diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/cppwinrt/LICENSE.txt b/msvc/Windows Kits/10/Include/10.0.26100.0/cppwinrt/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..2b2cd3e76f54d3d734cd0cf83c84424243da2772 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/cppwinrt/LICENSE.txt @@ -0,0 +1,24 @@ +C++ for the Windows Runtime (cppwinrt) + +Copyright (c) Microsoft Corporation +All rights reserved. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/GenericUsbFnIoctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/GenericUsbFnIoctl.h new file mode 100644 index 0000000000000000000000000000000000000000..74310fa6814d7bf2c17eadea5e5854e652114931 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/GenericUsbFnIoctl.h @@ -0,0 +1,106 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + +Module Name: + + GenericUsbFnIoctl.h + +Abstract: + + This header defines the IOCTL codes for the generic USB function class driver + +Environment: + + Kernel and user mode + +--*/ + +#pragma once + +// TRANSFERS +#define IOCTL_GENERICUSBFN_TRANSFER_IN CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x03, \ + METHOD_IN_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_TRANSFER_IN_APPEND_ZERO_PKT CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x04, \ + METHOD_IN_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_TRANSFER_OUT CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x05, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_CONTROL_STATUS_HANDSHAKE_IN CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x06, \ + METHOD_BUFFERED, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_CONTROL_STATUS_HANDSHAKE_OUT CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x07, \ + METHOD_BUFFERED, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +//COMMANDS +#define IOCTL_GENERICUSBFN_GET_CLASS_INFO CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x08, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_GET_PIPE_STATE CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x09, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_SET_PIPE_STATE CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0A, \ + METHOD_IN_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + + +#define IOCTL_GENERICUSBFN_ACTIVATE_USB_BUS CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0B, \ + METHOD_BUFFERED, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_DEACTIVATE_USB_BUS CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0C, \ + METHOD_BUFFERED, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_BUS_EVENT_NOTIFICATION CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0D, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_GET_CLASS_INFO_EX CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0E, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_GET_INTERFACE_DESCRIPTOR_SET CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x0F, \ + METHOD_OUT_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) + +#define IOCTL_GENERICUSBFN_REGISTER_USB_STRING CTL_CODE(FILE_DEVICE_UNKNOWN, \ + 0x10, \ + METHOD_IN_DIRECT, \ + FILE_READ_DATA | \ + FILE_WRITE_DATA) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Iprtrmib.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Iprtrmib.h new file mode 100644 index 0000000000000000000000000000000000000000..562b61cb8702f2b62c4ed7baac5f85b7f1e1f845 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Iprtrmib.h @@ -0,0 +1,340 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + iprtrmib.h + +Abstract: + This file contains: + o Definitions of the MIB_XX structures passed to and from the IP Router Manager + to query and set MIB variables handled by the IP Router Manager + o The #defines for the MIB variables IDs handled by the IP Router Manager + and made accessible by the MprAdminMIBXXX APIs + o The Routing PID of the IP Router Manager (as mentioned in ipinfoid.h) + +--*/ + +#ifndef __ROUTING_IPRTRMIB_H__ +#define __ROUTING_IPRTRMIB_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) + +////////////////////////////////////////////////////////////////////////////// +// // +// Included to get the value of MAX_INTERFACE_NAME_LEN // +// // +////////////////////////////////////////////////////////////////////////////// + +#include + +////////////////////////////////////////////////////////////////////////////// +// // +// Included to get the necessary constants // +// // +////////////////////////////////////////////////////////////////////////////// + +#include + +////////////////////////////////////////////////////////////////////////////// +// // +// This is the Id for IP Router Manager. The Router Manager handles // +// MIB-II, Forwarding MIB and some enterprise specific information. // +// Calls made with any other ID are passed on to the corresponding protocol // +// For example, an MprAdminMIBXXX call with a protocol ID of PID_IP and // +// a routing Id of 0xD will be sent to the IP Router Manager and then // +// forwarded to OSPF // +// This lives in the same number space as the protocol Ids of RIP, OSPF // +// etc, so any change made to it should be done keeping this in mind // +// // +////////////////////////////////////////////////////////////////////////////// + + +#define IPRTRMGR_PID 10000 + +#ifndef ANY_SIZE + +#define ANY_SIZE 1 + +#endif + +////////////////////////////////////////////////////////////////////////////// +// // +// The following #defines are the Ids of the MIB variables made accessible // +// to the user via MprAdminMIBXXX Apis. It will be noticed that these are // +// not the same as RFC 1213, since the MprAdminMIBXXX APIs work on rows and // +// groups instead of scalar variables // +// // +////////////////////////////////////////////////////////////////////////////// + + +#define IF_NUMBER 0 +#define IF_TABLE (IF_NUMBER + 1) +#define IF_ROW (IF_TABLE + 1) +#define IP_STATS (IF_ROW + 1) +#define IP_ADDRTABLE (IP_STATS + 1) +#define IP_ADDRROW (IP_ADDRTABLE + 1) +#define IP_FORWARDNUMBER (IP_ADDRROW + 1) +#define IP_FORWARDTABLE (IP_FORWARDNUMBER + 1) +#define IP_FORWARDROW (IP_FORWARDTABLE + 1) +#define IP_NETTABLE (IP_FORWARDROW + 1) +#define IP_NETROW (IP_NETTABLE + 1) +#define ICMP_STATS (IP_NETROW + 1) +#define TCP_STATS (ICMP_STATS + 1) +#define TCP_TABLE (TCP_STATS + 1) +#define TCP_ROW (TCP_TABLE + 1) +#define UDP_STATS (TCP_ROW + 1) +#define UDP_TABLE (UDP_STATS + 1) +#define UDP_ROW (UDP_TABLE + 1) +#define MCAST_MFE (UDP_ROW + 1) +#define MCAST_MFE_STATS (MCAST_MFE + 1) +#define BEST_IF (MCAST_MFE_STATS + 1) +#define BEST_ROUTE (BEST_IF + 1) +#define PROXY_ARP (BEST_ROUTE + 1) +#define MCAST_IF_ENTRY (PROXY_ARP + 1) +#define MCAST_GLOBAL (MCAST_IF_ENTRY + 1) +#define IF_STATUS (MCAST_GLOBAL + 1) +#define MCAST_BOUNDARY (IF_STATUS + 1) +#define MCAST_SCOPE (MCAST_BOUNDARY + 1) +#define DEST_MATCHING (MCAST_SCOPE + 1) +#define DEST_LONGER (DEST_MATCHING + 1) +#define DEST_SHORTER (DEST_LONGER + 1) +#define ROUTE_MATCHING (DEST_SHORTER + 1) +#define ROUTE_LONGER (ROUTE_MATCHING + 1) +#define ROUTE_SHORTER (ROUTE_LONGER + 1) +#define ROUTE_STATE (ROUTE_SHORTER + 1) +#define MCAST_MFE_STATS_EX (ROUTE_STATE + 1) +#define IP6_STATS (MCAST_MFE_STATS_EX + 1) +#define UDP6_STATS (IP6_STATS + 1) +#define TCP6_STATS (UDP6_STATS + 1) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define NUMBER_OF_EXPORTED_VARIABLES (TCP6_STATS + 1) +#else +#define NUMBER_OF_EXPORTED_VARIABLES (ROUTE_STATE + 1) +#endif + + +////////////////////////////////////////////////////////////////////////////// +// // +// MIB_OPAQUE_QUERY is the structure filled in by the user to identify a // +// MIB variable // +// // +// dwVarId ID of MIB Variable (One of the Ids #defined above) // +// dwVarIndex Variable sized array containing the indices needed to // +// identify a variable. NOTE: Unlike SNMP we dont require that // +// a scalar variable be indexed by 0 // +// // +////////////////////////////////////////////////////////////////////////////// + +typedef struct _MIB_OPAQUE_QUERY +{ + DWORD dwVarId; + DWORD rgdwVarIndex[ANY_SIZE]; +}MIB_OPAQUE_QUERY, *PMIB_OPAQUE_QUERY; + +////////////////////////////////////////////////////////////////////////////// +// // +// The following are the structures which are filled in and returned to the // +// user when a query is made, OR are filled in BY THE USER when a set is // +// done // +// // +////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include + +typedef enum _TCP_TABLE_CLASS { + TCP_TABLE_BASIC_LISTENER, + TCP_TABLE_BASIC_CONNECTIONS, + TCP_TABLE_BASIC_ALL, + TCP_TABLE_OWNER_PID_LISTENER, + TCP_TABLE_OWNER_PID_CONNECTIONS, + TCP_TABLE_OWNER_PID_ALL, + TCP_TABLE_OWNER_MODULE_LISTENER, + TCP_TABLE_OWNER_MODULE_CONNECTIONS, + TCP_TABLE_OWNER_MODULE_ALL +} TCP_TABLE_CLASS, *PTCP_TABLE_CLASS; + +typedef enum _UDP_TABLE_CLASS { + UDP_TABLE_BASIC, + UDP_TABLE_OWNER_PID, + UDP_TABLE_OWNER_MODULE +} UDP_TABLE_CLASS, *PUDP_TABLE_CLASS; + +typedef enum _TCPIP_OWNER_MODULE_INFO_CLASS { + TCPIP_OWNER_MODULE_INFO_BASIC +} TCPIP_OWNER_MODULE_INFO_CLASS, *PTCPIP_OWNER_MODULE_INFO_CLASS; + +typedef struct _TCPIP_OWNER_MODULE_BASIC_INFO { + PWCHAR pModuleName; + PWCHAR pModulePath; +} TCPIP_OWNER_MODULE_BASIC_INFO, *PTCPIP_OWNER_MODULE_BASIC_INFO; + +typedef struct _MIB_IPMCAST_BOUNDARY +{ + DWORD dwIfIndex; + DWORD dwGroupAddress; + DWORD dwGroupMask; + DWORD dwStatus; +}MIB_IPMCAST_BOUNDARY, *PMIB_IPMCAST_BOUNDARY; + +typedef struct _MIB_IPMCAST_BOUNDARY_TABLE +{ + DWORD dwNumEntries; + MIB_IPMCAST_BOUNDARY table[ANY_SIZE]; +}MIB_IPMCAST_BOUNDARY_TABLE, *PMIB_IPMCAST_BOUNDARY_TABLE; + +#define SIZEOF_BOUNDARY_TABLE(X) (FIELD_OFFSET(MIB_IPMCAST_BOUNDARY_TABLE,table[0]) + ((X) * sizeof(MIB_IPMCAST_BOUNDARY)) + ALIGN_SIZE) + +typedef struct { + DWORD dwGroupAddress; + DWORD dwGroupMask; +} MIB_BOUNDARYROW, *PMIB_BOUNDARYROW; + +// Structure matching what goes in the registry in a block of type +// IP_MCAST_LIMIT_INFO. This contains the fields of +// MIB_IPMCAST_IF_ENTRY which are configurable. + +typedef struct { + DWORD dwTtl; + DWORD dwRateLimit; +} MIB_MCAST_LIMIT_ROW, *PMIB_MCAST_LIMIT_ROW; + +#define MAX_SCOPE_NAME_LEN 255 + +// +// Scope names are unicode. SNMP and MZAP use UTF-8 encoding. +// + +#define SN_UNICODE +typedef WCHAR SN_CHAR; +typedef SN_CHAR SCOPE_NAME_BUFFER[MAX_SCOPE_NAME_LEN+1], *SCOPE_NAME; + +typedef struct _MIB_IPMCAST_SCOPE +{ + DWORD dwGroupAddress; + DWORD dwGroupMask; + SCOPE_NAME_BUFFER snNameBuffer; + DWORD dwStatus; +}MIB_IPMCAST_SCOPE, *PMIB_IPMCAST_SCOPE; + +typedef struct _MIB_IPDESTROW +{ +#ifdef __cplusplus + MIB_IPFORWARDROW ForwardRow; +#else + MIB_IPFORWARDROW; +#endif + + DWORD dwForwardPreference; + DWORD dwForwardViewSet; +}MIB_IPDESTROW, *PMIB_IPDESTROW; + +typedef struct _MIB_IPDESTTABLE +{ + DWORD dwNumEntries; + MIB_IPDESTROW table[ANY_SIZE]; +}MIB_IPDESTTABLE, *PMIB_IPDESTTABLE; + +typedef struct _MIB_BEST_IF +{ + DWORD dwDestAddr; + DWORD dwIfIndex; +}MIB_BEST_IF, *PMIB_BEST_IF; + +typedef struct _MIB_PROXYARP +{ + DWORD dwAddress; + DWORD dwMask; + DWORD dwIfIndex; +}MIB_PROXYARP, *PMIB_PROXYARP; + +typedef struct _MIB_IFSTATUS +{ + DWORD dwIfIndex; + DWORD dwAdminStatus; + DWORD dwOperationalStatus; + BOOL bMHbeatActive; + BOOL bMHbeatAlive; +}MIB_IFSTATUS, *PMIB_IFSTATUS; + +typedef struct _MIB_ROUTESTATE +{ + BOOL bRoutesSetToStack; + +}MIB_ROUTESTATE, *PMIB_ROUTESTATE; + +////////////////////////////////////////////////////////////////////////////// +// // +// All the info passed to (SET/CREATE) and from (GET/GETNEXT/GETFIRST) // +// IP Router Manager is encapsulated in the following "discriminated" // +// union. To pass, say MIB_IFROW, use the following code // +// // +// PMIB_OPAQUE_INFO pInfo; // +// PMIB_IFROW pIfRow; // +// DWORD rgdwBuff[(MAX_MIB_OFFSET + sizeof(MIB_IFROW))/sizeof(DWORD) + 1]; // +// // +// pInfo = (PMIB_OPAQUE_INFO)rgdwBuffer; // +// pIfRow = (MIB_IFROW *)(pInfo->rgbyData); // +// // +// This can also be accomplished by using the following macro // +// // +// DEFINE_MIB_BUFFER(pInfo,MIB_IFROW, pIfRow); // +// // +////////////////////////////////////////////////////////////////////////////// + + +typedef struct _MIB_OPAQUE_INFO +{ + DWORD dwId; + + union + { + ULONGLONG ullAlign; + BYTE rgbyData[1]; + }; + +}MIB_OPAQUE_INFO, *PMIB_OPAQUE_INFO; + +#define MAX_MIB_OFFSET 8 + +#define MIB_INFO_SIZE(S) \ + (MAX_MIB_OFFSET + sizeof(S)) + +#define MIB_INFO_SIZE_IN_DWORDS(S) \ + ((MIB_INFO_SIZE(S))/sizeof(DWORD) + 1) + +#define DEFINE_MIB_BUFFER(X,Y,Z) \ + DWORD __rgdwBuff[MIB_INFO_SIZE_IN_DWORDS(Y)]; \ + PMIB_OPAQUE_INFO X = (PMIB_OPAQUE_INFO)__rgdwBuff; \ + Y * Z = (Y *)(X->rgbyData) + + +#define CAST_MIB_INFO(X,Y,Z) Z = (Y)(X->rgbyData) + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif //__ROUTING_IPRTRMIB_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/IssPer16.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/IssPer16.h new file mode 100644 index 0000000000000000000000000000000000000000..8b2646dd7494e8b90a2ed9de10c7ea6e8b7efc43 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/IssPer16.h @@ -0,0 +1,329 @@ +//+------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (C) Microsoft Corporation, 1992-1999. +// +// File: issperr.h +// +// Contents: Constant definitions for OLE HRESULT values. +// +// History: dd-mmm-yy Author Comment +// +// Notes: +// This is a generated file. Do not modify directly. +// The MC tool generates this file from dsyserr.mc +// +//-------------------------------------------------------------------------- +#ifndef _ISSPERR_H_ +#define _ISSPERR_H_ +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +// Define the status type. + +#ifdef FACILITY_SECURITY +#undef FACILITY_SECURITY +#endif + +#ifdef STATUS_SEVERITY_SUCCESS +#undef STATUS_SEVERITY_SUCCESS +#endif +//#ifdef STATUS_SEVERITY_ERROR +//#undef STATUS_SEVERITY_ERROR +//#endif + +// Define the severities +// +// Values are 32 bit values layed out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// +#define FACILITY_SECURITY 0x9 +#define FACILITY_NULL 0 + + +// +// Define the severity codes +// +#define STATUS_SEVERITY_SUCCESS 0x0 +#define STATUS_SEVERITY_COERROR 0x2 + + +// +// MessageId: SEC_E_INSUFFICIENT_MEMORY +// +// MessageText: +// +// Not enough memory is available to complete this request +// +#define SEC_E_INSUFFICIENT_MEMORY ((SECURITY_STATUS)0x1300) + +// +// MessageId: SEC_E_INVALID_HANDLE +// +// MessageText: +// +// The handle specified is invalid +// +#define SEC_E_INVALID_HANDLE ((SECURITY_STATUS)0x1301) + +// +// MessageId: SEC_E_UNSUPPORTED_FUNCTION +// +// MessageText: +// +// The function requested is not supported +// +#define SEC_E_UNSUPPORTED_FUNCTION ((SECURITY_STATUS)0x1302) + + +// +// MessageId: SEC_E_TARGET_UNKNOWN +// +// MessageText: +// +// The specified target is unknown or unreachable +// +#define SEC_E_TARGET_UNKNOWN ((SECURITY_STATUS)0x1303) + +// +// MessageId: SEC_E_INTERNAL_ERROR +// +// MessageText: +// +// The Local Security Authority cannot be contacted +// +#define SEC_E_INTERNAL_ERROR ((SECURITY_STATUS)0x1304) + +// +// MessageId: SEC_E_SECPKG_NOT_FOUND +// +// MessageText: +// +// The requested security package does not exist +// +#define SEC_E_SECPKG_NOT_FOUND ((SECURITY_STATUS)0x1305) + + +// +// MessageId: SEC_E_NOT_OWNER +// +// MessageText: +// +// The caller is not the owner of the desired credentials +// +#define SEC_E_NOT_OWNER ((SECURITY_STATUS)0x1306) + +// +// MessageId: SEC_E_CANNOT_INSTALL +// +// MessageText: +// +// The security package failed to initialize, and cannot be installed +// +#define SEC_E_CANNOT_INSTALL ((SECURITY_STATUS)0x1307) + +// +// MessageId: SEC_E_INVALID_TOKEN +// +// MessageText: +// +// The token supplied to the function is invalid +// +#define SEC_E_INVALID_TOKEN ((SECURITY_STATUS)0x1308) + +// +// MessageId: SEC_E_CANNOT_PACK +// +// MessageText: +// +// The security package is not able to marshall the logon buffer, +// so the logon attempt has failed +// +#define SEC_E_CANNOT_PACK ((SECURITY_STATUS)0x1309) + +// +// MessageId: SEC_E_QOP_NOT_SUPPORTED +// +// MessageText: +// +// The per-message Quality of Protection is not supported by the +// security package +// +#define SEC_E_QOP_NOT_SUPPORTED ((SECURITY_STATUS)0x130A) + +// +// MessageId: SEC_E_NO_IMPERSONATION +// +// MessageText: +// +// The security context does not allow impersonation of the client +// +#define SEC_E_NO_IMPERSONATION ((SECURITY_STATUS)0x130B) + +// +// MessageId: SEC_E_LOGON_DENIED +// +// MessageText: +// +// The logon attempt failed +// +#define SEC_E_LOGON_DENIED ((SECURITY_STATUS)0x130C) + +// +// MessageId: SEC_E_UNKNOWN_CREDENTIALS +// +// MessageText: +// +// The credentials supplied to the package were not +// recognized +// +#define SEC_E_UNKNOWN_CREDENTIALS ((SECURITY_STATUS)0x130D) + +// +// MessageId: SEC_E_NO_CREDENTIALS +// +// MessageText: +// +// No credentials are available in the security package +// +#define SEC_E_NO_CREDENTIALS ((SECURITY_STATUS)0x130E) + +// +// MessageId: SEC_E_MESSAGE_ALTERED +// +// MessageText: +// +// The message supplied for verification has been altered +// +#define SEC_E_MESSAGE_ALTERED ((SECURITY_STATUS)0x130F) + +// +// MessageId: SEC_E_OUT_OF_SEQUENCE +// +// MessageText: +// +// The message supplied for verification is out of sequence +// +#define SEC_E_OUT_OF_SEQUENCE ((SECURITY_STATUS)0x1310) + +// +// MessageId: SEC_E_NO_AUTHENTICATING_AUTHORITY +// +// MessageText: +// +// No authority could be contacted for authentication. +// +#define SEC_E_NO_AUTHENTICATING_AUTHORITY ((SECURITY_STATUS)0x1311) + +// MessageId: SEC_E_CONTEXT_EXPIRED +// +// MessageText: +// +// The context has expired and can no longer be used. +// +#define SEC_E_CONTEXT_EXPIRED ((SECURITY_STATUS)0x1312) + +// +// MessageId: SEC_E_INCOMPLETE_MESSAGE +// +// MessageText: +// +// The supplied message is incomplete. The signature was not verified. +// +#define SEC_E_INCOMPLETE_MESSAGE ((SECURITY_STATUS)0x1313) + +// +// MessageId: SEC_I_CONTINUE_NEEDED +// +// MessageText: +// +// The function completed successfully, but must be called +// again to complete the context +// +#define SEC_I_CONTINUE_NEEDED ((SECURITY_STATUS)0x1012) + +// +// MessageId: SEC_I_COMPLETE_NEEDED +// +// MessageText: +// +// The function completed successfully, but CompleteToken +// must be called +// +#define SEC_I_COMPLETE_NEEDED ((SECURITY_STATUS)0x1013) + +// +// MessageId: SEC_I_COMPLETE_AND_CONTINUE +// +// MessageText: +// +// The function completed successfully, but both CompleteToken +// and this function must be called to complete the context +// +#define SEC_I_COMPLETE_AND_CONTINUE ((SECURITY_STATUS)0x1014) + +// +// MessageId: SEC_I_LOCAL_LOGON +// +// MessageText: +// +// The logon was completed, but no network authority was +// available. The logon was made using locally known information +// +#define SEC_I_LOCAL_LOGON ((SECURITY_STATUS)0x1015) + +// +// MessageId: SEC_E_OK +// +// MessageText: +// +// Call completed successfully +// +#define SEC_E_OK ((SECURITY_STATUS)0x0000) + +// +// Older error names for backwards compatibility +// + + +#define SEC_E_NOT_SUPPORTED SEC_E_UNSUPPORTED_FUNCTION +#define SEC_E_NO_SPM SEC_E_INTERNAL_ERROR +#define SEC_E_BAD_PKGID SEC_E_SECPKG_NOT_FOUND + + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _ISSPERR_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Math3DHelper.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Math3DHelper.h new file mode 100644 index 0000000000000000000000000000000000000000..61ea3b2428316140b72f7681648e8268250dd602 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/Math3DHelper.h @@ -0,0 +1,854 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + Math3DHelperV2.h + +Abstract: + + Internal math library for vector, rotation matrix and quaternion calculation + +--*/ + +#pragma once + +#ifdef __cplusplus + +#include + +// Pi +static const float PI = (3.14159265f); +static const float DegToRadRatio = (PI / 180.0f); +static const float RadToDegRatio = (180.0f / PI); +static const float FLOAT_TOLERANCE = (0.00001f); + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) +static __inline float RealModulo (float x, float y) +{ + if (0 == y) return x; + return x - y * (float)(floor(x/y)); +} + +static __inline bool FloatEq(float x, float y) +{ + return (fabs(x - y) < FLOAT_TOLERANCE); +} +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ + + + +class CVEC3D : public VEC3D +{ +public: + inline CVEC3D( void ) + { + Clear(); + }; + inline ~CVEC3D( void ) {}; + inline CVEC3D( const VEC3D& _V ) + { + X = _V.X; + Y = _V.Y; + Z = _V.Z; + }; + inline CVEC3D( float _X, float _Y, float _Z) + { + X = _X; + Y = _Y; + Z = _Z; + }; + + // assignment operators + inline CVEC3D& operator += ( const CVEC3D& _V) + { + *this = *this + _V; + return *this; + }; + + inline CVEC3D& operator -= ( const CVEC3D& _V) + { + *this = *this - _V; + return *this; + }; + + inline CVEC3D& operator *= (const float _F) + { + *this = *this * _F; + return *this; + }; + + inline CVEC3D& operator /= (const float _F) + { + *this = *this / _F; + return *this; + }; + + + // unary + inline CVEC3D operator - () const + { + CVEC3D v3; + v3.X = -X; + v3.Y = -Y; + v3.Z = -Z; + return v3; + }; + + // binary operators + inline CVEC3D operator + ( const CVEC3D& _V) const + { + CVEC3D v3; + v3.X = X + _V.X; + v3.Y = Y + _V.Y; + v3.Z = Z + _V.Z; + return v3; + }; + + inline CVEC3D operator - ( const CVEC3D& _V) const + { + CVEC3D v3; + v3.X = X - _V.X; + v3.Y = Y - _V.Y; + v3.Z = Z - _V.Z; + return v3; + }; + + inline CVEC3D operator * ( float _F) const + { + CVEC3D v3; + v3.X = X * _F; + v3.Y = Y * _F; + v3.Z = Z * _F; + return v3; + }; + + inline CVEC3D operator / ( float _F) const + { + CVEC3D v3; + v3.X = X / _F; + v3.Y = Y / _F; + v3.Z = Z / _F; + return v3; + }; + + inline bool operator == ( const CVEC3D& _V) const + { + return ((X == _V.X) && (Y == _V.Y) && (Z == _V.Z)); + }; + + + inline bool operator != ( const CVEC3D& _V) const + { + return !(this == &_V); + }; + + inline CVEC3D& operator = ( const CVEC3D& _V) + { + X = _V.X; + Y = _V.Y; + Z = _V.Z; + return *this; + }; + + inline void Clear (void) + { + X = 0.0f; + Y = 0.0f; + Z = 0.0f; + }; + + inline CVEC3D CrossProduct ( const CVEC3D& _V) const + { + CVEC3D v3; + v3.X = Y * _V.Z - Z * _V.Y; + v3.Y = Z * _V.X - X * _V.Z; + v3.Z = X * _V.Y - Y * _V.X; + return v3; + }; + + inline float DotProduct ( const CVEC3D& _V) const + { + return X * _V.X + Y * _V.Y + Z * _V.Z; + }; + + inline float Magnitude (void) + { + float fMagnitude; + fMagnitude = DotProduct (*this); + fMagnitude = static_cast(sqrt(fMagnitude)); + return fMagnitude; + }; + + inline void Normalize (void) + { + float fMagnitude = this->Magnitude(); + if (0.0 != fMagnitude) + { + *this /= fMagnitude; + } + }; + + inline CVEC3D AngularDiff ( const CVEC3D& _V) const + { + CVEC3D Out; + float fSine; + + Out = (*this).CrossProduct(_V); + fSine = Out.Magnitude(); + if (fSine >= 0.001f) // if Sine is very small, Angle=Sin(Angle) - so skip this + { + float fCosine = (*this).DotProduct(_V); + float fAngle = (float)(atan2(fSine, fCosine)); // Angle is in ]-PI..PI] range + Out = Out * (fAngle / fSine); + } + + return Out; + }; + + inline CVEC3D RotateAngleByAxis ( const float AngleInRad, const VEC3D ReferenceAxis) + { + // + // Rotate 3D vector pvToRotate by angle AngleRad (in radian), along axis pvAxis, + // using right handed space (positive rotation is counter-clockwize) + // This is using Rodrigues' rotation formula which is more efficient than + // converting the axis and angle into a rotation matrix, and using the rotation + // matrix to compute the rotated vector. + // + // Rotate vector V by Angle about direction vector W: + // Vrot = V*Cos(Angle) + (WxV)*Sin(Angle) + w*(w.v)*(1-Cos(Angle)) + // + + CVEC3D Out, Axis; + + Axis = ReferenceAxis; + Axis.Normalize(); + Out = (*this) * ((float)(cos(AngleInRad))) + + Axis.CrossProduct(*this) * ((float)(sin(AngleInRad))) + + Axis * (Axis.DotProduct(*this)) * (1 - ((float)(cos(AngleInRad)))); + + return Out; + }; + + inline bool HasNAN (void) + { + return !(X == X && Y == Y && Z == Z); + }; + + inline void LowPassFilter ( const CVEC3D& _V, float Coefficient ) + { + CVEC3D Temp; + Temp = _V - *this; + Temp = Temp * Coefficient; + Temp = Temp + *this; + X = Temp.X; + Y = Temp.Y; + Z = Temp.Z; + }; + +}; + + +class CMATRIX3X3 : public MATRIX3X3 +{ +public: + inline CMATRIX3X3( void ) + { + Clear(); + }; + inline ~CMATRIX3X3( void ) {}; + inline CMATRIX3X3( const MATRIX3X3& _M ) + { + A11 = _M.A11; + A12 = _M.A12; + A13 = _M.A13; + A21 = _M.A21; + A22 = _M.A22; + A23 = _M.A23; + A31 = _M.A31; + A32 = _M.A32; + A33 = _M.A33; + }; + inline CMATRIX3X3( const VEC3D& _Vx, const VEC3D& _Vy, const VEC3D& _Vz ) + { + V1 = _Vx; + V2 = _Vy; + V3 = _Vz; + }; + inline CMATRIX3X3( float _A11, float _A12, float _A13, + float _A21, float _A22, float _A23, + float _A31, float _A32, float _A33) + { + A11 = _A11; + A12 = _A12; + A13 = _A13; + A21 = _A21; + A22 = _A22; + A23 = _A23; + A31 = _A31; + A32 = _A32; + A33 = _A33; + }; + + // assignment operators + inline CMATRIX3X3 operator *= ( const CMATRIX3X3& _M ) + { + *this = *this * _M; + return *this; + }; + + inline CMATRIX3X3& operator += ( const CMATRIX3X3& _M) + { + *this = *this + _M; + return *this; + }; + + inline CMATRIX3X3& operator -= ( const CMATRIX3X3& _M) + { + *this = *this - _M; + return *this; + }; + + inline CMATRIX3X3& operator *= ( float _F) + { + *this = *this * _F; + return *this; + }; + + inline CMATRIX3X3& operator /= ( float _F) + { + *this = *this / _F; + return *this; + }; + + // unary + inline CMATRIX3X3 operator - () const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = -M [i] [j]; + } + } + return m33Ret; + }; + + // binary operators + inline CMATRIX3X3 operator * ( const CMATRIX3X3& _M) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = (M [i] [0] * _M.M [0] [j]) + + (M [i] [1] * _M.M [1] [j]) + + (M [i] [2] * _M.M [2] [j]); + } + } + return m33Ret; + }; + + inline CMATRIX3X3 operator + ( const CMATRIX3X3& _M) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = M [i] [j] + _M.M [i] [j]; + } + } + return m33Ret; + }; + + inline CMATRIX3X3 operator - ( const CMATRIX3X3& _M) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = M [i] [j] - _M.M [i] [j]; + } + } + return m33Ret; + }; + + inline CMATRIX3X3 operator * ( float _F) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = M [i] [j] * _F; + } + } + return m33Ret; + }; + + inline CMATRIX3X3 operator / ( float _F) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [i] [j] = M [i] [j] / _F; + } + } + return m33Ret; + }; + + inline bool operator == ( const CMATRIX3X3& _M) const + { + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + if (M [i] [j] != _M.M [i] [j]) + { + return false; + } + } + } + return true; + }; + + + inline bool operator != ( const CMATRIX3X3& _M) const + { + return !(this == &_M); + }; + + inline CMATRIX3X3& operator = ( const CMATRIX3X3& _M) + { + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + M [i] [j] = _M.M [i] [j]; + } + } + return *this; + }; + + inline void InitialPosition (void) + { + Clear(); + A11 = 1.0f; + A22 = 1.0f; + A33 = 1.0f; + }; + + inline void Clear (void) + { + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + M [i] [j] = 0.0f; + } + } + }; + + inline void SetToIdentity (void) + { + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + M [i] [j] = (i == j) ? 1.0f : 0.0f; + } + } + }; + + inline CMATRIX3X3 Transpose (void) const + { + CMATRIX3X3 m33Ret; + for (int i = 0; i < 3; i++) + { + for (int j = 0; j < 3; j++) + { + m33Ret.M [j] [i] = M [i] [j]; + } + } + return m33Ret; + }; + + inline CVEC3D operator * ( const CVEC3D &_V ) const + { + CVEC3D v3Ret ( A11 * _V.X + A12 * _V.Y + A13 * _V.Z, + A21 * _V.X + A22 * _V.Y + A23 * _V.Z, + A31 * _V.X + A32 * _V.Y + A33 * _V.Z); + return v3Ret; + }; + + inline QUATERNION ToQuaternion (void) + { + QUATERNION quarternion = {0}; + + // This method is safer and removes the imprecisions around PI rotation than using the classical: + // W = Sqrt(1+M11+M22+M33); X = (M32-M23) /4W; Y = (M13-M31)/4W; Z = (M21-M12)/4W + quarternion.W = (float) sqrt (max (0.0f, 1.0f + A11 + A22 + A33)) / 2.0f; + //Get norms: + quarternion.X = (float) sqrt (max (0.0f, 1.0f + A11 - A22 - A33)) / 2.0f; + quarternion.Y = (float) sqrt (max (0.0f, 1.0f - A11 + A22 - A33)) / 2.0f; + quarternion.Z = (float) sqrt (max (0.0f, 1.0f - A11 - A22 + A33)) / 2.0f; + // Get signs + if ((A32 - A23) < 0.0f) + { // negate QX: + quarternion.X = - quarternion.X; + } + if ((A13 - A31) < 0.0f) + { // negate QY: + quarternion.Y = - quarternion.Y; + } + if ((A21 - A12) < 0.0f) + { // negate QZ: + quarternion.Z = - quarternion.Z; + } + + return quarternion; + }; + + inline VEC3D ToEulerAngle (void) + { + VEC3D Euler = {0}; + CVEC3D EulerAngle; + + if (!FloatEq(A32, 1.0f) && !FloatEq(A32, -1.0f)) + { + float cx = 1.0f; + + if (FloatEq (A33, 0.0f)) + { + EulerAngle.Y = -PI/2; // then A31 = cos X + EulerAngle.X = (float) (atan2 (A32, A31)); + } + else + { + EulerAngle.Y = (float) (atan (-A31 / A33)); + if (A33 >= 0.0f) + { + EulerAngle.X = (float) (asin (A32)); + } + else + { + EulerAngle.X = (float) (-asin (A32)) + PI; + } + } + + if (cos (EulerAngle.X) < 0.0f) + { + cx = -1.0f; + } + + EulerAngle.Z = (float) (atan2 (-A12 * cx, A22 * cx)); + } + else + { + EulerAngle.Y = 0.0f; // can be anything, make if 0 + + if (FloatEq (A32, -1.0f)) + { + EulerAngle.X = -PI/2; + } + else + { + EulerAngle.X = PI/2; + } + + EulerAngle.Z = (float) (atan2 (A21, A11)); + } + + // Yaw is in [0, +2PI[ + EulerAngle.Z = RealModulo (EulerAngle.Z, 2*PI); + + // Pitch is in [-PI, +PI[ + EulerAngle.X = RealModulo (EulerAngle.X + PI, 2*PI) - PI; + + // Roll is in [-PI/2, +PI/2[ + EulerAngle.Y = RealModulo (EulerAngle.Y + PI/2, PI) - PI/2; + + // Convert from rad to degree + Euler = EulerAngle * RadToDegRatio; + + return Euler; + }; + +}; + + +class CQUATERNION : public QUATERNION +{ +public: + inline CQUATERNION( void ) + { + Clear(); + }; + inline ~CQUATERNION( void ) {}; + inline CQUATERNION( const QUATERNION& _Q ) + { + W = _Q.W; + X = _Q.X; + Y = _Q.Y; + Z = _Q.Z; + }; + inline CQUATERNION( float _W, float _X, float _Y, float _Z ) + { + W = _W; + X = _X; + Y = _Y; + Z = _Z; + }; + inline CQUATERNION( float AngleInRad, VEC3D Axis ) + { + W = (float)(cos(AngleInRad/2)); + X = Axis.X * (float)(sin(AngleInRad/2)); + Y = Axis.Y * (float)(sin(AngleInRad/2)); + Z = Axis.Z * (float)(sin(AngleInRad/2)); + }; + + // assignment operators + inline CQUATERNION operator *= ( const CQUATERNION& _Q ) + { + *this = *this * _Q; + return *this; + }; + + inline CQUATERNION& operator *= (const float _F) + { + *this = *this * _F; + return *this; + }; + + inline CQUATERNION& operator /= (const float _F) + { + *this = *this / _F; + return *this; + }; + + inline CQUATERNION& operator += ( const CQUATERNION& _Q) + { + *this = *this + _Q; + return *this; + }; + + inline CQUATERNION& operator -= ( const CQUATERNION& _Q) + { + *this = *this - _Q; + return *this; + }; + + // unary + inline CQUATERNION operator - () const + { + CQUATERNION QuatRet; + + QuatRet.W = -W; + QuatRet.X = -X; + QuatRet.Y = -Y; + QuatRet.Z = -Z; + + return QuatRet; + }; + + // binary operators + inline CQUATERNION operator * ( const CQUATERNION& _Q) const + { + CQUATERNION QuatRet; + + QuatRet.W = W*_Q.W - X*_Q.X - Y*_Q.Y - Z*_Q.Z; + QuatRet.X = X*_Q.W + W*_Q.X + Y*_Q.Z - Z*_Q.Y; + QuatRet.Y = W*_Q.Y - X*_Q.Z + Y*_Q.W + Z*_Q.X; + QuatRet.Z = W*_Q.Z + X*_Q.Y - Y*_Q.X + Z*_Q.W; + + return QuatRet; + }; + + inline CQUATERNION operator * ( float _F) const + { + CQUATERNION QuatRet; + + QuatRet.W = W * _F; + QuatRet.X = X * _F; + QuatRet.Y = Y * _F; + QuatRet.Z = Z * _F; + + return QuatRet; + }; + + inline CQUATERNION operator / ( float _F) const + { + CQUATERNION QuatRet; + + QuatRet.W = W / _F; + QuatRet.X = X / _F; + QuatRet.Y = Y / _F; + QuatRet.Z = Z / _F; + + return QuatRet; + }; + + inline CQUATERNION operator + ( const CQUATERNION& _Q) const + { + CQUATERNION QuatRet; + + QuatRet.W = W + _Q.W; + QuatRet.X = X + _Q.X; + QuatRet.Y = Y + _Q.Y; + QuatRet.Z = Z + _Q.Z; + + return QuatRet; + }; + + inline CQUATERNION operator - ( const CQUATERNION& _Q) const + { + CQUATERNION QuatRet; + + QuatRet.W = W - _Q.W; + QuatRet.X = X - _Q.X; + QuatRet.Y = Y - _Q.Y; + QuatRet.Z = Z - _Q.Z; + + return QuatRet; + }; + + inline bool operator == ( const CQUATERNION& _Q) const + { + return ((W == _Q.W) && (X == _Q.X) && (Y == _Q.Y) && (Z == _Q.Z)); + }; + + + inline bool operator != ( const CQUATERNION& _Q) const + { + return !(this == &_Q); + }; + + inline CQUATERNION& operator = ( const CQUATERNION& _Q) + { + W = _Q.W; + X = _Q.X; + Y = _Q.Y; + Z = _Q.Z; + return *this; + }; + + inline CQUATERNION Conjugate (void) const + { + CQUATERNION QuatRet; + + QuatRet.W = W; + QuatRet.X = -X; + QuatRet.Y = -Y; + QuatRet.Z = -Z; + + return QuatRet; + }; + + inline float Magnitude (void) + { + return (static_cast(sqrt(W*W+X*X+Y*Y+Z*Z))); + }; + + inline void Normalize (void) + { + float fMagnitude = this->Magnitude(); + if (0.0 != fMagnitude) + { + *this /= fMagnitude; + } + }; + + inline void InitialPosition (void) + { + W = 1.0f; + X = 0.0f; + Y = 0.0f; + Z = 0.0f; + }; + + inline void Clear (void) + { + W = 0.0f; + X = 0.0f; + Y = 0.0f; + Z = 0.0f; + }; + + inline float ToAngleAxis ( PVEC3D pAxis) + { + float Angle = 2 * acos(W); + + if (pAxis != nullptr) + { + float Temp = sqrt(1 - W*W); + if (Temp != 0) + { + pAxis->X = X / Temp; + pAxis->Y = Y / Temp; + pAxis->Z = Z / Temp; + } + } + + return Angle; + }; + + inline MATRIX3X3 ToMatrix (void) + { + MATRIX3X3 Matrix = {0}; + + Matrix.A11 = 1 - 2*Y*Y - 2*Z*Z; + Matrix.A12 = 2*X*Y - 2*Z*W; + Matrix.A13 = 2*X*Z + 2*Y*W; + Matrix.A21 = 2*X*Y + 2*Z*W; + Matrix.A22 = 1 - 2*X*X - 2*Z*Z; + Matrix.A23 = 2*Y*Z - 2*X*W; + Matrix.A31 = 2*X*Z - 2*Y*W; + Matrix.A32 = 2*Y*Z + 2*X*W; + Matrix.A33 = 1 - 2*X*X - 2*Y*Y; + + return Matrix; + }; + + inline CQUATERNION RotateAngleByAxis ( const float AngleInRad, const VEC3D Axis) + { + CQUATERNION QuatRet = *this; + + if (!FloatEq(AngleInRad, 0)) + { + CQUATERNION Rotation(AngleInRad, Axis); + + QuatRet = Rotation * *this; + } + + return QuatRet; + }; + + inline CQUATERNION RotateAngleByGravity ( const float AngleInRad ) + { + CQUATERNION QuatRet = *this; + + if (!FloatEq(AngleInRad, 0)) + { + VEC3D Axis = {0}; + Axis.X = -1.0f * (2*X*Z - 2*Y*W); + Axis.Y = -1.0f * (2*Y*Z + 2*X*W); + Axis.Z = -1.0f * (1 - 2*X*X - 2*Y*Y); + + CQUATERNION Rotation(AngleInRad, Axis); + + QuatRet = Rotation * *this; + } + + return QuatRet; + }; + +}; + +#endif \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.h new file mode 100644 index 0000000000000000000000000000000000000000..9377c359eb987912afef6c9e0abd333705953580 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.h @@ -0,0 +1,762 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __shellhandwriting_h__ +#define __shellhandwriting_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __ITfDetermineProximateHandwritingTargetArgs_FWD_DEFINED__ +#define __ITfDetermineProximateHandwritingTargetArgs_FWD_DEFINED__ +typedef interface ITfDetermineProximateHandwritingTargetArgs ITfDetermineProximateHandwritingTargetArgs; + +#endif /* __ITfDetermineProximateHandwritingTargetArgs_FWD_DEFINED__ */ + + +#ifndef __ITfFocusHandwritingTargetArgs_FWD_DEFINED__ +#define __ITfFocusHandwritingTargetArgs_FWD_DEFINED__ +typedef interface ITfFocusHandwritingTargetArgs ITfFocusHandwritingTargetArgs; + +#endif /* __ITfFocusHandwritingTargetArgs_FWD_DEFINED__ */ + + +#ifndef __ITfHandwritingSink_FWD_DEFINED__ +#define __ITfHandwritingSink_FWD_DEFINED__ +typedef interface ITfHandwritingSink ITfHandwritingSink; + +#endif /* __ITfHandwritingSink_FWD_DEFINED__ */ + + +#ifndef __ITfHandwritingRequest_FWD_DEFINED__ +#define __ITfHandwritingRequest_FWD_DEFINED__ +typedef interface ITfHandwritingRequest ITfHandwritingRequest; + +#endif /* __ITfHandwritingRequest_FWD_DEFINED__ */ + + +#ifndef __ITfHandwriting_FWD_DEFINED__ +#define __ITfHandwriting_FWD_DEFINED__ +typedef interface ITfHandwriting ITfHandwriting; + +#endif /* __ITfHandwriting_FWD_DEFINED__ */ + + +#ifndef __IHandwritingInputRoutingCallback_FWD_DEFINED__ +#define __IHandwritingInputRoutingCallback_FWD_DEFINED__ +typedef interface IHandwritingInputRoutingCallback IHandwritingInputRoutingCallback; + +#endif /* __IHandwritingInputRoutingCallback_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "oaidl.h" +#include "ocidl.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_shellhandwriting_0000_0000 */ +/* [local] */ + +#include +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) +#define TF_E_TOO_LATE MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x050A) +typedef /* [v1_enum] */ +enum TfHandwritingState + { + TF_HANDWRITING_AUTO = 0, + TF_HANDWRITING_DISABLED = 1, + TF_HANDWRITING_ENABLED = 2, + TF_HANDWRITING_POINTERDELIVERY = 3 + } TfHandwritingState; + +typedef /* [v1_enum] */ +enum TfProximateHandwritingTargetResponse + { + TF_NO_HANDWRITING_TARGET_PROXIMATE = 0, + TF_HANDWRITING_TARGET_PROXIMATE = 1, + TF_USE_SYSTEM_TARGETING = 2, + TF_USE_POINTER_DELIVERY = 3 + } TfProximateHandwritingTargetResponse; + +typedef /* [v1_enum] */ +enum TfHandwritingFocusTargetResponse + { + TF_NO_HANDWRITING_TARGET = 0, + TF_HANDWRITING_TARGET_FOCUSED = ( TF_NO_HANDWRITING_TARGET + 1 ) , + TF_HANDWRITING_TARGET_FOCUSED_NO_CORRECTIONS = ( TF_HANDWRITING_TARGET_FOCUSED + 1 ) , + TF_PERFORM_SYSTEM_TARGETING = ( TF_HANDWRITING_TARGET_FOCUSED_NO_CORRECTIONS + 1 ) + } TfHandwritingFocusTargetResponse; + +typedef /* [v1_enum] */ +enum TfInputEvaluation + { + TF_IE_HANDWRITING = 0, + TF_IE_TAP = 1, + TF_IE_CANCEL_HANDWRITING = 2 + } TfInputEvaluation; + + + +extern RPC_IF_HANDLE __MIDL_itf_shellhandwriting_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_shellhandwriting_0000_0000_v0_0_s_ifspec; + +#ifndef __ITfDetermineProximateHandwritingTargetArgs_INTERFACE_DEFINED__ +#define __ITfDetermineProximateHandwritingTargetArgs_INTERFACE_DEFINED__ + +/* interface ITfDetermineProximateHandwritingTargetArgs */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_ITfDetermineProximateHandwritingTargetArgs; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("8E676F4B-1951-530C-74D2-0DFDB76F17EB") + ITfDetermineProximateHandwritingTargetArgs : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE GetPointerTargetInfo( + /* [out] */ HWND *targetWindow, + /* [out] */ POINT *targetScreenPoint, + /* [out] */ SIZE *distanceThreshold) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetResponse( + TfProximateHandwritingTargetResponse response) = 0; + + }; + + +#else /* C style interface */ + + typedef struct ITfDetermineProximateHandwritingTargetArgsVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + ITfDetermineProximateHandwritingTargetArgs * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + ITfDetermineProximateHandwritingTargetArgs * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + ITfDetermineProximateHandwritingTargetArgs * This); + + DECLSPEC_XFGVIRT(ITfDetermineProximateHandwritingTargetArgs, GetPointerTargetInfo) + HRESULT ( STDMETHODCALLTYPE *GetPointerTargetInfo )( + ITfDetermineProximateHandwritingTargetArgs * This, + /* [out] */ HWND *targetWindow, + /* [out] */ POINT *targetScreenPoint, + /* [out] */ SIZE *distanceThreshold); + + DECLSPEC_XFGVIRT(ITfDetermineProximateHandwritingTargetArgs, SetResponse) + HRESULT ( STDMETHODCALLTYPE *SetResponse )( + ITfDetermineProximateHandwritingTargetArgs * This, + TfProximateHandwritingTargetResponse response); + + END_INTERFACE + } ITfDetermineProximateHandwritingTargetArgsVtbl; + + interface ITfDetermineProximateHandwritingTargetArgs + { + CONST_VTBL struct ITfDetermineProximateHandwritingTargetArgsVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define ITfDetermineProximateHandwritingTargetArgs_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define ITfDetermineProximateHandwritingTargetArgs_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define ITfDetermineProximateHandwritingTargetArgs_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define ITfDetermineProximateHandwritingTargetArgs_GetPointerTargetInfo(This,targetWindow,targetScreenPoint,distanceThreshold) \ + ( (This)->lpVtbl -> GetPointerTargetInfo(This,targetWindow,targetScreenPoint,distanceThreshold) ) + +#define ITfDetermineProximateHandwritingTargetArgs_SetResponse(This,response) \ + ( (This)->lpVtbl -> SetResponse(This,response) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __ITfDetermineProximateHandwritingTargetArgs_INTERFACE_DEFINED__ */ + + +#ifndef __ITfFocusHandwritingTargetArgs_INTERFACE_DEFINED__ +#define __ITfFocusHandwritingTargetArgs_INTERFACE_DEFINED__ + +/* interface ITfFocusHandwritingTargetArgs */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_ITfFocusHandwritingTargetArgs; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("5C4EC0E8-E7EE-51C7-6B7A-1CABBEE700E6") + ITfFocusHandwritingTargetArgs : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE GetPointerTargetInfo( + /* [out] */ HWND *targetWindow, + /* [out] */ RECT *targetScreenArea, + /* [out] */ SIZE *distanceThreshold) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetResponse( + TfHandwritingFocusTargetResponse response) = 0; + + }; + + +#else /* C style interface */ + + typedef struct ITfFocusHandwritingTargetArgsVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + ITfFocusHandwritingTargetArgs * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + ITfFocusHandwritingTargetArgs * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + ITfFocusHandwritingTargetArgs * This); + + DECLSPEC_XFGVIRT(ITfFocusHandwritingTargetArgs, GetPointerTargetInfo) + HRESULT ( STDMETHODCALLTYPE *GetPointerTargetInfo )( + ITfFocusHandwritingTargetArgs * This, + /* [out] */ HWND *targetWindow, + /* [out] */ RECT *targetScreenArea, + /* [out] */ SIZE *distanceThreshold); + + DECLSPEC_XFGVIRT(ITfFocusHandwritingTargetArgs, SetResponse) + HRESULT ( STDMETHODCALLTYPE *SetResponse )( + ITfFocusHandwritingTargetArgs * This, + TfHandwritingFocusTargetResponse response); + + END_INTERFACE + } ITfFocusHandwritingTargetArgsVtbl; + + interface ITfFocusHandwritingTargetArgs + { + CONST_VTBL struct ITfFocusHandwritingTargetArgsVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define ITfFocusHandwritingTargetArgs_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define ITfFocusHandwritingTargetArgs_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define ITfFocusHandwritingTargetArgs_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define ITfFocusHandwritingTargetArgs_GetPointerTargetInfo(This,targetWindow,targetScreenArea,distanceThreshold) \ + ( (This)->lpVtbl -> GetPointerTargetInfo(This,targetWindow,targetScreenArea,distanceThreshold) ) + +#define ITfFocusHandwritingTargetArgs_SetResponse(This,response) \ + ( (This)->lpVtbl -> SetResponse(This,response) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __ITfFocusHandwritingTargetArgs_INTERFACE_DEFINED__ */ + + +#ifndef __ITfHandwritingSink_INTERFACE_DEFINED__ +#define __ITfHandwritingSink_INTERFACE_DEFINED__ + +/* interface ITfHandwritingSink */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_ITfHandwritingSink; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("3575A140-A10F-555F-35F9-45C865EB93BE") + ITfHandwritingSink : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE DetermineProximateHandwritingTarget( + /* [in] */ ITfDetermineProximateHandwritingTargetArgs *determineProximateHandwritingTargetArgs) = 0; + + virtual HRESULT STDMETHODCALLTYPE FocusHandwritingTarget( + /* [in] */ ITfFocusHandwritingTargetArgs *focusHandwritingTargetArgs) = 0; + + }; + + +#else /* C style interface */ + + typedef struct ITfHandwritingSinkVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + ITfHandwritingSink * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + ITfHandwritingSink * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + ITfHandwritingSink * This); + + DECLSPEC_XFGVIRT(ITfHandwritingSink, DetermineProximateHandwritingTarget) + HRESULT ( STDMETHODCALLTYPE *DetermineProximateHandwritingTarget )( + ITfHandwritingSink * This, + /* [in] */ ITfDetermineProximateHandwritingTargetArgs *determineProximateHandwritingTargetArgs); + + DECLSPEC_XFGVIRT(ITfHandwritingSink, FocusHandwritingTarget) + HRESULT ( STDMETHODCALLTYPE *FocusHandwritingTarget )( + ITfHandwritingSink * This, + /* [in] */ ITfFocusHandwritingTargetArgs *focusHandwritingTargetArgs); + + END_INTERFACE + } ITfHandwritingSinkVtbl; + + interface ITfHandwritingSink + { + CONST_VTBL struct ITfHandwritingSinkVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define ITfHandwritingSink_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define ITfHandwritingSink_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define ITfHandwritingSink_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define ITfHandwritingSink_DetermineProximateHandwritingTarget(This,determineProximateHandwritingTargetArgs) \ + ( (This)->lpVtbl -> DetermineProximateHandwritingTarget(This,determineProximateHandwritingTargetArgs) ) + +#define ITfHandwritingSink_FocusHandwritingTarget(This,focusHandwritingTargetArgs) \ + ( (This)->lpVtbl -> FocusHandwritingTarget(This,focusHandwritingTargetArgs) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __ITfHandwritingSink_INTERFACE_DEFINED__ */ + + +#ifndef __ITfHandwritingRequest_INTERFACE_DEFINED__ +#define __ITfHandwritingRequest_INTERFACE_DEFINED__ + +/* interface ITfHandwritingRequest */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_ITfHandwritingRequest; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("EE54892A-2FC4-52E7-8765-DE0E8E88081B") + ITfHandwritingRequest : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE SetInputEvaluation( + TfInputEvaluation inputEvaluation) = 0; + + }; + + +#else /* C style interface */ + + typedef struct ITfHandwritingRequestVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + ITfHandwritingRequest * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + ITfHandwritingRequest * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + ITfHandwritingRequest * This); + + DECLSPEC_XFGVIRT(ITfHandwritingRequest, SetInputEvaluation) + HRESULT ( STDMETHODCALLTYPE *SetInputEvaluation )( + ITfHandwritingRequest * This, + TfInputEvaluation inputEvaluation); + + END_INTERFACE + } ITfHandwritingRequestVtbl; + + interface ITfHandwritingRequest + { + CONST_VTBL struct ITfHandwritingRequestVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define ITfHandwritingRequest_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define ITfHandwritingRequest_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define ITfHandwritingRequest_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define ITfHandwritingRequest_SetInputEvaluation(This,inputEvaluation) \ + ( (This)->lpVtbl -> SetInputEvaluation(This,inputEvaluation) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __ITfHandwritingRequest_INTERFACE_DEFINED__ */ + + +#ifndef __ITfHandwriting_INTERFACE_DEFINED__ +#define __ITfHandwriting_INTERFACE_DEFINED__ + +/* interface ITfHandwriting */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_ITfHandwriting; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("59714133-8E20-5101-B1AE-D2CD9BAD8CE5") + ITfHandwriting : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE GetHandwritingState( + /* [out] */ TfHandwritingState *handwritingState) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetHandwritingState( + TfHandwritingState handwritingState) = 0; + + virtual HRESULT STDMETHODCALLTYPE RequestHandwritingForPointer( + UINT32 pointerId, + UINT64 handwritingStrokeId, + /* [out] */ BOOL *requestAccepted, + /* [out] */ ITfHandwritingRequest **request) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetHandwritingDistanceThreshold( + /* [out] */ SIZE *distanceThresholdPixels) = 0; + + }; + + +#else /* C style interface */ + + typedef struct ITfHandwritingVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + ITfHandwriting * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + ITfHandwriting * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + ITfHandwriting * This); + + DECLSPEC_XFGVIRT(ITfHandwriting, GetHandwritingState) + HRESULT ( STDMETHODCALLTYPE *GetHandwritingState )( + ITfHandwriting * This, + /* [out] */ TfHandwritingState *handwritingState); + + DECLSPEC_XFGVIRT(ITfHandwriting, SetHandwritingState) + HRESULT ( STDMETHODCALLTYPE *SetHandwritingState )( + ITfHandwriting * This, + TfHandwritingState handwritingState); + + DECLSPEC_XFGVIRT(ITfHandwriting, RequestHandwritingForPointer) + HRESULT ( STDMETHODCALLTYPE *RequestHandwritingForPointer )( + ITfHandwriting * This, + UINT32 pointerId, + UINT64 handwritingStrokeId, + /* [out] */ BOOL *requestAccepted, + /* [out] */ ITfHandwritingRequest **request); + + DECLSPEC_XFGVIRT(ITfHandwriting, GetHandwritingDistanceThreshold) + HRESULT ( STDMETHODCALLTYPE *GetHandwritingDistanceThreshold )( + ITfHandwriting * This, + /* [out] */ SIZE *distanceThresholdPixels); + + END_INTERFACE + } ITfHandwritingVtbl; + + interface ITfHandwriting + { + CONST_VTBL struct ITfHandwritingVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define ITfHandwriting_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define ITfHandwriting_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define ITfHandwriting_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define ITfHandwriting_GetHandwritingState(This,handwritingState) \ + ( (This)->lpVtbl -> GetHandwritingState(This,handwritingState) ) + +#define ITfHandwriting_SetHandwritingState(This,handwritingState) \ + ( (This)->lpVtbl -> SetHandwritingState(This,handwritingState) ) + +#define ITfHandwriting_RequestHandwritingForPointer(This,pointerId,handwritingStrokeId,requestAccepted,request) \ + ( (This)->lpVtbl -> RequestHandwritingForPointer(This,pointerId,handwritingStrokeId,requestAccepted,request) ) + +#define ITfHandwriting_GetHandwritingDistanceThreshold(This,distanceThresholdPixels) \ + ( (This)->lpVtbl -> GetHandwritingDistanceThreshold(This,distanceThresholdPixels) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __ITfHandwriting_INTERFACE_DEFINED__ */ + + +#ifndef __IHandwritingInputRoutingCallback_INTERFACE_DEFINED__ +#define __IHandwritingInputRoutingCallback_INTERFACE_DEFINED__ + +/* interface IHandwritingInputRoutingCallback */ +/* [local][uuid][object] */ + + +EXTERN_C const IID IID_IHandwritingInputRoutingCallback; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("E3E84B6E-E625-5F79-C39E-32F1FF2056F6") + IHandwritingInputRoutingCallback : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE GetThreadIdForInput( + UINT32 pointerId, + POINT *targetScreenPoint, + HWND targetHWnd, + /* [out] */ UINT32 *uiThreadId) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IHandwritingInputRoutingCallbackVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IHandwritingInputRoutingCallback * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IHandwritingInputRoutingCallback * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IHandwritingInputRoutingCallback * This); + + DECLSPEC_XFGVIRT(IHandwritingInputRoutingCallback, GetThreadIdForInput) + HRESULT ( STDMETHODCALLTYPE *GetThreadIdForInput )( + IHandwritingInputRoutingCallback * This, + UINT32 pointerId, + POINT *targetScreenPoint, + HWND targetHWnd, + /* [out] */ UINT32 *uiThreadId); + + END_INTERFACE + } IHandwritingInputRoutingCallbackVtbl; + + interface IHandwritingInputRoutingCallback + { + CONST_VTBL struct IHandwritingInputRoutingCallbackVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IHandwritingInputRoutingCallback_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IHandwritingInputRoutingCallback_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IHandwritingInputRoutingCallback_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IHandwritingInputRoutingCallback_GetThreadIdForInput(This,pointerId,targetScreenPoint,targetHWnd,uiThreadId) \ + ( (This)->lpVtbl -> GetThreadIdForInput(This,pointerId,targetScreenPoint,targetHWnd,uiThreadId) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IHandwritingInputRoutingCallback_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_shellhandwriting_0000_0006 */ +/* [local] */ + +HRESULT WINAPI RegisterHandwritingInputRoutingCallback(IHandwritingInputRoutingCallback * callback); +HRESULT WINAPI GetHandwritingStrokeIdForPointer(_In_ UINT32 pointerId, _Out_ UINT64* handwritingStrokeId); +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +#endif // NTDDI_WIN10_NI + + +extern RPC_IF_HANDLE __MIDL_itf_shellhandwriting_0000_0006_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_shellhandwriting_0000_0006_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.idl new file mode 100644 index 0000000000000000000000000000000000000000..e7a5c604e75c2a7be70ee34b4b436415d2b82301 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ShellHandwriting.idl @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. + +import "oaidl.idl"; +import "ocidl.idl"; + +cpp_quote("#include ") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_NI)") + +// Shell Handwriting APIs are Desktop only. +#pragma region Desktop Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)") + +cpp_quote("#define TF_E_TOO_LATE MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x050A)") + +typedef [v1_enum] enum TfHandwritingState +{ + // This value indicates the client will receive the default handwriting behavior + // based on the presence of pen hardware and the handwriting settings. + TF_HANDWRITING_AUTO = 0, + + // This value indicates the client does not want any shell handwriting experience for the context. + TF_HANDWRITING_DISABLED = 1, + + // This value indicates the client wants the shell handwriting experience for the context + // even if the system has quirked the context to not have handwriting by default. + TF_HANDWRITING_ENABLED = 2, + + // By default, shell handwriting buffers all pen input from process delivery + // until the handwriting intent of the user has been determined. + // This value indicates that client wants the input delivered immediately + // and will handle the buffering and intent determination itself and notify + // the shell via the ITfHandwriting::RequestHandwritingForPointer. + TF_HANDWRITING_POINTERDELIVERY = 3, +} TfHandwritingState; + +typedef [v1_enum] enum TfProximateHandwritingTargetResponse +{ + // No valid handwriting target is proximate to the target point. + TF_NO_HANDWRITING_TARGET_PROXIMATE = 0, + + // A valid handwriting target is proximate to the target point. + TF_HANDWRITING_TARGET_PROXIMATE = 1, + + // The client wants the system to take its default action. + TF_USE_SYSTEM_TARGETING = 2, + + // The client wants the system to convert the handwriting handling + // to Pointer Delivery for the remainder of the handwriting session. + TF_USE_POINTER_DELIVERY = 3, +} TfProximateHandwritingTargetResponse; + +typedef [v1_enum] enum TfHandwritingFocusTargetResponse +{ + // The app found no target for ink stroke and doesn't want the system + // to try and perform its default targeting. + TF_NO_HANDWRITING_TARGET, + + // The app has successfully set focus to a handwriting target. + TF_HANDWRITING_TARGET_FOCUSED, + + // Same as TF_HANDWRITING_TARGET_FOCUSED but with a request to disable + // system-provided corrections experience. + TF_HANDWRITING_TARGET_FOCUSED_NO_CORRECTIONS, + + // The system should perform the default focus handwriting target + // behavior that would have occured if no callback was registered. + TF_PERFORM_SYSTEM_TARGETING, +} TfHandwritingFocusTargetResponse; + +typedef [v1_enum] enum TfInputEvaluation +{ + // The pen input was not recognized as a pen gesture and handwriting should commence. + TF_IE_HANDWRITING = 0, + + // The pen input was recognized as a tap gesture. This will result in the handwriting request being cancelled. + TF_IE_TAP = 1, + + // The pen input was recognized as a pen gesture the application wants to use and so the handwriting request should be cancelled. + TF_IE_CANCEL_HANDWRITING = 2, +} TfInputEvaluation; + +// ITfDetermineProximateHandwritingTargetArgs +[object, uuid(8E676F4B-1951-530C-74D2-0DFDB76F17EB), local] +interface ITfDetermineProximateHandwritingTargetArgs : IUnknown +{ + HRESULT GetPointerTargetInfo([out] HWND* targetWindow, [out] POINT* targetScreenPoint, [out] SIZE* distanceThreshold); + HRESULT SetResponse(TfProximateHandwritingTargetResponse response); +}; + +// ITfFocusHandwritingTargetArgs +[object, uuid(5C4EC0E8-E7EE-51C7-6B7A-1CABBEE700E6), local] +interface ITfFocusHandwritingTargetArgs : IUnknown +{ + HRESULT GetPointerTargetInfo([out] HWND* targetWindow, [out] RECT* targetScreenArea, [out] SIZE* distanceThreshold); + HRESULT SetResponse(TfHandwritingFocusTargetResponse response); +}; + +// ITfHandwritingSink +// Clients provide this callback if they are interested in participating in +// determination and activation of edit contexts prior to focus being set. +[object, uuid(3575A140-A10F-555F-35F9-45C865EB93BE), local] +interface ITfHandwritingSink : IUnknown +{ + // This callback requests that the client determine if there is a valid handwriting target within + // distanceThreshold number of pixels away from the target x,y. Valid handwriting targets are any edit + // context that can receive focus and participate in text services (TSF) input. + HRESULT DetermineProximateHandwritingTarget([in] ITfDetermineProximateHandwritingTargetArgs* determineProximateHandwritingTargetArgs); + + // This callback requsts that the client set edit focus on the edit context that most overlaps with + // the targetArea bounds provided plus the the additional distanceThreshold provided. + // The buffer is separated from the targetArea to represent an area of preference. + // Edit contexts that overlap with the targetArea are preferred, buf if none do + // then the cloest edit context within the buffer should be focused. + // The client also can optionally choose the correction experience provided for recognized handwriting text. + // Applications should return S_OK if focus has been set and E_INVALIDARG if no edit context matches the parameters. + HRESULT FocusHandwritingTarget([in] ITfFocusHandwritingTargetArgs* focusHandwritingTargetArgs); +}; + +// ITfHandwritingRequest +[object, uuid(EE54892A-2FC4-52E7-8765-DE0E8E88081B), local] +interface ITfHandwritingRequest : IUnknown +{ + HRESULT SetInputEvaluation(TfInputEvaluation inputEvaluation); +}; + +// ITfHandwriting +[object, uuid(59714133-8E20-5101-B1AE-D2CD9BAD8CE5), local] +interface ITfHandwriting : IUnknown +{ + HRESULT GetHandwritingState([out] TfHandwritingState* handwritingState); + HRESULT SetHandwritingState(TfHandwritingState handwritingState); + HRESULT RequestHandwritingForPointer(UINT32 pointerId, UINT64 handwritingStrokeId, [out] BOOL* requestAccepted, [out] ITfHandwritingRequest** request); + HRESULT GetHandwritingDistanceThreshold([out] SIZE* distanceThresholdPixels); +}; + +// IHandwritingInputRoutingCallback +[object, uuid(E3E84B6E-E625-5F79-C39E-32F1FF2056F6), local] +interface IHandwritingInputRoutingCallback : IUnknown +{ + // This callback requests that the client provide the thread Id of the UI thread that is responsible for + // the UI the pointer input is targetting + HRESULT GetThreadIdForInput(UINT32 pointerId, POINT* targetScreenPoint, HWND targetHWnd, [out] UINT32* uiThreadId); +}; + +cpp_quote("HRESULT WINAPI RegisterHandwritingInputRoutingCallback(IHandwritingInputRoutingCallback * callback);") +cpp_quote("HRESULT WINAPI GetHandwritingStrokeIdForPointer(_In_ UINT32 pointerId, _Out_ UINT64* handwritingStrokeId);") + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */") +#pragma endregion + +cpp_quote("#endif // NTDDI_WIN10_NI") diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingActivity.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingActivity.h new file mode 100644 index 0000000000000000000000000000000000000000..5773576e35810fff7d6a5be1b44d3c1f1503c02b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingActivity.h @@ -0,0 +1,902 @@ +/* ++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + TraceLoggingActivity.h + +Abstract: + + TraceLogging activity logging helper classes and macros for C++ for + utilizing ETW activity ids. + +Environment: + + User mode. + +--*/ + +#pragma once +#ifndef RC_INVOKED + +#include "TraceLoggingProvider.h" + +/* +Quick start: + +#include +#include +#include +#include // optional, used here for WINEVENT_LEVEL_ERROR + +TRACELOGGING_DEFINE_PROVIDER( + g_hProvider, + "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71)); + +int main(int argc, char* argv[]) +{ + const ULONGLONG MyKeywordValue = 0x10; + + TraceLoggingRegister(g_hProvider); + + // Declare a local activity variable. + // Use the default (0 = none) for the activity's keyword. + // Use the default (5 = verbose) for the activity's level. + TraceLoggingActivity parentActivity; + + // Write the activity's START event. Note that you must not specify keyword + // or level for START and STOP events because they always use the activity's + // keyword and level. + TraceLoggingWriteStart( + parentActivity, + "ParentActivity", // The name of the start event is used as the activity name. + TraceLoggingValue(argc, "SampleField1")); + + { + // Declare a local (nested) activity variable, with explicit keyword and level: + TraceLoggingActivity nestedActivity; + + // Connect the nested activity to the parent: + nestedActivity.SetRelatedActivity(parentActivity); + + // Write the activity's START event. + TraceLoggingWriteStart(nestedActivity, "NestedActivity"); + + // TraceLoggingWriteTagged writes an event that is tagged with an activity + // ID. Note that TraceLoggingWriteTagged is just like TraceLoggingWrite + // except that the first parameter is an activity (not a provider) and the + // resulting event is explicitly tagged with the activity ID. In particular, + // TraceLoggingWriteTagged does NOT use the activity's level and keyword -- + // they are specified just as they would be for a TraceLoggingWrite event. + TraceLoggingWriteTagged( + nestedActivity, + "NestedActivityIdTaggedEvent", + TraceLoggingValue(argc, "SampleField2"), + TraceLoggingKeyword(MyKeywordValue)); + + // Write the activity's STOP event. + TraceLoggingWriteStop(nestedActivity, "NestedActivity"); + + // Note that if the activity is destroyed without being stopped, a default + // "ActivityStoppedAutomatically" event will be written by the destructor. + } + + TraceLoggingWriteStop(parentActivity, "ParentActivity"); + + TraceLoggingUnregister(g_hProvider); + return 0; +} +*/ + +#pragma region Public Interface + +/* +Classes: + +- TraceLoggingActivity: General purpose activity class. +- TraceLoggingThreadActivity: Automatic activity class. (Desktop apps only.) +- TraceLoggingThreadActivityIdSetter: Helper for controlling the thread-local + activity ID. (Desktop apps only.) + +Macros: + +- TraceLoggingWriteStart: Writes an activity START event. +- TraceLoggingWriteStop: Writes an activity STOP event. +- TraceLoggingWriteTagged: Writes an event explicitly tagged with an activity ID. +- TraceLoggingWriteTaggedIfStarted: TraceLoggingWriteTagged if the activity was + started. +- TraceLoggingFunction: Creates a TraceLoggingThreadActivity and writes a START + event with the current function's name. (Desktop apps only.) + +Basic usage: + +1. Create an instance of TraceLoggingActivity or TraceLoggingThreadActivity. +2. Call TraceLoggingWriteStart to write the activity's START event. +3. Call TraceLoggingWriteTagged to write events associated with the activity. +4. Call TraceLoggingWriteStop to write the activity's STOP event. +*/ + +/* +TraceLoggingActivity implements general-purpose activity support. It supports +nesting via an explicit childActivity.SetRelatedActivity(parentActivity) method. +Events associated with the activity can then be written using +TraceLoggingWriteTagged. + +Activities can be nested by calling childActivity.SetRelatedActivity(parentActivity) +before calling TraceLoggingWriteStart(childActivity, ...). + +Use TraceLoggingWriteStart to generate a unique activity ID and write the START +event for the activity. + +Use TraceLoggingWriteTagged to write events that are associated with the activity. + +Use TraceLoggingWriteStop to write the STOP event for the activity. + +If the activity is destroyed without being stopped, it will log a default STOP +event. +*/ +template< + TraceLoggingHProvider const& provider, + UINT64 keyword = 0, // defaults to 0 = none + UINT8 level = 5, // defaults to 5 = WINEVENT_LEVEL_VERBOSE + typename TlgReflectorTag = _TlgReflectorTag_Param0IsHProvider> // helps TlgReflector understand that this is a wrapper type +class TraceLoggingActivity; + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/* +TraceLoggingThreadActivity implements automatic activities using a thread-local +CurrentActivityId variable. Each new activity is automatically nested within the +activity that previously set the CurrentActivityId variable, and all events +written using TraceLoggingWrite are automatically associated with the +CurrentActivityId. This automatic behavior can be convenient in some cases, but it +only works correctly when the activities nest precisely and do not cross thread +boundaries. In addition, TraceLoggingThreadActivity is not available on the +Windows Runtime (i.e. this class cannot be used for Windows Store or Windows Phone +apps). + +PLEASE NOTE: use TraceLoggingThreadActivity only when you can guarantee that +lifetimes of all activities of this type on the thread fully nest in all cases, i.e. +a parent activity will not end before a child activity, even in error or exceptional +cases. Activities defined in function-local scopes typically meet this criteria. + +Use TraceLoggingWriteStart to generate a unique activity ID and write the START +event for the activity. + +Use TraceLoggingWrite to write events that are automatically associated with the +activity. + +Use TraceLoggingWriteTagged to write events that are explicitly associated with the +activity. + +Use TraceLoggingWriteStop to write the STOP event for the activity. + +If the activity is destroyed without being stopped, it will log a default STOP +event. +*/ +template< + TraceLoggingHProvider const& provider, + UINT64 keyword = 0, // defaults to 0 = none + UINT8 level = 5, // defaults to 5 = WINEVENT_LEVEL_VERBOSE + typename TlgReflectorTag = _TlgReflectorTag_Param0IsHProvider> // helps TlgReflector understand that this is a wrapper type +class TraceLoggingThreadActivity; + +/* +TraceLoggingThreadActivityIdSetter is a helper class that sets the thread-local +CurrentActivity variable during construction and saves the original value. It then +restores the original value during destruction. This class is not available on the +Windows Runtime (i.e. it cannot be used for Windows Store or Windows Phone apps). + +As with thread activities, lifetime of an instance of this class should +be carefully managed to avoid imperfect nesting. +*/ +class TraceLoggingThreadActivityIdSetter; + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/* +Macro TraceLoggingWriteStart(activity, "EventName", args...): +Invoke this macro to start an activity and log the start event. + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Each arg must be a wrapper macro such as TraceLoggingValue, TraceLoggingInt32, +etc. + +Do not specify TraceLoggingKeyword or TraceLoggingLevel as args for this macro. +The START and STOP events always use the activity's keyword and level. +*/ +#define TraceLoggingWriteStart(activity, name, ...) \ + __pragma(warning(push)) __pragma(warning(disable:4127)) \ + do { \ + _tlgActivityDecl(activity) \ + static const UINT64 _tlgActivity_Keyword = _tlgActivityRef(activity).Keyword;\ + static const UINT8 _tlgActivity_Level = _tlgActivityRef(activity).Level;\ + static_assert( \ + _tlgActivity_Keyword == (_tlgActivity_Keyword _tlg_FOREACH(_tlgKeywordVal, __VA_ARGS__)), \ + "Do not use TraceLoggingKeyword in TraceLoggingWriteStart. Keywords for START events are " \ + "specified in the activity type, e.g. TraceLoggingActivity."); \ + static_assert( \ + _tlgActivity_Level == (_tlgActivity_Level _tlg_FOREACH(_tlgLevelVal, __VA_ARGS__)), \ + "Do not use TraceLoggingLevel in TraceLoggingWriteStart. The Level for START events is " \ + "specified in the activity type, e.g. TraceLoggingActivity."); \ + _tlgActivityRef(activity).zInternalStart(); \ + _tlgActivityWriteStartStop(_tlg_IS_EMPTY(__VA_ARGS__), ( \ + activity, \ + (name), \ + _tlgActivityRef(activity).Id(), \ + _tlgActivityRef(activity).zInternalRelatedId(), \ + 1 /* WINEVENT_OPCODE_START */, \ + _tlgActivity_Keyword, \ + _tlgActivity_Level, \ + __VA_ARGS__)); \ + } while(0) \ + __pragma(warning(pop)) \ + +/* +Macro TraceLoggingWriteStop(activity, "EventName", args...): +Invoke this macro to stop an activity and log the stop event. + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Each arg must be a wrapper macro such as TraceLoggingValue, TraceLoggingInt32, +etc. + +Do not specify TraceLoggingKeyword or TraceLoggingLevel as args for this macro. +The START and STOP events always use the activity's keyword and level. + +If an activity is started and is destroyed before it is stopped, a default +event will be logged from the destructor. +*/ +#define TraceLoggingWriteStop(activity, name, ...) \ + __pragma(warning(push)) __pragma(warning(disable:4127)) \ + do { \ + _tlgActivityDecl(activity) \ + static const UINT64 _tlgActivity_Keyword = _tlgActivityRef(activity).Keyword;\ + static const UINT8 _tlgActivity_Level = _tlgActivityRef(activity).Level;\ + static_assert( \ + _tlgActivity_Keyword == (_tlgActivity_Keyword _tlg_FOREACH(_tlgKeywordVal, __VA_ARGS__)), \ + "Do not use TraceLoggingKeyword in TraceLoggingWriteStop. Keywords for STOP events are " \ + "specified in the activity type, e.g. TraceLoggingActivity."); \ + static_assert( \ + _tlgActivity_Level == (_tlgActivity_Level _tlg_FOREACH(_tlgLevelVal, __VA_ARGS__)), \ + "Do not use TraceLoggingLevel in TraceLoggingWriteStop. The Level for STOP events is " \ + "specified in the activity type, e.g. TraceLoggingActivity."); \ + _tlgActivityRef(activity).zInternalStop(); \ + _tlgActivityWriteStartStop(_tlg_IS_EMPTY(__VA_ARGS__), ( \ + activity, \ + (name), \ + _tlgActivityRef(activity).Id(), \ + NULL, \ + 2 /* WINEVENT_OPCODE_STOP */,\ + _tlgActivity_Keyword,\ + _tlgActivity_Level,\ + __VA_ARGS__)); \ + } while(0) \ + __pragma(warning(pop)) \ + +/* +Macro TraceLoggingWriteTagged(activity, "EventName", args...): +Invoke this macro to log an event that is explicitly tagged with the activity id +of the specified activity. + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Each arg must be a wrapper macro such as TraceLoggingValue, TraceLoggingInt32, +etc. + +Note that events written with this macro do NOT use the activity's keyword and +level. If the level is not specified via TraceLoggingLevel, the level will default +to verbose (5). If the keyword is not specified via TraceLoggingKeyword, the keyword +will default to none (0). +*/ +#define TraceLoggingWriteTagged(activity, name, ...) \ + __pragma(warning(push)) __pragma(warning(disable:4127)) \ + do { \ + _tlgActivityDecl(activity) \ + TraceLoggingWriteActivity( \ + _tlgActivityRef(activity).Provider(), \ + (name), \ + _tlgActivityRef(activity).Id(), \ + NULL, \ + __VA_ARGS__); \ + } while(0) \ + __pragma(warning(pop)) \ + +/* +Macro TraceLoggingWriteTaggedIfStarted(activity, "EventName", args...): +Invoke this macro to log an event that is explicitly tagged with the activity id +of the specified activity. This macro logs the event only if the activity is +started. + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Each arg must be a wrapper macro such as TraceLoggingValue, TraceLoggingInt32, +etc. + +Note that events written with this macro do NOT use the activity's keyword and +level. If the level is not specified via TraceLoggingLevel, the level will default +to verbose (5). If the keyword is not specified via TraceLoggingKeyword, the keyword +will default to none (0). +*/ +#define TraceLoggingWriteTaggedIfStarted(activity, name, ...) \ + __pragma(warning(push)) __pragma(warning(disable:4127)) \ + do { \ + _tlgActivityDecl(activity) \ + if (_tlgActivityRef(activity).IsStarted()) { \ + TraceLoggingWriteActivity( \ + _tlgActivityRef(activity).Provider(), \ + (name), \ + _tlgActivityRef(activity).Id(), \ + NULL, \ + __VA_ARGS__); \ + } \ + } while(0) \ + __pragma(warning(pop)) \ + +/* +Macro TraceLoggingFunction(hProvider, args...): +Invoke this macro at the beginning of a function to define an activity and +start it. This will log a start event with the name of the function. When +the function exits, the activity class will log an automatically-generated +stop event. + +Each arg must be a wrapper macro such as TraceLoggingValue, TraceLoggingInt32, +etc. + +Since this macro uses a thread activity, please read the description for +TraceLoggingThreadActivity and ensure the function call or other thread +activities started within perfectly nest within each other even in cases of +errors and exceptions. +*/ +#define TraceLoggingFunction(providerHandle, ...)\ + TraceLoggingThreadActivity< \ + providerHandle, \ + 0 _tlg_FOREACH(_tlgKeywordVal, __VA_ARGS__), \ + 5 _tlg_FOREACH(_tlgLevelVal, __VA_ARGS__)> \ + _tlgFnActivity; \ + TraceLoggingWriteStart(_tlgFnActivity, _tlgThisFunctionName, __VA_ARGS__) + +#pragma endregion + +#pragma region Implementation + +/* +Private implementation macros. For internal use only. +Avoid IntelliSense errors about __FUNCTION__ only being valid within a function. +*/ +#ifdef __INTELLISENSE__ +#define _tlgThisFunctionName "ThisFunctionName" +#else +#define _tlgThisFunctionName __FUNCTION__ +#endif + +/* +Private implementation macros. For internal use only. +If the auto keyword is available, we can avoid referencing the activity +parameter more than once. +*/ +#if defined(_MSC_VER) && (_MSC_VER >= 1600) +#define _tlgActivityDecl(activity) auto& _tlgActivity(activity); +#define _tlgActivityRef(activity) _tlgActivity +#else +#define _tlgActivityDecl(activity) +#define _tlgActivityRef(activity) (activity) +#endif + +/* +Private implementation macros. For internal use only. +Avoid extra comma when invoking TraceLoggingWriteActivity. +*/ +#define _tlgActivityWriteStartStop(is_empty, args) \ + _tlg_PASTE2(_tlgActivityWriteStartStop_imp, is_empty) args +#define _tlgActivityWriteStartStop_imp0(activity, eventName, pActivityId, pRelatedId, opcode, keyword, level, ...) \ + TraceLoggingWriteActivity( \ + _tlgActivityRef(activity).Provider(), \ + eventName, \ + pActivityId, \ + pRelatedId, \ + TraceLoggingOpcode(opcode), \ + TraceLoggingKeyword(keyword), \ + TraceLoggingLevel(level), \ + TraceLoggingDescription("~^" _tlg_LSTRINGIZE(activity) L"^~") \ + , __VA_ARGS__ \ + ) +#define _tlgActivityWriteStartStop_imp1(activity, eventName, pActivityId, pRelatedId, opcode, keyword, level, ...) \ + TraceLoggingWriteActivity( \ + _tlgActivityRef(activity).Provider(), \ + eventName, \ + pActivityId, \ + pRelatedId, \ + TraceLoggingOpcode(opcode), \ + TraceLoggingKeyword(keyword), \ + TraceLoggingLevel(level), \ + TraceLoggingDescription("~^" _tlg_LSTRINGIZE(activity) L"^~") \ + ) + +/* +Private implementation function. For internal use only. +Separate function to minimize code bloat by consolidating the auto-stop events. +*/ +template +void _tlgWriteActivityAutoStop( + TraceLoggingHProvider provider, + _In_ GUID const* pActivityId) +{ + TraceLoggingWriteActivity( + provider, + "ActivityStoppedAutomatically", + pActivityId, + NULL, + TraceLoggingOpcode(2 /* WINEVENT_OPCODE_STOP */), + TraceLoggingKeyword(keyword), + TraceLoggingLevel(level)); +} + +/* +Private implementation function. For internal use only. +*/ +inline bool _tlgGuidIsZero(GUID const& g) +{ + INT32 const* p = reinterpret_cast(&g); + return + p[0] == 0 && + p[1] == 0 && + p[2] == 0 && + p[3] == 0; +} + +/* +Private implementation function. For internal use only. +*/ +inline bool _tlgGuidEqual(GUID const& g1, GUID const& g2) +{ + INT32 const* p1 = reinterpret_cast(&g1); + INT32 const* p2 = reinterpret_cast(&g2); + return + p1[0] == p2[0] && + p1[1] == p2[1] && + p1[2] == p2[2] && + p1[3] == p2[3]; +} + +/* +Private implementation class. For internal use only. +*/ +template< + typename DerivedTy, // DerivedTy must define Provider(), OnStarted(), OnStopped(). + UINT64 keyword, + UINT8 level> +class _TlgActivityBase +{ + _TlgActivityBase(const _TlgActivityBase&); // = delete + _TlgActivityBase& operator=(const _TlgActivityBase&); // = delete + + void Reset() + { + m_State = TlgStateCreated; + m_HasRelatedId = false; + } + + enum TlgState + { + TlgStateCreated, + TlgStateStarted, + TlgStateStopped, + TlgStateDestroyed + }; + + TlgState m_State; + bool m_HasRelatedId; + GUID m_Id; + GUID m_CapturedRelatedId; + +protected: + + ~_TlgActivityBase() + { + if (m_State == TlgStateStarted) + { + zInternalStop(); + _tlgWriteActivityAutoStop( + static_cast(this)->Provider(), + &m_Id); + } + + m_State = TlgStateDestroyed; + } + + _TlgActivityBase() + { + Reset(); + } + +#if defined(_MSC_VER) && (_MSC_VER >= 1600) + + _TlgActivityBase(_TlgActivityBase&& rhs) + { + Reset(); + *this = static_cast<_TlgActivityBase&&>(rhs); + } + + _TlgActivityBase& operator=(_TlgActivityBase&& rhs) + { + _tlg_ASSERT(m_State == TlgStateCreated, "Move-assign to newly created activities only"); + m_State = rhs.m_State; + m_HasRelatedId = rhs.m_HasRelatedId; + m_Id = rhs.m_Id; + m_CapturedRelatedId = rhs.m_CapturedRelatedId; + rhs.Reset(); + return *this; + } + +#endif // _MSC_VER >= 1600 + + /* + Should be called during activity setup (before activity starts). + If this is used, do NOT use PushThreadActivityId or PopThreadActivityId. + */ + void SetRelatedId(const GUID& relatedActivityId) + { + _tlg_ASSERT(m_State == TlgStateCreated, "_TlgActivityBase::SetRelatedId called from invalid state."); + _tlg_ASSERT(!m_HasRelatedId, "_TlgActivityBase::RelatedActivity was already set."); + m_CapturedRelatedId = relatedActivityId; + m_HasRelatedId = true; + } + + /* + Should be called at an appropriate point in activity setup, after SetRelatedId() is called. + Returns the related activity Id, if there is one. + Returns NULL if the related activity Id has not been set or if it is GUID_NULL. + */ + _Ret_opt_ const GUID* GetRelatedId() const + { + return m_HasRelatedId && !_tlgGuidIsZero(m_CapturedRelatedId) ? &m_CapturedRelatedId : NULL; + } + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + /* + Should be called from OnStarted if applicable. + If this is used, do NOT use SetRelatedId. + */ + void PushThreadActivityId() + { + _tlg_ASSERT(m_State == TlgStateCreated, "_TlgActivityBase::PushThreadActivityId called from invalid state."); + _tlg_ASSERT(!m_HasRelatedId, "_TlgActivityBase::RelatedActivity was already set."); + m_CapturedRelatedId = m_Id; + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_SET_ID, &m_CapturedRelatedId); + m_HasRelatedId = true; + } + + /* + Should be called from OnStopped if applicable. + If this is used, do NOT use SetRelatedId. + */ + void PopThreadActivityId() + { + _tlg_ASSERT(m_State == TlgStateStarted, "_TlgActivityBase::PopThreadActivityId called from invalid state."); + if (m_HasRelatedId) + { + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_SET_ID, &m_CapturedRelatedId); + + /* + If this assertion fails, it means that your thread activity's ID was corrupted. + For example: + + TraceLoggingWriteStart(activity1, ...); // Saves activity1.SavedId = thread.ActivityId, sets thread.ActivityId = activity1.Id(). + DoWork(); + TraceLoggingWrite(...); // Uses thread.ActivityId. + TraceLoggingWriteStop(activity1, ...); // Verifies that thread.ActivityId == activity1.Id(), restores thread.ActivityId = activity1.SavedId. + + If DoWork() leaves thread.ActivityId unchanged, or if it properly restores + thread.ActivityId to its original value before returning, then everything + will work as expected. If DoWork changes thread.ActivityId to its own value + and does not restore it before returning, the TraceLoggingWrite call will + use the activity ID set by DoWork instead of using activity1.Id(). The + assertion fires to warn you about this situation. + + The following are possible solutions for this issue: + + 1. If you can change the DoWork() code: Fix the DoWork() code to correctly + restore the activity ID before returning. Note that the activity ID should + be restored even in cases where DoWork() exits via exception. + 2. If you cannot change the DoWork() code: Save the activity ID before + calling DoWork(), then restore the activity ID after DoWork() returns. You + can use the EventActivityIdControl function to save and restore the + activity ID. + 3. Use TraceLoggingActivity instead of TraceLoggingThreadActivity so that you + are not impacted by code that incorrectly manages thread.ActivityId. In + this case, you will also need to switch from TraceLoggingWrite to + TraceLoggingWriteTagged. + + Example of solution 2: + + GUID savedActivityId; + EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_ID, &savedActivityId); + CodeThatDoesNotRestoreActivityId(); + EventActivityIdControl(EVENT_ACTIVITY_CTRL_SET_ID, &savedActivityId); + + Note that this example solution is sufficient only in cases where + the code in question does not throw exceptions. + */ + _tlg_ASSERT(_tlgGuidEqual(m_Id, m_CapturedRelatedId), "_TlgActivityBase: current id does not match set id!"); + } + } + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +public: + + /* + The activity's Keyword, which is used as the keyword for the START and STOP events. + */ + static const UINT64 Keyword = keyword; + + /* + The activity's Level, which is used as the level for the START and STOP events. + */ + static const UINT8 Level = level; + + /* + Returns the activity Id. + */ + _Ret_ const GUID* Id() const + { + _tlg_ASSERT(m_State >= TlgStateStarted, "TraceLoggingActivity::Id() called from invalid state"); + _tlg_ASSERT(m_State != TlgStateDestroyed, "TraceLoggingActivity::Id() called after destruction"); + return &m_Id; + } + + /* + Returns true if the activity has been started and has not yet been stopped. + */ + bool IsStarted() const + { + return m_State == TlgStateStarted; + } + + /* + Private implementation method. For internal use only. + Called by TraceLoggingWriteStart. Do not call directly. + Returns the related activity Id, if there is one. + Returns NULL if the related activity Id has not been set or if it is GUID_NULL. + */ + _Ret_opt_ const GUID* zInternalRelatedId() const + { + _tlg_ASSERT(m_State == TlgStateStarted, "TraceLoggingWriteStart race condition"); + return GetRelatedId(); + } + + /* + Private implementation method. For internal use only. + Called by TraceLoggingWriteStart. Do not call directly. + */ + void zInternalStart() + { + _tlg_ASSERT(m_State == TlgStateCreated, "TraceLoggingWriteStart called from invalid state."); + + DerivedTy* pDerived = static_cast(this); + if (TraceLoggingProviderEnabled(pDerived->Provider(), level, keyword)) + { + CreateActivityId(0, pDerived, m_Id); + pDerived->OnStarted(); + } + else + { + // Zero the activity id in case we end up logging the stop. + ZeroMemory(&m_Id, sizeof(m_Id)); + } + + m_State = TlgStateStarted; + } + + /* + Private implementation method. For internal use only. + Called by TraceLoggingWriteStop. Do not call directly. + */ + void zInternalStop() + { + _tlg_ASSERT(m_State == TlgStateStarted, "TraceLoggingWriteStop called from invalid state"); + + DerivedTy* pDerived = static_cast(this); + pDerived->OnStopped(); + + m_State = TlgStateStopped; + } + +private: + // SFINAE dispatching on presence of DerivedTy::CreateActivityId + template + static auto CreateActivityId(int, _In_ _DerivedTy* Derived, _Out_ GUID& ChildActivityId) -> + decltype(Derived->CreateActivityId(ChildActivityId), void(0)) + { + Derived->CreateActivityId(ChildActivityId); + } + + template + static auto CreateActivityId(long, _In_ _DerivedTy* Derived, _Out_ GUID& ChildActivityId) -> + void + { + (void)Derived; + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_CREATE_ID, &ChildActivityId); + } +}; + +template< + TraceLoggingHProvider const& provider, + UINT64 keyword, + UINT8 level, + typename TlgReflectorTag> +class TraceLoggingActivity + : public _TlgActivityBase, keyword, level> +{ + typedef + _TlgActivityBase, keyword, level> + BaseTy; + friend BaseTy; + + void OnStarted() + { + } + + void OnStopped() + { + } + +public: + + TraceLoggingActivity() + { + } + +#if defined(_MSC_VER) && (_MSC_VER >= 1600) + + TraceLoggingActivity(TraceLoggingActivity&& rhs) + : BaseTy(static_cast(rhs)) + { + } + + TraceLoggingActivity& operator=(TraceLoggingActivity&& rhs) + { + BaseTy::operator=(static_cast(rhs)); + return *this; + } + +#endif // _MSC_VER >= 1600 + + /* + Returns a handle to the TraceLogging provider associated with this activity. + */ + TraceLoggingHProvider Provider() const + { + return provider; + } + + /* + Sets the related (parent) activity. + May only be called once. Must be called before starting the activity. + */ + template + void SetRelatedActivity(_In_ const ActivityTy& relatedActivity) + { + BaseTy::SetRelatedId(*relatedActivity.Id()); + } + + /* + Sets the related (parent) activity. + May only be called once. Must be called before starting the activity. + */ + void SetRelatedActivityId(_In_ const GUID& relatedActivityId) + { + BaseTy::SetRelatedId(relatedActivityId); + } + + /* + Sets the related (parent) activity. + May only be called once. Must be called before starting the activity. + */ + void SetRelatedActivityId(_In_ const GUID* relatedActivityId) + { + _tlg_ASSERT(relatedActivityId != NULL, "TraceLoggingActivity SetRelatedActivity called with NULL id."); + BaseTy::SetRelatedId(*relatedActivityId); + } +}; + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +template< + TraceLoggingHProvider const& provider, + UINT64 keyword, + UINT8 level, + typename TlgReflectorTag> +class TraceLoggingThreadActivity + : public _TlgActivityBase, keyword, level> +{ + typedef + _TlgActivityBase, keyword, level> + BaseTy; + friend BaseTy; + + void OnStarted() + { + BaseTy::PushThreadActivityId(); + } + + void OnStopped() + { + BaseTy::PopThreadActivityId(); + } + +public: + + TraceLoggingThreadActivity() + { + } + +#if defined(_MSC_VER) && (_MSC_VER >= 1600) + + TraceLoggingThreadActivity(TraceLoggingThreadActivity&& rhs) + : BaseTy(static_cast(rhs)) + { + } + + TraceLoggingThreadActivity& operator=(TraceLoggingThreadActivity&& rhs) + { + BaseTy::operator=(static_cast(rhs)); + return *this; + } + +#endif // _MSC_VER >= 1600 + + /* + Returns a handle to the TraceLogging provider associated with this activity. + */ + TraceLoggingHProvider Provider() const + { + return provider; + } +}; + +class TraceLoggingThreadActivityIdSetter +{ + GUID m_ActivityId; + GUID m_SavedActivityId; + + TraceLoggingThreadActivityIdSetter(const TraceLoggingThreadActivityIdSetter&); // = delete + const TraceLoggingThreadActivityIdSetter& operator=(const TraceLoggingThreadActivityIdSetter&); // = delete + +public: + + explicit TraceLoggingThreadActivityIdSetter(_In_ const GUID& activityId) + : m_ActivityId(activityId) + , m_SavedActivityId(activityId) + { + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_SET_ID, &m_SavedActivityId); + } + + explicit TraceLoggingThreadActivityIdSetter(_In_ const GUID* activityId) + : m_ActivityId(*activityId) + , m_SavedActivityId(*activityId) + { + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_SET_ID, &m_SavedActivityId); + } + + ~TraceLoggingThreadActivityIdSetter() + { + ::EventActivityIdControl(EVENT_ACTIVITY_CTRL_GET_SET_ID, &m_SavedActivityId); + _tlg_ASSERT(_tlgGuidEqual(m_ActivityId, m_SavedActivityId), "TraceLoggingThreadActivityIdSetter current id does not match set id!"); + } +}; + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma endregion + +#endif // RC_INVOKED diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingProvider.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingProvider.h new file mode 100644 index 0000000000000000000000000000000000000000..ca516fb699e2272fd48dd25fde2b88fc77ef851b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/TraceLoggingProvider.h @@ -0,0 +1,4616 @@ +/* ++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + TraceLoggingProvider.h + +Abstract: + + Event Provider API for C/C++. + +Environment: + + User mode or kernel mode. + +--*/ + +/* +Quick start: + +#include // or for kernel-mode. +#include + +TRACELOGGING_DEFINE_PROVIDER( // defines g_hProvider + g_hProvider, // Name of the provider variable + "MyProvider", // Human-readable name of the provider + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71)); // Provider GUID + +int main(int argc, char* argv[]) // or DriverEntry for kernel-mode. +{ + TraceLoggingRegister(g_hProvider); + TraceLoggingWrite( + g_hProvider, + "MyEvent1", + TraceLoggingString(argv[0], "arg0"), // field name is "arg0" + TraceLoggingInt32(argc)); // field name is implicitly "argc" + TraceLoggingUnregister(g_hProvider); + return 0; +} + +Usage note: + +Symbols starting with T are part of the public interface of this header. +Symbols starting with _tlg or _Tlg are private internal implementation +details that are not supported for use outside this header and may change in +future releases. + +Compatibility note: + +TraceLoggingProvider.h needs to use the EventSetInformation/EtwSetInformation +API on systems where it is available. Depending on its configuration, +TraceLoggingProvider.h can access this API via GetProcAddress (sub-optimal, +but compatible with Vista or later), or can link directly against the needed +API (optimal but only works on OS versions that have the API). +TraceLoggingProvider.h uses WINVER (user mode) and NTDDI_VERSION (kernel mode) +to determine whether it should be compatible with earlier OS versions or be +optimized for newer OS versions. + +For user-mode, if you include before setting WINVER, +will set WINVER to the SDK's default target OS version. If WINVER is set to +0x602 or higher, TraceLoggingProvider.h will optimize its behavior for Windows +8 and your program will not run on earlier versions of Windows. If you need +your program to run on Vista or Windows 7, be sure to set WINVER to the +appropriate value before including . + +For kernel-mode, if you include before setting NTDDI_VERSION, +will set NTDDI_VERSION to a default value. If NTDDI_VERSION is set to +0x06040000 or higher, TraceLoggingProvider.h will optimize its behavior for +Windows 10 and your driver will not work on earlier versions of Windows. + +If you need to adjust this behavior, refer to the comments for the +TLG_HAVE_EVENT_SET_INFORMATION macro. +*/ + +#ifndef _traceloggingprovider_ +#define _traceloggingprovider_ +#pragma once + +#include + +#if !defined(RC_INVOKED) + +#pragma warning(push) +#pragma warning(disable:4055) // Allow cast from a PVOID to a PFN +#pragma warning(disable:4626) // assignment operator deleted +#pragma warning(disable:4995 4996) // strlen/wcslen marked as deprecated +#pragma warning(disable:25033) // Nonconst psz parameter +#if defined(_M_ARM) || defined(_M_ARM64) || defined(_M_ARM64EC) +#pragma warning(disable:4714) // __forceinline not inlined +#endif + +#ifdef __cplusplus +extern "C" { +#endif // __cplusplus + +#pragma region Configuration macros and typedefs + +#ifdef _ETW_KM_ +typedef PETWENABLECALLBACK TLG_PENABLECALLBACK; +typedef NTSTATUS TLG_STATUS; +#else // _ETW_KM_ +typedef PENABLECALLBACK TLG_PENABLECALLBACK; +typedef HRESULT TLG_STATUS; +#endif // _ETW_KM_ + +/* +The TLG_HAVE_EVENT_SET_INFORMATION can be set before including this header to +control how the TraceLoggingSetInformation function should behave. +TraceLoggingSetInformation is complex because the underlying Windows API +(EventSetInformation or EtwSetInformation) is not available on all versions of +Windows supported by TraceLoggingProvider. While TraceLoggingProvider.h works +correctly without the SetInformation API, it works better when the +SetInformation API is present. If TLG_HAVE_EVENT_SET_INFORMATION is left +unset, TraceLoggingSetInformation will use a default behavior that works for +most situations. + +Note that TraceLoggingSetInformation is called during TraceLoggingRegister. + +If both TLG_HAVE_EVENT_SET_INFORMATION and TLG_EVENT_SET_INFORMATION are +undefined, TraceLoggingSetInformation(...) behavior will depend on the Windows +version targeted at compile time, as determined by WINVER (user-mode) or +NTDDI_VERSION (kernel-mode). If the EventSetInformation API is available on +the targeted version of Windows, it will be called directly. Otherwise, +TraceLoggingSetInformation will use GetProcAddress (user-mode) or +MmGetSystemRoutineAddress (kernel-mode) in an attempt to locate the API. + +If TLG_HAVE_EVENT_SET_INFORMATION is undefined but TLG_EVENT_SET_INFORMATION +is defined, TraceLoggingSetInformation(...) will invoke +TLG_EVENT_SET_INFORMATION(...). + +If TLG_HAVE_EVENT_SET_INFORMATION is set to 0, TraceLoggingSetInformation(...) +will do nothing and will always return a NOT_SUPPORTED error. + +If TLG_HAVE_EVENT_SET_INFORMATION is set to 1 and the +TLG_EVENT_SET_INFORMATION macro is not defined, +TraceLoggingSetInformation(...) will directly invoke EventSetInformation(...) +for user-mode or EtwSetInformation(...) for kernel-mode. + +If TLG_HAVE_EVENT_SET_INFORMATION is set to 1 and the +TLG_EVENT_SET_INFORMATION macro is defined, +TraceLoggingSetInformation(...) will invoke TLG_EVENT_SET_INFORMATION(...). + +If TLG_HAVE_EVENT_SET_INFORMATION is set to 2, TraceLoggingSetInformation(...) +will attempt to load EventSetInformation via GetProcAddress (user-mode) or +will attempt to load EtwSetInformation via MmGetSystemRoutineAddress +(kernel-mode). If the load is successful, it will be invoked. Otherwise, +TraceLoggingSetInformation will return an error. +*/ +#ifndef TLG_HAVE_EVENT_SET_INFORMATION + #if defined(TLG_EVENT_SET_INFORMATION) + #define TLG_HAVE_EVENT_SET_INFORMATION 1 + #elif defined(_ETW_KM_) + #if NTDDI_VERSION < 0x06040000 + #define TLG_HAVE_EVENT_SET_INFORMATION 2 // Find "EtwSetInformation" via MmGetSystemRoutineAddress + #else + #define TLG_HAVE_EVENT_SET_INFORMATION 1 // Directly invoke TLG_EVENT_SET_INFORMATION(...) + #endif + #else // User-mode + #if WINVER < 0x0602 || !defined(EVENT_FILTER_TYPE_SCHEMATIZED) + #define TLG_HAVE_EVENT_SET_INFORMATION 2 // Find "EventSetInformation" via GetModuleHandleExW/GetProcAddress + #else + #define TLG_HAVE_EVENT_SET_INFORMATION 1 // Directly invoke TLG_EVENT_SET_INFORMATION(...) + #endif + #endif // TLG_EVENT_SET_INFORMATION +#endif // TLG_HAVE_EVENT_SET_INFORMATION + +/* +Determine whether TraceLoggingWriteEx should be defined. +- If TLG_EVENT_WRITE_EX is defined, TraceLoggingWriteEx will be defined. +- Otherwise, if target is kernel-mode with NTDDI_VERSION >= 0x06010000, + TraceLoggingWriteEx will be defined. +- Otherwise, if target is user-mode with WINVER >= 0x0601, TraceLoggingWriteEx + will be defined. +- Otherwise, TraceLoggingWriteEx will not be defined by this header. +*/ +#ifdef TLG_EVENT_WRITE_EX + #define _tlg_ENABLE_TraceLoggingWriteEx 1 +#elif defined(_ETW_KM_) + #define _tlg_ENABLE_TraceLoggingWriteEx NTDDI_VERSION >= 0x06010000 +#else + #define _tlg_ENABLE_TraceLoggingWriteEx WINVER >= 0x0601 +#endif + +/* +The following override macros can be defined before including this header to +control the APIs used by this header: + +- TLG_EVENT_REGISTER +- TLG_EVENT_UNREGISTER +- TLG_EVENT_SET_INFORMATION +- TLG_EVENT_WRITE_TRANSFER +- TLG_EVENT_WRITE_EX + +If the the macro is undefined, the TraceLoggingProvider.h implementation will +default to the corresponding ETW APIs. For example, if the TLG_EVENT_REGISTER +macro is undefined, TraceLoggingRegister will use EventRegister in user mode +and will use EtwRegister in kernel mode. + +To prevent issues from conflicting definitions of these macros, the value of +the override macro will be used as a suffix in certain internal function names. +Because of this, the override macros must follow certain rules: + +- The macro must be defined before TraceLoggingProvider.h is included and must + not be undefined or redefined after TraceLoggingProvider.h is included. + Different translation units (i.e. different .c or .cpp files) may set the + macros to different values, but within a translation unit (within a single + .c or .cpp file), the macro must be set once and not changed. +- The override must be an object-like macro, not a function-like + macro (i.e. the override macro must not have a parameter list). +- The override macro's value must be a simple identifier, i.e. must be + something that starts with a letter or '_' and contains only letters, + numbers, and '_' characters. +- If the override macro's value is the name of a second object-like macro, the + second object-like macro must follow the same rules. (The override macro's + value can also be the name of a function-like macro, in which case the + function-like macro does not need to follow the same rules.) + +For example, the following will cause compile errors: + + #define TLG_EVENT_WRITE_TRANSFER MyNamespace::MyClass::MyFunction // Value has non-identifier characters (colon). + #define TLG_EVENT_WRITE_TRANSFER GetEventWriteFunctionPointer(7) // Value has non-identifier characters (parentheses). + #define TLG_EVENT_WRITE_TRANSFER(h,e,a,r,c,d) EventWrite(h,e,c,d) // Override is defined as a function-like macro. + #define MY_OBJECT_LIKE_MACRO MyNamespace::MyClass::MyEventWriteFunction + #define TLG_EVENT_WRITE_TRANSFER MY_OBJECT_LIKE_MACRO // Evaluates to something with non-identifier characters (colon). + +The following would be ok: + + #define TLG_EVENT_WRITE_TRANSFER MyEventWriteFunction1 // OK, suffix will be "MyEventWriteFunction1". + #define MY_OBJECT_LIKE_MACRO MyEventWriteFunction2 + #define TLG_EVENT_WRITE_TRANSFER MY_OBJECT_LIKE_MACRO // OK, suffix will be "MyEventWriteFunction2". + #define MY_FUNCTION_LIKE_MACRO(h,e,a,r,c,d) MyNamespace::MyClass::MyEventWriteFunction3(h,e,c,d) + #define TLG_EVENT_WRITE_TRANSFER MY_FUNCTION_LIKE_MACRO // OK, suffix will be "MY_FUNCTION_LIKE_MACRO". +*/ +#ifdef _ETW_KM_ +#ifndef TLG_EVENT_REGISTER + #define TLG_EVENT_REGISTER EtwRegister +#endif +#ifndef TLG_EVENT_UNREGISTER + #define TLG_EVENT_UNREGISTER EtwUnregister +#endif +#ifndef TLG_EVENT_SET_INFORMATION + #define TLG_EVENT_SET_INFORMATION EtwSetInformation +#endif +#ifndef TLG_EVENT_WRITE_TRANSFER + #define TLG_EVENT_WRITE_TRANSFER EtwWriteTransfer +#endif +#ifndef TLG_EVENT_WRITE_EX + #define TLG_EVENT_WRITE_EX EtwWriteEx +#endif +#else // _ETW_KM_ +#ifndef TLG_EVENT_REGISTER + #define TLG_EVENT_REGISTER EventRegister +#endif +#ifndef TLG_EVENT_UNREGISTER + #define TLG_EVENT_UNREGISTER EventUnregister +#endif +#ifndef TLG_EVENT_SET_INFORMATION + #define TLG_EVENT_SET_INFORMATION EventSetInformation +#endif +#ifndef TLG_EVENT_WRITE_TRANSFER + #define TLG_EVENT_WRITE_TRANSFER EventWriteTransfer +#endif +#ifndef TLG_EVENT_WRITE_EX + #define TLG_EVENT_WRITE_EX EventWriteEx +#endif +#endif // _ETW_KM_ + +#ifndef TLG_PAGED_CODE + #ifdef _ETW_KM_ + #define TLG_PAGED_CODE() PAGED_CODE() + #else // _ETW_KM_ + #define TLG_PAGED_CODE() ((void)0) + #endif // _ETW_KM_ +#endif // TLG_PAGED_CODE + +#ifndef TLG_INLINE + #ifndef __cplusplus + #define TLG_INLINE __inline + #else + #define TLG_INLINE inline + #endif // __cplusplus +#endif + +#ifndef TLG_NULL + #ifndef __cplusplus + #define TLG_NULL NULL + #else + #define TLG_NULL nullptr + #endif // __cplusplus +#endif // TLG_NULL + +#ifndef TLG_DEBUG + #if (DBG || defined(DEBUG) || defined(_DEBUG)) && !defined(NDEBUG) + #define TLG_DEBUG 1 + #else // DBG + #define TLG_DEBUG 0 + #endif // DBG +#endif // TLG_DEBUG + +#ifndef TLG_RAISEASSERTIONFAILURE + #if defined(__clang__) || defined(_M_CEE) + #define TLG_RAISEASSERTIONFAILURE() __debugbreak() + #else + #define TLG_RAISEASSERTIONFAILURE() DbgRaiseAssertionFailure() + #endif +#endif // TLG_RAISEASSERTIONFAILURE + +#ifndef TLG_PFORCEINLINE + #if defined(PFORCEINLINE) + #define TLG_PFORCEINLINE PFORCEINLINE + #elif defined(FORCEINLINE) + #define TLG_PFORCEINLINE FORCEINLINE + #else + #define TLG_PFORCEINLINE __forceinline + #endif +#endif // TLG_PFORCEINLINE + +#ifdef __cplusplus + #define _tlg_EXTERN_C extern "C" + #define _tlg_EXTERN_C_CONST extern "C" const +#else + #define _tlg_EXTERN_C extern // In C, linkage is always "C". + #define _tlg_EXTERN_C_CONST const // In C, extern with initializer is wrong. +#endif // __cplusplus + +#define _tlg_CALL __stdcall + +/* +Internal implementation detail: Handler macros. +Wrapper macros (e.g. TraceLoggingInt32) are defined in terms of a handler. +The following macros are the first stage in unwrapping the handler parameters. +The unwrapping performed here is somewhat trivial and could be pushed into the +wrapper macro, but defining these handler macros as a separate layer provides +some IntelliSense and code documentation benefits. +NOTE: Do not call these directly. These macros may change or be renamed in +future versions of this header. Instead, call a public wrapper macro such as +TraceLoggingInt32 or TraceLoggingString. +*/ +#define _tlgArgAuto( value, ...) /* for TraceLoggingValue. */ \ + (_tlgAuto, value, _tlgNDT(value, __VA_ARGS__)) +#define _tlgArgScalarVal( ctype, value, inType, outType, ...) /* for by-value scalar. */ \ + (_tlgScalarVal, ctype, value, inType, _tlgExpandType(outType), _tlgNDT(value, __VA_ARGS__)) +#define _tlgArgScalarRef( ctype, value, inType, outType, ...) /* for by-ref scalar (in C, must be an lvalue). */ \ + (_tlgScalarRef, ctype, value, inType, _tlgExpandType(outType), _tlgNDT(value, __VA_ARGS__)) +#define _tlgArgSid( ctype, pValue, ...) /* for SID*. */ \ + (_tlgSid, ctype, pValue, _tlgNDT(pValue, __VA_ARGS__)) +#define _tlgArgPsz( ctype, pszValue, inType, outType, ...) /* for nul-terminated string. */ \ + (_tlgPsz, ctype, pszValue, inType, _tlgExpandType(outType), _tlgNDT(pszValue, __VA_ARGS__)) +#define _tlgArgBuffer( ctype, pValue, inType, outType, ...) /* for UNICODE_STRING*, STRING*, etc. */ \ + (_tlgBuffer, ctype, pValue, inType, _tlgExpandType(outType), _tlgNDT(pValue, __VA_ARGS__)) +#define _tlgArgArray( ctype, pValues, cValues, inType, outType, ...) /* for variable-length array with count of elements. */ \ + (_tlgArray, ctype, pValues, cValues, inType, _tlgExpandType(outType), _tlgNDT(pValues, __VA_ARGS__)) +#define _tlgArgBinary( ctype, pValue, cbValue, inType, outType, ...) /* for variable-length array with count of bytes. */ \ + (_tlgBinary, ctype, pValue, cbValue, inType, _tlgExpandType(outType), _tlgNDT(pValue, __VA_ARGS__)) +#define _tlgArgCounted( ctype, pchValue, cchValue, inType, outType, ...) /* for counted strings. */ \ + (_tlgCounted, ctype, pchValue, cchValue, inType, _tlgExpandType(outType), _tlgNDT(pchValue, __VA_ARGS__)) +#define _tlgArgFixedArray( ctype, pValues, cValues, inType, outType, ...) /* for fixed-length array with count of elements. */ \ + (_tlgFixedArray, ctype, pValues, cValues, inType, _tlgExpandType(outType), _tlgNDT(pValues, __VA_ARGS__)) +#define _tlgArgPackedField(ctype, pValue, cbValue, inType, outType, ...) /* for user-marshalled data and metadata. */ \ + (_tlgPackedField,ctype, pValue, cbValue, inType, _tlgExpandType(outType), _tlgNDT(pValue, __VA_ARGS__)) +#define _tlgArgPackedMeta( name, inType, outType, ...) /* for user-marshalled metadata. */ \ + (_tlgPackedMeta, inType, _tlgExpandType(outType), _tlgDT(name, __VA_ARGS__)) +#define _tlgArgPackedData( ctype, pValue, cbValue, dataDescType ) /* for user-marshalled data. */ \ + (_tlgPackedData, ctype, pValue, cbValue, _tlgExpandType(dataDescType)) +#define _tlgArgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,...) /* for user-serialized data and schema. */ \ + (_tlgCustom, ctype, pValue, cbValue, protocol,bSchema,cbSchema,_tlgNDT(pValue, __VA_ARGS__)) +#define _tlgArgStruct( fieldCount, name, inType, ...) /* for struct and array of struct. */ \ + (_tlgStruct, fieldCount, inType, _tlgDT(name, __VA_ARGS__)) +#define _tlgArgChannel( eventChannel) /* for TraceLoggingChannel. */ \ + (_tlgChannel, eventChannel) +#define _tlgArgLevel( eventLevel) /* for TraceLoggingLevel. */ \ + (_tlgLevel, eventLevel) +#define _tlgArgOpcode( eventOpcode) /* for TraceLoggingOpcode. */ \ + (_tlgOpcode, eventOpcode) +#define _tlgArgKeyword( eventKeyword) /* for TraceLoggingKeyword. */ \ + (_tlgKeyword, eventKeyword) +#define _tlgArgTag( eventTag) /* for TraceLoggingEventTag. */ \ + (_tlgTag, eventTag) +#define _tlgArgDesc( eventDescription) /* for TraceLoggingDescription. */ \ + (_tlgDesc, eventDescription) +#define _tlgArgCustomAnnot(key, value) /* for TraceLoggingCustomAttribute. */ \ + (_tlgCustomAnnot,key, value) + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_PASTE2(a, b) _tlg_PASTE2_imp(a, b) +#define _tlg_PASTE2_imp(a, b) a##b + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_PASTE3(a, b, c) _tlg_PASTE3_imp(a, b, c) +#define _tlg_PASTE3_imp(a, b, c) a##b##_##c + +// Helpers for override macro validation. +typedef void TLG_EVENT_REGISTER_must_not_be_a_functionLike_macro_TLG_EVENT_REGISTER; +typedef void TLG_EVENT_UNREGISTER_must_not_be_a_functionLike_macro_TLG_EVENT_UNREGISTER; +typedef void TLG_EVENT_SET_INFORMATION_must_not_be_a_functionLike_macro_TLG_EVENT_SET_INFORMATION; +typedef void TLG_EVENT_WRITE_TRANSFER_must_not_be_a_functionLike_macro_TLG_EVENT_WRITE_TRANSFER; +typedef void TLG_EVENT_WRITE_EX_must_not_be_a_functionLike_macro_TLG_EVENT_WRITE_EX; + +/* +Validate override macros - trigger compile errors if the override macros do +not follow the rules. (The full list of rules and some examples are given near +the top of this header.) +*/ + +// Trigger an error if TLG_EVENT_REGISTER is not an unqualified (simple) identifier: +struct _tlg_PASTE2(TLG_EVENT_REGISTER_definition_must_be_an_unqualified_identifier_, TLG_EVENT_REGISTER); + +// Trigger an error if TLG_EVENT_REGISTER is defined as a function-like macro: +typedef int _tlg_PASTE2(TLG_EVENT_REGISTER_must_not_be_a_functionLike_macro_, TLG_EVENT_REGISTER); + +// Trigger an error if TLG_EVENT_UNREGISTER is not an unqualified (simple) identifier: +struct _tlg_PASTE2(TLG_EVENT_UNREGISTER_definition_must_be_an_unqualified_identifier_, TLG_EVENT_UNREGISTER); + +// Trigger an error if TLG_EVENT_UNREGISTER is defined as a function-like macro: +typedef int _tlg_PASTE2(TLG_EVENT_UNREGISTER_must_not_be_a_functionLike_macro_, TLG_EVENT_UNREGISTER); + +// Trigger an error if TLG_EVENT_SET_INFORMATION is not an unqualified (simple) identifier: +struct _tlg_PASTE2(TLG_EVENT_SET_INFORMATION_definition_must_be_an_unqualified_identifier_, TLG_EVENT_SET_INFORMATION); + +// Trigger an error if TLG_EVENT_SET_INFORMATION is defined as a function-like macro: +typedef int _tlg_PASTE2(TLG_EVENT_SET_INFORMATION_must_not_be_a_functionLike_macro_, TLG_EVENT_SET_INFORMATION); + +// Trigger an error if TLG_EVENT_WRITE_TRANSFER is not an unqualified (simple) identifier: +struct _tlg_PASTE2(TLG_EVENT_WRITE_TRANSFER_definition_must_be_an_unqualified_identifier_, TLG_EVENT_WRITE_TRANSFER); + +// Trigger an error if TLG_EVENT_WRITE_TRANSFER is defined as a function-like macro: +typedef int _tlg_PASTE2(TLG_EVENT_WRITE_TRANSFER_must_not_be_a_functionLike_macro_, TLG_EVENT_WRITE_TRANSFER); + +// Trigger an error if TLG_EVENT_WRITE_EX is not an unqualified (simple) identifier: +struct _tlg_PASTE2(TLG_EVENT_WRITE_EX_definition_must_be_an_unqualified_identifier_, TLG_EVENT_WRITE_EX); + +// Trigger an error if TLG_EVENT_WRITE_EX is defined as a function-like macro: +typedef int _tlg_PASTE2(TLG_EVENT_WRITE_EX_must_not_be_a_functionLike_macro_, TLG_EVENT_WRITE_EX); + +#if TLG_HAVE_EVENT_SET_INFORMATION == 1 + #define _tlg_EVENT_SET_INFORMATION_suffix TLG_EVENT_SET_INFORMATION +#elif TLG_HAVE_EVENT_SET_INFORMATION == 2 + #ifdef _ETW_KM_ + #define _tlg_EVENT_SET_INFORMATION_suffix 2K + #else // _ETW_KM_ + #define _tlg_EVENT_SET_INFORMATION_suffix 2U + #endif // _ETW_KM_ +#else // TLG_HAVE_EVENT_SET_INFORMATION == 0 + #define _tlg_EVENT_SET_INFORMATION_suffix 0 +#endif // TLG_HAVE_EVENT_SET_INFORMATION + +/* +Determine the full (ODR-safe) name for tracelogging functions that are affected +by macro overrides. +*/ +#define TraceLoggingUnregister _tlg_PASTE2(TraceLoggingUnregister_, TLG_EVENT_UNREGISTER) +#define TraceLoggingRegister _tlg_PASTE3(TraceLoggingRegister_, TLG_EVENT_REGISTER, _tlg_EVENT_SET_INFORMATION_suffix) +#define TraceLoggingRegisterEx _tlg_PASTE3(TraceLoggingRegisterEx_, TLG_EVENT_REGISTER, _tlg_EVENT_SET_INFORMATION_suffix) +#define TraceLoggingSetInformation _tlg_PASTE2(TraceLoggingSetInformation_, _tlg_EVENT_SET_INFORMATION_suffix) +#define _tlgWriteTransfer _tlg_PASTE2(_tlgWriteTransfer_, TLG_EVENT_WRITE_TRANSFER) +#define _tlgWriteEx _tlg_PASTE2(_tlgWriteEx_, TLG_EVENT_WRITE_EX) + +#pragma endregion + +#pragma region Public interface + +/* +Typedef TraceLoggingHProvider: +The type of a provider handle. +To define a provider handle, use TRACELOGGING_DEFINE_PROVIDER. +To forward-declare a provider handle, use TRACELOGGING_DECLARE_PROVIDER. + +Notes: + +The _tlgProvider_t type is an internal implementation detail. Do not use the +_tlgProvider_t type directly, as it may be changed or renamed in future +versions of this header. Use the TraceLoggingHProvider type and the provided +accessor functions instead of reading members directly. + +The scope of a TraceLogging provider handle is strictly limited to the module +(the DLL or EXE) in which it is defined. The provider handle from one module +must not be shared with code in other modules. In other words, for any handle +g_hProvider, all instances of TraceLoggingWrite(g_hProvider, ...) must reside +in the same EXE or DLL as the TRACELOGGING_DEFINE_PROVIDER(g_hProvider, ...) +definition. If this rule is not followed, the behavior of TraceLoggingWrite is +unpredictable. + +The TraceLoggingHProvider type should almost never need to be used directly. +In most cases, the provider handle should be a global variable that is defined +and declared using TRACELOGGING macros. In most cases, all uses of the +provider handle will refer directly to this global variable (no copies of the +global variable are made), so user-defined variables of type +TraceLoggingHProvider should usually be unnecessary. (Using the global variable +directly also results in the most efficient code and automatically avoids the +scoping problem described above.) +*/ +typedef struct _tlgProvider_t const* TraceLoggingHProvider; + +/* +Macro TRACELOGGING_DEFINE_PROVIDER(hProviderVariableName, "ProviderName", providerId, [option]): +Invoke this macro to allocate static storage for a provider and define a +TraceLoggingHProvider variable that references the storage. + +An invocation of + + TRACELOGGING_DEFINE_PROVIDER( + g_hMyProvider, + "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71)); + +can be thought of as expanding to something like this: + + static [ProviderStateType] uniqueVarName = { ... }; // stores provider state + extern "C" const TraceLoggingHProvider g_hMyProvider = &uniqueVarName; // defines a handle + +The "ProviderName" specifies a name that identifies the provider in the logged +events. It must be a char string literal (not a variable) and must not contain +any '\0' characters. It must be specific enough to distinguish your provider +from other providers on the system. Typically, provider names use a hierarchy +for unique identification, e.g. "MyCompany.MyOrganization.MyComponent". + +The providerId specifies the ETW provider GUID. This GUID must be linked with +the "ProviderName", i.e. the name should never be used with any other GUID, and +the GUID should never be used with any other name. While it is acceptable to +generate the GUID using guidgen or another UUID generation tool, we recommend +that the GUID be generated as a hash of the name using the algorithm shown in +this C# code: + + static Guid ProviderIdFromName(string name) + { + var signature = new byte[] { + 0x48, 0x2C, 0x2D, 0xB2, 0xC3, 0x90, 0x47, 0xC8, + 0x87, 0xF8, 0x1A, 0x15, 0xBF, 0xC1, 0x30, 0xFB }; + var nameBytes = Encoding.BigEndianUnicode.GetBytes(name.ToUpperInvariant()); + using (var sha1 = new SHA1Managed()) + { + sha1.TransformBlock(signature, 0, signature.Length, null, 0); + sha1.TransformFinalBlock(nameBytes, 0, nameBytes.Length); + var hash = sha1.Hash; + Array.Resize(ref hash, 16); + hash[7] = (byte)((hash[7] & 0x0F) | 0x50); + return new Guid(hash); + } + } + +The providerId parameter must be a parenthesized list of 11 compile-time +constant integers e.g. (g1, g2, g3, ... g11). The integers will be used to +initialize the provider ID as follows: + + GUID providerId = { g1, g2, g3, g4, g5, g6, g7, g8, g9, g10, g11 }; + +After the providerId GUID, you may optionally specify a TraceLoggingOption... +macro to configure your provider, e.g. + + TRACELOGGING_DEFINE_PROVIDER(g_hMyProvider, "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71), + TraceLoggingOptionGroup(0xfaaf2f61, 0x9b26, 0x4591, 0x9b, 0xb1, 0xb9, 0xb8, 0xba, 0xe2, 0xd3, 0x4c)); + +Note that the provider handle is created in the "unregistered" state. Calls to +TraceLoggingWrite on unregistered handles are no-ops. Call +TraceLoggingRegister to register the handle. + +For kernel-mode, be aware that while provider metadata is explicitly stored +into TLG_METADATA_SEGMENT, the uniqueVarName and g_hMyProvider variables are +not explicitly assigned a segment and will use the current implicit segments. +The TRACELOGGING_DEFINE_PROVIDER macro expects the implicit const and data +segments to be configured appropriately (they usually need to be nonpaged). If +this is not the case already, the caller must set the data segment via #pragma +data_seg (for uniqueVarName) and/or the const segment via #pragma const_seg +(for g_hMyProvider) before invoking the TRACELOGGING_DEFINE_PROVIDER macro. +*/ +#define TRACELOGGING_DEFINE_PROVIDER(handleVariable, providerName, providerId, ...) \ + _tlg_DefineProvider_annotation(handleVariable, _Tlg##handleVariable##Prov, 1, providerName); \ + _tlgProviderStorage_imp(_Tlg##handleVariable##Prov, providerName, providerId, 1, __VA_ARGS__); \ + _tlg_EXTERN_C_CONST TraceLoggingHProvider handleVariable = &_Tlg##handleVariable##Prov + +/* +Macro TRACELOGGING_DEFINE_PROVIDER_STORAGE(storageVariable, "ProviderName", providerId, [option]): +Advanced scenarios only: Use this macro to help create a provider handle +when additional control is needed over the storage of the provider's data. +The provider name must be a string literal (not a variable) and must not +contain any '\0' characters. + +Typical usage: + + TRACELOGGING_DEFINE_PROVIDER_STORAGE(myProviderStorage, "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71)); + const TraceLoggingHProvider g_hMyProvider = &myProviderStorage; + +The above example can be thought of as expanding to something like this: + + static [ProviderStateType] myProviderStorage = { ... }; + const TraceLoggingHProvider g_hMyProvider = &myProviderStorage; + +Refer to the documentation for TRACELOGGING_DEFINE_PROVIDER for the syntax of +the providerId and option parameters. + +For kernel-mode, be aware that while provider metadata is explicitly stored +into TLG_METADATA_SEGMENT, the myProviderStorage variable is not explicitly +assigned a segment and will use the current implicit segment. The +TRACELOGGING_DEFINE_PROVIDER_STORAGE macro expects the implicit data segment to +be configured appropriately (it usually needs to be nonpaged). If this is not +the case already, the caller must set the data segment via #pragma data_seg for +myProviderStorage before invoking the TRACELOGGING_DEFINE_PROVIDER_STORAGE +macro. +*/ +#define TRACELOGGING_DEFINE_PROVIDER_STORAGE(storageVariable, providerName, providerId, ...) \ + _tlgProviderStorage_imp(storageVariable, providerName, providerId, 0, __VA_ARGS__) + +/* +Macro TRACELOGGING_DECLARE_PROVIDER(hProviderVariableName): +Invoke this macro to forward-declare a TraceLoggingHProvider variable that +will be defined by TRACELOGGING_DEFINE_PROVIDER. This is for declaring a global +provider handle variable in a header file. + +An invocation of + + TRACELOGGING_DECLARE_PROVIDER(g_hMyProvider); + +can be thought of as expanding to something like this: + + extern "C" const TraceLoggingHProvider g_hMyProvider; + +A variable declared by TRACELOGGING_DECLARE_PROVIDER must later be defined +using the TRACELOGGING_DEFINE_PROVIDER macro. +*/ +#define TRACELOGGING_DECLARE_PROVIDER(handleVariable) \ + _tlg_EXTERN_C const TraceLoggingHProvider handleVariable + +/* +Macro TraceLoggingOptionGroup(g1, g2, g3, g4, g5, g6, g7, g8, g9, g10, g11): +Advanced scenarios: Wrapper macro for use in TRACELOGGING_DEFINE_PROVIDER that +declares the provider's membership in a provider group (see +https://learn.microsoft.com/windows/win32/etw/provider-traits#provider-groups). +A provider can be a member of no more than one group. The semantics of group +membership are determined by ETW controllers that make use of the group +membership information to configure providers via their group. + +The parameters to this macro are 11 compile-time constant integers that will +form the group GUID. The GUID will be initialized as follows: + + GUID groupId = { g1, g2, g3, g4, g5, g6, g7, g8, g9, g10, g11 }; + +Example: + + TRACELOGGING_DEFINE_PROVIDER( + g_hMyProvider, + "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71), + TraceLoggingOptionGroup(0xfaaf2f61, 0x9b26, 0x4591, 0x9b, 0xb1, 0xb9, 0xb8, 0xba, 0xe2, 0xd3, 0x4c)); +*/ +#define TraceLoggingOptionGroup(g1, g2, g3, g4, g5, g6, g7, g8, g9, g10, g11) \ + TraceLoggingOptionTrait(_TlgOptionGroup, GUID, ({ g1, g2, g3, { g4, g5, g6, g7, g8, g9, g10, g11 } })) + +/* +Macro TraceLoggingOptionTrait(traitType, ctype, value): +Advanced scenarios: Wrapper macro for use in TRACELOGGING_DEFINE_PROVIDER that +adds a custom provider trait to a provider definition (see +https://learn.microsoft.com/en-us/windows/win32/etw/provider-traits#custom-traits). + +Parameters: + +- traitType: Compile-time constant integer value from 128-255 indicating the + user-defined trait type to use for the trait. + +- ctype: C/C++ type to be used for the trait value, e.g. UINT32 or GUID. + +- value: Compile-time constant expression that initializes the trait value, + enclosed in parenthesis, e.g. (32) or ({ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11}). + +Example: + + TRACELOGGING_DEFINE_PROVIDER( + g_hMyProvider, + "MyProvider", + (0xb3864c38, 0x4273, 0x58c5, 0x54, 0x5b, 0x8b, 0x36, 0x08, 0x34, 0x34, 0x71), + TraceLoggingOptionTrait(128, UINT32, ( 45 )); +*/ +#define TraceLoggingOptionTrait(traitType, ctype, value) \ + (_tlgOption, traitType, ctype, value) + +/* +Function TraceLoggingUnregister(hProvider): +Call this function to unregister your provider. Normally you will register at +component startup and unregister at component stop. + +Note that unregistration is important, especially in the case of a DLL (or +driver) that might be dynamically unloaded before the process ends (or the +system shuts down). TraceLoggingRegister sets up an ETW callback. If the DLL +unloads without calling TraceLoggingUnregister, the ETW callback will cause a +crash. + +Thread safety: TraceLoggingRegister/TraceLoggingUnregister are NOT thread-safe +and registration is NOT reference counted. +- Registering an already-registered handle is an error and can cause crashes. +- Calling TraceLoggingRegister(h1) or TraceLoggingUnregister(h1) on one thread + while another thread is in the middle of a call to TraceLoggingRegister(h1), + TraceLoggingUnregister(h1), or TraceLoggingSetInformation(h1) is an error + and can cause crashes. + +Calling TraceLoggingUnregister on an unregistered handle is a safe no-op. + +After unregistering a provider, it is ok to register it again. In other words, +the following is ok: + + TRACELOGGING_DECLARE_PROVIDER(hProvider); + ... + TraceLoggingRegister(hProvider); + ... + TraceLoggingUnregister(hProvider); + ... + TraceLoggingRegister(hProvider); + ... + TraceLoggingUnregister(hProvider); + +However, re-registering a provider should only happen because a component +has been uninitialized and then reinitialized. You should not register and +unregister a provider each time you need to write a few events. +*/ +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +void _tlg_CALL +TraceLoggingUnregister( + TraceLoggingHProvider _Inout_ hProvider); + +/* +Function TraceLoggingRegister(hProvider): +Call this function to register your provider with ETW. + +The provider handle must be in the "unregistered" state (i.e. registration is +not reference counted, and registering an already-registered handle is a +serious error). + +In user-mode, returns an HRESULT code. Use SUCCEEDED to check success. +In kernel-mode, returns an NTSTATUS code. Use NT_SUCCESS to check success. + +Calling TraceLoggingRegister(hProvider) is the same as calling +TraceLoggingRegisterEx(hProvider, NULL, NULL). + +Refer to the documentation in TraceLoggingUnregister for additional information +about registration, especially regarding thread safety. + +Note that it is ok to ignore failure - if TraceLoggingRegister fails, +TraceLoggingWrite and TraceLoggingUnregister will be safe no-ops. The returned +error code is typically only useful during development (i.e. for detection and +diagnosis of programming errors). In production, errors from +TraceLoggingRegister should usually be ignored unless event logging is +security-critical. +*/ +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingRegister( + TraceLoggingHProvider _Inout_ hProvider); + +/* +Function TraceLoggingRegisterEx(hProvider, pEnableCallback, pCallbackContext): +Call this function to register your provider with ETW if you need callbacks +(advanced scenarios only). + +The provider handle must be in the "unregistered" state (i.e. registration is +not reference counted, and registering an already-registered handle is a +serious error). + +In user-mode, returns an HRESULT code. Use SUCCEEDED to check success. +In kernel-mode, returns an NTSTATUS code. Use NT_SUCCESS to check success. + +Refer to the documentation in TraceLoggingUnregister for additional information +about registration, especially regarding thread safety. + +Note that it is ok to ignore failure - if TraceLoggingRegisterEx fails, +TraceLoggingWrite and TraceLoggingUnregister will be safe no-ops. The returned +error code is typically only useful during development (i.e. for detection and +diagnosis of programming errors). In production, errors from +TraceLoggingRegister should usually be ignored unless event logging is +security-critical. +*/ +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingRegisterEx( + TraceLoggingHProvider _Inout_ hProvider, + _In_opt_ TLG_PENABLECALLBACK pEnableCallback, + _In_opt_ PVOID pCallbackContext); + +/* +Function TraceLoggingSetInformation(hProvider, informationClass, pvInformation, cbInformation): +Call this function to provide special-purpose information to the ETW runtime. +For details, see the corresponding ETW API: EventSetInformation. + +Note that the EventSetInformation API is not available on all versions of +Windows. This wrapper has configurable behavior for how it should access the +EventSetInformation API. The default behavior of this function depends on the +value of WINVER (user-mode) or NTDDI_VERSION (kernel-mode). Use the +TLG_HAVE_EVENT_SET_INFORMATION macro to override the default behavior. +*/ +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingSetInformation( + TraceLoggingHProvider _Inout_ hProvider, + _In_ EVENT_INFO_CLASS informationClass, + _In_reads_bytes_opt_(cbInformation) PVOID pvInformation, + _In_ ULONG cbInformation); + +/* +Function TraceLoggingProviderEnabled(hProvider, eventLevel, eventKeyword): +Call this function to determine whether the given provider is enabled for +events with the specified level and keyword. Use 0 for eventLevel to determine +whether the provider is enabled for any level. Use 0 for eventKeyword to +determine whether the provider is enabled for any keyword. + +This function can be used to avoid doing extra work before calling +TraceLoggingWrite. For example, you might use TraceLoggingProviderEnabled for +something like this: + + if (TraceLoggingProviderEnabled(provider, level, keyword)) + { + string expensiveValue = ComputeExpensiveValue(); + TraceLoggingWriteImpl(provider, name, level, keyword, expensiveValue); + } + +Do not use TraceLoggingProviderEnabled simply to avoid calling +TraceLoggingWrite. TraceLoggingWrite performs its own test, i.e. a +TraceLoggingWrite(provider, name, level, keyword, args...) already includes a +check, approximately like: + + if (TraceLoggingProviderEnabled(provider, level, keyword)) + { + TraceLoggingWriteImpl(provider, name, level, keyword, args...); + } + +In this case, making your own call to TraceLoggingProviderEnabled would be +redundant. +*/ +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +BOOLEAN _tlg_CALL +TraceLoggingProviderEnabled( + TraceLoggingHProvider _In_ hProvider, + UCHAR eventLevel, + ULONGLONG eventKeyword); + +/* +Function TraceLoggingProviderId(hProvider): +Returns the provider ID (GUID) that was specified in +TRACELOGGING_DEFINE_PROVIDER. +*/ +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +GUID _tlg_CALL +TraceLoggingProviderId( + TraceLoggingHProvider _In_ hProvider); + +/* +Macro TraceLoggingWrite(hProvider, "EventName", args...): +Invoke this macro to log an event. + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingInt32(myIntVar), + TraceLoggingWideString(myString)); + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Supports up to 99 args (subject to compiler limitations). Each arg must be a +wrapper macro such as TraceLoggingLevel, TraceLoggingKeyword, TraceLoggingInt32, +TraceLoggingString, etc. + +Note that TraceLoggingWrite(hProvider, eventName, args...) is a macro that +checks whether the provider is enabled before evaluating args... and before +writing the data to ETW. In other words, an event like +TraceLoggingWrite(hProvider, eventName, TraceLoggingLevel(level), args...) +expands to an implementation that works as follows: + + if (TraceLoggingProviderEnabled(hProvider, level, keyword)) + { + TraceLoggingWriteImpl(hProvider, eventName, + TraceLoggingLevel(level), args...); + } + +Note that TraceLoggingWrite(hProvider, eventName, args...) is equivalent to +TraceLoggingWriteActivity(hProvider, eventName, NULL, NULL, args...). +- The resulting event will use the current thread's implicit activity ID. +- The resulting event will not include a "related activity ID" attribute. +*/ +#define TraceLoggingWrite(hProvider, eventName, ...) \ + _tlgWrite_imp(_tlgWriteTransfer, \ + hProvider, eventName, \ + (LPCGUID, LPCGUID), \ + (TLG_NULL, TLG_NULL), \ + __VA_ARGS__) + +/* +Macro TraceLoggingWriteActivity(hProvider, "EventName", pActivityId, pRelatedId, args...): +Invoke this macro to log an event with explicitly-specified activity GUIDs. + +Note that pActivityId can be NULL, which will cause the resulting event to use +the current thread's implicit activity ID. + +Note that pRelatedActivityId can be NULL, which will cause the resulting event +to not include a "related activity ID" attribute. In practice, only +activity-start events (Opcode=START) should set the "related activity ID" to +a non-NULL ID. + +Example: + + TraceLoggingWriteActivity( + g_hProvider, + "MyEventName", + pActivityId, + pRelatedActivityId, + TraceLoggingInt32(myIntVar), + TraceLoggingWideString(myString)); + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Supports up to 99 args (subject to compiler limitations). Each arg must be a +wrapper macro such as TraceLoggingLevel, TraceLoggingKeyword, TraceLoggingInt32, +TraceLoggingString, etc. +*/ +#define TraceLoggingWriteActivity(hProvider, eventName, pActivityId, pRelatedActivityId, ...) \ + _tlgWrite_imp(_tlgWriteTransfer, \ + hProvider, eventName, \ + (LPCGUID, LPCGUID), \ + ((pActivityId), (pRelatedActivityId)), \ + __VA_ARGS__) + +#if _tlg_ENABLE_TraceLoggingWriteEx + +/* +Macro TraceLoggingWriteEx(hProvider, "EventName", filter, flags, pActivityId, pRelatedId, args...): +Advanced scenarios: Invoke this macro to log an event with explicitly-specified +filter, flags, and activity GUIDs. Use this macro when you need to set the +filter or flags parameters (see the documentation of EventWriteEx for details). +Otherwise, use the TraceLoggingWrite and TraceLoggingWriteActivity macros. + +This macro is only available if WINVER is set to Windows 7 or later (or if +TLG_EVENT_WRITE_EX has been overridden). + +Example: + + TraceLoggingWriteEx( + g_hProvider, + "MyEventName", + filter, // normally 0 (no filter) + flags, // normally 0 (no flags) + pActivityId, // normally NULL (implicit thread activity ID) + pRelatedActivityId, // normally NULL (no related activity ID) + TraceLoggingInt32(myIntVar), + TraceLoggingWideString(myString)); + +The event name must be a string literal (not a variable) and must not contain +any '\0' characters. + +Supports up to 99 args (subject to compiler limitations). Each arg must be a +wrapper macro such as TraceLoggingLevel, TraceLoggingKeyword, TraceLoggingInt32, +TraceLoggingString, etc. +*/ +#define TraceLoggingWriteEx(hProvider, eventName, filter, flags, pActivityId, pRelatedActivityId, ...) \ + _tlgWrite_imp(_tlgWriteEx, \ + hProvider, eventName, \ + (ULONG64, ULONG, LPCGUID, LPCGUID), \ + ((filter), (flags), (pActivityId), (pRelatedActivityId)), \ + __VA_ARGS__) + +#endif // _tlg_ENABLE_TraceLoggingWriteEx + +/* +Macro TraceLoggingLevel(eventLevel) +Wrapper macro for setting the event's level. + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingLevel(TRACE_LEVEL_WARNING), + TraceLoggingWideString(myString)); + +The eventLevel parameter must be a compile-time constant 0 to 255 (typically +a TRACE_LEVEL_??? constant from evntrace.h or a WINEVENT_LEVEL_??? constant +from winmeta.h). If no TraceLoggingLevel(n) arg is provided, the event will +use logging level 5 (TRACE_LEVEL_VERBOSE). If multiple TraceLoggingLevel(n) +args are provided, the value from the last TraceLoggingLevel(n) will be used. + +ETW event level is stored in each event as an 8-bit value from 0 to 255 +indicating event severity, with lower values being more severe. Levels 0..5 are +defined by Microsoft as log-always=0, critical-error=1, error=2, warning=3, +info=4, and verbose=5. Levels 6..15 are reserved for future definition by +Microsoft. Levels and keywords are heavily used by the ETW runtime for event +filtering and routing. +*/ +#define TraceLoggingLevel(eventLevel) \ + _tlgArgLevel(eventLevel) + +/* +Macro TraceLoggingKeyword(eventKeyword): +Wrapper macro for setting the event's keyword(s). + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingKeyword(WINEVENT_KEYWORD_RESPONSE_TIME), + TraceLoggingWideString(myString)); + +The eventKeyword parameter must be a compile-time constant 0 to UINT64_MAX. If +no TraceLoggingKeyword(n) arg is provided, the event will use keyword 0 +(meaning "log-always"). If multiple TraceLoggingKeyword(n) args are provided, +the parameters are OR'ed together. + +ETW event keyword is stored in each event as a 64-bit value. Each bit in the +keyword value corresponds to an event category, with a "1" bit indicating that +the event is included in the category. The 16 most-significant bits of the +keyword (bits 48..63) correspond to Microsoft-defined categories. The 48 +least-significant bits of the keyword (bits 0..47) are user-defined categories, +i.e. the developer might decide that within a particular component, keyword +bit 0 (keyword value 0x1) indicates "networking", and keyword bit 3 (keyword +value 0x8) indicates "UI", so keyword value 0x9 would mean the event is in both +"networking" and "UI" categories. As a special exception, the keyword value 0 +means "log-always", i.e. that the event cannot be disabled by keyword. (Because +of this rule, it is best practice to always assign a non-zero keyword to every +event.) + +Levels and keywords are heavily used by the ETW runtime for event filtering and +routing. +*/ +#define TraceLoggingKeyword(eventKeyword) \ + _tlgArgKeyword(eventKeyword) + +/* +Macro TraceLoggingOpcode(eventOpcode): +Wrapper macro for setting the event's opcode. + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingOpcode(EVENT_TRACE_TYPE_STOP), + TraceLoggingWideString(myString)); + +The eventOpcode parameter must be a compile-time constant 0 to 255 (typically +a EVENT_TRACE_TYPE_??? constant from evntrace.h or a WINEVENT_OPCODE_??? +constant from winmeta.h). If no TraceLoggingOpcode(n) arg is provided, the +event will use opcode 0 (EVENT_TRACE_TYPE_INFO). If multiple +TraceLoggingOpcode(n) args are provided, the value from the last +TraceLoggingOpcode(n) will be used. + +ETW event opcode is stored in each event as an 8-bit value from 0 to 255 +indicating event semantics. Most events use opcode info=0, indicating an +informational event (no special semantics). The most commonly-used opcodes are +start=1 (indicating the start of an activity) and stop=2 (activity stop). The +opcode is not used by the ETW runtime (i.e. opcode does not usually affect +event filtering or routing), but the opcode is important during decoding +(i.e. in construction of activity sequences). +*/ +#define TraceLoggingOpcode(eventOpcode) \ + _tlgArgOpcode(eventOpcode) + +/* +Macro TraceLoggingChannel(eventChannel) +Wrapper macro for setting the event's channel. (Advanced scenarios.) + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingChannel(WINEVENT_CHANNEL_GLOBAL_APPLICATION), + TraceLoggingWideString(myString)); + +The eventChannel parameter must be a compile-time constant 0 to 255. If no +TraceLoggingChannel(n) arg is provided, the default channel is 11 +(WINEVENT_CHANNEL_TRACELOGGING), indicating that this is a normal +TraceLogging event. If multiple TraceLoggingChannel(n) args are provided, the +value from the last TraceLoggingChannel(n) is used. + +ETW event channel is stored in each event as an 8-bit value from 0 to 255 +indicating event semantics. Channel value 0 indicates a normal event. + +Channel values 1..15 are reserved by Microsoft and may trigger special +behavior in the ETW runtime or during event decoding. Channel versions 16 and +higher are defined by specific event consumers. + +The primary use of channels is with the Windows Event Log. When using channels +with the Event Log, a manifest must be registered with the system to define +the provider and its channels. A manifest for a TraceLogging provider should +define the provider and the channels but should omit the event definitions, +since they are managed by TraceLogging. + +NOTE: Do not use TraceLoggingChannel in code that needs to run on older +versions of Windows. The default channel 11 (WINEVENT_CHANNEL_TRACELOGGING) +marks the event as using TraceLogging-based decoding. On Windows 10, or on +Windows 7 with the necessary updates, the ETW runtime will mark the event as +TraceLogging regardless of channel, but on versions of Windows where the ETW +runtime has not been updated with TraceLogging support, the channel is the +only way for the decoder to know that the event was a TraceLogging event. As a +result, events that use a channel other than 11 and are captured on an older +version of Windows will not decode properly. +*/ +#define TraceLoggingChannel(eventChannel) \ + _tlgArgChannel(eventChannel) + +/* +Macro TraceLoggingEventTag(eventTag): +Wrapper macro for setting the event's tag(s). + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingEventTag(0x200000), + TraceLoggingWideString(myString)); + +Tags are a 28-bit user-defined metadata field. The semantics of the tags are +defined by the event consumer. During event processing, this tag can be +retrieved from the TRACE_EVENT_INFO Tags field. + +The eventTag parameter must be a compile-time constant, 0x0FFFFFFF or less. +(In C, the low 14 bits of eventTag must all be 0, as only the top 14 bits are +supported.) + +If no TraceLoggingEventTag(eventTag) arg is provided, the event's tag value +will be 0. If multiple TraceLoggingEventTag(eventTag) args are provided, the +tag values will be OR'ed together. + +Tag encoding is optimized in favor of the high bits, so you should generally +start assigning tag values at 0x08000000 (the highest supported tag bit), then +assign subsequent values to lower bits. + +C specific: + +The C implementation always uses a 2-byte encoding for tags, supporting up to +14 bits of tag data. The value parameter must be a compile-time constant +covered by mask 0x0FFFC000 (i.e. only tag bits 15-28 are supported). + +C++ specific: + +The C++ implementation uses a 1-byte, 2-byte, or 4-byte encoding for tags, +depending on tag's value. Tags that leave low bits unset can be encoded more +optimally. For example: + +- 0x00000000 uses a 1-byte encoding. +- 0x0FE00000 uses a 1-byte encoding. +- 0x0FFFC000 uses a 2-byte encoding. +- 0x0FFFFFFF uses a 4-byte encoding. + +Technical details: + +The TraceLogging schema convention encodes tags as 28-bit fields by using a +chain of up to four bytes with the upper-most bit used as a 'chain' bit +(4 bytes * 7 bits per byte = 28 bits supported). Data is encoded +most-significant byte first. The encoding always uses at least 1 byte. +*/ +#define TraceLoggingEventTag(eventTag) \ + _tlgArgTag(eventTag) + +/* +Macro TraceLoggingDescription(eventDescription): +Wrapper macro for setting a description for an event. + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingDescription("My event's detailed description"), + TraceLoggingWideString(myString)); + +The value parameter must be a string literal. If no +TraceLoggingDescription(description) parameter is provided, the default is +empty. If multiple TraceLoggingDescriptions(description) args are provided, +they are concatenated together into a single string. + +Descriptions are stored in the debug symbols (PDB file). They are not +available at runtime. +*/ +#define TraceLoggingDescription(eventDescription) \ + _tlgArgDesc(eventDescription) + +/* +Macro TraceLoggingCustomAttribute(key, value): +Wrapper macro for adding custom information about an event to the debug +symbols (PDB file). + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingCustomAttribute("Key", "Value"), + TraceLoggingWideString(myString)); + +Both parameters must be string literals. Multiple custom attributes can be +specified per event. + +Custom attributes are stored in the debug symbols (PDB file). They are not +available at runtime. +*/ +#define TraceLoggingCustomAttribute(key, value) \ + _tlgArgCustomAnnot(key, value) + +/* +Macro TraceLoggingStruct(fieldCount, "structName", "description", tags): +Wrapper macro for defining a group of related fields in an event. + +The description and tags parameters are optional. + +The fieldCount parameter must be a compile-time constant. It indicates the +number of fields that will be considered to be part of the struct. A struct and +all of its contained fields count as a single field in any parent structs. + +The name parameter must be a string literal (not a variable) and must not +contain any '\0' characters. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Example: + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingStruct(2, "Name"), + TraceLoggingWideString(szLast), + TraceLoggingWideString(szFirst)); +*/ +#define TraceLoggingStruct(fieldCount, name, ...) \ + _tlgArgStruct(fieldCount, name, _TlgInSTRUCT, __VA_ARGS__) + +#if defined(__cplusplus) +/* +Macro TraceLoggingValue(value, "name", "description", tags): +Wrapper macro for event fields. Automatically deduces value type. C++ only. + +The name, description, and tags parameters are optional. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the value +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingValue(val1) // field name = "val1", description = unset, tags = 0. +- TraceLoggingValue(val1, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingValue(val1, "name", "desc" // field name = "name", description = "desc", tags = 0. +- TraceLoggingValue(val1, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. + +Based on the type of val, TraceLoggingValue(val, ...) is equivalent to: +- bool --> TraceLoggingBoolean(val, ...) +- char --> TraceLoggingChar(val, ...) +- char16_t --> TraceLoggingChar16(val, ...) +- wchar_t --> TraceLoggingWChar(val, ...) // only for native wchar_t type, not for USHORT +- intNN_t --> TraceLoggingIntNN(val, ...) +- uintNN_t --> TraceLoggingUIntNN(val, ...) +- float --> TraceLoggingFloat32(val, ...) +- double --> TraceLoggingFloat64(val, ...) +- GUID --> TraceLoggingGuid(val, ...) +- FILETIME --> TraceLoggingFileTime(val, ...) +- SYSTEMTIME --> TraceLoggingSystemTime(val, ...) +- SID* --> TraceLoggingSid(val, ...) // Requires non-NULL, valid SID. +- void* --> TraceLoggingPointer(val, ...) // Logs the pointer's value, not the pointed-at data. +- char* --> TraceLoggingString(val, ...) // Assumes nul-terminated ANSI string. NULL is the same as "". +- char16_t* --> TraceLoggingString16(val, ...) // Assumes nul-terminated utf-16 string. NULL is the same as u"". +- wchar_t* --> TraceLoggingWideString(val, ...) // Assumes nul-terminated utf-16 string. NULL is the same as L"". +*/ +#define TraceLoggingValue(value, ...) \ + _tlgArgAuto(value, __VA_ARGS__) +#endif // __cplusplus + +/* +Wrapper macros for event fields with simple scalar values. +Usage: TraceLoggingInt32(value, "name", "description", tags). + +In C, a GUID, FILETIME, or SYSTEMTIME value parameter must be an lvalue. + +The name, description, and tags parameters are optional. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the value +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Notes: +- TraceLoggingBool is for 32-bit boolean values. +- TraceLoggingBoolean is for 8-bit boolean values. + +Examples: +- TraceLoggingInt32(val1) // field name = "val1", description = unset, tags = 0. +- TraceLoggingInt32(val1, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingInt32(val1, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingInt32(val1, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingInt8(value, ...) _tlgArgScalarVal(INT8, value, TlgInINT8, (), __VA_ARGS__) +#define TraceLoggingUInt8(value, ...) _tlgArgScalarVal(UINT8, value, TlgInUINT8, (), __VA_ARGS__) +#define TraceLoggingInt16(value, ...) _tlgArgScalarVal(INT16, value, TlgInINT16, (), __VA_ARGS__) +#define TraceLoggingUInt16(value, ...) _tlgArgScalarVal(UINT16, value, TlgInUINT16, (), __VA_ARGS__) +#define TraceLoggingInt32(value, ...) _tlgArgScalarVal(INT32, value, TlgInINT32, (), __VA_ARGS__) +#define TraceLoggingUInt32(value, ...) _tlgArgScalarVal(UINT32, value, TlgInUINT32, (), __VA_ARGS__) +#define TraceLoggingInt64(value, ...) _tlgArgScalarVal(INT64, value, TlgInINT64, (), __VA_ARGS__) +#define TraceLoggingUInt64(value, ...) _tlgArgScalarVal(UINT64, value, TlgInUINT64, (), __VA_ARGS__) +#define TraceLoggingIntPtr(value, ...) _tlgArgScalarVal(INT_PTR, value, TlgInINTPTR, (), __VA_ARGS__) +#define TraceLoggingUIntPtr(value, ...) _tlgArgScalarVal(UINT_PTR, value, TlgInUINTPTR, (), __VA_ARGS__) +#define TraceLoggingLong(value, ...) _tlgArgScalarVal(LONG, value, TlgInLONG, (), __VA_ARGS__) +#define TraceLoggingULong(value, ...) _tlgArgScalarVal(ULONG, value, TlgInULONG, (), __VA_ARGS__) +#define TraceLoggingHexInt8(value, ...) _tlgArgScalarVal(INT8, value, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt8(value, ...) _tlgArgScalarVal(UINT8, value, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt16(value, ...) _tlgArgScalarVal(INT16, value, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt16(value, ...) _tlgArgScalarVal(UINT16, value, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt32(value, ...) _tlgArgScalarVal(INT32, value, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexUInt32(value, ...) _tlgArgScalarVal(UINT32, value, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexInt64(value, ...) _tlgArgScalarVal(INT64, value, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexUInt64(value, ...) _tlgArgScalarVal(UINT64, value, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexIntPtr(value, ...) _tlgArgScalarVal(INT_PTR, value, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexUIntPtr(value, ...) _tlgArgScalarVal(UINT_PTR, value, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexLong(value, ...) _tlgArgScalarVal(LONG, value, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingHexULong(value, ...) _tlgArgScalarVal(ULONG, value, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingFloat32(value, ...) _tlgArgScalarVal(float, value, TlgInFLOAT, (), __VA_ARGS__) +#define TraceLoggingFloat64(value, ...) _tlgArgScalarVal(double, value, TlgInDOUBLE, (), __VA_ARGS__) +#define TraceLoggingBoolean(value, ...) _tlgArgScalarVal(BOOLEAN, value, TlgInUINT8, (TlgOutBOOLEAN), __VA_ARGS__) +#define TraceLoggingBool(value, ...) _tlgArgScalarVal(INT32, value, TlgInBOOL32, (), __VA_ARGS__) +#define TraceLoggingChar(value, ...) _tlgArgScalarVal(char, value, TlgInUINT8, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingChar16(value, ...) _tlgArgScalarVal(char16_t, value, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingWChar(value, ...) _tlgArgScalarVal(wchar_t, value, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingPointer(value, ...) _tlgArgScalarVal(void const*, value, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingCodePointer(value, ...) _tlgArgScalarVal(void const*, value, TlgInPOINTER, (TlgOutCODE_POINTER),__VA_ARGS__) +#define TraceLoggingPid(value, ...) _tlgArgScalarVal(UINT32, value, TlgInUINT32, (TlgOutPID), __VA_ARGS__) +#define TraceLoggingTid(value, ...) _tlgArgScalarVal(UINT32, value, TlgInUINT32, (TlgOutTID), __VA_ARGS__) +#define TraceLoggingPort(value, ...) _tlgArgScalarVal(UINT16, value, TlgInUINT16, (TlgOutPORT), __VA_ARGS__) +#define TraceLoggingWinError(value, ...) _tlgArgScalarVal(UINT32, value, TlgInUINT32, (TlgOutWIN32ERROR), __VA_ARGS__) +#define TraceLoggingNTStatus(value, ...) _tlgArgScalarVal(NTSTATUS, value, TlgInUINT32, (TlgOutNTSTATUS), __VA_ARGS__) +#define TraceLoggingHResult(value, ...) _tlgArgScalarVal(HRESULT, value, TlgInINT32, (TlgOutHRESULT), __VA_ARGS__) +#define TraceLoggingFileTime(value, ...) _tlgArgScalarRef(struct _FILETIME, value, TlgInFILETIME, (), __VA_ARGS__) +#define TraceLoggingFileTimeUtc(value, ...) _tlgArgScalarRef(struct _FILETIME, value, TlgInFILETIME, (TlgOutDATETIME_UTC),__VA_ARGS__) +#define TraceLoggingSystemTime(value, ...) _tlgArgScalarRef(struct _SYSTEMTIME,value, TlgInSYSTEMTIME,(), __VA_ARGS__) +#define TraceLoggingSystemTimeUtc(value, ...) _tlgArgScalarRef(struct _SYSTEMTIME,value, TlgInSYSTEMTIME,(TlgOutDATETIME_UTC),__VA_ARGS__) +#define TraceLoggingGuid(value, ...) _tlgArgScalarRef(GUID, value, TlgInGUID, (), __VA_ARGS__) + +/* +Wrapper macros for event fields with zero-terminated or counted string values. +Usage: TraceLoggingString(pszValue, "name", "description", tags) // NUL-terminated char*, uses decoding system's default ANSI code page. +Usage: TraceLoggingUtf8String(pszValue, "name", "description", tags) // NUL-terminated char*, uses UTF-8. +Usage: TraceLoggingString16(pszValue, "name", "description", tags) // NUL-terminated char16_t*, uses UTF-16LE. +Usage: TraceLoggingWideString(pszValue, "name", "description", tags) // NUL-terminated wchar_t*, uses UTF-16LE. +Usage: TraceLoggingCountedString(pchValue, cchValue, "name", "description", tags) // Counted char*, uses decoding system's default ANSI code page. +Usage: TraceLoggingCountedUtf8String(pchValue, cchValue, "name", "description", tags) // Counted char*, uses UTF-8. +Usage: TraceLoggingCountedString16(pchValue, cchValue, "name", "description", tags) // Counted char16_t*, uses UTF-16LE. +Usage: TraceLoggingCountedWideString(pchValue, cchValue, "name", "description", tags) // Counted wchar_t*, uses UTF-16LE. + +The name, description, and tags parameters are optional. + +For TraceLoggingString, TraceLoggingUtf8String, TraceLoggingString16, and +TraceLoggingWideString, the pszValue parameter is treated as a NUL-terminated +string. If pszValue is NULL, it is treated as an empty (zero-length) string. + +For TraceLoggingCountedString, TraceLoggingCountedUtf8String, +TraceLoggingCountedString16, and TraceLoggingCountedWideString, the pchValue +parameter is treated as a counted string, with length cchValue given in +characters. The pchValue parameter may be NULL only if cchValue is 0. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pszValue +or pchValue parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingString(psz1) // field name = "psz1", description = unset, tags = 0. +- TraceLoggingString(psz1, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingString(psz1, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingString(psz1, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingString(pszValue, ...) _tlgArgPsz( char, pszValue, TlgInANSISTRING, (), __VA_ARGS__) +#define TraceLoggingUtf8String(pszValue, ...) _tlgArgPsz( char, pszValue, TlgInANSISTRING, (TlgOutUTF8), __VA_ARGS__) +#define TraceLoggingString16(pszValue, ...) _tlgArgPsz( char16_t, pszValue, TlgInUNICODESTRING, (), __VA_ARGS__) +#define TraceLoggingWideString(pszValue, ...) _tlgArgPsz( wchar_t, pszValue, TlgInUNICODESTRING, (), __VA_ARGS__) +#define TraceLoggingCountedString(pchValue, cchValue, ...) _tlgArgCounted(char, pchValue, cchValue, TlgInCOUNTEDANSISTRING, (), __VA_ARGS__) +#define TraceLoggingCountedUtf8String(pchValue, cchValue, ...) _tlgArgCounted(char, pchValue, cchValue, TlgInCOUNTEDANSISTRING, (TlgOutUTF8), __VA_ARGS__) +#define TraceLoggingCountedString16(pchValue, cchValue, ...) _tlgArgCounted(char16_t, pchValue, cchValue, TlgInCOUNTEDSTRING, (), __VA_ARGS__) +#define TraceLoggingCountedWideString(pchValue, cchValue, ...) _tlgArgCounted(wchar_t, pchValue, cchValue, TlgInCOUNTEDSTRING, (), __VA_ARGS__) + +/* +Wrapper macros for event fields with PANSI_STRING, PUNICODE_STRING, etc. values. +Usage: TraceLoggingUnicodeString(pValue, "name", "description", tags). + +Use TraceLoggingUnicodeString for PUNICODE_STRING or PCUNICODE_STRING. +Use TraceLoggingAnsiString for PSTRING, PANSI_STRING, PCANSI_STRING, POEM_STRING, etc. + +The name, description, and tags parameters are optional. + +The pString parameter must not be NULL. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pString +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingUnicodeString(pStr) // field name = "pStr", description = unset, tags = 0. +- TraceLoggingUnicodeString(pStr, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingUnicodeString(pStr, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingUnicodeString(pStr, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingAnsiString(pValue, ...) _tlgArgBuffer(struct _STRING, pValue, TlgInCOUNTEDANSISTRING, (), __VA_ARGS__) +#define TraceLoggingUnicodeString(pValue, ...) _tlgArgBuffer(struct _UNICODE_STRING, pValue, TlgInCOUNTEDSTRING, (), __VA_ARGS__) + +/* +Wrapper macros for raw binary data. +Usage: TraceLoggingBinary(pValue, cbValue, "name", "description", tags). +Usage: TraceLoggingBinaryEx(pValue, cbValue, TlgOutTYPE, "name", "description", tags). + +Use TraceLoggingBinary for normal binary data. +Use TraceLoggingBinaryEx to specify a custom value for OutType. + +The pValue parameter is treated as a const void* so that any kind of data can +be provided. The cbValue parameter is the size of the data, in bytes. + +The name, description, and tags parameters are optional. + +The pValue parameter may be NULL only if cbValue is 0. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pValue +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available +at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingBinary(pObj, sizeof(*pObj)) // field name = "pObj", description = unset, tags = 0. +- TraceLoggingBinary(pObj, sizeof(*pObj), "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingBinary(pObj, sizeof(*pObj), "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingBinary(pObj, sizeof(*pObj), "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingBinary(pValue, cbValue, ...) _tlgArgBinary(void, pValue, cbValue, TlgInBINARY, (), __VA_ARGS__) +#define TraceLoggingBinaryEx(pValue, cbValue, outType, ...) _tlgArgBinary(void, pValue, cbValue, TlgInBINARY, (outType), __VA_ARGS__) + +/* +Wrapper macro for event fields with PSOCKADDR, PSOCKADDR_IN, etc. values. +Usage: TraceLoggingSocketAddress(pValue, cbValue, "name", "description", tags). + +Note that the amount of data needed for a SOCKADDR field varies depending on +the type of address. If the data is stored in a union variable, be sure to +set the cbValue parameter to the size of the correct union member or the +data might be truncated. + +The name, description, and tags parameters are optional. + +The pValue parameter may be NULL only if cbValue is 0. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pValue +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingSocketAddress(pSock, sizeof(*pSock)) // field name = "pSock", description = unset, tags = 0. +- TraceLoggingSocketAddress(pSock, sizeof(*pSock), "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingSocketAddress(pSock, sizeof(*pSock), "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingSocketAddress(pSock, sizeof(*pSock), "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingSocketAddress(pValue, cbValue, ...) _tlgArgBinary(void, pValue, cbValue, TlgInBINARY, (TlgOutSOCKETADDRESS), __VA_ARGS__) + +/* +Wrapper macro for event fields with IPv4 address values. +Usage: TraceLoggingIPv4Address(value, "name", "description", tags). + +The name, description, and tags parameters are optional. + +The value parameter must be a UINT32-encoded IPv4 address +(e.g. pSock->sin_addr.s_addr). + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the value +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingIPv4Address(sin_addr.s_addr) // field name = "sin_addr.s_addr", description = unset, tags = 0. +- TraceLoggingIPv4Address(sin_addr.s_addr, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingIPv4Address(sin_addr.s_addr, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingIPv4Address(sin_addr.s_addr, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingIPv4Address(value, ...) _tlgArgScalarVal(UINT32, value, TlgInUINT32, (TlgOutIPV4), __VA_ARGS__) + +/* +Wrapper macro for event fields with IPv6 address values. +Usage: TraceLoggingIPv6Address(pValue, "name", "description", tags). + +The name, description, and tags parameters are optional. + +The pValue parameter must not be NULL and must point at a 16-byte buffer +(e.g. &pSock->sin6_addr). + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pValue +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingIPv6Address(&pSock->sin6_addr) // field name = "&pSock->sin6_addr", description = unset, tags = 0. +- TraceLoggingIPv6Address(&pSock->sin6_addr, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingIPv6Address(&pSock->sin6_addr, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingIPv6Address(&pSock->sin6_addr, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingIPv6Address(pValue, ...) _tlgArgBinary(void, pValue, 16u, TlgInBINARY, (TlgOutIPV6), __VA_ARGS__) + +#ifdef SID_DEFINED +/* +Wrapper macros for event fields with PSID values. +Usage: TraceLoggingSid(pValue, "name", "description", tags). + +Note that the amount of data needed for a SID field varies depending on +the number of subauthorities. TraceLogging assumes the SID structure is valid +and will send the amount of data indicated by the subauthority count. + +The name, description, and tags parameters are optional. + +The pValue parameter must not be NULL and must point at a valid SID +(SubAuthorityCount must be initialized). + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pValue +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingSid(pSid) // field name = "pSid", description = unset, tags = 0. +- TraceLoggingSid(pSid, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingSid(pSid, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingSid(pSid, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingSid(pValue, ...) _tlgArgSid(SID, pValue, __VA_ARGS__) +#endif + +/* +Wrapper macros for event fields with values that are fixed-length arrays. +Usage: TraceLoggingInt32FixedArray(pValues, cValues, "name", "description", tags). + +The cValues parameter must be a compile-time constant value. It must not be 0. + +The name, description, and tags parameters are optional. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pbData +or pValues parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingUInt8FixedArray(pbX1, 32) // field name = "pbX1", description = unset, tags = 0. +- TraceLoggingUInt8FixedArray(pbX1, 32, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingUInt8FixedArray(pbX1, 32, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingUInt8FixedArray(pbX1, 32, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingInt8FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT8, pValues, cValues, TlgInINT8, (), __VA_ARGS__) +#define TraceLoggingUInt8FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT8, pValues, cValues, TlgInUINT8, (), __VA_ARGS__) +#define TraceLoggingInt16FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT16, pValues, cValues, TlgInINT16, (), __VA_ARGS__) +#define TraceLoggingUInt16FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT16, pValues, cValues, TlgInUINT16, (), __VA_ARGS__) +#define TraceLoggingInt32FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT32, pValues, cValues, TlgInINT32, (), __VA_ARGS__) +#define TraceLoggingUInt32FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT32, pValues, cValues, TlgInUINT32, (), __VA_ARGS__) +#define TraceLoggingInt64FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT64, pValues, cValues, TlgInINT64, (), __VA_ARGS__) +#define TraceLoggingUInt64FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT64, pValues, cValues, TlgInUINT64, (), __VA_ARGS__) +#define TraceLoggingIntPtrFixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT_PTR, pValues, cValues, TlgInINTPTR, (), __VA_ARGS__) +#define TraceLoggingUIntPtrFixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT_PTR, pValues, cValues, TlgInUINTPTR, (), __VA_ARGS__) +#define TraceLoggingLongFixedArray(pValues, cValues, ...) _tlgArgFixedArray(LONG, pValues, cValues, TlgInLONG, (), __VA_ARGS__) +#define TraceLoggingULongFixedArray(pValues, cValues, ...) _tlgArgFixedArray(ULONG, pValues, cValues, TlgInULONG, (), __VA_ARGS__) +#define TraceLoggingHexInt8FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT8, pValues, cValues, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt8FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT8, pValues, cValues, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt16FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT16, pValues, cValues, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt16FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT16, pValues, cValues, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt32FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT32, pValues, cValues, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexUInt32FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT32, pValues, cValues, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexInt64FixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT64, pValues, cValues, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexUInt64FixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT64, pValues, cValues, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexIntPtrFixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT_PTR, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexUIntPtrFixedArray(pValues, cValues, ...) _tlgArgFixedArray(UINT_PTR, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexLongFixedArray(pValues, cValues, ...) _tlgArgFixedArray(LONG, pValues, cValues, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingHexULongFixedArray(pValues, cValues, ...) _tlgArgFixedArray(ULONG, pValues, cValues, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingFloat32FixedArray(pValues, cValues, ...) _tlgArgFixedArray(float, pValues, cValues, TlgInFLOAT, (), __VA_ARGS__) +#define TraceLoggingFloat64FixedArray(pValues, cValues, ...) _tlgArgFixedArray(double, pValues, cValues, TlgInDOUBLE, (), __VA_ARGS__) +#define TraceLoggingBooleanFixedArray(pValues, cValues, ...) _tlgArgFixedArray(BOOLEAN, pValues, cValues, TlgInUINT8, (TlgOutBOOLEAN), __VA_ARGS__) +#define TraceLoggingBoolFixedArray(pValues, cValues, ...) _tlgArgFixedArray(INT32, pValues, cValues, TlgInBOOL32, (), __VA_ARGS__) +#define TraceLoggingCharFixedArray(pValues, cValues, ...) _tlgArgFixedArray(char, pValues, cValues, TlgInUINT8, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingChar16FixedArray(pValues, cValues, ...) _tlgArgFixedArray(char16_t, pValues, cValues, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingWCharFixedArray(pValues, cValues, ...) _tlgArgFixedArray(wchar_t, pValues, cValues, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingPointerFixedArray(pValues, cValues, ...) _tlgArgFixedArray(LPVOID, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingCodePointerFixedArray(pValues, cValues, ...) _tlgArgFixedArray(LPVOID, pValues, cValues, TlgInPOINTER, (TlgOutCODE_POINTER), __VA_ARGS__) +#define TraceLoggingFileTimeFixedArray(pValues, cValues, ...) _tlgArgFixedArray(struct _FILETIME, pValues, cValues, TlgInFILETIME, (), __VA_ARGS__) +#define TraceLoggingFileTimeUtcFixedArray(pValues, cValues, ...) _tlgArgFixedArray(struct _FILETIME, pValues, cValues, TlgInFILETIME, (TlgOutDATETIME_UTC), __VA_ARGS__) +#define TraceLoggingSystemTimeFixedArray(pValues, cValues, ...) _tlgArgFixedArray(struct _SYSTEMTIME, pValues, cValues, TlgInSYSTEMTIME, (), __VA_ARGS__) +#define TraceLoggingSystemTimeUtcFixedArray(pValues, cValues, ...) _tlgArgFixedArray(struct _SYSTEMTIME, pValues, cValues, TlgInSYSTEMTIME, (TlgOutDATETIME_UTC), __VA_ARGS__) +#define TraceLoggingGuidFixedArray(pValues, cValues, ...) _tlgArgFixedArray(GUID, pValues, cValues, TlgInGUID, (), __VA_ARGS__) + +/* +Wrapper macros for event fields with values that are variable-length arrays. +Usage: TraceLoggingInt32Array(pValues, cValues, "name", "description", tags). + +The name, description, and tags parameters are optional. + +The pointer parameter may be NULL only if the count parameter is 0. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pbData +or pValues parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Examples: +- TraceLoggingUInt8Array(pbX1, cbX1) // field name = "pbX1", description = unset, tags = 0. +- TraceLoggingUInt8Array(pbX1, cbX1, "name") // field name = "name", description = unset, tags = 0. +- TraceLoggingUInt8Array(pbX1, cbX1, "name", "desc") // field name = "name", description = "desc", tags = 0. +- TraceLoggingUInt8Array(pbX1, cbX1, "name", "desc", 0x4) // field name = "name", description = "desc", tags = 0x4. +*/ +#define TraceLoggingInt8Array(pValues, cValues, ...) _tlgArgArray(INT8, pValues, cValues, TlgInINT8, (), __VA_ARGS__) +#define TraceLoggingUInt8Array(pValues, cValues, ...) _tlgArgArray(UINT8, pValues, cValues, TlgInUINT8, (), __VA_ARGS__) +#define TraceLoggingInt16Array(pValues, cValues, ...) _tlgArgArray(INT16, pValues, cValues, TlgInINT16, (), __VA_ARGS__) +#define TraceLoggingUInt16Array(pValues, cValues, ...) _tlgArgArray(UINT16, pValues, cValues, TlgInUINT16, (), __VA_ARGS__) +#define TraceLoggingInt32Array(pValues, cValues, ...) _tlgArgArray(INT32, pValues, cValues, TlgInINT32, (), __VA_ARGS__) +#define TraceLoggingUInt32Array(pValues, cValues, ...) _tlgArgArray(UINT32, pValues, cValues, TlgInUINT32, (), __VA_ARGS__) +#define TraceLoggingInt64Array(pValues, cValues, ...) _tlgArgArray(INT64, pValues, cValues, TlgInINT64, (), __VA_ARGS__) +#define TraceLoggingUInt64Array(pValues, cValues, ...) _tlgArgArray(UINT64, pValues, cValues, TlgInUINT64, (), __VA_ARGS__) +#define TraceLoggingIntPtrArray(pValues, cValues, ...) _tlgArgArray(INT_PTR, pValues, cValues, TlgInINTPTR, (), __VA_ARGS__) +#define TraceLoggingUIntPtrArray(pValues, cValues, ...) _tlgArgArray(UINT_PTR, pValues, cValues, TlgInUINTPTR, (), __VA_ARGS__) +#define TraceLoggingLongArray(pValues, cValues, ...) _tlgArgArray(LONG, pValues, cValues, TlgInLONG, (), __VA_ARGS__) +#define TraceLoggingULongArray(pValues, cValues, ...) _tlgArgArray(ULONG, pValues, cValues, TlgInULONG, (), __VA_ARGS__) +#define TraceLoggingHexInt8Array(pValues, cValues, ...) _tlgArgArray(INT8, pValues, cValues, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt8Array(pValues, cValues, ...) _tlgArgArray(UINT8, pValues, cValues, TlgInUINT8, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt16Array(pValues, cValues, ...) _tlgArgArray(INT16, pValues, cValues, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexUInt16Array(pValues, cValues, ...) _tlgArgArray(UINT16, pValues, cValues, TlgInUINT16, (TlgOutHEX), __VA_ARGS__) +#define TraceLoggingHexInt32Array(pValues, cValues, ...) _tlgArgArray(INT32, pValues, cValues, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexUInt32Array(pValues, cValues, ...) _tlgArgArray(UINT32, pValues, cValues, TlgInHEXINT32, (), __VA_ARGS__) +#define TraceLoggingHexInt64Array(pValues, cValues, ...) _tlgArgArray(INT64, pValues, cValues, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexUInt64Array(pValues, cValues, ...) _tlgArgArray(UINT64, pValues, cValues, TlgInHEXINT64, (), __VA_ARGS__) +#define TraceLoggingHexIntPtrArray(pValues, cValues, ...) _tlgArgArray(INT_PTR, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexUIntPtrArray(pValues, cValues, ...) _tlgArgArray(UINT_PTR, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingHexLongArray(pValues, cValues, ...) _tlgArgArray(LONG, pValues, cValues, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingHexULongArray(pValues, cValues, ...) _tlgArgArray(ULONG, pValues, cValues, TlgInHEXLONG, (), __VA_ARGS__) +#define TraceLoggingFloat32Array(pValues, cValues, ...) _tlgArgArray(float, pValues, cValues, TlgInFLOAT, (), __VA_ARGS__) +#define TraceLoggingFloat64Array(pValues, cValues, ...) _tlgArgArray(double, pValues, cValues, TlgInDOUBLE, (), __VA_ARGS__) +#define TraceLoggingBooleanArray(pValues, cValues, ...) _tlgArgArray(BOOLEAN, pValues, cValues, TlgInUINT8, (TlgOutBOOLEAN), __VA_ARGS__) +#define TraceLoggingBoolArray(pValues, cValues, ...) _tlgArgArray(INT32, pValues, cValues, TlgInBOOL32, (), __VA_ARGS__) +#define TraceLoggingCharArray(pValues, cValues, ...) _tlgArgArray(char, pValues, cValues, TlgInUINT8, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingChar16Array(pValues, cValues, ...) _tlgArgArray(char16_t, pValues, cValues, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingWCharArray(pValues, cValues, ...) _tlgArgArray(wchar_t, pValues, cValues, TlgInUINT16, (TlgOutSTRING), __VA_ARGS__) +#define TraceLoggingPointerArray(pValues, cValues, ...) _tlgArgArray(LPVOID, pValues, cValues, TlgInPOINTER, (), __VA_ARGS__) +#define TraceLoggingCodePointerArray(pValues, cValues, ...) _tlgArgArray(LPVOID, pValues, cValues, TlgInPOINTER, (TlgOutCODE_POINTER), __VA_ARGS__) +#define TraceLoggingFileTimeArray(pValues, cValues, ...) _tlgArgArray(struct _FILETIME, pValues, cValues, TlgInFILETIME, (), __VA_ARGS__) +#define TraceLoggingFileTimeUtcArray(pValues, cValues, ...) _tlgArgArray(struct _FILETIME, pValues, cValues, TlgInFILETIME, (TlgOutDATETIME_UTC), __VA_ARGS__) +#define TraceLoggingSystemTimeArray(pValues, cValues, ...) _tlgArgArray(struct _SYSTEMTIME, pValues, cValues, TlgInSYSTEMTIME, (), __VA_ARGS__) +#define TraceLoggingSystemTimeUtcArray(pValues, cValues, ...) _tlgArgArray(struct _SYSTEMTIME, pValues, cValues, TlgInSYSTEMTIME, (TlgOutDATETIME_UTC), __VA_ARGS__) +#define TraceLoggingGuidArray(pValues, cValues, ...) _tlgArgArray(GUID, pValues, cValues, TlgInGUID, (), __VA_ARGS__) + +/* +Wrapper macros for manually-packed fields (advanced scenarios). +These macros support custom serialization of fields for use in creating events +that would otherwise be inexpressible through TraceLoggingProvider.h. For +example, these macros can be used to write fields containing arrays of strings +or arrays of structures. Note that the correct use of these macros requires an +understanding of how TraceLogging encodes events. If used incorrectly, these +macros can generate events that are impossible to decode. Note that to write +arrays of strings or arrays of structures, you will usually need to do +additional work such as manually buffering or marshaling the data before +invoking TraceLoggingWrite. + +TraceLoggingPackedField(pValue, cbValue, inType, "name", "description", tags) +TraceLoggingPackedFieldEx(pValue, cbValue, inType, outType, "name", "description", tags) +TraceLoggingPackedMetadata(inType, "name", "description", tags) +TraceLoggingPackedMetadataEx(inType, outType, "name", "description", tags) +TraceLoggingPackedStruct(fieldCount, "name", "description", tags) +TraceLoggingPackedStructArray(fieldCount, "name", "description", tags) +TraceLoggingPackedData(pValue, cbValue) +TraceLoggingPackedDataEx(pValue, cbValue, dataDescType) + +The name parameter must be a string literal (not a variable) and must not +contain any '\0' characters. For TraceLoggingPackedField and +TraceLoggingPackedFieldEx, the name parameter is optional. If the name is not +provided, the TraceLoggingPackedField and TraceLoggingPackedFieldEx macros will +use the pValue parameter to automatically generate a field name. + +The description parameter is optional. If provided, the description parameter +must be a string literal. The description will be included in the debug +symbols (PDB file). + +The tags parameter is optional. If provided, the tags parameter must be an +integer value. The low 28 bits of the value will be included in the field's +metadata. The semantics of the tags are defined by the event consumer. During +event processing, this tag can be retrieved from the EVENT_PROPERTY_INFO Tags +field. + +A TraceLogging event contains metadata and data. The metadata is the list of +fields, each with a name and a type. The data is the payload - an array of +raw bytes that contains the values of the event fields. The metadata is +composed of compile-time-constant data, while the data can be different each +time the event is generated. The metadata is used to decode the data, so the +metadata and the data need to be coordinated. The other wrapper macros +(TraceLoggingInt32, TraceLoggingString, etc.) automatically keep the metadata +and data coordinated, but the TraceLoggingPacked macros allow direct control +over the metadata and data so incorrect use of them can result in events that +do not decode correctly. + +The TraceLoggingPackedField macro adds both metadata and data. It adds an +arbitrary field to the event's type, and adds arbitrary data to the event's +payload. The TraceLoggingPackedFieldEx macro does the same, but includes a byte +for the field's OutType in the field descriptor. + +The TraceLoggingPackedMetadata macro adds only metadata. It adds a field to the +event's type without adding any data to the event's payload. The +TraceLoggingPackedMetadataEx macro does the same, but includes a byte for the +field's OutType in the field descriptor. + +The TraceLoggingPackedStruct macro adds only metadata (a struct declaration +never contains data -- the struct's data is provided by its fields). It begins +a structure in the event: the logical fields that follow the start +of the structure are considered to be part of the structure, and they will form +one logical field. (Structures can nest, and a nested structure counts as one +logical field in the parent structure.) The TraceLoggingPackedStructArray does +the same, but it begins an array of structures (which also counts as one +logical field). + +The TraceLoggingPackedData macro adds data directly into the event payload +without adding a field to the event's type. The TraceLoggingPackedDataEx macro +is the same, but it allows you to specify a non-default value to use in the +EVENT_DATA_DESCRIPTOR Type field (for custom communication with low-level ETW +processing). + +These macros can be combined in various ways to express TraceLogging field +structures not otherwise possible. Possible scenarios include: + +* Write a simple field with a specific InType/OutType combination that is + not supported by the core TraceLogging macros. + + For example, to write a nul-terminated wide string that is tagged as + containing JSON data: + + TraceLoggingWrite( + g_hProvider, + "MyEventWithJsonData", + TraceLoggingInt32(otherData1), + TraceLoggingPackedFieldEx( + szJson, + (wcslen(szJson) + 1) * sizeof(wchar_t), + TlgInUNICODESTRING, + TlgOutJSON, + "MyJsonFieldName"), + TraceLoggingInt32(otherData2)); + +* Write a complex field that requires marshaling data into a temporary + buffer. + + For example, to write an array of nul-terminated ANSI strings: + + // This scenario requires manually marshaling data. + // Don't spend time marshaling data if the event is disabled. + if (TraceLoggingProviderEnabled(g_hProvider, level, keyword)) + { + // This example assumes that the strings will fit into 100 bytes. + // Your production code will need to do additional error checking, or + // perhaps use std::vector and do a buf.push_back(val) instead of + // buf[iBuf++] = val. + BYTE buf[100]; + unsigned iBuf = 0; + + // Packed arrays start with a UINT16 value indicating the number of + // elements in the array. + buf[iBuf++] = (BYTE)cStrings; // Low byte of the element count + buf[iBuf++] = (BYTE)(cStrings >> 8); // High byte of the element count + + // Then we need to add the content of each array element. + for (UINT i = 0; i != cStrings; i++) + { + for (LPCSTR pString = pStrings[i]; *pString != 0; pString++) + { + buf[iBuf++] = *pString; + } + buf[iBuf++] = 0; // nul-terminate + } + + TraceLoggingWrite( + g_hProvider, + "MyEventWithArrayOfStrings", + TraceLoggingLevel(level), + TraceLoggingKeyword(keyword), + TraceLoggingInt32(otherData1), + TraceLoggingPackedField( + buf, + iBuf, + TlgInANSISTRING | TlgInVcount, // TlgInVcount means this is an array. + "MyArrayOfStringsFieldName"), + TraceLoggingInt32(otherData2)); + } + +* Write a structure directly as a single entity instead of as a series of + fields. + + This can be a minor performance optimization in some cases (it can reduce + per-event CPU and reduce stack usage), since it reduces the number of + EVENT_DATA_DESCRIPTOR that need to be created and initialized when generating + the event. Note that structures can only be written directly if the structure + contains no internal padding or non-blittable fields. If the structure + contains padding or non-blittable fields, you would need to buffer and repack + the data before using this technique, in which case it would have been more + efficient to use the normal methods for logging structures (i.e. using a + normal TraceLoggingStruct followed by the appropriate TraceLoggingValue for + each field). + + Overview: provide the data for the struct using TraceLoggingPackedData; + provide the number of fields and the name of the structure with + TraceLoggingPackedStruct; provide the names and types of the fields using + TraceLoggingPackedMetadata. + + Note that while the order of metadata is important and the ordering of data is + important, the ordering between metadata and data is not important. In the + example below, the TraceLoggingPackedData macro could appear anywhere between + otherData1 and otherData2 without changing the result. However, it could not + appear before otherData1 or after otherData2, since each of those also emit + data, and the data from TraceLoggingPackedData must appear after otherData1 + and before otherData2. + + TraceLoggingWrite( + g_hProvider, + "MyEventWithRect", + TraceLoggingInt32(otherData1), + TraceLoggingPackedData(&rect, sizeof(RECT)), // Data for all 4 fields + TraceLoggingPackedStruct(4, "RectangleFieldName"), // Structure with 4 fields + TraceLoggingPackedMetadata(TlgInINT32, "left"), + TraceLoggingPackedMetadata(TlgInINT32, "top"), + TraceLoggingPackedMetadata(TlgInINT32, "right"), + TraceLoggingPackedMetadata(TlgInINT32, "bottom"), + TraceLoggingInt32(otherData2)); + +* Write an array of structures. + + Overview: Provide the data for the array (the array count and the array + content) using TraceLoggingPackedData; provide the number of fields and the + name of the structure with TraceLoggingPackedStructArray; provide the names + and types of the fields using TraceLoggingPackedMetadata. + + In the example below, the array contains no padding and no non-blittable data + (i.e. variable-length data, out-of-line data like pointers to strings, etc.), + so we can provide a pointer directly to the array content. If the array + contained padding or contained non-blittable data, you would need to allocate + a buffer and re-pack the data, inlining any non-blittable elements and + omitting any padding. The example below needs to provide the array element + count (UINT16) as well as the array content, so it uses + TraceLoggingPackedData twice. + + TraceLoggingWrite( + g_hProvider, + "MyEventWithArrayOfRectangles", + TraceLoggingInt32(otherData1), + TraceLoggingPackedData(&cRectangles, sizeof(UINT16)), // Data for the array count + TraceLoggingPackedData(pRectangles, cRectangles * sizeof(RECT)), // Data for the array content + TraceLoggingPackedStructArray(4, "RectangleArrayFieldName"), // Structure with 4 fields + TraceLoggingPackedMetadata(TlgInINT32, "left"), + TraceLoggingPackedMetadata(TlgInINT32, "top"), + TraceLoggingPackedMetadata(TlgInINT32, "right"), + TraceLoggingPackedMetadata(TlgInINT32, "bottom"), + TraceLoggingInt32(otherData2)); + +Notes on serializing data: + +- When the decoder receives the event, it sees the event payload as a single + block of bytes. It does not see any boundaries between chunks of data in the + payload. If I use TraceLoggingPackedMetadata to add an Int32 field but + provide 5 bytes of data, the decoder will not be able to correctly decode the + remaining fields of the event. The developer must take care that the data + written matches up with the field definitions. On the other hand, this allows + flexibility in the way the data is encoded. For example, I might write the + data for several fields using a single TraceLoggingPackedData macro (more + efficient if the data is already contiguous in memory), or I might use + multiple TraceLoggingPackedData macros to gather bits of a single field's + value from multiple locations in memory (more efficient than recopying the + data to make it contiguous). +- Encoding/decoding behavior only uses the inType. The outType is only a + formatting hint and may be ignored by the decoder. +- TlgInUNICODESTRING means "nul-terminated UTF-16 wchar_t string". +- TlgInANSISTRING means "nul-terminated MBCS char string". +- TlgInCOUNTEDSTRING means "size-prefixed UTF-16 wchar_t string". +- TlgInCOUNTEDANSISTRING means "size-prefixed MBCS char string". +- TlgInBINARY and TlgInCOUNTEDBINARY mean "size-prefixed binary data". Both + types are encoded identically, but they go through different decoding paths. + TlgInBINARY cannot be used for arrays and results in an implicit Length + property. TlgInCOUNTEDBINARY can be used for arrays but is a newer InType + that may not be supported by all decoding tools. +- TlgInBINARY, TlgInCOUNTEDBINARY, TlgInCOUNTEDSTRING, and + TlgInCOUNTEDANSISTRING are encoded as a little-endian UINT16 byte-count (not + a char-count) followed by the data. +- Form an array by adding the TlgInVcount flag to the inType. For example, + an inType of TlgInANSISTRING will result in a field that stores a single + string, but an inType of TlgInANSISTRING|TlgInVcount will result in a field + that stores an array of strings. +- Arrays are serialized as a little-endian UINT16 element-count followed by the + elements. The elements in an array are serialized exactly as if they were not + in an array, even if the element has a variable length. For example, the + payload corrsponding to the 3-element array { "ABC", "DE", "F" } would be: + BYTE a[] = { '\3', '\0', 'A', 'B', 'C', '\0', 'D', 'E', '\0', 'F', '\0' }; +- Array of TlgInBINARY should not be used because TDH cannot decode it. + As an alternative, you can create an array of structures and put a field of + type TlgInBINARY inside it, or if your decoding tool supports the + TDH_INTYPE_MANIFEST_COUNTEDBINARY type, you can use TlgInCOUNTEDBINARY. +- All simple data types other than those used with TlgOutPORT and TlgOutIPV4 + are encoded as little-endian. +*/ +#define TraceLoggingPackedField(pValue, cbValue, inType, ...) _tlgArgPackedField(void, pValue, cbValue, inType, (), __VA_ARGS__) +#define TraceLoggingPackedFieldEx(pValue, cbValue, inType, outType, ...) _tlgArgPackedField(void, pValue, cbValue, inType, (outType), __VA_ARGS__) +#define TraceLoggingPackedMetadata(inType, name, ...) _tlgArgPackedMeta( name, inType, (), __VA_ARGS__) +#define TraceLoggingPackedMetadataEx(inType, outType, name, ...) _tlgArgPackedMeta( name, inType, (outType), __VA_ARGS__) +#define TraceLoggingPackedStruct(fieldCount, name, ...) _tlgArgStruct(fieldCount,name, _TlgInSTRUCT, __VA_ARGS__) +#define TraceLoggingPackedStructArray(fieldCount, name, ...) _tlgArgStruct(fieldCount,name, _TlgInSTRUCT|TlgInVcount, __VA_ARGS__) +#define TraceLoggingPackedData(pValue, cbValue) _tlgArgPackedData( void, pValue, cbValue, ()) +#define TraceLoggingPackedDataEx(pValue, cbValue, dataDescType) _tlgArgPackedData( void, pValue, cbValue, (dataDescType)) + +/* +Wrapper macros for binary data referenced by a structure (advanced scenarios). +Usage: TraceLoggingBinaryBuffer(pMyStruct, MyStructType, "name", "description", tags). +Usage: TraceLoggingBinaryBufferEx(pMyStruct, MyStructType, TlgOutTYPE, "name", "description", tags). + +These macros support serialization of structures that have fields "Buffer" and +"Length", where the Buffer field points to the data to be transmitted and the +Length field contains the number of bytes to be transmitted. + +Use TraceLoggingBinaryBuffer for normal binary data. +Use TraceLoggingBinaryBufferEx to specify a custom value for OutType. + +The name, description, and tags parameters are optional. + +The pMyStruct parameter must not be NULL. + +If provided, the name parameter must be a string literal (not a variable) and +must not contain any '\0' characters. If the name is not provided, the pValue +parameter is used to automatically generate a name. + +If provided, the description parameter must be a string literal, and will be +included in the debug symbols (PDB file). The description will not be +available at runtime. + +If provided, the tags parameter must be an integer value. The low 28 bits of +the value will be included in the field's metadata. The semantics of the tags +are defined by the event consumer. During event processing, this tag can be +retrieved from the EVENT_PROPERTY_INFO Tags field. + +Requirements: + +- The pMyStruct parameter must be a non-null pointer to dataType (or const + dataType). +- The dataType must have fields "Length" and "Buffer". + - The Length field must contain the size of the data (in bytes). + - The Buffer field must contain a pointer to the data. (Buffer may be null if + Length is 0.) +*/ +#define TraceLoggingBinaryBuffer(pValue, StructType, ...) _tlgArgBuffer(StructType, pValue, TlgInBINARY, (), __VA_ARGS__) +#define TraceLoggingBinaryBufferEx(pValue, StructType, outType, ...) _tlgArgBuffer(StructType, pValue, TlgInBINARY, (outType), __VA_ARGS__) + +/* +Macro TraceLoggingCustom(pValue, cbValue, protocol, bSchema, cbSchema, name, ...): +Wrapper macro for an event field packed using a custom serializer. + +The pValue/cbValue are the serialized data that has been generated at runtime +by a serializer from the specified protocol family. + +The protocol family may be specified as a value from 1 to 31 +with reserved values defined below (TRACELOGGING_PROTOCOL_*). + +The bSchema/cbSchema need to be compile-time literals (not variables). + +Example: + + BYTE rgValue[] = {...}; + + TraceLoggingWrite( + g_hProvider, + "MyEventName", + TraceLoggingCustom( + rgValue, + sizeof(rgValue), + TRACELOGGING_PROTOCOL_MYPROTOCOL, + ( 0x0, 0x1, 0x2 ), // schema bytes + 3, // number of schema bytes + "MyCustomField" + )); +*/ +#define TraceLoggingCustom(pValue, cbValue, protocol, bSchema, cbSchema, ...) \ + _tlgArgCustom(void, pValue, cbValue, protocol, bSchema, cbSchema, __VA_ARGS__) + +#define TRACELOGGING_PROTOCOL_MICROSOFT_RESERVED0 0 +#define TRACELOGGING_PROTOCOL_MICROSOFT_RESERVED1 1 +#define TRACELOGGING_PROTOCOL_MICROSOFT_RESERVED2 2 +#define TRACELOGGING_PROTOCOL_MICROSOFT_RESERVED3 3 +#define TRACELOGGING_PROTOCOL_MICROSOFT_RESERVED4 4 + +/* +By default, non-pageable TraceLogging inline functions go into the ".text" +segment. This can be overridden if necessary by setting the +TLG_NONPAGED_SEGMENT macro before including . +*/ +#ifndef TLG_NONPAGED_SEGMENT +#define TLG_NONPAGED_SEGMENT ".text" +#endif + +/* +By default, pageable TraceLogging inline functions go into the ".text" segment +(user-mode) or the "PAGE" segment (kernel-mode). This can be overridden if +necessary by setting the TLG_PAGED_SEGMENT macro before including +. +*/ +#ifndef TLG_PAGED_SEGMENT +#ifdef _ETW_KM_ +#define TLG_PAGED_SEGMENT "PAGE" +#else +#define TLG_PAGED_SEGMENT ".text" +#endif +#endif + +/* +By default, event metadata is stored in a blob in the ".rdata" segment. This +can be overridden if necessary by setting the TLG_METADATA_SEGMENT_BASE macro +before including . If overridden, this value must be +set consistently for all .obj files within the same module. + +Note that for kernel-mode code, the metadata usually needs to be in non-paged +memory. +*/ +#ifndef TLG_METADATA_SEGMENT_BASE +#define TLG_METADATA_SEGMENT_BASE .rdata +#endif + +#pragma endregion + +#pragma region Utility macros (for use only within TraceLoggingProvider.h) + +#if TLG_DEBUG + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_ASSERT(exp, str) ((void)(!(exp) ? (__annotation(L"Debug", L"AssertFail", L"TraceLogging: " _tlg_LSTRINGIZE(exp) L" : " str), TLG_RAISEASSERTIONFAILURE(), 0) : 0)) +#else // TLG_DEBUG + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_ASSERT(exp, str) ((void)0) +#endif // TLG_DEBUG + +#ifndef _tlg_FASTFAIL + #if defined(_M_CEE) + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_FASTFAIL(code) __debugbreak() + #else + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_FASTFAIL(code) __fastfail(code) + #endif +#endif // _tlg_FASTFAIL + +#ifndef _tlg_CASSERT + #if defined(__cplusplus) + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_CASSERT(exp, str) static_assert(exp, str) + #elif defined(__clang__) + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_CASSERT(exp, str) _Static_assert(exp, str) + #else + // Not for use outside of TraceLoggingProvider.h. + #define _tlg_CASSERT(exp, str) C_ASSERT(exp) + #endif +#endif // _tlg_CASSERT + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_FLATTEN(...) __VA_ARGS__ +#define _tlg_PARENTHESIZE(...) (__VA_ARGS__) + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_STRINGIZE(x) _tlg_STRINGIZE_imp(x) +#define _tlg_STRINGIZE_imp(x) #x + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_LSTRINGIZE(x) _tlg_LSTRINGIZE_imp(x) +#define _tlg_LSTRINGIZE_imp(x) _tlg_PASTE2(L, #x) + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_CAT(a, ...) _tlg_CAT_imp(a, __VA_ARGS__) +#define _tlg_CAT_imp(a, ...) a##__VA_ARGS__ + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_SPLIT(cond, ...) _tlg_SPLIT_imp(cond, (__VA_ARGS__)) +#define _tlg_SPLIT_imp(cond, args) _tlg_PASTE2(_tlg_SPLIT_imp, cond) args +#define _tlg_SPLIT_imp0(false_val, ...) false_val +#define _tlg_SPLIT_imp1(false_val, ...) __VA_ARGS__ + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_IS_PARENTHESIZED(...) \ + _tlg_SPLIT(0, _tlg_CAT(_tlg_IS_PARENTHESIZED_imp, _tlg_IS_PARENTHESIZED_imp0 __VA_ARGS__)) +#define _tlg_IS_PARENTHESIZED_imp0(...) 1 +#define _tlg_IS_PARENTHESIZED_imp1 1, +#define _tlg_IS_PARENTHESIZED_imp_tlg_IS_PARENTHESIZED_imp0 0, + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_IS_EMPTY(...) _tlg_SPLIT( \ + _tlg_IS_PARENTHESIZED(__VA_ARGS__), \ + _tlg_IS_PARENTHESIZED(_tlg_PARENTHESIZE __VA_ARGS__()), \ + 0) + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_NARGS(...) _tlg_NARGS_imp(_tlg_IS_EMPTY(__VA_ARGS__), (__VA_ARGS__)) +#define _tlg_NARGS_imp(is_empty, args) _tlg_PASTE2(_tlg_NARGS_imp, is_empty) args +#define _tlg_NARGS_imp0(...) _tlg_PASTE2(_tlg_NARGS_imp2(__VA_ARGS__, \ + 99,98,97,96,95,94,93,92,91,90, \ + 89,88,87,86,85,84,83,82,81,80, \ + 79,78,77,76,75,74,73,72,71,70, \ + 69,68,67,66,65,64,63,62,61,60, \ + 59,58,57,56,55,54,53,52,51,50, \ + 49,48,47,46,45,44,43,42,41,40, \ + 39,38,37,36,35,34,33,32,31,30, \ + 29,28,27,26,25,24,23,22,21,20, \ + 19,18,17,16,15,14,13,12,11,10, \ + 9, 8, 7, 6, 5, 4, 3, 2, 1,),) +#define _tlg_NARGS_imp1() 0 +#define _tlg_NARGS_imp2( \ + a1, a2, a3, a4, a5, a6, a7, a8, a9, \ + a10,a11,a12,a13,a14,a15,a16,a17,a18,a19, \ + a20,a21,a22,a23,a24,a25,a26,a27,a28,a29, \ + a30,a31,a32,a33,a34,a35,a36,a37,a38,a39, \ + a40,a41,a42,a43,a44,a45,a46,a47,a48,a49, \ + a50,a51,a52,a53,a54,a55,a56,a57,a58,a59, \ + a60,a61,a62,a63,a64,a65,a66,a67,a68,a69, \ + a70,a71,a72,a73,a74,a75,a76,a77,a78,a79, \ + a80,a81,a82,a83,a84,a85,a86,a87,a88,a89, \ + a90,a91,a92,a93,a94,a95,a96,a97,a98,a99, \ + size, ...) size + +// Not for use outside of TraceLoggingProvider.h. +#define _tlg_FOREACH(fn, ...) _tlg_FOR_imp(_tlg_NARGS(__VA_ARGS__), (fn, __VA_ARGS__)) +#define _tlg_FOR_imp(n, fnAndArgs) _tlg_PASTE2(_tlg_FOR_imp, n) fnAndArgs +#define _tlg_FOR_imp0( f,...) +#define _tlg_FOR_imp1( f,a0) f(0,a0) +#define _tlg_FOR_imp2( f,a0,a1) f(0,a0) f(1,a1) +#define _tlg_FOR_imp3( f,a0,a1,a2) f(0,a0) f(1,a1) f(2,a2) +#define _tlg_FOR_imp4( f,a0,a1,a2,a3) f(0,a0) f(1,a1) f(2,a2) f(3,a3) +#define _tlg_FOR_imp5( f,a0,a1,a2,a3,a4) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) +#define _tlg_FOR_imp6( f,a0,a1,a2,a3,a4,a5) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) +#define _tlg_FOR_imp7( f,a0,a1,a2,a3,a4,a5,a6) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) +#define _tlg_FOR_imp8( f,a0,a1,a2,a3,a4,a5,a6,a7) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) +#define _tlg_FOR_imp9( f,a0,a1,a2,a3,a4,a5,a6,a7,a8) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) +#define _tlg_FOR_imp10(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) +#define _tlg_FOR_imp11(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) +#define _tlg_FOR_imp12(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) +#define _tlg_FOR_imp13(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) +#define _tlg_FOR_imp14(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) +#define _tlg_FOR_imp15(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) +#define _tlg_FOR_imp16(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) +#define _tlg_FOR_imp17(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) +#define _tlg_FOR_imp18(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) +#define _tlg_FOR_imp19(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) +#define _tlg_FOR_imp20(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) +#define _tlg_FOR_imp21(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) +#define _tlg_FOR_imp22(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) +#define _tlg_FOR_imp23(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) +#define _tlg_FOR_imp24(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) +#define _tlg_FOR_imp25(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) +#define _tlg_FOR_imp26(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) +#define _tlg_FOR_imp27(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) +#define _tlg_FOR_imp28(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) +#define _tlg_FOR_imp29(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) +#define _tlg_FOR_imp30(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) +#define _tlg_FOR_imp31(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) +#define _tlg_FOR_imp32(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) +#define _tlg_FOR_imp33(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) +#define _tlg_FOR_imp34(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) +#define _tlg_FOR_imp35(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) +#define _tlg_FOR_imp36(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) +#define _tlg_FOR_imp37(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) +#define _tlg_FOR_imp38(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) +#define _tlg_FOR_imp39(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) +#define _tlg_FOR_imp40(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) +#define _tlg_FOR_imp41(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) +#define _tlg_FOR_imp42(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) +#define _tlg_FOR_imp43(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) +#define _tlg_FOR_imp44(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) +#define _tlg_FOR_imp45(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) +#define _tlg_FOR_imp46(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) +#define _tlg_FOR_imp47(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) +#define _tlg_FOR_imp48(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) +#define _tlg_FOR_imp49(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) +#define _tlg_FOR_imp50(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) +#define _tlg_FOR_imp51(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) +#define _tlg_FOR_imp52(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) +#define _tlg_FOR_imp53(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) +#define _tlg_FOR_imp54(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) +#define _tlg_FOR_imp55(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) +#define _tlg_FOR_imp56(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) +#define _tlg_FOR_imp57(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) +#define _tlg_FOR_imp58(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) +#define _tlg_FOR_imp59(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) +#define _tlg_FOR_imp60(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) +#define _tlg_FOR_imp61(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) +#define _tlg_FOR_imp62(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) +#define _tlg_FOR_imp63(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) +#define _tlg_FOR_imp64(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) +#define _tlg_FOR_imp65(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) +#define _tlg_FOR_imp66(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) +#define _tlg_FOR_imp67(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) +#define _tlg_FOR_imp68(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) +#define _tlg_FOR_imp69(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) +#define _tlg_FOR_imp70(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) +#define _tlg_FOR_imp71(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) +#define _tlg_FOR_imp72(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) +#define _tlg_FOR_imp73(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) +#define _tlg_FOR_imp74(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) +#define _tlg_FOR_imp75(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) +#define _tlg_FOR_imp76(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) +#define _tlg_FOR_imp77(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) +#define _tlg_FOR_imp78(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) +#define _tlg_FOR_imp79(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) +#define _tlg_FOR_imp80(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) +#define _tlg_FOR_imp81(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) +#define _tlg_FOR_imp82(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) +#define _tlg_FOR_imp83(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) +#define _tlg_FOR_imp84(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) +#define _tlg_FOR_imp85(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) +#define _tlg_FOR_imp86(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) +#define _tlg_FOR_imp87(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) +#define _tlg_FOR_imp88(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) +#define _tlg_FOR_imp89(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) +#define _tlg_FOR_imp90(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) +#define _tlg_FOR_imp91(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) +#define _tlg_FOR_imp92(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) +#define _tlg_FOR_imp93(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) +#define _tlg_FOR_imp94(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) +#define _tlg_FOR_imp95(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93,a94) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) f(94,a94) +#define _tlg_FOR_imp96(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93,a94,a95) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) f(94,a94) f(95,a95) +#define _tlg_FOR_imp97(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93,a94,a95,a96) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) f(94,a94) f(95,a95) f(96,a96) +#define _tlg_FOR_imp98(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93,a94,a95,a96,a97) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) f(94,a94) f(95,a95) f(96,a96) f(97,a97) +#define _tlg_FOR_imp99(f,a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31,a32,a33,a34,a35,a36,a37,a38,a39,a40,a41,a42,a43,a44,a45,a46,a47,a48,a49,a50,a51,a52,a53,a54,a55,a56,a57,a58,a59,a60,a61,a62,a63,a64,a65,a66,a67,a68,a69,a70,a71,a72,a73,a74,a75,a76,a77,a78,a79,a80,a81,a82,a83,a84,a85,a86,a87,a88,a89,a90,a91,a92,a93,a94,a95,a96,a97,a98) f(0,a0) f(1,a1) f(2,a2) f(3,a3) f(4,a4) f(5,a5) f(6,a6) f(7,a7) f(8,a8) f(9,a9) f(10,a10) f(11,a11) f(12,a12) f(13,a13) f(14,a14) f(15,a15) f(16,a16) f(17,a17) f(18,a18) f(19,a19) f(20,a20) f(21,a21) f(22,a22) f(23,a23) f(24,a24) f(25,a25) f(26,a26) f(27,a27) f(28,a28) f(29,a29) f(30,a30) f(31,a31) f(32,a32) f(33,a33) f(34,a34) f(35,a35) f(36,a36) f(37,a37) f(38,a38) f(39,a39) f(40,a40) f(41,a41) f(42,a42) f(43,a43) f(44,a44) f(45,a45) f(46,a46) f(47,a47) f(48,a48) f(49,a49) f(50,a50) f(51,a51) f(52,a52) f(53,a53) f(54,a54) f(55,a55) f(56,a56) f(57,a57) f(58,a58) f(59,a59) f(60,a60) f(61,a61) f(62,a62) f(63,a63) f(64,a64) f(65,a65) f(66,a66) f(67,a67) f(68,a68) f(69,a69) f(70,a70) f(71,a71) f(72,a72) f(73,a73) f(74,a74) f(75,a75) f(76,a76) f(77,a77) f(78,a78) f(79,a79) f(80,a80) f(81,a81) f(82,a82) f(83,a83) f(84,a84) f(85,a85) f(86,a86) f(87,a87) f(88,a88) f(89,a89) f(90,a90) f(91,a91) f(92,a92) f(93,a93) f(94,a94) f(95,a95) f(96,a96) f(97,a97) f(98,a98) + +#pragma endregion + +#pragma region Declarations + +/* +Core field types and flags. +*/ +enum TlgIn_t +{ + TlgInNULL, // Invalid type. + TlgInUNICODESTRING, + TlgInANSISTRING, + TlgInINT8, + TlgInUINT8, + TlgInINT16, + TlgInUINT16, + TlgInINT32, + TlgInUINT32, + TlgInINT64, + TlgInUINT64, + TlgInFLOAT, + TlgInDOUBLE, + TlgInBOOL32, + TlgInBINARY, + TlgInGUID, + _TlgInPOINTER_unsupported, + TlgInFILETIME, + TlgInSYSTEMTIME, + TlgInSID, + TlgInHEXINT32, + TlgInHEXINT64, + TlgInCOUNTEDSTRING, // TDH_INTYPE_MANIFEST_COUNTEDSTRING + TlgInCOUNTEDANSISTRING, // TDH_INTYPE_MANIFEST_COUNTEDANSISTRING + _TlgInSTRUCT, // TDH_INTYPE_RESERVED24 + TlgInCOUNTEDBINARY, // TDH_INTYPE_MANIFEST_COUNTEDBINARY + // New values go above this line, but _TlgInMax must not exceed 32. + _TlgInMax, + TlgInINTPTR = sizeof(void*) == 8 ? TlgInINT64 : TlgInINT32, + TlgInUINTPTR = sizeof(void*) == 8 ? TlgInUINT64 : TlgInUINT32, + TlgInPOINTER = sizeof(void*) == 8 ? TlgInHEXINT64 : TlgInHEXINT32, + TlgInLONG = sizeof(LONG) == 8 ? TlgInINT64 : TlgInINT32, + TlgInULONG = sizeof(ULONG) == 8 ? TlgInUINT64 : TlgInUINT32, + TlgInHEXLONG = sizeof(ULONG) == 8 ? TlgInHEXINT64 : TlgInHEXINT32, + _TlgInCcount = 32, // Indicates that field metadata contains a const-array-count tag. + TlgInVcount = 64, // Indicates that field data contains variable-array-count tag. + _TlgInChain = 128, // Indicates that field metadata contains a TlgOut tag. + _TlgInCustom = TlgInVcount | _TlgInCcount, // Indicates that the field uses a custom serializer. + _TlgInTypeMask = 31, + _TlgInCountMask = TlgInVcount | _TlgInCcount, + _TlgInFlagMask = _TlgInChain | TlgInVcount | _TlgInCcount +}; +_tlg_CASSERT(_TlgInMax <= _TlgInCcount, "Too many TlgIn_t values."); +#define _tlg_AssertValidPackedMetadataInType(inType) \ + _tlg_CASSERT( \ + ((inType)&_TlgInTypeMask) != _TlgInPOINTER_unsupported && \ + ((inType)&_TlgInTypeMask) != _TlgInSTRUCT && \ + ((inType)|_TlgInTypeMask|TlgInVcount) == (_TlgInTypeMask|TlgInVcount) && \ + (inType) != (TlgInBINARY|TlgInVcount), \ + "Invalid packed metadata in_type: " #inType) + +/* +Extended field formatting and flags. +*/ +enum TlgOut_t +{ + TlgOutNULL, + TlgOutNOPRINT, + TlgOutSTRING, + TlgOutBOOLEAN, // Used with InType = uint8 + TlgOutHEX, // Used with InType = uint8, uint16, uint32, uint64, binary + TlgOutPID, // Used with InType = uint32 + TlgOutTID, // Used with InType = uint32 + TlgOutPORT, // Used with InType = uint16, encoded as big-endian + TlgOutIPV4, // Used with InType = uint32 + TlgOutIPV6, // Used with InType = binary + TlgOutSOCKETADDRESS, // Used with InType = binary + TlgOutXML, // Used with InType = unicodestring, ansistring (counted and nul-terminated) + TlgOutJSON, // Used with InType = unicodestring, ansistring (counted and nul-terminated) + TlgOutWIN32ERROR, // Used with InType = uint32 + TlgOutNTSTATUS, // Used with InType = uint32 + TlgOutHRESULT, // Used with InType = int32 + TlgOutFILETIME, + TlgOutSIGNED, + TlgOutUNSIGNED, + // RS1+: Values 32 and higher are the same as the corresponding TDH_OUTTYPE values. + TlgOutUTF8 = 35, // Used with InType = ansistring (counted and nul-terminated) + TlgOutPKCS7_WITH_TYPE_INFO = 36, // Used with InType = binary + TlgOutCODE_POINTER = 37, // Used with InType = pointer + TlgOutDATETIME_UTC = 38, // Used with InType = FILETIME or SYSTEMTIME. + _TlgOutMax, + _TlgOutChain = 128, + _TlgOutTypeMask = _TlgOutChain - 1 +}; +_tlg_CASSERT(_TlgOutMax <= _TlgOutChain, "Too many TlgOut_t values."); + +/* +This comment defines the TraceLogging encoding format. +TraceLogging events are sent to ETW as described in this section. + +*** General concepts: + +- Each event has metadata and data. +- The metadata describes invariant characteristics of the event -- information + that is the same for each instance of the event. +- The data describes variable characteristics of the event -- information that + is different each time the event is written. +- The metadata includes provider characteristics, event characteristics, and + field characteristics. +- Each provider has a name and may optionally have other characteristics. +- Each event has a name and may optionally have fields and tags. +- Each field has a name, a type, and may optionally have tags. +- Field types can be considered as a combination of InType, OutType, and arity. + - InType defines how a field size is determined, and also defines a default + formatting behavior that will be used if no OutType is given. For example, + TlgInINT32 indicates that field size is 4 and that if no OutType is + given, the default formatting should be "signed decimal". + - If provided, OutType provides additional formatting information. For + example, TlgOutHEX would set formatting to "unsigned hexadecimal". + - If provided, arity indicates whether the field is a scalar (one value), + a fixed-length array (the same number of values for all events), or a + variable-length array (different events may have a different number of + values). +- TraceLogging supports grouping fields into structures. + - Structures can contain other structures (i.e. nesting is supported). + - Structures can contain arrays, and array-of-structure is supported. +- Events and fields can optionally set tags. Tags is a 28-bit metadata value + with user-defined semantics. For example, event tag 0x01000000 might be + defined as indicating a high-priority event, or field tag 0x02000000 might be + defined as indicating a field that contains potentially-private information. + +*** How to initialize a TraceLogging provider: + +- Call EventRegister. +- Call EventSetInformation to set your provider's characteristics and enable + the use of the Reserved field in EVENT_DATA_DESCRIPTOR. + +Example: + +EventRegister(&ProviderId, NULL, NULL, &RegHandle); +EventSetInformation(RegHandle, EventProviderSetTraits, &ProviderMetadata, ProviderMetadata.Size); + +*** How to send a TraceLogging event to ETW: + +- Determine N = the number of EVENT_DATA_DESCRIPTORs you need for your data. +- Allocate N + 2 EVENT_DATA_DESCRIPTORs. +- Use the first EVENT_DATA_DESCRIPTOR for provider metadata. +- Use the second EVENT_DATA_DESCRIPTOR for event metadata. +- Use the remaining EVENT_DATA_DESCRIPTORs for your data. + +Example: + +EVENT_DATA_DESCRIPTOR DataDescriptors[N + 2]; +DataDescriptors[0].Ptr = (ULONGLONG)(ULONG_PTR)&ProviderMetadata; // Defined below +DataDescriptors[0].Size = ProviderMetadata.Size; +DataDescriptors[0].Reserved = EVENT_DATA_DESCRIPTOR_TYPE_PROVIDER_METADATA; +DataDescriptors[1].Ptr = (ULONGLONG)(ULONG_PTR)&EventMetadata; // Defined below +DataDescriptors[1].Size = EventMetadata.Size; +DataDescriptors[1].Reserved = EVENT_DATA_DESCRIPTOR_TYPE_EVENT_METADATA; +// ... +// Use EventDataDescCreate(...) to populate the remaining N DataDescriptors +// with the data for your event, e.g. +// EventDataDescCreate(&DataDescriptors[2], &myData, sizeof(myData)); +// Note that the data layout in the remaining N DataDescriptors must match up +// with the fields defined in EventMetadata. +// ... +EventWrite(RegHandle, &EventDescriptor, N + 2, DataDescriptors); + +*** How to encode metadata: + +// ProviderMetadata: +// This pseudo-structure is the layout of the "provider traits" referenced by +// EventProviderSetTraits, EtwGetTraitFromProviderTraits, +// EVENT_HEADER_EXT_TYPE_PROV_TRAITS, and +// EVENT_DATA_DESCRIPTOR_TYPE_PROVIDER_METADATA. +// It provides the provider's name, plus other optional information such as group ID. +struct ProviderMetadata // Variable-length pseudo-structure, byte-aligned, tightly-packed. +{ + UINT16 Size; // = sizeof(ProviderMetadata) + char Name[]; // UTF-8 nul-terminated provider name + ProviderMetadataChunk AdditionalProviderInfo[]; // 0 or more chunks of data. +}; + +// ProviderMetadataChunk: +struct ProviderMetadataChunk // Variable-length pseudo-structure, byte-aligned, tightly-packed. +{ + UINT16 Size; // = sizeof(ProviderMetadataChunk) + UINT8 Type; // Value from the ETW_PROVIDER_TRAIT_TYPE enumeration. + AnyType Data; +}; + +// EventMetadata: +// This pseudo-structure is the layout of the "event metadata" referenced by +// EVENT_DATA_DESCRIPTOR_TYPE_EVENT_METADATA. +// It provides the event's name, event tags, and field information. +struct EventMetadata // Variable-length pseudo-structure, byte-aligned, tightly-packed. +{ + UINT16 Size; // = sizeof(EventMetadata) + UINT8 Extension[]; // 1 or more bytes. Read until you hit a byte with high bit unset. + char Name[]; // UTF-8 nul-terminated event name + FieldMetadata Fields[]; // 0 or more field definitions. +}; + +// FieldMetadata: +struct FieldMetadata // Variable-length pseudo-structure, byte-aligned, tightly-packed. +{ + char Name[]; // UTF-8 nul-terminated field name + UINT8 InType; // Values from the TlgIn enumeration. + UINT8 OutType; // TlgOut enumeration. Only present if (InType & 128) == 128. + UINT8 Extension[]; // Only present if OutType is present and (OutType & 128) == 128. Read until you hit a byte with high bit unset. + UINT16 ValueCount; // Only present if (InType & CountMask) == Ccount. + UINT16 TypeInfoSize; // Only present if (InType & CountMask) == Custom. + char TypeInfo[TypeInfoSize]; // Only present if (InType & CountMask) == Custom. +}; + +Each field has InType and OutType. The InType controls how the field's size is +determined and also implies a default formatting behavior that should be used +if OutType is 0 or not present. For example, TlgInINT32 indicates that the +field's size is 4 and that if no OutType is given (or if the decoder does not +understand the given OutType), the field formatting should be "signed decimal". + +Some InType values have special behaviors or limitations: + +- TlgInNULL: Invalid field type. +- TlgInBINARY: Array of BINARY should not be used. Array of BINARY is legal, + but TDH cannot decode a field with type array of BINARY. +- _TlgInPOINTER_unsupported: Do not use. This value is reserved because the + corresponding TDH value is TDH_INTYPE_POINTER. TraceLogging does not directly + support a POINTER type. Instead, TraceLogging defines TlgInPOINTER as + TlgInHEXINT32 for 32-bit binaries or TlgInHEXINT64 for 64-bit binaries. +- A struct has no data for itself, but it groups the following N logical fields + together into a single logical field. The value N is encoded in the OutType. + Arrays of struct are allowed, and structs can contain other structs (or + arrays of structs). + +The EventMetadata and FieldMetadata structures contain an Extension field. The +size of the Extension field is variable and unlimited. The decoder should +consume bytes until it has consumed a byte with the high bit set to 0. + +At present, only the first 4 bytes of Extension are defined (the remaining +bytes of the Extension field are reserved for future use and should be +ignored). The first 4 bytes (if present) each contribute 7 bits of "Tag" data +to the event or field, for up to 28 bits of "Tag" data. Tags are encoded +high-bits first. For example, if the first byte of Extension is 0x12, that +means the Extension field is 1 byte in length (high bit is unset), and value of +the Tag data is 0x02400000 (0x12 low 7 bits are 0010010, used as bits 21..27 of +the Tag data). + +*** Encoding data: + +Each scalar field's data is appended end-to-end with no alignment or padding. + +A fixed-length array is encoded by appending the data for N values end-to-end +with no alignment or padding, where N is the number of values as encoded in +the field's metadata. This rule applies even if the data is variable-length or +complex (e.g. it applies even if the field is a structure). Note that an array +length of 0 for a fixed-length array should not be used. + +A variable-length array is encoded as a UINT16 containing the number of values +followed by the data for those values, end-to-end. + +Most value types are fixed size (e.g. sizeof(INT32) == 4), but the following +value types are variable-size: + +- SID: size is 8 + 4*SubAuthorityCount. +- ANSISTRING: size is strlen(value) + 1. (Use strnlen for safe parsing.) +- UNICODESTRING: size is wcslen(value)*2 + 2. (Use wcsnlen for safe parsing.) +- BINARY, COUNTEDSTRING, COUNTEDANSISTRING: first two bytes are UINT16 + bytecount. +*/ + +/* +The following information is not part of the TraceLogging protocol - it +describes how the information needed by this header is stored in memory. +The following information is internal implementation information and may +change in future revisions of this header. +*/ + +/* +Type codes for metadata blobs in the binary. +*/ +enum _TlgBlob_t +{ + _TlgBlobNone, + _TlgBlobEnd, + _TlgBlobProvider, + _TlgBlobEvent3, + _TlgBlobProvider3, + _TlgBlobEvent2, + _TlgBlobEvent4, // Same as _TlgBlobEvent3 but event id is always 0. + _TlgBlobMax +}; + +enum _TlgFlags_t +{ + _TlgFlagsNone = 0, + _TlgFlagsPtr64 = 1 +}; + +enum _TlgOptions_t +{ + _TlgOptionNone = 0, + _TlgOptionGroup = 1 // = EtwProviderTraitTypeGroup +}; + +/* +A module's ETW metadata consists of a _TraceLoggingMetadata_t (8-byte aligned) +followed by metadata blobs (1-byte aligned). Extra zero-byte padding may be +present before or after blobs and must be ignored. (The extra padding is most +obvious in unoptimized builds.) +*/ +struct _TraceLoggingMetadata_t +{ + UINT32 Signature; // = _tlg_MetadataSignature = "ETW0" + UINT16 Size; // = sizeof(_TraceLoggingMetadata_t) + UINT8 Version; // = _tlg_MetadataVersion + UINT8 Flags; // = _tlg_MetadataFlags + UINT64 Magic; // = _tlg_MetadataMagic +}; + +#pragma pack(push,1) // Tight packing for metadata. + +/* +This is the data stored in the binary to describe a TraceLogging provider. +This structure may change in future revisions of this header. +The current design has the structure start with information needed by the +functions in this header (Type, ProviderId), and the structure ends with +information that will be passed on to ETW (provider traits). +Variable-length structure, byte-aligned, tightly-packed. +Actual size is: sizeof(Type) + _tlg_PROVIDER_METADATA_PREAMBLE + RemainingSize. +*/ +struct _tlgProviderMetadata_t +{ + UINT8 Type; // = _TlgBlobProvider3 + GUID ProviderId; +#define _tlg_PROVIDER_METADATA_PREAMBLE 16 // = sizeof(ProviderId) + UINT16 RemainingSize; // = sizeof(RemainingSize + ProviderName) + /* + char ProviderName[sizeof("providerName")]; // UTF-8 nul-terminated provider name + for each additional chunk of metadata { + UINT16 ChunkSize; + UINT8 ChunkType; + UINT8 ChunkData[ChunkSize - 3]; + } + */ +}; + +/* +This is the data stored in the binary to describe a TraceLogging event. +This structure may change in future revisions of this header. +The current design has the structure start with information needed by the +functions in this header (Type, Channel, etc.), and the structure ends with +information that will be passed on to ETW (event traits). +Variable-length structure, byte-aligned, tightly-packed. +Actual size is: sizeof(Type) + _tlg_EVENT_METADATA_PREAMBLE + RemainingSize +*/ +struct _tlgEventMetadata_t +{ + UINT8 Type; // = _TlgBlobEvent4 + UCHAR Channel; + UCHAR Level; + UCHAR Opcode; + ULONGLONG Keyword; +#define _tlg_EVENT_METADATA_PREAMBLE 11 // sizeof(Channel + Level + Opcode + Keyword) + UINT16 RemainingSize; // = sizeof(RemainingSize + Tags + EventName + Fields) + /* + UINT8 Tags[]; // 1 or more bytes. Read until you hit a byte with high bit unset. + char EventName[sizeof("eventName")]; // UTF-8 nul-terminated event name + for each field { + char FieldName[sizeof("fieldName")]; // UTF-8 nul-terminated field name + UINT8 InType; // TlgIn_t + UINT8 OutType; // TlgOut_t, only present if (InType & Chain) == Chain. + UINT8 Tags[]; // Only present if OutType is present and (OutType & Chain) == Chain. Read until you hit a byte with high bit unset. + UINT16 ValueCount; // Only present if (InType & CountMask) == Ccount. + UINT16 TypeInfoSize; // Only present if (InType & CountMask) == Custom. + char TypeInfo[TypeInfoSize]; // Only present if (InType & CountMask) == Custom. + } + */ +}; + +#pragma pack(8) // Default packing for other structures. + +/* +Data for TraceLoggingHProvider. +Note: The _tlgProvider_t type is an internal implementation detail. Do +not use the _tlgProvider_t type directly, as it may be changed or renamed in +future versions of this header. Use the TraceLoggingHProvider type and the +provided accessor functions instead of reading members directly. +*/ +struct _tlgProvider_t +{ + UINT32 LevelPlus1; + UINT16 const UNALIGNED* ProviderMetadataPtr; // Points to the RemainingSize member of provider metadata. + ULONGLONG KeywordAny; + ULONGLONG KeywordAll; + REGHANDLE RegHandle; + TLG_PENABLECALLBACK EnableCallback; + PVOID CallbackContext; +}; + +/* +Tag type. Has no effect on code. Can be used for detection of wrapper type for +a provider (such as TraceLoggingActivity). The tag indicates that the first +template parameter of the wrapper type is a reference to the provider handle +variable. + +Example: +template< + TraceLoggingHProvider const& provider, + typename TlgReflectorTag = _TlgReflectorTag_Param0IsHProvider> +class Activity +{ + ... +}; +*/ +struct _TlgReflectorTag_Param0IsHProvider; + +/* +Tag type. Has no effect on code. Can be used for detection of a wrapper type +for a provider (such as TraceLoggingActivity). The tag indicates that the first +template parameter of the wrapper type is a type T that wraps a provider, such +that T::Provider() returns an HProvider. + +Example: +template< + typename ProviderType, + typename TlgReflectorTag = _TlgReflectorTag_Param0IsProviderType> +class Activity +{ + static TraceLoggingHProvider Provider() + { + return ProviderType::Provider(); + } +}; +*/ +struct _TlgReflectorTag_Param0IsProviderType; + +#pragma pack(pop) + +#pragma endregion + +#pragma region Helper functions + +#define _tlg_MetadataSignature '0WTE' // "ETW0" +#define _tlg_MetadataVersion 0 +#define _tlg_MetadataFlags (sizeof(void*)==8?1:0) +#define _tlg_MetadataMagic 0xBB8A052B88040E86 + +#define _tlg_MetaDataDescCount 2 + +#define _tlgSegMetadataBegin _tlg_STRINGIZE(_tlg_PASTE2(TLG_METADATA_SEGMENT_BASE, $zETW0)) +#define _tlgSegMetadataEvents _tlg_STRINGIZE(_tlg_PASTE2(TLG_METADATA_SEGMENT_BASE, $zETW1)) +#define _tlgSegMetadataProviders _tlg_STRINGIZE(_tlg_PASTE2(TLG_METADATA_SEGMENT_BASE, $zETW2)) +#define _tlgSegMetadataEnd _tlg_STRINGIZE(_tlg_PASTE2(TLG_METADATA_SEGMENT_BASE, $zETW9)) + +#ifdef __cplusplus +#pragma detect_mismatch("TLG_METADATA_SEGMENT_BASE", _tlg_STRINGIZE(TLG_METADATA_SEGMENT_BASE)) +#endif // __cplusplus + +#pragma section(_tlgSegMetadataBegin, read) +#pragma section(_tlgSegMetadataEvents, read) +#pragma section(_tlgSegMetadataProviders, read) +#pragma section(_tlgSegMetadataEnd, read) + +#define _tlgGetLengthSid(pSid) (8u + (pSid)->SubAuthorityCount * 4u) + +// ********** NO FUNCTION DEFINITIONS ABOVE THIS POINT *********************** +#pragma code_seg(push) + +// ********** PAGED CODE ONLY ************************************************ +#pragma code_seg(TLG_PAGED_SEGMENT) + +_IRQL_requires_max_(PASSIVE_LEVEL) +_IRQL_requires_same_ +TLG_INLINE +void NTAPI +_tlgEnableCallback( + _In_ LPCGUID pSourceId, + _In_ ULONG callbackType, + _In_ UCHAR level, + _In_ ULONGLONG keywordAny, + _In_ ULONGLONG keywordAll, + _In_opt_ PEVENT_FILTER_DESCRIPTOR pFilterData, + _Inout_opt_ PVOID pCallbackContext) +{ + TLG_PAGED_CODE(); + if (pCallbackContext) + { + struct _tlgProvider_t* pProvider = (struct _tlgProvider_t*)pCallbackContext; + switch (callbackType) + { + case 0: // EVENT_CONTROL_CODE_DISABLE_PROVIDER + pProvider->LevelPlus1 = 0; + break; + case 1: // EVENT_CONTROL_CODE_ENABLE_PROVIDER + pProvider->LevelPlus1 = level != 0 ? (UINT32)level + 1u : 256u; + pProvider->KeywordAny = keywordAny; + pProvider->KeywordAll = keywordAll; + break; + } + + if (pProvider->EnableCallback) + { + pProvider->EnableCallback( + pSourceId, + callbackType, + level, + keywordAny, + keywordAll, + pFilterData, + pProvider->CallbackContext); + } + } +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +void _tlg_CALL +TraceLoggingUnregister(TraceLoggingHProvider _Inout_ hProvider) +{ + struct _tlgProvider_t* pProvider = (struct _tlgProvider_t*)hProvider; + REGHANDLE RegHandle; + TLG_PAGED_CODE(); + RegHandle = hProvider->RegHandle; + pProvider->LevelPlus1 = 0; + pProvider->RegHandle = 0; + TLG_EVENT_UNREGISTER(RegHandle); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingRegister( + TraceLoggingHProvider _Inout_ hProvider) +{ + TLG_PAGED_CODE(); + return TraceLoggingRegisterEx(hProvider, TLG_NULL, TLG_NULL); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingRegisterEx( + TraceLoggingHProvider _Inout_ hProvider, + _In_opt_ TLG_PENABLECALLBACK pEnableCallback, + _In_opt_ PVOID pCallbackContext) +{ + TLG_STATUS status; + struct _tlgProvider_t* pProvider = (struct _tlgProvider_t*)hProvider; + GUID const providerId = TraceLoggingProviderId(pProvider); + TLG_PAGED_CODE(); + + if (pProvider->RegHandle != 0) + { + // TraceLoggingRegister[Ex] was called with an hProvider that is + // currently registered. This leaks the provider registration and can + // cause memory corruption during provider callback. This is a serious + // bug in the code that called TraceLoggingRegister[Ex]. + _tlg_FASTFAIL(5); // 5 = FAST_FAIL_INVALID_ARG + } + + pProvider->EnableCallback = pEnableCallback; + pProvider->CallbackContext = pCallbackContext; + status = TLG_EVENT_REGISTER( + &providerId, + &_tlgEnableCallback, + pProvider, + &pProvider->RegHandle); + if (status != 0) + { +#ifndef _ETW_KM_ + status = HRESULT_FROM_WIN32(status); +#endif + } + else + { + UINT16 const cbMetadata = *pProvider->ProviderMetadataPtr; + (void)TraceLoggingSetInformation( + pProvider, + (EVENT_INFO_CLASS)2, // EventProviderSetTraits + (PVOID)pProvider->ProviderMetadataPtr, + cbMetadata); + } + return status; +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +TraceLoggingSetInformation( + TraceLoggingHProvider _Inout_ hProvider, + _In_ EVENT_INFO_CLASS informationClass, + _In_reads_bytes_opt_(cbInformation) PVOID pvInformation, + _In_ ULONG cbInformation) +{ + TLG_STATUS status; + +#if TLG_HAVE_EVENT_SET_INFORMATION == 1 + + TLG_PAGED_CODE(); +#pragma warning(suppress: 6387) // It's ok for pvInformation to be null if cbInformation is 0. + status = TLG_EVENT_SET_INFORMATION( + hProvider->RegHandle, + informationClass, + pvInformation, + cbInformation); +#ifndef _ETW_KM_ + status = HRESULT_FROM_WIN32(status); +#endif + +#elif TLG_HAVE_EVENT_SET_INFORMATION == 2 + +#ifdef _ETW_KM_ + typedef NTSTATUS(NTAPI* PFEtwSetInformation)( + _In_ REGHANDLE RegHandle, + _In_ EVENT_INFO_CLASS InformationClass, + _In_reads_bytes_opt_(InformationLength) PVOID EventInformation, + _In_ ULONG InformationLength); + static UNICODE_STRING strEtwSetInformation = { + sizeof(L"EtwSetInformation") - 2, + sizeof(L"EtwSetInformation") - 2, + (PWCH)L"EtwSetInformation" + }; + PFEtwSetInformation pfEtwSetInformation; + TLG_PAGED_CODE(); + status = STATUS_NOT_SUPPORTED; + pfEtwSetInformation = (PFEtwSetInformation)MmGetSystemRoutineAddress(&strEtwSetInformation); + if (pfEtwSetInformation) + { + status = pfEtwSetInformation( + hProvider->RegHandle, + informationClass, + pvInformation, + cbInformation); + } +#else // _ETW_KM_ + HMODULE hEventing; + status = ERROR_NOT_SUPPORTED; + if (GetModuleHandleExW(0, L"api-ms-win-eventing-provider-l1-1-0.dll", &hEventing) || + GetModuleHandleExW(0, L"advapi32.dll", &hEventing)) + { + typedef ULONG(WINAPI* PFEventSetInformation)( + _In_ REGHANDLE RegHandle, + _In_ EVENT_INFO_CLASS InformationClass, + _In_reads_bytes_opt_(InformationLength) PVOID EventInformation, + _In_ ULONG InformationLength); + PFEventSetInformation pfEventSetInformation = + (PFEventSetInformation)GetProcAddress(hEventing, "EventSetInformation"); + if (pfEventSetInformation) + { + status = pfEventSetInformation( + hProvider->RegHandle, + informationClass, + pvInformation, + cbInformation); + } + + FreeLibrary(hEventing); + } + status = HRESULT_FROM_WIN32(status); +#endif // _ETW_KM_ + +#else // TLG_HAVE_EVENT_SET_INFORMATION == 0 + + (void)hProvider; + (void)informationClass; + (void)pvInformation; + (void)cbInformation; + + #ifdef _ETW_KM_ + TLG_PAGED_CODE(); + status = STATUS_ENTRYPOINT_NOT_FOUND; + #else // _ETW_KM_ + status = HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED); + #endif // _ETW_KM_ + +#endif // TLG_HAVE_EVENT_SET_INFORMATION + + return status; +} + +// ********** NON-PAGED CODE ONLY ******************************************** +#pragma code_seg(TLG_NONPAGED_SEGMENT) + +extern struct _TraceLoggingMetadata_t const + __declspec(selectany allocate(_tlgSegMetadataBegin)) + _TraceLoggingMetadata = { + _tlg_MetadataSignature, + sizeof(_TraceLoggingMetadata), + _tlg_MetadataVersion, + _tlg_MetadataFlags, + _tlg_MetadataMagic +}; + +extern UINT8 const + __declspec(selectany allocate(_tlgSegMetadataEnd)) + _TraceLoggingMetadataEnd = _TlgBlobEnd; + +/* +Marking _tlgWriteCommon as __forceinline helps ensure minimal code size. +In most cases, there is no difference between __inline or __forceinline. +In a few cases __inline results in larger code. This is most common when both +_tlgWriteTransfer and _tlgWriteEx are used in the same module. + +Usually, _tlgWriteCommon gets inlined into _tlgWriteTransfer, and _tlgWrite +does not get inlined into call sites. This is generally the best result. + +Without __forceinline, _tlgWriteTransfer sometimes gets inlined into call +sites, and _tlgWriteCommon does not get inlined. The result is slightly larger +code at the call site with little or no benefit in performance. +*/ +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +void _tlg_CALL +_tlgWriteCommon( + _In_ TraceLoggingHProvider hProvider, + void const* pEventMetadata, // Buffer size determined from buffer content + _Out_writes_(2) ULONGLONG* pDesc, + _Out_writes_(2) EVENT_DATA_DESCRIPTOR* pData) +{ + _tlg_CASSERT(2 == _tlg_MetaDataDescCount, "Caller out of sync with _tlg_MetaDataDescCount."); + _tlg_CASSERT(_tlg_EVENT_METADATA_PREAMBLE == 1 + 2 + 4 + 4, "Caller out of sync with _tlg_EVENT_METADATA_PREAMBLE."); + UINT8 const* p = (UINT8 const*)pEventMetadata; + + ((UINT32*)pDesc)[0] = *p << 24; p += 1; // Id=0, Version=0, Channel=*p + ((UINT32*)pDesc)[1] = *(UINT16 UNALIGNED const*)p; p += 2; // Level, Opcode, Task + pDesc[1] = *(ULONGLONG UNALIGNED const*)p; p += 8; // Keyword + pData[0].Ptr = (ULONGLONG)(ULONG_PTR)hProvider->ProviderMetadataPtr; + pData[0].Size = *hProvider->ProviderMetadataPtr; + pData[0].Reserved = 2; // = EVENT_DATA_DESCRIPTOR_TYPE_PROVIDER_METADATA + pData[1].Ptr = (ULONGLONG)(ULONG_PTR)p; + pData[1].Size = *(UINT16 UNALIGNED const*)p; + pData[1].Reserved = 1; // = EVENT_DATA_DESCRIPTOR_TYPE_EVENT_METADATA + _tlg_ASSERT((void const*)&_TraceLoggingMetadata < (void const*)pEventMetadata, "Event metadata not in metadata segment."); + _tlg_ASSERT((void const*)&_TraceLoggingMetadataEnd > (void const*)pEventMetadata, "Event metadata not in metadata segment."); + + /* + Passing provider handles from one module to another is illegal. + Please fix your code to avoid doing this. + */ + _tlg_ASSERT( + (void const*)&_TraceLoggingMetadata < (void const*)hProvider->ProviderMetadataPtr, + "Provider handles must not be used outside of the module in which it was declared. Please don't share provider handles with other DLLs."); + _tlg_ASSERT( + (void const*)&_TraceLoggingMetadataEnd > (void const*)hProvider->ProviderMetadataPtr, + "Provider handles must not be used outside of the module in which it was declared. Please don't share provider handles with other DLLs."); + + /* + Force references to _TraceLoggingMetadata and _TraceLoggingMetadataEnd: + */ + { + int cbMetadata; + int volatile volatileVar; + cbMetadata = (int)((LPCCH)&_TraceLoggingMetadataEnd - (LPCCH)&_TraceLoggingMetadata); +#if defined(_M_ARM) || defined(_M_ARM64) || defined(_M_ARM64EC) + __iso_volatile_store32(&volatileVar, cbMetadata); +#else +#pragma warning(suppress: 28931) // Unused assignment + volatileVar = cbMetadata; + UNREFERENCED_PARAMETER(volatileVar); +#endif + } +} + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +_tlgWriteTransfer( + _In_ TraceLoggingHProvider hProvider, + void const* pEventMetadata, // Buffer size determined from buffer content + _In_opt_ LPCGUID pActivityId, + _In_opt_ LPCGUID pRelatedActivityId, + _In_range_(2, 128) UINT32 cData, + _Inout_cap_(cData) EVENT_DATA_DESCRIPTOR* pData) +{ + TLG_STATUS status; + ULONGLONG desc[2]; + _tlgWriteCommon(hProvider, pEventMetadata, desc, pData); + _tlg_ASSERT(cData <= 128, "Too many data values."); + status = TLG_EVENT_WRITE_TRANSFER(hProvider->RegHandle, (EVENT_DESCRIPTOR const*)desc, pActivityId, pRelatedActivityId, cData, pData); + return status; +} + +#if _tlg_ENABLE_TraceLoggingWriteEx + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +TLG_STATUS _tlg_CALL +_tlgWriteEx( + _In_ TraceLoggingHProvider hProvider, + void const* pEventMetadata, // Buffer size determined from buffer content + ULONG64 filter, + ULONG flags, + _In_opt_ LPCGUID pActivityId, + _In_opt_ LPCGUID pRelatedActivityId, + _In_range_(2, 128) UINT32 cData, + _Inout_cap_(cData) EVENT_DATA_DESCRIPTOR* pData) +{ + TLG_STATUS status; + ULONGLONG desc[2]; + _tlgWriteCommon(hProvider, pEventMetadata, desc, pData); + _tlg_ASSERT(cData <= 128, "Too many data values."); + status = TLG_EVENT_WRITE_EX(hProvider->RegHandle, (EVENT_DESCRIPTOR const*)desc, filter, flags, pActivityId, pRelatedActivityId, cData, pData); + return status; +} + +#endif // _tlg_ENABLE_TraceLoggingWriteEx + +/* +_tlgKeywordOn: Internal helper function. Do not call directly. This function +may change or be renamed in future versions of this header. +Use TraceLoggingProviderEnabled instead. +*/ +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +BOOLEAN _tlg_CALL +_tlgKeywordOn( + TraceLoggingHProvider _In_ hProvider, + ULONGLONG keyword) +{ + return keyword == 0 || ( + (keyword & hProvider->KeywordAny) && + (keyword & hProvider->KeywordAll) == hProvider->KeywordAll); +} + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +BOOLEAN _tlg_CALL +TraceLoggingProviderEnabled( + TraceLoggingHProvider _In_ hProvider, + UCHAR eventLevel, + ULONGLONG eventKeyword) +{ + return eventLevel < hProvider->LevelPlus1 && _tlgKeywordOn(hProvider, eventKeyword); +} + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +GUID _tlg_CALL +TraceLoggingProviderId( + TraceLoggingHProvider _In_ hProvider) +{ + GUID const UNALIGNED* pProviderId = + &CONTAINING_RECORD(hProvider->ProviderMetadataPtr, struct _tlgProviderMetadata_t, RemainingSize)->ProviderId; + return *pProviderId; +} + +#if !defined(__cplusplus) + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +void _tlg_CALL +_tlgCreate1Sz_char( + _Out_ PEVENT_DATA_DESCRIPTOR pDesc, + _In_opt_z_ char const* psz) +{ + char const* pch; + unsigned cb; + if (psz) + { + pch = psz; + cb = ((unsigned)strlen(pch) + 1) * sizeof(pch[0]); + } + else + { + pch = ""; + cb = sizeof(pch[0]); + } + EventDataDescCreate(pDesc, pch, cb); +} + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +void _tlg_CALL +_tlgCreate1Sz_wchar_t( + _Out_ PEVENT_DATA_DESCRIPTOR pDesc, + _In_opt_z_ wchar_t const* psz) +{ + wchar_t const* pch; + unsigned cb; + if (psz) + { + pch = psz; + cb = ((unsigned)wcslen(pch) + 1) * sizeof(pch[0]); + } + else + { + pch = L""; + cb = sizeof(pch[0]); + } + EventDataDescCreate(pDesc, pch, cb); +} + +/* +This is a macro instead of a function so that we don't have a dependency on +the char16_t type until the user actually uses a TraceLoggingChar16 or +TraceLoggingString16 macro, i.e. so that the user can include and use +TraceLoggingProvider.h without including uchar.h, and only needs to include +uchar.h if actually using char16_t. +Note: assumes that wchar_t and char16_t are the same type (i.e. both uint16). +*/ +#define _tlgCreate1Sz_char16_t(pDesc, psz) _tlgCreate1Sz_wchar_t(pDesc, psz) + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +void _tlg_CALL +_tlgCreate2Binary( + _Out_writes_(2) PEVENT_DATA_DESCRIPTOR pDesc, + _In_reads_bytes_(cbValue) void const* pValue, + _In_ ULONG cbValue) +{ + EventDataDescCreate(&pDesc[0], &pDesc[1].Size, 2); + EventDataDescCreate(&pDesc[1], pValue, cbValue); +} + +#else // !defined(__cplusplus) +} // extern "C" + +template struct _tlgCharTraits; +template<> struct _tlgCharTraits +{ + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_INLINE + _Check_return_ _Ret_z_ char const* _tlg_CALL + empty() + { return ""; } + + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_INLINE + _Check_return_ size_t _tlg_CALL + length(_In_z_ char const* psz) + { return strlen(psz); } +}; +template<> struct _tlgCharTraits +{ + static TLG_INLINE + _Check_return_ _Ret_z_ wchar_t const* _tlg_CALL + empty() + { return L""; } + + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_INLINE + _Check_return_ size_t _tlg_CALL + length(_In_z_ wchar_t const* psz) + { return wcslen(psz); } +}; +template<> struct _tlgCharTraits +{ + static_assert(sizeof(wchar_t) == sizeof(char16_t), "Unexpected sizeof(wchar_t)"); + + static TLG_INLINE + _Check_return_ _Ret_z_ char16_t const* _tlg_CALL + empty() + { return u""; } + + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_INLINE + _Check_return_ size_t _tlg_CALL + length(_In_z_ char16_t const* psz) + { return wcslen(reinterpret_cast(psz)); } +}; + +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +void _tlg_CALL +_tlgCreate1Sz( + _Out_ PEVENT_DATA_DESCRIPTOR pDesc, + _In_opt_z_ CH const* psz) +{ + typedef _tlgCharTraits _traits; + CH const* pch; + unsigned cb; + if (psz) + { + pch = psz; + cb = ((unsigned)_traits::length(pch) + 1) * sizeof(CH); + } + else + { + pch = _traits::empty(); + cb = sizeof(CH); + } +#pragma warning(suppress: 26018) // Analysis doesn't know that _traits::length(pch) returns strlen. + EventDataDescCreate(pDesc, pch, cb); +} + +/* +_tlgIndexSequence: stores the size of the EVENT_DATA_DESC array needed and the +indices at which each value will go. The Indices are mostly sequential, e.g. +(0, 1, 2, 3, Size=4), but some indices might be skipped since some values need +two descriptors, e.g. (0, 2, 4, 5, Size=7). +*/ +template +struct _tlgIndexSequence +{ + static unsigned const size = Size; +}; + +/* +_tlgExtendIndexSequence: recursively determines the _tlgIndexSequence +corresponding to a list of value types. +*/ +template +struct _tlgExtendIndexSequence; + +/* +_tlgExtendIndexSequence with no types: the sequence is complete. +*/ +template +struct _tlgExtendIndexSequence<_tlgIndexSequence> +{ + using type = _tlgIndexSequence; +}; + +/* +_tlgExtendIndexSequence with at least one type: +Extend the given base sequence with the DataDescCount from the next type. +Recurse to obtain the final sequence. +*/ +template +struct _tlgExtendIndexSequence<_tlgIndexSequence, NextType, RestTypes...> +{ +private: + + using NextSequence = _tlgIndexSequence; + +public: + + using type = typename _tlgExtendIndexSequence::type; +}; + +/* +_tlgDataDescInit is a helper type that fills in the EVENT_DATA_DESCRIPTOR +array. The helper is used to extract the Indices from _tlgIndexSequence. +This helper will be unnecessary once the compiler supports fold expressions. +*/ +template +struct _tlgDataDescInit; + +template +struct _tlgDataDescInit<_tlgIndexSequence> +{ + /* + Fills in the EVENT_DATA_DESCRIPTOR array using the data from the wrapped + arguments. + */ + template + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_PFORCEINLINE + void _tlg_CALL + Fill( + EVENT_DATA_DESCRIPTOR* pDescriptors, + WrappedTys const&... wrappedArgs) + { + /* + warning C4100 (unreferenced parameter pDescriptors) under VC2015 + */ + (void)pDescriptors; + + /* + Uses both the wrappedArgs and Indices parameter packs. For each pair of + entries (one arg from wrappedArgs, one index from Indices), calls + arg.Fill(&pDesc[index]). We do this as a function call because + parameter pack expansions are only allowed in certain places, and the + function call seems to be the syntax that the compiler is able to + optimize most effectively. + */ + EvaluateArgs(wrappedArgs.Fill(&pDescriptors[Indices])...); + } + +private: + + /* + Does nothing. Used to create the syntax in which a parameter pack + expansion may occur. + */ + template + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_PFORCEINLINE + void _tlg_CALL + EvaluateArgs(WrappedTys...) {} +}; + +/* +_tlgWriteTemplate: puts argument data into an EVENT_DATA_DESCRIPTOR array and +calls the event write API. This is used by _tlgWrite_imp. + +The struct is templated on the event write API and the extra parameters it +needs. The Write function accepts the standard arguments, any extra parameters +needed by the event write API, then wrapped values corresponding to the data +to be included in the event. For EventWriteTransfer with an INT32 value and a +char* value, you would use something like: + +_tlgWriteTemplate< + decltype(EventWriteTransfer), EventWriteTransfer, // The API to call. + LPCGUID, LPCGUID // The API's extra args. +>::Write( + hProvider, pEventMetadata, // Standard arguments. + pActivityId, pRelatedActivityId, // The API's extra args. + _tlgWrapScalar(value1), // The wrapped INT32 value. + _tlgWrapSz(value2)); // The wrapped char* value. +*/ +template +struct _tlgWriteTemplate +{ + template + _IRQL_requires_max_(HIGH_LEVEL) + static TLG_INLINE + TLG_STATUS _tlg_CALL + Write( + _In_ TraceLoggingHProvider hProvider, + void const* pEventMetadata, // Buffer size inexpressible + WriterArgTys... writerArgs, + WrappedTys const&... wrappedArgs) + { + using IndexSequence = typename _tlgExtendIndexSequence<_tlgIndexSequence<0>, WrappedTys...>::type; + unsigned const cData = IndexSequence::size + 2; + static_assert(cData <= 128, "Too many data values."); + EVENT_DATA_DESCRIPTOR data[cData]; + _tlgDataDescInit::Fill(data + 2, wrappedArgs...); + return writer(hProvider, pEventMetadata, writerArgs..., cData, data); + } +}; + +/* +_tlgStorageTypeForSize: Given a value size (1, 2, 4, 8), returns a suitable +type in which the value's bits can be stored (UINT8, UINT16, UINT32, UINT64). +*/ +template struct _tlgStorageTypeForSize; +template<> struct _tlgStorageTypeForSize<1> { typedef UINT8 type; }; +template<> struct _tlgStorageTypeForSize<2> { typedef UINT16 type; }; +template<> struct _tlgStorageTypeForSize<4> { typedef UINT32 type; }; +template<> struct _tlgStorageTypeForSize<8> { typedef UINT64 type; }; + +/* +_tlgWrapperByVal: Type-erased handler for fixed-size by-val scalar +(max 8 bytes). +Usage: _tlgWrapScalar(value) +*/ +template +struct _tlgWrapperByVal +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + typedef typename _tlgStorageTypeForSize::type StorageType; + + StorageType const Value; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + explicit _tlgWrapperByVal(_In_reads_bytes_(Size) void const* ptr) + : Value(*static_cast(ptr)) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(pDesc, &Value, Size); + return pDesc; + } +}; + +/* +_tlgWrapperByRef: Type-erased handler for fixed-size by-ref scalar (GUID, +SYSTEMTIME, FILETIME). +Usage: _tlgWrapScalar(value) +*/ +template +struct _tlgWrapperByRef +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + + void const* const Ptr; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + explicit _tlgWrapperByRef(_In_reads_bytes_(Size) void const* ptr) + : Ptr(ptr) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(pDesc, Ptr, Size); + return pDesc; + } +}; + +/* +_tlgWrapScalar: Type-checks the value, then wraps it (performing type erasure) +in either _tlgWrapperByVal or _tlgWrapperByRef (depending on type size). +Usage: _tlgWrapScalar(value) +*/ +template +struct _tlgWrapperTypeForScalar { typedef _tlgWrapperByVal type; }; +template +struct _tlgWrapperTypeForScalar { typedef _tlgWrapperByRef type; }; +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +typename _tlgWrapperTypeForScalar::type _tlg_CALL +_tlgWrapScalar(T const& value) +{ return typename _tlgWrapperTypeForScalar::type(&value); } + +/* +_tlgWrapSid: Typed handler for SID. +Usage: _tlgWrapSid(pValue) +*/ +template +struct _tlgWrapSid +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + + T const* const Sid; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + explicit _tlgWrapSid(T const* sid) + : Sid(sid) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(pDesc, Sid, _tlgGetLengthSid(Sid)); + return pDesc; + } +}; + +/* +_tlgWrapSz: Typed handler for char* string. +Usage: _tlgWrapSz(pszValue) +*/ +template struct _tlgWrapSz +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + _Field_z_ CH const* const Psz; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + explicit _tlgWrapSz(_In_z_ CH const* psz) + : Psz(psz) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + _tlgCreate1Sz(pDesc, Psz); + return pDesc; + } +}; + +/* +_tlgWrapperPtrSize: Type-erased handler for fixed array and +TraceLoggingPackedData. +Usage: _tlgWrapPtrSize(pValue, cbValue) +*/ +struct _tlgWrapperPtrSize +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + + void const* const Ptr; + ULONG const Size; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _tlgWrapperPtrSize(_In_reads_bytes_(size) void const* ptr, ULONG size) + : Ptr(ptr), Size(size) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(pDesc, Ptr, Size); + return pDesc; + } +}; +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +_tlgWrapperPtrSize _tlg_CALL +_tlgWrapPtrSize(_In_reads_bytes_(size) T const* ptr, ULONG size) +{ return _tlgWrapperPtrSize(ptr, size); } + +/* +_tlgWrapperPtrSizeType: Type-erased handler for TraceLoggingPackedDataEx. +Usage: _tlgWrapPtrSizeType(pValue, cbValue, reserved) +*/ +struct _tlgWrapperPtrSizeType +{ + static const unsigned DataDescCount = 1; // Consumes 1 EVENT_DATA_DESCRIPTOR. + + void const* const Ptr; + ULONG const Size; + ULONG const Reserved; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _tlgWrapperPtrSizeType(_In_reads_bytes_(size) void const* ptr, ULONG size, ULONG reserved) + : Ptr(ptr), Size(size), Reserved(reserved) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_ EVENT_DATA_DESCRIPTOR* pDesc) const + { + pDesc->Ptr = (UINT_PTR)Ptr; + pDesc->Size = Size; + pDesc->Reserved = Reserved; + return pDesc; + } +}; +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +_tlgWrapperPtrSizeType _tlg_CALL +_tlgWrapPtrSizeType(_In_reads_bytes_(size) T const* ptr, ULONG size, ULONG reserved) +{ return _tlgWrapperPtrSizeType(ptr, size, reserved); } + +/* +_tlgWrapperBinary: Type-erased handler for size-prefixed types (counted +binary, counted string). +Usage: _tlgWrapBinary(pValue, cbValue) +*/ +struct _tlgWrapperBinary +{ + static const unsigned DataDescCount = 2; // Consumes 2 EVENT_DATA_DESCRIPTORs. + + void const* const Ptr; + UINT16 const Size; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _tlgWrapperBinary(_In_reads_bytes_(size) void const* ptr, UINT16 size) + : Ptr(ptr), Size(size) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_writes_(2) EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(&pDesc[0], &pDesc[1].Size, 2); + EventDataDescCreate(&pDesc[1], Ptr, Size); + return pDesc; + } +}; +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +_tlgWrapperBinary _tlg_CALL +_tlgWrapBinary(_In_reads_bytes_(size) T const* ptr, ULONG size) +{ return _tlgWrapperBinary(ptr, static_cast(size)); } // Type checking before erasure. + +/* +_tlgWrapBuffer: Typed handler for Buffer types (e.g. ANSI_STRING, +UNICODE_STRING). +Usage: _tlgWrapBuffer(pValue) +*/ +template +struct _tlgWrapBuffer +{ + static const unsigned DataDescCount = 2; // Consumes 2 EVENT_DATA_DESCRIPTORs. + + T const* const Ptr; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + explicit _tlgWrapBuffer(_In_ T const* ptr) + : Ptr(ptr) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_writes_(2) EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(&pDesc[0], &pDesc[1].Size, 2); +#pragma warning(suppress: 26018) // Buffer length bounded by Ptr->Length. + EventDataDescCreate(&pDesc[1], Ptr->Buffer, static_cast(Ptr->Length)); + return pDesc; + } +}; + +/* +_tlgWrapperArray: Type-erased handler for count-prefixed types (arrays). +Usage: _tlgWrapArray(pValues, cValues) +*/ +template +struct _tlgWrapperArray +{ + static const unsigned DataDescCount = 2; // Consumes 2 EVENT_DATA_DESCRIPTORs. + + void const* const Ptr; + UINT16 const Length; + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _tlgWrapperArray(_In_reads_bytes_(Size * length) void const* ptr, UINT16 length) + : Ptr(ptr), Length(length) {} + + _IRQL_requires_max_(HIGH_LEVEL) + TLG_INLINE + _Ret_ void* + Fill(_Out_writes_(2) EVENT_DATA_DESCRIPTOR* pDesc) const + { + EventDataDescCreate(&pDesc[0], &Length, 2); + EventDataDescCreate(&pDesc[1], Ptr, Length * Size); + return pDesc; + } +}; +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_PFORCEINLINE +_tlgWrapperArray _tlg_CALL +_tlgWrapArray(T const* ptr, UINT16 count) +{ return _tlgWrapperArray(ptr, count); } + +template +struct _tlgCheckStructFieldCount +{ + static_assert(fieldCount < 128, "TraceLoggingStruct fieldCount must be less than 128."); + static unsigned const value = 0; +}; + +// remove reference from non-reference type (no-op). +template +struct _tlgRemoveReference +{ + typedef T type; +}; + +// remove reference from lvalue-reference type. +template +struct _tlgRemoveReference +{ + typedef T type; +}; + +// remove reference from rvalue-reference type. +template +struct _tlgRemoveReference +{ + typedef T type; +}; + +template struct _tlgDecay_cv { typedef T type; }; +template struct _tlgDecay_cv { typedef T type; }; +template struct _tlgDecay_cv { typedef T type; }; +template struct _tlgDecay_cv { typedef T type; }; + +// Given non-ref non-array type, remove const/volatile. +template +struct _tlgDecay_noref +{ + typedef typename _tlgDecay_cv::type type; +}; + +// Given array type, decay to pointer. +template +struct _tlgDecay_noref +{ + typedef T* type; +}; + +// Given array type, decay to pointer. +template +struct _tlgDecay_noref +{ + typedef T* type; +}; + +// Remove reference, remove const/volatile, arrays decay to pointers. +template +struct _tlgDecay +{ + typedef typename _tlgDecay_noref::type>::type type; +}; + +/* +Convert a type into an TlgIn_t value. +*/ +template struct _tlgTypeMapBase +{ + static_assert(sizeof(T) == 0, "The type is not supported by TraceLoggingValue."); +}; + +template struct _tlgTypeMap + : _tlgTypeMapBase::type> { }; + +// _tlgInTypeBaseDecl: outType is 0. +#define _tlgInTypeBaseDecl(simple, ctype, inType) \ + template<> struct _tlgTypeMapBase \ + { \ + typedef UINT8 _tlgTypeType0; /* No field tags: Don't need to store outtype. */ \ + typedef UINT16 _tlgTypeType1; /* Yes field tags: Need to store outtype = 0. */ \ + static bool const _tlgIsSimple = simple; \ + static _tlgTypeType0 const _tlgType0 = inType | 0x0000; \ + static _tlgTypeType1 const _tlgType1 = inType | 0x8080; \ + } + +// _tlgInTypeBaseDeclOut: outType is not 0. +#define _tlgInTypeBaseDeclOut(simple, ctype, inType, outType) \ + template<> struct _tlgTypeMapBase \ + { \ + typedef UINT16 _tlgTypeType0; /* Need to store intype+outtype. */ \ + typedef UINT16 _tlgTypeType1; /* Need to store intype+outtype. */ \ + static bool const _tlgIsSimple = simple; \ + static _tlgTypeType0 const _tlgType0 = inType | 0x0080 | (outType << 8); \ + static _tlgTypeType1 const _tlgType1 = inType | 0x8080 | (outType << 8); \ + } + +// _tlgWrapAuto normal case (where we want to write sizeof(T) bytes of data): + +template +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +typename _tlgWrapperTypeForScalar::type _tlg_CALL +_tlgWrapAuto(T const& value) +{ + static_assert(_tlgTypeMap::_tlgIsSimple, "Missing _tlgWrapAuto overload"); + return typename _tlgWrapperTypeForScalar::type(&value); +} + +#define _tlgInTypeBaseDecl0(ctype, inType ) _tlgInTypeBaseDecl( true, ctype, inType) +#define _tlgInTypeBaseDecl1(ctype, inType, outType) _tlgInTypeBaseDeclOut(true, ctype, inType, outType) +_tlgInTypeBaseDecl1(bool, TlgInUINT8, TlgOutBOOLEAN); +_tlgInTypeBaseDecl1(char, TlgInUINT8, TlgOutSTRING); +_tlgInTypeBaseDecl1(char16_t, TlgInUINT16, TlgOutSTRING); +_tlgInTypeBaseDecl1(__wchar_t, TlgInUINT16, TlgOutSTRING); +_tlgInTypeBaseDecl0(signed char, TlgInINT8); +_tlgInTypeBaseDecl0(unsigned char, TlgInUINT8); +_tlgInTypeBaseDecl0(signed short, TlgInINT16); +_tlgInTypeBaseDecl0(unsigned short, TlgInUINT16); +_tlgInTypeBaseDecl0(signed int, TlgInINT32); +_tlgInTypeBaseDecl0(unsigned int, TlgInUINT32); +_tlgInTypeBaseDecl0(signed long, sizeof(signed long) == 8 ? TlgInINT64 : TlgInINT32); +_tlgInTypeBaseDecl0(unsigned long, sizeof(unsigned long) == 8 ? TlgInUINT64 : TlgInUINT32); +_tlgInTypeBaseDecl0(signed long long, TlgInINT64); +_tlgInTypeBaseDecl0(unsigned long long, TlgInUINT64); +_tlgInTypeBaseDecl0(float, TlgInFLOAT); +_tlgInTypeBaseDecl0(double, TlgInDOUBLE); +_tlgInTypeBaseDecl0(GUID, TlgInGUID); +_tlgInTypeBaseDecl0(struct _FILETIME, TlgInFILETIME); +_tlgInTypeBaseDecl0(struct _SYSTEMTIME, TlgInSYSTEMTIME); +_tlgInTypeBaseDecl0(void*, TlgInPOINTER); +_tlgInTypeBaseDecl0(void const*, TlgInPOINTER); +#undef _tlgInTypeBaseDecl0 +#undef _tlgInTypeBaseDecl1 + +// _tlgWrapAuto special cases: + +#ifdef SID_DEFINED + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSid _tlg_CALL +_tlgWrapAuto(_In_ SID* pVal) +{ + return _tlgWrapSid(pVal); +} +_tlgInTypeBaseDecl(false, SID*, TlgInSID); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSid _tlg_CALL +_tlgWrapAuto(_In_ SID const* pVal) +{ + return _tlgWrapSid(pVal); +} +_tlgInTypeBaseDecl(false, SID const*, TlgInSID); + +#endif // SID_DEFINED + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ char* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, char*, TlgInANSISTRING); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ char const* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, char const*, TlgInANSISTRING); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ char16_t* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, char16_t*, TlgInUNICODESTRING); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ char16_t const* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, char16_t const*, TlgInUNICODESTRING); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ wchar_t* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, wchar_t*, TlgInUNICODESTRING); + +_IRQL_requires_max_(HIGH_LEVEL) +TLG_INLINE +_tlgWrapSz _tlg_CALL +_tlgWrapAuto(_In_z_ wchar_t const* psz) +{ + return _tlgWrapSz(psz); +} +_tlgInTypeBaseDecl(false, wchar_t const*, TlgInUNICODESTRING); + +#undef _tlgInTypeBaseDecl +#undef _tlgInTypeBaseDeclOut + +#endif // __cplusplus + +// ********** NO FUNCTION DEFINITIONS BELOW THIS POINT *********************** +#pragma code_seg(pop) + +#pragma endregion + +#pragma region Implementation macros + +#if defined(_MSC_VER) && !defined(__clang__) +#define _tlgPragmaUtf8Begin __pragma(execution_character_set(push, "UTF-8")) +#define _tlgPragmaUtf8End __pragma(execution_character_set(pop)) +#else +#define _tlgPragmaUtf8Begin +#define _tlgPragmaUtf8End +#endif + +#define _tlgValidateProviderId(...) \ + _tlgValidateProviderId_presentN(_tlg_NARGS(__VA_ARGS__), (__VA_ARGS__)) +#define _tlgValidateProviderId_presentN(n, args) \ + _tlgValidateProviderId_presentCALL(_tlg_PASTE2(_tlgValidateProviderId_present, n), args) +#define _tlgValidateProviderId_presentCALL(macro, args) \ + macro args +#define _tlgValidateProviderId_present0(...) /* parameter not provided - error case */ \ + _tracelogging_SyntaxError_ProviderIdMustBeSpecified _tracelogging_SyntaxError_ProviderIdMustBeSpecified; +#define _tlgValidateProviderId_present1(providerId) \ + _tlgValidateProviderId_parenthesisN(_tlg_IS_PARENTHESIZED(providerId), providerId) +#define _tlgValidateProviderId_parenthesisN(n, providerID) \ + _tlgValidateProviderId_parenthesisCALL(_tlg_PASTE2(_tlgValidateProviderId_parenthesis, n), providerID) +#define _tlgValidateProviderId_parenthesisCALL(macro, args) \ + macro args +#define _tlgValidateProviderId_parenthesis0 /* parameter not parenthesized - error case */ \ + _tracelogging_SyntaxError_ProviderIdMustBeInParenthesis _tracelogging_SyntaxError_ProviderIdMustBeInParenthesis; + +#ifdef __cplusplus +#define _tlgValidateProviderId_parenthesis1(...) \ + static_assert(11 == _tlg_NARGS(__VA_ARGS__), "TRACELOGGING_DEFINE_PROVIDER providerId must be eleven integers, e.g. (1,2,3,4,5,6,7,8,9,10,11)."); \ + static_assert(1 _tlg_FOREACH(_tlgParseProviderId_CheckInt, __VA_ARGS__), "TRACELOGGING_DEFINE_PROVIDER providerId must be eleven integers, e.g. (1,2,3,4,5,6,7,8,9,10,11)."); +#define _tlgParseProviderId_CheckInt(n, val) +(val) +#else +#define _tlgValidateProviderId_parenthesis1(...) +#endif + +#define _tlgExpandProviderId(a, b, c, d, e, f, g, h, i, j, k) \ + { a, b, c, { d, e, f, g, h, i, j , k } } + +#define _tlgProviderStorage_imp(storageVariable, providerName, providerId, annotationFunc, ...) \ + _tlgPragmaUtf8Begin \ + __pragma(pack(push, 1)) \ + _tlgValidateProviderId(providerId) \ + static struct { \ + struct _tlgProviderMetadata_t _tlgProv; \ + char _tlgName[sizeof(providerName)]; \ + _tlg_FOREACH(_tlgProvVar, __VA_ARGS__) \ + } const __declspec(allocate(_tlgSegMetadataProviders)) __declspec(align(1)) storageVariable##_Meta = { \ + { _TlgBlobProvider3, _tlgExpandProviderId providerId, sizeof(storageVariable##_Meta) - 1 - _tlg_PROVIDER_METADATA_PREAMBLE }, \ + (providerName) \ + _tlg_FOREACH(_tlgProvVal, __VA_ARGS__) \ + }; \ + __pragma(pack(pop)) \ + _tlgPragmaUtf8End \ + static struct _tlgProvider_t storageVariable = { \ + 0, &storageVariable##_Meta._tlgProv.RemainingSize, \ + 0, 0, 0, 0, 0 \ + _tlgAnnotationFunc_imp(annotationFunc, storageVariable) \ + } + +#define _tlgProvVar(n, args) _tlgApplyArgsN(_tlgProvVar, n, args) +#define _tlgProvVar_tlgOption(n, traitType, ctype, value) \ + UINT16 _tlgOptionSize##n; UINT8 _tlgTraitType##n; ctype _tlgOptionVal##n; + +#define _tlgProvVal(n, args) _tlgApplyArgs(_tlgProvVal, args) +#define _tlgProvVal_tlgOption(traitType, ctype, value) \ + , 3 + sizeof(ctype), traitType, _tlg_FLATTEN value + +#define _tlgAnnotationFunc_imp(use_annotationFunc, storageVariable) _tlg_PASTE2(_tlgAnnotationFunc_imp, use_annotationFunc) (storageVariable) +#define _tlgAnnotationFunc_imp0(storageVariable) + +/* +Note: Using pragma(comment /include AnnotationFunction) to ensure the +annotation is included into the PDB. Alternative would be taking the +function's address, but that interferes with control flow graph data. +*/ +#if defined(_M_HYBRID) || defined(_M_ARM64EC) +#define _tlgAnnotationFunc_imp1(storageVariable) __pragma(comment(linker, "/include:#" _tlg_STRINGIZE(_tlg_PASTE2(_tlgDefineProvider_annotation_, storageVariable)))) // +#elif defined(_M_IX86) || defined(_X86_) // x86 requires leading underscore +#define _tlgAnnotationFunc_imp1(storageVariable) __pragma(comment(linker, "/include:_" _tlg_STRINGIZE(_tlg_PASTE2(_tlgDefineProvider_annotation_, storageVariable)))) +#else +#define _tlgAnnotationFunc_imp1(storageVariable) __pragma(comment(linker, "/include:" _tlg_STRINGIZE(_tlg_PASTE2(_tlgDefineProvider_annotation_, storageVariable)))) +#endif + +/* +_tlgExpandType(typeParam) --> typeParam, hasType // typeParam should be a parenthesized value +_tlgExpandType(()) --> (0), 0 +_tlgExpandType((typeVal)) --> (typeVal), 1 +*/ +#define _tlgExpandType_imp0() (0), 0 +#define _tlgExpandType_imp1(typeVal) (typeVal), 1 +#define _tlgExpandType_impB(macro, args) macro args +#define _tlgExpandType_impA(n, typeParam) _tlgExpandType_impB(_tlg_PASTE2(_tlgExpandType_imp, n), typeParam) +#define _tlgExpandType(typeParam) _tlgExpandType_impA(_tlg_NARGS typeParam, typeParam) + +/* +_tlgNDT: Extracts Name/Description/Tags from varargs of wrapper macro with optional name. +_tlgNDT(value, __VA_ARGS__) --> "fieldName", L"description", tags, hasTags +*/ +#define _tlgNDT_imp0(value, ...) #value, , , 0 +#define _tlgNDT_imp1(value, name) name, , , 0 +#define _tlgNDT_imp2(value, name, desc) name, L"" desc, , 0 +#define _tlgNDT_imp3(value, name, desc, tags) name, L"" desc, tags, 1 +#define _tlgNDT_impB(macro, args) macro args +#define _tlgNDT_impA(n, args) _tlgNDT_impB(_tlg_PASTE2(_tlgNDT_imp, n), args) +#define _tlgNDT(value, ...) _tlgNDT_impA(_tlg_NARGS(__VA_ARGS__), (value, __VA_ARGS__)) + +/* +_tlgDT: Extracts Name/Description/Tags from varargs of wrapper macro with required name. +_tlgDT(name, __VA_ARGS__) --> "fieldName", L"description", tags, hasTags +*/ +#define _tlgDT_imp0(name, ...) name, , , 0 +#define _tlgDT_imp1(name, desc) name, L"" desc, , 0 +#define _tlgDT_imp2(name, desc, tags) name, L"" desc, tags, 1 +#define _tlgDT_impB(macro, args) macro args +#define _tlgDT_impA(n, args) _tlgDT_impB(_tlg_PASTE2(_tlgDT_imp, n), args) +#define _tlgDT(name, ...) _tlgDT_impA(_tlg_NARGS(__VA_ARGS__), (name, __VA_ARGS__)) + +/* +_tlgApplyArgs and _tlgApplyArgsN: Macro dispatchers. +_tlgApplyArgs( macro, (handler, ...)) --> macro##handler(...) +_tlgApplyArgsN(macro, n, (handler, ...)) --> macro##handler(n, ...) +*/ +#define _tlgApplyArgs_UNWRAP(...) __VA_ARGS__ +#define _tlgApplyArgs_CALL(macro, handler, args) macro##handler args +#define _tlgApplyArgs_impB(macro, handler, ...) _tlgApplyArgs_CALL(macro, handler, (__VA_ARGS__)) +#define _tlgApplyArgs_impA(args) _tlgApplyArgs_impB args +#define _tlgApplyArgs(macro, args) _tlgApplyArgs_impA((macro, _tlgApplyArgs_UNWRAP args)) +#define _tlgApplyArgsN_impB(macro, n, handler, ...) _tlgApplyArgs_CALL(macro, handler, (n, __VA_ARGS__)) +#define _tlgApplyArgsN_impA(args) _tlgApplyArgsN_impB args +#define _tlgApplyArgsN(macro, n, args) _tlgApplyArgsN_impA((macro, n, _tlgApplyArgs_UNWRAP args)) + +/* +Dispatch macros: generate a part of the TraceLoggingWrite macro. +*/ + +#define _tlgInfoVars(n, args) _tlgApplyArgsN(_tlgInfoVars, n, args) +#define _tlgInfoVars_tlgAuto( n, value, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; typename _tlgTypeMap::_tlgTypeType##hasTags _tlgTy##n; _tlgInfoVars_##hasTags(n) +#define _tlgInfoVars_tlgScalarVal( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgScalarRef( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgSid( n, ctype, pValue, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_0 ##hasTags(n) +#define _tlgInfoVars_tlgPsz( n, ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgBuffer( n, ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgBinary( n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgCounted( n, ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) +#define _tlgInfoVars_tlgFixedArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) UINT16 _tlgValCount##n; +#define _tlgInfoVars_tlgPackedField(n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) _tlg_AssertValidPackedMetadataInTypeCppOnly(inType) +#define _tlgInfoVars_tlgPackedMeta( n, inType, outType, hasOut, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_##hasOut##hasTags(n) _tlg_AssertValidPackedMetadataInTypeCppOnly(inType) +#define _tlgInfoVars_tlgPackedData( n, ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgInfoVars_tlgCustom( n, ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_0 ##hasTags(n) UINT16 _tlgCustLen##n; UINT8 _tlgCustDat##n[cbSchema]; +#define _tlgInfoVars_tlgStruct( n, fieldCount,inType, name, desc, tags, hasTags) char _tlgName##n[sizeof(name)]; UINT8 _tlgIn##n; _tlgInfoVars_1 ##hasTags(n) +#define _tlgInfoVars_tlgChannel( n, eventChannel ) +#define _tlgInfoVars_tlgLevel( n, eventLevel ) +#define _tlgInfoVars_tlgOpcode( n, eventOpcode ) +#define _tlgInfoVars_tlgKeyword( n, eventKeyword ) +#define _tlgInfoVars_tlgTag( n, eventTag ) +#define _tlgInfoVars_tlgDesc( n, eventDescription ) +#define _tlgInfoVars_tlgCustomAnnot(n, key, value ) +#define _tlgInfoVars_0(n) +#define _tlgInfoVars_1(n) UINT32 _tlgTags##n; +#define _tlgInfoVars_00(n) +#define _tlgInfoVars_10(n) UINT8 _tlgOut##n; +#define _tlgInfoVars_01(n) UINT8 _tlgOut##n;UINT32 _tlgTags##n; +#define _tlgInfoVars_11(n) UINT8 _tlgOut##n;UINT32 _tlgTags##n; + +#define _tlgInfoVals(n, args) _tlgApplyArgsN(_tlgInfoVals, n, args) +#define _tlgInfoVals_tlgAuto( n, value, name, desc, tags, hasTags) , (name), _tlgTypeMap::_tlgType##hasTags _tlgInfoVals_##hasTags(tags) +#define _tlgInfoVals_tlgScalarVal( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgScalarRef( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgSid( n, ctype, pValue, name, desc, tags, hasTags) , (name), TlgInSID _tlgInfoVals_0 ##hasTags(outType, tags) +#define _tlgInfoVals_tlgPsz( n, ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgBuffer( n, ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType|64 _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgBinary( n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgCounted( n, ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_##hasOut##hasTags(outType, tags) +#define _tlgInfoVals_tlgFixedArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) , (name), inType|32 _tlgInfoVals_##hasOut##hasTags(outType, tags), (cValues) +#define _tlgInfoVals_tlgPackedField(n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) , (name), (inType) _tlgInfoVals_##hasOut##hasTags((outType&_TlgOutTypeMask), tags) +#define _tlgInfoVals_tlgPackedMeta( n, inType, outType, hasOut, name, desc, tags, hasTags) , (name), (inType) _tlgInfoVals_##hasOut##hasTags((outType&_TlgOutTypeMask), tags) +#define _tlgInfoVals_tlgPackedData( n, ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgInfoVals_tlgCustom( n, ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) , (name), ((protocol)&31)|96 _tlgInfoVals_0##hasTags(0, tags), cbSchema, {_tlg_FLATTEN bSchema} +#define _tlgInfoVals_tlgStruct( n, fieldCount,inType, name, desc, tags, hasTags) , (name), inType _tlgInfoVals_1 ##hasTags(fieldCount, tags) +#define _tlgInfoVals_tlgChannel( n, eventChannel ) +#define _tlgInfoVals_tlgLevel( n, eventLevel ) +#define _tlgInfoVals_tlgOpcode( n, eventOpcode ) +#define _tlgInfoVals_tlgKeyword( n, eventKeyword ) +#define _tlgInfoVals_tlgTag( n, eventTag ) +#define _tlgInfoVals_tlgDesc( n, eventDescription ) +#define _tlgInfoVals_tlgCustomAnnot(n, key, value ) +#define _tlgInfoVals_0(...) +#define _tlgInfoVals_1(tags) ,_tlgInfoVals_Tags(tags) +#define _tlgInfoVals_00(outType, tags) +#define _tlgInfoVals_10(outType, tags) |128,outType +#define _tlgInfoVals_01(outType, tags) |128,128,_tlgInfoVals_Tags(tags) +#define _tlgInfoVals_11(outType, tags) |128,outType|128,_tlgInfoVals_Tags(tags) +#define _tlgInfoVals_Tags(tags) 0x808080|(((tags)&0x7f)<<24)|(((tags)&0x3f80)<<9)|(((tags)&0x1fc000)>>6)|(((tags)&0xfe00000)>>21) + +#ifdef __cplusplus + +#define _tlgWrap(n, args) _tlgApplyArgs(_tlgWrap, args) +#define _tlgWrap_tlgAuto( value, name, desc, tags, hasTags) , _tlgWrapAuto(value) +#define _tlgWrap_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapScalar(value) +#define _tlgWrap_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapScalar(value) +#define _tlgWrap_tlgSid( ctype, pValue, name, desc, tags, hasTags) , _tlgWrapSid(pValue) +#define _tlgWrap_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapSz(pszValue) +#define _tlgWrap_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapBuffer(pValue) +#define _tlgWrap_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapArray(pValues, cValues) +#define _tlgWrap_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapBinary(pValue, cbValue) +#define _tlgWrap_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapBinary(pchValue, (cchValue)*sizeof(ctype)) +#define _tlgWrap_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapPtrSize(pValues, (cValues)*sizeof(ctype)) +#define _tlgWrap_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) , _tlgWrapPtrSize(pValue, cbValue) +#define _tlgWrap_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgWrap_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) , _tlgWrap_tlgPackedData##hasType(ctype, pValue, cbValue, dataDescType) +#define _tlgWrap_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) , _tlgWrapBinary(pValue, cbValue) +#define _tlgWrap_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgWrap_tlgChannel( eventChannel ) +#define _tlgWrap_tlgLevel( eventLevel ) +#define _tlgWrap_tlgOpcode( eventOpcode ) +#define _tlgWrap_tlgKeyword( eventKeyword ) +#define _tlgWrap_tlgTag( eventTag ) +#define _tlgWrap_tlgDesc( eventDescription ) +#define _tlgWrap_tlgCustomAnnot(key, value ) +#define _tlgWrap_tlgPackedData0(ctype, pValue, cbValue, dataDescType) _tlgWrapPtrSize(pValue, cbValue) +#define _tlgWrap_tlgPackedData1(ctype, pValue, cbValue, dataDescType) _tlgWrapPtrSizeType(pValue, cbValue, dataDescType) + +#else // __cplusplus + +/* +Note: The _tlgTemp variable serves up to 3 purposes. +1. Type checking: by assigning the provided value to a ctype temporary, we get + a compile error or warning if the provided value is incompatible with + ctype. This is needed in every case except Psz. Psz is ok because the + _tlgCreate1Sz_ctype function is strongly-typed. +2. Single evaluation: in the Sid and Buffer cases, we don't want to repeatedly + evaluate the value pValue expression, so we need a temporary. +3. Storage: in the ScalarVal case, the value may be an rvalue, and we need to + take a pointer to it, so we store it in _tlgTemp. +Because of this, we store a temporary in all cases except Psz. +We also need a temporary for the Count in the Array case. +We can avoid the Count temporary for the Binary case because count == size, so +we can use &dataDescriptor[1].Size as the pointer to the count. +*/ +#define _tlgDataDescCreate(n, args) _tlgApplyArgsN(_tlgDataDescCreate, n, args) +#define _tlgDataDescCreate_tlgScalarVal( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const _tlgTemp##n = (value); \ + EventDataDescCreate(&_tlgData[_tlgIdx], &_tlgTemp##n, sizeof(ctype)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgScalarRef( n, ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = &(value); \ + EventDataDescCreate(&_tlgData[_tlgIdx], _tlgTemp##n, sizeof(ctype)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgSid( n, ctype, pValue, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValue); \ + EventDataDescCreate(&_tlgData[_tlgIdx], _tlgTemp##n, _tlgGetLengthSid(_tlgTemp##n)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgPsz( n, ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) \ + _tlgCreate1Sz_##ctype(&_tlgData[_tlgIdx], (pszValue)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgBuffer( n, ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValue); \ + _tlgCreate2Binary(&_tlgData[_tlgIdx], _tlgTemp##n->Buffer, _tlgTemp##n->Length); \ + _tlgIdx += 2; +#define _tlgDataDescCreate_tlgArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValues); \ + UINT16 const _tlgCount##n = (cValues); \ + EventDataDescCreate(&_tlgData[_tlgIdx+0], &_tlgCount##n, 2); \ + EventDataDescCreate(&_tlgData[_tlgIdx+1], _tlgTemp##n, _tlgCount##n * sizeof(ctype)); \ + _tlgIdx += 2; +#define _tlgDataDescCreate_tlgBinary( n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValue); \ + _tlgCreate2Binary(&_tlgData[_tlgIdx], _tlgTemp##n, (cbValue)); \ + _tlgIdx += 2; +#define _tlgDataDescCreate_tlgCounted( n, ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pchValue); \ + _tlgCreate2Binary(&_tlgData[_tlgIdx], _tlgTemp##n, sizeof(ctype)*(cchValue)); \ + _tlgIdx += 2; +#define _tlgDataDescCreate_tlgFixedArray( n, ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValues); \ + EventDataDescCreate(&_tlgData[_tlgIdx], _tlgTemp##n, (cValues)*sizeof(ctype)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgPackedField(n, ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValue); \ + _tlg_AssertValidPackedMetadataInType(inType); \ + EventDataDescCreate(&_tlgData[_tlgIdx], _tlgTemp##n, (cbValue)); \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgPackedMeta( n, inType, outType, hasOut, name, desc, tags, hasTags) \ + _tlg_AssertValidPackedMetadataInType(inType); +#define _tlgDataDescCreate_tlgPackedData( n, ctype, pValue, cbValue, dataDescType, hasType ) \ + ctype const* const _tlgTemp##n = (pValue); \ + _tlgData[_tlgIdx].Ptr = (ULONGLONG)(ULONG_PTR)_tlgTemp##n; \ + _tlgData[_tlgIdx].Size = (cbValue); \ + _tlgData[_tlgIdx].Reserved = dataDescType; \ + _tlgIdx += 1; +#define _tlgDataDescCreate_tlgCustom( n, ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) \ + ctype const* const _tlgTemp##n = (pValue); \ + _tlgCreate2Binary(&_tlgData[_tlgIdx], _tlgTemp##n, (cbValue)); \ + _tlgIdx += 2; +#define _tlgDataDescCreate_tlgStruct( n, fieldCount,inType, name, desc, tags, hasTags) \ + _tlg_CASSERT((fieldCount)<128, "TraceLoggingStruct fieldCount must be less than 128."); +#define _tlgDataDescCreate_tlgChannel( n, eventChannel ) +#define _tlgDataDescCreate_tlgLevel( n, eventLevel ) +#define _tlgDataDescCreate_tlgOpcode( n, eventOpcode ) +#define _tlgDataDescCreate_tlgKeyword( n, eventKeyword ) +#define _tlgDataDescCreate_tlgTag( n, eventTag ) +#define _tlgDataDescCreate_tlgDesc( n, eventDescription ) +#define _tlgDataDescCreate_tlgCustomAnnot(n, key, value ) + +#endif // __cplusplus + +#define _tlgDataDescCount(n, args) _tlgApplyArgs(_tlgDataDescCount, args) +#define _tlgDataDescCount_tlgAuto( value, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgSid( ctype, pValue, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +2 +#define _tlgDataDescCount_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +2 +#define _tlgDataDescCount_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +2 +#define _tlgDataDescCount_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +2 +#define _tlgDataDescCount_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +1 +#define _tlgDataDescCount_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDataDescCount_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +1 +#define _tlgDataDescCount_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +2 +#define _tlgDataDescCount_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +_tlgCheckStructFieldCountCppOnly(fieldCount) +#define _tlgDataDescCount_tlgChannel( eventChannel ) +#define _tlgDataDescCount_tlgLevel( eventLevel ) +#define _tlgDataDescCount_tlgOpcode( eventOpcode ) +#define _tlgDataDescCount_tlgKeyword( eventKeyword ) +#define _tlgDataDescCount_tlgTag( eventTag ) +#define _tlgDataDescCount_tlgDesc( eventDescription ) +#define _tlgDataDescCount_tlgCustomAnnot(key, value ) + +#define _tlgChannelVal(n, args) _tlgApplyArgs(_tlgChannelVal, args) +#define _tlgChannelVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgChannelVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgChannelVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgChannelVal_tlgChannel( eventChannel ) &0|(eventChannel) +#define _tlgChannelVal_tlgLevel( eventLevel ) +#define _tlgChannelVal_tlgOpcode( eventOpcode ) +#define _tlgChannelVal_tlgKeyword( eventKeyword ) +#define _tlgChannelVal_tlgTag( eventTag ) +#define _tlgChannelVal_tlgDesc( eventDescription ) +#define _tlgChannelVal_tlgCustomAnnot(key, value ) + +#define _tlgLevelVal(n, args) _tlgApplyArgs(_tlgLevelVal, args) +#define _tlgLevelVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgLevelVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgLevelVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgLevelVal_tlgChannel( eventChannel ) +#define _tlgLevelVal_tlgLevel( eventLevel ) &0|(eventLevel) +#define _tlgLevelVal_tlgOpcode( eventOpcode ) +#define _tlgLevelVal_tlgKeyword( eventKeyword ) +#define _tlgLevelVal_tlgTag( eventTag ) +#define _tlgLevelVal_tlgDesc( eventDescription ) +#define _tlgLevelVal_tlgCustomAnnot(key, value ) + +#define _tlgOpcodeVal(n, args) _tlgApplyArgs(_tlgOpcodeVal, args) +#define _tlgOpcodeVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgOpcodeVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgOpcodeVal_tlgChannel( eventChannel ) +#define _tlgOpcodeVal_tlgLevel( eventLevel ) +#define _tlgOpcodeVal_tlgOpcode( eventOpcode ) &0|(eventOpcode) +#define _tlgOpcodeVal_tlgKeyword( eventKeyword ) +#define _tlgOpcodeVal_tlgTag( eventTag ) +#define _tlgOpcodeVal_tlgDesc( eventDescription ) +#define _tlgOpcodeVal_tlgCustomAnnot(key, value ) + +#define _tlgKeywordVal(n, args) _tlgApplyArgs(_tlgKeywordVal, args) +#define _tlgKeywordVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgKeywordVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgKeywordVal_tlgChannel( eventChannel ) +#define _tlgKeywordVal_tlgLevel( eventLevel ) +#define _tlgKeywordVal_tlgOpcode( eventOpcode ) +#define _tlgKeywordVal_tlgKeyword( eventKeyword ) |(eventKeyword) +#define _tlgKeywordVal_tlgTag( eventTag ) +#define _tlgKeywordVal_tlgDesc( eventDescription ) +#define _tlgKeywordVal_tlgCustomAnnot(key, value ) + +#define _tlgEvtTagVal(n, args) _tlgApplyArgs(_tlgEvtTagVal, args) +#define _tlgEvtTagVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgEvtTagVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgEvtTagVal_tlgChannel( eventChannel ) +#define _tlgEvtTagVal_tlgLevel( eventLevel ) +#define _tlgEvtTagVal_tlgOpcode( eventOpcode ) +#define _tlgEvtTagVal_tlgKeyword( eventKeyword ) +#define _tlgEvtTagVal_tlgTag( eventTag ) |(eventTag) +#define _tlgEvtTagVal_tlgDesc( eventDescription ) +#define _tlgEvtTagVal_tlgCustomAnnot(key, value ) + +#define _tlgAnnotes(n, args) _tlgApplyArgs(_tlgAnnotes, args) +#define _tlgAnnotes_tlgAuto( value, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgSid( ctype, pValue, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgAnnotes_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) L"|" _tlg_LSTRINGIZE(name) L"=" desc +#define _tlgAnnotes_tlgChannel( eventChannel ) +#define _tlgAnnotes_tlgLevel( eventLevel ) +#define _tlgAnnotes_tlgOpcode( eventOpcode ) +#define _tlgAnnotes_tlgKeyword( eventKeyword ) +#define _tlgAnnotes_tlgTag( eventTag ) +#define _tlgAnnotes_tlgDesc( eventDescription ) +#define _tlgAnnotes_tlgCustomAnnot(key, value ) L"|" key L"=" value + +#define _tlgDescVal(n, args) _tlgApplyArgs(_tlgDescVal, args) +#define _tlgDescVal_tlgAuto( value, name, desc, tags, hasTags) +#define _tlgDescVal_tlgScalarVal( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgScalarRef( ctype, value, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgSid( ctype, pValue, name, desc, tags, hasTags) +#define _tlgDescVal_tlgPsz( ctype, pszValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgBuffer( ctype, pValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgBinary( ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgCounted( ctype, pchValue, cchValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgFixedArray( ctype, pValues, cValues, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgPackedField(ctype, pValue, cbValue, inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgPackedMeta( inType, outType, hasOut, name, desc, tags, hasTags) +#define _tlgDescVal_tlgPackedData( ctype, pValue, cbValue, dataDescType, hasType ) +#define _tlgDescVal_tlgCustom( ctype, pValue, cbValue, protocol,bSchema,cbSchema,name, desc, tags, hasTags) +#define _tlgDescVal_tlgStruct( fieldCount,inType, name, desc, tags, hasTags) +#define _tlgDescVal_tlgChannel( eventChannel ) +#define _tlgDescVal_tlgLevel( eventLevel ) +#define _tlgDescVal_tlgOpcode( eventOpcode ) +#define _tlgDescVal_tlgKeyword( eventKeyword ) +#define _tlgDescVal_tlgTag( eventTag ) +#define _tlgDescVal_tlgDesc( eventDescription ) eventDescription +#define _tlgDescVal_tlgCustomAnnot(key, value ) + +#ifdef __cplusplus + +template +struct _traceLoggingKeyword { static ULONGLONG const value = n; }; +#define _tlgKeywordConst(n) _traceLoggingKeyword::value + +template< + UINT32 eventTag, + unsigned length + = (eventTag & 0x0FE00000) == eventTag ? 1 + : (eventTag & 0x0FFFC000) == eventTag ? 2 + : (eventTag & 0x0FFFFFFF) == eventTag ? 4 + : 0> + struct _tlgTagEnc +{ + static_assert( + (eventTag & 0x0FFFFFFF) == eventTag, + "Invalid Tag value. Tag must be a 28-bit compile-time constant integer."); +}; + +template +struct _tlgTagEnc +{ + typedef UINT8 type; + static const UINT8 value = + ((eventTag & 0xfe00000) >> 21); +}; + +template +struct _tlgTagEnc +{ + typedef UINT16 type; + static const UINT16 value = 0x80 + | ((eventTag & 0xfe00000) >> 21) + | ((eventTag & 0x01fc000) >> 6); +}; + +template +struct _tlgTagEnc +{ + typedef UINT32 type; + static const UINT32 value = 0x808080 + | ((eventTag & 0xfe00000) >> 21) + | ((eventTag & 0x01fc000) >> 6) + | ((eventTag & 0x0003f80) << 9) + | ((eventTag & 0x000007f) << 24); +}; + +#define _tlgEvtTagDecl(eventTag) typedef _tlgTagEnc<(eventTag)> _tlgTagTy +#define _tlgEvtTagType _tlgTagTy::type +#define _tlgEvtTagInit _tlgTagTy::value + +#define _tlg_AssertValidPackedMetadataInTypeCppOnly(inType) _tlg_AssertValidPackedMetadataInType(inType); +#define _tlgCheckStructFieldCountCppOnly(fieldCount) _tlgCheckStructFieldCount::value + +#define _tlgPackAndEmitEvent(tlgWriteFunc, tlgWriteArgTypes, tlgWriteArgs, ...) \ + _tlgWriteTemplate::Write( \ + _tlgProv, &_tlgEvent._tlgChannel, \ + _tlg_FLATTEN tlgWriteArgs \ + _tlg_FOREACH(_tlgWrap, __VA_ARGS__)) + +#else // __cplusplus + +#define _tlgKeywordConst(n) n + +#define _tlgEvtTagDecl(eventTag) enum { _tlgTagConst = (eventTag) } +#define _tlgEvtTagType UINT16 +#define _tlgEvtTagInit \ + 128 /* Set the high bit of the low byte to indicate 2 bytes of tags. */ \ + |((0xfe00000&(UINT32)_tlgTagConst)>>21) /* Encode 0x0fe00000 bits into UINT16 */ \ + |((0x01fc000&(UINT32)_tlgTagConst)>>6) /* Encode 0x001fc000 bits into UINT16 */ \ + |((0x0003fff&(UINT32)_tlgTagConst)<<16) /* Trigger warning for 0x00003fff bits */ \ + |(~(0x0FFFFFFF|~(UINT32)_tlgTagConst)) /* Trigger warning for any other bits */ \ + +#define _tlg_AssertValidPackedMetadataInTypeCppOnly(inType) +#define _tlgCheckStructFieldCountCppOnly(fieldCount) 0 + +#define _tlgPackAndEmitEvent(tlgWriteFunc, tlgWriteArgTypes, tlgWriteArgs, ...) \ + EVENT_DATA_DESCRIPTOR _tlgData[_tlg_MetaDataDescCount _tlg_FOREACH(_tlgDataDescCount, __VA_ARGS__)]; \ + UINT32 _tlgIdx = _tlg_MetaDataDescCount; \ + _tlg_FOREACH(_tlgDataDescCreate, __VA_ARGS__) \ + tlgWriteFunc(_tlgProv, &_tlgEvent._tlgChannel, _tlg_FLATTEN tlgWriteArgs, _tlgIdx, _tlgData) + +#endif // __cplusplus + +#define _tlgWrite_imp(tlgWriteFunc, hProvider, eventName, tlgWriteArgTypes, tlgWriteArgs, ...) \ + do { \ + __pragma(warning(push)) \ + __pragma(warning(disable:4127 4132 6001)) \ + __pragma(warning(error:4047)) \ + __pragma(pack(push, 1)) \ + _tlgPragmaUtf8Begin \ + _tlgEvtTagDecl(0 _tlg_FOREACH(_tlgEvtTagVal, __VA_ARGS__)); \ + enum { _tlgChannelConst = (11u _tlg_FOREACH(_tlgChannelVal, __VA_ARGS__)) }; \ + enum { _tlgLevelConst = (5u _tlg_FOREACH(_tlgLevelVal, __VA_ARGS__)) }; \ + enum { _tlgOpcodeConst = (0u _tlg_FOREACH(_tlgOpcodeVal, __VA_ARGS__)) }; \ + static struct { \ + UCHAR _tlgBlobTyp; UCHAR _tlgChannel; UCHAR _tlgLevel; UCHAR _tlgOpcode; ULONGLONG _tlgKeyword; \ + UINT16 _tlgEvtMetaSize; \ + _tlgEvtTagType _tlgEvtTag; \ + char _tlgName[sizeof(eventName)]; \ + _tlg_FOREACH(_tlgInfoVars, __VA_ARGS__) \ + } __declspec(allocate(_tlgSegMetadataEvents)) __declspec(align(1)) const _tlgEvent = { \ + _TlgBlobEvent4, \ + _tlgChannelConst, \ + _tlgLevelConst, \ + _tlgOpcodeConst, \ + _tlgKeywordConst(0u _tlg_FOREACH(_tlgKeywordVal, __VA_ARGS__)), \ + sizeof(_tlgEvent)-_tlg_EVENT_METADATA_PREAMBLE-1, \ + _tlgEvtTagInit, \ + (eventName) \ + _tlg_FOREACH(_tlgInfoVals, __VA_ARGS__) \ + }; \ + TraceLoggingHProvider const _tlgProv = (hProvider); \ + if ((UCHAR)_tlgLevelConst < _tlgProv->LevelPlus1 && _tlgKeywordOn(_tlgProv, _tlgEvent._tlgKeyword)) { \ + __annotation( \ + L"_TlgWrite:|" _tlg_LSTRINGIZE(__LINE__) L"|" _tlg_LSTRINGIZE(hProvider) L"|" \ + _tlg_LSTRINGIZE(eventName) L"=" _tlg_FOREACH(_tlgDescVal, __VA_ARGS__) \ + _tlg_FOREACH(_tlgAnnotes, __VA_ARGS__) ); \ + _tlgPackAndEmitEvent(tlgWriteFunc, tlgWriteArgTypes, tlgWriteArgs, __VA_ARGS__); \ + } \ + _tlgPragmaUtf8End \ + __pragma(pack(pop)) \ + __pragma(warning(pop)) \ + } while (0) \ + +#define _tlg_DefineProvider_annotation(hProvider, functionPostfix, requiresWrapper, providerName) \ + _tlgDefineProvider_functionWrapperBegin##requiresWrapper(functionPostfix) \ + __annotation( \ + L"_TlgDefineProvider:|" _tlg_LSTRINGIZE(__LINE__) L"|" _tlg_LSTRINGIZE(hProvider) L"|" \ + providerName \ + ); \ + _tlgDefineProvider_functionWrapperEnd##requiresWrapper + +#define _tlgDefineProvider_functionWrapperBegin0(functionPostfix) + +// These functions exist only to contain annotations. They are never executed. +// They are extern "C" so that they can be named in pragma(linker, /include). +#define _tlgDefineProvider_functionWrapperBegin1(functionPostfix) \ + _tlg_EXTERN_C \ + void __cdecl \ + _tlg_PASTE2(_tlgDefineProvider_annotation_, functionPostfix)(void) \ + { +#define _tlgDefineProvider_functionWrapperEnd0 +#define _tlgDefineProvider_functionWrapperEnd1 } + +#pragma endregion + +#pragma warning(pop) +#endif // RC_INVOKED +#endif // _traceloggingprovider_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/afunix.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/afunix.h new file mode 100644 index 0000000000000000000000000000000000000000..d67939cd552edf51cc34efe535c6bd66c6696bda --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/afunix.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + afunix.h + +Abstract: + + This file contains the definitions for the AF_UNIX socket address family. + +--*/ + +#ifndef _AFUNIX_ +#define _AFUNIX_ + +#pragma once + +#define UNIX_PATH_MAX 108 + +typedef struct sockaddr_un +{ + ADDRESS_FAMILY sun_family; /* AF_UNIX */ + char sun_path[UNIX_PATH_MAX]; /* pathname */ +} SOCKADDR_UN, *PSOCKADDR_UN; + +#define SIO_AF_UNIX_GETPEERPID _WSAIOR(IOC_VENDOR, 256) // Returns ULONG PID of the connected peer process +#define SIO_AF_UNIX_SETBINDPARENTPATH _WSAIOW(IOC_VENDOR, 257) // Set the parent path for bind calls +#define SIO_AF_UNIX_SETCONNPARENTPATH _WSAIOW(IOC_VENDOR, 258) // Set the parent path for connect calls +// NOTE: setting the parent path is not thread safe. + +#endif /* _AFUNIX_ */ \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apdevpkey.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apdevpkey.h new file mode 100644 index 0000000000000000000000000000000000000000..db4e1b8e397ec6b0a565582fd3fa8383bd7c568d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apdevpkey.h @@ -0,0 +1,36 @@ + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + apdevpkey.h + +Abstract: + + Defines Plug and Play Device property keys used for AutoPlay behavior. + +Environment: + + User and Kernel modes. + + +--*/ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#include "devpropdef.h" + +// +// Indicate that AutoPlay should not be displayed for this device interface. +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Autoplay_Silent, 0x434dd28f, 0x9e75, 0x450a, 0x9a, 0xb9, 0xff, 0x61, 0xe6, 0x18, 0xba, 0xd0, 2); // DEVPROP_TYPE_BOOLEAN +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apiset.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apiset.h new file mode 100644 index 0000000000000000000000000000000000000000..c5598b3d9c202700b769757336c744706c3309ef --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apiset.h @@ -0,0 +1,137 @@ +/*++ + +Copyright (c) 2008 Microsoft Corporation + +Module Name: + + apiset.h + +Abstract: + + This module contains definitions related to the management of API namespaces. + +Author: + + Arun Kishan (arunki) 14-Sep-2008 + +--*/ + +#ifndef _API_SET_H_ +#define _API_SET_H_ + +// +// API set interface definitions. +// + +#define API_SET_OVERRIDE(X) X##Implementation +#define API_SET_LEGACY_OVERRIDE_DEF(X) X = API_SET_OVERRIDE(X) +#define API_SET_OVERRIDE_DEF(X) API_SET_LEGACY_OVERRIDE_DEF(X) PRIVATE + +#ifdef _M_HYBRID_X86_ARM64 + +#define API_SET_CHPE_GUEST X86 + +#else + +#define API_SET_CHPE_GUEST + +#endif + +#undef API_SET +#undef API_SET_DIR +#undef API_SET_BY_ORDINAL +#undef API_SET_BY_ORDINAL_DIR +#undef API_SET_WITH_OPTIONAL_ORDINAL +#undef API_SET_WITH_OPTIONAL_ORDINAL_DIR + +#undef API_SET_LEGACY +#undef API_SET_LEGACY_DIR +#undef API_SET_LEGACY_BY_ORDINAL +#undef API_SET_LEGACY_BY_ORDINAL_DIR +#undef API_SET_LEGACY_WITH_OPTIONAL_ORDINAL +#undef API_SET_LEGACY_WITH_OPTIONAL_ORDINAL_DIR + + +#ifdef _API_SET_HOST +// This section is intended for hosting contracts. Any legacy host definitions are ignored. + +#undef API_SET_LIBRARY + +#define API_SET_LIBRARY(X) + +#define API_SET(X) X PRIVATE +#define API_SET_DIR(X,DIR) X DIR PRIVATE +#define API_SET_BY_ORDINAL(X,O,PO) X @##O NONAME PRIVATE +#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X @##O NONAME DIR PRIVATE +#define API_SET_WITH_OPTIONAL_ORDINAL(X,O,PO) X @##O PRIVATE +#define API_SET_WITH_OPTIONAL_ORDINAL_DIR(X,O,PO,DIR) X @##O DIR PRIVATE + +#define API_SET_LEGACY(X,L) X PRIVATE +#define API_SET_LEGACY_DIR(X,L,DIR) X DIR PRIVATE +#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X @##O NONAME PRIVATE +#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X @##O NONAME DIR PRIVATE +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL(X,L,O,PO) X @##O PRIVATE +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL_DIR(X,L,O,PO,DIR) X @##O DIR PRIVATE + +#else + +#if defined(_API_SET_LEGACY_TARGET) +// This section is intended for "classic apiset forwarders" that are forwarding back to a legacy host. +// In this section, the definition for _API_SET_LEGACY_TARGET is taken as the default legacy host for the +// entire contract. But any APIs which specify LegacyHost directly will override this definition. + +#define API_SET(X) X = _API_SET_LEGACY_TARGET##.##X +#define API_SET_DIR(X,DIR) X = _API_SET_LEGACY_TARGET##.##X DIR +#define API_SET_BY_ORDINAL(X,O,PO) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME +#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_LEGACY_TARGET##.##PO @##O NONAME DIR +#define API_SET_WITH_OPTIONAL_ORDINAL(X,O,PO) X = _API_SET_LEGACY_TARGET##.##PO @##O +#define API_SET_WITH_OPTIONAL_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_LEGACY_TARGET##.##PO @##O DIR + +#define API_SET_LEGACY(X,L) X = L##.##X +#define API_SET_LEGACY_DIR(X,L,DIR) X = L##.##X DIR +#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X = L##.##PO @##O NONAME +#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X = L##.##PO @##O NONAME DIR +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL(X,L,O,PO) X = L##.##PO @##O +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL_DIR(X,L,O,PO,DIR) X = L##.##PO @##O DIR + +#elif defined(_API_SET_FORWARDER_TARGET) +// This section is intended for "reverse forwarders" that are forwarding to an explicit apiset name. +// Any legacy targets are ignored. +#define API_SET(X) X = _API_SET_FORWARDER_TARGET##.##X +#define API_SET_DIR(X,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR +#define API_SET_BY_ORDINAL(X,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME +#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR +#define API_SET_WITH_OPTIONAL_ORDINAL(X,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O +#define API_SET_WITH_OPTIONAL_ORDINAL_DIR(X,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O DIR + +#define API_SET_LEGACY(X,L) X = _API_SET_FORWARDER_TARGET##.##X +#define API_SET_LEGACY_DIR(X,L,DIR) X = _API_SET_FORWARDER_TARGET##.##X DIR +#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME +#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O NONAME DIR +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL(X,L,O,PO) X = _API_SET_FORWARDER_TARGET##.##PO @##O +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL_DIR(X,L,O,PO,DIR) X = _API_SET_FORWARDER_TARGET##.##PO @##O DIR + +#else +// This section is intended for internal contract generation to build artifacts that model the contract without forwarding. + +#define API_SET(X) X +#define API_SET_DIR(X,DIR) X DIR +#define API_SET_BY_ORDINAL(X,O,PO) X @##O NONAME +#define API_SET_BY_ORDINAL_DIR(X,O,PO,DIR) X @##O NONAME DIR +#define API_SET_WITH_OPTIONAL_ORDINAL(X,O,PO) X @##O +#define API_SET_WITH_OPTIONAL_ORDINAL_DIR(X,O,PO,DIR) X @##O DIR + +#define API_SET_LEGACY(X,L) X +#define API_SET_LEGACY_DIR(X,L,DIR) X DIR +#define API_SET_LEGACY_BY_ORDINAL(X,L,O,PO) X @##O NONAME +#define API_SET_LEGACY_BY_ORDINAL_DIR(X,L,O,PO,DIR) X @##O NONAME DIR +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL(X,L,O,PO) X @##O +#define API_SET_LEGACY_WITH_OPTIONAL_ORDINAL_DIR(X,L,O,PO,DIR) X @##O DIR + +#endif // _API_SET_LEGACY_TARGET, _API_SET_FORWARDER_TARGET + +#define API_SET_LIBRARY(X) LIBRARY X + +#endif // _API_SET_HOST + +#endif // _API_SET_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apisetcconv.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apisetcconv.h new file mode 100644 index 0000000000000000000000000000000000000000..a7ca077e1ba1456e1e6932a0b3b701c29b3aed75 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/apisetcconv.h @@ -0,0 +1,102 @@ +/************************************************************************ +* * +* apisetcconv.h -- Contains Win32 Calling Conventions for APISETs * +* that were a part of the old legacy APIs * +* Copyright (c) Microsoft Corp. All rights reserved. * +* * +************************************************************************/ +#ifndef _APISETCCONV_ +#define _APISETCCONV_ + + +#if !defined(WINADVAPI) +#if !defined(_ADVAPI32_) +#define WINADVAPI DECLSPEC_IMPORT +#else +#define WINADVAPI +#endif +#endif + +#if !defined(WINBASEAPI) +#if !defined(_KERNEL32_) +#define WINBASEAPI DECLSPEC_IMPORT +#else +#define WINBASEAPI +#endif +#endif + +#if !defined(ZAWPROXYAPI) +#if !defined(_ZAWPROXY_) +#define ZAWPROXYAPI DECLSPEC_IMPORT +#else +#define ZAWPROXYAPI +#endif +#endif + +#if !defined(WINUSERAPI) +#if !defined(_USER32_) +#define WINUSERAPI DECLSPEC_IMPORT +#define WINABLEAPI DECLSPEC_IMPORT +#else +#define WINUSERAPI +#define WINABLEAPI +#endif +#endif + +#if !defined(WINABLEAPI) +#if !defined(_USER32_) +#define WINABLEAPI DECLSPEC_IMPORT +#else +#define WINABLEAPI +#endif +#endif + +#if !defined(WINCFGMGR32API) +#if !defined(_SETUPAPI_) +#define WINCFGMGR32API DECLSPEC_IMPORT +#else +#define WINCFGMGR32API +#endif +#endif + +#if !defined(WINDEVQUERYAPI) +#if !defined(_CFGMGR32_) +#define WINDEVQUERYAPI DECLSPEC_IMPORT +#else +#define WINDEVQUERYAPI +#endif +#endif + +#if !defined(WINSWDEVICEAPI) +#if !defined(_CFGMGR32_) +#define WINSWDEVICEAPI DECLSPEC_IMPORT +#else +#define WINSWDEVICEAPI +#endif +#endif + +#if !defined(CMAPI) +#if !defined(_CFGMGR32_) +#define CMAPI DECLSPEC_IMPORT +#else +#define CMAPI +#endif +#endif + +#if !defined(WINPATHCCHAPI) +#if !defined(STATIC_PATHCCH) +#define WINPATHCCHAPI WINBASEAPI +#else +#define WINPATHCCHAPI +#endif +#endif + +#if !defined(WINSTORAGEAPI) +#if !defined(_WINSTORAGEAPI_) +#define WINSTORAGEAPI DECLSPEC_IMPORT +#else +#define WINSTORAGEAPI +#endif +#endif + +#endif // _APISETCCONV_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/atsmedia.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/atsmedia.h new file mode 100644 index 0000000000000000000000000000000000000000..b5f91d4ba6be06bcd53eb1ef17a2686c07ed010b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/atsmedia.h @@ -0,0 +1,43 @@ +//------------------------------------------------------------------------------ +// File: ATSMedia.h +// +// Desc: Broadcast Driver Architecture Media Definitions for ATSC +// +// Copyright (c) 1996 - 2001, Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if !defined(_KSMEDIA_) +#error KSMEDIA.H must be included before BDAMEDIA.H +#endif // !defined(_KSMEDIA_) + +#if !defined(_BDAMEDIA_) +#error BDAMEDIA.H must be included before ATSCMEDIA.H +#endif // !defined(_KSMEDIA_) + +#if !defined(_ATSCMEDIA_) +#define _ATSCMEDIA_ + + +//=========================================================================== +// +// ATSC Network Type +// +//=========================================================================== + +#define STATIC_BDANETWORKTYPE_ATSC\ + 0x71985f51, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F51-1CA1-11d3-9CC8-00C04F7971E0", BDANETWORKTYPE_ATSC); +#define BDANETWORKTYPE_ATSC DEFINE_GUIDNAMED(BDANETWORKTYPE_ATSC) + + +#endif // _ATSCMEDIA_ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetsd.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetsd.h new file mode 100644 index 0000000000000000000000000000000000000000..39b11d3b641f998ffd8b602db09affd6c385cf9d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetsd.h @@ -0,0 +1,518 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + basetsd.h + +Abstract: + + Type definitions for the basic sized types. + +Author: + +Revision History: + +--*/ + +#ifndef _BASETSD_H_ +#define _BASETSD_H_ + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#endif + +#if !defined(_MAC) && (defined(_M_MRX000) || defined(_WIN64)) && (_MSC_VER >= 1100) && !(defined(MIDL_PASS) || defined(RC_INVOKED)) + #define POINTER_64 __ptr64 + typedef unsigned __int64 POINTER_64_INT; + #if defined(_WIN64) + #define POINTER_32 __ptr32 + #else + #define POINTER_32 + #endif +#else + #if defined(_MAC) && defined(_MAC_INT_64) + #define POINTER_64 __ptr64 + typedef unsigned __int64 POINTER_64_INT; + #else + #if (_MSC_VER >= 1300) && !(defined(MIDL_PASS) || defined(RC_INVOKED)) + #define POINTER_64 __ptr64 + #else + #define POINTER_64 + #endif + typedef unsigned long POINTER_64_INT; + #endif + #define POINTER_32 +#endif + +#if defined(_WIN64) +#define FIRMWARE_PTR +#else +#define FIRMWARE_PTR POINTER_32 +#endif + +#if (_MSC_FULL_VER >= 140041204) && !defined(MIDL_PASS) && !defined(RC_INVOKED) +#define POINTER_SIGNED __sptr +#define POINTER_UNSIGNED __uptr +#else +#define POINTER_SIGNED +#define POINTER_UNSIGNED +#endif + +#define SPOINTER_32 POINTER_SIGNED POINTER_32 +#define UPOINTER_32 POINTER_UNSIGNED POINTER_32 + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef signed char INT8, *PINT8; +typedef signed short INT16, *PINT16; +typedef signed int INT32, *PINT32; +typedef signed __int64 INT64, *PINT64; +typedef unsigned char UINT8, *PUINT8; +typedef unsigned short UINT16, *PUINT16; +typedef unsigned int UINT32, *PUINT32; +typedef unsigned __int64 UINT64, *PUINT64; + +// +// The following types are guaranteed to be signed and 32 bits wide. +// + +typedef signed int LONG32, *PLONG32; + +// +// The following types are guaranteed to be unsigned and 32 bits wide. +// + +typedef unsigned int ULONG32, *PULONG32; +typedef unsigned int DWORD32, *PDWORD32; + +#if !defined(_W64) +#if !defined(__midl) && (defined(_X86_) || defined(_M_IX86) || defined(_ARM_) || defined(_M_ARM)) && _MSC_VER >= 1300 +#define _W64 __w64 +#else +#define _W64 +#endif +#endif + +// +// The INT_PTR is guaranteed to be the same size as a pointer. Its +// size with change with pointer size (32/64). It should be used +// anywhere that a pointer is cast to an integer type. UINT_PTR is +// the unsigned variation. +// +// __int3264 is intrinsic to 64b MIDL but not to old MIDL or to C compiler. +// +#if ( defined(__midl) && (501 < __midl) ) + + typedef [public] __int3264 INT_PTR, *PINT_PTR; + typedef [public] unsigned __int3264 UINT_PTR, *PUINT_PTR; + + typedef [public] __int3264 LONG_PTR, *PLONG_PTR; + typedef [public] unsigned __int3264 ULONG_PTR, *PULONG_PTR; + +#else // midl64 +// old midl and C++ compiler + +#if defined(_WIN64) + typedef __int64 INT_PTR, *PINT_PTR; + typedef unsigned __int64 UINT_PTR, *PUINT_PTR; + + typedef __int64 LONG_PTR, *PLONG_PTR; + typedef unsigned __int64 ULONG_PTR, *PULONG_PTR; + + #define __int3264 __int64 + +#else + typedef _W64 int INT_PTR, *PINT_PTR; + typedef _W64 unsigned int UINT_PTR, *PUINT_PTR; + + typedef _W64 long LONG_PTR, *PLONG_PTR; + typedef _W64 unsigned long ULONG_PTR, *PULONG_PTR; + + #define __int3264 __int32 + +#endif +#endif // midl64 + +// +// HANDLE64 uses 64 bits in both WIN32 and WIN64 platforms. This along with +// HandleToHandle64 and Handle64ToHandle conversion macros, help simplify WOW +// support while user mode and kernel mode communicate with a shared memory or +// when we prefer to use fixed size types in both WIN32 and WIN64 for other +// reasons. +// + +#ifndef __HANDLE64_DEFINED__ +#define __HANDLE64_DEFINED__ +typedef void* POINTER_64 HANDLE64; +typedef HANDLE64 *PHANDLE64; +#endif + +// +// HALF_PTR is half the size of a pointer it intended for use with +// within structures which contain a pointer and two small fields. +// UHALF_PTR is the unsigned variation. +// + +#ifdef _WIN64 + +#define ADDRESS_TAG_BIT 0x40000000000UI64 + +typedef __int64 SHANDLE_PTR; +typedef unsigned __int64 HANDLE_PTR; +typedef unsigned int UHALF_PTR, *PUHALF_PTR; +typedef int HALF_PTR, *PHALF_PTR; + +#if !defined(__midl) +__inline +unsigned long +HandleToULong( + const void *h + ) +{ + return((unsigned long) (ULONG_PTR) h ); +} + +__inline +long +HandleToLong( + const void *h + ) +{ + return((long) (LONG_PTR) h ); +} + +__inline +void * +ULongToHandle( + const unsigned long h + ) +{ + return((void *) (UINT_PTR) h ); +} + + +__inline +void * +LongToHandle( + const long h + ) +{ + return((void *) (INT_PTR) h ); +} + + +__inline +unsigned long +PtrToUlong( + const void *p + ) +{ + return((unsigned long) (ULONG_PTR) p ); +} + +__inline +unsigned int +PtrToUint( + const void *p + ) +{ + return((unsigned int) (UINT_PTR) p ); +} + +__inline +unsigned short +PtrToUshort( + const void *p + ) +{ + return((unsigned short) (unsigned long) (ULONG_PTR) p ); +} + +__inline +long +PtrToLong( + const void *p + ) +{ + return((long) (LONG_PTR) p ); +} + +__inline +int +PtrToInt( + const void *p + ) +{ + return((int) (INT_PTR) p ); +} + +__inline +short +PtrToShort( + const void *p + ) +{ + return((short) (long) (LONG_PTR) p ); +} + +__inline +void * +IntToPtr( + const int i + ) +// Caution: IntToPtr() sign-extends the int value. +{ + return( (void *)(INT_PTR)i ); +} + +__inline +void * +UIntToPtr( + const unsigned int ui + ) +// Caution: UIntToPtr() zero-extends the unsigned int value. +{ + return( (void *)(UINT_PTR)ui ); +} + +__inline +void * +LongToPtr( + const long l + ) +// Caution: LongToPtr() sign-extends the long value. +{ + return( (void *)(LONG_PTR)l ); +} + +__inline +void * +ULongToPtr( + const unsigned long ul + ) +// Caution: ULongToPtr() zero-extends the unsigned long value. +{ + return( (void *)(ULONG_PTR)ul ); +} + +#define PtrToPtr64( p ) ((void * POINTER_64) p) +#define Ptr64ToPtr( p ) ((void *) p) +#define HandleToHandle64( h ) (PtrToPtr64( h )) +#define Handle64ToHandle( h ) (Ptr64ToPtr( h )) + +__inline +void * +Ptr32ToPtr( + const void * POINTER_32 p + ) +{ + return((void *) (ULONG_PTR) (unsigned long) p); +} + +__inline +void * +Handle32ToHandle( + const void * POINTER_32 h + ) +{ + return((void *) (LONG_PTR) (long) h); +} + +__inline +void * POINTER_32 +PtrToPtr32( + const void *p + ) +{ + return((void * POINTER_32) (unsigned long) (ULONG_PTR) p); +} + +#define HandleToHandle32( h ) (PtrToPtr32( h )) + +#endif // !_midl + +#else // !_WIN64 + +#define ADDRESS_TAG_BIT 0x80000000UL + +typedef unsigned short UHALF_PTR, *PUHALF_PTR; +typedef short HALF_PTR, *PHALF_PTR; +typedef _W64 long SHANDLE_PTR; +typedef _W64 unsigned long HANDLE_PTR; + +#define HandleToULong( h ) ((ULONG)(ULONG_PTR)(h) ) +#define HandleToLong( h ) ((LONG)(LONG_PTR) (h) ) +#define ULongToHandle( ul ) ((HANDLE)(ULONG_PTR) (ul) ) +#define LongToHandle( h ) ((HANDLE)(LONG_PTR) (h) ) +#define PtrToUlong( p ) ((ULONG)(ULONG_PTR) (p) ) +#define PtrToLong( p ) ((LONG)(LONG_PTR) (p) ) +#define PtrToUint( p ) ((UINT)(UINT_PTR) (p) ) +#define PtrToInt( p ) ((INT)(INT_PTR) (p) ) +#define PtrToUshort( p ) ((unsigned short)(ULONG_PTR)(p) ) +#define PtrToShort( p ) ((short)(LONG_PTR)(p) ) +#define IntToPtr( i ) ((VOID *)(INT_PTR)((int)i)) +#define UIntToPtr( ui ) ((VOID *)(UINT_PTR)((unsigned int)ui)) +#define LongToPtr( l ) ((VOID *)(LONG_PTR)((long)l)) +#define ULongToPtr( ul ) ((VOID *)(ULONG_PTR)((unsigned long)ul)) + +#if !defined(__midl) +__inline +void * POINTER_64 +PtrToPtr64( + const void *p + ) +{ + return((void * POINTER_64) (unsigned __int64) (ULONG_PTR) p ); +} + +__inline +void * +Ptr64ToPtr( + const void * POINTER_64 p + ) +{ + return((void *) (ULONG_PTR) (unsigned __int64) p); +} + +__inline +HANDLE64 +HandleToHandle64( + const void * h + ) +{ + return((HANDLE64) (__int64) (LONG_PTR) h ); +} + +__inline +void * +Handle64ToHandle( + const HANDLE64 h + ) +{ + return((void *) (ULONG_PTR) (unsigned __int64) h ); +} +#endif + +#define Ptr32ToPtr( p ) ((void *) p) +#define Handle32ToHandle( h ) (Ptr32ToPtr( h )) +#define PtrToPtr32( p ) ((void * POINTER_32) p) +#define HandleToHandle32( h ) (PtrToPtr32( h )) + +#endif // !_WIN64 + +#define HandleToUlong(h) HandleToULong(h) +#define UlongToHandle(ul) ULongToHandle(ul) +#define UlongToPtr(ul) ULongToPtr(ul) +#define UintToPtr(ui) UIntToPtr(ui) + +#define MAXUINT_PTR (~((UINT_PTR)0)) +#define MAXINT_PTR ((INT_PTR)(MAXUINT_PTR >> 1)) +#define MININT_PTR (~MAXINT_PTR) + +#define MAXULONG_PTR (~((ULONG_PTR)0)) +#define MAXLONG_PTR ((LONG_PTR)(MAXULONG_PTR >> 1)) +#define MINLONG_PTR (~MAXLONG_PTR) + +#define MAXUHALF_PTR ((UHALF_PTR)~0) +#define MAXHALF_PTR ((HALF_PTR)(MAXUHALF_PTR >> 1)) +#define MINHALF_PTR (~MAXHALF_PTR) + +// +// SIZE_T used for counts or ranges which need to span the range of +// of a pointer. SSIZE_T is the signed variation. +// + +typedef ULONG_PTR SIZE_T, *PSIZE_T; +typedef LONG_PTR SSIZE_T, *PSSIZE_T; + +#if _WIN32_WINNT >= 0x0600 || (defined(__cplusplus) && defined(WINDOWS_ENABLE_CPLUSPLUS)) + +#define MAXUINT8 ((UINT8)~((UINT8)0)) +#define MAXINT8 ((INT8)(MAXUINT8 >> 1)) +#define MININT8 ((INT8)~MAXINT8) + +#define MAXUINT16 ((UINT16)~((UINT16)0)) +#define MAXINT16 ((INT16)(MAXUINT16 >> 1)) +#define MININT16 ((INT16)~MAXINT16) + +#define MAXUINT32 ((UINT32)~((UINT32)0)) +#define MAXINT32 ((INT32)(MAXUINT32 >> 1)) +#define MININT32 ((INT32)~MAXINT32) + +#define MAXUINT64 ((UINT64)~((UINT64)0)) +#define MAXINT64 ((INT64)(MAXUINT64 >> 1)) +#define MININT64 ((INT64)~MAXINT64) + +#define MAXULONG32 ((ULONG32)~((ULONG32)0)) +#define MAXLONG32 ((LONG32)(MAXULONG32 >> 1)) +#define MINLONG32 ((LONG32)~MAXLONG32) + +#define MAXULONG64 ((ULONG64)~((ULONG64)0)) +#define MAXLONG64 ((LONG64)(MAXULONG64 >> 1)) +#define MINLONG64 ((LONG64)~MAXLONG64) + +#define MAXULONGLONG ((ULONGLONG)~((ULONGLONG)0)) +#define MINLONGLONG ((LONGLONG)~MAXLONGLONG) + +#define MAXSIZE_T ((SIZE_T)~((SIZE_T)0)) +#define MAXSSIZE_T ((SSIZE_T)(MAXSIZE_T >> 1)) +#define MINSSIZE_T ((SSIZE_T)~MAXSSIZE_T) + +#define MAXUINT ((UINT)~((UINT)0)) +#define MAXINT ((INT)(MAXUINT >> 1)) +#define MININT ((INT)~MAXINT) + +#define MAXDWORD32 ((DWORD32)~((DWORD32)0)) +#define MAXDWORD64 ((DWORD64)~((DWORD64)0)) + +#endif // _WIN32_WINNT >= 0x0600 + +// +// Add Windows flavor DWORD_PTR types +// + +typedef ULONG_PTR DWORD_PTR, *PDWORD_PTR; + +// +// The following types are guaranteed to be signed and 64 bits wide. +// + +typedef __int64 LONG64, *PLONG64; + + +// +// The following types are guaranteed to be unsigned and 64 bits wide. +// + +typedef unsigned __int64 ULONG64, *PULONG64; +typedef unsigned __int64 DWORD64, *PDWORD64; + +// begin_wudfpwdm + +// +// Legacy thread affinity. +// + +typedef ULONG_PTR KAFFINITY; +typedef KAFFINITY *PKAFFINITY; + +// end_wudfpwdm + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // _BASETSD_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetyps.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetyps.h new file mode 100644 index 0000000000000000000000000000000000000000..4f0ccb15c1b3c2f4f75887b5b3979ee3f9010332 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/basetyps.h @@ -0,0 +1,226 @@ +//+--------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (c) Microsoft Corporation. All rights reserved. +// +// File: basetyps.h +// +//---------------------------------------------------------------------------- +#if !defined( _BASETYPS_H_ ) +#define _BASETYPS_H_ + +#if _MSC_VER > 1000 +#pragma once +#endif + +// Common macros gleamed from COMPOBJ.H + +#ifdef __cplusplus + #define EXTERN_C extern "C" +#else + #define EXTERN_C extern +#endif + +#ifdef _WIN32 + +// Win32 doesn't support __export + +#define STDMETHODCALLTYPE __stdcall +#define STDMETHODVCALLTYPE __cdecl + +#define STDAPICALLTYPE __stdcall +#define STDAPIVCALLTYPE __cdecl + +#else + +#define STDMETHODCALLTYPE __export __stdcall +#define STDMETHODVCALLTYPE __export __cdecl + +#define STDAPICALLTYPE __export __stdcall +#define STDAPIVCALLTYPE __export __cdecl + +#endif + +#define STDAPI EXTERN_C HRESULT STDAPICALLTYPE +#define STDAPI_(type) EXTERN_C type STDAPICALLTYPE + +#define STDMETHODIMP HRESULT STDMETHODCALLTYPE +#define STDMETHODIMP_(type) type STDMETHODCALLTYPE + +// The 'V' versions allow Variable Argument lists. + +#define STDAPIV EXTERN_C HRESULT STDAPIVCALLTYPE +#define STDAPIV_(type) EXTERN_C type STDAPIVCALLTYPE + +#define STDMETHODIMPV HRESULT STDMETHODVCALLTYPE +#define STDMETHODIMPV_(type) type STDMETHODVCALLTYPE + + + + +/****** Interface Declaration ***********************************************/ + +/* + * These are macros for declaring interfaces. They exist so that + * a single definition of the interface is simulataneously a proper + * declaration of the interface structures (C++ abstract classes) + * for both C and C++. + * + * DECLARE_INTERFACE(iface) is used to declare an interface that does + * not derive from a base interface. + * DECLARE_INTERFACE_(iface, baseiface) is used to declare an interface + * that does derive from a base interface. + * + * By default if the source file has a .c extension the C version of + * the interface declaratations will be expanded; if it has a .cpp + * extension the C++ version will be expanded. if you want to force + * the C version expansion even though the source file has a .cpp + * extension, then define the macro "CINTERFACE". + * eg. cl -DCINTERFACE file.cpp + * + * Example Interface declaration: + * + * #undef INTERFACE + * #define INTERFACE IClassFactory + * + * DECLARE_INTERFACE_(IClassFactory, IUnknown) + * { + * // *** IUnknown methods *** + * STDMETHOD(QueryInterface) (THIS_ + * REFIID riid, + * LPVOID FAR* ppvObj) PURE; + * STDMETHOD_(ULONG,AddRef) (THIS) PURE; + * STDMETHOD_(ULONG,Release) (THIS) PURE; + * + * // *** IClassFactory methods *** + * STDMETHOD(CreateInstance) (THIS_ + * LPUNKNOWN pUnkOuter, + * REFIID riid, + * LPVOID FAR* ppvObject) PURE; + * }; + * + * Example C++ expansion: + * + * struct FAR IClassFactory : public IUnknown + * { + * virtual HRESULT STDMETHODCALLTYPE QueryInterface( + * IID FAR& riid, + * LPVOID FAR* ppvObj) = 0; + * virtual HRESULT STDMETHODCALLTYPE AddRef(void) = 0; + * virtual HRESULT STDMETHODCALLTYPE Release(void) = 0; + * virtual HRESULT STDMETHODCALLTYPE CreateInstance( + * LPUNKNOWN pUnkOuter, + * IID FAR& riid, + * LPVOID FAR* ppvObject) = 0; + * }; + * + * NOTE: Our documentation says '#define interface class' but we use + * 'struct' instead of 'class' to keep a lot of 'public:' lines + * out of the interfaces. The 'FAR' forces the 'this' pointers to + * be far, which is what we need. + * + * Example C expansion: + * + * typedef struct IClassFactory + * { + * const struct IClassFactoryVtbl FAR* lpVtbl; + * } IClassFactory; + * + * typedef struct IClassFactoryVtbl IClassFactoryVtbl; + * + * struct IClassFactoryVtbl + * { + * HRESULT (STDMETHODCALLTYPE * QueryInterface) ( + * IClassFactory FAR* This, + * IID FAR* riid, + * LPVOID FAR* ppvObj) ; + * HRESULT (STDMETHODCALLTYPE * AddRef) (IClassFactory FAR* This) ; + * HRESULT (STDMETHODCALLTYPE * Release) (IClassFactory FAR* This) ; + * HRESULT (STDMETHODCALLTYPE * CreateInstance) ( + * IClassFactory FAR* This, + * LPUNKNOWN pUnkOuter, + * IID FAR* riid, + * LPVOID FAR* ppvObject); + * HRESULT (STDMETHODCALLTYPE * LockServer) ( + * IClassFactory FAR* This, + * BOOL fLock); + * }; + */ + + +#if defined(__cplusplus) && !defined(CINTERFACE) +//#define interface struct FAR + +#ifdef COM_STDMETHOD_CAN_THROW +#define COM_DECLSPEC_NOTHROW +#else +#define COM_DECLSPEC_NOTHROW DECLSPEC_NOTHROW +#endif + +#define __STRUCT__ struct +#define interface __STRUCT__ +#define STDMETHOD(method) virtual COM_DECLSPEC_NOTHROW HRESULT STDMETHODCALLTYPE method +#define STDMETHOD_(type,method) virtual COM_DECLSPEC_NOTHROW type STDMETHODCALLTYPE method +#define STDMETHODV(method) virtual COM_DECLSPEC_NOTHROW HRESULT STDMETHODVCALLTYPE method +#define STDMETHODV_(type,method) virtual COM_DECLSPEC_NOTHROW type STDMETHODVCALLTYPE method +#define PURE = 0 +#define THIS_ +#define THIS void +#define DECLARE_INTERFACE(iface) interface DECLSPEC_NOVTABLE iface +#define DECLARE_INTERFACE_(iface, baseiface) interface DECLSPEC_NOVTABLE iface : public baseiface + +#define IFACEMETHOD(method) __override STDMETHOD(method) +#define IFACEMETHOD_(type,method) __override STDMETHOD_(type,method) +#define IFACEMETHODV(method) __override STDMETHODV(method) +#define IFACEMETHODV_(type,method) __override STDMETHODV_(type,method) + +#else + +#define interface struct + +#define STDMETHOD(method) HRESULT (STDMETHODCALLTYPE * method) +#define STDMETHOD_(type,method) type (STDMETHODCALLTYPE * method) +#define STDMETHODV(method) HRESULT (STDMETHODVCALLTYPE * method) +#define STDMETHODV_(type,method) type (STDMETHODVCALLTYPE * method) + +#define IFACEMETHOD(method) __override STDMETHOD(method) +#define IFACEMETHOD_(type,method) __override STDMETHOD_(type,method) +#define IFACEMETHODV(method) __override STDMETHODV(method) +#define IFACEMETHODV_(type,method) __override STDMETHODV_(type,method) + + + +#define PURE +#define THIS_ INTERFACE FAR* This, +#define THIS INTERFACE FAR* This +#ifdef CONST_VTABLE +#define DECLARE_INTERFACE(iface) typedef interface iface { \ + const struct iface##Vtbl FAR* lpVtbl; \ + } iface; \ + typedef const struct iface##Vtbl iface##Vtbl; \ + const struct iface##Vtbl +#else +#define DECLARE_INTERFACE(iface) typedef interface iface { \ + struct iface##Vtbl FAR* lpVtbl; \ + } iface; \ + typedef struct iface##Vtbl iface##Vtbl; \ + struct iface##Vtbl +#endif +#define DECLARE_INTERFACE_(iface, baseiface) DECLARE_INTERFACE(iface) + +#endif + +#include + +#ifndef _ERROR_STATUS_T_DEFINED +typedef unsigned long error_status_t; +#define _ERROR_STATUS_T_DEFINED +#endif + +#ifndef _WCHAR_T_DEFINED +typedef unsigned short wchar_t; +#define _WCHAR_T_DEFINED +#endif + +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/batclass.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/batclass.h new file mode 100644 index 0000000000000000000000000000000000000000..577d300b982622014472dae85b7c91c0e6ba97fd --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/batclass.h @@ -0,0 +1,660 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + batclass.h + +Abstract: + + Defines battery class driver interfaces. + +--*/ + +#include + +// +// Battery device GUID +// + +DEFINE_GUID (BATTERY_STATUS_WMI_GUID, + 0xfc4670d1, 0xebbf, 0x416e, 0x87, 0xce, 0x37, 0x4a, 0x4e, 0xbc, 0x11, 0x1a); + +DEFINE_GUID (BATTERY_RUNTIME_WMI_GUID, + 0x535a3767, 0x1ac2, 0x49bc, 0xa0, 0x77, 0x3f, 0x7a, 0x02, 0xe4, 0x0a, 0xec); + +DEFINE_GUID (BATTERY_TEMPERATURE_WMI_GUID, + 0x1a52a14d, 0xadce, 0x4a44, 0x9a, 0x3e, 0xc8, 0xd8, 0xf1, 0x5f, 0xf2, 0xc2); + +DEFINE_GUID (BATTERY_FULL_CHARGED_CAPACITY_WMI_GUID, + 0x40b40565, 0x96f7, 0x4435, 0x86, 0x94, 0x97, 0xe0, 0xe4, 0x39, 0x59, 0x05); + +DEFINE_GUID (BATTERY_CYCLE_COUNT_WMI_GUID, + 0xef98db24, 0x0014, 0x4c25, 0xa5, 0x0b, 0xc7, 0x24, 0xae, 0x5c, 0xd3, 0x71); + +DEFINE_GUID (BATTERY_STATIC_DATA_WMI_GUID, + 0x05e1e463, 0xe4e2, 0x4ea9, 0x80, 0xcb, 0x9b, 0xd4, 0xb3, 0xca, 0x06, 0x55); + +DEFINE_GUID (BATTERY_STATUS_CHANGE_WMI_GUID, + 0xcddfa0c3, 0x7c5b, 0x4e43, 0xa0, 0x34, 0x05, 0x9f, 0xa5, 0xb8, 0x43, 0x64); + +DEFINE_GUID (BATTERY_TAG_CHANGE_WMI_GUID, + 0x5e1f6e19, 0x8786, 0x4d23, 0x94, 0xfc, 0x9e, 0x74, 0x6b, 0xd5, 0xd8, 0x88); + +#ifndef _BATCLASS_ +#define _BATCLASS_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#if (NTDDI_VERSION < NTDDI_WINXP) + +// +// Format of data returned when +// BATTERY_INFORMATION_LEVEL = BatteryGranularityInformation +// is an array of BATTERY_REPORTING_SCALE +// + +#ifndef _NTPOAPI_ + +typedef struct { + ULONG Granularity; + ULONG Capacity; +} BATTERY_REPORTING_SCALE, *PBATTERY_REPORTING_SCALE; + +#endif // _NTPOAPI_ + +#endif // (NTDDI_VERSION < NTDDI_WINXP) + +#ifndef _WINDOWS_ + +#pragma warning(push) +#pragma warning(disable:4214) /* nonstandard extension used : bit field types other then int */ + +// +// Battery Class-Miniport device driver interfaces +// + +_Function_class_(BCLASS_QUERY_TAG_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_QUERY_TAG_CALLBACK)( + _In_ PVOID Context, + _Out_ PULONG BatteryTag + ); + +typedef BCLASS_QUERY_TAG_CALLBACK *PBCLASS_QUERY_TAG_CALLBACK; + + +_Function_class_(BCLASS_QUERY_INFORMATION_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_QUERY_INFORMATION_CALLBACK)( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _In_ BATTERY_QUERY_INFORMATION_LEVEL Level, + _In_ LONG AtRate, + _Out_writes_bytes_to_(BufferLength, *ReturnedLength) PVOID Buffer, + _In_ ULONG BufferLength, + _Out_ PULONG ReturnedLength + ); + +typedef BCLASS_QUERY_INFORMATION_CALLBACK *PBCLASS_QUERY_INFORMATION_CALLBACK; + + +_Function_class_(BCLASS_QUERY_STATUS_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_QUERY_STATUS_CALLBACK)( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _Out_ PBATTERY_STATUS BatteryStatus + ); + +typedef BCLASS_QUERY_STATUS_CALLBACK *PBCLASS_QUERY_STATUS_CALLBACK; + +_Function_class_(ACLASS_QUERY_STATUS_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(ACLASS_QUERY_STATUS_CALLBACK)( + _In_ PVOID Context, + _Out_ PPOWER_ADAPTER_STATUS AdapterStatus + ); + +typedef ACLASS_QUERY_STATUS_CALLBACK *PACLASS_QUERY_STATUS_CALLBACK; +typedef PACLASS_QUERY_STATUS_CALLBACK ACLASS_QUERY_STATUS; + +_Function_class_(ACLASS_SET_STATUS_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(ACLASS_SET_STATUS_CALLBACK)( + _In_ PVOID Context, + _In_ PPOWER_ADAPTER_SET_STATUS_BUFFER AdapterStatus + ); + +typedef ACLASS_SET_STATUS_CALLBACK *PACLASS_SET_STATUS_CALLBACK; +typedef PACLASS_SET_STATUS_CALLBACK ACLASS_SET_STATUS; + +typedef struct _ADAPTER_NOTIFY { + UCHAR Version; + UCHAR Reserved[3]; + ULONG PeakPowerThreshold; +} ADAPTER_NOTIFY, *PADAPTER_NOTIFY; + +_Function_class_(ACLASS_SET_STATUS_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(ACLASS_SET_STATUS_NOTIFY_CALLBACK)( + _In_ PVOID Context, + _In_ PADAPTER_NOTIFY AdapterNotify + ); + +typedef ACLASS_SET_STATUS_NOTIFY_CALLBACK *PACLASS_SET_STATUS_NOTIFY_CALLBACK; +typedef PACLASS_SET_STATUS_NOTIFY_CALLBACK ACLASS_SET_STATUS_NOTIFY; + +_Function_class_(ACLASS_DISABLE_STATUS_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(ACLASS_DISABLE_STATUS_NOTIFY_CALLBACK) ( + _In_ PVOID Context + ); + +typedef ACLASS_DISABLE_STATUS_NOTIFY_CALLBACK *PACLASS_DISABLE_STATUS_NOTIFY_CALLBACK; +typedef PACLASS_DISABLE_STATUS_NOTIFY_CALLBACK ACLASS_DISABLE_STATUS_NOTIFY; + +typedef struct { + ULONG PowerState; + ULONG LowCapacity; + ULONG HighCapacity; +} BATTERY_NOTIFY, *PBATTERY_NOTIFY; + +typedef struct _BATTERY_NOTIFY_V2 { + ULONG PowerState; + ULONG LowCapacity; + ULONG HighCapacity; + UCHAR Version; + UCHAR Reserved[3]; + ULONG BatteryPresentRateThreshold; +} BATTERY_NOTIFY_V2, *PBATTERY_NOTIFY_V2; + +_Function_class_(BCLASS_SET_STATUS_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_SET_STATUS_NOTIFY_CALLBACK)( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _In_ PBATTERY_NOTIFY BatteryNotify + ); + +typedef BCLASS_SET_STATUS_NOTIFY_CALLBACK *PBCLASS_SET_STATUS_NOTIFY_CALLBACK; + +#define BATTERY_NOTIFY_VERSION_1 1 +#define BATTERY_NOTIFY_VERSION_2 2 + +_Function_class_(BCLASS_SET_INFORMATION_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_SET_INFORMATION_CALLBACK)( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _In_ BATTERY_SET_INFORMATION_LEVEL Level, + _In_opt_ PVOID Buffer + ); + +typedef BCLASS_SET_INFORMATION_CALLBACK *PBCLASS_SET_INFORMATION_CALLBACK; + + +_Function_class_(BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK)( + _In_ PVOID Context + ); + +typedef BCLASS_DISABLE_STATUS_NOTIFY_CALLBACK + *PBCLASS_DISABLE_STATUS_NOTIFY_CALLBACK; + +typedef struct _BATTERY_PEAK_POWER { + UCHAR Version; + UCHAR Reserved[3]; + ULONG InstantaneousPeakPower; + ULONG InstantaneousPeakPeriod; + ULONG SustainablePeakPower; + ULONG SustainablePeakPeriod; +} BATTERY_PEAK_POWER, *PBATTERY_PEAK_POWER; + +_Function_class_(BCLASS_QUERY_PEAK_POWER_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_QUERY_PEAK_POWER_CALLBACK) ( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _Inout_ PBATTERY_PEAK_POWER PeakPower + ); + +typedef BCLASS_QUERY_PEAK_POWER_CALLBACK *PBCLASS_QUERY_PEAK_POWER_CALLBACK; + +typedef struct _BATTERY_PEAK_POWER_THRESHOLDS { + UCHAR Version; + UCHAR Reserved[3]; + ULONG InstantaneousPeakPowerThreshold; + ULONG SustainablePeakPowerThreshold; +} BATTERY_PEAK_POWER_THRESHOLDS, *PBATTERY_PEAK_POWER_THRESHOLDS; + +_Function_class_(BCLASS_SET_PEAK_POWER_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_SET_PEAK_POWER_NOTIFY_CALLBACK) ( + _In_ PVOID Context, + _In_ ULONG BatteryTag, + _In_ PBATTERY_PEAK_POWER_THRESHOLDS PeakPowerThresholds + ); + +typedef BCLASS_SET_PEAK_POWER_NOTIFY_CALLBACK + *PBCLASS_SET_PEAK_POWER_NOTIFY_CALLBACK; + +_Function_class_(BCLASS_DISABLE_PEAK_POWER_NOTIFY_CALLBACK) +_IRQL_requires_same_ +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +typedef +NTSTATUS +(BCLASS_DISABLE_PEAK_POWER_NOTIFY_CALLBACK) ( + _In_ PVOID Context + ); + +typedef BCLASS_DISABLE_PEAK_POWER_NOTIFY_CALLBACK + *PBCLASS_DISABLE_PEAK_POWER_NOTIFY_CALLBACK; + +typedef PBCLASS_QUERY_TAG_CALLBACK BCLASS_QUERY_TAG; +typedef PBCLASS_QUERY_INFORMATION_CALLBACK BCLASS_QUERY_INFORMATION; +typedef PBCLASS_QUERY_STATUS_CALLBACK BCLASS_QUERY_STATUS; +typedef PBCLASS_SET_STATUS_NOTIFY_CALLBACK BCLASS_SET_STATUS_NOTIFY; +typedef PBCLASS_SET_INFORMATION_CALLBACK BCLASS_SET_INFORMATION; +typedef PBCLASS_DISABLE_STATUS_NOTIFY_CALLBACK BCLASS_DISABLE_STATUS_NOTIFY; +typedef PBCLASS_QUERY_PEAK_POWER_CALLBACK BCLASS_QUERY_PEAK_POWER; +typedef PBCLASS_SET_PEAK_POWER_NOTIFY_CALLBACK BCLASS_SET_PEAK_POWER_NOTIFY; +typedef PBCLASS_DISABLE_PEAK_POWER_NOTIFY_CALLBACK BCLASS_DISABLE_PEAK_POWER_NOTIFY; + +typedef struct { + USHORT MajorVersion; + USHORT MinorVersion; + + PVOID Context; // Miniport context + + BCLASS_QUERY_TAG QueryTag; + BCLASS_QUERY_INFORMATION QueryInformation; + BCLASS_SET_INFORMATION SetInformation; + BCLASS_QUERY_STATUS QueryStatus; + BCLASS_SET_STATUS_NOTIFY SetStatusNotify; + BCLASS_DISABLE_STATUS_NOTIFY DisableStatusNotify; + PDEVICE_OBJECT Pdo; + PUNICODE_STRING DeviceName; +} BATTERY_MINIPORT_INFO, *PBATTERY_MINIPORT_INFO; + +typedef struct { + USHORT MajorVersion; + USHORT MinorVersion; + + PVOID Context; // Miniport context + + BCLASS_QUERY_TAG QueryTag; + BCLASS_QUERY_INFORMATION QueryInformation; + BCLASS_SET_INFORMATION SetInformation; + BCLASS_QUERY_STATUS QueryStatus; + BCLASS_SET_STATUS_NOTIFY SetStatusNotify; + BCLASS_DISABLE_STATUS_NOTIFY DisableStatusNotify; + PDEVICE_OBJECT Pdo; + PUNICODE_STRING DeviceName; + PDEVICE_OBJECT Fdo; +} BATTERY_MINIPORT_INFO_V1_1, *PBATTERY_MINIPORT_INFO_V1_1; + +typedef union _BATTERY_CLASS_DRIVER_CAPABILITIES { + struct { + ULONG PeakPower : 1; + ULONG BatteryPresentRateThreshold : 1; + ULONG Reserved : 30; + } Bits; + + ULONG AsUlong; +} BATTERY_CLASS_DRIVER_CAPABILITIES, *PBATTERY_CLASS_DRIVER_CAPABILITIES; + +typedef struct { + USHORT MajorVersion; + USHORT MinorVersion; + + PVOID Context; // Miniport context + + BCLASS_QUERY_TAG QueryTag; + BCLASS_QUERY_INFORMATION QueryInformation; + BCLASS_SET_INFORMATION SetInformation; + BCLASS_QUERY_STATUS QueryStatus; + BCLASS_SET_STATUS_NOTIFY SetStatusNotify; + BCLASS_DISABLE_STATUS_NOTIFY DisableStatusNotify; + PDEVICE_OBJECT Pdo; + PUNICODE_STRING DeviceName; + PDEVICE_OBJECT Fdo; + + // + // This field is set by the class driver to expose its capabilities, this helps + // newer miniport driver to be compatiable with older class drivers. For V1.0 + // and V1.1 class driver, this field won't be updated. + // + + BATTERY_CLASS_DRIVER_CAPABILITIES ClassDriverCapabilities; + + // + // Callbacks for peak power related status. + // + + BCLASS_QUERY_PEAK_POWER QueryPeakPower; + BCLASS_SET_PEAK_POWER_NOTIFY SetPeakPowerNotify; + BCLASS_DISABLE_PEAK_POWER_NOTIFY DisablePeakPowerNotify; +} BATTERY_MINIPORT_INFO_V1_2, *PBATTERY_MINIPORT_INFO_V1_2; + +#define CHARGE_REQUIREMENT_MAX_POWER_SOURCE_TYPES 2 + +typedef struct _ADAPTER_INFORMATION { + ULONG AcAdapterCount; + BOOLEAN RecSupported; + POWER_ADAPTER_CHARGE_REQUIREMENT ChargeRequirement[CHARGE_REQUIREMENT_MAX_POWER_SOURCE_TYPES]; +} ADAPTER_INFORMATION, *PADAPTER_INFORMATION; + +typedef struct _ADAPTER_MINIPORT_INFO { + USHORT MajorVersion; + USHORT MinorVersion; + PVOID Context; + PDEVICE_OBJECT Pdo; + PDEVICE_OBJECT Fdo; + PUNICODE_STRING Description; + ADAPTER_INFORMATION AdapterInformation; + ACLASS_QUERY_STATUS QueryStatus; + ACLASS_SET_STATUS SetStatus; + ACLASS_SET_STATUS_NOTIFY SetStatusNotify; + ACLASS_DISABLE_STATUS_NOTIFY DisableStatusNotify; +} ADAPTER_MINIPORT_INFO, *PADAPTER_MINIPORT_INFO; + +typedef enum BATTERY_CHARGING_STATE { + BatteryNoPowerSupply = 0, + BatteryInadequatePowerSupply = 1, + BatteryAdequatePowerSupply = 2 +} BATTERY_CHARGING_STATE; + +// +// Battery data. +// + +typedef struct _BATTERY_NON_CATASTROPHIC_EVENT { + ULONG BatteryChargeLimitState : 1; + ULONG BatteryChargingState : 2; + ULONG Reserved : 29; +} BATTERY_NON_CATASTROPHIC_EVENT, *PBATTERY_NON_CATASTROPHIC_EVENT; + +typedef struct _BATTERY_MINIPORT_UPDATE_DATA { + ULONG Version; + BATTERY_NON_CATASTROPHIC_EVENT NotifyEvent; +} BATTERY_MINIPORT_UPDATE_DATA, *PBATTERY_MINIPORT_UPDATE_DATA; + +typedef BATTERY_MINIPORT_UPDATE_DATA BATTERY_MINIPORT_UPDATE_DATA_V2; +typedef PBATTERY_MINIPORT_UPDATE_DATA PBATTERY_MINIPORT_UPDATE_DATA_V2; + +#define BATTERY_MINIPORT_UPDATE_DATA_VER_1 0x00000001 +#define BATTERY_MINIPORT_UPDATE_DATA_VER_2 0x00000002 + +#define BATTERY_MINIPORT_UPDATE_DATA_VER_1_SIZE sizeof(BATTERY_MINIPORT_UPDATE_DATA) +#define BATTERY_MINIPORT_UPDATE_DATA_VER_2_SIZE sizeof(BATTERY_MINIPORT_UPDATE_DATA_V2) + +#pragma warning(pop) + +// +// Miniport info struct version info. +// + +#define BATTERY_CLASS_MAJOR_VERSION 0x0001 +#define BATTERY_CLASS_MINOR_VERSION 0x0000 +#define BATTERY_CLASS_MINOR_VERSION_1 0x0001 +#define BATTERY_CLASS_MINOR_VERSION_2 0x0002 + +#define ADAPTER_CLASS_MAJOR_VERSION 0x0001 +#define ADAPTER_CLASS_MINOR_VERSION 0x0000 + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// +// WMI data block structures +// + +typedef struct _BATTERY_WMI_STATUS { + ULONG Tag; + ULONG RemainingCapacity; + LONG ChargeRate; + LONG DischargeRate; + ULONG Voltage; + BOOLEAN PowerOnline; + BOOLEAN Charging; + BOOLEAN Discharging; + BOOLEAN Critical; +} BATTERY_WMI_STATUS, *PBATTERY_WMI_STATUS; + +typedef struct _BATTERY_WMI_RUNTIME +{ + ULONG Tag; + ULONG EstimatedRuntime; +} BATTERY_WMI_RUNTIME, *PBATTERY_WMI_RUNTIME; + +typedef struct _BATTERY_WMI_TEMPERATURE +{ + ULONG Tag; + ULONG Temperature; +} BATTERY_WMI_TEMPERATURE, *PBATTERY_WMI_TEMPERATURE; + +typedef struct _BATTERY_WMI_FULL_CHARGED_CAPACITY +{ + ULONG Tag; + ULONG FullChargedCapacity; +} BATTERY_WMI_FULL_CHARGED_CAPACITY, *PBATTERY_WMI_FULL_CHARGED_CAPACITY; + +typedef struct _BATTERY_WMI_CYCLE_COUNT +{ + ULONG Tag; + ULONG CycleCount; +} BATTERY_WMI_CYCLE_COUNT, *PBATTERY_WMI_CYCLE_COUNT; + +typedef struct _BATTERY_WMI_STATIC_DATA +{ + ULONG Tag; + WCHAR ManufactureDate[25]; + BATTERY_REPORTING_SCALE Granularity [4]; + ULONG Capabilities; + UCHAR Technology; + ULONG Chemistry; + ULONG DesignedCapacity; + ULONG DefaultAlert1; + ULONG DefaultAlert2; + ULONG CriticalBias; + WCHAR Strings[1]; + // Four variable length string values are stored with the first USHORT + // value containing the length of the string in bytes. + // + // Device Name + // Manufacture Name + // Serial Number + // UniqueID + // +} BATTERY_WMI_STATIC_DATA, *PBATTERY_WMI_STATIC_DATA; + +typedef struct _BATTERY_WMI_STATUS_CHANGE +{ + ULONG Tag; + BOOLEAN PowerOnline; + BOOLEAN Charging; + BOOLEAN Discharging; + BOOLEAN Critical; +} BATTERY_WMI_STATUS_CHANGE, *PBATTERY_WMI_STATUS_CHANGE; + +typedef struct _BATTERY_TAG_CHANGE +{ + ULONG Tag; +} BATTERY_TAG_CHANGE, *PBATTERY_TAG_CHANGE; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// +// Battery class driver functions +// + +#if !defined(BATTERYCLASS) + #define BATTERYCLASSAPI DECLSPEC_IMPORT +#else + #define BATTERYCLASSAPI +#endif + + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +BatteryClassInitializeDevice ( + _In_ PBATTERY_MINIPORT_INFO MiniportInfo, + _Out_ PVOID *ClassData + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +NTSTATUS +BATTERYCLASSAPI +BatteryClassUnload ( + _In_ PVOID ClassData + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +BatteryClassIoctl ( + _In_ PVOID ClassData, + _Inout_ PIRP Irp + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +BatteryClassSystemControl ( + _In_ PVOID ClassData, + _In_ PVOID WmiLibContext, //PWMILIB_CONTEXT + _In_ PDEVICE_OBJECT DeviceObject, + _Inout_ PIRP Irp, + _Out_ PVOID Disposition //PSYSCTL_IRP_DISPOSITION + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +BatteryClassQueryWmiDataBlock( + _In_ PVOID ClassData, + _Inout_ PDEVICE_OBJECT DeviceObject, + _Inout_ PIRP Irp, + _In_ ULONG GuidIndex, + _Out_writes_(1) PULONG InstanceLengthArray, + _In_ ULONG OutBufferSize, + _Out_writes_bytes_opt_(OutBufferSize) PUCHAR Buffer + ); + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS +BATTERYCLASSAPI +BatteryClassStatusNotify ( + _In_ PVOID ClassData + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS +BATTERYCLASSAPI +BatteryClassPeakPowerNotify ( + _In_ PVOID ClassData + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +BatteryClassUpdateData ( + _In_ PVOID ClassData, + _In_ PBATTERY_MINIPORT_UPDATE_DATA UpdateData + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Check_return_ +NTSTATUS +BATTERYCLASSAPI +AdapterClassInitializeDevice ( + _In_ PADAPTER_MINIPORT_INFO MiniportInfo, + _Out_ PVOID *ClassData + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS +BATTERYCLASSAPI +AdapterClassStatusNotify ( + _In_ PVOID ClassData + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +NTSTATUS +BATTERYCLASSAPI +AdapterClassUnload ( + _In_ PVOID ClassData + ); + +#endif // _WINDOWS_ + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _BATCLASS_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bcrypt.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bcrypt.h new file mode 100644 index 0000000000000000000000000000000000000000..c05c9ae0c3f0117f4fbebcf15701b48039912033 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bcrypt.h @@ -0,0 +1,2153 @@ +//+--------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (C) Microsoft Corporation, 2004. +// +// File: bcrypt.h +// +// Contents: Cryptographic Primitive API Prototypes and Definitions +// +//---------------------------------------------------------------------------- + +#pragma once + +// +// The __BCRYPT_H__ is used by other header files to conditionally define +// BCrypt-dependent extensions when bcrypt.h has been included. +// +#define __BCRYPT_H__ + +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family or OneCore or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef WINAPI +#define WINAPI __stdcall +#endif + +#ifndef _NTDEF_ +typedef _Return_type_success_(return >= 0) LONG NTSTATUS; +typedef NTSTATUS *PNTSTATUS; +#endif + +#ifndef BCRYPT_SUCCESS +#define BCRYPT_SUCCESS(Status) (((NTSTATUS)(Status)) >= 0) +#endif + +#ifndef CONST +#define CONST const +#endif + +#ifndef IN +#define IN +#endif + +#ifndef OUT +#define OUT +#endif + +#ifndef OPTIONAL +#define OPTIONAL +#endif + +// +// Alignment macros +// + +// +// BCRYPT_OBJECT_ALIGNMENT must be a power of 2 +// We align all our internal data structures to 16 to +// allow fast XMM memory accesses. +// BCrypt callers do not need to take any alignment precautions. +// +#define BCRYPT_OBJECT_ALIGNMENT 16 + +// +// BCRYPT_STRUCT_ALIGNMENT is an alignment macro that we no longer use. +// It used to align declspec(align(4)) on x86 and declspec(align(8)) on x64/ia64 but +// all structures that used it contained a pointer so they were already 4/8 aligned. +// +#define BCRYPT_STRUCT_ALIGNMENT + +// +// DeriveKey KDF Types +// +#define BCRYPT_KDF_HASH L"HASH" +#define BCRYPT_KDF_HMAC L"HMAC" +#define BCRYPT_KDF_TLS_PRF L"TLS_PRF" + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define BCRYPT_KDF_SP80056A_CONCAT L"SP800_56A_CONCAT" +#endif + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +#define BCRYPT_KDF_RAW_SECRET L"TRUNCATE" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define BCRYPT_KDF_HKDF L"HKDF" +#endif + +// +// DeriveKey KDF BufferTypes +// +// For BCRYPT_KDF_HASH and BCRYPT_KDF_HMAC operations, there may be an arbitrary +// number of KDF_SECRET_PREPEND and KDF_SECRET_APPEND buffertypes in the +// parameter list. The BufferTypes are processed in order of appearence +// within the parameter list. +// +#define KDF_HASH_ALGORITHM 0x0 +#define KDF_SECRET_PREPEND 0x1 +#define KDF_SECRET_APPEND 0x2 +#define KDF_HMAC_KEY 0x3 +#define KDF_TLS_PRF_LABEL 0x4 +#define KDF_TLS_PRF_SEED 0x5 +#define KDF_SECRET_HANDLE 0x6 + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define KDF_TLS_PRF_PROTOCOL 0x7 +#define KDF_ALGORITHMID 0x8 +#define KDF_PARTYUINFO 0x9 +#define KDF_PARTYVINFO 0xA +#define KDF_SUPPPUBINFO 0xB +#define KDF_SUPPPRIVINFO 0xC +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define KDF_LABEL 0xD +#define KDF_CONTEXT 0xE +#define KDF_SALT 0xF +#define KDF_ITERATION_COUNT 0x10 +// +// +// Parameters for BCrypt(/NCrypt)KeyDerivation: +// Generic parameters: +// KDF_GENERIC_PARAMETER and KDF_HASH_ALGORITHM are the generic parameters that can be passed for the following KDF algorithms: +// BCRYPT/NCRYPT_SP800108_CTR_HMAC_ALGORITHM +// KDF_GENERIC_PARAMETER = KDF_LABEL||0x00||KDF_CONTEXT +// BCRYPT/NCRYPT_SP80056A_CONCAT_ALGORITHM +// KDF_GENERIC_PARAMETER = KDF_ALGORITHMID || KDF_PARTYUINFO || KDF_PARTYVINFO {|| KDF_SUPPPUBINFO } {|| KDF_SUPPPRIVINFO } +// BCRYPT/NCRYPT_PBKDF2_ALGORITHM +// KDF_GENERIC_PARAMETER = KDF_SALT +// BCRYPT/NCRYPT_CAPI_KDF_ALGORITHM +// KDF_GENERIC_PARAMETER = Not used +// BCRYPT/NCRYPT_TLS1_1_KDF_ALGORITHM +// KDF_GENERIC_PARAMETER = Not used +// BCRYPT/NCRYPT_TLS1_2_KDF_ALGORITHM +// KDF_GENERIC_PARAMETER = Not used +// BCRYPT/NCRYPT_HKDF_ALGORITHM +// KDF_GENERIC_PARAMETER = Not used +// +// KDF specific parameters: +// For BCRYPT/NCRYPT_SP800108_CTR_HMAC_ALGORITHM: +// KDF_HASH_ALGORITHM, KDF_LABEL and KDF_CONTEXT are required +// For BCRYPT/NCRYPT_SP80056A_CONCAT_ALGORITHM: +// KDF_HASH_ALGORITHM, KDF_ALGORITHMID, KDF_PARTYUINFO, KDF_PARTYVINFO are required +// KDF_SUPPPUBINFO, KDF_SUPPPRIVINFO are optional +// For BCRYPT/NCRYPT_PBKDF2_ALGORITHM +// KDF_HASH_ALGORITHM is required +// KDF_ITERATION_COUNT, KDF_SALT are optional +// Iteration count, (if not specified) will default to 10,000 +// For BCRYPT/NCRYPT_CAPI_KDF_ALGORITHM +// KDF_HASH_ALGORITHM is required +// For BCRYPT/NCRYPT_TLS1_1_KDF_ALGORITHM +// KDF_TLS_PRF_LABEL is required +// KDF_TLS_PRF_SEED is required +// For BCRYPT/NCRYPT_TLS1_2_KDF_ALGORITHM +// KDF_HASH_ALGORITHM is required +// KDF_TLS_PRF_LABEL is required +// KDF_TLS_PRF_SEED is required +// For BCRYPT/NCRYPT_HKDF_ALGORITHM +// KDF_HKDF_INFO is optional +// +#define KDF_GENERIC_PARAMETER 0x11 +#define KDF_KEYBITLENGTH 0x12 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define KDF_HKDF_SALT 0x13 // This is used only for testing purposes +#define KDF_HKDF_INFO 0x14 +#endif + + +// +// DeriveKey Flags: +// +// KDF_USE_SECRET_AS_HMAC_KEY_FLAG causes the secret agreement to serve also +// as the HMAC key. If this flag is used, the KDF_HMAC_KEY parameter should +// NOT be specified. +// +#define KDF_USE_SECRET_AS_HMAC_KEY_FLAG 0x1 + +// +// BCrypt structs +// + +typedef struct __BCRYPT_KEY_LENGTHS_STRUCT +{ + ULONG dwMinLength; + ULONG dwMaxLength; + ULONG dwIncrement; +} BCRYPT_KEY_LENGTHS_STRUCT; + +typedef BCRYPT_KEY_LENGTHS_STRUCT BCRYPT_AUTH_TAG_LENGTHS_STRUCT; + +typedef struct _BCRYPT_OID +{ + ULONG cbOID; + PUCHAR pbOID; +} BCRYPT_OID; + +typedef struct _BCRYPT_OID_LIST +{ + ULONG dwOIDCount; + BCRYPT_OID *pOIDs; +} BCRYPT_OID_LIST; + +typedef struct _BCRYPT_PKCS1_PADDING_INFO +{ + LPCWSTR pszAlgId; +} BCRYPT_PKCS1_PADDING_INFO; + +typedef struct _BCRYPT_PSS_PADDING_INFO +{ + LPCWSTR pszAlgId; + ULONG cbSalt; +} BCRYPT_PSS_PADDING_INFO; + +typedef struct _BCRYPT_OAEP_PADDING_INFO +{ + LPCWSTR pszAlgId; + PUCHAR pbLabel; + ULONG cbLabel; +} BCRYPT_OAEP_PADDING_INFO; + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +typedef struct _BCRYPT_PQDSA_PADDING_INFO { + PUCHAR pbCtx; + ULONG cbCtx; + LPCWSTR pszPrehashAlgId; +} BCRYPT_PQDSA_PADDING_INFO; +#endif + +#define BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO_VERSION 1 + +#define BCRYPT_AUTH_MODE_CHAIN_CALLS_FLAG 0x00000001 +#define BCRYPT_AUTH_MODE_IN_PROGRESS_FLAG 0x00000002 + +typedef struct _BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO +{ + ULONG cbSize; + ULONG dwInfoVersion; + PUCHAR pbNonce; + ULONG cbNonce; + PUCHAR pbAuthData; + ULONG cbAuthData; + PUCHAR pbTag; + ULONG cbTag; + PUCHAR pbMacContext; + ULONG cbMacContext; + ULONG cbAAD; + ULONGLONG cbData; + ULONG dwFlags; +} BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO, *PBCRYPT_AUTHENTICATED_CIPHER_MODE_INFO; + +#define BCRYPT_INIT_AUTH_MODE_INFO(_AUTH_INFO_STRUCT_) \ + RtlZeroMemory((&_AUTH_INFO_STRUCT_), sizeof(BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO)); \ + (_AUTH_INFO_STRUCT_).cbSize = sizeof(BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO); \ + (_AUTH_INFO_STRUCT_).dwInfoVersion = BCRYPT_AUTHENTICATED_CIPHER_MODE_INFO_VERSION; + +// +// BCrypt String Properties +// + +// BCrypt(Import/Export)Key BLOB types +#define BCRYPT_OPAQUE_KEY_BLOB L"OpaqueKeyBlob" +#define BCRYPT_KEY_DATA_BLOB L"KeyDataBlob" + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define BCRYPT_AES_WRAP_KEY_BLOB L"Rfc3565KeyWrapBlob" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GA) + +#define BCRYPT_PKCS11_RSA_AES_WRAP_KEY_BLOB L"PKCS11RsaAesWrapBlob" + +#define BCRYPT_PKCS11_RSA_AES_WRAP_BLOB_MAGIC 0x57504152 // 'RAPW' for RSA-AES-PAD-WRAP (PKCS11-RSA-AES-WRAP) +typedef struct _BCRYPT_PKCS11_RSA_AES_WRAP_BLOB { + ULONG dwMagic; // BCRYPT_PKCS11_RSA_AES_WRAP_BLOB_MAGIC + ULONG cbKey; // Number of bytes in the binary PKCS#11 wrapped key blob + ULONG cbPaddingAlgId; // Number of bytes in OAEP Padding algorithm per OAEPParams in PKCS#11 specification + ULONG cbPaddingLabel; // Number of bytes in OAEP Padding label per OAEPParams in PKCS#11 specification + // UCHAR Key[cbKey]; -- PKCS#11 binary blob + // UCHAR PaddingAlgId[cbPaddingAlgId]; -- OAEP Padding information for PKCS#11 unwrapping + // UCHAR PaddingLabel[cbPaddingLabel]; -- OAEP Padding information for PKCS#11 unwrapping +} BCRYPT_PKCS11_RSA_AES_WRAP_BLOB, *PBCRYPT_PKCS11_RSA_AES_WRAP_BLOB; + +#endif // #if (NTDDI_VERSION >= NTDDI_WIN11_GA) +// BCryptGetProperty strings +#define BCRYPT_OBJECT_LENGTH L"ObjectLength" +#define BCRYPT_ALGORITHM_NAME L"AlgorithmName" +#define BCRYPT_PROVIDER_HANDLE L"ProviderHandle" +#define BCRYPT_CHAINING_MODE L"ChainingMode" +#define BCRYPT_BLOCK_LENGTH L"BlockLength" +#define BCRYPT_KEY_LENGTH L"KeyLength" +#define BCRYPT_KEY_OBJECT_LENGTH L"KeyObjectLength" +#define BCRYPT_KEY_STRENGTH L"KeyStrength" +#define BCRYPT_KEY_LENGTHS L"KeyLengths" +#define BCRYPT_BLOCK_SIZE_LIST L"BlockSizeList" +#define BCRYPT_EFFECTIVE_KEY_LENGTH L"EffectiveKeyLength" +#define BCRYPT_HASH_LENGTH L"HashDigestLength" +#define BCRYPT_HASH_OID_LIST L"HashOIDList" +#define BCRYPT_PADDING_SCHEMES L"PaddingSchemes" +#define BCRYPT_SIGNATURE_LENGTH L"SignatureLength" +#define BCRYPT_HASH_BLOCK_LENGTH L"HashBlockLength" +#define BCRYPT_AUTH_TAG_LENGTH L"AuthTagLength" + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define BCRYPT_FUNCTION_NAME_STRING L"FunctionNameString" +#define BCRYPT_CUSTOMIZATION_STRING L"CustomizationString" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define BCRYPT_PRIMITIVE_TYPE L"PrimitiveType" +#define BCRYPT_IS_KEYED_HASH L"IsKeyedHash" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_IS_REUSABLE_HASH L"IsReusableHash" +#define BCRYPT_MESSAGE_BLOCK_LENGTH L"MessageBlockLength" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_PUBLIC_KEY_LENGTH L"PublicKeyLength" +#endif + +// Additional BCryptGetProperty strings for the RNG Platform Crypto Provider +#define BCRYPT_PCP_PLATFORM_TYPE_PROPERTY L"PCP_PLATFORM_TYPE" +#define BCRYPT_PCP_PROVIDER_VERSION_PROPERTY L"PCP_PROVIDER_VERSION" + +#if (NTDDI_VERSION > NTDDI_WINBLUE || (NTDDI_VERSION == NTDDI_WINBLUE && defined(WINBLUE_KBSPRING14))) +#define BCRYPT_MULTI_OBJECT_LENGTH L"MultiObjectLength" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define BCRYPT_IS_IFX_TPM_WEAK_KEY L"IsIfxTpmWeakKey" + +// +// Additional properties for the HKDF on BCRYPT_KEY_HANDLE (and +// BCRYPT_SECRET_HANDLE). Both the hash algorithm property and +// one of the "Finalize" properties are required for the key +// (or secret) to be usable. +// +// When the available inputs are the input keying material (IKM) +// and the salt then the "SALT_AND_FINALIZE" path should be used: +// - First the function which creates the key (or secret) takes +// as input the IKM. +// - Then the hash algorithm should be set via the BCRYPT_HKDF_HASH_ALGORITHM +// property on BCryptSetProperty. +// - Finally the salt is input via the BCRYPT_HKDF_SALT_AND_FINALIZE +// property. The salt parameter is optional; thus the property input +// is allowed to be NULL. +// +// When the available input is the pseudorandom key (PRK) then +// the "PRK_AND_FINALIZE" path should be used: +// - First the function which creates the key (or secret) takes +// as input the PRK. +// - Then the hash algorithm should be set via the BCRYPT_HKDF_HASH_ALGORITHM +// property on BCryptSetProperty. +// - Finally the key (or secret) is finalized via the +// BCRYPT_HKDF_PRK_AND_FINALIZE property. In this case the input property +// must be NULL since the PRK was already passed in. +// +// After setting one of the two "Finalize" properties the key +// (or the secret) is finalized and can be used to derive the +// HKDF output. +// +#define BCRYPT_HKDF_HASH_ALGORITHM L"HkdfHashAlgorithm" +#define BCRYPT_HKDF_SALT_AND_FINALIZE L"HkdfSaltAndFinalize" +#define BCRYPT_HKDF_PRK_AND_FINALIZE L"HkdfPrkAndFinalize" + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_KEM_SHARED_SECRET_LENGTH L"KEMSharedSecretLength" +#define BCRYPT_KEM_CIPHERTEXT_LENGTH L"KEMCiphertextLength" +#define BCRYPT_PARAMETER_SET_NAME L"ParameterSetName" +#endif + +// BCryptSetProperty strings +#define BCRYPT_INITIALIZATION_VECTOR L"IV" + +// Property Strings +#define BCRYPT_CHAIN_MODE_NA L"ChainingModeN/A" +#define BCRYPT_CHAIN_MODE_CBC L"ChainingModeCBC" +#define BCRYPT_CHAIN_MODE_ECB L"ChainingModeECB" +#define BCRYPT_CHAIN_MODE_CFB L"ChainingModeCFB" +#define BCRYPT_CHAIN_MODE_CCM L"ChainingModeCCM" +#define BCRYPT_CHAIN_MODE_GCM L"ChainingModeGCM" + +// Supported RSA Padding Types +#define BCRYPT_SUPPORTED_PAD_ROUTER 0x00000001 +#define BCRYPT_SUPPORTED_PAD_PKCS1_ENC 0x00000002 +#define BCRYPT_SUPPORTED_PAD_PKCS1_SIG 0x00000004 +#define BCRYPT_SUPPORTED_PAD_OAEP 0x00000008 +#define BCRYPT_SUPPORTED_PAD_PSS 0x00000010 + +// +// BCrypt Flags +// + +#define BCRYPT_PROV_DISPATCH 0x00000001 // BCryptOpenAlgorithmProvider + +#define BCRYPT_BLOCK_PADDING 0x00000001 // BCryptEncrypt/Decrypt + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +#define BCRYPT_GENERATE_IV 0x00000020 // BCryptGenerateSymmetricKey BCryptEncrypt +#endif + +// RSA padding schemes +#define BCRYPT_PAD_NONE 0x00000001 +#define BCRYPT_PAD_PKCS1 0x00000002 // BCryptEncrypt/Decrypt BCryptSignHash/VerifySignature +#define BCRYPT_PAD_OAEP 0x00000004 // BCryptEncrypt/Decrypt +#define BCRYPT_PAD_PSS 0x00000008 // BCryptSignHash/VerifySignature +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +#define BCRYPT_PAD_PKCS1_OPTIONAL_HASH_OID 0x00000010 //BCryptVerifySignature +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_PAD_PQDSA 0x00000020 // BCryptSignHash/VerifySignature +#define BCRYPT_MLDSA_EXTERNAL_MU 0x00000040 // BCryptSignHash/VerifySignature +#endif + +#define BCRYPTBUFFER_VERSION 0 + +typedef struct _BCryptBuffer { + ULONG cbBuffer; // Length of buffer, in bytes + ULONG BufferType; // Buffer type + PVOID pvBuffer; // Pointer to buffer +} BCryptBuffer, * PBCryptBuffer; + +typedef struct _BCryptBufferDesc { + ULONG ulVersion; // Version number + ULONG cBuffers; // Number of buffers + PBCryptBuffer pBuffers; // Pointer to array of buffers +} BCryptBufferDesc, * PBCryptBufferDesc; + +// +// Primitive handles +// + +typedef PVOID BCRYPT_HANDLE; +typedef PVOID BCRYPT_ALG_HANDLE; +typedef PVOID BCRYPT_KEY_HANDLE; +typedef PVOID BCRYPT_HASH_HANDLE; +typedef PVOID BCRYPT_SECRET_HANDLE; + +// +// Structures used to represent key blobs. +// + +#define BCRYPT_PUBLIC_KEY_BLOB L"PUBLICBLOB" +#define BCRYPT_PRIVATE_KEY_BLOB L"PRIVATEBLOB" + +typedef struct _BCRYPT_KEY_BLOB +{ + ULONG Magic; +} BCRYPT_KEY_BLOB; + +// The BCRYPT_RSAPUBLIC_BLOB and BCRYPT_RSAPRIVATE_BLOB blob types are used +// to transport plaintext RSA keys. These blob types will be supported by +// all RSA primitive providers. +// The BCRYPT_RSAPRIVATE_BLOB includes the following values: +// Public Exponent +// Modulus +// Prime1 +// Prime2 + +#define BCRYPT_RSAPUBLIC_BLOB L"RSAPUBLICBLOB" +#define BCRYPT_RSAPRIVATE_BLOB L"RSAPRIVATEBLOB" +#define LEGACY_RSAPUBLIC_BLOB L"CAPIPUBLICBLOB" +#define LEGACY_RSAPRIVATE_BLOB L"CAPIPRIVATEBLOB" + +#define BCRYPT_RSAPUBLIC_MAGIC 0x31415352 // RSA1 +#define BCRYPT_RSAPRIVATE_MAGIC 0x32415352 // RSA2 + +typedef struct _BCRYPT_RSAKEY_BLOB +{ + ULONG Magic; + ULONG BitLength; + ULONG cbPublicExp; + ULONG cbModulus; + ULONG cbPrime1; + ULONG cbPrime2; +} BCRYPT_RSAKEY_BLOB; + +// The BCRYPT_RSAFULLPRIVATE_BLOB blob type is used to transport +// plaintext private RSA keys. It includes the following values: +// Public Exponent +// Modulus +// Prime1 +// Prime2 +// Private Exponent mod (Prime1 - 1) +// Private Exponent mod (Prime2 - 1) +// Inverse of Prime2 mod Prime1 +// PrivateExponent +#define BCRYPT_RSAFULLPRIVATE_BLOB L"RSAFULLPRIVATEBLOB" + +#define BCRYPT_RSAFULLPRIVATE_MAGIC 0x33415352 // RSA3 + +//Properties of secret agreement algorithms +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_GLOBAL_PARAMETERS L"SecretAgreementParam" +#define BCRYPT_PRIVATE_KEY L"PrivKeyVal" +#endif + +// The BCRYPT_ECCPUBLIC_BLOB and BCRYPT_ECCPRIVATE_BLOB blob types are used +// to transport plaintext ECC keys. These blob types will be supported by +// all ECC primitive providers. +#define BCRYPT_ECCPUBLIC_BLOB L"ECCPUBLICBLOB" +#define BCRYPT_ECCPRIVATE_BLOB L"ECCPRIVATEBLOB" + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_ECCFULLPUBLIC_BLOB L"ECCFULLPUBLICBLOB" +#define BCRYPT_ECCFULLPRIVATE_BLOB L"ECCFULLPRIVATEBLOB" +#define SSL_ECCPUBLIC_BLOB L"SSLECCPUBLICBLOB" +#endif +#define TLS_13_PRE_SHARED_KEY L"TLS13PRESHAREDKEY" + +#define BCRYPT_ECDH_PUBLIC_P256_MAGIC 0x314B4345 // ECK1 +#define BCRYPT_ECDH_PRIVATE_P256_MAGIC 0x324B4345 // ECK2 +#define BCRYPT_ECDH_PUBLIC_P384_MAGIC 0x334B4345 // ECK3 +#define BCRYPT_ECDH_PRIVATE_P384_MAGIC 0x344B4345 // ECK4 +#define BCRYPT_ECDH_PUBLIC_P521_MAGIC 0x354B4345 // ECK5 +#define BCRYPT_ECDH_PRIVATE_P521_MAGIC 0x364B4345 // ECK6 + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_ECDH_PUBLIC_GENERIC_MAGIC 0x504B4345 // ECKP +#define BCRYPT_ECDH_PRIVATE_GENERIC_MAGIC 0x564B4345 // ECKV +#endif + +#define BCRYPT_ECDSA_PUBLIC_P256_MAGIC 0x31534345 // ECS1 +#define BCRYPT_ECDSA_PRIVATE_P256_MAGIC 0x32534345 // ECS2 +#define BCRYPT_ECDSA_PUBLIC_P384_MAGIC 0x33534345 // ECS3 +#define BCRYPT_ECDSA_PRIVATE_P384_MAGIC 0x34534345 // ECS4 +#define BCRYPT_ECDSA_PUBLIC_P521_MAGIC 0x35534345 // ECS5 +#define BCRYPT_ECDSA_PRIVATE_P521_MAGIC 0x36534345 // ECS6 + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_ECDSA_PUBLIC_GENERIC_MAGIC 0x50444345 // ECDP +#define BCRYPT_ECDSA_PRIVATE_GENERIC_MAGIC 0x56444345 // ECDV +#endif + +typedef struct _BCRYPT_ECCKEY_BLOB +{ + ULONG dwMagic; + ULONG cbKey; +} BCRYPT_ECCKEY_BLOB, *PBCRYPT_ECCKEY_BLOB; + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +//SSL ECC Public Blob Version +typedef struct _SSL_ECCKEY_BLOB +{ + ULONG dwCurveType; + ULONG cbKey; +} SSL_ECCKEY_BLOB, *PSSL_ECCKEY_BLOB; + +//ECC Full versions +#define BCRYPT_ECC_FULLKEY_BLOB_V1 0x1 + +typedef enum +{ + BCRYPT_ECC_PRIME_SHORT_WEIERSTRASS_CURVE = 0x1, + BCRYPT_ECC_PRIME_TWISTED_EDWARDS_CURVE = 0x2, + BCRYPT_ECC_PRIME_MONTGOMERY_CURVE = 0x3 +} ECC_CURVE_TYPE_ENUM; + +typedef enum +{ + BCRYPT_NO_CURVE_GENERATION_ALG_ID = 0x0 +} ECC_CURVE_ALG_ID_ENUM; + +//The full version contains the curve parameters as well +//as the public and potentially private exponent. +typedef struct _BCRYPT_ECCFULLKEY_BLOB +{ + ULONG dwMagic; + ULONG dwVersion; //Version of the structure + ECC_CURVE_TYPE_ENUM dwCurveType; //Supported curve types. + ECC_CURVE_ALG_ID_ENUM dwCurveGenerationAlgId; //For X.592 verification purposes, if we include Seed we will need to include the algorithm ID. + ULONG cbFieldLength; //Byte length of the fields P, A, B, X, Y. + ULONG cbSubgroupOrder; //Byte length of the subgroup. + ULONG cbCofactor; //Byte length of cofactor of G in E. + ULONG cbSeed; //Byte length of the seed used to generate the curve. + //P[cbFieldLength] Prime specifying the base field. + //A[cbFieldLength] Coefficient A of the equation y^2 = x^3 + A*x + B mod p + //B[cbFieldLength] Coefficient B of the equation y^2 = x^3 + A*x + B mod p + //Gx[cbFieldLength] X-coordinate of the base point. + //Gy[cbFieldLength] Y-coordinate of the base point. + //n[cbSubgroupOrder] Order of the group generated by G = (x,y) + //h[cbCofactor] Cofactor of G in E. + //S[cbSeed] Seed of the curve. + //Qx[cbFieldLength] X-coordinate of the public point. + //Qy[cbFieldLength] Y-coordinate of the public point. + //d[cbSubgroupOrder] Private key. Not always present. +} BCRYPT_ECCFULLKEY_BLOB, *PBCRYPT_ECCFULLKEY_BLOB; +#endif + +// The BCRYPT_DH_PUBLIC_BLOB and BCRYPT_DH_PRIVATE_BLOB blob types are used +// to transport plaintext DH keys. These blob types will be supported by +// all DH primitive providers. +#define BCRYPT_DH_PUBLIC_BLOB L"DHPUBLICBLOB" +#define BCRYPT_DH_PRIVATE_BLOB L"DHPRIVATEBLOB" +#define LEGACY_DH_PUBLIC_BLOB L"CAPIDHPUBLICBLOB" +#define LEGACY_DH_PRIVATE_BLOB L"CAPIDHPRIVATEBLOB" + +#define BCRYPT_DH_PUBLIC_MAGIC 0x42504844 // DHPB +#define BCRYPT_DH_PRIVATE_MAGIC 0x56504844 // DHPV + +typedef struct _BCRYPT_DH_KEY_BLOB +{ + ULONG dwMagic; + ULONG cbKey; +} BCRYPT_DH_KEY_BLOB, *PBCRYPT_DH_KEY_BLOB; + +// Property Strings for DH +#define BCRYPT_DH_PARAMETERS L"DHParameters" + +#define BCRYPT_DH_PARAMETERS_MAGIC 0x4d504844 // DHPM + +typedef _Struct_size_bytes_(cbLength) struct _BCRYPT_DH_PARAMETER_HEADER +{ + ULONG cbLength; + ULONG dwMagic; + ULONG cbKeyLength; +} BCRYPT_DH_PARAMETER_HEADER; + + +// The BCRYPT_DSA_PUBLIC_BLOB and BCRYPT_DSA_PRIVATE_BLOB blob types are used +// to transport plaintext DSA keys. These blob types will be supported by +// all DSA primitive providers. +#define BCRYPT_DSA_PUBLIC_BLOB L"DSAPUBLICBLOB" +#define BCRYPT_DSA_PRIVATE_BLOB L"DSAPRIVATEBLOB" +#define LEGACY_DSA_PUBLIC_BLOB L"CAPIDSAPUBLICBLOB" +#define LEGACY_DSA_PRIVATE_BLOB L"CAPIDSAPRIVATEBLOB" +#define LEGACY_DSA_V2_PUBLIC_BLOB L"V2CAPIDSAPUBLICBLOB" +#define LEGACY_DSA_V2_PRIVATE_BLOB L"V2CAPIDSAPRIVATEBLOB" + +#define BCRYPT_DSA_PUBLIC_MAGIC 0x42505344 // DSPB +#define BCRYPT_DSA_PRIVATE_MAGIC 0x56505344 // DSPV + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_DSA_PUBLIC_MAGIC_V2 0x32425044 // DPB2 +#define BCRYPT_DSA_PRIVATE_MAGIC_V2 0x32565044 // DPV2 +#endif + +typedef struct _BCRYPT_DSA_KEY_BLOB +{ + ULONG dwMagic; + ULONG cbKey; + UCHAR Count[4]; + UCHAR Seed[20]; + UCHAR q[20]; +} BCRYPT_DSA_KEY_BLOB, *PBCRYPT_DSA_KEY_BLOB; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef enum +{ + DSA_HASH_ALGORITHM_SHA1, + DSA_HASH_ALGORITHM_SHA256, + DSA_HASH_ALGORITHM_SHA512 +} HASHALGORITHM_ENUM; + +typedef enum +{ + DSA_FIPS186_2, + DSA_FIPS186_3 +} DSAFIPSVERSION_ENUM; + +typedef struct _BCRYPT_DSA_KEY_BLOB_V2 +{ + ULONG dwMagic; + ULONG cbKey; + HASHALGORITHM_ENUM hashAlgorithm; + DSAFIPSVERSION_ENUM standardVersion; + ULONG cbSeedLength; + ULONG cbGroupSize; + UCHAR Count[4]; +} BCRYPT_DSA_KEY_BLOB_V2, *PBCRYPT_DSA_KEY_BLOB_V2; +#endif + +typedef struct _BCRYPT_KEY_DATA_BLOB_HEADER +{ + ULONG dwMagic; + ULONG dwVersion; + ULONG cbKeyData; +} BCRYPT_KEY_DATA_BLOB_HEADER, *PBCRYPT_KEY_DATA_BLOB_HEADER; + +#define BCRYPT_KEY_DATA_BLOB_MAGIC 0x4d42444b //Key Data Blob Magic (KDBM) + +#define BCRYPT_KEY_DATA_BLOB_VERSION1 0x1 + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_MLDSA_PUBLIC_MAGIC 0x4B505344 // DSPK +#define BCRYPT_MLDSA_PRIVATE_MAGIC 0x4B535344 // DSSK +#define BCRYPT_MLDSA_PRIVATE_SEED_MAGIC 0x53535344 // DSSS + +#define BCRYPT_SLHDSA_PUBLIC_MAGIC 0x4B504853 // SHPK +#define BCRYPT_SLHDSA_PRIVATE_MAGIC 0x4B534853 // SHSK + +#define BCRYPT_LMS_PUBLIC_MAGIC 0x4B504D4C // LMPK +#define BCRYPT_XMSS_PUBLIC_MAGIC 0x4B504D58 // XMPK + +#define BCRYPT_PQDSA_PUBLIC_BLOB L"PQDSAPUBLICBLOB" +#define BCRYPT_PQDSA_PRIVATE_BLOB L"PQDSAPRIVATEBLOB" +#define BCRYPT_PQDSA_PRIVATE_SEED_BLOB L"PQDSAPRIVATESEEDBLOB" + +typedef struct BCRYPT_PQDSA_KEY_BLOB { + ULONG dwMagic; + ULONG cbParameterSet; // Byte size of parameterSet[] + ULONG cbKey; // Byte size of key[] + // WCHAR parameterSet[cbParameterSet / sizeof(WCHAR)]; // For ML-DSA and SLH-DSA, \0-terminated + // BYTE key[cbKey]; // Key material +} BCRYPT_PQDSA_KEY_BLOB, *PBCRYPT_PQDSA_KEY_BLOB; + +#define BCRYPT_MLKEM_PUBLIC_MAGIC 0x504B4C4D // MLKP +#define BCRYPT_MLKEM_PRIVATE_MAGIC 0x524B4C4D // MLKR +#define BCRYPT_MLKEM_PRIVATE_SEED_MAGIC 0x534B4C4D // MLKS + +#define BCRYPT_MLKEM_PUBLIC_BLOB L"MLKEMPUBLICBLOB" +#define BCRYPT_MLKEM_PRIVATE_BLOB L"MLKEMPRIVATEBLOB" +#define BCRYPT_MLKEM_PRIVATE_SEED_BLOB L"MLKEMPRIVATESEEDBLOB" +#define BCRYPT_MLKEM_ENCAPSULATION_BLOB BCRYPT_MLKEM_PUBLIC_BLOB +#define BCRYPT_MLKEM_DECAPSULATION_BLOB BCRYPT_MLKEM_PRIVATE_BLOB + +typedef struct BCRYPT_MLKEM_KEY_BLOB +{ + ULONG dwMagic; + ULONG cbParameterSet; // Byte size of parameterSet[] + ULONG cbKey; // Byte size of key[] + // WCHAR parameterSet[cbParameterSet / sizeof(WCHAR)]; // For ML-KEM, \0-terminated + // BYTE key[cbKey]; // Key material +} BCRYPT_MLKEM_KEY_BLOB, *PBCRYPT_MLKEM_KEY_BLOB; +#endif + +// Property Strings for DSA +#define BCRYPT_DSA_PARAMETERS L"DSAParameters" + +#define BCRYPT_DSA_PARAMETERS_MAGIC 0x4d505344 // DSPM + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_DSA_PARAMETERS_MAGIC_V2 0x324d5044 // DPM2 +#endif + +typedef struct _BCRYPT_DSA_PARAMETER_HEADER +{ + ULONG cbLength; + ULONG dwMagic; + ULONG cbKeyLength; + UCHAR Count[4]; + UCHAR Seed[20]; + UCHAR q[20]; +} BCRYPT_DSA_PARAMETER_HEADER; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct _BCRYPT_DSA_PARAMETER_HEADER_V2 +{ + ULONG cbLength; + ULONG dwMagic; + ULONG cbKeyLength; + HASHALGORITHM_ENUM hashAlgorithm; + DSAFIPSVERSION_ENUM standardVersion; + ULONG cbSeedLength; + ULONG cbGroupSize; + UCHAR Count[4]; +} BCRYPT_DSA_PARAMETER_HEADER_V2; +#endif + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +//Property Strings for ECC +#define BCRYPT_ECC_PARAMETERS L"ECCParameters" +#define BCRYPT_ECC_CURVE_NAME L"ECCCurveName" +#define BCRYPT_ECC_CURVE_NAME_LIST L"ECCCurveNameList" + +#define BCRYPT_ECC_PARAMETERS_MAGIC 0x50434345 // ECCP + +typedef struct _BCRYPT_ECC_CURVE_NAMES +{ + ULONG dwEccCurveNames; + LPWSTR *pEccCurveNames; +} BCRYPT_ECC_CURVE_NAMES; + +// +// ECC Curve Names +// +#define BCRYPT_ECC_CURVE_BRAINPOOLP160R1 L"brainpoolP160r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP160T1 L"brainpoolP160t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP192R1 L"brainpoolP192r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP192T1 L"brainpoolP192t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP224R1 L"brainpoolP224r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP224T1 L"brainpoolP224t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP256R1 L"brainpoolP256r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP256T1 L"brainpoolP256t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP320R1 L"brainpoolP320r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP320T1 L"brainpoolP320t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP384R1 L"brainpoolP384r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP384T1 L"brainpoolP384t1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP512R1 L"brainpoolP512r1" +#define BCRYPT_ECC_CURVE_BRAINPOOLP512T1 L"brainpoolP512t1" + +#define BCRYPT_ECC_CURVE_25519 L"curve25519" + +#define BCRYPT_ECC_CURVE_EC192WAPI L"ec192wapi" + +#define BCRYPT_ECC_CURVE_NISTP192 L"nistP192" +#define BCRYPT_ECC_CURVE_NISTP224 L"nistP224" +#define BCRYPT_ECC_CURVE_NISTP256 L"nistP256" +#define BCRYPT_ECC_CURVE_NISTP384 L"nistP384" +#define BCRYPT_ECC_CURVE_NISTP521 L"nistP521" + +#define BCRYPT_ECC_CURVE_NUMSP256T1 L"numsP256t1" +#define BCRYPT_ECC_CURVE_NUMSP384T1 L"numsP384t1" +#define BCRYPT_ECC_CURVE_NUMSP512T1 L"numsP512t1" + +#define BCRYPT_ECC_CURVE_SECP160K1 L"secP160k1" +#define BCRYPT_ECC_CURVE_SECP160R1 L"secP160r1" +#define BCRYPT_ECC_CURVE_SECP160R2 L"secP160r2" +#define BCRYPT_ECC_CURVE_SECP192K1 L"secP192k1" +#define BCRYPT_ECC_CURVE_SECP192R1 L"secP192r1" +#define BCRYPT_ECC_CURVE_SECP224K1 L"secP224k1" +#define BCRYPT_ECC_CURVE_SECP224R1 L"secP224r1" +#define BCRYPT_ECC_CURVE_SECP256K1 L"secP256k1" +#define BCRYPT_ECC_CURVE_SECP256R1 L"secP256r1" +#define BCRYPT_ECC_CURVE_SECP384R1 L"secP384r1" +#define BCRYPT_ECC_CURVE_SECP521R1 L"secP521r1" + +#define BCRYPT_ECC_CURVE_WTLS7 L"wtls7" +#define BCRYPT_ECC_CURVE_WTLS9 L"wtls9" +#define BCRYPT_ECC_CURVE_WTLS12 L"wtls12" + +#define BCRYPT_ECC_CURVE_X962P192V1 L"x962P192v1" +#define BCRYPT_ECC_CURVE_X962P192V2 L"x962P192v2" +#define BCRYPT_ECC_CURVE_X962P192V3 L"x962P192v3" +#define BCRYPT_ECC_CURVE_X962P239V1 L"x962P239v1" +#define BCRYPT_ECC_CURVE_X962P239V2 L"x962P239v2" +#define BCRYPT_ECC_CURVE_X962P239V3 L"x962P239v3" +#define BCRYPT_ECC_CURVE_X962P256V1 L"x962P256v1" + +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +// +// PQDSA property values for BCRYPT_PARAMETER_SET_NAME +// +#define BCRYPT_MLDSA_PARAMETER_SET_44 L"44" +#define BCRYPT_MLDSA_PARAMETER_SET_65 L"65" +#define BCRYPT_MLDSA_PARAMETER_SET_87 L"87" + +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_128S L"SHA2-128s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_128S L"SHAKE-128s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_128F L"SHA2-128f" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_128F L"SHAKE-128f" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_192S L"SHA2-192s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_192S L"SHAKE-192s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_192F L"SHA2-192f" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_192F L"SHAKE-192f" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_256S L"SHA2-256s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_256S L"SHAKE-256s" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHA2_256F L"SHA2-256f" +#define BCRYPT_SLHDSA_PARAMETER_SET_SHAKE_256F L"SHAKE-256f" + +// +// MLKEM property values for BCRYPT_PARAMETER_SET_NAME +// +#define BCRYPT_MLKEM_PARAMETER_SET_512 L"512" +#define BCRYPT_MLKEM_PARAMETER_SET_768 L"768" +#define BCRYPT_MLKEM_PARAMETER_SET_1024 L"1024" + +#endif + + +// Operation types used in BCRYPT_MULTI_HASH_OPERATION structures +typedef enum { + BCRYPT_HASH_OPERATION_HASH_DATA = 1, + BCRYPT_HASH_OPERATION_FINISH_HASH = 2, +} BCRYPT_HASH_OPERATION_TYPE; + +typedef struct _BCRYPT_MULTI_HASH_OPERATION { + ULONG iHash; // index of hash object + BCRYPT_HASH_OPERATION_TYPE hashOperation; // operation to be performed + _Field_size_(cbBuffer) PUCHAR pbBuffer; // data to be hashed, or result buffer + ULONG cbBuffer; +} BCRYPT_MULTI_HASH_OPERATION; + +// Enum to specify type of multi-operation is passed to BCryptProcesMultiOperations +typedef enum{ + BCRYPT_OPERATION_TYPE_HASH = 1, // structure type is BCRYPT_MULTI_HASH_OPERATION +} BCRYPT_MULTI_OPERATION_TYPE; + +typedef struct _BCRYPT_MULTI_OBJECT_LENGTH_STRUCT +{ + ULONG cbPerObject; + ULONG cbPerElement; // required size for N elements is (cbPerObject + N * cbPerElement) +} BCRYPT_MULTI_OBJECT_LENGTH_STRUCT; + +// +// Microsoft built-in providers. +// + +#define MS_PRIMITIVE_PROVIDER L"Microsoft Primitive Provider" +#define MS_PLATFORM_CRYPTO_PROVIDER L"Microsoft Platform Crypto Provider" + +// +// Common algorithm identifiers. +// + +#define BCRYPT_RSA_ALGORITHM L"RSA" +#define BCRYPT_RSA_SIGN_ALGORITHM L"RSA_SIGN" +#define BCRYPT_DH_ALGORITHM L"DH" +#define BCRYPT_DSA_ALGORITHM L"DSA" +#define BCRYPT_RC2_ALGORITHM L"RC2" +#define BCRYPT_RC4_ALGORITHM L"RC4" +#define BCRYPT_AES_ALGORITHM L"AES" +#define BCRYPT_DES_ALGORITHM L"DES" +#define BCRYPT_DESX_ALGORITHM L"DESX" +#define BCRYPT_3DES_ALGORITHM L"3DES" +#define BCRYPT_3DES_112_ALGORITHM L"3DES_112" +#define BCRYPT_MD2_ALGORITHM L"MD2" +#define BCRYPT_MD4_ALGORITHM L"MD4" +#define BCRYPT_MD5_ALGORITHM L"MD5" +#define BCRYPT_SHA1_ALGORITHM L"SHA1" +#define BCRYPT_SHA256_ALGORITHM L"SHA256" +#define BCRYPT_SHA384_ALGORITHM L"SHA384" +#define BCRYPT_SHA512_ALGORITHM L"SHA512" +#define BCRYPT_AES_GMAC_ALGORITHM L"AES-GMAC" +#define BCRYPT_AES_CMAC_ALGORITHM L"AES-CMAC" +#define BCRYPT_ECDSA_P256_ALGORITHM L"ECDSA_P256" +#define BCRYPT_ECDSA_P384_ALGORITHM L"ECDSA_P384" +#define BCRYPT_ECDSA_P521_ALGORITHM L"ECDSA_P521" +#define BCRYPT_ECDH_P256_ALGORITHM L"ECDH_P256" +#define BCRYPT_ECDH_P384_ALGORITHM L"ECDH_P384" +#define BCRYPT_ECDH_P521_ALGORITHM L"ECDH_P521" +#define BCRYPT_RNG_ALGORITHM L"RNG" +#define BCRYPT_RNG_FIPS186_DSA_ALGORITHM L"FIPS186DSARNG" +#define BCRYPT_RNG_DUAL_EC_ALGORITHM L"DUALECRNG" + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_SP800108_CTR_HMAC_ALGORITHM L"SP800_108_CTR_HMAC" +#define BCRYPT_SP80056A_CONCAT_ALGORITHM L"SP800_56A_CONCAT" +#define BCRYPT_PBKDF2_ALGORITHM L"PBKDF2" +#define BCRYPT_CAPI_KDF_ALGORITHM L"CAPI_KDF" +#define BCRYPT_TLS1_1_KDF_ALGORITHM L"TLS1_1_KDF" +#define BCRYPT_TLS1_2_KDF_ALGORITHM L"TLS1_2_KDF" +#endif + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_ECDSA_ALGORITHM L"ECDSA" +#define BCRYPT_ECDH_ALGORITHM L"ECDH" +#define BCRYPT_XTS_AES_ALGORITHM L"XTS-AES" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define BCRYPT_HKDF_ALGORITHM L"HKDF" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) +#define BCRYPT_CHACHA20_POLY1305_ALGORITHM L"CHACHA20_POLY1305" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define BCRYPT_SHA3_256_ALGORITHM L"SHA3-256" +#define BCRYPT_SHA3_384_ALGORITHM L"SHA3-384" +#define BCRYPT_SHA3_512_ALGORITHM L"SHA3-512" +#define BCRYPT_CSHAKE128_ALGORITHM L"CSHAKE128" +#define BCRYPT_CSHAKE256_ALGORITHM L"CSHAKE256" +#define BCRYPT_KMAC128_ALGORITHM L"KMAC128" +#define BCRYPT_KMAC256_ALGORITHM L"KMAC256" +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_SHAKE128_ALGORITHM L"SHAKE128" +#define BCRYPT_SHAKE256_ALGORITHM L"SHAKE256" + +#define BCRYPT_MLDSA_ALGORITHM L"ML-DSA" +#define BCRYPT_SLHDSA_ALGORITHM L"SLH-DSA" + +#define BCRYPT_LMS_ALGORITHM L"LMS" +#define BCRYPT_XMSS_ALGORITHM L"XMSS" + +#define BCRYPT_MLKEM_ALGORITHM L"ML-KEM" +#endif + +// +// Interfaces +// + +#define BCRYPT_CIPHER_INTERFACE 0x00000001 +#define BCRYPT_HASH_INTERFACE 0x00000002 +#define BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE 0x00000003 +#define BCRYPT_SECRET_AGREEMENT_INTERFACE 0x00000004 +#define BCRYPT_SIGNATURE_INTERFACE 0x00000005 +#define BCRYPT_RNG_INTERFACE 0x00000006 + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_KEY_DERIVATION_INTERFACE 0x00000007 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_KEY_ENCAPSULATION_INTERFACE 0x00000008 +#endif + + +// +// Algorithm pseudo-handles +// Pseudo-handles are distinguished from normal handles by being 1 mod 16 +// +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_MD2_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000001) +#define BCRYPT_MD4_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000011) +#define BCRYPT_MD5_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000021) +#define BCRYPT_SHA1_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000031) +#define BCRYPT_SHA256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000041) +#define BCRYPT_SHA384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000051) +#define BCRYPT_SHA512_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000061) +#define BCRYPT_RC4_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000071) +#define BCRYPT_RNG_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000081) +#define BCRYPT_HMAC_MD5_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000091) +#define BCRYPT_HMAC_SHA1_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000a1) +#define BCRYPT_HMAC_SHA256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000b1) +#define BCRYPT_HMAC_SHA384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000c1) +#define BCRYPT_HMAC_SHA512_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000d1) +#define BCRYPT_RSA_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000e1) +#define BCRYPT_ECDSA_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000000f1) + +#define BCRYPT_AES_CMAC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000101) +#define BCRYPT_AES_GMAC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000111) +#define BCRYPT_HMAC_MD2_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000121) +#define BCRYPT_HMAC_MD4_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000131) + +#define BCRYPT_3DES_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000141) +#define BCRYPT_3DES_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000151) +#define BCRYPT_3DES_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000161) +#define BCRYPT_3DES_112_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000171) +#define BCRYPT_3DES_112_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000181) +#define BCRYPT_3DES_112_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000191) +#define BCRYPT_AES_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001a1) +#define BCRYPT_AES_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001b1) +#define BCRYPT_AES_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001c1) +#define BCRYPT_AES_CCM_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001d1) +#define BCRYPT_AES_GCM_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001e1) +#define BCRYPT_DES_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000001f1) +#define BCRYPT_DES_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000201) +#define BCRYPT_DES_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000211) +#define BCRYPT_DESX_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000221) +#define BCRYPT_DESX_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000231) +#define BCRYPT_DESX_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000241) +#define BCRYPT_RC2_CBC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000251) +#define BCRYPT_RC2_ECB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000261) +#define BCRYPT_RC2_CFB_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000271) + +#define BCRYPT_DH_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000281) +#define BCRYPT_ECDH_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000291) +#define BCRYPT_ECDH_P256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002a1) +#define BCRYPT_ECDH_P384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002b1) +#define BCRYPT_ECDH_P521_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002c1) +#define BCRYPT_DSA_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002d1) +#define BCRYPT_ECDSA_P256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002e1) +#define BCRYPT_ECDSA_P384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000002f1) +#define BCRYPT_ECDSA_P521_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000301) +#define BCRYPT_RSA_SIGN_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000311) + +#define BCRYPT_CAPI_KDF_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000321) +#define BCRYPT_PBKDF2_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000331) + +#define BCRYPT_SP800108_CTR_HMAC_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000341) +#define BCRYPT_SP80056A_CONCAT_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000351) + +#define BCRYPT_TLS1_1_KDF_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000361) +#define BCRYPT_TLS1_2_KDF_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000371) + +#define BCRYPT_XTS_AES_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000381) + +#define BCRYPT_HKDF_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000391) + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) +#define BCRYPT_CHACHA20_POLY1305_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003A1) +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define BCRYPT_SHA3_256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003B1) +#define BCRYPT_SHA3_384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003C1) +#define BCRYPT_SHA3_512_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003D1) +#define BCRYPT_HMAC_SHA3_256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003E1) +#define BCRYPT_HMAC_SHA3_384_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x000003F1) +#define BCRYPT_HMAC_SHA3_512_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000401) +#define BCRYPT_CSHAKE128_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000411) +#define BCRYPT_CSHAKE256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000421) +#define BCRYPT_KMAC128_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000431) +#define BCRYPT_KMAC256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000441) +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_SHAKE128_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000451) +#define BCRYPT_SHAKE256_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000461) + +#define BCRYPT_MLDSA_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000471) + +#define BCRYPT_MLKEM_ALG_HANDLE ((BCRYPT_ALG_HANDLE) 0x00000481) + +#endif + +// +// Primitive algorithm provider functions. +// + +#define BCRYPT_ALG_HANDLE_HMAC_FLAG 0x00000008 +#define BCRYPT_HASH_REUSABLE_FLAG 0x00000020 + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_CAPI_AES_FLAG 0x00000010 +#endif + +#if (NTDDI_VERSION > NTDDI_WINBLUE || (NTDDI_VERSION == NTDDI_WINBLUE && defined(WINBLUE_KBSPRING14))) +#define BCRYPT_MULTI_FLAG 0x00000040 +#endif + +// +// Extendable-output functions (XOFs) allow generating output multiple times from their +// state. BCRYPT_HASH_DONT_RESET_FLAG allows to override the default behavior of BCryptFinishHash, +// which is to reset the hash state. If this flag is set, the hash state is not reset and +// users may invoke BCryptFinishHash to generate more data out of the hash/XOF state, until +// after a BCryptFinishHash call where this flag is unset. +// +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define BCRYPT_HASH_DONT_RESET_FLAG 0x00000001 +#endif + +// +// The TLS_CBC_HMAC_VERIFY flag provides a side-channel safe way of verifying TLS data records +// from the CBC-HMAC cipher suites. See RFC 5246 section 6.2.3.2. +// This flag is used in BCryptOpenAlgorithmProvider and in BCryptHashData. +// For BCryptOpenAlgorithmProvider it ensures that you get a provider that supports this feature. +// For BCryptHashData is changes the functionality. +// The Input buffer now contains the whole TLS data record, consisting of the plaintext, +// followed by the MAC value, followed by the padding, followed by the padding_length. +// The function will compute the HMAC over the data already hashed plus the plaintext, +// compare it to the MAC value, and verify that the padding is correct. +// If all works out, it returns a success value; if anything fails it returns an error. +// What makes this special is that the code path or the memory access pattern used to +// do this verification does not depend on padding_length to stop attacks on the CBC encryption +// that was used to decrypt this data. +// This flag is only useful for TLS implementations, other callers should not use it. +// This flag is only valid for HMAC-SHA1, HMAC-SHA256, and HMAC-SHA384. +// This flag implies the BCRYPT_HASH_REUSABLE_FLAG. +// +// This flag is available staring in Windows 10 19H1, but we define it for all +// NTDDI values to allow applications to dynamically test wethere the OS supports the +// feature, and adjust accordingly. +// +#define BCRYPT_TLS_CBC_HMAC_VERIFY_FLAG 0x00000004 + +// +// The BUFFERS_LOCKED flag used in BCryptEncrypt/BCryptDecrypt signals that +// the pbInput and pbOutput buffers have been locked (see MmProbeAndLockPages) +// and CNG may not lock the buffers again. +// This flag applies only to kernel mode, it is ignored in user mode. +// +#define BCRYPT_BUFFERS_LOCKED_FLAG 0x00000040 + +// +// The EXTENDED_KEYSIZE flag extends the supported set of key sizes. +// +// The original design has a per-algorithm maximum key size, and +// BCryptGenerateSymmetricKey truncates any longer input to the maximum key size for that +// algorithm. Some callers depend on this feature and pass in large buffers. +// This makes it impossible to silently extend the supported key size without breaking +// backward compatibility. +// This flag indicates that the extended key size support is requested. +// It has the following consequences: +// - BCryptGetProperty will report a new maximum key size for BCRYPT_KEY_LENGTHS. +// - BCryptGenerateSymmetricKey will support the longer key sizes. +// - BCryptGenerateSymmetricKey will no longer truncate keys that are too long, but return an error instead. +// +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +#define BCRYPT_EXTENDED_KEYSIZE 0x00000080 +#endif + +// +// ENABLE_INCOMPATIBLE_FIPS_CHECKS flag enables some FIPS 140-2-mandated checks that are incompatible +// with the original algorithm. +// +// Starting in Redstone 1 (summer 2016 release of Win10) this flag has the following effect on the +// Microsoft default algorithm provider. +// - BCryptGenerateSymmetricKey when generating an XTS-AES key with this flag specified and FIPS mode enabled +// will verify that the two halves of the key are not identical. If they are, an error is returned. +// This is actually incompatible with the NIST SP 800-38E and IEEE Std 1619-2007 definitions +// of XTS-AES. Rather than change the standard, NIST added this requirement in the FIPS 140-2 +// implementation guidance. +// This check breaks existing usage of the algorithm, which is why we only perform the check when the +// caller explicitly asks for it. +// Use of this flag for any algorithm other than XTS-AES generates an error. +// Note that this flag is not supported for BCryptImportKey. +// +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define BCRYPT_ENABLE_INCOMPATIBLE_FIPS_CHECKS 0x00000100 +#endif + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptOpenAlgorithmProvider( + _Out_ BCRYPT_ALG_HANDLE *phAlgorithm, + _In_z_ LPCWSTR pszAlgId, + _In_opt_z_ LPCWSTR pszImplementation, + _In_ ULONG dwFlags); + + + +// AlgOperations flags for use with BCryptEnumAlgorithms() +#define BCRYPT_CIPHER_OPERATION 0x00000001 +#define BCRYPT_HASH_OPERATION 0x00000002 +#define BCRYPT_ASYMMETRIC_ENCRYPTION_OPERATION 0x00000004 +#define BCRYPT_SECRET_AGREEMENT_OPERATION 0x00000008 +#define BCRYPT_SIGNATURE_OPERATION 0x00000010 +#define BCRYPT_RNG_OPERATION 0x00000020 + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define BCRYPT_KEY_DERIVATION_OPERATION 0x00000040 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define BCRYPT_KEY_ENCAPSULATION_OPERATION 0x00000080 +#endif + +// USE EXTREME CAUTION: editing comments that contain "certenrolls_*" tokens +// could break building CertEnroll idl files: +// certenrolls_begin -- BCRYPT_ALGORITHM_IDENTIFIER +typedef struct _BCRYPT_ALGORITHM_IDENTIFIER +{ + LPWSTR pszName; + ULONG dwClass; + ULONG dwFlags; + +} BCRYPT_ALGORITHM_IDENTIFIER; +// certenrolls_end + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumAlgorithms( + _In_ ULONG dwAlgOperations, + _Out_ ULONG *pAlgCount, + _Out_ BCRYPT_ALGORITHM_IDENTIFIER **ppAlgList, + _In_ ULONG dwFlags); + +typedef struct _BCRYPT_PROVIDER_NAME +{ + LPWSTR pszProviderName; +} BCRYPT_PROVIDER_NAME; + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumProviders( + _In_z_ LPCWSTR pszAlgId, + _Out_ ULONG *pImplCount, + _Out_ BCRYPT_PROVIDER_NAME **ppImplList, + _In_ ULONG dwFlags); + + +// Unused flags. Kept for backward compatibility. +// "Flags for use with BCryptGetProperty and BCryptSetProperty" +#define BCRYPT_PUBLIC_KEY_FLAG 0x00000001 +#define BCRYPT_PRIVATE_KEY_FLAG 0x00000002 + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptGetProperty( + _In_ BCRYPT_HANDLE hObject, + _In_z_ LPCWSTR pszProperty, + _Out_writes_bytes_to_opt_(cbOutput, *pcbResult) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptSetProperty( + _Inout_ BCRYPT_HANDLE hObject, + _In_z_ LPCWSTR pszProperty, + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_ ULONG dwFlags); + + +NTSTATUS +WINAPI +BCryptCloseAlgorithmProvider( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _In_ ULONG dwFlags); + + +VOID +WINAPI +BCryptFreeBuffer( + _In_ PVOID pvBuffer); + + +// +// Primitive encryption functions. +// +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptGenerateSymmetricKey( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _Out_ BCRYPT_KEY_HANDLE *phKey, + _Out_writes_bytes_all_opt_(cbKeyObject) PUCHAR pbKeyObject, + _In_ ULONG cbKeyObject, + _In_reads_bytes_(cbSecret) PUCHAR pbSecret, + _In_ ULONG cbSecret, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptGenerateKeyPair( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _Out_ BCRYPT_KEY_HANDLE *phKey, + _In_ ULONG dwLength, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEncrypt( + _Inout_ BCRYPT_KEY_HANDLE hKey, + _In_reads_bytes_opt_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_opt_ VOID *pPaddingInfo, + _Inout_updates_bytes_opt_(cbIV) PUCHAR pbIV, + _In_ ULONG cbIV, + _Out_writes_bytes_to_opt_(cbOutput, *pcbResult) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDecrypt( + _Inout_ BCRYPT_KEY_HANDLE hKey, + _In_reads_bytes_opt_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_opt_ VOID *pPaddingInfo, + _Inout_updates_bytes_opt_(cbIV) PUCHAR pbIV, + _In_ ULONG cbIV, + _Out_writes_bytes_to_opt_(cbOutput, *pcbResult) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptExportKey( + _In_ BCRYPT_KEY_HANDLE hKey, + _In_opt_ BCRYPT_KEY_HANDLE hExportKey, + _In_z_ LPCWSTR pszBlobType, + _Out_writes_bytes_to_opt_(cbOutput, *pcbResult) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptImportKey( + _In_ BCRYPT_ALG_HANDLE hAlgorithm, + _In_opt_ BCRYPT_KEY_HANDLE hImportKey, + _In_z_ LPCWSTR pszBlobType, + _Out_ BCRYPT_KEY_HANDLE *phKey, + _Out_writes_bytes_all_opt_(cbKeyObject) PUCHAR pbKeyObject, + _In_ ULONG cbKeyObject, + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_ ULONG dwFlags); + + +#define BCRYPT_NO_KEY_VALIDATION 0x00000008 + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +#define BCRYPT_KEY_VALIDATION_RANGE 0x00000010 // BCryptImportKeyPair +#define BCRYPT_KEY_VALIDATION_RANGE_AND_ORDER 0x00000018 // BCryptImportKeyPair & BCryptFinalizeKeyPair +#define BCRYPT_KEY_VALIDATION_REGENERATE 0x00000020 // BCryptImportKeyPair +#endif + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptImportKeyPair( + _In_ BCRYPT_ALG_HANDLE hAlgorithm, + _In_opt_ BCRYPT_KEY_HANDLE hImportKey, + _In_z_ LPCWSTR pszBlobType, + _Out_ BCRYPT_KEY_HANDLE *phKey, + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDuplicateKey( + _In_ BCRYPT_KEY_HANDLE hKey, + _Out_ BCRYPT_KEY_HANDLE *phNewKey, + _Out_writes_bytes_all_opt_(cbKeyObject) PUCHAR pbKeyObject, + _In_ ULONG cbKeyObject, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptFinalizeKeyPair( + _Inout_ BCRYPT_KEY_HANDLE hKey, + _In_ ULONG dwFlags); + + +NTSTATUS +WINAPI +BCryptDestroyKey( + _Inout_ BCRYPT_KEY_HANDLE hKey); + + +NTSTATUS +WINAPI +BCryptDestroySecret( + _Inout_ BCRYPT_SECRET_HANDLE hSecret); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptSignHash( + _In_ BCRYPT_KEY_HANDLE hKey, + _In_opt_ VOID *pPaddingInfo, + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _Out_writes_bytes_to_opt_(cbOutput, *pcbResult) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptVerifySignature( + _In_ BCRYPT_KEY_HANDLE hKey, + _In_opt_ VOID *pPaddingInfo, + _In_reads_bytes_(cbHash) PUCHAR pbHash, + _In_ ULONG cbHash, + _In_reads_bytes_(cbSignature) PUCHAR pbSignature, + _In_ ULONG cbSignature, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptSecretAgreement( + _In_ BCRYPT_KEY_HANDLE hPrivKey, + _In_ BCRYPT_KEY_HANDLE hPubKey, + _Out_ BCRYPT_SECRET_HANDLE *phAgreedSecret, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDeriveKey( + _In_ BCRYPT_SECRET_HANDLE hSharedSecret, + _In_z_ LPCWSTR pwszKDF, + _In_opt_ BCryptBufferDesc *pParameterList, + _Out_writes_bytes_to_opt_(cbDerivedKey, *pcbResult) PUCHAR pbDerivedKey, + _In_ ULONG cbDerivedKey, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); + + +#if (NTDDI_VERSION >= NTDDI_WIN8) +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptKeyDerivation( + _In_ BCRYPT_KEY_HANDLE hKey, + _In_opt_ BCryptBufferDesc *pParameterList, + _Out_writes_bytes_to_(cbDerivedKey, *pcbResult) PUCHAR pbDerivedKey, + _In_ ULONG cbDerivedKey, + _Out_ ULONG *pcbResult, + _In_ ULONG dwFlags); +#endif + + +// +// Primitive hashing functions. +// +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptCreateHash( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _Out_ BCRYPT_HASH_HANDLE *phHash, + _Out_writes_bytes_all_opt_(cbHashObject) PUCHAR pbHashObject, + _In_ ULONG cbHashObject, + _In_reads_bytes_opt_(cbSecret) PUCHAR pbSecret, // optional + _In_ ULONG cbSecret, // optional + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptHashData( + _Inout_ BCRYPT_HASH_HANDLE hHash, + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _In_ ULONG dwFlags); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptFinishHash( + _Inout_ BCRYPT_HASH_HANDLE hHash, + _Out_writes_bytes_all_(cbOutput) PUCHAR pbOutput, + _In_ ULONG cbOutput, + _In_ ULONG dwFlags); + + +#if (NTDDI_VERSION > NTDDI_WINBLUE || (NTDDI_VERSION == NTDDI_WINBLUE && defined(WINBLUE_KBSPRING14))) +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptCreateMultiHash( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _Out_ BCRYPT_HASH_HANDLE *phHash, + _In_ ULONG nHashes, + _Out_writes_bytes_all_opt_(cbHashObject) PUCHAR pbHashObject, + _In_ ULONG cbHashObject, + _In_reads_bytes_opt_(cbSecret) PUCHAR pbSecret, // optional + _In_ ULONG cbSecret, // optional + _In_ ULONG dwFlags); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptProcessMultiOperations( + _Inout_ BCRYPT_HANDLE hObject, + _In_ BCRYPT_MULTI_OPERATION_TYPE operationType, + _In_reads_bytes_(cbOperations) PVOID pOperations, + _In_ ULONG cbOperations, + _In_ ULONG dwFlags ); +#endif + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDuplicateHash( + _In_ BCRYPT_HASH_HANDLE hHash, + _Out_ BCRYPT_HASH_HANDLE *phNewHash, + _Out_writes_bytes_all_opt_(cbHashObject) PUCHAR pbHashObject, + _In_ ULONG cbHashObject, + _In_ ULONG dwFlags); + + +NTSTATUS +WINAPI +BCryptDestroyHash( + _Inout_ BCRYPT_HASH_HANDLE hHash); + + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +NTSTATUS +WINAPI +BCryptHash( + _Inout_ BCRYPT_ALG_HANDLE hAlgorithm, + _In_reads_bytes_opt_(cbSecret) PUCHAR pbSecret, // for keyed algs + _In_ ULONG cbSecret, // for keyed algs + _In_reads_bytes_(cbInput) PUCHAR pbInput, + _In_ ULONG cbInput, + _Out_writes_bytes_all_(cbOutput) PUCHAR pbOutput, + _In_ ULONG cbOutput ); +#endif + + +// +// Primitive random number generation. +// + +// Flags to BCryptGenRandom +// BCRYPT_RNG_USE_ENTROPY_IN_BUFFER is ignored in Win7 & later +#define BCRYPT_RNG_USE_ENTROPY_IN_BUFFER 0x00000001 +#define BCRYPT_USE_SYSTEM_PREFERRED_RNG 0x00000002 + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptGenRandom( + _In_opt_ BCRYPT_ALG_HANDLE hAlgorithm, + _Out_writes_bytes_(cbBuffer) PUCHAR pbBuffer, + _In_ ULONG cbBuffer, + _In_ ULONG dwFlags); + + +#if (NTDDI_VERSION >= NTDDI_WIN7) +// +// Primitive key derivation functions. +// +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDeriveKeyCapi( + _In_ BCRYPT_HASH_HANDLE hHash, + _In_opt_ BCRYPT_ALG_HANDLE hTargetAlg, + _Out_writes_bytes_( cbDerivedKey ) PUCHAR pbDerivedKey, + _In_ ULONG cbDerivedKey, + _In_ ULONG dwFlags); +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN7) +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDeriveKeyPBKDF2( + _In_ BCRYPT_ALG_HANDLE hPrf, + _In_reads_bytes_opt_( cbPassword ) PUCHAR pbPassword, + _In_ ULONG cbPassword, + _In_reads_bytes_opt_( cbSalt ) PUCHAR pbSalt, + _In_ ULONG cbSalt, + _In_ ULONGLONG cIterations, + _Out_writes_bytes_( cbDerivedKey ) PUCHAR pbDerivedKey, + _In_ ULONG cbDerivedKey, + _In_ ULONG dwFlags); +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEncapsulate( + _In_ BCRYPT_KEY_HANDLE hKey, + _Out_writes_bytes_to_opt_(cbSecretKey, *pcbSecretKey) + PUCHAR pbSecretKey, + _In_ ULONG cbSecretKey, + _Out_ ULONG *pcbSecretKey, + _Out_writes_bytes_to_opt_(cbCipherText, *pcbCipherText) + PUCHAR pbCipherText, + _In_ ULONG cbCipherText, + _Out_ ULONG *pcbCipherText, + _In_ ULONG dwFlags); +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDecapsulate( + _In_ BCRYPT_KEY_HANDLE hKey, + _In_reads_bytes_(cbCipherText) + PUCHAR pbCipherText, + _In_ ULONG cbCipherText, + _Out_writes_bytes_to_opt_(cbSecretKey, *pcbSecretKey) + PUCHAR pbSecretKey, + _In_ ULONG cbSecretKey, + _Out_ ULONG *pcbSecretKey, + _In_ ULONG dwFlags); +#endif + + +// +// Interface version control... +// +typedef struct _BCRYPT_INTERFACE_VERSION +{ + USHORT MajorVersion; + USHORT MinorVersion; + +} BCRYPT_INTERFACE_VERSION, *PBCRYPT_INTERFACE_VERSION; + +#define BCRYPT_MAKE_INTERFACE_VERSION(major,minor) {(USHORT)major, (USHORT)minor} + +#define BCRYPT_IS_INTERFACE_VERSION_COMPATIBLE(loader, provider) \ + ((loader).MajorVersion <= (provider).MajorVersion) + +// +// Primitive provider interfaces. +// + +#define BCRYPT_CIPHER_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +#define BCRYPT_HASH_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + +#if (NTDDI_VERSION > NTDDI_WINBLUE || (NTDDI_VERSION == NTDDI_WINBLUE && defined(WINBLUE_KBSPRING14))) +#define BCRYPT_HASH_INTERFACE_MAJORVERSION_2 2 +#define BCRYPT_HASH_INTERFACE_VERSION_2 BCRYPT_MAKE_INTERFACE_VERSION(BCRYPT_HASH_INTERFACE_MAJORVERSION_2,0) +#endif + + +#define BCRYPT_ASYMMETRIC_ENCRYPTION_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +#define BCRYPT_SECRET_AGREEMENT_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +#define BCRYPT_SIGNATURE_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +#define BCRYPT_RNG_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +#define BCRYPT_KEY_ENCAPSULATION_INTERFACE_VERSION_1 BCRYPT_MAKE_INTERFACE_VERSION(1,0) + + +////////////////////////////////////////////////////////////////////////////// +// CryptoConfig Definitions ////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////// + +// Interface registration flags +#define CRYPT_MIN_DEPENDENCIES (0x00000001) +#define CRYPT_PROCESS_ISOLATE (0x00010000) // User-mode only + +// Processor modes supported by a provider +// +// (Valid for BCryptQueryProviderRegistration and BCryptResolveProviders): +// +#define CRYPT_UM (0x00000001) // User mode only +#define CRYPT_KM (0x00000002) // Kernel mode only +#define CRYPT_MM (0x00000003) // Multi-mode: Must support BOTH UM and KM +// +// (Valid only for BCryptQueryProviderRegistration): +// +#define CRYPT_ANY (0x00000004) // Wildcard: Either UM, or KM, or both + + +// Write behavior flags +#define CRYPT_OVERWRITE (0x00000001) + +// Configuration tables +#define CRYPT_LOCAL (0x00000001) +#define CRYPT_DOMAIN (0x00000002) + +// Context configuration flags +#define CRYPT_EXCLUSIVE (0x00000001) +#define CRYPT_OVERRIDE (0x00010000) // Enterprise table only + +// Resolution and enumeration flags +#define CRYPT_ALL_FUNCTIONS (0x00000001) +#define CRYPT_ALL_PROVIDERS (0x00000002) + +// Priority list positions +#define CRYPT_PRIORITY_TOP (0x00000000) +#define CRYPT_PRIORITY_BOTTOM (0xFFFFFFFF) + +// Default system-wide context +#define CRYPT_DEFAULT_CONTEXT L"Default" + +////////////////////////////////////////////////////////////////////////////// +// CryptoConfig Structures /////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////// + +// +// Provider Registration Structures +// + +typedef struct _CRYPT_INTERFACE_REG +{ + ULONG dwInterface; + ULONG dwFlags; + + ULONG cFunctions; + PWSTR *rgpszFunctions; +} +CRYPT_INTERFACE_REG, *PCRYPT_INTERFACE_REG; + +typedef struct _CRYPT_IMAGE_REG +{ + PWSTR pszImage; + + ULONG cInterfaces; + PCRYPT_INTERFACE_REG *rgpInterfaces; +} +CRYPT_IMAGE_REG, *PCRYPT_IMAGE_REG; + +typedef struct _CRYPT_PROVIDER_REG +{ + ULONG cAliases; + PWSTR *rgpszAliases; + + PCRYPT_IMAGE_REG pUM; + PCRYPT_IMAGE_REG pKM; +} +CRYPT_PROVIDER_REG, *PCRYPT_PROVIDER_REG; + +typedef struct _CRYPT_PROVIDERS +{ + ULONG cProviders; + PWSTR *rgpszProviders; +} +CRYPT_PROVIDERS, *PCRYPT_PROVIDERS; + +// +// Context Configuration Structures +// + +typedef struct _CRYPT_CONTEXT_CONFIG +{ + ULONG dwFlags; + ULONG dwReserved; +} +CRYPT_CONTEXT_CONFIG, *PCRYPT_CONTEXT_CONFIG; + +typedef struct _CRYPT_CONTEXT_FUNCTION_CONFIG +{ + ULONG dwFlags; + ULONG dwReserved; +} +CRYPT_CONTEXT_FUNCTION_CONFIG, *PCRYPT_CONTEXT_FUNCTION_CONFIG; + +typedef struct _CRYPT_CONTEXTS +{ + ULONG cContexts; + PWSTR *rgpszContexts; +} +CRYPT_CONTEXTS, *PCRYPT_CONTEXTS; + +typedef struct _CRYPT_CONTEXT_FUNCTIONS +{ + ULONG cFunctions; + PWSTR *rgpszFunctions; +} +CRYPT_CONTEXT_FUNCTIONS, *PCRYPT_CONTEXT_FUNCTIONS; + +typedef struct _CRYPT_CONTEXT_FUNCTION_PROVIDERS +{ + ULONG cProviders; + PWSTR *rgpszProviders; +} +CRYPT_CONTEXT_FUNCTION_PROVIDERS, *PCRYPT_CONTEXT_FUNCTION_PROVIDERS; + +// +// Provider Resolution Structures +// + +typedef struct _CRYPT_PROPERTY_REF +{ + PWSTR pszProperty; + + ULONG cbValue; + PUCHAR pbValue; +} +CRYPT_PROPERTY_REF, *PCRYPT_PROPERTY_REF; + +typedef struct _CRYPT_IMAGE_REF +{ + PWSTR pszImage; + ULONG dwFlags; +} +CRYPT_IMAGE_REF, *PCRYPT_IMAGE_REF; + +typedef struct _CRYPT_PROVIDER_REF +{ + ULONG dwInterface; + PWSTR pszFunction; + PWSTR pszProvider; + + ULONG cProperties; + PCRYPT_PROPERTY_REF *rgpProperties; + + PCRYPT_IMAGE_REF pUM; + PCRYPT_IMAGE_REF pKM; +} +CRYPT_PROVIDER_REF, *PCRYPT_PROVIDER_REF; + +typedef struct _CRYPT_PROVIDER_REFS +{ + ULONG cProviders; + PCRYPT_PROVIDER_REF *rgpProviders; +} +CRYPT_PROVIDER_REFS, *PCRYPT_PROVIDER_REFS; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +////////////////////////////////////////////////////////////////////////////// +// CryptoConfig Functions //////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////////// + +#ifndef KERNEL_MODE_CNG + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptQueryProviderRegistration( + _In_z_ LPCWSTR pszProvider, + _In_ ULONG dwMode, + _In_ ULONG dwInterface, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_PROVIDER_REG *ppBuffer); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumRegisteredProviders( + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_PROVIDERS *ppBuffer); + +// +// Context Configuration Functions +// +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptCreateContext( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_opt_ PCRYPT_CONTEXT_CONFIG pConfig); // Optional + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptDeleteContext( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumContexts( + _In_ ULONG dwTable, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_CONTEXTS *ppBuffer); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptConfigureContext( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ PCRYPT_CONTEXT_CONFIG pConfig); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptQueryContextConfiguration( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_CONTEXT_CONFIG *ppBuffer); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptAddContextFunction( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _In_ ULONG dwPosition); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptRemoveContextFunction( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumContextFunctions( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_CONTEXT_FUNCTIONS *ppBuffer); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptConfigureContextFunction( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _In_ PCRYPT_CONTEXT_FUNCTION_CONFIG pConfig); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptQueryContextFunctionConfiguration( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_CONTEXT_FUNCTION_CONFIG *ppBuffer); + + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptEnumContextFunctionProviders( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_CONTEXT_FUNCTION_PROVIDERS *ppBuffer); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptSetContextFunctionProperty( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _In_z_ LPCWSTR pszProperty, + _In_ ULONG cbValue, + _In_reads_bytes_opt_(cbValue) PUCHAR pbValue); + +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptQueryContextFunctionProperty( + _In_ ULONG dwTable, + _In_z_ LPCWSTR pszContext, + _In_ ULONG dwInterface, + _In_z_ LPCWSTR pszFunction, + _In_z_ LPCWSTR pszProperty, + _Inout_ ULONG* pcbValue, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PUCHAR *ppbValue); + +#endif //#ifndef KERNEL_MODE_CNG + +// +// Configuration Change Notification Functions +// + +#ifdef KERNEL_MODE_CNG +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptRegisterConfigChangeNotify( + _In_ PRKEVENT pEvent); + +#else +_Must_inspect_result_ +NTSTATUS +WINAPI +BCryptRegisterConfigChangeNotify( + _Out_ HANDLE *phEvent); +#endif + +#ifdef KERNEL_MODE_CNG +NTSTATUS +WINAPI +BCryptUnregisterConfigChangeNotify( + _In_ PRKEVENT pEvent); + +#else +NTSTATUS +WINAPI +BCryptUnregisterConfigChangeNotify( + _In_ HANDLE hEvent); +#endif + +// +// Provider Resolution Functions +// +_Must_inspect_result_ +NTSTATUS WINAPI +BCryptResolveProviders( + _In_opt_z_ LPCWSTR pszContext, + _In_opt_ ULONG dwInterface, + _In_opt_z_ LPCWSTR pszFunction, + _In_opt_z_ LPCWSTR pszProvider, + _In_ ULONG dwMode, + _In_ ULONG dwFlags, + _Inout_ ULONG* pcbBuffer, + _Outptr_opt_result_bytebuffer_all_maybenull_(*pcbBuffer) PCRYPT_PROVIDER_REFS *ppBuffer); + +#endif /* WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +// +// Miscellaneous queries about the crypto environment +// +NTSTATUS +WINAPI +BCryptGetFipsAlgorithmMode( + _Out_ BOOLEAN *pfEnabled + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)*/ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +BOOLEAN +CngGetFipsAlgorithmMode( + VOID + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdamedia.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdamedia.h new file mode 100644 index 0000000000000000000000000000000000000000..a0ef29d5e284019034e2e7d7835da9b75a443dc2 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdamedia.h @@ -0,0 +1,3685 @@ +//------------------------------------------------------------------------------ +// File: BDAMedia.h +// +// Desc: Broadcast Driver Architecture Multimedia Definitions. +// +// Copyright (c) 1996 - 2001, Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if !defined(_KSMEDIA_) +#error KSMEDIA.H must be included before BDAMEDIA.H +#endif // !defined(_KSMEDIA_) + +#if !defined(_BDATYPES_) +#error BDATYPES.H must be included before BDAMEDIA.H +#endif // !defined(_BDATYPES_) + +#if !defined(_BDAMEDIA_) +#define _BDAMEDIA_ + +#if defined(__cplusplus) +extern "C" { +#endif // defined(__cplusplus) + + + +//=========================================================================== +// +// KSProperty Set Structure Definitions for BDA +// +//=========================================================================== + +typedef struct _KSP_BDA_NODE_PIN { + KSPROPERTY Property; + ULONG ulNodeType; + ULONG ulInputPinId; + ULONG ulOutputPinId; +} KSP_BDA_NODE_PIN, *PKSP_BDA_NODE_PIN; + + +typedef struct _KSM_BDA_PIN +{ + KSMETHOD Method; + union + { + ULONG PinId; + ULONG PinType; + }; + ULONG Reserved; +} KSM_BDA_PIN, * PKSM_BDA_PIN; + + +typedef struct _KSM_BDA_PIN_PAIR +{ + KSMETHOD Method; + union + { + ULONG InputPinId; + ULONG InputPinType; + }; + union + { + ULONG OutputPinId; + ULONG OutputPinType; + }; +} KSM_BDA_PIN_PAIR, * PKSM_BDA_PIN_PAIR; + + +typedef struct { + KSP_NODE Property; + ULONG EsPid; +} KSP_NODE_ESPID, *PKSP_NODE_ESPID; + +typedef struct _KSM_BDA_DEBUG_LEVEL +{ + KSMETHOD Method; + UCHAR ucDebugLevel; + ULONG ulDebugStringSize; + BYTE argbDebugString [MIN_DIMENSION]; +} KSM_BDA_DEBUG_LEVEL, * PKSM_BDA_DEBUG_LEVEL; + +typedef struct _BDA_DEBUG_DATA +{ + PBDARESULT lResult; + GUID uuidDebugDataType; + ULONG ulDataSize; + BYTE argbDebugData [MIN_DIMENSION]; +} BDA_DEBUG_DATA; + +typedef struct _BDA_EVENT_DATA +{ + PBDARESULT lResult; + ULONG ulEventID; + GUID uuidEventType; + ULONG ulEventDataLength; + BYTE argbEventData [MIN_DIMENSION]; +} BDA_EVENT_DATA, * PBDA_EVENT_DATA; + +typedef struct _KSM_BDA_EVENT_COMPLETE { + KSMETHOD Method; + ULONG ulEventID; + ULONG ulEventResult; +} KSM_BDA_EVENT_COMPLETE, * PKSM_BDA_EVENT_COMPLETE; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for DRM, WMDRM, WMDRMTUNER +// +//=========================================================================== + +typedef struct _KSM_BDA_DRM_SETDRM +{ + KSM_NODE NodeMethod; + GUID NewDRMuuid; +} KSM_BDA_DRM_SETDRM, * PKSM_BDA_DRM_SETDRM; + +typedef struct _KSM_BDA_BUFFER +{ + KSM_NODE NodeMethod; + ULONG ulBufferSize; + BYTE argbBuffer[MIN_DIMENSION]; +} KSM_BDA_BUFFER, *PKSM_BDA_BUFFER; + +typedef struct KSM_BDA_WMDRM_LICENSE +{ + KSM_NODE NodeMethod; + GUID uuidKeyID; +} KSM_BDA_WMDRM_LICENSE, *PKSM_BDA_WMDRM_LICENSE; + +typedef struct _KSM_BDA_WMDRM_RENEWLICENSE +{ + KSM_NODE NodeMethod; + ULONG ulXMRLicenseLength; + ULONG ulEntitlementTokenLength; + BYTE argbDataBuffer[MIN_DIMENSION]; //License and Entitlement Token Buffer +} KSM_BDA_WMDRM_RENEWLICENSE, *PKSM_BDA_WMDRM_RENEWLICENSE; + +typedef struct _KSM_BDA_WMDRMTUNER_PURCHASEENTITLEMENT +{ + KSM_NODE NodeMethod; + ULONG ulDialogRequest; + CHAR cLanguage[12]; + ULONG ulPurchaseTokenLength; + BYTE argbDataBuffer[MIN_DIMENSION]; //Language Buffer before PurchaseToken +} KSM_BDA_WMDRMTUNER_PURCHASEENTITLEMENT, *PKSM_BDA_WMDRMTUNER_PURCHASEENTITLEMENT; + +typedef struct _KSM_BDA_WMDRMTUNER_SETPIDPROTECTION +{ + KSM_NODE NodeMethod; + ULONG ulPID; + GUID uuidKeyID; +} KSM_BDA_WMDRMTUNER_SETPIDPROTECTION, *PKSM_BDA_WMDRMTUNER_SETPIDPROTECTION; + +typedef struct _KSM_BDA_WMDRMTUNER_GETPIDPROTECTION +{ + KSM_NODE NodeMethod; + ULONG ulPID; +} KSM_BDA_WMDRMTUNER_GETPIDPROTECTION, *PKSM_BDA_WMDRMTUNER_GETPIDPROTECTION; + +typedef struct _KSM_BDA_WMDRMTUNER_SYNCVALUE +{ + KSM_NODE NodeMethod; + ULONG ulSyncValue; +} KSM_BDA_WMDRMTUNER_SYNCVALUE, *PKSM_BDA_WMDRMTUNER_SYNCVALUE; + + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA TUNER +// +//=========================================================================== + +typedef struct _KSM_BDA_TUNER_TUNEREQUEST +{ + KSMETHOD Method; + ULONG ulTuneLength; + BYTE argbTuneData [MIN_DIMENSION]; +} KSM_BDA_TUNER_TUNEREQUEST, *PKSM_BDA_TUNER_TUNEREQUEST; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA GENERAL PURPOSE NAME VALUES +// +//=========================================================================== + +typedef struct _KSM_BDA_GPNV_GETVALUE +{ + KSMETHOD Method; + ULONG ulNameLength; + CHAR cLanguage[12]; + BYTE argbData [MIN_DIMENSION]; +} KSM_BDA_GPNV_GETVALUE, *PKSM_BDA_GPNV_GETVALUE; + +typedef struct _KSM_BDA_GPNV_SETVALUE +{ + KSMETHOD Method; + ULONG ulDialogRequest; + CHAR cLanguage[12]; + ULONG ulNameLength; + ULONG ulValueLength; + BYTE argbName [MIN_DIMENSION]; +} KSM_BDA_GPNV_SETVALUE, *PKSM_BDA_GPNV_SETVALUE; + +typedef struct _KSM_BDA_GPNV_NAMEINDEX +{ + KSMETHOD Method; + ULONG ulValueNameIndex; +} KSM_BDA_GPNV_NAMEINDEX, *PKSM_BDA_GPNV_NAMEINDEX; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA SCANNING +// +//=========================================================================== +typedef struct _KSM_BDA_SCAN_CAPABILTIES +{ + KSMETHOD Method; + GUID uuidBroadcastStandard; +} KSM_BDA_SCAN_CAPABILTIES, *PKSM_BDA_SCAN_CAPABILTIES; + +typedef struct _KSM_BDA_SCAN_FILTER +{ + KSMETHOD Method; + ULONG ulScanModulationTypeSize; + ULONG64 AnalogVideoStandards; + BYTE argbScanModulationTypes[MIN_DIMENSION]; +} KSM_BDA_SCAN_FILTER, *PKSM_BDA_SCAN_FILTER; + +typedef struct _KSM_BDA_SCAN_START +{ + KSMETHOD Method; + ULONG LowerFrequency; + ULONG HigherFrequency; +} KSM_BDA_SCAN_START, *PKSM_BDA_SCAN_START; + + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA GUIDE DATA +// +//=========================================================================== + +typedef struct _KSM_BDA_GDDS_TUNEXMLFROMIDX { + KSMETHOD Method; + ULONG64 ulIdx; +} KSM_BDA_GDDS_TUNEXMLFROMIDX, *PKSM_BDA_GDDS_TUNEXMLFROMIDX; + +typedef struct _KSM_BDA_GDDS_SERVICEFROMTUNEXML +{ + KSMETHOD Method; + ULONG ulTuneXmlLength; + BYTE argbTuneXml[MIN_DIMENSION]; +} KSM_BDA_GDDS_SERVICEFROMTUNEXML , *PKSM_BDA_GDDS_SERVICEFROMTUNEXML; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA USER ACTIVITY +// +//=========================================================================== +typedef struct _KSM_BDA_USERACTIVITY_USEREASON +{ + KSMETHOD Method; + ULONG ulUseReason; +} KSM_BDA_USERACTIVITY_USEREASON, *PKSM_BDA_USERACTIVITY_USEREASON; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for PBDA CAS +// +//=========================================================================== +typedef struct _KSM_BDA_CAS_ENTITLEMENTTOKEN +{ + KSM_NODE NodeMethod; + ULONG ulDialogRequest; + CHAR cLanguage[12]; + ULONG ulRequestType; + ULONG ulEntitlementTokenLen; + BYTE argbEntitlementToken[MIN_DIMENSION]; +} KSM_BDA_CAS_ENTITLEMENTTOKEN, *PKSM_BDA_CAS_ENTITLEMENTTOKEN; + +typedef struct _KSM_BDA_CAS_CAPTURETOKEN +{ + KSM_NODE NodeMethod; + ULONG ulTokenLength; + BYTE argbToken [MIN_DIMENSION]; +} KSM_BDA_CAS_CAPTURETOKEN, *PKSM_BDA_CAS_CAPTURETOKEN; + +typedef struct _KSM_BDA_CAS_OPENBROADCASTMMI +{ + KSM_NODE NodeMethod; + ULONG ulDialogRequest; + CHAR cLanguage[12]; + ULONG ulEventId; +} KSM_BDA_CAS_OPENBROADCASTMMI, *PKSM_BDA_CAS_OPENBROADCASTMMI; + +typedef struct _KSM_BDA_CAS_CLOSEMMIDIALOG +{ + KSM_NODE NodeMethod; + ULONG ulDialogRequest; + CHAR cLanguage[12]; + ULONG ulDialogNumber; + ULONG ulReason; +} KSM_BDA_CAS_CLOSEMMIDIALOG, *PKSM_BDA_CAS_CLOSEMMIDIALOG; + +typedef struct _KSM_BDA_ISDBCAS_REQUEST +{ + KSM_NODE NodeMethod; + ULONG ulRequestID; + ULONG ulIsdbCommandSize; + BYTE argbIsdbCommandData [MIN_DIMENSION]; +} KSM_BDA_ISDBCAS_REQUEST, *PKSM_BDA_ISDBCAS_REQUEST; + +//=========================================================================== +// +// KSMethod Set Structure Definitions for Transprt Stream Selector +// +//=========================================================================== +typedef struct _KSM_BDA_TS_SELECTOR_SETTSID +{ + KSM_NODE NodeMethod; + USHORT usTSID; +} KSM_BDA_TS_SELECTOR_SETTSID, *PKSM_BDA_TS_SELECTOR_SETTSID; + + +//=========================================================================== +// +// BDA Data Range definitions. Includes specifier definitions. +// +//=========================================================================== + +// Antenna Signal Formats +// + +typedef struct tagKS_DATARANGE_BDA_ANTENNA { + KSDATARANGE DataRange; + + // Antenna specifier can go here if required + // +} KS_DATARANGE_BDA_ANTENNA, *PKS_DATARANGE_BDA_ANTENNA; + + + +// Transport Formats +// + +typedef struct tagBDA_TRANSPORT_INFO { + ULONG ulcbPhyiscalPacket; // Size, in bytes, of a physical packet + // (e.g. Satellite link payload size. + ULONG ulcbPhyiscalFrame; // Size, in bytes, of each physical frame + // 0 indicates no HW requirement + ULONG ulcbPhyiscalFrameAlignment; // Capture buffer alignment in bytes + // 0 and 1 indicate no alignment requirements + REFERENCE_TIME AvgTimePerFrame; // Normal ActiveMovie units (100 nS) + +} BDA_TRANSPORT_INFO, *PBDA_TRANSPORT_INFO; + +typedef struct tagKS_DATARANGE_BDA_TRANSPORT { + KSDATARANGE DataRange; + BDA_TRANSPORT_INFO BdaTransportInfo; + + // Transport specifier can go here if required + // +} KS_DATARANGE_BDA_TRANSPORT, *PKS_DATARANGE_BDA_TRANSPORT; + + +//=========================================================================== +// BDA Event Guids +// +// These are sent by the IBroadcastEvent service on the graph. +// To receive, +// 0) Implement IBroadcastEvent in your receiving object - this has one Method on it: Fire() +// 1) QI the graphs service provider for SID_SBroadcastEventService +// for the IID_IBroadcastEvent object +// 2) OR create the event service (CLSID_BroadcastEventService) if not already there +// and register it +// 3) QI that object for it's IConnectionPoint interface (*pCP) +// 4) Advise your object on *pCP (e.g. pCP->Advise(static_cast(this), &dwCookie) +// 5) Unadvise when done.. +// 6) Implement IBroadcastEvent::Fire(GUID gEventID) +// Check for relevant event below and deal with it appropriatly... +//=========================================================================== + +// {83183C03-C09E-45c4-A719-807A94952BF9} +#define STATIC_EVENTID_TuningChanging \ + 0x83183c03, 0xc09e, 0x45c4, 0xa7, 0x19, 0x80, 0x7a, 0x94, 0x95, 0x2b, 0xf9 +DEFINE_GUIDSTRUCT("83183C03-C09E-45c4-A719-807A94952BF9", EVENTID_TuningChanging); +#define EVENTID_TuningChanging DEFINE_GUIDNAMED(EVENTID_TuningChanging) + +// {9D7E6235-4B7D-425d-A6D1-D717C33B9C4C} +#define STATIC_EVENTID_TuningChanged \ + 0x9d7e6235, 0x4b7d, 0x425d, 0xa6, 0xd1, 0xd7, 0x17, 0xc3, 0x3b, 0x9c, 0x4c +DEFINE_GUIDSTRUCT("9D7E6235-4B7D-425d-A6D1-D717C33B9C4C", EVENTID_TuningChanged); +#define EVENTID_TuningChanged DEFINE_GUIDNAMED(EVENTID_TuningChanged) + +// {9F02D3D0-9F06-4369-9F1E-3AD6CA19807E} +#define STATIC_EVENTID_CandidatePostTuneData \ + 0x9F02D3D0, 0x9F06, 0x4369, 0x9F, 0x1E, 0x3A, 0xD6, 0xCA, 0x19, 0x80, 0x7E +DEFINE_GUIDSTRUCT("9F02D3D0-9F06-4369-9F1E-3AD6CA19807E", EVENTID_CandidatePostTuneData); +#define EVENTID_CandidatePostTuneData DEFINE_GUIDNAMED(EVENTID_CandidatePostTuneData) + +// {2A65C528-2249-4070-AC16-00390CDFB2DD} +#define STATIC_EVENTID_CADenialCountChanged \ + 0x2a65c528, 0x2249, 0x4070, 0xac, 0x16, 0x0, 0x39, 0xc, 0xdf, 0xb2, 0xdd +DEFINE_GUIDSTRUCT("2A65C528-2249-4070-AC16-00390CDFB2DD", EVENTID_CADenialCountChanged); +#define EVENTID_CADenialCountChanged DEFINE_GUIDNAMED(EVENTID_CADenialCountChanged) + +// {6D9CFAF2-702D-4b01-8DFF-6892AD20D191} +#define STATIC_EVENTID_SignalStatusChanged \ + 0x6d9cfaf2, 0x702d, 0x4b01, 0x8d, 0xff, 0x68, 0x92, 0xad, 0x20, 0xd1, 0x91 +DEFINE_GUIDSTRUCT("6D9CFAF2-702D-4b01-8DFF-6892AD20D191", EVENTID_SignalStatusChanged); +#define EVENTID_SignalStatusChanged DEFINE_GUIDNAMED(EVENTID_SignalStatusChanged) + +// {C87EC52D-CD18-404a-A076-C02A273D3DE7} +#define STATIC_EVENTID_NewSignalAcquired \ + 0xc87ec52d, 0xcd18, 0x404a, 0xa0, 0x76, 0xc0, 0x2a, 0x27, 0x3d, 0x3d, 0xe7 +DEFINE_GUIDSTRUCT("C87EC52D-CD18-404a-A076-C02A273D3DE7", EVENTID_NewSignalAcquired); +#define EVENTID_NewSignalAcquired DEFINE_GUIDNAMED(EVENTID_NewSignalAcquired) + +// {D10DF9D5-C261-4b85-9E8A-517B3299CAB2} +#define STATIC_EVENTID_EASMessageReceived \ + 0xd10df9d5, 0xc261, 0x4b85, 0x9e, 0x8a, 0x51, 0x7b, 0x32, 0x99, 0xca, 0xb2 +DEFINE_GUIDSTRUCT("D10DF9D5-C261-4b85-9E8A-517B3299CAB2", EVENTID_EASMessageReceived); +#define EVENTID_EASMessageReceived DEFINE_GUIDNAMED(EVENTID_EASMessageReceived) + +// This event is broadcasted with FireEx when a table(currently, PAT, PMT, NIT +// and SDT for DVB; PAT, PMT, MGT and VCT for ATSC). The four parameters are: +// dwPara1 - TSID, ONID|TSID for DVB EIT +// dwPara2 - TID|PID +// dwPara3 - dwHashedVersion +// dwPara4 - program number for PMT, Segment#|SID for EIT, but not used for others +// {1B9C3703-D447-4e16-97BB-01799FC031ED} +#define STATIC_EVENTID_PSITable \ + 0x1b9c3703, 0xd447, 0x4e16, 0x97, 0xbb, 0x1, 0x79, 0x9f, 0xc0, 0x31, 0xed +DEFINE_GUIDSTRUCT("1B9C3703-D447-4e16-97BB-01799FC031ED", EVENTID_PSITable); +#define EVENTID_PSITable DEFINE_GUIDNAMED(EVENTID_PSITable) + +// This event is broadcasted with FireEx when the capture graph recognized that a +// current tuning channel has been terminated by broadcaster. +// The four parameters are: +// dwPara1 - TSID +// dwPara2 - ONID|SID +// dwPara3 - channel frequency +// dwPara4 - satellite orbital position (0xFFFFFFFF for non-satellite) +// {0A1D591C-E0D2-4f8e-8960-2335BEF45CCB} +#define STATIC_EVENTID_ServiceTerminated \ + 0xa1d591c, 0xe0d2, 0x4f8e, 0x89, 0x60, 0x23, 0x35, 0xbe, 0xf4, 0x5c, 0xcb +DEFINE_GUIDSTRUCT("0A1D591C-E0D2-4f8e-8960-2335BEF45CCB", EVENTID_ServiceTerminated); +#define EVENTID_ServiceTerminated DEFINE_GUIDNAMED(EVENTID_ServiceTerminated) + +// {A265FAEA-F874-4b38-9FF7-C53D02969996} +#define STATIC_EVENTID_CardStatusChanged\ + 0xa265faea, 0xf874, 0x4b38, 0x9f, 0xf7, 0xc5, 0x3d, 0x2, 0x96, 0x99, 0x96 +DEFINE_GUIDSTRUCT("A265FAEA-F874-4b38-9FF7-C53D02969996", EVENTID_CardStatusChanged); +#define EVENTID_CardStatusChanged DEFINE_GUIDNAMED(EVENTID_CardStatusChanged) +#define DTV_CardStatus_Inserted 0 +#define DTV_CardStatus_Removed 1 +#define DTV_CardStatus_Error 2 +#define DTV_CardStatus_FirmwareDownload 3 + +// {000906F5-F0D1-41d6-A7DF-4028697669F6} +#define STATIC_EVENTID_DRMParingStatusChanged \ + 0x906f5, 0xf0d1, 0x41d6, 0xa7, 0xdf, 0x40, 0x28, 0x69, 0x76, 0x69, 0xf6 +DEFINE_GUIDSTRUCT("000906F5-F0D1-41d6-A7DF-4028697669F6", EVENTID_DRMParingStatusChanged); +#define EVENTID_DRMParingStatusChanged DEFINE_GUIDNAMED(EVENTID_DRMParingStatusChanged) +// The 1st parameter to this event is a BDA_DRMPairingStatus and 2nd is the error code. + +// {5B2EBF78-B752-4420-B41E-A472DC95828E} +#define STATIC_EVENTID_DRMParingStepComplete \ + 0x5b2ebf78, 0xb752, 0x4420, 0xb4, 0x1e, 0xa4, 0x72, 0xdc, 0x95, 0x82, 0x8e +DEFINE_GUIDSTRUCT("5B2EBF78-B752-4420-B41E-A472DC95828E", EVENTID_DRMParingStepComplete); +#define EVENTID_DRMParingStepComplete DEFINE_GUIDNAMED(EVENTID_DRMParingStepComplete) +// The 1st parameter is which pairing manager is generting the event +// The 2nd parameter is the step in the pairing process which is now complete +// The 3rd parameter is the result of the step +#define OCUR_PAIRING_PROTOCOL_VERSION 2 +#define PBDA_PAIRING_PROTOCOL_VERSION 3 + +// {052C29AF-09A4-4b93-890F-BD6A348968A4} +#define STATIC_EVENTID_MMIMessage \ + 0x52c29af, 0x9a4, 0x4b93, 0x89, 0xf, 0xbd, 0x6a, 0x34, 0x89, 0x68, 0xa4 +DEFINE_GUIDSTRUCT("052C29AF-09A4-4b93-890F-BD6A348968A4", EVENTID_MMIMessage); +#define EVENTID_MMIMessage DEFINE_GUIDNAMED(EVENTID_MMIMessage) +#define DTV_MMIMessage_Open 0 +#define DTV_MMIMessage_Close 1 + +// {9071AD5D-2359-4c95-8694-AFA81D70BFD5} +#define STATIC_EVENTID_EntitlementChanged \ + 0x9071ad5d, 0x2359, 0x4c95, 0x86, 0x94, 0xaf, 0xa8, 0x1d, 0x70, 0xbf, 0xd5 +DEFINE_GUIDSTRUCT("9071AD5D-2359-4c95-8694-AFA81D70BFD5", EVENTID_EntitlementChanged); +#define EVENTID_EntitlementChanged DEFINE_GUIDNAMED(EVENTID_EntitlementChanged) +#define DTV_Entitlement_CanDecrypt 0 +#define DTV_Entitlement_NotEntitled 1 +#define DTV_Entitlement_TechnicalFailure 2 + + +// This FireEx event is fired when tuning to a STB channel number +// the first parameter passed is the channel number the STB has been tuned to +// {17C4D730-D0F0-413a-8C99-500469DE35AD} +#define STATIC_EVENTID_STBChannelNumber\ + 0x17c4d730, 0xd0f0, 0x413a, 0x8c, 0x99, 0x50, 0x04, 0x69, 0xde, 0x35, 0xad +DEFINE_GUIDSTRUCT("17C4D730-D0F0-413a-8C99-500469DE35AD", EVENTID_STBChannelNumber); +#define EVENTID_STBChannelNumber DEFINE_GUIDNAMED(EVENTID_STBChannelNumber) + +// {5CA51711-5DDC-41a6-9430-E41B8B3BBC5B} +#define STATIC_EVENTID_BDAEventingServicePendingEvent \ + 0x5ca51711, 0x5ddc, 0x41a6, 0x94, 0x30, 0xe4, 0x1b, 0x8b, 0x3b, 0xbc, 0x5b +DEFINE_GUIDSTRUCT("5CA51711-5DDC-41a6-9430-E41B8B3BBC5B", EVENTID_BDAEventingServicePendingEvent); +#define EVENTID_BDAEventingServicePendingEvent DEFINE_GUIDNAMED(EVENTID_BDAEventingServicePendingEvent) + +// {EFC3A459-AE8B-4b4a-8FE9-79A0D097F3EA} +#define STATIC_EVENTID_BDAConditionalAccessTAG \ + 0xefc3a459, 0xae8b, 0x4b4a, 0x8f, 0xe9, 0x79, 0xa0, 0xd0, 0x97, 0xf3, 0xea +DEFINE_GUIDSTRUCT("EFC3A459-AE8B-4b4a-8FE9-79A0D097F3EA", EVENTID_BDAConditionalAccessTAG); +#define EVENTID_BDAConditionalAccessTAG DEFINE_GUIDNAMED(EVENTID_BDAConditionalAccessTAG) + +// {B2127D42-7BE5-4f4b-9130-6679899F4F4B} +#define STATIC_EVENTTYPE_CASDescrambleFailureEvent \ + 0xb2127d42, 0x7be5, 0x4f4b, 0x91, 0x30, 0x66, 0x79, 0x89, 0x9f, 0x4f, 0x4b +DEFINE_GUIDSTRUCT("B2127D42-7BE5-4f4b-9130-6679899F4F4B", EVENTTYPE_CASDescrambleFailureEvent); +#define EVENTTYPE_CASDescrambleFailureEvent DEFINE_GUIDNAMED(EVENTTYPE_CASDescrambleFailureEvent) + +// {EAD831AE-5529-4d1f-AFCE-0D8CD1257D30} +#define STATIC_EVENTID_CASFailureSpanningEvent \ + 0xead831ae, 0x5529, 0x4d1f, 0xaf, 0xce, 0xd, 0x8c, 0xd1, 0x25, 0x7d, 0x30 +DEFINE_GUIDSTRUCT("EAD831AE-5529-4d1f-AFCE-0D8CD1257D30", EVENTID_CASFailureSpanningEvent); +#define EVENTID_CASFailureSpanningEvent DEFINE_GUIDNAMED(EVENTID_CASFailureSpanningEvent) + +typedef enum { + ChannelChangeSpanningEvent_Start = 0, // Same as MSNP_EVENT_CHANGING defined in ehtraceguids.h + ChannelChangeSpanningEvent_End = 2 // Same as MSNP_EVENT_COMPLETED defined in ehtraceguids.h +} ChannelChangeSpanningEvent_State; + +// {9067C5E5-4C5C-4205-86C8-7AFE20FE1EFA} same as __uuidof(EH_MSNP_TUNING_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_ChannelChangeSpanningEvent \ + 0x9067C5E5, 0x4C5C, 0x4205, 0x86, 0xc8, 0x7a, 0xfe, 0x20, 0xfe, 0x1e, 0xfa +DEFINE_GUIDSTRUCT("9067C5E5-4C5C-4205-86C8-7AFE20FE1EFA", EVENTID_ChannelChangeSpanningEvent); +#define EVENTID_ChannelChangeSpanningEvent DEFINE_GUIDNAMED(EVENTID_ChannelChangeSpanningEvent) + + +typedef struct _ChannelChangeInfo +{ + ChannelChangeSpanningEvent_State state; + ULONGLONG TimeStamp; +}ChannelChangeInfo; + +#define STATIC_EVENTID_ChannelTypeSpanningEvent \ + 0x72ab1d51, 0x87d2, 0x489b, 0xba, 0x11, 0xe, 0x8, 0xdc, 0x21, 0x2, 0x43 +DEFINE_GUIDSTRUCT("72ab1d51-87d2-489b-ba11-0e08dc210243", EVENTID_ChannelTypeSpanningEvent); +#define EVENTID_ChannelTypeSpanningEvent DEFINE_GUIDNAMED(EVENTID_ChannelTypeSpanningEvent) + +typedef enum +{ + ChannelTypeNone = 0x0000, + // bit flags, can be ORed + // type == 2 ^ ComponentCategory in bdatypes.h + ChannelTypeOther = 0x0001, + ChannelTypeVideo = 0x0002, + ChannelTypeAudio = 0x0004, + ChannelTypeText = 0x0008, + ChannelTypeSubtitles = 0x0010, + ChannelTypeCaptions = 0x0020, + ChannelTypeSuperimpose = 0x0040, + ChannelTypeData = 0x0080 +} ChannelType; + +typedef struct _ChannelTypeInfo +{ + ChannelType channelType; + ULONGLONG timeStamp; +}ChannelTypeInfo; + +typedef struct _ChannelInfo +{ + LONG lFrequency; + union + { + struct + { + LONG lONID; + LONG lTSID; + LONG lSID; + } DVB; + struct + { + LONG lProgNumber; + } DC; + struct + { + LONG lProgNumber; + } ATSC; + }; + +} ChannelInfo; + +// {41F36D80-4132-4cc2-B121-01A43219D81B} +#define STATIC_EVENTID_ChannelInfoSpanningEvent \ + 0x41f36d80, 0x4132, 0x4cc2, 0xb1, 0x21, 0x1, 0xa4, 0x32, 0x19, 0xd8, 0x1b +DEFINE_GUIDSTRUCT("41F36D80-4132-4cc2-B121-01A43219D81B", EVENTID_ChannelInfoSpanningEvent); +#define EVENTID_ChannelInfoSpanningEvent DEFINE_GUIDNAMED(EVENTID_ChannelInfoSpanningEvent) + +// F6CFC8F4-DA93-4f2f-BFF8-BA1EE6FCA3A2 same as __uuidof(EH_RRT_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_RRTSpanningEvent \ + 0xf6cfc8f4, 0xda93, 0x4f2f, 0xbf, 0xf8, 0xba, 0x1e, 0xe6, 0xfc, 0xa3, 0xa2 +DEFINE_GUIDSTRUCT("F6CFC8F4-DA93-4f2f-BFF8-BA1EE6FCA3A2", EVENTID_RRTSpanningEvent); +#define EVENTID_RRTSpanningEvent DEFINE_GUIDNAMED(EVENTID_RRTSpanningEvent) + +// Data sturcture for both CaptionServiceDescriptor and Content Advisory descriptor +typedef struct _SpanningEventDescriptor{ + WORD wDataLen; // Total length of the data(2*sizeof(WORD)+lengthof(bDescriptor)) + WORD wProgNumber; // Program numberassociated with this descriptor + WORD wSID; // Source ID associated with this descriptor + BYTE bDescriptor[1]; // Raw descriptor data +} SpanningEventDescriptor; + +// Caption Service descriptior spanning event +// {EFE779D9-97F0-4786-800D-95CF505DDC66} same as __uuidof(EH_CaptionService_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_CSDescriptorSpanningEvent \ + 0xefe779d9, 0x97f0, 0x4786, 0x80, 0xd, 0x95, 0xcf, 0x50, 0x5d, 0xdc, 0x66 +DEFINE_GUIDSTRUCT("EFE779D9-97F0-4786-800D-95CF505DDC66", EVENTID_CSDescriptorSpanningEvent); +#define EVENTID_CSDescriptorSpanningEvent DEFINE_GUIDNAMED(EVENTID_CSDescriptorSpanningEvent) + +// Content Advisory descriptor spanning event +// {3AB4A2E6-4247-4b34-896C-30AFA5D21C24} same as __uuidof(EH_ContentAdvisory_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_CtxADescriptorSpanningEvent \ + 0x3ab4a2e6, 0x4247, 0x4b34, 0x89, 0x6c, 0x30, 0xaf, 0xa5, 0xd2, 0x1c, 0x24 +DEFINE_GUIDSTRUCT("3AB4A2E6-4247-4b34-896C-30AFA5D21C24", EVENTID_CtxADescriptorSpanningEvent); +#define EVENTID_CtxADescriptorSpanningEvent DEFINE_GUIDNAMED(EVENTID_CtxADescriptorSpanningEvent) + +typedef struct _DVBScramblingControlSpanningEvent +{ + ULONG ulPID; + BOOL fScrambled; +} DVBScramblingControlSpanningEvent; + +// transport_scarmbling_control flag global event +// {4BD4E1C4-90A1-4109-8236-27F00E7DCC5B} +#define STATIC_EVENTID_DVBScramblingControlSpanningEvent \ + 0x4bd4e1c4, 0x90a1, 0x4109, 0x82, 0x36, 0x27, 0xf0, 0xe, 0x7d, 0xcc, 0x5b +DEFINE_GUIDSTRUCT("4BD4E1C4-90A1-4109-8236-27F00E7DCC5B", EVENTID_DVBScramblingControlSpanningEvent); +#define EVENTID_DVBScramblingControlSpanningEvent DEFINE_GUIDNAMED(EVENTID_DVBScramblingControlSpanningEvent) + +typedef enum { + SignalAndServiceStatusSpanningEvent_None = -1, + SignalAndServiceStatusSpanningEvent_Clear = 0, // same as MSNP_EVENT_SIGNALANDSERVICE_TYPE in ehtraceguids.h + SignalAndServiceStatusSpanningEvent_NoTVSignal = 1, + SignalAndServiceStatusSpanningEvent_ServiceOffAir = 2, + SignalAndServiceStatusSpanningEvent_WeakTVSignal = 3, + SignalAndServiceStatusSpanningEvent_NoSubscription = 4, + SignalAndServiceStatusSpanningEvent_AllAVScrambled = 5, +} SignalAndServiceStatusSpanningEvent_State; + +// Signal and Service Status event +// {8068C5CB-3C04-492b-B47D-0308820DCE51} same as __uuidof(EH_MSNP_SIGNALANDSERVICE_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_SignalAndServiceStatusSpanningEvent \ + 0x8068c5cb, 0x3c04, 0x492b, 0xb4, 0x7d, 0x3, 0x8, 0x82, 0xd, 0xce, 0x51 +DEFINE_GUIDSTRUCT("8068C5CB-3C04-492b-B47D-0308820DCE51", EVENTID_SignalAndServiceStatusSpanningEvent); +#define EVENTID_SignalAndServiceStatusSpanningEvent DEFINE_GUIDNAMED(EVENTID_SignalAndServiceStatusSpanningEvent) + +#define EVENTID_SignalAndServiceStatusEvent EVENTID_SignalAndServiceStatusSpanningEvent + +// Data structure for EmmMessageSpanningEvent +typedef struct _SpanningEventEmmMessage{ + BYTE bCAbroadcasterGroupId; // CA Broadcaster Group ID from CA_service_descriptor (ARIB STD-B25) + BYTE bMessageControl; // Message Control from CA_service_descriptor (ARIB STD-B25) + WORD wServiceId; // Service ID of ISDB bound with this + WORD wTableIdExtension; // Zero means the followings are inoperable + BYTE bDeletionStatus; + BYTE bDisplayingDuration1; + BYTE bDisplayingDuration2; + BYTE bDisplayingDuration3; + BYTE bDisplayingCycle; + BYTE bFormatVersion; + BYTE bDisplayPosition; + WORD wMessageLength; + WCHAR szMessageArea[MIN_DIMENSION]; +} SpanningEventEmmMessage; + +// EMM Message spanning event +// {6BF00268-4F7E-4294-AA87-E9E953E43F14} same as __uuidof(EH_EmmMessage_EVENT) defined in ehtraceguids.h +#define STATIC_EVENTID_EmmMessageSpanningEvent \ + 0x6bf00268, 0x4f7e, 0x4294, 0xaa, 0x87, 0xe9, 0xe9, 0x53, 0xe4, 0x3f, 0x14 +DEFINE_GUIDSTRUCT("6BF00268-4F7E-4294-AA87-E9E953E43F14", EVENTID_EmmMessageSpanningEvent); +#define EVENTID_EmmMessageSpanningEvent DEFINE_GUIDNAMED(EVENTID_EmmMessageSpanningEvent) + +// {501CBFBE-B849-42ce-9BE9-3DB869FB82B3} +#define STATIC_EVENTID_AudioTypeSpanningEvent \ + 0x501cbfbe, 0xb849, 0x42ce, 0x9b, 0xe9, 0x3d, 0xb8, 0x69, 0xfb, 0x82, 0xb3 +DEFINE_GUIDSTRUCT("501CBFBE-B849-42ce-9BE9-3DB869FB82B3", EVENTID_AudioTypeSpanningEvent); +#define EVENTID_AudioTypeSpanningEvent DEFINE_GUIDNAMED(EVENTID_AudioTypeSpanningEvent) +// AC 3 audio type and ISO639 language descriptor audio type are slight different. The +// AudioType values defined here is for the convenience of the user of audio type info +// and the conversion from the original spec to these values is done in capture. +// +// ISO639 language descriptor audio types: +// 0x00 undefined (standard audio) +// 0x01 clean effects +// 0x02 hearing impaired +// 0x03 visual impaired commentary +// 0x04-0xFF reserved +// +// AC3 audio types +// 0 Complete Main (CM) +// 1 Music and Effects (ME) +// 2 Visually Impaired (VI) +// 3 Hearing Impaired (HI) +// 4 Dialogue (D) +// 5 Commentary (C) +// 6 Emergency (E) +// 7 Voiceover (VO) + +#define AudioType_Standard 0 +#define AudioType_Music_And_Effects 1 +#define AudioType_Visually_Impaired 2 +#define AudioType_Hearing_Impaired 3 +#define AudioType_Dialogue 4 +#define AudioType_Commentary 5 +#define AudioType_Emergency 6 +#define AudioType_Voiceover 7 +#define AudioType_Reserved -1 + +// {82af2ebc-30a6-4264-a80b-ad2e1372ac60} +#define STATIC_EVENTID_StreamTypeSpanningEvent \ + 0x82af2ebc, 0x30a6, 0x4264, 0xa8, 0x0b, 0xad, 0x2e, 0x13, 0x72, 0xac, 0x60 +DEFINE_GUIDSTRUCT("82af2ebc-30a6-4264-a80b-ad2e1372ac60", EVENTID_StreamTypeSpanningEvent); +#define EVENTID_StreamTypeSpanningEvent DEFINE_GUIDNAMED(EVENTID_StreamTypeSpanningEvent) + +// {3A954083-93D0-463e-90B2-0742C496EDF0} +#define STATIC_EVENTID_ARIBcontentSpanningEvent \ + 0x3a954083, 0x93d0, 0x463e, 0x90, 0xb2, 0x7, 0x42, 0xc4, 0x96, 0xed, 0xf0 +DEFINE_GUIDSTRUCT("3A954083-93D0-463e-90B2-0742C496EDF0", EVENTID_ARIBcontentSpanningEvent); +#define EVENTID_ARIBcontentSpanningEvent DEFINE_GUIDNAMED(EVENTID_ARIBcontentSpanningEvent) + +// {E292666D-9C02-448d-AA8D-781A93FDC395} +#define STATIC_EVENTID_LanguageSpanningEvent \ + 0xe292666d, 0x9c02, 0x448d, 0xaa, 0x8d, 0x78, 0x1a, 0x93, 0xfd, 0xc3, 0x95 +DEFINE_GUIDSTRUCT("E292666D-9C02-448d-AA8D-781A93FDC395", EVENTID_LanguageSpanningEvent); +#define EVENTID_LanguageSpanningEvent DEFINE_GUIDNAMED(EVENTID_LanguageSpanningEvent) +typedef struct _LanguageInfo +{ + LANGID LangID; + LONG lISOLangCode; +} LanguageInfo; + +// {A9A29B56-A84B-488c-89D5-0D4E7657C8CE} +#define STATIC_EVENTID_DualMonoSpanningEvent \ + 0xa9a29b56, 0xa84b, 0x488c, 0x89, 0xd5, 0x0d, 0x4e, 0x76, 0x57, 0xc8, 0xce +DEFINE_GUIDSTRUCT("A9A29B56-A84B-488c-89D5-0D4E7657C8CE", EVENTID_DualMonoSpanningEvent); +#define EVENTID_DualMonoSpanningEvent DEFINE_GUIDNAMED(EVENTID_DualMonoSpanningEvent) +typedef struct _DualMonoInfo +{ + LANGID LangID1; + LANGID LangID2; + LONG lISOLangCode1; + LONG lISOLangCode2; +} DualMonoInfo; + +// {47FC8F65-E2BB-4634-9CEF-FDBFE6261D5C} +#define STATIC_EVENTID_PIDListSpanningEvent \ + 0x47fc8f65, 0xe2bb, 0x4634, 0x9c, 0xef, 0xfd, 0xbf, 0xe6, 0x26, 0x1d, 0x5c +DEFINE_GUIDSTRUCT("47FC8F65-E2BB-4634-9CEF-FDBFE6261D5C", EVENTID_PIDListSpanningEvent); +#define EVENTID_PIDListSpanningEvent DEFINE_GUIDNAMED(EVENTID_PIDListSpanningEvent) +typedef struct _PIDListSpanningEvent +{ + WORD wPIDCount; + ULONG pulPIDs[1]; +} PIDListSpanningEvent; + +// {107BD41C-A6DA-4691-8369-11B2CDAA288E} +#define STATIC_EVENTID_AudioDescriptorSpanningEvent \ + 0x107bd41c, 0xa6da, 0x4691, 0x83, 0x69, 0x11, 0xb2, 0xcd, 0xaa, 0x28, 0x8e +DEFINE_GUIDSTRUCT("107BD41C-A6DA-4691-8369-11B2CDAA288E", EVENTID_AudioDescriptorSpanningEvent); +#define EVENTID_AudioDescriptorSpanningEvent DEFINE_GUIDNAMED(EVENTID_AudioDescriptorSpanningEvent) + +// {5DCEC048-D0B9-4163-872C-4F32223BE88A} +#define STATIC_EVENTID_SubtitleSpanningEvent \ + 0x5dcec048, 0xd0b9, 0x4163, 0x87, 0x2c, 0x4f, 0x32, 0x22, 0x3b, 0xe8, 0x8a +DEFINE_GUIDSTRUCT("5DCEC048-D0B9-4163-872C-4F32223BE88A", EVENTID_SubtitleSpanningEvent); +#define EVENTID_SubtitleSpanningEvent DEFINE_GUIDNAMED(EVENTID_SubtitleSpanningEvent) + +// {9599D950-5F33-4617-AF7C-1E54B510DAA3} +#define STATIC_EVENTID_TeletextSpanningEvent \ + 0x9599d950, 0x5f33, 0x4617, 0xaf, 0x7c, 0x1e, 0x54, 0xb5, 0x10, 0xda, 0xa3 +DEFINE_GUIDSTRUCT("9599D950-5F33-4617-AF7C-1E54B510DAA3", EVENTID_TeletextSpanningEvent); +#define EVENTID_TeletextSpanningEvent DEFINE_GUIDNAMED(EVENTID_TeletextSpanningEvent) + +// {CAF1AB68-E153-4d41-A6B3-A7C998DB75EE} +#define STATIC_EVENTID_StreamIDSpanningEvent \ + 0xcaf1ab68, 0xe153, 0x4d41, 0xa6, 0xb3, 0xa7, 0xc9, 0x98, 0xdb, 0x75, 0xee +DEFINE_GUIDSTRUCT("CAF1AB68-E153-4d41-A6B3-A7C998DB75EE", EVENTID_StreamIDSpanningEvent); +#define EVENTID_StreamIDSpanningEvent DEFINE_GUIDNAMED(EVENTID_StreamIDSpanningEvent) + +// {F947AA85-FB52-48e8-B9C5-E1E1F411A51A} +#define STATIC_EVENTID_PBDAParentalControlEvent \ + 0xf947aa85, 0xfb52, 0x48e8, 0xb9, 0xc5, 0xe1, 0xe1, 0xf4, 0x11, 0xa5, 0x1a +DEFINE_GUIDSTRUCT("F947AA85-FB52-48e8-B9C5-E1E1F411A51A", EVENTID_PBDAParentalControlEvent); +#define EVENTID_PBDAParentalControlEvent DEFINE_GUIDNAMED(EVENTID_PBDAParentalControlEvent) + +#pragma pack(push,1) + +#define MAX_COUNTRY_CODE_STRING 3 + +typedef struct { + DWORD rating_attribute_id; + DWORD rating_attribute_value; +} RATING_ATTRIBUTE, *LPRATING_ATTRIBUTE; + +typedef struct { + GUID rating_system_id; + BYTE rating_system_is_age_type: 1; + BYTE reserved: 7; + BYTE country_code[MAX_COUNTRY_CODE_STRING]; + DWORD rating_attribute_count; + RATING_ATTRIBUTE *lpratingattrib; +} RATING_SYSTEM, *LPRATING_SYSTEM; + +typedef struct { + DWORD rating_system_count; + RATING_SYSTEM *lpratingsystem; + +} RATING_INFO, *LPRATING_INFO; + +// attribute_id +#define PARENTAL_CONTROL_TIME_RANGE 0x00000001 // Parental Control Time Range +#define REQUIRED_PARENTAL_CONTROL_TIME_RANGE 0x00000002 // Required Parental Control Time Range +#define PARENTAL_CONTROL_CONTENT_RATING 0x00000100 // Rating (overall/primary content rating) +#define PARENTAL_CONTROL_ATTRIB_VIOLENCE 0x00000200 // Violence +#define PARENTAL_CONTROL_ATTRIB_LANGUAGE 0x00000201 // Language +#define PARENTAL_CONTROL_ATTRIB_SEXUAL 0x00000202 // Sexual Content +#define PARENTAL_CONTROL_ATTRIB_DIALOGUE 0x00000203 // Dialogue +#define PARENTAL_CONTROL_ATTRIB_FANTASY 0x00000204 // Fantasy Violence + +#define PARENTAL_CONTROL_VALUE_UNDEFINED 0 // UNDEFINED + +typedef struct _PBDAParentalControl +{ + ULONG rating_system_count; // number of rating systems in PBDA parenatl control table + RATING_SYSTEM * rating_systems; // PBDA unified rating systems +} PBDAParentalControl; + +#pragma pack(pop) + +// {D97287B2-2DFD-436a-9485-99D7D4AB5A69} +#define STATIC_EVENTID_TuneFailureEvent \ + 0xd97287b2, 0x2dfd, 0x436a, 0x94, 0x85, 0x99, 0xd7, 0xd4, 0xab, 0x5a, 0x69 +DEFINE_GUIDSTRUCT("D97287B2-2DFD-436a-9485-99D7D4AB5A69", EVENTID_TuneFailureEvent); +#define EVENTID_TuneFailureEvent DEFINE_GUIDNAMED(EVENTID_TuneFailureEvent) + +// {6F8AA455-5EE1-48ab-A27C-4C8D70B9AEBA} +#define STATIC_EVENTID_TuneFailureSpanningEvent \ + 0x6f8aa455, 0x5ee1, 0x48ab, 0xa2, 0x7c, 0x4c, 0x8d, 0x70, 0xb9, 0xae, 0xba +DEFINE_GUIDSTRUCT("6F8AA455-5EE1-48ab-A27C-4C8D70B9AEBA", EVENTID_TuneFailureSpanningEvent); +#define EVENTID_TuneFailureSpanningEvent DEFINE_GUIDNAMED(EVENTID_TuneFailureSpanningEvent) + +// {2A67A58D-ECA5-4eac-ABCB-E734D3776D0A} +#define STATIC_EVENTID_DvbParentalRatingDescriptor \ + 0x2a67a58d, 0xeca5, 0x4eac, 0xab, 0xcb, 0xe7, 0x34, 0xd3, 0x77, 0x6d, 0x0a +DEFINE_GUIDSTRUCT("2A67A58D-ECA5-4eac-ABCB-E734D3776D0A", EVENTID_DvbParentalRatingDescriptor); +#define EVENTID_DvbParentalRatingDescriptor DEFINE_GUIDNAMED(EVENTID_DvbParentalRatingDescriptor) +typedef struct +{ + CHAR szCountryCode[4]; // 3-chars + null + BYTE bRating; // rating +} DvbParentalRatingParam; +typedef struct +{ + ULONG ulNumParams; // if zero, no rating + DvbParentalRatingParam pParams[1]; +} DvbParentalRatingDescriptor; + +// {F5689FFE-55F9-4bb3-96BE-AE971C63BAE0} +#define STATIC_EVENTID_DFNWithNoActualAVData \ + 0xf5689ffe, 0x55f9, 0x4bb3, 0x96, 0xbe, 0xae, 0x97, 0x1c, 0x63, 0xba, 0xe0 +DEFINE_GUIDSTRUCT("F5689FFE-55F9-4bb3-96BE-AE971C63BAE0", EVENTID_DFNWithNoActualAVData); +#define EVENTID_DFNWithNoActualAVData DEFINE_GUIDNAMED(EVENTID_DFNWithNoActualAVData) + +//=========================================================================== +// +// BDA Stream Format GUIDs +// +//=========================================================================== + +#define STATIC_KSDATAFORMAT_TYPE_BDA_ANTENNA\ + 0x71985f41, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F41-1CA1-11d3-9CC8-00C04F7971E0", KSDATAFORMAT_TYPE_BDA_ANTENNA); +#define KSDATAFORMAT_TYPE_BDA_ANTENNA DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_BDA_ANTENNA) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_BDA_MPEG2_TRANSPORT\ + 0xf4aeb342, 0x0329, 0x4fdd, 0xa8, 0xfd, 0x4a, 0xff, 0x49, 0x26, 0xc9, 0x78 +DEFINE_GUIDSTRUCT("F4AEB342-0329-4fdd-A8FD-4AFF4926C978", KSDATAFORMAT_SUBTYPE_BDA_MPEG2_TRANSPORT); +#define KSDATAFORMAT_SUBTYPE_BDA_MPEG2_TRANSPORT DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_BDA_MPEG2_TRANSPORT) + + +#define STATIC_KSDATAFORMAT_SPECIFIER_BDA_TRANSPORT\ + 0x8deda6fd, 0xac5f, 0x4334, 0x8e, 0xcf, 0xa4, 0xba, 0x8f, 0xa7, 0xd0, 0xf0 +DEFINE_GUIDSTRUCT("8DEDA6FD-AC5F-4334-8ECF-A4BA8FA7D0F0", KSDATAFORMAT_SPECIFIER_BDA_TRANSPORT); +#define KSDATAFORMAT_SPECIFIER_BDA_TRANSPORT DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_BDA_TRANSPORT) + + +#define STATIC_KSDATAFORMAT_TYPE_BDA_IF_SIGNAL\ + 0x61be0b47, 0xa5eb, 0x499b, 0x9a, 0x85, 0x5b, 0x16, 0xc0, 0x7f, 0x12, 0x58 +DEFINE_GUIDSTRUCT("61BE0B47-A5EB-499b-9A85-5B16C07F1258", KSDATAFORMAT_TYPE_BDA_IF_SIGNAL); +#define KSDATAFORMAT_TYPE_BDA_IF_SIGNAL DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_BDA_IF_SIGNAL) + + +#define STATIC_KSDATAFORMAT_TYPE_MPEG2_SECTIONS\ + 0x455f176c, 0x4b06, 0x47ce, 0x9a, 0xef, 0x8c, 0xae, 0xf7, 0x3d, 0xf7, 0xb5 +DEFINE_GUIDSTRUCT("455F176C-4B06-47CE-9AEF-8CAEF73DF7B5", KSDATAFORMAT_TYPE_MPEG2_SECTIONS); +#define KSDATAFORMAT_TYPE_MPEG2_SECTIONS DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MPEG2_SECTIONS) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_ATSC_SI\ + 0xb3c7397c, 0xd303, 0x414d, 0xb3, 0x3c, 0x4e, 0xd2, 0xc9, 0xd2, 0x97, 0x33 +DEFINE_GUIDSTRUCT("B3C7397C-D303-414D-B33C-4ED2C9D29733", KSDATAFORMAT_SUBTYPE_ATSC_SI); +#define KSDATAFORMAT_SUBTYPE_ATSC_SI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_ATSC_SI) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_DVB_SI\ + 0xe9dd31a3, 0x221d, 0x4adb, 0x85, 0x32, 0x9a, 0xf3, 0x9, 0xc1, 0xa4, 0x8 +DEFINE_GUIDSTRUCT("e9dd31a3-221d-4adb-8532-9af309c1a408", KSDATAFORMAT_SUBTYPE_DVB_SI); +#define KSDATAFORMAT_SUBTYPE_DVB_SI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_DVB_SI) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_PSIP\ + 0x762e3f66, 0x336f, 0x48d1, 0xbf, 0x83, 0x2b, 0x0, 0x35, 0x2c, 0x11, 0xf0 +DEFINE_GUIDSTRUCT("762E3F66-336F-48d1-BF83-2B00352C11F0", KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_PSIP); +#define KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_PSIP DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_PSIP) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_OOB_PSIP\ + 0x951727db, 0xd2ce, 0x4528, 0x96, 0xf6, 0x33, 0x1, 0xfa, 0xbb, 0x2d, 0xe0 +DEFINE_GUIDSTRUCT("951727DB-D2CE-4528-96F6-3301FABB2DE0", KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_OOB_PSIP); +#define KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_OOB_PSIP DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_BDA_OPENCABLE_OOB_PSIP) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_ISDB_SI\ + 0x4a2eeb99, 0x6458, 0x4538, 0xb1, 0x87, 0x04, 0x01, 0x7c, 0x41, 0x41, 0x3f +DEFINE_GUIDSTRUCT("4a2eeb99-6458-4538-b187-04017c41413f", KSDATAFORMAT_SUBTYPE_ISDB_SI); +#define KSDATAFORMAT_SUBTYPE_ISDB_SI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_ISDB_SI) + + +#define STATIC_KSDATAFORMAT_SUBTYPE_PBDA_TRANSPORT_RAW\ + 0x0d7aed42, 0xcb9a, 0x11db, 0x97, 0x05, 0x00, 0x50, 0x56, 0xc0, 0x00, 0x08 +DEFINE_GUIDSTRUCT("0d7AED42-CB9A-11DB-9705-005056C00008", KSDATAFORMAT_SUBTYPE_PBDA_TRANSPORT_RAW); +#define KSDATAFORMAT_SUBTYPE_PBDA_TRANSPORT_RAW DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_PBDA_TRANSPORT_RAW) + + +//=========================================================================== +// +// KSPinName Definitions for BDA +// +//=========================================================================== + +// Pin name for a BDA transport pin +// +// {78216A81-CFA8-493e-9711-36A61C08BD9D} +// +#define STATIC_PINNAME_BDA_TRANSPORT \ + 0x78216a81, 0xcfa8, 0x493e, 0x97, 0x11, 0x36, 0xa6, 0x1c, 0x8, 0xbd, 0x9d +DEFINE_GUIDSTRUCT("78216A81-CFA8-493e-9711-36A61C08BD9D", PINNAME_BDA_TRANSPORT); +#define PINNAME_BDA_TRANSPORT DEFINE_GUIDNAMED(PINNAME_BDA_TRANSPORT) + + +// Pin name for a BDA analog video pin +// +// {5C0C8281-5667-486c-8482-63E31F01A6E9} +// +#define STATIC_PINNAME_BDA_ANALOG_VIDEO \ + 0x5c0c8281, 0x5667, 0x486c, 0x84, 0x82, 0x63, 0xe3, 0x1f, 0x1, 0xa6, 0xe9 +DEFINE_GUIDSTRUCT("5C0C8281-5667-486c-8482-63E31F01A6E9", PINNAME_BDA_ANALOG_VIDEO); +#define PINNAME_BDA_ANALOG_VIDEO DEFINE_GUIDNAMED(PINNAME_BDA_ANALOG_VIDEO) + + +// Pin name for a BDA analog audio pin +// +// {D28A580A-9B1F-4b0c-9C33-9BF0A8EA636B} +// +#define STATIC_PINNAME_BDA_ANALOG_AUDIO \ + 0xd28a580a, 0x9b1f, 0x4b0c, 0x9c, 0x33, 0x9b, 0xf0, 0xa8, 0xea, 0x63, 0x6b +DEFINE_GUIDSTRUCT("D28A580A-9B1F-4b0c-9C33-9BF0A8EA636B", PINNAME_BDA_ANALOG_AUDIO); +#define PINNAME_BDA_ANALOG_AUDIO DEFINE_GUIDNAMED(PINNAME_BDA_ANALOG_AUDIO) + + +// Pin name for a BDA FM Radio pin +// +// {D2855FED-B2D3-4eeb-9BD0-193436A2F890} +// +#define STATIC_PINNAME_BDA_FM_RADIO \ + 0xd2855fed, 0xb2d3, 0x4eeb, 0x9b, 0xd0, 0x19, 0x34, 0x36, 0xa2, 0xf8, 0x90 +DEFINE_GUIDSTRUCT("D2855FED-B2D3-4eeb-9BD0-193436A2F890", PINNAME_BDA_FM_RADIO); +#define PINNAME_BDA_FM_RADIO DEFINE_GUIDNAMED(PINNAME_BDA_FM_RADIO) + + +// Pin name for a BDA Intermediate Frequency pin +// +// {1A9D4A42-F3CD-48a1-9AEA-71DE133CBE14} +// +#define STATIC_PINNAME_BDA_IF_PIN \ + 0x1a9d4a42, 0xf3cd, 0x48a1, 0x9a, 0xea, 0x71, 0xde, 0x13, 0x3c, 0xbe, 0x14 +DEFINE_GUIDSTRUCT("1A9D4A42-F3CD-48a1-9AEA-71DE133CBE14", PINNAME_BDA_IF_PIN); +#define PINNAME_BDA_IF_PIN DEFINE_GUIDNAMED(PINNAME_BDA_IF_PIN) + + +// Pin name for a BDA Open Cable PSIP pin +// +// {297BB104-E5C9-4ACE-B123-95C3CBB24D4F} +// +#define STATIC_PINNAME_BDA_OPENCABLE_PSIP_PIN \ + 0x297bb104, 0xe5c9, 0x4ace, 0xb1, 0x23, 0x95, 0xc3, 0xcb, 0xb2, 0x4d, 0x4f +DEFINE_GUIDSTRUCT("297BB104-E5C9-4ACE-B123-95C3CBB24D4F", PINNAME_BDA_OPENCABLE_PSIP_PIN); +#define PINNAME_BDA_OPENCABLE_PSIP_PIN DEFINE_GUIDNAMED(PINNAME_BDA_OPENCABLE_PSIP_PIN) + + +//=========================================================================== +// +// KSProperty Set Definitions for BDA +// +//=========================================================================== + + +//------------------------------------------------------------ +// +// BDA Network Ethernet Filter Property Set +// +// {71985F43-1CA1-11d3-9CC8-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaEthernetFilter \ + 0x71985f43, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F43-1CA1-11d3-9CC8-00C04F7971E0", KSPROPSETID_BdaEthernetFilter); +#define KSPROPSETID_BdaEthernetFilter DEFINE_GUIDNAMED(KSPROPSETID_BdaEthernetFilter) + +typedef enum { + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_LIST_SIZE = 0, + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_LIST, + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_MODE +} KSPROPERTY_BDA_ETHERNET_FILTER; + +#define DEFINE_KSPROPERTY_ITEM_BDA_ETHERNET_FILTER_MULTICAST_LIST_SIZE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_LIST_SIZE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_ETHERNET_FILTER_MULTICAST_LIST(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_LIST,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_ETHERNET_ADDRESS_LIST),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_ETHERNET_FILTER_MULTICAST_MODE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_ETHERNET_FILTER_MULTICAST_MODE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_MULTICAST_MODE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// BDA Network IPv4 Filter Property Set +// +// {71985F44-1CA1-11d3-9CC8-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaIPv4Filter \ + 0x71985f44, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F44-1CA1-11d3-9CC8-00C04F7971E0", KSPROPSETID_BdaIPv4Filter); +#define KSPROPSETID_BdaIPv4Filter DEFINE_GUIDNAMED(KSPROPSETID_BdaIPv4Filter) + +typedef enum { + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_LIST_SIZE = 0, + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_LIST, + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_MODE +} KSPROPERTY_BDA_IPv4_FILTER; + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv4_FILTER_MULTICAST_LIST_SIZE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_LIST_SIZE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv4_FILTER_MULTICAST_LIST(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_LIST,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_IPv4_ADDRESS_LIST),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv4_FILTER_MULTICAST_MODE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv4_FILTER_MULTICAST_MODE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_MULTICAST_MODE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// BDA Network IPv6 Filter Property Set +// +// {E1785A74-2A23-4fb3-9245-A8F88017EF33} +// +#define STATIC_KSPROPSETID_BdaIPv6Filter \ + 0xe1785a74, 0x2a23, 0x4fb3, 0x92, 0x45, 0xa8, 0xf8, 0x80, 0x17, 0xef, 0x33 +DEFINE_GUIDSTRUCT("E1785A74-2A23-4fb3-9245-A8F88017EF33", KSPROPSETID_BdaIPv6Filter); +#define KSPROPSETID_BdaIPv6Filter DEFINE_GUIDNAMED(KSPROPSETID_BdaIPv6Filter) + +typedef enum { + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_LIST_SIZE = 0, + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_LIST, + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_MODE +} KSPROPERTY_BDA_IPv6_FILTER; + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv6_FILTER_MULTICAST_LIST_SIZE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_LIST_SIZE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv6_FILTER_MULTICAST_LIST(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_LIST,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_IPv6_ADDRESS_LIST),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_IPv6_FILTER_MULTICAST_MODE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_IPv6_FILTER_MULTICAST_MODE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(BDA_MULTICAST_MODE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + +//------------------------------------------------------------ +// +// +// BDA Signal Statistics Property Set +// +// Used to get signal statistics from a control node or a pin. +// Set NodeId == -1 to get properties from the pin. +// +// {1347D106-CF3A-428a-A5CB-AC0D9A2A4338} +// +#define STATIC_KSPROPSETID_BdaSignalStats \ + 0x1347d106, 0xcf3a, 0x428a, 0xa5, 0xcb, 0xac, 0xd, 0x9a, 0x2a, 0x43, 0x38 +DEFINE_GUIDSTRUCT("1347D106-CF3A-428a-A5CB-AC0D9A2A4338", KSPROPSETID_BdaSignalStats); +#define KSPROPSETID_BdaSignalStats DEFINE_GUIDNAMED(KSPROPSETID_BdaSignalStats) + +typedef enum { + KSPROPERTY_BDA_SIGNAL_STRENGTH = 0, + KSPROPERTY_BDA_SIGNAL_QUALITY, + KSPROPERTY_BDA_SIGNAL_PRESENT, + KSPROPERTY_BDA_SIGNAL_LOCKED, + KSPROPERTY_BDA_SAMPLE_TIME, + KSPROPERTY_BDA_SIGNAL_LOCK_CAPS, + KSPROPERTY_BDA_SIGNAL_LOCK_TYPE +} KSPROPERTY_BDA_SIGNAL_STATS; + +typedef enum _BdaLockType { + Bda_LockType_None = 0x00, + Bda_LockType_PLL = 0x01, + Bda_LockType_DecoderDemod = 0x02, + Bda_LockType_Complete = 0x80 +} BDA_LockType; + +// OPTIONAL +// Carrier strength in mDb (1/1000 of a DB). +// +// A strength of 0 is nominal strength as expected for the given +// type of broadcast network. +// +// Sub-nominal strengths are reported as positive mDb +// +// Super-nominal strengths are reported as negative mDb +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_STRENGTH(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_STRENGTH,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(LONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +// OPTIONAL +// Amount of data successfully extracted from the signal as a percent. +// +// Signal Quality is usually reported by the demodulation node and is +// a representation of how much of the original data could be extracted +// from the signal. +// +// In the case of Analog Signals, this percentage can be +// computed by examining the timing of HSync and VSync as will as by +// looking at information contained in HBlanking and VBlanking intervals. +// +// In the case of Digital Signals, this percentage can be +// computed by examining packet CRCs and FEC confidence values. +// +// 100 percent is ideal. +// 95 percent shows very little (almost unnoticable) artifacts when rendered. +// 90 percent contains few enough artifacts as to be easily viewable. +// 80 percent is the minimum level to be viewable. +// 60 percent is the minimum level to expect data services +// (including EPG) to work. +// 20 percent indicates that the demodulator knows that a properly modulated +// signal exists but can't produce enough data to be useful. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_QUALITY(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_QUALITY,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(LONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +// REQUIRED +// True if a signal carrier is present. +// +// Should be returned by the RF tuner node. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_PRESENT(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_PRESENT,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BOOL),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +// REQUIRED +// True if the signal can be locked. +// +// Ususally represents PLL lock when returned by the RF Tuner Node. +// +// Represents Signal Quality of at least 20% when returned by the +// demodulator node. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_LOCKED(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_LOCKED,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BOOL),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +// OPTIONAL +// Indicates the sample time overwhich signal level and quality are +// averaged. +// +// Each time a signal statistics property is requested, the node should +// report the average value for the last n milliseconds where n is the +// value set by this property. If no value is set or if the driver does +// not support this property, the driver should default to +// 100 millisecond sample times. +// +// The driver may report values for the most recently completed sample +// period. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SAMPLE_TIME(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SAMPLE_TIME,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(LONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + +// REQUIRED +// returns a bitmask of supported BDA_LockType_ values +// +// Should be returned by the RF tuner node. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_LOCK_CAPS(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_LOCK_CAPS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BOOL),\ + NULL,\ + NULL, 0, NULL, NULL, 0) + +// REQUIRED +// returns current BDA_LockType_ value +// +// Should be returned by the RF tuner node. +// +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNAL_LOCK_TYPE(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNAL_LOCK_TYPE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_LockType),\ + NULL,\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA Change Sync Method Set +// +// {FD0A5AF3-B41D-11d2-9C95-00C04F7971E0} +// +#define STATIC_KSMETHODSETID_BdaChangeSync \ + 0xfd0a5af3, 0xb41d, 0x11d2, 0x9c, 0x95, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("FD0A5AF3-B41D-11d2-9C95-00C04F7971E0", KSMETHODSETID_BdaChangeSync); +#define KSMETHODSETID_BdaChangeSync DEFINE_GUIDNAMED(KSMETHODSETID_BdaChangeSync) + +typedef enum { + KSMETHOD_BDA_START_CHANGES = 0, + KSMETHOD_BDA_CHECK_CHANGES, + KSMETHOD_BDA_COMMIT_CHANGES, + KSMETHOD_BDA_GET_CHANGE_STATE +} KSMETHOD_BDA_CHANGE_SYNC; + +#define DEFINE_KSMETHOD_ITEM_BDA_START_CHANGES(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_START_CHANGES,\ + KSMETHOD_TYPE_NONE,\ + (MethodHandler),\ + sizeof(KSMETHOD),\ + 0,\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_CHECK_CHANGES(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CHECK_CHANGES,\ + KSMETHOD_TYPE_NONE,\ + (MethodHandler),\ + sizeof(KSMETHOD),\ + 0,\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_COMMIT_CHANGES(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_COMMIT_CHANGES,\ + KSMETHOD_TYPE_NONE,\ + (MethodHandler),\ + sizeof(KSMETHOD),\ + 0,\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GET_CHANGE_STATE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GET_CHANGE_STATE,\ + KSMETHOD_TYPE_READ,\ + (MethodHandler),\ + sizeof(KSMETHOD),\ + 0,\ + SupportHandler) + + + +//------------------------------------------------------------ +// +// +// BDA Device Configuration Method Set +// +// {71985F45-1CA1-11d3-9CC8-00C04F7971E0} +// +#define STATIC_KSMETHODSETID_BdaDeviceConfiguration \ + 0x71985f45, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F45-1CA1-11d3-9CC8-00C04F7971E0", KSMETHODSETID_BdaDeviceConfiguration); +#define KSMETHODSETID_BdaDeviceConfiguration DEFINE_GUIDNAMED(KSMETHODSETID_BdaDeviceConfiguration) + +typedef enum { + KSMETHOD_BDA_CREATE_PIN_FACTORY = 0, + KSMETHOD_BDA_DELETE_PIN_FACTORY, + KSMETHOD_BDA_CREATE_TOPOLOGY +} KSMETHOD_BDA_DEVICE_CONFIGURATION; + +#define DEFINE_KSMETHOD_ITEM_BDA_CREATE_PIN_FACTORY(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CREATE_PIN_FACTORY,\ + KSMETHOD_TYPE_READ,\ + (MethodHandler),\ + sizeof(KSM_BDA_PIN),\ + sizeof(ULONG),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_DELETE_PIN_FACTORY(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_DELETE_PIN_FACTORY,\ + KSMETHOD_TYPE_NONE,\ + (MethodHandler),\ + sizeof(KSM_BDA_PIN),\ + 0,\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_CREATE_TOPOLOGY(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CREATE_TOPOLOGY,\ + KSMETHOD_TYPE_WRITE,\ + (MethodHandler),\ + sizeof(KSM_BDA_PIN_PAIR),\ + 0,\ + SupportHandler) + + + +//------------------------------------------------------------ +// +// +// BDA Topology Property Set +// +// {A14EE835-0A23-11d3-9CC7-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaTopology \ + 0xa14ee835, 0x0a23, 0x11d3, 0x9c, 0xc7, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("A14EE835-0A23-11d3-9CC7-00C04F7971E0", KSPROPSETID_BdaTopology); +#define KSPROPSETID_BdaTopology DEFINE_GUIDNAMED(KSPROPSETID_BdaTopology) + +typedef enum { + KSPROPERTY_BDA_NODE_TYPES, + KSPROPERTY_BDA_PIN_TYPES, + KSPROPERTY_BDA_TEMPLATE_CONNECTIONS, + KSPROPERTY_BDA_NODE_METHODS, + KSPROPERTY_BDA_NODE_PROPERTIES, + KSPROPERTY_BDA_NODE_EVENTS, + KSPROPERTY_BDA_CONTROLLING_PIN_ID, + KSPROPERTY_BDA_NODE_DESCRIPTORS + }KSPROPERTY_BDA_TOPOLOGY; + +#define DEFINE_KSPROPERTY_ITEM_BDA_NODE_TYPES(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NODE_TYPES,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIN_TYPES(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIN_TYPES,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_TEMPLATE_CONNECTIONS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_TEMPLATE_CONNECTIONS,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof( BDA_TEMPLATE_CONNECTION),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_NODE_METHODS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NODE_METHODS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_NODE_PROPERTIES(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NODE_PROPERTIES,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_NODE_EVENTS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NODE_EVENTS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CONTROLLING_PIN_ID(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CONTROLLING_PIN_ID,\ + (GetHandler),\ + sizeof(KSP_BDA_NODE_PIN),\ + sizeof( ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_NODE_DESCRIPTORS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NODE_DESCRIPTORS,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + 0,\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// +// BDA Pin Control Property Set +// +// {0DED49D5-A8B7-4d5d-97A1-12B0C195874D} +// +#define STATIC_KSPROPSETID_BdaPinControl \ + 0xded49d5, 0xa8b7, 0x4d5d, 0x97, 0xa1, 0x12, 0xb0, 0xc1, 0x95, 0x87, 0x4d +DEFINE_GUIDSTRUCT("0DED49D5-A8B7-4d5d-97A1-12B0C195874D", KSPROPSETID_BdaPinControl); +#define KSPROPSETID_BdaPinControl DEFINE_GUIDNAMED(KSPROPSETID_BdaPinControl) + +typedef enum { + KSPROPERTY_BDA_PIN_ID = 0, + KSPROPERTY_BDA_PIN_TYPE +} KSPROPERTY_BDA_PIN_CONTROL; + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIN_ID(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIN_ID,\ + (GetHandler),\ + sizeof( KSPROPERTY),\ + sizeof( ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIN_TYPE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIN_TYPE,\ + (GetHandler),\ + sizeof( KSPROPERTY),\ + sizeof( ULONG),\ + FALSE,\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// +// BDA Pin Event Set +// +// {104781CD-50BD-40d5-95FB-087E0E86A591} +// +#define STATIC_KSEVENTSETID_BdaPinEvent \ + 0x104781cd, 0x50bd, 0x40d5, 0x95, 0xfb, 0x08, 0x7e, 0xe, 0x86, 0xa5, 0x91 +DEFINE_GUIDSTRUCT("104781CD-50BD-40d5-95FB-087E0E86A591", KSEVENTSETID_BdaPinEvent); +#define KSEVENTSETID_BdaPinEvent DEFINE_GUIDNAMED(KSEVENTSETID_BdaPinEvent) + +typedef enum { + KSEVENT_BDA_PIN_CONNECTED = 0, + KSEVENT_BDA_PIN_DISCONNECTED +} KSPROPERTY_BDA_PIN_EVENT; + +#define DEFINE_KSEVENT_ITEM_BDA_PIN_CONNECTED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_PIN_CONNECTED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +#define DEFINE_KSEVENT_ITEM_BDA_PIN_DISCONNECTED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_PIN_DISCONNECTED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + + + +//------------------------------------------------------------ +// +// +// BDA Void Transform Property Set +// +// {71985F46-1CA1-11d3-9CC8-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaVoidTransform \ + 0x71985f46, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F46-1CA1-11d3-9CC8-00C04F7971E0", KSPROPSETID_BdaVoidTransform); +#define KSPROPSETID_BdaVoidTransform DEFINE_GUIDNAMED(KSPROPSETID_BdaVoidTransform) + +typedef enum { + KSPROPERTY_BDA_VOID_TRANSFORM_START = 0, + KSPROPERTY_BDA_VOID_TRANSFORM_STOP +} KSPROPERTY_BDA_VOID_TRANSFORM; + +#define DEFINE_KSPROPERTY_ITEM_BDA_VOID_TRANSFORM_START(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_VOID_TRANSFORM_START,\ + FALSE,\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_VOID_TRANSFORM_STOP(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_VOID_TRANSFORM_STOP,\ + FALSE,\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// +// BDA Null Transform Property Set +// +// {DDF15B0D-BD25-11d2-9CA0-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaNullTransform \ + 0xddf15b0d, 0xbd25, 0x11d2, 0x9c, 0xa0, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("DDF15B0D-BD25-11d2-9CA0-00C04F7971E0", KSPROPSETID_BdaNullTransform); +#define KSPROPSETID_BdaNullTransform DEFINE_GUIDNAMED(KSPROPSETID_BdaNullTransform) + +typedef enum { + KSPROPERTY_BDA_NULL_TRANSFORM_START = 0, + KSPROPERTY_BDA_NULL_TRANSFORM_STOP +} KSPROPERTY_BDA_NULL_TRANSFORM; + +#define DEFINE_KSPROPERTY_ITEM_BDA_NULL_TRANSFORM_START(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NULL_TRANSFORM_START,\ + FALSE,\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_NULL_TRANSFORM_STOP(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_NULL_TRANSFORM_STOP,\ + FALSE,\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// +// BDA Frequency Filter Property Set +// +// {71985F47-1CA1-11d3-9CC8-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaFrequencyFilter \ + 0x71985f47, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F47-1CA1-11d3-9CC8-00C04F7971E0", KSPROPSETID_BdaFrequencyFilter); +#define KSPROPSETID_BdaFrequencyFilter DEFINE_GUIDNAMED(KSPROPSETID_BdaFrequencyFilter) + +typedef enum { + KSPROPERTY_BDA_RF_TUNER_FREQUENCY = 0, + KSPROPERTY_BDA_RF_TUNER_POLARITY, + KSPROPERTY_BDA_RF_TUNER_RANGE, + KSPROPERTY_BDA_RF_TUNER_TRANSPONDER, + KSPROPERTY_BDA_RF_TUNER_BANDWIDTH, + KSPROPERTY_BDA_RF_TUNER_FREQUENCY_MULTIPLIER, + KSPROPERTY_BDA_RF_TUNER_CAPS, + KSPROPERTY_BDA_RF_TUNER_SCAN_STATUS, + KSPROPERTY_BDA_RF_TUNER_STANDARD, + KSPROPERTY_BDA_RF_TUNER_STANDARD_MODE +} KSPROPERTY_BDA_FREQUENCY_FILTER; + +typedef enum _BdaSignalType { + Bda_SignalType_Unknown = 0, + Bda_SignalType_Analog = 1, + Bda_SignalType_Digital = 2 +} BDA_SignalType; + +// +// The BDA_DigitalSignalStandard enumeration is tentatively put out for Beta review +// Based on feedback, this may be updated or entirely removed in a later release +// +typedef enum +{ + Bda_DigitalStandard_None = 0x00000000, + Bda_DigitalStandard_DVB_T = 0x00000001, + Bda_DigitalStandard_DVB_S = 0x00000002, + Bda_DigitalStandard_DVB_C = 0x00000004, + Bda_DigitalStandard_ATSC = 0x00000008, + Bda_DigitalStandard_ISDB_T = 0x00000010, + Bda_DigitalStandard_ISDB_S = 0x00000020, + Bda_DigitalStandard_ISDB_C = 0x00000040 +} BDA_DigitalSignalStandard; + +typedef struct { + KSP_NODE Property; + ULONG Mode; // IN: KSPROPERTY_TUNER_MODE + ULONG AnalogStandardsSupported; // Bda_AnalogStandard_* (if TV or DSS) + ULONG DigitalStandardsSupported; // Bda_DigitalStandard_* + ULONG MinFrequency; // R - Hz + ULONG MaxFrequency; // R - Hz + ULONG SettlingTime; // R - milliSeconds to settle for any sort of update to the tuner + ULONG AnalogSensingRange; // R - max range (kHz) in which tuner can detect an analog signal + ULONG DigitalSensingRange; // R - max range (kHz) in which tuner can detect an digital signal + ULONG MilliSecondsPerMHz; // R - max time to lock in to a signal 1MHz away assuming the signal has been detected, but its offset is unknown +} KSPROPERTY_BDA_RF_TUNER_CAPS_S, *PKSPROPERTY_BDA_RF_TUNER_CAPS_S; + +typedef struct { + KSP_NODE Property; + ULONG CurrentFrequency; // R - current frequency + ULONG FrequencyRangeMin; // R - lower limit of range left to scan + ULONG FrequencyRangeMax; // R - upper limit of range left to scan + ULONG MilliSecondsLeft; // R - time left to complete scanning +} KSPROPERTY_BDA_RF_TUNER_SCAN_STATUS_S, *PKSPROPERTY_BDA_RF_TUNER_SCAN_STATUS_S; + +typedef struct { + KSP_NODE Property; + BDA_SignalType SignalType; // RW - specifies whether the signal is Analog or Digital. this is required to interpret the SignalStandard field + ULONG SignalStandard; // RW - current signal standard (KS_AnalogVideo_* or Bda_DigitalStandard_*) set by the application or detected by the device +} KSPROPERTY_BDA_RF_TUNER_STANDARD_S, *PKSPROPERTY_BDA_RF_TUNER_STANDARD_S; + +typedef struct { + KSP_NODE Property; + BOOL AutoDetect; // RW - specifies whether the driver is in auto-detect mode for the signal standard +} KSPROPERTY_BDA_RF_TUNER_STANDARD_MODE_S, *PKSPROPERTY_BDA_RF_TUNER_STANDARD_MODE_S; + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_FREQUENCY(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_FREQUENCY,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_POLARITY(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_POLARITY,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_RANGE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_RANGE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_TRANSPONDER(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_TRANSPONDER,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_BANDWIDTH(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_BANDWIDTH,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_RF_TUNER_FREQUENCY_MULTIPLIER(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_RF_TUNER_FREQUENCY_MULTIPLIER,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA Tuner Event Set +// +// {AAB59E17-01C9-4ebf-93F2-FC3B79B46F91} +// +#define STATIC_KSEVENTSETID_BdaTunerEvent \ + 0xaab59e17, 0x1c9, 0x4ebf, 0x93, 0xf2, 0xfc, 0x3b, 0x79, 0xb4, 0x6f, 0x91 +DEFINE_GUIDSTRUCT("AAB59E17-01C9-4ebf-93F2-FC3B79B46F91", KSEVENTSETID_BdaTunerEvent); +#define KSEVENTSETID_BdaTunerEvent DEFINE_GUIDNAMED(KSEVENTSETID_BdaTunerEvent) + +typedef enum { + KSEVENT_BDA_TUNER_SCAN = 0 +} KSEVENT_BDA_TUNER; + +typedef struct { + KSEVENTDATA EventData; + ULONG StartFrequency; // W - initial frequency for the scan + ULONG EndFrequency; // W - final frequency for the scan, can be less than the initial value indicating a "scan down" is requested + BDA_LockType LockRequested; // W - whether the device should look for just a PLL lock, decoder lock, etc. should be a supported lock type. +} KSEVENTDATA_BDA_RF_TUNER_SCAN_S, *PKSEVENTDATA_BDA_RF_TUNER_SCAN_S; + +//------------------------------------------------------------ +// +// +// BDA LNB Info Property Set +// +// {992CF102-49F9-4719-A664-C4F23E2408F4} +// +#define STATIC_KSPROPSETID_BdaLNBInfo \ + 0x992cf102, 0x49f9, 0x4719, 0xa6, 0x64, 0xc4, 0xf2, 0x3e, 0x24, 0x8, 0xf4 +DEFINE_GUIDSTRUCT("992CF102-49F9-4719-A664-C4F23E2408F4", KSPROPSETID_BdaLNBInfo); +#define KSPROPSETID_BdaLNBInfo DEFINE_GUIDNAMED(KSPROPSETID_BdaLNBInfo) + +typedef enum { + KSPROPERTY_BDA_LNB_LOF_LOW_BAND = 0, + KSPROPERTY_BDA_LNB_LOF_HIGH_BAND, + KSPROPERTY_BDA_LNB_SWITCH_FREQUENCY +} KSPROPERTY_BDA_LNB_INFO; + +#define DEFINE_KSPROPERTY_ITEM_BDA_LNB_LOF_LOW_BAND(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_LNB_LOF_LOW_BAND,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_LNB_LOF_HIGH_BAND(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_LNB_LOF_HIGH_BAND,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_LNB_SWITCH_FREQUENCY(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_LNB_SWITCH_FREQUENCY,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +//DiseqC Specific commands and source selection +//DVB-S applications can use the commands to select there LNB Source +//or control there installation equipment (e.g. motor dish, switches) +// +// {F84E2AB0-3C6B-45e3-A0FC-8669D4B81F11} +// +#define STATIC_KSPROPSETID_BdaDiseqCommand \ + 0xf84e2ab0, 0x3c6b, 0x45e3, 0xa0, 0xfc, 0x86, 0x69, 0xd4, 0xb8, 0x1f, 0x11 +DEFINE_GUIDSTRUCT("F84E2AB0-3C6B-45e3-A0FC-8669D4B81F11", KSPROPSETID_BdaDiseqCommand); +#define KSPROPSETID_BdaDiseqCommand DEFINE_GUIDNAMED(KSPROPSETID_BdaDiseqCommand) + +typedef enum { + KSPROPERTY_BDA_DISEQC_ENABLE = 0, + KSPROPERTY_BDA_DISEQC_LNB_SOURCE, + KSPROPERTY_BDA_DISEQC_USETONEBURST, + KSPROPERTY_BDA_DISEQC_REPEATS, + KSPROPERTY_BDA_DISEQC_SEND, + KSPROPERTY_BDA_DISEQC_RESPONSE +} KSPROPERTY_BDA_DISEQC_COMMAND; + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_ENABLE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_ENABLE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BOOL),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_LNB_SOURCE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_LNB_SOURCE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_USETONEBURST(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_USETONEBURST,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BOOL),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_REPEATS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_REPEATS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_SEND(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_SEND,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_DISEQC_SEND),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_DISEQC_RESPONSE(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_DISEQC_RESPONSE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_DISEQC_RESPONSE),\ + NULL,\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA DiseqC Event Set +// +// {8B19BBF0-4184-43ac-AD3C-0C889BE4C212} +// + +#define STATIC_KSEVENTSETID_BdaDiseqCEvent \ + 0x8b19bbf0, 0x4184, 0x43ac, 0xad, 0x3c, 0xc, 0x88, 0x9b, 0xe4, 0xc2, 0x12 +DEFINE_GUIDSTRUCT("8B19BBF0-4184-43ac-AD3C-0C889BE4C212", KSEVENTSETID_BdaDiseqCEvent); +#define KSEVENTSETID_BdaDiseqCEvent DEFINE_GUIDNAMED(KSEVENTSETID_BdaDiseqCEvent) + +typedef enum { + KSEVENT_BDA_DISEQC_DATA_RECEIVED = 0 +} KSPROPERTY_BDA_DISEQC_EVENT; + +#define DEFINE_KSEVENT_BDA_DISEQC_DATA_RECEIVED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_DISEQC_DATA_RECEIVED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +//------------------------------------------------------------ +// +// +// BDA Digital Demodulator Property Set +// +// {EF30F379-985B-4d10-B640-A79D5E04E1E0} +// +#define STATIC_KSPROPSETID_BdaDigitalDemodulator \ + 0xef30f379, 0x985b, 0x4d10, 0xb6, 0x40, 0xa7, 0x9d, 0x5e, 0x4, 0xe1, 0xe0 +DEFINE_GUIDSTRUCT("EF30F379-985B-4d10-B640-A79D5E04E1E0", KSPROPSETID_BdaDigitalDemodulator); +#define KSPROPSETID_BdaDigitalDemodulator DEFINE_GUIDNAMED(KSPROPSETID_BdaDigitalDemodulator) + +typedef enum { + KSPROPERTY_BDA_MODULATION_TYPE = 0, + KSPROPERTY_BDA_INNER_FEC_TYPE, + KSPROPERTY_BDA_INNER_FEC_RATE, + KSPROPERTY_BDA_OUTER_FEC_TYPE, + KSPROPERTY_BDA_OUTER_FEC_RATE, + KSPROPERTY_BDA_SYMBOL_RATE, + KSPROPERTY_BDA_SPECTRAL_INVERSION, + KSPROPERTY_BDA_GUARD_INTERVAL, + KSPROPERTY_BDA_TRANSMISSION_MODE, + KSPROPERTY_BDA_ROLL_OFF, + KSPROPERTY_BDA_PILOT, + KSPROPERTY_BDA_SIGNALTIMEOUTS, + KSPROPERTY_BDA_PLP_NUMBER +} KSPROPERTY_BDA_DIGITAL_DEMODULATOR; + +#define DEFINE_KSPROPERTY_ITEM_BDA_MODULATION_TYPE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_MODULATION_TYPE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ModulationType),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_INNER_FEC_TYPE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_INNER_FEC_TYPE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(FECMethod),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_INNER_FEC_RATE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_INNER_FEC_RATE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BinaryConvolutionCodeRate),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_OUTER_FEC_TYPE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_OUTER_FEC_TYPE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(FECMethod),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_OUTER_FEC_RATE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_OUTER_FEC_RATE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BinaryConvolutionCodeRate),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_SYMBOL_RATE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SYMBOL_RATE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_SPECTRAL_INVERSION(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SPECTRAL_INVERSION,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(SpectralInversion),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_GUARD_INTERVAL(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_GUARD_INTERVAL,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(GuardInterval),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_TRANSMISSION_MODE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_TRANSMISSION_MODE,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(TransmissionMode),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_ROLL_OFF(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_ROLL_OFF,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(RollOff),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PILOT(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PILOT,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(Pilot),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_SIGNALTIMEOUTS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_SIGNALTIMEOUTS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_SIGNAL_TIMEOUTS),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PLP_NUMBER(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PLP_NUMBER,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA Autodemodulate Property Set +// +// {DDF15B12-BD25-11d2-9CA0-00C04F7971E0} +// +#define STATIC_KSPROPSETID_BdaAutodemodulate \ + 0xddf15b12, 0xbd25, 0x11d2, 0x9c, 0xa0, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("DDF15B12-BD25-11d2-9CA0-00C04F7971E0", KSPROPSETID_BdaAutodemodulate); +#define KSPROPSETID_BdaAutodemodulate DEFINE_GUIDNAMED(KSPROPSETID_BdaAutodemodulate) + +typedef enum { + KSPROPERTY_BDA_AUTODEMODULATE_START = 0, + KSPROPERTY_BDA_AUTODEMODULATE_STOP +} KSPROPERTY_BDA_AUTODEMODULATE; + +#define DEFINE_KSPROPERTY_ITEM_BDA_AUTODEMODULATE_START(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_AUTODEMODULATE_START,\ + FALSE,\ + sizeof(KSP_NODE),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_AUTODEMODULATE_STOP(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_AUTODEMODULATE_STOP,\ + FALSE,\ + sizeof(KSP_NODE),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA Table Section Property Set +// +// {516B99C5-971C-4aaf-B3F3-D9FDA8A15E16} +// + +#define STATIC_KSPROPSETID_BdaTableSection \ + 0x516b99c5, 0x971c, 0x4aaf, 0xb3, 0xf3, 0xd9, 0xfd, 0xa8, 0xa1, 0x5e, 0x16 +DEFINE_GUIDSTRUCT("516B99C5-971C-4aaf-B3F3-D9FDA8A15E16", KSPROPSETID_BdaTableSection); +#define KSPROPSETID_BdaTableSection DEFINE_GUIDNAMED(KSPROPSETID_BdaTableSection) + +typedef enum { + KSPROPERTY_BDA_TABLE_SECTION = 0, +} KSPROPERTY_IDS_BDA_TABLE; + +#define DEFINE_KSPROPERTY_ITEM_BDA_TABLE_SECTION(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_TABLE_SECTION,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_TABLE_SECTION),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//------------------------------------------------------------ +// +// +// BDA PID Filter Property Set +// +// {D0A67D65-08DF-4fec-8533-E5B550410B85} +// +#define STATIC_KSPROPSETID_BdaPIDFilter \ + 0xd0a67d65, 0x8df, 0x4fec, 0x85, 0x33, 0xe5, 0xb5, 0x50, 0x41, 0xb, 0x85 +DEFINE_GUIDSTRUCT("D0A67D65-08DF-4fec-8533-E5B550410B85", KSPROPSETID_BdaPIDFilter); +#define KSPROPSETID_BdaPIDFilter DEFINE_GUIDNAMED(KSPROPSETID_BdaPIDFilter) + +typedef enum { + KSPROPERTY_BDA_PIDFILTER_MAP_PIDS = 0, + KSPROPERTY_BDA_PIDFILTER_UNMAP_PIDS, + KSPROPERTY_BDA_PIDFILTER_LIST_PIDS +} KSPROPERTY_BDA_PIDFILTER; + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIDFILTER_MAP_PIDS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIDFILTER_MAP_PIDS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_PID_MAP),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIDFILTER_UNMAP_PIDS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIDFILTER_UNMAP_PIDS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_PID_UNMAP),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_PIDFILTER_LIST_PIDS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_PIDFILTER_LIST_PIDS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + + +//------------------------------------------------------------ +// +// +// BDA CA Property Set +// +// {B0693766-5278-4ec6-B9E1-3CE40560EF5A} +// +#define STATIC_KSPROPSETID_BdaCA \ + 0xb0693766, 0x5278, 0x4ec6, 0xb9, 0xe1, 0x3c, 0xe4, 0x5, 0x60, 0xef, 0x5a +DEFINE_GUIDSTRUCT("B0693766-5278-4ec6-B9E1-3CE40560EF5A", KSPROPSETID_BdaCA); +#define KSPROPSETID_BdaCA DEFINE_GUIDNAMED(KSPROPSETID_BdaCA) + +typedef enum { + KSPROPERTY_BDA_ECM_MAP_STATUS = 0, + KSPROPERTY_BDA_CA_MODULE_STATUS, + KSPROPERTY_BDA_CA_SMART_CARD_STATUS, + KSPROPERTY_BDA_CA_MODULE_UI, + KSPROPERTY_BDA_CA_SET_PROGRAM_PIDS, + KSPROPERTY_BDA_CA_REMOVE_PROGRAM +} KSPROPERTY_BDA_CA; + +#define DEFINE_KSPROPERTY_ITEM_BDA_ECM_MAP_STATUS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_ECM_MAP_STATUS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CA_MODULE_STATUS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CA_MODULE_STATUS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CA_SMART_CARD_STATUS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CA_SMART_CARD_STATUS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CA_MODULE_UI(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CA_MODULE_UI,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_CA_MODULE_UI),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CA_SET_PROGRAM_PIDS(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CA_SET_PROGRAM_PIDS,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_PROGRAM_PID_LIST),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_BDA_CA_REMOVE_PROGRAM(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_BDA_CA_REMOVE_PROGRAM,\ + (GetHandler),\ + sizeof(KSP_NODE),\ + sizeof(ULONG),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + +//------------------------------------------------------------ +// +// +// BDA CA Event Set +// +// {488C4CCC-B768-4129-8EB1-B00A071F9068} +// +#define STATIC_KSEVENTSETID_BdaCAEvent \ + 0x488c4ccc, 0xb768, 0x4129, 0x8e, 0xb1, 0xb0, 0xa, 0x7, 0x1f, 0x90, 0x68 +DEFINE_GUIDSTRUCT("488C4CCC-B768-4129-8EB1-B00A071F9068", KSEVENTSETID_BdaCAEvent); +#define KSEVENTSETID_BdaCAEvent DEFINE_GUIDNAMED(KSEVENTSETID_BdaCAEvent) + +typedef enum { + KSEVENT_BDA_PROGRAM_FLOW_STATUS_CHANGED = 0, + KSEVENT_BDA_CA_MODULE_STATUS_CHANGED, + KSEVENT_BDA_CA_SMART_CARD_STATUS_CHANGED, + KSEVENT_BDA_CA_MODULE_UI_REQUESTED +} KSPROPERTY_BDA_CA_EVENT; + +#define DEFINE_KSEVENT_BDA_PROGRAM_FLOW_STATUS_CHANGED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_PROGRAM_FLOW_STATUS_CHANGED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +#define DEFINE_KSEVENT_BDA_CA_MODULE_STATUS_CHANGED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_CA_MODULE_STATUS_CHANGED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +#define DEFINE_KSEVENT_BDA_CA_SMART_CARD_STATUS_CHANGED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_CA_SMART_CARD_STATUS_CHANGED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +#define DEFINE_KSEVENT_BDA_CA_MODULE_UI_REQUESTED(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_CA_MODULE_UI_REQUESTED,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +//------------------------------------------------------------ +// +// +// BdaDrmService Method Set +// +// {BFF6B5BB-B0AE-484c-9DCA-73528FB0B46E} +// +#define STATIC_KSMETHODSETID_BdaDrmService \ + 0xbff6b5bb, 0xb0ae, 0x484c, 0x9d, 0xca, 0x73, 0x52, 0x8f, 0xb0, 0xb4, 0x6e +DEFINE_GUIDSTRUCT("BFF6B5BB-B0AE-484c-9DCA-73528FB0B46E", KSMETHODSETID_BdaDrmService); +#define KSMETHODSETID_BdaDrmService DEFINE_GUIDNAMED(KSMETHODSETID_BdaDrmService) + +typedef enum { + KSMETHOD_BDA_DRM_CURRENT = 0, + KSMETHOD_BDA_DRM_DRMSTATUS + } KSMETHOD_BDA_DRM; + +#define DEFINE_KSMETHOD_BDA_DRM_SETDRM(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_DRM_CURRENT,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_DRM_SETDRM),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_DRM_DRMSTATUS(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_DRM_DRMSTATUS,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_DRM_DRMSTATUS),\ + SupportHandler) + +//------------------------------------------------------------ +// +// +// PBDA WMDRM SESSION Method Set +// +// {4BE6FA3D-07CD-4139-8B80-8C18BA3AEC88} +// +#define STATIC_KSMETHODSETID_BdaWmdrmSession \ + 0x4be6fa3d, 0x7cd, 0x4139, 0x8b, 0x80, 0x8c, 0x18, 0xba, 0x3a, 0xec, 0x88 +DEFINE_GUIDSTRUCT("4BE6FA3D-07CD-4139-8B80-8C18BA3AEC88", KSMETHODSETID_BdaWmdrmSession); +#define KSMETHODSETID_BdaWmdrmSession DEFINE_GUIDNAMED(KSMETHODSETID_BdaWmdrmSession) + +typedef enum { + KSMETHOD_BDA_WMDRM_STATUS = 0, + KSMETHOD_BDA_WMDRM_REVINFO, + KSMETHOD_BDA_WMDRM_CRL, + KSMETHOD_BDA_WMDRM_MESSAGE, + KSMETHOD_BDA_WMDRM_REISSUELICENSE, + KSMETHOD_BDA_WMDRM_RENEWLICENSE, + KSMETHOD_BDA_WMDRM_LICENSE, + KSMETHOD_BDA_WMDRM_KEYINFO + } KSMETHOD_BDA_WMDRM; + +#define DEFINE_KSMETHOD_BDA_WMDRM_STATUS(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_STATUS,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_WMDRM_STATUS),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_REVINFO(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_REVINFO,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_BUFFER),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_CRL(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_CRL,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_BUFFER),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_TRANSACTMESSAGE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_MESSAGE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_BUFFER),\ + sizeof(BDA_BUFFER),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_REISSUELICENSE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_REISSUELICENSE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRM_LICENSE),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_RENEWLICENSE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_RENEWLICENSE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRM_RENEWLICENSE),\ + sizeof(BDA_WMDRM_RENEWLICENSE),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_GETLICENSE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_LICENSE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRM_LICENSE),\ + sizeof(BDA_BUFFER),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRM_KEYINFO(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRM_KEYINFO,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_WMDRM_KEYINFOLIST),\ + SupportHandler) + +//------------------------------------------------------------ +// +// +// PBDA WMDRM Tuner Method Set +// +// {86D979CF-A8A7-4f94-B5FB-14C0ACA68FE6} +// +#define STATIC_KSMETHODSETID_BdaWmdrmTuner \ + 0x86d979cf, 0xa8a7, 0x4f94, 0xb5, 0xfb, 0x14, 0xc0, 0xac, 0xa6, 0x8f, 0xe6 +DEFINE_GUIDSTRUCT("86D979CF-A8A7-4f94-B5FB-14C0ACA68FE6", KSMETHODSETID_BdaWmdrmTuner); +#define KSMETHODSETID_BdaWmdrmTuner DEFINE_GUIDNAMED(KSMETHODSETID_BdaWmdrmTuner) + +typedef enum { + KSMETHOD_BDA_WMDRMTUNER_CANCELCAPTURETOKEN = 0, + KSMETHOD_BDA_WMDRMTUNER_SETPIDPROTECTION, + KSMETHOD_BDA_WMDRMTUNER_GETPIDPROTECTION, + KSMETHOD_BDA_WMDRMTUNER_SETSYNCVALUE, + KSMETHOD_BDA_WMDRMTUNER_STARTCODEPROFILE, + KSMETHOD_BDA_WMDRMTUNER_PURCHASE_ENTITLEMENT + } KSMETHOD_BDA_WMDRM_TUNER; + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_CANCELCAPTURETOKEN(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_CANCELCAPTURETOKEN,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_BUFFER),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_SETPIDPROTECTION(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_SETPIDPROTECTION,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRMTUNER_SETPIDPROTECTION),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_GETPIDPROTECTION(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_GETPIDPROTECTION,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRMTUNER_GETPIDPROTECTION),\ + sizeof(BDA_WMDRMTUNER_PIDPROTECTION),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_SETSYNCVALUE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_SETSYNCVALUE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRMTUNER_SYNCVALUE),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_STARTCODEPROFILE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_STARTCODEPROFILE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSP_NODE),\ + sizeof(BDA_BUFFER),\ + SupportHandler) + +#define DEFINE_KSMETHOD_BDA_WMDRMTUNER_PURCHASE_ENTITLEMENT(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_WMDRMTUNER_PURCHASE_ENTITLEMENT,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE,\ + (MethodHandler),\ + sizeof(KSM_BDA_WMDRMTUNER_PURCHASEENTITLEMENT),\ + sizeof(BDA_WMDRMTUNER_PURCHASEENTITLEMENT),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA Eventing Service Property Set +// +// {B0693766-5278-4ec6-B9E1-3CE40560EF5A} +// + + +#define STATIC_KSMETHODSETID_BdaEventing \ + 0xf99492da, 0x6193, 0x4eb0, 0x86, 0x90, 0x66, 0x86, 0xcb, 0xff, 0x71, 0x3e +DEFINE_GUIDSTRUCT("f99492da-6193-4eb0-8690-6686cbff713e", KSMETHODSETID_BdaEventing); +#define KSMETHODSETID_BdaEventing DEFINE_GUIDNAMED(KSMETHODSETID_BdaEventing) + +typedef enum { + KSMETHOD_BDA_EVENT_DATA = 0, + KSMETHOD_BDA_EVENT_COMPLETE +} KSMETHOD_BDA_EVENTING_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_EVENT_DATA(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_EVENT_DATA,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_EVENT_DATA),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_EVENT_COMPLETE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_EVENT_COMPLETE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_EVENT_COMPLETE),\ + sizeof(LONG),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA Eventing Service Event +// +// ae7e55b2-96d7-4e29-908f-62f95b2a1679 +// +#define STATIC_KSEVENTSETID_BdaEvent \ + 0xae7e55b2, 0x96d7, 0x4e29, 0x90, 0x8f, 0x62, 0xf9, 0x5b, 0x2a, 0x16, 0x79 +DEFINE_GUIDSTRUCT("ae7e55b2-96d7-4e29-908f-62f95b2a1679", KSEVENTSETID_BdaEvent); +#define KSEVENTSETID_BdaEvent DEFINE_GUIDNAMED(KSEVENTSETID_BdaEvent) + +typedef enum { + KSEVENT_BDA_EVENT_PENDINGEVENT = 0 +} KSEVENT_BDA_EVENT_TYPE; + +#define DEFINE_KSEVENT_ITEM_BDA_PENDINGEVENT(AddHandler, RemoveHandler, SupportHandler)\ + DEFINE_KSEVENT_ITEM(\ + KSEVENT_BDA_EVENT_PENDINGEVENT,\ + sizeof( KSEVENTDATA), \ + 0, \ + (AddHandler),\ + (RemoveHandler),\ + (SupportHandler)\ + ) + +//------------------------------------------------------------ +// +// +// BDA Debug Service Property Set +// +// {0d4a90ec-c69d-4ee2-8c5a-fb1f63a50da1} +// + +#define STATIC_KSMETHODSETID_BdaDebug \ + 0x0d4a90ec, 0xc69d, 0x4ee2, 0x8c, 0x5a, 0xfb, 0x1f, 0x63, 0xa5, 0x0d, 0xa1 +DEFINE_GUIDSTRUCT("0d4a90ec-c69d-4ee2-8c5a-fb1f63a50da1", KSMETHODSETID_BdaDebug); +#define KSMETHODSETID_BdaDebug DEFINE_GUIDNAMED(KSMETHODSETID_BdaDebug) + +typedef enum { + KSMETHOD_BDA_DEBUG_LEVEL = 0, + KSMETHOD_BDA_DEBUG_DATA +} KSMETHOD_BDA_DEBUG_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_DEBUG_LEVEL(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_DEBUG_LEVEL,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_DEBUG_LEVEL),\ + sizeof(LONG),\ + SupportHandler) + + +#define DEFINE_KSMETHOD_ITEM_BDA_DEBUG_DATA(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_DEBUG_DATA,\ + KSMETHOD_TYPE_MODIFY, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + 0,\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA Tuner Service Method Set +// +// {B774102F-AC07-478a-8228-2742D961FA7E} +// + +#define STATIC_KSMETHODSETID_BdaTuner \ + 0xb774102f, 0xac07, 0x478a, 0x82, 0x28, 0x27, 0x42, 0xd9, 0x61, 0xfa, 0x7e +DEFINE_GUIDSTRUCT("b774102f-ac07-478a-8228-2742d961fa7e", KSMETHODSETID_BdaTuner); +#define KSMETHODSETID_BdaTuner DEFINE_GUIDNAMED(KSMETHODSETID_BdaTuner) + +typedef enum { + KSMETHOD_BDA_TUNER_SETTUNER = 0, + KSMETHOD_BDA_TUNER_GETTUNERSTATE, + KSMETHOD_BDA_TUNER_SIGNALNOISERATIO +} KSMETHOD_BDA_TUNER_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_TUNER_SETTUNER(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_TUNER_SETTUNER,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_TUNER_TUNEREQUEST),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_TUNER_GETTUNERSTATE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_TUNER_GETTUNERSTATE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_TUNER_TUNERSTATE),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_TUNER_SIGNALNOISERATIO(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_TUNER_SIGNALNOISERATIO,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_TUNER_DIAGNOSTICS),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA General Purpose Name Value Service Method Set +// +// {0c24096d-5ff5-47de-a856-062e587e3727}//8bit string +// {36e07304-9f0d-4e88-9118-ac0ba317b7f2}//unicode version +// + +#define STATIC_KSMETHODSETID_BdaNameValueA \ + 0xc24096d, 0x5ff5, 0x47de, 0xa8, 0x56, 0x6, 0x2e, 0x58, 0x7e, 0x37, 0x27 +DEFINE_GUIDSTRUCT("0c24096d-5ff5-47de-a856-062e587e3727", KSMETHODSETID_BdaNameValueA); +#define KSMETHODSETID_BdaNameValueA DEFINE_GUIDNAMED(KSMETHODSETID_BdaNameValueA) + +#define STATIC_KSMETHODSETID_BdaNameValue \ + 0x36e07304, 0x9f0d, 0x4e88, 0x91, 0x18, 0xac, 0xb, 0xa3, 0x17, 0xb7, 0xf2 +DEFINE_GUIDSTRUCT("36e07304-9f0d-4e88-9118-ac0ba317b7f2", KSMETHODSETID_BdaNameValue); +#define KSMETHODSETID_BdaNameValue DEFINE_GUIDNAMED(KSMETHODSETID_BdaNameValue) + +typedef enum { + KSMETHOD_BDA_GPNV_GETVALUE = 0, + KSMETHOD_BDA_GPNV_SETVALUE, + KSMETHOD_BDA_GPNV_NAMEFROMINDEX, + KSMETHOD_BDA_GPNV_GETVALUEUPDATENAME +} KSMETHOD_BDA_GPNV_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_GPNV_GETVALUE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GPNV_GETVALUE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_GPNV_GETVALUE),\ + sizeof(BDA_STRING),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GPNV_SETVALUE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GPNV_SETVALUE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_GPNV_SETVALUE),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GPNV_NAMEFROMINDEX(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GPNV_NAMEFROMINDEX,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_GPNV_NAMEINDEX),\ + sizeof(BDA_STRING),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GPNV_GETVALUEUPDATENAME(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GPNV_GETVALUEUPDATENAME,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_STRING),\ + SupportHandler) + + + +//------------------------------------------------------------ +// +// +// BDA Mux Service Method Set +// +// {942AAFEC-4C05-4c74-B8EB-8706C2A4943F} +// + +#define STATIC_KSMETHODSETID_BdaMux \ + 0x942aafec, 0x4c05, 0x4c74, 0xb8, 0xeb, 0x87, 0x6, 0xc2, 0xa4, 0x94, 0x3f +DEFINE_GUIDSTRUCT("942AAFEC-4C05-4c74-B8EB-8706C2A4943F", KSMETHODSETID_BdaMux); +#define KSMETHODSETID_BdaMux DEFINE_GUIDNAMED(KSMETHODSETID_BdaMux) + +typedef enum { + KSMETHOD_BDA_MUX_GETPIDLIST = 0, + KSMETHOD_BDA_MUX_SETPIDLIST +} KSMETHOD_BDA_MUX_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_MUX_GETPIDLIST(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_MUX_GETPIDLIST,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_BUFFER),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_MUX_SETPIDLIST(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_MUX_SETPIDLIST,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_BUFFER),\ + sizeof(PBDARESULT),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA Scanning Service Method Set +// +// {12EB49DF-6249-47f3-B190-E21E6E2F8A9C} +// + +#define STATIC_KSMETHODSETID_BdaScanning \ + 0x12eb49df, 0x6249, 0x47f3, 0xb1, 0x90, 0xe2, 0x1e, 0x6e, 0x2f, 0x8a, 0x9c +DEFINE_GUIDSTRUCT("12EB49DF-6249-47f3-B190-E21E6E2F8A9C", KSMETHODSETID_BdaScanning); +#define KSMETHODSETID_BdaScanning DEFINE_GUIDNAMED(KSMETHODSETID_BdaScanning) + +typedef enum { + KSMETHOD_BDA_SCAN_CAPABILTIES = 0, + KSMETHOD_BDA_SCANNING_STATE, + KSMETHOD_BDA_SCAN_FILTER, + KSMETHOD_BDA_SCAN_START, + KSMETHOD_BDA_SCAN_RESUME, + KSMETHOD_BDA_SCAN_STOP +} KSMETHOD_BDA_SCAN_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_SCAN_CAPABILTIES(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCAN_CAPABILTIES,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_SCAN_CAPABILTIES),\ + sizeof(BDA_SCAN_CAPABILTIES),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_SCANNING_STATE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCANNING_STATE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_SCAN_STATE),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_SCAN_FILTER(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCAN_FILTER,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_SCAN_FILTER),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_SCAN_START(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCAN_START,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_SCAN_START),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_SCAN_RESUME(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCAN_RESUME,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_SCAN_STOP(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_SCAN_STOP,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(PBDARESULT),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA Guide Data Delivery Service Method Set +// +// {8D9D5562-1589-417d-99CE-AC531DDA19F9} +// + +#define STATIC_KSMETHODSETID_BdaGuideDataDeliveryService \ + 0x8d9d5562, 0x1589, 0x417d, 0x99, 0xce, 0xac, 0x53, 0x1d, 0xda, 0x19, 0xf9 +DEFINE_GUIDSTRUCT("8D9D5562-1589-417d-99CE-AC531DDA19F9", KSMETHODSETID_BdaGuideDataDeliveryService); +#define KSMETHODSETID_BdaGuideDataDeliveryService DEFINE_GUIDNAMED(KSMETHODSETID_BdaGuideDataDeliveryService) + +typedef enum { + KSMETHOD_BDA_GDDS_DATATYPE = 0, + KSMETHOD_BDA_GDDS_DATA, + KSMETHOD_BDA_GDDS_TUNEXMLFROMIDX, + KSMETHOD_BDA_GDDS_GETSERVICES, + KSMETHOD_BDA_GDDS_SERVICEFROMTUNEXML, + KSMETHOD_BDA_GDDS_DATAUPDATE +} KSMETHOD_BDA_GDDS_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_DATATYPE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_DATATYPE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_GDDS_DATATYPE),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_DATA(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_DATA,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_GDDS_DATA),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_TUNEXMLFROMIDX(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_TUNEXMLFROMIDX,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_GDDS_TUNEXMLFROMIDX),\ + sizeof(BDA_STRING),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_GETSERVICES(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_GETSERVICES,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_BUFFER),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_SERVICEFROMTUNEXML(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_SERVICEFROMTUNEXML,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_GDDS_SERVICEFROMTUNEXML),\ + sizeof(BDA_STRING),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_GDDS_DATAUPDATE(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_GDDS_DATAUPDATE,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(PBDARESULT),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA CAS Core Service Method Set +// +// {10CED3B4-320B-41bf-9824-1B2E68E71EB9} +// + +#define STATIC_KSMETHODSETID_BdaConditionalAccessService \ + 0x10ced3b4, 0x320b, 0x41bf, 0x98, 0x24, 0x1b, 0x2e, 0x68, 0xe7, 0x1e, 0xb9 +DEFINE_GUIDSTRUCT("10CED3B4-320B-41bf-9824-1B2E68E71EB9", KSMETHODSETID_BdaConditionalAccessService); +#define KSMETHODSETID_BdaConditionalAccessService DEFINE_GUIDNAMED(KSMETHODSETID_BdaConditionalAccessService) + +typedef enum { + KSMETHOD_BDA_CAS_CHECKENTITLEMENTTOKEN = 0, + KSMETHOD_BDA_CAS_SETCAPTURETOKEN, + KSMETHOD_BDA_CAS_OPENBROADCASTMMI, + KSMETHOD_BDA_CAS_CLOSEMMIDIALOG +} KSMETHOD_BDA_CAS_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_CAS_CHECKENTITLEMENTTOKEN(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CAS_CHECKENTITLEMENTTOKEN,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_CAS_ENTITLEMENTTOKEN),\ + sizeof(BDA_CAS_CHECK_ENTITLEMENTTOKEN),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_CAS_SETCAPTURETOKEN(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CAS_SETCAPTURETOKEN,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_CAS_CAPTURETOKEN),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_CAS_OPENBROADCASTMMI(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CAS_OPENBROADCASTMMI,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_CAS_OPENBROADCASTMMI),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_CAS_CLOSEMMIDIALOG(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_CAS_CLOSEMMIDIALOG,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_CAS_CLOSEMMIDIALOG),\ + sizeof(BDA_CAS_CLOSE_MMIDIALOG),\ + SupportHandler) + + +//------------------------------------------------------------ +// +// +// BDA ISDB CAS Service Method Set +// +// {5E68C627-16C2-4e6c-B1E2-D00170CDAA0F} +// + +#define STATIC_KSMETHODSETID_BdaIsdbConditionalAccess \ + 0x5e68c627, 0x16c2, 0x4e6c, 0xb1, 0xe2, 0xd0, 0x1, 0x70, 0xcd, 0xaa, 0xf +DEFINE_GUIDSTRUCT("5E68C627-16C2-4e6c-B1E2-D00170CDAA0F", KSMETHODSETID_BdaIsdbConditionalAccess); +#define KSMETHODSETID_BdaIsdbConditionalAccess DEFINE_GUIDNAMED(KSMETHODSETID_BdaIsdbConditionalAccess) + +typedef enum { + KSMETHOD_BDA_ISDBCAS_SETREQUEST = 0, + KSMETHOD_BDA_ISDBCAS_RESPONSEDATA +} KSMETHOD_BDA_ISDB_CAS; + +#define DEFINE_KSMETHOD_ITEM_BDA_ISDBCAS_SETREQUEST(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_ISDBCAS_SETREQUEST,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_ISDBCAS_REQUEST),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_ISDBCAS_RESPONSEDATA(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_ISDBCAS_RESPONSEDATA,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_ISDBCAS_RESPONSEDATA),\ + SupportHandler) + +//------------------------------------------------------------ +// +// +// BDA Transprt Stream Selector Service Method Set +// +// {1DCFAFE9-B45E-41b3-BB2A-561EB129AE98} +// + +#define STATIC_KSMETHODSETID_BdaTSSelector \ + 0x1dcfafe9, 0xb45e, 0x41b3, 0xbb, 0x2a, 0x56, 0x1e, 0xb1, 0x29, 0xae, 0x98 +DEFINE_GUIDSTRUCT("1DCFAFE9-B45E-41b3-BB2A-561EB129AE98", KSMETHODSETID_BdaTSSelector); +#define KSMETHODSETID_BdaTSSelector DEFINE_GUIDNAMED(KSMETHODSETID_BdaTSSelector) + +typedef enum { + KSMETHOD_BDA_TS_SELECTOR_SETTSID = 0, + KSMETHOD_BDA_TS_SELECTOR_GETTSINFORMATION, +} KSMETHOD_BDA_TS_SELECTOR; + +#define DEFINE_KSMETHOD_ITEM_BDA_TS_SELECTOR_SETTSID(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_TS_SELECTOR_SETTSID,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_TS_SELECTOR_SETTSID),\ + sizeof(ULONG),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_TS_SELECTOR_GETTSINFORMATION(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_TS_SELECTOR_GETTSINFORMATION,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_NODE),\ + sizeof(BDA_TS_SELECTORINFO),\ + SupportHandler) + +//------------------------------------------------------------ +// +// +// BDA User Activity Service Method Set +// +// {EDA5C834-4531-483c-BE0A-94E6C96FF396} +// + +#define STATIC_KSMETHODSETID_BdaUserActivity \ + 0xeda5c834, 0x4531, 0x483c, 0xbe, 0xa, 0x94, 0xe6, 0xc9, 0x6f, 0xf3, 0x96 +DEFINE_GUIDSTRUCT("EDA5C834-4531-483c-BE0A-94E6C96FF396", KSMETHODSETID_BdaUserActivity); +#define KSMETHODSETID_BdaUserActivity DEFINE_GUIDNAMED(KSMETHODSETID_BdaUserActivity) + +typedef enum { + KSMETHOD_BDA_USERACTIVITY_USEREASON = 0, + KSMETHOD_BDA_USERACTIVITY_INTERVAL, + KSMETHOD_BDA_USERACTIVITY_DETECTED +} KSMETHOD_BDA_USERACTIVITY_SERVICE; + +#define DEFINE_KSMETHOD_ITEM_BDA_USERACTIVITY_USEREASON(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_USERACTIVITY_USEREASON,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSM_BDA_USERACTIVITY_USEREASON),\ + sizeof(PBDARESULT),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_USERACTIVITY_INTERVAL(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_USERACTIVITY_INTERVAL,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(BDA_USERACTIVITY_INTERVAL),\ + SupportHandler) + +#define DEFINE_KSMETHOD_ITEM_BDA_USERACTIVITY_DETECTED(MethodHandler, SupportHandler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_BDA_USERACTIVITY_DETECTED,\ + KSMETHOD_TYPE_MODIFY | KSMETHOD_TYPE_SOURCE, \ + (MethodHandler),\ + sizeof(KSMETHOD),\ + sizeof(PBDARESULT),\ + SupportHandler) + +//=========================================================================== +// +// BDA Filter Categories +// +//=========================================================================== + +#define STATIC_KSCATEGORY_BDA_RECEIVER_COMPONENT \ + 0xFD0A5AF4, 0xB41D, 0x11d2, 0x9c, 0x95, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("FD0A5AF4-B41D-11d2-9C95-00C04F7971E0", KSCATEGORY_BDA_RECEIVER_COMPONENT); +#define KSCATEGORY_BDA_RECEIVER_COMPONENT DEFINE_GUIDNAMED(KSCATEGORY_BDA_RECEIVER_COMPONENT) + + +#define STATIC_KSCATEGORY_BDA_NETWORK_TUNER \ + 0x71985f48, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F48-1CA1-11d3-9CC8-00C04F7971E0", KSCATEGORY_BDA_NETWORK_TUNER); +#define KSCATEGORY_BDA_NETWORK_TUNER DEFINE_GUIDNAMED(KSCATEGORY_BDA_NETWORK_TUNER) + + +#define STATIC_KSCATEGORY_BDA_NETWORK_EPG \ + 0x71985f49, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F49-1CA1-11d3-9CC8-00C04F7971E0", KSCATEGORY_BDA_NETWORK_EPG); +#define KSCATEGORY_BDA_NETWORK_EPG DEFINE_GUIDNAMED(KSCATEGORY_BDA_NETWORK_EPG) + + +#define STATIC_KSCATEGORY_BDA_IP_SINK \ + 0x71985f4aL, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x00, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4A-1CA1-11d3-9CC8-00C04F7971E0", KSCATEGORY_BDA_IP_SINK); +#define KSCATEGORY_IP_SINK DEFINE_GUIDNAMED(KSCATEGORY_BDA_IP_SINK) + + +#define STATIC_KSCATEGORY_BDA_NETWORK_PROVIDER \ + 0x71985f4b, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4B-1CA1-11d3-9CC8-00C04F7971E0", KSCATEGORY_BDA_NETWORK_PROVIDER); +#define KSCATEGORY_BDA_NETWORK_PROVIDER DEFINE_GUIDNAMED(KSCATEGORY_BDA_NETWORK_PROVIDER) + +// {A2E3074F-6C3D-11d3-B653-00C04F79498E} +#define STATIC_KSCATEGORY_BDA_TRANSPORT_INFORMATION \ + 0xa2e3074f, 0x6c3d, 0x11d3, 0xb6, 0x53, 0x0, 0xc0, 0x4f, 0x79, 0x49, 0x8e +DEFINE_GUIDSTRUCT("A2E3074F-6C3D-11d3-B653-00C04F79498E", KSCATEGORY_BDA_TRANSPORT_INFORMATION); +#define KSCATEGORY_BDA_TRANSPORT_INFORMATION DEFINE_GUIDNAMED(KSCATEGORY_BDA_TRANSPORT_INFORMATION) + +//=========================================================================== +// +// BDA Node Categories +// +//=========================================================================== + +// +// Typical usage of the node categories to define supported tuner device standards. +// +// Analog (only) +// KSNODE_BDA_RF_TUNER +// +// ATSC (only): +// KSNODE_BDA_8VSB_DEMODULATOR node +// +// DVB-T (only): +// KSNODE_BDA_COFDM_DEMODULATOR +// +// DVB-S (only) +// KSNODE_BDA_QPSK_DEMODULATOR +// +// DVB-S2 (only) +// KSNODE_BDA_8PSK_DEMODULATOR +// +// Digital Cable (both DVB-C and US): +// KSNODE_BDA_QAM_DEMODULATOR node +// +// Hybrid Analog/ATSC: +// KSNODE_BDA_RF_TUNER & KSNODE_BDA_8VSB_DEMODULATOR nodes +// +// Hybrid Analog/Digital Cable: +// KSNODE_BDA_RF_TUNER & KSNODE_BDA_QAM_DEMODULATOR nodes +// +// Hybrid Analog and Digital Cable w/ CableCard: +// KSNODE_BDA_RF_TUNER & KSNODE_BDA_QAM_DEMODULATOR & KSNODE_BDA_OPENCABLE_POD nodes +// +// Hybrid Analog and DVB-T: +// KSNODE_BDA_RF_TUNER & KSNODE_BDA_COFDM_DEMODULATOR +// +// ISDB-S (only) +// KSNODE_BDA_ISDB_S_DEMODULATOR & KSNODE_BDA_TS_SELECTOR +// + +#define STATIC_KSNODE_BDA_RF_TUNER \ + 0x71985f4c, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4C-1CA1-11d3-9CC8-00C04F7971E0", KSNODE_BDA_RF_TUNER); +#define KSNODE_BDA_RF_TUNER DEFINE_GUIDNAMED(KSNODE_BDA_RF_TUNER) + +#define STATIC_KSNODE_BDA_ANALOG_DEMODULATOR \ + 0x634db199, 0x27dd, 0x46b8, 0xac, 0xfb, 0xec, 0xc9, 0x8e, 0x61, 0xa2, 0xad +DEFINE_GUIDSTRUCT("634DB199-27DD-46b8-ACFB-ECC98E61A2AD", KSNODE_BDA_ANALOG_DEMODULATOR); +#define KSNODE_BDA_ANALOG_DEMODULATOR DEFINE_GUIDNAMED( KSNODE_BDA_ANALOG_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_QAM_DEMODULATOR \ + 0x71985f4d, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4D-1CA1-11d3-9CC8-00C04F7971E0", KSNODE_BDA_QAM_DEMODULATOR); +#define KSNODE_BDA_QAM_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_QAM_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_QPSK_DEMODULATOR \ + 0x6390c905, 0x27c1, 0x4d67, 0xbd, 0xb7, 0x77, 0xc5, 0xd, 0x7, 0x93, 0x0 +DEFINE_GUIDSTRUCT("6390C905-27C1-4d67-BDB7-77C50D079300", KSNODE_BDA_QPSK_DEMODULATOR); +#define KSNODE_BDA_QPSK_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_QPSK_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_8VSB_DEMODULATOR \ + 0x71985f4f, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4F-1CA1-11d3-9CC8-00C04F7971E0", KSNODE_BDA_8VSB_DEMODULATOR); +#define KSNODE_BDA_8VSB_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_8VSB_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_COFDM_DEMODULATOR \ + 0x2dac6e05, 0xedbe, 0x4b9c, 0xb3, 0x87, 0x1b, 0x6f, 0xad, 0x7d, 0x64, 0x95 +DEFINE_GUIDSTRUCT("2DAC6E05-EDBE-4b9c-B387-1B6FAD7D6495", KSNODE_BDA_COFDM_DEMODULATOR); +#define KSNODE_BDA_COFDM_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_COFDM_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_8PSK_DEMODULATOR \ + 0xe957a0e7, 0xdd98, 0x4a3c, 0x81, 0x0b, 0x35, 0x25, 0x15, 0x7a, 0xb6, 0x2e +DEFINE_GUIDSTRUCT("E957A0E7-DD98-4A3C-810B-3525157AB62E", KSNODE_BDA_8PSK_DEMODULATOR); +#define KSNODE_BDA_8PSK_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_8PSK_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_ISDB_T_DEMODULATOR \ + 0xfcea3ae3, 0x2cb2, 0x464d, 0x8f, 0x5d, 0x30, 0x5c, 0x0b, 0xb7, 0x78, 0xa2 + DEFINE_GUIDSTRUCT("fcea3ae3-2cb2-464d-8f5d-305c0bb778a2", KSNODE_BDA_ISDB_T_DEMODULATOR); +#define KSNODE_BDA_ISDB_T_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_ISDB_T_DEMODULATOR) + +#define STATIC_KSNODE_BDA_ISDB_S_DEMODULATOR \ + 0xedde230a, 0x9086, 0x432d, 0xb8, 0xa5, 0x66, 0x70, 0x26, 0x38, 0x07, 0xe9 + DEFINE_GUIDSTRUCT("edde230a-9086-432d-b8a5-6670263807e9", KSNODE_BDA_ISDB_S_DEMODULATOR); +#define KSNODE_BDA_ISDB_S_DEMODULATOR DEFINE_GUIDNAMED(KSNODE_BDA_ISDB_S_DEMODULATOR) + + +#define STATIC_KSNODE_BDA_OPENCABLE_POD \ + 0x345812a0, 0xfb7c, 0x4790, 0xaa, 0x7e, 0xb1, 0xdb, 0x88, 0xac, 0x19, 0xc9 +DEFINE_GUIDSTRUCT("345812A0-FB7C-4790-AA7E-B1DB88AC19C9", KSNODE_BDA_OPENCABLE_POD); +#define KSNODE_BDA_OPENCABLE_POD DEFINE_GUIDNAMED(KSNODE_BDA_OPENCABLE_POD) + +#define STATIC_KSNODE_BDA_COMMON_CA_POD \ + 0xd83ef8fc, 0xf3b8, 0x45ab, 0x8b, 0x71, 0xec, 0xf7, 0xc3, 0x39, 0xde, 0xb4 +DEFINE_GUIDSTRUCT("D83EF8FC-F3B8-45ab-8B71-ECF7C339DEB4", KSNODE_BDA_COMMON_CA_POD); +#define KSNODE_BDA_COMMON_CA_POD DEFINE_GUIDNAMED(KSNODE_BDA_COMMON_CA_POD) + + +#define STATIC_KSNODE_BDA_PID_FILTER \ + 0xf5412789, 0xb0a0, 0x44e1, 0xae, 0x4f, 0xee, 0x99, 0x9b, 0x1b, 0x7f, 0xbe +DEFINE_GUIDSTRUCT("F5412789-B0A0-44e1-AE4F-EE999B1B7FBE", KSNODE_BDA_PID_FILTER); +#define KSNODE_BDA_PID_FILTER DEFINE_GUIDNAMED(KSNODE_BDA_PID_FILTER) + + +#define STATIC_KSNODE_BDA_IP_SINK \ + 0x71985f4e, 0x1ca1, 0x11d3, 0x9c, 0xc8, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe0 +DEFINE_GUIDSTRUCT("71985F4E-1CA1-11d3-9CC8-00C04F7971E0", KSNODE_BDA_IP_SINK); +#define KSNODE_IP_SINK DEFINE_GUIDNAMED(KSNODE_BDA_IP_SINK) + +#define STATIC_KSNODE_BDA_VIDEO_ENCODER \ + 0xd98429e3, 0x65c9, 0x4ac4, 0x93, 0xaa, 0x76, 0x67, 0x82, 0x83, 0x3b, 0x7a +DEFINE_GUIDSTRUCT("d98429e3-65c9-4ac4-93aa-766782833b7a", KSNODE_BDA_VIDEO_ENCODER); +#define KSNODE_BDA_VIDEO_ENCODER DEFINE_GUIDNAMED(KSNODE_BDA_VIDEO_ENCODER) + +#define STATIC_KSNODE_BDA_PBDA_CAS \ + 0xc026869f, 0x7129, 0x4e71, 0x86, 0x96, 0xec, 0x8f, 0x75, 0x29, 0x9b, 0x77 +DEFINE_GUIDSTRUCT("C026869F-7129-4e71-8696-EC8F75299B77", KSNODE_BDA_PBDA_CAS); +#define KSNODE_BDA_PBDA_CAS DEFINE_GUIDNAMED(KSNODE_BDA_PBDA_CAS) + +#define STATIC_KSNODE_BDA_PBDA_ISDBCAS \ + 0xf2cf2ab3, 0x5b9d, 0x40ae, 0xab, 0x7c, 0x4e, 0x7a, 0xd0, 0xbd, 0x1c, 0x52 +DEFINE_GUIDSTRUCT("F2CF2AB3-5B9D-40ae-AB7C-4E7AD0BD1C52", KSNODE_BDA_PBDA_ISDBCAS); +#define KSNODE_BDA_PBDA_ISDBCAS DEFINE_GUIDNAMED(KSNODE_BDA_PBDA_ISDBCAS) + +#define STATIC_KSNODE_BDA_PBDA_TUNER \ + 0xaa5e8286, 0x593c, 0x4979, 0x94, 0x94, 0x46, 0xa2, 0xa9, 0xdf, 0xe0, 0x76 +DEFINE_GUIDSTRUCT("AA5E8286-593C-4979-9494-46A2A9DFE076", KSNODE_BDA_PBDA_TUNER); +#define KSNODE_BDA_PBDA_TUNER DEFINE_GUIDNAMED(KSNODE_BDA_PBDA_TUNER) + +#define STATIC_KSNODE_BDA_PBDA_MUX \ + 0xf88c7787, 0x6678, 0x4f4b, 0xa1, 0x3e, 0xda, 0x9, 0x86, 0x1d, 0x68, 0x2b +DEFINE_GUIDSTRUCT("F88C7787-6678-4f4b-A13E-DA09861D682B", KSNODE_BDA_PBDA_MUX); +#define KSNODE_BDA_PBDA_MUX DEFINE_GUIDNAMED(KSNODE_BDA_PBDA_MUX) + +#define STATIC_KSNODE_BDA_PBDA_DRM \ + 0x9eeebd03, 0xeea1, 0x450f, 0x96, 0xae, 0x63, 0x3e, 0x6d, 0xe6, 0x3c, 0xce +DEFINE_GUIDSTRUCT("9EEEBD03-EEA1-450f-96AE-633E6DE63CCE", KSNODE_BDA_PBDA_DRM); +#define KSNODE_BDA_PBDA_DRM DEFINE_GUIDNAMED(KSNODE_BDA_PBDA_DRM) + +#define STATIC_KSNODE_BDA_DRI_DRM \ + 0x4f95ad74, 0xcefb, 0x42d2, 0x94, 0xa9, 0x68, 0xc5, 0xb2, 0xc1, 0xaa, 0xbe +DEFINE_GUIDSTRUCT("4F95AD74-CEFB-42d2-94A9-68C5B2C1AABE", KSNODE_BDA_DRI_DRM); +#define KSNODE_BDA_DRI_DRM DEFINE_GUIDNAMED(KSNODE_BDA_DRI_DRM) + +#define STATIC_KSNODE_BDA_TS_SELECTOR \ + 0x5eddf185, 0xfed1, 0x4f45, 0x96, 0x85, 0xbb, 0xb7, 0x3c, 0x32, 0x3c, 0xfc +DEFINE_GUIDSTRUCT("5EDDF185-FED1-4f45-9685-BBB73C323CFC", KSNODE_BDA_TS_SELECTOR); +#define KSNODE_BDA_TS_SELECTOR DEFINE_GUIDNAMED(KSNODE_BDA_TS_SELECTOR) + + +//=========================================================================== +// +// IPSink PINNAME GUID +// +//=========================================================================== + +#define STATIC_PINNAME_IPSINK_INPUT \ + 0x3fdffa70L, 0xac9a, 0x11d2, 0x8f, 0x17, 0x00, 0xc0, 0x4f, 0x79, 0x71, 0xe2 +DEFINE_GUIDSTRUCT("3fdffa70-ac9a-11d2-8f17-00c04f7971e2", PINNAME_IPSINK_INPUT); +#define PINNAME_IPSINK_INPUT DEFINE_GUIDNAMED(PINNAME_IPSINK_INPUT) + + +//=========================================================================== +// +// BDA IPSink Categories/Types +// +//=========================================================================== + + +#define STATIC_KSDATAFORMAT_TYPE_BDA_IP\ + 0xe25f7b8e, 0xcccc, 0x11d2, 0x8f, 0x25, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe2 +DEFINE_GUIDSTRUCT("e25f7b8e-cccc-11d2-8f25-00c04f7971e2", KSDATAFORMAT_TYPE_BDA_IP); +#define KSDATAFORMAT_TYPE_BDA_IP DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_BDA_IP) + +#define STATIC_KSDATAFORMAT_SUBTYPE_BDA_IP\ + 0x5a9a213c, 0xdb08, 0x11d2, 0x8f, 0x32, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe2 +DEFINE_GUIDSTRUCT("5a9a213c-db08-11d2-8f32-00c04f7971e2", KSDATAFORMAT_SUBTYPE_BDA_IP); +#define KSDATAFORMAT_SUBTYPE_BDA_IP DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_BDA_IP) + +#define STATIC_KSDATAFORMAT_SPECIFIER_BDA_IP\ + 0x6b891420, 0xdb09, 0x11d2, 0x8f, 0x32, 0x0, 0xc0, 0x4f, 0x79, 0x71, 0xe2 +DEFINE_GUIDSTRUCT("6B891420-DB09-11d2-8F32-00C04F7971E2", KSDATAFORMAT_SPECIFIER_BDA_IP); +#define KSDATAFORMAT_SPECIFIER_BDA_IP DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_BDA_IP) + + + +#define STATIC_KSDATAFORMAT_TYPE_BDA_IP_CONTROL\ + 0xdadd5799, 0x7d5b, 0x4b63, 0x80, 0xfb, 0xd1, 0x44, 0x2f, 0x26, 0xb6, 0x21 +DEFINE_GUIDSTRUCT("DADD5799-7D5B-4b63-80FB-D1442F26B621", KSDATAFORMAT_TYPE_BDA_IP_CONTROL); +#define KSDATAFORMAT_TYPE_BDA_IP_CONTROL DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_BDA_IP_CONTROL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_BDA_IP_CONTROL\ + 0x499856e8, 0xe85b, 0x48ed, 0x9b, 0xea, 0x41, 0xd, 0xd, 0xd4, 0xef, 0x81 +DEFINE_GUIDSTRUCT("499856E8-E85B-48ed-9BEA-410D0DD4EF81", KSDATAFORMAT_SUBTYPE_BDA_IP_CONTROL); +#define KSDATAFORMAT_SUBTYPE_BDA_IP_CONTROL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_BDA_IP_CONTROL) + + +//=========================================================================== +// +// MPE PINNAME GUID +// +//=========================================================================== + +#define STATIC_PINNAME_MPE \ + 0xc1b06d73L, 0x1dbb, 0x11d3, 0x8f, 0x46, 0x00, 0xC0, 0x4f, 0x79, 0x71, 0xE2 +DEFINE_GUIDSTRUCT("C1B06D73-1DBB-11d3-8F46-00C04F7971E2", PINNAME_MPE); +#define PINNAME_MPE DEFINE_GUIDNAMED(PINNAME_MPE) + + +///////////////////////////////////////////////////////////// +// +// BDA MPE Categories/Types +// +#define STATIC_KSDATAFORMAT_TYPE_MPE \ + 0x455f176c, 0x4b06, 0x47ce, 0x9a, 0xef, 0x8c, 0xae, 0xf7, 0x3d, 0xf7, 0xb5 +DEFINE_GUIDSTRUCT("455F176C-4B06-47ce-9AEF-8CAEF73DF7B5", KSDATAFORMAT_TYPE_MPE); +#define KSDATAFORMAT_TYPE_MPE DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MPE) + + +//=========================================================================== +// +// BDA NETWORK TYPE GUID +// +//=========================================================================== + +#define STATIC_DIGITAL_CABLE_NETWORK_TYPE \ + 0x143827AB, 0xF77B, 0x498d, 0x81, 0xCA, 0x5A, 0x00, 0x7A, 0xEC, 0x28, 0xBF +DEFINE_GUIDSTRUCT("143827AB-F77B-498d-81CA-5A007AEC28BF", DIGITAL_CABLE_NETWORK_TYPE); +#define DIGITAL_CABLE_NETWORK_TYPE DEFINE_GUIDNAMED(DIGITAL_CABLE_NETWORK_TYPE) + +#define STATIC_ANALOG_TV_NETWORK_TYPE \ + 0xb820d87e, 0xe0e3, 0x478f, 0x8a, 0x38, 0x4e, 0x13, 0xf7, 0xb3, 0xdf, 0x42 +DEFINE_GUIDSTRUCT("B820D87E-E0E3-478f-8A38-4E13F7B3DF42", ANALOG_TV_NETWORK_TYPE); +#define ANALOG_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ANALOG_TV_NETWORK_TYPE) + +#define STATIC_ANALOG_AUXIN_NETWORK_TYPE \ + 0x742EF867, 0x9E1, 0x40A3, 0x82, 0xD3, 0x96, 0x69, 0xBA, 0x35, 0x32, 0x5F +DEFINE_GUIDSTRUCT("742EF867-09E1-40A3-82D3-9669BA35325F", ANALOG_AUXIN_NETWORK_TYPE); +#define ANALOG_AUXIN_NETWORK_TYPE DEFINE_GUIDNAMED(ANALOG_AUXIN_NETWORK_TYPE) + +#define STATIC_ANALOG_FM_NETWORK_TYPE \ + 0x7728087b, 0x2bb9, 0x4e30, 0x80, 0x78, 0x44, 0x94, 0x76, 0xe5, 0x9d, 0xbb +DEFINE_GUIDSTRUCT("7728087B-2BB9-4E30-8078-449476E59DBB", ANALOG_FM_NETWORK_TYPE); +#define ANALOG_FM_NETWORK_TYPE DEFINE_GUIDNAMED(ANALOG_FM_NETWORK_TYPE) + +#define STATIC_ISDB_TERRESTRIAL_TV_NETWORK_TYPE \ + 0x95037f6f, 0x3ac7, 0x4452, 0xb6, 0xc4, 0x45, 0xa9, 0xce, 0x92, 0x92, 0xa2 +DEFINE_GUIDSTRUCT("95037F6F-3AC7-4452-B6C4-45A9CE9292A2", ISDB_TERRESTRIAL_TV_NETWORK_TYPE); +#define ISDB_TERRESTRIAL_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ISDB_TERRESTRIAL_TV_NETWORK_TYPE) +#define STATIC_ISDB_T_NETWORK_TYPE \ + 0xfc3855a6, 0xc901, 0x4f2e, 0xab, 0xa8, 0x90, 0x81, 0x5a, 0xfc, 0x6c, 0x83 +DEFINE_GUIDSTRUCT("fc3855a6-c901-4f2e-aba8-90815afc6c83", ISDB_T_NETWORK_TYPE); +#define ISDB_T_NETWORK_TYPE DEFINE_GUIDNAMED(ISDB_T_NETWORK_TYPE) + +#define STATIC_ISDB_SATELLITE_TV_NETWORK_TYPE \ + 0xb0a4e6a0, 0x6a1a, 0x4b83, 0xbb, 0x5b, 0x90, 0x3e, 0x1d, 0x90, 0xe6, 0xb6 +DEFINE_GUIDSTRUCT("B0A4E6A0-6A1A-4B83-BB5B-903E1D90E6B6", ISDB_SATELLITE_TV_NETWORK_TYPE); +#define ISDB_SATELLITE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ISDB_SATELLITE_TV_NETWORK_TYPE) +#define STATIC_ISDB_S_NETWORK_TYPE \ + 0xa1e78202, 0x1459, 0x41b1, 0x9c, 0xa9, 0x2a, 0x92, 0x58, 0x7a, 0x42, 0xcc +DEFINE_GUIDSTRUCT("a1e78202-1459-41b1-9ca9-2a92587a42cc", ISDB_S_NETWORK_TYPE); +#define ISDB_S_NETWORK_TYPE DEFINE_GUIDNAMED(ISDB_S_NETWORK_TYPE) + +#define STATIC_ISDB_CABLE_TV_NETWORK_TYPE \ + 0xc974ddb5, 0x41fe, 0x4b25, 0x97, 0x41, 0x92, 0xf0, 0x49, 0xf1, 0xd5, 0xd1 +DEFINE_GUIDSTRUCT("C974DDB5-41FE-4B25-9741-92F049F1D5D1", ISDB_CABLE_TV_NETWORK_TYPE); +#define ISDB_CABLE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ISDB_CABLE_TV_NETWORK_TYPE) + +#define STATIC_DIRECT_TV_SATELLITE_TV_NETWORK_TYPE \ + 0x93b66fb5, 0x93d4, 0x4323, 0x92, 0x1c, 0xc1, 0xf5, 0x2d, 0xf6, 0x1d, 0x3f +DEFINE_GUIDSTRUCT("93B66FB5-93D4-4323-921C-C1F52DF61D3F", DIRECT_TV_SATELLITE_TV_NETWORK_TYPE); +#define DIRECT_TV_SATELLITE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(DIRECT_TV_SATELLITE_TV_NETWORK_TYPE) + +#define STATIC_ECHOSTAR_SATELLITE_TV_NETWORK_TYPE \ + 0xc4f6b31b, 0xc6bf, 0x4759, 0x88, 0x6f, 0xa7, 0x38, 0x6d, 0xca, 0x27, 0xa0 +DEFINE_GUIDSTRUCT("C4F6B31B-C6BF-4759-886F-A7386DCA27A0", ECHOSTAR_SATELLITE_TV_NETWORK_TYPE); +#define ECHOSTAR_SATELLITE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ECHOSTAR_SATELLITE_TV_NETWORK_TYPE) + +// Same as CLSID_ATSCNetworkProvider in uuids.h +#define STATIC_ATSC_TERRESTRIAL_TV_NETWORK_TYPE \ + 0x0dad2fdd, 0x5fd7, 0x11d3, 0x8f, 0x50, 0x00, 0xc0, 0x4f, 0x79, 0x71, 0xe2 +DEFINE_GUIDSTRUCT("0DAD2FDD-5FD7-11D3-8F50-00C04F7971E2", ATSC_TERRESTRIAL_TV_NETWORK_TYPE); +#define ATSC_TERRESTRIAL_TV_NETWORK_TYPE DEFINE_GUIDNAMED(ATSC_TERRESTRIAL_TV_NETWORK_TYPE) + +// Same as CLSID_DVBTNetworkProvider in uuids.h +#define STATIC_DVB_TERRESTRIAL_TV_NETWORK_TYPE \ + 0x216c62df, 0x6d7f, 0x4e9a, 0x85, 0x71, 0x05, 0xf1, 0x4e, 0xdb, 0x76, 0x6a +DEFINE_GUIDSTRUCT("216C62DF-6D7F-4E9A-8571-05F14EDB766A", DVB_TERRESTRIAL_TV_NETWORK_TYPE); +#define DVB_TERRESTRIAL_TV_NETWORK_TYPE DEFINE_GUIDNAMED(DVB_TERRESTRIAL_TV_NETWORK_TYPE) + +// Same as CLSID_DVBSNetworkProvider in uuids.h +#define STATIC_BSKYB_TERRESTRIAL_TV_NETWORK_TYPE \ + 0x9E9E46C6, 0x3ABA, 0x4f08, 0xAD, 0x0E, 0xCC, 0x5A, 0xC8, 0x14, 0x8C, 0x2B +DEFINE_GUIDSTRUCT("9E9E46C6-3ABA-4f08-AD0E-CC5AC8148C2B", BSKYB_TERRESTRIAL_TV_NETWORK_TYPE); +#define BSKYB_TERRESTRIAL_TV_NETWORK_TYPE DEFINE_GUIDNAMED(BSKYB_TERRESTRIAL_TV_NETWORK_TYPE) + +// Same as CLSID_DVBSNetworkProvider in uuids.h +#define STATIC_DVB_SATELLITE_TV_NETWORK_TYPE \ + 0xfa4b375a, 0x45b4, 0x4d45, 0x84, 0x40, 0x26, 0x39, 0x57, 0xb1, 0x16, 0x23 +DEFINE_GUIDSTRUCT("FA4B375A-45B4-4D45-8440-263957B11623", DVB_SATELLITE_TV_NETWORK_TYPE); +#define DVB_SATELLITE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(DVB_SATELLITE_TV_NETWORK_TYPE) + +// Same as CLSID_DVBCNetworkProvider in uuids.h +#define STATIC_DVB_CABLE_TV_NETWORK_TYPE \ + 0xdc0c0fe7, 0x485, 0x4266, 0xb9, 0x3f, 0x68, 0xfb, 0xf8, 0x0e, 0xd8, 0x34 +DEFINE_GUIDSTRUCT("DC0C0FE7-0485-4266-B93F-68FBF80ED834", DVB_CABLE_TV_NETWORK_TYPE); +#define DVB_CABLE_TV_NETWORK_TYPE DEFINE_GUIDNAMED(DVB_CABLE_TV_NETWORK_TYPE) + + +//=========================================================================== +// +// PBDA EVENT GUIDS +// +//=========================================================================== +#define STATIC_BDA_DEBUG_DATA_AVAILABLE \ + 0x69C24F54, 0x9983, 0x497e, 0xb4, 0x15, 0x28, 0x2b, 0xe4, 0xc5, 0x55, 0xfb +DEFINE_GUIDSTRUCT("69C24F54-9983-497e-B415-282BE4C555FB", BDA_DEBUG_DATA_AVAILABLE ); +#define BDA_DEBUG_DATA_AVAILABLE DEFINE_GUIDNAMED(BDA_DEBUG_DATA_AVAILABLE) + + +#define STATIC_BDA_DEBUG_DATA_TYPE_STRING \ + 0xa806e767, 0xde5c, 0x430c, 0x80, 0xbf, 0xa2, 0x1e, 0xbe, 0x06, 0xc7, 0x48 +DEFINE_GUIDSTRUCT("a806e767-de5c-430c-80bf-a21ebe06c748", BDA_DEBUG_DATA_TYPE_STRING ); +#define BDA_DEBUG_DATA_TYPE_STRING DEFINE_GUIDNAMED(BDA_DEBUG_DATA_TYPE_STRING) + + +#define STATIC_EVENTID_BDA_IsdbCASResponse \ + 0xd4cb1966, 0x41bc, 0x4ced, 0x9a, 0x20, 0xfd, 0xce, 0xac, 0x78, 0xf7, 0x0d +DEFINE_GUIDSTRUCT("D4CB1966-41BC-4ced-9A20-FDCEAC78F70D", EVENTID_BDA_IsdbCASResponse); +#define EVENTID_BDA_IsdbCASResponse DEFINE_GUIDNAMED(EVENTID_BDA_IsdbCASResponse) + + +#define STATIC_EVENTID_BDA_CASRequestTuner \ + 0xcf39a9d8, 0xf5d3, 0x4685, 0xbe, 0x57, 0xed, 0x81, 0xdb, 0xa4, 0x6b, 0x27 +DEFINE_GUIDSTRUCT("CF39A9D8-F5D3-4685-BE57-ED81DBA46B27", EVENTID_BDA_CASRequestTuner); +#define EVENTID_BDA_CASRequestTuner DEFINE_GUIDNAMED(EVENTID_BDA_CASRequestTuner) + + +#define STATIC_EVENTID_BDA_CASReleaseTuner \ + 0x20c1a16b, 0x441f, 0x49a5, 0xbb, 0x5c, 0xe9, 0xa0, 0x44, 0x95, 0xc6, 0xc1 +DEFINE_GUIDSTRUCT("20C1A16B-441F-49a5-BB5C-E9A04495C6C1", EVENTID_BDA_CASReleaseTuner); +#define EVENTID_BDA_CASReleaseTuner DEFINE_GUIDNAMED(EVENTID_BDA_CASReleaseTuner) + + +#define STATIC_EVENTID_BDA_CASOpenMMI \ + 0x85dac915, 0xe593, 0x410d, 0x84, 0x71, 0xd6, 0x81, 0x21, 0x05, 0xf2, 0x8e +DEFINE_GUIDSTRUCT("85DAC915-E593-410d-8471-D6812105F28E", EVENTID_BDA_CASOpenMMI); +#define EVENTID_BDA_CASOpenMMI DEFINE_GUIDNAMED(EVENTID_BDA_CASOpenMMI) + + +#define STATIC_EVENTID_BDA_CASCloseMMI \ + 0x5d0f550f, 0xde2e, 0x479d, 0x83, 0x45, 0xec, 0x0e, 0x95, 0x57, 0xe8, 0xa2 +DEFINE_GUIDSTRUCT("5D0F550F-DE2E-479d-8345-EC0E9557E8A2", EVENTID_BDA_CASCloseMMI); +#define EVENTID_BDA_CASCloseMMI DEFINE_GUIDNAMED(EVENTID_BDA_CASCloseMMI) + + +#define STATIC_EVENTID_BDA_CASBroadcastMMI \ + 0x676876f0, 0x1132, 0x404c, 0xa7, 0xca, 0xe7, 0x20, 0x69, 0xa9, 0xd5, 0x4f +DEFINE_GUIDSTRUCT("676876F0-1132-404c-A7CA-E72069A9D54F", EVENTID_BDA_CASBroadcastMMI); +#define EVENTID_BDA_CASBroadcastMMI DEFINE_GUIDNAMED(EVENTID_BDA_CASBroadcastMMI) + + +#define STATIC_EVENTID_BDA_TunerSignalLock \ + 0x1872e740, 0xf573, 0x429b, 0xa0, 0x0e, 0xd9, 0xc1, 0xe4, 0x08, 0xaf, 0x09 +DEFINE_GUIDSTRUCT("1872E740-F573-429b-A00E-D9C1E408AF09", EVENTID_BDA_TunerSignalLock); +#define EVENTID_BDA_TunerSignalLock DEFINE_GUIDNAMED(EVENTID_BDA_TunerSignalLock) + +#define STATIC_EVENTID_BDA_TunerNoSignal \ + 0xe29b382b, 0x1edd, 0x4930, 0xbc, 0x46, 0x68, 0x2f, 0xd7, 0x2d, 0x2d, 0xfb +DEFINE_GUIDSTRUCT("E29B382B-1EDD-4930-BC46-682FD72D2DFB", EVENTID_BDA_TunerNoSignal); +#define EVENTID_BDA_TunerNoSignal DEFINE_GUIDNAMED(EVENTID_BDA_TunerNoSignal) + +#define STATIC_EVENTID_BDA_GPNVValueUpdate \ + 0xff75c68c, 0xf416, 0x4e7e, 0xbf, 0x17, 0x6d, 0x55, 0xc5, 0xdf, 0x15, 0x75 +DEFINE_GUIDSTRUCT("FF75C68C-F416-4e7e-BF17-6D55C5DF1575", EVENTID_BDA_GPNVValueUpdate); +#define EVENTID_BDA_GPNVValueUpdate DEFINE_GUIDNAMED(EVENTID_BDA_GPNVValueUpdate) + + +#define STATIC_EVENTID_BDA_UpdateDrmStatus \ + 0x65a6f681, 0x1462, 0x473b, 0x88, 0xce, 0xcb, 0x73, 0x14, 0x27, 0xbd, 0xb5 +DEFINE_GUIDSTRUCT("65A6F681-1462-473b-88CE-CB731427BDB5", EVENTID_BDA_UpdateDrmStatus); +#define EVENTID_BDA_UpdateDrmStatus DEFINE_GUIDNAMED(EVENTID_BDA_UpdateDrmStatus) + + +#define STATIC_EVENTID_BDA_UpdateScanState \ + 0x55702B50, 0x7B49, 0x42B8, 0xA8, 0x2F, 0x4A, 0xFB, 0x69, 0x1B, 0x06, 0x28 +DEFINE_GUIDSTRUCT("55702B50-7B49-42B8-A82F-4AFB691B0628", EVENTID_BDA_UpdateScanState); +#define EVENTID_BDA_UpdateScanState DEFINE_GUIDNAMED(EVENTID_BDA_UpdateScanState) + + +#define STATIC_EVENTID_BDA_GuideDataAvailable \ + 0x98db717a, 0x478a, 0x4cd4, 0x92, 0xd0, 0x95, 0xf6, 0x6b, 0x89, 0xe5, 0xb1 +DEFINE_GUIDSTRUCT("98DB717A-478A-4cd4-92D0-95F66B89E5B1", EVENTID_BDA_GuideDataAvailable); +#define EVENTID_BDA_GuideDataAvailable DEFINE_GUIDNAMED(EVENTID_BDA_GuideDataAvailable) + + +#define STATIC_EVENTID_BDA_GuideServiceInformationUpdated \ + 0xa1c3ea2b, 0x175f, 0x4458, 0xb7, 0x35, 0x50, 0x7d, 0x22, 0xdb, 0x23, 0xa6 +DEFINE_GUIDSTRUCT("A1C3EA2B-175F-4458-B735-507D22DB23A6", EVENTID_BDA_GuideServiceInformationUpdated); +#define EVENTID_BDA_GuideServiceInformationUpdated DEFINE_GUIDNAMED(EVENTID_BDA_GuideServiceInformationUpdated) + + +#define STATIC_EVENTID_BDA_GuideDataError \ + 0xAC33C448, 0x6F73, 0x4fd7, 0xB3, 0x41, 0x59, 0x4C, 0x36, 0x0D, 0x8D, 0x74 +DEFINE_GUIDSTRUCT("AC33C448-6F73-4fd7-B341-594C360D8D74", EVENTID_BDA_GuideDataError); +#define EVENTID_BDA_GuideDataError DEFINE_GUIDNAMED(EVENTID_BDA_GuideDataError) + + +#define STATIC_EVENTID_BDA_DiseqCResponseAvailable \ + 0xefa628f8, 0x1f2c, 0x4b67, 0x9e, 0xa5, 0xac, 0xf6, 0xfa, 0x9a, 0x1f, 0x36 +DEFINE_GUIDSTRUCT("EFA628F8-1F2C-4b67-9EA5-ACF6FA9A1F36", EVENTID_BDA_DiseqCResponseAvailable); +#define EVENTID_BDA_DiseqCResponseAvailable DEFINE_GUIDNAMED(EVENTID_BDA_DiseqCResponseAvailable) + +#define STATIC_EVENTID_BDA_LbigsOpenConnection \ + 0x356207B2, 0x6F31, 0x4eb0, 0xa2, 0x71, 0xb3, 0xfa, 0x6b, 0xb7, 0x68, 0x0f +DEFINE_GUIDSTRUCT("356207B2-6F31-4eb0-A271-B3FA6BB7680F", EVENTID_BDA_LbigsOpenConnection); +#define EVENTID_BDA_LbigsOpenConnection DEFINE_GUIDNAMED(EVENTID_BDA_LbigsOpenConnection) + +#define STATIC_EVENTID_BDA_LbigsSendData \ + 0x1123277B, 0xF1C6, 0x4154, 0x8b, 0x0d, 0x48, 0xe6, 0x15, 0x70, 0x59, 0xaa +DEFINE_GUIDSTRUCT("1123277B-F1C6-4154-8B0D-48E6157059AA", EVENTID_BDA_LbigsSendData); +#define EVENTID_BDA_LbigsSendData DEFINE_GUIDNAMED(EVENTID_BDA_LbigsSendData) + +#define STATIC_EVENTID_BDA_LbigsCloseConnectionHandle \ + 0xC2F08B99, 0x65EF, 0x4314, 0x96, 0x71, 0xe9, 0x9d, 0x4c, 0xce, 0x0b, 0xae +DEFINE_GUIDSTRUCT("C2F08B99-65EF-4314-9671-E99D4CCE0BAE", EVENTID_BDA_LbigsCloseConnectionHandle); +#define EVENTID_BDA_LbigsCloseConnectionHandle DEFINE_GUIDNAMED(EVENTID_BDA_LbigsCloseConnectionHandle) + +#define STATIC_EVENTID_BDA_EncoderSignalLock \ + 0x5ec90eb9, 0x39fa, 0x4cfc, 0xb9, 0x3f, 0x00, 0xbb, 0x11, 0x07, 0x7f, 0x5e +DEFINE_GUIDSTRUCT("5EC90EB9-39FA-4CFC-B93F-00BB11077F5E", EVENTID_BDA_EncoderSignalLock); +#define EVENTID_BDA_EncoderSignalLock DEFINE_GUIDNAMED(EVENTID_BDA_EncoderSignalLock) + + +#define STATIC_EVENTID_BDA_FdcStatus \ + 0x05f25366, 0xd0eb, 0x43d2, 0xbc, 0x3c, 0x68, 0x2b, 0x86, 0x3d, 0xf1, 0x42 +DEFINE_GUIDSTRUCT("05F25366-D0EB-43d2-BC3C-682B863DF142", EVENTID_BDA_FdcStatus); +#define EVENTID_BDA_FdcStatus DEFINE_GUIDNAMED(EVENTID_BDA_FdcStatus) + + +#define STATIC_EVENTID_BDA_FdcTableSection \ + 0x6a0cD757, 0x4ce3,0x4e5b, 0x94, 0x44, 0x71, 0x87, 0xb8, 0x71, 0x52, 0xc5 +DEFINE_GUIDSTRUCT("6A0CD757-4CE3-4e5b-9444-7187B87152C5", EVENTID_BDA_FdcTableSection); +#define EVENTID_BDA_FdcTableSection DEFINE_GUIDNAMED(EVENTID_BDA_FdcTableSection) + + +#define STATIC_EVENTID_BDA_TransprtStreamSelectorInfo \ + 0xc40f9f85, 0x9d0, 0x489c, 0x9e, 0x9c, 0x0a, 0xbb, 0xb5, 0x69, 0x51, 0xb0 +DEFINE_GUIDSTRUCT("C40F9F85-09D0-489c-9E9C-0ABBB56951B0", EVENTID_BDA_TransprtStreamSelectorInfo); +#define EVENTID_BDA_TransprtStreamSelectorInfo DEFINE_GUIDNAMED(EVENTID_BDA_TransprtStreamSelectorInfo) + + +#define STATIC_EVENTID_BDA_RatingPinReset \ + 0xc6e048c0, 0xc574, 0x4c26, 0xbc, 0xda, 0x2f, 0x4d, 0x35, 0xeb, 0x5e, 0x85 +DEFINE_GUIDSTRUCT("C6E048C0-C574-4C26-BCDA-2F4D35EB5E85", EVENTID_BDA_RatingPinReset); +#define EVENTID_BDA_RatingPinReset DEFINE_GUIDNAMED(EVENTID_BDA_RatingPinReset) + + +//=========================================================================== +// +// PBDA COMMON USE GUIDs +// +//=========================================================================== + +#define STATIC_PBDA_ALWAYS_TUNE_IN_MUX \ + 0x1E1D7141, 0x583F, 0x4ac2, 0xB0, 0x19, 0x1F, 0x43, 0x0E, 0xDA, 0x0F, 0x4C +DEFINE_GUIDSTRUCT("1E1D7141-583F-4ac2-B019-1F430EDA0F4C", PBDA_ALWAYS_TUNE_IN_MUX); +#define PBDA_ALWAYS_TUNE_IN_MUX DEFINE_GUIDNAMED(PBDA_ALWAYS_TUNE_IN_MUX) + + + +#if defined(__cplusplus) +} +#endif // defined(__cplusplus) + +#endif // !defined(_BDAMEDIA_) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdatypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdatypes.h new file mode 100644 index 0000000000000000000000000000000000000000..e4f8838e03bee04a0eedf9077dbb99178262ca16 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bdatypes.h @@ -0,0 +1,1135 @@ +//------------------------------------------------------------------------------ +// File: BDATypes.h +// +// Desc: Typedefs and enums needed by both the WDM drivers and the user mode +// COM interfaces. +// +// Copyright (c) 1999 - 2004, Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + + +#ifndef _BDATYPES_ + +#define _BDATYPES_ 1 + +// !!!! do not #pragma once, we use this file twice(once for native and once for mgd) in managed interop +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#include + +/* Utility Macros */ + +#define MIN_DIMENSION 1 + + +//=========================================================================== +// +// BDA Topology Structures +// +//=========================================================================== + +#ifndef MANAGED_ENUMS + +typedef struct _BDA_TEMPLATE_CONNECTION +{ + ULONG FromNodeType; + ULONG FromNodePinType; + ULONG ToNodeType; + ULONG ToNodePinType; +}BDA_TEMPLATE_CONNECTION, *PBDA_TEMPLATE_CONNECTION; + + +typedef struct _BDA_TEMPLATE_PIN_JOINT +{ + ULONG uliTemplateConnection; + ULONG ulcInstancesMax; +}BDA_TEMPLATE_PIN_JOINT, *PBDA_TEMPLATE_PIN_JOINT; +#endif + + +//=========================================================================== +// +// BDA Events +// +//=========================================================================== + +// In-band Event IDs +// +ENUM BDA_EVENT_ID { + BDA_EVENT_SIGNAL_LOSS = 0, + BDA_EVENT_SIGNAL_LOCK, + BDA_EVENT_DATA_START, + BDA_EVENT_DATA_STOP, + BDA_EVENT_CHANNEL_ACQUIRED, + BDA_EVENT_CHANNEL_LOST, + BDA_EVENT_CHANNEL_SOURCE_CHANGED, + BDA_EVENT_CHANNEL_ACTIVATED, + BDA_EVENT_CHANNEL_DEACTIVATED, + BDA_EVENT_SUBCHANNEL_ACQUIRED, + BDA_EVENT_SUBCHANNEL_LOST, + BDA_EVENT_SUBCHANNEL_SOURCE_CHANGED, + BDA_EVENT_SUBCHANNEL_ACTIVATED, + BDA_EVENT_SUBCHANNEL_DEACTIVATED, + BDA_EVENT_ACCESS_GRANTED, + BDA_EVENT_ACCESS_DENIED, + BDA_EVENT_OFFER_EXTENDED, + BDA_EVENT_PURCHASE_COMPLETED, + BDA_EVENT_SMART_CARD_INSERTED, + BDA_EVENT_SMART_CARD_REMOVED +} BDA_EVENT_ID, *PBDA_EVENT_ID; + + + +//=========================================================================== +// +// KSSTREAM_HEADER extensions for BDA +// +//=========================================================================== + +#ifndef MANAGED_ENUMS +typedef struct tagKS_BDA_FRAME_INFO { + ULONG ExtendedHeaderSize; // Size of this extended header + DWORD dwFrameFlags; // + ULONG ulEvent; // + ULONG ulChannelNumber; // + ULONG ulSubchannelNumber; // + ULONG ulReason; // +} KS_BDA_FRAME_INFO, *PKS_BDA_FRAME_INFO; + + +//------------------------------------------------------------ +// +// BDA Network Ethernet Filter Property Set +// +// {71985F43-1CA1-11d3-9CC8-00C04F7971E0} +// +typedef struct _BDA_ETHERNET_ADDRESS { + BYTE rgbAddress[6]; +} BDA_ETHERNET_ADDRESS, *PBDA_ETHERNET_ADDRESS; + +typedef struct _BDA_ETHERNET_ADDRESS_LIST { + ULONG ulcAddresses; + BDA_ETHERNET_ADDRESS rgAddressl[MIN_DIMENSION]; +} BDA_ETHERNET_ADDRESS_LIST, * PBDA_ETHERNET_ADDRESS_LIST; + +#endif + +ENUM BDA_MULTICAST_MODE { + BDA_PROMISCUOUS_MULTICAST = 0, + BDA_FILTERED_MULTICAST, + BDA_NO_MULTICAST +} BDA_MULTICAST_MODE, *PBDA_MULTICAST_MODE; + + +//------------------------------------------------------------ +// +// BDA Network IPv4 Filter Property Set +// +// {71985F44-1CA1-11d3-9CC8-00C04F7971E0} +// +#ifndef MANAGED_ENUMS +typedef struct _BDA_IPv4_ADDRESS { + BYTE rgbAddress[4]; +} BDA_IPv4_ADDRESS, *PBDA_IPv4_ADDRESS; + +typedef struct _BDA_IPv4_ADDRESS_LIST { + ULONG ulcAddresses; + BDA_IPv4_ADDRESS rgAddressl[MIN_DIMENSION]; +} BDA_IPv4_ADDRESS_LIST, * PBDA_IPv4_ADDRESS_LIST; + +//------------------------------------------------------------ +// +// BDA Network IPv4 Filter Property Set +// +// {E1785A74-2A23-4fb3-9245-A8F88017EF33} +// +typedef struct _BDA_IPv6_ADDRESS { + BYTE rgbAddress[6]; +} BDA_IPv6_ADDRESS, *PBDA_IPv6_ADDRESS; + +typedef struct _BDA_IPv6_ADDRESS_LIST { + ULONG ulcAddresses; + BDA_IPv6_ADDRESS rgAddressl[MIN_DIMENSION]; +} BDA_IPv6_ADDRESS_LIST, * PBDA_IPv6_ADDRESS_LIST; + +#endif + + +//------------------------------------------------------------ +// +// +// BDA Signal Property Set +// +// {D2F1644B-B409-11d2-BC69-00A0C9EE9E16} +// +ENUM BDA_SIGNAL_STATE { + BDA_SIGNAL_UNAVAILABLE = 0, + BDA_SIGNAL_INACTIVE, + BDA_SIGNAL_ACTIVE +} BDA_SIGNAL_STATE, * PBDA_SIGNAL_STATE; + + +//------------------------------------------------------------ +// +// +// BDA Change Sync Method Set +// +// {FD0A5AF3-B41D-11d2-9C95-00C04F7971E0} +// +ENUM BDA_CHANGE_STATE { + BDA_CHANGES_COMPLETE = 0, + BDA_CHANGES_PENDING +} BDA_CHANGE_STATE, * PBDA_CHANGE_STATE; + + +//------------------------------------------------------------ +// +// +// BDA Device Configuration Method Set +// +// {71985F45-1CA1-11d3-9CC8-00C04F7971E0} +// + + +//------------------------------------------------------------ +// +// +// BDA Topology Property Set +// +// {A14EE835-0A23-11d3-9CC7-00C04F7971E0} +// + +#ifndef MANAGED_ENUMS +typedef struct _BDANODE_DESCRIPTOR +{ + ULONG ulBdaNodeType; // The node type as it is used + // in the BDA template topology + + GUID guidFunction; // GUID from BdaMedia.h describing + // the node's function (e.g. + // KSNODE_BDA_RF_TUNER) + + GUID guidName; // GUID that can be use to look up + // a displayable name for the node. +} BDANODE_DESCRIPTOR, *PBDANODE_DESCRIPTOR; + + +//------------------------------------------------------------ +// +// +// BDA Void Transform Property Set +// +// {71985F46-1CA1-11d3-9CC8-00C04F7971E0} +// + + +//------------------------------------------------------------ +// +// +// BDA Null Transform Property Set +// +// {DDF15B0D-BD25-11d2-9CA0-00C04F7971E0} +// + + +//------------------------------------------------------------ +// +// +// BDA Frequency Filter Property Set +// +// {71985F47-1CA1-11d3-9CC8-00C04F7971E0} +// + + +//------------------------------------------------------------ +// +// +// BDA Autodemodulate Property Set +// +// {DDF15B12-BD25-11d2-9CA0-00C04F7971E0} +// + + +//------------------------------------------------------------ +// +// +// BDA Table Section Property Set +// +// {516B99C5-971C-4aaf-B3F3-D9FDA8A15E16} +// + +typedef struct _BDA_TABLE_SECTION +{ + ULONG ulPrimarySectionId; + ULONG ulSecondarySectionId; + ULONG ulcbSectionLength; + ULONG argbSectionData[MIN_DIMENSION]; +} BDA_TABLE_SECTION, *PBDA_TABLE_SECTION; + +#endif + +#ifndef MANAGED_ENUMS + +//------------------------------------------------------------ +// +// +// BDA Diseq Command Property Set +// +// {F84E2AB0-3C6B-45e3-A0FC-8669D4B81F11} +// + +typedef struct _BDA_DISEQC_SEND +{ + ULONG ulRequestId; + ULONG ulPacketLength; + BYTE argbPacketData[8]; +} BDA_DISEQC_SEND, *PBDA_DISEQC_SEND; + +typedef struct _BDA_DISEQC_RESPONSE +{ + ULONG ulRequestId; + ULONG ulPacketLength; + BYTE argbPacketData[8]; +} BDA_DISEQC_RESPONSE, *PBDA_DISEQC_RESPONSE; + + +#endif +//------------------------------------------------------------ +// +// +// BDA PID Filter Property Set +// +// {D0A67D65-08DF-4fec-8533-E5B550410B85} +// + +//--------------------------------------------------------------------- +// From IEnumPIDMap interface +//--------------------------------------------------------------------- + +ENUM MEDIA_SAMPLE_CONTENT { + MEDIA_TRANSPORT_PACKET, // complete TS packet e.g. pass-through mode + MEDIA_ELEMENTARY_STREAM, // PES payloads; audio/video only + MEDIA_MPEG2_PSI, // PAT, PMT, CAT, Private + MEDIA_TRANSPORT_PAYLOAD // gathered TS packet payloads (PES packets, etc...) +} MEDIA_SAMPLE_CONTENT ; + +#ifndef MANAGED_ENUMS +typedef struct { + ULONG ulPID ; + MEDIA_SAMPLE_CONTENT MediaSampleContent ; +} PID_MAP ; + +typedef struct _BDA_PID_MAP +{ + MEDIA_SAMPLE_CONTENT MediaSampleContent; + ULONG ulcPIDs; + ULONG aulPIDs[MIN_DIMENSION]; +} BDA_PID_MAP, *PBDA_PID_MAP; + +typedef struct _BDA_PID_UNMAP +{ + ULONG ulcPIDs; + ULONG aulPIDs[MIN_DIMENSION]; +} BDA_PID_UNMAP, *PBDA_PID_UNMAP; + + +//------------------------------------------------------------ +// +// +// BDA CA Property Set +// +// {B0693766-5278-4ec6-B9E1-3CE40560EF5A} +// +typedef struct _BDA_CA_MODULE_UI +{ + ULONG ulFormat; + ULONG ulbcDesc; + ULONG ulDesc[MIN_DIMENSION]; +} BDA_CA_MODULE_UI, *PBDA_CA_MODULE_UI; + +typedef struct _BDA_PROGRAM_PID_LIST +{ + ULONG ulProgramNumber; + ULONG ulcPIDs; + ULONG ulPID[MIN_DIMENSION]; +} BDA_PROGRAM_PID_LIST, *PBDA_PROGRAM_PID_LIST; + +#endif + +//------------------------------------------------------------ +// +// +// BDA CA Event Set +// +// {488C4CCC-B768-4129-8EB1-B00A071F9068} +// + +#ifndef MANAGED_ENUMS + +//============================================================= +// PBDA RESULT parameter definition +//============================================================= +typedef LONG PBDARESULT; + +//============================================================= +// BDA_DRM_STATUS used by the DRMService +//============================================================= + +typedef struct _BDA_DRM_DRMSTATUS +{ + PBDARESULT lResult; + GUID DRMuuid; + ULONG ulDrmUuidListStringSize; + GUID argbDrmUuidListString[MIN_DIMENSION]; +} BDA_DRM_DRMSTATUS, *PBDA_DRM_DRMSTATUS; + + +//============================================================= +// PBDA_WMDRM and PBDA_WMDRMTuner structures +//============================================================= + +typedef struct _BDA_WMDRM_STATUS +{ + PBDARESULT lResult; + ULONG ulMaxCaptureTokenSize; + ULONG uMaxStreamingPid; + ULONG ulMaxLicense; + ULONG ulMinSecurityLevel; + ULONG ulRevInfoSequenceNumber; + ULONGLONG ulRevInfoIssuedTime; + ULONG ulRevListVersion; + ULONG ulRevInfoTTL; + ULONG ulState; +} BDA_WMDRM_STATUS, *PBDA_WMDRM_STATUS; + +typedef struct _BDA_WMDRM_KEYINFOLIST +{ + PBDARESULT lResult; + ULONG ulKeyuuidBufferLen; + GUID argKeyuuidBuffer[MIN_DIMENSION]; +} BDA_WMDRM_KEYINFOLIST, *PBDA_WMDRM_KEYINFOLIST; + +typedef struct _BDA_BUFFER +{ + PBDARESULT lResult; + ULONG ulBufferSize; + BYTE argbBuffer[MIN_DIMENSION]; +} BDA_BUFFER, *PBDA_BUFFER; + +//============================================================= +// PBDA - DRM structures used in methods +//============================================================= + +typedef struct _BDA_WMDRM_RENEWLICENSE +{ + PBDARESULT lResult; + ULONG ulDescrambleStatus; + ULONG ulXmrLicenseOutputLength; + BYTE argbXmrLicenceOutputBuffer[MIN_DIMENSION]; //License and Entitlement Token Buffer +} BDA_WMDRM_RENEWLICENSE, *PBDA_WMDRM_RENEWLICENSE; + +typedef struct _BDA_WMDRMTUNER_PIDPROTECTION +{ + PBDARESULT lResult; + GUID uuidKeyID; +} BDA_WMDRMTUNER_PIDPROTECTION, *PBDA_WMDRMTUNER_PIDPROTECTION; + +typedef struct _BDA_WMDRMTUNER_PURCHASEENTITLEMENT +{ + PBDARESULT lResult; + ULONG ulDescrambleStatus; + ULONG ulCaptureTokenLength; + BYTE argbCaptureTokenBuffer[MIN_DIMENSION]; +} BDA_WMDRMTUNER_PURCHASEENTITLEMENT, *PBDA_WMDRMTUNER_PURCHASEENTITLEMENT; + +//============================================================= +// PBDA - TUNER structures used in methods +//============================================================= + +typedef struct _BDA_TUNER_TUNERSTATE { + PBDARESULT lResult; + ULONG ulTuneLength; + BYTE argbTuneData [MIN_DIMENSION]; +} BDA_TUNER_TUNERSTATE, *PBDA_TUNER_TUNERSTATE; + +typedef struct _BDA_TUNER_DIAGNOSTICS { + PBDARESULT lResult; + ULONG ulSignalLevel; + ULONG ulSignalLevelQuality; + ULONG ulSignalNoiseRatio; +} BDA_TUNER_DIAGNOSTICS, *PBDA_TUNER_DIAGNOSTICS; + +//============================================================= +// PBDA - STRING structure used in methods +//============================================================= + +typedef struct _BDA_STRING +{ + PBDARESULT lResult; + ULONG ulStringSize; + BYTE argbString[MIN_DIMENSION]; +} BDA_STRING, *PBDA_STRING; + + +//============================================================= +// PBDA - SCANNING structures used in methods +//============================================================= + +typedef struct _BDA_SCAN_CAPABILTIES +{ + PBDARESULT lResult; + UINT64 ul64AnalogStandardsSupported; +} BDA_SCAN_CAPABILTIES, *PBDA_SCAN_CAPABILTIES; + +typedef struct _BDA_SCAN_STATE +{ + PBDARESULT lResult; + ULONG ulSignalLock; + ULONG ulSecondsLeft; + ULONG ulCurrentFrequency; +} BDA_SCAN_STATE, *PBDA_SCAN_STATE; + +typedef struct _BDA_SCAN_START +{ + PBDARESULT lResult; + ULONG LowerFrequency; + ULONG HigerFrequency; +} BDA_SCAN_START, *PBDA_SCAN_START; + + +//============================================================= +// PBDA - GUIDE DATA structures used in methods +//============================================================= + +typedef struct _BDA_GDDS_DATATYPE +{ + PBDARESULT lResult; + GUID uuidDataType; +} BDA_GDDS_DATATYPE, *P_BDA_GDDS_DATATYPE; + +typedef struct _BDA_GDDS_DATA +{ + PBDARESULT lResult; + ULONG ulDataLength; + ULONG ulPercentageProgress; + BYTE argbData [MIN_DIMENSION]; +} BDA_GDDS_DATA, *P_BDA_GDDS_DATA; + + +//============================================================= +// PBDA - USER ACTIVITY structures used in methods +//============================================================= + +typedef struct _BDA_USERACTIVITY_INTERVAL +{ + PBDARESULT lResult; + ULONG ulActivityInterval; +} BDA_USERACTIVITY_INTERVAL, *P_BDA_USERACTIVITY_INTERVAL; + + +//============================================================= +// PBDA - CAS structures used in methods +//============================================================= + +typedef struct _BDA_CAS_CHECK_ENTITLEMENTTOKEN +{ + PBDARESULT lResult; + ULONG ulDescrambleStatus; +} BDA_CAS_CHECK_ENTITLEMENTTOKEN, *PBDA_CAS_CHECK_ENTITLEMENTTOKEN; + +typedef struct _BDA_CAS_CLOSE_MMIDIALOG +{ + PBDARESULT lResult; + ULONG SessionResult; +} BDA_CAS_CLOSE_MMIDIALOG, *PBDA_CAS_CLOSE_MMIDIALOG; + +typedef struct _BDA_CAS_REQUESTTUNERDATA +{ + UCHAR ucRequestPriority; + UCHAR ucRequestReason; + UCHAR ucRequestConsequences; + ULONG ulEstimatedTime; +} BDA_CAS_REQUESTTUNERDATA, *PBDA_CAS_REQUESTTUNERDATA; + +typedef struct _BDA_CAS_OPENMMIDATA +{ + ULONG ulDialogNumber; + ULONG ulDialogRequest; + GUID uuidDialogType; + USHORT usDialogDataLength; + BYTE argbDialogData[MIN_DIMENSION]; +} BDA_CAS_OPENMMIDATA, *PBDA_CAS_OPENMMIDATA; + +typedef struct _BDA_CAS_CLOSEMMIDATA +{ + ULONG ulDialogNumber; +} BDA_CAS_CLOSEMMIDATA, *PBDA_CAS_CLOSEMMIDATA; + +//============================================================= +// PBDA - ISDB CAS structures used in methods +//============================================================= + +#pragma pack(push, 1) + +ENUM ISDBCAS_REQUEST_ID { + ISDBCAS_REQUEST_ID_EMG = 0x38, + ISDBCAS_REQUEST_ID_EMD = 0x3A, +} ISDBCAS_REQUEST_ID ; + +typedef struct _BDA_ISDBCAS_REQUESTHEADER +{ + BYTE bInstruction; // EMD/EMG + BYTE bReserved[3]; // future use + ULONG ulDataLength; // byte size of argbIsdbCommand + BYTE argbIsdbCommand[MIN_DIMENSION]; +} BDA_ISDBCAS_REQUESTHEADER, *PBDA_ISDBCAS_REQUESTHEADER; + +typedef struct _BDA_ISDBCAS_RESPONSEDATA +{ + PBDARESULT lResult; + ULONG ulRequestID; + ULONG ulIsdbStatus; + ULONG ulIsdbDataSize; + BYTE argbIsdbCommandData[MIN_DIMENSION]; +} BDA_ISDBCAS_RESPONSEDATA, *PBDA_ISDBCAS_RESPONSEDATA; + +typedef struct _BDA_ISDBCAS_EMG_REQ +{ + BYTE bCLA; // 0x90 + BYTE bINS; // 0x38 + BYTE bP1; // 0x00 + BYTE bP2; // 0x00 + BYTE bLC; // Following bytes - 1(LE) + BYTE bCardId[6]; // from EMM message packet + BYTE bProtocol; // from EMM message packet + BYTE bCABroadcasterGroupId; // from EMM message packet + BYTE bMessageControl; // from EMM message packet + BYTE bMessageCode[MIN_DIMENSION]; // Last byte is reserved as 'LE' +} BDA_ISDBCAS_EMG_REQ, *PBDA_ISDBCAS_EMG_REQ; + +#pragma pack(pop) + +//============================================================= +// PBDA - MUX structures used in methods +//============================================================= +ENUM MUX_PID_TYPE { + PID_OTHER = -1, + PID_ELEMENTARY_STREAM, // PES payloads + PID_MPEG2_SECTION_PSI_SI, // ISO 13818_1 Sections PAT, PMT, CAT, Private. Service Information Sections e.g SDT, NIT, EIT, BAT +} MUX_PID_TYPE ; + +#pragma pack(push, 2) +typedef struct _BDA_MUX_PIDLISTITEM +{ + USHORT usPIDNumber; //PID number of the stream + USHORT usProgramNumber; //associated Service Id, if applicable + MUX_PID_TYPE ePIDType; //PID Type of the stream if applicable +} BDA_MUX_PIDLISTITEM, *PBDA_MUX_PIDLISTITEM; +#pragma pack(pop) + +#endif + +//============================================================= +// BDA - TS Selector structures used in methods +//============================================================= + +// |<-------------- bTSInfolength ---------------------->| +// | | +// | | | +// | BDA_TS_SELECTORINFO | BDA_TS_SELECTORINFO_ISDBS_EXT | +// | | (for ISDB-S extension) | +// | | | + +#pragma pack(push, 1) +typedef struct _BDA_TS_SELECTORINFO +{ + BYTE bTSInfolength; // buffer length including extension + BYTE bReserved[2]; + GUID guidNetworkType; // current type of tuning + BYTE bTSIDCount; // number of usTSID + USHORT usTSID[MIN_DIMENSION]; +} BDA_TS_SELECTORINFO, *PBDA_TS_SELECTORINFO; + +typedef struct _BDA_TS_SELECTORINFO_ISDBS_EXT +{ + BYTE bTMCC[48]; +} BDA_TS_SELECTORINFO_ISDBS_EXT, *PBDA_TS_SELECTORINFO_ISDBS_EXT; +#pragma pack(pop) + +//DVB-T2 related L1 signalling information returned in _GETTSINFORMATION + +typedef struct _BDA_DVBT2_L1_SIGNALLING_DATA +{ + BYTE L1Pre_TYPE; + BYTE L1Pre_BWT_S1_S2; + BYTE L1Pre_REPETITION_GUARD_PAPR; + BYTE L1Pre_MOD_COD_FEC; + BYTE L1Pre_POSTSIZE_INFO_PILOT[5]; + BYTE L1Pre_TX_ID_AVAIL; + BYTE L1Pre_CELL_ID[2]; + BYTE L1Pre_NETWORK_ID[2]; + BYTE L1Pre_T2SYSTEM_ID[2]; + BYTE L1Pre_NUM_T2_FRAMES; + BYTE L1Pre_NUM_DATA_REGENFLAG_L1POSTEXT[2]; + BYTE L1Pre_NUMRF_CURRENTRF_RESERVED[2]; + BYTE L1Pre_CRC32[4]; + BYTE L1PostData[MIN_DIMENSION]; +} BDA_DVBT2_L1_SIGNALLING_DATA, *PBDA_DVBT2_L1_SIGNALLING_DATA; + + +//============================================================= +// PBDA - RATING structures used in methods +//============================================================= +typedef struct _BDA_RATING_PINRESET +{ + BYTE bPinLength; //Buffer size including a null termination + BYTE argbNewPin[MIN_DIMENSION]; //Null terminated UTF8. Use empty string if disable pin +} BDA_RATING_PINRESET, *PBDA_RATING_PINRESET; + +//============================================================= +// +// +// BDA Tuning Model enumerations +// +// +//============================================================= + +// system type for particular DVB Tuning Space instance +ENUM DVBSystemType { + DVB_Cable, + DVB_Terrestrial, + DVB_Satellite, + ISDB_Terrestrial, + ISDB_Satellite, +} DVBSystemType; + +//------------------------------------------------------------ +// +// BDA Channel Tune Request + +ENUM BDA_Channel { + BDA_UNDEFINED_CHANNEL = -1, +} BDA_Channel ; + + +//------------------------------------------------------------ +// +// BDA Component(substream) +// +// Note: Persistent TS remember preferred component categories by their number. +// Please update the rgs files at multimedia\dshow\vidctl\msvidctl\res +// and multimedia\dshow\vidctl\manifests\Video-TVVideoControl.man accordingly +// if the order/value changes. +// Also make sure ehiProxy.asmmeta, ehiVidCtl.asmmeta and bdatunepia.asmmeta +// are properly updated. +// +ENUM ComponentCategory { + CategoryNotSet = -1, + CategoryOther = 0, + CategoryVideo, + CategoryAudio, + CategoryText, + CategorySubtitles, + CategoryCaptions, + CategorySuperimpose, + CategoryData, + CATEGORY_COUNT, +} ComponentCategory; + +// Component Status +ENUM ComponentStatus { + StatusActive, + StatusInactive, + StatusUnavailable, +} ComponentStatus; + + +//------------------------------------------------------------ +// +// BDA MPEG2 Component Type +// +// from the MPEG2 specification +ENUM MPEG2StreamType { + BDA_UNITIALIZED_MPEG2STREAMTYPE = -1, + Reserved1 = 0x00, + ISO_IEC_11172_2_VIDEO = 0x01, + ISO_IEC_13818_2_VIDEO = 0x02, + ISO_IEC_11172_3_AUDIO = 0x03, + ISO_IEC_13818_3_AUDIO = 0x04, + ISO_IEC_13818_1_PRIVATE_SECTION = 0x05, + ISO_IEC_13818_1_PES = 0x06, + ISO_IEC_13522_MHEG = 0x07, + ANNEX_A_DSM_CC = 0x08, + ITU_T_REC_H_222_1 = 0x09, + ISO_IEC_13818_6_TYPE_A = 0x0A, + ISO_IEC_13818_6_TYPE_B = 0x0B, + ISO_IEC_13818_6_TYPE_C = 0x0C, + ISO_IEC_13818_6_TYPE_D = 0x0D, + ISO_IEC_13818_1_AUXILIARY = 0x0E, + ISO_IEC_13818_7_AUDIO = 0x0F, + ISO_IEC_14496_2_VISUAL = 0x10, + ISO_IEC_14496_3_AUDIO = 0x11, + ISO_IEC_14496_1_IN_PES = 0x12, + ISO_IEC_14496_1_IN_SECTION = 0x13, + ISO_IEC_13818_6_DOWNLOAD = 0x14, + METADATA_IN_PES = 0x15, + METADATA_IN_SECTION = 0x16, + METADATA_IN_DATA_CAROUSEL = 0x17, + METADATA_IN_OBJECT_CAROUSEL = 0x18, + METADATA_IN_DOWNLOAD_PROTOCOL = 0x19, + IRPM_STREAMM = 0x1A, + ITU_T_H264 = 0x1B, + ISO_IEC_13818_1_RESERVED = 0x1C, // continues until 0x7F + USER_PRIVATE = 0x10, // standard says 0x80, retaining for backwards compatibility + HEVC_VIDEO_OR_TEMPORAL_VIDEO = 0x24, + HEVC_TEMPORAL_VIDEO_SUBSET = 0x25, + MPEG_H_AUDIO = 0x2D, // used for single-stream delivery or for the main stream in case of multi-stream delivery. + MPEG_H_AUDIO_MS = 0x2E, // used for additional (auxiliary) stream in case of MPEG-H multi-stream delivery. + ISO_IEC_USER_PRIVATE = 0x80, + DOLBY_AC3_AUDIO = 0x81, + DOLBY_DIGITAL_PLUS_AUDIO_ATSC = 0X87 +} MPEG2StreamType; + + + +//------------------------------------------------------------ +// +// mpeg-2 transport stride format block; associated with media +// types MEDIATYPE_Stream/MEDIASUBTYPE_MPEG2_TRANSPORT_STRIDE; +// *all* format blocks associated with above media type *must* +// start with the MPEG2_TRANSPORT_STRIDE structure +// + +#ifndef MANAGED_ENUMS +typedef struct _MPEG2_TRANSPORT_STRIDE { + DWORD dwOffset ; + DWORD dwPacketLength ; + DWORD dwStride ; +} MPEG2_TRANSPORT_STRIDE, *PMPEG2_TRANSPORT_STRIDE ; +#endif + +//------------------------------------------------------------ +// +// BDA ATSC Component Type +// +// +// ATSC made AC3 Audio a descriptor instead of +// defining a user private stream type. + +FLAGS ATSCComponentTypeFlags { + // bit flags for various component type properties + ATSCCT_AC3 = 0x00000001, +} ATSCComponentTypeFlags; + + +//------------------------------------------------------------ +// +// BDA Locators +// + + +ENUM BinaryConvolutionCodeRate { + BDA_BCC_RATE_NOT_SET = -1, + BDA_BCC_RATE_NOT_DEFINED = 0, + BDA_BCC_RATE_1_2 = 1, // 1/2 + BDA_BCC_RATE_2_3, // 2/3 + BDA_BCC_RATE_3_4, // 3/4 + BDA_BCC_RATE_3_5, // 3/5 + BDA_BCC_RATE_4_5, // 4/5 + BDA_BCC_RATE_5_6, // 5/6 + BDA_BCC_RATE_5_11, // 5/11 + BDA_BCC_RATE_7_8, // 7/8 + BDA_BCC_RATE_1_4, // 1/4 + BDA_BCC_RATE_1_3, // 1/3 + BDA_BCC_RATE_2_5, // 2/5 + BDA_BCC_RATE_6_7, // 6/7 + BDA_BCC_RATE_8_9, // 8/9 + BDA_BCC_RATE_9_10, // 9/10 + BDA_BCC_RATE_MAX, +} BinaryConvolutionCodeRate; + +ENUM FECMethod { + BDA_FEC_METHOD_NOT_SET = -1, + BDA_FEC_METHOD_NOT_DEFINED = 0, + BDA_FEC_VITERBI = 1, // FEC is a Viterbi Binary Convolution. + BDA_FEC_RS_204_188, // The FEC is Reed-Solomon 204/188 (outer FEC) + BDA_FEC_LDPC, // Low Density Parity Check error correction code + BDA_FEC_BCH, // Bose-Chaudhuri-Hocquenghem multiple error correction binary block code + BDA_FEC_RS_147_130, // The FEC is Reed-Solomon 147/130 (outer FEC) DirecTV-DSS + BDA_FEC_MAX, +} FECMethod; + +ENUM ModulationType { + BDA_MOD_NOT_SET = -1, + BDA_MOD_NOT_DEFINED = 0, + BDA_MOD_16QAM = 1, + BDA_MOD_32QAM, + BDA_MOD_64QAM, + BDA_MOD_80QAM, + BDA_MOD_96QAM, + BDA_MOD_112QAM, + BDA_MOD_128QAM, + BDA_MOD_160QAM, + BDA_MOD_192QAM, + BDA_MOD_224QAM, + BDA_MOD_256QAM, + BDA_MOD_320QAM, + BDA_MOD_384QAM, + BDA_MOD_448QAM, + BDA_MOD_512QAM, + BDA_MOD_640QAM, + BDA_MOD_768QAM, + BDA_MOD_896QAM, + BDA_MOD_1024QAM, + BDA_MOD_QPSK, // Quadrature Phase Shift Keying (including backwards compatible mode) + BDA_MOD_BPSK, // Binary Phase Shift Keying + BDA_MOD_OQPSK, // Offset QPSK + BDA_MOD_8VSB, // 8-Level Vestigial Sideband + BDA_MOD_16VSB, // 16-Level Vestigial Sideband + BDA_MOD_ANALOG_AMPLITUDE, // std am + BDA_MOD_ANALOG_FREQUENCY, // std fm + BDA_MOD_8PSK, // 8 Phase Shift Keying (including backwards compatible mode) + BDA_MOD_RF, // analog TV (Video standards such as NTSC/PAL/SECAM specified in IAnalogLocator VideoStandard property) + BDA_MOD_16APSK, // DVB-S2 modulation 16-Level APSK + BDA_MOD_32APSK, // DVB-S2 modulation 32-Level APSK + BDA_MOD_NBC_QPSK, // Non-Backwards Compatible Quadrature Phase Shift Keying + BDA_MOD_NBC_8PSK, // Non-Backwards Compatible 8 Phase Shift Keying + BDA_MOD_DIRECTV, // DIRECTV DSS + BDA_MOD_ISDB_T_TMCC, // Automatic demodulation by Transmission and Multiplexing Configuration Control signal for ISDB-T + BDA_MOD_ISDB_S_TMCC, // Automatic demodulation by Transmission and Multiplexing Configuration Control signal for ISDB-S + BDA_MOD_MAX, +} ModulationType; + +#ifdef _MANAGED +FLAGS TAG(ScanModulationTypes) : unsigned int +#else +// this is to silence enum warning C4369 +FLAGS TAG(ScanModulationTypes) +#endif +{ + BDA_SCAN_MOD_16QAM = 0x00000001, + BDA_SCAN_MOD_32QAM = 0x00000002, + BDA_SCAN_MOD_64QAM = 0x00000004, + BDA_SCAN_MOD_80QAM = 0x00000008, + BDA_SCAN_MOD_96QAM = 0x00000010, + BDA_SCAN_MOD_112QAM = 0x00000020, + BDA_SCAN_MOD_128QAM = 0x00000040, + BDA_SCAN_MOD_160QAM = 0x00000080, + BDA_SCAN_MOD_192QAM = 0x00000100, + BDA_SCAN_MOD_224QAM = 0x00000200, + BDA_SCAN_MOD_256QAM = 0x00000400, + BDA_SCAN_MOD_320QAM = 0x00000800, + BDA_SCAN_MOD_384QAM = 0x00001000, + BDA_SCAN_MOD_448QAM = 0x00002000, + BDA_SCAN_MOD_512QAM = 0x00004000, + BDA_SCAN_MOD_640QAM = 0x00008000, + BDA_SCAN_MOD_768QAM = 0x00010000, + BDA_SCAN_MOD_896QAM = 0x00020000, + BDA_SCAN_MOD_1024QAM = 0x00040000, + BDA_SCAN_MOD_QPSK = 0x00080000, + BDA_SCAN_MOD_BPSK = 0x00100000, + BDA_SCAN_MOD_OQPSK = 0x00200000, + BDA_SCAN_MOD_8VSB = 0x00400000, + BDA_SCAN_MOD_16VSB = 0x00800000, + BDA_SCAN_MOD_AM_RADIO = 0x01000000, + BDA_SCAN_MOD_FM_RADIO = 0x02000000, + BDA_SCAN_MOD_8PSK = 0x04000000, + BDA_SCAN_MOD_RF = 0x08000000, // analog TV + ScanModulationTypesMask_MCE_DigitalCable = BDA_MOD_64QAM | + BDA_MOD_256QAM, + ScanModulationTypesMask_MCE_TerrestrialATSC = BDA_MOD_8VSB, + ScanModulationTypesMask_MCE_AnalogTv = BDA_MOD_RF, + ScanModulationTypesMask_MCE_All_TV = 0xffffffff, + ScanModulationTypesMask_DVBC = BDA_MOD_64QAM | BDA_SCAN_MOD_128QAM | + BDA_MOD_256QAM, + BDA_SCAN_MOD_16APSK = 0x10000000, + BDA_SCAN_MOD_32APSK = 0x20000000, +} ScanModulationTypes; + +ENUM SpectralInversion { + BDA_SPECTRAL_INVERSION_NOT_SET = -1, + BDA_SPECTRAL_INVERSION_NOT_DEFINED = 0, + BDA_SPECTRAL_INVERSION_AUTOMATIC = 1, + BDA_SPECTRAL_INVERSION_NORMAL, + BDA_SPECTRAL_INVERSION_INVERTED, + BDA_SPECTRAL_INVERSION_MAX +} SpectralInversion; + +ENUM Polarisation { + BDA_POLARISATION_NOT_SET = -1, + BDA_POLARISATION_NOT_DEFINED = 0, + BDA_POLARISATION_LINEAR_H = 1, // Linear horizontal polarisation + BDA_POLARISATION_LINEAR_V, // Linear vertical polarisation + BDA_POLARISATION_CIRCULAR_L, // Circular left polarisation + BDA_POLARISATION_CIRCULAR_R, // Circular right polarisation + BDA_POLARISATION_MAX, +} Polarisation; + +ENUM LNB_Source { + BDA_LNB_SOURCE_NOT_SET = -1, + BDA_LNB_SOURCE_NOT_DEFINED = 0, + BDA_LNB_SOURCE_A = 1, // + BDA_LNB_SOURCE_B = 2, // + BDA_LNB_SOURCE_C = 3, // + BDA_LNB_SOURCE_D = 4, // + BDA_LNB_SOURCE_MAX, +} LNB_Source; + + +ENUM GuardInterval { + BDA_GUARD_NOT_SET = -1, + BDA_GUARD_NOT_DEFINED = 0, + BDA_GUARD_1_32 = 1, // Guard interval is 1/32 + BDA_GUARD_1_16, // Guard interval is 1/16 + BDA_GUARD_1_8, // Guard interval is 1/8 + BDA_GUARD_1_4, // Guard interval is 1/4 + BDA_GUARD_1_128, // Guard interval is 1/128 (DVB-T2) + BDA_GUARD_19_128, // Guard interval is 19/128 (DVB-T2) + BDA_GUARD_19_256, // Guard interval is 19/256 (DVB-T2) + BDA_GUARD_MAX, +} GuardInterval; + +ENUM HierarchyAlpha { + BDA_HALPHA_NOT_SET = -1, + BDA_HALPHA_NOT_DEFINED = 0, + BDA_HALPHA_1 = 1, // Hierarchy alpha is 1. + BDA_HALPHA_2, // Hierarchy alpha is 2. + BDA_HALPHA_4, // Hierarchy alpha is 4. + BDA_HALPHA_MAX, +} HierarchyAlpha; + +ENUM TransmissionMode { + BDA_XMIT_MODE_NOT_SET = -1, + BDA_XMIT_MODE_NOT_DEFINED = 0, + BDA_XMIT_MODE_2K = 1, // Transmission uses 1705 carriers (use a 2K FFT) + BDA_XMIT_MODE_8K, // Transmission uses 6817 carriers (use an 8K FFT) + BDA_XMIT_MODE_4K, + BDA_XMIT_MODE_2K_INTERLEAVED, + BDA_XMIT_MODE_4K_INTERLEAVED, + BDA_XMIT_MODE_1K, //DVB-T2 (use 1K FFT) + BDA_XMIT_MODE_16K, //DVB-T2 (use 16K FFT) + BDA_XMIT_MODE_32K, //DVB-T2 (use 32K FFT) + BDA_XMIT_MODE_MAX, +} TransmissionMode; + +ENUM RollOff { + BDA_ROLL_OFF_NOT_SET = -1, + BDA_ROLL_OFF_NOT_DEFINED = 0, + BDA_ROLL_OFF_20 = 1, // .20 Roll Off (DVB-S2 Only) + BDA_ROLL_OFF_25, // .25 Roll Off (DVB-S2 Only) + BDA_ROLL_OFF_35, // .35 Roll Off (DVB-S2 Only) + BDA_ROLL_OFF_MAX, +} RollOff; + +ENUM Pilot { + BDA_PILOT_NOT_SET = -1, + BDA_PILOT_NOT_DEFINED = 0, + BDA_PILOT_OFF = 1, // Pilot Off (DVB-S2 Only) + BDA_PILOT_ON, // Pilot On (DVB-S2 Only) + BDA_PILOT_MAX, +} Pilot; + +typedef struct _BDA_SIGNAL_TIMEOUTS +{ + ULONG ulCarrierTimeoutMs; + ULONG ulScanningTimeoutMs; + ULONG ulTuningTimeoutMs; +} BDA_SIGNAL_TIMEOUTS, *PBDA_SIGNAL_TIMEOUTS; + +// Settings for Tuner Frequency +// +ENUM BDA_Frequency { + BDA_FREQUENCY_NOT_SET = -1, + BDA_FREQUENCY_NOT_DEFINED = 0 +} BDA_Frequency; + +// Settings for Tuner Range +// +// Tuner range refers to the setting of LNB High/Low as well as the +// selection of a satellite on a multiple satellite switch. +// +ENUM BDA_Range { + BDA_RANGE_NOT_SET = -1, + BDA_RANGE_NOT_DEFINED = 0 +} BDA_Range; + +// Settings for Tuner Channel Bandwidth +// +ENUM BDA_Channel_Bandwidth { + BDA_CHAN_BANDWITH_NOT_SET = -1, + BDA_CHAN_BANDWITH_NOT_DEFINED = 0 +} BDA_Channel_Bandwidth; + +// Settings for Tuner Frequency Multiplier +// +ENUM BDA_Frequency_Multiplier { + BDA_FREQUENCY_MULTIPLIER_NOT_SET = -1, + BDA_FREQUENCY_MULTIPLIER_NOT_DEFINED = 0 +} BDA_Frequency_Multiplier; + +FLAGS BDA_Comp_Flags { + // equiv comparison rule overrides, default behavior is type specific + BDACOMP_NOT_DEFINED = 0x00000000, + BDACOMP_EXCLUDE_TS_FROM_TR = 0x00000001, // never put TS in TR equiv comparison + BDACOMP_INCLUDE_LOCATOR_IN_TR = 0x00000002, // always include loc in TR equiv comparison + BDACOMP_INCLUDE_COMPONENTS_IN_TR = 0x00000004, // always include components in TR equiv comparison +} BDA_Comp_Flags; + +ENUM ApplicationTypeType +{ + SCTE28_ConditionalAccess = 0, + SCTE28_POD_Host_Binding_Information, + SCTE28_IPService, + SCTE28_NetworkInterface_SCTE55_2, + SCTE28_NetworkInterface_SCTE55_1, + SCTE28_CopyProtection, + SCTE28_Diagnostic, + SCTE28_Undesignated, + SCTE28_Reserved, +}ApplicationTypeType; + + +ENUM BDA_CONDITIONALACCESS_REQUESTTYPE { + CONDITIONALACCESS_ACCESS_UNSPECIFIED = 0, + CONDITIONALACCESS_ACCESS_NOT_POSSIBLE, + CONDITIONALACCESS_ACCESS_POSSIBLE, + CONDITIONALACCESS_ACCESS_POSSIBLE_NO_STREAMING_DISRUPTION +} BDA_CONDITIONALACCESS_REQUESTTYPE; + +ENUM BDA_CONDITIONALACCESS_MMICLOSEREASON { + CONDITIONALACCESS_UNSPECIFIED = 0, + CONDITIONALACCESS_CLOSED_ITSELF, + CONDITIONALACCESS_TUNER_REQUESTED_CLOSE, + CONDITIONALACCESS_DIALOG_TIMEOUT, + CONDITIONALACCESS_DIALOG_FOCUS_CHANGE, + CONDITIONALACCESS_DIALOG_USER_DISMISSED, + CONDITIONALACCESS_DIALOG_USER_NOT_AVAILABLE +} BDA_CONDITIONALACCESS_MMICLOSEREASON; + +ENUM BDA_CONDITIONALACCESS_SESSION_RESULT { + CONDITIONALACCESS_SUCCESSFULL = 0, + CONDITIONALACCESS_ENDED_NOCHANGE, + CONDITIONALACCESS_ABORTED +} BDA_CONDITIONALACCESS_SESSION_RESULT; + +ENUM BDA_DISCOVERY_STATE { + BDA_DISCOVERY_UNSPECIFIED = 0, + BDA_DISCOVERY_REQUIRED, + BDA_DISCOVERY_COMPLETE +} BDA_DISCOVERY_STATE; + +// Digital Demodulator for DVBT2 Physical Layer Pipe +#define BDA_PLP_ID_NOT_SET -1 + +#include + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // not defined _BDATYPES_ + +// end of file -- bdatypes.h diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthdef.h new file mode 100644 index 0000000000000000000000000000000000000000..51442e3699df42a729bb50fc6557e464fc3d65b0 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthdef.h @@ -0,0 +1,1339 @@ +/*++ + +Copyright (c) 2000 Microsoft Corporation + +Module Name: + + bthdef.h + +Abstract: + + This module contains the Bluetooth common structures and definitions + +Author: + +Notes: + +Environment: + + Kernel mode only + +Revision History: + + --*/ + +#ifndef __BTHDEF_H__ +#define __BTHDEF_H__ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// Bluetooth 2.1 support added in KB942567 +// +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + + #define BTH_MAJORVERSION 2 + #define BTH_MINORVERSION 1 + +#elif(NTDDI_VERSION >= NTDDI_WINXPSP2) + + #define BTH_MAJORVERSION 2 + #define BTH_MINORVERSION 0 + +#endif // >= SP1+KB942567 + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // nameless struct/union + +#if (NTDDI_VERSION >= NTDDI_WINXPSP2) + +#ifndef GUID_DEFS_ONLY + #ifndef NO_BTHSDPDEF_INC + #include "bthsdpdef.h" + #endif // NO_BTHSDPDEF_INC +#endif // GUID_DEFS_ONLY + +#ifndef NO_GUID_DEFS + +// {0850302A-B344-4fda-9BE9-90576B8D46F0} +DEFINE_GUID(GUID_BTHPORT_DEVICE_INTERFACE, 0x850302a, 0xb344, 0x4fda, 0x9b, 0xe9, 0x90, 0x57, 0x6b, 0x8d, 0x46, 0xf0); + +// RFCOMM device interface GUID for RFCOMM services +// {b142fc3e-fa4e-460b-8abc-072b628b3c70} +DEFINE_GUID(GUID_BTH_RFCOMM_SERVICE_DEVICE_INTERFACE, 0xb142fc3e, 0xfa4e, 0x460b, 0x8a, 0xbc, 0x07, 0x2b, 0x62, 0x8b, 0x3c, 0x70); + +// {EA3B5B82-26EE-450E-B0D8-D26FE30A3869} +DEFINE_GUID(GUID_BLUETOOTH_RADIO_IN_RANGE, 0xea3b5b82, 0x26ee, 0x450e, 0xb0, 0xd8, 0xd2, 0x6f, 0xe3, 0x0a, 0x38, 0x69); + +// {E28867C9-C2AA-4CED-B969-4570866037C4} +DEFINE_GUID(GUID_BLUETOOTH_RADIO_OUT_OF_RANGE, 0xe28867c9, 0xc2aa, 0x4ced, 0xb9, 0x69, 0x45, 0x70, 0x86, 0x60, 0x37, 0xc4); + +// {7EAE4030-B709-4AA8-AC55-E953829C9DAA} +DEFINE_GUID(GUID_BLUETOOTH_L2CAP_EVENT, 0x7eae4030, 0xb709, 0x4aa8, 0xac, 0x55, 0xe9, 0x53, 0x82, 0x9c, 0x9d, 0xaa); + +// {FC240062-1541-49BE-B463-84C4DCD7BF7F} +DEFINE_GUID(GUID_BLUETOOTH_HCI_EVENT, 0xfc240062, 0x1541, 0x49be, 0xb4, 0x63, 0x84, 0xc4, 0xdc, 0xd7, 0xbf, 0x7f); + +// +// Support added in KB942567 +// +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + +// {5DC9136D-996C-46DB-84F5-32C0A3F47352} +DEFINE_GUID(GUID_BLUETOOTH_AUTHENTICATION_REQUEST, 0x5DC9136D, 0x996C, 0x46DB, 0x84, 0xF5, 0x32, 0xC0, 0xA3, 0xF4, 0x73, 0x52); + +// {D668DFCD-0F4E-4EFC-BFE0-392EEEC5109C} +DEFINE_GUID(GUID_BLUETOOTH_KEYPRESS_EVENT, 0xD668DFCD, 0x0F4E, 0x4EFC, 0xBF, 0xE0, 0x39, 0x2E, 0xEE, 0xC5, 0x10, 0x9C); + +// {547247e6-45bb-4c33-af8c-c00efe15a71d} +DEFINE_GUID(GUID_BLUETOOTH_HCI_VENDOR_EVENT, 0x547247e6, 0x45bb, 0x4c33, 0xaf, 0x8c, 0xc0, 0x0e, 0xfe, 0x15, 0xa7, 0x1d); + +#endif // >= SP1+KB942567 + +// +// Bluetooth base UUID for service discovery +// +DEFINE_GUID(Bluetooth_Base_UUID, 0x00000000, 0x0000, 0x1000, 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB); + +// +// Creates the 128-bit UUID from a short id by using the Bluetooth base UUID +// {-0000-1000-8000-00805F9B34FB} +// +#define DEFINE_BLUETOOTH_UUID128(name,shortId) \ + DEFINE_GUID(name,shortId,0x0000,0x1000,0x80,0x00,0x00,0x80,0x5F,0x9B,0x34,0xFB) + + +// +// UUIDs for the Protocol Identifiers, Service Discovery Assigned Numbers +// +#define SDP_PROTOCOL_UUID16 (0x0001) +#define UDP_PROTOCOL_UUID16 (0x0002) +#define RFCOMM_PROTOCOL_UUID16 (0x0003) +#define TCP_PROTOCOL_UUID16 (0x0004) +#define TCSBIN_PROTOCOL_UUID16 (0x0005) +#define TCSAT_PROTOCOL_UUID16 (0x0006) +#define ATT_PROTOCOL_UUID16 (0x0007) +#define OBEX_PROTOCOL_UUID16 (0x0008) +#define IP_PROTOCOL_UUID16 (0x0009) +#define FTP_PROTOCOL_UUID16 (0x000A) +#define HTTP_PROTOCOL_UUID16 (0x000C) +#define WSP_PROTOCOL_UUID16 (0x000E) +#define BNEP_PROTOCOL_UUID16 (0x000F) +#define UPNP_PROTOCOL_UUID16 (0x0010) +#define HID_PROTOCOL_UUID16 (0x0011) +#define HCCC_PROTOCOL_UUID16 (0x0012) +#define HCDC_PROTOCOL_UUID16 (0x0014) +#define HCN_PROTOCOL_UUID16 (0x0016) +#define AVCTP_PROTOCOL_UUID16 (0x0017) +#define AVDTP_PROTOCOL_UUID16 (0x0019) +#define CMPT_PROTOCOL_UUID16 (0x001B) +#define UDI_C_PLANE_PROTOCOL_UUID16 (0x001D) +#define L2CAP_PROTOCOL_UUID16 (0x0100) + +DEFINE_BLUETOOTH_UUID128(SDP_PROTOCOL_UUID, SDP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(UDP_PROTOCOL_UUID, UDP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(RFCOMM_PROTOCOL_UUID, RFCOMM_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(TCP_PROTOCOL_UUID, TCP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(TCSBIN_PROTOCOL_UUID, TCSBIN_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(TCSAT_PROTOCOL_UUID, TCSAT_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(ATT_PROTOCOL_UUID, ATT_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(OBEX_PROTOCOL_UUID, OBEX_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(IP_PROTOCOL_UUID, IP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(FTP_PROTOCOL_UUID, FTP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(HTTP_PROTOCOL_UUID, HTTP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(WSP_PROTOCOL_UUID, WSP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(BNEP_PROTOCOL_UUID, BNEP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(UPNP_PROTOCOL_UUID, UPNP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(HID_PROTOCOL_UUID, HID_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(HCCC_PROTOCOL_UUID, HCCC_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(HCDC_PROTOCOL_UUID, HCDC_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(HCN_PROTOCOL_UUID, HCN_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(AVCTP_PROTOCOL_UUID, AVCTP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(AVDTP_PROTOCOL_UUID, AVDTP_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(CMPT_PROTOCOL_UUID, CMPT_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(UDI_C_PLANE_PROTOCOL_UUID, UDI_C_PLANE_PROTOCOL_UUID16); +DEFINE_BLUETOOTH_UUID128(L2CAP_PROTOCOL_UUID, L2CAP_PROTOCOL_UUID16); + +// +// UUIDs for Service Class IDs, Service Discovery Assigned Numbers +// +#define ServiceDiscoveryServerServiceClassID_UUID16 (0x1000) +#define BrowseGroupDescriptorServiceClassID_UUID16 (0x1001) +#define PublicBrowseGroupServiceClassID_UUID16 (0x1002) + +#define SerialPortServiceClassID_UUID16 (0x1101) +#define LANAccessUsingPPPServiceClassID_UUID16 (0x1102) +#define DialupNetworkingServiceClassID_UUID16 (0x1103) +#define IrMCSyncServiceClassID_UUID16 (0x1104) +#define OBEXObjectPushServiceClassID_UUID16 (0x1105) +#define OBEXFileTransferServiceClassID_UUID16 (0x1106) +#define IrMcSyncCommandServiceClassID_UUID16 (0x1107) +#define HeadsetServiceClassID_UUID16 (0x1108) +#define CordlessTelephonyServiceClassID_UUID16 (0x1109) +#define AudioSourceServiceClassID_UUID16 (0x110A) +#define AudioSinkServiceClassID_UUID16 (0x110B) +#define AVRemoteControlTargetServiceClassID_UUID16 (0x110C) +#define AVRemoteControlServiceClassID_UUID16 (0x110E) +#define AVRemoteControlControllerServiceClass_UUID16 (0x110F) +#define IntercomServiceClassID_UUID16 (0x1110) +#define FaxServiceClassID_UUID16 (0x1111) +#define HeadsetAudioGatewayServiceClassID_UUID16 (0x1112) +#define WAPServiceClassID_UUID16 (0x1113) +#define WAPClientServiceClassID_UUID16 (0x1114) +#define PANUServiceClassID_UUID16 (0x1115) +#define NAPServiceClassID_UUID16 (0x1116) +#define GNServiceClassID_UUID16 (0x1117) +#define DirectPrintingServiceClassID_UUID16 (0x1118) +#define ReferencePrintingServiceClassID_UUID16 (0x1119) +#define ImagingResponderServiceClassID_UUID16 (0x111B) +#define ImagingAutomaticArchiveServiceClassID_UUID16 (0x111C) +#define ImagingReferenceObjectsServiceClassID_UUID16 (0x111D) +#define HandsfreeServiceClassID_UUID16 (0x111E) +#define HandsfreeAudioGatewayServiceClassID_UUID16 (0x111F) +#define DirectPrintingReferenceObjectsServiceClassID_UUID16 \ + (0x1120) +#define ReflectsUIServiceClassID_UUID16 (0x1121) +#define PrintingStatusServiceClassID_UUID16 (0x1123) +#define HumanInterfaceDeviceServiceClassID_UUID16 (0x1124) +#define HCRPrintServiceClassID_UUID16 (0x1126) +#define HCRScanServiceClassID_UUID16 (0x1127) +#define CommonISDNAccessServiceClassID_UUID16 (0x1128) +#define VideoConferencingGWServiceClassID_UUID16 (0x1129) +#define UDIMTServiceClassID_UUID16 (0x112A) +#define UDITAServiceClassID_UUID16 (0x112B) +#define AudioVideoServiceClassID_UUID16 (0x112C) +#define SimAccessServiceClassID_UUID16 (0x112D) +#define PhonebookAccessPceServiceClassID_UUID16 (0x112E) +#define PhonebookAccessPseServiceClassID_UUID16 (0x112F) + +#define HeadsetHSServiceClassID_UUID16 (0x1131) +#define MessageAccessServerServiceClassID_UUID16 (0x1132) +#define MessageNotificationServerServiceClassID_UUID16 (0x1133) + +#define GNSSServerServiceClassID_UUID16 (0x1136) +#define ThreeDimensionalDisplayServiceClassID_UUID16 (0x1137) +#define ThreeDimensionalGlassesServiceClassID_UUID16 (0x1138) + +#define MPSServiceClassID_UUID16 (0x113B) +#define CTNAccessServiceClassID_UUID16 (0x113C) +#define CTNNotificationServiceClassID_UUID16 (0x113D) + +#define PnPInformationServiceClassID_UUID16 (0x1200) +#define GenericNetworkingServiceClassID_UUID16 (0x1201) +#define GenericFileTransferServiceClassID_UUID16 (0x1202) +#define GenericAudioServiceClassID_UUID16 (0x1203) +#define GenericTelephonyServiceClassID_UUID16 (0x1204) +#define UPnpServiceClassID_UUID16 (0x1205) +#define UPnpIpServiceClassID_UUID16 (0x1206) + +#define ESdpUpnpIpPanServiceClassID_UUID16 (0x1300) +#define ESdpUpnpIpLapServiceClassID_UUID16 (0x1301) +#define ESdpUpnpL2capServiceClassID_UUID16 (0x1302) +#define VideoSourceServiceClassID_UUID16 (0x1303) +#define VideoSinkServiceClassID_UUID16 (0x1304) + +#define HealthDeviceProfileSourceServiceClassID_UUID16 (0x1401) +#define HealthDeviceProfileSinkServiceClassID_UUID16 (0x1402) + +DEFINE_BLUETOOTH_UUID128(ServiceDiscoveryServerServiceClassID_UUID, ServiceDiscoveryServerServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(BrowseGroupDescriptorServiceClassID_UUID, BrowseGroupDescriptorServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(PublicBrowseGroupServiceClass_UUID, PublicBrowseGroupServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(SerialPortServiceClass_UUID, SerialPortServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(LANAccessUsingPPPServiceClass_UUID, LANAccessUsingPPPServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(DialupNetworkingServiceClass_UUID, DialupNetworkingServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(IrMCSyncServiceClass_UUID, IrMCSyncServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(OBEXObjectPushServiceClass_UUID, OBEXObjectPushServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(OBEXFileTransferServiceClass_UUID, OBEXFileTransferServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(IrMCSyncCommandServiceClass_UUID, IrMcSyncCommandServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HeadsetServiceClass_UUID, HeadsetServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(CordlessTelephonyServiceClass_UUID, CordlessTelephonyServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AudioSourceServiceClass_UUID, AudioSourceServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AudioSinkServiceClass_UUID, AudioSinkServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AVRemoteControlTargetServiceClass_UUID, AVRemoteControlTargetServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AVRemoteControlServiceClass_UUID, AVRemoteControlServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AVRemoteControlControllerServiceClass_UUID, AVRemoteControlControllerServiceClass_UUID16); +DEFINE_BLUETOOTH_UUID128(IntercomServiceClass_UUID, IntercomServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(FaxServiceClass_UUID, FaxServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HeadsetAudioGatewayServiceClass_UUID, HeadsetAudioGatewayServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(WAPServiceClass_UUID, WAPServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(WAPClientServiceClass_UUID, WAPClientServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(PANUServiceClass_UUID, PANUServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(NAPServiceClass_UUID, NAPServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(GNServiceClass_UUID, GNServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(DirectPrintingServiceClass_UUID, DirectPrintingServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ReferencePrintingServiceClass_UUID, ReferencePrintingServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ImagingResponderServiceClass_UUID, ImagingResponderServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ImagingAutomaticArchiveServiceClass_UUID, ImagingAutomaticArchiveServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ImagingReferenceObjectsServiceClass_UUID, ImagingReferenceObjectsServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HandsfreeServiceClass_UUID, HandsfreeServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HandsfreeAudioGatewayServiceClass_UUID, HandsfreeAudioGatewayServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(DirectPrintingReferenceObjectsServiceClass_UUID, DirectPrintingReferenceObjectsServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ReflectedUIServiceClass_UUID, ReflectsUIServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(PrintingStatusServiceClass_UUID, PrintingStatusServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HumanInterfaceDeviceServiceClass_UUID, HumanInterfaceDeviceServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HCRPrintServiceClass_UUID, HCRPrintServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HCRScanServiceClass_UUID, HCRScanServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(CommonISDNAccessServiceClass_UUID, CommonISDNAccessServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(VideoConferencingGWServiceClass_UUID, VideoConferencingGWServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(UDIMTServiceClass_UUID, UDIMTServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(UDITAServiceClass_UUID, UDITAServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(AudioVideoServiceClass_UUID, AudioVideoServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(SimAccessServiceClass_UUID, SimAccessServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(PhonebookAccessPceServiceClass_UUID, PhonebookAccessPceServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(PhonebookAccessPseServiceClass_UUID, PhonebookAccessPseServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(HeadsetHSServiceClass_UUID, HeadsetHSServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(MessageAccessServerServiceClass_UUID, MessageAccessServerServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(MessageNotificationServerServiceClass_UUID, MessageNotificationServerServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(GNSSServerServiceClass_UUID, GNSSServerServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ThreeDimensionalDisplayServiceClass_UUID, ThreeDimensionalDisplayServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ThreeDimensionalGlassesServiceClass_UUID, ThreeDimensionalGlassesServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(MPSServiceClass_UUID, MPSServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(CTNAccessServiceClass_UUID, CTNAccessServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(CTNNotificationServiceClass_UUID, CTNNotificationServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(PnPInformationServiceClass_UUID, PnPInformationServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(GenericNetworkingServiceClass_UUID, GenericNetworkingServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(GenericFileTransferServiceClass_UUID, GenericFileTransferServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(GenericAudioServiceClass_UUID, GenericAudioServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(GenericTelephonyServiceClass_UUID, GenericTelephonyServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(UPnpServiceClass_UUID, UPnpServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(UPnpIpServiceClass_UUID, UPnpIpServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(ESdpUpnpIpPanServiceClass_UUID, ESdpUpnpIpPanServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ESdpUpnpIpLapServiceClass_UUID, ESdpUpnpIpLapServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(ESdpUpnpL2capServiceClass_UUID, ESdpUpnpL2capServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(VideoSourceServiceClass_UUID, VideoSourceServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(VideoSinkServiceClass_UUID, VideoSinkServiceClassID_UUID16); + +DEFINE_BLUETOOTH_UUID128(HealthDeviceProfileSourceServiceClass_UUID, HealthDeviceProfileSourceServiceClassID_UUID16); +DEFINE_BLUETOOTH_UUID128(HealthDeviceProfileSinkServiceClass_UUID, HealthDeviceProfileSinkServiceClassID_UUID16); + +// +// UUIDs for SIG defined profiles, Service Discovery Assigned Numbers +// +#define AdvancedAudioDistributionProfileID_UUID16 (0x110D) +#define ImagingServiceProfileID_UUID16 (0x111A) +#define BasicPrintingProfileID_UUID16 (0x1122) +#define HardcopyCableReplacementProfileID_UUID16 (0x1125) +#define PhonebookAccessProfileID_UUID16 (0x1130) +#define MessageAccessProfileID_UUID16 (0x1134) +#define GNSSProfileID_UUID16 (0x1135) +#define ThreeDimensionalSynchronizationProfileID_UUID16 (0x1139) +#define MPSProfileID_UUID16 (0x113A) +#define CTNProfileID_UUID16 (0x113E) +#define VideoDistributionProfileID_UUID16 (0x1305) +#define HealthDeviceProfileID_UUID16 (0x1400) + +DEFINE_BLUETOOTH_UUID128(AdvancedAudioDistributionProfile_UUID, AdvancedAudioDistributionProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(ImagingServiceProfile_UUID, ImagingServiceProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(BasicPrintingProfile_UUID, BasicPrintingProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(HardcopyCableReplacementProfile_UUID, HardcopyCableReplacementProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(PhonebookAccessProfile_UUID, PhonebookAccessProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(MessageAccessProfile_UUID, MessageAccessProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(GNSSProfile_UUID, GNSSProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(ThreeDimensionalSynchronizationProfile_UUID, ThreeDimensionalSynchronizationProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(MPSProfile_UUID, MPSProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(CTNProfile_UUID, CTNProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(VideoDistributionProfile_UUID, VideoDistributionProfileID_UUID16); +DEFINE_BLUETOOTH_UUID128(HealthDeviceProfile_UUID, HealthDeviceProfileID_UUID16); + +// +// The SIG renamed the uuid for VideoConferencingServiceClass +// +#define VideoConferencingServiceClass_UUID AVRemoteControlControllerServiceClass_UUID +#define VideoConferencingServiceClassID_UUID16 AVRemoteControlControllerServiceClass_UUID16 + +// +// Fixing typos introduced in previous releases +// +#define HN_PROTOCOL_UUID HCN_PROTOCOL_UUID +#define BasicPringingServiceClass_UUID BasicPrintingProfile_UUID + +// +// Fixing naming inconsistencies in UUID16 list +// +#define CommonISDNAccessServiceClass_UUID16 CommonISDNAccessServiceClassID_UUID16 +#define VideoConferencingGWServiceClass_UUID16 VideoConferencingGWServiceClassID_UUID16 +#define UDIMTServiceClass_UUID16 UDIMTServiceClassID_UUID16 +#define UDITAServiceClass_UUID16 UDITAServiceClassID_UUID16 +#define AudioVideoServiceClass_UUID16 AudioVideoServiceClassID_UUID16 + +// +// Fixing naming inconsistencies in profile list +// +#define CordlessServiceClassID_UUID16 CordlessTelephonyServiceClassID_UUID16 +#define AudioSinkSourceServiceClassID_UUID16 AudioSinkServiceClassID_UUID16 +#define AdvancedAudioDistributionServiceClassID_UUID16 AdvancedAudioDistributionProfileID_UUID16 +#define ImagingServiceClassID_UUID16 ImagingServiceProfileID_UUID16 +#define BasicPrintingServiceClassID_UUID16 BasicPrintingProfileID_UUID16 +#define HardcopyCableReplacementServiceClassID_UUID16 HardcopyCableReplacementProfileID_UUID16 + +#define AdvancedAudioDistributionServiceClass_UUID AdvancedAudioDistributionProfile_UUID +#define ImagingServiceClass_UUID ImagingServiceProfile_UUID +#define BasicPrintingServiceClass_UUID BasicPrintingProfile_UUID +#define HardcopyCableReplacementServiceClass_UUID HardcopyCableReplacementProfile_UUID +#define VideoDistributionServiceClass_UUID VideoDistributionProfile_UUID + +#endif // NO_GUID_DEFS + +#ifndef GUID_DEFS_ONLY + +// +// max length of device friendly name. +// +#define BTH_MAX_NAME_SIZE (248) + +#define BTH_MAX_PIN_SIZE (16) +#define BTH_LINK_KEY_LENGTH (16) + +#define BTH_MFG_ERICSSON (0) +#define BTH_MFG_NOKIA (1) +#define BTH_MFG_INTEL (2) +#define BTH_MFG_IBM (3) +#define BTH_MFG_TOSHIBA (4) +#define BTH_MFG_3COM (5) +#define BTH_MFG_MICROSOFT (6) +#define BTH_MFG_LUCENT (7) +#define BTH_MFG_MOTOROLA (8) +#define BTH_MFG_INFINEON (9) +#define BTH_MFG_CSR (10) +#define BTH_MFG_SILICONWAVE (11) +#define BTH_MFG_DIGIANSWER (12) +#define BTH_MFG_TI (13) +#define BTH_MFG_PARTHUS (14) +#define BTH_MFG_BROADCOM (15) +#define BTH_MFG_MITEL (16) +#define BTH_MFG_WIDCOMM (17) +#define BTH_MFG_ZEEVO (18) +#define BTH_MFG_ATMEL (19) +#define BTH_MFG_MITSIBUSHI (20) +#define BTH_MFG_RTX_TELECOM (21) +#define BTH_MFG_KC_TECHNOLOGY (22) +#define BTH_MFG_NEWLOGIC (23) +#define BTH_MFG_TRANSILICA (24) +#define BTH_MFG_ROHDE_SCHWARZ (25) +#define BTH_MFG_TTPCOM (26) +#define BTH_MFG_SIGNIA (27) +#define BTH_MFG_CONEXANT (28) +#define BTH_MFG_QUALCOMM (29) +#define BTH_MFG_INVENTEL (30) +#define BTH_MFG_AVM_BERLIN (31) +#define BTH_MFG_BANDSPEED (32) +#define BTH_MFG_MANSELLA (33) +#define BTH_MFG_NEC (34) +#define BTH_MFG_WAVEPLUS_TECHNOLOGY_CO (35) +#define BTH_MFG_ALCATEL (36) +#define BTH_MFG_PHILIPS_SEMICONDUCTOR (37) +#define BTH_MFG_C_TECHNOLOGIES (38) +#define BTH_MFG_OPEN_INTERFACE (39) +#define BTH_MFG_RF_MICRO_DEVICES (40) +#define BTH_MFG_HITACHI (41) +#define BTH_MFG_SYMBOL_TECHNOLOGIES (42) +#define BTH_MFG_TENOVIS (43) +#define BTH_MFG_MACRONIX_INTERNATIONAL (44) +#define BTH_MFG_MARVELL (72) +#define BTH_MFG_APPLE (76) +#define BTH_MFG_NORDIC_SEMICONDUCTORS_ASA (89) +#define BTH_MFG_ARUBA_NETWORKS (283) +#define BTH_MFG_INTERNAL_USE (65535) + +typedef ULONGLONG BTH_ADDR, *PBTH_ADDR; +typedef ULONG BTH_COD, *PBTH_COD; +typedef ULONG BTH_LAP, *PBTH_LAP; + +#define BTH_ADDR_NULL ((ULONGLONG) 0x0000000000000000) + +#define NAP_MASK ((ULONGLONG) 0xFFFF00000000) +#define SAP_MASK ((ULONGLONG) 0x0000FFFFFFFF) + +#define NAP_BIT_OFFSET (8 * 4) +#define SAP_BIT_OFFSET (0) + +#define GET_NAP(_bth_addr) ((USHORT) (((_bth_addr) & NAP_MASK) >> NAP_BIT_OFFSET)) +#define GET_SAP(_bth_addr) ((ULONG) (((_bth_addr) & SAP_MASK) >> SAP_BIT_OFFSET)) + +#define SET_NAP(_nap) (((ULONGLONG) ((USHORT) (_nap))) << NAP_BIT_OFFSET) +#define SET_SAP(_sap) (((ULONGLONG) ((ULONG) (_sap))) << SAP_BIT_OFFSET) + +#define SET_NAP_SAP(_nap, _sap) (SET_NAP(_nap) | SET_SAP(_sap)) + +#define COD_FORMAT_BIT_OFFSET (0) +#define COD_MINOR_BIT_OFFSET (2) +#define COD_MAJOR_BIT_OFFSET (8 * 1) +#define COD_SERVICE_BIT_OFFSET (8 * 1 + 5) + +#define COD_FORMAT_MASK (0x000003) +#define COD_MINOR_MASK (0x0000FC) +#define COD_MAJOR_MASK (0x001F00) +#define COD_SERVICE_MASK (0xFFE000) + +#define GET_COD_FORMAT(_cod) ( (_cod) & COD_FORMAT_MASK >> COD_FORMAT_BIT_OFFSET) +#define GET_COD_MINOR(_cod) (((_cod) & COD_MINOR_MASK) >> COD_MINOR_BIT_OFFSET) +#define GET_COD_MAJOR(_cod) (((_cod) & COD_MAJOR_MASK) >> COD_MAJOR_BIT_OFFSET) +#define GET_COD_SERVICE(_cod) (((_cod) & COD_SERVICE_MASK) >> COD_SERVICE_BIT_OFFSET) + +#define SET_COD_MINOR(_cod, _minor) (_cod) = ((_cod) & ~COD_MINOR_MASK) | ((_minor) << COD_MINOR_BIT_OFFSET) +#define SET_COD_MAJOR(_cod, _major) (_cod) = ((_cod) & ~COD_MAJOR_MASK) | ((_major) << COD_MAJOR_BIT_OFFSET) +#define SET_COD_SERVICE(_cod, _service) (_cod) = ((_cod) & ~COD_SERVICE_MASK) | ((_service) << COD_SERVICE_BIT_OFFSET) + +#define COD_VERSION (0x0) + +#define COD_SERVICE_LIMITED (0x0001) +#define COD_SERVICE_LE_AUDIO (0x0002) +#define COD_SERVICE_POSITIONING (0x0008) +#define COD_SERVICE_NETWORKING (0x0010) +#define COD_SERVICE_RENDERING (0x0020) +#define COD_SERVICE_CAPTURING (0x0040) +#define COD_SERVICE_OBJECT_XFER (0x0080) +#define COD_SERVICE_AUDIO (0x0100) +#define COD_SERVICE_TELEPHONY (0x0200) +#define COD_SERVICE_INFORMATION (0x0400) + +#define COD_SERVICE_VALID_MASK (COD_SERVICE_LIMITED | \ + COD_SERVICE_LE_AUDIO | \ + COD_SERVICE_POSITIONING | \ + COD_SERVICE_NETWORKING | \ + COD_SERVICE_RENDERING | \ + COD_SERVICE_CAPTURING | \ + COD_SERVICE_OBJECT_XFER |\ + COD_SERVICE_AUDIO |\ + COD_SERVICE_TELEPHONY |\ + COD_SERVICE_INFORMATION) + +#define COD_SERVICE_MAX_COUNT (10) + +// +// Major class codes +// +#define COD_MAJOR_MISCELLANEOUS (0x00) +#define COD_MAJOR_COMPUTER (0x01) +#define COD_MAJOR_PHONE (0x02) +#define COD_MAJOR_LAN_ACCESS (0x03) +#define COD_MAJOR_AUDIO (0x04) +#define COD_MAJOR_PERIPHERAL (0x05) +#define COD_MAJOR_IMAGING (0x06) +#define COD_MAJOR_WEARABLE (0x07) +#define COD_MAJOR_TOY (0x08) +#define COD_MAJOR_HEALTH (0x09) +#define COD_MAJOR_UNCLASSIFIED (0x1F) + +// +// Minor class codes specific to each major class +// +#define COD_COMPUTER_MINOR_UNCLASSIFIED (0x00) +#define COD_COMPUTER_MINOR_DESKTOP (0x01) +#define COD_COMPUTER_MINOR_SERVER (0x02) +#define COD_COMPUTER_MINOR_LAPTOP (0x03) +#define COD_COMPUTER_MINOR_HANDHELD (0x04) +#define COD_COMPUTER_MINOR_PALM (0x05) +#define COD_COMPUTER_MINOR_WEARABLE (0x06) + +#define COD_PHONE_MINOR_UNCLASSIFIED (0x00) +#define COD_PHONE_MINOR_CELLULAR (0x01) +#define COD_PHONE_MINOR_CORDLESS (0x02) +#define COD_PHONE_MINOR_SMART (0x03) +#define COD_PHONE_MINOR_WIRED_MODEM (0x04) + +#define COD_AUDIO_MINOR_UNCLASSIFIED (0x00) +#define COD_AUDIO_MINOR_HEADSET (0x01) +#define COD_AUDIO_MINOR_HANDS_FREE (0x02) +#define COD_AUDIO_MINOR_HEADSET_HANDS_FREE (0x03) +#define COD_AUDIO_MINOR_MICROPHONE (0x04) +#define COD_AUDIO_MINOR_LOUDSPEAKER (0x05) +#define COD_AUDIO_MINOR_HEADPHONES (0x06) +#define COD_AUDIO_MINOR_PORTABLE_AUDIO (0x07) +#define COD_AUDIO_MINOR_CAR_AUDIO (0x08) +#define COD_AUDIO_MINOR_SET_TOP_BOX (0x09) +#define COD_AUDIO_MINOR_HIFI_AUDIO (0x0A) +#define COD_AUDIO_MINOR_VCR (0x0B) +#define COD_AUDIO_MINOR_VIDEO_CAMERA (0x0C) +#define COD_AUDIO_MINOR_CAMCORDER (0x0D) +#define COD_AUDIO_MINOR_VIDEO_MONITOR (0x0E) +#define COD_AUDIO_MINOR_VIDEO_DISPLAY_LOUDSPEAKER \ + (0x0F) +#define COD_AUDIO_MINOR_VIDEO_DISPLAY_CONFERENCING \ + (0x10) +// #define COD_AUDIO_MINOR_RESERVED (0x11) +#define COD_AUDIO_MINOR_GAMING_TOY (0x12) + +#define COD_PERIPHERAL_MINOR_KEYBOARD_MASK (0x10) +#define COD_PERIPHERAL_MINOR_POINTER_MASK (0x20) + +#define COD_PERIPHERAL_MINOR_NO_CATEGORY (0x00) +#define COD_PERIPHERAL_MINOR_JOYSTICK (0x01) +#define COD_PERIPHERAL_MINOR_GAMEPAD (0x02) +#define COD_PERIPHERAL_MINOR_REMOTE_CONTROL (0x03) +#define COD_PERIPHERAL_MINOR_SENSING (0x04) + +#define COD_IMAGING_MINOR_DISPLAY_MASK (0x04) +#define COD_IMAGING_MINOR_CAMERA_MASK (0x08) +#define COD_IMAGING_MINOR_SCANNER_MASK (0x10) +#define COD_IMAGING_MINOR_PRINTER_MASK (0x20) + +#define COD_WEARABLE_MINOR_WRIST_WATCH (0x01) +#define COD_WEARABLE_MINOR_PAGER (0x02) +#define COD_WEARABLE_MINOR_JACKET (0x03) +#define COD_WEARABLE_MINOR_HELMET (0x04) +#define COD_WEARABLE_MINOR_GLASSES (0x05) + +#define COD_TOY_MINOR_ROBOT (0x01) +#define COD_TOY_MINOR_VEHICLE (0x02) +#define COD_TOY_MINOR_DOLL_ACTION_FIGURE (0x03) +#define COD_TOY_MINOR_CONTROLLER (0x04) +#define COD_TOY_MINOR_GAME (0x05) + +#define COD_HEALTH_MINOR_BLOOD_PRESSURE_MONITOR \ + (0x01) +#define COD_HEALTH_MINOR_THERMOMETER (0x02) +#define COD_HEALTH_MINOR_WEIGHING_SCALE (0x03) +#define COD_HEALTH_MINOR_GLUCOSE_METER (0x04) +#define COD_HEALTH_MINOR_PULSE_OXIMETER (0x05) +#define COD_HEALTH_MINOR_HEART_PULSE_MONITOR \ + (0x06) +#define COD_HEALTH_MINOR_HEALTH_DATA_DISPLAY \ + (0x07) +#define COD_HEALTH_MINOR_STEP_COUNTER (0x08) + +// +// Cannot use GET_COD_MINOR for this b/c it is embedded in a different manner +// than the rest of the major classes +// + +#define COD_LAN_ACCESS_BIT_OFFSET (5) + +#define COD_LAN_MINOR_MASK (0x00001C) +#define COD_LAN_ACCESS_MASK (0x0000E0) + +#define GET_COD_LAN_MINOR(_cod) (((_cod) & COD_LAN_MINOR_MASK) >> COD_MINOR_BIT_OFFSET) +#define GET_COD_LAN_ACCESS(_cod) (((_cod) & COD_LAN_ACCESS_MASK) >> COD_LAN_ACCESS_BIT_OFFSET) + +// +// LAN access percent usage subcodes +// +#define COD_LAN_MINOR_UNCLASSIFIED (0x00) + +#define COD_LAN_ACCESS_0_USED (0x00) +#define COD_LAN_ACCESS_17_USED (0x01) +#define COD_LAN_ACCESS_33_USED (0x02) +#define COD_LAN_ACCESS_50_USED (0x03) +#define COD_LAN_ACCESS_67_USED (0x04) +#define COD_LAN_ACCESS_83_USED (0x05) +#define COD_LAN_ACCESS_99_USED (0x06) +#define COD_LAN_ACCESS_FULL (0x07) + +// +// Extended Inquiry Response (EIR) defines. +// +#define BTH_EIR_FLAGS_ID (0x01) +#define BTH_EIR_16_UUIDS_PARTIAL_ID (0x02) +#define BTH_EIR_16_UUIDS_COMPLETE_ID (0x03) +#define BTH_EIR_32_UUIDS_PARTIAL_ID (0x04) +#define BTH_EIR_32_UUIDS_COMPLETE_ID (0x05) +#define BTH_EIR_128_UUIDS_PARTIAL_ID (0x06) +#define BTH_EIR_128_UUIDS_COMPLETE_ID (0x07) +#define BTH_EIR_LOCAL_NAME_PARTIAL_ID (0x08) +#define BTH_EIR_LOCAL_NAME_COMPLETE_ID (0x09) +#define BTH_EIR_TX_POWER_LEVEL_ID (0x0A) +#define BTH_EIR_OOB_OPT_DATA_LEN_ID (0x0B) // OOB only. +#define BTH_EIR_OOB_BD_ADDR_ID (0x0C) // OOB only. +#define BTH_EIR_OOB_COD_ID (0x0D) // OOB only. +#define BTH_EIR_OOB_SP_HASH_ID (0x0E) // OOB only. +#define BTH_EIR_OOB_SP_RANDOMIZER_ID (0x0F) // OOB only. +#define BTH_EIR_MANUFACTURER_ID (0xFF) + +// +// Extended Inquiry Response (EIR) size. +// +#define BTH_EIR_SIZE (240) + +// +// Used as an initializer of LAP_DATA +// +#define LAP_GIAC_INIT { 0x33, 0x8B, 0x9E } +#define LAP_LIAC_INIT { 0x00, 0x8B, 0x9E } + +// +// General Inquiry Access Code. +// +#define LAP_GIAC_VALUE (0x009E8B33) + +// +// Limited Inquiry Access Code. +// +#define LAP_LIAC_VALUE (0x009E8B00) + +#define BTH_ADDR_IAC_FIRST (0x9E8B00) +#define BTH_ADDR_IAC_LAST (0x9E8B3f) +#define BTH_ADDR_LIAC (0x9E8B00) +#define BTH_ADDR_GIAC (0x9E8B33) + +typedef UCHAR BTHSTATUS, *PBTHSTATUS; + +#define BTH_ERROR(_btStatus) ((_btStatus) != BTH_ERROR_SUCCESS) +#define BTH_SUCCESS(_btStatus) ((_btStatus) == BTH_ERROR_SUCCESS) + +#define BTH_ERROR_SUCCESS (0x00) +#define BTH_ERROR_UNKNOWN_HCI_COMMAND (0x01) +#define BTH_ERROR_NO_CONNECTION (0x02) +#define BTH_ERROR_HARDWARE_FAILURE (0x03) +#define BTH_ERROR_PAGE_TIMEOUT (0x04) +#define BTH_ERROR_AUTHENTICATION_FAILURE (0x05) +#define BTH_ERROR_KEY_MISSING (0x06) +#define BTH_ERROR_MEMORY_FULL (0x07) +#define BTH_ERROR_CONNECTION_TIMEOUT (0x08) +#define BTH_ERROR_MAX_NUMBER_OF_CONNECTIONS (0x09) +#define BTH_ERROR_MAX_NUMBER_OF_SCO_CONNECTIONS (0x0a) +#define BTH_ERROR_ACL_CONNECTION_ALREADY_EXISTS (0x0b) +#define BTH_ERROR_COMMAND_DISALLOWED (0x0c) +#define BTH_ERROR_HOST_REJECTED_LIMITED_RESOURCES (0x0d) +#define BTH_ERROR_HOST_REJECTED_SECURITY_REASONS (0x0e) +#define BTH_ERROR_HOST_REJECTED_PERSONAL_DEVICE (0x0f) +#define BTH_ERROR_HOST_TIMEOUT (0x10) +#define BTH_ERROR_UNSUPPORTED_FEATURE_OR_PARAMETER (0x11) +#define BTH_ERROR_INVALID_HCI_PARAMETER (0x12) +#define BTH_ERROR_REMOTE_USER_ENDED_CONNECTION (0x13) +#define BTH_ERROR_REMOTE_LOW_RESOURCES (0x14) +#define BTH_ERROR_REMOTE_POWERING_OFF (0x15) +#define BTH_ERROR_LOCAL_HOST_TERMINATED_CONNECTION (0x16) +#define BTH_ERROR_REPEATED_ATTEMPTS (0x17) +#define BTH_ERROR_PAIRING_NOT_ALLOWED (0x18) +#define BTH_ERROR_UKNOWN_LMP_PDU (0x19) +#define BTH_ERROR_UNSUPPORTED_REMOTE_FEATURE (0x1a) +#define BTH_ERROR_SCO_OFFSET_REJECTED (0x1b) +#define BTH_ERROR_SCO_INTERVAL_REJECTED (0x1c) +#define BTH_ERROR_SCO_AIRMODE_REJECTED (0x1d) +#define BTH_ERROR_INVALID_LMP_PARAMETERS (0x1e) +#define BTH_ERROR_UNSPECIFIED_ERROR (0x1f) +#define BTH_ERROR_UNSUPPORTED_LMP_PARM_VALUE (0x20) +#define BTH_ERROR_ROLE_CHANGE_NOT_ALLOWED (0x21) +#define BTH_ERROR_LMP_RESPONSE_TIMEOUT (0x22) +#define BTH_ERROR_LMP_TRANSACTION_COLLISION (0x23) +#define BTH_ERROR_LMP_PDU_NOT_ALLOWED (0x24) +#define BTH_ERROR_ENCRYPTION_MODE_NOT_ACCEPTABLE (0x25) +#define BTH_ERROR_UNIT_KEY_NOT_USED (0x26) +#define BTH_ERROR_QOS_IS_NOT_SUPPORTED (0x27) +#define BTH_ERROR_INSTANT_PASSED (0x28) +#define BTH_ERROR_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED (0x29) +#define BTH_ERROR_DIFFERENT_TRANSACTION_COLLISION (0x2a) +#define BTH_ERROR_QOS_UNACCEPTABLE_PARAMETER (0x2c) +#define BTH_ERROR_QOS_REJECTED (0x2d) +#define BTH_ERROR_CHANNEL_CLASSIFICATION_NOT_SUPPORTED (0x2e) +#define BTH_ERROR_INSUFFICIENT_SECURITY (0x2f) +#define BTH_ERROR_PARAMETER_OUT_OF_MANDATORY_RANGE (0x30) +#define BTH_ERROR_ROLE_SWITCH_PENDING (0x32) +#define BTH_ERROR_RESERVED_SLOT_VIOLATION (0x34) +#define BTH_ERROR_ROLE_SWITCH_FAILED (0x35) +#define BTH_ERROR_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE (0x36) +#define BTH_ERROR_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST (0x37) +#define BTH_ERROR_HOST_BUSY_PAIRING (0x38) +#define BTH_ERROR_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND \ + (0x39) +#define BTH_ERROR_CONTROLLER_BUSY (0x3a) +#define BTH_ERROR_UNACCEPTABLE_CONNECTION_INTERVAL (0x3b) +#define BTH_ERROR_DIRECTED_ADVERTISING_TIMEOUT (0x3c) +#define BTH_ERROR_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE \ + (0x3d) +#define BTH_ERROR_CONNECTION_FAILED_TO_BE_ESTABLISHED (0x3e) +#define BTH_ERROR_MAC_CONNECTION_FAILED (0x3f) +#define BTH_ERROR_COARSE_CLOCK_ADJUSTMENT_REJECTED (0x40) +#define BTH_ERROR_TYPE_0_SUBMAP_NOT_DEFINED (0x41) +#define BTH_ERROR_UNKNOWN_ADVERTISING_IDENTIFIER (0x42) +#define BTH_ERROR_LIMIT_REACHED (0x43) +#define BTH_ERROR_OPERATION_CANCELLED_BY_HOST (0X44) +#define BTH_ERROR_PACKET_TOO_LONG (0x45) + +#define BTH_ERROR_UNSPECIFIED (0xFF) + +// +// Min, max, and default L2cap MTU. +// +#define L2CAP_MIN_MTU (48) +#define L2CAP_MAX_MTU (0xFFFF) +#define L2CAP_DEFAULT_MTU (672) + +// +// Max l2cap signal size (48) - size of signal header (4) +// +#define MAX_L2CAP_PING_DATA_LENGTH (44) +#define MAX_L2CAP_INFO_DATA_LENGTH (44) + +// +// the following structures provide information about +// disocvered remote radios. +// + +#define BDIF_ADDRESS (0x00000001) +#define BDIF_COD (0x00000002) +#define BDIF_NAME (0x00000004) +#define BDIF_PAIRED (0x00000008) +#define BDIF_PERSONAL (0x00000010) +#define BDIF_CONNECTED (0x00000020) + +// +// Support added in KB942567 +// +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + +#define BDIF_SHORT_NAME (0x00000040) +#define BDIF_VISIBLE (0x00000080) +#define BDIF_SSP_SUPPORTED (0x00000100) +#define BDIF_SSP_PAIRED (0x00000200) +#define BDIF_SSP_MITM_PROTECTED (0x00000400) +#define BDIF_RSSI (0x00001000) +#define BDIF_EIR (0x00002000) + +#if (NTDDI_VERSION >= NTDDI_WIN8) // >= WIN8 + +#define BDIF_BR (0x00004000) +#define BDIF_LE (0x00008000) +#define BDIF_LE_PAIRED (0x00010000) +#define BDIF_LE_PERSONAL (0x00020000) +#define BDIF_LE_MITM_PROTECTED (0x00040000) +#define BDIF_LE_PRIVACY_ENABLED (0x00080000) +#define BDIF_LE_RANDOM_ADDRESS_TYPE \ + (0x00100000) + +#if (NTDDI_VERSION >= NTDDI_WIN10) // >= WIN10 + +#define BDIF_LE_DISCOVERABLE (0x00200000) +#define BDIF_LE_NAME (0x00400000) +#define BDIF_LE_VISIBLE (0x00800000) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) // >= WIN10_RS2 + +#define BDIF_LE_CONNECTED (0x01000000) +#define BDIF_LE_CONNECTABLE (0x02000000) +#define BDIF_BR_SECURE_CONNECTION_PAIRED \ + (0x08000000) +#define BDIF_LE_SECURE_CONNECTION_PAIRED \ + (0x10000000) + +#define BDIF_DEBUGKEY (0x20000000) +#define BDIF_LE_DEBUGKEY (0x40000000) + +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) // >= NTDDI_WIN10_19H1 + +#define BDIF_TX_POWER (0x80000000) + + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED | BDIF_SHORT_NAME | BDIF_VISIBLE | BDIF_RSSI | BDIF_EIR | BDIF_SSP_PAIRED | BDIF_SSP_MITM_PROTECTED | \ + BDIF_BR | BDIF_LE | BDIF_LE_PAIRED | BDIF_LE_PERSONAL | BDIF_LE_MITM_PROTECTED | BDIF_LE_PRIVACY_ENABLED | BDIF_LE_RANDOM_ADDRESS_TYPE | \ + BDIF_LE_DISCOVERABLE | BDIF_LE_NAME | BDIF_LE_VISIBLE | BDIF_LE_CONNECTED | BDIF_LE_CONNECTABLE | \ + BDIF_BR_SECURE_CONNECTION_PAIRED | BDIF_LE_SECURE_CONNECTION_PAIRED | BDIF_DEBUGKEY | BDIF_LE_DEBUGKEY | BDIF_TX_POWER) + +#else + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED | BDIF_SHORT_NAME | BDIF_VISIBLE | BDIF_RSSI | BDIF_EIR | BDIF_SSP_PAIRED | BDIF_SSP_MITM_PROTECTED | \ + BDIF_BR | BDIF_LE | BDIF_LE_PAIRED | BDIF_LE_PERSONAL | BDIF_LE_MITM_PROTECTED | BDIF_LE_PRIVACY_ENABLED | BDIF_LE_RANDOM_ADDRESS_TYPE | \ + BDIF_LE_DISCOVERABLE | BDIF_LE_NAME | BDIF_LE_VISIBLE | BDIF_LE_CONNECTED | BDIF_LE_CONNECTABLE | \ + BDIF_BR_SECURE_CONNECTION_PAIRED | BDIF_LE_SECURE_CONNECTION_PAIRED | BDIF_DEBUGKEY | BDIF_LE_DEBUGKEY) + +#endif // >= NTDDI_WIN10_19H1 + +#else + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED | BDIF_SHORT_NAME | BDIF_VISIBLE | BDIF_RSSI | BDIF_EIR | BDIF_SSP_PAIRED | BDIF_SSP_MITM_PROTECTED | \ + BDIF_BR | BDIF_LE | BDIF_LE_PAIRED | BDIF_LE_PERSONAL | BDIF_LE_MITM_PROTECTED | BDIF_LE_PRIVACY_ENABLED | BDIF_LE_RANDOM_ADDRESS_TYPE | \ + BDIF_LE_DISCOVERABLE | BDIF_LE_NAME | BDIF_LE_VISIBLE) + +#endif // >= WIN10_RS2 + +#else + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED | BDIF_SHORT_NAME | BDIF_VISIBLE | BDIF_RSSI | BDIF_EIR | BDIF_SSP_PAIRED | BDIF_SSP_MITM_PROTECTED | \ + BDIF_BR | BDIF_LE | BDIF_LE_PAIRED | BDIF_LE_PERSONAL | BDIF_LE_MITM_PROTECTED | BDIF_LE_PRIVACY_ENABLED | BDIF_LE_RANDOM_ADDRESS_TYPE) + +#endif // >= WIN10 + +#else + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED | BDIF_SHORT_NAME | BDIF_VISIBLE | BDIF_RSSI | BDIF_EIR | BDIF_SSP_PAIRED | BDIF_SSP_MITM_PROTECTED) + +#endif // >= WIN8 + +#else // <= SP1 + +#define BDIF_VALID_FLAGS \ + (BDIF_ADDRESS | BDIF_COD | BDIF_NAME | BDIF_PAIRED | BDIF_PERSONAL | \ + BDIF_CONNECTED) + +#endif // >= SP1+KB942567 + +typedef struct _BTH_DEVICE_INFO { + // + // Combination BDIF_Xxx flags + // + ULONG flags; + + // + // Address of remote device. + // + BTH_ADDR address; + + // + // Class Of Device. + // + BTH_COD classOfDevice; + + // + // name of the device + // + CHAR name[BTH_MAX_NAME_SIZE]; + +} BTH_DEVICE_INFO, *PBTH_DEVICE_INFO; + +// +// Buffer associated with GUID_BLUETOOTH_RADIO_IN_RANGE +// + +typedef struct _BTH_RADIO_IN_RANGE { + // + // Information about the remote radio + // + BTH_DEVICE_INFO deviceInfo; + + // + // The previous flags value for the BTH_DEVICE_INFO. The receiver of this + // notification can compare the deviceInfo.flags and previousDeviceFlags + // to determine what has changed about this remote radio. + // + // For instance, if BDIF_NAME is set in deviceInfo.flags and not in + // previousDeviceFlags, the remote radio's has just been retrieved. + // + ULONG previousDeviceFlags; + +} BTH_RADIO_IN_RANGE, *PBTH_RADIO_IN_RANGE; + +// +// Buffer associated with GUID_BLUETOOTH_L2CAP_EVENT +// +typedef struct _BTH_L2CAP_EVENT_INFO { + // + // Remote radio address which the L2CAP event is associated with + // + BTH_ADDR bthAddress; + + // + // The PSM that is either being connected to or disconnected from + // + USHORT psm; + + // + // If != 0, then the channel has just been established. If == 0, then the + // channel has been destroyed. Notifications for a destroyed channel will + // only be sent for channels successfully established. + // + UCHAR connected; + + // + // If != 0, then the local host iniated the l2cap connection. If == 0, then + // the remote host initated the connection. This field is only valid if + // connect is != 0. + // + UCHAR initiated; + +} BTH_L2CAP_EVENT_INFO, *PBTH_L2CAP_EVENT_INFO; + +#define HCI_CONNECTION_TYPE_ACL (1) +#define HCI_CONNECTION_TYPE_SCO (2) +#define HCI_CONNECTION_TYPE_LE (3) + +// +// Fix typos +// +#define HCI_CONNNECTION_TYPE_ACL HCI_CONNECTION_TYPE_ACL +#define HCI_CONNNECTION_TYPE_SCO HCI_CONNECTION_TYPE_SCO + +// +// Buffer associated with GUID_BLUETOOTH_HCI_EVENT +// +typedef struct _BTH_HCI_EVENT_INFO { + // + // Remote radio address which the HCI event is associated with + // + BTH_ADDR bthAddress; + + // + // HCI_CONNNECTION_TYPE_XXX value + // + UCHAR connectionType; + + // + // If != 0, then the underlying connection to the remote radio has just + // been estrablished. If == 0, then the underlying conneciton has just been + // destroyed. + // + UCHAR connected; + +} BTH_HCI_EVENT_INFO, *PBTH_HCI_EVENT_INFO; + +// +// Support added in KB942567 +// +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + +typedef enum _IO_CAPABILITY { + IoCaps_DisplayOnly = 0x00, + IoCaps_DisplayYesNo = 0x01, + IoCaps_KeyboardOnly = 0x02, + IoCaps_NoInputNoOutput = 0x03, + IoCaps_Undefined = 0xff +}IO_CAPABILITY; + +typedef enum _AUTHENTICATION_REQUIREMENTS { + MITMProtectionNotRequired = 0x00, + MITMProtectionRequired = 0x01, + MITMProtectionNotRequiredBonding = 0x02, + MITMProtectionRequiredBonding = 0x03, + MITMProtectionNotRequiredGeneralBonding = 0x04, + MITMProtectionRequiredGeneralBonding = 0x05, + MITMProtectionNotDefined = 0xff +} AUTHENTICATION_REQUIREMENTS; + +#define IsMITMProtectionRequired(requirements) \ + ((MITMProtectionRequired == requirements) || (MITMProtectionRequiredBonding == requirements) || (MITMProtectionRequiredGeneralBonding == requirements)) + +#endif // >= SP1+KB942567 + +// +// Max length we allow for ServiceName in the remote SDP records +// +#define BTH_MAX_SERVICE_NAME_SIZE (256) + +#define MAX_UUIDS_IN_QUERY (12) + +#define BTH_VID_DEFAULT_VALUE (0xFFFF) + +#define SDP_ERROR_INVALID_SDP_VERSION (0x0001) +#define SDP_ERROR_INVALID_RECORD_HANDLE (0x0002) +#define SDP_ERROR_INVALID_REQUEST_SYNTAX (0x0003) +#define SDP_ERROR_INVALID_PDU_SIZE (0x0004) +#define SDP_ERROR_INVALID_CONTINUATION_STATE (0x0005) +#define SDP_ERROR_INSUFFICIENT_RESOURCES (0x0006) + +// +// Defined by windows to handle server errors that are not described by the +// above errors. Start at 0x0100 so we don't go anywhere near the spec +// defined values. +// + +// +// Success, nothing went wrong +// +#define SDP_ERROR_SUCCESS ((SDP_ERROR) 0x0000) + +// +// The SDP PDU or parameters other than the SDP stream response was not correct +// +#define SDP_ERROR_SERVER_INVALID_RESPONSE ((SDP_ERROR) 0x0100) + +// +// The SDP response stream did not parse correctly. +// +#define SDP_ERROR_SERVER_RESPONSE_DID_NOT_PARSE ((SDP_ERROR) 0x0200) + +// +// The SDP response stream was successfully parsed, but did not match the +// required format for the query. +// +#define SDP_ERROR_SERVER_BAD_FORMAT ((SDP_ERROR) 0x0300) + +// +// SDP was unable to send a continued query back to the server +// +#define SDP_ERROR_COULD_NOT_SEND_CONTINUE ((SDP_ERROR) 0x0400) + +// +// Server sent a response that was too large to fit in the caller's buffer. +// +#define SDP_ERROR_RESPONSE_TOO_LARGE ((SDP_ERROR) 0x0500) + +#define SDP_ATTRIB_RECORD_HANDLE (0x0000) +#define SDP_ATTRIB_CLASS_ID_LIST (0x0001) +#define SDP_ATTRIB_RECORD_STATE (0x0002) +#define SDP_ATTRIB_SERVICE_ID (0x0003) +#define SDP_ATTRIB_PROTOCOL_DESCRIPTOR_LIST (0x0004) +#define SDP_ATTRIB_BROWSE_GROUP_LIST (0x0005) +#define SDP_ATTRIB_LANG_BASE_ATTRIB_ID_LIST (0x0006) +#define SDP_ATTRIB_INFO_TIME_TO_LIVE (0x0007) +#define SDP_ATTRIB_AVAILABILITY (0x0008) +#define SDP_ATTRIB_PROFILE_DESCRIPTOR_LIST (0x0009) +#define SDP_ATTRIB_DOCUMENTATION_URL (0x000A) +#define SDP_ATTRIB_CLIENT_EXECUTABLE_URL (0x000B) +#define SDP_ATTRIB_ICON_URL (0x000C) +#define SDP_ATTRIB_ADDITIONAL_PROTOCOL_DESCRIPTOR_LIST \ + (0x000D) + +// +// Attribute IDs in the range of 0x000D - 0x01FF are reserved for future use +// +#define SDP_ATTRIB_PROFILE_SPECIFIC (0x0200) + +#define LANG_BASE_LANGUAGE_INDEX (0x0000) +#define LANG_BASE_ENCODING_INDEX (0x0001) +#define LANG_BASE_OFFSET_INDEX (0x0002) +#define LANG_DEFAULT_ID (0x0100) + +#define LANGUAGE_EN_US (0x656E) +#define ENCODING_UTF_8 (0x006A) + +#define STRING_NAME_OFFSET (0x0000) +#define STRING_DESCRIPTION_OFFSET (0x0001) +#define STRING_PROVIDER_NAME_OFFSET (0x0002) + +#define SDP_ATTRIB_SDP_VERSION_NUMBER_LIST (0x0200) +#define SDP_ATTRIB_SDP_DATABASE_STATE (0x0201) + +#define SDP_ATTRIB_BROWSE_GROUP_ID (0x0200) + +#define SDP_ATTRIB_CORDLESS_EXTERNAL_NETWORK (0x0301) + +#define SDP_ATTRIB_FAX_CLASS_1_SUPPORT (0x0302) +#define SDP_ATTRIB_FAX_CLASS_2_0_SUPPORT (0x0303) +#define SDP_ATTRIB_FAX_CLASS_2_SUPPORT (0x0304) +#define SDP_ATTRIB_FAX_AUDIO_FEEDBACK_SUPPORT (0x0305) + +#define SDP_ATTRIB_HEADSET_REMOTE_AUDIO_VOLUME_CONTROL (0x0302) + +#define SDP_ATTRIB_LAN_LPSUBNET (0x0200) + +#define SDP_ATTRIB_OBJECT_PUSH_SUPPORTED_FORMATS_LIST (0x0303) + +#define SDP_ATTRIB_SYNCH_SUPPORTED_DATA_STORES_LIST (0x0301) + +// this is in the assigned numbers doc, but it does not show up in any profile +#define SDP_ATTRIB_SERVICE_VERSION (0x0300) + +#define SDP_ATTRIB_PAN_NETWORK_ADDRESS (0x0306) +#define SDP_ATTRIB_PAN_WAP_GATEWAY (0x0307) +#define SDP_ATTRIB_PAN_HOME_PAGE_URL (0x0308) +#define SDP_ATTRIB_PAN_WAP_STACK_TYPE (0x0309) +#define SDP_ATTRIB_PAN_SECURITY_DESCRIPTION (0x030A) +#define SDP_ATTRIB_PAN_NET_ACCESS_TYPE (0x030B) +#define SDP_ATTRIB_PAN_MAX_NET_ACCESS_RATE (0x030C) + +#define SDP_ATTRIB_IMAGING_SUPPORTED_CAPABILITIES (0x0310) +#define SDP_ATTRIB_IMAGING_SUPPORTED_FEATURES (0x0311) +#define SDP_ATTRIB_IMAGING_SUPPORTED_FUNCTIONS (0x0312) +#define SDP_ATTRIB_IMAGING_TOTAL_DATA_CAPACITY (0x0313) + +#define SDP_ATTRIB_DI_SPECIFICATION_ID (0x0200) +#define SDP_ATTRIB_DI_VENDOR_ID (0x0201) +#define SDP_ATTRIB_DI_PRODUCT_ID (0x0202) +#define SDP_ATTRIB_DI_VERSION (0x0203) +#define SDP_ATTRIB_DI_PRIMARY_RECORD (0x0204) +#define SDP_ATTRIB_DI_VENDOR_ID_SOURCE (0x0205) + +#define SDP_ATTRIB_HID_DEVICE_RELEASE_NUMBER (0x0200) +#define SDP_ATTRIB_HID_PARSER_VERSION (0x0201) +#define SDP_ATTRIB_HID_DEVICE_SUBCLASS (0x0202) +#define SDP_ATTRIB_HID_COUNTRY_CODE (0x0203) +#define SDP_ATTRIB_HID_VIRTUAL_CABLE (0x0204) +#define SDP_ATTRIB_HID_RECONNECT_INITIATE (0x0205) +#define SDP_ATTRIB_HID_DESCRIPTOR_LIST (0x0206) +#define SDP_ATTRIB_HID_LANG_ID_BASE_LIST (0x0207) +#define SDP_ATTRIB_HID_SDP_DISABLE (0x0208) +#define SDP_ATTRIB_HID_BATTERY_POWER (0x0209) +#define SDP_ATTRIB_HID_REMOTE_WAKE (0x020A) +#define SDP_ATTRIB_HID_PROFILE_VERSION (0x020B) +#define SDP_ATTRIB_HID_SUPERVISION_TIMEOUT (0x020C) +#define SDP_ATTRIB_HID_NORMALLY_CONNECTABLE (0x020D) +#define SDP_ATTRIB_HID_BOOT_DEVICE (0x020E) +#define SDP_ATTRIB_HID_SSR_HOST_MAX_LATENCY (0x020F) +#define SDP_ATTRIB_HID_SSR_HOST_MIN_TIMEOUT (0x0210) + +#define SDP_ATTRIB_A2DP_SUPPORTED_FEATURES (0x0311) + +#define SDP_ATTRIB_AVRCP_SUPPORTED_FEATURES (0x0311) + +#define SDP_ATTRIB_HFP_SUPPORTED_FEATURES (0x0311) + +// +// Profile specific values +// +#define AVRCP_SUPPORTED_FEATURES_CATEGORY_1 (0x0001) +#define AVRCP_SUPPORTED_FEATURES_CATEGORY_2 (0x0002) +#define AVRCP_SUPPORTED_FEATURES_CATEGORY_3 (0x0004) +#define AVRCP_SUPPORTED_FEATURES_CATEGORY_4 (0x0008) +#define AVRCP_SUPPORTED_FEATURES_CT_BROWSING (0x0040) +#define AVRCP_SUPPORTED_FEATURES_CT_COVER_ART_IMAGE_PROPERTIES (0X0080) +#define AVRCP_SUPPORTED_FEATURES_CT_COVER_ART_IMAGE (0X0100) +#define AVRCP_SUPPORTED_FEATURES_CT_COVER_ART_LINKED_THUMBNAIL (0x0200) +#define AVRCP_SUPPORTED_FEATURES_TG_PLAYER_APPLICATION_SETTINGS (0x0010) +#define AVRCP_SUPPORTED_FEATURES_TG_GROUP_NAVIGATION (0x0020) +#define AVRCP_SUPPORTED_FEATURES_TG_BROWSING (0x0040) +#define AVRCP_SUPPORTED_FEATURES_TG_MULTIPLE_PLAYER_APPLICATIONS (0x0080) +#define AVRCP_SUPPORTED_FEATURES_TG_COVER_ART (0x0100) + +#define A2DP_SINK_SUPPORTED_FEATURES_HEADPHONE (0x0001) +#define A2DP_SINK_SUPPORTED_FEATURES_SPEAKER (0x0002) +#define A2DP_SINK_SUPPORTED_FEATURES_RECORDER (0x0004) +#define A2DP_SINK_SUPPORTED_FEATURES_AMPLIFIER (0x0008) + +#define A2DP_SOURCE_SUPPORTED_FEATURES_PLAYER (0x0001) +#define A2DP_SOURCE_SUPPORTED_FEATURES_MICROPHONE (0x0002) +#define A2DP_SOURCE_SUPPORTED_FEATURES_TUNER (0x0004) +#define A2DP_SOURCE_SUPPORTED_FEATURES_MIXER (0x0008) + +#define CORDLESS_EXTERNAL_NETWORK_PSTN (0x01) +#define CORDLESS_EXTERNAL_NETWORK_ISDN (0x02) +#define CORDLESS_EXTERNAL_NETWORK_GSM (0x03) +#define CORDLESS_EXTERNAL_NETWORK_CDMA (0x04) +#define CORDLESS_EXTERNAL_NETWORK_ANALOG_CELLULAR (0x05) +#define CORDLESS_EXTERNAL_NETWORK_PACKET_SWITCHED (0x06) +#define CORDLESS_EXTERNAL_NETWORK_OTHER (0x07) + +#define OBJECT_PUSH_FORMAT_VCARD_2_1 (0x01) +#define OBJECT_PUSH_FORMAT_VCARD_3_0 (0x02) +#define OBJECT_PUSH_FORMAT_VCAL_1_0 (0x03) +#define OBJECT_PUSH_FORMAT_ICAL_2_0 (0x04) +#define OBJECT_PUSH_FORMAT_VNOTE (0x05) +#define OBJECT_PUSH_FORMAT_VMESSAGE (0x06) +#define OBJECT_PUSH_FORMAT_ANY (0xFF) + +#define SYNCH_DATA_STORE_PHONEBOOK (0x01) +#define SYNCH_DATA_STORE_CALENDAR (0x03) +#define SYNCH_DATA_STORE_NOTES (0x05) +#define SYNCH_DATA_STORE_MESSAGES (0x06) + +#define DI_VENDOR_ID_SOURCE_BLUETOOTH_SIG (0x0001) +#define DI_VENDOR_ID_SOURCE_USB_IF (0x0002) + +#define PSM_SDP (0x0001) +#define PSM_RFCOMM (0x0003) +#define PSM_TCS_BIN (0x0005) +#define PSM_TCS_BIN_CORDLESS (0x0007) +#define PSM_BNEP (0x000F) +#define PSM_HID_CONTROL (0x0011) +#define PSM_HID_INTERRUPT (0x0013) +#define PSM_UPNP (0x0015) +#define PSM_AVCTP (0x0017) +#define PSM_AVDTP (0x0019) +#define PSM_AVCTP_BROWSE (0x001B) +#define PSM_UDI_C_PLANE (0x001D) +#define PSM_ATT (0x001F) +#define PSM_3DSP (0x0021) +#define PSM_LE_IPSP (0x0023) + +// +// Strings +// +#define STR_ADDR_FMTA "(%02x:%02x:%02x:%02x:%02x:%02x)" +#define STR_ADDR_FMTW L"(%02x:%02x:%02x:%02x:%02x:%02x)" + +#define STR_ADDR_SHORT_FMTA "%04x%08x" +#define STR_ADDR_SHORT_FMTW L"%04x%08x" + +#define STR_USBHCI_CLASS_HARDWAREIDA "USB\\Class_E0&SubClass_01&Prot_01" +#define STR_USBHCI_CLASS_HARDWAREIDW L"USB\\Class_E0&SubClass_01&Prot_01" + +#if defined(UNICODE) || defined(BTH_KERN) + +#define STR_ADDR_FMT STR_ADDR_FMTW +#define STR_ADDR_SHORT_FMT STR_ADDR_SHORT_FMTW + +#define STR_USBHCI_CLASS_HARDWAREID STR_USBHCI_CLASS_HARDWAREIDW + +#else // UNICODE + +#define STR_ADDR_FMT STR_ADDR_FMTA +#define STR_ADDR_SHORT_FMT STR_ADDR_SHORT_FMTA + +#define STR_USBHCI_CLASS_HARDWAREID STR_USBHCI_CLASS_HARDWAREIDA + +#endif // UNICODE + +#define GET_BITS(field,offset,mask) ( ( (field) >> (offset) ) & (mask) ) +#define GET_BIT(field,offset) ( GET_BITS(field,offset,0x1) ) + +#define LMP_3_SLOT_PACKETS(x) (GET_BIT(x, 0)) +#define LMP_5_SLOT_PACKETS(x) (GET_BIT(x, 1)) +#define LMP_ENCRYPTION(x) (GET_BIT(x, 2)) +#define LMP_SLOT_OFFSET(x) (GET_BIT(x, 3)) +#define LMP_TIMING_ACCURACY(x) (GET_BIT(x, 4)) +#define LMP_SWITCH(x) (GET_BIT(x, 5)) +#define LMP_HOLD_MODE(x) (GET_BIT(x, 6)) +#define LMP_SNIFF_MODE(x) (GET_BIT(x, 7)) +#define LMP_PARK_MODE(x) (GET_BIT(x, 8)) +#define LMP_RSSI(x) (GET_BIT(x, 9)) +#define LMP_CHANNEL_QUALITY_DRIVEN_MODE(x) (GET_BIT(x,10)) +#define LMP_SCO_LINK(x) (GET_BIT(x,11)) +#define LMP_HV2_PACKETS(x) (GET_BIT(x,12)) +#define LMP_HV3_PACKETS(x) (GET_BIT(x,13)) +#define LMP_MU_LAW_LOG(x) (GET_BIT(x,14)) +#define LMP_A_LAW_LOG(x) (GET_BIT(x,15)) +#define LMP_CVSD(x) (GET_BIT(x,16)) +#define LMP_PAGING_SCHEME(x) (GET_BIT(x,17)) +#define LMP_POWER_CONTROL(x) (GET_BIT(x,18)) +#define LMP_TRANSPARENT_SCO_DATA(x) (GET_BIT(x,19)) +#define LMP_FLOW_CONTROL_LAG(x) (GET_BITS(x,20,0x3)) +#define LMP_BROADCAST_ENCRYPTION(x) (GET_BIT(x,23)) +#define LMP_ENHANCED_DATA_RATE_ACL_2MBPS_MODE(x) (GET_BIT(x,25)) +#define LMP_ENHANCED_DATA_RATE_ACL_3MBPS_MODE(x) (GET_BIT(x,26)) +#define LMP_ENHANCED_INQUIRY_SCAN(x) (GET_BIT(x,27)) +#define LMP_INTERLACED_INQUIRY_SCAN(x) (GET_BIT(x,28)) +#define LMP_INTERLACED_PAGE_SCAN(x) (GET_BIT(x,29)) +#define LMP_RSSI_WITH_INQUIRY_RESULTS(x) (GET_BIT(x,30)) +#define LMP_ESCO_LINK(x) (GET_BIT(x,31)) +#define LMP_EV4_PACKETS(x) (GET_BIT(x,32)) +#define LMP_EV5_PACKETS(x) (GET_BIT(x,33)) +#define LMP_AFH_CAPABLE_SLAVE(x) (GET_BIT(x,35)) +#define LMP_AFH_CLASSIFICATION_SLAVE(x) (GET_BIT(x,36)) +#define LMP_BR_EDR_NOT_SUPPORTED(x) (GET_BIT(x,37)) +#define LMP_LE_SUPPORTED(x) (GET_BIT(x,38)) +#define LMP_3SLOT_EDR_ACL_PACKETS(x) (GET_BIT(x,39)) +#define LMP_5SLOT_EDR_ACL_PACKETS(x) (GET_BIT(x,40)) +#define LMP_SNIFF_SUBRATING(x) (GET_BIT(x,41)) +#define LMP_PAUSE_ENCRYPTION(x) (GET_BIT(x,42)) +#define LMP_AFH_CAPABLE_MASTER(x) (GET_BIT(x,43)) +#define LMP_AFH_CLASSIFICATION_MASTER(x) (GET_BIT(x,44)) +#define LMP_EDR_ESCO_2MBPS_MODE(x) (GET_BIT(x,45)) +#define LMP_EDR_ESCO_3MBPS_MODE(x) (GET_BIT(x,46)) +#define LMP_3SLOT_EDR_ESCO_PACKETS(x) (GET_BIT(x,47)) +#define LMP_EXTENDED_INQUIRY_RESPONSE(x) (GET_BIT(x,48)) +#define LMP_SIMULT_LE_BR_TO_SAME_DEV(x) (GET_BIT(x,49)) +#define LMP_SECURE_SIMPLE_PAIRING(x) (GET_BIT(x,51)) +#define LMP_ENCAPSULATED_PDU(x) (GET_BIT(x,52)) +#define LMP_ERRONEOUS_DATA_REPORTING(x) (GET_BIT(x,53)) +#define LMP_NON_FLUSHABLE_PACKET_BOUNDARY_FLAG(x) (GET_BIT(x,54)) +#define LMP_LINK_SUPERVISION_TIMEOUT_CHANGED_EVENT(x) (GET_BIT(x,56)) +#define LMP_INQUIRY_RESPONSE_TX_POWER_LEVEL(x)(GET_BIT(x,57)) +#define LMP_EXTENDED_FEATURES(x) (GET_BIT(x,63)) + +#endif // GUID_DEFS_ONLY + +#endif // (NTDDI_VERSION >= NTDDI_WINXPSP2) + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // __BTHDEF_H__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthioctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthioctl.h new file mode 100644 index 0000000000000000000000000000000000000000..f1953531c31a723f50e1cba78a5d114d74e15a0f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthioctl.h @@ -0,0 +1,421 @@ +// Copyright (C) Microsoft Corporation. All rights reserved. + +#pragma detect_mismatch("ODR_violation_bthioctl_mismatch", "1") +#ifndef __BTHIOCTL_H__ +#define __BTHIOCTL_H__ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // nameless struct/union + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#ifndef CTL_CODE + #pragma message("CTL_CODE undefined. Include winioctl.h or wdm.h") +#endif + +// IOCTL defines. +#define BTH_IOCTL_BASE 0 + +#define BTH_CTL(id) CTL_CODE(FILE_DEVICE_BLUETOOTH, \ + (id), \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define BTH_KERNEL_CTL(id) CTL_CODE(FILE_DEVICE_BLUETOOTH, \ + (id), \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +// kernel-level (internal) IOCTLs +#define IOCTL_INTERNAL_BTH_SUBMIT_BRB BTH_KERNEL_CTL(BTH_IOCTL_BASE+0x00) + +// Input: none +// Output: BTH_ENUMERATOR_INFO +#define IOCTL_INTERNAL_BTHENUM_GET_ENUMINFO BTH_KERNEL_CTL(BTH_IOCTL_BASE+0x01) + +// Input: none +// Output: BTH_DEVICE_INFO +#define IOCTL_INTERNAL_BTHENUM_GET_DEVINFO BTH_KERNEL_CTL(BTH_IOCTL_BASE+0x02) + +// IOCTLs +// Input: none +// Output: BTH_LOCAL_RADIO_INFO +#define IOCTL_BTH_GET_LOCAL_INFO BTH_CTL(BTH_IOCTL_BASE+0x00) + +// Input: BTH_ADDR +// Output: BTH_RADIO_INFO +#define IOCTL_BTH_GET_RADIO_INFO BTH_CTL(BTH_IOCTL_BASE+0x01) + +// use this ioctl to get a list of cached discovered devices in the port driver. +// Input: None +// Output: BTH_DEVICE_INFO_LIST +#define IOCTL_BTH_GET_DEVICE_INFO BTH_CTL(BTH_IOCTL_BASE+0x02) + +// Input: BTH_ADDR +// Output: none +#define IOCTL_BTH_DISCONNECT_DEVICE BTH_CTL(BTH_IOCTL_BASE+0x03) + +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + +// Input: BTH_VENDOR_SPECIFIC_COMMAND +// Output: PVOID +#define IOCTL_BTH_HCI_VENDOR_COMMAND BTH_CTL(BTH_IOCTL_BASE+0x14) + +#endif // >= SP1+KB942567 + +// Input: BTH_SDP_CONNECT +// Output: BTH_SDP_CONNECT +#define IOCTL_BTH_SDP_CONNECT BTH_CTL(BTH_IOCTL_BASE+0x80) + +// Input: HANDLE_SDP +// Output: none +#define IOCTL_BTH_SDP_DISCONNECT BTH_CTL(BTH_IOCTL_BASE+0x81) + +// Input: BTH_SDP_SERVICE_SEARCH_REQUEST +// Output: ULONG * number of handles wanted +#define IOCTL_BTH_SDP_SERVICE_SEARCH BTH_CTL(BTH_IOCTL_BASE+0x82) + +// Input: BTH_SDP_ATTRIBUTE_SEARCH_REQUEST +// Output: BTH_SDP_STREAM_RESPONSE or bigger +#define IOCTL_BTH_SDP_ATTRIBUTE_SEARCH BTH_CTL(BTH_IOCTL_BASE+0x83) + +// Input: BTH_SDP_SERVICE_ATTRIBUTE_SEARCH_REQUEST +// Output: BTH_SDP_STREAM_RESPONSE or bigger +#define IOCTL_BTH_SDP_SERVICE_ATTRIBUTE_SEARCH \ + BTH_CTL(BTH_IOCTL_BASE+0x84) + +// Input: raw SDP stream (at least 2 bytes) +// Ouptut: HANDLE_SDP +#define IOCTL_BTH_SDP_SUBMIT_RECORD BTH_CTL(BTH_IOCTL_BASE+0x85) + +// Input: HANDLE_SDP +// Output: none +#define IOCTL_BTH_SDP_REMOVE_RECORD BTH_CTL(BTH_IOCTL_BASE+0x86) + +// Input: BTH_SDP_RECORD + raw SDP record +// Output: HANDLE_SDP +#define IOCTL_BTH_SDP_SUBMIT_RECORD_WITH_INFO BTH_CTL(BTH_IOCTL_BASE+0x87) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +// Input: NONE +// Output: BTH_HOST_FEATURE_MASK +#define IOCTL_BTH_GET_HOST_SUPPORTED_FEATURES BTH_CTL(BTH_IOCTL_BASE+0x88) +#endif // >= NTDDI_WIN8 + + +#include + +typedef struct _BTH_DEVICE_INFO_LIST +{ + // [IN/OUT] minimum of 1 device required + ULONG numOfDevices; + + // Open ended array of devices; + BTH_DEVICE_INFO deviceList[1]; + +} BTH_DEVICE_INFO_LIST, *PBTH_DEVICE_INFO_LIST; + +typedef struct _BTH_RADIO_INFO +{ + // Supported LMP features of the radio. Use LMP_XXX() to extract + // the desired bits. + ULONGLONG lmpSupportedFeatures; + + // Manufacturer ID (possibly BTH_MFG_XXX) + USHORT mfg; + + // LMP subversion + USHORT lmpSubversion; + + // LMP version + UCHAR lmpVersion; + +} BTH_RADIO_INFO, *PBTH_RADIO_INFO; + +typedef struct _BTH_LOCAL_RADIO_INFO +{ + // Local BTH_ADDR, class of defice, and radio name + BTH_DEVICE_INFO localInfo; + + // Combo of LOCAL_RADIO_XXX values + ULONG flags; + + // HCI revision, see core spec + USHORT hciRevision; + + // HCI version, see core spec + UCHAR hciVersion; + + // More information about the local radio (LMP, MFG) + BTH_RADIO_INFO radioInfo; + +} BTH_LOCAL_RADIO_INFO, *PBTH_LOCAL_RADIO_INFO; + +#define SDP_CONNECT_CACHE (0x00000001) +#define SDP_CONNECT_ALLOW_PIN (0x00000002) + + +#define SDP_REQUEST_TO_DEFAULT (0) +#define SDP_REQUEST_TO_MIN (10) +#define SDP_REQUEST_TO_MAX (45) + +#define SERVICE_OPTION_DO_NOT_PUBLISH (0x00000002) +#define SERVICE_OPTION_NO_PUBLIC_BROWSE (0x00000004) +#define SERVICE_OPTION_DO_NOT_PUBLISH_EIR (0x00000008) + +#define SERVICE_SECURITY_USE_DEFAULTS (0x00000000) +#define SERVICE_SECURITY_NONE (0x00000001) +#define SERVICE_SECURITY_AUTHORIZE (0x00000002) +#define SERVICE_SECURITY_AUTHENTICATE (0x00000004) +#define SERVICE_SECURITY_ENCRYPT_REQUIRED (0x00000010) +#define SERVICE_SECURITY_ENCRYPT_OPTIONAL (0x00000020) +#define SERVICE_SECURITY_DISABLED (0x10000000) +#define SERVICE_SECURITY_NO_ASK (0x20000000) + +// Do not attempt to validate that the stream can be parsed +#define SDP_SEARCH_NO_PARSE_CHECK (0x00000001) + +// Do not check the format of the results. This includes suppression of both +// the check for a record patten (SEQ of UINT16 + value) and the validation +// of each universal attribute's accordance to the spec. +#define SDP_SEARCH_NO_FORMAT_CHECK (0x00000002) + +#ifndef HANDLE_SDP_TYPE +typedef ULONGLONG HANDLE_SDP, *PHANDLE_SDP; +#define HANDLE_SDP_TYPE HANDLE_SDP +#define HANDLE_SDP_FIELD_NAME hConnection +#define HANDLE_SDP_NULL ((HANDLE_SDP)0x0) +#endif + +#define HANDLE_SDP_LOCAL ((HANDLE_SDP) -2) + +typedef struct _BTH_SDP_CONNECT +{ + // Address of the remote SDP server. Cannot be the local radio. + BTH_ADDR bthAddress; + + // Combination of SDP_CONNECT_XXX flags + ULONG fSdpConnect; + + // When the connect request returns, this will specify the handle to the + // SDP connection to the remote server + HANDLE_SDP_TYPE HANDLE_SDP_FIELD_NAME; + + // Timeout, in seconds, for the requests on ths SDP channel. If the request + // times out, the SDP connection represented by the HANDLE_SDP must be + // closed. The values for this field are bound by SDP_REQUEST_TO_MIN and + // SDP_REQUEST_MAX. If SDP_REQUEST_TO_DEFAULT is specified, the timeout is + // 30 seconds. + UCHAR requestTimeout; + +} BTH_SDP_CONNECT, *PBTH_SDP_CONNECT; + +typedef struct _BTH_SDP_DISCONNECT +{ + // hConnection returned by BTH_SDP_CONNECT + HANDLE_SDP_TYPE HANDLE_SDP_FIELD_NAME; + +} BTH_SDP_DISCONNECT, *PBTH_SDP_DISCONNECT; + + +typedef struct _BTH_SDP_RECORD +{ + // Combination of SERVICE_SECURITY_XXX flags + ULONG fSecurity; + + // Combination of SERVICE_OPTION_XXX flags + ULONG fOptions; + + // combo of COD_SERVICE_XXX flags + ULONG fCodService; + + // The length of the record array, in bytes. + ULONG recordLength; + + // The SDP record in its raw format + UCHAR record[1]; + +} BTH_SDP_RECORD, *PBTH_SDP_RECORD; + +typedef struct _BTH_SDP_SERVICE_SEARCH_REQUEST +{ + // Handle returned by the connect request or HANDLE_SDP_LOCAL + HANDLE_SDP_TYPE HANDLE_SDP_FIELD_NAME; + + // Array of UUIDs. Each entry can be either a 2 byte, 4 byte or 16 byte + // UUID. SDP spec mandates that a request can have a maximum of 12 UUIDs. + SdpQueryUuid uuids[MAX_UUIDS_IN_QUERY]; + +} BTH_SDP_SERVICE_SEARCH_REQUEST, *PBTH_SDP_SERVICE_SEARCH_REQUEST; + +typedef struct _BTH_SDP_ATTRIBUTE_SEARCH_REQUEST +{ + // Handle returned by the connect request or HANDLE_SDP_LOCAL + HANDLE_SDP_TYPE HANDLE_SDP_FIELD_NAME; + + // Combo of SDP_SEARCH_Xxx flags + ULONG searchFlags; + + // Record handle returned by the remote SDP server, most likely from a + // previous BTH_SDP_SERVICE_SEARCH_RESPONSE. + ULONG recordHandle; + + // Array of attributes to query for. Each SdpAttributeRange entry can + // specify either a single attribute or a range. To specify a single + // attribute, minAttribute should be equal to maxAttribute. The array must + // be in sorted order, starting with the smallest attribute. Furthermore, + // if a range is specified, the minAttribute must be <= maxAttribute. + SdpAttributeRange range[1]; + +} BTH_SDP_ATTRIBUTE_SEARCH_REQUEST, *PBTH_SDP_ATTRIBUTE_SEARCH_REQUEST; + +typedef struct _BTH_SDP_SERVICE_ATTRIBUTE_SEARCH_REQUEST +{ + // Handle returned by the connect request or HANDLE_SDP_LOCAL + HANDLE_SDP_TYPE HANDLE_SDP_FIELD_NAME; + + // Combo of SDP_SEARCH_Xxx flags + ULONG searchFlags; + + // See comments in BTH_SDP_SERVICE_SEARCH_REQUEST + SdpQueryUuid uuids[MAX_UUIDS_IN_QUERY]; + + // See comments in BTH_SDP_ATTRIBUTE_SEARCH_REQUEST + SdpAttributeRange range[1]; + +} BTH_SDP_SERVICE_ATTRIBUTE_SEARCH_REQUEST, + *PBTH_SDP_SERVICE_ATTRIBUTE_SEARCH_REQUEST; + +typedef struct _BTH_SDP_STREAM_RESPONSE +{ + // The required buffer size (not including the first 2 ULONG_PTRs of this + // data structure) needed to contain the response. + // If the buffer passed was large enough to contain the entire response, + // requiredSize will be equal to responseSize. Otherwise, the caller should + // resubmit the request with a buffer size equal to + // sizeof(BTH_SDP_STREAM_RESPONSE) + requiredSize - 1. (The -1 is because + // the size of this data structure already includes one byte of the + // response.) + // A response cannot exceed 4GB in size. + ULONG requiredSize; + + // The number of bytes copied into the response array of this data + // structure. If there is not enough room for the entire response, the + // response will be partially copied into the response array. + ULONG responseSize; + + // The raw SDP response from the search. + UCHAR response[1]; + +} BTH_SDP_STREAM_RESPONSE, *PBTH_SDP_STREAM_RESPONSE; + +#if (NTDDI_VERSION > NTDDI_VISTASP1 || \ + (NTDDI_VERSION == NTDDI_VISTASP1 && defined(VISTA_KB942567))) + +// Vendor specific HCI command header +typedef struct _BTH_COMMAND_HEADER +{ + // Opcode for the command + USHORT OpCode; + + // Payload of the command excluding the header. + // TotalParameterLength = TotalCommandLength - sizeof(BTH_COMMAND_HEADER) + UCHAR TotalParameterLength; + +} BTH_COMMAND_HEADER, * PBTH_COMMAND_HEADER; + +// Vendor Specific Command structure +typedef struct _BTH_VENDOR_SPECIFIC_COMMAND +{ + // Manufacturer ID + ULONG ManufacturerId; + + // LMP version. Command is send to radio only if the radios + // LMP version is greater than this value. + UCHAR LmpVersion; + + // Should all the patterns match or just one. If MatchAnySinglePattern == TRUE + // then if a single pattern matches the command, we decide that we have a match. + BOOLEAN MatchAnySinglePattern; + + // HCI Command Header + BTH_COMMAND_HEADER HciHeader; + + // Data for the above command including patterns + UCHAR Data[1]; +} BTH_VENDOR_SPECIFIC_COMMAND, * PBTH_VENDOR_SPECIFIC_COMMAND; + +// Structure of patterns +typedef struct _BTH_VENDOR_PATTERN +{ + // Pattern Offset in the event structure excluding EVENT header + UCHAR Offset; + + // Size of the Pattern + UCHAR Size; + + // Pattern + UCHAR Pattern[1]; +} BTH_VENDOR_PATTERN, * PBTH_VENDOR_PATTERN; + + +//The buffer associated with GUID_BLUETOOTH_HCI_VENDOR_EVENT +typedef struct _BTH_VENDOR_EVENT_INFO +{ + //Local radio address with which the event is associated. + BTH_ADDR BthAddress; + + //Size of the event buffer including Event header + ULONG EventSize; + + //Information associated with the event + UCHAR EventInfo[1]; +} BTH_VENDOR_EVENT_INFO, * PBTH_VENDOR_EVENT_INFO; + +#endif // >= SP1+KB942567 + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +// Host supported features +#define BTH_HOST_FEATURE_ENHANCED_RETRANSMISSION_MODE (0x0000000000000001) +#define BTH_HOST_FEATURE_STREAMING_MODE (0x0000000000000002) +#define BTH_HOST_FEATURE_LOW_ENERGY (0x0000000000000004) +#define BTH_HOST_FEATURE_SCO_HCI (0x0000000000000008) +#define BTH_HOST_FEATURE_SCO_HCIBYPASS (0x0000000000000010) + +typedef struct _BTH_HOST_FEATURE_MASK +{ + // Mask of supported features. + ULONGLONG Mask; + + // Reserved for future use. + ULONGLONG Reserved1; + ULONGLONG Reserved2; +} BTH_HOST_FEATURE_MASK, *PBTH_HOST_FEATURE_MASK; + +#endif //NTDDI_WIN8 + +#include + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // __BTHIOCTL_H__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthsdpdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthsdpdef.h new file mode 100644 index 0000000000000000000000000000000000000000..b47ee1ff021974f7a22e6a2c967b84c0acc29570 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bthsdpdef.h @@ -0,0 +1,121 @@ +// Copyright (C) Microsoft Corporation. All rights reserved. + +#ifndef __BTHSDPDEF_H__ +#define __BTHSDPDEF_H__ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WINXPSP2) + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct SDP_LARGE_INTEGER_16 +{ + ULONGLONG LowPart; + LONGLONG HighPart; +} SDP_LARGE_INTEGER_16, *PSDP_LARGE_INTEGER_16, *LPSDP_LARGE_INTEGER_16; + +typedef struct SDP_ULARGE_INTEGER_16 +{ + ULONGLONG LowPart; + ULONGLONG HighPart; +} SDP_ULARGE_INTEGER_16, *PSDP_ULARGE_INTEGER_16, *LPSDP_ULARGE_INTEGER_16; + +typedef enum NodeContainerType +{ + NodeContainerTypeSequence, + NodeContainerTypeAlternative +} NodeContainerType; + +typedef USHORT SDP_ERROR, *PSDP_ERROR; + +// 9 - 31 are reserved +typedef enum SDP_TYPE +{ + SDP_TYPE_NIL = 0x00, + SDP_TYPE_UINT = 0x01, + SDP_TYPE_INT = 0x02, + SDP_TYPE_UUID = 0x03, + SDP_TYPE_STRING = 0x04, + SDP_TYPE_BOOLEAN = 0x05, + SDP_TYPE_SEQUENCE = 0x06, + SDP_TYPE_ALTERNATIVE = 0x07, + SDP_TYPE_URL = 0x08, + SDP_TYPE_CONTAINER = 0x20 +} SDP_TYPE; + +// allow for a little easier type checking / sizing for integers and UUIDs +// ((SDP_ST_XXX & 0xF0) >> 4) == SDP_TYPE_XXX +// size of the data (in bytes) is encoded as ((SDP_ST_XXX & 0xF0) >> 8) +typedef enum SDP_SPECIFICTYPE +{ + SDP_ST_NONE = 0x0000, + + SDP_ST_UINT8 = 0x0010, + SDP_ST_UINT16 = 0x0110, + SDP_ST_UINT32 = 0x0210, + SDP_ST_UINT64 = 0x0310, + SDP_ST_UINT128 = 0x0410, + + SDP_ST_INT8 = 0x0020, + SDP_ST_INT16 = 0x0120, + SDP_ST_INT32 = 0x0220, + SDP_ST_INT64 = 0x0320, + SDP_ST_INT128 = 0x0420, + + SDP_ST_UUID16 = 0x0130, + SDP_ST_UUID32 = 0x0220, + SDP_ST_UUID128 = 0x0430 +} SDP_SPECIFICTYPE; + +typedef struct SdpAttributeRange +{ + USHORT minAttribute; + USHORT maxAttribute; +} SdpAttributeRange; + +typedef +#ifdef MIDL_PASS + [switch_type(unsigned short)] +#endif +union SdpQueryUuidUnion { +#ifdef MIDL_PASS + [case(SDP_ST_UUID128)] +#endif + GUID uuid128; + +#ifdef MIDL_PASS + [case(SDP_ST_UUID32)] +#endif // _NTDDK_ + ULONG uuid32; + +#ifdef MIDL_PASS + [case(SDP_ST_UUID16)] +#endif // _NTDDK_ + USHORT uuid16; +} SdpQueryUuidUnion; + +typedef struct _SdpQueryUuid { +#ifdef MIDL_PASS + [switch_is(uuidType)] +#endif + SdpQueryUuidUnion u; + + USHORT uuidType; +} SdpQueryUuid; + + +#ifdef __cplusplus +}; +#endif + +#endif // (NTDDI_VERSION >= NTDDI_WINXPSP2) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // __BTHSDPDEF_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bugcodes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bugcodes.h new file mode 100644 index 0000000000000000000000000000000000000000..35889c9f9b4b929a21a94541d2f4c71029720db1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/bugcodes.h @@ -0,0 +1,4902 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) 1991 Microsoft Corporation + +Module Name: + + bugcodes.mc + +Abstract: + + This module contains the definition of the system bug check codes. + +Notes: + + No message strings should be added to the bugcodes' entries. Their + symbolic names take the place of message strings. + +--*/ + +#ifndef _BUGCODES_ +#define _BUGCODES_ + + +// +// Values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// + + +// +// Define the severity codes +// + + +// +// MessageId: HARDWARE_PROFILE_UNDOCKED_STRING +// +// MessageText: +// +// Undocked Profile +// +#define HARDWARE_PROFILE_UNDOCKED_STRING ((ULONG)0x40010001L) + +// +// MessageId: HARDWARE_PROFILE_DOCKED_STRING +// +// MessageText: +// +// Docked Profile +// +#define HARDWARE_PROFILE_DOCKED_STRING ((ULONG)0x40010002L) + +// +// MessageId: HARDWARE_PROFILE_UNKNOWN_STRING +// +// MessageText: +// +// Profile +// +#define HARDWARE_PROFILE_UNKNOWN_STRING ((ULONG)0x40010003L) + +// +// MessageId: WINDOWS_NT_BANNER +// +// MessageText: +// +// Microsoft (R) Windows (R) Version %hs (Build %u%hs) +// +#define WINDOWS_NT_BANNER ((ULONG)0x4000007EL) + +// +// MessageId: WINDOWS_NT_CSD_STRING +// +// MessageText: +// +// Service Pack +// +#define WINDOWS_NT_CSD_STRING ((ULONG)0x40000087L) + +// +// MessageId: WINDOWS_NT_INFO_STRING +// +// MessageText: +// +// %u System Processor [%u MB Memory] %Z +// +#define WINDOWS_NT_INFO_STRING ((ULONG)0x40000088L) + +// +// MessageId: WINDOWS_NT_MP_STRING +// +// MessageText: +// +// MultiProcessor Kernel +// +#define WINDOWS_NT_MP_STRING ((ULONG)0x40000089L) + +// +// MessageId: THREAD_TERMINATE_HELD_MUTEX +// +// MessageText: +// +// A kernel thread terminated while holding a mutex +// +#define THREAD_TERMINATE_HELD_MUTEX ((ULONG)0x4000008AL) + +// +// MessageId: WINDOWS_NT_INFO_STRING_PLURAL +// +// MessageText: +// +// %u System Processors [%u MB Memory] %Z +// +#define WINDOWS_NT_INFO_STRING_PLURAL ((ULONG)0x4000009DL) + +// +// MessageId: WINDOWS_NT_RC_STRING +// +// MessageText: +// +// RC +// +#define WINDOWS_NT_RC_STRING ((ULONG)0x4000009EL) + +// +// MessageId: APC_INDEX_MISMATCH +// +// MessageText: +// +// APC_INDEX_MISMATCH +// +#define APC_INDEX_MISMATCH ((ULONG)0x00000001L) + +// +// MessageId: DEVICE_QUEUE_NOT_BUSY +// +// MessageText: +// +// DEVICE_QUEUE_NOT_BUSY +// +#define DEVICE_QUEUE_NOT_BUSY ((ULONG)0x00000002L) + +// +// MessageId: INVALID_AFFINITY_SET +// +// MessageText: +// +// INVALID_AFFINITY_SET +// +#define INVALID_AFFINITY_SET ((ULONG)0x00000003L) + +// +// MessageId: INVALID_DATA_ACCESS_TRAP +// +// MessageText: +// +// INVALID_DATA_ACCESS_TRAP +// +#define INVALID_DATA_ACCESS_TRAP ((ULONG)0x00000004L) + +// +// MessageId: INVALID_PROCESS_ATTACH_ATTEMPT +// +// MessageText: +// +// INVALID_PROCESS_ATTACH_ATTEMPT +// +#define INVALID_PROCESS_ATTACH_ATTEMPT ((ULONG)0x00000005L) + +// +// MessageId: INVALID_PROCESS_DETACH_ATTEMPT +// +// MessageText: +// +// INVALID_PROCESS_DETACH_ATTEMPT +// +#define INVALID_PROCESS_DETACH_ATTEMPT ((ULONG)0x00000006L) + +// +// MessageId: INVALID_SOFTWARE_INTERRUPT +// +// MessageText: +// +// INVALID_SOFTWARE_INTERRUPT +// +#define INVALID_SOFTWARE_INTERRUPT ((ULONG)0x00000007L) + +// +// MessageId: IRQL_NOT_DISPATCH_LEVEL +// +// MessageText: +// +// IRQL_NOT_DISPATCH_LEVEL +// +#define IRQL_NOT_DISPATCH_LEVEL ((ULONG)0x00000008L) + +// +// MessageId: IRQL_NOT_GREATER_OR_EQUAL +// +// MessageText: +// +// IRQL_NOT_GREATER_OR_EQUAL +// +#define IRQL_NOT_GREATER_OR_EQUAL ((ULONG)0x00000009L) + +// +// MessageId: IRQL_NOT_LESS_OR_EQUAL +// +// MessageText: +// +// IRQL_NOT_LESS_OR_EQUAL +// +#define IRQL_NOT_LESS_OR_EQUAL ((ULONG)0x0000000AL) + +// +// MessageId: NO_EXCEPTION_HANDLING_SUPPORT +// +// MessageText: +// +// NO_EXCEPTION_HANDLING_SUPPORT +// +#define NO_EXCEPTION_HANDLING_SUPPORT ((ULONG)0x0000000BL) + +// +// MessageId: MAXIMUM_WAIT_OBJECTS_EXCEEDED +// +// MessageText: +// +// MAXIMUM_WAIT_OBJECTS_EXCEEDED +// +#define MAXIMUM_WAIT_OBJECTS_EXCEEDED ((ULONG)0x0000000CL) + +// +// MessageId: MUTEX_LEVEL_NUMBER_VIOLATION +// +// MessageText: +// +// MUTEX_LEVEL_NUMBER_VIOLATION +// +#define MUTEX_LEVEL_NUMBER_VIOLATION ((ULONG)0x0000000DL) + +// +// MessageId: NO_USER_MODE_CONTEXT +// +// MessageText: +// +// NO_USER_MODE_CONTEXT +// +#define NO_USER_MODE_CONTEXT ((ULONG)0x0000000EL) + +// +// MessageId: SPIN_LOCK_ALREADY_OWNED +// +// MessageText: +// +// SPIN_LOCK_ALREADY_OWNED +// +#define SPIN_LOCK_ALREADY_OWNED ((ULONG)0x0000000FL) + +// +// MessageId: SPIN_LOCK_NOT_OWNED +// +// MessageText: +// +// SPIN_LOCK_NOT_OWNED +// +#define SPIN_LOCK_NOT_OWNED ((ULONG)0x00000010L) + +// +// MessageId: THREAD_NOT_MUTEX_OWNER +// +// MessageText: +// +// THREAD_NOT_MUTEX_OWNER +// +#define THREAD_NOT_MUTEX_OWNER ((ULONG)0x00000011L) + +// +// MessageId: TRAP_CAUSE_UNKNOWN +// +// MessageText: +// +// TRAP_CAUSE_UNKNOWN +// +#define TRAP_CAUSE_UNKNOWN ((ULONG)0x00000012L) + +// +// MessageId: EMPTY_THREAD_REAPER_LIST +// +// MessageText: +// +// EMPTY_THREAD_REAPER_LIST +// +#define EMPTY_THREAD_REAPER_LIST ((ULONG)0x00000013L) + +// +// MessageId: CREATE_DELETE_LOCK_NOT_LOCKED +// +// MessageText: +// +// CREATE_DELETE_LOCK_NOT_LOCKED +// +#define CREATE_DELETE_LOCK_NOT_LOCKED ((ULONG)0x00000014L) + +// +// MessageId: LAST_CHANCE_CALLED_FROM_KMODE +// +// MessageText: +// +// LAST_CHANCE_CALLED_FROM_KMODE +// +#define LAST_CHANCE_CALLED_FROM_KMODE ((ULONG)0x00000015L) + +// +// MessageId: CID_HANDLE_CREATION +// +// MessageText: +// +// CID_HANDLE_CREATION +// +#define CID_HANDLE_CREATION ((ULONG)0x00000016L) + +// +// MessageId: CID_HANDLE_DELETION +// +// MessageText: +// +// CID_HANDLE_DELETION +// +#define CID_HANDLE_DELETION ((ULONG)0x00000017L) + +// +// MessageId: REFERENCE_BY_POINTER +// +// MessageText: +// +// REFERENCE_BY_POINTER +// +#define REFERENCE_BY_POINTER ((ULONG)0x00000018L) + +// +// MessageId: BAD_POOL_HEADER +// +// MessageText: +// +// BAD_POOL_HEADER +// +#define BAD_POOL_HEADER ((ULONG)0x00000019L) + +// +// MessageId: MEMORY_MANAGEMENT +// +// MessageText: +// +// MEMORY_MANAGEMENT +// +#define MEMORY_MANAGEMENT ((ULONG)0x0000001AL) + +// +// MessageId: PFN_SHARE_COUNT +// +// MessageText: +// +// PFN_SHARE_COUNT +// +#define PFN_SHARE_COUNT ((ULONG)0x0000001BL) + +// +// MessageId: PFN_REFERENCE_COUNT +// +// MessageText: +// +// PFN_REFERENCE_COUNT +// +#define PFN_REFERENCE_COUNT ((ULONG)0x0000001CL) + +// +// MessageId: NO_SPIN_LOCK_AVAILABLE +// +// MessageText: +// +// NO_SPIN_LOCK_AVAILABLE +// +#define NO_SPIN_LOCK_AVAILABLE ((ULONG)0x0000001DL) + +// +// MessageId: KMODE_EXCEPTION_NOT_HANDLED +// +// MessageText: +// +// KMODE_EXCEPTION_NOT_HANDLED +// +#define KMODE_EXCEPTION_NOT_HANDLED ((ULONG)0x0000001EL) + +// +// MessageId: SHARED_RESOURCE_CONV_ERROR +// +// MessageText: +// +// SHARED_RESOURCE_CONV_ERROR +// +#define SHARED_RESOURCE_CONV_ERROR ((ULONG)0x0000001FL) + +// +// MessageId: KERNEL_APC_PENDING_DURING_EXIT +// +// MessageText: +// +// KERNEL_APC_PENDING_DURING_EXIT +// +#define KERNEL_APC_PENDING_DURING_EXIT ((ULONG)0x00000020L) + +// +// MessageId: QUOTA_UNDERFLOW +// +// MessageText: +// +// QUOTA_UNDERFLOW +// +#define QUOTA_UNDERFLOW ((ULONG)0x00000021L) + +// +// MessageId: FILE_SYSTEM +// +// MessageText: +// +// FILE_SYSTEM +// +#define FILE_SYSTEM ((ULONG)0x00000022L) + +// +// MessageId: FAT_FILE_SYSTEM +// +// MessageText: +// +// FAT_FILE_SYSTEM +// +#define FAT_FILE_SYSTEM ((ULONG)0x00000023L) + +// +// MessageId: NTFS_FILE_SYSTEM +// +// MessageText: +// +// NTFS_FILE_SYSTEM +// +#define NTFS_FILE_SYSTEM ((ULONG)0x00000024L) + +// +// MessageId: NPFS_FILE_SYSTEM +// +// MessageText: +// +// NPFS_FILE_SYSTEM +// +#define NPFS_FILE_SYSTEM ((ULONG)0x00000025L) + +// +// MessageId: CDFS_FILE_SYSTEM +// +// MessageText: +// +// CDFS_FILE_SYSTEM +// +#define CDFS_FILE_SYSTEM ((ULONG)0x00000026L) + +// +// MessageId: RDR_FILE_SYSTEM +// +// MessageText: +// +// RDR_FILE_SYSTEM +// +#define RDR_FILE_SYSTEM ((ULONG)0x00000027L) + +// +// MessageId: CORRUPT_ACCESS_TOKEN +// +// MessageText: +// +// CORRUPT_ACCESS_TOKEN +// +#define CORRUPT_ACCESS_TOKEN ((ULONG)0x00000028L) + +// +// MessageId: SECURITY_SYSTEM +// +// MessageText: +// +// SECURITY_SYSTEM +// +#define SECURITY_SYSTEM ((ULONG)0x00000029L) + +// +// MessageId: INCONSISTENT_IRP +// +// MessageText: +// +// INCONSISTENT_IRP +// +#define INCONSISTENT_IRP ((ULONG)0x0000002AL) + +// +// MessageId: PANIC_STACK_SWITCH +// +// MessageText: +// +// PANIC_STACK_SWITCH +// +#define PANIC_STACK_SWITCH ((ULONG)0x0000002BL) + +// +// MessageId: PORT_DRIVER_INTERNAL +// +// MessageText: +// +// PORT_DRIVER_INTERNAL +// +#define PORT_DRIVER_INTERNAL ((ULONG)0x0000002CL) + +// +// MessageId: SCSI_DISK_DRIVER_INTERNAL +// +// MessageText: +// +// SCSI_DISK_DRIVER_INTERNAL +// +#define SCSI_DISK_DRIVER_INTERNAL ((ULONG)0x0000002DL) + +// +// MessageId: DATA_BUS_ERROR +// +// MessageText: +// +// DATA_BUS_ERROR +// +#define DATA_BUS_ERROR ((ULONG)0x0000002EL) + +// +// MessageId: INSTRUCTION_BUS_ERROR +// +// MessageText: +// +// INSTRUCTION_BUS_ERROR +// +#define INSTRUCTION_BUS_ERROR ((ULONG)0x0000002FL) + +// +// MessageId: SET_OF_INVALID_CONTEXT +// +// MessageText: +// +// SET_OF_INVALID_CONTEXT +// +#define SET_OF_INVALID_CONTEXT ((ULONG)0x00000030L) + +// +// MessageId: PHASE0_INITIALIZATION_FAILED +// +// MessageText: +// +// PHASE0_INITIALIZATION_FAILED +// +#define PHASE0_INITIALIZATION_FAILED ((ULONG)0x00000031L) + +// +// MessageId: PHASE1_INITIALIZATION_FAILED +// +// MessageText: +// +// PHASE1_INITIALIZATION_FAILED +// +#define PHASE1_INITIALIZATION_FAILED ((ULONG)0x00000032L) + +// +// MessageId: UNEXPECTED_INITIALIZATION_CALL +// +// MessageText: +// +// UNEXPECTED_INITIALIZATION_CALL +// +#define UNEXPECTED_INITIALIZATION_CALL ((ULONG)0x00000033L) + +// +// MessageId: CACHE_MANAGER +// +// MessageText: +// +// CACHE_MANAGER +// +#define CACHE_MANAGER ((ULONG)0x00000034L) + +// +// MessageId: NO_MORE_IRP_STACK_LOCATIONS +// +// MessageText: +// +// NO_MORE_IRP_STACK_LOCATIONS +// +#define NO_MORE_IRP_STACK_LOCATIONS ((ULONG)0x00000035L) + +// +// MessageId: DEVICE_REFERENCE_COUNT_NOT_ZERO +// +// MessageText: +// +// DEVICE_REFERENCE_COUNT_NOT_ZERO +// +#define DEVICE_REFERENCE_COUNT_NOT_ZERO ((ULONG)0x00000036L) + +// +// MessageId: FLOPPY_INTERNAL_ERROR +// +// MessageText: +// +// FLOPPY_INTERNAL_ERROR +// +#define FLOPPY_INTERNAL_ERROR ((ULONG)0x00000037L) + +// +// MessageId: SERIAL_DRIVER_INTERNAL +// +// MessageText: +// +// SERIAL_DRIVER_INTERNAL +// +#define SERIAL_DRIVER_INTERNAL ((ULONG)0x00000038L) + +// +// MessageId: SYSTEM_EXIT_OWNED_MUTEX +// +// MessageText: +// +// SYSTEM_EXIT_OWNED_MUTEX +// +#define SYSTEM_EXIT_OWNED_MUTEX ((ULONG)0x00000039L) + +// +// MessageId: SYSTEM_UNWIND_PREVIOUS_USER +// +// MessageText: +// +// SYSTEM_UNWIND_PREVIOUS_USER +// +#define SYSTEM_UNWIND_PREVIOUS_USER ((ULONG)0x0000003AL) + +// +// MessageId: SYSTEM_SERVICE_EXCEPTION +// +// MessageText: +// +// SYSTEM_SERVICE_EXCEPTION +// +#define SYSTEM_SERVICE_EXCEPTION ((ULONG)0x0000003BL) + +// +// MessageId: INTERRUPT_UNWIND_ATTEMPTED +// +// MessageText: +// +// INTERRUPT_UNWIND_ATTEMPTED +// +#define INTERRUPT_UNWIND_ATTEMPTED ((ULONG)0x0000003CL) + +// +// MessageId: INTERRUPT_EXCEPTION_NOT_HANDLED +// +// MessageText: +// +// INTERRUPT_EXCEPTION_NOT_HANDLED +// +#define INTERRUPT_EXCEPTION_NOT_HANDLED ((ULONG)0x0000003DL) + +// +// MessageId: MULTIPROCESSOR_CONFIGURATION_NOT_SUPPORTED +// +// MessageText: +// +// MULTIPROCESSOR_CONFIGURATION_NOT_SUPPORTED +// +#define MULTIPROCESSOR_CONFIGURATION_NOT_SUPPORTED ((ULONG)0x0000003EL) + +// +// MessageId: NO_MORE_SYSTEM_PTES +// +// MessageText: +// +// NO_MORE_SYSTEM_PTES +// +#define NO_MORE_SYSTEM_PTES ((ULONG)0x0000003FL) + +// +// MessageId: TARGET_MDL_TOO_SMALL +// +// MessageText: +// +// TARGET_MDL_TOO_SMALL +// +#define TARGET_MDL_TOO_SMALL ((ULONG)0x00000040L) + +// +// MessageId: MUST_SUCCEED_POOL_EMPTY +// +// MessageText: +// +// MUST_SUCCEED_POOL_EMPTY +// +#define MUST_SUCCEED_POOL_EMPTY ((ULONG)0x00000041L) + +// +// MessageId: ATDISK_DRIVER_INTERNAL +// +// MessageText: +// +// ATDISK_DRIVER_INTERNAL +// +#define ATDISK_DRIVER_INTERNAL ((ULONG)0x00000042L) + +// +// MessageId: NO_SUCH_PARTITION +// +// MessageText: +// +// NO_SUCH_PARTITION +// +#define NO_SUCH_PARTITION ((ULONG)0x00000043L) + +// +// MessageId: MULTIPLE_IRP_COMPLETE_REQUESTS +// +// MessageText: +// +// MULTIPLE_IRP_COMPLETE_REQUESTS +// +#define MULTIPLE_IRP_COMPLETE_REQUESTS ((ULONG)0x00000044L) + +// +// MessageId: INSUFFICIENT_SYSTEM_MAP_REGS +// +// MessageText: +// +// INSUFFICIENT_SYSTEM_MAP_REGS +// +#define INSUFFICIENT_SYSTEM_MAP_REGS ((ULONG)0x00000045L) + +// +// MessageId: DEREF_UNKNOWN_LOGON_SESSION +// +// MessageText: +// +// DEREF_UNKNOWN_LOGON_SESSION +// +#define DEREF_UNKNOWN_LOGON_SESSION ((ULONG)0x00000046L) + +// +// MessageId: REF_UNKNOWN_LOGON_SESSION +// +// MessageText: +// +// REF_UNKNOWN_LOGON_SESSION +// +#define REF_UNKNOWN_LOGON_SESSION ((ULONG)0x00000047L) + +// +// MessageId: CANCEL_STATE_IN_COMPLETED_IRP +// +// MessageText: +// +// CANCEL_STATE_IN_COMPLETED_IRP +// +#define CANCEL_STATE_IN_COMPLETED_IRP ((ULONG)0x00000048L) + +// +// MessageId: PAGE_FAULT_WITH_INTERRUPTS_OFF +// +// MessageText: +// +// PAGE_FAULT_WITH_INTERRUPTS_OFF +// +#define PAGE_FAULT_WITH_INTERRUPTS_OFF ((ULONG)0x00000049L) + +// +// MessageId: IRQL_GT_ZERO_AT_SYSTEM_SERVICE +// +// MessageText: +// +// IRQL_GT_ZERO_AT_SYSTEM_SERVICE +// +#define IRQL_GT_ZERO_AT_SYSTEM_SERVICE ((ULONG)0x0000004AL) + +// +// MessageId: STREAMS_INTERNAL_ERROR +// +// MessageText: +// +// STREAMS_INTERNAL_ERROR +// +#define STREAMS_INTERNAL_ERROR ((ULONG)0x0000004BL) + +// +// MessageId: FATAL_UNHANDLED_HARD_ERROR +// +// MessageText: +// +// FATAL_UNHANDLED_HARD_ERROR +// +#define FATAL_UNHANDLED_HARD_ERROR ((ULONG)0x0000004CL) + +// +// MessageId: NO_PAGES_AVAILABLE +// +// MessageText: +// +// NO_PAGES_AVAILABLE +// +#define NO_PAGES_AVAILABLE ((ULONG)0x0000004DL) + +// +// MessageId: PFN_LIST_CORRUPT +// +// MessageText: +// +// PFN_LIST_CORRUPT +// +#define PFN_LIST_CORRUPT ((ULONG)0x0000004EL) + +// +// MessageId: NDIS_INTERNAL_ERROR +// +// MessageText: +// +// NDIS_INTERNAL_ERROR +// +#define NDIS_INTERNAL_ERROR ((ULONG)0x0000004FL) + +// +// MessageId: PAGE_FAULT_IN_NONPAGED_AREA +// +// MessageText: +// +// PAGE_FAULT_IN_NONPAGED_AREA +// +#define PAGE_FAULT_IN_NONPAGED_AREA ((ULONG)0x00000050L) + +#define PAGE_FAULT_IN_NONPAGED_AREA_M ((ULONG)0x10000050L) +// +// MessageId: REGISTRY_ERROR +// +// MessageText: +// +// REGISTRY_ERROR +// +#define REGISTRY_ERROR ((ULONG)0x00000051L) + +// +// MessageId: MAILSLOT_FILE_SYSTEM +// +// MessageText: +// +// MAILSLOT_FILE_SYSTEM +// +#define MAILSLOT_FILE_SYSTEM ((ULONG)0x00000052L) + +// +// MessageId: NO_BOOT_DEVICE +// +// MessageText: +// +// NO_BOOT_DEVICE +// +#define NO_BOOT_DEVICE ((ULONG)0x00000053L) + +// +// MessageId: LM_SERVER_INTERNAL_ERROR +// +// MessageText: +// +// LM_SERVER_INTERNAL_ERROR +// +#define LM_SERVER_INTERNAL_ERROR ((ULONG)0x00000054L) + +// +// MessageId: DATA_COHERENCY_EXCEPTION +// +// MessageText: +// +// DATA_COHERENCY_EXCEPTION +// +#define DATA_COHERENCY_EXCEPTION ((ULONG)0x00000055L) + +// +// MessageId: INSTRUCTION_COHERENCY_EXCEPTION +// +// MessageText: +// +// INSTRUCTION_COHERENCY_EXCEPTION +// +#define INSTRUCTION_COHERENCY_EXCEPTION ((ULONG)0x00000056L) + +// +// MessageId: XNS_INTERNAL_ERROR +// +// MessageText: +// +// XNS_INTERNAL_ERROR +// +#define XNS_INTERNAL_ERROR ((ULONG)0x00000057L) + +// +// MessageId: VOLMGRX_INTERNAL_ERROR +// +// MessageText: +// +// VOLMGRX_INTERNAL_ERROR +// +#define VOLMGRX_INTERNAL_ERROR ((ULONG)0x00000058L) + +// +// MessageId: PINBALL_FILE_SYSTEM +// +// MessageText: +// +// PINBALL_FILE_SYSTEM +// +#define PINBALL_FILE_SYSTEM ((ULONG)0x00000059L) + +// +// MessageId: CRITICAL_SERVICE_FAILED +// +// MessageText: +// +// CRITICAL_SERVICE_FAILED +// +#define CRITICAL_SERVICE_FAILED ((ULONG)0x0000005AL) + +// +// MessageId: SET_ENV_VAR_FAILED +// +// MessageText: +// +// SET_ENV_VAR_FAILED +// +#define SET_ENV_VAR_FAILED ((ULONG)0x0000005BL) + +// +// MessageId: HAL_INITIALIZATION_FAILED +// +// MessageText: +// +// HAL_INITIALIZATION_FAILED +// +#define HAL_INITIALIZATION_FAILED ((ULONG)0x0000005CL) + +// +// MessageId: UNSUPPORTED_PROCESSOR +// +// MessageText: +// +// UNSUPPORTED_PROCESSOR +// +#define UNSUPPORTED_PROCESSOR ((ULONG)0x0000005DL) + +// +// MessageId: OBJECT_INITIALIZATION_FAILED +// +// MessageText: +// +// OBJECT_INITIALIZATION_FAILED +// +#define OBJECT_INITIALIZATION_FAILED ((ULONG)0x0000005EL) + +// +// MessageId: SECURITY_INITIALIZATION_FAILED +// +// MessageText: +// +// SECURITY_INITIALIZATION_FAILED +// +#define SECURITY_INITIALIZATION_FAILED ((ULONG)0x0000005FL) + +// +// MessageId: PROCESS_INITIALIZATION_FAILED +// +// MessageText: +// +// PROCESS_INITIALIZATION_FAILED +// +#define PROCESS_INITIALIZATION_FAILED ((ULONG)0x00000060L) + +// +// MessageId: HAL1_INITIALIZATION_FAILED +// +// MessageText: +// +// HAL1_INITIALIZATION_FAILED +// +#define HAL1_INITIALIZATION_FAILED ((ULONG)0x00000061L) + +// +// MessageId: OBJECT1_INITIALIZATION_FAILED +// +// MessageText: +// +// OBJECT1_INITIALIZATION_FAILED +// +#define OBJECT1_INITIALIZATION_FAILED ((ULONG)0x00000062L) + +// +// MessageId: SECURITY1_INITIALIZATION_FAILED +// +// MessageText: +// +// SECURITY1_INITIALIZATION_FAILED +// +#define SECURITY1_INITIALIZATION_FAILED ((ULONG)0x00000063L) + +// +// MessageId: SYMBOLIC_INITIALIZATION_FAILED +// +// MessageText: +// +// SYMBOLIC_INITIALIZATION_FAILED +// +#define SYMBOLIC_INITIALIZATION_FAILED ((ULONG)0x00000064L) + +// +// MessageId: MEMORY1_INITIALIZATION_FAILED +// +// MessageText: +// +// MEMORY1_INITIALIZATION_FAILED +// +#define MEMORY1_INITIALIZATION_FAILED ((ULONG)0x00000065L) + +// +// MessageId: CACHE_INITIALIZATION_FAILED +// +// MessageText: +// +// CACHE_INITIALIZATION_FAILED +// +#define CACHE_INITIALIZATION_FAILED ((ULONG)0x00000066L) + +// +// MessageId: CONFIG_INITIALIZATION_FAILED +// +// MessageText: +// +// CONFIG_INITIALIZATION_FAILED +// +#define CONFIG_INITIALIZATION_FAILED ((ULONG)0x00000067L) + +// +// MessageId: FILE_INITIALIZATION_FAILED +// +// MessageText: +// +// FILE_INITIALIZATION_FAILED +// +#define FILE_INITIALIZATION_FAILED ((ULONG)0x00000068L) + +// +// MessageId: IO1_INITIALIZATION_FAILED +// +// MessageText: +// +// IO1_INITIALIZATION_FAILED +// +#define IO1_INITIALIZATION_FAILED ((ULONG)0x00000069L) + +// +// MessageId: LPC_INITIALIZATION_FAILED +// +// MessageText: +// +// LPC_INITIALIZATION_FAILED +// +#define LPC_INITIALIZATION_FAILED ((ULONG)0x0000006AL) + +// +// MessageId: PROCESS1_INITIALIZATION_FAILED +// +// MessageText: +// +// PROCESS1_INITIALIZATION_FAILED +// +#define PROCESS1_INITIALIZATION_FAILED ((ULONG)0x0000006BL) + +// +// MessageId: REFMON_INITIALIZATION_FAILED +// +// MessageText: +// +// REFMON_INITIALIZATION_FAILED +// +#define REFMON_INITIALIZATION_FAILED ((ULONG)0x0000006CL) + +// +// MessageId: SESSION1_INITIALIZATION_FAILED +// +// MessageText: +// +// SESSION1_INITIALIZATION_FAILED +// +#define SESSION1_INITIALIZATION_FAILED ((ULONG)0x0000006DL) + +// +// MessageId: BOOTPROC_INITIALIZATION_FAILED +// +// MessageText: +// +// BOOTPROC_INITIALIZATION_FAILED +// +#define BOOTPROC_INITIALIZATION_FAILED ((ULONG)0x0000006EL) + +// +// MessageId: VSL_INITIALIZATION_FAILED +// +// MessageText: +// +// VSL_INITIALIZATION_FAILED +// +#define VSL_INITIALIZATION_FAILED ((ULONG)0x0000006FL) + +// +// MessageId: SOFT_RESTART_FATAL_ERROR +// +// MessageText: +// +// SOFT_RESTART_FATAL_ERROR +// +#define SOFT_RESTART_FATAL_ERROR ((ULONG)0x00000070L) + +// +// MessageId: ASSIGN_DRIVE_LETTERS_FAILED +// +// MessageText: +// +// ASSIGN_DRIVE_LETTERS_FAILED +// +#define ASSIGN_DRIVE_LETTERS_FAILED ((ULONG)0x00000072L) + +// +// MessageId: CONFIG_LIST_FAILED +// +// MessageText: +// +// CONFIG_LIST_FAILED +// +#define CONFIG_LIST_FAILED ((ULONG)0x00000073L) + +// +// MessageId: BAD_SYSTEM_CONFIG_INFO +// +// MessageText: +// +// BAD_SYSTEM_CONFIG_INFO +// +#define BAD_SYSTEM_CONFIG_INFO ((ULONG)0x00000074L) + +// +// MessageId: CANNOT_WRITE_CONFIGURATION +// +// MessageText: +// +// CANNOT_WRITE_CONFIGURATION +// +#define CANNOT_WRITE_CONFIGURATION ((ULONG)0x00000075L) + +// +// MessageId: PROCESS_HAS_LOCKED_PAGES +// +// MessageText: +// +// PROCESS_HAS_LOCKED_PAGES +// +#define PROCESS_HAS_LOCKED_PAGES ((ULONG)0x00000076L) + +// +// MessageId: KERNEL_STACK_INPAGE_ERROR +// +// MessageText: +// +// KERNEL_STACK_INPAGE_ERROR +// +#define KERNEL_STACK_INPAGE_ERROR ((ULONG)0x00000077L) + +// +// MessageId: PHASE0_EXCEPTION +// +// MessageText: +// +// PHASE0_EXCEPTION +// +#define PHASE0_EXCEPTION ((ULONG)0x00000078L) + +// +// MessageId: MISMATCHED_HAL +// +// MessageText: +// +// MISMATCHED_HAL +// +#define MISMATCHED_HAL ((ULONG)0x00000079L) + +// +// MessageId: KERNEL_DATA_INPAGE_ERROR +// +// MessageText: +// +// KERNEL_DATA_INPAGE_ERROR +// +#define KERNEL_DATA_INPAGE_ERROR ((ULONG)0x0000007AL) + +// +// MessageId: INACCESSIBLE_BOOT_DEVICE +// +// MessageText: +// +// INACCESSIBLE_BOOT_DEVICE +// +#define INACCESSIBLE_BOOT_DEVICE ((ULONG)0x0000007BL) + +// +// MessageId: BUGCODE_NDIS_DRIVER +// +// MessageText: +// +// BUGCODE_NDIS_DRIVER +// +#define BUGCODE_NDIS_DRIVER ((ULONG)0x0000007CL) + +// +// MessageId: INSTALL_MORE_MEMORY +// +// MessageText: +// +// INSTALL_MORE_MEMORY +// +#define INSTALL_MORE_MEMORY ((ULONG)0x0000007DL) + +// +// MessageId: SYSTEM_THREAD_EXCEPTION_NOT_HANDLED +// +// MessageText: +// +// SYSTEM_THREAD_EXCEPTION_NOT_HANDLED +// +#define SYSTEM_THREAD_EXCEPTION_NOT_HANDLED ((ULONG)0x0000007EL) + +#define SYSTEM_THREAD_EXCEPTION_NOT_HANDLED_M ((ULONG)0x1000007EL) +// +// MessageId: UNEXPECTED_KERNEL_MODE_TRAP +// +// MessageText: +// +// UNEXPECTED_KERNEL_MODE_TRAP +// +#define UNEXPECTED_KERNEL_MODE_TRAP ((ULONG)0x0000007FL) + +#define UNEXPECTED_KERNEL_MODE_TRAP_M ((ULONG)0x1000007FL) +// +// MessageId: NMI_HARDWARE_FAILURE +// +// MessageText: +// +// NMI_HARDWARE_FAILURE +// +#define NMI_HARDWARE_FAILURE ((ULONG)0x00000080L) + +// +// MessageId: SPIN_LOCK_INIT_FAILURE +// +// MessageText: +// +// SPIN_LOCK_INIT_FAILURE +// +#define SPIN_LOCK_INIT_FAILURE ((ULONG)0x00000081L) + +// +// MessageId: DFS_FILE_SYSTEM +// +// MessageText: +// +// DFS_FILE_SYSTEM +// +#define DFS_FILE_SYSTEM ((ULONG)0x00000082L) + +// +// MessageId: OFS_FILE_SYSTEM +// +// MessageText: +// +// OFS_FILE_SYSTEM +// +#define OFS_FILE_SYSTEM ((ULONG)0x00000083L) + +// +// MessageId: RECOM_DRIVER +// +// MessageText: +// +// RECOM_DRIVER +// +#define RECOM_DRIVER ((ULONG)0x00000084L) + +// +// MessageId: SETUP_FAILURE +// +// MessageText: +// +// SETUP_FAILURE +// +#define SETUP_FAILURE ((ULONG)0x00000085L) + +// +// MessageId: AUDIT_FAILURE +// +// MessageText: +// +// AUDIT_FAILURE +// +#define AUDIT_FAILURE ((ULONG)0x00000086L) + +// +// MessageId: MBR_CHECKSUM_MISMATCH +// +// MessageText: +// +// MBR_CHECKSUM_MISMATCH +// +#define MBR_CHECKSUM_MISMATCH ((ULONG)0x0000008BL) + +// +// MessageId: KERNEL_MODE_EXCEPTION_NOT_HANDLED +// +// MessageText: +// +// KERNEL_MODE_EXCEPTION_NOT_HANDLED +// +#define KERNEL_MODE_EXCEPTION_NOT_HANDLED ((ULONG)0x0000008EL) + +#define KERNEL_MODE_EXCEPTION_NOT_HANDLED_M ((ULONG)0x1000008EL) +// +// MessageId: PP0_INITIALIZATION_FAILED +// +// MessageText: +// +// PP0_INITIALIZATION_FAILED +// +#define PP0_INITIALIZATION_FAILED ((ULONG)0x0000008FL) + +// +// MessageId: PP1_INITIALIZATION_FAILED +// +// MessageText: +// +// PP1_INITIALIZATION_FAILED +// +#define PP1_INITIALIZATION_FAILED ((ULONG)0x00000090L) + +// +// MessageId: WIN32K_INIT_OR_RIT_FAILURE +// +// MessageText: +// +// WIN32K_INIT_OR_RIT_FAILURE +// +#define WIN32K_INIT_OR_RIT_FAILURE ((ULONG)0x00000091L) + +// +// MessageId: UP_DRIVER_ON_MP_SYSTEM +// +// MessageText: +// +// UP_DRIVER_ON_MP_SYSTEM +// +#define UP_DRIVER_ON_MP_SYSTEM ((ULONG)0x00000092L) + +// +// MessageId: INVALID_KERNEL_HANDLE +// +// MessageText: +// +// INVALID_KERNEL_HANDLE +// +#define INVALID_KERNEL_HANDLE ((ULONG)0x00000093L) + +// +// MessageId: KERNEL_STACK_LOCKED_AT_EXIT +// +// MessageText: +// +// KERNEL_STACK_LOCKED_AT_EXIT +// +#define KERNEL_STACK_LOCKED_AT_EXIT ((ULONG)0x00000094L) + +// +// MessageId: PNP_INTERNAL_ERROR +// +// MessageText: +// +// PNP_INTERNAL_ERROR +// +#define PNP_INTERNAL_ERROR ((ULONG)0x00000095L) + +// +// MessageId: INVALID_WORK_QUEUE_ITEM +// +// MessageText: +// +// INVALID_WORK_QUEUE_ITEM +// +#define INVALID_WORK_QUEUE_ITEM ((ULONG)0x00000096L) + +// +// MessageId: BOUND_IMAGE_UNSUPPORTED +// +// MessageText: +// +// BOUND_IMAGE_UNSUPPORTED +// +#define BOUND_IMAGE_UNSUPPORTED ((ULONG)0x00000097L) + +// +// MessageId: END_OF_NT_EVALUATION_PERIOD +// +// MessageText: +// +// END_OF_NT_EVALUATION_PERIOD +// +#define END_OF_NT_EVALUATION_PERIOD ((ULONG)0x00000098L) + +// +// MessageId: INVALID_REGION_OR_SEGMENT +// +// MessageText: +// +// INVALID_REGION_OR_SEGMENT +// +#define INVALID_REGION_OR_SEGMENT ((ULONG)0x00000099L) + +// +// MessageId: SYSTEM_LICENSE_VIOLATION +// +// MessageText: +// +// SYSTEM_LICENSE_VIOLATION +// +#define SYSTEM_LICENSE_VIOLATION ((ULONG)0x0000009AL) + +// +// MessageId: UDFS_FILE_SYSTEM +// +// MessageText: +// +// UDFS_FILE_SYSTEM +// +#define UDFS_FILE_SYSTEM ((ULONG)0x0000009BL) + +// +// MessageId: MACHINE_CHECK_EXCEPTION +// +// MessageText: +// +// MACHINE_CHECK_EXCEPTION +// +#define MACHINE_CHECK_EXCEPTION ((ULONG)0x0000009CL) + +// +// MessageId: USER_MODE_HEALTH_MONITOR +// +// MessageText: +// +// USER_MODE_HEALTH_MONITOR +// +#define USER_MODE_HEALTH_MONITOR ((ULONG)0x0000009EL) + +// +// MessageId: DRIVER_POWER_STATE_FAILURE +// +// MessageText: +// +// DRIVER_POWER_STATE_FAILURE +// +#define DRIVER_POWER_STATE_FAILURE ((ULONG)0x0000009FL) + +// +// MessageId: INTERNAL_POWER_ERROR +// +// MessageText: +// +// INTERNAL_POWER_ERROR +// +#define INTERNAL_POWER_ERROR ((ULONG)0x000000A0L) + +// +// MessageId: PCI_BUS_DRIVER_INTERNAL +// +// MessageText: +// +// PCI_BUS_DRIVER_INTERNAL +// +#define PCI_BUS_DRIVER_INTERNAL ((ULONG)0x000000A1L) + +// +// MessageId: MEMORY_IMAGE_CORRUPT +// +// MessageText: +// +// MEMORY_IMAGE_CORRUPT +// +#define MEMORY_IMAGE_CORRUPT ((ULONG)0x000000A2L) + +// +// MessageId: ACPI_DRIVER_INTERNAL +// +// MessageText: +// +// ACPI_DRIVER_INTERNAL +// +#define ACPI_DRIVER_INTERNAL ((ULONG)0x000000A3L) + +// +// MessageId: CNSS_FILE_SYSTEM_FILTER +// +// MessageText: +// +// CNSS_FILE_SYSTEM_FILTER +// +#define CNSS_FILE_SYSTEM_FILTER ((ULONG)0x000000A4L) + +// +// MessageId: ACPI_BIOS_ERROR +// +// MessageText: +// +// ACPI_BIOS_ERROR +// +#define ACPI_BIOS_ERROR ((ULONG)0x000000A5L) + +// +// MessageId: FP_EMULATION_ERROR +// +// MessageText: +// +// FP_EMULATION_ERROR +// +#define FP_EMULATION_ERROR ((ULONG)0x000000A6L) + +// +// MessageId: BAD_EXHANDLE +// +// MessageText: +// +// BAD_EXHANDLE +// +#define BAD_EXHANDLE ((ULONG)0x000000A7L) + +// +// MessageId: BOOTING_IN_SAFEMODE_MINIMAL +// +// MessageText: +// +// BOOTING_IN_SAFEMODE_MINIMAL +// +#define BOOTING_IN_SAFEMODE_MINIMAL ((ULONG)0x000000A8L) + +// +// MessageId: BOOTING_IN_SAFEMODE_NETWORK +// +// MessageText: +// +// BOOTING_IN_SAFEMODE_NETWORK +// +#define BOOTING_IN_SAFEMODE_NETWORK ((ULONG)0x000000A9L) + +// +// MessageId: BOOTING_IN_SAFEMODE_DSREPAIR +// +// MessageText: +// +// BOOTING_IN_SAFEMODE_DSREPAIR +// +#define BOOTING_IN_SAFEMODE_DSREPAIR ((ULONG)0x000000AAL) + +// +// MessageId: SESSION_HAS_VALID_POOL_ON_EXIT +// +// MessageText: +// +// SESSION_HAS_VALID_POOL_ON_EXIT +// +#define SESSION_HAS_VALID_POOL_ON_EXIT ((ULONG)0x000000ABL) + +// +// MessageId: HAL_MEMORY_ALLOCATION +// +// MessageText: +// +// HAL_MEMORY_ALLOCATION +// +#define HAL_MEMORY_ALLOCATION ((ULONG)0x000000ACL) + +// +// MessageId: VIDEO_DRIVER_DEBUG_REPORT_REQUEST +// +// MessageText: +// +// VIDEO_DRIVER_DEBUG_REPORT_REQUEST +// +#define VIDEO_DRIVER_DEBUG_REPORT_REQUEST ((ULONG)0x400000ADL) + +// +// MessageId: BGI_DETECTED_VIOLATION +// +// MessageText: +// +// BGI_DETECTED_VIOLATION +// +#define BGI_DETECTED_VIOLATION ((ULONG)0x000000B1L) + +// +// MessageId: VIDEO_DRIVER_INIT_FAILURE +// +// MessageText: +// +// VIDEO_DRIVER_INIT_FAILURE +// +#define VIDEO_DRIVER_INIT_FAILURE ((ULONG)0x000000B4L) + +// +// MessageId: BOOTLOG_LOADED +// +// MessageText: +// +// BOOTLOG_LOADED +// +#define BOOTLOG_LOADED ((ULONG)0x000000B5L) + +// +// MessageId: BOOTLOG_NOT_LOADED +// +// MessageText: +// +// BOOTLOG_NOT_LOADED +// +#define BOOTLOG_NOT_LOADED ((ULONG)0x000000B6L) + +// +// MessageId: BOOTLOG_ENABLED +// +// MessageText: +// +// BOOTLOG_ENABLED +// +#define BOOTLOG_ENABLED ((ULONG)0x000000B7L) + +// +// MessageId: ATTEMPTED_SWITCH_FROM_DPC +// +// MessageText: +// +// ATTEMPTED_SWITCH_FROM_DPC +// +#define ATTEMPTED_SWITCH_FROM_DPC ((ULONG)0x000000B8L) + +// +// MessageId: CHIPSET_DETECTED_ERROR +// +// MessageText: +// +// CHIPSET_DETECTED_ERROR +// +#define CHIPSET_DETECTED_ERROR ((ULONG)0x000000B9L) + +// +// MessageId: SESSION_HAS_VALID_VIEWS_ON_EXIT +// +// MessageText: +// +// SESSION_HAS_VALID_VIEWS_ON_EXIT +// +#define SESSION_HAS_VALID_VIEWS_ON_EXIT ((ULONG)0x000000BAL) + +// +// MessageId: NETWORK_BOOT_INITIALIZATION_FAILED +// +// MessageText: +// +// NETWORK_BOOT_INITIALIZATION_FAILED +// +#define NETWORK_BOOT_INITIALIZATION_FAILED ((ULONG)0x000000BBL) + +// +// MessageId: NETWORK_BOOT_DUPLICATE_ADDRESS +// +// MessageText: +// +// NETWORK_BOOT_DUPLICATE_ADDRESS +// +#define NETWORK_BOOT_DUPLICATE_ADDRESS ((ULONG)0x000000BCL) + +// +// MessageId: INVALID_HIBERNATED_STATE +// +// MessageText: +// +// INVALID_HIBERNATED_STATE +// +#define INVALID_HIBERNATED_STATE ((ULONG)0x000000BDL) + +// +// MessageId: ATTEMPTED_WRITE_TO_READONLY_MEMORY +// +// MessageText: +// +// ATTEMPTED_WRITE_TO_READONLY_MEMORY +// +#define ATTEMPTED_WRITE_TO_READONLY_MEMORY ((ULONG)0x000000BEL) + +// +// MessageId: MUTEX_ALREADY_OWNED +// +// MessageText: +// +// MUTEX_ALREADY_OWNED +// +#define MUTEX_ALREADY_OWNED ((ULONG)0x000000BFL) + +// +// MessageId: PCI_CONFIG_SPACE_ACCESS_FAILURE +// +// MessageText: +// +// PCI_CONFIG_SPACE_ACCESS_FAILURE +// +#define PCI_CONFIG_SPACE_ACCESS_FAILURE ((ULONG)0x000000C0L) + +// +// MessageId: SPECIAL_POOL_DETECTED_MEMORY_CORRUPTION +// +// MessageText: +// +// SPECIAL_POOL_DETECTED_MEMORY_CORRUPTION +// +#define SPECIAL_POOL_DETECTED_MEMORY_CORRUPTION ((ULONG)0x000000C1L) + +// +// MessageId: BAD_POOL_CALLER +// +// MessageText: +// +// BAD_POOL_CALLER +// +#define BAD_POOL_CALLER ((ULONG)0x000000C2L) + +// +// MessageId: SYSTEM_IMAGE_BAD_SIGNATURE +// +// MessageText: +// +// SYSTEM_IMAGE_BAD_SIGNATURE +// +#define SYSTEM_IMAGE_BAD_SIGNATURE ((ULONG)0x000000C3L) + +// +// MessageId: DRIVER_VERIFIER_DETECTED_VIOLATION +// +// MessageText: +// +// DRIVER_VERIFIER_DETECTED_VIOLATION +// +#define DRIVER_VERIFIER_DETECTED_VIOLATION ((ULONG)0x000000C4L) + +// +// MessageId: DRIVER_CORRUPTED_EXPOOL +// +// MessageText: +// +// DRIVER_CORRUPTED_EXPOOL +// +#define DRIVER_CORRUPTED_EXPOOL ((ULONG)0x000000C5L) + +// +// MessageId: DRIVER_CAUGHT_MODIFYING_FREED_POOL +// +// MessageText: +// +// DRIVER_CAUGHT_MODIFYING_FREED_POOL +// +#define DRIVER_CAUGHT_MODIFYING_FREED_POOL ((ULONG)0x000000C6L) + +// +// MessageId: TIMER_OR_DPC_INVALID +// +// MessageText: +// +// TIMER_OR_DPC_INVALID +// +#define TIMER_OR_DPC_INVALID ((ULONG)0x000000C7L) + +// +// MessageId: IRQL_UNEXPECTED_VALUE +// +// MessageText: +// +// IRQL_UNEXPECTED_VALUE +// +#define IRQL_UNEXPECTED_VALUE ((ULONG)0x000000C8L) + +// +// MessageId: DRIVER_VERIFIER_IOMANAGER_VIOLATION +// +// MessageText: +// +// DRIVER_VERIFIER_IOMANAGER_VIOLATION +// +#define DRIVER_VERIFIER_IOMANAGER_VIOLATION ((ULONG)0x000000C9L) + +// +// MessageId: PNP_DETECTED_FATAL_ERROR +// +// MessageText: +// +// PNP_DETECTED_FATAL_ERROR +// +#define PNP_DETECTED_FATAL_ERROR ((ULONG)0x000000CAL) + +// +// MessageId: DRIVER_LEFT_LOCKED_PAGES_IN_PROCESS +// +// MessageText: +// +// DRIVER_LEFT_LOCKED_PAGES_IN_PROCESS +// +#define DRIVER_LEFT_LOCKED_PAGES_IN_PROCESS ((ULONG)0x000000CBL) + +// +// MessageId: PAGE_FAULT_IN_FREED_SPECIAL_POOL +// +// MessageText: +// +// PAGE_FAULT_IN_FREED_SPECIAL_POOL +// +#define PAGE_FAULT_IN_FREED_SPECIAL_POOL ((ULONG)0x000000CCL) + +// +// MessageId: PAGE_FAULT_BEYOND_END_OF_ALLOCATION +// +// MessageText: +// +// PAGE_FAULT_BEYOND_END_OF_ALLOCATION +// +#define PAGE_FAULT_BEYOND_END_OF_ALLOCATION ((ULONG)0x000000CDL) + +// +// MessageId: DRIVER_UNLOADED_WITHOUT_CANCELLING_PENDING_OPERATIONS +// +// MessageText: +// +// DRIVER_UNLOADED_WITHOUT_CANCELLING_PENDING_OPERATIONS +// +#define DRIVER_UNLOADED_WITHOUT_CANCELLING_PENDING_OPERATIONS ((ULONG)0x000000CEL) + +// +// MessageId: TERMINAL_SERVER_DRIVER_MADE_INCORRECT_MEMORY_REFERENCE +// +// MessageText: +// +// TERMINAL_SERVER_DRIVER_MADE_INCORRECT_MEMORY_REFERENCE +// +#define TERMINAL_SERVER_DRIVER_MADE_INCORRECT_MEMORY_REFERENCE ((ULONG)0x000000CFL) + +// +// MessageId: DRIVER_CORRUPTED_MMPOOL +// +// MessageText: +// +// DRIVER_CORRUPTED_MMPOOL +// +#define DRIVER_CORRUPTED_MMPOOL ((ULONG)0x000000D0L) + +// +// MessageId: DRIVER_IRQL_NOT_LESS_OR_EQUAL +// +// MessageText: +// +// DRIVER_IRQL_NOT_LESS_OR_EQUAL +// +#define DRIVER_IRQL_NOT_LESS_OR_EQUAL ((ULONG)0x000000D1L) + +// +// MessageId: BUGCODE_ID_DRIVER +// +// MessageText: +// +// BUGCODE_ID_DRIVER +// +#define BUGCODE_ID_DRIVER ((ULONG)0x000000D2L) + +// +// MessageId: DRIVER_PORTION_MUST_BE_NONPAGED +// +// MessageText: +// +// DRIVER_PORTION_MUST_BE_NONPAGED +// +#define DRIVER_PORTION_MUST_BE_NONPAGED ((ULONG)0x000000D3L) + +// +// MessageId: SYSTEM_SCAN_AT_RAISED_IRQL_CAUGHT_IMPROPER_DRIVER_UNLOAD +// +// MessageText: +// +// SYSTEM_SCAN_AT_RAISED_IRQL_CAUGHT_IMPROPER_DRIVER_UNLOAD +// +#define SYSTEM_SCAN_AT_RAISED_IRQL_CAUGHT_IMPROPER_DRIVER_UNLOAD ((ULONG)0x000000D4L) + +// +// MessageId: DRIVER_PAGE_FAULT_IN_FREED_SPECIAL_POOL +// +// MessageText: +// +// DRIVER_PAGE_FAULT_IN_FREED_SPECIAL_POOL +// +#define DRIVER_PAGE_FAULT_IN_FREED_SPECIAL_POOL ((ULONG)0x000000D5L) + +// +// MessageId: DRIVER_PAGE_FAULT_BEYOND_END_OF_ALLOCATION +// +// MessageText: +// +// DRIVER_PAGE_FAULT_BEYOND_END_OF_ALLOCATION +// +#define DRIVER_PAGE_FAULT_BEYOND_END_OF_ALLOCATION ((ULONG)0x000000D6L) + +#define DRIVER_PAGE_FAULT_BEYOND_END_OF_ALLOCATION_M ((ULONG)0x100000D6L) +// +// MessageId: DRIVER_UNMAPPING_INVALID_VIEW +// +// MessageText: +// +// DRIVER_UNMAPPING_INVALID_VIEW +// +#define DRIVER_UNMAPPING_INVALID_VIEW ((ULONG)0x000000D7L) + +// +// MessageId: DRIVER_USED_EXCESSIVE_PTES +// +// MessageText: +// +// DRIVER_USED_EXCESSIVE_PTES +// +#define DRIVER_USED_EXCESSIVE_PTES ((ULONG)0x000000D8L) + +// +// MessageId: LOCKED_PAGES_TRACKER_CORRUPTION +// +// MessageText: +// +// LOCKED_PAGES_TRACKER_CORRUPTION +// +#define LOCKED_PAGES_TRACKER_CORRUPTION ((ULONG)0x000000D9L) + +// +// MessageId: SYSTEM_PTE_MISUSE +// +// MessageText: +// +// SYSTEM_PTE_MISUSE +// +#define SYSTEM_PTE_MISUSE ((ULONG)0x000000DAL) + +// +// MessageId: DRIVER_CORRUPTED_SYSPTES +// +// MessageText: +// +// DRIVER_CORRUPTED_SYSPTES +// +#define DRIVER_CORRUPTED_SYSPTES ((ULONG)0x000000DBL) + +// +// MessageId: DRIVER_INVALID_STACK_ACCESS +// +// MessageText: +// +// DRIVER_INVALID_STACK_ACCESS +// +#define DRIVER_INVALID_STACK_ACCESS ((ULONG)0x000000DCL) + +// +// MessageId: POOL_CORRUPTION_IN_FILE_AREA +// +// MessageText: +// +// POOL_CORRUPTION_IN_FILE_AREA +// +#define POOL_CORRUPTION_IN_FILE_AREA ((ULONG)0x000000DEL) + +// +// MessageId: IMPERSONATING_WORKER_THREAD +// +// MessageText: +// +// IMPERSONATING_WORKER_THREAD +// +#define IMPERSONATING_WORKER_THREAD ((ULONG)0x000000DFL) + +// +// MessageId: ACPI_BIOS_FATAL_ERROR +// +// MessageText: +// +// ACPI_BIOS_FATAL_ERROR +// +#define ACPI_BIOS_FATAL_ERROR ((ULONG)0x000000E0L) + +// +// MessageId: WORKER_THREAD_RETURNED_AT_BAD_IRQL +// +// MessageText: +// +// WORKER_THREAD_RETURNED_AT_BAD_IRQL +// +#define WORKER_THREAD_RETURNED_AT_BAD_IRQL ((ULONG)0x000000E1L) + +// +// MessageId: MANUALLY_INITIATED_CRASH +// +// MessageText: +// +// MANUALLY_INITIATED_CRASH +// +#define MANUALLY_INITIATED_CRASH ((ULONG)0x000000E2L) + +// +// MessageId: RESOURCE_NOT_OWNED +// +// MessageText: +// +// RESOURCE_NOT_OWNED +// +#define RESOURCE_NOT_OWNED ((ULONG)0x000000E3L) + +// +// MessageId: WORKER_INVALID +// +// MessageText: +// +// WORKER_INVALID +// +#define WORKER_INVALID ((ULONG)0x000000E4L) + +// +// MessageId: POWER_FAILURE_SIMULATE +// +// MessageText: +// +// POWER_FAILURE_SIMULATE +// +#define POWER_FAILURE_SIMULATE ((ULONG)0x000000E5L) + +// +// MessageId: DRIVER_VERIFIER_DMA_VIOLATION +// +// MessageText: +// +// DRIVER_VERIFIER_DMA_VIOLATION +// +#define DRIVER_VERIFIER_DMA_VIOLATION ((ULONG)0x000000E6L) + +// +// MessageId: INVALID_FLOATING_POINT_STATE +// +// MessageText: +// +// INVALID_FLOATING_POINT_STATE +// +#define INVALID_FLOATING_POINT_STATE ((ULONG)0x000000E7L) + +// +// MessageId: INVALID_CANCEL_OF_FILE_OPEN +// +// MessageText: +// +// INVALID_CANCEL_OF_FILE_OPEN +// +#define INVALID_CANCEL_OF_FILE_OPEN ((ULONG)0x000000E8L) + +// +// MessageId: ACTIVE_EX_WORKER_THREAD_TERMINATION +// +// MessageText: +// +// ACTIVE_EX_WORKER_THREAD_TERMINATION +// +#define ACTIVE_EX_WORKER_THREAD_TERMINATION ((ULONG)0x000000E9L) + +// +// MessageId: SAVER_UNSPECIFIED +// +// MessageText: +// +// SAVER_UNSPECIFIED +// +#define SAVER_UNSPECIFIED ((ULONG)0x0000F000L) + +// +// MessageId: SAVER_BLANKSCREEN +// +// MessageText: +// +// SAVER_BLANKSCREEN +// +#define SAVER_BLANKSCREEN ((ULONG)0x0000F002L) + +// +// MessageId: SAVER_INPUT +// +// MessageText: +// +// SAVER_INPUT +// +#define SAVER_INPUT ((ULONG)0x0000F003L) + +// +// MessageId: SAVER_WATCHDOG +// +// MessageText: +// +// SAVER_WATCHDOG +// +#define SAVER_WATCHDOG ((ULONG)0x0000F004L) + +// +// MessageId: SAVER_STARTNOTVISIBLE +// +// MessageText: +// +// SAVER_STARTNOTVISIBLE +// +#define SAVER_STARTNOTVISIBLE ((ULONG)0x0000F005L) + +// +// MessageId: SAVER_NAVIGATIONMODEL +// +// MessageText: +// +// SAVER_NAVIGATIONMODEL +// +#define SAVER_NAVIGATIONMODEL ((ULONG)0x0000F006L) + +// +// MessageId: SAVER_OUTOFMEMORY +// +// MessageText: +// +// SAVER_OUTOFMEMORY +// +#define SAVER_OUTOFMEMORY ((ULONG)0x0000F007L) + +// +// MessageId: SAVER_GRAPHICS +// +// MessageText: +// +// SAVER_GRAPHICS +// +#define SAVER_GRAPHICS ((ULONG)0x0000F008L) + +// +// MessageId: SAVER_NAVSERVERTIMEOUT +// +// MessageText: +// +// SAVER_NAVSERVERTIMEOUT +// +#define SAVER_NAVSERVERTIMEOUT ((ULONG)0x0000F009L) + +// +// MessageId: SAVER_CHROMEPROCESSCRASH +// +// MessageText: +// +// SAVER_CHROMEPROCESSCRASH +// +#define SAVER_CHROMEPROCESSCRASH ((ULONG)0x0000F00AL) + +// +// MessageId: SAVER_NOTIFICATIONDISMISSAL +// +// MessageText: +// +// SAVER_NOTIFICATIONDISMISSAL +// +#define SAVER_NOTIFICATIONDISMISSAL ((ULONG)0x0000F00BL) + +// +// MessageId: SAVER_SPEECHDISMISSAL +// +// MessageText: +// +// SAVER_SPEECHDISMISSAL +// +#define SAVER_SPEECHDISMISSAL ((ULONG)0x0000F00CL) + +// +// MessageId: SAVER_CALLDISMISSAL +// +// MessageText: +// +// SAVER_CALLDISMISSAL +// +#define SAVER_CALLDISMISSAL ((ULONG)0x0000F00DL) + +// +// MessageId: SAVER_APPBARDISMISSAL +// +// MessageText: +// +// SAVER_APPBARDISMISSAL +// +#define SAVER_APPBARDISMISSAL ((ULONG)0x0000F00EL) + +// +// MessageId: SAVER_RILADAPTATIONCRASH +// +// MessageText: +// +// SAVER_RILADAPTATIONCRASH +// +#define SAVER_RILADAPTATIONCRASH ((ULONG)0x0000F00FL) + +// +// MessageId: SAVER_APPLISTUNREACHABLE +// +// MessageText: +// +// SAVER_APPLISTUNREACHABLE +// +#define SAVER_APPLISTUNREACHABLE ((ULONG)0x0000F010L) + +// +// MessageId: SAVER_REPORTNOTIFICATIONFAILURE +// +// MessageText: +// +// SAVER_REPORTNOTIFICATIONFAILURE +// +#define SAVER_REPORTNOTIFICATIONFAILURE ((ULONG)0x0000F011L) + +// +// MessageId: SAVER_UNEXPECTEDSHUTDOWN +// +// MessageText: +// +// SAVER_UNEXPECTEDSHUTDOWN +// +#define SAVER_UNEXPECTEDSHUTDOWN ((ULONG)0x0000F012L) + +// +// MessageId: SAVER_RPCFAILURE +// +// MessageText: +// +// SAVER_RPCFAILURE +// +#define SAVER_RPCFAILURE ((ULONG)0x0000F013L) + +// +// MessageId: SAVER_AUXILIARYFULLDUMP +// +// MessageText: +// +// SAVER_AUXILIARYFULLDUMP +// +#define SAVER_AUXILIARYFULLDUMP ((ULONG)0x0000F014L) + +// +// MessageId: SAVER_ACCOUNTPROVSVCINITFAILURE +// +// MessageText: +// +// SAVER_ACCOUNTPROVSVCINITFAILURE +// +#define SAVER_ACCOUNTPROVSVCINITFAILURE ((ULONG)0x0000F015L) + +// +// MessageId: SAVER_MTBFCOMMANDTIMEOUT +// +// MessageText: +// +// SAVER_MTBFCOMMANDTIMEOUT +// +#define SAVER_MTBFCOMMANDTIMEOUT ((ULONG)0x00000315L) + +// +// MessageId: SAVER_MTBFCOMMANDHANG +// +// MessageText: +// +// SAVER_MTBFCOMMANDHANG +// +#define SAVER_MTBFCOMMANDHANG ((ULONG)0x0000F101L) + +// +// MessageId: SAVER_MTBFPASSBUGCHECK +// +// MessageText: +// +// SAVER_MTBFPASSBUGCHECK +// +#define SAVER_MTBFPASSBUGCHECK ((ULONG)0x0000F102L) + +// +// MessageId: SAVER_MTBFIOERROR +// +// MessageText: +// +// SAVER_MTBFIOERROR +// +#define SAVER_MTBFIOERROR ((ULONG)0x0000F103L) + +// +// MessageId: SAVER_RENDERTHREADHANG +// +// MessageText: +// +// SAVER_RENDERTHREADHANG +// +#define SAVER_RENDERTHREADHANG ((ULONG)0x0000F200L) + +// +// MessageId: SAVER_RENDERMOBILEUIOOM +// +// MessageText: +// +// SAVER_RENDERMOBILEUIOOM +// +#define SAVER_RENDERMOBILEUIOOM ((ULONG)0x0000F201L) + +// +// MessageId: SAVER_DEVICEUPDATEUNSPECIFIED +// +// MessageText: +// +// SAVER_DEVICEUPDATEUNSPECIFIED +// +#define SAVER_DEVICEUPDATEUNSPECIFIED ((ULONG)0x0000F300L) + +// +// MessageId: SAVER_AUDIODRIVERHANG +// +// MessageText: +// +// SAVER_AUDIODRIVERHANG +// +#define SAVER_AUDIODRIVERHANG ((ULONG)0x0000F400L) + +// +// MessageId: SAVER_BATTERYPULLOUT +// +// MessageText: +// +// SAVER_BATTERYPULLOUT +// +#define SAVER_BATTERYPULLOUT ((ULONG)0x0000F500L) + +// +// MessageId: SAVER_MEDIACORETESTHANG +// +// MessageText: +// +// SAVER_MEDIACORETESTHANG +// +#define SAVER_MEDIACORETESTHANG ((ULONG)0x0000F600L) + +// +// MessageId: SAVER_RESOURCEMANAGEMENT +// +// MessageText: +// +// SAVER_RESOURCEMANAGEMENT +// +#define SAVER_RESOURCEMANAGEMENT ((ULONG)0x0000F700L) + +// +// MessageId: SAVER_CAPTURESERVICE +// +// MessageText: +// +// SAVER_CAPTURESERVICE +// +#define SAVER_CAPTURESERVICE ((ULONG)0x0000F800L) + +// +// MessageId: SAVER_WAITFORSHELLREADY +// +// MessageText: +// +// SAVER_WAITFORSHELLREADY +// +#define SAVER_WAITFORSHELLREADY ((ULONG)0x0000F900L) + +// +// MessageId: SAVER_NONRESPONSIVEPROCESS +// +// MessageText: +// +// SAVER_NONRESPONSIVEPROCESS +// +#define SAVER_NONRESPONSIVEPROCESS ((ULONG)0x00000194L) + +// +// MessageId: SAVER_SICKAPPLICATION +// +// MessageText: +// +// SAVER_SICKAPPLICATION +// +#define SAVER_SICKAPPLICATION ((ULONG)0x00008866L) + +// +// MessageId: THREAD_STUCK_IN_DEVICE_DRIVER +// +// MessageText: +// +// THREAD_STUCK_IN_DEVICE_DRIVER +// +#define THREAD_STUCK_IN_DEVICE_DRIVER ((ULONG)0x000000EAL) + +#define THREAD_STUCK_IN_DEVICE_DRIVER_M ((ULONG)0x100000EAL) +// +// MessageId: DIRTY_MAPPED_PAGES_CONGESTION +// +// MessageText: +// +// DIRTY_MAPPED_PAGES_CONGESTION +// +#define DIRTY_MAPPED_PAGES_CONGESTION ((ULONG)0x000000EBL) + +// +// MessageId: SESSION_HAS_VALID_SPECIAL_POOL_ON_EXIT +// +// MessageText: +// +// SESSION_HAS_VALID_SPECIAL_POOL_ON_EXIT +// +#define SESSION_HAS_VALID_SPECIAL_POOL_ON_EXIT ((ULONG)0x000000ECL) + +// +// MessageId: UNMOUNTABLE_BOOT_VOLUME +// +// MessageText: +// +// UNMOUNTABLE_BOOT_VOLUME +// +#define UNMOUNTABLE_BOOT_VOLUME ((ULONG)0x000000EDL) + +// +// MessageId: CRITICAL_PROCESS_DIED +// +// MessageText: +// +// CRITICAL_PROCESS_DIED +// +#define CRITICAL_PROCESS_DIED ((ULONG)0x000000EFL) + +// +// MessageId: STORAGE_MINIPORT_ERROR +// +// MessageText: +// +// STORAGE_MINIPORT_ERROR +// +#define STORAGE_MINIPORT_ERROR ((ULONG)0x000000F0L) + +// +// MessageId: SCSI_VERIFIER_DETECTED_VIOLATION +// +// MessageText: +// +// SCSI_VERIFIER_DETECTED_VIOLATION +// +#define SCSI_VERIFIER_DETECTED_VIOLATION ((ULONG)0x000000F1L) + +// +// MessageId: HARDWARE_INTERRUPT_STORM +// +// MessageText: +// +// HARDWARE_INTERRUPT_STORM +// +#define HARDWARE_INTERRUPT_STORM ((ULONG)0x000000F2L) + +// +// MessageId: DISORDERLY_SHUTDOWN +// +// MessageText: +// +// DISORDERLY_SHUTDOWN +// +#define DISORDERLY_SHUTDOWN ((ULONG)0x000000F3L) + +// +// MessageId: CRITICAL_OBJECT_TERMINATION +// +// MessageText: +// +// CRITICAL_OBJECT_TERMINATION +// +#define CRITICAL_OBJECT_TERMINATION ((ULONG)0x000000F4L) + +// +// MessageId: FLTMGR_FILE_SYSTEM +// +// MessageText: +// +// FLTMGR_FILE_SYSTEM +// +#define FLTMGR_FILE_SYSTEM ((ULONG)0x000000F5L) + +// +// MessageId: PCI_VERIFIER_DETECTED_VIOLATION +// +// MessageText: +// +// PCI_VERIFIER_DETECTED_VIOLATION +// +#define PCI_VERIFIER_DETECTED_VIOLATION ((ULONG)0x000000F6L) + +// +// MessageId: DRIVER_OVERRAN_STACK_BUFFER +// +// MessageText: +// +// DRIVER_OVERRAN_STACK_BUFFER +// +#define DRIVER_OVERRAN_STACK_BUFFER ((ULONG)0x000000F7L) + +// +// MessageId: RAMDISK_BOOT_INITIALIZATION_FAILED +// +// MessageText: +// +// RAMDISK_BOOT_INITIALIZATION_FAILED +// +#define RAMDISK_BOOT_INITIALIZATION_FAILED ((ULONG)0x000000F8L) + +// +// MessageId: DRIVER_RETURNED_STATUS_REPARSE_FOR_VOLUME_OPEN +// +// MessageText: +// +// DRIVER_RETURNED_STATUS_REPARSE_FOR_VOLUME_OPEN +// +#define DRIVER_RETURNED_STATUS_REPARSE_FOR_VOLUME_OPEN ((ULONG)0x000000F9L) + +// +// MessageId: HTTP_DRIVER_CORRUPTED +// +// MessageText: +// +// HTTP_DRIVER_CORRUPTED +// +#define HTTP_DRIVER_CORRUPTED ((ULONG)0x000000FAL) + +// +// MessageId: RECURSIVE_MACHINE_CHECK +// +// MessageText: +// +// RECURSIVE_MACHINE_CHECK +// +#define RECURSIVE_MACHINE_CHECK ((ULONG)0x000000FBL) + +// +// MessageId: ATTEMPTED_EXECUTE_OF_NOEXECUTE_MEMORY +// +// MessageText: +// +// ATTEMPTED_EXECUTE_OF_NOEXECUTE_MEMORY +// +#define ATTEMPTED_EXECUTE_OF_NOEXECUTE_MEMORY ((ULONG)0x000000FCL) + +// +// MessageId: DIRTY_NOWRITE_PAGES_CONGESTION +// +// MessageText: +// +// DIRTY_NOWRITE_PAGES_CONGESTION +// +#define DIRTY_NOWRITE_PAGES_CONGESTION ((ULONG)0x000000FDL) + +// +// MessageId: BUGCODE_USB_DRIVER +// +// MessageText: +// +// BUGCODE_USB_DRIVER +// +#define BUGCODE_USB_DRIVER ((ULONG)0x000000FEL) + +// +// MessageId: BC_BLUETOOTH_VERIFIER_FAULT +// +// MessageText: +// +// BC_BLUETOOTH_VERIFIER_FAULT +// +#define BC_BLUETOOTH_VERIFIER_FAULT ((ULONG)0x00000BFEL) + +// +// MessageId: BC_BTHMINI_VERIFIER_FAULT +// +// MessageText: +// +// BC_BTHMINI_VERIFIER_FAULT +// +#define BC_BTHMINI_VERIFIER_FAULT ((ULONG)0x00000BFFL) + +// +// MessageId: RESERVE_QUEUE_OVERFLOW +// +// MessageText: +// +// RESERVE_QUEUE_OVERFLOW +// +#define RESERVE_QUEUE_OVERFLOW ((ULONG)0x000000FFL) + +// +// MessageId: LOADER_BLOCK_MISMATCH +// +// MessageText: +// +// LOADER_BLOCK_MISMATCH +// +#define LOADER_BLOCK_MISMATCH ((ULONG)0x00000100L) + +// +// MessageId: CLOCK_WATCHDOG_TIMEOUT +// +// MessageText: +// +// CLOCK_WATCHDOG_TIMEOUT +// +#define CLOCK_WATCHDOG_TIMEOUT ((ULONG)0x00000101L) + +// +// MessageId: DPC_WATCHDOG_TIMEOUT +// +// MessageText: +// +// DPC_WATCHDOG_TIMEOUT +// +#define DPC_WATCHDOG_TIMEOUT ((ULONG)0x00000102L) + +// +// MessageId: MUP_FILE_SYSTEM +// +// MessageText: +// +// MUP_FILE_SYSTEM +// +#define MUP_FILE_SYSTEM ((ULONG)0x00000103L) + +// +// MessageId: AGP_INVALID_ACCESS +// +// MessageText: +// +// AGP_INVALID_ACCESS +// +#define AGP_INVALID_ACCESS ((ULONG)0x00000104L) + +// +// MessageId: AGP_GART_CORRUPTION +// +// MessageText: +// +// AGP_GART_CORRUPTION +// +#define AGP_GART_CORRUPTION ((ULONG)0x00000105L) + +// +// MessageId: AGP_ILLEGALLY_REPROGRAMMED +// +// MessageText: +// +// AGP_ILLEGALLY_REPROGRAMMED +// +#define AGP_ILLEGALLY_REPROGRAMMED ((ULONG)0x00000106L) + +// +// MessageId: KERNEL_EXPAND_STACK_ACTIVE +// +// MessageText: +// +// KERNEL_EXPAND_STACK_ACTIVE +// +#define KERNEL_EXPAND_STACK_ACTIVE ((ULONG)0x00000107L) + +// +// MessageId: THIRD_PARTY_FILE_SYSTEM_FAILURE +// +// MessageText: +// +// THIRD_PARTY_FILE_SYSTEM_FAILURE +// +#define THIRD_PARTY_FILE_SYSTEM_FAILURE ((ULONG)0x00000108L) + +// +// MessageId: CRITICAL_STRUCTURE_CORRUPTION +// +// MessageText: +// +// CRITICAL_STRUCTURE_CORRUPTION +// +#define CRITICAL_STRUCTURE_CORRUPTION ((ULONG)0x00000109L) + +// +// MessageId: APP_TAGGING_INITIALIZATION_FAILED +// +// MessageText: +// +// APP_TAGGING_INITIALIZATION_FAILED +// +#define APP_TAGGING_INITIALIZATION_FAILED ((ULONG)0x0000010AL) + +// +// MessageId: DFSC_FILE_SYSTEM +// +// MessageText: +// +// DFSC_FILE_SYSTEM +// +#define DFSC_FILE_SYSTEM ((ULONG)0x0000010BL) + +// +// MessageId: FSRTL_EXTRA_CREATE_PARAMETER_VIOLATION +// +// MessageText: +// +// FSRTL_EXTRA_CREATE_PARAMETER_VIOLATION +// +#define FSRTL_EXTRA_CREATE_PARAMETER_VIOLATION ((ULONG)0x0000010CL) + +// +// MessageId: WDF_VIOLATION +// +// MessageText: +// +// WDF_VIOLATION +// +#define WDF_VIOLATION ((ULONG)0x0000010DL) + +// +// MessageId: VIDEO_MEMORY_MANAGEMENT_INTERNAL +// +// MessageText: +// +// VIDEO_MEMORY_MANAGEMENT_INTERNAL +// +#define VIDEO_MEMORY_MANAGEMENT_INTERNAL ((ULONG)0x0000010EL) + +// +// MessageId: DRIVER_INVALID_CRUNTIME_PARAMETER +// +// MessageText: +// +// DRIVER_INVALID_CRUNTIME_PARAMETER +// +#define DRIVER_INVALID_CRUNTIME_PARAMETER ((ULONG)0x00000110L) + +// +// MessageId: RECURSIVE_NMI +// +// MessageText: +// +// RECURSIVE_NMI +// +#define RECURSIVE_NMI ((ULONG)0x00000111L) + +// +// MessageId: MSRPC_STATE_VIOLATION +// +// MessageText: +// +// MSRPC_STATE_VIOLATION +// +#define MSRPC_STATE_VIOLATION ((ULONG)0x00000112L) + +// +// MessageId: VIDEO_DXGKRNL_FATAL_ERROR +// +// MessageText: +// +// VIDEO_DXGKRNL_FATAL_ERROR +// +#define VIDEO_DXGKRNL_FATAL_ERROR ((ULONG)0x00000113L) + +// +// MessageId: VIDEO_SHADOW_DRIVER_FATAL_ERROR +// +// MessageText: +// +// VIDEO_SHADOW_DRIVER_FATAL_ERROR +// +#define VIDEO_SHADOW_DRIVER_FATAL_ERROR ((ULONG)0x00000114L) + +// +// MessageId: AGP_INTERNAL +// +// MessageText: +// +// AGP_INTERNAL +// +#define AGP_INTERNAL ((ULONG)0x00000115L) + +// +// MessageId: VIDEO_TDR_FAILURE +// +// MessageText: +// +// VIDEO_TDR_FAILURE +// +#define VIDEO_TDR_FAILURE ((ULONG)0x00000116L) + +// +// MessageId: VIDEO_TDR_TIMEOUT_DETECTED +// +// MessageText: +// +// VIDEO_TDR_TIMEOUT_DETECTED +// +#define VIDEO_TDR_TIMEOUT_DETECTED ((ULONG)0x00000117L) + +// +// MessageId: NTHV_GUEST_ERROR +// +// MessageText: +// +// NTHV_GUEST_ERROR +// +#define NTHV_GUEST_ERROR ((ULONG)0x00000118L) + +// +// MessageId: VIDEO_SCHEDULER_INTERNAL_ERROR +// +// MessageText: +// +// VIDEO_SCHEDULER_INTERNAL_ERROR +// +#define VIDEO_SCHEDULER_INTERNAL_ERROR ((ULONG)0x00000119L) + +// +// MessageId: EM_INITIALIZATION_ERROR +// +// MessageText: +// +// EM_INITIALIZATION_ERROR +// +#define EM_INITIALIZATION_ERROR ((ULONG)0x0000011AL) + +// +// MessageId: DRIVER_RETURNED_HOLDING_CANCEL_LOCK +// +// MessageText: +// +// DRIVER_RETURNED_HOLDING_CANCEL_LOCK +// +#define DRIVER_RETURNED_HOLDING_CANCEL_LOCK ((ULONG)0x0000011BL) + +// +// MessageId: ATTEMPTED_WRITE_TO_CM_PROTECTED_STORAGE +// +// MessageText: +// +// ATTEMPTED_WRITE_TO_CM_PROTECTED_STORAGE +// +#define ATTEMPTED_WRITE_TO_CM_PROTECTED_STORAGE ((ULONG)0x0000011CL) + +// +// MessageId: EVENT_TRACING_FATAL_ERROR +// +// MessageText: +// +// EVENT_TRACING_FATAL_ERROR +// +#define EVENT_TRACING_FATAL_ERROR ((ULONG)0x0000011DL) + +// +// MessageId: TOO_MANY_RECURSIVE_FAULTS +// +// MessageText: +// +// TOO_MANY_RECURSIVE_FAULTS +// +#define TOO_MANY_RECURSIVE_FAULTS ((ULONG)0x0000011EL) + +// +// MessageId: INVALID_DRIVER_HANDLE +// +// MessageText: +// +// INVALID_DRIVER_HANDLE +// +#define INVALID_DRIVER_HANDLE ((ULONG)0x0000011FL) + +// +// MessageId: BITLOCKER_FATAL_ERROR +// +// MessageText: +// +// BITLOCKER_FATAL_ERROR +// +#define BITLOCKER_FATAL_ERROR ((ULONG)0x00000120L) + +// +// MessageId: DRIVER_VIOLATION +// +// MessageText: +// +// DRIVER_VIOLATION +// +#define DRIVER_VIOLATION ((ULONG)0x00000121L) + +// +// MessageId: WHEA_INTERNAL_ERROR +// +// MessageText: +// +// WHEA_INTERNAL_ERROR +// +#define WHEA_INTERNAL_ERROR ((ULONG)0x00000122L) + +// +// MessageId: CRYPTO_SELF_TEST_FAILURE +// +// MessageText: +// +// CRYPTO_SELF_TEST_FAILURE +// +#define CRYPTO_SELF_TEST_FAILURE ((ULONG)0x00000123L) + +// +// MessageId: WHEA_UNCORRECTABLE_ERROR +// +// MessageText: +// +// WHEA_UNCORRECTABLE_ERROR +// +#define WHEA_UNCORRECTABLE_ERROR ((ULONG)0x00000124L) + +// +// MessageId: NMR_INVALID_STATE +// +// MessageText: +// +// NMR_INVALID_STATE +// +#define NMR_INVALID_STATE ((ULONG)0x00000125L) + +// +// MessageId: NETIO_INVALID_POOL_CALLER +// +// MessageText: +// +// NETIO_INVALID_POOL_CALLER +// +#define NETIO_INVALID_POOL_CALLER ((ULONG)0x00000126L) + +// +// MessageId: PAGE_NOT_ZERO +// +// MessageText: +// +// PAGE_NOT_ZERO +// +#define PAGE_NOT_ZERO ((ULONG)0x00000127L) + +// +// MessageId: WORKER_THREAD_RETURNED_WITH_BAD_IO_PRIORITY +// +// MessageText: +// +// WORKER_THREAD_RETURNED_WITH_BAD_IO_PRIORITY +// +#define WORKER_THREAD_RETURNED_WITH_BAD_IO_PRIORITY ((ULONG)0x00000128L) + +// +// MessageId: WORKER_THREAD_RETURNED_WITH_BAD_PAGING_IO_PRIORITY +// +// MessageText: +// +// WORKER_THREAD_RETURNED_WITH_BAD_PAGING_IO_PRIORITY +// +#define WORKER_THREAD_RETURNED_WITH_BAD_PAGING_IO_PRIORITY ((ULONG)0x00000129L) + +// +// MessageId: MUI_NO_VALID_SYSTEM_LANGUAGE +// +// MessageText: +// +// MUI_NO_VALID_SYSTEM_LANGUAGE +// +#define MUI_NO_VALID_SYSTEM_LANGUAGE ((ULONG)0x0000012AL) + +// +// MessageId: FAULTY_HARDWARE_CORRUPTED_PAGE +// +// MessageText: +// +// FAULTY_HARDWARE_CORRUPTED_PAGE +// +#define FAULTY_HARDWARE_CORRUPTED_PAGE ((ULONG)0x0000012BL) + +// +// MessageId: EXFAT_FILE_SYSTEM +// +// MessageText: +// +// EXFAT_FILE_SYSTEM +// +#define EXFAT_FILE_SYSTEM ((ULONG)0x0000012CL) + +// +// MessageId: VOLSNAP_OVERLAPPED_TABLE_ACCESS +// +// MessageText: +// +// VOLSNAP_OVERLAPPED_TABLE_ACCESS +// +#define VOLSNAP_OVERLAPPED_TABLE_ACCESS ((ULONG)0x0000012DL) + +// +// MessageId: INVALID_MDL_RANGE +// +// MessageText: +// +// INVALID_MDL_RANGE +// +#define INVALID_MDL_RANGE ((ULONG)0x0000012EL) + +// +// MessageId: VHD_BOOT_INITIALIZATION_FAILED +// +// MessageText: +// +// VHD_BOOT_INITIALIZATION_FAILED +// +#define VHD_BOOT_INITIALIZATION_FAILED ((ULONG)0x0000012FL) + +// +// MessageId: DYNAMIC_ADD_PROCESSOR_MISMATCH +// +// MessageText: +// +// DYNAMIC_ADD_PROCESSOR_MISMATCH +// +#define DYNAMIC_ADD_PROCESSOR_MISMATCH ((ULONG)0x00000130L) + +// +// MessageId: INVALID_EXTENDED_PROCESSOR_STATE +// +// MessageText: +// +// INVALID_EXTENDED_PROCESSOR_STATE +// +#define INVALID_EXTENDED_PROCESSOR_STATE ((ULONG)0x00000131L) + +// +// MessageId: RESOURCE_OWNER_POINTER_INVALID +// +// MessageText: +// +// RESOURCE_OWNER_POINTER_INVALID +// +#define RESOURCE_OWNER_POINTER_INVALID ((ULONG)0x00000132L) + +// +// MessageId: DPC_WATCHDOG_VIOLATION +// +// MessageText: +// +// DPC_WATCHDOG_VIOLATION +// +#define DPC_WATCHDOG_VIOLATION ((ULONG)0x00000133L) + +// +// MessageId: DRIVE_EXTENDER +// +// MessageText: +// +// DRIVE_EXTENDER +// +#define DRIVE_EXTENDER ((ULONG)0x00000134L) + +// +// MessageId: REGISTRY_FILTER_DRIVER_EXCEPTION +// +// MessageText: +// +// REGISTRY_FILTER_DRIVER_EXCEPTION +// +#define REGISTRY_FILTER_DRIVER_EXCEPTION ((ULONG)0x00000135L) + +// +// MessageId: VHD_BOOT_HOST_VOLUME_NOT_ENOUGH_SPACE +// +// MessageText: +// +// VHD_BOOT_HOST_VOLUME_NOT_ENOUGH_SPACE +// +#define VHD_BOOT_HOST_VOLUME_NOT_ENOUGH_SPACE ((ULONG)0x00000136L) + +// +// MessageId: WIN32K_HANDLE_MANAGER +// +// MessageText: +// +// WIN32K_HANDLE_MANAGER +// +#define WIN32K_HANDLE_MANAGER ((ULONG)0x00000137L) + +// +// MessageId: GPIO_CONTROLLER_DRIVER_ERROR +// +// MessageText: +// +// GPIO_CONTROLLER_DRIVER_ERROR +// +#define GPIO_CONTROLLER_DRIVER_ERROR ((ULONG)0x00000138L) + +// +// MessageId: KERNEL_SECURITY_CHECK_FAILURE +// +// MessageText: +// +// KERNEL_SECURITY_CHECK_FAILURE +// +#define KERNEL_SECURITY_CHECK_FAILURE ((ULONG)0x00000139L) + +// +// MessageId: KERNEL_MODE_HEAP_CORRUPTION +// +// MessageText: +// +// KERNEL_MODE_HEAP_CORRUPTION +// +#define KERNEL_MODE_HEAP_CORRUPTION ((ULONG)0x0000013AL) + +// +// MessageId: PASSIVE_INTERRUPT_ERROR +// +// MessageText: +// +// PASSIVE_INTERRUPT_ERROR +// +#define PASSIVE_INTERRUPT_ERROR ((ULONG)0x0000013BL) + +// +// MessageId: INVALID_IO_BOOST_STATE +// +// MessageText: +// +// INVALID_IO_BOOST_STATE +// +#define INVALID_IO_BOOST_STATE ((ULONG)0x0000013CL) + +// +// MessageId: CRITICAL_INITIALIZATION_FAILURE +// +// MessageText: +// +// CRITICAL_INITIALIZATION_FAILURE +// +#define CRITICAL_INITIALIZATION_FAILURE ((ULONG)0x0000013DL) + +// +// MessageId: ERRATA_WORKAROUND_UNSUCCESSFUL +// +// MessageText: +// +// ERRATA_WORKAROUND_UNSUCCESSFUL +// +#define ERRATA_WORKAROUND_UNSUCCESSFUL ((ULONG)0x0000013EL) + +// +// MessageId: REGISTRY_CALLBACK_DRIVER_EXCEPTION +// +// MessageText: +// +// REGISTRY_CALLBACK_DRIVER_EXCEPTION +// +#define REGISTRY_CALLBACK_DRIVER_EXCEPTION ((ULONG)0x0000013FL) + +// +// MessageId: STORAGE_DEVICE_ABNORMALITY_DETECTED +// +// MessageText: +// +// STORAGE_DEVICE_ABNORMALITY_DETECTED +// +#define STORAGE_DEVICE_ABNORMALITY_DETECTED ((ULONG)0x00000140L) + +// +// MessageId: VIDEO_ENGINE_TIMEOUT_DETECTED +// +// MessageText: +// +// VIDEO_ENGINE_TIMEOUT_DETECTED +// +#define VIDEO_ENGINE_TIMEOUT_DETECTED ((ULONG)0x00000141L) + +// +// MessageId: VIDEO_TDR_APPLICATION_BLOCKED +// +// MessageText: +// +// VIDEO_TDR_APPLICATION_BLOCKED +// +#define VIDEO_TDR_APPLICATION_BLOCKED ((ULONG)0x00000142L) + +// +// MessageId: PROCESSOR_DRIVER_INTERNAL +// +// MessageText: +// +// PROCESSOR_DRIVER_INTERNAL +// +#define PROCESSOR_DRIVER_INTERNAL ((ULONG)0x00000143L) + +// +// MessageId: BUGCODE_USB3_DRIVER +// +// MessageText: +// +// BUGCODE_USB3_DRIVER +// +#define BUGCODE_USB3_DRIVER ((ULONG)0x00000144L) + +// +// MessageId: SECURE_BOOT_VIOLATION +// +// MessageText: +// +// SECURE_BOOT_VIOLATION +// +#define SECURE_BOOT_VIOLATION ((ULONG)0x00000145L) + +// +// MessageId: NDIS_NET_BUFFER_LIST_INFO_ILLEGALLY_TRANSFERRED +// +// MessageText: +// +// NDIS_NET_BUFFER_LIST_INFO_ILLEGALLY_TRANSFERRED +// +#define NDIS_NET_BUFFER_LIST_INFO_ILLEGALLY_TRANSFERRED ((ULONG)0x00000146L) + +// +// MessageId: ABNORMAL_RESET_DETECTED +// +// MessageText: +// +// ABNORMAL_RESET_DETECTED +// +#define ABNORMAL_RESET_DETECTED ((ULONG)0x00000147L) + +// +// MessageId: IO_OBJECT_INVALID +// +// MessageText: +// +// IO_OBJECT_INVALID +// +#define IO_OBJECT_INVALID ((ULONG)0x00000148L) + +// +// MessageId: REFS_FILE_SYSTEM +// +// MessageText: +// +// REFS_FILE_SYSTEM +// +#define REFS_FILE_SYSTEM ((ULONG)0x00000149L) + +// +// MessageId: KERNEL_WMI_INTERNAL +// +// MessageText: +// +// KERNEL_WMI_INTERNAL +// +#define KERNEL_WMI_INTERNAL ((ULONG)0x0000014AL) + +// +// MessageId: SOC_SUBSYSTEM_FAILURE +// +// MessageText: +// +// SOC_SUBSYSTEM_FAILURE +// +#define SOC_SUBSYSTEM_FAILURE ((ULONG)0x0000014BL) + +// +// MessageId: FATAL_ABNORMAL_RESET_ERROR +// +// MessageText: +// +// FATAL_ABNORMAL_RESET_ERROR +// +#define FATAL_ABNORMAL_RESET_ERROR ((ULONG)0x0000014CL) + +// +// MessageId: EXCEPTION_SCOPE_INVALID +// +// MessageText: +// +// EXCEPTION_SCOPE_INVALID +// +#define EXCEPTION_SCOPE_INVALID ((ULONG)0x0000014DL) + +// +// MessageId: SOC_CRITICAL_DEVICE_REMOVED +// +// MessageText: +// +// SOC_CRITICAL_DEVICE_REMOVED +// +#define SOC_CRITICAL_DEVICE_REMOVED ((ULONG)0x0000014EL) + +// +// MessageId: PDC_WATCHDOG_TIMEOUT +// +// MessageText: +// +// PDC_WATCHDOG_TIMEOUT +// +#define PDC_WATCHDOG_TIMEOUT ((ULONG)0x0000014FL) + +// +// MessageId: TCPIP_AOAC_NIC_ACTIVE_REFERENCE_LEAK +// +// MessageText: +// +// TCPIP_AOAC_NIC_ACTIVE_REFERENCE_LEAK +// +#define TCPIP_AOAC_NIC_ACTIVE_REFERENCE_LEAK ((ULONG)0x00000150L) + +// +// MessageId: UNSUPPORTED_INSTRUCTION_MODE +// +// MessageText: +// +// UNSUPPORTED_INSTRUCTION_MODE +// +#define UNSUPPORTED_INSTRUCTION_MODE ((ULONG)0x00000151L) + +// +// MessageId: INVALID_PUSH_LOCK_FLAGS +// +// MessageText: +// +// INVALID_PUSH_LOCK_FLAGS +// +#define INVALID_PUSH_LOCK_FLAGS ((ULONG)0x00000152L) + +// +// MessageId: KERNEL_LOCK_ENTRY_LEAKED_ON_THREAD_TERMINATION +// +// MessageText: +// +// KERNEL_LOCK_ENTRY_LEAKED_ON_THREAD_TERMINATION +// +#define KERNEL_LOCK_ENTRY_LEAKED_ON_THREAD_TERMINATION ((ULONG)0x00000153L) + +// +// MessageId: UNEXPECTED_STORE_EXCEPTION +// +// MessageText: +// +// UNEXPECTED_STORE_EXCEPTION +// +#define UNEXPECTED_STORE_EXCEPTION ((ULONG)0x00000154L) + +// +// MessageId: OS_DATA_TAMPERING +// +// MessageText: +// +// OS_DATA_TAMPERING +// +#define OS_DATA_TAMPERING ((ULONG)0x00000155L) + +// +// MessageId: WINSOCK_DETECTED_HUNG_CLOSESOCKET_LIVEDUMP +// +// MessageText: +// +// WINSOCK_DETECTED_HUNG_CLOSESOCKET_LIVEDUMP +// +#define WINSOCK_DETECTED_HUNG_CLOSESOCKET_LIVEDUMP ((ULONG)0x00000156L) + +// +// MessageId: KERNEL_THREAD_PRIORITY_FLOOR_VIOLATION +// +// MessageText: +// +// KERNEL_THREAD_PRIORITY_FLOOR_VIOLATION +// +#define KERNEL_THREAD_PRIORITY_FLOOR_VIOLATION ((ULONG)0x00000157L) + +// +// MessageId: ILLEGAL_IOMMU_PAGE_FAULT +// +// MessageText: +// +// ILLEGAL_IOMMU_PAGE_FAULT +// +#define ILLEGAL_IOMMU_PAGE_FAULT ((ULONG)0x00000158L) + +// +// MessageId: HAL_ILLEGAL_IOMMU_PAGE_FAULT +// +// MessageText: +// +// HAL_ILLEGAL_IOMMU_PAGE_FAULT +// +#define HAL_ILLEGAL_IOMMU_PAGE_FAULT ((ULONG)0x00000159L) + +// +// MessageId: SDBUS_INTERNAL_ERROR +// +// MessageText: +// +// SDBUS_INTERNAL_ERROR +// +#define SDBUS_INTERNAL_ERROR ((ULONG)0x0000015AL) + +// +// MessageId: WORKER_THREAD_RETURNED_WITH_SYSTEM_PAGE_PRIORITY_ACTIVE +// +// MessageText: +// +// WORKER_THREAD_RETURNED_WITH_SYSTEM_PAGE_PRIORITY_ACTIVE +// +#define WORKER_THREAD_RETURNED_WITH_SYSTEM_PAGE_PRIORITY_ACTIVE ((ULONG)0x0000015BL) + +// +// MessageId: PDC_WATCHDOG_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// PDC_WATCHDOG_TIMEOUT_LIVEDUMP +// +#define PDC_WATCHDOG_TIMEOUT_LIVEDUMP ((ULONG)0x0000015CL) + +// +// MessageId: SOC_SUBSYSTEM_FAILURE_LIVEDUMP +// +// MessageText: +// +// SOC_SUBSYSTEM_FAILURE_LIVEDUMP +// +#define SOC_SUBSYSTEM_FAILURE_LIVEDUMP ((ULONG)0x0000015DL) + +// +// MessageId: BUGCODE_NDIS_DRIVER_LIVE_DUMP +// +// MessageText: +// +// BUGCODE_NDIS_DRIVER_LIVE_DUMP +// +#define BUGCODE_NDIS_DRIVER_LIVE_DUMP ((ULONG)0x0000015EL) + +// +// MessageId: CONNECTED_STANDBY_WATCHDOG_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CONNECTED_STANDBY_WATCHDOG_TIMEOUT_LIVEDUMP +// +#define CONNECTED_STANDBY_WATCHDOG_TIMEOUT_LIVEDUMP ((ULONG)0x0000015FL) + +// +// MessageId: WIN32K_ATOMIC_CHECK_FAILURE +// +// MessageText: +// +// WIN32K_ATOMIC_CHECK_FAILURE +// +#define WIN32K_ATOMIC_CHECK_FAILURE ((ULONG)0x00000160L) + +// +// MessageId: LIVE_SYSTEM_DUMP +// +// MessageText: +// +// LIVE_SYSTEM_DUMP +// +#define LIVE_SYSTEM_DUMP ((ULONG)0x00000161L) + +// +// MessageId: KERNEL_AUTO_BOOST_INVALID_LOCK_RELEASE +// +// MessageText: +// +// KERNEL_AUTO_BOOST_INVALID_LOCK_RELEASE +// +#define KERNEL_AUTO_BOOST_INVALID_LOCK_RELEASE ((ULONG)0x00000162L) + +// +// MessageId: WORKER_THREAD_TEST_CONDITION +// +// MessageText: +// +// WORKER_THREAD_TEST_CONDITION +// +#define WORKER_THREAD_TEST_CONDITION ((ULONG)0x00000163L) + +// +// MessageId: WIN32K_CRITICAL_FAILURE +// +// MessageText: +// +// WIN32K_CRITICAL_FAILURE +// +#define WIN32K_CRITICAL_FAILURE ((ULONG)0x00000164L) + +// +// MessageId: CLUSTER_CSV_STATUS_IO_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_STATUS_IO_TIMEOUT_LIVEDUMP +// +#define CLUSTER_CSV_STATUS_IO_TIMEOUT_LIVEDUMP ((ULONG)0x00000165L) + +// +// MessageId: CLUSTER_RESOURCE_CALL_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_RESOURCE_CALL_TIMEOUT_LIVEDUMP +// +#define CLUSTER_RESOURCE_CALL_TIMEOUT_LIVEDUMP ((ULONG)0x00000166L) + +// +// MessageId: CLUSTER_CSV_SNAPSHOT_DEVICE_INFO_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_SNAPSHOT_DEVICE_INFO_TIMEOUT_LIVEDUMP +// +#define CLUSTER_CSV_SNAPSHOT_DEVICE_INFO_TIMEOUT_LIVEDUMP ((ULONG)0x00000167L) + +// +// MessageId: CLUSTER_CSV_STATE_TRANSITION_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_STATE_TRANSITION_TIMEOUT_LIVEDUMP +// +#define CLUSTER_CSV_STATE_TRANSITION_TIMEOUT_LIVEDUMP ((ULONG)0x00000168L) + +// +// MessageId: CLUSTER_CSV_VOLUME_ARRIVAL_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_VOLUME_ARRIVAL_LIVEDUMP +// +#define CLUSTER_CSV_VOLUME_ARRIVAL_LIVEDUMP ((ULONG)0x00000169L) + +// +// MessageId: CLUSTER_CSV_VOLUME_REMOVAL_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_VOLUME_REMOVAL_LIVEDUMP +// +#define CLUSTER_CSV_VOLUME_REMOVAL_LIVEDUMP ((ULONG)0x0000016AL) + +// +// MessageId: CLUSTER_CSV_CLUSTER_WATCHDOG_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_CLUSTER_WATCHDOG_LIVEDUMP +// +#define CLUSTER_CSV_CLUSTER_WATCHDOG_LIVEDUMP ((ULONG)0x0000016BL) + +// +// MessageId: INVALID_RUNDOWN_PROTECTION_FLAGS +// +// MessageText: +// +// INVALID_RUNDOWN_PROTECTION_FLAGS +// +#define INVALID_RUNDOWN_PROTECTION_FLAGS ((ULONG)0x0000016CL) + +// +// MessageId: INVALID_SLOT_ALLOCATOR_FLAGS +// +// MessageText: +// +// INVALID_SLOT_ALLOCATOR_FLAGS +// +#define INVALID_SLOT_ALLOCATOR_FLAGS ((ULONG)0x0000016DL) + +// +// MessageId: ERESOURCE_INVALID_RELEASE +// +// MessageText: +// +// ERESOURCE_INVALID_RELEASE +// +#define ERESOURCE_INVALID_RELEASE ((ULONG)0x0000016EL) + +// +// MessageId: CLUSTER_CSV_STATE_TRANSITION_INTERVAL_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSV_STATE_TRANSITION_INTERVAL_TIMEOUT_LIVEDUMP +// +#define CLUSTER_CSV_STATE_TRANSITION_INTERVAL_TIMEOUT_LIVEDUMP ((ULONG)0x0000016FL) + +// +// MessageId: CLUSTER_CSV_CLUSSVC_DISCONNECT_WATCHDOG +// +// MessageText: +// +// CLUSTER_CSV_CLUSSVC_DISCONNECT_WATCHDOG +// +#define CLUSTER_CSV_CLUSSVC_DISCONNECT_WATCHDOG ((ULONG)0x00000170L) + +// +// MessageId: CRYPTO_LIBRARY_INTERNAL_ERROR +// +// MessageText: +// +// CRYPTO_LIBRARY_INTERNAL_ERROR +// +#define CRYPTO_LIBRARY_INTERNAL_ERROR ((ULONG)0x00000171L) + +// +// MessageId: SECURE_KERNEL_HIBERNATE_ERROR +// +// MessageText: +// +// SECURE_KERNEL_HIBERNATE_ERROR +// +#define SECURE_KERNEL_HIBERNATE_ERROR ((ULONG)0x00000172L) + +// +// MessageId: COREMSGCALL_INTERNAL_ERROR +// +// MessageText: +// +// COREMSGCALL_INTERNAL_ERROR +// +#define COREMSGCALL_INTERNAL_ERROR ((ULONG)0x00000173L) + +// +// MessageId: COREMSG_INTERNAL_ERROR +// +// MessageText: +// +// COREMSG_INTERNAL_ERROR +// +#define COREMSG_INTERNAL_ERROR ((ULONG)0x00000174L) + +// +// MessageId: PREVIOUS_FATAL_ABNORMAL_RESET_ERROR +// +// MessageText: +// +// PREVIOUS_FATAL_ABNORMAL_RESET_ERROR +// +#define PREVIOUS_FATAL_ABNORMAL_RESET_ERROR ((ULONG)0x00000175L) + +// +// MessageId: STORAGE_STACK_FATAL_ERROR +// +// MessageText: +// +// STORAGE_STACK_FATAL_ERROR +// +#define STORAGE_STACK_FATAL_ERROR ((ULONG)0x00000176L) + +// +// MessageId: ELAM_DRIVER_DETECTED_FATAL_ERROR +// +// MessageText: +// +// ELAM_DRIVER_DETECTED_FATAL_ERROR +// +#define ELAM_DRIVER_DETECTED_FATAL_ERROR ((ULONG)0x00000178L) + +// +// MessageId: CLUSTER_CLUSPORT_STATUS_IO_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CLUSPORT_STATUS_IO_TIMEOUT_LIVEDUMP +// +#define CLUSTER_CLUSPORT_STATUS_IO_TIMEOUT_LIVEDUMP ((ULONG)0x00000179L) + +// +// MessageId: PROFILER_CONFIGURATION_ILLEGAL +// +// MessageText: +// +// PROFILER_CONFIGURATION_ILLEGAL +// +#define PROFILER_CONFIGURATION_ILLEGAL ((ULONG)0x0000017BL) + +// +// MessageId: PDC_LOCK_WATCHDOG_LIVEDUMP +// +// MessageText: +// +// PDC_LOCK_WATCHDOG_LIVEDUMP +// +#define PDC_LOCK_WATCHDOG_LIVEDUMP ((ULONG)0x0000017CL) + +// +// MessageId: PDC_UNEXPECTED_REVOCATION_LIVEDUMP +// +// MessageText: +// +// PDC_UNEXPECTED_REVOCATION_LIVEDUMP +// +#define PDC_UNEXPECTED_REVOCATION_LIVEDUMP ((ULONG)0x0000017DL) + +// +// MessageId: MICROCODE_REVISION_MISMATCH +// +// MessageText: +// +// MICROCODE_REVISION_MISMATCH +// +#define MICROCODE_REVISION_MISMATCH ((ULONG)0x0000017EL) + +// +// MessageId: HYPERGUARD_INITIALIZATION_FAILURE +// +// MessageText: +// +// HYPERGUARD_INITIALIZATION_FAILURE +// +#define HYPERGUARD_INITIALIZATION_FAILURE ((ULONG)0x0000017FL) + +// +// MessageId: WVR_LIVEDUMP_REPLICATION_IOCONTEXT_TIMEOUT +// +// MessageText: +// +// WVR_LIVEDUMP_REPLICATION_IOCONTEXT_TIMEOUT +// +#define WVR_LIVEDUMP_REPLICATION_IOCONTEXT_TIMEOUT ((ULONG)0x00000180L) + +// +// MessageId: WVR_LIVEDUMP_STATE_TRANSITION_TIMEOUT +// +// MessageText: +// +// WVR_LIVEDUMP_STATE_TRANSITION_TIMEOUT +// +#define WVR_LIVEDUMP_STATE_TRANSITION_TIMEOUT ((ULONG)0x00000181L) + +// +// MessageId: WVR_LIVEDUMP_RECOVERY_IOCONTEXT_TIMEOUT +// +// MessageText: +// +// WVR_LIVEDUMP_RECOVERY_IOCONTEXT_TIMEOUT +// +#define WVR_LIVEDUMP_RECOVERY_IOCONTEXT_TIMEOUT ((ULONG)0x00000182L) + +// +// MessageId: WVR_LIVEDUMP_APP_IO_TIMEOUT +// +// MessageText: +// +// WVR_LIVEDUMP_APP_IO_TIMEOUT +// +#define WVR_LIVEDUMP_APP_IO_TIMEOUT ((ULONG)0x00000183L) + +// +// MessageId: WVR_LIVEDUMP_MANUALLY_INITIATED +// +// MessageText: +// +// WVR_LIVEDUMP_MANUALLY_INITIATED +// +#define WVR_LIVEDUMP_MANUALLY_INITIATED ((ULONG)0x00000184L) + +// +// MessageId: WVR_LIVEDUMP_STATE_FAILURE +// +// MessageText: +// +// WVR_LIVEDUMP_STATE_FAILURE +// +#define WVR_LIVEDUMP_STATE_FAILURE ((ULONG)0x00000185L) + +// +// MessageId: WVR_LIVEDUMP_CRITICAL_ERROR +// +// MessageText: +// +// WVR_LIVEDUMP_CRITICAL_ERROR +// +#define WVR_LIVEDUMP_CRITICAL_ERROR ((ULONG)0x00000186L) + +// +// MessageId: VIDEO_DWMINIT_TIMEOUT_FALLBACK_BDD +// +// MessageText: +// +// VIDEO_DWMINIT_TIMEOUT_FALLBACK_BDD +// +#define VIDEO_DWMINIT_TIMEOUT_FALLBACK_BDD ((ULONG)0x00000187L) + +// +// MessageId: CLUSTER_CSVFS_LIVEDUMP +// +// MessageText: +// +// CLUSTER_CSVFS_LIVEDUMP +// +#define CLUSTER_CSVFS_LIVEDUMP ((ULONG)0x00000188L) + +// +// MessageId: BAD_OBJECT_HEADER +// +// MessageText: +// +// BAD_OBJECT_HEADER +// +#define BAD_OBJECT_HEADER ((ULONG)0x00000189L) + +// +// MessageId: SILO_CORRUPT +// +// MessageText: +// +// SILO_CORRUPT +// +#define SILO_CORRUPT ((ULONG)0x0000018AL) + +// +// MessageId: SECURE_KERNEL_ERROR +// +// MessageText: +// +// SECURE_KERNEL_ERROR +// +#define SECURE_KERNEL_ERROR ((ULONG)0x0000018BL) + +// +// MessageId: HYPERGUARD_VIOLATION +// +// MessageText: +// +// HYPERGUARD_VIOLATION +// +#define HYPERGUARD_VIOLATION ((ULONG)0x0000018CL) + +// +// MessageId: SECURE_FAULT_UNHANDLED +// +// MessageText: +// +// SECURE_FAULT_UNHANDLED +// +#define SECURE_FAULT_UNHANDLED ((ULONG)0x0000018DL) + +// +// MessageId: KERNEL_PARTITION_REFERENCE_VIOLATION +// +// MessageText: +// +// KERNEL_PARTITION_REFERENCE_VIOLATION +// +#define KERNEL_PARTITION_REFERENCE_VIOLATION ((ULONG)0x0000018EL) + +// +// MessageId: SYNTHETIC_EXCEPTION_UNHANDLED +// +// MessageText: +// +// SYNTHETIC_EXCEPTION_UNHANDLED +// +#define SYNTHETIC_EXCEPTION_UNHANDLED ((ULONG)0x0000018FL) + +// +// MessageId: WIN32K_CRITICAL_FAILURE_LIVEDUMP +// +// MessageText: +// +// WIN32K_CRITICAL_FAILURE_LIVEDUMP +// +#define WIN32K_CRITICAL_FAILURE_LIVEDUMP ((ULONG)0x00000190L) + +// +// MessageId: PF_DETECTED_CORRUPTION +// +// MessageText: +// +// PF_DETECTED_CORRUPTION +// +#define PF_DETECTED_CORRUPTION ((ULONG)0x00000191L) + +// +// MessageId: KERNEL_AUTO_BOOST_LOCK_ACQUISITION_WITH_RAISED_IRQL +// +// MessageText: +// +// KERNEL_AUTO_BOOST_LOCK_ACQUISITION_WITH_RAISED_IRQL +// +#define KERNEL_AUTO_BOOST_LOCK_ACQUISITION_WITH_RAISED_IRQL ((ULONG)0x00000192L) + +// +// MessageId: VIDEO_DXGKRNL_LIVEDUMP +// +// MessageText: +// +// VIDEO_DXGKRNL_LIVEDUMP +// +#define VIDEO_DXGKRNL_LIVEDUMP ((ULONG)0x00000193L) + +// +// MessageId: KERNEL_STORAGE_SLOT_IN_USE +// +// MessageText: +// +// KERNEL_STORAGE_SLOT_IN_USE +// +#define KERNEL_STORAGE_SLOT_IN_USE ((ULONG)0x00000199L) + +// +// MessageId: SMB_SERVER_LIVEDUMP +// +// MessageText: +// +// SMB_SERVER_LIVEDUMP +// +#define SMB_SERVER_LIVEDUMP ((ULONG)0x00000195L) + +// +// MessageId: LOADER_ROLLBACK_DETECTED +// +// MessageText: +// +// LOADER_ROLLBACK_DETECTED +// +#define LOADER_ROLLBACK_DETECTED ((ULONG)0x00000196L) + +// +// MessageId: WIN32K_SECURITY_FAILURE +// +// MessageText: +// +// WIN32K_SECURITY_FAILURE +// +#define WIN32K_SECURITY_FAILURE ((ULONG)0x00000197L) + +// +// MessageId: UFX_LIVEDUMP +// +// MessageText: +// +// UFX_LIVEDUMP +// +#define UFX_LIVEDUMP ((ULONG)0x00000198L) + +// +// MessageId: WORKER_THREAD_RETURNED_WHILE_ATTACHED_TO_SILO +// +// MessageText: +// +// WORKER_THREAD_RETURNED_WHILE_ATTACHED_TO_SILO +// +#define WORKER_THREAD_RETURNED_WHILE_ATTACHED_TO_SILO ((ULONG)0x0000019AL) + +// +// MessageId: TTM_FATAL_ERROR +// +// MessageText: +// +// TTM_FATAL_ERROR +// +#define TTM_FATAL_ERROR ((ULONG)0x0000019BL) + +// +// MessageId: WIN32K_POWER_WATCHDOG_TIMEOUT +// +// MessageText: +// +// WIN32K_POWER_WATCHDOG_TIMEOUT +// +#define WIN32K_POWER_WATCHDOG_TIMEOUT ((ULONG)0x0000019CL) + +// +// MessageId: CLUSTER_SVHDX_LIVEDUMP +// +// MessageText: +// +// CLUSTER_SVHDX_LIVEDUMP +// +#define CLUSTER_SVHDX_LIVEDUMP ((ULONG)0x0000019DL) + +// +// MessageId: BUGCODE_NETADAPTER_DRIVER +// +// MessageText: +// +// BUGCODE_NETADAPTER_DRIVER +// +#define BUGCODE_NETADAPTER_DRIVER ((ULONG)0x0000019EL) + +// +// MessageId: PDC_PRIVILEGE_CHECK_LIVEDUMP +// +// MessageText: +// +// PDC_PRIVILEGE_CHECK_LIVEDUMP +// +#define PDC_PRIVILEGE_CHECK_LIVEDUMP ((ULONG)0x0000019FL) + +// +// MessageId: TTM_WATCHDOG_TIMEOUT +// +// MessageText: +// +// TTM_WATCHDOG_TIMEOUT +// +#define TTM_WATCHDOG_TIMEOUT ((ULONG)0x000001A0L) + +// +// MessageId: WIN32K_CALLOUT_WATCHDOG_LIVEDUMP +// +// MessageText: +// +// WIN32K_CALLOUT_WATCHDOG_LIVEDUMP +// +#define WIN32K_CALLOUT_WATCHDOG_LIVEDUMP ((ULONG)0x000001A1L) + +// +// MessageId: WIN32K_CALLOUT_WATCHDOG_BUGCHECK +// +// MessageText: +// +// WIN32K_CALLOUT_WATCHDOG_BUGCHECK +// +#define WIN32K_CALLOUT_WATCHDOG_BUGCHECK ((ULONG)0x000001A2L) + +// +// MessageId: CALL_HAS_NOT_RETURNED_WATCHDOG_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// CALL_HAS_NOT_RETURNED_WATCHDOG_TIMEOUT_LIVEDUMP +// +#define CALL_HAS_NOT_RETURNED_WATCHDOG_TIMEOUT_LIVEDUMP ((ULONG)0x000001A3L) + +// +// MessageId: DRIPS_SW_HW_DIVERGENCE_LIVEDUMP +// +// MessageText: +// +// DRIPS_SW_HW_DIVERGENCE_LIVEDUMP +// +#define DRIPS_SW_HW_DIVERGENCE_LIVEDUMP ((ULONG)0x000001A4L) + +// +// MessageId: USB_DRIPS_BLOCKER_SURPRISE_REMOVAL_LIVEDUMP +// +// MessageText: +// +// USB_DRIPS_BLOCKER_SURPRISE_REMOVAL_LIVEDUMP +// +#define USB_DRIPS_BLOCKER_SURPRISE_REMOVAL_LIVEDUMP ((ULONG)0x000001A5L) + +// +// MessageId: BLUETOOTH_ERROR_RECOVERY_LIVEDUMP +// +// MessageText: +// +// BLUETOOTH_ERROR_RECOVERY_LIVEDUMP +// +#define BLUETOOTH_ERROR_RECOVERY_LIVEDUMP ((ULONG)0x000001A6L) + +// +// MessageId: SMB_REDIRECTOR_LIVEDUMP +// +// MessageText: +// +// SMB_REDIRECTOR_LIVEDUMP +// +#define SMB_REDIRECTOR_LIVEDUMP ((ULONG)0x000001A7L) + +// +// MessageId: VIDEO_DXGKRNL_BLACK_SCREEN_LIVEDUMP +// +// MessageText: +// +// VIDEO_DXGKRNL_BLACK_SCREEN_LIVEDUMP +// +#define VIDEO_DXGKRNL_BLACK_SCREEN_LIVEDUMP ((ULONG)0x000001A8L) + +// +// MessageId: DIRECTED_FX_TRANSITION_LIVEDUMP +// +// MessageText: +// +// DIRECTED_FX_TRANSITION_LIVEDUMP +// +#define DIRECTED_FX_TRANSITION_LIVEDUMP ((ULONG)0x000001A9L) + +// +// MessageId: EXCEPTION_ON_INVALID_STACK +// +// MessageText: +// +// EXCEPTION_ON_INVALID_STACK +// +#define EXCEPTION_ON_INVALID_STACK ((ULONG)0x000001AAL) + +// +// MessageId: UNWIND_ON_INVALID_STACK +// +// MessageText: +// +// UNWIND_ON_INVALID_STACK +// +#define UNWIND_ON_INVALID_STACK ((ULONG)0x000001ABL) + +// +// MessageId: VIDEO_MINIPORT_FAILED_LIVEDUMP +// +// MessageText: +// +// VIDEO_MINIPORT_FAILED_LIVEDUMP +// +#define VIDEO_MINIPORT_FAILED_LIVEDUMP ((ULONG)0x000001B0L) + +// +// MessageId: VIDEO_MINIPORT_BLACK_SCREEN_LIVEDUMP +// +// MessageText: +// +// VIDEO_MINIPORT_BLACK_SCREEN_LIVEDUMP +// +#define VIDEO_MINIPORT_BLACK_SCREEN_LIVEDUMP ((ULONG)0x000001B8L) + +// +// MessageId: DRIVER_VERIFIER_DETECTED_VIOLATION_LIVEDUMP +// +// MessageText: +// +// DRIVER_VERIFIER_DETECTED_VIOLATION_LIVEDUMP +// +#define DRIVER_VERIFIER_DETECTED_VIOLATION_LIVEDUMP ((ULONG)0x000001C4L) + +// +// MessageId: IO_THREADPOOL_DEADLOCK_LIVEDUMP +// +// MessageText: +// +// IO_THREADPOOL_DEADLOCK_LIVEDUMP +// +#define IO_THREADPOOL_DEADLOCK_LIVEDUMP ((ULONG)0x000001C5L) + +// +// MessageId: FAST_ERESOURCE_PRECONDITION_VIOLATION +// +// MessageText: +// +// FAST_ERESOURCE_PRECONDITION_VIOLATION +// +#define FAST_ERESOURCE_PRECONDITION_VIOLATION ((ULONG)0x000001C6L) + +// +// MessageId: STORE_DATA_STRUCTURE_CORRUPTION +// +// MessageText: +// +// STORE_DATA_STRUCTURE_CORRUPTION +// +#define STORE_DATA_STRUCTURE_CORRUPTION ((ULONG)0x000001C7L) + +// +// MessageId: MANUALLY_INITIATED_POWER_BUTTON_HOLD +// +// MessageText: +// +// MANUALLY_INITIATED_POWER_BUTTON_HOLD +// +#define MANUALLY_INITIATED_POWER_BUTTON_HOLD ((ULONG)0x000001C8L) + +// +// MessageId: USER_MODE_HEALTH_MONITOR_LIVEDUMP +// +// MessageText: +// +// USER_MODE_HEALTH_MONITOR_LIVEDUMP +// +#define USER_MODE_HEALTH_MONITOR_LIVEDUMP ((ULONG)0x000001C9L) + +// +// MessageId: SYNTHETIC_WATCHDOG_TIMEOUT +// +// MessageText: +// +// SYNTHETIC_WATCHDOG_TIMEOUT +// +#define SYNTHETIC_WATCHDOG_TIMEOUT ((ULONG)0x000001CAL) + +// +// MessageId: INVALID_SILO_DETACH +// +// MessageText: +// +// INVALID_SILO_DETACH +// +#define INVALID_SILO_DETACH ((ULONG)0x000001CBL) + +// +// MessageId: EXRESOURCE_TIMEOUT_LIVEDUMP +// +// MessageText: +// +// EXRESOURCE_TIMEOUT_LIVEDUMP +// +#define EXRESOURCE_TIMEOUT_LIVEDUMP ((ULONG)0x000001CCL) + +// +// MessageId: INVALID_CALLBACK_STACK_ADDRESS +// +// MessageText: +// +// INVALID_CALLBACK_STACK_ADDRESS +// +#define INVALID_CALLBACK_STACK_ADDRESS ((ULONG)0x000001CDL) + +// +// MessageId: INVALID_KERNEL_STACK_ADDRESS +// +// MessageText: +// +// INVALID_KERNEL_STACK_ADDRESS +// +#define INVALID_KERNEL_STACK_ADDRESS ((ULONG)0x000001CEL) + +// +// MessageId: HARDWARE_WATCHDOG_TIMEOUT +// +// MessageText: +// +// HARDWARE_WATCHDOG_TIMEOUT +// +#define HARDWARE_WATCHDOG_TIMEOUT ((ULONG)0x000001CFL) + +// +// MessageId: ACPI_FIRMWARE_WATCHDOG_TIMEOUT +// +// MessageText: +// +// ACPI_FIRMWARE_WATCHDOG_TIMEOUT +// +#define ACPI_FIRMWARE_WATCHDOG_TIMEOUT ((ULONG)0x000001D0L) + +// +// MessageId: TELEMETRY_ASSERTS_LIVEDUMP +// +// MessageText: +// +// TELEMETRY_ASSERTS_LIVEDUMP +// +#define TELEMETRY_ASSERTS_LIVEDUMP ((ULONG)0x000001D1L) + +// +// MessageId: WORKER_THREAD_INVALID_STATE +// +// MessageText: +// +// WORKER_THREAD_INVALID_STATE +// +#define WORKER_THREAD_INVALID_STATE ((ULONG)0x000001D2L) + +// +// MessageId: WFP_INVALID_OPERATION +// +// MessageText: +// +// WFP_INVALID_OPERATION +// +#define WFP_INVALID_OPERATION ((ULONG)0x000001D3L) + +// +// MessageId: UCMUCSI_LIVEDUMP +// +// MessageText: +// +// UCMUCSI_LIVEDUMP +// +#define UCMUCSI_LIVEDUMP ((ULONG)0x000001D4L) + +// +// MessageId: DRIVER_PNP_WATCHDOG +// +// MessageText: +// +// DRIVER_PNP_WATCHDOG +// +#define DRIVER_PNP_WATCHDOG ((ULONG)0x000001D5L) + +// +// MessageId: WORKER_THREAD_RETURNED_WITH_NON_DEFAULT_WORKLOAD_CLASS +// +// MessageText: +// +// WORKER_THREAD_RETURNED_WITH_NON_DEFAULT_WORKLOAD_CLASS +// +#define WORKER_THREAD_RETURNED_WITH_NON_DEFAULT_WORKLOAD_CLASS ((ULONG)0x000001D6L) + +// +// MessageId: EFS_FATAL_ERROR +// +// MessageText: +// +// EFS_FATAL_ERROR +// +#define EFS_FATAL_ERROR ((ULONG)0x000001D7L) + +// +// MessageId: UCMUCSI_FAILURE +// +// MessageText: +// +// UCMUCSI_FAILURE +// +#define UCMUCSI_FAILURE ((ULONG)0x000001D8L) + +// +// MessageId: HAL_IOMMU_INTERNAL_ERROR +// +// MessageText: +// +// HAL_IOMMU_INTERNAL_ERROR +// +#define HAL_IOMMU_INTERNAL_ERROR ((ULONG)0x000001D9L) + +// +// MessageId: HAL_BLOCKED_PROCESSOR_INTERNAL_ERROR +// +// MessageText: +// +// HAL_BLOCKED_PROCESSOR_INTERNAL_ERROR +// +#define HAL_BLOCKED_PROCESSOR_INTERNAL_ERROR ((ULONG)0x000001DAL) + +// +// MessageId: IPI_WATCHDOG_TIMEOUT +// +// MessageText: +// +// IPI_WATCHDOG_TIMEOUT +// +#define IPI_WATCHDOG_TIMEOUT ((ULONG)0x000001DBL) + +// +// MessageId: DMA_COMMON_BUFFER_VECTOR_ERROR +// +// MessageText: +// +// DMA_COMMON_BUFFER_VECTOR_ERROR +// +#define DMA_COMMON_BUFFER_VECTOR_ERROR ((ULONG)0x000001DCL) + +// +// MessageId: BUGCODE_MBBADAPTER_DRIVER +// +// MessageText: +// +// BUGCODE_MBBADAPTER_DRIVER +// +#define BUGCODE_MBBADAPTER_DRIVER ((ULONG)0x000001DDL) + +// +// MessageId: BUGCODE_WIFIADAPTER_DRIVER +// +// MessageText: +// +// BUGCODE_WIFIADAPTER_DRIVER +// +#define BUGCODE_WIFIADAPTER_DRIVER ((ULONG)0x000001DEL) + +// +// MessageId: PROCESSOR_START_TIMEOUT +// +// MessageText: +// +// PROCESSOR_START_TIMEOUT +// +#define PROCESSOR_START_TIMEOUT ((ULONG)0x000001DFL) + +// +// MessageId: INVALID_ALTERNATE_SYSTEM_CALL_HANDLER_REGISTRATION +// +// MessageText: +// +// INVALID_ALTERNATE_SYSTEM_CALL_HANDLER_REGISTRATION +// +#define INVALID_ALTERNATE_SYSTEM_CALL_HANDLER_REGISTRATION ((ULONG)0x000001E0L) + +// +// MessageId: DEVICE_DIAGNOSTIC_LOG_LIVEDUMP +// +// MessageText: +// +// DEVICE_DIAGNOSTIC_LOG_LIVEDUMP +// +#define DEVICE_DIAGNOSTIC_LOG_LIVEDUMP ((ULONG)0x000001E1L) + +// +// MessageId: AZURE_DEVICE_FW_DUMP +// +// MessageText: +// +// AZURE_DEVICE_FW_DUMP +// +#define AZURE_DEVICE_FW_DUMP ((ULONG)0x000001E2L) + +// +// MessageId: BREAKAWAY_CABLE_TRANSITION +// +// MessageText: +// +// BREAKAWAY_CABLE_TRANSITION +// +#define BREAKAWAY_CABLE_TRANSITION ((ULONG)0x000001E3L) + +// +// MessageId: VIDEO_DXGKRNL_SYSMM_FATAL_ERROR +// +// MessageText: +// +// VIDEO_DXGKRNL_SYSMM_FATAL_ERROR +// +#define VIDEO_DXGKRNL_SYSMM_FATAL_ERROR ((ULONG)0x000001E4L) + +// +// MessageId: DRIVER_VERIFIER_TRACKING_LIVE_DUMP +// +// MessageText: +// +// DRIVER_VERIFIER_TRACKING_LIVE_DUMP +// +#define DRIVER_VERIFIER_TRACKING_LIVE_DUMP ((ULONG)0x000001E5L) + +// +// MessageId: CRASHDUMP_WATCHDOG_TIMEOUT +// +// MessageText: +// +// CRASHDUMP_WATCHDOG_TIMEOUT +// +#define CRASHDUMP_WATCHDOG_TIMEOUT ((ULONG)0x000001E6L) + +// +// MessageId: REGISTRY_LIVE_DUMP +// +// MessageText: +// +// REGISTRY_LIVE_DUMP +// +#define REGISTRY_LIVE_DUMP ((ULONG)0x000001E7L) + +// +// MessageId: INVALID_THREAD_AFFINITY_STATE +// +// MessageText: +// +// INVALID_THREAD_AFFINITY_STATE +// +#define INVALID_THREAD_AFFINITY_STATE ((ULONG)0x000001E8L) + +// +// MessageId: ILLEGAL_ATS_INITIALIZATION +// +// MessageText: +// +// ILLEGAL_ATS_INITIALIZATION +// +#define ILLEGAL_ATS_INITIALIZATION ((ULONG)0x000001E9L) + +// +// MessageId: SECURE_PCI_CONFIG_SPACE_ACCESS_VIOLATION +// +// MessageText: +// +// SECURE_PCI_CONFIG_SPACE_ACCESS_VIOLATION +// +#define SECURE_PCI_CONFIG_SPACE_ACCESS_VIOLATION ((ULONG)0x000001EAL) + +// +// MessageId: DAM_WATCHDOG_TIMEOUT +// +// MessageText: +// +// DAM_WATCHDOG_TIMEOUT +// +#define DAM_WATCHDOG_TIMEOUT ((ULONG)0x000001EBL) + +// +// MessageId: HANDLE_LIVE_DUMP +// +// MessageText: +// +// HANDLE_LIVE_DUMP +// +#define HANDLE_LIVE_DUMP ((ULONG)0x000001ECL) + +// +// MessageId: HANDLE_ERROR_ON_CRITICAL_THREAD +// +// MessageText: +// +// HANDLE_ERROR_ON_CRITICAL_THREAD +// +#define HANDLE_ERROR_ON_CRITICAL_THREAD ((ULONG)0x000001EDL) + +// +// MessageId: MPSDRV_QUERY_USER +// +// MessageText: +// +// MPSDRV_QUERY_USER +// +#define MPSDRV_QUERY_USER ((ULONG)0x400001EEL) + +// +// MessageId: VMBUS_LIVEDUMP +// +// MessageText: +// +// VMBUS_LIVEDUMP +// +#define VMBUS_LIVEDUMP ((ULONG)0x400001EFL) + +// +// MessageId: USB4_HARDWARE_VIOLATION +// +// MessageText: +// +// USB4_HARDWARE_VIOLATION +// +#define USB4_HARDWARE_VIOLATION ((ULONG)0x000001F0L) + +// +// MessageId: KASAN_ENLIGHTENMENT_VIOLATION +// +// MessageText: +// +// KASAN_ENLIGHTENMENT_VIOLATION +// +#define KASAN_ENLIGHTENMENT_VIOLATION ((ULONG)0x000001F1L) + +// +// MessageId: KASAN_ILLEGAL_ACCESS +// +// MessageText: +// +// KASAN_ILLEGAL_ACCESS +// +#define KASAN_ILLEGAL_ACCESS ((ULONG)0x000001F2L) + +// +// MessageId: IORING +// +// MessageText: +// +// IORING +// +#define IORING ((ULONG)0x000001F3L) + +// +// MessageId: MDL_CACHE +// +// MessageText: +// +// MDL_CACHE +// +#define MDL_CACHE ((ULONG)0x000001F4L) + +// +// MessageId: APPLICATION_HANG_KERNEL_LIVEDUMP +// +// MessageText: +// +// APPLICATION_HANG_KERNEL_LIVEDUMP +// +#define APPLICATION_HANG_KERNEL_LIVEDUMP ((ULONG)0x000001F5L) + +// +// MessageId: MISALIGNED_POINTER_PARAMETER +// +// MessageText: +// +// MISALIGNED_POINTER_PARAMETER +// +#define MISALIGNED_POINTER_PARAMETER ((ULONG)0x000001F6L) + +// +// MessageId: MSSECCORE_ASSERTION_FAILURE +// +// MessageText: +// +// MSSECCORE_ASSERTION_FAILURE +// +#define MSSECCORE_ASSERTION_FAILURE ((ULONG)0x000001F7L) + +// +// MessageId: INVALID_MINIMAL_PROCESS_STATE +// +// MessageText: +// +// INVALID_MINIMAL_PROCESS_STATE +// +#define INVALID_MINIMAL_PROCESS_STATE ((ULONG)0x000001F8L) + +// +// MessageId: PREVIOUS_MODE_MISMATCH +// +// MessageText: +// +// PREVIOUS_MODE_MISMATCH +// +#define PREVIOUS_MODE_MISMATCH ((ULONG)0x000001F9L) + +// +// MessageId: SMB_SRV_REQUEST_VALIDATION_FAILURE +// +// MessageText: +// +// SMB_SRV_REQUEST_VALIDATION_FAILURE +// +#define SMB_SRV_REQUEST_VALIDATION_FAILURE ((ULONG)0x000001FAL) + +// +// MessageId: IOMMU_INTERRUPT_REMAPPING_FAULT +// +// MessageText: +// +// IOMMU_INTERRUPT_REMAPPING_FAULT +// +#define IOMMU_INTERRUPT_REMAPPING_FAULT ((ULONG)0x000001FBL) + +// +// MessageId: WIN32K_CALLOUT_UNREGISTER_FAILED +// +// MessageText: +// +// WIN32K_CALLOUT_UNREGISTER_FAILED +// +#define WIN32K_CALLOUT_UNREGISTER_FAILED ((ULONG)0x000001FCL) + +// +// MessageId: HAL_SPE_INTERNAL_ERROR +// +// MessageText: +// +// HAL_SPE_INTERNAL_ERROR +// +#define HAL_SPE_INTERNAL_ERROR ((ULONG)0x000001FDL) + +// +// MessageId: SMB_CLIENT_REQUEST_VALIDATION_FAILURE +// +// MessageText: +// +// SMB_CLIENT_REQUEST_VALIDATION_FAILURE +// +#define SMB_CLIENT_REQUEST_VALIDATION_FAILURE ((ULONG)0x000001FEL) + +// +// MessageId: CPU_SCHEDULER_INTERNAL_ERROR +// +// MessageText: +// +// CPU_SCHEDULER_INTERNAL_ERROR +// +#define CPU_SCHEDULER_INTERNAL_ERROR ((ULONG)0x00000200L) + +// +// MessageId: PROCESS_TERMINATE_LIKELY_DEADLOCK +// +// MessageText: +// +// PROCESS_TERMINATE_LIKELY_DEADLOCK +// +#define PROCESS_TERMINATE_LIKELY_DEADLOCK ((ULONG)0x00000201L) + +// +// MessageId: UNEXPECTED_CODEPATH +// +// MessageText: +// +// UNEXPECTED_CODEPATH +// +#define UNEXPECTED_CODEPATH ((ULONG)0x00000202L) + +// +// MessageId: INVALID_EXTENSION_STATE +// +// MessageText: +// +// INVALID_EXTENSION_STATE +// +#define INVALID_EXTENSION_STATE ((ULONG)0x00000203L) + +// +// MessageId: STORAGE_DRIVER_LIVEDUMP +// +// MessageText: +// +// STORAGE_DRIVER_LIVEDUMP +// +#define STORAGE_DRIVER_LIVEDUMP ((ULONG)0x00000207L) + +// +// MessageId: XBOX_VMCTRL_CS_TIMEOUT +// +// MessageText: +// +// XBOX_VMCTRL_CS_TIMEOUT +// +#define XBOX_VMCTRL_CS_TIMEOUT ((ULONG)0x00000356L) + +// +// MessageId: XBOX_CORRUPTED_IMAGE +// +// MessageText: +// +// XBOX_CORRUPTED_IMAGE +// +#define XBOX_CORRUPTED_IMAGE ((ULONG)0x00000357L) + +// +// MessageId: XBOX_INVERTED_FUNCTION_TABLE_OVERFLOW +// +// MessageText: +// +// XBOX_INVERTED_FUNCTION_TABLE_OVERFLOW +// +#define XBOX_INVERTED_FUNCTION_TABLE_OVERFLOW ((ULONG)0x00000358L) + +// +// MessageId: XBOX_CORRUPTED_IMAGE_BASE +// +// MessageText: +// +// XBOX_CORRUPTED_IMAGE_BASE +// +#define XBOX_CORRUPTED_IMAGE_BASE ((ULONG)0x00000359L) + +// +// MessageId: XBOX_XDS_WATCHDOG_TIMEOUT +// +// MessageText: +// +// XBOX_XDS_WATCHDOG_TIMEOUT +// +#define XBOX_XDS_WATCHDOG_TIMEOUT ((ULONG)0x0000035AL) + +// +// MessageId: XBOX_SHUTDOWN_WATCHDOG_TIMEOUT +// +// MessageText: +// +// XBOX_SHUTDOWN_WATCHDOG_TIMEOUT +// +#define XBOX_SHUTDOWN_WATCHDOG_TIMEOUT ((ULONG)0x0000035BL) + +// +// MessageId: XBOX_CANNOT_MANAGE_PARTITION_MEMORY +// +// MessageText: +// +// XBOX_CANNOT_MANAGE_PARTITION_MEMORY +// +#define XBOX_CANNOT_MANAGE_PARTITION_MEMORY ((ULONG)0x0000035DL) + +// +// MessageId: XBOX_360_SYSTEM_CRASH +// +// MessageText: +// +// XBOX_360_SYSTEM_CRASH +// +#define XBOX_360_SYSTEM_CRASH ((ULONG)0x00000360L) + +// +// MessageId: XBOX_360_SYSTEM_CRASH_RESERVED +// +// MessageText: +// +// XBOX_360_SYSTEM_CRASH_RESERVED +// +#define XBOX_360_SYSTEM_CRASH_RESERVED ((ULONG)0x00000420L) + +// +// MessageId: XBOX_SECURITY_FAILUE +// +// MessageText: +// +// XBOX_SECURITY_FAILUE +// +#define XBOX_SECURITY_FAILUE ((ULONG)0x00000421L) + +// +// MessageId: KERNEL_CFG_INIT_FAILURE +// +// MessageText: +// +// KERNEL_CFG_INIT_FAILURE +// +#define KERNEL_CFG_INIT_FAILURE ((ULONG)0x00000422L) + +// +// MessageId: MANUALLY_INITIATED_POWER_BUTTON_HOLD_LIVE_DUMP +// +// MessageText: +// +// MANUALLY_INITIATED_POWER_BUTTON_HOLD_LIVE_DUMP +// +#define MANUALLY_INITIATED_POWER_BUTTON_HOLD_LIVE_DUMP ((ULONG)0x000011C8L) + +// +// MessageId: HYPERVISOR_ERROR +// +// MessageText: +// +// HYPERVISOR_ERROR +// +#define HYPERVISOR_ERROR ((ULONG)0x00020001L) + +// +// MessageId: XBOX_MANUALLY_INITIATED_CRASH +// +// MessageText: +// +// XBOX_MANUALLY_INITIATED_CRASH +// +#define XBOX_MANUALLY_INITIATED_CRASH ((ULONG)0x00030006L) + +// +// MessageId: MANUALLY_INITIATED_BLACKSCREEN_HOTKEY_LIVE_DUMP +// +// MessageText: +// +// MANUALLY_INITIATED_BLACKSCREEN_HOTKEY_LIVE_DUMP +// +#define MANUALLY_INITIATED_BLACKSCREEN_HOTKEY_LIVE_DUMP ((ULONG)0x000021C8L) + +#define WINLOGON_FATAL_ERROR ((ULONG)0xC000021AL) +#define MANUALLY_INITIATED_CRASH1 ((ULONG)0xDEADDEAD) +#define BUGCHECK_CONTEXT_MODIFIER 0x80000000 +#endif // _BUGCODES_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cderr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cderr.h new file mode 100644 index 0000000000000000000000000000000000000000..aadc309c50dd02b33ec52d5ca60a0fd2b6a1a248 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cderr.h @@ -0,0 +1,62 @@ +/*****************************************************************************\ +* * +* cderr.h - Common dialog error return codes * +* * +* Version 1.0 * +* * +* Copyright (c) 1992-1999, Microsoft Corp. All rights reserved. * +* * +\*****************************************************************************/ + +#ifndef _INC_CDERR +#define _INC_CDERR + +#if _MSC_VER > 1000 +#pragma once +#endif + +#define CDERR_DIALOGFAILURE 0xFFFF + +#define CDERR_GENERALCODES 0x0000 +#define CDERR_STRUCTSIZE 0x0001 +#define CDERR_INITIALIZATION 0x0002 +#define CDERR_NOTEMPLATE 0x0003 +#define CDERR_NOHINSTANCE 0x0004 +#define CDERR_LOADSTRFAILURE 0x0005 +#define CDERR_FINDRESFAILURE 0x0006 +#define CDERR_LOADRESFAILURE 0x0007 +#define CDERR_LOCKRESFAILURE 0x0008 +#define CDERR_MEMALLOCFAILURE 0x0009 +#define CDERR_MEMLOCKFAILURE 0x000A +#define CDERR_NOHOOK 0x000B +#define CDERR_REGISTERMSGFAIL 0x000C + +#define PDERR_PRINTERCODES 0x1000 +#define PDERR_SETUPFAILURE 0x1001 +#define PDERR_PARSEFAILURE 0x1002 +#define PDERR_RETDEFFAILURE 0x1003 +#define PDERR_LOADDRVFAILURE 0x1004 +#define PDERR_GETDEVMODEFAIL 0x1005 +#define PDERR_INITFAILURE 0x1006 +#define PDERR_NODEVICES 0x1007 +#define PDERR_NODEFAULTPRN 0x1008 +#define PDERR_DNDMMISMATCH 0x1009 +#define PDERR_CREATEICFAILURE 0x100A +#define PDERR_PRINTERNOTFOUND 0x100B +#define PDERR_DEFAULTDIFFERENT 0x100C + +#define CFERR_CHOOSEFONTCODES 0x2000 +#define CFERR_NOFONTS 0x2001 +#define CFERR_MAXLESSTHANMIN 0x2002 + +#define FNERR_FILENAMECODES 0x3000 +#define FNERR_SUBCLASSFAILURE 0x3001 +#define FNERR_INVALIDFILENAME 0x3002 +#define FNERR_BUFFERTOOSMALL 0x3003 + +#define FRERR_FINDREPLACECODES 0x4000 +#define FRERR_BUFFERLENGTHZERO 0x4001 + +#define CCERR_CHOOSECOLORCODES 0x5000 + +#endif /* !_INC_CDERR */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cfg.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cfg.h new file mode 100644 index 0000000000000000000000000000000000000000..a3137de0d2ea7978c701e9ce9934ccc8b8529602 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/cfg.h @@ -0,0 +1,343 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + cfg.h + +Abstract: + + This module contains the common Configuration Manager definitions for + both user mode and kernel mode code. + +Revision History: + +--*/ + +#ifndef _CFG_INCLUDED_ +#define _CFG_INCLUDED_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#ifdef _MSC_VER +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) /* #if not_defined treated as #if 0 */ +#endif +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// The following definitions are also used by kernel mode code to +// set up the registry. +// +// +// VetoType used in +// CM_Disable_DevNode +// CM_Uninstall_DevNode +// CM_Query_And_Remove_SubTree +// +typedef enum _PNP_VETO_TYPE { + PNP_VetoTypeUnknown, // Name is unspecified + PNP_VetoLegacyDevice, // Name is an Instance Path + PNP_VetoPendingClose, // Name is an Instance Path + PNP_VetoWindowsApp, // Name is a Module + PNP_VetoWindowsService, // Name is a Service + PNP_VetoOutstandingOpen, // Name is an Instance Path + PNP_VetoDevice, // Name is an Instance Path + PNP_VetoDriver, // Name is a Driver Service Name + PNP_VetoIllegalDeviceRequest, // Name is an Instance Path + PNP_VetoInsufficientPower, // Name is unspecified + PNP_VetoNonDisableable, // Name is an Instance Path + PNP_VetoLegacyDriver, // Name is a Service + PNP_VetoInsufficientRights, // Name is unspecified + PNP_VetoAlreadyRemoved, // Name is unspecified +} PNP_VETO_TYPE, *PPNP_VETO_TYPE; + + +// +// DevInst problem values, returned by call to CM_Get_DevInst_Status +// +#define CM_PROB_NOT_CONFIGURED (0x00000001) // no config for device +#define CM_PROB_DEVLOADER_FAILED (0x00000002) // service load failed +#define CM_PROB_OUT_OF_MEMORY (0x00000003) // out of memory +#define CM_PROB_ENTRY_IS_WRONG_TYPE (0x00000004) // +#define CM_PROB_LACKED_ARBITRATOR (0x00000005) // +#define CM_PROB_BOOT_CONFIG_CONFLICT (0x00000006) // boot config conflict +#define CM_PROB_FAILED_FILTER (0x00000007) // +#define CM_PROB_DEVLOADER_NOT_FOUND (0x00000008) // Devloader not found +#define CM_PROB_INVALID_DATA (0x00000009) // Invalid ID +#define CM_PROB_FAILED_START (0x0000000A) // +#define CM_PROB_LIAR (0x0000000B) // +#define CM_PROB_NORMAL_CONFLICT (0x0000000C) // config conflict +#define CM_PROB_NOT_VERIFIED (0x0000000D) // +#define CM_PROB_NEED_RESTART (0x0000000E) // requires restart +#define CM_PROB_REENUMERATION (0x0000000F) // +#define CM_PROB_PARTIAL_LOG_CONF (0x00000010) // +#define CM_PROB_UNKNOWN_RESOURCE (0x00000011) // unknown res type +#define CM_PROB_REINSTALL (0x00000012) // +#define CM_PROB_REGISTRY (0x00000013) // +#define CM_PROB_VXDLDR (0x00000014) // WINDOWS 95 ONLY +#define CM_PROB_WILL_BE_REMOVED (0x00000015) // devinst will remove +#define CM_PROB_DISABLED (0x00000016) // devinst is disabled +#define CM_PROB_DEVLOADER_NOT_READY (0x00000017) // Devloader not ready +#define CM_PROB_DEVICE_NOT_THERE (0x00000018) // device doesn't exist +#define CM_PROB_MOVED (0x00000019) // +#define CM_PROB_TOO_EARLY (0x0000001A) // +#define CM_PROB_NO_VALID_LOG_CONF (0x0000001B) // no valid log config +#define CM_PROB_FAILED_INSTALL (0x0000001C) // install failed +#define CM_PROB_HARDWARE_DISABLED (0x0000001D) // device disabled +#define CM_PROB_CANT_SHARE_IRQ (0x0000001E) // can't share IRQ +#define CM_PROB_FAILED_ADD (0x0000001F) // driver failed add +#define CM_PROB_DISABLED_SERVICE (0x00000020) // service's Start = 4 +#define CM_PROB_TRANSLATION_FAILED (0x00000021) // resource translation failed +#define CM_PROB_NO_SOFTCONFIG (0x00000022) // no soft config +#define CM_PROB_BIOS_TABLE (0x00000023) // device missing in BIOS table +#define CM_PROB_IRQ_TRANSLATION_FAILED (0x00000024) // IRQ translator failed +#define CM_PROB_FAILED_DRIVER_ENTRY (0x00000025) // DriverEntry() failed. +#define CM_PROB_DRIVER_FAILED_PRIOR_UNLOAD (0x00000026) // Driver should have unloaded. +#define CM_PROB_DRIVER_FAILED_LOAD (0x00000027) // Driver load unsuccessful. +#define CM_PROB_DRIVER_SERVICE_KEY_INVALID (0x00000028) // Error accessing driver's service key +#define CM_PROB_LEGACY_SERVICE_NO_DEVICES (0x00000029) // Loaded legacy service created no devices +#define CM_PROB_DUPLICATE_DEVICE (0x0000002A) // Two devices were discovered with the same name +#define CM_PROB_FAILED_POST_START (0x0000002B) // The drivers set the device state to failed +#define CM_PROB_HALTED (0x0000002C) // This device was failed post start via usermode +#define CM_PROB_PHANTOM (0x0000002D) // The devinst currently exists only in the registry +#define CM_PROB_SYSTEM_SHUTDOWN (0x0000002E) // The system is shutting down +#define CM_PROB_HELD_FOR_EJECT (0x0000002F) // The device is offline awaiting removal +#define CM_PROB_DRIVER_BLOCKED (0x00000030) // One or more drivers is blocked from loading +#define CM_PROB_REGISTRY_TOO_LARGE (0x00000031) // System hive has grown too large +#define CM_PROB_SETPROPERTIES_FAILED (0x00000032) // Failed to apply one or more registry properties +#define CM_PROB_WAITING_ON_DEPENDENCY (0x00000033) // Device is stalled waiting on a dependency to start +#define CM_PROB_UNSIGNED_DRIVER (0x00000034) // Failed load driver due to unsigned image. +#define CM_PROB_USED_BY_DEBUGGER (0x00000035) // Device is being used by kernel debugger +#define CM_PROB_DEVICE_RESET (0x00000036) // Device is being reset +#define CM_PROB_CONSOLE_LOCKED (0x00000037) // Device is blocked while console is locked +#define CM_PROB_NEED_CLASS_CONFIG (0x00000038) // Device needs extended class configuration to start +#define CM_PROB_GUEST_ASSIGNMENT_FAILED (0x00000039) // Assignment to guest partition failed + +#define NUM_CM_PROB_V1 (0x00000025) +#define NUM_CM_PROB_V2 (0x00000032) +#define NUM_CM_PROB_V3 (0x00000033) +#define NUM_CM_PROB_V4 (0x00000034) +#define NUM_CM_PROB_V5 (0x00000035) +#define NUM_CM_PROB_V6 (0x00000036) +#define NUM_CM_PROB_V7 (0x00000037) +#define NUM_CM_PROB_V8 (0x00000039) +#define NUM_CM_PROB_V9 (0x0000003A) + +#if (NTDDI_VERSION >= NTDDI_WIN10_VB) + +#define NUM_CM_PROB NUM_CM_PROB_V9 + +#elif (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +#define NUM_CM_PROB NUM_CM_PROB_V8 + +#elif (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define NUM_CM_PROB NUM_CM_PROB_V7 + +#elif (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define NUM_CM_PROB NUM_CM_PROB_V6 + +#elif (NTDDI_VERSION >= NTDDI_WIN7) + +#define NUM_CM_PROB NUM_CM_PROB_V5 + +#elif (NTDDI_VERSION >= NTDDI_WS08) + +#define NUM_CM_PROB NUM_CM_PROB_V4 + +#elif (NTDDI_VERSION >= NTDDI_WS03) + +#define NUM_CM_PROB NUM_CM_PROB_V3 + +#elif (NTDDI_VERSION >= NTDDI_WINXP) + +#define NUM_CM_PROB NUM_CM_PROB_V2 + +#elif (NTDDI_VERSION >= WIN2K) + +#define NUM_CM_PROB NUM_CM_PROB_V1 + +#endif + +// +// Device Instance status flags, returned by call to CM_Get_DevInst_Status +// +#define DN_ROOT_ENUMERATED (0x00000001) // Was enumerated by ROOT +#define DN_DRIVER_LOADED (0x00000002) // Has Register_Device_Driver +#define DN_ENUM_LOADED (0x00000004) // Has Register_Enumerator +#define DN_STARTED (0x00000008) // Is currently configured +#define DN_MANUAL (0x00000010) // Manually installed +#define DN_NEED_TO_ENUM (0x00000020) // May need reenumeration +#define DN_NOT_FIRST_TIME (0x00000040) // Has received a config +#define DN_HARDWARE_ENUM (0x00000080) // Enum generates hardware ID +#define DN_LIAR (0x00000100) // Lied about can reconfig once +#define DN_HAS_MARK (0x00000200) // Not CM_Create_DevInst lately +#define DN_HAS_PROBLEM (0x00000400) // Need device installer +#define DN_FILTERED (0x00000800) // Is filtered +#define DN_MOVED (0x00001000) // Has been moved +#define DN_DISABLEABLE (0x00002000) // Can be disabled +#define DN_REMOVABLE (0x00004000) // Can be removed +#define DN_PRIVATE_PROBLEM (0x00008000) // Has a private problem +#define DN_MF_PARENT (0x00010000) // Multi function parent +#define DN_MF_CHILD (0x00020000) // Multi function child +#define DN_WILL_BE_REMOVED (0x00040000) // DevInst is being removed + +// +// Windows 4 OPK2 Flags +// +#define DN_NOT_FIRST_TIMEE 0x00080000 // S: Has received a config enumerate +#define DN_STOP_FREE_RES 0x00100000 // S: When child is stopped, free resources +#define DN_REBAL_CANDIDATE 0x00200000 // S: Don't skip during rebalance +#define DN_BAD_PARTIAL 0x00400000 // S: This devnode's log_confs do not have same resources +#define DN_NT_ENUMERATOR 0x00800000 // S: This devnode's is an NT enumerator +#define DN_NT_DRIVER 0x01000000 // S: This devnode's is an NT driver +// +// Windows 4.1 Flags +// +#define DN_NEEDS_LOCKING 0x02000000 // S: Devnode need lock resume processing +#define DN_ARM_WAKEUP 0x04000000 // S: Devnode can be the wakeup device +#define DN_APM_ENUMERATOR 0x08000000 // S: APM aware enumerator +#define DN_APM_DRIVER 0x10000000 // S: APM aware driver +#define DN_SILENT_INSTALL 0x20000000 // S: Silent install +#define DN_NO_SHOW_IN_DM 0x40000000 // S: No show in device manager +#define DN_BOOT_LOG_PROB 0x80000000 // S: Had a problem during preassignment of boot log conf + +// +// Windows NT Flags +// +// These are overloaded on top of unused Win 9X flags +// + +#if (NTDDI_VERSION >= NTDDI_WIN2K) + +#define DN_NEED_RESTART DN_LIAR // System needs to be restarted for this Devnode to work properly + +#endif + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define DN_DRIVER_BLOCKED DN_NOT_FIRST_TIME // One or more drivers are blocked from loading for this Devnode +#define DN_LEGACY_DRIVER DN_MOVED // This device is using a legacy driver +#define DN_CHILD_WITH_INVALID_ID DN_HAS_MARK // One or more children have invalid ID(s) + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define DN_DEVICE_DISCONNECTED DN_NEEDS_LOCKING // The function driver for a device reported that the device is not connected. Typically this means a wireless device is out of range. + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10) + +#define DN_QUERY_REMOVE_PENDING DN_MF_PARENT // Device is part of a set of related devices collectively pending query-removal +#define DN_QUERY_REMOVE_ACTIVE DN_MF_CHILD // Device is actively engaged in a query-remove IRP + +#endif + +#define DN_CHANGEABLE_FLAGS (DN_NOT_FIRST_TIME+\ + DN_HARDWARE_ENUM+\ + DN_HAS_MARK+\ + DN_DISABLEABLE+\ + DN_REMOVABLE+\ + DN_MF_CHILD+\ + DN_MF_PARENT+\ + DN_NOT_FIRST_TIMEE+\ + DN_STOP_FREE_RES+\ + DN_REBAL_CANDIDATE+\ + DN_NT_ENUMERATOR+\ + DN_NT_DRIVER+\ + DN_SILENT_INSTALL+\ + DN_NO_SHOW_IN_DM) + +// +// Logical configuration Priority values +// +// These priority values are used in user-mode calls to CM_Add_Empty_Log_Conf. +// Drivers may also specify priority values for a given IO_RESOURCE_LIST +// structure by including a ConfigData member union as the first +// IO_RESOURCE_DESCRIPTOR in the IO_RESOURCE_LIST. In this case, the descriptor +// type would be CmResourceTypeConfigData. +// +#define LCPRI_FORCECONFIG (0x00000000) // Coming from a forced config +#define LCPRI_BOOTCONFIG (0x00000001) // Coming from a boot config +#define LCPRI_DESIRED (0x00002000) // Preferable (better performance) +#define LCPRI_NORMAL (0x00003000) // Workable (acceptable performance) +#define LCPRI_LASTBESTCONFIG (0x00003FFF) // CM only--do not use +#define LCPRI_SUBOPTIMAL (0x00005000) // Not desired, but will work +#define LCPRI_LASTSOFTCONFIG (0x00007FFF) // CM only--do not use +#define LCPRI_RESTART (0x00008000) // Need to restart +#define LCPRI_REBOOT (0x00009000) // Need to reboot +#define LCPRI_POWEROFF (0x0000A000) // Need to shutdown/power-off +#define LCPRI_HARDRECONFIG (0x0000C000) // Need to change a jumper +#define LCPRI_HARDWIRED (0x0000E000) // Cannot be changed +#define LCPRI_IMPOSSIBLE (0x0000F000) // Impossible configuration +#define LCPRI_DISABLED (0x0000FFFF) // Disabled configuration +#define MAX_LCPRI (0x0000FFFF) // Maximum known LC Priority + +// +// Device panel sides +// +#define CM_DEVICE_PANEL_SIDE_UNKNOWN (0x00000000) +#define CM_DEVICE_PANEL_SIDE_TOP (0x00000001) +#define CM_DEVICE_PANEL_SIDE_BOTTOM (0x00000002) +#define CM_DEVICE_PANEL_SIDE_LEFT (0x00000003) +#define CM_DEVICE_PANEL_SIDE_RIGHT (0x00000004) +#define CM_DEVICE_PANEL_SIDE_FRONT (0x00000005) +#define CM_DEVICE_PANEL_SIDE_BACK (0x00000006) + +// +// Device panel edges +// +#define CM_DEVICE_PANEL_EDGE_UNKNOWN (0x00000000) +#define CM_DEVICE_PANEL_EDGE_TOP (0x00000001) +#define CM_DEVICE_PANEL_EDGE_BOTTOM (0x00000002) +#define CM_DEVICE_PANEL_EDGE_LEFT (0x00000003) +#define CM_DEVICE_PANEL_EDGE_RIGHT (0x00000004) + +// +// Device panel shapes +// +#define CM_DEVICE_PANEL_SHAPE_UNKNOWN (0x00000000) +#define CM_DEVICE_PANEL_SHAPE_RECTANGLE (0x00000001) +#define CM_DEVICE_PANEL_SHAPE_OVAL (0x00000002) + +// +// Device panel orientations +// +#define CM_DEVICE_PANEL_ORIENTATION_HORIZONTAL (0x00000000) +#define CM_DEVICE_PANEL_ORIENTATION_VERTICAL (0x00000001) + +// +// Device panel joint types +// +#define CM_DEVICE_PANEL_JOINT_TYPE_UNKNOWN (0x00000000) +#define CM_DEVICE_PANEL_JOINT_TYPE_PLANAR (0x00000001) +#define CM_DEVICE_PANEL_JOINT_TYPE_HINGE (0x00000002) +#define CM_DEVICE_PANEL_JOINT_TYPE_PIVOT (0x00000003) +#define CM_DEVICE_PANEL_JOINT_TYPE_SWIVEL (0x00000004) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef _MSC_VER +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif +#endif + +#endif // _CFG_INCLUDED_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfs.h new file mode 100644 index 0000000000000000000000000000000000000000..f987975a89405374c64a0196662b55a9d24eb6ce --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfs.h @@ -0,0 +1,1311 @@ +/*============================================================================= + + Copyright (c) 1998 Microsoft Corporation + + Module Name: + + clfs.h + + Abstract: + + Header file containing all publicly defined data structures for the + common log file system. + + Author: + + Dexter Bradshaw [DexterB] 09-Dec-1998 + + + Revision History: + +=============================================================================*/ + +#include + +#pragma region Desktop Family or BootableSku Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_BOOTABLESKU) + +// begin_wdm +#ifndef _CLFS_PUBLIC_H_ +#define _CLFS_PUBLIC_H_ +// end_wdm + +// begin_wdm +#if !defined(CLFSUSER_API) + +#if defined(__CLFSUSER_EXPORTS__) +#define CLFSUSER_API +#else +#define CLFSUSER_API __declspec(dllimport) +#endif + +#endif +// end_wdm + +#ifndef CLFS_KERNEL_MODE + +#include + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// PFILE +// +// Define PFILE to be a pointer to _iobuf * +// + +typedef FILE *PFILE, **PPFILE; +typedef DWORD CLFSSTATUS; + +# define ClfsLsnEqual LsnEqual +# define ClfsLsnLess LsnLess +# define ClfsLsnGreater LsnGreater +# define ClfsLsnNull LsnNull +# define ClfsLsnCreate LsnCreate +# define ClfsLsnContainer LsnContainer +# define ClfsLsnBlockOffset LsnBlockOffset +# define ClfsLsnRecordSequence LsnRecordSequence +# define ClfsLsnInvalid LsnInvalid +# define ClfsLsnIncrement LsnIncrement + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* CLFS_KERNEL_MODE */ + +// begin_wdm + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) + +// +// FILE_ATTRIBUTE_DEDICATED is defined as FILE_ATTRIBUTE_TEMPORARY. +// + +#define FILE_ATTRIBUTE_DEDICATED FILE_ATTRIBUTE_TEMPORARY + +// +// Container name and container size extended attribute entry names. +// + +#define EA_CONTAINER_NAME "ContainerName" +#define EA_CONTAINER_SIZE "ContainerSize" + +// +// Base log file name 3-letter extension. +// + +#define CLFS_BASELOG_EXTENSION L".blf" + +// +// Common log file system public flags and constants. +// + +#define CLFS_FLAG_NO_FLAGS 0x00000000 // No flags. +#define CLFS_FLAG_FORCE_APPEND 0x00000001 // Flag to force an append to log queue +#define CLFS_FLAG_FORCE_FLUSH 0x00000002 // Flag to force a log flush +#define CLFS_FLAG_USE_RESERVATION 0x00000004 // Flag to charge a data append to reservation +#define CLFS_FLAG_REENTRANT_FILE_SYSTEM 0x00000008 // Kernel mode create flag indicating a re-entrant file system. +#define CLFS_FLAG_NON_REENTRANT_FILTER 0x00000010 // Kernel mode create flag indicating non-reentrant filter. +#define CLFS_FLAG_REENTRANT_FILTER 0x00000020 // Kernel mode create flag indicating reentrant filter. +#define CLFS_FLAG_IGNORE_SHARE_ACCESS 0x00000040 // Kernel mode create flag indicating IO_IGNORE_SHARE_ACCESS_CHECK semantics. +#define CLFS_FLAG_READ_IN_PROGRESS 0x00000080 // Flag indicating read in progress and not completed. +#define CLFS_FLAG_MINIFILTER_LEVEL 0x00000100 // Kernel mode create flag indicating mini-filter target. +#define CLFS_FLAG_HIDDEN_SYSTEM_LOG 0x00000200 // Kernel mode create flag indicating the log and containers should be marked hidden & system. +// CLFS_FLAG_MAX_VALUE 0x00800000 // Highest value allowed for public flags. +/* NOTE that the uppper 8 bits of CLFS_FLAG values are reserved for internal use. */ +// +// Marshalling Context Flag +// +#define CLFS_MARSHALLING_FLAG_NONE 0x00000000 // No flags +#define CLFS_MARSHALLING_FLAG_DISABLE_BUFF_INIT 0x00000001 // Flag to disable mashalling buffer intialization + +// +// Flag indicating all CLFS I/O will be targeted to an intermediate level of the I/O stack +// + +#define CLFS_FLAG_FILTER_INTERMEDIATE_LEVEL CLFS_FLAG_NON_REENTRANT_FILTER + +// +// Flag indicating all CLFS I/O will be targeted to the top level of the I/O stack +// + +#define CLFS_FLAG_FILTER_TOP_LEVEL CLFS_FLAG_REENTRANT_FILTER + +// +// CLFS_CONTAINER_INDEX +// +// Index into the container table. +// + +typedef ULONG CLFS_CONTAINER_ID; +typedef CLFS_CONTAINER_ID *PCLFS_CONTAINER_ID; +typedef CLFS_CONTAINER_ID **PPCLFS_CONTAINER_ID; + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#ifdef __CLFS_PRIVATE_LSN__ + +#include + +#else + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) + +// +// CLS_LSN +// + +typedef struct _CLS_LSN +{ + + ULONGLONG Internal; + +} CLS_LSN, *PCLS_LSN, **PPCLS_LSN; + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* __CLFS_PRIVATE_LSN__ */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) + +// +// Alias CLS prefixed types with CLFS prefixes. +// + +typedef CLS_LSN CLFS_LSN; +typedef CLFS_LSN *PCLFS_LSN, **PPCLFS_LSN; + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#ifdef __cplusplus +extern "C" +{ +#endif /* __cplusplus */ + +// end_wdm + +// +// Definition of special LSN's: CLFS_LSN_INVALID and CLFS_LSN_NULL. Note that +// [CLFS_LSN_NULL, CLFS_LSN_INVALID) define the only valid LSN range. LSN values +// are strictly monotonic increasing. +// +#ifdef CLFS_KERNEL_MODE + +#if defined __CLFS_SUPPORT_LIBRARY__ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +extern const CLFS_LSN CLFS_LSN_INVALID; +extern const CLFS_LSN CLFS_LSN_NULL; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#elif defined __CLFSUSER_EXPORTS__ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +extern __declspec(dllexport) const CLFS_LSN CLFS_LSN_INVALID; +extern __declspec(dllexport) const CLFS_LSN CLFS_LSN_NULL; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +# else + +// begin_wdm +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +extern __declspec(dllimport) const CLFS_LSN CLFS_LSN_INVALID; +extern __declspec(dllimport) const CLFS_LSN CLFS_LSN_NULL; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ +// end_wdm + +# endif /* __CLFSUSER_EXPORTS__ */ + +#else + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +extern CLFSUSER_API const CLFS_LSN CLFS_LSN_INVALID; +extern CLFSUSER_API const CLFS_LSN CLFS_LSN_NULL; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* CLFS_KERNEL_MODE */ + +// begin_wdm + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) + +// +// CLS_RECORD_TYPE +// +// Definition of record types. +// + +#ifdef __cplusplus + +const UCHAR ClfsNullRecord = 0x00; // Null record type. +const UCHAR ClfsDataRecord = 0x01; // Client data record. +const UCHAR ClfsRestartRecord = 0x02; // Restart record. + + +// Valid client records are restart and data records. + +const UCHAR ClfsClientRecord = 0x03; + +#else + +#define ClfsNullRecord 0x00 // Null record type. +#define ClfsDataRecord 0x01 // Client data record. +#define ClfsRestartRecord 0x02 // Restart record. + + +// Valid client records are restart and data records. + +#define ClfsClientRecord (ClfsDataRecord|ClfsRestartRecord) + +#endif /* _cplusplus */ + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Log container path prefix indicating the log container's location is +// actually a stream inside of the BLF. +// + +#ifdef _cplusplus + +const LPCWSTR CLFS_CONTAINER_STREAM_PREFIX = L"%BLF%:" + +#else + +#define CLFS_CONTAINER_STREAM_PREFIX L"%BLF%:" + +#endif /* _cplusplus */ + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Log container path prefix indicating the log container's location is +// relative to the base log file (BLF) and not an absolute path. +// Paths which do not being with said prefix are absolute paths. +// + +#ifdef _cplusplus + +const LPCWSTR CLFS_CONTAINER_RELATIVE_PREFIX = L"%BLF%\\" + +#else + +#define CLFS_CONTAINER_RELATIVE_PREFIX L"%BLF%\\" + +#endif /* _cplusplus */ + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Alias CLS prefix with CLFS prefixes. +// + +typedef UCHAR CLS_RECORD_TYPE, *PCLS_RECORD_TYPE, **PPCLS_RECORD_TYPE; +typedef CLS_RECORD_TYPE CLFS_RECORD_TYPE, *PCLFS_RECORD_TYPE, **PPCLFS_RECORD_TYPE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_CONTEXT_MODE +// +// The context mode specifies the direction and access methods used to scan the +// log file. +// + +typedef enum _CLS_CONTEXT_MODE +{ + ClsContextNone = 0x00, + ClsContextUndoNext, + ClsContextPrevious, + ClsContextForward + +} CLS_CONTEXT_MODE, *PCLS_CONTEXT_MODE, **PPCLS_CONTEXT_MODE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef enum _CLFS_CONTEXT_MODE +{ + ClfsContextNone = 0x00, + ClfsContextUndoNext, + ClfsContextPrevious, + ClfsContextForward + +} CLFS_CONTEXT_MODE, *PCLFS_CONTEXT_MODE, **PPCLFS_CONTEXT_MODE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFSD_NODE_ID +// +// Common log file system node identifier. Every CLFS file system +// structure has a node identity and type. The node type is a signature +// field while the size is used in for consistency checking. +// + +typedef struct _CLFS_NODE_ID +{ + ULONG cType; // CLFS node type. + ULONG cbNode; // CLFS node size. + +} CLFS_NODE_ID, *PCLFS_NODE_ID; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_WRITE_ENTRY +// +// Write entry specifying the contents of a user buffer and length that are +// marshaled in the space reservation and append interface of the CLS API. +// + +typedef struct _CLS_WRITE_ENTRY +{ + PVOID Buffer; + ULONG ByteLength; +} CLS_WRITE_ENTRY, *PCLS_WRITE_ENTRY, **PPCLS_WRITE_ENTRY; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_WRITE_ENTRY CLFS_WRITE_ENTRY; +typedef CLFS_WRITE_ENTRY *PCLFS_WRITE_ENTRY, **PPCLFS_WRITE_ENTRY; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_LOG_ID +// +// A log identifier is a GUID that describes uniquely a physical log file. +// + +typedef GUID CLFS_LOG_ID; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_INFORMATION +// +// Logical log file information structure describing either virtual or physical log +// file data, depending on the type of information queried. +// + +typedef struct _CLS_INFORMATION +{ + LONGLONG TotalAvailable; // Total log data space available. + LONGLONG CurrentAvailable; // Usable space in the log file. + LONGLONG TotalReservation; // Space reserved for UNDO's (aggregate for physical log) + ULONGLONG BaseFileSize; // Size of the base log file. + ULONGLONG ContainerSize; // Uniform size of log containers. + ULONG TotalContainers; // Total number of containers. + ULONG FreeContainers; // Number of containers not in active log. + ULONG TotalClients; // Total number of clients. + ULONG Attributes; // Log file attributes. + ULONG FlushThreshold; // Log file flush threshold. + ULONG SectorSize; // Underlying container sector size. + CLS_LSN MinArchiveTailLsn; // Marks the global archive tail. + CLS_LSN BaseLsn; // Start of the active log region. + CLS_LSN LastFlushedLsn; // Last flushed LSN in active log. + CLS_LSN LastLsn; // End of active log region. + CLS_LSN RestartLsn; // Location of restart record. + GUID Identity; // Unique identifier for the log. +} CLS_INFORMATION, *PCLS_INFORMATION, *PPCLS_INFORMATION; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Alias CLS prefixes with CLS prefixes. +// + +typedef CLS_INFORMATION CLFS_INFORMATION; +typedef CLFS_INFORMATION *PCLFS_INFORMATION, *PPCLFS_INFORMATION; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ +/* +// +// CLFS_CLIENT_INFORMATION +// +// The client information structure maintains client-based log metadata. +// + +typedef struct _CLS_CLIENT_INFORMATION +{ + CLS_INFORMATION ClfsInfo; // Contains base log file information. + ULONG ClientAttributes; // Virtual log file attributes. + LONGLONG ClientUndoCommitment; // Max. undo commitment for client. + CLS_LSN ClientArchiveTailLsn; // Marks the client archive tail. + CLS_LSN ClientBaseLsn; // Min. client LSN in active log region. + CLS_LSN ClientLastLsn; // Max. client LSN in active log region. + CLS_LSN ClientRestartLsn; // Location of restart record. + +} CLS_CLIENT_INFORMATION, *PCLS_CLIENT_INFORMATION, **PPCLS_CLIENT_INFORMATION; + +// +// Alias CLS prefixes with CLS prefixes. +// + +typedef CLS_CLIENT_INFORMATION CLFS_CLIENT_INFORMATION; +typedef CLFS_CLIENT_INFORMATION *PCLFS_CLIENT_INFORMATION, *PPCLFS_CLIENT_INFORMATION; +*/ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_LOG_NAME_INFORMATION +// +// The client information structure stores the name of a log. It is used +// to communicate ClfsLogNameInformation and ClfsLogPhysicalNameInformation. +// + +typedef struct _CLFS_LOG_NAME_INFORMATION +{ + + USHORT NameLengthInBytes; + WCHAR Name[1]; + +} CLFS_LOG_NAME_INFORMATION, *PCLFS_LOG_NAME_INFORMATION, **PPCLFS_LOG_NAME_INFORMATION; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_STREAM_ID_INFORMATION +// +// The client information structure provides a permanent identifier unique +// to the log for the stream in question. +// + +typedef struct _CLFS_STREAM_ID_INFORMATION +{ + + UCHAR StreamIdentifier; + +} CLFS_STREAM_ID_INFORMATION, *PCLFS_STREAM_ID_INFORMATION, **PPCLFS_STREAM_ID_INFORMATION; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_VISTA) || (_WIN32_WINNT >= _WIN32_WINNT_LONGHORN) +// +// CLFS_PHYSICAL_LSN_INFORMATION +// +// An information structure that describes a virtual:physical LSN pairing +// for the stream identified in the structure. +// +#pragma pack(push,8) +typedef struct _CLFS_PHYSICAL_LSN_INFORMATION +{ + UCHAR StreamIdentifier; + CLFS_LSN VirtualLsn; + CLFS_LSN PhysicalLsn; + +} CLFS_PHYSICAL_LSN_INFORMATION, *PCLFS_PHYSICAL_LSN_INFORMATION; +#pragma pack(pop) +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_CONTAINER_STATE +// +// At any point in time a container could be inactive or uninitialized, active, +// pending deletion from the list of free containers, pending archival, or +// pending deletion while waiting to be archived. +// + +typedef UINT32 CLS_CONTAINER_STATE, *PCLS_CONTAINER_STATE, *PPCLS_CONTAINER_STATE; +typedef CLS_CONTAINER_STATE CLFS_CONTAINER_STATE, *PCLFS_CONTAINER_STATE, *PPCLFS_CONTAINER_STATE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#ifdef __cplusplus + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +const CLFS_CONTAINER_STATE ClsContainerInitializing = 0x01; +const CLFS_CONTAINER_STATE ClsContainerInactive = 0x02; +const CLFS_CONTAINER_STATE ClsContainerActive = 0x04; +const CLFS_CONTAINER_STATE ClsContainerActivePendingDelete = 0x08; +const CLFS_CONTAINER_STATE ClsContainerPendingArchive = 0x10; +const CLFS_CONTAINER_STATE ClsContainerPendingArchiveAndDelete = 0x20; + +const CLFS_CONTAINER_STATE ClfsContainerInitializing = 0x01; +const CLFS_CONTAINER_STATE ClfsContainerInactive = 0x02; +const CLFS_CONTAINER_STATE ClfsContainerActive = 0x04; +const CLFS_CONTAINER_STATE ClfsContainerActivePendingDelete = 0x08; +const CLFS_CONTAINER_STATE ClfsContainerPendingArchive = 0x10; +const CLFS_CONTAINER_STATE ClfsContainerPendingArchiveAndDelete= 0x20; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#else + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +#define ClsContainerInitializing 0x01 +#define ClsContainerInactive 0x02 +#define ClsContainerActive 0x04 +#define ClsContainerActivePendingDelete 0x08 +#define ClsContainerPendingArchive 0x10 +#define ClsContainerPendingArchiveAndDelete 0x20 + +#define ClfsContainerInitializing 0x01 +#define ClfsContainerInactive 0x02 +#define ClfsContainerActive 0x04 +#define ClfsContainerActivePendingDelete 0x08 +#define ClfsContainerPendingArchive 0x10 +#define ClfsContainerPendingArchiveAndDelete 0x20 +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* __cplusplus */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_MAX_CONTAINER_INFO +// +// The maximum length, in bytes, of the FileName field in the CLFS +// container information structure. +// + +#ifdef __cplusplus + +const ULONG CLFS_MAX_CONTAINER_INFO = (256); + +#else + +#define CLFS_MAX_CONTAINER_INFO (256) + +#endif /* __cplusplus */ + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_CONTAINER_INFORMATION +// +// This structure defines a container descriptor. The descriptor specifies the +// container's creation and access times, size, file system name, file system +// attributes, state, minimum, and maximum LSNs. +// + +typedef struct _CLS_CONTAINER_INFORMATION +{ + ULONG FileAttributes; // File system attribute flag. + ULONGLONG CreationTime; // File creation time. + ULONGLONG LastAccessTime; // Last time container was read/written. + ULONGLONG LastWriteTime; // Last time container was written. + LONGLONG ContainerSize; // Size of container in bytes. + ULONG FileNameActualLength; // Length of the actual file name. + ULONG FileNameLength; // Length of file name in buffer + WCHAR FileName [CLFS_MAX_CONTAINER_INFO];// File system name for container. + CLFS_CONTAINER_STATE State; // Current state of the container. + CLFS_CONTAINER_ID PhysicalContainerId; // Physical container identifier. + CLFS_CONTAINER_ID LogicalContainerId; // Logical container identifier. + +} CLS_CONTAINER_INFORMATION, *PCLS_CONTAINER_INFORMATION, **PPCLS_CONTAINER_INFORMATION; + +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_CONTAINER_INFORMATION CLFS_CONTAINER_INFORMATION; +typedef CLFS_CONTAINER_INFORMATION *PCLFS_CONTAINER_INFORMATION, **PPCLFS_CONTAINER_INFORMATION; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_LOG_INFORMATION_CLASS +// +// The information class specifies the kind of information a caller +// wishes to query or set on a log file. +// + +typedef enum _CLS_LOG_INFORMATION_CLASS +{ + + ClfsLogBasicInformation = 0x00, // For virtual or physical logs, indicates the respective basic information. + ClfsLogBasicInformationPhysical, // Always indicates physical log basic information. + ClfsLogPhysicalNameInformation, // Always indicates physical name information. + ClfsLogStreamIdentifierInformation, // Virtual/physical log agnostic. +#if (NTDDI_VERSION >= NTDDI_VISTA) || (_WIN32_WINNT >= _WIN32_WINNT_LONGHORN) + ClfsLogSystemMarkingInformation, // Count of system marking references. + ClfsLogPhysicalLsnInformation // Maps virtual LSNs to physical LSNs; only valid for physical logs. +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +} CLS_LOG_INFORMATION_CLASS, *PCLS_LOG_INFORMATION_CLASS, **PPCLS_LOG_INFORMATION_CLASS; + +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_LOG_INFORMATION_CLASS CLFS_LOG_INFORMATION_CLASS; +typedef CLFS_LOG_INFORMATION_CLASS *PCLFS_LOG_INFORMATION_CLASS, **PPCLFS_LOG_INFORMATION_CLASS; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_IOSTATS_CLASS +// +// Enumerated type defining the class of I/O statistics. +// + +typedef enum _CLS_IOSTATS_CLASS +{ + ClsIoStatsDefault = 0x0000, + ClsIoStatsMax = 0xFFFF + +} CLS_IOSTATS_CLASS, *PCLS_IOSTATS_CLASS, **PPCLS_IOSTATS_CLASS; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_IOSTATS_CLASS +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef enum _CLFS_IOSTATS_CLASS +{ + ClfsIoStatsDefault = 0x0000, + ClfsIoStatsMax = 0xFFFF + +} CLFS_IOSTATS_CLASS, *PCLFS_IOSTATS_CLASS, **PPCLFS_IOSTATS_CLASS; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_IO_STATISTICS +// +// This structure defines I/O performance counters particular to a log file. It consists +// of a header followed by the I/O statistics counters. The header is being ignored for +// now. +// + +typedef struct _CLS_IO_STATISTICS_HEADER +{ + UCHAR ubMajorVersion; // Major version of the statistics buffer. + UCHAR ubMinorVersion; // Minor version of the statistics buffer. + CLFS_IOSTATS_CLASS eStatsClass; // I/O statistics class. + USHORT cbLength; // Length of the statistics buffer. + ULONG coffData; // Offset of statistics counters. + +} CLS_IO_STATISTICS_HEADER, *PCLS_IO_STATISTICS_HEADER, **PPCLS_IO_STATISTICS_HEADER; + +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_IO_STATISTICS_HEADER CLFS_IO_STATISTICS_HEADER; +typedef CLFS_IO_STATISTICS_HEADER *PCLFS_IO_STATISTICS_HEADER, **PPCLFS_IO_STATISTICS_HEADER; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +typedef struct _CLS_IO_STATISTICS +{ + CLS_IO_STATISTICS_HEADER hdrIoStats; // Statistics buffer header. + ULONGLONG cFlush; // Flush count. + ULONGLONG cbFlush; // Cumulative number of bytes flushed. + ULONGLONG cMetaFlush; // Metadata flush count. + ULONGLONG cbMetaFlush; // Cumulative number of metadata bytes flushed. + +} CLS_IO_STATISTICS, *PCLS_IO_STATISTICS, **PPCLS_IO_STATISTICS; + +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_IO_STATISTICS CLFS_IO_STATISTICS; +typedef CLFS_IO_STATISTICS *PCLFS_IO_STATISTICS, **PPCLFS_IO_STATISTICS; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_SCAN_MODE +// +// Container scan mode flags. +// + +#ifdef __cplusplus + +const UCHAR CLFS_SCAN_INIT = 0x01; +const UCHAR CLFS_SCAN_FORWARD = 0x02; +const UCHAR CLFS_SCAN_BACKWARD = 0x04; +const UCHAR CLFS_SCAN_CLOSE = 0x08; +const UCHAR CLFS_SCAN_INITIALIZED = 0x10; +const UCHAR CLFS_SCAN_BUFFERED = 0x20; + +#else + +#define CLFS_SCAN_INIT 0x01 +#define CLFS_SCAN_FORWARD 0x02 +#define CLFS_SCAN_BACKWARD 0x04 +#define CLFS_SCAN_CLOSE 0x08 +#define CLFS_SCAN_INITIALIZED 0x10 +#define CLFS_SCAN_BUFFERED 0x20 + +#endif + +typedef UCHAR CLFS_SCAN_MODE, *PCLFS_SCAN_MODE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +// end_wdm + +#ifdef CLFS_KERNEL_MODE + +// begin_wdm +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) + +// +// CLFS_SCAN_CONTEXT +// +// Container scan context for scanning all containers in a given physical log +// file. +// + +// +// The log file object wraps an NT file object and the size of the structure. +// The log file object may be modified in the near future and there should be no +// dependencies on the size of the structure itself. +// + +typedef FILE_OBJECT LOG_FILE_OBJECT, *PLOG_FILE_OBJECT, **PPLOG_FILE_OBJECT; + +#if defined(_MSC_VER) +#if (_MSC_VER >= 1200) +#pragma warning(push) +#pragma warning(disable:4324) // structure padded due to __declspec(align()) +#endif +#endif + +typedef struct _CLS_SCAN_CONTEXT +{ + CLFS_NODE_ID cidNode; + PLOG_FILE_OBJECT plfoLog; + __declspec(align(8)) ULONG cIndex; + __declspec(align(8)) ULONG cContainers; + __declspec(align(8)) ULONG cContainersReturned; + __declspec(align(8)) CLFS_SCAN_MODE eScanMode; + __declspec(align(8)) PCLS_CONTAINER_INFORMATION pinfoContainer; + +} CLS_SCAN_CONTEXT, *PCLS_SCAN_CONTEXT, **PPCLS_SCAN_CONTEXT; + +#if defined(_MSC_VER) +#if (_MSC_VER >= 1200) +#pragma warning(pop) +#endif +#endif + +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +// end_wdm + +#else + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +typedef struct _CLS_SCAN_CONTEXT +{ + CLFS_NODE_ID cidNode; + HANDLE hLog; + __declspec(align(8)) ULONG cIndex; + __declspec(align(8)) ULONG cContainers; + __declspec(align(8)) ULONG cContainersReturned; + __declspec(align(8)) CLFS_SCAN_MODE eScanMode; + __declspec(align(8)) PCLS_CONTAINER_INFORMATION pinfoContainer; + +} CLS_SCAN_CONTEXT, *PCLS_SCAN_CONTEXT, **PPCLS_SCAN_CONTEXT; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* CLFS_KERNEL_MODE */ + +// begin_wdm + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// Alias all CLS prefixes with CLFS prefixes. +// + +typedef CLS_SCAN_CONTEXT CLFS_SCAN_CONTEXT; +typedef CLFS_SCAN_CONTEXT *PCLFS_SCAN_CONTEXT, **PPCLFS_SCAN_CONTEXT; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_ARCHIVE_DESCRIPTOR +// +// Log archive descriptors describe the set of discrete but logically +// contiguous disk extents comprising a snapshot of the active log when +// preparing for archival. Log archive descriptors specify enough information +// for log archive clients directly access the relevant contents of containers +// for archiving and restoring a snapshot of the log. +// + +typedef struct _CLS_ARCHIVE_DESCRIPTOR +{ + ULONGLONG coffLow; + ULONGLONG coffHigh; + CLS_CONTAINER_INFORMATION infoContainer; + +} CLS_ARCHIVE_DESCRIPTOR, *PCLS_ARCHIVE_DESCRIPTOR, **PPCLS_ARCHIVE_DESCRIPTOR; + +// +// Alias CLS prefixes with CLFS prefixes. +// + +typedef CLS_ARCHIVE_DESCRIPTOR CLFS_ARCHIVE_DESCRIPTOR; +typedef CLFS_ARCHIVE_DESCRIPTOR *PCLFS_ARCHIVE_DESCRIPTOR, **PPCLFS_ARCHIVE_DESCRIPTOR; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_ALLOCATION_ROUTINE +// +// Allocate a blocks for marshaled reads or writes +// + +typedef PVOID (* CLFS_BLOCK_ALLOCATION) (ULONG cbBufferLength, PVOID pvUserContext); + +// +// CLFS_DEALLOCATION_ROUTINE +// +// Deallocate buffers allocated by the CLFS_ALLOCATION_ROUTINE. +// + +typedef void (* CLFS_BLOCK_DEALLOCATION) (PVOID pvBuffer, PVOID pvUserContext); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_LOG_ARCHIVE_MODE +// +// Describes the archive support behavior for the log. +// + +typedef enum _CLFS_LOG_ARCHIVE_MODE +{ + + ClfsLogArchiveEnabled = 0x01, + ClfsLogArchiveDisabled = 0x02 + +} CLFS_LOG_ARCHIVE_MODE, *PCLFS_LOG_ARCHIVE_MODE; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +//----------------------------------------------------------------------------- +// LSN OPERATORS +//----------------------------------------------------------------------------- + +#ifdef __cplusplus +extern "C" +{ +#endif + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnEqual +// +// Method Description: +// +// Check for the equivalence of LSNs. +// +// Arguments: +// +// plsn1 -- first LSN comparator +// plsn2 -- second LSN comparator +// +// +// Return Value: +// +// TRUE if LSN values are equivalent and FALSE otherwise. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API BOOLEAN NTAPI +ClfsLsnEqual +( + _In_ const CLFS_LSN* plsn1, + _In_ const CLFS_LSN* plsn2 +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnLess +// +// Method Description: +// +// Check if LSN1 is less than LSN2. +// +// Arguments: +// +// plsn1 -- first LSN comparator +// plsn2 -- second LSN comparator +// +// +// Return Value: +// +// TRUE if LSN1 is less than LSN2 and FALSE otherwise. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API BOOLEAN NTAPI +ClfsLsnLess +( + _In_ const CLFS_LSN* plsn1, + _In_ const CLFS_LSN* plsn2 +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnGreater +// +// Method Description: +// +// Check if LSN1 is greater than LSN2. +// +// Arguments: +// +// plsn1 -- first LSN comparator +// plsn2 -- second LSN comparator +// +// +// Return Value: +// +// TRUE if LSN1 is greater than LSN2 and FALSE otherwise. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API BOOLEAN NTAPI +ClfsLsnGreater +( + _In_ const CLFS_LSN* plsn1, + _In_ const CLFS_LSN* plsn2 +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnNull (Inline) +// +// Method Description: +// +// Check whether or not an LSN is CLFS_LSN_NULL. +// +// Arguments: +// +// plsn -- reference to LSN tested against the NULL value. +// +// +// Return Value: +// +// TRUE if and only if an LSN is equivalent to CLFS_LSN_NULL. +// LSNs with the value CLFS_LSN_INVALID will return FALSE. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API BOOLEAN NTAPI +ClfsLsnNull +( + _In_ const CLFS_LSN* plsn +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnContainer (Inline) +// +// Routine Description: +// +// Extract the container identifier from the LSN. +// +// Arguments: +// +// plsn -- get block offset from this LSN +// +// Return Value: +// +// Returns the container identifier for the LSN. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API CLFS_CONTAINER_ID NTAPI +ClfsLsnContainer +( + _In_ const CLFS_LSN* plsn +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnCreate (Inline) +// +// Routine Description: +// +// Create an LSN given a log identifier, a container identifier, a block +// offset and a bucket identifier. Caller must test for invalid LSN after +// making this call. +// +// Arguments: +// +// cidContainer -- container identifier +// offBlock -- block offset +// cRecord -- ordinal number of the record in block +// +// Return Value: +// +// Returns a valid LSN if successful, otherwise it returns +// CLFS_LSN_INVALID +// +//----------------------------------------------------------------------------- + +CLFSUSER_API CLFS_LSN NTAPI +ClfsLsnCreate +( + _In_ CLFS_CONTAINER_ID cidContainer, + _In_ ULONG offBlock, + _In_ ULONG cRecord +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnBlockOffset (Inline) +// +// Routine Description: +// +// Extract the block offset from the LSN. +// +// Arguments: +// +// plsn -- get block offset from this LSN +// +// Return Value: +// +// Returns the block offset for the LSN. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API ULONG NTAPI +ClfsLsnBlockOffset +( + _In_ const CLFS_LSN* plsn +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnRecordSequence (Inline) +// +// Routine Description: +// +// Extract the bucket identifier from the LSN. +// +// Arguments: +// +// plsn -- get block offset from this LSN +// +// Return Value: +// +// Returns the bucket identifier for the LSN. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API ULONG NTAPI +ClfsLsnRecordSequence +( + _In_ const CLFS_LSN* plsn +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnInvalid +// +// Method Description: +// +// Check whether or not an LSN is CLFS_LSN_INVALID. +// +// Arguments: +// +// plsn -- reference to LSN tested against CLFS_LSN_INVALID. +// +// +// Return Value: +// +// TRUE if and only if an LSN is equivalent to CLFS_LSN_INVALID. +// LSNs with the value CLFS_LSN_NULL will return FALSE. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API BOOLEAN NTAPI +ClfsLsnInvalid +( + _In_ const CLFS_LSN* plsn +); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +//----------------------------------------------------------------------------- +// ClfsLsnIncrement +// +// Method Description: +// +// Increment and LSN by 1 +// +// Arguments: +// +// plsn -- LSN to be incremented. +// +// +// Return Value: +// +// A valid LSN next in sequence to the input LSN, if successful. +// Otherwise, this function returns CLFS_LSN_INVALID. +// +//----------------------------------------------------------------------------- + +CLFSUSER_API CLFS_LSN NTAPI +ClfsLsnIncrement (_In_ PCLFS_LSN plsn); +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#ifdef __cplusplus +} +#endif + +#ifdef __cplusplus + +#ifdef CLFS_OPERATORS + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// LSN arithmetic increment operator. +// + +inline CLFS_LSN +operator++ +( + _Inout_ CLFS_LSN& refLsn +) +{ + // + // Prefix increment operator. + // + + refLsn = ClfsLsnIncrement (&refLsn); + return refLsn; +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// BOOLEAN LSN operators. +// + +inline BOOLEAN +operator< +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (ClfsLsnLess ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +inline BOOLEAN +operator> +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (ClfsLsnGreater ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +inline BOOLEAN +operator== +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (ClfsLsnEqual ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +inline BOOLEAN +operator!= +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (!ClfsLsnEqual ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +inline BOOLEAN +operator<= +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (!ClfsLsnGreater ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +inline BOOLEAN +operator>= +( + _In_ const CLFS_LSN& refLsn1, + _In_ const CLFS_LSN& refLsn2 +) +{ + return (!ClfsLsnLess ((PCLFS_LSN) &refLsn1, (PCLFS_LSN) &refLsn2)); +} +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* CLFS_OPERATORS */ + +#endif /* __cplusplus */ + + +#endif /* _CLFS_PUBLIC_H_ */ +// end_wdm + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_BOOTABLESKU) */ +#pragma endregion + +//----------------------------------------------------------------------------- +// END OF FILE +//----------------------------------------------------------------------------- + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfslsn.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfslsn.h new file mode 100644 index 0000000000000000000000000000000000000000..066056373c97924bd238faf69cf93cf63fc7a063 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/clfslsn.h @@ -0,0 +1,94 @@ +#include + +/*============================================================================= + + Copyright (c) 1998 Microsoft Corporation + + Module Name: + + clfslsn.h + + Abstract: + + Header file containing the private definition for the common log + file system's log sequence number structure. + + Author: + + Dexter Bradshaw [DexterB] 09-Dec-1998 + + + Revision History: + +=============================================================================*/ + +#ifndef _CLFS_LSN_H_ +#define _CLFS_LSN_H_ + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLFS_RECORD_INDEX +// +// Log record offset on container file. The log record offset consists of a block +// offset in the container and a bucket identifier indexing the records in the block. +// Declared up here because including clfs_x.h will try to define the LSN, which needs +// this. +// + +typedef UINT32 CLFS_RECORD_INDEX; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) || (_WIN32_WINNT >= _WIN32_WINNT_WS03) +// +// CLS_LSN +// +// The log sequence number (LSN) is a valid log file address. The LSN consists of +// three (3) parts: (a) a log identifier to identify which physical log the log record +// belongs to, (b) a container index identifying the log container where the log record +// lies, and (c) a record offset identified by the offset of the block in the container +// and an ordinal number for the record within the container. +// +// +// The structure of the LSN poses some inherent limitations of the number of logs, +// the number of containers, the size of a container, and the number of log records in +// a log block. +// +// Maximum number of physical log files is 64K. +// Maximum number of container identifiers is 4G. +// Maximum size of a container is 4G. +// Maximum number of sector-aligned log blocks is 8M +// Maximum number of record buckets in a log block is 512 +// + +typedef union _CLS_LSN +{ + // + // Container identifier + // + + struct + { + CLFS_RECORD_INDEX idxRecord; // Record offset on container. + CLFS_CONTAINER_ID cidContainer; // Container identifier. + } offset; + + __volatile ULONGLONG ullOffset; // Sequence number within physical log. + +} CLS_LSN, *PCLS_LSN, **PPCLS_LSN; + +// +// Alias CLS prefixed types with CLFS prefixes. +// + +typedef CLS_LSN CLFS_LSN; +typedef CLFS_LSN *PCLFS_LSN, **PPCLFS_LSN; +#endif /* NTDDI_VERSION || _WIN32_WINNT */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/common.ver b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/common.ver new file mode 100644 index 0000000000000000000000000000000000000000..53d210e4e3554ee5842abffe43d7068b9505667a --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/common.ver @@ -0,0 +1,269 @@ + +/*---------------------------------------------------------------*/ +/* */ +/* The following section actually creates the version structure. */ +/* They are ignored if we are not being invoked by RC. */ +/* */ +/* ntverp.H must be included before including this file */ +/* */ +/* If VER_LEGALCOPYRIGHT_STR is not defined, it will be */ +/* constructed using VER_LEGALCOPYRIGHT_YEARS, so at least one */ +/* these macros must be defined before including this file. */ +/* */ +/* VER_FILETYPE, VER_FILESUBTYPE, VER_FILEDESCRIPTION_STR, and */ +/* VER_INTERNALNAME_STR must be defined before including this */ +/* file. */ +/* */ +/* If VER_FILEVERSION is not defined, VER_PRODUCTVERSION will be */ +/* used instead. If VER_FILEVERSION_STR is not defined, */ +/* VER_PRODUCTVERSION_STR will be used instead. */ +/* */ +/* If VER_ORIGINALFILENAME_STR is not defined, it is set to */ +/* the value in VER_INTERNALNAME_STR. */ +/* */ +/* If INTL is defined, then this is assumed to be an */ +/* an international build; two string blocks will be created, */ +/* (since all version resources must have English), and the */ +/* second one can be localized */ +/* */ +/*---------------------------------------------------------------*/ + + +/**************************************************************** + When updating the copy right year Please Make sure you also update the + constant VER_LEGALCOPYRIGHT_STR_WITH_YEARS below +*****************************************************************/ +#ifndef VER_LEGALCOPYRIGHT_YEARS +#define VER_LEGALCOPYRIGHT_YEARS "2021" +#endif + +#ifndef VER_LEGALCOPYRIGHT_STR_WITH_YEARS +#define VER_LEGALCOPYRIGHT_STR_WITH_YEARS L"\251 2021 Microsoft Corporation. All rights reserved." +#endif + +#ifndef VER_LEGALCOPYRIGHT_STR +#if defined(RC_INVOKED) && !defined(WIN16) +#define VER_LEGALCOPYRIGHT_STR L"\251 Microsoft Corporation. All rights reserved." +#else +#define VER_LEGALCOPYRIGHT_STR "Copyright (c) Microsoft Corporation. All rights reserved." +#endif +#endif + + +#ifndef VER_PRODUCTNAME_STR +#ifdef RC_INVOKED +#define VER_PRODUCTNAME_STR L"Microsoft\256 Windows\256 Operating System" +#else +#define VER_PRODUCTNAME_STR "Microsoft (R) Windows (R) Operating System" +#endif +#endif + +#ifndef VER_PRODUCTVERSION +#define VER_PRODUCTVERSION 5,00,01,001 +#endif + +#ifndef VER_FILEVERSION +#define VER_FILEVERSION VER_PRODUCTVERSION +#endif + +#ifndef VER_PRODUCTVERSION_STR +#define VER_PRODUCTVERSION_STR "5.00" +#endif + +#ifndef VER_FILEVERSION_STR +#define VER_FILEVERSION_STR VER_PRODUCTVERSION_STR +#endif + +#ifndef VER_ORIGINALFILENAME_STR +#define VER_ORIGINALFILENAME_STR VER_INTERNALNAME_STR +#endif + +#ifdef EXPORT_CONTROLLED + +#ifdef EXPORT +#define EXPORT_TAG " (Export Version)" +#else +#define EXPORT_TAG " (US/Canada Only, Not for Export)" +#endif + +#else /* Not Export Controlled */ + +#define EXPORT_TAG + +#endif + +#if defined(__BUILDMACHINE__) + +#if (defined(_NEED_FULLVERSION_INFO) || !defined(OFFICIAL_BUILD)) + #if defined(__BUILDDATE__) + #define B2(x,y) " (" #x "." #y ")" + #define B1(x,y) B2(x, y) + #if (defined(_NEED_FULLVERSION_INFO) && defined(OFFICIAL_BUILD) && defined(_BUILDBRANCH)) + #define BUILD_MACHINE_TAG B1(_BUILDBRANCH, __BUILDDATE__) + #else + #define BUILD_MACHINE_TAG B1(__BUILDMACHINE__, __BUILDDATE__) + #endif + #else + #define B2(x) " (" #x ".160101.0800)" + #define B1(x) B2(x) + #define BUILD_MACHINE_TAG B1(__BUILDMACHINE__) + #endif +#else + #define BUILD_MACHINE_TAG " (WinBuild.160101.0800)" +#endif + +#if defined(__BUILDMACHINE_LEN__) +#if __BUILDMACHINE_LEN__ >= 25 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG +#elif __BUILDMACHINE_LEN__ == 24 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 23 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 22 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 21 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 20 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 19 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 18 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 17 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 16 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 15 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 14 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 13 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 12 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 11 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 10 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 9 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 8 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 7 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 6 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 5 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 4 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 3 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 2 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#elif __BUILDMACHINE_LEN__ == 1 +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG " " +#else +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG +#endif +#else +#define BUILD_MACHINE_TAG_PADDED BUILD_MACHINE_TAG +#endif +#else +#define BUILD_MACHINE_TAG +#define BUILD_MACHINE_TAG_PADDED +#endif + +#ifdef VER_LANGNEUTRAL + #ifndef VER_VERSION_UNICODE_LANG + #define VER_VERSION_UNICODE_LANG "000004B0" /* LANG_NEUTRAL/SUBLANG_NEUTRAL, Unicode CP */ + #endif + #ifndef VER_VERSION_ANSI_LANG + #define VER_VERSION_ANSI_LANG "000004E4" /* LANG_NEUTRAL/SUBLANG_NEUTRAL, Ansi CP */ + #endif + #ifndef VER_VERSION_TRANSLATION + #define VER_VERSION_TRANSLATION 0x0000, 0x04B0 + #endif +#else + #ifndef VER_VERSION_UNICODE_LANG + #define VER_VERSION_UNICODE_LANG "040904B0" /* LANG_ENGLISH/SUBLANG_ENGLISH_US, Unicode CP */ + #endif + #ifndef VER_VERSION_ANSI_LANG + #define VER_VERSION_ANSI_LANG "0c0904E4" /* LANG_ENGLISH/SUBLANG_ENGLISH_US, Ansi CP */ + #endif + #ifndef VER_VERSION_TRANSLATION + #define VER_VERSION_TRANSLATION 0x0409, 0x04B0 + #endif +#endif + + +#ifdef SMP_ID +#define VER_SAMPLE_IDENTIFIER_STR SMP_ID +#endif + +#ifndef VER_SAMPLE_IDENTIFIER +#define VER_SAMPLE_IDENTIFIER "SAMPLE_IDENTIFIER" +#endif + +#ifdef VER_SAMPLE_IDENTIFIER_STR +resname RCDATA +{ + VER_SAMPLE_IDENTIFIER, + VER_SAMPLE_IDENTIFIER_STR +} +#endif + + +#ifdef RC_INVOKED + +VS_VERSION_INFO VERSIONINFO +FILEVERSION VER_FILEVERSION +PRODUCTVERSION VER_PRODUCTVERSION +FILEFLAGSMASK VER_FILEFLAGSMASK +FILEFLAGS VER_FILEFLAGS +FILEOS VER_FILEOS +FILETYPE VER_FILETYPE +FILESUBTYPE VER_FILESUBTYPE +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK VER_VERSION_UNICODE_LANG + BEGIN + VALUE "CompanyName", VER_COMPANYNAME_STR + VALUE "FileDescription", VER_FILEDESCRIPTION_STR EXPORT_TAG + VALUE "FileVersion", VER_FILEVERSION_STR BUILD_MACHINE_TAG_PADDED + VALUE "InternalName", VER_INTERNALNAME_STR + VALUE "LegalCopyright", VER_LEGALCOPYRIGHT_STR + VALUE "OriginalFilename",VER_ORIGINALFILENAME_STR + VALUE "ProductName", VER_PRODUCTNAME_STR + VALUE "ProductVersion", VER_PRODUCTVERSION_STR +#ifdef VER_OLESELFREGISTER + VALUE "OleSelfRegister", "\0" +#endif + END + +#ifdef VER_ANSICP /* Some apps are hard coded to look for ANSI CP. */ + BLOCK VER_VERSION_ANSI_LANG + BEGIN + VALUE "CompanyName", VER_COMPANYNAME_STR + VALUE "FileDescription", VER_FILEDESCRIPTION_STR EXPORT_TAG + VALUE "FileVersion", VER_FILEVERSION_STR + VALUE "InternalName", VER_INTERNALNAME_STR + VALUE "LegalCopyright", VER_LEGALCOPYRIGHT_STR + VALUE "OriginalFilename",VER_ORIGINALFILENAME_STR + VALUE "ProductName", VER_PRODUCTNAME_STR + VALUE "ProductVersion", VER_PRODUCTVERSION_STR +#ifdef VER_OLESELFREGISTER + VALUE "OleSelfRegister", "\0" +#endif + END +#endif + END + + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", VER_VERSION_TRANSLATION + END +END + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/concurrencysal.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/concurrencysal.h new file mode 100644 index 0000000000000000000000000000000000000000..9a2fe697dea7b0018795c93bb4cb09bcd6e05fa0 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/concurrencysal.h @@ -0,0 +1,394 @@ +/*** +*concurrencysal.h - markers for documenting the concurrent semantics of APIs +* +* Copyright (c) Microsoft Corporation. All rights reserved. +* +*Purpose: +* This file contains macros for Concurrency SAL annotations. Definitions +* starting with _Internal are low level macros that are subject to change. +* Users should not use those low level macros directly. +* [ANSI] +* +* [Public] +* +****/ + +#ifndef CONCURRENCYSAL_H +#define CONCURRENCYSAL_H + +#pragma once + +#ifdef __cplusplus // [ +extern "C" { +#endif // ] + +#if !defined(__midl) && defined(_PREFAST_) && !defined(_SDV_) + +__ANNOTATION(SAL_guarded_by(__deferTypecheck void *)); +__ANNOTATION(SAL_write_guarded_by(__deferTypecheck void *)); +__ANNOTATION(SAL_requires_lock_held(__deferTypecheck void *)); +__ANNOTATION(SAL_requires_exclusive_lock_held(__deferTypecheck void *)); +__ANNOTATION(SAL_requires_shared_lock_held(__deferTypecheck void *)); +__ANNOTATION(SAL_requires_lock_not_held(__deferTypecheck void *)); +__ANNOTATION(SAL_requires_no_locks_held(void)); +__ANNOTATION(SAL_set_lock_count_to_zero(__deferTypecheck void *)); +__ANNOTATION(SAL_set_lock_count_to_one(__deferTypecheck void *)); +__ANNOTATION(SAL_acquires_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_acquires_exclusive_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_acquires_shared_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_releases_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_releases_exclusive_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_releases_shared_lock(__deferTypecheck void *)); +__ANNOTATION(SAL_ignore_lock_match(__deferTypecheck void *)); +__ANNOTATION(SAL_has_lock_property(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_has_lock_level(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_lock_level_order(__deferTypecheck void *, __deferTypecheck void *)); +__ANNOTATION(SAL_no_competing_thread(void)); +__ANNOTATION(SAL_set_same_lock(__deferTypecheck void *, __deferTypecheck void *)); + +/* + * pre-defined global system locks + */ +extern int _Global_interlock_; +extern int _Global_cancel_spin_lock_; +extern int _Global_critical_region_; + +/* + * Annotation identifiers + */ +#define _Internal_create_CSAL_identifier_(id) const char id[] = ""; + +_Internal_create_CSAL_identifier_(_Lock_kind_mutex_) +_Internal_create_CSAL_identifier_(_Lock_kind_event_) +_Internal_create_CSAL_identifier_(_Lock_kind_semaphore_) +_Internal_create_CSAL_identifier_(_Lock_kind_spin_lock_) +_Internal_create_CSAL_identifier_(_Lock_kind_critical_section_) + +/* + * data protection + */ +#define _Guarded_by_(lock) _SAL2_Source_(_Guarded_by_, (lock), _SA_annotes1(SAL_guarded_by,lock)) +#define _Write_guarded_by_(lock) _SAL2_Source_(_Write_guarded_by_, (lock), _SA_annotes1(SAL_write_guarded_by,lock)) +#define _Interlocked_ _Guarded_by_(_Global_interlock_) + +/* + * interlocked operand used in interlocked instructions + */ +#ifndef _Interlocked_operand_ +#define _Interlocked_operand_ _SAL2_Source_(_Interlocked_operand_, (), _Pre_ _SA_annotes0(SAL_interlocked)) +#endif + +/* + * caller/callee locking contracts + */ +#define _Requires_lock_held_(lock) _SAL2_Source_(_Requires_lock_held_, (lock), _Pre_ _SA_annotes1(SAL_requires_lock_held,lock)) +#define _Requires_exclusive_lock_held_(lock) _SAL2_Source_(_Requires_exclusive_lock_held_, (lock), _Pre_ _SA_annotes1(SAL_requires_exclusive_lock_held,lock)) +#define _Requires_shared_lock_held_(lock) _SAL2_Source_(_Requires_shared_lock_held_, (lock), _Pre_ _SA_annotes1(SAL_requires_shared_lock_held,lock)) + +#define _Requires_lock_not_held_(lock) _SAL2_Source_(_Requires_lock_not_held_, (lock), _Pre_ _SA_annotes1(SAL_requires_lock_not_held,lock)) +#define _Requires_no_locks_held_ _SAL2_Source_(_Requires_no_locks_held_, (), _Pre_ _SA_annotes0(SAL_requires_no_locks_held)) + +/* + * acquire/release locking side effects + */ +#define _Acquires_lock_(lock) _SAL2_Source_(_Acquires_lock_, (lock), _Post_ _SA_annotes1(SAL_acquires_lock,lock)) +#define _Acquires_exclusive_lock_(lock) _SAL2_Source_(_Acquires_exclusive_lock_, (lock), _Post_ _SA_annotes1(SAL_acquires_exclusive_lock,lock)) +#define _Acquires_shared_lock_(lock) _SAL2_Source_(_Acquires_shared_lock_, (lock), _Post_ _SA_annotes1(SAL_acquires_shared_lock,lock)) + +#define _Releases_lock_(lock) _SAL2_Source_(_Releases_lock_, (lock), _Post_ _SA_annotes1(SAL_releases_lock,lock)) +#define _Releases_exclusive_lock_(lock) _SAL2_Source_(_Releases_exclusive_lock_, (lock), _Post_ _SA_annotes1(SAL_releases_exclusive_lock,lock)) +#define _Releases_shared_lock_(lock) _SAL2_Source_(_Releases_shared_lock_, (lock), _Post_ _SA_annotes1(SAL_releases_shared_lock,lock)) + +/* + * acquire/release locking side effects for non-reentrant locks + */ +#define _Acquires_nonreentrant_lock_(lock) \ + _SAL2_Source_(_Acquires_nonreentrant_lock_, (lock), \ + _Requires_lock_not_held_(lock) \ + _Acquires_lock_(lock)) + +#define _Releases_nonreentrant_lock_(lock) \ + _SAL2_Source_(_Releases_nonreentrant_lock_, (lock), \ + _Requires_lock_held_(lock) \ + _Releases_lock_(lock)) + +#define _Post_same_lock_(a,b) _SAL2_Source_(_Post_same_lock_, (a,b), _Post_ _SA_annotes2(SAL_set_same_lock,a,b)) + +/* + * lock level + */ +#define _Create_lock_level_(level) _Internal_create_CSAL_identifier_(level) + +#define _Has_lock_level_(level) _SAL2_Source_(_Has_lock_level_, (level), _SA_annotes1(SAL_has_lock_level,#level)) + +#define _Internal_lock_level_order_(a,b) _SAL2_Source_(_Internal_lock_level_order_, (a,b), _SA_annotes2(SAL_lock_level_order,a,b)) +#define _Csalcat1_(x,y) x##y +#define _Csalcat2_(x,y) _Csalcat1_(x,y) + +#define _Lock_level_order_(a,b) \ + extern _Internal_lock_level_order_(a,b) void _Sal_order_##a##_##b(_In_z_ const char*a, _In_z_ const char*b); \ + static __inline void CSALCAT2(CSAL_LockOrder,__COUNTER__)(void){_Sal_order_##a##_##b(#a,#b);} + +/* + * threading context + */ +#define _No_competing_thread_ _SAL2_Source_(_No_competing_thread_, (), _Pre_ _SA_annotes0(SAL_no_competing_thread)) + +/* + * refinement and suppression + */ +extern _Acquires_lock_(*plock) void _Internal_acquires_lock_(void* plock); +extern _Releases_lock_(*plock) void _Internal_releases_lock_(void* plock); + +#define _Internal_set_lock_count_to_zero_(lock) _SAL2_Source_(Internal_set_lock_count_to_zero_, (lock), _Post_ _SA_annotes1(SAL_set_lock_count_to_zero,lock)) +#define _Internal_set_lock_count_to_one_(lock) _SAL2_Source_(_Internal_set_lock_count_to_one_, (lock), _Post_ _SA_annotes1(SAL_set_lock_count_to_one,lock)) + +extern _Internal_set_lock_count_to_one_(*plock) void _Internal_lock_held_(void* plock); +extern _Internal_set_lock_count_to_zero_(*plock) void _Internal_lock_not_held_(void* plock); +extern _Post_same_lock_(*plock1, *plock2) void _Internal_same_lock_(void* plock1, void* plock2); + +#define _Analysis_assume_lock_acquired_(lock) _Internal_acquires_lock_((void*)(&(lock))) +#define _Analysis_assume_lock_released_(lock) _Internal_releases_lock_((void*)(&(lock))) + +#define _Analysis_assume_lock_held_(lock) _Internal_lock_held_((void*)(&(lock))) +#define _Analysis_assume_lock_not_held_(lock) _Internal_lock_not_held_((void*)(&(lock))) +#define _Analysis_assume_same_lock_(lock1, lock2) _Internal_same_lock_((void*)(&(lock1)), (void*)(&(lock2))) + +/* + * _Function_ignore_lock_checking_ may be deprecated in future versions of SAL + */ +#define _Function_ignore_lock_checking_(lock) _SAL2_Source_(_Function_ignore_lock_checking_, (lock), _Pre_ _SA_annotes1(SAL_ignore_lock_match,lock)) +extern _Function_ignore_lock_checking_(*plock) void _Internal_suppress_lock_checking_(void* plock); + +/* + * _Analysis_suppress_lock_checking_ may be deprecated in future versions of SAL + */ +#define _Analysis_suppress_lock_checking_(lock) _Internal_suppress_lock_checking_((void*)(&(lock))); + +#define _Benign_race_begin_ __pragma(warning(push)) __pragma(warning(disable:26100 26101 26150 26130 26180 26131 26181 28112)) +#define _Benign_race_end_ __pragma(warning(pop)) + +#define _No_competing_thread_begin_ __pragma(warning(push)) __pragma(warning(disable:26100 26101 26150 26101 26151 26110 26160 26130 26180 26131 26181 28112)) +#define _No_competing_thread_end_ __pragma(warning(pop)) + +/* + * lock kinds + */ +#define _Has_lock_kind_(kind) _SAL2_Source_(_Has_lock_kind_, (kind), _SA_annotes1(SAL_has_lock_property,#kind)) + +/* + * smart locks (RAII lock wrappers) + */ +#ifdef __cplusplus +} // extern "C" + +extern "C++" +{ + template _Acquires_lock_(_smartLock) void _Internal_acquires_smart_lock_(const _SmartLockType& _smartLock); + template _Releases_lock_(_smartLock) void _Internal_releases_smart_lock_(const _SmartLockType& _smartLock); +} // extern "C++" + +#define _Analysis_assume_smart_lock_acquired_(lock) _Internal_acquires_smart_lock_((lock)) +#define _Analysis_assume_smart_lock_released_(lock) _Internal_releases_smart_lock_((lock)) + +extern "C" { +#endif + +/* + * move semantics + */ +#define _Internal_swap_lock_ 0 + +#define _Detaches_lock_(detached, lock) _Post_same_lock_(_Internal_swap_lock_, (lock)) _Post_same_lock_((detached), _Internal_swap_lock_) +#define _Moves_lock_(target, source) _Post_same_lock_(_Internal_swap_lock_, (source)) _Post_same_lock_((target), _Internal_swap_lock_) +#define _Replaces_lock_(target, source) _Post_same_lock_(_Internal_swap_lock_, (target)) _Post_same_lock_((target), (source)) _Releases_lock_(_Internal_swap_lock_) +#define _Swaps_locks_(left, right) _Post_same_lock_(_Internal_swap_lock_, (left)) _Post_same_lock_((left), (right)) _Post_same_lock_((right), _Internal_swap_lock_) + +/* + * Old spelling + * Note: the old version may be deprecated in the future!!! + */ +extern int __system_interlock; +extern int __system_cancel_spinlock; +extern int __system_critical_region; + +#define __guarded_by(lock) _SAL1_1_Source_(__guarded_by, (lock), _SA_annotes1(SAL_guarded_by,lock)) +#define __write_guarded_by(lock) _SAL1_1_Source_(__write_guarded_by, (lock), _SA_annotes1(SAL_write_guarded_by,lock)) +#define __interlocked __guarded_by(_Global_interlock_) + +/* + * caller/callee locking contracts + */ +#define __requires_lock_held(lock) _SAL1_1_Source_(__requires_lock_held, (lock), __pre _SA_annotes1(SAL_requires_lock_held,lock)) +#define __requires_exclusive_lock_held(lock) _SAL1_1_Source_(__requires_exclusive_lock_held, (lock), __pre _SA_annotes1(SAL_requires_exclusive_lock_held,lock)) +#define __requires_shared_lock_held(lock) _SAL1_1_Source_(__requires_shared_lock_held, (lock), __pre _SA_annotes1(SAL_requires_shared_lock_held,lock)) + +#define __requires_lock_not_held(lock) _SAL1_1_Source_(__requires_lock_not_held, (lock), __pre _SA_annotes1(SAL_requires_lock_not_held,lock)) +#define __requires_no_locks_held _SAL1_1_Source_(__requires_no_locks_held, (), __pre _SA_annotes0(SAL_requires_no_locks_held)) + +/* + * acquire/release locking side effects + */ +#define __acquires_lock(lock) _SAL1_1_Source_(__acquires_lock, (lock), __post _SA_annotes1(SAL_acquires_lock,lock)) +#define __acquires_exclusive_lock(lock) _SAL1_1_Source_(__acquires_exclusive_lock, (lock), __post _SA_annotes1(SAL_acquires_exclusive_lock,lock)) +#define __acquires_shared_lock(lock) _SAL1_1_Source_(__acquires_shared_lock, (lock), __post _SA_annotes1(SAL_acquires_shared_lock,lock)) + +#define __releases_lock(lock) _SAL1_1_Source_(__releases_lock, (lock), __post _SA_annotes1(SAL_releases_lock,lock)) +#define __releases_exclusive_lock(lock) _SAL1_1_Source_(__releases_exclusive_lock, (lock),__post _SA_annotes1(SAL_releases_exclusive_lock,lock)) +#define __releases_shared_lock(lock) _SAL1_1_Source_(__releases_shared_lock, (lock), __post _SA_annotes1(SAL_releases_shared_lock,lock)) + +/* + * lock properties + * The following kind options are supported: + * __has_lock_property(MUTEX) + * __has_lock_property(EVENT) + * __has_lock_property(SEMAPHORE) + * __has_lock_property(OTHER_HANDLE) + * __has_lock_property(REENTRANT) + * __has_lock_property(NON_REENTRANT) + */ +#define __has_lock_property(kind) _SAL1_1_Source_(__has_lock_property, (kind), _SA_annotes1(SAL_has_lock_property,#kind)) + +/* + * lock level + */ +#define __declare_lock_level(level) _Internal_create_CSAL_identifier_(level) +#define __has_lock_level(level) _SAL1_1_Source_(__has_lock_level, (level), _SA_annotes1(SAL_has_lock_level,#level)) + +#define __internal_lock_level_order(a,b) _SAL1_1_Source_(__internal_lock_level_order, (a,b), _SA_annotes2(SAL_lock_level_order,#a,#b)) +#define CSALCAT1(x,y) x##y +#define CSALCAT2(x,y) CSALCAT1(x,y) + +#define __lock_level_order(a,b) \ + extern __internal_lock_level_order(a,b) void __sal_order_##a##_##b(__in_z char*a, __in_z char*b); \ + static __inline void CSALCAT2(CSAL_LockOrder,__COUNTER__)(void){__sal_order_##a##_##b(#a,#b);} + +/* + * threading context + */ +#define __no_competing_thread _SAL1_1_Source_(__no_competing_thread, (), __pre _SA_annotes0(SAL_no_competing_thread)) + +/* + * refinement and suppression + */ +extern __acquires_lock(*plock) void __internal_acquires_lock(void* plock); +extern __releases_lock(*plock) void __internal_releases_lock(void* plock); + +#define __analysis_assume_lock_acquired(lock) __internal_acquires_lock((void*)(&(lock))) +#define __analysis_assume_lock_released(lock) __internal_releases_lock((void*)(&(lock))) + +#define __function_ignore_lock_checking(lock) _SAL1_1_Source_(__function_ignore_lock_cleanup, (lock), __pre _SA_annotes1(SAL_ignore_lock_match,lock)) +extern __function_ignore_lock_checking(*plock) void __internal_suppress_lock_checking(void* plock); + +#define __analysis_suppress_lock_checking(lock) __internal_suppress_lock_checking((void*)(&(lock))); + +#define BENIGN_RACE_BEGIN __pragma(warning(push)) __pragma(warning(disable:26100 26150 26130 26180 26131 26181)) +#define BENIGN_RACE_END __pragma(warning(pop)) + +#define NO_COMPETING_THREAD_BEGIN __pragma(warning(push)) __pragma(warning(disable:26100 26150 26101 26151 26110 26160 26130 26180 26131 26181)) +#define NO_COMPETING_THREAD_END __pragma(warning(pop)) + +#else + +#ifndef _Interlocked_operand_ +#define _Interlocked_operand_ +#endif + +#define _Guarded_by_(lock) +#define _Write_guarded_by_(lock) +#define _Interlocked_ +#define _Requires_lock_held_(lock) +#define _Requires_exclusive_lock_held_(lock) +#define _Requires_shared_lock_held_(lock) +#define _Requires_lock_not_held_(lock) +#define _Requires_no_locks_held_ +#define _Acquires_lock_(lock) +#define _Acquires_exclusive_lock_(lock) +#define _Acquires_shared_lock_(lock) +#define _Releases_lock_(lock) +#define _Releases_exclusive_lock_(lock) +#define _Releases_shared_lock_(lock) +#define _Acquires_nonreentrant_lock_(lock) +#define _Releases_nonreentrant_lock_(lock) + +#define _Post_same_lock_(lock1,lock2) + +#define _Internal_set_lock_count_(lock, count) + +#define _Create_lock_level_(level) +#define _Has_lock_level_(level) +#define _Internal_lock_level_order_(a,b) +#define _Csalcat1_(x,y) +#define _Csalcat2_(x,y) +#define _Lock_level_order_(a,b) +#define _No_competing_thread_ +#define _Analysis_assume_lock_acquired_(lock) +#define _Analysis_assume_lock_released_(lock) +#define _Analysis_assume_lock_held_(lock) +#define _Analysis_assume_lock_not_held_(lock) +#define _Analysis_assume_same_lock_(lock1, lock2) +#define _Function_ignore_lock_checking_(lock) +#define _Analysis_suppress_lock_checking_(lock) + +#define _Benign_race_begin_ __pragma(warning(push)) +#define _Benign_race_end_ __pragma(warning(pop)) + +#define _No_competing_thread_begin_ __pragma(warning(push)) +#define _No_competing_thread_end_ __pragma(warning(pop)) + +#define _Has_lock_kind_(kind) + +#ifdef __cplusplus +#define _Analysis_assume_smart_lock_acquired_(lock) +#define _Analysis_assume_smart_lock_released_(lock) +#endif + +#define _Detaches_lock_(detached, lock) +#define _Moves_lock_(target, source) +#define _Replaces_lock_(target, source) +#define _Swaps_locks_(left, right) + +/* + * Old spelling: will be deprecated + */ +#define __guarded_by(lock) +#define __write_guarded_by(lock) +#define __interlocked +#define __requires_lock_held(lock) +#define __requires_exclusive_lock_held(lock) +#define __requires_shared_lock_held(lock) +#define __requires_lock_not_held(lock) +#define __requires_no_locks_held +#define __acquires_lock(lock) +#define __acquires_exclusive_lock(lock) +#define __acquires_shared_lock(lock) +#define __releases_lock(lock) +#define __releases_exclusive_lock(lock) +#define __releases_shared_lock(lock) + +#define __has_lock_property(kind) +#define __declare_lock_level(level) +#define __has_lock_level(level) +#define __internal_lock_level_order(a,b) +#define CSALCAT1(x,y) +#define CSALCAT2(x,y) +#define __lock_level_order(a,b) +#define __no_competing_thread +#define __analysis_assume_lock_acquired(lock) +#define __analysis_assume_lock_released(lock) +#define __function_ignore_lock_checking(lock) +#define __analysis_suppress_lock_checking(lock) + +#define BENIGN_RACE_BEGIN __pragma(warning(push)) +#define BENIGN_RACE_END __pragma(warning(pop)) + +#define NO_COMPETING_THREAD_BEGIN __pragma(warning(push)) +#define NO_COMPETING_THREAD_END __pragma(warning(pop)) + +#endif + +#ifdef __cplusplus +} +#endif + +#endif // CONCURRENCYSAL_H diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9.h new file mode 100644 index 0000000000000000000000000000000000000000..2558de0a2060222347afbf04d0955bff5b6bac7c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9.h @@ -0,0 +1,2799 @@ +/*==========================================================================; + * + * Copyright (C) Microsoft Corporation. All Rights Reserved. + * + * File: d3d9.h + * Content: Direct3D include file + * + ****************************************************************************/ + +#ifndef _D3D9_H_ +#define _D3D9_H_ + +#ifndef DIRECT3D_VERSION +#define DIRECT3D_VERSION 0x0900 +#endif //DIRECT3D_VERSION + +// include this file content only if compiling for DX9 interfaces +#if(DIRECT3D_VERSION >= 0x0900) + +#include +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/* This identifier is passed to Direct3DCreate9 in order to ensure that an + * application was built against the correct header files. This number is + * incremented whenever a header (or other) change would require applications + * to be rebuilt. If the version doesn't match, Direct3DCreate9 will fail. + * (The number itself has no meaning.)*/ + +#ifdef D3D_DEBUG_INFO +#define D3D_SDK_VERSION (32 | 0x80000000) +#define D3D9b_SDK_VERSION (31 | 0x80000000) + +#else +#define D3D_SDK_VERSION 32 +#define D3D9b_SDK_VERSION 31 +#endif + + +#include + +#define COM_NO_WINDOWS_H +#include + +#include + +#if !defined(HMONITOR_DECLARED) && (WINVER < 0x0500) + #define HMONITOR_DECLARED + DECLARE_HANDLE(HMONITOR); +#endif + +#define D3DAPI WINAPI +/* + * Interface IID's + */ +#if defined( _WIN32 ) && !defined( _NO_COM) + +/* IID_IDirect3D9 */ +/* {81BDCBCA-64D4-426d-AE8D-AD0147F4275C} */ +DEFINE_GUID(IID_IDirect3D9, 0x81bdcbca, 0x64d4, 0x426d, 0xae, 0x8d, 0xad, 0x1, 0x47, 0xf4, 0x27, 0x5c); + +/* IID_IDirect3DDevice9 */ +// {D0223B96-BF7A-43fd-92BD-A43B0D82B9EB} */ +DEFINE_GUID(IID_IDirect3DDevice9, 0xd0223b96, 0xbf7a, 0x43fd, 0x92, 0xbd, 0xa4, 0x3b, 0xd, 0x82, 0xb9, 0xeb); + +/* IID_IDirect3DResource9 */ +// {05EEC05D-8F7D-4362-B999-D1BAF357C704} +DEFINE_GUID(IID_IDirect3DResource9, 0x5eec05d, 0x8f7d, 0x4362, 0xb9, 0x99, 0xd1, 0xba, 0xf3, 0x57, 0xc7, 0x4); + +/* IID_IDirect3DBaseTexture9 */ +/* {580CA87E-1D3C-4d54-991D-B7D3E3C298CE} */ +DEFINE_GUID(IID_IDirect3DBaseTexture9, 0x580ca87e, 0x1d3c, 0x4d54, 0x99, 0x1d, 0xb7, 0xd3, 0xe3, 0xc2, 0x98, 0xce); + +/* IID_IDirect3DTexture9 */ +/* {85C31227-3DE5-4f00-9B3A-F11AC38C18B5} */ +DEFINE_GUID(IID_IDirect3DTexture9, 0x85c31227, 0x3de5, 0x4f00, 0x9b, 0x3a, 0xf1, 0x1a, 0xc3, 0x8c, 0x18, 0xb5); + +/* IID_IDirect3DCubeTexture9 */ +/* {FFF32F81-D953-473a-9223-93D652ABA93F} */ +DEFINE_GUID(IID_IDirect3DCubeTexture9, 0xfff32f81, 0xd953, 0x473a, 0x92, 0x23, 0x93, 0xd6, 0x52, 0xab, 0xa9, 0x3f); + +/* IID_IDirect3DVolumeTexture9 */ +/* {2518526C-E789-4111-A7B9-47EF328D13E6} */ +DEFINE_GUID(IID_IDirect3DVolumeTexture9, 0x2518526c, 0xe789, 0x4111, 0xa7, 0xb9, 0x47, 0xef, 0x32, 0x8d, 0x13, 0xe6); + +/* IID_IDirect3DVertexBuffer9 */ +/* {B64BB1B5-FD70-4df6-BF91-19D0A12455E3} */ +DEFINE_GUID(IID_IDirect3DVertexBuffer9, 0xb64bb1b5, 0xfd70, 0x4df6, 0xbf, 0x91, 0x19, 0xd0, 0xa1, 0x24, 0x55, 0xe3); + +/* IID_IDirect3DIndexBuffer9 */ +/* {7C9DD65E-D3F7-4529-ACEE-785830ACDE35} */ +DEFINE_GUID(IID_IDirect3DIndexBuffer9, 0x7c9dd65e, 0xd3f7, 0x4529, 0xac, 0xee, 0x78, 0x58, 0x30, 0xac, 0xde, 0x35); + +/* IID_IDirect3DSurface9 */ +/* {0CFBAF3A-9FF6-429a-99B3-A2796AF8B89B} */ +DEFINE_GUID(IID_IDirect3DSurface9, 0xcfbaf3a, 0x9ff6, 0x429a, 0x99, 0xb3, 0xa2, 0x79, 0x6a, 0xf8, 0xb8, 0x9b); + +/* IID_IDirect3DVolume9 */ +/* {24F416E6-1F67-4aa7-B88E-D33F6F3128A1} */ +DEFINE_GUID(IID_IDirect3DVolume9, 0x24f416e6, 0x1f67, 0x4aa7, 0xb8, 0x8e, 0xd3, 0x3f, 0x6f, 0x31, 0x28, 0xa1); + +/* IID_IDirect3DSwapChain9 */ +/* {794950F2-ADFC-458a-905E-10A10B0B503B} */ +DEFINE_GUID(IID_IDirect3DSwapChain9, 0x794950f2, 0xadfc, 0x458a, 0x90, 0x5e, 0x10, 0xa1, 0xb, 0xb, 0x50, 0x3b); + +/* IID_IDirect3DVertexDeclaration9 */ +/* {DD13C59C-36FA-4098-A8FB-C7ED39DC8546} */ +DEFINE_GUID(IID_IDirect3DVertexDeclaration9, 0xdd13c59c, 0x36fa, 0x4098, 0xa8, 0xfb, 0xc7, 0xed, 0x39, 0xdc, 0x85, 0x46); + +/* IID_IDirect3DVertexShader9 */ +/* {EFC5557E-6265-4613-8A94-43857889EB36} */ +DEFINE_GUID(IID_IDirect3DVertexShader9, 0xefc5557e, 0x6265, 0x4613, 0x8a, 0x94, 0x43, 0x85, 0x78, 0x89, 0xeb, 0x36); + +/* IID_IDirect3DPixelShader9 */ +/* {6D3BDBDC-5B02-4415-B852-CE5E8BCCB289} */ +DEFINE_GUID(IID_IDirect3DPixelShader9, 0x6d3bdbdc, 0x5b02, 0x4415, 0xb8, 0x52, 0xce, 0x5e, 0x8b, 0xcc, 0xb2, 0x89); + +/* IID_IDirect3DStateBlock9 */ +/* {B07C4FE5-310D-4ba8-A23C-4F0F206F218B} */ +DEFINE_GUID(IID_IDirect3DStateBlock9, 0xb07c4fe5, 0x310d, 0x4ba8, 0xa2, 0x3c, 0x4f, 0xf, 0x20, 0x6f, 0x21, 0x8b); + +/* IID_IDirect3DQuery9 */ +/* {d9771460-a695-4f26-bbd3-27b840b541cc} */ +DEFINE_GUID(IID_IDirect3DQuery9, 0xd9771460, 0xa695, 0x4f26, 0xbb, 0xd3, 0x27, 0xb8, 0x40, 0xb5, 0x41, 0xcc); + + +/* IID_HelperName */ +/* {E4A36723-FDFE-4b22-B146-3C04C07F4CC8} */ +DEFINE_GUID(IID_HelperName, 0xe4a36723, 0xfdfe, 0x4b22, 0xb1, 0x46, 0x3c, 0x4, 0xc0, 0x7f, 0x4c, 0xc8); + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +/* IID_IDirect3D9Ex */ +/* {02177241-69FC-400C-8FF1-93A44DF6861D} */ +DEFINE_GUID(IID_IDirect3D9Ex, 0x02177241, 0x69FC, 0x400C, 0x8F, 0xF1, 0x93, 0xA4, 0x4D, 0xF6, 0x86, 0x1D); + +/* IID_IDirect3DDevice9Ex */ +// {B18B10CE-2649-405a-870F-95F777D4313A} +DEFINE_GUID(IID_IDirect3DDevice9Ex, 0xb18b10ce, 0x2649, 0x405a, 0x87, 0xf, 0x95, 0xf7, 0x77, 0xd4, 0x31, 0x3a); + +/* IID_IDirect3DSwapChain9Ex */ +/* {91886CAF-1C3D-4d2e-A0AB-3E4C7D8D3303} */ +DEFINE_GUID(IID_IDirect3DSwapChain9Ex, 0x91886caf, 0x1c3d, 0x4d2e, 0xa0, 0xab, 0x3e, 0x4c, 0x7d, 0x8d, 0x33, 0x3); + +/* IID_IDirect3D9ExOverlayExtension */ +/* {187aeb13-aaf5-4c59-876d-e059088c0df8} */ +DEFINE_GUID(IID_IDirect3D9ExOverlayExtension, 0x187aeb13, 0xaaf5, 0x4c59, 0x87, 0x6d, 0xe0, 0x59, 0x8, 0x8c, 0xd, 0xf8); + +/* IID_IDirect3DDevice9Video */ +// {26DC4561-A1EE-4ae7-96DA-118A36C0EC95} +DEFINE_GUID(IID_IDirect3DDevice9Video, 0x26dc4561, 0xa1ee, 0x4ae7, 0x96, 0xda, 0x11, 0x8a, 0x36, 0xc0, 0xec, 0x95); + +/* IID_IDirect3D9AuthenticatedChannel */ +// {FF24BEEE-DA21-4beb-98B5-D2F899F98AF9} +DEFINE_GUID(IID_IDirect3DAuthenticatedChannel9, 0xff24beee, 0xda21, 0x4beb, 0x98, 0xb5, 0xd2, 0xf8, 0x99, 0xf9, 0x8a, 0xf9); + +/* IID_IDirect3DCryptoSession9 */ +// {FA0AB799-7A9C-48ca-8C5B-237E71A54434} +DEFINE_GUID(IID_IDirect3DCryptoSession9, 0xfa0ab799, 0x7a9c, 0x48ca, 0x8c, 0x5b, 0x23, 0x7e, 0x71, 0xa5, 0x44, 0x34); + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +#endif + +#ifdef __cplusplus + +#ifndef DECLSPEC_UUID +#if _MSC_VER >= 1100 +#define DECLSPEC_UUID(x) __declspec(uuid(x)) +#else +#define DECLSPEC_UUID(x) +#endif +#endif + +interface DECLSPEC_UUID("81BDCBCA-64D4-426d-AE8D-AD0147F4275C") IDirect3D9; +interface DECLSPEC_UUID("D0223B96-BF7A-43fd-92BD-A43B0D82B9EB") IDirect3DDevice9; + +interface DECLSPEC_UUID("B07C4FE5-310D-4ba8-A23C-4F0F206F218B") IDirect3DStateBlock9; +interface DECLSPEC_UUID("05EEC05D-8F7D-4362-B999-D1BAF357C704") IDirect3DResource9; +interface DECLSPEC_UUID("DD13C59C-36FA-4098-A8FB-C7ED39DC8546") IDirect3DVertexDeclaration9; +interface DECLSPEC_UUID("EFC5557E-6265-4613-8A94-43857889EB36") IDirect3DVertexShader9; +interface DECLSPEC_UUID("6D3BDBDC-5B02-4415-B852-CE5E8BCCB289") IDirect3DPixelShader9; +interface DECLSPEC_UUID("580CA87E-1D3C-4d54-991D-B7D3E3C298CE") IDirect3DBaseTexture9; +interface DECLSPEC_UUID("85C31227-3DE5-4f00-9B3A-F11AC38C18B5") IDirect3DTexture9; +interface DECLSPEC_UUID("2518526C-E789-4111-A7B9-47EF328D13E6") IDirect3DVolumeTexture9; +interface DECLSPEC_UUID("FFF32F81-D953-473a-9223-93D652ABA93F") IDirect3DCubeTexture9; + +interface DECLSPEC_UUID("B64BB1B5-FD70-4df6-BF91-19D0A12455E3") IDirect3DVertexBuffer9; +interface DECLSPEC_UUID("7C9DD65E-D3F7-4529-ACEE-785830ACDE35") IDirect3DIndexBuffer9; + +interface DECLSPEC_UUID("0CFBAF3A-9FF6-429a-99B3-A2796AF8B89B") IDirect3DSurface9; +interface DECLSPEC_UUID("24F416E6-1F67-4aa7-B88E-D33F6F3128A1") IDirect3DVolume9; + +interface DECLSPEC_UUID("794950F2-ADFC-458a-905E-10A10B0B503B") IDirect3DSwapChain9; +interface DECLSPEC_UUID("d9771460-a695-4f26-bbd3-27b840b541cc") IDirect3DQuery9; + + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +interface DECLSPEC_UUID("02177241-69FC-400C-8FF1-93A44DF6861D") IDirect3D9Ex; +interface DECLSPEC_UUID("B18B10CE-2649-405a-870F-95F777D4313A") IDirect3DDevice9Ex; +interface DECLSPEC_UUID("91886CAF-1C3D-4d2e-A0AB-3E4C7D8D3303") IDirect3DSwapChain9Ex; +interface DECLSPEC_UUID("187AEB13-AAF5-4C59-876D-E059088C0DF8") IDirect3D9ExOverlayExtension; +interface DECLSPEC_UUID("26DC4561-A1EE-4ae7-96DA-118A36C0EC95") IDirect3DDevice9Video; +interface DECLSPEC_UUID("FF24BEEE-DA21-4beb-98B5-D2F899F98AF9") IDirect3DAuthenticatedChannel9; +interface DECLSPEC_UUID("FA0AB799-7A9C-48CA-8C5B-237E71A54434") IDirect3DCryptoSession9; + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +#if defined(_COM_SMARTPTR_TYPEDEF) +_COM_SMARTPTR_TYPEDEF(IDirect3D9, __uuidof(IDirect3D9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DDevice9, __uuidof(IDirect3DDevice9)); + +_COM_SMARTPTR_TYPEDEF(IDirect3DStateBlock9, __uuidof(IDirect3DStateBlock9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DResource9, __uuidof(IDirect3DResource9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DVertexDeclaration9, __uuidof(IDirect3DVertexDeclaration9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DVertexShader9, __uuidof(IDirect3DVertexShader9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DPixelShader9, __uuidof(IDirect3DPixelShader9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DBaseTexture9, __uuidof(IDirect3DBaseTexture9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DTexture9, __uuidof(IDirect3DTexture9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DVolumeTexture9, __uuidof(IDirect3DVolumeTexture9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DCubeTexture9, __uuidof(IDirect3DCubeTexture9)); + +_COM_SMARTPTR_TYPEDEF(IDirect3DVertexBuffer9, __uuidof(IDirect3DVertexBuffer9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DIndexBuffer9, __uuidof(IDirect3DIndexBuffer9)); + +_COM_SMARTPTR_TYPEDEF(IDirect3DSurface9, __uuidof(IDirect3DSurface9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DVolume9, __uuidof(IDirect3DVolume9)); + +_COM_SMARTPTR_TYPEDEF(IDirect3DSwapChain9, __uuidof(IDirect3DSwapChain9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DQuery9, __uuidof(IDirect3DQuery9)); + + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +_COM_SMARTPTR_TYPEDEF(IDirect3D9Ex, __uuidof(IDirect3D9Ex)); +_COM_SMARTPTR_TYPEDEF(IDirect3DDevice9Ex, __uuidof(IDirect3DDevice9Ex)); +_COM_SMARTPTR_TYPEDEF(IDirect3DSwapChain9Ex, __uuidof(IDirect3DSwapChain9Ex)); +_COM_SMARTPTR_TYPEDEF(IDirect3D9ExOverlayExtension, __uuidof(IDirect3D9ExOverlayExtension)); +_COM_SMARTPTR_TYPEDEF(IDirect3DDevice9Video, __uuidof(IDirect3DDevice9Video)); +_COM_SMARTPTR_TYPEDEF(IDirect3DAuthenticatedChannel9, __uuidof(IDirect3DAuthenticatedChannel9)); +_COM_SMARTPTR_TYPEDEF(IDirect3DCryptoSession9, __uuidof(IDirect3DCryptoSession9)); + + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +#endif + +#endif + + +typedef interface IDirect3D9 IDirect3D9; +typedef interface IDirect3DDevice9 IDirect3DDevice9; +typedef interface IDirect3DStateBlock9 IDirect3DStateBlock9; +typedef interface IDirect3DVertexDeclaration9 IDirect3DVertexDeclaration9; +typedef interface IDirect3DVertexShader9 IDirect3DVertexShader9; +typedef interface IDirect3DPixelShader9 IDirect3DPixelShader9; +typedef interface IDirect3DResource9 IDirect3DResource9; +typedef interface IDirect3DBaseTexture9 IDirect3DBaseTexture9; +typedef interface IDirect3DTexture9 IDirect3DTexture9; +typedef interface IDirect3DVolumeTexture9 IDirect3DVolumeTexture9; +typedef interface IDirect3DCubeTexture9 IDirect3DCubeTexture9; +typedef interface IDirect3DVertexBuffer9 IDirect3DVertexBuffer9; +typedef interface IDirect3DIndexBuffer9 IDirect3DIndexBuffer9; +typedef interface IDirect3DSurface9 IDirect3DSurface9; +typedef interface IDirect3DVolume9 IDirect3DVolume9; +typedef interface IDirect3DSwapChain9 IDirect3DSwapChain9; +typedef interface IDirect3DQuery9 IDirect3DQuery9; + + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + + +typedef interface IDirect3D9Ex IDirect3D9Ex; +typedef interface IDirect3DDevice9Ex IDirect3DDevice9Ex; +typedef interface IDirect3DSwapChain9Ex IDirect3DSwapChain9Ex; +typedef interface IDirect3D9ExOverlayExtension IDirect3D9ExOverlayExtension; +typedef interface IDirect3DDevice9Video IDirect3DDevice9Video; +typedef interface IDirect3DAuthenticatedChannel9 IDirect3DAuthenticatedChannel9; +typedef interface IDirect3DCryptoSession9 IDirect3DCryptoSession9; + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +#include "d3d9types.h" +#include "d3d9caps.h" + + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * DLL Function for creating a Direct3D9 object. This object supports + * enumeration and allows the creation of Direct3DDevice9 objects. + * Pass the value of the constant D3D_SDK_VERSION to this function, so + * that the run-time can validate that your application was compiled + * against the right headers. + */ + +IDirect3D9 * WINAPI Direct3DCreate9(UINT SDKVersion); + +/* + * Stubs for graphics profiling. + */ + +int WINAPI D3DPERF_BeginEvent( D3DCOLOR col, LPCWSTR wszName ); +int WINAPI D3DPERF_EndEvent( void ); +void WINAPI D3DPERF_SetMarker( D3DCOLOR col, LPCWSTR wszName ); +void WINAPI D3DPERF_SetRegion( D3DCOLOR col, LPCWSTR wszName ); +BOOL WINAPI D3DPERF_QueryRepeatFrame( void ); + +void WINAPI D3DPERF_SetOptions( DWORD dwOptions ); +DWORD WINAPI D3DPERF_GetStatus( void ); + +/* + * Direct3D interfaces + */ + + + + + + +#undef INTERFACE +#define INTERFACE IDirect3D9 + +DECLARE_INTERFACE_(IDirect3D9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3D9 methods ***/ + STDMETHOD(RegisterSoftwareDevice)(THIS_ void* pInitializeFunction) PURE; + STDMETHOD_(UINT, GetAdapterCount)(THIS) PURE; + STDMETHOD(GetAdapterIdentifier)(THIS_ UINT Adapter,DWORD Flags,D3DADAPTER_IDENTIFIER9* pIdentifier) PURE; + STDMETHOD_(UINT, GetAdapterModeCount)(THIS_ UINT Adapter,D3DFORMAT Format) PURE; + STDMETHOD(EnumAdapterModes)(THIS_ UINT Adapter,D3DFORMAT Format,UINT Mode,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetAdapterDisplayMode)(THIS_ UINT Adapter,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(CheckDeviceType)(THIS_ UINT Adapter,D3DDEVTYPE DevType,D3DFORMAT AdapterFormat,D3DFORMAT BackBufferFormat,BOOL bWindowed) PURE; + STDMETHOD(CheckDeviceFormat)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,DWORD Usage,D3DRESOURCETYPE RType,D3DFORMAT CheckFormat) PURE; + STDMETHOD(CheckDeviceMultiSampleType)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SurfaceFormat,BOOL Windowed,D3DMULTISAMPLE_TYPE MultiSampleType,DWORD* pQualityLevels) PURE; + STDMETHOD(CheckDepthStencilMatch)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,D3DFORMAT RenderTargetFormat,D3DFORMAT DepthStencilFormat) PURE; + STDMETHOD(CheckDeviceFormatConversion)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SourceFormat,D3DFORMAT TargetFormat) PURE; + STDMETHOD(GetDeviceCaps)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DCAPS9* pCaps) PURE; + STDMETHOD_(HMONITOR, GetAdapterMonitor)(THIS_ UINT Adapter) PURE; + STDMETHOD(CreateDevice)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,HWND hFocusWindow,DWORD BehaviorFlags,D3DPRESENT_PARAMETERS* pPresentationParameters,IDirect3DDevice9** ppReturnedDeviceInterface) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Version; + #endif +}; + +typedef struct IDirect3D9 *LPDIRECT3D9, *PDIRECT3D9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3D9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3D9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3D9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3D9_RegisterSoftwareDevice(p,a) (p)->lpVtbl->RegisterSoftwareDevice(p,a) +#define IDirect3D9_GetAdapterCount(p) (p)->lpVtbl->GetAdapterCount(p) +#define IDirect3D9_GetAdapterIdentifier(p,a,b,c) (p)->lpVtbl->GetAdapterIdentifier(p,a,b,c) +#define IDirect3D9_GetAdapterModeCount(p,a,b) (p)->lpVtbl->GetAdapterModeCount(p,a,b) +#define IDirect3D9_EnumAdapterModes(p,a,b,c,d) (p)->lpVtbl->EnumAdapterModes(p,a,b,c,d) +#define IDirect3D9_GetAdapterDisplayMode(p,a,b) (p)->lpVtbl->GetAdapterDisplayMode(p,a,b) +#define IDirect3D9_CheckDeviceType(p,a,b,c,d,e) (p)->lpVtbl->CheckDeviceType(p,a,b,c,d,e) +#define IDirect3D9_CheckDeviceFormat(p,a,b,c,d,e,f) (p)->lpVtbl->CheckDeviceFormat(p,a,b,c,d,e,f) +#define IDirect3D9_CheckDeviceMultiSampleType(p,a,b,c,d,e,f) (p)->lpVtbl->CheckDeviceMultiSampleType(p,a,b,c,d,e,f) +#define IDirect3D9_CheckDepthStencilMatch(p,a,b,c,d,e) (p)->lpVtbl->CheckDepthStencilMatch(p,a,b,c,d,e) +#define IDirect3D9_CheckDeviceFormatConversion(p,a,b,c,d) (p)->lpVtbl->CheckDeviceFormatConversion(p,a,b,c,d) +#define IDirect3D9_GetDeviceCaps(p,a,b,c) (p)->lpVtbl->GetDeviceCaps(p,a,b,c) +#define IDirect3D9_GetAdapterMonitor(p,a) (p)->lpVtbl->GetAdapterMonitor(p,a) +#define IDirect3D9_CreateDevice(p,a,b,c,d,e,f) (p)->lpVtbl->CreateDevice(p,a,b,c,d,e,f) +#else +#define IDirect3D9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3D9_AddRef(p) (p)->AddRef() +#define IDirect3D9_Release(p) (p)->Release() +#define IDirect3D9_RegisterSoftwareDevice(p,a) (p)->RegisterSoftwareDevice(a) +#define IDirect3D9_GetAdapterCount(p) (p)->GetAdapterCount() +#define IDirect3D9_GetAdapterIdentifier(p,a,b,c) (p)->GetAdapterIdentifier(a,b,c) +#define IDirect3D9_GetAdapterModeCount(p,a,b) (p)->GetAdapterModeCount(a,b) +#define IDirect3D9_EnumAdapterModes(p,a,b,c,d) (p)->EnumAdapterModes(a,b,c,d) +#define IDirect3D9_GetAdapterDisplayMode(p,a,b) (p)->GetAdapterDisplayMode(a,b) +#define IDirect3D9_CheckDeviceType(p,a,b,c,d,e) (p)->CheckDeviceType(a,b,c,d,e) +#define IDirect3D9_CheckDeviceFormat(p,a,b,c,d,e,f) (p)->CheckDeviceFormat(a,b,c,d,e,f) +#define IDirect3D9_CheckDeviceMultiSampleType(p,a,b,c,d,e,f) (p)->CheckDeviceMultiSampleType(a,b,c,d,e,f) +#define IDirect3D9_CheckDepthStencilMatch(p,a,b,c,d,e) (p)->CheckDepthStencilMatch(a,b,c,d,e) +#define IDirect3D9_CheckDeviceFormatConversion(p,a,b,c,d) (p)->CheckDeviceFormatConversion(a,b,c,d) +#define IDirect3D9_GetDeviceCaps(p,a,b,c) (p)->GetDeviceCaps(a,b,c) +#define IDirect3D9_GetAdapterMonitor(p,a) (p)->GetAdapterMonitor(a) +#define IDirect3D9_CreateDevice(p,a,b,c,d,e,f) (p)->CreateDevice(a,b,c,d,e,f) +#endif + + + + + + + +/* SwapChain */ + + + + + + + + + + + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DDevice9 + +DECLARE_INTERFACE_(IDirect3DDevice9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DDevice9 methods ***/ + STDMETHOD(TestCooperativeLevel)(THIS) PURE; + STDMETHOD_(UINT, GetAvailableTextureMem)(THIS) PURE; + STDMETHOD(EvictManagedResources)(THIS) PURE; + STDMETHOD(GetDirect3D)(THIS_ IDirect3D9** ppD3D9) PURE; + STDMETHOD(GetDeviceCaps)(THIS_ D3DCAPS9* pCaps) PURE; + STDMETHOD(GetDisplayMode)(THIS_ UINT iSwapChain,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetCreationParameters)(THIS_ D3DDEVICE_CREATION_PARAMETERS *pParameters) PURE; + STDMETHOD(SetCursorProperties)(THIS_ UINT XHotSpot,UINT YHotSpot,IDirect3DSurface9* pCursorBitmap) PURE; + STDMETHOD_(void, SetCursorPosition)(THIS_ int X,int Y,DWORD Flags) PURE; + STDMETHOD_(BOOL, ShowCursor)(THIS_ BOOL bShow) PURE; + STDMETHOD(CreateAdditionalSwapChain)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters,IDirect3DSwapChain9** pSwapChain) PURE; + STDMETHOD(GetSwapChain)(THIS_ UINT iSwapChain,IDirect3DSwapChain9** pSwapChain) PURE; + STDMETHOD_(UINT, GetNumberOfSwapChains)(THIS) PURE; + STDMETHOD(Reset)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters) PURE; + STDMETHOD(Present)(THIS_ CONST RECT* pSourceRect,CONST RECT* pDestRect,HWND hDestWindowOverride,CONST RGNDATA* pDirtyRegion) PURE; + STDMETHOD(GetBackBuffer)(THIS_ UINT iSwapChain,UINT iBackBuffer,D3DBACKBUFFER_TYPE Type,IDirect3DSurface9** ppBackBuffer) PURE; + STDMETHOD(GetRasterStatus)(THIS_ UINT iSwapChain,D3DRASTER_STATUS* pRasterStatus) PURE; + STDMETHOD(SetDialogBoxMode)(THIS_ BOOL bEnableDialogs) PURE; + STDMETHOD_(void, SetGammaRamp)(THIS_ UINT iSwapChain,DWORD Flags,CONST D3DGAMMARAMP* pRamp) PURE; + STDMETHOD_(void, GetGammaRamp)(THIS_ UINT iSwapChain,D3DGAMMARAMP* pRamp) PURE; + STDMETHOD(CreateTexture)(THIS_ UINT Width,UINT Height,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DTexture9** ppTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateVolumeTexture)(THIS_ UINT Width,UINT Height,UINT Depth,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DVolumeTexture9** ppVolumeTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateCubeTexture)(THIS_ UINT EdgeLength,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DCubeTexture9** ppCubeTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateVertexBuffer)(THIS_ UINT Length,DWORD Usage,DWORD FVF,D3DPOOL Pool,IDirect3DVertexBuffer9** ppVertexBuffer,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateIndexBuffer)(THIS_ UINT Length,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DIndexBuffer9** ppIndexBuffer,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateRenderTarget)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Lockable,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateDepthStencilSurface)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Discard,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(UpdateSurface)(THIS_ IDirect3DSurface9* pSourceSurface,CONST RECT* pSourceRect,IDirect3DSurface9* pDestinationSurface,CONST POINT* pDestPoint) PURE; + STDMETHOD(UpdateTexture)(THIS_ IDirect3DBaseTexture9* pSourceTexture,IDirect3DBaseTexture9* pDestinationTexture) PURE; + STDMETHOD(GetRenderTargetData)(THIS_ IDirect3DSurface9* pRenderTarget,IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(GetFrontBufferData)(THIS_ UINT iSwapChain,IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(StretchRect)(THIS_ IDirect3DSurface9* pSourceSurface,CONST RECT* pSourceRect,IDirect3DSurface9* pDestSurface,CONST RECT* pDestRect,D3DTEXTUREFILTERTYPE Filter) PURE; + STDMETHOD(ColorFill)(THIS_ IDirect3DSurface9* pSurface,CONST RECT* pRect,D3DCOLOR color) PURE; + STDMETHOD(CreateOffscreenPlainSurface)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DPOOL Pool,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(SetRenderTarget)(THIS_ DWORD RenderTargetIndex,IDirect3DSurface9* pRenderTarget) PURE; + STDMETHOD(GetRenderTarget)(THIS_ DWORD RenderTargetIndex,IDirect3DSurface9** ppRenderTarget) PURE; + STDMETHOD(SetDepthStencilSurface)(THIS_ IDirect3DSurface9* pNewZStencil) PURE; + STDMETHOD(GetDepthStencilSurface)(THIS_ IDirect3DSurface9** ppZStencilSurface) PURE; + STDMETHOD(BeginScene)(THIS) PURE; + STDMETHOD(EndScene)(THIS) PURE; + STDMETHOD(Clear)(THIS_ DWORD Count,CONST D3DRECT* pRects,DWORD Flags,D3DCOLOR Color,float Z,DWORD Stencil) PURE; + STDMETHOD(SetTransform)(THIS_ D3DTRANSFORMSTATETYPE State,CONST D3DMATRIX* pMatrix) PURE; + STDMETHOD(GetTransform)(THIS_ D3DTRANSFORMSTATETYPE State,D3DMATRIX* pMatrix) PURE; + STDMETHOD(MultiplyTransform)(THIS_ D3DTRANSFORMSTATETYPE,CONST D3DMATRIX*) PURE; + STDMETHOD(SetViewport)(THIS_ CONST D3DVIEWPORT9* pViewport) PURE; + STDMETHOD(GetViewport)(THIS_ D3DVIEWPORT9* pViewport) PURE; + STDMETHOD(SetMaterial)(THIS_ CONST D3DMATERIAL9* pMaterial) PURE; + STDMETHOD(GetMaterial)(THIS_ D3DMATERIAL9* pMaterial) PURE; + STDMETHOD(SetLight)(THIS_ DWORD Index,CONST D3DLIGHT9*) PURE; + STDMETHOD(GetLight)(THIS_ DWORD Index,D3DLIGHT9*) PURE; + STDMETHOD(LightEnable)(THIS_ DWORD Index,BOOL Enable) PURE; + STDMETHOD(GetLightEnable)(THIS_ DWORD Index,BOOL* pEnable) PURE; + STDMETHOD(SetClipPlane)(THIS_ DWORD Index,CONST float* pPlane) PURE; + STDMETHOD(GetClipPlane)(THIS_ DWORD Index,float* pPlane) PURE; + STDMETHOD(SetRenderState)(THIS_ D3DRENDERSTATETYPE State,DWORD Value) PURE; + STDMETHOD(GetRenderState)(THIS_ D3DRENDERSTATETYPE State,DWORD* pValue) PURE; + STDMETHOD(CreateStateBlock)(THIS_ D3DSTATEBLOCKTYPE Type,IDirect3DStateBlock9** ppSB) PURE; + STDMETHOD(BeginStateBlock)(THIS) PURE; + STDMETHOD(EndStateBlock)(THIS_ IDirect3DStateBlock9** ppSB) PURE; + STDMETHOD(SetClipStatus)(THIS_ CONST D3DCLIPSTATUS9* pClipStatus) PURE; + STDMETHOD(GetClipStatus)(THIS_ D3DCLIPSTATUS9* pClipStatus) PURE; + STDMETHOD(GetTexture)(THIS_ DWORD Stage,IDirect3DBaseTexture9** ppTexture) PURE; + STDMETHOD(SetTexture)(THIS_ DWORD Stage,IDirect3DBaseTexture9* pTexture) PURE; + STDMETHOD(GetTextureStageState)(THIS_ DWORD Stage,D3DTEXTURESTAGESTATETYPE Type,DWORD* pValue) PURE; + STDMETHOD(SetTextureStageState)(THIS_ DWORD Stage,D3DTEXTURESTAGESTATETYPE Type,DWORD Value) PURE; + STDMETHOD(GetSamplerState)(THIS_ DWORD Sampler,D3DSAMPLERSTATETYPE Type,DWORD* pValue) PURE; + STDMETHOD(SetSamplerState)(THIS_ DWORD Sampler,D3DSAMPLERSTATETYPE Type,DWORD Value) PURE; + STDMETHOD(ValidateDevice)(THIS_ DWORD* pNumPasses) PURE; + STDMETHOD(SetPaletteEntries)(THIS_ UINT PaletteNumber,CONST PALETTEENTRY* pEntries) PURE; + STDMETHOD(GetPaletteEntries)(THIS_ UINT PaletteNumber,PALETTEENTRY* pEntries) PURE; + STDMETHOD(SetCurrentTexturePalette)(THIS_ UINT PaletteNumber) PURE; + STDMETHOD(GetCurrentTexturePalette)(THIS_ UINT *PaletteNumber) PURE; + STDMETHOD(SetScissorRect)(THIS_ CONST RECT* pRect) PURE; + STDMETHOD(GetScissorRect)(THIS_ RECT* pRect) PURE; + STDMETHOD(SetSoftwareVertexProcessing)(THIS_ BOOL bSoftware) PURE; + STDMETHOD_(BOOL, GetSoftwareVertexProcessing)(THIS) PURE; + STDMETHOD(SetNPatchMode)(THIS_ float nSegments) PURE; + STDMETHOD_(float, GetNPatchMode)(THIS) PURE; + STDMETHOD(DrawPrimitive)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT StartVertex,UINT PrimitiveCount) PURE; + STDMETHOD(DrawIndexedPrimitive)(THIS_ D3DPRIMITIVETYPE,INT BaseVertexIndex,UINT MinVertexIndex,UINT NumVertices,UINT startIndex,UINT primCount) PURE; + STDMETHOD(DrawPrimitiveUP)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT PrimitiveCount,CONST void* pVertexStreamZeroData,UINT VertexStreamZeroStride) PURE; + STDMETHOD(DrawIndexedPrimitiveUP)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT MinVertexIndex,UINT NumVertices,UINT PrimitiveCount,CONST void* pIndexData,D3DFORMAT IndexDataFormat,CONST void* pVertexStreamZeroData,UINT VertexStreamZeroStride) PURE; + STDMETHOD(ProcessVertices)(THIS_ UINT SrcStartIndex,UINT DestIndex,UINT VertexCount,IDirect3DVertexBuffer9* pDestBuffer,IDirect3DVertexDeclaration9* pVertexDecl,DWORD Flags) PURE; + STDMETHOD(CreateVertexDeclaration)(THIS_ CONST D3DVERTEXELEMENT9* pVertexElements,IDirect3DVertexDeclaration9** ppDecl) PURE; + STDMETHOD(SetVertexDeclaration)(THIS_ IDirect3DVertexDeclaration9* pDecl) PURE; + STDMETHOD(GetVertexDeclaration)(THIS_ IDirect3DVertexDeclaration9** ppDecl) PURE; + STDMETHOD(SetFVF)(THIS_ DWORD FVF) PURE; + STDMETHOD(GetFVF)(THIS_ DWORD* pFVF) PURE; + STDMETHOD(CreateVertexShader)(THIS_ CONST DWORD* pFunction,IDirect3DVertexShader9** ppShader) PURE; + STDMETHOD(SetVertexShader)(THIS_ IDirect3DVertexShader9* pShader) PURE; + STDMETHOD(GetVertexShader)(THIS_ IDirect3DVertexShader9** ppShader) PURE; + STDMETHOD(SetVertexShaderConstantF)(THIS_ UINT StartRegister,CONST float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(GetVertexShaderConstantF)(THIS_ UINT StartRegister,float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(SetVertexShaderConstantI)(THIS_ UINT StartRegister,CONST int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(GetVertexShaderConstantI)(THIS_ UINT StartRegister,int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(SetVertexShaderConstantB)(THIS_ UINT StartRegister,CONST BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(GetVertexShaderConstantB)(THIS_ UINT StartRegister,BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(SetStreamSource)(THIS_ UINT StreamNumber,IDirect3DVertexBuffer9* pStreamData,UINT OffsetInBytes,UINT Stride) PURE; + STDMETHOD(GetStreamSource)(THIS_ UINT StreamNumber,IDirect3DVertexBuffer9** ppStreamData,UINT* pOffsetInBytes,UINT* pStride) PURE; + STDMETHOD(SetStreamSourceFreq)(THIS_ UINT StreamNumber,UINT Setting) PURE; + STDMETHOD(GetStreamSourceFreq)(THIS_ UINT StreamNumber,UINT* pSetting) PURE; + STDMETHOD(SetIndices)(THIS_ IDirect3DIndexBuffer9* pIndexData) PURE; + STDMETHOD(GetIndices)(THIS_ IDirect3DIndexBuffer9** ppIndexData) PURE; + STDMETHOD(CreatePixelShader)(THIS_ CONST DWORD* pFunction,IDirect3DPixelShader9** ppShader) PURE; + STDMETHOD(SetPixelShader)(THIS_ IDirect3DPixelShader9* pShader) PURE; + STDMETHOD(GetPixelShader)(THIS_ IDirect3DPixelShader9** ppShader) PURE; + STDMETHOD(SetPixelShaderConstantF)(THIS_ UINT StartRegister,CONST float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(GetPixelShaderConstantF)(THIS_ UINT StartRegister,float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(SetPixelShaderConstantI)(THIS_ UINT StartRegister,CONST int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(GetPixelShaderConstantI)(THIS_ UINT StartRegister,int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(SetPixelShaderConstantB)(THIS_ UINT StartRegister,CONST BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(GetPixelShaderConstantB)(THIS_ UINT StartRegister,BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(DrawRectPatch)(THIS_ UINT Handle,CONST float* pNumSegs,CONST D3DRECTPATCH_INFO* pRectPatchInfo) PURE; + STDMETHOD(DrawTriPatch)(THIS_ UINT Handle,CONST float* pNumSegs,CONST D3DTRIPATCH_INFO* pTriPatchInfo) PURE; + STDMETHOD(DeletePatch)(THIS_ UINT Handle) PURE; + STDMETHOD(CreateQuery)(THIS_ D3DQUERYTYPE Type,IDirect3DQuery9** ppQuery) PURE; + + #ifdef D3D_DEBUG_INFO + D3DDEVICE_CREATION_PARAMETERS CreationParameters; + D3DPRESENT_PARAMETERS PresentParameters; + D3DDISPLAYMODE DisplayMode; + D3DCAPS9 Caps; + + UINT AvailableTextureMem; + UINT SwapChains; + UINT Textures; + UINT VertexBuffers; + UINT IndexBuffers; + UINT VertexShaders; + UINT PixelShaders; + + D3DVIEWPORT9 Viewport; + D3DMATRIX ProjectionMatrix; + D3DMATRIX ViewMatrix; + D3DMATRIX WorldMatrix; + D3DMATRIX TextureMatrices[8]; + + DWORD FVF; + UINT VertexSize; + DWORD VertexShaderVersion; + DWORD PixelShaderVersion; + BOOL SoftwareVertexProcessing; + + D3DMATERIAL9 Material; + D3DLIGHT9 Lights[16]; + BOOL LightsEnabled[16]; + + D3DGAMMARAMP GammaRamp; + RECT ScissorRect; + BOOL DialogBoxMode; + #endif +}; + +typedef struct IDirect3DDevice9 *LPDIRECT3DDEVICE9, *PDIRECT3DDEVICE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DDevice9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DDevice9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DDevice9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DDevice9_TestCooperativeLevel(p) (p)->lpVtbl->TestCooperativeLevel(p) +#define IDirect3DDevice9_GetAvailableTextureMem(p) (p)->lpVtbl->GetAvailableTextureMem(p) +#define IDirect3DDevice9_EvictManagedResources(p) (p)->lpVtbl->EvictManagedResources(p) +#define IDirect3DDevice9_GetDirect3D(p,a) (p)->lpVtbl->GetDirect3D(p,a) +#define IDirect3DDevice9_GetDeviceCaps(p,a) (p)->lpVtbl->GetDeviceCaps(p,a) +#define IDirect3DDevice9_GetDisplayMode(p,a,b) (p)->lpVtbl->GetDisplayMode(p,a,b) +#define IDirect3DDevice9_GetCreationParameters(p,a) (p)->lpVtbl->GetCreationParameters(p,a) +#define IDirect3DDevice9_SetCursorProperties(p,a,b,c) (p)->lpVtbl->SetCursorProperties(p,a,b,c) +#define IDirect3DDevice9_SetCursorPosition(p,a,b,c) (p)->lpVtbl->SetCursorPosition(p,a,b,c) +#define IDirect3DDevice9_ShowCursor(p,a) (p)->lpVtbl->ShowCursor(p,a) +#define IDirect3DDevice9_CreateAdditionalSwapChain(p,a,b) (p)->lpVtbl->CreateAdditionalSwapChain(p,a,b) +#define IDirect3DDevice9_GetSwapChain(p,a,b) (p)->lpVtbl->GetSwapChain(p,a,b) +#define IDirect3DDevice9_GetNumberOfSwapChains(p) (p)->lpVtbl->GetNumberOfSwapChains(p) +#define IDirect3DDevice9_Reset(p,a) (p)->lpVtbl->Reset(p,a) +#define IDirect3DDevice9_Present(p,a,b,c,d) (p)->lpVtbl->Present(p,a,b,c,d) +#define IDirect3DDevice9_GetBackBuffer(p,a,b,c,d) (p)->lpVtbl->GetBackBuffer(p,a,b,c,d) +#define IDirect3DDevice9_GetRasterStatus(p,a,b) (p)->lpVtbl->GetRasterStatus(p,a,b) +#define IDirect3DDevice9_SetDialogBoxMode(p,a) (p)->lpVtbl->SetDialogBoxMode(p,a) +#define IDirect3DDevice9_SetGammaRamp(p,a,b,c) (p)->lpVtbl->SetGammaRamp(p,a,b,c) +#define IDirect3DDevice9_GetGammaRamp(p,a,b) (p)->lpVtbl->GetGammaRamp(p,a,b) +#define IDirect3DDevice9_CreateTexture(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateTexture(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) (p)->lpVtbl->CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9_CreateCubeTexture(p,a,b,c,d,e,f,g) (p)->lpVtbl->CreateCubeTexture(p,a,b,c,d,e,f,g) +#define IDirect3DDevice9_CreateVertexBuffer(p,a,b,c,d,e,f) (p)->lpVtbl->CreateVertexBuffer(p,a,b,c,d,e,f) +#define IDirect3DDevice9_CreateIndexBuffer(p,a,b,c,d,e,f) (p)->lpVtbl->CreateIndexBuffer(p,a,b,c,d,e,f) +#define IDirect3DDevice9_CreateRenderTarget(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateRenderTarget(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_UpdateSurface(p,a,b,c,d) (p)->lpVtbl->UpdateSurface(p,a,b,c,d) +#define IDirect3DDevice9_UpdateTexture(p,a,b) (p)->lpVtbl->UpdateTexture(p,a,b) +#define IDirect3DDevice9_GetRenderTargetData(p,a,b) (p)->lpVtbl->GetRenderTargetData(p,a,b) +#define IDirect3DDevice9_GetFrontBufferData(p,a,b) (p)->lpVtbl->GetFrontBufferData(p,a,b) +#define IDirect3DDevice9_StretchRect(p,a,b,c,d,e) (p)->lpVtbl->StretchRect(p,a,b,c,d,e) +#define IDirect3DDevice9_ColorFill(p,a,b,c) (p)->lpVtbl->ColorFill(p,a,b,c) +#define IDirect3DDevice9_CreateOffscreenPlainSurface(p,a,b,c,d,e,f) (p)->lpVtbl->CreateOffscreenPlainSurface(p,a,b,c,d,e,f) +#define IDirect3DDevice9_SetRenderTarget(p,a,b) (p)->lpVtbl->SetRenderTarget(p,a,b) +#define IDirect3DDevice9_GetRenderTarget(p,a,b) (p)->lpVtbl->GetRenderTarget(p,a,b) +#define IDirect3DDevice9_SetDepthStencilSurface(p,a) (p)->lpVtbl->SetDepthStencilSurface(p,a) +#define IDirect3DDevice9_GetDepthStencilSurface(p,a) (p)->lpVtbl->GetDepthStencilSurface(p,a) +#define IDirect3DDevice9_BeginScene(p) (p)->lpVtbl->BeginScene(p) +#define IDirect3DDevice9_EndScene(p) (p)->lpVtbl->EndScene(p) +#define IDirect3DDevice9_Clear(p,a,b,c,d,e,f) (p)->lpVtbl->Clear(p,a,b,c,d,e,f) +#define IDirect3DDevice9_SetTransform(p,a,b) (p)->lpVtbl->SetTransform(p,a,b) +#define IDirect3DDevice9_GetTransform(p,a,b) (p)->lpVtbl->GetTransform(p,a,b) +#define IDirect3DDevice9_MultiplyTransform(p,a,b) (p)->lpVtbl->MultiplyTransform(p,a,b) +#define IDirect3DDevice9_SetViewport(p,a) (p)->lpVtbl->SetViewport(p,a) +#define IDirect3DDevice9_GetViewport(p,a) (p)->lpVtbl->GetViewport(p,a) +#define IDirect3DDevice9_SetMaterial(p,a) (p)->lpVtbl->SetMaterial(p,a) +#define IDirect3DDevice9_GetMaterial(p,a) (p)->lpVtbl->GetMaterial(p,a) +#define IDirect3DDevice9_SetLight(p,a,b) (p)->lpVtbl->SetLight(p,a,b) +#define IDirect3DDevice9_GetLight(p,a,b) (p)->lpVtbl->GetLight(p,a,b) +#define IDirect3DDevice9_LightEnable(p,a,b) (p)->lpVtbl->LightEnable(p,a,b) +#define IDirect3DDevice9_GetLightEnable(p,a,b) (p)->lpVtbl->GetLightEnable(p,a,b) +#define IDirect3DDevice9_SetClipPlane(p,a,b) (p)->lpVtbl->SetClipPlane(p,a,b) +#define IDirect3DDevice9_GetClipPlane(p,a,b) (p)->lpVtbl->GetClipPlane(p,a,b) +#define IDirect3DDevice9_SetRenderState(p,a,b) (p)->lpVtbl->SetRenderState(p,a,b) +#define IDirect3DDevice9_GetRenderState(p,a,b) (p)->lpVtbl->GetRenderState(p,a,b) +#define IDirect3DDevice9_CreateStateBlock(p,a,b) (p)->lpVtbl->CreateStateBlock(p,a,b) +#define IDirect3DDevice9_BeginStateBlock(p) (p)->lpVtbl->BeginStateBlock(p) +#define IDirect3DDevice9_EndStateBlock(p,a) (p)->lpVtbl->EndStateBlock(p,a) +#define IDirect3DDevice9_SetClipStatus(p,a) (p)->lpVtbl->SetClipStatus(p,a) +#define IDirect3DDevice9_GetClipStatus(p,a) (p)->lpVtbl->GetClipStatus(p,a) +#define IDirect3DDevice9_GetTexture(p,a,b) (p)->lpVtbl->GetTexture(p,a,b) +#define IDirect3DDevice9_SetTexture(p,a,b) (p)->lpVtbl->SetTexture(p,a,b) +#define IDirect3DDevice9_GetTextureStageState(p,a,b,c) (p)->lpVtbl->GetTextureStageState(p,a,b,c) +#define IDirect3DDevice9_SetTextureStageState(p,a,b,c) (p)->lpVtbl->SetTextureStageState(p,a,b,c) +#define IDirect3DDevice9_GetSamplerState(p,a,b,c) (p)->lpVtbl->GetSamplerState(p,a,b,c) +#define IDirect3DDevice9_SetSamplerState(p,a,b,c) (p)->lpVtbl->SetSamplerState(p,a,b,c) +#define IDirect3DDevice9_ValidateDevice(p,a) (p)->lpVtbl->ValidateDevice(p,a) +#define IDirect3DDevice9_SetPaletteEntries(p,a,b) (p)->lpVtbl->SetPaletteEntries(p,a,b) +#define IDirect3DDevice9_GetPaletteEntries(p,a,b) (p)->lpVtbl->GetPaletteEntries(p,a,b) +#define IDirect3DDevice9_SetCurrentTexturePalette(p,a) (p)->lpVtbl->SetCurrentTexturePalette(p,a) +#define IDirect3DDevice9_GetCurrentTexturePalette(p,a) (p)->lpVtbl->GetCurrentTexturePalette(p,a) +#define IDirect3DDevice9_SetScissorRect(p,a) (p)->lpVtbl->SetScissorRect(p,a) +#define IDirect3DDevice9_GetScissorRect(p,a) (p)->lpVtbl->GetScissorRect(p,a) +#define IDirect3DDevice9_SetSoftwareVertexProcessing(p,a) (p)->lpVtbl->SetSoftwareVertexProcessing(p,a) +#define IDirect3DDevice9_GetSoftwareVertexProcessing(p) (p)->lpVtbl->GetSoftwareVertexProcessing(p) +#define IDirect3DDevice9_SetNPatchMode(p,a) (p)->lpVtbl->SetNPatchMode(p,a) +#define IDirect3DDevice9_GetNPatchMode(p) (p)->lpVtbl->GetNPatchMode(p) +#define IDirect3DDevice9_DrawPrimitive(p,a,b,c) (p)->lpVtbl->DrawPrimitive(p,a,b,c) +#define IDirect3DDevice9_DrawIndexedPrimitive(p,a,b,c,d,e,f) (p)->lpVtbl->DrawIndexedPrimitive(p,a,b,c,d,e,f) +#define IDirect3DDevice9_DrawPrimitiveUP(p,a,b,c,d) (p)->lpVtbl->DrawPrimitiveUP(p,a,b,c,d) +#define IDirect3DDevice9_DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_ProcessVertices(p,a,b,c,d,e,f) (p)->lpVtbl->ProcessVertices(p,a,b,c,d,e,f) +#define IDirect3DDevice9_CreateVertexDeclaration(p,a,b) (p)->lpVtbl->CreateVertexDeclaration(p,a,b) +#define IDirect3DDevice9_SetVertexDeclaration(p,a) (p)->lpVtbl->SetVertexDeclaration(p,a) +#define IDirect3DDevice9_GetVertexDeclaration(p,a) (p)->lpVtbl->GetVertexDeclaration(p,a) +#define IDirect3DDevice9_SetFVF(p,a) (p)->lpVtbl->SetFVF(p,a) +#define IDirect3DDevice9_GetFVF(p,a) (p)->lpVtbl->GetFVF(p,a) +#define IDirect3DDevice9_CreateVertexShader(p,a,b) (p)->lpVtbl->CreateVertexShader(p,a,b) +#define IDirect3DDevice9_SetVertexShader(p,a) (p)->lpVtbl->SetVertexShader(p,a) +#define IDirect3DDevice9_GetVertexShader(p,a) (p)->lpVtbl->GetVertexShader(p,a) +#define IDirect3DDevice9_SetVertexShaderConstantF(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantF(p,a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantF(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantF(p,a,b,c) +#define IDirect3DDevice9_SetVertexShaderConstantI(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantI(p,a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantI(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantI(p,a,b,c) +#define IDirect3DDevice9_SetVertexShaderConstantB(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantB(p,a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantB(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantB(p,a,b,c) +#define IDirect3DDevice9_SetStreamSource(p,a,b,c,d) (p)->lpVtbl->SetStreamSource(p,a,b,c,d) +#define IDirect3DDevice9_GetStreamSource(p,a,b,c,d) (p)->lpVtbl->GetStreamSource(p,a,b,c,d) +#define IDirect3DDevice9_SetStreamSourceFreq(p,a,b) (p)->lpVtbl->SetStreamSourceFreq(p,a,b) +#define IDirect3DDevice9_GetStreamSourceFreq(p,a,b) (p)->lpVtbl->GetStreamSourceFreq(p,a,b) +#define IDirect3DDevice9_SetIndices(p,a) (p)->lpVtbl->SetIndices(p,a) +#define IDirect3DDevice9_GetIndices(p,a) (p)->lpVtbl->GetIndices(p,a) +#define IDirect3DDevice9_CreatePixelShader(p,a,b) (p)->lpVtbl->CreatePixelShader(p,a,b) +#define IDirect3DDevice9_SetPixelShader(p,a) (p)->lpVtbl->SetPixelShader(p,a) +#define IDirect3DDevice9_GetPixelShader(p,a) (p)->lpVtbl->GetPixelShader(p,a) +#define IDirect3DDevice9_SetPixelShaderConstantF(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantF(p,a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantF(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantF(p,a,b,c) +#define IDirect3DDevice9_SetPixelShaderConstantI(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantI(p,a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantI(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantI(p,a,b,c) +#define IDirect3DDevice9_SetPixelShaderConstantB(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantB(p,a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantB(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantB(p,a,b,c) +#define IDirect3DDevice9_DrawRectPatch(p,a,b,c) (p)->lpVtbl->DrawRectPatch(p,a,b,c) +#define IDirect3DDevice9_DrawTriPatch(p,a,b,c) (p)->lpVtbl->DrawTriPatch(p,a,b,c) +#define IDirect3DDevice9_DeletePatch(p,a) (p)->lpVtbl->DeletePatch(p,a) +#define IDirect3DDevice9_CreateQuery(p,a,b) (p)->lpVtbl->CreateQuery(p,a,b) +#else +#define IDirect3DDevice9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DDevice9_AddRef(p) (p)->AddRef() +#define IDirect3DDevice9_Release(p) (p)->Release() +#define IDirect3DDevice9_TestCooperativeLevel(p) (p)->TestCooperativeLevel() +#define IDirect3DDevice9_GetAvailableTextureMem(p) (p)->GetAvailableTextureMem() +#define IDirect3DDevice9_EvictManagedResources(p) (p)->EvictManagedResources() +#define IDirect3DDevice9_GetDirect3D(p,a) (p)->GetDirect3D(a) +#define IDirect3DDevice9_GetDeviceCaps(p,a) (p)->GetDeviceCaps(a) +#define IDirect3DDevice9_GetDisplayMode(p,a,b) (p)->GetDisplayMode(a,b) +#define IDirect3DDevice9_GetCreationParameters(p,a) (p)->GetCreationParameters(a) +#define IDirect3DDevice9_SetCursorProperties(p,a,b,c) (p)->SetCursorProperties(a,b,c) +#define IDirect3DDevice9_SetCursorPosition(p,a,b,c) (p)->SetCursorPosition(a,b,c) +#define IDirect3DDevice9_ShowCursor(p,a) (p)->ShowCursor(a) +#define IDirect3DDevice9_CreateAdditionalSwapChain(p,a,b) (p)->CreateAdditionalSwapChain(a,b) +#define IDirect3DDevice9_GetSwapChain(p,a,b) (p)->GetSwapChain(a,b) +#define IDirect3DDevice9_GetNumberOfSwapChains(p) (p)->GetNumberOfSwapChains() +#define IDirect3DDevice9_Reset(p,a) (p)->Reset(a) +#define IDirect3DDevice9_Present(p,a,b,c,d) (p)->Present(a,b,c,d) +#define IDirect3DDevice9_GetBackBuffer(p,a,b,c,d) (p)->GetBackBuffer(a,b,c,d) +#define IDirect3DDevice9_GetRasterStatus(p,a,b) (p)->GetRasterStatus(a,b) +#define IDirect3DDevice9_SetDialogBoxMode(p,a) (p)->SetDialogBoxMode(a) +#define IDirect3DDevice9_SetGammaRamp(p,a,b,c) (p)->SetGammaRamp(a,b,c) +#define IDirect3DDevice9_GetGammaRamp(p,a,b) (p)->GetGammaRamp(a,b) +#define IDirect3DDevice9_CreateTexture(p,a,b,c,d,e,f,g,h) (p)->CreateTexture(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) (p)->CreateVolumeTexture(a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9_CreateCubeTexture(p,a,b,c,d,e,f,g) (p)->CreateCubeTexture(a,b,c,d,e,f,g) +#define IDirect3DDevice9_CreateVertexBuffer(p,a,b,c,d,e,f) (p)->CreateVertexBuffer(a,b,c,d,e,f) +#define IDirect3DDevice9_CreateIndexBuffer(p,a,b,c,d,e,f) (p)->CreateIndexBuffer(a,b,c,d,e,f) +#define IDirect3DDevice9_CreateRenderTarget(p,a,b,c,d,e,f,g,h) (p)->CreateRenderTarget(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) (p)->CreateDepthStencilSurface(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_UpdateSurface(p,a,b,c,d) (p)->UpdateSurface(a,b,c,d) +#define IDirect3DDevice9_UpdateTexture(p,a,b) (p)->UpdateTexture(a,b) +#define IDirect3DDevice9_GetRenderTargetData(p,a,b) (p)->GetRenderTargetData(a,b) +#define IDirect3DDevice9_GetFrontBufferData(p,a,b) (p)->GetFrontBufferData(a,b) +#define IDirect3DDevice9_StretchRect(p,a,b,c,d,e) (p)->StretchRect(a,b,c,d,e) +#define IDirect3DDevice9_ColorFill(p,a,b,c) (p)->ColorFill(a,b,c) +#define IDirect3DDevice9_CreateOffscreenPlainSurface(p,a,b,c,d,e,f) (p)->CreateOffscreenPlainSurface(a,b,c,d,e,f) +#define IDirect3DDevice9_SetRenderTarget(p,a,b) (p)->SetRenderTarget(a,b) +#define IDirect3DDevice9_GetRenderTarget(p,a,b) (p)->GetRenderTarget(a,b) +#define IDirect3DDevice9_SetDepthStencilSurface(p,a) (p)->SetDepthStencilSurface(a) +#define IDirect3DDevice9_GetDepthStencilSurface(p,a) (p)->GetDepthStencilSurface(a) +#define IDirect3DDevice9_BeginScene(p) (p)->BeginScene() +#define IDirect3DDevice9_EndScene(p) (p)->EndScene() +#define IDirect3DDevice9_Clear(p,a,b,c,d,e,f) (p)->Clear(a,b,c,d,e,f) +#define IDirect3DDevice9_SetTransform(p,a,b) (p)->SetTransform(a,b) +#define IDirect3DDevice9_GetTransform(p,a,b) (p)->GetTransform(a,b) +#define IDirect3DDevice9_MultiplyTransform(p,a,b) (p)->MultiplyTransform(a,b) +#define IDirect3DDevice9_SetViewport(p,a) (p)->SetViewport(a) +#define IDirect3DDevice9_GetViewport(p,a) (p)->GetViewport(a) +#define IDirect3DDevice9_SetMaterial(p,a) (p)->SetMaterial(a) +#define IDirect3DDevice9_GetMaterial(p,a) (p)->GetMaterial(a) +#define IDirect3DDevice9_SetLight(p,a,b) (p)->SetLight(a,b) +#define IDirect3DDevice9_GetLight(p,a,b) (p)->GetLight(a,b) +#define IDirect3DDevice9_LightEnable(p,a,b) (p)->LightEnable(a,b) +#define IDirect3DDevice9_GetLightEnable(p,a,b) (p)->GetLightEnable(a,b) +#define IDirect3DDevice9_SetClipPlane(p,a,b) (p)->SetClipPlane(a,b) +#define IDirect3DDevice9_GetClipPlane(p,a,b) (p)->GetClipPlane(a,b) +#define IDirect3DDevice9_SetRenderState(p,a,b) (p)->SetRenderState(a,b) +#define IDirect3DDevice9_GetRenderState(p,a,b) (p)->GetRenderState(a,b) +#define IDirect3DDevice9_CreateStateBlock(p,a,b) (p)->CreateStateBlock(a,b) +#define IDirect3DDevice9_BeginStateBlock(p) (p)->BeginStateBlock() +#define IDirect3DDevice9_EndStateBlock(p,a) (p)->EndStateBlock(a) +#define IDirect3DDevice9_SetClipStatus(p,a) (p)->SetClipStatus(a) +#define IDirect3DDevice9_GetClipStatus(p,a) (p)->GetClipStatus(a) +#define IDirect3DDevice9_GetTexture(p,a,b) (p)->GetTexture(a,b) +#define IDirect3DDevice9_SetTexture(p,a,b) (p)->SetTexture(a,b) +#define IDirect3DDevice9_GetTextureStageState(p,a,b,c) (p)->GetTextureStageState(a,b,c) +#define IDirect3DDevice9_SetTextureStageState(p,a,b,c) (p)->SetTextureStageState(a,b,c) +#define IDirect3DDevice9_GetSamplerState(p,a,b,c) (p)->GetSamplerState(a,b,c) +#define IDirect3DDevice9_SetSamplerState(p,a,b,c) (p)->SetSamplerState(a,b,c) +#define IDirect3DDevice9_ValidateDevice(p,a) (p)->ValidateDevice(a) +#define IDirect3DDevice9_SetPaletteEntries(p,a,b) (p)->SetPaletteEntries(a,b) +#define IDirect3DDevice9_GetPaletteEntries(p,a,b) (p)->GetPaletteEntries(a,b) +#define IDirect3DDevice9_SetCurrentTexturePalette(p,a) (p)->SetCurrentTexturePalette(a) +#define IDirect3DDevice9_GetCurrentTexturePalette(p,a) (p)->GetCurrentTexturePalette(a) +#define IDirect3DDevice9_SetScissorRect(p,a) (p)->SetScissorRect(a) +#define IDirect3DDevice9_GetScissorRect(p,a) (p)->GetScissorRect(a) +#define IDirect3DDevice9_SetSoftwareVertexProcessing(p,a) (p)->SetSoftwareVertexProcessing(a) +#define IDirect3DDevice9_GetSoftwareVertexProcessing(p) (p)->GetSoftwareVertexProcessing() +#define IDirect3DDevice9_SetNPatchMode(p,a) (p)->SetNPatchMode(a) +#define IDirect3DDevice9_GetNPatchMode(p) (p)->GetNPatchMode() +#define IDirect3DDevice9_DrawPrimitive(p,a,b,c) (p)->DrawPrimitive(a,b,c) +#define IDirect3DDevice9_DrawIndexedPrimitive(p,a,b,c,d,e,f) (p)->DrawIndexedPrimitive(a,b,c,d,e,f) +#define IDirect3DDevice9_DrawPrimitiveUP(p,a,b,c,d) (p)->DrawPrimitiveUP(a,b,c,d) +#define IDirect3DDevice9_DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) (p)->DrawIndexedPrimitiveUP(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9_ProcessVertices(p,a,b,c,d,e,f) (p)->ProcessVertices(a,b,c,d,e,f) +#define IDirect3DDevice9_CreateVertexDeclaration(p,a,b) (p)->CreateVertexDeclaration(a,b) +#define IDirect3DDevice9_SetVertexDeclaration(p,a) (p)->SetVertexDeclaration(a) +#define IDirect3DDevice9_GetVertexDeclaration(p,a) (p)->GetVertexDeclaration(a) +#define IDirect3DDevice9_SetFVF(p,a) (p)->SetFVF(a) +#define IDirect3DDevice9_GetFVF(p,a) (p)->GetFVF(a) +#define IDirect3DDevice9_CreateVertexShader(p,a,b) (p)->CreateVertexShader(a,b) +#define IDirect3DDevice9_SetVertexShader(p,a) (p)->SetVertexShader(a) +#define IDirect3DDevice9_GetVertexShader(p,a) (p)->GetVertexShader(a) +#define IDirect3DDevice9_SetVertexShaderConstantF(p,a,b,c) (p)->SetVertexShaderConstantF(a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantF(p,a,b,c) (p)->GetVertexShaderConstantF(a,b,c) +#define IDirect3DDevice9_SetVertexShaderConstantI(p,a,b,c) (p)->SetVertexShaderConstantI(a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantI(p,a,b,c) (p)->GetVertexShaderConstantI(a,b,c) +#define IDirect3DDevice9_SetVertexShaderConstantB(p,a,b,c) (p)->SetVertexShaderConstantB(a,b,c) +#define IDirect3DDevice9_GetVertexShaderConstantB(p,a,b,c) (p)->GetVertexShaderConstantB(a,b,c) +#define IDirect3DDevice9_SetStreamSource(p,a,b,c,d) (p)->SetStreamSource(a,b,c,d) +#define IDirect3DDevice9_GetStreamSource(p,a,b,c,d) (p)->GetStreamSource(a,b,c,d) +#define IDirect3DDevice9_SetStreamSourceFreq(p,a,b) (p)->SetStreamSourceFreq(a,b) +#define IDirect3DDevice9_GetStreamSourceFreq(p,a,b) (p)->GetStreamSourceFreq(a,b) +#define IDirect3DDevice9_SetIndices(p,a) (p)->SetIndices(a) +#define IDirect3DDevice9_GetIndices(p,a) (p)->GetIndices(a) +#define IDirect3DDevice9_CreatePixelShader(p,a,b) (p)->CreatePixelShader(a,b) +#define IDirect3DDevice9_SetPixelShader(p,a) (p)->SetPixelShader(a) +#define IDirect3DDevice9_GetPixelShader(p,a) (p)->GetPixelShader(a) +#define IDirect3DDevice9_SetPixelShaderConstantF(p,a,b,c) (p)->SetPixelShaderConstantF(a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantF(p,a,b,c) (p)->GetPixelShaderConstantF(a,b,c) +#define IDirect3DDevice9_SetPixelShaderConstantI(p,a,b,c) (p)->SetPixelShaderConstantI(a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantI(p,a,b,c) (p)->GetPixelShaderConstantI(a,b,c) +#define IDirect3DDevice9_SetPixelShaderConstantB(p,a,b,c) (p)->SetPixelShaderConstantB(a,b,c) +#define IDirect3DDevice9_GetPixelShaderConstantB(p,a,b,c) (p)->GetPixelShaderConstantB(a,b,c) +#define IDirect3DDevice9_DrawRectPatch(p,a,b,c) (p)->DrawRectPatch(a,b,c) +#define IDirect3DDevice9_DrawTriPatch(p,a,b,c) (p)->DrawTriPatch(a,b,c) +#define IDirect3DDevice9_DeletePatch(p,a) (p)->DeletePatch(a) +#define IDirect3DDevice9_CreateQuery(p,a,b) (p)->CreateQuery(a,b) +#endif + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DStateBlock9 + +DECLARE_INTERFACE_(IDirect3DStateBlock9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DStateBlock9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(Capture)(THIS) PURE; + STDMETHOD(Apply)(THIS) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DStateBlock9 *LPDIRECT3DSTATEBLOCK9, *PDIRECT3DSTATEBLOCK9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DStateBlock9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DStateBlock9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DStateBlock9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DStateBlock9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DStateBlock9_Capture(p) (p)->lpVtbl->Capture(p) +#define IDirect3DStateBlock9_Apply(p) (p)->lpVtbl->Apply(p) +#else +#define IDirect3DStateBlock9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DStateBlock9_AddRef(p) (p)->AddRef() +#define IDirect3DStateBlock9_Release(p) (p)->Release() +#define IDirect3DStateBlock9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DStateBlock9_Capture(p) (p)->Capture() +#define IDirect3DStateBlock9_Apply(p) (p)->Apply() +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DSwapChain9 + +DECLARE_INTERFACE_(IDirect3DSwapChain9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DSwapChain9 methods ***/ + STDMETHOD(Present)(THIS_ CONST RECT* pSourceRect,CONST RECT* pDestRect,HWND hDestWindowOverride,CONST RGNDATA* pDirtyRegion,DWORD dwFlags) PURE; + STDMETHOD(GetFrontBufferData)(THIS_ IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(GetBackBuffer)(THIS_ UINT iBackBuffer,D3DBACKBUFFER_TYPE Type,IDirect3DSurface9** ppBackBuffer) PURE; + STDMETHOD(GetRasterStatus)(THIS_ D3DRASTER_STATUS* pRasterStatus) PURE; + STDMETHOD(GetDisplayMode)(THIS_ D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(GetPresentParameters)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters) PURE; + + #ifdef D3D_DEBUG_INFO + D3DPRESENT_PARAMETERS PresentParameters; + D3DDISPLAYMODE DisplayMode; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DSwapChain9 *LPDIRECT3DSWAPCHAIN9, *PDIRECT3DSWAPCHAIN9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DSwapChain9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DSwapChain9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DSwapChain9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DSwapChain9_Present(p,a,b,c,d,e) (p)->lpVtbl->Present(p,a,b,c,d,e) +#define IDirect3DSwapChain9_GetFrontBufferData(p,a) (p)->lpVtbl->GetFrontBufferData(p,a) +#define IDirect3DSwapChain9_GetBackBuffer(p,a,b,c) (p)->lpVtbl->GetBackBuffer(p,a,b,c) +#define IDirect3DSwapChain9_GetRasterStatus(p,a) (p)->lpVtbl->GetRasterStatus(p,a) +#define IDirect3DSwapChain9_GetDisplayMode(p,a) (p)->lpVtbl->GetDisplayMode(p,a) +#define IDirect3DSwapChain9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DSwapChain9_GetPresentParameters(p,a) (p)->lpVtbl->GetPresentParameters(p,a) +#else +#define IDirect3DSwapChain9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DSwapChain9_AddRef(p) (p)->AddRef() +#define IDirect3DSwapChain9_Release(p) (p)->Release() +#define IDirect3DSwapChain9_Present(p,a,b,c,d,e) (p)->Present(a,b,c,d,e) +#define IDirect3DSwapChain9_GetFrontBufferData(p,a) (p)->GetFrontBufferData(a) +#define IDirect3DSwapChain9_GetBackBuffer(p,a,b,c) (p)->GetBackBuffer(a,b,c) +#define IDirect3DSwapChain9_GetRasterStatus(p,a) (p)->GetRasterStatus(a) +#define IDirect3DSwapChain9_GetDisplayMode(p,a) (p)->GetDisplayMode(a) +#define IDirect3DSwapChain9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DSwapChain9_GetPresentParameters(p,a) (p)->GetPresentParameters(a) +#endif + + + +#undef INTERFACE +#define INTERFACE IDirect3DResource9 + +DECLARE_INTERFACE_(IDirect3DResource9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DResource9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; +}; + +typedef struct IDirect3DResource9 *LPDIRECT3DRESOURCE9, *PDIRECT3DRESOURCE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DResource9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DResource9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DResource9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DResource9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DResource9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DResource9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DResource9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DResource9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DResource9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DResource9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DResource9_GetType(p) (p)->lpVtbl->GetType(p) +#else +#define IDirect3DResource9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DResource9_AddRef(p) (p)->AddRef() +#define IDirect3DResource9_Release(p) (p)->Release() +#define IDirect3DResource9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DResource9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DResource9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DResource9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DResource9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DResource9_GetPriority(p) (p)->GetPriority() +#define IDirect3DResource9_PreLoad(p) (p)->PreLoad() +#define IDirect3DResource9_GetType(p) (p)->GetType() +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DVertexDeclaration9 + +DECLARE_INTERFACE_(IDirect3DVertexDeclaration9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DVertexDeclaration9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(GetDeclaration)(THIS_ D3DVERTEXELEMENT9* pElement,UINT* pNumElements) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DVertexDeclaration9 *LPDIRECT3DVERTEXDECLARATION9, *PDIRECT3DVERTEXDECLARATION9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DVertexDeclaration9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DVertexDeclaration9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DVertexDeclaration9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DVertexDeclaration9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DVertexDeclaration9_GetDeclaration(p,a,b) (p)->lpVtbl->GetDeclaration(p,a,b) +#else +#define IDirect3DVertexDeclaration9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DVertexDeclaration9_AddRef(p) (p)->AddRef() +#define IDirect3DVertexDeclaration9_Release(p) (p)->Release() +#define IDirect3DVertexDeclaration9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DVertexDeclaration9_GetDeclaration(p,a,b) (p)->GetDeclaration(a,b) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DVertexShader9 + +DECLARE_INTERFACE_(IDirect3DVertexShader9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DVertexShader9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(GetFunction)(THIS_ void*,UINT* pSizeOfData) PURE; + + #ifdef D3D_DEBUG_INFO + DWORD Version; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DVertexShader9 *LPDIRECT3DVERTEXSHADER9, *PDIRECT3DVERTEXSHADER9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DVertexShader9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DVertexShader9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DVertexShader9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DVertexShader9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DVertexShader9_GetFunction(p,a,b) (p)->lpVtbl->GetFunction(p,a,b) +#else +#define IDirect3DVertexShader9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DVertexShader9_AddRef(p) (p)->AddRef() +#define IDirect3DVertexShader9_Release(p) (p)->Release() +#define IDirect3DVertexShader9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DVertexShader9_GetFunction(p,a,b) (p)->GetFunction(a,b) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DPixelShader9 + +DECLARE_INTERFACE_(IDirect3DPixelShader9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DPixelShader9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(GetFunction)(THIS_ void*,UINT* pSizeOfData) PURE; + + #ifdef D3D_DEBUG_INFO + DWORD Version; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DPixelShader9 *LPDIRECT3DPIXELSHADER9, *PDIRECT3DPIXELSHADER9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DPixelShader9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DPixelShader9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DPixelShader9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DPixelShader9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DPixelShader9_GetFunction(p,a,b) (p)->lpVtbl->GetFunction(p,a,b) +#else +#define IDirect3DPixelShader9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DPixelShader9_AddRef(p) (p)->AddRef() +#define IDirect3DPixelShader9_Release(p) (p)->Release() +#define IDirect3DPixelShader9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DPixelShader9_GetFunction(p,a,b) (p)->GetFunction(a,b) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DBaseTexture9 + +DECLARE_INTERFACE_(IDirect3DBaseTexture9, IDirect3DResource9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DResource9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD_(DWORD, SetLOD)(THIS_ DWORD LODNew) PURE; + STDMETHOD_(DWORD, GetLOD)(THIS) PURE; + STDMETHOD_(DWORD, GetLevelCount)(THIS) PURE; + STDMETHOD(SetAutoGenFilterType)(THIS_ D3DTEXTUREFILTERTYPE FilterType) PURE; + STDMETHOD_(D3DTEXTUREFILTERTYPE, GetAutoGenFilterType)(THIS) PURE; + STDMETHOD_(void, GenerateMipSubLevels)(THIS) PURE; +}; + +typedef struct IDirect3DBaseTexture9 *LPDIRECT3DBASETEXTURE9, *PDIRECT3DBASETEXTURE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DBaseTexture9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DBaseTexture9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DBaseTexture9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DBaseTexture9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DBaseTexture9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DBaseTexture9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DBaseTexture9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DBaseTexture9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DBaseTexture9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DBaseTexture9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DBaseTexture9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DBaseTexture9_SetLOD(p,a) (p)->lpVtbl->SetLOD(p,a) +#define IDirect3DBaseTexture9_GetLOD(p) (p)->lpVtbl->GetLOD(p) +#define IDirect3DBaseTexture9_GetLevelCount(p) (p)->lpVtbl->GetLevelCount(p) +#define IDirect3DBaseTexture9_SetAutoGenFilterType(p,a) (p)->lpVtbl->SetAutoGenFilterType(p,a) +#define IDirect3DBaseTexture9_GetAutoGenFilterType(p) (p)->lpVtbl->GetAutoGenFilterType(p) +#define IDirect3DBaseTexture9_GenerateMipSubLevels(p) (p)->lpVtbl->GenerateMipSubLevels(p) +#else +#define IDirect3DBaseTexture9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DBaseTexture9_AddRef(p) (p)->AddRef() +#define IDirect3DBaseTexture9_Release(p) (p)->Release() +#define IDirect3DBaseTexture9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DBaseTexture9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DBaseTexture9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DBaseTexture9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DBaseTexture9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DBaseTexture9_GetPriority(p) (p)->GetPriority() +#define IDirect3DBaseTexture9_PreLoad(p) (p)->PreLoad() +#define IDirect3DBaseTexture9_GetType(p) (p)->GetType() +#define IDirect3DBaseTexture9_SetLOD(p,a) (p)->SetLOD(a) +#define IDirect3DBaseTexture9_GetLOD(p) (p)->GetLOD() +#define IDirect3DBaseTexture9_GetLevelCount(p) (p)->GetLevelCount() +#define IDirect3DBaseTexture9_SetAutoGenFilterType(p,a) (p)->SetAutoGenFilterType(a) +#define IDirect3DBaseTexture9_GetAutoGenFilterType(p) (p)->GetAutoGenFilterType() +#define IDirect3DBaseTexture9_GenerateMipSubLevels(p) (p)->GenerateMipSubLevels() +#endif + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DTexture9 + +DECLARE_INTERFACE_(IDirect3DTexture9, IDirect3DBaseTexture9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DBaseTexture9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD_(DWORD, SetLOD)(THIS_ DWORD LODNew) PURE; + STDMETHOD_(DWORD, GetLOD)(THIS) PURE; + STDMETHOD_(DWORD, GetLevelCount)(THIS) PURE; + STDMETHOD(SetAutoGenFilterType)(THIS_ D3DTEXTUREFILTERTYPE FilterType) PURE; + STDMETHOD_(D3DTEXTUREFILTERTYPE, GetAutoGenFilterType)(THIS) PURE; + STDMETHOD_(void, GenerateMipSubLevels)(THIS) PURE; + STDMETHOD(GetLevelDesc)(THIS_ UINT Level,D3DSURFACE_DESC *pDesc) PURE; + STDMETHOD(GetSurfaceLevel)(THIS_ UINT Level,IDirect3DSurface9** ppSurfaceLevel) PURE; + STDMETHOD(LockRect)(THIS_ UINT Level,D3DLOCKED_RECT* pLockedRect,CONST RECT* pRect,DWORD Flags) PURE; + STDMETHOD(UnlockRect)(THIS_ UINT Level) PURE; + STDMETHOD(AddDirtyRect)(THIS_ CONST RECT* pDirtyRect) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Width; + UINT Height; + UINT Levels; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + DWORD Priority; + DWORD LOD; + D3DTEXTUREFILTERTYPE FilterType; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DTexture9 *LPDIRECT3DTEXTURE9, *PDIRECT3DTEXTURE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DTexture9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DTexture9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DTexture9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DTexture9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DTexture9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DTexture9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DTexture9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DTexture9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DTexture9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DTexture9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DTexture9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DTexture9_SetLOD(p,a) (p)->lpVtbl->SetLOD(p,a) +#define IDirect3DTexture9_GetLOD(p) (p)->lpVtbl->GetLOD(p) +#define IDirect3DTexture9_GetLevelCount(p) (p)->lpVtbl->GetLevelCount(p) +#define IDirect3DTexture9_SetAutoGenFilterType(p,a) (p)->lpVtbl->SetAutoGenFilterType(p,a) +#define IDirect3DTexture9_GetAutoGenFilterType(p) (p)->lpVtbl->GetAutoGenFilterType(p) +#define IDirect3DTexture9_GenerateMipSubLevels(p) (p)->lpVtbl->GenerateMipSubLevels(p) +#define IDirect3DTexture9_GetLevelDesc(p,a,b) (p)->lpVtbl->GetLevelDesc(p,a,b) +#define IDirect3DTexture9_GetSurfaceLevel(p,a,b) (p)->lpVtbl->GetSurfaceLevel(p,a,b) +#define IDirect3DTexture9_LockRect(p,a,b,c,d) (p)->lpVtbl->LockRect(p,a,b,c,d) +#define IDirect3DTexture9_UnlockRect(p,a) (p)->lpVtbl->UnlockRect(p,a) +#define IDirect3DTexture9_AddDirtyRect(p,a) (p)->lpVtbl->AddDirtyRect(p,a) +#else +#define IDirect3DTexture9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DTexture9_AddRef(p) (p)->AddRef() +#define IDirect3DTexture9_Release(p) (p)->Release() +#define IDirect3DTexture9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DTexture9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DTexture9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DTexture9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DTexture9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DTexture9_GetPriority(p) (p)->GetPriority() +#define IDirect3DTexture9_PreLoad(p) (p)->PreLoad() +#define IDirect3DTexture9_GetType(p) (p)->GetType() +#define IDirect3DTexture9_SetLOD(p,a) (p)->SetLOD(a) +#define IDirect3DTexture9_GetLOD(p) (p)->GetLOD() +#define IDirect3DTexture9_GetLevelCount(p) (p)->GetLevelCount() +#define IDirect3DTexture9_SetAutoGenFilterType(p,a) (p)->SetAutoGenFilterType(a) +#define IDirect3DTexture9_GetAutoGenFilterType(p) (p)->GetAutoGenFilterType() +#define IDirect3DTexture9_GenerateMipSubLevels(p) (p)->GenerateMipSubLevels() +#define IDirect3DTexture9_GetLevelDesc(p,a,b) (p)->GetLevelDesc(a,b) +#define IDirect3DTexture9_GetSurfaceLevel(p,a,b) (p)->GetSurfaceLevel(a,b) +#define IDirect3DTexture9_LockRect(p,a,b,c,d) (p)->LockRect(a,b,c,d) +#define IDirect3DTexture9_UnlockRect(p,a) (p)->UnlockRect(a) +#define IDirect3DTexture9_AddDirtyRect(p,a) (p)->AddDirtyRect(a) +#endif + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DVolumeTexture9 + +DECLARE_INTERFACE_(IDirect3DVolumeTexture9, IDirect3DBaseTexture9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DBaseTexture9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD_(DWORD, SetLOD)(THIS_ DWORD LODNew) PURE; + STDMETHOD_(DWORD, GetLOD)(THIS) PURE; + STDMETHOD_(DWORD, GetLevelCount)(THIS) PURE; + STDMETHOD(SetAutoGenFilterType)(THIS_ D3DTEXTUREFILTERTYPE FilterType) PURE; + STDMETHOD_(D3DTEXTUREFILTERTYPE, GetAutoGenFilterType)(THIS) PURE; + STDMETHOD_(void, GenerateMipSubLevels)(THIS) PURE; + STDMETHOD(GetLevelDesc)(THIS_ UINT Level,D3DVOLUME_DESC *pDesc) PURE; + STDMETHOD(GetVolumeLevel)(THIS_ UINT Level,IDirect3DVolume9** ppVolumeLevel) PURE; + STDMETHOD(LockBox)(THIS_ UINT Level,D3DLOCKED_BOX* pLockedVolume,CONST D3DBOX* pBox,DWORD Flags) PURE; + STDMETHOD(UnlockBox)(THIS_ UINT Level) PURE; + STDMETHOD(AddDirtyBox)(THIS_ CONST D3DBOX* pDirtyBox) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Width; + UINT Height; + UINT Depth; + UINT Levels; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + DWORD Priority; + DWORD LOD; + D3DTEXTUREFILTERTYPE FilterType; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DVolumeTexture9 *LPDIRECT3DVOLUMETEXTURE9, *PDIRECT3DVOLUMETEXTURE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DVolumeTexture9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DVolumeTexture9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DVolumeTexture9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DVolumeTexture9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DVolumeTexture9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DVolumeTexture9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DVolumeTexture9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DVolumeTexture9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DVolumeTexture9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DVolumeTexture9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DVolumeTexture9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DVolumeTexture9_SetLOD(p,a) (p)->lpVtbl->SetLOD(p,a) +#define IDirect3DVolumeTexture9_GetLOD(p) (p)->lpVtbl->GetLOD(p) +#define IDirect3DVolumeTexture9_GetLevelCount(p) (p)->lpVtbl->GetLevelCount(p) +#define IDirect3DVolumeTexture9_SetAutoGenFilterType(p,a) (p)->lpVtbl->SetAutoGenFilterType(p,a) +#define IDirect3DVolumeTexture9_GetAutoGenFilterType(p) (p)->lpVtbl->GetAutoGenFilterType(p) +#define IDirect3DVolumeTexture9_GenerateMipSubLevels(p) (p)->lpVtbl->GenerateMipSubLevels(p) +#define IDirect3DVolumeTexture9_GetLevelDesc(p,a,b) (p)->lpVtbl->GetLevelDesc(p,a,b) +#define IDirect3DVolumeTexture9_GetVolumeLevel(p,a,b) (p)->lpVtbl->GetVolumeLevel(p,a,b) +#define IDirect3DVolumeTexture9_LockBox(p,a,b,c,d) (p)->lpVtbl->LockBox(p,a,b,c,d) +#define IDirect3DVolumeTexture9_UnlockBox(p,a) (p)->lpVtbl->UnlockBox(p,a) +#define IDirect3DVolumeTexture9_AddDirtyBox(p,a) (p)->lpVtbl->AddDirtyBox(p,a) +#else +#define IDirect3DVolumeTexture9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DVolumeTexture9_AddRef(p) (p)->AddRef() +#define IDirect3DVolumeTexture9_Release(p) (p)->Release() +#define IDirect3DVolumeTexture9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DVolumeTexture9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DVolumeTexture9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DVolumeTexture9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DVolumeTexture9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DVolumeTexture9_GetPriority(p) (p)->GetPriority() +#define IDirect3DVolumeTexture9_PreLoad(p) (p)->PreLoad() +#define IDirect3DVolumeTexture9_GetType(p) (p)->GetType() +#define IDirect3DVolumeTexture9_SetLOD(p,a) (p)->SetLOD(a) +#define IDirect3DVolumeTexture9_GetLOD(p) (p)->GetLOD() +#define IDirect3DVolumeTexture9_GetLevelCount(p) (p)->GetLevelCount() +#define IDirect3DVolumeTexture9_SetAutoGenFilterType(p,a) (p)->SetAutoGenFilterType(a) +#define IDirect3DVolumeTexture9_GetAutoGenFilterType(p) (p)->GetAutoGenFilterType() +#define IDirect3DVolumeTexture9_GenerateMipSubLevels(p) (p)->GenerateMipSubLevels() +#define IDirect3DVolumeTexture9_GetLevelDesc(p,a,b) (p)->GetLevelDesc(a,b) +#define IDirect3DVolumeTexture9_GetVolumeLevel(p,a,b) (p)->GetVolumeLevel(a,b) +#define IDirect3DVolumeTexture9_LockBox(p,a,b,c,d) (p)->LockBox(a,b,c,d) +#define IDirect3DVolumeTexture9_UnlockBox(p,a) (p)->UnlockBox(a) +#define IDirect3DVolumeTexture9_AddDirtyBox(p,a) (p)->AddDirtyBox(a) +#endif + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DCubeTexture9 + +DECLARE_INTERFACE_(IDirect3DCubeTexture9, IDirect3DBaseTexture9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DBaseTexture9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD_(DWORD, SetLOD)(THIS_ DWORD LODNew) PURE; + STDMETHOD_(DWORD, GetLOD)(THIS) PURE; + STDMETHOD_(DWORD, GetLevelCount)(THIS) PURE; + STDMETHOD(SetAutoGenFilterType)(THIS_ D3DTEXTUREFILTERTYPE FilterType) PURE; + STDMETHOD_(D3DTEXTUREFILTERTYPE, GetAutoGenFilterType)(THIS) PURE; + STDMETHOD_(void, GenerateMipSubLevels)(THIS) PURE; + STDMETHOD(GetLevelDesc)(THIS_ UINT Level,D3DSURFACE_DESC *pDesc) PURE; + STDMETHOD(GetCubeMapSurface)(THIS_ D3DCUBEMAP_FACES FaceType,UINT Level,IDirect3DSurface9** ppCubeMapSurface) PURE; + STDMETHOD(LockRect)(THIS_ D3DCUBEMAP_FACES FaceType,UINT Level,D3DLOCKED_RECT* pLockedRect,CONST RECT* pRect,DWORD Flags) PURE; + STDMETHOD(UnlockRect)(THIS_ D3DCUBEMAP_FACES FaceType,UINT Level) PURE; + STDMETHOD(AddDirtyRect)(THIS_ D3DCUBEMAP_FACES FaceType,CONST RECT* pDirtyRect) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Width; + UINT Height; + UINT Levels; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + DWORD Priority; + DWORD LOD; + D3DTEXTUREFILTERTYPE FilterType; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DCubeTexture9 *LPDIRECT3DCUBETEXTURE9, *PDIRECT3DCUBETEXTURE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DCubeTexture9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DCubeTexture9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DCubeTexture9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DCubeTexture9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DCubeTexture9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DCubeTexture9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DCubeTexture9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DCubeTexture9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DCubeTexture9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DCubeTexture9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DCubeTexture9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DCubeTexture9_SetLOD(p,a) (p)->lpVtbl->SetLOD(p,a) +#define IDirect3DCubeTexture9_GetLOD(p) (p)->lpVtbl->GetLOD(p) +#define IDirect3DCubeTexture9_GetLevelCount(p) (p)->lpVtbl->GetLevelCount(p) +#define IDirect3DCubeTexture9_SetAutoGenFilterType(p,a) (p)->lpVtbl->SetAutoGenFilterType(p,a) +#define IDirect3DCubeTexture9_GetAutoGenFilterType(p) (p)->lpVtbl->GetAutoGenFilterType(p) +#define IDirect3DCubeTexture9_GenerateMipSubLevels(p) (p)->lpVtbl->GenerateMipSubLevels(p) +#define IDirect3DCubeTexture9_GetLevelDesc(p,a,b) (p)->lpVtbl->GetLevelDesc(p,a,b) +#define IDirect3DCubeTexture9_GetCubeMapSurface(p,a,b,c) (p)->lpVtbl->GetCubeMapSurface(p,a,b,c) +#define IDirect3DCubeTexture9_LockRect(p,a,b,c,d,e) (p)->lpVtbl->LockRect(p,a,b,c,d,e) +#define IDirect3DCubeTexture9_UnlockRect(p,a,b) (p)->lpVtbl->UnlockRect(p,a,b) +#define IDirect3DCubeTexture9_AddDirtyRect(p,a,b) (p)->lpVtbl->AddDirtyRect(p,a,b) +#else +#define IDirect3DCubeTexture9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DCubeTexture9_AddRef(p) (p)->AddRef() +#define IDirect3DCubeTexture9_Release(p) (p)->Release() +#define IDirect3DCubeTexture9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DCubeTexture9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DCubeTexture9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DCubeTexture9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DCubeTexture9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DCubeTexture9_GetPriority(p) (p)->GetPriority() +#define IDirect3DCubeTexture9_PreLoad(p) (p)->PreLoad() +#define IDirect3DCubeTexture9_GetType(p) (p)->GetType() +#define IDirect3DCubeTexture9_SetLOD(p,a) (p)->SetLOD(a) +#define IDirect3DCubeTexture9_GetLOD(p) (p)->GetLOD() +#define IDirect3DCubeTexture9_GetLevelCount(p) (p)->GetLevelCount() +#define IDirect3DCubeTexture9_SetAutoGenFilterType(p,a) (p)->SetAutoGenFilterType(a) +#define IDirect3DCubeTexture9_GetAutoGenFilterType(p) (p)->GetAutoGenFilterType() +#define IDirect3DCubeTexture9_GenerateMipSubLevels(p) (p)->GenerateMipSubLevels() +#define IDirect3DCubeTexture9_GetLevelDesc(p,a,b) (p)->GetLevelDesc(a,b) +#define IDirect3DCubeTexture9_GetCubeMapSurface(p,a,b,c) (p)->GetCubeMapSurface(a,b,c) +#define IDirect3DCubeTexture9_LockRect(p,a,b,c,d,e) (p)->LockRect(a,b,c,d,e) +#define IDirect3DCubeTexture9_UnlockRect(p,a,b) (p)->UnlockRect(a,b) +#define IDirect3DCubeTexture9_AddDirtyRect(p,a,b) (p)->AddDirtyRect(a,b) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DVertexBuffer9 + +DECLARE_INTERFACE_(IDirect3DVertexBuffer9, IDirect3DResource9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DResource9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD(Lock)(THIS_ UINT OffsetToLock,UINT SizeToLock,void** ppbData,DWORD Flags) PURE; + STDMETHOD(Unlock)(THIS) PURE; + STDMETHOD(GetDesc)(THIS_ D3DVERTEXBUFFER_DESC *pDesc) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Length; + DWORD Usage; + DWORD FVF; + D3DPOOL Pool; + DWORD Priority; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DVertexBuffer9 *LPDIRECT3DVERTEXBUFFER9, *PDIRECT3DVERTEXBUFFER9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DVertexBuffer9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DVertexBuffer9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DVertexBuffer9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DVertexBuffer9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DVertexBuffer9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DVertexBuffer9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DVertexBuffer9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DVertexBuffer9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DVertexBuffer9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DVertexBuffer9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DVertexBuffer9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DVertexBuffer9_Lock(p,a,b,c,d) (p)->lpVtbl->Lock(p,a,b,c,d) +#define IDirect3DVertexBuffer9_Unlock(p) (p)->lpVtbl->Unlock(p) +#define IDirect3DVertexBuffer9_GetDesc(p,a) (p)->lpVtbl->GetDesc(p,a) +#else +#define IDirect3DVertexBuffer9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DVertexBuffer9_AddRef(p) (p)->AddRef() +#define IDirect3DVertexBuffer9_Release(p) (p)->Release() +#define IDirect3DVertexBuffer9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DVertexBuffer9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DVertexBuffer9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DVertexBuffer9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DVertexBuffer9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DVertexBuffer9_GetPriority(p) (p)->GetPriority() +#define IDirect3DVertexBuffer9_PreLoad(p) (p)->PreLoad() +#define IDirect3DVertexBuffer9_GetType(p) (p)->GetType() +#define IDirect3DVertexBuffer9_Lock(p,a,b,c,d) (p)->Lock(a,b,c,d) +#define IDirect3DVertexBuffer9_Unlock(p) (p)->Unlock() +#define IDirect3DVertexBuffer9_GetDesc(p,a) (p)->GetDesc(a) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DIndexBuffer9 + +DECLARE_INTERFACE_(IDirect3DIndexBuffer9, IDirect3DResource9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DResource9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD(Lock)(THIS_ UINT OffsetToLock,UINT SizeToLock,void** ppbData,DWORD Flags) PURE; + STDMETHOD(Unlock)(THIS) PURE; + STDMETHOD(GetDesc)(THIS_ D3DINDEXBUFFER_DESC *pDesc) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Length; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + DWORD Priority; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DIndexBuffer9 *LPDIRECT3DINDEXBUFFER9, *PDIRECT3DINDEXBUFFER9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DIndexBuffer9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DIndexBuffer9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DIndexBuffer9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DIndexBuffer9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DIndexBuffer9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DIndexBuffer9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DIndexBuffer9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DIndexBuffer9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DIndexBuffer9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DIndexBuffer9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DIndexBuffer9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DIndexBuffer9_Lock(p,a,b,c,d) (p)->lpVtbl->Lock(p,a,b,c,d) +#define IDirect3DIndexBuffer9_Unlock(p) (p)->lpVtbl->Unlock(p) +#define IDirect3DIndexBuffer9_GetDesc(p,a) (p)->lpVtbl->GetDesc(p,a) +#else +#define IDirect3DIndexBuffer9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DIndexBuffer9_AddRef(p) (p)->AddRef() +#define IDirect3DIndexBuffer9_Release(p) (p)->Release() +#define IDirect3DIndexBuffer9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DIndexBuffer9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DIndexBuffer9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DIndexBuffer9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DIndexBuffer9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DIndexBuffer9_GetPriority(p) (p)->GetPriority() +#define IDirect3DIndexBuffer9_PreLoad(p) (p)->PreLoad() +#define IDirect3DIndexBuffer9_GetType(p) (p)->GetType() +#define IDirect3DIndexBuffer9_Lock(p,a,b,c,d) (p)->Lock(a,b,c,d) +#define IDirect3DIndexBuffer9_Unlock(p) (p)->Unlock() +#define IDirect3DIndexBuffer9_GetDesc(p,a) (p)->GetDesc(a) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DSurface9 + +DECLARE_INTERFACE_(IDirect3DSurface9, IDirect3DResource9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DResource9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD_(DWORD, SetPriority)(THIS_ DWORD PriorityNew) PURE; + STDMETHOD_(DWORD, GetPriority)(THIS) PURE; + STDMETHOD_(void, PreLoad)(THIS) PURE; + STDMETHOD_(D3DRESOURCETYPE, GetType)(THIS) PURE; + STDMETHOD(GetContainer)(THIS_ REFIID riid,void** ppContainer) PURE; + STDMETHOD(GetDesc)(THIS_ D3DSURFACE_DESC *pDesc) PURE; + STDMETHOD(LockRect)(THIS_ D3DLOCKED_RECT* pLockedRect,CONST RECT* pRect,DWORD Flags) PURE; + STDMETHOD(UnlockRect)(THIS) PURE; + STDMETHOD(GetDC)(THIS_ HDC *phdc) PURE; + STDMETHOD(ReleaseDC)(THIS_ HDC hdc) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Width; + UINT Height; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + D3DMULTISAMPLE_TYPE MultiSampleType; + DWORD MultiSampleQuality; + DWORD Priority; + UINT LockCount; + UINT DCCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DSurface9 *LPDIRECT3DSURFACE9, *PDIRECT3DSURFACE9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DSurface9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DSurface9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DSurface9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DSurface9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DSurface9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DSurface9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DSurface9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DSurface9_SetPriority(p,a) (p)->lpVtbl->SetPriority(p,a) +#define IDirect3DSurface9_GetPriority(p) (p)->lpVtbl->GetPriority(p) +#define IDirect3DSurface9_PreLoad(p) (p)->lpVtbl->PreLoad(p) +#define IDirect3DSurface9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DSurface9_GetContainer(p,a,b) (p)->lpVtbl->GetContainer(p,a,b) +#define IDirect3DSurface9_GetDesc(p,a) (p)->lpVtbl->GetDesc(p,a) +#define IDirect3DSurface9_LockRect(p,a,b,c) (p)->lpVtbl->LockRect(p,a,b,c) +#define IDirect3DSurface9_UnlockRect(p) (p)->lpVtbl->UnlockRect(p) +#define IDirect3DSurface9_GetDC(p,a) (p)->lpVtbl->GetDC(p,a) +#define IDirect3DSurface9_ReleaseDC(p,a) (p)->lpVtbl->ReleaseDC(p,a) +#else +#define IDirect3DSurface9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DSurface9_AddRef(p) (p)->AddRef() +#define IDirect3DSurface9_Release(p) (p)->Release() +#define IDirect3DSurface9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DSurface9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DSurface9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DSurface9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DSurface9_SetPriority(p,a) (p)->SetPriority(a) +#define IDirect3DSurface9_GetPriority(p) (p)->GetPriority() +#define IDirect3DSurface9_PreLoad(p) (p)->PreLoad() +#define IDirect3DSurface9_GetType(p) (p)->GetType() +#define IDirect3DSurface9_GetContainer(p,a,b) (p)->GetContainer(a,b) +#define IDirect3DSurface9_GetDesc(p,a) (p)->GetDesc(a) +#define IDirect3DSurface9_LockRect(p,a,b,c) (p)->LockRect(a,b,c) +#define IDirect3DSurface9_UnlockRect(p) (p)->UnlockRect() +#define IDirect3DSurface9_GetDC(p,a) (p)->GetDC(a) +#define IDirect3DSurface9_ReleaseDC(p,a) (p)->ReleaseDC(a) +#endif + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DVolume9 + +DECLARE_INTERFACE_(IDirect3DVolume9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DVolume9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(SetPrivateData)(THIS_ REFGUID refguid,CONST void* pData,DWORD SizeOfData,DWORD Flags) PURE; + STDMETHOD(GetPrivateData)(THIS_ REFGUID refguid,void* pData,DWORD* pSizeOfData) PURE; + STDMETHOD(FreePrivateData)(THIS_ REFGUID refguid) PURE; + STDMETHOD(GetContainer)(THIS_ REFIID riid,void** ppContainer) PURE; + STDMETHOD(GetDesc)(THIS_ D3DVOLUME_DESC *pDesc) PURE; + STDMETHOD(LockBox)(THIS_ D3DLOCKED_BOX * pLockedVolume,CONST D3DBOX* pBox,DWORD Flags) PURE; + STDMETHOD(UnlockBox)(THIS) PURE; + + #ifdef D3D_DEBUG_INFO + LPCWSTR Name; + UINT Width; + UINT Height; + UINT Depth; + DWORD Usage; + D3DFORMAT Format; + D3DPOOL Pool; + UINT LockCount; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DVolume9 *LPDIRECT3DVOLUME9, *PDIRECT3DVOLUME9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DVolume9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DVolume9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DVolume9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DVolume9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DVolume9_SetPrivateData(p,a,b,c,d) (p)->lpVtbl->SetPrivateData(p,a,b,c,d) +#define IDirect3DVolume9_GetPrivateData(p,a,b,c) (p)->lpVtbl->GetPrivateData(p,a,b,c) +#define IDirect3DVolume9_FreePrivateData(p,a) (p)->lpVtbl->FreePrivateData(p,a) +#define IDirect3DVolume9_GetContainer(p,a,b) (p)->lpVtbl->GetContainer(p,a,b) +#define IDirect3DVolume9_GetDesc(p,a) (p)->lpVtbl->GetDesc(p,a) +#define IDirect3DVolume9_LockBox(p,a,b,c) (p)->lpVtbl->LockBox(p,a,b,c) +#define IDirect3DVolume9_UnlockBox(p) (p)->lpVtbl->UnlockBox(p) +#else +#define IDirect3DVolume9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DVolume9_AddRef(p) (p)->AddRef() +#define IDirect3DVolume9_Release(p) (p)->Release() +#define IDirect3DVolume9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DVolume9_SetPrivateData(p,a,b,c,d) (p)->SetPrivateData(a,b,c,d) +#define IDirect3DVolume9_GetPrivateData(p,a,b,c) (p)->GetPrivateData(a,b,c) +#define IDirect3DVolume9_FreePrivateData(p,a) (p)->FreePrivateData(a) +#define IDirect3DVolume9_GetContainer(p,a,b) (p)->GetContainer(a,b) +#define IDirect3DVolume9_GetDesc(p,a) (p)->GetDesc(a) +#define IDirect3DVolume9_LockBox(p,a,b,c) (p)->LockBox(a,b,c) +#define IDirect3DVolume9_UnlockBox(p) (p)->UnlockBox() +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DQuery9 + +DECLARE_INTERFACE_(IDirect3DQuery9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DQuery9 methods ***/ + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD_(D3DQUERYTYPE, GetType)(THIS) PURE; + STDMETHOD_(DWORD, GetDataSize)(THIS) PURE; + STDMETHOD(Issue)(THIS_ DWORD dwIssueFlags) PURE; + STDMETHOD(GetData)(THIS_ void* pData,DWORD dwSize,DWORD dwGetDataFlags) PURE; + + #ifdef D3D_DEBUG_INFO + D3DQUERYTYPE Type; + DWORD DataSize; + LPCWSTR CreationCallStack; + #endif +}; + +typedef struct IDirect3DQuery9 *LPDIRECT3DQUERY9, *PDIRECT3DQUERY9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DQuery9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DQuery9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DQuery9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DQuery9_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DQuery9_GetType(p) (p)->lpVtbl->GetType(p) +#define IDirect3DQuery9_GetDataSize(p) (p)->lpVtbl->GetDataSize(p) +#define IDirect3DQuery9_Issue(p,a) (p)->lpVtbl->Issue(p,a) +#define IDirect3DQuery9_GetData(p,a,b,c) (p)->lpVtbl->GetData(p,a,b,c) +#else +#define IDirect3DQuery9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DQuery9_AddRef(p) (p)->AddRef() +#define IDirect3DQuery9_Release(p) (p)->Release() +#define IDirect3DQuery9_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DQuery9_GetType(p) (p)->GetType() +#define IDirect3DQuery9_GetDataSize(p) (p)->GetDataSize() +#define IDirect3DQuery9_Issue(p,a) (p)->Issue(a) +#define IDirect3DQuery9_GetData(p,a,b,c) (p)->GetData(a,b,c) +#endif + +/**************************************************************************** + * Flags for SetPrivateData method on all D3D9 interfaces + * + * The passed pointer is an IUnknown ptr. The SizeOfData argument to SetPrivateData + * must be set to sizeof(IUnknown*). Direct3D will call AddRef through this + * pointer and Release when the private data is destroyed. The data will be + * destroyed when another SetPrivateData with the same GUID is set, when + * FreePrivateData is called, or when the D3D9 object is freed. + ****************************************************************************/ +#define D3DSPD_IUNKNOWN 0x00000001L + +/**************************************************************************** + * + * Flags for IDirect3D9::CreateDevice's BehaviorFlags + * + ****************************************************************************/ + +#define D3DCREATE_FPU_PRESERVE 0x00000002L +#define D3DCREATE_MULTITHREADED 0x00000004L + +#define D3DCREATE_PUREDEVICE 0x00000010L +#define D3DCREATE_SOFTWARE_VERTEXPROCESSING 0x00000020L +#define D3DCREATE_HARDWARE_VERTEXPROCESSING 0x00000040L +#define D3DCREATE_MIXED_VERTEXPROCESSING 0x00000080L + +#define D3DCREATE_DISABLE_DRIVER_MANAGEMENT 0x00000100L +#define D3DCREATE_ADAPTERGROUP_DEVICE 0x00000200L +#define D3DCREATE_DISABLE_DRIVER_MANAGEMENT_EX 0x00000400L + +// This flag causes the D3D runtime not to alter the focus +// window in any way. Use with caution- the burden of supporting +// focus management events (alt-tab, etc.) falls on the +// application, and appropriate responses (switching display +// mode, etc.) should be coded. +#define D3DCREATE_NOWINDOWCHANGES 0x00000800L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +// Disable multithreading for software vertex processing +#define D3DCREATE_DISABLE_PSGP_THREADING 0x00002000L +// This flag enables present statistics on device. +#define D3DCREATE_ENABLE_PRESENTSTATS 0x00004000L +// This flag disables printscreen support in the runtime for this device +#define D3DCREATE_DISABLE_PRINTSCREEN 0x00008000L + +#define D3DCREATE_SCREENSAVER 0x10000000L + + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + + +/**************************************************************************** + * + * Parameter for IDirect3D9::CreateDevice's Adapter argument + * + ****************************************************************************/ + +#define D3DADAPTER_DEFAULT 0 + +/**************************************************************************** + * + * Flags for IDirect3D9::EnumAdapters + * + ****************************************************************************/ + +/* + * The D3DENUM_WHQL_LEVEL value has been retired for 9Ex and future versions, + * but it needs to be defined here for compatibility with DX9 and earlier versions. + * See the DirectX SDK for sample code on discovering driver signatures. + */ +#define D3DENUM_WHQL_LEVEL 0x00000002L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +/* NO_DRIVERVERSION will not fill out the DriverVersion field, nor will the + DriverVersion be incorporated into the DeviceIdentifier GUID. WINNT only */ +#define D3DENUM_NO_DRIVERVERSION 0x00000004L + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + +/**************************************************************************** + * + * Maximum number of back-buffers supported in DX9 + * + ****************************************************************************/ + +#define D3DPRESENT_BACK_BUFFERS_MAX 3L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +/**************************************************************************** + * + * Maximum number of back-buffers supported when apps use CreateDeviceEx + * + ****************************************************************************/ + +#define D3DPRESENT_BACK_BUFFERS_MAX_EX 30L + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +/**************************************************************************** + * + * Flags for IDirect3DDevice9::SetGammaRamp + * + ****************************************************************************/ + +#define D3DSGR_NO_CALIBRATION 0x00000000L +#define D3DSGR_CALIBRATE 0x00000001L + +/**************************************************************************** + * + * Flags for IDirect3DDevice9::SetCursorPosition + * + ****************************************************************************/ + +#define D3DCURSOR_IMMEDIATE_UPDATE 0x00000001L + +/**************************************************************************** + * + * Flags for IDirect3DSwapChain9::Present + * + ****************************************************************************/ + +#define D3DPRESENT_DONOTWAIT 0x00000001L +#define D3DPRESENT_LINEAR_CONTENT 0x00000002L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +#define D3DPRESENT_DONOTFLIP 0x00000004L +#define D3DPRESENT_FLIPRESTART 0x00000008L +#define D3DPRESENT_VIDEO_RESTRICT_TO_MONITOR 0x00000010L +#define D3DPRESENT_UPDATEOVERLAYONLY 0x00000020L +#define D3DPRESENT_HIDEOVERLAY 0x00000040L +#define D3DPRESENT_UPDATECOLORKEY 0x00000080L +#define D3DPRESENT_FORCEIMMEDIATE 0x00000100L + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + +/**************************************************************************** + * + * Flags for DrawPrimitive/DrawIndexedPrimitive + * Also valid for Begin/BeginIndexed + * Also valid for VertexBuffer::CreateVertexBuffer + ****************************************************************************/ + + +/* + * DirectDraw error codes + */ +#define _FACD3D 0x876 +#define MAKE_D3DHRESULT( code ) MAKE_HRESULT( 1, _FACD3D, code ) +#define MAKE_D3DSTATUS( code ) MAKE_HRESULT( 0, _FACD3D, code ) + +/* + * Direct3D Errors + */ +#define D3D_OK S_OK + +#define D3DERR_WRONGTEXTUREFORMAT MAKE_D3DHRESULT(2072) +#define D3DERR_UNSUPPORTEDCOLOROPERATION MAKE_D3DHRESULT(2073) +#define D3DERR_UNSUPPORTEDCOLORARG MAKE_D3DHRESULT(2074) +#define D3DERR_UNSUPPORTEDALPHAOPERATION MAKE_D3DHRESULT(2075) +#define D3DERR_UNSUPPORTEDALPHAARG MAKE_D3DHRESULT(2076) +#define D3DERR_TOOMANYOPERATIONS MAKE_D3DHRESULT(2077) +#define D3DERR_CONFLICTINGTEXTUREFILTER MAKE_D3DHRESULT(2078) +#define D3DERR_UNSUPPORTEDFACTORVALUE MAKE_D3DHRESULT(2079) +#define D3DERR_CONFLICTINGRENDERSTATE MAKE_D3DHRESULT(2081) +#define D3DERR_UNSUPPORTEDTEXTUREFILTER MAKE_D3DHRESULT(2082) +#define D3DERR_CONFLICTINGTEXTUREPALETTE MAKE_D3DHRESULT(2086) +#define D3DERR_DRIVERINTERNALERROR MAKE_D3DHRESULT(2087) + +#define D3DERR_NOTFOUND MAKE_D3DHRESULT(2150) +#define D3DERR_MOREDATA MAKE_D3DHRESULT(2151) +#define D3DERR_DEVICELOST MAKE_D3DHRESULT(2152) +#define D3DERR_DEVICENOTRESET MAKE_D3DHRESULT(2153) +#define D3DERR_NOTAVAILABLE MAKE_D3DHRESULT(2154) +#define D3DERR_OUTOFVIDEOMEMORY MAKE_D3DHRESULT(380) +#define D3DERR_INVALIDDEVICE MAKE_D3DHRESULT(2155) +#define D3DERR_INVALIDCALL MAKE_D3DHRESULT(2156) +#define D3DERR_DRIVERINVALIDCALL MAKE_D3DHRESULT(2157) +#define D3DERR_WASSTILLDRAWING MAKE_D3DHRESULT(540) +#define D3DOK_NOAUTOGEN MAKE_D3DSTATUS(2159) + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + + +#define D3DERR_DEVICEREMOVED MAKE_D3DHRESULT(2160) +#define S_NOT_RESIDENT MAKE_D3DSTATUS(2165) +#define S_RESIDENT_IN_SHARED_MEMORY MAKE_D3DSTATUS(2166) +#define S_PRESENT_MODE_CHANGED MAKE_D3DSTATUS(2167) +#define S_PRESENT_OCCLUDED MAKE_D3DSTATUS(2168) +#define D3DERR_DEVICEHUNG MAKE_D3DHRESULT(2164) +#define D3DERR_UNSUPPORTEDOVERLAY MAKE_D3DHRESULT(2171) +#define D3DERR_UNSUPPORTEDOVERLAYFORMAT MAKE_D3DHRESULT(2172) +#define D3DERR_CANNOTPROTECTCONTENT MAKE_D3DHRESULT(2173) +#define D3DERR_UNSUPPORTEDCRYPTO MAKE_D3DHRESULT(2174) +#define D3DERR_PRESENT_STATISTICS_DISJOINT MAKE_D3DHRESULT(2180) + + +/********************* +/* D3D9Ex interfaces +/*********************/ + +HRESULT WINAPI Direct3DCreate9Ex(UINT SDKVersion, IDirect3D9Ex**); + + + + +#undef INTERFACE +#define INTERFACE IDirect3D9Ex + +DECLARE_INTERFACE_(IDirect3D9Ex, IDirect3D9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3D9 methods ***/ + STDMETHOD(RegisterSoftwareDevice)(THIS_ void* pInitializeFunction) PURE; + STDMETHOD_(UINT, GetAdapterCount)(THIS) PURE; + STDMETHOD(GetAdapterIdentifier)(THIS_ UINT Adapter,DWORD Flags,D3DADAPTER_IDENTIFIER9* pIdentifier) PURE; + STDMETHOD_(UINT, GetAdapterModeCount)(THIS_ UINT Adapter,D3DFORMAT Format) PURE; + STDMETHOD(EnumAdapterModes)(THIS_ UINT Adapter,D3DFORMAT Format,UINT Mode,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetAdapterDisplayMode)(THIS_ UINT Adapter,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(CheckDeviceType)(THIS_ UINT Adapter,D3DDEVTYPE DevType,D3DFORMAT AdapterFormat,D3DFORMAT BackBufferFormat,BOOL bWindowed) PURE; + STDMETHOD(CheckDeviceFormat)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,DWORD Usage,D3DRESOURCETYPE RType,D3DFORMAT CheckFormat) PURE; + STDMETHOD(CheckDeviceMultiSampleType)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SurfaceFormat,BOOL Windowed,D3DMULTISAMPLE_TYPE MultiSampleType,DWORD* pQualityLevels) PURE; + STDMETHOD(CheckDepthStencilMatch)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT AdapterFormat,D3DFORMAT RenderTargetFormat,D3DFORMAT DepthStencilFormat) PURE; + STDMETHOD(CheckDeviceFormatConversion)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DFORMAT SourceFormat,D3DFORMAT TargetFormat) PURE; + STDMETHOD(GetDeviceCaps)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,D3DCAPS9* pCaps) PURE; + STDMETHOD_(HMONITOR, GetAdapterMonitor)(THIS_ UINT Adapter) PURE; + STDMETHOD(CreateDevice)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,HWND hFocusWindow,DWORD BehaviorFlags,D3DPRESENT_PARAMETERS* pPresentationParameters,IDirect3DDevice9** ppReturnedDeviceInterface) PURE; + STDMETHOD_(UINT, GetAdapterModeCountEx)(THIS_ UINT Adapter,CONST D3DDISPLAYMODEFILTER* pFilter ) PURE; + STDMETHOD(EnumAdapterModesEx)(THIS_ UINT Adapter,CONST D3DDISPLAYMODEFILTER* pFilter,UINT Mode,D3DDISPLAYMODEEX* pMode) PURE; + STDMETHOD(GetAdapterDisplayModeEx)(THIS_ UINT Adapter,D3DDISPLAYMODEEX* pMode,D3DDISPLAYROTATION* pRotation) PURE; + STDMETHOD(CreateDeviceEx)(THIS_ UINT Adapter,D3DDEVTYPE DeviceType,HWND hFocusWindow,DWORD BehaviorFlags,D3DPRESENT_PARAMETERS* pPresentationParameters,D3DDISPLAYMODEEX* pFullscreenDisplayMode,IDirect3DDevice9Ex** ppReturnedDeviceInterface) PURE; + STDMETHOD(GetAdapterLUID)(THIS_ UINT Adapter,LUID * pLUID) PURE; +}; + +typedef struct IDirect3D9Ex *LPDIRECT3D9EX, *PDIRECT3D9EX; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3D9Ex_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3D9Ex_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3D9Ex_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3D9Ex_RegisterSoftwareDevice(p,a) (p)->lpVtbl->RegisterSoftwareDevice(p,a) +#define IDirect3D9Ex_GetAdapterCount(p) (p)->lpVtbl->GetAdapterCount(p) +#define IDirect3D9Ex_GetAdapterIdentifier(p,a,b,c) (p)->lpVtbl->GetAdapterIdentifier(p,a,b,c) +#define IDirect3D9Ex_GetAdapterModeCount(p,a,b) (p)->lpVtbl->GetAdapterModeCount(p,a,b) +#define IDirect3D9Ex_EnumAdapterModes(p,a,b,c,d) (p)->lpVtbl->EnumAdapterModes(p,a,b,c,d) +#define IDirect3D9Ex_GetAdapterDisplayMode(p,a,b) (p)->lpVtbl->GetAdapterDisplayMode(p,a,b) +#define IDirect3D9Ex_CheckDeviceType(p,a,b,c,d,e) (p)->lpVtbl->CheckDeviceType(p,a,b,c,d,e) +#define IDirect3D9Ex_CheckDeviceFormat(p,a,b,c,d,e,f) (p)->lpVtbl->CheckDeviceFormat(p,a,b,c,d,e,f) +#define IDirect3D9Ex_CheckDeviceMultiSampleType(p,a,b,c,d,e,f) (p)->lpVtbl->CheckDeviceMultiSampleType(p,a,b,c,d,e,f) +#define IDirect3D9Ex_CheckDepthStencilMatch(p,a,b,c,d,e) (p)->lpVtbl->CheckDepthStencilMatch(p,a,b,c,d,e) +#define IDirect3D9Ex_CheckDeviceFormatConversion(p,a,b,c,d) (p)->lpVtbl->CheckDeviceFormatConversion(p,a,b,c,d) +#define IDirect3D9Ex_GetDeviceCaps(p,a,b,c) (p)->lpVtbl->GetDeviceCaps(p,a,b,c) +#define IDirect3D9Ex_GetAdapterMonitor(p,a) (p)->lpVtbl->GetAdapterMonitor(p,a) +#define IDirect3D9Ex_CreateDevice(p,a,b,c,d,e,f) (p)->lpVtbl->CreateDevice(p,a,b,c,d,e,f) +#define IDirect3D9Ex_GetAdapterModeCountEx(p,a,b) (p)->lpVtbl->GetAdapterModeCountEx(p,a,b) +#define IDirect3D9Ex_EnumAdapterModesEx(p,a,b,c,d) (p)->lpVtbl->EnumAdapterModesEx(p,a,b,c,d) +#define IDirect3D9Ex_GetAdapterDisplayModeEx(p,a,b,c) (p)->lpVtbl->GetAdapterDisplayModeEx(p,a,b,c) +#define IDirect3D9Ex_CreateDeviceEx(p,a,b,c,d,e,f,g) (p)->lpVtbl->CreateDeviceEx(p,a,b,c,d,e,f,g) +#define IDirect3D9Ex_GetAdapterLUID(p,a,b) (p)->lpVtbl->GetAdapterLUID(p,a,b) +#else +#define IDirect3D9Ex_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3D9Ex_AddRef(p) (p)->AddRef() +#define IDirect3D9Ex_Release(p) (p)->Release() +#define IDirect3D9Ex_RegisterSoftwareDevice(p,a) (p)->RegisterSoftwareDevice(a) +#define IDirect3D9Ex_GetAdapterCount(p) (p)->GetAdapterCount() +#define IDirect3D9Ex_GetAdapterIdentifier(p,a,b,c) (p)->GetAdapterIdentifier(a,b,c) +#define IDirect3D9Ex_GetAdapterModeCount(p,a,b) (p)->GetAdapterModeCount(a,b) +#define IDirect3D9Ex_EnumAdapterModes(p,a,b,c,d) (p)->EnumAdapterModes(a,b,c,d) +#define IDirect3D9Ex_GetAdapterDisplayMode(p,a,b) (p)->GetAdapterDisplayMode(a,b) +#define IDirect3D9Ex_CheckDeviceType(p,a,b,c,d,e) (p)->CheckDeviceType(a,b,c,d,e) +#define IDirect3D9Ex_CheckDeviceFormat(p,a,b,c,d,e,f) (p)->CheckDeviceFormat(a,b,c,d,e,f) +#define IDirect3D9Ex_CheckDeviceMultiSampleType(p,a,b,c,d,e,f) (p)->CheckDeviceMultiSampleType(a,b,c,d,e,f) +#define IDirect3D9Ex_CheckDepthStencilMatch(p,a,b,c,d,e) (p)->CheckDepthStencilMatch(a,b,c,d,e) +#define IDirect3D9Ex_CheckDeviceFormatConversion(p,a,b,c,d) (p)->CheckDeviceFormatConversion(a,b,c,d) +#define IDirect3D9Ex_GetDeviceCaps(p,a,b,c) (p)->GetDeviceCaps(a,b,c) +#define IDirect3D9Ex_GetAdapterMonitor(p,a) (p)->GetAdapterMonitor(a) +#define IDirect3D9Ex_CreateDevice(p,a,b,c,d,e,f) (p)->CreateDevice(a,b,c,d,e,f) +#define IDirect3D9Ex_GetAdapterModeCountEx(p,a,b) (p)->GetAdapterModeCountEx(a,b) +#define IDirect3D9Ex_EnumAdapterModesEx(p,a,b,c,d) (p)->EnumAdapterModesEx(a,b,c,d) +#define IDirect3D9Ex_GetAdapterDisplayModeEx(p,a,b,c) (p)->GetAdapterDisplayModeEx(a,b,c) +#define IDirect3D9Ex_CreateDeviceEx(p,a,b,c,d,e,f,g) (p)->CreateDeviceEx(a,b,c,d,e,f,g) +#define IDirect3D9Ex_GetAdapterLUID(p,a,b) (p)->GetAdapterLUID(a,b) +#endif + + + + + + + + + + + + + + + + + + + + + + + + +#undef INTERFACE +#define INTERFACE IDirect3DDevice9Ex + +DECLARE_INTERFACE_(IDirect3DDevice9Ex, IDirect3DDevice9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DDevice9 methods ***/ + STDMETHOD(TestCooperativeLevel)(THIS) PURE; + STDMETHOD_(UINT, GetAvailableTextureMem)(THIS) PURE; + STDMETHOD(EvictManagedResources)(THIS) PURE; + STDMETHOD(GetDirect3D)(THIS_ IDirect3D9** ppD3D9) PURE; + STDMETHOD(GetDeviceCaps)(THIS_ D3DCAPS9* pCaps) PURE; + STDMETHOD(GetDisplayMode)(THIS_ UINT iSwapChain,D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetCreationParameters)(THIS_ D3DDEVICE_CREATION_PARAMETERS *pParameters) PURE; + STDMETHOD(SetCursorProperties)(THIS_ UINT XHotSpot,UINT YHotSpot,IDirect3DSurface9* pCursorBitmap) PURE; + STDMETHOD_(void, SetCursorPosition)(THIS_ int X,int Y,DWORD Flags) PURE; + STDMETHOD_(BOOL, ShowCursor)(THIS_ BOOL bShow) PURE; + STDMETHOD(CreateAdditionalSwapChain)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters,IDirect3DSwapChain9** pSwapChain) PURE; + STDMETHOD(GetSwapChain)(THIS_ UINT iSwapChain,IDirect3DSwapChain9** pSwapChain) PURE; + STDMETHOD_(UINT, GetNumberOfSwapChains)(THIS) PURE; + STDMETHOD(Reset)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters) PURE; + STDMETHOD(Present)(THIS_ CONST RECT* pSourceRect,CONST RECT* pDestRect,HWND hDestWindowOverride,CONST RGNDATA* pDirtyRegion) PURE; + STDMETHOD(GetBackBuffer)(THIS_ UINT iSwapChain,UINT iBackBuffer,D3DBACKBUFFER_TYPE Type,IDirect3DSurface9** ppBackBuffer) PURE; + STDMETHOD(GetRasterStatus)(THIS_ UINT iSwapChain,D3DRASTER_STATUS* pRasterStatus) PURE; + STDMETHOD(SetDialogBoxMode)(THIS_ BOOL bEnableDialogs) PURE; + STDMETHOD_(void, SetGammaRamp)(THIS_ UINT iSwapChain,DWORD Flags,CONST D3DGAMMARAMP* pRamp) PURE; + STDMETHOD_(void, GetGammaRamp)(THIS_ UINT iSwapChain,D3DGAMMARAMP* pRamp) PURE; + STDMETHOD(CreateTexture)(THIS_ UINT Width,UINT Height,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DTexture9** ppTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateVolumeTexture)(THIS_ UINT Width,UINT Height,UINT Depth,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DVolumeTexture9** ppVolumeTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateCubeTexture)(THIS_ UINT EdgeLength,UINT Levels,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DCubeTexture9** ppCubeTexture,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateVertexBuffer)(THIS_ UINT Length,DWORD Usage,DWORD FVF,D3DPOOL Pool,IDirect3DVertexBuffer9** ppVertexBuffer,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateIndexBuffer)(THIS_ UINT Length,DWORD Usage,D3DFORMAT Format,D3DPOOL Pool,IDirect3DIndexBuffer9** ppIndexBuffer,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateRenderTarget)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Lockable,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(CreateDepthStencilSurface)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Discard,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(UpdateSurface)(THIS_ IDirect3DSurface9* pSourceSurface,CONST RECT* pSourceRect,IDirect3DSurface9* pDestinationSurface,CONST POINT* pDestPoint) PURE; + STDMETHOD(UpdateTexture)(THIS_ IDirect3DBaseTexture9* pSourceTexture,IDirect3DBaseTexture9* pDestinationTexture) PURE; + STDMETHOD(GetRenderTargetData)(THIS_ IDirect3DSurface9* pRenderTarget,IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(GetFrontBufferData)(THIS_ UINT iSwapChain,IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(StretchRect)(THIS_ IDirect3DSurface9* pSourceSurface,CONST RECT* pSourceRect,IDirect3DSurface9* pDestSurface,CONST RECT* pDestRect,D3DTEXTUREFILTERTYPE Filter) PURE; + STDMETHOD(ColorFill)(THIS_ IDirect3DSurface9* pSurface,CONST RECT* pRect,D3DCOLOR color) PURE; + STDMETHOD(CreateOffscreenPlainSurface)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DPOOL Pool,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle) PURE; + STDMETHOD(SetRenderTarget)(THIS_ DWORD RenderTargetIndex,IDirect3DSurface9* pRenderTarget) PURE; + STDMETHOD(GetRenderTarget)(THIS_ DWORD RenderTargetIndex,IDirect3DSurface9** ppRenderTarget) PURE; + STDMETHOD(SetDepthStencilSurface)(THIS_ IDirect3DSurface9* pNewZStencil) PURE; + STDMETHOD(GetDepthStencilSurface)(THIS_ IDirect3DSurface9** ppZStencilSurface) PURE; + STDMETHOD(BeginScene)(THIS) PURE; + STDMETHOD(EndScene)(THIS) PURE; + STDMETHOD(Clear)(THIS_ DWORD Count,CONST D3DRECT* pRects,DWORD Flags,D3DCOLOR Color,float Z,DWORD Stencil) PURE; + STDMETHOD(SetTransform)(THIS_ D3DTRANSFORMSTATETYPE State,CONST D3DMATRIX* pMatrix) PURE; + STDMETHOD(GetTransform)(THIS_ D3DTRANSFORMSTATETYPE State,D3DMATRIX* pMatrix) PURE; + STDMETHOD(MultiplyTransform)(THIS_ D3DTRANSFORMSTATETYPE,CONST D3DMATRIX*) PURE; + STDMETHOD(SetViewport)(THIS_ CONST D3DVIEWPORT9* pViewport) PURE; + STDMETHOD(GetViewport)(THIS_ D3DVIEWPORT9* pViewport) PURE; + STDMETHOD(SetMaterial)(THIS_ CONST D3DMATERIAL9* pMaterial) PURE; + STDMETHOD(GetMaterial)(THIS_ D3DMATERIAL9* pMaterial) PURE; + STDMETHOD(SetLight)(THIS_ DWORD Index,CONST D3DLIGHT9*) PURE; + STDMETHOD(GetLight)(THIS_ DWORD Index,D3DLIGHT9*) PURE; + STDMETHOD(LightEnable)(THIS_ DWORD Index,BOOL Enable) PURE; + STDMETHOD(GetLightEnable)(THIS_ DWORD Index,BOOL* pEnable) PURE; + STDMETHOD(SetClipPlane)(THIS_ DWORD Index,CONST float* pPlane) PURE; + STDMETHOD(GetClipPlane)(THIS_ DWORD Index,float* pPlane) PURE; + STDMETHOD(SetRenderState)(THIS_ D3DRENDERSTATETYPE State,DWORD Value) PURE; + STDMETHOD(GetRenderState)(THIS_ D3DRENDERSTATETYPE State,DWORD* pValue) PURE; + STDMETHOD(CreateStateBlock)(THIS_ D3DSTATEBLOCKTYPE Type,IDirect3DStateBlock9** ppSB) PURE; + STDMETHOD(BeginStateBlock)(THIS) PURE; + STDMETHOD(EndStateBlock)(THIS_ IDirect3DStateBlock9** ppSB) PURE; + STDMETHOD(SetClipStatus)(THIS_ CONST D3DCLIPSTATUS9* pClipStatus) PURE; + STDMETHOD(GetClipStatus)(THIS_ D3DCLIPSTATUS9* pClipStatus) PURE; + STDMETHOD(GetTexture)(THIS_ DWORD Stage,IDirect3DBaseTexture9** ppTexture) PURE; + STDMETHOD(SetTexture)(THIS_ DWORD Stage,IDirect3DBaseTexture9* pTexture) PURE; + STDMETHOD(GetTextureStageState)(THIS_ DWORD Stage,D3DTEXTURESTAGESTATETYPE Type,DWORD* pValue) PURE; + STDMETHOD(SetTextureStageState)(THIS_ DWORD Stage,D3DTEXTURESTAGESTATETYPE Type,DWORD Value) PURE; + STDMETHOD(GetSamplerState)(THIS_ DWORD Sampler,D3DSAMPLERSTATETYPE Type,DWORD* pValue) PURE; + STDMETHOD(SetSamplerState)(THIS_ DWORD Sampler,D3DSAMPLERSTATETYPE Type,DWORD Value) PURE; + STDMETHOD(ValidateDevice)(THIS_ DWORD* pNumPasses) PURE; + STDMETHOD(SetPaletteEntries)(THIS_ UINT PaletteNumber,CONST PALETTEENTRY* pEntries) PURE; + STDMETHOD(GetPaletteEntries)(THIS_ UINT PaletteNumber,PALETTEENTRY* pEntries) PURE; + STDMETHOD(SetCurrentTexturePalette)(THIS_ UINT PaletteNumber) PURE; + STDMETHOD(GetCurrentTexturePalette)(THIS_ UINT *PaletteNumber) PURE; + STDMETHOD(SetScissorRect)(THIS_ CONST RECT* pRect) PURE; + STDMETHOD(GetScissorRect)(THIS_ RECT* pRect) PURE; + STDMETHOD(SetSoftwareVertexProcessing)(THIS_ BOOL bSoftware) PURE; + STDMETHOD_(BOOL, GetSoftwareVertexProcessing)(THIS) PURE; + STDMETHOD(SetNPatchMode)(THIS_ float nSegments) PURE; + STDMETHOD_(float, GetNPatchMode)(THIS) PURE; + STDMETHOD(DrawPrimitive)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT StartVertex,UINT PrimitiveCount) PURE; + STDMETHOD(DrawIndexedPrimitive)(THIS_ D3DPRIMITIVETYPE,INT BaseVertexIndex,UINT MinVertexIndex,UINT NumVertices,UINT startIndex,UINT primCount) PURE; + STDMETHOD(DrawPrimitiveUP)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT PrimitiveCount,CONST void* pVertexStreamZeroData,UINT VertexStreamZeroStride) PURE; + STDMETHOD(DrawIndexedPrimitiveUP)(THIS_ D3DPRIMITIVETYPE PrimitiveType,UINT MinVertexIndex,UINT NumVertices,UINT PrimitiveCount,CONST void* pIndexData,D3DFORMAT IndexDataFormat,CONST void* pVertexStreamZeroData,UINT VertexStreamZeroStride) PURE; + STDMETHOD(ProcessVertices)(THIS_ UINT SrcStartIndex,UINT DestIndex,UINT VertexCount,IDirect3DVertexBuffer9* pDestBuffer,IDirect3DVertexDeclaration9* pVertexDecl,DWORD Flags) PURE; + STDMETHOD(CreateVertexDeclaration)(THIS_ CONST D3DVERTEXELEMENT9* pVertexElements,IDirect3DVertexDeclaration9** ppDecl) PURE; + STDMETHOD(SetVertexDeclaration)(THIS_ IDirect3DVertexDeclaration9* pDecl) PURE; + STDMETHOD(GetVertexDeclaration)(THIS_ IDirect3DVertexDeclaration9** ppDecl) PURE; + STDMETHOD(SetFVF)(THIS_ DWORD FVF) PURE; + STDMETHOD(GetFVF)(THIS_ DWORD* pFVF) PURE; + STDMETHOD(CreateVertexShader)(THIS_ CONST DWORD* pFunction,IDirect3DVertexShader9** ppShader) PURE; + STDMETHOD(SetVertexShader)(THIS_ IDirect3DVertexShader9* pShader) PURE; + STDMETHOD(GetVertexShader)(THIS_ IDirect3DVertexShader9** ppShader) PURE; + STDMETHOD(SetVertexShaderConstantF)(THIS_ UINT StartRegister,CONST float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(GetVertexShaderConstantF)(THIS_ UINT StartRegister,float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(SetVertexShaderConstantI)(THIS_ UINT StartRegister,CONST int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(GetVertexShaderConstantI)(THIS_ UINT StartRegister,int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(SetVertexShaderConstantB)(THIS_ UINT StartRegister,CONST BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(GetVertexShaderConstantB)(THIS_ UINT StartRegister,BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(SetStreamSource)(THIS_ UINT StreamNumber,IDirect3DVertexBuffer9* pStreamData,UINT OffsetInBytes,UINT Stride) PURE; + STDMETHOD(GetStreamSource)(THIS_ UINT StreamNumber,IDirect3DVertexBuffer9** ppStreamData,UINT* pOffsetInBytes,UINT* pStride) PURE; + STDMETHOD(SetStreamSourceFreq)(THIS_ UINT StreamNumber,UINT Setting) PURE; + STDMETHOD(GetStreamSourceFreq)(THIS_ UINT StreamNumber,UINT* pSetting) PURE; + STDMETHOD(SetIndices)(THIS_ IDirect3DIndexBuffer9* pIndexData) PURE; + STDMETHOD(GetIndices)(THIS_ IDirect3DIndexBuffer9** ppIndexData) PURE; + STDMETHOD(CreatePixelShader)(THIS_ CONST DWORD* pFunction,IDirect3DPixelShader9** ppShader) PURE; + STDMETHOD(SetPixelShader)(THIS_ IDirect3DPixelShader9* pShader) PURE; + STDMETHOD(GetPixelShader)(THIS_ IDirect3DPixelShader9** ppShader) PURE; + STDMETHOD(SetPixelShaderConstantF)(THIS_ UINT StartRegister,CONST float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(GetPixelShaderConstantF)(THIS_ UINT StartRegister,float* pConstantData,UINT Vector4fCount) PURE; + STDMETHOD(SetPixelShaderConstantI)(THIS_ UINT StartRegister,CONST int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(GetPixelShaderConstantI)(THIS_ UINT StartRegister,int* pConstantData,UINT Vector4iCount) PURE; + STDMETHOD(SetPixelShaderConstantB)(THIS_ UINT StartRegister,CONST BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(GetPixelShaderConstantB)(THIS_ UINT StartRegister,BOOL* pConstantData,UINT BoolCount) PURE; + STDMETHOD(DrawRectPatch)(THIS_ UINT Handle,CONST float* pNumSegs,CONST D3DRECTPATCH_INFO* pRectPatchInfo) PURE; + STDMETHOD(DrawTriPatch)(THIS_ UINT Handle,CONST float* pNumSegs,CONST D3DTRIPATCH_INFO* pTriPatchInfo) PURE; + STDMETHOD(DeletePatch)(THIS_ UINT Handle) PURE; + STDMETHOD(CreateQuery)(THIS_ D3DQUERYTYPE Type,IDirect3DQuery9** ppQuery) PURE; + STDMETHOD(SetConvolutionMonoKernel)(THIS_ UINT width,UINT height,float* rows,float* columns) PURE; + STDMETHOD(ComposeRects)(THIS_ IDirect3DSurface9* pSrc,IDirect3DSurface9* pDst,IDirect3DVertexBuffer9* pSrcRectDescs,UINT NumRects,IDirect3DVertexBuffer9* pDstRectDescs,D3DCOMPOSERECTSOP Operation,int Xoffset,int Yoffset) PURE; + STDMETHOD(PresentEx)(THIS_ CONST RECT* pSourceRect,CONST RECT* pDestRect,HWND hDestWindowOverride,CONST RGNDATA* pDirtyRegion,DWORD dwFlags) PURE; + STDMETHOD(GetGPUThreadPriority)(THIS_ INT* pPriority) PURE; + STDMETHOD(SetGPUThreadPriority)(THIS_ INT Priority) PURE; + STDMETHOD(WaitForVBlank)(THIS_ UINT iSwapChain) PURE; + STDMETHOD(CheckResourceResidency)(THIS_ IDirect3DResource9** pResourceArray,UINT32 NumResources) PURE; + STDMETHOD(SetMaximumFrameLatency)(THIS_ UINT MaxLatency) PURE; + STDMETHOD(GetMaximumFrameLatency)(THIS_ UINT* pMaxLatency) PURE; + STDMETHOD(CheckDeviceState)(THIS_ HWND hDestinationWindow) PURE; + STDMETHOD(CreateRenderTargetEx)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Lockable,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle,DWORD Usage) PURE; + STDMETHOD(CreateOffscreenPlainSurfaceEx)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DPOOL Pool,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle,DWORD Usage) PURE; + STDMETHOD(CreateDepthStencilSurfaceEx)(THIS_ UINT Width,UINT Height,D3DFORMAT Format,D3DMULTISAMPLE_TYPE MultiSample,DWORD MultisampleQuality,BOOL Discard,IDirect3DSurface9** ppSurface,HANDLE* pSharedHandle,DWORD Usage) PURE; + STDMETHOD(ResetEx)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters,D3DDISPLAYMODEEX *pFullscreenDisplayMode) PURE; + STDMETHOD(GetDisplayModeEx)(THIS_ UINT iSwapChain,D3DDISPLAYMODEEX* pMode,D3DDISPLAYROTATION* pRotation) PURE; +}; + +typedef struct IDirect3DDevice9Ex *LPDIRECT3DDEVICE9EX, *PDIRECT3DDEVICE9EX; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DDevice9Ex_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DDevice9Ex_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DDevice9Ex_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DDevice9Ex_TestCooperativeLevel(p) (p)->lpVtbl->TestCooperativeLevel(p) +#define IDirect3DDevice9Ex_GetAvailableTextureMem(p) (p)->lpVtbl->GetAvailableTextureMem(p) +#define IDirect3DDevice9Ex_EvictManagedResources(p) (p)->lpVtbl->EvictManagedResources(p) +#define IDirect3DDevice9Ex_GetDirect3D(p,a) (p)->lpVtbl->GetDirect3D(p,a) +#define IDirect3DDevice9Ex_GetDeviceCaps(p,a) (p)->lpVtbl->GetDeviceCaps(p,a) +#define IDirect3DDevice9Ex_GetDisplayMode(p,a,b) (p)->lpVtbl->GetDisplayMode(p,a,b) +#define IDirect3DDevice9Ex_GetCreationParameters(p,a) (p)->lpVtbl->GetCreationParameters(p,a) +#define IDirect3DDevice9Ex_SetCursorProperties(p,a,b,c) (p)->lpVtbl->SetCursorProperties(p,a,b,c) +#define IDirect3DDevice9Ex_SetCursorPosition(p,a,b,c) (p)->lpVtbl->SetCursorPosition(p,a,b,c) +#define IDirect3DDevice9Ex_ShowCursor(p,a) (p)->lpVtbl->ShowCursor(p,a) +#define IDirect3DDevice9Ex_CreateAdditionalSwapChain(p,a,b) (p)->lpVtbl->CreateAdditionalSwapChain(p,a,b) +#define IDirect3DDevice9Ex_GetSwapChain(p,a,b) (p)->lpVtbl->GetSwapChain(p,a,b) +#define IDirect3DDevice9Ex_GetNumberOfSwapChains(p) (p)->lpVtbl->GetNumberOfSwapChains(p) +#define IDirect3DDevice9Ex_Reset(p,a) (p)->lpVtbl->Reset(p,a) +#define IDirect3DDevice9Ex_Present(p,a,b,c,d) (p)->lpVtbl->Present(p,a,b,c,d) +#define IDirect3DDevice9Ex_GetBackBuffer(p,a,b,c,d) (p)->lpVtbl->GetBackBuffer(p,a,b,c,d) +#define IDirect3DDevice9Ex_GetRasterStatus(p,a,b) (p)->lpVtbl->GetRasterStatus(p,a,b) +#define IDirect3DDevice9Ex_SetDialogBoxMode(p,a) (p)->lpVtbl->SetDialogBoxMode(p,a) +#define IDirect3DDevice9Ex_SetGammaRamp(p,a,b,c) (p)->lpVtbl->SetGammaRamp(p,a,b,c) +#define IDirect3DDevice9Ex_GetGammaRamp(p,a,b) (p)->lpVtbl->GetGammaRamp(p,a,b) +#define IDirect3DDevice9Ex_CreateTexture(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateTexture(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) (p)->lpVtbl->CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_CreateCubeTexture(p,a,b,c,d,e,f,g) (p)->lpVtbl->CreateCubeTexture(p,a,b,c,d,e,f,g) +#define IDirect3DDevice9Ex_CreateVertexBuffer(p,a,b,c,d,e,f) (p)->lpVtbl->CreateVertexBuffer(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateIndexBuffer(p,a,b,c,d,e,f) (p)->lpVtbl->CreateIndexBuffer(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateRenderTarget(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateRenderTarget(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_UpdateSurface(p,a,b,c,d) (p)->lpVtbl->UpdateSurface(p,a,b,c,d) +#define IDirect3DDevice9Ex_UpdateTexture(p,a,b) (p)->lpVtbl->UpdateTexture(p,a,b) +#define IDirect3DDevice9Ex_GetRenderTargetData(p,a,b) (p)->lpVtbl->GetRenderTargetData(p,a,b) +#define IDirect3DDevice9Ex_GetFrontBufferData(p,a,b) (p)->lpVtbl->GetFrontBufferData(p,a,b) +#define IDirect3DDevice9Ex_StretchRect(p,a,b,c,d,e) (p)->lpVtbl->StretchRect(p,a,b,c,d,e) +#define IDirect3DDevice9Ex_ColorFill(p,a,b,c) (p)->lpVtbl->ColorFill(p,a,b,c) +#define IDirect3DDevice9Ex_CreateOffscreenPlainSurface(p,a,b,c,d,e,f) (p)->lpVtbl->CreateOffscreenPlainSurface(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_SetRenderTarget(p,a,b) (p)->lpVtbl->SetRenderTarget(p,a,b) +#define IDirect3DDevice9Ex_GetRenderTarget(p,a,b) (p)->lpVtbl->GetRenderTarget(p,a,b) +#define IDirect3DDevice9Ex_SetDepthStencilSurface(p,a) (p)->lpVtbl->SetDepthStencilSurface(p,a) +#define IDirect3DDevice9Ex_GetDepthStencilSurface(p,a) (p)->lpVtbl->GetDepthStencilSurface(p,a) +#define IDirect3DDevice9Ex_BeginScene(p) (p)->lpVtbl->BeginScene(p) +#define IDirect3DDevice9Ex_EndScene(p) (p)->lpVtbl->EndScene(p) +#define IDirect3DDevice9Ex_Clear(p,a,b,c,d,e,f) (p)->lpVtbl->Clear(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_SetTransform(p,a,b) (p)->lpVtbl->SetTransform(p,a,b) +#define IDirect3DDevice9Ex_GetTransform(p,a,b) (p)->lpVtbl->GetTransform(p,a,b) +#define IDirect3DDevice9Ex_MultiplyTransform(p,a,b) (p)->lpVtbl->MultiplyTransform(p,a,b) +#define IDirect3DDevice9Ex_SetViewport(p,a) (p)->lpVtbl->SetViewport(p,a) +#define IDirect3DDevice9Ex_GetViewport(p,a) (p)->lpVtbl->GetViewport(p,a) +#define IDirect3DDevice9Ex_SetMaterial(p,a) (p)->lpVtbl->SetMaterial(p,a) +#define IDirect3DDevice9Ex_GetMaterial(p,a) (p)->lpVtbl->GetMaterial(p,a) +#define IDirect3DDevice9Ex_SetLight(p,a,b) (p)->lpVtbl->SetLight(p,a,b) +#define IDirect3DDevice9Ex_GetLight(p,a,b) (p)->lpVtbl->GetLight(p,a,b) +#define IDirect3DDevice9Ex_LightEnable(p,a,b) (p)->lpVtbl->LightEnable(p,a,b) +#define IDirect3DDevice9Ex_GetLightEnable(p,a,b) (p)->lpVtbl->GetLightEnable(p,a,b) +#define IDirect3DDevice9Ex_SetClipPlane(p,a,b) (p)->lpVtbl->SetClipPlane(p,a,b) +#define IDirect3DDevice9Ex_GetClipPlane(p,a,b) (p)->lpVtbl->GetClipPlane(p,a,b) +#define IDirect3DDevice9Ex_SetRenderState(p,a,b) (p)->lpVtbl->SetRenderState(p,a,b) +#define IDirect3DDevice9Ex_GetRenderState(p,a,b) (p)->lpVtbl->GetRenderState(p,a,b) +#define IDirect3DDevice9Ex_CreateStateBlock(p,a,b) (p)->lpVtbl->CreateStateBlock(p,a,b) +#define IDirect3DDevice9Ex_BeginStateBlock(p) (p)->lpVtbl->BeginStateBlock(p) +#define IDirect3DDevice9Ex_EndStateBlock(p,a) (p)->lpVtbl->EndStateBlock(p,a) +#define IDirect3DDevice9Ex_SetClipStatus(p,a) (p)->lpVtbl->SetClipStatus(p,a) +#define IDirect3DDevice9Ex_GetClipStatus(p,a) (p)->lpVtbl->GetClipStatus(p,a) +#define IDirect3DDevice9Ex_GetTexture(p,a,b) (p)->lpVtbl->GetTexture(p,a,b) +#define IDirect3DDevice9Ex_SetTexture(p,a,b) (p)->lpVtbl->SetTexture(p,a,b) +#define IDirect3DDevice9Ex_GetTextureStageState(p,a,b,c) (p)->lpVtbl->GetTextureStageState(p,a,b,c) +#define IDirect3DDevice9Ex_SetTextureStageState(p,a,b,c) (p)->lpVtbl->SetTextureStageState(p,a,b,c) +#define IDirect3DDevice9Ex_GetSamplerState(p,a,b,c) (p)->lpVtbl->GetSamplerState(p,a,b,c) +#define IDirect3DDevice9Ex_SetSamplerState(p,a,b,c) (p)->lpVtbl->SetSamplerState(p,a,b,c) +#define IDirect3DDevice9Ex_ValidateDevice(p,a) (p)->lpVtbl->ValidateDevice(p,a) +#define IDirect3DDevice9Ex_SetPaletteEntries(p,a,b) (p)->lpVtbl->SetPaletteEntries(p,a,b) +#define IDirect3DDevice9Ex_GetPaletteEntries(p,a,b) (p)->lpVtbl->GetPaletteEntries(p,a,b) +#define IDirect3DDevice9Ex_SetCurrentTexturePalette(p,a) (p)->lpVtbl->SetCurrentTexturePalette(p,a) +#define IDirect3DDevice9Ex_GetCurrentTexturePalette(p,a) (p)->lpVtbl->GetCurrentTexturePalette(p,a) +#define IDirect3DDevice9Ex_SetScissorRect(p,a) (p)->lpVtbl->SetScissorRect(p,a) +#define IDirect3DDevice9Ex_GetScissorRect(p,a) (p)->lpVtbl->GetScissorRect(p,a) +#define IDirect3DDevice9Ex_SetSoftwareVertexProcessing(p,a) (p)->lpVtbl->SetSoftwareVertexProcessing(p,a) +#define IDirect3DDevice9Ex_GetSoftwareVertexProcessing(p) (p)->lpVtbl->GetSoftwareVertexProcessing(p) +#define IDirect3DDevice9Ex_SetNPatchMode(p,a) (p)->lpVtbl->SetNPatchMode(p,a) +#define IDirect3DDevice9Ex_GetNPatchMode(p) (p)->lpVtbl->GetNPatchMode(p) +#define IDirect3DDevice9Ex_DrawPrimitive(p,a,b,c) (p)->lpVtbl->DrawPrimitive(p,a,b,c) +#define IDirect3DDevice9Ex_DrawIndexedPrimitive(p,a,b,c,d,e,f) (p)->lpVtbl->DrawIndexedPrimitive(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_DrawPrimitiveUP(p,a,b,c,d) (p)->lpVtbl->DrawPrimitiveUP(p,a,b,c,d) +#define IDirect3DDevice9Ex_DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_ProcessVertices(p,a,b,c,d,e,f) (p)->lpVtbl->ProcessVertices(p,a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateVertexDeclaration(p,a,b) (p)->lpVtbl->CreateVertexDeclaration(p,a,b) +#define IDirect3DDevice9Ex_SetVertexDeclaration(p,a) (p)->lpVtbl->SetVertexDeclaration(p,a) +#define IDirect3DDevice9Ex_GetVertexDeclaration(p,a) (p)->lpVtbl->GetVertexDeclaration(p,a) +#define IDirect3DDevice9Ex_SetFVF(p,a) (p)->lpVtbl->SetFVF(p,a) +#define IDirect3DDevice9Ex_GetFVF(p,a) (p)->lpVtbl->GetFVF(p,a) +#define IDirect3DDevice9Ex_CreateVertexShader(p,a,b) (p)->lpVtbl->CreateVertexShader(p,a,b) +#define IDirect3DDevice9Ex_SetVertexShader(p,a) (p)->lpVtbl->SetVertexShader(p,a) +#define IDirect3DDevice9Ex_GetVertexShader(p,a) (p)->lpVtbl->GetVertexShader(p,a) +#define IDirect3DDevice9Ex_SetVertexShaderConstantF(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantF(p,a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantF(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantF(p,a,b,c) +#define IDirect3DDevice9Ex_SetVertexShaderConstantI(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantI(p,a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantI(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantI(p,a,b,c) +#define IDirect3DDevice9Ex_SetVertexShaderConstantB(p,a,b,c) (p)->lpVtbl->SetVertexShaderConstantB(p,a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantB(p,a,b,c) (p)->lpVtbl->GetVertexShaderConstantB(p,a,b,c) +#define IDirect3DDevice9Ex_SetStreamSource(p,a,b,c,d) (p)->lpVtbl->SetStreamSource(p,a,b,c,d) +#define IDirect3DDevice9Ex_GetStreamSource(p,a,b,c,d) (p)->lpVtbl->GetStreamSource(p,a,b,c,d) +#define IDirect3DDevice9Ex_SetStreamSourceFreq(p,a,b) (p)->lpVtbl->SetStreamSourceFreq(p,a,b) +#define IDirect3DDevice9Ex_GetStreamSourceFreq(p,a,b) (p)->lpVtbl->GetStreamSourceFreq(p,a,b) +#define IDirect3DDevice9Ex_SetIndices(p,a) (p)->lpVtbl->SetIndices(p,a) +#define IDirect3DDevice9Ex_GetIndices(p,a) (p)->lpVtbl->GetIndices(p,a) +#define IDirect3DDevice9Ex_CreatePixelShader(p,a,b) (p)->lpVtbl->CreatePixelShader(p,a,b) +#define IDirect3DDevice9Ex_SetPixelShader(p,a) (p)->lpVtbl->SetPixelShader(p,a) +#define IDirect3DDevice9Ex_GetPixelShader(p,a) (p)->lpVtbl->GetPixelShader(p,a) +#define IDirect3DDevice9Ex_SetPixelShaderConstantF(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantF(p,a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantF(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantF(p,a,b,c) +#define IDirect3DDevice9Ex_SetPixelShaderConstantI(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantI(p,a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantI(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantI(p,a,b,c) +#define IDirect3DDevice9Ex_SetPixelShaderConstantB(p,a,b,c) (p)->lpVtbl->SetPixelShaderConstantB(p,a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantB(p,a,b,c) (p)->lpVtbl->GetPixelShaderConstantB(p,a,b,c) +#define IDirect3DDevice9Ex_DrawRectPatch(p,a,b,c) (p)->lpVtbl->DrawRectPatch(p,a,b,c) +#define IDirect3DDevice9Ex_DrawTriPatch(p,a,b,c) (p)->lpVtbl->DrawTriPatch(p,a,b,c) +#define IDirect3DDevice9Ex_DeletePatch(p,a) (p)->lpVtbl->DeletePatch(p,a) +#define IDirect3DDevice9Ex_CreateQuery(p,a,b) (p)->lpVtbl->CreateQuery(p,a,b) +#define IDirect3DDevice9Ex_SetConvolutionMonoKernel(p,a,b,c,d) (p)->lpVtbl->SetConvolutionMonoKernel(p,a,b,c,d) +#define IDirect3DDevice9Ex_ComposeRects(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->ComposeRects(p,a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_PresentEx(p,a,b,c,d,e) (p)->lpVtbl->PresentEx(p,a,b,c,d,e) +#define IDirect3DDevice9Ex_GetGPUThreadPriority(p,a) (p)->lpVtbl->GetGPUThreadPriority(p,a) +#define IDirect3DDevice9Ex_SetGPUThreadPriority(p,a) (p)->lpVtbl->SetGPUThreadPriority(p,a) +#define IDirect3DDevice9Ex_WaitForVBlank(p,a) (p)->lpVtbl->WaitForVBlank(p,a) +#define IDirect3DDevice9Ex_CheckResourceResidency(p,a,b) (p)->lpVtbl->CheckResourceResidency(p,a,b) +#define IDirect3DDevice9Ex_SetMaximumFrameLatency(p,a) (p)->lpVtbl->SetMaximumFrameLatency(p,a) +#define IDirect3DDevice9Ex_GetMaximumFrameLatency(p,a) (p)->lpVtbl->GetMaximumFrameLatency(p,a) +#define IDirect3DDevice9Ex_CheckDeviceState(p,a) (p)->lpVtbl->CheckDeviceState(p,a) +#define IDirect3DDevice9Ex_CreateRenderTargetEx(p,a,b,c,d,e,f,g,h,i) (p)->lpVtbl->CreateRenderTargetEx(p,a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_CreateOffscreenPlainSurfaceEx(p,a,b,c,d,e,f,g) (p)->lpVtbl->CreateOffscreenPlainSurfaceEx(p,a,b,c,d,e,f,g) +#define IDirect3DDevice9Ex_CreateDepthStencilSurfaceEx(p,a,b,c,d,e,f,g,h,i) (p)->lpVtbl->CreateDepthStencilSurfaceEx(p,a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_ResetEx(p,a,b) (p)->lpVtbl->ResetEx(p,a,b) +#define IDirect3DDevice9Ex_GetDisplayModeEx(p,a,b,c) (p)->lpVtbl->GetDisplayModeEx(p,a,b,c) +#else +#define IDirect3DDevice9Ex_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DDevice9Ex_AddRef(p) (p)->AddRef() +#define IDirect3DDevice9Ex_Release(p) (p)->Release() +#define IDirect3DDevice9Ex_TestCooperativeLevel(p) (p)->TestCooperativeLevel() +#define IDirect3DDevice9Ex_GetAvailableTextureMem(p) (p)->GetAvailableTextureMem() +#define IDirect3DDevice9Ex_EvictManagedResources(p) (p)->EvictManagedResources() +#define IDirect3DDevice9Ex_GetDirect3D(p,a) (p)->GetDirect3D(a) +#define IDirect3DDevice9Ex_GetDeviceCaps(p,a) (p)->GetDeviceCaps(a) +#define IDirect3DDevice9Ex_GetDisplayMode(p,a,b) (p)->GetDisplayMode(a,b) +#define IDirect3DDevice9Ex_GetCreationParameters(p,a) (p)->GetCreationParameters(a) +#define IDirect3DDevice9Ex_SetCursorProperties(p,a,b,c) (p)->SetCursorProperties(a,b,c) +#define IDirect3DDevice9Ex_SetCursorPosition(p,a,b,c) (p)->SetCursorPosition(a,b,c) +#define IDirect3DDevice9Ex_ShowCursor(p,a) (p)->ShowCursor(a) +#define IDirect3DDevice9Ex_CreateAdditionalSwapChain(p,a,b) (p)->CreateAdditionalSwapChain(a,b) +#define IDirect3DDevice9Ex_GetSwapChain(p,a,b) (p)->GetSwapChain(a,b) +#define IDirect3DDevice9Ex_GetNumberOfSwapChains(p) (p)->GetNumberOfSwapChains() +#define IDirect3DDevice9Ex_Reset(p,a) (p)->Reset(a) +#define IDirect3DDevice9Ex_Present(p,a,b,c,d) (p)->Present(a,b,c,d) +#define IDirect3DDevice9Ex_GetBackBuffer(p,a,b,c,d) (p)->GetBackBuffer(a,b,c,d) +#define IDirect3DDevice9Ex_GetRasterStatus(p,a,b) (p)->GetRasterStatus(a,b) +#define IDirect3DDevice9Ex_SetDialogBoxMode(p,a) (p)->SetDialogBoxMode(a) +#define IDirect3DDevice9Ex_SetGammaRamp(p,a,b,c) (p)->SetGammaRamp(a,b,c) +#define IDirect3DDevice9Ex_GetGammaRamp(p,a,b) (p)->GetGammaRamp(a,b) +#define IDirect3DDevice9Ex_CreateTexture(p,a,b,c,d,e,f,g,h) (p)->CreateTexture(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_CreateVolumeTexture(p,a,b,c,d,e,f,g,h,i) (p)->CreateVolumeTexture(a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_CreateCubeTexture(p,a,b,c,d,e,f,g) (p)->CreateCubeTexture(a,b,c,d,e,f,g) +#define IDirect3DDevice9Ex_CreateVertexBuffer(p,a,b,c,d,e,f) (p)->CreateVertexBuffer(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateIndexBuffer(p,a,b,c,d,e,f) (p)->CreateIndexBuffer(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateRenderTarget(p,a,b,c,d,e,f,g,h) (p)->CreateRenderTarget(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_CreateDepthStencilSurface(p,a,b,c,d,e,f,g,h) (p)->CreateDepthStencilSurface(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_UpdateSurface(p,a,b,c,d) (p)->UpdateSurface(a,b,c,d) +#define IDirect3DDevice9Ex_UpdateTexture(p,a,b) (p)->UpdateTexture(a,b) +#define IDirect3DDevice9Ex_GetRenderTargetData(p,a,b) (p)->GetRenderTargetData(a,b) +#define IDirect3DDevice9Ex_GetFrontBufferData(p,a,b) (p)->GetFrontBufferData(a,b) +#define IDirect3DDevice9Ex_StretchRect(p,a,b,c,d,e) (p)->StretchRect(a,b,c,d,e) +#define IDirect3DDevice9Ex_ColorFill(p,a,b,c) (p)->ColorFill(a,b,c) +#define IDirect3DDevice9Ex_CreateOffscreenPlainSurface(p,a,b,c,d,e,f) (p)->CreateOffscreenPlainSurface(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_SetRenderTarget(p,a,b) (p)->SetRenderTarget(a,b) +#define IDirect3DDevice9Ex_GetRenderTarget(p,a,b) (p)->GetRenderTarget(a,b) +#define IDirect3DDevice9Ex_SetDepthStencilSurface(p,a) (p)->SetDepthStencilSurface(a) +#define IDirect3DDevice9Ex_GetDepthStencilSurface(p,a) (p)->GetDepthStencilSurface(a) +#define IDirect3DDevice9Ex_BeginScene(p) (p)->BeginScene() +#define IDirect3DDevice9Ex_EndScene(p) (p)->EndScene() +#define IDirect3DDevice9Ex_Clear(p,a,b,c,d,e,f) (p)->Clear(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_SetTransform(p,a,b) (p)->SetTransform(a,b) +#define IDirect3DDevice9Ex_GetTransform(p,a,b) (p)->GetTransform(a,b) +#define IDirect3DDevice9Ex_MultiplyTransform(p,a,b) (p)->MultiplyTransform(a,b) +#define IDirect3DDevice9Ex_SetViewport(p,a) (p)->SetViewport(a) +#define IDirect3DDevice9Ex_GetViewport(p,a) (p)->GetViewport(a) +#define IDirect3DDevice9Ex_SetMaterial(p,a) (p)->SetMaterial(a) +#define IDirect3DDevice9Ex_GetMaterial(p,a) (p)->GetMaterial(a) +#define IDirect3DDevice9Ex_SetLight(p,a,b) (p)->SetLight(a,b) +#define IDirect3DDevice9Ex_GetLight(p,a,b) (p)->GetLight(a,b) +#define IDirect3DDevice9Ex_LightEnable(p,a,b) (p)->LightEnable(a,b) +#define IDirect3DDevice9Ex_GetLightEnable(p,a,b) (p)->GetLightEnable(a,b) +#define IDirect3DDevice9Ex_SetClipPlane(p,a,b) (p)->SetClipPlane(a,b) +#define IDirect3DDevice9Ex_GetClipPlane(p,a,b) (p)->GetClipPlane(a,b) +#define IDirect3DDevice9Ex_SetRenderState(p,a,b) (p)->SetRenderState(a,b) +#define IDirect3DDevice9Ex_GetRenderState(p,a,b) (p)->GetRenderState(a,b) +#define IDirect3DDevice9Ex_CreateStateBlock(p,a,b) (p)->CreateStateBlock(a,b) +#define IDirect3DDevice9Ex_BeginStateBlock(p) (p)->BeginStateBlock() +#define IDirect3DDevice9Ex_EndStateBlock(p,a) (p)->EndStateBlock(a) +#define IDirect3DDevice9Ex_SetClipStatus(p,a) (p)->SetClipStatus(a) +#define IDirect3DDevice9Ex_GetClipStatus(p,a) (p)->GetClipStatus(a) +#define IDirect3DDevice9Ex_GetTexture(p,a,b) (p)->GetTexture(a,b) +#define IDirect3DDevice9Ex_SetTexture(p,a,b) (p)->SetTexture(a,b) +#define IDirect3DDevice9Ex_GetTextureStageState(p,a,b,c) (p)->GetTextureStageState(a,b,c) +#define IDirect3DDevice9Ex_SetTextureStageState(p,a,b,c) (p)->SetTextureStageState(a,b,c) +#define IDirect3DDevice9Ex_GetSamplerState(p,a,b,c) (p)->GetSamplerState(a,b,c) +#define IDirect3DDevice9Ex_SetSamplerState(p,a,b,c) (p)->SetSamplerState(a,b,c) +#define IDirect3DDevice9Ex_ValidateDevice(p,a) (p)->ValidateDevice(a) +#define IDirect3DDevice9Ex_SetPaletteEntries(p,a,b) (p)->SetPaletteEntries(a,b) +#define IDirect3DDevice9Ex_GetPaletteEntries(p,a,b) (p)->GetPaletteEntries(a,b) +#define IDirect3DDevice9Ex_SetCurrentTexturePalette(p,a) (p)->SetCurrentTexturePalette(a) +#define IDirect3DDevice9Ex_GetCurrentTexturePalette(p,a) (p)->GetCurrentTexturePalette(a) +#define IDirect3DDevice9Ex_SetScissorRect(p,a) (p)->SetScissorRect(a) +#define IDirect3DDevice9Ex_GetScissorRect(p,a) (p)->GetScissorRect(a) +#define IDirect3DDevice9Ex_SetSoftwareVertexProcessing(p,a) (p)->SetSoftwareVertexProcessing(a) +#define IDirect3DDevice9Ex_GetSoftwareVertexProcessing(p) (p)->GetSoftwareVertexProcessing() +#define IDirect3DDevice9Ex_SetNPatchMode(p,a) (p)->SetNPatchMode(a) +#define IDirect3DDevice9Ex_GetNPatchMode(p) (p)->GetNPatchMode() +#define IDirect3DDevice9Ex_DrawPrimitive(p,a,b,c) (p)->DrawPrimitive(a,b,c) +#define IDirect3DDevice9Ex_DrawIndexedPrimitive(p,a,b,c,d,e,f) (p)->DrawIndexedPrimitive(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_DrawPrimitiveUP(p,a,b,c,d) (p)->DrawPrimitiveUP(a,b,c,d) +#define IDirect3DDevice9Ex_DrawIndexedPrimitiveUP(p,a,b,c,d,e,f,g,h) (p)->DrawIndexedPrimitiveUP(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_ProcessVertices(p,a,b,c,d,e,f) (p)->ProcessVertices(a,b,c,d,e,f) +#define IDirect3DDevice9Ex_CreateVertexDeclaration(p,a,b) (p)->CreateVertexDeclaration(a,b) +#define IDirect3DDevice9Ex_SetVertexDeclaration(p,a) (p)->SetVertexDeclaration(a) +#define IDirect3DDevice9Ex_GetVertexDeclaration(p,a) (p)->GetVertexDeclaration(a) +#define IDirect3DDevice9Ex_SetFVF(p,a) (p)->SetFVF(a) +#define IDirect3DDevice9Ex_GetFVF(p,a) (p)->GetFVF(a) +#define IDirect3DDevice9Ex_CreateVertexShader(p,a,b) (p)->CreateVertexShader(a,b) +#define IDirect3DDevice9Ex_SetVertexShader(p,a) (p)->SetVertexShader(a) +#define IDirect3DDevice9Ex_GetVertexShader(p,a) (p)->GetVertexShader(a) +#define IDirect3DDevice9Ex_SetVertexShaderConstantF(p,a,b,c) (p)->SetVertexShaderConstantF(a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantF(p,a,b,c) (p)->GetVertexShaderConstantF(a,b,c) +#define IDirect3DDevice9Ex_SetVertexShaderConstantI(p,a,b,c) (p)->SetVertexShaderConstantI(a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantI(p,a,b,c) (p)->GetVertexShaderConstantI(a,b,c) +#define IDirect3DDevice9Ex_SetVertexShaderConstantB(p,a,b,c) (p)->SetVertexShaderConstantB(a,b,c) +#define IDirect3DDevice9Ex_GetVertexShaderConstantB(p,a,b,c) (p)->GetVertexShaderConstantB(a,b,c) +#define IDirect3DDevice9Ex_SetStreamSource(p,a,b,c,d) (p)->SetStreamSource(a,b,c,d) +#define IDirect3DDevice9Ex_GetStreamSource(p,a,b,c,d) (p)->GetStreamSource(a,b,c,d) +#define IDirect3DDevice9Ex_SetStreamSourceFreq(p,a,b) (p)->SetStreamSourceFreq(a,b) +#define IDirect3DDevice9Ex_GetStreamSourceFreq(p,a,b) (p)->GetStreamSourceFreq(a,b) +#define IDirect3DDevice9Ex_SetIndices(p,a) (p)->SetIndices(a) +#define IDirect3DDevice9Ex_GetIndices(p,a) (p)->GetIndices(a) +#define IDirect3DDevice9Ex_CreatePixelShader(p,a,b) (p)->CreatePixelShader(a,b) +#define IDirect3DDevice9Ex_SetPixelShader(p,a) (p)->SetPixelShader(a) +#define IDirect3DDevice9Ex_GetPixelShader(p,a) (p)->GetPixelShader(a) +#define IDirect3DDevice9Ex_SetPixelShaderConstantF(p,a,b,c) (p)->SetPixelShaderConstantF(a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantF(p,a,b,c) (p)->GetPixelShaderConstantF(a,b,c) +#define IDirect3DDevice9Ex_SetPixelShaderConstantI(p,a,b,c) (p)->SetPixelShaderConstantI(a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantI(p,a,b,c) (p)->GetPixelShaderConstantI(a,b,c) +#define IDirect3DDevice9Ex_SetPixelShaderConstantB(p,a,b,c) (p)->SetPixelShaderConstantB(a,b,c) +#define IDirect3DDevice9Ex_GetPixelShaderConstantB(p,a,b,c) (p)->GetPixelShaderConstantB(a,b,c) +#define IDirect3DDevice9Ex_DrawRectPatch(p,a,b,c) (p)->DrawRectPatch(a,b,c) +#define IDirect3DDevice9Ex_DrawTriPatch(p,a,b,c) (p)->DrawTriPatch(a,b,c) +#define IDirect3DDevice9Ex_DeletePatch(p,a) (p)->DeletePatch(a) +#define IDirect3DDevice9Ex_CreateQuery(p,a,b) (p)->CreateQuery(a,b) +#define IDirect3DDevice9Ex_SetConvolutionMonoKernel(p,a,b,c,d) (p)->SetConvolutionMonoKernel(a,b,c,d) +#define IDirect3DDevice9Ex_ComposeRects(p,a,b,c,d,e,f,g,h) (p)->ComposeRects(a,b,c,d,e,f,g,h) +#define IDirect3DDevice9Ex_PresentEx(p,a,b,c,d,e) (p)->PresentEx(a,b,c,d,e) +#define IDirect3DDevice9Ex_GetGPUThreadPriority(p,a) (p)->GetGPUThreadPriority(a) +#define IDirect3DDevice9Ex_SetGPUThreadPriority(p,a) (p)->SetGPUThreadPriority(a) +#define IDirect3DDevice9Ex_WaitForVBlank(p,a) (p)->WaitForVBlank(a) +#define IDirect3DDevice9Ex_CheckResourceResidency(p,a,b) (p)->CheckResourceResidency(a,b) +#define IDirect3DDevice9Ex_SetMaximumFrameLatency(p,a) (p)->SetMaximumFrameLatency(a) +#define IDirect3DDevice9Ex_GetMaximumFrameLatency(p,a) (p)->GetMaximumFrameLatency(a) +#define IDirect3DDevice9Ex_CheckDeviceState(p,a) (p)->CheckDeviceState(a) +#define IDirect3DDevice9Ex_CreateRenderTargetEx(p,a,b,c,d,e,f,g,h,i) (p)->CreateRenderTargetEx(a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_CreateOffscreenPlainSurfaceEx(p,a,b,c,d,e,f,g) (p)->CreateOffscreenPlainSurfaceEx(a,b,c,d,e,f,g) +#define IDirect3DDevice9Ex_CreateDepthStencilSurfaceEx(p,a,b,c,d,e,f,g,h,i) (p)->CreateDepthStencilSurfaceEx(a,b,c,d,e,f,g,h,i) +#define IDirect3DDevice9Ex_ResetEx(p,a,b) (p)->ResetEx(a,b) +#define IDirect3DDevice9Ex_GetDisplayModeEx(p,a,b,c) (p)->GetDisplayModeEx(a,b,c) +#endif + + + +#undef INTERFACE +#define INTERFACE IDirect3DSwapChain9Ex + +DECLARE_INTERFACE_(IDirect3DSwapChain9Ex, IDirect3DSwapChain9) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DSwapChain9 methods ***/ + STDMETHOD(Present)(THIS_ CONST RECT* pSourceRect,CONST RECT* pDestRect,HWND hDestWindowOverride,CONST RGNDATA* pDirtyRegion,DWORD dwFlags) PURE; + STDMETHOD(GetFrontBufferData)(THIS_ IDirect3DSurface9* pDestSurface) PURE; + STDMETHOD(GetBackBuffer)(THIS_ UINT iBackBuffer,D3DBACKBUFFER_TYPE Type,IDirect3DSurface9** ppBackBuffer) PURE; + STDMETHOD(GetRasterStatus)(THIS_ D3DRASTER_STATUS* pRasterStatus) PURE; + STDMETHOD(GetDisplayMode)(THIS_ D3DDISPLAYMODE* pMode) PURE; + STDMETHOD(GetDevice)(THIS_ IDirect3DDevice9** ppDevice) PURE; + STDMETHOD(GetPresentParameters)(THIS_ D3DPRESENT_PARAMETERS* pPresentationParameters) PURE; + STDMETHOD(GetLastPresentCount)(THIS_ UINT* pLastPresentCount) PURE; + STDMETHOD(GetPresentStats)(THIS_ D3DPRESENTSTATS* pPresentationStatistics) PURE; + STDMETHOD(GetDisplayModeEx)(THIS_ D3DDISPLAYMODEEX* pMode,D3DDISPLAYROTATION* pRotation) PURE; +}; + +typedef struct IDirect3DSwapChain9Ex *LPDIRECT3DSWAPCHAIN9EX, *PDIRECT3DSWAPCHAIN9EX; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DSwapChain9Ex_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DSwapChain9Ex_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DSwapChain9Ex_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DSwapChain9Ex_Present(p,a,b,c,d,e) (p)->lpVtbl->Present(p,a,b,c,d,e) +#define IDirect3DSwapChain9Ex_GetFrontBufferData(p,a) (p)->lpVtbl->GetFrontBufferData(p,a) +#define IDirect3DSwapChain9Ex_GetBackBuffer(p,a,b,c) (p)->lpVtbl->GetBackBuffer(p,a,b,c) +#define IDirect3DSwapChain9Ex_GetRasterStatus(p,a) (p)->lpVtbl->GetRasterStatus(p,a) +#define IDirect3DSwapChain9Ex_GetDisplayMode(p,a) (p)->lpVtbl->GetDisplayMode(p,a) +#define IDirect3DSwapChain9Ex_GetDevice(p,a) (p)->lpVtbl->GetDevice(p,a) +#define IDirect3DSwapChain9Ex_GetPresentParameters(p,a) (p)->lpVtbl->GetPresentParameters(p,a) +#define IDirect3DSwapChain9Ex_GetLastPresentCount(p,a) (p)->lpVtbl->GetLastPresentCount(p,a) +#define IDirect3DSwapChain9Ex_GetPresentStats(p,a) (p)->lpVtbl->GetPresentStats(p,a) +#define IDirect3DSwapChain9Ex_GetDisplayModeEx(p,a,b) (p)->lpVtbl->GetDisplayModeEx(p,a,b) +#else +#define IDirect3DSwapChain9Ex_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DSwapChain9Ex_AddRef(p) (p)->AddRef() +#define IDirect3DSwapChain9Ex_Release(p) (p)->Release() +#define IDirect3DSwapChain9Ex_Present(p,a,b,c,d,e) (p)->Present(a,b,c,d,e) +#define IDirect3DSwapChain9Ex_GetFrontBufferData(p,a) (p)->GetFrontBufferData(a) +#define IDirect3DSwapChain9Ex_GetBackBuffer(p,a,b,c) (p)->GetBackBuffer(a,b,c) +#define IDirect3DSwapChain9Ex_GetRasterStatus(p,a) (p)->GetRasterStatus(a) +#define IDirect3DSwapChain9Ex_GetDisplayMode(p,a) (p)->GetDisplayMode(a) +#define IDirect3DSwapChain9Ex_GetDevice(p,a) (p)->GetDevice(a) +#define IDirect3DSwapChain9Ex_GetPresentParameters(p,a) (p)->GetPresentParameters(a) +#define IDirect3DSwapChain9Ex_GetLastPresentCount(p,a) (p)->GetLastPresentCount(a) +#define IDirect3DSwapChain9Ex_GetPresentStats(p,a) (p)->GetPresentStats(a) +#define IDirect3DSwapChain9Ex_GetDisplayModeEx(p,a,b) (p)->GetDisplayModeEx(a,b) +#endif + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + + + +#undef INTERFACE +#define INTERFACE IDirect3D9ExOverlayExtension + +DECLARE_INTERFACE_(IDirect3D9ExOverlayExtension, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3D9ExOverlayExtension methods ***/ + STDMETHOD(CheckDeviceOverlayType)(THIS_ UINT Adapter,D3DDEVTYPE DevType,UINT OverlayWidth,UINT OverlayHeight,D3DFORMAT OverlayFormat,D3DDISPLAYMODEEX* pDisplayMode,D3DDISPLAYROTATION DisplayRotation,D3DOVERLAYCAPS* pOverlayCaps) PURE; +}; + +typedef struct IDirect3D9ExOverlayExtension *LPDIRECT3D9EXOVERLAYEXTENSION, *PDIRECT3D9EXOVERLAYEXTENSION; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3D9ExOverlayExtension_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3D9ExOverlayExtension_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3D9ExOverlayExtension_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3D9ExOverlayExtension_CheckDeviceOverlayType(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->CheckDeviceOverlayType(p,a,b,c,d,e,f,g,h) +#else +#define IDirect3D9ExOverlayExtension_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3D9ExOverlayExtension_AddRef(p) (p)->AddRef() +#define IDirect3D9ExOverlayExtension_Release(p) (p)->Release() +#define IDirect3D9ExOverlayExtension_CheckDeviceOverlayType(p,a,b,c,d,e,f,g,h) (p)->CheckDeviceOverlayType(a,b,c,d,e,f,g,h) +#endif + + + +#undef INTERFACE +#define INTERFACE IDirect3DDevice9Video + +DECLARE_INTERFACE_(IDirect3DDevice9Video, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DDevice9Video methods ***/ + STDMETHOD(GetContentProtectionCaps)(THIS_ CONST GUID* pCryptoType,CONST GUID* pDecodeProfile,D3DCONTENTPROTECTIONCAPS* pCaps) PURE; + STDMETHOD(CreateAuthenticatedChannel)(THIS_ D3DAUTHENTICATEDCHANNELTYPE ChannelType,IDirect3DAuthenticatedChannel9** ppAuthenticatedChannel,HANDLE* pChannelHandle) PURE; + STDMETHOD(CreateCryptoSession)(THIS_ CONST GUID* pCryptoType,CONST GUID* pDecodeProfile,IDirect3DCryptoSession9** ppCryptoSession,HANDLE* pCryptoHandle) PURE; +}; + +typedef struct IDirect3DDevice9Video *LPDIRECT3DDEVICE9VIDEO, *PDIRECT3DDEVICE9VIDEO; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DDevice9Video_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DDevice9Video_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DDevice9Video_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DDevice9Video_GetContentProtectionCaps(p,a,b,c) (p)->lpVtbl->GetContentProtectionCaps(p,a,b,c) +#define IDirect3DDevice9Video_CreateAuthenticatedChannel(p,a,b,c) (p)->lpVtbl->CreateAuthenticatedChannel(p,a,b,c) +#define IDirect3DDevice9Video_CreateCryptoSession(p,a,b,c,d) (p)->lpVtbl->CreateCryptoSession(p,a,b,c,d) +#else +#define IDirect3DDevice9Video_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DDevice9Video_AddRef(p) (p)->AddRef() +#define IDirect3DDevice9Video_Release(p) (p)->Release() +#define IDirect3DDevice9Video_GetContentProtectionCaps(p,a,b,c) (p)->GetContentProtectionCaps(a,b,c) +#define IDirect3DDevice9Video_CreateAuthenticatedChannel(p,a,b,c) (p)->CreateAuthenticatedChannel(a,b,c) +#define IDirect3DDevice9Video_CreateCryptoSession(p,a,b,c,d) (p)->CreateCryptoSession(a,b,c,d) +#endif + + + + +#undef INTERFACE +#define INTERFACE IDirect3DAuthenticatedChannel9 + +DECLARE_INTERFACE_(IDirect3DAuthenticatedChannel9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DAuthenticatedChannel9 methods ***/ + STDMETHOD(GetCertificateSize)(THIS_ UINT* pCertificateSize) PURE; + STDMETHOD(GetCertificate)(THIS_ UINT CertifacteSize,BYTE* ppCertificate) PURE; + STDMETHOD(NegotiateKeyExchange)(THIS_ UINT DataSize,VOID* pData) PURE; + STDMETHOD(Query)(THIS_ UINT InputSize,CONST VOID* pInput,UINT OutputSize,VOID* pOutput) PURE; + STDMETHOD(Configure)(THIS_ UINT InputSize,CONST VOID* pInput,D3DAUTHENTICATEDCHANNEL_CONFIGURE_OUTPUT* pOutput) PURE; +}; + +typedef struct IDirect3DAuthenticatedChannel9 *LPDIRECT3DAUTHENTICATEDCHANNEL9, *PDIRECT3DAUTHENTICATEDCHANNEL9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DAuthenticatedChannel9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DAuthenticatedChannel9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DAuthenticatedChannel9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DAuthenticatedChannel9_GetCertificateSize(p,a) (p)->lpVtbl->GetCertificateSize(p,a) +#define IDirect3DAuthenticatedChannel9_GetCertificate(p,a,b) (p)->lpVtbl->GetCertificate(p,a,b) +#define IDirect3DAuthenticatedChannel9_NegotiateKeyExchange(p,a,b) (p)->lpVtbl->NegotiateKeyExchange(p,a,b) +#define IDirect3DAuthenticatedChannel9_Query(p,a,b,c,d) (p)->lpVtbl->Query(p,a,b,c,d) +#define IDirect3DAuthenticatedChannel9_Configure(p,a,b,c) (p)->lpVtbl->Configure(p,a,b,c) +#else +#define IDirect3DAuthenticatedChannel9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DAuthenticatedChannel9_AddRef(p) (p)->AddRef() +#define IDirect3DAuthenticatedChannel9_Release(p) (p)->Release() +#define IDirect3DAuthenticatedChannel9_GetCertificateSize(p,a) (p)->GetCertificateSize(a) +#define IDirect3DAuthenticatedChannel9_GetCertificate(p,a,b) (p)->GetCertificate(a,b) +#define IDirect3DAuthenticatedChannel9_NegotiateKeyExchange(p,a,b) (p)->NegotiateKeyExchange(a,b) +#define IDirect3DAuthenticatedChannel9_Query(p,a,b,c,d) (p)->Query(a,b,c,d) +#define IDirect3DAuthenticatedChannel9_Configure(p,a,b,c) (p)->Configure(a,b,c) +#endif + + + +#undef INTERFACE +#define INTERFACE IDirect3DCryptoSession9 + +DECLARE_INTERFACE_(IDirect3DCryptoSession9, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, void** ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirect3DCryptoSession9 methods ***/ + STDMETHOD(GetCertificateSize)(THIS_ UINT* pCertificateSize) PURE; + STDMETHOD(GetCertificate)(THIS_ UINT CertifacteSize,BYTE* ppCertificate) PURE; + STDMETHOD(NegotiateKeyExchange)(THIS_ UINT DataSize,VOID* pData) PURE; + STDMETHOD(EncryptionBlt)(THIS_ IDirect3DSurface9* pSrcSurface,IDirect3DSurface9* pDstSurface,UINT DstSurfaceSize,VOID* pIV) PURE; + STDMETHOD(DecryptionBlt)(THIS_ IDirect3DSurface9* pSrcSurface,IDirect3DSurface9* pDstSurface,UINT SrcSurfaceSize,D3DENCRYPTED_BLOCK_INFO* pEncryptedBlockInfo,VOID* pContentKey,VOID* pIV) PURE; + STDMETHOD(GetSurfacePitch)(THIS_ IDirect3DSurface9* pSrcSurface,UINT* pSurfacePitch) PURE; + STDMETHOD(StartSessionKeyRefresh)(THIS_ VOID* pRandomNumber,UINT RandomNumberSize) PURE; + STDMETHOD(FinishSessionKeyRefresh)(THIS) PURE; + STDMETHOD(GetEncryptionBltKey)(THIS_ VOID* pReadbackKey,UINT KeySize) PURE; +}; + +typedef struct IDirect3DCryptoSession9 *LPDIRECT3DCRYPTOSESSION9, *PDIRECT3DCRYPTOSESSION9; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirect3DCryptoSession9_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirect3DCryptoSession9_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirect3DCryptoSession9_Release(p) (p)->lpVtbl->Release(p) +#define IDirect3DCryptoSession9_GetCertificateSize(p,a) (p)->lpVtbl->GetCertificateSize(p,a) +#define IDirect3DCryptoSession9_GetCertificate(p,a,b) (p)->lpVtbl->GetCertificate(p,a,b) +#define IDirect3DCryptoSession9_NegotiateKeyExchange(p,a,b) (p)->lpVtbl->NegotiateKeyExchange(p,a,b) +#define IDirect3DCryptoSession9_EncryptionBlt(p,a,b,c,d) (p)->lpVtbl->EncryptionBlt(p,a,b,c,d) +#define IDirect3DCryptoSession9_DecryptionBlt(p,a,b,c,d,e,f) (p)->lpVtbl->DecryptionBlt(p,a,b,c,d,e,f) +#define IDirect3DCryptoSession9_GetSurfacePitch(p,a,b) (p)->lpVtbl->GetSurfacePitch(p,a,b) +#define IDirect3DCryptoSession9_StartSessionKeyRefresh(p,a,b) (p)->lpVtbl->StartSessionKeyRefresh(p,a,b) +#define IDirect3DCryptoSession9_FinishSessionKeyRefresh(p) (p)->lpVtbl->FinishSessionKeyRefresh(p) +#define IDirect3DCryptoSession9_GetEncryptionBltKey(p,a,b) (p)->lpVtbl->GetEncryptionBltKey(p,a,b) +#else +#define IDirect3DCryptoSession9_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirect3DCryptoSession9_AddRef(p) (p)->AddRef() +#define IDirect3DCryptoSession9_Release(p) (p)->Release() +#define IDirect3DCryptoSession9_GetCertificateSize(p,a) (p)->GetCertificateSize(a) +#define IDirect3DCryptoSession9_GetCertificate(p,a,b) (p)->GetCertificate(a,b) +#define IDirect3DCryptoSession9_NegotiateKeyExchange(p,a,b) (p)->NegotiateKeyExchange(a,b) +#define IDirect3DCryptoSession9_EncryptionBlt(p,a,b,c,d) (p)->EncryptionBlt(a,b,c,d) +#define IDirect3DCryptoSession9_DecryptionBlt(p,a,b,c,d,e,f) (p)->DecryptionBlt(a,b,c,d,e,f) +#define IDirect3DCryptoSession9_GetSurfacePitch(p,a,b) (p)->GetSurfacePitch(a,b) +#define IDirect3DCryptoSession9_StartSessionKeyRefresh(p,a,b) (p)->StartSessionKeyRefresh(a,b) +#define IDirect3DCryptoSession9_FinishSessionKeyRefresh(p) (p)->FinishSessionKeyRefresh() +#define IDirect3DCryptoSession9_GetEncryptionBltKey(p,a,b) (p)->GetEncryptionBltKey(a,b) +#endif + +/* -- D3D9Ex only */ +#endif // !D3D_DISABLE_9EX + + +#ifdef __cplusplus +}; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* (DIRECT3D_VERSION >= 0x0900) */ +#endif /* _D3D_H_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9caps.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9caps.h new file mode 100644 index 0000000000000000000000000000000000000000..05ce2cca02e100aafde52863d17f40cc22f225f5 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9caps.h @@ -0,0 +1,576 @@ +/*==========================================================================; + * + * Copyright (C) Microsoft Corporation. All Rights Reserved. + * + * File: d3d9caps.h + * Content: Direct3D capabilities include file + * + ***************************************************************************/ + +#ifndef _d3d9CAPS_H +#define _d3d9CAPS_H + +#ifndef DIRECT3D_VERSION +#define DIRECT3D_VERSION 0x0900 +#endif //DIRECT3D_VERSION + +// include this file content only if compiling for DX9 interfaces +#if(DIRECT3D_VERSION >= 0x0900) + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if defined(_X86_) || defined(_IA64_) +#pragma pack(4) +#endif + +typedef struct _D3DVSHADERCAPS2_0 +{ + DWORD Caps; + INT DynamicFlowControlDepth; + INT NumTemps; + INT StaticFlowControlDepth; +} D3DVSHADERCAPS2_0; + +#define D3DVS20CAPS_PREDICATION (1<<0) + +#define D3DVS20_MAX_DYNAMICFLOWCONTROLDEPTH 24 +#define D3DVS20_MIN_DYNAMICFLOWCONTROLDEPTH 0 +#define D3DVS20_MAX_NUMTEMPS 32 +#define D3DVS20_MIN_NUMTEMPS 12 +#define D3DVS20_MAX_STATICFLOWCONTROLDEPTH 4 +#define D3DVS20_MIN_STATICFLOWCONTROLDEPTH 1 + +typedef struct _D3DPSHADERCAPS2_0 +{ + DWORD Caps; + INT DynamicFlowControlDepth; + INT NumTemps; + INT StaticFlowControlDepth; + INT NumInstructionSlots; +} D3DPSHADERCAPS2_0; + +#define D3DPS20CAPS_ARBITRARYSWIZZLE (1<<0) +#define D3DPS20CAPS_GRADIENTINSTRUCTIONS (1<<1) +#define D3DPS20CAPS_PREDICATION (1<<2) +#define D3DPS20CAPS_NODEPENDENTREADLIMIT (1<<3) +#define D3DPS20CAPS_NOTEXINSTRUCTIONLIMIT (1<<4) + +#define D3DPS20_MAX_DYNAMICFLOWCONTROLDEPTH 24 +#define D3DPS20_MIN_DYNAMICFLOWCONTROLDEPTH 0 +#define D3DPS20_MAX_NUMTEMPS 32 +#define D3DPS20_MIN_NUMTEMPS 12 +#define D3DPS20_MAX_STATICFLOWCONTROLDEPTH 4 +#define D3DPS20_MIN_STATICFLOWCONTROLDEPTH 0 +#define D3DPS20_MAX_NUMINSTRUCTIONSLOTS 512 +#define D3DPS20_MIN_NUMINSTRUCTIONSLOTS 96 + +#define D3DMIN30SHADERINSTRUCTIONS 512 +#define D3DMAX30SHADERINSTRUCTIONS 32768 + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +typedef struct _D3DOVERLAYCAPS +{ + UINT Caps; + UINT MaxOverlayDisplayWidth; + UINT MaxOverlayDisplayHeight; +} D3DOVERLAYCAPS; + +#define D3DOVERLAYCAPS_FULLRANGERGB 0x00000001 +#define D3DOVERLAYCAPS_LIMITEDRANGERGB 0x00000002 +#define D3DOVERLAYCAPS_YCbCr_BT601 0x00000004 +#define D3DOVERLAYCAPS_YCbCr_BT709 0x00000008 +#define D3DOVERLAYCAPS_YCbCr_BT601_xvYCC 0x00000010 +#define D3DOVERLAYCAPS_YCbCr_BT709_xvYCC 0x00000020 +#define D3DOVERLAYCAPS_STRETCHX 0x00000040 +#define D3DOVERLAYCAPS_STRETCHY 0x00000080 + + +typedef struct _D3DCONTENTPROTECTIONCAPS +{ + DWORD Caps; + GUID KeyExchangeType; + UINT BufferAlignmentStart; + UINT BlockAlignmentSize; + ULONGLONG ProtectedMemorySize; +} D3DCONTENTPROTECTIONCAPS; + +#define D3DCPCAPS_SOFTWARE 0x00000001 +#define D3DCPCAPS_HARDWARE 0x00000002 +#define D3DCPCAPS_PROTECTIONALWAYSON 0x00000004 +#define D3DCPCAPS_PARTIALDECRYPTION 0x00000008 +#define D3DCPCAPS_CONTENTKEY 0x00000010 +#define D3DCPCAPS_FRESHENSESSIONKEY 0x00000020 +#define D3DCPCAPS_ENCRYPTEDREADBACK 0x00000040 +#define D3DCPCAPS_ENCRYPTEDREADBACKKEY 0x00000080 +#define D3DCPCAPS_SEQUENTIAL_CTR_IV 0x00000100 +#define D3DCPCAPS_ENCRYPTSLICEDATAONLY 0x00000200 + +DEFINE_GUID(D3DCRYPTOTYPE_AES128_CTR, +0x9b6bd711, 0x4f74, 0x41c9, 0x9e, 0x7b, 0xb, 0xe2, 0xd7, 0xd9, 0x3b, 0x4f); +DEFINE_GUID(D3DCRYPTOTYPE_PROPRIETARY, +0xab4e9afd, 0x1d1c, 0x46e6, 0xa7, 0x2f, 0x8, 0x69, 0x91, 0x7b, 0xd, 0xe8); + +DEFINE_GUID(D3DKEYEXCHANGE_RSAES_OAEP, +0xc1949895, 0xd72a, 0x4a1d, 0x8e, 0x5d, 0xed, 0x85, 0x7d, 0x17, 0x15, 0x20); +DEFINE_GUID(D3DKEYEXCHANGE_DXVA, +0x43d3775c, 0x38e5, 0x4924, 0x8d, 0x86, 0xd3, 0xfc, 0xcf, 0x15, 0x3e, 0x9b); + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +typedef struct _D3DCAPS9 +{ + /* Device Info */ + D3DDEVTYPE DeviceType; + UINT AdapterOrdinal; + + /* Caps from DX7 Draw */ + DWORD Caps; + DWORD Caps2; + DWORD Caps3; + DWORD PresentationIntervals; + + /* Cursor Caps */ + DWORD CursorCaps; + + /* 3D Device Caps */ + DWORD DevCaps; + + DWORD PrimitiveMiscCaps; + DWORD RasterCaps; + DWORD ZCmpCaps; + DWORD SrcBlendCaps; + DWORD DestBlendCaps; + DWORD AlphaCmpCaps; + DWORD ShadeCaps; + DWORD TextureCaps; + DWORD TextureFilterCaps; // D3DPTFILTERCAPS for IDirect3DTexture9's + DWORD CubeTextureFilterCaps; // D3DPTFILTERCAPS for IDirect3DCubeTexture9's + DWORD VolumeTextureFilterCaps; // D3DPTFILTERCAPS for IDirect3DVolumeTexture9's + DWORD TextureAddressCaps; // D3DPTADDRESSCAPS for IDirect3DTexture9's + DWORD VolumeTextureAddressCaps; // D3DPTADDRESSCAPS for IDirect3DVolumeTexture9's + + DWORD LineCaps; // D3DLINECAPS + + DWORD MaxTextureWidth, MaxTextureHeight; + DWORD MaxVolumeExtent; + + DWORD MaxTextureRepeat; + DWORD MaxTextureAspectRatio; + DWORD MaxAnisotropy; + float MaxVertexW; + + float GuardBandLeft; + float GuardBandTop; + float GuardBandRight; + float GuardBandBottom; + + float ExtentsAdjust; + DWORD StencilCaps; + + DWORD FVFCaps; + DWORD TextureOpCaps; + DWORD MaxTextureBlendStages; + DWORD MaxSimultaneousTextures; + + DWORD VertexProcessingCaps; + DWORD MaxActiveLights; + DWORD MaxUserClipPlanes; + DWORD MaxVertexBlendMatrices; + DWORD MaxVertexBlendMatrixIndex; + + float MaxPointSize; + + DWORD MaxPrimitiveCount; // max number of primitives per DrawPrimitive call + DWORD MaxVertexIndex; + DWORD MaxStreams; + DWORD MaxStreamStride; // max stride for SetStreamSource + + DWORD VertexShaderVersion; + DWORD MaxVertexShaderConst; // number of vertex shader constant registers + + DWORD PixelShaderVersion; + float PixelShader1xMaxValue; // max value storable in registers of ps.1.x shaders + + // Here are the DX9 specific ones + DWORD DevCaps2; + + float MaxNpatchTessellationLevel; + DWORD Reserved5; + + UINT MasterAdapterOrdinal; // ordinal of master adaptor for adapter group + UINT AdapterOrdinalInGroup; // ordinal inside the adapter group + UINT NumberOfAdaptersInGroup; // number of adapters in this adapter group (only if master) + DWORD DeclTypes; // Data types, supported in vertex declarations + DWORD NumSimultaneousRTs; // Will be at least 1 + DWORD StretchRectFilterCaps; // Filter caps supported by StretchRect + D3DVSHADERCAPS2_0 VS20Caps; + D3DPSHADERCAPS2_0 PS20Caps; + DWORD VertexTextureFilterCaps; // D3DPTFILTERCAPS for IDirect3DTexture9's for texture, used in vertex shaders + DWORD MaxVShaderInstructionsExecuted; // maximum number of vertex shader instructions that can be executed + DWORD MaxPShaderInstructionsExecuted; // maximum number of pixel shader instructions that can be executed + DWORD MaxVertexShader30InstructionSlots; + DWORD MaxPixelShader30InstructionSlots; +} D3DCAPS9; + +// +// BIT DEFINES FOR D3DCAPS9 DWORD MEMBERS +// + +// +// Caps +// +#define D3DCAPS_OVERLAY 0x00000800L +#define D3DCAPS_READ_SCANLINE 0x00020000L + +// +// Caps2 +// +#define D3DCAPS2_FULLSCREENGAMMA 0x00020000L +#define D3DCAPS2_CANCALIBRATEGAMMA 0x00100000L +#define D3DCAPS2_RESERVED 0x02000000L +#define D3DCAPS2_CANMANAGERESOURCE 0x10000000L +#define D3DCAPS2_DYNAMICTEXTURES 0x20000000L +#define D3DCAPS2_CANAUTOGENMIPMAP 0x40000000L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +#define D3DCAPS2_CANSHARERESOURCE 0x80000000L + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +// +// Caps3 +// +#define D3DCAPS3_RESERVED 0x8000001fL + +// Indicates that the device can respect the ALPHABLENDENABLE render state +// when fullscreen while using the FLIP or DISCARD swap effect. +// COPY and COPYVSYNC swap effects work whether or not this flag is set. +#define D3DCAPS3_ALPHA_FULLSCREEN_FLIP_OR_DISCARD 0x00000020L + +// Indicates that the device can perform a gamma correction from +// a windowed back buffer containing linear content to the sRGB desktop. +#define D3DCAPS3_LINEAR_TO_SRGB_PRESENTATION 0x00000080L + +#define D3DCAPS3_COPY_TO_VIDMEM 0x00000100L /* Device can acclerate copies from sysmem to local vidmem */ +#define D3DCAPS3_COPY_TO_SYSTEMMEM 0x00000200L /* Device can acclerate copies from local vidmem to sysmem */ +#define D3DCAPS3_DXVAHD 0x00000400L +#define D3DCAPS3_DXVAHD_LIMITED 0x00000800L + + +// +// PresentationIntervals +// +#define D3DPRESENT_INTERVAL_DEFAULT 0x00000000L +#define D3DPRESENT_INTERVAL_ONE 0x00000001L +#define D3DPRESENT_INTERVAL_TWO 0x00000002L +#define D3DPRESENT_INTERVAL_THREE 0x00000004L +#define D3DPRESENT_INTERVAL_FOUR 0x00000008L +#define D3DPRESENT_INTERVAL_IMMEDIATE 0x80000000L + +// +// CursorCaps +// +// Driver supports HW color cursor in at least hi-res modes(height >=400) +#define D3DCURSORCAPS_COLOR 0x00000001L +// Driver supports HW cursor also in low-res modes(height < 400) +#define D3DCURSORCAPS_LOWRES 0x00000002L + +// +// DevCaps +// +#define D3DDEVCAPS_EXECUTESYSTEMMEMORY 0x00000010L /* Device can use execute buffers from system memory */ +#define D3DDEVCAPS_EXECUTEVIDEOMEMORY 0x00000020L /* Device can use execute buffers from video memory */ +#define D3DDEVCAPS_TLVERTEXSYSTEMMEMORY 0x00000040L /* Device can use TL buffers from system memory */ +#define D3DDEVCAPS_TLVERTEXVIDEOMEMORY 0x00000080L /* Device can use TL buffers from video memory */ +#define D3DDEVCAPS_TEXTURESYSTEMMEMORY 0x00000100L /* Device can texture from system memory */ +#define D3DDEVCAPS_TEXTUREVIDEOMEMORY 0x00000200L /* Device can texture from device memory */ +#define D3DDEVCAPS_DRAWPRIMTLVERTEX 0x00000400L /* Device can draw TLVERTEX primitives */ +#define D3DDEVCAPS_CANRENDERAFTERFLIP 0x00000800L /* Device can render without waiting for flip to complete */ +#define D3DDEVCAPS_TEXTURENONLOCALVIDMEM 0x00001000L /* Device can texture from nonlocal video memory */ +#define D3DDEVCAPS_DRAWPRIMITIVES2 0x00002000L /* Device can support DrawPrimitives2 */ +#define D3DDEVCAPS_SEPARATETEXTUREMEMORIES 0x00004000L /* Device is texturing from separate memory pools */ +#define D3DDEVCAPS_DRAWPRIMITIVES2EX 0x00008000L /* Device can support Extended DrawPrimitives2 i.e. DX7 compliant driver*/ +#define D3DDEVCAPS_HWTRANSFORMANDLIGHT 0x00010000L /* Device can support transformation and lighting in hardware and DRAWPRIMITIVES2EX must be also */ +#define D3DDEVCAPS_CANBLTSYSTONONLOCAL 0x00020000L /* Device supports a Tex Blt from system memory to non-local vidmem */ +#define D3DDEVCAPS_HWRASTERIZATION 0x00080000L /* Device has HW acceleration for rasterization */ +#define D3DDEVCAPS_PUREDEVICE 0x00100000L /* Device supports D3DCREATE_PUREDEVICE */ +#define D3DDEVCAPS_QUINTICRTPATCHES 0x00200000L /* Device supports quintic Beziers and BSplines */ +#define D3DDEVCAPS_RTPATCHES 0x00400000L /* Device supports Rect and Tri patches */ +#define D3DDEVCAPS_RTPATCHHANDLEZERO 0x00800000L /* Indicates that RT Patches may be drawn efficiently using handle 0 */ +#define D3DDEVCAPS_NPATCHES 0x01000000L /* Device supports N-Patches */ + +// +// PrimitiveMiscCaps +// +#define D3DPMISCCAPS_MASKZ 0x00000002L +#define D3DPMISCCAPS_CULLNONE 0x00000010L +#define D3DPMISCCAPS_CULLCW 0x00000020L +#define D3DPMISCCAPS_CULLCCW 0x00000040L +#define D3DPMISCCAPS_COLORWRITEENABLE 0x00000080L +#define D3DPMISCCAPS_CLIPPLANESCALEDPOINTS 0x00000100L /* Device correctly clips scaled points to clip planes */ +#define D3DPMISCCAPS_CLIPTLVERTS 0x00000200L /* device will clip post-transformed vertex primitives */ +#define D3DPMISCCAPS_TSSARGTEMP 0x00000400L /* device supports D3DTA_TEMP for temporary register */ +#define D3DPMISCCAPS_BLENDOP 0x00000800L /* device supports D3DRS_BLENDOP */ +#define D3DPMISCCAPS_NULLREFERENCE 0x00001000L /* Reference Device that doesnt render */ +#define D3DPMISCCAPS_INDEPENDENTWRITEMASKS 0x00004000L /* Device supports independent write masks for MET or MRT */ +#define D3DPMISCCAPS_PERSTAGECONSTANT 0x00008000L /* Device supports per-stage constants */ +#define D3DPMISCCAPS_FOGANDSPECULARALPHA 0x00010000L /* Device supports separate fog and specular alpha (many devices + use the specular alpha channel to store fog factor) */ +#define D3DPMISCCAPS_SEPARATEALPHABLEND 0x00020000L /* Device supports separate blend settings for the alpha channel */ +#define D3DPMISCCAPS_MRTINDEPENDENTBITDEPTHS 0x00040000L /* Device supports different bit depths for MRT */ +#define D3DPMISCCAPS_MRTPOSTPIXELSHADERBLENDING 0x00080000L /* Device supports post-pixel shader operations for MRT */ +#define D3DPMISCCAPS_FOGVERTEXCLAMPED 0x00100000L /* Device clamps fog blend factor per vertex */ + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +#define D3DPMISCCAPS_POSTBLENDSRGBCONVERT 0x00200000L /* Indicates device can perform conversion to sRGB after blending. */ + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + +// +// LineCaps +// +#define D3DLINECAPS_TEXTURE 0x00000001L +#define D3DLINECAPS_ZTEST 0x00000002L +#define D3DLINECAPS_BLEND 0x00000004L +#define D3DLINECAPS_ALPHACMP 0x00000008L +#define D3DLINECAPS_FOG 0x00000010L +#define D3DLINECAPS_ANTIALIAS 0x00000020L + +// +// RasterCaps +// +#define D3DPRASTERCAPS_DITHER 0x00000001L +#define D3DPRASTERCAPS_ZTEST 0x00000010L +#define D3DPRASTERCAPS_FOGVERTEX 0x00000080L +#define D3DPRASTERCAPS_FOGTABLE 0x00000100L +#define D3DPRASTERCAPS_MIPMAPLODBIAS 0x00002000L +#define D3DPRASTERCAPS_ZBUFFERLESSHSR 0x00008000L +#define D3DPRASTERCAPS_FOGRANGE 0x00010000L +#define D3DPRASTERCAPS_ANISOTROPY 0x00020000L +#define D3DPRASTERCAPS_WBUFFER 0x00040000L +#define D3DPRASTERCAPS_WFOG 0x00100000L +#define D3DPRASTERCAPS_ZFOG 0x00200000L +#define D3DPRASTERCAPS_COLORPERSPECTIVE 0x00400000L /* Device iterates colors perspective correct */ +#define D3DPRASTERCAPS_SCISSORTEST 0x01000000L +#define D3DPRASTERCAPS_SLOPESCALEDEPTHBIAS 0x02000000L +#define D3DPRASTERCAPS_DEPTHBIAS 0x04000000L +#define D3DPRASTERCAPS_MULTISAMPLE_TOGGLE 0x08000000L + +// +// ZCmpCaps, AlphaCmpCaps +// +#define D3DPCMPCAPS_NEVER 0x00000001L +#define D3DPCMPCAPS_LESS 0x00000002L +#define D3DPCMPCAPS_EQUAL 0x00000004L +#define D3DPCMPCAPS_LESSEQUAL 0x00000008L +#define D3DPCMPCAPS_GREATER 0x00000010L +#define D3DPCMPCAPS_NOTEQUAL 0x00000020L +#define D3DPCMPCAPS_GREATEREQUAL 0x00000040L +#define D3DPCMPCAPS_ALWAYS 0x00000080L + +// +// SourceBlendCaps, DestBlendCaps +// +#define D3DPBLENDCAPS_ZERO 0x00000001L +#define D3DPBLENDCAPS_ONE 0x00000002L +#define D3DPBLENDCAPS_SRCCOLOR 0x00000004L +#define D3DPBLENDCAPS_INVSRCCOLOR 0x00000008L +#define D3DPBLENDCAPS_SRCALPHA 0x00000010L +#define D3DPBLENDCAPS_INVSRCALPHA 0x00000020L +#define D3DPBLENDCAPS_DESTALPHA 0x00000040L +#define D3DPBLENDCAPS_INVDESTALPHA 0x00000080L +#define D3DPBLENDCAPS_DESTCOLOR 0x00000100L +#define D3DPBLENDCAPS_INVDESTCOLOR 0x00000200L +#define D3DPBLENDCAPS_SRCALPHASAT 0x00000400L +#define D3DPBLENDCAPS_BOTHSRCALPHA 0x00000800L +#define D3DPBLENDCAPS_BOTHINVSRCALPHA 0x00001000L +#define D3DPBLENDCAPS_BLENDFACTOR 0x00002000L /* Supports both D3DBLEND_BLENDFACTOR and D3DBLEND_INVBLENDFACTOR */ + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +#define D3DPBLENDCAPS_SRCCOLOR2 0x00004000L +#define D3DPBLENDCAPS_INVSRCCOLOR2 0x00008000L + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + + +// +// ShadeCaps +// +#define D3DPSHADECAPS_COLORGOURAUDRGB 0x00000008L +#define D3DPSHADECAPS_SPECULARGOURAUDRGB 0x00000200L +#define D3DPSHADECAPS_ALPHAGOURAUDBLEND 0x00004000L +#define D3DPSHADECAPS_FOGGOURAUD 0x00080000L + +// +// TextureCaps +// +#define D3DPTEXTURECAPS_PERSPECTIVE 0x00000001L /* Perspective-correct texturing is supported */ +#define D3DPTEXTURECAPS_POW2 0x00000002L /* Power-of-2 texture dimensions are required - applies to non-Cube/Volume textures only. */ +#define D3DPTEXTURECAPS_ALPHA 0x00000004L /* Alpha in texture pixels is supported */ +#define D3DPTEXTURECAPS_SQUAREONLY 0x00000020L /* Only square textures are supported */ +#define D3DPTEXTURECAPS_TEXREPEATNOTSCALEDBYSIZE 0x00000040L /* Texture indices are not scaled by the texture size prior to interpolation */ +#define D3DPTEXTURECAPS_ALPHAPALETTE 0x00000080L /* Device can draw alpha from texture palettes */ +// Device can use non-POW2 textures if: +// 1) D3DTEXTURE_ADDRESS is set to CLAMP for this texture's stage +// 2) D3DRS_WRAP(N) is zero for this texture's coordinates +// 3) mip mapping is not enabled (use magnification filter only) +#define D3DPTEXTURECAPS_NONPOW2CONDITIONAL 0x00000100L +#define D3DPTEXTURECAPS_PROJECTED 0x00000400L /* Device can do D3DTTFF_PROJECTED */ +#define D3DPTEXTURECAPS_CUBEMAP 0x00000800L /* Device can do cubemap textures */ +#define D3DPTEXTURECAPS_VOLUMEMAP 0x00002000L /* Device can do volume textures */ +#define D3DPTEXTURECAPS_MIPMAP 0x00004000L /* Device can do mipmapped textures */ +#define D3DPTEXTURECAPS_MIPVOLUMEMAP 0x00008000L /* Device can do mipmapped volume textures */ +#define D3DPTEXTURECAPS_MIPCUBEMAP 0x00010000L /* Device can do mipmapped cube maps */ +#define D3DPTEXTURECAPS_CUBEMAP_POW2 0x00020000L /* Device requires that cubemaps be power-of-2 dimension */ +#define D3DPTEXTURECAPS_VOLUMEMAP_POW2 0x00040000L /* Device requires that volume maps be power-of-2 dimension */ +#define D3DPTEXTURECAPS_NOPROJECTEDBUMPENV 0x00200000L /* Device does not support projected bump env lookup operation + in programmable and fixed function pixel shaders */ + +// +// TextureFilterCaps, StretchRectFilterCaps +// +#define D3DPTFILTERCAPS_MINFPOINT 0x00000100L /* Min Filter */ +#define D3DPTFILTERCAPS_MINFLINEAR 0x00000200L +#define D3DPTFILTERCAPS_MINFANISOTROPIC 0x00000400L +#define D3DPTFILTERCAPS_MINFPYRAMIDALQUAD 0x00000800L +#define D3DPTFILTERCAPS_MINFGAUSSIANQUAD 0x00001000L +#define D3DPTFILTERCAPS_MIPFPOINT 0x00010000L /* Mip Filter */ +#define D3DPTFILTERCAPS_MIPFLINEAR 0x00020000L + +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + +#define D3DPTFILTERCAPS_CONVOLUTIONMONO 0x00040000L /* Min and Mag for the convolution mono filter */ + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + +#define D3DPTFILTERCAPS_MAGFPOINT 0x01000000L /* Mag Filter */ +#define D3DPTFILTERCAPS_MAGFLINEAR 0x02000000L +#define D3DPTFILTERCAPS_MAGFANISOTROPIC 0x04000000L +#define D3DPTFILTERCAPS_MAGFPYRAMIDALQUAD 0x08000000L +#define D3DPTFILTERCAPS_MAGFGAUSSIANQUAD 0x10000000L + +// +// TextureAddressCaps +// +#define D3DPTADDRESSCAPS_WRAP 0x00000001L +#define D3DPTADDRESSCAPS_MIRROR 0x00000002L +#define D3DPTADDRESSCAPS_CLAMP 0x00000004L +#define D3DPTADDRESSCAPS_BORDER 0x00000008L +#define D3DPTADDRESSCAPS_INDEPENDENTUV 0x00000010L +#define D3DPTADDRESSCAPS_MIRRORONCE 0x00000020L + +// +// StencilCaps +// +#define D3DSTENCILCAPS_KEEP 0x00000001L +#define D3DSTENCILCAPS_ZERO 0x00000002L +#define D3DSTENCILCAPS_REPLACE 0x00000004L +#define D3DSTENCILCAPS_INCRSAT 0x00000008L +#define D3DSTENCILCAPS_DECRSAT 0x00000010L +#define D3DSTENCILCAPS_INVERT 0x00000020L +#define D3DSTENCILCAPS_INCR 0x00000040L +#define D3DSTENCILCAPS_DECR 0x00000080L +#define D3DSTENCILCAPS_TWOSIDED 0x00000100L + +// +// TextureOpCaps +// +#define D3DTEXOPCAPS_DISABLE 0x00000001L +#define D3DTEXOPCAPS_SELECTARG1 0x00000002L +#define D3DTEXOPCAPS_SELECTARG2 0x00000004L +#define D3DTEXOPCAPS_MODULATE 0x00000008L +#define D3DTEXOPCAPS_MODULATE2X 0x00000010L +#define D3DTEXOPCAPS_MODULATE4X 0x00000020L +#define D3DTEXOPCAPS_ADD 0x00000040L +#define D3DTEXOPCAPS_ADDSIGNED 0x00000080L +#define D3DTEXOPCAPS_ADDSIGNED2X 0x00000100L +#define D3DTEXOPCAPS_SUBTRACT 0x00000200L +#define D3DTEXOPCAPS_ADDSMOOTH 0x00000400L +#define D3DTEXOPCAPS_BLENDDIFFUSEALPHA 0x00000800L +#define D3DTEXOPCAPS_BLENDTEXTUREALPHA 0x00001000L +#define D3DTEXOPCAPS_BLENDFACTORALPHA 0x00002000L +#define D3DTEXOPCAPS_BLENDTEXTUREALPHAPM 0x00004000L +#define D3DTEXOPCAPS_BLENDCURRENTALPHA 0x00008000L +#define D3DTEXOPCAPS_PREMODULATE 0x00010000L +#define D3DTEXOPCAPS_MODULATEALPHA_ADDCOLOR 0x00020000L +#define D3DTEXOPCAPS_MODULATECOLOR_ADDALPHA 0x00040000L +#define D3DTEXOPCAPS_MODULATEINVALPHA_ADDCOLOR 0x00080000L +#define D3DTEXOPCAPS_MODULATEINVCOLOR_ADDALPHA 0x00100000L +#define D3DTEXOPCAPS_BUMPENVMAP 0x00200000L +#define D3DTEXOPCAPS_BUMPENVMAPLUMINANCE 0x00400000L +#define D3DTEXOPCAPS_DOTPRODUCT3 0x00800000L +#define D3DTEXOPCAPS_MULTIPLYADD 0x01000000L +#define D3DTEXOPCAPS_LERP 0x02000000L + +// +// FVFCaps +// +#define D3DFVFCAPS_TEXCOORDCOUNTMASK 0x0000ffffL /* mask for texture coordinate count field */ +#define D3DFVFCAPS_DONOTSTRIPELEMENTS 0x00080000L /* Device prefers that vertex elements not be stripped */ +#define D3DFVFCAPS_PSIZE 0x00100000L /* Device can receive point size */ + +// +// VertexProcessingCaps +// +#define D3DVTXPCAPS_TEXGEN 0x00000001L /* device can do texgen */ +#define D3DVTXPCAPS_MATERIALSOURCE7 0x00000002L /* device can do DX7-level colormaterialsource ops */ +#define D3DVTXPCAPS_DIRECTIONALLIGHTS 0x00000008L /* device can do directional lights */ +#define D3DVTXPCAPS_POSITIONALLIGHTS 0x00000010L /* device can do positional lights (includes point and spot) */ +#define D3DVTXPCAPS_LOCALVIEWER 0x00000020L /* device can do local viewer */ +#define D3DVTXPCAPS_TWEENING 0x00000040L /* device can do vertex tweening */ +#define D3DVTXPCAPS_TEXGEN_SPHEREMAP 0x00000100L /* device supports D3DTSS_TCI_SPHEREMAP */ +#define D3DVTXPCAPS_NO_TEXGEN_NONLOCALVIEWER 0x00000200L /* device does not support TexGen in non-local + viewer mode */ + +// +// DevCaps2 +// +#define D3DDEVCAPS2_STREAMOFFSET 0x00000001L /* Device supports offsets in streams. Must be set by DX9 drivers */ +#define D3DDEVCAPS2_DMAPNPATCH 0x00000002L /* Device supports displacement maps for N-Patches*/ +#define D3DDEVCAPS2_ADAPTIVETESSRTPATCH 0x00000004L /* Device supports adaptive tesselation of RT-patches*/ +#define D3DDEVCAPS2_ADAPTIVETESSNPATCH 0x00000008L /* Device supports adaptive tesselation of N-patches*/ +#define D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES 0x00000010L /* Device supports StretchRect calls with a texture as the source*/ +#define D3DDEVCAPS2_PRESAMPLEDDMAPNPATCH 0x00000020L /* Device supports presampled displacement maps for N-Patches */ +#define D3DDEVCAPS2_VERTEXELEMENTSCANSHARESTREAMOFFSET 0x00000040L /* Vertex elements in a vertex declaration can share the same stream offset */ + +// +// DeclTypes +// +#define D3DDTCAPS_UBYTE4 0x00000001L +#define D3DDTCAPS_UBYTE4N 0x00000002L +#define D3DDTCAPS_SHORT2N 0x00000004L +#define D3DDTCAPS_SHORT4N 0x00000008L +#define D3DDTCAPS_USHORT2N 0x00000010L +#define D3DDTCAPS_USHORT4N 0x00000020L +#define D3DDTCAPS_UDEC3 0x00000040L +#define D3DDTCAPS_DEC3N 0x00000080L +#define D3DDTCAPS_FLOAT16_2 0x00000100L +#define D3DDTCAPS_FLOAT16_4 0x00000200L + + +#pragma pack() + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* (DIRECT3D_VERSION >= 0x0900) */ +#endif /* _d3d9CAPS_H_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9types.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9types.h new file mode 100644 index 0000000000000000000000000000000000000000..f7142fae8fc015492c3937515a44923ade2dfce8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3d9types.h @@ -0,0 +1,2455 @@ +/*==========================================================================; + * + * Copyright (C) Microsoft Corporation. All Rights Reserved. + * + * File: d3d9types.h + * Content: Direct3D capabilities include file + * + ***************************************************************************/ + +#ifndef _d3d9TYPES_H_ +#define _d3d9TYPES_H_ + +#include + +#ifndef DIRECT3D_VERSION +#define DIRECT3D_VERSION 0x0900 +#endif //DIRECT3D_VERSION + +// include this file content only if compiling for DX9 interfaces +#if(DIRECT3D_VERSION >= 0x0900) + +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // anonymous unions warning +#if defined(_X86_) || defined(_IA64_) +#pragma pack(4) +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// D3DCOLOR is equivalent to D3DFMT_A8R8G8B8 +#ifndef D3DCOLOR_DEFINED +typedef DWORD D3DCOLOR; +#define D3DCOLOR_DEFINED +#endif + +// maps unsigned 8 bits/channel to D3DCOLOR +#define D3DCOLOR_ARGB(a,r,g,b) \ + ((D3DCOLOR)((((a)&0xff)<<24)|(((r)&0xff)<<16)|(((g)&0xff)<<8)|((b)&0xff))) +#define D3DCOLOR_RGBA(r,g,b,a) D3DCOLOR_ARGB(a,r,g,b) +#define D3DCOLOR_XRGB(r,g,b) D3DCOLOR_ARGB(0xff,r,g,b) + +#define D3DCOLOR_XYUV(y,u,v) D3DCOLOR_ARGB(0xff,y,u,v) +#define D3DCOLOR_AYUV(a,y,u,v) D3DCOLOR_ARGB(a,y,u,v) + +// maps floating point channels (0.f to 1.f range) to D3DCOLOR +#define D3DCOLOR_COLORVALUE(r,g,b,a) \ + D3DCOLOR_RGBA((DWORD)((r)*255.f),(DWORD)((g)*255.f),(DWORD)((b)*255.f),(DWORD)((a)*255.f)) + + +#ifndef D3DVECTOR_DEFINED +typedef struct _D3DVECTOR { + float x; + float y; + float z; +} D3DVECTOR; +#define D3DVECTOR_DEFINED +#endif + +#ifndef D3DCOLORVALUE_DEFINED +typedef struct _D3DCOLORVALUE { + float r; + float g; + float b; + float a; +} D3DCOLORVALUE; +#define D3DCOLORVALUE_DEFINED +#endif + +#ifndef D3DRECT_DEFINED +typedef struct _D3DRECT { + LONG x1; + LONG y1; + LONG x2; + LONG y2; +} D3DRECT; +#define D3DRECT_DEFINED +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#ifndef D3DMATRIX_DEFINED +typedef struct _D3DMATRIX { + union { + struct { + float _11, _12, _13, _14; + float _21, _22, _23, _24; + float _31, _32, _33, _34; + float _41, _42, _43, _44; + + }; + float m[4][4]; + }; +} D3DMATRIX; +#define D3DMATRIX_DEFINED +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct _D3DVIEWPORT9 { + DWORD X; + DWORD Y; /* Viewport Top left */ + DWORD Width; + DWORD Height; /* Viewport Dimensions */ + float MinZ; /* Min/max of clip Volume */ + float MaxZ; +} D3DVIEWPORT9; + +/* + * Values for clip fields. + */ + +// Max number of user clipping planes, supported in D3D. +#define D3DMAXUSERCLIPPLANES 32 + +// These bits could be ORed together to use with D3DRS_CLIPPLANEENABLE +// +#define D3DCLIPPLANE0 (1 << 0) +#define D3DCLIPPLANE1 (1 << 1) +#define D3DCLIPPLANE2 (1 << 2) +#define D3DCLIPPLANE3 (1 << 3) +#define D3DCLIPPLANE4 (1 << 4) +#define D3DCLIPPLANE5 (1 << 5) + +// The following bits are used in the ClipUnion and ClipIntersection +// members of the D3DCLIPSTATUS9 +// + +#define D3DCS_LEFT 0x00000001L +#define D3DCS_RIGHT 0x00000002L +#define D3DCS_TOP 0x00000004L +#define D3DCS_BOTTOM 0x00000008L +#define D3DCS_FRONT 0x00000010L +#define D3DCS_BACK 0x00000020L +#define D3DCS_PLANE0 0x00000040L +#define D3DCS_PLANE1 0x00000080L +#define D3DCS_PLANE2 0x00000100L +#define D3DCS_PLANE3 0x00000200L +#define D3DCS_PLANE4 0x00000400L +#define D3DCS_PLANE5 0x00000800L + +#define D3DCS_ALL (D3DCS_LEFT | \ + D3DCS_RIGHT | \ + D3DCS_TOP | \ + D3DCS_BOTTOM | \ + D3DCS_FRONT | \ + D3DCS_BACK | \ + D3DCS_PLANE0 | \ + D3DCS_PLANE1 | \ + D3DCS_PLANE2 | \ + D3DCS_PLANE3 | \ + D3DCS_PLANE4 | \ + D3DCS_PLANE5) + +typedef struct _D3DCLIPSTATUS9 { + DWORD ClipUnion; + DWORD ClipIntersection; +} D3DCLIPSTATUS9; + +typedef struct _D3DMATERIAL9 { + D3DCOLORVALUE Diffuse; /* Diffuse color RGBA */ + D3DCOLORVALUE Ambient; /* Ambient color RGB */ + D3DCOLORVALUE Specular; /* Specular 'shininess' */ + D3DCOLORVALUE Emissive; /* Emissive color RGB */ + float Power; /* Sharpness if specular highlight */ +} D3DMATERIAL9; + +typedef enum _D3DLIGHTTYPE { + D3DLIGHT_POINT = 1, + D3DLIGHT_SPOT = 2, + D3DLIGHT_DIRECTIONAL = 3, + D3DLIGHT_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DLIGHTTYPE; + +typedef struct _D3DLIGHT9 { + D3DLIGHTTYPE Type; /* Type of light source */ + D3DCOLORVALUE Diffuse; /* Diffuse color of light */ + D3DCOLORVALUE Specular; /* Specular color of light */ + D3DCOLORVALUE Ambient; /* Ambient color of light */ + D3DVECTOR Position; /* Position in world space */ + D3DVECTOR Direction; /* Direction in world space */ + float Range; /* Cutoff range */ + float Falloff; /* Falloff */ + float Attenuation0; /* Constant attenuation */ + float Attenuation1; /* Linear attenuation */ + float Attenuation2; /* Quadratic attenuation */ + float Theta; /* Inner angle of spotlight cone */ + float Phi; /* Outer angle of spotlight cone */ +} D3DLIGHT9; + +/* + * Options for clearing + */ +#define D3DCLEAR_TARGET 0x00000001l /* Clear target surface */ +#define D3DCLEAR_ZBUFFER 0x00000002l /* Clear target z buffer */ +#define D3DCLEAR_STENCIL 0x00000004l /* Clear stencil planes */ + +/* + * The following defines the rendering states + */ + +typedef enum _D3DSHADEMODE { + D3DSHADE_FLAT = 1, + D3DSHADE_GOURAUD = 2, + D3DSHADE_PHONG = 3, + D3DSHADE_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DSHADEMODE; + +typedef enum _D3DFILLMODE { + D3DFILL_POINT = 1, + D3DFILL_WIREFRAME = 2, + D3DFILL_SOLID = 3, + D3DFILL_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DFILLMODE; + +typedef enum _D3DBLEND { + D3DBLEND_ZERO = 1, + D3DBLEND_ONE = 2, + D3DBLEND_SRCCOLOR = 3, + D3DBLEND_INVSRCCOLOR = 4, + D3DBLEND_SRCALPHA = 5, + D3DBLEND_INVSRCALPHA = 6, + D3DBLEND_DESTALPHA = 7, + D3DBLEND_INVDESTALPHA = 8, + D3DBLEND_DESTCOLOR = 9, + D3DBLEND_INVDESTCOLOR = 10, + D3DBLEND_SRCALPHASAT = 11, + D3DBLEND_BOTHSRCALPHA = 12, + D3DBLEND_BOTHINVSRCALPHA = 13, + D3DBLEND_BLENDFACTOR = 14, /* Only supported if D3DPBLENDCAPS_BLENDFACTOR is on */ + D3DBLEND_INVBLENDFACTOR = 15, /* Only supported if D3DPBLENDCAPS_BLENDFACTOR is on */ +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + + D3DBLEND_SRCCOLOR2 = 16, + D3DBLEND_INVSRCCOLOR2 = 17, + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + D3DBLEND_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DBLEND; + +typedef enum _D3DBLENDOP { + D3DBLENDOP_ADD = 1, + D3DBLENDOP_SUBTRACT = 2, + D3DBLENDOP_REVSUBTRACT = 3, + D3DBLENDOP_MIN = 4, + D3DBLENDOP_MAX = 5, + D3DBLENDOP_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DBLENDOP; + +typedef enum _D3DTEXTUREADDRESS { + D3DTADDRESS_WRAP = 1, + D3DTADDRESS_MIRROR = 2, + D3DTADDRESS_CLAMP = 3, + D3DTADDRESS_BORDER = 4, + D3DTADDRESS_MIRRORONCE = 5, + D3DTADDRESS_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DTEXTUREADDRESS; + +typedef enum _D3DCULL { + D3DCULL_NONE = 1, + D3DCULL_CW = 2, + D3DCULL_CCW = 3, + D3DCULL_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DCULL; + +typedef enum _D3DCMPFUNC { + D3DCMP_NEVER = 1, + D3DCMP_LESS = 2, + D3DCMP_EQUAL = 3, + D3DCMP_LESSEQUAL = 4, + D3DCMP_GREATER = 5, + D3DCMP_NOTEQUAL = 6, + D3DCMP_GREATEREQUAL = 7, + D3DCMP_ALWAYS = 8, + D3DCMP_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DCMPFUNC; + +typedef enum _D3DSTENCILOP { + D3DSTENCILOP_KEEP = 1, + D3DSTENCILOP_ZERO = 2, + D3DSTENCILOP_REPLACE = 3, + D3DSTENCILOP_INCRSAT = 4, + D3DSTENCILOP_DECRSAT = 5, + D3DSTENCILOP_INVERT = 6, + D3DSTENCILOP_INCR = 7, + D3DSTENCILOP_DECR = 8, + D3DSTENCILOP_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DSTENCILOP; + +typedef enum _D3DFOGMODE { + D3DFOG_NONE = 0, + D3DFOG_EXP = 1, + D3DFOG_EXP2 = 2, + D3DFOG_LINEAR = 3, + D3DFOG_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DFOGMODE; + +typedef enum _D3DZBUFFERTYPE { + D3DZB_FALSE = 0, + D3DZB_TRUE = 1, // Z buffering + D3DZB_USEW = 2, // W buffering + D3DZB_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DZBUFFERTYPE; + +// Primitives supported by draw-primitive API +typedef enum _D3DPRIMITIVETYPE { + D3DPT_POINTLIST = 1, + D3DPT_LINELIST = 2, + D3DPT_LINESTRIP = 3, + D3DPT_TRIANGLELIST = 4, + D3DPT_TRIANGLESTRIP = 5, + D3DPT_TRIANGLEFAN = 6, + D3DPT_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DPRIMITIVETYPE; + +typedef enum _D3DTRANSFORMSTATETYPE { + D3DTS_VIEW = 2, + D3DTS_PROJECTION = 3, + D3DTS_TEXTURE0 = 16, + D3DTS_TEXTURE1 = 17, + D3DTS_TEXTURE2 = 18, + D3DTS_TEXTURE3 = 19, + D3DTS_TEXTURE4 = 20, + D3DTS_TEXTURE5 = 21, + D3DTS_TEXTURE6 = 22, + D3DTS_TEXTURE7 = 23, + D3DTS_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DTRANSFORMSTATETYPE; + +#define D3DTS_WORLDMATRIX(index) (D3DTRANSFORMSTATETYPE)(index + 256) +#define D3DTS_WORLD D3DTS_WORLDMATRIX(0) +#define D3DTS_WORLD1 D3DTS_WORLDMATRIX(1) +#define D3DTS_WORLD2 D3DTS_WORLDMATRIX(2) +#define D3DTS_WORLD3 D3DTS_WORLDMATRIX(3) + +typedef enum _D3DRENDERSTATETYPE { + D3DRS_ZENABLE = 7, /* D3DZBUFFERTYPE (or TRUE/FALSE for legacy) */ + D3DRS_FILLMODE = 8, /* D3DFILLMODE */ + D3DRS_SHADEMODE = 9, /* D3DSHADEMODE */ + D3DRS_ZWRITEENABLE = 14, /* TRUE to enable z writes */ + D3DRS_ALPHATESTENABLE = 15, /* TRUE to enable alpha tests */ + D3DRS_LASTPIXEL = 16, /* TRUE for last-pixel on lines */ + D3DRS_SRCBLEND = 19, /* D3DBLEND */ + D3DRS_DESTBLEND = 20, /* D3DBLEND */ + D3DRS_CULLMODE = 22, /* D3DCULL */ + D3DRS_ZFUNC = 23, /* D3DCMPFUNC */ + D3DRS_ALPHAREF = 24, /* D3DFIXED */ + D3DRS_ALPHAFUNC = 25, /* D3DCMPFUNC */ + D3DRS_DITHERENABLE = 26, /* TRUE to enable dithering */ + D3DRS_ALPHABLENDENABLE = 27, /* TRUE to enable alpha blending */ + D3DRS_FOGENABLE = 28, /* TRUE to enable fog blending */ + D3DRS_SPECULARENABLE = 29, /* TRUE to enable specular */ + D3DRS_FOGCOLOR = 34, /* D3DCOLOR */ + D3DRS_FOGTABLEMODE = 35, /* D3DFOGMODE */ + D3DRS_FOGSTART = 36, /* Fog start (for both vertex and pixel fog) */ + D3DRS_FOGEND = 37, /* Fog end */ + D3DRS_FOGDENSITY = 38, /* Fog density */ + D3DRS_RANGEFOGENABLE = 48, /* Enables range-based fog */ + D3DRS_STENCILENABLE = 52, /* BOOL enable/disable stenciling */ + D3DRS_STENCILFAIL = 53, /* D3DSTENCILOP to do if stencil test fails */ + D3DRS_STENCILZFAIL = 54, /* D3DSTENCILOP to do if stencil test passes and Z test fails */ + D3DRS_STENCILPASS = 55, /* D3DSTENCILOP to do if both stencil and Z tests pass */ + D3DRS_STENCILFUNC = 56, /* D3DCMPFUNC fn. Stencil Test passes if ((ref & mask) stencilfn (stencil & mask)) is true */ + D3DRS_STENCILREF = 57, /* Reference value used in stencil test */ + D3DRS_STENCILMASK = 58, /* Mask value used in stencil test */ + D3DRS_STENCILWRITEMASK = 59, /* Write mask applied to values written to stencil buffer */ + D3DRS_TEXTUREFACTOR = 60, /* D3DCOLOR used for multi-texture blend */ + D3DRS_WRAP0 = 128, /* wrap for 1st texture coord. set */ + D3DRS_WRAP1 = 129, /* wrap for 2nd texture coord. set */ + D3DRS_WRAP2 = 130, /* wrap for 3rd texture coord. set */ + D3DRS_WRAP3 = 131, /* wrap for 4th texture coord. set */ + D3DRS_WRAP4 = 132, /* wrap for 5th texture coord. set */ + D3DRS_WRAP5 = 133, /* wrap for 6th texture coord. set */ + D3DRS_WRAP6 = 134, /* wrap for 7th texture coord. set */ + D3DRS_WRAP7 = 135, /* wrap for 8th texture coord. set */ + D3DRS_CLIPPING = 136, + D3DRS_LIGHTING = 137, + D3DRS_AMBIENT = 139, + D3DRS_FOGVERTEXMODE = 140, + D3DRS_COLORVERTEX = 141, + D3DRS_LOCALVIEWER = 142, + D3DRS_NORMALIZENORMALS = 143, + D3DRS_DIFFUSEMATERIALSOURCE = 145, + D3DRS_SPECULARMATERIALSOURCE = 146, + D3DRS_AMBIENTMATERIALSOURCE = 147, + D3DRS_EMISSIVEMATERIALSOURCE = 148, + D3DRS_VERTEXBLEND = 151, + D3DRS_CLIPPLANEENABLE = 152, + D3DRS_POINTSIZE = 154, /* float point size */ + D3DRS_POINTSIZE_MIN = 155, /* float point size min threshold */ + D3DRS_POINTSPRITEENABLE = 156, /* BOOL point texture coord control */ + D3DRS_POINTSCALEENABLE = 157, /* BOOL point size scale enable */ + D3DRS_POINTSCALE_A = 158, /* float point attenuation A value */ + D3DRS_POINTSCALE_B = 159, /* float point attenuation B value */ + D3DRS_POINTSCALE_C = 160, /* float point attenuation C value */ + D3DRS_MULTISAMPLEANTIALIAS = 161, // BOOL - set to do FSAA with multisample buffer + D3DRS_MULTISAMPLEMASK = 162, // DWORD - per-sample enable/disable + D3DRS_PATCHEDGESTYLE = 163, // Sets whether patch edges will use float style tessellation + D3DRS_DEBUGMONITORTOKEN = 165, // DEBUG ONLY - token to debug monitor + D3DRS_POINTSIZE_MAX = 166, /* float point size max threshold */ + D3DRS_INDEXEDVERTEXBLENDENABLE = 167, + D3DRS_COLORWRITEENABLE = 168, // per-channel write enable + D3DRS_TWEENFACTOR = 170, // float tween factor + D3DRS_BLENDOP = 171, // D3DBLENDOP setting + D3DRS_POSITIONDEGREE = 172, // NPatch position interpolation degree. D3DDEGREE_LINEAR or D3DDEGREE_CUBIC (default) + D3DRS_NORMALDEGREE = 173, // NPatch normal interpolation degree. D3DDEGREE_LINEAR (default) or D3DDEGREE_QUADRATIC + D3DRS_SCISSORTESTENABLE = 174, + D3DRS_SLOPESCALEDEPTHBIAS = 175, + D3DRS_ANTIALIASEDLINEENABLE = 176, + D3DRS_MINTESSELLATIONLEVEL = 178, + D3DRS_MAXTESSELLATIONLEVEL = 179, + D3DRS_ADAPTIVETESS_X = 180, + D3DRS_ADAPTIVETESS_Y = 181, + D3DRS_ADAPTIVETESS_Z = 182, + D3DRS_ADAPTIVETESS_W = 183, + D3DRS_ENABLEADAPTIVETESSELLATION = 184, + D3DRS_TWOSIDEDSTENCILMODE = 185, /* BOOL enable/disable 2 sided stenciling */ + D3DRS_CCW_STENCILFAIL = 186, /* D3DSTENCILOP to do if ccw stencil test fails */ + D3DRS_CCW_STENCILZFAIL = 187, /* D3DSTENCILOP to do if ccw stencil test passes and Z test fails */ + D3DRS_CCW_STENCILPASS = 188, /* D3DSTENCILOP to do if both ccw stencil and Z tests pass */ + D3DRS_CCW_STENCILFUNC = 189, /* D3DCMPFUNC fn. ccw Stencil Test passes if ((ref & mask) stencilfn (stencil & mask)) is true */ + D3DRS_COLORWRITEENABLE1 = 190, /* Additional ColorWriteEnables for the devices that support D3DPMISCCAPS_INDEPENDENTWRITEMASKS */ + D3DRS_COLORWRITEENABLE2 = 191, /* Additional ColorWriteEnables for the devices that support D3DPMISCCAPS_INDEPENDENTWRITEMASKS */ + D3DRS_COLORWRITEENABLE3 = 192, /* Additional ColorWriteEnables for the devices that support D3DPMISCCAPS_INDEPENDENTWRITEMASKS */ + D3DRS_BLENDFACTOR = 193, /* D3DCOLOR used for a constant blend factor during alpha blending for devices that support D3DPBLENDCAPS_BLENDFACTOR */ + D3DRS_SRGBWRITEENABLE = 194, /* Enable rendertarget writes to be DE-linearized to SRGB (for formats that expose D3DUSAGE_QUERY_SRGBWRITE) */ + D3DRS_DEPTHBIAS = 195, + D3DRS_WRAP8 = 198, /* Additional wrap states for vs_3_0+ attributes with D3DDECLUSAGE_TEXCOORD */ + D3DRS_WRAP9 = 199, + D3DRS_WRAP10 = 200, + D3DRS_WRAP11 = 201, + D3DRS_WRAP12 = 202, + D3DRS_WRAP13 = 203, + D3DRS_WRAP14 = 204, + D3DRS_WRAP15 = 205, + D3DRS_SEPARATEALPHABLENDENABLE = 206, /* TRUE to enable a separate blending function for the alpha channel */ + D3DRS_SRCBLENDALPHA = 207, /* SRC blend factor for the alpha channel when D3DRS_SEPARATEDESTALPHAENABLE is TRUE */ + D3DRS_DESTBLENDALPHA = 208, /* DST blend factor for the alpha channel when D3DRS_SEPARATEDESTALPHAENABLE is TRUE */ + D3DRS_BLENDOPALPHA = 209, /* Blending operation for the alpha channel when D3DRS_SEPARATEDESTALPHAENABLE is TRUE */ + + + D3DRS_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DRENDERSTATETYPE; + +// Maximum number of simultaneous render targets D3D supports +#define D3D_MAX_SIMULTANEOUS_RENDERTARGETS 4 + +// Values for material source +typedef enum _D3DMATERIALCOLORSOURCE +{ + D3DMCS_MATERIAL = 0, // Color from material is used + D3DMCS_COLOR1 = 1, // Diffuse vertex color is used + D3DMCS_COLOR2 = 2, // Specular vertex color is used + D3DMCS_FORCE_DWORD = 0x7fffffff, // force 32-bit size enum +} D3DMATERIALCOLORSOURCE; + +// Bias to apply to the texture coordinate set to apply a wrap to. +#define D3DRENDERSTATE_WRAPBIAS 128UL + +/* Flags to construct the WRAP render states */ +#define D3DWRAP_U 0x00000001L +#define D3DWRAP_V 0x00000002L +#define D3DWRAP_W 0x00000004L + +/* Flags to construct the WRAP render states for 1D thru 4D texture coordinates */ +#define D3DWRAPCOORD_0 0x00000001L // same as D3DWRAP_U +#define D3DWRAPCOORD_1 0x00000002L // same as D3DWRAP_V +#define D3DWRAPCOORD_2 0x00000004L // same as D3DWRAP_W +#define D3DWRAPCOORD_3 0x00000008L + +/* Flags to construct D3DRS_COLORWRITEENABLE */ +#define D3DCOLORWRITEENABLE_RED (1L<<0) +#define D3DCOLORWRITEENABLE_GREEN (1L<<1) +#define D3DCOLORWRITEENABLE_BLUE (1L<<2) +#define D3DCOLORWRITEENABLE_ALPHA (1L<<3) + +/* + * State enumerants for per-stage processing of fixed function pixel processing + * Two of these affect fixed function vertex processing as well: TEXTURETRANSFORMFLAGS and TEXCOORDINDEX. + */ +typedef enum _D3DTEXTURESTAGESTATETYPE +{ + D3DTSS_COLOROP = 1, /* D3DTEXTUREOP - per-stage blending controls for color channels */ + D3DTSS_COLORARG1 = 2, /* D3DTA_* (texture arg) */ + D3DTSS_COLORARG2 = 3, /* D3DTA_* (texture arg) */ + D3DTSS_ALPHAOP = 4, /* D3DTEXTUREOP - per-stage blending controls for alpha channel */ + D3DTSS_ALPHAARG1 = 5, /* D3DTA_* (texture arg) */ + D3DTSS_ALPHAARG2 = 6, /* D3DTA_* (texture arg) */ + D3DTSS_BUMPENVMAT00 = 7, /* float (bump mapping matrix) */ + D3DTSS_BUMPENVMAT01 = 8, /* float (bump mapping matrix) */ + D3DTSS_BUMPENVMAT10 = 9, /* float (bump mapping matrix) */ + D3DTSS_BUMPENVMAT11 = 10, /* float (bump mapping matrix) */ + D3DTSS_TEXCOORDINDEX = 11, /* identifies which set of texture coordinates index this texture */ + D3DTSS_BUMPENVLSCALE = 22, /* float scale for bump map luminance */ + D3DTSS_BUMPENVLOFFSET = 23, /* float offset for bump map luminance */ + D3DTSS_TEXTURETRANSFORMFLAGS = 24, /* D3DTEXTURETRANSFORMFLAGS controls texture transform */ + D3DTSS_COLORARG0 = 26, /* D3DTA_* third arg for triadic ops */ + D3DTSS_ALPHAARG0 = 27, /* D3DTA_* third arg for triadic ops */ + D3DTSS_RESULTARG = 28, /* D3DTA_* arg for result (CURRENT or TEMP) */ + D3DTSS_CONSTANT = 32, /* Per-stage constant D3DTA_CONSTANT */ + + + D3DTSS_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DTEXTURESTAGESTATETYPE; + +/* + * State enumerants for per-sampler texture processing. + */ +typedef enum _D3DSAMPLERSTATETYPE +{ + D3DSAMP_ADDRESSU = 1, /* D3DTEXTUREADDRESS for U coordinate */ + D3DSAMP_ADDRESSV = 2, /* D3DTEXTUREADDRESS for V coordinate */ + D3DSAMP_ADDRESSW = 3, /* D3DTEXTUREADDRESS for W coordinate */ + D3DSAMP_BORDERCOLOR = 4, /* D3DCOLOR */ + D3DSAMP_MAGFILTER = 5, /* D3DTEXTUREFILTER filter to use for magnification */ + D3DSAMP_MINFILTER = 6, /* D3DTEXTUREFILTER filter to use for minification */ + D3DSAMP_MIPFILTER = 7, /* D3DTEXTUREFILTER filter to use between mipmaps during minification */ + D3DSAMP_MIPMAPLODBIAS = 8, /* float Mipmap LOD bias */ + D3DSAMP_MAXMIPLEVEL = 9, /* DWORD 0..(n-1) LOD index of largest map to use (0 == largest) */ + D3DSAMP_MAXANISOTROPY = 10, /* DWORD maximum anisotropy */ + D3DSAMP_SRGBTEXTURE = 11, /* Default = 0 (which means Gamma 1.0, + no correction required.) else correct for + Gamma = 2.2 */ + D3DSAMP_ELEMENTINDEX = 12, /* When multi-element texture is assigned to sampler, this + indicates which element index to use. Default = 0. */ + D3DSAMP_DMAPOFFSET = 13, /* Offset in vertices in the pre-sampled displacement map. + Only valid for D3DDMAPSAMPLER sampler */ + D3DSAMP_FORCE_DWORD = 0x7fffffff, /* force 32-bit size enum */ +} D3DSAMPLERSTATETYPE; + +/* Special sampler which is used in the tesselator */ +#define D3DDMAPSAMPLER 256 + +// Samplers used in vertex shaders +#define D3DVERTEXTEXTURESAMPLER0 (D3DDMAPSAMPLER+1) +#define D3DVERTEXTEXTURESAMPLER1 (D3DDMAPSAMPLER+2) +#define D3DVERTEXTEXTURESAMPLER2 (D3DDMAPSAMPLER+3) +#define D3DVERTEXTEXTURESAMPLER3 (D3DDMAPSAMPLER+4) + +// Values, used with D3DTSS_TEXCOORDINDEX, to specify that the vertex data(position +// and normal in the camera space) should be taken as texture coordinates +// Low 16 bits are used to specify texture coordinate index, to take the WRAP mode from +// +#define D3DTSS_TCI_PASSTHRU 0x00000000 +#define D3DTSS_TCI_CAMERASPACENORMAL 0x00010000 +#define D3DTSS_TCI_CAMERASPACEPOSITION 0x00020000 +#define D3DTSS_TCI_CAMERASPACEREFLECTIONVECTOR 0x00030000 +#define D3DTSS_TCI_SPHEREMAP 0x00040000 + +/* + * Enumerations for COLOROP and ALPHAOP texture blending operations set in + * texture processing stage controls in D3DTSS. + */ +typedef enum _D3DTEXTUREOP +{ + // Control + D3DTOP_DISABLE = 1, // disables stage + D3DTOP_SELECTARG1 = 2, // the default + D3DTOP_SELECTARG2 = 3, + + // Modulate + D3DTOP_MODULATE = 4, // multiply args together + D3DTOP_MODULATE2X = 5, // multiply and 1 bit + D3DTOP_MODULATE4X = 6, // multiply and 2 bits + + // Add + D3DTOP_ADD = 7, // add arguments together + D3DTOP_ADDSIGNED = 8, // add with -0.5 bias + D3DTOP_ADDSIGNED2X = 9, // as above but left 1 bit + D3DTOP_SUBTRACT = 10, // Arg1 - Arg2, with no saturation + D3DTOP_ADDSMOOTH = 11, // add 2 args, subtract product + // Arg1 + Arg2 - Arg1*Arg2 + // = Arg1 + (1-Arg1)*Arg2 + + // Linear alpha blend: Arg1*(Alpha) + Arg2*(1-Alpha) + D3DTOP_BLENDDIFFUSEALPHA = 12, // iterated alpha + D3DTOP_BLENDTEXTUREALPHA = 13, // texture alpha + D3DTOP_BLENDFACTORALPHA = 14, // alpha from D3DRS_TEXTUREFACTOR + + // Linear alpha blend with pre-multiplied arg1 input: Arg1 + Arg2*(1-Alpha) + D3DTOP_BLENDTEXTUREALPHAPM = 15, // texture alpha + D3DTOP_BLENDCURRENTALPHA = 16, // by alpha of current color + + // Specular mapping + D3DTOP_PREMODULATE = 17, // modulate with next texture before use + D3DTOP_MODULATEALPHA_ADDCOLOR = 18, // Arg1.RGB + Arg1.A*Arg2.RGB + // COLOROP only + D3DTOP_MODULATECOLOR_ADDALPHA = 19, // Arg1.RGB*Arg2.RGB + Arg1.A + // COLOROP only + D3DTOP_MODULATEINVALPHA_ADDCOLOR = 20, // (1-Arg1.A)*Arg2.RGB + Arg1.RGB + // COLOROP only + D3DTOP_MODULATEINVCOLOR_ADDALPHA = 21, // (1-Arg1.RGB)*Arg2.RGB + Arg1.A + // COLOROP only + + // Bump mapping + D3DTOP_BUMPENVMAP = 22, // per pixel env map perturbation + D3DTOP_BUMPENVMAPLUMINANCE = 23, // with luminance channel + + // This can do either diffuse or specular bump mapping with correct input. + // Performs the function (Arg1.R*Arg2.R + Arg1.G*Arg2.G + Arg1.B*Arg2.B) + // where each component has been scaled and offset to make it signed. + // The result is replicated into all four (including alpha) channels. + // This is a valid COLOROP only. + D3DTOP_DOTPRODUCT3 = 24, + + // Triadic ops + D3DTOP_MULTIPLYADD = 25, // Arg0 + Arg1*Arg2 + D3DTOP_LERP = 26, // (Arg0)*Arg1 + (1-Arg0)*Arg2 + + D3DTOP_FORCE_DWORD = 0x7fffffff, +} D3DTEXTUREOP; + +/* + * Values for COLORARG0,1,2, ALPHAARG0,1,2, and RESULTARG texture blending + * operations set in texture processing stage controls in D3DRENDERSTATE. + */ +#define D3DTA_SELECTMASK 0x0000000f // mask for arg selector +#define D3DTA_DIFFUSE 0x00000000 // select diffuse color (read only) +#define D3DTA_CURRENT 0x00000001 // select stage destination register (read/write) +#define D3DTA_TEXTURE 0x00000002 // select texture color (read only) +#define D3DTA_TFACTOR 0x00000003 // select D3DRS_TEXTUREFACTOR (read only) +#define D3DTA_SPECULAR 0x00000004 // select specular color (read only) +#define D3DTA_TEMP 0x00000005 // select temporary register color (read/write) +#define D3DTA_CONSTANT 0x00000006 // select texture stage constant +#define D3DTA_COMPLEMENT 0x00000010 // take 1.0 - x (read modifier) +#define D3DTA_ALPHAREPLICATE 0x00000020 // replicate alpha to color components (read modifier) + +// +// Values for D3DSAMP_***FILTER texture stage states +// +typedef enum _D3DTEXTUREFILTERTYPE +{ + D3DTEXF_NONE = 0, // filtering disabled (valid for mip filter only) + D3DTEXF_POINT = 1, // nearest + D3DTEXF_LINEAR = 2, // linear interpolation + D3DTEXF_ANISOTROPIC = 3, // anisotropic + D3DTEXF_PYRAMIDALQUAD = 6, // 4-sample tent + D3DTEXF_GAUSSIANQUAD = 7, // 4-sample gaussian +/* D3D9Ex only -- */ +#if !defined(D3D_DISABLE_9EX) + + D3DTEXF_CONVOLUTIONMONO = 8, // Convolution filter for monochrome textures + +#endif // !D3D_DISABLE_9EX +/* -- D3D9Ex only */ + D3DTEXF_FORCE_DWORD = 0x7fffffff, // force 32-bit size enum +} D3DTEXTUREFILTERTYPE; + +/* Bits for Flags in ProcessVertices call */ + +#define D3DPV_DONOTCOPYDATA (1 << 0) + +//------------------------------------------------------------------- + +// Flexible vertex format bits +// +#define D3DFVF_RESERVED0 0x001 +#define D3DFVF_POSITION_MASK 0x400E +#define D3DFVF_XYZ 0x002 +#define D3DFVF_XYZRHW 0x004 +#define D3DFVF_XYZB1 0x006 +#define D3DFVF_XYZB2 0x008 +#define D3DFVF_XYZB3 0x00a +#define D3DFVF_XYZB4 0x00c +#define D3DFVF_XYZB5 0x00e +#define D3DFVF_XYZW 0x4002 + +#define D3DFVF_NORMAL 0x010 +#define D3DFVF_PSIZE 0x020 +#define D3DFVF_DIFFUSE 0x040 +#define D3DFVF_SPECULAR 0x080 + +#define D3DFVF_TEXCOUNT_MASK 0xf00 +#define D3DFVF_TEXCOUNT_SHIFT 8 +#define D3DFVF_TEX0 0x000 +#define D3DFVF_TEX1 0x100 +#define D3DFVF_TEX2 0x200 +#define D3DFVF_TEX3 0x300 +#define D3DFVF_TEX4 0x400 +#define D3DFVF_TEX5 0x500 +#define D3DFVF_TEX6 0x600 +#define D3DFVF_TEX7 0x700 +#define D3DFVF_TEX8 0x800 + +#define D3DFVF_LASTBETA_UBYTE4 0x1000 +#define D3DFVF_LASTBETA_D3DCOLOR 0x8000 + +#define D3DFVF_RESERVED2 0x6000 // 2 reserved bits + +//--------------------------------------------------------------------- +// Vertex Shaders +// + +// Vertex shader declaration + +// Vertex element semantics +// +typedef enum _D3DDECLUSAGE +{ + D3DDECLUSAGE_POSITION = 0, + D3DDECLUSAGE_BLENDWEIGHT, // 1 + D3DDECLUSAGE_BLENDINDICES, // 2 + D3DDECLUSAGE_NORMAL, // 3 + D3DDECLUSAGE_PSIZE, // 4 + D3DDECLUSAGE_TEXCOORD, // 5 + D3DDECLUSAGE_TANGENT, // 6 + D3DDECLUSAGE_BINORMAL, // 7 + D3DDECLUSAGE_TESSFACTOR, // 8 + D3DDECLUSAGE_POSITIONT, // 9 + D3DDECLUSAGE_COLOR, // 10 + D3DDECLUSAGE_FOG, // 11 + D3DDECLUSAGE_DEPTH, // 12 + D3DDECLUSAGE_SAMPLE, // 13 +} D3DDECLUSAGE; + +#define MAXD3DDECLUSAGE D3DDECLUSAGE_SAMPLE +#define MAXD3DDECLUSAGEINDEX 15 +#define MAXD3DDECLLENGTH 64 // does not include "end" marker vertex element + +typedef enum _D3DDECLMETHOD +{ + D3DDECLMETHOD_DEFAULT = 0, + D3DDECLMETHOD_PARTIALU, + D3DDECLMETHOD_PARTIALV, + D3DDECLMETHOD_CROSSUV, // Normal + D3DDECLMETHOD_UV, + D3DDECLMETHOD_LOOKUP, // Lookup a displacement map + D3DDECLMETHOD_LOOKUPPRESAMPLED, // Lookup a pre-sampled displacement map +} D3DDECLMETHOD; + +#define MAXD3DDECLMETHOD D3DDECLMETHOD_LOOKUPPRESAMPLED + +// Declarations for _Type fields +// +typedef enum _D3DDECLTYPE +{ + D3DDECLTYPE_FLOAT1 = 0, // 1D float expanded to (value, 0., 0., 1.) + D3DDECLTYPE_FLOAT2 = 1, // 2D float expanded to (value, value, 0., 1.) + D3DDECLTYPE_FLOAT3 = 2, // 3D float expanded to (value, value, value, 1.) + D3DDECLTYPE_FLOAT4 = 3, // 4D float + D3DDECLTYPE_D3DCOLOR = 4, // 4D packed unsigned bytes mapped to 0. to 1. range + // Input is in D3DCOLOR format (ARGB) expanded to (R, G, B, A) + D3DDECLTYPE_UBYTE4 = 5, // 4D unsigned byte + D3DDECLTYPE_SHORT2 = 6, // 2D signed short expanded to (value, value, 0., 1.) + D3DDECLTYPE_SHORT4 = 7, // 4D signed short + +// The following types are valid only with vertex shaders >= 2.0 + + + D3DDECLTYPE_UBYTE4N = 8, // Each of 4 bytes is normalized by dividing to 255.0 + D3DDECLTYPE_SHORT2N = 9, // 2D signed short normalized (v[0]/32767.0,v[1]/32767.0,0,1) + D3DDECLTYPE_SHORT4N = 10, // 4D signed short normalized (v[0]/32767.0,v[1]/32767.0,v[2]/32767.0,v[3]/32767.0) + D3DDECLTYPE_USHORT2N = 11, // 2D unsigned short normalized (v[0]/65535.0,v[1]/65535.0,0,1) + D3DDECLTYPE_USHORT4N = 12, // 4D unsigned short normalized (v[0]/65535.0,v[1]/65535.0,v[2]/65535.0,v[3]/65535.0) + D3DDECLTYPE_UDEC3 = 13, // 3D unsigned 10 10 10 format expanded to (value, value, value, 1) + D3DDECLTYPE_DEC3N = 14, // 3D signed 10 10 10 format normalized and expanded to (v[0]/511.0, v[1]/511.0, v[2]/511.0, 1) + D3DDECLTYPE_FLOAT16_2 = 15, // Two 16-bit floating point values, expanded to (value, value, 0, 1) + D3DDECLTYPE_FLOAT16_4 = 16, // Four 16-bit floating point values + D3DDECLTYPE_UNUSED = 17, // When the type field in a decl is unused. +} D3DDECLTYPE; + +#define MAXD3DDECLTYPE D3DDECLTYPE_UNUSED + +typedef struct _D3DVERTEXELEMENT9 +{ + WORD Stream; // Stream index + WORD Offset; // Offset in the stream in bytes + BYTE Type; // Data type + BYTE Method; // Processing method + BYTE Usage; // Semantics + BYTE UsageIndex; // Semantic index +} D3DVERTEXELEMENT9, *LPD3DVERTEXELEMENT9; + +// This is used to initialize the last vertex element in a vertex declaration +// array +// +#define D3DDECL_END() {0xFF,0,D3DDECLTYPE_UNUSED,0,0,0} + +// Maximum supported number of texture coordinate sets +#define D3DDP_MAXTEXCOORD 8 + +//--------------------------------------------------------------------- +// Values for IDirect3DDevice9::SetStreamSourceFreq's Setting parameter +//--------------------------------------------------------------------- +#define D3DSTREAMSOURCE_INDEXEDDATA (1<<30) +#define D3DSTREAMSOURCE_INSTANCEDATA (2<<30) + + + +//--------------------------------------------------------------------- +// +// The internal format of Pixel Shader (PS) & Vertex Shader (VS) +// Instruction Tokens is defined in the Direct3D Device Driver Kit +// +//--------------------------------------------------------------------- + +// +// Instruction Token Bit Definitions +// +#define D3DSI_OPCODE_MASK 0x0000FFFF + +#define D3DSI_INSTLENGTH_MASK 0x0F000000 +#define D3DSI_INSTLENGTH_SHIFT 24 + +typedef enum _D3DSHADER_INSTRUCTION_OPCODE_TYPE +{ + D3DSIO_NOP = 0, + D3DSIO_MOV , + D3DSIO_ADD , + D3DSIO_SUB , + D3DSIO_MAD , + D3DSIO_MUL , + D3DSIO_RCP , + D3DSIO_RSQ , + D3DSIO_DP3 , + D3DSIO_DP4 , + D3DSIO_MIN , + D3DSIO_MAX , + D3DSIO_SLT , + D3DSIO_SGE , + D3DSIO_EXP , + D3DSIO_LOG , + D3DSIO_LIT , + D3DSIO_DST , + D3DSIO_LRP , + D3DSIO_FRC , + D3DSIO_M4x4 , + D3DSIO_M4x3 , + D3DSIO_M3x4 , + D3DSIO_M3x3 , + D3DSIO_M3x2 , + D3DSIO_CALL , + D3DSIO_CALLNZ , + D3DSIO_LOOP , + D3DSIO_RET , + D3DSIO_ENDLOOP , + D3DSIO_LABEL , + D3DSIO_DCL , + D3DSIO_POW , + D3DSIO_CRS , + D3DSIO_SGN , + D3DSIO_ABS , + D3DSIO_NRM , + D3DSIO_SINCOS , + D3DSIO_REP , + D3DSIO_ENDREP , + D3DSIO_IF , + D3DSIO_IFC , + D3DSIO_ELSE , + D3DSIO_ENDIF , + D3DSIO_BREAK , + D3DSIO_BREAKC , + D3DSIO_MOVA , + D3DSIO_DEFB , + D3DSIO_DEFI , + + D3DSIO_TEXCOORD = 64, + D3DSIO_TEXKILL , + D3DSIO_TEX , + D3DSIO_TEXBEM , + D3DSIO_TEXBEML , + D3DSIO_TEXREG2AR , + D3DSIO_TEXREG2GB , + D3DSIO_TEXM3x2PAD , + D3DSIO_TEXM3x2TEX , + D3DSIO_TEXM3x3PAD , + D3DSIO_TEXM3x3TEX , + D3DSIO_RESERVED0 , + D3DSIO_TEXM3x3SPEC , + D3DSIO_TEXM3x3VSPEC , + D3DSIO_EXPP , + D3DSIO_LOGP , + D3DSIO_CND , + D3DSIO_DEF , + D3DSIO_TEXREG2RGB , + D3DSIO_TEXDP3TEX , + D3DSIO_TEXM3x2DEPTH , + D3DSIO_TEXDP3 , + D3DSIO_TEXM3x3 , + D3DSIO_TEXDEPTH , + D3DSIO_CMP , + D3DSIO_BEM , + D3DSIO_DP2ADD , + D3DSIO_DSX , + D3DSIO_DSY , + D3DSIO_TEXLDD , + D3DSIO_SETP , + D3DSIO_TEXLDL , + D3DSIO_BREAKP , + + D3DSIO_PHASE = 0xFFFD, + D3DSIO_COMMENT = 0xFFFE, + D3DSIO_END = 0xFFFF, + + D3DSIO_FORCE_DWORD = 0x7fffffff, // force 32-bit size enum +} D3DSHADER_INSTRUCTION_OPCODE_TYPE; + +//--------------------------------------------------------------------- +// Use these constants with D3DSIO_SINCOS macro as SRC2, SRC3 +// +#define D3DSINCOSCONST1 -1.5500992e-006f, -2.1701389e-005f, 0.0026041667f, 0.00026041668f +#define D3DSINCOSCONST2 -0.020833334f, -0.12500000f, 1.0f, 0.50000000f + +//--------------------------------------------------------------------- +// Co-Issue Instruction Modifier - if set then this instruction is to be +// issued in parallel with the previous instruction(s) for which this bit +// is not set. +// +#define D3DSI_COISSUE 0x40000000 + +//--------------------------------------------------------------------- +// Opcode specific controls + +#define D3DSP_OPCODESPECIFICCONTROL_MASK 0x00ff0000 +#define D3DSP_OPCODESPECIFICCONTROL_SHIFT 16 + +// ps_2_0 texld controls +#define D3DSI_TEXLD_PROJECT (0x01 << D3DSP_OPCODESPECIFICCONTROL_SHIFT) +#define D3DSI_TEXLD_BIAS (0x02 << D3DSP_OPCODESPECIFICCONTROL_SHIFT) + +// Comparison for dynamic conditional instruction opcodes (i.e. if, breakc) +typedef enum _D3DSHADER_COMPARISON +{ + // < = > + D3DSPC_RESERVED0= 0, // 0 0 0 + D3DSPC_GT = 1, // 0 0 1 + D3DSPC_EQ = 2, // 0 1 0 + D3DSPC_GE = 3, // 0 1 1 + D3DSPC_LT = 4, // 1 0 0 + D3DSPC_NE = 5, // 1 0 1 + D3DSPC_LE = 6, // 1 1 0 + D3DSPC_RESERVED1= 7 // 1 1 1 +} D3DSHADER_COMPARISON; + +// Comparison is part of instruction opcode token: +#define D3DSHADER_COMPARISON_SHIFT D3DSP_OPCODESPECIFICCONTROL_SHIFT +#define D3DSHADER_COMPARISON_MASK (0x7<>8)&0xFF) +#define D3DSHADER_VERSION_MINOR(_Version) (((_Version)>>0)&0xFF) + +// destination/source parameter register type +#define D3DSI_COMMENTSIZE_SHIFT 16 +#define D3DSI_COMMENTSIZE_MASK 0x7FFF0000 +#define D3DSHADER_COMMENT(_DWordSize) \ + ((((_DWordSize)<= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* (DIRECT3D_VERSION >= 0x0900) */ +#endif /* _d3d9TYPES(P)_H_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmdt.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmdt.h new file mode 100644 index 0000000000000000000000000000000000000000..73eb984600a26468ce0b3d289bf90e55bb3ecef2 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmdt.h @@ -0,0 +1,2513 @@ +/******************************Module*Header**********************************\ +* +* Module Name: d3dkmdt.h +* +* Content: Longhorn Display Driver Model (LDDM) kernel mode +* data type definitions +* +* Copyright (c) 2004 Microsoft Corporation. All rights reserved. +\*****************************************************************************/ +#ifndef _D3DKMDT_H +#define _D3DKMDT_H + +#if !defined(_D3DKMDDI_H_) && \ + !defined(_D3DKMDDI_PEXT_H_) && \ + !defined(_DXGDMM_H_) && \ + !defined(_VIDPRIV_H_) && \ + !defined(_DISPMPRT_H_) && \ + !defined(_DMM_DIAG_H_) && \ + !defined(_D3DKMTHK_H_) + #error This header should not be included directly! +#endif + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma warning(push) +#pragma warning(disable:4201) // anonymous unions warning +#pragma warning(disable:4214) // nonstandard extension used: bit field types other than int + +// +// Available only for Vista (LONGHORN) and later and for +// multiplatform tools such as debugger extensions +// +#if (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +// +// Hardcoded overlay count +// +#define D3DKMDT_MAX_OVERLAYS_BITCOUNT 2 +#define D3DKMDT_MAX_OVERLAYS (1 << D3DKMDT_MAX_OVERLAYS_BITCOUNT) + + +//////////////////// VidPN management DDI handles ///////////////////////////////////////////////////////// +DECLARE_HANDLE(D3DKMDT_HVIDPN); +DECLARE_HANDLE(D3DKMDT_HVIDEOPRESENTSOURCESET); +DECLARE_HANDLE(D3DKMDT_HVIDEOPRESENTTARGETSET); +DECLARE_HANDLE(D3DKMDT_HVIDPNTOPOLOGY); +DECLARE_HANDLE(D3DKMDT_HVIDPNSOURCEMODESET); +DECLARE_HANDLE(D3DKMDT_HVIDPNTARGETMODESET); +DECLARE_HANDLE(D3DKMDT_HMONITORSOURCEMODESET); +DECLARE_HANDLE(D3DKMDT_HMONITORFREQUENCYRANGESET); +DECLARE_HANDLE(D3DKMDT_HMONITORDESCRIPTORSET); + +// Alias VOID* to make LDDM kernel mode interface prototypes using adapter handles self-explanatory. +typedef VOID* D3DKMDT_ADAPTER; + + + +//////////////////// VidPN management DDI constants ///////////////////////////////////////////////////////// + +// Special values representing that given variable has not been initialized to a valid value intended +// to catch development time errors. A valid parameter should never have this value. +#define D3DKMDT_DIMENSION_UNINITIALIZED (UINT)(~0) +#define D3DKMDT_FREQUENCY_UNINITIALIZED (UINT)(~0) + +// Special values representing that given parameter is not-specified. +// A parameter having this value should be ignored. +#define D3DKMDT_DIMENSION_NOTSPECIFIED (UINT)(~1) +#define D3DKMDT_FREQUENCY_NOTSPECIFIED (UINT)(~1) + + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video mode standard descriptor type, listing standards that are explicitly supported by Windows. +// +// Remarks: This enum specifies based on which standard the video signal timing parameters should be computed. +// Note that NTSC, PAL, and SECAM mode variants are treated as individual groups to avoid complicating +// the DDI with the notion of "sub-standard" (because they don't differ from each other in the parameters +// used to describe the video signal in the DDI and the parameters that they do differ in are of no +// interest to us in DMM). +// +typedef enum _D3DKMDT_VIDEO_SIGNAL_STANDARD +{ + D3DKMDT_VSS_UNINITIALIZED = 0, + + // VESA standards + D3DKMDT_VSS_VESA_DMT = 1, // See VESA Display Monitor Timings specification + D3DKMDT_VSS_VESA_GTF = 2, // See VESA Generalized Timing Formula standard + D3DKMDT_VSS_VESA_CVT = 3, // See VESA Coordinated Video Timings standard + + // De-facto standards + D3DKMDT_VSS_IBM = 4, + D3DKMDT_VSS_APPLE = 5, + + // Legacy STV standards W x H{i|p} @ ( VR / HR ) + D3DKMDT_VSS_NTSC_M = 6, // 720 x 525i @ (59.94 [Hz] / 15,734.27[Hz]) + D3DKMDT_VSS_NTSC_J = 7, // 720 x 525i @ (59.94 [Hz] / 15,734.27[Hz]) + D3DKMDT_VSS_NTSC_443 = 8, // 720 x 525i @ (59.94 [Hz] / 15,734.27[Hz]) + D3DKMDT_VSS_PAL_B = 9, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_B1 = 10, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_G = 11, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_H = 12, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_I = 13, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_D = 14, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_N = 15, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_NC = 16, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_B = 17, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_D = 18, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_G = 19, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_H = 20, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_K = 21, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_K1 = 22, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_L = 23, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_SECAM_L1 = 24, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + + // CEA/EIA standards + D3DKMDT_VSS_EIA_861 = 25, + D3DKMDT_VSS_EIA_861A = 26, + D3DKMDT_VSS_EIA_861B = 27, + + // More legacy STV standards + D3DKMDT_VSS_PAL_K = 28, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_K1 = 29, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_L = 30, // 720 x 625i @ (50 [Hz] / 15,625 [Hz]) + D3DKMDT_VSS_PAL_M = 31, // 720 x 525i @ (59.94 [Hz] / 15,734 [Hz]) + + D3DKMDT_VSS_OTHER = 255 +} +D3DKMDT_VIDEO_SIGNAL_STANDARD; + + + +//////////////////// Video present sources ////////////////////////////////////////////////////////////////// + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present source descriptor type. +// +typedef struct _D3DKMDT_VIDEO_PRESENT_SOURCE +{ + // Unique ID used to reference the respective video present source by the miniport and the OS. + D3DDDI_VIDEO_PRESENT_SOURCE_ID Id; + + // Other video present source descriptor properties go here. + DWORD dwReserved; +} +D3DKMDT_VIDEO_PRESENT_SOURCE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN source mode enumeration type descriptor type. +// +// Remarks: This type is used to specify whether a VidPN source mode is a graphics or a text mode +// (see VIDEO_PRESENT_SOURCE_MODE for more details). +// +typedef enum _D3DKMDT_VIDPN_SOURCE_MODE_TYPE +{ + D3DKMDT_RMT_UNINITIALIZED = 0, + D3DKMDT_RMT_GRAPHICS = 1, + D3DKMDT_RMT_TEXT = 2, + D3DKMDT_RMT_GRAPHICS_STEREO = 3, + D3DKMDT_RMT_GRAPHICS_STEREO_ADVANCED_SCAN = 4 +} +D3DKMDT_VIDPN_SOURCE_MODE_TYPE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Pixel value access mode descriptor type. +// +// Remarks: Use Direct to represent VidPN source modes with colors stored directly in the primary surface. +// Use PresetPalette to represent VidPN source modes with colors' indices stored in the primary +// surface and actual color values stored in a palette specific to the video card, that must +// be queried from the video miniport. +// Use SettablePalette to represent VidPN source modes with colors' indices stored in the primary +// surface and actual color values stored in a settable palette that can be dynamically set on +// the video card, by specifying it to the video miniport. +// +typedef enum _D3DKMDT_PIXEL_VALUE_ACCESS_MODE +{ + D3DKMDT_PVAM_UNINITIALIZED = 0, + D3DKMDT_PVAM_DIRECT = 1, + D3DKMDT_PVAM_PRESETPALETTE = 2, + D3DKMDT_PVAM_SETTABLEPALETTE = 3, +} +D3DKMDT_PIXEL_VALUE_ACCESS_MODE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Descriptor type of the color basis with respect to which the pixels' colors are expanded, +// or conversely, based on which the color values are synthesized. +// +// Remarks: The commonly used color bases in graphics industry are RGB, which has the basis (red, green, blue), +// as well as YPbPr and YCbCr, which have scaled variants of basis: +// (1, blue-1, red-1)*intensity(red,green,blue). +// Tri-stimulus linear RGB is well suited for real-time rendering, since most filtering algorithms +// use tri-stimulus values to approximate light's spectral transformations caused by its interaction +// with the environment, primarily due to the fact that there is a linear relationship between the +// perceived light level and the light's spectral intensity. Ideally, all processing of video content +// (i.e. scaling, filtering, etc) should be performed in a linear RGB space. +// Y'PbPr spaces store data using a nonlinear curve which is approximately the inverse of a gamma +// 2.2 curve (i.e. x^0.45). This allows more precision to be stored in darker intensities where the +// human eye is more sensitive. +// sRGB (more accurately, sR'G'B') stores light intensities relative to a gamma curve. +// scRGB stores linear values and requires much higher precision to represent the same perceptually +// similar signal. +// The light-intensity based YPbPr and YCbCr is better suited for persistence of pre-rendered content, +// such as video streaming. This is due to the fact that a human visual system is more responsive to +// small differences in photons' intensity rather than frequency (i.e. perceived color), and, hence, +// a light-intensity based color expansion over a finite dynamic range, yields a better perceptual +// image quality for the human eye than a tri-stimulus based color expansion in that same range +// (e.g non-linear Y8Cb8Cr8 appears slightly better than R8G8B8 and is comparable to R9G9B9). +// To represent monochrome modes, use Intensity. Grayscale imaging is heavily used in medical imaging. +// Note: the apostrophe notation Y'PbPr is used to remind you that you are working with non-linear data. +// +typedef enum _D3DKMDT_COLOR_BASIS +{ + D3DKMDT_CB_UNINITIALIZED = 0, + D3DKMDT_CB_INTENSITY = 1, + D3DKMDT_CB_SRGB = 2, + D3DKMDT_CB_SCRGB = 3, + D3DKMDT_CB_YCBCR = 4, + D3DKMDT_CB_YPBPR = 5, +} +D3DKMDT_COLOR_BASIS; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Descriptor type of the color coefficients dynamic range, whose linear combination with the +// respective color basis produces final pixel values. +// +// Remarks: Examples include (5,6,5,0) for R5G6B5, (8,8,8,8) for R8G8B8A8, and (24, 0, 0, 0) for 24-bit +// grayscale pixel encoding format. +// NOTE: Currently this is only used for target modes, none of which has the 4th channel (e.g. alpha). +// We are keeping the 4th field for extensibility purpose to avoid miniport interface revision +// if 4-channel video interfaces became available between display adapter and monitor. +// +typedef struct _D3DKMDT_COLOR_COEFF_DYNAMIC_RANGES +{ + UINT FirstChannel; + UINT SecondChannel; + UINT ThirdChannel; + UINT FourthChannel; +} +D3DKMDT_COLOR_COEFF_DYNAMIC_RANGES; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: 2D region descriptor type. +// +// Remarks: We define our own rather than reusing SIZE type to avoid dependency on SDK headers. +// +typedef struct _D3DKMDT_2DREGION +{ + UINT cx; + UINT cy; +} +D3DKMDT_2DREGION; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: 2D offset descriptor type. +// +// Remarks: We define our own rather than reusing SIZE type to avoid dependency on SDK headers. +// +typedef D3DKMDT_2DREGION D3DKMDT_2DOFFSET; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Graphics video present source mode descriptor type. +// +// Remarks: Graphics video present source mode is the dominantly used subtype of the video present source +// modes (other being the text video present source mode). +// Note that whenever video present source mode's visible size, +// VIDEO_PRESENT_SOURCE_MODE.GRAPHICS_RENDERING_FORMAT.sizeVisible is not equal to the respective +// video mode's visible size, VIDEO_PRESENT_TARGET_MODE.sizeVisible, h/w scaling is undertaken by +// the video output codec. +// +// Miniport is free to support any D3D pixel format for its graphics modes that is meaningful +// as a primary surface pixel format. +// +typedef struct _D3DKMDT_GRAPHICS_RENDERING_FORMAT +{ + // Size of the primary surface required for this VidPN source mode. + D3DKMDT_2DREGION PrimSurfSize; + + // Size of the visible part of the primary surface, used for panned modes including zoom modes. + // The visible region size is required to be the same as the primary surface + D3DKMDT_2DREGION VisibleRegionSize; + + // Number of bytes between the start of one scan line and the next. + DWORD Stride; + + // Pixel format type + D3DDDIFORMAT PixelFormat; + + // Color basis with respect to which rendering client encodes pixel values. + D3DKMDT_COLOR_BASIS ColorBasis; + + // Access mode for the pixel value information. + D3DKMDT_PIXEL_VALUE_ACCESS_MODE PixelValueAccessMode; +} +D3DKMDT_GRAPHICS_RENDERING_FORMAT; + + +typedef enum _D3DKMDT_TEXT_RENDERING_FORMAT +{ + D3DKMDT_TRF_UNINITIALIZED = 0 +} +D3DKMDT_TEXT_RENDERING_FORMAT; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present source mode ID type. +typedef UINT D3DKMDT_VIDEO_PRESENT_SOURCE_MODE_ID; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN source mode descriptor type. +// +// Remarks: VidPN source (rendering) mode is the mode of operation of a given video present source and determines +// the format of this source's primary surface to which the graphics subsystem is rendering +// the visual image to be presented to the user, and from which the video output codec is reading +// the visual image content to be converted into a respective video mode signal. +// +typedef struct _D3DKMDT_VIDPN_SOURCE_MODE +{ + D3DKMDT_VIDEO_PRESENT_SOURCE_MODE_ID Id; + + // Specifies whether the mode is a graphics or a text rendering mode. + D3DKMDT_VIDPN_SOURCE_MODE_TYPE Type; + + union + { + // Descriptor of the graphics rendering mode (valid only if Type==D3DKMDT_RMT_GRAPHICS). + D3DKMDT_GRAPHICS_RENDERING_FORMAT Graphics; + + // Descriptor of the text rendering mode (valid only if Type==D3DKMDT_RMT_TEXT). + D3DKMDT_TEXT_RENDERING_FORMAT Text; + } + Format; +} +D3DKMDT_VIDPN_SOURCE_MODE; + + + +//////////////////////// Video present targets/////////////////////////////////////////////////////////////// + + +// NOTE: Child device (e.g. video output) HPD awareness is used to represent the level of external +// device (e.g. monitor) connectivity sensed by a display adapter. Child device can either be +// always connected to an external device (e.g. integrated LCD in a mobile system) or have: +// 1. No HPD-awareness iff miniport is *not* aware of external device arrivals/departures +// whether through interrupts or polling, +// 2. Polled HPD-awareness iff miniport can not asynchronously notify the OS about external +// device arrivals/departures, but OS can sporadically poll for its presence, and of a +// monitor, causing visual artifacts on each poll. +// 3. Interruptible HPD-awareness iff miniport can asynchronously notify the OS about +// external device arrivals/departures. +typedef enum _DXGK_CHILD_DEVICE_HPD_AWARENESS { + HpdAwarenessUninitialized = 0, + HpdAwarenessAlwaysConnected = 1, + HpdAwarenessNone = 2, + HpdAwarenessPolled = 3, + HpdAwarenessInterruptible = 4 +} DXGK_CHILD_DEVICE_HPD_AWARENESS, *PDXGK_CHILD_DEVICE_HPD_AWARENESS; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor orientation descriptor type. +// +typedef enum _D3DKMDT_MONITOR_ORIENTATION +{ + D3DKMDT_MO_UNINITIALIZED = 0, + D3DKMDT_MO_0DEG = 1, + D3DKMDT_MO_90DEG = 2, + D3DKMDT_MO_180DEG = 3, + D3DKMDT_MO_270DEG = 4 +} +D3DKMDT_MONITOR_ORIENTATION; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video output technology descriptor type. +// +// Remarks: Video output technology is used to determine the hard-coded list of video modes supported +// by the monitor, when monitor descriptor is not available. +// +typedef enum _D3DKMDT_VIDEO_OUTPUT_TECHNOLOGY +{ + D3DKMDT_VOT_UNINITIALIZED = -2, + D3DKMDT_VOT_OTHER = -1, + D3DKMDT_VOT_HD15 = 0, + D3DKMDT_VOT_SVIDEO = 1, + D3DKMDT_VOT_COMPOSITE_VIDEO = 2, + D3DKMDT_VOT_COMPONENT_VIDEO = 3, + D3DKMDT_VOT_DVI = 4, + D3DKMDT_VOT_HDMI = 5, + D3DKMDT_VOT_LVDS = 6, + D3DKMDT_VOT_D_JPN = 8, + D3DKMDT_VOT_SDI = 9, + D3DKMDT_VOT_DISPLAYPORT_EXTERNAL = 10, + D3DKMDT_VOT_DISPLAYPORT_EMBEDDED = 11, + D3DKMDT_VOT_UDI_EXTERNAL = 12, + D3DKMDT_VOT_UDI_EMBEDDED = 13, + D3DKMDT_VOT_SDTVDONGLE = 14, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_M1) + D3DKMDT_VOT_MIRACAST = 15, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMDT_VOT_INDIRECT_WIRED = 16, +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_M1) + D3DKMDT_VOT_INTERNAL = 0x80000000, + + // Remove when DDI is unlocked. + D3DKMDT_VOT_SVIDEO_4PIN = D3DKMDT_VOT_SVIDEO, + D3DKMDT_VOT_SVIDEO_7PIN = D3DKMDT_VOT_SVIDEO, + D3DKMDT_VOT_RF = D3DKMDT_VOT_COMPOSITE_VIDEO, + D3DKMDT_VOT_RCA_3COMPONENT = D3DKMDT_VOT_COMPONENT_VIDEO, + D3DKMDT_VOT_BNC = D3DKMDT_VOT_COMPONENT_VIDEO, +} +D3DKMDT_VIDEO_OUTPUT_TECHNOLOGY; + +typedef enum _DXGKMDT_OPM_CONNECTOR_TYPE +{ + DXGKMDT_OPM_CONNECTOR_TYPE_OTHER = -1, + DXGKMDT_OPM_CONNECTOR_TYPE_HD15 = 0, + DXGKMDT_OPM_CONNECTOR_TYPE_SVIDEO = 1, + DXGKMDT_OPM_CONNECTOR_TYPE_COMPOSITE_VIDEO = 2, + DXGKMDT_OPM_CONNECTOR_TYPE_COMPONENT_VIDEO = 3, + DXGKMDT_OPM_CONNECTOR_TYPE_DVI = 4, + DXGKMDT_OPM_CONNECTOR_TYPE_HDMI = 5, + DXGKMDT_OPM_CONNECTOR_TYPE_LVDS = 6, + DXGKMDT_OPM_CONNECTOR_TYPE_D_JPN = 8, + DXGKMDT_OPM_CONNECTOR_TYPE_SDI = 9, + DXGKMDT_OPM_CONNECTOR_TYPE_DISPLAYPORT_EXTERNAL = 10, + DXGKMDT_OPM_CONNECTOR_TYPE_DISPLAYPORT_EMBEDDED = 11, + DXGKMDT_OPM_CONNECTOR_TYPE_UDI_EXTERNAL = 12, + DXGKMDT_OPM_CONNECTOR_TYPE_UDI_EMBEDDED = 13, + DXGKMDT_OPM_CONNECTOR_TYPE_RESERVED = 14, + DXGKMDT_OPM_CONNECTOR_TYPE_MIRACAST = 15, + DXGKMDT_OPM_CONNECTOR_TYPE_TRANSPORT_AGNOSTIC_DIGITAL_MODE_A = 16, + DXGKMDT_OPM_CONNECTOR_TYPE_TRANSPORT_AGNOSTIC_DIGITAL_MODE_B = 17, + DXGKMDT_OPM_COPP_COMPATIBLE_CONNECTOR_TYPE_INTERNAL = 0x80000000 +} DXGKMDT_OPM_CONNECTOR_TYPE; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor orientation awareness descriptor type. +// +typedef enum _D3DKMDT_MONITOR_ORIENTATION_AWARENESS +{ + D3DKMDT_MOA_UNINITIALIZED = 0, + D3DKMDT_MOA_NONE = 1, + D3DKMDT_MOA_POLLED = 2, + D3DKMDT_MOA_INTERRUPTIBLE = 3 +} +D3DKMDT_MONITOR_ORIENTATION_AWARENESS; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target descriptor type. +// +typedef struct _D3DKMDT_VIDEO_PRESENT_TARGET +{ + // Unique ID used to reference the respective video present target by the miniport and the OS. + D3DDDI_VIDEO_PRESENT_TARGET_ID Id; + + // Type of the video output technology (see D3DKMDT_VIDEO_OUTPUT_TECHNOLOGY for more details). + D3DKMDT_VIDEO_OUTPUT_TECHNOLOGY VideoOutputTechnology; + + // Type of the video output's HPD awareness (see D3DKMDT_VIDEO_OUTPUT_HPD_AWARENESS for more details). + DXGK_CHILD_DEVICE_HPD_AWARENESS VideoOutputHpdAwareness; + + D3DKMDT_MONITOR_ORIENTATION_AWARENESS MonitorOrientationAwareness; + + // NOTE: On monitor arrival, OS will leave monitor mode set empty for monitors connected to video outputs + // supporting SDTV modes, expecting miniport to populate modes it wants to expose for that monitor. + // + // NOTE: This predicate is also used when selecting video output for presentation on a TV via + // APIs that don't support explicit specification of monitors/video outputs (e.g. VIDEOPARAMETERS). + // + // Predicate specifying whether corresponding video output supports SDTV modes. + BOOLEAN SupportsSdtvModes; +} +D3DKMDT_VIDEO_PRESENT_TARGET; + + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode GTF compliance descriptor type. +typedef enum _D3DKMDT_GTFCOMPLIANCE +{ + D3DKMDT_GTF_UNINITIALIZED = 0, + D3DKMDT_GTF_COMPLIANT = 1, + D3DKMDT_GTF_NOTCOMPLIANT = 2 +} +D3DKMDT_GTFCOMPLIANCE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN target mode preference descriptor type. + +typedef enum _D3DKMDT_MODE_PREFERENCE +{ + D3DKMDT_MP_UNINITIALIZED = 0, + D3DKMDT_MP_PREFERRED = 1, + D3DKMDT_MP_NOTPREFERRED = 2, +} +D3DKMDT_MODE_PREFERENCE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video signal info descriptor type. +// +// Remarks: Video signal info is the mode of operation of a given video output that's driving a connected +// moitor and is driven by an internal video output codec. +// Note that this descriptor supersedes subset of the XDDM's VIDEO_MODE_INFORMATION structure +// related to video mode. In XDDM, both video and rendering modes were described in this struct. +// LDDM separates these two notions, and hence their descriptors. +// The video standard field, vidStandard, should be used for video mode comparisons, when it's +// set to a well-defined video standard. Note that most of the standard modes do not comply with +// the VESA GTF frequency constraints. +// +// If color basis of the target mode does not correspond to that of the source mode, appropriate +// color conversion is performed by the respective video output codec. +// +typedef struct _D3DKMDT_VIDEO_SIGNAL_INFO +{ + // Video mode standard this mode is defined by (if any). + D3DKMDT_VIDEO_SIGNAL_STANDARD VideoStandard; + + // Video signal's size in pixels (i.e. HTotal & VTotal). + D3DKMDT_2DREGION TotalSize; + + // Presented image's size in active pixels (i.e. HActive & VActive). + D3DKMDT_2DREGION ActiveSize; + + // Vertical refresh frequency (in Hz). + D3DDDI_RATIONAL VSyncFreq; + + // Horizontal refresh frequency (in Hz). + D3DDDI_RATIONAL HSyncFreq; + + // Pixel clock rate (in Hz). + SIZE_T PixelRate; + + union + { +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_M1) + struct + { + // Scan line ordering (e.g. progressive, interlaced). + D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING ScanLineOrdering : 3; + + // Vertical refresh frequency divider + UINT VSyncFreqDivider : 6; + + UINT Reserved : 23; + + } AdditionalSignalInfo; +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3_M1 + + // Scan line ordering (e.g. progressive, interlaced). + D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING ScanLineOrdering; + }; +} +D3DKMDT_VIDEO_SIGNAL_INFO; + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#define D3DKMDT_BITS_PER_COMPONENT_06 0x01 +#define D3DKMDT_BITS_PER_COMPONENT_08 0x02 +#define D3DKMDT_BITS_PER_COMPONENT_10 0x04 +#define D3DKMDT_BITS_PER_COMPONENT_12 0x08 +#define D3DKMDT_BITS_PER_COMPONENT_14 0x10 +#define D3DKMDT_BITS_PER_COMPONENT_16 0x20 + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode ID type. +typedef UINT D3DKMDT_VIDEO_PRESENT_TARGET_MODE_ID; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Describe bit-fields for wire format and preference +// In the D3DKMDT_VIDPN_TARGET_MODE structure all fields are valid and the wire format fields indicate +// supported bit depts per color encoding format. +// In the DXGK_SET_TIMING_PATH_INFO structure the Preference field is unused so should be ignored by the +// driver and will be set to zero by the OS in case of future usage. The wire format fields are used to +// indicate which wire format has been selected so only one bit across the five fields will be set. +// + +typedef union _D3DKMDT_WIRE_FORMAT_AND_PREFERENCE +{ + struct + { + D3DKMDT_MODE_PREFERENCE Preference : 2; + + // Flags indicating supported formats of color components transmitted between source and target + UINT Rgb : 6; + UINT YCbCr444 : 6; + UINT YCbCr422 : 6; + UINT YCbCr420 : 6; + UINT Intensity : 6; + }; + UINT Value; +} D3DKMDT_WIRE_FORMAT_AND_PREFERENCE, *PD3DKMDT_WIRE_FORMAT_AND_PREFERENCE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode descriptor type. +typedef struct _D3DKMDT_VIDPN_TARGET_MODE +{ + // Identifier unique within the set this mode is part of. + D3DKMDT_VIDEO_PRESENT_TARGET_MODE_ID Id; + + // Video signal parameters. + D3DKMDT_VIDEO_SIGNAL_INFO VideoSignalInfo; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + union + { + D3DKMDT_WIRE_FORMAT_AND_PREFERENCE WireFormatAndPreference; + struct + { + D3DKMDT_MODE_PREFERENCE Preference : 2; + UINT :30; + }; + }; +#else + // Predicate specifying whether this mode is preferred by the adapter given the mode pinned on + // the source of the respective present path. + D3DKMDT_MODE_PREFERENCE Preference; +#endif // (DXGKDDI_INTERFACE_VERSION < DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + + D3DDDI_RATIONAL MinimumVSyncFreq; + +#endif // (DXGKDDI_INTERFACE_VERSION < DXGKDDI_INTERFACE_VERSION_WDDM2_9) + +} +D3DKMDT_VIDPN_TARGET_MODE; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VESA Display ID detailed timing type I. + +#pragma pack(push, 1) +#define DISPLAYID_DETAILED_TIMING_TYPE_I_SIZE 20 + +// Enum specifying monitor's aspect ratio (see DISPLAYID_DETAILED_TIMING_TYPE_I.AspectRatio) +enum _DISPLAYID_DETAILED_TIMING_TYPE_I_ASPECT_RATIO +{ + DIDDT1_AspectRatio_1x1 = 0, // 000 = 1:1 + DIDDT1_AspectRatio_5x4 = 1, // 001 = 5:4 + DIDDT1_AspectRatio_4x3 = 2, // 010 = 4:3 + DIDDT1_AspectRatio_15x9 = 3, // 011 = 15:9 + DIDDT1_AspectRatio_16x9 = 4, // 100 = 16:9 + DIDDT1_AspectRatio_16x10 = 5, // 101 = 16:10 +}; + +enum _DISPLAYID_DETAILED_TIMING_TYPE_I_SCANNING_MODE +{ + DIDDT1_Progressive = 0, // 0 = Progressive mode + DIDDT1_Interlaced = 1, // 1 = Interlaced mode +}; + +enum _DISPLAYID_DETAILED_TIMING_TYPE_I_STEREO_MODE +{ + DIDDT1_Monoscopic = 0, // 00 = Monoscopic (no stereo) mode + DIDDT1_Stereo = 1, // 01 = Stereo mode + DIDDT1_Dependent = 2, // 10 = Stereo mode despends on user action +}; + +enum _DISPLAYID_DETAILED_TIMING_TYPE_I_SYNC_POLARITY +{ + DIDDT1_Sync_Positive = 0, + DIDDT1_Sync_Negative = 1, +}; + +typedef struct _DISPLAYID_DETAILED_TIMING_TYPE_I +{ + struct + { + ULONG PixelClock : 24; // Pixel clock / 10000 + ULONG AspectRatio : 3; // Aspect ratio + ULONG Reserved : 1; + ULONG ScanningType : 1; // Frame scanning type + ULONG StereoMode : 2; // 3D stereo mode + ULONG PreferredTiming : 1; // preferred timing + }; + + USHORT HorizontalActivePixels; // Horizontal active image pixel number + USHORT HorizontalBlankPixels; // Horizontal blank pixel number + struct + { + USHORT HorizontalFrontPorch : 15; // Horizontal offset (front porch) pixel number + USHORT HorizontalSyncPolarity : 1; // Horizontal sync polarity + }; + USHORT HorizontalSyncWidth; // Horizontal sync pixel number + + USHORT VerticalActiveLines; // Number of lines of vertical active image + USHORT VerticalBlankLines; // Number of lines of vertical blank + struct + { + USHORT VerticalFrontPorch : 15; // Number of lines of vertical offset (front porch) + USHORT VerticalSyncPolarity : 1; // Vertical sync polarity + }; + USHORT VerticalSyncWidth; // Number of lines of vertical sync +}DISPLAYID_DETAILED_TIMING_TYPE_I; + +C_ASSERT(sizeof(DISPLAYID_DETAILED_TIMING_TYPE_I) == DISPLAYID_DETAILED_TIMING_TYPE_I_SIZE); + +#pragma pack(pop) + +typedef struct _DXGK_TARGETMODE_DETAIL_TIMING +{ + // Video standard this detail timing comes from. + D3DKMDT_VIDEO_SIGNAL_STANDARD VideoStandard; + + // ID of this detail timing in VideoStandard. + UINT TimingId; + + // Detail timing. + DISPLAYID_DETAILED_TIMING_TYPE_I DetailTiming; +}DXGK_TARGETMODE_DETAIL_TIMING; + + +// Structure of hardware capability +typedef struct _D3DKMDT_VIDPN_HW_CAPABILITY +{ + UINT DriverRotation : 1; + UINT DriverScaling : 1; + UINT DriverCloning : 1; + UINT DriverColorConvert : 1; + UINT DriverLinkedAdapaterOutput : 1; + UINT DriverRemoteDisplay : 1; + UINT Reserved : 26; +} +D3DKMDT_VIDPN_HW_CAPABILITY; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode ID type. +typedef UINT D3DKMDT_MONITOR_SOURCE_MODE_ID; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor capability origin type. +typedef enum _D3DKMDT_MONITOR_CAPABILITIES_ORIGIN +{ + D3DKMDT_MCO_UNINITIALIZED = 0, // mode information is coming from the: + D3DKMDT_MCO_DEFAULTMONITORPROFILE = 1, // + default monitor profile. + D3DKMDT_MCO_MONITORDESCRIPTOR = 2, // + monitor's descriptor. + D3DKMDT_MCO_MONITORDESCRIPTOR_REGISTRYOVERRIDE = 3, // + registry override of the monitor descriptor. + D3DKMDT_MCO_SPECIFICCAP_REGISTRYOVERRIDE = 4, // + registry override of a specific capability. + D3DKMDT_MCO_DRIVER = 5, // + display adapter driver. +} +D3DKMDT_MONITOR_CAPABILITIES_ORIGIN; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor timing type. +typedef enum _D3DKMDT_MONITOR_TIMING_TYPE +{ + D3DKMDT_MTT_UNINITIALIZED = 0, // mode timing information is coming from: + D3DKMDT_MTT_ESTABLISHED = 1, // + established timings block. + D3DKMDT_MTT_STANDARD = 2, // + standard timings block. + D3DKMDT_MTT_EXTRASTANDARD = 3, // + extra standard timings block. + D3DKMDT_MTT_DETAILED = 4, // + detailed timings block. + D3DKMDT_MTT_DEFAULTMONITORPROFILE = 5, // + default monitor profile. + D3DKMDT_MTT_DRIVER = 6, // + display adapter driver. +} +D3DKMDT_MONITOR_TIMING_TYPE; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode descriptor type. +typedef struct _D3DKMDT_MONITOR_SOURCE_MODE +{ + // Identifier unique within the set this mode is part of. + D3DKMDT_MONITOR_SOURCE_MODE_ID Id; + + // Video signal parameters. + D3DKMDT_VIDEO_SIGNAL_INFO VideoSignalInfo; + + // Color basis with respect to which monitor is presenting the pixels sampled from the video signal. + D3DKMDT_COLOR_BASIS ColorBasis; + + // Supported dynamic range of each of the pixel color component coefficients by the monitor's + // presentational technology - e.g. for a DFP LCD with 12-bit bit-depth, this will be (4, 4, 4, 0). + // A TV supporting 10-bit per component YCbCr this will be (10, 10, 10, 0) regardless of chroma compression. + D3DKMDT_COLOR_COEFF_DYNAMIC_RANGES ColorCoeffDynamicRanges; + + // Origins of the monitor source mode information. + D3DKMDT_MONITOR_CAPABILITIES_ORIGIN Origin; + + // Predicate specifying whether this mode is preferred by the monitor connected to the respective video output. + D3DKMDT_MODE_PREFERENCE Preference; +} +D3DKMDT_MONITOR_SOURCE_MODE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Frequency range type. +typedef struct _D3DKMDT_FREQUENCY_RANGE +{ + // Minimum vertical refresh frequency (in Hz) supported by the monitor. + D3DDDI_RATIONAL MinVSyncFreq; + + // Maximum vertical refresh frequency (in Hz) supported by the monitor. + D3DDDI_RATIONAL MaxVSyncFreq; + + // Minimum horizontal refresh frequency (in Hz) supported by the monitor. + D3DDDI_RATIONAL MinHSyncFreq; + + // Maximum horizontal refresh frequency (in Hz) supported by the monitor. + D3DDDI_RATIONAL MaxHSyncFreq; +} +D3DKMDT_FREQUENCY_RANGE; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor frequency range constraint type. +typedef enum _D3DKMDT_MONITOR_FREQUENCY_RANGE_CONSTRAINT +{ + D3DKMDT_MFRC_UNINITIALIZED = 0, + D3DKMDT_MFRC_ACTIVESIZE = 1, + D3DKMDT_MFRC_MAXPIXELRATE = 2 +} +D3DKMDT_MONITOR_FREQUENCY_RANGE_CONSTRAINT; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Monitor frequency range type. +typedef struct _D3DKMDT_MONITOR_FREQUENCY_RANGE +{ + // Origins of the monitor frequency range information. + D3DKMDT_MONITOR_CAPABILITIES_ORIGIN Origin; + + // Frequency range limits. + D3DKMDT_FREQUENCY_RANGE RangeLimits; + + // Type of the frequency range constraint. + D3DKMDT_MONITOR_FREQUENCY_RANGE_CONSTRAINT ConstraintType; + + // Constraint under which this frequency range is supported. + union + { + // Active region size this frequency range applies to. + D3DKMDT_2DREGION ActiveSize; + + // Maximum pixel clock rate (in Hz) to which this pixel rate applies. + SIZE_T MaxPixelRate; + + } Constraint; +} +D3DKMDT_MONITOR_FREQUENCY_RANGE; + + + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// VidPN present paths + +// VidPN present path index used during enumeration of paths satisfying certain criteria +// (e.g. originating from the same source). +typedef SIZE_T D3DKMDT_VIDPN_PRESENT_PATH_INDEX; + +// Purpose: VidPN present path scaling type. +typedef enum _D3DKMDT_VIDPN_PRESENT_PATH_SCALING +{ + D3DKMDT_VPPS_UNINITIALIZED = 0, + + // For the following transformation, spatial resolutions must be equal on both the source and the target. + + // Source content is not modified in any way. + D3DKMDT_VPPS_IDENTITY = 1, + + // For the following three transformations, spatial resolution of the source differs from that of the target. + + // Source content is centered on the target. + D3DKMDT_VPPS_CENTERED = 2, + + // Source content is scaled to fit the target, no aspect ratio preserving. + D3DKMDT_VPPS_STRETCHED = 3, + + // Source content is scaled to fit the target. Aspect ratio preserving. + D3DKMDT_VPPS_ASPECTRATIOCENTEREDMAX = 4, + + // Scaling that cannot be described by any other D3DKMDT_VPPS_XXX value + D3DKMDT_VPPS_CUSTOM = 5, + + + // Reserved for internal OS use + D3DKMDT_VPPS_RESERVED1 = 253, + + // Source content scaling mode is not pinned. + D3DKMDT_VPPS_UNPINNED = 254, + + // OS does not specify the scaling mode, and miniport should decide based on its own settings. + D3DKMDT_VPPS_NOTSPECIFIED = 255 +} +D3DKMDT_VIDPN_PRESENT_PATH_SCALING; + + +// Purpose: VidPN present path rotation type. +typedef enum _D3DKMDT_VIDPN_PRESENT_PATH_ROTATION +{ + D3DKMDT_VPPR_UNINITIALIZED = 0, + + // Source content is not modified in any way. + D3DKMDT_VPPR_IDENTITY = 1, + + // Source content is rotated 90 degrees. + D3DKMDT_VPPR_ROTATE90 = 2, + + // Source content is rotated 180 degrees. + D3DKMDT_VPPR_ROTATE180 = 3, + + // Source content is rotated 270 degrees. + D3DKMDT_VPPR_ROTATE270 = 4, + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) + // Source content is not modified in any way. Driver should rotate this content an extra 90 degrees. + D3DKMDT_VPPR_IDENTITY_OFFSET90 = 5, + + // Source content is rotated 90 degrees. Driver should rotate this content an extra 90 degrees. + D3DKMDT_VPPR_ROTATE90_OFFSET90 = 6, + + // Source content is rotated 180 degrees. Driver should rotate this content an extra 90 degrees. + D3DKMDT_VPPR_ROTATE180_OFFSET90 = 7, + + // Source content is rotated 270 degrees. Driver should rotate this content an extra 90 degrees. + D3DKMDT_VPPR_ROTATE270_OFFSET90 = 8, + + // Source content is not modified in any way. Driver should rotate this content an extra 180 degrees. + D3DKMDT_VPPR_IDENTITY_OFFSET180 = 9, + + // Source content is rotated 90 degrees. Driver should rotate this content an extra 180 degrees. + D3DKMDT_VPPR_ROTATE90_OFFSET180 = 10, + + // Source content is rotated 180 degrees. Driver should rotate this content an extra 180 degrees. + D3DKMDT_VPPR_ROTATE180_OFFSET180 = 11, + + // Source content is rotated 270 degrees. Driver should rotate this content an extra 180 degrees. + D3DKMDT_VPPR_ROTATE270_OFFSET180 = 12, + + // Source content is not modified in any way. Driver should rotate this content an extra 270 degrees. + D3DKMDT_VPPR_IDENTITY_OFFSET270 = 13, + + // Source content is rotated 90 degrees. Driver should rotate this content an extra 270 degrees. + D3DKMDT_VPPR_ROTATE90_OFFSET270 = 14, + + // Source content is rotated 180 degrees. Driver should rotate this content an extra 270 degrees. + D3DKMDT_VPPR_ROTATE180_OFFSET270 = 15, + + // Source content is rotated 270 degrees. Driver should rotate this content an extra 270 degrees. + D3DKMDT_VPPR_ROTATE270_OFFSET270 = 16, +#endif // DXGKDDI_INTERFACE_VERSION + + // Source content rotation setting is not pinned. + D3DKMDT_VPPR_UNPINNED = 254, + + // OS does not specify the rotation mode, and miniport should decide based on its own settings. + D3DKMDT_VPPR_NOTSPECIFIED = 255 +} +D3DKMDT_VIDPN_PRESENT_PATH_ROTATION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) + +__inline +D3DKMDT_VIDPN_PRESENT_PATH_ROTATION D3DKMDT_VPPR_GET_OFFSET_ROTATION(D3DKMDT_VIDPN_PRESENT_PATH_ROTATION Rotation) +{ + if ((Rotation >= D3DKMDT_VPPR_IDENTITY) && + (Rotation <= D3DKMDT_VPPR_ROTATE270_OFFSET270)) + { + Rotation = (D3DKMDT_VIDPN_PRESENT_PATH_ROTATION)(((Rotation - 1) / 4) + 1); + } + return Rotation; +} + +__inline +D3DKMDT_VIDPN_PRESENT_PATH_ROTATION D3DKMDT_VPPR_GET_CONTENT_ROTATION_PART(D3DKMDT_VIDPN_PRESENT_PATH_ROTATION Rotation) +{ + if ((Rotation >= D3DKMDT_VPPR_IDENTITY_OFFSET90) && + (Rotation <= D3DKMDT_VPPR_ROTATE270_OFFSET270)) + { + Rotation = (D3DKMDT_VIDPN_PRESENT_PATH_ROTATION)(((Rotation - 1) % 4) + 1); + } + return Rotation; +} + +__inline +D3DKMDT_VIDPN_PRESENT_PATH_ROTATION D3DKMDT_VPPR_GET_CONTENT_ROTATION(D3DKMDT_VIDPN_PRESENT_PATH_ROTATION Rotation) +{ + if ((Rotation >= D3DKMDT_VPPR_IDENTITY_OFFSET90) && + (Rotation <= D3DKMDT_VPPR_ROTATE270_OFFSET270)) + { + D3DKMDT_VIDPN_PRESENT_PATH_ROTATION ContentPart = D3DKMDT_VPPR_GET_CONTENT_ROTATION_PART(Rotation); + D3DKMDT_VIDPN_PRESENT_PATH_ROTATION OffsetPart = D3DKMDT_VPPR_GET_OFFSET_ROTATION(Rotation); + Rotation = (D3DKMDT_VIDPN_PRESENT_PATH_ROTATION)((((ContentPart - 1) + (OffsetPart - 1)) % 4) + 1); + } + return Rotation; +} +#endif // DXGKDDI_INTERFACE_VERSION + + +#define D3DKMDT_SCALING_SUPPORT_MASK 0x1f; + +// Purpose: Specifies what scaling modes are supported given current path configuration. +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH_SCALING_SUPPORT +{ + UINT Identity : 1; + UINT Centered : 1; + UINT Stretched : 1; + UINT AspectRatioCenteredMax : 1; + UINT Custom : 1; +} D3DKMDT_VIDPN_PRESENT_PATH_SCALING_SUPPORT; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) +#define D3DKMDT_ROTATION_SUPPORT_MASK 0xff; +#else +#define D3DKMDT_ROTATION_SUPPORT_MASK 0xf; +#endif // DXGKDDI_INTERFACE_VERSION + +// Purpose: Specifies what rotation modes are supported given current path configuration. +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH_ROTATION_SUPPORT +{ + UINT Identity : 1; + UINT Rotate90 : 1; + UINT Rotate180 : 1; + UINT Rotate270 : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) + UINT Offset0 : 1; + UINT Offset90 : 1; + UINT Offset180 : 1; + UINT Offset270 : 1; +#endif // DXGKDDI_INTERFACE_VERSION +} D3DKMDT_VIDPN_PRESENT_PATH_ROTATION_SUPPORT; + +// Purpose: Combines all the transformation related fields into one structure. +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH_TRANSFORMATION +{ + // Scaling applied to the content presented on this video present path. + D3DKMDT_VIDPN_PRESENT_PATH_SCALING Scaling; + + // Scaling support given the currently pinned modes. + D3DKMDT_VIDPN_PRESENT_PATH_SCALING_SUPPORT ScalingSupport; + + // Rotation applied to the content presented on this video present path. + D3DKMDT_VIDPN_PRESENT_PATH_ROTATION Rotation; + + // Rotation support given the currently pinned modes. + D3DKMDT_VIDPN_PRESENT_PATH_ROTATION_SUPPORT RotationSupport; +} D3DKMDT_VIDPN_PRESENT_PATH_TRANSFORMATION; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN present path importance ordinal type. +// +// Note: Higher order importance ordinals can be used (upto 255), but only the first 10 have been explicitly named. +// +typedef enum _D3DKMDT_VIDPN_PRESENT_PATH_IMPORTANCE +{ + D3DKMDT_VPPI_UNINITIALIZED = 0, + D3DKMDT_VPPI_PRIMARY = 1, + D3DKMDT_VPPI_SECONDARY = 2, + D3DKMDT_VPPI_TERTIARY = 3, + D3DKMDT_VPPI_QUATERNARY = 4, + D3DKMDT_VPPI_QUINARY = 5, + D3DKMDT_VPPI_SENARY = 6, + D3DKMDT_VPPI_SEPTENARY = 7, + D3DKMDT_VPPI_OCTONARY = 8, + D3DKMDT_VPPI_NONARY = 9, + D3DKMDT_VPPI_DENARY = 10, +} +D3DKMDT_VIDPN_PRESENT_PATH_IMPORTANCE; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN present path content ordinal type. +// +// Indicates whether the content being displayed is video or graphics. +// +typedef enum _D3DKMDT_VIDPN_PRESENT_PATH_CONTENT +{ + D3DKMDT_VPPC_UNINITIALIZED = 0, + + // Miniport should optimize presentation of the present path for graphics content. + D3DKMDT_VPPC_GRAPHICS = 1, + + // Miniport should optimize presentation of the present path for video content. + D3DKMDT_VPPC_VIDEO = 2, + + // OS does not specify the content type, and miniport should decide based on its own settings. + D3DKMDT_VPPC_NOTSPECIFIED = 255 +} +D3DKMDT_VIDPN_PRESENT_PATH_CONTENT; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN present path macrovision information. +// +// Contains macrovision caps and controls. +// +typedef enum _D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_TYPE +{ + D3DKMDT_VPPMT_UNINITIALIZED = 0, + + D3DKMDT_VPPMT_NOPROTECTION = 1, + + D3DKMDT_VPPMT_MACROVISION_APSTRIGGER = 2, + + D3DKMDT_VPPMT_MACROVISION_FULLSUPPORT = 3, + +} +D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_TYPE; + +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_SUPPORT +{ + UINT NoProtection : 1; + UINT MacroVisionApsTrigger : 1; + UINT MacroVisionFull : 1; + UINT Reserved : 29; +} +D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_SUPPORT; + +#define D3DKMDT_MACROVISION_OEMCOPYPROTECTION_SIZE 256 + +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION +{ + // Macrovision controls. + D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_TYPE CopyProtectionType; + UINT APSTriggerBits; + BYTE OEMCopyProtection[D3DKMDT_MACROVISION_OEMCOPYPROTECTION_SIZE]; + + // Level of available copy protection support. + D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION_SUPPORT CopyProtectionSupport; +} D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: VidPN present path gamma ramp descriptor type. +// +typedef struct _D3DKMDT_GAMMA_RAMP +{ + D3DDDI_GAMMARAMP_TYPE Type; + SIZE_T DataSize; + + // If (Type == D3DDDI_GAMMARAMP_DEFAULT), (DataSize == 0) and (Data.pRaw == NULL ) + union + { + D3DDDI_GAMMA_RAMP_RGB256x3x16* pRgb256x3x16; // Type == D3DDDI_GAMMARAMP_RGB256x3x16. + D3DDDI_GAMMA_RAMP_DXGI_1* pDxgi1; // Type == D3DDDI_GAMMARAMP_DXGI_1. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + D3DKMDT_3x4_COLORSPACE_TRANSFORM* p3x4; // Type == D3DDDI_GAMMARAMP_MATRIX_3x4. +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_3 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + D3DKMDT_COLORSPACE_TRANSFORM_MATRIX_V2* pMatrixV2; // Type == D3DDDI_GAMMARAMP_MATRIX_V2. +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 + VOID* pRaw; + } + Data; +} +D3DKMDT_GAMMA_RAMP; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target to source mapping. +// +// Remarks: This type is used to describe a mapping from a single video present target to a single +// video present source in a VidPN topology. +// +typedef struct _D3DKMDT_VIDPN_PRESENT_PATH +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + + D3DDDI_VIDEO_PRESENT_TARGET_ID VidPnTargetId; + + // Video present path importance ordinal (e.g. path presenting the primary view may have higher + // importance set on it in order to guarantee that it gets the best source/target mode sets). + D3DKMDT_VIDPN_PRESENT_PATH_IMPORTANCE ImportanceOrdinal; + + // Contains all the transformation related fields. + D3DKMDT_VIDPN_PRESENT_PATH_TRANSFORMATION ContentTransformation; + + // Storing deltas for visible/active pixels mapping rather than visible pixels' + // size & offset has the added benefit of ideal/default state being zeros. + + // Monitor screen's offset of visible pixels' top-left corner from + // video signal's active pixels top-left corner. + // Note: Default = (0,0). + D3DKMDT_2DOFFSET VisibleFromActiveTLOffset; + + // Monitor screen's offset of visible pixels' bottom-right corner from + // video signal's active pixels bottom-right corner. + // Note: Default = (0,0). + D3DKMDT_2DOFFSET VisibleFromActiveBROffset; + + // Video signal color basis with respect to which video output codec encodes the pixels from the respective + // source's primary surface (e.g. on HDMI this can be either RGB or YCbCr). + D3DKMDT_COLOR_BASIS VidPnTargetColorBasis; + + // Supported dynamic range of each of the color bases' coefficients by the video output codec's output + // E.g. With a DAC scaning out A2R10G10B10 primary surface at R8G8B8 color resolution, this would be (8,8,8,0), + D3DKMDT_COLOR_COEFF_DYNAMIC_RANGES VidPnTargetColorCoeffDynamicRanges; + + // Indicates the content being diplayed. The driver can use this to determine whether the flicker filter + // and overscan should be enabled or disabled. + D3DKMDT_VIDPN_PRESENT_PATH_CONTENT Content; + + // Contains all the copy protection related fields. + D3DKMDT_VIDPN_PRESENT_PATH_COPYPROTECTION CopyProtection; + + // A lookup table (LUT) used to compensate intensity of presented content for the color response of the monitor + // connected to present path's target. + D3DKMDT_GAMMA_RAMP GammaRamp; +} +D3DKMDT_VIDPN_PRESENT_PATH; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Specifies whether to ignore monitor connectivity checks or enforce them. +// +typedef enum _D3DKMDT_MONITOR_CONNECTIVITY_CHECKS +{ + D3DKMDT_MCC_UNINITIALIZED = 0, + D3DKMDT_MCC_IGNORE = 1, + D3DKMDT_MCC_ENFORCE = 2 +} +D3DKMDT_MONITOR_CONNECTIVITY_CHECKS; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Type of the owner whose mode set does not change during an enumeration. +// +// Remarks: When OS pins/unpins a mode in one of VidPN's mode sets, the only mode set that is guaranteed to +// stay the same is the mode set whose mode was pinned/unpinned. Enumeration pivot lets the OS +// specify to the miniport which mode set it should not update (because this mode set could not have +// been invalidated as a result of the change the OS made to the VidPN. +// +typedef enum _D3DKMDT_ENUMCOFUNCMODALITY_PIVOT_TYPE +{ + D3DKMDT_EPT_UNINITIALIZED, + D3DKMDT_EPT_VIDPNSOURCE, + D3DKMDT_EPT_VIDPNTARGET, + D3DKMDT_EPT_SCALING, + D3DKMDT_EPT_ROTATION, + D3DKMDT_EPT_NOPIVOT +} +D3DKMDT_ENUMCOFUNCMODALITY_PIVOT_TYPE; + +// +// Monitor descriptor related types. +// + +typedef UINT D3DKMDT_MONITOR_DESCRIPTOR_ID; + +typedef enum _D3DKMDT_MONITOR_DESCRIPTOR_TYPE +{ + D3DKMDT_MDT_UNINITIALIZED = 0, + D3DKMDT_MDT_VESA_EDID_V1_BASEBLOCK = 1, + D3DKMDT_MDT_VESA_EDID_V1_BLOCKMAP = 2, + D3DKMDT_MDT_OTHER = 255 +} +D3DKMDT_MONITOR_DESCRIPTOR_TYPE; + +typedef struct _D3DKMDT_MONITOR_DESCRIPTOR +{ + D3DKMDT_MONITOR_DESCRIPTOR_ID Id; + D3DKMDT_MONITOR_DESCRIPTOR_TYPE Type; + SIZE_T DataSize; + VOID* pData; + D3DKMDT_MONITOR_CAPABILITIES_ORIGIN Origin; +} +D3DKMDT_MONITOR_DESCRIPTOR; + + +typedef enum _D3DKMDT_STANDARDALLOCATION_TYPE +{ + D3DKMDT_STANDARDALLOCATION_SHAREDPRIMARYSURFACE = 1, + D3DKMDT_STANDARDALLOCATION_SHADOWSURFACE = 2, + D3DKMDT_STANDARDALLOCATION_STAGINGSURFACE = 3, + D3DKMDT_STANDARDALLOCATION_GDISURFACE = 4, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMDT_STANDARDALLOCATION_VGPU = 5, +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMDT_STANDARDALLOCATION_FENCESTORAGE = 6, +} D3DKMDT_STANDARDALLOCATION_TYPE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef enum _D3DKMDT_GRAPHICS_PREEMPTION_GRANULARITY +{ + D3DKMDT_GRAPHICS_PREEMPTION_NONE = 0, + D3DKMDT_GRAPHICS_PREEMPTION_DMA_BUFFER_BOUNDARY = 100, + D3DKMDT_GRAPHICS_PREEMPTION_PRIMITIVE_BOUNDARY = 200, + D3DKMDT_GRAPHICS_PREEMPTION_TRIANGLE_BOUNDARY = 300, + D3DKMDT_GRAPHICS_PREEMPTION_PIXEL_BOUNDARY = 400, + D3DKMDT_GRAPHICS_PREEMPTION_SHADER_BOUNDARY = 500, +} D3DKMDT_GRAPHICS_PREEMPTION_GRANULARITY; + +typedef enum _D3DKMDT_COMPUTE_PREEMPTION_GRANULARITY +{ + D3DKMDT_COMPUTE_PREEMPTION_NONE = 0, + D3DKMDT_COMPUTE_PREEMPTION_DMA_BUFFER_BOUNDARY = 100, + D3DKMDT_COMPUTE_PREEMPTION_DISPATCH_BOUNDARY = 200, + D3DKMDT_COMPUTE_PREEMPTION_THREAD_GROUP_BOUNDARY = 300, + D3DKMDT_COMPUTE_PREEMPTION_THREAD_BOUNDARY = 400, + D3DKMDT_COMPUTE_PREEMPTION_SHADER_BOUNDARY = 500, +} D3DKMDT_COMPUTE_PREEMPTION_GRANULARITY; + +typedef struct _D3DKMDT_PREEMPTION_CAPS +{ + D3DKMDT_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity; + D3DKMDT_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity; +} D3DKMDT_PREEMPTION_CAPS; + +typedef struct _D3DKMT_WDDM_1_2_CAPS +{ + D3DKMDT_PREEMPTION_CAPS PreemptionCaps; + union + { + struct + { + UINT SupportNonVGA : 1; + UINT SupportSmoothRotation : 1; + UINT SupportPerEngineTDR : 1; + UINT SupportKernelModeCommandBuffer : 1; + UINT SupportCCD : 1; + UINT SupportSoftwareDeviceBitmaps : 1; + UINT SupportGammaRamp : 1; + UINT SupportHWCursor : 1; + UINT SupportHWVSync : 1; + UINT SupportSurpriseRemovalInHibernation : 1; + UINT Reserved : 22; + }; + UINT Value; + }; +} D3DKMT_WDDM_1_2_CAPS; + + +#endif // DXGKDDI_INTERFACE_VERSION + +typedef struct _D3DKMDT_SHAREDPRIMARYSURFACEDATA +{ + UINT Width; + UINT Height; + D3DDDIFORMAT Format; + D3DDDI_RATIONAL RefreshRate; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; +} D3DKMDT_SHAREDPRIMARYSURFACEDATA; + +typedef struct _D3DKMDT_SHADOWSURFACEDATA +{ + UINT Width; + UINT Height; + D3DDDIFORMAT Format; + UINT Pitch; //out: Driver must return Pitch as this allocation will be lockabale +} D3DKMDT_SHADOWSURFACEDATA; + +//Staging Surface is a surface created potentially +//during present when a direct Blt to primary is +//not possible in cases like multimon or sprites. +//This surface is always in the format of D3DDDIFMT_X8R8G8B8 + +typedef struct _D3DKMDT_STAGINGSURFACEDATA +{ + UINT Width; //in: Width of the staging buffer + UINT Height; //in: Height of the staging buffer + UINT Pitch; //out: Driver must return Pitch as this allocation will be lockabale +} D3DKMDT_STAGINGSURFACEDATA; + +typedef struct _D3DKMDT_GDISURFACEFLAGS +{ + union + { + struct + { + UINT Reserved : 32; + }; + UINT Value; + }; +} D3DKMDT_GDISURFACEFLAGS; + +typedef enum _D3DKMDT_GDISURFACETYPE +{ + D3DKMDT_GDISURFACE_INVALID = 0, + D3DKMDT_GDISURFACE_TEXTURE = 1, + D3DKMDT_GDISURFACE_STAGING_CPUVISIBLE = 2, + D3DKMDT_GDISURFACE_STAGING = 3, + D3DKMDT_GDISURFACE_LOOKUPTABLE = 4, + D3DKMDT_GDISURFACE_EXISTINGSYSMEM = 5, + D3DKMDT_GDISURFACE_TEXTURE_CPUVISIBLE = 6, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_M1) + D3DKMDT_GDISURFACE_TEXTURE_CROSSADAPTER = 7, + D3DKMDT_GDISURFACE_TEXTURE_CPUVISIBLE_CROSSADAPTER = 8, // Reserved for OS +#endif // DXGKDDI_INTERFACE_VERSION +} D3DKMDT_GDISURFACETYPE; + +typedef struct _D3DKMDT_GDISURFACEDATA +{ + UINT Width; + UINT Height; + D3DDDIFORMAT Format; + D3DKMDT_GDISURFACETYPE Type; + D3DKMDT_GDISURFACEFLAGS Flags; + UINT Pitch; // out: The driver must return pitch if allocation is CPU visible +} D3DKMDT_GDISURFACEDATA; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +typedef struct _D3DKMDT_VIRTUALGPUSURFACEDATA +{ + UINT64 Size; + UINT Alignment; + UINT DriverSegmentId; + UINT PrivateDriverData; +} D3DKMDT_VIRTUALGPUSURFACEDATA; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +typedef enum _DXGKARG_FENCESTORAGEVALUETYPE +{ + D3DKARG_FENCESTORAGETYPE_CURRENTVALUE, + D3DKARG_FENCESTORAGETYPE_MONITOREDVALUE, +} DXGKARG_FENCESTORAGEVALUETYPE; + +typedef struct _D3DKMDT_PALETTEDATA +{ + BYTE Red; + BYTE Green; + BYTE Blue; + BYTE Unused; +} D3DKMDT_PALETTEDATA; + +// +//Red - Bits to be put in the Red portion of the color registers. +// +//Green - Bits to be put in the Green portion of the color registers. +// +//Blue - Bits to be put in the Blue portion of the color registers. +// + +typedef struct _DXGKARG_SETPALETTE +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT FirstEntry; + UINT NumEntries; + D3DKMDT_PALETTEDATA* pLookupTable; +} DXGKARG_SETPALETTE; + +// +//NumEntries - Number of entries in the LookupTable of color values. +// +//FirstEntry - Location in the device palette to which the first entry in the +// LookupTable of colors should be copied to. The other entries in the +// LookupTable should be copied sequentially, from this starting point into +// the device's palette. +// +//pLookupTable - Array of color entries to copy into the device's color +// registers/palette. The color entries can be accessed as a genric 32 bit +// value or as Red/Green/Blue/Unused fields. +// + +typedef struct _D3DKMT_MOVE_RECT +{ + POINT SourcePoint; + RECT DestRect; +}D3DKMT_MOVE_RECT; + +// +// Display information structure. +// + +#ifndef PHYSICAL_ADDRESS +typedef LARGE_INTEGER PHYSICAL_ADDRESS; +#endif + +typedef struct _DXGK_DISPLAY_INFORMATION +{ + UINT Width; + UINT Height; + UINT Pitch; + D3DDDIFORMAT ColorFormat; + PHYSICAL_ADDRESS PhysicAddress; + D3DDDI_VIDEO_PRESENT_TARGET_ID TargetId; + ULONG AcpiId; +} DXGK_DISPLAY_INFORMATION, *PDXGK_DISPLAY_INFORMATION; + + +//////////////////// I2C //////////////////////////////////////////////////////////////////////////////////// + +#define DXGKMDT_I2C_NO_FLAGS 0 +#define DXGKMDT_I2C_DEVICE_TRANSMITS_DATA_LENGTH 1 + +//////////////////// OPM (Output Protection Manager) //////////////////////////////////////////////////////// + +#pragma pack( push, 1 ) + +#define DXGKMDT_OPM_OMAC_SIZE 16 +#define DXGKMDT_OPM_128_BIT_RANDOM_NUMBER_SIZE 16 +#define DXGKMDT_OPM_ENCRYPTED_PARAMETERS_SIZE 256 +#define DXGKMDT_OPM_CONFIGURE_SETTING_DATA_SIZE 4056 +#define DXGKMDT_OPM_GET_INFORMATION_PARAMETERS_SIZE 4056 +#define DXGKMDT_OPM_REQUESTED_INFORMATION_SIZE 4076 +#define DXGKMDT_OPM_HDCP_KEY_SELECTION_VECTOR_SIZE 5 +#define DXGKMDT_OPM_PROTECTION_TYPE_SIZE 4 + +DEFINE_GUID(DXGKMDT_OPM_GET_CURRENT_HDCP_SRM_VERSION, 0x99c5ceff, 0x5f1d, 0x4879, 0x81, 0xc1, 0xc5, 0x24, 0x43, 0xc9, 0x48, 0x2b); +DEFINE_GUID(DXGKMDT_OPM_GET_CONNECTED_HDCP_DEVICE_INFORMATION, 0x0db59d74, 0xa992, 0x492e, 0xa0, 0xbd, 0xc2, 0x3f, 0xda, 0x56, 0x4e, 0x00); +DEFINE_GUID(DXGKMDT_OPM_GET_CONNECTOR_TYPE, 0x81d0bfd5, 0x6afe, 0x48c2, 0x99, 0xc0, 0x95, 0xa0, 0x8f, 0x97, 0xc5, 0xda); +DEFINE_GUID(DXGKMDT_OPM_GET_SUPPORTED_PROTECTION_TYPES, 0x38f2a801, 0x9a6c, 0x48bb, 0x91, 0x07, 0xb6, 0x69, 0x6e, 0x6f, 0x17, 0x97); +DEFINE_GUID(DXGKMDT_OPM_GET_VIRTUAL_PROTECTION_LEVEL, 0xb2075857, 0x3eda, 0x4d5d, 0x88, 0xdb, 0x74, 0x8f, 0x8c, 0x1a, 0x05, 0x49); +DEFINE_GUID(DXGKMDT_OPM_GET_ACTUAL_PROTECTION_LEVEL, 0x1957210a, 0x7766, 0x452a, 0xb9, 0x9a, 0xd2, 0x7a, 0xed, 0x54, 0xf0, 0x3a); +DEFINE_GUID(DXGKMDT_OPM_GET_ACTUAL_OUTPUT_FORMAT, 0xd7bf1ba3, 0xad13, 0x4f8e, 0xaf, 0x98, 0x0d, 0xcb, 0x3c, 0xa2, 0x04, 0xcc); +DEFINE_GUID(DXGKMDT_OPM_GET_ADAPTER_BUS_TYPE, 0xc6f4d673, 0x6174, 0x4184, 0x8e, 0x35, 0xf6, 0xdb, 0x52, 0x0, 0xbc, 0xba); +DEFINE_GUID(DXGKMDT_OPM_GET_ACP_AND_CGMSA_SIGNALING, 0x6629a591, 0x3b79, 0x4cf3, 0x92, 0x4a, 0x11, 0xe8, 0xe7, 0x81, 0x16, 0x71); +DEFINE_GUID(DXGKMDT_OPM_GET_OUTPUT_ID, 0x72cb6df3, 0x244f, 0x40ce, 0xb0, 0x9e, 0x20, 0x50, 0x6a, 0xf6, 0x30, 0x2f); +DEFINE_GUID(DXGKMDT_OPM_GET_DVI_CHARACTERISTICS, 0xa470b3bb, 0x5dd7, 0x4172, 0x83, 0x9c, 0x3d, 0x37, 0x76, 0xe0, 0xeb, 0xf5); +DEFINE_GUID(DXGKMDT_OPM_GET_OUTPUT_HARDWARE_PROTECTION_SUPPORT, 0x3b129589, 0x2af8, 0x4ef0, 0x96, 0xa2, 0x70, 0x4a, 0x84, 0x5a, 0x21, 0x8e); +DEFINE_GUID(DXGKMDT_OPM_GET_CODEC_INFO, 0x4f374491, 0x8f5f, 0x4445, 0x9d, 0xba, 0x95, 0x58, 0x8f, 0x6b, 0x58, 0xb4); +DEFINE_GUID(DXGKMDT_OPM_SET_PROTECTION_LEVEL, 0x9bb9327c, 0x4eb5, 0x4727, 0x9f, 0x00, 0xb4, 0x2b, 0x09, 0x19, 0xc0, 0xda); +DEFINE_GUID(DXGKMDT_OPM_SET_ACP_AND_CGMSA_SIGNALING, 0x09a631a5, 0xd684, 0x4c60, 0x8e, 0x4d, 0xd3, 0xbb, 0x0f, 0x0b, 0xe3, 0xee); +DEFINE_GUID(DXGKMDT_OPM_SET_HDCP_SRM, 0x8b5ef5d1, 0xc30d, 0x44ff, 0x84, 0xa5, 0xea, 0x71, 0xdc, 0xe7, 0x8f, 0x13); +DEFINE_GUID(DXGKMDT_OPM_SET_PROTECTION_LEVEL_ACCORDING_TO_CSS_DVD, 0x39ce333e, 0x4cc0, 0x44ae, 0xbf, 0xcc, 0xda, 0x50, 0xb5, 0xf8, 0x2e, 0x72); + +typedef enum _DXGKMDT_CERTIFICATE_TYPE +{ + DXGKMDT_OPM_CERTIFICATE = 0, + DXGKMDT_COPP_CERTIFICATE = 1, + DXGKMDT_UAB_CERTIFICATE = 2, + DXGKMDT_INDIRECT_DISPLAY_CERTIFICATE = 3, + DXGKMDT_FORCE_ULONG = 0xFFFFFFFF +} DXGKMDT_CERTIFICATE_TYPE; + +typedef enum _DXGKMDT_OPM_VIDEO_OUTPUT_SEMANTICS +{ + DXGKMDT_OPM_VOS_COPP_SEMANTICS = 0, + DXGKMDT_OPM_VOS_OPM_SEMANTICS = 1, + DXGKMDT_OPM_VOS_OPM_INDIRECT_DISPLAY = 2 +} DXGKMDT_OPM_VIDEO_OUTPUT_SEMANTICS; + +typedef enum _DXGKMDT_DPCP_PROTECTION_LEVEL +{ + DXGKMDT_OPM_DPCP_OFF = 0, + DXGKMDT_OPM_DPCP_ON = 1, + DXGKMDT_OPM_DPCP_FORCE_ULONG = 0x7fffffff + +} DXGKMDT_OPM_DPCP_PROTECTION_LEVEL; + +typedef enum _DXGKMDT_OPM_HDCP_FLAG +{ + DXGKMDT_OPM_HDCP_FLAG_NONE = 0x00, + DXGKMDT_OPM_HDCP_FLAG_REPEATER = 0x01 +} DXGKMDT_OPM_HDCP_FLAG; + +typedef enum _DXGKMDT_OPM_STATUS +{ + DXGKMDT_OPM_STATUS_NORMAL = 0x00, + DXGKMDT_OPM_STATUS_LINK_LOST = 0x01, + DXGKMDT_OPM_STATUS_RENEGOTIATION_REQUIRED = 0x02, + DXGKMDT_OPM_STATUS_TAMPERING_DETECTED = 0x04, + DXGKMDT_OPM_STATUS_REVOKED_HDCP_DEVICE_ATTACHED = 0x08 +} DXGKMDT_OPM_STATUS; + +// NUAE stands for Non-User Accessible Enclosure +typedef enum _DXGKMDT_OPM_BUS_TYPE_AND_IMPLEMENTATION +{ + DXGKMDT_OPM_BUS_TYPE_OTHER = 0x00000000, + DXGKMDT_OPM_BUS_TYPE_PCI = 0x00000001, + DXGKMDT_OPM_BUS_TYPE_PCIX = 0x00000002, + DXGKMDT_OPM_BUS_TYPE_PCIEXPRESS = 0x00000003, + DXGKMDT_OPM_BUS_TYPE_AGP = 0x00000004, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_INSIDE_OF_CHIPSET = 0x00010000, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_CHIP = 0x00020000, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_TRACKS_ON_MOTHER_BOARD_TO_SOCKET = 0x00030000, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_DAUGHTER_BOARD_CONNECTOR = 0x00040000, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_DAUGHTER_BOARD_CONNECTOR_INSIDE_OF_NUAE = 0x00050000, + DXGKMDT_OPM_BUS_IMPLEMENTATION_MODIFIER_NON_STANDARD = 0x80000000, + DXGKMDT_OPM_COPP_COMPATIBLE_BUS_TYPE_INTEGRATED = 0x80000000 +} DXGKMDT_OPM_BUS_TYPE_AND_IMPLEMENTATION; + +typedef enum _DXGKMDT_OPM_HDCP_PROTECTION_LEVEL +{ + DXGKMDT_OPM_HDCP_OFF = 0, + DXGKMDT_OPM_HDCP_ON = 1, + DXGKMDT_OPM_HDCP_FORCE_ULONG = 0x7fffffff +} DXGKMDT_OPM_HDCP_PROTECTION_LEVEL; + +typedef enum _DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_PROTECTION_LEVEL +{ + DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_OFF = DXGKMDT_OPM_HDCP_OFF, + DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_ON_WITH_NO_TYPE_RESTRICTION = DXGKMDT_OPM_HDCP_ON, // No Type restriction on output topology nodes + DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_ON_WITH_TYPE1_RESTRICTION = DXGKMDT_OPM_HDCP_ON + 1, // Restrict to Type 1 compliant output topology nodes + DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_FORCE_ULONG = 0x7fffffff +} DXGKMDT_OPM_TYPE_ENFORCEMENT_HDCP_PROTECTION_LEVEL; + +typedef enum _DXGKMDT_OPM_CGMSA +{ + DXGKMDT_OPM_CGMSA_OFF = 0, + DXGKMDT_OPM_CGMSA_COPY_FREELY = 1, + DXGKMDT_OPM_CGMSA_COPY_NO_MORE = 2, + DXGKMDT_OPM_CGMSA_COPY_ONE_GENERATION = 3, + DXGKMDT_OPM_CGMSA_COPY_NEVER = 4, + DXGKMDT_OPM_REDISTRIBUTION_CONTROL_REQUIRED = 0x08, +} DXGKMDT_OPM_CGMSA; + +typedef enum _DXGKMDT_OPM_ACP_PROTECTION_LEVEL +{ + DXGKMDT_OPM_ACP_OFF = 0, + DXGKMDT_OPM_ACP_LEVEL_ONE = 1, + DXGKMDT_OPM_ACP_LEVEL_TWO = 2, + DXGKMDT_OPM_ACP_LEVEL_THREE = 3, + DXGKMDT_OPM_ACP_FORCE_ULONG = 0x7fffffff +} DXGKMDT_OPM_ACP_PROTECTION_LEVEL; + +typedef enum _DXGKMDT_OPM_PROTECTION_TYPE +{ + DXGKMDT_OPM_PROTECTION_TYPE_OTHER = 0x80000000, + DXGKMDT_OPM_PROTECTION_TYPE_NONE = 0x00000000, + DXGKMDT_OPM_PROTECTION_TYPE_COPP_COMPATIBLE_HDCP = 0x00000001, + DXGKMDT_OPM_PROTECTION_TYPE_ACP = 0x00000002, + DXGKMDT_OPM_PROTECTION_TYPE_CGMSA = 0x00000004, + DXGKMDT_OPM_PROTECTION_TYPE_HDCP = 0x00000008, + DXGKMDT_OPM_PROTECTION_TYPE_DPCP = 0x00000010, + DXGKMDT_OPM_PROTECTION_TYPE_TYPE_ENFORCEMENT_HDCP = 0x00000020, + DXGKMDT_OPM_PROTECTION_TYPE_MASK = 0x8000003F +} DXGKMDT_OPM_PROTECTION_TYPE; + +typedef enum _DXGKMDT_OPM_PROTECTION_STANDARD +{ + DXGKMDT_OPM_PROTECTION_STANDARD_OTHER = 0x80000000, + DXGKMDT_OPM_PROTECTION_STANDARD_NONE = 0x00000000, + DXGKMDT_OPM_PROTECTION_STANDARD_IEC61880_525I = 0x00000001, + DXGKMDT_OPM_PROTECTION_STANDARD_IEC61880_2_525I = 0x00000002, + DXGKMDT_OPM_PROTECTION_STANDARD_IEC62375_625P = 0x00000004, + DXGKMDT_OPM_PROTECTION_STANDARD_EIA608B_525 = 0x00000008, + DXGKMDT_OPM_PROTECTION_STANDARD_EN300294_625I = 0x00000010, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEA_525P = 0x00000020, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEA_750P = 0x00000040, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEA_1125I = 0x00000080, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEB_525P = 0x00000100, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEB_750P = 0x00000200, + DXGKMDT_OPM_PROTECTION_STANDARD_CEA805A_TYPEB_1125I = 0x00000400, + DXGKMDT_OPM_PROTECTION_STANDARD_ARIBTRB15_525I = 0x00000800, + DXGKMDT_OPM_PROTECTION_STANDARD_ARIBTRB15_525P = 0x00001000, + DXGKMDT_OPM_PROTECTION_STANDARD_ARIBTRB15_750P = 0x00002000, + DXGKMDT_OPM_PROTECTION_STANDARD_ARIBTRB15_1125I = 0x00004000, +} DXGKMDT_OPM_PROTECTION_STANDARD; + +typedef enum _DXGKMDT_OPM_IMAGE_ASPECT_RATIO_EN300294 +{ + DXGKMDT_OPM_ASPECT_RATIO_EN300294_FULL_FORMAT_4_BY_3 = 0, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_BOX_14_BY_9_CENTER = 1, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_BOX_14_BY_9_TOP = 2, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_BOX_16_BY_9_CENTER = 3, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_BOX_16_BY_9_TOP = 4, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_BOX_GT_16_BY_9_CENTER = 5, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_FULL_FORMAT_4_BY_3_PROTECTED_CENTER = 6, + DXGKMDT_OPM_ASPECT_RATIO_EN300294_FULL_FORMAT_16_BY_9_ANAMORPHIC = 7, + DXGKMDT_OPM_ASPECT_RATIO_FORCE_ULONG = 0x7FFFFFFF +} DXGKMDT_OPM_IMAGE_ASPECT_RATIO_EN300294; + +typedef enum _DXGKMDT_OPM_INTERLEAVE_FORMAT +{ + DXGKMDT_OPM_INTERLEAVE_FORMAT_OTHER = 0, + DXGKMDT_OPM_INTERLEAVE_FORMAT_PROGRESSIVE = 2, + DXGKMDT_OPM_INTERLEAVE_FORMAT_INTERLEAVED_EVEN_FIRST = 3, + DXGKMDT_OPM_INTERLEAVE_FORMAT_INTERLEAVED_ODD_FIRST = 4, + DXGKMDT_OPM_INTERLEAVE_FORMAT_FORCE_ULONG = 0xFFFFFFFF + +} DXGKMDT_OPM_INTERLEAVE_FORMAT; + +typedef enum _DXGKDT_OPM_DVI_CHARACTERISTICS +{ + DXGKMDT_OPM_DVI_CHARACTERISTIC_1_0 = 1, + DXGKMDT_OPM_DVI_CHARACTERISTIC_1_1_OR_ABOVE = 2, + DXGKMDT_OPM_DVI_CHARACTERISTICS_FORCE_ULONG = 0xFFFFFFFF +} DXGKDT_OPM_DVI_CHARACTERISTICS; + +typedef enum _DXGKMDT_OPM_OUTPUT_HARDWARE_PROTECTION +{ + DXGKMDT_OPM_OUTPUT_HARDWARE_PROTECTION_NOT_SUPPORTED = 0x0, + DXGKMDT_OPM_OUTPUT_HARDWARE_PROTECTION_SUPPORTED = 0x1 +} DXGKMDT_OPM_OUTPUT_HARDWARE_PROTECTION; + +typedef struct _DXGKMDT_OPM_RANDOM_NUMBER +{ + BYTE abRandomNumber[DXGKMDT_OPM_128_BIT_RANDOM_NUMBER_SIZE]; +} DXGKMDT_OPM_RANDOM_NUMBER, *PDXGKMDT_OPM_RANDOM_NUMBER; + +typedef struct _DXGKMDT_OPM_OMAC +{ + BYTE abOMAC[DXGKMDT_OPM_OMAC_SIZE]; +} DXGKMDT_OPM_OMAC, *PDXGKMDT_OPM_OMAC; + +typedef struct _DXGKMDT_OPM_ENCRYPTED_PARAMETERS +{ + BYTE abEncryptedParameters[DXGKMDT_OPM_ENCRYPTED_PARAMETERS_SIZE]; +} DXGKMDT_OPM_ENCRYPTED_PARAMETERS, *PDXGKMDT_OPM_ENCRYPTED_PARAMETERS; + +typedef struct _DXGKMDT_OPM_GET_INFO_PARAMETERS +{ + DXGKMDT_OPM_OMAC omac; + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + GUID guidInformation; + ULONG ulSequenceNumber; + ULONG cbParametersSize; + BYTE abParameters[DXGKMDT_OPM_GET_INFORMATION_PARAMETERS_SIZE]; +} DXGKMDT_OPM_GET_INFO_PARAMETERS, *PDXGKMDT_OPM_GET_INFO_PARAMETERS; + +typedef struct _DXGKMDT_OPM_COPP_COMPATIBLE_GET_INFO_PARAMETERS +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + GUID guidInformation; + ULONG ulSequenceNumber; + ULONG cbParametersSize; + BYTE abParameters[DXGKMDT_OPM_GET_INFORMATION_PARAMETERS_SIZE]; +} DXGKMDT_OPM_COPP_COMPATIBLE_GET_INFO_PARAMETERS, *PDXGKMDT_OPM_COPP_COMPATIBLE_GET_INFO_PARAMETERS; + +typedef struct _DXGKMDT_OPM_HDCP_KEY_SELECTION_VECTOR +{ + BYTE abKeySelectionVector[DXGKMDT_OPM_HDCP_KEY_SELECTION_VECTOR_SIZE]; +} DXGKMDT_OPM_HDCP_KEY_SELECTION_VECTOR; + +typedef struct _DXGKMDT_OPM_CONNECTED_HDCP_DEVICE_INFORMATION +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + ULONG ulStatusFlags; + ULONG ulHDCPFlags; + DXGKMDT_OPM_HDCP_KEY_SELECTION_VECTOR ksvB; + BYTE Reserved[11]; + BYTE Reserved2[16]; + BYTE Reserved3[16]; +} DXGKMDT_OPM_CONNECTED_HDCP_DEVICE_INFORMATION; + +typedef struct _DXGKMDT_OPM_REQUESTED_INFORMATION +{ + DXGKMDT_OPM_OMAC omac; + ULONG cbRequestedInformationSize; + BYTE abRequestedInformation[DXGKMDT_OPM_REQUESTED_INFORMATION_SIZE]; +} DXGKMDT_OPM_REQUESTED_INFORMATION, *PDXGKMDT_OPM_REQUESTED_INFORMATION; + +typedef struct _DXGKMDT_OPM_STANDARD_INFORMATION +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + ULONG ulStatusFlags; + ULONG ulInformation; + ULONG ulReserved; + ULONG ulReserved2; +} DXGKMDT_OPM_STANDARD_INFORMATION; + +typedef struct _DXGKMDT_OPM_ACTUAL_OUTPUT_FORMAT +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + ULONG ulStatusFlags; + ULONG ulDisplayWidth; + ULONG ulDisplayHeight; + DXGKMDT_OPM_INTERLEAVE_FORMAT ifInterleaveFormat; + ULONG d3dFormat; + ULONG ulFrequencyNumerator; + ULONG ulFrequencyDenominator; +} DXGKMDT_OPM_ACTUAL_OUTPUT_FORMAT; + +typedef struct _DXGKMDT_OPM_ACP_AND_CGMSA_SIGNALING +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + ULONG ulStatusFlags; + ULONG ulAvailableTVProtectionStandards; + ULONG ulActiveTVProtectionStandard; + ULONG ulReserved; + ULONG ulAspectRatioValidMask1; + ULONG ulAspectRatioData1; + ULONG ulAspectRatioValidMask2; + ULONG ulAspectRatioData2; + ULONG ulAspectRatioValidMask3; + ULONG ulAspectRatioData3; + ULONG ulReserved2[4]; + ULONG ulReserved3[4]; +} DXGKMDT_OPM_ACP_AND_CGMSA_SIGNALING; + +typedef struct _DXGKMDT_OPM_OUTPUT_ID +{ + DXGKMDT_OPM_RANDOM_NUMBER rnRandomNumber; + ULONG ulStatusFlags; + UINT64 OutputId; +} DXGKMDT_OPM_OUTPUT_ID; + +typedef struct _DXGKMDT_OPM_CONFIGURE_PARAMETERS +{ + DXGKMDT_OPM_OMAC omac; + GUID guidSetting; + ULONG ulSequenceNumber; + ULONG cbParametersSize; + BYTE abParameters[DXGKMDT_OPM_CONFIGURE_SETTING_DATA_SIZE]; +} DXGKMDT_OPM_CONFIGURE_PARAMETERS, *PDXGKMDT_OPM_CONFIGURE_PARAMETERS; + +typedef struct _DXGKMDT_OPM_SET_PROTECTION_LEVEL_PARAMETERS +{ + ULONG ulProtectionType; + ULONG ulProtectionLevel; + ULONG Reserved; + ULONG Reserved2; +} DXGKMDT_OPM_SET_PROTECTION_LEVEL_PARAMETERS; + +typedef struct _DXGKMDT_OPM_SET_ACP_AND_CGMSA_SIGNALING_PARAMETERS +{ + ULONG ulNewTVProtectionStandard; + ULONG ulAspectRatioChangeMask1; + ULONG ulAspectRatioData1; + ULONG ulAspectRatioChangeMask2; + ULONG ulAspectRatioData2; + ULONG ulAspectRatioChangeMask3; + ULONG ulAspectRatioData3; + ULONG ulReserved[4]; + ULONG ulReserved2[4]; + ULONG ulReserved3; +} DXGKMDT_OPM_SET_ACP_AND_CGMSA_SIGNALING_PARAMETERS; + +typedef struct _DXGKMDT_OPM_SET_HDCP_SRM_PARAMETERS +{ + ULONG ulSRMVersion; +} DXGKMDT_OPM_SET_HDCP_SRM_PARAMETERS; + +typedef struct _DXGKMDT_OPM_CREATE_VIDEO_OUTPUT_FOR_TARGET_PARAMETERS +{ + LUID AdapterLuid; + D3DDDI_VIDEO_PRESENT_TARGET_ID TargetId; + DXGKMDT_OPM_VIDEO_OUTPUT_SEMANTICS Vos; +} DXGKMDT_OPM_CREATE_VIDEO_OUTPUT_FOR_TARGET_PARAMETERS; + +typedef struct _DXGK_BRIGHTNESS_CAPS +{ + union + { + struct + { + UINT SmoothBrightness : 1; // 0x00000001 + UINT AdaptiveBrightness : 1; // 0x00000002 + UINT NitsBrightness : 1; // 0x00000004 + UINT Reserved : 29; // 0xFFFFFFF8 + }; + + UINT Value; + }; +} DXGK_BRIGHTNESS_CAPS; + +typedef struct _DXGK_BRIGHTNESS_STATE +{ + union + { + struct + { + UINT SmoothBrightness : 1; // 0x00000001 + UINT Reserved : 31; // 0xFFFFFFFE + }; + + UINT Value; + }; +} DXGK_BRIGHTNESS_STATE; + +typedef enum +{ + DxgkBacklightOptimizationDisable = 0, + DxgkBacklightOptimizationDesktop = 1, + DxgkBacklightOptimizationDynamic = 2, + DxgkBacklightOptimizationDimmed = 3, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + DxgkBacklightOptimizationEDR = 4, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 +} DXGK_BACKLIGHT_OPTIMIZATION_LEVEL; + +typedef struct _DXGK_BACKLIGHT_INFO +{ + OUT USHORT BacklightUsersetting; + OUT USHORT BacklightEffective; + OUT D3DDDI_GAMMA_RAMP_RGB256x3x16 GammaRamp; +} DXGK_BACKLIGHT_INFO; + +typedef struct _DXGK_BRIGHTNESS_SENSOR_DATA_CHROMATICITY +{ + float ChromaticityX; + float ChromaticityY; +} DXGK_BRIGHTNESS_SENSOR_DATA_CHROMATICITY; + +typedef struct _DXGK_BRIGHTNESS_SENSOR_DATA +{ + UINT32 Size; + union + { + struct + { + UINT AlsReadingValid : 1; + UINT ChromaticityValid : 1; + UINT ColorTemperatureValid : 1; + UINT Reserved : 29; + } Flags; + UINT ValidSensorValues; + }; + float AlsReading; + DXGK_BRIGHTNESS_SENSOR_DATA_CHROMATICITY Chromaticity; + float ColorTemperature; +} DXGK_BRIGHTNESS_SENSOR_DATA; + + +typedef struct _DXGK_BRIGHTNESS_SET_IN +{ + UINT32 BrightnessMillinits; + UINT32 TransitionTimeMs; + DXGK_BRIGHTNESS_SENSOR_DATA SensorReadings; +} DXGK_BRIGHTNESS_SET_IN, *PDXGK_BRIGHTNESS_SET_IN; + +typedef struct _DXGK_BRIGHTNESS_GET_OUT +{ + UINT32 CurrentBrightnessMillinits; + UINT32 TargetBrightnessMillinits; +} DXGK_BRIGHTNESS_GET_OUT, *PDXGK_BRIGHTNESS_GET_OUT; + +typedef struct _DXGK_BRIGHTNESS_NIT_RANGE +{ + UINT32 MinimumLevelMillinit; + UINT32 MaximumLevelMillinit; + UINT32 StepSizeMillinit; +} DXGK_BRIGHTNESS_NIT_RANGE; + +#define DXGK_BRIGHTNESS_MAXIMUM_NIT_RANGE_COUNT 16 + +typedef struct _DXGK_BRIGHTNESS_GET_NIT_RANGES_OUT +{ + UINT32 NormalRangeCount; + UINT32 RangeCount; + UINT32 PreferredMaximumBrightness; + DXGK_BRIGHTNESS_NIT_RANGE SupportedRanges[DXGK_BRIGHTNESS_MAXIMUM_NIT_RANGE_COUNT]; +} DXGK_BRIGHTNESS_GET_NIT_RANGES_OUT, *PDXGK_BRIGHTNESS_GET_NIT_RANGES_OUT; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +typedef struct _D3DKMT_WDDM_1_3_CAPS +{ + union + { + struct + { + UINT SupportMiracast : 1; + UINT IsHybridIntegratedGPU : 1; + UINT IsHybridDiscreteGPU : 1; + UINT SupportPowerManagementPStates : 1; + UINT SupportVirtualModes : 1; + UINT SupportCrossAdapterResource : 1; + UINT Reserved : 26; + }; + UINT Value; + }; +} D3DKMT_WDDM_1_3_CAPS; + +#define DXGK_MAX_METADATA_NAME_LENGTH 32 +typedef enum +{ + DXGK_ENGINE_TYPE_OTHER, + DXGK_ENGINE_TYPE_3D, + DXGK_ENGINE_TYPE_VIDEO_DECODE, + DXGK_ENGINE_TYPE_VIDEO_ENCODE, + DXGK_ENGINE_TYPE_VIDEO_PROCESSING, + DXGK_ENGINE_TYPE_SCENE_ASSEMBLY, + DXGK_ENGINE_TYPE_COPY, + DXGK_ENGINE_TYPE_OVERLAY, + DXGK_ENGINE_TYPE_CRYPTO, + DXGK_ENGINE_TYPE_VIDEO_CODEC, + DXGK_ENGINE_TYPE_MAX +} DXGK_ENGINE_TYPE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _DXGK_NODEMETADATA_FLAGS +{ + union + { + struct + { + UINT ContextSchedulingSupported : 1; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + + UINT RingBufferFenceRelease : 1; + UINT SupportTrackedWorkload : 1; + UINT UserModeSubmission : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + UINT SupportBuildTestCommandBuffer : 1; + UINT Reserved : 11; +#else + UINT Reserved : 12; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + + UINT MaxInFlightHwQueueBuffers : 16; + +#else + + UINT Reserved : 31; + +#endif // !(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + + }; + UINT32 Value; + }; +} DXGK_NODEMETADATA_FLAGS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _DXGK_NODEMETADATA +{ + DXGK_ENGINE_TYPE EngineType; + WCHAR FriendlyName[DXGK_MAX_METADATA_NAME_LENGTH]; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + DXGK_NODEMETADATA_FLAGS Flags; +#else + UINT32 Reserved; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + BOOLEAN GpuMmuSupported; + BOOLEAN IoMmuSupported; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +} DXGK_NODEMETADATA; + +typedef DXGK_NODEMETADATA DXGKARG_GETNODEMETADATA; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +typedef struct _DXGK_GPUCLOCKDATA_FLAGS +{ + union + { + struct + { + UINT ContextManagementProcessor : 1; + UINT Reserved : 31; + }; + UINT32 Value; + }; +} DXGK_GPUCLOCKDATA_FLAGS; + +typedef struct _DXGK_NODE_PERFDATA +{ + ULONGLONG Frequency; // out: Clock frequency of the engine in hertz + ULONGLONG MaxFrequency; // out: Max engine clock frequency + ULONGLONG MaxFrequencyOC; // out: Max engine over clock frequency + ULONG Voltage; // out: Voltage of the engine in milli volts mV + ULONG VoltageMax; // out: Max voltage levels in milli volts. + ULONG VoltageMaxOC; // out: Max voltage level while overclocked in milli volts. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + ULONGLONG MaxTransitionLatency; // out: Max transition latency to change the frequency in 100 nanoseconds +#endif +} DXGK_NODE_PERFDATA; + +typedef struct _DXGK_ADAPTER_PERFDATA +{ + ULONGLONG MemoryFrequency; // out: Clock frequency of the memory in hertz + ULONGLONG MaxMemoryFrequency; // out: Max memory clock frequency + ULONGLONG MaxMemoryFrequencyOC; // out: Clock frequency of the memory while overclocked in hertz. + ULONGLONG MemoryBandwidth; // out: Amount of memory transferred in bytes + ULONGLONG PCIEBandwidth; // out: Amount of memory transferred over PCI-E in bytes + ULONG FanRPM; // out: Fan rpm + ULONG Power; // out: Power draw of the adapter in tenths of a percentage + ULONG Temperature; // out: Temperature in deci-Celsius 1 = 0.1C + UCHAR PowerStateOverride; // out: Overrides dxgkrnls power view of linked adapters. +} DXGK_ADAPTER_PERFDATA; + +typedef struct _DXGK_ADAPTER_PERFDATACAPS +{ + ULONGLONG MaxMemoryBandwidth; // out: Max memory bandwidth in bytes for 1 second + ULONGLONG MaxPCIEBandwidth; // out: Max pcie bandwidth in bytes for 1 second + ULONG MaxFanRPM; // out: Max fan rpm + ULONG TemperatureMax; // out: Max temperature before damage levels + ULONG TemperatureWarning; // out: The temperature level where throttling begins. +} DXGK_ADAPTER_PERFDATACAPS; + +#define DXGK_MAX_GPUVERSION_NAME_LENGTH 32 +typedef struct _DXGK_GPUVERSION +{ + WCHAR BiosVersion[DXGK_MAX_GPUVERSION_NAME_LENGTH]; //out: The gpu bios version + WCHAR GpuArchitecture[DXGK_MAX_GPUVERSION_NAME_LENGTH]; //out: The gpu architectures name. +} DXGK_GPUVERSION; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +typedef struct _DXGK_GPUCLOCKDATA +{ + ULONGLONG GpuFrequency; + ULONGLONG GpuClockCounter; + ULONGLONG CpuClockCounter; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + DXGK_GPUCLOCKDATA_FLAGS Flags; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) +} DXGK_GPUCLOCKDATA; + +typedef DXGK_GPUCLOCKDATA DXGKARG_CALIBRATEGPUCLOCK; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_WDDM_2_0_CAPS +{ + union + { + struct + { + UINT Support64BitAtomics : 1; + UINT GpuMmuSupported : 1; + UINT IoMmuSupported : 1; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + UINT FlipOverwriteSupported : 1; + UINT SupportContextlessPresent : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + UINT SupportSurpriseRemoval : 1; + UINT Reserved : 26; +#else + UINT Reserved : 27; +#endif // !(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) +#else + UINT Reserved : 29; +#endif // !(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + }; + UINT Value; + }; +} D3DKMT_WDDM_2_0_CAPS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + +typedef struct _D3DKMT_WDDM_2_7_CAPS +{ + union + { + struct + { + UINT HwSchSupported : 1; // Specifies whether the GPU supports hardware scheduling + UINT HwSchEnabled : 1; // Specifies whether the hardware scheduling is currently enabled for this GPU + UINT HwSchEnabledByDefault : 1; // Set to 1 if the OS default policy is to enable hardware scheduling for this GPU + UINT IndependentVidPnVSyncControl : 1; + UINT Reserved : 28; + }; + UINT Value; + }; +} D3DKMT_WDDM_2_7_CAPS; + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + +// DXGK_FEATURE_SUPPORT constants + +// When a driver doesn't support a feature, it doesn't call into QueryFeatureSupport with that feature ID. +// This value is provided for implementation convenience of enumerating possible driver support states +// for a particular feature. +#define DXGK_FEATURE_SUPPORT_ALWAYS_OFF ((UINT)0) + +// Driver support for a feature is in the experimental state +#define DXGK_FEATURE_SUPPORT_EXPERIMENTAL ((UINT)1) + +// Driver support for a feature is in the stable state +#define DXGK_FEATURE_SUPPORT_STABLE ((UINT)2) + +// Driver support for a feature is in the always on state, +// and it doesn't operate without this feature enabled. +#define DXGK_FEATURE_SUPPORT_ALWAYS_ON ((UINT)3) + +typedef struct _D3DKMT_WDDM_2_9_CAPS +{ + union + { + struct + { + _Field_range_(DXGK_FEATURE_SUPPORT_ALWAYS_OFF, DXGK_FEATURE_SUPPORT_ALWAYS_ON) + UINT HwSchSupportState : 2; // DXGK_FEATURE_SUPPORT_* value that specifies driver support state for GPU supports hardware scheduling + UINT HwSchEnabled : 1; // Specifies whether the hardware scheduling is currently enabled for this GPU + UINT SelfRefreshMemorySupported : 1; // Specifies whether Self Refresh Memory is supported for this GPU + UINT Reserved : 28; + }; + UINT Value; + }; +} D3DKMT_WDDM_2_9_CAPS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +typedef struct _D3DKMT_WDDM_3_0_CAPS +{ + union + { + struct + { + _Field_range_(DXGK_FEATURE_SUPPORT_ALWAYS_OFF, DXGK_FEATURE_SUPPORT_ALWAYS_ON) + UINT HwFlipQueueSupportState : 2; // DXGK_FEATURE_SUPPORT_* value that specifies driver support state for GPU supports hardware flip queue + UINT HwFlipQueueEnabled : 1; // Specifies whether the hardware flip queue is currently enabled for this GPU + UINT DisplayableSupported : 1; // Specifies whether displayable feature is supported + UINT Reserved : 28; + }; + UINT Value; + }; +} D3DKMT_WDDM_3_0_CAPS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_WDDM_3_1_CAPS +{ + union + { + struct + { + UINT NativeGpuFenceSupported : 1; // Specifies whether native GPU fence is supported by this GPU + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DKMT_WDDM_3_1_CAPS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + +typedef enum _DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL +{ + DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL_UNINITIALIZED = 0, + + // Indicates driver has no support for MDM + DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL_NONE = 1, + + // Indicates the driver has development support for MDM, + // quality not considered good enough for development purposes only + DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL_DEVELOPMENT = 2, + + // Indicates the driver has experimental support for MDM, + // quality not considered good enough for general customer rollout + DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL_EXPERIMENTAL = 3, + + // Indicates the driver has full support for MDM, + // quality considered good enough for general customer rollout + DXGK_DISPLAYMUX_DRIVER_SUPPORT_LEVEL_FULL = 4, +} DXGK_DISPLAYMUX_SUPPORT_LEVEL, *PDXGK_DISPLAYMUX_SUPPORT_LEVEL; + +typedef enum _DXGK_DISPLAYMUX_RUNTIME_STATUS +{ + DXGK_DISPLAYMUX_RUNTIME_STATUS_UNINITIALIZED = 0, + + // Indicates the GPU supports MDM and any driver obtained any + // required information from the system + DXGK_DISPLAYMUX_RUNTIME_STATUS_OK = 1, + + // Indicates the GPU does not support MDM + DXGK_DISPLAYMUX_RUNTIME_STATUS_NO_GPU_SUPPORT = 2, + + // Indicates the driver could not obtain some non-critical information + // from the system, MDM can still function but user experience may be impacted + DXGK_DISPLAYMUX_RUNTIME_STATUS_NON_CRITICAL_SYSTEM_INFO_MISSING = 3, + + // Indicates the driver could not obtain some critical information + // from the system, MDM can function without this + DXGK_DISPLAYMUX_RUNTIME_STATUS_CRITICAL_SYSTEM_INFO_MISSING = 4, +} DXGK_DISPLAYMUX_RUNTIME_STATUS, *PDXGK_DISPLAYMUX_RUNTIME_STATUS; + +typedef struct _DXGK_DISPLAYMUX_SET_INTERNAL_PANEL_INFO +{ + // Indicates if brightness 3 interface was supported by the + // GPU the panel was initially connected to at boot + BOOLEAN Brightness3Supported; + + // If brightness 3 was supported by the GPU the mux was connected to + // then these are the brightness 3 caps and ranges reported + DXGK_BRIGHTNESS_CAPS Brightness3Caps; + DXGK_BRIGHTNESS_GET_NIT_RANGES_OUT Bridgtness3Ranges; +} DXGK_DISPLAYMUX_SET_INTERNAL_PANEL_INFO, *PDXGK_DISPLAYMUX_SET_INTERNAL_PANEL_INFO; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_TRACKEDWORKLOAD_SUPPORT +{ + _In_ UINT PhysicalAdapterIndex; + _In_ DXGK_ENGINE_TYPE EngineType; + _Out_ BOOL Support; +} D3DKMT_TRACKEDWORKLOAD_SUPPORT; + +typedef struct _D3DKMT_NODEMETADATA +{ + _In_ UINT NodeOrdinalAndAdapterIndex; // WDDMv2: High word is physical adapter index, low word is node ordinal + _Out_ DXGK_NODEMETADATA NodeData; +} D3DKMT_NODEMETADATA; + +typedef struct _D3DKMT_QUERYCLOCKCALIBRATION +{ + D3DKMT_HANDLE hAdapter; // in: The adapter to query clock information for + UINT32 NodeOrdinal; // in: Node ordinal of the requested engine. + UINT32 PhysicalAdapterIndex; // in: The physical adapter index, in an LDA chain + DXGK_GPUCLOCKDATA ClockData; // out: Output frequency, Gpu clock, and Cpu clock on the specified engine +} D3DKMT_QUERYCLOCKCALIBRATION; + +typedef enum _DXGK_RENDER_PIPELINE_STAGE +{ + DXGK_RENDER_PIPELINE_STAGE_UNKNOWN = 0, + DXGK_RENDER_PIPELINE_STAGE_INPUT_ASSEMBLER = 1, + DXGK_RENDER_PIPELINE_STAGE_VERTEX_SHADER = 2, + DXGK_RENDER_PIPELINE_STAGE_GEOMETRY_SHADER = 3, + DXGK_RENDER_PIPELINE_STAGE_STREAM_OUTPUT = 4, + DXGK_RENDER_PIPELINE_STAGE_RASTERIZER = 5, + DXGK_RENDER_PIPELINE_STAGE_PIXEL_SHADER = 6, + DXGK_RENDER_PIPELINE_STAGE_OUTPUT_MERGER = 7, +} DXGK_RENDER_PIPELINE_STAGE; + +typedef enum _DXGK_PAGE_FAULT_FLAGS +{ + DXGK_PAGE_FAULT_WRITE = 0x1, // when set, indicates that a write to a GPU virtual address failed + DXGK_PAGE_FAULT_FENCE_INVALID = 0x2, // when set, indicates that a fence value for the packet that generated + // the page fault could not be determined + DXGK_PAGE_FAULT_ADAPTER_RESET_REQUIRED = 0x4, // when set, indicates that the page fault put the GPU in a state that requires a full adapter reset + DXGK_PAGE_FAULT_ENGINE_RESET_REQUIRED = 0x8, // when set, indicates that the page fault put the GPU in a state that requires GPU engine reset + DXGK_PAGE_FAULT_FATAL_HARDWARE_ERROR = 0x10, // when set, indicates that the system hardware, not just the GPU, cannot continue, + // and the OS should issue a bugcheck + DXGK_PAGE_FAULT_IOMMU = 0x20, // when set, indicates that the faulting GPU virtual address was mapped using IoMmu, + // when not set, the faulting GPU virtual address was mapped using GPU memory management unit. + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + + DXGK_PAGE_FAULT_HW_CONTEXT_VALID = 0x40, // when set, indicates that the faulting hardware queue was not identified, but faulting HW context was. + DXGK_PAGE_FAULT_PROCESS_HANDLE_VALID = 0x80, // when set, indicates that the faulting hardware queue or context was not identified, + // but process handle that submitted the faulted buffer was. + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +} DXGK_PAGE_FAULT_FLAGS; + +typedef enum _DXGK_GENERAL_ERROR_CODE +{ + DXGK_GENERAL_ERROR_PAGE_FAULT = 0, + DXGK_GENERAL_ERROR_INVALID_INSTRUCTION = 1, +} DXGK_GENERAL_ERROR_CODE; + +typedef struct _DXGK_FAULT_ERROR_CODE +{ + union + { + struct + { + UINT IsDeviceSpecificCode : 1; // when set to 1, indicates the low 31 bits correspond to a device specific error code. + // when set to 0, indicates the low 31 bits correspond to a code defined by DXGK_GENERAL_ERROR_CODE. + DXGK_GENERAL_ERROR_CODE GeneralErrorCode : 31; // General error code defined by DXGK_GENERAL_ERROR_CODE. + }; + struct + { + UINT IsDeviceSpecificCodeReservedBit : 1; // Same as IsDeviceSpecificCode member above: + // when set to 1, indicates the low 31 bits correspond to a device specific error code. + // when set to 0, indicates the low 31 bits correspond to a code defined by DXGK_GENERAL_ERROR_CODE. + UINT DeviceSpecificCode : 31; // A device specific error code. + }; + }; +} DXGK_FAULT_ERROR_CODE; + +typedef struct _D3DKMT_DRIVERCAPS_EXT +{ + union + { + struct + { + UINT VirtualModeSupport : 1; + UINT Usb4MonitorSupport : 1; + UINT Reserved : 30; + }; + UINT Value; + }; +} D3DKMT_DRIVERCAPS_EXT; + +#define DXGK_PRIMITIVE_API_SEQUENCE_NUMBER_UNKNOWN ULONGLONG_MAX +#define DXGK_BIND_TABLE_ENTRY_UNKNOWN UINT_MAX + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +typedef union _DXGK_MONITORLINKINFO_USAGEHINTS +{ + struct + { + UINT Hidden : 1; // 0x00000001 + UINT HeadMounted : 1; // 0x00000002 + UINT Reserved :30; // 0xFFFFFFFC + }; + UINT Value; +} DXGK_MONITORLINKINFO_USAGEHINTS, *PDXGK_MONITORLINKINFO_USAGEHINTS; + +typedef union _DXGK_MONITORLINKINFO_CAPABILITIES +{ + struct + { + UINT Stereo : 1; // 0x00000001 + UINT WideColorSpace : 1; // 0x00000002 + UINT HighColorSpace : 1; // 0x00000004 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + UINT DynamicColorSpace : 1; // 0x00000008 + UINT DynamicBitsPerColorChannel : 1; // 0x00000010 + UINT DynamicColorEncodingFormat : 1; // 0x00000020 + UINT DedicatedTimingGeneration : 1; // 0x00000040 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + UINT TargetIndependentPrimary : 1; // 0x00000080 + UINT SyncLockIdentical : 1; // 0x00000100 + UINT Hdr10Plus : 1; // 0x00000200 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_4 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + UINT DolbyVisionLowLatency : 1; // 0x00000400 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_5 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + UINT VariableRefresh : 1; // 0x00000800 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + UINT Reserved :20; // 0xFFFFF000 +#elif (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + UINT Reserved :21; // 0xFFFFF800 +#elif (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + UINT Reserved :22; // 0xFFFFFC00 +#elif (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + UINT Reserved :25; // 0xFFFFFF80 +#else + UINT Reserved :29; // 0xFFFFFFF8 +#endif // DXGKDDI_INTERFACE_VERSION + }; + UINT Value; +} DXGK_MONITORLINKINFO_CAPABILITIES, *PDXGK_MONITORLINKINFO_CAPABILITIES; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#if defined(__cplusplus) && !defined(SORTPP_PASS) + +typedef enum _DXGK_DISPLAY_USAGE : BYTE +{ + DXGK_DU_INVALID = 0, + DXGK_DU_GENERIC = 1, + DXGK_DU_AR = 2, + DXGK_DU_VR = 3, + DXGK_DU_MEDICAL_IMAGING = 4, + DXGK_DU_ACCESSORY = 5, + DXGK_DU_MAX = 6 +} DXGK_DISPLAY_USAGE, *PDXGK_DISPLAY_USAGE; + +typedef enum _DXGK_DISPLAY_TECHNOLOGY : BYTE +{ + DXGK_DT_INVALID = 0, + DXGK_DT_OTHER = 1, + DXGK_DT_LCD = 2, + DXGK_DT_OLED = 3, + DXGK_DT_PROJECTOR = 4, + DXGK_DT_MAX = 5 +} DXGK_DISPLAY_TECHNOLOGY, *PDXGK_DISPLAY_TECHNOLOGY; + +typedef enum _DXGK_DISPLAY_DESCRIPTOR_TYPE: BYTE +{ + DXGK_DDT_INVALID = 0, + DXGK_DDT_EDID, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + DXGK_DDT_DISPLAYID, +#endif +} DXGK_DISPLAY_DESCRIPTOR_TYPE, *PDXGK_DISPLAY_DESCRIPTOR_TYPE; + +#else +typedef BYTE DXGK_DISPLAY_USAGE; +typedef BYTE DXGK_DISPLAY_TECHNOLOGY; +typedef BYTE DXGK_DISPLAY_DESCRIPTOR_TYPE; +#endif // defined(__cplusplus) && !defined(SORTPP_PASS) + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Capabilities, preferences and other information reported by display only capable adapters. + +typedef struct _D3DKMT_DISPLAY_CAPS +{ + union + { + struct + { + UINT64 PreferPhysicallyContiguous : 1; + UINT64 CursorScaledWithMultiPlaneOverlayPlane0 : 1; + UINT64 CursorDoesNotSupportXorBlendWithMultiPlaneOverlay : 1; + UINT64 Reserved : 61; + }; + UINT64 Value; + }; +} D3DKMT_DISPLAY_CAPS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +#pragma pack( pop ) + +#endif // (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +#pragma warning(pop) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _D3DKMDT_H */ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmthk.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmthk.h new file mode 100644 index 0000000000000000000000000000000000000000..18b0c249391305a1b48cbda050d97b523afb5066 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dkmthk.h @@ -0,0 +1,6284 @@ +/******************************Module*Header**********************************\ +* +* Module Name: d3dkmthk.h +* +* Content: longhorn display driver model kernel mode thunk interfaces +* +* Copyright (c) 2003 Microsoft Corporation. All rights reserved. +\*****************************************************************************/ +#ifndef _D3DKMTHK_H_ +#define _D3DKMTHK_H_ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma warning(push) +#pragma warning(disable:4201) // anonymous unions warning +#pragma warning(disable:4200) // zero-sized array in struct/union +#pragma warning(disable:4214) // nonstandard extension used: bit field types other than int + + +typedef struct _OBJECT_ATTRIBUTES OBJECT_ATTRIBUTES; +typedef OBJECT_ATTRIBUTES *POBJECT_ATTRIBUTES; + +// +// Available only for Vista (LONGHORN) and later and for +// multiplatform tools such as debugger extensions +// +#if (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +typedef struct _D3DKMT_CREATEDEVICEFLAGS +{ + UINT LegacyMode : 1; // 0x00000001 + UINT RequestVSync : 1; // 0x00000002 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + UINT DisableGpuTimeout : 1; // 0x00000004 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + UINT TestDevice : 1; // 0x00000008 The device is created by a test. Testsigning must be enabled. + UINT Reserved : 28; // 0xFFFFFFF0 +#else + UINT Reserved : 29; // 0xFFFFFFF8 +#endif +#else + UINT Reserved : 30; // 0xFFFFFFFC +#endif +} D3DKMT_CREATEDEVICEFLAGS; + +typedef struct _D3DKMT_CREATEDEVICE +{ + union + { + D3DKMT_HANDLE hAdapter; // in: identifies the adapter for user-mode creation + VOID* pAdapter; // in: identifies the adapter for kernel-mode creation + D3DKMT_PTR_HELPER(pAdapter_Align) + }; + + D3DKMT_CREATEDEVICEFLAGS Flags; + + D3DKMT_HANDLE hDevice; // out: Identifies the device + D3DKMT_PTR(VOID*, pCommandBuffer); // out: D3D10 compatibility. + UINT CommandBufferSize; // out: D3D10 compatibility. + D3DKMT_PTR(D3DDDI_ALLOCATIONLIST*, pAllocationList); // out: D3D10 compatibility. + UINT AllocationListSize; // out: D3D10 compatibility. + D3DKMT_PTR(D3DDDI_PATCHLOCATIONLIST*, pPatchLocationList); // out: D3D10 compatibility. + UINT PatchLocationListSize; // out: D3D10 compatibility. +} D3DKMT_CREATEDEVICE; + +typedef struct _D3DKMT_DESTROYDEVICE +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device +}D3DKMT_DESTROYDEVICE; + +typedef enum _D3DKMT_CLIENTHINT +{ + D3DKMT_CLIENTHINT_UNKNOWN = 0, + D3DKMT_CLIENTHINT_OPENGL = 1, + D3DKMT_CLIENTHINT_CDD = 2, // Internal + D3DKMT_CLIENTHINT_OPENCL = 3, + D3DKMT_CLIENTHINT_VULKAN = 4, + D3DKMT_CLIENTHINT_CUDA = 5, + D3DKMT_CLIENTHINT_RESERVED = 6, + D3DKMT_CLIENTHINT_DX7 = 7, + D3DKMT_CLIENTHINT_DX8 = 8, + D3DKMT_CLIENTHINT_DX9 = 9, + D3DKMT_CLIENTHINT_DX10 = 10, + D3DKMT_CLIENTHINT_DX11 = 11, + D3DKMT_CLIENTHINT_DX12 = 12, + D3DKMT_CLIENTHINT_9ON12 = 13, + D3DKMT_CLIENTHINT_11ON12 = 14, + D3DKMT_CLIENTHINT_MFT_ENCODE = 15, + D3DKMT_CLIENTHINT_GLON12 = 16, + D3DKMT_CLIENTHINT_CLON12 = 17, + D3DKMT_CLIENTHINT_DML_TENSORFLOW = 18, + D3DKMT_CLIENTHINT_ONEAPI_LEVEL0 = 19, + D3DKMT_CLIENTHINT_DML_PYTORCH = 20, + D3DKMT_CLIENTHINT_VKON12 = 21, + D3DKMT_CLIENTHINT_FASTRPC = 22, + D3DKMT_CLIENTHINT_SNPE = 23, + D3DKMT_CLIENTHINT_QNN = 24, + D3DKMT_CLIENTHINT_VITIS = 25, + D3DKMT_CLIENTHINT_FFMPEG = 26, + D3DKMT_CLIENTHINT_OPEN_VINO = 27, + D3DKMT_CLIENTHINT_MAX +} D3DKMT_CLIENTHINT; + +typedef struct _D3DKMT_CREATECONTEXT +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device owning this context. + UINT NodeOrdinal; // in: Identifier for the node targetted by this context. + UINT EngineAffinity; // in: Engine affinity within the specified node. + D3DDDI_CREATECONTEXTFLAGS Flags; // in: Context creation flags. + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in: Size of private driver data + D3DKMT_CLIENTHINT ClientHint; // in: Hints which client is creating this + D3DKMT_HANDLE hContext; // out: Handle of the created context. + D3DKMT_PTR(VOID*, pCommandBuffer); // out: Pointer to the first command buffer. + UINT CommandBufferSize; // out: Command buffer size (bytes). + D3DKMT_PTR(D3DDDI_ALLOCATIONLIST*, pAllocationList); // out: Pointer to the first allocation list. + UINT AllocationListSize; // out: Allocation list size (elements). + D3DKMT_PTR(D3DDDI_PATCHLOCATIONLIST*, pPatchLocationList); // out: Pointer to the first patch location list. + UINT PatchLocationListSize; // out: Patch location list size (elements). + D3DGPU_VIRTUAL_ADDRESS CommandBuffer; // out: GPU virtual address of the command buffer. _ADVSCH_ +} D3DKMT_CREATECONTEXT; + +typedef struct _D3DKMT_DESTROYCONTEXT +{ + D3DKMT_HANDLE hContext; // in: Identifies the context being destroyed. +} D3DKMT_DESTROYCONTEXT; + +typedef struct _D3DKMT_CREATESYNCHRONIZATIONOBJECT +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DDDI_SYNCHRONIZATIONOBJECTINFO Info; // in: Attributes of the synchronization object. + D3DKMT_HANDLE hSyncObject; // out: Handle to the synchronization object created. +} D3DKMT_CREATESYNCHRONIZATIONOBJECT; + +typedef struct _D3DKMT_CREATESYNCHRONIZATIONOBJECT2 +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DDDI_SYNCHRONIZATIONOBJECTINFO2 Info; // in/out: Attributes of the synchronization object. + D3DKMT_HANDLE hSyncObject; // out: Handle to the synchronization object created. +} D3DKMT_CREATESYNCHRONIZATIONOBJECT2; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_CREATENATIVEFENCE_FLAGS +{ + union + { + struct + { + UINT Reserved : 32; + }; + UINT Value; + }; +}D3DKMT_CREATENATIVEFENCE_FLAGS; + +typedef struct _D3DKMT_CREATENATIVEFENCE +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DKMT_HANDLE hSyncObject; // out: Handle to sync object in this process. + BYTE PrivateDriverData[D3DDDI_NATIVE_FENCE_PDD_SIZE]; // in/out: Private driver data to pass to KMD CreateNativeFence call, + // and copy back to UMD + D3DDDI_NATIVEFENCEINFO Info; // in/out: Attributes of the synchronization object. + D3DKMT_CREATENATIVEFENCE_FLAGS Flags; + BYTE Reserved[28]; +} D3DKMT_CREATENATIVEFENCE; + +typedef struct _D3DKMT_GETNATIVEFENCELOGDETAIL_FLAGS +{ + union + { + struct + { + UINT Reserved : 32; + }; + UINT Value; + }; +} D3DKMT_GETNATIVEFENCELOGDETAIL_FLAGS; + +typedef struct _D3DKMT_GETNATIVEFENCELOGDETAIL +{ + D3DKMT_HANDLE hHwQueue; // in: HWQueue for which log buffer details are requested + D3DKMT_GETNATIVEFENCELOGDETAIL_FLAGS Flags; // in: + UINT32 WaitLogNumberOfEntries; // out: + UINT32 SignalLogNumberOfEntries; // out: + D3DGPU_VIRTUAL_ADDRESS WaitLogGpuBaseAddress; // out: + D3DGPU_VIRTUAL_ADDRESS SignalLogGpuBaseAddress; // out: + BYTE Reserved[64]; +} D3DKMT_GETNATIVEFENCELOGDETAIL; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_DESTROYSYNCHRONIZATIONOBJECT +{ + D3DKMT_HANDLE hSyncObject; // in: Identifies the synchronization objects being destroyed. +} D3DKMT_DESTROYSYNCHRONIZATIONOBJECT; + +typedef struct _D3DKMT_OPENSYNCHRONIZATIONOBJECT +{ + D3DKMT_HANDLE hSharedHandle; // in: shared handle to synchronization object to be opened. + D3DKMT_HANDLE hSyncObject; // out: Handle to sync object in this process. + + D3DKMT_ALIGN64 UINT64 Reserved[8]; +} D3DKMT_OPENSYNCHRONIZATIONOBJECT; + +typedef struct _D3DKMT_WAITFORSYNCHRONIZATIONOBJECT +{ + D3DKMT_HANDLE hContext; // in: Identifies the context that needs to wait. + UINT ObjectCount; // in: Specifies the number of object to wait on. + D3DKMT_HANDLE ObjectHandleArray[D3DDDI_MAX_OBJECT_WAITED_ON]; // in: Specifies the object to wait on. +} D3DKMT_WAITFORSYNCHRONIZATIONOBJECT; + +typedef struct _D3DKMT_WAITFORSYNCHRONIZATIONOBJECT2 +{ + D3DKMT_HANDLE hContext; // in: Identifies the context that needs to wait. + UINT ObjectCount; // in: Specifies the number of object to wait on. + D3DKMT_HANDLE ObjectHandleArray[D3DDDI_MAX_OBJECT_WAITED_ON]; // in: Specifies the object to wait on. + union + { + struct { + D3DKMT_ALIGN64 UINT64 FenceValue; // in: fence value to be waited. + } Fence; + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; +} D3DKMT_WAITFORSYNCHRONIZATIONOBJECT2; + +typedef struct _D3DKMT_SIGNALSYNCHRONIZATIONOBJECT +{ + D3DKMT_HANDLE hContext; // in: Identifies the context that needs to signal. + UINT ObjectCount; // in: Specifies the number of object to signal. + D3DKMT_HANDLE ObjectHandleArray[D3DDDI_MAX_OBJECT_SIGNALED]; // in: Specifies the object to be signaled. + D3DDDICB_SIGNALFLAGS Flags; // in: Specifies signal behavior. +} D3DKMT_SIGNALSYNCHRONIZATIONOBJECT; + +typedef struct _D3DKMT_SIGNALSYNCHRONIZATIONOBJECT2 +{ + D3DKMT_HANDLE hContext; // in: Identifies the context that needs to signal. + UINT ObjectCount; // in: Specifies the number of object to signal. + D3DKMT_HANDLE ObjectHandleArray[D3DDDI_MAX_OBJECT_SIGNALED]; // in: Specifies the object to be signaled. + D3DDDICB_SIGNALFLAGS Flags; // in: Specifies signal behavior. + ULONG BroadcastContextCount; // in: Specifies the number of context + // to broadcast this command buffer to. + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + // broadcast to. + union + { + struct { + D3DKMT_ALIGN64 UINT64 FenceValue; // in: fence value to be signaled; + } Fence; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + HANDLE CpuEventHandle; // in: handle of a CPU event to be signaled +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; +} D3DKMT_SIGNALSYNCHRONIZATIONOBJECT2; + +typedef struct _D3DKMT_LOCK +{ + D3DKMT_HANDLE hDevice; // in: identifies the device + D3DKMT_HANDLE hAllocation; // in: allocation to lock + // out: New handle representing the allocation after the lock. + UINT PrivateDriverData; // in: Used by UMD for AcquireAperture + UINT NumPages; + D3DKMT_PTR(CONST UINT*, pPages); + D3DKMT_PTR(VOID*, pData); // out: pointer to memory + D3DDDICB_LOCKFLAGS Flags; // in: Bit field defined by D3DDDI_LOCKFLAGS + D3DGPU_VIRTUAL_ADDRESS GpuVirtualAddress; // out: GPU's Virtual Address of locked allocation. _ADVSCH_ +} D3DKMT_LOCK; + +typedef struct _D3DKMT_UNLOCK +{ + D3DKMT_HANDLE hDevice; // in: Identifies the device + UINT NumAllocations; // in: Number of allocations in the array + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocations); // in: array of allocations to unlock +} D3DKMT_UNLOCK; + +typedef enum _D3DKMDT_MODE_PRUNING_REASON +{ + D3DKMDT_MPR_UNINITIALIZED = 0, // mode was pruned or is supported because of: + D3DKMDT_MPR_ALLCAPS = 1, // all of the monitor caps (only used to imply lack of support - for support, specific reason is always indicated) + D3DKMDT_MPR_DESCRIPTOR_MONITOR_SOURCE_MODE = 2, // monitor source mode in the monitor descriptor + D3DKMDT_MPR_DESCRIPTOR_MONITOR_FREQUENCY_RANGE = 3, // monitor frequency range in the monitor descriptor + D3DKMDT_MPR_DESCRIPTOR_OVERRIDE_MONITOR_SOURCE_MODE = 4, // monitor source mode in the monitor descriptor override + D3DKMDT_MPR_DESCRIPTOR_OVERRIDE_MONITOR_FREQUENCY_RANGE = 5, // monitor frequency range in the monitor descriptor override + D3DKMDT_MPR_DEFAULT_PROFILE_MONITOR_SOURCE_MODE = 6, // monitor source mode in the default monitor profile + D3DKMDT_MPR_DRIVER_RECOMMENDED_MONITOR_SOURCE_MODE = 7, // monitor source mode recommended by the driver + D3DKMDT_MPR_MONITOR_FREQUENCY_RANGE_OVERRIDE = 8, // monitor frequency range override + D3DKMDT_MPR_CLONE_PATH_PRUNED = 9, // Mode is pruned because other path(s) in clone cluster has(have) no mode supported by monitor + D3DKMDT_MPR_MAXVALID = 10 +} +D3DKMDT_MODE_PRUNING_REASON; + +// This structure takes 8 bytes. +// The unnamed UINT of size 0 forces alignment of the structure to +// make it exactly occupy 8 bytes, see MSDN docs on C++ bitfields +// for more details +typedef struct _D3DKMDT_DISPLAYMODE_FLAGS +{ +#if (DXGKDDI_INTERFACE_VERSION < DXGKDDI_INTERFACE_VERSION_WIN8) + BOOLEAN ValidatedAgainstMonitorCaps : 1; + BOOLEAN RoundedFakeMode : 1; + D3DKMDT_MODE_PRUNING_REASON ModePruningReason : 4; + UINT Reserved : 28; +#else + UINT ValidatedAgainstMonitorCaps : 1; + UINT RoundedFakeMode : 1; + UINT : 0; + D3DKMDT_MODE_PRUNING_REASON ModePruningReason : 4; + UINT Stereo : 1; + UINT AdvancedScanCapable : 1; +#if (DXGKDDI_INTERFACE_VERSION < DXGKDDI_INTERFACE_VERSION_WDDM2_0) + UINT Reserved : 26; +#else + UINT PreferredTiming : 1; + UINT PhysicalModeSupported : 1; +#if (DXGKDDI_INTERFACE_VERSION < DXGKDDI_INTERFACE_VERSION_WDDM2_9) + UINT Reserved : 24; +#else + UINT VirtualRefreshRate : 1; + UINT Reserved : 23; +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 +#endif +#endif +} +D3DKMDT_DISPLAYMODE_FLAGS; + +typedef struct _D3DKMT_DISPLAYMODE +{ + UINT Width; + UINT Height; + D3DDDIFORMAT Format; + UINT IntegerRefreshRate; + D3DDDI_RATIONAL RefreshRate; + D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING ScanLineOrdering; + D3DDDI_ROTATION DisplayOrientation; + UINT DisplayFixedOutput; + D3DKMDT_DISPLAYMODE_FLAGS Flags; +} D3DKMT_DISPLAYMODE; + +typedef struct _D3DKMT_GETDISPLAYMODELIST +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN source ID + D3DKMT_PTR(D3DKMT_DISPLAYMODE*, pModeList); // out: + UINT ModeCount; // in/out: +} D3DKMT_GETDISPLAYMODELIST; + +typedef struct _D3DKMT_DISPLAYMODELIST +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT ModeCount; + D3DKMT_DISPLAYMODE pModeList[0]; +} D3DKMT_DISPLAYMODELIST; + +typedef struct _D3DKMT_SETDISPLAYMODE_FLAGS +{ + BOOLEAN PreserveVidPn : 1; + UINT Reserved : 31; +} +D3DKMT_SETDISPLAYMODE_FLAGS; + +typedef struct _D3DKMT_SETDISPLAYMODE +{ + D3DKMT_HANDLE hDevice; // in: Identifies the device + D3DKMT_HANDLE hPrimaryAllocation; // in: + D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING ScanLineOrdering; // in: + D3DDDI_ROTATION DisplayOrientation; // in: + UINT PrivateDriverFormatAttribute; // out: Private Format Attribute of the current primary surface if DxgkSetDisplayMode failed with STATUS_GRAPHICS_INCOMPATIBLE_PRIVATE_FORMAT + D3DKMT_SETDISPLAYMODE_FLAGS Flags; // in: +} D3DKMT_SETDISPLAYMODE; + + +typedef struct _D3DKMT_MULTISAMPLEMETHOD +{ + UINT NumSamples; + UINT NumQualityLevels; + UINT Reserved; //workaround for NTRAID#Longhorn-1124385-2005/03/14-kanqiu +} D3DKMT_MULTISAMPLEMETHOD; + +typedef struct _D3DKMT_GETMULTISAMPLEMETHODLIST +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN source ID + UINT Width; // in: + UINT Height; // in: + D3DDDIFORMAT Format; // in: + D3DKMT_PTR(D3DKMT_MULTISAMPLEMETHOD*, pMethodList); // out: + UINT MethodCount; // in/out: +} D3DKMT_GETMULTISAMPLEMETHODLIST; + +typedef struct _D3DKMT_PRESENTFLAGS +{ + union + { + struct + { + UINT Blt : 1; // 0x00000001 + UINT ColorFill : 1; // 0x00000002 + UINT Flip : 1; // 0x00000004 + UINT FlipDoNotFlip : 1; // 0x00000008 + UINT FlipDoNotWait : 1; // 0x00000010 + UINT FlipRestart : 1; // 0x00000020 + UINT DstRectValid : 1; // 0x00000040 + UINT SrcRectValid : 1; // 0x00000080 + UINT RestrictVidPnSource : 1; // 0x00000100 + UINT SrcColorKey : 1; // 0x00000200 + UINT DstColorKey : 1; // 0x00000400 + UINT LinearToSrgb : 1; // 0x00000800 + UINT PresentCountValid : 1; // 0x00001000 + UINT Rotate : 1; // 0x00002000 + UINT PresentToBitmap : 1; // 0x00004000 + UINT RedirectedFlip : 1; // 0x00008000 + UINT RedirectedBlt : 1; // 0x00010000 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + UINT FlipStereo : 1; // 0x00020000 // This is a flip from a stereo alloc. Used in addition to Flip. + UINT FlipStereoTemporaryMono : 1; // 0x00040000 // This is a flip from a stereo alloc. The left image should used to produce both images. Used in addition to Flip. + UINT FlipStereoPreferRight : 1; // 0x00080000 // This is a flip from a stereo alloc. Use the right image when cloning to a mono monitor. Used in addition to Flip. + UINT BltStereoUseRight : 1; // 0x00100000 // This is a Blt from a stereo alloc to a mono alloc. The right image should be used. + UINT PresentHistoryTokenOnly : 1; // 0x00200000 // Submit Present History Token only. + UINT PresentRegionsValid : 1; // 0x00400000 // Ptr to present regions is valid + UINT PresentDDA : 1; // 0x00800000 // Present from a DDA swapchain + UINT ProtectedContentBlankedOut : 1; // 0x01000000 + UINT RemoteSession : 1; // 0x02000000 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + UINT CrossAdapter : 1; // 0x04000000 + UINT DurationValid : 1; // 0x08000000 + UINT PresentIndirect : 1; // 0x10000000 // Present to an indirect-display adapter + UINT PresentHMD : 1; // 0x20000000 // Present from an HMD swapchain. + UINT Reserved : 2; // 0xC0000000 +#else + UINT Reserved : 6; // 0xFC000000 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) +#else + UINT Reserved : 15; // 0xFFFE0000 +#endif + }; + UINT Value; + }; +} D3DKMT_PRESENTFLAGS; + +typedef enum _D3DKMT_PRESENT_MODEL +{ + D3DKMT_PM_UNINITIALIZED = 0, + D3DKMT_PM_REDIRECTED_GDI = 1, + D3DKMT_PM_REDIRECTED_FLIP = 2, + D3DKMT_PM_REDIRECTED_BLT = 3, + D3DKMT_PM_REDIRECTED_VISTABLT = 4, + D3DKMT_PM_SCREENCAPTUREFENCE = 5, + D3DKMT_PM_REDIRECTED_GDI_SYSMEM = 6, + D3DKMT_PM_REDIRECTED_COMPOSITION = 7, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_PM_SURFACECOMPLETE = 8, +#endif + D3DKMT_PM_FLIPMANAGER = 9, +} D3DKMT_PRESENT_MODEL; + +typedef enum _D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE +{ + D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE_FLIP_SUBMITTED = 0, + D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE_FLIP_COMPLETE = 1 +} D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE; + +typedef struct _D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS +{ + union + { + struct + { + UINT Video : 1; // 0x00000001 + UINT RestrictedContent : 1; // 0x00000002 + UINT ClipToView : 1; // 0x00000004 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + UINT StereoPreferRight : 1; // 0x00000008 + UINT TemporaryMono : 1; // 0x00000010 + UINT FlipRestart : 1; // 0x00000020 + UINT HDRMetaDataChanged : 1; // 0x00000040 + UINT AlphaMode : 2; // 0x00000180 + UINT SignalLimitOnTokenCompletion : 1; // 0x00000200 + UINT YCbCrFlags : 3; // 0x00001C00 + UINT IndependentFlip : 1; // 0x00002000 + D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE IndependentFlipStage : 2; // 0x0000C000 + UINT IndependentFlipReleaseCount : 2; // 0x00030000 + UINT IndependentFlipForceNotifyDwm : 1; // 0x00040000 + UINT UseCustomDuration : 1; // 0x00080000 + UINT IndependentFlipRequestDwmConfirm:1; // 0x00100000 + UINT IndependentFlipCandidate : 1; // 0x00200000 + UINT IndependentFlipCheckNeeded : 1; // 0x00400000 + UINT IndependentFlipTrueImmediate : 1; // 0x00800000 + UINT IndependentFlipRequestDwmExit : 1; // 0x01000000 + UINT CompSurfaceNotifiedEarly : 1; // 0x02000000 + UINT IndependentFlipDoNotFlip : 1; // 0x04000000 + UINT RequirePairedToken : 1; // 0x08000000 + UINT VariableRefreshOverrideEligible :1; // 0x10000000 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + UINT VailToken : 1; // 0x20000000 + UINT Reserved : 2; // 0xC0000000 +#else + UINT Reserved : 3; // 0xE0000000 +#endif +#else + UINT Reserved : 29; // 0xFFFFFFF8 +#endif + }; + + UINT Value; + }; +} D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS; + +#define D3DKMT_MAX_PRESENT_HISTORY_RECTS 16 + +typedef struct _D3DKMT_DIRTYREGIONS +{ + UINT NumRects; + RECT Rects[D3DKMT_MAX_PRESENT_HISTORY_RECTS]; +} D3DKMT_DIRTYREGIONS; + +typedef struct _D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hPrivateData; +} D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN; + +typedef struct _D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hPrivateData; + D3DKMT_ALIGN64 ULONGLONG PresentAtQpc; + union + { + struct + { + UINT Discard : 1; + UINT PresentAt : 1; + UINT hPrivateDataIsPointer : 1; + UINT Reserved : 29; + }; + UINT Value; + }Flags; +} D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN; + +typedef enum _D3DKMT_AUXILIARYPRESENTINFO_TYPE +{ + D3DKMT_AUXILIARYPRESENTINFO_TYPE_FLIPMANAGER = 0 +} D3DKMT_AUXILIARYPRESENTINFO_TYPE; + +typedef struct _D3DKMT_AUXILIARYPRESENTINFO +{ + UINT size; + D3DKMT_AUXILIARYPRESENTINFO_TYPE type; +} D3DKMT_AUXILIARYPRESENTINFO; + +typedef struct _D3DKMT_FLIPMANAGER_AUXILIARYPRESENTINFO +{ + // in: Base information + D3DKMT_AUXILIARYPRESENTINFO auxiliaryPresentInfo; + + // in: Tracing ID of owner flip manager + UINT flipManagerTracingId; + + // in: Whether or not the application requested a different custom duration + // than the previous present + BOOL customDurationChanged; + + // in: CPU event to signal after the flip manager processes this present + void* pFlipManagerProcessedEvent; + + // out: The adapter LUID/VidPn source of the flip output + LUID FlipAdapterLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + + // out: Independent flip stage + D3DKMT_FLIPMODEL_INDEPENDENT_FLIP_STAGE independentFlipStage; + + // out: The DPC frame time of the frame on which the flip was completed + D3DKMT_ALIGN64 ULONGLONG FlipCompletedQpc; + + // out: The approved frame duration + UINT HwPresentDurationQpc; + + // out: Whether or not the present was canceled in the scheduler + BOOL WasCanceled; + + // out: An IFlip submitted token was subsequently cancelled and should be resubmitted as non-IFlip token. + BOOL ConvertedToNonIFlip; +} D3DKMT_FLIPMANAGER_AUXILIARYPRESENTINFO; + +typedef struct _D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hLogicalSurface; + D3DKMT_ALIGN64 ULONG64 hPhysicalSurface; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + RECT ScrollRect; + POINT ScrollOffset; +#endif + D3DKMT_DIRTYREGIONS DirtyRegions; +} D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN; + +typedef struct _D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hlsurf; + DWORD dwDirtyFlags; + D3DKMT_ALIGN64 UINT64 uiCookie; +} D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN; + +typedef ULONGLONG D3DKMT_VISTABLTMODEL_PRESENTHISTORYTOKEN; + +typedef struct _D3DKMT_FENCE_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 UINT64 Key; +} D3DKMT_FENCE_PRESENTHISTORYTOKEN; + +typedef struct _D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hLogicalSurface; + D3DKMT_ALIGN64 ULONG64 hPhysicalSurface; + D3DKMT_ALIGN64 ULONG64 EventId; + D3DKMT_DIRTYREGIONS DirtyRegions; +} D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +#define D3DKMT_MAX_PRESENT_HISTORY_SCATTERBLTS 12 + +typedef struct _D3DKMT_SCATTERBLT +{ + D3DKMT_ALIGN64 ULONG64 hLogicalSurfaceDestination; + D3DKMT_ALIGN64 LONG64 hDestinationCompSurfDWM; + D3DKMT_ALIGN64 UINT64 DestinationCompositionBindingId; + RECT SourceRect; + POINT DestinationOffset; +} D3DKMT_SCATTERBLT; + +typedef struct _D3DKMT_SCATTERBLTS +{ + UINT NumBlts; + D3DKMT_SCATTERBLT Blts[D3DKMT_MAX_PRESENT_HISTORY_SCATTERBLTS]; +} D3DKMT_SCATTERBLTS; +#endif + +typedef struct _D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 UINT64 FenceValue; + D3DKMT_ALIGN64 ULONG64 hLogicalSurface; + D3DKMT_ALIGN64 D3DKMT_UINT_PTR dxgContext; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT SwapChainIndex; + D3DKMT_ALIGN64 UINT64 PresentLimitSemaphoreId; + D3DDDI_FLIPINTERVAL_TYPE FlipInterval; + D3DKMT_FLIPMODEL_PRESENTHISTORYTOKENFLAGS Flags; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ALIGN64 LONG64 hCompSurf; + LUID compSurfLuid; + D3DKMT_ALIGN64 UINT64 confirmationCookie; + D3DKMT_ALIGN64 UINT64 CompositionSyncKey; + RECT ScrollRect; + POINT ScrollOffset; + UINT PresentCount; + FLOAT RevealColor[4]; // index 0 == R, ... , 3 == A + D3DDDI_ROTATION Rotation; + union + { + D3DKMT_SCATTERBLTS ScatterBlts; // Unused + struct + { + HANDLE hSyncObject; // NT handle to FlipEx fence. + D3DDDI_HDR_METADATA_TYPE HDRMetaDataType; + union + { + D3DDDI_HDR_METADATA_HDR10 HDRMetaDataHDR10; + D3DDDI_HDR_METADATA_HDR10PLUS HDRMetaDataHDR10Plus; + }; + }; + }; + UINT InkCookie; + RECT SourceRect; + UINT DestWidth; + UINT DestHeight; + RECT TargetRect; + // DXGI_MATRIX_3X2_F: _11 _12 _21 _22 _31 _32 + FLOAT Transform[6]; + UINT CustomDuration; + D3DDDI_FLIPINTERVAL_TYPE CustomDurationFlipInterval; + UINT PlaneIndex; +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DDDI_COLOR_SPACE_TYPE ColorSpace; +#endif + D3DKMT_DIRTYREGIONS DirtyRegions; +} D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN; + +// User mode timeout is in milliseconds, kernel mode timeout is in 100 nanoseconds +#define FLIPEX_TIMEOUT_USER (2000) +#define FLIPEX_TIMEOUT_KERNEL (FLIPEX_TIMEOUT_USER*10000) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef struct _D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN +{ + D3DKMT_ALIGN64 ULONG64 hLogicalSurface; +} D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN; +#endif + +// The size of D3DKMT_PRESENTHISTORYTOKEN is fixed since it is part of D3DKMT_PRESENT +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +#define D3DKMT_PRESENTHISTORYTOKEN_SIZE 1080 +#endif + +typedef struct _D3DKMT_PRESENTHISTORYTOKEN +{ + D3DKMT_PRESENT_MODEL Model; + // The size of the present history token in bytes including Model. + // Should be set to zero by when submitting a token. + // It will be initialized when reading present history and can be used to + // go to the next token in the present history buffer. + UINT TokenSize; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + // The binding id as specified by the Composition Surface + UINT64 CompositionBindingId; +#endif + + union + { +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + BYTE MaxSize[1064]; +#endif + D3DKMT_FLIPMODEL_PRESENTHISTORYTOKEN Flip; + D3DKMT_BLTMODEL_PRESENTHISTORYTOKEN Blt; + D3DKMT_VISTABLTMODEL_PRESENTHISTORYTOKEN VistaBlt; + D3DKMT_GDIMODEL_PRESENTHISTORYTOKEN Gdi; + D3DKMT_FENCE_PRESENTHISTORYTOKEN Fence; + D3DKMT_GDIMODEL_SYSMEM_PRESENTHISTORYTOKEN GdiSysMem; + D3DKMT_COMPOSITION_PRESENTHISTORYTOKEN Composition; + D3DKMT_FLIPMANAGER_PRESENTHISTORYTOKEN FlipManager; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_SURFACECOMPLETE_PRESENTHISTORYTOKEN SurfaceComplete; +#endif + } + Token; +} D3DKMT_PRESENTHISTORYTOKEN; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +C_ASSERT(sizeof(D3DKMT_PRESENTHISTORYTOKEN) == D3DKMT_PRESENTHISTORYTOKEN_SIZE); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_PRESENT_RGNS +{ + UINT DirtyRectCount; + D3DKMT_PTR(_Field_size_( DirtyRectCount ) const RECT*, pDirtyRects); + UINT MoveRectCount; + D3DKMT_PTR(_Field_size_( MoveRectCount ) const D3DKMT_MOVE_RECT*, pMoveRects); +}D3DKMT_PRESENT_RGNS; +#endif + +typedef struct _D3DKMT_PRESENT +{ + union + { + D3DKMT_HANDLE hDevice; // in: D3D10 compatibility. + D3DKMT_HANDLE hContext; // in: Indentifies the context + }; + D3DKMT_PTR(HWND, hWindow); // in: window to present to + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPn source ID if RestrictVidPnSource is flagged + D3DKMT_HANDLE hSource; // in: Source allocation to present from + D3DKMT_HANDLE hDestination; // in: Destination allocation whenever non-zero + UINT Color; // in: color value in ARGB 32 bit format + RECT DstRect; // in: unclipped dest rect + RECT SrcRect; // in: unclipped src rect + UINT SubRectCnt; // in: count of sub rects + D3DKMT_PTR(CONST RECT*, pSrcSubRects); // in: sub rects in source space + UINT PresentCount; // in: present counter + D3DDDI_FLIPINTERVAL_TYPE FlipInterval; // in: flip interval + D3DKMT_PRESENTFLAGS Flags; // in: + ULONG BroadcastContextCount; // in: Specifies the number of context + // to broadcast this command buffer to. + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + // broadcast to. + HANDLE PresentLimitSemaphore; + D3DKMT_PRESENTHISTORYTOKEN PresentHistoryToken; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_PRESENT_RGNS* pPresentRegions; +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + union + { + D3DKMT_HANDLE hAdapter; // in: iGpu adapter for PHT redirection. Valid only when the CrossAdapter flag is set. + D3DKMT_HANDLE hIndirectContext; // in: indirect adapter context for redirecting through the DoD present path. Only + // valid if PresentIndirect flag is set. + }; + UINT Duration; // in: Per-present duration. Valid only when the DurationValid flag is set. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DKMT_PTR(_Field_size_(BroadcastContextCount) + D3DKMT_HANDLE*, BroadcastSrcAllocation); // in: LDA + D3DKMT_PTR(_Field_size_opt_(BroadcastContextCount) + D3DKMT_HANDLE*, BroadcastDstAllocation); // in: LDA + UINT PrivateDriverDataSize; // in: + D3DKMT_PTR(_Field_size_bytes_(PrivateDriverDataSize) + PVOID, pPrivateDriverData); // in: Private driver data to pass to DdiPresent and DdiSetVidPnSourceAddress + BOOLEAN bOptimizeForComposition; // out: DWM is involved in composition +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) +} D3DKMT_PRESENT; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +typedef struct _D3DKMT_PRESENT_REDIRECTEDS_FLAGS +{ + union + { + struct + { + UINT Reserved : 32; // 0xFFFFFFFF + }; + UINT Value; + }; +}D3DKMT_PRESENT_REDIRECTED_FLAGS; + +typedef struct _D3DKMT_PRESENT_REDIRECTED +{ + D3DKMT_HANDLE hSyncObj; // in: Sync object PHT waits on + D3DKMT_HANDLE hDevice; // in: Device associated with the present + D3DKMT_ALIGN64 ULONGLONG WaitedFenceValue; // in: Fence value of hSyncObj that PHT waits on + D3DKMT_PRESENTHISTORYTOKEN PresentHistoryToken; + D3DKMT_PRESENT_REDIRECTED_FLAGS Flags; + D3DKMT_HANDLE hSource; // in: Source allocation to present from + UINT PrivateDriverDataSize; // in: + D3DKMT_PTR(_Field_size_bytes_(PrivateDriverDataSize) + PVOID, pPrivateDriverData); // in: Private driver data to pass to DdiPresent and DdiSetVidPnSourceAddress +}D3DKMT_PRESENT_REDIRECTED; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) +typedef struct _D3DKMT_CANCEL_PRESENTS_FLAGS +{ + union + { + // D3DKMT_CANCEL_PRESENTS_OPERATION_REPROGRAM_INTERRUPT flags + struct + { + UINT NewVSyncInterruptState : 1; + UINT Reserved : 31; + } ReprogramInterrupt; + + UINT Value; + }; +}D3DKMT_CANCEL_PRESENTS_FLAGS; + + +typedef enum D3DKMT_CANCEL_PRESENTS_OPERATION +{ + D3DKMT_CANCEL_PRESENTS_OPERATION_CANCEL_FROM = 0, + D3DKMT_CANCEL_PRESENTS_OPERATION_REPROGRAM_INTERRUPT = 1, + D3DKMT_CANCEL_PRESENTS_OPERATION_FLUSH_COMPLETED_PRESENTS = 2 +} D3DKMT_CANCEL_PRESENTS_OPERATION; + +typedef struct _D3DKMT_CANCEL_PRESENTS +{ + UINT cbSize; + D3DKMT_HANDLE hDevice; + D3DKMT_CANCEL_PRESENTS_FLAGS Flags; + D3DKMT_CANCEL_PRESENTS_OPERATION Operation; + D3DKMT_ALIGN64 UINT64 CancelFromPresentId; + LUID CompSurfaceLuid; + D3DKMT_ALIGN64 UINT64 BindId; + HANDLE hFlipManagerProcessedEvent; +}D3DKMT_CANCEL_PRESENTS; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + + +typedef struct _D3DKMT_CREATE_DOORBELL_FLAGS +{ + union + { + struct + { + UINT RequireSecondaryCpuVA : 1; + UINT ResizeRingBufferOperation : 1; + UINT Reserved : 30; + }; + UINT Value; + }; +}D3DKMT_CREATE_DOORBELL_FLAGS; + +typedef struct _D3DKMT_CREATE_DOORBELL +{ + D3DKMT_HANDLE hHwQueue; // in: HWQueue for which doorbell is required + D3DKMT_HANDLE hRingBuffer; // in: Ring buffer allocation handle + D3DKMT_HANDLE hRingBufferControl; // in opt: ring buffer control area allocation handle + D3DKMT_CREATE_DOORBELL_FLAGS Flags; // in opt: flags + _Field_range_(0, D3DDDI_DOORBELL_PRIVATEDATA_MAX_BYTES_WDDM3_1) + UINT PrivateDriverDataSize; // in: Size of private driver data + D3DKMT_PTR(_Field_size_(PrivateDriverDataSize) VOID*, PrivateDriverData); // in/out: Private driver data + D3DKMT_PTR(VOID*, DoorbellCPUVirtualAddress); // out: CPU VA of the created doorbell + D3DKMT_PTR(VOID*, DoorbellSecondaryCPUVirtualAddress); // out opt: Secondary CPU VA of the created doorbell + D3DKMT_PTR(VOID*, DoorbellStatusCPUVirtualAddress); // out: CPU VA of the status page of doorbell + D3DKMT_PTR(VOID*, HwQueueProgressFenceLastQueuedValueCPUVirtualAddress); // out: CPU VA of the location where the UMD will write + // the newly queued progress fence value every time a new + // command buffer is appended to the ring buffer. + D3DKMT_HANDLE hDoorbell; // out: Runtime handle to the newly created doorbell object +}D3DKMT_CREATE_DOORBELL; + +typedef struct _D3DKMT_CONNECT_DOORBELL_FLAGS +{ + union + { + struct + { + UINT Reserved : 32; + }; + UINT Value; + }; +}D3DKMT_CONNECT_DOORBELL_FLAGS; + +typedef struct _D3DKMT_CONNECT_DOORBELL +{ + D3DKMT_HANDLE hDoorbell; // in: UM handle of the doorbell which must be connected + D3DKMT_CONNECT_DOORBELL_FLAGS Flags; +}D3DKMT_CONNECT_DOORBELL; + +typedef struct _D3DKMT_DESTROY_DOORBELL +{ + D3DKMT_HANDLE hDoorbell; // in: UM handle of the doorbell which must be destroyed +}D3DKMT_DESTROY_DOORBELL; + +typedef struct _D3DKMT_NOTIFY_WORK_SUBMISSION_FLAGS +{ + union + { + struct + { + UINT Reserved : 32; + }; + UINT Value; + }; +}D3DKMT_NOTIFY_WORK_SUBMISSION_FLAGS; + +typedef struct _D3DKMT_NOTIFY_WORK_SUBMISSION +{ + D3DKMT_HANDLE hDoorbell; // in: UM handle of doorbell + D3DKMT_NOTIFY_WORK_SUBMISSION_FLAGS Flags; +}D3DKMT_NOTIFY_WORK_SUBMISSION; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) +typedef struct _D3DKMT_ISFEATUREENABLED +{ + D3DKMT_HANDLE hAdapter; + DXGK_FEATURE_ID FeatureId; + DXGK_ISFEATUREENABLED_RESULT Result; +} D3DKMT_ISFEATUREENABLED; +#endif + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +typedef struct _D3DKMT_SUBMITPRESENTBLTTOHWQUEUE +{ + D3DKMT_HANDLE hHwQueue; + D3DKMT_ALIGN64 UINT64 HwQueueProgressFenceId; + D3DKMT_PRESENT PrivatePresentData; +} D3DKMT_SUBMITPRESENTBLTTOHWQUEUE; + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +typedef struct _D3DKMT_SUBMITPRESENTTOHWQUEUE +{ + D3DKMT_PTR(_Field_size_(PrivatePresentData.BroadcastContextCount + 1) + D3DKMT_HANDLE*, hHwQueues); + D3DKMT_PRESENT PrivatePresentData; +} D3DKMT_SUBMITPRESENTTOHWQUEUE; + +#endif + +#define D3DKMT_MAX_MULTIPLANE_OVERLAY_PLANES 8 +#define D3DKMT_MAX_MULTIPLANE_OVERLAY_ALLOCATIONS_PER_PLANE 256 + +typedef enum D3DKMT_MULTIPLANE_OVERLAY_FLAGS +{ + D3DKMT_MULTIPLANE_OVERLAY_FLAG_VERTICAL_FLIP = 0x1, + D3DKMT_MULTIPLANE_OVERLAY_FLAG_HORIZONTAL_FLIP = 0x2, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + D3DKMT_MULTIPLANE_OVERLAY_FLAG_STATIC_CHECK = 0x4, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_0 +} D3DKMT_MULTIPLANE_OVERLAY_FLAGS; + +typedef enum D3DKMT_MULTIPLANE_OVERLAY_BLEND +{ + D3DKMT_MULTIPLANE_OVERLAY_BLEND_OPAQUE = 0x0, + D3DKMT_MULTIPLANE_OVERLAY_BLEND_ALPHABLEND = 0x1, +} D3DKMT_MULTIPLANE_OVERLAY_BLEND; + +typedef enum D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT +{ + D3DKMT_MULIIPLANE_OVERLAY_VIDEO_FRAME_FORMAT_PROGRESSIVE = 0, + D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT_INTERLACED_TOP_FIELD_FIRST = 1, + D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT_INTERLACED_BOTTOM_FIELD_FIRST = 2 +} D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT; + +typedef enum D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAGS +{ + D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAG_NOMINAL_RANGE = 0x1, // 16 - 235 vs. 0 - 255 + D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAG_BT709 = 0x2, // BT.709 vs. BT.601 + D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAG_xvYCC = 0x4, // xvYCC vs. conventional YCbCr +} D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAGS; + +typedef enum D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT +{ + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_MONO = 0, + D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_HORIZONTAL = 1, + D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_VERTICAL = 2, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_SEPARATE = 3, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_MONO_OFFSET = 4, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_ROW_INTERLEAVED = 5, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_COLUMN_INTERLEAVED = 6, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT_CHECKERBOARD = 7 +} D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT; + +typedef enum _DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE +{ + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_NONE = 0, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_FRAME0 = 1, + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_FRAME1 = 2, +} DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE; + +typedef enum _DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY +{ + DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY_BILINEAR = 0x1, // Bilinear + DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY_HIGH = 0x2, // Maximum +} DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY; + +typedef struct D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES +{ + UINT Flags; // D3DKMT_MULTIPLANE_OVERLAY_FLAGS + RECT SrcRect; + RECT DstRect; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + RECT ClipRect; +#endif + D3DDDI_ROTATION Rotation; + D3DKMT_MULTIPLANE_OVERLAY_BLEND Blend; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + UINT DirtyRectCount; + D3DKMT_PTR(RECT*, pDirtyRects); +#else + UINT NumFilters; + D3DKMT_PTR(void*, pFilters); +#endif + D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT VideoFrameFormat; + UINT YCbCrFlags; // D3DKMT_MULTIPLANE_OVERLAY_YCbCr_FLAGS + D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT StereoFormat; + BOOL StereoLeftViewFrame0; + BOOL StereoBaseViewFrame0; + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE StereoFlipMode; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY StretchQuality; +#endif +} D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM_1_3) +typedef struct D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE +{ + D3DKMT_HANDLE hResource; + LUID CompSurfaceLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES PlaneAttributes; +} D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE; + +typedef struct D3DKMT_CHECK_MULTIPLANE_OVERLAY_SUPPORT_RETURN_INFO +{ + union + { + struct + { + UINT FailingPlane : 4; // The 0 based index of the first plane that could not be supported + UINT TryAgain : 1; // The configuration is not supported due to a transition condition, which should shortly go away + UINT Reserved : 27; + }; + UINT Value; + }; +} D3DKMT_CHECK_MULTIPLANE_OVERLAY_SUPPORT_RETURN_INFO; + +typedef struct _D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + UINT PlaneCount; // in : Number of resources to pin + D3DKMT_PTR(D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE*, pOverlayPlanes); // in : Array of resource handles to pin + BOOL Supported; + D3DKMT_CHECK_MULTIPLANE_OVERLAY_SUPPORT_RETURN_INFO ReturnInfo; +} D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM_2_0) +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES2 +{ + UINT Flags; // D3DKMT_MULTIPLANE_OVERLAY_FLAGS + RECT SrcRect; // Specifies the source rectangle, of type RECT, relative to the source resource. + RECT DstRect; // Specifies the destination rectangle, of type RECT, relative to the monitor resolution. + RECT ClipRect; // Specifies any additional clipping, of type RECT, relative to the DstRect rectangle, + // after the data has been stretched according to the values of SrcRect and DstRect. + + // The driver and hardware can use the ClipRect member to apply a common stretch factor + // as the clipping changes when an app occludes part of the DstRect destination rectangle. + D3DDDI_ROTATION Rotation; // Specifies the clockwise rotation of the overlay plane, given as a value from the D3DDDI_ROTATION enumeration. + D3DKMT_MULTIPLANE_OVERLAY_BLEND Blend; // Specifies the blend mode that applies to this overlay plane and the plane beneath it, given as a value from the DXGK_MULTIPLANE_OVERLAY_BLEND enumeration. + UINT DirtyRectCount; + D3DKMT_PTR(RECT*, pDirtyRects); + D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT VideoFrameFormat; // DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT + D3DDDI_COLOR_SPACE_TYPE ColorSpace; + D3DKMT_MULTIPLANE_OVERLAY_STEREO_FORMAT StereoFormat; // DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT + BOOL StereoLeftViewFrame0; // Reserved for system use. Must always be FALSE. + BOOL StereoBaseViewFrame0; // Reserved for system use. Must always be FALSE. + DXGKMT_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE StereoFlipMode; // DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE + DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY StretchQuality; // DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY + UINT Reserved1; +} D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES2; + +typedef struct _D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE2 +{ + UINT LayerIndex; + D3DKMT_HANDLE hResource; + LUID CompSurfaceLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES2 PlaneAttributes; +} D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE2; + +typedef struct _D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT2 +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in : Indentifies the device + UINT PlaneCount; // in : Number of resources to pin + D3DKMT_PTR(D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE2*, pOverlayPlanes); // in : Array of resource handles to pin + BOOL Supported; + D3DKMT_CHECK_MULTIPLANE_OVERLAY_SUPPORT_RETURN_INFO ReturnInfo; +} D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT2; + +typedef struct _D3DKMT_MULTIPLANE_OVERLAY2 +{ + UINT LayerIndex; + BOOL Enabled; + D3DKMT_HANDLE hAllocation; + D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES2 PlaneAttributes; +} D3DKMT_MULTIPLANE_OVERLAY2; + +typedef struct _D3DKMT_PRESENT_MULTIPLANE_OVERLAY2 +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + union + { + D3DKMT_HANDLE hDevice; // in: D3D10 compatibility. + D3DKMT_HANDLE hContext; // in: Indentifies the context + }; + ULONG BroadcastContextCount; // in: Specifies the number of context + // to broadcast this command buffer to. + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + // broadcast to. + + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPn source ID if RestrictVidPnSource is flagged + UINT PresentCount; // in: present counter + D3DDDI_FLIPINTERVAL_TYPE FlipInterval; // in: flip interval + D3DKMT_PRESENTFLAGS Flags; // in: + + UINT PresentPlaneCount; + D3DKMT_PTR(D3DKMT_MULTIPLANE_OVERLAY2*, pPresentPlanes); + UINT Duration; +} D3DKMT_PRESENT_MULTIPLANE_OVERLAY2; +#endif // DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES3 +{ + UINT Flags; // D3DKMT_MULTIPLANE_OVERLAY_FLAGS + RECT SrcRect; // Specifies the source rectangle, of type RECT, relative to the source resource. + RECT DstRect; // Specifies the destination rectangle, of type RECT, relative to the monitor resolution. + RECT ClipRect; // Specifies any additional clipping, of type RECT, relative to the DstRect rectangle, + // after the data has been stretched according to the values of SrcRect and DstRect. + + // The driver and hardware can use the ClipRect member to apply a common stretch factor + // as the clipping changes when an app occludes part of the DstRect destination rectangle. + D3DDDI_ROTATION Rotation; // Specifies the clockwise rotation of the overlay plane, given as a value from the D3DDDI_ROTATION enumeration. + D3DKMT_MULTIPLANE_OVERLAY_BLEND Blend; // Specifies the blend mode that applies to this overlay plane and the plane beneath it, given as a value from the DXGK_MULTIPLANE_OVERLAY_BLEND enumeration. + UINT DirtyRectCount; + D3DKMT_PTR(_Field_size_(DirtyRectCount) RECT*, pDirtyRects); + D3DDDI_COLOR_SPACE_TYPE ColorSpace; + DXGKMT_MULTIPLANE_OVERLAY_STRETCH_QUALITY StretchQuality; // DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + UINT SDRWhiteLevel; +#endif +} D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES3; + +typedef struct _D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE3 +{ + UINT LayerIndex; + D3DKMT_HANDLE hResource; + LUID CompSurfaceLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_PTR(D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES3*, pPlaneAttributes); +} D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE3; + +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_FLAGS +{ + union + { + struct + { + UINT VerticalFlip : 1; // 0x00000001 + UINT HorizontalFlip : 1; // 0x00000002 + UINT Reserved :30; // 0xFFFFFFFC + }; + UINT Value; + }; +} D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_FLAGS; + +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION +{ + D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_FLAGS Flags; + RECT SrcRect; + RECT DstRect; + D3DDDI_ROTATION Rotation; +} D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION; + +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_WITH_SOURCE +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION PostComposition; +} D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_WITH_SOURCE; + +typedef struct _D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT3 +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in : Indentifies the device + UINT PlaneCount; // in : Number of resources to pin + // Note: Array-of-pointers don't work in 32bit WSL + _Field_size_(PlaneCount) + D3DKMT_CHECK_MULTIPLANE_OVERLAY_PLANE3** ppOverlayPlanes; // in : Array of pointers to overlay planes + UINT PostCompositionCount; // in : Number of resources to pin + _Field_size_(PostCompositionCount) + D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION_WITH_SOURCE** ppPostComposition; // in : Array of pointers to overlay planes + BOOL Supported; + D3DKMT_CHECK_MULTIPLANE_OVERLAY_SUPPORT_RETURN_INFO ReturnInfo; +} D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT3; + +typedef struct _D3DKMT_PLANE_SPECIFIC_INPUT_FLAGS +{ + union + { + struct + { + UINT Enabled : 1; // 0x00000001 + UINT Reserved :31; // 0xFFFFFFFE + }; + UINT Value; + }; +} D3DKMT_PLANE_SPECIFIC_INPUT_FLAGS; + +typedef struct _D3DKMT_PLANE_SPECIFIC_OUTPUT_FLAGS +{ + union + { + struct + { + UINT FlipConvertedToImmediate : 1; // 0x00000001 + UINT Reserved :31; // 0xFFFFFFFE + }; + UINT Value; + }; +} D3DKMT_PLANE_SPECIFIC_OUTPUT_FLAGS; + +typedef struct _D3DKMT_MULTIPLANE_OVERLAY3 +{ + UINT LayerIndex; + D3DKMT_PLANE_SPECIFIC_INPUT_FLAGS InputFlags; + D3DDDI_FLIPINTERVAL_TYPE FlipInterval; + UINT MaxImmediateFlipLine; + UINT AllocationCount; + D3DKMT_PTR(_Field_size_(AllocationCount) + D3DKMT_HANDLE*, pAllocationList); + UINT DriverPrivateDataSize; + D3DKMT_PTR(_Field_size_bytes_(DriverPrivateDataSize) + VOID*, pDriverPrivateData); + D3DKMT_PTR(const D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES3*, pPlaneAttributes); + D3DKMT_HANDLE hFlipToFence; + D3DKMT_HANDLE hFlipAwayFence; + D3DKMT_ALIGN64 UINT64 FlipToFenceValue; + D3DKMT_ALIGN64 UINT64 FlipAwayFenceValue; +} D3DKMT_MULTIPLANE_OVERLAY3; + +typedef struct _D3DKMT_PRESENT_MULTIPLANE_OVERLAY_FLAGS +{ + union + { + struct + { + UINT FlipStereo : 1; // 0x00000001 This is a flip from a stereo alloc. Used in addition to FlipImmediate or FlipOnNextVSync. + UINT FlipStereoTemporaryMono : 1; // 0x00000002 This is a flip from a stereo alloc. The left image should used. Used in addition to FlipImmediate or FlipOnNextVSync. + UINT FlipStereoPreferRight : 1; // 0x00000004 This is a flip from a stereo alloc. The right image should used when cloning to a mono monitor. Used in addition to FlipImmediate or FlipOnNextVSync. + UINT FlipDoNotWait : 1; // 0x00000008 + UINT FlipDoNotFlip : 1; // 0x00000010 + UINT FlipRestart : 1; // 0x00000020 + UINT DurationValid : 1; // 0x00000040 + UINT HDRMetaDataValid : 1; // 0x00000080 + UINT HMD : 1; // 0x00000100 + UINT TrueImmediate : 1; // 0x00000200 If a present interval is 0, allow tearing rather than override a previously queued flip + UINT FromDDisplay : 1; // 0x00000400 The flip is from DDisplay + UINT IndirectDisplay : 1; // 0x00000800 + UINT Reserved :20; // 0xFFFFF000 + }; + UINT Value; + }; +} D3DKMT_PRESENT_MULTIPLANE_OVERLAY_FLAGS; + +typedef struct _D3DKMT_PRESENT_MULTIPLANE_OVERLAY3 +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + UINT ContextCount; + D3DKMT_PTR(_Field_size_(ContextCount) + D3DKMT_HANDLE*, pContextList); + + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPn source ID if RestrictVidPnSource is flagged + UINT PresentCount; // in: present counter + D3DKMT_PRESENT_MULTIPLANE_OVERLAY_FLAGS Flags; // in: + + UINT PresentPlaneCount; + // Note: Array-of-pointers don't work in 32bit WSL + _Field_size_(PresentPlaneCount) + D3DKMT_MULTIPLANE_OVERLAY3** ppPresentPlanes; + D3DKMT_PTR(D3DKMT_MULTIPLANE_OVERLAY_POST_COMPOSITION*, pPostComposition); + UINT Duration; + D3DDDI_HDR_METADATA_TYPE HDRMetaDataType; + UINT HDRMetaDataSize; + D3DKMT_PTR(_Field_size_bytes_(HDRMetaDataSize) + const VOID*, pHDRMetaData); + UINT BoostRefreshRateMultiplier; +} D3DKMT_PRESENT_MULTIPLANE_OVERLAY3; +#endif // DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) +typedef struct _D3DKMT_MULTIPLANE_OVERLAY_CAPS +{ + union + { + struct + { + UINT Rotation : 1; // Full rotation + UINT RotationWithoutIndependentFlip : 1; // Rotation, but without simultaneous IndependentFlip support + UINT VerticalFlip : 1; // Can flip the data vertically + UINT HorizontalFlip : 1; // Can flip the data horizontally + UINT StretchRGB : 1; // Supports stretching RGB formats + UINT StretchYUV : 1; // Supports stretching YUV formats + UINT BilinearFilter : 1; // Blinear filtering + UINT HighFilter : 1; // Better than bilinear filtering + UINT Shared : 1; // MPO resources are shared across VidPnSources + UINT Immediate : 1; // Immediate flip support + UINT Plane0ForVirtualModeOnly : 1; // Stretching plane 0 will also stretch the HW cursor and should only be used for virtual mode support + UINT Version3DDISupport : 1; // Driver supports the 2.2 MPO DDIs + UINT Reserved : 20; + }; + UINT Value; + }; +} D3DKMT_MULTIPLANE_OVERLAY_CAPS; + +typedef struct _D3DKMT_GET_MULTIPLANE_OVERLAY_CAPS +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in + UINT MaxPlanes; // out: Total number of planes currently supported + UINT MaxRGBPlanes; // out: Number of RGB planes currently supported + UINT MaxYUVPlanes; // out: Number of YUV planes currently supported + D3DKMT_MULTIPLANE_OVERLAY_CAPS OverlayCaps; // out: Overlay capabilities + float MaxStretchFactor; // out + float MaxShrinkFactor; // out +} D3DKMT_GET_MULTIPLANE_OVERLAY_CAPS; + +typedef struct _D3DKMT_GET_POST_COMPOSITION_CAPS +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in + float MaxStretchFactor; // out + float MaxShrinkFactor; // out +} D3DKMT_GET_POST_COMPOSITION_CAPS; + +typedef struct _D3DKMT_MULTIPLANEOVERLAY_STRETCH_SUPPORT +{ + UINT VidPnSourceId; + BOOL Update; + BOOL Supported; +} D3DKMT_MULTIPLANEOVERLAY_STRETCH_SUPPORT; +#endif // DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2 + +typedef struct D3DKMT_MULTIPLANE_OVERLAY +{ + UINT LayerIndex; + BOOL Enabled; + D3DKMT_HANDLE hAllocation; + D3DKMT_MULTIPLANE_OVERLAY_ATTRIBUTES PlaneAttributes; +} D3DKMT_MULTIPLANE_OVERLAY; + +typedef struct D3DKMT_PRESENT_MULTIPLANE_OVERLAY +{ + union + { + D3DKMT_HANDLE hDevice; // in: D3D10 compatibility. + D3DKMT_HANDLE hContext; // in: Indentifies the context + }; + ULONG BroadcastContextCount; // in: Specifies the number of context + // to broadcast this command buffer to. + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + // broadcast to. + + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPn source ID if RestrictVidPnSource is flagged + UINT PresentCount; // in: present counter + D3DDDI_FLIPINTERVAL_TYPE FlipInterval; // in: flip interval + D3DKMT_PRESENTFLAGS Flags; // in: + + UINT PresentPlaneCount; + D3DKMT_MULTIPLANE_OVERLAY* pPresentPlanes; + UINT Duration; +} D3DKMT_PRESENT_MULTIPLANE_OVERLAY; + +typedef struct _D3DKMT_RENDERFLAGS +{ + UINT ResizeCommandBuffer : 1; // 0x00000001 + UINT ResizeAllocationList : 1; // 0x00000002 + UINT ResizePatchLocationList : 1; // 0x00000004 + UINT NullRendering : 1; // 0x00000008 + UINT PresentRedirected : 1; // 0x00000010 + UINT RenderKm : 1; // 0x00000020 Cannot be used with DxgkRender + UINT RenderKmReadback : 1; // 0x00000040 Cannot be used with DxgkRender + UINT Reserved : 25; // 0xFFFFFF80 +} D3DKMT_RENDERFLAGS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_OUTPUTDUPLPRESENTFLAGS +{ + union + { + struct + { + UINT ProtectedContentBlankedOut : 1; + UINT RemoteSession : 1; + UINT FullScreenPresent : 1; + UINT PresentIndirect : 1; + UINT Reserved : 28; + }; + UINT Value; + }; +}D3DKMT_OUTPUTDUPLPRESENTFLAGS; + +typedef struct _D3DKMT_OUTPUTDUPLPRESENT +{ + D3DKMT_HANDLE hContext; // in: Indentifies the context + D3DKMT_HANDLE hSource; // in: Source allocation to present from + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + ULONG BroadcastContextCount; // in: Specifies the number of context + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + D3DKMT_PRESENT_RGNS PresentRegions; // in: Dirty and move regions + D3DKMT_OUTPUTDUPLPRESENTFLAGS Flags; + D3DKMT_HANDLE hIndirectContext; +} D3DKMT_OUTPUTDUPLPRESENT; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + +typedef struct _D3DKMT_OUTPUTDUPLPRESENTTOHWQUEUE +{ + D3DKMT_HANDLE hSource; // in: Source allocation to present from + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + ULONG BroadcastHwQueueCount; + D3DKMT_PTR(_Field_size_(BroadcastHwQueueCount) + D3DKMT_HANDLE*, hHwQueues); + D3DKMT_PRESENT_RGNS PresentRegions; // in: Dirty and move regions + D3DKMT_OUTPUTDUPLPRESENTFLAGS Flags; + D3DKMT_HANDLE hIndirectHwQueue; +} D3DKMT_OUTPUTDUPLPRESENTTOHWQUEUE; + +#endif + +typedef struct _D3DKMT_RENDER +{ + union + { + D3DKMT_HANDLE hDevice; // in: D3D10 compatibility. + D3DKMT_HANDLE hContext; // in: Indentifies the context + }; + UINT CommandOffset; // in: offset in bytes from start + UINT CommandLength; // in: number of bytes + UINT AllocationCount; // in: Number of allocations in allocation list. + UINT PatchLocationCount; // in: Number of patch locations in patch allocation list. + D3DKMT_PTR(VOID*, pNewCommandBuffer); // out: Pointer to the next command buffer to use. + // in: When RenderKm flag is set, it points to a command buffer. + UINT NewCommandBufferSize; // in: Size requested for the next command buffer. + // out: Size of the next command buffer to use. + D3DKMT_PTR(D3DDDI_ALLOCATIONLIST*, pNewAllocationList); // out: Pointer to the next allocation list to use. + // in: When RenderKm flag is set, it points to an allocation list. + UINT NewAllocationListSize; // in: Size requested for the next allocation list. + // out: Size of the new allocation list. + D3DKMT_PTR(D3DDDI_PATCHLOCATIONLIST*, pNewPatchLocationList); // out: Pointer to the next patch location list. + UINT NewPatchLocationListSize; // in: Size requested for the next patch location list. + // out: Size of the new patch location list. + D3DKMT_RENDERFLAGS Flags; // in: + D3DKMT_ALIGN64 ULONGLONG PresentHistoryToken; // in: Present history token for redirected present calls + ULONG BroadcastContextCount; // in: Specifies the number of context + // to broadcast this command buffer to. + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; // in: Specifies the handle of the context to + // broadcast to. + ULONG QueuedBufferCount; // out: Number of DMA buffer queued to this context after this submission. + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS NewCommandBuffer; // out: GPU virtual address of next command buffer to use. _ADVSCH_ + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: pointer to private driver data. _ADVSCH_ + UINT PrivateDriverDataSize; // in: size of private driver data. _ADVSCH_ +} D3DKMT_RENDER; + + +typedef enum _D3DKMT_STANDARDALLOCATIONTYPE +{ + D3DKMT_STANDARDALLOCATIONTYPE_EXISTINGHEAP = 1, + D3DKMT_STANDARDALLOCATIONTYPE_INTERNALBACKINGSTORE = 2, + D3DKMT_STANDARDALLOCATIONTYPE_MAX, +} D3DKMT_STANDARDALLOCATIONTYPE; + +typedef struct _D3DKMT_STANDARDALLOCATION_EXISTINGHEAP +{ + D3DKMT_ALIGN64 D3DKMT_SIZE_T Size; // in: Size in bytes of existing heap +} D3DKMT_STANDARDALLOCATION_EXISTINGHEAP; + +typedef struct _D3DKMT_CREATESTANDARDALLOCATIONFLAGS +{ + union + { + struct + { + UINT Reserved : 32; // 0xFFFFFFFF + }; + UINT Value; + }; +} D3DKMT_CREATESTANDARDALLOCATIONFLAGS; + +typedef struct _D3DKMT_CREATESTANDARDALLOCATION +{ + // + // update onecoreuap/windows/core/ntuser/inc/whwin32.tpl when adding new memeber + // to this struct + // + D3DKMT_STANDARDALLOCATIONTYPE Type; + union + { + D3DKMT_STANDARDALLOCATION_EXISTINGHEAP ExistingHeapData; + }; + D3DKMT_CREATESTANDARDALLOCATIONFLAGS Flags; +} D3DKMT_CREATESTANDARDALLOCATION; + +typedef struct _D3DKMT_CREATEALLOCATIONFLAGS +{ + UINT CreateResource : 1; // 0x00000001 + UINT CreateShared : 1; // 0x00000002 + UINT NonSecure : 1; // 0x00000004 + UINT CreateProtected : 1; // 0x00000008 Cannot be used when allocation is created from the user mode. + UINT RestrictSharedAccess : 1; // 0x00000010 + UINT ExistingSysMem : 1; // 0x00000020 Cannot be used when allocation is created from the user mode. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + UINT NtSecuritySharing : 1; // 0x00000040 + UINT ReadOnly : 1; // 0x00000080 + UINT CreateWriteCombined : 1; // 0x00000100 Cannot be used when allocation is created from the user mode. + UINT CreateCached : 1; // 0x00000200 Cannot be used when allocation is created from the user mode. + UINT SwapChainBackBuffer : 1; // 0x00000400 Specifies whether an allocation corresponds to a swap chain back buffer. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + UINT CrossAdapter : 1; // 0x00000800 + UINT OpenCrossAdapter : 1; // 0x00001000 Cannot be used when allocation is created from the user mode. + UINT PartialSharedCreation : 1; // 0x00002000 + UINT Zeroed : 1; // 0x00004000 // out: set when allocation fulfilled by zero pages + UINT WriteWatch : 1; // 0x00008000 // in: request Mm to track writes to pages of this allocation +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + UINT StandardAllocation : 1; // 0x00010000 // in: use pStandardAllocation instead of pPrivateDriverData + UINT ExistingSection : 1; // 0x00020000 // in: Use Section Handle instead of SysMem in D3DDI_ALLOCATIONINFO2 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + UINT AllowNotZeroed : 1; // 0x00040000 // in: indicate zeroed pages are not required +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + UINT PhysicallyContiguous : 1; // 0x00080000 // in: indicate allocation must be physically contguous + UINT NoKmdAccess : 1; // 0x00100000 // in: KMD is not notified about the allocation +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + UINT SharedDisplayable : 1; // 0x00200000 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + UINT NoImplicitSynchronization : 1; // 0x00400000 // in: request that kernel shouldn't do any implicit synchronization for this allocation + UINT Reserved : 9; // 0xFF800000 +#else + UINT Reserved : 10; // 0xFFC00000 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) +#else + UINT Reserved : 11; // 0xFFE00000 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) +#else + UINT Reserved : 13; // 0xFFF80000 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) +#else + UINT Reserved : 14; // 0xFFFC0000 +#endif //(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) +#else + UINT Reserved : 16; // 0xFFFF0000 +#endif //(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +#else + UINT Reserved : 21; // 0xFFFFF800 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) +#else + UINT Reserved : 26; // 0xFFFFFFC0 +#endif +} D3DKMT_CREATEALLOCATIONFLAGS; + +typedef struct _D3DKMT_CREATEALLOCATION +{ + D3DKMT_HANDLE hDevice; + D3DKMT_HANDLE hResource; //in/out:valid only within device + D3DKMT_HANDLE hGlobalShare; //out:Shared handle if CreateShared and not NtSecuritySharing + D3DKMT_PTR(_Field_size_bytes_(PrivateRuntimeDataSize) + CONST VOID*, pPrivateRuntimeData); + UINT PrivateRuntimeDataSize; + union + { + // + // update onecoreuap/windows/core/ntuser/inc/whwin32.tpl when adding new memeber + // to this union + // + D3DKMT_CREATESTANDARDALLOCATION* pStandardAllocation; + _Field_size_bytes_(PrivateDriverDataSize) + CONST VOID* pPrivateDriverData; + D3DKMT_PTR_HELPER( AlignUnionTo64_1) + }; + UINT PrivateDriverDataSize; + UINT NumAllocations; + union + { + _Field_size_(NumAllocations) D3DDDI_ALLOCATIONINFO* pAllocationInfo; +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN7) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN7)) + _Field_size_(NumAllocations) D3DDDI_ALLOCATIONINFO2* pAllocationInfo2; // _ADVSCH_ +#endif + D3DKMT_PTR_HELPER( AlignUnionTo64_2) + }; + D3DKMT_CREATEALLOCATIONFLAGS Flags; + D3DKMT_PTR(HANDLE, hPrivateRuntimeResourceHandle); // opaque handle used for event tracing +} D3DKMT_CREATEALLOCATION; + +typedef struct _D3DKMT_OPENRESOURCE +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + D3DKMT_HANDLE hGlobalShare; // in : Shared resource handle + UINT NumAllocations; // in : Number of allocations associated with the resource + union { + _Field_size_(NumAllocations) D3DDDI_OPENALLOCATIONINFO* pOpenAllocationInfo; // in : Array of open allocation structs +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN7) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN7)) + _Field_size_(NumAllocations) D3DDDI_OPENALLOCATIONINFO2* pOpenAllocationInfo2; // in : Array of open allocation structs // _ADVSCH_ +#endif + D3DKMT_PTR_HELPER(AlignUnionTo64) + }; + D3DKMT_PTR(_Field_size_bytes_(PrivateRuntimeDataSize) VOID*, pPrivateRuntimeData); // in : Caller supplied buffer where the runtime private data associated with this resource will be copied + UINT PrivateRuntimeDataSize; // in : Size in bytes of the pPrivateRuntimeData buffer + D3DKMT_PTR(_Field_size_bytes_(ResourcePrivateDriverDataSize) VOID*, pResourcePrivateDriverData); // in : Caller supplied buffer where the driver private data associated with the resource will be copied + UINT ResourcePrivateDriverDataSize; // in : Size in bytes of the pResourcePrivateDriverData buffer + D3DKMT_PTR(_Field_size_bytes_(TotalPrivateDriverDataBufferSize) VOID*, pTotalPrivateDriverDataBuffer); // in : Caller supplied buffer where the Driver private data will be stored + UINT TotalPrivateDriverDataBufferSize; // in/out : Size in bytes of pTotalPrivateDriverDataBuffer / Size in bytes of data written to pTotalPrivateDriverDataBuffer + D3DKMT_HANDLE hResource; // out : Handle for this resource in this process +}D3DKMT_OPENRESOURCE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_OPENRESOURCEFROMNTHANDLE +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + D3DKMT_PTR( HANDLE, hNtHandle); // in : Process's NT handle + UINT NumAllocations; // in : Number of allocations associated with the resource + D3DKMT_PTR(_Field_size_(NumAllocations) D3DDDI_OPENALLOCATIONINFO2*, pOpenAllocationInfo2); // in : Array of open allocation structs // _ADVSCH_ + UINT PrivateRuntimeDataSize; // in : Size in bytes of the pPrivateRuntimeData buffer + D3DKMT_PTR(_Field_size_bytes_(PrivateRuntimeDataSize) VOID*, pPrivateRuntimeData); // in : Caller supplied buffer where the runtime private data associated with this resource will be copied + UINT ResourcePrivateDriverDataSize; // in : Size in bytes of the pResourcePrivateDriverData buffer + D3DKMT_PTR(_Field_size_bytes_(ResourcePrivateDriverDataSize) VOID*, pResourcePrivateDriverData); // in : Caller supplied buffer where the driver private data associated with the resource will be copied + UINT TotalPrivateDriverDataBufferSize; // in/out : Size in bytes of pTotalPrivateDriverDataBuffer / Size in bytes of data written to pTotalPrivateDriverDataBuffer + D3DKMT_PTR(_Field_size_bytes_(TotalPrivateDriverDataBufferSize) VOID*, pTotalPrivateDriverDataBuffer); // in : Caller supplied buffer where the Driver private data will be stored + D3DKMT_HANDLE hResource; // out : Handle for this resource in this process + + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process + D3DKMT_PTR(_In_reads_bytes_opt_(PrivateRuntimeDataSize) VOID*, pKeyedMutexPrivateRuntimeData); // in: Buffer containing initial private data. + // If NULL then PrivateRuntimeDataSize must be 0. + // It will only be copied if the keyed mutex does not already have private data. + UINT KeyedMutexPrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. + D3DKMT_HANDLE hSyncObject; // out: Handle to sync object in this process. +} D3DKMT_OPENRESOURCEFROMNTHANDLE; + +typedef struct _D3DKMT_OPENSYNCOBJECTFROMNTHANDLE +{ + D3DKMT_PTR(HANDLE, hNtHandle); // in : NT handle for the sync object. + D3DKMT_HANDLE hSyncObject; // out: Handle to sync object in this process. +} D3DKMT_OPENSYNCOBJECTFROMNTHANDLE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_OPENSYNCOBJECTFROMNTHANDLE2 +{ + D3DKMT_PTR(HANDLE, hNtHandle); // in : NT handle for the sync object. + D3DKMT_HANDLE hDevice; // in : Device handle to use this sync object on. + D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS Flags; // in : specifies sync object behavior for this device. + D3DKMT_HANDLE hSyncObject; // out: Handle to sync object in this process. + + union + { + + struct + { + D3DKMT_PTR(VOID*, FenceValueCPUVirtualAddress); // out: Read-only mapping of the fence value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS FenceValueGPUVirtualAddress; // out: Read/write mapping of the fence value for the GPU + UINT EngineAffinity; // in: Defines physical adapters where the GPU VA should be mapped + } MonitoredFence; + + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; + +} D3DKMT_OPENSYNCOBJECTFROMNTHANDLE2; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_OPENNATIVEFENCEFROMNTHANDLE +{ + D3DKMT_PTR(HANDLE, hNtHandle); // in : NT handle for the shared fence object. + D3DKMT_HANDLE hDevice; // in : Device handle to open this fence object on. + UINT EngineAffinity; // in: Defines physical adapters where the GPU VA is mapped + D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS Flags; // in: Flags. + D3DKMT_HANDLE hSyncObject; // out: Handle to the opened fence object + D3DDDI_NATIVEFENCEMAPPING NativeFenceMapping; // out: process mapping information for the fence object + BYTE PrivateDriverData[D3DDDI_NATIVE_FENCE_PDD_SIZE]; // in/out: Private driver data to pass to KMD DdiOpenNativeFence call and copy back to UMD + BYTE Reserved[32]; +} D3DKMT_OPENNATIVEFENCEFROMNTHANDLE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_OPENSYNCOBJECTNTHANDLEFROMNAME +{ + DWORD dwDesiredAccess; + D3DKMT_PTR(OBJECT_ATTRIBUTES*, pObjAttrib); + D3DKMT_PTR(HANDLE, hNtHandle); +} D3DKMT_OPENSYNCOBJECTNTHANDLEFROMNAME; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +typedef struct _D3DKMT_OPENNTHANDLEFROMNAME +{ + DWORD dwDesiredAccess; + D3DKMT_PTR(OBJECT_ATTRIBUTES*, pObjAttrib); + D3DKMT_PTR(HANDLE, hNtHandle); +} D3DKMT_OPENNTHANDLEFROMNAME; + +#define SHARED_ALLOCATION_WRITE 0x1 +#define SHARED_ALLOCATION_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SHARED_ALLOCATION_WRITE) + +typedef struct _D3DKMT_QUERYRESOURCEINFOFROMNTHANDLE +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + D3DKMT_PTR(HANDLE, hNtHandle); // in : Global resource handle to open + D3DKMT_PTR(VOID*, pPrivateRuntimeData); // in : Ptr to buffer that will receive runtime private data for the resource + UINT PrivateRuntimeDataSize; // in/out : Size in bytes of buffer passed in for runtime private data / If pPrivateRuntimeData was NULL then size in bytes of buffer required for the runtime private data otherwise size in bytes of runtime private data copied into the buffer + UINT TotalPrivateDriverDataSize; // out : Size in bytes of buffer required to hold all the DriverPrivate data for all of the allocations associated withe the resource + UINT ResourcePrivateDriverDataSize; // out : Size in bytes of the driver's resource private data + UINT NumAllocations; // out : Number of allocations associated with this resource +}D3DKMT_QUERYRESOURCEINFOFROMNTHANDLE; + +#endif + +typedef struct _D3DKMT_QUERYRESOURCEINFO +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + D3DKMT_HANDLE hGlobalShare; // in : Global resource handle to open + D3DKMT_PTR(VOID*, pPrivateRuntimeData); // in : Ptr to buffer that will receive runtime private data for the resource + UINT PrivateRuntimeDataSize; // in/out : Size in bytes of buffer passed in for runtime private data / If pPrivateRuntimeData was NULL then size in bytes of buffer required for the runtime private data otherwise size in bytes of runtime private data copied into the buffer + UINT TotalPrivateDriverDataSize; // out : Size in bytes of buffer required to hold all the DriverPrivate data for all of the allocations associated withe the resource + UINT ResourcePrivateDriverDataSize; // out : Size in bytes of the driver's resource private data + UINT NumAllocations; // out : Number of allocations associated with this resource +}D3DKMT_QUERYRESOURCEINFO; + +typedef struct _D3DKMT_DESTROYALLOCATION +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hResource; + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocationList); // in: pointer to an array allocation handles to destroy + UINT AllocationCount; // in: Number of allocations in phAllocationList +} D3DKMT_DESTROYALLOCATION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_DESTROYALLOCATION2 +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hResource; + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocationList); // in: pointer to an array allocation handles to destroy + UINT AllocationCount; // in: Number of allocations in phAllocationList + D3DDDICB_DESTROYALLOCATION2FLAGS Flags; // in: Bit field defined by D3DDDICB_DESTROYALLOCATION2FLAGS +} D3DKMT_DESTROYALLOCATION2; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +typedef struct _D3DKMT_SETALLOCATIONPRIORITY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hResource; // in: Specify the resource to set priority to. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocationList); // in: pointer to an array allocation handles to destroy + UINT AllocationCount; // in: Number of allocations in phAllocationList + D3DKMT_PTR(CONST UINT*, pPriorities); // in: New priority for each of the allocation in the array. +} D3DKMT_SETALLOCATIONPRIORITY; + +typedef enum _D3DKMT_ALLOCATIONRESIDENCYSTATUS +{ + D3DKMT_ALLOCATIONRESIDENCYSTATUS_RESIDENTINGPUMEMORY=1, + D3DKMT_ALLOCATIONRESIDENCYSTATUS_RESIDENTINSHAREDMEMORY=2, + D3DKMT_ALLOCATIONRESIDENCYSTATUS_NOTRESIDENT=3, +} D3DKMT_ALLOCATIONRESIDENCYSTATUS; + +typedef struct _D3DKMT_QUERYALLOCATIONRESIDENCY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hResource; // in: pointer to resource owning the list of allocation. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocationList); // in: pointer to an array allocation to get residency status. + UINT AllocationCount; // in: Number of allocations in phAllocationList + D3DKMT_PTR(D3DKMT_ALLOCATIONRESIDENCYSTATUS*, pResidencyStatus); // out: Residency status of each allocation in the array. +} D3DKMT_QUERYALLOCATIONRESIDENCY; + +typedef struct _D3DKMT_GETRUNTIMEDATA +{ + D3DKMT_HANDLE hAdapter; + D3DKMT_HANDLE hGlobalShare; // in: shared handle + D3DKMT_PTR(VOID*, pRuntimeData); // out: in: for a version? + UINT RuntimeDataSize; // in: +} D3DKMT_GETRUNTIMEDATA; + +typedef enum _KMTUMDVERSION +{ + KMTUMDVERSION_DX9 = 0, + KMTUMDVERSION_DX10, + KMTUMDVERSION_DX11, + KMTUMDVERSION_DX12, + KMTUMDVERSION_DX12_WSA32, + KMTUMDVERSION_DX12_WSA64, + NUM_KMTUMDVERSIONS +} KMTUMDVERSION; + +typedef struct _D3DKMT_UMDFILENAMEINFO +{ + KMTUMDVERSION Version; // In: UMD version + WCHAR UmdFileName[MAX_PATH]; // Out: UMD file name +} D3DKMT_UMDFILENAMEINFO; + +#define D3DKMT_COMPONENTIZED_INDICATOR L'#' +#define D3DKMT_SUBKEY_DX9 L"DX9" +#define D3DKMT_SUBKEY_OPENGL L"OpenGL" + +typedef struct _D3DKMT_OPENGLINFO +{ + WCHAR UmdOpenGlIcdFileName[MAX_PATH]; + ULONG Version; + ULONG Flags; +} D3DKMT_OPENGLINFO; + +typedef struct _D3DKMT_SEGMENTSIZEINFO +{ + D3DKMT_ALIGN64 ULONGLONG DedicatedVideoMemorySize; + D3DKMT_ALIGN64 ULONGLONG DedicatedSystemMemorySize; + D3DKMT_ALIGN64 ULONGLONG SharedSystemMemorySize; +} D3DKMT_SEGMENTSIZEINFO; + +typedef struct _D3DKMT_SEGMENTGROUPSIZEINFO +{ + UINT32 PhysicalAdapterIndex; + D3DKMT_SEGMENTSIZEINFO LegacyInfo; + D3DKMT_ALIGN64 ULONGLONG LocalMemory; + D3DKMT_ALIGN64 ULONGLONG NonLocalMemory; + D3DKMT_ALIGN64 ULONGLONG NonBudgetMemory; +} D3DKMT_SEGMENTGROUPSIZEINFO; + +typedef struct _D3DKMT_WORKINGSETFLAGS +{ + UINT UseDefault : 1; // 0x00000001 + UINT Reserved : 31; // 0xFFFFFFFE +} D3DKMT_WORKINGSETFLAGS; + +typedef struct _D3DKMT_WORKINGSETINFO +{ + D3DKMT_WORKINGSETFLAGS Flags; + ULONG MinimumWorkingSetPercentile; + ULONG MaximumWorkingSetPercentile; +} D3DKMT_WORKINGSETINFO; + +typedef struct _D3DKMT_FLIPINFOFLAGS +{ + UINT FlipInterval : 1; // 0x00000001 // Set when kmd driver support FlipInterval natively + UINT Reserved : 31; // 0xFFFFFFFE +} D3DKMT_FLIPINFOFLAGS; + +typedef struct _D3DKMT_FLIPQUEUEINFO +{ + UINT MaxHardwareFlipQueueLength; // Max flip can be queued for hardware flip queue. + UINT MaxSoftwareFlipQueueLength; // Max flip can be queued for software flip queue for non-legacy device. + D3DKMT_FLIPINFOFLAGS FlipFlags; +} D3DKMT_FLIPQUEUEINFO; + +typedef struct _D3DKMT_ADAPTERADDRESS +{ + UINT BusNumber; // Bus number on which the physical device is located. + UINT DeviceNumber; // Index of the physical device on the bus. + UINT FunctionNumber; // Function number of the adapter on the physical device. +} D3DKMT_ADAPTERADDRESS; + +typedef struct _D3DKMT_ADAPTERREGISTRYINFO +{ + WCHAR AdapterString[MAX_PATH]; + WCHAR BiosString[MAX_PATH]; + WCHAR DacType[MAX_PATH]; + WCHAR ChipType[MAX_PATH]; +} D3DKMT_ADAPTERREGISTRYINFO; + +typedef struct _D3DKMT_CURRENTDISPLAYMODE +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_DISPLAYMODE DisplayMode; +} D3DKMT_CURRENTDISPLAYMODE; + +typedef struct _D3DKMT_VIRTUALADDRESSFLAGS // _ADVSCH_ +{ + UINT VirtualAddressSupported : 1; + UINT Reserved : 31; +} D3DKMT_VIRTUALADDRESSFLAGS; + +typedef struct _D3DKMT_VIRTUALADDRESSINFO // _ADVSCH_ +{ + D3DKMT_VIRTUALADDRESSFLAGS VirtualAddressFlags; +} D3DKMT_VIRTUALADDRESSINFO; + +typedef enum _QAI_DRIVERVERSION +{ + KMT_DRIVERVERSION_WDDM_1_0 = 1000, + KMT_DRIVERVERSION_WDDM_1_1_PRERELEASE = 1102, + KMT_DRIVERVERSION_WDDM_1_1 = 1105, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + KMT_DRIVERVERSION_WDDM_1_2 = 1200, +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + KMT_DRIVERVERSION_WDDM_1_3 = 1300, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + KMT_DRIVERVERSION_WDDM_2_0 = 2000, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + KMT_DRIVERVERSION_WDDM_2_1 = 2100, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_1 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + KMT_DRIVERVERSION_WDDM_2_2 = 2200, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + KMT_DRIVERVERSION_WDDM_2_3 = 2300, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_3 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + KMT_DRIVERVERSION_WDDM_2_4 = 2400, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_4 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + KMT_DRIVERVERSION_WDDM_2_5 = 2500, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_5 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + KMT_DRIVERVERSION_WDDM_2_6 = 2600, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + KMT_DRIVERVERSION_WDDM_2_7 = 2700, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_8) + KMT_DRIVERVERSION_WDDM_2_8 = 2800, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_8 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + KMT_DRIVERVERSION_WDDM_2_9 = 2900, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + KMT_DRIVERVERSION_WDDM_3_0 = 3000, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_0 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + KMT_DRIVERVERSION_WDDM_3_1 = 3100, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_1 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + KMT_DRIVERVERSION_WDDM_3_2 = 3200 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_2 +} D3DKMT_DRIVERVERSION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_ADAPTERTYPE +{ + union + { + struct + { + UINT RenderSupported : 1; + UINT DisplaySupported : 1; + UINT SoftwareDevice : 1; + UINT PostDevice : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + UINT HybridDiscrete : 1; + UINT HybridIntegrated : 1; + UINT IndirectDisplayDevice : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + UINT Paravirtualized : 1; + UINT ACGSupported : 1; + UINT SupportSetTimingsFromVidPn : 1; + UINT Detachable : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + UINT ComputeOnly : 1; + UINT Prototype : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + UINT RuntimePowerManagement : 1; + UINT Reserved : 18; +#else + UINT Reserved : 19; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) +#else + UINT Reserved : 21; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) +#else + UINT Reserved : 25; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +#else + UINT Reserved : 28; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + }; + UINT Value; + }; +} D3DKMT_ADAPTERTYPE; + +typedef struct _D3DKMT_OUTPUTDUPLCONTEXTSCOUNT +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT OutputDuplicationCount; +} D3DKMT_OUTPUTDUPLCONTEXTSCOUNT; + +typedef struct _D3DKMT_UMD_DRIVER_VERSION +{ + D3DKMT_ALIGN64 LARGE_INTEGER DriverVersion; +} D3DKMT_UMD_DRIVER_VERSION; + +typedef struct _D3DKMT_KMD_DRIVER_VERSION +{ + D3DKMT_ALIGN64 LARGE_INTEGER DriverVersion; +} D3DKMT_KMD_DRIVER_VERSION; + +typedef struct _D3DKMT_DIRECTFLIP_SUPPORT +{ + BOOL Supported; +} D3DKMT_DIRECTFLIP_SUPPORT; + +typedef struct _D3DKMT_MULTIPLANEOVERLAY_SUPPORT +{ + BOOL Supported; +} D3DKMT_MULTIPLANEOVERLAY_SUPPORT; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) +typedef struct _D3DKMT_MULTIPLANEOVERLAY_HUD_SUPPORT +{ + UINT VidPnSourceId; // Not yet used. + BOOL Update; + BOOL KernelSupported; + BOOL HudSupported; +} D3DKMT_MULTIPLANEOVERLAY_HUD_SUPPORT; +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +typedef struct _D3DKMT_DLIST_DRIVER_NAME +{ + WCHAR DListFileName[MAX_PATH]; // Out: DList driver file name +} D3DKMT_DLIST_DRIVER_NAME; + +typedef struct _D3DKMT_CPDRIVERNAME +{ + WCHAR ContentProtectionFileName[MAX_PATH]; +} D3DKMT_CPDRIVERNAME; + +typedef struct _D3DKMT_MIRACASTCOMPANIONDRIVERNAME +{ + WCHAR MiracastCompanionDriverName[MAX_PATH]; +} D3DKMT_MIRACASTCOMPANIONDRIVERNAME; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_XBOX +{ + BOOL IsXBOX; +} D3DKMT_XBOX; + +typedef struct _D3DKMT_INDEPENDENTFLIP_SUPPORT +{ + BOOL Supported; +} D3DKMT_INDEPENDENTFLIP_SUPPORT; + +typedef struct _D3DKMT_MULTIPLANEOVERLAY_DECODE_SUPPORT +{ + BOOL Supported; +} D3DKMT_MULTIPLANEOVERLAY_DECODE_SUPPORT; + +typedef struct _D3DKMT_ISBADDRIVERFORHWPROTECTIONDISABLED +{ + BOOL Disabled; +} D3DKMT_ISBADDRIVERFORHWPROTECTIONDISABLED; + +typedef struct _D3DKMT_MULTIPLANEOVERLAY_SECONDARY_SUPPORT +{ + BOOL Supported; +} D3DKMT_MULTIPLANEOVERLAY_SECONDARY_SUPPORT; + +typedef struct _D3DKMT_INDEPENDENTFLIP_SECONDARY_SUPPORT +{ + BOOL Supported; +} D3DKMT_INDEPENDENTFLIP_SECONDARY_SUPPORT; + +typedef struct _D3DKMT_PANELFITTER_SUPPORT +{ + BOOL Supported; +} D3DKMT_PANELFITTER_SUPPORT; + +typedef struct _D3DKMT_PHYSICAL_ADAPTER_COUNT +{ + UINT Count; +} D3DKMT_PHYSICAL_ADAPTER_COUNT; + +typedef struct _D3DKMT_DEVICE_IDS +{ + UINT VendorID; + UINT DeviceID; + UINT SubVendorID; + UINT SubSystemID; + UINT RevisionID; + UINT BusType; +} D3DKMT_DEVICE_IDS; + +typedef struct _D3DKMT_QUERY_DEVICE_IDS +{ + UINT PhysicalAdapterIndex; // in: + D3DKMT_DEVICE_IDS DeviceIds; // out: +} D3DKMT_QUERY_DEVICE_IDS; + +typedef enum _D3DKMT_PNP_KEY_TYPE +{ + D3DKMT_PNP_KEY_HARDWARE = 1, + D3DKMT_PNP_KEY_SOFTWARE = 2 +} D3DKMT_PNP_KEY_TYPE; + +typedef struct _D3DKMT_QUERY_PHYSICAL_ADAPTER_PNP_KEY +{ + UINT PhysicalAdapterIndex; + D3DKMT_PNP_KEY_TYPE PnPKeyType; + D3DKMT_PTR(_Field_size_opt_(*pCchDest) WCHAR*, pDest); + D3DKMT_PTR(UINT*, pCchDest); +} D3DKMT_QUERY_PHYSICAL_ADAPTER_PNP_KEY; + +typedef enum _D3DKMT_MIRACAST_DRIVER_TYPE +{ + D3DKMT_MIRACAST_DRIVER_NOT_SUPPORTED = 0, + D3DKMT_MIRACAST_DRIVER_IHV = 1, + D3DKMT_MIRACAST_DRIVER_MS = 2, +} D3DKMT_MIRACAST_DRIVER_TYPE; + +typedef struct _D3DKMT_QUERY_MIRACAST_DRIVER_TYPE +{ + D3DKMT_MIRACAST_DRIVER_TYPE MiracastDriverType; +} D3DKMT_QUERY_MIRACAST_DRIVER_TYPE; + +typedef struct _D3DKMT_GPUMMU_CAPS +{ + union + { + struct + { + UINT ReadOnlyMemorySupported : 1; + UINT NoExecuteMemorySupported : 1; + UINT CacheCoherentMemorySupported : 1; + UINT Reserved : 29; + }; + UINT Value; + } Flags; + UINT VirtualAddressBitCount; +} D3DKMT_GPUMMU_CAPS; + +typedef struct _D3DKMT_QUERY_GPUMMU_CAPS +{ + UINT PhysicalAdapterIndex; // in: + D3DKMT_GPUMMU_CAPS Caps; // out: +} D3DKMT_QUERY_GPUMMU_CAPS; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _D3DKMT_MPO3DDI_SUPPORT +{ + BOOL Supported; +} D3DKMT_MPO3DDI_SUPPORT; + +typedef struct _D3DKMT_HWDRM_SUPPORT +{ + BOOLEAN Supported; +} D3DKMT_HWDRM_SUPPORT; + +typedef struct _D3DKMT_MPOKERNELCAPS_SUPPORT +{ + BOOL Supported; +} D3DKMT_MPOKERNELCAPS_SUPPORT; + +typedef struct _D3DKMT_GET_DEVICE_VIDPN_OWNERSHIP_INFO +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + BOOLEAN bFailedDwmAcquireVidPn; // out : True if Dwm Acquire VidPn failed due to another Dwm device having ownership +} D3DKMT_GET_DEVICE_VIDPN_OWNERSHIP_INFO; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +typedef struct _D3DKMT_BLOCKLIST_INFO +{ + UINT Size; + WCHAR BlockList[1]; +} D3DKMT_BLOCKLIST_INFO; + +typedef struct _D3DKMT_QUERY_ADAPTER_UNIQUE_GUID +{ + WCHAR AdapterUniqueGUID[40]; +} D3DKMT_QUERY_ADAPTER_UNIQUE_GUID; + +typedef struct _D3DKMT_NODE_PERFDATA +{ + UINT32 NodeOrdinal; // in: Node ordinal of the requested engine. + UINT32 PhysicalAdapterIndex; // in: The physical adapter index, in an LDA chain + D3DKMT_ALIGN64 ULONGLONG Frequency; // out: Clock frequency of the engine in hertz + D3DKMT_ALIGN64 ULONGLONG MaxFrequency; // out: Max engine clock frequency + D3DKMT_ALIGN64 ULONGLONG MaxFrequencyOC;// out: Max engine over clock frequency + ULONG Voltage; // out: Voltage of the engine in milli volts mV + ULONG VoltageMax; // out: Max voltage levels in milli volts. + ULONG VoltageMaxOC; // out: Max voltage level while overclocked in milli volts. +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + D3DKMT_ALIGN64 ULONGLONG MaxTransitionLatency; // out: Max transition latency to change the frequency in 100 nanoseconds +#else + D3DKMT_ALIGN64 ULONGLONG Reserved; +#endif +} D3DKMT_NODE_PERFDATA; + +typedef struct _D3DKMT_ADAPTER_PERFDATA +{ + UINT32 PhysicalAdapterIndex; // in: The physical adapter index, in an LDA chain + D3DKMT_ALIGN64 ULONGLONG MemoryFrequency; // out: Clock frequency of the memory in hertz + D3DKMT_ALIGN64 ULONGLONG MaxMemoryFrequency; // out: Max memory clock frequency + D3DKMT_ALIGN64 ULONGLONG MaxMemoryFrequencyOC; // out: Clock frequency of the memory while overclocked in hertz. + D3DKMT_ALIGN64 ULONGLONG MemoryBandwidth; // out: Amount of memory transferred in bytes + D3DKMT_ALIGN64 ULONGLONG PCIEBandwidth; // out: Amount of memory transferred over PCI-E in bytes + ULONG FanRPM; // out: Fan rpm + ULONG Power; // out: Power draw of the adapter in tenths of a percentage + ULONG Temperature; // out: Temperature in deci-Celsius 1 = 0.1C + UCHAR PowerStateOverride; // out: Overrides dxgkrnls power view of linked adapters. +} D3DKMT_ADAPTER_PERFDATA; + +typedef struct _D3DKMT_ADAPTER_PERFDATACAPS +{ + UINT32 PhysicalAdapterIndex; // in: The physical adapter index, in an LDA chain + D3DKMT_ALIGN64 ULONGLONG MaxMemoryBandwidth; // out: Max memory bandwidth in bytes for 1 second + D3DKMT_ALIGN64 ULONGLONG MaxPCIEBandwidth; // out: Max pcie bandwidth in bytes for 1 second + ULONG MaxFanRPM; // out: Max fan rpm + ULONG TemperatureMax; // out: Max temperature before damage levels + ULONG TemperatureWarning; // out: The temperature level where throttling begins. +} D3DKMT_ADAPTER_PERFDATACAPS; + +#define DXGK_MAX_GPUVERSION_NAME_LENGTH 32 +typedef struct _D3DKMT_GPUVERSION +{ + UINT32 PhysicalAdapterIndex; // in: The physical adapter index, in an LDA chain + WCHAR BiosVersion[DXGK_MAX_GPUVERSION_NAME_LENGTH]; //out: The gpu bios version + WCHAR GpuArchitecture[DXGK_MAX_GPUVERSION_NAME_LENGTH]; //out: The gpu architectures name. +} D3DKMT_GPUVERSION; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_4 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + +typedef struct _D3DKMT_DRIVER_DESCRIPTION +{ + WCHAR DriverDescription[4096]; //out: The driver description +} D3DKMT_DRIVER_DESCRIPTION; + +typedef struct _D3DKMT_QUERY_SCANOUT_CAPS +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT Caps; +} D3DKMT_QUERY_SCANOUT_CAPS; + +typedef enum _KMT_DISPLAY_UMD_VERSION +{ + KMT_DISPLAY_UMDVERSION_1 = 0, + NUM_KMT_DISPLAY_UMDVERSIONS +} KMT_DISPLAY_UMD_VERSION; + +typedef struct _D3DKMT_DISPLAY_UMD_FILENAMEINFO +{ + KMT_DISPLAY_UMD_VERSION Version; // In: UMD version + WCHAR UmdFileName[MAX_PATH]; // Out: UMD file name +} D3DKMT_DISPLAY_UMD_FILENAMEINFO; + +typedef struct _D3DKMT_WSAUMDIMAGENAME +{ + WCHAR WsaUmdImageName[MAX_PATH]; // Out: UMD WSA image name +} D3DKMT_WSAUMDIMAGENAME; + +typedef struct _D3DKMT_VGPUINTERFACEID +{ + WCHAR VirtualGpuIntefaceId[MAX_PATH]; // Out: UMD WSA image name +} D3DKMT_VGPUINTERFACEID; + +typedef struct _D3DKMT_PARAVIRTUALIZATION +{ + // This adapter property originates from the VM/ Container, and is currently replicated on adapters. + // It precludes extended device functions (i.e. Escapes) for paravirtualized devices which not known at all, + // and therefore assumed not to be secure enough for demanding server scenarios. + BOOLEAN SecureContainer; +} D3DKMT_PARAVIRTUALIZATION; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_8) + +typedef struct _D3DKMT_HYBRID_DLIST_DLL_SUPPORT +{ + BOOL Supported; +} D3DKMT_HYBRID_DLIST_DLL_SUPPORT; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_8 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + +typedef struct _D3DKMT_HYBRID_DLIST_DLL_MUX_SUPPORT +{ + BOOL Supported; +} D3DKMT_HYBRID_DLIST_DLL_MUX_SUPPORT; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_2 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + + +typedef enum _D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER +{ + D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER_NONE = 0, + D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER_COPY = 1, + D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER_TEXTURE = 2, + D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER_SCANOUT = 3, +} D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER; + +typedef struct _D3DKMT_CROSSADAPTERRESOURCE_SUPPORT +{ + D3DKMT_CROSSADAPTERRESOURCE_SUPPORT_TIER SupportTier; +} D3DKMT_CROSSADAPTERRESOURCE_SUPPORT; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 + +typedef enum _KMTQUERYADAPTERINFOTYPE +{ + KMTQAITYPE_UMDRIVERPRIVATE = 0, + KMTQAITYPE_UMDRIVERNAME = 1, + KMTQAITYPE_UMOPENGLINFO = 2, + KMTQAITYPE_GETSEGMENTSIZE = 3, + KMTQAITYPE_ADAPTERGUID = 4, + KMTQAITYPE_FLIPQUEUEINFO = 5, + KMTQAITYPE_ADAPTERADDRESS = 6, + KMTQAITYPE_SETWORKINGSETINFO = 7, + KMTQAITYPE_ADAPTERREGISTRYINFO = 8, + KMTQAITYPE_CURRENTDISPLAYMODE = 9, + KMTQAITYPE_MODELIST = 10, + KMTQAITYPE_CHECKDRIVERUPDATESTATUS = 11, + KMTQAITYPE_VIRTUALADDRESSINFO = 12, // _ADVSCH_ + KMTQAITYPE_DRIVERVERSION = 13, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + KMTQAITYPE_ADAPTERTYPE = 15, + KMTQAITYPE_OUTPUTDUPLCONTEXTSCOUNT = 16, + KMTQAITYPE_WDDM_1_2_CAPS = 17, + KMTQAITYPE_UMD_DRIVER_VERSION = 18, + KMTQAITYPE_DIRECTFLIP_SUPPORT = 19, +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + KMTQAITYPE_MULTIPLANEOVERLAY_SUPPORT = 20, + KMTQAITYPE_DLIST_DRIVER_NAME = 21, + KMTQAITYPE_WDDM_1_3_CAPS = 22, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) + KMTQAITYPE_MULTIPLANEOVERLAY_HUD_SUPPORT = 23, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + KMTQAITYPE_WDDM_2_0_CAPS = 24, + KMTQAITYPE_NODEMETADATA = 25, + KMTQAITYPE_CPDRIVERNAME = 26, + KMTQAITYPE_XBOX = 27, + KMTQAITYPE_INDEPENDENTFLIP_SUPPORT = 28, + KMTQAITYPE_MIRACASTCOMPANIONDRIVERNAME = 29, + KMTQAITYPE_PHYSICALADAPTERCOUNT = 30, + KMTQAITYPE_PHYSICALADAPTERDEVICEIDS = 31, + KMTQAITYPE_DRIVERCAPS_EXT = 32, + KMTQAITYPE_QUERY_MIRACAST_DRIVER_TYPE = 33, + KMTQAITYPE_QUERY_GPUMMU_CAPS = 34, + KMTQAITYPE_QUERY_MULTIPLANEOVERLAY_DECODE_SUPPORT = 35, + KMTQAITYPE_QUERY_HW_PROTECTION_TEARDOWN_COUNT = 36, + KMTQAITYPE_QUERY_ISBADDRIVERFORHWPROTECTIONDISABLED = 37, + KMTQAITYPE_MULTIPLANEOVERLAY_SECONDARY_SUPPORT = 38, + KMTQAITYPE_INDEPENDENTFLIP_SECONDARY_SUPPORT = 39, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + KMTQAITYPE_PANELFITTER_SUPPORT = 40, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_1 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + KMTQAITYPE_PHYSICALADAPTERPNPKEY = 41, + KMTQAITYPE_GETSEGMENTGROUPSIZE = 42, + KMTQAITYPE_MPO3DDI_SUPPORT = 43, + KMTQAITYPE_HWDRM_SUPPORT = 44, + KMTQAITYPE_MPOKERNELCAPS_SUPPORT = 45, + KMTQAITYPE_MULTIPLANEOVERLAY_STRETCH_SUPPORT = 46, + KMTQAITYPE_GET_DEVICE_VIDPN_OWNERSHIP_INFO = 47, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + KMTQAITYPE_QUERYREGISTRY = 48, + KMTQAITYPE_KMD_DRIVER_VERSION = 49, + KMTQAITYPE_BLOCKLIST_KERNEL = 50, + KMTQAITYPE_BLOCKLIST_RUNTIME = 51, + KMTQAITYPE_ADAPTERGUID_RENDER = 52, + KMTQAITYPE_ADAPTERADDRESS_RENDER = 53, + KMTQAITYPE_ADAPTERREGISTRYINFO_RENDER = 54, + KMTQAITYPE_CHECKDRIVERUPDATESTATUS_RENDER = 55, + KMTQAITYPE_DRIVERVERSION_RENDER = 56, + KMTQAITYPE_ADAPTERTYPE_RENDER = 57, + KMTQAITYPE_WDDM_1_2_CAPS_RENDER = 58, + KMTQAITYPE_WDDM_1_3_CAPS_RENDER = 59, + KMTQAITYPE_QUERY_ADAPTER_UNIQUE_GUID = 60, + KMTQAITYPE_NODEPERFDATA = 61, + KMTQAITYPE_ADAPTERPERFDATA = 62, + KMTQAITYPE_ADAPTERPERFDATA_CAPS = 63, + KMTQUITYPE_GPUVERSION = 64, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_4 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + KMTQAITYPE_DRIVER_DESCRIPTION = 65, + KMTQAITYPE_DRIVER_DESCRIPTION_RENDER = 66, + KMTQAITYPE_SCANOUT_CAPS = 67, + KMTQAITYPE_DISPLAY_UMDRIVERNAME = 71, // Added in 19H2 + KMTQAITYPE_PARAVIRTUALIZATION_RENDER = 68, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + KMTQAITYPE_SERVICENAME = 69, + KMTQAITYPE_WDDM_2_7_CAPS = 70, + KMTQAITYPE_TRACKEDWORKLOAD_SUPPORT = 72, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_8) + KMTQAITYPE_HYBRID_DLIST_DLL_SUPPORT = 73, + KMTQAITYPE_DISPLAY_CAPS = 74, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_8 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + KMTQAITYPE_WDDM_2_9_CAPS = 75, + KMTQAITYPE_CROSSADAPTERRESOURCE_SUPPORT = 76, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + KMTQAITYPE_WDDM_3_0_CAPS = 77, + KMTQAITYPE_WSAUMDIMAGENAME = 78, + KMTQAITYPE_VGPUINTERFACEID = 79, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_0 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + KMTQAITYPE_WDDM_3_1_CAPS = 80, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_1 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + KMTQAITYPE_HYBRID_DLIST_DLL_MUX_SUPPORT = 81, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_2 +// If a new enum will be used by DXGI or D3D11 software driver code, update the test content in the area. +// Search for KMTQAITYPE_PARAVIRTUALIZATION_RENDER in directx\dxg\dxgi\unittests for references. +} KMTQUERYADAPTERINFOTYPE; + +typedef struct _D3DKMT_QUERYADAPTERINFO +{ + D3DKMT_HANDLE hAdapter; + KMTQUERYADAPTERINFOTYPE Type; + D3DKMT_PTR(VOID*, pPrivateDriverData); + UINT PrivateDriverDataSize; +} D3DKMT_QUERYADAPTERINFO; + +typedef struct _D3DKMT_OPENADAPTERFROMHDC +{ + D3DKMT_PTR(HDC, hDc); // in: DC that maps to a single display + D3DKMT_HANDLE hAdapter; // out: adapter handle + LUID AdapterLuid; // out: adapter LUID + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // out: VidPN source ID for that particular display +} D3DKMT_OPENADAPTERFROMHDC; + +typedef struct _D3DKMT_OPENADAPTERFROMGDIDISPLAYNAME +{ + WCHAR DeviceName[32]; // in: Name of GDI device from which to open an adapter instance + D3DKMT_HANDLE hAdapter; // out: adapter handle + LUID AdapterLuid; // out: adapter LUID + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // out: VidPN source ID for that particular display +} D3DKMT_OPENADAPTERFROMGDIDISPLAYNAME; + +typedef struct _D3DKMT_OPENADAPTERFROMDEVICENAME +{ + D3DKMT_PTR(PCWSTR, pDeviceName); // in: NULL terminated string containing the device name to open + D3DKMT_HANDLE hAdapter; // out: adapter handle + LUID AdapterLuid; // out: adapter LUID +} D3DKMT_OPENADAPTERFROMDEVICENAME; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + +#define MAX_ENUM_ADAPTERS 16 + +typedef struct _D3DKMT_ADAPTERINFO +{ + D3DKMT_HANDLE hAdapter; + LUID AdapterLuid; + ULONG NumOfSources; + BOOL bPrecisePresentRegionsPreferred; +} D3DKMT_ADAPTERINFO; + +typedef struct _D3DKMT_ENUMADAPTERS +{ + _In_range_(0, MAX_ENUM_ADAPTERS) ULONG NumAdapters; + D3DKMT_ADAPTERINFO Adapters[MAX_ENUM_ADAPTERS]; +} D3DKMT_ENUMADAPTERS; + +typedef struct _D3DKMT_ENUMADAPTERS2 +{ + ULONG NumAdapters; // in/out: On input, the count of the pAdapters array buffer. On output, the number of adapters enumerated. + D3DKMT_PTR(D3DKMT_ADAPTERINFO*, pAdapters); // out: Array of enumerated adapters containing NumAdapters elements +} D3DKMT_ENUMADAPTERS2; + +typedef struct _D3DKMT_OPENADAPTERFROMLUID +{ + LUID AdapterLuid; + D3DKMT_HANDLE hAdapter; +} D3DKMT_OPENADAPTERFROMLUID; + +typedef struct _D3DKMT_QUERYREMOTEVIDPNSOURCEFROMGDIDISPLAYNAME +{ + WCHAR DeviceName[32]; // in: Name of GDI device from which to open an adapter instance + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // out: VidPN source ID for that particular display +} D3DKMT_QUERYREMOTEVIDPNSOURCEFROMGDIDISPLAYNAME; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) +typedef union _D3DKMT_ENUMADAPTERS_FILTER +{ + // Setting none of these flags will still enumerate adapters, + // but there are fewer adapters than EnumAdapters2 enumerates. + // ComputeOnly adapters are left out of the default enumeration, to avoid breaking applications. + // DisplayOnly adapters are also left out of the default enumeration. + struct + { + ULONGLONG IncludeComputeOnly : 1; + ULONGLONG IncludeDisplayOnly : 1; + ULONGLONG IncludeVirtualGpuOnly : 1; + ULONGLONG Reserved : 61; + }; + D3DKMT_ALIGN64 ULONGLONG Value; +} D3DKMT_ENUMADAPTERS_FILTER; + +typedef struct _D3DKMT_ENUMADAPTERS3 +{ + D3DKMT_ENUMADAPTERS_FILTER Filter; // in: Defines the filter + ULONG NumAdapters; // in/out: On input, the count of the pAdapters array buffer. On output, the number of adapters enumerated. + D3DKMT_PTR(D3DKMT_ADAPTERINFO*, pAdapters); // out: Array of enumerated adapters containing NumAdapters elements +} D3DKMT_ENUMADAPTERS3; +#endif + +typedef struct _D3DKMT_CLOSEADAPTER +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle +} D3DKMT_CLOSEADAPTER; + +typedef struct _D3DKMT_GETSHAREDPRIMARYHANDLE +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN source ID + D3DKMT_HANDLE hSharedPrimary; // out: global shared primary handle (if one exists currently) +} D3DKMT_GETSHAREDPRIMARYHANDLE; + +typedef struct _D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION +{ + LUID AdapterLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + RECTL LockRect; // in: If zero rect then we are locking the whole primary else the lock sub-rect +} D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION; + +typedef struct _D3DKMT_SHAREDPRIMARYUNLOCKNOTIFICATION +{ + LUID AdapterLuid; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; +} D3DKMT_SHAREDPRIMARYUNLOCKNOTIFICATION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_PINDIRECTFLIPRESOURCES +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + UINT ResourceCount; // in : Number of resources to pin + D3DKMT_PTR(_Field_size_(ResourceCount) D3DKMT_HANDLE*, pResourceList); // in : Array of resource handles to pin +} D3DKMT_PINDIRECTFLIPRESOURCES; + +typedef struct _D3DKMT_UNPINDIRECTFLIPRESOURCES +{ + D3DKMT_HANDLE hDevice; // in : Indentifies the device + UINT ResourceCount; // in : Number of resources to unpin + D3DKMT_PTR(_Field_size_(ResourceCount) D3DKMT_HANDLE*, pResourceList); // in : Array of resource handles to unpin +} D3DKMT_UNPINDIRECTFLIPRESOURCES; +#endif + + +typedef enum _D3DKMT_ESCAPETYPE +{ + D3DKMT_ESCAPE_DRIVERPRIVATE = 0, + D3DKMT_ESCAPE_VIDMM = 1, + D3DKMT_ESCAPE_TDRDBGCTRL = 2, + D3DKMT_ESCAPE_VIDSCH = 3, + D3DKMT_ESCAPE_DEVICE = 4, + D3DKMT_ESCAPE_DMM = 5, + D3DKMT_ESCAPE_DEBUG_SNAPSHOT = 6, + // unused (7 was previously used to set driver update in-progress status, D3DKMT_ESCAPE_SETDRIVERUPDATESTATUS) + D3DKMT_ESCAPE_DRT_TEST = 8, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ESCAPE_DIAGNOSTICS = 9, + D3DKMT_ESCAPE_OUTPUTDUPL_SNAPSHOT = 10, + D3DKMT_ESCAPE_OUTPUTDUPL_DIAGNOSTICS = 11, + D3DKMT_ESCAPE_BDD_PNP = 12, + D3DKMT_ESCAPE_BDD_FALLBACK = 13, + D3DKMT_ESCAPE_ACTIVATE_SPECIFIC_DIAG = 14, + D3DKMT_ESCAPE_MODES_PRUNED_OUT = 15, + D3DKMT_ESCAPE_WHQL_INFO = 16, + D3DKMT_ESCAPE_BRIGHTNESS = 17, + D3DKMT_ESCAPE_EDID_CACHE = 18, + // unused (19 was previously D3DKMT_ESCAPE_GENERIC_ADAPTER_DIAG_INFO) +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + D3DKMT_ESCAPE_MIRACAST_DISPLAY_REQUEST = 20, + D3DKMT_ESCAPE_HISTORY_BUFFER_STATUS = 21, + // 22 can be reused for future needs as it was never exposed for external purposes + D3DKMT_ESCAPE_MIRACAST_ADAPTER_DIAG_INFO = 23, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DKMT_ESCAPE_FORCE_BDDFALLBACK_HEADLESS = 24, + D3DKMT_ESCAPE_REQUEST_MACHINE_CRASH = 25, + // unused (26 was previously D3DKMT_ESCAPE_HMD_GET_EDID_BASE_BLOCK) + D3DKMT_ESCAPE_SOFTGPU_ENABLE_DISABLE_HMD = 27, + D3DKMT_ESCAPE_PROCESS_VERIFIER_OPTION = 28, + D3DKMT_ESCAPE_ADAPTER_VERIFIER_OPTION = 29, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_ESCAPE_IDD_REQUEST = 30, + D3DKMT_ESCAPE_DOD_SET_DIRTYRECT_MODE = 31, + D3DKMT_ESCAPE_LOG_CODEPOINT_PACKET = 32, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + D3DKMT_ESCAPE_LOG_USERMODE_DAIG_PACKET = 33, + D3DKMT_ESCAPE_GET_EXTERNAL_DIAGNOSTICS = 34, + // unused (35 previously was D3DKMT_ESCAPE_GET_PREFERRED_MODE) +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + D3DKMT_ESCAPE_GET_DISPLAY_CONFIGURATIONS = 36, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_ESCAPE_QUERY_IOMMU_STATUS = 37, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + D3DKMT_ESCAPE_CCD_DATABASE = 38, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + D3DKMT_ESCAPE_QUERY_DMA_REMAPPING_STATUS = 39, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_0 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_4 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_3 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_2 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_1 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3 + + D3DKMT_ESCAPE_WIN32K_START = 1024, + D3DKMT_ESCAPE_WIN32K_HIP_DEVICE_INFO = 1024, + D3DKMT_ESCAPE_WIN32K_QUERY_CD_ROTATION_BLOCK = 1025, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + D3DKMT_ESCAPE_WIN32K_DPI_INFO = 1026, // Use hContext for the desired hdev + D3DKMT_ESCAPE_WIN32K_PRESENTER_VIEW_INFO = 1027, + D3DKMT_ESCAPE_WIN32K_SYSTEM_DPI = 1028, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DKMT_ESCAPE_WIN32K_BDD_FALLBACK = 1029, + D3DKMT_ESCAPE_WIN32K_DDA_TEST_CTL = 1030, + D3DKMT_ESCAPE_WIN32K_USER_DETECTED_BLACK_SCREEN = 1031, + // unused (1032 was previously D3DKMT_ESCAPE_WIN32K_HMD_ENUM) + // unused (1033 was previously D3DKMT_ESCAPE_WIN32K_HMD_CONTROL) + // unused (1034 was previously D3DKMT_ESCAPE_WIN32K_LPMDISPLAY_CONTROL) +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + D3DKMT_ESCAPE_WIN32K_DISPBROKER_TEST = 1035, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + D3DKMT_ESCAPE_WIN32K_COLOR_PROFILE_INFO = 1036, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + D3DKMT_ESCAPE_WIN32K_SET_DIMMED_STATE = 1037, + D3DKMT_ESCAPE_WIN32K_SPECIALIZED_DISPLAY_TEST = 1038, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_5 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM1_3 +#endif // DXGKDDI_INTERFACE_VERSION_WIN8 +} D3DKMT_ESCAPETYPE; + +typedef struct _D3DKMT_DOD_SET_DIRTYRECT_MODE +{ + BOOL bForceFullScreenDirty; // in: indicates if this adapter should always give full screen dirty for every Dod present +}D3DKMT_DOD_SET_DIRTYRECT_MODE; + +typedef enum _D3DKMT_TDRDBGCTRLTYPE +{ + D3DKMT_TDRDBGCTRLTYPE_FORCETDR = 0, //Simulate a TDR + D3DKMT_TDRDBGCTRLTYPE_DISABLEBREAK = 1, //Disable DebugBreak on timeout + D3DKMT_TDRDBGCTRLTYPE_ENABLEBREAK = 2, //Enable DebugBreak on timeout + D3DKMT_TDRDBGCTRLTYPE_UNCONDITIONAL = 3, //Disables all safety conditions (e.g. check for consecutive recoveries) + D3DKMT_TDRDBGCTRLTYPE_VSYNCTDR = 4, //Simulate a Vsync TDR + D3DKMT_TDRDBGCTRLTYPE_GPUTDR = 5, //Simulate a GPU TDR +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_TDRDBGCTRLTYPE_FORCEDODTDR = 6, //Simulate a Display Only Present TDR + D3DKMT_TDRDBGCTRLTYPE_FORCEDODVSYNCTDR = 7, //Simulate a Display Only Vsync TDR + D3DKMT_TDRDBGCTRLTYPE_ENGINETDR = 8, //Simulate an engine TDR +#endif +} D3DKMT_TDRDBGCTRLTYPE; + +typedef enum _D3DKMT_VIDMMESCAPETYPE +{ + D3DKMT_VIDMMESCAPETYPE_SETFAULT = 0, + D3DKMT_VIDMMESCAPETYPE_RUN_COHERENCY_TEST = 1, + D3DKMT_VIDMMESCAPETYPE_RUN_UNMAP_TO_DUMMY_PAGE_TEST = 2, + D3DKMT_VIDMMESCAPETYPE_APERTURE_CORRUPTION_CHECK = 3, + D3DKMT_VIDMMESCAPETYPE_SUSPEND_CPU_ACCESS_TEST = 4, + D3DKMT_VIDMMESCAPETYPE_EVICT = 5, + D3DKMT_VIDMMESCAPETYPE_EVICT_BY_NT_HANDLE = 6, + D3DKMT_VIDMMESCAPETYPE_GET_VAD_INFO = 7, + D3DKMT_VIDMMESCAPETYPE_SET_BUDGET = 8, + D3DKMT_VIDMMESCAPETYPE_SUSPEND_PROCESS = 9, + D3DKMT_VIDMMESCAPETYPE_RESUME_PROCESS = 10, + D3DKMT_VIDMMESCAPETYPE_GET_BUDGET = 11, + D3DKMT_VIDMMESCAPETYPE_SET_TRIM_INTERVALS = 12, + D3DKMT_VIDMMESCAPETYPE_EVICT_BY_CRITERIA = 13, + D3DKMT_VIDMMESCAPETYPE_WAKE = 14, + D3DKMT_VIDMMESCAPETYPE_DEFRAG = 15, + D3DKMT_VIDMMESCAPETYPE_DELAYEXECUTION = 16, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + D3DKMT_VIDMMESCAPETYPE_VALIDATE_INTEGRITY = 17, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + D3DKMT_VIDMMESCAPETYPE_SET_EVICTION_CONFIG = 18, +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 +} D3DKMT_VIDMMESCAPETYPE; + +typedef enum _D3DKMT_VIDSCHESCAPETYPE +{ + D3DKMT_VIDSCHESCAPETYPE_PREEMPTIONCONTROL = 0, //Enable/Disable preemption + D3DKMT_VIDSCHESCAPETYPE_SUSPENDSCHEDULER = 1, //Suspend/Resume scheduler (obsolate) + D3DKMT_VIDSCHESCAPETYPE_TDRCONTROL = 2, //Tdr control + D3DKMT_VIDSCHESCAPETYPE_SUSPENDRESUME = 3, //Suspend/Resume scheduler +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_VIDSCHESCAPETYPE_ENABLECONTEXTDELAY = 4, //Enable/Disable context delay +#endif + D3DKMT_VIDSCHESCAPETYPE_CONFIGURE_TDR_LIMIT = 5, // Configure TdrLimitCount and TdrLimitTime + D3DKMT_VIDSCHESCAPETYPE_VGPU_RESET = 6, // Trigger VGPU reset + D3DKMT_VIDSCHESCAPETYPE_PFN_CONTROL = 7, // Periodic frame notification control + D3DKMT_VIDSCHESCAPETYPE_VIRTUAL_REFRESH_RATE = 8, +} D3DKMT_VIDSCHESCAPETYPE; + +typedef enum _D3DKMT_DMMESCAPETYPE +{ + D3DKMT_DMMESCAPETYPE_UNINITIALIZED = 0, + D3DKMT_DMMESCAPETYPE_GET_SUMMARY_INFO = 1, + D3DKMT_DMMESCAPETYPE_GET_VIDEO_PRESENT_SOURCES_INFO = 2, + D3DKMT_DMMESCAPETYPE_GET_VIDEO_PRESENT_TARGETS_INFO = 3, + D3DKMT_DMMESCAPETYPE_GET_ACTIVEVIDPN_INFO = 4, + D3DKMT_DMMESCAPETYPE_GET_MONITORS_INFO = 5, + D3DKMT_DMMESCAPETYPE_RECENTLY_COMMITTED_VIDPNS_INFO = 6, + D3DKMT_DMMESCAPETYPE_RECENT_MODECHANGE_REQUESTS_INFO = 7, + D3DKMT_DMMESCAPETYPE_RECENTLY_RECOMMENDED_VIDPNS_INFO = 8, + D3DKMT_DMMESCAPETYPE_RECENT_MONITOR_PRESENCE_EVENTS_INFO = 9, + D3DKMT_DMMESCAPETYPE_ACTIVEVIDPN_SOURCEMODESET_INFO = 10, + D3DKMT_DMMESCAPETYPE_ACTIVEVIDPN_COFUNCPATHMODALITY_INFO = 11, + D3DKMT_DMMESCAPETYPE_GET_LASTCLIENTCOMMITTEDVIDPN_INFO = 12, + D3DKMT_DMMESCAPETYPE_GET_VERSION_INFO = 13, + D3DKMT_DMMESCAPETYPE_VIDPN_MGR_DIAGNOSTICS = 14 +} D3DKMT_DMMESCAPETYPE; + +typedef struct _D3DKMT_HISTORY_BUFFER_STATUS +{ + BOOLEAN Enabled; + UINT Reserved; +} D3DKMT_HISTORY_BUFFER_STATUS; + +typedef enum _D3DKMT_VAD_ESCAPE_COMMAND +{ + D3DKMT_VAD_ESCAPE_GETNUMVADS, + D3DKMT_VAD_ESCAPE_GETVAD, + D3DKMT_VAD_ESCAPE_GETVADRANGE, + D3DKMT_VAD_ESCAPE_GET_PTE, + D3DKMT_VAD_ESCAPE_GET_GPUMMU_CAPS, + D3DKMT_VAD_ESCAPE_GET_SEGMENT_CAPS, + D3DKMT_VAD_ESCAPE_GET_PTE_DATA, +} D3DKMT_VAD_ESCAPE_COMMAND; + +typedef struct _D3DKMT_VAD_DESC +{ + UINT VadIndex; // in: 0xFFFFFFFF to use the VAD address + D3DKMT_ALIGN64 UINT64 VadAddress; // in + UINT NumMappedRanges; // out + UINT VadType; // out: 0 - reserved, 1 - Mapped + D3DKMT_ALIGN64 UINT64 StartAddress; // out + D3DKMT_ALIGN64 UINT64 EndAddress; // out +} D3DKMT_VAD_DESC; + +typedef struct _D3DKMT_VA_RANGE_DESC +{ + D3DKMT_ALIGN64 UINT64 VadAddress; // in + UINT VaRangeIndex; // in + UINT PhysicalAdapterIndex; // in + D3DKMT_ALIGN64 UINT64 StartAddress; // out + D3DKMT_ALIGN64 UINT64 EndAddress; // out + D3DKMT_ALIGN64 UINT64 DriverProtection; // out + UINT OwnerType; // out: VIDMM_VAD_OWNER_TYPE + D3DKMT_ALIGN64 UINT64 pOwner; // out + D3DKMT_ALIGN64 UINT64 OwnerOffset; // out + UINT Protection; // out: D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE +} D3DKMT_VA_RANGE_DESC; + +typedef struct _D3DKMT_EVICTION_CRITERIA +{ + D3DKMT_ALIGN64 UINT64 MinimumSize; + D3DKMT_ALIGN64 UINT64 MaximumSize; + struct + { + union + { + struct + { + UINT Primary : 1; // 0x00000001 + UINT Reserved : 31; // 0xFFFFFFFE + } Flags; + UINT Value; + }; + }; +} D3DKMT_EVICTION_CRITERIA; + +typedef enum _D3DKMT_DEFRAG_ESCAPE_OPERATION +{ + D3DKMT_DEFRAG_ESCAPE_GET_FRAGMENTATION_STATS = 0, + D3DKMT_DEFRAG_ESCAPE_DEFRAG_UPWARD = 1, + D3DKMT_DEFRAG_ESCAPE_DEFRAG_DOWNWARD = 2, + D3DKMT_DEFRAG_ESCAPE_DEFRAG_PASS = 3, + D3DKMT_DEFRAG_ESCAPE_VERIFY_TRANSFER = 4, +} D3DKMT_DEFRAG_ESCAPE_OPERATION; + +typedef struct _D3DKMT_PAGE_TABLE_LEVEL_DESC +{ + UINT IndexBitCount; + D3DKMT_ALIGN64 UINT64 IndexMask; + D3DKMT_ALIGN64 UINT64 IndexShift; + D3DKMT_ALIGN64 UINT64 LowerLevelsMask; + D3DKMT_ALIGN64 UINT64 EntryCoverageInPages; +} D3DKMT_PAGE_TABLE_LEVEL_DESC; + +typedef struct _DXGK_ESCAPE_GPUMMUCAPS +{ + BOOLEAN ReadOnlyMemorySupported; + BOOLEAN NoExecuteMemorySupported; + BOOLEAN ZeroInPteSupported; + BOOLEAN CacheCoherentMemorySupported; + BOOLEAN LargePageSupported; + BOOLEAN DualPteSupported; + BOOLEAN AllowNonAlignedLargePageAddress; + BOOLEAN PageTable64KSupported : 1; // Support 64K page table (no dual-PTE) + BOOLEAN Reserved : 7; + UINT VirtualAddressBitCount; + UINT PageTableLevelCount; + D3DKMT_PAGE_TABLE_LEVEL_DESC PageTableLevelDesk[DXGK_MAX_PAGE_TABLE_LEVEL_COUNT]; +} DXGK_ESCAPE_GPUMMUCAPS; + +typedef struct _D3DKMT_GET_GPUMMU_CAPS +{ + UINT PhysicalAdapterIndex; // In + DXGK_ESCAPE_GPUMMUCAPS GpuMmuCaps; // Out +} D3DKMT_GET_GPUMMU_CAPS; + +#define D3DKMT_GET_PTE_MAX 64 + +typedef struct _D3DKMT_GET_PTE +{ + UINT PhysicalAdapterIndex; // In + UINT PageTableLevel; // In + UINT PageTableIndex[DXGK_MAX_PAGE_TABLE_LEVEL_COUNT]; // In + BOOLEAN b64KBPte; // In - Valid only when dual PTEs are supported. Out - PT is 64KB. + UINT NumPtes; // In - Number of PTEs to fill. Out - number of filled PTEs + DXGK_PTE Pte[D3DKMT_GET_PTE_MAX]; // Out + UINT NumValidEntries; // Out +} D3DKMT_GET_PTE; + +typedef struct _D3DKMT_GET_PTE_EXT +{ + UINT64 DriverProtection[D3DKMT_GET_PTE_MAX]; // Out + UINT64 AllocationData[D3DKMT_GET_PTE_MAX]; // Out +} D3DKMT_GET_PTE_EXT; + +#define D3DKMT_MAX_SEGMENT_COUNT 32 + +typedef enum _D3DKMT_MEMORY_SEGMENT_GROUP +{ + D3DKMT_MEMORY_SEGMENT_GROUP_LOCAL = 0, + D3DKMT_MEMORY_SEGMENT_GROUP_NON_LOCAL = 1 +} D3DKMT_MEMORY_SEGMENT_GROUP; + +typedef struct _D3DKMT_SEGMENT_CAPS +{ + D3DKMT_ALIGN64 UINT64 Size; + UINT PageSize; + ULONG SegmentId; + BOOLEAN bAperture; + BOOLEAN bReservedSysMem; + D3DKMT_MEMORY_SEGMENT_GROUP BudgetGroup; +} D3DKMT_SEGMENT_CAPS; + +typedef struct _D3DKMT_GET_SEGMENT_CAPS +{ + UINT PhysicalAdapterIndex; // In + UINT NumSegments; // Out + D3DKMT_SEGMENT_CAPS SegmentCaps[D3DKMT_MAX_SEGMENT_COUNT]; // Out +} D3DKMT_GET_SEGMENT_CAPS; + +typedef enum _D3DKMT_ESCAPE_PFN_CONTROL_COMMAND +{ + D3DKMT_ESCAPE_PFN_CONTROL_DEFAULT, + D3DKMT_ESCAPE_PFN_CONTROL_FORCE_CPU, + D3DKMT_ESCAPE_PFN_CONTROL_FORCE_GPU +} D3DKMT_ESCAPE_PFN_CONTROL_COMMAND; + +// params for D3DKMT_VIDSCHESCAPETYPE_VIRTUAL_REFRESH_RATE +typedef enum _D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE +{ + D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE_SET_BASE_DESKTOP_DURATION = 0, + D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE_SET_VSYNC_MULTIPLIER = 1, + D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE_SET_PROCESS_BOOST_ELIGIBLE = 2, +} D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE; + +typedef struct _D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE +{ + D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE_TYPE Type; + UINT VidPnSourceId; + BOOLEAN ProcessBoostEligible; + UINT VSyncMultiplier; + UINT BaseDesktopDuration; + UCHAR Reserved[16]; +} D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE; + +typedef struct _D3DKMT_VIDMM_ESCAPE +{ + D3DKMT_VIDMMESCAPETYPE Type; + union + { + struct + { + union + { + struct + { + ULONG ProbeAndLock : 1; + ULONG SplitPoint : 1; + ULONG NoDemotion : 1; + ULONG SwizzlingAperture : 1; + ULONG PagingPathLockSubRange : 1; + ULONG PagingPathLockMinRange : 1; + ULONG ComplexLock : 1; + ULONG FailVARotation : 1; + ULONG NoWriteCombined : 1; + ULONG NoPrePatching : 1; + ULONG AlwaysRepatch : 1; + ULONG ExpectPreparationFailure : 1; + ULONG FailUserModeVAMapping : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + ULONG NeverDiscardOfferedAllocation : 1; + ULONG AlwaysDiscardOfferedAllocation : 1; + ULONG Reserved : 17; +#else + ULONG Reserved : 19; +#endif + }; + ULONG Value; + }; + } SetFault; + struct + { + D3DKMT_HANDLE ResourceHandle; + D3DKMT_HANDLE AllocationHandle; + D3DKMT_PTR(HANDLE, hProcess); // 0 to evict memory for the current process, otherwise it is a process handle from OpenProcess(PROCESS_ALL_ACCESS, FALSE, ProcessId). + } Evict; + struct + { + D3DKMT_ALIGN64 UINT64 NtHandle; // Used by D3DKMT_VIDMMESCAPETYPE_EVICT_BY_NT_HANDLE + } EvictByNtHandle; + struct + { + union + { + struct + { + UINT NumVads; + } GetNumVads; + D3DKMT_VAD_DESC GetVad; + D3DKMT_VA_RANGE_DESC GetVadRange; + D3DKMT_GET_GPUMMU_CAPS GetGpuMmuCaps; + D3DKMT_GET_PTE GetPte; + D3DKMT_GET_SEGMENT_CAPS GetSegmentCaps; + }; + D3DKMT_VAD_ESCAPE_COMMAND Command; // in + NTSTATUS Status; // out + union + { + D3DKMT_GET_PTE_EXT GetPteExt; + }; + } GetVads; + struct + { + D3DKMT_ALIGN64 ULONGLONG LocalMemoryBudget; + D3DKMT_ALIGN64 ULONGLONG SystemMemoryBudget; + } SetBudget; + struct + { + D3DKMT_PTR(HANDLE, hProcess); + BOOL bAllowWakeOnSubmission; + } SuspendProcess; + struct + { + D3DKMT_PTR(HANDLE, hProcess); + } ResumeProcess; + struct + { + D3DKMT_ALIGN64 UINT64 NumBytesToTrim; + } GetBudget; + struct + { + ULONG MinTrimInterval; // In 100ns units + ULONG MaxTrimInterval; // In 100ns units + ULONG IdleTrimInterval; // In 100ns units + } SetTrimIntervals; + D3DKMT_EVICTION_CRITERIA EvictByCriteria; + struct + { + BOOL bFlush; + } Wake; + struct + { + D3DKMT_DEFRAG_ESCAPE_OPERATION Operation; + + UINT SegmentId; + + D3DKMT_ALIGN64 ULONGLONG TotalCommitted; + D3DKMT_ALIGN64 ULONGLONG TotalFree; + D3DKMT_ALIGN64 ULONGLONG LargestGapBefore; + D3DKMT_ALIGN64 ULONGLONG LargestGapAfter; + } Defrag; + struct + { + D3DKMT_HANDLE hPagingQueue; + UINT PhysicalAdapterIndex; + ULONG Milliseconds; + D3DKMT_ALIGN64 ULONGLONG PagingFenceValue; + } DelayExecution; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + struct + { + UINT16 PhysicalAdapterIndex; + UINT16 SegmentId; + } VerifyIntegrity; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + struct + { + D3DKMT_ALIGN64 LONGLONG TimerValue; + } DelayedEvictionConfig; +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_9 +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 + }; +} D3DKMT_VIDMM_ESCAPE; + +typedef struct _D3DKMT_VIDSCH_ESCAPE +{ + D3DKMT_VIDSCHESCAPETYPE Type; + union + { + BOOL PreemptionControl; // enable/disable preemption +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + BOOL EnableContextDelay; // enable/disable context delay + struct + { + ULONG TdrControl; // control tdr + union + { + ULONG NodeOrdinal; // valid if TdrControl is set to D3DKMT_TDRDBGCTRLTYPE_ENGINETDR + }; + } TdrControl2; +#endif + BOOL SuspendScheduler; // suspend/resume scheduler (obsolate) + ULONG TdrControl; // control tdr + ULONG SuspendTime; // time period to suspend. + struct + { + UINT Count; + UINT Time; // In seconds + } TdrLimit; + + D3DKMT_ESCAPE_PFN_CONTROL_COMMAND PfnControl; // periodic frame notification control + }; + D3DKMT_ESCAPE_VIRTUAL_REFRESH_RATE VirtualRefreshRateControl; +} D3DKMT_VIDSCH_ESCAPE; + +typedef struct _D3DKMT_TDRDBGCTRL_ESCAPE +{ + D3DKMT_TDRDBGCTRLTYPE TdrControl; // control tdr +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + union + { + ULONG NodeOrdinal; // valid if TdrControl is set to D3DKMT_TDRDBGCTRLTYPE_ENGINETDR + }; +#endif +} D3DKMT_TDRDBGCTRL_ESCAPE; + +// Upper boundary on the DMM escape data size (in bytes). +enum +{ + D3DKMT_MAX_DMM_ESCAPE_DATASIZE = 100*1024 +}; + +// NOTE: If (ProvidedBufferSize >= MinRequiredBufferSize), then MinRequiredBufferSize = size of the actual complete data set in the Data[] array. +typedef struct _D3DKMT_DMM_ESCAPE +{ + _In_ D3DKMT_DMMESCAPETYPE Type; + _In_ D3DKMT_ALIGN64 D3DKMT_SIZE_T ProvidedBufferSize; // actual size of Data[] array, in bytes. + _Out_ D3DKMT_ALIGN64 D3DKMT_SIZE_T MinRequiredBufferSize; // minimum required size of Data[] array to contain requested data. + _Out_writes_bytes_(ProvidedBufferSize) UCHAR Data[1]; +} D3DKMT_DMM_ESCAPE; + +typedef enum _D3DKMT_BRIGHTNESS_INFO_TYPE +{ + D3DKMT_BRIGHTNESS_INFO_GET_POSSIBLE_LEVELS = 1, + D3DKMT_BRIGHTNESS_INFO_GET = 2, + D3DKMT_BRIGHTNESS_INFO_SET = 3, + D3DKMT_BRIGHTNESS_INFO_GET_CAPS = 4, + D3DKMT_BRIGHTNESS_INFO_SET_STATE = 5, + D3DKMT_BRIGHTNESS_INFO_SET_OPTIMIZATION = 6, + D3DKMT_BRIGHTNESS_INFO_GET_REDUCTION = 7, + D3DKMT_BRIGHTNESS_INFO_BEGIN_MANUAL_MODE = 8, + D3DKMT_BRIGHTNESS_INFO_END_MANUAL_MODE = 9, + D3DKMT_BRIGHTNESS_INFO_TOGGLE_LOGGING = 10, + D3DKMT_BRIGHTNESS_INFO_GET_NIT_RANGES = 11, + D3DKMT_BRIGHTNESS_INFO_SUPPORTED_INTERFACE = 12, +} D3DKMT_BRIGHTNESS_INFO_TYPE; + +typedef struct _D3DKMT_BRIGHTNESS_POSSIBLE_LEVELS +{ + UCHAR LevelCount; + UCHAR BrightnessLevels[256]; +} D3DKMT_BRIGHTNESS_POSSIBLE_LEVELS; + +typedef enum _D3DKMT_BRIGHTNESS_INTERFACE_VERSION +{ + D3DKMT_BRIGHTNESS_INTERFACE_VERSION_UNINITIALIZED = 0, + D3DKMT_BRIGHTNESS_INTERFACE_VERSION_1 = 1, + D3DKMT_BRIGHTNESS_INTERFACE_VERSION_2 = 2, + D3DKMT_BRIGHTNESS_INTERFACE_VERSION_3 = 3, +} D3DKMT_BRIGHTNESS_INTERFACE_VERSION; + +typedef struct _D3DKMT_BRIGHTNESS_INFO +{ + D3DKMT_BRIGHTNESS_INFO_TYPE Type; + ULONG ChildUid; + union + { + D3DKMT_BRIGHTNESS_POSSIBLE_LEVELS PossibleLevels; + UCHAR Brightness; + DXGK_BRIGHTNESS_CAPS BrightnessCaps; + DXGK_BRIGHTNESS_STATE BrightnessState; + DXGK_BACKLIGHT_OPTIMIZATION_LEVEL OptimizationLevel; + DXGK_BACKLIGHT_INFO ReductionInfo; + BOOLEAN VerboseLogging; + DXGK_BRIGHTNESS_GET_NIT_RANGES_OUT NitRanges; + DXGK_BRIGHTNESS_GET_OUT GetBrightnessMillinits; + DXGK_BRIGHTNESS_SET_IN SetBrightnessMillinits; + D3DKMT_BRIGHTNESS_INTERFACE_VERSION BrightnessInterfaceSupported; + }; +} D3DKMT_BRIGHTNESS_INFO; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +typedef struct _D3DKMT_BDDFALLBACK_CTL +{ + BOOLEAN ForceBddHeadlessNextFallback; +} D3DKMT_BDDFALLBACK_CTL; + +typedef struct _D3DKMT_REQUEST_MACHINE_CRASH_ESCAPE +{ + D3DKMT_ALIGN64 D3DKMT_ULONG_PTR Param1; + D3DKMT_ALIGN64 D3DKMT_ULONG_PTR Param2; + D3DKMT_ALIGN64 D3DKMT_ULONG_PTR Param3; +} D3DKMT_REQUEST_MACHINE_CRASH_ESCAPE; + +// +// VERIFIER OPTIONS +// +typedef enum _D3DKMT_VERIFIER_OPTION_MODE +{ + D3DKMT_VERIFIER_OPTION_QUERY, + D3DKMT_VERIFIER_OPTION_SET +} D3DKMT_VERIFIER_OPTION_MODE; + +typedef enum _D3DKMT_PROCESS_VERIFIER_OPTION_TYPE +{ + // + // Dxgkrnl (0xxx) + // + + // + // VidMm (1xxx) + // + D3DKMT_PROCESS_VERIFIER_OPTION_VIDMM_FLAGS = 1000, + D3DKMT_PROCESS_VERIFIER_OPTION_VIDMM_RESTRICT_BUDGET = 1001, + + // + // VidSch (2xxx) + // + +} D3DKMT_PROCESS_VERIFIER_OPTION_TYPE; + +typedef union _D3DKMT_PROCESS_VERIFIER_VIDMM_FLAGS +{ + struct + { + UINT ForceSynchronousEvict : 1; + UINT NeverDeferEvictions : 1; + UINT AlwaysFailCommitOnReclaim : 1; + UINT AlwaysPlaceInDemotedLocation : 1; + UINT IgnoreBudgetCap : 1; + UINT Reserved : 27; + }; + UINT32 Value; +} D3DKMT_PROCESS_VERIFIER_VIDMM_FLAGS; + +typedef struct _D3DKMT_PROCESS_VERIFIER_VIDMM_RESTRICT_BUDGET +{ + D3DKMT_ALIGN64 UINT64 LocalBudget; + D3DKMT_ALIGN64 UINT64 NonLocalBudget; +} D3DKMT_PROCESS_VERIFIER_VIDMM_RESTRICT_BUDGET; + +typedef union _D3DKMT_PROCESS_VERIFIER_OPTION_DATA +{ + D3DKMT_PROCESS_VERIFIER_VIDMM_FLAGS VidMmFlags; + D3DKMT_PROCESS_VERIFIER_VIDMM_RESTRICT_BUDGET VidMmRestrictBudget; +} D3DKMT_PROCESS_VERIFIER_OPTION_DATA; + +typedef struct _D3DKMT_PROCESS_VERIFIER_OPTION +{ + D3DKMT_PTR(HANDLE, hProcess); + D3DKMT_PROCESS_VERIFIER_OPTION_TYPE Type; + D3DKMT_VERIFIER_OPTION_MODE Mode; + D3DKMT_PROCESS_VERIFIER_OPTION_DATA Data; +} D3DKMT_PROCESS_VERIFIER_OPTION; + +typedef enum _D3DKMT_ADAPTER_VERIFIER_OPTION_TYPE +{ + // + // Dxgkrnl (0xxx) + // + + // + // VidMm (1xxx) + // + D3DKMT_ADAPTER_VERIFIER_OPTION_VIDMM_FLAGS = 1000, + D3DKMT_ADAPTER_VERIFIER_OPTION_VIDMM_TRIM_INTERVAL = 1001, + + // + // VidSch (2xxx) + // +} D3DKMT_ADAPTER_VERIFIER_OPTION_TYPE; + +typedef union _D3DKMT_ADAPTER_VERIFIER_VIDMM_FLAGS +{ + struct + { + UINT AlwaysRepatch : 1; + UINT FailSharedPrimary : 1; + UINT FailProbeAndLock : 1; + UINT AlwaysDiscardOffer : 1; + UINT NeverDiscardOffer : 1; + UINT ForceComplexLock : 1; + UINT NeverPrepatch : 1; + UINT ExpectPreparationFailure : 1; + UINT TakeSplitPoint : 1; + UINT FailAcquireSwizzlingRange : 1; + UINT PagingPathLockSubrange : 1; + UINT PagingPathLockMinrange : 1; + UINT FailVaRotation : 1; + UINT NoDemotion : 1; + UINT FailDefragPass : 1; + UINT AlwaysProcessOfferList : 1; + UINT AlwaysDecommitOffer : 1; + UINT NeverMoveDefrag : 1; + UINT AlwaysRelocateDisplayableResources : 1; + UINT AlwaysFailGrowVPRMoves : 1; + UINT NeverFlushTemporaryResources : 1; + UINT AllocateTemporaryResourcesInAperture : 1; + UINT Reserved : 10; + }; + UINT32 Value; +} D3DKMT_ADAPTER_VERIFIER_VIDMM_FLAGS; + +typedef struct _D3DKMT_ADAPTER_VERIFIER_VIDMM_TRIM_INTERVAL +{ + D3DKMT_ALIGN64 UINT64 MinimumTrimInterval; + D3DKMT_ALIGN64 UINT64 MaximumTrimInterval; + D3DKMT_ALIGN64 UINT64 IdleTrimInterval; +} D3DKMT_ADAPTER_VERIFIER_VIDMM_TRIM_INTERVAL; + +typedef union _D3DKMT_ADAPTER_VERIFIER_OPTION_DATA +{ + D3DKMT_ADAPTER_VERIFIER_VIDMM_FLAGS VidMmFlags; + D3DKMT_ADAPTER_VERIFIER_VIDMM_TRIM_INTERVAL VidMmTrimInterval; +} D3DKMT_ADAPTER_VERIFIER_OPTION_DATA; + +typedef struct _D3DKMT_ADAPTER_VERIFIER_OPTION +{ + D3DKMT_ADAPTER_VERIFIER_OPTION_TYPE Type; + D3DKMT_VERIFIER_OPTION_MODE Mode; + D3DKMT_ADAPTER_VERIFIER_OPTION_DATA Data; +} D3DKMT_ADAPTER_VERIFIER_OPTION; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +typedef enum _D3DKMT_DEVICEESCAPE_TYPE +{ + D3DKMT_DEVICEESCAPE_VIDPNFROMALLOCATION = 0, + D3DKMT_DEVICEESCAPE_RESTOREGAMMA = 1, +} D3DKMT_DEVICEESCAPE_TYPE; + +typedef struct _D3DKMT_DEVICE_ESCAPE +{ + D3DKMT_DEVICEESCAPE_TYPE Type; + union + { + struct + { + D3DKMT_HANDLE hPrimaryAllocation; // in: Primary allocation handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // out: VidPnSoureId of primary allocation + } VidPnFromAllocation; + }; +} D3DKMT_DEVICE_ESCAPE; + +typedef struct _D3DKMT_DEBUG_SNAPSHOT_ESCAPE +{ + ULONG Length; // out: Actual length of the snapshot written in Buffer + BYTE Buffer[1]; // out: Buffer to place snapshot +} D3DKMT_DEBUG_SNAPSHOT_ESCAPE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +#ifndef DXGK_DIAG_PROCESS_NAME_LENGTH +#define DXGK_DIAG_PROCESS_NAME_LENGTH 16 +#endif + +typedef enum _OUTPUTDUPL_CONTEXT_DEBUG_STATUS +{ + OUTPUTDUPL_CONTEXT_DEBUG_STATUS_INACTIVE = 0, + OUTPUTDUPL_CONTEXT_DEBUG_STATUS_ACTIVE = 1, + OUTPUTDUPL_CONTEXT_DEBUG_STATUS_PENDING_DESTROY = 2, + OUTPUTDUPL_CONTEXT_DEBUG_STATUS_FORCE_UINT32 = 0xffffffff +}OUTPUTDUPL_CONTEXT_DEBUG_STATUS; + +typedef struct _OUTPUTDUPL_CONTEXT_DEBUG_INFO +{ + OUTPUTDUPL_CONTEXT_DEBUG_STATUS Status; + D3DKMT_PTR(HANDLE, ProcessID); + UINT32 AccumulatedPresents; + D3DKMT_ALIGN64 LARGE_INTEGER LastPresentTime; + D3DKMT_ALIGN64 LARGE_INTEGER LastMouseTime; + CHAR ProcessName[DXGK_DIAG_PROCESS_NAME_LENGTH]; +} OUTPUTDUPL_CONTEXT_DEBUG_INFO; + +#define GET_OUTPUT_DUPL_DEBUG_INFO_FROM_SNAPSHOT(pSnapshot, VidPnSource, OutputDuplContextIndex) \ + (pSnapshot->OutputDuplDebugInfos[(VidPnSource * pSnapshot->NumOutputDuplContexts) + OutputDuplContextIndex]) + +typedef struct _D3DKMT_OUTPUTDUPL_SNAPSHOT +{ + UINT Size; // _In_/out: Size of entire structure + + UINT SessionProcessCount; // _Out_: Number of processes currently duplicating output in this session (max possible will be equal to NumOutputDuplContexts) + UINT SessionActiveConnectionsCount; // _Out_: Total number of active contexts in this session, may be more than number active in 2D array because that is per adapter + + UINT NumVidPnSources; // _Out_: Max of first array index + UINT NumOutputDuplContexts; // _Out_: Max of second array index + + UINT Padding; + + // This field is in reality a two dimensional array, use GET_OUTPUT_DUPL_DEBUG_INFO_FROM_SNAPSHOT macro to get a specific one + _Field_size_bytes_(Size - sizeof(_D3DKMT_OUTPUTDUPL_SNAPSHOT)) OUTPUTDUPL_CONTEXT_DEBUG_INFO OutputDuplDebugInfos[0]; +} D3DKMT_OUTPUTDUPL_SNAPSHOT; +#endif + +typedef enum _D3DKMT_ACTIVATE_SPECIFIC_DIAG_TYPE +{ + D3DKMT_ACTIVATE_SPECIFIC_DIAG_TYPE_EXTRA_CCD_DATABASE_INFO = 0, + D3DKMT_ACTIVATE_SPECIFIC_DIAG_TYPE_MODES_PRUNED = 15, +}D3DKMT_ACTIVATE_SPECIFIC_DIAG_TYPE; + +typedef struct _D3DKMT_ACTIVATE_SPECIFIC_DIAG_ESCAPE +{ + D3DKMT_ACTIVATE_SPECIFIC_DIAG_TYPE Type; // The escape type that needs to be (de)activated + BOOL Activate; // FALSE means deactivate +} D3DKMT_ACTIVATE_SPECIFIC_DIAG_ESCAPE; + +typedef struct _D3DKMT_ESCAPE +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in: device handle [Optional] + D3DKMT_ESCAPETYPE Type; // in: escape type. + D3DDDI_ESCAPEFLAGS Flags; // in: flags + D3DKMT_PTR(VOID*, pPrivateDriverData); // in/out: escape data + UINT PrivateDriverDataSize; // in: size of escape data + D3DKMT_HANDLE hContext; // in: context handle [Optional] +} D3DKMT_ESCAPE; + +// +// begin D3DKMT_QUERYSTATISTICS +// + +typedef enum _D3DKMT_QUERYRESULT_PREEMPTION_ATTEMPT_RESULT +{ + D3DKMT_PreemptionAttempt = 0, + D3DKMT_PreemptionAttemptSuccess = 1, + D3DKMT_PreemptionAttemptMissNoCommand = 2, + D3DKMT_PreemptionAttemptMissNotEnabled = 3, + D3DKMT_PreemptionAttemptMissNextFence = 4, + D3DKMT_PreemptionAttemptMissPagingCommand = 5, + D3DKMT_PreemptionAttemptMissSplittedCommand = 6, + D3DKMT_PreemptionAttemptMissFenceCommand = 7, + D3DKMT_PreemptionAttemptMissRenderPendingFlip = 8, + D3DKMT_PreemptionAttemptMissNotMakingProgress = 9, + D3DKMT_PreemptionAttemptMissLessPriority = 10, + D3DKMT_PreemptionAttemptMissRemainingQuantum = 11, + D3DKMT_PreemptionAttemptMissRemainingPreemptionQuantum = 12, + D3DKMT_PreemptionAttemptMissAlreadyPreempting = 13, + D3DKMT_PreemptionAttemptMissGlobalBlock = 14, + D3DKMT_PreemptionAttemptMissAlreadyRunning = 15, + D3DKMT_PreemptionAttemptStatisticsMax = 16, +} D3DKMT_QUERYRESULT_PREEMPTION_ATTEMPT_RESULT; + +// +// WOW will not allow enum member as array length, so define it as a constant +// +#define D3DKMT_QUERYRESULT_PREEMPTION_ATTEMPT_RESULT_MAX 16 +C_ASSERT(D3DKMT_QUERYRESULT_PREEMPTION_ATTEMPT_RESULT_MAX == D3DKMT_PreemptionAttemptStatisticsMax); + +// +// Command packet type +// +typedef enum _D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE { + D3DKMT_ClientRenderBuffer = 0, // (Dma packet) should be 0 base. + D3DKMT_ClientPagingBuffer = 1, // (Dma packet) + D3DKMT_SystemPagingBuffer = 2, // (Dma packet) + D3DKMT_SystemPreemptionBuffer = 3, // (Dma packet) + D3DKMT_DmaPacketTypeMax = 4 +} D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE; + +// +// WOW will not allow enum member as array length, so define it as a constant +// +#define D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_MAX 4 +C_ASSERT(D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_MAX == D3DKMT_DmaPacketTypeMax); + +typedef enum _D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE { + D3DKMT_RenderCommandBuffer = 0, // (Queue Packet) should be 0 base. + D3DKMT_DeferredCommandBuffer = 1, // (Queue Packet) + D3DKMT_SystemCommandBuffer = 2, // (Queue Packet) + D3DKMT_MmIoFlipCommandBuffer = 3, // (Queue Packet) + D3DKMT_WaitCommandBuffer = 4, // (Queue Packet) + D3DKMT_SignalCommandBuffer = 5, // (Queue Packet) + D3DKMT_DeviceCommandBuffer = 6, // (Queue Packet) + D3DKMT_SoftwareCommandBuffer = 7, // (Queue Packet) + D3DKMT_QueuePacketTypeMax = 8 +} D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE; + +// +// WOW will not allow enum member as array length, so define it as a constant +// +#define D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_MAX 8 +C_ASSERT(D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_MAX == D3DKMT_QueuePacketTypeMax); + +typedef enum _D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS +{ + D3DKMT_AllocationPriorityClassMinimum = 0, + D3DKMT_AllocationPriorityClassLow = 1, + D3DKMT_AllocationPriorityClassNormal = 2, + D3DKMT_AllocationPriorityClassHigh = 3, + D3DKMT_AllocationPriorityClassMaximum = 4, + D3DKMT_MaxAllocationPriorityClass = 5 +} D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS; + +// +// WOW will not allow enum member as array length, so define it as a constant +// + +#define D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX 5 +C_ASSERT(D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX == D3DKMT_MaxAllocationPriorityClass); + +// +// Allocation segment preference set can contain 5 preferences +// +#define D3DKMT_QUERYSTATISTICS_SEGMENT_PREFERENCE_MAX 5 + +typedef struct _D3DKMT_QUERYSTATISTICS_COUNTER +{ + ULONG Count; + ULONGLONG Bytes; +} D3DKMT_QUERYSTATISTICS_COUNTER; + +typedef struct _D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_INFORMATION { + ULONG PacketSubmited; + ULONG PacketCompleted; + ULONG PacketPreempted; + ULONG PacketFaulted; +} D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_INFORMATION { + ULONG PacketSubmited; + ULONG PacketCompleted; +} D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_PACKET_INFORMATION { + D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_INFORMATION QueuePacket[D3DKMT_QUERYSTATISTICS_QUEUE_PACKET_TYPE_MAX]; //Size = D3DKMT_QueuePacketTypeMax + D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_INFORMATION DmaPacket[D3DKMT_QUERYSTATISTICS_DMA_PACKET_TYPE_MAX]; //Size = D3DKMT_DmaPacketTypeMax +} D3DKMT_QUERYSTATISTICS_PACKET_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_PREEMPTION_INFORMATION { + ULONG PreemptionCounter[D3DKMT_QUERYRESULT_PREEMPTION_ATTEMPT_RESULT_MAX]; +} D3DKMT_QUERYSTATISTICS_PREEMPTION_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_NODE_INFORMATION { + D3DKMT_ALIGN64 LARGE_INTEGER RunningTime; // Running time in micro-second. + ULONG ContextSwitch; + D3DKMT_QUERYSTATISTICS_PREEMPTION_INFORMATION PreemptionStatistics; + D3DKMT_QUERYSTATISTICS_PACKET_INFORMATION PacketStatistics; + D3DKMT_ALIGN64 UINT64 Reserved[8]; +} D3DKMT_QUERYSTATISTICS_PROCESS_NODE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_NODE_INFORMATION { + D3DKMT_QUERYSTATISTICS_PROCESS_NODE_INFORMATION GlobalInformation; //Global statistics + D3DKMT_QUERYSTATISTICS_PROCESS_NODE_INFORMATION SystemInformation; //Statistics for system thread +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_NODE_PERFDATA NodePerfData; + UINT32 Reserved[3]; +#else + D3DKMT_ALIGN64 UINT64 Reserved[8]; +#endif +} D3DKMT_QUERYSTATISTICS_NODE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE_INFORMATION { + ULONG Frame; // both by Blt and Flip. + ULONG CancelledFrame; // by restart (flip only). + ULONG QueuedPresent; // queued present. + UINT Padding; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + D3DKMT_ALIGN64 UINT64 IsVSyncEnabled; + D3DKMT_ALIGN64 UINT64 VSyncOnTotalTimeMs; + D3DKMT_ALIGN64 UINT64 VSyncOffKeepPhaseTotalTimeMs; + D3DKMT_ALIGN64 UINT64 VSyncOffNoPhaseTotalTimeMs; + D3DKMT_ALIGN64 UINT64 Reserved[4]; +#else + D3DKMT_ALIGN64 UINT64 Reserved[8]; +#endif + +} D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_VIDPNSOURCE_INFORMATION { + D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE_INFORMATION GlobalInformation; //Global statistics + D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE_INFORMATION SystemInformation; //Statistics for system thread + D3DKMT_ALIGN64 UINT64 Reserved[8]; +} D3DKMT_QUERYSTATISTICS_VIDPNSOURCE_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATSTICS_REFERENCE_DMA_BUFFER +{ + ULONG NbCall; + ULONG NbAllocationsReferenced; + ULONG MaxNbAllocationsReferenced; + ULONG NbNULLReference; + ULONG NbWriteReference; + ULONG NbRenamedAllocationsReferenced; + ULONG NbIterationSearchingRenamedAllocation; + ULONG NbLockedAllocationReferenced; + ULONG NbAllocationWithValidPrepatchingInfoReferenced; + ULONG NbAllocationWithInvalidPrepatchingInfoReferenced; + ULONG NbDMABufferSuccessfullyPrePatched; + ULONG NbPrimariesReferencesOverflow; + ULONG NbAllocationWithNonPreferredResources; + ULONG NbAllocationInsertedInMigrationTable; +} D3DKMT_QUERYSTATSTICS_REFERENCE_DMA_BUFFER; + +typedef struct _D3DKMT_QUERYSTATSTICS_RENAMING +{ + ULONG NbAllocationsRenamed; + ULONG NbAllocationsShrinked; + ULONG NbRenamedBuffer; + ULONG MaxRenamingListLength; + ULONG NbFailuresDueToRenamingLimit; + ULONG NbFailuresDueToCreateAllocation; + ULONG NbFailuresDueToOpenAllocation; + ULONG NbFailuresDueToLowResource; + ULONG NbFailuresDueToNonRetiredLimit; +} D3DKMT_QUERYSTATSTICS_RENAMING; + +typedef struct _D3DKMT_QUERYSTATSTICS_PREPRATION +{ + ULONG BroadcastStall; + ULONG NbDMAPrepared; + ULONG NbDMAPreparedLongPath; + ULONG ImmediateHighestPreparationPass; + D3DKMT_QUERYSTATISTICS_COUNTER AllocationsTrimmed; +} D3DKMT_QUERYSTATSTICS_PREPRATION; + +typedef struct _D3DKMT_QUERYSTATSTICS_PAGING_FAULT +{ + D3DKMT_QUERYSTATISTICS_COUNTER Faults; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsFirstTimeAccess; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsReclaimed; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsMigration; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsIncorrectResource; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsLostContent; + D3DKMT_QUERYSTATISTICS_COUNTER FaultsEvicted; + D3DKMT_QUERYSTATISTICS_COUNTER AllocationsMEM_RESET; + D3DKMT_QUERYSTATISTICS_COUNTER AllocationsUnresetSuccess; + D3DKMT_QUERYSTATISTICS_COUNTER AllocationsUnresetFail; + ULONG AllocationsUnresetSuccessRead; + ULONG AllocationsUnresetFailRead; + + D3DKMT_QUERYSTATISTICS_COUNTER Evictions; + D3DKMT_QUERYSTATISTICS_COUNTER EvictionsDueToPreparation; + D3DKMT_QUERYSTATISTICS_COUNTER EvictionsDueToLock; + D3DKMT_QUERYSTATISTICS_COUNTER EvictionsDueToClose; + D3DKMT_QUERYSTATISTICS_COUNTER EvictionsDueToPurge; + D3DKMT_QUERYSTATISTICS_COUNTER EvictionsDueToSuspendCPUAccess; +} D3DKMT_QUERYSTATSTICS_PAGING_FAULT; + +typedef struct _D3DKMT_QUERYSTATSTICS_PAGING_TRANSFER +{ + D3DKMT_ALIGN64 ULONGLONG BytesFilled; + D3DKMT_ALIGN64 ULONGLONG BytesDiscarded; + D3DKMT_ALIGN64 ULONGLONG BytesMappedIntoAperture; + D3DKMT_ALIGN64 ULONGLONG BytesUnmappedFromAperture; + D3DKMT_ALIGN64 ULONGLONG BytesTransferredFromMdlToMemory; + D3DKMT_ALIGN64 ULONGLONG BytesTransferredFromMemoryToMdl; + D3DKMT_ALIGN64 ULONGLONG BytesTransferredFromApertureToMemory; + D3DKMT_ALIGN64 ULONGLONG BytesTransferredFromMemoryToAperture; +} D3DKMT_QUERYSTATSTICS_PAGING_TRANSFER; + +typedef struct _D3DKMT_QUERYSTATSTICS_SWIZZLING_RANGE +{ + ULONG NbRangesAcquired; + ULONG NbRangesReleased; +} D3DKMT_QUERYSTATSTICS_SWIZZLING_RANGE; + +typedef struct _D3DKMT_QUERYSTATSTICS_LOCKS +{ + ULONG NbLocks; + ULONG NbLocksWaitFlag; + ULONG NbLocksDiscardFlag; + ULONG NbLocksNoOverwrite; + ULONG NbLocksNoReadSync; + ULONG NbLocksLinearization; + ULONG NbComplexLocks; +} D3DKMT_QUERYSTATSTICS_LOCKS; + +typedef struct _D3DKMT_QUERYSTATSTICS_ALLOCATIONS +{ + D3DKMT_QUERYSTATISTICS_COUNTER Created; + D3DKMT_QUERYSTATISTICS_COUNTER Destroyed; + D3DKMT_QUERYSTATISTICS_COUNTER Opened; + D3DKMT_QUERYSTATISTICS_COUNTER Closed; + D3DKMT_QUERYSTATISTICS_COUNTER MigratedSuccess; + D3DKMT_QUERYSTATISTICS_COUNTER MigratedFail; + D3DKMT_QUERYSTATISTICS_COUNTER MigratedAbandoned; +} D3DKMT_QUERYSTATSTICS_ALLOCATIONS; + +typedef struct _D3DKMT_QUERYSTATSTICS_TERMINATIONS +{ + // + // We separate shared / nonshared because for nonshared we know that every alloc + // terminated will lead cause a global alloc destroyed, but not for nonshared. + // + D3DKMT_QUERYSTATISTICS_COUNTER TerminatedShared; + D3DKMT_QUERYSTATISTICS_COUNTER TerminatedNonShared; + D3DKMT_QUERYSTATISTICS_COUNTER DestroyedShared; + D3DKMT_QUERYSTATISTICS_COUNTER DestroyedNonShared; +} D3DKMT_QUERYSTATSTICS_TERMINATIONS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef struct _D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION_FLAGS +{ + union + { + struct + { + UINT64 NumberOfMemoryGroups : 2; + UINT64 SupportsDemotion : 1; + UINT64 Reserved :61; + }; + D3DKMT_ALIGN64 UINT64 Value; + }; +} D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION_FLAGS; +#endif + +typedef struct _D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION +{ + ULONG NbSegments; + ULONG NodeCount; + ULONG VidPnSourceCount; + + ULONG VSyncEnabled; + ULONG TdrDetectedCount; + + D3DKMT_ALIGN64 LONGLONG ZeroLengthDmaBuffers; + D3DKMT_ALIGN64 ULONGLONG RestartedPeriod; + + D3DKMT_QUERYSTATSTICS_REFERENCE_DMA_BUFFER ReferenceDmaBuffer; + D3DKMT_QUERYSTATSTICS_RENAMING Renaming; + D3DKMT_QUERYSTATSTICS_PREPRATION Preparation; + D3DKMT_QUERYSTATSTICS_PAGING_FAULT PagingFault; + D3DKMT_QUERYSTATSTICS_PAGING_TRANSFER PagingTransfer; + D3DKMT_QUERYSTATSTICS_SWIZZLING_RANGE SwizzlingRange; + D3DKMT_QUERYSTATSTICS_LOCKS Locks; + D3DKMT_QUERYSTATSTICS_ALLOCATIONS Allocations; + D3DKMT_QUERYSTATSTICS_TERMINATIONS Terminations; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION_FLAGS Flags; + D3DKMT_ALIGN64 UINT64 Reserved[7]; +#else + D3DKMT_ALIGN64 UINT64 Reserved[8]; +#endif +} D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) +typedef struct _D3DKMT_QUERYSTATISTICS_PHYSICAL_ADAPTER_INFORMATION +{ + D3DKMT_ADAPTER_PERFDATA AdapterPerfData; + D3DKMT_ADAPTER_PERFDATACAPS AdapterPerfDataCaps; + D3DKMT_GPUVERSION GpuVersion; +} D3DKMT_QUERYSTATISTICS_PHYSICAL_ADAPTER_INFORMATION; +#endif + +typedef struct _D3DKMT_QUERYSTATISTICS_SYSTEM_MEMORY +{ + D3DKMT_ALIGN64 ULONGLONG BytesAllocated; + D3DKMT_ALIGN64 ULONGLONG BytesReserved; + ULONG SmallAllocationBlocks; + ULONG LargeAllocationBlocks; + D3DKMT_ALIGN64 ULONGLONG WriteCombinedBytesAllocated; + D3DKMT_ALIGN64 ULONGLONG WriteCombinedBytesReserved; + D3DKMT_ALIGN64 ULONGLONG CachedBytesAllocated; + D3DKMT_ALIGN64 ULONGLONG CachedBytesReserved; + D3DKMT_ALIGN64 ULONGLONG SectionBytesAllocated; + D3DKMT_ALIGN64 ULONGLONG SectionBytesReserved; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_ALIGN64 ULONGLONG BytesZeroed; +#else + D3DKMT_ALIGN64 ULONGLONG Reserved; +#endif +} D3DKMT_QUERYSTATISTICS_SYSTEM_MEMORY; + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_INFORMATION +{ + ULONG NodeCount; + ULONG VidPnSourceCount; + + D3DKMT_QUERYSTATISTICS_SYSTEM_MEMORY SystemMemory; + + D3DKMT_ALIGN64 UINT64 Reserved[7]; +} D3DKMT_QUERYSTATISTICS_PROCESS_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_DMA_BUFFER +{ + D3DKMT_QUERYSTATISTICS_COUNTER Size; + ULONG AllocationListBytes; + ULONG PatchLocationListBytes; +} D3DKMT_QUERYSTATISTICS_DMA_BUFFER; + +typedef struct _D3DKMT_QUERYSTATISTICS_COMMITMENT_DATA +{ + D3DKMT_ALIGN64 UINT64 TotalBytesEvictedFromProcess; + D3DKMT_ALIGN64 UINT64 BytesBySegmentPreference[D3DKMT_QUERYSTATISTICS_SEGMENT_PREFERENCE_MAX]; +} D3DKMT_QUERYSTATISTICS_COMMITMENT_DATA; + +typedef struct _D3DKMT_QUERYSTATISTICS_POLICY +{ + D3DKMT_ALIGN64 ULONGLONG PreferApertureForRead[D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX]; + D3DKMT_ALIGN64 ULONGLONG PreferAperture[D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX]; + D3DKMT_ALIGN64 ULONGLONG MemResetOnPaging; + D3DKMT_ALIGN64 ULONGLONG RemovePagesFromWorkingSetOnPaging; + D3DKMT_ALIGN64 ULONGLONG MigrationEnabled; +} D3DKMT_QUERYSTATISTICS_POLICY; + +// Process interference counters indicate how much this process GPU workload interferes with packets +// attempting to preempt it. 9 buckets will be exposed based on how long preemption took: +// [0] 100 microseconds <= preemption time < 250 microseconds +// [1] 250 microseconds <= preemption time < 500 microseconds +// [2] 500 microseconds <= preemption time < 1 milliseconds +// [3] 1 milliseconds <= preemption time < 2.5 milliseconds +// [4] 2.5 milliseconds <= preemption time < 5 milliseconds +// [5] 5 milliseconds <= preemption time < 10 milliseconds +// [6] 10 milliseconds <= preemption time < 25 milliseconds +// [7] 25 milliseconds <= preemption time < 50 milliseconds +// [8] 50 milliseconds <= preemption time +// +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +#define D3DKMT_QUERYSTATISTICS_PROCESS_INTERFERENCE_BUCKET_COUNT 9 + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_INTERFERENCE_COUNTERS +{ + D3DKMT_ALIGN64 UINT64 InterferenceCount[D3DKMT_QUERYSTATISTICS_PROCESS_INTERFERENCE_BUCKET_COUNT]; +} D3DKMT_QUERYSTATISTICS_PROCESS_INTERFERENCE_COUNTERS; +#endif + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER_INFORMATION +{ + ULONG NbSegments; + ULONG NodeCount; + ULONG VidPnSourceCount; + + // + // Virtual address space used by vidmm for this process + // + ULONG VirtualMemoryUsage; + + D3DKMT_QUERYSTATISTICS_DMA_BUFFER DmaBuffer; + D3DKMT_QUERYSTATISTICS_COMMITMENT_DATA CommitmentData; + D3DKMT_QUERYSTATISTICS_POLICY _Policy; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_QUERYSTATISTICS_PROCESS_INTERFERENCE_COUNTERS ProcessInterferenceCounters; +#else + D3DKMT_ALIGN64 UINT64 Reserved[9]; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + D3DKMT_CLIENTHINT ClientHint; +#else + UINT Reserve; +#endif +} D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER_INFORMATION; + +typedef struct _D3DKMT_QUERYSTATISTICS_MEMORY +{ + D3DKMT_ALIGN64 ULONGLONG TotalBytesEvicted; + ULONG AllocsCommitted; + ULONG AllocsResident; +} D3DKMT_QUERYSTATISTICS_MEMORY; + +typedef enum _D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE +{ + D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE_APERTURE = 0, + D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE_MEMORY = 1, + D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE_SYSMEM = 2 +} D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE; + +typedef struct _D3DKMT_QUERYSTATISTICS_SEGMENT_INFORMATION +{ +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ALIGN64 ULONGLONG CommitLimit; + D3DKMT_ALIGN64 ULONGLONG BytesCommitted; + D3DKMT_ALIGN64 ULONGLONG BytesResident; +#else + ULONG CommitLimit; + ULONG BytesCommitted; + ULONG BytesResident; +#endif + + D3DKMT_QUERYSTATISTICS_MEMORY Memory; + + // + // Boolean, whether this is an aperture segment + // + ULONG Aperture; + + // + // Breakdown of bytes evicted by priority class + // + D3DKMT_ALIGN64 ULONGLONG TotalBytesEvictedByPriority[D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX]; //Size = D3DKMT_MaxAllocationPriorityClass + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ALIGN64 UINT64 SystemMemoryEndAddress; + struct D3DKMT_ALIGN64 + { + UINT64 PreservedDuringStandby : 1; + UINT64 PreservedDuringHibernate : 1; + UINT64 PartiallyPreservedDuringHibernate : 1; + UINT64 Reserved : 61; + } PowerFlags; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + struct D3DKMT_ALIGN64 + { + UINT64 SystemMemory : 1; + UINT64 PopulatedByReservedDDRByFirmware : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + UINT64 SegmentType : 4; // D3DKMT_QUERYSTATISTICS_SEGMENT_TYPE +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + UINT64 SegmentGroup : 2; + UINT64 FullyCPUVisible: 1; + UINT64 Reserved : 55; +#else + UINT64 Reserved : 58; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) +#else + UINT64 Reserved : 62; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + } SegmentProperties; + D3DKMT_ALIGN64 UINT64 Reserved[5]; +#else + D3DKMT_ALIGN64 UINT64 Reserved[6]; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) +#else + D3DKMT_ALIGN64 UINT64 Reserved[8]; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +} D3DKMT_QUERYSTATISTICS_SEGMENT_INFORMATION; + +// +// Video memory statistics. +// +typedef struct _D3DKMT_QUERYSTATISTICS_VIDEO_MEMORY +{ + ULONG AllocsCommitted; + D3DKMT_QUERYSTATISTICS_COUNTER AllocsResidentInP[D3DKMT_QUERYSTATISTICS_SEGMENT_PREFERENCE_MAX]; + D3DKMT_QUERYSTATISTICS_COUNTER AllocsResidentInNonPreferred; + D3DKMT_ALIGN64 ULONGLONG TotalBytesEvictedDueToPreparation; +} D3DKMT_QUERYSTATISTICS_VIDEO_MEMORY; + +// +// VidMM Policies +// +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_POLICY +{ + D3DKMT_ALIGN64 ULONGLONG UseMRU; +} D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_POLICY; + +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_INFORMATION +{ +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + D3DKMT_ALIGN64 ULONGLONG BytesCommitted; + D3DKMT_ALIGN64 ULONGLONG MaximumWorkingSet; + D3DKMT_ALIGN64 ULONGLONG MinimumWorkingSet; + + ULONG NbReferencedAllocationEvictedInPeriod; + UINT Padding; +#else + ULONG BytesCommitted; + ULONG NbReferencedAllocationEvictedInPeriod; + ULONG MaximumWorkingSet; + ULONG MinimumWorkingSet; +#endif + + D3DKMT_QUERYSTATISTICS_VIDEO_MEMORY VideoMemory; + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_POLICY _Policy; + + D3DKMT_ALIGN64 UINT64 Reserved[8]; +} D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_INFORMATION; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef struct _D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP_INFORMATION +{ + D3DKMT_ALIGN64 UINT64 Budget; + D3DKMT_ALIGN64 UINT64 Requested; + D3DKMT_ALIGN64 UINT64 Usage; + D3DKMT_ALIGN64 UINT64 Demoted[D3DKMT_QUERYSTATISTICS_ALLOCATION_PRIORITY_CLASS_MAX]; +} D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP_INFORMATION; +#endif + +typedef enum _D3DKMT_QUERYSTATISTICS_TYPE +{ + D3DKMT_QUERYSTATISTICS_ADAPTER = 0, + D3DKMT_QUERYSTATISTICS_PROCESS = 1, + D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER = 2, + D3DKMT_QUERYSTATISTICS_SEGMENT = 3, + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT = 4, + D3DKMT_QUERYSTATISTICS_NODE = 5, + D3DKMT_QUERYSTATISTICS_PROCESS_NODE = 6, + D3DKMT_QUERYSTATISTICS_VIDPNSOURCE = 7, + D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE = 8, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP = 9, +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_QUERYSTATISTICS_PHYSICAL_ADAPTER = 10, +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + D3DKMT_QUERYSTATISTICS_ADAPTER2 = 11, + D3DKMT_QUERYSTATISTICS_SEGMENT2 = 12, + D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER2 = 13, + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT2 = 14, + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP2 = 15, + D3DKMT_QUERYSTATISTICS_SEGMENT_USAGE = 16, + D3DKMT_QUERYSTATISTICS_SEGMENT_GROUP_USAGE = 17, + D3DKMT_QUERYSTATISTICS_NODE2 = 18, + D3DKMT_QUERYSTATISTICS_PROCESS_NODE2 = 19 +#endif +} D3DKMT_QUERYSTATISTICS_TYPE; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT +{ + ULONG SegmentId; // in: id of node to get statistics for +} D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_NODE +{ + ULONG NodeId; +} D3DKMT_QUERYSTATISTICS_QUERY_NODE; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_VIDPNSOURCE +{ + ULONG VidPnSourceId; // in: id of segment to get statistics for +} D3DKMT_QUERYSTATISTICS_QUERY_VIDPNSOURCE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_PHYSICAL_ADAPTER +{ + ULONG PhysicalAdapterIndex; +} D3DKMT_QUERYSTATISTICS_QUERY_PHYSICAL_ADAPTER; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +typedef struct _D3DKMT_QUERYSTATISTICS_MEMORY_USAGE +{ + D3DKMT_ALIGN64 UINT64 AllocatedBytes; + D3DKMT_ALIGN64 UINT64 FreeBytes; + D3DKMT_ALIGN64 UINT64 ZeroBytes; + D3DKMT_ALIGN64 UINT64 ModifiedBytes; + D3DKMT_ALIGN64 UINT64 StandbyBytes; +} D3DKMT_QUERYSTATISTICS_MEMORY_USAGE; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT2 +{ + UINT16 PhysicalAdapterIndex; + UINT16 SegmentId; +} D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT2; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_USAGE +{ + UINT16 PhysicalAdapterIndex; + UINT16 SegmentId; +} D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_USAGE; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_GROUP_USAGE +{ + UINT16 PhysicalAdapterIndex; + UINT16 SegmentGroup; // D3DKMT_MEMORY_SEGMENT_GROUP +} D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_GROUP_USAGE; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER2 +{ + UINT16 PhysicalAdapterIndex; +} D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER2; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER_INFORMATION2 +{ + UINT16 PhysicalAdapterIndex; +} D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER_INFORMATION2; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_PROCESS_SEGMENT_GROUP2 +{ + UINT16 PhysicalAdapterIndex; + UINT16 SegmentGroup; // D3DKMT_MEMORY_SEGMENT_GROUP +} D3DKMT_QUERYSTATISTICS_QUERY_PROCESS_SEGMENT_GROUP2; + +typedef struct _D3DKMT_QUERYSTATISTICS_QUERY_NODE2 +{ + UINT16 PhysicalAdapterIndex; + UINT16 NodeOrdinal; +} D3DKMT_QUERYSTATISTICS_QUERY_NODE2; + +#endif + +typedef union _D3DKMT_QUERYSTATISTICS_RESULT +{ + D3DKMT_QUERYSTATISTICS_ADAPTER_INFORMATION AdapterInformation; // out: result of D3DKMT_QUERYSTATISTICS_ADAPTER(2) query +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_QUERYSTATISTICS_PHYSICAL_ADAPTER_INFORMATION PhysAdapterInformation; // out: result of D3DKMT_QUERYSTATISTICS_PHYSICAL_ADAPTER query +#endif + D3DKMT_QUERYSTATISTICS_SEGMENT_INFORMATION SegmentInformation; // out: result of D3DKMT_QUERYSTATISTICS_SEGMENT(2) query + D3DKMT_QUERYSTATISTICS_NODE_INFORMATION NodeInformation; // out: result of D3DKMT_QUERYSTATISTICS_NODE query + D3DKMT_QUERYSTATISTICS_VIDPNSOURCE_INFORMATION VidPnSourceInformation; // out: result of D3DKMT_QUERYSTATISTICS_VIDPNSOURCE query + D3DKMT_QUERYSTATISTICS_PROCESS_INFORMATION ProcessInformation; // out: result of D3DKMT_QUERYSTATISTICS_PROCESS query + D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER_INFORMATION ProcessAdapterInformation; // out: result of D3DKMT_QUERYSTATISTICS_PROCESS_ADAPTER(2) query + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_INFORMATION ProcessSegmentInformation; // out: result of D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT(2) query + D3DKMT_QUERYSTATISTICS_PROCESS_NODE_INFORMATION ProcessNodeInformation; // out: result of D3DKMT_QUERYSTATISTICS_PROCESS_NODE query + D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE_INFORMATION ProcessVidPnSourceInformation; // out: result of D3DKMT_QUERYSTATISTICS_PROCESS_VIDPNSOURCE query +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP_INFORMATION ProcessSegmentGroupInformation;// out: result of D3DKMT_QUERYSTATISTICS_PROCESS_SEGMENT_GROUP(2) query +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + D3DKMT_QUERYSTATISTICS_MEMORY_USAGE SegmentUsageInformation; // out: result of D3DKMT_QUERYSTATISTICS_SEGMENT_USAGE query + D3DKMT_QUERYSTATISTICS_MEMORY_USAGE SegmentGroupUsageInformation; // out: result of D3DKMT_QUERYSTATISTICS_SEGMENT_GROUP_USAGE query +#endif +} D3DKMT_QUERYSTATISTICS_RESULT; + +typedef struct _D3DKMT_QUERYSTATISTICS +{ + D3DKMT_QUERYSTATISTICS_TYPE Type; // in: type of data requested + LUID AdapterLuid; // in: adapter to get export / statistics from + D3DKMT_PTR(HANDLE, hProcess); // in: process to get statistics for, if required for this query type + D3DKMT_QUERYSTATISTICS_RESULT QueryResult; // out: requested data + + union + { + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT QuerySegment; // in: id of segment to get statistics for + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT QueryProcessSegment; // in: id of segment to get statistics for +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + D3DKMT_MEMORY_SEGMENT_GROUP QueryProcessSegmentGroup; // in: id of segment group to get statistics for +#endif + D3DKMT_QUERYSTATISTICS_QUERY_NODE QueryNode; // in: id of node to get statistics for + D3DKMT_QUERYSTATISTICS_QUERY_NODE QueryProcessNode; // in: id of node to get statistics for + D3DKMT_QUERYSTATISTICS_QUERY_VIDPNSOURCE QueryVidPnSource; // in: id of vidpnsource to get statistics for + D3DKMT_QUERYSTATISTICS_QUERY_VIDPNSOURCE QueryProcessVidPnSource; // in: id of vidpnsource to get statistics for +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + D3DKMT_QUERYSTATISTICS_QUERY_PHYSICAL_ADAPTER QueryPhysAdapter; // in: id of physical adapter to get statistics for +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER2 QueryAdapter2; + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT2 QuerySegment2; + D3DKMT_QUERYSTATISTICS_QUERY_ADAPTER2 QueryProcessAdapter2; + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT2 QueryProcessSegment2; + D3DKMT_QUERYSTATISTICS_QUERY_PROCESS_SEGMENT_GROUP2 QueryProcessSegmentGroup2; + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_USAGE QuerySegmentUsage; + D3DKMT_QUERYSTATISTICS_QUERY_SEGMENT_GROUP_USAGE QuerySegmentGroupUsage; + D3DKMT_QUERYSTATISTICS_QUERY_NODE2 QueryNode2; // in: id of node to get statistics for + D3DKMT_QUERYSTATISTICS_QUERY_NODE2 QueryProcessNode2; // in: id of node to get statistics for +#endif + }; +} D3DKMT_QUERYSTATISTICS; +#if defined(_AMD64_) +C_ASSERT(sizeof(D3DKMT_QUERYSTATISTICS) == 0x328); +#endif + +// +// end D3DKMT_QUERYSTATISTICS +// + + +typedef struct _D3DKMT_PRESENT_STATS_DWM2 +{ + ULONG cbSize; // in: size of struct for versioning + UINT PresentCount; + UINT PresentRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER PresentQPCTime; + UINT SyncRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER SyncQPCTime; + UINT CustomPresentDuration; + UINT VirtualSyncRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER VirtualSyncQPCTime; + D3DKMT_ALIGN64 LARGE_INTEGER VSyncDurationQPCTime; + UINT VSyncMultiplier; + UINT VirtualPresentRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER VirtualPresentQPCTime; +} D3DKMT_PRESENT_STATS_DWM2; + + +typedef enum _D3DKMT_VIDPNSOURCEOWNER_TYPE +{ + D3DKMT_VIDPNSOURCEOWNER_UNOWNED = 0, //Has no owner or GDI is the owner + D3DKMT_VIDPNSOURCEOWNER_SHARED = 1, //Has shared owner, that is owner can yield to any exclusive owner, not available to legacy devices + D3DKMT_VIDPNSOURCEOWNER_EXCLUSIVE = 2, //Has exclusive owner without shared gdi primary, + D3DKMT_VIDPNSOURCEOWNER_EXCLUSIVEGDI = 3, //Has exclusive owner with shared gdi primary and must be exclusive owner of all VidPn sources, only available to legacy devices + D3DKMT_VIDPNSOURCEOWNER_EMULATED = 4, //Does not have real primary ownership, but allows the device to set gamma on its owned sources +} D3DKMT_VIDPNSOURCEOWNER_TYPE; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_VIDPNSOURCEOWNER_FLAGS +{ + union + { + struct + { + UINT AllowOutputDuplication : 1; + UINT DisableDWMVirtualMode : 1; + UINT UseNtHandles : 1; + UINT Reserved : 29; + }; + UINT Value; + }; +} D3DKMT_VIDPNSOURCEOWNER_FLAGS; +#endif + +typedef struct _D3DKMT_SETVIDPNSOURCEOWNER +{ + D3DKMT_HANDLE hDevice; // in: Device handle + D3DKMT_PTR(CONST D3DKMT_VIDPNSOURCEOWNER_TYPE*, pType); // in: OwnerType array + D3DKMT_PTR(CONST D3DDDI_VIDEO_PRESENT_SOURCE_ID*, pVidPnSourceId); // in: VidPn source ID array + UINT VidPnSourceCount; // in: Number of valid entries in above array +} D3DKMT_SETVIDPNSOURCEOWNER; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef struct _D3DKMT_SETVIDPNSOURCEOWNER1 +{ + D3DKMT_SETVIDPNSOURCEOWNER Version0; + D3DKMT_VIDPNSOURCEOWNER_FLAGS Flags; +} D3DKMT_SETVIDPNSOURCEOWNER1; +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +typedef struct _D3DKMT_SETVIDPNSOURCEOWNER2 +{ + D3DKMT_SETVIDPNSOURCEOWNER1 Version1; + D3DKMT_PTR(CONST D3DKMT_PTR_TYPE*, pVidPnSourceNtHandles); // in: VidPn source owner DispMgr NT handles +} D3DKMT_SETVIDPNSOURCEOWNER2; +#endif + +typedef struct _D3DKMT_CHECKVIDPNEXCLUSIVEOWNERSHIP +{ + D3DKMT_HANDLE hAdapter; // in: Adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPn source ID array +} D3DKMT_CHECKVIDPNEXCLUSIVEOWNERSHIP; + +#define D3DKMT_GETPRESENTHISTORY_MAXTOKENS 2048 + +typedef struct _D3DKMT_GETPRESENTHISTORY +{ + D3DKMT_HANDLE hAdapter; // in: Handle to adapter + UINT ProvidedSize; // in: Size of provided buffer + UINT WrittenSize; // out: Copied token size or required size for first token + D3DKMT_PTR(_Field_size_bytes_(ProvidedSize) D3DKMT_PRESENTHISTORYTOKEN*, pTokens); // in: Pointer to buffer. + UINT NumTokens; // out: Number of copied token +} D3DKMT_GETPRESENTHISTORY; + +typedef struct _D3DKMT_CREATEOVERLAY +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DDDI_KERNELOVERLAYINFO OverlayInfo; // in + D3DKMT_HANDLE hOverlay; // out: Kernel overlay handle +} D3DKMT_CREATEOVERLAY; + +typedef struct _D3DKMT_UPDATEOVERLAY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hOverlay; // in: Kernel overlay handle + D3DDDI_KERNELOVERLAYINFO OverlayInfo; // in +} D3DKMT_UPDATEOVERLAY; + +typedef struct _D3DKMT_FLIPOVERLAY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hOverlay; // in: Kernel overlay handle + D3DKMT_HANDLE hSource; // in: Allocation currently displayed + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in: Size of private driver data +} D3DKMT_FLIPOVERLAY; + +typedef struct _D3DKMT_GETOVERLAYSTATE +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hOverlay; // in: Kernel overlay handle + BOOLEAN OverlayEnabled; +} D3DKMT_GETOVERLAYSTATE; + +typedef struct _D3DKMT_DESTROYOVERLAY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hOverlay; // in: Kernel overlay handle +} D3DKMT_DESTROYOVERLAY; + +typedef struct _D3DKMT_WAITFORVERTICALBLANKEVENT +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in: device handle [Optional] + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID +} D3DKMT_WAITFORVERTICALBLANKEVENT; + +#define D3DKMT_MAX_WAITFORVERTICALBLANK_OBJECTS 8 + +typedef struct _D3DKMT_WAITFORVERTICALBLANKEVENT2 +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in: device handle [Optional] + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + UINT NumObjects; + D3DKMT_PTR_TYPE ObjectHandleArray[D3DKMT_MAX_WAITFORVERTICALBLANK_OBJECTS]; // in: Specifies the objects to wait on. +} D3DKMT_WAITFORVERTICALBLANKEVENT2; + +typedef struct _D3DKMT_GETVERTICALBLANKEVENT +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in: device handle [Optional] + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + D3DKMT_PTR(D3DKMT_PTR_TYPE*, phEvent); +} D3DKMT_GETVERTICALBLANKEVENT; + +typedef struct _D3DKMT_SETSYNCREFRESHCOUNTWAITTARGET +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DKMT_HANDLE hDevice; // in: device handle [Optional] + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + UINT TargetSyncRefreshCount; +} D3DKMT_SETSYNCREFRESHCOUNTWAITTARGET; + +typedef struct _D3DKMT_SETGAMMARAMP +{ + D3DKMT_HANDLE hDevice; // in: device handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + D3DDDI_GAMMARAMP_TYPE Type; // in: Gamma ramp type + + union + { + D3DDDI_GAMMA_RAMP_RGB256x3x16* pGammaRampRgb256x3x16; + D3DDDI_GAMMA_RAMP_DXGI_1* pGammaRampDXGI1; + D3DKMT_PTR_HELPER( AlignUnionTo64) + }; + UINT Size; +} D3DKMT_SETGAMMARAMP; + +typedef struct _D3DKMT_ADJUSTFULLSCREENGAMMA +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + D3DDDI_DXGI_RGB Scale; + D3DDDI_DXGI_RGB Offset; +} D3DKMT_ADJUSTFULLSCREENGAMMA; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + +typedef struct _D3DKMT_SET_COLORSPACE_TRANSFORM +{ + _In_ LUID AdapterLuid; + _In_ D3DDDI_VIDEO_PRESENT_TARGET_ID VidPnTargetId; + _In_ D3DDDI_GAMMARAMP_TYPE Type; + _In_ UINT Size; + union + { + _In_reads_bytes_opt_(Size) D3DKMDT_3x4_COLORSPACE_TRANSFORM* pColorSpaceTransform; + D3DKMT_PTR_HELPER( AlignUnionTo64) + }; +} D3DKMT_SET_COLORSPACE_TRANSFORM; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_3 + +typedef struct _D3DKMT_SETVIDPNSOURCEHWPROTECTION +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN Source ID + BOOL HwProtected; // in: HW protection status +} D3DKMT_SETVIDPNSOURCEHWPROTECTION; + +typedef struct _D3DKMT_SETHWPROTECTIONTEARDOWNRECOVERY +{ + D3DKMT_HANDLE hAdapter; // in: adapter handle + BOOL Recovered; // in: HW protection teardown recovery +} D3DKMT_SETHWPROTECTIONTEARDOWNRECOVERY; + +typedef enum _D3DKMT_DEVICEEXECUTION_STATE +{ + D3DKMT_DEVICEEXECUTION_ACTIVE = 1, + D3DKMT_DEVICEEXECUTION_RESET = 2, + D3DKMT_DEVICEEXECUTION_HUNG = 3, + D3DKMT_DEVICEEXECUTION_STOPPED = 4, + D3DKMT_DEVICEEXECUTION_ERROR_OUTOFMEMORY = 5, + D3DKMT_DEVICEEXECUTION_ERROR_DMAFAULT = 6, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DKMT_DEVICEEXECUTION_ERROR_DMAPAGEFAULT = 7, +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +} D3DKMT_DEVICEEXECUTION_STATE; + +typedef struct _D3DKMT_DEVICERESET_STATE +{ + union + { + struct + { + UINT DesktopSwitched : 1; // 0x00000001 + UINT Reserved :31; // 0xFFFFFFFE + }; + UINT Value; + }; +} D3DKMT_DEVICERESET_STATE; + +typedef struct _D3DKMT_PRESENT_STATS +{ + UINT PresentCount; + UINT PresentRefreshCount; + UINT SyncRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER SyncQPCTime; + D3DKMT_ALIGN64 LARGE_INTEGER SyncGPUTime; +} D3DKMT_PRESENT_STATS; + +typedef struct _D3DKMT_DEVICEPRESENT_STATE +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: present source id + D3DKMT_PRESENT_STATS PresentStats; // out: present stats +} D3DKMT_DEVICEPRESENT_STATE; + +typedef struct _D3DKMT_PRESENT_STATS_DWM +{ + UINT PresentCount; + UINT PresentRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER PresentQPCTime; + UINT SyncRefreshCount; + D3DKMT_ALIGN64 LARGE_INTEGER SyncQPCTime; + UINT CustomPresentDuration; +} D3DKMT_PRESENT_STATS_DWM; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_DEVICEPAGEFAULT_STATE +{ + D3DKMT_ALIGN64 UINT64 FaultedPrimitiveAPISequenceNumber; // when per draw fence write is enabled, identifies the draw that caused the page fault, or DXGK_PRIMITIVE_API_SEQUENCE_NUMBER_UNKNOWN if such information is not available. + DXGK_RENDER_PIPELINE_STAGE FaultedPipelineStage; // render pipeline stage during which the fault was generated, or DXGK_RENDER_PIPELINE_STAGE_UNKNOWN if such information is not available. + UINT FaultedBindTableEntry; // a bind table index of a resource being accessed at the time of the fault, or DXGK_BIND_TABLE_ENTRY_UNKNOWN if such information is not available. + DXGK_PAGE_FAULT_FLAGS PageFaultFlags; // flags specifying the nature of the fault + DXGK_FAULT_ERROR_CODE FaultErrorCode; // Structure that contains error code describing the fault. + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS FaultedVirtualAddress; // virtual address of faulting resource, or D3DGPU_NULL if such information is not available. +} D3DKMT_DEVICEPAGEFAULT_STATE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_DEVICEPRESENT_STATE_DWM +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: present source id + D3DKMT_PRESENT_STATS_DWM PresentStatsDWM; // out: present stats rev 2 +} D3DKMT_DEVICEPRESENT_STATE_DWM; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +typedef struct _D3DKMT_DEVICEPRESENT_QUEUE_STATE +{ + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: present source id + BOOLEAN bQueuedPresentLimitReached; // out: whether the queued present limit has been reached +} D3DKMT_DEVICEPRESENT_QUEUE_STATE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +typedef enum _D3DKMT_DEVICESTATE_TYPE +{ + D3DKMT_DEVICESTATE_EXECUTION = 1, + D3DKMT_DEVICESTATE_PRESENT = 2, + D3DKMT_DEVICESTATE_RESET = 3, + D3DKMT_DEVICESTATE_PRESENT_DWM = 4, + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + + D3DKMT_DEVICESTATE_PAGE_FAULT = 5, + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + + D3DKMT_DEVICESTATE_PRESENT_QUEUE = 6, + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_1 +} D3DKMT_DEVICESTATE_TYPE; + +typedef struct _D3DKMT_GETDEVICESTATE +{ + D3DKMT_HANDLE hDevice; // in: device handle + D3DKMT_DEVICESTATE_TYPE StateType; // in: device state type + union + { + D3DKMT_DEVICEEXECUTION_STATE ExecutionState; // out: device state + D3DKMT_DEVICEPRESENT_STATE PresentState; // in/out: present state + D3DKMT_DEVICERESET_STATE ResetState; // out: reset state + D3DKMT_DEVICEPRESENT_STATE_DWM PresentStateDWM; // in/out: present state + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + + D3DKMT_DEVICEPAGEFAULT_STATE PageFaultState; // out: page fault state + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + + D3DKMT_DEVICEPRESENT_QUEUE_STATE PresentQueueState; // in/out: present queue state + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_1 + }; +} D3DKMT_GETDEVICESTATE; + +typedef struct _D3DKMT_CREATEDCFROMMEMORY +{ + D3DKMT_PTR(VOID*, pMemory); // in: memory for DC + D3DDDIFORMAT Format; // in: Memory pixel format + UINT Width; // in: Memory Width + UINT Height; // in: Memory Height + UINT Pitch; // in: Memory pitch + D3DKMT_PTR(HDC, hDeviceDc); // in: DC describing the device + D3DKMT_PTR(PALETTEENTRY*, pColorTable); // in: Palette + D3DKMT_PTR(HDC, hDc); // out: HDC + D3DKMT_PTR(HANDLE, hBitmap); // out: Handle to bitmap +} D3DKMT_CREATEDCFROMMEMORY; + +typedef struct _D3DKMT_DESTROYDCFROMMEMORY +{ + D3DKMT_PTR(HDC, hDc); // in: + D3DKMT_PTR(HANDLE, hBitmap); // in: +} D3DKMT_DESTROYDCFROMMEMORY; + +#define D3DKMT_SETCONTEXTSCHEDULINGPRIORITY_ABSOLUTE 0x40000000 + +typedef struct _D3DKMT_SETCONTEXTSCHEDULINGPRIORITY +{ + D3DKMT_HANDLE hContext; // in: context handle + INT Priority; // in: context priority +} D3DKMT_SETCONTEXTSCHEDULINGPRIORITY; + +typedef struct _D3DKMT_SETCONTEXTINPROCESSSCHEDULINGPRIORITY +{ + D3DKMT_HANDLE hContext; // in: context handle + INT Priority; // in: context priority +} D3DKMT_SETCONTEXTINPROCESSSCHEDULINGPRIORITY; + +typedef struct _D3DKMT_CHANGESURFACEPOINTER +{ + D3DKMT_PTR(HDC, hDC); // in: dc handle + D3DKMT_PTR(HANDLE, hBitmap); // in: bitmap handle + D3DKMT_PTR(LPVOID, pSurfacePointer);// in: new surface pointer + UINT Width; // in: Memory Width + UINT Height; // in: Memory Height + UINT Pitch; // in: Memory pitch +} D3DKMT_CHANGESURFACEPOINTER; + +typedef struct _D3DKMT_GETCONTEXTSCHEDULINGPRIORITY +{ + D3DKMT_HANDLE hContext; // in: context handle + INT Priority; // out: context priority +} D3DKMT_GETCONTEXTSCHEDULINGPRIORITY; + +typedef struct _D3DKMT_GETCONTEXTINPROCESSSCHEDULINGPRIORITY +{ + D3DKMT_HANDLE hContext; // in: context handle + INT Priority; // out: context priority +} D3DKMT_GETCONTEXTINPROCESSSCHEDULINGPRIORITY; + +typedef enum _D3DKMT_SCHEDULINGPRIORITYCLASS +{ + D3DKMT_SCHEDULINGPRIORITYCLASS_IDLE = 0, + D3DKMT_SCHEDULINGPRIORITYCLASS_BELOW_NORMAL = 1, + D3DKMT_SCHEDULINGPRIORITYCLASS_NORMAL = 2, + D3DKMT_SCHEDULINGPRIORITYCLASS_ABOVE_NORMAL = 3, + D3DKMT_SCHEDULINGPRIORITYCLASS_HIGH = 4, + D3DKMT_SCHEDULINGPRIORITYCLASS_REALTIME = 5, +} D3DKMT_SCHEDULINGPRIORITYCLASS; + +typedef struct _D3DKMT_GETSCANLINE +{ + D3DKMT_HANDLE hAdapter; // in: Adapter handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: Adapter's VidPN Source ID + BOOLEAN InVerticalBlank; // out: Within vertical blank + UINT ScanLine; // out: Current scan line +} D3DKMT_GETSCANLINE; + +typedef enum _D3DKMT_QUEUEDLIMIT_TYPE +{ + D3DKMT_SET_QUEUEDLIMIT_PRESENT = 1, + D3DKMT_GET_QUEUEDLIMIT_PRESENT = 2, +} D3DKMT_QUEUEDLIMIT_TYPE; + +typedef struct _D3DKMT_SETQUEUEDLIMIT +{ + D3DKMT_HANDLE hDevice; // in: device handle + D3DKMT_QUEUEDLIMIT_TYPE Type; // in: limit type + union + { + UINT QueuedPresentLimit; // in (or out): queued present limit + struct + { + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: adapter's VidPN source ID + UINT QueuedPendingFlipLimit; // in (or out): flip pending limit + }; + }; +} D3DKMT_SETQUEUEDLIMIT; + +typedef struct _D3DKMT_POLLDISPLAYCHILDREN +{ + D3DKMT_HANDLE hAdapter; // in: Adapter handle + UINT NonDestructiveOnly : 1; // in: 0x00000001 Destructive or not + UINT SynchronousPolling : 1; // in: 0x00000002 Synchronous polling or not + UINT DisableModeReset : 1; // in: 0x00000004 Disable DMM mode reset on monitor event + UINT PollAllAdapters : 1; // in: 0x00000008 Poll all adapters + UINT PollInterruptible : 1; // in: 0x00000010 Poll interruptible targets as well. + UINT Reserved : 27; // in: 0xffffffc0 +} D3DKMT_POLLDISPLAYCHILDREN; + +typedef struct _D3DKMT_INVALIDATEACTIVEVIDPN +{ + D3DKMT_HANDLE hAdapter; // in: Adapter handle + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in: Size of private driver data +} D3DKMT_INVALIDATEACTIVEVIDPN; + +typedef struct _D3DKMT_CHECKOCCLUSION +{ + D3DKMT_PTR(HWND, hWindow); // in: Destination window handle +} D3DKMT_CHECKOCCLUSION; + +typedef struct _D3DKMT_WAITFORIDLE +{ + D3DKMT_HANDLE hDevice; // in: Device to wait for idle +} D3DKMT_WAITFORIDLE; + +typedef struct _D3DKMT_CHECKMONITORPOWERSTATE +{ + D3DKMT_HANDLE hAdapter; // in: Adapter to check on + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: Adapter's VidPN Source ID +} D3DKMT_CHECKMONITORPOWERSTATE; + +typedef struct _D3DKMT_SETDISPLAYPRIVATEDRIVERFORMAT +{ + D3DKMT_HANDLE hDevice; // in: Identifies the device + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: Identifies which VidPn we are changing the private driver format attribute for + UINT PrivateDriverFormatAttribute; // In: Requested private format attribute for VidPn specified +} D3DKMT_SETDISPLAYPRIVATEDRIVERFORMAT; + +typedef struct _D3DKMT_CREATEKEYEDMUTEX +{ + D3DKMT_ALIGN64 UINT64 InitialValue; // in: Initial value to release to + D3DKMT_HANDLE hSharedHandle; // out: Global handle to keyed mutex + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process +} D3DKMT_CREATEKEYEDMUTEX; + +typedef struct _D3DKMT_OPENKEYEDMUTEX +{ + D3DKMT_HANDLE hSharedHandle; // in: Global handle to keyed mutex + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process +} D3DKMT_OPENKEYEDMUTEX; + +typedef struct _D3DKMT_DESTROYKEYEDMUTEX +{ + D3DKMT_HANDLE hKeyedMutex; // in: Identifies the keyed mutex being destroyed. +} D3DKMT_DESTROYKEYEDMUTEX; + +typedef struct _D3DKMT_ACQUIREKEYEDMUTEX +{ + D3DKMT_HANDLE hKeyedMutex; // in: Handle to the keyed mutex + D3DKMT_ALIGN64 UINT64 Key; // in: Key value to Acquire + D3DKMT_PTR(PLARGE_INTEGER, pTimeout); // in: NT-style timeout value + D3DKMT_ALIGN64 UINT64 FenceValue; // out: Current fence value of the GPU sync object +} D3DKMT_ACQUIREKEYEDMUTEX; + +typedef struct _D3DKMT_RELEASEKEYEDMUTEX +{ + D3DKMT_HANDLE hKeyedMutex; // in: Handle to the keyed mutex + D3DKMT_ALIGN64 UINT64 Key; // in: Key value to Release to + D3DKMT_ALIGN64 UINT64 FenceValue; // in: New fence value to use for GPU sync object +} D3DKMT_RELEASEKEYEDMUTEX; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + +typedef struct _D3DKMT_CREATEKEYEDMUTEX2_FLAGS +{ + union + { + struct + { + UINT NtSecuritySharing : 1; // If set, the keyed mutex will be shared using DxgkShareObjects instead of D3DKMT_CREATEKEYEDMUTEX2::hSharedHandle + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DKMT_CREATEKEYEDMUTEX2_FLAGS; + +typedef struct _D3DKMT_CREATEKEYEDMUTEX2 +{ + D3DKMT_ALIGN64 UINT64 InitialValue; // in: Initial value to release to + D3DKMT_HANDLE hSharedHandle; // out: Global handle to keyed mutex, NULL if NtSecuritySharing is set. + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process + D3DKMT_PTR(_In_reads_bytes_opt_(PrivateRuntimeDataSize) + VOID*, pPrivateRuntimeData); // in: Buffer containing initial private data. + // If NULL then PrivateRuntimeDataSize must be 0. + UINT PrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. + D3DKMT_CREATEKEYEDMUTEX2_FLAGS Flags; // in: Creation flags. +} D3DKMT_CREATEKEYEDMUTEX2; + +typedef struct _D3DKMT_OPENKEYEDMUTEX2 +{ + D3DKMT_HANDLE hSharedHandle; // in: Global handle to keyed mutex + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process + D3DKMT_PTR(_In_reads_bytes_opt_(PrivateRuntimeDataSize) + VOID*, pPrivateRuntimeData); // in: Buffer containing initial private data. + // If NULL then PrivateRuntimeDataSize must be 0. + // It will only be copied if the keyed mutex does not already have private data. + UINT PrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. +} D3DKMT_OPENKEYEDMUTEX2; + +typedef struct _D3DKMT_OPENKEYEDMUTEXFROMNTHANDLE +{ + D3DKMT_PTR(HANDLE, hNtHandle); // in: NT handle to keyed mutex + D3DKMT_HANDLE hKeyedMutex; // out: Handle to the keyed mutex in this process + D3DKMT_PTR(_In_reads_bytes_opt_(PrivateRuntimeDataSize) + VOID*, pPrivateRuntimeData); // in: Buffer containing initial private data. + // If NULL then PrivateRuntimeDataSize must be 0. + // It will only be copied if the keyed mutex does not already have private data. + UINT PrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. +} D3DKMT_OPENKEYEDMUTEXFROMNTHANDLE; + +typedef struct _D3DKMT_ACQUIREKEYEDMUTEX2 +{ + D3DKMT_HANDLE hKeyedMutex; // in: Handle to the keyed mutex + D3DKMT_ALIGN64 UINT64 Key; // in: Key value to Acquire + D3DKMT_PTR(PLARGE_INTEGER, pTimeout); // in: NT-style timeout value + D3DKMT_ALIGN64 UINT64 FenceValue; // out: Current fence value of the GPU sync object + D3DKMT_PTR(_Out_writes_bytes_all_opt_(PrivateRuntimeDataSize) + VOID*, pPrivateRuntimeData); // out: Buffer to copy private data to. + // If NULL then PrivateRuntimeDataSize must be 0. + UINT PrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. +} D3DKMT_ACQUIREKEYEDMUTEX2; + +typedef struct _D3DKMT_RELEASEKEYEDMUTEX2 +{ + D3DKMT_HANDLE hKeyedMutex; // in: Handle to the keyed mutex + D3DKMT_ALIGN64 UINT64 Key; // in: Key value to Release to + D3DKMT_ALIGN64 UINT64 FenceValue; // in: New fence value to use for GPU sync object + D3DKMT_PTR(_In_reads_bytes_opt_(PrivateRuntimeDataSize) + VOID*, pPrivateRuntimeData); // in: Buffer containing new private data. + // If NULL then PrivateRuntimeDataSize must be 0. + UINT PrivateRuntimeDataSize; // in: Size in bytes of pPrivateRuntimeData. +} D3DKMT_RELEASEKEYEDMUTEX2; +#endif + + +typedef struct _D3DKMT_CONFIGURESHAREDRESOURCE +{ + D3DKMT_HANDLE hDevice; // in: Device that created the resource + D3DKMT_HANDLE hResource; // in: Handle for shared resource + BOOLEAN IsDwm; // in: TRUE when the process is DWM + D3DKMT_PTR(HANDLE, hProcess); // in: Process handle for the non-DWM case + BOOLEAN AllowAccess; // in: Indicates whereh the process is allowed access +} D3DKMT_CONFIGURESHAREDRESOURCE; + +typedef struct _D3DKMT_CHECKSHAREDRESOURCEACCESS +{ + D3DKMT_HANDLE hResource; // in: Handle for the resource + UINT ClientPid; // in: Client process PID +} D3DKMT_CHECKSHAREDRESOURCEACCESS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef enum _D3DKMT_OFFER_PRIORITY +{ + D3DKMT_OFFER_PRIORITY_LOW=1, // Content is not useful + D3DKMT_OFFER_PRIORITY_NORMAL, // Content is useful but easy to regenerate + D3DKMT_OFFER_PRIORITY_HIGH, // Content is useful and difficult to regenerate + D3DKMT_OFFER_PRIORITY_AUTO, // Let VidMm decide offer priority based on eviction priority +} D3DKMT_OFFER_PRIORITY; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +typedef struct _D3DKMT_OFFER_FLAGS +{ + union + { + struct + { + UINT OfferImmediately : 1; // 0x00000001 + UINT AllowDecommit : 1; // 0x00000002 + UINT Reserved : 30; // 0xFFFFFFFC + }; + UINT Value; + }; +} D3DKMT_OFFER_FLAGS; +#endif // DXGKDDI_INTERFACE_VERSION + +typedef struct _D3DKMT_OFFERALLOCATIONS +{ + D3DKMT_HANDLE hDevice; // in: Device that created the allocations + D3DKMT_PTR(D3DKMT_HANDLE*, pResources); // in: array of D3D runtime resource handles. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, HandleList); // in: array of allocation handles. If non-NULL, pResources must be NULL. + UINT NumAllocations; // in: number of items in whichever of pResources or HandleList is non-NULL. + D3DKMT_OFFER_PRIORITY Priority; // in: priority with which to offer the allocations +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + D3DKMT_OFFER_FLAGS Flags; // in: various flags for determining offer behavior +#endif // DXGKDDI_INTERFACE_VERSION +} D3DKMT_OFFERALLOCATIONS; + +typedef struct _D3DKMT_RECLAIMALLOCATIONS +{ + D3DKMT_HANDLE hDevice; // in: Device that created the allocations + D3DKMT_PTR(D3DKMT_HANDLE*, pResources); // in: array of D3D runtime resource handles. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, HandleList); // in: array of allocation handles. If non-NULL, pResources must be NULL. + D3DKMT_PTR(BOOL*, pDiscarded); // out: optional array of booleans specifying whether each resource or allocation was discarded. + UINT NumAllocations; // in: number of items in pDiscarded and whichever of pResources or HandleList is non-NULL. +} D3DKMT_RECLAIMALLOCATIONS; + +typedef struct _D3DKMT_RECLAIMALLOCATIONS2 +{ + D3DKMT_HANDLE hPagingQueue; // in: Device that created the allocations + UINT NumAllocations; // in: number of items in pDiscarded and whichever of pResources or HandleList is non-NULL. + D3DKMT_PTR(D3DKMT_HANDLE*, pResources); // in: array of D3D runtime resource handles. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, HandleList); // in: array of allocation handles. If non-NULL, pResources must be NULL. +#if(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1 || \ + D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_1) + union + { + BOOL* pDiscarded; // out: optional array of booleans specifying whether each resource or allocation was discarded. + D3DDDI_RECLAIM_RESULT* pResults; // out: array of results specifying whether each resource or allocation is OK, discarded, or has no commitment. + D3DKMT_PTR_HELPER(AlignUnionTo64) + }; +#else + D3DKMT_PTR(BOOL*, pDiscarded); // out: optional array of booleans specifying whether each resource or allocation was discarded. +#endif // (DXGKDDI_INTERFACE_VERSION || D3D_UMD_INTERFACE_VERSION) + D3DKMT_ALIGN64 UINT64 PagingFenceValue; // out: The paging fence to synchronize against before submitting work to the GPU which + // references any of the resources or allocations in the provided arrays +} D3DKMT_RECLAIMALLOCATIONS2; + +typedef struct _D3DKMT_OUTPUTDUPLCREATIONFLAGS +{ + union + { + struct + { + UINT CompositionUiCaptureOnly : 1; + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DKMT_OUTPUTDUPLCREATIONFLAGS; + +typedef struct _D3DKMT_OUTPUTDUPL_KEYEDMUTEX +{ + D3DKMT_PTR(HANDLE, hSharedSurfaceNt); +}D3DKMT_OUTPUTDUPL_KEYEDMUTEX; + +#define OUTPUTDUPL_CREATE_MAX_KEYEDMUTXES 3 +typedef struct _D3DKMT_CREATE_OUTPUTDUPL +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT KeyedMutexCount; // in : If zero then means is this the pre-create check + UINT RequiredKeyedMutexCount; // out: The number of keyed mutexs needed + D3DKMT_OUTPUTDUPL_KEYEDMUTEX KeyedMutexs[OUTPUTDUPL_CREATE_MAX_KEYEDMUTXES]; + D3DKMT_OUTPUTDUPLCREATIONFLAGS Flags; +} D3DKMT_CREATE_OUTPUTDUPL; + +typedef struct _D3DKMT_DESTROY_OUTPUTDUPL +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + BOOL bDestroyAllContexts; +} D3DKMT_DESTROY_OUTPUTDUPL; + +typedef struct _D3DKMT_OUTPUTDUPL_POINTER_POSITION +{ + POINT Position; + BOOL Visible; +} D3DKMT_OUTPUTDUPL_POINTER_POSITION; + +typedef struct _D3DKMT_OUTPUTDUPL_FRAMEINFO +{ + D3DKMT_ALIGN64 LARGE_INTEGER LastPresentTime; + D3DKMT_ALIGN64 LARGE_INTEGER LastMouseUpdateTime; + UINT AccumulatedFrames; + BOOL RectsCoalesced; + BOOL ProtectedContentMaskedOut; + D3DKMT_OUTPUTDUPL_POINTER_POSITION PointerPosition; + UINT TotalMetadataBufferSize; + UINT PointerShapeBufferSize; +} D3DKMT_OUTPUTDUPL_FRAMEINFO; + +typedef struct _D3DKMT_OUTPUTDUPL_GET_FRAMEINFO +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_OUTPUTDUPL_FRAMEINFO FrameInfo; +} D3DKMT_OUTPUTDUPL_GET_FRAMEINFO; + +typedef enum _D3DKMT_OUTPUTDUPL_METADATATYPE +{ + D3DKMT_OUTPUTDUPL_METADATATYPE_DIRTY_RECTS = 0, + D3DKMT_OUTPUTDUPL_METADATATYPE_MOVE_RECTS = 1 +} D3DKMT_OUTPUTDUPL_METADATATYPE; + +typedef struct _D3DKMT_OUTPUTDUPL_METADATA +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_OUTPUTDUPL_METADATATYPE Type; + UINT BufferSizeSupplied; + D3DKMT_PTR(_Field_size_bytes_part_(BufferSizeSupplied, BufferSizeRequired) PVOID, pBuffer); + UINT BufferSizeRequired; +} D3DKMT_OUTPUTDUPL_METADATA; + +typedef enum _D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE +{ + D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME = 0x00000001, + D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE_COLOR = 0x00000002, + D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR = 0x00000004 +} D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE; + +typedef struct _D3DKMT_OUTDUPL_POINTER_SHAPE_INFO +{ + D3DKMT_OUTDUPL_POINTER_SHAPE_TYPE Type; + UINT Width; + UINT Height; + UINT Pitch; + POINT HotSpot; +} D3DKMT_OUTDUPL_POINTER_SHAPE_INFO; + +typedef struct _D3DKMT_OUTPUTDUPL_GET_POINTER_SHAPE_DATA +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT BufferSizeSupplied; + D3DKMT_PTR(_Field_size_bytes_part_(BufferSizeSupplied, BufferSizeRequired) PVOID, pShapeBuffer); + UINT BufferSizeRequired; + D3DKMT_OUTDUPL_POINTER_SHAPE_INFO ShapeInfo; +} D3DKMT_OUTPUTDUPL_GET_POINTER_SHAPE_DATA; + +typedef struct _D3DKMT_OUTPUTDUPL_RELEASE_FRAME +{ + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + UINT NextKeyMutexIdx; // out : index of the next keyed mutex to use +} D3DKMT_OUTPUTDUPL_RELEASE_FRAME; + + +#define D3DKMT_MAX_OBJECTS_PER_HANDLE 3 + +#define D3DKMT_MAX_BUNDLE_OBJECTS_PER_HANDLE 16 + +#define D3DKMT_GDI_STYLE_HANDLE_DECORATION 0x2 + +typedef struct _D3DKMT_GETSHAREDRESOURCEADAPTERLUID +{ + D3DKMT_HANDLE hGlobalShare; // in : Shared resource handle + D3DKMT_PTR(HANDLE, hNtHandle); // in : Process's NT handle + LUID AdapterLuid; // out: adapter LUID +} D3DKMT_GETSHAREDRESOURCEADAPTERLUID; + +typedef enum _D3DKMT_GPU_PREFERENCE_QUERY_STATE +{ + D3DKMT_GPU_PREFERENCE_STATE_UNINITIALIZED, + D3DKMT_GPU_PREFERENCE_STATE_HIGH_PERFORMANCE, + D3DKMT_GPU_PREFERENCE_STATE_MINIMUM_POWER, + D3DKMT_GPU_PREFERENCE_STATE_UNSPECIFIED, + D3DKMT_GPU_PREFERENCE_STATE_NOT_FOUND, + D3DKMT_GPU_PREFERENCE_STATE_USER_SPECIFIED_GPU +} D3DKMT_GPU_PREFERENCE_QUERY_STATE; + +typedef enum _D3DKMT_GPU_PREFERENCE_QUERY_TYPE +{ + D3DKMT_GPU_PREFERENCE_TYPE_IHV_DLIST, + D3DKMT_GPU_PREFERENCE_TYPE_DX_DATABASE, + D3DKMT_GPU_PREFERENCE_TYPE_USER_PREFERENCE +} D3DKMT_GPU_PREFERENCE_QUERY_TYPE; + +typedef struct _D3DKMT_HYBRID_LIST +{ + D3DKMT_GPU_PREFERENCE_QUERY_STATE State; // Gpu preference query state + LUID AdapterLuid; // in,opt: Adapter luid to per-adapter DList state. Optional if QueryType == D3DKMT_GPU_PREFERENCE_TYPE_IHV_DLIST + BOOL bUserPreferenceQuery; // Whether referring to user gpu preference, or per-adapter DList query +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + D3DKMT_GPU_PREFERENCE_QUERY_TYPE QueryType; // Replaced bUserPreferenceQuery, for referring to which D3DKMT_GPU_PREFERENCE_QUERY_TYPE +#endif +} D3DKMT_HYBRID_LIST; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) +typedef struct +{ + DXGK_MIRACAST_CHUNK_INFO ChunkInfo; + UINT PrivateDriverDataSize; // Size of private data + BYTE PrivateDriverData[1]; // Private data buffer +} D3DKMT_MIRACAST_CHUNK_DATA; + +typedef enum +{ + MiracastStopped = 0, + MiracastStartPending = 1, + MiracastStarted = 2, + MiracastStopPending = 3, +} D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE; + +typedef enum +{ + D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS = 0, + D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS_NO_MONITOR = 1, + D3DKMT_MIRACAST_DEVICE_STATUS_PENDING = 2, + D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_ERROR = 0x80000001, + D3DKMT_MIRACAST_DEVICE_STATUS_GPU_RESOURCE_IN_USE = 0x80000002, + D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_ERROR = 0x80000003, + D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_PAIRING = 0x80000004, + D3DKMT_MIRACAST_DEVICE_STATUS_REMOTE_SESSION = 0x80000005, + D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_FOUND = 0x80000006, + D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_STARTED = 0x80000007, + D3DKMT_MIRACAST_DEVICE_STATUS_INVALID_PARAMETER = 0x80000008, + D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_BANDWIDTH = 0x80000009, + D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_MEMORY = 0x8000000A, + D3DKMT_MIRACAST_DEVICE_STATUS_CANCELLED = 0x8000000B, +} D3DKMT_MIRACAST_DEVICE_STATUS; + +typedef struct _D3DKMT_MIRACAST_DISPLAY_DEVICE_STATUS +{ + // + // Miracast display device state. + // + D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE State; +} D3DKMT_MIRACAST_DISPLAY_DEVICE_STATUS, *PD3DKMT_MIRACAST_DISPLAY_DEVICE_STATUS; + +typedef struct _D3DKMT_MIRACAST_DISPLAY_DEVICE_CAPS +{ + BOOLEAN HdcpSupported; + ULONG DefaultControlPort; + BOOLEAN UsesIhvSolution; +} D3DKMT_MIRACAST_DISPLAY_DEVICE_CAPS, *PD3DKMT_MIRACAST_DISPLAY_DEVICE_CAPS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +typedef struct _D3DKMT_MIRACAST_DISPLAY_STOP_SESSIONS +{ + LUID AdapterLuid; + D3DDDI_VIDEO_PRESENT_TARGET_ID TargetId; + UINT StopReason; +} D3DKMT_MIRACAST_DISPLAY_STOP_SESSIONS, *PD3DKMT_MIRACAST_DISPLAY_STOP_SESSIONS; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +typedef struct _D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMCPU +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + UINT ObjectCount; // in: Number of objects to wait on. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Handle to monitored fence synchronization objects to wait on. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const UINT64*, FenceValueArray); // in: Fence values to be waited on. + + D3DKMT_PTR(HANDLE, hAsyncEvent); // in: Event to be signaled when the wait condition is satisfied. + // When set to NULL, the call will not return until the wait condition is satisfied. + + D3DDDI_WAITFORSYNCHRONIZATIONOBJECTFROMCPU_FLAGS Flags; // in: Flags that specify the wait mode. +} D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMCPU; + +typedef struct _D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMCPU +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + UINT ObjectCount; // in: Number of objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Handle to monitored fence synchronization objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const UINT64*, FenceValueArray); // in: Fence values to be signaled. + + D3DDDICB_SIGNALFLAGS Flags; // in: Specifies signal behavior. +} D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMCPU; + +typedef struct _D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMGPU +{ + D3DKMT_HANDLE hContext; // in: Specify the context that should be waiting. + UINT ObjectCount; // in: Number of object to wait on. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Handles to synchronization objects to wait on. + + union + { + _Field_size_(ObjectCount) + const UINT64* MonitoredFenceValueArray; // in: monitored fence values to be waited. + + D3DKMT_ALIGN64 UINT64 FenceValue; // in: fence value to be waited. + + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; +} D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMGPU; + +typedef struct _D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU +{ + D3DKMT_HANDLE hContext; // in: Identifies the context that the signal is being submitted to. + UINT ObjectCount; // in: Specifies the number of objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Specifies the objects to signal. + + union + { + _Field_size_(ObjectCount) + const UINT64* MonitoredFenceValueArray; // in: monitored fence values to be signaled + + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; +} D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU; + +typedef struct _D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU2 +{ + UINT ObjectCount; // in: Specifies the number of objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Specifies the objects to signal. + + D3DDDICB_SIGNALFLAGS Flags; // in: Specifies signal behavior. + + ULONG BroadcastContextCount; // in: Specifies the number of contexts to broadcast this signal to. + + D3DKMT_PTR(_Field_size_(BroadcastContextCount) + const D3DKMT_HANDLE*, BroadcastContextArray); // in: Specifies context handles to broadcast to. + + union + { + D3DKMT_ALIGN64 UINT64 FenceValue; // in: fence value to be signaled; + + HANDLE CpuEventHandle; // in: handle of a CPU event to be signaled if Flags.EnqueueCpuEvent flag is set. + + _Field_size_(ObjectCount) + const UINT64* MonitoredFenceValueArray; // in: monitored fence values to be signaled + + D3DKMT_ALIGN64 UINT64 Reserved[8]; + }; +} D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU2; + +typedef struct _D3DKMT_CREATEPAGINGQUEUE +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DDDI_PAGINGQUEUE_PRIORITY Priority; // in: scheduling priority relative to other paging queues on this device + D3DKMT_HANDLE hPagingQueue; // out: handle to the paging queue used to synchronize paging operations for this device. + D3DKMT_HANDLE hSyncObject; // out: handle to the monitored fence object used to synchronize paging operations for this paging queue. + D3DKMT_PTR(VOID*, FenceValueCPUVirtualAddress); // out: Read-only mapping of the fence value for the CPU + UINT PhysicalAdapterIndex; // in: Physical adapter index (engine ordinal) +} D3DKMT_CREATEPAGINGQUEUE; + +typedef struct _D3DKMT_EVICT +{ + D3DKMT_HANDLE hDevice; // in: Device that created the allocations + UINT NumAllocations; // in: number of allocation handles + D3DKMT_PTR(CONST D3DKMT_HANDLE*, AllocationList); // in: an array of NumAllocations allocation handles + D3DDDI_EVICT_FLAGS Flags; // in: eviction flags + D3DKMT_ALIGN64 UINT64 NumBytesToTrim; // out: This value indicates how much to trim in order to satisfy the new budget. +} D3DKMT_EVICT; + +typedef struct _D3DKMT_LOCK2 +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DKMT_HANDLE hAllocation; // in: allocation to lock + D3DDDICB_LOCK2FLAGS Flags; // in: Bit field defined by D3DDDI_LOCK2FLAGS + D3DKMT_PTR(PVOID, pData); // out: Virtual address of the locked allocation +} D3DKMT_LOCK2; + +typedef struct _D3DKMT_UNLOCK2 +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device. + D3DKMT_HANDLE hAllocation; // in: allocation to unlock +} D3DKMT_UNLOCK2; + +typedef struct _D3DKMT_INVALIDATECACHE +{ + D3DKMT_HANDLE hDevice; + D3DKMT_HANDLE hAllocation; + D3DKMT_ALIGN64 D3DKMT_SIZE_T Offset; + D3DKMT_ALIGN64 D3DKMT_SIZE_T Length; +} D3DKMT_INVALIDATECACHE; + +typedef struct _D3DKMT_FREEGPUVIRTUALADDRESS +{ + D3DKMT_HANDLE hAdapter; // in: Handle to an adapter. + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; // in: Start of a virtual address range in bytes + D3DKMT_ALIGN64 D3DGPU_SIZE_T Size; // in: Size of the virtual address range in bytes +} D3DKMT_FREEGPUVIRTUALADDRESS; + +typedef struct _D3DKMT_UPDATEGPUVIRTUALADDRESS +{ + D3DKMT_HANDLE hDevice; + D3DKMT_HANDLE hContext; + D3DKMT_HANDLE hFenceObject; + UINT NumOperations; + D3DKMT_PTR(D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION*, Operations); + D3DKMT_ALIGN64 D3DKMT_SIZE_T Reserved0; + D3DKMT_ALIGN64 UINT64 Reserved1; + D3DKMT_ALIGN64 UINT64 FenceValue; + union + { + struct + { + UINT DoNotWait : 1; + UINT Reserved : 31; + }; + UINT Value; + } Flags; +} D3DKMT_UPDATEGPUVIRTUALADDRESS; + +typedef struct _D3DKMT_CREATECONTEXTVIRTUAL +{ + D3DKMT_HANDLE hDevice; // in: + UINT NodeOrdinal; // in: + UINT EngineAffinity; // in: + D3DDDI_CREATECONTEXTFLAGS Flags; // in: + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: + UINT PrivateDriverDataSize; // in: + D3DKMT_CLIENTHINT ClientHint; // in: Hints which client is creating the context + D3DKMT_HANDLE hContext; // out: +} D3DKMT_CREATECONTEXTVIRTUAL; + +typedef struct _D3DKMT_SUBMITCOMMANDFLAGS +{ + UINT NullRendering : 1; // 0x00000001 + UINT PresentRedirected : 1; // 0x00000002 + UINT NoKmdAccess : 1; // 0x00000004 + UINT Reserved : 29; // 0xFFFFFFF8 +} D3DKMT_SUBMITCOMMANDFLAGS; + +typedef struct _D3DKMT_SUBMITCOMMAND +{ + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS Commands; + UINT CommandLength; + D3DKMT_SUBMITCOMMANDFLAGS Flags; + D3DKMT_ALIGN64 ULONGLONG PresentHistoryToken; // in: Present history token for redirected present calls + UINT BroadcastContextCount; + D3DKMT_HANDLE BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]; + D3DKMT_PTR(VOID*, pPrivateDriverData); + UINT PrivateDriverDataSize; + UINT NumPrimaries; + D3DKMT_HANDLE WrittenPrimaries[D3DDDI_MAX_WRITTEN_PRIMARIES]; + UINT NumHistoryBuffers; + D3DKMT_PTR(D3DKMT_HANDLE*, HistoryBufferArray); +} D3DKMT_SUBMITCOMMAND; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _D3DKMT_SUBMITCOMMANDTOHWQUEUE +{ + D3DKMT_HANDLE hHwQueue; // in: Context queue to submit the command to. + + D3DKMT_ALIGN64 UINT64 HwQueueProgressFenceId; // in: Hardware queue progress fence value that will be signaled once the command is finished. + + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS CommandBuffer;// in: GPU VA of the command buffer to be executed on the GPU. + UINT CommandLength; // in: Length in bytes of the command buffer. + + UINT PrivateDriverDataSize; // in: Size of private driver data in bytes. + + D3DKMT_PTR(_Field_size_bytes_(PrivateDriverDataSize) + VOID*, pPrivateDriverData); // in: Pointer to the private driver data. + + UINT NumPrimaries; // in: The number of primaries written by this command buffer. + + D3DKMT_PTR(_Field_size_ (NumPrimaries) + D3DKMT_HANDLE CONST*, WrittenPrimaries); // in: The array of primaries written by this command buffer. +} D3DKMT_SUBMITCOMMANDTOHWQUEUE; + +typedef struct _D3DKMT_SUBMITWAITFORSYNCOBJECTSTOHWQUEUE +{ + D3DKMT_HANDLE hHwQueue; // in: Context queue to submit the command to. + + UINT ObjectCount; // in: Number of objects to wait on. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Handles to monitored fence synchronization objects to wait on. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const UINT64*, FenceValueArray); // in: monitored fence values to be waited. +} D3DKMT_SUBMITWAITFORSYNCOBJECTSTOHWQUEUE; + +typedef struct _D3DKMT_SUBMITSIGNALSYNCOBJECTSTOHWQUEUE +{ + D3DDDICB_SIGNALFLAGS Flags; // in: Specifies signal behavior. + + ULONG BroadcastHwQueueCount; // in: Specifies the number of hardware queues to broadcast this signal to. + + D3DKMT_PTR(_Field_size_(BroadcastHwQueueCount) + const D3DKMT_HANDLE*, BroadcastHwQueueArray); // in: Specifies hardware queue handles to broadcast to. + + UINT ObjectCount; // in: Number of objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const D3DKMT_HANDLE*, ObjectHandleArray); // in: Handles to monitored fence synchronization objects to signal. + + D3DKMT_PTR(_Field_size_(ObjectCount) + const UINT64*, FenceValueArray); // in: monitored fence values to signal. +} D3DKMT_SUBMITSIGNALSYNCOBJECTSTOHWQUEUE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _D3DKMT_QUERYVIDEOMEMORYINFO +{ + D3DKMT_PTR(HANDLE, hProcess); // in,opt: A handle to a process. If NULL, the current process is used. + // The process handle must be opened with PROCESS_QUERY_INFORMATION privileges + D3DKMT_HANDLE hAdapter; // in : The adapter to query for this process + D3DKMT_MEMORY_SEGMENT_GROUP MemorySegmentGroup; // in : The memory segment group to query. + D3DKMT_ALIGN64 UINT64 Budget; // out: Total memory the application may use + D3DKMT_ALIGN64 UINT64 CurrentUsage; // out: Current memory usage of the device + D3DKMT_ALIGN64 UINT64 CurrentReservation; // out: Current reservation of the device + D3DKMT_ALIGN64 UINT64 AvailableForReservation; // out: Total that the device may reserve + UINT PhysicalAdapterIndex; // in : Zero based physical adapter index in the LDA configuration. +} D3DKMT_QUERYVIDEOMEMORYINFO; + +typedef struct _D3DKMT_CHANGEVIDEOMMEMORYRESERVATION +{ + D3DKMT_PTR(HANDLE, hProcess); // in,opt: A handle to a process. If NULL, the current process is used. + // The process handle must be opened with PROCESS_SET_INFORMATION privileges + D3DKMT_HANDLE hAdapter; // in : The adapter to change reservation for. + D3DKMT_MEMORY_SEGMENT_GROUP MemorySegmentGroup; // in : The memory segment group to change reservation for. + D3DKMT_ALIGN64 UINT64 Reservation; // in : Desired reservation in the range between 0 and AvailableForReservation returned by QueryVideoMemoryInfo. + UINT PhysicalAdapterIndex; // in : Zero based physical adapter index in the LDA configuration. +} D3DKMT_CHANGEVIDEOMEMORYRESERVATION; + +typedef struct _D3DKMT_SETSTABLEPOWERSTATE +{ + D3DKMT_HANDLE hAdapter; // in: The adapter to enable or disable stable power for + BOOL Enabled; // in: Whether or not stable power is being requested on or off. +} D3DKMT_SETSTABLEPOWERSTATE; + + +typedef struct _D3DKMT_SHAREOBJECTWITHHOST +{ + D3DKMT_HANDLE hDevice; // in + D3DKMT_HANDLE hObject; // in + D3DKMT_ALIGN64 UINT64 Reserved; // in Must be zero. Reserved for future use + D3DKMT_ALIGN64 UINT64 hVailProcessNtHandle; // out +} D3DKMT_SHAREOBJECTWITHHOST; + +// +// This API is used to support sync_file in Android. +// A sync_file is a wrapper around the given monitored fence and the fence value. +// When a sync_file is created, a wait for sync object on CPU is issued +// and a file descriptor (FD) it returned to the app. The app can wait on the FD, +// which will be unblocked when the sync object with this fence value is signaled. +// +typedef struct _D3DKMT_CREATESYNCFILE +{ + D3DKMT_HANDLE hDevice; // in: Device owner of the monitored fence. + D3DKMT_HANDLE hMonitoredFence; // in: Monitored fence object + D3DKMT_ALIGN64 UINT64 FenceValue; // in: Fence value to wait for + D3DKMT_ALIGN64 UINT64 hSyncFile; // out: File descriptor on Android or a NT handle on Windows (when implemented) +} D3DKMT_CREATESYNCFILE; + +typedef struct _D3DKMT_WAITSYNCFILE +{ + D3DKMT_ALIGN64 UINT64 hSyncFile; // in: Sync file descriptor on Android or a NT handle on Windows (when implemented) + D3DKMT_HANDLE hContext; // in: Context where the wait needs to be inserted + UINT Reserved; // in: Reserved for future use +} D3DKMT_WAITSYNCFILE; + +typedef struct _D3DKMT_OPENSYNCOBJECTFROMSYNCFILE +{ + D3DKMT_ALIGN64 UINT64 hSyncFile; // in: Sync file descriptor on Android or a NT handle on Windows (when implemented) + D3DKMT_HANDLE hDevice; // in: Device fot the sync object + D3DKMT_HANDLE hSyncObject; // out: Monitored sync object handle + D3DKMT_ALIGN64 UINT64 FenceValue; // out: Fence value, associated with the sync file + D3DKMT_PTR(VOID*, FenceValueCPUVirtualAddress); // out: Read-only mapping of the fence value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS FenceValueGPUVirtualAddress; // out: Read/write mapping of the fence value for the GPU +} D3DKMT_OPENSYNCOBJECTFROMSYNCFILE; + + +typedef struct _D3DKMT_TRIMNOTIFICATION +{ + D3DKMT_PTR(VOID*, Context); // In: context at Register + D3DDDI_TRIMRESIDENCYSET_FLAGS Flags; // In: trim flags + D3DKMT_ALIGN64 UINT64 NumBytesToTrim; // In: When TrimToBudget flag is set, this value indicates how much VidMm + // requests the app to trim to fit in the new budget. +} D3DKMT_TRIMNOTIFICATION; + +typedef VOID (APIENTRY *PFND3DKMT_TRIMNOTIFICATIONCALLBACK)(_Inout_ D3DKMT_TRIMNOTIFICATION*); + +typedef struct _D3DKMT_REGISTERTRIMNOTIFICATION +{ + LUID AdapterLuid; + D3DKMT_HANDLE hDevice; + PFND3DKMT_TRIMNOTIFICATIONCALLBACK Callback; + D3DKMT_PTR(VOID*, Context); // In: callback context + D3DKMT_PTR(VOID*, Handle); // Out: for Unregister +} D3DKMT_REGISTERTRIMNOTIFICATION; + +typedef struct _D3DKMT_UNREGISTERTRIMNOTIFICATION +{ + D3DKMT_PTR(VOID*, Handle); // In: Handle returned from RegisterTrimNotification, + // or NULL to unregister all Callback instances. + D3DKMT_PTR(PFND3DKMT_TRIMNOTIFICATIONCALLBACK, Callback); // In: When Handle is NULL, this parameter specifies that all registered instances of Callback + // should be unregistered. This unregistration method should only be used + // in DLL unload scenarios when the DLL being unloaded cannot guarantee that + // all trim callbacks are unregistered through their handles. +} D3DKMT_UNREGISTERTRIMNOTIFICATION; + +typedef struct _D3DKMT_BUDGETCHANGENOTIFICATION +{ + D3DKMT_PTR(VOID*, Context); // In: context at Register + D3DKMT_ALIGN64 UINT64 Budget; // In: new budget +} D3DKMT_BUDGETCHANGENOTIFICATION; + +typedef VOID (APIENTRY *PFND3DKMT_BUDGETCHANGENOTIFICATIONCALLBACK)(_In_ D3DKMT_BUDGETCHANGENOTIFICATION*); + +typedef struct _D3DKMT_REGISTERBUDGETCHANGENOTIFICATION +{ + D3DKMT_HANDLE hDevice; + D3DKMT_PTR(PFND3DKMT_BUDGETCHANGENOTIFICATIONCALLBACK, Callback); + D3DKMT_PTR(VOID*, Context); // In: callback context + D3DKMT_PTR(VOID*, Handle); // Out: for Unregister +} D3DKMT_REGISTERBUDGETCHANGENOTIFICATION; + +typedef struct _D3DKMT_UNREGISTERBUDGETCHANGENOTIFICATION +{ + D3DKMT_PTR(VOID*, Handle); // In: from register +} D3DKMT_UNREGISTERBUDGETCHANGENOTIFICATION; + +typedef struct _D3DKMT_QUERYVIDPNEXCLUSIVEOWNERSHIP +{ + D3DKMT_PTR(HANDLE, hProcess); // In: Process handle + D3DKMT_PTR(HWND, hWindow); // In: Window handle + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // Out: VidPn source ID + LUID AdapterLuid; // Out: Adapter LUID + D3DKMT_VIDPNSOURCEOWNER_TYPE OwnerType; // Out: Owner Type +} D3DKMT_QUERYVIDPNEXCLUSIVEOWNERSHIP; + + +typedef enum _D3DKMT_DEVICE_ERROR_REASON { + D3DKMT_DEVICE_ERROR_REASON_GENERIC = 0x80000000, + D3DKMT_DEVICE_ERROR_REASON_DRIVER_ERROR = 0x80000006, +} D3DKMT_DEVICE_ERROR_REASON; + +typedef struct _D3DKMT_MARKDEVICEASERROR +{ + D3DKMT_HANDLE hDevice; // in: Device handle + D3DKMT_DEVICE_ERROR_REASON Reason; // in: Status code +} D3DKMT_MARKDEVICEASERROR; + +typedef struct _D3DKMT_FLUSHHEAPTRANSITIONS +{ + D3DKMT_HANDLE hAdapter; +} D3DKMT_FLUSHHEAPTRANSITIONS; + +typedef struct _D3DKMT_QUERYPROCESSOFFERINFO +{ + _In_ ULONG cbSize; + D3DKMT_PTR(_In_ HANDLE, hProcess); + _Out_ D3DKMT_ALIGN64 UINT64 DecommitUniqueness; + _Out_ D3DKMT_ALIGN64 UINT64 DecommittableBytes; +} D3DKMT_QUERYPROCESSOFFERINFO; + +typedef union _D3DKMT_TRIMPROCESSCOMMITMENT_FLAGS +{ + struct + { + UINT Lazy : 1; + UINT OnlyRepurposed : 1; + UINT Reserved : 30; + }; + UINT Value; +} D3DKMT_TRIMPROCESSCOMMITMENT_FLAGS; + +typedef struct _D3DKMT_TRIMPROCESSCOMMITMENT +{ + _In_ ULONG cbSize; + D3DKMT_PTR(_In_ HANDLE, hProcess); + _In_ D3DKMT_TRIMPROCESSCOMMITMENT_FLAGS Flags; + _In_ D3DKMT_ALIGN64 UINT64 DecommitRequested; + _Out_ D3DKMT_ALIGN64 UINT64 NumBytesDecommitted; +} D3DKMT_TRIMPROCESSCOMMITMENT; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _D3DKMT_CREATEHWCONTEXT +{ + D3DKMT_HANDLE hDevice; // in: Handle to the device owning this context. + UINT NodeOrdinal; // in: Identifier for the node targetted by this context. + UINT EngineAffinity; // in: Engine affinity within the specified node. + D3DDDI_CREATEHWCONTEXTFLAGS Flags; // in: Context creation flags. + UINT PrivateDriverDataSize; // in: Size of private driver data + D3DKMT_PTR(_Inout_ + _Field_size_bytes_ (PrivateDriverDataSize) + VOID*, pPrivateDriverData); // in/out: Private driver data + D3DKMT_HANDLE hHwContext; // out: Handle of the created context. +} D3DKMT_CREATEHWCONTEXT; + +typedef struct _D3DKMT_DESTROYHWCONTEXT +{ + D3DKMT_HANDLE hHwContext; // in: Identifies the context being destroyed. +} D3DKMT_DESTROYHWCONTEXT; + +typedef struct _D3DKMT_CREATEHWQUEUE +{ + D3DKMT_HANDLE hHwContext; // in: Handle to the hardware context the queue is associated with. + D3DDDI_CREATEHWQUEUEFLAGS Flags; // in: Hardware queue creation flags. + UINT PrivateDriverDataSize; // in: Size of private driver data + D3DKMT_PTR(_Inout_ + _Field_size_bytes_ (PrivateDriverDataSize) + VOID*, pPrivateDriverData); // in/out: Private driver data + D3DKMT_HANDLE hHwQueue; // out: handle to the hardware queue object to submit work to. + D3DKMT_HANDLE hHwQueueProgressFence; // out: handle to the monitored fence object used to monitor the queue progress. + D3DKMT_PTR(VOID*, HwQueueProgressFenceCPUVirtualAddress); // out: Read-only mapping of the queue progress fence value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS HwQueueProgressFenceGPUVirtualAddress; // out: Read/write mapping of the queue progress fence value for the GPU +} D3DKMT_CREATEHWQUEUE; + +typedef struct _D3DKMT_DESTROYHWQUEUE +{ + D3DKMT_HANDLE hHwQueue; // in: handle to the hardware queue to be destroyed. +} D3DKMT_DESTROYHWQUEUE; + +typedef struct _D3DKMT_GETALLOCATIONPRIORITY +{ + D3DKMT_HANDLE hDevice; // in: Indentifies the device + D3DKMT_HANDLE hResource; // in: Specify the resource to get priority of. + D3DKMT_PTR(CONST D3DKMT_HANDLE*, phAllocationList); // in: pointer to an array allocation to get priorities of. + UINT AllocationCount; // in: Number of allocations in phAllocationList + D3DKMT_PTR(UINT*, pPriorities); // out: Priority for each of the allocation in the array. +} D3DKMT_GETALLOCATIONPRIORITY; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + + + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef union _D3DKMT_SETFSEBLOCKFLAGS +{ + struct + { + UINT Block : 1; + UINT Reserved : 31; + }; + UINT Value; +} D3DKMT_SETFSEBLOCKFLAGS; + +typedef struct _D3DKMT_SETFSEBLOCK +{ + LUID AdapterLuid; + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_SETFSEBLOCKFLAGS Flags; +} D3DKMT_SETFSEBLOCK; + +typedef union _D3DKMT_QUERYFSEFLAGS +{ + struct + { + UINT Blocked : 1; + UINT Reserved : 31; + }; + UINT Value; +} D3DKMT_QUERYFSEBLOCKFLAGS; + +typedef struct _D3DKMT_QUERYFSEBLOCK +{ + LUID AdapterLuid; + D3DKMT_HANDLE hAdapter; + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; + D3DKMT_QUERYFSEBLOCKFLAGS Flags; +} D3DKMT_QUERYFSEBLOCK; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + +typedef struct _D3DKMT_CREATEPROTECTEDSESSION +{ + D3DKMT_HANDLE hDevice; // in: device handle + D3DKMT_HANDLE hSyncObject; // in: monitored fence handle associated to this session (kernel handle) + D3DKMT_PTR(_Field_size_bytes_(PrivateDriverDataSize) + CONST VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in: Size of private runtime data + D3DKMT_PTR(_Field_size_bytes_(PrivateRuntimeDataSize) + CONST VOID*, pPrivateRuntimeData); // in: Private runtime data + UINT PrivateRuntimeDataSize; // in: Size of private runtime data + + D3DKMT_HANDLE hHandle; // out: protected session handle (kernel handle) + +} D3DKMT_CREATEPROTECTEDSESSION; + +typedef struct _D3DKMT_DESTROYPROTECTEDSESSION +{ + D3DKMT_HANDLE hHandle; // in: protected session handle (kernel handle) + +} D3DKMT_DESTROYPROTECTEDSESSION; + +typedef enum _D3DKMT_PROTECTED_SESSION_STATUS +{ + D3DKMT_PROTECTED_SESSION_STATUS_OK = 0, + D3DKMT_PROTECTED_SESSION_STATUS_INVALID = 1, +} D3DKMT_PROTECTED_SESSION_STATUS; + +typedef struct _D3DKMT_QUERYPROTECTEDSESSIONSTATUS +{ + D3DKMT_HANDLE hHandle; // in: protected session handle (kernel handle) + D3DKMT_PROTECTED_SESSION_STATUS Status; // out: protected session status + +} D3DKMT_QUERYPROTECTEDSESSIONSTATUS; + +typedef struct _D3DKMT_QUERYPROTECTEDSESSIONINFOFROMNTHANDLE +{ + D3DKMT_PTR(HANDLE, hNtHandle); // in: protected session handle (NT handle) + D3DKMT_PTR(_Field_size_bytes_(PrivateDriverDataSize) + CONST VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in/out: Size of private runtime data + D3DKMT_PTR(_Field_size_bytes_(PrivateRuntimeDataSize) + CONST VOID*, pPrivateRuntimeData); // in: Private runtime data + UINT PrivateRuntimeDataSize; // in/out: Size of private runtime data + +} D3DKMT_QUERYPROTECTEDSESSIONINFOFROMNTHANDLE; + +typedef struct _D3DKMT_OPENPROTECTEDSESSIONFROMNTHANDLE +{ + D3DKMT_PTR(HANDLE, hNtHandle);// in: protected session handle (NT handle) + D3DKMT_HANDLE hHandle; // out: protected session handle (kernel handle) + +} D3DKMT_OPENPROTECTEDSESSIONFROMNTHANDLE; + + +typedef struct _D3DKMT_GETPROCESSDEVICEREMOVALSUPPORT +{ + D3DKMT_PTR(HANDLE, hProcess); // in: Process handle + LUID AdapterLuid; // in: Luid of Adapter that is potentially being detached + BOOLEAN Support; // out: Whether or not the process using the adapter can recover from graphics device removal + +} D3DKMT_GETPROCESSDEVICEREMOVALSUPPORT; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_7 + + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEALLOCATION)(_Inout_ D3DKMT_CREATEALLOCATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEALLOCATION2)(_Inout_ D3DKMT_CREATEALLOCATION*); // _ADVSCH_ +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYRESOURCEINFO)(_Inout_ D3DKMT_QUERYRESOURCEINFO*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYRESOURCEINFOFROMNTHANDLE)(_Inout_ D3DKMT_QUERYRESOURCEINFOFROMNTHANDLE*); + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SHAREOBJECTS)( + _In_range_(1, D3DKMT_MAX_OBJECTS_PER_HANDLE) UINT cObjects, + _In_reads_(cObjects) CONST D3DKMT_HANDLE * hObjects, + _In_ POBJECT_ATTRIBUTES pObjectAttributes, + _In_ DWORD dwDesiredAccess, + _Out_ HANDLE * phSharedNtHandle + ); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENNTHANDLEFROMNAME)(_Inout_ D3DKMT_OPENNTHANDLEFROMNAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENRESOURCEFROMNTHANDLE)(_Inout_ D3DKMT_OPENRESOURCEFROMNTHANDLE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENSYNCOBJECTFROMNTHANDLE)(_Inout_ D3DKMT_OPENSYNCOBJECTFROMNTHANDLE*); +#endif +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENRESOURCE)(_Inout_ D3DKMT_OPENRESOURCE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENRESOURCE2)(_Inout_ D3DKMT_OPENRESOURCE*); // _ADVSCH_ +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYALLOCATION)(_In_ CONST D3DKMT_DESTROYALLOCATION*); + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYALLOCATION2)(_In_ CONST D3DKMT_DESTROYALLOCATION2*); +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETALLOCATIONPRIORITY)(_In_ CONST D3DKMT_SETALLOCATIONPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYALLOCATIONRESIDENCY)(_In_ CONST D3DKMT_QUERYALLOCATIONRESIDENCY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEDEVICE)(_Inout_ D3DKMT_CREATEDEVICE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYDEVICE)(_In_ CONST D3DKMT_DESTROYDEVICE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATECONTEXT)(_Inout_ D3DKMT_CREATECONTEXT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYCONTEXT)(_In_ CONST D3DKMT_DESTROYCONTEXT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATESYNCHRONIZATIONOBJECT)(_Inout_ D3DKMT_CREATESYNCHRONIZATIONOBJECT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATESYNCHRONIZATIONOBJECT2)(_Inout_ D3DKMT_CREATESYNCHRONIZATIONOBJECT2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENSYNCHRONIZATIONOBJECT)(_Inout_ D3DKMT_OPENSYNCHRONIZATIONOBJECT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYSYNCHRONIZATIONOBJECT)(_In_ CONST D3DKMT_DESTROYSYNCHRONIZATIONOBJECT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORSYNCHRONIZATIONOBJECT)(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORSYNCHRONIZATIONOBJECT2)(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECT2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SIGNALSYNCHRONIZATIONOBJECT)(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SIGNALSYNCHRONIZATIONOBJECT2)(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECT2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_LOCK)(_Inout_ D3DKMT_LOCK*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UNLOCK)(_In_ CONST D3DKMT_UNLOCK*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETDISPLAYMODELIST)(_Inout_ D3DKMT_GETDISPLAYMODELIST*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETDISPLAYMODE)(_Inout_ CONST D3DKMT_SETDISPLAYMODE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETMULTISAMPLEMETHODLIST)(_Inout_ D3DKMT_GETMULTISAMPLEMETHODLIST*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_PRESENT)(_Inout_ D3DKMT_PRESENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RENDER)(_Inout_ D3DKMT_RENDER*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETRUNTIMEDATA)(_Inout_ CONST D3DKMT_GETRUNTIMEDATA*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYADAPTERINFO)(_Inout_ CONST D3DKMT_QUERYADAPTERINFO*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENADAPTERFROMHDC)(_Inout_ D3DKMT_OPENADAPTERFROMHDC*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENADAPTERFROMGDIDISPLAYNAME)(_Inout_ D3DKMT_OPENADAPTERFROMGDIDISPLAYNAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENADAPTERFROMDEVICENAME)(_Inout_ D3DKMT_OPENADAPTERFROMDEVICENAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CLOSEADAPTER)(_In_ CONST D3DKMT_CLOSEADAPTER*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETSHAREDPRIMARYHANDLE)(_Inout_ D3DKMT_GETSHAREDPRIMARYHANDLE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ESCAPE)(_In_ CONST D3DKMT_ESCAPE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYSTATISTICS)(_In_ CONST D3DKMT_QUERYSTATISTICS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETVIDPNSOURCEOWNER)(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETPRESENTHISTORY)(_Inout_ D3DKMT_GETPRESENTHISTORY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEOVERLAY)(_Inout_ D3DKMT_CREATEOVERLAY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UPDATEOVERLAY)(_In_ CONST D3DKMT_UPDATEOVERLAY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_FLIPOVERLAY)(_In_ CONST D3DKMT_FLIPOVERLAY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYOVERLAY)(_In_ CONST D3DKMT_DESTROYOVERLAY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORVERTICALBLANKEVENT)(_In_ CONST D3DKMT_WAITFORVERTICALBLANKEVENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETGAMMARAMP)(_In_ CONST D3DKMT_SETGAMMARAMP*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETDEVICESTATE)(_Inout_ D3DKMT_GETDEVICESTATE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEDCFROMMEMORY)(_Inout_ D3DKMT_CREATEDCFROMMEMORY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYDCFROMMEMORY)(_In_ CONST D3DKMT_DESTROYDCFROMMEMORY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETCONTEXTSCHEDULINGPRIORITY)(_In_ CONST D3DKMT_SETCONTEXTSCHEDULINGPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETCONTEXTSCHEDULINGPRIORITY)(_Inout_ D3DKMT_GETCONTEXTSCHEDULINGPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETPROCESSSCHEDULINGPRIORITYCLASS)(_In_ HANDLE, _In_ D3DKMT_SCHEDULINGPRIORITYCLASS); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETPROCESSSCHEDULINGPRIORITYCLASS)(_In_ HANDLE, _Out_ D3DKMT_SCHEDULINGPRIORITYCLASS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RELEASEPROCESSVIDPNSOURCEOWNERS)(_In_ HANDLE); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETSCANLINE)(_Inout_ D3DKMT_GETSCANLINE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHANGESURFACEPOINTER)(_In_ CONST D3DKMT_CHANGESURFACEPOINTER*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETQUEUEDLIMIT)(_In_ CONST D3DKMT_SETQUEUEDLIMIT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_POLLDISPLAYCHILDREN)(_In_ CONST D3DKMT_POLLDISPLAYCHILDREN*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_INVALIDATEACTIVEVIDPN)(_In_ CONST D3DKMT_INVALIDATEACTIVEVIDPN*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKOCCLUSION)(_In_ CONST D3DKMT_CHECKOCCLUSION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORIDLE)(_In_ CONST D3DKMT_WAITFORIDLE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKMONITORPOWERSTATE)(_In_ CONST D3DKMT_CHECKMONITORPOWERSTATE*); +typedef _Check_return_ BOOLEAN (APIENTRY *PFND3DKMT_CHECKEXCLUSIVEOWNERSHIP)(); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKVIDPNEXCLUSIVEOWNERSHIP)(_In_ CONST D3DKMT_CHECKVIDPNEXCLUSIVEOWNERSHIP*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETDISPLAYPRIVATEDRIVERFORMAT)(_In_ CONST D3DKMT_SETDISPLAYPRIVATEDRIVERFORMAT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SHAREDPRIMARYLOCKNOTIFICATION)(_In_ CONST D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SHAREDPRIMARYUNLOCKNOTIFICATION)(_In_ CONST D3DKMT_SHAREDPRIMARYUNLOCKNOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEKEYEDMUTEX)(_Inout_ D3DKMT_CREATEKEYEDMUTEX*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENKEYEDMUTEX)(_Inout_ D3DKMT_OPENKEYEDMUTEX*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYKEYEDMUTEX)(_In_ CONST D3DKMT_DESTROYKEYEDMUTEX*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ACQUIREKEYEDMUTEX)(_Inout_ D3DKMT_ACQUIREKEYEDMUTEX*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RELEASEKEYEDMUTEX)(_Inout_ D3DKMT_RELEASEKEYEDMUTEX*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEKEYEDMUTEX2)(_Inout_ D3DKMT_CREATEKEYEDMUTEX2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENKEYEDMUTEX2)(_Inout_ D3DKMT_OPENKEYEDMUTEX2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ACQUIREKEYEDMUTEX2)(_Inout_ D3DKMT_ACQUIREKEYEDMUTEX2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RELEASEKEYEDMUTEX2)(_Inout_ D3DKMT_RELEASEKEYEDMUTEX2*); +#endif +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CONFIGURESHAREDRESOURCE)(_In_ CONST D3DKMT_CONFIGURESHAREDRESOURCE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETOVERLAYSTATE)(_Inout_ D3DKMT_GETOVERLAYSTATE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKSHAREDRESOURCEACCESS)(_In_ CONST D3DKMT_CHECKSHAREDRESOURCEACCESS*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OFFERALLOCATIONS)(_In_ CONST D3DKMT_OFFERALLOCATIONS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RECLAIMALLOCATIONS)(_Inout_ CONST D3DKMT_RECLAIMALLOCATIONS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEOUTPUTDUPL)(_In_ CONST D3DKMT_CREATE_OUTPUTDUPL*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYOUTPUTDUPL)(_In_ CONST D3DKMT_DESTROY_OUTPUTDUPL*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLGETFRAMEINFO)(_Inout_ D3DKMT_OUTPUTDUPL_GET_FRAMEINFO*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLGETMETADATA)(_Inout_ D3DKMT_OUTPUTDUPL_METADATA*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLGETPOINTERSHAPEDATA)(_Inout_ D3DKMT_OUTPUTDUPL_GET_POINTER_SHAPE_DATA*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLRELEASEFRAME)(_In_ D3DKMT_OUTPUTDUPL_RELEASE_FRAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLPRESENT)(_In_ CONST D3DKMT_OUTPUTDUPLPRESENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ENUMADAPTERS)(_Inout_ CONST D3DKMT_ENUMADAPTERS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ENUMADAPTERS2)(_Inout_ CONST D3DKMT_ENUMADAPTERS2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENADAPTERFROMLUID)(_Inout_ D3DKMT_OPENADAPTERFROMLUID*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYREMOTEVIDPNSOURCEFROMGDIDISPLAYNAME)(_Inout_ D3DKMT_QUERYREMOTEVIDPNSOURCEFROMGDIDISPLAYNAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETVIDPNSOURCEOWNER1)(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER1*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_PINDIRECTFLIPRESOURCES)(_In_ CONST D3DKMT_PINDIRECTFLIPRESOURCES*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UNPINDIRECTFLIPRESOURCES)(_In_ CONST D3DKMT_UNPINDIRECTFLIPRESOURCES*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORVERTICALBLANKEVENT2)(_In_ CONST D3DKMT_WAITFORVERTICALBLANKEVENT2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETDWMVERTICALBLANKEVENT)(_In_ CONST D3DKMT_GETVERTICALBLANKEVENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETSYNCREFRESHCOUNTWAITTARGET)(_In_ CONST D3DKMT_SETSYNCREFRESHCOUNTWAITTARGET*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETCONTEXTINPROCESSSCHEDULINGPRIORITY)(_In_ CONST D3DKMT_SETCONTEXTINPROCESSSCHEDULINGPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETCONTEXTINPROCESSSCHEDULINGPRIORITY)(_Inout_ D3DKMT_GETCONTEXTINPROCESSSCHEDULINGPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_PRESENTMULTIPLANEOVERLAY)(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETSHAREDRESOURCEADAPTERLUID)(_Inout_ D3DKMT_GETSHAREDRESOURCEADAPTERLUID*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETSTEREOENABLED)(_In_ BOOL); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYHYBRIDLISTVALUE)(_Inout_ D3DKMT_HYBRID_LIST*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETHYBRIDLISTVVALUE)(_Inout_ D3DKMT_HYBRID_LIST*); +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT)(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_MAKERESIDENT)(_Inout_ D3DDDI_MAKERESIDENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_EVICT)(_Inout_ D3DKMT_EVICT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMCPU)(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMCPU*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMCPU)(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMCPU*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMGPU)(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMGPU*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU)(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU2)(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEPAGINGQUEUE)(_Inout_ D3DKMT_CREATEPAGINGQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYPAGINGQUEUE)(_Inout_ D3DDDI_DESTROYPAGINGQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_LOCK2)(_Inout_ D3DKMT_LOCK2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UNLOCK2)(_In_ CONST D3DKMT_UNLOCK2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_INVALIDATECACHE)(_In_ const D3DKMT_INVALIDATECACHE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RESERVEGPUVIRTUALADDRESS)(_Inout_ D3DDDI_RESERVEGPUVIRTUALADDRESS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_MAPGPUVIRTUALADDRESS)(_Inout_ D3DDDI_MAPGPUVIRTUALADDRESS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_FREEGPUVIRTUALADDRESS)(_In_ CONST D3DKMT_FREEGPUVIRTUALADDRESS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UPDATEGPUVIRTUALADDRESS)(_In_ CONST D3DKMT_UPDATEGPUVIRTUALADDRESS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETRESOURCEPRESENTPRIVATEDRIVERDATA)(_Inout_ D3DDDI_GETRESOURCEPRESENTPRIVATEDRIVERDATA*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATECONTEXTVIRTUAL)(_Inout_ D3DKMT_CREATECONTEXTVIRTUAL*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITCOMMAND)(_In_ CONST D3DKMT_SUBMITCOMMAND*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENSYNCOBJECTFROMNTHANDLE2)(_Inout_ D3DKMT_OPENSYNCOBJECTFROMNTHANDLE2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENSYNCOBJECTNTHANDLEFROMNAME)(_Inout_ D3DKMT_OPENSYNCOBJECTNTHANDLEFROMNAME*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYVIDEOMEMORYINFO)(_Inout_ D3DKMT_QUERYVIDEOMEMORYINFO*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHANGEVIDEOMEMORYRESERVATION)(_In_ CONST D3DKMT_CHANGEVIDEOMEMORYRESERVATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_REGISTERTRIMNOTIFICATION)(_Inout_ D3DKMT_REGISTERTRIMNOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UNREGISTERTRIMNOTIFICATION)(_Inout_ D3DKMT_UNREGISTERTRIMNOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_REGISTERBUDGETCHANGENOTIFICATION)(_Inout_ D3DKMT_REGISTERBUDGETCHANGENOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UNREGISTERBUDGETCHANGENOTIFICATION)(_Inout_ D3DKMT_UNREGISTERBUDGETCHANGENOTIFICATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT2)(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_PRESENTMULTIPLANEOVERLAY2)(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_RECLAIMALLOCATIONS2)(_Inout_ D3DKMT_RECLAIMALLOCATIONS2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETSTABLEPOWERSTATE)(_In_ CONST D3DKMT_SETSTABLEPOWERSTATE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYCLOCKCALIBRATION)(_Inout_ D3DKMT_QUERYCLOCKCALIBRATION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYVIDPNEXCLUSIVEOWNERSHIP)(_Inout_ D3DKMT_QUERYVIDPNEXCLUSIVEOWNERSHIP*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ADJUSTFULLSCREENGAMMA)(_In_ D3DKMT_ADJUSTFULLSCREENGAMMA*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETVIDPNSOURCEHWPROTECTION)(_In_ D3DKMT_SETVIDPNSOURCEHWPROTECTION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_MARKDEVICEASERROR)(_In_ D3DKMT_MARKDEVICEASERROR*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_FLUSHHEAPTRANSITIONS)(_In_ D3DKMT_FLUSHHEAPTRANSITIONS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETHWPROTECTIONTEARDOWNRECOVERY)(_In_ D3DKMT_SETHWPROTECTIONTEARDOWNRECOVERY*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYPROCESSOFFERINFO)(_Inout_ D3DKMT_QUERYPROCESSOFFERINFO*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_TRIMPROCESSCOMMITMENT)(_Inout_ D3DKMT_TRIMPROCESSCOMMITMENT*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_UPDATEALLOCATIONPROPERTY)(_Inout_ D3DDDI_UPDATEALLOCPROPERTY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT3)(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT3*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_PRESENTMULTIPLANEOVERLAY3)(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY3*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETFSEBLOCK)(_In_ CONST D3DKMT_SETFSEBLOCK*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYFSEBLOCK)(_Inout_ D3DKMT_QUERYFSEBLOCK*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETALLOCATIONPRIORITY)(_In_ CONST D3DKMT_GETALLOCATIONPRIORITY*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETMULTIPLANEOVERLAYCAPS)(_Inout_ D3DKMT_GET_MULTIPLANE_OVERLAY_CAPS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETPOSTCOMPOSITIONCAPS)(_Inout_ D3DKMT_GET_POST_COMPOSITION_CAPS*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SETVIDPNSOURCEOWNER2)(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER2*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETPROCESSDEVICEREMOVALSUPPORT)(_Inout_ D3DKMT_GETPROCESSDEVICEREMOVALSUPPORT*); + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEPROTECTEDSESSION)(_Inout_ D3DKMT_CREATEPROTECTEDSESSION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYPROTECTEDSESSION)(_Inout_ D3DKMT_DESTROYPROTECTEDSESSION*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYPROTECTEDSESSIONSTATUS)(_Inout_ D3DKMT_QUERYPROTECTEDSESSIONSTATUS*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_QUERYPROTECTEDSESSIONINFOFROMNTHANDLE)(_Inout_ D3DKMT_QUERYPROTECTEDSESSIONINFOFROMNTHANDLE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENPROTECTEDSESSIONFROMNTHANDLE)(_Inout_ D3DKMT_OPENPROTECTEDSESSIONFROMNTHANDLE*); + + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENKEYEDMUTEXFROMNTHANDLE)(_Inout_ D3DKMT_OPENKEYEDMUTEXFROMNTHANDLE*); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATEHWQUEUE)(_Inout_ D3DKMT_CREATEHWQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_DESTROYHWQUEUE)(_In_ CONST D3DKMT_DESTROYHWQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITCOMMANDTOHWQUEUE)(_In_ CONST D3DKMT_SUBMITCOMMANDTOHWQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITWAITFORSYNCOBJECTSTOHWQUEUE)(_In_ CONST D3DKMT_SUBMITWAITFORSYNCOBJECTSTOHWQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITSIGNALSYNCOBJECTSTOHWQUEUE)(_In_ CONST D3DKMT_SUBMITSIGNALSYNCOBJECTSTOHWQUEUE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITPRESENTBLTTOHWQUEUE)(_In_ CONST D3DKMT_SUBMITPRESENTBLTTOHWQUEUE*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_SUBMITPRESENTTOHWQUEUE)(_Inout_ D3DKMT_SUBMITPRESENTTOHWQUEUE*); +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_5 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OUTPUTDUPLPRESENTTOHWQUEUE)(_In_ CONST D3DKMT_OUTPUTDUPLPRESENTTOHWQUEUE*); + + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_ENUMADAPTERS3)(_Inout_ D3DKMT_ENUMADAPTERS3*); + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CANCELPRESENTS)(_In_ D3DKMT_CANCEL_PRESENTS*); + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + + +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_CREATENATIVEFENCE)(_Inout_ D3DKMT_CREATENATIVEFENCE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_OPENNATIVEFENCEFROMNTHANDLE)(_Inout_ D3DKMT_OPENNATIVEFENCEFROMNTHANDLE*); +typedef _Check_return_ NTSTATUS (APIENTRY *PFND3DKMT_GETNATIVEFENCELOGDETAIL)(_Inout_ D3DKMT_GETNATIVEFENCELOGDETAIL*); +typedef _Check_return_ NTSTATUS (APIENTRY* PFND3DKMT_CREATEDOORBELL)(_In_ D3DKMT_CREATE_DOORBELL*); +typedef _Check_return_ NTSTATUS (APIENTRY* PFND3DKMT_CONNECTDOORBELL)(_In_ D3DKMT_CONNECT_DOORBELL*); +typedef _Check_return_ NTSTATUS (APIENTRY* PFND3DKMT_DESTROYDOORBELL)(_In_ D3DKMT_DESTROY_DOORBELL*); +typedef _Check_return_ NTSTATUS (APIENTRY* PFND3DKMT_NOTIFYWORKSUBMISSION)(_In_ D3DKMT_NOTIFY_WORK_SUBMISSION*); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + +typedef _Check_return_ NTSTATUS (APIENTRY* PFND3DKMT_ISFEATUREENABLED)(_Inout_ D3DKMT_ISFEATUREENABLED*); + +#endif + +#if !defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +#ifdef __cplusplus +extern "C" +{ +#endif + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateAllocation(_Inout_ D3DKMT_CREATEALLOCATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateAllocation2(_Inout_ D3DKMT_CREATEALLOCATION*); // _ADVSCH_ +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryResourceInfo(_Inout_ D3DKMT_QUERYRESOURCEINFO*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryResourceInfoFromNtHandle(_Inout_ D3DKMT_QUERYRESOURCEINFOFROMNTHANDLE*); + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTShareObjects( + _In_range_(1, D3DKMT_MAX_OBJECTS_PER_HANDLE) UINT cObjects, + _In_reads_(cObjects) CONST D3DKMT_HANDLE * hObjects, + _In_ POBJECT_ATTRIBUTES pObjectAttributes, + _In_ DWORD dwDesiredAccess, + _Out_ HANDLE * phSharedNtHandle + ); + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenNtHandleFromName(_Inout_ D3DKMT_OPENNTHANDLEFROMNAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenResourceFromNtHandle(_Inout_ D3DKMT_OPENRESOURCEFROMNTHANDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenSyncObjectFromNtHandle(_Inout_ D3DKMT_OPENSYNCOBJECTFROMNTHANDLE*); +#endif +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenResource(_Inout_ D3DKMT_OPENRESOURCE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenResource2(_Inout_ D3DKMT_OPENRESOURCE*); // _ADVSCH_ +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyAllocation(_In_ CONST D3DKMT_DESTROYALLOCATION*); + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyAllocation2(_In_ CONST D3DKMT_DESTROYALLOCATION2*); +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_0 + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetAllocationPriority(_In_ CONST D3DKMT_SETALLOCATIONPRIORITY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryAllocationResidency(_In_ CONST D3DKMT_QUERYALLOCATIONRESIDENCY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateDevice(_Inout_ D3DKMT_CREATEDEVICE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyDevice(_In_ CONST D3DKMT_DESTROYDEVICE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateContext(_Inout_ D3DKMT_CREATECONTEXT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyContext(_In_ CONST D3DKMT_DESTROYCONTEXT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateSynchronizationObject(_Inout_ D3DKMT_CREATESYNCHRONIZATIONOBJECT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateSynchronizationObject2(_Inout_ D3DKMT_CREATESYNCHRONIZATIONOBJECT2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenSynchronizationObject(_Inout_ D3DKMT_OPENSYNCHRONIZATIONOBJECT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroySynchronizationObject(_In_ CONST D3DKMT_DESTROYSYNCHRONIZATIONOBJECT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForSynchronizationObject(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForSynchronizationObject2(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECT2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSignalSynchronizationObject(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSignalSynchronizationObject2(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECT2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTLock(_Inout_ D3DKMT_LOCK*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUnlock(_In_ CONST D3DKMT_UNLOCK*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetDisplayModeList(_Inout_ D3DKMT_GETDISPLAYMODELIST*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetDisplayMode(_Inout_ CONST D3DKMT_SETDISPLAYMODE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetMultisampleMethodList(_Inout_ D3DKMT_GETMULTISAMPLEMETHODLIST*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPresent(_Inout_ D3DKMT_PRESENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTRender(_Inout_ D3DKMT_RENDER*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetRuntimeData(_Inout_ CONST D3DKMT_GETRUNTIMEDATA*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryAdapterInfo(_Inout_ CONST D3DKMT_QUERYADAPTERINFO*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenAdapterFromHdc(_Inout_ D3DKMT_OPENADAPTERFROMHDC*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenAdapterFromGdiDisplayName(_Inout_ D3DKMT_OPENADAPTERFROMGDIDISPLAYNAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenAdapterFromDeviceName(_Inout_ D3DKMT_OPENADAPTERFROMDEVICENAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCloseAdapter(_In_ CONST D3DKMT_CLOSEADAPTER*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetSharedPrimaryHandle(_Inout_ D3DKMT_GETSHAREDPRIMARYHANDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTEscape(_In_ CONST D3DKMT_ESCAPE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryStatistics(_In_ CONST D3DKMT_QUERYSTATISTICS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetVidPnSourceOwner(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetPresentHistory(_Inout_ D3DKMT_GETPRESENTHISTORY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetPresentQueueEvent(_In_ D3DKMT_HANDLE hAdapter, _Inout_ HANDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateOverlay(_Inout_ D3DKMT_CREATEOVERLAY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUpdateOverlay(_In_ CONST D3DKMT_UPDATEOVERLAY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTFlipOverlay(_In_ CONST D3DKMT_FLIPOVERLAY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyOverlay(_In_ CONST D3DKMT_DESTROYOVERLAY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForVerticalBlankEvent(_In_ CONST D3DKMT_WAITFORVERTICALBLANKEVENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetGammaRamp(_In_ CONST D3DKMT_SETGAMMARAMP*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetDeviceState(_Inout_ D3DKMT_GETDEVICESTATE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateDCFromMemory(_Inout_ D3DKMT_CREATEDCFROMMEMORY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyDCFromMemory(_In_ CONST D3DKMT_DESTROYDCFROMMEMORY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetContextSchedulingPriority(_In_ CONST D3DKMT_SETCONTEXTSCHEDULINGPRIORITY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetContextSchedulingPriority(_Inout_ D3DKMT_GETCONTEXTSCHEDULINGPRIORITY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetProcessSchedulingPriorityClass(_In_ HANDLE, _In_ D3DKMT_SCHEDULINGPRIORITYCLASS); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetProcessSchedulingPriorityClass(_In_ HANDLE, _Out_ D3DKMT_SCHEDULINGPRIORITYCLASS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReleaseProcessVidPnSourceOwners(_In_ HANDLE); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetScanLine(_Inout_ D3DKMT_GETSCANLINE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTChangeSurfacePointer(_In_ CONST D3DKMT_CHANGESURFACEPOINTER*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetQueuedLimit(_In_ CONST D3DKMT_SETQUEUEDLIMIT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPollDisplayChildren(_In_ CONST D3DKMT_POLLDISPLAYCHILDREN*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTInvalidateActiveVidPn(_In_ CONST D3DKMT_INVALIDATEACTIVEVIDPN*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckOcclusion(_In_ CONST D3DKMT_CHECKOCCLUSION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForIdle(IN CONST D3DKMT_WAITFORIDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckMonitorPowerState(_In_ CONST D3DKMT_CHECKMONITORPOWERSTATE*); +EXTERN_C _Check_return_ BOOLEAN APIENTRY D3DKMTCheckExclusiveOwnership(VOID); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckVidPnExclusiveOwnership(_In_ CONST D3DKMT_CHECKVIDPNEXCLUSIVEOWNERSHIP*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetDisplayPrivateDriverFormat(_In_ CONST D3DKMT_SETDISPLAYPRIVATEDRIVERFORMAT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSharedPrimaryLockNotification(_In_ CONST D3DKMT_SHAREDPRIMARYLOCKNOTIFICATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSharedPrimaryUnLockNotification(_In_ CONST D3DKMT_SHAREDPRIMARYUNLOCKNOTIFICATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateKeyedMutex(_Inout_ D3DKMT_CREATEKEYEDMUTEX*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenKeyedMutex(_Inout_ D3DKMT_OPENKEYEDMUTEX*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyKeyedMutex(_In_ CONST D3DKMT_DESTROYKEYEDMUTEX*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTAcquireKeyedMutex(_Inout_ D3DKMT_ACQUIREKEYEDMUTEX*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReleaseKeyedMutex(_Inout_ D3DKMT_RELEASEKEYEDMUTEX*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateKeyedMutex2(_Inout_ D3DKMT_CREATEKEYEDMUTEX2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenKeyedMutex2(_Inout_ D3DKMT_OPENKEYEDMUTEX2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTAcquireKeyedMutex2(_Inout_ D3DKMT_ACQUIREKEYEDMUTEX2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReleaseKeyedMutex2(_Inout_ D3DKMT_RELEASEKEYEDMUTEX2*); +#endif +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTConfigureSharedResource(_In_ CONST D3DKMT_CONFIGURESHAREDRESOURCE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetOverlayState(_Inout_ D3DKMT_GETOVERLAYSTATE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckSharedResourceAccess(_In_ CONST D3DKMT_CHECKSHAREDRESOURCEACCESS*); +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOfferAllocations(_In_ CONST D3DKMT_OFFERALLOCATIONS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReclaimAllocations(_Inout_ CONST D3DKMT_RECLAIMALLOCATIONS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateOutputDupl(_In_ CONST D3DKMT_CREATE_OUTPUTDUPL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyOutputDupl(_In_ CONST D3DKMT_DESTROY_OUTPUTDUPL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplGetFrameInfo(_Inout_ D3DKMT_OUTPUTDUPL_GET_FRAMEINFO*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplGetMetaData(_Inout_ D3DKMT_OUTPUTDUPL_METADATA*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplGetPointerShapeData(_Inout_ D3DKMT_OUTPUTDUPL_GET_POINTER_SHAPE_DATA*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplReleaseFrame(_Inout_ D3DKMT_OUTPUTDUPL_RELEASE_FRAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplPresent(_In_ CONST D3DKMT_OUTPUTDUPLPRESENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTEnumAdapters(_Inout_ CONST D3DKMT_ENUMADAPTERS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTEnumAdapters2(_Inout_ CONST D3DKMT_ENUMADAPTERS2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenAdapterFromLuid(_Inout_ CONST D3DKMT_OPENADAPTERFROMLUID*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryRemoteVidPnSourceFromGdiDisplayName(_Inout_ D3DKMT_QUERYREMOTEVIDPNSOURCEFROMGDIDISPLAYNAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetVidPnSourceOwner1(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER1*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForVerticalBlankEvent2(_In_ CONST D3DKMT_WAITFORVERTICALBLANKEVENT2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetSyncRefreshCountWaitTarget(_In_ CONST D3DKMT_SETSYNCREFRESHCOUNTWAITTARGET*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetDWMVerticalBlankEvent(_In_ CONST D3DKMT_GETVERTICALBLANKEVENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPresentMultiPlaneOverlay(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetSharedResourceAdapterLuid(_Inout_ D3DKMT_GETSHAREDRESOURCEADAPTERLUID*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckMultiPlaneOverlaySupport(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetContextInProcessSchedulingPriority(_In_ CONST D3DKMT_SETCONTEXTINPROCESSSCHEDULINGPRIORITY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetContextInProcessSchedulingPriority(_Inout_ D3DKMT_GETCONTEXTINPROCESSSCHEDULINGPRIORITY*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTMakeResident(_Inout_ D3DDDI_MAKERESIDENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTEvict(_Inout_ D3DKMT_EVICT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForSynchronizationObjectFromCpu(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMCPU*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSignalSynchronizationObjectFromCpu(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMCPU*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitForSynchronizationObjectFromGpu(_In_ CONST D3DKMT_WAITFORSYNCHRONIZATIONOBJECTFROMGPU*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSignalSynchronizationObjectFromGpu(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSignalSynchronizationObjectFromGpu2(_In_ CONST D3DKMT_SIGNALSYNCHRONIZATIONOBJECTFROMGPU2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreatePagingQueue(_Inout_ D3DKMT_CREATEPAGINGQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyPagingQueue(_Inout_ D3DDDI_DESTROYPAGINGQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTLock2(_Inout_ D3DKMT_LOCK2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUnlock2(_In_ CONST D3DKMT_UNLOCK2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTInvalidateCache(_In_ CONST D3DKMT_INVALIDATECACHE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTMapGpuVirtualAddress(_Inout_ D3DDDI_MAPGPUVIRTUALADDRESS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReserveGpuVirtualAddress(_Inout_ D3DDDI_RESERVEGPUVIRTUALADDRESS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTFreeGpuVirtualAddress(_In_ CONST D3DKMT_FREEGPUVIRTUALADDRESS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUpdateGpuVirtualAddress(_In_ CONST D3DKMT_UPDATEGPUVIRTUALADDRESS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetResourcePresentPrivateDriverData(_Inout_ D3DDDI_GETRESOURCEPRESENTPRIVATEDRIVERDATA*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateContextVirtual(_In_ D3DKMT_CREATECONTEXTVIRTUAL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitCommand(_In_ CONST D3DKMT_SUBMITCOMMAND*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenSyncObjectFromNtHandle2(_Inout_ D3DKMT_OPENSYNCOBJECTFROMNTHANDLE2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenSyncObjectNtHandleFromName(_Inout_ D3DKMT_OPENSYNCOBJECTNTHANDLEFROMNAME*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryVideoMemoryInfo(_Inout_ D3DKMT_QUERYVIDEOMEMORYINFO*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTChangeVideoMemoryReservation(_In_ CONST D3DKMT_CHANGEVIDEOMEMORYRESERVATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTRegisterTrimNotification(_Inout_ D3DKMT_REGISTERTRIMNOTIFICATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUnregisterTrimNotification(_Inout_ D3DKMT_UNREGISTERTRIMNOTIFICATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckMultiPlaneOverlaySupport2(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPresentMultiPlaneOverlay2(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTReclaimAllocations2(_Inout_ D3DKMT_RECLAIMALLOCATIONS2*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetStablePowerState(_In_ CONST D3DKMT_SETSTABLEPOWERSTATE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryClockCalibration(_Inout_ D3DKMT_QUERYCLOCKCALIBRATION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryVidPnExclusiveOwnership(_Inout_ D3DKMT_QUERYVIDPNEXCLUSIVEOWNERSHIP*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTAdjustFullscreenGamma(_In_ D3DKMT_ADJUSTFULLSCREENGAMMA*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetVidPnSourceHwProtection(_In_ D3DKMT_SETVIDPNSOURCEHWPROTECTION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTMarkDeviceAsError(_In_ D3DKMT_MARKDEVICEASERROR*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTFlushHeapTransitions(_In_ D3DKMT_FLUSHHEAPTRANSITIONS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetHwProtectionTeardownRecovery(_In_ D3DKMT_SETHWPROTECTIONTEARDOWNRECOVERY*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryProcessOfferInfo(_Inout_ D3DKMT_QUERYPROCESSOFFERINFO*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTTrimProcessCommitment(_Inout_ D3DKMT_TRIMPROCESSCOMMITMENT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTUpdateAllocationProperty(_Inout_ D3DDDI_UPDATEALLOCPROPERTY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCheckMultiPlaneOverlaySupport3(_Inout_ D3DKMT_CHECKMULTIPLANEOVERLAYSUPPORT3*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPresentMultiPlaneOverlay3(_In_ CONST D3DKMT_PRESENT_MULTIPLANE_OVERLAY3*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetFSEBlock(_In_ CONST D3DKMT_SETFSEBLOCK*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryFSEBlock(_Inout_ D3DKMT_QUERYFSEBLOCK*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateHwContext(_Inout_ D3DKMT_CREATEHWCONTEXT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyHwContext(_In_ CONST D3DKMT_DESTROYHWCONTEXT*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateHwQueue(_Inout_ D3DKMT_CREATEHWQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyHwQueue(_In_ CONST D3DKMT_DESTROYHWQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitCommandToHwQueue(_In_ CONST D3DKMT_SUBMITCOMMANDTOHWQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitWaitForSyncObjectsToHwQueue(_In_ CONST D3DKMT_SUBMITWAITFORSYNCOBJECTSTOHWQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitSignalSyncObjectsToHwQueue(_In_ CONST D3DKMT_SUBMITSIGNALSYNCOBJECTSTOHWQUEUE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetAllocationPriority(_In_ CONST D3DKMT_GETALLOCATIONPRIORITY*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetMultiPlaneOverlayCaps(_Inout_ D3DKMT_GET_MULTIPLANE_OVERLAY_CAPS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetPostCompositionCaps(_Inout_ D3DKMT_GET_POST_COMPOSITION_CAPS*); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTPresentRedirected(_In_ D3DKMT_PRESENT_REDIRECTED*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetVidPnSourceOwner2(_In_ CONST D3DKMT_SETVIDPNSOURCEOWNER2*); + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSetMonitorColorSpaceTransform(_In_ D3DKMT_SET_COLORSPACE_TRANSFORM*); + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateProtectedSession(_Inout_ D3DKMT_CREATEPROTECTEDSESSION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyProtectedSession(_Inout_ D3DKMT_DESTROYPROTECTEDSESSION*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryProtectedSessionStatus(_Inout_ D3DKMT_QUERYPROTECTEDSESSIONSTATUS*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTQueryProtectedSessionInfoFromNtHandle(_Inout_ D3DKMT_QUERYPROTECTEDSESSIONINFOFROMNTHANDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenProtectedSessionFromNtHandle(_Inout_ D3DKMT_OPENPROTECTEDSESSIONFROMNTHANDLE*); + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetProcessDeviceRemovalSupport(_Inout_ D3DKMT_GETPROCESSDEVICEREMOVALSUPPORT*); + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenKeyedMutexFromNtHandle(_Inout_ D3DKMT_OPENKEYEDMUTEXFROMNTHANDLE*); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTRegisterVailProcess(_In_ GUID*); + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitPresentBltToHwQueue(_In_ CONST D3DKMT_SUBMITPRESENTBLTTOHWQUEUE*); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTSubmitPresentToHwQueue(_Inout_ D3DKMT_SUBMITPRESENTTOHWQUEUE*); + +#endif + + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOutputDuplPresentToHwQueue(_In_ CONST D3DKMT_OUTPUTDUPLPRESENTTOHWQUEUE*); + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_7) + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTEnumAdapters3(_Inout_ D3DKMT_ENUMADAPTERS3*); + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_9) + + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCancelPresents(_In_ D3DKMT_CANCEL_PRESENTS*); + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTShareObjectWithHost(_Inout_ D3DKMT_SHAREOBJECTWITHHOST*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateSyncFile(_Inout_ D3DKMT_CREATESYNCFILE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTWaitSyncFile(_In_ CONST D3DKMT_WAITSYNCFILE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenSyncObjectFromSyncFile(_Inout_ D3DKMT_OPENSYNCOBJECTFROMSYNCFILE*); + +// Used in WSL to close the internal file descriptor to /dev/dxg +EXTERN_C VOID APIENTRY D3DKMTCloseDxCoreDevice(); + +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateNativeFence(_Inout_ D3DKMT_CREATENATIVEFENCE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTOpenNativeFenceFromNtHandle(_Inout_ D3DKMT_OPENNATIVEFENCEFROMNTHANDLE*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTGetNativeFenceLogDetail(_Inout_ D3DKMT_GETNATIVEFENCELOGDETAIL*); + + +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTCreateDoorbell(_In_ D3DKMT_CREATE_DOORBELL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTConnectDoorbell(_In_ D3DKMT_CONNECT_DOORBELL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTDestroyDoorbell(_In_ D3DKMT_DESTROY_DOORBELL*); +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTNotifyWorkSubmission(_In_ D3DKMT_NOTIFY_WORK_SUBMISSION*); +#endif + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) +EXTERN_C _Check_return_ NTSTATUS APIENTRY D3DKMTIsFeatureEnabled(_Inout_ D3DKMT_ISFEATUREENABLED*); + +#endif + +// +// Interface used for shared power component management +// {ea5c6870-e93c-4588-bef1-fec42fc9429a} +// + +DEFINE_GUID(GUID_DEVINTERFACE_GRAPHICSPOWER, 0xea5c6870, 0xe93c, 0x4588, 0xbe, 0xf1, 0xfe, 0xc4, 0x2f, 0xc9, 0x42, 0x9a); + +#define IOCTL_INTERNAL_GRAPHICSPOWER_REGISTER \ + CTL_CODE(FILE_DEVICE_VIDEO, 0xa01, METHOD_NEITHER, FILE_ANY_ACCESS) + +#define DXGK_GRAPHICSPOWER_VERSION_1_0 0x1000 +#define DXGK_GRAPHICSPOWER_VERSION_1_1 0x1001 +#define DXGK_GRAPHICSPOWER_VERSION_1_2 0x1002 +#define DXGK_GRAPHICSPOWER_VERSION DXGK_GRAPHICSPOWER_VERSION_1_2 + +typedef + _IRQL_requires_max_(PASSIVE_LEVEL) +VOID +(*PDXGK_POWER_NOTIFICATION)( + PVOID GraphicsDeviceHandle, + DEVICE_POWER_STATE NewGrfxPowerState, + BOOLEAN PreNotification, + PVOID PrivateHandle + ); + +typedef + _IRQL_requires_max_(PASSIVE_LEVEL) +VOID +(*PDXGK_REMOVAL_NOTIFICATION)( + PVOID GraphicsDeviceHandle, + PVOID PrivateHandle + ); + +typedef + _IRQL_requires_max_(DISPATCH_LEVEL) +VOID +(*PDXGK_FSTATE_NOTIFICATION)( + PVOID GraphicsDeviceHandle, + ULONG ComponentIndex, + UINT NewFState, + BOOLEAN PreNotification, + PVOID PrivateHandle + ); + +typedef + _IRQL_requires_(DISPATCH_LEVEL) +VOID +(*PDXGK_INITIAL_COMPONENT_STATE) ( + PVOID GraphicsDeviceHandle, + PVOID PrivateHandle, + ULONG ComponentIndex, + BOOLEAN IsBlockingType, + UINT InitialFState, + GUID ComponentGuid, + UINT PowerComponentMappingFlag +); + + +typedef struct _DXGK_GRAPHICSPOWER_REGISTER_INPUT_V_1_2 { + ULONG Version; + PVOID PrivateHandle; + PDXGK_POWER_NOTIFICATION PowerNotificationCb; + PDXGK_REMOVAL_NOTIFICATION RemovalNotificationCb; + PDXGK_FSTATE_NOTIFICATION FStateNotificationCb; + PDXGK_INITIAL_COMPONENT_STATE InitialComponentStateCb; +} DXGK_GRAPHICSPOWER_REGISTER_INPUT_V_1_2, *PDXGK_GRAPHICSPOWER_REGISTER_INPUT_V_1_2; + +typedef DXGK_GRAPHICSPOWER_REGISTER_INPUT_V_1_2 DXGK_GRAPHICSPOWER_REGISTER_INPUT; +typedef DXGK_GRAPHICSPOWER_REGISTER_INPUT *PDXGK_GRAPHICSPOWER_REGISTER_INPUT; + +typedef + _Check_return_ + _IRQL_requires_max_(APC_LEVEL) +NTSTATUS +(*PDXGK_SET_SHARED_POWER_COMPONENT_STATE)( + PVOID DeviceHandle, + PVOID PrivateHandle, + ULONG ComponentIndex, + BOOLEAN Active + ); + +typedef + _Check_return_ + _IRQL_requires_max_(APC_LEVEL) +NTSTATUS +(*PDXGK_GRAPHICSPOWER_UNREGISTER)( + PVOID DeviceHandle, + PVOID PrivateHandle + ); + +typedef struct _DXGK_GRAPHICSPOWER_REGISTER_OUTPUT +{ + PVOID DeviceHandle; + DEVICE_POWER_STATE InitialGrfxPowerState; + PDXGK_SET_SHARED_POWER_COMPONENT_STATE SetSharedPowerComponentStateCb; + PDXGK_GRAPHICSPOWER_UNREGISTER UnregisterCb; +} DXGK_GRAPHICSPOWER_REGISTER_OUTPUT, *PDXGK_GRAPHICSPOWER_REGISTER_OUTPUT; + +typedef enum _DXGKMT_POWER_SHARED_TYPE +{ + DXGKMT_POWER_SHARED_TYPE_AUDIO = 0, +} DXGKMT_POWER_SHARED_TYPE; + +#ifdef __cplusplus +} +#endif + +#endif // !defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +#endif // (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + + +#pragma warning(pop) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _D3DKMTHK_H_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dukmdt.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dukmdt.h new file mode 100644 index 0000000000000000000000000000000000000000..58b845e2192e8ee321ffa277bcef58f3893670de --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/d3dukmdt.h @@ -0,0 +1,2348 @@ +/******************************Module*Header************************************\ +* +* Module Name: d3dukmdt.h +* +* Content: Longhorn Display Driver Model (LDDM) user/kernel mode +* shared data type definitions. +* +* Copyright (c) 2003 Microsoft Corporation. All rights reserved. +\*******************************************************************************/ +#ifndef _D3DUKMDT_H_ +#define _D3DUKMDT_H_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#if !defined(_D3DKMDT_H) && \ + !defined(_D3DKMTHK_H_) && \ + !defined(_D3DUMDDI_H_) && \ + !defined(__DXGKRNLETW_H__) + #error This header should not be included directly! +#endif + +#pragma warning(push) +#pragma warning(disable:4201) // anonymous unions warning +#pragma warning(disable:4214) // nonstandard extension used: bit field types other than int + + +// +// WDDM DDI Interface Version +// + +#define DXGKDDI_INTERFACE_VERSION_VISTA 0x1052 +#define DXGKDDI_INTERFACE_VERSION_VISTA_SP1 0x1053 +#define DXGKDDI_INTERFACE_VERSION_WIN7 0x2005 +#define DXGKDDI_INTERFACE_VERSION_WIN8 0x300E +#define DXGKDDI_INTERFACE_VERSION_WDDM1_3 0x4002 +#define DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION 0x4003 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_0 0x5023 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_1 0x6003 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_1_5 0x6010 // Used in RS1.7 for GPU-P +#define DXGKDDI_INTERFACE_VERSION_WDDM2_1_6 0x6011 // Used in RS1.8 for GPU-P +#define DXGKDDI_INTERFACE_VERSION_WDDM2_2 0x700A +#define DXGKDDI_INTERFACE_VERSION_WDDM2_3 0x8001 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_4 0x9006 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_5 0xA00B +#define DXGKDDI_INTERFACE_VERSION_WDDM2_6 0xB004 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_7 0xC004 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_8 0xD001 +#define DXGKDDI_INTERFACE_VERSION_WDDM2_9 0xE003 +#define DXGKDDI_INTERFACE_VERSION_WDDM3_0 0xF003 +#define DXGKDDI_INTERFACE_VERSION_WDDM3_1 0x10004 +#define DXGKDDI_INTERFACE_VERSION_WDDM3_2 0x11007 + + +#define IS_OFFICIAL_DDI_INTERFACE_VERSION(version) \ + (((version) == DXGKDDI_INTERFACE_VERSION_VISTA) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_VISTA_SP1) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WIN7) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WIN8) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM1_3) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM1_3_PATH_INDEPENDENT_ROTATION) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_1) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_1_5) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_1_6) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_3) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_4) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_5) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_6) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_7) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_8) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM2_9) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM3_0) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM3_1) || \ + ((version) == DXGKDDI_INTERFACE_VERSION_WDDM3_2) \ + ) + +#if !defined(DXGKDDI_INTERFACE_VERSION) +#define DXGKDDI_INTERFACE_VERSION DXGKDDI_INTERFACE_VERSION_WDDM3_2 +#endif // !defined(DXGKDDI_INTERFACE_VERSION) + +#define D3D_UMD_INTERFACE_VERSION_VISTA 0x000C +#define D3D_UMD_INTERFACE_VERSION_WIN7 0x2003 +#define D3D_UMD_INTERFACE_VERSION_WIN8_M3 0x3001 +#define D3D_UMD_INTERFACE_VERSION_WIN8_CP 0x3002 +#define D3D_UMD_INTERFACE_VERSION_WIN8_RC 0x3003 +#define D3D_UMD_INTERFACE_VERSION_WIN8 0x3004 +#define D3D_UMD_INTERFACE_VERSION_WDDM1_3 0x4002 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_0_M1 0x5000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_0_M1_3 0x5001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_0_M2_2 0x5002 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_0 0x5002 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_1_1 0x6000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_1_2 0x6001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_1_3 0x6002 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_1_4 0x6003 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_1 D3D_UMD_INTERFACE_VERSION_WDDM2_1_4 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_2_1 0x7000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_2_2 0x7001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_2 D3D_UMD_INTERFACE_VERSION_WDDM2_2_2 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_3_1 0x8000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_3_2 0x8001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_3 D3D_UMD_INTERFACE_VERSION_WDDM2_3_2 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_4_1 0x9000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_4_2 0x9001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_4 D3D_UMD_INTERFACE_VERSION_WDDM2_4_2 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_5_1 0xA000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_5_2 0xA001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_5_3 0xA002 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_5 D3D_UMD_INTERFACE_VERSION_WDDM2_5_3 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_6_1 0xB000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_6_2 0xB001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_6_3 0xB002 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_6_4 0xB003 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_6 D3D_UMD_INTERFACE_VERSION_WDDM2_6_4 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_7_1 0xC000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_7_2 0xC001 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_7 D3D_UMD_INTERFACE_VERSION_WDDM2_7_2 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_8_1 0xD000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_8 D3D_UMD_INTERFACE_VERSION_WDDM2_8_1 + +#define D3D_UMD_INTERFACE_VERSION_WDDM2_9_1 0xE000 +#define D3D_UMD_INTERFACE_VERSION_WDDM2_9 D3D_UMD_INTERFACE_VERSION_WDDM2_9_1 + +#define D3D_UMD_INTERFACE_VERSION_WDDM3_0_1 0xF000 +#define D3D_UMD_INTERFACE_VERSION_WDDM3_0 D3D_UMD_INTERFACE_VERSION_WDDM3_0_1 + +#define D3D_UMD_INTERFACE_VERSION_WDDM3_1_1 0x10000 +#define D3D_UMD_INTERFACE_VERSION_WDDM3_1 D3D_UMD_INTERFACE_VERSION_WDDM3_1_1 + +#define D3D_UMD_INTERFACE_VERSION_WDDM3_2_1 0x11000 +#define D3D_UMD_INTERFACE_VERSION_WDDM3_2 D3D_UMD_INTERFACE_VERSION_WDDM3_2_1 + +// Components which depend on D3D_UMD_INTERFACE_VERSION need to be updated, static assert validation present. +// Search for D3D_UMD_INTERFACE_VERSION across all depots to ensure all dependencies are updated. + +#if !defined(D3D_UMD_INTERFACE_VERSION) +#define D3D_UMD_INTERFACE_VERSION D3D_UMD_INTERFACE_VERSION_WDDM3_2 +#endif // !defined(D3D_UMD_INTERFACE_VERSION) + +// +// These macros are used to enable non-Windows 32-bit usermode to fill out a fixed-size +// structure for D3DKMT structures, so that they can be sent to a 64-bit kernel +// without a thunking layer for translation. +// +// Note that a thunking layer is still used for wchar_t translation, where Windows uses +// 16-bit characters and non-Windows uses 32-bit characters. +// +// If brace initialization is used (e.g. D3DKMT_FOO foo = { a, b, c }), be aware that for +// non-Windows, pointers will be unioned such that a 64-bit integer is the member that is +// initialized. It is not possible to achieve both type safety and proper zero-initialization +// of the high bits of pointers with brace initialization in this model. Use D3DKMT_PTR_INIT(ptr) +// to appropriately cast to a 64-bit integer for non-Windows, or to pass the pointer unchanged for +// Windows. To maintain type safety, manually assign the fields after zero-initializing the struct. +// +#ifdef _WIN32 +// For Windows, don't enforce any unnatural alignment or data sizes/types. +// The WOW64 thunking layer will handle translation. +#define D3DKMT_ALIGN64 +#define D3DKMT_PTR_HELPER(Name) +#define D3DKMT_PTR(Type, Name) Type Name +#define D3DKMT_PTR_INIT(x) (x) +typedef SIZE_T D3DKMT_SIZE_T; +typedef UINT_PTR D3DKMT_UINT_PTR; +typedef ULONG_PTR D3DKMT_ULONG_PTR; +typedef HANDLE D3DKMT_PTR_TYPE; +#else +// For other platforms, struct layout should be fixed-size, x64-compatible +#if __cplusplus >= 201103L + #define D3DKMT_ALIGN64 alignas(8) +#else + #define D3DKMT_ALIGN64 __attribute__((aligned(8))) +#endif +#define D3DKMT_PTR_HELPER(Name) D3DKMT_ALIGN64 UINT64 Name; +#define D3DKMT_PTR(Type, Name) \ +union D3DKMT_ALIGN64 \ +{ \ + D3DKMT_PTR_HELPER(Name##_Align) \ + Type Name; \ +} +#define D3DKMT_PTR_INIT(x) { (UINT64)(SIZE_T)(x) } +typedef UINT64 D3DKMT_SIZE_T, D3DKMT_UINT_PTR, D3DKMT_ULONG_PTR; +typedef union _D3DKMT_PTR_TYPE +{ + D3DKMT_PTR_HELPER(Ptr_Align); + HANDLE Ptr; +} D3DKMT_PTR_TYPE; +#endif + +// +// Available only for Vista (LONGHORN) and later and for +// multiplatform tools such as debugger extensions +// +#if (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +typedef ULONGLONG D3DGPU_VIRTUAL_ADDRESS; +typedef ULONGLONG D3DGPU_SIZE_T; +#define D3DGPU_UNIQUE_DRIVER_PROTECTION 0x8000000000000000ULL + +#define DXGK_MAX_PAGE_TABLE_LEVEL_COUNT 6 +#define DXGK_MIN_PAGE_TABLE_LEVEL_COUNT 2 +#define DXGK_MAX_GPU_VA_BIT_COUNT 63 + +// +// IOCTL_GPUP_DRIVER_ESCAPE - The user mode emulation DLL calls this IOCTL +// to exchange information with the kernel mode driver. +// +#define IOCTL_GPUP_DRIVER_ESCAPE CTL_CODE(FILE_DEVICE_UNKNOWN, (8 + 0x910), METHOD_BUFFERED, FILE_READ_DATA) +typedef struct _GPUP_DRIVER_ESCAPE_INPUT +{ + LUID vfLUID; //LUID that was returned from SET_PARTITION_DETAILS +} GPUP_DRIVER_ESCAPE_INPUT, *PGPUP_DRIVER_ESCAPE_INPUT; + +typedef enum _DXGKVGPU_ESCAPE_TYPE +{ + DXGKVGPU_ESCAPE_TYPE_READ_PCI_CONFIG = 0, + DXGKVGPU_ESCAPE_TYPE_WRITE_PCI_CONFIG = 1, + DXGKVGPU_ESCAPE_TYPE_INITIALIZE = 2, + DXGKVGPU_ESCAPE_TYPE_RELEASE = 3, + DXGKVGPU_ESCAPE_TYPE_GET_VGPU_TYPE = 4, + DXGKVGPU_ESCAPE_TYPE_POWERTRANSITIONCOMPLETE = 5, + DXGKVGPU_ESCAPE_TYPE_PAUSE = 6, + DXGKVGPU_ESCAPE_TYPE_RESUME = 7, +} DXGKVGPU_ESCAPE_TYPE; + +typedef struct _DXGKVGPU_ESCAPE_HEAD +{ + GPUP_DRIVER_ESCAPE_INPUT Luid; + DXGKVGPU_ESCAPE_TYPE Type; +} DXGKVGPU_ESCAPE_HEAD; + +typedef struct _DXGKVGPU_ESCAPE_READ_PCI_CONFIG +{ + DXGKVGPU_ESCAPE_HEAD Header; + + UINT Offset; // Offset in bytes in the PCI config space + UINT Size; // Size in bytes to read +} DXGKVGPU_ESCAPE_READ_PCI_CONFIG; + +typedef struct _DXGKVGPU_ESCAPE_WRITE_PCI_CONFIG +{ + DXGKVGPU_ESCAPE_HEAD Header; + + UINT Offset; // Offset in bytes in the PCI config space + UINT Size; // Size in bytes to write + // "Size" number of bytes follow +} DXGKVGPU_ESCAPE_WRITE_PCI_CONFIG; + +typedef struct _DXGKVGPU_ESCAPE_READ_VGPU_TYPE +{ + DXGKVGPU_ESCAPE_HEAD Header; +} DXGKVGPU_ESCAPE_READ_VGPU_TYPE; + +typedef struct _DXGKVGPU_ESCAPE_POWERTRANSITIONCOMPLETE +{ + DXGKVGPU_ESCAPE_HEAD Header; + UINT PowerState; +} DXGKVGPU_ESCAPE_POWERTRANSITIONCOMPLETE; + +typedef struct _DXGKVGPU_ESCAPE_INITIALIZE +{ + DXGKVGPU_ESCAPE_HEAD Header; + GUID VmGuid; +} DXGKVGPU_ESCAPE_INITIALIZE; + +typedef struct _DXGKVGPU_ESCAPE_RELEASE +{ + DXGKVGPU_ESCAPE_HEAD Header; +} DXGKVGPU_ESCAPE_RELEASE; + +typedef struct _DXGKVGPU_ESCAPE_PAUSE +{ + DXGKVGPU_ESCAPE_HEAD Header; + LUID DeviceLuid; + union + { + struct + { + UINT GuestVmRunning : 1; + }; + UINT Flags; + }; +} DXGKVGPU_ESCAPE_PAUSE; + +typedef struct _DXGKVGPU_ESCAPE_RESUME +{ + DXGKVGPU_ESCAPE_HEAD Header; + LUID DeviceLuid; + UINT Flags; // enum GPUP_SAVE_RESTORE_PAUSE_STATE +} DXGKVGPU_ESCAPE_RESUME; + + +typedef enum _DXGK_PTE_PAGE_SIZE +{ + DXGK_PTE_PAGE_TABLE_PAGE_4KB = 0, + DXGK_PTE_PAGE_TABLE_PAGE_64KB = 1, +} DXGK_PTE_PAGE_SIZE; + +// +// Page Table Entry structure. Contains segment/physical address pointing to a page +// + +typedef struct _DXGK_PTE +{ + union + { + struct + { + ULONGLONG Valid : 1; + ULONGLONG Zero : 1; + ULONGLONG CacheCoherent : 1; + ULONGLONG ReadOnly : 1; + ULONGLONG NoExecute : 1; + ULONGLONG Segment : 5; + ULONGLONG LargePage : 1; + ULONGLONG PhysicalAdapterIndex : 6; + ULONGLONG PageTablePageSize : 2; // DXGK_PTE_PAGE_SIZE + ULONGLONG SystemReserved0 : 1; + ULONGLONG Reserved : 44; + }; + ULONGLONG Flags; + }; + union + { + ULONGLONG PageAddress; // High 52 bits of 64 bit physical address. Low 12 bits are zero. + ULONGLONG PageTableAddress; // High 52 bits of 64 bit physical address. Low 12 bits are zero. + }; +} DXGK_PTE; + +#define D3DGPU_NULL 0 +#define D3DDDI_MAX_WRITTEN_PRIMARIES 16 +#define D3DDDI_MAX_MPO_PRESENT_DIRTY_RECTS 0xFFF + +typedef struct _D3DGPU_PHYSICAL_ADDRESS +{ + UINT SegmentId; + UINT Padding; + UINT64 SegmentOffset; +} D3DGPU_PHYSICAL_ADDRESS; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present source unique identification number descriptor type +// + +typedef UINT D3DDDI_VIDEO_PRESENT_SOURCE_ID; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present source unique identification number descriptor type. +// +typedef UINT D3DDDI_VIDEO_PRESENT_TARGET_ID; + +// +// DDI level handle that represents a kernel mode object (allocation, device, etc) +// +typedef UINT D3DKMT_HANDLE; + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video present target mode fractional frequency descriptor type. +// +// Remarks: Fractional value used to represent vertical and horizontal frequencies of a video mode +// (i.e. VSync and HSync). Vertical frequencies are stored in Hz. Horizontal frequencies +// are stored in Hz. +// The dynamic range of this encoding format, given 10^-7 resolution is {0..(2^32 - 1) / 10^7}, +// which translates to {0..428.4967296} [Hz] for vertical frequencies and {0..428.4967296} [Hz] +// for horizontal frequencies. This sub-microseconds precision range should be acceptable even +// for a pro-video application (error in one microsecond for video signal synchronization would +// imply a time drift with a cycle of 10^7/(60*60*24) = 115.741 days. +// +// If rational number with a finite fractional sequence, use denominator of form 10^(length of fractional sequence). +// If rational number without a finite fractional sequence, or a sequence exceeding the precision allowed by the +// dynamic range of the denominator, or an irrational number, use an appropriate ratio of integers which best +// represents the value. +// +typedef struct _D3DDDI_RATIONAL +{ + UINT Numerator; + UINT Denominator; +} D3DDDI_RATIONAL; + +typedef struct _D3DDDI_ALLOCATIONINFO +{ + D3DKMT_HANDLE hAllocation; // out: Private driver data for allocation + D3DKMT_PTR(CONST VOID*, pSystemMem); // in: Pointer to pre-allocated sysmem + D3DKMT_PTR(VOID*, pPrivateDriverData); // in(out optional): Private data for each allocation + UINT PrivateDriverDataSize; // in: Size of the private data + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPN source ID if this is a primary + union + { + struct + { + UINT Primary : 1; // 0x00000001 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN8)) + UINT Stereo : 1; // 0x00000002 + UINT Reserved :30; // 0xFFFFFFFC +#else + UINT Reserved :31; // 0xFFFFFFFE +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + }; + UINT Value; + } Flags; +} D3DDDI_ALLOCATIONINFO; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN7) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN7)) + +typedef struct _D3DDDI_ALLOCATIONINFO2 +{ + D3DKMT_HANDLE hAllocation; // out: Private driver data for allocation + union D3DKMT_ALIGN64 + { + D3DKMT_PTR_HELPER(pSystemMem_hSection_Align) + HANDLE hSection; // in: Handle to valid section object + CONST VOID* pSystemMem; // in: Pointer to pre-allocated sysmem + }; + D3DKMT_PTR(VOID*, pPrivateDriverData); // in(out optional): Private data for each allocation + UINT PrivateDriverDataSize; // in: Size of the private data + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPN source ID if this is a primary + union + { + struct + { + UINT Primary : 1; // 0x00000001 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN8)) + UINT Stereo : 1; // 0x00000002 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_2)) + UINT OverridePriority : 1; // 0x00000004 + UINT Reserved : 29; // 0xFFFFFFF8 +#else + UINT Reserved : 30; // 0xFFFFFFFC +#endif +#else + UINT Reserved :31; // 0xFFFFFFFE +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + }; + UINT Value; + } Flags; + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS GpuVirtualAddress; // out: GPU Virtual address of the allocation created. +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_2)) + union + { + UINT Priority; // in: priority of allocation + D3DKMT_ALIGN64 ULONG_PTR Unused; + }; + D3DKMT_ALIGN64 ULONG_PTR Reserved[5]; // Reserved +#else + D3DKMT_ALIGN64 ULONG_PTR Reserved[6]; // Reserved +#endif +} D3DDDI_ALLOCATIONINFO2; + +#endif + +typedef struct _D3DDDI_OPENALLOCATIONINFO +{ + D3DKMT_HANDLE hAllocation; // in: Handle for this allocation in this process + D3DKMT_PTR(CONST VOID*, pPrivateDriverData); // in: Ptr to driver private buffer for this allocations + UINT PrivateDriverDataSize; // in: Size in bytes of driver private buffer for this allocations + +} D3DDDI_OPENALLOCATIONINFO; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN7) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN7)) + +typedef struct _D3DDDI_OPENALLOCATIONINFO2 +{ + D3DKMT_HANDLE hAllocation; // in: Handle for this allocation in this process + D3DKMT_PTR(CONST VOID*, pPrivateDriverData);// in: Ptr to driver private buffer for this allocations + UINT PrivateDriverDataSize; // in: Size in bytes of driver private buffer for this allocations + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS GpuVirtualAddress; // out: GPU Virtual address of the allocation opened. + D3DKMT_ALIGN64 ULONG_PTR Reserved[6]; // Reserved +} D3DDDI_OPENALLOCATIONINFO2; + +#endif + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN8)) + +typedef enum _D3DDDI_OFFER_PRIORITY +{ + D3DDDI_OFFER_PRIORITY_NONE=0, // Do not offer + D3DDDI_OFFER_PRIORITY_LOW=1, // Content is not useful + D3DDDI_OFFER_PRIORITY_NORMAL, // Content is useful but easy to regenerate + D3DDDI_OFFER_PRIORITY_HIGH, // Content is useful and difficult to regenerate + D3DDDI_OFFER_PRIORITY_AUTO, // Let VidMm decide offer priority based on eviction priority +} D3DDDI_OFFER_PRIORITY; + +#endif + +typedef struct _D3DDDI_ALLOCATIONLIST +{ + D3DKMT_HANDLE hAllocation; + union + { + struct + { + UINT WriteOperation : 1; // 0x00000001 + UINT DoNotRetireInstance : 1; // 0x00000002 + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN8)) + UINT OfferPriority : 3; // 0x0000001C D3DDDI_OFFER_PRIORITY + UINT Reserved :27; // 0xFFFFFFE0 +#else + UINT Reserved :30; // 0xFFFFFFFC +#endif + }; + UINT Value; + }; +} D3DDDI_ALLOCATIONLIST; + +typedef struct _D3DDDI_PATCHLOCATIONLIST +{ + UINT AllocationIndex; + union + { + struct + { + UINT SlotId : 24; // 0x00FFFFFF + UINT Reserved : 8; // 0xFF000000 + }; + UINT Value; + }; + UINT DriverId; + UINT AllocationOffset; + UINT PatchOffset; + UINT SplitOffset; +} D3DDDI_PATCHLOCATIONLIST; + +typedef struct _D3DDDICB_LOCKFLAGS +{ + union + { + struct + { + UINT ReadOnly : 1; // 0x00000001 + UINT WriteOnly : 1; // 0x00000002 + UINT DonotWait : 1; // 0x00000004 + UINT IgnoreSync : 1; // 0x00000008 + UINT LockEntire : 1; // 0x00000010 + UINT DonotEvict : 1; // 0x00000020 + UINT AcquireAperture : 1; // 0x00000040 + UINT Discard : 1; // 0x00000080 + UINT NoExistingReference : 1; // 0x00000100 + UINT UseAlternateVA : 1; // 0x00000200 + UINT IgnoreReadSync : 1; // 0x00000400 + UINT Reserved :21; // 0xFFFFF800 + }; + UINT Value; + }; +} D3DDDICB_LOCKFLAGS; + +typedef struct _D3DDDICB_LOCK2FLAGS +{ + union + { + struct + { + UINT Reserved : 32; // 0xFFFFFFFF + }; + UINT Value; + }; +} D3DDDICB_LOCK2FLAGS; + +typedef struct _D3DDDICB_DESTROYALLOCATION2FLAGS +{ + union + { + struct + { + UINT AssumeNotInUse : 1; // 0x00000001 + UINT SynchronousDestroy : 1; // 0x00000002 + UINT Reserved : 29; // 0x7FFFFFFC + UINT SystemUseOnly : 1; // 0x80000000 // Should not be set by the UMD + }; + UINT Value; + }; +} D3DDDICB_DESTROYALLOCATION2FLAGS; + +typedef struct _D3DDDI_ESCAPEFLAGS +{ + union + { + struct + { + UINT HardwareAccess : 1; // 0x00000001 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM1_3)) + UINT DeviceStatusQuery : 1; // 0x00000002 + UINT ChangeFrameLatency : 1; // 0x00000004 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + UINT NoAdapterSynchronization : 1; // 0x00000008 +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + UINT Reserved : 1; // 0x00000010 Used internally by DisplayOnly present + UINT VirtualMachineData : 1; // 0x00000020 Cannot be set from user mode +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + UINT DriverKnownEscape : 1; // 0x00000040 // Driver private data points to a well known structure + UINT DriverCommonEscape : 1; // 0x00000080 // Private data points runtime defined structure + UINT Reserved2 :24; // 0xFFFFFF00 +#else // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + UINT Reserved2 :26; // 0xFFFFFFC0 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) +#else + UINT Reserved :28; // 0xFFFFFFF0 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) +#else + UINT Reserved :29; // 0xFFFFFFF8 +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) +#else + UINT Reserved :31; // 0xFFFFFFFE +#endif // WDDM1_3 + }; + UINT Value; + }; +} D3DDDI_ESCAPEFLAGS; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +typedef enum _D3DDDI_DRIVERESCAPETYPE +{ + D3DDDI_DRIVERESCAPETYPE_TRANSLATEALLOCATIONHANDLE = 0, + D3DDDI_DRIVERESCAPETYPE_TRANSLATERESOURCEHANDLE = 1, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + D3DDDI_DRIVERESCAPETYPE_CPUEVENTUSAGE = 2, +#endif +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + D3DDDI_DRIVERESCAPETYPE_BUILDTESTCOMMANDBUFFER = 3, +#endif + D3DDDI_DRIVERESCAPETYPE_MAX, +} D3DDDI_DRIVERESCAPETYPE; + +typedef struct _D3DDDI_DRIVERESCAPE_TRANSLATEALLOCATIONEHANDLE +{ + D3DDDI_DRIVERESCAPETYPE EscapeType; + D3DKMT_HANDLE hAllocation; +} D3DDDI_DRIVERESCAPE_TRANSLATEALLOCATIONEHANDLE; + +typedef struct _D3DDDI_DRIVERESCAPE_TRANSLATERESOURCEHANDLE +{ + D3DDDI_DRIVERESCAPETYPE EscapeType; + D3DKMT_HANDLE hResource; +} D3DDDI_DRIVERESCAPE_TRANSLATERESOURCEHANDLE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_5) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +typedef struct _D3DDDI_DRIVERESCAPE_CPUEVENTUSAGE +{ + D3DDDI_DRIVERESCAPETYPE EscapeType; + D3DKMT_HANDLE hSyncObject; + D3DKMT_ALIGN64 UINT64 hKmdCpuEvent; + UINT Usage[8]; +} D3DDDI_DRIVERESCAPE_CPUEVENTUSAGE; + +#endif + +typedef struct _D3DDDI_CREATECONTEXTFLAGS +{ + union + { + struct + { + UINT NullRendering : 1; // 0x00000001 + UINT InitialData : 1; // 0x00000002 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + UINT DisableGpuTimeout : 1; // 0x00000004 + UINT SynchronizationOnly : 1; // 0x00000008 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_3_1)) + UINT HwQueueSupported : 1; // 0x00000010 + UINT NoKmdAccess : 1; // 0x00000020 + UINT TestContext : 1; // 0x00000040 + UINT Reserved :25; // 0xFFFFFF80 +#else + UINT Reserved :28; // 0xFFFFFFF0 +#endif // DXGKDDI_INTERFACE_VERSION + +#else + UINT Reserved :30; // 0xFFFFFFFC +#endif // DXGKDDI_INTERFACE_VERSION + }; + UINT Value; + }; +} D3DDDI_CREATECONTEXTFLAGS; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_2_1)) + +typedef struct _D3DDDI_CREATEHWCONTEXTFLAGS +{ + union + { + struct + { + UINT Reserved :32; // 0xFFFFFFFF + }; + UINT Value; + }; +} D3DDDI_CREATEHWCONTEXTFLAGS; + +typedef struct _D3DDDI_CREATEHWQUEUEFLAGS +{ + union + { + struct + { + UINT DisableGpuTimeout : 1; // 0x00000001 + UINT NoBroadcastSignal : 1; // 0x00000002 + UINT NoBroadcastWait : 1; // 0x00000004 + UINT NoKmdAccess : 1; // 0x00000008 + UINT UserModeSubmission : 1; // 0x00000010 + UINT NativeProgressFence : 1; // 0x00000020 + UINT TestQueue : 1; // 0x00000040 + UINT Reserved :25; // 0xFFFFFF80 + }; + UINT Value; + }; +} D3DDDI_CREATEHWQUEUEFLAGS; + +#endif // ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + +typedef struct _D3DDDI_SEGMENTPREFERENCE +{ + union + { + struct + { + UINT SegmentId0 : 5; // 0x0000001F + UINT Direction0 : 1; // 0x00000020 + UINT SegmentId1 : 5; // 0x000007C0 + UINT Direction1 : 1; // 0x00000800 + UINT SegmentId2 : 5; // 0x0001F000 + UINT Direction2 : 1; // 0x00020000 + UINT SegmentId3 : 5; // 0x007C0000 + UINT Direction3 : 1; // 0x00800000 + UINT SegmentId4 : 5; // 0x1F000000 + UINT Direction4 : 1; // 0x20000000 + UINT Reserved : 2; // 0xC0000000 + }; + UINT Value; + }; +} D3DDDI_SEGMENTPREFERENCE; + +/* Formats + * Most of these names have the following convention: + * A = Alpha + * R = Red + * G = Green + * B = Blue + * X = Unused Bits + * P = Palette + * L = Luminance + * U = dU coordinate for BumpMap + * V = dV coordinate for BumpMap + * S = Stencil + * D = Depth (e.g. Z or W buffer) + * C = Computed from other channels (typically on certain read operations) + * + * Further, the order of the pieces are from MSB first; hence + * D3DFMT_A8L8 indicates that the high byte of this two byte + * format is alpha. + * + * D16 indicates: + * - An integer 16-bit value. + * - An app-lockable surface. + * + * All Depth/Stencil formats except D3DFMT_D16_LOCKABLE indicate: + * - no particular bit ordering per pixel, and + * - are not app lockable, and + * - the driver is allowed to consume more than the indicated + * number of bits per Depth channel (but not Stencil channel). + */ +#ifndef MAKEFOURCC + #define MAKEFOURCC(ch0, ch1, ch2, ch3) \ + ((DWORD)(BYTE)(ch0) | ((DWORD)(BYTE)(ch1) << 8) | \ + ((DWORD)(BYTE)(ch2) << 16) | ((DWORD)(BYTE)(ch3) << 24 )) +#endif /* defined(MAKEFOURCC) */ + + +typedef enum _D3DDDIFORMAT +{ + + D3DDDIFMT_UNKNOWN = 0, + + D3DDDIFMT_R8G8B8 = 20, + D3DDDIFMT_A8R8G8B8 = 21, + D3DDDIFMT_X8R8G8B8 = 22, + D3DDDIFMT_R5G6B5 = 23, + D3DDDIFMT_X1R5G5B5 = 24, + D3DDDIFMT_A1R5G5B5 = 25, + D3DDDIFMT_A4R4G4B4 = 26, + D3DDDIFMT_R3G3B2 = 27, + D3DDDIFMT_A8 = 28, + D3DDDIFMT_A8R3G3B2 = 29, + D3DDDIFMT_X4R4G4B4 = 30, + D3DDDIFMT_A2B10G10R10 = 31, + D3DDDIFMT_A8B8G8R8 = 32, + D3DDDIFMT_X8B8G8R8 = 33, + D3DDDIFMT_G16R16 = 34, + D3DDDIFMT_A2R10G10B10 = 35, + D3DDDIFMT_A16B16G16R16 = 36, + + D3DDDIFMT_A8P8 = 40, + D3DDDIFMT_P8 = 41, + + D3DDDIFMT_L8 = 50, + D3DDDIFMT_A8L8 = 51, + D3DDDIFMT_A4L4 = 52, + + D3DDDIFMT_V8U8 = 60, + D3DDDIFMT_L6V5U5 = 61, + D3DDDIFMT_X8L8V8U8 = 62, + D3DDDIFMT_Q8W8V8U8 = 63, + D3DDDIFMT_V16U16 = 64, + D3DDDIFMT_W11V11U10 = 65, + D3DDDIFMT_A2W10V10U10 = 67, + + D3DDDIFMT_UYVY = MAKEFOURCC('U', 'Y', 'V', 'Y'), + D3DDDIFMT_R8G8_B8G8 = MAKEFOURCC('R', 'G', 'B', 'G'), + D3DDDIFMT_YUY2 = MAKEFOURCC('Y', 'U', 'Y', '2'), + D3DDDIFMT_G8R8_G8B8 = MAKEFOURCC('G', 'R', 'G', 'B'), + D3DDDIFMT_DXT1 = MAKEFOURCC('D', 'X', 'T', '1'), + D3DDDIFMT_DXT2 = MAKEFOURCC('D', 'X', 'T', '2'), + D3DDDIFMT_DXT3 = MAKEFOURCC('D', 'X', 'T', '3'), + D3DDDIFMT_DXT4 = MAKEFOURCC('D', 'X', 'T', '4'), + D3DDDIFMT_DXT5 = MAKEFOURCC('D', 'X', 'T', '5'), + + D3DDDIFMT_D16_LOCKABLE = 70, + D3DDDIFMT_D32 = 71, + D3DDDIFMT_D15S1 = 73, + D3DDDIFMT_D24S8 = 75, + D3DDDIFMT_D24X8 = 77, + D3DDDIFMT_D24X4S4 = 79, + D3DDDIFMT_D16 = 80, + + D3DDDIFMT_D32F_LOCKABLE = 82, + D3DDDIFMT_D24FS8 = 83, + + D3DDDIFMT_D32_LOCKABLE = 84, + D3DDDIFMT_S8_LOCKABLE = 85, + + D3DDDIFMT_S1D15 = 72, + D3DDDIFMT_S8D24 = 74, + D3DDDIFMT_X8D24 = 76, + D3DDDIFMT_X4S4D24 = 78, + + D3DDDIFMT_L16 = 81, +#if (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM1_3) // M1 + D3DDDIFMT_G8R8 = 91, + D3DDDIFMT_R8 = 92, +#endif + + D3DDDIFMT_VERTEXDATA =100, + D3DDDIFMT_INDEX16 =101, + D3DDDIFMT_INDEX32 =102, + + D3DDDIFMT_Q16W16V16U16 =110, + + D3DDDIFMT_MULTI2_ARGB8 = MAKEFOURCC('M','E','T','1'), + + // Floating point surface formats + + // s10e5 formats (16-bits per channel) + D3DDDIFMT_R16F = 111, + D3DDDIFMT_G16R16F = 112, + D3DDDIFMT_A16B16G16R16F = 113, + + // IEEE s23e8 formats (32-bits per channel) + D3DDDIFMT_R32F = 114, + D3DDDIFMT_G32R32F = 115, + D3DDDIFMT_A32B32G32R32F = 116, + + D3DDDIFMT_CxV8U8 = 117, + + // Monochrome 1 bit per pixel format + D3DDDIFMT_A1 = 118, + + // 2.8 biased fixed point + D3DDDIFMT_A2B10G10R10_XR_BIAS = 119, + + // Decode compressed buffer formats + D3DDDIFMT_DXVACOMPBUFFER_BASE = 150, + D3DDDIFMT_PICTUREPARAMSDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+0, // 150 + D3DDDIFMT_MACROBLOCKDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+1, // 151 + D3DDDIFMT_RESIDUALDIFFERENCEDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+2, // 152 + D3DDDIFMT_DEBLOCKINGDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+3, // 153 + D3DDDIFMT_INVERSEQUANTIZATIONDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+4, // 154 + D3DDDIFMT_SLICECONTROLDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+5, // 155 + D3DDDIFMT_BITSTREAMDATA = D3DDDIFMT_DXVACOMPBUFFER_BASE+6, // 156 + D3DDDIFMT_MOTIONVECTORBUFFER = D3DDDIFMT_DXVACOMPBUFFER_BASE+7, // 157 + D3DDDIFMT_FILMGRAINBUFFER = D3DDDIFMT_DXVACOMPBUFFER_BASE+8, // 158 + D3DDDIFMT_DXVA_RESERVED9 = D3DDDIFMT_DXVACOMPBUFFER_BASE+9, // 159 + D3DDDIFMT_DXVA_RESERVED10 = D3DDDIFMT_DXVACOMPBUFFER_BASE+10, // 160 + D3DDDIFMT_DXVA_RESERVED11 = D3DDDIFMT_DXVACOMPBUFFER_BASE+11, // 161 + D3DDDIFMT_DXVA_RESERVED12 = D3DDDIFMT_DXVACOMPBUFFER_BASE+12, // 162 + D3DDDIFMT_DXVA_RESERVED13 = D3DDDIFMT_DXVACOMPBUFFER_BASE+13, // 163 + D3DDDIFMT_DXVA_RESERVED14 = D3DDDIFMT_DXVACOMPBUFFER_BASE+14, // 164 + D3DDDIFMT_DXVA_RESERVED15 = D3DDDIFMT_DXVACOMPBUFFER_BASE+15, // 165 + D3DDDIFMT_DXVA_RESERVED16 = D3DDDIFMT_DXVACOMPBUFFER_BASE+16, // 166 + D3DDDIFMT_DXVA_RESERVED17 = D3DDDIFMT_DXVACOMPBUFFER_BASE+17, // 167 + D3DDDIFMT_DXVA_RESERVED18 = D3DDDIFMT_DXVACOMPBUFFER_BASE+18, // 168 + D3DDDIFMT_DXVA_RESERVED19 = D3DDDIFMT_DXVACOMPBUFFER_BASE+19, // 169 + D3DDDIFMT_DXVA_RESERVED20 = D3DDDIFMT_DXVACOMPBUFFER_BASE+20, // 170 + D3DDDIFMT_DXVA_RESERVED21 = D3DDDIFMT_DXVACOMPBUFFER_BASE+21, // 171 + D3DDDIFMT_DXVA_RESERVED22 = D3DDDIFMT_DXVACOMPBUFFER_BASE+22, // 172 + D3DDDIFMT_DXVA_RESERVED23 = D3DDDIFMT_DXVACOMPBUFFER_BASE+23, // 173 + D3DDDIFMT_DXVA_RESERVED24 = D3DDDIFMT_DXVACOMPBUFFER_BASE+24, // 174 + D3DDDIFMT_DXVA_RESERVED25 = D3DDDIFMT_DXVACOMPBUFFER_BASE+25, // 175 + D3DDDIFMT_DXVA_RESERVED26 = D3DDDIFMT_DXVACOMPBUFFER_BASE+26, // 176 + D3DDDIFMT_DXVA_RESERVED27 = D3DDDIFMT_DXVACOMPBUFFER_BASE+27, // 177 + D3DDDIFMT_DXVA_RESERVED28 = D3DDDIFMT_DXVACOMPBUFFER_BASE+28, // 178 + D3DDDIFMT_DXVA_RESERVED29 = D3DDDIFMT_DXVACOMPBUFFER_BASE+29, // 179 + D3DDDIFMT_DXVA_RESERVED30 = D3DDDIFMT_DXVACOMPBUFFER_BASE+30, // 180 + D3DDDIFMT_DXVA_RESERVED31 = D3DDDIFMT_DXVACOMPBUFFER_BASE+31, // 181 + D3DDDIFMT_DXVACOMPBUFFER_MAX = D3DDDIFMT_DXVA_RESERVED31, + + D3DDDIFMT_BINARYBUFFER = 199, + + D3DDDIFMT_FORCE_UINT =0x7fffffff +} D3DDDIFORMAT; + +typedef enum D3DDDI_COLOR_SPACE_TYPE +{ + D3DDDI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 = 0, + D3DDDI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 = 1, + D3DDDI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P709 = 2, + D3DDDI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P2020 = 3, + D3DDDI_COLOR_SPACE_RESERVED = 4, + D3DDDI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601 = 5, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 = 6, + D3DDDI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P601 = 7, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 = 8, + D3DDDI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P709 = 9, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020 = 10, + D3DDDI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020 = 11, + D3DDDI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 = 12, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G2084_LEFT_P2020 = 13, + D3DDDI_COLOR_SPACE_RGB_STUDIO_G2084_NONE_P2020 = 14, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G22_TOPLEFT_P2020 = 15, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G2084_TOPLEFT_P2020 = 16, + D3DDDI_COLOR_SPACE_RGB_FULL_G22_NONE_P2020 = 17, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_GHLG_TOPLEFT_P2020 = 18, + D3DDDI_COLOR_SPACE_YCBCR_FULL_GHLG_TOPLEFT_P2020 = 19, + D3DDDI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P709 = 20, + D3DDDI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P2020 = 21, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P709 = 22, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P2020 = 23, + D3DDDI_COLOR_SPACE_YCBCR_STUDIO_G24_TOPLEFT_P2020 = 24, + D3DDDI_COLOR_SPACE_CUSTOM = 0xFFFFFFFF +} D3DDDI_COLOR_SPACE_TYPE; + +// +// Note: This enum is intended to specify the final wire signaling +// colorspace values. Do not mix it with enum values defined in +// D3DDDI_COLOR_SPACE_TYPE which are used to specify +// input colorspace for MPOs and other surfaces. +// +typedef enum _D3DDDI_OUTPUT_WIRE_COLOR_SPACE_TYPE +{ + // We are using the same values for these first two enums for + // backward compatibility to WDDM2.2 drivers which used + // to get these 2 values from D3DDDI_COLOR_SPACE_TYPE + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G22_P709 = 0, + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_RESERVED = 4, + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G2084_P2020 = 12, + + // We are starting the new enum value at 30 just to make sure it + // is not confused with the existing D3DDDI_COLOR_SPACE_TYPE + // in the short term + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G22_P709_WCG = 30, + + // OS only intend to use the _G22_P2020 value in future, + // for now graphics drivers should not expect it. + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G22_P2020 = 31, + + // OS only intend to use the _G2084_P2020_HDR10PLUS value in future, + // for now graphics drivers should not expect it. + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G2084_P2020_HDR10PLUS = 32, + + // OS only intend to use the _G2084_P2020_DVLL value in future, + // for now graphics drivers should not expect it. + D3DDDI_OUTPUT_WIRE_COLOR_SPACE_G2084_P2020_DVLL = 33, +} D3DDDI_OUTPUT_WIRE_COLOR_SPACE_TYPE; + +typedef struct _D3DDDIRECT +{ + LONG left; + LONG top; + LONG right; + LONG bottom; +} D3DDDIRECT; + +typedef struct _D3DDDI_KERNELOVERLAYINFO +{ + D3DKMT_HANDLE hAllocation; // in: Allocation to be displayed + D3DDDIRECT DstRect; // in: Dest rect + D3DDDIRECT SrcRect; // in: Source rect + D3DKMT_PTR(VOID*, pPrivateDriverData); // in: Private driver data + UINT PrivateDriverDataSize; // in: Size of private driver data +} D3DDDI_KERNELOVERLAYINFO; + +typedef enum _D3DDDI_GAMMARAMP_TYPE +{ + D3DDDI_GAMMARAMP_UNINITIALIZED = 0, + D3DDDI_GAMMARAMP_DEFAULT = 1, + D3DDDI_GAMMARAMP_RGB256x3x16 = 2, + D3DDDI_GAMMARAMP_DXGI_1 = 3, +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) + D3DDDI_GAMMARAMP_MATRIX_3x4 = 4, +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_3) +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + D3DDDI_GAMMARAMP_MATRIX_V2 = 5, +#endif // DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6 +} D3DDDI_GAMMARAMP_TYPE; + +typedef struct _D3DDDI_GAMMA_RAMP_RGB256x3x16 +{ + USHORT Red[256]; + USHORT Green[256]; + USHORT Blue[256]; +} D3DDDI_GAMMA_RAMP_RGB256x3x16; + +typedef struct D3DDDI_DXGI_RGB +{ + float Red; + float Green; + float Blue; +} D3DDDI_DXGI_RGB; + +typedef struct _D3DDDI_GAMMA_RAMP_DXGI_1 +{ + D3DDDI_DXGI_RGB Scale; + D3DDDI_DXGI_RGB Offset; + D3DDDI_DXGI_RGB GammaCurve[1025]; +} D3DDDI_GAMMA_RAMP_DXGI_1; + +typedef struct _D3DKMDT_3X4_COLORSPACE_TRANSFORM +{ + float ColorMatrix3x4[3][4]; + float ScalarMultiplier; + D3DDDI_DXGI_RGB LookupTable1D[4096]; +} D3DKMDT_3x4_COLORSPACE_TRANSFORM, *PD3DDDI_3x4_COLORSPACE_TRANSFORM; + +typedef enum _D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL +{ + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL_NO_CHANGE = 0, + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL_ENABLE = 1, + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL_BYPASS = 2, +}D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL, *PD3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL; + +typedef struct _D3DKMDT_COLORSPACE_TRANSFORM_MATRIX_V2 +{ + // stage of 1D Degamma. + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlLookupTable1DDegamma; + D3DDDI_DXGI_RGB LookupTable1DDegamma[4096]; + + // stage of 3x3 matrix + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlColorMatrix3x3; + float ColorMatrix3x3[3][3]; + + // stage of 1D Regamma. + D3DKMDT_COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlLookupTable1DRegamma; + D3DDDI_DXGI_RGB LookupTable1DRegamma[4096]; +} D3DKMDT_COLORSPACE_TRANSFORM_MATRIX_V2, *PD3DKMDT_COLORSPACE_TRANSFORM_MATRIX_V2; + +typedef enum _D3DDDI_HDR_METADATA_TYPE +{ + D3DDDI_HDR_METADATA_TYPE_NONE = 0, + D3DDDI_HDR_METADATA_TYPE_HDR10 = 1, + D3DDDI_HDR_METADATA_TYPE_HDR10PLUS = 2, +} D3DDDI_HDR_METADATA_TYPE; + +typedef struct _D3DDDI_HDR_METADATA_HDR10 +{ + // Color gamut + UINT16 RedPrimary[2]; + UINT16 GreenPrimary[2]; + UINT16 BluePrimary[2]; + UINT16 WhitePoint[2]; + + // Luminance + UINT MaxMasteringLuminance; + UINT MinMasteringLuminance; + UINT16 MaxContentLightLevel; + UINT16 MaxFrameAverageLightLevel; +} D3DDDI_HDR_METADATA_HDR10; + +typedef struct D3DDDI_HDR_METADATA_HDR10PLUS +{ + BYTE Data[72]; +} D3DDDI_HDR_METADATA_HDR10PLUS; + +// Used as a value for D3DDDI_VIDEO_PRESENT_SOURCE_ID and D3DDDI_VIDEO_PRESENT_TARGET_ID types to specify +// that the respective video present source/target ID hasn't been initialized. +#define D3DDDI_ID_UNINITIALIZED (UINT)(~0) + +// TODO:[mmilirud] Define this as (UINT)(~1) to avoid collision with valid source ID equal to 0. +// +// Used as a value for D3DDDI_VIDEO_PRESENT_SOURCE_ID and D3DDDI_VIDEO_PRESENT_TARGET_ID types to specify +// that the respective video present source/target ID isn't applicable for the given execution context. +#define D3DDDI_ID_NOTAPPLICABLE (UINT)(0) + +// Indicates that a resource can be associated with "any" VidPn source, even none at all. +#define D3DDDI_ID_ANY (UINT)(~1) + +// Used as a value for D3DDDI_VIDEO_PRESENT_SOURCE_ID and D3DDDI_VIDEO_PRESENT_TARGET_ID types to specify +// that the respective video present source/target ID describes every VidPN source/target in question. +#define D3DDDI_ID_ALL (UINT)(~2) + +// +// Hardcoded VidPnSource count +// +#define D3DKMDT_MAX_VIDPN_SOURCES_BITCOUNT 4 +#define D3DKMDT_MAX_VIDPN_SOURCES (1 << D3DKMDT_MAX_VIDPN_SOURCES_BITCOUNT) + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Multi-sampling method descriptor type. +// +// Remarks: Driver is free to partition its quality levels for a given multi-sampling method into as many +// increments as it likes, with the condition that each incremental step does noticably improve +// quality of the presented image. +// +typedef struct _D3DDDI_MULTISAMPLINGMETHOD +{ + // Number of sub-pixels employed in this multi-sampling method (e.g. 2 for 2x and 8 for 8x multi-sampling) + UINT NumSamples; + + // Upper bound on the quality range supported for this multi-sampling method. The range starts from 0 + // and goes upto and including the reported maximum quality setting. + UINT NumQualityLevels; +} +D3DDDI_MULTISAMPLINGMETHOD; + + +///////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Purpose: Video signal scan line ordering descriptor type. +// +// Remarks: Scan-line ordering of the video mode, specifies whether each field contains the entire +// content of a frame, or only half of it (i.e. even/odd lines interchangeably). +// Note that while for standard interlaced modes, what field comes first can be inferred +// from the mode, specifying this characteristic explicitly with an enum both frees up the +// client from having to maintain mode-based look-up tables and is extensible for future +// standard modes not listed in the D3DKMDT_VIDEO_SIGNAL_STANDARD enum. +// +typedef enum _D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING +{ + D3DDDI_VSSLO_UNINITIALIZED = 0, + D3DDDI_VSSLO_PROGRESSIVE = 1, + D3DDDI_VSSLO_INTERLACED_UPPERFIELDFIRST = 2, + D3DDDI_VSSLO_INTERLACED_LOWERFIELDFIRST = 3, + D3DDDI_VSSLO_OTHER = 255 +} +D3DDDI_VIDEO_SIGNAL_SCANLINE_ORDERING; + + +typedef enum D3DDDI_FLIPINTERVAL_TYPE +{ + D3DDDI_FLIPINTERVAL_IMMEDIATE = 0, + D3DDDI_FLIPINTERVAL_ONE = 1, + D3DDDI_FLIPINTERVAL_TWO = 2, + D3DDDI_FLIPINTERVAL_THREE = 3, + D3DDDI_FLIPINTERVAL_FOUR = 4, + + // This value is only valid for the D3D9 runtime PresentCb SyncIntervalOverride field. + // For this field, IMMEDIATE means the API semantic of sync interval 0, where + // IMMEDIATE_ALLOW_TEARING is equivalent to the addition of the DXGI ALLOW_TEARING API flags. + D3DDDI_FLIPINTERVAL_IMMEDIATE_ALLOW_TEARING = 5, +} D3DDDI_FLIPINTERVAL_TYPE; + + +typedef enum _D3DDDI_POOL +{ + D3DDDIPOOL_SYSTEMMEM = 1, + D3DDDIPOOL_VIDEOMEMORY = 2, + D3DDDIPOOL_LOCALVIDMEM = 3, + D3DDDIPOOL_NONLOCALVIDMEM = 4, +#if (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM1_3) // M1 + D3DDDIPOOL_STAGINGMEM = 5, +#endif +} D3DDDI_POOL; + + +typedef enum _D3DDDIMULTISAMPLE_TYPE +{ + D3DDDIMULTISAMPLE_NONE = 0, + D3DDDIMULTISAMPLE_NONMASKABLE = 1, + D3DDDIMULTISAMPLE_2_SAMPLES = 2, + D3DDDIMULTISAMPLE_3_SAMPLES = 3, + D3DDDIMULTISAMPLE_4_SAMPLES = 4, + D3DDDIMULTISAMPLE_5_SAMPLES = 5, + D3DDDIMULTISAMPLE_6_SAMPLES = 6, + D3DDDIMULTISAMPLE_7_SAMPLES = 7, + D3DDDIMULTISAMPLE_8_SAMPLES = 8, + D3DDDIMULTISAMPLE_9_SAMPLES = 9, + D3DDDIMULTISAMPLE_10_SAMPLES = 10, + D3DDDIMULTISAMPLE_11_SAMPLES = 11, + D3DDDIMULTISAMPLE_12_SAMPLES = 12, + D3DDDIMULTISAMPLE_13_SAMPLES = 13, + D3DDDIMULTISAMPLE_14_SAMPLES = 14, + D3DDDIMULTISAMPLE_15_SAMPLES = 15, + D3DDDIMULTISAMPLE_16_SAMPLES = 16, + + D3DDDIMULTISAMPLE_FORCE_UINT = 0x7fffffff +} D3DDDIMULTISAMPLE_TYPE; + +typedef struct _D3DDDI_RESOURCEFLAGS +{ + union + { + struct + { + UINT RenderTarget : 1; // 0x00000001 + UINT ZBuffer : 1; // 0x00000002 + UINT Dynamic : 1; // 0x00000004 + UINT HintStatic : 1; // 0x00000008 + UINT AutogenMipmap : 1; // 0x00000010 + UINT DMap : 1; // 0x00000020 + UINT WriteOnly : 1; // 0x00000040 + UINT NotLockable : 1; // 0x00000080 + UINT Points : 1; // 0x00000100 + UINT RtPatches : 1; // 0x00000200 + UINT NPatches : 1; // 0x00000400 + UINT SharedResource : 1; // 0x00000800 + UINT DiscardRenderTarget : 1; // 0x00001000 + UINT Video : 1; // 0x00002000 + UINT CaptureBuffer : 1; // 0x00004000 + UINT Primary : 1; // 0x00008000 + UINT Texture : 1; // 0x00010000 + UINT CubeMap : 1; // 0x00020000 + UINT Volume : 1; // 0x00040000 + UINT VertexBuffer : 1; // 0x00080000 + UINT IndexBuffer : 1; // 0x00100000 + UINT DecodeRenderTarget : 1; // 0x00200000 + UINT DecodeCompressedBuffer : 1; // 0x00400000 + UINT VideoProcessRenderTarget: 1; // 0x00800000 + UINT CpuOptimized : 1; // 0x01000000 + UINT MightDrawFromLocked : 1; // 0x02000000 + UINT Overlay : 1; // 0x04000000 + UINT MatchGdiPrimary : 1; // 0x08000000 + UINT InterlacedRefresh : 1; // 0x10000000 + UINT TextApi : 1; // 0x20000000 + UINT RestrictedContent : 1; // 0x40000000 + UINT RestrictSharedAccess : 1; // 0x80000000 + }; + UINT Value; + }; +} D3DDDI_RESOURCEFLAGS; + +typedef struct _D3DDDI_SURFACEINFO +{ + UINT Width; // in: For linear, surface and volume + UINT Height; // in: For surface and volume + UINT Depth; // in: For volume + CONST VOID* pSysMem; + UINT SysMemPitch; + UINT SysMemSlicePitch; +} D3DDDI_SURFACEINFO; + +typedef enum _D3DDDI_ROTATION +{ + D3DDDI_ROTATION_IDENTITY = 1, // No rotation. + D3DDDI_ROTATION_90 = 2, // Rotated 90 degrees. + D3DDDI_ROTATION_180 = 3, // Rotated 180 degrees. + D3DDDI_ROTATION_270 = 4 // Rotated 270 degrees. +} D3DDDI_ROTATION; + +typedef enum D3DDDI_SCANLINEORDERING +{ + D3DDDI_SCANLINEORDERING_UNKNOWN = 0, + D3DDDI_SCANLINEORDERING_PROGRESSIVE = 1, + D3DDDI_SCANLINEORDERING_INTERLACED = 2, +} D3DDDI_SCANLINEORDERING; + +typedef struct _D3DDDIARG_CREATERESOURCE +{ + D3DDDIFORMAT Format; + D3DDDI_POOL Pool; + D3DDDIMULTISAMPLE_TYPE MultisampleType; + UINT MultisampleQuality; + CONST D3DDDI_SURFACEINFO* pSurfList; // in: List of sub resource objects to create + UINT SurfCount; // in: Number of sub resource objects + UINT MipLevels; + UINT Fvf; // in: FVF format for vertex buffers + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPnSourceId on which the primary surface is created + D3DDDI_RATIONAL RefreshRate; // in: RefreshRate that this primary surface is to be used with + HANDLE hResource; // in/out: D3D runtime handle/UM driver handle + D3DDDI_RESOURCEFLAGS Flags; + D3DDDI_ROTATION Rotation; // in: The orientation of the resource. (0, 90, 180, 270) +} D3DDDIARG_CREATERESOURCE; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WIN8)) + +typedef struct _D3DDDI_RESOURCEFLAGS2 +{ + union + { + struct + { + UINT VideoEncoder : 1; // 0x00000001 + UINT UserMemory : 1; // 0x00000002 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM1_3)) // M1 + UINT CrossAdapter : 1; // 0x00000004 +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + UINT IsDisplayable : 1; // 0x00000008 + UINT Reserved : 28; +#else + UINT Reserved : 29; +#endif +#else + UINT Reserved : 30; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + }; + UINT Value; + }; +} D3DDDI_RESOURCEFLAGS2; + + +typedef struct _D3DDDIARG_CREATERESOURCE2 +{ + D3DDDIFORMAT Format; + D3DDDI_POOL Pool; + D3DDDIMULTISAMPLE_TYPE MultisampleType; + UINT MultisampleQuality; + CONST D3DDDI_SURFACEINFO* pSurfList; // in: List of sub resource objects to create + UINT SurfCount; // in: Number of sub resource objects + UINT MipLevels; + UINT Fvf; // in: FVF format for vertex buffers + D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId; // in: VidPnSourceId on which the primary surface is created + D3DDDI_RATIONAL RefreshRate; // in: RefreshRate that this primary surface is to be used with + HANDLE hResource; // in/out: D3D runtime handle/UM driver handle + D3DDDI_RESOURCEFLAGS Flags; + D3DDDI_ROTATION Rotation; // in: The orientation of the resource. (0, 90, 180, 270) + D3DDDI_RESOURCEFLAGS2 Flags2; +} D3DDDIARG_CREATERESOURCE2; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + +typedef struct _D3DDDICB_SIGNALFLAGS +{ + union + { + struct + { + UINT SignalAtSubmission : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + UINT EnqueueCpuEvent : 1; +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + UINT AllowFenceRewind : 1; + UINT Reserved : 28; + UINT DXGK_SIGNAL_FLAG_INTERNAL0 : 1; +#else + UINT Reserved : 30; +#endif +#else + UINT Reserved : 31; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WIN8) + }; + UINT Value; + }; +} D3DDDICB_SIGNALFLAGS; + +#define D3DDDI_MAX_OBJECT_WAITED_ON 32 +#define D3DDDI_MAX_OBJECT_SIGNALED 32 + +typedef enum _D3DDDI_SYNCHRONIZATIONOBJECT_TYPE +{ + D3DDDI_SYNCHRONIZATION_MUTEX = 1, + D3DDDI_SEMAPHORE = 2, + D3DDDI_FENCE = 3, + D3DDDI_CPU_NOTIFICATION = 4, + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + D3DDDI_MONITORED_FENCE = 5, +#endif // DXGKDDI_INTERFACE_VERSION + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_2)) + D3DDDI_PERIODIC_MONITORED_FENCE = 6, +#endif // DXGKDDI_INTERFACE_VERSION + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM3_1)) + D3DDDI_NATIVE_FENCE = 7, +#endif + D3DDDI_SYNCHRONIZATION_TYPE_LIMIT + +} D3DDDI_SYNCHRONIZATIONOBJECT_TYPE; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + +#define D3DDDI_SYNC_OBJECT_WAIT 0x1 +#define D3DDDI_SYNC_OBJECT_SIGNAL 0x2 +#define D3DDDI_SYNC_OBJECT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | D3DDDI_SYNC_OBJECT_WAIT | D3DDDI_SYNC_OBJECT_SIGNAL) + +#endif // DXGKDDI_INTERFACE_VERSION + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +typedef union +{ + struct + { + UINT64 FrameNumber : 40; + UINT64 PartNumber : 24; + }; + UINT64 Value; +}DXGK_MIRACAST_CHUNK_ID; + +typedef enum _DXGK_MIRACAST_CHUNK_TYPE +{ + DXGK_MIRACAST_CHUNK_TYPE_UNKNOWN = 0, + DXGK_MIRACAST_CHUNK_TYPE_COLOR_CONVERT_COMPLETE = 1, + DXGK_MIRACAST_CHUNK_TYPE_ENCODE_COMPLETE = 2, + DXGK_MIRACAST_CHUNK_TYPE_FRAME_START = 3, + DXGK_MIRACAST_CHUNK_TYPE_FRAME_DROPPED = 4, + DXGK_MIRACAST_CHUNK_TYPE_ENCODE_DRIVER_DEFINED_1 = 0x80000000, + DXGK_MIRACAST_CHUNK_TYPE_ENCODE_DRIVER_DEFINED_2 = 0x80000001, +} DXGK_MIRACAST_CHUNK_TYPE; + +typedef struct +{ + DXGK_MIRACAST_CHUNK_TYPE ChunkType; // Type of chunk info + DXGK_MIRACAST_CHUNK_ID ChunkId; // Identifier for this chunk + UINT ProcessingTime; // Time the process took to complete in microsecond + UINT EncodeRate; // Encode bitrate driver reported for the chunk, kilobits per second +} DXGK_MIRACAST_CHUNK_INFO; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + +typedef enum D3DDDI_PAGINGQUEUE_PRIORITY +{ + D3DDDI_PAGINGQUEUE_PRIORITY_BELOW_NORMAL = -1, + D3DDDI_PAGINGQUEUE_PRIORITY_NORMAL = 0, + D3DDDI_PAGINGQUEUE_PRIORITY_ABOVE_NORMAL = 1, +} D3DDDI_PAGINGQUEUE_PRIORITY; + +typedef struct D3DDDI_MAKERESIDENT_FLAGS +{ + union + { + struct + { + UINT CantTrimFurther : 1; // When set, MakeResidentCb will succeed even if the request puts the application over the current budget. + // MakeResidentCb will still fail if the request puts the application over the maximum budget. + UINT MustSucceed : 1; // When set, instructs MakeResidentCb to put the device in error if the resource cannot be made resident. + UINT Reserved : 30; + }; + UINT Value; + }; +} D3DDDI_MAKERESIDENT_FLAGS; + +typedef struct D3DDDI_MAKERESIDENT +{ + D3DKMT_HANDLE hPagingQueue; // [in] Handle to the paging queue used to synchronize paging operations for this call. + UINT NumAllocations; // [in/out] On input, the number of allocation handles om the AllocationList array. On output, + // the number of allocations successfully made resident. + D3DKMT_PTR(_Field_size_(NumAllocations) + CONST D3DKMT_HANDLE*, AllocationList); // [in] An array of NumAllocations allocation handles + D3DKMT_PTR(CONST UINT*, PriorityList); // [in] Residency priority array for each of the allocations in the resource or allocation list + D3DDDI_MAKERESIDENT_FLAGS Flags; // [in] Residency flags + D3DKMT_ALIGN64 UINT64 PagingFenceValue; // [out] Paging fence value to synchronize on before submitting the command + // that uses above resources to the GPU. This value applies to the monitored fence + // synchronization object associated with hPagingQueue. + D3DKMT_ALIGN64 UINT64 NumBytesToTrim; // [out] When MakeResident fails due to being over budget, this value + // indicates how much to trim in order for the call to succeed on a retry. +} D3DDDI_MAKERESIDENT; + +typedef struct D3DDDI_EVICT_FLAGS +{ + union + { + struct + { + UINT EvictOnlyIfNecessary : 1; + UINT NotWrittenTo : 1; + UINT Reserved : 30; + }; + UINT Value; + }; +} D3DDDI_EVICT_FLAGS; + +typedef struct D3DDDI_TRIMRESIDENCYSET_FLAGS +{ + union + { + struct + { + UINT PeriodicTrim : 1; // When PeriodicTrim flag is set, the driver is required to performed the following operations: + // a) trim all allocations that were not referenced since the previous periodic trim request + // by comparing the allocation last referenced fence with the last periodic trim context fence + // b) Refresh the last periodic trim context fence with the last completed context fence. + UINT RestartPeriodicTrim : 1; // May not be set together with PeriodicTrim flag. + // Reset the last periodic trim context fence to the last completed context fence. + UINT TrimToBudget : 1; // Indicates that the application usage is over the memory budget, + // and NumBytesToTrim bytes should be trimmed to fit in the new memory budget. + UINT Reserved : 29; + }; + UINT Value; + }; +} D3DDDI_TRIMRESIDENCYSET_FLAGS; + +typedef struct _D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE +{ + union + { + struct + { + UINT64 Write : 1; + UINT64 Execute : 1; + UINT64 Zero : 1; + UINT64 NoAccess : 1; + UINT64 SystemUseOnly : 1; // Should not be set by the UMD + UINT64 Reserved : 59; + }; + D3DKMT_ALIGN64 UINT64 Value; + }; +} D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE; + +typedef enum _D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION_TYPE +{ + D3DDDI_UPDATEGPUVIRTUALADDRESS_MAP = 0, + D3DDDI_UPDATEGPUVIRTUALADDRESS_UNMAP = 1, + D3DDDI_UPDATEGPUVIRTUALADDRESS_COPY = 2, + D3DDDI_UPDATEGPUVIRTUALADDRESS_MAP_PROTECT = 3, +} D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION_TYPE; + +typedef struct _D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION +{ + D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION_TYPE OperationType; + union + { + struct + { + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; + D3DKMT_ALIGN64 D3DGPU_SIZE_T SizeInBytes; + D3DKMT_HANDLE hAllocation; + D3DKMT_ALIGN64 D3DGPU_SIZE_T AllocationOffsetInBytes; + D3DKMT_ALIGN64 D3DGPU_SIZE_T AllocationSizeInBytes; + } Map; + struct + { + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; + D3DKMT_ALIGN64 D3DGPU_SIZE_T SizeInBytes; + D3DKMT_HANDLE hAllocation; + D3DKMT_ALIGN64 D3DGPU_SIZE_T AllocationOffsetInBytes; + D3DKMT_ALIGN64 D3DGPU_SIZE_T AllocationSizeInBytes; + D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE Protection; + D3DKMT_ALIGN64 UINT64 DriverProtection; + } MapProtect; + struct + { + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; + D3DKMT_ALIGN64 D3DGPU_SIZE_T SizeInBytes; + D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE Protection; + } Unmap; // Used for UNMAP_NOACCESS as well + struct + { + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS SourceAddress; + D3DKMT_ALIGN64 D3DGPU_SIZE_T SizeInBytes; + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS DestAddress; + } Copy; + }; +} D3DDDI_UPDATEGPUVIRTUALADDRESS_OPERATION; + +typedef enum _D3DDDIGPUVIRTUALADDRESS_RESERVATION_TYPE +{ + D3DDDIGPUVIRTUALADDRESS_RESERVE_NO_ACCESS = 0, + D3DDDIGPUVIRTUALADDRESS_RESERVE_ZERO = 1, + D3DDDIGPUVIRTUALADDRESS_RESERVE_NO_COMMIT = 2 // Reserved for system use +} D3DDDIGPUVIRTUALADDRESS_RESERVATION_TYPE; + +typedef struct D3DDDI_MAPGPUVIRTUALADDRESS +{ + D3DKMT_HANDLE hPagingQueue; // in: Paging queue to synchronize the operation on. + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; // in_opt: Base virtual address to map + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS MinimumAddress; // in_opt: Minimum virtual address + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS MaximumAddress; // in_opt: Maximum virtual address + D3DKMT_HANDLE hAllocation; // in: Allocation handle to map + D3DKMT_ALIGN64 D3DGPU_SIZE_T OffsetInPages; // in: Offset in 4 KB pages from the start of the allocation + D3DKMT_ALIGN64 D3DGPU_SIZE_T SizeInPages; // in: Size in 4 KB pages to map + D3DDDIGPUVIRTUALADDRESS_PROTECTION_TYPE Protection; // in: Virtual address protection + D3DKMT_ALIGN64 UINT64 DriverProtection; // in: Driver specific protection + UINT Reserved0; // in: + D3DKMT_ALIGN64 UINT64 Reserved1; // in: + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS VirtualAddress; // out: Virtual address + D3DKMT_ALIGN64 UINT64 PagingFenceValue; // out: Paging fence Id for synchronization +} D3DDDI_MAPGPUVIRTUALADDRESS; + +typedef struct D3DDDI_RESERVEGPUVIRTUALADDRESS +{ + union + { + D3DKMT_HANDLE hPagingQueue; // in: Paging queue to synchronize the operation on. + D3DKMT_HANDLE hAdapter; // in: DXG adapter handle. (M2) + }; + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS BaseAddress; // in_opt: Base virtual address to map + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS MinimumAddress; // in_opt: Minimum virtual address + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS MaximumAddress; // in_opt: Maximum virtual address + D3DKMT_ALIGN64 D3DGPU_SIZE_T Size; // in: Size to reserve in bytes + union + { + D3DDDIGPUVIRTUALADDRESS_RESERVATION_TYPE ReservationType; // in: Reservation type + UINT Reserved0; // M2 + }; + union + { + D3DKMT_ALIGN64 UINT64 DriverProtection;// in: Driver specific protection + D3DKMT_ALIGN64 UINT64 Reserved1; // M2 + }; + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS VirtualAddress; // out: Virtual address + union + { + D3DKMT_ALIGN64 UINT64 PagingFenceValue;// out: Paging fence Id for synchronization + D3DKMT_ALIGN64 UINT64 Reserved2; // M2 + }; +} D3DDDI_RESERVEGPUVIRTUALADDRESS; + +typedef struct _D3DDDI_GETRESOURCEPRESENTPRIVATEDRIVERDATA +{ + D3DKMT_HANDLE hResource; + UINT PrivateDriverDataSize; + D3DKMT_PTR(PVOID, pPrivateDriverData); +} D3DDDI_GETRESOURCEPRESENTPRIVATEDRIVERDATA; + +typedef struct D3DDDI_DESTROYPAGINGQUEUE +{ + D3DKMT_HANDLE hPagingQueue; // in: handle to the paging queue to destroy +} D3DDDI_DESTROYPAGINGQUEUE; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_1_1)) + +typedef struct D3DDDI_UPDATEALLOCPROPERTY_FLAGS +{ + union + { + struct + { + UINT AccessedPhysically : 1; // The new value for AccessedPhysically on an allocation + UINT Unmoveable : 1; // Indicates an allocation cannot be moved while pinned in a memory segment + UINT Reserved : 30; + }; + UINT Value; + }; +} D3DDDI_UPDATEALLOCPROPERTY_FLAGS; + +typedef struct D3DDDI_UPDATEALLOCPROPERTY +{ + D3DKMT_HANDLE hPagingQueue; // [in] Handle to the paging queue used to synchronize paging operations for this call. + D3DKMT_HANDLE hAllocation; // [in] Handle to the allocation to be updated. + UINT SupportedSegmentSet; // [in] New supported segment set, ignored if the same. + D3DDDI_SEGMENTPREFERENCE PreferredSegment; // [in] New preferred segment set, ignored if the same. + D3DDDI_UPDATEALLOCPROPERTY_FLAGS Flags; // [in] Flags to set on the allocation, ignored if the same. + D3DKMT_ALIGN64 UINT64 PagingFenceValue; // [out] Paging fence value to synchronize on before using the above allocation. + // This value applies to the monitored fence synchronization + // object associated with hPagingQueue. + union + { + struct + { + UINT SetAccessedPhysically : 1; // [in] When set to 1, will set AccessedPhysically to new value + UINT SetSupportedSegmentSet : 1; // [in] When set to 1, will set SupportedSegmentSet to new value + UINT SetPreferredSegment : 1; // [in] When set to 1, will set PreferredSegment to new value + UINT SetUnmoveable : 1; // [in] When set to 1, will set Unmoveable to new value + UINT Reserved : 28; + }; + UINT PropertyMaskValue; + }; +} D3DDDI_UPDATEALLOCPROPERTY; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1) + +#if(D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_1_1) + +typedef struct D3DDDI_OFFER_FLAGS +{ + union + { + struct + { + UINT AllowDecommit : 1; + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DDDI_OFFER_FLAGS; + +#endif // (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_1_1) + +#if(DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_1 || \ + D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_1) + +typedef enum _D3DDDI_RECLAIM_RESULT +{ + D3DDDI_RECLAIM_RESULT_OK = 0, + D3DDDI_RECLAIM_RESULT_DISCARDED = 1, + D3DDDI_RECLAIM_RESULT_NOT_COMMITTED = 2, +} D3DDDI_RECLAIM_RESULT; + +#endif + +typedef struct _D3DDDI_SYNCHRONIZATIONOBJECTINFO +{ + D3DDDI_SYNCHRONIZATIONOBJECT_TYPE Type; // in: Type of synchronization object to create. + union + { + struct + { + BOOL InitialState; // in: Initial state of a synchronization mutex. + } SynchronizationMutex; + + struct + { + UINT MaxCount; // in: Max count of the semaphore. + UINT InitialCount; // in: Initial count of the semaphore. + } Semaphore; + + + struct + { + UINT Reserved[16]; // Reserved for future use. + } Reserved; + }; +} D3DDDI_SYNCHRONIZATIONOBJECTINFO; + +#ifndef D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS_EXT +#define D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS_EXT +#define D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS_RESERVED0 Reserved0 +#endif + +typedef struct _D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS +{ + union + { + struct + { + UINT Shared : 1; + UINT NtSecuritySharing : 1; +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM1_3)) // M1 + + UINT CrossAdapter : 1; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + + // When set, the sync object is signaled as soon as the contents of command buffers preceding it + // is entirely copied to the GPU pipeline, but not necessarily completed execution. + // This flag can be set in order to start reusing command buffers as soon as possible. + UINT TopOfPipeline : 1; + + // When set, the device this sync object is created or opened on + // can only submit wait commands for it. + UINT NoSignal : 1; + + // When set, the device this sync object is created or opened on + // can only submit signal commands for it. This flag cannot be set + // simultaneously with NoSignal. + UINT NoWait : 1; + + // When set, instructs the GPU scheduler to bypass signaling of the monitored fence + // to the maximum value when the device is affected by the GPU reset. + UINT NoSignalMaxValueOnTdr : 1; + + // When set, the fence will not be mapped into the GPU virtual address space. + // Only packet-based signal/wait operations are supported + // When this is set, the fence is always stored as a 64-bit value (regardless of adapter caps) + UINT NoGPUAccess : 1; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + // When set, the fence can be signaled by KMD. + // The flag can be used only with D3DDDI_CPU_NOTIFICATION objects. + UINT SignalByKmd : 1; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + UINT Unused : 1; + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + // When set, the waiters for a shared sync object on CPU will be unblocked + // only when the shared sync object is finally destroyed. By default, CPU + // waiters are unblocked when a local sync object is destroyed, but the main + // shared sync object is still opened by another local sync object. + UINT UnwaitCpuWaitersOnlyOnDestroy : 1; + UINT Reserved : 20; +#else + UINT Reserved : 21; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + +#else + + UINT Reserved : 22; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) + +#else + UINT Reserved : 23; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_0) + +#else + UINT Reserved : 28; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#else + UINT Reserved : 29; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + UINT D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS_RESERVED0 : 1; + }; + UINT Value; + }; +} D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS; + +typedef struct _D3DDDI_SYNCHRONIZATIONOBJECTINFO2 +{ + D3DDDI_SYNCHRONIZATIONOBJECT_TYPE Type; // in: Type of synchronization object to create. + D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS Flags; // in: flags. + union + { + struct + { + BOOL InitialState; // in: Initial state of a synchronization mutex. + } SynchronizationMutex; + + struct + { + UINT MaxCount; // in: Max count of the semaphore. + UINT InitialCount; // in: Initial count of the semaphore. + } Semaphore; + + struct + { + D3DKMT_ALIGN64 UINT64 FenceValue; // in: inital fence value. + } Fence; + + struct + { + D3DKMT_PTR(HANDLE, Event); // in: Handle to the event + } CPUNotification; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + struct + { + D3DKMT_ALIGN64 UINT64 InitialFenceValue; // in: inital fence value. + D3DKMT_PTR(VOID*, FenceValueCPUVirtualAddress); // out: Read-only mapping of the fence value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS FenceValueGPUVirtualAddress; // out: Read/write mapping of the fence value for the GPU + UINT EngineAffinity; // in: Defines physical adapters where the GPU VA will be mapped + UINT Padding; + } MonitoredFence; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_2)) + struct + { + D3DKMT_HANDLE hAdapter; // in: A handle to the adapter associated with VidPnTargetId + D3DDDI_VIDEO_PRESENT_TARGET_ID VidPnTargetId; // in: The output that the compositor wishes to receive notifications for + D3DKMT_ALIGN64 UINT64 Time; // in: Represents an offset before the VSync. + // The Time value may not be longer than a VSync interval. In units of 100ns. + D3DKMT_PTR(VOID*, FenceValueCPUVirtualAddress); // out: Read-only mapping of the fence value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS FenceValueGPUVirtualAddress; // out: Read-only mapping of the fence value for the GPU + UINT EngineAffinity; // in: Defines physical adapters where the GPU VA will be mapped + UINT Padding; + } PeriodicMonitoredFence; +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_2) + + + struct + { + D3DKMT_ALIGN64 UINT64 Reserved[8]; // Reserved for future use. + } Reserved; + }; + + D3DKMT_HANDLE SharedHandle; // out: global shared handle (when requested to be shared) + +} D3DDDI_SYNCHRONIZATIONOBJECTINFO2; + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_1) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM3_1)) + +#define D3DDDI_NATIVE_FENCE_PDD_SIZE 64 + +typedef enum _D3DDDI_NATIVEFENCE_TYPE +{ + D3DDDI_NATIVEFENCE_TYPE_DEFAULT = 0, // Full CPU and GPU interoperability. + D3DDDI_NATIVEFENCE_TYPE_INTRA_GPU = 1, // Special fence type for engine-engine synchronization, which + // does not support any CPU access or CPU wait/signal operations +} D3DDDI_NATIVEFENCE_TYPE; + +typedef struct _D3DDDI_NATIVEFENCEMAPPING +{ + D3DKMT_PTR(VOID*, CurrentValueCpuVa); // Read-only mapping of the current value for the CPU + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS CurrentValueGpuVa; // Read/write mapping of the current value for the GPU in the current process address space + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS MonitoredValueGpuVa; // Read/write mapping of the monitored value for the GPU in the current process address space + D3DKMT_ALIGN64 BYTE Reserved[32]; +} D3DDDI_NATIVEFENCEMAPPING; + +typedef struct _D3DDDI_NATIVEFENCEINFO +{ + D3DKMT_ALIGN64 UINT64 InitialFenceValue; // in: initial fence value. + UINT EngineAffinity; // in: Defines physical adapters where the GPU VA is mapped + D3DDDI_NATIVEFENCE_TYPE Type; // in: Type of the fence + D3DDDI_SYNCHRONIZATIONOBJECT_FLAGS Flags; // in: Flags. + D3DDDI_NATIVEFENCEMAPPING NativeFenceMapping; // out: process mapping information for the native fence + D3DKMT_ALIGN64 BYTE Reserved[28]; +} D3DDDI_NATIVEFENCEINFO; + +typedef enum _DXGK_NATIVE_FENCE_LOG_TYPE +{ + DXGK_NATIVE_FENCE_LOG_TYPE_WAITS = 1, + DXGK_NATIVE_FENCE_LOG_TYPE_SIGNALS = 2 +} DXGK_NATIVE_FENCE_LOG_TYPE; + +typedef struct _DXGK_NATIVE_FENCE_LOG_HEADER +{ + union + { + struct + { + UINT32 FirstFreeEntryIndex; // same as LowPart of AtomicWraparoundAndEntryIndex + UINT32 WraparoundCount; // same as HighPart of AtomicWraparoundAndEntryIndex + }; + + ULARGE_INTEGER AtomicWraparoundAndEntryIndex; + }; + + DXGK_NATIVE_FENCE_LOG_TYPE Type; + UINT64 NumberOfEntries; + UINT64 Reserved[2]; +}DXGK_NATIVE_FENCE_LOG_HEADER; + +typedef enum _DXGK_NATIVE_FENCE_LOG_OPERATION +{ + DXGK_NATIVE_FENCE_LOG_OPERATION_SIGNAL_EXECUTED = 0, + DXGK_NATIVE_FENCE_LOG_OPERATION_WAIT_UNBLOCKED = 1 +}DXGK_NATIVE_FENCE_LOG_OPERATION; + +typedef struct _DXGK_NATIVE_FENCE_LOG_ENTRY +{ + UINT64 FenceValue; // UMD payload: Newly signaled/unblocked fence value + D3DKMT_HANDLE hNativeFence; // UMD payload: user mode D3DKMT_HANDLE of native fence to which this operation belongs + UINT OperationType; // UMD payload: DXGK_FENCE_LOG_OPERATION type + UINT64 Reserved0; // Reserved for alignment + UINT64 FenceObservedGpuTimestamp; // GPU Payload: OPERATION_WAIT_UNBLOCKED only: GPU Time at which an unresolved wait command was seen by engine and stalled the HWQueue + UINT64 Reserved1; // Reserved for alignment + UINT64 FenceEndGpuTimestamp; // GPU Payload: GPU Time at which the fence operation completed on GPU +}DXGK_NATIVE_FENCE_LOG_ENTRY; + +typedef struct _DXGK_NATIVE_FENCE_LOG_BUFFER +{ + DXGK_NATIVE_FENCE_LOG_HEADER Header; + + _Field_size_(Header.NumberOfEntries) + DXGK_NATIVE_FENCE_LOG_ENTRY Entries[1]; +}DXGK_NATIVE_FENCE_LOG_BUFFER; + +#define D3DDDI_DOORBELL_PRIVATEDATA_MAX_BYTES_WDDM3_1 16 + +typedef enum _D3DDDI_DOORBELLSTATUS +{ + D3DDDI_DOORBELLSTATUS_CONNECTED = 0, + D3DDDI_DOORBELLSTATUS_CONNECTED_NOTIFY_KMD = 1, + D3DDDI_DOORBELLSTATUS_DISCONNECTED_RETRY = 2, + D3DDDI_DOORBELLSTATUS_DISCONNECTED_ABORT = 3, +}D3DDDI_DOORBELLSTATUS; + +#endif // >= 3_1 + +#if ((DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) || \ + (D3D_UMD_INTERFACE_VERSION >= D3D_UMD_INTERFACE_VERSION_WDDM2_0)) + +typedef struct _D3DDDI_WAITFORSYNCHRONIZATIONOBJECTFROMCPU_FLAGS +{ + union + { + struct + { + UINT WaitAny : 1; // when waiting for multiple objects, signal the wait event if any + // of the wait array conditions is satisfied as opposed to all conditions. + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DDDI_WAITFORSYNCHRONIZATIONOBJECTFROMCPU_FLAGS; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_0) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +typedef struct _D3DDDI_QUERYREGISTRY_FLAGS +{ + union + { + struct + { + UINT TranslatePath : 1; + UINT MutableValue : 1; + UINT Reserved : 30; + }; + UINT Value; + }; +} D3DDDI_QUERYREGISTRY_FLAGS; + +typedef enum _D3DDDI_QUERYREGISTRY_TYPE +{ + D3DDDI_QUERYREGISTRY_SERVICEKEY = 0, + D3DDDI_QUERYREGISTRY_ADAPTERKEY = 1, + D3DDDI_QUERYREGISTRY_DRIVERSTOREPATH = 2, + D3DDDI_QUERYREGISTRY_DRIVERIMAGEPATH = 3, + D3DDDI_QUERYREGISTRY_MAX, +} D3DDDI_QUERYREGISTRY_TYPE; + +typedef enum _D3DDDI_QUERYREGISTRY_STATUS +{ + D3DDDI_QUERYREGISTRY_STATUS_SUCCESS = 0, + D3DDDI_QUERYREGISTRY_STATUS_BUFFER_OVERFLOW = 1, + D3DDDI_QUERYREGISTRY_STATUS_FAIL = 2, + D3DDDI_QUERYREGISTRY_STATUS_MAX, +} D3DDDI_QUERYREGISTRY_STATUS; + +// +// Output data value follows this structure. +// PrivateDriverSize must be sizeof(D3DDDI_QUERYREGISTRY_INFO) + (size of the the key value in bytes) +// +typedef struct _D3DDDI_QUERYREGISTRY_INFO +{ + D3DDDI_QUERYREGISTRY_TYPE QueryType; // In + D3DDDI_QUERYREGISTRY_FLAGS QueryFlags; // In + WCHAR ValueName[MAX_PATH]; // In + ULONG ValueType; // In + ULONG PhysicalAdapterIndex; // In + ULONG OutputValueSize; // Out. Number of bytes written to the output value or required in case of D3DDDI_QUERYREGISTRY_STATUS_BUFFER_OVERFLOW. + D3DDDI_QUERYREGISTRY_STATUS Status; // Out + union { + DWORD OutputDword; // Out + D3DKMT_ALIGN64 UINT64 OutputQword; // Out + WCHAR OutputString[1]; // Out. Dynamic array + BYTE OutputBinary[1]; // Out. Dynamic array + }; + } D3DDDI_QUERYREGISTRY_INFO; + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_4) + +// +// Defines the maximum number of context a particular command buffer can +// be broadcast to. +// +#define D3DDDI_MAX_BROADCAST_CONTEXT 64 + +// +// Allocation priorities. +// +#define D3DDDI_ALLOCATIONPRIORITY_MINIMUM 0x28000000 +#define D3DDDI_ALLOCATIONPRIORITY_LOW 0x50000000 +#define D3DDDI_ALLOCATIONPRIORITY_NORMAL 0x78000000 +#define D3DDDI_ALLOCATIONPRIORITY_HIGH 0xa0000000 +#define D3DDDI_ALLOCATIONPRIORITY_MAXIMUM 0xc8000000 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +// Cross adapter resource pitch alignment in bytes. +// Must be power of 2. +// +#define D3DKMT_CROSS_ADAPTER_RESOURCE_PITCH_ALIGNMENT 128 + +// Cross adapter resource height alignment in rows. +// +#define D3DKMT_CROSS_ADAPTER_RESOURCE_HEIGHT_ALIGNMENT 4 + +#endif // (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM1_3) + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM2_6) + +typedef enum _DXGK_FEATURE_CATEGORY +{ + DXGK_FEATURE_CATEGORY_DRIVER = 0, + DXGK_FEATURE_CATEGORY_OS = 1, + DXGK_FEATURE_CATEGORY_BUGFIX = 2, + DXGK_FEATURE_CATEGORY_TEST = 3, + DXGK_FEATURE_CATEGORY_RESERVED4 = 4, + DXGK_FEATURE_CATEGORY_RESERVED5 = 5, + DXGK_FEATURE_CATEGORY_RESERVED6 = 6, + DXGK_FEATURE_CATEGORY_RESERVED7 = 7, + DXGK_FEATURE_CATEGORY_RESERVED8 = 8, + DXGK_FEATURE_CATEGORY_RESERVED9 = 9, + DXGK_FEATURE_CATEGORY_RESERVED10 = 10, + DXGK_FEATURE_CATEGORY_RESERVED11 = 11, + DXGK_FEATURE_CATEGORY_RESERVED12 = 12, + DXGK_FEATURE_CATEGORY_RESERVED13 = 13, + DXGK_FEATURE_CATEGORY_RESERVED14 = 14, + DXGK_FEATURE_CATEGORY_RESERVED15 = 15, + DXGK_FEATURE_CATEGORY_MAX = 16 +} DXGK_FEATURE_CATEGORY; + +#define DXGK_FEATURE_ID_CATEGORY_BITS 4 +#define DXGK_FEATURE_ID_FEATURE_BITS (32 - DXGK_FEATURE_ID_CATEGORY_BITS) +#define DXGK_FEATURE_ID_CATEGORY_SHIFT (32 - DXGK_FEATURE_ID_CATEGORY_BITS) +#define DXGK_FEATURE_ID_MASK ((1 << DXGK_FEATURE_ID_CATEGORY_SHIFT) - 1) + +#define DXGK_DEFINE_FEATURE_ID(Category, IdValue) \ + (((Category) << DXGK_FEATURE_ID_CATEGORY_SHIFT) | (IdValue)) + +typedef enum _DXGK_DRIVER_FEATURE +{ + DXGK_DRIVER_FEATURE_HWSCH = 0, // Hardware accelerated GPU scheduling + DXGK_DRIVER_FEATURE_HWFLIPQUEUE = 1, // Hardware flip queue + DXGK_DRIVER_FEATURE_LDA_GPUPV = 2, // Support for LDA in GPU-PV + DXGK_DRIVER_FEATURE_KMD_SIGNAL_CPU_EVENT = 3, // Support for signaling CPU event by KMD + DXGK_DRIVER_FEATURE_USER_MODE_SUBMISSION = 4, + DXGK_DRIVER_FEATURE_SHARE_BACKING_STORE_WITH_KMD = 5, + DXGK_DRIVER_FEATURE_RESERVED_1 = 6, + DXGK_DRIVER_FEATURE_RESERVED_2 = 7, + DXGK_DRIVER_FEATURE_RESERVED_3 = 8, + DXGK_DRIVER_FEATURE_RESERVED_4 = 9, + DXGK_DRIVER_FEATURE_RESERVED_5 = 10, + DXGK_DRIVER_FEATURE_RESERVED_6 = 11, + DXGK_DRIVER_FEATURE_RESERVED_7 = 12, + DXGK_DRIVER_FEATURE_RESERVED_8 = 13, + DXGK_DRIVER_FEATURE_RESERVED_9 = 14, + DXGK_DRIVER_FEATURE_RESERVED_10 = 15, + DXGK_DRIVER_FEATURE_RESERVED_11 = 16, + DXGK_DRIVER_FEATURE_RESERVED_12 = 17, + DXGK_DRIVER_FEATURE_RESERVED_13 = 18, + DXGK_DRIVER_FEATURE_RESERVED_14 = 19, + DXGK_DRIVER_FEATURE_RESERVED_15 = 20, + DXGK_DRIVER_FEATURE_RESERVED_16 = 21, + DXGK_DRIVER_FEATURE_RESERVED_17 = 22, + DXGK_DRIVER_FEATURE_RESERVED_18 = 23, + DXGK_DRIVER_FEATURE_RESERVED_19 = 24, + DXGK_DRIVER_FEATURE_RESERVED_20 = 25, + DXGK_DRIVER_FEATURE_RESERVED_21 = 26, + DXGK_DRIVER_FEATURE_RESERVED_22 = 27, + DXGK_DRIVER_FEATURE_RESERVED_23 = 28, + DXGK_DRIVER_FEATURE_RESERVED_24 = 29, + DXGK_DRIVER_FEATURE_RESERVED_25 = 30, + DXGK_DRIVER_FEATURE_SAMPLE = 31, + DXGK_DRIVER_FEATURE_PAGE_BASED_MEMORY_MANAGER = 32, + DXGK_DRIVER_FEATURE_KERNEL_MODE_TESTING = 33, + DXGK_DRIVER_FEATURE_64K_PT_DEMOTION_FIX = 34, + DXGK_DRIVER_FEATURE_GPUPV_PRESENT_HWQUEUE = 35, + DXGK_DRIVER_FEATURE_GPUVAIOMMU = 36, + DXGK_DRIVER_FEATURE_NATIVE_FENCE = 37, + DXGK_DRIVER_FEATURE_EXTENDED_SEGMENT_FLAGS = 38, + DXGK_DRIVER_FEATURE_FAULT_AND_STALL = 39, + DXGK_DRIVER_FEATURE_SINGLE_ADAPTER_HYBRID_MODE = 40, + DXGK_DRIVER_FEATURE_SYNC_PRESENT_RENDER_HWQ_ONLY = 41, // Feature to avoid synchronizing present with other render queue + //DXGK_DRIVER_FEATURE_UNIFIED_SCHEDULING_MODEL = 42, + //DXGK_DRIVER_FEATURE_NOTIFY_RESIDENCY2 = 43, + //DXGK_DRIVER_FEATURE_P2P_FENCE_SIGNAL = 44, + //DXGK_DRIVER_FEATURE_PROCESS_DEBUG_BLOB_COLLECTION = 45, + DXGK_DRIVER_FEATURE_PANEL_BUFFER_CONTROL = 46, + + DXGK_DRIVER_FEATURE_MAX + +} DXGK_DRIVER_FEATURE; + +typedef enum _DXGK_OS_FEATURE +{ + DXGK_OS_FEATURE_QUERYSTATISTICS_EXTENSIONS = 0, + DXGK_OS_FEATURE_RESERVE_GPUVA_ZERO_BASE_ADDRESS = 1, + DXGK_OS_FEATURE_PER_PTE_PAGE_SIZE = 2, + DXGK_OS_FEATURE_FENCE_SIGNAL_FROM_SWS_NODE = 3, + DXGK_OS_FEATURE_SUPPRESSVSYNC_INTERRUPTS = 4, + DXGK_OS_FEATURE_FEATURE_INTERFACE_EXTENSIONS = 5, + DXGK_OS_FEATURE_READONLY_EXISTINGSYSMEM = 6, + + DXGK_OS_FEATURE_MAX + +} DXGK_OS_FEATURE; + + +// +// For each feature in this enumeration, if the driver supports it, +// it must invoke the OS QueryFeatureSupport callback +// to report the level of support (experimental, stable, always on), +// and only enable the feature if the OS returned Enabled=TRUE. +// Drivers that don't support the feature don't have to call the OS to query its status. +// +typedef enum _DXGK_FEATURE_ID +{ + // + // Driver features + // + DXGK_FEATURE_HWSCH = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_HWSCH), + DXGK_FEATURE_HWFLIPQUEUE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_HWFLIPQUEUE), + DXGK_FEATURE_LDA_GPUPV = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_LDA_GPUPV), + DXGK_FEATURE_KMD_SIGNAL_CPU_EVENT = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_KMD_SIGNAL_CPU_EVENT), + DXGK_FEATURE_USER_MODE_SUBMISSION = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_USER_MODE_SUBMISSION), + DXGK_FEATURE_SHARE_BACKING_STORE_WITH_KMD = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_SHARE_BACKING_STORE_WITH_KMD), + DXGK_FEATURE_SAMPLE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_SAMPLE), + DXGK_FEATURE_PAGE_BASED_MEMORY_MANAGER = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_PAGE_BASED_MEMORY_MANAGER), + DXGK_FEATURE_KERNEL_MODE_TESTING = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_KERNEL_MODE_TESTING), + DXGK_FEATURE_64K_PT_DEMOTION_FIX = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_64K_PT_DEMOTION_FIX), + DXGK_FEATURE_GPUPV_PRESENT_HWQUEUE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_GPUPV_PRESENT_HWQUEUE), + DXGK_FEATURE_GPUVAIOMMU = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_GPUVAIOMMU), + DXGK_FEATURE_NATIVE_FENCE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_NATIVE_FENCE), + DXGK_FEATURE_SYNC_PRESENT_RENDER_HWQ_ONLY = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_SYNC_PRESENT_RENDER_HWQ_ONLY), + //DXGK_FEATURE_UNIFIED_SCHEDULING_MODEL = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_UNIFIED_SCHEDULING_MODEL), + //DXGK_FEATURE_NOTIFY_RESIDENCY2 = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_NOTIFY_RESIDENCY2), + //DXGK_FEATURE_P2P_FENCE_SIGNAL = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_P2P_FENCE_SIGNAL), + //DXGK_FEATURE_PROCESS_DEBUG_BLOB_COLLECTION = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_PROCESS_DEBUG_BLOB_COLLECTION), + DXGK_FEATURE_PANEL_BUFFER_CONTROL = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_DRIVER, DXGK_DRIVER_FEATURE_PANEL_BUFFER_CONTROL), + + // + // OS features + // + DXGK_FEATURE_QUERYSTATISTICS_EXTENSIONS = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_QUERYSTATISTICS_EXTENSIONS), + DXGK_FEATURE_RESERVE_GPUVA_ZERO_BASE_ADDRESS = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_RESERVE_GPUVA_ZERO_BASE_ADDRESS), + DXGK_FEATURE_PER_PTE_PAGE_SIZE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_PER_PTE_PAGE_SIZE), + DXGK_FEATURE_FENCE_SIGNAL_FROM_SWS_NODE = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_FENCE_SIGNAL_FROM_SWS_NODE), + DXGK_FEATURE_SUPPRESSVSYNC_INTERRUPTS = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_SUPPRESSVSYNC_INTERRUPTS), + DXGK_FEATURE_FEATURE_INTERFACE_EXTENSIONS = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_FEATURE_INTERFACE_EXTENSIONS), + DXGK_FEATURE_READONLY_EXISTINGSYSMEM = DXGK_DEFINE_FEATURE_ID(DXGK_FEATURE_CATEGORY_OS, DXGK_OS_FEATURE_READONLY_EXISTINGSYSMEM), + +} DXGK_FEATURE_ID; + + +#define DXGK_FEATURE_MAX DXGK_DRIVER_FEATURE_MAX + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM2_6 + +#if (DXGKDDI_INTERFACE_VERSION >= DXGKDDI_INTERFACE_VERSION_WDDM3_2) + +typedef UINT16 DXGK_FEATURE_VERSION; + +typedef struct _DXGK_ISFEATUREENABLED_RESULT +{ + UINT16 Version; + union + { + struct + { + UINT16 Enabled : 1; + UINT16 KnownFeature : 1; + UINT16 SupportedByDriver : 1; + UINT16 SupportedOnCurrentConfig : 1; + UINT16 Reserved : 12; + }; + DXGK_FEATURE_VERSION Value; + }; +} DXGK_ISFEATUREENABLED_RESULT; + +typedef enum _D3DDDI_TESTCOMMANDBUFFEROP +{ + D3DDDI_TESTCOMMANDBUFFEROP_INVALID = 0, + D3DDDI_TESTCOMMANDBUFFEROP_COPY = 1, + D3DDDI_TESTCOMMANDBUFFEROP_FILL = 2, + D3DDDI_TESTCOMMANDBUFFEROP_INFINITE_LOOP = 3, + D3DDDI_TESTCOMMANDBUFFEROP_INFINITE_PREEMPTABLE_LOOP = 4, + D3DDDI_TESTCOMMANDBUFFEROP_MAX, +} D3DDDI_TESTCOMMANDBUFFEROP; + +typedef struct _D3DDDI_TESTCOMMANDBUFFER_COPY +{ + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS SrcAddress; + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS DstAddress; + UINT NumBytes; // Multiple of 4 bytes +} D3DDDI_TESTCOMMANDBUFFER_COPY; + +typedef struct _D3DDDI_TESTCOMMANDBUFFER_FILL +{ + D3DKMT_ALIGN64 D3DGPU_VIRTUAL_ADDRESS DstAddress; + UINT NumBytes; // Multiple of 4 bytes + UINT Pattern; +} D3DDDI_TESTCOMMANDBUFFER_FILL; + +typedef struct _D3DDDI_TESTCOMMANDBUFFER +{ + union + { + D3DDDI_TESTCOMMANDBUFFER_COPY Copy; + D3DDDI_TESTCOMMANDBUFFER_FILL Fill; + char Reserved[64]; // Reserved for future extensions + }; + D3DDDI_TESTCOMMANDBUFFEROP Operation; + UINT Reserved1; +} D3DDDI_TESTCOMMANDBUFFER; +#if defined(__cplusplus) && !defined(SORTPP_PASS) +static_assert(sizeof(D3DDDI_TESTCOMMANDBUFFER) == 72, "D3DDDI_TESTCOMMANDBUFFER must be 72 bytes"); +#endif + +typedef struct _D3DDDI_BUILDTESTCOMMANDBUFFERFLAGS +{ + union + { + struct + { + UINT HardwareQueue : 1; + UINT Reserved : 31; + }; + UINT Value; + }; +} D3DDDI_BUILDTESTCOMMANDBUFFERFLAGS; + +#define D3DDDI_MAXTESTBUFFERSIZE 4096 +#define D3DDDI_MAXTESTBUFFERPRIVATEDRIVERDATASIZE 1024 + +typedef struct _D3DDDI_DRIVERESCAPE_BUILDTESTCOMMANDBUFFER +{ + D3DDDI_DRIVERESCAPETYPE EscapeType; + D3DKMT_HANDLE hDevice; + D3DKMT_HANDLE hContext; + D3DDDI_BUILDTESTCOMMANDBUFFERFLAGS Flags; + D3DDDI_TESTCOMMANDBUFFER Command; + D3DKMT_PTR(_Field_size_bytes_(DmaBufferSize) + PVOID, pDmaBuffer); + D3DKMT_PTR(_Field_size_bytes_(DmaBufferPrivateDataSize) + PVOID, pDmaBufferPrivateData); + UINT DmaBufferSize; + UINT DmaBufferPrivateDataSize; +} D3DDDI_DRIVERESCAPE_BUILDTESTCOMMANDBUFFER; + +#endif // DXGKDDI_INTERFACE_VERSION_WDDM3_2 + +#endif // (NTDDI_VERSION >= NTDDI_LONGHORN) || defined(D3DKMDT_SPECIAL_MULTIPLATFORM_TOOL) + +#pragma warning(pop) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _D3DUKMDT_H_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dciddi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dciddi.h new file mode 100644 index 0000000000000000000000000000000000000000..cd28bd6ac0c81731a7fba20fd986a40cc0c2570a --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dciddi.h @@ -0,0 +1,296 @@ +/******************************************************************* + * + * FILE: dciddi.h + * + * DESCRIPTION: definitions for MS/Intel-defined DCI interface + * + * Copyright (C) 1994-1999 Intel/Microsoft Corporation. All Rights Reserved. + * + *******************************************************************/ + +#ifndef _INC_DCIDDI +#define _INC_DCIDDI + +#if _MSC_VER > 1000 +#pragma once +#endif + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/* DCI Command Escapes */ +#define DCICOMMAND 3075 +#define DCI_VERSION 0x0100 + +#define DCICREATEPRIMARYSURFACE 1 +#define DCICREATEOFFSCREENSURFACE 2 +#define DCICREATEOVERLAYSURFACE 3 +#define DCIENUMSURFACE 4 +#define DCIESCAPE 5 + +/* DCI-Defined error codes */ +#define DCI_OK 0 /* success */ + +/* Hard errors -- DCI will be unavailable */ +#define DCI_FAIL_GENERIC -1 +#define DCI_FAIL_UNSUPPORTEDVERSION -2 +#define DCI_FAIL_INVALIDSURFACE -3 +#define DCI_FAIL_UNSUPPORTED -4 + +/* Soft errors -- DCI may be available later */ +#define DCI_ERR_CURRENTLYNOTAVAIL -5 +#define DCI_ERR_INVALIDRECT -6 +#define DCI_ERR_UNSUPPORTEDFORMAT -7 +#define DCI_ERR_UNSUPPORTEDMASK -8 +#define DCI_ERR_TOOBIGHEIGHT -9 +#define DCI_ERR_TOOBIGWIDTH -10 +#define DCI_ERR_TOOBIGSIZE -11 +#define DCI_ERR_OUTOFMEMORY -12 +#define DCI_ERR_INVALIDPOSITION -13 +#define DCI_ERR_INVALIDSTRETCH -14 +#define DCI_ERR_INVALIDCLIPLIST -15 +#define DCI_ERR_SURFACEISOBSCURED -16 +#define DCI_ERR_XALIGN -17 +#define DCI_ERR_YALIGN -18 +#define DCI_ERR_XYALIGN -19 +#define DCI_ERR_WIDTHALIGN -20 +#define DCI_ERR_HEIGHTALIGN -21 + +/* success messages -- DCI call succeeded, but specified item changed */ +#define DCI_STATUS_POINTERCHANGED 1 +#define DCI_STATUS_STRIDECHANGED 2 +#define DCI_STATUS_FORMATCHANGED 4 +#define DCI_STATUS_SURFACEINFOCHANGED 8 +#define DCI_STATUS_CHROMAKEYCHANGED 16 +#define DCI_STATUS_WASSTILLDRAWING 32 + +#define DCI_SUCCESS(error) (((DCIRVAL)error) >= 0) + +/* DCI Capability Flags */ +#define DCI_SURFACE_TYPE 0x0000000F +#define DCI_PRIMARY 0x00000000 +#define DCI_OFFSCREEN 0x00000001 +#define DCI_OVERLAY 0x00000002 + +#define DCI_VISIBLE 0x00000010 +#define DCI_CHROMAKEY 0x00000020 +#define DCI_1632_ACCESS 0x00000040 +#define DCI_DWORDSIZE 0x00000080 +#define DCI_DWORDALIGN 0x00000100 +#define DCI_WRITEONLY 0x00000200 +#define DCI_ASYNC 0x00000400 + +#define DCI_CAN_STRETCHX 0x00001000 +#define DCI_CAN_STRETCHY 0x00002000 +#define DCI_CAN_STRETCHXY (DCI_CAN_STRETCHX | DCI_CAN_STRETCHY) + +#define DCI_CAN_STRETCHXN 0x00004000 +#define DCI_CAN_STRETCHYN 0x00008000 +#define DCI_CAN_STRETCHXYN (DCI_CAN_STRETCHXN | DCI_CAN_STRETCHYN) + + +#define DCI_CANOVERLAY 0x00010000 + +/* + * Win32 RGNDATA structure. This will be used for cliplist info. passing. + */ +#if (WINVER < 0x0400) + +#ifndef RDH_RECTANGLES + +typedef struct tagRECTL +{ + LONG left; + LONG top; + LONG right; + LONG bottom; +} RECTL; +typedef RECTL* PRECTL; +typedef RECTL NEAR* NPRECTL; +typedef RECTL FAR* LPRECTL; +typedef const RECTL FAR* LPCRECTL; + +#define RDH_RECTANGLES 0 + +typedef struct tagRGNDATAHEADER { + DWORD dwSize; /* size of structure */ + DWORD iType; /* Will be RDH_RECTANGLES */ + DWORD nCount; /* # of clipping rectangles */ + DWORD nRgnSize; /* size of buffer -- can be zero */ + RECTL rcBound; /* bounding rectangle for region*/ +} RGNDATAHEADER; +typedef RGNDATAHEADER* PRGNDATAHEADER; +typedef RGNDATAHEADER NEAR* NPRGNDATAHEADER; +typedef RGNDATAHEADER FAR* LPRGNDATAHEADER; +typedef const RGNDATAHEADER FAR* LPCRGNDATAHEADER; + +typedef struct tagRGNDATA { + RGNDATAHEADER rdh; + char Buffer[1]; +} RGNDATA; +typedef RGNDATA* PRGNDATA; +typedef RGNDATA NEAR* NPRGNDATA; +typedef RGNDATA FAR* LPRGNDATA; +typedef const RGNDATA FAR* LPCRGNDATA; + +#endif +#endif + +typedef int DCIRVAL; /* return for callbacks */ + +/************************************************************************** + * input structures + **************************************************************************/ + +/* + * Used by a DCI client to provide input parameters for the + * DCICREATEPRIMARYSURFACE escape. + */ +typedef struct _DCICMD { + DWORD dwCommand; + DWORD dwParam1; + DWORD dwParam2; + DWORD dwVersion; + DWORD dwReserved; +} DCICMD; + +/* + * This structure is used by a DCI client to provide input parameters for + * the DCICREATE... calls. The fields that are actually relevant differ for + * each of the three calls. Details are in the DCI Spec chapter providing + * the function specifications. + */ +typedef struct _DCICREATEINPUT { + DCICMD cmd; /* common header structure */ + DWORD dwCompression; /* format of surface to be created */ + DWORD dwMask[3]; /* for nonstandard RGB (e.g. 5-6-5, RGB32) */ + DWORD dwWidth; /* height of the surface to be created */ + DWORD dwHeight; /* width of input surfaces */ + DWORD dwDCICaps; /* capabilities of surface wanted */ + DWORD dwBitCount; /* bit depth of format to be created */ + LPVOID lpSurface; /* pointer to an associated surface */ +} DCICREATEINPUT, FAR *LPDCICREATEINPUT; + + +/************************************************************************** + * surface info. structures + **************************************************************************/ + +/* + * This structure is used to return information about available support + * during a DCIEnumSurface call. It is also used to create a primary + * surface, and as a member of the larger structures returned by the + * offscreen and overlay calls. + */ + typedef struct _DCISURFACEINFO { + DWORD dwSize; /* size of structure */ + DWORD dwDCICaps; /* capability flags (stretch, etc.) */ + DWORD dwCompression; /* format of surface to be created */ + DWORD dwMask[3]; /* for BI_BITMASK surfaces */ + + DWORD dwWidth; /* width of surface */ + DWORD dwHeight; /* height of surface */ + LONG lStride; /* distance in bytes betw. one pixel */ + /* and the pixel directly below it */ + DWORD dwBitCount; /* Bits per pixel for this dwCompression */ + ULONG_PTR dwOffSurface; /* offset of surface pointer */ + WORD wSelSurface; /* selector of surface pointer */ + WORD wReserved; + + DWORD dwReserved1; /* reserved for provider */ + DWORD dwReserved2; /* reserved for DCIMAN */ + DWORD dwReserved3; /* reserved for future */ + DCIRVAL (CALLBACK *BeginAccess) (LPVOID, LPRECT); /* BeginAccess callback */ + void (CALLBACK *EndAccess) (LPVOID); /* EndAcess callback */ + void (CALLBACK *DestroySurface) (LPVOID); /* Destroy surface callback */ +} DCISURFACEINFO, FAR *LPDCISURFACEINFO; + + +/* + * This structure is used by a DCI client to provide input parameters for the + * DCIEnumSurface call. + */ + +typedef +void +(*ENUM_CALLBACK) ( + LPDCISURFACEINFO lpSurfaceInfo, + LPVOID lpContext + ); + +typedef struct _DCIENUMINPUT { + DCICMD cmd; /* common header structure */ + RECT rSrc; /* source rect. for stretch */ + RECT rDst; /* dest. rect. for stretch */ + void (CALLBACK *EnumCallback)(LPDCISURFACEINFO, LPVOID); /* callback for supported formats */ + LPVOID lpContext; +} DCIENUMINPUT, FAR *LPDCIENUMINPUT; + + +/* + * This structure must be allocated and returned by the DCI provider in + * response to a DCICREATEPRIMARYSURFACE call. + */ + typedef DCISURFACEINFO DCIPRIMARY, FAR *LPDCIPRIMARY; + +/* + * This structure must be allocated and returned by the DCI provider in + * response to a DCICREATEOFFSCREENSURFACE call. + */ + typedef struct _DCIOFFSCREEN { + + DCISURFACEINFO dciInfo; /* surface info */ + DCIRVAL (CALLBACK *Draw) (LPVOID); /* copy to onscreen buffer */ + DCIRVAL (CALLBACK *SetClipList) (LPVOID, LPRGNDATA); /* SetCliplist callback */ + DCIRVAL (CALLBACK *SetDestination) (LPVOID, LPRECT, LPRECT); /* SetDestination callback */ +} DCIOFFSCREEN, FAR *LPDCIOFFSCREEN; + + +/* + * This structure must be allocated and returned by the DCI provider in response + * to a DCICREATEOVERLAYSURFACE call. + */ + typedef struct _DCIOVERLAY{ + + DCISURFACEINFO dciInfo; /* surface info */ + DWORD dwChromakeyValue; /* chromakey color value */ + DWORD dwChromakeyMask; /* specifies valid bits of value */ +} DCIOVERLAY, FAR *LPDCIOVERLAY; + + +/* DCI FOURCC def.s for extended DIB formats */ + +#ifndef YVU9 +#define YVU9 mmioFOURCC('Y','V','U','9') +#endif +#ifndef Y411 +#define Y411 mmioFOURCC('Y','4','1','1') +#endif +#ifndef YUY2 +#define YUY2 mmioFOURCC('Y','U','Y','2') +#endif +#ifndef YVYU +#define YVYU mmioFOURCC('Y','V','Y','U') +#endif +#ifndef UYVY +#define UYVY mmioFOURCC('U','Y','V','Y') +#endif +#ifndef Y211 +#define Y211 mmioFOURCC('Y','2','1','1') +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#endif // _INC_DCIDDI diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dcomptypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dcomptypes.h new file mode 100644 index 0000000000000000000000000000000000000000..6222321bf18282b9dd5af3a95b2b321e97989b6c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dcomptypes.h @@ -0,0 +1,171 @@ + +//--------------------------------------------------------------------------- +// Copyright (c) Microsoft Corporation. All rights reserved. +//--------------------------------------------------------------------------- +#pragma once + +#include // for DXGI_RATIONAL +#include // for DXGI_ALPHA_MODE, DXGI_HDR_METADATA_TYPE +#include + + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + + +// +// DirectComposition types +// + +enum DCOMPOSITION_BITMAP_INTERPOLATION_MODE +{ + DCOMPOSITION_BITMAP_INTERPOLATION_MODE_NEAREST_NEIGHBOR = 0, + DCOMPOSITION_BITMAP_INTERPOLATION_MODE_LINEAR = 1, + + DCOMPOSITION_BITMAP_INTERPOLATION_MODE_INHERIT = 0xffffffff +}; + +enum DCOMPOSITION_BORDER_MODE +{ + DCOMPOSITION_BORDER_MODE_SOFT = 0, + DCOMPOSITION_BORDER_MODE_HARD = 1, + + DCOMPOSITION_BORDER_MODE_INHERIT = 0xffffffff +}; + +enum DCOMPOSITION_COMPOSITE_MODE +{ + DCOMPOSITION_COMPOSITE_MODE_SOURCE_OVER = 0, + DCOMPOSITION_COMPOSITE_MODE_DESTINATION_INVERT = 1, +#if (_WIN32_WINNT >= _WIN32_WINNT_WINBLUE) + DCOMPOSITION_COMPOSITE_MODE_MIN_BLEND = 2, +#endif // (_WIN32_WINNT >= _WIN32_WINNT_WINBLUE) + + DCOMPOSITION_COMPOSITE_MODE_INHERIT = 0xffffffff +}; + +#if (_WIN32_WINNT >= _WIN32_WINNT_WINBLUE) +enum DCOMPOSITION_BACKFACE_VISIBILITY +{ + DCOMPOSITION_BACKFACE_VISIBILITY_VISIBLE = 0, + DCOMPOSITION_BACKFACE_VISIBILITY_HIDDEN = 1, + + DCOMPOSITION_BACKFACE_VISIBILITY_INHERIT = 0xffffffff +}; + +enum DCOMPOSITION_OPACITY_MODE +{ + DCOMPOSITION_OPACITY_MODE_LAYER = 0, + DCOMPOSITION_OPACITY_MODE_MULTIPLY = 1, + + DCOMPOSITION_OPACITY_MODE_INHERIT = 0xffffffff +}; +#endif // (_WIN32_WINNT >= _WIN32_WINNT_WINBLUE) + +#if (_WIN32_WINNT >= _WIN32_WINNT_WINTHRESHOLD) +enum DCOMPOSITION_DEPTH_MODE +{ + DCOMPOSITION_DEPTH_MODE_TREE = 0, + DCOMPOSITION_DEPTH_MODE_SPATIAL = 1, + DCOMPOSITION_DEPTH_MODE_SORTED = 3, + + DCOMPOSITION_DEPTH_MODE_INHERIT = 0xffffffff +}; +#endif // (_WIN32_WINNT >= _WIN32_WINNT_WINTHRESHOLD) + +typedef struct +{ + LARGE_INTEGER lastFrameTime; + DXGI_RATIONAL currentCompositionRate; + LARGE_INTEGER currentTime; + LARGE_INTEGER timeFrequency; + LARGE_INTEGER nextEstimatedFrameTime; +} DCOMPOSITION_FRAME_STATISTICS; + +// +// Composition object specific access flags +// + +#define COMPOSITIONOBJECT_READ 0x0001L +#define COMPOSITIONOBJECT_WRITE 0x0002L + +#define COMPOSITIONOBJECT_ALL_ACCESS (COMPOSITIONOBJECT_READ | COMPOSITIONOBJECT_WRITE) + +// +// Composition Stats +// + +typedef enum COMPOSITION_FRAME_ID_TYPE +{ + COMPOSITION_FRAME_ID_CREATED = 0, + COMPOSITION_FRAME_ID_CONFIRMED = 1, + COMPOSITION_FRAME_ID_COMPLETED = 2 +} COMPOSITION_FRAME_ID_TYPE; + +typedef ULONG64 COMPOSITION_FRAME_ID; + +typedef struct tagCOMPOSITION_FRAME_STATS +{ + UINT64 startTime; + UINT64 targetTime; + UINT64 framePeriod; +} COMPOSITION_FRAME_STATS; + +typedef struct tagCOMPOSITION_TARGET_ID +{ +#if defined(__cplusplus) && !defined(SORTPP_PASS) + bool operator ==(const tagCOMPOSITION_TARGET_ID& rhs) const + { + return ((displayAdapterLuid.LowPart == rhs.displayAdapterLuid.LowPart) && + (displayAdapterLuid.HighPart == rhs.displayAdapterLuid.HighPart) && + (renderAdapterLuid.LowPart == rhs.renderAdapterLuid.LowPart) && + (renderAdapterLuid.HighPart == rhs.renderAdapterLuid.HighPart) && + (vidPnSourceId == rhs.vidPnSourceId) && + (vidPnTargetId == rhs.vidPnTargetId) && + ((uniqueId == rhs.uniqueId) || (uniqueId == 0) || (rhs.uniqueId == 0))); + } + + bool operator !=(const tagCOMPOSITION_TARGET_ID& rhs) const + { + return !(*this == rhs); + } +#endif + + LUID displayAdapterLuid; + LUID renderAdapterLuid; + UINT vidPnSourceId; + UINT vidPnTargetId; + UINT uniqueId; +} COMPOSITION_TARGET_ID; + +typedef struct tagCOMPOSITION_STATS +{ + UINT presentCount; + UINT refreshCount; + UINT virtualRefreshCount; + UINT64 time; +} COMPOSITION_STATS; + +typedef struct tagCOMPOSITION_TARGET_STATS +{ + UINT outstandingPresents; + UINT64 presentTime; + UINT64 vblankDuration; + + COMPOSITION_STATS presentedStats; + COMPOSITION_STATS completedStats; +} COMPOSITION_TARGET_STATS; + +// The maximum nubmer of objects we allow users to wait on the compositor clock +#define DCOMPOSITION_MAX_WAITFORCOMPOSITORCLOCK_OBJECTS 32 + +// Maximum number of targets kept per frame +#define COMPOSITION_STATS_MAX_TARGETS 256 + +#endif // NTDDI_WIN8 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devguid.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devguid.h new file mode 100644 index 0000000000000000000000000000000000000000..aca5db5bb56ee6ebb488eeb8cd95030e5c7ab22b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devguid.h @@ -0,0 +1,133 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + devguid.h + +Abstract: + + Defines GUIDs for device classes used in Plug & Play. + +--*/ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +DEFINE_GUID( GUID_DEVCLASS_1394, 0x6bdd1fc1L, 0x810f, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_1394DEBUG, 0x66f250d6L, 0x7801, 0x4a64, 0xb1, 0x39, 0xee, 0xa8, 0x0a, 0x45, 0x0b, 0x24 ); +DEFINE_GUID( GUID_DEVCLASS_61883, 0x7ebefbc0L, 0x3200, 0x11d2, 0xb4, 0xc2, 0x00, 0xa0, 0xc9, 0x69, 0x7d, 0x07 ); +DEFINE_GUID( GUID_DEVCLASS_ADAPTER, 0x4d36e964L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_APMSUPPORT, 0xd45b1c18L, 0xc8fa, 0x11d1, 0x9f, 0x77, 0x00, 0x00, 0xf8, 0x05, 0xf5, 0x30 ); +DEFINE_GUID( GUID_DEVCLASS_AUDIOPROCESSINGOBJECT, 0x5989fce8L, 0x9cd0, 0x467d, 0x8a, 0x6a, 0x54, 0x19, 0xe3, 0x15, 0x29, 0xd4 ); +DEFINE_GUID( GUID_DEVCLASS_AVC, 0xc06ff265L, 0xae09, 0x48f0, 0x81, 0x2c, 0x16, 0x75, 0x3d, 0x7c, 0xba, 0x83 ); +DEFINE_GUID( GUID_DEVCLASS_BATTERY, 0x72631e54L, 0x78a4, 0x11d0, 0xbc, 0xf7, 0x00, 0xaa, 0x00, 0xb7, 0xb3, 0x2a ); +DEFINE_GUID( GUID_DEVCLASS_BIOMETRIC, 0x53d29ef7L, 0x377c, 0x4d14, 0x86, 0x4b, 0xeb, 0x3a, 0x85, 0x76, 0x93, 0x59 ); +DEFINE_GUID( GUID_DEVCLASS_BLUETOOTH, 0xe0cbf06cL, 0xcd8b, 0x4647, 0xbb, 0x8a, 0x26, 0x3b, 0x43, 0xf0, 0xf9, 0x74 ); +DEFINE_GUID( GUID_DEVCLASS_CAMERA, 0xca3e7ab9L, 0xb4c3, 0x4ae6, 0x82, 0x51, 0x57, 0x9e, 0xf9, 0x33, 0x89, 0x0f ); +DEFINE_GUID( GUID_DEVCLASS_CDROM, 0x4d36e965L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_COMPUTEACCELERATOR, 0xf01a9d53L, 0x3ff6, 0x48d2, 0x9f, 0x97, 0xc8, 0xa7, 0x00, 0x4b, 0xe1, 0x0c ); +DEFINE_GUID( GUID_DEVCLASS_COMPUTER, 0x4d36e966L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_DECODER, 0x6bdd1fc2L, 0x810f, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_DISKDRIVE, 0x4d36e967L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_DISPLAY, 0x4d36e968L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_DOT4, 0x48721b56L, 0x6795, 0x11d2, 0xb1, 0xa8, 0x00, 0x80, 0xc7, 0x2e, 0x74, 0xa2 ); +DEFINE_GUID( GUID_DEVCLASS_DOT4PRINT, 0x49ce6ac8L, 0x6f86, 0x11d2, 0xb1, 0xe5, 0x00, 0x80, 0xc7, 0x2e, 0x74, 0xa2 ); +DEFINE_GUID( GUID_DEVCLASS_EHSTORAGESILO, 0x9da2b80fL, 0xf89f, 0x4a49, 0xa5, 0xc2, 0x51, 0x1b, 0x08, 0x5b, 0x9e, 0x8a ); +DEFINE_GUID( GUID_DEVCLASS_ENUM1394, 0xc459df55L, 0xdb08, 0x11d1, 0xb0, 0x09, 0x00, 0xa0, 0xc9, 0x08, 0x1f, 0xf6 ); +DEFINE_GUID( GUID_DEVCLASS_EXTENSION, 0xe2f84ce7L, 0x8efa, 0x411c, 0xaa, 0x69, 0x97, 0x45, 0x4c, 0xa4, 0xcb, 0x57 ); +DEFINE_GUID( GUID_DEVCLASS_FDC, 0x4d36e969L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_FIRMWARE, 0xf2e7dd72L, 0x6468, 0x4e36, 0xb6, 0xf1, 0x64, 0x88, 0xf4, 0x2c, 0x1b, 0x52 ); +DEFINE_GUID( GUID_DEVCLASS_FLOPPYDISK, 0x4d36e980L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_GENERIC, 0xff494df1L, 0xc4ed, 0x4fac, 0x9b, 0x3f, 0x37, 0x86, 0xf6, 0xe9, 0x1e, 0x7e ); +DEFINE_GUID( GUID_DEVCLASS_GPS, 0x6bdd1fc3L, 0x810f, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_HDC, 0x4d36e96aL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_HIDCLASS, 0x745a17a0L, 0x74d3, 0x11d0, 0xb6, 0xfe, 0x00, 0xa0, 0xc9, 0x0f, 0x57, 0xda ); +DEFINE_GUID( GUID_DEVCLASS_HOLOGRAPHIC, 0xd612553dL, 0x06b1, 0x49ca, 0x89, 0x38, 0xe3, 0x9e, 0xf8, 0x0e, 0xb1, 0x6f ); +DEFINE_GUID( GUID_DEVCLASS_I3C, 0x13cfe1b1L, 0x6b17, 0x424c, 0xac, 0x3f, 0x16, 0xac, 0xe8, 0x73, 0x38, 0x98 ); +DEFINE_GUID( GUID_DEVCLASS_IMAGE, 0x6bdd1fc6L, 0x810f, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_INFINIBAND, 0x30ef7132L, 0xd858, 0x4a0c, 0xac, 0x24, 0xb9, 0x02, 0x8a, 0x5c, 0xca, 0x3f ); +DEFINE_GUID( GUID_DEVCLASS_INFRARED, 0x6bdd1fc5L, 0x810f, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_KEYBOARD, 0x4d36e96bL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_LEGACYDRIVER, 0x8ecc055dL, 0x047f, 0x11d1, 0xa5, 0x37, 0x00, 0x00, 0xf8, 0x75, 0x3e, 0xd1 ); +DEFINE_GUID( GUID_DEVCLASS_MEDIA, 0x4d36e96cL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MEDIUM_CHANGER, 0xce5939aeL, 0xebde, 0x11d0, 0xb1, 0x81, 0x00, 0x00, 0xf8, 0x75, 0x3e, 0xc4 ); +DEFINE_GUID( GUID_DEVCLASS_MEMORY, 0x5099944aL, 0xf6b9, 0x4057, 0xa0, 0x56, 0x8c, 0x55, 0x02, 0x28, 0x54, 0x4c ); +DEFINE_GUID( GUID_DEVCLASS_MODEM, 0x4d36e96dL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MONITOR, 0x4d36e96eL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MOUSE, 0x4d36e96fL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MTD, 0x4d36e970L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MULTIFUNCTION, 0x4d36e971L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_MULTIPORTSERIAL, 0x50906cb8L, 0xba12, 0x11d1, 0xbf, 0x5d, 0x00, 0x00, 0xf8, 0x05, 0xf5, 0x30 ); +DEFINE_GUID( GUID_DEVCLASS_NET, 0x4d36e972L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_NETCLIENT, 0x4d36e973L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_NETDRIVER, 0x87ef9ad1L, 0x8f70, 0x49ee, 0xb2, 0x15, 0xab, 0x1f, 0xca, 0xdc, 0xbe, 0x3c ); +DEFINE_GUID( GUID_DEVCLASS_NETSERVICE, 0x4d36e974L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_NETTRANS, 0x4d36e975L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_NETUIO, 0x78912bc1L, 0xcb8e, 0x4b28, 0xa3, 0x29, 0xf3, 0x22, 0xeb, 0xad, 0xbe, 0x0f ); +DEFINE_GUID( GUID_DEVCLASS_NODRIVER, 0x4d36e976L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_PCMCIA, 0x4d36e977L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_PNPPRINTERS, 0x4658ee7eL, 0xf050, 0x11d1, 0xb6, 0xbd, 0x00, 0xc0, 0x4f, 0xa3, 0x72, 0xa7 ); +DEFINE_GUID( GUID_DEVCLASS_PORTS, 0x4d36e978L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_PRIMITIVE, 0x242681d1L, 0xeed3, 0x41d2, 0xa1, 0xef, 0x14, 0x68, 0xfc, 0x84, 0x31, 0x06 ); +DEFINE_GUID( GUID_DEVCLASS_PRINTER, 0x4d36e979L, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_PRINTERUPGRADE, 0x4d36e97aL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_PRINTQUEUE, 0x1ed2bbf9L, 0x11f0, 0x4084, 0xb2, 0x1f, 0xad, 0x83, 0xa8, 0xe6, 0xdc, 0xdc ); +DEFINE_GUID( GUID_DEVCLASS_PROCESSOR, 0x50127dc3L, 0x0f36, 0x415e, 0xa6, 0xcc, 0x4c, 0xb3, 0xbe, 0x91, 0x0B, 0x65 ); +DEFINE_GUID( GUID_DEVCLASS_SBP2, 0xd48179beL, 0xec20, 0x11d1, 0xb6, 0xb8, 0x00, 0xc0, 0x4f, 0xa3, 0x72, 0xa7 ); +DEFINE_GUID( GUID_DEVCLASS_SCMDISK, 0x53966cb1L, 0x4d46, 0x4166, 0xbf, 0x23, 0xc5, 0x22, 0x40, 0x3c, 0xd4, 0x95 ); +DEFINE_GUID( GUID_DEVCLASS_SCMVOLUME, 0x53ccb149L, 0xe543, 0x4c84, 0xb6, 0xe0, 0xbc, 0xe4, 0xf6, 0xb7, 0xe8, 0x06 ); +DEFINE_GUID( GUID_DEVCLASS_SCSIADAPTER, 0x4d36e97bL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_SECURITYACCELERATOR, 0x268c95a1L, 0xedfe, 0x11d3, 0x95, 0xc3, 0x00, 0x10, 0xdc, 0x40, 0x50, 0xa5 ); +DEFINE_GUID( GUID_DEVCLASS_SENSOR, 0x5175d334L, 0xc371, 0x4806, 0xb3, 0xba, 0x71, 0xfd, 0x53, 0xc9, 0x25, 0x8d ); +DEFINE_GUID( GUID_DEVCLASS_SIDESHOW, 0x997b5d8dL, 0xc442, 0x4f2e, 0xba, 0xf3, 0x9c, 0x8e, 0x67, 0x1e, 0x9e, 0x21 ); +DEFINE_GUID( GUID_DEVCLASS_SMARTCARDREADER, 0x50dd5230L, 0xba8a, 0x11d1, 0xbf, 0x5d, 0x00, 0x00, 0xf8, 0x05, 0xf5, 0x30 ); +DEFINE_GUID( GUID_DEVCLASS_SMRDISK, 0x53487c23L, 0x680f, 0x4585, 0xac, 0xc3, 0x1f, 0x10, 0xd6, 0x77, 0x7e, 0x82 ); +DEFINE_GUID( GUID_DEVCLASS_SMRVOLUME, 0x53b3cf03L, 0x8f5a, 0x4788, 0x91, 0xb6, 0xd1, 0x9e, 0xd9, 0xfc, 0xcc, 0xbf ); +DEFINE_GUID( GUID_DEVCLASS_SOFTWARECOMPONENT, 0x5c4c3332L, 0x344d, 0x483c, 0x87, 0x39, 0x25, 0x9e, 0x93, 0x4c, 0x9c, 0xc8 ); +DEFINE_GUID( GUID_DEVCLASS_SOUND, 0x4d36e97cL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_SYSTEM, 0x4d36e97dL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_TAPEDRIVE, 0x6d807884L, 0x7d21, 0x11cf, 0x80, 0x1c, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_THERMAL, 0xca301ce1L, 0x74fc, 0x45ea, 0xa5, 0x57, 0x46, 0x1e, 0xf4, 0x8b, 0x9e, 0x37 ); +DEFINE_GUID( GUID_DEVCLASS_UNKNOWN, 0x4d36e97eL, 0xe325, 0x11ce, 0xbf, 0xc1, 0x08, 0x00, 0x2b, 0xe1, 0x03, 0x18 ); +DEFINE_GUID( GUID_DEVCLASS_UCM, 0xe6f1aa1cL, 0x7f3b, 0x4473, 0xb2, 0xe8, 0xc9, 0x7d, 0x8a, 0xc7, 0x1d, 0x53 ); +DEFINE_GUID( GUID_DEVCLASS_USB, 0x36fc9e60L, 0xc465, 0x11cf, 0x80, 0x56, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00 ); +DEFINE_GUID( GUID_DEVCLASS_VOLUME, 0x71a27cddL, 0x812a, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); +DEFINE_GUID( GUID_DEVCLASS_VOLUMESNAPSHOT, 0x533c5b84L, 0xec70, 0x11d2, 0x95, 0x05, 0x00, 0xc0, 0x4f, 0x79, 0xde, 0xaf ); +DEFINE_GUID( GUID_DEVCLASS_WCEUSBS, 0x25dbce51L, 0x6c8f, 0x4a72, 0x8a, 0x6d, 0xb5, 0x4c, 0x2b, 0x4f, 0xc8, 0x35 ); +DEFINE_GUID( GUID_DEVCLASS_WPD, 0xeec5ad98L, 0x8080, 0x425f, 0x92, 0x2a, 0xda, 0xbf, 0x3d, 0xe3, 0xf6, 0x9a ); + +// +// Define filesystem filter classes used for classification and load ordering. +// Classes are listed below in order from "highest" (i.e., farthest from the +// filesystem) to "lowest" (i.e., closest to the filesystem). +// +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_TOP, 0xb369baf4L, 0x5568, 0x4e82, 0xa8, 0x7e, 0xa9, 0x3e, 0xb1, 0x6b, 0xca, 0x87 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_ACTIVITYMONITOR, 0xb86dff51L, 0xa31e, 0x4bac, 0xb3, 0xcf, 0xe8, 0xcf, 0xe7, 0x5c, 0x9f, 0xc2 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_UNDELETE, 0xfe8f1572L, 0xc67a, 0x48c0, 0xbb, 0xac, 0x0b, 0x5c, 0x6d, 0x66, 0xca, 0xfb ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_ANTIVIRUS, 0xb1d1a169L, 0xc54f, 0x4379, 0x81, 0xdb, 0xbe, 0xe7, 0xd8, 0x8d, 0x74, 0x54 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_REPLICATION, 0x48d3ebc4L, 0x4cf8, 0x48ff, 0xb8, 0x69, 0x9c, 0x68, 0xad, 0x42, 0xeb, 0x9f ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_CONTINUOUSBACKUP, 0x71aa14f8L, 0x6fad, 0x4622, 0xad, 0x77, 0x92, 0xbb, 0x9d, 0x7e, 0x69, 0x47 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_CONTENTSCREENER, 0x3e3f0674L, 0xc83c, 0x4558, 0xbb, 0x26, 0x98, 0x20, 0xe1, 0xeb, 0xa5, 0xc5 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_QUOTAMANAGEMENT, 0x8503c911L, 0xa6c7, 0x4919, 0x8f, 0x79, 0x50, 0x28, 0xf5, 0x86, 0x6b, 0x0c ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_SYSTEMRECOVERY, 0x2db15374L, 0x706e, 0x4131, 0xa0, 0xc7, 0xd7, 0xc7, 0x8e, 0xb0, 0x28, 0x9a ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_CFSMETADATASERVER, 0xcdcf0939L, 0xb75b, 0x4630, 0xbf, 0x76, 0x80, 0xf7, 0xba, 0x65, 0x58, 0x84 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_HSM, 0xd546500aL, 0x2aeb, 0x45f6, 0x94, 0x82, 0xf4, 0xb1, 0x79, 0x9c, 0x31, 0x77 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_COMPRESSION, 0xf3586bafL, 0xb5aa, 0x49b5, 0x8d, 0x6c, 0x05, 0x69, 0x28, 0x4c, 0x63, 0x9f ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_ENCRYPTION, 0xa0a701c0L, 0xa511, 0x42ff, 0xaa, 0x6c, 0x06, 0xdc, 0x03, 0x95, 0x57, 0x6f ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_VIRTUALIZATION, 0xf75a86c0L, 0x10d8, 0x4c3a, 0xb2, 0x33, 0xed, 0x60, 0xe4, 0xcd, 0xfa, 0xac ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_PHYSICALQUOTAMANAGEMENT, 0x6a0a8e78L, 0xbba6, 0x4fc4, 0xa7, 0x09, 0x1e, 0x33, 0xcd, 0x09, 0xd6, 0x7e ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_OPENFILEBACKUP, 0xf8ecafa6L, 0x66d1, 0x41a5, 0x89, 0x9b, 0x66, 0x58, 0x5d, 0x72, 0x16, 0xb7 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_SECURITYENHANCER, 0xd02bc3daL, 0x0c8e, 0x4945, 0x9b, 0xd5, 0xf1, 0x88, 0x3c, 0x22, 0x6c, 0x8c ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_COPYPROTECTION, 0x89786ff1L, 0x9c12, 0x402f, 0x9c, 0x9e, 0x17, 0x75, 0x3c, 0x7f, 0x43, 0x75 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_BOTTOM, 0x37765ea0L, 0x5958, 0x4fc9, 0xb0, 0x4b, 0x2f, 0xdf, 0xef, 0x97, 0xe5, 0x9e ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_SYSTEM, 0x5d1b9aaaL, 0x01e2, 0x46af, 0x84, 0x9f, 0x27, 0x2b, 0x3f, 0x32, 0x4c, 0x46 ); +DEFINE_GUID( GUID_DEVCLASS_FSFILTER_INFRASTRUCTURE, 0xe55fa6f9L, 0x128c, 0x4d04, 0xab, 0xab, 0x63, 0x0c, 0x74, 0xb1, 0x45, 0x3a ); + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devioctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devioctl.h new file mode 100644 index 0000000000000000000000000000000000000000..d5dd7431a7a72c2137bf4798311f6d27896f5456 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devioctl.h @@ -0,0 +1,189 @@ +/*++ BUILD Version: 0004 // Increment this if a change has global effects + +Copyright (c) 1992-1999 Microsoft Corporation + +Module Name: + + devioctl.h + +Abstract: + + This module contains + + +Revision History: + + +--*/ + +// begin_winioctl + +#ifndef _DEVIOCTL_ +#define _DEVIOCTL_ + +// begin_ntddk begin_wdm begin_nthal begin_ntifs +// +// Define the various device type values. Note that values used by Microsoft +// Corporation are in the range 0-32767, and 32768-65535 are reserved for use +// by customers. +// + +#define DEVICE_TYPE ULONG + +#define FILE_DEVICE_BEEP 0x00000001 +#define FILE_DEVICE_CD_ROM 0x00000002 +#define FILE_DEVICE_CD_ROM_FILE_SYSTEM 0x00000003 +#define FILE_DEVICE_CONTROLLER 0x00000004 +#define FILE_DEVICE_DATALINK 0x00000005 +#define FILE_DEVICE_DFS 0x00000006 +#define FILE_DEVICE_DISK 0x00000007 +#define FILE_DEVICE_DISK_FILE_SYSTEM 0x00000008 +#define FILE_DEVICE_FILE_SYSTEM 0x00000009 +#define FILE_DEVICE_INPORT_PORT 0x0000000a +#define FILE_DEVICE_KEYBOARD 0x0000000b +#define FILE_DEVICE_MAILSLOT 0x0000000c +#define FILE_DEVICE_MIDI_IN 0x0000000d +#define FILE_DEVICE_MIDI_OUT 0x0000000e +#define FILE_DEVICE_MOUSE 0x0000000f +#define FILE_DEVICE_MULTI_UNC_PROVIDER 0x00000010 +#define FILE_DEVICE_NAMED_PIPE 0x00000011 +#define FILE_DEVICE_NETWORK 0x00000012 +#define FILE_DEVICE_NETWORK_BROWSER 0x00000013 +#define FILE_DEVICE_NETWORK_FILE_SYSTEM 0x00000014 +#define FILE_DEVICE_NULL 0x00000015 +#define FILE_DEVICE_PARALLEL_PORT 0x00000016 +#define FILE_DEVICE_PHYSICAL_NETCARD 0x00000017 +#define FILE_DEVICE_PRINTER 0x00000018 +#define FILE_DEVICE_SCANNER 0x00000019 +#define FILE_DEVICE_SERIAL_MOUSE_PORT 0x0000001a +#define FILE_DEVICE_SERIAL_PORT 0x0000001b +#define FILE_DEVICE_SCREEN 0x0000001c +#define FILE_DEVICE_SOUND 0x0000001d +#define FILE_DEVICE_STREAMS 0x0000001e +#define FILE_DEVICE_TAPE 0x0000001f +#define FILE_DEVICE_TAPE_FILE_SYSTEM 0x00000020 +#define FILE_DEVICE_TRANSPORT 0x00000021 +#define FILE_DEVICE_UNKNOWN 0x00000022 +#define FILE_DEVICE_VIDEO 0x00000023 +#define FILE_DEVICE_VIRTUAL_DISK 0x00000024 +#define FILE_DEVICE_WAVE_IN 0x00000025 +#define FILE_DEVICE_WAVE_OUT 0x00000026 +#define FILE_DEVICE_8042_PORT 0x00000027 +#define FILE_DEVICE_NETWORK_REDIRECTOR 0x00000028 +#define FILE_DEVICE_BATTERY 0x00000029 +#define FILE_DEVICE_BUS_EXTENDER 0x0000002a +#define FILE_DEVICE_MODEM 0x0000002b +#define FILE_DEVICE_VDM 0x0000002c +#define FILE_DEVICE_MASS_STORAGE 0x0000002d +#define FILE_DEVICE_SMB 0x0000002e +#define FILE_DEVICE_KS 0x0000002f +#define FILE_DEVICE_CHANGER 0x00000030 +#define FILE_DEVICE_SMARTCARD 0x00000031 +#define FILE_DEVICE_ACPI 0x00000032 +#define FILE_DEVICE_DVD 0x00000033 +#define FILE_DEVICE_FULLSCREEN_VIDEO 0x00000034 +#define FILE_DEVICE_DFS_FILE_SYSTEM 0x00000035 +#define FILE_DEVICE_DFS_VOLUME 0x00000036 +#define FILE_DEVICE_SERENUM 0x00000037 +#define FILE_DEVICE_TERMSRV 0x00000038 +#define FILE_DEVICE_KSEC 0x00000039 +#define FILE_DEVICE_FIPS 0x0000003A +#define FILE_DEVICE_INFINIBAND 0x0000003B +#define FILE_DEVICE_VMBUS 0x0000003E +#define FILE_DEVICE_CRYPT_PROVIDER 0x0000003F +#define FILE_DEVICE_WPD 0x00000040 +#define FILE_DEVICE_BLUETOOTH 0x00000041 +#define FILE_DEVICE_MT_COMPOSITE 0x00000042 +#define FILE_DEVICE_MT_TRANSPORT 0x00000043 +#define FILE_DEVICE_BIOMETRIC 0x00000044 +#define FILE_DEVICE_PMI 0x00000045 +#define FILE_DEVICE_EHSTOR 0x00000046 +#define FILE_DEVICE_DEVAPI 0x00000047 +#define FILE_DEVICE_GPIO 0x00000048 +#define FILE_DEVICE_USBEX 0x00000049 +#define FILE_DEVICE_CONSOLE 0x00000050 +#define FILE_DEVICE_NFP 0x00000051 +#define FILE_DEVICE_SYSENV 0x00000052 +#define FILE_DEVICE_VIRTUAL_BLOCK 0x00000053 +#define FILE_DEVICE_POINT_OF_SERVICE 0x00000054 +#define FILE_DEVICE_STORAGE_REPLICATION 0x00000055 +#define FILE_DEVICE_TRUST_ENV 0x00000056 +#define FILE_DEVICE_UCM 0x00000057 +#define FILE_DEVICE_UCMTCPCI 0x00000058 +#define FILE_DEVICE_PERSISTENT_MEMORY 0x00000059 +#define FILE_DEVICE_NVDIMM 0x0000005a +#define FILE_DEVICE_HOLOGRAPHIC 0x0000005b +#define FILE_DEVICE_SDFXHCI 0x0000005c +#define FILE_DEVICE_UCMUCSI 0x0000005d +#define FILE_DEVICE_PRM 0x0000005e +#define FILE_DEVICE_EVENT_COLLECTOR 0x0000005f +#define FILE_DEVICE_USB4 0x00000060 +#define FILE_DEVICE_SOUNDWIRE 0x00000061 +#define FILE_DEVICE_FABRIC_NVME 0x00000062 +#define FILE_DEVICE_SVM 0x00000063 +#define FILE_DEVICE_HARDWARE_ACCELERATOR 0x00000064 +#define FILE_DEVICE_I3C 0x00000065 + +// +// Macro definition for defining IOCTL and FSCTL function control codes. Note +// that function codes 0-2047 are reserved for Microsoft Corporation, and +// 2048-4095 are reserved for customers. +// + +#define CTL_CODE( DeviceType, Function, Method, Access ) ( \ + ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method) \ +) + +// +// Macro to extract device type out of the device io control code +// +#define DEVICE_TYPE_FROM_CTL_CODE(ctrlCode) (((ULONG)(ctrlCode & 0xffff0000)) >> 16) + +// +// Macro to extract buffering method out of the device io control code +// +#define METHOD_FROM_CTL_CODE(ctrlCode) ((ULONG)(ctrlCode & 3)) + +// +// Define the method codes for how buffers are passed for I/O and FS controls +// + +#define METHOD_BUFFERED 0 +#define METHOD_IN_DIRECT 1 +#define METHOD_OUT_DIRECT 2 +#define METHOD_NEITHER 3 + +// +// Define some easier to comprehend aliases: +// METHOD_DIRECT_TO_HARDWARE (writes, aka METHOD_IN_DIRECT) +// METHOD_DIRECT_FROM_HARDWARE (reads, aka METHOD_OUT_DIRECT) +// + +#define METHOD_DIRECT_TO_HARDWARE METHOD_IN_DIRECT +#define METHOD_DIRECT_FROM_HARDWARE METHOD_OUT_DIRECT + +// +// Define the access check value for any access +// +// +// The FILE_READ_ACCESS and FILE_WRITE_ACCESS constants are also defined in +// ntioapi.h as FILE_READ_DATA and FILE_WRITE_DATA. The values for these +// constants *MUST* always be in sync. +// +// +// FILE_SPECIAL_ACCESS is checked by the NT I/O system the same as FILE_ANY_ACCESS. +// The file systems, however, may add additional access checks for I/O and FS controls +// that use this value. +// + + +#define FILE_ANY_ACCESS 0 +#define FILE_SPECIAL_ACCESS (FILE_ANY_ACCESS) +#define FILE_READ_ACCESS ( 0x0001 ) // file & pipe +#define FILE_WRITE_ACCESS ( 0x0002 ) // file & pipe + +// end_ntddk end_wdm end_nthal end_ntifs + +#endif // _DEVIOCTL_ + +// end_winioctl diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpkey.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpkey.h new file mode 100644 index 0000000000000000000000000000000000000000..04934ef60295cf36f991e7bfc3b1e8e789e522fa --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpkey.h @@ -0,0 +1,429 @@ + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + devpkey.h + +Abstract: + + Defines property keys for the Plug and Play Device Property API. + +Environment: + + User and Kernel modes. + + +--*/ + +#define DEVPKEY_H_INCLUDED + +#include + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#include + + +// +// DEVPKEY_NAME +// Namespace: {b725f130-47ef-101a-a5f1-02608c9eebac} +// Property IDs: 10 +// Common DEVPKEY used to retrieve the display name for an object. +// +DEFINE_DEVPROPKEY(DEVPKEY_NAME, 0xb725f130, 0x47ef, 0x101a, 0xa5, 0xf1, 0x02, 0x60, 0x8c, 0x9e, 0xeb, 0xac, 10); // DEVPROP_TYPE_STRING + +// +// Device properties +// Namespace: {a45c254e-df1c-4efd-8020-67d146a850e0} +// Property IDs: 2-38 +// These DEVPKEYs correspond to the SetupAPI SPDRP_XXX device properties. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_DeviceDesc, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 2); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_HardwareIds, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 3); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_CompatibleIds, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 4); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_Service, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 6); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_Class, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 9); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_ClassGuid, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 10); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_Device_Driver, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 11); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_ConfigFlags, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 12); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_Manufacturer, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 13); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_FriendlyName, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 14); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_LocationInfo, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 15); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_PDOName, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 16); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_Capabilities, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 17); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_UINumber, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 18); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_UpperFilters, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 19); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_LowerFilters, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 20); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_BusTypeGuid, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 21); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_Device_LegacyBusType, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 22); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_BusNumber, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 23); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_EnumeratorName, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 24); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_Security, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 25); // DEVPROP_TYPE_SECURITY_DESCRIPTOR +DEFINE_DEVPROPKEY(DEVPKEY_Device_SecuritySDS, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 26); // DEVPROP_TYPE_SECURITY_DESCRIPTOR_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DevType, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 27); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_Exclusive, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 28); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_Characteristics, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 29); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_Address, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 30); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_UINumberDescFormat, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 31); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_PowerData, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 32); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_Device_RemovalPolicy, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 33); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_RemovalPolicyDefault, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 34); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_RemovalPolicyOverride, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 35); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_InstallState, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 36); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_LocationPaths, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 37); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_BaseContainerId, 0xa45c254e, 0xdf1c, 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 38); // DEVPROP_TYPE_GUID + +// +// Device and Device Interface property +// Namespace: {78c34fc8-104a-4aca-9ea4-524d52996e57} +// Property IDs: 256 +// Common DEVPKEY used to retrieve the device instance id associated with devices and device interfaces. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_InstanceId, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 256); // DEVPROP_TYPE_STRING + +// +// Device properties +// Namespace: {4340a6c5-93fa-4706-972c-7b648008a5a7} +// Property IDs: 2-3 +// These DEVPKEYs correspond to a device's status and problem code. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_DevNodeStatus, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 2); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_ProblemCode, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 3); // DEVPROP_TYPE_UINT32 + +// +// Device properties +// Namespace: {4340a6c5-93fa-4706-972c-7b648008a5a7} +// Property IDs: 4-11 +// These DEVPKEYs correspond to a device's relations. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_EjectionRelations, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 4); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_RemovalRelations, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 5); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_PowerRelations, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 6); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_BusRelations, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 7); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_Parent, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 8); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_Children, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 9); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_Siblings, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 10); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_TransportRelations, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 11); // DEVPROP_TYPE_STRING_LIST + +// +// Device property +// Namespace: {4340a6c5-93fa-4706-972c-7b648008a5a7} +// Property IDs: 12-13 +// This DEVPKEY corresponds to a the status code that resulted in a device to be in a problem state. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_ProblemStatus, 0x4340a6c5, 0x93fa, 0x4706, 0x97, 0x2c, 0x7b, 0x64, 0x80, 0x08, 0xa5, 0xa7, 12); // DEVPROP_TYPE_NTSTATUS + +// +// Device properties +// Namespace: {80497100-8c73-48b9-aad9-ce387e19c56e} +// Property IDs: 2-3 +// These DEVPKEYs are set for the corresponding types of root-enumerated devices. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_Reported, 0x80497100, 0x8c73, 0x48b9, 0xaa, 0xd9, 0xce, 0x38, 0x7e, 0x19, 0xc5, 0x6e, 2); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_Legacy, 0x80497100, 0x8c73, 0x48b9, 0xaa, 0xd9, 0xce, 0x38, 0x7e, 0x19, 0xc5, 0x6e, 3); // DEVPROP_TYPE_BOOLEAN + + +// +// Device Container Id +// Namespace: {8c7ed206-3f8a-4827-b3ab-ae9e1faefc6c} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_ContainerId, 0x8c7ed206, 0x3f8a, 0x4827, 0xb3, 0xab, 0xae, 0x9e, 0x1f, 0xae, 0xfc, 0x6c, 2); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_Device_InLocalMachineContainer, 0x8c7ed206, 0x3f8a, 0x4827, 0xb3, 0xab, 0xae, 0x9e, 0x1f, 0xae, 0xfc, 0x6c, 4); // DEVPROP_TYPE_BOOLEAN + +// +// Device Container device driver properties (container metadata properties) +// Namespace: {7d0300e4-4fb7-493d-8a95-656f00e6a271} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_ContainerModelName, 0x7d0300e4, 0x4fb7, 0x493d, 0x8a, 0x95, 0x65, 0x6f, 0x00, 0xe6, 0xa2, 0x71, 2); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_ContainerManufacturer, 0x7d0300e4, 0x4fb7, 0x493d, 0x8a, 0x95, 0x65, 0x6f, 0x00, 0xe6, 0xa2, 0x71, 3); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_Device_ContainerCategories, 0x7d0300e4, 0x4fb7, 0x493d, 0x8a, 0x95, 0x65, 0x6f, 0x00, 0xe6, 0xa2, 0x71, 4); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_ContainerIcon, 0x7d0300e4, 0x4fb7, 0x493d, 0x8a, 0x95, 0x65, 0x6f, 0x00, 0xe6, 0xa2, 0x71, 5); // DEVPROP_TYPE_STRING + + +// +// Device property +// Namespace: {78c34fc8-104a-4aca-9ea4-524d52996e57} +// Property IDs: 39 +// This DEVPKEY correspond to a device's model. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_Model, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 39); // DEVPROP_TYPE_STRING + +// +// Device Experience related Keys +// Namespace: {80d81ea6-7473-4b0c-8216-efc11a2c4c8b} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_ModelId, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 2); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_Device_FriendlyNameAttributes, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 3); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_ManufacturerAttributes, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 4); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_PresenceNotForDevice, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 5); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_SignalStrength, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 6); // DEVPROP_TYPE_INT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_IsAssociateableByUserAction, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 7); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_ShowInUninstallUI, 0x80d81ea6, 0x7473, 0x4b0c, 0x82, 0x16, 0xef, 0xc1, 0x1a, 0x2c, 0x4c, 0x8b, 8); // DEVPROP_TYPE_BOOLEAN + +// +// Hardware Support App (HSA) properties +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_CompanionApps, 0x6a742654, 0xd0b2, 0x4420, 0xa5, 0x23, 0xe0, 0x68, 0x35, 0x2a, 0xc1, 0xdf, 2); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_PrimaryCompanionApp, 0x6a742654, 0xd0b2, 0x4420, 0xa5, 0x23, 0xe0, 0x68, 0x35, 0x2a, 0xc1, 0xdf, 3); // DEVPROP_TYPE_STRING + +// +// Other Device properties +// Namespace: {540b947e-8b40-45bc-a8a2-6a0b894cbda2} +// Property IDs: all +// +#define DEVPKEY_Numa_Proximity_Domain DEVPKEY_Device_Numa_Proximity_Domain +DEFINE_DEVPROPKEY(DEVPKEY_Device_Numa_Proximity_Domain, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 1); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_DHP_Rebalance_Policy, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 2); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_Numa_Node, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 3); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_BusReportedDeviceDesc, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 4); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_IsPresent, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 5); // DEVPROP_TYPE_BOOL +DEFINE_DEVPROPKEY(DEVPKEY_Device_HasProblem, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 6); // DEVPROP_TYPE_BOOL +DEFINE_DEVPROPKEY(DEVPKEY_Device_ConfigurationId, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 7); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_ReportedDeviceIdsHash, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 8); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_PhysicalDeviceLocation, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 9); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_Device_BiosDeviceName, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 10); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverProblemDesc, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 11); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DebuggerSafe, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 12); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_PostInstallInProgress, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 13); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_Stack, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 14); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_ExtendedConfigurationIds, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 15); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_IsRebootRequired, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 16); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_FirmwareDate, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 17); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_Device_FirmwareVersion, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 18); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_FirmwareRevision, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 19); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DependencyProviders, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 20); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_DependencyDependents, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 21); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_SoftRestartSupported, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 22); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_ExtendedAddress, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 23); // DEVPROP_TYPE_UINT64 +DEFINE_DEVPROPKEY(DEVPKEY_Device_AssignedToGuest, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 24); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_CreatorProcessId, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 25); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_FirmwareVendor, 0x540b947e, 0x8b40, 0x45bc, 0xa8, 0xa2, 0x6a, 0x0b, 0x89, 0x4c, 0xbd, 0xa2, 26); // DEVPROP_TYPE_STRING + +DEFINE_DEVPROPKEY(DEVPKEY_Device_SessionId, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 6); // DEVPROP_TYPE_UINT32 + +// +// Device activity timestamp properties +// Namespace: {83da6326-97a6-4088-9453-a1923f573b29} +// Property IDs: 100-103 +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_InstallDate, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 100); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_Device_FirstInstallDate, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 101); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_Device_LastArrivalDate, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 102); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_Device_LastRemovalDate, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 103); // DEVPROP_TYPE_FILETIME + + +// +// Device driver properties +// Namespace: {a8b865dd-2e3d-4094-ad97-e593a7c75d6} +// Property IDs: 2-15 +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverDate, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 2); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverVersion, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 3); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverDesc, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 4); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverInfPath, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 5); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverInfSection, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 6); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverInfSectionExt, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 7); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_MatchingDeviceId, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 8); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverProvider, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 9); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverPropPageProvider, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 10); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverCoInstallers, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 11); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_Device_ResourcePickerTags, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 12); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_ResourcePickerExceptions, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 13); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverRank, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 14); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Device_DriverLogoLevel, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 15); // DEVPROP_TYPE_UINT32 + +// +// Device properties +// Namespace: {a8b865dd-2e3d-4094-ad97-e593a7c75d6} +// Property IDs: 17-19 +// These DEVPKEYs may be set by the driver package installed for a device. +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_NoConnectSound, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 17); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_GenericDriverInstalled, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 18); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_AdditionalSoftwareRequested, 0xa8b865dd, 0x2e3d, 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 19); // DEVPROP_TYPE_BOOLEAN + +// +// Device safe-removal properties +// Namespace: {afd97640-86a3-4210-b67c-289c41aabe55} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_Device_SafeRemovalRequired, 0xafd97640, 0x86a3, 0x4210, 0xb6, 0x7c, 0x28, 0x9c, 0x41, 0xaa, 0xbe, 0x55, 2); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Device_SafeRemovalRequiredOverride, 0xafd97640, 0x86a3, 0x4210, 0xb6, 0x7c, 0x28, 0x9c, 0x41, 0xaa, 0xbe, 0x55, 3); // DEVPROP_TYPE_BOOLEAN + + +// +// Device properties +// Namespace: {cf73bb51-3abf-44a2-85e0-9a3dc7a12132} +// Property IDs: all +// These DEVPKEYs may be set by the driver package installed for a device. +// +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_Model, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 2); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_VendorWebSite, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 3); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_DetailedDescription, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 4); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_DocumentationLink, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 5); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_Icon, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 6); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DrvPkg_BrandingIcon, 0xcf73bb51, 0x3abf, 0x44a2, 0x85, 0xe0, 0x9a, 0x3d, 0xc7, 0xa1, 0x21, 0x32, 7); // DEVPROP_TYPE_STRING_LIST + + +// +// Device setup class properties +// Namespace: {4321918b-f69e-470d-a5de-4d88c75ad24b} +// Property IDs: all +// These DEVPKEYs correspond to the SetupAPI SPCRP_XXX setup class properties. +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_UpperFilters, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 19); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_LowerFilters, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 20); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_Security, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 25); // DEVPROP_TYPE_SECURITY_DESCRIPTOR +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_SecuritySDS, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 26); // DEVPROP_TYPE_SECURITY_DESCRIPTOR_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_DevType, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 27); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_Exclusive, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 28); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_Characteristics, 0x4321918b, 0xf69e, 0x470d, 0xa5, 0xde, 0x4d, 0x88, 0xc7, 0x5a, 0xd2, 0x4b, 29); // DEVPROP_TYPE_UINT32 + +// +// Device setup class properties +// Namespace: {259abffc-50a7-47ce-af8-68c9a7d73366} +// Property IDs: 2-12 +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_Name, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 2); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_ClassName, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 3); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_Icon, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 4); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_ClassInstaller, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 5); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_PropPageProvider, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 6); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_NoInstallClass, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 7); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_NoDisplayClass, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 8); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_SilentInstall, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 9); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_NoUseClass, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 10); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_DefaultService, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 11); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_IconPath, 0x259abffc, 0x50a7, 0x47ce, 0xaf, 0x8, 0x68, 0xc9, 0xa7, 0xd7, 0x33, 0x66, 12); // DEVPROP_TYPE_STRING_LIST + +// +// Other Device setup class properties +// Namespace: {d14d3ef3-66cf-4ba2-9d38-0ddb37ab4701} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_DHPRebalanceOptOut, 0xd14d3ef3, 0x66cf, 0x4ba2, 0x9d, 0x38, 0x0d, 0xdb, 0x37, 0xab, 0x47, 0x01, 2); // DEVPROP_TYPE_BOOLEAN + +// +// Other Device setup class properties +// Namespace: {713d1703-a2e2-49f5-9214-56472ef3da5c} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceClass_ClassCoInstallers, 0x713d1703, 0xa2e2, 0x49f5, 0x92, 0x14, 0x56, 0x47, 0x2e, 0xf3, 0xda, 0x5c, 2); // DEVPROP_TYPE_STRING_LIST + +// +// Device interface properties +// Namespace: {026e516e-b814-414b-83cd-856d6fef4822} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_FriendlyName, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 2); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Enabled, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 3); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_ClassGuid, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 4); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_ReferenceString, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 5); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Restricted, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 6); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_UnrestrictedAppCapabilities, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 8); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_SchematicName, 0x026e516e, 0xb814, 0x414b, 0x83, 0xcd, 0x85, 0x6d, 0x6f, 0xef, 0x48, 0x22, 9); // DEVPROP_TYPE_STRING + +// +// Device interface class properties +// Namespace: {14c83a99-0b3f-44b7-be4c-a178d3990564} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterfaceClass_DefaultInterface, 0x14c83a99, 0x0b3f, 0x44b7, 0xbe, 0x4c, 0xa1, 0x78, 0xd3, 0x99, 0x05, 0x64, 2); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterfaceClass_Name, 0x14c83a99, 0x0b3f, 0x44b7, 0xbe, 0x4c, 0xa1, 0x78, 0xd3, 0x99, 0x05, 0x64, 3); // DEVPROP_TYPE_STRING + +// +// Device Container Properties +// Namespace: {78c34fc8-104a-4aca-9ea4-524d52996e57} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Address, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 51); // DEVPROP_TYPE_STRING | DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_DiscoveryMethod, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 52); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsEncrypted, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 53); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsAuthenticated, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 54); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsConnected, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 55); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsPaired, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 56); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Icon, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 57); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Version, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 65); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Last_Seen, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 66); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Last_Connected, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 67); // DEVPROP_TYPE_FILETIME +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsShowInDisconnectedState, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 68); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsLocalMachine, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 70); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_MetadataPath, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 71); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsMetadataSearchInProgress, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 72); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_MetadataChecksum, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 73); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsNotInterestingForDisplay, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 74); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_LaunchDeviceStageOnDeviceConnect, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 76); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_LaunchDeviceStageFromExplorer, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 77); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_BaselineExperienceId, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 78); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsDeviceUniquelyIdentifiable, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 79); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_AssociationArray, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 80); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_DeviceDescription1, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 81); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_DeviceDescription2, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 82); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_HasProblem, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 83); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsSharedDevice, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 84); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsNetworkDevice, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 85); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsDefaultDevice, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 86); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_MetadataCabinet, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 87); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_RequiresPairingElevation, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 88); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_ExperienceId, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 89); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Category, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 90); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Category_Desc_Singular, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 91); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Category_Desc_Plural, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 92); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Category_Icon, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 93); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_CategoryGroup_Desc, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 94); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_CategoryGroup_Icon, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 95); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_PrimaryCategory, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 97); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_UnpairUninstall, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 98); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_RequiresUninstallElevation, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 99); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_DeviceFunctionSubRank, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 100); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_AlwaysShowDeviceAsConnected, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 101); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_ConfigFlags, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 105); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_PrivilegedPackageFamilyNames, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 106); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_CustomPrivilegedPackageFamilyNames, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 107); // DEVPROP_TYPE_STRING_LIST +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_IsRebootRequired, 0x78c34fc8, 0x104a, 0x4aca, 0x9e, 0xa4, 0x52, 0x4d, 0x52, 0x99, 0x6e, 0x57, 108); // DEVPROP_TYPE_BOOLEAN + +// +// Device Container Properties +// Namespace: {656a3bb3-ecc0-43fd-8477-4ae0404a96cd} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_FriendlyName, 0x656A3BB3, 0xECC0, 0x43FD, 0x84, 0x77, 0x4A, 0xE0, 0x40, 0x4A, 0x96, 0xCD, 12288); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_Manufacturer, 0x656A3BB3, 0xECC0, 0x43FD, 0x84, 0x77, 0x4A, 0xE0, 0x40, 0x4A, 0x96, 0xCD, 8192); // DEVPROP_TYPE_STRING +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_ModelName, 0x656A3BB3, 0xECC0, 0x43FD, 0x84, 0x77, 0x4A, 0xE0, 0x40, 0x4A, 0x96, 0xCD, 8194); // DEVPROP_TYPE_STRING (localizable) +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_ModelNumber, 0x656A3BB3, 0xECC0, 0x43FD, 0x84, 0x77, 0x4A, 0xE0, 0x40, 0x4A, 0x96, 0xCD, 8195); // DEVPROP_TYPE_STRING + +// {83da6326-97a6-4088-9453-a1923f573b29} +// Property IDs: 9 +DEFINE_DEVPROPKEY(DEVPKEY_DeviceContainer_InstallInProgress, 0x83da6326, 0x97a6, 0x4088, 0x94, 0x53, 0xa1, 0x92, 0x3f, 0x57, 0x3b, 0x29, 9); // DEVPROP_TYPE_BOOLEAN + +// +// DeviceContainer properties that can be set on a devnode. +// These used to be defined as DeviceDisplay +// +#define DEVPKEY_DeviceDisplay_DiscoveryMethod DEVPKEY_DeviceContainer_DiscoveryMethod +#define DEVPKEY_DeviceDisplay_IsShowInDisconnectedState DEVPKEY_DeviceContainer_IsShowInDisconnectedState +#define DEVPKEY_DeviceDisplay_IsNotInterestingForDisplay DEVPKEY_DeviceContainer_IsNotInterestingForDisplay +#define DEVPKEY_DeviceDisplay_IsNetworkDevice DEVPKEY_DeviceContainer_IsNetworkDevice +#define DEVPKEY_DeviceDisplay_Category DEVPKEY_DeviceContainer_Category +#define DEVPKEY_DeviceDisplay_UnpairUninstall DEVPKEY_DeviceContainer_UnpairUninstall +#define DEVPKEY_DeviceDisplay_RequiresUninstallElevation DEVPKEY_DeviceContainer_RequiresUninstallElevation +#define DEVPKEY_DeviceDisplay_AlwaysShowDeviceAsConnected DEVPKEY_DeviceContainer_AlwaysShowDeviceAsConnected + + +// +// DevQuery properties +// Namespace: {13673f42-a3d6-49f6-b4da-ae46e0c5237c} +// Property IDs: all +// +DEFINE_DEVPROPKEY(DEVPKEY_DevQuery_ObjectType, 0x13673f42, 0xa3d6, 0x49f6, 0xb4, 0xda, 0xae, 0x46, 0xe0, 0xc5, 0x23, 0x7c, 2); // DEVPROP_TYPE_UINT32 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpropdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpropdef.h new file mode 100644 index 0000000000000000000000000000000000000000..d1db387bb790980272b7f55d9a36106b7ea426fb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/devpropdef.h @@ -0,0 +1,210 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + devpropdef.h + +Abstract: + + Defines property types and keys for the Plug and Play Device Property API. + +Environment: + + User and Kernel modes. + +--*/ + + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef _DEVPROPDEF_H_ +#define _DEVPROPDEF_H_ + +// +// Type definition for property data types. Valid DEVPROPTYPE values are +// constructed from base DEVPROP_TYPE_ values, which may be modified by a +// logical OR with DEVPROP_TYPEMOD_ values, as appropriate. +// +typedef ULONG DEVPROPTYPE, *PDEVPROPTYPE; + +// +// Property type modifiers. Used to modify base DEVPROP_TYPE_ values, as +// appropriate. Not valid as standalone DEVPROPTYPE values. +// +#define DEVPROP_TYPEMOD_ARRAY 0x00001000 // array of fixed-sized data elements +#define DEVPROP_TYPEMOD_LIST 0x00002000 // list of variable-sized data elements + +// +// Property data types. +// +#define DEVPROP_TYPE_EMPTY 0x00000000 // nothing, no property data +#define DEVPROP_TYPE_NULL 0x00000001 // null property data +#define DEVPROP_TYPE_SBYTE 0x00000002 // 8-bit signed int (SBYTE) +#define DEVPROP_TYPE_BYTE 0x00000003 // 8-bit unsigned int (BYTE) +#define DEVPROP_TYPE_INT16 0x00000004 // 16-bit signed int (SHORT) +#define DEVPROP_TYPE_UINT16 0x00000005 // 16-bit unsigned int (USHORT) +#define DEVPROP_TYPE_INT32 0x00000006 // 32-bit signed int (LONG) +#define DEVPROP_TYPE_UINT32 0x00000007 // 32-bit unsigned int (ULONG) +#define DEVPROP_TYPE_INT64 0x00000008 // 64-bit signed int (LONG64) +#define DEVPROP_TYPE_UINT64 0x00000009 // 64-bit unsigned int (ULONG64) +#define DEVPROP_TYPE_FLOAT 0x0000000A // 32-bit floating-point (FLOAT) +#define DEVPROP_TYPE_DOUBLE 0x0000000B // 64-bit floating-point (DOUBLE) +#define DEVPROP_TYPE_DECIMAL 0x0000000C // 128-bit data (DECIMAL) +#define DEVPROP_TYPE_GUID 0x0000000D // 128-bit unique identifier (GUID) +#define DEVPROP_TYPE_CURRENCY 0x0000000E // 64 bit signed int currency value (CURRENCY) +#define DEVPROP_TYPE_DATE 0x0000000F // date (DATE) +#define DEVPROP_TYPE_FILETIME 0x00000010 // file time (FILETIME) +#define DEVPROP_TYPE_BOOLEAN 0x00000011 // 8-bit boolean (DEVPROP_BOOLEAN) +#define DEVPROP_TYPE_STRING 0x00000012 // null-terminated string +#define DEVPROP_TYPE_STRING_LIST (DEVPROP_TYPE_STRING|DEVPROP_TYPEMOD_LIST) // multi-sz string list +#define DEVPROP_TYPE_SECURITY_DESCRIPTOR 0x00000013 // self-relative binary SECURITY_DESCRIPTOR +#define DEVPROP_TYPE_SECURITY_DESCRIPTOR_STRING 0x00000014 // security descriptor string (SDDL format) +#define DEVPROP_TYPE_DEVPROPKEY 0x00000015 // device property key (DEVPROPKEY) +#define DEVPROP_TYPE_DEVPROPTYPE 0x00000016 // device property type (DEVPROPTYPE) +#define DEVPROP_TYPE_BINARY (DEVPROP_TYPE_BYTE|DEVPROP_TYPEMOD_ARRAY) // custom binary data +#define DEVPROP_TYPE_ERROR 0x00000017 // 32-bit Win32 system error code +#define DEVPROP_TYPE_NTSTATUS 0x00000018 // 32-bit NTSTATUS code +#define DEVPROP_TYPE_STRING_INDIRECT 0x00000019 // string resource (@[path\],-) + +// +// Max base DEVPROP_TYPE_ and DEVPROP_TYPEMOD_ values. +// +#define MAX_DEVPROP_TYPE 0x00000019 // max valid DEVPROP_TYPE_ value +#define MAX_DEVPROP_TYPEMOD 0x00002000 // max valid DEVPROP_TYPEMOD_ value + +// +// Bitmasks for extracting DEVPROP_TYPE_ and DEVPROP_TYPEMOD_ values. +// +#define DEVPROP_MASK_TYPE 0x00000FFF // range for base DEVPROP_TYPE_ values +#define DEVPROP_MASK_TYPEMOD 0x0000F000 // mask for DEVPROP_TYPEMOD_ type modifiers + + +// +// Property type specific data types. +// + +// 8-bit boolean type definition for DEVPROP_TYPE_BOOLEAN (True=-1, False=0) +typedef CHAR DEVPROP_BOOLEAN, *PDEVPROP_BOOLEAN; +#define DEVPROP_TRUE ((DEVPROP_BOOLEAN)-1) +#define DEVPROP_FALSE ((DEVPROP_BOOLEAN) 0) + + +// +// DEVPROPKEY structure +// + +#ifndef DEVPROPKEY_DEFINED +#define DEVPROPKEY_DEFINED + +typedef GUID DEVPROPGUID, *PDEVPROPGUID; +typedef ULONG DEVPROPID, *PDEVPROPID; + +typedef struct _DEVPROPKEY { + DEVPROPGUID fmtid; + DEVPROPID pid; +} DEVPROPKEY, *PDEVPROPKEY; + +#endif // DEVPROPKEY_DEFINED + +#ifndef IsEqualDevPropKey +#ifdef __cplusplus +#define IsEqualDevPropKey(a, b) (((a).pid == (b).pid) && IsEqualGUID((a).fmtid, (b).fmtid)) +#ifdef _SYS_GUID_OPERATOR_EQ_ +extern "C++" { +inline bool operator==(const DEVPROPKEY &a, const DEVPROPKEY &b) { return ((a.pid == b.pid) && (a.fmtid == b.fmtid)); } +inline bool operator!=(const DEVPROPKEY &a, const DEVPROPKEY &b) { return !(a == b); } +} +#endif // _SYS_GUID_OPERATOR_EQ_ +#else // !__cplusplus +#define IsEqualDevPropKey(a, b) (((a).pid == (b).pid) && IsEqualGUID(&(a).fmtid, &(b).fmtid)) +#endif // __cplusplus +#endif // !IsEqualDevPropKey + +// +// DEVPROPSTORE Enumeration +// +// This enumeration describes where a property is stored. +// + +typedef +#ifdef MIDL_PASS +[v1_enum] +#endif +enum _DEVPROPSTORE { + DEVPROP_STORE_SYSTEM, + DEVPROP_STORE_USER +} DEVPROPSTORE, *PDEVPROPSTORE; + +// +// DEVPROPCOMPKEY structure +// +// This structure represents a compound key for a property. +// + +typedef struct _DEVPROPCOMPKEY { + DEVPROPKEY Key; + DEVPROPSTORE Store; +#ifdef MIDL_PASS + [string] wchar_t *LocaleName; +#else + PCWSTR LocaleName; +#endif +} DEVPROPCOMPKEY, *PDEVPROPCOMPKEY; + +#ifndef IsEqualLocaleName +#define IsEqualLocaleName(a, b) (((a) == (b)) || (((a) != NULL) && ((b) != NULL) && (_wcsicmp((a), (b)) == 0))) +#endif + +#ifndef IsEqualDevPropCompKey +#define IsEqualDevPropCompKey(a, b) (IsEqualDevPropKey((a).Key, (b).Key) && ((a).Store == (b).Store) && IsEqualLocaleName((a).LocaleName, (b).LocaleName)) +#ifdef __cplusplus +#ifdef _SYS_GUID_OPERATOR_EQ_ +extern "C++" { +inline bool operator==(const DEVPROPCOMPKEY &a, const DEVPROPCOMPKEY &b) { return ((a.Key == b.Key) && (a.Store == b.Store) && IsEqualLocaleName(a.LocaleName, b.LocaleName)); } +inline bool operator!=(const DEVPROPCOMPKEY &a, const DEVPROPCOMPKEY &b) { return !(a == b); } +} +#endif // _SYS_GUID_OPERATOR_EQ_ +#endif // __cplusplus +#endif // !IsEqualDevPropCompKey + +// +// DEVPROPERTY structure +// + +typedef struct _DEVPROPERTY { + DEVPROPCOMPKEY CompKey; + DEVPROPTYPE Type; + ULONG BufferSize; +#ifdef MIDL_PASS + [size_is(BufferSize)] BYTE *Buffer; +#else + __field_bcount_opt(BufferSize) PVOID Buffer; +#endif +} DEVPROPERTY, *PDEVPROPERTY; + + +// +// All valid DEVPROPKEY definitions must use a PROPID that is equal to or greater +// than DEVPROPID_FIRST_USABLE. +// +#define DEVPROPID_FIRST_USABLE 2 + +#endif // _DEVPROPDEF_H_ + + +#ifdef DEFINE_DEVPROPKEY +#undef DEFINE_DEVPROPKEY +#endif +#ifdef INITGUID +#define DEFINE_DEVPROPKEY(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8, pid) EXTERN_C const DEVPROPKEY DECLSPEC_SELECTANY name = { { l, w1, w2, { b1, b2, b3, b4, b5, b6, b7, b8 } }, pid } +#else +#define DEFINE_DEVPROPKEY(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8, pid) EXTERN_C const DEVPROPKEY name +#endif // INITGUID + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dinputd.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dinputd.h new file mode 100644 index 0000000000000000000000000000000000000000..a15940c34eecc1bc144b1272f6d8221cea73986b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dinputd.h @@ -0,0 +1,763 @@ +/**************************************************************************** + * + * Copyright (C) 1995-2000 Microsoft Corporation. All Rights Reserved. + * + * File: dinputd.h + * Content: DirectInput include file for device driver implementors + * + ****************************************************************************/ +#ifndef __DINPUTD_INCLUDED__ +#define __DINPUTD_INCLUDED__ + +#include + +#ifndef DIRECTINPUT_VERSION +#define DIRECTINPUT_VERSION 0x0800 +#pragma message(__FILE__ ": DIRECTINPUT_VERSION undefined. Defaulting to version 0x0800") +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/**************************************************************************** + * + * Interfaces + * + ****************************************************************************/ + +#ifndef DIJ_RINGZERO + +DEFINE_GUID(IID_IDirectInputEffectDriver, 0x02538130,0x898F,0x11D0,0x9A,0xD0,0x00,0xA0,0xC9,0xA0,0x6E,0x35); +DEFINE_GUID(IID_IDirectInputJoyConfig, 0x1DE12AB1,0xC9F5,0x11CF,0xBF,0xC7,0x44,0x45,0x53,0x54,0x00,0x00); +DEFINE_GUID(IID_IDirectInputPIDDriver, 0xEEC6993A,0xB3FD,0x11D2,0xA9,0x16,0x00,0xC0,0x4F,0xB9,0x86,0x38); + +DEFINE_GUID(IID_IDirectInputJoyConfig8, 0xeb0d7dfa,0x1990,0x4f27,0xb4,0xd6,0xed,0xf2,0xee,0xc4,0xa4,0x4c); + +#endif /* DIJ_RINGZERO */ + + +/**************************************************************************** + * + * IDirectInputEffectDriver + * + ****************************************************************************/ + +typedef struct DIOBJECTATTRIBUTES { + DWORD dwFlags; + WORD wUsagePage; + WORD wUsage; +} DIOBJECTATTRIBUTES, *LPDIOBJECTATTRIBUTES; +typedef const DIOBJECTATTRIBUTES *LPCDIOBJECTATTRIBUTES; + +typedef struct DIFFOBJECTATTRIBUTES { + DWORD dwFFMaxForce; + DWORD dwFFForceResolution; +} DIFFOBJECTATTRIBUTES, *LPDIFFOBJECTATTRIBUTES; +typedef const DIFFOBJECTATTRIBUTES *LPCDIFFOBJECTATTRIBUTES; + +typedef struct DIOBJECTCALIBRATION { + LONG lMin; + LONG lCenter; + LONG lMax; +} DIOBJECTCALIBRATION, *LPDIOBJECTCALIBRATION; +typedef const DIOBJECTCALIBRATION *LPCDIOBJECTCALIBRATION; + +typedef struct DIPOVCALIBRATION { + LONG lMin[5]; + LONG lMax[5]; +} DIPOVCALIBRATION, *LPDIPOVCALIBRATION; +typedef const DIPOVCALIBRATION *LPCDIPOVCALIBRATION; + +typedef struct DIEFFECTATTRIBUTES { + DWORD dwEffectId; + DWORD dwEffType; + DWORD dwStaticParams; + DWORD dwDynamicParams; + DWORD dwCoords; +} DIEFFECTATTRIBUTES, *LPDIEFFECTATTRIBUTES; +typedef const DIEFFECTATTRIBUTES *LPCDIEFFECTATTRIBUTES; + +typedef struct DIFFDEVICEATTRIBUTES { + DWORD dwFlags; + DWORD dwFFSamplePeriod; + DWORD dwFFMinTimeResolution; +} DIFFDEVICEATTRIBUTES, *LPDIFFDEVICEATTRIBUTES; +typedef const DIFFDEVICEATTRIBUTES *LPCDIFFDEVICEATTRIBUTES; + +typedef struct DIDRIVERVERSIONS { + DWORD dwSize; + DWORD dwFirmwareRevision; + DWORD dwHardwareRevision; + DWORD dwFFDriverVersion; +} DIDRIVERVERSIONS, *LPDIDRIVERVERSIONS; +typedef const DIDRIVERVERSIONS *LPCDIDRIVERVERSIONS; + +typedef struct DIDEVICESTATE { + DWORD dwSize; + DWORD dwState; + DWORD dwLoad; +} DIDEVICESTATE, *LPDIDEVICESTATE; + +#define DEV_STS_EFFECT_RUNNING DIEGES_PLAYING + +#ifndef DIJ_RINGZERO + +typedef struct DIHIDFFINITINFO { + DWORD dwSize; + LPWSTR pwszDeviceInterface; + GUID GuidInstance; +} DIHIDFFINITINFO, *LPDIHIDFFINITINFO; + +#undef INTERFACE +#define INTERFACE IDirectInputEffectDriver + +DECLARE_INTERFACE_(IDirectInputEffectDriver, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, LPVOID * ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirectInputEffectDriver methods ***/ + STDMETHOD(DeviceID)(THIS_ DWORD,DWORD,DWORD,DWORD,LPVOID) PURE; + STDMETHOD(GetVersions)(THIS_ LPDIDRIVERVERSIONS) PURE; + STDMETHOD(Escape)(THIS_ DWORD,DWORD,LPDIEFFESCAPE) PURE; + STDMETHOD(SetGain)(THIS_ DWORD,DWORD) PURE; + STDMETHOD(SendForceFeedbackCommand)(THIS_ DWORD,DWORD) PURE; + STDMETHOD(GetForceFeedbackState)(THIS_ DWORD,LPDIDEVICESTATE) PURE; + STDMETHOD(DownloadEffect)(THIS_ DWORD,DWORD,LPDWORD,LPCDIEFFECT,DWORD) PURE; + STDMETHOD(DestroyEffect)(THIS_ DWORD,DWORD) PURE; + STDMETHOD(StartEffect)(THIS_ DWORD,DWORD,DWORD,DWORD) PURE; + STDMETHOD(StopEffect)(THIS_ DWORD,DWORD) PURE; + STDMETHOD(GetEffectStatus)(THIS_ DWORD,DWORD,LPDWORD) PURE; +}; + +typedef struct IDirectInputEffectDriver *LPDIRECTINPUTEFFECTDRIVER; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirectInputEffectDriver_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirectInputEffectDriver_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirectInputEffectDriver_Release(p) (p)->lpVtbl->Release(p) +#define IDirectInputEffectDriver_DeviceID(p,a,b,c,d,e) (p)->lpVtbl->DeviceID(p,a,b,c,d,e) +#define IDirectInputEffectDriver_GetVersions(p,a) (p)->lpVtbl->GetVersions(p,a) +#define IDirectInputEffectDriver_Escape(p,a,b,c) (p)->lpVtbl->Escape(p,a,b,c) +#define IDirectInputEffectDriver_SetGain(p,a,b) (p)->lpVtbl->SetGain(p,a,b) +#define IDirectInputEffectDriver_SendForceFeedbackCommand(p,a,b) (p)->lpVtbl->SendForceFeedbackCommand(p,a,b) +#define IDirectInputEffectDriver_GetForceFeedbackState(p,a,b) (p)->lpVtbl->GetForceFeedbackState(p,a,b) +#define IDirectInputEffectDriver_DownloadEffect(p,a,b,c,d,e) (p)->lpVtbl->DownloadEffect(p,a,b,c,d,e) +#define IDirectInputEffectDriver_DestroyEffect(p,a,b) (p)->lpVtbl->DestroyEffect(p,a,b) +#define IDirectInputEffectDriver_StartEffect(p,a,b,c,d) (p)->lpVtbl->StartEffect(p,a,b,c,d) +#define IDirectInputEffectDriver_StopEffect(p,a,b) (p)->lpVtbl->StopEffect(p,a,b) +#define IDirectInputEffectDriver_GetEffectStatus(p,a,b,c) (p)->lpVtbl->GetEffectStatus(p,a,b,c) +#else +#define IDirectInputEffectDriver_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirectInputEffectDriver_AddRef(p) (p)->AddRef() +#define IDirectInputEffectDriver_Release(p) (p)->Release() +#define IDirectInputEffectDriver_DeviceID(p,a,b,c,d,e) (p)->DeviceID(a,b,c,d,e) +#define IDirectInputEffectDriver_GetVersions(p,a) (p)->GetVersions(a) +#define IDirectInputEffectDriver_Escape(p,a,b,c) (p)->Escape(a,b,c) +#define IDirectInputEffectDriver_SetGain(p,a,b) (p)->SetGain(a,b) +#define IDirectInputEffectDriver_SendForceFeedbackCommand(p,a,b) (p)->SendForceFeedbackCommand(a,b) +#define IDirectInputEffectDriver_GetForceFeedbackState(p,a,b) (p)->GetForceFeedbackState(a,b) +#define IDirectInputEffectDriver_DownloadEffect(p,a,b,c,d,e) (p)->DownloadEffect(a,b,c,d,e) +#define IDirectInputEffectDriver_DestroyEffect(p,a,b) (p)->DestroyEffect(a,b) +#define IDirectInputEffectDriver_StartEffect(p,a,b,c,d) (p)->StartEffect(a,b,c,d) +#define IDirectInputEffectDriver_StopEffect(p,a,b) (p)->StopEffect(a,b) +#define IDirectInputEffectDriver_GetEffectStatus(p,a,b,c) (p)->GetEffectStatus(a,b,c) +#endif + + +#endif /* DIJ_RINGZERO */ + + +/**************************************************************************** + * + * IDirectInputJoyConfig + * + ****************************************************************************/ + +/**************************************************************************** + * + * Definitions copied from the DDK + * + ****************************************************************************/ + +#ifndef JOY_HW_NONE + +/* pre-defined joystick types */ +#define JOY_HW_NONE 0 +#define JOY_HW_CUSTOM 1 +#define JOY_HW_2A_2B_GENERIC 2 +#define JOY_HW_2A_4B_GENERIC 3 +#define JOY_HW_2B_GAMEPAD 4 +#define JOY_HW_2B_FLIGHTYOKE 5 +#define JOY_HW_2B_FLIGHTYOKETHROTTLE 6 +#define JOY_HW_3A_2B_GENERIC 7 +#define JOY_HW_3A_4B_GENERIC 8 +#define JOY_HW_4B_GAMEPAD 9 +#define JOY_HW_4B_FLIGHTYOKE 10 +#define JOY_HW_4B_FLIGHTYOKETHROTTLE 11 +#define JOY_HW_TWO_2A_2B_WITH_Y 12 +#define JOY_HW_LASTENTRY 13 + + +/* calibration flags */ +#define JOY_ISCAL_XY 0x00000001l /* XY are calibrated */ +#define JOY_ISCAL_Z 0x00000002l /* Z is calibrated */ +#define JOY_ISCAL_R 0x00000004l /* R is calibrated */ +#define JOY_ISCAL_U 0x00000008l /* U is calibrated */ +#define JOY_ISCAL_V 0x00000010l /* V is calibrated */ +#define JOY_ISCAL_POV 0x00000020l /* POV is calibrated */ + +/* point of view constants */ +#define JOY_POV_NUMDIRS 4 +#define JOY_POVVAL_FORWARD 0 +#define JOY_POVVAL_BACKWARD 1 +#define JOY_POVVAL_LEFT 2 +#define JOY_POVVAL_RIGHT 3 + +/* Specific settings for joystick hardware */ +#define JOY_HWS_HASZ 0x00000001l /* has Z info? */ +#define JOY_HWS_HASPOV 0x00000002l /* point of view hat present */ +#define JOY_HWS_POVISBUTTONCOMBOS 0x00000004l /* pov done through combo of buttons */ +#define JOY_HWS_POVISPOLL 0x00000008l /* pov done through polling */ +#define JOY_HWS_ISYOKE 0x00000010l /* joystick is a flight yoke */ +#define JOY_HWS_ISGAMEPAD 0x00000020l /* joystick is a game pad */ +#define JOY_HWS_ISCARCTRL 0x00000040l /* joystick is a car controller */ +/* X defaults to J1 X axis */ +#define JOY_HWS_XISJ1Y 0x00000080l /* X is on J1 Y axis */ +#define JOY_HWS_XISJ2X 0x00000100l /* X is on J2 X axis */ +#define JOY_HWS_XISJ2Y 0x00000200l /* X is on J2 Y axis */ +/* Y defaults to J1 Y axis */ +#define JOY_HWS_YISJ1X 0x00000400l /* Y is on J1 X axis */ +#define JOY_HWS_YISJ2X 0x00000800l /* Y is on J2 X axis */ +#define JOY_HWS_YISJ2Y 0x00001000l /* Y is on J2 Y axis */ +/* Z defaults to J2 Y axis */ +#define JOY_HWS_ZISJ1X 0x00002000l /* Z is on J1 X axis */ +#define JOY_HWS_ZISJ1Y 0x00004000l /* Z is on J1 Y axis */ +#define JOY_HWS_ZISJ2X 0x00008000l /* Z is on J2 X axis */ +/* POV defaults to J2 Y axis, if it is not button based */ +#define JOY_HWS_POVISJ1X 0x00010000l /* pov done through J1 X axis */ +#define JOY_HWS_POVISJ1Y 0x00020000l /* pov done through J1 Y axis */ +#define JOY_HWS_POVISJ2X 0x00040000l /* pov done through J2 X axis */ +/* R defaults to J2 X axis */ +#define JOY_HWS_HASR 0x00080000l /* has R (4th axis) info */ +#define JOY_HWS_RISJ1X 0x00100000l /* R done through J1 X axis */ +#define JOY_HWS_RISJ1Y 0x00200000l /* R done through J1 Y axis */ +#define JOY_HWS_RISJ2Y 0x00400000l /* R done through J2 X axis */ +/* U & V for future hardware */ +#define JOY_HWS_HASU 0x00800000l /* has U (5th axis) info */ +#define JOY_HWS_HASV 0x01000000l /* has V (6th axis) info */ + +/* Usage settings */ +#define JOY_US_HASRUDDER 0x00000001l /* joystick configured with rudder */ +#define JOY_US_PRESENT 0x00000002l /* is joystick actually present? */ +#define JOY_US_ISOEM 0x00000004l /* joystick is an OEM defined type */ + +/* reserved for future use -> as link to next possible dword */ +#define JOY_US_RESERVED 0x80000000l /* reserved */ + + +/* Settings for TypeInfo Flags1 */ +#define JOYTYPE_ZEROGAMEENUMOEMDATA 0x00000001l /* Zero GameEnum's OEM data field */ +#define JOYTYPE_NOAUTODETECTGAMEPORT 0x00000002l /* Device does not support Autodetect gameport*/ +#define JOYTYPE_NOHIDDIRECT 0x00000004l /* Do not use HID directly for this device */ +#define JOYTYPE_ANALOGCOMPAT 0x00000008l /* Expose the analog compatible ID */ +#define JOYTYPE_DEFAULTPROPSHEET 0x80000000l /* CPL overrides custom property sheet */ + +/* Settings for TypeInfo Flags2 */ +#define JOYTYPE_DEVICEHIDE 0x00010000l /* Hide unclassified devices */ +#define JOYTYPE_MOUSEHIDE 0x00020000l /* Hide mice */ +#define JOYTYPE_KEYBHIDE 0x00040000l /* Hide keyboards */ +#define JOYTYPE_GAMEHIDE 0x00080000l /* Hide game controllers */ +#define JOYTYPE_HIDEACTIVE 0x00100000l /* Hide flags are active */ +#define JOYTYPE_INFOMASK 0x00E00000l /* Mask for type specific info */ +#define JOYTYPE_INFODEFAULT 0x00000000l /* Use default axis mappings */ +#define JOYTYPE_INFOYYPEDALS 0x00200000l /* Use Y as a combined pedals axis */ +#define JOYTYPE_INFOZYPEDALS 0x00400000l /* Use Z for accelerate, Y for brake */ +#define JOYTYPE_INFOYRPEDALS 0x00600000l /* Use Y for accelerate, R for brake */ +#define JOYTYPE_INFOZRPEDALS 0x00800000l /* Use Z for accelerate, R for brake */ +#define JOYTYPE_INFOZISSLIDER 0x00200000l /* Use Z as a slider */ +#define JOYTYPE_INFOZISZ 0x00400000l /* Use Z as Z axis */ +#define JOYTYPE_ENABLEINPUTREPORT 0x01000000l /* Enable initial input reports */ + +/* struct for storing x,y, z, and rudder values */ +typedef struct joypos_tag { + DWORD dwX; + DWORD dwY; + DWORD dwZ; + DWORD dwR; + DWORD dwU; + DWORD dwV; +} JOYPOS, FAR *LPJOYPOS; + +/* struct for storing ranges */ +typedef struct joyrange_tag { + JOYPOS jpMin; + JOYPOS jpMax; + JOYPOS jpCenter; +} JOYRANGE,FAR *LPJOYRANGE; + +/* + * dwTimeout - value at which to timeout joystick polling + * jrvRanges - range of values app wants returned for axes + * jpDeadZone - area around center to be considered + * as "dead". specified as a percentage + * (0-100). Only X & Y handled by system driver + */ +typedef struct joyreguservalues_tag { + DWORD dwTimeOut; + JOYRANGE jrvRanges; + JOYPOS jpDeadZone; +} JOYREGUSERVALUES, FAR *LPJOYREGUSERVALUES; + +typedef struct joyreghwsettings_tag { + DWORD dwFlags; + DWORD dwNumButtons; +} JOYREGHWSETTINGS, FAR *LPJOYHWSETTINGS; + +/* range of values returned by the hardware (filled in by calibration) */ +/* + * jrvHardware - values returned by hardware + * dwPOVValues - POV values returned by hardware + * dwCalFlags - what has been calibrated + */ +typedef struct joyreghwvalues_tag { + JOYRANGE jrvHardware; + DWORD dwPOVValues[JOY_POV_NUMDIRS]; + DWORD dwCalFlags; +} JOYREGHWVALUES, FAR *LPJOYREGHWVALUES; + +/* hardware configuration */ +/* + * hws - hardware settings + * dwUsageSettings - usage settings + * hwv - values returned by hardware + * dwType - type of joystick + * dwReserved - reserved for OEM drivers + */ +typedef struct joyreghwconfig_tag { + JOYREGHWSETTINGS hws; + DWORD dwUsageSettings; + JOYREGHWVALUES hwv; + DWORD dwType; + DWORD dwReserved; +} JOYREGHWCONFIG, FAR *LPJOYREGHWCONFIG; + +/* joystick calibration info structure */ +typedef struct joycalibrate_tag { + UINT wXbase; + UINT wXdelta; + UINT wYbase; + UINT wYdelta; + UINT wZbase; + UINT wZdelta; +} JOYCALIBRATE; +typedef JOYCALIBRATE FAR *LPJOYCALIBRATE; + +#endif + +#ifndef DIJ_RINGZERO + +#define MAX_JOYSTRING 256 +typedef BOOL (FAR PASCAL * LPDIJOYTYPECALLBACK)(LPCWSTR, LPVOID); + +#ifndef MAX_JOYSTICKOEMVXDNAME +#define MAX_JOYSTICKOEMVXDNAME 260 +#endif + +#define DITC_REGHWSETTINGS 0x00000001 +#define DITC_CLSIDCONFIG 0x00000002 +#define DITC_DISPLAYNAME 0x00000004 +#define DITC_CALLOUT 0x00000008 +#define DITC_HARDWAREID 0x00000010 +#define DITC_FLAGS1 0x00000020 +#define DITC_FLAGS2 0x00000040 +#define DITC_MAPFILE 0x00000080 + + + +/* This structure is defined for DirectX 5.0 compatibility */ + +typedef struct DIJOYTYPEINFO_DX5 { + DWORD dwSize; + JOYREGHWSETTINGS hws; + CLSID clsidConfig; + WCHAR wszDisplayName[MAX_JOYSTRING]; + WCHAR wszCallout[MAX_JOYSTICKOEMVXDNAME]; +} DIJOYTYPEINFO_DX5, *LPDIJOYTYPEINFO_DX5; +typedef const DIJOYTYPEINFO_DX5 *LPCDIJOYTYPEINFO_DX5; + +/* This structure is defined for DirectX 6.1 compatibility */ +typedef struct DIJOYTYPEINFO_DX6 { + DWORD dwSize; + JOYREGHWSETTINGS hws; + CLSID clsidConfig; + WCHAR wszDisplayName[MAX_JOYSTRING]; + WCHAR wszCallout[MAX_JOYSTICKOEMVXDNAME]; + WCHAR wszHardwareId[MAX_JOYSTRING]; + DWORD dwFlags1; +} DIJOYTYPEINFO_DX6, *LPDIJOYTYPEINFO_DX6; +typedef const DIJOYTYPEINFO_DX6 *LPCDIJOYTYPEINFO_DX6; + +typedef struct DIJOYTYPEINFO { + DWORD dwSize; + JOYREGHWSETTINGS hws; + CLSID clsidConfig; + WCHAR wszDisplayName[MAX_JOYSTRING]; + WCHAR wszCallout[MAX_JOYSTICKOEMVXDNAME]; +#if(DIRECTINPUT_VERSION >= 0x05b2) + WCHAR wszHardwareId[MAX_JOYSTRING]; + DWORD dwFlags1; +#if(DIRECTINPUT_VERSION >= 0x0800) + DWORD dwFlags2; + WCHAR wszMapFile[MAX_JOYSTRING]; +#endif /* DIRECTINPUT_VERSION >= 0x0800 */ +#endif /* DIRECTINPUT_VERSION >= 0x05b2 */ +} DIJOYTYPEINFO, *LPDIJOYTYPEINFO; +typedef const DIJOYTYPEINFO *LPCDIJOYTYPEINFO; +#define DIJC_GUIDINSTANCE 0x00000001 +#define DIJC_REGHWCONFIGTYPE 0x00000002 +#define DIJC_GAIN 0x00000004 +#define DIJC_CALLOUT 0x00000008 +#define DIJC_WDMGAMEPORT 0x00000010 + +/* This structure is defined for DirectX 5.0 compatibility */ + +typedef struct DIJOYCONFIG_DX5 { + DWORD dwSize; + GUID guidInstance; + JOYREGHWCONFIG hwc; + DWORD dwGain; + WCHAR wszType[MAX_JOYSTRING]; + WCHAR wszCallout[MAX_JOYSTRING]; +} DIJOYCONFIG_DX5, *LPDIJOYCONFIG_DX5; +typedef const DIJOYCONFIG_DX5 *LPCDIJOYCONFIG_DX5; + +typedef struct DIJOYCONFIG { + DWORD dwSize; + GUID guidInstance; + JOYREGHWCONFIG hwc; + DWORD dwGain; + WCHAR wszType[MAX_JOYSTRING]; + WCHAR wszCallout[MAX_JOYSTRING]; +#if(DIRECTINPUT_VERSION >= 0x05b2) + GUID guidGameport; +#endif /* DIRECTINPUT_VERSION >= 0x05b2 */ + } DIJOYCONFIG, *LPDIJOYCONFIG; +typedef const DIJOYCONFIG *LPCDIJOYCONFIG; + + +#define DIJU_USERVALUES 0x00000001 +#define DIJU_GLOBALDRIVER 0x00000002 +#define DIJU_GAMEPORTEMULATOR 0x00000004 + +typedef struct DIJOYUSERVALUES { + DWORD dwSize; + JOYREGUSERVALUES ruv; + WCHAR wszGlobalDriver[MAX_JOYSTRING]; + WCHAR wszGameportEmulator[MAX_JOYSTRING]; +} DIJOYUSERVALUES, *LPDIJOYUSERVALUES; +typedef const DIJOYUSERVALUES *LPCDIJOYUSERVALUES; + +DEFINE_GUID(GUID_KeyboardClass, 0x4D36E96B,0xE325,0x11CE,0xBF,0xC1,0x08,0x00,0x2B,0xE1,0x03,0x18); +DEFINE_GUID(GUID_MediaClass, 0x4D36E96C,0xE325,0x11CE,0xBF,0xC1,0x08,0x00,0x2B,0xE1,0x03,0x18); +DEFINE_GUID(GUID_MouseClass, 0x4D36E96F,0xE325,0x11CE,0xBF,0xC1,0x08,0x00,0x2B,0xE1,0x03,0x18); +DEFINE_GUID(GUID_HIDClass, 0x745A17A0,0x74D3,0x11D0,0xB6,0xFE,0x00,0xA0,0xC9,0x0F,0x57,0xDA); + +#undef INTERFACE +#define INTERFACE IDirectInputJoyConfig + +DECLARE_INTERFACE_(IDirectInputJoyConfig, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, LPVOID * ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirectInputJoyConfig methods ***/ + STDMETHOD(Acquire)(THIS) PURE; + STDMETHOD(Unacquire)(THIS) PURE; + STDMETHOD(SetCooperativeLevel)(THIS_ HWND,DWORD) PURE; + STDMETHOD(SendNotify)(THIS) PURE; + STDMETHOD(EnumTypes)(THIS_ LPDIJOYTYPECALLBACK,LPVOID) PURE; + STDMETHOD(GetTypeInfo)(THIS_ LPCWSTR,LPDIJOYTYPEINFO,DWORD) PURE; + STDMETHOD(SetTypeInfo)(THIS_ LPCWSTR,LPCDIJOYTYPEINFO,DWORD) PURE; + STDMETHOD(DeleteType)(THIS_ LPCWSTR) PURE; + STDMETHOD(GetConfig)(THIS_ UINT,LPDIJOYCONFIG,DWORD) PURE; + STDMETHOD(SetConfig)(THIS_ UINT,LPCDIJOYCONFIG,DWORD) PURE; + STDMETHOD(DeleteConfig)(THIS_ UINT) PURE; + STDMETHOD(GetUserValues)(THIS_ LPDIJOYUSERVALUES,DWORD) PURE; + STDMETHOD(SetUserValues)(THIS_ LPCDIJOYUSERVALUES,DWORD) PURE; + STDMETHOD(AddNewHardware)(THIS_ HWND,REFGUID) PURE; + STDMETHOD(OpenTypeKey)(THIS_ LPCWSTR,DWORD,PHKEY) PURE; + STDMETHOD(OpenConfigKey)(THIS_ UINT,DWORD,PHKEY) PURE; +}; + +typedef struct IDirectInputJoyConfig *LPDIRECTINPUTJOYCONFIG; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirectInputJoyConfig_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirectInputJoyConfig_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirectInputJoyConfig_Release(p) (p)->lpVtbl->Release(p) +#define IDirectInputJoyConfig_Acquire(p) (p)->lpVtbl->Acquire(p) +#define IDirectInputJoyConfig_Unacquire(p) (p)->lpVtbl->Unacquire(p) +#define IDirectInputJoyConfig_SetCooperativeLevel(p,a,b) (p)->lpVtbl->SetCooperativeLevel(p,a,b) +#define IDirectInputJoyConfig_SendNotify(p) (p)->lpVtbl->SendNotify(p) +#define IDirectInputJoyConfig_EnumTypes(p,a,b) (p)->lpVtbl->EnumTypes(p,a,b) +#define IDirectInputJoyConfig_GetTypeInfo(p,a,b,c) (p)->lpVtbl->GetTypeInfo(p,a,b,c) +#define IDirectInputJoyConfig_SetTypeInfo(p,a,b,c) (p)->lpVtbl->SetTypeInfo(p,a,b,c) +#define IDirectInputJoyConfig_DeleteType(p,a) (p)->lpVtbl->DeleteType(p,a) +#define IDirectInputJoyConfig_GetConfig(p,a,b,c) (p)->lpVtbl->GetConfig(p,a,b,c) +#define IDirectInputJoyConfig_SetConfig(p,a,b,c) (p)->lpVtbl->SetConfig(p,a,b,c) +#define IDirectInputJoyConfig_DeleteConfig(p,a) (p)->lpVtbl->DeleteConfig(p,a) +#define IDirectInputJoyConfig_GetUserValues(p,a,b) (p)->lpVtbl->GetUserValues(p,a,b) +#define IDirectInputJoyConfig_SetUserValues(p,a,b) (p)->lpVtbl->SetUserValues(p,a,b) +#define IDirectInputJoyConfig_AddNewHardware(p,a,b) (p)->lpVtbl->AddNewHardware(p,a,b) +#define IDirectInputJoyConfig_OpenTypeKey(p,a,b,c) (p)->lpVtbl->OpenTypeKey(p,a,b,c) +#define IDirectInputJoyConfig_OpenConfigKey(p,a,b,c) (p)->lpVtbl->OpenConfigKey(p,a,b,c) +#else +#define IDirectInputJoyConfig_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirectInputJoyConfig_AddRef(p) (p)->AddRef() +#define IDirectInputJoyConfig_Release(p) (p)->Release() +#define IDirectInputJoyConfig_Acquire(p) (p)->Acquire() +#define IDirectInputJoyConfig_Unacquire(p) (p)->Unacquire() +#define IDirectInputJoyConfig_SetCooperativeLevel(p,a,b) (p)->SetCooperativeLevel(a,b) +#define IDirectInputJoyConfig_SendNotify(p) (p)->SendNotify() +#define IDirectInputJoyConfig_EnumTypes(p,a,b) (p)->EnumTypes(a,b) +#define IDirectInputJoyConfig_GetTypeInfo(p,a,b,c) (p)->GetTypeInfo(a,b,c) +#define IDirectInputJoyConfig_SetTypeInfo(p,a,b,c) (p)->SetTypeInfo(a,b,c) +#define IDirectInputJoyConfig_DeleteType(p,a) (p)->DeleteType(a) +#define IDirectInputJoyConfig_GetConfig(p,a,b,c) (p)->GetConfig(a,b,c) +#define IDirectInputJoyConfig_SetConfig(p,a,b,c) (p)->SetConfig(a,b,c) +#define IDirectInputJoyConfig_DeleteConfig(p,a) (p)->DeleteConfig(a) +#define IDirectInputJoyConfig_GetUserValues(p,a,b) (p)->GetUserValues(a,b) +#define IDirectInputJoyConfig_SetUserValues(p,a,b) (p)->SetUserValues(a,b) +#define IDirectInputJoyConfig_AddNewHardware(p,a,b) (p)->AddNewHardware(a,b) +#define IDirectInputJoyConfig_OpenTypeKey(p,a,b,c) (p)->OpenTypeKey(a,b,c) +#define IDirectInputJoyConfig_OpenConfigKey(p,a,b,c) (p)->OpenConfigKey(a,b,c) +#endif + +#endif /* DIJ_RINGZERO */ + +#if(DIRECTINPUT_VERSION >= 0x0800) + +#ifndef DIJ_RINGZERO + +#undef INTERFACE +#define INTERFACE IDirectInputJoyConfig8 + +DECLARE_INTERFACE_(IDirectInputJoyConfig8, IUnknown) +{ + /*** IUnknown methods ***/ + STDMETHOD(QueryInterface)(THIS_ REFIID riid, LPVOID * ppvObj) PURE; + STDMETHOD_(ULONG,AddRef)(THIS) PURE; + STDMETHOD_(ULONG,Release)(THIS) PURE; + + /*** IDirectInputJoyConfig8 methods ***/ + STDMETHOD(Acquire)(THIS) PURE; + STDMETHOD(Unacquire)(THIS) PURE; + STDMETHOD(SetCooperativeLevel)(THIS_ HWND,DWORD) PURE; + STDMETHOD(SendNotify)(THIS) PURE; + STDMETHOD(EnumTypes)(THIS_ LPDIJOYTYPECALLBACK,LPVOID) PURE; + STDMETHOD(GetTypeInfo)(THIS_ LPCWSTR,LPDIJOYTYPEINFO,DWORD) PURE; + STDMETHOD(SetTypeInfo)(THIS_ LPCWSTR,LPCDIJOYTYPEINFO,DWORD,LPWSTR) PURE; + STDMETHOD(DeleteType)(THIS_ LPCWSTR) PURE; + STDMETHOD(GetConfig)(THIS_ UINT,LPDIJOYCONFIG,DWORD) PURE; + STDMETHOD(SetConfig)(THIS_ UINT,LPCDIJOYCONFIG,DWORD) PURE; + STDMETHOD(DeleteConfig)(THIS_ UINT) PURE; + STDMETHOD(GetUserValues)(THIS_ LPDIJOYUSERVALUES,DWORD) PURE; + STDMETHOD(SetUserValues)(THIS_ LPCDIJOYUSERVALUES,DWORD) PURE; + STDMETHOD(AddNewHardware)(THIS_ HWND,REFGUID) PURE; + STDMETHOD(OpenTypeKey)(THIS_ LPCWSTR,DWORD,PHKEY) PURE; + STDMETHOD(OpenAppStatusKey)(THIS_ PHKEY) PURE; +}; + +typedef struct IDirectInputJoyConfig8 *LPDIRECTINPUTJOYCONFIG8; + +#if !defined(__cplusplus) || defined(CINTERFACE) +#define IDirectInputJoyConfig8_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b) +#define IDirectInputJoyConfig8_AddRef(p) (p)->lpVtbl->AddRef(p) +#define IDirectInputJoyConfig8_Release(p) (p)->lpVtbl->Release(p) +#define IDirectInputJoyConfig8_Acquire(p) (p)->lpVtbl->Acquire(p) +#define IDirectInputJoyConfig8_Unacquire(p) (p)->lpVtbl->Unacquire(p) +#define IDirectInputJoyConfig8_SetCooperativeLevel(p,a,b) (p)->lpVtbl->SetCooperativeLevel(p,a,b) +#define IDirectInputJoyConfig8_SendNotify(p) (p)->lpVtbl->SendNotify(p) +#define IDirectInputJoyConfig8_EnumTypes(p,a,b) (p)->lpVtbl->EnumTypes(p,a,b) +#define IDirectInputJoyConfig8_GetTypeInfo(p,a,b,c) (p)->lpVtbl->GetTypeInfo(p,a,b,c) +#define IDirectInputJoyConfig8_SetTypeInfo(p,a,b,c,d) (p)->lpVtbl->SetTypeInfo(p,a,b,c,d) +#define IDirectInputJoyConfig8_DeleteType(p,a) (p)->lpVtbl->DeleteType(p,a) +#define IDirectInputJoyConfig8_GetConfig(p,a,b,c) (p)->lpVtbl->GetConfig(p,a,b,c) +#define IDirectInputJoyConfig8_SetConfig(p,a,b,c) (p)->lpVtbl->SetConfig(p,a,b,c) +#define IDirectInputJoyConfig8_DeleteConfig(p,a) (p)->lpVtbl->DeleteConfig(p,a) +#define IDirectInputJoyConfig8_GetUserValues(p,a,b) (p)->lpVtbl->GetUserValues(p,a,b) +#define IDirectInputJoyConfig8_SetUserValues(p,a,b) (p)->lpVtbl->SetUserValues(p,a,b) +#define IDirectInputJoyConfig8_AddNewHardware(p,a,b) (p)->lpVtbl->AddNewHardware(p,a,b) +#define IDirectInputJoyConfig8_OpenTypeKey(p,a,b,c) (p)->lpVtbl->OpenTypeKey(p,a,b,c) +#define IDirectInputJoyConfig8_OpenAppStatusKey(p,a) (p)->lpVtbl->OpenAppStatusKey(p,a) +#else +#define IDirectInputJoyConfig8_QueryInterface(p,a,b) (p)->QueryInterface(a,b) +#define IDirectInputJoyConfig8_AddRef(p) (p)->AddRef() +#define IDirectInputJoyConfig8_Release(p) (p)->Release() +#define IDirectInputJoyConfig8_Acquire(p) (p)->Acquire() +#define IDirectInputJoyConfig8_Unacquire(p) (p)->Unacquire() +#define IDirectInputJoyConfig8_SetCooperativeLevel(p,a,b) (p)->SetCooperativeLevel(a,b) +#define IDirectInputJoyConfig8_SendNotify(p) (p)->SendNotify() +#define IDirectInputJoyConfig8_EnumTypes(p,a,b) (p)->EnumTypes(a,b) +#define IDirectInputJoyConfig8_GetTypeInfo(p,a,b,c) (p)->GetTypeInfo(a,b,c) +#define IDirectInputJoyConfig8_SetTypeInfo(p,a,b,c,d) (p)->SetTypeInfo(a,b,c,d) +#define IDirectInputJoyConfig8_DeleteType(p,a) (p)->DeleteType(a) +#define IDirectInputJoyConfig8_GetConfig(p,a,b,c) (p)->GetConfig(a,b,c) +#define IDirectInputJoyConfig8_SetConfig(p,a,b,c) (p)->SetConfig(a,b,c) +#define IDirectInputJoyConfig8_DeleteConfig(p,a) (p)->DeleteConfig(a) +#define IDirectInputJoyConfig8_GetUserValues(p,a,b) (p)->GetUserValues(a,b) +#define IDirectInputJoyConfig8_SetUserValues(p,a,b) (p)->SetUserValues(a,b) +#define IDirectInputJoyConfig8_AddNewHardware(p,a,b) (p)->AddNewHardware(a,b) +#define IDirectInputJoyConfig8_OpenTypeKey(p,a,b,c) (p)->OpenTypeKey(a,b,c) +#define IDirectInputJoyConfig8_OpenAppStatusKey(p,a) (p)->OpenAppStatusKey(a) +#endif + +#endif /* DIJ_RINGZERO */ + +/**************************************************************************** + * + * Notification Messages + * + ****************************************************************************/ + +/* RegisterWindowMessage with this to get DirectInput notification messages */ +#define DIRECTINPUT_NOTIFICATION_MSGSTRINGA "DIRECTINPUT_NOTIFICATION_MSGSTRING" +#define DIRECTINPUT_NOTIFICATION_MSGSTRINGW L"DIRECTINPUT_NOTIFICATION_MSGSTRING" + +#ifdef UNICODE +#define DIRECTINPUT_NOTIFICATION_MSGSTRING DIRECTINPUT_NOTIFICATION_MSGSTRINGW +#else +#define DIRECTINPUT_NOTIFICATION_MSGSTRING DIRECTINPUT_NOTIFICATION_MSGSTRINGA +#endif + +#define DIMSGWP_NEWAPPSTART 0x00000001 +#define DIMSGWP_DX8APPSTART 0x00000002 +#define DIMSGWP_DX8MAPPERAPPSTART 0x00000003 + +#endif /* DIRECTINPUT_VERSION >= 0x0800 */ + +#define DIAPPIDFLAG_NOTIME 0x00000001 +#define DIAPPIDFLAG_NOSIZE 0x00000002 + +#define DIRECTINPUT_REGSTR_VAL_APPIDFLAGA "AppIdFlag" +#define DIRECTINPUT_REGSTR_KEY_LASTAPPA "MostRecentApplication" +#define DIRECTINPUT_REGSTR_KEY_LASTMAPAPPA "MostRecentMapperApplication" +#define DIRECTINPUT_REGSTR_VAL_VERSIONA "Version" +#define DIRECTINPUT_REGSTR_VAL_NAMEA "Name" +#define DIRECTINPUT_REGSTR_VAL_IDA "Id" +#define DIRECTINPUT_REGSTR_VAL_MAPPERA "UsesMapper" +#define DIRECTINPUT_REGSTR_VAL_LASTSTARTA "MostRecentStart" + +#define DIRECTINPUT_REGSTR_VAL_APPIDFLAGW L"AppIdFlag" +#define DIRECTINPUT_REGSTR_KEY_LASTAPPW L"MostRecentApplication" +#define DIRECTINPUT_REGSTR_KEY_LASTMAPAPPW L"MostRecentMapperApplication" +#define DIRECTINPUT_REGSTR_VAL_VERSIONW L"Version" +#define DIRECTINPUT_REGSTR_VAL_NAMEW L"Name" +#define DIRECTINPUT_REGSTR_VAL_IDW L"Id" +#define DIRECTINPUT_REGSTR_VAL_MAPPERW L"UsesMapper" +#define DIRECTINPUT_REGSTR_VAL_LASTSTARTW L"MostRecentStart" + +#ifdef UNICODE +#define DIRECTINPUT_REGSTR_VAL_APPIDFLAG DIRECTINPUT_REGSTR_VAL_APPIDFLAGW +#define DIRECTINPUT_REGSTR_KEY_LASTAPP DIRECTINPUT_REGSTR_KEY_LASTAPPW +#define DIRECTINPUT_REGSTR_KEY_LASTMAPAPP DIRECTINPUT_REGSTR_KEY_LASTMAPAPPW +#define DIRECTINPUT_REGSTR_VAL_VERSION DIRECTINPUT_REGSTR_VAL_VERSIONW +#define DIRECTINPUT_REGSTR_VAL_NAME DIRECTINPUT_REGSTR_VAL_NAMEW +#define DIRECTINPUT_REGSTR_VAL_ID DIRECTINPUT_REGSTR_VAL_IDW +#define DIRECTINPUT_REGSTR_VAL_MAPPER DIRECTINPUT_REGSTR_VAL_MAPPERW +#define DIRECTINPUT_REGSTR_VAL_LASTSTART DIRECTINPUT_REGSTR_VAL_LASTSTARTW +#else +#define DIRECTINPUT_REGSTR_VAL_APPIDFLAG DIRECTINPUT_REGSTR_VAL_APPIDFLAGA +#define DIRECTINPUT_REGSTR_KEY_LASTAPP DIRECTINPUT_REGSTR_KEY_LASTAPPA +#define DIRECTINPUT_REGSTR_KEY_LASTMAPAPP DIRECTINPUT_REGSTR_KEY_LASTMAPAPPA +#define DIRECTINPUT_REGSTR_VAL_VERSION DIRECTINPUT_REGSTR_VAL_VERSIONA +#define DIRECTINPUT_REGSTR_VAL_NAME DIRECTINPUT_REGSTR_VAL_NAMEA +#define DIRECTINPUT_REGSTR_VAL_ID DIRECTINPUT_REGSTR_VAL_IDA +#define DIRECTINPUT_REGSTR_VAL_MAPPER DIRECTINPUT_REGSTR_VAL_MAPPERA +#define DIRECTINPUT_REGSTR_VAL_LASTSTART DIRECTINPUT_REGSTR_VAL_LASTSTARTA +#endif + + +/**************************************************************************** + * + * Return Codes + * + ****************************************************************************/ + +#define DIERR_NOMOREITEMS \ + MAKE_HRESULT(SEVERITY_ERROR, FACILITY_WIN32, ERROR_NO_MORE_ITEMS) + +/* + * Device driver-specific codes. + */ + +#define DIERR_DRIVERFIRST 0x80040300L +#define DIERR_DRIVERLAST 0x800403FFL + +/* + * Unless the specific driver has been precisely identified, no meaning + * should be attributed to these values other than that the driver + * originated the error. However, to illustrate the types of error that + * may be causing the failure, the PID force feedback driver distributed + * with DirectX 7 could return the following errors: + * + * DIERR_DRIVERFIRST + 1 + * The requested usage was not found. + * DIERR_DRIVERFIRST + 2 + * The parameter block couldn't be downloaded to the device. + * DIERR_DRIVERFIRST + 3 + * PID initialization failed. + * DIERR_DRIVERFIRST + 4 + * The provided values couldn't be scaled. + */ + + +/* + * Device installer errors. + */ + +/* + * Registry entry or DLL for class installer invalid + * or class installer not found. + */ +#define DIERR_INVALIDCLASSINSTALLER 0x80040400L + +/* + * The user cancelled the install operation. + */ +#define DIERR_CANCELLED 0x80040401L + +/* + * The INF file for the selected device could not be + * found or is invalid or is damaged. + */ +#define DIERR_BADINF 0x80040402L + +/**************************************************************************** + * + * Map files + * + ****************************************************************************/ + +/* + * Delete particular data from default map file. + */ +#define DIDIFT_DELETE 0x01000000 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#ifdef __cplusplus +}; +#endif + +#endif /* __DINPUTD_INCLUDED__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/diskguid.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/diskguid.h new file mode 100644 index 0000000000000000000000000000000000000000..900762ef327638e9b5ecd53fdd67a639c4c2e67f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/diskguid.h @@ -0,0 +1,98 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + diskguid.h + +Abstract: + + GPT disk GUIDs. + +Revision History: + +--*/ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// GPT Partition Type GUIDs +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// + +#ifdef DEFINE_GUID + +// +// Make sure FAR is defined... +// +#ifndef FAR +#ifdef _WIN32 +#define FAR +#else +#define FAR _far +#endif +#endif + + +// +// Define the GPT partition guids known by disk drivers and volume managers. +// + +DEFINE_GUID(PARTITION_BASIC_DATA_GUID, 0xEBD0A0A2L, 0xB9E5, 0x4433, 0x87, 0xC0, 0x68, 0xB6, 0xB7, 0x26, 0x99, 0xC7); // Basic data partition +DEFINE_GUID(PARTITION_BSP_GUID, 0x57434F53L, 0x4DF9, 0x45B9, 0x8E, 0x9E, 0x23, 0x70, 0xF0, 0x06, 0x45, 0x7C); // BSP partition +DEFINE_GUID(PARTITION_CLUSTER_GUID, 0xDB97DBA9L, 0x0840, 0x4BAE, 0x97, 0xF0, 0xFF, 0xB9, 0xA3, 0x27, 0xC7, 0xE1); // Cluster metadata partition +DEFINE_GUID(PARTITION_DPP_GUID, 0x57434F53L, 0x94CB, 0x43F0, 0xA5, 0x33, 0xD7, 0x3C, 0x10, 0xCF, 0xA5, 0x7D); // DPP partition +DEFINE_GUID(PARTITION_ENTRY_UNUSED_GUID, 0x00000000L, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00); // Entry unused +DEFINE_GUID(PARTITION_LDM_DATA_GUID, 0xAF9B60A0L, 0x1431, 0x4F62, 0xBC, 0x68, 0x33, 0x11, 0x71, 0x4A, 0x69, 0xAD); // Logical Disk Manager data partition +DEFINE_GUID(PARTITION_LDM_METADATA_GUID, 0x5808C8AAL, 0x7E8F, 0x42E0, 0x85, 0xD2, 0xE1, 0xE9, 0x04, 0x34, 0xCF, 0xB3); // Logical Disk Manager metadata partition +DEFINE_GUID(PARTITION_MAIN_OS_GUID, 0x57434F53L, 0x8F45, 0x405E, 0x8A, 0x23, 0x18, 0x6D, 0x8A, 0x43, 0x30, 0xD3); // Main OS partition +DEFINE_GUID(PARTITION_MSFT_RECOVERY_GUID, 0xDE94BBA4L, 0x06D1, 0x4D40, 0xA1, 0x6A, 0xBF, 0xD5, 0x01, 0x79, 0xD6, 0xAC); // Microsoft recovery partition +DEFINE_GUID(PARTITION_MSFT_RESERVED_GUID, 0xE3C9E316L, 0x0B5C, 0x4DB8, 0x81, 0x7D, 0xF9, 0x2D, 0xF0, 0x02, 0x15, 0xAE); // Microsoft reserved space +DEFINE_GUID(PARTITION_MSFT_SNAPSHOT_GUID, 0xCADDEBF1L, 0x4400, 0x4DE8, 0xB1, 0x03, 0x12, 0x11, 0x7D, 0xCF, 0x3C, 0xCF); // Microsoft shadow copy partition +DEFINE_GUID(PARTITION_OS_DATA_GUID, 0x57434F53L, 0x23F2, 0x44D5, 0xA8, 0x30, 0x67, 0xBB, 0xDA, 0xA6, 0x09, 0xF9); // OS data partition +DEFINE_GUID(PARTITION_PATCH_GUID, 0x8967A686L, 0x96AA, 0x6AA8, 0x95, 0x89, 0xA8, 0x42, 0x56, 0x54, 0x10, 0x90); // Patch partition +DEFINE_GUID(PARTITION_PRE_INSTALLED_GUID, 0x57434F53L, 0x7FE0, 0x4196, 0x9B, 0x42, 0x42, 0x7B, 0x51, 0x64, 0x34, 0x84); // PreInstalled partition +DEFINE_GUID(PARTITION_SBL_CACHE_SSD_GUID, 0xeeff8352L, 0xdd2a, 0x44db, 0xae, 0x83, 0xbe, 0xe1, 0xcf, 0x74, 0x81, 0xdc); // Storage Bus Layer Cache partition +DEFINE_GUID(PARTITION_SBL_CACHE_SSD_RESERVED_GUID, 0xdcc0c7c1L, 0x55ad, 0x4f17, 0x9d, 0x43, 0x4b, 0xc7, 0x76, 0xe0, 0x11, 0x7e); // Storage Bus Layer Cache partition +DEFINE_GUID(PARTITION_SBL_CACHE_HDD_GUID, 0x03aaa829L, 0xebfc, 0x4e7e, 0xaa, 0xc9, 0xc4, 0xd7, 0x6c, 0x63, 0xb2, 0x4b); // Storage Bus Layer Cache partition +DEFINE_GUID(PARTITION_SERVICING_FILES_GUID, 0x57434F53L, 0x432E, 0x4014, 0xAE, 0x4C, 0x8D, 0xEA, 0xA9, 0xC0, 0x00, 0x6A); // Servicing files partition +DEFINE_GUID(PARTITION_SERVICING_METADATA_GUID, 0x57434F53L, 0xC691, 0x4A05, 0xBB, 0x4E, 0x70, 0x3D, 0xAF, 0xD2, 0x29, 0xCE); // Servicing metadata partition +DEFINE_GUID(PARTITION_SERVICING_RESERVE_GUID, 0x57434F53L, 0x4B81, 0x460B, 0xA3, 0x19, 0xFF, 0xB6, 0xFE, 0x13, 0x6D, 0x14); // Servicing reserve partition +DEFINE_GUID(PARTITION_SERVICING_STAGING_ROOT_GUID, 0x57434F53L, 0xE84d, 0x4E84, 0xAA, 0xF3, 0xEC, 0xBB, 0xBD, 0x04, 0xB9, 0xDF); // Servicing staging root partition +DEFINE_GUID(PARTITION_SPACES_GUID, 0xE75CAF8FL, 0xF680, 0x4CEE, 0xAF, 0xA3, 0xB0, 0x01, 0xE5, 0x6E, 0xFC, 0x2D); // Storage Spaces protective partition +DEFINE_GUID(PARTITION_SPACES_DATA_GUID, 0xE7ADDCB4L, 0xDC34, 0x4539, 0x9A, 0x76, 0xEB, 0xBD, 0x07, 0xBE, 0x6F, 0x7E); // Storage Spaces protective partition +DEFINE_GUID(PARTITION_SYSTEM_GUID, 0xC12A7328L, 0xF81F, 0x11D2, 0xBA, 0x4B, 0x00, 0xA0, 0xC9, 0x3E, 0xC9, 0x3B); // EFI system partition +DEFINE_GUID(PARTITION_WINDOWS_SYSTEM_GUID, 0x57434F53L, 0xE3E3, 0x4631, 0xA5, 0xC5, 0x26, 0xD2, 0x24, 0x38, 0x73, 0xAA); // Windows system partition +#endif + +#ifdef __cplusplus +#define IsEqualPartitionType IsEqualGUID +#else +#define IsEqualPartitionType(_a, _b) IsEqualGUID(&(_a), &(_b)) +#endif + +#define IsRecognizedGptPartition(_t) ( \ + IsEqualPartitionType((_t), PARTITION_BSP_GUID) || \ + IsEqualPartitionType((_t), PARTITION_DPP_GUID) || \ + IsEqualPartitionType((_t), PARTITION_BASIC_DATA_GUID) || \ + IsEqualPartitionType((_t), PARTITION_MAIN_OS_GUID) || \ + IsEqualPartitionType((_t), PARTITION_MSFT_RECOVERY_GUID) || \ + IsEqualPartitionType((_t), PARTITION_OS_DATA_GUID) || \ + IsEqualPartitionType((_t), PARTITION_PRE_INSTALLED_GUID) || \ + IsEqualPartitionType((_t), PARTITION_SERVICING_FILES_GUID) || \ + IsEqualPartitionType((_t), PARTITION_SERVICING_METADATA_GUID) || \ + IsEqualPartitionType((_t), PARTITION_SERVICING_RESERVE_GUID) || \ + IsEqualPartitionType((_t), PARTITION_SERVICING_STAGING_ROOT_GUID) || \ + IsEqualPartitionType((_t), PARTITION_WINDOWS_SYSTEM_GUID)) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls1.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls1.h new file mode 100644 index 0000000000000000000000000000000000000000..eec26dfcb70f4f294d27b0645b10b80f8a65d125 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls1.h @@ -0,0 +1,284 @@ + + +/*==========================================================================; +// +// dls1.h +// +// +// Description: +// +// Interface defines and structures for the Instrument Collection Form +// RIFF DLS. +// +// +// Written by Sonic Foundry 1996. Released for public use. +// +//=========================================================================*/ + +//-------------------------------------------------------------------------- +// The file dls1.h was reviewed by LCA in June 2011 and per license is +// acceptable for Microsoft use under Dealpoint ID 109444 +//-------------------------------------------------------------------------- + +#ifndef _INC_DLS1 +#define _INC_DLS1 + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/*////////////////////////////////////////////////////////////////////////// +// +// +// Layout of an instrument collection: +// +// +// RIFF [] 'DLS ' [dlid,colh,INSTLIST,WAVEPOOL,INFOLIST] +// +// INSTLIST +// LIST [] 'lins' +// LIST [] 'ins ' [dlid,insh,RGNLIST,ARTLIST,INFOLIST] +// LIST [] 'ins ' [dlid,insh,RGNLIST,ARTLIST,INFOLIST] +// LIST [] 'ins ' [dlid,insh,RGNLIST,ARTLIST,INFOLIST] +// +// RGNLIST +// LIST [] 'lrgn' +// LIST [] 'rgn ' [rgnh,wsmp,wlnk,ARTLIST] +// LIST [] 'rgn ' [rgnh,wsmp,wlnk,ARTLIST] +// LIST [] 'rgn ' [rgnh,wsmp,wlnk,ARTLIST] +// +// ARTLIST +// LIST [] 'lart' +// 'art1' level 1 Articulation connection graph +// 'art2' level 2 Articulation connection graph +// '3rd1' Possible 3rd party articulation structure 1 +// '3rd2' Possible 3rd party articulation structure 2 .... and so on +// +// WAVEPOOL +// ptbl [] [pool table] +// LIST [] 'wvpl' +// [path], +// [path], +// LIST [] 'wave' [dlid,RIFFWAVE] +// LIST [] 'wave' [dlid,RIFFWAVE] +// LIST [] 'wave' [dlid,RIFFWAVE] +// LIST [] 'wave' [dlid,RIFFWAVE] +// LIST [] 'wave' [dlid,RIFFWAVE] +// +// INFOLIST +// LIST [] 'INFO' +// 'icmt' 'Comment.' +// 'icop' 'Copyright (C) Someone' +// +/////////////////////////////////////////////////////////////////////////*/ + + +/*///////////////////////////////////////////////////////////////////////// +// FOURCC's used in the DLS file +/////////////////////////////////////////////////////////////////////////*/ + +#define FOURCC_DLS mmioFOURCC('D','L','S',' ') +#define FOURCC_DLID mmioFOURCC('d','l','i','d') +#define FOURCC_COLH mmioFOURCC('c','o','l','h') +#define FOURCC_WVPL mmioFOURCC('w','v','p','l') +#define FOURCC_PTBL mmioFOURCC('p','t','b','l') +#define FOURCC_PATH mmioFOURCC('p','a','t','h') +#define FOURCC_wave mmioFOURCC('w','a','v','e') +#define FOURCC_LINS mmioFOURCC('l','i','n','s') +#define FOURCC_INS mmioFOURCC('i','n','s',' ') +#define FOURCC_INSH mmioFOURCC('i','n','s','h') +#define FOURCC_LRGN mmioFOURCC('l','r','g','n') +#define FOURCC_RGN mmioFOURCC('r','g','n',' ') +#define FOURCC_RGNH mmioFOURCC('r','g','n','h') +#define FOURCC_LART mmioFOURCC('l','a','r','t') +#define FOURCC_ART1 mmioFOURCC('a','r','t','1') +#define FOURCC_WLNK mmioFOURCC('w','l','n','k') +#define FOURCC_WSMP mmioFOURCC('w','s','m','p') +#define FOURCC_VERS mmioFOURCC('v','e','r','s') + +/*///////////////////////////////////////////////////////////////////////// +// Articulation connection graph definitions +/////////////////////////////////////////////////////////////////////////*/ + +/* Generic Sources */ +#define CONN_SRC_NONE 0x0000 +#define CONN_SRC_LFO 0x0001 +#define CONN_SRC_KEYONVELOCITY 0x0002 +#define CONN_SRC_KEYNUMBER 0x0003 +#define CONN_SRC_EG1 0x0004 +#define CONN_SRC_EG2 0x0005 +#define CONN_SRC_PITCHWHEEL 0x0006 + +/* Midi Controllers 0-127 */ +#define CONN_SRC_CC1 0x0081 +#define CONN_SRC_CC7 0x0087 +#define CONN_SRC_CC10 0x008a +#define CONN_SRC_CC11 0x008b + +/* Generic Destinations */ +#define CONN_DST_NONE 0x0000 +#define CONN_DST_ATTENUATION 0x0001 +#define CONN_DST_PITCH 0x0003 +#define CONN_DST_PAN 0x0004 + +/* LFO Destinations */ +#define CONN_DST_LFO_FREQUENCY 0x0104 +#define CONN_DST_LFO_STARTDELAY 0x0105 + +/* EG1 Destinations */ +#define CONN_DST_EG1_ATTACKTIME 0x0206 +#define CONN_DST_EG1_DECAYTIME 0x0207 +#define CONN_DST_EG1_RELEASETIME 0x0209 +#define CONN_DST_EG1_SUSTAINLEVEL 0x020a + +/* EG2 Destinations */ +#define CONN_DST_EG2_ATTACKTIME 0x030a +#define CONN_DST_EG2_DECAYTIME 0x030b +#define CONN_DST_EG2_RELEASETIME 0x030d +#define CONN_DST_EG2_SUSTAINLEVEL 0x030e + +#define CONN_TRN_NONE 0x0000 +#define CONN_TRN_CONCAVE 0x0001 + +typedef struct _DLSID { + ULONG ulData1; + USHORT usData2; + USHORT usData3; + BYTE abData4[8]; +} DLSID, FAR *LPDLSID; + +typedef struct _DLSVERSION { + DWORD dwVersionMS; + DWORD dwVersionLS; +}DLSVERSION, FAR *LPDLSVERSION; + + +typedef struct _CONNECTION { + USHORT usSource; + USHORT usControl; + USHORT usDestination; + USHORT usTransform; + LONG lScale; + }CONNECTION, FAR *LPCONNECTION; + + +/* Level 1 Articulation Data */ + +typedef struct _CONNECTIONLIST { + ULONG cbSize; /* size of the connection list structure */ + ULONG cConnections; /* count of connections in the list */ + } CONNECTIONLIST, FAR *LPCONNECTIONLIST; + + + +/*///////////////////////////////////////////////////////////////////////// +// Generic type defines for regions and instruments +/////////////////////////////////////////////////////////////////////////*/ + +typedef struct _RGNRANGE { + USHORT usLow; + USHORT usHigh; +}RGNRANGE, FAR * LPRGNRANGE; + +#define F_INSTRUMENT_DRUMS 0x80000000 + +typedef struct _MIDILOCALE { + ULONG ulBank; + ULONG ulInstrument; +}MIDILOCALE, FAR *LPMIDILOCALE; + +/*///////////////////////////////////////////////////////////////////////// +// Header structures found in an DLS file for collection, instruments, and +// regions. +/////////////////////////////////////////////////////////////////////////*/ + +#define F_RGN_OPTION_SELFNONEXCLUSIVE 0x0001 + +typedef struct _RGNHEADER { + RGNRANGE RangeKey; /* Key range */ + RGNRANGE RangeVelocity; /* Velocity Range */ + USHORT fusOptions; /* Synthesis options for this range */ + USHORT usKeyGroup; /* Key grouping for non simultaneous play */ + /* 0 = no group, 1 up is group */ + /* for Level 1 only groups 1-15 are allowed */ +}RGNHEADER, FAR *LPRGNHEADER; + +typedef struct _INSTHEADER { + ULONG cRegions; /* Count of regions in this instrument */ + MIDILOCALE Locale; /* Intended MIDI locale of this instrument */ +}INSTHEADER, FAR *LPINSTHEADER; + +typedef struct _DLSHEADER { + ULONG cInstruments; /* Count of instruments in the collection */ +}DLSHEADER, FAR *LPDLSHEADER; + +/*//////////////////////////////////////////////////////////////////////////// +// definitions for the Wave link structure +////////////////////////////////////////////////////////////////////////////*/ + +/* **** For level 1 only WAVELINK_CHANNEL_MONO is valid **** */ +/* ulChannel allows for up to 32 channels of audio with each bit position */ +/* specifiying a channel of playback */ + +#define WAVELINK_CHANNEL_LEFT 0x0001l +#define WAVELINK_CHANNEL_RIGHT 0x0002l + +#define F_WAVELINK_PHASE_MASTER 0x0001 + +typedef struct _WAVELINK { /* any paths or links are stored right after struct */ + USHORT fusOptions; /* options flags for this wave */ + USHORT usPhaseGroup; /* Phase grouping for locking channels */ + ULONG ulChannel; /* channel placement */ + ULONG ulTableIndex; /* index into the wave pool table, 0 based */ +}WAVELINK, FAR *LPWAVELINK; + +#define POOL_CUE_NULL 0xffffffffl + +typedef struct _POOLCUE { + ULONG ulOffset; /* Offset to the entry in the list */ +}POOLCUE, FAR *LPPOOLCUE; + +typedef struct _POOLTABLE { + ULONG cbSize; /* size of the pool table structure */ + ULONG cCues; /* count of cues in the list */ + } POOLTABLE, FAR *LPPOOLTABLE; + +/*//////////////////////////////////////////////////////////////////////////// +// Structures for the "wsmp" chunk +////////////////////////////////////////////////////////////////////////////*/ + +#define F_WSMP_NO_TRUNCATION 0x0001l +#define F_WSMP_NO_COMPRESSION 0x0002l + + +typedef struct _rwsmp { + ULONG cbSize; + USHORT usUnityNote; /* MIDI Unity Playback Note */ + SHORT sFineTune; /* Fine Tune in log tuning */ + LONG lAttenuation; /* Overall Attenuation to be applied to data */ + ULONG fulOptions; /* Flag options */ + ULONG cSampleLoops; /* Count of Sample loops, 0 loops is one shot */ + } WSMPL, FAR *LPWSMPL; + + +/* This loop type is a normal forward playing loop which is continually */ +/* played until the envelope reaches an off threshold in the release */ +/* portion of the volume envelope */ + +#define WLOOP_TYPE_FORWARD 0 + +typedef struct _rloop { + ULONG cbSize; + ULONG ulType; /* Loop Type */ + ULONG ulStart; /* Start of loop in samples */ + ULONG ulLength; /* Length of loop in samples */ +} WLOOP, FAR *LPWLOOP; + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /*_INC_DLS1 */ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls2.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls2.h new file mode 100644 index 0000000000000000000000000000000000000000..f2672adf45606921be498001a6185df2d4c828db --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dls2.h @@ -0,0 +1,155 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +/* + + dls2.h + + Description: + + Interface defines and structures for the DLS2 extensions of DLS. + + + Written by Microsoft 1998. Released for public use. + +*/ + +#ifndef _INC_DLS2 +#define _INC_DLS2 + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/* + FOURCC's used in the DLS2 file, in addition to DLS1 chunks +*/ + +#define FOURCC_RGN2 mmioFOURCC('r','g','n','2') +#define FOURCC_LAR2 mmioFOURCC('l','a','r','2') +#define FOURCC_ART2 mmioFOURCC('a','r','t','2') +#define FOURCC_CDL mmioFOURCC('c','d','l',' ') +#define FOURCC_DLID mmioFOURCC('d','l','i','d') + +/* + Articulation connection graph definitions. These are in addition to + the definitions in the DLS1 header. +*/ + +/* Generic Sources (in addition to DLS1 sources. */ +#define CONN_SRC_POLYPRESSURE 0x0007 /* Polyphonic Pressure */ +#define CONN_SRC_CHANNELPRESSURE 0x0008 /* Channel Pressure */ +#define CONN_SRC_VIBRATO 0x0009 /* Vibrato LFO */ +#define CONN_SRC_MONOPRESSURE 0x000a /* MIDI Mono pressure */ + + +/* Midi Controllers */ +#define CONN_SRC_CC91 0x00db /* Reverb Send */ +#define CONN_SRC_CC93 0x00dd /* Chorus Send */ + + +/* Generic Destinations */ +#define CONN_DST_GAIN 0x0001 /* Same as CONN_DST_ ATTENUATION, but more appropriate terminology. */ +#define CONN_DST_KEYNUMBER 0x0005 /* Key Number Generator */ + +/* Audio Channel Output Destinations */ +#define CONN_DST_LEFT 0x0010 /* Left Channel Send */ +#define CONN_DST_RIGHT 0x0011 /* Right Channel Send */ +#define CONN_DST_CENTER 0x0012 /* Center Channel Send */ +#define CONN_DST_LEFTREAR 0x0013 /* Left Rear Channel Send */ +#define CONN_DST_RIGHTREAR 0x0014 /* Right Rear Channel Send */ +#define CONN_DST_LFE_CHANNEL 0x0015 /* LFE Channel Send */ +#define CONN_DST_CHORUS 0x0080 /* Chorus Send */ +#define CONN_DST_REVERB 0x0081 /* Reverb Send */ + +/* Vibrato LFO Destinations */ +#define CONN_DST_VIB_FREQUENCY 0x0114 /* Vibrato Frequency */ +#define CONN_DST_VIB_STARTDELAY 0x0115 /* Vibrato Start Delay */ + +/* EG1 Destinations */ +#define CONN_DST_EG1_DELAYTIME 0x020B /* EG1 Delay Time */ +#define CONN_DST_EG1_HOLDTIME 0x020C /* EG1 Hold Time */ +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ +#define CONN_DST_EG1_SHUTDOWNTIME 0x020D /* EG1 Shutdown Time */ +#endif + +/* EG2 Destinations */ +#define CONN_DST_EG2_DELAYTIME 0x030F /* EG2 Delay Time */ +#define CONN_DST_EG2_HOLDTIME 0x0310 /* EG2 Hold Time */ + + +/* Filter Destinations */ +#define CONN_DST_FILTER_CUTOFF 0x0500 /* Filter Cutoff Frequency */ +#define CONN_DST_FILTER_Q 0x0501 /* Filter Resonance */ + + +/* Transforms */ +#define CONN_TRN_CONVEX 0x0002 /* Convex Transform */ +#define CONN_TRN_SWITCH 0x0003 /* Switch Transform */ + + +/* Conditional chunk operators */ + #define DLS_CDL_AND 0x0001 /* X = X & Y */ + #define DLS_CDL_OR 0x0002 /* X = X | Y */ + #define DLS_CDL_XOR 0x0003 /* X = X ^ Y */ + #define DLS_CDL_ADD 0x0004 /* X = X + Y */ + #define DLS_CDL_SUBTRACT 0x0005 /* X = X - Y */ + #define DLS_CDL_MULTIPLY 0x0006 /* X = X * Y */ + #define DLS_CDL_DIVIDE 0x0007 /* X = X / Y */ + #define DLS_CDL_LOGICAL_AND 0x0008 /* X = X && Y */ + #define DLS_CDL_LOGICAL_OR 0x0009 /* X = X || Y */ + #define DLS_CDL_LT 0x000A /* X = (X < Y) */ + #define DLS_CDL_LE 0x000B /* X = (X <= Y) */ + #define DLS_CDL_GT 0x000C /* X = (X > Y) */ + #define DLS_CDL_GE 0x000D /* X = (X >= Y) */ + #define DLS_CDL_EQ 0x000E /* X = (X == Y) */ + #define DLS_CDL_NOT 0x000F /* X = !X */ + #define DLS_CDL_CONST 0x0010 /* 32-bit constant */ + #define DLS_CDL_QUERY 0x0011 /* 32-bit value returned from query */ + #define DLS_CDL_QUERYSUPPORTED 0x0012 /* Test to see if query is supported by synth */ + +/* + Loop and release +*/ + +#if (NTDDI_VERSION < NTDDI_WINXP) /* Windows 2000 and SPs */ +#define WLOOP_TYPE_RELEASE 2 +#else +#define WLOOP_TYPE_RELEASE 1 +#endif + +/* + WaveLink chunk +*/ + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ +#define F_WAVELINK_MULTICHANNEL 0x0002 +#endif + +/* + WaveLink chunk +*/ + +#define F_WAVELINK_MULTICHANNEL 0x0002 + + +/* + DLSID queries for +*/ + +DEFINE_GUID(DLSID_GMInHardware, 0x178f2f24, 0xc364, 0x11d1, 0xa7, 0x60, 0x00, 0x00, 0xf8, 0x75, 0xac, 0x12); +DEFINE_GUID(DLSID_GSInHardware, 0x178f2f25, 0xc364, 0x11d1, 0xa7, 0x60, 0x00, 0x00, 0xf8, 0x75, 0xac, 0x12); +DEFINE_GUID(DLSID_XGInHardware, 0x178f2f26, 0xc364, 0x11d1, 0xa7, 0x60, 0x00, 0x00, 0xf8, 0x75, 0xac, 0x12); +DEFINE_GUID(DLSID_SupportsDLS1, 0x178f2f27, 0xc364, 0x11d1, 0xa7, 0x60, 0x00, 0x00, 0xf8, 0x75, 0xac, 0x12); +DEFINE_GUID(DLSID_SupportsDLS2, 0xf14599e5, 0x4689, 0x11d2, 0xaf, 0xa6, 0x0, 0xaa, 0x0, 0x24, 0xd8, 0xb6); +DEFINE_GUID(DLSID_SampleMemorySize, 0x178f2f28, 0xc364, 0x11d1, 0xa7, 0x60, 0x00, 0x00, 0xf8, 0x75, 0xac, 0x12); +DEFINE_GUID(DLSID_ManufacturersID, 0xb03e1181, 0x8095, 0x11d2, 0xa1, 0xef, 0x0, 0x60, 0x8, 0x33, 0xdb, 0xd8); +DEFINE_GUID(DLSID_ProductID, 0xb03e1182, 0x8095, 0x11d2, 0xa1, 0xef, 0x0, 0x60, 0x8, 0x33, 0xdb, 0xd8); +DEFINE_GUID(DLSID_SamplePlaybackRate, 0x2a91f713, 0xa4bf, 0x11d2, 0xbb, 0xdf, 0x0, 0x60, 0x8, 0x33, 0xdb, 0xd8); + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _INC_DLS2 */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmdls.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmdls.h new file mode 100644 index 0000000000000000000000000000000000000000..c04f9a9d2d241a54831a8cb4325310212693887f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmdls.h @@ -0,0 +1,214 @@ +/************************************************************************ +* * +* dmdls.h -- DLS download definitions for DirectMusic API's * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +************************************************************************/ + +#ifndef _DMDLS_ +#define _DMDLS_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#include "dls1.h" + +typedef long PCENT; /* Pitch cents */ +typedef long GCENT; /* Gain cents */ +typedef long TCENT; /* Time cents */ +typedef long PERCENT; /* Per.. cent! */ + +typedef LONGLONG REFERENCE_TIME; +typedef REFERENCE_TIME *LPREFERENCE_TIME; +typedef long MUSIC_TIME; + +#ifndef MAKEFOURCC +#define MAKEFOURCC(ch0, ch1, ch2, ch3) \ + ((DWORD)(BYTE)(ch0) | ((DWORD)(BYTE)(ch1) << 8) | \ + ((DWORD)(BYTE)(ch2) << 16) | ((DWORD)(BYTE)(ch3) << 24 )) + + +typedef DWORD FOURCC; /* a four character code */ +#endif + +typedef struct _DMUS_DOWNLOADINFO +{ + DWORD dwDLType; /* Instrument or Wave */ + DWORD dwDLId; /* Unique identifier to tag this download. */ + DWORD dwNumOffsetTableEntries; /* Number of index in the offset address table. */ + DWORD cbSize; /* Total size of this memory chunk. */ +} DMUS_DOWNLOADINFO; + +#define DMUS_DOWNLOADINFO_INSTRUMENT 1 +#define DMUS_DOWNLOADINFO_WAVE 2 +#define DMUS_DOWNLOADINFO_INSTRUMENT2 3 /* New version for better DLS2 support. */ + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ + +/* Support for oneshot and streaming wave data */ +#define DMUS_DOWNLOADINFO_WAVEARTICULATION 4 /* Wave articulation data */ +#define DMUS_DOWNLOADINFO_STREAMINGWAVE 5 /* One chunk of a streaming */ +#define DMUS_DOWNLOADINFO_ONESHOTWAVE 6 + +#endif + +#define DMUS_DEFAULT_SIZE_OFFSETTABLE 1 + +/* Flags for DMUS_INSTRUMENT's ulFlags member */ + +#define DMUS_INSTRUMENT_GM_INSTRUMENT (1 << 0) + +typedef struct _DMUS_OFFSETTABLE +{ + ULONG ulOffsetTable[DMUS_DEFAULT_SIZE_OFFSETTABLE]; +} DMUS_OFFSETTABLE; + +typedef struct _DMUS_INSTRUMENT +{ + ULONG ulPatch; + ULONG ulFirstRegionIdx; + ULONG ulGlobalArtIdx; /* If zero the instrument does not have an articulation */ + ULONG ulFirstExtCkIdx; /* If zero no 3rd party entenstion chunks associated with the instrument */ + ULONG ulCopyrightIdx; /* If zero no Copyright information associated with the instrument */ + ULONG ulFlags; +} DMUS_INSTRUMENT; + +typedef struct _DMUS_REGION +{ + RGNRANGE RangeKey; + RGNRANGE RangeVelocity; + USHORT fusOptions; + USHORT usKeyGroup; + ULONG ulRegionArtIdx; /* If zero the region does not have an articulation */ + ULONG ulNextRegionIdx; /* If zero no more regions */ + ULONG ulFirstExtCkIdx; /* If zero no 3rd party entenstion chunks associated with the region */ + WAVELINK WaveLink; + WSMPL WSMP; /* If WSMP.cSampleLoops > 1 then a WLOOP is included */ + WLOOP WLOOP[1]; +} DMUS_REGION; + +typedef struct _DMUS_LFOPARAMS +{ + PCENT pcFrequency; + TCENT tcDelay; + GCENT gcVolumeScale; + PCENT pcPitchScale; + GCENT gcMWToVolume; + PCENT pcMWToPitch; +} DMUS_LFOPARAMS; + +typedef struct _DMUS_VEGPARAMS +{ + TCENT tcAttack; + TCENT tcDecay; + PERCENT ptSustain; + TCENT tcRelease; + TCENT tcVel2Attack; + TCENT tcKey2Decay; +} DMUS_VEGPARAMS; + +typedef struct _DMUS_PEGPARAMS +{ + TCENT tcAttack; + TCENT tcDecay; + PERCENT ptSustain; + TCENT tcRelease; + TCENT tcVel2Attack; + TCENT tcKey2Decay; + PCENT pcRange; +} DMUS_PEGPARAMS; + +typedef struct _DMUS_MSCPARAMS +{ + PERCENT ptDefaultPan; +} DMUS_MSCPARAMS; + +typedef struct _DMUS_ARTICPARAMS +{ + DMUS_LFOPARAMS LFO; + DMUS_VEGPARAMS VolEG; + DMUS_PEGPARAMS PitchEG; + DMUS_MSCPARAMS Misc; +} DMUS_ARTICPARAMS; + +typedef struct _DMUS_ARTICULATION /* Articulation chunk for DMUS_DOWNLOADINFO_INSTRUMENT format. */ +{ + ULONG ulArt1Idx; /* DLS Level 1 articulation chunk */ + ULONG ulFirstExtCkIdx; /* 3rd party extenstion chunks associated with the articulation */ +} DMUS_ARTICULATION; + +typedef struct _DMUS_ARTICULATION2 /* Articulation chunk for DMUS_DOWNLOADINFO_INSTRUMENT2 format. */ +{ + ULONG ulArtIdx; /* DLS Level 1/2 articulation chunk */ + ULONG ulFirstExtCkIdx; /* 3rd party extenstion chunks associated with the articulation */ + ULONG ulNextArtIdx; /* Additional articulation chunks */ +} DMUS_ARTICULATION2; + +#define DMUS_MIN_DATA_SIZE 4 +/* The actual number is determined by cbSize of struct _DMUS_EXTENSIONCHUNK */ + +typedef struct _DMUS_EXTENSIONCHUNK +{ + ULONG cbSize; /* Size of extension chunk */ + ULONG ulNextExtCkIdx; /* If zero no more 3rd party entenstion chunks */ + FOURCC ExtCkID; + BYTE byExtCk[DMUS_MIN_DATA_SIZE]; /* The actual number that follows is determined by cbSize */ +} DMUS_EXTENSIONCHUNK; + +/* The actual number is determined by cbSize of struct _DMUS_COPYRIGHT */ + +typedef struct _DMUS_COPYRIGHT +{ + ULONG cbSize; /* Size of copyright information */ + BYTE byCopyright[DMUS_MIN_DATA_SIZE]; /* The actual number that follows is determined by cbSize */ +} DMUS_COPYRIGHT; + +typedef struct _DMUS_WAVEDATA +{ + ULONG cbSize; + BYTE byData[DMUS_MIN_DATA_SIZE]; +} DMUS_WAVEDATA; + +typedef struct _DMUS_WAVE +{ + ULONG ulFirstExtCkIdx; /* If zero no 3rd party entenstion chunks associated with the wave */ + ULONG ulCopyrightIdx; /* If zero no Copyright information associated with the wave */ + ULONG ulWaveDataIdx; /* Location of actual wave data. */ + WAVEFORMATEX WaveformatEx; +} DMUS_WAVE; + +typedef struct _DMUS_NOTERANGE *LPDMUS_NOTERANGE; +typedef struct _DMUS_NOTERANGE +{ + DWORD dwLowNote; /* Sets the low note for the range of MIDI note events to which the instrument responds.*/ + DWORD dwHighNote; /* Sets the high note for the range of MIDI note events to which the instrument responds.*/ +} DMUS_NOTERANGE; + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ + +typedef struct _DMUS_WAVEARTDL +{ + ULONG ulDownloadIdIdx; /* Download ID's of each buffer */ + ULONG ulBus; /* Playback bus */ + ULONG ulBuffers; /* Buffers */ + ULONG ulMasterDLId; /* Download ID of master voice of subordinate group */ + USHORT usOptions; /* Same as DLS2 region options */ +} DMUS_WAVEARTDL, + *LPDMUS_WAVEARTDL; + +typedef struct _DMUS_WAVEDL +{ + ULONG cbWaveData; /* Bytes of wave data */ +} DMUS_WAVEDL, + *LPDMUS_WAVEDL; + +#endif /* NTDDI_VERSION >= NTDDI_WINXP */ + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _DMDLS_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmerror.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmerror.h new file mode 100644 index 0000000000000000000000000000000000000000..c8ebd46e412a1f21d6c670e8c5bbba2aad51ae6d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmerror.h @@ -0,0 +1,864 @@ +/************************************************************************ +* * +* dmerror.h -- Error codes returned by DirectMusic API's * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +************************************************************************/ + +#ifndef _DMERROR_ +#define _DMERROR_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#define DMUS_ERRBASE 0x1000 /* Make error codes human readable in hex */ + +#ifndef MAKE_HRESULT +#define MAKE_HRESULT(sev,fac,code) \ + ((HRESULT) (((unsigned long)(sev)<<31) | ((unsigned long)(fac)<<16) | ((unsigned long)(code))) ) +#endif + +#define MAKE_DMHRESULTSUCCESS(code) MAKE_HRESULT(0, FACILITY_DIRECTMUSIC, (DMUS_ERRBASE + (code))) +#define MAKE_DMHRESULTERROR(code) MAKE_HRESULT(1, FACILITY_DIRECTMUSIC, (DMUS_ERRBASE + (code))) + +/* DMUS_S_PARTIALLOAD + * + * The object could only load partially. This can happen if some components are + * not registered properly, such as embedded tracks and tools. This can also happen + * if some content is missing. For example, if a segment uses a DLS collection that + * is not in the loader's current search directory. + */ +#define DMUS_S_PARTIALLOAD MAKE_DMHRESULTSUCCESS(0x091) + +/* DMUS_S_PARTIALDOWNLOAD + * + * Return value from IDirectMusicBand::Download() which indicates that + * some of the instruments safely downloaded, but others failed. This usually + * occurs when some instruments are on PChannels not supported by the performance + * or port. + */ +#define DMUS_S_PARTIALDOWNLOAD MAKE_DMHRESULTSUCCESS(0x092) + +/* DMUS_S_REQUEUE + * + * Return value from IDirectMusicTool::ProcessPMsg() which indicates to the + * performance that it should cue the PMsg again automatically. + */ +#define DMUS_S_REQUEUE MAKE_DMHRESULTSUCCESS(0x200) + +/* DMUS_S_FREE + * + * Return value from IDirectMusicTool::ProcessPMsg() which indicates to the + * performance that it should free the PMsg automatically. + */ +#define DMUS_S_FREE MAKE_DMHRESULTSUCCESS(0x201) + +/* DMUS_S_END + * + * Return value from IDirectMusicTrack::Play() which indicates to the + * segment that the track has no more data after mtEnd. + */ +#define DMUS_S_END MAKE_DMHRESULTSUCCESS(0x202) + +/* DMUS_S_STRING_TRUNCATED + * + * Returned string has been truncated to fit the buffer size. + */ +#define DMUS_S_STRING_TRUNCATED MAKE_DMHRESULTSUCCESS(0x210) + +/* DMUS_S_LAST_TOOL + * + * Returned from IDirectMusicGraph::StampPMsg(), this indicates that the PMsg + * is already stamped with the last tool in the graph. The returned PMsg's + * tool pointer is now NULL. + */ +#define DMUS_S_LAST_TOOL MAKE_DMHRESULTSUCCESS(0x211) + +/* DMUS_S_OVER_CHORD + * + * Returned from IDirectMusicPerformance::MusicToMIDI(), this indicates + * that no note has been calculated because the music value has the note + * at a position higher than the top note of the chord. This applies only + * to DMUS_PLAYMODE_NORMALCHORD play mode. This success code indicates + * that the caller should not do anything with the note. It is not meant + * to be played against this chord. + */ +#define DMUS_S_OVER_CHORD MAKE_DMHRESULTSUCCESS(0x212) + +/* DMUS_S_UP_OCTAVE + * + * Returned from IDirectMusicPerformance::MIDIToMusic(), and + * IDirectMusicPerformance::MusicToMIDI(), this indicates + * that the note conversion generated a note value that is below 0, + * so it has been bumped up one or more octaves to be in the proper + * MIDI range of 0 through 127. + * Note that this is valid for MIDIToMusic() when using play modes + * DMUS_PLAYMODE_FIXEDTOCHORD and DMUS_PLAYMODE_FIXEDTOKEY, both of + * which store MIDI values in wMusicValue. With MusicToMIDI(), it is + * valid for all play modes. + * Ofcourse, DMUS_PLAYMODE_FIXED will never return this success code. + */ +#define DMUS_S_UP_OCTAVE MAKE_DMHRESULTSUCCESS(0x213) + +/* DMUS_S_DOWN_OCTAVE + * + * Returned from IDirectMusicPerformance::MIDIToMusic(), and + * IDirectMusicPerformance::MusicToMIDI(), this indicates + * that the note conversion generated a note value that is above 127, + * so it has been bumped down one or more octaves to be in the proper + * MIDI range of 0 through 127. + * Note that this is valid for MIDIToMusic() when using play modes + * DMUS_PLAYMODE_FIXEDTOCHORD and DMUS_PLAYMODE_FIXEDTOKEY, both of + * which store MIDI values in wMusicValue. With MusicToMIDI(), it is + * valid for all play modes. + * Ofcourse, DMUS_PLAYMODE_FIXED will never return this success code. + */ +#define DMUS_S_DOWN_OCTAVE MAKE_DMHRESULTSUCCESS(0x214) + +/* DMUS_S_NOBUFFERCONTROL + * + * Although the audio output from the port will be routed to the + * same device as the given DirectSound buffer, buffer controls + * such as pan and volume will not affect the output. + * + */ +#define DMUS_S_NOBUFFERCONTROL MAKE_DMHRESULTSUCCESS(0x215) + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ + +/* DMUS_S_GARBAGE_COLLECTED + * + * The requested operation was not performed because during CollectGarbage + * the loader determined that the object had been released. + */ +#define DMUS_S_GARBAGE_COLLECTED MAKE_DMHRESULTSUCCESS(0x216) + +#endif + +/* DMUS_E_DRIVER_FAILED + * + * An unexpected error was returned from a device driver, indicating + * possible failure of the driver or hardware. + */ +#define DMUS_E_DRIVER_FAILED MAKE_DMHRESULTERROR(0x0101) + +/* DMUS_E_PORTS_OPEN + * + * The requested operation cannot be performed while there are + * instantiated ports in any process in the system. + */ +#define DMUS_E_PORTS_OPEN MAKE_DMHRESULTERROR(0x0102) + +/* DMUS_E_DEVICE_IN_USE + * + * The requested device is already in use (possibly by a non-DirectMusic + * client) and cannot be opened again. + */ +#define DMUS_E_DEVICE_IN_USE MAKE_DMHRESULTERROR(0x0103) + +/* DMUS_E_INSUFFICIENTBUFFER + * + * Buffer is not large enough for requested operation. + */ +#define DMUS_E_INSUFFICIENTBUFFER MAKE_DMHRESULTERROR(0x0104) + +/* DMUS_E_BUFFERNOTSET + * + * No buffer was prepared for the download data. + */ +#define DMUS_E_BUFFERNOTSET MAKE_DMHRESULTERROR(0x0105) + +/* DMUS_E_BUFFERNOTAVAILABLE + * + * Download failed due to inability to access or create download buffer. + */ +#define DMUS_E_BUFFERNOTAVAILABLE MAKE_DMHRESULTERROR(0x0106) + +/* DMUS_E_NOTADLSCOL + * + * Error parsing DLS collection. File is corrupt. + */ +#define DMUS_E_NOTADLSCOL MAKE_DMHRESULTERROR(0x0108) + +/* DMUS_E_INVALIDOFFSET + * + * Wave chunks in DLS collection file are at incorrect offsets. + */ +#define DMUS_E_INVALIDOFFSET MAKE_DMHRESULTERROR(0x0109) + +/* DMUS_E_ALREADY_LOADED + * + * Second attempt to load a DLS collection that is currently open. + */ +#define DMUS_E_ALREADY_LOADED MAKE_DMHRESULTERROR(0x0111) + +/* DMUS_E_INVALIDPOS + * + * Error reading wave data from DLS collection. Indicates bad file. + */ +#define DMUS_E_INVALIDPOS MAKE_DMHRESULTERROR(0x0113) + +/* DMUS_E_INVALIDPATCH + * + * There is no instrument in the collection that matches patch number. + */ +#define DMUS_E_INVALIDPATCH MAKE_DMHRESULTERROR(0x0114) + +/* DMUS_E_CANNOTSEEK + * + * The IStream* doesn't support Seek(). + */ +#define DMUS_E_CANNOTSEEK MAKE_DMHRESULTERROR(0x0115) + +/* DMUS_E_CANNOTWRITE + * + * The IStream* doesn't support Write(). + */ +#define DMUS_E_CANNOTWRITE MAKE_DMHRESULTERROR(0x0116) + +/* DMUS_E_CHUNKNOTFOUND + * + * The RIFF parser doesn't contain a required chunk while parsing file. + */ +#define DMUS_E_CHUNKNOTFOUND MAKE_DMHRESULTERROR(0x0117) + +/* DMUS_E_INVALID_DOWNLOADID + * + * Invalid download id was used in the process of creating a download buffer. + */ +#define DMUS_E_INVALID_DOWNLOADID MAKE_DMHRESULTERROR(0x0119) + +/* DMUS_E_NOT_DOWNLOADED_TO_PORT + * + * Tried to unload an object that was not downloaded or previously unloaded. + */ +#define DMUS_E_NOT_DOWNLOADED_TO_PORT MAKE_DMHRESULTERROR(0x0120) + +/* DMUS_E_ALREADY_DOWNLOADED + * + * Buffer was already downloaded to synth. + */ +#define DMUS_E_ALREADY_DOWNLOADED MAKE_DMHRESULTERROR(0x0121) + +/* DMUS_E_UNKNOWN_PROPERTY + * + * The specified property item was not recognized by the target object. + */ +#define DMUS_E_UNKNOWN_PROPERTY MAKE_DMHRESULTERROR(0x0122) + +/* DMUS_E_SET_UNSUPPORTED + * + * The specified property item may not be set on the target object. + */ +#define DMUS_E_SET_UNSUPPORTED MAKE_DMHRESULTERROR(0x0123) + +/* DMUS_E_GET_UNSUPPORTED + * + * The specified property item may not be retrieved from the target object. + */ +#define DMUS_E_GET_UNSUPPORTED MAKE_DMHRESULTERROR(0x0124) + +/* DMUS_E_NOTMONO + * + * Wave chunk has more than one interleaved channel. DLS format requires MONO. + */ +#define DMUS_E_NOTMONO MAKE_DMHRESULTERROR(0x0125) + +/* DMUS_E_BADARTICULATION + * + * Invalid articulation chunk in DLS collection. + */ +#define DMUS_E_BADARTICULATION MAKE_DMHRESULTERROR(0x0126) + +/* DMUS_E_BADINSTRUMENT + * + * Invalid instrument chunk in DLS collection. + */ +#define DMUS_E_BADINSTRUMENT MAKE_DMHRESULTERROR(0x0127) + +/* DMUS_E_BADWAVELINK + * + * Wavelink chunk in DLS collection points to invalid wave. + */ +#define DMUS_E_BADWAVELINK MAKE_DMHRESULTERROR(0x0128) + +/* DMUS_E_NOARTICULATION + * + * Articulation missing from instrument in DLS collection. + */ +#define DMUS_E_NOARTICULATION MAKE_DMHRESULTERROR(0x0129) + +/* DMUS_E_NOTPCM + * + * Downoaded DLS wave is not in PCM format. +*/ +#define DMUS_E_NOTPCM MAKE_DMHRESULTERROR(0x012A) + +/* DMUS_E_BADWAVE + * + * Bad wave chunk in DLS collection + */ +#define DMUS_E_BADWAVE MAKE_DMHRESULTERROR(0x012B) + +/* DMUS_E_BADOFFSETTABLE + * + * Offset Table for download buffer has errors. + */ +#define DMUS_E_BADOFFSETTABLE MAKE_DMHRESULTERROR(0x012C) + +/* DMUS_E_UNKNOWNDOWNLOAD + * + * Attempted to download unknown data type. + */ +#define DMUS_E_UNKNOWNDOWNLOAD MAKE_DMHRESULTERROR(0x012D) + +/* DMUS_E_NOSYNTHSINK + * + * The operation could not be completed because no sink was connected to + * the synthesizer. + */ +#define DMUS_E_NOSYNTHSINK MAKE_DMHRESULTERROR(0x012E) + +/* DMUS_E_ALREADYOPEN + * + * An attempt was made to open the software synthesizer while it was already + * open. + * ASSERT? + */ +#define DMUS_E_ALREADYOPEN MAKE_DMHRESULTERROR(0x012F) + +/* DMUS_E_ALREADYCLOSE + * + * An attempt was made to close the software synthesizer while it was already + * open. + * ASSERT? + */ +#define DMUS_E_ALREADYCLOSED MAKE_DMHRESULTERROR(0x0130) + +/* DMUS_E_SYNTHNOTCONFIGURED + * + * The operation could not be completed because the software synth has not + * yet been fully configured. + * ASSERT? + */ +#define DMUS_E_SYNTHNOTCONFIGURED MAKE_DMHRESULTERROR(0x0131) + +/* DMUS_E_SYNTHACTIVE + * + * The operation cannot be carried out while the synthesizer is active. + */ +#define DMUS_E_SYNTHACTIVE MAKE_DMHRESULTERROR(0x0132) + +/* DMUS_E_CANNOTREAD + * + * An error occurred while attempting to read from the IStream* object. + */ +#define DMUS_E_CANNOTREAD MAKE_DMHRESULTERROR(0x0133) + +/* DMUS_E_DMUSIC_RELEASED + * + * The operation cannot be performed because the final instance of the + * DirectMusic object was released. Ports cannot be used after final + * release of the DirectMusic object. + */ +#define DMUS_E_DMUSIC_RELEASED MAKE_DMHRESULTERROR(0x0134) + +/* DMUS_E_BUFFER_EMPTY + * + * There was no data in the referenced buffer. + */ +#define DMUS_E_BUFFER_EMPTY MAKE_DMHRESULTERROR(0x0135) + +/* DMUS_E_BUFFER_FULL + * + * There is insufficient space to insert the given event into the buffer. + */ +#define DMUS_E_BUFFER_FULL MAKE_DMHRESULTERROR(0x0136) + +/* DMUS_E_PORT_NOT_CAPTURE + * + * The given operation could not be carried out because the port is a + * capture port. + */ +#define DMUS_E_PORT_NOT_CAPTURE MAKE_DMHRESULTERROR(0x0137) + +/* DMUS_E_PORT_NOT_RENDER + * + * The given operation could not be carried out because the port is a + * render port. + */ +#define DMUS_E_PORT_NOT_RENDER MAKE_DMHRESULTERROR(0x0138) + +/* DMUS_E_DSOUND_NOT_SET + * + * The port could not be created because no DirectSound has been specified. + * Specify a DirectSound interface via the IDirectMusic::SetDirectSound + * method; pass NULL to have DirectMusic manage usage of DirectSound. + */ +#define DMUS_E_DSOUND_NOT_SET MAKE_DMHRESULTERROR(0x0139) + +/* DMUS_E_ALREADY_ACTIVATED + * + * The operation cannot be carried out while the port is active. + */ +#define DMUS_E_ALREADY_ACTIVATED MAKE_DMHRESULTERROR(0x013A) + +/* DMUS_E_INVALIDBUFFER + * + * Invalid DirectSound buffer was handed to port. + */ +#define DMUS_E_INVALIDBUFFER MAKE_DMHRESULTERROR(0x013B) + +/* DMUS_E_WAVEFORMATNOTSUPPORTED + * + * Invalid buffer format was handed to the synth sink. + */ +#define DMUS_E_WAVEFORMATNOTSUPPORTED MAKE_DMHRESULTERROR(0x013C) + +/* DMUS_E_SYNTHINACTIVE + * + * The operation cannot be carried out while the synthesizer is inactive. + */ +#define DMUS_E_SYNTHINACTIVE MAKE_DMHRESULTERROR(0x013D) + +/* DMUS_E_DSOUND_ALREADY_SET + * + * IDirectMusic::SetDirectSound has already been called. It may not be + * changed while in use. + */ +#define DMUS_E_DSOUND_ALREADY_SET MAKE_DMHRESULTERROR(0x013E) + +/* DMUS_E_INVALID_EVENT + * + * The given event is invalid (either it is not a valid MIDI message + * or it makes use of running status). The event cannot be packed + * into the buffer. + */ +#define DMUS_E_INVALID_EVENT MAKE_DMHRESULTERROR(0x013F) + +/* DMUS_E_UNSUPPORTED_STREAM + * + * The IStream* object does not contain data supported by the loading object. + */ +#define DMUS_E_UNSUPPORTED_STREAM MAKE_DMHRESULTERROR(0x0150) + +/* DMUS_E_ALREADY_INITED + * + * The object has already been initialized. + */ +#define DMUS_E_ALREADY_INITED MAKE_DMHRESULTERROR(0x0151) + +/* DMUS_E_INVALID_BAND + * + * The file does not contain a valid band. + */ +#define DMUS_E_INVALID_BAND MAKE_DMHRESULTERROR(0x0152) + +/* DMUS_E_TRACK_HDR_NOT_FIRST_CK + * + * The IStream* object's data does not have a track header as the first chunk, + * and therefore can not be read by the segment object. + */ +#define DMUS_E_TRACK_HDR_NOT_FIRST_CK MAKE_DMHRESULTERROR(0x0155) + +/* DMUS_E_TOOL_HDR_NOT_FIRST_CK + * + * The IStream* object's data does not have a tool header as the first chunk, + * and therefore can not be read by the graph object. + */ +#define DMUS_E_TOOL_HDR_NOT_FIRST_CK MAKE_DMHRESULTERROR(0x0156) + +/* DMUS_E_INVALID_TRACK_HDR + * + * The IStream* object's data contains an invalid track header (ckid is 0 and + * fccType is NULL,) and therefore can not be read by the segment object. + */ +#define DMUS_E_INVALID_TRACK_HDR MAKE_DMHRESULTERROR(0x0157) + +/* DMUS_E_INVALID_TOOL_HDR + * + * The IStream* object's data contains an invalid tool header (ckid is 0 and + * fccType is NULL,) and therefore can not be read by the graph object. + */ +#define DMUS_E_INVALID_TOOL_HDR MAKE_DMHRESULTERROR(0x0158) + +/* DMUS_E_ALL_TOOLS_FAILED + * + * The graph object was unable to load all tools from the IStream* object data. + * This may be due to errors in the stream, or the tools being incorrectly + * registered on the client. + */ +#define DMUS_E_ALL_TOOLS_FAILED MAKE_DMHRESULTERROR(0x0159) + +/* DMUS_E_ALL_TRACKS_FAILED + * + * The segment object was unable to load all tracks from the IStream* object data. + * This may be due to errors in the stream, or the tracks being incorrectly + * registered on the client. + */ +#define DMUS_E_ALL_TRACKS_FAILED MAKE_DMHRESULTERROR(0x0160) + +/* DMUS_E_NOT_FOUND + * + * The requested item was not contained by the object. + */ +#define DMUS_E_NOT_FOUND MAKE_DMHRESULTERROR(0x0161) + +/* DMUS_E_NOT_INIT + * + * A required object is not initialized or failed to initialize. + */ +#define DMUS_E_NOT_INIT MAKE_DMHRESULTERROR(0x0162) + +/* DMUS_E_TYPE_DISABLED + * + * The requested parameter type is currently disabled. Parameter types may + * be enabled and disabled by certain calls to SetParam(). + */ +#define DMUS_E_TYPE_DISABLED MAKE_DMHRESULTERROR(0x0163) + +/* DMUS_E_TYPE_UNSUPPORTED + * + * The requested parameter type is not supported on the object. + */ +#define DMUS_E_TYPE_UNSUPPORTED MAKE_DMHRESULTERROR(0x0164) + +/* DMUS_E_TIME_PAST + * + * The time is in the past, and the operation can not succeed. + */ +#define DMUS_E_TIME_PAST MAKE_DMHRESULTERROR(0x0165) + +/* DMUS_E_TRACK_NOT_FOUND + * + * The requested track is not contained by the segment. + */ +#define DMUS_E_TRACK_NOT_FOUND MAKE_DMHRESULTERROR(0x0166) + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ + +/* DMUS_E_TRACK_NO_CLOCKTIME_SUPPORT + * + * The track does not support clock time playback or getparam. + */ +#define DMUS_E_TRACK_NO_CLOCKTIME_SUPPORT MAKE_DMHRESULTERROR(0x0167) + +#endif + +/* DMUS_E_NO_MASTER_CLOCK + * + * There is no master clock in the performance. Be sure to call + * IDirectMusicPerformance::Init(). + */ +#define DMUS_E_NO_MASTER_CLOCK MAKE_DMHRESULTERROR(0x0170) + +/* DMUS_E_LOADER_NOCLASSID + * + * The class id field is required and missing in the DMUS_OBJECTDESC. + */ +#define DMUS_E_LOADER_NOCLASSID MAKE_DMHRESULTERROR(0x0180) + +/* DMUS_E_LOADER_BADPATH + * + * The requested file path is invalid. + */ +#define DMUS_E_LOADER_BADPATH MAKE_DMHRESULTERROR(0x0181) + +/* DMUS_E_LOADER_FAILEDOPEN + * + * File open failed - either file doesn't exist or is locked. + */ +#define DMUS_E_LOADER_FAILEDOPEN MAKE_DMHRESULTERROR(0x0182) + +/* DMUS_E_LOADER_FORMATNOTSUPPORTED + * + * Search data type is not supported. + */ +#define DMUS_E_LOADER_FORMATNOTSUPPORTED MAKE_DMHRESULTERROR(0x0183) + +/* DMUS_E_LOADER_FAILEDCREATE + * + * Unable to find or create object. + */ +#define DMUS_E_LOADER_FAILEDCREATE MAKE_DMHRESULTERROR(0x0184) + +/* DMUS_E_LOADER_OBJECTNOTFOUND + * + * Object was not found. + */ +#define DMUS_E_LOADER_OBJECTNOTFOUND MAKE_DMHRESULTERROR(0x0185) + +/* DMUS_E_LOADER_NOFILENAME + * + * The file name is missing from the DMUS_OBJECTDESC. + */ +#define DMUS_E_LOADER_NOFILENAME MAKE_DMHRESULTERROR(0x0186) + +/* DMUS_E_INVALIDFILE + * + * The file requested is not a valid file. + */ +#define DMUS_E_INVALIDFILE MAKE_DMHRESULTERROR(0x0200) + +/* DMUS_E_ALREADY_EXISTS + * + * The tool is already contained in the graph. Create a new instance. + */ +#define DMUS_E_ALREADY_EXISTS MAKE_DMHRESULTERROR(0x0201) + +/* DMUS_E_OUT_OF_RANGE + * + * Value is out of range, for instance the requested length is longer than + * the segment. + */ +#define DMUS_E_OUT_OF_RANGE MAKE_DMHRESULTERROR(0x0202) + +/* DMUS_E_SEGMENT_INIT_FAILED + * + * Segment initialization failed, most likely due to a critical memory situation. + */ +#define DMUS_E_SEGMENT_INIT_FAILED MAKE_DMHRESULTERROR(0x0203) + +/* DMUS_E_ALREADY_SENT + * + * The DMUS_PMSG has already been sent to the performance object via + * IDirectMusicPerformance::SendPMsg(). + */ +#define DMUS_E_ALREADY_SENT MAKE_DMHRESULTERROR(0x0204) + +/* DMUS_E_CANNOT_FREE + * + * The DMUS_PMSG was either not allocated by the performance via + * IDirectMusicPerformance::AllocPMsg(), or it was already freed via + * IDirectMusicPerformance::FreePMsg(). + */ +#define DMUS_E_CANNOT_FREE MAKE_DMHRESULTERROR(0x0205) + +/* DMUS_E_CANNOT_OPEN_PORT + * + * The default system port could not be opened. + */ +#define DMUS_E_CANNOT_OPEN_PORT MAKE_DMHRESULTERROR(0x0206) + +/* DMUS_E_CANNOT_CONVERT + * + * A call to MIDIToMusic() or MusicToMIDI() resulted in an error because + * the requested conversion could not happen. This usually occurs when the + * provided DMUS_CHORD_KEY structure has an invalid chord or scale pattern. + */ +#define DMUS_E_CANNOT_CONVERT MAKE_DMHRESULTERROR(0x0207) +/* misspelling in previous versions of DirectX preserved for backward compatibility */ +#define DMUS_E_CONNOT_CONVERT DMUS_E_CANNOT_CONVERT + +/* DMUS_E_DESCEND_CHUNK_FAIL + * + * DMUS_E_DESCEND_CHUNK_FAIL is returned when the end of the file + * was reached before the desired chunk was found. + */ +#define DMUS_E_DESCEND_CHUNK_FAIL MAKE_DMHRESULTERROR(0x0210) + + +#if (NTDDI_VERSION >= NTDDI_WINXP) /* Windows XP or greater */ + +/* DMUS_E_NOT_LOADED + * + * An attempt to use this object failed because it first needs to + * be loaded. + */ +#define DMUS_E_NOT_LOADED MAKE_DMHRESULTERROR(0x0211) + +/* DMUS_E_SCRIPT_LANGUAGE_INCOMPATIBLE + * + * The activeX scripting engine for the script's language is not compatible with + * DirectMusic. + * + */ +#define DMUS_E_SCRIPT_LANGUAGE_INCOMPATIBLE MAKE_DMHRESULTERROR(0x0213) + +/* DMUS_E_SCRIPT_UNSUPPORTED_VARTYPE + * + * A varient was used that had a type that is not supported by DirectMusic. + * + */ +#define DMUS_E_SCRIPT_UNSUPPORTED_VARTYPE MAKE_DMHRESULTERROR(0x0214) + +/* DMUS_E_SCRIPT_ERROR_IN_SCRIPT + * + * An error was encountered while parsing or executing the script. + * The pErrorInfo parameter (if supplied) was filled with information about the error. + */ +#define DMUS_E_SCRIPT_ERROR_IN_SCRIPT MAKE_DMHRESULTERROR(0x0215) + +/* DMUS_E_SCRIPT_CANTLOAD_OLEAUT32 + * + * Loading of oleaut32.dll failed. VBScript and other activeX scripting languages + * require use of oleaut32.dll. On platforms where oleaut32.dll is not present, only + * the DirectMusicScript language, which doesn't require oleaut32.dll can be used. + */ +#define DMUS_E_SCRIPT_CANTLOAD_OLEAUT32 MAKE_DMHRESULTERROR(0x0216) + +/* DMUS_E_SCRIPT_LOADSCRIPT_ERROR + * + * An error occured while parsing a script loaded using LoadScript. The script that + * was loaded contains an error. + */ +#define DMUS_E_SCRIPT_LOADSCRIPT_ERROR MAKE_DMHRESULTERROR(0x0217) + +/* DMUS_E_SCRIPT_INVALID_FILE + * + * The script file is invalid. + */ +#define DMUS_E_SCRIPT_INVALID_FILE MAKE_DMHRESULTERROR(0x0218) + +/* DMUS_E_INVALID_SCRIPTTRACK + * + * The file contains an invalid script track. + */ +#define DMUS_E_INVALID_SCRIPTTRACK MAKE_DMHRESULTERROR(0x0219) + +/* DMUS_E_SCRIPT_VARIABLE_NOT_FOUND + * + * The script does not contain a variable with the specified name. + */ +#define DMUS_E_SCRIPT_VARIABLE_NOT_FOUND MAKE_DMHRESULTERROR(0x021A) + +/* DMUS_E_SCRIPT_ROUTINE_NOT_FOUND + * + * The script does not contain a routine with the specified name. + */ +#define DMUS_E_SCRIPT_ROUTINE_NOT_FOUND MAKE_DMHRESULTERROR(0x021B) + +/* DMUS_E_SCRIPT_CONTENT_READONLY + * + * Scripts variables for content referenced or embedded in a script cannot be set. + */ +#define DMUS_E_SCRIPT_CONTENT_READONLY MAKE_DMHRESULTERROR(0x021C) + +/* DMUS_E_SCRIPT_NOT_A_REFERENCE + * + * Attempt was made to set a script's variable by reference to a value that was + * not an object type. + */ +#define DMUS_E_SCRIPT_NOT_A_REFERENCE MAKE_DMHRESULTERROR(0x021D) + +/* DMUS_E_SCRIPT_VALUE_NOT_SUPPORTED + * + * Attempt was made to set a script's variable by value to an object that does + * not support a default value property. + */ +#define DMUS_E_SCRIPT_VALUE_NOT_SUPPORTED MAKE_DMHRESULTERROR(0x021E) + +/* DMUS_E_INVALID_SEGMENTTRIGGERTRACK + * + * The file contains an invalid segment trigger track. + */ +#define DMUS_E_INVALID_SEGMENTTRIGGERTRACK MAKE_DMHRESULTERROR(0x0220) + +/* DMUS_E_INVALID_LYRICSTRACK + * + * The file contains an invalid lyrics track. + */ +#define DMUS_E_INVALID_LYRICSTRACK MAKE_DMHRESULTERROR(0x0221) + +/* DMUS_E_INVALID_PARAMCONTROLTRACK + * + * The file contains an invalid parameter control track. + */ +#define DMUS_E_INVALID_PARAMCONTROLTRACK MAKE_DMHRESULTERROR(0x0222) + +/* DMUS_E_AUDIOVBSCRIPT_SYNTAXERROR + * + * A script written in AudioVBScript could not be read because it contained a statement that + * is not allowed by the AudioVBScript language. + */ +#define DMUS_E_AUDIOVBSCRIPT_SYNTAXERROR MAKE_DMHRESULTERROR(0x0223) + +/* DMUS_E_AUDIOVBSCRIPT_RUNTIMEERROR + * + * A script routine written in AudioVBScript failed because an invalid operation occurred. For example, + * adding the number 3 to a segment object would produce this error. So would attempting to call a routine + * that doesn't exist. + */ +#define DMUS_E_AUDIOVBSCRIPT_RUNTIMEERROR MAKE_DMHRESULTERROR(0x0224) + +/* DMUS_E_AUDIOVBSCRIPT_OPERATIONFAILURE + * + * A script routine written in AudioVBScript failed because a function outside of a script failed to complete. + * For example, a call to PlaySegment that fails to play because of low memory would return this error. + */ +#define DMUS_E_AUDIOVBSCRIPT_OPERATIONFAILURE MAKE_DMHRESULTERROR(0x0225) + +/* DMUS_E_AUDIOPATHS_NOT_VALID + * + * The Performance has set up some PChannels using the AssignPChannel command, which + * makes it not capable of supporting audio paths. + */ +#define DMUS_E_AUDIOPATHS_NOT_VALID MAKE_DMHRESULTERROR(0x0226) + +/* DMUS_E_AUDIOPATHS_IN_USE + * + * This is the inverse of the previous error. + * The Performance has set up some audio paths, which makes is incompatible + * with the calls to allocate pchannels, etc. + */ +#define DMUS_E_AUDIOPATHS_IN_USE MAKE_DMHRESULTERROR(0x0227) + +/* DMUS_E_NO_AUDIOPATH_CONFIG + * + * A segment was asked for its embedded audio path configuration, + * but there isn't any. + */ +#define DMUS_E_NO_AUDIOPATH_CONFIG MAKE_DMHRESULTERROR(0x0228) + +/* DMUS_E_AUDIOPATH_INACTIVE + * + * An audiopath is inactive, perhaps because closedown was called. + */ +#define DMUS_E_AUDIOPATH_INACTIVE MAKE_DMHRESULTERROR(0x0229) + +/* DMUS_E_AUDIOPATH_NOBUFFER + * + * An audiopath failed to create because a requested buffer could not be created. + */ +#define DMUS_E_AUDIOPATH_NOBUFFER MAKE_DMHRESULTERROR(0x022A) + +/* DMUS_E_AUDIOPATH_NOPORT + * + * An audiopath could not be used for playback because it lacked port assignments. + */ +#define DMUS_E_AUDIOPATH_NOPORT MAKE_DMHRESULTERROR(0x022B) + +/* DMUS_E_NO_AUDIOPATH + * + * Attempt was made to play segment in audiopath mode and there was no audiopath. + */ +#define DMUS_E_NO_AUDIOPATH MAKE_DMHRESULTERROR(0x022C) + +/* DMUS_E_INVALIDCHUNK + * + * Invalid data was found in a RIFF file chunk. + */ +#define DMUS_E_INVALIDCHUNK MAKE_DMHRESULTERROR(0x022D) + +/* DMUS_E_AUDIOPATH_NOGLOBALFXBUFFER + * + * Attempt was made to create an audiopath that sends to a global effects buffer which did not exist. + */ +#define DMUS_E_AUDIOPATH_NOGLOBALFXBUFFER MAKE_DMHRESULTERROR(0x022E) + +/* DMUS_E_INVALID_CONTAINER_OBJECT + * + * The file does not contain a valid container object. + */ +#define DMUS_E_INVALID_CONTAINER_OBJECT MAKE_DMHRESULTERROR(0x022F) + +#endif /* NTDDI_VERSION >= NTDDI_WINXP */ + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _DMERROR_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmusbuff.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmusbuff.h new file mode 100644 index 0000000000000000000000000000000000000000..5fba2cb8d731d0fb216b864ae51fb7b53dec0811 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dmusbuff.h @@ -0,0 +1,50 @@ +/*************************************************************************** +* * +* DMusBuff.h -- This module defines the buffer format for DirectMusic * +* Shared file between user mode and kernel mode components * +* * +* Copyright (c) 1998, Microsoft Corp. All rights reserved. * +* * +***************************************************************************/ + +#ifndef _DMusBuff_ +#define _DMusBuff_ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#include "dmdls.h" + +/* Format of DirectMusic events in a buffer + * + * A buffer contains 1 or more events, each with the following header. + * Immediately following the header is the event data. The header+data + * size is rounded to the nearest quadword (8 bytes). + */ + +#include /* Do not pad at end - that's where the data is */ +typedef struct _DMUS_EVENTHEADER *LPDMUS_EVENTHEADER; +typedef struct _DMUS_EVENTHEADER +{ + DWORD cbEvent; /* Unrounded bytes in event */ + DWORD dwChannelGroup; /* Channel group of event */ + REFERENCE_TIME rtDelta; /* Delta from start time of entire buffer */ + DWORD dwFlags; /* Flags DMUS_EVENT_xxx */ +} DMUS_EVENTHEADER; +#include + +#define DMUS_EVENT_STRUCTURED 0x00000001 /* Unstructured data (SysEx, etc.) */ + +/* The number of bytes to allocate for an event with 'cb' data bytes. + */ +#define QWORD_ALIGN(x) (((x) + 7) & ~7) +#define DMUS_EVENT_SIZE(cb) QWORD_ALIGN(sizeof(DMUS_EVENTHEADER) + cb) + + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* _DMusBuff_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dontuse.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dontuse.h new file mode 100644 index 0000000000000000000000000000000000000000..c5394a427d98bdf53c6704c5bf7ec24b788b6dca --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dontuse.h @@ -0,0 +1,595 @@ +/****************************************************************** +* * +* dontuse.h -- This module deprecates Banned APIs * +* * +* Copyright (c) Microsoft Corp. All rights reserved. * +* * +******************************************************************/ +#ifndef _DONTUSE_H_INCLUDED_ +#define _DONTUSE_H_INCLUDED_ +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + + +#ifdef DEPRECATE_SUPPORTED +// First all the names that are a/w variants (or shouldn't be #defined by now anyway). + + +//Windows +#pragma deprecated(lstrcpyA) +#pragma deprecated(lstrcpyW) +#pragma deprecated(lstrcpynA) +#pragma deprecated(lstrcpynW) +#pragma deprecated(lstrcatA) +#pragma deprecated(lstrcatW) +#pragma deprecated(lstrcatnA) +#pragma deprecated(lstrcatnW) +#pragma deprecated(wsprintfA) +#pragma deprecated(wsprintfW) +#pragma deprecated(wvsprintfA) +#pragma deprecated(wvsprintfW) + +//shlwapi +#ifndef _STRSAFE_H_INCLUDED_ +#pragma deprecated(StrCpyW) +#endif +#pragma deprecated(StrNCpyW) +#pragma deprecated(StrCpyNW) +#pragma deprecated(StrCatW) +#pragma deprecated(StrNCatW) +#pragma deprecated(StrCatNW) +#pragma deprecated(wnsprintf) +#ifndef _STRSAFE_H_INCLUDED_ +#pragma deprecated(wnsprintfW) +#endif +#pragma deprecated(wvnsprintfW) +#pragma deprecated(StrCatBuffW) + + +#if defined(_MSC_VER) && (_MSC_VER < 1700) + +//crt +#pragma deprecated(gets) +#pragma deprecated(_getws) +#pragma deprecated(strcpy) +#pragma deprecated(wcscpy) +#pragma deprecated(strncat) +#pragma deprecated(wcsncat) +#pragma deprecated(strcat) +#pragma deprecated(wcscat) +#pragma deprecated(strncpy) +#pragma deprecated(wcsncpy) +#pragma deprecated(_snprintf) +#pragma deprecated(_snwprintf) +#pragma deprecated(_vsnprintf) +#pragma deprecated(_vsnwprintf) +#pragma deprecated(vsprintf) +#pragma deprecated(vswprintf) +#pragma deprecated(sprintf) +#pragma deprecated(swprintf) +#pragma deprecated(_makepath) +#pragma deprecated(_wmakepath) +#pragma deprecated(_splitpath) +#pragma deprecated(_wsplitpath) + +#pragma deprecated(sprintfA) +#pragma deprecated(sprintfW) +#pragma deprecated(strcatA) +#pragma deprecated(strcatW) +#pragma deprecated(strcpyA) +#pragma deprecated(strcpyW) +#pragma deprecated(nsprintf) +#pragma deprecated(IsBadCodePtr) +#pragma deprecated(IsBadHugeReadPtr) +#pragma deprecated(IsBadHugeWritePtr) +#pragma deprecated(IsBadReadPtr) +#pragma deprecated(IsBadStringPtr) +#pragma deprecated(IsBadWritePtr) +#pragma deprecated(_ftccat) +#pragma deprecated("_ftccpy") +#pragma deprecated(_tccat) +#pragma deprecated("_tccpy") +#pragma deprecated(makepath) +#pragma deprecated(StrCatChainW) +#pragma deprecated(ualstrcpyW) + +#pragma deprecated(scanf) +#pragma deprecated(wscanf) +#pragma deprecated(sscanf) +#pragma deprecated(swscanf) +#pragma deprecated(_snscanf) +#pragma deprecated(_snwscanf) +#pragma deprecated(snscanf) +#pragma deprecated("swscanf") + +#endif // defined(_MSC_VER) && (_MSC_VER < 1700) + +// Then all the windows.h names - we need to undef and redef based on UNICODE setting +#undef lstrcat +#undef lstrcatn +#undef lstrcpy +#undef lstrcpyn +#undef wsprintf +#undef wvsprintf +#pragma deprecated(lstrcat) +#pragma deprecated(lstrcatn) +#pragma deprecated(lstrcpy) +#pragma deprecated(lstrcpyn) +#pragma deprecated(wsprintf) +#pragma deprecated(wvsprintf) +#ifdef UNICODE +#define lstrcat lstrcatW +#define lstrcatn lstrcatnW +#define lstrcpy lstrcpyW +#define lstrcpyn lstrcpynW +#define wsprintf wsprintfW +#define wvsprintf wvsprintfW +#else +#define lstrcat lstrcatA +#define lstrcatn lstrcatnA +#define lstrcpy lstrcpyA +#define lstrcpyn lstrcpynA +#define wsprintf wsprintfA +#define wvsprintf wvsprintfA +#endif + + + +// Then the shlwapi names - they key off UNICODE also. + +#undef StrCpyA +#undef StrCatA +#undef StrCpy +#undef StrCat +#undef StrNCat +#undef StrCatN +#undef StrCpyN +#undef StrCatNA +#undef StrCpyNA +#undef StrNCpy +#undef wvnsprintfA +#undef wvnsprintf +#undef wnsprintfA +#undef wnsprintf +#undef StrCatBuffA +#undef StrCatBuff +#pragma deprecated(StrCatNA) +#pragma deprecated(StrCpyNA) +#pragma deprecated(StrCpyA) +#pragma deprecated(StrCatA) +#pragma deprecated(StrCat) +#pragma deprecated(StrCpy) +#pragma deprecated(StrNCat) +#pragma deprecated(StrCatN) +#pragma deprecated(StrNCpy) +#pragma deprecated(StrCpyN) +#pragma deprecated(StrNCpyA) +#pragma deprecated(StrNCatA) +#pragma deprecated(wvnsprintfA) +#pragma deprecated(wvnsprintf) +#pragma deprecated(wnsprintfA) +#pragma deprecated("wnsprintf") +#pragma deprecated(StrCatBuffA) +#pragma deprecated(StrCatBuff) +#define StrCpyA lstrcpyA +#define StrCatA lstrcatA +#define StrCatN StrNCat +#define StrCpyN StrNCpy +#define wvnsprintfA vsprintf +#define wnsprintfA wsprintf +#define StrCatBuffA lstrcatA +#ifdef UNICODE +#define StrCat StrCatW +#define StrNCat StrNCatW +#define StrCpy StrCpyW +#define StrNCpy StrNCpyW +#define wvnsprintf vswprintf +#define wnsprintf wsprintf +#define StrCatBuff StrCatW +#else +#define StrCat lstrcatA +#define StrNCat StrNCatA +#define StrCpy lstrcpyA +#define StrNCpy StrNCpyA +#define wvnsprintf vsprintf +#define wnsprintf vsprintf +#define StrCatBuff lstrcatA +#endif + + +#if defined(_MSC_VER) && (_MSC_VER < 1700) + +// Then all the CRT names - we need to undef/redef based on _UNICODE value. + +#undef _getts +#undef _tcscat +#undef _tcsncat +#undef _tcscpy +#undef _tcsncpy +#undef _stprintf +#undef _vsntprintf +#undef _vstprintf +#undef _ftcscpy +#undef _ftcscat +#undef _fstrcpy +#undef _fstrcat +#undef _fstrncat +#undef _fstrncpy +#undef _sntprintf +#undef _tmakepath +#undef _tsplitpath +#undef _tscanf +#undef _stscanf +#undef _sntscanf +#pragma deprecated(_getts) +#pragma deprecated(_tcscat) +#pragma deprecated(_tcsncat) +#pragma deprecated(_tcscpy) +#pragma deprecated(_tcsncpy) +#pragma deprecated(_stprintf) +#pragma deprecated(_vsntprintf) +#pragma deprecated(_vstprintf) +#pragma deprecated("_ftcscpy") +#pragma deprecated("_ftcscat") +#pragma deprecated(_fstrcpy) +#pragma deprecated(_fstrcat) +#pragma deprecated(_fstrncat) +#pragma deprecated(_fstrncpy) +#pragma deprecated(_sntprintf) +#pragma deprecated(_tmakepath) +#pragma deprecated(_tsplitpath) +#pragma deprecated(_tscanf) +#pragma deprecated(_stscanf) +#pragma deprecated(_sntscanf) +#ifdef _UNICODE +#define _getts _getws +#define _tcscat wcscat +#define _tscncat wcsncat +#define _tcscpy wcscpy +#define _tcsncpy wcsncpy +#define _sntprintf _snwprintf +#define _vsntprintf _vsnwprintf +#define _vstprintf vswprintf +#define _ftcscpy wcscpy +#define _ftcscat wcscat +#define _fstrcpy wcscpy +#define _fstrcat wcscat +#define _fstrncpy wcsncpy +#define _fstrncat wcsncat +#define _fstrcpy wcscpy +#define _stprintf swprintf +#define _tmakepath _wmakepath +#define _tsplitpath _wsplitpath +#define _tscanf wscanf +#define _stscanf swscanf +#define _sntscanf snwscanf +#else +#define _getts gets +#define _tcscat strcat +#define _tcsncat strncat +#define _tcscpy strcpy +#define _tcsncpy strncpy +#define _sntprintf _snprintf +#define _vsntprintf _vsnprintf +#define _vstprintf vsprintf +#define _ftcscpy strcpy +#define _ftcscat strcat +#define _fstrcpy strcpy +#define _fstrcat strcat +#define _fstrncpy strncpy +#define _fstrncat strncat +#define _fstrcpy strcpy +#define _stprintf vsprintf +#define _tmakepath _makepath +#define _tsplitpath _splitpath +#define _tscanf scanf +#define _stscanf sscanf +#define _sntscanf snscanf +#endif + +#endif // defined(_MSC_VER) && (_MSC_VER < 1700) + +#else // DEPRECATE_SUPPORTED + +// WINDOWS + +#undef lstrcpy +#define lstrcpy lstrcpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy +#undef lstrcpyA +#define lstrcpyA lstrcpyA_instead_use_strcpy_s_or_StringCchCopyA_or_StringCbCopyA +#undef lstrcpyW +#define lstrcpyW lstrcpyW_instead_use_wcscpy_s_or_StringCchCopyW_or_StringCbCopyW + +#undef lstrcpyn +#define lstrcpyn lstrcpyn_instead_use_strncpy_s_or_StringCchCopyN_or_StringCbCopyN +#undef lstrcpynA +#define lstrcpynA lstrcpynA_instead_use_strncpy_s_or_StringCchCopyNA_or_StringCbCopyNA +#undef lstrcpynW +#define lstrcpynW lstrcpynW_instead_use_wcsncpy_s_or_StringCchCopyNW_or_StringCbCopyNW + +#undef lstrcat +#define lstrcat lstrcat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef lstrcatA +#define lstrcatA lstrcatA_instead_use_strcat_s_or_StringCchCatA_or_StringCbCatA +#undef lstrcatW +#define lstrcatW lstrcatW_instead_use_wcscat_s_or_StringCchCatW_or_StringCbCatW + +#undef lstrcatn +#define lstrcatn lstrcatn_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN +#undef lstrcatnA +#define lstrcatnA lstrcatnA_instead_use_strncat_s_or_StringCchCatNA_or_StringCbCatNA +#undef lstrcatnW +#define lstrcatnW lstrcatnW_instead_use_wcsncat_s_or_StringCchCatNW_or_StringCbCatNW + +#undef wsprintf +#define wsprintf wsprintf_instead_use_sprintf_s_or_StringCchPrintf_or_StringCbPrintf +#undef wsprintfA +#define wsprintfA wsprintfA_instead_use_sprintf_s_or_StringCchPrintfA_or_StringCbPrintfA +#undef wsprintfW +#define wsprintfW wsprintfW_instead_use_sprintf_s_or_StringCchPrintfW_or_StringCbPrintfW + +#undef wvsprintf +#define wvsprintf wvsprintf_instead_use_vsprintf_s_or_StringCchVPrintf_or_StringCbVPrintf +#undef wvsprintfA +#define wvsprintfA wvsprintfA_instead_use_vsprintf_s_or_StringCchVPrintfA_or_StringCbVPrintfA +#undef wvsprintfW +#define wvsprintfW wvsprintfW_instead_use_swprintf_s_or_StringCchVPrintfW_or_StringCbVPrintfW + + + +// SHLWAPI + +#undef StrCpy +#define StrCpy StrCpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy +#undef StrCpyA +#define StrCpyA StrCpyA_instead_use_strcpy_s_or_StringCchCopyA_or_StringCbCopyA +#undef StrCpyW +#define StrCpyW StrCpyW_instead_use_wcscpy_s_or_StringCchCopyW_or_StringCbCopyW + +#undef StrNCpy +#define StrNCpy StrNCpy_instead_use_strncpy_s_or_StringCchCopyN_or_StringCbCopyN +#undef StrNCpyA +#define StrNCpyA StrNCpyA_instead_use_strncpy_s_or_StringCchCopyNA_or_StringCbCopyNA +#undef StrNCpyW +#define StrNCpyW StrNCpyW_instead_use_wcsncpy_s_or_StringCchCopyNW_or_StringCbCopyNW + +#undef StrCpyN +#define StrCpyN StrCpyN_instead_use_strncpy_s_or_StringCchCopyN_or_StringCbCopyN +#undef StrCpyNA +#define StrCpyNA StrCpyNA_instead_use_strncpy_s_or_StringCchCopyNA_or_StringCbCopyNA +#undef StrCpyNW +#define StrCpyNW StrCpyNW_instead_use_wcsncpy_s_or_StringCchCopyNW_or_StringCbCopyNW + +#undef StrCat +#define StrCat StrCat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef StrCatA +#define StrCatA StrCatA_instead_use_strcat_s_or_StringCchCatA_or_StringCbCatA +#undef StrCatW +#define StrCatW StrCatW_instead_use_wcscat_s_or_StringCchCatW_or_StringCbCatW + +#undef StrNCat +#define StrNCat StrNCat_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN +#undef StrNCatA +#define StrNCatA StrNCatA_instead_use_strncat_s_or_StringCchCatNA_or_StringCbCatNA +#undef StrNCatW +#define StrNCatW StrNCatW_instead_use_wcsncat_s_or_StringCchCatNW_or_StringCbCatNW + +#undef StrCatN +#define StrCatN StrCatN_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN +#undef StrCatNA +#define StrCatNA StrCatNA_instead_use_strncat_s_or_StringCchCatNA_or_StringCbCatNA +#undef StrCatNW +#define StrCatNW StrCatNW_instead_use_wcsncat_s_or_StringCchCatNW_or_StringCbCatNW + +#undef wnsprintf +#define wnsprintf wnsprintf_instead_use_vsprintf_s_or_StringCchPrintf_or_StringCbPrintf +#undef wnsprintfA +#define wnsprintfA wnsprintfA_instead_use_vsprintf_s_or_StringCchPrintfA_or_StringCbPrintfA +#undef wnsprintfW +#define wnsprintfW wnsprintfW_instead_use_vswprintf_s_or_StringCchPrintfW_or_StringCbPrintfW + +#undef wvnsprintf +#define wvnsprintf wvnsprintf_instead_use_vsprintf_s_or_StringCchVPrintf_or_StringCbVPrintf +#undef wvnsprintfA +#define wvnsprintfA wvnsprintfA_instead_use_vsprintf_s_or_StringCchVPrintfA_or_StringCbVPrintfA +#undef wvnsprintfW +#define wvnsprintfW wvnsprintfW_instead_use_vswprintf_s_or_StringCchVPrintfW_or_StringCbVPrintfW + +#undef StrCatBuff +#define StrCatBuff StrCatBuff_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef StrCatBuffA +#define StrCatBuffA StrCatBuffA_instead_use_strcat_s_or_StringCchCatA_or_StringCbCatA +#undef StrCatBuffW +#define StrCatBuffW StrCatBuffW_instead_use_strcat_s_or_StringCchCatW_or_StringCbCatW + + +// CRT + +#undef gets +#define gets _gets_instead_use__gets_or_StringCchGets_or_StringCbGets +#undef _getws +#define _getws _getws_instead_use__getWs_or_StringCchGetsW_or_StringCbGetsW +#undef _getts +#define _getts _getts_instead_use__gets_or_StringCchGets_or_StringCbGets + +#undef strcpy +#define strcpy strcpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy +#undef wcscpy +#define wcscpy wcscpy_instead_use_wcscpy_s_or_StringCchCopyW_or_StringCbCopyW +#undef _tcscpy +#define _tcscpy _tcscpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy + +#undef strcat +#define strcat strcat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef wcscat +#define wcscat wcscat_instead_use_wcscat_s_or_StringCchCatW_or_StringCbCatW +#undef _tcscat +#define _tcscat _tcscat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat + +#undef strncat +#define strncat strncat_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN +#undef wcsncat +#define wcsncat wcsncat_instead_use_wcsncat_s_or_StringCchCatNW_or_StringCbCatNW +#undef _tcsncat +#define _tcsncat _tcsncat_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN + +#undef strncpy +#define strncpy strncpy_instead_use_strncpy_s_or_StringCchCpyN_or_StringCbCpyN +#undef wcsncpy +#define wcsncpy wcsncpy_instead_use_wcsncpy_s_or_StringCchCpyNW_or_StringCbCpyNW +#undef _tcsncpy +#define _tcsncpy _tcsncpy_instead_use_strncpy_s_or_StringCchCpyN_or_StringCbCpyN + +#undef _snprintf +#define _snprintf _snprintf_instead_use_snprintf_s_or_StringCchPrintf_or_StringCbPrintf +#undef _snwprintf +#define _snwprintf _snwprintf_instead_use_snwprintf_s_or_StringCchPrintfW_or_StringCbPrintfW +#undef _sntprintf +#define _sntprintf _sntprintf_instead_use_sprintf_s_or_StringCchPrintf_or_StringCbPrintf + +#undef _vsnprintf +#define _vsnprintf _vsnprintf_instead_use_vsnprintf_s_or_StringCchVPrintf_or_StringCbVPrintf +#undef _vsnwprintf +#define _vsnwprintf _vsnwprintf_instead_use_vsnwprintf_s_or_StringCchVPrintfW_or_StringCbVPrintfW +#undef _vsntprintf +#define _vsntprintf _vsntprintf_instead_use_vsprintf_s_or_StringCchVPrintf_or_StringCbVPrintf + +#undef vsprintf +#define vsprintf vsprintf_instead_use_vsprintf_s_or_StringCchVPrintf_or_StringCbVPrintf +#undef vswprintf +#define vswprintf vswprintf_instead_use_vswprintf_s_or_StringCchVPrintfW_or_StringCbVPrintfW +#undef _vstprintf +#define _vstprintf _vstprintf_instead_use_vsprintf_s_or_StringCchVPrintf_or_StringCbVPrintf + +#undef sprintf +#define sprintf sprintf_instead_use_sprintf_s_or_StringCchPrintf_or_StringCbPrintf +#undef swprintf +#define swprintf swprintf_instead_use_swprintf_s_or_StringCchPrintfW_or_StringCbPrintfW +#undef _stprintf +#define _stprintf _stprintf_instead_use_vsprintf_s_or_StringCchPrintf_or_StringCbPrintf + +#undef _makepath +#define _makepath _makepath_instead_use_makepath_s +#undef _wmakepath +#define _wmakepath _wmakepath_instead_use_wmakepath_s +#undef _tmakepath +#define _tmakepath _tmakepath_instead_use_tmakepath_s + +#undef _splitpath +#define _splitpath _splitpath_instead_use_splitpath_s +#undef _wsplitpath +#define _wsplitpath _wsplitpath_instead_use_wsplitpath_s +#undef _tsplitpath +#define _tsplitpath _tsplitpath_instead_use_tsplitpath_s + +#undef scanf +#define scanf scanf_instead_use_scanf_S +#undef wscanf +#define wscanf wscanf_instead_use_wscanf_S +#undef _tscanf +#define _tscanf _tscanf_instead_use_scanf_S + +#undef sscanf +#define sscanf sscanf_instead_use_sscanf_S +#undef swscanf +#define swscanf swscanf_instead_use_swscanf_s +#undef _stscanf +#define _stscanf _stscanf_instead_use_sscanf_S + +#undef _snscanf +#define _snscanf _snscanf_instead_use__snscanf_s +#undef _snwscanf +#define _snwscanf _snwscanf_instead_use__snwscanf_s +#undef snscanf +#define snscanf snscanf_instead_use__snscanf_s +#undef swscanf +#define swscanf swscanf_instead_use__snwscanf_s +#undef _sntscanf +#define _sntscanf _sntscanf_instead_use__snscanf_s + +#undef _ftcscat +#define _ftcscat _ftcscat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef _ftcscpy +#define _ftcscpy _ftcscpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy +#undef _fstrcat +#define _fstrcat _fstrcat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat +#undef _fstrcpy +#define _fstrcpy _fstrcpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy +#undef _fstrncat +#define _fstrncat _fstrncat_instead_use_strncat_s_or_StringCchCatN_or_StringCbCatN +#undef _fstrncpy +#define _fstrncpy _fstrncpy_instead_use_strncpy_s_or_StringCchCpyN_or_StringCbCpyN + + + +// MISC + +#undef sprintfA +#define sprintfA sprintfA_instead_use_sprintf_s_or_StringCchPrintfA_or_StringCbPrintfA +#undef sprintfW +#define sprintfW sprintfW_instead_use_swprintf_s_or_StringCchPrintfW_or_StringCbPrintfW + +#undef strcpyA +#define strcpyA strcpyA_instead_use_strcpy_s_or_StringCchCopyA_or_StringCbCopyA +#undef strcpyW +#define strcpyW strcpyW_instead_use_wcscpy_s_or_StringCchCopyW_or_StringCbCopyW + +#undef strcatA +#define strcatA strcatA_instead_use_strcat_s_or_StringCchCatA_or_StringCbCatA +#undef strcatW +#define strcatW strcatW_instead_use_wcscat_s_or_StringCchCatW_or_StringCbCatW + +#undef nsprintf +#define nsprintf nsprintf_instead_use_vsprintf_s_or_StringCchPrintf_or_StringCbPrintf + +#undef IsBadCodePtr +#define IsBadCodePtr IsBadCodePtr_is_no_longer_supported + +#undef IsBadHugeReadPtr +#define IsBadHugeReadPtr IsBadHugeReadPtr_is_no_longer_supported + +#undef IsBadHugeWritePtr +#define IsBadHugeWritePtr IsBadHugeWritePtr_is_no_longer_supported + +#undef IsBadReadPtr +#define IsBadReadPtr IsBadReadPtr_is_no_longer_supported + +#undef IsBadStringPtr +#define IsBadStringPtr IsBadStringPtr_is_no_longer_supported + +#undef IsBadWritePtr +#define IsBadWritePtr IsBadWritePtr_is_no_longer_supported + +#undef _ftccat +#define _ftccat _ftccat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat + +#undef _ftccpy +#define _ftccpy _ftccpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy + +#undef _tccat +#define _tccat _tccat_instead_use_strcat_s_or_StringCchCat_or_StringCbCat + +#undef _tccpy +#define _tccpy _tccpy_instead_use_strcpy_s_or_StringCchCopy_or_StringCbCopy + +#undef makepath +#define makepath makepath_instead_use_makepath_s_or_wmakepath_s + +#undef StrCatChainW +#define StrCatChainW StrCatChainW_is_no_longer_supported + +#undef ualstrcpyW +#define ualstrcpyW ualstrcpyW_is_no_longer_supported + + +#endif // !DEPRECATE_SUPPORTED + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _DONTUSE_H_INCLUDED_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dpfilter.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dpfilter.h new file mode 100644 index 0000000000000000000000000000000000000000..fe377fa9a2ff444a87ec205eb3b9b99894a71371 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dpfilter.h @@ -0,0 +1,169 @@ +// +// Component name filter id enumeration and levels. +// + +#define DPFLTR_ERROR_LEVEL 0 +#define DPFLTR_WARNING_LEVEL 1 +#define DPFLTR_TRACE_LEVEL 2 +#define DPFLTR_INFO_LEVEL 3 +#define DPFLTR_MASK 0x80000000 + +typedef enum _DPFLTR_TYPE { + DPFLTR_SYSTEM_ID = 0, + DPFLTR_SMSS_ID = 1, + DPFLTR_SETUP_ID = 2, + DPFLTR_NTFS_ID = 3, + DPFLTR_FSTUB_ID = 4, + DPFLTR_CRASHDUMP_ID = 5, + DPFLTR_CDAUDIO_ID = 6, + DPFLTR_CDROM_ID = 7, + DPFLTR_CLASSPNP_ID = 8, + DPFLTR_DISK_ID = 9, + DPFLTR_REDBOOK_ID = 10, + DPFLTR_STORPROP_ID = 11, + DPFLTR_SCSIPORT_ID = 12, + DPFLTR_SCSIMINIPORT_ID = 13, + DPFLTR_CONFIG_ID = 14, + DPFLTR_I8042PRT_ID = 15, + DPFLTR_SERMOUSE_ID = 16, + DPFLTR_LSERMOUS_ID = 17, + DPFLTR_KBDHID_ID = 18, + DPFLTR_MOUHID_ID = 19, + DPFLTR_KBDCLASS_ID = 20, + DPFLTR_MOUCLASS_ID = 21, + DPFLTR_TWOTRACK_ID = 22, + DPFLTR_WMILIB_ID = 23, + DPFLTR_ACPI_ID = 24, + DPFLTR_AMLI_ID = 25, + DPFLTR_HALIA64_ID = 26, + DPFLTR_VIDEO_ID = 27, + DPFLTR_SVCHOST_ID = 28, + DPFLTR_VIDEOPRT_ID = 29, + DPFLTR_TCPIP_ID = 30, + DPFLTR_DMSYNTH_ID = 31, + DPFLTR_NTOSPNP_ID = 32, + DPFLTR_FASTFAT_ID = 33, + DPFLTR_SAMSS_ID = 34, + DPFLTR_PNPMGR_ID = 35, + DPFLTR_NETAPI_ID = 36, + DPFLTR_SCSERVER_ID = 37, + DPFLTR_SCCLIENT_ID = 38, + DPFLTR_SERIAL_ID = 39, + DPFLTR_SERENUM_ID = 40, + DPFLTR_UHCD_ID = 41, + DPFLTR_RPCPROXY_ID = 42, + DPFLTR_AUTOCHK_ID = 43, + DPFLTR_DCOMSS_ID = 44, + DPFLTR_UNIMODEM_ID = 45, + DPFLTR_SIS_ID = 46, + DPFLTR_FLTMGR_ID = 47, + DPFLTR_WMICORE_ID = 48, + DPFLTR_BURNENG_ID = 49, + DPFLTR_IMAPI_ID = 50, + DPFLTR_SXS_ID = 51, + DPFLTR_FUSION_ID = 52, + DPFLTR_IDLETASK_ID = 53, + DPFLTR_SOFTPCI_ID = 54, + DPFLTR_TAPE_ID = 55, + DPFLTR_MCHGR_ID = 56, + DPFLTR_IDEP_ID = 57, + DPFLTR_PCIIDE_ID = 58, + DPFLTR_FLOPPY_ID = 59, + DPFLTR_FDC_ID = 60, + DPFLTR_TERMSRV_ID = 61, + DPFLTR_W32TIME_ID = 62, + DPFLTR_PREFETCHER_ID = 63, + DPFLTR_RSFILTER_ID = 64, + DPFLTR_FCPORT_ID = 65, + DPFLTR_PCI_ID = 66, + DPFLTR_DMIO_ID = 67, + DPFLTR_DMCONFIG_ID = 68, + DPFLTR_DMADMIN_ID = 69, + DPFLTR_WSOCKTRANSPORT_ID = 70, + DPFLTR_VSS_ID = 71, + DPFLTR_PNPMEM_ID = 72, + DPFLTR_PROCESSOR_ID = 73, + DPFLTR_DMSERVER_ID = 74, + DPFLTR_SR_ID = 75, + DPFLTR_INFINIBAND_ID = 76, + DPFLTR_IHVDRIVER_ID = 77, + DPFLTR_IHVVIDEO_ID = 78, + DPFLTR_IHVAUDIO_ID = 79, + DPFLTR_IHVNETWORK_ID = 80, + DPFLTR_IHVSTREAMING_ID = 81, + DPFLTR_IHVBUS_ID = 82, + DPFLTR_HPS_ID = 83, + DPFLTR_RTLTHREADPOOL_ID = 84, + DPFLTR_LDR_ID = 85, + DPFLTR_TCPIP6_ID = 86, + DPFLTR_ISAPNP_ID = 87, + DPFLTR_SHPC_ID = 88, + DPFLTR_STORPORT_ID = 89, + DPFLTR_STORMINIPORT_ID = 90, + DPFLTR_PRINTSPOOLER_ID = 91, + DPFLTR_VSSDYNDISK_ID = 92, + DPFLTR_VERIFIER_ID = 93, + DPFLTR_VDS_ID = 94, + DPFLTR_VDSBAS_ID = 95, + DPFLTR_VDSDYN_ID = 96, + DPFLTR_VDSDYNDR_ID = 97, + DPFLTR_VDSLDR_ID = 98, + DPFLTR_VDSUTIL_ID = 99, + DPFLTR_DFRGIFC_ID = 100, + DPFLTR_DEFAULT_ID = 101, + DPFLTR_MM_ID = 102, + DPFLTR_DFSC_ID = 103, + DPFLTR_WOW64_ID = 104, + DPFLTR_ALPC_ID = 105, + DPFLTR_WDI_ID = 106, + DPFLTR_PERFLIB_ID = 107, + DPFLTR_KTM_ID = 108, + DPFLTR_IOSTRESS_ID = 109, + DPFLTR_HEAP_ID = 110, + DPFLTR_WHEA_ID = 111, + DPFLTR_USERGDI_ID = 112, + DPFLTR_MMCSS_ID = 113, + DPFLTR_TPM_ID = 114, + DPFLTR_THREADORDER_ID = 115, + DPFLTR_ENVIRON_ID = 116, + DPFLTR_EMS_ID = 117, + DPFLTR_WDT_ID = 118, + DPFLTR_FVEVOL_ID = 119, + DPFLTR_NDIS_ID = 120, + DPFLTR_NVCTRACE_ID = 121, + DPFLTR_LUAFV_ID = 122, + DPFLTR_APPCOMPAT_ID = 123, + DPFLTR_USBSTOR_ID = 124, + DPFLTR_SBP2PORT_ID = 125, + DPFLTR_COVERAGE_ID = 126, + DPFLTR_CACHEMGR_ID = 127, + DPFLTR_MOUNTMGR_ID = 128, + DPFLTR_CFR_ID = 129, + DPFLTR_TXF_ID = 130, + DPFLTR_KSECDD_ID = 131, + DPFLTR_FLTREGRESS_ID = 132, + DPFLTR_MPIO_ID = 133, + DPFLTR_MSDSM_ID = 134, + DPFLTR_UDFS_ID = 135, + DPFLTR_PSHED_ID = 136, + DPFLTR_STORVSP_ID = 137, + DPFLTR_LSASS_ID = 138, + DPFLTR_SSPICLI_ID = 139, + DPFLTR_CNG_ID = 140, + DPFLTR_EXFAT_ID = 141, + DPFLTR_FILETRACE_ID = 142, + DPFLTR_XSAVE_ID = 143, + DPFLTR_SE_ID = 144, + DPFLTR_DRIVEEXTENDER_ID = 145, + DPFLTR_POWER_ID = 146, + DPFLTR_CRASHDUMPXHCI_ID = 147, + DPFLTR_GPIO_ID = 148, + DPFLTR_REFS_ID = 149, + DPFLTR_WER_ID = 150, + DPFLTR_CAPIMG_ID = 151, + DPFLTR_VPCI_ID = 152, + DPFLTR_STORAGECLASSMEMORY_ID = 153, + DPFLTR_FSLIB_ID = 154, + DPFLTR_ENDOFTABLE_ID +} DPFLTR_TYPE; + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/driverspecs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/driverspecs.h new file mode 100644 index 0000000000000000000000000000000000000000..54d30eb63b0e30a7a765f784567882892a334c9c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/driverspecs.h @@ -0,0 +1,901 @@ +/*****************************************************************************\ +* * +* DriverSpecs.h - markers for documenting the semantics of driver APIs * +* See also * +* * +* Version 1.2.10 * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +\*****************************************************************************/ + +/*****************************************************************************\ +* NOTE * +* NOTE * +* NOTE * +* The macro bodies in this file are subject to change without notice. * +* Attempting to use the annotations in the macro bodies directly is not * +* supported. * +* NOTE * +* NOTE * +* NOTE * +\*****************************************************************************/ + +/*****************************************************************************\ +* The annotations described by KernelSpecs.h and DriverSpecs.h, taken together, +* are used to annotate drivers. Many of the annotations are applicable to +* user space code (including subsystems) as well as to drivers. +* +* DriverSpecs.h contains those annotations which are appropriate to userspace +* code, or which might appear in headers that are shared between user space +* and kernel space. In the case of annotations which might appear in such a +* shared header, but which are meaningless in user space, the annotations are +* #defined to nothing in DriverSpecs.h. +* +* KernelSpecs.h contains those annotations which either will only appear in +* kernel code or headers; or which might appear in shared headers. In the +* latter case, it is assumed that DriverSpecs.h has been #included, and +* the anntoations are re-defined (using #undef) to give them a meaningful +* value. In general, documentation for the shared-header annotations appears +* in DriverSpecs.h. +* +* Many annotations are context dependent. They only apply to certain versions +* of Windows, or only to certain classes of driver. These rules can be written +* using something like _When_(NTDDI_VERSION >= NTDDI_WINXP, ...) +* which causes the rule only to apply to Windows XP and later. Many of these +* symbols are already defined in various Windows headers. +* +* To facilitate using this sort of conditional rule, we collect here the +* various known symbols that are (or reasonably might) be used in such +* a conditional annotation. Some are speculative in that the symbol has +* not yet been defined because there are no known uses of it yet. +* +* Where the symbol already exists its relevant header is +* noted below (excluding the "really well known" ones). +* +* Each symbol is listed with the currently known possible values. +* +* Some symbols are marked as #define symbols -- they are used with #ifdef +* operators only. To use them in _When_, use something like +* _When_(__drv_defined(NT), ...). +* +* WDK Version (copied for convenience from sdkddkver.h) +* NTDDI_VERSION: NTDDI_WIN2K NTDDI_WIN2KSP1 NTDDI_WIN2KSP2 NTDDI_WIN2KSP3 +* NTDDI_WIN2KSP4 NTDDI_WINXP NTDDI_WINXPSP1 NTDDI_WINXPSP2 +* NTDDI_WS03 NTDDI_WS03SP1 NTDDI_VISTA +* The WDK version is taken as the WDM version as well. +* +* OS Version: (copied for convenience from sdkddkver.h) +* _WIN32_WINNT: _WIN32_WINNT_NT4 _WIN32_WINNT_WIN2K _WIN32_WINNT_WINXP +* _WIN32_WINNT_WS03 _WIN32_WINNT_LONGHORN +* WINVER: 0x030B 0x0400 0x0500 0x0600 +* NT (#define symbol) +* (sdkddkver.h also defines symbols for IE versions should they be needed.) +* +* Compiler Version: +* _MSC_VER: too many to list. +* _MSC_FULL_VER: too many to list. +* +* KMDF Version: (Currently defined/used only in makefiles.) +* KMDF_VERSION_MAJOR: 1 +* +* UMDF Version: (Currently defined/used only in makefiles.) +* UMDF_VERSION_MAJOR: 1 +* +* Architecture kinds: +* __WIN64 (#define symbols) +* _X86_ +* _AMD64_ +* _IA64_ +* +* Machine Architectures: +* _M_IX86 +* _M_AMD64 +* _M_IA64 +* +* Driver Kind (NYI: "not yet implemented") +* Typically these will be defined in the most-common header for a +* particular driver (or in individual source files if appropriate). +* These are not intended to necessarily be orthogonal: more than one might +* apply to a particular driver. +* _DRIVER_TYPE_BUS: 1 // NYI +* _DRIVER_TYPE_FUNCTIONAL: 1 // NYI +* _DRIVER_TYPE_MINIPORT: 1 // NYI +* _DRIVER_TYPE_STORAGE: 1 // NYI +* _DRIVER_TYPE_DISPLAY: 1 // NYI +* _DRIVER_TYPE_FILESYSTEM: 1 +* _DRIVER_TYPE_FILESYSTEM_FILTER: 1 +* +* NDIS driver version: (see ndis.h for much more detail.) +* These can be used to both identify an NDIS driver and to check the version. +* NDIS40 NDIS50 NDIS51 NDIS60 (#defined symbols) +* NDIS_PROTOCOL_MAJOR_VERSION.NDIS_PROTOCOL_MINOR_VERSION: 4.0 5.0 5.1 6.0 +* And many others in ndis.h (including MINIPORT) +* +\*****************************************************************************/ + +#ifndef DRIVERSPECS_H +#define DRIVERSPECS_H + +// In case driverspecs.h is included directly (and w/o specstrings.h) +#ifndef SPECSTRINGS_H +#include +#endif + +#include "sdv_driverspecs.h" +#include + +#if _MSC_VER > 1000 // [ +#pragma once +#endif // ] + +#ifdef __cplusplus // [ +extern "C" { +#endif // ] + +#if (_MSC_VER >= 1000) && !defined(__midl) && defined(_PREFAST_) && defined(_MSC_EXTENSIONS)// [ + + // --------------------------------------------------------------------- + // Processing mode selection: + // + // __internal_kernel_driver + // + // Flag for headers that indicates a probable driver. + // This should only be coded in headers that are normally used + // as the "primary" header for a class of drivers. It sets the + // default to kernel mode driver. + // + // ';' inside the parens to keep MIDL happy + __ANNOTATION(SAL_internal_kernel_driver(void);) + + #define __internal_kernel_driver \ + _Analysis_mode_(_Analysis_internal_kernel_driver_) \ + _Analysis_mode_(_Analysis_local_leak_checks_) + + // + // __kernel_code + // __kernel_driver + // __user_driver + // __user_code + // + // Flags for compilation units that indicated specifically what kind of + // code it is. + // These should be coded as early as possible in any compilation unit + // (.c/.cpp file) that doesn't get the correct default. Whether before + // or after __internal_kernel_driver + // + // Indicate that the code is kernel, but not driver, code. + + __ANNOTATION(SAL_kernel(void);) + __ANNOTATION(SAL_nokernel(void);) + __ANNOTATION(SAL_driver(void);) + __ANNOTATION(SAL_nodriver(void);) + + #define __kernel_code \ + _Analysis_mode_(_Analysis_code_type_kernel_code_) \ + _Analysis_mode_(_Analysis_local_leak_checks_) + + // Indicate that the code is kernel, driver, code. + #define __kernel_driver \ + _Analysis_mode_(_Analysis_code_type_kernel_driver_) \ + _Analysis_mode_(_Analysis_local_leak_checks_) + + // Indicate that the code is a user mode driver. + #define __user_driver \ + _Analysis_mode_(_Analysis_code_type_user_driver_) \ + _Analysis_mode_(_Analysis_local_leak_checks_) + + // Indicate that the code is ordinary user mode code. + #define __user_code \ + _Analysis_mode_(_Analysis_code_type_user_code_) \ + _Analysis_mode_(_Analysis_local_leak_checks_) + + // "landmark" function definition to pass information to the + // analysis tools, as needed. + + __ANNOTATION(SAL_landmark(__In_impl_ char *);) + + #define _Landmark_(name) _SAL_L_Source_(_Landmark_, (name), \ + _SA_annotes1(SAL_landmark, #name)) + + #define __drv_Mode_impl(x) \ + _Landmark_(x) \ + __inline void __GENSYM(__SAL_dummy_)(void){} + + // Macros to declare a function to be a particular class + // of driver. + + #define __drv_WDM __drv_Mode_impl(WDM) + #define __drv_KMDF __drv_Mode_impl(KMDF) + #define __drv_NDIS __drv_Mode_impl(NDIS) + + // Inform PREfast that operator new does [not] throw. + // Be sure you really know which is actually in use before using one of + // these. The default is throwing (and cannot return NULL) which is + // standard conformant, but much kernel code links with a non-throwing + // operator new. + // + // Header will set the default to throwing, so be sure to place + // this after that header is included. + // + // Be sure to use these macros for this purpose as the implementation + // could change. + + #define __prefast_operator_new_throws \ + void* __cdecl operator new(size_t size) throw(std::bad_alloc); \ + void* __cdecl operator new[](size_t size) throw(std::bad_alloc); \ + _Analysis_mode_(_Analysis_operator_new_throw_) + + #define __prefast_operator_new_null \ + void* __cdecl operator new(size_t size) throw(); \ + void* __cdecl operator new[](size_t size) throw(); \ + _Analysis_mode_(_Analysis_operator_new_null_) + + + // Paging information: + // _Analysis_assume_section_locked_(n) + // _Analysis_assume_section_unlocked_(n) + // A call will be made to , and we should assume it is [not] + // locked in memory. + + // Past this point, the named section is assumed to be locked in + // memory, and calls to that section are deemed safe. + // This is only used when dynamically locked pages are being used. + __inline __nothrow + void __AnalysisAssumeLockedSection(__In_impl_ char *p); + __inline __nothrow + void __AnalysisAssumeUnlockedSection(__In_impl_ char *p); + + #define _Analysis_assume_section_locked_(name) \ + __AnalysisAssumeLockedSection(name) + #define _Analysis_assume_section_unlocked_(name) \ + __AnalysisAssumeUnlockedSection(name) + +#else // ][ + + #define __internal_kernel_driver + #define __kernel_code + #define __kernel_driver + #define __user_driver + #define __user_code + #define __drv_Mode_impl(x) + #define __drv_WDM + #define __drv_KMDF + #define __drv_NDIS + #define __prefast_operator_new_throws + #define __prefast_operator_new_null + + #define _Analysis_assume_section_locked_(name) + #define _Analysis_assume_section_unlocked_(name) + +#endif // ] + + // Callback with high IRQL level will never actually be called above + // 'level' + #define _IRQL_limited_to_(level) \ + ASSERT(KeGetCurrentIrql() <= level); \ + _Analysis_assume_(KeGetCurrentIrql() <= level); + + // core macros: these provide syntatic wrappers to make other uses + // simpler. + // + // For example: + // __drv_in(__drv_nonconstant __setsIRQL) + + #define __drv_deref(annotes) __deref _Group_(annotes _SAL_nop_impl_) + #define __drv_in(annotes) _Pre_ _Group_(annotes _SAL_nop_impl_) + #define __drv_in_deref(annotes) _Pre_ __deref _Group_(annotes _SAL_nop_impl_) + #define __drv_out(annotes) _Post_ _Group_(annotes _SAL_nop_impl_) + #define __drv_out_deref(annotes) _Post_ __deref _Group_(annotes _SAL_nop_impl_) + #define __drv_when(cond, annotes) _When_(cond, annotes _SAL_nop_impl_) + #define __drv_at(expr,annotes) _At_(expr, annotes _SAL_nop_impl_) + + #define __drv_fun(annotes) _At_(return,annotes _SAL_nop_impl_) + #define __drv_ret(annotes) _At_(return,annotes _SAL_nop_impl_) + #define __drv_arg(expr,annotes) _At_(expr,annotes) + #define __drv_unit(p) \ + typedef int ___drv_unit_##p \ + __GENSYM(__prefast_flag_kernel_driver_mode); + + // Internal macros for convenience + #define ___drv_unit_internal_kernel_driver \ + _SAL_L_Source_(__drv_unit_internal_kernel_driver, (), _SA_annotes0(SAL_internal_kernel_driver)) + + // + // __drv_unit + // + // Flags for compilation units that indicated specifically what kind of + // code it is. + // These should be coded as early as possible in any compilation unit + // (.c/.cpp file) that doesn't get the correct default. Whether before + // or after __internal_kernel_driver is immaterial as long as it will + // successfully parse. + // + // Indicate that the code is kernel, but not driver, code. + #define ___drv_unit_kernel_code \ + _SAL_L_Source_(___drv_unit_kernel_code, (), _SA_annotes0(SAL_kernel) _SA_annotes0(SAL_nodriver)) + + // Indicate that the code is kernel, driver, code. + #define ___drv_unit_kernel_driver \ + _SAL_L_Source_(___drv_unit_kernel_driver, (), _SA_annotes0(SAL_kernel) _SA_annotes0(SAL_driver)) + + // Indicate that the code is a user mode driver. + #define ___drv_unit_user_driver \ + _SAL_L_Source_(___drv_unit_user_driver, (), _SA_annotes0(SAL_nokernel) _SA_annotes0(SAL_driver)) + + // Indicate that the code is ordinary user mode code. + #define ___drv_unit_user_code \ + _SAL_L_Source_(___drv_unit_user_code, (), _SA_annotes0(SAL_nokernel) _SA_annotes0(SAL_nodriver)) + + + // These are needed for backwards compatability. + #ifndef __internal_kernel_driver + + #define __internal_kernel_driver __drv_unit(internal_kernel_driver) + #define __kernel_code __drv_unit(kernel_code) + #define __kernel_driver __drv_unit(kernel_driver) + #define __user_driver __drv_unit(user_driver) + #define __user_code __drv_unit(user_code) + + #endif + + // --------------------------------------------------------------------- + // Syntatic utilities: + // + // Needed to make the annotations convenient to use. + // + // So we can use a macro name that might be used in #ifdef context, + // where it's defined with no value. + // This should only be used inside a _When_ condition. + // + #define __drv_defined(x) _Macro_defined_( #x ) + + // --------------------------------------------------------------------- + // Callback properties: + // + // __drv_functionClass(x) + // + // Flag that the the annotated function + // is a member of that function class. Some class names are recognized + // by PREfast itself for special treatment. + // This can be tested by the condition function _In_function_class_() + // + #define __drv_functionClass(x) _SAL1_Source_(__drv_functionClass, (x), _Function_class_(x)) + + // --------------------------------------------------------------------- + // Resources: + // + // __drv_acquiresResource(kind) + // __drv_releasesResource(kind) + // __drv_acquiresResourceGlobal(kind,param) + // __drv_releasesResourceGlobal(kind,param) + // __drv_mustHold(kind) + // __drv_neverHold(kind) + // __drv_mustHoldGlobal(kind,param) + // __drv_neverHoldGlobal(kind,param) + // + // Flag that the annotated parameter acquires a resource of type kind. + // + + __ANNOTATION(SAL_acquire(__In_impl_ char *);) + #define _Kernel_acquires_resource_(kind) \ + _SAL2_Source_(_Kernel_acquires_resource_, (#kind), _Post_ _SA_annotes1(SAL_acquire, #kind)) + + #define __drv_acquiresResource(kind) \ + _SAL1_1_Source_(__drv_acquiresResource, (kind), _Acquires_lock_(_Curr_)) + + // + // Flag that the annotated parameter releases a resource of type kind. + // + __ANNOTATION(SAL_release(__In_impl_ char *);) + #define _Kernel_releases_resource_(kind) \ + _SAL2_Source_(_Kernel_releases_resource_, (#kind), _Post_ _SA_annotes1(SAL_release, #kind)) + #define __drv_releasesResource(kind) \ + _SAL1_1_Source_(__drv_releasesResource, (kind), _Releases_lock_(_Curr_)) + + // + // Flag that the annotated object acquires a global resource named by param + // + __ANNOTATION(SAL_acquireGlobal(__In_impl_ char *, ...);) + #define __drv_innerAcquiresGlobal(kind, param) \ + _SAL1_1_Source_(_drv_innerAcquiresGlobal, (#kind, param\t), _Post_ _SA_annotes2(SAL_acquireGlobal, #kind, param\t)) + #define __drv_acquiresResourceGlobal(kind,param) \ + _SAL1_1_Source_(__drv_acquiresResourceGlobal, (kind, param), _Acquires_lock_(param)) + + // + // Flag that the annotated object releases a global resource named by param + // + __ANNOTATION(SAL_releaseGlobal(__In_impl_ char *, ...);) + #define __drv_innerReleasesGlobal(kind, param) \ + _SAL1_1_Source_(__drv_InnerReleasesGlobal, (#kind, param\t), _Post_ _SA_annotes2(SAL_releaseGlobal,#kind, param\t)) + #define __drv_releasesResourceGlobal(kind, param) \ + _SAL1_1_Source_(__drv_releasesResourceGlobal, (kind, param), _Releases_lock_(param)) + + // + // Flag that the annotated parameter must hold a resource of type kind + // + __ANNOTATION(SAL_mustHold(__In_impl_ char *);) + #define _Kernel_requires_resource_held_(kind) \ + _SAL2_Source_(_Kernel_requires_resource_held_, (#kind), _Pre_ _SA_annotes1(SAL_mustHold, #kind)) + + #define __drv_mustHold(kind) \ + _SAL_L_Source_(_drv_mustHold, (kind), \ + _When_(!_Arg_comp_(#kind,"Memory"), _Requires_lock_held_(_Curr_)) \ + _When_(_Arg_comp_(#kind,"Memory"), _Kernel_requires_resource_held_(kind))) + + // + // Flag that the annotated object must hold a global resource named by param + // + __ANNOTATION(SAL_mustHoldGlobal(__In_impl_ char *, ...);) + #define __drv_innerMustHoldGlobal(kind, param) \ + _SAL_L_Source_(__drv_innerMustHoldGlobal, (#kind, param\t), _Pre_ _SA_annotes2(SAL_mustHoldGlobal, #kind, param\t)) + #define __drv_mustHoldGlobal(kind,param) \ + _SAL1_1_Source_(__drv_mustHoldGlobal, (kind, param), _Requires_lock_held_(param)) + + // + // Flag that the annotated parameter must never hold a resource of type kind + // + __ANNOTATION(SAL_neverHold(__In_impl_ char *);) + #define _Kernel_requires_resource_not_held_(kind) \ + _SAL2_Source_(_Kernel_requires_resource_not_held_, (#kind), _Pre_ _SA_annotes1(SAL_neverHold, #kind)) + + #define __drv_neverHold(kind) \ + _SAL1_1_Source_(__drv_neverHold, (kind), _Requires_lock_not_held_(_Curr_)) + + // + // Flag that the annotated object must never hold a global resource + // of type kind named by param. + // + __ANNOTATION(SAL_neverHoldGlobal(__In_impl_ char *, ...);) + #define __drv_innerNeverHoldGlobal(kind, param) \ + _SAL_L_Source_(__drv_innterNeverHoldGlobal, (#kind, param\t), _Pre_ _SA_annotes2(SAL_neverHoldGlobal, #kind, param\t)) + #define __drv_neverHoldGlobal(kind,param) \ + _SAL1_1_Source_(__drv_neverHoldGlobal, (kind, param), _Requires_lock_not_held_(param)) + + // Predicates to determine if a resource is held + __PRIMOP(int, _Holds_resource_(__In_impl_ __deferTypecheck char *,__In_impl_ char *);) + __PRIMOP(int, _Holds_resource_global_(__In_impl_ char *, ...);) + + // + // --------------------------------------------------------------------- + // IRQL annotations: + // + // _IRQL_raises_(irql) + // _IRQL_requires_(irql) + // _IRQL_requires_max_(irql) + // _IRQL_requires_min_(irql) + // _IRQL_saves_ + // _IRQL_saves_global_(kind,param) + // _IRQL_restores_ + // _IRQL_restores_global_(kind,param) + // _IRQL_always_function_min_(irql) + // _IRQL_always_function_max_(irql) + // _IRQL_requires_same_ + // _IRQL_uses_cancel_ + // + // Legacy IRQL annotations: + // Legacy annotation: Use instead: + // __drv_setsIRQL (Obsolete, use _IRQL_raises_) + // __drv_raisesIRQL _IRQL_raises_ + // __drv_requiresIRQL _IRQL_requires_ + // __drv_maxIRQL _IRQL_requires_max_ + // __drv_minIRQL _IRQL_requires_min_ + // __drv_savesIRQL _IRQL_saves_ + // __drv_savesIRQLGlobal _IRQL_saves_global_ + // __drv_restoresIRQL _IRQL_restores_ + // __drv_restoresIRQLGlobal _IRQL_restores_global_ + // __drv_minFunctionIRQL _IRQL_always_function_min_ + // __drv_maxFunctionIRQL _IRQL_always_function_max_ + // __drv_sameIRQL _IRQL_requires_same_ + // __drv_useCancelIRQL _IRQL_uses_cancel_ + // + + // + // The function exits at IRQL irql (obsolete, use _IRQL_raises_) + // + #define __drv_setsIRQL(irql) /* see kernelspecs.h, legacy */ + + // + // The function exits at IRQL irql, but this may only raise the irql. + // + #define _IRQL_raises_(irql) /* see kernelspecs.h */ + #define __drv_raisesIRQL _SAL1_1_Source_(__drv_raisesIRQL, (), _IRQL_raises_) /* legacy */ + + // + // The called function must be entered at IRQL level + // + #define _IRQL_requires_(irql) /* see kernelspecs.h */ + #define __drv_requiresIRQL(irql) _SAL1_1_Source_(__drv_requiresIRQL, (irql), _IRQL_requires_(irql)) /* legacy */ + + // + // The maximum IRQL at which the function may be called. + // + #define _IRQL_requires_max_(irql) /* see kernelspecs.h */ + #define __drv_maxIRQL(irql) _SAL1_1_Source_(__drv_maxIRQL, (irql), _IRQL_requires_max_(irql)) /* legacy */ + + // + // The minimum IRQL at which the function may be called. + // + #define _IRQL_requires_min_(irql) /* see kernelspecs.h */ + #define __drv_minIRQL(irql) _SAL1_1_Source_(__drv_minIRQL, (irql), _IRQL_requires_min_(irql)) /* legacy */ + + // + // The current IRQL is saved in the annotated parameter + // + #define _IRQL_saves_ /* see kernelspecs.h */ + #define __drv_savesIRQL _SAL1_1_Source_(__drv_savesIRQL, (), _IRQL_saves_) /* legacy */ + + // + // The current IRQL is saved in the (otherwise anonymous) global object + // identified by kind and further refined by param. + // + #define _IRQL_saves_global_(kind,param) /* see kernelspecs.h */ + #define __drv_savesIRQLGlobal(kind,param) _SAL1_1_Source_(__drv_savesIRQLGlobal, (kind,param), _IRQL_saves_global_(kind,param)) /* legacy */ + + // + // The current IRQL is restored from the annotated parameter + // + #define _IRQL_restores_ /* see kernelspecs.h */ + #define __drv_restoresIRQL _SAL1_1_Source_(__drv_restoresIRQL, (), _IRQL_restores_) /* legacy */ + + // + // The current IRQL is restored from the (otherwise anonymous) global + // object identified by kind and further refined by param. + // + #define _IRQL_restores_global_(kind,param) /* see kernelspecs.h */ + #define __drv_restoresIRQLGlobal(kind,param) _SAL1_1_Source_(__drv_restoresIRQLGlobal, (kind,param), _IRQL_restores_global_(kind,param)) /* legacy */ + + // + // The minimum IRQL to which the function can lower itself. The IRQL + // at entry is assumed to be that value unless overridden. + // + #define _IRQL_always_function_min_(irql) /* see kernelspecs.h */ + #define __drv_minFunctionIRQL(irql) _SAL1_1_Source_(__drv_minFunctionIRQL, (irql), _IRQL_always_function_min_(irql)) /* legacy */ + + // + // The maximum IRQL to which the function can raise itself. + // + #define _IRQL_always_function_max_(irql) /* see kernelspecs.h */ + #define __drv_maxFunctionIRQL(irql) _SAL1_1_Source_(__drv_maxFunctionIRQL, (irql), _IRQL_always_function_max_(irql)) /* legacy */ + + // + // The function must exit with the same IRQL it was entered with. + // (It may change it but it must restore it.) + // + #define _IRQL_requires_same_ /* see kernelspecs.h */ + #define __drv_sameIRQL _SAL1_1_Source_(__drv_sameIRQL, (), _IRQL_requires_same_) /* legacy */ + + // + // The annotated parameter contains the cancelIRQL, which will be restored + // by the called function. + // + #define _IRQL_uses_cancel_ /* see kernelspecs.h */ + #define __drv_useCancelIRQL _SAL1_1_Source_(__drv_usesCancelIRQL, (), _IRQL_uses_cancel_) /* legacy */ + + // + // The annotated parameter is an IRQL that will be restored and a new (probably the same) + // value will be inserted. (Use this in preference to directly coding it.) + #undef _IRQL_inout_ + #define _IRQL_inout_ \ + _IRQL_saves_ _IRQL_restores_ + + // --------------------------------------------------------------------- + // Specific function behaviors + + // The annotated function clears the requirement that DoInitializeing + // is cleared (or not). + __ANNOTATION(SAL_clearDoInit(enum __SAL_YesNo);) + #define _Kernel_clear_do_init_(yesNo) \ + _SAL2_Source_(_Kernel_clear_do_init_, (yesNo), _Post_ _SA_annotes1(SAL_clearDoInit,yesNo)) + #define __drv_clearDoInit(yesNo) _SAL1_1_Source_(__drv_clearDoInit, (yesNo), _Kernel_clear_do_init_(yesNo)) /* legacy */ + + // This is (or is like) IoGetDmaAdapter: look for misuse of DMA pointers + __ANNOTATION(SAL_IoGetDmaAdapter(void);) + #define _Kernel_IoGetDmaAdapter_ \ + _SAL2_Source_(_Kernel_IoGetDmaAdapter_, (), _Post_ _SA_annotes0(SAL_IoGetDmaAdapter)) + #define __drv_IoGetDmaAdapter _SAL1_1_Source_(__drv_IoGetDmaAdapter, (), _Kernel_IoGetDmaAdapter_) /* legacy */ + + // --------------------------------------------------------------------- + // Function and out parameter return values. + // + // __drv_valueIs() + // + // The function being annotated will return each of the specified values + // during simulation. The items in the list are , + // e.g. ==0 or <0. + // This is a ; separated list of values. The internal parser will accept + // a comma-separated list. In the future __VA_ARGS__ could be used. + // See the documentation for use of this. + // + + __ANNOTATION(SAL_return(__In_impl_ __AuToQuOtE char *);) + #define __drv_valueIs(arglist) \ + _SAL1_1_Source_(__drv_valueIs, (arglist), _Post_ _SA_annotes1(SAL_return,arglist)) + + // --------------------------------------------------------------------- + // Additional parameter checking. + // + // __drv_constant + // __drv_nonConstant + // __drv_strictTypeMatch(mode) + // __drv_strictType(type,mode) + // + // The actual parameter must evaluate to a constant (not a const). + // + #define __drv_constant _SAL1_1_Source_(__drv_constant, (), _Literal_) + + // + // The actual parameter may never evaluate to a numeric constant + // (exclusive of a const symbol). + // + #define __drv_nonConstant _SAL1_1_Source_(__drv_nonConstant, (), _Notliteral_) + + // + // The actual parameter must match the type of the annotated formal + // within the specifications set by mode. + // + __ANNOTATION(SAL_strictTypeMatch(__int64);) + #define __drv_strictTypeMatch(mode) \ + _SAL1_1_Source_(__drv_strictTypeMatch, (mode), _Pre_ _SA_annotes1(SAL_strictTypeMatch,mode)) + + // + // The actual parameter must match the type of typename (below) + // within the specifications set by mode. + // + __ANNOTATION(SAL_strictType(__In_impl_ __AuToQuOtE char *);) // currently 1/2 args + #define __drv_strictType(typename,mode) \ + _SAL1_1_Source_(__drv_strictType, (typename,mode), _Pre_ _SA_annotes2(SAL_strictType, typename, mode)) + // + // The following modes are defined: + #define __drv_typeConst 0 // constants of that type + #define __drv_typeCond 1 // plus ?: + #define __drv_typeBitset 2 // plus all operators + #define __drv_typeExpr 3 // plus literal constants + // + // The actual parameter must be data (not a pointer). Used to + // prevent passing pointers to pointers when pointers to structures + // are needed (because &pXXX is a common error when pXXX is + // intended). + #define __drv_notPointer _SAL1_1_Source_(__drv_notPointer, (), _Pre_ _SA_annotes1(SAL_mayBePointer,__no)) + + // + // Convenience for the most common form of the above. + #define __drv_isObjectPointer _SAL1_1_Source_(__drv_isObjectPointer, (), _Points_to_data_) + + // --------------------------------------------------------------------- + // Memory management + // + // __drv_aliasesMem + // __drv_allocatesMem + // __drv_freesMem + // + // The annotated parameter is "kept" by the function, creating an + // alias, and relieving any obligation to free the object. + // + __ANNOTATION(SAL_IsAliased(void);) + #define __drv_aliasesMem _SAL_L_Source_(__drv_aliasesMem, (), _Post_ _SA_annotes0(SAL_IsAliased)) + + // + // Allocate/release memory-like objects. + // Kind is unused, but should be "mem" for malloc/free + // and "object" for new/delete. + __ANNOTATION(SAL_NeedsRelease(enum __SAL_YesNo);) + #define __drv_allocatesMem(kind) _SAL_L_Source_(__drv_allocatesMem, (kind), _Post_ _SA_annotes1(SAL_NeedsRelease,__yes)) + + #define __drv_freesMem(kind) _SAL_L_Source_(__drv_freesMem, (kind), _Post_ _SA_annotes1(SAL_NeedsRelease,__no)) + + // --------------------------------------------------------------------- + // Additional diagnostics + // + // __drv_preferredFunction + // __drv_reportError + // + // + // Function 'func' should be used for reason 'why'. Often used + // conditionally. + // + __ANNOTATION(SAL_preferredFunction(__In_impl_ __AuToQuOtE char *, + __In_impl_ __AuToQuOtE char *);) + __ANNOTATION(SAL_preferredFunction3(__In_impl_ __AuToQuOtE char *, + __In_impl_ __AuToQuOtE char *, __In_impl_ __int64);) + #define __drv_preferredFunction(func,why) \ + _SAL_L_Source_(__drv_preferredFunction, (func,why), _Pre_ _SA_annotes2(SAL_preferredFunction, func, why)) + + // + // The error given by 'why' was detected. Used conditionally. + // + __ANNOTATION(SAL_error(__In_impl_ __AuToQuOtE char *);) + __ANNOTATION(SAL_error2(__In_impl_ __AuToQuOtE char *, __In_impl_ __int64);) + #define __drv_reportError(why) \ + _SAL_L_Source_(__drv_reportError, (why), _Pre_ _SA_annotes1(SAL_error,why)) + + // --------------------------------------------------------------------- + // Floating point save/restore: + // + // _Kernel_float_saved_ + // _Kernel_float_restored_ + // _Kernel_float_used_ + // __drv_floatSaved (legacy, replaced by _Kernel_float_saved_) + // __drv_floatRestored (legacy, replaced by _Kernel_float_restored_) + // __drv_floatUsed (legacy, replaced by _Kernel_float_used_) + // + // The floating point hardware was saved (available to kernel) + __ANNOTATION(SAL_floatSaved(void);) + #define _Kernel_float_saved_ _SAL2_Source_(_Kernel_float_saved_, (), _Post_ _SA_annotes0(SAL_floatSaved)) + #define __drv_floatSaved _SAL1_1_Source_(__drv_floatSaved, (), _Kernel_float_saved_) /* legacy */ + + // + // The floating point hardware was restored (no longer available) + __ANNOTATION(SAL_floatRestored(void);) + #define _Kernel_float_restored_ _SAL2_Source_(_Kernel_float_restored_, (), _Post_ _SA_annotes0(SAL_floatRestored)) + #define __drv_floatRestored _SAL1_1_Source_(__drv_floatRestored, (), _Kernel_float_restored_) /* legacy */ + + // + // The function uses floating point. Functions with floating point + // in their type signature get this automatically. + __ANNOTATION(SAL_floatUsed(void);) + #define _Kernel_float_used_ _SAL2_Source_(_Kernel_float_used_, (), _Post_ _SA_annotes0(SAL_floatUsed)) + #define __drv_floatUsed _SAL1_1_Source_(__drv_floatUsed, (), _Kernel_float_used_) /* legacy */ + + // --------------------------------------------------------------------- + // Usage: + // + // __drv_interlocked + // __drv_inTry + // __drv_notInTry + // + // The parameter is used for interlocked instructions. + #define __drv_interlocked _SAL1_1_Source_(__drv_interlocked, (), _Interlocked_operand_) + + // The function must be called inside a try block + #define __drv_inTry _SAL_L_Source_(__drv_inTry, (), _Pre_ _SA_annotes1(SAL_inTry,__yes)) + + // The function must not be called inside a try block + #define __drv_notInTry _SAL_L_Source_(__drv_notInTry, (), _Pre_ _SA_annotes1(SAL_inTry,__no)) + + // --------------------------------------------------------------------- + // FormatString: + // + // kind can be "printf", "scanf", "strftime" or "FormatMessage". + __ANNOTATION(SAL_IsFormatString(__In_impl_ char *);) + #define __drv_formatString(kind)\ + _SAL1_1_Source_(__drv_formatString, (kind), _SA_annotes1(SAL_IsFormatString, #kind)) + + // --------------------------------------------------------------------- + // Function classes for drivers: + // + + // Function class for driver dispatch functions: + #define _Dispatch_type_(x) _SAL2_Source_(Dispatch_type_, (x), _SA_annotes1(SAL_functionClassNew, #x)) + + // Legacy function class for driver dispatch functions: + #define __drv_dispatchType(x) \ + _SAL1_1_Source_(__drv_displatchType, (x), _SA_annotes1(SAL_functionClassNew, #x)) + + // Legacy function class for driver dispatch functions - special case: + #define __drv_dispatchType_other\ + _SAL1_1_Source_(__drv_dispatchType_other, (), __drv_dispatchType(IRP_MJ_OTHER)) + + // Legacy function class for driver completion functions: + __ANNOTATION(SAL_completionType(__In_impl_ __AuToQuOtE char *);) + #define __drv_completionType(kindlist)\ + _SAL1_1_Source_(__drv_completionType, (kindlist), _SA_annotes1(SAL_completionType, #kindlist)) + + // Legacy function class for driver callback functions (FDO or PDO): + __ANNOTATION(SAL_callbackType(__In_impl_ __AuToQuOtE char *);) + #define __drv_callbackType(kind)\ + _SAL1_1_Source_(__drv_callbackType, (kind), _SA_annotes1(SAL_callbackType, #kind)) + + // --------------------------------------------------------------------- + // Composite: + +#ifdef _PREFAST_ // [ expand to nothing immediately to avoid RC problem + // + // Exclusive Resources + // + #define __drv_acquiresExclusiveResource(kind) \ + _SAL1_1_Source_(__drv_acquiresExclusiveResource, (kind), _Acquires_nonreentrant_lock_(_Curr_)) + + #define __drv_releasesExclusiveResource(kind) \ + _SAL1_Source_(__drv_releasesExclusiveResource, (kind), _Releases_nonreentrant_lock_(_Curr_)) + + #define __drv_acquiresExclusiveResourceGlobal(kind, param) \ + _SAL1_Source_(__drv_acquiresExclusiveResourceGlobal, (kind), _Acquires_nonreentrant_lock_(param)) + + #define __drv_releasesExclusiveResourceGlobal(kind, param) \ + _SAL1_Source_(__drv_releasesExclusiveResourceGlobal, (kind), _Releases_nonreentrant_lock_(param)) + + // + // CancelSpinLock + // + #define __drv_acquiresCancelSpinLock \ + _SAL1_Source_(__drv_acquiresCancelSpinLock, (kind), _Acquires_nonreentrant_lock_(_Global_cancel_spin_lock_)) + + #define __drv_releasesCancelSpinLock \ + _SAL1_Source_(__drv_releasesCancelSpinLock, (kind), _Releases_nonreentrant_lock_(_Global_cancel_spin_lock_)) + + #define __drv_mustHoldCancelSpinLock \ + _SAL1_Source_(__drv_mustHoldCancelSpinLock, (kind), _Requires_lock_held_(_Global_cancel_spin_lock_)) + + #define __drv_neverHoldCancelSpinLock \ + _SAL1_Source_(__drv_neverHoldCancelSpinLock, (kind), _Requires_lock_not_held_(_Global_cancel_spin_lock_)) + + #define __drv_holdsCancelSpinLock() \ + _SAL1_Source_(__drv_holdsCanselSpinLock, (kind), _Holds_resource_global_("CancelSpinLock",)) + + // + // CriticalRegion + // + #define __drv_acquiresCriticalRegion \ + _SAL1_Source_(__drv_acquiresCriticalRegion, (kind), _Acquires_lock_(_Global_critical_region_)) + + #define __drv_releasesCriticalRegion \ + _SAL1_Source_(__drv_releasesCriticalRegion, (kind), _Releases_lock_(_Global_critical_region_)) + + #define __drv_mustHoldCriticalRegion \ + _SAL1_Source_(__drv_mustHoldCriticalRegion, (kind), _Requires_lock_held_(_Global_critical_region_)) + + #define __drv_neverHoldCriticalRegion \ + _SAL1_Source_(__drv_neverHoldCriticalRegion, (kind), _Requires_lock_not_held_(_Global_critical_region_)) + + #define __drv_holdsCriticalRegion() \ + _SAL1_Source_(__drv_holdsCriticalRegion, (kind), _Holds_resource_global_("CriticalRegion",)) + + +extern int _Global_priority_region_; + // + // PriorityRegion + // + #define __drv_acquiresPriorityRegion \ + _SAL1_Source_(__drv_acquiresPrioorityRegion, (kind), _Acquires_lock_(_Global_priority_region_)) + + #define __drv_releasesPriorityRegion \ + _SAL1_Source_(__drv_releasesPriorityRegion, (kind), _Releases_lock_(_Global_priority_region_)) + + #define __drv_mustHoldPriorityRegion \ + _SAL1_Source_(__drv_mustHoldPriorityRegion, (kind), _Requires_lock_held_(_Global_priority_region_)) + + #define __drv_neverHoldPriorityRegion \ + _SAL1_Source_(__drv_neverHoldPriorityRegion, (kind), _Requires_lock_not_held_(_Global_priority_region_)) + + #define __drv_holdsPriorityRegion() \ + _SAL1_Source_(__drv_holdsPriorityRegion, (kind), _Holds_resource_global_("PriorityRegion",)) + +#else // ][ + + #define __drv_acquiresExclusiveResource(kind) + #define __drv_releasesExclusiveResource(kind) + #define __drv_acquiresExclusiveResourceGlobal(kind, param) + #define __drv_releasesExclusiveResourceGlobal(kind, param) + #define __drv_acquiresCancelSpinLock + #define __drv_releasesCancelSpinLock + #define __drv_mustHoldCancelSpinLock + #define __drv_holdsCancelSpinLock() + #define __drv_neverHoldCancelSpinLock + #define __drv_acquiresCriticalRegion + #define __drv_releasesCriticalRegion + #define __drv_mustHoldCriticalRegion + #define __drv_neverHoldCriticalRegion + #define __drv_holdsCriticalRegion() + #define __drv_acquiresPriorityRegion + #define __drv_releasesPriorityRegion + #define __drv_mustHoldPriorityRegion + #define __drv_neverHoldPriorityRegion + #define __drv_holdsPriorityRegion() + +#endif // ] + + // Passing the cancel Irql to a utility function + #define _IRQL_is_cancel_ /* see kernelspecs.h */ + #define __drv_isCancelIRQL _IRQL_is_cancel_ /* legacy */ + + // Check if this is kernel or driver code + __PRIMOP(int, _Is_kernel_(void);) + __PRIMOP(int, _Is_driver_(void);) + +#ifdef __cplusplus +} +#endif + +#endif // DRIVERSPECS_H + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/drivinit.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/drivinit.h new file mode 100644 index 0000000000000000000000000000000000000000..f53ad09012eeac2d8d5e8b690b1ee164f79ff572 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/drivinit.h @@ -0,0 +1,11 @@ +//+--------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (C) Microsoft Corporation, 1992-1999. +// +// File: drivinit.h +// +//---------------------------------------------------------------------------- + +// All items moved to wingdi.h + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.h new file mode 100644 index 0000000000000000000000000000000000000000..dd47f142813290614f54c35fd0d34d8c1293a5fd --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.h @@ -0,0 +1,3137 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi_h__ +#define __dxgi_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGIObject_FWD_DEFINED__ +#define __IDXGIObject_FWD_DEFINED__ +typedef interface IDXGIObject IDXGIObject; + +#endif /* __IDXGIObject_FWD_DEFINED__ */ + + +#ifndef __IDXGIDeviceSubObject_FWD_DEFINED__ +#define __IDXGIDeviceSubObject_FWD_DEFINED__ +typedef interface IDXGIDeviceSubObject IDXGIDeviceSubObject; + +#endif /* __IDXGIDeviceSubObject_FWD_DEFINED__ */ + + +#ifndef __IDXGIResource_FWD_DEFINED__ +#define __IDXGIResource_FWD_DEFINED__ +typedef interface IDXGIResource IDXGIResource; + +#endif /* __IDXGIResource_FWD_DEFINED__ */ + + +#ifndef __IDXGIKeyedMutex_FWD_DEFINED__ +#define __IDXGIKeyedMutex_FWD_DEFINED__ +typedef interface IDXGIKeyedMutex IDXGIKeyedMutex; + +#endif /* __IDXGIKeyedMutex_FWD_DEFINED__ */ + + +#ifndef __IDXGISurface_FWD_DEFINED__ +#define __IDXGISurface_FWD_DEFINED__ +typedef interface IDXGISurface IDXGISurface; + +#endif /* __IDXGISurface_FWD_DEFINED__ */ + + +#ifndef __IDXGISurface1_FWD_DEFINED__ +#define __IDXGISurface1_FWD_DEFINED__ +typedef interface IDXGISurface1 IDXGISurface1; + +#endif /* __IDXGISurface1_FWD_DEFINED__ */ + + +#ifndef __IDXGIAdapter_FWD_DEFINED__ +#define __IDXGIAdapter_FWD_DEFINED__ +typedef interface IDXGIAdapter IDXGIAdapter; + +#endif /* __IDXGIAdapter_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput_FWD_DEFINED__ +#define __IDXGIOutput_FWD_DEFINED__ +typedef interface IDXGIOutput IDXGIOutput; + +#endif /* __IDXGIOutput_FWD_DEFINED__ */ + + +#ifndef __IDXGISwapChain_FWD_DEFINED__ +#define __IDXGISwapChain_FWD_DEFINED__ +typedef interface IDXGISwapChain IDXGISwapChain; + +#endif /* __IDXGISwapChain_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory_FWD_DEFINED__ +#define __IDXGIFactory_FWD_DEFINED__ +typedef interface IDXGIFactory IDXGIFactory; + +#endif /* __IDXGIFactory_FWD_DEFINED__ */ + + +#ifndef __IDXGIDevice_FWD_DEFINED__ +#define __IDXGIDevice_FWD_DEFINED__ +typedef interface IDXGIDevice IDXGIDevice; + +#endif /* __IDXGIDevice_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory1_FWD_DEFINED__ +#define __IDXGIFactory1_FWD_DEFINED__ +typedef interface IDXGIFactory1 IDXGIFactory1; + +#endif /* __IDXGIFactory1_FWD_DEFINED__ */ + + +#ifndef __IDXGIAdapter1_FWD_DEFINED__ +#define __IDXGIAdapter1_FWD_DEFINED__ +typedef interface IDXGIAdapter1 IDXGIAdapter1; + +#endif /* __IDXGIAdapter1_FWD_DEFINED__ */ + + +#ifndef __IDXGIDevice1_FWD_DEFINED__ +#define __IDXGIDevice1_FWD_DEFINED__ +typedef interface IDXGIDevice1 IDXGIDevice1; + +#endif /* __IDXGIDevice1_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "oaidl.h" +#include "ocidl.h" +#include "dxgicommon.h" +#include "dxgitype.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi_0000_0000 */ +/* [local] */ + +#include +#define DXGI_CPU_ACCESS_NONE ( 0 ) +#define DXGI_CPU_ACCESS_DYNAMIC ( 1 ) +#define DXGI_CPU_ACCESS_READ_WRITE ( 2 ) +#define DXGI_CPU_ACCESS_SCRATCH ( 3 ) +#define DXGI_CPU_ACCESS_FIELD 15 +#define DXGI_USAGE_SHADER_INPUT 0x00000010UL +#define DXGI_USAGE_RENDER_TARGET_OUTPUT 0x00000020UL +#define DXGI_USAGE_BACK_BUFFER 0x00000040UL +#define DXGI_USAGE_SHARED 0x00000080UL +#define DXGI_USAGE_READ_ONLY 0x00000100UL +#define DXGI_USAGE_DISCARD_ON_PRESENT 0x00000200UL +#define DXGI_USAGE_UNORDERED_ACCESS 0x00000400UL +typedef UINT DXGI_USAGE; + +typedef struct DXGI_FRAME_STATISTICS + { + UINT PresentCount; + UINT PresentRefreshCount; + UINT SyncRefreshCount; + LARGE_INTEGER SyncQPCTime; + LARGE_INTEGER SyncGPUTime; + } DXGI_FRAME_STATISTICS; + +typedef struct DXGI_MAPPED_RECT + { + INT Pitch; + BYTE *pBits; + } DXGI_MAPPED_RECT; + +#ifdef __midl +#ifndef LUID_DEFINED +#define LUID_DEFINED 1 +typedef struct _LUID + { + DWORD LowPart; + LONG HighPart; + } LUID; + +typedef struct _LUID *PLUID; + +#endif +#endif +typedef struct DXGI_ADAPTER_DESC + { + WCHAR Description[ 128 ]; + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + LUID AdapterLuid; + } DXGI_ADAPTER_DESC; + +#if !defined(HMONITOR_DECLARED) && !defined(HMONITOR) && (WINVER < 0x0500) +#define HMONITOR_DECLARED +#if 0 +typedef HANDLE HMONITOR; + +#endif +DECLARE_HANDLE(HMONITOR); +#endif +typedef struct DXGI_OUTPUT_DESC + { + WCHAR DeviceName[ 32 ]; + RECT DesktopCoordinates; + BOOL AttachedToDesktop; + DXGI_MODE_ROTATION Rotation; + HMONITOR Monitor; + } DXGI_OUTPUT_DESC; + +typedef struct DXGI_SHARED_RESOURCE + { + HANDLE Handle; + } DXGI_SHARED_RESOURCE; + +#define DXGI_RESOURCE_PRIORITY_MINIMUM ( 0x28000000 ) + +#define DXGI_RESOURCE_PRIORITY_LOW ( 0x50000000 ) + +#define DXGI_RESOURCE_PRIORITY_NORMAL ( 0x78000000 ) + +#define DXGI_RESOURCE_PRIORITY_HIGH ( 0xa0000000 ) + +#define DXGI_RESOURCE_PRIORITY_MAXIMUM ( 0xc8000000 ) + +typedef +enum DXGI_RESIDENCY + { + DXGI_RESIDENCY_FULLY_RESIDENT = 1, + DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY = 2, + DXGI_RESIDENCY_EVICTED_TO_DISK = 3 + } DXGI_RESIDENCY; + +typedef struct DXGI_SURFACE_DESC + { + UINT Width; + UINT Height; + DXGI_FORMAT Format; + DXGI_SAMPLE_DESC SampleDesc; + } DXGI_SURFACE_DESC; + +typedef +enum DXGI_SWAP_EFFECT + { + DXGI_SWAP_EFFECT_DISCARD = 0, + DXGI_SWAP_EFFECT_SEQUENTIAL = 1, + DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL = 3, + DXGI_SWAP_EFFECT_FLIP_DISCARD = 4 + } DXGI_SWAP_EFFECT; + +typedef +enum DXGI_SWAP_CHAIN_FLAG + { + DXGI_SWAP_CHAIN_FLAG_NONPREROTATED = 1, + DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH = 2, + DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE = 4, + DXGI_SWAP_CHAIN_FLAG_RESTRICTED_CONTENT = 8, + DXGI_SWAP_CHAIN_FLAG_RESTRICT_SHARED_RESOURCE_DRIVER = 16, + DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY = 32, + DXGI_SWAP_CHAIN_FLAG_FRAME_LATENCY_WAITABLE_OBJECT = 64, + DXGI_SWAP_CHAIN_FLAG_FOREGROUND_LAYER = 128, + DXGI_SWAP_CHAIN_FLAG_FULLSCREEN_VIDEO = 256, + DXGI_SWAP_CHAIN_FLAG_YUV_VIDEO = 512, + DXGI_SWAP_CHAIN_FLAG_HW_PROTECTED = 1024, + DXGI_SWAP_CHAIN_FLAG_ALLOW_TEARING = 2048, + DXGI_SWAP_CHAIN_FLAG_RESTRICTED_TO_ALL_HOLOGRAPHIC_DISPLAYS = 4096 + } DXGI_SWAP_CHAIN_FLAG; + +typedef struct DXGI_SWAP_CHAIN_DESC + { + DXGI_MODE_DESC BufferDesc; + DXGI_SAMPLE_DESC SampleDesc; + DXGI_USAGE BufferUsage; + UINT BufferCount; + HWND OutputWindow; + BOOL Windowed; + DXGI_SWAP_EFFECT SwapEffect; + UINT Flags; + } DXGI_SWAP_CHAIN_DESC; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGIObject_INTERFACE_DEFINED__ +#define __IDXGIObject_INTERFACE_DEFINED__ + +/* interface IDXGIObject */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIObject; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("aec22fb8-76f3-4639-9be0-28eb43a67a2e") + IDXGIObject : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE SetPrivateData( + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetPrivateDataInterface( + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetPrivateData( + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetParent( + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIObjectVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIObject * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIObject * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIObject * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIObject * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + END_INTERFACE + } IDXGIObjectVtbl; + + interface IDXGIObject + { + CONST_VTBL struct IDXGIObjectVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIObject_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIObject_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIObject_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIObject_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIObject_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIObject_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIObject_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIObject_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIDeviceSubObject_INTERFACE_DEFINED__ +#define __IDXGIDeviceSubObject_INTERFACE_DEFINED__ + +/* interface IDXGIDeviceSubObject */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDeviceSubObject; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("3d3e0379-f9de-4d58-bb6c-18d62992f1a6") + IDXGIDeviceSubObject : public IDXGIObject + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDevice( + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDeviceSubObjectVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDeviceSubObject * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDeviceSubObject * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDeviceSubObject * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDeviceSubObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDeviceSubObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDeviceSubObject * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDeviceSubObject * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGIDeviceSubObject * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + END_INTERFACE + } IDXGIDeviceSubObjectVtbl; + + interface IDXGIDeviceSubObject + { + CONST_VTBL struct IDXGIDeviceSubObjectVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDeviceSubObject_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDeviceSubObject_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDeviceSubObject_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDeviceSubObject_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDeviceSubObject_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDeviceSubObject_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDeviceSubObject_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDeviceSubObject_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDeviceSubObject_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIResource_INTERFACE_DEFINED__ +#define __IDXGIResource_INTERFACE_DEFINED__ + +/* interface IDXGIResource */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIResource; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("035f3ab4-482e-4e50-b41f-8a7f8bd8960b") + IDXGIResource : public IDXGIDeviceSubObject + { + public: + virtual HRESULT STDMETHODCALLTYPE GetSharedHandle( + /* [annotation][out] */ + _Out_ HANDLE *pSharedHandle) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetUsage( + /* [out] */ DXGI_USAGE *pUsage) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetEvictionPriority( + /* [in] */ UINT EvictionPriority) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetEvictionPriority( + /* [annotation][retval][out] */ + _Out_ UINT *pEvictionPriority) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIResourceVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIResource * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIResource * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIResource * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIResource * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIResource * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIResource * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIResource * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGIResource * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGIResource, GetSharedHandle) + HRESULT ( STDMETHODCALLTYPE *GetSharedHandle )( + IDXGIResource * This, + /* [annotation][out] */ + _Out_ HANDLE *pSharedHandle); + + DECLSPEC_XFGVIRT(IDXGIResource, GetUsage) + HRESULT ( STDMETHODCALLTYPE *GetUsage )( + IDXGIResource * This, + /* [out] */ DXGI_USAGE *pUsage); + + DECLSPEC_XFGVIRT(IDXGIResource, SetEvictionPriority) + HRESULT ( STDMETHODCALLTYPE *SetEvictionPriority )( + IDXGIResource * This, + /* [in] */ UINT EvictionPriority); + + DECLSPEC_XFGVIRT(IDXGIResource, GetEvictionPriority) + HRESULT ( STDMETHODCALLTYPE *GetEvictionPriority )( + IDXGIResource * This, + /* [annotation][retval][out] */ + _Out_ UINT *pEvictionPriority); + + END_INTERFACE + } IDXGIResourceVtbl; + + interface IDXGIResource + { + CONST_VTBL struct IDXGIResourceVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIResource_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIResource_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIResource_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIResource_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIResource_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIResource_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIResource_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIResource_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGIResource_GetSharedHandle(This,pSharedHandle) \ + ( (This)->lpVtbl -> GetSharedHandle(This,pSharedHandle) ) + +#define IDXGIResource_GetUsage(This,pUsage) \ + ( (This)->lpVtbl -> GetUsage(This,pUsage) ) + +#define IDXGIResource_SetEvictionPriority(This,EvictionPriority) \ + ( (This)->lpVtbl -> SetEvictionPriority(This,EvictionPriority) ) + +#define IDXGIResource_GetEvictionPriority(This,pEvictionPriority) \ + ( (This)->lpVtbl -> GetEvictionPriority(This,pEvictionPriority) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIResource_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIKeyedMutex_INTERFACE_DEFINED__ +#define __IDXGIKeyedMutex_INTERFACE_DEFINED__ + +/* interface IDXGIKeyedMutex */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIKeyedMutex; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("9d8e1289-d7b3-465f-8126-250e349af85d") + IDXGIKeyedMutex : public IDXGIDeviceSubObject + { + public: + virtual HRESULT STDMETHODCALLTYPE AcquireSync( + /* [in] */ UINT64 Key, + /* [in] */ DWORD dwMilliseconds) = 0; + + virtual HRESULT STDMETHODCALLTYPE ReleaseSync( + /* [in] */ UINT64 Key) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIKeyedMutexVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIKeyedMutex * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIKeyedMutex * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIKeyedMutex * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIKeyedMutex * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIKeyedMutex * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIKeyedMutex * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIKeyedMutex * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGIKeyedMutex * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGIKeyedMutex, AcquireSync) + HRESULT ( STDMETHODCALLTYPE *AcquireSync )( + IDXGIKeyedMutex * This, + /* [in] */ UINT64 Key, + /* [in] */ DWORD dwMilliseconds); + + DECLSPEC_XFGVIRT(IDXGIKeyedMutex, ReleaseSync) + HRESULT ( STDMETHODCALLTYPE *ReleaseSync )( + IDXGIKeyedMutex * This, + /* [in] */ UINT64 Key); + + END_INTERFACE + } IDXGIKeyedMutexVtbl; + + interface IDXGIKeyedMutex + { + CONST_VTBL struct IDXGIKeyedMutexVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIKeyedMutex_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIKeyedMutex_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIKeyedMutex_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIKeyedMutex_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIKeyedMutex_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIKeyedMutex_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIKeyedMutex_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIKeyedMutex_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGIKeyedMutex_AcquireSync(This,Key,dwMilliseconds) \ + ( (This)->lpVtbl -> AcquireSync(This,Key,dwMilliseconds) ) + +#define IDXGIKeyedMutex_ReleaseSync(This,Key) \ + ( (This)->lpVtbl -> ReleaseSync(This,Key) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIKeyedMutex_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0004 */ +/* [local] */ + +#define DXGI_MAP_READ ( 1UL ) + +#define DXGI_MAP_WRITE ( 2UL ) + +#define DXGI_MAP_DISCARD ( 4UL ) + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0004_v0_0_s_ifspec; + +#ifndef __IDXGISurface_INTERFACE_DEFINED__ +#define __IDXGISurface_INTERFACE_DEFINED__ + +/* interface IDXGISurface */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISurface; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("cafcb56c-6ac3-4889-bf47-9e23bbd260ec") + IDXGISurface : public IDXGIDeviceSubObject + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc( + /* [annotation][out] */ + _Out_ DXGI_SURFACE_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE Map( + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect, + /* [in] */ UINT MapFlags) = 0; + + virtual HRESULT STDMETHODCALLTYPE Unmap( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISurfaceVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISurface * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISurface * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISurface * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISurface * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISurface * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISurface * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISurface * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISurface * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISurface, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISurface * This, + /* [annotation][out] */ + _Out_ DXGI_SURFACE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISurface, Map) + HRESULT ( STDMETHODCALLTYPE *Map )( + IDXGISurface * This, + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect, + /* [in] */ UINT MapFlags); + + DECLSPEC_XFGVIRT(IDXGISurface, Unmap) + HRESULT ( STDMETHODCALLTYPE *Unmap )( + IDXGISurface * This); + + END_INTERFACE + } IDXGISurfaceVtbl; + + interface IDXGISurface + { + CONST_VTBL struct IDXGISurfaceVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISurface_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISurface_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISurface_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISurface_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISurface_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISurface_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISurface_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISurface_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISurface_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISurface_Map(This,pLockedRect,MapFlags) \ + ( (This)->lpVtbl -> Map(This,pLockedRect,MapFlags) ) + +#define IDXGISurface_Unmap(This) \ + ( (This)->lpVtbl -> Unmap(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISurface_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGISurface1_INTERFACE_DEFINED__ +#define __IDXGISurface1_INTERFACE_DEFINED__ + +/* interface IDXGISurface1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISurface1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("4AE63092-6327-4c1b-80AE-BFE12EA32B86") + IDXGISurface1 : public IDXGISurface + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDC( + /* [in] */ BOOL Discard, + /* [annotation][out] */ + _Out_ HDC *phdc) = 0; + + virtual HRESULT STDMETHODCALLTYPE ReleaseDC( + /* [annotation][in] */ + _In_opt_ RECT *pDirtyRect) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISurface1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISurface1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISurface1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISurface1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISurface, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISurface1 * This, + /* [annotation][out] */ + _Out_ DXGI_SURFACE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISurface, Map) + HRESULT ( STDMETHODCALLTYPE *Map )( + IDXGISurface1 * This, + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect, + /* [in] */ UINT MapFlags); + + DECLSPEC_XFGVIRT(IDXGISurface, Unmap) + HRESULT ( STDMETHODCALLTYPE *Unmap )( + IDXGISurface1 * This); + + DECLSPEC_XFGVIRT(IDXGISurface1, GetDC) + HRESULT ( STDMETHODCALLTYPE *GetDC )( + IDXGISurface1 * This, + /* [in] */ BOOL Discard, + /* [annotation][out] */ + _Out_ HDC *phdc); + + DECLSPEC_XFGVIRT(IDXGISurface1, ReleaseDC) + HRESULT ( STDMETHODCALLTYPE *ReleaseDC )( + IDXGISurface1 * This, + /* [annotation][in] */ + _In_opt_ RECT *pDirtyRect); + + END_INTERFACE + } IDXGISurface1Vtbl; + + interface IDXGISurface1 + { + CONST_VTBL struct IDXGISurface1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISurface1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISurface1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISurface1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISurface1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISurface1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISurface1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISurface1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISurface1_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISurface1_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISurface1_Map(This,pLockedRect,MapFlags) \ + ( (This)->lpVtbl -> Map(This,pLockedRect,MapFlags) ) + +#define IDXGISurface1_Unmap(This) \ + ( (This)->lpVtbl -> Unmap(This) ) + + +#define IDXGISurface1_GetDC(This,Discard,phdc) \ + ( (This)->lpVtbl -> GetDC(This,Discard,phdc) ) + +#define IDXGISurface1_ReleaseDC(This,pDirtyRect) \ + ( (This)->lpVtbl -> ReleaseDC(This,pDirtyRect) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISurface1_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0006 */ +/* [local] */ + + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0006_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0006_v0_0_s_ifspec; + +#ifndef __IDXGIAdapter_INTERFACE_DEFINED__ +#define __IDXGIAdapter_INTERFACE_DEFINED__ + +/* interface IDXGIAdapter */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIAdapter; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("2411e7e1-12ac-4ccf-bd14-9798e8534dc0") + IDXGIAdapter : public IDXGIObject + { + public: + virtual HRESULT STDMETHODCALLTYPE EnumOutputs( + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDesc( + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE CheckInterfaceSupport( + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIAdapterVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIAdapter * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIAdapter * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIAdapter * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIAdapter * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIAdapter * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIAdapter * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIAdapter * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIAdapter, EnumOutputs) + HRESULT ( STDMETHODCALLTYPE *EnumOutputs )( + IDXGIAdapter * This, + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGIAdapter, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIAdapter * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter, CheckInterfaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckInterfaceSupport )( + IDXGIAdapter * This, + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion); + + END_INTERFACE + } IDXGIAdapterVtbl; + + interface IDXGIAdapter + { + CONST_VTBL struct IDXGIAdapterVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIAdapter_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIAdapter_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIAdapter_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIAdapter_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIAdapter_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIAdapter_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIAdapter_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIAdapter_EnumOutputs(This,Output,ppOutput) \ + ( (This)->lpVtbl -> EnumOutputs(This,Output,ppOutput) ) + +#define IDXGIAdapter_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIAdapter_CheckInterfaceSupport(This,InterfaceName,pUMDVersion) \ + ( (This)->lpVtbl -> CheckInterfaceSupport(This,InterfaceName,pUMDVersion) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIAdapter_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0007 */ +/* [local] */ + +#define DXGI_ENUM_MODES_INTERLACED ( 1UL ) + +#define DXGI_ENUM_MODES_SCALING ( 2UL ) + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0007_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0007_v0_0_s_ifspec; + +#ifndef __IDXGIOutput_INTERFACE_DEFINED__ +#define __IDXGIOutput_INTERFACE_DEFINED__ + +/* interface IDXGIOutput */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("ae02eedb-c735-4690-8d52-5a8dc20213aa") + IDXGIOutput : public IDXGIObject + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc( + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDisplayModeList( + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE FindClosestMatchingMode( + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice) = 0; + + virtual HRESULT STDMETHODCALLTYPE WaitForVBlank( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE TakeOwnership( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive) = 0; + + virtual void STDMETHODCALLTYPE ReleaseOwnership( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetGammaControlCapabilities( + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetGammaControl( + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetGammaControl( + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetDisplaySurface( + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDisplaySurfaceData( + /* [annotation][in] */ + _In_ IDXGISurface *pDestination) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFrameStatistics( + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutputVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + END_INTERFACE + } IDXGIOutputVtbl; + + interface IDXGIOutput + { + CONST_VTBL struct IDXGIOutputVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0008 */ +/* [local] */ + +#define DXGI_MAX_SWAP_CHAIN_BUFFERS ( 16 ) +#define DXGI_PRESENT_TEST 0x00000001UL +#define DXGI_PRESENT_DO_NOT_SEQUENCE 0x00000002UL +#define DXGI_PRESENT_RESTART 0x00000004UL +#define DXGI_PRESENT_DO_NOT_WAIT 0x00000008UL +#define DXGI_PRESENT_STEREO_PREFER_RIGHT 0x00000010UL +#define DXGI_PRESENT_STEREO_TEMPORARY_MONO 0x00000020UL +#define DXGI_PRESENT_RESTRICT_TO_OUTPUT 0x00000040UL +#define DXGI_PRESENT_USE_DURATION 0x00000100UL +#define DXGI_PRESENT_ALLOW_TEARING 0x00000200UL + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0008_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0008_v0_0_s_ifspec; + +#ifndef __IDXGISwapChain_INTERFACE_DEFINED__ +#define __IDXGISwapChain_INTERFACE_DEFINED__ + +/* interface IDXGISwapChain */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChain; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("310d36a0-d2e7-4c0a-aa04-6a9d23b8886a") + IDXGISwapChain : public IDXGIDeviceSubObject + { + public: + virtual HRESULT STDMETHODCALLTYPE Present( + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetBuffer( + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetFullscreenState( + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFullscreenState( + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDesc( + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE ResizeBuffers( + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags) = 0; + + virtual HRESULT STDMETHODCALLTYPE ResizeTarget( + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetContainingOutput( + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFrameStatistics( + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetLastPresentCount( + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChainVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChain * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChain * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChain * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISwapChain, Present) + HRESULT ( STDMETHODCALLTYPE *Present )( + IDXGISwapChain * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetBuffer) + HRESULT ( STDMETHODCALLTYPE *GetBuffer )( + IDXGISwapChain * This, + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface); + + DECLSPEC_XFGVIRT(IDXGISwapChain, SetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *SetFullscreenState )( + IDXGISwapChain * This, + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenState )( + IDXGISwapChain * This, + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISwapChain * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeBuffers) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers )( + IDXGISwapChain * This, + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeTarget) + HRESULT ( STDMETHODCALLTYPE *ResizeTarget )( + IDXGISwapChain * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetContainingOutput) + HRESULT ( STDMETHODCALLTYPE *GetContainingOutput )( + IDXGISwapChain * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGISwapChain * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetLastPresentCount) + HRESULT ( STDMETHODCALLTYPE *GetLastPresentCount )( + IDXGISwapChain * This, + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount); + + END_INTERFACE + } IDXGISwapChainVtbl; + + interface IDXGISwapChain + { + CONST_VTBL struct IDXGISwapChainVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChain_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChain_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChain_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChain_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISwapChain_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISwapChain_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISwapChain_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISwapChain_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISwapChain_Present(This,SyncInterval,Flags) \ + ( (This)->lpVtbl -> Present(This,SyncInterval,Flags) ) + +#define IDXGISwapChain_GetBuffer(This,Buffer,riid,ppSurface) \ + ( (This)->lpVtbl -> GetBuffer(This,Buffer,riid,ppSurface) ) + +#define IDXGISwapChain_SetFullscreenState(This,Fullscreen,pTarget) \ + ( (This)->lpVtbl -> SetFullscreenState(This,Fullscreen,pTarget) ) + +#define IDXGISwapChain_GetFullscreenState(This,pFullscreen,ppTarget) \ + ( (This)->lpVtbl -> GetFullscreenState(This,pFullscreen,ppTarget) ) + +#define IDXGISwapChain_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISwapChain_ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) \ + ( (This)->lpVtbl -> ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) ) + +#define IDXGISwapChain_ResizeTarget(This,pNewTargetParameters) \ + ( (This)->lpVtbl -> ResizeTarget(This,pNewTargetParameters) ) + +#define IDXGISwapChain_GetContainingOutput(This,ppOutput) \ + ( (This)->lpVtbl -> GetContainingOutput(This,ppOutput) ) + +#define IDXGISwapChain_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#define IDXGISwapChain_GetLastPresentCount(This,pLastPresentCount) \ + ( (This)->lpVtbl -> GetLastPresentCount(This,pLastPresentCount) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChain_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0009 */ +/* [local] */ + +#define DXGI_MWA_NO_WINDOW_CHANGES ( 1 << 0 ) +#define DXGI_MWA_NO_ALT_ENTER ( 1 << 1 ) +#define DXGI_MWA_NO_PRINT_SCREEN ( 1 << 2 ) +#define DXGI_MWA_VALID ( 0x7 ) + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0009_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0009_v0_0_s_ifspec; + +#ifndef __IDXGIFactory_INTERFACE_DEFINED__ +#define __IDXGIFactory_INTERFACE_DEFINED__ + +/* interface IDXGIFactory */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("7b7166ec-21c7-44ae-b21a-c9ae321ae369") + IDXGIFactory : public IDXGIObject + { + public: + virtual HRESULT STDMETHODCALLTYPE EnumAdapters( + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter) = 0; + + virtual HRESULT STDMETHODCALLTYPE MakeWindowAssociation( + HWND WindowHandle, + UINT Flags) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetWindowAssociation( + /* [annotation][out] */ + _Out_ HWND *pWindowHandle) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSwapChain( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSoftwareAdapter( + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactoryVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + END_INTERFACE + } IDXGIFactoryVtbl; + + interface IDXGIFactory + { + CONST_VTBL struct IDXGIFactoryVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0010 */ +/* [local] */ + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) +HRESULT WINAPI CreateDXGIFactory(REFIID riid, _COM_Outptr_ void **ppFactory); +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +HRESULT WINAPI CreateDXGIFactory1(REFIID riid, _COM_Outptr_ void **ppFactory); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0010_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0010_v0_0_s_ifspec; + +#ifndef __IDXGIDevice_INTERFACE_DEFINED__ +#define __IDXGIDevice_INTERFACE_DEFINED__ + +/* interface IDXGIDevice */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDevice; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("54ec77fa-1377-44e6-8c32-88fd5f44c84c") + IDXGIDevice : public IDXGIObject + { + public: + virtual HRESULT STDMETHODCALLTYPE GetAdapter( + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSurface( + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface) = 0; + + virtual HRESULT STDMETHODCALLTYPE QueryResourceResidency( + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetGPUThreadPriority( + /* [in] */ INT Priority) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetGPUThreadPriority( + /* [annotation][retval][out] */ + _Out_ INT *pPriority) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDeviceVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDevice * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDevice * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDevice * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDevice * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDevice * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDevice * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDevice * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetAdapter) + HRESULT ( STDMETHODCALLTYPE *GetAdapter )( + IDXGIDevice * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter); + + DECLSPEC_XFGVIRT(IDXGIDevice, CreateSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSurface )( + IDXGIDevice * This, + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIDevice, QueryResourceResidency) + HRESULT ( STDMETHODCALLTYPE *QueryResourceResidency )( + IDXGIDevice * This, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources); + + DECLSPEC_XFGVIRT(IDXGIDevice, SetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *SetGPUThreadPriority )( + IDXGIDevice * This, + /* [in] */ INT Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *GetGPUThreadPriority )( + IDXGIDevice * This, + /* [annotation][retval][out] */ + _Out_ INT *pPriority); + + END_INTERFACE + } IDXGIDeviceVtbl; + + interface IDXGIDevice + { + CONST_VTBL struct IDXGIDeviceVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDevice_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDevice_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDevice_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDevice_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDevice_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDevice_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDevice_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDevice_GetAdapter(This,pAdapter) \ + ( (This)->lpVtbl -> GetAdapter(This,pAdapter) ) + +#define IDXGIDevice_CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) \ + ( (This)->lpVtbl -> CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) ) + +#define IDXGIDevice_QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) \ + ( (This)->lpVtbl -> QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) ) + +#define IDXGIDevice_SetGPUThreadPriority(This,Priority) \ + ( (This)->lpVtbl -> SetGPUThreadPriority(This,Priority) ) + +#define IDXGIDevice_GetGPUThreadPriority(This,pPriority) \ + ( (This)->lpVtbl -> GetGPUThreadPriority(This,pPriority) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDevice_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0011 */ +/* [local] */ + +typedef +enum DXGI_ADAPTER_FLAG + { + DXGI_ADAPTER_FLAG_NONE = 0, + DXGI_ADAPTER_FLAG_REMOTE = 1, + DXGI_ADAPTER_FLAG_SOFTWARE = 2, + DXGI_ADAPTER_FLAG_FORCE_DWORD = 0xffffffff + } DXGI_ADAPTER_FLAG; + +typedef struct DXGI_ADAPTER_DESC1 + { + WCHAR Description[ 128 ]; + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + LUID AdapterLuid; + UINT Flags; + } DXGI_ADAPTER_DESC1; + +typedef struct DXGI_DISPLAY_COLOR_SPACE + { + FLOAT PrimaryCoordinates[ 8 ][ 2 ]; + FLOAT WhitePoints[ 16 ][ 2 ]; + } DXGI_DISPLAY_COLOR_SPACE; + + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0011_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0011_v0_0_s_ifspec; + +#ifndef __IDXGIFactory1_INTERFACE_DEFINED__ +#define __IDXGIFactory1_INTERFACE_DEFINED__ + +/* interface IDXGIFactory1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("770aae78-f26f-4dba-a829-253c83d1b387") + IDXGIFactory1 : public IDXGIFactory + { + public: + virtual HRESULT STDMETHODCALLTYPE EnumAdapters1( + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter) = 0; + + virtual BOOL STDMETHODCALLTYPE IsCurrent( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory1 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory1 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory1 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory1 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory1 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory1 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory1 * This); + + END_INTERFACE + } IDXGIFactory1Vtbl; + + interface IDXGIFactory1 + { + CONST_VTBL struct IDXGIFactory1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory1_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory1_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory1_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory1_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory1_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory1_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory1_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory1_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIAdapter1_INTERFACE_DEFINED__ +#define __IDXGIAdapter1_INTERFACE_DEFINED__ + +/* interface IDXGIAdapter1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIAdapter1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("29038f61-3839-4626-91fd-086879011a05") + IDXGIAdapter1 : public IDXGIAdapter + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc1( + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC1 *pDesc) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIAdapter1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIAdapter1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIAdapter1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIAdapter1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIAdapter1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIAdapter1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIAdapter1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIAdapter1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIAdapter, EnumOutputs) + HRESULT ( STDMETHODCALLTYPE *EnumOutputs )( + IDXGIAdapter1 * This, + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGIAdapter, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIAdapter1 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter, CheckInterfaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckInterfaceSupport )( + IDXGIAdapter1 * This, + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion); + + DECLSPEC_XFGVIRT(IDXGIAdapter1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGIAdapter1 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC1 *pDesc); + + END_INTERFACE + } IDXGIAdapter1Vtbl; + + interface IDXGIAdapter1 + { + CONST_VTBL struct IDXGIAdapter1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIAdapter1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIAdapter1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIAdapter1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIAdapter1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIAdapter1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIAdapter1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIAdapter1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIAdapter1_EnumOutputs(This,Output,ppOutput) \ + ( (This)->lpVtbl -> EnumOutputs(This,Output,ppOutput) ) + +#define IDXGIAdapter1_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIAdapter1_CheckInterfaceSupport(This,InterfaceName,pUMDVersion) \ + ( (This)->lpVtbl -> CheckInterfaceSupport(This,InterfaceName,pUMDVersion) ) + + +#define IDXGIAdapter1_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIAdapter1_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIDevice1_INTERFACE_DEFINED__ +#define __IDXGIDevice1_INTERFACE_DEFINED__ + +/* interface IDXGIDevice1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDevice1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("77db970f-6276-48ba-ba28-070143b4392c") + IDXGIDevice1 : public IDXGIDevice + { + public: + virtual HRESULT STDMETHODCALLTYPE SetMaximumFrameLatency( + /* [in] */ UINT MaxLatency) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetMaximumFrameLatency( + /* [annotation][out] */ + _Out_ UINT *pMaxLatency) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDevice1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDevice1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDevice1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDevice1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDevice1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDevice1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDevice1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDevice1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetAdapter) + HRESULT ( STDMETHODCALLTYPE *GetAdapter )( + IDXGIDevice1 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter); + + DECLSPEC_XFGVIRT(IDXGIDevice, CreateSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSurface )( + IDXGIDevice1 * This, + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIDevice, QueryResourceResidency) + HRESULT ( STDMETHODCALLTYPE *QueryResourceResidency )( + IDXGIDevice1 * This, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources); + + DECLSPEC_XFGVIRT(IDXGIDevice, SetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *SetGPUThreadPriority )( + IDXGIDevice1 * This, + /* [in] */ INT Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *GetGPUThreadPriority )( + IDXGIDevice1 * This, + /* [annotation][retval][out] */ + _Out_ INT *pPriority); + + DECLSPEC_XFGVIRT(IDXGIDevice1, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGIDevice1 * This, + /* [in] */ UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice1, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGIDevice1 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + END_INTERFACE + } IDXGIDevice1Vtbl; + + interface IDXGIDevice1 + { + CONST_VTBL struct IDXGIDevice1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDevice1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDevice1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDevice1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDevice1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDevice1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDevice1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDevice1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDevice1_GetAdapter(This,pAdapter) \ + ( (This)->lpVtbl -> GetAdapter(This,pAdapter) ) + +#define IDXGIDevice1_CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) \ + ( (This)->lpVtbl -> CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) ) + +#define IDXGIDevice1_QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) \ + ( (This)->lpVtbl -> QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) ) + +#define IDXGIDevice1_SetGPUThreadPriority(This,Priority) \ + ( (This)->lpVtbl -> SetGPUThreadPriority(This,Priority) ) + +#define IDXGIDevice1_GetGPUThreadPriority(This,pPriority) \ + ( (This)->lpVtbl -> GetGPUThreadPriority(This,pPriority) ) + + +#define IDXGIDevice1_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGIDevice1_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDevice1_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi_0000_0014 */ +/* [local] */ + +#ifdef __cplusplus +#endif /*__cplusplus*/ +DEFINE_GUID(IID_IDXGIObject,0xaec22fb8,0x76f3,0x4639,0x9b,0xe0,0x28,0xeb,0x43,0xa6,0x7a,0x2e); +DEFINE_GUID(IID_IDXGIDeviceSubObject,0x3d3e0379,0xf9de,0x4d58,0xbb,0x6c,0x18,0xd6,0x29,0x92,0xf1,0xa6); +DEFINE_GUID(IID_IDXGIResource,0x035f3ab4,0x482e,0x4e50,0xb4,0x1f,0x8a,0x7f,0x8b,0xd8,0x96,0x0b); +DEFINE_GUID(IID_IDXGIKeyedMutex,0x9d8e1289,0xd7b3,0x465f,0x81,0x26,0x25,0x0e,0x34,0x9a,0xf8,0x5d); +DEFINE_GUID(IID_IDXGISurface,0xcafcb56c,0x6ac3,0x4889,0xbf,0x47,0x9e,0x23,0xbb,0xd2,0x60,0xec); +DEFINE_GUID(IID_IDXGISurface1,0x4AE63092,0x6327,0x4c1b,0x80,0xAE,0xBF,0xE1,0x2E,0xA3,0x2B,0x86); +DEFINE_GUID(IID_IDXGIAdapter,0x2411e7e1,0x12ac,0x4ccf,0xbd,0x14,0x97,0x98,0xe8,0x53,0x4d,0xc0); +DEFINE_GUID(IID_IDXGIOutput,0xae02eedb,0xc735,0x4690,0x8d,0x52,0x5a,0x8d,0xc2,0x02,0x13,0xaa); +DEFINE_GUID(IID_IDXGISwapChain,0x310d36a0,0xd2e7,0x4c0a,0xaa,0x04,0x6a,0x9d,0x23,0xb8,0x88,0x6a); +DEFINE_GUID(IID_IDXGIFactory,0x7b7166ec,0x21c7,0x44ae,0xb2,0x1a,0xc9,0xae,0x32,0x1a,0xe3,0x69); +DEFINE_GUID(IID_IDXGIDevice,0x54ec77fa,0x1377,0x44e6,0x8c,0x32,0x88,0xfd,0x5f,0x44,0xc8,0x4c); +DEFINE_GUID(IID_IDXGIFactory1,0x770aae78,0xf26f,0x4dba,0xa8,0x29,0x25,0x3c,0x83,0xd1,0xb3,0x87); +DEFINE_GUID(IID_IDXGIAdapter1,0x29038f61,0x3839,0x4626,0x91,0xfd,0x08,0x68,0x79,0x01,0x1a,0x05); +DEFINE_GUID(IID_IDXGIDevice1,0x77db970f,0x6276,0x48ba,0xba,0x28,0x07,0x01,0x43,0xb4,0x39,0x2c); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0014_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi_0000_0014_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.idl new file mode 100644 index 0000000000000000000000000000000000000000..1899f8f2436f1dd736dff3cc599fa556870c2f23 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi.idl @@ -0,0 +1,618 @@ +import "oaidl.idl"; +import "ocidl.idl"; + +import "dxgicommon.idl"; +import "dxgitype.idl"; + +cpp_quote("#include ") + +//-------------------------------------------------------------------------------------------------------- +// DXGI API-only types +//-------------------------------------------------------------------------------------------------------- + +//-------------------------------------------------------------------------------------------------------- +// DXGI usages are a UINT with the following fields: +// 33222222222211111111110000000000 +// 10987654321098765432109876543210 +// [PC][PRIVATE][ DXGI ][DA] +// +// DA is a 4-bit field that encodes CPU data access patterns. +// 0 No CPU access. Maps should be validated to fail on this access. +// 1 Dynamic: Frequent CPU write-only access, high-performance GPU read-only access. +// 2 CPU-friendly: Frequent CPU read/write access, non-optimal GPU read-only access. +// 3 CPU-scratch: Frequent CPU read/write access, no GPU access. +cpp_quote( "#define DXGI_CPU_ACCESS_NONE ( 0 )" ) +cpp_quote( "#define DXGI_CPU_ACCESS_DYNAMIC ( 1 )" ) +cpp_quote( "#define DXGI_CPU_ACCESS_READ_WRITE ( 2 )" ) +cpp_quote( "#define DXGI_CPU_ACCESS_SCRATCH ( 3 )" ) +cpp_quote( "#define DXGI_CPU_ACCESS_FIELD 15" ) + +// +// DXGI is a 15-bit field containing DXGI-defined usages. In DXGI's first revision, these usages refer only to 2D +// non-mipped resources: the only resource type that DXGI intends to share cross-process, cross-API. Further +// 2D non-mipped uses can be added here (for example, DXVA extensions) +// +// Bitfield meanings: (Shift these into bits 18:4) +cpp_quote( "#define DXGI_USAGE_SHADER_INPUT 0x00000010UL" ) +cpp_quote( "#define DXGI_USAGE_RENDER_TARGET_OUTPUT 0x00000020UL" ) +cpp_quote( "#define DXGI_USAGE_BACK_BUFFER 0x00000040UL" ) +cpp_quote( "#define DXGI_USAGE_SHARED 0x00000080UL" ) +cpp_quote( "#define DXGI_USAGE_READ_ONLY 0x00000100UL" ) +cpp_quote( "#define DXGI_USAGE_DISCARD_ON_PRESENT 0x00000200UL" ) +cpp_quote( "#define DXGI_USAGE_UNORDERED_ACCESS 0x00000400UL" ) + +// See dxgiinternal.idl for private DXGI USAGE BITS, e.g. +// #define DXGI_USAGE_REMOTE_SWAPCHAIN_BUFFER ( 1L << (15 + 4) ) +// #define DXGI_USAGE_GDI_COMPATIBLE ( 1L << (16 + 4) ) + + +// +// +// PRIVATE is a 9-bit field that has usages private to a particular producer implementation that are irrelevant to 2D bitmaps (for example, d3d index buffers) +// +// PC is a producer-code that defines the namespace within which PRIVATE bits exist. The +// following PC codes are defined: +// 0 DXGI (implying that DXGI usages can be extended to 24 bits (DXGI field plus the 9-bit private field) +// 1 D3D (covering d3d10 and later revisions)typedef DXGI_USAGE UINT; +typedef UINT DXGI_USAGE; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_FRAME_STATISTICS +{ + UINT PresentCount; + UINT PresentRefreshCount; + UINT SyncRefreshCount; + LARGE_INTEGER SyncQPCTime; + LARGE_INTEGER SyncGPUTime; +} DXGI_FRAME_STATISTICS; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_MAPPED_RECT +{ + INT Pitch; + BYTE* pBits; +} DXGI_MAPPED_RECT; + +//-------------------------------------------------------------------------------------------------------- +// The system LUID struct isn't defined in wtypes, so we repeat it here just +// for the MIDL compiler. +cpp_quote("#ifdef __midl") +cpp_quote("#ifndef LUID_DEFINED") +cpp_quote("#define LUID_DEFINED 1") +typedef struct _LUID { + DWORD LowPart; + LONG HighPart; +} LUID, *PLUID; +cpp_quote("#endif") +cpp_quote("#endif") + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_ADAPTER_DESC +{ + WCHAR Description[128]; + + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + + LUID AdapterLuid; +} DXGI_ADAPTER_DESC; + +//-------------------------------------------------------------------------------------------------------- +// HMONITOR: This appears to be best (!) practice for preprocessor-declared windows macros that +// need to be expressed as actual types in midl... +cpp_quote("#if !defined(HMONITOR_DECLARED) && !defined(HMONITOR) && (WINVER < 0x0500)") +cpp_quote("#define HMONITOR_DECLARED") +cpp_quote("#if 0") +typedef HANDLE HMONITOR; +cpp_quote("#endif") +cpp_quote("DECLARE_HANDLE(HMONITOR);") +cpp_quote("#endif") + +typedef struct DXGI_OUTPUT_DESC +{ + WCHAR DeviceName[32]; // Device name for GDI (ex. \\.\DISPLAY1) + RECT DesktopCoordinates; + BOOL AttachedToDesktop; + DXGI_MODE_ROTATION Rotation; + HMONITOR Monitor; +} DXGI_OUTPUT_DESC; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_SHARED_RESOURCE +{ + HANDLE Handle; +} DXGI_SHARED_RESOURCE; + +//-------------------------------------------------------------------------------------------------------- +const UINT DXGI_RESOURCE_PRIORITY_MINIMUM = 0x28000000; +const UINT DXGI_RESOURCE_PRIORITY_LOW = 0x50000000; +const UINT DXGI_RESOURCE_PRIORITY_NORMAL = 0x78000000; +const UINT DXGI_RESOURCE_PRIORITY_HIGH = 0xa0000000; +const UINT DXGI_RESOURCE_PRIORITY_MAXIMUM = 0xc8000000; + +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_RESIDENCY +{ + DXGI_RESIDENCY_FULLY_RESIDENT = 1, + DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY = 2, + DXGI_RESIDENCY_EVICTED_TO_DISK = 3, +} DXGI_RESIDENCY; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_SURFACE_DESC +{ + UINT Width; + UINT Height; + DXGI_FORMAT Format; + DXGI_SAMPLE_DESC SampleDesc; +} DXGI_SURFACE_DESC; + +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_SWAP_EFFECT +{ + DXGI_SWAP_EFFECT_DISCARD = 0, + DXGI_SWAP_EFFECT_SEQUENTIAL = 1, + DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL = 3, + DXGI_SWAP_EFFECT_FLIP_DISCARD = 4, +} DXGI_SWAP_EFFECT; + +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_SWAP_CHAIN_FLAG +{ + DXGI_SWAP_CHAIN_FLAG_NONPREROTATED = 1, + DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH = 2, + DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE = 4, + DXGI_SWAP_CHAIN_FLAG_RESTRICTED_CONTENT = 8, + DXGI_SWAP_CHAIN_FLAG_RESTRICT_SHARED_RESOURCE_DRIVER = 16, + DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY = 32, + DXGI_SWAP_CHAIN_FLAG_FRAME_LATENCY_WAITABLE_OBJECT = 64, + DXGI_SWAP_CHAIN_FLAG_FOREGROUND_LAYER = 128, + DXGI_SWAP_CHAIN_FLAG_FULLSCREEN_VIDEO = 256, + DXGI_SWAP_CHAIN_FLAG_YUV_VIDEO = 512, + DXGI_SWAP_CHAIN_FLAG_HW_PROTECTED = 1024, + DXGI_SWAP_CHAIN_FLAG_ALLOW_TEARING = 2048, + DXGI_SWAP_CHAIN_FLAG_RESTRICTED_TO_ALL_HOLOGRAPHIC_DISPLAYS = 4096, +} DXGI_SWAP_CHAIN_FLAG; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_SWAP_CHAIN_DESC +{ + DXGI_MODE_DESC BufferDesc; + DXGI_SAMPLE_DESC SampleDesc; + DXGI_USAGE BufferUsage; + UINT BufferCount; + HWND OutputWindow; + BOOL Windowed; + DXGI_SWAP_EFFECT SwapEffect; + UINT Flags; // DXGI_SWAP_CHAIN_FLAG +} DXGI_SWAP_CHAIN_DESC; + + +//-------------------------------------------------------------------------------------------------------- +// DXGI object hierarchy base interfaces +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( aec22fb8-76f3-4639-9be0-28eb43a67a2e ), + local, + pointer_default(unique) +] +interface IDXGIObject : + IUnknown +{ + //ULONG Release(); + HRESULT SetPrivateData( + [in, annotation("_In_")] REFGUID Name, + [in] UINT DataSize, + [in, annotation("_In_reads_bytes_(DataSize)")] const void *pData ); + HRESULT SetPrivateDataInterface( + [in, annotation("_In_")] REFGUID Name, + [in, annotation("_In_opt_")] const IUnknown *pUnknown ); + HRESULT GetPrivateData( + [in, annotation("_In_")] REFGUID Name, + [in, out, annotation("_Inout_")] UINT *pDataSize, + [out, annotation("_Out_writes_bytes_(*pDataSize)")] void *pData ); + HRESULT GetParent( + [in, annotation("_In_")] REFIID riid, + [out, retval, annotation("_COM_Outptr_")] void **ppParent ); +}; + +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 3d3e0379-f9de-4d58-bb6c-18d62992f1a6 ), + local, + pointer_default(unique) +] +interface IDXGIDeviceSubObject : + IDXGIObject +{ + HRESULT GetDevice( + [in, annotation("_In_")] REFIID riid, + [out, retval, annotation("_COM_Outptr_")] void **ppDevice ); +}; + + +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 035f3ab4-482e-4e50-b41f-8a7f8bd8960b ), + local, + pointer_default(unique) +] +interface IDXGIResource : + IDXGIDeviceSubObject +{ + HRESULT GetSharedHandle( [out, annotation("_Out_")] HANDLE * pSharedHandle ); + HRESULT GetUsage( [out] DXGI_USAGE * pUsage ); + HRESULT SetEvictionPriority( [in] UINT EvictionPriority ); + HRESULT GetEvictionPriority( [out, retval, annotation("_Out_")] UINT* pEvictionPriority ); +}; + +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 9d8e1289-d7b3-465f-8126-250e349af85d ), + local, + pointer_default(unique) +] +interface IDXGIKeyedMutex : + IDXGIDeviceSubObject +{ + HRESULT AcquireSync( [in] UINT64 Key, [in] DWORD dwMilliseconds); + HRESULT ReleaseSync( [in] UINT64 Key); +}; + + +//-------------------------------------------------------------------------------------------------------- +// The DXGISurface +//-------------------------------------------------------------------------------------------------------- + +const UINT DXGI_MAP_READ = 1UL; +const UINT DXGI_MAP_WRITE = 2UL; +const UINT DXGI_MAP_DISCARD = 4UL; + +[ + object, + uuid( cafcb56c-6ac3-4889-bf47-9e23bbd260ec), + local, + pointer_default(unique) +] +interface IDXGISurface : + IDXGIDeviceSubObject +{ + HRESULT GetDesc([out, annotation("_Out_")] DXGI_SURFACE_DESC *pDesc); + HRESULT Map( + [out, annotation("_Out_")] DXGI_MAPPED_RECT *pLockedRect, + [in] UINT MapFlags ); + HRESULT Unmap(); +}; + + +//-------------------------------------------------------------------------------------------------------- +// The DXGISurface1 +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 4AE63092-6327-4c1b-80AE-BFE12EA32B86), + local, + pointer_default(unique) +] +interface IDXGISurface1 : + IDXGISurface +{ + HRESULT GetDC( + [in] BOOL Discard, + [out, annotation("_Out_")] HDC* phdc ); + HRESULT ReleaseDC([in, annotation("_In_opt_")] RECT* pDirtyRect); +}; + + +//-------------------------------------------------------------------------------------------------------- +// The DXGIAdapter +//-------------------------------------------------------------------------------------------------------- +//forward declarations: +interface IDXGIOutput; + +[ + object, + uuid( 2411e7e1-12ac-4ccf-bd14-9798e8534dc0 ), + local, + pointer_default(unique) +] +interface IDXGIAdapter : IDXGIObject +{ + HRESULT EnumOutputs( + [in] UINT Output, + [in, out, annotation("_COM_Outptr_")] IDXGIOutput **ppOutput ); + HRESULT GetDesc( [out, annotation("_Out_")] DXGI_ADAPTER_DESC *pDesc ); + HRESULT CheckInterfaceSupport( + [in, annotation("_In_")] REFGUID InterfaceName, + [out, annotation("_Out_")] LARGE_INTEGER * pUMDVersion ); +}; + +//-------------------------------------------------------------------------------------------------------- +const UINT DXGI_ENUM_MODES_INTERLACED = 1UL; +const UINT DXGI_ENUM_MODES_SCALING = 2UL; + +// Additional mode enumerations in DXGI 1.2 + +//-------------------------------------------------------------------------------------------------------- +// The DXGIOutput +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( ae02eedb-c735-4690-8d52-5a8dc20213aa ), + local, + pointer_default(unique) +] +interface IDXGIOutput : + IDXGIObject +{ + HRESULT GetDesc( [out,annotation("_Out_")] DXGI_OUTPUT_DESC *pDesc ); + HRESULT GetDisplayModeList( + [in] DXGI_FORMAT EnumFormat, + [in] UINT Flags, + [in, out, annotation("_Inout_")] UINT * pNumModes, + [out, annotation("_Out_writes_to_opt_(*pNumModes,*pNumModes)")] DXGI_MODE_DESC *pDesc); + HRESULT FindClosestMatchingMode( + [in, annotation("_In_")] const DXGI_MODE_DESC *pModeToMatch, + [out, annotation("_Out_")] DXGI_MODE_DESC *pClosestMatch, + [in, annotation("_In_opt_")] IUnknown * pConcernedDevice ); + HRESULT WaitForVBlank(); + HRESULT TakeOwnership( + [in, annotation("_In_")] IUnknown *pDevice, + BOOL Exclusive ); + void ReleaseOwnership(); + //The following methods can only be called when this output is owned by a device. + HRESULT GetGammaControlCapabilities( [out, annotation("_Out_")] DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps ); + HRESULT SetGammaControl( [in, annotation("_In_")] const DXGI_GAMMA_CONTROL *pArray ); + HRESULT GetGammaControl( [out, annotation("_Out_")] DXGI_GAMMA_CONTROL *pArray ); + HRESULT SetDisplaySurface( [in, annotation("_In_")] IDXGISurface *pScanoutSurface ); + HRESULT GetDisplaySurfaceData( [in, annotation("_In_")] IDXGISurface *pDestination ); + HRESULT GetFrameStatistics( [out, annotation("_Out_")] DXGI_FRAME_STATISTICS *pStats ); +}; + +//-------------------------------------------------------------------------------------------------------- +// The DXGI SwapChain +//-------------------------------------------------------------------------------------------------------- + +cpp_quote( "#define DXGI_MAX_SWAP_CHAIN_BUFFERS ( 16 )" ) +cpp_quote( "#define DXGI_PRESENT_TEST 0x00000001UL" ) +cpp_quote( "#define DXGI_PRESENT_DO_NOT_SEQUENCE 0x00000002UL" ) +cpp_quote( "#define DXGI_PRESENT_RESTART 0x00000004UL" ) +cpp_quote( "#define DXGI_PRESENT_DO_NOT_WAIT 0x00000008UL" ) +cpp_quote( "#define DXGI_PRESENT_STEREO_PREFER_RIGHT 0x00000010UL" ) +cpp_quote( "#define DXGI_PRESENT_STEREO_TEMPORARY_MONO 0x00000020UL" ) +cpp_quote( "#define DXGI_PRESENT_RESTRICT_TO_OUTPUT 0x00000040UL" ) +// See dxgidwm.idl for private DXGI Present Bits. +//cpp_quote( "#define DXGI_PRESENT_DDA_PROTECTED_CONTENT 0x00000080UL" ) reserved +cpp_quote( "#define DXGI_PRESENT_USE_DURATION 0x00000100UL" ) +cpp_quote( "#define DXGI_PRESENT_ALLOW_TEARING 0x00000200UL" ) + +[ + object, + uuid( 310d36a0-d2e7-4c0a-aa04-6a9d23b8886a ), + local, + pointer_default(unique) +] +interface IDXGISwapChain : + IDXGIDeviceSubObject +{ + HRESULT Present([in] UINT SyncInterval, [in] UINT Flags); + HRESULT GetBuffer( + [in] UINT Buffer, + [in, annotation("_In_")] REFIID riid, + [in, out, annotation("_COM_Outptr_")] void **ppSurface ); + HRESULT SetFullscreenState( + [in] BOOL Fullscreen, + [in, annotation("_In_opt_")] IDXGIOutput *pTarget ); + HRESULT GetFullscreenState( + [out, annotation("_Out_opt_")] BOOL *pFullscreen, + [out, annotation("_COM_Outptr_opt_result_maybenull_")] IDXGIOutput **ppTarget ); + HRESULT GetDesc( [out, annotation("_Out_")] DXGI_SWAP_CHAIN_DESC *pDesc ); + HRESULT ResizeBuffers( [in] UINT BufferCount, [in] UINT Width, [in] UINT Height, [in] DXGI_FORMAT NewFormat, [in] UINT SwapChainFlags ); + HRESULT ResizeTarget( [in, annotation("_In_")] const DXGI_MODE_DESC *pNewTargetParameters ); + HRESULT GetContainingOutput( [out, annotation("_COM_Outptr_")] IDXGIOutput **ppOutput ); + HRESULT GetFrameStatistics( [out, annotation("_Out_")] DXGI_FRAME_STATISTICS *pStats ); + HRESULT GetLastPresentCount( [out, annotation("_Out_")] UINT *pLastPresentCount ); +}; + +//-------------------------------------------------------------------------------------------------------- +// The DXGIFactory +//-------------------------------------------------------------------------------------------------------- + +cpp_quote( "#define DXGI_MWA_NO_WINDOW_CHANGES ( 1 << 0 )" ) +cpp_quote( "#define DXGI_MWA_NO_ALT_ENTER ( 1 << 1 )" ) +cpp_quote( "#define DXGI_MWA_NO_PRINT_SCREEN ( 1 << 2 )" ) +cpp_quote( "#define DXGI_MWA_VALID ( 0x7 )" ) + +[ + object, + uuid( 7b7166ec-21c7-44ae-b21a-c9ae321ae369 ), + local, + pointer_default(unique) +] +interface IDXGIFactory : + IDXGIObject +{ + HRESULT EnumAdapters( + [in] UINT Adapter, + [out, annotation("_COM_Outptr_")] IDXGIAdapter **ppAdapter ); + HRESULT MakeWindowAssociation(HWND WindowHandle, UINT Flags); //pass NULL to break the association + HRESULT GetWindowAssociation( [out, annotation("_Out_")] HWND *pWindowHandle ); + HRESULT CreateSwapChain( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_")] DXGI_SWAP_CHAIN_DESC *pDesc, + [out, annotation("_COM_Outptr_")] IDXGISwapChain **ppSwapChain ); + HRESULT CreateSoftwareAdapter( + [in] HMODULE Module, + [out, annotation("_COM_Outptr_")] IDXGIAdapter **ppAdapter ); +}; + +//-------------------------------------------------------------------------------------------------------- +// DXGI instantiation +//-------------------------------------------------------------------------------------------------------- + +#pragma region Desktop Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)") +cpp_quote( "HRESULT WINAPI CreateDXGIFactory(REFIID riid, _COM_Outptr_ void **ppFactory);" ) +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */") +#pragma endregion + +cpp_quote( "HRESULT WINAPI CreateDXGIFactory1(REFIID riid, _COM_Outptr_ void **ppFactory);" ) + +//----------------------------- --------------------------------------------------------------------------- +// The DXGIDevice base interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 54ec77fa-1377-44e6-8c32-88fd5f44c84c ), + local, + pointer_default(unique) +] +interface IDXGIDevice : + IDXGIObject +{ + HRESULT GetAdapter( [out, annotation("_COM_Outptr_")] IDXGIAdapter **pAdapter ); + HRESULT CreateSurface( + [in, annotation("_In_")] const DXGI_SURFACE_DESC *pDesc, + [in] UINT NumSurfaces, + [in] DXGI_USAGE Usage, + [in, annotation("_In_opt_")] const DXGI_SHARED_RESOURCE *pSharedResource, + [out, size_is(NumSurfaces), annotation("_Out_writes_(NumSurfaces)")] IDXGISurface **ppSurface ); + HRESULT QueryResourceResidency( + [in, size_is(NumResources), annotation("_In_reads_(NumResources)")] IUnknown *const *ppResources, + [out, size_is(NumResources), annotation("_Out_writes_(NumResources)")] DXGI_RESIDENCY *pResidencyStatus, + [in] UINT NumResources); + HRESULT SetGPUThreadPriority( [in] INT Priority ); + HRESULT GetGPUThreadPriority( [out, retval, annotation("_Out_")] INT *pPriority ); +}; + + +//-------------------------------------------------------------------------------------------------------- +// DXGI 1.1 +//-------------------------------------------------------------------------------------------------------- + + +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_ADAPTER_FLAG +{ + DXGI_ADAPTER_FLAG_NONE = 0, + DXGI_ADAPTER_FLAG_REMOTE = 1, + DXGI_ADAPTER_FLAG_SOFTWARE = 2, + DXGI_ADAPTER_FLAG_FORCE_DWORD = 0xFFFFFFFF, +} DXGI_ADAPTER_FLAG; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_ADAPTER_DESC1 +{ + WCHAR Description[128]; + + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + + LUID AdapterLuid; + + UINT Flags; // DXGI_ADAPTER_FLAG +} DXGI_ADAPTER_DESC1; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_DISPLAY_COLOR_SPACE +{ + FLOAT PrimaryCoordinates[8][2]; + FLOAT WhitePoints[16][2]; +} DXGI_DISPLAY_COLOR_SPACE; + + +//forward declarations: +interface IDXGIAdapter1; + + +//-------------------------------------------------------------------------------------------------------- +// The DXGIFactory1 +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 770aae78-f26f-4dba-a829-253c83d1b387 ), + local, + pointer_default(unique) +] +interface IDXGIFactory1 : + IDXGIFactory +{ + HRESULT EnumAdapters1( + [in] UINT Adapter, + [out, annotation("_COM_Outptr_")] IDXGIAdapter1 **ppAdapter ); + BOOL IsCurrent(); +}; + +//-------------------------------------------------------------------------------------------------------- +// The DXGIAdapter1 +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 29038f61-3839-4626-91fd-086879011a05 ), + local, + pointer_default(unique) +] +interface IDXGIAdapter1 : + IDXGIAdapter +{ + HRESULT GetDesc1( [out, annotation("_Out_")] DXGI_ADAPTER_DESC1 *pDesc ); +}; + +//-------------------------------------------------------------------------------------------------------- +// The DXGIDevice1 +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 77db970f-6276-48ba-ba28-070143b4392c ), + local, + pointer_default(unique) +] +interface IDXGIDevice1 : + IDXGIDevice +{ + HRESULT SetMaximumFrameLatency( [in] UINT MaxLatency ); + HRESULT GetMaximumFrameLatency( [out, annotation("_Out_")] UINT *pMaxLatency ); +}; + +cpp_quote( "#ifdef __cplusplus" ) + +cpp_quote( "#endif /*__cplusplus*/" ) + + +cpp_quote( "DEFINE_GUID(IID_IDXGIObject,0xaec22fb8,0x76f3,0x4639,0x9b,0xe0,0x28,0xeb,0x43,0xa6,0x7a,0x2e);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDeviceSubObject,0x3d3e0379,0xf9de,0x4d58,0xbb,0x6c,0x18,0xd6,0x29,0x92,0xf1,0xa6);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIResource,0x035f3ab4,0x482e,0x4e50,0xb4,0x1f,0x8a,0x7f,0x8b,0xd8,0x96,0x0b);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIKeyedMutex,0x9d8e1289,0xd7b3,0x465f,0x81,0x26,0x25,0x0e,0x34,0x9a,0xf8,0x5d);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISurface,0xcafcb56c,0x6ac3,0x4889,0xbf,0x47,0x9e,0x23,0xbb,0xd2,0x60,0xec);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISurface1,0x4AE63092,0x6327,0x4c1b,0x80,0xAE,0xBF,0xE1,0x2E,0xA3,0x2B,0x86);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIAdapter,0x2411e7e1,0x12ac,0x4ccf,0xbd,0x14,0x97,0x98,0xe8,0x53,0x4d,0xc0);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput,0xae02eedb,0xc735,0x4690,0x8d,0x52,0x5a,0x8d,0xc2,0x02,0x13,0xaa);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChain,0x310d36a0,0xd2e7,0x4c0a,0xaa,0x04,0x6a,0x9d,0x23,0xb8,0x88,0x6a);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory,0x7b7166ec,0x21c7,0x44ae,0xb2,0x1a,0xc9,0xae,0x32,0x1a,0xe3,0x69);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDevice,0x54ec77fa,0x1377,0x44e6,0x8c,0x32,0x88,0xfd,0x5f,0x44,0xc8,0x4c);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory1,0x770aae78,0xf26f,0x4dba,0xa8,0x29,0x25,0x3c,0x83,0xd1,0xb3,0x87);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIAdapter1,0x29038f61,0x3839,0x4626,0x91,0xfd,0x08,0x68,0x79,0x01,0x1a,0x05);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDevice1,0x77db970f,0x6276,0x48ba,0xba,0x28,0x07,0x01,0x43,0xb4,0x39,0x2c);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.h new file mode 100644 index 0000000000000000000000000000000000000000..3519c686d81fb762f4fa350f80d37f676ce1e391 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.h @@ -0,0 +1,2637 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi1_2_h__ +#define __dxgi1_2_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGIDisplayControl_FWD_DEFINED__ +#define __IDXGIDisplayControl_FWD_DEFINED__ +typedef interface IDXGIDisplayControl IDXGIDisplayControl; + +#endif /* __IDXGIDisplayControl_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutputDuplication_FWD_DEFINED__ +#define __IDXGIOutputDuplication_FWD_DEFINED__ +typedef interface IDXGIOutputDuplication IDXGIOutputDuplication; + +#endif /* __IDXGIOutputDuplication_FWD_DEFINED__ */ + + +#ifndef __IDXGISurface2_FWD_DEFINED__ +#define __IDXGISurface2_FWD_DEFINED__ +typedef interface IDXGISurface2 IDXGISurface2; + +#endif /* __IDXGISurface2_FWD_DEFINED__ */ + + +#ifndef __IDXGIResource1_FWD_DEFINED__ +#define __IDXGIResource1_FWD_DEFINED__ +typedef interface IDXGIResource1 IDXGIResource1; + +#endif /* __IDXGIResource1_FWD_DEFINED__ */ + + +#ifndef __IDXGIDevice2_FWD_DEFINED__ +#define __IDXGIDevice2_FWD_DEFINED__ +typedef interface IDXGIDevice2 IDXGIDevice2; + +#endif /* __IDXGIDevice2_FWD_DEFINED__ */ + + +#ifndef __IDXGISwapChain1_FWD_DEFINED__ +#define __IDXGISwapChain1_FWD_DEFINED__ +typedef interface IDXGISwapChain1 IDXGISwapChain1; + +#endif /* __IDXGISwapChain1_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory2_FWD_DEFINED__ +#define __IDXGIFactory2_FWD_DEFINED__ +typedef interface IDXGIFactory2 IDXGIFactory2; + +#endif /* __IDXGIFactory2_FWD_DEFINED__ */ + + +#ifndef __IDXGIAdapter2_FWD_DEFINED__ +#define __IDXGIAdapter2_FWD_DEFINED__ +typedef interface IDXGIAdapter2 IDXGIAdapter2; + +#endif /* __IDXGIAdapter2_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput1_FWD_DEFINED__ +#define __IDXGIOutput1_FWD_DEFINED__ +typedef interface IDXGIOutput1 IDXGIOutput1; + +#endif /* __IDXGIOutput1_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "dxgi.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi1_2_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGIDisplayControl_INTERFACE_DEFINED__ +#define __IDXGIDisplayControl_INTERFACE_DEFINED__ + +/* interface IDXGIDisplayControl */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDisplayControl; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("ea9dbf1a-c88e-4486-854a-98aa0138f30c") + IDXGIDisplayControl : public IUnknown + { + public: + virtual BOOL STDMETHODCALLTYPE IsStereoEnabled( void) = 0; + + virtual void STDMETHODCALLTYPE SetStereoEnabled( + BOOL enabled) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDisplayControlVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDisplayControl * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDisplayControl * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDisplayControl * This); + + DECLSPEC_XFGVIRT(IDXGIDisplayControl, IsStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsStereoEnabled )( + IDXGIDisplayControl * This); + + DECLSPEC_XFGVIRT(IDXGIDisplayControl, SetStereoEnabled) + void ( STDMETHODCALLTYPE *SetStereoEnabled )( + IDXGIDisplayControl * This, + BOOL enabled); + + END_INTERFACE + } IDXGIDisplayControlVtbl; + + interface IDXGIDisplayControl + { + CONST_VTBL struct IDXGIDisplayControlVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDisplayControl_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDisplayControl_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDisplayControl_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDisplayControl_IsStereoEnabled(This) \ + ( (This)->lpVtbl -> IsStereoEnabled(This) ) + +#define IDXGIDisplayControl_SetStereoEnabled(This,enabled) \ + ( (This)->lpVtbl -> SetStereoEnabled(This,enabled) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDisplayControl_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0001 */ +/* [local] */ + +typedef struct DXGI_OUTDUPL_MOVE_RECT + { + POINT SourcePoint; + RECT DestinationRect; + } DXGI_OUTDUPL_MOVE_RECT; + +typedef struct DXGI_OUTDUPL_DESC + { + DXGI_MODE_DESC ModeDesc; + DXGI_MODE_ROTATION Rotation; + BOOL DesktopImageInSystemMemory; + } DXGI_OUTDUPL_DESC; + +typedef struct DXGI_OUTDUPL_POINTER_POSITION + { + POINT Position; + BOOL Visible; + } DXGI_OUTDUPL_POINTER_POSITION; + +typedef +enum DXGI_OUTDUPL_POINTER_SHAPE_TYPE + { + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME = 0x1, + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR = 0x2, + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR = 0x4 + } DXGI_OUTDUPL_POINTER_SHAPE_TYPE; + +typedef struct DXGI_OUTDUPL_POINTER_SHAPE_INFO + { + UINT Type; + UINT Width; + UINT Height; + UINT Pitch; + POINT HotSpot; + } DXGI_OUTDUPL_POINTER_SHAPE_INFO; + +typedef struct DXGI_OUTDUPL_FRAME_INFO + { + LARGE_INTEGER LastPresentTime; + LARGE_INTEGER LastMouseUpdateTime; + UINT AccumulatedFrames; + BOOL RectsCoalesced; + BOOL ProtectedContentMaskedOut; + DXGI_OUTDUPL_POINTER_POSITION PointerPosition; + UINT TotalMetadataBufferSize; + UINT PointerShapeBufferSize; + } DXGI_OUTDUPL_FRAME_INFO; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0001_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0001_v0_0_s_ifspec; + +#ifndef __IDXGIOutputDuplication_INTERFACE_DEFINED__ +#define __IDXGIOutputDuplication_INTERFACE_DEFINED__ + +/* interface IDXGIOutputDuplication */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutputDuplication; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("191cfac3-a341-470d-b26e-a864f428319c") + IDXGIOutputDuplication : public IDXGIObject + { + public: + virtual void STDMETHODCALLTYPE GetDesc( + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE AcquireNextFrame( + /* [annotation][in] */ + _In_ UINT TimeoutInMilliseconds, + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_FRAME_INFO *pFrameInfo, + /* [annotation][out] */ + _COM_Outptr_ IDXGIResource **ppDesktopResource) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFrameDirtyRects( + /* [annotation][in] */ + _In_ UINT DirtyRectsBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(DirtyRectsBufferSize, *pDirtyRectsBufferSizeRequired) RECT *pDirtyRectsBuffer, + /* [annotation][out] */ + _Out_ UINT *pDirtyRectsBufferSizeRequired) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFrameMoveRects( + /* [annotation][in] */ + _In_ UINT MoveRectsBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(MoveRectsBufferSize, *pMoveRectsBufferSizeRequired) DXGI_OUTDUPL_MOVE_RECT *pMoveRectBuffer, + /* [annotation][out] */ + _Out_ UINT *pMoveRectsBufferSizeRequired) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFramePointerShape( + /* [annotation][in] */ + _In_ UINT PointerShapeBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(PointerShapeBufferSize, *pPointerShapeBufferSizeRequired) void *pPointerShapeBuffer, + /* [annotation][out] */ + _Out_ UINT *pPointerShapeBufferSizeRequired, + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_POINTER_SHAPE_INFO *pPointerShapeInfo) = 0; + + virtual HRESULT STDMETHODCALLTYPE MapDesktopSurface( + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect) = 0; + + virtual HRESULT STDMETHODCALLTYPE UnMapDesktopSurface( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE ReleaseFrame( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutputDuplicationVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutputDuplication * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutputDuplication * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutputDuplication * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, GetDesc) + void ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutputDuplication * This, + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, AcquireNextFrame) + HRESULT ( STDMETHODCALLTYPE *AcquireNextFrame )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ UINT TimeoutInMilliseconds, + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_FRAME_INFO *pFrameInfo, + /* [annotation][out] */ + _COM_Outptr_ IDXGIResource **ppDesktopResource); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, GetFrameDirtyRects) + HRESULT ( STDMETHODCALLTYPE *GetFrameDirtyRects )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ UINT DirtyRectsBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(DirtyRectsBufferSize, *pDirtyRectsBufferSizeRequired) RECT *pDirtyRectsBuffer, + /* [annotation][out] */ + _Out_ UINT *pDirtyRectsBufferSizeRequired); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, GetFrameMoveRects) + HRESULT ( STDMETHODCALLTYPE *GetFrameMoveRects )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ UINT MoveRectsBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(MoveRectsBufferSize, *pMoveRectsBufferSizeRequired) DXGI_OUTDUPL_MOVE_RECT *pMoveRectBuffer, + /* [annotation][out] */ + _Out_ UINT *pMoveRectsBufferSizeRequired); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, GetFramePointerShape) + HRESULT ( STDMETHODCALLTYPE *GetFramePointerShape )( + IDXGIOutputDuplication * This, + /* [annotation][in] */ + _In_ UINT PointerShapeBufferSize, + /* [annotation][out] */ + _Out_writes_bytes_to_(PointerShapeBufferSize, *pPointerShapeBufferSizeRequired) void *pPointerShapeBuffer, + /* [annotation][out] */ + _Out_ UINT *pPointerShapeBufferSizeRequired, + /* [annotation][out] */ + _Out_ DXGI_OUTDUPL_POINTER_SHAPE_INFO *pPointerShapeInfo); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, MapDesktopSurface) + HRESULT ( STDMETHODCALLTYPE *MapDesktopSurface )( + IDXGIOutputDuplication * This, + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, UnMapDesktopSurface) + HRESULT ( STDMETHODCALLTYPE *UnMapDesktopSurface )( + IDXGIOutputDuplication * This); + + DECLSPEC_XFGVIRT(IDXGIOutputDuplication, ReleaseFrame) + HRESULT ( STDMETHODCALLTYPE *ReleaseFrame )( + IDXGIOutputDuplication * This); + + END_INTERFACE + } IDXGIOutputDuplicationVtbl; + + interface IDXGIOutputDuplication + { + CONST_VTBL struct IDXGIOutputDuplicationVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutputDuplication_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutputDuplication_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutputDuplication_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutputDuplication_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutputDuplication_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutputDuplication_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutputDuplication_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutputDuplication_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutputDuplication_AcquireNextFrame(This,TimeoutInMilliseconds,pFrameInfo,ppDesktopResource) \ + ( (This)->lpVtbl -> AcquireNextFrame(This,TimeoutInMilliseconds,pFrameInfo,ppDesktopResource) ) + +#define IDXGIOutputDuplication_GetFrameDirtyRects(This,DirtyRectsBufferSize,pDirtyRectsBuffer,pDirtyRectsBufferSizeRequired) \ + ( (This)->lpVtbl -> GetFrameDirtyRects(This,DirtyRectsBufferSize,pDirtyRectsBuffer,pDirtyRectsBufferSizeRequired) ) + +#define IDXGIOutputDuplication_GetFrameMoveRects(This,MoveRectsBufferSize,pMoveRectBuffer,pMoveRectsBufferSizeRequired) \ + ( (This)->lpVtbl -> GetFrameMoveRects(This,MoveRectsBufferSize,pMoveRectBuffer,pMoveRectsBufferSizeRequired) ) + +#define IDXGIOutputDuplication_GetFramePointerShape(This,PointerShapeBufferSize,pPointerShapeBuffer,pPointerShapeBufferSizeRequired,pPointerShapeInfo) \ + ( (This)->lpVtbl -> GetFramePointerShape(This,PointerShapeBufferSize,pPointerShapeBuffer,pPointerShapeBufferSizeRequired,pPointerShapeInfo) ) + +#define IDXGIOutputDuplication_MapDesktopSurface(This,pLockedRect) \ + ( (This)->lpVtbl -> MapDesktopSurface(This,pLockedRect) ) + +#define IDXGIOutputDuplication_UnMapDesktopSurface(This) \ + ( (This)->lpVtbl -> UnMapDesktopSurface(This) ) + +#define IDXGIOutputDuplication_ReleaseFrame(This) \ + ( (This)->lpVtbl -> ReleaseFrame(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutputDuplication_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0002 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) +typedef +enum DXGI_ALPHA_MODE + { + DXGI_ALPHA_MODE_UNSPECIFIED = 0, + DXGI_ALPHA_MODE_PREMULTIPLIED = 1, + DXGI_ALPHA_MODE_STRAIGHT = 2, + DXGI_ALPHA_MODE_IGNORE = 3, + DXGI_ALPHA_MODE_FORCE_DWORD = 0xffffffff + } DXGI_ALPHA_MODE; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0002_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0002_v0_0_s_ifspec; + +#ifndef __IDXGISurface2_INTERFACE_DEFINED__ +#define __IDXGISurface2_INTERFACE_DEFINED__ + +/* interface IDXGISurface2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISurface2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("aba496dd-b617-4cb8-a866-bc44d7eb1fa2") + IDXGISurface2 : public IDXGISurface1 + { + public: + virtual HRESULT STDMETHODCALLTYPE GetResource( + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out] */ + _COM_Outptr_ void **ppParentResource, + /* [annotation][out] */ + _Out_ UINT *pSubresourceIndex) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISurface2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISurface2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISurface2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISurface2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISurface, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISurface2 * This, + /* [annotation][out] */ + _Out_ DXGI_SURFACE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISurface, Map) + HRESULT ( STDMETHODCALLTYPE *Map )( + IDXGISurface2 * This, + /* [annotation][out] */ + _Out_ DXGI_MAPPED_RECT *pLockedRect, + /* [in] */ UINT MapFlags); + + DECLSPEC_XFGVIRT(IDXGISurface, Unmap) + HRESULT ( STDMETHODCALLTYPE *Unmap )( + IDXGISurface2 * This); + + DECLSPEC_XFGVIRT(IDXGISurface1, GetDC) + HRESULT ( STDMETHODCALLTYPE *GetDC )( + IDXGISurface2 * This, + /* [in] */ BOOL Discard, + /* [annotation][out] */ + _Out_ HDC *phdc); + + DECLSPEC_XFGVIRT(IDXGISurface1, ReleaseDC) + HRESULT ( STDMETHODCALLTYPE *ReleaseDC )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_opt_ RECT *pDirtyRect); + + DECLSPEC_XFGVIRT(IDXGISurface2, GetResource) + HRESULT ( STDMETHODCALLTYPE *GetResource )( + IDXGISurface2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out] */ + _COM_Outptr_ void **ppParentResource, + /* [annotation][out] */ + _Out_ UINT *pSubresourceIndex); + + END_INTERFACE + } IDXGISurface2Vtbl; + + interface IDXGISurface2 + { + CONST_VTBL struct IDXGISurface2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISurface2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISurface2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISurface2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISurface2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISurface2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISurface2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISurface2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISurface2_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISurface2_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISurface2_Map(This,pLockedRect,MapFlags) \ + ( (This)->lpVtbl -> Map(This,pLockedRect,MapFlags) ) + +#define IDXGISurface2_Unmap(This) \ + ( (This)->lpVtbl -> Unmap(This) ) + + +#define IDXGISurface2_GetDC(This,Discard,phdc) \ + ( (This)->lpVtbl -> GetDC(This,Discard,phdc) ) + +#define IDXGISurface2_ReleaseDC(This,pDirtyRect) \ + ( (This)->lpVtbl -> ReleaseDC(This,pDirtyRect) ) + + +#define IDXGISurface2_GetResource(This,riid,ppParentResource,pSubresourceIndex) \ + ( (This)->lpVtbl -> GetResource(This,riid,ppParentResource,pSubresourceIndex) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISurface2_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIResource1_INTERFACE_DEFINED__ +#define __IDXGIResource1_INTERFACE_DEFINED__ + +/* interface IDXGIResource1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIResource1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("30961379-4609-4a41-998e-54fe567ee0c1") + IDXGIResource1 : public IDXGIResource + { + public: + virtual HRESULT STDMETHODCALLTYPE CreateSubresourceSurface( + UINT index, + /* [annotation][out] */ + _COM_Outptr_ IDXGISurface2 **ppSurface) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSharedHandle( + /* [annotation][in] */ + _In_opt_ const SECURITY_ATTRIBUTES *pAttributes, + /* [annotation][in] */ + _In_ DWORD dwAccess, + /* [annotation][in] */ + _In_opt_ LPCWSTR lpName, + /* [annotation][out] */ + _Out_ HANDLE *pHandle) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIResource1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIResource1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIResource1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIResource1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGIResource, GetSharedHandle) + HRESULT ( STDMETHODCALLTYPE *GetSharedHandle )( + IDXGIResource1 * This, + /* [annotation][out] */ + _Out_ HANDLE *pSharedHandle); + + DECLSPEC_XFGVIRT(IDXGIResource, GetUsage) + HRESULT ( STDMETHODCALLTYPE *GetUsage )( + IDXGIResource1 * This, + /* [out] */ DXGI_USAGE *pUsage); + + DECLSPEC_XFGVIRT(IDXGIResource, SetEvictionPriority) + HRESULT ( STDMETHODCALLTYPE *SetEvictionPriority )( + IDXGIResource1 * This, + /* [in] */ UINT EvictionPriority); + + DECLSPEC_XFGVIRT(IDXGIResource, GetEvictionPriority) + HRESULT ( STDMETHODCALLTYPE *GetEvictionPriority )( + IDXGIResource1 * This, + /* [annotation][retval][out] */ + _Out_ UINT *pEvictionPriority); + + DECLSPEC_XFGVIRT(IDXGIResource1, CreateSubresourceSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSubresourceSurface )( + IDXGIResource1 * This, + UINT index, + /* [annotation][out] */ + _COM_Outptr_ IDXGISurface2 **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIResource1, CreateSharedHandle) + HRESULT ( STDMETHODCALLTYPE *CreateSharedHandle )( + IDXGIResource1 * This, + /* [annotation][in] */ + _In_opt_ const SECURITY_ATTRIBUTES *pAttributes, + /* [annotation][in] */ + _In_ DWORD dwAccess, + /* [annotation][in] */ + _In_opt_ LPCWSTR lpName, + /* [annotation][out] */ + _Out_ HANDLE *pHandle); + + END_INTERFACE + } IDXGIResource1Vtbl; + + interface IDXGIResource1 + { + CONST_VTBL struct IDXGIResource1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIResource1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIResource1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIResource1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIResource1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIResource1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIResource1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIResource1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIResource1_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGIResource1_GetSharedHandle(This,pSharedHandle) \ + ( (This)->lpVtbl -> GetSharedHandle(This,pSharedHandle) ) + +#define IDXGIResource1_GetUsage(This,pUsage) \ + ( (This)->lpVtbl -> GetUsage(This,pUsage) ) + +#define IDXGIResource1_SetEvictionPriority(This,EvictionPriority) \ + ( (This)->lpVtbl -> SetEvictionPriority(This,EvictionPriority) ) + +#define IDXGIResource1_GetEvictionPriority(This,pEvictionPriority) \ + ( (This)->lpVtbl -> GetEvictionPriority(This,pEvictionPriority) ) + + +#define IDXGIResource1_CreateSubresourceSurface(This,index,ppSurface) \ + ( (This)->lpVtbl -> CreateSubresourceSurface(This,index,ppSurface) ) + +#define IDXGIResource1_CreateSharedHandle(This,pAttributes,dwAccess,lpName,pHandle) \ + ( (This)->lpVtbl -> CreateSharedHandle(This,pAttributes,dwAccess,lpName,pHandle) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIResource1_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0004 */ +/* [local] */ + +typedef +enum _DXGI_OFFER_RESOURCE_PRIORITY + { + DXGI_OFFER_RESOURCE_PRIORITY_LOW = 1, + DXGI_OFFER_RESOURCE_PRIORITY_NORMAL = ( DXGI_OFFER_RESOURCE_PRIORITY_LOW + 1 ) , + DXGI_OFFER_RESOURCE_PRIORITY_HIGH = ( DXGI_OFFER_RESOURCE_PRIORITY_NORMAL + 1 ) + } DXGI_OFFER_RESOURCE_PRIORITY; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0004_v0_0_s_ifspec; + +#ifndef __IDXGIDevice2_INTERFACE_DEFINED__ +#define __IDXGIDevice2_INTERFACE_DEFINED__ + +/* interface IDXGIDevice2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDevice2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("05008617-fbfd-4051-a790-144884b4f6a9") + IDXGIDevice2 : public IDXGIDevice1 + { + public: + virtual HRESULT STDMETHODCALLTYPE OfferResources( + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority) = 0; + + virtual HRESULT STDMETHODCALLTYPE ReclaimResources( + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_opt_(NumResources) BOOL *pDiscarded) = 0; + + virtual HRESULT STDMETHODCALLTYPE EnqueueSetEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDevice2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDevice2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDevice2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDevice2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetAdapter) + HRESULT ( STDMETHODCALLTYPE *GetAdapter )( + IDXGIDevice2 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter); + + DECLSPEC_XFGVIRT(IDXGIDevice, CreateSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSurface )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIDevice, QueryResourceResidency) + HRESULT ( STDMETHODCALLTYPE *QueryResourceResidency )( + IDXGIDevice2 * This, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources); + + DECLSPEC_XFGVIRT(IDXGIDevice, SetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *SetGPUThreadPriority )( + IDXGIDevice2 * This, + /* [in] */ INT Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *GetGPUThreadPriority )( + IDXGIDevice2 * This, + /* [annotation][retval][out] */ + _Out_ INT *pPriority); + + DECLSPEC_XFGVIRT(IDXGIDevice1, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGIDevice2 * This, + /* [in] */ UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice1, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGIDevice2 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice2, OfferResources) + HRESULT ( STDMETHODCALLTYPE *OfferResources )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice2, ReclaimResources) + HRESULT ( STDMETHODCALLTYPE *ReclaimResources )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_opt_(NumResources) BOOL *pDiscarded); + + DECLSPEC_XFGVIRT(IDXGIDevice2, EnqueueSetEvent) + HRESULT ( STDMETHODCALLTYPE *EnqueueSetEvent )( + IDXGIDevice2 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent); + + END_INTERFACE + } IDXGIDevice2Vtbl; + + interface IDXGIDevice2 + { + CONST_VTBL struct IDXGIDevice2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDevice2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDevice2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDevice2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDevice2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDevice2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDevice2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDevice2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDevice2_GetAdapter(This,pAdapter) \ + ( (This)->lpVtbl -> GetAdapter(This,pAdapter) ) + +#define IDXGIDevice2_CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) \ + ( (This)->lpVtbl -> CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) ) + +#define IDXGIDevice2_QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) \ + ( (This)->lpVtbl -> QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) ) + +#define IDXGIDevice2_SetGPUThreadPriority(This,Priority) \ + ( (This)->lpVtbl -> SetGPUThreadPriority(This,Priority) ) + +#define IDXGIDevice2_GetGPUThreadPriority(This,pPriority) \ + ( (This)->lpVtbl -> GetGPUThreadPriority(This,pPriority) ) + + +#define IDXGIDevice2_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGIDevice2_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + + +#define IDXGIDevice2_OfferResources(This,NumResources,ppResources,Priority) \ + ( (This)->lpVtbl -> OfferResources(This,NumResources,ppResources,Priority) ) + +#define IDXGIDevice2_ReclaimResources(This,NumResources,ppResources,pDiscarded) \ + ( (This)->lpVtbl -> ReclaimResources(This,NumResources,ppResources,pDiscarded) ) + +#define IDXGIDevice2_EnqueueSetEvent(This,hEvent) \ + ( (This)->lpVtbl -> EnqueueSetEvent(This,hEvent) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDevice2_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0005 */ +/* [local] */ + +#define DXGI_ENUM_MODES_STEREO ( 4UL ) + +#define DXGI_ENUM_MODES_DISABLED_STEREO ( 8UL ) + +#define DXGI_SHARED_RESOURCE_READ ( 0x80000000L ) + +#define DXGI_SHARED_RESOURCE_WRITE ( 1 ) + +typedef struct DXGI_MODE_DESC1 + { + UINT Width; + UINT Height; + DXGI_RATIONAL RefreshRate; + DXGI_FORMAT Format; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; + BOOL Stereo; + } DXGI_MODE_DESC1; + +typedef +enum DXGI_SCALING + { + DXGI_SCALING_STRETCH = 0, + DXGI_SCALING_NONE = 1, + DXGI_SCALING_ASPECT_RATIO_STRETCH = 2 + } DXGI_SCALING; + +typedef struct DXGI_SWAP_CHAIN_DESC1 + { + UINT Width; + UINT Height; + DXGI_FORMAT Format; + BOOL Stereo; + DXGI_SAMPLE_DESC SampleDesc; + DXGI_USAGE BufferUsage; + UINT BufferCount; + DXGI_SCALING Scaling; + DXGI_SWAP_EFFECT SwapEffect; + DXGI_ALPHA_MODE AlphaMode; + UINT Flags; + } DXGI_SWAP_CHAIN_DESC1; + +typedef struct DXGI_SWAP_CHAIN_FULLSCREEN_DESC + { + DXGI_RATIONAL RefreshRate; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; + BOOL Windowed; + } DXGI_SWAP_CHAIN_FULLSCREEN_DESC; + +typedef struct DXGI_PRESENT_PARAMETERS + { + UINT DirtyRectsCount; + /* [annotation] */ + _Field_size_full_opt_(DirtyRectsCount) RECT *pDirtyRects; + RECT *pScrollRect; + POINT *pScrollOffset; + } DXGI_PRESENT_PARAMETERS; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0005_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0005_v0_0_s_ifspec; + +#ifndef __IDXGISwapChain1_INTERFACE_DEFINED__ +#define __IDXGISwapChain1_INTERFACE_DEFINED__ + +/* interface IDXGISwapChain1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChain1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("790a45f7-0d42-4876-983a-0a55cfe6f4aa") + IDXGISwapChain1 : public IDXGISwapChain + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc1( + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC1 *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetFullscreenDesc( + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetHwnd( + /* [annotation][out] */ + _Out_ HWND *pHwnd) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetCoreWindow( + /* [annotation][in] */ + _In_ REFIID refiid, + /* [annotation][out] */ + _COM_Outptr_ void **ppUnk) = 0; + + virtual HRESULT STDMETHODCALLTYPE Present1( + /* [in] */ UINT SyncInterval, + /* [in] */ UINT PresentFlags, + /* [annotation][in] */ + _In_ const DXGI_PRESENT_PARAMETERS *pPresentParameters) = 0; + + virtual BOOL STDMETHODCALLTYPE IsTemporaryMonoSupported( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetRestrictToOutput( + /* [annotation][out] */ + _Out_ IDXGIOutput **ppRestrictToOutput) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetBackgroundColor( + /* [annotation][in] */ + _In_ const DXGI_RGBA *pColor) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetBackgroundColor( + /* [annotation][out] */ + _Out_ DXGI_RGBA *pColor) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetRotation( + /* [annotation][in] */ + _In_ DXGI_MODE_ROTATION Rotation) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetRotation( + /* [annotation][out] */ + _Out_ DXGI_MODE_ROTATION *pRotation) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChain1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChain1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChain1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChain1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISwapChain, Present) + HRESULT ( STDMETHODCALLTYPE *Present )( + IDXGISwapChain1 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetBuffer) + HRESULT ( STDMETHODCALLTYPE *GetBuffer )( + IDXGISwapChain1 * This, + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface); + + DECLSPEC_XFGVIRT(IDXGISwapChain, SetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *SetFullscreenState )( + IDXGISwapChain1 * This, + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenState )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeBuffers) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers )( + IDXGISwapChain1 * This, + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeTarget) + HRESULT ( STDMETHODCALLTYPE *ResizeTarget )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetContainingOutput) + HRESULT ( STDMETHODCALLTYPE *GetContainingOutput )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetLastPresentCount) + HRESULT ( STDMETHODCALLTYPE *GetLastPresentCount )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetFullscreenDesc) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenDesc )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetHwnd) + HRESULT ( STDMETHODCALLTYPE *GetHwnd )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ HWND *pHwnd); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetCoreWindow) + HRESULT ( STDMETHODCALLTYPE *GetCoreWindow )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ REFIID refiid, + /* [annotation][out] */ + _COM_Outptr_ void **ppUnk); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, Present1) + HRESULT ( STDMETHODCALLTYPE *Present1 )( + IDXGISwapChain1 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT PresentFlags, + /* [annotation][in] */ + _In_ const DXGI_PRESENT_PARAMETERS *pPresentParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, IsTemporaryMonoSupported) + BOOL ( STDMETHODCALLTYPE *IsTemporaryMonoSupported )( + IDXGISwapChain1 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRestrictToOutput) + HRESULT ( STDMETHODCALLTYPE *GetRestrictToOutput )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ IDXGIOutput **ppRestrictToOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *SetBackgroundColor )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ const DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *GetBackgroundColor )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetRotation) + HRESULT ( STDMETHODCALLTYPE *SetRotation )( + IDXGISwapChain1 * This, + /* [annotation][in] */ + _In_ DXGI_MODE_ROTATION Rotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRotation) + HRESULT ( STDMETHODCALLTYPE *GetRotation )( + IDXGISwapChain1 * This, + /* [annotation][out] */ + _Out_ DXGI_MODE_ROTATION *pRotation); + + END_INTERFACE + } IDXGISwapChain1Vtbl; + + interface IDXGISwapChain1 + { + CONST_VTBL struct IDXGISwapChain1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChain1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChain1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChain1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChain1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISwapChain1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISwapChain1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISwapChain1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISwapChain1_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISwapChain1_Present(This,SyncInterval,Flags) \ + ( (This)->lpVtbl -> Present(This,SyncInterval,Flags) ) + +#define IDXGISwapChain1_GetBuffer(This,Buffer,riid,ppSurface) \ + ( (This)->lpVtbl -> GetBuffer(This,Buffer,riid,ppSurface) ) + +#define IDXGISwapChain1_SetFullscreenState(This,Fullscreen,pTarget) \ + ( (This)->lpVtbl -> SetFullscreenState(This,Fullscreen,pTarget) ) + +#define IDXGISwapChain1_GetFullscreenState(This,pFullscreen,ppTarget) \ + ( (This)->lpVtbl -> GetFullscreenState(This,pFullscreen,ppTarget) ) + +#define IDXGISwapChain1_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISwapChain1_ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) \ + ( (This)->lpVtbl -> ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) ) + +#define IDXGISwapChain1_ResizeTarget(This,pNewTargetParameters) \ + ( (This)->lpVtbl -> ResizeTarget(This,pNewTargetParameters) ) + +#define IDXGISwapChain1_GetContainingOutput(This,ppOutput) \ + ( (This)->lpVtbl -> GetContainingOutput(This,ppOutput) ) + +#define IDXGISwapChain1_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#define IDXGISwapChain1_GetLastPresentCount(This,pLastPresentCount) \ + ( (This)->lpVtbl -> GetLastPresentCount(This,pLastPresentCount) ) + + +#define IDXGISwapChain1_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#define IDXGISwapChain1_GetFullscreenDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetFullscreenDesc(This,pDesc) ) + +#define IDXGISwapChain1_GetHwnd(This,pHwnd) \ + ( (This)->lpVtbl -> GetHwnd(This,pHwnd) ) + +#define IDXGISwapChain1_GetCoreWindow(This,refiid,ppUnk) \ + ( (This)->lpVtbl -> GetCoreWindow(This,refiid,ppUnk) ) + +#define IDXGISwapChain1_Present1(This,SyncInterval,PresentFlags,pPresentParameters) \ + ( (This)->lpVtbl -> Present1(This,SyncInterval,PresentFlags,pPresentParameters) ) + +#define IDXGISwapChain1_IsTemporaryMonoSupported(This) \ + ( (This)->lpVtbl -> IsTemporaryMonoSupported(This) ) + +#define IDXGISwapChain1_GetRestrictToOutput(This,ppRestrictToOutput) \ + ( (This)->lpVtbl -> GetRestrictToOutput(This,ppRestrictToOutput) ) + +#define IDXGISwapChain1_SetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> SetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain1_GetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> GetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain1_SetRotation(This,Rotation) \ + ( (This)->lpVtbl -> SetRotation(This,Rotation) ) + +#define IDXGISwapChain1_GetRotation(This,pRotation) \ + ( (This)->lpVtbl -> GetRotation(This,pRotation) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChain1_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIFactory2_INTERFACE_DEFINED__ +#define __IDXGIFactory2_INTERFACE_DEFINED__ + +/* interface IDXGIFactory2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("50c83a1c-e072-4c48-87b0-3630fa36a6d0") + IDXGIFactory2 : public IDXGIFactory1 + { + public: + virtual BOOL STDMETHODCALLTYPE IsWindowedStereoEnabled( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSwapChainForHwnd( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSwapChainForCoreWindow( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetSharedResourceAdapterLuid( + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid) = 0; + + virtual HRESULT STDMETHODCALLTYPE RegisterStereoStatusWindow( + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE RegisterStereoStatusEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual void STDMETHODCALLTYPE UnregisterStereoStatus( + /* [annotation][in] */ + _In_ DWORD dwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE RegisterOcclusionStatusWindow( + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE RegisterOcclusionStatusEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual void STDMETHODCALLTYPE UnregisterOcclusionStatus( + /* [annotation][in] */ + _In_ DWORD dwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateSwapChainForComposition( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory2 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory2 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory2 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory2 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory2 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory2 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory2 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory2 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + END_INTERFACE + } IDXGIFactory2Vtbl; + + interface IDXGIFactory2 + { + CONST_VTBL struct IDXGIFactory2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory2_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory2_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory2_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory2_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory2_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory2_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory2_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory2_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory2_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory2_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory2_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory2_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory2_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory2_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory2_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory2_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory2_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory2_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory2_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0007 */ +/* [local] */ + +typedef +enum DXGI_GRAPHICS_PREEMPTION_GRANULARITY + { + DXGI_GRAPHICS_PREEMPTION_DMA_BUFFER_BOUNDARY = 0, + DXGI_GRAPHICS_PREEMPTION_PRIMITIVE_BOUNDARY = 1, + DXGI_GRAPHICS_PREEMPTION_TRIANGLE_BOUNDARY = 2, + DXGI_GRAPHICS_PREEMPTION_PIXEL_BOUNDARY = 3, + DXGI_GRAPHICS_PREEMPTION_INSTRUCTION_BOUNDARY = 4 + } DXGI_GRAPHICS_PREEMPTION_GRANULARITY; + +typedef +enum DXGI_COMPUTE_PREEMPTION_GRANULARITY + { + DXGI_COMPUTE_PREEMPTION_DMA_BUFFER_BOUNDARY = 0, + DXGI_COMPUTE_PREEMPTION_DISPATCH_BOUNDARY = 1, + DXGI_COMPUTE_PREEMPTION_THREAD_GROUP_BOUNDARY = 2, + DXGI_COMPUTE_PREEMPTION_THREAD_BOUNDARY = 3, + DXGI_COMPUTE_PREEMPTION_INSTRUCTION_BOUNDARY = 4 + } DXGI_COMPUTE_PREEMPTION_GRANULARITY; + +typedef struct DXGI_ADAPTER_DESC2 + { + WCHAR Description[ 128 ]; + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + LUID AdapterLuid; + UINT Flags; + DXGI_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity; + DXGI_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity; + } DXGI_ADAPTER_DESC2; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0007_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0007_v0_0_s_ifspec; + +#ifndef __IDXGIAdapter2_INTERFACE_DEFINED__ +#define __IDXGIAdapter2_INTERFACE_DEFINED__ + +/* interface IDXGIAdapter2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIAdapter2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("0AA1AE0A-FA0E-4B84-8644-E05FF8E5ACB5") + IDXGIAdapter2 : public IDXGIAdapter1 + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc2( + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC2 *pDesc) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIAdapter2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIAdapter2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIAdapter2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIAdapter2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIAdapter2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIAdapter2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIAdapter2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIAdapter2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIAdapter, EnumOutputs) + HRESULT ( STDMETHODCALLTYPE *EnumOutputs )( + IDXGIAdapter2 * This, + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGIAdapter, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIAdapter2 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter, CheckInterfaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckInterfaceSupport )( + IDXGIAdapter2 * This, + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion); + + DECLSPEC_XFGVIRT(IDXGIAdapter1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGIAdapter2 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter2, GetDesc2) + HRESULT ( STDMETHODCALLTYPE *GetDesc2 )( + IDXGIAdapter2 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC2 *pDesc); + + END_INTERFACE + } IDXGIAdapter2Vtbl; + + interface IDXGIAdapter2 + { + CONST_VTBL struct IDXGIAdapter2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIAdapter2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIAdapter2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIAdapter2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIAdapter2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIAdapter2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIAdapter2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIAdapter2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIAdapter2_EnumOutputs(This,Output,ppOutput) \ + ( (This)->lpVtbl -> EnumOutputs(This,Output,ppOutput) ) + +#define IDXGIAdapter2_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIAdapter2_CheckInterfaceSupport(This,InterfaceName,pUMDVersion) \ + ( (This)->lpVtbl -> CheckInterfaceSupport(This,InterfaceName,pUMDVersion) ) + + +#define IDXGIAdapter2_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + + +#define IDXGIAdapter2_GetDesc2(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc2(This,pDesc) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIAdapter2_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIOutput1_INTERFACE_DEFINED__ +#define __IDXGIOutput1_INTERFACE_DEFINED__ + +/* interface IDXGIOutput1 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput1; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("00cddea8-939b-4b83-a340-a685226666cc") + IDXGIOutput1 : public IDXGIOutput + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDisplayModeList1( + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE FindClosestMatchingMode1( + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDisplaySurfaceData1( + /* [annotation][in] */ + _In_ IDXGIResource *pDestination) = 0; + + virtual HRESULT STDMETHODCALLTYPE DuplicateOutput( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput1Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput1 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput1 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput1 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput1 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput1 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput1 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput1 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput1 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput1 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput1 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput1 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput1 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + END_INTERFACE + } IDXGIOutput1Vtbl; + + interface IDXGIOutput1 + { + CONST_VTBL struct IDXGIOutput1Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput1_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput1_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput1_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput1_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput1_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput1_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput1_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput1_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput1_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput1_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput1_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput1_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput1_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput1_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput1_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput1_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput1_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput1_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput1_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput1_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput1_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput1_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput1_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput1_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_2_0000_0009 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +DEFINE_GUID(IID_IDXGIDisplayControl,0xea9dbf1a,0xc88e,0x4486,0x85,0x4a,0x98,0xaa,0x01,0x38,0xf3,0x0c); +DEFINE_GUID(IID_IDXGIOutputDuplication,0x191cfac3,0xa341,0x470d,0xb2,0x6e,0xa8,0x64,0xf4,0x28,0x31,0x9c); +DEFINE_GUID(IID_IDXGISurface2,0xaba496dd,0xb617,0x4cb8,0xa8,0x66,0xbc,0x44,0xd7,0xeb,0x1f,0xa2); +DEFINE_GUID(IID_IDXGIResource1,0x30961379,0x4609,0x4a41,0x99,0x8e,0x54,0xfe,0x56,0x7e,0xe0,0xc1); +DEFINE_GUID(IID_IDXGIDevice2,0x05008617,0xfbfd,0x4051,0xa7,0x90,0x14,0x48,0x84,0xb4,0xf6,0xa9); +DEFINE_GUID(IID_IDXGISwapChain1,0x790a45f7,0x0d42,0x4876,0x98,0x3a,0x0a,0x55,0xcf,0xe6,0xf4,0xaa); +DEFINE_GUID(IID_IDXGIFactory2,0x50c83a1c,0xe072,0x4c48,0x87,0xb0,0x36,0x30,0xfa,0x36,0xa6,0xd0); +DEFINE_GUID(IID_IDXGIAdapter2,0x0AA1AE0A,0xFA0E,0x4B84,0x86,0x44,0xE0,0x5F,0xF8,0xE5,0xAC,0xB5); +DEFINE_GUID(IID_IDXGIOutput1,0x00cddea8,0x939b,0x4b83,0xa3,0x40,0xa6,0x85,0x22,0x66,0x66,0xcc); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0009_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_2_0000_0009_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.idl new file mode 100644 index 0000000000000000000000000000000000000000..e5c1a6da4065efdb4200a6817866c9b70241ebb8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_2.idl @@ -0,0 +1,427 @@ +// Copyright (c) Microsoft Corporation. All Rights Reserved + +import "dxgi.idl"; + +cpp_quote("#include ") + +#pragma region Desktop Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)") + +[ + object, + uuid( ea9dbf1a-c88e-4486-854a-98aa0138f30c ), + local, + pointer_default(unique) +] +interface IDXGIDisplayControl : + IUnknown +{ + BOOL IsStereoEnabled(); + void SetStereoEnabled(BOOL enabled); +}; + + //-------------------------------------------------------------------------------------------------------- +// IDXGIOutputDuplication structures +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_OUTDUPL_MOVE_RECT +{ + POINT SourcePoint; + RECT DestinationRect; +} DXGI_OUTDUPL_MOVE_RECT; + +typedef struct DXGI_OUTDUPL_DESC +{ + DXGI_MODE_DESC ModeDesc; + DXGI_MODE_ROTATION Rotation; + BOOL DesktopImageInSystemMemory; +} DXGI_OUTDUPL_DESC; + +typedef struct DXGI_OUTDUPL_POINTER_POSITION +{ + POINT Position; + BOOL Visible; +} DXGI_OUTDUPL_POINTER_POSITION; + +typedef enum DXGI_OUTDUPL_POINTER_SHAPE_TYPE +{ + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME = 0x00000001, + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR = 0x00000002, + DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR = 0x00000004 +} DXGI_OUTDUPL_POINTER_SHAPE_TYPE; + +typedef struct DXGI_OUTDUPL_POINTER_SHAPE_INFO +{ + UINT Type; + UINT Width; + UINT Height; + UINT Pitch; + POINT HotSpot; +} DXGI_OUTDUPL_POINTER_SHAPE_INFO; + +typedef struct DXGI_OUTDUPL_FRAME_INFO +{ + LARGE_INTEGER LastPresentTime; + LARGE_INTEGER LastMouseUpdateTime; + UINT AccumulatedFrames; + BOOL RectsCoalesced; + BOOL ProtectedContentMaskedOut; + DXGI_OUTDUPL_POINTER_POSITION PointerPosition; + UINT TotalMetadataBufferSize; + UINT PointerShapeBufferSize; +} DXGI_OUTDUPL_FRAME_INFO; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutputDuplication interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(191cfac3-a341-470d-b26e-a864f428319c), + local, + pointer_default(unique) +] +interface IDXGIOutputDuplication : + IDXGIObject +{ + void GetDesc([out, annotation ("_Out_")] DXGI_OUTDUPL_DESC* pDesc); + HRESULT AcquireNextFrame([in, annotation ("_In_")] UINT TimeoutInMilliseconds, + [out, annotation("_Out_")] DXGI_OUTDUPL_FRAME_INFO* pFrameInfo, + [out, annotation("_COM_Outptr_")] IDXGIResource** ppDesktopResource); + HRESULT GetFrameDirtyRects([in, annotation("_In_")] UINT DirtyRectsBufferSize, + [out, annotation("_Out_writes_bytes_to_(DirtyRectsBufferSize, *pDirtyRectsBufferSizeRequired)")] RECT* pDirtyRectsBuffer, + [out, annotation("_Out_")] UINT* pDirtyRectsBufferSizeRequired); + HRESULT GetFrameMoveRects([in, annotation("_In_")] UINT MoveRectsBufferSize, + [out, annotation("_Out_writes_bytes_to_(MoveRectsBufferSize, *pMoveRectsBufferSizeRequired)")] DXGI_OUTDUPL_MOVE_RECT* pMoveRectBuffer, + [out, annotation("_Out_")] UINT* pMoveRectsBufferSizeRequired); + HRESULT GetFramePointerShape([in, annotation("_In_")] UINT PointerShapeBufferSize, + [out, annotation("_Out_writes_bytes_to_(PointerShapeBufferSize, *pPointerShapeBufferSizeRequired)")] void* pPointerShapeBuffer, + [out, annotation("_Out_")] UINT* pPointerShapeBufferSizeRequired, + [out, annotation("_Out_")] DXGI_OUTDUPL_POINTER_SHAPE_INFO* pPointerShapeInfo); + HRESULT MapDesktopSurface([out, annotation("_Out_")] DXGI_MAPPED_RECT* pLockedRect); + HRESULT UnMapDesktopSurface(); + HRESULT ReleaseFrame(); +}; +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */") +#pragma endregion + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") + +typedef enum DXGI_ALPHA_MODE +{ + DXGI_ALPHA_MODE_UNSPECIFIED = 0, + DXGI_ALPHA_MODE_PREMULTIPLIED = 1, + DXGI_ALPHA_MODE_STRAIGHT = 2, + DXGI_ALPHA_MODE_IGNORE = 3, + DXGI_ALPHA_MODE_FORCE_DWORD = 0xffffffff +} DXGI_ALPHA_MODE; + +[ + object, + uuid(aba496dd-b617-4cb8-a866-bc44d7eb1fa2), + local, + pointer_default(unique) +] +interface IDXGISurface2 : + IDXGISurface1 +{ + HRESULT GetResource([in, annotation("_In_")] REFIID riid, + [out, annotation("_COM_Outptr_")] void **ppParentResource, + [out, annotation("_Out_")] UINT *pSubresourceIndex); +}; + +[ + object, + uuid(30961379-4609-4a41-998e-54fe567ee0c1), + local, + pointer_default(unique) +] +interface IDXGIResource1 : + IDXGIResource +{ + HRESULT CreateSubresourceSurface( + UINT index, + [out, annotation("_COM_Outptr_")] IDXGISurface2 **ppSurface ); + + HRESULT CreateSharedHandle( + [in, annotation("_In_opt_")] const SECURITY_ATTRIBUTES *pAttributes, + [in, annotation("_In_")] DWORD dwAccess, + [in, annotation("_In_opt_")] LPCWSTR lpName, + [out, annotation("_Out_")] HANDLE *pHandle); +}; + +typedef enum _DXGI_OFFER_RESOURCE_PRIORITY +{ + DXGI_OFFER_RESOURCE_PRIORITY_LOW=1, + DXGI_OFFER_RESOURCE_PRIORITY_NORMAL, + DXGI_OFFER_RESOURCE_PRIORITY_HIGH, +} DXGI_OFFER_RESOURCE_PRIORITY; + +[ + object, + uuid( 05008617-fbfd-4051-a790-144884b4f6a9 ), + local, + pointer_default(unique) +] +interface IDXGIDevice2 : + IDXGIDevice1 +{ + HRESULT OfferResources( + [in, annotation("_In_")] UINT NumResources, + [in, size_is(NumResources), annotation("_In_reads_(NumResources)")] IDXGIResource *const *ppResources, + [in, annotation("_In_")] DXGI_OFFER_RESOURCE_PRIORITY Priority); + HRESULT ReclaimResources( + [in, annotation("_In_")] UINT NumResources, + [in, size_is(NumResources), annotation("_In_reads_(NumResources)")] IDXGIResource *const *ppResources, + [out, size_is(NumResources), annotation("_Out_writes_all_opt_(NumResources)")] BOOL *pDiscarded); + HRESULT EnqueueSetEvent( [in, annotation("_In_")] HANDLE hEvent ); +}; + +const UINT DXGI_ENUM_MODES_STEREO = 4UL; +const UINT DXGI_ENUM_MODES_DISABLED_STEREO = 8UL; + +const DWORD DXGI_SHARED_RESOURCE_READ = 0x80000000L; +const DWORD DXGI_SHARED_RESOURCE_WRITE = 1; + +typedef struct DXGI_MODE_DESC1 +{ + UINT Width; + UINT Height; + DXGI_RATIONAL RefreshRate; + DXGI_FORMAT Format; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; + BOOL Stereo; +} DXGI_MODE_DESC1; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapchain1 structures +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_SCALING +{ + DXGI_SCALING_STRETCH = 0, + DXGI_SCALING_NONE = 1, + DXGI_SCALING_ASPECT_RATIO_STRETCH = 2, +} DXGI_SCALING; + +typedef struct DXGI_SWAP_CHAIN_DESC1 +{ + UINT Width; + UINT Height; + DXGI_FORMAT Format; + BOOL Stereo; + DXGI_SAMPLE_DESC SampleDesc; + DXGI_USAGE BufferUsage; + UINT BufferCount; + DXGI_SCALING Scaling; + DXGI_SWAP_EFFECT SwapEffect; + DXGI_ALPHA_MODE AlphaMode; + UINT Flags; // DXGI_SWAP_CHAIN_FLAG +} DXGI_SWAP_CHAIN_DESC1; + +typedef struct DXGI_SWAP_CHAIN_FULLSCREEN_DESC +{ + DXGI_RATIONAL RefreshRate; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; + BOOL Windowed; +} DXGI_SWAP_CHAIN_FULLSCREEN_DESC; + +typedef struct DXGI_PRESENT_PARAMETERS +{ + UINT DirtyRectsCount; + [annotation("_Field_size_full_opt_(DirtyRectsCount)")] RECT* pDirtyRects; + RECT* pScrollRect; + POINT* pScrollOffset; +} DXGI_PRESENT_PARAMETERS; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapchain1 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 790a45f7-0d42-4876-983a-0a55cfe6f4aa ), + local, + pointer_default(unique) +] +interface IDXGISwapChain1 : + IDXGISwapChain +{ + HRESULT GetDesc1( [out, annotation("_Out_")] DXGI_SWAP_CHAIN_DESC1 *pDesc ); + HRESULT GetFullscreenDesc( [out, annotation("_Out_")] DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc ); + + HRESULT GetHwnd( [out, annotation("_Out_")] HWND *pHwnd); + HRESULT GetCoreWindow ( + [in, annotation("_In_")] REFIID refiid, + [out, annotation("_COM_Outptr_")] void **ppUnk); + + HRESULT Present1( + [in] UINT SyncInterval, + [in] UINT PresentFlags, + [in, annotation("_In_")] const DXGI_PRESENT_PARAMETERS* pPresentParameters ); + BOOL IsTemporaryMonoSupported(); + HRESULT GetRestrictToOutput( [out, annotation("_Out_")] IDXGIOutput** ppRestrictToOutput ); + HRESULT SetBackgroundColor( [in, annotation("_In_")] const DXGI_RGBA* pColor ); + HRESULT GetBackgroundColor( [out, annotation("_Out_")] DXGI_RGBA* pColor ); + HRESULT SetRotation( [in, annotation("_In_")] DXGI_MODE_ROTATION Rotation ); + HRESULT GetRotation( [out, annotation("_Out_")] DXGI_MODE_ROTATION* pRotation ); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory2 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 50c83a1c-e072-4c48-87b0-3630fa36a6d0 ), + local, + pointer_default(unique) +] +interface IDXGIFactory2 : + IDXGIFactory1 +{ + BOOL IsWindowedStereoEnabled(); + + HRESULT CreateSwapChainForHwnd( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_")] HWND hWnd, + [in, annotation("_In_")] const DXGI_SWAP_CHAIN_DESC1 *pDesc, + [in, annotation("_In_opt_")] const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + [in, annotation("_In_opt_")] IDXGIOutput *pRestrictToOutput, + [out, annotation("_COM_Outptr_")] IDXGISwapChain1 **ppSwapChain ); + + HRESULT CreateSwapChainForCoreWindow( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_")] IUnknown *pWindow, + [in, annotation("_In_")] const DXGI_SWAP_CHAIN_DESC1 *pDesc, + [in, annotation("_In_opt_")] IDXGIOutput *pRestrictToOutput, + [out, annotation("_COM_Outptr_")] IDXGISwapChain1 **ppSwapChain ); + + HRESULT GetSharedResourceAdapterLuid( + [annotation("_In_")] HANDLE hResource, + [annotation("_Out_")] LUID* pLuid); + + HRESULT RegisterStereoStatusWindow( + [in, annotation("_In_")] HWND WindowHandle, + [in, annotation("_In_")] UINT wMsg, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + HRESULT RegisterStereoStatusEvent( + [in, annotation("_In_")] HANDLE hEvent, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + void UnregisterStereoStatus( + [in, annotation("_In_")] DWORD dwCookie ); + + HRESULT RegisterOcclusionStatusWindow( + [in, annotation("_In_")] HWND WindowHandle, + [in, annotation("_In_")] UINT wMsg, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + HRESULT RegisterOcclusionStatusEvent( + [in, annotation("_In_")] HANDLE hEvent, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + void UnregisterOcclusionStatus( + [in, annotation("_In_")] DWORD dwCookie ); + + HRESULT CreateSwapChainForComposition( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_")] const DXGI_SWAP_CHAIN_DESC1 *pDesc, + [in, annotation("_In_opt_")] IDXGIOutput *pRestrictToOutput, + [out, annotation("_COM_Outptr_")] IDXGISwapChain1 **ppSwapChain ); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIAdapter2 structures +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_GRAPHICS_PREEMPTION_GRANULARITY +{ + DXGI_GRAPHICS_PREEMPTION_DMA_BUFFER_BOUNDARY = 0, + DXGI_GRAPHICS_PREEMPTION_PRIMITIVE_BOUNDARY = 1, + DXGI_GRAPHICS_PREEMPTION_TRIANGLE_BOUNDARY = 2, + DXGI_GRAPHICS_PREEMPTION_PIXEL_BOUNDARY = 3, + DXGI_GRAPHICS_PREEMPTION_INSTRUCTION_BOUNDARY = 4, +} DXGI_GRAPHICS_PREEMPTION_GRANULARITY; + +typedef enum DXGI_COMPUTE_PREEMPTION_GRANULARITY +{ + DXGI_COMPUTE_PREEMPTION_DMA_BUFFER_BOUNDARY = 0, + DXGI_COMPUTE_PREEMPTION_DISPATCH_BOUNDARY = 1, + DXGI_COMPUTE_PREEMPTION_THREAD_GROUP_BOUNDARY = 2, + DXGI_COMPUTE_PREEMPTION_THREAD_BOUNDARY = 3, + DXGI_COMPUTE_PREEMPTION_INSTRUCTION_BOUNDARY = 4, +} DXGI_COMPUTE_PREEMPTION_GRANULARITY; + +typedef struct DXGI_ADAPTER_DESC2 +{ + WCHAR Description[128]; + + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + + LUID AdapterLuid; + + UINT Flags; + + DXGI_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity; + DXGI_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity; +} DXGI_ADAPTER_DESC2; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIAdapter2 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(0AA1AE0A-FA0E-4B84-8644-E05FF8E5ACB5), + local, + pointer_default(unique) +] +interface IDXGIAdapter2 : + IDXGIAdapter1 +{ + HRESULT GetDesc2( [out, annotation("_Out_")] DXGI_ADAPTER_DESC2 *pDesc); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput1 +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(00cddea8-939b-4b83-a340-a685226666cc), + local, + pointer_default(unique) +] +interface IDXGIOutput1 : + IDXGIOutput +{ + HRESULT GetDisplayModeList1( + [in] DXGI_FORMAT EnumFormat, + [in] UINT Flags, + [in, out, annotation("_Inout_")] UINT * pNumModes, + [out, annotation("_Out_writes_to_opt_(*pNumModes,*pNumModes)")] DXGI_MODE_DESC1 *pDesc); + HRESULT FindClosestMatchingMode1( + [in, annotation("_In_")] const DXGI_MODE_DESC1 *pModeToMatch, + [out, annotation("_Out_")] DXGI_MODE_DESC1 *pClosestMatch, + [in, annotation("_In_opt_")] IUnknown * pConcernedDevice ); + HRESULT GetDisplaySurfaceData1( [in, annotation("_In_")] IDXGIResource *pDestination ); + HRESULT DuplicateOutput([in, annotation("_In_")] IUnknown *pDevice, + [out, annotation("_COM_Outptr_")] IDXGIOutputDuplication **ppOutputDuplication); +}; + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +cpp_quote( "DEFINE_GUID(IID_IDXGIDisplayControl,0xea9dbf1a,0xc88e,0x4486,0x85,0x4a,0x98,0xaa,0x01,0x38,0xf3,0x0c);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutputDuplication,0x191cfac3,0xa341,0x470d,0xb2,0x6e,0xa8,0x64,0xf4,0x28,0x31,0x9c);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISurface2,0xaba496dd,0xb617,0x4cb8,0xa8,0x66,0xbc,0x44,0xd7,0xeb,0x1f,0xa2);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIResource1,0x30961379,0x4609,0x4a41,0x99,0x8e,0x54,0xfe,0x56,0x7e,0xe0,0xc1);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDevice2,0x05008617,0xfbfd,0x4051,0xa7,0x90,0x14,0x48,0x84,0xb4,0xf6,0xa9);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChain1,0x790a45f7,0x0d42,0x4876,0x98,0x3a,0x0a,0x55,0xcf,0xe6,0xf4,0xaa);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory2,0x50c83a1c,0xe072,0x4c48,0x87,0xb0,0x36,0x30,0xfa,0x36,0xa6,0xd0);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIAdapter2,0x0AA1AE0A,0xFA0E,0x4B84,0x86,0x44,0xE0,0x5F,0xF8,0xE5,0xAC,0xB5);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput1,0x00cddea8,0x939b,0x4b83,0xa3,0x40,0xa6,0x85,0x22,0x66,0x66,0xcc);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.h new file mode 100644 index 0000000000000000000000000000000000000000..6ef6608dba5c2f6467c0c8de9519bfd425c2e454 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.h @@ -0,0 +1,2281 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi1_3_h__ +#define __dxgi1_3_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGIDevice3_FWD_DEFINED__ +#define __IDXGIDevice3_FWD_DEFINED__ +typedef interface IDXGIDevice3 IDXGIDevice3; + +#endif /* __IDXGIDevice3_FWD_DEFINED__ */ + + +#ifndef __IDXGISwapChain2_FWD_DEFINED__ +#define __IDXGISwapChain2_FWD_DEFINED__ +typedef interface IDXGISwapChain2 IDXGISwapChain2; + +#endif /* __IDXGISwapChain2_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput2_FWD_DEFINED__ +#define __IDXGIOutput2_FWD_DEFINED__ +typedef interface IDXGIOutput2 IDXGIOutput2; + +#endif /* __IDXGIOutput2_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory3_FWD_DEFINED__ +#define __IDXGIFactory3_FWD_DEFINED__ +typedef interface IDXGIFactory3 IDXGIFactory3; + +#endif /* __IDXGIFactory3_FWD_DEFINED__ */ + + +#ifndef __IDXGIDecodeSwapChain_FWD_DEFINED__ +#define __IDXGIDecodeSwapChain_FWD_DEFINED__ +typedef interface IDXGIDecodeSwapChain IDXGIDecodeSwapChain; + +#endif /* __IDXGIDecodeSwapChain_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactoryMedia_FWD_DEFINED__ +#define __IDXGIFactoryMedia_FWD_DEFINED__ +typedef interface IDXGIFactoryMedia IDXGIFactoryMedia; + +#endif /* __IDXGIFactoryMedia_FWD_DEFINED__ */ + + +#ifndef __IDXGISwapChainMedia_FWD_DEFINED__ +#define __IDXGISwapChainMedia_FWD_DEFINED__ +typedef interface IDXGISwapChainMedia IDXGISwapChainMedia; + +#endif /* __IDXGISwapChainMedia_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput3_FWD_DEFINED__ +#define __IDXGIOutput3_FWD_DEFINED__ +typedef interface IDXGIOutput3 IDXGIOutput3; + +#endif /* __IDXGIOutput3_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "dxgi1_2.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi1_3_0000_0000 */ +/* [local] */ + +#include +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) +#define DXGI_CREATE_FACTORY_DEBUG 0x1 +HRESULT WINAPI CreateDXGIFactory2(UINT Flags, REFIID riid, _COM_Outptr_ void **ppFactory); +HRESULT WINAPI DXGIGetDebugInterface1(UINT Flags, REFIID riid, _COM_Outptr_ void **pDebug); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGIDevice3_INTERFACE_DEFINED__ +#define __IDXGIDevice3_INTERFACE_DEFINED__ + +/* interface IDXGIDevice3 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDevice3; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("6007896c-3244-4afd-bf18-a6d3beda5023") + IDXGIDevice3 : public IDXGIDevice2 + { + public: + virtual void STDMETHODCALLTYPE Trim( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDevice3Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDevice3 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDevice3 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDevice3 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetAdapter) + HRESULT ( STDMETHODCALLTYPE *GetAdapter )( + IDXGIDevice3 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter); + + DECLSPEC_XFGVIRT(IDXGIDevice, CreateSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSurface )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIDevice, QueryResourceResidency) + HRESULT ( STDMETHODCALLTYPE *QueryResourceResidency )( + IDXGIDevice3 * This, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources); + + DECLSPEC_XFGVIRT(IDXGIDevice, SetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *SetGPUThreadPriority )( + IDXGIDevice3 * This, + /* [in] */ INT Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *GetGPUThreadPriority )( + IDXGIDevice3 * This, + /* [annotation][retval][out] */ + _Out_ INT *pPriority); + + DECLSPEC_XFGVIRT(IDXGIDevice1, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGIDevice3 * This, + /* [in] */ UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice1, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGIDevice3 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice2, OfferResources) + HRESULT ( STDMETHODCALLTYPE *OfferResources )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice2, ReclaimResources) + HRESULT ( STDMETHODCALLTYPE *ReclaimResources )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_opt_(NumResources) BOOL *pDiscarded); + + DECLSPEC_XFGVIRT(IDXGIDevice2, EnqueueSetEvent) + HRESULT ( STDMETHODCALLTYPE *EnqueueSetEvent )( + IDXGIDevice3 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent); + + DECLSPEC_XFGVIRT(IDXGIDevice3, Trim) + void ( STDMETHODCALLTYPE *Trim )( + IDXGIDevice3 * This); + + END_INTERFACE + } IDXGIDevice3Vtbl; + + interface IDXGIDevice3 + { + CONST_VTBL struct IDXGIDevice3Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDevice3_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDevice3_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDevice3_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDevice3_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDevice3_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDevice3_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDevice3_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDevice3_GetAdapter(This,pAdapter) \ + ( (This)->lpVtbl -> GetAdapter(This,pAdapter) ) + +#define IDXGIDevice3_CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) \ + ( (This)->lpVtbl -> CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) ) + +#define IDXGIDevice3_QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) \ + ( (This)->lpVtbl -> QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) ) + +#define IDXGIDevice3_SetGPUThreadPriority(This,Priority) \ + ( (This)->lpVtbl -> SetGPUThreadPriority(This,Priority) ) + +#define IDXGIDevice3_GetGPUThreadPriority(This,pPriority) \ + ( (This)->lpVtbl -> GetGPUThreadPriority(This,pPriority) ) + + +#define IDXGIDevice3_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGIDevice3_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + + +#define IDXGIDevice3_OfferResources(This,NumResources,ppResources,Priority) \ + ( (This)->lpVtbl -> OfferResources(This,NumResources,ppResources,Priority) ) + +#define IDXGIDevice3_ReclaimResources(This,NumResources,ppResources,pDiscarded) \ + ( (This)->lpVtbl -> ReclaimResources(This,NumResources,ppResources,pDiscarded) ) + +#define IDXGIDevice3_EnqueueSetEvent(This,hEvent) \ + ( (This)->lpVtbl -> EnqueueSetEvent(This,hEvent) ) + + +#define IDXGIDevice3_Trim(This) \ + ( (This)->lpVtbl -> Trim(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDevice3_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_3_0000_0001 */ +/* [local] */ + +typedef struct DXGI_MATRIX_3X2_F + { + FLOAT _11; + FLOAT _12; + FLOAT _21; + FLOAT _22; + FLOAT _31; + FLOAT _32; + } DXGI_MATRIX_3X2_F; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0001_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0001_v0_0_s_ifspec; + +#ifndef __IDXGISwapChain2_INTERFACE_DEFINED__ +#define __IDXGISwapChain2_INTERFACE_DEFINED__ + +/* interface IDXGISwapChain2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChain2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("a8be2ac4-199f-4946-b331-79599fb98de7") + IDXGISwapChain2 : public IDXGISwapChain1 + { + public: + virtual HRESULT STDMETHODCALLTYPE SetSourceSize( + UINT Width, + UINT Height) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetSourceSize( + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetMaximumFrameLatency( + UINT MaxLatency) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetMaximumFrameLatency( + /* [annotation][out] */ + _Out_ UINT *pMaxLatency) = 0; + + virtual HANDLE STDMETHODCALLTYPE GetFrameLatencyWaitableObject( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetMatrixTransform( + const DXGI_MATRIX_3X2_F *pMatrix) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetMatrixTransform( + /* [annotation][out] */ + _Out_ DXGI_MATRIX_3X2_F *pMatrix) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChain2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChain2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChain2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChain2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISwapChain, Present) + HRESULT ( STDMETHODCALLTYPE *Present )( + IDXGISwapChain2 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetBuffer) + HRESULT ( STDMETHODCALLTYPE *GetBuffer )( + IDXGISwapChain2 * This, + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface); + + DECLSPEC_XFGVIRT(IDXGISwapChain, SetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *SetFullscreenState )( + IDXGISwapChain2 * This, + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenState )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeBuffers) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers )( + IDXGISwapChain2 * This, + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeTarget) + HRESULT ( STDMETHODCALLTYPE *ResizeTarget )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetContainingOutput) + HRESULT ( STDMETHODCALLTYPE *GetContainingOutput )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetLastPresentCount) + HRESULT ( STDMETHODCALLTYPE *GetLastPresentCount )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetFullscreenDesc) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenDesc )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetHwnd) + HRESULT ( STDMETHODCALLTYPE *GetHwnd )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ HWND *pHwnd); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetCoreWindow) + HRESULT ( STDMETHODCALLTYPE *GetCoreWindow )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ REFIID refiid, + /* [annotation][out] */ + _COM_Outptr_ void **ppUnk); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, Present1) + HRESULT ( STDMETHODCALLTYPE *Present1 )( + IDXGISwapChain2 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT PresentFlags, + /* [annotation][in] */ + _In_ const DXGI_PRESENT_PARAMETERS *pPresentParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, IsTemporaryMonoSupported) + BOOL ( STDMETHODCALLTYPE *IsTemporaryMonoSupported )( + IDXGISwapChain2 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRestrictToOutput) + HRESULT ( STDMETHODCALLTYPE *GetRestrictToOutput )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ IDXGIOutput **ppRestrictToOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *SetBackgroundColor )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ const DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *GetBackgroundColor )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetRotation) + HRESULT ( STDMETHODCALLTYPE *SetRotation )( + IDXGISwapChain2 * This, + /* [annotation][in] */ + _In_ DXGI_MODE_ROTATION Rotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRotation) + HRESULT ( STDMETHODCALLTYPE *GetRotation )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_MODE_ROTATION *pRotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetSourceSize) + HRESULT ( STDMETHODCALLTYPE *SetSourceSize )( + IDXGISwapChain2 * This, + UINT Width, + UINT Height); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetSourceSize) + HRESULT ( STDMETHODCALLTYPE *GetSourceSize )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGISwapChain2 * This, + UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetFrameLatencyWaitableObject) + HANDLE ( STDMETHODCALLTYPE *GetFrameLatencyWaitableObject )( + IDXGISwapChain2 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *SetMatrixTransform )( + IDXGISwapChain2 * This, + const DXGI_MATRIX_3X2_F *pMatrix); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *GetMatrixTransform )( + IDXGISwapChain2 * This, + /* [annotation][out] */ + _Out_ DXGI_MATRIX_3X2_F *pMatrix); + + END_INTERFACE + } IDXGISwapChain2Vtbl; + + interface IDXGISwapChain2 + { + CONST_VTBL struct IDXGISwapChain2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChain2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChain2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChain2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChain2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISwapChain2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISwapChain2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISwapChain2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISwapChain2_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISwapChain2_Present(This,SyncInterval,Flags) \ + ( (This)->lpVtbl -> Present(This,SyncInterval,Flags) ) + +#define IDXGISwapChain2_GetBuffer(This,Buffer,riid,ppSurface) \ + ( (This)->lpVtbl -> GetBuffer(This,Buffer,riid,ppSurface) ) + +#define IDXGISwapChain2_SetFullscreenState(This,Fullscreen,pTarget) \ + ( (This)->lpVtbl -> SetFullscreenState(This,Fullscreen,pTarget) ) + +#define IDXGISwapChain2_GetFullscreenState(This,pFullscreen,ppTarget) \ + ( (This)->lpVtbl -> GetFullscreenState(This,pFullscreen,ppTarget) ) + +#define IDXGISwapChain2_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISwapChain2_ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) \ + ( (This)->lpVtbl -> ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) ) + +#define IDXGISwapChain2_ResizeTarget(This,pNewTargetParameters) \ + ( (This)->lpVtbl -> ResizeTarget(This,pNewTargetParameters) ) + +#define IDXGISwapChain2_GetContainingOutput(This,ppOutput) \ + ( (This)->lpVtbl -> GetContainingOutput(This,ppOutput) ) + +#define IDXGISwapChain2_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#define IDXGISwapChain2_GetLastPresentCount(This,pLastPresentCount) \ + ( (This)->lpVtbl -> GetLastPresentCount(This,pLastPresentCount) ) + + +#define IDXGISwapChain2_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#define IDXGISwapChain2_GetFullscreenDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetFullscreenDesc(This,pDesc) ) + +#define IDXGISwapChain2_GetHwnd(This,pHwnd) \ + ( (This)->lpVtbl -> GetHwnd(This,pHwnd) ) + +#define IDXGISwapChain2_GetCoreWindow(This,refiid,ppUnk) \ + ( (This)->lpVtbl -> GetCoreWindow(This,refiid,ppUnk) ) + +#define IDXGISwapChain2_Present1(This,SyncInterval,PresentFlags,pPresentParameters) \ + ( (This)->lpVtbl -> Present1(This,SyncInterval,PresentFlags,pPresentParameters) ) + +#define IDXGISwapChain2_IsTemporaryMonoSupported(This) \ + ( (This)->lpVtbl -> IsTemporaryMonoSupported(This) ) + +#define IDXGISwapChain2_GetRestrictToOutput(This,ppRestrictToOutput) \ + ( (This)->lpVtbl -> GetRestrictToOutput(This,ppRestrictToOutput) ) + +#define IDXGISwapChain2_SetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> SetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain2_GetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> GetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain2_SetRotation(This,Rotation) \ + ( (This)->lpVtbl -> SetRotation(This,Rotation) ) + +#define IDXGISwapChain2_GetRotation(This,pRotation) \ + ( (This)->lpVtbl -> GetRotation(This,pRotation) ) + + +#define IDXGISwapChain2_SetSourceSize(This,Width,Height) \ + ( (This)->lpVtbl -> SetSourceSize(This,Width,Height) ) + +#define IDXGISwapChain2_GetSourceSize(This,pWidth,pHeight) \ + ( (This)->lpVtbl -> GetSourceSize(This,pWidth,pHeight) ) + +#define IDXGISwapChain2_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGISwapChain2_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + +#define IDXGISwapChain2_GetFrameLatencyWaitableObject(This) \ + ( (This)->lpVtbl -> GetFrameLatencyWaitableObject(This) ) + +#define IDXGISwapChain2_SetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> SetMatrixTransform(This,pMatrix) ) + +#define IDXGISwapChain2_GetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> GetMatrixTransform(This,pMatrix) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChain2_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIOutput2_INTERFACE_DEFINED__ +#define __IDXGIOutput2_INTERFACE_DEFINED__ + +/* interface IDXGIOutput2 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput2; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("595e39d1-2724-4663-99b1-da969de28364") + IDXGIOutput2 : public IDXGIOutput1 + { + public: + virtual BOOL STDMETHODCALLTYPE SupportsOverlays( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput2Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput2 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput2 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput2 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput2 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput2 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput2 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput2 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput2 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput2 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput2 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput2 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput2 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput2, SupportsOverlays) + BOOL ( STDMETHODCALLTYPE *SupportsOverlays )( + IDXGIOutput2 * This); + + END_INTERFACE + } IDXGIOutput2Vtbl; + + interface IDXGIOutput2 + { + CONST_VTBL struct IDXGIOutput2Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput2_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput2_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput2_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput2_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput2_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput2_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput2_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput2_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput2_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput2_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput2_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput2_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput2_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput2_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput2_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput2_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput2_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput2_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput2_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput2_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput2_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput2_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput2_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + + +#define IDXGIOutput2_SupportsOverlays(This) \ + ( (This)->lpVtbl -> SupportsOverlays(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput2_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIFactory3_INTERFACE_DEFINED__ +#define __IDXGIFactory3_INTERFACE_DEFINED__ + +/* interface IDXGIFactory3 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory3; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("25483823-cd46-4c7d-86ca-47aa95b837bd") + IDXGIFactory3 : public IDXGIFactory2 + { + public: + virtual UINT STDMETHODCALLTYPE GetCreationFlags( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory3Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory3 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory3 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory3 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory3 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory3 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory3 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory3 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory3 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory3 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory3 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory3 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory3, GetCreationFlags) + UINT ( STDMETHODCALLTYPE *GetCreationFlags )( + IDXGIFactory3 * This); + + END_INTERFACE + } IDXGIFactory3Vtbl; + + interface IDXGIFactory3 + { + CONST_VTBL struct IDXGIFactory3Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory3_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory3_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory3_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory3_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory3_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory3_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory3_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory3_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory3_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory3_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory3_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory3_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory3_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory3_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory3_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory3_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory3_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory3_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory3_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory3_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory3_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory3_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory3_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory3_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory3_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + + +#define IDXGIFactory3_GetCreationFlags(This) \ + ( (This)->lpVtbl -> GetCreationFlags(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory3_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_3_0000_0004 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) +typedef struct DXGI_DECODE_SWAP_CHAIN_DESC + { + UINT Flags; + } DXGI_DECODE_SWAP_CHAIN_DESC; + +typedef +enum DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS + { + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_NOMINAL_RANGE = 0x1, + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_BT709 = 0x2, + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_xvYCC = 0x4 + } DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0004_v0_0_s_ifspec; + +#ifndef __IDXGIDecodeSwapChain_INTERFACE_DEFINED__ +#define __IDXGIDecodeSwapChain_INTERFACE_DEFINED__ + +/* interface IDXGIDecodeSwapChain */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDecodeSwapChain; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("2633066b-4514-4c7a-8fd8-12ea98059d18") + IDXGIDecodeSwapChain : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE PresentBuffer( + UINT BufferToPresent, + UINT SyncInterval, + UINT Flags) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetSourceRect( + const RECT *pRect) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetTargetRect( + const RECT *pRect) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetDestSize( + UINT Width, + UINT Height) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetSourceRect( + /* [annotation][out] */ + _Out_ RECT *pRect) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetTargetRect( + /* [annotation][out] */ + _Out_ RECT *pRect) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDestSize( + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetColorSpace( + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS ColorSpace) = 0; + + virtual DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS STDMETHODCALLTYPE GetColorSpace( void) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDecodeSwapChainVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDecodeSwapChain * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDecodeSwapChain * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDecodeSwapChain * This); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, PresentBuffer) + HRESULT ( STDMETHODCALLTYPE *PresentBuffer )( + IDXGIDecodeSwapChain * This, + UINT BufferToPresent, + UINT SyncInterval, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, SetSourceRect) + HRESULT ( STDMETHODCALLTYPE *SetSourceRect )( + IDXGIDecodeSwapChain * This, + const RECT *pRect); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, SetTargetRect) + HRESULT ( STDMETHODCALLTYPE *SetTargetRect )( + IDXGIDecodeSwapChain * This, + const RECT *pRect); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, SetDestSize) + HRESULT ( STDMETHODCALLTYPE *SetDestSize )( + IDXGIDecodeSwapChain * This, + UINT Width, + UINT Height); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, GetSourceRect) + HRESULT ( STDMETHODCALLTYPE *GetSourceRect )( + IDXGIDecodeSwapChain * This, + /* [annotation][out] */ + _Out_ RECT *pRect); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, GetTargetRect) + HRESULT ( STDMETHODCALLTYPE *GetTargetRect )( + IDXGIDecodeSwapChain * This, + /* [annotation][out] */ + _Out_ RECT *pRect); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, GetDestSize) + HRESULT ( STDMETHODCALLTYPE *GetDestSize )( + IDXGIDecodeSwapChain * This, + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, SetColorSpace) + HRESULT ( STDMETHODCALLTYPE *SetColorSpace )( + IDXGIDecodeSwapChain * This, + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS ColorSpace); + + DECLSPEC_XFGVIRT(IDXGIDecodeSwapChain, GetColorSpace) + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS ( STDMETHODCALLTYPE *GetColorSpace )( + IDXGIDecodeSwapChain * This); + + END_INTERFACE + } IDXGIDecodeSwapChainVtbl; + + interface IDXGIDecodeSwapChain + { + CONST_VTBL struct IDXGIDecodeSwapChainVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDecodeSwapChain_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDecodeSwapChain_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDecodeSwapChain_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDecodeSwapChain_PresentBuffer(This,BufferToPresent,SyncInterval,Flags) \ + ( (This)->lpVtbl -> PresentBuffer(This,BufferToPresent,SyncInterval,Flags) ) + +#define IDXGIDecodeSwapChain_SetSourceRect(This,pRect) \ + ( (This)->lpVtbl -> SetSourceRect(This,pRect) ) + +#define IDXGIDecodeSwapChain_SetTargetRect(This,pRect) \ + ( (This)->lpVtbl -> SetTargetRect(This,pRect) ) + +#define IDXGIDecodeSwapChain_SetDestSize(This,Width,Height) \ + ( (This)->lpVtbl -> SetDestSize(This,Width,Height) ) + +#define IDXGIDecodeSwapChain_GetSourceRect(This,pRect) \ + ( (This)->lpVtbl -> GetSourceRect(This,pRect) ) + +#define IDXGIDecodeSwapChain_GetTargetRect(This,pRect) \ + ( (This)->lpVtbl -> GetTargetRect(This,pRect) ) + +#define IDXGIDecodeSwapChain_GetDestSize(This,pWidth,pHeight) \ + ( (This)->lpVtbl -> GetDestSize(This,pWidth,pHeight) ) + +#define IDXGIDecodeSwapChain_SetColorSpace(This,ColorSpace) \ + ( (This)->lpVtbl -> SetColorSpace(This,ColorSpace) ) + +#define IDXGIDecodeSwapChain_GetColorSpace(This) \ + ( (This)->lpVtbl -> GetColorSpace(This) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDecodeSwapChain_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIFactoryMedia_INTERFACE_DEFINED__ +#define __IDXGIFactoryMedia_INTERFACE_DEFINED__ + +/* interface IDXGIFactoryMedia */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactoryMedia; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("41e7d1f2-a591-4f7b-a2e5-fa9c843e1c12") + IDXGIFactoryMedia : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE CreateSwapChainForCompositionSurfaceHandle( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_opt_ HANDLE hSurface, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain) = 0; + + virtual HRESULT STDMETHODCALLTYPE CreateDecodeSwapChainForCompositionSurfaceHandle( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_opt_ HANDLE hSurface, + /* [annotation][in] */ + _In_ DXGI_DECODE_SWAP_CHAIN_DESC *pDesc, + /* [annotation][in] */ + _In_ IDXGIResource *pYuvDecodeBuffers, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGIDecodeSwapChain **ppSwapChain) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactoryMediaVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactoryMedia * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactoryMedia * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactoryMedia * This); + + DECLSPEC_XFGVIRT(IDXGIFactoryMedia, CreateSwapChainForCompositionSurfaceHandle) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCompositionSurfaceHandle )( + IDXGIFactoryMedia * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_opt_ HANDLE hSurface, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactoryMedia, CreateDecodeSwapChainForCompositionSurfaceHandle) + HRESULT ( STDMETHODCALLTYPE *CreateDecodeSwapChainForCompositionSurfaceHandle )( + IDXGIFactoryMedia * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_opt_ HANDLE hSurface, + /* [annotation][in] */ + _In_ DXGI_DECODE_SWAP_CHAIN_DESC *pDesc, + /* [annotation][in] */ + _In_ IDXGIResource *pYuvDecodeBuffers, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGIDecodeSwapChain **ppSwapChain); + + END_INTERFACE + } IDXGIFactoryMediaVtbl; + + interface IDXGIFactoryMedia + { + CONST_VTBL struct IDXGIFactoryMediaVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactoryMedia_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactoryMedia_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactoryMedia_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactoryMedia_CreateSwapChainForCompositionSurfaceHandle(This,pDevice,hSurface,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCompositionSurfaceHandle(This,pDevice,hSurface,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactoryMedia_CreateDecodeSwapChainForCompositionSurfaceHandle(This,pDevice,hSurface,pDesc,pYuvDecodeBuffers,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateDecodeSwapChainForCompositionSurfaceHandle(This,pDevice,hSurface,pDesc,pYuvDecodeBuffers,pRestrictToOutput,ppSwapChain) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactoryMedia_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_3_0000_0006 */ +/* [local] */ + +typedef +enum DXGI_FRAME_PRESENTATION_MODE + { + DXGI_FRAME_PRESENTATION_MODE_COMPOSED = 0, + DXGI_FRAME_PRESENTATION_MODE_OVERLAY = 1, + DXGI_FRAME_PRESENTATION_MODE_NONE = 2, + DXGI_FRAME_PRESENTATION_MODE_COMPOSITION_FAILURE = 3 + } DXGI_FRAME_PRESENTATION_MODE; + +typedef struct DXGI_FRAME_STATISTICS_MEDIA + { + UINT PresentCount; + UINT PresentRefreshCount; + UINT SyncRefreshCount; + LARGE_INTEGER SyncQPCTime; + LARGE_INTEGER SyncGPUTime; + DXGI_FRAME_PRESENTATION_MODE CompositionMode; + UINT ApprovedPresentDuration; + } DXGI_FRAME_STATISTICS_MEDIA; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0006_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0006_v0_0_s_ifspec; + +#ifndef __IDXGISwapChainMedia_INTERFACE_DEFINED__ +#define __IDXGISwapChainMedia_INTERFACE_DEFINED__ + +/* interface IDXGISwapChainMedia */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChainMedia; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("dd95b90b-f05f-4f6a-bd65-25bfb264bd84") + IDXGISwapChainMedia : public IUnknown + { + public: + virtual HRESULT STDMETHODCALLTYPE GetFrameStatisticsMedia( + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS_MEDIA *pStats) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetPresentDuration( + UINT Duration) = 0; + + virtual HRESULT STDMETHODCALLTYPE CheckPresentDurationSupport( + UINT DesiredPresentDuration, + /* [annotation][out] */ + _Out_ UINT *pClosestSmallerPresentDuration, + /* [annotation][out] */ + _Out_ UINT *pClosestLargerPresentDuration) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChainMediaVtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChainMedia * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChainMedia * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChainMedia * This); + + DECLSPEC_XFGVIRT(IDXGISwapChainMedia, GetFrameStatisticsMedia) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatisticsMedia )( + IDXGISwapChainMedia * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS_MEDIA *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChainMedia, SetPresentDuration) + HRESULT ( STDMETHODCALLTYPE *SetPresentDuration )( + IDXGISwapChainMedia * This, + UINT Duration); + + DECLSPEC_XFGVIRT(IDXGISwapChainMedia, CheckPresentDurationSupport) + HRESULT ( STDMETHODCALLTYPE *CheckPresentDurationSupport )( + IDXGISwapChainMedia * This, + UINT DesiredPresentDuration, + /* [annotation][out] */ + _Out_ UINT *pClosestSmallerPresentDuration, + /* [annotation][out] */ + _Out_ UINT *pClosestLargerPresentDuration); + + END_INTERFACE + } IDXGISwapChainMediaVtbl; + + interface IDXGISwapChainMedia + { + CONST_VTBL struct IDXGISwapChainMediaVtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChainMedia_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChainMedia_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChainMedia_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChainMedia_GetFrameStatisticsMedia(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatisticsMedia(This,pStats) ) + +#define IDXGISwapChainMedia_SetPresentDuration(This,Duration) \ + ( (This)->lpVtbl -> SetPresentDuration(This,Duration) ) + +#define IDXGISwapChainMedia_CheckPresentDurationSupport(This,DesiredPresentDuration,pClosestSmallerPresentDuration,pClosestLargerPresentDuration) \ + ( (This)->lpVtbl -> CheckPresentDurationSupport(This,DesiredPresentDuration,pClosestSmallerPresentDuration,pClosestLargerPresentDuration) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChainMedia_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_3_0000_0007 */ +/* [local] */ + +typedef +enum DXGI_OVERLAY_SUPPORT_FLAG + { + DXGI_OVERLAY_SUPPORT_FLAG_DIRECT = 0x1, + DXGI_OVERLAY_SUPPORT_FLAG_SCALING = 0x2 + } DXGI_OVERLAY_SUPPORT_FLAG; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0007_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0007_v0_0_s_ifspec; + +#ifndef __IDXGIOutput3_INTERFACE_DEFINED__ +#define __IDXGIOutput3_INTERFACE_DEFINED__ + +/* interface IDXGIOutput3 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput3; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("8a6bb301-7e7e-41F4-a8e0-5b32f7f99b18") + IDXGIOutput3 : public IDXGIOutput2 + { + public: + virtual HRESULT STDMETHODCALLTYPE CheckOverlaySupport( + /* [annotation][in] */ + _In_ DXGI_FORMAT EnumFormat, + /* [annotation][out] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput3Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput3 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput3 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput3 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput3 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput3 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput3 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput3 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput3 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput3 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput3 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput3 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput2, SupportsOverlays) + BOOL ( STDMETHODCALLTYPE *SupportsOverlays )( + IDXGIOutput3 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput3, CheckOverlaySupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlaySupport )( + IDXGIOutput3 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT EnumFormat, + /* [annotation][out] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + END_INTERFACE + } IDXGIOutput3Vtbl; + + interface IDXGIOutput3 + { + CONST_VTBL struct IDXGIOutput3Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput3_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput3_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput3_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput3_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput3_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput3_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput3_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput3_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput3_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput3_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput3_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput3_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput3_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput3_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput3_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput3_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput3_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput3_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput3_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput3_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput3_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput3_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput3_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + + +#define IDXGIOutput3_SupportsOverlays(This) \ + ( (This)->lpVtbl -> SupportsOverlays(This) ) + + +#define IDXGIOutput3_CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput3_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_3_0000_0008 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +DEFINE_GUID(IID_IDXGIDevice3,0x6007896c,0x3244,0x4afd,0xbf,0x18,0xa6,0xd3,0xbe,0xda,0x50,0x23); +DEFINE_GUID(IID_IDXGISwapChain2,0xa8be2ac4,0x199f,0x4946,0xb3,0x31,0x79,0x59,0x9f,0xb9,0x8d,0xe7); +DEFINE_GUID(IID_IDXGIOutput2,0x595e39d1,0x2724,0x4663,0x99,0xb1,0xda,0x96,0x9d,0xe2,0x83,0x64); +DEFINE_GUID(IID_IDXGIFactory3,0x25483823,0xcd46,0x4c7d,0x86,0xca,0x47,0xaa,0x95,0xb8,0x37,0xbd); +DEFINE_GUID(IID_IDXGIDecodeSwapChain,0x2633066b,0x4514,0x4c7a,0x8f,0xd8,0x12,0xea,0x98,0x05,0x9d,0x18); +DEFINE_GUID(IID_IDXGIFactoryMedia,0x41e7d1f2,0xa591,0x4f7b,0xa2,0xe5,0xfa,0x9c,0x84,0x3e,0x1c,0x12); +DEFINE_GUID(IID_IDXGISwapChainMedia,0xdd95b90b,0xf05f,0x4f6a,0xbd,0x65,0x25,0xbf,0xb2,0x64,0xbd,0x84); +DEFINE_GUID(IID_IDXGIOutput3,0x8a6bb301,0x7e7e,0x41F4,0xa8,0xe0,0x5b,0x32,0xf7,0xf9,0x9b,0x18); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0008_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_3_0000_0008_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.idl new file mode 100644 index 0000000000000000000000000000000000000000..06b176bc8735ab27be5fdcb3c732e0aabf921ebf --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_3.idl @@ -0,0 +1,260 @@ +// Copyright (c) Microsoft Corporation. All Rights Reserved + +import "dxgi1_2.idl"; + +cpp_quote("#include ") + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") + +cpp_quote( "#define DXGI_CREATE_FACTORY_DEBUG 0x1") +cpp_quote( "HRESULT WINAPI CreateDXGIFactory2(UINT Flags, REFIID riid, _COM_Outptr_ void **ppFactory);" ) +cpp_quote( "HRESULT WINAPI DXGIGetDebugInterface1(UINT Flags, REFIID riid, _COM_Outptr_ void **pDebug);" ) + +//-------------------------------------------------------------------------------------------------------- +// IDXGIDevice3 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 6007896c-3244-4afd-bf18-a6d3beda5023 ), + local, + pointer_default(unique) +] +interface IDXGIDevice3 : + IDXGIDevice2 +{ + void Trim(); +}; + +//+----------------------------------------------------------------------------- +// +// Struct: +// DXGI_MATRIX_3X2_F +// +//------------------------------------------------------------------------------ +typedef struct DXGI_MATRIX_3X2_F +{ + FLOAT _11; + FLOAT _12; + FLOAT _21; + FLOAT _22; + FLOAT _31; + FLOAT _32; +} DXGI_MATRIX_3X2_F; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapChain2 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( a8be2ac4-199f-4946-b331-79599fb98de7 ), + local, + pointer_default(unique) +] +interface IDXGISwapChain2 : + IDXGISwapChain1 +{ + HRESULT SetSourceSize( UINT Width, UINT Height ); + HRESULT GetSourceSize( [out, annotation("_Out_")] UINT *pWidth, + [out, annotation("_Out_")] UINT *pHeight ); + HRESULT SetMaximumFrameLatency(UINT MaxLatency); + HRESULT GetMaximumFrameLatency( [out, annotation("_Out_")] UINT *pMaxLatency); + HANDLE GetFrameLatencyWaitableObject(); + HRESULT SetMatrixTransform(const DXGI_MATRIX_3X2_F *pMatrix); + HRESULT GetMatrixTransform( [out, annotation("_Out_")] DXGI_MATRIX_3X2_F *pMatrix); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput2 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 595e39d1-2724-4663-99b1-da969de28364 ), + local, + pointer_default(unique) +] +interface IDXGIOutput2 : + IDXGIOutput1 +{ + BOOL SupportsOverlays(); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory3 interface +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 25483823-cd46-4c7d-86ca-47aa95b837bd ), + local, + pointer_default(unique) +] +interface IDXGIFactory3 : + IDXGIFactory2 +{ + UINT GetCreationFlags(); +}; + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)") + +//+----------------------------------------------------------------------------- +// +// Struct: DXGI_DECODE_SWAP_CHAIN_DESC +// +//------------------------------------------------------------------------------ +typedef struct DXGI_DECODE_SWAP_CHAIN_DESC +{ + UINT Flags; +} DXGI_DECODE_SWAP_CHAIN_DESC; + +//+----------------------------------------------------------------------------- +// +// Flags: DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS +// +//------------------------------------------------------------------------------ +typedef enum DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS +{ + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_NOMINAL_RANGE = 0x1, // 16 - 235 vs. 0 - 255 + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_BT709 = 0x2, // BT.709 vs. BT.601 + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAG_xvYCC = 0x4, // xvYCC vs. conventional YCbCr +} DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIDecodeSwapChain interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 2633066b-4514-4c7a-8fd8-12ea98059d18 ), + local, + pointer_default(unique) +] +interface IDXGIDecodeSwapChain : + IUnknown +{ + HRESULT PresentBuffer(UINT BufferToPresent, UINT SyncInterval, UINT Flags); + + HRESULT SetSourceRect(const RECT *pRect); // ID3D11VideoContext::VideoProcessorSetStreamSourceRect + HRESULT SetTargetRect(const RECT *pRect); // ID3D11VideoContext::VideoProcessorSetOutputTargetRect + HRESULT SetDestSize(UINT Width, UINT Height); // ID3D11VideoContext::VideoProcessorSetStreamDestRect + + HRESULT GetSourceRect([out, annotation("_Out_")] RECT *pRect); + HRESULT GetTargetRect([out, annotation("_Out_")] RECT *pRect); + HRESULT GetDestSize([out, annotation("_Out_")] UINT *pWidth, [out, annotation("_Out_")] UINT *pHeight); + + // Set and get color space + HRESULT SetColorSpace(DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS ColorSpace); + DXGI_MULTIPLANE_OVERLAY_YCbCr_FLAGS GetColorSpace(); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactoryMedia interface +//-------------------------------------------------------------------------------------------------------- + +[ + object, + uuid( 41e7d1f2-a591-4f7b-a2e5-fa9c843e1c12 ), + local, + pointer_default(unique) +] +interface IDXGIFactoryMedia : + IUnknown +{ + HRESULT CreateSwapChainForCompositionSurfaceHandle( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_opt_")] HANDLE hSurface, + [in, annotation("_In_")] const DXGI_SWAP_CHAIN_DESC1 *pDesc, + [in, annotation("_In_opt_")] IDXGIOutput *pRestrictToOutput, + [out, annotation("_COM_Outptr_")] IDXGISwapChain1 **ppSwapChain ); + + HRESULT CreateDecodeSwapChainForCompositionSurfaceHandle( + [in, annotation("_In_")] IUnknown *pDevice, + [in, annotation("_In_opt_")] HANDLE hSurface, + [in, annotation("_In_")] DXGI_DECODE_SWAP_CHAIN_DESC *pDesc, + [in, annotation("_In_")] IDXGIResource *pYuvDecodeBuffers, + [in, annotation("_In_opt_")] IDXGIOutput *pRestrictToOutput, + [out, annotation("_COM_Outptr_")] IDXGIDecodeSwapChain **ppSwapChain ); +}; + +//+----------------------------------------------------------------------------- +// +// Struct: DXGI_FRAME_PRESENTATION_MODE & DXGI_FRAME_STATISTICS_MEDIA +// +//------------------------------------------------------------------------------ +typedef enum DXGI_FRAME_PRESENTATION_MODE +{ + DXGI_FRAME_PRESENTATION_MODE_COMPOSED = 0, + DXGI_FRAME_PRESENTATION_MODE_OVERLAY = 1, + DXGI_FRAME_PRESENTATION_MODE_NONE = 2, + DXGI_FRAME_PRESENTATION_MODE_COMPOSITION_FAILURE = 3, +} DXGI_FRAME_PRESENTATION_MODE; + +typedef struct DXGI_FRAME_STATISTICS_MEDIA +{ + UINT PresentCount; + UINT PresentRefreshCount; + UINT SyncRefreshCount; + LARGE_INTEGER SyncQPCTime; + LARGE_INTEGER SyncGPUTime; + DXGI_FRAME_PRESENTATION_MODE CompositionMode; + UINT ApprovedPresentDuration; +} DXGI_FRAME_STATISTICS_MEDIA; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapChainMedia interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( dd95b90b-f05f-4f6a-bd65-25bfb264bd84 ), + local, + pointer_default(unique) +] +interface IDXGISwapChainMedia : + IUnknown +{ + HRESULT GetFrameStatisticsMedia([out, annotation("_Out_")] DXGI_FRAME_STATISTICS_MEDIA *pStats); + HRESULT SetPresentDuration(UINT Duration); + HRESULT CheckPresentDurationSupport(UINT DesiredPresentDuration, [out, annotation("_Out_")] UINT *pClosestSmallerPresentDuration, [out, annotation("_Out_")] UINT *pClosestLargerPresentDuration); +}; + +typedef enum DXGI_OVERLAY_SUPPORT_FLAG +{ + DXGI_OVERLAY_SUPPORT_FLAG_DIRECT = 0x1, + DXGI_OVERLAY_SUPPORT_FLAG_SCALING = 0x2 +} DXGI_OVERLAY_SUPPORT_FLAG; + + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */") +#pragma endregion + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput3 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 8a6bb301-7e7e-41F4-a8e0-5b32f7f99b18 ), + local, + pointer_default(unique) +] +interface IDXGIOutput3 : + IDXGIOutput2 +{ + HRESULT CheckOverlaySupport( [in, annotation("_In_")] DXGI_FORMAT EnumFormat, [out, annotation("_In_")] IUnknown *pConcernedDevice, [out, annotation("_Out_")] UINT *pFlags ); +}; + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +cpp_quote( "DEFINE_GUID(IID_IDXGIDevice3,0x6007896c,0x3244,0x4afd,0xbf,0x18,0xa6,0xd3,0xbe,0xda,0x50,0x23);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChain2,0xa8be2ac4,0x199f,0x4946,0xb3,0x31,0x79,0x59,0x9f,0xb9,0x8d,0xe7);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput2,0x595e39d1,0x2724,0x4663,0x99,0xb1,0xda,0x96,0x9d,0xe2,0x83,0x64);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory3,0x25483823,0xcd46,0x4c7d,0x86,0xca,0x47,0xaa,0x95,0xb8,0x37,0xbd);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDecodeSwapChain,0x2633066b,0x4514,0x4c7a,0x8f,0xd8,0x12,0xea,0x98,0x05,0x9d,0x18);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactoryMedia,0x41e7d1f2,0xa591,0x4f7b,0xa2,0xe5,0xfa,0x9c,0x84,0x3e,0x1c,0x12);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChainMedia,0xdd95b90b,0xf05f,0x4f6a,0xbd,0x65,0x25,0xbf,0xb2,0x64,0xbd,0x84);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput3,0x8a6bb301,0x7e7e,0x41F4,0xa8,0xe0,0x5b,0x32,0xf7,0xf9,0x9b,0x18);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.h new file mode 100644 index 0000000000000000000000000000000000000000..4937abcf9be8d5d697e0d22b539cdbc138141ad6 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.h @@ -0,0 +1,1614 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi1_4_h__ +#define __dxgi1_4_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGISwapChain3_FWD_DEFINED__ +#define __IDXGISwapChain3_FWD_DEFINED__ +typedef interface IDXGISwapChain3 IDXGISwapChain3; + +#endif /* __IDXGISwapChain3_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput4_FWD_DEFINED__ +#define __IDXGIOutput4_FWD_DEFINED__ +typedef interface IDXGIOutput4 IDXGIOutput4; + +#endif /* __IDXGIOutput4_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory4_FWD_DEFINED__ +#define __IDXGIFactory4_FWD_DEFINED__ +typedef interface IDXGIFactory4 IDXGIFactory4; + +#endif /* __IDXGIFactory4_FWD_DEFINED__ */ + + +#ifndef __IDXGIAdapter3_FWD_DEFINED__ +#define __IDXGIAdapter3_FWD_DEFINED__ +typedef interface IDXGIAdapter3 IDXGIAdapter3; + +#endif /* __IDXGIAdapter3_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "dxgi1_3.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi1_4_0000_0000 */ +/* [local] */ + +#include +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) +typedef +enum DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG + { + DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG_PRESENT = 0x1, + DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG_OVERLAY_PRESENT = 0x2 + } DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGISwapChain3_INTERFACE_DEFINED__ +#define __IDXGISwapChain3_INTERFACE_DEFINED__ + +/* interface IDXGISwapChain3 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChain3; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("94d99bdb-f1f8-4ab0-b236-7da0170edab1") + IDXGISwapChain3 : public IDXGISwapChain2 + { + public: + virtual UINT STDMETHODCALLTYPE GetCurrentBackBufferIndex( void) = 0; + + virtual HRESULT STDMETHODCALLTYPE CheckColorSpaceSupport( + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][out] */ + _Out_ UINT *pColorSpaceSupport) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetColorSpace1( + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace) = 0; + + virtual HRESULT STDMETHODCALLTYPE ResizeBuffers1( + /* [annotation][in] */ + _In_ UINT BufferCount, + /* [annotation][in] */ + _In_ UINT Width, + /* [annotation][in] */ + _In_ UINT Height, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ UINT SwapChainFlags, + /* [annotation][in] */ + _In_reads_(BufferCount) const UINT *pCreationNodeMask, + /* [annotation][in] */ + _In_reads_(BufferCount) IUnknown *const *ppPresentQueue) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChain3Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChain3 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChain3 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChain3 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISwapChain, Present) + HRESULT ( STDMETHODCALLTYPE *Present )( + IDXGISwapChain3 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetBuffer) + HRESULT ( STDMETHODCALLTYPE *GetBuffer )( + IDXGISwapChain3 * This, + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface); + + DECLSPEC_XFGVIRT(IDXGISwapChain, SetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *SetFullscreenState )( + IDXGISwapChain3 * This, + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenState )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeBuffers) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers )( + IDXGISwapChain3 * This, + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeTarget) + HRESULT ( STDMETHODCALLTYPE *ResizeTarget )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetContainingOutput) + HRESULT ( STDMETHODCALLTYPE *GetContainingOutput )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetLastPresentCount) + HRESULT ( STDMETHODCALLTYPE *GetLastPresentCount )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetFullscreenDesc) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenDesc )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetHwnd) + HRESULT ( STDMETHODCALLTYPE *GetHwnd )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ HWND *pHwnd); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetCoreWindow) + HRESULT ( STDMETHODCALLTYPE *GetCoreWindow )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ REFIID refiid, + /* [annotation][out] */ + _COM_Outptr_ void **ppUnk); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, Present1) + HRESULT ( STDMETHODCALLTYPE *Present1 )( + IDXGISwapChain3 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT PresentFlags, + /* [annotation][in] */ + _In_ const DXGI_PRESENT_PARAMETERS *pPresentParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, IsTemporaryMonoSupported) + BOOL ( STDMETHODCALLTYPE *IsTemporaryMonoSupported )( + IDXGISwapChain3 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRestrictToOutput) + HRESULT ( STDMETHODCALLTYPE *GetRestrictToOutput )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ IDXGIOutput **ppRestrictToOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *SetBackgroundColor )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ const DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *GetBackgroundColor )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetRotation) + HRESULT ( STDMETHODCALLTYPE *SetRotation )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ DXGI_MODE_ROTATION Rotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRotation) + HRESULT ( STDMETHODCALLTYPE *GetRotation )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_MODE_ROTATION *pRotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetSourceSize) + HRESULT ( STDMETHODCALLTYPE *SetSourceSize )( + IDXGISwapChain3 * This, + UINT Width, + UINT Height); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetSourceSize) + HRESULT ( STDMETHODCALLTYPE *GetSourceSize )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGISwapChain3 * This, + UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetFrameLatencyWaitableObject) + HANDLE ( STDMETHODCALLTYPE *GetFrameLatencyWaitableObject )( + IDXGISwapChain3 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *SetMatrixTransform )( + IDXGISwapChain3 * This, + const DXGI_MATRIX_3X2_F *pMatrix); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *GetMatrixTransform )( + IDXGISwapChain3 * This, + /* [annotation][out] */ + _Out_ DXGI_MATRIX_3X2_F *pMatrix); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, GetCurrentBackBufferIndex) + UINT ( STDMETHODCALLTYPE *GetCurrentBackBufferIndex )( + IDXGISwapChain3 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, CheckColorSpaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckColorSpaceSupport )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][out] */ + _Out_ UINT *pColorSpaceSupport); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, SetColorSpace1) + HRESULT ( STDMETHODCALLTYPE *SetColorSpace1 )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, ResizeBuffers1) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers1 )( + IDXGISwapChain3 * This, + /* [annotation][in] */ + _In_ UINT BufferCount, + /* [annotation][in] */ + _In_ UINT Width, + /* [annotation][in] */ + _In_ UINT Height, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ UINT SwapChainFlags, + /* [annotation][in] */ + _In_reads_(BufferCount) const UINT *pCreationNodeMask, + /* [annotation][in] */ + _In_reads_(BufferCount) IUnknown *const *ppPresentQueue); + + END_INTERFACE + } IDXGISwapChain3Vtbl; + + interface IDXGISwapChain3 + { + CONST_VTBL struct IDXGISwapChain3Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChain3_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChain3_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChain3_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChain3_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISwapChain3_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISwapChain3_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISwapChain3_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISwapChain3_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISwapChain3_Present(This,SyncInterval,Flags) \ + ( (This)->lpVtbl -> Present(This,SyncInterval,Flags) ) + +#define IDXGISwapChain3_GetBuffer(This,Buffer,riid,ppSurface) \ + ( (This)->lpVtbl -> GetBuffer(This,Buffer,riid,ppSurface) ) + +#define IDXGISwapChain3_SetFullscreenState(This,Fullscreen,pTarget) \ + ( (This)->lpVtbl -> SetFullscreenState(This,Fullscreen,pTarget) ) + +#define IDXGISwapChain3_GetFullscreenState(This,pFullscreen,ppTarget) \ + ( (This)->lpVtbl -> GetFullscreenState(This,pFullscreen,ppTarget) ) + +#define IDXGISwapChain3_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISwapChain3_ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) \ + ( (This)->lpVtbl -> ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) ) + +#define IDXGISwapChain3_ResizeTarget(This,pNewTargetParameters) \ + ( (This)->lpVtbl -> ResizeTarget(This,pNewTargetParameters) ) + +#define IDXGISwapChain3_GetContainingOutput(This,ppOutput) \ + ( (This)->lpVtbl -> GetContainingOutput(This,ppOutput) ) + +#define IDXGISwapChain3_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#define IDXGISwapChain3_GetLastPresentCount(This,pLastPresentCount) \ + ( (This)->lpVtbl -> GetLastPresentCount(This,pLastPresentCount) ) + + +#define IDXGISwapChain3_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#define IDXGISwapChain3_GetFullscreenDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetFullscreenDesc(This,pDesc) ) + +#define IDXGISwapChain3_GetHwnd(This,pHwnd) \ + ( (This)->lpVtbl -> GetHwnd(This,pHwnd) ) + +#define IDXGISwapChain3_GetCoreWindow(This,refiid,ppUnk) \ + ( (This)->lpVtbl -> GetCoreWindow(This,refiid,ppUnk) ) + +#define IDXGISwapChain3_Present1(This,SyncInterval,PresentFlags,pPresentParameters) \ + ( (This)->lpVtbl -> Present1(This,SyncInterval,PresentFlags,pPresentParameters) ) + +#define IDXGISwapChain3_IsTemporaryMonoSupported(This) \ + ( (This)->lpVtbl -> IsTemporaryMonoSupported(This) ) + +#define IDXGISwapChain3_GetRestrictToOutput(This,ppRestrictToOutput) \ + ( (This)->lpVtbl -> GetRestrictToOutput(This,ppRestrictToOutput) ) + +#define IDXGISwapChain3_SetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> SetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain3_GetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> GetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain3_SetRotation(This,Rotation) \ + ( (This)->lpVtbl -> SetRotation(This,Rotation) ) + +#define IDXGISwapChain3_GetRotation(This,pRotation) \ + ( (This)->lpVtbl -> GetRotation(This,pRotation) ) + + +#define IDXGISwapChain3_SetSourceSize(This,Width,Height) \ + ( (This)->lpVtbl -> SetSourceSize(This,Width,Height) ) + +#define IDXGISwapChain3_GetSourceSize(This,pWidth,pHeight) \ + ( (This)->lpVtbl -> GetSourceSize(This,pWidth,pHeight) ) + +#define IDXGISwapChain3_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGISwapChain3_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + +#define IDXGISwapChain3_GetFrameLatencyWaitableObject(This) \ + ( (This)->lpVtbl -> GetFrameLatencyWaitableObject(This) ) + +#define IDXGISwapChain3_SetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> SetMatrixTransform(This,pMatrix) ) + +#define IDXGISwapChain3_GetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> GetMatrixTransform(This,pMatrix) ) + + +#define IDXGISwapChain3_GetCurrentBackBufferIndex(This) \ + ( (This)->lpVtbl -> GetCurrentBackBufferIndex(This) ) + +#define IDXGISwapChain3_CheckColorSpaceSupport(This,ColorSpace,pColorSpaceSupport) \ + ( (This)->lpVtbl -> CheckColorSpaceSupport(This,ColorSpace,pColorSpaceSupport) ) + +#define IDXGISwapChain3_SetColorSpace1(This,ColorSpace) \ + ( (This)->lpVtbl -> SetColorSpace1(This,ColorSpace) ) + +#define IDXGISwapChain3_ResizeBuffers1(This,BufferCount,Width,Height,Format,SwapChainFlags,pCreationNodeMask,ppPresentQueue) \ + ( (This)->lpVtbl -> ResizeBuffers1(This,BufferCount,Width,Height,Format,SwapChainFlags,pCreationNodeMask,ppPresentQueue) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChain3_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_4_0000_0001 */ +/* [local] */ + +typedef +enum DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG + { + DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG_PRESENT = 0x1 + } DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0001_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0001_v0_0_s_ifspec; + +#ifndef __IDXGIOutput4_INTERFACE_DEFINED__ +#define __IDXGIOutput4_INTERFACE_DEFINED__ + +/* interface IDXGIOutput4 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput4; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("dc7dca35-2196-414d-9F53-617884032a60") + IDXGIOutput4 : public IDXGIOutput3 + { + public: + virtual HRESULT STDMETHODCALLTYPE CheckOverlayColorSpaceSupport( + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][in] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput4Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput4 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput4 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput4 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput4 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput4 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput4 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput4 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput4 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput4 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput4 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput4 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput2, SupportsOverlays) + BOOL ( STDMETHODCALLTYPE *SupportsOverlays )( + IDXGIOutput4 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput3, CheckOverlaySupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlaySupport )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT EnumFormat, + /* [annotation][out] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + DECLSPEC_XFGVIRT(IDXGIOutput4, CheckOverlayColorSpaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlayColorSpaceSupport )( + IDXGIOutput4 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][in] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + END_INTERFACE + } IDXGIOutput4Vtbl; + + interface IDXGIOutput4 + { + CONST_VTBL struct IDXGIOutput4Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput4_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput4_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput4_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput4_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput4_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput4_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput4_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput4_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput4_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput4_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput4_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput4_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput4_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput4_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput4_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput4_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput4_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput4_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput4_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput4_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput4_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput4_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput4_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + + +#define IDXGIOutput4_SupportsOverlays(This) \ + ( (This)->lpVtbl -> SupportsOverlays(This) ) + + +#define IDXGIOutput4_CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) ) + + +#define IDXGIOutput4_CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput4_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIFactory4_INTERFACE_DEFINED__ +#define __IDXGIFactory4_INTERFACE_DEFINED__ + +/* interface IDXGIFactory4 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory4; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("1bc6ea02-ef36-464f-bf0c-21ca39e5168a") + IDXGIFactory4 : public IDXGIFactory3 + { + public: + virtual HRESULT STDMETHODCALLTYPE EnumAdapterByLuid( + /* [annotation] */ + _In_ LUID AdapterLuid, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter) = 0; + + virtual HRESULT STDMETHODCALLTYPE EnumWarpAdapter( + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory4Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory4 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory4 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory4 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory4 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory4 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory4 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory4 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory4 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory4 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory4 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory4 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory4 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory3, GetCreationFlags) + UINT ( STDMETHODCALLTYPE *GetCreationFlags )( + IDXGIFactory4 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumAdapterByLuid) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByLuid )( + IDXGIFactory4 * This, + /* [annotation] */ + _In_ LUID AdapterLuid, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumWarpAdapter) + HRESULT ( STDMETHODCALLTYPE *EnumWarpAdapter )( + IDXGIFactory4 * This, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + END_INTERFACE + } IDXGIFactory4Vtbl; + + interface IDXGIFactory4 + { + CONST_VTBL struct IDXGIFactory4Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory4_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory4_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory4_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory4_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory4_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory4_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory4_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory4_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory4_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory4_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory4_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory4_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory4_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory4_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory4_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory4_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory4_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory4_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory4_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory4_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory4_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory4_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory4_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory4_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory4_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + + +#define IDXGIFactory4_GetCreationFlags(This) \ + ( (This)->lpVtbl -> GetCreationFlags(This) ) + + +#define IDXGIFactory4_EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) ) + +#define IDXGIFactory4_EnumWarpAdapter(This,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumWarpAdapter(This,riid,ppvAdapter) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory4_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_4_0000_0003 */ +/* [local] */ + +typedef +enum DXGI_MEMORY_SEGMENT_GROUP + { + DXGI_MEMORY_SEGMENT_GROUP_LOCAL = 0, + DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = 1 + } DXGI_MEMORY_SEGMENT_GROUP; + +typedef struct DXGI_QUERY_VIDEO_MEMORY_INFO + { + UINT64 Budget; + UINT64 CurrentUsage; + UINT64 AvailableForReservation; + UINT64 CurrentReservation; + } DXGI_QUERY_VIDEO_MEMORY_INFO; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0003_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0003_v0_0_s_ifspec; + +#ifndef __IDXGIAdapter3_INTERFACE_DEFINED__ +#define __IDXGIAdapter3_INTERFACE_DEFINED__ + +/* interface IDXGIAdapter3 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIAdapter3; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("645967A4-1392-4310-A798-8053CE3E93FD") + IDXGIAdapter3 : public IDXGIAdapter2 + { + public: + virtual HRESULT STDMETHODCALLTYPE RegisterHardwareContentProtectionTeardownStatusEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual void STDMETHODCALLTYPE UnregisterHardwareContentProtectionTeardownStatus( + /* [annotation][in] */ + _In_ DWORD dwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE QueryVideoMemoryInfo( + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][out] */ + _Out_ DXGI_QUERY_VIDEO_MEMORY_INFO *pVideoMemoryInfo) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetVideoMemoryReservation( + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][in] */ + _In_ UINT64 Reservation) = 0; + + virtual HRESULT STDMETHODCALLTYPE RegisterVideoMemoryBudgetChangeNotificationEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual void STDMETHODCALLTYPE UnregisterVideoMemoryBudgetChangeNotification( + /* [annotation][in] */ + _In_ DWORD dwCookie) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIAdapter3Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIAdapter3 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIAdapter3 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIAdapter3 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIAdapter, EnumOutputs) + HRESULT ( STDMETHODCALLTYPE *EnumOutputs )( + IDXGIAdapter3 * This, + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGIAdapter, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIAdapter3 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter, CheckInterfaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckInterfaceSupport )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion); + + DECLSPEC_XFGVIRT(IDXGIAdapter1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGIAdapter3 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter2, GetDesc2) + HRESULT ( STDMETHODCALLTYPE *GetDesc2 )( + IDXGIAdapter3 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC2 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, RegisterHardwareContentProtectionTeardownStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterHardwareContentProtectionTeardownStatusEvent )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, UnregisterHardwareContentProtectionTeardownStatus) + void ( STDMETHODCALLTYPE *UnregisterHardwareContentProtectionTeardownStatus )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, QueryVideoMemoryInfo) + HRESULT ( STDMETHODCALLTYPE *QueryVideoMemoryInfo )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][out] */ + _Out_ DXGI_QUERY_VIDEO_MEMORY_INFO *pVideoMemoryInfo); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, SetVideoMemoryReservation) + HRESULT ( STDMETHODCALLTYPE *SetVideoMemoryReservation )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][in] */ + _In_ UINT64 Reservation); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, RegisterVideoMemoryBudgetChangeNotificationEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterVideoMemoryBudgetChangeNotificationEvent )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, UnregisterVideoMemoryBudgetChangeNotification) + void ( STDMETHODCALLTYPE *UnregisterVideoMemoryBudgetChangeNotification )( + IDXGIAdapter3 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + END_INTERFACE + } IDXGIAdapter3Vtbl; + + interface IDXGIAdapter3 + { + CONST_VTBL struct IDXGIAdapter3Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIAdapter3_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIAdapter3_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIAdapter3_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIAdapter3_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIAdapter3_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIAdapter3_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIAdapter3_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIAdapter3_EnumOutputs(This,Output,ppOutput) \ + ( (This)->lpVtbl -> EnumOutputs(This,Output,ppOutput) ) + +#define IDXGIAdapter3_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIAdapter3_CheckInterfaceSupport(This,InterfaceName,pUMDVersion) \ + ( (This)->lpVtbl -> CheckInterfaceSupport(This,InterfaceName,pUMDVersion) ) + + +#define IDXGIAdapter3_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + + +#define IDXGIAdapter3_GetDesc2(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc2(This,pDesc) ) + + +#define IDXGIAdapter3_RegisterHardwareContentProtectionTeardownStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterHardwareContentProtectionTeardownStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIAdapter3_UnregisterHardwareContentProtectionTeardownStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterHardwareContentProtectionTeardownStatus(This,dwCookie) ) + +#define IDXGIAdapter3_QueryVideoMemoryInfo(This,NodeIndex,MemorySegmentGroup,pVideoMemoryInfo) \ + ( (This)->lpVtbl -> QueryVideoMemoryInfo(This,NodeIndex,MemorySegmentGroup,pVideoMemoryInfo) ) + +#define IDXGIAdapter3_SetVideoMemoryReservation(This,NodeIndex,MemorySegmentGroup,Reservation) \ + ( (This)->lpVtbl -> SetVideoMemoryReservation(This,NodeIndex,MemorySegmentGroup,Reservation) ) + +#define IDXGIAdapter3_RegisterVideoMemoryBudgetChangeNotificationEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterVideoMemoryBudgetChangeNotificationEvent(This,hEvent,pdwCookie) ) + +#define IDXGIAdapter3_UnregisterVideoMemoryBudgetChangeNotification(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterVideoMemoryBudgetChangeNotification(This,dwCookie) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIAdapter3_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_4_0000_0004 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +DEFINE_GUID(IID_IDXGISwapChain3,0x94d99bdb,0xf1f8,0x4ab0,0xb2,0x36,0x7d,0xa0,0x17,0x0e,0xda,0xb1); +DEFINE_GUID(IID_IDXGIOutput4,0xdc7dca35,0x2196,0x414d,0x9F,0x53,0x61,0x78,0x84,0x03,0x2a,0x60); +DEFINE_GUID(IID_IDXGIFactory4,0x1bc6ea02,0xef36,0x464f,0xbf,0x0c,0x21,0xca,0x39,0xe5,0x16,0x8a); +DEFINE_GUID(IID_IDXGIAdapter3,0x645967A4,0x1392,0x4310,0xA7,0x98,0x80,0x53,0xCE,0x3E,0x93,0xFD); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_4_0000_0004_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.idl new file mode 100644 index 0000000000000000000000000000000000000000..cac1fa608cfeb691e21c8d1327a7d2c2e031a0fa --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_4.idl @@ -0,0 +1,154 @@ +// Copyright (c) Microsoft Corporation. All Rights Reserved + +import "dxgi1_3.idl"; + +cpp_quote("#include ") + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") + +//+----------------------------------------------------------------------------- +// +// Return flags from CheckColorSpaceSupport +// +//------------------------------------------------------------------------------ +typedef enum DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG +{ + DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG_PRESENT = 0x00000001, + DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG_OVERLAY_PRESENT = 0x00000002 +} DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapChain3 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 94d99bdb-f1f8-4ab0-b236-7da0170edab1 ), + local, + pointer_default(unique) +] +interface IDXGISwapChain3 : + IDXGISwapChain2 +{ + UINT GetCurrentBackBufferIndex(); + HRESULT CheckColorSpaceSupport( [in, annotation("_In_")] DXGI_COLOR_SPACE_TYPE ColorSpace, [out, annotation("_Out_")] UINT* pColorSpaceSupport ); + HRESULT SetColorSpace1( [in, annotation("_In_")] DXGI_COLOR_SPACE_TYPE ColorSpace ); + HRESULT ResizeBuffers1( + [in, annotation("_In_")] UINT BufferCount, + [in, annotation("_In_")] UINT Width, + [in, annotation("_In_")] UINT Height, + [in, annotation("_In_")] DXGI_FORMAT Format, + [in, annotation("_In_")] UINT SwapChainFlags, + [in, annotation("_In_reads_(BufferCount)")] const UINT* pCreationNodeMask, + [in, annotation("_In_reads_(BufferCount)")] IUnknown* const* ppPresentQueue + ); + +}; + +//+----------------------------------------------------------------------------- +// +// Return flags from CheckOverlayColorSpaceSupport +// +//------------------------------------------------------------------------------ +typedef enum DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG +{ + DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG_PRESENT = 0x00000001, +} DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput4 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(dc7dca35-2196-414d-9F53-617884032a60), + local, + pointer_default(unique) +] +interface IDXGIOutput4 : + IDXGIOutput3 +{ + HRESULT CheckOverlayColorSpaceSupport( [in, annotation("_In_")] DXGI_FORMAT Format, [in, annotation("_In_")] DXGI_COLOR_SPACE_TYPE ColorSpace, [in, annotation("_In_")] IUnknown *pConcernedDevice, [out, annotation("_Out_")] UINT *pFlags ); +}; + + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory4 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(1bc6ea02-ef36-464f-bf0c-21ca39e5168a), + local, + pointer_default(unique) +] +interface IDXGIFactory4 : + IDXGIFactory3 +{ + HRESULT EnumAdapterByLuid( + [annotation("_In_")] LUID AdapterLuid, + [annotation("_In_")] REFIID riid, + [annotation("_COM_Outptr_")] void** ppvAdapter + ); + HRESULT EnumWarpAdapter( + [annotation("_In_")] REFIID riid, + [annotation("_COM_Outptr_")] void** ppvAdapter + ); +}; + +typedef enum DXGI_MEMORY_SEGMENT_GROUP +{ + DXGI_MEMORY_SEGMENT_GROUP_LOCAL = 0, + DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = 1 +} DXGI_MEMORY_SEGMENT_GROUP; + +typedef struct DXGI_QUERY_VIDEO_MEMORY_INFO +{ + UINT64 Budget; + UINT64 CurrentUsage; + UINT64 AvailableForReservation; + UINT64 CurrentReservation; +} DXGI_QUERY_VIDEO_MEMORY_INFO; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIAdapter3 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid( 645967A4-1392-4310-A798-8053CE3E93FD ), + local, + pointer_default(unique) +] +interface IDXGIAdapter3 : + IDXGIAdapter2 +{ + HRESULT RegisterHardwareContentProtectionTeardownStatusEvent( + [in, annotation("_In_")] HANDLE hEvent, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + void UnregisterHardwareContentProtectionTeardownStatus( + [in, annotation("_In_")] DWORD dwCookie ); + + HRESULT QueryVideoMemoryInfo( + [in, annotation("_In_")] UINT NodeIndex, + [in, annotation("_In_")] DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + [out, annotation("_Out_")] DXGI_QUERY_VIDEO_MEMORY_INFO *pVideoMemoryInfo ); + + HRESULT SetVideoMemoryReservation( + [in, annotation("_In_")] UINT NodeIndex, + [in, annotation("_In_")] DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + [in, annotation("_In_")] UINT64 Reservation ); + + HRESULT RegisterVideoMemoryBudgetChangeNotificationEvent( + [in, annotation("_In_")] HANDLE hEvent, + [out, annotation("_Out_")] DWORD *pdwCookie ); + + void UnregisterVideoMemoryBudgetChangeNotification( + [in, annotation("_In_")] DWORD dwCookie ); +}; + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChain3,0x94d99bdb,0xf1f8,0x4ab0,0xb2,0x36,0x7d,0xa0,0x17,0x0e,0xda,0xb1);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput4,0xdc7dca35,0x2196,0x414d,0x9F,0x53,0x61,0x78,0x84,0x03,0x2a,0x60);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory4,0x1bc6ea02,0xef36,0x464f,0xbf,0x0c,0x21,0xca,0x39,0xe5,0x16,0x8a);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIAdapter3,0x645967A4,0x1392,0x4310,0xA7,0x98,0x80,0x53,0xCE,0x3E,0x93,0xFD);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.h new file mode 100644 index 0000000000000000000000000000000000000000..1a501d12350bdcf66456564ed4f766734133bf2c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.h @@ -0,0 +1,1670 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi1_5_h__ +#define __dxgi1_5_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGIOutput5_FWD_DEFINED__ +#define __IDXGIOutput5_FWD_DEFINED__ +typedef interface IDXGIOutput5 IDXGIOutput5; + +#endif /* __IDXGIOutput5_FWD_DEFINED__ */ + + +#ifndef __IDXGISwapChain4_FWD_DEFINED__ +#define __IDXGISwapChain4_FWD_DEFINED__ +typedef interface IDXGISwapChain4 IDXGISwapChain4; + +#endif /* __IDXGISwapChain4_FWD_DEFINED__ */ + + +#ifndef __IDXGIDevice4_FWD_DEFINED__ +#define __IDXGIDevice4_FWD_DEFINED__ +typedef interface IDXGIDevice4 IDXGIDevice4; + +#endif /* __IDXGIDevice4_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory5_FWD_DEFINED__ +#define __IDXGIFactory5_FWD_DEFINED__ +typedef interface IDXGIFactory5 IDXGIFactory5; + +#endif /* __IDXGIFactory5_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "dxgi1_4.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi1_5_0000_0000 */ +/* [local] */ + +#include +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) +typedef +enum DXGI_OUTDUPL_FLAG + { + DXGI_OUTDUPL_COMPOSITED_UI_CAPTURE_ONLY = 1 + } DXGI_OUTDUPL_FLAG; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGIOutput5_INTERFACE_DEFINED__ +#define __IDXGIOutput5_INTERFACE_DEFINED__ + +/* interface IDXGIOutput5 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput5; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("80A07424-AB52-42EB-833C-0C42FD282D98") + IDXGIOutput5 : public IDXGIOutput4 + { + public: + virtual HRESULT STDMETHODCALLTYPE DuplicateOutput1( + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [in] */ UINT Flags, + /* [annotation][in] */ + _In_ UINT SupportedFormatsCount, + /* [annotation][in] */ + _In_reads_(SupportedFormatsCount) const DXGI_FORMAT *pSupportedFormats, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput5Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput5 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput5 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput5 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput5 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput5 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput5 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput5 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput5 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput5 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput5 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput5 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput2, SupportsOverlays) + BOOL ( STDMETHODCALLTYPE *SupportsOverlays )( + IDXGIOutput5 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput3, CheckOverlaySupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlaySupport )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT EnumFormat, + /* [annotation][out] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + DECLSPEC_XFGVIRT(IDXGIOutput4, CheckOverlayColorSpaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlayColorSpaceSupport )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][in] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + DECLSPEC_XFGVIRT(IDXGIOutput5, DuplicateOutput1) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput1 )( + IDXGIOutput5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [in] */ UINT Flags, + /* [annotation][in] */ + _In_ UINT SupportedFormatsCount, + /* [annotation][in] */ + _In_reads_(SupportedFormatsCount) const DXGI_FORMAT *pSupportedFormats, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + END_INTERFACE + } IDXGIOutput5Vtbl; + + interface IDXGIOutput5 + { + CONST_VTBL struct IDXGIOutput5Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput5_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput5_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput5_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput5_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput5_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput5_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput5_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput5_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput5_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput5_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput5_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput5_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput5_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput5_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput5_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput5_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput5_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput5_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput5_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput5_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput5_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput5_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput5_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + + +#define IDXGIOutput5_SupportsOverlays(This) \ + ( (This)->lpVtbl -> SupportsOverlays(This) ) + + +#define IDXGIOutput5_CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) ) + + +#define IDXGIOutput5_CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) ) + + +#define IDXGIOutput5_DuplicateOutput1(This,pDevice,Flags,SupportedFormatsCount,pSupportedFormats,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput1(This,pDevice,Flags,SupportedFormatsCount,pSupportedFormats,ppOutputDuplication) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput5_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_5_0000_0001 */ +/* [local] */ + +typedef +enum DXGI_HDR_METADATA_TYPE + { + DXGI_HDR_METADATA_TYPE_NONE = 0, + DXGI_HDR_METADATA_TYPE_HDR10 = 1, + DXGI_HDR_METADATA_TYPE_HDR10PLUS = 2 + } DXGI_HDR_METADATA_TYPE; + +typedef struct DXGI_HDR_METADATA_HDR10 + { + UINT16 RedPrimary[ 2 ]; + UINT16 GreenPrimary[ 2 ]; + UINT16 BluePrimary[ 2 ]; + UINT16 WhitePoint[ 2 ]; + UINT MaxMasteringLuminance; + UINT MinMasteringLuminance; + UINT16 MaxContentLightLevel; + UINT16 MaxFrameAverageLightLevel; + } DXGI_HDR_METADATA_HDR10; + +typedef struct DXGI_HDR_METADATA_HDR10PLUS + { + BYTE Data[ 72 ]; + } DXGI_HDR_METADATA_HDR10PLUS; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0001_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0001_v0_0_s_ifspec; + +#ifndef __IDXGISwapChain4_INTERFACE_DEFINED__ +#define __IDXGISwapChain4_INTERFACE_DEFINED__ + +/* interface IDXGISwapChain4 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGISwapChain4; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("3D585D5A-BD4A-489E-B1F4-3DBCB6452FFB") + IDXGISwapChain4 : public IDXGISwapChain3 + { + public: + virtual HRESULT STDMETHODCALLTYPE SetHDRMetaData( + /* [annotation][in] */ + _In_ DXGI_HDR_METADATA_TYPE Type, + /* [annotation][in] */ + _In_ UINT Size, + /* [annotation][size_is][in] */ + _In_reads_opt_(Size) void *pMetaData) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGISwapChain4Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGISwapChain4 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGISwapChain4 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGISwapChain4 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDeviceSubObject, GetDevice) + HRESULT ( STDMETHODCALLTYPE *GetDevice )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppDevice); + + DECLSPEC_XFGVIRT(IDXGISwapChain, Present) + HRESULT ( STDMETHODCALLTYPE *Present )( + IDXGISwapChain4 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetBuffer) + HRESULT ( STDMETHODCALLTYPE *GetBuffer )( + IDXGISwapChain4 * This, + /* [in] */ UINT Buffer, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][out][in] */ + _COM_Outptr_ void **ppSurface); + + DECLSPEC_XFGVIRT(IDXGISwapChain, SetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *SetFullscreenState )( + IDXGISwapChain4 * This, + /* [in] */ BOOL Fullscreen, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFullscreenState) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenState )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_opt_ BOOL *pFullscreen, + /* [annotation][out] */ + _COM_Outptr_opt_result_maybenull_ IDXGIOutput **ppTarget); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeBuffers) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers )( + IDXGISwapChain4 * This, + /* [in] */ UINT BufferCount, + /* [in] */ UINT Width, + /* [in] */ UINT Height, + /* [in] */ DXGI_FORMAT NewFormat, + /* [in] */ UINT SwapChainFlags); + + DECLSPEC_XFGVIRT(IDXGISwapChain, ResizeTarget) + HRESULT ( STDMETHODCALLTYPE *ResizeTarget )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pNewTargetParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetContainingOutput) + HRESULT ( STDMETHODCALLTYPE *GetContainingOutput )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGISwapChain, GetLastPresentCount) + HRESULT ( STDMETHODCALLTYPE *GetLastPresentCount )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ UINT *pLastPresentCount); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetFullscreenDesc) + HRESULT ( STDMETHODCALLTYPE *GetFullscreenDesc )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetHwnd) + HRESULT ( STDMETHODCALLTYPE *GetHwnd )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ HWND *pHwnd); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetCoreWindow) + HRESULT ( STDMETHODCALLTYPE *GetCoreWindow )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ REFIID refiid, + /* [annotation][out] */ + _COM_Outptr_ void **ppUnk); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, Present1) + HRESULT ( STDMETHODCALLTYPE *Present1 )( + IDXGISwapChain4 * This, + /* [in] */ UINT SyncInterval, + /* [in] */ UINT PresentFlags, + /* [annotation][in] */ + _In_ const DXGI_PRESENT_PARAMETERS *pPresentParameters); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, IsTemporaryMonoSupported) + BOOL ( STDMETHODCALLTYPE *IsTemporaryMonoSupported )( + IDXGISwapChain4 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRestrictToOutput) + HRESULT ( STDMETHODCALLTYPE *GetRestrictToOutput )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ IDXGIOutput **ppRestrictToOutput); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *SetBackgroundColor )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ const DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetBackgroundColor) + HRESULT ( STDMETHODCALLTYPE *GetBackgroundColor )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_RGBA *pColor); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, SetRotation) + HRESULT ( STDMETHODCALLTYPE *SetRotation )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ DXGI_MODE_ROTATION Rotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain1, GetRotation) + HRESULT ( STDMETHODCALLTYPE *GetRotation )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_MODE_ROTATION *pRotation); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetSourceSize) + HRESULT ( STDMETHODCALLTYPE *SetSourceSize )( + IDXGISwapChain4 * This, + UINT Width, + UINT Height); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetSourceSize) + HRESULT ( STDMETHODCALLTYPE *GetSourceSize )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ UINT *pWidth, + /* [annotation][out] */ + _Out_ UINT *pHeight); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGISwapChain4 * This, + UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetFrameLatencyWaitableObject) + HANDLE ( STDMETHODCALLTYPE *GetFrameLatencyWaitableObject )( + IDXGISwapChain4 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, SetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *SetMatrixTransform )( + IDXGISwapChain4 * This, + const DXGI_MATRIX_3X2_F *pMatrix); + + DECLSPEC_XFGVIRT(IDXGISwapChain2, GetMatrixTransform) + HRESULT ( STDMETHODCALLTYPE *GetMatrixTransform )( + IDXGISwapChain4 * This, + /* [annotation][out] */ + _Out_ DXGI_MATRIX_3X2_F *pMatrix); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, GetCurrentBackBufferIndex) + UINT ( STDMETHODCALLTYPE *GetCurrentBackBufferIndex )( + IDXGISwapChain4 * This); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, CheckColorSpaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckColorSpaceSupport )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][out] */ + _Out_ UINT *pColorSpaceSupport); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, SetColorSpace1) + HRESULT ( STDMETHODCALLTYPE *SetColorSpace1 )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace); + + DECLSPEC_XFGVIRT(IDXGISwapChain3, ResizeBuffers1) + HRESULT ( STDMETHODCALLTYPE *ResizeBuffers1 )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ UINT BufferCount, + /* [annotation][in] */ + _In_ UINT Width, + /* [annotation][in] */ + _In_ UINT Height, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ UINT SwapChainFlags, + /* [annotation][in] */ + _In_reads_(BufferCount) const UINT *pCreationNodeMask, + /* [annotation][in] */ + _In_reads_(BufferCount) IUnknown *const *ppPresentQueue); + + DECLSPEC_XFGVIRT(IDXGISwapChain4, SetHDRMetaData) + HRESULT ( STDMETHODCALLTYPE *SetHDRMetaData )( + IDXGISwapChain4 * This, + /* [annotation][in] */ + _In_ DXGI_HDR_METADATA_TYPE Type, + /* [annotation][in] */ + _In_ UINT Size, + /* [annotation][size_is][in] */ + _In_reads_opt_(Size) void *pMetaData); + + END_INTERFACE + } IDXGISwapChain4Vtbl; + + interface IDXGISwapChain4 + { + CONST_VTBL struct IDXGISwapChain4Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGISwapChain4_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGISwapChain4_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGISwapChain4_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGISwapChain4_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGISwapChain4_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGISwapChain4_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGISwapChain4_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGISwapChain4_GetDevice(This,riid,ppDevice) \ + ( (This)->lpVtbl -> GetDevice(This,riid,ppDevice) ) + + +#define IDXGISwapChain4_Present(This,SyncInterval,Flags) \ + ( (This)->lpVtbl -> Present(This,SyncInterval,Flags) ) + +#define IDXGISwapChain4_GetBuffer(This,Buffer,riid,ppSurface) \ + ( (This)->lpVtbl -> GetBuffer(This,Buffer,riid,ppSurface) ) + +#define IDXGISwapChain4_SetFullscreenState(This,Fullscreen,pTarget) \ + ( (This)->lpVtbl -> SetFullscreenState(This,Fullscreen,pTarget) ) + +#define IDXGISwapChain4_GetFullscreenState(This,pFullscreen,ppTarget) \ + ( (This)->lpVtbl -> GetFullscreenState(This,pFullscreen,ppTarget) ) + +#define IDXGISwapChain4_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGISwapChain4_ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) \ + ( (This)->lpVtbl -> ResizeBuffers(This,BufferCount,Width,Height,NewFormat,SwapChainFlags) ) + +#define IDXGISwapChain4_ResizeTarget(This,pNewTargetParameters) \ + ( (This)->lpVtbl -> ResizeTarget(This,pNewTargetParameters) ) + +#define IDXGISwapChain4_GetContainingOutput(This,ppOutput) \ + ( (This)->lpVtbl -> GetContainingOutput(This,ppOutput) ) + +#define IDXGISwapChain4_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + +#define IDXGISwapChain4_GetLastPresentCount(This,pLastPresentCount) \ + ( (This)->lpVtbl -> GetLastPresentCount(This,pLastPresentCount) ) + + +#define IDXGISwapChain4_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#define IDXGISwapChain4_GetFullscreenDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetFullscreenDesc(This,pDesc) ) + +#define IDXGISwapChain4_GetHwnd(This,pHwnd) \ + ( (This)->lpVtbl -> GetHwnd(This,pHwnd) ) + +#define IDXGISwapChain4_GetCoreWindow(This,refiid,ppUnk) \ + ( (This)->lpVtbl -> GetCoreWindow(This,refiid,ppUnk) ) + +#define IDXGISwapChain4_Present1(This,SyncInterval,PresentFlags,pPresentParameters) \ + ( (This)->lpVtbl -> Present1(This,SyncInterval,PresentFlags,pPresentParameters) ) + +#define IDXGISwapChain4_IsTemporaryMonoSupported(This) \ + ( (This)->lpVtbl -> IsTemporaryMonoSupported(This) ) + +#define IDXGISwapChain4_GetRestrictToOutput(This,ppRestrictToOutput) \ + ( (This)->lpVtbl -> GetRestrictToOutput(This,ppRestrictToOutput) ) + +#define IDXGISwapChain4_SetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> SetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain4_GetBackgroundColor(This,pColor) \ + ( (This)->lpVtbl -> GetBackgroundColor(This,pColor) ) + +#define IDXGISwapChain4_SetRotation(This,Rotation) \ + ( (This)->lpVtbl -> SetRotation(This,Rotation) ) + +#define IDXGISwapChain4_GetRotation(This,pRotation) \ + ( (This)->lpVtbl -> GetRotation(This,pRotation) ) + + +#define IDXGISwapChain4_SetSourceSize(This,Width,Height) \ + ( (This)->lpVtbl -> SetSourceSize(This,Width,Height) ) + +#define IDXGISwapChain4_GetSourceSize(This,pWidth,pHeight) \ + ( (This)->lpVtbl -> GetSourceSize(This,pWidth,pHeight) ) + +#define IDXGISwapChain4_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGISwapChain4_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + +#define IDXGISwapChain4_GetFrameLatencyWaitableObject(This) \ + ( (This)->lpVtbl -> GetFrameLatencyWaitableObject(This) ) + +#define IDXGISwapChain4_SetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> SetMatrixTransform(This,pMatrix) ) + +#define IDXGISwapChain4_GetMatrixTransform(This,pMatrix) \ + ( (This)->lpVtbl -> GetMatrixTransform(This,pMatrix) ) + + +#define IDXGISwapChain4_GetCurrentBackBufferIndex(This) \ + ( (This)->lpVtbl -> GetCurrentBackBufferIndex(This) ) + +#define IDXGISwapChain4_CheckColorSpaceSupport(This,ColorSpace,pColorSpaceSupport) \ + ( (This)->lpVtbl -> CheckColorSpaceSupport(This,ColorSpace,pColorSpaceSupport) ) + +#define IDXGISwapChain4_SetColorSpace1(This,ColorSpace) \ + ( (This)->lpVtbl -> SetColorSpace1(This,ColorSpace) ) + +#define IDXGISwapChain4_ResizeBuffers1(This,BufferCount,Width,Height,Format,SwapChainFlags,pCreationNodeMask,ppPresentQueue) \ + ( (This)->lpVtbl -> ResizeBuffers1(This,BufferCount,Width,Height,Format,SwapChainFlags,pCreationNodeMask,ppPresentQueue) ) + + +#define IDXGISwapChain4_SetHDRMetaData(This,Type,Size,pMetaData) \ + ( (This)->lpVtbl -> SetHDRMetaData(This,Type,Size,pMetaData) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGISwapChain4_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_5_0000_0002 */ +/* [local] */ + +typedef +enum _DXGI_OFFER_RESOURCE_FLAGS + { + DXGI_OFFER_RESOURCE_FLAG_ALLOW_DECOMMIT = 0x1 + } DXGI_OFFER_RESOURCE_FLAGS; + +typedef +enum _DXGI_RECLAIM_RESOURCE_RESULTS + { + DXGI_RECLAIM_RESOURCE_RESULT_OK = 0, + DXGI_RECLAIM_RESOURCE_RESULT_DISCARDED = 1, + DXGI_RECLAIM_RESOURCE_RESULT_NOT_COMMITTED = 2 + } DXGI_RECLAIM_RESOURCE_RESULTS; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0002_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0002_v0_0_s_ifspec; + +#ifndef __IDXGIDevice4_INTERFACE_DEFINED__ +#define __IDXGIDevice4_INTERFACE_DEFINED__ + +/* interface IDXGIDevice4 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIDevice4; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("95B4F95F-D8DA-4CA4-9EE6-3B76D5968A10") + IDXGIDevice4 : public IDXGIDevice3 + { + public: + virtual HRESULT STDMETHODCALLTYPE OfferResources1( + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority, + /* [annotation][in] */ + _In_ UINT Flags) = 0; + + virtual HRESULT STDMETHODCALLTYPE ReclaimResources1( + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_(NumResources) DXGI_RECLAIM_RESOURCE_RESULTS *pResults) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIDevice4Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIDevice4 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIDevice4 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIDevice4 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetAdapter) + HRESULT ( STDMETHODCALLTYPE *GetAdapter )( + IDXGIDevice4 * This, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **pAdapter); + + DECLSPEC_XFGVIRT(IDXGIDevice, CreateSurface) + HRESULT ( STDMETHODCALLTYPE *CreateSurface )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ const DXGI_SURFACE_DESC *pDesc, + /* [in] */ UINT NumSurfaces, + /* [in] */ DXGI_USAGE Usage, + /* [annotation][in] */ + _In_opt_ const DXGI_SHARED_RESOURCE *pSharedResource, + /* [annotation][size_is][out] */ + _Out_writes_(NumSurfaces) IDXGISurface **ppSurface); + + DECLSPEC_XFGVIRT(IDXGIDevice, QueryResourceResidency) + HRESULT ( STDMETHODCALLTYPE *QueryResourceResidency )( + IDXGIDevice4 * This, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IUnknown *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_(NumResources) DXGI_RESIDENCY *pResidencyStatus, + /* [in] */ UINT NumResources); + + DECLSPEC_XFGVIRT(IDXGIDevice, SetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *SetGPUThreadPriority )( + IDXGIDevice4 * This, + /* [in] */ INT Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice, GetGPUThreadPriority) + HRESULT ( STDMETHODCALLTYPE *GetGPUThreadPriority )( + IDXGIDevice4 * This, + /* [annotation][retval][out] */ + _Out_ INT *pPriority); + + DECLSPEC_XFGVIRT(IDXGIDevice1, SetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *SetMaximumFrameLatency )( + IDXGIDevice4 * This, + /* [in] */ UINT MaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice1, GetMaximumFrameLatency) + HRESULT ( STDMETHODCALLTYPE *GetMaximumFrameLatency )( + IDXGIDevice4 * This, + /* [annotation][out] */ + _Out_ UINT *pMaxLatency); + + DECLSPEC_XFGVIRT(IDXGIDevice2, OfferResources) + HRESULT ( STDMETHODCALLTYPE *OfferResources )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority); + + DECLSPEC_XFGVIRT(IDXGIDevice2, ReclaimResources) + HRESULT ( STDMETHODCALLTYPE *ReclaimResources )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_opt_(NumResources) BOOL *pDiscarded); + + DECLSPEC_XFGVIRT(IDXGIDevice2, EnqueueSetEvent) + HRESULT ( STDMETHODCALLTYPE *EnqueueSetEvent )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent); + + DECLSPEC_XFGVIRT(IDXGIDevice3, Trim) + void ( STDMETHODCALLTYPE *Trim )( + IDXGIDevice4 * This); + + DECLSPEC_XFGVIRT(IDXGIDevice4, OfferResources1) + HRESULT ( STDMETHODCALLTYPE *OfferResources1 )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][in] */ + _In_ DXGI_OFFER_RESOURCE_PRIORITY Priority, + /* [annotation][in] */ + _In_ UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIDevice4, ReclaimResources1) + HRESULT ( STDMETHODCALLTYPE *ReclaimResources1 )( + IDXGIDevice4 * This, + /* [annotation][in] */ + _In_ UINT NumResources, + /* [annotation][size_is][in] */ + _In_reads_(NumResources) IDXGIResource *const *ppResources, + /* [annotation][size_is][out] */ + _Out_writes_all_(NumResources) DXGI_RECLAIM_RESOURCE_RESULTS *pResults); + + END_INTERFACE + } IDXGIDevice4Vtbl; + + interface IDXGIDevice4 + { + CONST_VTBL struct IDXGIDevice4Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIDevice4_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIDevice4_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIDevice4_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIDevice4_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIDevice4_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIDevice4_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIDevice4_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIDevice4_GetAdapter(This,pAdapter) \ + ( (This)->lpVtbl -> GetAdapter(This,pAdapter) ) + +#define IDXGIDevice4_CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) \ + ( (This)->lpVtbl -> CreateSurface(This,pDesc,NumSurfaces,Usage,pSharedResource,ppSurface) ) + +#define IDXGIDevice4_QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) \ + ( (This)->lpVtbl -> QueryResourceResidency(This,ppResources,pResidencyStatus,NumResources) ) + +#define IDXGIDevice4_SetGPUThreadPriority(This,Priority) \ + ( (This)->lpVtbl -> SetGPUThreadPriority(This,Priority) ) + +#define IDXGIDevice4_GetGPUThreadPriority(This,pPriority) \ + ( (This)->lpVtbl -> GetGPUThreadPriority(This,pPriority) ) + + +#define IDXGIDevice4_SetMaximumFrameLatency(This,MaxLatency) \ + ( (This)->lpVtbl -> SetMaximumFrameLatency(This,MaxLatency) ) + +#define IDXGIDevice4_GetMaximumFrameLatency(This,pMaxLatency) \ + ( (This)->lpVtbl -> GetMaximumFrameLatency(This,pMaxLatency) ) + + +#define IDXGIDevice4_OfferResources(This,NumResources,ppResources,Priority) \ + ( (This)->lpVtbl -> OfferResources(This,NumResources,ppResources,Priority) ) + +#define IDXGIDevice4_ReclaimResources(This,NumResources,ppResources,pDiscarded) \ + ( (This)->lpVtbl -> ReclaimResources(This,NumResources,ppResources,pDiscarded) ) + +#define IDXGIDevice4_EnqueueSetEvent(This,hEvent) \ + ( (This)->lpVtbl -> EnqueueSetEvent(This,hEvent) ) + + +#define IDXGIDevice4_Trim(This) \ + ( (This)->lpVtbl -> Trim(This) ) + + +#define IDXGIDevice4_OfferResources1(This,NumResources,ppResources,Priority,Flags) \ + ( (This)->lpVtbl -> OfferResources1(This,NumResources,ppResources,Priority,Flags) ) + +#define IDXGIDevice4_ReclaimResources1(This,NumResources,ppResources,pResults) \ + ( (This)->lpVtbl -> ReclaimResources1(This,NumResources,ppResources,pResults) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIDevice4_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_5_0000_0003 */ +/* [local] */ + +typedef +enum DXGI_FEATURE + { + DXGI_FEATURE_PRESENT_ALLOW_TEARING = 0 + } DXGI_FEATURE; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0003_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0003_v0_0_s_ifspec; + +#ifndef __IDXGIFactory5_INTERFACE_DEFINED__ +#define __IDXGIFactory5_INTERFACE_DEFINED__ + +/* interface IDXGIFactory5 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory5; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("7632e1f5-ee65-4dca-87fd-84cd75f8838d") + IDXGIFactory5 : public IDXGIFactory4 + { + public: + virtual HRESULT STDMETHODCALLTYPE CheckFeatureSupport( + DXGI_FEATURE Feature, + /* [annotation] */ + _Inout_updates_bytes_(FeatureSupportDataSize) void *pFeatureSupportData, + UINT FeatureSupportDataSize) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory5Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory5 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory5 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory5 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory5 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory5 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory5 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory5 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory5 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory5 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory5 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory5 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory5 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory3, GetCreationFlags) + UINT ( STDMETHODCALLTYPE *GetCreationFlags )( + IDXGIFactory5 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumAdapterByLuid) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByLuid )( + IDXGIFactory5 * This, + /* [annotation] */ + _In_ LUID AdapterLuid, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumWarpAdapter) + HRESULT ( STDMETHODCALLTYPE *EnumWarpAdapter )( + IDXGIFactory5 * This, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory5, CheckFeatureSupport) + HRESULT ( STDMETHODCALLTYPE *CheckFeatureSupport )( + IDXGIFactory5 * This, + DXGI_FEATURE Feature, + /* [annotation] */ + _Inout_updates_bytes_(FeatureSupportDataSize) void *pFeatureSupportData, + UINT FeatureSupportDataSize); + + END_INTERFACE + } IDXGIFactory5Vtbl; + + interface IDXGIFactory5 + { + CONST_VTBL struct IDXGIFactory5Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory5_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory5_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory5_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory5_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory5_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory5_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory5_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory5_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory5_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory5_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory5_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory5_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory5_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory5_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory5_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory5_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory5_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory5_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory5_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory5_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory5_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory5_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory5_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory5_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory5_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + + +#define IDXGIFactory5_GetCreationFlags(This) \ + ( (This)->lpVtbl -> GetCreationFlags(This) ) + + +#define IDXGIFactory5_EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) ) + +#define IDXGIFactory5_EnumWarpAdapter(This,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumWarpAdapter(This,riid,ppvAdapter) ) + + +#define IDXGIFactory5_CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) \ + ( (This)->lpVtbl -> CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory5_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_5_0000_0004 */ +/* [local] */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +DEFINE_GUID(IID_IDXGIOutput5,0x80A07424,0xAB52,0x42EB,0x83,0x3C,0x0C,0x42,0xFD,0x28,0x2D,0x98); +DEFINE_GUID(IID_IDXGISwapChain4,0x3D585D5A,0xBD4A,0x489E,0xB1,0xF4,0x3D,0xBC,0xB6,0x45,0x2F,0xFB); +DEFINE_GUID(IID_IDXGIDevice4,0x95B4F95F,0xD8DA,0x4CA4,0x9E,0xE6,0x3B,0x76,0xD5,0x96,0x8A,0x10); +DEFINE_GUID(IID_IDXGIFactory5,0x7632e1f5,0xee65,0x4dca,0x87,0xfd,0x84,0xcd,0x75,0xf8,0x83,0x8d); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_5_0000_0004_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.idl new file mode 100644 index 0000000000000000000000000000000000000000..d08fe52896d0ebaf45cc6f6412ebf7ad48bbb90f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_5.idl @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All Rights Reserved + +import "dxgi1_4.idl"; + +cpp_quote("#include ") + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") + +typedef enum DXGI_OUTDUPL_FLAG { + DXGI_OUTDUPL_COMPOSITED_UI_CAPTURE_ONLY = 1, +} DXGI_OUTDUPL_FLAG; + + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput5 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(80A07424-AB52-42EB-833C-0C42FD282D98), + local, + pointer_default(unique) +] +interface IDXGIOutput5 : + IDXGIOutput4 +{ + HRESULT DuplicateOutput1([in, annotation("_In_")] IUnknown *pDevice, + [in ] UINT Flags, + [in, annotation("_In_")] UINT SupportedFormatsCount, + [in, annotation("_In_reads_(SupportedFormatsCount)")] const DXGI_FORMAT* pSupportedFormats, + [out, annotation("_COM_Outptr_")] IDXGIOutputDuplication **ppOutputDuplication); +}; + +//+----------------------------------------------------------------------------- +// +// HDR MetaData types +// +//------------------------------------------------------------------------------ +typedef enum DXGI_HDR_METADATA_TYPE +{ + DXGI_HDR_METADATA_TYPE_NONE = 0, + DXGI_HDR_METADATA_TYPE_HDR10 = 1, + DXGI_HDR_METADATA_TYPE_HDR10PLUS = 2, +} DXGI_HDR_METADATA_TYPE; + +typedef struct DXGI_HDR_METADATA_HDR10 +{ + // Color gamut + UINT16 RedPrimary[2]; + UINT16 GreenPrimary[2]; + UINT16 BluePrimary[2]; + UINT16 WhitePoint[2]; + + // Luminance + UINT MaxMasteringLuminance; + UINT MinMasteringLuminance; + UINT16 MaxContentLightLevel; + UINT16 MaxFrameAverageLightLevel; +} DXGI_HDR_METADATA_HDR10; + +typedef struct DXGI_HDR_METADATA_HDR10PLUS +{ + BYTE Data[72]; +} DXGI_HDR_METADATA_HDR10PLUS; + +//-------------------------------------------------------------------------------------------------------- +// IDXGISwapChain4 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(3D585D5A-BD4A-489E-B1F4-3DBCB6452FFB), + local, + pointer_default(unique) +] +interface IDXGISwapChain4 : + IDXGISwapChain3 +{ + HRESULT SetHDRMetaData( + [in, annotation("_In_")] DXGI_HDR_METADATA_TYPE Type, + [in, annotation("_In_")] UINT Size, + [in, size_is(Size), annotation("_In_reads_opt_(Size)")] void* pMetaData + ); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIDevice4 interface +//-------------------------------------------------------------------------------------------------------- +typedef enum _DXGI_OFFER_RESOURCE_FLAGS +{ + DXGI_OFFER_RESOURCE_FLAG_ALLOW_DECOMMIT = 0x1, +} DXGI_OFFER_RESOURCE_FLAGS; + +typedef enum _DXGI_RECLAIM_RESOURCE_RESULTS +{ + DXGI_RECLAIM_RESOURCE_RESULT_OK = 0, + DXGI_RECLAIM_RESOURCE_RESULT_DISCARDED = 1, + DXGI_RECLAIM_RESOURCE_RESULT_NOT_COMMITTED = 2, +} DXGI_RECLAIM_RESOURCE_RESULTS; + +[ + object, + uuid(95B4F95F-D8DA-4CA4-9EE6-3B76D5968A10), + local, + pointer_default(unique) +] +interface IDXGIDevice4 : + IDXGIDevice3 +{ + HRESULT OfferResources1( + [in, annotation("_In_")] UINT NumResources, + [in, size_is(NumResources), annotation("_In_reads_(NumResources)")] IDXGIResource *const *ppResources, + [in, annotation("_In_")] DXGI_OFFER_RESOURCE_PRIORITY Priority, + [in, annotation("_In_")] UINT Flags); + HRESULT ReclaimResources1( + [in, annotation("_In_")] UINT NumResources, + [in, size_is(NumResources), annotation("_In_reads_(NumResources)")] IDXGIResource *const *ppResources, + [out, size_is(NumResources), annotation("_Out_writes_all_(NumResources)")] DXGI_RECLAIM_RESOURCE_RESULTS *pResults); +}; + +//+----------------------------------------------------------------------------- +// +// Enum for IDXGIFactory5::CheckFeatureSupport +// +//------------------------------------------------------------------------------ +typedef enum DXGI_FEATURE +{ + DXGI_FEATURE_PRESENT_ALLOW_TEARING = 0, +} DXGI_FEATURE; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory5 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(7632e1f5-ee65-4dca-87fd-84cd75f8838d), + local, + pointer_default(unique) +] +interface IDXGIFactory5 : + IDXGIFactory4 +{ + HRESULT CheckFeatureSupport( + DXGI_FEATURE Feature, + [annotation("_Inout_updates_bytes_(FeatureSupportDataSize)")] void* pFeatureSupportData, + UINT FeatureSupportDataSize + ); +}; + +//-------------------------------------------------------------------------------------------------------- + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput5,0x80A07424,0xAB52,0x42EB,0x83,0x3C,0x0C,0x42,0xFD,0x28,0x2D,0x98);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGISwapChain4,0x3D585D5A,0xBD4A,0x489E,0xB1,0xF4,0x3D,0xBC,0xB6,0x45,0x2F,0xFB);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIDevice4,0x95B4F95F,0xD8DA,0x4CA4,0x9E,0xE6,0x3B,0x76,0xD5,0x96,0x8A,0x10);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory5,0x7632e1f5,0xee65,0x4dca,0x87,0xfd,0x84,0xcd,0x75,0xf8,0x83,0x8d);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.h new file mode 100644 index 0000000000000000000000000000000000000000..7c704f8a8dceec43f4501d672844d0d90c01e588 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.h @@ -0,0 +1,1637 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + +#ifndef COM_NO_WINDOWS_H +#include "windows.h" +#include "ole2.h" +#endif /*COM_NO_WINDOWS_H*/ + +#ifndef __dxgi1_6_h__ +#define __dxgi1_6_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +#ifndef __IDXGIAdapter4_FWD_DEFINED__ +#define __IDXGIAdapter4_FWD_DEFINED__ +typedef interface IDXGIAdapter4 IDXGIAdapter4; + +#endif /* __IDXGIAdapter4_FWD_DEFINED__ */ + + +#ifndef __IDXGIOutput6_FWD_DEFINED__ +#define __IDXGIOutput6_FWD_DEFINED__ +typedef interface IDXGIOutput6 IDXGIOutput6; + +#endif /* __IDXGIOutput6_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory6_FWD_DEFINED__ +#define __IDXGIFactory6_FWD_DEFINED__ +typedef interface IDXGIFactory6 IDXGIFactory6; + +#endif /* __IDXGIFactory6_FWD_DEFINED__ */ + + +#ifndef __IDXGIFactory7_FWD_DEFINED__ +#define __IDXGIFactory7_FWD_DEFINED__ +typedef interface IDXGIFactory7 IDXGIFactory7; + +#endif /* __IDXGIFactory7_FWD_DEFINED__ */ + + +/* header files for imported files */ +#include "dxgi1_5.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_dxgi1_6_0000_0000 */ +/* [local] */ + +// Copyright (c) Microsoft Corporation. All Rights Reserved +#include +#pragma region App Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) +HRESULT WINAPI DXGIDeclareAdapterRemovalSupport(); +typedef +enum DXGI_ADAPTER_FLAG3 + { + DXGI_ADAPTER_FLAG3_NONE = 0, + DXGI_ADAPTER_FLAG3_REMOTE = 1, + DXGI_ADAPTER_FLAG3_SOFTWARE = 2, + DXGI_ADAPTER_FLAG3_ACG_COMPATIBLE = 4, + DXGI_ADAPTER_FLAG3_SUPPORT_MONITORED_FENCES = 8, + DXGI_ADAPTER_FLAG3_SUPPORT_NON_MONITORED_FENCES = 0x10, + DXGI_ADAPTER_FLAG3_KEYED_MUTEX_CONFORMANCE = 0x20, + DXGI_ADAPTER_FLAG3_FORCE_DWORD = 0xffffffff + } DXGI_ADAPTER_FLAG3; + +DEFINE_ENUM_FLAG_OPERATORS( DXGI_ADAPTER_FLAG3 ); +typedef struct DXGI_ADAPTER_DESC3 + { + WCHAR Description[ 128 ]; + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + LUID AdapterLuid; + DXGI_ADAPTER_FLAG3 Flags; + DXGI_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity; + DXGI_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity; + } DXGI_ADAPTER_DESC3; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0000_v0_0_s_ifspec; + +#ifndef __IDXGIAdapter4_INTERFACE_DEFINED__ +#define __IDXGIAdapter4_INTERFACE_DEFINED__ + +/* interface IDXGIAdapter4 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIAdapter4; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("3c8d99d1-4fbf-4181-a82c-af66bf7bd24e") + IDXGIAdapter4 : public IDXGIAdapter3 + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc3( + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC3 *pDesc) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIAdapter4Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIAdapter4 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIAdapter4 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIAdapter4 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIAdapter, EnumOutputs) + HRESULT ( STDMETHODCALLTYPE *EnumOutputs )( + IDXGIAdapter4 * This, + /* [in] */ UINT Output, + /* [annotation][out][in] */ + _COM_Outptr_ IDXGIOutput **ppOutput); + + DECLSPEC_XFGVIRT(IDXGIAdapter, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIAdapter4 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter, CheckInterfaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckInterfaceSupport )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ REFGUID InterfaceName, + /* [annotation][out] */ + _Out_ LARGE_INTEGER *pUMDVersion); + + DECLSPEC_XFGVIRT(IDXGIAdapter1, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGIAdapter4 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter2, GetDesc2) + HRESULT ( STDMETHODCALLTYPE *GetDesc2 )( + IDXGIAdapter4 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC2 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, RegisterHardwareContentProtectionTeardownStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterHardwareContentProtectionTeardownStatusEvent )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, UnregisterHardwareContentProtectionTeardownStatus) + void ( STDMETHODCALLTYPE *UnregisterHardwareContentProtectionTeardownStatus )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, QueryVideoMemoryInfo) + HRESULT ( STDMETHODCALLTYPE *QueryVideoMemoryInfo )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][out] */ + _Out_ DXGI_QUERY_VIDEO_MEMORY_INFO *pVideoMemoryInfo); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, SetVideoMemoryReservation) + HRESULT ( STDMETHODCALLTYPE *SetVideoMemoryReservation )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ UINT NodeIndex, + /* [annotation][in] */ + _In_ DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup, + /* [annotation][in] */ + _In_ UINT64 Reservation); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, RegisterVideoMemoryBudgetChangeNotificationEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterVideoMemoryBudgetChangeNotificationEvent )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter3, UnregisterVideoMemoryBudgetChangeNotification) + void ( STDMETHODCALLTYPE *UnregisterVideoMemoryBudgetChangeNotification )( + IDXGIAdapter4 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIAdapter4, GetDesc3) + HRESULT ( STDMETHODCALLTYPE *GetDesc3 )( + IDXGIAdapter4 * This, + /* [annotation][out] */ + _Out_ DXGI_ADAPTER_DESC3 *pDesc); + + END_INTERFACE + } IDXGIAdapter4Vtbl; + + interface IDXGIAdapter4 + { + CONST_VTBL struct IDXGIAdapter4Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIAdapter4_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIAdapter4_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIAdapter4_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIAdapter4_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIAdapter4_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIAdapter4_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIAdapter4_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIAdapter4_EnumOutputs(This,Output,ppOutput) \ + ( (This)->lpVtbl -> EnumOutputs(This,Output,ppOutput) ) + +#define IDXGIAdapter4_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIAdapter4_CheckInterfaceSupport(This,InterfaceName,pUMDVersion) \ + ( (This)->lpVtbl -> CheckInterfaceSupport(This,InterfaceName,pUMDVersion) ) + + +#define IDXGIAdapter4_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + + +#define IDXGIAdapter4_GetDesc2(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc2(This,pDesc) ) + + +#define IDXGIAdapter4_RegisterHardwareContentProtectionTeardownStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterHardwareContentProtectionTeardownStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIAdapter4_UnregisterHardwareContentProtectionTeardownStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterHardwareContentProtectionTeardownStatus(This,dwCookie) ) + +#define IDXGIAdapter4_QueryVideoMemoryInfo(This,NodeIndex,MemorySegmentGroup,pVideoMemoryInfo) \ + ( (This)->lpVtbl -> QueryVideoMemoryInfo(This,NodeIndex,MemorySegmentGroup,pVideoMemoryInfo) ) + +#define IDXGIAdapter4_SetVideoMemoryReservation(This,NodeIndex,MemorySegmentGroup,Reservation) \ + ( (This)->lpVtbl -> SetVideoMemoryReservation(This,NodeIndex,MemorySegmentGroup,Reservation) ) + +#define IDXGIAdapter4_RegisterVideoMemoryBudgetChangeNotificationEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterVideoMemoryBudgetChangeNotificationEvent(This,hEvent,pdwCookie) ) + +#define IDXGIAdapter4_UnregisterVideoMemoryBudgetChangeNotification(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterVideoMemoryBudgetChangeNotification(This,dwCookie) ) + + +#define IDXGIAdapter4_GetDesc3(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc3(This,pDesc) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIAdapter4_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_6_0000_0001 */ +/* [local] */ + +typedef struct DXGI_OUTPUT_DESC1 + { + WCHAR DeviceName[ 32 ]; + RECT DesktopCoordinates; + BOOL AttachedToDesktop; + DXGI_MODE_ROTATION Rotation; + HMONITOR Monitor; + UINT BitsPerColor; + DXGI_COLOR_SPACE_TYPE ColorSpace; + FLOAT RedPrimary[ 2 ]; + FLOAT GreenPrimary[ 2 ]; + FLOAT BluePrimary[ 2 ]; + FLOAT WhitePoint[ 2 ]; + FLOAT MinLuminance; + FLOAT MaxLuminance; + FLOAT MaxFullFrameLuminance; + } DXGI_OUTPUT_DESC1; + +typedef +enum DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS + { + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_FULLSCREEN = 1, + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_WINDOWED = 2, + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_CURSOR_STRETCHED = 4 + } DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS; + +DEFINE_ENUM_FLAG_OPERATORS( DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS ); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0001_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0001_v0_0_s_ifspec; + +#ifndef __IDXGIOutput6_INTERFACE_DEFINED__ +#define __IDXGIOutput6_INTERFACE_DEFINED__ + +/* interface IDXGIOutput6 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIOutput6; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("068346e8-aaec-4b84-add7-137f513f77a1") + IDXGIOutput6 : public IDXGIOutput5 + { + public: + virtual HRESULT STDMETHODCALLTYPE GetDesc1( + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC1 *pDesc) = 0; + + virtual HRESULT STDMETHODCALLTYPE CheckHardwareCompositionSupport( + /* [annotation][out] */ + _Out_ UINT *pFlags) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIOutput6Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIOutput6 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIOutput6 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIOutput6 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDesc) + HRESULT ( STDMETHODCALLTYPE *GetDesc )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplayModeList) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList )( + IDXGIOutput6 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput, FindClosestMatchingMode) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput, WaitForVBlank) + HRESULT ( STDMETHODCALLTYPE *WaitForVBlank )( + IDXGIOutput6 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, TakeOwnership) + HRESULT ( STDMETHODCALLTYPE *TakeOwnership )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + BOOL Exclusive); + + DECLSPEC_XFGVIRT(IDXGIOutput, ReleaseOwnership) + void ( STDMETHODCALLTYPE *ReleaseOwnership )( + IDXGIOutput6 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControlCapabilities) + HRESULT ( STDMETHODCALLTYPE *GetGammaControlCapabilities )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL_CAPABILITIES *pGammaCaps); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetGammaControl) + HRESULT ( STDMETHODCALLTYPE *SetGammaControl )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ const DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetGammaControl) + HRESULT ( STDMETHODCALLTYPE *GetGammaControl )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ DXGI_GAMMA_CONTROL *pArray); + + DECLSPEC_XFGVIRT(IDXGIOutput, SetDisplaySurface) + HRESULT ( STDMETHODCALLTYPE *SetDisplaySurface )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pScanoutSurface); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetDisplaySurfaceData) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IDXGISurface *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput, GetFrameStatistics) + HRESULT ( STDMETHODCALLTYPE *GetFrameStatistics )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ DXGI_FRAME_STATISTICS *pStats); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplayModeList1) + HRESULT ( STDMETHODCALLTYPE *GetDisplayModeList1 )( + IDXGIOutput6 * This, + /* [in] */ DXGI_FORMAT EnumFormat, + /* [in] */ UINT Flags, + /* [annotation][out][in] */ + _Inout_ UINT *pNumModes, + /* [annotation][out] */ + _Out_writes_to_opt_(*pNumModes,*pNumModes) DXGI_MODE_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput1, FindClosestMatchingMode1) + HRESULT ( STDMETHODCALLTYPE *FindClosestMatchingMode1 )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ const DXGI_MODE_DESC1 *pModeToMatch, + /* [annotation][out] */ + _Out_ DXGI_MODE_DESC1 *pClosestMatch, + /* [annotation][in] */ + _In_opt_ IUnknown *pConcernedDevice); + + DECLSPEC_XFGVIRT(IDXGIOutput1, GetDisplaySurfaceData1) + HRESULT ( STDMETHODCALLTYPE *GetDisplaySurfaceData1 )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IDXGIResource *pDestination); + + DECLSPEC_XFGVIRT(IDXGIOutput1, DuplicateOutput) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput2, SupportsOverlays) + BOOL ( STDMETHODCALLTYPE *SupportsOverlays )( + IDXGIOutput6 * This); + + DECLSPEC_XFGVIRT(IDXGIOutput3, CheckOverlaySupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlaySupport )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT EnumFormat, + /* [annotation][out] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + DECLSPEC_XFGVIRT(IDXGIOutput4, CheckOverlayColorSpaceSupport) + HRESULT ( STDMETHODCALLTYPE *CheckOverlayColorSpaceSupport )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ DXGI_FORMAT Format, + /* [annotation][in] */ + _In_ DXGI_COLOR_SPACE_TYPE ColorSpace, + /* [annotation][in] */ + _In_ IUnknown *pConcernedDevice, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + DECLSPEC_XFGVIRT(IDXGIOutput5, DuplicateOutput1) + HRESULT ( STDMETHODCALLTYPE *DuplicateOutput1 )( + IDXGIOutput6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [in] */ UINT Flags, + /* [annotation][in] */ + _In_ UINT SupportedFormatsCount, + /* [annotation][in] */ + _In_reads_(SupportedFormatsCount) const DXGI_FORMAT *pSupportedFormats, + /* [annotation][out] */ + _COM_Outptr_ IDXGIOutputDuplication **ppOutputDuplication); + + DECLSPEC_XFGVIRT(IDXGIOutput6, GetDesc1) + HRESULT ( STDMETHODCALLTYPE *GetDesc1 )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ DXGI_OUTPUT_DESC1 *pDesc); + + DECLSPEC_XFGVIRT(IDXGIOutput6, CheckHardwareCompositionSupport) + HRESULT ( STDMETHODCALLTYPE *CheckHardwareCompositionSupport )( + IDXGIOutput6 * This, + /* [annotation][out] */ + _Out_ UINT *pFlags); + + END_INTERFACE + } IDXGIOutput6Vtbl; + + interface IDXGIOutput6 + { + CONST_VTBL struct IDXGIOutput6Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIOutput6_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIOutput6_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIOutput6_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIOutput6_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIOutput6_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIOutput6_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIOutput6_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIOutput6_GetDesc(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc(This,pDesc) ) + +#define IDXGIOutput6_GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput6_FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput6_WaitForVBlank(This) \ + ( (This)->lpVtbl -> WaitForVBlank(This) ) + +#define IDXGIOutput6_TakeOwnership(This,pDevice,Exclusive) \ + ( (This)->lpVtbl -> TakeOwnership(This,pDevice,Exclusive) ) + +#define IDXGIOutput6_ReleaseOwnership(This) \ + ( (This)->lpVtbl -> ReleaseOwnership(This) ) + +#define IDXGIOutput6_GetGammaControlCapabilities(This,pGammaCaps) \ + ( (This)->lpVtbl -> GetGammaControlCapabilities(This,pGammaCaps) ) + +#define IDXGIOutput6_SetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> SetGammaControl(This,pArray) ) + +#define IDXGIOutput6_GetGammaControl(This,pArray) \ + ( (This)->lpVtbl -> GetGammaControl(This,pArray) ) + +#define IDXGIOutput6_SetDisplaySurface(This,pScanoutSurface) \ + ( (This)->lpVtbl -> SetDisplaySurface(This,pScanoutSurface) ) + +#define IDXGIOutput6_GetDisplaySurfaceData(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData(This,pDestination) ) + +#define IDXGIOutput6_GetFrameStatistics(This,pStats) \ + ( (This)->lpVtbl -> GetFrameStatistics(This,pStats) ) + + +#define IDXGIOutput6_GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) \ + ( (This)->lpVtbl -> GetDisplayModeList1(This,EnumFormat,Flags,pNumModes,pDesc) ) + +#define IDXGIOutput6_FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) \ + ( (This)->lpVtbl -> FindClosestMatchingMode1(This,pModeToMatch,pClosestMatch,pConcernedDevice) ) + +#define IDXGIOutput6_GetDisplaySurfaceData1(This,pDestination) \ + ( (This)->lpVtbl -> GetDisplaySurfaceData1(This,pDestination) ) + +#define IDXGIOutput6_DuplicateOutput(This,pDevice,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput(This,pDevice,ppOutputDuplication) ) + + +#define IDXGIOutput6_SupportsOverlays(This) \ + ( (This)->lpVtbl -> SupportsOverlays(This) ) + + +#define IDXGIOutput6_CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlaySupport(This,EnumFormat,pConcernedDevice,pFlags) ) + + +#define IDXGIOutput6_CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) \ + ( (This)->lpVtbl -> CheckOverlayColorSpaceSupport(This,Format,ColorSpace,pConcernedDevice,pFlags) ) + + +#define IDXGIOutput6_DuplicateOutput1(This,pDevice,Flags,SupportedFormatsCount,pSupportedFormats,ppOutputDuplication) \ + ( (This)->lpVtbl -> DuplicateOutput1(This,pDevice,Flags,SupportedFormatsCount,pSupportedFormats,ppOutputDuplication) ) + + +#define IDXGIOutput6_GetDesc1(This,pDesc) \ + ( (This)->lpVtbl -> GetDesc1(This,pDesc) ) + +#define IDXGIOutput6_CheckHardwareCompositionSupport(This,pFlags) \ + ( (This)->lpVtbl -> CheckHardwareCompositionSupport(This,pFlags) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIOutput6_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_6_0000_0002 */ +/* [local] */ + +typedef +enum DXGI_GPU_PREFERENCE + { + DXGI_GPU_PREFERENCE_UNSPECIFIED = 0, + DXGI_GPU_PREFERENCE_MINIMUM_POWER = ( DXGI_GPU_PREFERENCE_UNSPECIFIED + 1 ) , + DXGI_GPU_PREFERENCE_HIGH_PERFORMANCE = ( DXGI_GPU_PREFERENCE_MINIMUM_POWER + 1 ) + } DXGI_GPU_PREFERENCE; + + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0002_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0002_v0_0_s_ifspec; + +#ifndef __IDXGIFactory6_INTERFACE_DEFINED__ +#define __IDXGIFactory6_INTERFACE_DEFINED__ + +/* interface IDXGIFactory6 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory6; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("c1b6694f-ff09-44a9-b03c-77900a0a1d17") + IDXGIFactory6 : public IDXGIFactory5 + { + public: + virtual HRESULT STDMETHODCALLTYPE EnumAdapterByGpuPreference( + /* [annotation] */ + _In_ UINT Adapter, + /* [annotation] */ + _In_ DXGI_GPU_PREFERENCE GpuPreference, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory6Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory6 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory6 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory6 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory6 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory6 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory6 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory6 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory6 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory6 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory6 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory6 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory6 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory3, GetCreationFlags) + UINT ( STDMETHODCALLTYPE *GetCreationFlags )( + IDXGIFactory6 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumAdapterByLuid) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByLuid )( + IDXGIFactory6 * This, + /* [annotation] */ + _In_ LUID AdapterLuid, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumWarpAdapter) + HRESULT ( STDMETHODCALLTYPE *EnumWarpAdapter )( + IDXGIFactory6 * This, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory5, CheckFeatureSupport) + HRESULT ( STDMETHODCALLTYPE *CheckFeatureSupport )( + IDXGIFactory6 * This, + DXGI_FEATURE Feature, + /* [annotation] */ + _Inout_updates_bytes_(FeatureSupportDataSize) void *pFeatureSupportData, + UINT FeatureSupportDataSize); + + DECLSPEC_XFGVIRT(IDXGIFactory6, EnumAdapterByGpuPreference) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByGpuPreference )( + IDXGIFactory6 * This, + /* [annotation] */ + _In_ UINT Adapter, + /* [annotation] */ + _In_ DXGI_GPU_PREFERENCE GpuPreference, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + END_INTERFACE + } IDXGIFactory6Vtbl; + + interface IDXGIFactory6 + { + CONST_VTBL struct IDXGIFactory6Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory6_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory6_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory6_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory6_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory6_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory6_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory6_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory6_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory6_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory6_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory6_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory6_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory6_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory6_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory6_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory6_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory6_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory6_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory6_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory6_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory6_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory6_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory6_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory6_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory6_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + + +#define IDXGIFactory6_GetCreationFlags(This) \ + ( (This)->lpVtbl -> GetCreationFlags(This) ) + + +#define IDXGIFactory6_EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) ) + +#define IDXGIFactory6_EnumWarpAdapter(This,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumWarpAdapter(This,riid,ppvAdapter) ) + + +#define IDXGIFactory6_CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) \ + ( (This)->lpVtbl -> CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) ) + + +#define IDXGIFactory6_EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory6_INTERFACE_DEFINED__ */ + + +#ifndef __IDXGIFactory7_INTERFACE_DEFINED__ +#define __IDXGIFactory7_INTERFACE_DEFINED__ + +/* interface IDXGIFactory7 */ +/* [unique][local][uuid][object] */ + + +EXTERN_C const IID IID_IDXGIFactory7; + +#if defined(__cplusplus) && !defined(CINTERFACE) + + MIDL_INTERFACE("a4966eed-76db-44da-84c1-ee9a7afb20a8") + IDXGIFactory7 : public IDXGIFactory6 + { + public: + virtual HRESULT STDMETHODCALLTYPE RegisterAdaptersChangedEvent( + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie) = 0; + + virtual HRESULT STDMETHODCALLTYPE UnregisterAdaptersChangedEvent( + /* [annotation][in] */ + _In_ DWORD dwCookie) = 0; + + }; + + +#else /* C style interface */ + + typedef struct IDXGIFactory7Vtbl + { + BEGIN_INTERFACE + + DECLSPEC_XFGVIRT(IUnknown, QueryInterface) + HRESULT ( STDMETHODCALLTYPE *QueryInterface )( + IDXGIFactory7 * This, + /* [in] */ REFIID riid, + /* [annotation][iid_is][out] */ + _COM_Outptr_ void **ppvObject); + + DECLSPEC_XFGVIRT(IUnknown, AddRef) + ULONG ( STDMETHODCALLTYPE *AddRef )( + IDXGIFactory7 * This); + + DECLSPEC_XFGVIRT(IUnknown, Release) + ULONG ( STDMETHODCALLTYPE *Release )( + IDXGIFactory7 * This); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateData) + HRESULT ( STDMETHODCALLTYPE *SetPrivateData )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [in] */ UINT DataSize, + /* [annotation][in] */ + _In_reads_bytes_(DataSize) const void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, SetPrivateDataInterface) + HRESULT ( STDMETHODCALLTYPE *SetPrivateDataInterface )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][in] */ + _In_opt_ const IUnknown *pUnknown); + + DECLSPEC_XFGVIRT(IDXGIObject, GetPrivateData) + HRESULT ( STDMETHODCALLTYPE *GetPrivateData )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ REFGUID Name, + /* [annotation][out][in] */ + _Inout_ UINT *pDataSize, + /* [annotation][out] */ + _Out_writes_bytes_(*pDataSize) void *pData); + + DECLSPEC_XFGVIRT(IDXGIObject, GetParent) + HRESULT ( STDMETHODCALLTYPE *GetParent )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ REFIID riid, + /* [annotation][retval][out] */ + _COM_Outptr_ void **ppParent); + + DECLSPEC_XFGVIRT(IDXGIFactory, EnumAdapters) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters )( + IDXGIFactory7 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory, MakeWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *MakeWindowAssociation )( + IDXGIFactory7 * This, + HWND WindowHandle, + UINT Flags); + + DECLSPEC_XFGVIRT(IDXGIFactory, GetWindowAssociation) + HRESULT ( STDMETHODCALLTYPE *GetWindowAssociation )( + IDXGIFactory7 * This, + /* [annotation][out] */ + _Out_ HWND *pWindowHandle); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSwapChain) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChain )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ DXGI_SWAP_CHAIN_DESC *pDesc, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory, CreateSoftwareAdapter) + HRESULT ( STDMETHODCALLTYPE *CreateSoftwareAdapter )( + IDXGIFactory7 * This, + /* [in] */ HMODULE Module, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, EnumAdapters1) + HRESULT ( STDMETHODCALLTYPE *EnumAdapters1 )( + IDXGIFactory7 * This, + /* [in] */ UINT Adapter, + /* [annotation][out] */ + _COM_Outptr_ IDXGIAdapter1 **ppAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory1, IsCurrent) + BOOL ( STDMETHODCALLTYPE *IsCurrent )( + IDXGIFactory7 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, IsWindowedStereoEnabled) + BOOL ( STDMETHODCALLTYPE *IsWindowedStereoEnabled )( + IDXGIFactory7 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForHwnd) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForHwnd )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ HWND hWnd, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ const DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pFullscreenDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForCoreWindow) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForCoreWindow )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ IUnknown *pWindow, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory2, GetSharedResourceAdapterLuid) + HRESULT ( STDMETHODCALLTYPE *GetSharedResourceAdapterLuid )( + IDXGIFactory7 * This, + /* [annotation] */ + _In_ HANDLE hResource, + /* [annotation] */ + _Out_ LUID *pLuid); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusWindow )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterStereoStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterStereoStatusEvent )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterStereoStatus) + void ( STDMETHODCALLTYPE *UnregisterStereoStatus )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusWindow) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusWindow )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ HWND WindowHandle, + /* [annotation][in] */ + _In_ UINT wMsg, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, RegisterOcclusionStatusEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterOcclusionStatusEvent )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, UnregisterOcclusionStatus) + void ( STDMETHODCALLTYPE *UnregisterOcclusionStatus )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory2, CreateSwapChainForComposition) + HRESULT ( STDMETHODCALLTYPE *CreateSwapChainForComposition )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ IUnknown *pDevice, + /* [annotation][in] */ + _In_ const DXGI_SWAP_CHAIN_DESC1 *pDesc, + /* [annotation][in] */ + _In_opt_ IDXGIOutput *pRestrictToOutput, + /* [annotation][out] */ + _COM_Outptr_ IDXGISwapChain1 **ppSwapChain); + + DECLSPEC_XFGVIRT(IDXGIFactory3, GetCreationFlags) + UINT ( STDMETHODCALLTYPE *GetCreationFlags )( + IDXGIFactory7 * This); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumAdapterByLuid) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByLuid )( + IDXGIFactory7 * This, + /* [annotation] */ + _In_ LUID AdapterLuid, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory4, EnumWarpAdapter) + HRESULT ( STDMETHODCALLTYPE *EnumWarpAdapter )( + IDXGIFactory7 * This, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory5, CheckFeatureSupport) + HRESULT ( STDMETHODCALLTYPE *CheckFeatureSupport )( + IDXGIFactory7 * This, + DXGI_FEATURE Feature, + /* [annotation] */ + _Inout_updates_bytes_(FeatureSupportDataSize) void *pFeatureSupportData, + UINT FeatureSupportDataSize); + + DECLSPEC_XFGVIRT(IDXGIFactory6, EnumAdapterByGpuPreference) + HRESULT ( STDMETHODCALLTYPE *EnumAdapterByGpuPreference )( + IDXGIFactory7 * This, + /* [annotation] */ + _In_ UINT Adapter, + /* [annotation] */ + _In_ DXGI_GPU_PREFERENCE GpuPreference, + /* [annotation] */ + _In_ REFIID riid, + /* [annotation] */ + _COM_Outptr_ void **ppvAdapter); + + DECLSPEC_XFGVIRT(IDXGIFactory7, RegisterAdaptersChangedEvent) + HRESULT ( STDMETHODCALLTYPE *RegisterAdaptersChangedEvent )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ HANDLE hEvent, + /* [annotation][out] */ + _Out_ DWORD *pdwCookie); + + DECLSPEC_XFGVIRT(IDXGIFactory7, UnregisterAdaptersChangedEvent) + HRESULT ( STDMETHODCALLTYPE *UnregisterAdaptersChangedEvent )( + IDXGIFactory7 * This, + /* [annotation][in] */ + _In_ DWORD dwCookie); + + END_INTERFACE + } IDXGIFactory7Vtbl; + + interface IDXGIFactory7 + { + CONST_VTBL struct IDXGIFactory7Vtbl *lpVtbl; + }; + + + +#ifdef COBJMACROS + + +#define IDXGIFactory7_QueryInterface(This,riid,ppvObject) \ + ( (This)->lpVtbl -> QueryInterface(This,riid,ppvObject) ) + +#define IDXGIFactory7_AddRef(This) \ + ( (This)->lpVtbl -> AddRef(This) ) + +#define IDXGIFactory7_Release(This) \ + ( (This)->lpVtbl -> Release(This) ) + + +#define IDXGIFactory7_SetPrivateData(This,Name,DataSize,pData) \ + ( (This)->lpVtbl -> SetPrivateData(This,Name,DataSize,pData) ) + +#define IDXGIFactory7_SetPrivateDataInterface(This,Name,pUnknown) \ + ( (This)->lpVtbl -> SetPrivateDataInterface(This,Name,pUnknown) ) + +#define IDXGIFactory7_GetPrivateData(This,Name,pDataSize,pData) \ + ( (This)->lpVtbl -> GetPrivateData(This,Name,pDataSize,pData) ) + +#define IDXGIFactory7_GetParent(This,riid,ppParent) \ + ( (This)->lpVtbl -> GetParent(This,riid,ppParent) ) + + +#define IDXGIFactory7_EnumAdapters(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters(This,Adapter,ppAdapter) ) + +#define IDXGIFactory7_MakeWindowAssociation(This,WindowHandle,Flags) \ + ( (This)->lpVtbl -> MakeWindowAssociation(This,WindowHandle,Flags) ) + +#define IDXGIFactory7_GetWindowAssociation(This,pWindowHandle) \ + ( (This)->lpVtbl -> GetWindowAssociation(This,pWindowHandle) ) + +#define IDXGIFactory7_CreateSwapChain(This,pDevice,pDesc,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChain(This,pDevice,pDesc,ppSwapChain) ) + +#define IDXGIFactory7_CreateSoftwareAdapter(This,Module,ppAdapter) \ + ( (This)->lpVtbl -> CreateSoftwareAdapter(This,Module,ppAdapter) ) + + +#define IDXGIFactory7_EnumAdapters1(This,Adapter,ppAdapter) \ + ( (This)->lpVtbl -> EnumAdapters1(This,Adapter,ppAdapter) ) + +#define IDXGIFactory7_IsCurrent(This) \ + ( (This)->lpVtbl -> IsCurrent(This) ) + + +#define IDXGIFactory7_IsWindowedStereoEnabled(This) \ + ( (This)->lpVtbl -> IsWindowedStereoEnabled(This) ) + +#define IDXGIFactory7_CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForHwnd(This,pDevice,hWnd,pDesc,pFullscreenDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory7_CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForCoreWindow(This,pDevice,pWindow,pDesc,pRestrictToOutput,ppSwapChain) ) + +#define IDXGIFactory7_GetSharedResourceAdapterLuid(This,hResource,pLuid) \ + ( (This)->lpVtbl -> GetSharedResourceAdapterLuid(This,hResource,pLuid) ) + +#define IDXGIFactory7_RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory7_RegisterStereoStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterStereoStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory7_UnregisterStereoStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterStereoStatus(This,dwCookie) ) + +#define IDXGIFactory7_RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusWindow(This,WindowHandle,wMsg,pdwCookie) ) + +#define IDXGIFactory7_RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterOcclusionStatusEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory7_UnregisterOcclusionStatus(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterOcclusionStatus(This,dwCookie) ) + +#define IDXGIFactory7_CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) \ + ( (This)->lpVtbl -> CreateSwapChainForComposition(This,pDevice,pDesc,pRestrictToOutput,ppSwapChain) ) + + +#define IDXGIFactory7_GetCreationFlags(This) \ + ( (This)->lpVtbl -> GetCreationFlags(This) ) + + +#define IDXGIFactory7_EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByLuid(This,AdapterLuid,riid,ppvAdapter) ) + +#define IDXGIFactory7_EnumWarpAdapter(This,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumWarpAdapter(This,riid,ppvAdapter) ) + + +#define IDXGIFactory7_CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) \ + ( (This)->lpVtbl -> CheckFeatureSupport(This,Feature,pFeatureSupportData,FeatureSupportDataSize) ) + + +#define IDXGIFactory7_EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter) \ + ( (This)->lpVtbl -> EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter) ) + + +#define IDXGIFactory7_RegisterAdaptersChangedEvent(This,hEvent,pdwCookie) \ + ( (This)->lpVtbl -> RegisterAdaptersChangedEvent(This,hEvent,pdwCookie) ) + +#define IDXGIFactory7_UnregisterAdaptersChangedEvent(This,dwCookie) \ + ( (This)->lpVtbl -> UnregisterAdaptersChangedEvent(This,dwCookie) ) + +#endif /* COBJMACROS */ + + +#endif /* C style interface */ + + + + +#endif /* __IDXGIFactory7_INTERFACE_DEFINED__ */ + + +/* interface __MIDL_itf_dxgi1_6_0000_0004 */ +/* [local] */ + +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +HRESULT WINAPI DXGIDisableVBlankVirtualization(); +#endif +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion +DEFINE_GUID(IID_IDXGIAdapter4,0x3c8d99d1,0x4fbf,0x4181,0xa8,0x2c,0xaf,0x66,0xbf,0x7b,0xd2,0x4e); +DEFINE_GUID(IID_IDXGIOutput6,0x068346e8,0xaaec,0x4b84,0xad,0xd7,0x13,0x7f,0x51,0x3f,0x77,0xa1); +DEFINE_GUID(IID_IDXGIFactory6,0xc1b6694f,0xff09,0x44a9,0xb0,0x3c,0x77,0x90,0x0a,0x0a,0x1d,0x17); +DEFINE_GUID(IID_IDXGIFactory7,0xa4966eed,0x76db,0x44da,0x84,0xc1,0xee,0x9a,0x7a,0xfb,0x20,0xa8); + + +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0004_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_dxgi1_6_0000_0004_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.idl new file mode 100644 index 0000000000000000000000000000000000000000..6b9879bd3cbbf9ccde8f2bc5d4222de709712eed --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgi1_6.idl @@ -0,0 +1,193 @@ +// Copyright (c) Microsoft Corporation. All Rights Reserved +cpp_quote("// Copyright (c) Microsoft Corporation. All Rights Reserved") + +import "dxgi1_5.idl"; + +cpp_quote("#include ") + +#pragma region App Family +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES)") + +cpp_quote( "HRESULT WINAPI DXGIDeclareAdapterRemovalSupport();" ) + +typedef enum DXGI_ADAPTER_FLAG3 +{ + DXGI_ADAPTER_FLAG3_NONE = 0, + DXGI_ADAPTER_FLAG3_REMOTE = 1, + DXGI_ADAPTER_FLAG3_SOFTWARE = 2, + DXGI_ADAPTER_FLAG3_ACG_COMPATIBLE = 4, + DXGI_ADAPTER_FLAG3_SUPPORT_MONITORED_FENCES = 8, + DXGI_ADAPTER_FLAG3_SUPPORT_NON_MONITORED_FENCES = 0x10, + DXGI_ADAPTER_FLAG3_KEYED_MUTEX_CONFORMANCE = 0x20, + DXGI_ADAPTER_FLAG3_FORCE_DWORD = 0xFFFFFFFF, +} DXGI_ADAPTER_FLAG3; +cpp_quote( "DEFINE_ENUM_FLAG_OPERATORS( DXGI_ADAPTER_FLAG3 );" ) + +typedef struct DXGI_ADAPTER_DESC3 +{ + WCHAR Description[128]; + + UINT VendorId; + UINT DeviceId; + UINT SubSysId; + UINT Revision; + + SIZE_T DedicatedVideoMemory; + SIZE_T DedicatedSystemMemory; + SIZE_T SharedSystemMemory; + + LUID AdapterLuid; + + DXGI_ADAPTER_FLAG3 Flags; + + DXGI_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity; + DXGI_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity; +} DXGI_ADAPTER_DESC3; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIAdapter4 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(3c8d99d1-4fbf-4181-a82c-af66bf7bd24e), + local, + pointer_default(unique) +] +interface IDXGIAdapter4 : + IDXGIAdapter3 +{ + HRESULT GetDesc3( [out, annotation("_Out_")] DXGI_ADAPTER_DESC3 *pDesc); +}; + +//-------------------------------------------------------------------------------------------------------- +typedef struct DXGI_OUTPUT_DESC1 +{ + // Device name for GDI (ex. \\.\DISPLAY1) + WCHAR DeviceName[32]; + RECT DesktopCoordinates; + BOOL AttachedToDesktop; + DXGI_MODE_ROTATION Rotation; + HMONITOR Monitor; + + // Number of bits per color channel being + // used for scanout on this output + UINT BitsPerColor; + + // Represents whether the current OS state can take + // advantage of color values larger than sRGB and also + // specifies if there is any headroom + DXGI_COLOR_SPACE_TYPE ColorSpace; + + // Color primaries of this output in xy coordinates + FLOAT RedPrimary[2]; + FLOAT GreenPrimary[2]; + FLOAT BluePrimary[2]; + + // White point of this output in xy coordinates + FLOAT WhitePoint[2]; + + // Minimum luminance supported on this output in nits + FLOAT MinLuminance; + + // Maximum peak luminance supported on this output + // in nits; usually only possible on a small fraction + // of the display + FLOAT MaxLuminance; + + // Maximum average luminance supported on this + // output in nits; valid for the full frame of the + // display + FLOAT MaxFullFrameLuminance; +} DXGI_OUTPUT_DESC1; + +//-------------------------------------------------------------------------------------------------------- +typedef enum DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS +{ + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_FULLSCREEN = 1, + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_WINDOWED = 2, + DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAG_CURSOR_STRETCHED = 4, +} DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS; +cpp_quote("DEFINE_ENUM_FLAG_OPERATORS( DXGI_HARDWARE_COMPOSITION_SUPPORT_FLAGS );") + +//-------------------------------------------------------------------------------------------------------- +// IDXGIOutput6 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(068346e8-aaec-4b84-add7-137f513f77a1), + local, + pointer_default(unique) +] +interface IDXGIOutput6 : + IDXGIOutput5 +{ + HRESULT GetDesc1([out, annotation("_Out_")] DXGI_OUTPUT_DESC1 *pDesc); + HRESULT CheckHardwareCompositionSupport([out, annotation("_Out_")] UINT* pFlags); +}; + +//+----------------------------------------------------------------------------- +// +// Enum for GPU Preference categories +// +//------------------------------------------------------------------------------ +typedef enum DXGI_GPU_PREFERENCE +{ + DXGI_GPU_PREFERENCE_UNSPECIFIED = 0, + DXGI_GPU_PREFERENCE_MINIMUM_POWER, + DXGI_GPU_PREFERENCE_HIGH_PERFORMANCE, + +} DXGI_GPU_PREFERENCE; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory6 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(c1b6694f-ff09-44a9-b03c-77900a0a1d17), + local, + pointer_default(unique) +] +interface IDXGIFactory6 : + IDXGIFactory5 +{ + HRESULT EnumAdapterByGpuPreference( + [annotation("_In_")] UINT Adapter, + [annotation("_In_")] DXGI_GPU_PREFERENCE GpuPreference, + [annotation("_In_")] REFIID riid, + [annotation("_COM_Outptr_")] void** ppvAdapter + ); +}; + +//-------------------------------------------------------------------------------------------------------- +// IDXGIFactory7 interface +//-------------------------------------------------------------------------------------------------------- +[ + object, + uuid(a4966eed-76db-44da-84c1-ee9a7afb20a8), + local, + pointer_default(unique) +] +interface IDXGIFactory7 : + IDXGIFactory6 +{ + HRESULT RegisterAdaptersChangedEvent( + [in, annotation("_In_")] HANDLE hEvent, + [out, annotation("_Out_")] DWORD *pdwCookie + ); + + HRESULT UnregisterAdaptersChangedEvent([in, annotation("_In_")] DWORD dwCookie); +}; + +//-------------------------------------------------------------------------------------------------------- + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_NI)" ) +cpp_quote( "HRESULT WINAPI DXGIDisableVBlankVirtualization();" ) +cpp_quote("#endif" ) + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */") +#pragma endregion + +cpp_quote( "DEFINE_GUID(IID_IDXGIAdapter4,0x3c8d99d1,0x4fbf,0x4181,0xa8,0x2c,0xaf,0x66,0xbf,0x7b,0xd2,0x4e);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIOutput6,0x068346e8,0xaaec,0x4b84,0xad,0xd7,0x13,0x7f,0x51,0x3f,0x77,0xa1);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory6,0xc1b6694f,0xff09,0x44a9,0xb0,0x3c,0x77,0x90,0x0a,0x0a,0x1d,0x17);" ) +cpp_quote( "DEFINE_GUID(IID_IDXGIFactory7,0xa4966eed,0x76db,0x44da,0x84,0xc1,0xee,0x9a,0x7a,0xfb,0x20,0xa8);" ) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.h new file mode 100644 index 0000000000000000000000000000000000000000..2ecad0e542e848b2df0072374f3bf020fb602d2b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.h @@ -0,0 +1,58 @@ +// +// Copyright (C) Microsoft Corporation. +// Licensed under the MIT license +// + +#ifndef __dxgicommon_h__ +#define __dxgicommon_h__ + + + +typedef struct DXGI_RATIONAL +{ + UINT Numerator; + UINT Denominator; +} DXGI_RATIONAL; + +// The following values are used with DXGI_SAMPLE_DESC::Quality: +#define DXGI_STANDARD_MULTISAMPLE_QUALITY_PATTERN 0xffffffff +#define DXGI_CENTER_MULTISAMPLE_QUALITY_PATTERN 0xfffffffe + +typedef struct DXGI_SAMPLE_DESC +{ + UINT Count; + UINT Quality; +} DXGI_SAMPLE_DESC; + +typedef enum DXGI_COLOR_SPACE_TYPE +{ + DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 = 0, + DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 = 1, + DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P709 = 2, + DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P2020 = 3, + DXGI_COLOR_SPACE_RESERVED = 4, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601 = 5, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 = 6, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P601 = 7, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 = 8, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P709 = 9, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020 = 10, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020 = 11, + DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 = 12, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_LEFT_P2020 = 13, + DXGI_COLOR_SPACE_RGB_STUDIO_G2084_NONE_P2020 = 14, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_TOPLEFT_P2020 = 15, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_TOPLEFT_P2020 = 16, + DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P2020 = 17, + DXGI_COLOR_SPACE_YCBCR_STUDIO_GHLG_TOPLEFT_P2020 = 18, + DXGI_COLOR_SPACE_YCBCR_FULL_GHLG_TOPLEFT_P2020 = 19, + DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P709 = 20, + DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P2020 = 21, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P709 = 22, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P2020 = 23, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_TOPLEFT_P2020 = 24, + DXGI_COLOR_SPACE_CUSTOM = 0xFFFFFFFF +} DXGI_COLOR_SPACE_TYPE; + +#endif // __dxgicommon_h__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.idl new file mode 100644 index 0000000000000000000000000000000000000000..045131d0775c054ae7e8c148a90d1dfeb16eedfd --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgicommon.idl @@ -0,0 +1,54 @@ +// +// Copyright (C) Microsoft Corporation. +// Licensed under the MIT license +// + + +import "ocidl.idl"; + +typedef struct DXGI_RATIONAL +{ + UINT Numerator; + UINT Denominator; +} DXGI_RATIONAL; + +// The following values are used with DXGI_SAMPLE_DESC::Quality: +#define DXGI_STANDARD_MULTISAMPLE_QUALITY_PATTERN 0xffffffff +#define DXGI_CENTER_MULTISAMPLE_QUALITY_PATTERN 0xfffffffe + +typedef struct DXGI_SAMPLE_DESC +{ + UINT Count; + UINT Quality; +} DXGI_SAMPLE_DESC; + +typedef enum DXGI_COLOR_SPACE_TYPE +{ + DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 = 0, + DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 = 1, + DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P709 = 2, + DXGI_COLOR_SPACE_RGB_STUDIO_G22_NONE_P2020 = 3, + DXGI_COLOR_SPACE_RESERVED = 4, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_NONE_P709_X601 = 5, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P601 = 6, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P601 = 7, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P709 = 8, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P709 = 9, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_LEFT_P2020 = 10, + DXGI_COLOR_SPACE_YCBCR_FULL_G22_LEFT_P2020 = 11, + DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 = 12, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_LEFT_P2020 = 13, + DXGI_COLOR_SPACE_RGB_STUDIO_G2084_NONE_P2020 = 14, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G22_TOPLEFT_P2020 = 15, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G2084_TOPLEFT_P2020 = 16, + DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P2020 = 17, + DXGI_COLOR_SPACE_YCBCR_STUDIO_GHLG_TOPLEFT_P2020 = 18, + DXGI_COLOR_SPACE_YCBCR_FULL_GHLG_TOPLEFT_P2020 = 19, + DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P709 = 20, + DXGI_COLOR_SPACE_RGB_STUDIO_G24_NONE_P2020 = 21, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P709 = 22, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_LEFT_P2020 = 23, + DXGI_COLOR_SPACE_YCBCR_STUDIO_G24_TOPLEFT_P2020 = 24, + DXGI_COLOR_SPACE_CUSTOM = 0xFFFFFFFF +} DXGI_COLOR_SPACE_TYPE; + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.h new file mode 100644 index 0000000000000000000000000000000000000000..28f087f6594d204f66d1d3174b033933e7877eda --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.h @@ -0,0 +1,144 @@ +// +// Copyright (C) Microsoft Corporation. +// Licensed under the MIT license +// + +#ifndef __dxgiformat_h__ +#define __dxgiformat_h__ + +#define DXGI_FORMAT_DEFINED 1 + +typedef enum DXGI_FORMAT +{ + DXGI_FORMAT_UNKNOWN = 0, + DXGI_FORMAT_R32G32B32A32_TYPELESS = 1, + DXGI_FORMAT_R32G32B32A32_FLOAT = 2, + DXGI_FORMAT_R32G32B32A32_UINT = 3, + DXGI_FORMAT_R32G32B32A32_SINT = 4, + DXGI_FORMAT_R32G32B32_TYPELESS = 5, + DXGI_FORMAT_R32G32B32_FLOAT = 6, + DXGI_FORMAT_R32G32B32_UINT = 7, + DXGI_FORMAT_R32G32B32_SINT = 8, + DXGI_FORMAT_R16G16B16A16_TYPELESS = 9, + DXGI_FORMAT_R16G16B16A16_FLOAT = 10, + DXGI_FORMAT_R16G16B16A16_UNORM = 11, + DXGI_FORMAT_R16G16B16A16_UINT = 12, + DXGI_FORMAT_R16G16B16A16_SNORM = 13, + DXGI_FORMAT_R16G16B16A16_SINT = 14, + DXGI_FORMAT_R32G32_TYPELESS = 15, + DXGI_FORMAT_R32G32_FLOAT = 16, + DXGI_FORMAT_R32G32_UINT = 17, + DXGI_FORMAT_R32G32_SINT = 18, + DXGI_FORMAT_R32G8X24_TYPELESS = 19, + DXGI_FORMAT_D32_FLOAT_S8X24_UINT = 20, + DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS = 21, + DXGI_FORMAT_X32_TYPELESS_G8X24_UINT = 22, + DXGI_FORMAT_R10G10B10A2_TYPELESS = 23, + DXGI_FORMAT_R10G10B10A2_UNORM = 24, + DXGI_FORMAT_R10G10B10A2_UINT = 25, + DXGI_FORMAT_R11G11B10_FLOAT = 26, + DXGI_FORMAT_R8G8B8A8_TYPELESS = 27, + DXGI_FORMAT_R8G8B8A8_UNORM = 28, + DXGI_FORMAT_R8G8B8A8_UNORM_SRGB = 29, + DXGI_FORMAT_R8G8B8A8_UINT = 30, + DXGI_FORMAT_R8G8B8A8_SNORM = 31, + DXGI_FORMAT_R8G8B8A8_SINT = 32, + DXGI_FORMAT_R16G16_TYPELESS = 33, + DXGI_FORMAT_R16G16_FLOAT = 34, + DXGI_FORMAT_R16G16_UNORM = 35, + DXGI_FORMAT_R16G16_UINT = 36, + DXGI_FORMAT_R16G16_SNORM = 37, + DXGI_FORMAT_R16G16_SINT = 38, + DXGI_FORMAT_R32_TYPELESS = 39, + DXGI_FORMAT_D32_FLOAT = 40, + DXGI_FORMAT_R32_FLOAT = 41, + DXGI_FORMAT_R32_UINT = 42, + DXGI_FORMAT_R32_SINT = 43, + DXGI_FORMAT_R24G8_TYPELESS = 44, + DXGI_FORMAT_D24_UNORM_S8_UINT = 45, + DXGI_FORMAT_R24_UNORM_X8_TYPELESS = 46, + DXGI_FORMAT_X24_TYPELESS_G8_UINT = 47, + DXGI_FORMAT_R8G8_TYPELESS = 48, + DXGI_FORMAT_R8G8_UNORM = 49, + DXGI_FORMAT_R8G8_UINT = 50, + DXGI_FORMAT_R8G8_SNORM = 51, + DXGI_FORMAT_R8G8_SINT = 52, + DXGI_FORMAT_R16_TYPELESS = 53, + DXGI_FORMAT_R16_FLOAT = 54, + DXGI_FORMAT_D16_UNORM = 55, + DXGI_FORMAT_R16_UNORM = 56, + DXGI_FORMAT_R16_UINT = 57, + DXGI_FORMAT_R16_SNORM = 58, + DXGI_FORMAT_R16_SINT = 59, + DXGI_FORMAT_R8_TYPELESS = 60, + DXGI_FORMAT_R8_UNORM = 61, + DXGI_FORMAT_R8_UINT = 62, + DXGI_FORMAT_R8_SNORM = 63, + DXGI_FORMAT_R8_SINT = 64, + DXGI_FORMAT_A8_UNORM = 65, + DXGI_FORMAT_R1_UNORM = 66, + DXGI_FORMAT_R9G9B9E5_SHAREDEXP = 67, + DXGI_FORMAT_R8G8_B8G8_UNORM = 68, + DXGI_FORMAT_G8R8_G8B8_UNORM = 69, + DXGI_FORMAT_BC1_TYPELESS = 70, + DXGI_FORMAT_BC1_UNORM = 71, + DXGI_FORMAT_BC1_UNORM_SRGB = 72, + DXGI_FORMAT_BC2_TYPELESS = 73, + DXGI_FORMAT_BC2_UNORM = 74, + DXGI_FORMAT_BC2_UNORM_SRGB = 75, + DXGI_FORMAT_BC3_TYPELESS = 76, + DXGI_FORMAT_BC3_UNORM = 77, + DXGI_FORMAT_BC3_UNORM_SRGB = 78, + DXGI_FORMAT_BC4_TYPELESS = 79, + DXGI_FORMAT_BC4_UNORM = 80, + DXGI_FORMAT_BC4_SNORM = 81, + DXGI_FORMAT_BC5_TYPELESS = 82, + DXGI_FORMAT_BC5_UNORM = 83, + DXGI_FORMAT_BC5_SNORM = 84, + DXGI_FORMAT_B5G6R5_UNORM = 85, + DXGI_FORMAT_B5G5R5A1_UNORM = 86, + DXGI_FORMAT_B8G8R8A8_UNORM = 87, + DXGI_FORMAT_B8G8R8X8_UNORM = 88, + DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM = 89, + DXGI_FORMAT_B8G8R8A8_TYPELESS = 90, + DXGI_FORMAT_B8G8R8A8_UNORM_SRGB = 91, + DXGI_FORMAT_B8G8R8X8_TYPELESS = 92, + DXGI_FORMAT_B8G8R8X8_UNORM_SRGB = 93, + DXGI_FORMAT_BC6H_TYPELESS = 94, + DXGI_FORMAT_BC6H_UF16 = 95, + DXGI_FORMAT_BC6H_SF16 = 96, + DXGI_FORMAT_BC7_TYPELESS = 97, + DXGI_FORMAT_BC7_UNORM = 98, + DXGI_FORMAT_BC7_UNORM_SRGB = 99, + DXGI_FORMAT_AYUV = 100, + DXGI_FORMAT_Y410 = 101, + DXGI_FORMAT_Y416 = 102, + DXGI_FORMAT_NV12 = 103, + DXGI_FORMAT_P010 = 104, + DXGI_FORMAT_P016 = 105, + DXGI_FORMAT_420_OPAQUE = 106, + DXGI_FORMAT_YUY2 = 107, + DXGI_FORMAT_Y210 = 108, + DXGI_FORMAT_Y216 = 109, + DXGI_FORMAT_NV11 = 110, + DXGI_FORMAT_AI44 = 111, + DXGI_FORMAT_IA44 = 112, + DXGI_FORMAT_P8 = 113, + DXGI_FORMAT_A8P8 = 114, + DXGI_FORMAT_B4G4R4A4_UNORM = 115, + + DXGI_FORMAT_P208 = 130, + DXGI_FORMAT_V208 = 131, + DXGI_FORMAT_V408 = 132, + + + DXGI_FORMAT_SAMPLER_FEEDBACK_MIN_MIP_OPAQUE = 189, + DXGI_FORMAT_SAMPLER_FEEDBACK_MIP_REGION_USED_OPAQUE = 190, + + DXGI_FORMAT_A4B4G4R4_UNORM = 191, + + + DXGI_FORMAT_FORCE_UINT = 0xffffffff +} DXGI_FORMAT; + +#endif // __dxgiformat_h__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.idl new file mode 100644 index 0000000000000000000000000000000000000000..d3eb0a7ebd0f4e7e9edbe094db468e7163739479 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgiformat.idl @@ -0,0 +1,139 @@ +// +// Copyright (C) Microsoft Corporation. +// Licensed under the MIT license +// + + +typedef enum DXGI_FORMAT +{ + DXGI_FORMAT_UNKNOWN = 0, + DXGI_FORMAT_R32G32B32A32_TYPELESS = 1, + DXGI_FORMAT_R32G32B32A32_FLOAT = 2, + DXGI_FORMAT_R32G32B32A32_UINT = 3, + DXGI_FORMAT_R32G32B32A32_SINT = 4, + DXGI_FORMAT_R32G32B32_TYPELESS = 5, + DXGI_FORMAT_R32G32B32_FLOAT = 6, + DXGI_FORMAT_R32G32B32_UINT = 7, + DXGI_FORMAT_R32G32B32_SINT = 8, + DXGI_FORMAT_R16G16B16A16_TYPELESS = 9, + DXGI_FORMAT_R16G16B16A16_FLOAT = 10, + DXGI_FORMAT_R16G16B16A16_UNORM = 11, + DXGI_FORMAT_R16G16B16A16_UINT = 12, + DXGI_FORMAT_R16G16B16A16_SNORM = 13, + DXGI_FORMAT_R16G16B16A16_SINT = 14, + DXGI_FORMAT_R32G32_TYPELESS = 15, + DXGI_FORMAT_R32G32_FLOAT = 16, + DXGI_FORMAT_R32G32_UINT = 17, + DXGI_FORMAT_R32G32_SINT = 18, + DXGI_FORMAT_R32G8X24_TYPELESS = 19, + DXGI_FORMAT_D32_FLOAT_S8X24_UINT = 20, + DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS = 21, + DXGI_FORMAT_X32_TYPELESS_G8X24_UINT = 22, + DXGI_FORMAT_R10G10B10A2_TYPELESS = 23, + DXGI_FORMAT_R10G10B10A2_UNORM = 24, + DXGI_FORMAT_R10G10B10A2_UINT = 25, + DXGI_FORMAT_R11G11B10_FLOAT = 26, + DXGI_FORMAT_R8G8B8A8_TYPELESS = 27, + DXGI_FORMAT_R8G8B8A8_UNORM = 28, + DXGI_FORMAT_R8G8B8A8_UNORM_SRGB = 29, + DXGI_FORMAT_R8G8B8A8_UINT = 30, + DXGI_FORMAT_R8G8B8A8_SNORM = 31, + DXGI_FORMAT_R8G8B8A8_SINT = 32, + DXGI_FORMAT_R16G16_TYPELESS = 33, + DXGI_FORMAT_R16G16_FLOAT = 34, + DXGI_FORMAT_R16G16_UNORM = 35, + DXGI_FORMAT_R16G16_UINT = 36, + DXGI_FORMAT_R16G16_SNORM = 37, + DXGI_FORMAT_R16G16_SINT = 38, + DXGI_FORMAT_R32_TYPELESS = 39, + DXGI_FORMAT_D32_FLOAT = 40, + DXGI_FORMAT_R32_FLOAT = 41, + DXGI_FORMAT_R32_UINT = 42, + DXGI_FORMAT_R32_SINT = 43, + DXGI_FORMAT_R24G8_TYPELESS = 44, + DXGI_FORMAT_D24_UNORM_S8_UINT = 45, + DXGI_FORMAT_R24_UNORM_X8_TYPELESS = 46, + DXGI_FORMAT_X24_TYPELESS_G8_UINT = 47, + DXGI_FORMAT_R8G8_TYPELESS = 48, + DXGI_FORMAT_R8G8_UNORM = 49, + DXGI_FORMAT_R8G8_UINT = 50, + DXGI_FORMAT_R8G8_SNORM = 51, + DXGI_FORMAT_R8G8_SINT = 52, + DXGI_FORMAT_R16_TYPELESS = 53, + DXGI_FORMAT_R16_FLOAT = 54, + DXGI_FORMAT_D16_UNORM = 55, + DXGI_FORMAT_R16_UNORM = 56, + DXGI_FORMAT_R16_UINT = 57, + DXGI_FORMAT_R16_SNORM = 58, + DXGI_FORMAT_R16_SINT = 59, + DXGI_FORMAT_R8_TYPELESS = 60, + DXGI_FORMAT_R8_UNORM = 61, + DXGI_FORMAT_R8_UINT = 62, + DXGI_FORMAT_R8_SNORM = 63, + DXGI_FORMAT_R8_SINT = 64, + DXGI_FORMAT_A8_UNORM = 65, + DXGI_FORMAT_R1_UNORM = 66, + DXGI_FORMAT_R9G9B9E5_SHAREDEXP = 67, + DXGI_FORMAT_R8G8_B8G8_UNORM = 68, + DXGI_FORMAT_G8R8_G8B8_UNORM = 69, + DXGI_FORMAT_BC1_TYPELESS = 70, + DXGI_FORMAT_BC1_UNORM = 71, + DXGI_FORMAT_BC1_UNORM_SRGB = 72, + DXGI_FORMAT_BC2_TYPELESS = 73, + DXGI_FORMAT_BC2_UNORM = 74, + DXGI_FORMAT_BC2_UNORM_SRGB = 75, + DXGI_FORMAT_BC3_TYPELESS = 76, + DXGI_FORMAT_BC3_UNORM = 77, + DXGI_FORMAT_BC3_UNORM_SRGB = 78, + DXGI_FORMAT_BC4_TYPELESS = 79, + DXGI_FORMAT_BC4_UNORM = 80, + DXGI_FORMAT_BC4_SNORM = 81, + DXGI_FORMAT_BC5_TYPELESS = 82, + DXGI_FORMAT_BC5_UNORM = 83, + DXGI_FORMAT_BC5_SNORM = 84, + DXGI_FORMAT_B5G6R5_UNORM = 85, + DXGI_FORMAT_B5G5R5A1_UNORM = 86, + DXGI_FORMAT_B8G8R8A8_UNORM = 87, + DXGI_FORMAT_B8G8R8X8_UNORM = 88, + DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM = 89, + DXGI_FORMAT_B8G8R8A8_TYPELESS = 90, + DXGI_FORMAT_B8G8R8A8_UNORM_SRGB = 91, + DXGI_FORMAT_B8G8R8X8_TYPELESS = 92, + DXGI_FORMAT_B8G8R8X8_UNORM_SRGB = 93, + DXGI_FORMAT_BC6H_TYPELESS = 94, + DXGI_FORMAT_BC6H_UF16 = 95, + DXGI_FORMAT_BC6H_SF16 = 96, + DXGI_FORMAT_BC7_TYPELESS = 97, + DXGI_FORMAT_BC7_UNORM = 98, + DXGI_FORMAT_BC7_UNORM_SRGB = 99, + DXGI_FORMAT_AYUV = 100, + DXGI_FORMAT_Y410 = 101, + DXGI_FORMAT_Y416 = 102, + DXGI_FORMAT_NV12 = 103, + DXGI_FORMAT_P010 = 104, + DXGI_FORMAT_P016 = 105, + DXGI_FORMAT_420_OPAQUE = 106, + DXGI_FORMAT_YUY2 = 107, + DXGI_FORMAT_Y210 = 108, + DXGI_FORMAT_Y216 = 109, + DXGI_FORMAT_NV11 = 110, + DXGI_FORMAT_AI44 = 111, + DXGI_FORMAT_IA44 = 112, + DXGI_FORMAT_P8 = 113, + DXGI_FORMAT_A8P8 = 114, + DXGI_FORMAT_B4G4R4A4_UNORM = 115, + + DXGI_FORMAT_P208 = 130, + DXGI_FORMAT_V208 = 131, + DXGI_FORMAT_V408 = 132, + + + DXGI_FORMAT_SAMPLER_FEEDBACK_MIN_MIP_OPAQUE = 189, + DXGI_FORMAT_SAMPLER_FEEDBACK_MIP_REGION_USED_OPAQUE = 190, + + DXGI_FORMAT_A4B4G4R4_UNORM = 191, + + + DXGI_FORMAT_FORCE_UINT = 0xffffffff +} DXGI_FORMAT; + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.h new file mode 100644 index 0000000000000000000000000000000000000000..157ba17ca9f0ab1fc58a082dc65f0ef64a5b6b83 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.h @@ -0,0 +1,111 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +#ifndef __dxgitype_h__ +#define __dxgitype_h__ + +#include "dxgicommon.h" +#include "dxgiformat.h" + +#define _FACDXGI 0x87a +#define MAKE_DXGI_HRESULT(code) MAKE_HRESULT(1, _FACDXGI, code) +#define MAKE_DXGI_STATUS(code) MAKE_HRESULT(0, _FACDXGI, code) + +// DXGI error messages have moved to winerror.h + +#define DXGI_CPU_ACCESS_NONE ( 0 ) +#define DXGI_CPU_ACCESS_DYNAMIC ( 1 ) +#define DXGI_CPU_ACCESS_READ_WRITE ( 2 ) +#define DXGI_CPU_ACCESS_SCRATCH ( 3 ) +#define DXGI_CPU_ACCESS_FIELD 15 + + +typedef struct DXGI_RGB +{ + float Red; + float Green; + float Blue; +} DXGI_RGB; + +#ifndef D3DCOLORVALUE_DEFINED +typedef struct _D3DCOLORVALUE { + float r; + float g; + float b; + float a; +} D3DCOLORVALUE; + +#define D3DCOLORVALUE_DEFINED +#endif + +typedef D3DCOLORVALUE DXGI_RGBA; + +typedef struct DXGI_GAMMA_CONTROL +{ + DXGI_RGB Scale; + DXGI_RGB Offset; + DXGI_RGB GammaCurve[ 1025 ]; +} DXGI_GAMMA_CONTROL; + +typedef struct DXGI_GAMMA_CONTROL_CAPABILITIES +{ + BOOL ScaleAndOffsetSupported; + float MaxConvertedValue; + float MinConvertedValue; + UINT NumGammaControlPoints; + float ControlPointPositions[1025]; +} DXGI_GAMMA_CONTROL_CAPABILITIES; + +typedef enum DXGI_MODE_SCANLINE_ORDER +{ + DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED = 0, + DXGI_MODE_SCANLINE_ORDER_PROGRESSIVE = 1, + DXGI_MODE_SCANLINE_ORDER_UPPER_FIELD_FIRST = 2, + DXGI_MODE_SCANLINE_ORDER_LOWER_FIELD_FIRST = 3 +} DXGI_MODE_SCANLINE_ORDER; + +typedef enum DXGI_MODE_SCALING +{ + DXGI_MODE_SCALING_UNSPECIFIED = 0, + DXGI_MODE_SCALING_CENTERED = 1, + DXGI_MODE_SCALING_STRETCHED = 2 +} DXGI_MODE_SCALING; + +typedef enum DXGI_MODE_ROTATION +{ + DXGI_MODE_ROTATION_UNSPECIFIED = 0, + DXGI_MODE_ROTATION_IDENTITY = 1, + DXGI_MODE_ROTATION_ROTATE90 = 2, + DXGI_MODE_ROTATION_ROTATE180 = 3, + DXGI_MODE_ROTATION_ROTATE270 = 4 +} DXGI_MODE_ROTATION; + +typedef struct DXGI_MODE_DESC +{ + UINT Width; + UINT Height; + DXGI_RATIONAL RefreshRate; + DXGI_FORMAT Format; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; +} DXGI_MODE_DESC; + +typedef struct DXGI_JPEG_DC_HUFFMAN_TABLE +{ + BYTE CodeCounts[12]; + BYTE CodeValues[12]; +} DXGI_JPEG_DC_HUFFMAN_TABLE; + +typedef struct DXGI_JPEG_AC_HUFFMAN_TABLE +{ + BYTE CodeCounts[16]; + BYTE CodeValues[162]; +} DXGI_JPEG_AC_HUFFMAN_TABLE; + +typedef struct DXGI_JPEG_QUANTIZATION_TABLE +{ + BYTE Elements[64]; +} DXGI_JPEG_QUANTIZATION_TABLE; + +#endif // __dxgitype_h__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.idl new file mode 100644 index 0000000000000000000000000000000000000000..d1d442f98658eee32c9b654a2d49da42dc616b08 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/dxgitype.idl @@ -0,0 +1,89 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +import "dxgicommon.idl"; +import "dxgiformat.idl"; + +typedef struct DXGI_RGB +{ + float Red; + float Green; + float Blue; +} DXGI_RGB; + +typedef struct _D3DCOLORVALUE { + float r; + float g; + float b; + float a; +} D3DCOLORVALUE; + +typedef D3DCOLORVALUE DXGI_RGBA; + +typedef struct DXGI_GAMMA_CONTROL +{ + DXGI_RGB Scale; + DXGI_RGB Offset; + DXGI_RGB GammaCurve[ 1025 ]; +} DXGI_GAMMA_CONTROL; + +typedef struct DXGI_GAMMA_CONTROL_CAPABILITIES +{ + BOOL ScaleAndOffsetSupported; + float MaxConvertedValue; + float MinConvertedValue; + UINT NumGammaControlPoints; + float ControlPointPositions[1025]; +} DXGI_GAMMA_CONTROL_CAPABILITIES; + +typedef enum DXGI_MODE_SCANLINE_ORDER +{ + DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED = 0, + DXGI_MODE_SCANLINE_ORDER_PROGRESSIVE = 1, + DXGI_MODE_SCANLINE_ORDER_UPPER_FIELD_FIRST = 2, + DXGI_MODE_SCANLINE_ORDER_LOWER_FIELD_FIRST = 3 +} DXGI_MODE_SCANLINE_ORDER; + +typedef enum DXGI_MODE_SCALING +{ + DXGI_MODE_SCALING_UNSPECIFIED = 0, + DXGI_MODE_SCALING_CENTERED = 1, + DXGI_MODE_SCALING_STRETCHED = 2 +} DXGI_MODE_SCALING; + +typedef enum DXGI_MODE_ROTATION +{ + DXGI_MODE_ROTATION_UNSPECIFIED = 0, + DXGI_MODE_ROTATION_IDENTITY = 1, + DXGI_MODE_ROTATION_ROTATE90 = 2, + DXGI_MODE_ROTATION_ROTATE180 = 3, + DXGI_MODE_ROTATION_ROTATE270 = 4 +} DXGI_MODE_ROTATION; + +typedef struct DXGI_MODE_DESC +{ + UINT Width; + UINT Height; + DXGI_RATIONAL RefreshRate; + DXGI_FORMAT Format; + DXGI_MODE_SCANLINE_ORDER ScanlineOrdering; + DXGI_MODE_SCALING Scaling; +} DXGI_MODE_DESC; + +typedef struct DXGI_JPEG_DC_HUFFMAN_TABLE +{ + BYTE CodeCounts[12]; + BYTE CodeValues[12]; +} DXGI_JPEG_DC_HUFFMAN_TABLE; + +typedef struct DXGI_JPEG_AC_HUFFMAN_TABLE +{ + BYTE CodeCounts[16]; + BYTE CodeValues[162]; +} DXGI_JPEG_AC_HUFFMAN_TABLE; + +typedef struct DXGI_JPEG_QUANTIZATION_TABLE +{ + BYTE Elements[64]; +} DXGI_JPEG_QUANTIZATION_TABLE; + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorbandmgmt.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorbandmgmt.h new file mode 100644 index 0000000000000000000000000000000000000000..d746ea4e933879a4a6b78efc1e59b0fcc21310b4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorbandmgmt.h @@ -0,0 +1,351 @@ +/*++ + Copyright (c) Microsoft Corporation. All rights reserved. + + Module Name: + EhStorBandMgmt.h + + Abstract: + Header file for Enhanced Storage Band Management IOCTLs. + + Environment: + Kernel mode only + + Revision History: + 08-18-09 : Created +--*/ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#define _EHSTOR_INTERFACE_ + +#pragma warning(push) +// nonstandard extension used : nameless struct/union +#pragma warning(disable:4201) + +// +// IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES parameters. +// +typedef struct _BAND_MANAGEMENT_CAPABILITIES +{ + ULONG StructSize; + ULONG Capabilities; + ULONGLONG KeyProtectionMechanism; + ULONG MinAuthKeyLength; + ULONG MaxAuthKeyLength; + ULONG MaxBandCount; + ULONG MaxSimultaneousReencryptionCount; + ULONG BandMetadataSize; +} BAND_MANAGEMENT_CAPABILITIES, *PBAND_MANAGEMENT_CAPABILITIES; + +#define CAPS_ACTIVATED 0x00000001 +#define CAPS_BANDCROSSING_SUPPORTED 0x00000002 +#define CAPS_SID_SECURED 0x00000004 + +#define MEDIAKEY_PROTECTEDBY_VENDORSCHEME 0x1 +#define MEDIAKEY_PROTECTEDBY_AUTHKEY 0x2 + +// +// IOCTL_EHSTOR_BANDMGMT_ACTIVATE or IOCTL_EHSTOR_BANDMGMT_REVERT parameters. +// +typedef struct _ACTIVATE_REVERT_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG AuthKeyOffset; + // + // This structure is followed by a variable-length AUTH_KEY structure + // referenced by the AuthKeyOffset field. + // +} ACTIVATE_REVERT_PARAMETERS, *PACTIVATE_REVERT_PARAMETERS; + +#define ACTIVATE_DISABLE_SID 0x00000001 +#define ACTIVATE_IGNORE_POLICY 0x00000002 +#define REVERT_PSID_AUTHKEY 0x00000001 + +typedef struct _AUTH_KEY +{ + ULONG KeySize; + UCHAR Key[ANYSIZE_ARRAY]; +} AUTH_KEY, *PAUTH_KEY; + +#define SIZE_AUTH_KEY_HEADER FIELD_OFFSET(AUTH_KEY, Key) + +// Special key offset value for "no key" or "default key" +#define EHSTOR_BANDMGR_NO_KEY 0 + +// +// IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS parameters. +// +typedef struct _ENUMERATE_BANDS_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG Reserved; + ULONG BandId; + LARGE_INTEGER BandStart; + LARGE_INTEGER BandSize; +} ENUMERATE_BANDS_PARAMETERS, *PENUMERATE_BANDS_PARAMETERS; + +#define ENUMBANDS_ENUM_ALL_BANDS 0x00000001 +#define ENUMBANDS_REPORT_CRYPTO_ALGO 0x00000002 + +typedef struct _BAND_LOCATION_INFO +{ + ULONG StructSize; + ULONG Reserved; + LARGE_INTEGER BandStart; + LARGE_INTEGER BandSize; + BYTE Metadata[32]; +} BAND_LOCATION_INFO, *PBAND_LOCATION_INFO; + +typedef enum +{ + INVALID_LOCK_STATE = 0, + PERSISTENT_UNLOCK, //dev is unlocked and remains unlocked on pwr reset. + NONPERSISTENT_UNLOCK, //dev is unlocked but gets locked on pwr reset. + PERSISTENT_LOCK //dev is locked and remains locked on pwr reset. +} LOCKSTATE; + +typedef enum +{ + AlgoIdTypeInvalid = 0, + AlgoIdTypeOidString, + AlgoIdTypeNumeric +} ALGOIDTYPE; + +typedef struct _BAND_SECURITY_INFO +{ + ULONG StructSize; + LOCKSTATE ReadLock; + LOCKSTATE WriteLock; + ALGOIDTYPE CryptoAlgoIdType; + union + { + struct + { + ULONG Offset; + ULONG Length; + } CryptoAlgoOidString; + ULONG CryptoAlgoNumericId; + }; + BYTE Metadata[32]; +} BAND_SECURITY_INFO, *PBAND_SECURITY_INFO; + +typedef struct _BAND_TABLE_ENTRY +{ + ULONG BandId; + BAND_LOCATION_INFO LocationInfo; + BAND_SECURITY_INFO SecurityInfo; +} BAND_TABLE_ENTRY, *PBAND_TABLE_ENTRY; + +typedef struct _BAND_TABLE +{ + ULONG StructSize; + ULONG BandTableOffset; + ULONG BandTableEntryCount; + ULONG BandTableEntrySize; + // + // This structure is followed by a variable-length array + // of BAND_TABLE_ENTRY structures referenced by BandTableOffset + // +} BAND_TABLE, *PBAND_TABLE; + +// +// IOCTL_EHSTOR_BANDMGMT_CREATE_BAND parameters. +// +typedef struct _CREATE_BAND_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG BandLocationInfoOffset; + ULONG BandSecurityInfoOffset; + ULONG AuthKeyOffset; + // + // This structure is followed by BAND_LOCATION_INFO, BAND_SECURITY_INFO + // and AUTH_KEY structures referenced by the BandLocationInfoOffset, + // BandSecurityInfoOffset and AuthKeyOffset fields. + // +} CREATE_BAND_PARAMETERS, *PCREATE_BAND_PARAMETERS; + +#define CREATEBAND_AUTHKEY_CACHING_ENABLED 0x00000001 + +// +// IOCTL_EHSTOR_BANDMGMT_SET_BAND_LOCATION parameters. +// +typedef struct _SET_BAND_LOCATION_PARAMETERS +{ + ULONG StructSize; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG AuthKeyOffset; + ULONG BandLocationInfoOffset; + // + // This structure is followed by a BAND_LOCATION_INFO structure + // and a variable-length AUTH_KEY structure referenced by the + // BandLocationInfoOffset and AuthKeyOffset fields, respectively. + // +} SET_BAND_LOCATION_PARAMETERS, *PSET_BAND_LOCATION_PARAMETERS; + +// +// IOCTL_EHSTOR_BANDMGMT_SET_BAND_SECURITY parameters. +// +typedef struct _SET_BAND_SECURITY_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG Reserved; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG CurrentAuthKeyOffset; + ULONG NewAuthKeyOffset; + ULONG BandSecurityInfoOffset; + // + // This structure is followed by variable-length AUTH_KEY and + // BAND_SECURITY_INFO structures referenced by the CurrentAuthKeyOffset, + // NewAuthKeyOffset and BandSecurityInfoOffset fields. + // +} SET_BAND_SECURITY_PARAMETERS, *PSET_BAND_SECURITY_PARAMETERS; + +#define SETBANDSEC_AUTHKEY_CACHING_ENABLED 0x00000001 + +// +// IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA parameters. +// +typedef struct _GET_BAND_METADATA_PARAMETERS +{ + ULONG StructSize; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG MetadataOffset; + ULONG MetadataSize; +} GET_BAND_METADATA_PARAMETERS, *PGET_BAND_METADATA_PARAMETERS; + +// +// IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA parameters. +// +typedef struct _SET_BAND_METADATA_PARAMETERS +{ + ULONG StructSize; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG MetadataOffset; + ULONG MetadataSize; + ULONG BufferOffset; + ULONG AuthKeyOffset; + // + // This structure is followed by a buffer referenced by the BufferOffset + // and MetadataSize fields, and optionally a variable-length AUTH_KEY + // structure referenced by the AuthKeyOffset field. + // +} SET_BAND_METADATA_PARAMETERS, *PSET_BAND_METADATA_PARAMETERS; + +// +// IOCTL_EHSTOR_BANDMGMT_DELETE_BAND parameters. +// +typedef struct _DELETE_BAND_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG Reserved; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG AuthKeyOffset; + // + // This structure is followed by a variable-length AUTH_KEY + // structure referenced by AuthKeyOffset. + // +} DELETE_BAND_PARAMETERS, *PDELETE_BAND_PARAMETERS; + +#define DELBAND_ERASE_BEFORE_DELETE 0x00000001 + +// +// IOCTL_EHSTOR_BANDMGMT_ERASE_BAND parameters. +// +typedef struct _ERASE_BAND_PARAMETERS +{ + ULONG StructSize; + ULONG Flags; + ULONG Reserved; + ULONG BandId; + LARGE_INTEGER BandStart; + ULONG NewAuthKeyOffset; + // + // This structure is followed by a variable-length AUTH_KEY + // structure referenced by NewAuthKeyOffset. + // +} ERASE_BAND_PARAMETERS, *PERASE_BAND_PARAMETERS; + +#define ERASEBAND_AUTHKEY_CACHING_ENABLED 0x00000001 + +// +// IOCTL_EHSTOR_BANDMGMT_SET_SID parameters. +// +typedef struct _SET_SID_PARAMETERS +{ + ULONG StructSize; + ULONG CurrentSidPinOffset; + ULONG NewSidPinOffset; + // + // This structure is followed by two variable-length AUTH_KEY structures + // referenced by CurrentSidPinOffset and NewSidPinOffset fields. + // +} SET_SID_PARAMETERS, *PSET_SID_PARAMETERS; + +// +// Band Control IOCTLs +// +#define IOCTL_EHSTOR_BANDMGMT_QUERY_CAPABILITIES \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x520, METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_ACTIVATE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x521, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_REVERT \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x522, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_ENUMERATE_BANDS \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x523, METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_CREATE_BAND \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x524, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_SET_BAND_LOCATION \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x525, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_SET_BAND_SECURITY \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x526, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_GET_BAND_METADATA \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x527, METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_SET_BAND_METADATA \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x528, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_DELETE_BAND \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x529, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_ERASE_BAND \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x52a, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_SET_SID \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x52b, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_BANDMGMT_ERASE_ALL_BANDS \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x52c, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// TCG Storage Silo Driver specific IOCTLs +// +#define IOCTL_EHSTOR_TCGDRV_RELINQUISH_SILO \ + CTL_CODE(FILE_DEVICE_EHSTOR, 0x200, METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorioctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorioctl.h new file mode 100644 index 0000000000000000000000000000000000000000..a09a9f6ee277e10c74bcadc196221e16eaaebc81 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ehstorioctl.h @@ -0,0 +1,224 @@ +/*++ + Copyright (c) Microsoft Corporation. All rights reserved. + + Module Name: + EhStorIoctl.h + + Abstract: + Header file for Enhanced Storage IOCTLs + + Environment: + Kernel mode only + + Revision History: + 05-01-07 : Created + 06-19-09 : Renamed from UsbStorIoctl.h to EhStorIoctl.h +--*/ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifndef MAX_PATH +#define MAX_PATH 260 +#endif + +// +// IOCTL_EHSTOR_DEVICE_GET_AUTHZ_STATE and IOCTL_EHSTOR_DEVICE_SET_AUTHZ_STATE +// parameters. +// +typedef struct tagACT_AUTHZ_STATE +{ + UCHAR ACT; + BOOLEAN fAuthorized; +} ACT_AUTHZ_STATE, *PACT_AUTHZ_STATE; + +// +// IOCTL_EHSTOR_DEVICE_GET_QUEUE_STATE and IOCTL_EHSTOR_DEVICE_SET_QUEUE_STATE +// parameters. +// +typedef struct tagACT_QUEUE_STATE +{ + BOOLEAN fFrozen; +} ACT_QUEUE_STATE, *PACT_QUEUE_STATE; + +// +// IOCTL_EHSTOR_DEVICE_SILO_COMMAND parameters. +// +typedef struct tagSILO_COMMAND +{ + UCHAR SiloIndex; + UCHAR Command; + ULONG cbCommandBuffer; + UCHAR rgbCommandBuffer[ANYSIZE_ARRAY]; +} SILO_COMMAND, *PSILO_COMMAND; + +#define SIZE_SILO_COMMAND_HEADER FIELD_OFFSET(SILO_COMMAND, rgbCommandBuffer) + +// +// IOCTL_EHSTOR_DEVICE_ENUMERATE_PDOS parameters. +// + +// Enumeration +typedef enum _PDO_TYPE +{ + PDO_TYPE_UNDEFINED = 0, + // Types either enumerated or provided as filter parameter to + // IOCTL_EHSTOR_DEVICE_ENUMERATE_PDOS + PDO_TYPE_DISK, + PDO_TYPE_CONTROL, + PDO_TYPE_SILO, + // This type is never enumerated, only provided as a filter parameter to + // IOCTL_EHSTOR_DEVICE_ENUMERATE_PDOS + PDO_TYPE_THIS = 256 +} PDO_TYPE; + +// Enumeration +typedef enum _PDO_STATE +{ + PDO_STATE_UNDEFINED = 0, + PDO_STATE_STARTED, + PDO_STATE_NOT_STARTED +} PDO_STATE; + +// Bit-mask +typedef enum _PDO_CAPS +{ + PDO_CAPABILITY_UNDEFINED = 0, + PDO_CAPABILITY_INC512_SET = 1, + PDO_CAPABILITY_INC512_CLEAR = 2 +} PDO_CAPS; + +typedef struct _ENUM_PDO_ENTRY +{ + UCHAR type; + UCHAR state; + UCHAR capabilities; + ULONG ulSTID; + UCHAR bSpecificationMajor; + UCHAR bSpecificationMinor; + UCHAR bImplementationMajor; + UCHAR bImplementationMinor; + WCHAR wszDeviceInstancePath[(2 * MAX_PATH) + 1]; +} ENUM_PDO_ENTRY, *PENUM_PDO_ENTRY; + +typedef struct _ENUM_PDO_RESULTS +{ + ULONG cEntries; + ENUM_PDO_ENTRY rgEntries[ANYSIZE_ARRAY]; +} ENUM_PDO_RESULTS, *PENUM_PDO_RESULTS; + +#define SIZE_ENUM_PDO_RESULTS_HEADER FIELD_OFFSET(ENUM_PDO_RESULTS, rgEntries) + +// +// IOCTL_EHSTOR_DEVICE_QUERY_PROPERTIES parameters. +// +typedef struct _EHSTOR_DEVICE_PROPERTIES +{ + ULONG StructSize; + ULONG BytesPerSector; +} EHSTOR_DEVICE_PROPERTIES, *PEHSTOR_DEVICE_PROPERTIES; + +// +// IOCTL_EHSTOR_DRIVER_REPORT_CAPABILITIES parameters. +// +typedef struct _SILO_DRIVER_CAPABILITIES +{ + ULONG StructSize; + ULONG Capabilities; + ULONG MaxLbaFilterCount; + ULONG RedirectedIoctlListCount; + ULONG RedirectedIoctlListOffset; +} SILO_DRIVER_CAPABILITIES, *PSILO_DRIVER_CAPABILITIES; + +// Bit-mask +typedef enum _SILO_DRIVER_CAPS +{ + CAP_ON_DEMAND_AUTHENTICATION = (1 << 0), //The silo driver supports + //on-demand authentication and + //deauthentication + CAP_BANDING_SUPPORT = (1 << 1) //The silo driver supports the + //concept of different states + //for different LBA bands +} SILO_DRIVER_CAPS; + +// +// IOCTL_EHSTOR_DRIVER_UPDATE_LBA_FILTER_TABLE parameters. +// +typedef struct _LBA_FILTER_TABLE_ENTRY +{ + ULARGE_INTEGER StartLba; + ULARGE_INTEGER LbaCount; + BOOLEAN ReadLock; + BOOLEAN WriteLock; +} LBA_FILTER_TABLE_ENTRY, *PLBA_FILTER_TABLE_ENTRY; + +typedef struct _LBA_FILTER_TABLE +{ + ULONG StructSize; + BOOLEAN GlobalReadLock; + LONG Reserved1; + BOOLEAN GlobalWriteLock; + LONG Reserved2; + ULONG LbaFilterCount; + ULONG LbaFilterSize; + ULONG LbaFiltersOffset; +} LBA_FILTER_TABLE, *PLBA_FILTER_TABLE; + +// +// IOCTL_EHSTOR_DRIVER_PERFORM_AUTHZ parameters. +// +typedef struct _AUTHZ_STATE +{ + ULONG AuthzState; +} AUTHZ_STATE, *PAUTHZ_STATE; + +#define AUTHZSTATE_AUTHENTICATE 0x00000001 +#define AUTHZSTATE_CLEAR_AUTHKEY_CACHE 0x00000002 + +// +// Enhanced Storage IOCTL codes +// +#define IOCTL_EHSTOR_DEVICE_SILO_COMMAND \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x503, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DEVICE_ENUMERATE_PDOS \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x504, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DEVICE_SET_AUTHZ_STATE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x505, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DEVICE_QUERY_PROPERTIES \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x506, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DEVICE_GET_QUEUE_STATE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x507, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DEVICE_SET_QUEUE_STATE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x508, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_DEVICE_GET_AUTHZ_STATE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x509, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_EHSTOR_DRIVER_REPORT_CAPABILITIES \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x510, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_DRIVER_UPDATE_LBA_FILTER_TABLE \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x511, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_EHSTOR_DRIVER_PERFORM_AUTHZ \ + CTL_CODE(IOCTL_STORAGE_BASE, 0x512, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// Enhanced Storage GUIDs +// +DEFINE_GUID(GUID_EHSTOR_SILO_INTERFACE, + 0x7c2bcf57, 0x2bea, 0x46da, 0xad, 0x26, 0x78, 0xfd, 0xc8, 0x3c, 0xee, 0x46); +DEFINE_GUID(GUID_EHSTOR_CONTROL_INTERFACE, + 0x4f40006f, 0xb933, 0x4550, 0xb5, 0x32, 0x2b, 0x58, 0xce, 0xe6, 0x14, 0xd3); + +// Legacy USBSTOR definitions left for compatibility reasons +DEFINE_GUID(GUID_USBSTOR_EHSTOR_SILO_INTERFACE, + 0x7c2bcf57, 0x2bea, 0x46da, 0xad, 0x26, 0x78, 0xfd, 0xc8, 0x3c, 0xee, 0x46); +DEFINE_GUID(GUID_USBSTOR_EHSTOR_CONTROL_INTERFACE, + 0x4f40006f, 0xb933, 0x4550, 0xb5, 0x32, 0x2b, 0x58, 0xce, 0xe6, 0x14, 0xd3); + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/emi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/emi.h new file mode 100644 index 0000000000000000000000000000000000000000..3de8dba663daee81dd4853daa83fa8292fd691ea --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/emi.h @@ -0,0 +1,132 @@ +/*++ + +Copyright (c) Microsoft Corporation. All Rights Reserved. + +Module Name: + + emi.h + +Abstract: + + This header defines the standard IOCTL interface to an energy meter device. + +--*/ + +#if !defined(_EMI_) +#define _EMI_ + +#ifdef _MSC_VER +#pragma once +#endif // _MSC_VER + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +// +// Energy Metering Device Interface +// {45BD8344-7ED6-49cf-A440-C276C933B053} +// + +DEFINE_GUID(GUID_DEVICE_ENERGY_METER, +0x45bd8344, 0x7ed6, 0x49cf, 0xa4, 0x40, 0xc2, 0x76, 0xc9, 0x33, 0xb0, 0x53); + +#define IOCTL_EMI_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_EMI_GET_METADATA_SIZE CTL_CODE(FILE_DEVICE_UNKNOWN, 1, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_EMI_GET_METADATA CTL_CODE(FILE_DEVICE_UNKNOWN, 2, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_EMI_GET_MEASUREMENT CTL_CODE(FILE_DEVICE_UNKNOWN, 3, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// The maximum length for a name parameter including the null terminator. +// + +#define EMI_NAME_MAX 16 + +#define EMI_VERSION_V1 1 +#define EMI_VERSION_V2 2 + +typedef enum +{ + EmiMeasurementUnitPicowattHours +} EMI_MEASUREMENT_UNIT; + +typedef struct +{ + USHORT EmiVersion; +} EMI_VERSION; + +typedef struct +{ + ULONG MetadataSize; +} EMI_METADATA_SIZE; + +typedef struct +{ + ULONGLONG AbsoluteEnergy; + ULONGLONG AbsoluteTime; +} EMI_CHANNEL_MEASUREMENT_DATA; + +// +// V1 Interface Definition +// + +typedef struct +{ + EMI_MEASUREMENT_UNIT MeasurementUnit; + WCHAR HardwareOEM[EMI_NAME_MAX]; + WCHAR HardwareModel[EMI_NAME_MAX]; + USHORT HardwareRevision; + USHORT MeteredHardwareNameSize; + WCHAR MeteredHardwareName[ANYSIZE_ARRAY]; +} EMI_METADATA_V1; + +typedef EMI_CHANNEL_MEASUREMENT_DATA EMI_MEASUREMENT_DATA_V1; + +// +// Backwards Compatability Typedefs +// + +typedef EMI_METADATA_V1 EMI_METADATA; +typedef EMI_MEASUREMENT_DATA_V1 EMI_MEASUREMENT_DATA; + +// +// V2 Interface Definition +// + +typedef struct +{ + EMI_MEASUREMENT_UNIT MeasurementUnit; + USHORT ChannelNameSize; + WCHAR ChannelName[ANYSIZE_ARRAY]; +} EMI_CHANNEL_V2; + +typedef struct +{ + WCHAR HardwareOEM[EMI_NAME_MAX]; + WCHAR HardwareModel[EMI_NAME_MAX]; + USHORT HardwareRevision; + USHORT ChannelCount; + EMI_CHANNEL_V2 Channels[ANYSIZE_ARRAY]; +} EMI_METADATA_V2; + +typedef struct +{ + EMI_CHANNEL_MEASUREMENT_DATA ChannelData[ANYSIZE_ARRAY]; +} EMI_MEASUREMENT_DATA_V2; + +#define EMI_CHANNEL_V2_LENGTH(_ChannelNameSize) \ + (FIELD_OFFSET(EMI_CHANNEL_V2, ChannelName) + (_ChannelNameSize)) + +#define EMI_CHANNEL_V2_NEXT_CHANNEL(_Channel) \ + ((EMI_CHANNEL_V2*)((PUCHAR)(_Channel) + \ + EMI_CHANNEL_V2_LENGTH((_Channel)->ChannelNameSize))) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#endif // !defined(_EMI_) + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntprov.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntprov.h new file mode 100644 index 0000000000000000000000000000000000000000..d668ae0d8dc04f843a462bbc1a952087b2921aa8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntprov.h @@ -0,0 +1,1035 @@ + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + evntprov.h + +Abstract: + + This defines the unified provider side user mode API. + +Revision History: + +--*/ + +#ifndef _EVNTPROV_H_ +#define _EVNTPROV_H_ + +#pragma once + +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added +#endif + +#ifndef _EVNT_SOURCE_ +#ifdef _NTDLLBUILD_ +#define _EVNT_SOURCE_ +#endif // _NTDLLBUILD_ +#endif // _EVNT_SOURCE_ + +#ifndef EVNTAPI +#ifndef MIDL_PASS +#ifdef _EVNT_SOURCE_ +#define EVNTAPI __stdcall +#else +#define EVNTAPI DECLSPEC_IMPORT __stdcall +#endif // _EVNT_SOURCE_ +#endif // MIDL_PASS +#endif // EVNTAPI + +#ifndef EVNTPROV_PFORCEINLINE + #if defined(PFORCEINLINE) + #define EVNTPROV_PFORCEINLINE PFORCEINLINE + #elif defined(FORCEINLINE) + #define EVNTPROV_PFORCEINLINE FORCEINLINE + #else + #define EVNTPROV_PFORCEINLINE __forceinline + #endif +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#define EVENT_MIN_LEVEL (0) /* + Lowest value for an event level is 0. */ +#define EVENT_MAX_LEVEL (0xff) /* + Highest value for an event level is 255. */ + +/* +EVENT_ACTIVITY_CTRL values for the ControlCode parameter of +EventActivityIdControl. +*/ +#define EVENT_ACTIVITY_CTRL_GET_ID (1) /* + EventActivityIdControl will return the current thread's activity ID. */ +#define EVENT_ACTIVITY_CTRL_SET_ID (2) /* + EventActivityIdControl will set the current thread's activity ID. */ +#define EVENT_ACTIVITY_CTRL_CREATE_ID (3) /* + EventActivityIdControl will generate and return a new activity ID. Note + that the returned activity ID is not a GUID. The EventActivityIdControl + function uses a simpler generation algorithm that is guaranteed to return + a value different from any valid GUID and different from any other activity + ID generated by EventActivityIdControl on the same machine during the same + boot session. You can generate activity IDs using either + EventActivityIdControl or a GUID-generation API like UuidCreate. */ +#define EVENT_ACTIVITY_CTRL_GET_SET_ID (4) /* + EventActivityIdControl will set the current thread's activity ID and + return the previous activity ID. */ +#define EVENT_ACTIVITY_CTRL_CREATE_SET_ID (5) /* + EventActivityIdControl will generate a new activity ID, set the current + thread's activity ID to the new value, and return the previous activity + ID. */ + +#define MAX_EVENT_DATA_DESCRIPTORS (128) /* + The maximum number of EVENT_DATA_DESCRIPTORs that can be used in an event. + Used with EventWrite, EventWriteTransfer, EventWriteEx. */ +#define MAX_EVENT_FILTER_DATA_SIZE (1024) /* + The maximum data size for many of the filter types. + Used with EVENT_FILTER_DESCRIPTOR. */ +#define MAX_EVENT_FILTER_PAYLOAD_SIZE (4096) /* + The maximum data size for an event payload filter. + Used with EVENT_FILTER_DESCRIPTOR of type EVENT_FILTER_TYPE_PAYLOAD. */ +#define MAX_EVENT_FILTER_EVENT_NAME_SIZE (4096) /* + The maximum data size for a name-based filter. + Used with EVENT_FILTER_DESCRIPTOR for name-based filters. */ + +#define MAX_EVENT_FILTERS_COUNT (13) /* + The maximum number of filters that can be provided in a call to + EnableTraceEx2. + Used with ENABLE_TRACE_PARAMETERS. */ + +#define MAX_EVENT_FILTER_PID_COUNT (8) /* + The maximum number of process IDs in a PID filter. + Used with EVENT_FILTER_DESCRIPTOR of type EVENT_FILTER_TYPE_PID. */ + +#define MAX_EVENT_FILTER_EVENT_ID_COUNT (64) /* + The maximum number of event IDs in an event ID or stackwalk filter. + Used with EVENT_FILTER_DESCRIPTOR of type EVENT_FILTER_TYPE_EVENT_ID or + EVENT_FILTER_TYPE_STACKWALK. */ + +/* +EVENT_FILTER_TYPE values for the Type field of EVENT_FILTER_DESCRIPTOR. +*/ +#define EVENT_FILTER_TYPE_NONE (0x00000000) +#define EVENT_FILTER_TYPE_SCHEMATIZED (0x80000000) // Provider-side. +#define EVENT_FILTER_TYPE_SYSTEM_FLAGS (0x80000001) // Internal use only. +#define EVENT_FILTER_TYPE_TRACEHANDLE (0x80000002) // Initiate rundown. +#define EVENT_FILTER_TYPE_PID (0x80000004) // Process ID. +#define EVENT_FILTER_TYPE_EXECUTABLE_NAME (0x80000008) // EXE file name. +#define EVENT_FILTER_TYPE_PACKAGE_ID (0x80000010) // Package ID. +#define EVENT_FILTER_TYPE_PACKAGE_APP_ID (0x80000020) // Package Relative App Id (PRAID). +#define EVENT_FILTER_TYPE_PAYLOAD (0x80000100) // TDH payload filter. +#define EVENT_FILTER_TYPE_EVENT_ID (0x80000200) // Event IDs. +#define EVENT_FILTER_TYPE_EVENT_NAME (0x80000400) // Event name (TraceLogging only). +#define EVENT_FILTER_TYPE_STACKWALK (0x80001000) // Event IDs for stack. +#define EVENT_FILTER_TYPE_STACKWALK_NAME (0x80002000) // Event name for stack (TraceLogging only). +#define EVENT_FILTER_TYPE_STACKWALK_LEVEL_KW (0x80004000) // Filter stack collection by level and keyword. +#define EVENT_FILTER_TYPE_CONTAINER (0x80008000) // Filter by Container ID. + +/* +EVENT_DATA_DESCRIPTOR_TYPE values for the Type field of EVENT_DATA_DESCRIPTOR. +Note that the Type field is ignored by default. ETW will only check the Type +field if a provider has opted-in via a call to EventSetInformation. +*/ +#define EVENT_DATA_DESCRIPTOR_TYPE_NONE (0) /* + Event data (payload). */ +#define EVENT_DATA_DESCRIPTOR_TYPE_EVENT_METADATA (1) /* + TraceLogging event decoding information. */ +#define EVENT_DATA_DESCRIPTOR_TYPE_PROVIDER_METADATA (2) /* + Manually-attached provider traits. For use with operating systems that do + not support attaching provider traits via EventSetInformation. This data + will be ignored if provider traits have been configured via + EventSetInformation. */ +#define EVENT_DATA_DESCRIPTOR_TYPE_TIMESTAMP_OVERRIDE (3) /* + 64-bit event timestamp override. For use when relogging. Note that logging + events out of timestamp order may lead to event ordering issues during + trace processing. */ + +/* +EVENT_WRITE_FLAG values for the Flag parameter of EventWriteEx and EtwWriteEx. +*/ +#define EVENT_WRITE_FLAG_NO_FAULTING 0x00000001 /* + EVENT_WRITE_FLAG_NO_FAULTING is used in kernel-mode calls to EtwWriteEx. + Certain ETW functionality requires paging. ETW will automatically disable + such functionality when it is called at high IRQL (dispatch or above). + To call ETW at low IRQL (below dispatch) from a context in which page + faults are not tolerated, use EtwWriteEx and include this flag. */ +#define EVENT_WRITE_FLAG_INPRIVATE 0x00000002 /* + EVENT_WRITE_FLAG_INPRIVATE indicates that an event should be dropped on any + logger the uses EVENT_ENABLE_PROPERTY_EXCLUDE_INPRIVATE. */ + +/* +A REGHANDLE represents an event provider session. +A REGHANDLE is opened with EventRegister and closed with EventUnregister. +*/ +typedef ULONGLONG REGHANDLE, *PREGHANDLE; + +#pragma warning(push) +#pragma warning(disable:4201) // Nonstandard extension: unnamed struct/union + +/* +EVENT_DATA_DESCRIPTOR is used with EventWrite to provide user data items. +*/ +typedef struct _EVENT_DATA_DESCRIPTOR { + + ULONGLONG Ptr; // Pointer to data. Set to (ULONGLONG)(ULONG_PTR)pData. + ULONG Size; // Size of data in bytes. + union { + ULONG Reserved; // Set to 0 if not using a special data item type. + struct { + UCHAR Type; // Default is EVENT_DATA_DESCRIPTOR_TYPE_NONE, meaning normal payload data. + UCHAR Reserved1; + USHORT Reserved2; + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; + +} EVENT_DATA_DESCRIPTOR, *PEVENT_DATA_DESCRIPTOR; + +#pragma warning(pop) // 4201 + + +#ifndef EVENT_DESCRIPTOR_DEF +#define EVENT_DESCRIPTOR_DEF + +/* +EVENT_DESCRIPTOR describes and categorizes an event. +Note that for TraceLogging events, the Id and Version fields are not +meaningful and should be ignored. +*/ +typedef struct _EVENT_DESCRIPTOR { + + USHORT Id; /* + For manifest-based events, the Provider.Guid + Event.Id + Event.Version + should uniquely identify an event. Once a manifest with a particular + event Id+Version has been made public, the definition of that event + (the types, ordering, and semantics of the fields) should never be + changed. If an event needs to be changed, it must be given a new + identity (usually by incrementing the Version), and the original event + must remain in the manifest (so that older versions of the event can + still be decoded with the new manifest). To change an event (e.g. to + add/remove a field or to change a field type): duplicate the event in + the manifest, then increment the event Version and make changes in the + new copy. + For manifest-free events (i.e. TraceLogging), Event.Id and + Event.Version are not useful and should be ignored. Use Event name, + level, keyword, and opcode for event filtering and identification. */ + UCHAR Version; /* + For manifest-based events, the Provider.Guid + Event.Id + Event.Version + should uniquely identify an event. The Id+Version constitute a 24-bit + identifier. Generally, events with the same Id are semantically + related, and the Version is incremented as the event is refined over + time. */ + UCHAR Channel; /* + The meaning of the Channel field depends on the event consumer. + This field is most commonly used with events that will be consumed by + the Windows Event Log. Note that Event Log does not listen to all ETW + events, so setting a channel is not enough to make the event appear in + the Event Log. For an ETW event to be routed to Event Log, the + following must be configured: + - The provider and its channels must be defined in a manifest. + - The manifest must be compiled with the mc.exe tool, and the resulting + BIN files must be included into the resources of an EXE or DLL. + - The EXE or DLL containing the BIN data must be installed on the + machine where the provider will run. + - The manifest must be registered (using wevtutil.exe) on the machine + where the provider will run. The manifest registration process must + record the location of the EXE or DLL with the BIN data. + - The channel must be enabled in Event Log configuration. + - The provider must log an event with the channel and keyword set + correctly as defined in the manifest. (Note that the mc.exe code + generator will automatically define an implicit keyword for each + channel, and will automatically add the channel's implicit keyword to + each event that references a channel.) */ + UCHAR Level; /* + The event level defines the event's severity or importance and is a + primary means for filtering events. Microsoft-defined levels (in + evntrace.h and winmeta.h) are 1 (critical/fatal), 2 (error), + 3 (warning), 4 (information), and 5 (verbose). Levels 6-9 are reserved. + Level 0 means the event is always-on (will not be filtered by level). + For a provider, a lower level means the event is more important. An + event with level 0 will always pass any level-based filtering. + For a consumer, a lower level means the session's filter is more + restrictive. However, setting a session's level to 0 disables level + filtering (i.e. session level 0 is the same as session level 255). */ + UCHAR Opcode; /* + The event opcode is used to mark events with special semantics that + may be used by event decoders to organize and correlate events. + Globally-recognized opcode values are defined in winmeta.h. A provider + can define its own opcodes. Most events use opcode 0 (information). + The opcodes 1 (start) and 2 (stop) are used to indicate the beginning + and end of an activity as follows: + - Generate a new activity Id (UuidCreate or EventActivityIdControl). + - Write an event with opcode = start, activity ID = (the generated + activity ID), and related activity ID = (the parent activity if any). + - Write any number of informational events with opcode = info, activity + ID = (the generated activity ID). + - Write a stop event with opcode = stop, activity ID = (the generated + activity ID). + Each thread has an implicit activity ID (in thread-local storage) that + will be applied to any event that does not explicitly specify an + activity ID. The implicit activity ID can be accessed using + EventActivityIdControl. It is intended that the thread-local activity + will be used to implement scope-based activities: on entry to a scope + (i.e. at the start of a function), a user will record the existing + value of the implicit activity ID, generate and set a new value, and + write a start event; on exit from the scope, the user will write a stop + event and restore the previous activity ID. Note that there is no enforcement + of this pattern, and an application must be aware that other code may + potentially overwrite the activity ID without restoring it. In + addition, the implicit activity ID does not work well with cross-thread + activities. For these reasons, it may be more appropriate to use + explicit activity IDs (explicitly pass a GUID to EventWriteTransfer) + instead of relying on the implicity activity ID. */ + USHORT Task; /* + The event task code can be used for any purpose as defined by the + provider. The task code 0 is the default, used to indicate that no + special task code has been assigned to the event. The ETW manifest + supports assigning localizable strings for each task code. The task + code might be used to group events into categories, or to simply + associate a task name with each event. */ + ULONGLONG Keyword; /* + The event keyword defines membership in various categories and is an + important means for filtering events. The event's keyword is a set of + 64 bits indicating the categories to which an event belongs. The + provider manifest may provide definitions for up to 48 keyword values, + each value defining the meaning of a single keyword bit (the upper 16 + bits are reserved by Microsoft for special purposes). For example, if + the provider manifest defines keyword 0x0010 as "Networking", and + defines keyword 0x0020 as "Threading", an event with keyword 0x0030 + would be in both "Networking" and "Threading" categories, while an + event with keyword 0x0001 would be in neither category. An event with + keyword 0 is treated as uncategorized. + Event consumers can use keyword masks to determine which events should + be included in the log. A session can define a KeywordAny mask and + a KeywordAll mask. An event will pass the session's keyword filtering + if the following expression is true: + event.Keyword == 0 || ( + (event.Keyword & session.KeywordAny) != 0 && + (event.Keyword & session.KeywordAll) == session.KeywordAll). + In other words, uncategorized events (events with no keywords set) + always pass keyword filtering, and categorized events pass if they + match any keywords in KeywordAny and match all keywords in KeywordAll. + */ + +} EVENT_DESCRIPTOR, *PEVENT_DESCRIPTOR; + +typedef const EVENT_DESCRIPTOR *PCEVENT_DESCRIPTOR; + +#endif + +/* +EVENT_FILTER_DESCRIPTOR describes a filter data item for EnableTraceEx2. +*/ +typedef struct _EVENT_FILTER_DESCRIPTOR { + + ULONGLONG Ptr; // Pointer to filter data. Set to (ULONGLONG)(ULONG_PTR)pData. + ULONG Size; // Size of filter data in bytes. + ULONG Type; // EVENT_FILTER_TYPE value. + +} EVENT_FILTER_DESCRIPTOR, *PEVENT_FILTER_DESCRIPTOR; + +/* +Defines the header data that must precede the filter data. +The filter data layout is defined in the instrumentation manifest. +*/ +typedef struct _EVENT_FILTER_HEADER { + + USHORT Id; + UCHAR Version; + UCHAR Reserved[5]; + ULONGLONG InstanceId; + ULONG Size; + ULONG NextOffset; + +} EVENT_FILTER_HEADER, *PEVENT_FILTER_HEADER; + +/* +EVENT_FILTER_EVENT_ID is used to pass EventId filter for +stack walk filters. +*/ +typedef struct _EVENT_FILTER_EVENT_ID { + BOOLEAN FilterIn; + UCHAR Reserved; + USHORT Count; + USHORT Events[ANYSIZE_ARRAY]; +} EVENT_FILTER_EVENT_ID, *PEVENT_FILTER_EVENT_ID; + +/* +EVENT_FILTER_EVENT_NAME is used to pass the EventName filter. + +This filter will only be applied to events that are otherwise enabled +on the logging session (via level/keyword in the enable call). + +The Level, MatchAnyKeyword, and MatchAllKeyword fields in the filter +determine which of those otherwise enabled events the filter is applied to. + +FilterIn determines whether the events matching the provided names will be +filtered in or filtered out. When used for the EVENT_FILTER_TYPE_STACKWALK_NAME +filter type, the filtered in events will have stacks collected for them. + +The Names field should be a series of NameCount nul-terminated utf-8 +event names. +*/ +typedef struct _EVENT_FILTER_EVENT_NAME { + ULONGLONG MatchAnyKeyword; + ULONGLONG MatchAllKeyword; + UCHAR Level; + BOOLEAN FilterIn; + USHORT NameCount; + UCHAR Names[ANYSIZE_ARRAY]; // utf-8 +} EVENT_FILTER_EVENT_NAME, *PEVENT_FILTER_EVENT_NAME; + +/* +EVENT_FILTER_LEVEL_KW is used to pass the StackWalk Level-Keyword filter. + +This filter will only be applied to events that are otherwise enabled +on the logging session (via level/keyword in the enable call). + +The Level, MatchAnyKeyword, and MatchAllKeyword fields in the filter +determine which of these events should have the filter applied to it. + +FilterIn determines whether the events matching the provided names will be +filtered in or filtered out. Those filtered in will have Stacks collected. +*/ +typedef struct _EVENT_FILTER_LEVEL_KW { + ULONGLONG MatchAnyKeyword; + ULONGLONG MatchAllKeyword; + UCHAR Level; + BOOLEAN FilterIn; +} EVENT_FILTER_LEVEL_KW, *PEVENT_FILTER_LEVEL_KW; + +#ifndef MIDL_PASS + +/* +EVENT_INFO_CLASS values for the InformationClass parameter of +EventSetInformation. +*/ +typedef enum _EVENT_INFO_CLASS { + EventProviderBinaryTrackInfo, /* + Requests that the ETW runtime add the full path to the binary that + registered the provider into each trace. The full path is important if + if the binary contains the mc.exe-generated decoding resources but is + not globally registered. Decoding tools can use the path to locate the + binary and extract the decoding resources. */ + EventProviderSetReserved1, /* + Not used. */ + EventProviderSetTraits, /* + Provides the ETW runtime with additional information about the + provider, potentially including the provider name and a group GUID. + Refer the the MSDN Provider Traits topic for more information about the + format of the data to be used with this control code. + Setting this trait also configures the ETW runtime to respect the + Type field of EVENT_DATA_DESCRIPTOR (by default the Type field is + ignored). */ + EventProviderUseDescriptorType, /* + Configures whether the ETW runtime should respect the Type field of the + EVENT_DATA_DESCRIPTOR. The data for this control code is a BOOLEAN + (1 byte, value FALSE or TRUE). */ + MaxEventInfo +} EVENT_INFO_CLASS; + +#if !defined(_ETW_KM_) || defined(_EVNT_SOURCE_) + +/* +Optional callback function that users provide to EventRegister. +(Refer to MSDN documentation for EnableCallback.) + +The ETW runtime will invoke this function to send notifications to a provider. +These notifications include the following values of the IsEnabled parameter: + +- EVENT_CONTROL_CODE_DISABLE_PROVIDER (0): No sessions are listening for events + from this provider. +- EVENT_CONTROL_CODE_ENABLE_PROVIDER (1): At least one session is listening for + events from this provider. This notification may be sent multiple times if + multiple different providers are listening, if a provider changes its level + or keyword masks, or if a provider updates its filter data. +- EVENT_CONTROL_CODE_CAPTURE_STATE (2): A session is requesting that this + provider log its state. + +Note that for the ENABLE_PROVIDER and CAPTURE_STATE notifications, the ETW +runtime will adjust the Level, MatchAnyKeyword, and MatchAllKeyword parameters +to the least-restrictive values set by any subscribed session. The callback is +not responsible for maintaining these values on a per-session basis. + +The provider can use these notifications to perform efficient event filtering. +While such filtering is optional (the ETW runtime will perform the same +filtering), filtering within the provider is usually much more efficient than +relying on ETW's internal filtering. Filtering within the provider usually +means checking a few global variables and can be done before preparing the +data to be sent to ETW. ETW's internal filtering always occurs after the data +has been prepared, and it requires looking up the provider's handle in a table. + +The provider can use the CAPTURE_STATE notification to log non-event +information (such as performance counters or system status) on-demand. +If the provider has no such state, it can ignore any CAPTURE_STATE events. + +Assuming that the callback saves the values of IsEnabled, Level, +MatchAnyKeyword, and MatchAllKeyword in global variables each time a +DISABLE_PROVIDER or ENABLE_PROVIDER notification occurs, an event would be +filtered as follows: + +if (g_IsEnabled != 0 && // Provider is enabled + event.Level <= g_Level && // Event passes level filter + (event.Keyword == 0 || ( // Event is uncategorized or passes keyword filter + (event.Keyword & g_MatchAnyKeyword) != 0 && + (event.Keyword & g_MatchAllKeyword) == g_MatchAllKeyword))) +{ + PrepareEventData(...); + EventWrite(...); +} + +Note that the code generated by mc.exe includes an efficient callback routine +and optimized event filtering system that implements the behavior described +above. The mc.exe-generated callback will be registered if you use the +mc.exe-generated EventRegister[ProviderName] macro to register the provider. +Similarly, when using TraceLoggingProvider.h, TraceLoggingRegister will +install its own callback routine so that it can efficiently filter each +TraceLoggingWrite event. + +If filtering performance is not critical, but you still want to avoid +preparing data unnecessarily, you can eliminate the need for a callback by +using the EventEnabled or EventProviderEnabled routines. These routines still +require ETW to perform a table lookup, but they can help you avoid the overhead +of preparing your data without needing to register a callback. In that case, +the above code would be replaced with something like this: + +if (EventProviderEnabled(regHandle, event.Level, event.Keyword)) +{ + PrepareEventData(...); + EventWrite(...); +} +*/ +typedef +VOID +(NTAPI *PENABLECALLBACK) ( + _In_ LPCGUID SourceId, + _In_ ULONG IsEnabled, + _In_ UCHAR Level, + _In_ ULONGLONG MatchAnyKeyword, + _In_ ULONGLONG MatchAllKeyword, + _In_opt_ PEVENT_FILTER_DESCRIPTOR FilterData, + _Inout_opt_ PVOID CallbackContext + ); + +#ifndef _APISET_EVENTING + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Registration APIs +// + +#if (WINVER >= _WIN32_WINNT_VISTA) + +/* +Registers a provider with the ETW runtime and obtains a handle to use with +calls to EventWrite. + +Note that the returned RegHandle must be closed by calling EventUnregister. +This is especially important if the provider is registered by DLL. If the DLL +unloads without closing the handle, the process may crash when the ETW runtime +attempts to invoke the provider's callback after the has unloaded. +*/ +ULONG +EVNTAPI +EventRegister( + _In_ LPCGUID ProviderId, + _In_opt_ PENABLECALLBACK EnableCallback, + _In_opt_ PVOID CallbackContext, + _Out_ PREGHANDLE RegHandle + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Closes the RegHandle that was opened by EventRegister. +*/ +ULONG +EVNTAPI +EventUnregister( + _In_ REGHANDLE RegHandle + ); +#endif + +#if (WINVER >= _WIN32_WINNT_WIN8) +/* +Used to provide the ETW runtime with additional information about your provider +or to configure how the ETW runtime handles your provider's events. +Refer to the documentation of the EVENT_INFO_CLASS for more information. +*/ +ULONG +EVNTAPI +EventSetInformation( + _In_ REGHANDLE RegHandle, + _In_ EVENT_INFO_CLASS InformationClass, + _In_reads_bytes_(InformationLength) PVOID EventInformation, + _In_ ULONG InformationLength + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Used to check whether any sessions are enabled to receive an event with the +Level and Keyword specified in the given EventDescriptor. + +Note that this function is not as efficient as the checks built into most +ETW frameworks (e.g. the checks implemented by mc.exe's generated code or by +TraceLoggingProvider.h). This function must look up the RegHandle state, while +the ETW frameworks can usually perform a direct check against global variables. +If using an ETW framework, use the framework's test APIs in preference to this +function. + +This function can be used to avoid performing expensive preparation before +calling EventWrite, i.e. to avoid spending CPU cycles looking up data and +packing it into EVENT_DATA_DESCRIPTORs. + +// This is a good idea if PrepareEventData(...) is expensive: +if (EventEnabled(regHandle, &myEventDesc)) +{ + PrepareEventData(...); + EventWrite(regHandle, &myEventDesc, ...); +} + +It is not necessary or efficient to use this function simply to avoid a call to +EventWrite. The EventWrite function will automatically perform an EventEnabled +check as its first operation. + +// This is unnecessary complexity and does not improve performance: +if (EventEnabled(regHandle, &myEventDesc)) +{ + EventWrite(regHandle, &myEventDesc, ...); +} +*/ +BOOLEAN +EVNTAPI +EventEnabled( + _In_ REGHANDLE RegHandle, + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Used to check whether any sessions are enabled to receive an event with the +given Level and Keyword. + +Note that this function is not as efficient as the checks built into most +ETW frameworks (e.g. the checks implemented by mc.exe's generated code or by +TraceLoggingProvider.h). This function must look up the RegHandle state, while +the ETW frameworks can usually perform a direct check against global variables. +If using an ETW framework, use the framework's test APIs in preference to this +function. + +This function can be used to avoid performing expensive preparation before +calling EventWrite, i.e. to avoid spending CPU cycles looking up data and +packing it into EVENT_DATA_DESCRIPTORs. + +// This is a good idea if PrepareEventData(...) is expensive: +if (EventProviderEnabled(regHandle, myEventDesc.Level, myEventDesc.Keyword)) +{ + PrepareEventData(...); + EventWrite(regHandle, &myEventDesc, ...); +} + +It is not necessary or efficient to use this function simply to avoid a call to +EventWrite. The EventWrite function will automatically perform an EventEnabled +check as its first operation. + +// This is unnecessary complexity and does not improve performance: +if (EventProviderEnabled(regHandle, myEventDesc.Level, myEventDesc.Keyword)) +{ + EventWrite(regHandle, &myEventDesc, ...); +} +*/ +BOOLEAN +EVNTAPI +EventProviderEnabled( + _In_ REGHANDLE RegHandle, + _In_ UCHAR Level, + _In_ ULONGLONG Keyword + ); +#endif + +// +// Writing (Publishing/Logging) APIs +// + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Logs an ETW event. + +Note that this function will use the implicit thread activity ID (from +thread-local storage) as the event's activity ID. + +UserData may be NULL if UserDataCount is 0. + +EventWrite(regHandle, &eventDesc, cData, pData) is equivalent to +EventWriteTransfer(regHandle, &eventDesc, NULL, NULL, cData, pData). +*/ +ULONG +EVNTAPI +EventWrite( + _In_ REGHANDLE RegHandle, + _In_ PCEVENT_DESCRIPTOR EventDescriptor, + _In_range_(0, MAX_EVENT_DATA_DESCRIPTORS) ULONG UserDataCount, + _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Logs an ETW event, optionally specifying activity IDs. + +If the ActivityId parameter is NULL, this function will use the implicit thread +activity ID (from thread-local storage) as the event's activity ID. + +If the RelatedActivityId parameter is NULL, the event will not include a +related activity ID. + +UserData may be NULL if UserDataCount is 0. + +EventWriteTransfer(regHandle, &eventDesc, pAI, pRAI, cData, pData) is equivalent to +EventWriteEx(regHandle, &eventDesc, 0, 0, pAI, pRAI, cData, pData). +*/ +ULONG +EVNTAPI +EventWriteTransfer( + _In_ REGHANDLE RegHandle, + _In_ PCEVENT_DESCRIPTOR EventDescriptor, + _In_opt_ LPCGUID ActivityId, + _In_opt_ LPCGUID RelatedActivityId, + _In_range_(0, MAX_EVENT_DATA_DESCRIPTORS) ULONG UserDataCount, + _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData + ); +#endif + +#if (WINVER >= _WIN32_WINNT_WIN7) +/* +Logs an ETW event, optionally specifying activity IDs, filter, and flags. + +The Filter parameter specifies sessions to which the event should not be +written. This should be set to 0 unless the provider is doing provider-size +filtering based on the FilterData parameter of the provider callback. + +The Flags parameter adds special behaviors to the event. Use EVENT_WRITE_FLAG +values, or 0 for no special behaviors. + +If the ActivityId parameter is NULL, this function will use the implicit thread +activity ID (from thread-local storage) as the event's activity ID. + +If the RelatedActivityId parameter is NULL, the event will not include a +related activity ID. + +UserData may be NULL if UserDataCount is 0. + +EventWriteTransfer(regHandle, &eventDesc, pAI, pRAI, cData, pData) is equivalent to +EventWriteEx(regHandle, &eventDesc, 0, 0, pAI, pRAI, cData, pData). +*/ +ULONG +EVNTAPI +EventWriteEx( + _In_ REGHANDLE RegHandle, + _In_ PCEVENT_DESCRIPTOR EventDescriptor, + _In_ ULONG64 Filter, + _In_ ULONG Flags, + _In_opt_ LPCGUID ActivityId, + _In_opt_ LPCGUID RelatedActivityId, + _In_range_(0, MAX_EVENT_DATA_DESCRIPTORS) ULONG UserDataCount, + _In_reads_opt_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Writes a simple event containing a string. +*/ +ULONG +EVNTAPI +EventWriteString( + _In_ REGHANDLE RegHandle, + _In_ UCHAR Level, + _In_ ULONGLONG Keyword, + _In_ PCWSTR String + ); +#endif + +#if (WINVER >= _WIN32_WINNT_VISTA) +/* +Performs operations on activity IDs. + +Use EVENT_ACTIVITY_CTRL values for the ControlCode parameter. + +Depending on the ControlCode, this function does one or more of the following: + +- Generate a new activity ID. +- Get the implicit thread activity ID. +- Set the implicit thread activity ID. + +Generating an activity ID using this API is faster than generating a GUID with +UuidCreate. The IDs generated by this API are not GUIDs -- they are only +guaranteed to be unique on the local machine and only during the current boot +session. +*/ +ULONG +EVNTAPI +EventActivityIdControl( + _In_ ULONG ControlCode, + _Inout_ LPGUID ActivityId + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +#endif // _ETW_KM_ + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) +/* +Initializes an EVENT_DATA_DESCRIPTOR with the given values. +*/ +EVNTPROV_PFORCEINLINE +VOID +EventDataDescCreate( + _Out_ PEVENT_DATA_DESCRIPTOR EventDataDescriptor, + _In_reads_bytes_(DataSize) const VOID* DataPtr, + _In_ ULONG DataSize + ) +{ + EventDataDescriptor->Ptr = (ULONGLONG)(ULONG_PTR)DataPtr; + EventDataDescriptor->Size = DataSize; + EventDataDescriptor->Reserved = 0; // Reserved MUST be initialized. + return; +} + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +/* +Initializes an EVENT_DESCRIPTOR with the given values. +*/ +EVNTPROV_PFORCEINLINE +VOID +EventDescCreate( + _Out_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ USHORT Id, + _In_ UCHAR Version, + _In_ UCHAR Channel, + _In_ UCHAR Level, + _In_ USHORT Task, + _In_ UCHAR Opcode, + _In_ ULONGLONG Keyword + ) +{ + EventDescriptor->Id = Id; + EventDescriptor->Version = Version; + EventDescriptor->Channel = Channel; + EventDescriptor->Level = Level; + EventDescriptor->Task = Task; + EventDescriptor->Opcode = Opcode; + EventDescriptor->Keyword = Keyword; + return; +} + +/* +Initializes an EVENT_DESCRIPTOR. Sets all values to 0. +*/ +EVNTPROV_PFORCEINLINE +VOID +EventDescZero( + _Out_ PEVENT_DESCRIPTOR EventDescriptor + ) +{ + memset(EventDescriptor, 0, sizeof(EVENT_DESCRIPTOR)); + return; +} + +// +// Macros to extract info from an Event Descriptor +// + +EVNTPROV_PFORCEINLINE +USHORT +EventDescGetId( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Id); +} + +EVNTPROV_PFORCEINLINE +UCHAR +EventDescGetVersion( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Version); +} + +EVNTPROV_PFORCEINLINE +USHORT +EventDescGetTask( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Task); +} + +EVNTPROV_PFORCEINLINE +UCHAR +EventDescGetOpcode( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Opcode); +} + +EVNTPROV_PFORCEINLINE +UCHAR +EventDescGetChannel( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Channel); +} + +EVNTPROV_PFORCEINLINE +UCHAR +EventDescGetLevel( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Level); +} + +EVNTPROV_PFORCEINLINE +ULONGLONG +EventDescGetKeyword( + _In_ PCEVENT_DESCRIPTOR EventDescriptor + ) +{ + return (EventDescriptor->Keyword); +} + +// +// Macros to set info into an Event Descriptor +// + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetId( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ USHORT Id + ) +{ + EventDescriptor->Id = Id; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetVersion( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ UCHAR Version + ) +{ + EventDescriptor->Version = Version; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetTask( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ USHORT Task + ) +{ + EventDescriptor->Task = Task; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetOpcode( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ UCHAR Opcode + ) +{ + EventDescriptor->Opcode = Opcode; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetLevel( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ UCHAR Level + ) +{ + EventDescriptor->Level = Level; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetChannel( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ UCHAR Channel + ) +{ + EventDescriptor->Channel = Channel; + return (EventDescriptor); +} + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescSetKeyword( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ ULONGLONG Keyword + ) +{ + EventDescriptor->Keyword = Keyword; + return (EventDescriptor); +} + + +EVNTPROV_PFORCEINLINE +PEVENT_DESCRIPTOR +EventDescOrKeyword( + _In_ PEVENT_DESCRIPTOR EventDescriptor, + _In_ ULONGLONG Keyword + ) +{ + EventDescriptor->Keyword |= Keyword; + return (EventDescriptor); +} + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + + + +#endif // MIDL_PASS + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntrace.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntrace.h new file mode 100644 index 0000000000000000000000000000000000000000..58677d492aae1a4a4fbfab5e99538fc1861fdc47 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/evntrace.h @@ -0,0 +1,2966 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + EvnTrace.h + +Abstract: + + Public headers for event tracing control applications, + consumers and providers + +--*/ + +#ifndef _EVNTRACE_ +#define _EVNTRACE_ + +#pragma once + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added */ +#endif + +#if defined(_WINNT_) || defined(WINNT) + +#if !defined(NO_ETW_APP_DEPRECATION_WARNINGS) + +#if (WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) || WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_GAMES)) && !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_SYSTEM) +#define ETW_APP_DECLSPEC_DEPRECATED __declspec(deprecated("This API is not recommended for general usage in Windows Store Apps or Games and may not be supported in future versions of Windows")) +#else +#define ETW_APP_DECLSPEC_DEPRECATED +#endif // (WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) || WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_GAMES)) && !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_SYSTEM) + +#else + +#define ETW_APP_DECLSPEC_DEPRECATED +#endif // NO_ETW_APP_DEPRECATION_WARNINGS + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef WMIAPI +#ifndef MIDL_PASS +#ifdef _WMI_SOURCE_ +#define WMIAPI __stdcall +#else +#define WMIAPI DECLSPEC_IMPORT __stdcall +#endif // _WMI_SOURCE +#endif // MIDL_PASS + +#endif // WMIAPI + +#include + +#if defined(_NTDDK_) || defined(_NTIFS_) || defined(_WMIKM_) + +#define _EVNTRACE_KERNEL_MODE + +#endif + +#if !defined(_EVNTRACE_KERNEL_MODE) + +#include + +#endif + +// +// EventTraceGuid is used to identify a event tracing session +// +DEFINE_GUID ( /* 68fdd900-4a3e-11d1-84f4-0000f80464e3 */ + EventTraceGuid, + 0x68fdd900, + 0x4a3e, + 0x11d1, + 0x84, 0xf4, 0x00, 0x00, 0xf8, 0x04, 0x64, 0xe3 + ); + +// +// SystemTraceControlGuid. Used to specify event tracing for kernel +// +DEFINE_GUID ( /* 9e814aad-3204-11d2-9a82-006008a86939 */ + SystemTraceControlGuid, + 0x9e814aad, + 0x3204, + 0x11d2, + 0x9a, 0x82, 0x00, 0x60, 0x08, 0xa8, 0x69, 0x39 + ); + +// +// EventTraceConfigGuid. Used to report system configuration records +// +DEFINE_GUID ( /* 01853a65-418f-4f36-aefc-dc0f1d2fd235 */ + EventTraceConfigGuid, + 0x01853a65, + 0x418f, + 0x4f36, + 0xae, 0xfc, 0xdc, 0x0f, 0x1d, 0x2f, 0xd2, 0x35 + ); + +// +// DefaultTraceSecurityGuid. Specifies the default event tracing security +// +DEFINE_GUID ( /* 0811c1af-7a07-4a06-82ed-869455cdf713 */ + DefaultTraceSecurityGuid, + 0x0811c1af, + 0x7a07, + 0x4a06, + 0x82, 0xed, 0x86, 0x94, 0x55, 0xcd, 0xf7, 0x13 + ); + + +// +// PrivateLoggerNotificationGuid +// Used for private cross-process logger notifications. +// + +DEFINE_GUID ( /* 3595ab5c-042a-4c8e-b942-2d059bfeb1b1 */ + PrivateLoggerNotificationGuid, + 0x3595ab5c, + 0x042a, + 0x4c8e, + 0xb9, 0x42, 0x2d, 0x05, 0x9b, 0xfe, 0xb1, 0xb1 + ); + +// +// System Provider GUIDs +// + +DEFINE_GUID( /* fbd09363-9e22-4661-b8bf-e7a34b535b8c */ + SystemIoFilterProviderGuid, + 0xfbd09363, + 0x9e22, + 0x4661, + 0xb8, 0xbf, 0xe7, 0xa3, 0x4b, 0x53, 0x5b, 0x8c + ); + +DEFINE_GUID( /* febd7460-3d1d-47eb-af49-c9eeb1e146f2 */ + SystemObjectProviderGuid, + 0xfebd7460, + 0x3d1d, + 0x47eb, + 0xaf, 0x49, 0xc9, 0xee, 0xb1, 0xe1, 0x46, 0xf2 + ); + +DEFINE_GUID( /* c134884a-32d5-4488-80e5-14ed7abb8269 */ + SystemPowerProviderGuid, + 0xc134884a, + 0x32d5, + 0x4488, + 0x80, 0xe5, 0x14, 0xed, 0x7a, 0xbb, 0x82, 0x69 + ); + +DEFINE_GUID( /* bafa072a-918a-4bed-b622-bc152097098f */ + SystemHypervisorProviderGuid, + 0xbafa072a, + 0x918a, + 0x4bed, + 0xb6, 0x22, 0xbc, 0x15, 0x20, 0x97, 0x9, 0x8f + ); + +DEFINE_GUID( /* 721ddfd3-dacc-4e1e-b26a-a2cb31d4705a */ + SystemLockProviderGuid, + 0x721ddfd3, + 0xdacc, + 0x4e1e, + 0xb2, 0x6a, 0xa2, 0xcb, 0x31, 0xd4, 0x70, 0x5a + ); + +DEFINE_GUID( /* fef3a8b6-318d-4b67-a96a-3b0f6b8f18fe */ + SystemConfigProviderGuid, + 0xfef3a8b6, + 0x318d, + 0x4b67, + 0xa9, 0x6a, 0x3b, 0xf, 0x6b, 0x8f, 0x18, 0xfe + ); + +DEFINE_GUID( /* c6c5265f-eae8-4650-aae4-9d48603d8510 */ + SystemCpuProviderGuid, + 0xc6c5265f, + 0xeae8, + 0x4650, + 0xaa, 0xe4, 0x9d, 0x48, 0x60, 0x3d, 0x85, 0x10 + ); + +DEFINE_GUID( /* 599a2a76-4d91-4910-9ac7-7d33f2e97a6c */ + SystemSchedulerProviderGuid, + 0x599a2a76, + 0x4d91, + 0x4910, + 0x9a, 0xc7, 0x7d, 0x33, 0xf2, 0xe9, 0x7a, 0x6c + ); + +DEFINE_GUID( /* bfeb0324-1cee-496f-a409-2ac2b48a6322 */ + SystemProfileProviderGuid, + 0xbfeb0324, + 0x1cee, + 0x496f, + 0xa4, 0x9, 0x2a, 0xc2, 0xb4, 0x8a, 0x63, 0x22 + ); + +DEFINE_GUID( /* 3d5c43e3-0f1c-4202-b817-174c0070dc79 */ + SystemIoProviderGuid, + 0x3d5c43e3, + 0xf1c, + 0x4202, + 0xb8, 0x17, 0x17, 0x4c, 0x0, 0x70, 0xdc, 0x79 + ); + +DEFINE_GUID( /* 82958ca9-b6cd-47f8-a3a8-03ae85a4bc24 */ + SystemMemoryProviderGuid, + 0x82958ca9, + 0xb6cd, + 0x47f8, + 0xa3, 0xa8, 0x3, 0xae, 0x85, 0xa4, 0xbc, 0x24 + ); + +DEFINE_GUID( /* 16156bd9-fab4-4cfa-a232-89d1099058e3 */ + SystemRegistryProviderGuid, + 0x16156bd9, + 0xfab4, + 0x4cfa, + 0xa2, 0x32, 0x89, 0xd1, 0x9, 0x90, 0x58, 0xe3 + ); + +DEFINE_GUID( /* 151f55dc-467d-471f-83b5-5f889d46ff66 */ + SystemProcessProviderGuid, + 0x151f55dc, + 0x467d, + 0x471f, + 0x83, 0xb5, 0x5f, 0x88, 0x9d, 0x46, 0xff, 0x66 + ); + +DEFINE_GUID( /* fcb9baaf-e529-4980-92e9-ced1a6aadfdf */ + SystemAlpcProviderGuid, + 0xfcb9baaf, + 0xe529, + 0x4980, + 0x92, 0xe9, 0xce, 0xd1, 0xa6, 0xaa, 0xdf, 0xdf + ); + +DEFINE_GUID( /* 434286f7-6f1b-45bb-b37e-95f623046c7c */ + SystemSyscallProviderGuid, + 0x434286f7, + 0x6f1b, + 0x45bb, + 0xb3, 0x7e, 0x95, 0xf6, 0x23, 0x04, 0x6c, 0x7c + ); + +DEFINE_GUID( /* d4bbee17-b545-4888-858b-744169015b25 */ + SystemInterruptProviderGuid, + 0xd4bbee17, + 0xb545, + 0x4888, + 0x85, 0x8b, 0x74, 0x41, 0x69, 0x01, 0x5b, 0x25 + ); + +DEFINE_GUID( /* 4f061568-e215-499f-ab2e-eda0ae890a5b */ + SystemTimerProviderGuid, + 0x4f061568, + 0xe215, + 0x499f, + 0xab, 0x2e, 0xed, 0xa0, 0xae, 0x89, 0x0a, 0x5b + ); + +DEFINE_GUID( /* 99134383-5248-43fc-834b-529454e75df3 */ + LastBranchRecordProviderGuid, + 0x99134383, + 0x5248, + 0x43fc, + 0x83, 0x4b, 0x52, 0x94, 0x54, 0xe7, 0x5d, 0xf3 + ); + +#define KERNEL_LOGGER_NAMEW L"NT Kernel Logger" +#define GLOBAL_LOGGER_NAMEW L"GlobalLogger" +#define EVENT_LOGGER_NAMEW L"EventLog" +#define DIAG_LOGGER_NAMEW L"DiagLog" + +#define KERNEL_LOGGER_NAMEA "NT Kernel Logger" +#define GLOBAL_LOGGER_NAMEA "GlobalLogger" +#define EVENT_LOGGER_NAMEA "EventLog" +#define DIAG_LOGGER_NAMEA "DiagLog" + +#define MAX_MOF_FIELDS 16 // Limit of USE_MOF_PTR fields + +#ifndef _TRACEHANDLE_DEFINED +#define _TRACEHANDLE_DEFINED +// Obsolete - prefer PROCESSTRACE_HANDLE or CONTROLTRACE_ID. +typedef ULONG64 TRACEHANDLE, *PTRACEHANDLE; +#endif + +// Used to read the events from a trace file or real-time trace session (via +// ProcessTrace). The handle is invalid if it contains the value +// INVALID_PROCESSTRACE_HANDLE. Obtain the handle by calling an OpenTrace +// function (e.g. OpenTrace, OpenTraceFromFile, OpenTraceFromRealTimeLogger). +// Close the handle by calling CloseTrace. +typedef ULONG64 PROCESSTRACE_HANDLE; + +// Used to identify a trace collection session. The id is invalid if it +// contains the value (CONTROLTRACE_ID)0. Obtain the id from StartTrace or from +// the Wnode.HistoricalContext field of the EVENT_TRACE_PROPERTIES returned by +// ControlTrace(0, sessionName, ...). The id is valid until the trace stops and +// does not need to be closed by the user. +typedef ULONG64 CONTROLTRACE_ID; + + //types for event data going to System Event Logger +#define SYSTEM_EVENT_TYPE 1 + +// +// predefined generic event types (0x00 to 0x09 reserved). +// + +#define EVENT_TRACE_TYPE_INFO 0x00 // Info or point event +#define EVENT_TRACE_TYPE_START 0x01 // Start event +#define EVENT_TRACE_TYPE_END 0x02 // End event +#define EVENT_TRACE_TYPE_STOP 0x02 // Stop event (WinEvent compatible) +#define EVENT_TRACE_TYPE_DC_START 0x03 // Collection start marker +#define EVENT_TRACE_TYPE_DC_END 0x04 // Collection end marker +#define EVENT_TRACE_TYPE_EXTENSION 0x05 // Extension/continuation +#define EVENT_TRACE_TYPE_REPLY 0x06 // Reply event +#define EVENT_TRACE_TYPE_DEQUEUE 0x07 // De-queue event +#define EVENT_TRACE_TYPE_RESUME 0x07 // Resume event (WinEvent compatible) +#define EVENT_TRACE_TYPE_CHECKPOINT 0x08 // Generic checkpoint event +#define EVENT_TRACE_TYPE_SUSPEND 0x08 // Suspend event (WinEvent compatible) +#define EVENT_TRACE_TYPE_WINEVT_SEND 0x09 // Send Event (WinEvent compatible) +#define EVENT_TRACE_TYPE_WINEVT_RECEIVE 0XF0 // Receive Event (WinEvent compatible) + +// +// Predefined Event Tracing Levels for Software/Debug Tracing +// +// +// Trace Level is UCHAR and passed in through the EnableLevel parameter +// in EnableTrace API. It is retrieved by the provider using the +// GetTraceEnableLevel macro.It should be interpreted as an integer value +// to mean everything at or below that level will be traced. +// +// Here are the possible Levels. +// + +#define TRACE_LEVEL_NONE 0 // Tracing is not on +#define TRACE_LEVEL_CRITICAL 1 // Abnormal exit or termination +#define TRACE_LEVEL_FATAL 1 // Deprecated name for Abnormal exit or termination +#define TRACE_LEVEL_ERROR 2 // Severe errors that need logging +#define TRACE_LEVEL_WARNING 3 // Warnings such as allocation failure +#define TRACE_LEVEL_INFORMATION 4 // Includes non-error cases(e.g.,Entry-Exit) +#define TRACE_LEVEL_VERBOSE 5 // Detailed traces from intermediate steps +#define TRACE_LEVEL_RESERVED6 6 +#define TRACE_LEVEL_RESERVED7 7 +#define TRACE_LEVEL_RESERVED8 8 +#define TRACE_LEVEL_RESERVED9 9 + + +// +// Event types for Process & Threads +// + +#define EVENT_TRACE_TYPE_LOAD 0x0A // Load image +#define EVENT_TRACE_TYPE_TERMINATE 0x0B // Terminate Process + +// +// Event types for IO subsystem +// + +#define EVENT_TRACE_TYPE_IO_READ 0x0A +#define EVENT_TRACE_TYPE_IO_WRITE 0x0B +#define EVENT_TRACE_TYPE_IO_READ_INIT 0x0C +#define EVENT_TRACE_TYPE_IO_WRITE_INIT 0x0D +#define EVENT_TRACE_TYPE_IO_FLUSH 0x0E +#define EVENT_TRACE_TYPE_IO_FLUSH_INIT 0x0F +#define EVENT_TRACE_TYPE_IO_REDIRECTED_INIT 0x10 + +// +// Event types for Memory subsystem +// + +#define EVENT_TRACE_TYPE_MM_TF 0x0A // Transition fault +#define EVENT_TRACE_TYPE_MM_DZF 0x0B // Demand Zero fault +#define EVENT_TRACE_TYPE_MM_COW 0x0C // Copy on Write +#define EVENT_TRACE_TYPE_MM_GPF 0x0D // Guard Page fault +#define EVENT_TRACE_TYPE_MM_HPF 0x0E // Hard page fault +#define EVENT_TRACE_TYPE_MM_AV 0x0F // Access violation + +// +// Event types for Network subsystem, all protocols +// + +#define EVENT_TRACE_TYPE_SEND 0x0A // Send +#define EVENT_TRACE_TYPE_RECEIVE 0x0B // Receive +#define EVENT_TRACE_TYPE_CONNECT 0x0C // Connect +#define EVENT_TRACE_TYPE_DISCONNECT 0x0D // Disconnect +#define EVENT_TRACE_TYPE_RETRANSMIT 0x0E // ReTransmit +#define EVENT_TRACE_TYPE_ACCEPT 0x0F // Accept +#define EVENT_TRACE_TYPE_RECONNECT 0x10 // ReConnect +#define EVENT_TRACE_TYPE_CONNFAIL 0x11 // Fail +#define EVENT_TRACE_TYPE_COPY_TCP 0x12 // Copy in PendData +#define EVENT_TRACE_TYPE_COPY_ARP 0x13 // NDIS_STATUS_RESOURCES Copy +#define EVENT_TRACE_TYPE_ACKFULL 0x14 // A full data ACK +#define EVENT_TRACE_TYPE_ACKPART 0x15 // A Partial data ACK +#define EVENT_TRACE_TYPE_ACKDUP 0x16 // A Duplicate data ACK + + +// +// Event Types for the Header (to handle internal event headers) +// + +#define EVENT_TRACE_TYPE_GUIDMAP 0x0A +#define EVENT_TRACE_TYPE_CONFIG 0x0B +#define EVENT_TRACE_TYPE_SIDINFO 0x0C +#define EVENT_TRACE_TYPE_SECURITY 0x0D +#define EVENT_TRACE_TYPE_DBGID_RSDS 0x40 + +// +// Event Types for Registry subsystem +// + +#define EVENT_TRACE_TYPE_REGCREATE 0x0A // NtCreateKey +#define EVENT_TRACE_TYPE_REGOPEN 0x0B // NtOpenKey +#define EVENT_TRACE_TYPE_REGDELETE 0x0C // NtDeleteKey +#define EVENT_TRACE_TYPE_REGQUERY 0x0D // NtQueryKey +#define EVENT_TRACE_TYPE_REGSETVALUE 0x0E // NtSetValueKey +#define EVENT_TRACE_TYPE_REGDELETEVALUE 0x0F // NtDeleteValueKey +#define EVENT_TRACE_TYPE_REGQUERYVALUE 0x10 // NtQueryValueKey +#define EVENT_TRACE_TYPE_REGENUMERATEKEY 0x11 // NtEnumerateKey +#define EVENT_TRACE_TYPE_REGENUMERATEVALUEKEY 0x12 // NtEnumerateValueKey +#define EVENT_TRACE_TYPE_REGQUERYMULTIPLEVALUE 0x13 // NtQueryMultipleValueKey +#define EVENT_TRACE_TYPE_REGSETINFORMATION 0x14 // NtSetInformationKey +#define EVENT_TRACE_TYPE_REGFLUSH 0x15 // NtFlushKey +#define EVENT_TRACE_TYPE_REGKCBCREATE 0x16 // KcbCreate +#define EVENT_TRACE_TYPE_REGKCBDELETE 0x17 // KcbDelete +#define EVENT_TRACE_TYPE_REGKCBRUNDOWNBEGIN 0x18 // KcbRundownBegin +#define EVENT_TRACE_TYPE_REGKCBRUNDOWNEND 0x19 // KcbRundownEnd +#define EVENT_TRACE_TYPE_REGVIRTUALIZE 0x1A // VirtualizeKey +#define EVENT_TRACE_TYPE_REGCLOSE 0x1B // NtClose (KeyObject) +#define EVENT_TRACE_TYPE_REGSETSECURITY 0x1C // SetSecurityDescriptor (KeyObject) +#define EVENT_TRACE_TYPE_REGQUERYSECURITY 0x1D // QuerySecurityDescriptor (KeyObject) +#define EVENT_TRACE_TYPE_REGCOMMIT 0x1E // CmKtmNotification (TRANSACTION_NOTIFY_COMMIT) +#define EVENT_TRACE_TYPE_REGPREPARE 0x1F // CmKtmNotification (TRANSACTION_NOTIFY_PREPARE) +#define EVENT_TRACE_TYPE_REGROLLBACK 0x20 // CmKtmNotification (TRANSACTION_NOTIFY_ROLLBACK) +#define EVENT_TRACE_TYPE_REGMOUNTHIVE 0x21 // NtLoadKey variations + system hives + +// +// Event types for system configuration records +// +#define EVENT_TRACE_TYPE_CONFIG_CPU 0x0A // CPU Configuration +#define EVENT_TRACE_TYPE_CONFIG_PHYSICALDISK 0x0B // Physical Disk Configuration +#define EVENT_TRACE_TYPE_CONFIG_LOGICALDISK 0x0C // Logical Disk Configuration +#define EVENT_TRACE_TYPE_CONFIG_NIC 0x0D // NIC Configuration +#define EVENT_TRACE_TYPE_CONFIG_VIDEO 0x0E // Video Adapter Configuration +#define EVENT_TRACE_TYPE_CONFIG_SERVICES 0x0F // Active Services +#define EVENT_TRACE_TYPE_CONFIG_POWER 0x10 // ACPI Configuration +#define EVENT_TRACE_TYPE_CONFIG_NETINFO 0x11 // Networking Configuration +#define EVENT_TRACE_TYPE_CONFIG_OPTICALMEDIA 0x12 // Optical Media Configuration +#define EVENT_TRACE_TYPE_CONFIG_PHYSICALDISK_EX 0x13 // Physical Disk Extended Configuration + +#define EVENT_TRACE_TYPE_CONFIG_IRQ 0x15 // IRQ assigned to devices +#define EVENT_TRACE_TYPE_CONFIG_PNP 0x16 // PnP device info +#define EVENT_TRACE_TYPE_CONFIG_IDECHANNEL 0x17 // Primary/Secondary IDE channel Configuration +#define EVENT_TRACE_TYPE_CONFIG_NUMANODE 0x18 // Numa configuration +#define EVENT_TRACE_TYPE_CONFIG_PLATFORM 0x19 // Platform Configuration +#define EVENT_TRACE_TYPE_CONFIG_PROCESSORGROUP 0x1A // Processor Group Configuration +#define EVENT_TRACE_TYPE_CONFIG_PROCESSORNUMBER 0x1B // ProcessorIndex -> ProcNumber mapping +#define EVENT_TRACE_TYPE_CONFIG_DPI 0x1C // Display DPI Configuration +#define EVENT_TRACE_TYPE_CONFIG_CI_INFO 0x1D // Display System Code Integrity Information +#define EVENT_TRACE_TYPE_CONFIG_MACHINEID 0x1E // SQM Machine Id +#define EVENT_TRACE_TYPE_CONFIG_DEFRAG 0x1F // Logical Disk Defragmenter Information +#define EVENT_TRACE_TYPE_CONFIG_MOBILEPLATFORM 0x20 // Mobile Platform Configuration +#define EVENT_TRACE_TYPE_CONFIG_DEVICEFAMILY 0x21 // Device Family Information +#define EVENT_TRACE_TYPE_CONFIG_FLIGHTID 0x22 // Flights on the machine +#define EVENT_TRACE_TYPE_CONFIG_PROCESSOR 0x23 // CentralProcessor records +#define EVENT_TRACE_TYPE_CONFIG_VIRTUALIZATION 0x24 // virtualization config info +#define EVENT_TRACE_TYPE_CONFIG_BOOT 0x25 // boot config info + +// +// Event types for Optical IO subsystem +// + +#define EVENT_TRACE_TYPE_OPTICAL_IO_READ 0x37 +#define EVENT_TRACE_TYPE_OPTICAL_IO_WRITE 0x38 +#define EVENT_TRACE_TYPE_OPTICAL_IO_FLUSH 0x39 +#define EVENT_TRACE_TYPE_OPTICAL_IO_READ_INIT 0x3a +#define EVENT_TRACE_TYPE_OPTICAL_IO_WRITE_INIT 0x3b +#define EVENT_TRACE_TYPE_OPTICAL_IO_FLUSH_INIT 0x3c + +// +// Event types for Filter Manager +// + +#define EVENT_TRACE_TYPE_FLT_PREOP_INIT 0x60 // Minifilter preop initiation +#define EVENT_TRACE_TYPE_FLT_POSTOP_INIT 0x61 // Minifilter postop initiation +#define EVENT_TRACE_TYPE_FLT_PREOP_COMPLETION 0x62 // Minifilter preop completion +#define EVENT_TRACE_TYPE_FLT_POSTOP_COMPLETION 0x63 // Minifilter postop completion +#define EVENT_TRACE_TYPE_FLT_PREOP_FAILURE 0x64 // Minifilter failed preop +#define EVENT_TRACE_TYPE_FLT_POSTOP_FAILURE 0x65 // Minifilter failed postop + +// +// Enable flags for Kernel Events +// +#define EVENT_TRACE_FLAG_PROCESS 0x00000001 // process start & end +#define EVENT_TRACE_FLAG_THREAD 0x00000002 // thread start & end +#define EVENT_TRACE_FLAG_IMAGE_LOAD 0x00000004 // image load + +#define EVENT_TRACE_FLAG_DISK_IO 0x00000100 // physical disk IO +#define EVENT_TRACE_FLAG_DISK_FILE_IO 0x00000200 // requires disk IO + +#define EVENT_TRACE_FLAG_MEMORY_PAGE_FAULTS 0x00001000 // all page faults +#define EVENT_TRACE_FLAG_MEMORY_HARD_FAULTS 0x00002000 // hard faults only + +#define EVENT_TRACE_FLAG_NETWORK_TCPIP 0x00010000 // tcpip send & receive + +#define EVENT_TRACE_FLAG_REGISTRY 0x00020000 // registry calls +#define EVENT_TRACE_FLAG_DBGPRINT 0x00040000 // DbgPrint(ex) Calls + +// +// Enable flags for Kernel Events on Vista and above +// +#define EVENT_TRACE_FLAG_PROCESS_COUNTERS 0x00000008 // process perf counters +#define EVENT_TRACE_FLAG_CSWITCH 0x00000010 // context switches +#define EVENT_TRACE_FLAG_DPC 0x00000020 // deferred procedure calls +#define EVENT_TRACE_FLAG_INTERRUPT 0x00000040 // interrupts +#define EVENT_TRACE_FLAG_SYSTEMCALL 0x00000080 // system calls + +#define EVENT_TRACE_FLAG_DISK_IO_INIT 0x00000400 // physical disk IO initiation +#define EVENT_TRACE_FLAG_ALPC 0x00100000 // ALPC traces +#define EVENT_TRACE_FLAG_SPLIT_IO 0x00200000 // split io traces (VolumeManager) + +#define EVENT_TRACE_FLAG_DRIVER 0x00800000 // driver delays +#define EVENT_TRACE_FLAG_PROFILE 0x01000000 // sample based profiling +#define EVENT_TRACE_FLAG_FILE_IO 0x02000000 // file IO +#define EVENT_TRACE_FLAG_FILE_IO_INIT 0x04000000 // file IO initiation + +// +// Enable flags for Kernel Events on Win7 and above +// +#define EVENT_TRACE_FLAG_DISPATCHER 0x00000800 // scheduler (ReadyThread) +#define EVENT_TRACE_FLAG_VIRTUAL_ALLOC 0x00004000 // VM operations + +// +// Enable flags for Kernel Events on Win8 and above +// +#define EVENT_TRACE_FLAG_VAMAP 0x00008000 // map/unmap (excluding images) +#define EVENT_TRACE_FLAG_NO_SYSCONFIG 0x10000000 // Do not do sys config rundown + +// +// Enable flags for Kernel Events on Threshold and above +// +#define EVENT_TRACE_FLAG_JOB 0x00080000 // job start & end +#define EVENT_TRACE_FLAG_DEBUG_EVENTS 0x00400000 // debugger events (break/continue/...) + +// +// Pre-defined Enable flags for everybody else +// +#define EVENT_TRACE_FLAG_EXTENSION 0x80000000 // Indicates more flags +#define EVENT_TRACE_FLAG_FORWARD_WMI 0x40000000 // Can forward to WMI +#define EVENT_TRACE_FLAG_ENABLE_RESERVE 0x20000000 // Reserved + +// +// Logger Mode flags +// +#define EVENT_TRACE_FILE_MODE_NONE 0x00000000 // Logfile is off +#define EVENT_TRACE_FILE_MODE_SEQUENTIAL 0x00000001 // Log sequentially +#define EVENT_TRACE_FILE_MODE_CIRCULAR 0x00000002 // Log in circular manner +#define EVENT_TRACE_FILE_MODE_APPEND 0x00000004 // Append sequential log + +#define EVENT_TRACE_REAL_TIME_MODE 0x00000100 // Real time mode on +#define EVENT_TRACE_DELAY_OPEN_FILE_MODE 0x00000200 // Delay opening file +#define EVENT_TRACE_BUFFERING_MODE 0x00000400 // Buffering mode only +#define EVENT_TRACE_PRIVATE_LOGGER_MODE 0x00000800 // Process Private Logger +#define EVENT_TRACE_ADD_HEADER_MODE 0x00001000 // Add a logfile header + +#define EVENT_TRACE_USE_GLOBAL_SEQUENCE 0x00004000 // Use global sequence no. +#define EVENT_TRACE_USE_LOCAL_SEQUENCE 0x00008000 // Use local sequence no. + +#define EVENT_TRACE_RELOG_MODE 0x00010000 // Relogger + +#define EVENT_TRACE_USE_PAGED_MEMORY 0x01000000 // Use pageable buffers + +// +// Logger Mode flags on XP and above +// + +#define EVENT_TRACE_FILE_MODE_NEWFILE 0x00000008 // Auto-switch log file +#define EVENT_TRACE_FILE_MODE_PREALLOCATE 0x00000020 // Pre-allocate mode + +// +// Logger Mode flags on Vista and above +// + +#define EVENT_TRACE_NONSTOPPABLE_MODE 0x00000040 // Session cannot be stopped (Autologger only) +#define EVENT_TRACE_SECURE_MODE 0x00000080 // Secure session +#define EVENT_TRACE_USE_KBYTES_FOR_SIZE 0x00002000 // Use KBytes as file size unit +#define EVENT_TRACE_PRIVATE_IN_PROC 0x00020000 // In process private logger + +#define EVENT_TRACE_MODE_RESERVED 0x00100000 // Reserved bit, used to signal Heap/Critsec tracing + +// +// Logger Mode flags on Win7 and above +// + +#define EVENT_TRACE_NO_PER_PROCESSOR_BUFFERING 0x10000000 // Use this for low frequency sessions. + +// +// Logger Mode flags on Win8 and above +// + +#define EVENT_TRACE_SYSTEM_LOGGER_MODE 0x02000000 // Receive events from SystemTraceProvider +#define EVENT_TRACE_ADDTO_TRIAGE_DUMP 0x80000000 // Add ETW buffers to triage dumps +#define EVENT_TRACE_STOP_ON_HYBRID_SHUTDOWN 0x00400000 // Stop on hybrid shutdown +#define EVENT_TRACE_PERSIST_ON_HYBRID_SHUTDOWN 0x00800000 // Persist on hybrid shutdown + +// +// Logger Mode flags on Blue and above +// + +#define EVENT_TRACE_INDEPENDENT_SESSION_MODE 0x08000000 // Independent logger session + +// +// Logger Mode flags on Redstone and above +// + +#define EVENT_TRACE_COMPRESSED_MODE 0x04000000 // Compressed logger session. + +// +// ControlTrace Codes +// + +#define EVENT_TRACE_CONTROL_QUERY 0 +#define EVENT_TRACE_CONTROL_STOP 1 +#define EVENT_TRACE_CONTROL_UPDATE 2 + +// +// Flush ControlTrace Codes for XP and above +// + +#define EVENT_TRACE_CONTROL_FLUSH 3 // Flushes all the buffers + +// +// Supported for RS5 and above. +// + +#define EVENT_TRACE_CONTROL_INCREMENT_FILE 4 // Causes a session with EVENT_TRACE_FILE_MODE_NEWFILE + // to switch to the next file before the automatic + // switching criteria is met + +// +// Supported for Manganese and above. +// + +#define EVENT_TRACE_CONTROL_CONVERT_TO_REALTIME 5 // Transitions from file mode tracing to real-time. + +// +// Flags used by WMI Trace Message +// Note that the order or value of these flags should NOT be changed as they are processed +// in this order. +// + +#define TRACE_MESSAGE_SEQUENCE 1 // Message should include a sequence number +#define TRACE_MESSAGE_GUID 2 // Message includes a GUID +#define TRACE_MESSAGE_COMPONENTID 4 // Message has no GUID, Component ID instead +#define TRACE_MESSAGE_TIMESTAMP 8 // Message includes a timestamp +#define TRACE_MESSAGE_PERFORMANCE_TIMESTAMP 16 // *Obsolete* Clock type is controlled by the logger +#define TRACE_MESSAGE_SYSTEMINFO 32 // Message includes system information TID,PID + +// +// Vista flags set by system to indicate provider pointer size. +// + +#define TRACE_MESSAGE_POINTER32 0x0040 // Message logged by 32 bit provider +#define TRACE_MESSAGE_POINTER64 0x0080 // Message logged by 64 bit provider + +#define TRACE_MESSAGE_FLAG_MASK 0xFFFF // Only the lower 16 bits of flags are placed in the message + // those above 16 bits are reserved for local processing +// +// Maximum size allowed for a single TraceMessage message. +// +// N.B. This limit was increased from 8K to 64K in Win8. +// + +#define TRACE_MESSAGE_MAXIMUM_SIZE (64 * 1024) + +// +// Flags to indicate to consumer which fields +// in the EVENT_TRACE_HEADER are valid +// + +#define EVENT_TRACE_USE_PROCTIME 0x0001 // ProcessorTime field is valid +#define EVENT_TRACE_USE_NOCPUTIME 0x0002 // No Kernel/User/Processor Times + +// +// TRACE_HEADER_FLAG values are used in the Flags field of EVENT_TRACE_HEADER +// structure while calling into TraceEvent API +// + +#define TRACE_HEADER_FLAG_USE_TIMESTAMP 0x00000200 +#define TRACE_HEADER_FLAG_TRACED_GUID 0x00020000 // denotes a trace +#define TRACE_HEADER_FLAG_LOG_WNODE 0x00040000 // request to log Wnode +#define TRACE_HEADER_FLAG_USE_GUID_PTR 0x00080000 // Guid is actually a pointer +#define TRACE_HEADER_FLAG_USE_MOF_PTR 0x00100000 // MOF data are dereferenced + +// +// Keywords to be used for the System ALPC Provider. +// + +#define SYSTEM_ALPC_KW_GENERAL 0x0000000000000001 + +// +// Keywords to be used for the System Config Provider. +// + +#define SYSTEM_CONFIG_KW_SYSTEM 0x0000000000000001 +#define SYSTEM_CONFIG_KW_GRAPHICS 0x0000000000000002 +#define SYSTEM_CONFIG_KW_STORAGE 0x0000000000000004 +#define SYSTEM_CONFIG_KW_NETWORK 0x0000000000000008 +#define SYSTEM_CONFIG_KW_SERVICES 0x0000000000000010 +#define SYSTEM_CONFIG_KW_PNP 0x0000000000000020 +#define SYSTEM_CONFIG_KW_OPTICAL 0x0000000000000040 + +// +// Keywords to be used for the System CPU Provider. +// + +#define SYSTEM_CPU_KW_CONFIG 0x0000000000000001 +#define SYSTEM_CPU_KW_CACHE_FLUSH 0x0000000000000002 +#define SYSTEM_CPU_KW_SPEC_CONTROL 0x0000000000000004 +#define SYSTEM_CPU_KW_DOMAIN_CHANGE 0x0000000000000008 + +// +// Keywords to be used for the System Hypervisor Provider. +// + +#define SYSTEM_HYPERVISOR_KW_PROFILE 0x0000000000000001 +#define SYSTEM_HYPERVISOR_KW_CALLOUTS 0x0000000000000002 +#define SYSTEM_HYPERVISOR_KW_VTL_CHANGE 0x0000000000000004 + +// +// Keywords to be used for the System Interrupt Provider. +// + +#define SYSTEM_INTERRUPT_KW_GENERAL 0x0000000000000001 +#define SYSTEM_INTERRUPT_KW_CLOCK_INTERRUPT 0x0000000000000002 +#define SYSTEM_INTERRUPT_KW_DPC 0x0000000000000004 +#define SYSTEM_INTERRUPT_KW_DPC_QUEUE 0x0000000000000008 +#define SYSTEM_INTERRUPT_KW_WDF_DPC 0x0000000000000010 +#define SYSTEM_INTERRUPT_KW_WDF_INTERRUPT 0x0000000000000020 +#define SYSTEM_INTERRUPT_KW_IPI 0x0000000000000040 + +// +// Keywords to be used for the System IO Provider. +// + +#define SYSTEM_IO_KW_DISK 0x0000000000000001 +#define SYSTEM_IO_KW_DISK_INIT 0x0000000000000002 +#define SYSTEM_IO_KW_FILENAME 0x0000000000000004 +#define SYSTEM_IO_KW_SPLIT 0x0000000000000008 +#define SYSTEM_IO_KW_FILE 0x0000000000000010 +#define SYSTEM_IO_KW_OPTICAL 0x0000000000000020 +#define SYSTEM_IO_KW_OPTICAL_INIT 0x0000000000000040 +#define SYSTEM_IO_KW_DRIVERS 0x0000000000000080 +#define SYSTEM_IO_KW_CC 0x0000000000000100 +#define SYSTEM_IO_KW_NETWORK 0x0000000000000200 +#define SYSTEM_IO_KW_FILE_INIT 0x0000000000000400 +#define SYSTEM_IO_KW_TIMER 0x0000000000000800 + +// +// Keywords to be used for the System IoFilter Provider. +// + +#define SYSTEM_IOFILTER_KW_GENERAL 0x0000000000000001 +#define SYSTEM_IOFILTER_KW_INIT 0x0000000000000002 +#define SYSTEM_IOFILTER_KW_FASTIO 0x0000000000000004 +#define SYSTEM_IOFILTER_KW_FAILURE 0x0000000000000008 + +// +// Keywords to be used for the System SpinLock Provider. +// + +#define SYSTEM_LOCK_KW_SPINLOCK 0x0000000000000001 +#define SYSTEM_LOCK_KW_SPINLOCK_COUNTERS 0x0000000000000002 +#define SYSTEM_LOCK_KW_SYNC_OBJECTS 0x0000000000000004 + +// +// Keywords to be used for the System Memory Provider. +// + +#define SYSTEM_MEMORY_KW_GENERAL 0x0000000000000001 +#define SYSTEM_MEMORY_KW_HARD_FAULTS 0x0000000000000002 +#define SYSTEM_MEMORY_KW_ALL_FAULTS 0x0000000000000004 +#define SYSTEM_MEMORY_KW_POOL 0x0000000000000008 +#define SYSTEM_MEMORY_KW_MEMINFO 0x0000000000000010 +#define SYSTEM_MEMORY_KW_PFSECTION 0x0000000000000020 +#define SYSTEM_MEMORY_KW_MEMINFO_WS 0x0000000000000040 +#define SYSTEM_MEMORY_KW_HEAP 0x0000000000000080 +#define SYSTEM_MEMORY_KW_WS 0x0000000000000100 +#define SYSTEM_MEMORY_KW_CONTMEM_GEN 0x0000000000000200 +#define SYSTEM_MEMORY_KW_VIRTUAL_ALLOC 0x0000000000000400 +#define SYSTEM_MEMORY_KW_FOOTPRINT 0x0000000000000800 +#define SYSTEM_MEMORY_KW_SESSION 0x0000000000001000 +#define SYSTEM_MEMORY_KW_REFSET 0x0000000000002000 +#define SYSTEM_MEMORY_KW_VAMAP 0x0000000000004000 +#define SYSTEM_MEMORY_KW_NONTRADEABLE 0x0000000000008000 + +// +// Keywords to be used for the System Object Provider. +// + +#define SYSTEM_OBJECT_KW_GENERAL 0x0000000000000001 +#define SYSTEM_OBJECT_KW_HANDLE 0x0000000000000002 + +// +// Keywords to be used for the System Power Provider. +// + +#define SYSTEM_POWER_KW_GENERAL 0x0000000000000001 +#define SYSTEM_POWER_KW_HIBER_RUNDOWN 0x0000000000000002 +#define SYSTEM_POWER_KW_PROCESSOR_IDLE 0x0000000000000004 +#define SYSTEM_POWER_KW_IDLE_SELECTION 0x0000000000000008 +#define SYSTEM_POWER_KW_PPM_EXIT_LATENCY 0x0000000000000010 + +// +// Keywords to be used for the System Process Provider. +// + +#define SYSTEM_PROCESS_KW_GENERAL 0x0000000000000001 +#define SYSTEM_PROCESS_KW_INSWAP 0x0000000000000002 +#define SYSTEM_PROCESS_KW_FREEZE 0x0000000000000004 +#define SYSTEM_PROCESS_KW_PERF_COUNTER 0x0000000000000008 +#define SYSTEM_PROCESS_KW_WAKE_COUNTER 0x0000000000000010 +#define SYSTEM_PROCESS_KW_WAKE_DROP 0x0000000000000020 +#define SYSTEM_PROCESS_KW_WAKE_EVENT 0x0000000000000040 +#define SYSTEM_PROCESS_KW_DEBUG_EVENTS 0x0000000000000080 +#define SYSTEM_PROCESS_KW_DBGPRINT 0x0000000000000100 +#define SYSTEM_PROCESS_KW_JOB 0x0000000000000200 +#define SYSTEM_PROCESS_KW_WORKER_THREAD 0x0000000000000400 +#define SYSTEM_PROCESS_KW_THREAD 0x0000000000000800 +#define SYSTEM_PROCESS_KW_LOADER 0x0000000000001000 + +// +// Keywords to be used for the System Profile Provider. +// + +#define SYSTEM_PROFILE_KW_GENERAL 0x0000000000000001 +#define SYSTEM_PROFILE_KW_PMC_PROFILE 0x0000000000000002 + +// +// Keywords to be used for the System Registry Provider. +// + +#define SYSTEM_REGISTRY_KW_GENERAL 0x0000000000000001 +#define SYSTEM_REGISTRY_KW_HIVE 0x0000000000000002 +#define SYSTEM_REGISTRY_KW_NOTIFICATION 0x0000000000000004 + +// +// Keywords to be used for the System Scheduler Provider. +// + +#define SYSTEM_SCHEDULER_KW_XSCHEDULER 0x0000000000000001 +#define SYSTEM_SCHEDULER_KW_DISPATCHER 0x0000000000000002 +#define SYSTEM_SCHEDULER_KW_KERNEL_QUEUE 0x0000000000000004 +#define SYSTEM_SCHEDULER_KW_SHOULD_YIELD 0x0000000000000008 +#define SYSTEM_SCHEDULER_KW_ANTI_STARVATION 0x0000000000000010 +#define SYSTEM_SCHEDULER_KW_LOAD_BALANCER 0x0000000000000020 +#define SYSTEM_SCHEDULER_KW_AFFINITY 0x0000000000000040 +#define SYSTEM_SCHEDULER_KW_PRIORITY 0x0000000000000080 +#define SYSTEM_SCHEDULER_KW_IDEAL_PROCESSOR 0x0000000000000100 +#define SYSTEM_SCHEDULER_KW_CONTEXT_SWITCH 0x0000000000000200 +#define SYSTEM_SCHEDULER_KW_COMPACT_CSWITCH 0x0000000000000400 +#define SYSTEM_SCHEDULER_KW_SCHEDULE_THREAD 0x0000000000000800 +#define SYSTEM_SCHEDULER_KW_READY_QUEUE 0x0000000000001000 +#define SYSTEM_SCHEDULER_KW_CPU_PARTITION 0x0000000000002000 +#define SYSTEM_SCHEDULER_KW_THREAD_FEEDBACK_READ 0x0000000000004000 +#define SYSTEM_SCHEDULER_KW_WORKLOAD_CLASS_UPDATE 0x0000000000008000 +#define SYSTEM_SCHEDULER_KW_AUTOBOOST 0x0000000000010000 + +// +// Keywords to be used for the System Syscall Provider. +// + +#define SYSTEM_SYSCALL_KW_GENERAL 0x0000000000000001 + +// +// Keywords to be used for the System Timer Provider. +// + +#define SYSTEM_TIMER_KW_GENERAL 0x0000000000000001 +#define SYSTEM_TIMER_KW_CLOCK_TIMER 0x0000000000000002 + +// +// Schematized Filter ID for the Pool Tag Filter on the System Memory Provider. +// + +#define SYSTEM_MEMORY_POOL_FILTER_ID 1 + +typedef enum { + EtwCompressionModeRestart = 0, + EtwCompressionModeNoDisable = 1, + EtwCompressionModeNoRestart = 2 +} ETW_COMPRESSION_RESUMPTION_MODE; + +#ifndef _typedef_TRACELOGGER_HANDLE +#define _typedef_TRACELOGGER_HANDLE 1 +// Used by RegisterTraceGuids-based ("Classic") ETW providers. The handle is +// invalid if it contains the value (TRACELOGGER_HANDLE)INVALID_HANDLE_VALUE. +// Obtain the handle by calling GetTraceLoggerHandle during the provider +// notification callback. The handle is valid until the subsequent notification +// callback and does not need to be closed by the user. +typedef ULONG64 TRACELOGGER_HANDLE; +#endif // _typedef_TRACELOGGER_HANDLE + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ + +// +// Trace header for all legacy events. +// + +typedef struct _EVENT_TRACE_HEADER { // overlays WNODE_HEADER + USHORT Size; // Size of entire record + union { + USHORT FieldTypeFlags; // Indicates valid fields + struct { + UCHAR HeaderType; // Header type - internal use only + UCHAR MarkerFlags; // Marker - internal use only + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; + union { + ULONG Version; + struct { + UCHAR Type; // event type + UCHAR Level; // trace instrumentation level + USHORT Version; // version of trace record + } Class; + } DUMMYUNIONNAME2; + ULONG ThreadId; // Thread Id + ULONG ProcessId; // Process Id + LARGE_INTEGER TimeStamp; // time when event happens + union { + GUID Guid; // Guid that identifies event + ULONGLONG GuidPtr; // use with WNODE_FLAG_USE_GUID_PTR + } DUMMYUNIONNAME3; + union { + struct { + ULONG KernelTime; // Kernel Mode CPU ticks + ULONG UserTime; // User mode CPU ticks + } DUMMYSTRUCTNAME; + ULONG64 ProcessorTime; // Processor Clock + struct { + ULONG ClientContext; // Reserved + ULONG Flags; // Event Flags + } DUMMYSTRUCTNAME2; + } DUMMYUNIONNAME4; +} EVENT_TRACE_HEADER, *PEVENT_TRACE_HEADER; + +// +// This header is used to trace and track transaction co-relations +// +typedef struct _EVENT_INSTANCE_HEADER { + USHORT Size; + union { + USHORT FieldTypeFlags; // Indicates valid fields + struct { + UCHAR HeaderType; // Header type - internal use only + UCHAR MarkerFlags; // Marker - internal use only + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; + union { + ULONG Version; + struct { + UCHAR Type; + UCHAR Level; + USHORT Version; + } Class; + } DUMMYUNIONNAME2; + ULONG ThreadId; + ULONG ProcessId; + LARGE_INTEGER TimeStamp; + ULONGLONG RegHandle; + ULONG InstanceId; + ULONG ParentInstanceId; + union { + struct { + ULONG KernelTime; // Kernel Mode CPU ticks + ULONG UserTime; // User mode CPU ticks + } DUMMYSTRUCTNAME; + ULONG64 ProcessorTime; // Processor Clock + struct { + ULONG EventId; // Event ID + ULONG Flags; // Trace header Flags + } DUMMYSTRUCTNAME2; + } DUMMYUNIONNAME3; + ULONGLONG ParentRegHandle; +} EVENT_INSTANCE_HEADER, *PEVENT_INSTANCE_HEADER; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +// +// Following are structures and macros for use with USE_MOF_PTR +// + +// Trace data types +#define ETW_NULL_TYPE_VALUE 0 +#define ETW_OBJECT_TYPE_VALUE 1 +#define ETW_STRING_TYPE_VALUE 2 +#define ETW_SBYTE_TYPE_VALUE 3 +#define ETW_BYTE_TYPE_VALUE 4 +#define ETW_INT16_TYPE_VALUE 5 +#define ETW_UINT16_TYPE_VALUE 6 +#define ETW_INT32_TYPE_VALUE 7 +#define ETW_UINT32_TYPE_VALUE 8 +#define ETW_INT64_TYPE_VALUE 9 +#define ETW_UINT64_TYPE_VALUE 10 +#define ETW_CHAR_TYPE_VALUE 11 +#define ETW_SINGLE_TYPE_VALUE 12 +#define ETW_DOUBLE_TYPE_VALUE 13 +#define ETW_BOOLEAN_TYPE_VALUE 14 +#define ETW_DECIMAL_TYPE_VALUE 15 +// Extended types +#define ETW_GUID_TYPE_VALUE 101 +#define ETW_ASCIICHAR_TYPE_VALUE 102 +#define ETW_ASCIISTRING_TYPE_VALUE 103 +#define ETW_COUNTED_STRING_TYPE_VALUE 104 +#define ETW_POINTER_TYPE_VALUE 105 +#define ETW_SIZET_TYPE_VALUE 106 +#define ETW_HIDDEN_TYPE_VALUE 107 +#define ETW_BOOL_TYPE_VALUE 108 +#define ETW_COUNTED_ANSISTRING_TYPE_VALUE 109 +#define ETW_REVERSED_COUNTED_STRING_TYPE_VALUE 110 +#define ETW_REVERSED_COUNTED_ANSISTRING_TYPE_VALUE 111 +#define ETW_NON_NULL_TERMINATED_STRING_TYPE_VALUE 112 +#define ETW_REDUCED_ANSISTRING_TYPE_VALUE 113 +#define ETW_REDUCED_STRING_TYPE_VALUE 114 +#define ETW_SID_TYPE_VALUE 115 +#define ETW_VARIANT_TYPE_VALUE 116 +#define ETW_PTVECTOR_TYPE_VALUE 117 +#define ETW_WMITIME_TYPE_VALUE 118 +#define ETW_DATETIME_TYPE_VALUE 119 +#define ETW_REFRENCE_TYPE_VALUE 120 + + +#define DEFINE_TRACE_MOF_FIELD(MOF, ptr, length, type) \ + (MOF)->DataPtr = (ULONG64)(ULONG_PTR) ptr; \ + (MOF)->Length = (ULONG) length; \ + (MOF)->DataType = (ULONG) type; + +typedef struct _MOF_FIELD { + ULONG64 DataPtr; // Pointer to the field. Up to 64-bits only + ULONG Length; // Length of the MOF field + ULONG DataType; // Type of data +} MOF_FIELD, *PMOF_FIELD; + +#if !defined(_EVNTRACE_KERNEL_MODE) || defined(_WMIKM_) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ + +// +// This is the header for every logfile. The memory for LoggerName +// and LogFileName must be contiguous adjacent to this structure +// Allows both user-mode and kernel-mode to understand the header. +// +// TRACE_LOGFILE_HEADER32 and TRACE_LOGFILE_HEADER64 structures +// are also provided to simplify cross platform decoding of the +// header event. +// + +typedef struct _TRACE_LOGFILE_HEADER { + ULONG BufferSize; // Logger buffer size in Kbytes + union { + ULONG Version; // Logger version + struct { + UCHAR MajorVersion; + UCHAR MinorVersion; + UCHAR SubVersion; + UCHAR SubMinorVersion; + } VersionDetail; + } DUMMYUNIONNAME; + ULONG ProviderVersion; // defaults to NT version + ULONG NumberOfProcessors; // Number of Processors + LARGE_INTEGER EndTime; // Time when logger stops + ULONG TimerResolution; // assumes timer is constant!!! + ULONG MaximumFileSize; // Maximum in Mbytes + ULONG LogFileMode; // specify logfile mode + ULONG BuffersWritten; // used to file start of Circular File + union { + GUID LogInstanceGuid; // For RealTime Buffer Delivery + struct { + ULONG StartBuffers; // Count of buffers written at start. + ULONG PointerSize; // Size of pointer type in bits + ULONG EventsLost; // Events lost during log session + ULONG CpuSpeedInMHz; // Cpu Speed in MHz + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME2; +#if defined(_WMIKM_) + PWCHAR LoggerName; + PWCHAR LogFileName; + RTL_TIME_ZONE_INFORMATION TimeZone; +#else + LPWSTR LoggerName; + LPWSTR LogFileName; + TIME_ZONE_INFORMATION TimeZone; +#endif + LARGE_INTEGER BootTime; + LARGE_INTEGER PerfFreq; // Reserved + LARGE_INTEGER StartTime; // Reserved + ULONG ReservedFlags; // ClockType + ULONG BuffersLost; +} TRACE_LOGFILE_HEADER, *PTRACE_LOGFILE_HEADER; + +typedef struct _TRACE_LOGFILE_HEADER32 { + ULONG BufferSize; // Logger buffer size in Kbytes + union { + ULONG Version; // Logger version + struct { + UCHAR MajorVersion; + UCHAR MinorVersion; + UCHAR SubVersion; + UCHAR SubMinorVersion; + } VersionDetail; + }; + ULONG ProviderVersion; // defaults to NT version + ULONG NumberOfProcessors; // Number of Processors + LARGE_INTEGER EndTime; // Time when logger stops + ULONG TimerResolution; // assumes timer is constant!!! + ULONG MaximumFileSize; // Maximum in Mbytes + ULONG LogFileMode; // specify logfile mode + ULONG BuffersWritten; // used to file start of Circular File + union { + GUID LogInstanceGuid; // For RealTime Buffer Delivery + struct { + ULONG StartBuffers; // Count of buffers written at start. + ULONG PointerSize; // Size of pointer type in bits + ULONG EventsLost; // Events lost during log session + ULONG CpuSpeedInMHz; // Cpu Speed in MHz + }; + }; +#if defined(_WMIKM_) + ULONG32 LoggerName; + ULONG32 LogFileName; + RTL_TIME_ZONE_INFORMATION TimeZone; +#else + ULONG32 LoggerName; + ULONG32 LogFileName; + TIME_ZONE_INFORMATION TimeZone; +#endif + LARGE_INTEGER BootTime; + LARGE_INTEGER PerfFreq; // Reserved + LARGE_INTEGER StartTime; // Reserved + ULONG ReservedFlags; // ClockType + ULONG BuffersLost; +} TRACE_LOGFILE_HEADER32, *PTRACE_LOGFILE_HEADER32; + +typedef struct _TRACE_LOGFILE_HEADER64 { + ULONG BufferSize; // Logger buffer size in Kbytes + union { + ULONG Version; // Logger version + struct { + UCHAR MajorVersion; + UCHAR MinorVersion; + UCHAR SubVersion; + UCHAR SubMinorVersion; + } VersionDetail; + }; + ULONG ProviderVersion; // defaults to NT version + ULONG NumberOfProcessors; // Number of Processors + LARGE_INTEGER EndTime; // Time when logger stops + ULONG TimerResolution; // assumes timer is constant!!! + ULONG MaximumFileSize; // Maximum in Mbytes + ULONG LogFileMode; // specify logfile mode + ULONG BuffersWritten; // used to file start of Circular File + union { + GUID LogInstanceGuid; // For RealTime Buffer Delivery + struct { + ULONG StartBuffers; // Count of buffers written at start. + ULONG PointerSize; // Size of pointer type in bits + ULONG EventsLost; // Events lost during log session + ULONG CpuSpeedInMHz; // Cpu Speed in MHz + }; + }; +#if defined(_WMIKM_) + ULONG64 LoggerName; + ULONG64 LogFileName; + RTL_TIME_ZONE_INFORMATION TimeZone; +#else + ULONG64 LoggerName; + ULONG64 LogFileName; + TIME_ZONE_INFORMATION TimeZone; +#endif + LARGE_INTEGER BootTime; + LARGE_INTEGER PerfFreq; // Reserved + LARGE_INTEGER StartTime; // Reserved + ULONG ReservedFlags; // ClockType + ULONG BuffersLost; +} TRACE_LOGFILE_HEADER64, *PTRACE_LOGFILE_HEADER64; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // !_EVNTRACE_KERNEL_MODE || _WMIKM_ + +// +// Instance Information to track parent child relationship of Instances. +// + +typedef struct EVENT_INSTANCE_INFO { + HANDLE RegHandle; + ULONG InstanceId; +} EVENT_INSTANCE_INFO, *PEVENT_INSTANCE_INFO; + +#if !defined(_EVNTRACE_KERNEL_MODE) + +// +// Structures that have UNICODE and ANSI versions are defined here +// + +// +// Logger configuration and running statistics. This structure is used +// by user-mode callers, such as PDH library +// + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif + +typedef struct _EVENT_FILTER_DESCRIPTOR + EVENT_FILTER_DESCRIPTOR, *PEVENT_FILTER_DESCRIPTOR; + +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning (disable:4214) /* nonstandard extension used : bit field other than int */ + +typedef struct _EVENT_TRACE_PROPERTIES { + WNODE_HEADER Wnode; +// +// data provided by caller + ULONG BufferSize; // buffer size for logging (kbytes) + ULONG MinimumBuffers; // minimum to preallocate + ULONG MaximumBuffers; // maximum buffers allowed + ULONG MaximumFileSize; // maximum logfile size (in MBytes) + ULONG LogFileMode; // sequential, circular + ULONG FlushTimer; // buffer flush timer, in seconds + ULONG EnableFlags; // trace enable flags + union { + LONG AgeLimit; // unused + LONG FlushThreshold; // Number of buffers to fill before flushing + } DUMMYUNIONNAME; + +// data returned to caller + ULONG NumberOfBuffers; // no of buffers in use + ULONG FreeBuffers; // no of buffers free + ULONG EventsLost; // event records lost + ULONG BuffersWritten; // no of buffers written to file + ULONG LogBuffersLost; // no of logfile write failures + ULONG RealTimeBuffersLost; // no of rt delivery failures + HANDLE LoggerThreadId; // thread id of Logger + ULONG LogFileNameOffset; // Offset to LogFileName + ULONG LoggerNameOffset; // Offset to LoggerName +} EVENT_TRACE_PROPERTIES, *PEVENT_TRACE_PROPERTIES; + +typedef struct _EVENT_TRACE_PROPERTIES_V2 { + WNODE_HEADER Wnode; // Always have WNODE_FLAG_VERSIONED_PROPERTIES. + // + // data provided by caller + ULONG BufferSize; // buffer size for logging (kbytes) + ULONG MinimumBuffers; // minimum to preallocate + ULONG MaximumBuffers; // maximum buffers allowed + ULONG MaximumFileSize; // maximum logfile size (in MBytes) + ULONG LogFileMode; // sequential, circular + ULONG FlushTimer; // buffer flush timer, in seconds + ULONG EnableFlags; // trace enable flags + union { + LONG AgeLimit; // unused + LONG FlushThreshold; // Number of buffers to fill before flushing + } DUMMYUNIONNAME; + + // data returned to caller + ULONG NumberOfBuffers; // no of buffers in use + ULONG FreeBuffers; // no of buffers free + ULONG EventsLost; // event records lost + ULONG BuffersWritten; // no of buffers written to file + ULONG LogBuffersLost; // no of logfile write failures + ULONG RealTimeBuffersLost; // no of rt delivery failures + HANDLE LoggerThreadId; // thread id of Logger + ULONG LogFileNameOffset; // Offset to LogFileName + ULONG LoggerNameOffset; // Offset to LoggerName + + // V2 data + union { + struct { + ULONG VersionNumber : 8; // Should be set to 2 for this version. + } DUMMYSTRUCTNAME; + ULONG V2Control; + } DUMMYUNIONNAME2; + ULONG FilterDescCount; // Number of filters + PEVENT_FILTER_DESCRIPTOR FilterDesc; // Only applicable for Private Loggers + union { + struct { + ULONG Wow : 1; // Logger was started by a WOW64 process (output only). + ULONG QpcDeltaTracking : 1; // QPC delta tracking events are enabled. + ULONG LargeMdlPages : 1; // Buffers allocated via large MDL pages. + ULONG ExcludeKernelStack : 1; // Exclude kernel stack from stack walk. + } DUMMYSTRUCTNAME; + ULONG64 V2Options; + } DUMMYUNIONNAME3; +} EVENT_TRACE_PROPERTIES_V2, *PEVENT_TRACE_PROPERTIES_V2; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +// +// Data Provider structures +// +// Used by RegisterTraceGuids() +// +typedef struct _TRACE_GUID_REGISTRATION { + LPCGUID Guid; // Guid of data block being registered or updated. + HANDLE RegHandle; // Guid Registration Handle is returned. +} TRACE_GUID_REGISTRATION, *PTRACE_GUID_REGISTRATION; + +// +// Data consumer structures +// + +#endif // !_EVNTRACE_KERNEL_MODE + +typedef struct _TRACE_GUID_PROPERTIES { + GUID Guid; + ULONG GuidType; + ULONG LoggerId; + ULONG EnableLevel; + ULONG EnableFlags; + BOOLEAN IsEnable; +} TRACE_GUID_PROPERTIES, *PTRACE_GUID_PROPERTIES; + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ +#ifndef ETW_BUFFER_CONTEXT_DEF +#define ETW_BUFFER_CONTEXT_DEF +typedef struct _ETW_BUFFER_CONTEXT { + union { + struct { + UCHAR ProcessorNumber; + UCHAR Alignment; + } DUMMYSTRUCTNAME; + USHORT ProcessorIndex; + } DUMMYUNIONNAME; + USHORT LoggerId; +} ETW_BUFFER_CONTEXT, *PETW_BUFFER_CONTEXT; +#endif +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +// +// Provider Information Flags used on Vista and above. +// +#define TRACE_PROVIDER_FLAG_LEGACY (0x00000001) +#define TRACE_PROVIDER_FLAG_PRE_ENABLE (0x00000002) + +// +// Enable Information for Provider Instance +// Used on Vista and above +// +typedef struct _TRACE_ENABLE_INFO { + + ULONG IsEnabled; + UCHAR Level; + UCHAR Reserved1; + USHORT LoggerId; + ULONG EnableProperty; + ULONG Reserved2; + ULONGLONG MatchAnyKeyword; + ULONGLONG MatchAllKeyword; + +} TRACE_ENABLE_INFO, *PTRACE_ENABLE_INFO; + +// +// Instance Information for Provider +// Used on Vista and above +// +typedef struct _TRACE_PROVIDER_INSTANCE_INFO { + + ULONG NextOffset; + ULONG EnableCount; + ULONG Pid; + ULONG Flags; + +} TRACE_PROVIDER_INSTANCE_INFO, *PTRACE_PROVIDER_INSTANCE_INFO; + +// +// GUID Information Used on Vista and above +// +typedef struct _TRACE_GUID_INFO { + ULONG InstanceCount; + ULONG Reserved; +} TRACE_GUID_INFO, *PTRACE_GUID_INFO; + +typedef struct _PROFILE_SOURCE_INFO { + ULONG NextEntryOffset; + ULONG Source; + ULONG MinInterval; + ULONG MaxInterval; + ULONG64 Reserved; + WCHAR Description[ANYSIZE_ARRAY]; +} PROFILE_SOURCE_INFO, *PPROFILE_SOURCE_INFO; + +typedef enum _ETW_PMC_COUNTER_OWNER_TYPE { + EtwPmcOwnerFree, + EtwPmcOwnerUntagged, + EtwPmcOwnerTagged, + EtwPmcOwnerTaggedWithSource +} ETW_PMC_COUNTER_OWNER_TYPE; + +typedef struct _ETW_PMC_COUNTER_OWNER { + ETW_PMC_COUNTER_OWNER_TYPE OwnerType; + ULONG ProfileSource; + ULONG OwnerTag; +} ETW_PMC_COUNTER_OWNER, *PETW_PMC_COUNTER_OWNER; + +typedef struct _ETW_PMC_COUNTER_OWNERSHIP_STATUS { + ULONG ProcessorNumber; + ULONG NumberOfCounters; + ETW_PMC_COUNTER_OWNER CounterOwners[ANYSIZE_ARRAY]; +} ETW_PMC_COUNTER_OWNERSHIP_STATUS, *PETW_PMC_COUNTER_OWNERSHIP_STATUS; + +typedef struct { + ULONG NextEntryOffset; + USHORT LoggerId; + USHORT Reserved; + ULONG ProfileSourceCount; + ULONG HookIdCount; + + // These two fields follow as a ULONG blob after the initial header. + // ULONG ProfileSources[]; // Count indicated by ProfileSourceCount + // USHORT HookIds[]; // Count indicated by HookIdCount +} ETW_PMC_SESSION_INFO; + +typedef enum ETW_CONTEXT_REGISTER_TYPES { + EtwContextRegisterTypeNone = 0, + EtwContextRegisterTypeControl = 0x1, + EtwContextRegisterTypeInteger = 0x2 +} ETW_CONTEXT_REGISTER_TYPES; +DEFINE_ENUM_FLAG_OPERATORS(ETW_CONTEXT_REGISTER_TYPES) + +#define TRACE_LBR_EVENT_OPCODE 0x20 +#define TRACE_LBR_MAXIMUM_EVENTS 4 + +typedef enum TRACE_LBR_CONFIGURATION { + TRACE_LBR_CONFIGURATION_NONE = 0x0, // do not exclude any branches + TRACE_LBR_CONFIGURATION_EXCLUDE_KERNEL = 0x1, // exclude branches in kernel privilege + TRACE_LBR_CONFIGURATION_EXCLUDE_USER = 0x2, // exclude branches in user privilege + TRACE_LBR_CONFIGURATION_EXCLUDE_JCC = 0x4, // exclude conditional branches + TRACE_LBR_CONFIGURATION_EXCLUDE_NEAR_REL_CALL = 0x8, // exclude near relative calls + TRACE_LBR_CONFIGURATION_EXCLUDE_NEAR_IND_CALL = 0x10, // exclude near indirect calls + TRACE_LBR_CONFIGURATION_EXCLUDE_NEAR_RET = 0x20, // exclude near returns + TRACE_LBR_CONFIGURATION_EXCLUDE_NEAR_IND_JMP = 0x40, // exclude near indirect jumps + TRACE_LBR_CONFIGURATION_EXCLUDE_NEAR_REL_JMP = 0x80, // exclude near relative jumps + TRACE_LBR_CONFIGURATION_EXCLUDE_FAR_BRANCH = 0x100, // exclude far ("other") branches + TRACE_LBR_CONFIGURATION_CALLSTACK_ENABLE = 0x200, // record branches in callstack (LIFO) mode + TRACE_LBR_CONFIGURATION_SAMPLED = 0x400, // record sample-based LBR (ARM64 only) +} TRACE_LBR_CONFIGURATION; +DEFINE_ENUM_FLAG_OPERATORS(TRACE_LBR_CONFIGURATION) + +// +// An EVENT_TRACE consists of a fixed header (EVENT_TRACE_HEADER) and +// optionally a variable portion pointed to by MofData. The datablock +// layout of the variable portion is unknown to the Logger and must +// be obtained from WBEM CIMOM database. +// + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ +typedef struct _EVENT_TRACE { + EVENT_TRACE_HEADER Header; // Event trace header + ULONG InstanceId; // Instance Id of this event + ULONG ParentInstanceId; // Parent Instance Id. + GUID ParentGuid; // Parent Guid; + PVOID MofData; // Pointer to Variable Data + ULONG MofLength; // Variable Datablock Length + union { + ULONG ClientContext; + ETW_BUFFER_CONTEXT BufferContext; + } DUMMYUNIONNAME; +} EVENT_TRACE, *PEVENT_TRACE; +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#define EVENT_CONTROL_CODE_DISABLE_PROVIDER 0 +#define EVENT_CONTROL_CODE_ENABLE_PROVIDER 1 +#define EVENT_CONTROL_CODE_CAPTURE_STATE 2 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#if !defined(_EVNTRACE_KERNEL_MODE) + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +typedef struct _EVENT_RECORD + EVENT_RECORD, *PEVENT_RECORD; + +typedef struct _EVENT_TRACE_LOGFILEW + EVENT_TRACE_LOGFILEW, *PEVENT_TRACE_LOGFILEW; + +typedef struct _EVENT_TRACE_LOGFILEA + EVENT_TRACE_LOGFILEA, *PEVENT_TRACE_LOGFILEA; + +typedef ULONG (WINAPI * PEVENT_TRACE_BUFFER_CALLBACKW) + (PEVENT_TRACE_LOGFILEW Logfile); + +typedef ULONG (WINAPI * PEVENT_TRACE_BUFFER_CALLBACKA) + (PEVENT_TRACE_LOGFILEA Logfile); + +typedef VOID (WINAPI *PEVENT_CALLBACK)( PEVENT_TRACE pEvent ); + +typedef VOID (WINAPI *PEVENT_RECORD_CALLBACK) (PEVENT_RECORD EventRecord); + +typedef struct ETW_BUFFER_HEADER { + ULONG Reserved1[4]; + LARGE_INTEGER TimeStamp; // Time of flush + ULONG Reserved2[4]; + ETW_BUFFER_CONTEXT ClientContext; + ULONG Reserved3; + ULONG FilledBytes; // Number of bytes written to the buffer. Essentially the filled length of the buffer. + ULONG Reserved4[5]; +} ETW_BUFFER_HEADER; + +// Structure passed to the BufferCallback containing information on the +// current state of the processing session. +typedef struct ETW_BUFFER_CALLBACK_INFORMATION { + PROCESSTRACE_HANDLE TraceHandle; + const TRACE_LOGFILE_HEADER* LogfileHeader; + ULONG BuffersRead; +} ETW_BUFFER_CALLBACK_INFORMATION; + +typedef BOOL (WINAPI *PETW_BUFFER_CALLBACK) ( + _In_reads_bytes_(BufferSize) const ETW_BUFFER_HEADER* Buffer, + _In_ ULONG BufferSize, + _In_ const ETW_BUFFER_CALLBACK_INFORMATION* ConsumerInfo, + _In_opt_ void* CallbackContext); + +typedef enum ETW_PROCESS_TRACE_MODES { + ETW_PROCESS_TRACE_MODE_NONE = 0, + ETW_PROCESS_TRACE_MODE_RAW_TIMESTAMP = 0x00000001 +} ETW_PROCESS_TRACE_MODES; + +// Configuration options to pass into OpenTrace style functions. +typedef struct ETW_OPEN_TRACE_OPTIONS { + ETW_PROCESS_TRACE_MODES ProcessTraceModes; + + // This callback will be called for each event in time order. + // If left NULL, all event playback code will be bypassed. + PEVENT_RECORD_CALLBACK EventCallback; + void* EventCallbackContext; + + // This callback will get called once buffer processing is complete. + PETW_BUFFER_CALLBACK BufferCallback; + void* BufferCallbackContext; +} ETW_OPEN_TRACE_OPTIONS; + +typedef VOID (WINAPI *PETW_BUFFER_COMPLETION_CALLBACK) ( + _In_ const ETW_BUFFER_HEADER* Buffer, + _In_opt_ void* CallbackContext); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Prototype for service request callback. Data providers register with WMI +// by passing a service request callback function that is called for all +// wmi requests. + +typedef ULONG ( +#ifndef MIDL_PASS +WINAPI +#endif +*WMIDPREQUEST)( + _In_ WMIDPREQUESTCODE RequestCode, + _In_ PVOID RequestContext, + _Inout_ ULONG *BufferSize, + _Inout_ PVOID Buffer + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning (disable:4201) /* nonstandard extension used : nameless struct/union */ + +struct _EVENT_TRACE_LOGFILEW { + LPWSTR LogFileName; // Logfile Name + LPWSTR LoggerName; // LoggerName + LONGLONG CurrentTime; // timestamp of last event + ULONG BuffersRead; // buffers read to date + union { + // Mode of the logfile + ULONG LogFileMode; + // Processing flags used on Vista and above + ULONG ProcessTraceMode; + } DUMMYUNIONNAME; + EVENT_TRACE CurrentEvent; // Current Event from this stream. + TRACE_LOGFILE_HEADER LogfileHeader; // logfile header structure + PEVENT_TRACE_BUFFER_CALLBACKW // callback before each buffer + BufferCallback; // is read + // + // following variables are filled for BufferCallback. + // + ULONG BufferSize; + ULONG Filled; + ULONG EventsLost; + // + // following needs to be propagated to each buffer + // + union { + // Callback with EVENT_TRACE + PEVENT_CALLBACK EventCallback; + // Callback with EVENT_RECORD on Vista and above + PEVENT_RECORD_CALLBACK EventRecordCallback; + } DUMMYUNIONNAME2; + + ULONG IsKernelTrace; // TRUE for kernel logfile + + PVOID Context; // reserved for internal use +}; + +struct _EVENT_TRACE_LOGFILEA { + LPSTR LogFileName; // Logfile Name + LPSTR LoggerName; // LoggerName + LONGLONG CurrentTime; // timestamp of last event + ULONG BuffersRead; // buffers read to date + union { + ULONG LogFileMode; // Mode of the logfile + ULONG ProcessTraceMode; // Processing flags + } DUMMYUNIONNAME; + EVENT_TRACE CurrentEvent; // Current Event from this stream + TRACE_LOGFILE_HEADER LogfileHeader; // logfile header structure + PEVENT_TRACE_BUFFER_CALLBACKA // callback before each buffer + BufferCallback; // is read + + // + // following variables are filled for BufferCallback. + // + ULONG BufferSize; + ULONG Filled; + ULONG EventsLost; + // + // following needs to be propagated to each buffer + // + union { + PEVENT_CALLBACK EventCallback; // callback for every event + PEVENT_RECORD_CALLBACK EventRecordCallback; + } DUMMYUNIONNAME2; + + + ULONG IsKernelTrace; // TRUE for kernel logfile + + PVOID Context; // reserved for internal use +}; +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +// +// Define generic structures +// + +#if defined(_UNICODE) || defined(UNICODE) + +#define PEVENT_TRACE_BUFFER_CALLBACK PEVENT_TRACE_BUFFER_CALLBACKW +#define EVENT_TRACE_LOGFILE EVENT_TRACE_LOGFILEW +#define PEVENT_TRACE_LOGFILE PEVENT_TRACE_LOGFILEW +#define KERNEL_LOGGER_NAME KERNEL_LOGGER_NAMEW +#define GLOBAL_LOGGER_NAME GLOBAL_LOGGER_NAMEW +#define EVENT_LOGGER_NAME EVENT_LOGGER_NAMEW + +#else + +#define PEVENT_TRACE_BUFFER_CALLBACK PEVENT_TRACE_BUFFER_CALLBACKA +#define EVENT_TRACE_LOGFILE EVENT_TRACE_LOGFILEA +#define PEVENT_TRACE_LOGFILE PEVENT_TRACE_LOGFILEA +#define KERNEL_LOGGER_NAME KERNEL_LOGGER_NAMEA +#define GLOBAL_LOGGER_NAME GLOBAL_LOGGER_NAMEA +#define EVENT_LOGGER_NAME EVENT_LOGGER_NAMEA + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef _APISET_EVENTING + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Logger control APIs +// + +// +// Use the routine below to start an event trace session +// + +EXTERN_C +ULONG +WMIAPI +StartTraceW ( + _Out_ CONTROLTRACE_ID* TraceId, + _In_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +StartTraceA ( + _Out_ CONTROLTRACE_ID* TraceId, + _In_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Use the routine below to stop an event trace session +// + +EXTERN_C +ULONG +WMIAPI +StopTraceW ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +StopTraceA ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Use the routine below to query the properties of an event trace session +// + +EXTERN_C +ULONG +WMIAPI +QueryTraceW ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +QueryTraceA ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +// +// Use the routine below to update certain properties of an event trace session +// + +EXTERN_C +ULONG +WMIAPI +UpdateTraceW ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +EXTERN_C +ULONG +WMIAPI +UpdateTraceA ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); + +// +// Use the routine below to request that all active buffers an event trace +// session be "flushed", or written out. +// + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_WINXP) +EXTERN_C +ULONG +WMIAPI +FlushTraceW ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_WINXP) +EXTERN_C +ULONG +WMIAPI +FlushTraceA ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Generic trace control routine +// +EXTERN_C +ULONG +WMIAPI +ControlTraceW ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCWSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties, + _In_ ULONG ControlCode + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +ControlTraceA ( + _In_ CONTROLTRACE_ID TraceId, + _In_opt_ LPCSTR InstanceName, + _Inout_ PEVENT_TRACE_PROPERTIES Properties, + _In_ ULONG ControlCode + ); + +EXTERN_C +ULONG +WMIAPI +QueryAllTracesW ( + _Out_writes_(PropertyArrayCount) PEVENT_TRACE_PROPERTIES *PropertyArray, + _In_ ULONG PropertyArrayCount, + _Out_ PULONG LoggerCount + ); + +EXTERN_C +ULONG +WMIAPI +QueryAllTracesA ( + _Out_writes_(PropertyArrayCount) PEVENT_TRACE_PROPERTIES *PropertyArray, + _In_ ULONG PropertyArrayCount, + _Out_ PULONG LoggerCount + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Data Provider Enable APIs +// + +EXTERN_C +ULONG +WMIAPI +EnableTrace ( + _In_ ULONG Enable, + _In_ ULONG EnableFlag, + _In_ ULONG EnableLevel, + _In_ LPCGUID ControlGuid, + _In_ CONTROLTRACE_ID TraceId + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +#ifndef _APISET_EVENTING + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_VISTA) +EXTERN_C +ULONG +WMIAPI +EnableTraceEx ( + _In_ LPCGUID ProviderId, + _In_opt_ LPCGUID SourceId, + _In_ CONTROLTRACE_ID TraceId, + _In_ ULONG IsEnabled, + _In_ UCHAR Level, + _In_ ULONGLONG MatchAnyKeyword, + _In_ ULONGLONG MatchAllKeyword, + _In_ ULONG EnableProperty, + _In_opt_ PEVENT_FILTER_DESCRIPTOR EnableFilterDesc + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +#define ENABLE_TRACE_PARAMETERS_VERSION 1 +#define ENABLE_TRACE_PARAMETERS_VERSION_2 2 + +typedef struct _ENABLE_TRACE_PARAMETERS_V1 { + ULONG Version; + ULONG EnableProperty; + ULONG ControlFlags; + GUID SourceId; + PEVENT_FILTER_DESCRIPTOR EnableFilterDesc; +} ENABLE_TRACE_PARAMETERS_V1, *PENABLE_TRACE_PARAMETERS_V1; + +typedef struct _ENABLE_TRACE_PARAMETERS { + ULONG Version; + ULONG EnableProperty; + ULONG ControlFlags; + GUID SourceId; + PEVENT_FILTER_DESCRIPTOR EnableFilterDesc; + ULONG FilterDescCount; +} ENABLE_TRACE_PARAMETERS, *PENABLE_TRACE_PARAMETERS; + +#ifndef _APISET_EVENTING + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_WIN7) +EXTERN_C +ULONG +WMIAPI +EnableTraceEx2 ( + _In_ CONTROLTRACE_ID TraceId, + _In_ LPCGUID ProviderId, + _In_ ULONG ControlCode, + _In_ UCHAR Level, + _In_ ULONGLONG MatchAnyKeyword, + _In_ ULONGLONG MatchAllKeyword, + _In_ ULONG Timeout, + _In_opt_ PENABLE_TRACE_PARAMETERS EnableParameters + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +// +// TRACE_QUERY_INFO_CLASS/TRACE_INFO_CLASS +// This enumeration contains values that are passed to one or more of the +// ETW query/set APIs: EnumerateTraceGuidsEx, TraceSetInformation, TraceQueryInformation. +// + +typedef enum _TRACE_QUERY_INFO_CLASS { + // + // TraceGuidQueryList: + // - EnumerateTraceGuidsEx. + // Returns a list of provider GUIDs that are currently registered with the kernel. + // Note: This is not the same thing as having an installed manifest. + // + // Input Format: None. + // Output Format: An array of GUIDs. + // + TraceGuidQueryList = 0, + + // + // TraceGuidQueryList: + // - EnumerateTraceGuidsEx. + // Returns the current registration and enablement information for the input GUID. + // + // Input Format: GUID + // Output Format: TRACE_GUID_INFO followed by TRACE_GUID_INFO.InstanceCount + // TRACE_PROVIDER_INSTANCE_INFO structs, each bundled with + // TRACE_PROVIDER_INSTANCE_INFO.EnableCount TRACE_ENABLE_INFO. + // For example, a GUID with two provider registrations, the first enabled + // by two loggers and the second by three loggers would look like: + // { + // TRACE_GUID_INFO; // Where InstanceCount = 2 + // TRACE_PROVIDER_INSTANCE_INFO; // Where EnableCount = 2 + // TRACE_ENABLE_INFO; + // TRACE_ENABLE_INFO; + // TRACE_PROVIDER_INSTANCE_INFO; // Where EnableCount = 3 + // TRACE_ENABLE_INFO; + // TRACE_ENABLE_INFO; + // TRACE_ENABLE_INFO; + // } + // + TraceGuidQueryInfo = 1, + + // + // TraceGuidQueryProcess: + // - EnumerateTraceGuidsEx. + // Returns a list of provider GUIDs that are registered in the current process. + // Note: This is not the same thing as having an installed manifest. + // + // Input Format: None. + // Output Format: An array of GUIDs. + // + TraceGuidQueryProcess = 2, + + // + // TraceStackTracingInfo: + // - TraceSetInformation. + // Turns on stack trace collection for the specified kernel events for the specified logger. + // It also turns off stack tracing for all kernel events not on this list, regardless of prior status. + // + // Input Format: An array of CLASSIC_EVENT_ID structs. + // + TraceStackTracingInfo = 3, + + // + // TraceSystemTraceEnableFlagsInfo: + // - TraceSetInformation + // Sets the Group Mask state for the specified logging session. + // + // Input Format: PERFINFO_GROUPMASK + // + // - TraceQueryInformation + // Queries the current Group Mask state for the specified logging session. + // + // Return Format: PERFINFO_GROUPMASK + // + TraceSystemTraceEnableFlagsInfo = 4, + + // + // TraceSampledProfileIntervalInfo: + // - TraceSetInformation + // Sets the Sample Profile interval for the system. + // Expects 0 for the TraceId parameter. + // + // Input Format: TRACE_PROFILE_INTERVAL + // + // - TraceQueryInformation + // Queries the current Sample Profile Interval for the system. + // Expects 0 for the TraceId parameter. + // + // Output Format: TRACE_PROFILE_INTERVAL + // + TraceSampledProfileIntervalInfo = 5, + + // + // TraceProfileSourceConfigInfo: + // - TraceSetInformation + // Sets a list of sources to be used for PMC Profiling system-wide. + // Expects 0 for the TraceId parameter. + // + // Input Format: An array of ULONGs specifying the IDs of the sources. + // + TraceProfileSourceConfigInfo = 6, + + // + // TraceProfileSourceListInfo: + // - TraceQueryInformation + // Queries the list of PMC Profiling sources available on the system. + // Expects 0 for the TraceId parameter. + // + // Output Format: An array of PROFILE_SOURCE_INFO structs. + // + TraceProfileSourceListInfo = 7, + + // + // TracePmcEventListInfo: + // - TraceSetInformation + // Updates the list of kernel events for which PMC counters will be collected + // for the specified logger. This can only be set once per logger and cannot + // be updated. + // The counters collected are specified by + // TraceSetInformation(TracePmcCounterListInfo, ...) described below. + // + // Input Format: An array of CLASSIC_EVENT_ID structs. + // + TracePmcEventListInfo = 8, + + // + // TracePmcCounterListInfo: + // - TraceSetInformation + // Sets the list of PMC counters to be collected on system events. + // This can only be set once per logger and cannot be updated. + // The specified counters will be collected on the events specified by + // TraceSetInformation(TracePmcEventListInfo, ...) described above. + // + // Input Format: An array of ULONGs. + // + TracePmcCounterListInfo = 9, + + // + // TraceSetDisallowList: + // - TraceSetInformation + // Sets a list of provider GUIDs that should not be enabled via + // Provider Groups on the specified logging session. + // + // Input Format: An array of GUIDs. + // + TraceSetDisallowList = 10, + + // + // TraceVersionInfo: + // - TraceQueryInformation + // Queries the version number of the trace processing code. + // Expects 0 for the TraceId parameter. + // + // Output Format: TRACE_VERSION_INFO + // + TraceVersionInfo = 11, + + // + // TraceGroupQueryList: + // - EnumerateTraceGuidsEx. + // Returns a list of Group GUIDs that are currently known to the kernel. + // + // Input Format: None. + // Output Format: An array of GUIDs. + // + TraceGroupQueryList = 12, + + // + // TraceGroupQueryInfo: + // - EnumerateTraceGuidsEx. + // Returns the current enablement information and list of member providers + // for the input Group GUID. + // + // Input Format: GUID + // Output Format: a) ULONG - Length of the following TRACE_ENABLE_INFO array. + // b) Array of TRACE_ENABLE_INFO. Size of the array is inferred from (a) + // c) ULONG - Count of the Number of Unique Providers that belong to this Group + // d) Array of GUID - Size of the array is specified by (c) + // + // PseudoStructure - + // struct TRACE_GROUP_INFO { + // ULONG TraceEnableInfoSize; + // TRACE_ENABLE_INFO TraceEnableInfos[TraceEnableInfoSize]; + // ULONG GuidArraySize; + // GUID UniqueProviders[GuidArraySize]; + // } + // + TraceGroupQueryInfo = 13, + + // + // TraceDisallowListQuery: + // - TraceQueryInformation + // Queries the list of provider GUIDs that should not be enabled via + // Provider Groups on the specified logging session. + // + // Output Format: An array of GUIDs. + // + TraceDisallowListQuery = 14, + + TraceInfoReserved15 = 15, + + // + // TracePeriodicCaptureStateListInfo: + // - TraceSetInformation + // Sets the list of providers for which capture state should be collected + // at periodic time intervals for the specified logging session. + // If a NULL input buffer is specified, then the current periodic capture state + // settings are cleared. + // + // Input Format: TRACE_PERIODIC_CAPTURE_STATE_INFO followed by an array of ProviderCount + // Provider GUIDs. Or a NULL Buffer. + // + TracePeriodicCaptureStateListInfo = 16, + + // + // TracePeriodicCaptureStatInfo: + // - TraceQueryInformation + // Queries the limits of periodic capture settings on this system, including + // the minimum time frequency and the maximum number of providers that can be + // enabled for periodic capture state. + // Does not use the TraceId parameter. + // + // Output Format: TRACE_PERIODIC_CAPTURE_STATE_INFO + // + TracePeriodicCaptureStateInfo = 17, + + // + // TraceProviderBinaryTracking: + // - TraceSetInformation + // Instructs ETW to begin tracking binaries for all providers that are enabled + // to the session. The tracking applies retroactively for providers that were + // enabled to the session prior to the call, as well as for all future providers + // that are enabled to the session. + // + // ETW fabricates tracking events for these tracked providers that contain a + // mapping between provider GUID(s). ETW also fabricates the file path that describes + // where the registered provider is located on disk. If the session is in realtime, + // the events are provided live in the realtime buffers. If the session is file-based + // (i.e. trace is saved to an .etl file), the events are aggregated and written to the + // file header; they will be among some of the first events the ETW runtime provides + // when the .etl file is played back. + // + // The binary tracking events will come from the EventTraceGuid provider, with an opcode + // of WMI_LOG_TYPE_BINARY_PATH. + // + // Input Format: BOOLEAN (The 1-byte type, rather than the 4-byte BOOL.) + // True to turn tracking on. False to turn tracking off. + // + TraceProviderBinaryTracking = 18, + + // + // TraceMaxLoggersQuery: + // - TraceQueryInformation + // Queries the maximum number of system-wide loggers that can be running at a time + // on this system. + // Does not use the TraceId parameter. + // + // Output Format: ULONG + // + TraceMaxLoggersQuery = 19, + + // + // TraceLbrConfigurationInfo: + // - TraceSetInformation + // Sets a bitfield of configuration options for Last Branch Record tracing. + // + // Input Format: ULONG + // + TraceLbrConfigurationInfo = 20, + + // + // TraceLbrEventListInfo: + // - TraceSetInformation + // Provides a list of kernel events to collect Last Branch Records on. + // The events are specified by their HookIds. + // + // Input Format: An array of ULONGs + // + TraceLbrEventListInfo = 21, + + // + // TraceMaxPmcCounterQuery: + // - TraceQueryInformation + // Queries the maximum number of PMC counters supported on this platform. + // Does not use the TraceId parameter. + // + // Output Format: ULONG + // + TraceMaxPmcCounterQuery = 22, + + // + // TraceStreamCount: + // - TraceQueryInformation + // Queries the number of streams that a given session can be expected + // to emit. This is usually proportional to CPU count, or 1 if no + // per-processor buffering is enabled. + // + // Output Format: ULONG + // + TraceStreamCount = 23, + + // + // TraceStackCachingInfo: + // - TraceSetInformation + // Turns on stack caching for classic event stacks. + // + // Input Format: TRACE_STACK_CACHING_INFO + // + TraceStackCachingInfo = 24, + + // + // TracePmcCounterOwners: + // - TraceQueryInformation + // Queries ownership information for active PMC counters. + // Expects 0 for the TraceId parameter. + // + // Input Format: ETW_PMC_COUNTER_OWNERSHIP_STATUS with ProcessorNumber set to an + // appropriate processor index. The input buffer must be of size at least + // RTL_SIZEOF_THROUGH_FIELD(ETW_PMC_COUNTER_OWNERSHIP_STATUS, NumberOfCounters) + + // (sizeof(ETW_PMC_COUNTER_OWNER) * EtwMaxPmcCounters), where EtwMaxPmcCounters + // is the result of a TraceQueryInformation(TraceMaxPmcCounterQuery, ...) operation. + // + // Output Format: ETW_PMC_COUNTER_OWNERSHIP_STATUS with CounterOwners filled out. NumberOfCounters is + // set to the number of items in the CounterOwners array. + // If a counter owner's OwnershipType is EtwPmcOwnerTagged, then OwnerTag contains + // a tag provided by the counter owner. + // + TracePmcCounterOwners = 25, + + // + // TraceStackCachingInfo: + // - TraceSetInformation + // Turns on unified stack caching for all event stacks. + // + // Input Format: TRACE_STACK_CACHING_INFO + // + TraceUnifiedStackCachingInfo = 26, + + // + // TracePmcSessionInformation: + // TraceQueryInformation + // Queries information about enabled PMC counters for all sessions. + // Expects 0 for the TraceId parameter. + // + // Output Format: The supplied output buffer will be set to a blob of filled out ETW_PMC_SESSION_INFO. + // The NextEntryOffset member of each item will be set to the offset from the start of + // the current item to the next item, or 0 if there are no more items. + // The ProfileSourceCount and HookId count members will be set to the number of items that + // exist in the ProfileSources array and HookIds arrays, respectively. + // + TracePmcSessionInformation = 27, + + // + // TraceContextRegisterInfo: + // - TraceSetInformation. + // Turns on context register tracing for the specified System Trace Provider events for the specified logger. + // It also turns off context register tracing for all kernel events not on this list, regardless of prior status. + // + // Input Format: A TRACE_CONTEXT_REGISTER_INFO structure, followed by an array of up to + // ETW_MAX_CONTEXT_REGISTER_EVENTS number of CLASSIC_EVENT_ID structures. + // + TraceContextRegisterInfo = 28, + + MaxTraceSetInfoClass +} TRACE_QUERY_INFO_CLASS, TRACE_INFO_CLASS; + +#ifndef _APISET_EVENTING + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_VISTA) +EXTERN_C +ULONG +WMIAPI +EnumerateTraceGuidsEx ( + _In_ TRACE_QUERY_INFO_CLASS TraceQueryInfoClass, + _In_reads_bytes_opt_(InBufferSize) PVOID InBuffer, + _In_ ULONG InBufferSize, + _Out_writes_bytes_opt_(OutBufferSize) PVOID OutBuffer, + _In_ ULONG OutBufferSize, + _Out_ PULONG ReturnLength + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +typedef struct _CLASSIC_EVENT_ID { + GUID EventGuid; + UCHAR Type; + UCHAR Reserved[7]; +} CLASSIC_EVENT_ID, *PCLASSIC_EVENT_ID; + +typedef struct _TRACE_STACK_CACHING_INFO { + BOOLEAN Enabled; + ULONG CacheSize; + ULONG BucketCount; +} TRACE_STACK_CACHING_INFO, *PTRACE_STACK_CACHING_INFO; + +typedef struct _TRACE_PROFILE_INTERVAL { + ULONG Source; + ULONG Interval; +} TRACE_PROFILE_INTERVAL, *PTRACE_PROFILE_INTERVAL; + +typedef struct _TRACE_VERSION_INFO { + UINT EtwTraceProcessingVersion; + UINT Reserved; +} TRACE_VERSION_INFO, *PTRACE_VERSION_INFO; + +typedef struct _TRACE_PERIODIC_CAPTURE_STATE_INFO { + ULONG CaptureStateFrequencyInSeconds; + USHORT ProviderCount; + USHORT Reserved; +} TRACE_PERIODIC_CAPTURE_STATE_INFO, *PTRACE_PERIODIC_CAPTURE_STATE_INFO; + +typedef struct TRACE_CONTEXT_REGISTER_INFO { + ETW_CONTEXT_REGISTER_TYPES RegisterTypes; + ULONG Reserved; +} TRACE_CONTEXT_REGISTER_INFO; + +#ifndef _APISET_EVENTING + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (WINVER >= _WIN32_WINNT_WIN7) +EXTERN_C +ULONG +WMIAPI +TraceSetInformation ( + _In_ CONTROLTRACE_ID TraceId, + _In_ TRACE_INFO_CLASS InformationClass, + _In_reads_bytes_(InformationLength) PVOID TraceInformation, + _In_ ULONG InformationLength + ); +#endif + +#if (WINVER >= _WIN32_WINNT_WIN8) +EXTERN_C +ULONG +WMIAPI +TraceQueryInformation ( + _In_ CONTROLTRACE_ID TraceId, + _In_ TRACE_INFO_CLASS InformationClass, + _Out_writes_bytes_(InformationLength) PVOID TraceInformation, + _In_ ULONG InformationLength, + _Out_opt_ PULONG ReturnLength + ); +#endif + +EXTERN_C +_Success_(return == ERROR_SUCCESS) +ULONG +TraceConfigureLastBranchRecord ( + _In_ CONTROLTRACE_ID TraceId, + _In_ TRACE_LBR_CONFIGURATION LbrConfiguration, + _In_reads_(EventCount) CLASSIC_EVENT_ID const* Events, + _In_ ULONG EventCount + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +// +// Data Provider APIs +// + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +EXTERN_C +ULONG +WMIAPI +CreateTraceInstanceId ( + _In_ HANDLE RegHandle, + _Inout_ PEVENT_INSTANCE_INFO InstInfo + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// Used by RegisterTraceGuids-based ("Classic") ETW providers. The handle is +// invalid if it contains the value (TRACEGUID_HANDLE)0. Obtain the handle by +// calling RegisterTraceGuids. Close the handle by calling +// UnregisterTraceGuids. +typedef ULONG64 TRACEGUID_HANDLE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Use the routine below to generate and record an event trace +// + +EXTERN_C +ULONG +WMIAPI +TraceEvent ( + _In_ TRACELOGGER_HANDLE TraceHandle, + _In_ PEVENT_TRACE_HEADER EventTrace + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +EXTERN_C +ULONG +WMIAPI +TraceEventInstance ( + _In_ TRACELOGGER_HANDLE TraceHandle, + _In_ PEVENT_INSTANCE_HEADER EventTrace, + _In_ PEVENT_INSTANCE_INFO InstInfo, + _In_opt_ PEVENT_INSTANCE_INFO ParentInstInfo + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Use the routine below to register a guid for tracing. +// + +EXTERN_C +ULONG +WMIAPI +RegisterTraceGuidsW ( + _In_ WMIDPREQUEST RequestAddress, + _In_opt_ PVOID RequestContext, + _In_ LPCGUID ControlGuid, + _In_ ULONG GuidCount, + _In_reads_opt_(GuidCount) PTRACE_GUID_REGISTRATION TraceGuidReg, + _In_opt_ LPCWSTR MofImagePath, + _In_opt_ LPCWSTR MofResourceName, + _Out_ TRACEGUID_HANDLE* RegistrationHandle + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +RegisterTraceGuidsA ( + _In_ WMIDPREQUEST RequestAddress, + _In_opt_ PVOID RequestContext, + _In_ LPCGUID ControlGuid, + _In_ ULONG GuidCount, + _In_reads_opt_(GuidCount) PTRACE_GUID_REGISTRATION TraceGuidReg, + _In_opt_ LPCSTR MofImagePath, + _In_opt_ LPCSTR MofResourceName, + _Out_ TRACEGUID_HANDLE* RegistrationHandle + ); + +#if (WINVER >= _WIN32_WINNT_WINXP) +EXTERN_C +ULONG +WMIAPI +EnumerateTraceGuids ( + _Inout_updates_(PropertyArrayCount) PTRACE_GUID_PROPERTIES *GuidPropertiesArray, + _In_ ULONG PropertyArrayCount, + _Out_ PULONG GuidCount + ); +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +WMIAPI +UnregisterTraceGuids ( + _In_ TRACEGUID_HANDLE RegistrationHandle + ); + +EXTERN_C +TRACELOGGER_HANDLE +WMIAPI +GetTraceLoggerHandle ( + _In_ PVOID Buffer + ); + +EXTERN_C +UCHAR +WMIAPI +GetTraceEnableLevel ( + _In_ TRACELOGGER_HANDLE TraceHandle + ); + +EXTERN_C +ULONG +WMIAPI +GetTraceEnableFlags ( + _In_ TRACELOGGER_HANDLE TraceHandle + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +// +// Data Consumer APIs and structures start here +// + +#pragma region Application Family or OneCore Family or GameCore family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceW ( + _Inout_ PEVENT_TRACE_LOGFILEW Logfile + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +ULONG +WMIAPI +ProcessTrace ( + _In_reads_(HandleCount) PROCESSTRACE_HANDLE* HandleArray, + _In_ ULONG HandleCount, + _In_opt_ LPFILETIME StartTime, + _In_opt_ LPFILETIME EndTime + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +ULONG +WMIAPI +CloseTrace ( + _In_ PROCESSTRACE_HANDLE TraceHandle + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return != INVALID_PROCESSTRACE_HANDLE) +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceFromBufferStream( + _In_ const ETW_OPEN_TRACE_OPTIONS* Options, + _In_ PETW_BUFFER_COMPLETION_CALLBACK BufferCompletionCallback, + _In_opt_ void* BufferCompletionContext + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return != INVALID_PROCESSTRACE_HANDLE) +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceFromRealTimeLogger( + _In_ PCWSTR LoggerName, + _In_ const ETW_OPEN_TRACE_OPTIONS* Options, + _Out_opt_ TRACE_LOGFILE_HEADER* LogFileHeader + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return != INVALID_PROCESSTRACE_HANDLE) +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceFromRealTimeLoggerWithAllocationOptions( + _In_ PCWSTR LoggerName, + _In_ const ETW_OPEN_TRACE_OPTIONS* Options, + _In_ ULONG_PTR AllocationSize, + _In_opt_ HANDLE MemoryPartitionHandle, + _Out_opt_ TRACE_LOGFILE_HEADER* LogFileHeader + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return != INVALID_PROCESSTRACE_HANDLE) +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceFromFile( + _In_ PCWSTR LogFileName, + _In_ const ETW_OPEN_TRACE_OPTIONS* Options, + _Out_opt_ TRACE_LOGFILE_HEADER* LogFileHeader + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return == ERROR_SUCCESS) +ULONG +WMIAPI +ProcessTraceBufferIncrementReference( + _In_ PROCESSTRACE_HANDLE TraceHandle, + _In_ const ETW_BUFFER_HEADER* Buffer + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return == ERROR_SUCCESS) +ULONG +WMIAPI +ProcessTraceBufferDecrementReference( + _In_ const ETW_BUFFER_HEADER* Buffer + ); + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +_Success_(return == ERROR_SUCCESS) +ULONG +WMIAPI +ProcessTraceAddBufferToBufferStream( + _In_ PROCESSTRACE_HANDLE TraceHandle, + _In_reads_bytes_(BufferSize) const ETW_BUFFER_HEADER* Buffer, + _In_ ULONG BufferSize + ); + +// +// Structures and enums for QueryTraceProcessingHandle +// + +typedef enum _ETW_PROCESS_HANDLE_INFO_TYPE { + EtwQueryPartitionInformation = 1, + EtwQueryPartitionInformationV2 = 2, + EtwQueryLastDroppedTimes = 3, + EtwQueryLogFileHeader = 4, + EtwQueryProcessHandleInfoMax +} ETW_PROCESS_HANDLE_INFO_TYPE; + +typedef struct _ETW_TRACE_PARTITION_INFORMATION { + GUID PartitionId; + GUID ParentId; + LONG64 QpcOffsetFromRoot; + ULONG PartitionType; +} ETW_TRACE_PARTITION_INFORMATION, *PETW_TRACE_PARTITION_INFORMATION; + +typedef struct _ETW_TRACE_PARTITION_INFORMATION_V2 { + LONG64 QpcOffsetFromRoot; + ULONG PartitionType; + PWSTR PartitionId; + PWSTR ParentId; +} ETW_TRACE_PARTITION_INFORMATION_V2, *PETW_TRACE_PARTITION_INFORMATION_V2; + + +EXTERN_C +ETW_APP_DECLSPEC_DEPRECATED +ULONG +WMIAPI +QueryTraceProcessingHandle ( + _In_ PROCESSTRACE_HANDLE ProcessingHandle, + _In_ ETW_PROCESS_HANDLE_INFO_TYPE InformationClass, + _In_opt_ PVOID InBuffer, + _In_ ULONG InBufferSize, + _Out_opt_ PVOID OutBuffer, + _In_ ULONG OutBufferSize, + _Inout_ PULONG ReturnLength + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// +// Data Consumer APIs and structures start here +// + +EXTERN_C +PROCESSTRACE_HANDLE +WMIAPI +OpenTraceA ( + _Inout_ PEVENT_TRACE_LOGFILEA Logfile + ); + +EXTERN_C +ULONG +WMIAPI +SetTraceCallback ( + _In_ LPCGUID pGuid, + _In_ PEVENT_CALLBACK EventCallback + ); + +EXTERN_C +ULONG +WMIAPI +RemoveTraceCallback ( + _In_ LPCGUID pGuid + ); + +// +// The routines for tracing Messages follow +// + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +__cdecl +TraceMessage ( + _In_ TRACELOGGER_HANDLE LoggerHandle, + _In_ ULONG MessageFlags, + _In_ LPCGUID MessageGuid, + _In_ USHORT MessageNumber, + ... +); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +EXTERN_C +ULONG +TraceMessageVa ( + _In_ TRACELOGGER_HANDLE LoggerHandle, + _In_ ULONG MessageFlags, + _In_ LPCGUID MessageGuid, + _In_ USHORT MessageNumber, + _In_ va_list MessageArgList +); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _APISET_EVENTING + +#ifdef __cplusplus +} // extern "C" +#endif + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#define INVALID_PROCESSTRACE_HANDLE ((PROCESSTRACE_HANDLE)INVALID_HANDLE_VALUE) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#ifndef _APISET_EVENTING + +// +// Define the encoding independent routines +// + +#if defined(UNICODE) || defined(_UNICODE) + +#pragma region Application Family or OneCore Family or GameCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#define RegisterTraceGuids RegisterTraceGuidsW +#define StartTrace StartTraceW +#define ControlTrace ControlTraceW +#if defined(__TRACE_W2K_COMPATIBLE) +#define StopTrace(a,b,c) ControlTraceW((a),(b),(c), \ + EVENT_TRACE_CONTROL_STOP) +#define QueryTrace(a,b,c) ControlTraceW((a),(b),(c), \ + EVENT_TRACE_CONTROL_QUERY) +#define UpdateTrace(a,b,c) ControlTraceW((a),(b),(c), \ + EVENT_TRACE_CONTROL_UPDATE) +#else +#define StopTrace StopTraceW +#define QueryTrace QueryTraceW +#define UpdateTrace UpdateTraceW +#endif +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define FlushTrace FlushTraceW +#endif // NTDDI_VERSION >= NTDDI_WINXP +#define QueryAllTraces QueryAllTracesW +#define OpenTrace OpenTraceW + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP| WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#else + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#define RegisterTraceGuids RegisterTraceGuidsA +#define StartTrace StartTraceA +#define ControlTrace ControlTraceA +#if defined(__TRACE_W2K_COMPATIBLE) +#define StopTrace(a,b,c) ControlTraceA((a),(b),(c), \ + EVENT_TRACE_CONTROL_STOP) +#define QueryTrace(a,b,c) ControlTraceA((a),(b),(c), \ + EVENT_TRACE_CONTROL_QUERY) +#define UpdateTrace(a,b,c) ControlTraceA((a),(b),(c), \ + EVENT_TRACE_CONTROL_UPDATE) +#else +#define StopTrace StopTraceA +#define QueryTrace QueryTraceA +#define UpdateTrace UpdateTraceA +#endif +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define FlushTrace FlushTraceA +#endif // NTDDI_VERSION >= NTDDI_WINXP +#define QueryAllTraces QueryAllTracesA +#define OpenTrace OpenTraceA + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // UNICODE + +#endif // _APISET_EVENTING + +#endif // !_EVNTRACE_KERNEL_MODE + +#endif // WINNT + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* _EVNTRACE_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/exposeenums2managed.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/exposeenums2managed.h new file mode 100644 index 0000000000000000000000000000000000000000..d526a26aef1d41148d7e0554913f5c3e3e65499c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/exposeenums2managed.h @@ -0,0 +1,81 @@ +//------------------------------------------------------------------------------ +// File: exposeenums2managed.h +// +// Desc: macros to allow the same enum to be exposed to native and managed +// +// USAGE: +// +// in your whatever.h file that defines the enums use ENUM or FLAGS(for enums defining bitmasks/flags) +// at the top of the file include this .h +// at the bottom of the file include unexposeenums2managed.h(resets the macro state) +// +// in a native client .idl/.h/.cpp file as normal just +// #include +// this will include the file normally +// +// in a mgd cpp file +// #include +// once normally, this will make the enums available to native +// +// Copyright (c) 2003-2004, Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + +// !!! do not pragma once or macro guard this file. +// it gets used multiple times by the same compilation units + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifdef MANAGED_ENUMS + +#ifndef _MANAGED +#error "you can only generate managed enums when compiling managed code" +#endif + +#define ENUM typedef public enum class +#define ENUMG(g) ENUM +#define ENUM16 ENUM +#define FLAGS [System::Flags] ENUM +#define FLAGS16 [System::Flags] ENUM16 +#define TAG(x) x +#define RATLEVEL(x) EnTvRat_GenericLevel::##x +#define RATATTR(x) BfEnTvRat_GenericAttributes::##x +#ifdef USING_EHRECVR_NAMESPACE +#define EHRECVR_MGD_OUTER_NAMESPACE Microsoft::MediaCenter::TV::Tuners +#define EHRECVR_MGD_NAMESPACE(x) EHRECVR_MGD_OUTER_NAMESPACE##::##x +#define ANALOG_VIDEO_STANDARD_NAMESPACE(x) EHRECVR_MGD_NAMESPACE(AnalogVideoStandard::##x) +#else +#define EHRECVR_MGD_NAMESPACE(x) x +#define ANALOG_VIDEO_STANDARD_NAMESPACE(x) x +#endif + + +#else // managed + +#ifdef __midl +#define V1_ENUM [v1_enum] +#define V1_ENUMG(g) [uuid(g), v1_enum] +#else +#define V1_ENUM +#define V1_ENUMG(g) +#endif +#define RATLEVEL(x) x +#define RATATTR(x) x +#define ENUM typedef V1_ENUM enum +#define ENUMG(g) typedef V1_ENUMG(g) enum +#define ENUM16 typedef enum +#define FLAGS ENUM +#define FLAGS16 ENUM16 +#define TAG(x) tag##x +#define EHRECVR_MGD_NAMESPACE(x) x +#define ANALOG_VIDEO_STANDARD_NAMESPACE(x) x + +#endif + +// end of file - exposeenums2managed.h + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fltUserStructures.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fltUserStructures.h new file mode 100644 index 0000000000000000000000000000000000000000..012cbec46bfe33a625de2422ccfbd6d7e9f732f1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fltUserStructures.h @@ -0,0 +1,636 @@ +/*++ + +Copyright (c) 1989-2002 Microsoft Corporation + +Module Name: + + fltUserStructures.h + +Abstract: + + This contains structures, types, and defintiions that are common to both + USER mode and KERNEL mode environments. + +Environment: + + User mode + +--*/ +#ifndef __FLT_USER_STRUCTURES_H__ +#define __FLT_USER_STRUCTURES_H__ + +#include + +#pragma region Desktop Family or or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if FLT_MGR_BASELINE + +// +// Disable warning for this file +// + +#define FLTAPI NTAPI + +#define FILTER_NAME_MAX_CHARS 255 +#define FILTER_NAME_MAX_BYTES (FILTER_NAME_MAX_CHARS * sizeof( WCHAR )) + +#define VOLUME_NAME_MAX_CHARS 1024 +#define VOLUME_NAME_MAX_BYTES (VOLUME_NAME_MAX_CHARS * sizeof( WCHAR )) + +#define INSTANCE_NAME_MAX_CHARS 255 +#define INSTANCE_NAME_MAX_BYTES (INSTANCE_NAME_MAX_CHARS * sizeof( WCHAR )) + +typedef HANDLE HFILTER; +typedef HANDLE HFILTER_INSTANCE; +typedef HANDLE HFILTER_VOLUME; + + +// +// Note: this may be removed in future when all translations from NTSTATUS to +// Win32 error codes are checked in. This is interim - since there the +// translation is not in for all filter manager error codes, +// apps will have to access NTSTATUS codes directly +// + +typedef _Return_type_success_(return >= 0) LONG NTSTATUS; +typedef NTSTATUS *PNTSTATUS; + +/////////////////////////////////////////////////////////////////////////////// +// +// Known File System Types +// +/////////////////////////////////////////////////////////////////////////////// + +typedef enum _FLT_FILESYSTEM_TYPE { + + FLT_FSTYPE_UNKNOWN, //an UNKNOWN file system type + FLT_FSTYPE_RAW, //Microsoft's RAW file system (\FileSystem\RAW) + FLT_FSTYPE_NTFS, //Microsoft's NTFS file system (\FileSystem\Ntfs) + FLT_FSTYPE_FAT, //Microsoft's FAT file system (\FileSystem\Fastfat) + FLT_FSTYPE_CDFS, //Microsoft's CDFS file system (\FileSystem\Cdfs) + FLT_FSTYPE_UDFS, //Microsoft's UDFS file system (\FileSystem\Udfs) + FLT_FSTYPE_LANMAN, //Microsoft's LanMan Redirector (\FileSystem\MRxSmb) + FLT_FSTYPE_WEBDAV, //Microsoft's WebDav redirector (\FileSystem\MRxDav) + FLT_FSTYPE_RDPDR, //Microsoft's Terminal Server redirector (\Driver\rdpdr) + FLT_FSTYPE_NFS, //Microsoft's NFS file system (\FileSystem\NfsRdr) + FLT_FSTYPE_MS_NETWARE, //Microsoft's NetWare redirector (\FileSystem\nwrdr) + FLT_FSTYPE_NETWARE, //Novell's NetWare redirector + FLT_FSTYPE_BSUDF, //The BsUDF CD-ROM driver (\FileSystem\BsUDF) + FLT_FSTYPE_MUP, //Microsoft's Mup redirector (\FileSystem\Mup) + FLT_FSTYPE_RSFX, //Microsoft's WinFS redirector (\FileSystem\RsFxDrv) + FLT_FSTYPE_ROXIO_UDF1, //Roxio's UDF writeable file system (\FileSystem\cdudf_xp) + FLT_FSTYPE_ROXIO_UDF2, //Roxio's UDF readable file system (\FileSystem\UdfReadr_xp) + FLT_FSTYPE_ROXIO_UDF3, //Roxio's DVD file system (\FileSystem\DVDVRRdr_xp) + FLT_FSTYPE_TACIT, //Tacit FileSystem (\Device\TCFSPSE) + FLT_FSTYPE_FS_REC, //Microsoft's File system recognizer (\FileSystem\Fs_rec) + FLT_FSTYPE_INCD, //Nero's InCD file system (\FileSystem\InCDfs) + FLT_FSTYPE_INCD_FAT, //Nero's InCD FAT file system (\FileSystem\InCDFat) + FLT_FSTYPE_EXFAT, //Microsoft's EXFat FILE SYSTEM (\FileSystem\exfat) + FLT_FSTYPE_PSFS, //PolyServ's file system (\FileSystem\psfs) + FLT_FSTYPE_GPFS, //IBM General Parallel File System (\FileSystem\gpfs) + FLT_FSTYPE_NPFS, //Microsoft's Named Pipe file system(\FileSystem\npfs) + FLT_FSTYPE_MSFS, //Microsoft's Mailslot file system (\FileSystem\msfs) + FLT_FSTYPE_CSVFS, //Microsoft's Cluster Shared Volume file system (\FileSystem\csvfs) + FLT_FSTYPE_REFS, //Microsoft's ReFS file system (\FileSystem\Refs or \FileSystem\Refsv1) + FLT_FSTYPE_OPENAFS, //OpenAFS file system (\Device\AFSRedirector) + FLT_FSTYPE_CIMFS //Composite Image file system (\FileSystem\cimfs) + +} FLT_FILESYSTEM_TYPE, *PFLT_FILESYSTEM_TYPE; + + +///////////////////////////////////////////////////////////////////////////// +// +// The different types information that can be return on an Filter. +// +// Note: Entries with "Aggregate" in the name return information for +// both LEGACY and MINI filters. +// +///////////////////////////////////////////////////////////////////////////// + + +// +// In xpsp2 we do not have the concept of enumerating legacy filters +// For this reason there is no FilterAggregateBasicInfo in the V1 version +// of the enum +// + +typedef enum _FILTER_INFORMATION_CLASS { + + FilterFullInformation, + FilterAggregateBasicInformation, //Added to XP SP2 via QFE + FilterAggregateStandardInformation //Longhorn and later + +} FILTER_INFORMATION_CLASS, *PFILTER_INFORMATION_CLASS; + +// +// The structures for the information returned from the query of +// information on a Filter. +// + +typedef struct _FILTER_FULL_INFORMATION { + + ULONG NextEntryOffset; + + ULONG FrameID; + + ULONG NumberOfInstances; + + USHORT FilterNameLength; + WCHAR FilterNameBuffer[1]; + +} FILTER_FULL_INFORMATION, *PFILTER_FULL_INFORMATION; + + +// +// This structure returns information for both legacy filters and mini +// filters. +// +// NOTE: Support for this structures exists in all OS's that support +// filter manager except XP SP2. It was added later to XP SP2 +// via a QFE. +// + +typedef struct _FILTER_AGGREGATE_BASIC_INFORMATION { + + ULONG NextEntryOffset; + + // + // ABI - Aggregate Basic Information flags + // + + ULONG Flags; + #define FLTFL_AGGREGATE_INFO_IS_MINIFILTER 0x00000001 + #define FLTFL_AGGREGATE_INFO_IS_LEGACYFILTER 0x00000002 + + union { + + // + // Minifilter FULL information + // + + struct { + + ULONG FrameID; + + ULONG NumberOfInstances; + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + + USHORT FilterAltitudeLength; + USHORT FilterAltitudeBufferOffset; + + } MiniFilter; + + // + // Legacyfilter information + // + + struct { + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + + } LegacyFilter; + + } Type; + +} FILTER_AGGREGATE_BASIC_INFORMATION, *PFILTER_AGGREGATE_BASIC_INFORMATION; + + +// +// This structure returns information for both legacy filters and mini +// filters. +// +// NOTE: Support for this structures exists in Vista and Later +// + +#if FLT_MGR_LONGHORN +typedef struct _FILTER_AGGREGATE_STANDARD_INFORMATION { + + ULONG NextEntryOffset; + + // + // ASI - Aggregate Standard Information flags + // + + ULONG Flags; + #define FLTFL_ASI_IS_MINIFILTER 0x00000001 + #define FLTFL_ASI_IS_LEGACYFILTER 0x00000002 + + union { + + // + // Minifilter FULL information + // + + struct { + + // + // ASIM - Aggregate Standard Information Minifilter flags + // + + ULONG Flags; + + + ULONG FrameID; + + ULONG NumberOfInstances; + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + + USHORT FilterAltitudeLength; + USHORT FilterAltitudeBufferOffset; + + } MiniFilter; + + // + // Legacyfilter information + // + + struct { + + // + // ASIL - Aggregate Standard Information LegacyFilter flags + // + + ULONG Flags; + + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + + USHORT FilterAltitudeLength; + USHORT FilterAltitudeBufferOffset; + + } LegacyFilter; + + } Type; + +} FILTER_AGGREGATE_STANDARD_INFORMATION, *PFILTER_AGGREGATE_STANDARD_INFORMATION; +#endif // FLT_MGR_LONGHORN + + +///////////////////////////////////////////////////////////////////////////// +// +// The different types information that can be return for a Volume +// +///////////////////////////////////////////////////////////////////////////// + +typedef enum _FILTER_VOLUME_INFORMATION_CLASS { + + FilterVolumeBasicInformation, + FilterVolumeStandardInformation //Longhorn and later + +} FILTER_VOLUME_INFORMATION_CLASS, *PFILTER_VOLUME_INFORMATION_CLASS; + + +// +// Basic information about a volume (its name) +// + +typedef struct _FILTER_VOLUME_BASIC_INFORMATION { + + // + // Length of name + // + + USHORT FilterVolumeNameLength; + + // + // Buffer containing name (it's NOT NULL-terminated) + // + + WCHAR FilterVolumeName[1]; + +} FILTER_VOLUME_BASIC_INFORMATION, *PFILTER_VOLUME_BASIC_INFORMATION; + +// +// Additional volume information. +// +// NOTE: Only available in LONGHORN and later OS's +// + +#if FLT_MGR_LONGHORN +typedef struct _FILTER_VOLUME_STANDARD_INFORMATION { + + ULONG NextEntryOffset; + + // + // VSI - VOlume Standard Information flags + // + + ULONG Flags; + + // + // If set this volume is not current attached to a storage stack + // + + #define FLTFL_VSI_DETACHED_VOLUME 0x00000001 + + // + // Identifies which frame this volume structure is in + // + + ULONG FrameID; + + // + // Identifies the type of file system being used on the volume + // + + FLT_FILESYSTEM_TYPE FileSystemType; + + // + // Length of name + // + + USHORT FilterVolumeNameLength; + + // + // Buffer containing name (it's NOT NULL-terminated) + // + + WCHAR FilterVolumeName[1]; + +} FILTER_VOLUME_STANDARD_INFORMATION, *PFILTER_VOLUME_STANDARD_INFORMATION; +#endif // FLT_MGR_LONGHORN + + + +///////////////////////////////////////////////////////////////////////////// +// +// The different types information that can be return on an Instance. +// +///////////////////////////////////////////////////////////////////////////// + +typedef enum _INSTANCE_INFORMATION_CLASS { + + InstanceBasicInformation, + InstancePartialInformation, + InstanceFullInformation, + InstanceAggregateStandardInformation //LONGHORN and later + +} INSTANCE_INFORMATION_CLASS, *PINSTANCE_INFORMATION_CLASS; + + +// +// The structures for the information returned from the query of the information +// on the Instance. All strings are UNICODE strings. All Lengths are in bytes +// + +typedef _Struct_size_bytes_(sizeof(INSTANCE_BASIC_INFORMATION) * InstanceNameLength) struct _INSTANCE_BASIC_INFORMATION { + + ULONG NextEntryOffset; + + USHORT InstanceNameLength; + USHORT InstanceNameBufferOffset; + +} INSTANCE_BASIC_INFORMATION, *PINSTANCE_BASIC_INFORMATION; + +typedef _Struct_size_bytes_(sizeof(INSTANCE_PARTIAL_INFORMATION) + InstanceNameLength + AltitudeLength) struct _INSTANCE_PARTIAL_INFORMATION { + + ULONG NextEntryOffset; + + USHORT InstanceNameLength; + USHORT InstanceNameBufferOffset; + + USHORT AltitudeLength; + USHORT AltitudeBufferOffset; + +} INSTANCE_PARTIAL_INFORMATION, *PINSTANCE_PARTIAL_INFORMATION; + +typedef _Struct_size_bytes_(sizeof(INSTANCE_FULL_INFORMATION) + InstanceNameLength + AltitudeLength + VolumeNameLength + FilterNameLength) struct _INSTANCE_FULL_INFORMATION { + + ULONG NextEntryOffset; + + USHORT InstanceNameLength; + USHORT InstanceNameBufferOffset; + + USHORT AltitudeLength; + USHORT AltitudeBufferOffset; + + USHORT VolumeNameLength; + USHORT VolumeNameBufferOffset; + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + +} INSTANCE_FULL_INFORMATION, *PINSTANCE_FULL_INFORMATION; + + +// +// This information class is used to return instance information about both +// legacy filters and minifilters. +// + +#if FLT_MGR_LONGHORN +typedef struct _INSTANCE_AGGREGATE_STANDARD_INFORMATION { + + ULONG NextEntryOffset; + + // + // IASI - Instance Aggregate Standard Information flags + // + + ULONG Flags; + #define FLTFL_IASI_IS_MINIFILTER 0x00000001 + #define FLTFL_IASI_IS_LEGACYFILTER 0x00000002 + + union { + + // + // MiniFilter information + // + + struct { + + // + // IASIM - Instance Aggregate Standard Information Minifilter flags + // + + ULONG Flags; + + // + // If set this volume is not current attached to a storage stack + // + + #define FLTFL_IASIM_DETACHED_VOLUME 0x00000001 + + // + // Identifies which frame this volume structure is in + // + + ULONG FrameID; + + // + // The type of file system this instance is attached to + // + + FLT_FILESYSTEM_TYPE VolumeFileSystemType; + + // + // The name of this instance (unicode string) + // + + USHORT InstanceNameLength; //in bytes + USHORT InstanceNameBufferOffset; + + // + // The altitude of this instance (unicode string) + // + + USHORT AltitudeLength; + USHORT AltitudeBufferOffset; + + // + // The volume name this instance is attached to (unicode string) + // + + USHORT VolumeNameLength; + USHORT VolumeNameBufferOffset; + + // + // The name of the minifilter associated with this instace (unicode string) + // + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + +#if FLT_MGR_WIN8 + // + // Identifies the "SupportedFeatures" state for this filter + // The flag values for this can be found in ntifs.h and begin + // with: FSFILTER_SUPPORTED_FEATURES_ + // + + ULONG SupportedFeatures; +#endif + + } MiniFilter; + + // + // Legacyfilter information + // + + struct { + + // + // IASIL - Instance Aggregate Standard Information LegacyFilter flags + // + + ULONG Flags; + + // + // If set this volume is not current attached to a storage stack + // + + #define FLTFL_IASIL_DETACHED_VOLUME 0x00000001 + + // + // The altitude of this attachment (unicode string) + // + + USHORT AltitudeLength; + USHORT AltitudeBufferOffset; + + // + // The volume name this filter is attached to (unicode string) + // + + USHORT VolumeNameLength; + USHORT VolumeNameBufferOffset; + + // + // The name of the filter associated with this attachment (unicode string) + // + + USHORT FilterNameLength; + USHORT FilterNameBufferOffset; + +#if FLT_MGR_WIN8 + // + // Identifies the "SupportedFeatures" state for this filter + // The flag values for this can be found in ntifs.h and begin + // with: SUPPORTED_FS_FEATURES_ + // + + ULONG SupportedFeatures; +#endif + + } LegacyFilter; + + } Type; + +} INSTANCE_AGGREGATE_STANDARD_INFORMATION, *PINSTANCE_AGGREGATE_STANDARD_INFORMATION; +#endif // FLT_MGR_LONGHORN + + +///////////////////////////////////////////////////////////////////////////// +// +// Message defintitions +// +///////////////////////////////////////////////////////////////////////////// + +typedef struct _FILTER_MESSAGE_HEADER { + + // + // OUT + // + // Total buffer length in bytes, including the FILTER_REPLY_HEADER, of + // the expected reply. If no reply is expected, 0 is returned. + // + + ULONG ReplyLength; + + // + // OUT + // + // Unique Id for this message. This will be set when the kernel message + // satifies this FilterGetMessage or FilterInstanceGetMessage request. + // If replying to this message, this is the MessageId that should be used. + // + + ULONGLONG MessageId; + + // + // General filter-specific buffer data follows... + // + +} FILTER_MESSAGE_HEADER, *PFILTER_MESSAGE_HEADER; + +typedef struct _FILTER_REPLY_HEADER { + + // + // IN. + // + // Status of this reply. This status will be returned back to the filter + // driver who is waiting for a reply. + // + + NTSTATUS Status; + + // + // IN + // + // Unique Id for this message. This id was returned in the + // FILTER_MESSAGE_HEADER from the kernel message to which we are replying. + // + + ULONGLONG MessageId; + + // + // General filter-specific buffer data follows... + // + +} FILTER_REPLY_HEADER, *PFILTER_REPLY_HEADER; + +#endif //FLT_MGR_BASELINE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* __FLT_USER_STRUCTURES_H__ */ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fttypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fttypes.h new file mode 100644 index 0000000000000000000000000000000000000000..9050c1b0b4413e1b57f120760334a3740c7eea80 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fttypes.h @@ -0,0 +1,144 @@ +/*++ + +Copyright (c) 1996-1999 Microsoft Corporation + +Module Name: + + fttypes.h + +Abstract: + + This header file defines types and structures for the FT API + and the IOCTLs used to implement the FT API. + +Notes: + +Revision History: + +--*/ + +#if !defined( _FT_TYPES_DEFINITION_ ) + +#define _FT_TYPES_DEFINITION_ 1 + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// The logical disk id type is used to uniquely identify a logical disk. It +// needs to be unique in the universe. +// + +typedef LONGLONG FT_LOGICAL_DISK_ID, *PFT_LOGICAL_DISK_ID; + +#if (NTDDI_VERSION < NTDDI_VISTA) + +// +// This enumerated type defines all of the different types of logical +// disks that can be constructed with this API. +// + +typedef enum _FT_LOGICAL_DISK_TYPE { + FtPartition, + FtVolumeSet, + FtStripeSet, + FtMirrorSet, + FtStripeSetWithParity, + FtRedistribution +} FT_LOGICAL_DISK_TYPE, *PFT_LOGICAL_DISK_TYPE; + +// +// This enumerated type defines all of the possible states that members +// of an FT set can have. +// + +typedef enum _FT_MEMBER_STATE { + FtMemberHealthy, + FtMemberRegenerating, + FtMemberOrphaned +} FT_MEMBER_STATE, *PFT_MEMBER_STATE; + +// +// This is the structure needed for the configuration information of +// a logical disk type of 'FtPartition'. +// + +typedef struct _FT_PARTITION_CONFIGURATION_INFORMATION { + ULONG Signature; + ULONG DiskNumber; + LONGLONG ByteOffset; +} FT_PARTITION_CONFIGURATION_INFORMATION, *PFT_PARTITION_CONFIGURATION_INFORMATION; + +// +// This is the structure needed for the configuration information of +// a logical disk type of 'FtStripeSet'. +// + +typedef struct _FT_STRIPE_SET_CONFIGURATION_INFORMATION { + ULONG StripeSize; +} FT_STRIPE_SET_CONFIGURATION_INFORMATION, *PFT_STRIPE_SET_CONFIGURATION_INFORMATION; + +// +// This is the structure needed for the configuration information of +// a logical disk type of 'FtMirrorSet'. +// + +typedef struct _FT_MIRROR_SET_CONFIGURATION_INFORMATION { + LONGLONG MemberSize; +} FT_MIRROR_SET_CONFIGURATION_INFORMATION, *PFT_MIRROR_SET_CONFIGURATION_INFORMATION; + +// +// This is the structure needed for the configuration information of +// a logical disk type of 'FtStripeSetWithParity'. +// + +typedef struct _FT_STRIPE_SET_WITH_PARITY_CONFIGURATION_INFORMATION { + LONGLONG MemberSize; + ULONG StripeSize; +} FT_STRIPE_SET_WITH_PARITY_CONFIGURATION_INFORMATION, *PFT_STRIPE_SET_WITH_PARITY_CONFIGURATION_INFORMATION; + +// +// This is the structure needed for the configuration information of +// a logical disk type of 'FtRedistribution'. +// + +typedef struct _FT_REDISTRIBUTION_CONFIGURATION_INFORMATION { + ULONG StripeSize; + USHORT FirstMemberWidth; + USHORT SecondMemberWidth; +} FT_REDISTRIBUTION_CONFIGURATION_INFORMATION, *PFT_REDISTRIBUTION_CONFIGURATION_INFORMATION; + +// +// This is the structure needed for the state of a logical disk type of +// 'FtStripeSetWithParity' or 'FtMirrorSet'. +// + +typedef struct _FT_MIRROR_AND_SWP_STATE_INFORMATION { + BOOLEAN IsDirty; + BOOLEAN IsInitializing; + USHORT UnhealthyMemberNumber; + FT_MEMBER_STATE UnhealthyMemberState; +} FT_MIRROR_AND_SWP_STATE_INFORMATION, *PFT_MIRROR_AND_SWP_STATE_INFORMATION; + +// +// This is the structure needed for the state of a logical disk type of +// 'FtRedistribution'. +// + +typedef struct _FT_REDISTRIBUTION_STATE_INFORMATION { + LONGLONG BytesRedistributed; +} FT_REDISTRIBUTION_STATE_INFORMATION, *PFT_REDISTRIBUTION_STATE_INFORMATION; + +#endif // < NTDDI_VISTA + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.h new file mode 100644 index 0000000000000000000000000000000000000000..b3cff8613a40d0cae358166e30c9bc96a2f5fdf6 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.h @@ -0,0 +1,1339 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + + +#ifndef __fwpmtypes_h__ +#define __fwpmtypes_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +/* header files for imported files */ +#include "fwptypes.h" +#include "iketypes.h" +#include "ipsectypes.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_fwpmtypes_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family or AppRuntime Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif +#ifndef _DEFINE_DL_ADDRESS_TYPE_ +#define _DEFINE_DL_ADDRESS_TYPE_ +typedef /* [public][v1_enum] */ +enum __MIDL___MIDL_itf_fwpmtypes_0000_0000_0001 + { + DlUnicast = 0, + DlMulticast = ( DlUnicast + 1 ) , + DlBroadcast = ( DlMulticast + 1 ) + } DL_ADDRESS_TYPE; + +typedef /* [v1_enum] */ enum __MIDL___MIDL_itf_fwpmtypes_0000_0000_0001 *PDL_ADDRESS_TYPE; + +#endif +typedef /* [v1_enum] */ +enum FWPM_CHANGE_TYPE_ + { + FWPM_CHANGE_ADD = 1, + FWPM_CHANGE_DELETE = ( FWPM_CHANGE_ADD + 1 ) , + FWPM_CHANGE_TYPE_MAX = ( FWPM_CHANGE_DELETE + 1 ) + } FWPM_CHANGE_TYPE; + +#define FWPM_SUBSCRIPTION_FLAG_NOTIFY_ON_ADD (0x00000001) +#define FWPM_SUBSCRIPTION_FLAG_NOTIFY_ON_DELETE (0x00000002) +typedef +enum FWPM_SERVICE_STATE_ + { + FWPM_SERVICE_STOPPED = 0, + FWPM_SERVICE_START_PENDING = ( FWPM_SERVICE_STOPPED + 1 ) , + FWPM_SERVICE_STOP_PENDING = ( FWPM_SERVICE_START_PENDING + 1 ) , + FWPM_SERVICE_RUNNING = ( FWPM_SERVICE_STOP_PENDING + 1 ) , + FWPM_SERVICE_STATE_MAX = ( FWPM_SERVICE_RUNNING + 1 ) + } FWPM_SERVICE_STATE; + +#define FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST (0x00000001) +#define FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST (0x00000002) +#define FWPM_NET_EVENT_KEYWORD_CAPABILITY_DROP (0x00000004) +#define FWPM_NET_EVENT_KEYWORD_CAPABILITY_ALLOW (0x00000008) +#define FWPM_NET_EVENT_KEYWORD_CLASSIFY_ALLOW (0x00000010) +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define FWPM_NET_EVENT_KEYWORD_PORT_SCANNING_DROP (0x00000020) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE (0x00000000) +#define FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND (0x00000001) +#define FWPM_ENGINE_OPTION_PACKET_QUEUE_FORWARD (0x00000002) +#define FWPM_ENGINE_OPTION_PACKET_BATCH_INBOUND (0x00000004) +typedef +enum FWPM_ENGINE_OPTION_ + { + FWPM_ENGINE_COLLECT_NET_EVENTS = 0, + FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS = ( FWPM_ENGINE_COLLECT_NET_EVENTS + 1 ) , + FWPM_ENGINE_NAME_CACHE = ( FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS + 1 ) , + FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS = ( FWPM_ENGINE_NAME_CACHE + 1 ) , + FWPM_ENGINE_PACKET_QUEUING = ( FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS + 1 ) , + FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC = ( FWPM_ENGINE_PACKET_QUEUING + 1 ) , + FWPM_ENGINE_OPTION_MAX = ( FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC + 1 ) + } FWPM_ENGINE_OPTION; + +#define FWPM_SESSION_FLAG_DYNAMIC (0x00000001) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_SESSION_FLAG_RESERVED (0x10000000) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_SESSION0_ + { + GUID sessionKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + UINT32 txnWaitTimeoutInMSec; + DWORD processId; + /* [unique] */ SID *sid; + /* [unique][string] */ wchar_t *username; + BOOL kernelMode; + } FWPM_SESSION0; + +typedef struct FWPM_SESSION_ENUM_TEMPLATE0_ + { + UINT64 reserved; + } FWPM_SESSION_ENUM_TEMPLATE0; + +#define FWPM_PROVIDER_FLAG_PERSISTENT (0x00000001) +#define FWPM_PROVIDER_FLAG_DISABLED (0x00000010) +typedef struct FWPM_PROVIDER0_ + { + GUID providerKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + FWP_BYTE_BLOB providerData; + /* [unique][string] */ wchar_t *serviceName; + } FWPM_PROVIDER0; + +typedef struct FWPM_PROVIDER_ENUM_TEMPLATE0_ + { + UINT64 reserved; + } FWPM_PROVIDER_ENUM_TEMPLATE0; + +typedef struct FWPM_PROVIDER_CHANGE0_ + { + FWPM_CHANGE_TYPE changeType; + GUID providerKey; + } FWPM_PROVIDER_CHANGE0; + +typedef struct FWPM_PROVIDER_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_PROVIDER_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_PROVIDER_SUBSCRIPTION0; + +#define FWPM_PROVIDER_CONTEXT_FLAG_PERSISTENT (0x00000001) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_PROVIDER_CONTEXT_FLAG_DOWNLEVEL (0x00000002) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_CLASSIFY_OPTION0_ + { + FWP_CLASSIFY_OPTION_TYPE type; + FWP_VALUE0 value; + } FWPM_CLASSIFY_OPTION0; + +typedef struct FWPM_CLASSIFY_OPTIONS0_ + { + UINT32 numOptions; + /* [ref][size_is] */ FWPM_CLASSIFY_OPTION0 *options; + } FWPM_CLASSIFY_OPTIONS0; + +typedef struct FWPM_NETWORK_CONNECTION_POLICY_SETTING0_ + { + FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE type; + FWP_VALUE0 value; + } FWPM_NETWORK_CONNECTION_POLICY_SETTING0; + +typedef struct FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0_ + { + UINT32 numSettings; + /* [ref][size_is] */ FWPM_NETWORK_CONNECTION_POLICY_SETTING0 *settings; + } FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0; + +typedef /* [v1_enum] */ +enum FWPM_PROVIDER_CONTEXT_TYPE_ + { + FWPM_IPSEC_KEYING_CONTEXT = 0, + FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT = ( FWPM_IPSEC_KEYING_CONTEXT + 1 ) , + FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT = ( FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT + 1 ) , + FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT = ( FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT + 1 ) , + FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT = ( FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT + 1 ) , + FWPM_IPSEC_IKE_MM_CONTEXT = ( FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT + 1 ) , + FWPM_IPSEC_AUTHIP_MM_CONTEXT = ( FWPM_IPSEC_IKE_MM_CONTEXT + 1 ) , + FWPM_CLASSIFY_OPTIONS_CONTEXT = ( FWPM_IPSEC_AUTHIP_MM_CONTEXT + 1 ) , + FWPM_GENERAL_CONTEXT = ( FWPM_CLASSIFY_OPTIONS_CONTEXT + 1 ) , + FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT = ( FWPM_GENERAL_CONTEXT + 1 ) , + FWPM_IPSEC_IKEV2_MM_CONTEXT = ( FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT + 1 ) , + FWPM_IPSEC_DOSP_CONTEXT = ( FWPM_IPSEC_IKEV2_MM_CONTEXT + 1 ) , + FWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT = ( FWPM_IPSEC_DOSP_CONTEXT + 1 ) , + FWPM_NETWORK_CONNECTION_POLICY_CONTEXT = ( FWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT + 1 ) , + FWPM_PROVIDER_CONTEXT_TYPE_MAX = ( FWPM_NETWORK_CONNECTION_POLICY_CONTEXT + 1 ) + } FWPM_PROVIDER_CONTEXT_TYPE; + +typedef struct FWPM_PROVIDER_CONTEXT0_ + { + GUID providerContextKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + FWPM_PROVIDER_CONTEXT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_KEYING_POLICY0 *keyingPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY0 *ikeQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY0 *ikeQmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY0 *authipQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY0 *authipQmTunnelPolicy; + /* [case()][unique] */ IKEEXT_POLICY0 *ikeMmPolicy; + /* [case()][unique] */ IKEEXT_POLICY0 *authIpMmPolicy; + /* [case()][unique] */ FWP_BYTE_BLOB *dataBuffer; + /* [case()][unique] */ FWPM_CLASSIFY_OPTIONS0 *classifyOptions; + /* [default] */ /* Empty union arm */ + } ; + UINT64 providerContextId; + } FWPM_PROVIDER_CONTEXT0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_PROVIDER_CONTEXT1_ + { + GUID providerContextKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + FWPM_PROVIDER_CONTEXT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_KEYING_POLICY0 *keyingPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY1 *ikeQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY1 *ikeQmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY1 *authipQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY1 *authipQmTunnelPolicy; + /* [case()][unique] */ IKEEXT_POLICY1 *ikeMmPolicy; + /* [case()][unique] */ IKEEXT_POLICY1 *authIpMmPolicy; + /* [case()][unique] */ FWP_BYTE_BLOB *dataBuffer; + /* [case()][unique] */ FWPM_CLASSIFY_OPTIONS0 *classifyOptions; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY1 *ikeV2QmTunnelPolicy; + /* [case()][unique] */ IKEEXT_POLICY1 *ikeV2MmPolicy; + /* [case()][unique] */ IPSEC_DOSP_OPTIONS0 *idpOptions; + } ; + UINT64 providerContextId; + } FWPM_PROVIDER_CONTEXT1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_PROVIDER_CONTEXT2_ + { + GUID providerContextKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + FWPM_PROVIDER_CONTEXT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_KEYING_POLICY1 *keyingPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *ikeQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY2 *ikeQmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *authipQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY2 *authipQmTunnelPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *ikeMmPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *authIpMmPolicy; + /* [case()][unique] */ FWP_BYTE_BLOB *dataBuffer; + /* [case()][unique] */ FWPM_CLASSIFY_OPTIONS0 *classifyOptions; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY2 *ikeV2QmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *ikeV2QmTransportPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *ikeV2MmPolicy; + /* [case()][unique] */ IPSEC_DOSP_OPTIONS0 *idpOptions; + } ; + UINT64 providerContextId; + } FWPM_PROVIDER_CONTEXT2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct FWPM_PROVIDER_CONTEXT3_ + { + GUID providerContextKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + FWPM_PROVIDER_CONTEXT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_KEYING_POLICY1 *keyingPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *ikeQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY3 *ikeQmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *authipQmTransportPolicy; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY3 *authipQmTunnelPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *ikeMmPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *authIpMmPolicy; + /* [case()][unique] */ FWP_BYTE_BLOB *dataBuffer; + /* [case()][unique] */ FWPM_CLASSIFY_OPTIONS0 *classifyOptions; + /* [case()][unique] */ IPSEC_TUNNEL_POLICY3 *ikeV2QmTunnelPolicy; + /* [case()][unique] */ IPSEC_TRANSPORT_POLICY2 *ikeV2QmTransportPolicy; + /* [case()][unique] */ IKEEXT_POLICY2 *ikeV2MmPolicy; + /* [case()][unique] */ IPSEC_DOSP_OPTIONS0 *idpOptions; + /* [case()][unique] */ FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0 *networkConnectionPolicy; + } ; + UINT64 providerContextId; + } FWPM_PROVIDER_CONTEXT3; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0_ + { + /* [unique] */ GUID *providerKey; + FWPM_PROVIDER_CONTEXT_TYPE providerContextType; + } FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0; + +typedef struct FWPM_PROVIDER_CONTEXT_CHANGE0_ + { + FWPM_CHANGE_TYPE changeType; + GUID providerContextKey; + UINT64 providerContextId; + } FWPM_PROVIDER_CONTEXT_CHANGE0; + +typedef struct FWPM_PROVIDER_CONTEXT_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_PROVIDER_CONTEXT_SUBSCRIPTION0; + +#define FWPM_SUBLAYER_FLAG_PERSISTENT (0x00000001) +typedef struct FWPM_SUBLAYER0_ + { + GUID subLayerKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + UINT16 weight; + } FWPM_SUBLAYER0; + +typedef struct FWPM_SUBLAYER_ENUM_TEMPLATE0_ + { + /* [unique] */ GUID *providerKey; + } FWPM_SUBLAYER_ENUM_TEMPLATE0; + +typedef struct FWPM_SUBLAYER_CHANGE0_ + { + FWPM_CHANGE_TYPE changeType; + GUID subLayerKey; + } FWPM_SUBLAYER_CHANGE0; + +typedef struct FWPM_SUBLAYER_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_SUBLAYER_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_SUBLAYER_SUBSCRIPTION0; + +#define FWPM_LAYER_FLAG_KERNEL (0x00000001) +#define FWPM_LAYER_FLAG_BUILTIN (0x00000002) +#define FWPM_LAYER_FLAG_CLASSIFY_MOSTLY (0x00000004) +#define FWPM_LAYER_FLAG_BUFFERED (0x00000008) +typedef /* [v1_enum] */ +enum FWPM_FIELD_TYPE_ + { + FWPM_FIELD_RAW_DATA = 0, + FWPM_FIELD_IP_ADDRESS = ( FWPM_FIELD_RAW_DATA + 1 ) , + FWPM_FIELD_FLAGS = ( FWPM_FIELD_IP_ADDRESS + 1 ) , + FWPM_FIELD_TYPE_MAX = ( FWPM_FIELD_FLAGS + 1 ) + } FWPM_FIELD_TYPE; + +typedef struct FWPM_FIELD0_ + { + /* [ref] */ GUID *fieldKey; + FWPM_FIELD_TYPE type; + FWP_DATA_TYPE dataType; + } FWPM_FIELD0; + +typedef struct FWPM_LAYER0_ + { + GUID layerKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + UINT32 numFields; + /* [ref][size_is] */ FWPM_FIELD0 *field; + GUID defaultSubLayerKey; + UINT16 layerId; + } FWPM_LAYER0; + +typedef struct FWPM_LAYER_ENUM_TEMPLATE0_ + { + UINT64 reserved; + } FWPM_LAYER_ENUM_TEMPLATE0; + +#define FWPM_CALLOUT_FLAG_PERSISTENT (0x00010000) +#define FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT (0x00020000) +#define FWPM_CALLOUT_FLAG_REGISTERED (0x00040000) +typedef struct FWPM_CALLOUT0_ + { + GUID calloutKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + GUID applicableLayer; + UINT32 calloutId; + } FWPM_CALLOUT0; + +typedef struct FWPM_CALLOUT_ENUM_TEMPLATE0_ + { + /* [unique] */ GUID *providerKey; + GUID layerKey; + } FWPM_CALLOUT_ENUM_TEMPLATE0; + +typedef struct FWPM_CALLOUT_CHANGE0_ + { + FWPM_CHANGE_TYPE changeType; + GUID calloutKey; + UINT32 calloutId; + } FWPM_CALLOUT_CHANGE0; + +typedef struct FWPM_CALLOUT_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_CALLOUT_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_CALLOUT_SUBSCRIPTION0; + +typedef struct FWPM_ACTION0_ + { + FWP_ACTION_TYPE type; + /* [switch_is] */ /* [switch_type] */ union + { + /* [case()] */ GUID filterType; + /* [case()] */ GUID calloutKey; + } ; + } FWPM_ACTION0; + +typedef struct FWPM_FILTER_CONDITION0_ + { + GUID fieldKey; + FWP_MATCH_TYPE matchType; + FWP_CONDITION_VALUE0 conditionValue; + } FWPM_FILTER_CONDITION0; + +#define FWPM_FILTER_FLAG_NONE (0x00000000) +#define FWPM_FILTER_FLAG_PERSISTENT (0x00000001) +#define FWPM_FILTER_FLAG_BOOTTIME (0x00000002) +#define FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT (0x00000004) +#define FWPM_FILTER_FLAG_CLEAR_ACTION_RIGHT (0x00000008) +#define FWPM_FILTER_FLAG_PERMIT_IF_CALLOUT_UNREGISTERED (0x00000010) +#define FWPM_FILTER_FLAG_DISABLED (0x00000020) +#define FWPM_FILTER_FLAG_INDEXED (0x00000040) +#define FWPM_FILTER_FLAG_HAS_SECURITY_REALM_PROVIDER_CONTEXT (0x00000080) +#define FWPM_FILTER_FLAG_SYSTEMOS_ONLY (0x00000100) +#define FWPM_FILTER_FLAG_GAMEOS_ONLY (0x00000200) +#define FWPM_FILTER_FLAG_SILENT_MODE (0x00000400) +#define FWPM_FILTER_FLAG_IPSEC_NO_ACQUIRE_INITIATE (0x00000800) +#define FWPM_FILTER_FLAG_RESERVED0 (0x00001000) +#define FWPM_FILTER_FLAG_RESERVED1 (0x00002000) +#define FWPM_FILTER_FLAG_RESERVED2 (0x00004000) +typedef struct FWPM_FILTER0_ + { + GUID filterKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + /* [unique] */ GUID *providerKey; + FWP_BYTE_BLOB providerData; + GUID layerKey; + GUID subLayerKey; + FWP_VALUE0 weight; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPM_FILTER_CONDITION0 *filterCondition; + FWPM_ACTION0 action; + /* [switch_is] */ /* [switch_type] */ union + { + /* [case()] */ UINT64 rawContext; + /* [case()] */ GUID providerContextKey; + } ; + /* [unique] */ GUID *reserved; + UINT64 filterId; + FWP_VALUE0 effectiveWeight; + } FWPM_FILTER0; + +typedef struct FWPM_FILTER_ENUM_TEMPLATE0_ + { + /* [unique] */ GUID *providerKey; + GUID layerKey; + FWP_FILTER_ENUM_TYPE enumType; + UINT32 flags; + /* [unique] */ FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0 *providerContextTemplate; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPM_FILTER_CONDITION0 *filterCondition; + UINT32 actionMask; + /* [unique] */ GUID *calloutKey; + } FWPM_FILTER_ENUM_TEMPLATE0; + +typedef struct FWPM_FILTER_CHANGE0_ + { + FWPM_CHANGE_TYPE changeType; + GUID filterKey; + UINT64 filterId; + } FWPM_FILTER_CHANGE0; + +typedef struct FWPM_FILTER_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_FILTER_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_FILTER_SUBSCRIPTION0; + +typedef struct FWPM_LAYER_STATISTICS0_ + { + GUID layerId; + UINT32 classifyPermitCount; + UINT32 classifyBlockCount; + UINT32 classifyVetoCount; + UINT32 numCacheEntries; + } FWPM_LAYER_STATISTICS0; + +typedef struct FWPM_LAYER_STATISTICS1_ + { + GUID layerId; + UINT32 classifyPermitCount; + UINT32 classifyBlockCount; + UINT32 classifyVetoCount; + UINT32 numCacheEntries; + UINT32 filterCount; + UINT32 totalFilterSize; + } FWPM_LAYER_STATISTICS1; + +typedef struct FWPM_STATISTICS0_ + { + UINT32 numLayerStatistics; + /* [ref][size_is] */ FWPM_LAYER_STATISTICS0 *layerStatistics; + UINT32 inboundAllowedConnectionsV4; + UINT32 inboundBlockedConnectionsV4; + UINT32 outboundAllowedConnectionsV4; + UINT32 outboundBlockedConnectionsV4; + UINT32 inboundAllowedConnectionsV6; + UINT32 inboundBlockedConnectionsV6; + UINT32 outboundAllowedConnectionsV6; + UINT32 outboundBlockedConnectionsV6; + UINT32 inboundActiveConnectionsV4; + UINT32 outboundActiveConnectionsV4; + UINT32 inboundActiveConnectionsV6; + UINT32 outboundActiveConnectionsV6; + UINT64 reauthDirInbound; + UINT64 reauthDirOutbound; + UINT64 reauthFamilyV4; + UINT64 reauthFamilyV6; + UINT64 reauthProtoOther; + UINT64 reauthProtoIPv4; + UINT64 reauthProtoIPv6; + UINT64 reauthProtoICMP; + UINT64 reauthProtoICMP6; + UINT64 reauthProtoUDP; + UINT64 reauthProtoTCP; + UINT64 reauthReasonPolicyChange; + UINT64 reauthReasonNewArrivalInterface; + UINT64 reauthReasonNewNextHopInterface; + UINT64 reauthReasonProfileCrossing; + UINT64 reauthReasonClassifyCompletion; + UINT64 reauthReasonIPSecPropertiesChanged; + UINT64 reauthReasonMidStreamInspection; + UINT64 reauthReasonSocketPropertyChanged; + UINT64 reauthReasonNewInboundMCastBCastPacket; + UINT64 reauthReasonEDPPolicyChanged; + UINT64 reauthReasonProxyHandleChanged; + } FWPM_STATISTICS0; + +typedef struct FWPM_STATISTICS1_ + { + UINT32 numLayerStatistics; + /* [ref][size_is] */ FWPM_LAYER_STATISTICS1 *layerStatistics; + UINT32 inboundAllowedConnectionsV4; + UINT32 inboundBlockedConnectionsV4; + UINT32 outboundAllowedConnectionsV4; + UINT32 outboundBlockedConnectionsV4; + UINT32 inboundAllowedConnectionsV6; + UINT32 inboundBlockedConnectionsV6; + UINT32 outboundAllowedConnectionsV6; + UINT32 outboundBlockedConnectionsV6; + UINT32 inboundActiveConnectionsV4; + UINT32 outboundActiveConnectionsV4; + UINT32 inboundActiveConnectionsV6; + UINT32 outboundActiveConnectionsV6; + UINT64 reauthDirInbound; + UINT64 reauthDirOutbound; + UINT64 reauthFamilyV4; + UINT64 reauthFamilyV6; + UINT64 reauthProtoOther; + UINT64 reauthProtoIPv4; + UINT64 reauthProtoIPv6; + UINT64 reauthProtoICMP; + UINT64 reauthProtoICMP6; + UINT64 reauthProtoUDP; + UINT64 reauthProtoTCP; + UINT64 reauthReasonPolicyChange; + UINT64 reauthReasonNewArrivalInterface; + UINT64 reauthReasonNewNextHopInterface; + UINT64 reauthReasonProfileCrossing; + UINT64 reauthReasonClassifyCompletion; + UINT64 reauthReasonIPSecPropertiesChanged; + UINT64 reauthReasonMidStreamInspection; + UINT64 reauthReasonSocketPropertyChanged; + UINT64 reauthReasonNewInboundMCastBCastPacket; + UINT64 reauthReasonEDPPolicyChanged; + UINT64 reauthReasonProxyHandleChanged; + } FWPM_STATISTICS1; + +#define FWPM_NET_EVENT_FLAG_IP_PROTOCOL_SET (0x00000001) +#define FWPM_NET_EVENT_FLAG_LOCAL_ADDR_SET (0x00000002) +#define FWPM_NET_EVENT_FLAG_REMOTE_ADDR_SET (0x00000004) +#define FWPM_NET_EVENT_FLAG_LOCAL_PORT_SET (0x00000008) +#define FWPM_NET_EVENT_FLAG_REMOTE_PORT_SET (0x00000010) +#define FWPM_NET_EVENT_FLAG_APP_ID_SET (0x00000020) +#define FWPM_NET_EVENT_FLAG_USER_ID_SET (0x00000040) +#define FWPM_NET_EVENT_FLAG_SCOPE_ID_SET (0x00000080) +#define FWPM_NET_EVENT_FLAG_IP_VERSION_SET (0x00000100) +#define FWPM_NET_EVENT_FLAG_REAUTH_REASON_SET (0x00000200) +#define FWPM_NET_EVENT_FLAG_PACKAGE_ID_SET (0x00000400) +#define FWPM_NET_EVENT_FLAG_ENTERPRISE_ID_SET (0x00000800) +#define FWPM_NET_EVENT_FLAG_POLICY_FLAGS_SET (0x00001000) +#define FWPM_NET_EVENT_FLAG_EFFECTIVE_NAME_SET (0x00002000) +typedef struct FWPM_NET_EVENT_HEADER0_ + { + FILETIME timeStamp; + UINT32 flags; + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 localAddrV6; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 remoteAddrV6; + } ; + UINT16 localPort; + UINT16 remotePort; + UINT32 scopeId; + FWP_BYTE_BLOB appId; + /* [unique] */ SID *userId; + } FWPM_NET_EVENT_HEADER0; + +typedef struct FWPM_NET_EVENT_HEADER1_ + { + FILETIME timeStamp; + UINT32 flags; + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 localAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 remoteAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + UINT16 localPort; + UINT16 remotePort; + UINT32 scopeId; + FWP_BYTE_BLOB appId; + /* [unique] */ SID *userId; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + FWP_AF reserved1; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + FWP_BYTE_ARRAY6 reserved2; + FWP_BYTE_ARRAY6 reserved3; + UINT32 reserved4; + UINT32 reserved5; + UINT16 reserved6; + UINT32 reserved7; + UINT32 reserved8; + UINT16 reserved9; + UINT64 reserved10; + } ; + } ; + } ; + /* [case()] */ /* Empty union arm */ + } ; + } FWPM_NET_EVENT_HEADER1; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_NET_EVENT_HEADER2_ + { + FILETIME timeStamp; + UINT32 flags; + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 localAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 remoteAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + UINT16 localPort; + UINT16 remotePort; + UINT32 scopeId; + FWP_BYTE_BLOB appId; + /* [unique] */ SID *userId; + FWP_AF addressFamily; + /* [unique] */ SID *packageSid; + } FWPM_NET_EVENT_HEADER2; + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +typedef struct FWPM_NET_EVENT_HEADER3_ + { + FILETIME timeStamp; + UINT32 flags; + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 localAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteAddrV4; + /* [case()] */ FWP_BYTE_ARRAY16 remoteAddrV6; + /* [case()] */ /* Empty union arm */ + } ; + UINT16 localPort; + UINT16 remotePort; + UINT32 scopeId; + FWP_BYTE_BLOB appId; + /* [unique] */ SID *userId; + FWP_AF addressFamily; + /* [unique] */ SID *packageSid; + /* [unique][string] */ wchar_t *enterpriseId; + UINT64 policyFlags; + FWP_BYTE_BLOB effectiveName; + } FWPM_NET_EVENT_HEADER3; + +#endif //(NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +typedef /* [v1_enum] */ +enum FWPM_NET_EVENT_TYPE_ + { + FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE = 0, + FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE = ( FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE + 1 ) , + FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE = ( FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE + 1 ) , + FWPM_NET_EVENT_TYPE_CLASSIFY_DROP = ( FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE + 1 ) , + FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP = ( FWPM_NET_EVENT_TYPE_CLASSIFY_DROP + 1 ) , + FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP = ( FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP + 1 ) , + FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW = ( FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP + 1 ) , + FWPM_NET_EVENT_TYPE_CAPABILITY_DROP = ( FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW + 1 ) , + FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW = ( FWPM_NET_EVENT_TYPE_CAPABILITY_DROP + 1 ) , + FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC = ( FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW + 1 ) , + FWPM_NET_EVENT_TYPE_LPM_PACKET_ARRIVAL = ( FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC + 1 ) , + FWPM_NET_EVENT_TYPE_MAX = ( FWPM_NET_EVENT_TYPE_LPM_PACKET_ARRIVAL + 1 ) + } FWPM_NET_EVENT_TYPE; + +#define IKEEXT_CERT_HASH_LEN 20 +#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE_FLAG_BENIGN (0x00000001) +#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE_FLAG_MULTIPLE (0x00000002) +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE0_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + UINT32 flags; + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + IKEEXT_MM_SA_STATE mmState; + IKEEXT_SA_ROLE saRole; + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + UINT8 endCertHash[ 20 ]; + UINT64 mmId; + UINT64 mmFilterId; + } FWPM_NET_EVENT_IKEEXT_MM_FAILURE0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE1_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + UINT32 flags; + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + IKEEXT_MM_SA_STATE mmState; + IKEEXT_SA_ROLE saRole; + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + UINT8 endCertHash[ 20 ]; + UINT64 mmId; + UINT64 mmFilterId; + /* [ref][string] */ wchar_t *localPrincipalNameForAuth; + /* [ref][string] */ wchar_t *remotePrincipalNameForAuth; + UINT32 numLocalPrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *localPrincipalGroupSids; + UINT32 numRemotePrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *remotePrincipalGroupSids; + } FWPM_NET_EVENT_IKEEXT_MM_FAILURE1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE2_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + UINT32 flags; + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + IKEEXT_MM_SA_STATE mmState; + IKEEXT_SA_ROLE saRole; + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + UINT8 endCertHash[ 20 ]; + UINT64 mmId; + UINT64 mmFilterId; + /* [ref][string] */ wchar_t *localPrincipalNameForAuth; + /* [ref][string] */ wchar_t *remotePrincipalNameForAuth; + UINT32 numLocalPrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *localPrincipalGroupSids; + UINT32 numRemotePrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *remotePrincipalGroupSids; + GUID *providerContextKey; + } FWPM_NET_EVENT_IKEEXT_MM_FAILURE2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4) +typedef struct FWPM_NET_EVENT_IKEEXT_QM_FAILURE0_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + IKEEXT_QM_SA_STATE qmState; + IKEEXT_SA_ROLE saRole; + IPSEC_TRAFFIC_TYPE saTrafficType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ FWP_CONDITION_VALUE0 localSubNet; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ FWP_CONDITION_VALUE0 remoteSubNet; + } ; + UINT64 qmFilterId; + } FWPM_NET_EVENT_IKEEXT_QM_FAILURE0; + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +typedef struct FWPM_NET_EVENT_IKEEXT_QM_FAILURE1_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + IKEEXT_QM_SA_STATE qmState; + IKEEXT_SA_ROLE saRole; + IPSEC_TRAFFIC_TYPE saTrafficType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ FWP_CONDITION_VALUE0 localSubNet; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ FWP_CONDITION_VALUE0 remoteSubNet; + } ; + UINT64 qmFilterId; + UINT64 mmSaLuid; + GUID mmProviderContextKey; + } FWPM_NET_EVENT_IKEEXT_QM_FAILURE1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE_FLAG_MULTIPLE (0x00000001) +#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE_FLAG_BENIGN (0x00000002) +typedef struct FWPM_NET_EVENT_IKEEXT_EM_FAILURE0_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + UINT32 flags; + IKEEXT_EM_SA_STATE emState; + IKEEXT_SA_ROLE saRole; + IKEEXT_AUTHENTICATION_METHOD_TYPE emAuthMethod; + UINT8 endCertHash[ 20 ]; + UINT64 mmId; + UINT64 qmFilterId; + } FWPM_NET_EVENT_IKEEXT_EM_FAILURE0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_NET_EVENT_IKEEXT_EM_FAILURE1_ + { + UINT32 failureErrorCode; + IPSEC_FAILURE_POINT failurePoint; + UINT32 flags; + IKEEXT_EM_SA_STATE emState; + IKEEXT_SA_ROLE saRole; + IKEEXT_AUTHENTICATION_METHOD_TYPE emAuthMethod; + UINT8 endCertHash[ 20 ]; + UINT64 mmId; + UINT64 qmFilterId; + /* [ref][string] */ wchar_t *localPrincipalNameForAuth; + /* [ref][string] */ wchar_t *remotePrincipalNameForAuth; + UINT32 numLocalPrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *localPrincipalGroupSids; + UINT32 numRemotePrincipalGroupSids; + /* [unique][string][size_is] */ LPWSTR *remotePrincipalGroupSids; + IPSEC_TRAFFIC_TYPE saTrafficType; + } FWPM_NET_EVENT_IKEEXT_EM_FAILURE1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP0_ + { + UINT64 filterId; + UINT16 layerId; + } FWPM_NET_EVENT_CLASSIFY_DROP0; + +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP1_ + { + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + } FWPM_NET_EVENT_CLASSIFY_DROP1; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP2_ + { + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + FWP_BYTE_BLOB vSwitchId; + UINT32 vSwitchSourcePort; + UINT32 vSwitchDestinationPort; + } FWPM_NET_EVENT_CLASSIFY_DROP2; + +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP_MAC0_ + { + FWP_BYTE_ARRAY6 localMacAddr; + FWP_BYTE_ARRAY6 remoteMacAddr; + UINT32 mediaType; + UINT32 ifType; + UINT16 etherType; + UINT32 ndisPortNumber; + UINT32 reserved; + UINT16 vlanTag; + UINT64 ifLuid; + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + FWP_BYTE_BLOB vSwitchId; + UINT32 vSwitchSourcePort; + UINT32 vSwitchDestinationPort; + } FWPM_NET_EVENT_CLASSIFY_DROP_MAC0; + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_NET_EVENT_CLASSIFY_ALLOW0 + { + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + } FWPM_NET_EVENT_CLASSIFY_ALLOW0; + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_NET_EVENT_IPSEC_KERNEL_DROP0_ + { + INT32 failureStatus; + FWP_DIRECTION direction; + IPSEC_SA_SPI spi; + UINT64 filterId; + UINT16 layerId; + } FWPM_NET_EVENT_IPSEC_KERNEL_DROP0; + +typedef struct FWPM_NET_EVENT_IPSEC_DOSP_DROP0_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 publicHostV4Addr; + /* [case()] */ UINT8 publicHostV6Addr[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 internalHostV4Addr; + /* [case()] */ UINT8 internalHostV6Addr[ 16 ]; + } ; + INT32 failureStatus; + FWP_DIRECTION direction; + } FWPM_NET_EVENT_IPSEC_DOSP_DROP0; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef +enum FWPM_APPC_NETWORK_CAPABILITY_TYPE_ + { + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT = 0, + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT_SERVER = ( FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT + 1 ) , + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_PRIVATE_NETWORK = ( FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT_SERVER + 1 ) + } FWPM_APPC_NETWORK_CAPABILITY_TYPE; + +typedef struct FWPM_NET_EVENT_CAPABILITY_DROP0_ + { + FWPM_APPC_NETWORK_CAPABILITY_TYPE networkCapabilityId; + UINT64 filterId; + BOOL isLoopback; + } FWPM_NET_EVENT_CAPABILITY_DROP0; + +typedef struct FWPM_NET_EVENT_CAPABILITY_ALLOW0_ + { + FWPM_APPC_NETWORK_CAPABILITY_TYPE networkCapabilityId; + UINT64 filterId; + BOOL isLoopback; + } FWPM_NET_EVENT_CAPABILITY_ALLOW0; + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0_ + { + IPSEC_SA_SPI spi; + } FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0; + +#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct FWPM_NET_EVENT0_ + { + FWPM_NET_EVENT_HEADER0 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE0 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE0 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE0 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP0 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + } ; + } FWPM_NET_EVENT0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_NET_EVENT1_ + { + FWPM_NET_EVENT_HEADER1 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE1 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE0 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP1 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + } ; + } FWPM_NET_EVENT1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_NET_EVENT2_ + { + FWPM_NET_EVENT_HEADER2 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE1 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE0 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP2 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_ALLOW0 *classifyAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_DROP0 *capabilityDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_ALLOW0 *capabilityAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP_MAC0 *classifyDropMac; + } ; + } FWPM_NET_EVENT2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +typedef struct FWPM_NET_EVENT3_ + { + FWPM_NET_EVENT_HEADER3 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE1 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE0 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP2 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_ALLOW0 *classifyAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_DROP0 *capabilityDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_ALLOW0 *capabilityAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP_MAC0 *classifyDropMac; + } ; + } FWPM_NET_EVENT3; + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +typedef struct FWPM_NET_EVENT4_ + { + FWPM_NET_EVENT_HEADER3 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE2 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE1 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP2 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_ALLOW0 *classifyAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_DROP0 *capabilityDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_ALLOW0 *capabilityAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP_MAC0 *classifyDropMac; + } ; + } FWPM_NET_EVENT4; + +#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS4) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct FWPM_NET_EVENT5_ + { + FWPM_NET_EVENT_HEADER3 header; + FWPM_NET_EVENT_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_MM_FAILURE2 *ikeMmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_QM_FAILURE1 *ikeQmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 *ikeEmFailure; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP2 *classifyDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 *ipsecDrop; + /* [case()][unique] */ FWPM_NET_EVENT_IPSEC_DOSP_DROP0 *idpDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_ALLOW0 *classifyAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_DROP0 *capabilityDrop; + /* [case()][unique] */ FWPM_NET_EVENT_CAPABILITY_ALLOW0 *capabilityAllow; + /* [case()][unique] */ FWPM_NET_EVENT_CLASSIFY_DROP_MAC0 *classifyDropMac; + /* [case()][unique] */ FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0 *lpmPacketArrival; + } ; + } FWPM_NET_EVENT5; + +#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct FWPM_NET_EVENT_ENUM_TEMPLATE0_ + { + FILETIME startTime; + FILETIME endTime; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPM_FILTER_CONDITION0 *filterCondition; + } FWPM_NET_EVENT_ENUM_TEMPLATE0; + +typedef struct FWPM_NET_EVENT_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_NET_EVENT_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_NET_EVENT_SUBSCRIPTION0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef /* [v1_enum] */ +enum FWPM_SYSTEM_PORT_TYPE_ + { + FWPM_SYSTEM_PORT_RPC_EPMAP = 0, + FWPM_SYSTEM_PORT_TEREDO = ( FWPM_SYSTEM_PORT_RPC_EPMAP + 1 ) , + FWPM_SYSTEM_PORT_IPHTTPS_IN = ( FWPM_SYSTEM_PORT_TEREDO + 1 ) , + FWPM_SYSTEM_PORT_IPHTTPS_OUT = ( FWPM_SYSTEM_PORT_IPHTTPS_IN + 1 ) , + FWPM_SYSTEM_PORT_TYPE_MAX = ( FWPM_SYSTEM_PORT_IPHTTPS_OUT + 1 ) + } FWPM_SYSTEM_PORT_TYPE; + +typedef struct FWPM_SYSTEM_PORTS_BY_TYPE0_ + { + FWPM_SYSTEM_PORT_TYPE type; + UINT32 numPorts; + /* [unique][size_is] */ UINT16 *ports; + } FWPM_SYSTEM_PORTS_BY_TYPE0; + +typedef struct FWPM_SYSTEM_PORTS0_ + { + UINT32 numTypes; + /* [unique][size_is] */ FWPM_SYSTEM_PORTS_BY_TYPE0 *types; + } FWPM_SYSTEM_PORTS0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_CONNECTION0_ + { + UINT64 connectionId; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + /* [unique] */ GUID *providerKey; + IPSEC_TRAFFIC_TYPE ipsecTrafficModeType; + IKEEXT_KEY_MODULE_TYPE keyModuleType; + IKEEXT_PROPOSAL0 mmCrypto; + IKEEXT_CREDENTIAL2 mmPeer; + IKEEXT_CREDENTIAL2 emPeer; + UINT64 bytesTransferredIn; + UINT64 bytesTransferredOut; + UINT64 bytesTransferredTotal; + FILETIME startSysTime; + } FWPM_CONNECTION0; + +#define FWPM_CONNECTION_ENUM_FLAG_QUERY_BYTES_TRANSFERRED (0x00000001) +typedef struct FWPM_CONNECTION_ENUM_TEMPLATE0_ + { + UINT64 connectionId; + UINT32 flags; + } FWPM_CONNECTION_ENUM_TEMPLATE0; + +typedef struct FWPM_CONNECTION_SUBSCRIPTION0_ + { + /* [unique] */ FWPM_CONNECTION_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } FWPM_CONNECTION_SUBSCRIPTION0; + +typedef /* [v1_enum] */ +enum FWPM_CONNECTION_EVENT_TYPE_ + { + FWPM_CONNECTION_EVENT_ADD = 0, + FWPM_CONNECTION_EVENT_DELETE = ( FWPM_CONNECTION_EVENT_ADD + 1 ) , + FWPM_CONNECTION_EVENT_MAX = ( FWPM_CONNECTION_EVENT_DELETE + 1 ) + } FWPM_CONNECTION_EVENT_TYPE; + +typedef /* [v1_enum] */ +enum FWPM_VSWITCH_EVENT_TYPE_ + { + FWPM_VSWITCH_EVENT_FILTER_ADD_TO_INCOMPLETE_LAYER = 0, + FWPM_VSWITCH_EVENT_FILTER_ENGINE_NOT_IN_REQUIRED_POSITION = ( FWPM_VSWITCH_EVENT_FILTER_ADD_TO_INCOMPLETE_LAYER + 1 ) , + FWPM_VSWITCH_EVENT_ENABLED_FOR_INSPECTION = ( FWPM_VSWITCH_EVENT_FILTER_ENGINE_NOT_IN_REQUIRED_POSITION + 1 ) , + FWPM_VSWITCH_EVENT_DISABLED_FOR_INSPECTION = ( FWPM_VSWITCH_EVENT_ENABLED_FOR_INSPECTION + 1 ) , + FWPM_VSWITCH_EVENT_FILTER_ENGINE_REORDER = ( FWPM_VSWITCH_EVENT_DISABLED_FOR_INSPECTION + 1 ) , + FWPM_VSWITCH_EVENT_MAX = ( FWPM_VSWITCH_EVENT_FILTER_ENGINE_REORDER + 1 ) + } FWPM_VSWITCH_EVENT_TYPE; + +typedef struct FWPM_VSWITCH_EVENT0_ + { + FWPM_VSWITCH_EVENT_TYPE eventType; + /* [unique][string] */ wchar_t *vSwitchId; + /* [switch_type][switch_is] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ struct + { + ULONG numvSwitchFilterExtensions; + /* [ref][string][size_is] */ LPWSTR *vSwitchFilterExtensions; + } positionInfo; + /* [case()] */ struct + { + BOOL inRequiredPosition; + ULONG numvSwitchFilterExtensions; + /* [unique][string][size_is] */ LPWSTR *vSwitchFilterExtensions; + } reorderInfo; + } ; + } FWPM_VSWITCH_EVENT0; + +typedef struct FWPM_VSWITCH_EVENT_SUBSCRIPTION0_ + { + UINT32 flags; + GUID sessionKey; + } FWPM_VSWITCH_EVENT_SUBSCRIPTION0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */ +#pragma endregion + + +extern RPC_IF_HANDLE __MIDL_itf_fwpmtypes_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_fwpmtypes_0000_0000_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.idl new file mode 100644 index 0000000000000000000000000000000000000000..b6c6d084a6ad92e4f100121e1fec5a63a72c440d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpmtypes.idl @@ -0,0 +1,2186 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Defines data types used by the management portion of the FWP API. +*/ +cpp_quote("#include ") + +#pragma region Desktop Family or AppRuntime Package +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME)") + +import "fwptypes.idl"; +import "iketypes.idl"; +import "ipsectypes.idl"; + + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(push)") +cpp_quote("#endif") +cpp_quote("#pragma warning(disable:4201)") +cpp_quote("#endif") + + +// +// Need a cleaner way to import DL_ADDRESS_TYPE into this space. +// + +cpp_quote("#ifndef _DEFINE_DL_ADDRESS_TYPE_") +cpp_quote("#define _DEFINE_DL_ADDRESS_TYPE_") +// +// DL_ADDRESS_TYPE +// +// Define datalink layer address types. +// + +typedef [v1_enum] enum { + DlUnicast, + DlMulticast, + DlBroadcast +} DL_ADDRESS_TYPE, *PDL_ADDRESS_TYPE; + +cpp_quote("#endif") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Common data types. +// +/////////////////////////////////////////////////////////////////////////////// + + +// Used when dispatching change notifications to subscribers. +typedef [v1_enum] enum FWPM_CHANGE_TYPE_ +{ + FWPM_CHANGE_ADD = 1, + FWPM_CHANGE_DELETE, + FWPM_CHANGE_TYPE_MAX +} FWPM_CHANGE_TYPE; + +// Flags used to indicate which notifications a subscriber wishes to receive. +cpp_quote("#define FWPM_SUBSCRIPTION_FLAG_NOTIFY_ON_ADD (0x00000001)") +cpp_quote("#define FWPM_SUBSCRIPTION_FLAG_NOTIFY_ON_DELETE (0x00000002)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing the engine. +// +/////////////////////////////////////////////////////////////////////////////// + +// Service state. +typedef enum FWPM_SERVICE_STATE_ +{ + FWPM_SERVICE_STOPPED, + FWPM_SERVICE_START_PENDING, + FWPM_SERVICE_STOP_PENDING, + FWPM_SERVICE_RUNNING, + FWPM_SERVICE_STATE_MAX +} FWPM_SERVICE_STATE; + +// Keywords used for finer control of net event collection. +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST (0x00000001)") +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST (0x00000002)") +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_CAPABILITY_DROP (0x00000004)") +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_CAPABILITY_ALLOW (0x00000008)") +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_CLASSIFY_ALLOW (0x00000010)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_19H1)") +cpp_quote("#define FWPM_NET_EVENT_KEYWORD_PORT_SCANNING_DROP (0x00000020)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1)") + +cpp_quote("#define FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE (0x00000000)") +cpp_quote("#define FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND (0x00000001)") +cpp_quote("#define FWPM_ENGINE_OPTION_PACKET_QUEUE_FORWARD (0x00000002)") +cpp_quote("#define FWPM_ENGINE_OPTION_PACKET_BATCH_INBOUND (0x00000004)") + + +// Configurable options for the filter engine. +typedef enum FWPM_ENGINE_OPTION_ +{ + // FWP_UINT32 - if non-zero, FWPM_NET_EVENT0s will be collected. + FWPM_ENGINE_COLLECT_NET_EVENTS, + // FWP_UINT32 - enables collection of FWPM_NET_EVENT0s with any of the given + // keywords. + FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS, + // FWP_UINT32 - enables name caching + FWPM_ENGINE_NAME_CACHE, + // FWP_UINT32 - if non-zero ipsec connections are tracked Returns enabled if + // the operational log is enabled. + FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS, + // FWP_UINT32 - flags + FWPM_ENGINE_PACKET_QUEUING, + // FWP_UINT32 - transactions lasting longer than this time will trigger a + // watchdog event + FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC, + // Not a valid option -- used for parameter validation only. + FWPM_ENGINE_OPTION_MAX +} FWPM_ENGINE_OPTION; + +// When this flag is set, any objects added during the session are +// automatically deleted when the session ends. +cpp_quote("#define FWPM_SESSION_FLAG_DYNAMIC (0x00000001)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Reserved for system use +cpp_quote("#define FWPM_SESSION_FLAG_RESERVED (0x10000000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Stores the state associated with a client session. +typedef struct FWPM_SESSION0_ +{ + // Information supplied when creating a session. + + // Uniquely identifies the session. If the GUID is zero-initialized in the + // call to Add, BFE will generate one. + GUID sessionKey; + // Allows sessions to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Time in msec that client will wait to begin a transaction. If zero, a + // default timeout will be used. + UINT32 txnWaitTimeoutInMSec; + + // Additional information returned when getting/enumerating sessions. + + // Process ID of the client. + DWORD processId; + // SID of the client. + [unique] SID* sid; + // Username of the client. + [string, unique] wchar_t* username; + // TRUE if this is a kernel-mode client. + BOOL kernelMode; +} FWPM_SESSION0; + +// Used for enumerating sessions. Currently, there is no way to limit the +// enumeration -- all sessions are returned. +typedef struct FWPM_SESSION_ENUM_TEMPLATE0_ +{ + // Reserved for system use. + UINT64 reserved; +} FWPM_SESSION_ENUM_TEMPLATE0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing providers. +// +/////////////////////////////////////////////////////////////////////////////// + +// Object is persistent, i.e., it survives across BFE stop/start. +cpp_quote("#define FWPM_PROVIDER_FLAG_PERSISTENT (0x00000001)") +// Provider's filters were disabled at BFE start because the associated Windows +// service wasn't set to auto start. This flag is ignored when adding new +// providers. +cpp_quote("#define FWPM_PROVIDER_FLAG_DISABLED (0x00000010)") + +// Stores the state associated with a policy provider. +typedef struct FWPM_PROVIDER0_ +{ + // Uniquely identifies the provider. If the GUID is zero-initialized in the + // call to Add, BFE will generate one. + GUID providerKey; + // Allows providers to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Optional name of the Windows service hosting the provider. This allows + // BFE to detect that a provider has been disabled. + [string, unique] wchar_t* serviceName; +} FWPM_PROVIDER0; + +// Used for enumerating providers. Currently, there is no way to limit the +// enumeration -- all providers are returned. +typedef struct FWPM_PROVIDER_ENUM_TEMPLATE0_ +{ + // Reserved for system use. + UINT64 reserved; +} FWPM_PROVIDER_ENUM_TEMPLATE0; + +// Change notification dispatched to subscribers. +typedef struct FWPM_PROVIDER_CHANGE0_ +{ + // Type of change. + FWPM_CHANGE_TYPE changeType; + // GUID of the provider that changed. + GUID providerKey; +} FWPM_PROVIDER_CHANGE0; + +// Used to subscribe for change notifications. +typedef struct FWPM_PROVIDER_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_PROVIDER_ENUM_TEMPLATE0* enumTemplate; + // Flags -- see FWPM_SUBSCRIPTION_FLAG_XXX above. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_PROVIDER_SUBSCRIPTION0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing provider contexts. +// +/////////////////////////////////////////////////////////////////////////////// + +// Object is persistent, i.e., it survives across BFE stop/start. +cpp_quote("#define FWPM_PROVIDER_CONTEXT_FLAG_PERSISTENT (0x00000001)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWPM_PROVIDER_CONTEXT_FLAG_DOWNLEVEL (0x00000002)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +typedef struct FWPM_CLASSIFY_OPTION0_ +{ + FWP_CLASSIFY_OPTION_TYPE type; + FWP_VALUE0 value; +} FWPM_CLASSIFY_OPTION0; + +typedef struct FWPM_CLASSIFY_OPTIONS0_ +{ + UINT32 numOptions; + [size_is(numOptions), ref] FWPM_CLASSIFY_OPTION0* options; +} FWPM_CLASSIFY_OPTIONS0; + +typedef struct FWPM_NETWORK_CONNECTION_POLICY_SETTING0_ +{ + FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE type; + FWP_VALUE0 value; +} FWPM_NETWORK_CONNECTION_POLICY_SETTING0; + +typedef struct FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0_ +{ + UINT32 numSettings; + [size_is(numSettings), ref] FWPM_NETWORK_CONNECTION_POLICY_SETTING0* settings; +} FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0; + +// Types of provider contexts that may be stored in BFE. +// FWPM_NETWORK_CONNECTION_POLICY_CONTEXT was added in NTDDI_WIN10_NI, but cpp_quote doesn't +// work in the middle of structs. +typedef [v1_enum] enum FWPM_PROVIDER_CONTEXT_TYPE_ +{ + FWPM_IPSEC_KEYING_CONTEXT, + FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT, + FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT, + FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT, + FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT, + FWPM_IPSEC_IKE_MM_CONTEXT, + FWPM_IPSEC_AUTHIP_MM_CONTEXT, + FWPM_CLASSIFY_OPTIONS_CONTEXT, + FWPM_GENERAL_CONTEXT, + FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT, + FWPM_IPSEC_IKEV2_MM_CONTEXT, + FWPM_IPSEC_DOSP_CONTEXT, + FWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT, + FWPM_NETWORK_CONNECTION_POLICY_CONTEXT, + FWPM_PROVIDER_CONTEXT_TYPE_MAX +} FWPM_PROVIDER_CONTEXT_TYPE; + +// Stores the state associated with a provider context. +typedef struct FWPM_PROVIDER_CONTEXT0_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the provider context. If the GUID is zero-initialized + // in the call to Add, BFE will generate one. + GUID providerContextKey; + // Allows provider contexts to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Tagged union containing the provider-specific data. + FWPM_PROVIDER_CONTEXT_TYPE type; + [switch_type(FWPM_PROVIDER_CONTEXT_TYPE), switch_is(type)] + union + { + [case(FWPM_IPSEC_KEYING_CONTEXT)] + [unique] IPSEC_KEYING_POLICY0* keyingPolicy; + [case(FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY0* ikeQmTransportPolicy; + [case(FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY0* ikeQmTunnelPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY0* authipQmTransportPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY0* authipQmTunnelPolicy; + [case(FWPM_IPSEC_IKE_MM_CONTEXT)] + [unique] IKEEXT_POLICY0* ikeMmPolicy; + [case(FWPM_IPSEC_AUTHIP_MM_CONTEXT)] + [unique] IKEEXT_POLICY0* authIpMmPolicy; + [case(FWPM_GENERAL_CONTEXT)] + [unique] FWP_BYTE_BLOB* dataBuffer; + [case(FWPM_CLASSIFY_OPTIONS_CONTEXT)] + [unique] FWPM_CLASSIFY_OPTIONS0* classifyOptions; + [default]; + }; + // Additional information returned when getting/enumerating objects. + + // LUID identifying the context. This is the context value stored in the + // FWPS_FILTER for filters that reference a provider context. + UINT64 providerContextId; +} FWPM_PROVIDER_CONTEXT0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type that stores the state associated with a provider context. +typedef struct FWPM_PROVIDER_CONTEXT1_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the provider context. If the GUID is zero-initialized + // in the call to Add, BFE will generate one. + GUID providerContextKey; + // Allows provider contexts to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Tagged union containing the provider-specific data. + FWPM_PROVIDER_CONTEXT_TYPE type; + [switch_type(FWPM_PROVIDER_CONTEXT_TYPE), switch_is(type)] + union + { + [case(FWPM_IPSEC_KEYING_CONTEXT)] + [unique] IPSEC_KEYING_POLICY0* keyingPolicy; + [case(FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY1* ikeQmTransportPolicy; + [case(FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY1* ikeQmTunnelPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY1* authipQmTransportPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY1* authipQmTunnelPolicy; + [case(FWPM_IPSEC_IKE_MM_CONTEXT)] + [unique] IKEEXT_POLICY1* ikeMmPolicy; + [case(FWPM_IPSEC_AUTHIP_MM_CONTEXT)] + [unique] IKEEXT_POLICY1* authIpMmPolicy; + [case(FWPM_GENERAL_CONTEXT)] + [unique] FWP_BYTE_BLOB* dataBuffer; + [case(FWPM_CLASSIFY_OPTIONS_CONTEXT)] + [unique] FWPM_CLASSIFY_OPTIONS0* classifyOptions; + [case(FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY1* ikeV2QmTunnelPolicy; + [case(FWPM_IPSEC_IKEV2_MM_CONTEXT)] + [unique] IKEEXT_POLICY1* ikeV2MmPolicy; + [case(FWPM_IPSEC_DOSP_CONTEXT)] + [unique] IPSEC_DOSP_OPTIONS0* idpOptions; + }; + // Additional information returned when getting/enumerating objects. + + // LUID identifying the context. This is the context value stored in the + // FWPS_FILTER for filters that reference a provider context. + UINT64 providerContextId; +} FWPM_PROVIDER_CONTEXT1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-2 of type that stores the state associated with a provider context. +typedef struct FWPM_PROVIDER_CONTEXT2_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the provider context. If the GUID is zero-initialized + // in the call to Add, BFE will generate one. + GUID providerContextKey; + // Allows provider contexts to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Tagged union containing the provider-specific data. + FWPM_PROVIDER_CONTEXT_TYPE type; + [switch_type(FWPM_PROVIDER_CONTEXT_TYPE), switch_is(type)] + union + { + [case(FWPM_IPSEC_KEYING_CONTEXT)] + [unique] IPSEC_KEYING_POLICY1* keyingPolicy; + [case(FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* ikeQmTransportPolicy; + [case(FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY2* ikeQmTunnelPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* authipQmTransportPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY2* authipQmTunnelPolicy; + [case(FWPM_IPSEC_IKE_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* ikeMmPolicy; + [case(FWPM_IPSEC_AUTHIP_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* authIpMmPolicy; + [case(FWPM_GENERAL_CONTEXT)] + [unique] FWP_BYTE_BLOB* dataBuffer; + [case(FWPM_CLASSIFY_OPTIONS_CONTEXT)] + [unique] FWPM_CLASSIFY_OPTIONS0* classifyOptions; + [case(FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY2* ikeV2QmTunnelPolicy; + [case(FWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* ikeV2QmTransportPolicy; + [case(FWPM_IPSEC_IKEV2_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* ikeV2MmPolicy; + [case(FWPM_IPSEC_DOSP_CONTEXT)] + [unique] IPSEC_DOSP_OPTIONS0* idpOptions; + }; + // Additional information returned when getting/enumerating objects. + + // LUID identifying the context. This is the context value stored in the + // FWPS_FILTER for filters that reference a provider context. + UINT64 providerContextId; +} FWPM_PROVIDER_CONTEXT2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS3)") +// Version-3 of type that stores the state associated with a provider context. +typedef struct FWPM_PROVIDER_CONTEXT3_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the provider context. If the GUID is zero-initialized + // in the call to Add, BFE will generate one. + GUID providerContextKey; + // Allows provider contexts to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Tagged union containing the provider-specific data. + FWPM_PROVIDER_CONTEXT_TYPE type; + + [switch_type(FWPM_PROVIDER_CONTEXT_TYPE), switch_is(type)] + union + { + [case(FWPM_IPSEC_KEYING_CONTEXT)] + [unique] IPSEC_KEYING_POLICY1* keyingPolicy; + [case(FWPM_IPSEC_IKE_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* ikeQmTransportPolicy; + [case(FWPM_IPSEC_IKE_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY3* ikeQmTunnelPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* authipQmTransportPolicy; + [case(FWPM_IPSEC_AUTHIP_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY3* authipQmTunnelPolicy; + [case(FWPM_IPSEC_IKE_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* ikeMmPolicy; + [case(FWPM_IPSEC_AUTHIP_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* authIpMmPolicy; + [case(FWPM_GENERAL_CONTEXT)] + [unique] FWP_BYTE_BLOB* dataBuffer; + [case(FWPM_CLASSIFY_OPTIONS_CONTEXT)] + [unique] FWPM_CLASSIFY_OPTIONS0* classifyOptions; + [case(FWPM_IPSEC_IKEV2_QM_TUNNEL_CONTEXT)] + [unique] IPSEC_TUNNEL_POLICY3* ikeV2QmTunnelPolicy; + [case(FWPM_IPSEC_IKEV2_QM_TRANSPORT_CONTEXT)] + [unique] IPSEC_TRANSPORT_POLICY2* ikeV2QmTransportPolicy; + [case(FWPM_IPSEC_IKEV2_MM_CONTEXT)] + [unique] IKEEXT_POLICY2* ikeV2MmPolicy; + [case(FWPM_IPSEC_DOSP_CONTEXT)] + [unique] IPSEC_DOSP_OPTIONS0* idpOptions; + [case(FWPM_NETWORK_CONNECTION_POLICY_CONTEXT)] + [unique] FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0* networkConnectionPolicy; + }; + // Additional information returned when getting/enumerating objects. + + // LUID identifying the context. This is the context value stored in the + // FWPS_FILTER for filters that reference a provider context. + UINT64 providerContextId; +} FWPM_PROVIDER_CONTEXT3; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3)") + + +// Used for enumerating provider contexts. +typedef struct FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0_ +{ + // If non-null, only objects associated with the specified provider will be + // returned. + [unique] GUID* providerKey; + // Only return provider contexts of the specified type. + FWPM_PROVIDER_CONTEXT_TYPE providerContextType; +} FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0; + +// Change notification dispatched to subscribers. +typedef struct FWPM_PROVIDER_CONTEXT_CHANGE0_ +{ + // Type of change. + FWPM_CHANGE_TYPE changeType; + // GUID of the provider context that changed. + GUID providerContextKey; + // LUID of the provider context that changed. + UINT64 providerContextId; +} FWPM_PROVIDER_CONTEXT_CHANGE0; + +// Used to subscribe for change notifications. +typedef struct FWPM_PROVIDER_CONTEXT_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0* enumTemplate; + // Flags -- see FWPM_SUBSCRIPTION_FLAG_XXX above. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_PROVIDER_CONTEXT_SUBSCRIPTION0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing sublayers. +// +/////////////////////////////////////////////////////////////////////////////// + +// Object is persistent, i.e., it survives across BFE stop/start. +cpp_quote("#define FWPM_SUBLAYER_FLAG_PERSISTENT (0x00000001)") + +// Stores the state associated with a sublayer. +typedef struct FWPM_SUBLAYER0_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the sublayer. If the GUID is zero-initialized in the + // call to Add, BFE will generate one. + GUID subLayerKey; + // Allows sublayers to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Weight of the sublayer. Higher weighted sublayers are invoked first. + UINT16 weight; +} FWPM_SUBLAYER0; + +// Used for enumerating sublayers. +typedef struct FWPM_SUBLAYER_ENUM_TEMPLATE0_ +{ + // If non-null, only objects associated with the specified provider will be + // returned. + [unique] GUID* providerKey; +} FWPM_SUBLAYER_ENUM_TEMPLATE0; + +// Change notification dispatched to subscribers. +typedef struct FWPM_SUBLAYER_CHANGE0_ +{ + // Type of change. + FWPM_CHANGE_TYPE changeType; + // GUID of the sublayer that changed. + GUID subLayerKey; +} FWPM_SUBLAYER_CHANGE0; + +// Used to subscribe for change notifications. +typedef struct FWPM_SUBLAYER_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_SUBLAYER_ENUM_TEMPLATE0* enumTemplate; + // Flags -- see FWPM_SUBSCRIPTION_FLAG_XXX above. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_SUBLAYER_SUBSCRIPTION0; + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing layers. +// +/////////////////////////////////////////////////////////////////////////////// + +////////// +// Flags specifying layer characteristics. +////////// + +// The layer is classified in kernel-mode. +cpp_quote("#define FWPM_LAYER_FLAG_KERNEL (0x00000001)") +// The layer is built-in and can't be deleted. +cpp_quote("#define FWPM_LAYER_FLAG_BUILTIN (0x00000002)") +// The layer is optimized for classification as opposed to enumeration. +cpp_quote("#define FWPM_LAYER_FLAG_CLASSIFY_MOSTLY (0x00000004)") +// The layer is buffered. +cpp_quote("#define FWPM_LAYER_FLAG_BUFFERED (0x00000008)") + +// Provides additional information about how the field's data should be +// interpreted. +typedef [v1_enum] enum FWPM_FIELD_TYPE_ +{ + // Value contains plain old data. + FWPM_FIELD_RAW_DATA, + // Value contains an IP address. + FWPM_FIELD_IP_ADDRESS, + // Value contains flags. + FWPM_FIELD_FLAGS, + FWPM_FIELD_TYPE_MAX +} FWPM_FIELD_TYPE; + +// Schema information for a field. +typedef struct FWPM_FIELD0_ +{ + // Uniquely identifies the field. + [ref] GUID* fieldKey; + // Determines how dataType is interpreted. + FWPM_FIELD_TYPE type; + // Data type passed to classify. + FWP_DATA_TYPE dataType; +} FWPM_FIELD0; + +// Schema information for a layer. +typedef struct FWPM_LAYER0_ +{ + // Uniquely identifies the layer. + GUID layerKey; + // Allows layers to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Number of fields in the layer. + UINT32 numFields; + // Schema information for the layer's fields. + [size_is(numFields), ref] FWPM_FIELD0* field; + // Sub-layer used when a filter is added with a null sublayer. + GUID defaultSubLayerKey; + // LUID identifying the layer. + UINT16 layerId; +} FWPM_LAYER0; + +// Used for enumerating layers. Currently, there is no way to limit the +// enumeration -- all layers are returned. +typedef struct FWPM_LAYER_ENUM_TEMPLATE0_ +{ + // Reserved for system use. + UINT64 reserved; +} FWPM_LAYER_ENUM_TEMPLATE0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing callouts. +// +/////////////////////////////////////////////////////////////////////////////// + +// Object is persistent, i.e., it survives across BFE stop/start. +cpp_quote("#define FWPM_CALLOUT_FLAG_PERSISTENT (0x00010000)") +// The callout needs access to the provider context stored in the filter +// invoking the callout. If this flag is set, the provider context will be +// copied from the FWPM_FILTER to the FWPS_FILTER struct. +cpp_quote("#define FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT (0x00020000)") +// Callout is currently registered in kernel. This flag must not be set when +// adding new callouts. It is only used when querying the state of existing +// callouts. +cpp_quote("#define FWPM_CALLOUT_FLAG_REGISTERED (0x00040000)") + +// Stores the state associated with a callout. +typedef struct FWPM_CALLOUT0_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the session. If the GUID is zero-initialized in the + // call to Add, BFE will generate one. + GUID calloutKey; + // Allows callouts to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // Only filters in this layer are allowed to invoke the callout. + GUID applicableLayer; + + // Additional information returned when getting/enumerating objects. + + // LUID identifying the callout. This is the calloutId stored in the + // FWPS_ACTION0 for filters that invoke a callout. + UINT32 calloutId; +} FWPM_CALLOUT0; + +// Used for enumerating callouts. +typedef struct FWPM_CALLOUT_ENUM_TEMPLATE0_ +{ + // If non-null, only objects associated with the specified provider will be + // returned. + [unique] GUID* providerKey; + // Only return callouts from the specified layer. + GUID layerKey; +} FWPM_CALLOUT_ENUM_TEMPLATE0; + +// Change notification dispatched to subscribers. +typedef struct FWPM_CALLOUT_CHANGE0_ +{ + // Type of change. + FWPM_CHANGE_TYPE changeType; + // GUID of the callout that changed. + GUID calloutKey; + // LUID of the callout that changed. + UINT32 calloutId; +} FWPM_CALLOUT_CHANGE0; + +// Used to subscribe for change notifications. +typedef struct FWPM_CALLOUT_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_CALLOUT_ENUM_TEMPLATE0* enumTemplate; + // Flags -- see FWPM_SUBSCRIPTION_FLAG_XXX above. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_CALLOUT_SUBSCRIPTION0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for managing filters. +// +/////////////////////////////////////////////////////////////////////////////// + +// The macro is repeated here, so that MIDL has access. +#define FWP_ACTION_FLAG_CALLOUT (0x00004000) + +// Action taken if all the filter conditions are true. +typedef struct FWPM_ACTION0_ +{ + // Action type. + FWP_ACTION_TYPE type; + // If the action invokes a callout, calloutKey must contain the GUID for a + // valid callout in the layer. Otherwise, the filterType may contain an + // arbitrary GUID chosen by the policy provider. + [switch_is(type & FWP_ACTION_FLAG_CALLOUT)] + union + { + [case(0)] + GUID filterType; + [case(FWP_ACTION_FLAG_CALLOUT)] + GUID calloutKey; + }; + +} FWPM_ACTION0; + +// Expresses a filter condition that must be true for the action to be taken. +typedef struct FWPM_FILTER_CONDITION0_ +{ + // GUID of the field to be tested. + GUID fieldKey; + // Type of match to be performed. + FWP_MATCH_TYPE matchType; + // Value to match the field against. + FWP_CONDITION_VALUE0 conditionValue; +} FWPM_FILTER_CONDITION0; + +////////// +// Flags specificying filter characteristics. +////////// + +// Default. +cpp_quote("#define FWPM_FILTER_FLAG_NONE (0x00000000)") +// Filter is persistent, i.e., it survives across BFE stop/start. +cpp_quote("#define FWPM_FILTER_FLAG_PERSISTENT (0x00000001)") +// Filter is enforced at boot-time, even before BFE starts. +cpp_quote("#define FWPM_FILTER_FLAG_BOOTTIME (0x00000002)") +// The filter references a provider context. +cpp_quote("#define FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT (0x00000004)") +// Macro is also needed by MIDL. +#define FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT (0x00000004) +// Clear action right +cpp_quote("#define FWPM_FILTER_FLAG_CLEAR_ACTION_RIGHT (0x00000008)") +// If the callout isn't registered, the filter is treated as a permit filter. +// Only allowed if the action type is FWP_ACTION_CALLOUT_TERMINATING or +// FWP_ACTION_CALLOUT_UNKNOWN. +cpp_quote("#define FWPM_FILTER_FLAG_PERMIT_IF_CALLOUT_UNREGISTERED (0x00000010)") +// Persistent filter was disabled at BFE start because the associated Windows +// service wasn't set to auto start. +cpp_quote("#define FWPM_FILTER_FLAG_DISABLED (0x00000020)") +// BFE has indexed the filter for fast run-time lookup. +cpp_quote("#define FWPM_FILTER_FLAG_INDEXED (0x00000040)") +// The filter references a provider context for IPsec security realm Id +cpp_quote("#define FWPM_FILTER_FLAG_HAS_SECURITY_REALM_PROVIDER_CONTEXT (0x00000080)") +// The filter is exclusive to system OS only +cpp_quote("#define FWPM_FILTER_FLAG_SYSTEMOS_ONLY (0x00000100)") +// The filter is exclusive to Xbox game OS only +cpp_quote("#define FWPM_FILTER_FLAG_GAMEOS_ONLY (0x00000200)") +// The filter is in silent mode +cpp_quote("#define FWPM_FILTER_FLAG_SILENT_MODE (0x00000400)") +// (used for s2s IPsec tunnel policies) +// Do not initiate IPsec acquire, if packet matches a IPsec policy from a filter with this flag +cpp_quote("#define FWPM_FILTER_FLAG_IPSEC_NO_ACQUIRE_INITIATE (0x00000800)") +// The flag is reserved +cpp_quote("#define FWPM_FILTER_FLAG_RESERVED0 (0x00001000)") +// The flag is reserved +cpp_quote("#define FWPM_FILTER_FLAG_RESERVED1 (0x00002000)") +// The flag is reserved +cpp_quote("#define FWPM_FILTER_FLAG_RESERVED2 (0x00004000)") + + + + +// Stores the state associated with a filter. +typedef struct FWPM_FILTER0_ +{ + // Information supplied when adding objects. + + // Uniquely identifies the filter. If the GUID is zero-initialized in the + // call to Add, BFE will generate one. + GUID filterKey; + // Allows filters to be annotated in a human-readable form. + FWPM_DISPLAY_DATA0 displayData; + // Flags + UINT32 flags; + // Optional GUID of the policy provider that manages this object. + [unique] GUID* providerKey; + // Optional provider-specific data; allows providers to store additional + // context info with the object. + FWP_BYTE_BLOB providerData; + // GUID of the layer where the filter resides. + GUID layerKey; + // GUID of the sublayer where the filter resides. If this is set to + // IID_NULL, the filter is added to the default sublayer. + GUID subLayerKey; + // Weight of the filter. This must be either of type FWP_UINT64 or + // FWP_EMPTY. If empty, BFE will automatically assign a weight based on the + // filter conditions. + FWP_VALUE0 weight; + // Array of filter conditions. All must be true for the action to be + // performed. In other words, the conditions are AND'ed together. If no + // conditions are specified, the action is always performed. + UINT32 numFilterConditions; + [size_is(numFilterConditions), unique] + FWPM_FILTER_CONDITION0* filterCondition; + // Action performed if all the filter conditions are true. + FWPM_ACTION0 action; + // If FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT is not set, the rawContext is + // placed 'as is' in the context field of the corresonding FWPS_FILTER. + // Otherwise, the LUID of the provider context specified by the + // providerContextKey is used. + [switch_is(flags & FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT)] + union + { + [case(0)] + UINT64 rawContext; + [case(FWPM_FILTER_FLAG_HAS_PROVIDER_CONTEXT)] + GUID providerContextKey; + }; + // Reserved for system use. + [unique] GUID* reserved; + + // Additional information returned when getting/enumerating objects. + + // LUID identifying the filter. This is also the LUID of the corresponding + // FWPS_FILTER. + UINT64 filterId; + // Weight assigned to the FWPS_FILTER filter. + FWP_VALUE0 effectiveWeight; +} FWPM_FILTER0; + +// Used for enumerating filters. +typedef struct FWPM_FILTER_ENUM_TEMPLATE0_ +{ + // If non-null, only objects associated with the specified provider will be + // returned. + [unique] GUID* providerKey; + // Layer whose fields are to be enumerated. + GUID layerKey; + // Determines how the filter conditions are interpreted. + FWP_FILTER_ENUM_TYPE enumType; + // Flags + UINT32 flags; + // If non-null, only enumerate filters whose provider context matches the + // template. + [unique] FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0* providerContextTemplate; + // Number of filter conditions. If zero, then all filters match. + UINT32 numFilterConditions; + // Array of filter conditions. + [size_is(numFilterConditions), unique] + FWPM_FILTER_CONDITION0* filterCondition; + // Only filters whose action type contains at least one of the bits in + // actionMask will be returned. To ignore the filter's action type when + // enumerating, set this to 0xFFFFFFFF. To enumerate just callouts, set this + // to FWP_ACTION_FLAG_CALLOUT. + UINT32 actionMask; + // If non-null, only filters invoking the specified callout will be + // returned. If this field is non-null, FWP_ACTION_FLAG_CALLOUT must be set + // in the actionMask. + [unique] GUID* calloutKey; +} FWPM_FILTER_ENUM_TEMPLATE0; + +// Change notification dispatched to subscribers. +typedef struct FWPM_FILTER_CHANGE0_ +{ + // Type of change. + FWPM_CHANGE_TYPE changeType; + // GUID of the filter that changed. + GUID filterKey; + // LUID of the filter that changed. + UINT64 filterId; +} FWPM_FILTER_CHANGE0; + +// Used to subscribe for change notifications. +typedef struct FWPM_FILTER_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_FILTER_ENUM_TEMPLATE0* enumTemplate; + // Flags -- see FWPM_SUBSCRIPTION_FLAG_XXX above. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_FILTER_SUBSCRIPTION0; + + +typedef struct FWPM_LAYER_STATISTICS0_ +{ + // layerId for the statistics + GUID layerId; + // number of classifications that returned permit + UINT32 classifyPermitCount; + // number of classifications that returned block + UINT32 classifyBlockCount; + // number of classifications that returned block via veto + UINT32 classifyVetoCount; + // number of cache entries + UINT32 numCacheEntries; +} FWPM_LAYER_STATISTICS0; + +typedef struct FWPM_LAYER_STATISTICS1_ +{ + // layerId for the statistics + GUID layerId; + // number of classifications that returned permit + UINT32 classifyPermitCount; + // number of classifications that returned block + UINT32 classifyBlockCount; + // number of classifications that returned block via veto + UINT32 classifyVetoCount; + // number of cache entries + UINT32 numCacheEntries; + // number of filters + UINT32 filterCount; + // size of filters + UINT32 totalFilterSize; +} FWPM_LAYER_STATISTICS1; + +typedef struct FWPM_STATISTICS0_ +{ + UINT32 numLayerStatistics; + [size_is(numLayerStatistics), ref] FWPM_LAYER_STATISTICS0* layerStatistics; + UINT32 inboundAllowedConnectionsV4; + UINT32 inboundBlockedConnectionsV4; + UINT32 outboundAllowedConnectionsV4; + UINT32 outboundBlockedConnectionsV4; + UINT32 inboundAllowedConnectionsV6; + UINT32 inboundBlockedConnectionsV6; + UINT32 outboundAllowedConnectionsV6; + UINT32 outboundBlockedConnectionsV6; + UINT32 inboundActiveConnectionsV4; + UINT32 outboundActiveConnectionsV4; + UINT32 inboundActiveConnectionsV6; + UINT32 outboundActiveConnectionsV6; + UINT64 reauthDirInbound; + UINT64 reauthDirOutbound; + UINT64 reauthFamilyV4; + UINT64 reauthFamilyV6; + UINT64 reauthProtoOther; + UINT64 reauthProtoIPv4; + UINT64 reauthProtoIPv6; + UINT64 reauthProtoICMP; + UINT64 reauthProtoICMP6; + UINT64 reauthProtoUDP; + UINT64 reauthProtoTCP; + UINT64 reauthReasonPolicyChange; + UINT64 reauthReasonNewArrivalInterface; + UINT64 reauthReasonNewNextHopInterface; + UINT64 reauthReasonProfileCrossing; + UINT64 reauthReasonClassifyCompletion; + UINT64 reauthReasonIPSecPropertiesChanged; + UINT64 reauthReasonMidStreamInspection; + UINT64 reauthReasonSocketPropertyChanged; + UINT64 reauthReasonNewInboundMCastBCastPacket; + UINT64 reauthReasonEDPPolicyChanged; + UINT64 reauthReasonProxyHandleChanged; +} FWPM_STATISTICS0; + +typedef struct FWPM_STATISTICS1_ +{ + UINT32 numLayerStatistics; + [size_is(numLayerStatistics), ref] FWPM_LAYER_STATISTICS1* layerStatistics; + UINT32 inboundAllowedConnectionsV4; + UINT32 inboundBlockedConnectionsV4; + UINT32 outboundAllowedConnectionsV4; + UINT32 outboundBlockedConnectionsV4; + UINT32 inboundAllowedConnectionsV6; + UINT32 inboundBlockedConnectionsV6; + UINT32 outboundAllowedConnectionsV6; + UINT32 outboundBlockedConnectionsV6; + UINT32 inboundActiveConnectionsV4; + UINT32 outboundActiveConnectionsV4; + UINT32 inboundActiveConnectionsV6; + UINT32 outboundActiveConnectionsV6; + UINT64 reauthDirInbound; + UINT64 reauthDirOutbound; + UINT64 reauthFamilyV4; + UINT64 reauthFamilyV6; + UINT64 reauthProtoOther; + UINT64 reauthProtoIPv4; + UINT64 reauthProtoIPv6; + UINT64 reauthProtoICMP; + UINT64 reauthProtoICMP6; + UINT64 reauthProtoUDP; + UINT64 reauthProtoTCP; + UINT64 reauthReasonPolicyChange; + UINT64 reauthReasonNewArrivalInterface; + UINT64 reauthReasonNewNextHopInterface; + UINT64 reauthReasonProfileCrossing; + UINT64 reauthReasonClassifyCompletion; + UINT64 reauthReasonIPSecPropertiesChanged; + UINT64 reauthReasonMidStreamInspection; + UINT64 reauthReasonSocketPropertyChanged; + UINT64 reauthReasonNewInboundMCastBCastPacket; + UINT64 reauthReasonEDPPolicyChanged; + UINT64 reauthReasonProxyHandleChanged; +} FWPM_STATISTICS1; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for diagnostics. +// +/////////////////////////////////////////////////////////////////////////////// + +// Flags indicating which fields are set. +cpp_quote("#define FWPM_NET_EVENT_FLAG_IP_PROTOCOL_SET (0x00000001)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_LOCAL_ADDR_SET (0x00000002)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_REMOTE_ADDR_SET (0x00000004)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_LOCAL_PORT_SET (0x00000008)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_REMOTE_PORT_SET (0x00000010)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_APP_ID_SET (0x00000020)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_USER_ID_SET (0x00000040)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_SCOPE_ID_SET (0x00000080)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_IP_VERSION_SET (0x00000100)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_REAUTH_REASON_SET (0x00000200)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_PACKAGE_ID_SET (0x00000400)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_ENTERPRISE_ID_SET (0x00000800)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_POLICY_FLAGS_SET (0x00001000)") +cpp_quote("#define FWPM_NET_EVENT_FLAG_EFFECTIVE_NAME_SET (0x00002000)") + +// Fields common to all events. +typedef struct FWPM_NET_EVENT_HEADER0_ +{ + // Contains the time the event occurred, in 100-nanosecond intervals since + // midnight, January 1, 1601. Do not set this when firing events. It's only + // used when enum'ing events. + FILETIME timeStamp; + // Flags indicating which fields are set. Unused fields must be + // zero-initialized. + UINT32 flags; + // 5-tuple of the network traffic. + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 localAddrV6; + }; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 remoteAddrV6; + }; + UINT16 localPort; + UINT16 remotePort; + // IPv6 scope ID. + UINT32 scopeId; + // Local application and user corresponding to the traffic. + FWP_BYTE_BLOB appId; + [unique] SID* userId; +} FWPM_NET_EVENT_HEADER0; + +// The original comment above on the previous structure is overtaken by events. +// +// It's because the original structure doesn't cover all events that we're having +// to revise it. Ideally, instead of "ipVersion", we could have done the +// discrimination of types with an "address family" field instead, and that could +// include other addressing schemes such as Ethernet, 802.11, etc. +// +// Because new fields can only be added *at the end* of the structure, any new +// discriminator comes too late to usefully influence the serialization +// process... since you need to see the discriminator before you can see the fields +// that it discriminates. +// +typedef struct FWPM_NET_EVENT_HEADER1_ +{ + // Contains the time the event occurred, in 100-nanosecond intervals since + // midnight, January 1, 1601. Do not set this when firing events. It's only + // used when enum'ing events. + FILETIME timeStamp; + // Flags indicating which fields are set. Unused fields must be + // zero-initialized. + UINT32 flags; + // 5-tuple of the network traffic. + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 localAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 remoteAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + UINT16 localPort; + UINT16 remotePort; + // IPv6 scope ID. + UINT32 scopeId; + // Local application and user corresponding to the traffic. + FWP_BYTE_BLOB appId; + [unique] SID* userId; + // additional V1 stuff goes here... + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_NONE)] + struct + { + FWP_AF reserved1; + [switch_type(FWP_AF), switch_is(reserved1)] + union + { + [case(FWP_AF_ETHER)] + struct + { + FWP_BYTE_ARRAY6 reserved2; + FWP_BYTE_ARRAY6 reserved3; + UINT32 reserved4; + UINT32 reserved5; + UINT16 reserved6; + UINT32 reserved7; + UINT32 reserved8; + UINT16 reserved9; + UINT64 reserved10; + }; + }; + }; + [case(FWP_IP_VERSION_V4, FWP_IP_VERSION_V6)]; + }; +} FWPM_NET_EVENT_HEADER1; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +typedef struct FWPM_NET_EVENT_HEADER2_ +{ + // Contains the time the event occurred, in 100-nanosecond intervals since + // midnight, January 1, 1601. Do not set this when firing events. It's only + // used when enum'ing events. + FILETIME timeStamp; + // Flags indicating which fields are set. Unused fields must be + // zero-initialized. + UINT32 flags; + // 5-tuple of the network traffic. + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 localAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 remoteAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + UINT16 localPort; + UINT16 remotePort; + // IPv6 scope ID. + UINT32 scopeId; + // Local application and user corresponding to the traffic. + FWP_BYTE_BLOB appId; + [unique] SID* userId; + FWP_AF addressFamily; + [unique] SID* packageSid; +} FWPM_NET_EVENT_HEADER2; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") +typedef struct FWPM_NET_EVENT_HEADER3_ +{ + // Contains the time the event occurred, in 100-nanosecond intervals since + // midnight, January 1, 1601. Do not set this when firing events. It's only + // used when enum'ing events. + FILETIME timeStamp; + // Flags indicating which fields are set. Unused fields must be + // zero-initialized. + UINT32 flags; + // 5-tuple of the network traffic. + FWP_IP_VERSION ipVersion; + UINT8 ipProtocol; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 localAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteAddrV4; + [case(FWP_IP_VERSION_V6)] + FWP_BYTE_ARRAY16 remoteAddrV6; + [case(FWP_IP_VERSION_NONE)]; + }; + UINT16 localPort; + UINT16 remotePort; + // IPv6 scope ID. + UINT32 scopeId; + // Local application and user corresponding to the traffic. + FWP_BYTE_BLOB appId; + [unique] SID* userId; + FWP_AF addressFamily; + [unique] SID* packageSid; + [string, unique] wchar_t* enterpriseId; + UINT64 policyFlags; + FWP_BYTE_BLOB effectiveName; +} FWPM_NET_EVENT_HEADER3; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") + +// NOTE: If FWPM_NET_EVENT_TYPE is being updated, you MUST update FWPM_NET_EVENT_INTERNAL_TYPE in fwpptypes.idl +// so that the first part of the _INTERNAL_ struct exactly matches the current FWPM_NET_EVENT_TYPE +// +// Types of network events fired by WFP/IPsec. +typedef [v1_enum] enum FWPM_NET_EVENT_TYPE_ +{ + // An error occurred during IKE/AuthIP main-mode SA establishment. + FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE, + // An error occurred during IKE/AuthIP quick-mode SA establishment. + FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE, + // An error occurred during AuthIP extended-mode SA establishment. + FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE, + // Filter engine classify returned drop + FWPM_NET_EVENT_TYPE_CLASSIFY_DROP, + // IPsec kernel drop + FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP, + // IPsec DoS Protection drop + FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP, + // Filter engine classify allow + FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW, + // IPsec DoS Protection drop + FWPM_NET_EVENT_TYPE_CAPABILITY_DROP, + // IPsec DoS Protection drop + FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW, + // Filter engine classify at MAC related later returned drop + FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC, + //Low Power Mode Packet arrival event + FWPM_NET_EVENT_TYPE_LPM_PACKET_ARRIVAL, + // Not a valid event type -- used for parameter validation only. + FWPM_NET_EVENT_TYPE_MAX +} FWPM_NET_EVENT_TYPE; + +// Length in bytes of the SHA thumbprint of an IKE/Authip certificate +#define IKEEXT_CERT_HASH_LEN 20 +cpp_quote("#define IKEEXT_CERT_HASH_LEN 20") + +// Flag indicating that the IKE MM failure event is a benign/expected failure +cpp_quote("#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE_FLAG_BENIGN (0x00000001)") +// Flag indicating that multiple IKE MM failure events have been reported that +// should be correlated using the mmId field. +cpp_quote("#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE_FLAG_MULTIPLE (0x00000002)") + +// Event-specific data for FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE0_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // Flags for the failure event + UINT32 flags; + // IKE or Authip + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + // Main mode state + IKEEXT_MM_SA_STATE mmState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + // Hash (SHA thumbprint) of the end certificate corresponding to failures + // that happen during building or validating certificate chains. + UINT8 endCertHash[IKEEXT_CERT_HASH_LEN]; + // LUID for the MM SA + UINT64 mmId; + // Main mode filter ID + UINT64 mmFilterId; +} FWPM_NET_EVENT_IKEEXT_MM_FAILURE0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of event specific data for FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE1_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // Flags for the failure event + UINT32 flags; + // IKE or Authip + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + // Main mode state + IKEEXT_MM_SA_STATE mmState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + // Hash (SHA thumbprint) of the end certificate corresponding to failures + // that happen during building or validating certificate chains. + UINT8 endCertHash[IKEEXT_CERT_HASH_LEN]; + // LUID for the MM SA + UINT64 mmId; + // Main mode filter ID + UINT64 mmFilterId; + // Name of local security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* localPrincipalNameForAuth; + // Name of remote security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* remotePrincipalNameForAuth; + // Array of group SIDs corresponding to the local security principal that + // was authenticated, if available. + UINT32 numLocalPrincipalGroupSids; + [size_is(numLocalPrincipalGroupSids), string, unique] + LPWSTR* localPrincipalGroupSids; + // Array of group SIDs corresponding to the remote security principal that + // was authenticated, if available. + UINT32 numRemotePrincipalGroupSids; + [size_is(numRemotePrincipalGroupSids), string, unique] + LPWSTR* remotePrincipalGroupSids; +} FWPM_NET_EVENT_IKEEXT_MM_FAILURE1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS4)") +// Version-2 of event specific data for FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_MM_FAILURE2_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // Flags for the failure event + UINT32 flags; + // IKE or Authip + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + // Main mode state + IKEEXT_MM_SA_STATE mmState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE mmAuthMethod; + // Hash (SHA thumbprint) of the end certificate corresponding to failures + // that happen during building or validating certificate chains. + UINT8 endCertHash[IKEEXT_CERT_HASH_LEN]; + // LUID for the MM SA + UINT64 mmId; + // Main mode filter ID + UINT64 mmFilterId; + // Name of local security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* localPrincipalNameForAuth; + // Name of remote security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* remotePrincipalNameForAuth; + // Array of group SIDs corresponding to the local security principal that + // was authenticated, if available. + UINT32 numLocalPrincipalGroupSids; + [size_is(numLocalPrincipalGroupSids), string, unique] + LPWSTR* localPrincipalGroupSids; + // Array of group SIDs corresponding to the remote security principal that + // was authenticated, if available. + UINT32 numRemotePrincipalGroupSids; + [size_is(numRemotePrincipalGroupSids), string, unique] + LPWSTR* remotePrincipalGroupSids; + //Provider Context GUID + GUID *providerContextKey; +} FWPM_NET_EVENT_IKEEXT_MM_FAILURE2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4)") +// Event-specific data for FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_QM_FAILURE0_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // IKE or Authip + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + // Quick mode state + IKEEXT_QM_SA_STATE qmState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Tunnel or transport mode + IPSEC_TRAFFIC_TYPE saTrafficType; + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(saTrafficType)] + union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)]; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + // Must be of type FWP_V4_ADDR_MASK or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 localSubNet; + }; + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(saTrafficType)] + union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)]; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + // Must be of type FWP_V4_ADDR_MASK or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 remoteSubNet; + }; + // Quick mode filter ID + UINT64 qmFilterId; +} FWPM_NET_EVENT_IKEEXT_QM_FAILURE0; +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS4)") +// Version-1 Event-specific data for FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_QM_FAILURE1_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // IKE or Authip + IKEEXT_KEY_MODULE_TYPE keyingModuleType; + // Quick mode state + IKEEXT_QM_SA_STATE qmState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Tunnel or transport mode + IPSEC_TRAFFIC_TYPE saTrafficType; + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(saTrafficType)] + union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)]; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + // Must be of type FWP_V4_ADDR_MASK or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 localSubNet; + }; + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(saTrafficType)] + union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)]; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + // Must be of type FWP_V4_ADDR_MASK or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 remoteSubNet; + }; + // Quick mode filter ID + UINT64 qmFilterId; + UINT64 mmSaLuid; + GUID mmProviderContextKey; +} FWPM_NET_EVENT_IKEEXT_QM_FAILURE1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4)") +// Flag indicating that multiple IKE EM failure events have been reported that +// should be correlated using the mmId field. +cpp_quote("#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE_FLAG_MULTIPLE (0x00000001)") +// Flag indicating that the IKE EM failure event is a benign/expected failure +cpp_quote("#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE_FLAG_BENIGN (0x00000002)") + +// Event-specific data for FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_EM_FAILURE0_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // Flags for the failure event + UINT32 flags; + // Extended mode state + IKEEXT_EM_SA_STATE emState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE emAuthMethod; + // Hash (SHA thumbprint) of the end certificate corresponding to failures + // that happen during building or validating certificate chains. + UINT8 endCertHash[IKEEXT_CERT_HASH_LEN]; + // LUID for the MM SA corresponding to this EM failure + UINT64 mmId; + // Quick mode filter ID associated with this EM failure + UINT64 qmFilterId; +} FWPM_NET_EVENT_IKEEXT_EM_FAILURE0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of event specific data for FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE. +typedef struct FWPM_NET_EVENT_IKEEXT_EM_FAILURE1_ +{ + // Windows error code for the failure + UINT32 failureErrorCode; + // Point of failure + IPSEC_FAILURE_POINT failurePoint; + // Flags for the failure event + UINT32 flags; + // Extended mode state + IKEEXT_EM_SA_STATE emState; + // Initiator or Responder + IKEEXT_SA_ROLE saRole; + // Authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE emAuthMethod; + // Hash (SHA thumbprint) of the end certificate corresponding to failures + // that happen during building or validating certificate chains. + UINT8 endCertHash[IKEEXT_CERT_HASH_LEN]; + // LUID for the MM SA corresponding to this EM failure + UINT64 mmId; + // Quick mode filter ID associated with this EM failure + UINT64 qmFilterId; + // Name of local security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* localPrincipalNameForAuth; + // Name of remote security principal that was authenticated, if available. + // If not available, an empty string will be stored. + [string, ref] wchar_t* remotePrincipalNameForAuth; + // Array of group SIDs corresponding to the local security principal that + // was authenticated, if available. + UINT32 numLocalPrincipalGroupSids; + [size_is(numLocalPrincipalGroupSids), string, unique] + LPWSTR* localPrincipalGroupSids; + // Array of group SIDs corresponding to the remote security principal that + // was authenticated, if available. + UINT32 numRemotePrincipalGroupSids; + [size_is(numRemotePrincipalGroupSids), string, unique] + LPWSTR* remotePrincipalGroupSids; + // Tunnel or transport mode + IPSEC_TRAFFIC_TYPE saTrafficType; +} FWPM_NET_EVENT_IKEEXT_EM_FAILURE1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Event-specific data for FWP_NET_EVENT_TYPE_CLASSIFY_DROP. +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP0_ +{ + UINT64 filterId; + UINT16 layerId; +} FWPM_NET_EVENT_CLASSIFY_DROP0; + +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP1_ +{ + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; +} FWPM_NET_EVENT_CLASSIFY_DROP1; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP2_ +{ + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + FWP_BYTE_BLOB vSwitchId; + UINT32 vSwitchSourcePort; + UINT32 vSwitchDestinationPort; +} FWPM_NET_EVENT_CLASSIFY_DROP2; + +typedef struct FWPM_NET_EVENT_CLASSIFY_DROP_MAC0_ +{ + FWP_BYTE_ARRAY6 localMacAddr; + FWP_BYTE_ARRAY6 remoteMacAddr; + UINT32 mediaType; + UINT32 ifType; + UINT16 etherType; + UINT32 ndisPortNumber; + UINT32 reserved; + UINT16 vlanTag; + UINT64 ifLuid; + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; + FWP_BYTE_BLOB vSwitchId; + UINT32 vSwitchSourcePort; + UINT32 vSwitchDestinationPort; +} FWPM_NET_EVENT_CLASSIFY_DROP_MAC0; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN8)") + + +//Event-specific data for the classify allow +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +typedef struct FWPM_NET_EVENT_CLASSIFY_ALLOW0 +{ + UINT64 filterId; + UINT16 layerId; + UINT32 reauthReason; + UINT32 originalProfile; + UINT32 currentProfile; + UINT32 msFwpDirection; + BOOL isLoopback; +} FWPM_NET_EVENT_CLASSIFY_ALLOW0; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN8)") + +// Event-specific data for FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP. +typedef struct FWPM_NET_EVENT_IPSEC_KERNEL_DROP0_ +{ + // NTSTATUS error code for the failure + INT32 failureStatus; + // Is dropped packet inbound or outbound + FWP_DIRECTION direction; + // SPI on the IPSec (ESP/AH) header of the packet. Will be 0 for clear text + // packets. + IPSEC_SA_SPI spi; + // FilterId corresponding to the IPsec callout filter. This will be + // available only if the packet was dropped by the IPsec callout. + UINT64 filterId; + // LayerId corresponding to the IPsec callout filter. This will be available + // only if the packet was dropped by the IPsec callout. + UINT16 layerId; +} FWPM_NET_EVENT_IPSEC_KERNEL_DROP0; + + +// Event-specific data for FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP. +typedef struct FWPM_NET_EVENT_IPSEC_DOSP_DROP0_ +{ + // IP version + FWP_IP_VERSION ipVersion; + // IP address of the internet host + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 publicHostV4Addr; + [case(FWP_IP_VERSION_V6)] + UINT8 publicHostV6Addr[16]; + }; + // IP address of the corpnet host + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union + { + [case(FWP_IP_VERSION_V4)] + UINT32 internalHostV4Addr; + [case(FWP_IP_VERSION_V6)] + UINT8 internalHostV6Addr[16]; + }; + // NTSTATUS error code for the failure + INT32 failureStatus; + // Is dropped packet inbound or outbound + FWP_DIRECTION direction; +} FWPM_NET_EVENT_IPSEC_DOSP_DROP0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Event specific data for FWPM_NET_EVENT_TYPE_CAPABILITY_DROP +typedef enum FWPM_APPC_NETWORK_CAPABILITY_TYPE_ +{ + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT, + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_CLIENT_SERVER, + FWPM_APPC_NETWORK_CAPABILITY_INTERNET_PRIVATE_NETWORK, +} FWPM_APPC_NETWORK_CAPABILITY_TYPE; + +typedef struct FWPM_NET_EVENT_CAPABILITY_DROP0_ +{ + FWPM_APPC_NETWORK_CAPABILITY_TYPE networkCapabilityId; + UINT64 filterId; + BOOL isLoopback; +} FWPM_NET_EVENT_CAPABILITY_DROP0; + +typedef struct FWPM_NET_EVENT_CAPABILITY_ALLOW0_ +{ + FWPM_APPC_NETWORK_CAPABILITY_TYPE networkCapabilityId; + UINT64 filterId; + BOOL isLoopback; +} FWPM_NET_EVENT_CAPABILITY_ALLOW0; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS5)") // NTDDI_WIN10_RS5 +typedef struct FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0_ +{ + IPSEC_SA_SPI spi; +} FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS5)") // NTDDI_WIN10_RS5 + +// Consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT0_ +{ + // Common data. + FWPM_NET_EVENT_HEADER0 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE0* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE0* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE0* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP0* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + }; +} FWPM_NET_EVENT0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT1_ +{ + // Common data. + FWPM_NET_EVENT_HEADER1 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE1* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE0* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE1* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP1* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + }; +} FWPM_NET_EVENT1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-1 of consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT2_ +{ + // Common data. + FWPM_NET_EVENT_HEADER2 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE1* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE0* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE1* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP2* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW)] + [unique] FWPM_NET_EVENT_CLASSIFY_ALLOW0* classifyAllow; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_DROP)] + [unique] FWPM_NET_EVENT_CAPABILITY_DROP0* capabilityDrop; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW)] + [unique] FWPM_NET_EVENT_CAPABILITY_ALLOW0* capabilityAllow; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP_MAC0* classifyDropMac; + }; +} FWPM_NET_EVENT2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") +// Version-3 of consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT3_ +{ + // Common data. + FWPM_NET_EVENT_HEADER3 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE1* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE0* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE1* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP2* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW)] + [unique] FWPM_NET_EVENT_CLASSIFY_ALLOW0* classifyAllow; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_DROP)] + [unique] FWPM_NET_EVENT_CAPABILITY_DROP0* capabilityDrop; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW)] + [unique] FWPM_NET_EVENT_CAPABILITY_ALLOW0* capabilityAllow; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP_MAC0* classifyDropMac; + }; +} FWPM_NET_EVENT3; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS4)") +// Version-4 of consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT4_ +{ + // Common data. + FWPM_NET_EVENT_HEADER3 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE2* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE1* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE1* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP2* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW)] + [unique] FWPM_NET_EVENT_CLASSIFY_ALLOW0* classifyAllow; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_DROP)] + [unique] FWPM_NET_EVENT_CAPABILITY_DROP0* capabilityDrop; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW)] + [unique] FWPM_NET_EVENT_CAPABILITY_ALLOW0* capabilityAllow; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP_MAC0* classifyDropMac; + }; +} FWPM_NET_EVENT4; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS4)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS5)") //NTDDI_WIN10_RS5 +// NOTE: If FWPM_NET_EVENT is being updated, you MUST update FWPM_NET_EVENT_INTERNAL in fwpptypes.idl +// so that the first part of the _INTERNAL struct exactly matches the current FWPM_NET_EVENT +// Version-4 of consolidated event struct for all event types. +typedef struct FWPM_NET_EVENT5_ +{ + // Common data. + FWPM_NET_EVENT_HEADER3 header; + // Type of event. + FWPM_NET_EVENT_TYPE type; + // Event-specific data. + [switch_type(FWPM_NET_EVENT_TYPE), switch_is(type)] + union + { + [case(FWPM_NET_EVENT_TYPE_IKEEXT_MM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_MM_FAILURE2* ikeMmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_QM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_QM_FAILURE1* ikeQmFailure; + [case(FWPM_NET_EVENT_TYPE_IKEEXT_EM_FAILURE)] + [unique] FWPM_NET_EVENT_IKEEXT_EM_FAILURE1* ikeEmFailure; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP2* classifyDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_KERNEL_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_KERNEL_DROP0* ipsecDrop; + [case(FWPM_NET_EVENT_TYPE_IPSEC_DOSP_DROP)] + [unique] FWPM_NET_EVENT_IPSEC_DOSP_DROP0* idpDrop; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_ALLOW)] + [unique] FWPM_NET_EVENT_CLASSIFY_ALLOW0* classifyAllow; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_DROP)] + [unique] FWPM_NET_EVENT_CAPABILITY_DROP0* capabilityDrop; + [case(FWPM_NET_EVENT_TYPE_CAPABILITY_ALLOW)] + [unique] FWPM_NET_EVENT_CAPABILITY_ALLOW0* capabilityAllow; + [case(FWPM_NET_EVENT_TYPE_CLASSIFY_DROP_MAC)] + [unique] FWPM_NET_EVENT_CLASSIFY_DROP_MAC0* classifyDropMac; + [case(FWPM_NET_EVENT_TYPE_LPM_PACKET_ARRIVAL)] + [unique] FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0* lpmPacketArrival; + }; +} FWPM_NET_EVENT5; +cpp_quote("#endif //(NTDDI_VERSION >= NTDDI_WIN10_RS5)") //NTDDI_WIN10_RS5 + +// Template for filtering events. Supported filter conditions are: +// FWPM_CONDITION_IP_PROTOCOL +// FWPM_CONDITION_IP_LOCAL_ADDRESS +// FWPM_CONDITION_IP_REMOTE_ADDRESS +// FWPM_CONDITION_IP_LOCAL_PORT +// FWPM_CONDITION_IP_REMOTE_PORT +// FWPM_CONDITION_ALE_APP_ID +typedef struct FWPM_NET_EVENT_ENUM_TEMPLATE0_ +{ + // Start/end time of the time period of interest. + FILETIME startTime; + FILETIME endTime; + // Number of filter conditions. If zero, then all events match. + UINT32 numFilterConditions; + // Array of filter conditions. + [size_is(numFilterConditions), unique] + FWPM_FILTER_CONDITION0* filterCondition; +} FWPM_NET_EVENT_ENUM_TEMPLATE0; + +// Used to subscribe for net event notifications. +typedef struct FWPM_NET_EVENT_SUBSCRIPTION0_ +{ + // Information supplied when subscribing. + + // Notifications are only dispatched for objects that match the template. If + // the template is NULL, it matches all objects. + [unique] FWPM_NET_EVENT_ENUM_TEMPLATE0* enumTemplate; + // Flags -- unused. + UINT32 flags; + + // Additional information returned when getting subscriptions. + + // Owning session. + GUID sessionKey; +} FWPM_NET_EVENT_SUBSCRIPTION0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for tracking system ports. +// +/////////////////////////////////////////////////////////////////////////////// + +// Different types of system ports. +typedef [v1_enum] enum FWPM_SYSTEM_PORT_TYPE_ +{ + FWPM_SYSTEM_PORT_RPC_EPMAP, + FWPM_SYSTEM_PORT_TEREDO, + FWPM_SYSTEM_PORT_IPHTTPS_IN, + FWPM_SYSTEM_PORT_IPHTTPS_OUT, + FWPM_SYSTEM_PORT_TYPE_MAX +} FWPM_SYSTEM_PORT_TYPE; + +// Stores all the system ports of a specified type. +typedef struct FWPM_SYSTEM_PORTS_BY_TYPE0_ +{ + // Type of port. + FWPM_SYSTEM_PORT_TYPE type; + // Number of ports of the specified type. + UINT32 numPorts; + // Array of IP port numbers for the specified type. + [size_is(numPorts), unique] UINT16* ports; +} FWPM_SYSTEM_PORTS_BY_TYPE0; + +// Stores all the system ports of all types. +typedef struct FWPM_SYSTEM_PORTS0_ +{ + // Number of types in the array. + UINT32 numTypes; + // Array of system port types. + [size_is(numTypes), unique] FWPM_SYSTEM_PORTS_BY_TYPE0* types; +} FWPM_SYSTEM_PORTS0; + + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for Tracking Connection Objects (objects coorelating SAs into a +// single entity). +// +/////////////////////////////////////////////////////////////////////////////// + +// Different types of system ports. +typedef struct FWPM_CONNECTION0_ { + UINT64 connectionId; + + FWP_IP_VERSION ipVersion; + + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + } ; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] + union { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + } ; + + [unique] GUID * providerKey; + IPSEC_TRAFFIC_TYPE ipsecTrafficModeType; + + IKEEXT_KEY_MODULE_TYPE keyModuleType; + IKEEXT_PROPOSAL0 mmCrypto; + + IKEEXT_CREDENTIAL2 mmPeer; + IKEEXT_CREDENTIAL2 emPeer; + + UINT64 bytesTransferredIn; + UINT64 bytesTransferredOut; + UINT64 bytesTransferredTotal; + + FILETIME startSysTime; + +} FWPM_CONNECTION0; + +cpp_quote("#define FWPM_CONNECTION_ENUM_FLAG_QUERY_BYTES_TRANSFERRED (0x00000001)") + +typedef struct FWPM_CONNECTION_ENUM_TEMPLATE0_ { + UINT64 connectionId; + UINT32 flags; +} FWPM_CONNECTION_ENUM_TEMPLATE0; + +typedef struct FWPM_CONNECTION_SUBSCRIPTION0_ { + [unique] FWPM_CONNECTION_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; // reserved flags + GUID sessionKey; +} FWPM_CONNECTION_SUBSCRIPTION0; + +typedef [v1_enum] enum FWPM_CONNECTION_EVENT_TYPE_ { + FWPM_CONNECTION_EVENT_ADD, + FWPM_CONNECTION_EVENT_DELETE, + FWPM_CONNECTION_EVENT_MAX +} FWPM_CONNECTION_EVENT_TYPE; + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for Tracking vSwitch events. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef [v1_enum] enum FWPM_VSWITCH_EVENT_TYPE_ +{ + // Filter engine is not enabled on all vSwitch instances. As a result + // the filter(s) being added may not be fully enforced. + FWPM_VSWITCH_EVENT_FILTER_ADD_TO_INCOMPLETE_LAYER, + // Filter(s) are being added to the vSwitch filter engine that's not in + // its required position. As a result the filter(s) could be bypassed. + FWPM_VSWITCH_EVENT_FILTER_ENGINE_NOT_IN_REQUIRED_POSITION, + // Filter engine is being enabled for the vSwitch instance. + FWPM_VSWITCH_EVENT_ENABLED_FOR_INSPECTION, + // Filter engine is being disabled for the vSwitch instance. + FWPM_VSWITCH_EVENT_DISABLED_FOR_INSPECTION, + // vSwitch filter engine is being reordered and may not reside in the + // required position to correctly enforce committed filters. + FWPM_VSWITCH_EVENT_FILTER_ENGINE_REORDER, + FWPM_VSWITCH_EVENT_MAX +} FWPM_VSWITCH_EVENT_TYPE; + +typedef struct FWPM_VSWITCH_EVENT0_ +{ + FWPM_VSWITCH_EVENT_TYPE eventType; + [string, unique] wchar_t* vSwitchId; + [switch_is(eventType), switch_type(FWPM_VSWITCH_EVENT_TYPE)] + union + { + [case(FWPM_VSWITCH_EVENT_FILTER_ADD_TO_INCOMPLETE_LAYER, + FWPM_VSWITCH_EVENT_ENABLED_FOR_INSPECTION, + FWPM_VSWITCH_EVENT_DISABLED_FOR_INSPECTION)]; + [case(FWPM_VSWITCH_EVENT_FILTER_ENGINE_NOT_IN_REQUIRED_POSITION)] + struct + { + ULONG numvSwitchFilterExtensions; + [size_is(numvSwitchFilterExtensions), string, ref] LPWSTR* vSwitchFilterExtensions; + } positionInfo; + [case(FWPM_VSWITCH_EVENT_FILTER_ENGINE_REORDER)] + struct + { + BOOL inRequiredPosition; + ULONG numvSwitchFilterExtensions; + [size_is(numvSwitchFilterExtensions), string, unique] LPWSTR* vSwitchFilterExtensions; + } reorderInfo; + }; +} FWPM_VSWITCH_EVENT0; + +typedef struct FWPM_VSWITCH_EVENT_SUBSCRIPTION0_ +{ + UINT32 flags; + GUID sessionKey; +} FWPM_VSWITCH_EVENT_SUBSCRIPTION0; + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(pop)") +cpp_quote("#else") +cpp_quote("#pragma warning(default:4201)") +cpp_quote("#endif") +cpp_quote("#endif") + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */") +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.h new file mode 100644 index 0000000000000000000000000000000000000000..770fb826d3375e10317a9a920fa3db5985c24dca --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.h @@ -0,0 +1,302 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + + +#ifndef __fwpstypes_h__ +#define __fwpstypes_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +/* header files for imported files */ +#include "fwptypes.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_fwpstypes_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family or AppRuntime Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif +typedef struct FWPS_FILTER_CONDITION0_ + { + UINT16 fieldId; + UINT16 reserved; + FWP_MATCH_TYPE matchType; + FWP_CONDITION_VALUE0 conditionValue; + } FWPS_FILTER_CONDITION0; + +typedef struct FWPS_ACTION0_ + { + FWP_ACTION_TYPE type; + UINT32 calloutId; + } FWPS_ACTION0; + +#define FWPS_FILTER_FLAG_CLEAR_ACTION_RIGHT (0x0001) +#define FWPS_FILTER_FLAG_PERMIT_IF_CALLOUT_UNREGISTERED (0x0002) +#define FWPS_FILTER_FLAG_OR_CONDITIONS (0x0004) +#define FWPS_FILTER_FLAG_HAS_SECURITY_REALM_PROVIDER_CONTEXT (0x0008) +#define FWPS_FILTER_FLAG_SILENT_MODE (0x0010) +#define FWPS_FILTER_FLAG_IPSEC_NO_ACQUIRE_INITIATE (0x0020) +#define FWPS_FILTER_FLAG_RESERVED0 (0x0040) +#define FWPS_FILTER_FLAG_RESERVED1 (0x0080) +#define FWPS_FILTER_FLAG_RESERVED2 (0x0100) +typedef struct FWPM_PROVIDER_CONTEXT0_ FWPM_PROVIDER_CONTEXT0; + +typedef struct FWPS_FILTER0_ + { + UINT64 filterId; + FWP_VALUE0 weight; + UINT16 subLayerWeight; + UINT16 flags; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPS_FILTER_CONDITION0 *filterCondition; + FWPS_ACTION0 action; + UINT64 context; + /* [unique] */ FWPM_PROVIDER_CONTEXT0 *providerContext; + } FWPS_FILTER0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_PROVIDER_CONTEXT1_ FWPM_PROVIDER_CONTEXT1; + +typedef struct FWPS_FILTER1_ + { + UINT64 filterId; + FWP_VALUE0 weight; + UINT16 subLayerWeight; + UINT16 flags; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPS_FILTER_CONDITION0 *filterCondition; + FWPS_ACTION0 action; + UINT64 context; + /* [unique] */ FWPM_PROVIDER_CONTEXT1 *providerContext; + } FWPS_FILTER1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct FWPM_PROVIDER_CONTEXT2_ FWPM_PROVIDER_CONTEXT2; + +typedef struct FWPS_FILTER2_ + { + UINT64 filterId; + FWP_VALUE0 weight; + UINT16 subLayerWeight; + UINT16 flags; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPS_FILTER_CONDITION0 *filterCondition; + FWPS_ACTION0 action; + UINT64 context; + /* [unique] */ FWPM_PROVIDER_CONTEXT2 *providerContext; + } FWPS_FILTER2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct FWPM_PROVIDER_CONTEXT3_ FWPM_PROVIDER_CONTEXT3; + +typedef struct FWPS_FILTER3_ + { + UINT64 filterId; + FWP_VALUE0 weight; + UINT16 subLayerWeight; + UINT16 flags; + UINT32 numFilterConditions; + /* [unique][size_is] */ FWPS_FILTER_CONDITION0 *filterCondition; + FWPS_ACTION0 action; + UINT64 context; + /* [unique] */ FWPM_PROVIDER_CONTEXT3 *providerContext; + } FWPS_FILTER3; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct FWPS_INCOMING_VALUE0_ + { + FWP_VALUE0 value; + } FWPS_INCOMING_VALUE0; + +typedef struct FWPS_INCOMING_VALUES0_ + { + UINT16 layerId; + UINT32 valueCount; + /* [ref][size_is] */ FWPS_INCOMING_VALUE0 *incomingValue; + } FWPS_INCOMING_VALUES0; + +typedef +enum FWPS_DISCARD_MODULE0_ + { + FWPS_DISCARD_MODULE_NETWORK = 0, + FWPS_DISCARD_MODULE_TRANSPORT = ( FWPS_DISCARD_MODULE_NETWORK + 1 ) , + FWPS_DISCARD_MODULE_GENERAL = ( FWPS_DISCARD_MODULE_TRANSPORT + 1 ) , + FWPS_DISCARD_MODULE_MAX = ( FWPS_DISCARD_MODULE_GENERAL + 1 ) + } FWPS_DISCARD_MODULE0; + +typedef +enum FWPS_GENERAL_DISCARD_REASON_ + { + FWPS_DISCARD_FIREWALL_POLICY = 0, + FWPS_DISCARD_IPSEC = ( FWPS_DISCARD_FIREWALL_POLICY + 1 ) , + FWPS_GENERAL_DISCARD_REASON_MAX = ( FWPS_DISCARD_IPSEC + 1 ) + } FWPS_GENERAL_DISCARD_REASON; + +typedef struct FWPS_DISCARD_METADATA0_ + { + FWPS_DISCARD_MODULE0 discardModule; + UINT32 discardReason; + UINT64 filterId; + } FWPS_DISCARD_METADATA0; + +typedef struct FWPS_INBOUND_FRAGMENT_METADATA0_ + { + UINT32 fragmentIdentification; + UINT16 fragmentOffset; + ULONG fragmentLength; + } FWPS_INBOUND_FRAGMENT_METADATA0; + +#define FWPS_INCOMING_FLAG_CACHE_SAFE (0x00000001) +#define FWPS_INCOMING_FLAG_ENFORCE_QUERY (0x00000002) +#define FWPS_INCOMING_FLAG_ABSORB (0x00000004) +#define FWPS_INCOMING_FLAG_CONNECTION_FAILING_INDICATION (0x00000008) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_INCOMING_FLAG_MID_STREAM_INSPECTION (0x00000010) +#define FWPS_INCOMING_FLAG_RECLASSIFY (0x00000020) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_INCOMING_FLAG_IS_LOOSE_SOURCE_FLOW (0x00000040) +#define FWPS_INCOMING_FLAG_IS_LOCAL_ONLY_FLOW (0x00000080) +#define FWPS_L2_INCOMING_FLAG_IS_RAW_IPV4_FRAMING (0x00000001) +#define FWPS_L2_INCOMING_FLAG_IS_RAW_IPV6_FRAMING (0x00000002) +#define FWPS_L2_INCOMING_FLAG_RECLASSIFY_MULTI_DESTINATION (0x00000008) +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define FWPS_INCOMING_FLAG_RESERVED0 (0x00000100) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_RIGHT_ACTION_WRITE (0x00000001) +#define FWPS_CLASSIFY_OUT_FLAG_ABSORB (0x00000001) +#define FWPS_CLASSIFY_OUT_FLAG_BUFFER_LIMIT_REACHED (0x00000002) +#define FWPS_CLASSIFY_OUT_FLAG_NO_MORE_DATA (0x00000004) +#define FWPS_CLASSIFY_OUT_FLAG_ALE_FAST_CACHE_CHECK (0x00000008) +#define FWPS_CLASSIFY_OUT_FLAG_ALE_FAST_CACHE_POSSIBLE (0x00000010) +typedef struct FWPS_CLASSIFY_OUT0_ + { + FWP_ACTION_TYPE actionType; + UINT64 outContext; + UINT64 filterId; + UINT32 rights; + UINT32 flags; + UINT32 reserved; + } FWPS_CLASSIFY_OUT0; + +typedef +enum FWPS_CALLOUT_NOTIFY_TYPE_ + { + FWPS_CALLOUT_NOTIFY_ADD_FILTER = 0, + FWPS_CALLOUT_NOTIFY_DELETE_FILTER = ( FWPS_CALLOUT_NOTIFY_ADD_FILTER + 1 ) , + FWPS_CALLOUT_NOTIFY_ADD_FILTER_POST_COMMIT = ( FWPS_CALLOUT_NOTIFY_DELETE_FILTER + 1 ) , + FWPS_CALLOUT_NOTIFY_TYPE_MAX = ( FWPS_CALLOUT_NOTIFY_ADD_FILTER_POST_COMMIT + 1 ) + } FWPS_CALLOUT_NOTIFY_TYPE; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_ALE_ENDPOINT_FLAG_IPSEC_SECURED (0x00000001) +typedef struct FWPS_ALE_ENDPOINT_PROPERTIES0_ + { + UINT64 endpointId; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + UINT8 ipProtocol; + UINT16 localPort; + UINT16 remotePort; + UINT64 localTokenModifiedId; + UINT64 mmSaId; + UINT64 qmSaId; + UINT32 ipsecStatus; + UINT32 flags; + FWP_BYTE_BLOB appId; + } FWPS_ALE_ENDPOINT_PROPERTIES0; + +typedef struct FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0_ + { + FWP_CONDITION_VALUE0 localSubNet; + FWP_CONDITION_VALUE0 remoteSubNet; + FWP_CONDITION_VALUE0 ipProtocol; + FWP_CONDITION_VALUE0 localPort; + FWP_CONDITION_VALUE0 remotePort; + } FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */ +#pragma endregion + + +extern RPC_IF_HANDLE __MIDL_itf_fwpstypes_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_fwpstypes_0000_0000_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.idl new file mode 100644 index 0000000000000000000000000000000000000000..39c35b6fca1e7b14aacdccd42efb64d9cbff5a66 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpstypes.idl @@ -0,0 +1,420 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Defines data types used by the system portion of the FWP API. +*/ +cpp_quote("#include ") + +#pragma region Desktop Family or AppRuntime Package +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME)") + + +import "fwptypes.idl"; + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(push)") +cpp_quote("#endif") +cpp_quote("#pragma warning(disable:4201)") +cpp_quote("#endif") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building filters. A filter expresses a rule of the form "if +// the condition is true, then perform the action." +// +/////////////////////////////////////////////////////////////////////////////// + +// Expresses a filter condition that must be true for the action to be invoked. +typedef struct FWPS_FILTER_CONDITION0_ +{ + // LUID of the field to be tested. + UINT16 fieldId; + // Reserved for system type. + UINT16 reserved; + // Type of match to be performed. + FWP_MATCH_TYPE matchType; + // Value to match the field against. + FWP_CONDITION_VALUE0 conditionValue; +} FWPS_FILTER_CONDITION0; + +// Action invoked if all the filter conditions are true. +typedef struct FWPS_ACTION0_ +{ + // Type of action. + FWP_ACTION_TYPE type; + // LUID of the callout if FWP_ACTION_FLAG_CALLOUT is set in the action type. + // Otherwise, it's ignored. + UINT32 calloutId; +} FWPS_ACTION0; + +// Clear filter action right +cpp_quote("#define FWPS_FILTER_FLAG_CLEAR_ACTION_RIGHT (0x0001)") +// Treat callout filters as permit filters if callout is not registered +cpp_quote("#define FWPS_FILTER_FLAG_PERMIT_IF_CALLOUT_UNREGISTERED (0x0002)") +// There are multiple conditions for the same field. OR semantics applied +cpp_quote("#define FWPS_FILTER_FLAG_OR_CONDITIONS (0x0004)") +// The filter references a provider context for IPsec security realm Id +cpp_quote("#define FWPS_FILTER_FLAG_HAS_SECURITY_REALM_PROVIDER_CONTEXT (0x0008)") +// The filter is in silent mode +cpp_quote("#define FWPS_FILTER_FLAG_SILENT_MODE (0x0010)") +// (used for s2s IPsec tunnel policies) +// Do not initiate IPsec acquire, if packet matches a IPsec policy from a filter with this flag +cpp_quote("#define FWPS_FILTER_FLAG_IPSEC_NO_ACQUIRE_INITIATE (0x0020)") +// The flag is reserved +cpp_quote("#define FWPS_FILTER_FLAG_RESERVED0 (0x0040)") +// The flag is reserved +cpp_quote("#define FWPS_FILTER_FLAG_RESERVED1 (0x0080)") +// The flag is reserved +cpp_quote("#define FWPS_FILTER_FLAG_RESERVED2 (0x0100)") + +typedef struct FWPM_PROVIDER_CONTEXT0_ FWPM_PROVIDER_CONTEXT0; + +// System filter used for run-time classification. +typedef struct FWPS_FILTER0_ +{ + // LUID uniquely identifying the filter in the filter engine. + UINT64 filterId; + + // Weight of the filter -- higher filters are invoked first. + FWP_VALUE0 weight; + // Weight of the filter's sub-layer -- higher weights are invoked first. + UINT16 subLayerWeight; + UINT16 flags; + // Array of filter conditions. All must be true for the action to be + // performed. In other words, the conditions are AND'ed together. If no + // conditions are specified, the action is always performed. + UINT32 numFilterConditions; + [size_is(numFilterConditions), unique] + FWPS_FILTER_CONDITION0* filterCondition; + // Action performed if the conditions are true. + FWPS_ACTION0 action; + // Opaque context that may be interpreted by callouts. The context of the + // terminating filter is also returned from classify. In many cases, this + // context will be the LUID of a provider context, but it need not be. + UINT64 context; + // If this is a callout filter and the callout has the + // FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT flag set, this contains the + // provider context from the corresponding FWPM_FILTER0 struct. Otherwise, + // it is null. + [unique] FWPM_PROVIDER_CONTEXT0* providerContext; +} FWPS_FILTER0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +typedef struct FWPM_PROVIDER_CONTEXT1_ FWPM_PROVIDER_CONTEXT1; +// Version-1 of system filter used for run-time classification. +typedef struct FWPS_FILTER1_ +{ + // LUID uniquely identifying the filter in the filter engine. + UINT64 filterId; + + // Weight of the filter -- higher filters are invoked first. + FWP_VALUE0 weight; + // Weight of the filter's sub-layer -- higher weights are invoked first. + UINT16 subLayerWeight; + UINT16 flags; + // Array of filter conditions. All must be true for the action to be + // performed. In other words, the conditions are AND'ed together. If no + // conditions are specified, the action is always performed. + UINT32 numFilterConditions; + [size_is(numFilterConditions), unique] + FWPS_FILTER_CONDITION0* filterCondition; + // Action performed if the conditions are true. + FWPS_ACTION0 action; + // Opaque context that may be interpreted by callouts. The context of the + // terminating filter is also returned from classify. In many cases, this + // context will be the LUID of a provider context, but it need not be. + UINT64 context; + // If this is a callout filter and the callout has the + // FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT flag set, this contains the + // provider context from the corresponding FWPM_FILTER1 struct. Otherwise, + // it is null. + [unique] FWPM_PROVIDER_CONTEXT1* providerContext; +} FWPS_FILTER1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +typedef struct FWPM_PROVIDER_CONTEXT2_ FWPM_PROVIDER_CONTEXT2; +// Version-2 of system filter used for run-time classification. +typedef struct FWPS_FILTER2_ +{ + // LUID uniquely identifying the filter in the filter engine. + UINT64 filterId; + + // Weight of the filter -- higher filters are invoked first. + FWP_VALUE0 weight; + // Weight of the filter's sub-layer -- higher weights are invoked first. + UINT16 subLayerWeight; + UINT16 flags; + // Array of filter conditions. All must be true for the action to be + // performed. In other words, the conditions are AND'ed together. If no + // conditions are specified, the action is always performed. + UINT32 numFilterConditions; + [size_is(numFilterConditions), unique] + FWPS_FILTER_CONDITION0* filterCondition; + // Action performed if the conditions are true. + FWPS_ACTION0 action; + // Opaque context that may be interpreted by callouts. The context of the + // terminating filter is also returned from classify. In many cases, this + // context will be the LUID of a provider context, but it need not be. + UINT64 context; + // If this is a callout filter and the callout has the + // FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT flag set, this contains the + // provider context from the corresponding FWPM_FILTER1 struct. Otherwise, + // it is null. + [unique] FWPM_PROVIDER_CONTEXT2* providerContext; +} FWPS_FILTER2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS3)") +typedef struct FWPM_PROVIDER_CONTEXT3_ FWPM_PROVIDER_CONTEXT3; +// Version-3 of system filter used for run-time classification. +typedef struct FWPS_FILTER3_ +{ + // LUID uniquely identifying the filter in the filter engine. + UINT64 filterId; + + // Weight of the filter -- higher filters are invoked first. + FWP_VALUE0 weight; + // Weight of the filter's sub-layer -- higher weights are invoked first. + UINT16 subLayerWeight; + UINT16 flags; + // Array of filter conditions. All must be true for the action to be + // performed. In other words, the conditions are AND'ed together. If no + // conditions are specified, the action is always performed. + UINT32 numFilterConditions; + [size_is(numFilterConditions), unique] + FWPS_FILTER_CONDITION0* filterCondition; + // Action performed if the conditions are true. + FWPS_ACTION0 action; + // Opaque context that may be interpreted by callouts. The context of the + // terminating filter is also returned from classify. In many cases, this + // context will be the LUID of a provider context, but it need not be. + UINT64 context; + // If this is a callout filter and the callout has the + // FWPM_CALLOUT_FLAG_USES_PROVIDER_CONTEXT flag set, this contains the + // provider context from the corresponding FWPM_FILTER1 struct. Otherwise, + // it is null. + [unique] FWPM_PROVIDER_CONTEXT3* providerContext; +} FWPS_FILTER3; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for classifying. +// +/////////////////////////////////////////////////////////////////////////////// + +// An incoming value passed to the filter engine. These are what +// FWPS_FILTER_CONDITION0's are tested against. +typedef struct FWPS_INCOMING_VALUE0_ +{ + // Data value. + FWP_VALUE0 value; +} FWPS_INCOMING_VALUE0; + +// An array of FWPS_INCOMING_VALUE0's. +typedef struct FWPS_INCOMING_VALUES0_ +{ + // The LUID of the layer where these values originated. + UINT16 layerId; + // Number of values in the array. The number of values, their order, and + // their data type is fixed for a given layer and determined by the layer + // schema. + UINT32 valueCount; + // Array of FWPS_INCOMING_VALUE0's. + [size_is(valueCount), ref] FWPS_INCOMING_VALUE0* incomingValue; +} FWPS_INCOMING_VALUES0; + +////////// +// The FWPS_INCOMING_VALUES0 are the only values which can be tested by +// conditions. However, many layers provide additional "meta" information, that +// can be processed by callouts. +////////// + +typedef enum FWPS_DISCARD_MODULE0_ +{ + FWPS_DISCARD_MODULE_NETWORK, + FWPS_DISCARD_MODULE_TRANSPORT, + FWPS_DISCARD_MODULE_GENERAL, + FWPS_DISCARD_MODULE_MAX +} FWPS_DISCARD_MODULE0; + +// General (i.e., not layer-specific) reasons why a packet might be discarded. +typedef enum FWPS_GENERAL_DISCARD_REASON_ +{ + FWPS_DISCARD_FIREWALL_POLICY, + FWPS_DISCARD_IPSEC, + FWPS_GENERAL_DISCARD_REASON_MAX +} FWPS_GENERAL_DISCARD_REASON; + +typedef struct FWPS_DISCARD_METADATA0_ +{ + FWPS_DISCARD_MODULE0 discardModule; + UINT32 discardReason; + // LUID of filter that caused discard + UINT64 filterId; +} FWPS_DISCARD_METADATA0; + +typedef struct FWPS_INBOUND_FRAGMENT_METADATA0_ +{ + UINT32 fragmentIdentification; + UINT16 fragmentOffset; + ULONG fragmentLength; +} FWPS_INBOUND_FRAGMENT_METADATA0; + +////////// +// Flags that can be specified in FWPS_INCOMING_METADATA_VALUES0.flags. +////////// + +cpp_quote("#define FWPS_INCOMING_FLAG_CACHE_SAFE (0x00000001)") +cpp_quote("#define FWPS_INCOMING_FLAG_ENFORCE_QUERY (0x00000002)") +cpp_quote("#define FWPS_INCOMING_FLAG_ABSORB (0x00000004)") +cpp_quote("#define FWPS_INCOMING_FLAG_CONNECTION_FAILING_INDICATION (0x00000008)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +cpp_quote("#define FWPS_INCOMING_FLAG_MID_STREAM_INSPECTION (0x00000010)") +cpp_quote("#define FWPS_INCOMING_FLAG_RECLASSIFY (0x00000020)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWPS_INCOMING_FLAG_IS_LOOSE_SOURCE_FLOW (0x00000040)") +cpp_quote("#define FWPS_INCOMING_FLAG_IS_LOCAL_ONLY_FLOW (0x00000080)") +cpp_quote("#define FWPS_L2_INCOMING_FLAG_IS_RAW_IPV4_FRAMING (0x00000001)") +cpp_quote("#define FWPS_L2_INCOMING_FLAG_IS_RAW_IPV6_FRAMING (0x00000002)") +cpp_quote("#define FWPS_L2_INCOMING_FLAG_RECLASSIFY_MULTI_DESTINATION (0x00000008)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_19H1)") +cpp_quote("#define FWPS_INCOMING_FLAG_RESERVED0 (0x00000100)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#define FWPS_RIGHT_ACTION_WRITE (0x00000001)") + +cpp_quote("#define FWPS_CLASSIFY_OUT_FLAG_ABSORB (0x00000001)") +cpp_quote("#define FWPS_CLASSIFY_OUT_FLAG_BUFFER_LIMIT_REACHED (0x00000002)") +cpp_quote("#define FWPS_CLASSIFY_OUT_FLAG_NO_MORE_DATA (0x00000004)") +cpp_quote("#define FWPS_CLASSIFY_OUT_FLAG_ALE_FAST_CACHE_CHECK (0x00000008)") +cpp_quote("#define FWPS_CLASSIFY_OUT_FLAG_ALE_FAST_CACHE_POSSIBLE (0x00000010)") + +// Used to return the outcome of classification to the shim. +typedef struct FWPS_CLASSIFY_OUT0_ +{ + + // Suggested action for the classification. Write access to this field is + // controlled by "rights" below. Note that returning block + // when FWPS_RIGHT_ACTION_WRITE isn't held is a veto. + FWP_ACTION_TYPE actionType; + // Opaque context data set by callout or terminating filter + UINT64 outContext; + // FilterId of filter that set final actionType + UINT64 filterId; + // Controls write access to fields in within this structure. + // FWPS_RIGHT_ACTION_WRITE must be held to update the actionType + // unless executing a veto. + UINT32 rights; + UINT32 flags; + // Reserved for system use + UINT32 reserved; +} FWPS_CLASSIFY_OUT0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for dispatching callout notifications. +// +/////////////////////////////////////////////////////////////////////////////// + + +// Types of notifications dispatched to callouts. +typedef enum FWPS_CALLOUT_NOTIFY_TYPE_ +{ + // A filter invoking the callout has been added. + FWPS_CALLOUT_NOTIFY_ADD_FILTER, + // A filter invoking the callout has been deleted. + FWPS_CALLOUT_NOTIFY_DELETE_FILTER, + // A filter invoking the callout has commit, and is active in the system + FWPS_CALLOUT_NOTIFY_ADD_FILTER_POST_COMMIT, + // Not a valid type -- used for parameter validation only. + FWPS_CALLOUT_NOTIFY_TYPE_MAX +} FWPS_CALLOUT_NOTIFY_TYPE; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for ALE endpoints. +// +/////////////////////////////////////////////////////////////////////////////// + +////////// +// Flags specific to an ALE endpoint. +////////// + +// The connection is secured using IPsec +cpp_quote("#define FWPS_ALE_ENDPOINT_FLAG_IPSEC_SECURED (0x00000001)") + +// ALE endpoint properties +typedef struct FWPS_ALE_ENDPOINT_PROPERTIES0_ +{ + UINT64 endpointId; + FWP_IP_VERSION ipVersion; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + UINT8 ipProtocol; + UINT16 localPort; + UINT16 remotePort; + UINT64 localTokenModifiedId; + UINT64 mmSaId; + UINT64 qmSaId; + UINT32 ipsecStatus; + UINT32 flags; + FWP_BYTE_BLOB appId; +} FWPS_ALE_ENDPOINT_PROPERTIES0; + +// Template used for enumerating ALE endpoints +typedef struct FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0_ +{ + // If not empty, only endpoints whose local address is on + // the specified subnet will be returned. May be of type FWP_EMPTY, + // FWP_UINT32, FWP_BYTE_ARRAY16_TYPE, FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 localSubNet; + // If not empty, only endpoints whose remote address is + // on the specified subnet will be returned. May be of type FWP_EMPTY, + // FWP_UINT32, FWP_BYTE_ARRAY16_TYPE, FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 remoteSubNet; + // If not empty, only endpoints whose protocol matches the specified value + // will be returned. May be of type FWP_EMPTY, FWP_UINT8 or FWP_RANGE_TYPE. + FWP_CONDITION_VALUE0 ipProtocol; + // If not empty, only endpoints whose local port matches the specified value + // will be returned. May be of type FWP_EMPTY, FWP_UINT16 or FWP_RANGE_TYPE. + FWP_CONDITION_VALUE0 localPort; + // If not empty, only endpoints whose remote port matches the specified value + // will be returned. May be of type FWP_EMPTY, FWP_UINT16 or FWP_RANGE_TYPE. + FWP_CONDITION_VALUE0 remotePort; +} FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(pop)") +cpp_quote("#else") +cpp_quote("#pragma warning(default:4201)") +cpp_quote("#endif") +cpp_quote("#endif") + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */") +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.h new file mode 100644 index 0000000000000000000000000000000000000000..e0405dfdfb105b86118d76e02848b5fdea92ebb2 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.h @@ -0,0 +1,446 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + + +#ifndef __fwptypes_h__ +#define __fwptypes_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +/* header files for imported files */ +#include "wtypes.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_fwptypes_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family or AppRuntime Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif +#ifdef __midl +typedef struct _LUID + { + DWORD LowPart; + LONG HighPart; + } LUID; + +typedef struct _LUID *PLUID; + +#endif +typedef /* [v1_enum] */ +enum FWP_DIRECTION_ + { + FWP_DIRECTION_OUTBOUND = 0, + FWP_DIRECTION_INBOUND = ( FWP_DIRECTION_OUTBOUND + 1 ) , + FWP_DIRECTION_MAX = ( FWP_DIRECTION_INBOUND + 1 ) + } FWP_DIRECTION; + +typedef /* [v1_enum] */ +enum FWP_IP_VERSION_ + { + FWP_IP_VERSION_V4 = 0, + FWP_IP_VERSION_V6 = ( FWP_IP_VERSION_V4 + 1 ) , + FWP_IP_VERSION_NONE = ( FWP_IP_VERSION_V6 + 1 ) , + FWP_IP_VERSION_MAX = ( FWP_IP_VERSION_NONE + 1 ) + } FWP_IP_VERSION; + +typedef /* [v1_enum] */ +enum FWP_NE_FAMILY_ + { + FWP_AF_INET = FWP_IP_VERSION_V4, + FWP_AF_INET6 = FWP_IP_VERSION_V6, + FWP_AF_ETHER = FWP_IP_VERSION_NONE, + FWP_AF_NONE = ( FWP_AF_ETHER + 1 ) + } FWP_AF; + +typedef /* [v1_enum] */ +enum FWP_ETHER_ENCAP_METHOD_ + { + FWP_ETHER_ENCAP_METHOD_ETHER_V2 = 0, + FWP_ETHER_ENCAP_METHOD_SNAP = 1, + FWP_ETHER_ENCAP_METHOD_SNAP_W_OUI_ZERO = 3 + } FWP_ETHER_ENCAP_METHOD; + +typedef /* [v1_enum] */ +enum FWP_DATA_TYPE_ + { + FWP_EMPTY = 0, + FWP_UINT8 = ( FWP_EMPTY + 1 ) , + FWP_UINT16 = ( FWP_UINT8 + 1 ) , + FWP_UINT32 = ( FWP_UINT16 + 1 ) , + FWP_UINT64 = ( FWP_UINT32 + 1 ) , + FWP_INT8 = ( FWP_UINT64 + 1 ) , + FWP_INT16 = ( FWP_INT8 + 1 ) , + FWP_INT32 = ( FWP_INT16 + 1 ) , + FWP_INT64 = ( FWP_INT32 + 1 ) , + FWP_FLOAT = ( FWP_INT64 + 1 ) , + FWP_DOUBLE = ( FWP_FLOAT + 1 ) , + FWP_BYTE_ARRAY16_TYPE = ( FWP_DOUBLE + 1 ) , + FWP_BYTE_BLOB_TYPE = ( FWP_BYTE_ARRAY16_TYPE + 1 ) , + FWP_SID = ( FWP_BYTE_BLOB_TYPE + 1 ) , + FWP_SECURITY_DESCRIPTOR_TYPE = ( FWP_SID + 1 ) , + FWP_TOKEN_INFORMATION_TYPE = ( FWP_SECURITY_DESCRIPTOR_TYPE + 1 ) , + FWP_TOKEN_ACCESS_INFORMATION_TYPE = ( FWP_TOKEN_INFORMATION_TYPE + 1 ) , + FWP_UNICODE_STRING_TYPE = ( FWP_TOKEN_ACCESS_INFORMATION_TYPE + 1 ) , + FWP_BYTE_ARRAY6_TYPE = ( FWP_UNICODE_STRING_TYPE + 1 ) , + FWP_SINGLE_DATA_TYPE_MAX = 0xff, + FWP_V4_ADDR_MASK = ( FWP_SINGLE_DATA_TYPE_MAX + 1 ) , + FWP_V6_ADDR_MASK = ( FWP_V4_ADDR_MASK + 1 ) , + FWP_RANGE_TYPE = ( FWP_V6_ADDR_MASK + 1 ) , + FWP_DATA_TYPE_MAX = ( FWP_RANGE_TYPE + 1 ) + } FWP_DATA_TYPE; + +#define FWP_BYTEMAP_ARRAY64_SIZE 8 +typedef struct FWP_BYTE_ARRAY6_ + { + UINT8 byteArray6[ 6 ]; + } FWP_BYTE_ARRAY6; + +#define FWP_BYTE_ARRAY6_SIZE 6 +typedef struct FWP_BYTE_ARRAY16_ + { + UINT8 byteArray16[ 16 ]; + } FWP_BYTE_ARRAY16; + +typedef struct FWP_BYTE_BLOB_ + { + UINT32 size; + /* [unique][size_is] */ UINT8 *data; + } FWP_BYTE_BLOB; + +typedef struct FWP_TOKEN_INFORMATION_ + { + ULONG sidCount; + /* [size_is] */ PSID_AND_ATTRIBUTES sids; + ULONG restrictedSidCount; + /* [size_is] */ PSID_AND_ATTRIBUTES restrictedSids; + } FWP_TOKEN_INFORMATION; + +typedef struct FWP_VALUE0_ + { + FWP_DATA_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ UINT8 uint8; + /* [case()] */ UINT16 uint16; + /* [case()] */ UINT32 uint32; + /* [case()][unique] */ UINT64 *uint64; + /* [case()] */ INT8 int8; + /* [case()] */ INT16 int16; + /* [case()] */ INT32 int32; + /* [case()][unique] */ INT64 *int64; + /* [case()] */ float float32; + /* [case()][unique] */ double *double64; + /* [case()][unique] */ FWP_BYTE_ARRAY16 *byteArray16; + /* [case()][unique] */ FWP_BYTE_BLOB *byteBlob; + /* [case()][unique] */ SID *sid; + /* [case()][unique] */ FWP_BYTE_BLOB *sd; + /* [case()][unique] */ FWP_TOKEN_INFORMATION *tokenInformation; + /* [case()][unique] */ FWP_BYTE_BLOB *tokenAccessInformation; + /* [case()][string] */ LPWSTR unicodeString; + /* [case()][unique] */ FWP_BYTE_ARRAY6 *byteArray6; + } ; + } FWP_VALUE0; + +typedef /* [v1_enum] */ +enum FWP_MATCH_TYPE_ + { + FWP_MATCH_EQUAL = 0, + FWP_MATCH_GREATER = ( FWP_MATCH_EQUAL + 1 ) , + FWP_MATCH_LESS = ( FWP_MATCH_GREATER + 1 ) , + FWP_MATCH_GREATER_OR_EQUAL = ( FWP_MATCH_LESS + 1 ) , + FWP_MATCH_LESS_OR_EQUAL = ( FWP_MATCH_GREATER_OR_EQUAL + 1 ) , + FWP_MATCH_RANGE = ( FWP_MATCH_LESS_OR_EQUAL + 1 ) , + FWP_MATCH_FLAGS_ALL_SET = ( FWP_MATCH_RANGE + 1 ) , + FWP_MATCH_FLAGS_ANY_SET = ( FWP_MATCH_FLAGS_ALL_SET + 1 ) , + FWP_MATCH_FLAGS_NONE_SET = ( FWP_MATCH_FLAGS_ANY_SET + 1 ) , + FWP_MATCH_EQUAL_CASE_INSENSITIVE = ( FWP_MATCH_FLAGS_NONE_SET + 1 ) , + FWP_MATCH_NOT_EQUAL = ( FWP_MATCH_EQUAL_CASE_INSENSITIVE + 1 ) , + FWP_MATCH_PREFIX = ( FWP_MATCH_NOT_EQUAL + 1 ) , + FWP_MATCH_NOT_PREFIX = ( FWP_MATCH_PREFIX + 1 ) , + FWP_MATCH_TYPE_MAX = ( FWP_MATCH_NOT_PREFIX + 1 ) + } FWP_MATCH_TYPE; + +typedef struct FWP_V4_ADDR_AND_MASK_ + { + UINT32 addr; + UINT32 mask; + } FWP_V4_ADDR_AND_MASK; + +#define FWP_V6_ADDR_SIZE (16) +typedef struct FWP_V6_ADDR_AND_MASK_ + { + UINT8 addr[ 16 ]; + UINT8 prefixLength; + } FWP_V6_ADDR_AND_MASK; + +typedef struct FWP_RANGE0_ + { + FWP_VALUE0 valueLow; + FWP_VALUE0 valueHigh; + } FWP_RANGE0; + +#define FWP_ACTRL_MATCH_FILTER (0x00000001) + +typedef struct FWP_CONDITION_VALUE0_ + { + FWP_DATA_TYPE type; + /* [switch_is][switch_type] */ union + { + /* [case()] */ /* Empty union arm */ + /* [case()] */ UINT8 uint8; + /* [case()] */ UINT16 uint16; + /* [case()] */ UINT32 uint32; + /* [case()][unique] */ UINT64 *uint64; + /* [case()] */ INT8 int8; + /* [case()] */ INT16 int16; + /* [case()] */ INT32 int32; + /* [case()][unique] */ INT64 *int64; + /* [case()] */ float float32; + /* [case()][unique] */ double *double64; + /* [case()][unique] */ FWP_BYTE_ARRAY16 *byteArray16; + /* [case()][unique] */ FWP_BYTE_BLOB *byteBlob; + /* [case()][unique] */ SID *sid; + /* [case()][unique] */ FWP_BYTE_BLOB *sd; + /* [case()][unique] */ FWP_TOKEN_INFORMATION *tokenInformation; + /* [case()][unique] */ FWP_BYTE_BLOB *tokenAccessInformation; + /* [case()][string] */ LPWSTR unicodeString; + /* [case()][unique] */ FWP_BYTE_ARRAY6 *byteArray6; + /* [case()][unique] */ FWP_V4_ADDR_AND_MASK *v4AddrMask; + /* [case()][unique] */ FWP_V6_ADDR_AND_MASK *v6AddrMask; + /* [case()][unique] */ FWP_RANGE0 *rangeValue; + } ; + } FWP_CONDITION_VALUE0; + +typedef /* [v1_enum] */ +enum FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE_ + { + FWP_NETWORK_CONNECTION_POLICY_SOURCE_ADDRESS = 0, + FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP_INTERFACE = ( FWP_NETWORK_CONNECTION_POLICY_SOURCE_ADDRESS + 1 ) , + FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP = ( FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP_INTERFACE + 1 ) , + FWP_NETWORK_CONNECTION_POLICY_MAX = ( FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP + 1 ) + } FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE; + +typedef /* [v1_enum] */ +enum FWP_CLASSIFY_OPTION_TYPE_ + { + FWP_CLASSIFY_OPTION_MULTICAST_STATE = 0, + FWP_CLASSIFY_OPTION_LOOSE_SOURCE_MAPPING = ( FWP_CLASSIFY_OPTION_MULTICAST_STATE + 1 ) , + FWP_CLASSIFY_OPTION_UNICAST_LIFETIME = ( FWP_CLASSIFY_OPTION_LOOSE_SOURCE_MAPPING + 1 ) , + FWP_CLASSIFY_OPTION_MCAST_BCAST_LIFETIME = ( FWP_CLASSIFY_OPTION_UNICAST_LIFETIME + 1 ) , + FWP_CLASSIFY_OPTION_SECURE_SOCKET_SECURITY_FLAGS = ( FWP_CLASSIFY_OPTION_MCAST_BCAST_LIFETIME + 1 ) , + FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_MM_POLICY_KEY = ( FWP_CLASSIFY_OPTION_SECURE_SOCKET_SECURITY_FLAGS + 1 ) , + FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_QM_POLICY_KEY = ( FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_MM_POLICY_KEY + 1 ) , + FWP_CLASSIFY_OPTION_LOCAL_ONLY_MAPPING = ( FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_QM_POLICY_KEY + 1 ) , + FWP_CLASSIFY_OPTION_MAX = ( FWP_CLASSIFY_OPTION_LOCAL_ONLY_MAPPING + 1 ) + } FWP_CLASSIFY_OPTION_TYPE; + +#define FWP_OPTION_VALUE_ALLOW_MULTICAST_STATE (0x00000000) +#define FWP_OPTION_VALUE_DENY_MULTICAST_STATE (0x00000001) +#define FWP_OPTION_VALUE_ALLOW_GLOBAL_MULTICAST_STATE (0x00000002) +#define FWP_OPTION_VALUE_DISABLE_LOOSE_SOURCE (0x00000000) +#define FWP_OPTION_VALUE_ENABLE_LOOSE_SOURCE (0x00000001) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWP_OPTION_VALUE_DISABLE_LOCAL_ONLY_MAPPING (0x00000000) +#define FWP_OPTION_VALUE_ENABLE_LOCAL_ONLY_MAPPING (0x00000001) +typedef /* [v1_enum] */ +enum FWP_VSWITCH_NETWORK_TYPE_ + { + FWP_VSWITCH_NETWORK_TYPE_UNKNOWN = 0, + FWP_VSWITCH_NETWORK_TYPE_PRIVATE = ( FWP_VSWITCH_NETWORK_TYPE_UNKNOWN + 1 ) , + FWP_VSWITCH_NETWORK_TYPE_INTERNAL = ( FWP_VSWITCH_NETWORK_TYPE_PRIVATE + 1 ) , + FWP_VSWITCH_NETWORK_TYPE_EXTERNAL = ( FWP_VSWITCH_NETWORK_TYPE_INTERNAL + 1 ) + } FWP_VSWITCH_NETWORK_TYPE; + +#endif +#define FWP_ACTION_FLAG_TERMINATING (0x00001000) +#define FWP_ACTION_FLAG_NON_TERMINATING (0x00002000) +#define FWP_ACTION_FLAG_CALLOUT (0x00004000) +typedef UINT32 FWP_ACTION_TYPE; + +#define FWP_ACTION_BLOCK (0x00000001 | FWP_ACTION_FLAG_TERMINATING) +#define FWP_ACTION_PERMIT (0x00000002 | FWP_ACTION_FLAG_TERMINATING) +#define FWP_ACTION_CALLOUT_TERMINATING (0x00000003 | FWP_ACTION_FLAG_CALLOUT | FWP_ACTION_FLAG_TERMINATING) +#define FWP_ACTION_CALLOUT_INSPECTION (0x00000004 | FWP_ACTION_FLAG_CALLOUT | FWP_ACTION_FLAG_NON_TERMINATING) +#define FWP_ACTION_CALLOUT_UNKNOWN (0x00000005 | FWP_ACTION_FLAG_CALLOUT) +#define FWP_ACTION_CONTINUE (0x00000006 | FWP_ACTION_FLAG_NON_TERMINATING) +#define FWP_ACTION_NONE (0x00000007) +#define FWP_ACTION_NONE_NO_MATCH (0x00000008) +#define FWP_CONDITION_FLAG_IS_LOOPBACK (0x00000001) +#define FWP_CONDITION_FLAG_IS_IPSEC_SECURED (0x00000002) +#define FWP_CONDITION_FLAG_IS_REAUTHORIZE (0x00000004) +#define FWP_CONDITION_FLAG_IS_WILDCARD_BIND (0x00000008) +#define FWP_CONDITION_FLAG_IS_RAW_ENDPOINT (0x00000010) +#define FWP_CONDITION_FLAG_IS_FRAGMENT (0x00000020) +#define FWP_CONDITION_FLAG_IS_FRAGMENT_GROUP (0x00000040) +#define FWP_CONDITION_FLAG_IS_IPSEC_NATT_RECLASSIFY (0x00000080) +#define FWP_CONDITION_FLAG_REQUIRES_ALE_CLASSIFY (0x00000100) +#define FWP_CONDITION_FLAG_IS_IMPLICIT_BIND (0x00000200) +#if (NTDDI_VERSION >= NTDDI_WIN6SP1) +#define FWP_CONDITION_FLAG_IS_REASSEMBLED (0x00000400) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWP_CONDITION_FLAG_IS_NAME_APP_SPECIFIED (0x00004000) +#define FWP_CONDITION_FLAG_IS_PROMISCUOUS (0x00008000) +#define FWP_CONDITION_FLAG_IS_AUTH_FW (0x00010000) +#define FWP_CONDITION_FLAG_IS_RECLASSIFY (0x00020000) +#define FWP_CONDITION_FLAG_IS_OUTBOUND_PASS_THRU (0x00040000) +#define FWP_CONDITION_FLAG_IS_INBOUND_PASS_THRU (0x00080000) +#define FWP_CONDITION_FLAG_IS_CONNECTION_REDIRECTED (0x00100000) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWP_CONDITION_FLAG_IS_PROXY_CONNECTION (0x00200000) +#define FWP_CONDITION_FLAG_IS_APPCONTAINER_LOOPBACK (0x00400000) +#define FWP_CONDITION_FLAG_IS_NON_APPCONTAINER_LOOPBACK (0x00800000) +#define FWP_CONDITION_FLAG_IS_RESERVED (0x01000000) +#define FWP_CONDITION_FLAG_IS_HONORING_POLICY_AUTHORIZE (0x02000000) +#endif +#define FWP_CONDITION_REAUTHORIZE_REASON_POLICY_CHANGE (0x00000001) +#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_ARRIVAL_INTERFACE (0x00000002) +#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_NEXTHOP_INTERFACE (0x00000004) +#define FWP_CONDITION_REAUTHORIZE_REASON_PROFILE_CROSSING (0x00000008) +#define FWP_CONDITION_REAUTHORIZE_REASON_CLASSIFY_COMPLETION (0x00000010) +#define FWP_CONDITION_REAUTHORIZE_REASON_IPSEC_PROPERTIES_CHANGED (0x00000020) +#define FWP_CONDITION_REAUTHORIZE_REASON_MID_STREAM_INSPECTION (0x00000040) +#define FWP_CONDITION_REAUTHORIZE_REASON_SOCKET_PROPERTY_CHANGED (0x00000080) +#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_INBOUND_MCAST_BCAST_PACKET (0x00000100) +#define FWP_CONDITION_REAUTHORIZE_REASON_EDP_POLICY_CHANGED (0x00000200) +#define FWP_CONDITION_REAUTHORIZE_REASON_PROXY_HANDLE_CHANGED (0x00004000) +#define FWP_CONDITION_REAUTHORIZE_REASON_CHECK_OFFLOAD (0x00010000) +#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_IS_SYSTEM_PORT_RPC (0x00000001) +#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_ALLOW_EDGE_TRAFFIC (0x00000002) +#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_DENY_EDGE_TRAFFIC (0x00000004) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWP_CONDITION_L2_IS_NATIVE_ETHERNET (0x00000001) +#define FWP_CONDITION_L2_IS_WIFI (0x00000002) +#define FWP_CONDITION_L2_IS_MOBILE_BROADBAND (0x00000004) +#define FWP_CONDITION_L2_IS_WIFI_DIRECT_DATA (0x00000008) +#define FWP_CONDITION_L2_IS_VM2VM (0x00000010) +#define FWP_CONDITION_L2_IS_MALFORMED_PACKET (0x00000020) +#define FWP_CONDITION_L2_IS_IP_FRAGMENT_GROUP (0x00000040) +#define FWP_CONDITION_L2_IF_CONNECTOR_PRESENT (0x00000080) +#endif +#endif +#endif +typedef /* [v1_enum] */ +enum FWP_FILTER_ENUM_TYPE_ + { + FWP_FILTER_ENUM_FULLY_CONTAINED = 0, + FWP_FILTER_ENUM_OVERLAPPING = ( FWP_FILTER_ENUM_FULLY_CONTAINED + 1 ) , + FWP_FILTER_ENUM_TYPE_MAX = ( FWP_FILTER_ENUM_OVERLAPPING + 1 ) + } FWP_FILTER_ENUM_TYPE; + +#define FWP_FILTER_ENUM_FLAG_BEST_TERMINATING_MATCH (0x00000001) +#define FWP_FILTER_ENUM_FLAG_SORTED (0x00000002) +#define FWP_FILTER_ENUM_FLAG_BOOTTIME_ONLY (0x00000004) +#define FWP_FILTER_ENUM_FLAG_INCLUDE_BOOTTIME (0x00000008) +#define FWP_FILTER_ENUM_FLAG_INCLUDE_DISABLED (0x00000010) +#define FWP_FILTER_ENUM_VALID_FLAGS (FWP_FILTER_ENUM_FLAG_BEST_TERMINATING_MATCH | FWP_FILTER_ENUM_FLAG_SORTED) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWP_FILTER_ENUM_FLAG_RESERVED1 (0x00000020) +#endif +#define FWP_CALLOUT_FLAG_CONDITIONAL_ON_FLOW (0x00000001) +#define FWP_CALLOUT_FLAG_ALLOW_OFFLOAD (0x00000002) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWP_CALLOUT_FLAG_ENABLE_COMMIT_ADD_NOTIFY (0x00000004) +#define FWP_CALLOUT_FLAG_ALLOW_MID_STREAM_INSPECTION (0x00000008) +#define FWP_CALLOUT_FLAG_ALLOW_RECLASSIFY (0x00000010) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWP_CALLOUT_FLAG_RESERVED1 (0x00000020) +#define FWP_CALLOUT_FLAG_ALLOW_RSC (0x00000040) +#define FWP_CALLOUT_FLAG_ALLOW_L2_BATCH_CLASSIFY (0x00000080) +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define FWP_CALLOUT_FLAG_ALLOW_USO (0x00000100) +#if (NTDDI_VERSION >= NTDDI_WIN10_VB) +#define FWP_CALLOUT_FLAG_ALLOW_URO (0x00000200) +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +#define FWP_CALLOUT_FLAG_RESERVED2 (0x00000400) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_VB) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct FWPM_DISPLAY_DATA0_ + { + /* [unique][string] */ wchar_t *name; + /* [unique][string] */ wchar_t *description; + } FWPM_DISPLAY_DATA0; + +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_VIRTUAL_IF_TUNNEL_INFO0_ + { + UINT64 virtualIfTunnelId; + UINT64 trafficSelectorId; + } IPSEC_VIRTUAL_IF_TUNNEL_INFO0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */ +#pragma endregion + + +extern RPC_IF_HANDLE __MIDL_itf_fwptypes_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_fwptypes_0000_0000_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.idl new file mode 100644 index 0000000000000000000000000000000000000000..51e8ac9db47dfa2a547632fd78e776ec5a27f6b4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwptypes.idl @@ -0,0 +1,587 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Defines common data types shared across the FWP/IPsec API. +*/ +cpp_quote("#include ") + +#pragma region Desktop Family or AppRuntime Package +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME)") + + +import "wtypes.idl"; + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(push)") +cpp_quote("#endif") +cpp_quote("#pragma warning(disable:4201)") +cpp_quote("#endif") + +// The system LUID struct isn't defined in wtypes, so we repeat it here just +// for the MIDL compiler. +cpp_quote("#ifdef __midl") +typedef struct _LUID { + DWORD LowPart; + LONG HighPart; +} LUID, *PLUID; +cpp_quote("#endif") + +// Direction of network traffic. +typedef [v1_enum] enum FWP_DIRECTION_ +{ + FWP_DIRECTION_OUTBOUND, + FWP_DIRECTION_INBOUND, + FWP_DIRECTION_MAX +} FWP_DIRECTION; + +// IP version. +typedef [v1_enum] enum FWP_IP_VERSION_ +{ + FWP_IP_VERSION_V4, + FWP_IP_VERSION_V6, + FWP_IP_VERSION_NONE, + FWP_IP_VERSION_MAX, +} FWP_IP_VERSION; + +// This is the hindsight catch-all for all net events that aren't either IPv4 or IPv6. +typedef [v1_enum] enum FWP_NE_FAMILY_ +{ + FWP_AF_INET = FWP_IP_VERSION_V4, + FWP_AF_INET6 = FWP_IP_VERSION_V6, + FWP_AF_ETHER = FWP_IP_VERSION_NONE, + FWP_AF_NONE, +} FWP_AF; + +typedef [v1_enum] enum FWP_ETHER_ENCAP_METHOD_ +{ + FWP_ETHER_ENCAP_METHOD_ETHER_V2 = 0, + FWP_ETHER_ENCAP_METHOD_SNAP = 1, + FWP_ETHER_ENCAP_METHOD_SNAP_W_OUI_ZERO = 3, +} FWP_ETHER_ENCAP_METHOD; + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building data values to be filtered. +// +/////////////////////////////////////////////////////////////////////////////// + +// Data types that can be stored in an FWP_VALUE or an FWP_CONDITION_VALUE +// struct. Not all data types are valid for each struct; see the tagged union +// in each struct to determine which are allowed. +typedef [v1_enum] enum FWP_DATA_TYPE_ +{ + FWP_EMPTY, + FWP_UINT8, + FWP_UINT16, + FWP_UINT32, + FWP_UINT64, + FWP_INT8, + FWP_INT16, + FWP_INT32, + FWP_INT64, + FWP_FLOAT, + FWP_DOUBLE, + FWP_BYTE_ARRAY16_TYPE, + FWP_BYTE_BLOB_TYPE, + FWP_SID, + FWP_SECURITY_DESCRIPTOR_TYPE, + FWP_TOKEN_INFORMATION_TYPE, + FWP_TOKEN_ACCESS_INFORMATION_TYPE, + FWP_UNICODE_STRING_TYPE, + FWP_BYTE_ARRAY6_TYPE, + FWP_SINGLE_DATA_TYPE_MAX = 0xFF, + FWP_V4_ADDR_MASK, + FWP_V6_ADDR_MASK, + FWP_RANGE_TYPE, + FWP_DATA_TYPE_MAX +} FWP_DATA_TYPE; + +cpp_quote("#define FWP_BYTEMAP_ARRAY64_SIZE 8") + +// Stores an array of exactly 6 bytes -- useful for Ethernet/802.11 addresses. +typedef struct FWP_BYTE_ARRAY6_ +{ + UINT8 byteArray6[6]; +} FWP_BYTE_ARRAY6; + +#define FWP_BYTE_ARRAY6_SIZE 6 +cpp_quote("#define FWP_BYTE_ARRAY6_SIZE 6") + +// Stores an array of exactly 16 bytes -- useful for IPv6 addresses. +typedef struct FWP_BYTE_ARRAY16_ +{ + UINT8 byteArray16[16]; +} FWP_BYTE_ARRAY16; + +// Stores an array containing a variable number of bytes. +typedef struct FWP_BYTE_BLOB_ +{ + UINT32 size; + [size_is(size), unique] UINT8* data; +} FWP_BYTE_BLOB; + +// Stores the user/group and restricted sids for user-mode classification +typedef struct FWP_TOKEN_INFORMATION_ +{ + ULONG sidCount; + [size_is(sidCount)] PSID_AND_ATTRIBUTES sids; + ULONG restrictedSidCount; + [size_is(restrictedSidCount)] PSID_AND_ATTRIBUTES restrictedSids; +} FWP_TOKEN_INFORMATION; + +// Generic data value. This is primarily used to supply incoming values to the +// filter engine. +typedef struct FWP_VALUE0_ +{ + FWP_DATA_TYPE type; + [switch_type(FWP_DATA_TYPE), switch_is(type)] + union + { + [case(FWP_EMPTY)] + ; + [case(FWP_UINT8)] + UINT8 uint8; + [case(FWP_UINT16)] + UINT16 uint16; + [case(FWP_UINT32)] + UINT32 uint32; + [case(FWP_UINT64)] + [unique] UINT64* uint64; + [case(FWP_INT8)] + INT8 int8; + [case(FWP_INT16)] + INT16 int16; + [case(FWP_INT32)] + INT32 int32; + [case(FWP_INT64)] + [unique] INT64* int64; + [case(FWP_FLOAT)] + float float32; + [case(FWP_DOUBLE)] + [unique] double* double64; + [case(FWP_BYTE_ARRAY16_TYPE)] + [unique] FWP_BYTE_ARRAY16* byteArray16; + [case(FWP_BYTE_BLOB_TYPE)] + [unique] FWP_BYTE_BLOB* byteBlob; + [case(FWP_SID)] + [unique] SID* sid; + [case(FWP_SECURITY_DESCRIPTOR_TYPE)] + [unique] FWP_BYTE_BLOB* sd; + [case(FWP_TOKEN_INFORMATION_TYPE)] + [unique] FWP_TOKEN_INFORMATION* tokenInformation; + [case(FWP_TOKEN_ACCESS_INFORMATION_TYPE)] + [unique] FWP_BYTE_BLOB* tokenAccessInformation; + [case(FWP_UNICODE_STRING_TYPE)] + [string] LPWSTR unicodeString; + [case(FWP_BYTE_ARRAY6_TYPE)] + [unique] FWP_BYTE_ARRAY6* byteArray6; + }; +} FWP_VALUE0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building conditions. +// +/////////////////////////////////////////////////////////////////////////////// + +// Different match types allowed in conditions. Not all match types are +// supported by all data types. +typedef [v1_enum] enum FWP_MATCH_TYPE_ +{ + FWP_MATCH_EQUAL, + FWP_MATCH_GREATER, + FWP_MATCH_LESS, + FWP_MATCH_GREATER_OR_EQUAL, + FWP_MATCH_LESS_OR_EQUAL, + FWP_MATCH_RANGE, + FWP_MATCH_FLAGS_ALL_SET, + FWP_MATCH_FLAGS_ANY_SET, + FWP_MATCH_FLAGS_NONE_SET, + FWP_MATCH_EQUAL_CASE_INSENSITIVE, + FWP_MATCH_NOT_EQUAL, + FWP_MATCH_PREFIX, + FWP_MATCH_NOT_PREFIX, + FWP_MATCH_TYPE_MAX +} FWP_MATCH_TYPE; + +// IPv4 address and mask in host order. +typedef struct FWP_V4_ADDR_AND_MASK_ +{ + UINT32 addr; + UINT32 mask; +} FWP_V4_ADDR_AND_MASK; + +// Length in bytes of an IPv6 address. +#define FWP_V6_ADDR_SIZE (16) +cpp_quote("#define FWP_V6_ADDR_SIZE (16)") + +// IPv6 address and mask. The mask is specified by the width in bits. For +// example, a prefixLength of 16 specifies a mask consisting of 16 1's followed +// by 112 0's. +typedef struct FWP_V6_ADDR_AND_MASK_ +{ + UINT8 addr[FWP_V6_ADDR_SIZE]; + UINT8 prefixLength; +} FWP_V6_ADDR_AND_MASK; + +// A range of values. valueLow and valueHigh must be the same data type with +// valueHigh >= valueLow. Ranges are always inclusive. Thus, if a value equals +// valueLow or valueHigh, it is contained in the range. +typedef struct FWP_RANGE0_ +{ + FWP_VALUE0 valueLow; + FWP_VALUE0 valueHigh; +} FWP_RANGE0; + +// Access control rights for matching security descriptors in Application +// Level Enforcement (ALE) layers. +cpp_quote("#define FWP_ACTRL_MATCH_FILTER (0x00000001)") +cpp_quote("") + +// Values that conditions can use when testing for matches. The +// FWP_CONDITION_VALUE's data type must be compatible with the type of the +// FWP_VALUE to which it's being compared. However, this doesn't mean they +// necessarily need to be the same. For example, an FWP_V4_ADDR_MASK can be +// compared to an FWP_UINT32 containing an IPv4 address. +typedef struct FWP_CONDITION_VALUE0_ +{ + FWP_DATA_TYPE type; + [switch_type(FWP_DATA_TYPE), switch_is(type)] + union + { + [case(FWP_EMPTY)] + ; + [case(FWP_UINT8)] + UINT8 uint8; + [case(FWP_UINT16)] + UINT16 uint16; + [case(FWP_UINT32)] + UINT32 uint32; + [case(FWP_UINT64)] + [unique] UINT64* uint64; + [case(FWP_INT8)] + INT8 int8; + [case(FWP_INT16)] + INT16 int16; + [case(FWP_INT32)] + INT32 int32; + [case(FWP_INT64)] + [unique] INT64* int64; + [case(FWP_FLOAT)] + float float32; + [case(FWP_DOUBLE)] + [unique] double* double64; + [case(FWP_BYTE_ARRAY16_TYPE)] + [unique] FWP_BYTE_ARRAY16* byteArray16; + [case(FWP_BYTE_BLOB_TYPE)] + [unique] FWP_BYTE_BLOB* byteBlob; + [case(FWP_SID)] + [unique] SID* sid; + [case(FWP_SECURITY_DESCRIPTOR_TYPE)] + [unique] FWP_BYTE_BLOB* sd; + [case(FWP_TOKEN_INFORMATION_TYPE)] + [unique] FWP_TOKEN_INFORMATION* tokenInformation; + [case(FWP_TOKEN_ACCESS_INFORMATION_TYPE)] + [unique] FWP_BYTE_BLOB* tokenAccessInformation; + [case(FWP_UNICODE_STRING_TYPE)] + [string] LPWSTR unicodeString; + [case(FWP_BYTE_ARRAY6_TYPE)] + [unique] FWP_BYTE_ARRAY6* byteArray6; + [case(FWP_V4_ADDR_MASK)] + [unique] FWP_V4_ADDR_AND_MASK* v4AddrMask; + [case(FWP_V6_ADDR_MASK)] + [unique] FWP_V6_ADDR_AND_MASK* v6AddrMask; + [case(FWP_RANGE_TYPE)] + [unique] FWP_RANGE0* rangeValue; + }; +} FWP_CONDITION_VALUE0; + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for Network Connection Policy options. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef [v1_enum] enum FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE_ +{ + FWP_NETWORK_CONNECTION_POLICY_SOURCE_ADDRESS, + FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP_INTERFACE, + FWP_NETWORK_CONNECTION_POLICY_NEXT_HOP, + FWP_NETWORK_CONNECTION_POLICY_MAX, +} FWP_NETWORK_CONNECTION_POLICY_SETTING_TYPE; + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for classify options. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef [v1_enum] enum FWP_CLASSIFY_OPTION_TYPE_ +{ + FWP_CLASSIFY_OPTION_MULTICAST_STATE, + FWP_CLASSIFY_OPTION_LOOSE_SOURCE_MAPPING, + FWP_CLASSIFY_OPTION_UNICAST_LIFETIME, + FWP_CLASSIFY_OPTION_MCAST_BCAST_LIFETIME, + FWP_CLASSIFY_OPTION_SECURE_SOCKET_SECURITY_FLAGS, + FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_MM_POLICY_KEY, + FWP_CLASSIFY_OPTION_SECURE_SOCKET_AUTHIP_QM_POLICY_KEY, + FWP_CLASSIFY_OPTION_LOCAL_ONLY_MAPPING, + FWP_CLASSIFY_OPTION_MAX, +} FWP_CLASSIFY_OPTION_TYPE; + +// Valid values for different classify options. +cpp_quote("#define FWP_OPTION_VALUE_ALLOW_MULTICAST_STATE (0x00000000)") +cpp_quote("#define FWP_OPTION_VALUE_DENY_MULTICAST_STATE (0x00000001)") +cpp_quote("#define FWP_OPTION_VALUE_ALLOW_GLOBAL_MULTICAST_STATE (0x00000002)") + +cpp_quote("#define FWP_OPTION_VALUE_DISABLE_LOOSE_SOURCE (0x00000000)") +cpp_quote("#define FWP_OPTION_VALUE_ENABLE_LOOSE_SOURCE (0x00000001)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#define FWP_OPTION_VALUE_DISABLE_LOCAL_ONLY_MAPPING (0x00000000)") +cpp_quote("#define FWP_OPTION_VALUE_ENABLE_LOCAL_ONLY_MAPPING (0x00000001)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Types for vSwitch filtering. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef [v1_enum] enum FWP_VSWITCH_NETWORK_TYPE_ +{ + FWP_VSWITCH_NETWORK_TYPE_UNKNOWN, + FWP_VSWITCH_NETWORK_TYPE_PRIVATE, + FWP_VSWITCH_NETWORK_TYPE_INTERNAL, + FWP_VSWITCH_NETWORK_TYPE_EXTERNAL +} FWP_VSWITCH_NETWORK_TYPE; + +cpp_quote("#endif") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building actions. +// +/////////////////////////////////////////////////////////////////////////////// + +////////// +// Flags specifying characteristics of a given action type. These should +// generally not be used directly. Use one of the action types below instead. +////////// + +// The action terminates classification, i.e., it returns block or permit. +cpp_quote("#define FWP_ACTION_FLAG_TERMINATING (0x00001000)") +// The action doesn't terminate classification, i.e., it never returns block or +// permit. +cpp_quote("#define FWP_ACTION_FLAG_NON_TERMINATING (0x00002000)") +// The action invokes a callout. +cpp_quote("#define FWP_ACTION_FLAG_CALLOUT (0x00004000)") + +////////// +// Actions that can be set in the FWPM_ACTION0.type or FWPS_ACTION.type fields. +////////// + +typedef UINT32 FWP_ACTION_TYPE; + +// Block the traffic. +cpp_quote("#define FWP_ACTION_BLOCK (0x00000001 | FWP_ACTION_FLAG_TERMINATING)") + +// Permit the traffic. +cpp_quote("#define FWP_ACTION_PERMIT (0x00000002 | FWP_ACTION_FLAG_TERMINATING)") + +// Invoke a callout that always returns block or permit. +cpp_quote("#define FWP_ACTION_CALLOUT_TERMINATING (0x00000003 | FWP_ACTION_FLAG_CALLOUT | FWP_ACTION_FLAG_TERMINATING)") + +// Invoke a callout that never returns block or permit. +cpp_quote("#define FWP_ACTION_CALLOUT_INSPECTION (0x00000004 | FWP_ACTION_FLAG_CALLOUT | FWP_ACTION_FLAG_NON_TERMINATING)") + +// Invoke a callout that may return block or permit. +cpp_quote("#define FWP_ACTION_CALLOUT_UNKNOWN (0x00000005 | FWP_ACTION_FLAG_CALLOUT)") + +////////// +// Additional actions that may be returned by callouts. They can not be set in +// an FWPM_ACTION0 or FWPS_ACTION struct. +////////// + +cpp_quote("#define FWP_ACTION_CONTINUE (0x00000006 | FWP_ACTION_FLAG_NON_TERMINATING)") + +////////// +// Additional actions that may be returned by classify. These are only used to +// indicate the outcome of a classify. They can not be set in an FWPM_ACTION0 +// or FWPS_ACTION struct or returned by a callout from its classify function. +////////// + +// No matching filter generated a terminating action (i.e., block or permit). +cpp_quote("#define FWP_ACTION_NONE (0x00000007)") + +// No filter matched. +cpp_quote("#define FWP_ACTION_NONE_NO_MATCH (0x00000008)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for flags that can be filtered against on certain layers. +// +/////////////////////////////////////////////////////////////////////////////// + +cpp_quote("#define FWP_CONDITION_FLAG_IS_LOOPBACK (0x00000001)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_IPSEC_SECURED (0x00000002)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_REAUTHORIZE (0x00000004)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_WILDCARD_BIND (0x00000008)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_RAW_ENDPOINT (0x00000010)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_FRAGMENT (0x00000020)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_FRAGMENT_GROUP (0x00000040)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_IPSEC_NATT_RECLASSIFY (0x00000080)") +cpp_quote("#define FWP_CONDITION_FLAG_REQUIRES_ALE_CLASSIFY (0x00000100)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_IMPLICIT_BIND (0x00000200)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN6SP1)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_REASSEMBLED (0x00000400)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_NAME_APP_SPECIFIED (0x00004000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_PROMISCUOUS (0x00008000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_AUTH_FW (0x00010000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_RECLASSIFY (0x00020000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_OUTBOUND_PASS_THRU (0x00040000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_INBOUND_PASS_THRU (0x00080000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_CONNECTION_REDIRECTED (0x00100000)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_PROXY_CONNECTION (0x00200000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_APPCONTAINER_LOOPBACK (0x00400000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_NON_APPCONTAINER_LOOPBACK (0x00800000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_RESERVED (0x01000000)") +cpp_quote("#define FWP_CONDITION_FLAG_IS_HONORING_POLICY_AUTHORIZE (0x02000000)") +cpp_quote("#endif") + +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_POLICY_CHANGE (0x00000001)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_ARRIVAL_INTERFACE (0x00000002)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_NEXTHOP_INTERFACE (0x00000004)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_PROFILE_CROSSING (0x00000008)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_CLASSIFY_COMPLETION (0x00000010)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_IPSEC_PROPERTIES_CHANGED (0x00000020)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_MID_STREAM_INSPECTION (0x00000040)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_SOCKET_PROPERTY_CHANGED (0x00000080)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_NEW_INBOUND_MCAST_BCAST_PACKET (0x00000100)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_EDP_POLICY_CHANGED (0x00000200)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_PROXY_HANDLE_CHANGED (0x00004000)") +cpp_quote("#define FWP_CONDITION_REAUTHORIZE_REASON_CHECK_OFFLOAD (0x00010000)") + +cpp_quote("#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_IS_SYSTEM_PORT_RPC (0x00000001)") +cpp_quote("#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_ALLOW_EDGE_TRAFFIC (0x00000002)") +cpp_quote("#define FWP_CONDITION_SOCKET_PROPERTY_FLAG_DENY_EDGE_TRAFFIC (0x00000004)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWP_CONDITION_L2_IS_NATIVE_ETHERNET (0x00000001)") +cpp_quote("#define FWP_CONDITION_L2_IS_WIFI (0x00000002)") +cpp_quote("#define FWP_CONDITION_L2_IS_MOBILE_BROADBAND (0x00000004)") +cpp_quote("#define FWP_CONDITION_L2_IS_WIFI_DIRECT_DATA (0x00000008)") +cpp_quote("#define FWP_CONDITION_L2_IS_VM2VM (0x00000010)") +cpp_quote("#define FWP_CONDITION_L2_IS_MALFORMED_PACKET (0x00000020)") +cpp_quote("#define FWP_CONDITION_L2_IS_IP_FRAGMENT_GROUP (0x00000040)") +cpp_quote("#define FWP_CONDITION_L2_IF_CONNECTOR_PRESENT (0x00000080)") + +cpp_quote("#endif") + +cpp_quote("#endif") +cpp_quote("#endif") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for enumerating filters. +// +/////////////////////////////////////////////////////////////////////////////// + +// Specifies how the filter enum conditions should be interpreted. +typedef [v1_enum] enum FWP_FILTER_ENUM_TYPE_ +{ + // Return only filters that fully contain the enum conditions. + FWP_FILTER_ENUM_FULLY_CONTAINED, + // Return filters that overlap with the enum conditions, including filters + // that are fully contained. + FWP_FILTER_ENUM_OVERLAPPING, + FWP_FILTER_ENUM_TYPE_MAX +} FWP_FILTER_ENUM_TYPE; + +////////// +// Flags controlling how filters matching an enum are returned. +////////// + +// Only return the terminating filter with the highest weight. +cpp_quote("#define FWP_FILTER_ENUM_FLAG_BEST_TERMINATING_MATCH (0x00000001)") +// Return all matching filters sorted by weight (highest to lowest). +cpp_quote("#define FWP_FILTER_ENUM_FLAG_SORTED (0x00000002)") +// Return only boot-time filters. +cpp_quote("#define FWP_FILTER_ENUM_FLAG_BOOTTIME_ONLY (0x00000004)") +// Include boot-time filters; ignored if the BOOTTIME_ONLY flag is set. +cpp_quote("#define FWP_FILTER_ENUM_FLAG_INCLUDE_BOOTTIME (0x00000008)") +// Include disabled filters; ignored if the BOOTTIME_ONLY flag is set. +cpp_quote("#define FWP_FILTER_ENUM_FLAG_INCLUDE_DISABLED (0x00000010)") + +// Valid enum flags. If no flags are set, all matching filters will be returned +// in an unspecified order. +cpp_quote("#define FWP_FILTER_ENUM_VALID_FLAGS (FWP_FILTER_ENUM_FLAG_BEST_TERMINATING_MATCH | FWP_FILTER_ENUM_FLAG_SORTED)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWP_FILTER_ENUM_FLAG_RESERVED1 (0x00000020)") +cpp_quote("#endif") + +cpp_quote("#define FWP_CALLOUT_FLAG_CONDITIONAL_ON_FLOW (0x00000001)") +// Flags that the callout doesn't mind not being called in the presence +// of various offloads +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_OFFLOAD (0x00000002)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Enable add notification after transaction has committed +cpp_quote("#define FWP_CALLOUT_FLAG_ENABLE_COMMIT_ADD_NOTIFY (0x00000004)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_MID_STREAM_INSPECTION (0x00000008)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_RECLASSIFY (0x00000010)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#define FWP_CALLOUT_FLAG_RESERVED1 (0x00000020)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_RSC (0x00000040)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_L2_BATCH_CLASSIFY (0x00000080)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_19H1)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_USO (0x00000100)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_VB)") +cpp_quote("#define FWP_CALLOUT_FLAG_ALLOW_URO (0x00000200)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_CO)") +cpp_quote("#define FWP_CALLOUT_FLAG_RESERVED2 (0x00000400)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_VB)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Stores an optional friendly name and description for an object. In order to +// support MUI, both strings may contain indirect strings (see +// SHLoadIndirectString for details). + +typedef struct FWPM_DISPLAY_DATA0_ +{ + [string, unique] wchar_t* name; + [string, unique] wchar_t* description; +} FWPM_DISPLAY_DATA0; + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(pop)") +cpp_quote("#else") +cpp_quote("#pragma warning(default:4201)") +cpp_quote("#endif") +cpp_quote("#endif") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Type containing information specific to virtual interface tunneling. +// Currently this is only supported by IKEv2. +typedef struct IPSEC_VIRTUAL_IF_TUNNEL_INFO0_ +{ + // ID/Handle to Virtual-IF tunnel state. + UINT64 virtualIfTunnelId; + // ID/Handle to Virtual-IF traffic selector(s). + UINT64 trafficSelectorId; +} IPSEC_VIRTUAL_IF_TUNNEL_INFO0; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */") +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpvi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpvi.h new file mode 100644 index 0000000000000000000000000000000000000000..d417a6516f5cc4d66328bec28545a84adf6ddf3b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/fwpvi.h @@ -0,0 +1,847 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Declares version independent definitions for the FWP API. +*/ +#include "sdkddkver.h" + +#if (NTDDI_VERSION >= NTDDI_WIN6) +#ifndef FWPVI_H +#define FWPVI_H +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Fwpmtypes. +// +/////////////////////////////////////////////////////////////////////////////// +#define FWPM_DISPLAY_DATA FWPM_DISPLAY_DATA0 +#define FWPM_SESSION FWPM_SESSION0 +#define FWPM_SESSION_ENUM_TEMPLATE FWPM_SESSION_ENUM_TEMPLATE0 +#define FWPM_PROVIDER FWPM_PROVIDER0 +#define FWPM_PROVIDER_ENUM_TEMPLATE FWPM_PROVIDER_ENUM_TEMPLATE0 +#define FWPM_PROVIDER_CHANGE FWPM_PROVIDER_CHANGE0 +#define FWPM_PROVIDER_SUBSCRIPTION FWPM_PROVIDER_SUBSCRIPTION0 +#define FWPM_CLASSIFY_OPTION FWPM_CLASSIFY_OPTION0 +#define FWPM_CLASSIFY_OPTIONS FWPM_CLASSIFY_OPTIONS0 + +#define FWPM_NETWORK_CONNECTION_POLICY_SETTING FWPM_NETWORK_CONNECTION_POLICY_SETTING0 +#define FWPM_NETWORK_CONNECTION_POLICY_SETTINGS FWPM_NETWORK_CONNECTION_POLICY_SETTINGS0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FWPM_PROVIDER_CONTEXT FWPM_PROVIDER_CONTEXT3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_PROVIDER_CONTEXT FWPM_PROVIDER_CONTEXT2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_PROVIDER_CONTEXT FWPM_PROVIDER_CONTEXT1 +#else +#define FWPM_PROVIDER_CONTEXT FWPM_PROVIDER_CONTEXT0 +#endif +#define FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0 +#define FWPM_PROVIDER_CONTEXT_CHANGE FWPM_PROVIDER_CONTEXT_CHANGE0 +#define FWPM_PROVIDER_CONTEXT_SUBSCRIPTION FWPM_PROVIDER_CONTEXT_SUBSCRIPTION0 +#define FWPM_SUBLAYER FWPM_SUBLAYER0 +#define FWPM_SUBLAYER_ENUM_TEMPLATE FWPM_SUBLAYER_ENUM_TEMPLATE0 +#define FWPM_SUBLAYER_CHANGE FWPM_SUBLAYER_CHANGE0 +#define FWPM_SUBLAYER_SUBSCRIPTION FWPM_SUBLAYER_SUBSCRIPTION0 +#define FWPM_FIELD FWPM_FIELD0 +#define FWPM_LAYER FWPM_LAYER0 +#define FWPM_LAYER_ENUM_TEMPLATE FWPM_LAYER_ENUM_TEMPLATE0 +#define FWPM_CALLOUT FWPM_CALLOUT0 +#define FWPM_CALLOUT_ENUM_TEMPLATE FWPM_CALLOUT_ENUM_TEMPLATE0 +#define FWPM_CALLOUT_CHANGE FWPM_CALLOUT_CHANGE0 +#define FWPM_CALLOUT_SUBSCRIPTION FWPM_CALLOUT_SUBSCRIPTION0 +#define FWPM_ACTION FWPM_ACTION0 +#define FWPM_FILTER_CONDITION FWPM_FILTER_CONDITION0 +#define FWPM_FILTER FWPM_FILTER0 +#define FWPM_FILTER_ENUM_TEMPLATE FWPM_FILTER_ENUM_TEMPLATE0 +#define FWPM_FILTER_CHANGE FWPM_FILTER_CHANGE0 +#define FWPM_FILTER_SUBSCRIPTION FWPM_FILTER_SUBSCRIPTION0 +#define FWPM_LAYER_STATISTICS FWPM_LAYER_STATISTICS0 +#define FWPM_STATISTICS FWPM_STATISTICS0 +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define FWPM_NET_EVENT_HEADER FWPM_NET_EVENT_HEADER3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_NET_EVENT_HEADER FWPM_NET_EVENT_HEADER2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_NET_EVENT_HEADER FWPM_NET_EVENT_HEADER1 +#else +#define FWPM_NET_EVENT_HEADER FWPM_NET_EVENT_HEADER0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE FWPM_NET_EVENT_IKEEXT_MM_FAILURE2 +#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE FWPM_NET_EVENT_IKEEXT_MM_FAILURE1 +#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE FWPM_NET_EVENT_IKEEXT_EM_FAILURE1 +#else +#define FWPM_NET_EVENT_IKEEXT_MM_FAILURE FWPM_NET_EVENT_IKEEXT_MM_FAILURE0 +#define FWPM_NET_EVENT_IKEEXT_EM_FAILURE FWPM_NET_EVENT_IKEEXT_EM_FAILURE0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FWPM_NET_EVENT_IKEEXT_QM_FAILURE FWPM_NET_EVENT_IKEEXT_QM_FAILURE1 +#else +#define FWPM_NET_EVENT_IKEEXT_QM_FAILURE FWPM_NET_EVENT_IKEEXT_QM_FAILURE0 +#endif +#define FWPM_NET_EVENT_IPSEC_KERNEL_DROP FWPM_NET_EVENT_IPSEC_KERNEL_DROP0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_NET_EVENT_CLASSIFY_DROP FWPM_NET_EVENT_CLASSIFY_DROP2 +#define FWPM_NET_EVENT_CLASSIFY_DROP_MAC FWPM_NET_EVENT_CLASSIFY_DROP_MAC0 +#define FWPM_NET_EVENT_IPSEC_DOSP_DROP FWPM_NET_EVENT_IPSEC_DOSP_DROP0 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_NET_EVENT_CLASSIFY_DROP FWPM_NET_EVENT_CLASSIFY_DROP1 +#define FWPM_NET_EVENT_IPSEC_DOSP_DROP FWPM_NET_EVENT_IPSEC_DOSP_DROP0 +#else +#define FWPM_NET_EVENT_CLASSIFY_DROP FWPM_NET_EVENT_CLASSIFY_DROP0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_NET_EVENT_CLASSIFY_ALLOW FWPM_NET_EVENT_CLASSIFY_ALLOW0 +#define FWPM_NET_EVENT_CAPABILITY_DROP FWPM_NET_EVENT_CAPABILITY_DROP0 +#define FWPM_NET_EVENT_CAPABILITY_ALLOW FWPM_NET_EVENT_CAPABILITY_ALLOW0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) //NTDDI_WIN10_RS5 +#define FWPM_NET_EVENT_LPM_PACKET_ARRIVAL FWPM_NET_EVENT_LPM_PACKET_ARRIVAL0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) //NTDDI_WIN10_RS5 +#define FWPM_NET_EVENT FWPM_NET_EVENT5 +#elif (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FWPM_NET_EVENT FWPM_NET_EVENT4 +#elif (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define FWPM_NET_EVENT FWPM_NET_EVENT3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_NET_EVENT FWPM_NET_EVENT2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_NET_EVENT FWPM_NET_EVENT1 +#else +#define FWPM_NET_EVENT FWPM_NET_EVENT0 +#endif + + +#define FWPM_NET_EVENT_ENUM_TEMPLATE FWPM_NET_EVENT_ENUM_TEMPLATE0 +#define FWPM_NET_EVENT_SUBSCRIPTION FWPM_NET_EVENT_SUBSCRIPTION0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_SYSTEM_PORTS_BY_TYPE FWPM_SYSTEM_PORTS_BY_TYPE0 +#define FWPM_SYSTEM_PORTS FWPM_SYSTEM_PORTS0 +#endif + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Fwpstypes. +// +/////////////////////////////////////////////////////////////////////////////// +#define FWPS_FILTER_CONDITION FWPS_FILTER_CONDITION0 +#define FWPS_ACTION FWPS_ACTION0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FWPS_FILTER FWPS_FILTER3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_FILTER FWPS_FILTER2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_FILTER FWPS_FILTER1 +#else +#define FWPS_FILTER FWPS_FILTER0 +#endif +#define FWPS_INCOMING_VALUE FWPS_INCOMING_VALUE0 +#define FWPS_INCOMING_VALUES FWPS_INCOMING_VALUES0 +#define FWPS_DISCARD_METADATA FWPS_DISCARD_METADATA0 +#define FWPS_INBOUND_FRAGMENT_METADATA FWPS_INBOUND_FRAGMENT_METADATA0 +#define FWPS_CLASSIFY_OUT FWPS_CLASSIFY_OUT0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_ALE_ENDPOINT_PROPERTIES FWPS_ALE_ENDPOINT_PROPERTIES0 +#define FWPS_ALE_ENDPOINT_ENUM_TEMPLATE FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0 +#endif + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Fwptypes. +// +/////////////////////////////////////////////////////////////////////////////// +#define FWP_VALUE FWP_VALUE0 +#define FWP_RANGE FWP_RANGE0 +#define FWP_CONDITION_VALUE FWP_CONDITION_VALUE0 + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Iketypes. +// +/////////////////////////////////////////////////////////////////////////////// +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_PRESHARED_KEY_AUTHENTICATION IKEEXT_PRESHARED_KEY_AUTHENTICATION1 +#else +#define IKEEXT_PRESHARED_KEY_AUTHENTICATION IKEEXT_PRESHARED_KEY_AUTHENTICATION0 +#endif +#define IKEEXT_CERT_ROOT_CONFIG IKEEXT_CERT_ROOT_CONFIG0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERTIFICATE_AUTHENTICATION IKEEXT_CERTIFICATE_AUTHENTICATION2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_CERTIFICATE_AUTHENTICATION IKEEXT_CERTIFICATE_AUTHENTICATION1 +#else +#define IKEEXT_CERTIFICATE_AUTHENTICATION IKEEXT_CERTIFICATE_AUTHENTICATION0 +#endif +#define IKEEXT_IPV6_CGA_AUTHENTICATION IKEEXT_IPV6_CGA_AUTHENTICATION0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_KERBEROS_AUTHENTICATION IKEEXT_KERBEROS_AUTHENTICATION1 +#else +#define IKEEXT_KERBEROS_AUTHENTICATION IKEEXT_KERBEROS_AUTHENTICATION0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_RESERVED_AUTHENTICATION IKEEXT_RESERVED_AUTHENTICATION0 +#endif +#define IKEEXT_NTLM_V2_AUTHENTICATION IKEEXT_NTLM_V2_AUTHENTICATION0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_EAP_AUTHENTICATION IKEEXT_EAP_AUTHENTICATION0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_AUTHENTICATION_METHOD IKEEXT_AUTHENTICATION_METHOD2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_AUTHENTICATION_METHOD IKEEXT_AUTHENTICATION_METHOD1 +#else +#define IKEEXT_AUTHENTICATION_METHOD IKEEXT_AUTHENTICATION_METHOD0 +#endif +#define IKEEXT_CIPHER_ALGORITHM IKEEXT_CIPHER_ALGORITHM0 +#define IKEEXT_INTEGRITY_ALGORITHM IKEEXT_INTEGRITY_ALGORITHM0 +#define IKEEXT_PROPOSAL IKEEXT_PROPOSAL0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_POLICY IKEEXT_POLICY2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_POLICY IKEEXT_POLICY1 +#else +#define IKEEXT_POLICY IKEEXT_POLICY0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_EM_POLICY IKEEXT_EM_POLICY2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_EM_POLICY IKEEXT_EM_POLICY1 +#else +#define IKEEXT_EM_POLICY IKEEXT_EM_POLICY0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1 +#else +#define IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_KEYMODULE_STATISTICS IKEEXT_KEYMODULE_STATISTICS1 +#else +#define IKEEXT_KEYMODULE_STATISTICS IKEEXT_KEYMODULE_STATISTICS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1 +#else +#define IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_COMMON_STATISTICS IKEEXT_COMMON_STATISTICS1 +#else +#define IKEEXT_COMMON_STATISTICS IKEEXT_COMMON_STATISTICS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_STATISTICS IKEEXT_STATISTICS1 +#else +#define IKEEXT_STATISTICS IKEEXT_STATISTICS0 +#endif +#define IKEEXT_TRAFFIC IKEEXT_TRAFFIC0 +#define IKEEXT_COOKIE_PAIR IKEEXT_COOKIE_PAIR0 +#define IKEEXT_NAME_CREDENTIAL IKEEXT_NAME_CREDENTIAL0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERTIFICATE_CREDENTIAL IKEEXT_CERTIFICATE_CREDENTIAL1 +#define IKEEXT_CREDENTIAL IKEEXT_CREDENTIAL2 +#define IKEEXT_CREDENTIAL_PAIR IKEEXT_CREDENTIAL_PAIR2 +#define IKEEXT_CREDENTIALS IKEEXT_CREDENTIALS2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_CERTIFICATE_CREDENTIAL IKEEXT_CERTIFICATE_CREDENTIAL1 +#define IKEEXT_CREDENTIAL IKEEXT_CREDENTIAL1 +#define IKEEXT_CREDENTIAL_PAIR IKEEXT_CREDENTIAL_PAIR1 +#define IKEEXT_CREDENTIALS IKEEXT_CREDENTIALS1 +#else +#define IKEEXT_CERTIFICATE_CREDENTIAL IKEEXT_CERTIFICATE_CREDENTIAL0 +#define IKEEXT_CREDENTIAL IKEEXT_CREDENTIAL0 +#define IKEEXT_CREDENTIAL_PAIR IKEEXT_CREDENTIAL_PAIR0 +#define IKEEXT_CREDENTIALS IKEEXT_CREDENTIALS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_SA_DETAILS IKEEXT_SA_DETAILS2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_SA_DETAILS IKEEXT_SA_DETAILS1 +#else +#define IKEEXT_SA_DETAILS IKEEXT_SA_DETAILS0 +#endif +#define IKEEXT_SA_ENUM_TEMPLATE IKEEXT_SA_ENUM_TEMPLATE0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERT_EKUS IKEEXT_CERT_EKUS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERT_NAME IKEEXT_CERT_NAME0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERTIFICATE_CRITERIA IKEEXT_CERTIFICATE_CRITERIA0 +#endif + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Ipsectypes. +// +/////////////////////////////////////////////////////////////////////////////// +#define IPSEC_SA_LIFETIME IPSEC_SA_LIFETIME0 +#define IPSEC_AUTH_TRANSFORM_ID IPSEC_AUTH_TRANSFORM_ID0 +#define IPSEC_AUTH_TRANSFORM IPSEC_AUTH_TRANSFORM0 +#define IPSEC_CIPHER_TRANSFORM_ID IPSEC_CIPHER_TRANSFORM_ID0 +#define IPSEC_CIPHER_TRANSFORM IPSEC_CIPHER_TRANSFORM0 +#define IPSEC_AUTH_AND_CIPHER_TRANSFORM IPSEC_AUTH_AND_CIPHER_TRANSFORM0 +#define IPSEC_SA_TRANSFORM IPSEC_SA_TRANSFORM0 +#define IPSEC_PROPOSAL IPSEC_PROPOSAL0 +#define IPSEC_SA_IDLE_TIMEOUT IPSEC_SA_IDLE_TIMEOUT0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define IPSEC_TUNNEL_POLICY IPSEC_TUNNEL_POLICY3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_TUNNEL_POLICY IPSEC_TUNNEL_POLICY2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_TUNNEL_POLICY IPSEC_TUNNEL_POLICY1 +#else +#define IPSEC_TUNNEL_POLICY IPSEC_TUNNEL_POLICY0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_TRANSPORT_POLICY IPSEC_TRANSPORT_POLICY2 +#define IPSEC_TUNNEL_ENDPOINT IPSEC_TUNNEL_ENDPOINT0 +#define IPSEC_TUNNEL_ENDPOINTS IPSEC_TUNNEL_ENDPOINTS2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_TRANSPORT_POLICY IPSEC_TRANSPORT_POLICY1 +#define IPSEC_TUNNEL_ENDPOINTS IPSEC_TUNNEL_ENDPOINTS1 +#else +#define IPSEC_TRANSPORT_POLICY IPSEC_TRANSPORT_POLICY0 +#define IPSEC_TUNNEL_ENDPOINTS IPSEC_TUNNEL_ENDPOINTS0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_KEYING_POLICY IPSEC_KEYING_POLICY1 +#else +#define IPSEC_KEYING_POLICY IPSEC_KEYING_POLICY0 +#endif +#define IPSEC_AGGREGATE_SA_STATISTICS IPSEC_AGGREGATE_SA_STATISTICS0 +#define IPSEC_ESP_DROP_PACKET_STATISTICS IPSEC_ESP_DROP_PACKET_STATISTICS0 +#define IPSEC_AH_DROP_PACKET_STATISTICS IPSEC_AH_DROP_PACKET_STATISTICS0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_AGGREGATE_DROP_PACKET_STATISTICS IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1 +#define IPSEC_TRAFFIC_STATISTICS IPSEC_TRAFFIC_STATISTICS1 +#define IPSEC_STATISTICS IPSEC_STATISTICS1 +#else +#define IPSEC_AGGREGATE_DROP_PACKET_STATISTICS IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0 +#define IPSEC_TRAFFIC_STATISTICS IPSEC_TRAFFIC_STATISTICS0 +#define IPSEC_STATISTICS IPSEC_STATISTICS0 +#endif +#define IPSEC_SA_AUTH_INFORMATION IPSEC_SA_AUTH_INFORMATION0 +#define IPSEC_SA_CIPHER_INFORMATION IPSEC_SA_CIPHER_INFORMATION0 +#define IPSEC_SA_AUTH_AND_CIPHER_INFORMATION IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0 +#define IPSEC_SA IPSEC_SA0 +#define IPSEC_KEYMODULE_STATE IPSEC_KEYMODULE_STATE0 +#define IPSEC_TOKEN IPSEC_TOKEN0 +#define IPSEC_ID IPSEC_ID0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_TRAFFIC IPSEC_TRAFFIC1 +#define IPSEC_SA_BUNDLE IPSEC_SA_BUNDLE1 +#else +#define IPSEC_TRAFFIC IPSEC_TRAFFIC0 +#define IPSEC_SA_BUNDLE IPSEC_SA_BUNDLE0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define IPSEC_TRAFFIC_SELECTOR IPSEC_TRAFFIC_SELECTOR0 +#define IPSEC_TRAFFIC_SELECTOR_POLICY IPSEC_TRAFFIC_SELECTOR_POLICY0 +#endif +#define IPSEC_V4_UDP_ENCAPSULATION IPSEC_V4_UDP_ENCAPSULATION0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_GETSPI IPSEC_GETSPI1 +#define IPSEC_SA_DETAILS IPSEC_SA_DETAILS1 +#define IPSEC_SA_CONTEXT IPSEC_SA_CONTEXT1 +#else +#define IPSEC_GETSPI IPSEC_GETSPI0 +#define IPSEC_SA_DETAILS IPSEC_SA_DETAILS0 +#define IPSEC_SA_CONTEXT IPSEC_SA_CONTEXT0 +#endif +#define IPSEC_SA_CONTEXT_ENUM_TEMPLATE IPSEC_SA_CONTEXT_ENUM_TEMPLATE0 +#define IPSEC_SA_ENUM_TEMPLATE IPSEC_SA_ENUM_TEMPLATE0 +#define IPSEC_ADDRESS_INFO IPSEC_ADDRESS_INFO0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_VIRTUAL_IF_TUNNEL_INFO IPSEC_VIRTUAL_IF_TUNNEL_INFO0 +#define IPSEC_DOSP_OPTIONS IPSEC_DOSP_OPTIONS0 +#define IPSEC_DOSP_STATISTICS IPSEC_DOSP_STATISTICS0 +#define IPSEC_DOSP_STATE IPSEC_DOSP_STATE0 +#define IPSEC_DOSP_STATE_ENUM_TEMPLATE IPSEC_DOSP_STATE_ENUM_TEMPLATE0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_KEY_MANAGER IPSEC_KEY_MANAGER0 +#define IPSEC_KEY_MANAGER_CALLBACKS IPSEC_KEY_MANAGER_CALLBACKS0 +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Fwpmu / Fwpmk +// +/////////////////////////////////////////////////////////////////////////////// +#define FWPM_SERVICE_STATE_CHANGE_CALLBACK FWPM_SERVICE_STATE_CHANGE_CALLBACK0 +#define FwpmFreeMemory FwpmFreeMemory0 +#define FwpmBfeStateGet FwpmBfeStateGet0 +#define FwpmBfeStateSubscribeChanges FwpmBfeStateSubscribeChanges0 +#define FwpmBfeStateUnsubscribeChanges FwpmBfeStateUnsubscribeChanges0 +#define FwpmEngineOpen FwpmEngineOpen0 +#define FwpmEngineClose FwpmEngineClose0 +#define FwpmEngineGetOption FwpmEngineGetOption0 +#define FwpmEngineSetOption FwpmEngineSetOption0 +#define FwpmEngineGetSecurityInfo FwpmEngineGetSecurityInfo0 +#define FwpmEngineSetSecurityInfo FwpmEngineSetSecurityInfo0 +#define FwpmSessionCreateEnumHandle FwpmSessionCreateEnumHandle0 +#define FwpmSessionEnum FwpmSessionEnum0 +#define FwpmSessionDestroyEnumHandle FwpmSessionDestroyEnumHandle0 +#define FwpmTransactionBegin FwpmTransactionBegin0 +#define FwpmTransactionCommit FwpmTransactionCommit0 +#define FwpmTransactionAbort FwpmTransactionAbort0 +#define FwpmProviderAdd FwpmProviderAdd0 +#define FwpmProviderDeleteByKey FwpmProviderDeleteByKey0 +#define FwpmProviderGetByKey FwpmProviderGetByKey0 +#define FwpmProviderCreateEnumHandle FwpmProviderCreateEnumHandle0 +#define FwpmProviderEnum FwpmProviderEnum0 +#define FwpmProviderDestroyEnumHandle FwpmProviderDestroyEnumHandle0 +#define FwpmProviderGetSecurityInfoByKey FwpmProviderGetSecurityInfoByKey0 +#define FwpmProviderSetSecurityInfoByKey FwpmProviderSetSecurityInfoByKey0 +#define FWPM_PROVIDER_CHANGE_CALLBACK FWPM_PROVIDER_CHANGE_CALLBACK0 +#define FwpmProviderSubscribeChanges FwpmProviderSubscribeChanges0 +#define FwpmProviderUnsubscribeChanges FwpmProviderUnsubscribeChanges0 +#define FwpmProviderSubscriptionsGet FwpmProviderSubscriptionsGet0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FwpmProviderContextAdd FwpmProviderContextAdd3 +#define FwpmProviderContextGetById FwpmProviderContextGetById3 +#define FwpmProviderContextGetByKey FwpmProviderContextGetByKey3 +#define FwpmProviderContextEnum FwpmProviderContextEnum3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FwpmProviderContextAdd FwpmProviderContextAdd2 +#define FwpmProviderContextGetById FwpmProviderContextGetById2 +#define FwpmProviderContextGetByKey FwpmProviderContextGetByKey2 +#define FwpmProviderContextEnum FwpmProviderContextEnum2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpmProviderContextAdd FwpmProviderContextAdd1 +#define FwpmProviderContextGetById FwpmProviderContextGetById1 +#define FwpmProviderContextGetByKey FwpmProviderContextGetByKey1 +#define FwpmProviderContextEnum FwpmProviderContextEnum1 +#else +#define FwpmProviderContextAdd FwpmProviderContextAdd0 +#define FwpmProviderContextGetById FwpmProviderContextGetById0 +#define FwpmProviderContextGetByKey FwpmProviderContextGetByKey0 +#define FwpmProviderContextEnum FwpmProviderContextEnum0 +#endif +#define FwpmProviderContextDeleteById FwpmProviderContextDeleteById0 +#define FwpmProviderContextDeleteByKey FwpmProviderContextDeleteByKey0 +#define FwpmProviderContextCreateEnumHandle FwpmProviderContextCreateEnumHandle0 +#define FwpmProviderContextDestroyEnumHandle FwpmProviderContextDestroyEnumHandle0 +#define FwpmProviderContextGetSecurityInfoByKey FwpmProviderContextGetSecurityInfoByKey0 +#define FwpmProviderContextSetSecurityInfoByKey FwpmProviderContextSetSecurityInfoByKey0 +#define FWPM_PROVIDER_CONTEXT_CHANGE_CALLBACK FWPM_PROVIDER_CONTEXT_CHANGE_CALLBACK0 +#define FwpmProviderContextSubscribeChanges FwpmProviderContextSubscribeChanges0 +#define FwpmProviderContextUnsubscribeChanges FwpmProviderContextUnsubscribeChanges0 +#define FwpmProviderContextSubscriptionsGet FwpmProviderContextSubscriptionsGet0 +#define FwpmSubLayerAdd FwpmSubLayerAdd0 +#define FwpmSubLayerDeleteByKey FwpmSubLayerDeleteByKey0 +#define FwpmSubLayerGetByKey FwpmSubLayerGetByKey0 +#define FwpmSubLayerCreateEnumHandle FwpmSubLayerCreateEnumHandle0 +#define FwpmSubLayerEnum FwpmSubLayerEnum0 +#define FwpmSubLayerDestroyEnumHandle FwpmSubLayerDestroyEnumHandle0 +#define FwpmSubLayerGetSecurityInfoByKey FwpmSubLayerGetSecurityInfoByKey0 +#define FwpmSubLayerSetSecurityInfoByKey FwpmSubLayerSetSecurityInfoByKey0 +#define FWPM_SUBLAYER_CHANGE_CALLBACK FWPM_SUBLAYER_CHANGE_CALLBACK0 +#define FwpmSubLayerSubscribeChanges FwpmSubLayerSubscribeChanges0 +#define FwpmSubLayerUnsubscribeChanges FwpmSubLayerUnsubscribeChanges0 +#define FwpmSubLayerSubscriptionsGet FwpmSubLayerSubscriptionsGet0 +#define FwpmLayerGetById FwpmLayerGetById0 +#define FwpmLayerGetByKey FwpmLayerGetByKey0 +#define FwpmLayerCreateEnumHandle FwpmLayerCreateEnumHandle0 +#define FwpmLayerEnum FwpmLayerEnum0 +#define FwpmLayerDestroyEnumHandle FwpmLayerDestroyEnumHandle0 +#define FwpmLayerGetSecurityInfoByKey FwpmLayerGetSecurityInfoByKey0 +#define FwpmLayerSetSecurityInfoByKey FwpmLayerSetSecurityInfoByKey0 +#define FwpmCalloutAdd FwpmCalloutAdd0 +#define FwpmCalloutDeleteById FwpmCalloutDeleteById0 +#define FwpmCalloutDeleteByKey FwpmCalloutDeleteByKey0 +#define FwpmCalloutGetById FwpmCalloutGetById0 +#define FwpmCalloutGetByKey FwpmCalloutGetByKey0 +#define FwpmCalloutCreateEnumHandle FwpmCalloutCreateEnumHandle0 +#define FwpmCalloutEnum FwpmCalloutEnum0 +#define FwpmCalloutDestroyEnumHandle FwpmCalloutDestroyEnumHandle0 +#define FwpmCalloutGetSecurityInfoByKey FwpmCalloutGetSecurityInfoByKey0 +#define FwpmCalloutSetSecurityInfoByKey FwpmCalloutSetSecurityInfoByKey0 +#define FWPM_CALLOUT_CHANGE_CALLBACK FWPM_CALLOUT_CHANGE_CALLBACK0 +#define FwpmCalloutSubscribeChanges FwpmCalloutSubscribeChanges0 +#define FwpmCalloutUnsubscribeChanges FwpmCalloutUnsubscribeChanges0 +#define FwpmCalloutSubscriptionsGet FwpmCalloutSubscriptionsGet0 +#define FwpmFilterAdd FwpmFilterAdd0 +#define FwpmFilterDeleteById FwpmFilterDeleteById0 +#define FwpmFilterDeleteByKey FwpmFilterDeleteByKey0 +#define FwpmFilterGetById FwpmFilterGetById0 +#define FwpmFilterGetByKey FwpmFilterGetByKey0 +#define FwpmFilterCreateEnumHandle FwpmFilterCreateEnumHandle0 +#define FwpmFilterEnum FwpmFilterEnum0 +#define FwpmFilterDestroyEnumHandle FwpmFilterDestroyEnumHandle0 +#define FwpmFilterGetSecurityInfoByKey FwpmFilterGetSecurityInfoByKey0 +#define FwpmFilterSetSecurityInfoByKey FwpmFilterSetSecurityInfoByKey0 +#define FWPM_FILTER_CHANGE_CALLBACK FWPM_FILTER_CHANGE_CALLBACK0 +#define FwpmFilterSubscribeChanges FwpmFilterSubscribeChanges0 +#define FwpmFilterUnsubscribeChanges FwpmFilterUnsubscribeChanges0 +#define FwpmFilterSubscriptionsGet FwpmFilterSubscriptionsGet0 +#define FwpmGetAppIdFromFileName FwpmGetAppIdFromFileName0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FwpmIPsecTunnelAdd FwpmIPsecTunnelAdd3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FwpmIPsecTunnelAdd FwpmIPsecTunnelAdd2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpmIPsecTunnelAdd FwpmIPsecTunnelAdd1 +#else +#define FwpmIPsecTunnelAdd FwpmIPsecTunnelAdd0 +#endif +#define FwpmIPsecTunnelDeleteByKey FwpmIPsecTunnelDeleteByKey0 +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define FwpsVirtualIfTunnelInfoGet FwpsVirtualIfTunnelInfoGet0 +#define FwpsVirtualIfTunnelInfoSet FwpsVirtualIfTunnelInfoSet0 +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecGetStatistics IPsecGetStatistics1 +#define IPsecSaContextCreate IPsecSaContextCreate1 +#else +#define IPsecGetStatistics IPsecGetStatistics0 +#define IPsecSaContextCreate IPsecSaContextCreate0 +#endif +#define IPsecSaContextDeleteById IPsecSaContextDeleteById0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecSaContextGetById IPsecSaContextGetById1 +#define IPsecSaContextGetSpi IPsecSaContextGetSpi1 +#define IPsecSaContextSetSpi IPsecSaContextSetSpi0 +#define IPsecSaContextAddInbound IPsecSaContextAddInbound1 +#define IPsecSaContextAddOutbound IPsecSaContextAddOutbound1 +#else +#define IPsecSaContextGetById IPsecSaContextGetById0 +#define IPsecSaContextGetSpi IPsecSaContextGetSpi0 +#define IPsecSaContextAddInbound IPsecSaContextAddInbound0 +#define IPsecSaContextAddOutbound IPsecSaContextAddOutbound0 +#endif +#define IPsecSaContextExpire IPsecSaContextExpire0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecSaContextUpdate IPsecSaContextUpdate0 +#endif +#define IPsecSaContextCreateEnumHandle IPsecSaContextCreateEnumHandle0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecSaContextEnum IPsecSaContextEnum1 +#else +#define IPsecSaContextEnum IPsecSaContextEnum0 +#endif +#define IPsecSaContextDestroyEnumHandle IPsecSaContextDestroyEnumHandle0 +#define IPsecSaCreateEnumHandle IPsecSaCreateEnumHandle0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecSaEnum IPsecSaEnum1 +#else +#define IPsecSaEnum IPsecSaEnum0 +#endif +#define IPsecSaDestroyEnumHandle IPsecSaDestroyEnumHandle0 +#define IPsecSaDbGetSecurityInfo IPsecSaDbGetSecurityInfo0 +#define IPsecSaDbSetSecurityInfo IPsecSaDbSetSecurityInfo0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPsecDospGetStatistics IPsecDospGetStatistics0 +#define IPsecDospStateCreateEnumHandle IPsecDospStateCreateEnumHandle0 +#define IPsecDospStateEnum IPsecDospStateEnum0 +#define IPsecDospStateDestroyEnumHandle IPsecDospStateDestroyEnumHandle0 +#define IPsecDospGetSecurityInfo IPsecDospGetSecurityInfo0 +#define IPsecDospSetSecurityInfo IPsecDospSetSecurityInfo0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IkeextGetStatistics IkeextGetStatistics1 +#else +#define IkeextGetStatistics IkeextGetStatistics0 +#endif +#define IkeextSaDeleteById IkeextSaDeleteById0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IkeextSaGetById IkeextSaGetById2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IkeextSaGetById IkeextSaGetById1 +#else +#define IkeextSaGetById IkeextSaGetById0 +#endif +#define IkeextSaCreateEnumHandle IkeextSaCreateEnumHandle0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IkeextSaEnum IkeextSaEnum2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define IkeextSaEnum IkeextSaEnum1 +#else +#define IkeextSaEnum IkeextSaEnum0 +#endif +#define IkeextSaDestroyEnumHandle IkeextSaDestroyEnumHandle0 +#define IkeextSaDbGetSecurityInfo IkeextSaDbGetSecurityInfo0 +#define IkeextSaDbSetSecurityInfo IkeextSaDbSetSecurityInfo0 +#define FwpmNetEventCreateEnumHandle FwpmNetEventCreateEnumHandle0 +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) //NTDDI_WIN10_RS5 +#define FwpmNetEventEnum FwpmNetEventEnum5 +#elif (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FwpmNetEventEnum FwpmNetEventEnum4 +#elif (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define FwpmNetEventEnum FwpmNetEventEnum3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FwpmNetEventEnum FwpmNetEventEnum2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpmNetEventEnum FwpmNetEventEnum1 +#else +#define FwpmNetEventEnum FwpmNetEventEnum0 +#endif +#define FwpmNetEventDestroyEnumHandle FwpmNetEventDestroyEnumHandle0 +#define FwpmNetEventsGetSecurityInfo FwpmNetEventsGetSecurityInfo0 +#define FwpmNetEventsSetSecurityInfo FwpmNetEventsSetSecurityInfo0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) //NTDDI_WIN10_RS5 +#define FWPM_NET_EVENT_CALLBACK FWPM_NET_EVENT_CALLBACK4 +#define FwpmNetEventSubscribe FwpmNetEventSubscribe4 +#elif (NTDDI_VERSION >= NTDDI_WIN10_RS4) +#define FWPM_NET_EVENT_CALLBACK FWPM_NET_EVENT_CALLBACK3 +#define FwpmNetEventSubscribe FwpmNetEventSubscribe3 +#elif (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define FWPM_NET_EVENT_CALLBACK FWPM_NET_EVENT_CALLBACK2 +#define FwpmNetEventSubscribe FwpmNetEventSubscribe2 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_NET_EVENT_CALLBACK FWPM_NET_EVENT_CALLBACK1 +#define FwpmNetEventSubscribe FwpmNetEventSubscribe1 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPM_NET_EVENT_CALLBACK FWPM_NET_EVENT_CALLBACK0 +#define FwpmNetEventSubscribe FwpmNetEventSubscribe0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpmNetEventUnsubscribe FwpmNetEventUnsubscribe0 +#define FwpmNetEventSubscriptionsGet FwpmNetEventSubscriptionsGet0 +#define FwpmSystemPortsGet FwpmSystemPortsGet0 +#define FWPM_SYSTEM_PORTS_CALLBACK FWPM_SYSTEM_PORTS_CALLBACK0 +#define FwpmSystemPortsSubscribe FwpmSystemPortsSubscribe0 +#define FwpmSystemPortsUnsubscribe FwpmSystemPortsUnsubscribe0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +#define FWPM_DYNAMIC_KEYWORD_CALLBACK FWPM_DYNAMIC_KEYWORD_CALLBACK0 +#define FwpmDynamicKeywordSubscribe FwpmDynamicKeywordSubscribe0 +#define FwpmDynamicKeywordUnsubscribe FwpmDynamicUnsubscribe0 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_KEY_MANAGER_KEY_DICTATION_CHECK IPSEC_KEY_MANAGER_KEY_DICTATION_CHECK0 +#define IPSEC_KEY_MANAGER_DICTATE_KEY IPSEC_KEY_MANAGER_DICTATE_KEY0 +#define IPSEC_KEY_MANAGER_NOTIFY_KEY IPSEC_KEY_MANAGER_NOTIFY_KEY0 +#define IPsecKeyManagerAddAndRegister IPsecKeyManagerAddAndRegister0 +#define IPsecKeyManagerUnregisterAndDelete IPsecKeyManagerUnregisterAndDelete0 +#define IPsecKeyManagersGet IPsecKeyManagersGet0 +#define IPsecKeyManagerGetSecurityInfoByKey IPsecKeyManagerGetSecurityInfoByKey0 +#define IPsecKeyManagerSetSecurityInfoByKey IPsecKeyManagerSetSecurityInfoByKey0 +#endif +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPM_CONNECTION FWPM_CONNECTION0 +#define FWPM_CONNECTION_ENUM_TEMPLATE FWPM_CONNECTION_ENUM_TEMPLATE0 +#define FWPM_CONNECTION_SUBSCRIPTION FWPM_CONNECTION_SUBSCRIPTION0 +#define FWPM_CONNECTION_CALLBACK FWPM_CONNECTION_CALLBACK0 +#define FWPM_VSWITCH_EVENT FWPM_VSWITCH_EVENT0 +#define FWPM_VSWITCH_EVENT_SUBSCRIPTION FWPM_VSWITCH_EVENT_SUBSCRIPTION0 +#define FWPM_VSWITCH_EVENT_CALLBACK FWPM_VSWITCH_EVENT_CALLBACK0 +#define FwpmConnectionSubscribe FwpmConnectionSubscribe0 +#define FwpmConnectionUnsubscribe FwpmConnectionUnsubscribe0 +#define FwpmConnectionGetById FwpmConnectionGetById0 +#define FwpmConnectionEnum FwpmConnectionEnum0 +#define FwpmConnectionCreateEnumHandle FwpmConnectionCreateEnumHandle0 +#define FwpmConnectionDestroyEnumHandle FwpmConnectionDestroyEnumHandle0 +#define FwpmConnectionSubscriptionsGet FwpmConnectionSubscriptionsGet0 +#define FwpmConnectionGetSecurityInfo FwpmConnectionGetSecurityInfo0 +#define FwpmConnectionSetSecurityInfo FwpmConnectionSetSecurityInfo0 +#define FwpmvSwitchEventSubscribe FwpmvSwitchEventSubscribe0 +#define FwpmvSwitchEventUnsubscribe FwpmvSwitchEventUnsubscribe0 +#define FwpmvSwitchEventsGetSecurityInfo FwpmvSwitchEventsGetSecurityInfo0 +#define FwpmvSwitchEventsSetSecurityInfo FwpmvSwitchEventsSetSecurityInfo0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_SA_CONTEXT_SUBSCRIPTION IPSEC_SA_CONTEXT_SUBSCRIPTION0 +#define IPSEC_SA_CONTEXT_EVENT_TYPE IPSEC_SA_CONTEXT_EVENT_TYPE0 +#define IPSEC_SA_CONTEXT_CHANGE IPSEC_SA_CONTEXT_CHANGE0 +#define IPsecSaContextSubscribe IPsecSaContextSubscribe0 +#define IPsecSaContextUnsubscribe IPsecSaContextUnsubscribe0 +#define IPsecSaContextSubscriptionsGet IPsecSaContextSubscriptionsGet0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define FwpmConnectionPolicyAdd FwpmConnectionPolicyAdd0 +#define FwpmConnectionPolicyDeleteByKey FwpmConnectionPolicyDeleteByKey0 +#endif + +/////////////////////////////////////////////////////////////////////////////// +// +// Version independent definitions for Fwpsu / Fwpsk +// +/////////////////////////////////////////////////////////////////////////////// +#define FWPS_INCOMING_METADATA_VALUES FWPS_INCOMING_METADATA_VALUES0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FWPS_CALLOUT_CLASSIFY_FN FWPS_CALLOUT_CLASSIFY_FN3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_CALLOUT_CLASSIFY_FN FWPS_CALLOUT_CLASSIFY_FN2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_CALLOUT_CLASSIFY_FN FWPS_CALLOUT_CLASSIFY_FN1 +#else +#define FWPS_CALLOUT_CLASSIFY_FN FWPS_CALLOUT_CLASSIFY_FN0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FWPS_CALLOUT_NOTIFY_FN FWPS_CALLOUT_NOTIFY_FN3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_CALLOUT_NOTIFY_FN FWPS_CALLOUT_NOTIFY_FN2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_CALLOUT_NOTIFY_FN FWPS_CALLOUT_NOTIFY_FN1 +#else +#define FWPS_CALLOUT_NOTIFY_FN FWPS_CALLOUT_NOTIFY_FN0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#define FWPS_CALLOUT_FLOW_DELETE_NOTIFY_FN FWPS_CALLOUT_FLOW_DELETE_NOTIFY_FN0 +#define FWPS_CALLOUT_BOOTTIME_CALLOUT_DELETE_NOTIFY_FN FWPS_CALLOUT_BOOTTIME_CALLOUT_DELETE_NOTIFY_FN0 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FWPS_CALLOUT FWPS_CALLOUT3 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_CALLOUT FWPS_CALLOUT2 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_CALLOUT FWPS_CALLOUT1 +#else +#define FWPS_CALLOUT FWPS_CALLOUT0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_VSWITCH_LIFETIME_EVENT_CALLBACK FWPS_VSWITCH_LIFETIME_EVENT_CALLBACK0 +#define FWPS_VSWITCH_PORT_EVENT_CALLBACK FWPS_VSWITCH_PORT_EVENT_CALLBACK0 +#define FWPS_VSWITCH_INTERFACE_EVENT_CALLBACK FWPS_VSWITCH_INTERFACE_EVENT_CALLBACK0; +#define FWPS_VSWITCH_FILTER_ENGINE_REORDER_CALLBACK FWPS_VSWITCH_FILTER_ENGINE_REORDER_CALLBACK0 +#define FWPS_VSWITCH_POLICY_EVENT_CALLBACK FWPS_VSWITCH_POLICY_EVENT_CALLBACK0 +#define FWPS_VSWITCH_RUNTIME_STATE_SAVE_CALLBACK FWPS_VSWITCH_RUNTIME_STATE_SAVE_CALLBACK0 +#define FWPS_VSWITCH_RUNTIME_STATE_RESTORE_CALLBACK FWPS_VSWITCH_RUNTIME_STATE_RESTORE_CALLBACK0 +#define FWPS_VSWITCH_EVENT_DISPATCH_TABLE FWPS_VSWITCH_EVENT_DISPATCH_TABLE0 +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define FwpsCalloutRegister FwpsCalloutRegister3 +#define FwpsvSwitchEventsSubscribe FwpsvSwitchEventsSubscribe0 +#define FwpsvSwitchEventsUnsubscribe FwpsvSwitchEventsUnsubscribe0 +#define FwpsvSwitchNotifyComplete FwpsvSwitchNotifyComplete0 +#elif (NTDDI_VERSION >= NTDDI_WIN8) +#define FwpsCalloutRegister FwpsCalloutRegister2 +#define FwpsvSwitchEventsSubscribe FwpsvSwitchEventsSubscribe0 +#define FwpsvSwitchEventsUnsubscribe FwpsvSwitchEventsUnsubscribe0 +#define FwpsvSwitchNotifyComplete FwpsvSwitchNotifyComplete0 +#elif (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpsCalloutRegister FwpsCalloutRegister1 +#else +#define FwpsCalloutRegister FwpsCalloutRegister0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#define FwpsCalloutUnregisterById FwpsCalloutUnregisterById0 +#define FwpsCalloutUnregisterByKey FwpsCalloutUnregisterByKey0 +#define FwpsFlowAssociateContext FwpsFlowAssociateContext0 +#define FwpsFlowRemoveContext FwpsFlowRemoveContext0 +#define FWPS_PACKET_LIST_INBOUND_IPSEC_INFORMATION FWPS_PACKET_LIST_INBOUND_IPSEC_INFORMATION0 +#define FWPS_PACKET_LIST_OUTBOUND_IPSEC_INFORMATION FWPS_PACKET_LIST_OUTBOUND_IPSEC_INFORMATION0 +#define FWPS_PACKET_LIST_IPSEC_INFORMATION FWPS_PACKET_LIST_IPSEC_INFORMATION0 +#define FWPS_PACKET_LIST_FWP_INFORMATION FWPS_PACKET_LIST_FWP_INFORMATION0 +#define FWPS_PACKET_LIST_INFORMATION FWPS_PACKET_LIST_INFORMATION0 +#define FwpsGetPacketListSecurityInformation FwpsGetPacketListSecurityInformation0 +#define FwpsPendOperation FwpsPendOperation0 +#define FwpsCompleteOperation FwpsCompleteOperation0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpsAcquireClassifyHandle FwpsAcquireClassifyHandle0 +#define FwpsReleaseClassifyHandle FwpsReleaseClassifyHandle0 +#define FwpsPendClassify FwpsPendClassify0 +#define FwpsCompleteClassify FwpsCompleteClassify0 +#define FwpsAcquireWritableLayerDataPointer FwpsAcquireWritableLayerDataPointer0 +#define FwpsApplyModifiedLayerData FwpsApplyModifiedLayerData0 +#define FWPS_CONNECT_REQUEST FWPS_CONNECT_REQUEST0 +#define FWPS_CONNECTION_POLICY FWPS_CONNECTION_POLICY0 +#define FWPS_BIND_REQUEST FWPS_BIND_REQUEST0 +#define FWPS_NET_BUFFER_LIST_EVENT_TYPE FWPS_NET_BUFFER_LIST_EVENT_TYPE0 +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FWPS_NET_BUFFER_LIST_NOTIFY_FN FWPS_NET_BUFFER_LIST_NOTIFY_FN1 +#define FwpsNetBufferListAssociateContext FwpsNetBufferListAssociateContext1 +#define FwpsFlowAbort FwpsFlowAbort0 +#else +#define FWPS_NET_BUFFER_LIST_NOTIFY_FN FWPS_NET_BUFFER_LIST_NOTIFY_FN0 +#define FwpsNetBufferListAssociateContext FwpsNetBufferListAssociateContext0 +#endif +#define FwpsNetBufferListGetTagForContext FwpsNetBufferListGetTagForContext0 +#define FwpsNetBufferListRetrieveContext FwpsNetBufferListRetrieveContext0 +#define FwpsNetBufferListRemoveContext FwpsNetBufferListRemoveContext0 +#define FwpsOpenToken FwpsOpenToken0 +#define FwpsAleEndpointGetById FwpsAleEndpointGetById0 +#define FwpsAleEndpointCreateEnumHandle FwpsAleEndpointCreateEnumHandle0 +#define FwpsAleEndpointEnum FwpsAleEndpointEnum0 +#define FwpsAleEndpointDestroyEnumHandle FwpsAleEndpointDestroyEnumHandle0 +#define FwpsAleEndpointGetSecurityInfo FwpsAleEndpointGetSecurityInfo0 +#define FwpsAleEndpointSetSecurityInfo FwpsAleEndpointSetSecurityInfo0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#define FwpsClassifyOptionSet FwpsClassifyOptionSet0 +#define FwpsInjectionHandleCreate FwpsInjectionHandleCreate0 +#define FwpsInjectionHandleDestroy FwpsInjectionHandleDestroy0 +#define FWPS_INJECT_COMPLETE FWPS_INJECT_COMPLETE0 +#define FwpsAllocateNetBufferAndNetBufferList FwpsAllocateNetBufferAndNetBufferList0 +#define FwpsFreeNetBufferList FwpsFreeNetBufferList0 +#define FwpsAllocateCloneNetBufferList FwpsAllocateCloneNetBufferList0 +#define FwpsFreeCloneNetBufferList FwpsFreeCloneNetBufferList0 +#define FwpsReassembleForwardFragmentGroup FwpsReassembleForwardFragmentGroup0 +#define FwpsInjectNetworkSendAsync FwpsInjectNetworkSendAsync0 +#define FwpsInjectForwardAsync FwpsInjectForwardAsync0 +#define FwpsConstructIpHeaderForTransportPacket FwpsConstructIpHeaderForTransportPacket0 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define FWPS_TRANSPORT_SEND_PARAMS FWPS_TRANSPORT_SEND_PARAMS1 +#define FwpsInjectTransportSendAsync FwpsInjectTransportSendAsync1 +#else +#define FWPS_TRANSPORT_SEND_PARAMS FWPS_TRANSPORT_SEND_PARAMS0 +#define FwpsInjectTransportSendAsync FwpsInjectTransportSendAsync0 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define FwpsInjectMacSendAsync FwpsInjectMacSendAsync0 +#define FwpsInjectMacReceiveAsync FwpsInjectMacReceiveAsync0 +#define FwpsInjectvSwitchEthernetIngressAsync FwpsInjectvSwitchEthernetIngressAsync0 +#define FwpsReferencevSwitchPacketContext FwpsReferencevSwitchPacketContext0 +#define FwpsDereferencevSwitchPacketContext FwpsDereferencevSwitchPacketContext0 +#define FwpsRedirectHandleCreate FwpsRedirectHandleCreate0 +#define FwpsRedirectHandleDestroy FwpsRedirectHandleDestroy0 +#define FwpsQueryConnectionRedirectState FwpsQueryConnectionRedirectState0 +#define FwpsQueryConnectionSioFormatRedirectRecords FwpsQueryConnectionSioFormatRedirectRecords0 +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +#define FWPS_CALLOUT_CLASSIFY_FN_FAST FWPS_CALLOUT_CLASSIFY_FN_FAST0 +#define FWPS_CALLOUT_FAST FWPS_CALLOUT_FAST0 +#endif //(NTDDI_VERSION >= NTDDI_WINBLUE) + +#define FwpsInjectTransportReceiveAsync FwpsInjectTransportReceiveAsync0 +#define FwpsInjectNetworkReceiveAsync FwpsInjectNetworkReceiveAsync0 +#define FwpsReferenceNetBufferList FwpsReferenceNetBufferList0 +#define FwpsDereferenceNetBufferList FwpsDereferenceNetBufferList0 +#define FwpsQueryPacketInjectionState FwpsQueryPacketInjectionState0 +#define FWPS_STREAM_DATA_OFFSET FWPS_STREAM_DATA_OFFSET0 +#define FWPS_STREAM_DATA FWPS_STREAM_DATA0 +#define FWPS_STREAM_CALLOUT_IO_PACKET FWPS_STREAM_CALLOUT_IO_PACKET0 +#define FwpsStreamInjectAsync FwpsStreamInjectAsync0 +#define FwpsStreamContinue FwpsStreamContinue0 +#define FwpsCopyStreamDataToBuffer FwpsCopyStreamDataToBuffer0 +#define FwpsCloneStreamData FwpsCloneStreamData0 +#define FwpsDiscardClonedStreamData FwpsDiscardClonedStreamData0 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // FWPVI_H +#endif // (NTDDI_VERSION >= NTDDI_WIN6) + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gnssdriver.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gnssdriver.h new file mode 100644 index 0000000000000000000000000000000000000000..19d1f95490468f29c894a41a226b96ebd1178764 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gnssdriver.h @@ -0,0 +1,1323 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + + THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR + PURPOSE. + +Module Name: + + GnssDriver.h + +Abstract: + + Defines the interfaces, IOCTL codes and data structures for the GNSS device driver + +Environment: + + User mode or Kernel mode + +--*/ +#pragma once + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) /* ABRACADABRA_THRESHOLD */ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma warning(push) +#pragma warning(disable : 4201) // Disable compiler warning C4201: nameless struct/union + +// +// Current DDK Version (Major): Version 6 +// +// Changes in Version 6 (requires GNSS Driver to compile with this version of the DDK header): +// - Support additional accuracy and higher precision data +// +// Changes in Version 5 (requires GNSS Driver to compile with this version of the DDK header): +// - Added service indicator in GNSS_SUPL_VERSION interface +// +// Changes in Version 4 (requires GNSS Driver to compile with this version of the DDK header): +// - Added breadcrumbing interface +// +// Changes in Version 3 (requires GNSS Driver to compile with this version of the DDK header): +// - Removed unused fields +// - Support for Galileo +// - Support for driver to get out-of-band data +// +// Changes in Version 2 (requires GNSS Driver to compile with this version of the DDK header): +// - Geofence Support +// - Support for Beidou +// - SUPL support enhancements (Multiple Root Certificates, Emergency Call Location Support) +// +// +// Previous DDK Versions : Version 1 +// Version 2 +// Version 3 +// Version 4 +// Version 5 +// + +// +// Define Driver Versions +// + +#define GNSS_DRIVER_VERSION_1 1 +#define GNSS_DRIVER_VERSION_2 2 +#define GNSS_DRIVER_VERSION_3 3 +#define GNSS_DRIVER_VERSION_4 4 +#define GNSS_DRIVER_VERSION_5 5 +#define GNSS_DRIVER_VERSION_6 6 + +// +// Define GNSS IOCTL Codes +// + +#define IOCTL_GNSS_SEND_PLATFORM_CAPABILITY CTL_CODE(FILE_DEVICE_UNKNOWN, 0x001, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_GET_DEVICE_CAPABILITY CTL_CODE(FILE_DEVICE_UNKNOWN, 0x002, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_SEND_DRIVERCOMMAND CTL_CODE(FILE_DEVICE_UNKNOWN, 0x003, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_START_FIXSESSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x010, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_MODIFY_FIXSESSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x011, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_STOP_FIXSESSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x012, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_GET_FIXDATA CTL_CODE(FILE_DEVICE_UNKNOWN, 0x013, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_INJECT_AGNSS CTL_CODE(FILE_DEVICE_UNKNOWN, 0x020, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_AGNSS CTL_CODE(FILE_DEVICE_UNKNOWN, 0x030, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_ERROR CTL_CODE(FILE_DEVICE_UNKNOWN, 0x031, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_NI CTL_CODE(FILE_DEVICE_UNKNOWN, 0x040, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_SET_SUPL_HSLP CTL_CODE(FILE_DEVICE_UNKNOWN, 0x041, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_CONFIG_SUPL_CERT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x042, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_RESPOND_NI CTL_CODE(FILE_DEVICE_UNKNOWN, 0x043, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_EXECUTE_CWTEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x044, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_EXECUTE_SELFTEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x045, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_GET_CHIPSETINFO CTL_CODE(FILE_DEVICE_UNKNOWN, 0x046, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_NMEA CTL_CODE(FILE_DEVICE_UNKNOWN, 0x047, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_SET_V2UPL_CONFIG CTL_CODE(FILE_DEVICE_UNKNOWN, 0x048, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_GNSS_CREATE_GEOFENCE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x050, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_DELETE_GEOFENCE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x051, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_GEOFENCE_ALERT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_GEOFENCES_TRACKINGSTATUS CTL_CODE(FILE_DEVICE_UNKNOWN, 0x053, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_GNSS_LISTEN_DRIVER_REQUEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x060, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_GNSS_START_BREADCRUMBING CTL_CODE(FILE_DEVICE_UNKNOWN, 0x070, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_STOP_BREADCRUMBING CTL_CODE(FILE_DEVICE_UNKNOWN, 0x071, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_LISTEN_BREADCRUMBING_ALERT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x072, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_GNSS_POP_BREADCRUMBS CTL_CODE(FILE_DEVICE_UNKNOWN, 0x073, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Define the commonly used AGNSS Formats +// Some of these formats are supported by specific IHVs only +// + +#define GNSS_AGNSSFORMAT_XTRA1 0x01 +#define GNSS_AGNSSFORMAT_XTRA2 0x02 +#define GNSS_AGNSSFORMAT_LTO 0x04 +#define GNSS_AGNSSFORMAT_XTRA3 0x08 +#define GNSS_AGNSSFORMAT_XTRA3_1 0x10 +#define GNSS_AGNSSFORMAT_XTRA3_2 0x20 +#define GNSS_AGNSSFORMAT_XTRA_INT 0x40 + +// +// Device Interface GUID for GNSS device +// + +// {3336e5e4-018a-4669-84c5-bd05f3bd368b} +DEFINE_GUID(GUID_DEVINTERFACE_GNSS, 0x3336e5e4, 0x18a, 0x4669, 0x84, 0xc5, 0xbd, 0x5, 0xf3, 0xbd, 0x36, 0x8b); + +// +// Define max server URL name. It is 256 uchars plus some ending spaces. +// +// + +#define MAX_SERVER_URL_NAME 260 + +// +// Define minimum number of geofences supported to be able to use native Geofencing. +// +// + +#define MIN_GEOFENCES_REQUIRED 100 + +// +// Enumerate all versions of Breadcrumbs +// +// + +#define BREADCRUMBING_UNSUPPORTED 0 +#define BREADCRUMBING_VERSION_1 1 + +// +// Define the minimum number of breadcrumbs that must be stored in order for a driver +// to be considered conforming to the breadcrumbing portions of the interface +// +// + +#define MIN_BREADCRUMBS_SUPPORTED 120 + +// +// Define structure for SUPL version +// + +typedef struct +{ + ULONG MajorVersion; + ULONG MinorVersion; +} GNSS_SUPL_VERSION, *PGNSS_SUPL_VERSION; + +// +// Define structure for SUPL version 2 +// + +typedef struct +{ + ULONG MajorVersion; + ULONG MinorVersion; + ULONG ServiceIndicator; +} GNSS_SUPL_VERSION_2, *PGNSS_SUPL_VERSION_2; + +// +// Data structure for Driver Capabilities +// + +typedef struct +{ + ULONG Size; + + // The version number of this structure is the DDK version against which the GNSS Driver is developed + + ULONG Version; + + // Session Management + + BOOL SupportMultipleFixSessions; + BOOL SupportMultipleAppSessions; + + // AGNSS + BOOL RequireAGnssInjection; + ULONG AgnssFormatSupported; + ULONG AgnssFormatPreferred; + + // Tracking support + BOOL SupportDistanceTracking; + BOOL SupportContinuousTracking; + + // Reserved fields for future use + + ULONG Reserved1; + BOOL Reserved2; + BOOL Reserved3; + BOOL Reserved4; + BOOL Reserved5; + + // Geofencing + ULONG GeofencingSupport; + + // Reserved fields for future use + + BOOL Reserved6; + BOOL Reserved7; + + // SUPL/CP + + BOOL SupportCpLocation; + BOOL SupportUplV2; + BOOL SupportSuplV1; + BOOL SupportSuplV2; + GNSS_SUPL_VERSION SupportedSuplVersion; // Location adapter does not refer to this SUPL version provided by GNSS driver today + + // Geofence Parameters + // Only valid when GeofencingSupport field is non-zero + + ULONG MaxGeofencesSupported; + + // SUPL Parameter + BOOL SupportMultipleSuplRootCert; + + // Bread crumbing + ULONG GnssBreadCrumbPayloadVersion; // BREADCRUMBING_UNSUPPORTED or BREADCRUMBING_VERSION_x + ULONG MaxGnssBreadCrumbFixes; // Must >= MIN_BREADCRUMBS_SUPPORTED + + BYTE Unused[496]; +} GNSS_DEVICE_CAPABILITY, *PGNSS_DEVICE_CAPABILITY; + +// +// Define structure for Platform Capabilities +// + +typedef struct +{ + ULONG Size; + + // The version number of this structure is the DDK version against which the HLOS Platform (GNSS Adapter) is developed + // The HLOS controls the DDK versioning such that the GNSS Adapter stays backward compatible with all prior versions of the Driver + // Driver compiled with a new DDK version requires the corresponding HLOS be compiled with the same or more recent DDK version + // + + ULONG Version; + + BOOL SupportAgnssInjection; + ULONG AgnssFormatSupported; + + BYTE Unused[516]; +} GNSS_PLATFORM_CAPABILITY, *PGNSS_PLATFORM_CAPABILITY; + +// +// Define the driver commands +// + +typedef enum +{ + GNSS_SetLocationServiceEnabled = 0x01, + GNSS_SetLocationNIRequestAllowed = 0x02, + GNSS_ForceSatelliteSystem = 0x03, + GNSS_ForceOperationMode = 0x04, + GNSS_ResetEngine = 0x09, + GNSS_ClearAgnssData = 0x0A, + GNSS_SetSuplVersion = 0x0C, // GNSS_SUPL_VERSION + GNSS_SetNMEALogging = 0x0D, + GNSS_SetUplServerAccessInterval = 0x0E, + GNSS_SetNiTimeoutInterval = 0x0F, + GNSS_ResetGeofencesTracking = 0x10, + GNSS_SetSuplVersion2 = 0x11, // GNSS_SUPL_VERSION_2 + GNSS_CustomCommand = 0x0100, +} GNSS_DRIVERCOMMAND_TYPE; + +// +// Define the data structure for sending driver commands +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_DRIVERCOMMAND_TYPE CommandType; + ULONG Reserved; + ULONG CommandDataSize; + BYTE Unused[512]; + BYTE CommandData[ANYSIZE_ARRAY]; +} GNSS_DRIVERCOMMAND_PARAM, *PGNSS_DRIVERCOMMAND_PARAM; + +// +// Define Satellite System +// + +#define GNSS_SATELLITE_ANY 0x00 +#define GNSS_SATELLITE_GPS 0x01 +#define GNSS_SATELLITE_GLONASS 0x02 +#define GNSS_SATELLITE_BEIDOU 0x04 +#define GNSS_SATELLITE_GALILEO 0x08 + +// +// Define Operation Mode +// + +#define GNSS_OPERMODE_ANY 0x00 +#define GNSS_OPERMODE_MSA 0x01 +#define GNSS_OPERMODE_MSB 0x02 +#define GNSS_OPERMODE_MSS 0x04 +#define GNSS_OPERMODE_CELLID 0x08 +#define GNSS_OPERMODE_AFLT 0x10 +#define GNSS_OPERMODE_OTDOA 0x20 + +// +// Define known values for GNSS_SetNMEALogging +// + +#define GNSS_NMEALOGGING_NONE 0x00 +#define GNSS_NMEALOGGING_ALL 0xFF + +// +// Define Fix Session Types +// + +typedef enum +{ + GNSS_FixSession_SingleShot = 0x01, + GNSS_FixSession_DistanceTracking = 0x02, + GNSS_FixSession_ContinuousTracking = 0x03, + GNSS_FixSession_LKG = 0x04, +} GNSS_FIXSESSIONTYPE; + +// +// Define data structure for Single-shot Fix Session request +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG ResponseTime; + +} GNSS_SINGLESHOT_PARAM, *PGNSS_SINGLESHOT_PARAM; + +// +// Define data structure for Distance Tracking Fix Session request +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG MovementThreshold; + +} GNSS_DISTANCETRACKING_PARAM, *PGNSS_DISTANCETRACKING_PARAM; + +// +// Define data structure for Continuous Fix Session request +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG PreferredInterval; + +} GNSS_CONTINUOUSTRACKING_PARAM, *PGNSS_CONTINUOUSTRACKING_PARAM; + +// +// Define data structure for Last-known-good Fix Session request +// + +typedef struct +{ + ULONG Size; + ULONG Version; + +} GNSS_LKGFIX_PARAM, *PGNSS_LKGFIX_PARAM; + +// +// Define data structure for Fix Session request +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG FixSessionID; + GNSS_FIXSESSIONTYPE SessionType; + + // Fix quality preferences + + ULONG HorizontalAccuracy; + ULONG HorizontalConfidence; + + // Reserved Fields + ULONG Reserved[9]; + + ULONG FixLevelOfDetails; + + union + { + GNSS_SINGLESHOT_PARAM SingleShotParam; + GNSS_DISTANCETRACKING_PARAM DistanceParam; + GNSS_CONTINUOUSTRACKING_PARAM ContinuousParam; + GNSS_LKGFIX_PARAM LkgFixParam; + BYTE UnusedParam[268]; + }; + + BYTE Unused[256]; +} GNSS_FIXSESSION_PARAM, *PGNSS_FIXSESSION_PARAM; + +// +// Define data structure for stopping Fix Session +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG FixSessionID; + + BYTE Unused[512]; +} GNSS_STOPFIXSESSION_PARAM, *PGNSS_STOPFIXSESSION_PARAM; + +// +// Define level of details associated with a fix +// + +#define GNSS_FIXDETAIL_BASIC 0x0001 +#define GNSS_FIXDETAIL_ACCURACY 0x0002 +#define GNSS_FIXDETAIL_SATELLITE 0x0004 + +// +// Define data structure for basic fix data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + double Latitude; + double Longitude; + double Altitude; // Altitude with respect to mean sea level + double Speed; + double Heading; + +} GNSS_FIXDATA_BASIC, *PGNSS_FIXDATA_BASIC; + +// +// Define data structure for basic fix data version 2 +// This data structure is added in GNSS_DRIVER_VERSION_6 +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + double Latitude; + double Longitude; + double Altitude; // Altitude with respect to mean sea level + double Speed; + double Heading; + + double AltitudeEllipsoid; // Altitude with respect to ellipsoid + +} GNSS_FIXDATA_BASIC_2, *PGNSS_FIXDATA_BASIC_2; + +// +// Define data structure for accuracy-related fix data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG HorizontalAccuracy; + ULONG HorizontalErrorMajorAxis; + ULONG HorizontalErrorMinorAxis; + ULONG HorizontalErrorAngle; + ULONG HeadingAccuracy; + ULONG AltitudeAccuracy; + ULONG SpeedAccuracy; + + ULONG HorizontalConfidence; + ULONG HeadingConfidence; + ULONG AltitudeConfidence; + ULONG SpeedConfidence; + + float PositionDilutionOfPrecision; + float HorizontalDilutionOfPrecision; + float VerticalDilutionOfPrecision; + +} GNSS_FIXDATA_ACCURACY, *PGNSS_FIXDATA_ACCURACY; + +// +// Define data structure for accuracy-related fix data version 2 +// This data structure is added in GNSS_DRIVER_VERSION_6 +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + double HorizontalAccuracy; + double HorizontalErrorMajorAxis; + double HorizontalErrorMinorAxis; + double HorizontalErrorAngle; + double HeadingAccuracy; + double AltitudeAccuracy; + double SpeedAccuracy; + + ULONG HorizontalConfidence; + ULONG HeadingConfidence; + ULONG AltitudeConfidence; + ULONG SpeedConfidence; + + double PositionDilutionOfPrecision; + double HorizontalDilutionOfPrecision; + double VerticalDilutionOfPrecision; + double GeometricDilutionOfPrecision; + double TimeDilutionOfPrecision; + +} GNSS_FIXDATA_ACCURACY_2, *PGNSS_FIXDATA_ACCURACY_2; + +// +// Define data structure for satellite information +// + +typedef struct +{ + ULONG SatelliteId; + BOOL UsedInPositiong; + double Elevation; + double Azimuth; + double SignalToNoiseRatio; +} GNSS_SATELLITEINFO, *PGNSS_SATELLITEINFO; + +// +// Define data structure for satellite related fix data +// + +#define GNSS_MAXSATELLITE 64 + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG SatelliteCount; + + GNSS_SATELLITEINFO SatelliteArray[GNSS_MAXSATELLITE]; + +} GNSS_FIXDATA_SATELLITE, *PGNSS_FIXDATA_SATELLITE; + +// +// Define data structure for fix data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG FixSessionID; + FILETIME FixTimeStamp; + BOOL IsFinalFix; + NTSTATUS FixStatus; + + ULONG FixLevelOfDetails; + + GNSS_FIXDATA_BASIC BasicData; + GNSS_FIXDATA_ACCURACY AccuracyData; + GNSS_FIXDATA_SATELLITE SatelliteData; + +} GNSS_FIXDATA, *PGNSS_FIXDATA; + +// +// Define data structure for fix data version 2 +// This data structure is added in GNSS_DRIVER_VERSION_6 +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG FixSessionID; + FILETIME FixTimeStamp; + BOOL IsFinalFix; + NTSTATUS FixStatus; + + ULONG FixLevelOfDetails; + + GNSS_FIXDATA_BASIC_2 BasicData; + GNSS_FIXDATA_ACCURACY_2 AccuracyData; + GNSS_FIXDATA_SATELLITE SatelliteData; + +} GNSS_FIXDATA_2, *PGNSS_FIXDATA_2; + +// +// The configuration passed into the start of breadcrumbing via IOCTL_GNSS_START_BREADCRUMBING +// +typedef struct +{ + ULONG Size; + ULONG Version; + + // Any fix with an error radius larger than this shall not be recorded. + ULONG MaximumHorizontalUncertainty; + + // Only record a fix if the center of it is at least this far apart from center of the last, + // using a Haversine distance calculation + ULONG MinDistanceBetweenFixes; + + // If the location of the device is unknown for this duration, an error must be recorded in + // the breadcrumb data. Errors can be recorded earlier if they were already known. + ULONG MaximumErrorTimeoutMs; + + BYTE Unused[512]; +} GNSS_BREADCRUMBING_PARAM, *PGNSS_BREADCRUMBING_PARAM; + +// +// The alert information for when the breadcrumbing buffer has reached a level at which OS read +// operations should be performed. +// +typedef struct +{ + ULONG Size; + ULONG Version; + + BYTE Unused[512]; +} GNSS_BREADCRUMBING_ALERT_DATA, *PGNSS_BREADCRUMBING_ALERT_DATA; + +// +// An individual breadcrumb. The order and types of the fields are carefully crafted to pack densely. +// +typedef struct +{ + FILETIME FixTimeStamp; + + double Latitude; + double Longitude; + ULONG HorizontalAccuracy; + + unsigned short Speed; + unsigned short SpeedAccuracy; + + short Altitude; + unsigned short AltitudeAccuracy; + + short Heading; + unsigned char HeadingAccuracy; + + unsigned char FixSuccess; // A Boolean type +} GNSS_BREADCRUMB_V1, *PGNSS_BREADCRUMB_V1; + +// +// The response to an IOCTL_GNSS_POP_BREADCRUMBS +// +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG NumCrumbs; + union + { + GNSS_BREADCRUMB_V1 v1[50]; + }; + +} GNSS_BREADCRUMB_LIST, *PGNSS_BREADCRUMB_LIST; + +// +// Define the level of Geofence support by the Driver +// + +#define GNSS_GEOFENCESUPPORT_SUPPORTED 0x01 // Supports Geofence Tracking +#define GNSS_GEOFENCESUPPORT_CIRCLE 0x02 // Supports Circular Geofences + +// +// Define enumeration for Geofence Shape +// + +typedef enum +{ + GNSS_GeoRegion_Circle = 0x01, +} GNSS_GEOREGIONTYPE; + +// +// Define data structure for Circle shape +// + +typedef struct +{ + double Latitude; + double Longitude; + double RadiusInMeters; + +} GNSS_GEOREGION_CIRCLE, *PGNSS_GEOREGION_CIRCLE; + +// +// Define data structure for Geofence Region +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_GEOREGIONTYPE GeoRegionType; + + union + { + GNSS_GEOREGION_CIRCLE Circle; + BYTE Unused[512]; + }; + +} GNSS_GEOREGION, *PGNSS_GEOREGION; + +// +// Define Geofence States and Alert Mask +// + +typedef enum +{ + GNSS_GeofenceState_Unknown = 0x00, + GNSS_GeofenceState_Entered = 0x01, + GNSS_GeofenceState_Exited = 0x02, +} GNSS_GEOFENCE_STATE; + +#define GNSS_GEOFENCEALERTTYPE_ENTRY GNSS_GeofenceState_Entered // Enter Geofence +#define GNSS_GEOFENCEALERTTYPE_EXIT GNSS_GeofenceState_Exited // Exit Geofence + +// +// Define data structure for Geofence Create parameters +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG AlertTypes; // Bit-mask to indicate the Geofence alert types (GNSS_GEOFENCEALERTTYPE_xxxx) + GNSS_GEOFENCE_STATE InitialState; // Initial State of the Geofence, as seen by HLOS + + GNSS_GEOREGION Boundary; // The Geofence boundary + + BYTE Unused[512]; +} GNSS_GEOFENCE_CREATE_PARAM, *PGNSS_GEOFENCE_CREATE_PARAM; + +// +// Define data structure for Create Geofence Response +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + NTSTATUS CreationStatus; + ULONG GeofenceID; + + BYTE Unused[512]; + +} GNSS_GEOFENCE_CREATE_RESPONSE, *PGNSS_GEOFENCE_CREATE_RESPONSE; + +// +// Define data structure for Geofence Delete parameters +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG GeofenceID; + + BYTE Unused[512]; +} GNSS_GEOFENCE_DELETE_PARAM, *PGNSS_GEOFENCE_DELETE_PARAM; + +// +// Define data structure for Geofence Alert Data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG GeofenceID; + GNSS_GEOFENCE_STATE GeofenceState; + + GNSS_FIXDATA_BASIC FixBasicData; + GNSS_FIXDATA_ACCURACY FixAccuracyData; + + BYTE Unused[512]; +} GNSS_GEOFENCE_ALERT_DATA, *PGNSS_GEOFENCE_ALERT_DATA; + +// +// Define data structure for Tracking Status of all Geofences +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + NTSTATUS Status; + FILETIME StatusTimeStamp; + + BYTE Unused[512]; +} GNSS_GEOFENCES_TRACKINGSTATUS_DATA, *PGNSS_GEOFENCES_TRACKINGSTATUS_DATA; + +// +// Define GNSS events +// + +typedef enum +{ + GNSS_Event_FixAvailable = 0x0001, + GNSS_Event_RequireAgnss = 0x0002, + GNSS_Event_Error = 0x0003, + GNSS_Event_NiRequest = 0x000C, + GNSS_Event_NmeaData = 0x000D, + GNSS_Event_GeofenceAlertData = 0x000E, + GNSS_Event_GeofencesTrackingStatus = 0x000F, + GNSS_Event_DriverRequest = 0x0010, + GNSS_Event_BreadcrumbAlertEvent = 0x0011, + GNSS_Event_FixAvailable_2 = 0x0012, // Added in GNSS_DRIVER_VERSION_6 + GNSS_Event_Custom = 0x8000 +} GNSS_EVENT_TYPE; + +// +// Define data structure for error information +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG ErrorCode; + BOOL IsRecoverable; + WCHAR ErrorDescription[256]; + + BYTE Unused[512]; + +} GNSS_ERRORINFO, *PGNSS_ERRORINFO; + +// +// Define data structure for generic (non-parsed) NMEA data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + CHAR NmeaSentences[256]; + +} GNSS_NMEA_DATA, *PGNSS_NMEA_DATA; + +// +// Define AGNSS request type +// + +typedef enum +{ + GNSS_AGNSS_TimeInjection = 0x01, + GNSS_AGNSS_PositionInjection = 0x02, + GNSS_AGNSS_BlobInjection = 0x03, +} GNSS_AGNSS_REQUEST_TYPE; + +// +// Define AGNSS request patameter +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_AGNSS_REQUEST_TYPE RequestType; + ULONG BlobFormat; + +} GNSS_AGNSS_REQUEST_PARAM, *PGNSS_AGNSS_REQUEST_PARAM; + +// +// Define Plane type +// + +typedef enum +{ + GNSS_NI_SUPL = 0x01, + GNSS_NI_CP = 0x02, + GNSS_NI_V2UPL = 0x03, +} GNSS_NI_PLANE_TYPE; + +// +// Define Request type +// + +typedef enum +{ + GNSS_NI_Request_SingleShot = 0x01, + GNSS_NI_Request_AreaTrigger = 0x02, +} GNSS_NI_REQUEST_TYPE; + +// +// Define Request type +// + +typedef enum +{ + GNSS_NI_NoNotifyNoVerify = 0x01, + GNSS_NI_NotifyOnly = 0x02, + GNSS_NI_NotifyVerifyDefaultAllow = 0x03, + GNSS_NI_NotifyVerifyDefaultNotAllow = 0x04, + GNSS_NI_PrivacyOverride = 0x05 +} GNSS_NI_NOTIFICATION_TYPE; + +// +// Define data structure for SUPL NI info +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + WCHAR RequestorId[MAX_PATH]; + WCHAR ClientName[MAX_PATH]; + CHAR SuplNiUrl[MAX_SERVER_URL_NAME]; + +} GNSS_SUPL_NI_INFO, *PGNSS_SUPL_NI_INFO; + +// +// Define data structure for CP NI info +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + WCHAR RequestorId[MAX_PATH]; + WCHAR NotificationText[MAX_PATH]; + +} GNSS_CP_NI_INFO, *PGNSS_CP_NI_INFO; + +// +// Define data structure for V2UPL NI info +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + WCHAR RequestorId[MAX_PATH]; + +} GNSS_V2UPL_NI_INFO, *PGNSS_V2UPL_NI_INFO; + +// +// Define data structure for Request parameter +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG RequestId; + GNSS_NI_REQUEST_TYPE RequestType; + GNSS_NI_NOTIFICATION_TYPE NotificationType; + + GNSS_NI_PLANE_TYPE RequestPlaneType; + union + { + GNSS_SUPL_NI_INFO SuplNiInfo; + GNSS_CP_NI_INFO CpNiInfo; + GNSS_V2UPL_NI_INFO V2UplNiInfo; + }; + ULONG ResponseTimeInSec; + + BOOL EmergencyLocation; + +} GNSS_NI_REQUEST_PARAM, *PGNSS_NI_REQUEST_PARAM; + +// +// Define the data requested by the driver +// + +typedef enum +{ + SUPL_CONFIG_DATA = 0x01, +} GNSS_DRIVER_REQUEST; + +// +// Define data structure for driver requested data +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_DRIVER_REQUEST Request; + ULONG RequestFlag; +} GNSS_DRIVER_REQUEST_DATA; + +// +// Define data structure for GNSS events +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_EVENT_TYPE EventType; + ULONG EventDataSize; + BYTE Unused[512]; + + union + { + GNSS_FIXDATA FixData; + GNSS_AGNSS_REQUEST_PARAM AgnssRequest; + GNSS_NI_REQUEST_PARAM NiRequest; + GNSS_ERRORINFO ErrorInformation; + GNSS_NMEA_DATA NmeaData; + GNSS_GEOFENCE_ALERT_DATA GeofenceAlertData; + GNSS_BREADCRUMBING_ALERT_DATA BreadcrumbAlertData; + GNSS_GEOFENCES_TRACKINGSTATUS_DATA GeofencesTrackingStatus; + GNSS_DRIVER_REQUEST_DATA DriverRequestData; + BYTE CustomData[ANYSIZE_ARRAY]; + }; + +} GNSS_EVENT, *PGNSS_EVENT; + +// +// Define data structure for GNSS events version 2 +// This data structure is added in GNSS_DRIVER_VERSION_6 +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_EVENT_TYPE EventType; + ULONG EventDataSize; + BYTE Unused[512]; + + union + { + GNSS_FIXDATA FixData; + GNSS_FIXDATA_2 FixData2; + GNSS_AGNSS_REQUEST_PARAM AgnssRequest; + GNSS_NI_REQUEST_PARAM NiRequest; + GNSS_ERRORINFO ErrorInformation; + GNSS_NMEA_DATA NmeaData; + GNSS_GEOFENCE_ALERT_DATA GeofenceAlertData; + GNSS_BREADCRUMBING_ALERT_DATA BreadcrumbAlertData; + GNSS_GEOFENCES_TRACKINGSTATUS_DATA GeofencesTrackingStatus; + GNSS_DRIVER_REQUEST_DATA DriverRequestData; + BYTE CustomData[ANYSIZE_ARRAY]; + }; + +} GNSS_EVENT_2, *PGNSS_EVENT_2; + +// +// Define data structure for AGNSS time injection +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + FILETIME UtcTime; + ULONG TimeUncertainty; + +} GNSS_AGNSS_INJECTTIME, *PGNSS_AGNSS_INJECTTIME; + +// +// Define data structure for AGNSS position injection +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG Age; + + GNSS_FIXDATA_BASIC BasicData; + GNSS_FIXDATA_ACCURACY AccuracyData; + +} GNSS_AGNSS_INJECTPOSITION, *PGNSS_AGNSS_INJECTPOSITION; + +// +// Define data structure for AGNSS Blob injection +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG BlobOui; + ULONG BlobVersion; + ULONG AgnssFormat; + ULONG BlobSize; + + BYTE BlobData[ANYSIZE_ARRAY]; +} GNSS_AGNSS_INJECTBLOB, *PGNSS_AGNSS_INJECTBLOB; + +// +// Define data structure for AGNSS injection +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_AGNSS_REQUEST_TYPE InjectionType; + NTSTATUS InjectionStatus; + + ULONG InjectionDataSize; + + BYTE Unused[512]; + + union + { + GNSS_AGNSS_INJECTTIME Time; + GNSS_AGNSS_INJECTPOSITION Position; + GNSS_AGNSS_INJECTBLOB BlobData; + }; + +} GNSS_AGNSS_INJECT, *PGNSS_AGNSS_INJECT; + +// +// Define data structure for SUPL H-SLP +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + CHAR SuplHslp[MAX_SERVER_URL_NAME]; + CHAR SuplHslpFromImsi[MAX_SERVER_URL_NAME]; + ULONG Reserved; + + BYTE Unused[512]; + +} GNSS_SUPL_HSLP_CONFIG, *PGNSS_SUPL_HSLP_CONFIG; + +// +// Define actions for SUPL certs +// + +typedef enum +{ + GNSS_Supl_Cert_Inject = 0x01, + GNSS_Supl_Cert_Delete = 0x02, + GNSS_Supl_Cert_Purge = 0x03, +} GNSS_SUPL_CERT_ACTION; + +// +// Define data structure for SUPL Certs +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + GNSS_SUPL_CERT_ACTION CertAction; + CHAR SuplCertName[MAX_PATH]; + ULONG CertSize; + BYTE Unused[512]; + + BYTE CertData[ANYSIZE_ARRAY]; + +} GNSS_SUPL_CERT_CONFIG, *PGNSS_SUPL_CERT_CONFIG; + +// +// Define data structure for V2UPL Config +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + CHAR MPC[MAX_SERVER_URL_NAME]; + CHAR PDE[MAX_SERVER_URL_NAME]; + BYTE ApplicationTypeIndicator_MR; + + BYTE Unused[512]; + +} GNSS_V2UPL_CONFIG, *PGNSS_V2UPL_CONFIG; + +// +// Define user response type +// + +typedef enum +{ + GNSS_Ni_UserResponseAccept = 0x01, + GNSS_Ni_UserResponseDeny = 0x02, + GNSS_Ni_UserResponseTimeout = 0x03, +} GNSS_NI_USER_RESPONSE; + +// +// Define data structure for NI user response. +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG RequestId; + GNSS_NI_USER_RESPONSE UserResponse; + +} GNSS_NI_RESPONSE, *PGNSS_NI_RESPONSE; + +// +// Define data structure for IOCTL_GNSS_EXECUTE_CWTEST +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + NTSTATUS TestResultStatus; + double SignalToNoiseRatio; + double Frequency; + BYTE Unused[512]; + +} GNSS_CWTESTDATA, *PGNSS_CWTESTDATA; + +// +// Define data structures for IOCTL_GNSS_EXECUTE_SELFTEST +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + ULONG TestType; + BYTE Unused[512]; + ULONG InBufLen; + BYTE InBuffer[ANYSIZE_ARRAY]; + +} GNSS_SELFTESTCONFIG, *PGNSS_SELFTESTCONFIG; + +typedef struct +{ + ULONG Size; + ULONG Version; + + NTSTATUS TestResultStatus; + ULONG Result; + ULONG PinFailedBitMask; + BYTE Unused[512]; + ULONG OutBufLen; + BYTE OutBuffer[ANYSIZE_ARRAY]; + +} GNSS_SELFTESTRESULT, *PGNSS_SELFTESTRESULT; + +// +// Define data structure for IOCTL_GNSS_GET_CHIPSETINFO +// + +typedef struct +{ + ULONG Size; + ULONG Version; + + WCHAR ManufacturerID[25]; + WCHAR HardwareID[25]; + WCHAR FirmwareVersion[20]; + BYTE Unused[512]; + +} GNSS_CHIPSETINFO, *PGNSS_CHIPSETINFO; + +// Restore the previous setting for C4201 compiler warning +#pragma warning(pop) + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#endif // NTDDI_VERSION >= NTDDI_WINBLUE diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gpio.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gpio.h new file mode 100644 index 0000000000000000000000000000000000000000..8657744bf1589b7bbab56c37baea79fd28c65a15 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/gpio.h @@ -0,0 +1,84 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + + THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR + PURPOSE. + +Module Name: + + gpio.h + +Abstract: + + Header file that defines structures, prototypes and definitions required + by consumers of GPIO services. + +Environment: + + Kernel mode + +--*/ + +#ifndef __GPIO_W__ +#define __GPIO_W__ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Define IOCTL to read from a set of GPIO pins (input). +// + +#define IOCTL_GPIO_READ_PINS \ + CTL_CODE(FILE_DEVICE_GPIO, 0x0, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Define IOCTL to write to a set of GPIO pins (output). +// + +#define IOCTL_GPIO_WRITE_PINS \ + CTL_CODE(FILE_DEVICE_GPIO, 0x1, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Define IOCTL for handling GPIO controller-specific functionality. +// + +#define IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION \ + CTL_CODE(FILE_DEVICE_GPIO, 0x2, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) + +// +// Define IOCTL to commit function config pin settings to HW. +// + +#define IOCTL_GPIO_COMMIT_FUNCTION_CONFIG_PINS \ + CTL_CODE(FILE_DEVICE_GPIO, 0x4, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#endif + + +#ifdef __cplusplus +} +#endif + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // __GPIO_W__ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/guiddef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/guiddef.h new file mode 100644 index 0000000000000000000000000000000000000000..574c321ce38558f8014490ae37d63f4c1583d798 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/guiddef.h @@ -0,0 +1,205 @@ +//+--------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (c) Microsoft Corporation. All rights reserved. +// +// File: guiddef.h +// +// Contents: GUID definition +// +//---------------------------------------------------------------------------- + +#ifndef GUID_DEFINED +#define GUID_DEFINED +#if defined(__midl) +typedef struct { + unsigned long Data1; + unsigned short Data2; + unsigned short Data3; + byte Data4[ 8 ]; +} GUID; +#else +typedef struct _GUID { + unsigned long Data1; + unsigned short Data2; + unsigned short Data3; + unsigned char Data4[ 8 ]; +} GUID; +#endif +#endif + +#ifndef FAR +#ifdef _WIN32 +#define FAR +#else +#define FAR _far +#endif +#endif + +#ifndef DECLSPEC_SELECTANY +#if (_MSC_VER >= 1100) +#define DECLSPEC_SELECTANY __declspec(selectany) +#else +#define DECLSPEC_SELECTANY +#endif +#endif + +#ifndef EXTERN_C +#ifdef __cplusplus +#define EXTERN_C extern "C" +#else +#define EXTERN_C extern +#endif +#endif + +#ifdef DEFINE_GUID +#undef DEFINE_GUID +#endif + +#ifdef INITGUID +#define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \ + EXTERN_C const GUID DECLSPEC_SELECTANY name \ + = { l, w1, w2, { b1, b2, b3, b4, b5, b6, b7, b8 } } +#else +#define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \ + EXTERN_C const GUID FAR name +#endif // INITGUID + +#define DEFINE_OLEGUID(name, l, w1, w2) DEFINE_GUID(name, l, w1, w2, 0xC0,0,0,0,0,0,0,0x46) + +#ifndef _GUIDDEF_H_ +#define _GUIDDEF_H_ + +#ifndef __LPGUID_DEFINED__ +#define __LPGUID_DEFINED__ +typedef GUID *LPGUID; +#endif + +#ifndef __LPCGUID_DEFINED__ +#define __LPCGUID_DEFINED__ +typedef const GUID *LPCGUID; +#endif + +#ifndef __IID_DEFINED__ +#define __IID_DEFINED__ + +typedef GUID IID; +typedef IID *LPIID; +#define IID_NULL GUID_NULL +#define IsEqualIID(riid1, riid2) IsEqualGUID(riid1, riid2) +typedef GUID CLSID; +typedef CLSID *LPCLSID; +#define CLSID_NULL GUID_NULL +#define IsEqualCLSID(rclsid1, rclsid2) IsEqualGUID(rclsid1, rclsid2) +typedef GUID FMTID; +typedef FMTID *LPFMTID; +#define FMTID_NULL GUID_NULL +#define IsEqualFMTID(rfmtid1, rfmtid2) IsEqualGUID(rfmtid1, rfmtid2) + +#ifdef __midl_proxy +#define __MIDL_CONST +#else +#define __MIDL_CONST const +#endif + +#ifndef _REFGUID_DEFINED +#define _REFGUID_DEFINED +#ifdef __cplusplus +#define REFGUID const GUID & +#else +#define REFGUID const GUID * __MIDL_CONST +#endif +#endif + +#ifndef _REFIID_DEFINED +#define _REFIID_DEFINED +#ifdef __cplusplus +#define REFIID const IID & +#else +#define REFIID const IID * __MIDL_CONST +#endif +#endif + +#ifndef _REFCLSID_DEFINED +#define _REFCLSID_DEFINED +#ifdef __cplusplus +#define REFCLSID const IID & +#else +#define REFCLSID const IID * __MIDL_CONST +#endif +#endif + +#ifndef _REFFMTID_DEFINED +#define _REFFMTID_DEFINED +#ifdef __cplusplus +#define REFFMTID const IID & +#else +#define REFFMTID const IID * __MIDL_CONST +#endif +#endif + +#endif // !__IID_DEFINED__ + +#if !defined (__midl) +#if !defined (_SYS_GUID_OPERATORS_) +#define _SYS_GUID_OPERATORS_ +#include + +// Faster (but makes code fatter) inline version...use sparingly +#ifdef __cplusplus +__inline int InlineIsEqualGUID(REFGUID rguid1, REFGUID rguid2) +{ + return ( + ((unsigned long *) &rguid1)[0] == ((unsigned long *) &rguid2)[0] && + ((unsigned long *) &rguid1)[1] == ((unsigned long *) &rguid2)[1] && + ((unsigned long *) &rguid1)[2] == ((unsigned long *) &rguid2)[2] && + ((unsigned long *) &rguid1)[3] == ((unsigned long *) &rguid2)[3]); +} + +__inline int IsEqualGUID(REFGUID rguid1, REFGUID rguid2) +{ + return !memcmp(&rguid1, &rguid2, sizeof(GUID)); +} + +#else // ! __cplusplus + +#define InlineIsEqualGUID(rguid1, rguid2) \ + (((unsigned long *) rguid1)[0] == ((unsigned long *) rguid2)[0] && \ + ((unsigned long *) rguid1)[1] == ((unsigned long *) rguid2)[1] && \ + ((unsigned long *) rguid1)[2] == ((unsigned long *) rguid2)[2] && \ + ((unsigned long *) rguid1)[3] == ((unsigned long *) rguid2)[3]) + +#define IsEqualGUID(rguid1, rguid2) (!memcmp(rguid1, rguid2, sizeof(GUID))) + +#endif // __cplusplus + +#ifdef __INLINE_ISEQUAL_GUID +#undef IsEqualGUID +#define IsEqualGUID(rguid1, rguid2) InlineIsEqualGUID(rguid1, rguid2) +#endif + +// Same type, different name + +#define IsEqualIID(riid1, riid2) IsEqualGUID(riid1, riid2) +#define IsEqualCLSID(rclsid1, rclsid2) IsEqualGUID(rclsid1, rclsid2) + + +#if !defined _SYS_GUID_OPERATOR_EQ_ && !defined _NO_SYS_GUID_OPERATOR_EQ_ +#define _SYS_GUID_OPERATOR_EQ_ +// A couple of C++ helpers + +#ifdef __cplusplus +__inline bool operator==(REFGUID guidOne, REFGUID guidOther) +{ + return !!IsEqualGUID(guidOne,guidOther); +} + +__inline bool operator!=(REFGUID guidOne, REFGUID guidOther) +{ + return !(guidOne == guidOther); +} +#endif +#endif // _SYS_GUID_OPERATOR_EQ_ +#endif // _SYS_GUID_OPERATORS_ +#endif // __midl +#endif // _GUIDDEF_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hbaapi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hbaapi.h new file mode 100644 index 0000000000000000000000000000000000000000..841481c0516a1851505396c8a0ab627b48aa0057 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hbaapi.h @@ -0,0 +1,1572 @@ +//*************************************************************************** +// +// hbaapi.h +// +// Module: Windows HBA API implmentation +// +// This header is consistent with www.t11.org SM-HBA Draft July 2006 +// +// Purpose: Contains HBA api header +// +// Copyright (c) Microsoft Corporation +// +//*************************************************************************** + +#ifndef HBAAPI_H +#define HBAAPI_H + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef __cplusplus +extern "C" { +#endif + +#define SM_HBA_API // include SM-HBA specific functions + +#include + +#ifdef _HBAAPIP_ +#define HBA_API __cdecl +#else +#define HBA_API DECLSPEC_IMPORT __cdecl +#endif + +#define HBA_VERSION 2 + +typedef ULONGLONG HBA_UINT64; +typedef LONGLONG HBA_INT64; +typedef ULONG HBA_UINT32; +typedef USHORT HBA_UINT16; +typedef UCHAR HBA_UINT8; +typedef signed char HBA_INT8; + +typedef HBA_UINT32 HBA_HANDLE; + +typedef HBA_UINT32 HBA_STATUS; + +#define HBA_STATUS_OK 0 + +#define HBA_STATUS_ERROR 1 /* Error */ +#define HBA_STATUS_ERROR_NOT_SUPPORTED 2 /* Function not supported.*/ +#define HBA_STATUS_ERROR_INVALID_HANDLE 3 /* invalid handle */ +#define HBA_STATUS_ERROR_ARG 4 /* Bad argument */ +#define HBA_STATUS_ERROR_ILLEGAL_WWN 5 /* WWN not recognized */ +#define HBA_STATUS_ERROR_ILLEGAL_INDEX 6 /* Index not recognized */ +#define HBA_STATUS_ERROR_MORE_DATA 7 /* Larger buffer required */ + +/* Information has changed since the last call to HBA_RefreshInformation */ +#define HBA_STATUS_ERROR_STALE_DATA 8 + +/* SCSI Check Condition reported*/ +#define HBA_STATUS_SCSI_CHECK_CONDITION 9 + +/* Adapter busy or reserved, retry may be effective*/ +#define HBA_STATUS_ERROR_BUSY 10 + +/* Request timed out, retry may be effective */ +#define HBA_STATUS_ERROR_TRY_AGAIN 11 + +/* Referenced HBA has been removed or deactivated */ +#define HBA_STATUS_ERROR_UNAVAILABLE 12 + +/* The requested ELS was rejected by the local adapter */ +#define HBA_STATUS_ERROR_ELS_REJECT 13 + +/* The specified LUN is not provided by the specified adapter */ +#define HBA_STATUS_ERROR_INVALID_LUN 14 + +/* An incompatibility has been detected among the library and driver modules */ +/* invoked which will cause one or more functions in the highest version */ +/* that all support to operate incorrectly. */ +/* The differing function sets of software modules implementing different */ +/* versions of the HBA API specification does not in itself constitute an */ +/* incompatibility. */ +/* Known interoperability bugs among supposedly compatible versions */ +/* should be reported as incompatibilities, */ +/* but not all such interoperability bugs may be known. */ +/* This value may be returned by any function which calls a */ +/* Vendor Specific Library, and by HBA_LoadLibrary and HBA_GetAdapterName. */ + +#define HBA_STATUS_ERROR_INCOMPATIBLE 15 + + +/* Multiple adapters have a matching WWN. */ +/* This could occur if the NodeWWN of multiple adapters is identical. */ +#define HBA_STATUS_ERROR_AMBIGUOUS_WWN 16 + +/* A persistent binding request included a bad local SCSI bus number */ +#define HBA_STATUS_ERROR_LOCAL_BUS 17 + +/* A persistent binding request included a bad local SCSI target number */ +#define HBA_STATUS_ERROR_LOCAL_TARGET 18 + +/* A persistent binding request included a bad local SCSI logical unit number */ +#define HBA_STATUS_ERROR_LOCAL_LUN 19 + +/* A persistent binding set request included */ +/* a local SCSI ID that was already bound */ +#define HBA_STATUS_ERROR_LOCAL_SCSIID_BOUND 20 + +/* A persistent binding request included a bad or unlocatable FCP Target FCID */ +#define HBA_STATUS_ERROR_TARGET_FCID 21 + +/* A persistent binding request included a bad FCP Target Node WWN */ +#define HBA_STATUS_ERROR_TARGET_NODE_WWN 22 + +/* A persistent binding request included a bad FCP Target Port WWN */ +#define HBA_STATUS_ERROR_TARGET_PORT_WWN 23 + +/* A persistent binding request included */ +/* an FCP Logical Unit Number not defined by the identified Target*/ +#define HBA_STATUS_ERROR_TARGET_LUN 24 + +/* A persistent binding request included */ +/* an undefined or otherwise inaccessible Logical Unit Unique Identifier */ +#define HBA_STATUS_ERROR_TARGET_LUID 25 + +/* A persistent binding remove request included */ +/* a binding which did not match a binding established by the specified port */ +#define HBA_STATUS_ERROR_NO_SUCH_BINDING 26 + +/* A SCSI command was requested to an Nx_Port that was not a SCSI Target Port */ +#define HBA_STATUS_ERROR_NOT_A_TARGET 27 + +/* A request was made concerning an unsupported FC-4 protocol */ +#define HBA_STATUS_ERROR_UNSUPPORTED_FC4 28 + +/* A request was made to enable unimplemented capabilities for a port */ +#define HBA_STATUS_ERROR_INCAPABLE 29 + +/* A SCSI function was rejected to prevent causing */ +/* a SCSI overlapped command condition (see SAM-3) */ +#define HBA_STATUS_ERROR_TARGET_BUSY 30 + +/* A call was made to HBA_FreeLibrary when no library was loaded */ +#define HBA_STATUS_ERROR_NOT_LOADED 31 + +/* A call was made to HBA_LoadLibrary when a library was already loaded */ +#define HBA_STATUS_ERROR_ALREADY_LOADED 32 + +/* The Address Identifier specified in a call to HBA_SendRNIDV2 */ +/* violates access control rules for that call */ +#define HBA_STATUS_ERROR_ILLEGAL_FCID 33 + +#define HBA_STATUS_ERROR_NOT_ASCSIDEVICE 34 + +#define HBA_STATUS_ERROR_INVALID_PROTOCOL_TYPE 35 + +#define HBA_STATUS_ERROR_BAD_EVENT_TYPE 36 + + +typedef HBA_UINT8 HBA_BOOLEAN; /* Use this for a single true/false flag */ + +typedef HBA_UINT32 HBA_PORTTYPE; + +#define HBA_PORTTYPE_UNKNOWN 1 /* Unknown */ +#define HBA_PORTTYPE_OTHER 2 /* Other */ +#define HBA_PORTTYPE_NOTPRESENT 3 /* Not present */ +#define HBA_PORTTYPE_NPORT 5 /* Fabric */ +#define HBA_PORTTYPE_NLPORT 6 /* Public Loop */ +#define HBA_PORTTYPE_FLPORT 7 /* Fabric on a Loop */ +#define HBA_PORTTYPE_FPORT 8 /* Fabric Port */ +#define HBA_PORTTYPE_EPORT 9 /* Fabric expansion port */ // obsolete? +#define HBA_PORTTYPE_GPORT 10 /* Generic Fabric Port */ // obsolete? +#define HBA_PORTTYPE_LPORT 20 /* Private Loop */ +#define HBA_PORTTYPE_PTP 21 /* Point to Point */ +#define HBA_PORTTYPE_SASDEVICE 30 /* SAS (SSP or STP) */ +#define HBA_PORTTYPE_SATADEVICE 31 /* SATA Device, i.e. Direct Attach SATA */ +#define HBA_PORTTYPE_SASEXPANDER 32 /* SAS Expander */ + +typedef HBA_UINT32 HBA_PORTSTATE; +#define HBA_PORTSTATE_UNKNOWN 1 /* Unknown */ +#define HBA_PORTSTATE_ONLINE 2 /* Operational */ +#define HBA_PORTSTATE_OFFLINE 3 /* User Offline */ +#define HBA_PORTSTATE_BYPASSED 4 /* Bypassed */ +#define HBA_PORTSTATE_DIAGNOSTICS 5 /* In diagnostics mode */ +#define HBA_PORTSTATE_LINKDOWN 6 /* Link Down */ +#define HBA_PORTSTATE_ERROR 7 /* Port Error */ +#define HBA_PORTSTATE_LOOPBACK 8 /* Loopback */ +#define HBA_PORTSTATE_DEGRADED 9 /* Degraded, but Operational mode */ + +typedef HBA_UINT32 HBA_PORTSPEED; +typedef HBA_UINT32 HBA_FCPHYSPEED, HBA_SASPHYSPEED, HBA_PHYSPEED; + +#define HBA_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver incapable */ + /* of reporting */ +#define HBA_PORTSPEED_1GBIT 1 /* 1 GBit/sec */ +#define HBA_PORTSPEED_2GBIT 2 /* 2 GBit/sec */ +#define HBA_PORTSPEED_10GBIT 4 /* 10 GBit/sec */ +#define HBA_PORTSPEED_4GBIT 8 /* 4 GBit/sec */ + + +#define HBA_FCSPEED_UNKNOWN 0 /* Unknown - transceiver incapable */ + /* of reporting */ +#define HBA_FCPHYSPEED_8GBIT 16 /* 8 GBit/sec */ +#define HBA_FCPHYSPEED_16GBIT 32 /* 16 GBit/sec */ + +#define HBA_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */ + + +typedef HBA_UINT8 HBA_FCPHYTYPE; + +#define HBA_FCPHYTYPE_UNKNOWN 1 /* Unknown Phy type */ +#define HBA_FCPHYTYPE_OPTICAL 2 /* Optical Phy */ +#define HBA_FCPHYTYPE_COPPER 4 /* Copper Phy */ + + +#define HBA_SASSTATE_UNKNOWN 0x00 /* Phy is enabled. Speed is unknown */ +#define HBA_SASSTATE_DISABLED 0x01 /* Phy is disabled. */ + +#define HBA_SASSTATE_FAILED 0x02 /* Phy is enabled. But failed speed */ + /* negotiation. */ + +#define HBA_SASSTATE_SATASPINUP 0x03 /* Phy is enabled. Detected a SATA */ + /* device and entered the SATA Spinup */ + /* hold state */ + +#define HBA_SASSTATE_SATAPORTSEL 0x04 /* The phy is attached to a */ + /* Port Selector (see SATA-2.5). */ + +#define HBA_SASSPEED_1_5GBIT 0x08 /* 1.5 GBit/sec */ +#define HBA_SASSPEED_3GBIT 0x09 /* 3 GBit/sec */ + + +typedef struct HBA_wwn { + HBA_UINT8 wwn[8]; +} HBA_WWN, *PHBA_WWN; + + +typedef struct SMHBA_FC_Phy { + HBA_FCPHYSPEED PhySupportSpeed; /* PhySupportedSpeed */ + HBA_FCPHYSPEED PhySpeed; /* PhySpeed */ + HBA_FCPHYTYPE PhyType; + HBA_UINT32 MaxFrameSize; /* MaxFrameSize */ +} SMHBA_FC_PHY, *PSMHBA_FC_PHY; + +typedef struct SMHBA_SAS_Phy { + HBA_UINT8 PhyIdentifier; + HBA_SASPHYSPEED NegotiatedLinkRate; + HBA_SASPHYSPEED ProgrammedMinLinkRate; + HBA_SASPHYSPEED HardwareMinLinkRate; + HBA_SASPHYSPEED ProgrammedMaxLinkRate; + HBA_SASPHYSPEED HardwareMaxLinkRate; + HBA_WWN domainPortWWN; +} SMHBA_SAS_PHY, *PSMHBA_SAS_PHY; + + + +typedef HBA_UINT32 HBA_COS; + +typedef struct HBA_fc4types { + HBA_UINT8 bits[32]; /* See FC-4 TYPEs - Format in FC-GS-4 */ +} HBA_FC4TYPES, *PHBA_FC4TYPES; + +typedef struct HBA_ipaddress { + int ipversion; // see enumerations in RNID + union + { + unsigned char ipv4address[4]; + unsigned char ipv6address[16]; + } ipaddress; +} HBA_IPADDRESS, *PHBA_IPADDRESS; + +typedef struct HBA_AdapterAttributes { + char Manufacturer[64]; + char SerialNumber[64]; + char Model[256]; + char ModelDescription[256]; + HBA_WWN NodeWWN; + char NodeSymbolicName[256]; /* From GS-2 */ + char HardwareVersion[256]; /* Vendor use */ + char DriverVersion[256]; /* Vendor use */ + char OptionROMVersion[256]; /* Vendor use - i.e. hardware boot ROM*/ + char FirmwareVersion[256]; /* Vendor use */ + HBA_UINT32 VendorSpecificID; /* Vendor specific */ + HBA_UINT32 NumberOfPorts; + char DriverName[256]; /* Binary path and/or name of driver file. */ +} HBA_ADAPTERATTRIBUTES, *PHBA_ADAPTERATTRIBUTES; + + +typedef struct SMHBA_AdapterAttributes { + char Manufacturer[64]; + char SerialNumber[64]; + char Model[256]; + char ModelDescription[256]; + char HardwareVersion[256]; + char DriverVersion[256]; + char OptionROMVersion[256]; + char FirmwareVersion[256]; + HBA_UINT32 VendorSpecificID; + char DriverName[256]; + char HBASymbolicName[256]; + char RedundantOptionROMVersion[256]; + char RedundantFirmwareVersion[256]; +} SMHBA_ADAPTERATTRIBUTES, *PSMHBA_ADAPTERATTRIBUTES; + + +typedef struct HBA_PortAttributes { + HBA_WWN NodeWWN; + HBA_WWN PortWWN; + HBA_UINT32 PortFcId; + HBA_PORTTYPE PortType; /*PTP, Fabric, etc. */ + HBA_PORTSTATE PortState; + HBA_COS PortSupportedClassofService; + HBA_FC4TYPES PortSupportedFc4Types; + HBA_FC4TYPES PortActiveFc4Types; + char PortSymbolicName[256]; + char OSDeviceName[256]; + HBA_PORTSPEED PortSupportedSpeed; + HBA_PORTSPEED PortSpeed; + HBA_UINT32 PortMaxFrameSize; + HBA_WWN FabricName; + HBA_UINT32 NumberofDiscoveredPorts; +} HBA_PORTATTRIBUTES, *PHBA_PORTATTRIBUTES; + + +typedef HBA_UINT32 HBA_SASPORTPROTOCOL; + +#define HBA_SASPORTPROTOCOL_SSP 1 /* Serial Attached SCSI Port */ +#define HBA_SASPORTPROTOCOL_STP 2 /* Serial ATA Tunneling Protocol Port */ +#define HBA_SASPORTPROTOCOL_SMP 4 /* Serial Management Protocol Port */ +#define HBA_SASPORTPROTOCOL_SATA 8 /* SATA Device, Direct Attached or */ + /* anywhere in the domain */ + + +typedef struct SMHBA_FC_Port { + HBA_WWN NodeWWN; + HBA_WWN PortWWN; + HBA_UINT32 FcId; + HBA_COS PortSupportedClassofService; + HBA_FC4TYPES PortSupportedFc4Types; + HBA_FC4TYPES PortActiveFc4Types; + HBA_WWN FabricName; + char PortSymbolicName[256]; + HBA_UINT32 NumberofDiscoveredPorts; + HBA_UINT8 NumberofPhys; +} SMHBA_FC_PORT, *PSMHBA_FC_PORT; + +typedef struct SMHBA_SAS_Port { + HBA_SASPORTPROTOCOL PortProtocol; + HBA_WWN LocalSASAddress; + HBA_WWN AttachedSASAddress; + HBA_UINT32 NumberofDiscoveredPorts; + HBA_UINT32 NumberofPhys; +} SMHBA_SAS_PORT, *PSMHBA_SAS_PORT; + +typedef union SMHBA_Port { + SMHBA_FC_PORT *FCPort; + SMHBA_SAS_PORT *SASPort; +} SMHBA_PORT, *PSMHBA_PORT; + +typedef struct SMHBA_PortAttributes { + HBA_PORTTYPE PortType; + HBA_PORTSTATE PortState; + char OSDeviceName[256]; + SMHBA_PORT PortSpecificAttribute; +} SMHBA_PORTATTRIBUTES, *PSMHBA_PORTATTRIBUTES; + + +/* Statistical counters for FC-0, FC-1 and FC-2 */ + +typedef struct HBA_PortStatistics { + HBA_INT64 SecondsSinceLastReset; + HBA_INT64 TxFrames; + HBA_INT64 TxWords; + HBA_INT64 RxFrames; + HBA_INT64 RxWords; + HBA_INT64 LIPCount; + HBA_INT64 NOSCount; + HBA_INT64 ErrorFrames; + HBA_INT64 DumpedFrames; + HBA_INT64 LinkFailureCount; + HBA_INT64 LossOfSyncCount; + HBA_INT64 LossOfSignalCount; + HBA_INT64 PrimitiveSeqProtocolErrCount; + HBA_INT64 InvalidTxWordCount; + HBA_INT64 InvalidCRCCount; +} HBA_PORTSTATISTICS, *PHBA_PORTSTATISTICS; + + +/* Statistical counters for FC-4 protocols */ + +typedef struct HBA_FC4Statistics { + HBA_INT64 InputRequests; + HBA_INT64 OutputRequests; + HBA_INT64 ControlRequests; + HBA_INT64 InputMegabytes; + HBA_INT64 OutputMegabytes; +} HBA_FC4STATISTICS, *PHBA_FC4STATISTICS; + + +/* Statistical counters for FC-4, SSP, STP, SMP protocols */ + +typedef struct SMHBA_ProtocolStatistics { + HBA_INT64 SecondsSinceLastReset; + HBA_INT64 InputRequests; + HBA_INT64 OutputRequests; + HBA_INT64 ControlRequests; + HBA_INT64 InputMegabytes; + HBA_INT64 OutputMegabytes; +} SMHBA_PROTOCOLSTATISTICS, *PSMHBA_PROTOCOLSTATISTICS; + + +typedef struct SMHBA_SASPhyStatistics { + HBA_INT64 SecondsSinceLastReset; + HBA_INT64 TxFrames; + HBA_INT64 TxWords; + HBA_INT64 RxFrames; + HBA_INT64 RxWords; + HBA_INT64 InvalidDwordCount; + HBA_INT64 RunningDisparityErrorCount; + HBA_INT64 LossofDwordSyncCount; + HBA_INT64 PhyResetProblemCount; +} SMHBA_SASPHYSTATISTICS, *PSMHBA_SASPHYSTATISTICS; + + +/* Statistical counters for FC-0, FC-1, and FC-2 */ + +typedef HBA_PORTSTATISTICS SMHBA_FCPHYSTATISTICS, *PSMHBA_FCPHYSTATISTICS; + +typedef union SMHBA_PhyStatistics { + SMHBA_SASPHYSTATISTICS *SASPhyStatistics; + SMHBA_FCPHYSTATISTICS *FCPhyStatistics; +} SMHBA_PHYSTATISTICS, *PSMHBA_PHYSTATISTICS; + + + +/* HBA_FCPBINDINGTYPE was used in Rev 1.0. Add TO_OTHER for older calls to + indicate other binding types for HBA_GetPersistentBinding. To support + multiple types a new flag has been created to allow for multiple bindings + supported */ + +typedef enum HBA_fcpbindingtype { TO_D_ID, TO_WWN, TO_OTHER } HBA_FCPBINDINGTYPE; + + +/* A bit mask of Rev 2.0 persistent binding capabilities */ + +typedef HBA_UINT32 HBA_BIND_CAPABILITY; + +/* The following are bit flags indicating persistent binding capabilities */ + +#define HBA_CAN_BIND_TO_D_ID 0x0001 +#define HBA_CAN_BIND_TO_WWPN 0x0002 +#define HBA_CAN_BIND_TO_WWNN 0x0004 +#define HBA_CAN_BIND_TO_LUID 0x0008 +#define HBA_CAN_BIND_ANY_LUNS 0x0400 +#define HBA_CAN_BIND_TARGETS 0x0800 +#define HBA_CAN_BIND_AUTOMAP 0x1000 +#define HBA_CAN_BIND_CONFIGURED 0x2000 + +/* A bit mask of Rev 2.0 persistent binding setting types */ + +typedef HBA_UINT32 HBA_BIND_TYPE; + +/* The following are bit flags indicating persistent binding setting types */ + +#define HBA_BIND_TO_D_ID 0x0001 +#define HBA_BIND_TO_WWPN 0x0002 +#define HBA_BIND_TO_WWNN 0x0004 +#define HBA_BIND_TO_LUID 0x0008 +#define HBA_BIND_TARGETS 0x0800 + +typedef struct HBA_LUID { + char buffer[256]; +} HBA_LUID, *PHBA_LUID; + +typedef struct HBA_ScsiId { + char OSDeviceName[256]; /* \device\ScsiPort3 */ + HBA_UINT32 ScsiBusNumber; /* Bus on the HBA */ + HBA_UINT32 ScsiTargetNumber; /* SCSI Target ID to OS */ + HBA_UINT32 ScsiOSLun; +} HBA_SCSIID, *PHBA_SCSIID; + +typedef struct HBA_FcpId { + HBA_UINT32 FcId; + HBA_WWN NodeWWN; + HBA_WWN PortWWN; + HBA_UINT64 FcpLun; +} HBA_FCPID, *PHBA_FCPID; + +typedef struct HBA_FcpScsiEntry { + HBA_SCSIID ScsiId; + HBA_FCPID FcpId; +} HBA_FCPSCSIENTRY, *PHBA_FCPSCSIENTRY; + +typedef struct HBA_FcpScsiEntryV2 { + HBA_SCSIID ScsiId; + HBA_FCPID FcpId; + HBA_LUID LUID; +} HBA_FCPSCSIENTRYV2, *PHBA_FCPSCSIENTRYV2; + +typedef struct HBA_FCPTargetMapping { + HBA_UINT32 NumberOfEntries; + HBA_FCPSCSIENTRY entry[1]; /* Variable length array containing mappings*/ +} HBA_FCPTARGETMAPPING, *PHBA_FCPTARGETMAPPING; + +typedef struct HBA_FCPTargetMappingV2 { + HBA_UINT32 NumberOfEntries; + HBA_FCPSCSIENTRYV2 entry[1]; /* Variable length array containing mappings*/ +} HBA_FCPTARGETMAPPINGV2, *PHBA_FCPTARGETMAPPINGV2; + + +typedef struct HBA_FCPBindingEntry { + HBA_FCPBINDINGTYPE type; + HBA_SCSIID ScsiId; + HBA_FCPID FcpId; + HBA_UINT32 FcId; +} HBA_FCPBINDINGENTRY, *PHBA_FCPBINDINGENTRY; + +typedef struct HBA_FCPBinding { + HBA_UINT32 NumberOfEntries; + HBA_FCPBINDINGENTRY entry[1]; /* Variable length array */ +} HBA_FCPBINDING, *PHBA_FCPBINDING; + +typedef struct HBA_FCPBindingEntry2 { + HBA_BIND_TYPE type; + HBA_SCSIID ScsiId; + HBA_FCPID FcpId; + HBA_LUID LUID; + HBA_STATUS Status; +} HBA_FCPBINDINGENTRY2, *PHBA_FCPBINDINGENTRY2; + +typedef struct HBA_FCPBinding2 { + HBA_UINT32 NumberOfEntries; + HBA_FCPBINDINGENTRY2 entry[1]; /* Variable length array */ +} HBA_FCPBINDING2, *PHBA_FCPBINDING2; + + +typedef HBA_UINT32 SMHBA_BIND_CAPABILITY; + +#define SMHBA_CAN_BIND_TO_WWPN 0x0001 +#define SMHBA_CAN_BIND_TO_LUID 0x0002 +#define SMHBA_CAN_BIND_ANY_LUNS 0x0400 +#define SMHBA_CAN_BIND_AUTOMAP 0x0800 + +typedef HBA_UINT32 SMHBA_BIND_TYPE; + +#define SMHBA_BIND_TO_WWPN 0x0001 +#define SMHBA_BIND_TO_LUID 0x0002 + +typedef struct SMHBA_ScsiId { + char OSDeviceName[256]; + HBA_UINT32 ScsiBusNumber; + HBA_UINT32 ScsiTargetNumber; + HBA_UINT32 ScsiOSLun; +} SMHBA_SCSIID, *PSMHBA_SCSIID; + +typedef struct SMHBA_LUID { + char buffer[256]; +} SMHBA_LUID, *PSMHBA_LUID; + +typedef HBA_UINT64 HBA_SCSILUN; + +typedef struct SMHBA_SCSILUN { + HBA_UINT8 lun[8]; +} SMHBA_SCSILUN; + +typedef struct SMHBA_PORTLUN { + HBA_WWN PortWWN; + HBA_WWN domainPortWWN; + HBA_SCSILUN TargetLun; +} SMHBA_PORTLUN, *PSMHBA_PORTLUN; + +typedef struct SMHBA_ScsiEntry { + SMHBA_SCSIID ScsiId; + SMHBA_PORTLUN PortLun; + SMHBA_LUID LUID; +} SMHBA_SCSIENTRY, *PSMHBA_SCSIENTRY; + +typedef struct SMHBA_TargetMapping { + HBA_UINT32 NumberOfEntries; + SMHBA_SCSIENTRY entry[1]; /* Variable length array containing mappings*/ +} SMHBA_TARGETMAPPING, *PSMHBA_TARGETMAPPING; + +typedef struct SMHBA_BindingEntry { + SMHBA_BIND_TYPE type; + SMHBA_SCSIID ScsiId; + SMHBA_PORTLUN PortLun; + SMHBA_LUID LUID; + HBA_STATUS Status; +} SMHBA_BINDINGENTRY, *PSMHBA_BINDINGENTRY; + +typedef struct SMHBA_Binding { + HBA_UINT32 NumberOfEntries; + SMHBA_BINDINGENTRY entry[1]; /* Variable length array */ +} SMHBA_BINDING, *PSMHBA_BINDING; + + +typedef enum HBA_wwntype { NODE_WWN, PORT_WWN } HBA_WWNTYPE; + +typedef struct HBA_MgmtInfo { + HBA_WWN wwn; + HBA_UINT32 unittype; + HBA_UINT32 PortId; + HBA_UINT32 NumberOfAttachedNodes; + HBA_UINT16 IPVersion; + HBA_UINT16 UDPPort; + HBA_UINT8 IPAddress[16]; + HBA_UINT16 reserved; + HBA_UINT16 TopologyDiscoveryFlags; +} HBA_MGMTINFO, *PHBA_MGMTINFO; + +#define HBA_EVENT_LIP_OCCURRED 1 +#define HBA_EVENT_LINK_UP 2 +#define HBA_EVENT_LINK_DOWN 3 +#define HBA_EVENT_LIP_RESET_OCCURRED 4 +#define HBA_EVENT_RSCN 5 +#define HBA_EVENT_PROPRIETARY 0xFFFF + +typedef struct HBA_Link_EventInfo { + HBA_UINT32 PortFcId; /* Port which this event occurred */ + HBA_UINT32 Reserved[3]; +} HBA_LINK_EVENTINFO, *PHBA_LINK_EVENTINFO; + +typedef struct HBA_RSCN_EventInfo { + HBA_UINT32 PortFcId; /* Port which this event occurred */ + HBA_UINT32 NPortPage; /* Reference FC-FS for RSCN ELS "Affected N-Port Pages"*/ + HBA_UINT32 Reserved[2]; +} HBA_RSCN_EVENTINFO, *PHBA_RSCN_EVENTINFO; + +typedef struct HBA_Pty_EventInfo { + HBA_UINT32 PtyData[4]; /* Proprietary data */ +} HBA_PTY_EVENTINFO, *PHBA_PTY_EVENTINFO; + +typedef struct HBA_EventInfo { + HBA_UINT32 EventCode; + union { + HBA_LINK_EVENTINFO Link_EventInfo; + HBA_RSCN_EVENTINFO RSCN_EventInfo; + HBA_PTY_EVENTINFO Pty_EventInfo; + } Event; +} HBA_EVENTINFO, *PHBA_EVENTINFO; + +typedef PVOID PHBA_ENTRYPOINTS; +typedef PVOID PHBA_ENTRYPOINTSV2; +typedef PVOID PSMHBA_ENTRYPOINTS; + +HBA_STATUS HBA_API HBA_RegisterLibrary(PHBA_ENTRYPOINTS entrypoints); +HBA_STATUS HBA_API HBA_RegisterLibraryV2(PHBA_ENTRYPOINTSV2 entrypoints); + + +HBA_UINT32 HBA_API HBA_GetVersion(); +HBA_STATUS HBA_API HBA_LoadLibrary(); +HBA_STATUS HBA_API HBA_FreeLibrary(); + + +HBA_UINT32 HBA_API HBA_GetNumberOfAdapters(); + +HBA_STATUS HBA_API +HBA_GetAdapterName( + _In_ HBA_UINT32 AdapterIndex, + _Inout_updates_(MAX_NAME) PSTR AdapterName + ); + +HBA_HANDLE HBA_API +HBA_OpenAdapter( + _In_ PSTR AdapterName + ); + +void HBA_API +HBA_CloseAdapter( + IN HBA_HANDLE handle + ); + +HBA_STATUS HBA_API +HBA_GetAdapterAttributes( + IN HBA_HANDLE Handle, + OUT HBA_ADAPTERATTRIBUTES *HbaAttributes + ); + +HBA_STATUS HBA_API +HBA_GetAdapterPortAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + OUT HBA_PORTATTRIBUTES *PortAttributes + ); + + +HBA_STATUS HBA_API +HBA_GetPortStatistics( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + OUT HBA_PORTSTATISTICS *PortStatistics + ); + +HBA_STATUS HBA_API +HBA_GetDiscoveredPortAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 DiscoveredPortIndex, + OUT HBA_PORTATTRIBUTES *PortAttributes + ); + +HBA_STATUS HBA_API +HBA_GetPortAttributesByWWN( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + OUT HBA_PORTATTRIBUTES *PortAttributes + ); + + +HBA_STATUS HBA_API +HBA_SendCTPassThru( + IN HBA_HANDLE Handle, + IN void *pReqBuffer, + IN HBA_UINT32 ReqBufferSize, + OUT void *pRspBuffer, + IN HBA_UINT32 RspBufferSize + ); + +HBA_STATUS HBA_API +HBA_GetEventBuffer( + IN HBA_HANDLE Handle, + OUT PHBA_EVENTINFO EventBuffer, + IN OUT HBA_UINT32 *EventCount + ); + +HBA_STATUS HBA_API +HBA_SetRNIDMgmtInfo( + IN HBA_HANDLE Handle, + IN HBA_MGMTINFO *pInfo + ); + +HBA_STATUS HBA_API +HBA_GetRNIDMgmtInfo( + IN HBA_HANDLE Handle, + OUT HBA_MGMTINFO *pInfo + ); + +HBA_STATUS HBA_API +HBA_SendRNID( + IN HBA_HANDLE Handle, + IN HBA_WWN Wwn, + IN HBA_WWNTYPE WnnType, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *RspBufferSize + ); + +HBA_STATUS HBA_API +HBA_GetFcpTargetMapping( + IN HBA_HANDLE Handle, + IN OUT PHBA_FCPTARGETMAPPING Mapping + ); + +HBA_STATUS HBA_API +HBA_GetFcpPersistentBinding( + IN HBA_HANDLE Handle, + IN OUT PHBA_FCPBINDING Binding + ); + +HBA_STATUS HBA_API +HBA_SendScsiInquiry( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT64 FcLUN, + IN HBA_UINT8 EVPD, + IN HBA_UINT32 PageCode, + OUT void *pRspBuffer, + IN HBA_UINT32 RspBufferSize, + OUT void *pSenseBuffer, + IN HBA_UINT32 SenseBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendReportLUNs( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + OUT void *pRspBuffer, + IN HBA_UINT32 RspBufferSize, + OUT void *pSenseBuffer, + IN HBA_UINT32 SenseBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendReadCapacity( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT64 FcLUN, + OUT void *pRspBuffer, + IN HBA_UINT32 RspBufferSize, + OUT void *pSenseBuffer, + IN HBA_UINT32 SenseBufferSize + ); + +void HBA_API +HBA_RefreshInformation( + IN HBA_HANDLE Handle + ); + +void HBA_API +HBA_ResetStatistics( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex + ); + + +typedef void *HBA_CALLBACKHANDLE; + +typedef HBA_CALLBACKHANDLE *PHBA_CALLBACKHANDLE; + +/* Adapter Level Events */ +#define HBA_EVENT_ADAPTER_UNKNOWN 0x100 +#define HBA_EVENT_ADAPTER_ADD 0x101 +#define HBA_EVENT_ADAPTER_REMOVE 0x102 +#define HBA_EVENT_ADAPTER_CHANGE 0x103 + +/* Port Level Events */ +#define HBA_EVENT_PORT_UNKNOWN 0x200 +#define HBA_EVENT_PORT_OFFLINE 0x201 +#define HBA_EVENT_PORT_ONLINE 0x202 +#define HBA_EVENT_PORT_NEW_TARGETS 0x203 +#define HBA_EVENT_PORT_FABRIC 0x204 +#define HBA_EVENT_PORT_BROADCAST_CHANGE 0x205 +#define HBA_EVENT_PORT_BROADCAST_D24_0 0x206 +#define HBA_EVENT_PORT_BROADCAST_D27_4 0x207 +#define HBA_EVENT_PORT_BROADCAST_SES 0x208 +#define HBA_EVENT_PORT_BROADCAST_D01_4 0x209 +#define HBA_EVENT_PORT_BROADCAST_D04_7 0x20a +#define HBA_EVENT_PORT_BROADCAST_D16_7 0x20b +#define HBA_EVENT_PORT_BROADCAST_D29_7 0x20c +#define HBA_EVENT_PORT_ALL 0x2ff + +/* Port Statistics Events */ +#define HBA_EVENT_PORT_STAT_THRESHOLD 0x301 +#define HBA_EVENT_PORT_STAT_GROWTH 0x302 + +/* Phy Statistics Events */ +#define HBA_EVENT_PHY_STAT_THRESHOLD 0x351 +#define HBA_EVENT_PHY_STAT_GROWTH 0x352 + +/* Target Level Events */ +#define HBA_EVENT_TARGET_UNKNOWN 0x400 +#define HBA_EVENT_TARGET_OFFLINE 0x401 +#define HBA_EVENT_TARGET_ONLINE 0x402 +#define HBA_EVENT_TARGET_REMOVED 0x403 + +/* Fabric Link Events */ +#define HBA_EVENT_LINK_UNKNOWN 0x500 +#define HBA_EVENT_LINK_INCIDENT 0x501 + +HBA_STATUS HBA_API +HBA_RemoveCallback( + IN HBA_CALLBACKHANDLE callbackHandle + ); + +HBA_STATUS HBA_API +HBA_RegisterForAdapterAddEvents( + IN void (*callback) (void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType), + IN void *pUserData, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +HBA_RegisterForAdapterEvents( + IN void (*callback) (void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +HBA_RegisterForAdapterPortEvents( + IN void (*callback) (void *pData, + HBA_WWN PortWWN, + HBA_UINT32 eventType, + HBA_UINT32 fabricPortID), + IN void *UserData, + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +HBA_RegisterForAdapterPortStatEvents( + IN void (*callback)(void *pData, + HBA_WWN PortWWN, + HBA_UINT32 eventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_PORTSTATISTICS stats, + IN HBA_UINT32 statType, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +HBA_RegisterForTargetEvents( + IN void (*callback)(void *pData, + HBA_WWN hbaPortWWN, + HBA_WWN discoveredPortWWN, + HBA_UINT32 eventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + OUT HBA_CALLBACKHANDLE *pCallbackHandle, + IN HBA_UINT32 AllTargets + ); + +HBA_STATUS HBA_API +HBA_RegisterForLinkEvents( + IN void (*callback)(void *data, HBA_WWN adapterWWN, HBA_UINT32 eventType, + void *pRLIRBuffer, HBA_UINT32 RLIRBufferSize), + IN void *userData, + IN void *pRLIRBuffer, + IN HBA_UINT32 RLIRBufferSize, + IN HBA_HANDLE Handle, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + + +HBA_STATUS HBA_API +HBA_OpenAdapterByWWN( + OUT HBA_HANDLE *HbaHandle, + IN HBA_WWN Wwn + ); + +void HBA_API +HBA_RefreshAdapterConfiguration( + ); + +HBA_STATUS HBA_API +HBA_SendCTPassThruV2( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN void *pReqBuffer, + IN HBA_UINT32 ReqBufferSize, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendRNIDV2( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DestWWN, + IN HBA_UINT32 DestFCID, + IN HBA_UINT32 NodeIdDataFormat, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendRPL( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN Agent_wwn, + IN HBA_UINT32 Agent_domain, + IN HBA_UINT32 PortIndex, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendRPS( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN Agent_wwn, + IN HBA_UINT32 Agent_domain, + IN HBA_WWN Object_wwn, + IN HBA_UINT32 Object_port_number, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendSRL( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN Wwn, + IN HBA_UINT32 Domain, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendLIRR( + IN HBA_HANDLE Handle, + IN HBA_WWN SourceWWN, + IN HBA_WWN DestWWN, + IN HBA_UINT8 Function, + IN HBA_UINT8 Type, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + +HBA_STATUS HBA_API +HBA_SendRLS( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DestWWN, + OUT void *pRspBuffer, + IN OUT HBA_UINT32 *pRspBufferSize + ); + + +HBA_STATUS HBA_API +HBA_GetFC4Statistics( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT8 FC4type, + OUT HBA_FC4STATISTICS *Statistics + ); + +HBA_STATUS HBA_API +HBA_GetFCPStatistics( + IN HBA_HANDLE Handle, + IN const HBA_SCSIID *Lunit, + OUT HBA_FC4STATISTICS *Statistics + ); + + + +typedef struct HBA_LibraryAttributes { + HBA_BOOLEAN final; + char LibPath[256]; + char VName[256]; + char VVersion[256]; + struct tm build_date; +} HBA_LIBRARYATTRIBUTES, *PHBA_LIBRARYATTRIBUTES; + +typedef struct SMHBA_LibraryAttributes { + char LibPath[256]; + char VName[256]; + char VVersion[256]; + struct { + int tm_mday; /* day of the month - [1,31] */ + int tm_mon; /* months since January - [0,11] */ + int tm_year; /* years since 1900 */ + } build_date; +} SMHBA_LIBRARYATTRIBUTES, *PSMHBA_LIBRARYATTRIBUTES; + + +HBA_UINT32 HBA_API +HBA_GetWrapperLibraryAttributes( + OUT HBA_LIBRARYATTRIBUTES *Attributes + ); + +HBA_UINT32 HBA_API +HBA_GetVendorLibraryAttributes( + IN HBA_UINT32 AdapterIndex, + OUT HBA_LIBRARYATTRIBUTES *Attributes + ); + + +HBA_STATUS HBA_API +HBA_ScsiReadCapacityV2( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_UINT64 FcLUN, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + +HBA_STATUS HBA_API +HBA_ScsiReportLUNsV2( + IN HBA_HANDLE Hbahandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + +HBA_STATUS HBA_API +HBA_ScsiInquiryV2 ( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_UINT64 FcLUN, + IN HBA_UINT8 CDB_Byte1, + IN HBA_UINT8 CDB_Byte2, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + + +HBA_STATUS HBA_API +HBA_GetFcpTargetMappingV2( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN OUT HBA_FCPTARGETMAPPINGV2 *Mapping + ); + +HBA_STATUS HBA_API +HBA_GetBindingCapability( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + OUT HBA_BIND_CAPABILITY *Flags + ); + +HBA_STATUS HBA_API +HBA_GetBindingSupport( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + OUT HBA_BIND_CAPABILITY *Flags + ); + +HBA_STATUS HBA_API +HBA_SetBindingSupport( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_BIND_CAPABILITY Flags + ); + + +HBA_STATUS HBA_API +HBA_GetPersistentBindingV2( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN OUT PHBA_FCPBINDING2 Binding + ); + +HBA_STATUS HBA_API +HBA_SetPersistentBindingV2( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN PHBA_FCPBINDING2 Binding + ); + +HBA_STATUS HBA_API +HBA_RemovePersistentBinding( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN PHBA_FCPBINDING2 Binding + ); + +HBA_STATUS HBA_API +HBA_RemoveAllPersistentBindings( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN + ); + + +#if 0 + +// +// stubs for unsupported SB functions +// + +typedef PVOID PHBA_SBTARGETMAPPING; + +typedef struct HBA_SBDevId { + char OSDeviceName[256]; +} HBA_SBDEVID, *PHBA_SBDEVID; + + +typedef struct HBA_Ned { + HBA_UINT32 NEDWord0; + HBA_UINT32 NelId[7]; +} HBA_NED, *PHBA_NED; + +typedef struct HBA_DeviceSelfDesc { + HBA_NED TokenNED; + HBA_NED DeviceNED; +} HBA_DEVICESELFDESC, *PHBA_DEVICESELFDESC; + +typedef PVOID PHBA_SBSTATISTICS; + +typedef struct HBA_SBDskCapacity { + HBA_INT32 SCSIFormatLBA; /* SCSI Read Capacity Format */ + HBA_INT32 SCSIFormatBlkLen; /* SCSI Read Capacity Format */ + HBA_INT32 SBDskNumberOfCylinders; /* cyls */ + HBA_INT32 SBDskTracksPerCylinder; /* tracks per cyl */ + HBA_INT32 SBDskMaxUsableTrackLen; /* usable track capcacity */ +} HBA_SBDSKCAPACITY, *PHBA_SBDSKCAPACITY; + + +HBA_STATUS HBA_API +HBA_GetSBTargetMapping( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + OUT PHBA_SBTARGETMAPPING Mapping + ); + +HBA_STATUS HBA_API +HBA_GetSBStatistics( + IN HBA_HANDLE HbaHandle, + IN const HBA_SBDEVID *Device, + OUT PHBA_SBSTATISTICS Statistics + ); + +HBA_STATUS HBA_API +HBA_SBDskGetCapacity( + IN HBA_DEVICESELFDESC DeviceSelfDesc, + OUT PHBA_SBDSKCAPACITY PSbDskCapacity + ); + +#endif + +#ifdef SM_HBA_API + +// +// SM-HBA Library Control Functions +// + +#define SMHBA_VERSION 1 + +HBA_UINT32 HBA_API SMHBA_GetVersion(); +HBA_STATUS HBA_API SMHBA_RegisterLibrary(PSMHBA_ENTRYPOINTS entrypoints); + +HBA_UINT32 HBA_API +SMHBA_GetWrapperLibraryAttributes( + OUT SMHBA_LIBRARYATTRIBUTES *Attributes + ); + +HBA_UINT32 HBA_API +SMHBA_GetVendorLibraryAttributes( + IN HBA_UINT32 AdapterIndex, + OUT SMHBA_LIBRARYATTRIBUTES *Attributes + ); + + +// +// SM-HBA Adapter, FC_Port and SAS_Port Information Functions +// + +HBA_STATUS HBA_API +SMHBA_GetProtocolStatistics( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 ProtocolType, + OUT SMHBA_PROTOCOLSTATISTICS *ProtocolStatistics + ); + +HBA_STATUS HBA_API +SMHBA_GetNumberOfPorts( + IN HBA_HANDLE Handle, + OUT HBA_UINT32 *NumberOfPorts + ); + +HBA_STATUS HBA_API +SMHBA_GetAdapterAttributes( + IN HBA_HANDLE Handle, + OUT SMHBA_ADAPTERATTRIBUTES *AdapterAttributes + ); + +HBA_STATUS HBA_API +SMHBA_GetPhyStatistics( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 PhyIndex, + OUT SMHBA_PHYSTATISTICS *PhyStatistics + ); + +HBA_STATUS HBA_API +SMHBA_GetDiscoveredPortAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 DiscoveredPortIndex, + OUT SMHBA_PORTATTRIBUTES *PortAttributes + ); + +HBA_STATUS HBA_API +SMHBA_GetPortAttributesByWWN( + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_WWN DomainPortWWN, + OUT SMHBA_PORTATTRIBUTES *PortAttributes + ); + +HBA_STATUS HBA_API +SMHBA_GetPortType( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + OUT HBA_PORTTYPE *PortType + ); + +HBA_STATUS HBA_API +SMHBA_GetAdapterPortAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + OUT SMHBA_PORTATTRIBUTES *PortAttributes + ); + +HBA_STATUS HBA_API +SMHBA_GetFCPhyAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 PhyIndex, + OUT SMHBA_FC_PHY *PhyType + ); + +HBA_STATUS HBA_API +SMHBA_GetSASPhyAttributes( + IN HBA_HANDLE Handle, + IN HBA_UINT32 PortIndex, + IN HBA_UINT32 PhyIndex, + OUT SMHBA_SAS_PHY *PhyType + ); + +// +// SM-HBA Target Information Functions +// + +HBA_STATUS HBA_API +SMHBA_GetLUNStatistics( + IN HBA_HANDLE Handle, + IN const HBA_SCSIID *Lunit, + OUT SMHBA_PROTOCOLSTATISTICS *ProtocolStatistics + ); + +HBA_STATUS HBA_API +SMHBA_GetTargetMapping( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + IN OUT SMHBA_TARGETMAPPING *Mapping + ); + +HBA_STATUS HBA_API +SMHBA_GetBindingCapability( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + OUT SMHBA_BIND_CAPABILITY *Flags + ); + +HBA_STATUS HBA_API +SMHBA_GetBindingSupport( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + OUT SMHBA_BIND_CAPABILITY *Flags + ); + +HBA_STATUS HBA_API +SMHBA_SetBindingSupport( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + IN SMHBA_BIND_CAPABILITY Flags + ); + +HBA_STATUS HBA_API +SMHBA_GetPersistentBinding( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + IN OUT SMHBA_BINDING *Binding + ); + +HBA_STATUS HBA_API +SMHBA_SetPersistentBinding( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + IN OUT SMHBA_BINDING *Binding + ); + +HBA_STATUS HBA_API +SMHBA_RemovePersistentBinding( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN, + IN const SMHBA_BINDING *Binding + ); + +HBA_STATUS HBA_API +SMHBA_RemoveAllPersistentBindings( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DomainPortWWN + ); + +// +// SCSI Information Functions +// + +HBA_STATUS HBA_API +SMHBA_ScsiInquiry( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_WWN DomainPortWWN, + IN HBA_SCSILUN SmhbaLUN, + IN HBA_UINT8 CDB_Byte1, + IN HBA_UINT8 CDB_Byte2, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + +HBA_STATUS HBA_API +SMHBA_ScsiReportLuns( + IN HBA_HANDLE Hbahandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_WWN DomainPortWWN, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + +HBA_STATUS HBA_API +SMHBA_ScsiReadCapacity( + IN HBA_HANDLE HbaHandle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_WWN DomainPortWWN, + IN HBA_SCSILUN SmhbaLUN, + OUT void *pRespBuffer, + IN OUT HBA_UINT32 *pRespBufferSize, + OUT HBA_UINT8 *pScsiStatus, + OUT void *pSenseBuffer, + IN OUT HBA_UINT32 *pSenseBufferSize + ); + +// +// Fabric and Domain Management Functions +// + +// new FC specific + +HBA_STATUS HBA_API +SMHBA_SendTEST( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DestWWN, + IN HBA_UINT32 DestFCID, + IN void *ReqBuffer, + IN HBA_UINT32 ReqBufferSize + ); + +// new FC specific + +HBA_STATUS HBA_API +SMHBA_SendECHO( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DestWWN, + IN HBA_UINT32 DestFCID, + IN void *ReqBuffer, + IN HBA_UINT32 ReqBufferSize, + OUT void *RspBuffer, + IN OUT HBA_UINT32 *RspBufferSize + ); + +// new SAS specific + +HBA_STATUS HBA_API +SMHBA_SendSMPPassThru( + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DestPortWWN, + IN HBA_WWN DomainPortWWN, + IN void *ReqBuffer, + IN HBA_UINT32 ReqBufferSize, + OUT void *RspBuffer, + IN OUT HBA_UINT32 *RspBufferSize + ); + + +// +// Event Handling Functions +// + + +HBA_STATUS HBA_API +SMHBA_RegisterForAdapterAddEvents( + IN void (*callback)(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType), + IN void *pUserData, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +SMHBA_RegisterForAdapterEvents( + IN void (*callback)(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +SMHBA_RegisterForAdapterPortEvents( + IN void (*callback)(void *pData, + HBA_WWN PortWWN, + HBA_UINT32 eventType, + HBA_UINT32 fabricPortID), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT32 SpecificEventType, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +SMHBA_RegisterForAdapterPortStatEvents( + IN void (*callback)(void *pData, + HBA_WWN PortWWN, + HBA_UINT32 ProtocolType, + HBA_UINT32 EventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT32 ProtocolType, + IN SMHBA_PROTOCOLSTATISTICS Stats, + IN HBA_UINT32 StatType, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +SMHBA_RegisterForAdapterPhyStatEvents( + IN void (*callback)(void *pData, + HBA_WWN PortWWN, + HBA_UINT32 PhyIndex, + HBA_UINT32 EventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN PortWWN, + IN HBA_UINT32 PhyIndex, + IN SMHBA_PHYSTATISTICS Stats, + IN HBA_UINT32 StatType, + OUT HBA_CALLBACKHANDLE *pCallbackHandle + ); + +HBA_STATUS HBA_API +SMHBA_RegisterForTargetEvents( + IN void (*callback)(void *pData, + HBA_WWN HbaPortWWN, + HBA_WWN DiscoveredPortWWN, + HBA_WWN DomainPortWWN, + HBA_UINT32 EventType), + IN void *pUserData, + IN HBA_HANDLE Handle, + IN HBA_WWN HbaPortWWN, + IN HBA_WWN DiscoveredPortWWN, + IN HBA_WWN DomainPortWWN, + OUT HBA_CALLBACKHANDLE *pCallbackHandle, + IN HBA_UINT32 AllTargets + ); + +#endif // _SM_HBA_API_ + +#ifdef __cplusplus +}; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif //NTDDI_VERSION + +#endif // HBAAPI_H + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidclass.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidclass.h new file mode 100644 index 0000000000000000000000000000000000000000..6fcf801b8b1de10dc075316ab0cdd8573b4b0288 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidclass.h @@ -0,0 +1,300 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + hidclass.h + +Abstract + + Definitions that are common to clients of the HID class driver. + +Environment: + + Kernel mode and user mode + +--*/ + + +#include +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// +// Define the HID class guid *OUTSIDE* the #ifndef/#endif to allow +// multiple includes with precompiled headers. +// +DEFINE_GUID( GUID_DEVINTERFACE_HID, 0x4D1E55B2L, 0xF16F, 0x11CF, 0x88, 0xCB, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30); +#define GUID_CLASS_INPUT GUID_DEVINTERFACE_HID + +// 2c4e2e88-25e6-4c33-882f-3d82e6073681 +DEFINE_GUID( GUID_HID_INTERFACE_NOTIFY, 0x2c4e2e88L, 0x25e6, 0x4c33, 0x88, 0x2f, 0x3d, 0x82, 0xe6, 0x07, 0x36, 0x81 ); + +// {F5C315A5-69AC-4bc2-9279-D0B64576F44B} +DEFINE_GUID( GUID_HID_INTERFACE_HIDPARSE, 0xf5c315a5, 0x69ac, 0x4bc2, 0x92, 0x79, 0xd0, 0xb6, 0x45, 0x76, 0xf4, 0x4b ); + +#ifdef DEFINE_DEVPROPKEY + +// +// Device interface properties +// + +// Name: System.DeviceInterface.Hid.UsagePage -- DEVPKEY_DeviceInterface_HID_UsagePage +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 2 +// +// HID Usage Page +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_UsagePage, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 2); + + +// Name: System.DeviceInterface.Hid.UsageId -- DEVPKEY_DeviceInterface_HID_UsageId +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 3 +// +// HID Usage Id +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_UsageId, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 3); + + +// Name: System.DeviceInterface.Hid.IsReadOnly -- DEVPKEY_DeviceInterface_HID_IsReadOnly +// Type: Boolean - DEVPROP_TYPE_BOOLEAN +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 4 +// +// Read-only property indicator +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_IsReadOnly, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 4); + + +// Name: System.DeviceInterface.Hid.VendorId +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 5 +// +// VendorId of HID device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_VendorId, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 5); + + +// Name: System.DeviceInterface.Hid.ProductId +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 6 +// +// ProductId of HID device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_ProductId, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 6); + + +// Name: System.DeviceInterface.Hid.VersionNumber +// Type: Two-byte integer - DEVPROP_TYPE_UINT16 +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 7 +// +// Version number of HID device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_VersionNumber, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 7); + + +// Type: Boolean - DEVPROP_TYPE_BOOLEAN +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 8 +// +// Allow access from background tasks to this HID device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_BackgroundAccess, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 8); + + +// Type: DEVPROP_TYPE_BOOLEAN +// FormatID: {CBF38310-4A17-4310-A1EB-247F0B67593B}, 9 +// +// Do NOT alter this property. The HID stack in the OS sets it automatically. +// This property indicates whether the HID collection input is capable of turning on the screen. +// +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_HID_WakeScreenOnInputCapable, 0xcbf38310, 0x4a17, 0x4310, 0xa1, 0xeb, 0x24, 0x7f, 0xb, 0x67, 0x59, 0x3b, 9); + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifndef __HIDCLASS_H__ +#define __HIDCLASS_H__ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // nameless struct/union + +// +// HID_REVISION specifies the minimum revision of HIDCLASS.SYS +// required to support minidrivers compiled with this header file. +// +#define HID_REVISION 0x00000001 + +// +// Macro for defining HID ioctls +// +#define HID_CTL_CODE(id) CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_NEITHER, FILE_ANY_ACCESS) +#define HID_BUFFER_CTL_CODE(id) CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define HID_IN_CTL_CODE(id) CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_IN_DIRECT, FILE_ANY_ACCESS) +#define HID_OUT_CTL_CODE(id) CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS) + +// +// IOCTLs supported by the upper edge of the HID class driver +// +#define IOCTL_HID_GET_DRIVER_CONFIG HID_BUFFER_CTL_CODE(100) +#define IOCTL_HID_SET_DRIVER_CONFIG HID_BUFFER_CTL_CODE(101) +#define IOCTL_HID_GET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE(102) +#define IOCTL_HID_SET_POLL_FREQUENCY_MSEC HID_BUFFER_CTL_CODE(103) +#define IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE(104) +#define IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS HID_BUFFER_CTL_CODE(105) +#define IOCTL_HID_GET_COLLECTION_INFORMATION HID_BUFFER_CTL_CODE(106) +#define IOCTL_HID_ENABLE_WAKE_ON_SX HID_BUFFER_CTL_CODE(107) +#define IOCTL_HID_SET_S0_IDLE_TIMEOUT HID_BUFFER_CTL_CODE(108) + + +#define IOCTL_HID_GET_COLLECTION_DESCRIPTOR HID_CTL_CODE(100) +#define IOCTL_HID_FLUSH_QUEUE HID_CTL_CODE(101) + +#define IOCTL_HID_SET_FEATURE HID_IN_CTL_CODE(100) +#define IOCTL_HID_SET_OUTPUT_REPORT HID_IN_CTL_CODE(101) + +#define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE(100) +#define IOCTL_GET_PHYSICAL_DESCRIPTOR HID_OUT_CTL_CODE(102) +#define IOCTL_HID_GET_HARDWARE_ID HID_OUT_CTL_CODE(103) +#define IOCTL_HID_GET_INPUT_REPORT HID_OUT_CTL_CODE(104) +#define IOCTL_HID_GET_OUTPUT_REPORT HID_OUT_CTL_CODE(105) + +#define IOCTL_HID_GET_MANUFACTURER_STRING HID_OUT_CTL_CODE(110) +#define IOCTL_HID_GET_PRODUCT_STRING HID_OUT_CTL_CODE(111) +#define IOCTL_HID_GET_SERIALNUMBER_STRING HID_OUT_CTL_CODE(112) + +#define IOCTL_HID_GET_INDEXED_STRING HID_OUT_CTL_CODE(120) +#define IOCTL_HID_GET_MS_GENRE_DESCRIPTOR HID_OUT_CTL_CODE(121) + +#define IOCTL_HID_ENABLE_SECURE_READ HID_CTL_CODE(130) +#define IOCTL_HID_DISABLE_SECURE_READ HID_CTL_CODE(131) + +#define IOCTL_HID_DEVICERESET_NOTIFICATION HID_CTL_CODE(140) + +// +// This is used to pass write-report and feature-report information +// from HIDCLASS to a minidriver. +// +typedef struct _HID_XFER_PACKET { + PUCHAR reportBuffer; + ULONG reportBufferLen; + UCHAR reportId; +} HID_XFER_PACKET, *PHID_XFER_PACKET; + +#ifdef NT_INCLUDED + +enum DeviceObjectState { + DeviceObjectStarted, + DeviceObjectStopped, + DeviceObjectRemoved +}; + +typedef VOID (*PHID_STATUS_CHANGE)(_In_ PVOID Context, _In_ enum DeviceObjectState State); + +typedef struct _HID_INTERFACE_NOTIFY_PNP +{ +#ifndef __cplusplus + INTERFACE; +#else + INTERFACE i; +#endif + PHID_STATUS_CHANGE StatusChangeFn; + PVOID CallbackContext; +} HID_INTERFACE_NOTIFY_PNP, *PHID_INTERFACE_NOTIFY_PNP; + +#ifdef __HIDPI_H__ + +_Must_inspect_result_ +typedef +NTSTATUS +(__stdcall *PHIDP_GETCAPS) ( + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_ PHIDP_CAPS Capabilities + ); + +typedef struct _HID_INTERFACE_HIDPARSE +{ +#ifndef __cplusplus + INTERFACE; +#else + INTERFACE i; +#endif + PHIDP_GETCAPS HidpGetCaps; +} HID_INTERFACE_HIDPARSE, *PHID_INTERFACE_HIDPARSE; + +#endif // __HIDPI_H__ + +#endif // NT_INCLUDED + +// +// Structure passed by IOCTL_HID_GET_COLLECTION_INFORMATION +// + +typedef struct _HID_COLLECTION_INFORMATION { + + // + // DescriptorSize is the size of the input buffer required to accept + // the collection descriptor returned by + // IOCTL_HID_GET_COLLECTION_DESCRIPTOR. + // + + ULONG DescriptorSize; + + // + // Polled is TRUE if this collection is a polled collection. + // + + BOOLEAN Polled; + + // + // Reserved1 must be set to zero. + // + + UCHAR Reserved1[ 1 ]; + + // + // Vendor ids of this hid device + // + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; + + // + // Additional fields, if any, will be added at the end of this structure. + // + +} HID_COLLECTION_INFORMATION, *PHID_COLLECTION_INFORMATION; + +// +// Structure passed by IOCTL_HID_GET_DRIVER_CONFIG and +// IOCTL_HID_SET_DRIVER_CONFIG +// + +typedef struct _HID_DRIVER_CONFIG { + + // + // Size must be set to the size of this structure. + // + + ULONG Size; + + // + // Size of the input report queue (in reports). This value can be set. + // + + ULONG RingBufferSize; + +} HID_DRIVER_CONFIG, *PHID_DRIVER_CONFIG; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // __HIDCLASS_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidpi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidpi.h new file mode 100644 index 0000000000000000000000000000000000000000..19615541e4ecce73b1ef00c15293011ad456dac6 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidpi.h @@ -0,0 +1,2094 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDPI.H + +Abstract: + + Public Interface to the HID parsing library. + +Environment: + + Kernel & user mode + +--*/ + +#ifndef __HIDPI_H__ +#define __HIDPI_H__ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4115) // named type definition in parentheses +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4214) // bit field types other than int + +#include + +// Please include "hidsdi.h" to use the user space (dll / parser) +// Please include "hidpddi.h" to use the kernel space parser + +// +// Special Link collection values for using the query functions +// +// Root collection references the collection at the base of the link +// collection tree. +// Unspecifies, references all collections in the link collection tree. +// +#define HIDP_LINK_COLLECTION_ROOT ((USHORT) -1) +#define HIDP_LINK_COLLECTION_UNSPECIFIED ((USHORT) 0) + + +typedef enum _HIDP_REPORT_TYPE +{ + HidP_Input, + HidP_Output, + HidP_Feature +} HIDP_REPORT_TYPE; + +typedef struct _USAGE_AND_PAGE +{ + USAGE Usage; + USAGE UsagePage; +} USAGE_AND_PAGE, *PUSAGE_AND_PAGE; + +#define HidP_IsSameUsageAndPage(u1, u2) ((* (PULONG) &u1) == (* (PULONG) &u2)) + +typedef struct _HIDP_BUTTON_CAPS +{ + USAGE UsagePage; + UCHAR ReportID; + BOOLEAN IsAlias; + + USHORT BitField; + USHORT LinkCollection; // A unique internal index pointer + + USAGE LinkUsage; + USAGE LinkUsagePage; + + BOOLEAN IsRange; + BOOLEAN IsStringRange; + BOOLEAN IsDesignatorRange; + BOOLEAN IsAbsolute; + + USHORT ReportCount; // Available in API version >= 2 only. + + USHORT Reserved2; + + ULONG Reserved[9]; + union { + struct { + USAGE UsageMin, UsageMax; + USHORT StringMin, StringMax; + USHORT DesignatorMin, DesignatorMax; + USHORT DataIndexMin, DataIndexMax; + } Range; + struct { + USAGE Usage, Reserved1; + USHORT StringIndex, Reserved2; + USHORT DesignatorIndex, Reserved3; + USHORT DataIndex, Reserved4; + } NotRange; + }; + +} HIDP_BUTTON_CAPS, *PHIDP_BUTTON_CAPS; + + +typedef struct _HIDP_VALUE_CAPS +{ + USAGE UsagePage; + UCHAR ReportID; + BOOLEAN IsAlias; + + USHORT BitField; + USHORT LinkCollection; // A unique internal index pointer + + USAGE LinkUsage; + USAGE LinkUsagePage; + + BOOLEAN IsRange; + BOOLEAN IsStringRange; + BOOLEAN IsDesignatorRange; + BOOLEAN IsAbsolute; + + BOOLEAN HasNull; // Does this channel have a null report union + UCHAR Reserved; + USHORT BitSize; // How many bits are devoted to this value? + + USHORT ReportCount; // See Note below. Usually set to 1. + USHORT Reserved2[5]; + + ULONG UnitsExp; + ULONG Units; + + LONG LogicalMin, LogicalMax; + LONG PhysicalMin, PhysicalMax; + + union { + struct { + USAGE UsageMin, UsageMax; + USHORT StringMin, StringMax; + USHORT DesignatorMin, DesignatorMax; + USHORT DataIndexMin, DataIndexMax; + } Range; + + struct { + USAGE Usage, Reserved1; + USHORT StringIndex, Reserved2; + USHORT DesignatorIndex, Reserved3; + USHORT DataIndex, Reserved4; + } NotRange; + }; +} HIDP_VALUE_CAPS, *PHIDP_VALUE_CAPS; + +// +// Notes: +// +// ReportCount: When a report descriptor declares an Input, Output, or +// Feature main item with fewer usage declarations than the report count, then +// the last usage applies to all remaining unspecified count in that main item. +// (As an example you might have data that required many fields to describe, +// possibly buffered bytes.) In this case, only one value cap structure is +// allocated for these associtated fields, all with the same usage, and Report +// Count reflects the number of fields involved. Normally ReportCount is 1. +// To access all of the fields in such a value structure would require using +// HidP_GetUsageValueArray and HidP_SetUsageValueArray. HidP_GetUsageValue/ +// HidP_SetScaledUsageValue will also work, however, these functions will only +// work with the first field of the structure. +// + +// +// The link collection tree consists of an array of LINK_COLLECTION_NODES +// where the index into this array is the same as the collection number. +// +// Given a collection A which contains a subcollection B, A is defined to be +// the parent B, and B is defined to be the child. +// +// Given collections A, B, and C where B and C are children of A, and B was +// encountered before C in the report descriptor, B is defined as a sibling of +// C. (This implies, of course, that if B is a sibling of C, then C is NOT a +// sibling of B). +// +// B is defined as the NextSibling of C if and only if there exists NO +// child collection of A, call it D, such that B is a sibling of D and D +// is a sibling of C. +// +// E is defined to be the FirstChild of A if and only if for all children of A, +// F, that are not equivalent to E, F is a sibling of E. +// (This implies, of course, that the does not exist a child of A, call it G, +// where E is a sibling of G). In other words the first sibling is the last +// link collection found in the list. +// +// In other words, if a collection B is defined within the definition of another +// collection A, B becomes a child of A. All collections with the same parent +// are considered siblings. The FirstChild of the parent collection, A, will be +// last collection defined that has A as a parent. The order of sibling pointers +// is similarly determined. When a collection B is defined, it becomes the +// FirstChild of it's parent collection. The previously defined FirstChild of the +// parent collection becomes the NextSibling of the new collection. As new +// collections with the same parent are discovered, the chain of sibling is built. +// +// With that in mind, the following describes conclusively a data structure +// that provides direct traversal up, down, and accross the link collection +// tree. +// +// +typedef struct _HIDP_LINK_COLLECTION_NODE +{ + USAGE LinkUsage; + USAGE LinkUsagePage; + USHORT Parent; + USHORT NumberOfChildren; + USHORT NextSibling; + USHORT FirstChild; + ULONG CollectionType: 8; // As defined in 6.2.2.6 of HID spec + ULONG IsAlias : 1; // This link node is an allias of the next link node. + ULONG Reserved: 23; + PVOID UserContext; // The user can hang his coat here. +} HIDP_LINK_COLLECTION_NODE, *PHIDP_LINK_COLLECTION_NODE; + +// +// When a link collection is described by a delimiter, alias link collection +// nodes are created. (One for each usage within the delimiter). +// The parser assigns each capability description listed above only one +// link collection. +// +// If a control is defined within a collection defined by +// delimited usages, then that control is said to be within multiple link +// collections, one for each usage within the open and close delimiter tokens. +// Such multiple link collecions are said to be aliases. The first N-1 such +// collections, listed in the link collection node array, have their IsAlias +// bit set. The last such link collection is the link collection index used +// in the capabilities described above. +// Clients wishing to set a control in an aliased collection, should walk the +// collection array once for each time they see the IsAlias flag set, and use +// the last link collection as the index for the below accessor functions. +// +// NB: if IsAlias is set, then NextSibling should be one more than the current +// link collection node index. +// + +typedef PUCHAR PHIDP_REPORT_DESCRIPTOR; +typedef struct _HIDP_PREPARSED_DATA * PHIDP_PREPARSED_DATA; + +typedef struct _HIDP_CAPS +{ + USAGE Usage; + USAGE UsagePage; + USHORT InputReportByteLength; + USHORT OutputReportByteLength; + USHORT FeatureReportByteLength; + USHORT Reserved[17]; + + USHORT NumberLinkCollectionNodes; + + USHORT NumberInputButtonCaps; + USHORT NumberInputValueCaps; + USHORT NumberInputDataIndices; + + USHORT NumberOutputButtonCaps; + USHORT NumberOutputValueCaps; + USHORT NumberOutputDataIndices; + + USHORT NumberFeatureButtonCaps; + USHORT NumberFeatureValueCaps; + USHORT NumberFeatureDataIndices; +} HIDP_CAPS, *PHIDP_CAPS; + +typedef struct _HIDP_DATA +{ + USHORT DataIndex; + USHORT Reserved; + union { + ULONG RawValue; // for values + BOOLEAN On; // for buttons MUST BE TRUE for buttons. + }; +} HIDP_DATA, *PHIDP_DATA; +// +// The HIDP_DATA structure is used with HidP_GetData and HidP_SetData +// functions. +// +// The parser contiguously assigns every control (button or value) in a hid +// device a unique data index from zero to NumberXXXDataIndices -1 , inclusive. +// This value is found in the HIDP_BUTTON_CAPS and HIDP_VALUE_CAPS structures. +// +// Most clients will find the Get/Set Buttons / Value accessor functions +// sufficient to their needs, as they will allow the clients to access the +// data known to them while ignoring the other controls. +// +// More complex clients, which actually read the Button / Value Caps, and which +// do a value add service to these routines (EG Direct Input), will need to +// access all the data in the device without interest in the individual usage +// or link collection location. These are the clients that will find +// HidP_Data useful. +// + +typedef struct _HIDP_UNKNOWN_TOKEN +{ + UCHAR Token; + UCHAR Reserved[3]; + ULONG BitField; +} HIDP_UNKNOWN_TOKEN, *PHIDP_UNKNOWN_TOKEN; + +typedef struct _HIDP_EXTENDED_ATTRIBUTES +{ + UCHAR NumGlobalUnknowns; + UCHAR Reserved [3]; + PHIDP_UNKNOWN_TOKEN GlobalUnknowns; + // ... Additional attributes + ULONG Data [1]; // variableLength DO NOT ACCESS THIS FIELD +} HIDP_EXTENDED_ATTRIBUTES, *PHIDP_EXTENDED_ATTRIBUTES; + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetCaps ( + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_ PHIDP_CAPS Capabilities + ); +/*++ +Routine Description: + Returns a list of capabilities of a given hid device as described by its + preparsed data. + +Arguments: + PreparsedData The preparsed data returned from HIDCLASS. + Capabilities a HIDP_CAPS structure + +Return Value: + HIDP_STATUS_SUCCESS + HIDP_STATUS_INVALID_PREPARSED_DATA +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetLinkCollectionNodes ( + _Out_writes_to_(*LinkCollectionNodesLength, *LinkCollectionNodesLength) PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes, + _Inout_ PULONG LinkCollectionNodesLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + Return a list of PHIDP_LINK_COLLECTION_NODEs used to describe the link + collection tree of this hid device. See the above description of + struct _HIDP_LINK_COLLECTION_NODE. + +Arguments: + LinkCollectionNodes - a caller allocated array into which + HidP_GetLinkCollectionNodes will store the information + + LinKCollectionNodesLength - the caller sets this value to the length of the + the array in terms of number of elements. + HidP_GetLinkCollectionNodes sets this value to the actual + number of elements set. The total number of nodes required to + describe this HID device can be found in the + NumberLinkCollectionNodes field in the HIDP_CAPS structure. + +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetSpecificButtonCaps ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_opt_ USAGE UsagePage, // Optional (0 => ignore) + _In_opt_ USHORT LinkCollection, // Optional (0 => ignore) + _In_opt_ USAGE Usage, // Optional (0 => ignore) + _Out_writes_to_(*ButtonCapsLength, *ButtonCapsLength) PHIDP_BUTTON_CAPS ButtonCaps, + _Inout_ PUSHORT ButtonCapsLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Description: + HidP_GetButtonCaps returns all the buttons (binary values) that are a part + of the given report type for the Hid device represented by the given + preparsed data. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + UsagePage A usage page value used to limit the button caps returned to + those on a given usage page. If set to 0, this parameter is + ignored. Can be used with LinkCollection and Usage parameters + to further limit the number of button caps structures returned. + + LinkCollection HIDP_LINK_COLLECTION node array index used to limit the + button caps returned to those buttons in a given link + collection. If set to 0, this parameter is + ignored. Can be used with UsagePage and Usage parameters + to further limit the number of button caps structures + returned. + + Usage A usage value used to limit the button caps returned to those + with the specified usage value. If set to 0, this parameter + is ignored. Can be used with LinkCollection and UsagePage + parameters to further limit the number of button caps + structures returned. + + ButtonCaps A _HIDP_BUTTON_CAPS array containing information about all the + binary values in the given report. This buffer is provided by + the caller. + + ButtonCapsLength As input, this parameter specifies the length of the + ButtonCaps parameter (array) in number of array elements. + As output, this value is set to indicate how many of those + array elements were filled in by the function. The maximum number of + button caps that can be returned is found in the HIDP_CAPS + structure. If HIDP_STATUS_BUFFER_TOO_SMALL is returned, + this value contains the number of array elements needed to + successfully complete the request. + + PreparsedData The preparsed data returned from HIDCLASS. + + +Return Value +HidP_GetSpecificButtonCaps returns the following error codes: + HIDP_STATUS_SUCCESS. + HIDP_STATUS_INVALID_REPORT_TYPE + HIDP_STATUS_INVALID_PREPARSED_DATA + HIDP_STATUS_BUFFER_TOO_SMALL (all given entries however have been filled in) + HIDP_STATUS_USAGE_NOT_FOUND +--*/ +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +NTSTATUS __stdcall +HidP_GetButtonCaps ( + _In_ HIDP_REPORT_TYPE ReportType, + _Out_writes_to_(*ButtonCapsLength, *ButtonCapsLength) PHIDP_BUTTON_CAPS ButtonCaps, + _Inout_ PUSHORT ButtonCapsLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData +); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetSpecificValueCaps ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_opt_ USAGE UsagePage, // Optional (0 => ignore) + _In_opt_ USHORT LinkCollection, // Optional (0 => ignore) + _In_opt_ USAGE Usage, // Optional (0 => ignore) + _Out_writes_to_(*ValueCapsLength, *ValueCapsLength) PHIDP_VALUE_CAPS ValueCaps, + _Inout_ PUSHORT ValueCapsLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Description: + HidP_GetValueCaps returns all the values (non-binary) that are a part + of the given report type for the Hid device represented by the given + preparsed data. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + UsagePage A usage page value used to limit the value caps returned to + those on a given usage page. If set to 0, this parameter is + ignored. Can be used with LinkCollection and Usage parameters + to further limit the number of value caps structures returned. + + LinkCollection HIDP_LINK_COLLECTION node array index used to limit the + value caps returned to those buttons in a given link + collection. If set to 0, this parameter is + ignored. Can be used with UsagePage and Usage parameters + to further limit the number of value caps structures + returned. + + Usage A usage value used to limit the value caps returned to those + with the specified usage value. If set to 0, this parameter + is ignored. Can be used with LinkCollection and UsagePage + parameters to further limit the number of value caps + structures returned. + + ValueCaps A _HIDP_VALUE_CAPS array containing information about all the + non-binary values in the given report. This buffer is provided + by the caller. + + ValueLength As input, this parameter specifies the length of the ValueCaps + parameter (array) in number of array elements. As output, + this value is set to indicate how many of those array elements + were filled in by the function. The maximum number of + value caps that can be returned is found in the HIDP_CAPS + structure. If HIDP_STATUS_BUFFER_TOO_SMALL is returned, + this value contains the number of array elements needed to + successfully complete the request. + + PreparsedData The preparsed data returned from HIDCLASS. + + +Return Value +HidP_GetValueCaps returns the following error codes: + HIDP_STATUS_SUCCESS. + HIDP_STATUS_INVALID_REPORT_TYPE + HIDP_STATUS_INVALID_PREPARSED_DATA + HIDP_STATUS_BUFFER_TOO_SMALL (all given entries however have been filled in) + HIDP_STATUS_USAGE_NOT_FOUND + +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetValueCaps ( + _In_ HIDP_REPORT_TYPE ReportType, + _Out_writes_to_(*ValueCapsLength, *ValueCapsLength) PHIDP_VALUE_CAPS ValueCaps, + _Inout_ PUSHORT ValueCapsLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData +); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetExtendedAttributes ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USHORT DataIndex, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_writes_to_(*LengthAttributes, *LengthAttributes) PHIDP_EXTENDED_ATTRIBUTES Attributes, + _Inout_ PULONG LengthAttributes + ); +/*++ +Description: + Given a data index from the value or button capabilities of a given control + return any extended attributes for the control if any exist. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataIndex The data index for the given control, found in the capabilities + structure for that control + + PreparsedData The preparsed data returned from HIDCLASS. + + Attributes Pointer to a buffer into which the extended attribute data will + be copied. + + LengthAttributes Length of the given buffer in bytes. + +Return Value + HIDP_STATUS_SUCCESS + HIDP_STATUS_DATA_INDEX_NOT_FOUND +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_InitializeReportForID ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ UCHAR ReportID, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_writes_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + + Initialize a report based on the given report ID. + +Parameters: + + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + PreparasedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + +--*/ + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetData ( + _In_ HIDP_REPORT_TYPE ReportType, + _Inout_updates_to_(*DataLength,*DataLength) PHIDP_DATA DataList, + _Inout_ PULONG DataLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + + Please Note: Since usage value arrays deal with multiple fields for + for one usage value, they cannot be used with HidP_SetData + and HidP_GetData. In this case, + HIDP_STATUS_IS_USAGE_VALUE_ARRAY will be returned. + +Parameters: + + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataList Array of HIDP_DATA structures that contains the data values + that are to be set into the given report + + DataLength As input, length in array elements of DataList. As output, + contains the number of data elements set on successful + completion or an index into the DataList array to identify + the faulting HIDP_DATA value if an error code is returned. + + PreparasedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + HidP_SetData returns the following error codes. The report packet will + have all the data set up until the HIDP_DATA structure that caused the + error. DataLength, in the error case, will return this problem index. + + HIDP_STATUS_SUCCESS -- upon successful insertion of all data + into the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_DATA_INDEX_NOT_FOUND -- if a HIDP_DATA structure referenced a + data index that does not exist for this + device's ReportType + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_IS_USAGE_VALUE_ARRAY -- if one of the HIDP_DATA structures + references a usage value array. + DataLength will contain the index into + the array that was invalid + HIDP_STATUS_BUTTON_NOT_PRESSED -- if a HIDP_DATA structure attempted + to unset a button that was not already + set in the Report + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- a HIDP_DATA structure was found with + a valid index value but is contained + in a different report than the one + currently being processed + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough entries in + a given Main Array Item to report all + buttons that have been requested to be + set +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetData ( + _In_ HIDP_REPORT_TYPE ReportType, + _Out_writes_to_(*DataLength,*DataLength) PHIDP_DATA DataList, + _Inout_ PULONG DataLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_writes_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + + Please Note: For obvious reasons HidP_SetData and HidP_GetData will not + access UsageValueArrays. + +Parameters: + ReportType One of HidP_Input, HidP_Output, or HidP_Feature. + + DataList Array of HIDP_DATA structures that will receive the data + values that are set in the given report + + DataLength As input, length in array elements of DataList. As output, + contains the number of data elements that were successfully + set by HidP_GetData. The maximum size necessary for DataList + can be determined by calling HidP_MaxDataListLength + + PreparsedData Preparsed data structure returned by HIDCLASS + + Report Buffer which to set the data into. + + ReportLength Length of Report...Report should be at least as long as the + value indicated in the HIDP_CAPS structure for the device and + the corresponding ReportType + +Return Value + HidP_GetData returns the following error codes. + + HIDP_STATUS_SUCCESS -- upon successful retrieval of all data + from the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not equal + to the length specified in HIDP_CAPS + structure for the given ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough array entries in + DataList to store all the indice values + in the given report. DataLength will + contain the number of array entries + required to hold all data +--*/ + +_IRQL_requires_max_(DISPATCH_LEVEL) +ULONG __stdcall +HidP_MaxDataListLength ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + + This function returns the maximum length of HIDP_DATA elements that + HidP_GetData could return for the given report type. + +Parameters: + + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + PreparsedData Preparsed data structure returned by HIDCLASS + +Return Value: + + The length of the data list array required for the HidP_GetData function + call. If an error occurs (either HIDP_STATUS_INVALID_REPORT_TYPE or + HIDP_STATUS_INVALID_PREPARSED_DATA), this function returns 0. + +--*/ + +#define HidP_SetButtons(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) \ + HidP_SetUsages(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetUsages ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _Inout_updates_to_(*UsageLength,*UsageLength) PUSAGE UsageList, + _Inout_ PULONG UsageLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + This function sets binary values (buttons) in a report. Given an + initialized packet of correct length, it modifies the report packet so that + each element in the given list of usages has been set in the report packet. + For example, in an output report with 5 LED's, each with a given usage, + an application could turn on any subset of these lights by placing their + usages in any order into the usage array (UsageList). HidP_SetUsages would, + in turn, set the appropriate bit or add the corresponding byte into the + HID Main Array Item. + + A properly initialized Report packet is one of the correct byte length, + and all zeros. + + NOTE: A packet that has already been set with a call to a HidP_Set routine + can also be passed in. This routine then sets processes the UsageList + in the same fashion but verifies that the ReportID already set in + Report matches the report ID for the given usages. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage array, which HidP_SetUsages will + set in the report, refer to this same usage page. + If a client wishes to set usages in a report for multiple + usage pages then that client needs to make multiple calls to + HidP_SetUsages for each of the usage pages. + + UsageList A usage array containing the usages that HidP_SetUsages will set in + the report packet. + + UsageLength The length of the given usage array in array elements. + The parser will set this value to the position in the usage + array where it stopped processing. If successful, UsageLength + will be unchanged. In any error condition, this parameter + reflects how many of the usages in the usage list have + actually been set by the parser. This is useful for finding + the usage in the list which caused the error. + + PreparsedData The preparsed data recevied from HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet...Must be equal to the + value reported in the HIDP_CAPS structure for the device + and corresponding report type. + +Return Value + HidP_SetUsages returns the following error codes. On error, the report packet + will be correct up until the usage element that caused the error. + + HIDP_STATUS_SUCCESS -- upon successful insertion of all usages + into the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if a usage was found that exists in a + different report. If the report is + zero-initialized on entry the first + usage in the list will determine which + report ID is used. Otherwise, the + parser will verify that usage matches + the passed in report's ID + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage does not exist for any + report (no matter what the report ID) + for the given report type. + HIDP_STATUS_BUFFER_TOO_SMALL -- if there are not enough entries in a + given Main Array Item to list all of + the given usages. The caller needs + to split his request into more than + one call +--*/ + +#define HidP_UnsetButtons(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) \ + HidP_UnsetUsages(Rty, Up, Lco, ULi, ULe, Ppd, Rep, Rle) + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_UnsetUsages ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _Inout_updates_to_(*UsageLength,*UsageLength) PUSAGE UsageList, + _Inout_ PULONG UsageLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + This function unsets (turns off) binary values (buttons) in the report. Given + an initialized packet of correct length, it modifies the report packet so + that each element in the given list of usages has been unset in the + report packet. + + This function is the "undo" operation for SetUsages. If the given usage + is not already set in the Report, it will return an error code of + HIDP_STATUS_BUTTON_NOT_PRESSED. If the button is pressed, HidP_UnsetUsages + will unset the appropriate bit or remove the corresponding index value from + the HID Main Array Item. + + A properly initialized Report packet is one of the correct byte length, + and all zeros.. + + NOTE: A packet that has already been set with a call to a HidP_Set routine + can also be passed in. This routine then processes the UsageList + in the same fashion but verifies that the ReportID already set in + Report matches the report ID for the given usages. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage array, which HidP_UnsetUsages will + unset in the report, refer to this same usage page. + If a client wishes to unset usages in a report for multiple + usage pages then that client needs to make multiple calls to + HidP_UnsetUsages for each of the usage pages. + + UsageList A usage array containing the usages that HidP_UnsetUsages will + unset in the report packet. + + UsageLength The length of the given usage array in array elements. + The parser will set this value to the position in the usage + array where it stopped processing. If successful, UsageLength + will be unchanged. In any error condition, this parameter + reflects how many of the usages in the usage list have + actually been unset by the parser. This is useful for finding + the usage in the list which caused the error. + + PreparsedData The preparsed data recevied from HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet...Must be equal to the + value reported in the HIDP_CAPS structure for the device + and corresponding report type. + +Return Value + HidP_UnsetUsages returns the following error codes. On error, the report + packet will be correct up until the usage element that caused the error. + + HIDP_STATUS_SUCCESS -- upon successful "unsetting" of all usages + in the report packet. + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if a usage was found that exists in a + different report. If the report is + zero-initialized on entry the first + usage in the list will determine which + report ID is used. Otherwise, the + parser will verify that usage matches + the passed in report's ID + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage does not exist for any + report (no matter what the report ID) + for the given report type. + HIDP_STATUS_BUTTON_NOT_PRESSED -- if a usage corresponds to a button that + is not already set in the given report +--*/ + +#define HidP_GetButtons(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe) \ + HidP_GetUsages(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe) + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_GetUsages ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _Out_writes_to_(*UsageLength, *UsageLength) PUSAGE UsageList, + _Inout_ PULONG UsageLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Out_writes_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ + +Routine Description: + This function returns the binary values (buttons) that are set in a HID + report. Given a report packet of correct length, it searches the report + packet for each usage for the given usage page and returns them in the + usage list. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage All of the usages in the usage list, which HidP_GetUsages will + retrieve in the report, refer to this same usage page. + If the client wishes to get usages in a packet for multiple + usage pages then that client needs to make multiple calls + to HidP_GetUsages. + + LinkCollection An optional value which can limit which usages are returned + in the UsageList to those usages that exist in a specific + LinkCollection. A non-zero value indicates the index into + the HIDP_LINK_COLLECITON_NODE list returned by + HidP_GetLinkCollectionNodes of the link collection the + usage should belong to. A value of 0 indicates this + should value be ignored. + + UsageList The usage array that will contain all the usages found in + the report packet. + + UsageLength The length of the given usage array in array elements. + On input, this value describes the length of the usage list. + On output, HidP_GetUsages sets this value to the number of + usages that was found. Use HidP_MaxUsageListLength to + determine the maximum length needed to return all the usages + that a given report packet may contain. + + PreparsedData Preparsed data structure returned by HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet + + +Return Value + HidP_GetUsages returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving all the + usages from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if the UsageList is not big enough to + hold all the usages found in the report + packet. If this is returned, the buffer + will contain UsageLength number of + usages. Use HidP_MaxUsageListLength to + find the maximum length needed + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if no usages were found but usages + that match the UsagePage and + LinkCollection specified could be found + in a report with a different report ID + HIDP_STATUS_USAGE_NOT_FOUND -- if there are no usages in a reports for + the device and ReportType that match the + UsagePage and LinkCollection that were + specified +--*/ + +#define HidP_GetButtonsEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe) \ + HidP_GetUsagesEx(Rty, LCo, BLi, ULe, Ppd, Rep, RLe) + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_GetUsagesEx ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_opt_ USHORT LinkCollection, // Optional + _Inout_updates_to_(*UsageLength,*UsageLength) PUSAGE_AND_PAGE ButtonList, + _Inout_ ULONG * UsageLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ + +Routine Description: + This function returns the binary values (buttons) in a HID report. + Given a report packet of correct length, it searches the report packet + for all buttons and returns the UsagePage and Usage for each of the buttons + it finds. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + LinkCollection An optional value which can limit which usages are returned + in the ButtonList to those usages that exist in a specific + LinkCollection. A non-zero value indicates the index into + the HIDP_LINK_COLLECITON_NODE list returned by + HidP_GetLinkCollectionNodes of the link collection the + usage should belong to. A value of 0 indicates this + should value be ignored. + + ButtonList An array of USAGE_AND_PAGE structures describing all the + buttons currently ``down'' in the device. + + UsageLength The length of the given array in terms of elements. + On input, this value describes the length of the list. On + output, HidP_GetUsagesEx sets this value to the number of + usages that were found. Use HidP_MaxUsageListLength to + determine the maximum length needed to return all the usages + that a given report packet may contain. + + PreparsedData Preparsed data returned by HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value + HidP_GetUsagesEx returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving all the + usages from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_BUFFER_TOO_SMALL -- if ButtonList is not big enough to + hold all the usages found in the report + packet. If this is returned, the buffer + will contain UsageLength number of + usages. Use HidP_MaxUsageListLength to + find the maximum length needed + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- if no usages were found but usages + that match the specified LinkCollection + exist in report with a different report + ID. + HIDP_STATUS_USAGE_NOT_FOUND -- if there are no usages in any reports that + match the LinkCollection parameter +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +ULONG __stdcall +HidP_MaxUsageListLength ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_opt_ USAGE UsagePage, // Optional + _In_ PHIDP_PREPARSED_DATA PreparsedData + ); +/*++ +Routine Description: + This function returns the maximum number of usages that a call to + HidP_GetUsages or HidP_GetUsagesEx could return for a given HID report. + If calling for number of usages returned by HidP_GetUsagesEx, use 0 as + the UsagePage value. + +Parameters: + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage Specifies the optional UsagePage to query for. If 0, will + return all the maximum number of usage values that could be + returned for a given ReportType. If non-zero, will return + the maximum number of usages that would be returned for the + ReportType with the given UsagePage. + + PreparsedData Preparsed data returned from HIDCLASS + +Return Value: + The length of the usage list array required for the HidP_GetUsages or + HidP_GetUsagesEx function call. If an error occurs (such as + HIDP_STATUS_INVALID_REPORT_TYPE or HIDP_INVALID_PREPARSED_DATA, this + returns 0. +--*/ + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetUsageValue ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _In_ ULONG UsageValue, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Inout_updates_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); +/*++ +Description: + HidP_SetUsageValue inserts a value into the HID Report Packet in the field + corresponding to the given usage page and usage. HidP_SetUsageValue + casts this value to the appropriate bit length. If a report packet + contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + Using this function sets the raw value into the report packet with + no checking done as to whether it actually falls within the logical + minimum/logical maximum range. Use HidP_SetScaledUsageValue for this... + + NOTE: Although the UsageValue parameter is a ULONG, any casting that is + done will preserve or sign-extend the value. The value being set + should be considered a LONG value and will be treated as such by + this function. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_SetUsageValue will set. + + UsageValue The raw value to set in the report buffer. This value must be within + the logical range or if a NULL value this value should be the + most negative value that can be represented by the number of bits + for this field. + + PreparsedData The preparsed data returned for HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_SetUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully setting the value + in the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call HidP_SetUsageValue + again with a zero-initizialed report + packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetScaledUsageValue ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _In_ LONG UsageValue, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Inout_updates_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Description: + HidP_SetScaledUsageValue inserts the UsageValue into the HID report packet + in the field corresponding to the given usage page and usage. If a report + packet contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + + If the specified field has a defined physical range, this function converts + the physical value specified to the corresponding logical value for the + report. If a physical value does not exist, the function will verify that + the value specified falls within the logical range and set according. + + If the range checking fails but the field has NULL values, the function will + set the field to the defined NULL value (most negative number possible) and + return HIDP_STATUS_NULL. In other words, use this function to set NULL + values for a given field by passing in a value that falls outside the + physical range if it is defined or the logical range otherwise. + + If the field does not support NULL values, an out of range error will be + returned instead. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_SetScaledUsageValue will set. + + UsageValue The value to set in the report buffer. See the routine + description above for the different interpretations of this + value + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_SetScaledUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully setting the value + in the report packet + HIDP_STATUS_NULL -- upon successfully setting the value + in the report packet as a NULL value + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_VALUE_OUT_OF_RANGE -- if the value specified failed to fall + within the physical range if it exists + or within the logical range otherwise + and the field specified by the usage + does not allow NULL values + HIDP_STATUS_BAD_LOG_PHY_VALUES -- if the field has a physical range but + either the logical range is invalid + (max <= min) or the physical range is + invalid + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_SetScaledUsageValue again with + a zero-initialized report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetUsageValueArray ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _In_reads_bytes_(UsageValueByteLength) PCHAR UsageValue, + _In_ USHORT UsageValueByteLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Inout_updates_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Routine Descripton: + A usage value array occurs when the last usage in the list of usages + describing a main item must be repeated because there are less usages defined + than there are report counts declared for the given main item. In this case + a single value cap is allocated for that usage and the report count of that + value cap is set to reflect the number of fields to which that usage refers. + + HidP_SetUsageValueArray sets the raw bits for that usage which spans + more than one field in a report. + + NOTE: This function currently does not support value arrays where the + ReportSize for each of the fields in the array is not a multiple + of 8 bits. + + The UsageValue buffer should have the values set as they would appear + in the report buffer. If this function supported non 8-bit multiples + for the ReportSize then caller should format the input buffer so that + each new value begins at the bit immediately following the last bit + of the previous value + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value array HidP_SetUsageValueArray will set. + + UsageValue The buffer with the values to set into the value array. + The number of BITS required is found by multiplying the + BitSize and ReportCount fields of the Value Cap for this + control. The least significant bit of this control found in the + given report will be placed in the least significan bit location + of the array given (little-endian format), regardless of whether + or not the field is byte alligned or if the BitSize is a multiple + of sizeof (CHAR). + + See the above note for current implementation limitations. + + UsageValueByteLength Length of the UsageValue buffer (in bytes) + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HIDP_STATUS_SUCCESS -- upon successfully setting the value + array in the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_NOT_VALUE_ARRAY -- if the control specified is not a + value array -- a value array will have + a ReportCount field in the + HIDP_VALUE_CAPS structure that is > 1 + Use HidP_SetUsageValue instead + HIDP_STATUS_BUFFER_TOO_SMALL -- if the size of the passed in buffer with + the values to set is too small (ie. has + fewer values than the number of fields in + the array + HIDP_STATUS_NOT_IMPLEMENTED -- if the usage value array has field sizes + that are not multiples of 8 bits, this + error code is returned since the function + currently does not handle setting into + such arrays. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_SetUsageValueArray again with + a zero-initialized report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_GetUsageValue ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _Out_ PULONG UsageValue, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/* +Description + HidP_GetUsageValue retrieves the value from the HID Report for the usage + specified by the combination of usage page, usage and link collection. + If a report packet contains two different fields with the same + Usage and UsagePage, they can be distinguished with the optional + LinkCollection field value. + +Parameters: + + ReportType One of HidP_Input or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_GetUsageValue will retrieve + + UsageValue The raw value that is set for the specified field in the report + buffer. This value will either fall within the logical range + or if NULL values are allowed, a number outside the range to + indicate a NULL + + PreparsedData The preparsed data returned for HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_GetUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call HidP_GetUsageValue + again with a different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_GetScaledUsageValue ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _Out_ PLONG UsageValue, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Description + HidP_GetScaledUsageValue retrieves a UsageValue from the HID report packet + in the field corresponding to the given usage page and usage. If a report + packet contains two different fields with the same Usage and UsagePage, + they can be distinguished with the optional LinkCollection field value. + + If the specified field has a defined physical range, this function converts + the logical value that exists in the report packet to the corresponding + physical value. If a physical range does not exist, the function will + return the logical value. This function will check to verify that the + logical value in the report falls within the declared logical range. + + When doing the conversion between logical and physical values, this + function assumes a linear extrapolation between the physical max/min and + the logical max/min. (Where logical is the values reported by the device + and physical is the value returned by this function). If the data field + size is less than 32 bits, then HidP_GetScaledUsageValue will sign extend + the value to 32 bits. + + If the range checking fails but the field has NULL values, the function + will set UsageValue to 0 and return HIDP_STATUS_NULL. Otherwise, it + returns a HIDP_STATUS_OUT_OF_RANGE error. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will retrieve the first + field it finds that matches the usage page + and usage. + + Usage The usage whose value HidP_GetScaledUsageValue will retrieve + + UsageValue The value retrieved from the report buffer. See the routine + description above for the different interpretations of this + value + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. + + ReportLength Length (in bytes) of the given report packet. + + +Return Value: + HidP_GetScaledUsageValue returns the following error codes: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_NULL -- if the report packet had a NULL value + set + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_VALUE_OUT_OF_RANGE -- if the value retrieved from the packet + falls outside the logical range and + the field does not support NULL values + HIDP_STATUS_BAD_LOG_PHY_VALUES -- if the field has a physical range but + either the logical range is invalid + (max <= min) or the physical range is + invalid + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_GetScaledUsageValue with a + different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_GetUsageValueArray ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _Inout_updates_bytes_(UsageValueByteLength) PCHAR UsageValue, + _In_ USHORT UsageValueByteLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Routine Descripton: + A usage value array occurs when the last usage in the list of usages + describing a main item must be repeated because there are less usages defined + than there are report counts declared for the given main item. In this case + a single value cap is allocated for that usage and the report count of that + value cap is set to reflect the number of fields to which that usage refers. + + HidP_GetUsageValueArray returns the raw bits for that usage which spans + more than one field in a report. + + NOTE: This function currently does not support value arrays where the + ReportSize for each of the fields in the array is not a multiple + of 8 bits. + + The UsageValue buffer will have the raw values as they are set + in the report packet. + +Parameters: + + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate + between two fields that may have the same + UsagePage and Usage but exist in different + collections. If the link collection value + is zero, this function will set the first field + it finds that matches the usage page and + usage. + + Usage The usage whose value HidP_GetUsageValueArray will retreive. + + UsageValue A pointer to an array of characters where the value will be + placed. The number of BITS required is found by multiplying the + BitSize and ReportCount fields of the Value Cap for this + control. The least significant bit of this control found in the + given report will be placed in the least significant bit location + of the buffer (little-endian format), regardless of whether + or not the field is byte aligned or if the BitSize is a multiple + of sizeof (CHAR). + + See note above about current implementation limitations + + UsageValueByteLength + the length of the given UsageValue buffer. + + PreparsedData The preparsed data returned by the HIDCLASS + + Report The report packet. + + ReportLength Length of the given report packet. + +Return Value: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the value + from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_NOT_VALUE_ARRAY -- if the control specified is not a + value array -- a value array will have + a ReportCount field in the + HIDP_VALUE_CAPS structure that is > 1 + Use HidP_GetUsageValue instead + HIDP_STATUS_BUFFER_TOO_SMALL -- if the size of the passed in buffer in + which to return the array is too small + (ie. has fewer values than the number of + fields in the array + HIDP_STATUS_NOT_IMPLEMENTED -- if the usage value array has field sizes + that are not multiples of 8 bits, this + error code is returned since the function + currently does not handle getting values + from such arrays. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_GetUsageValueArray with a + different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_UsageListDifference ( + _In_reads_(UsageListLength) PUSAGE PreviousUsageList, + _In_reads_(UsageListLength) PUSAGE CurrentUsageList, + _Out_writes_(UsageListLength) PUSAGE BreakUsageList, + _Out_writes_(UsageListLength) PUSAGE MakeUsageList, + _In_ ULONG UsageListLength + ); +/*++ +Routine Description: + This function will return the difference between a two lists of usages + (as might be returned from HidP_GetUsages), In other words, it will return + return a list of usages that are in the current list but not the previous + list as well as a list of usages that are in the previous list but not + the current list. + +Parameters: + + PreviousUsageList The list of usages before. + CurrentUsageList The list of usages now. + BreakUsageList Previous - Current. + MakeUsageList Current - Previous. + UsageListLength Represents the length of the usage lists in array + elements. If comparing two lists with a differing + number of array elements, this value should be + the size of the larger of the two lists. Any + zero found with a list indicates an early termination + of the list and any usages found after the first zero + will be ignored. +--*/ + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +NTSTATUS __stdcall +HidP_UsageAndPageListDifference ( + _In_reads_(UsageListLength) PUSAGE_AND_PAGE PreviousUsageList, + _In_reads_(UsageListLength) PUSAGE_AND_PAGE CurrentUsageList, + _Out_writes_(UsageListLength) PUSAGE_AND_PAGE BreakUsageList, + _Out_writes_(UsageListLength) PUSAGE_AND_PAGE MakeUsageList, + _In_ ULONG UsageListLength + ); + +// +// Used to get/set data for single button in a ButtonArray. +// +typedef struct _HIDP_BUTTON_ARRAY_DATA +{ + // + // The position (zero-based index) of the button within the ButtonArray. + // Value will always be < HIDP_BUTTON_CAPS.ReportCount + // (Note: This is NOT an index 'of' a ButtonArray within the preparsed data.) + // + USHORT ArrayIndex; + + // + // TRUE when the button at the ArrayIndex (within the ButtonArray) is 'On'. + // This is FALSE when the button is 'Off'. + // + BOOLEAN On; +} HIDP_BUTTON_ARRAY_DATA, *PHIDP_BUTTON_ARRAY_DATA; + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_GetButtonArray ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _Out_writes_to_(*ButtonDataLength, *ButtonDataLength) PHIDP_BUTTON_ARRAY_DATA ButtonData, + _Inout_ PUSHORT ButtonDataLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _In_reads_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Routine Descripton: + A button array occurs when the last usage in the sequence of usages + describing a main item, must be repeated because there are less usages defined + than the ReportCount declared for the given main item. In this case, + a single HIDP_BUTTON_CAPS is allocated for that usage and the ReportCount of the + HIDP_BUTTON_CAPS is set to reflect the number of fields the usage refers. + + A HIDP_BUTTON_CAPS that describes a button array, will always have ReportCount > 1. + If ReportCount == 1, then it is not a button array and cannot be used with HidP_GetButtonArray. + (see instead HidP_GetUsages) + + HidP_GetButtonArray returns (via _Out_ parameter) an array of HIDP_BUTTON_ARRAY_DATAs, one for each button + (in the first button array found (and within the specified LinkCollection) with the supplied Usage) + that is set to ON, for the supplied Report. + + +Parameters: + + ReportType One of HidP_Input, HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate between two fields that may have + the same UsagePage and Usage but exist in different collections. + If the LinkCollection value is HIDP_LINK_COLLECTION_UNSPECIFIED, the first found button array + matching the UsagePage and Usage will be returned (regardless of location). + If the LinkCollection value is HIDP_LINK_COLLECTION_ROOT, the first found button array (in the + root collection) matching the UsagePage and Usage will be returned. + + Usage The usage whose buttons HidP_GetButtonArray will retrieve. + + ButtonData A HIDP_BUTTON_ARRAY_DATAs array where the data of buttons set to ON will be + placed. The number of elements required is the ReportCount field + of the HIDP_BUTTON_CAPS for this control. This buffer is provided by + the caller. + + ButtonDataLength As input, this parameter specifies the length of the + ButtonData parameter (array) in number of array elements (NOT number of bytes). + As output, if HIDP_STATUS_SUCCESS is returned, this value is set to indicate how many of those + array elements were filled in by the function. The maximum number of + HIDP_BUTTON_ARRAY_DATA that can be returned is determined by HIDP_BUTTON_CAPS.ReportCount + If HIDP_STATUS_BUFFER_TOO_SMALL is returned, this value contains the number + of array elements needed to successfully complete the request. + + PreparsedData The preparsed data returned by the HIDCLASS + + Report The report packet. (Note: The first byte MUST be the ReportId; this will be correctly set if the report is read from the system) + + ReportLength Length of the given report packet (in bytes). + +Return Value: + + HIDP_STATUS_SUCCESS -- upon successfully retrieving the buttons + from the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_NOT_BUTTON_ARRAY -- if the control specified is not a + button array -- a button array will have + a ReportCount field in the + HIDP_BUTTON_CAPS structure that is > 1. + If ReportCount == 1, Use HidP_GetUsages instead. + HIDP_STATUS_BUFFER_TOO_SMALL -- if the size of the passed in buffer in + which to return the array is too small + (i.e. has fewer values than the number of + fields in the array). ButtonDataLength will be set + to the required size. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_GetButtonArray with a + different report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType +--*/ + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_SetButtonArray ( + _In_ HIDP_REPORT_TYPE ReportType, + _In_ USAGE UsagePage, + _In_opt_ USHORT LinkCollection, + _In_ USAGE Usage, + _In_reads_(ButtonDataLength) PHIDP_BUTTON_ARRAY_DATA ButtonData, + _In_ USHORT ButtonDataLength, + _In_ PHIDP_PREPARSED_DATA PreparsedData, + _Inout_updates_bytes_(ReportLength) PCHAR Report, + _In_ ULONG ReportLength + ); + +/*++ +Routine Descripton: + A button array occurs when the last usage in the sequence of usages + describing a main item, must be repeated because there are less usages defined + than the ReportCount declared for the given main item. In this case, + a single HIDP_BUTTON_CAPS is allocated for that usage and the ReportCount of the + HIDP_BUTTON_CAPS is set to reflect the number of fields the usage refers. + + A HIDP_BUTTON_CAPS that describes a button array, will always have ReportCount > 1. + If ReportCount == 1, then it is not a button array and cannot be used with HidP_SetButtonArray. + (see instead HidP_SetUsages) + + HidP_SetButtonArray sets the state of buttons via an array of HIDP_BUTTON_ARRAY_DATAs. + + HidP_SetButtonArray sets the state of buttons via an array of HIDP_BUTTON_ARRAY_DATAs + (for the first button array found (and within the specified LinkCollection) with the supplied Usage) + for the supplied Report. + +Parameters: + + ReportType One of HidP_Output or HidP_Feature. + + UsagePage The usage page to which the given usage refers. + + LinkCollection (Optional) This value can be used to differentiate between two fields that may have + the same UsagePage and Usage but exist in different collections. + If the LinkCollection value is HIDP_LINK_COLLECTION_UNSPECIFIED, the first found button array + matching the UsagePage and Usage will be returned (regardless of location). + If the LinkCollection value is HIDP_LINK_COLLECTION_ROOT, the first found button array (in the + root collection) matching the UsagePage and Usage will be returned. + + Usage The usage whose button array HidP_SetButtonArray will set. + + ButtonData The buffer with the values to set into the button array. + + ButtonDataLength Number of elements in the ButtonData buffer. + + PreparsedData The preparsed data returned from HIDCLASS + + Report The report packet. (Note: The first byte MUST be the ReportId). + + ReportLength Length of the given report packet (in bytes). + + +Return Value: + HIDP_STATUS_SUCCESS -- upon successfully setting the value + array in the report packet + HIDP_STATUS_INVALID_REPORT_TYPE -- if ReportType is not valid. + HIDP_STATUS_INVALID_PREPARSED_DATA -- if PreparsedData is not valid + HIDP_STATUS_INVALID_REPORT_LENGTH -- the length of the report packet is not + equal to the length specified in + the HIDP_CAPS structure for the given + ReportType + HIDP_STATUS_REPORT_DOES_NOT_EXIST -- if there are no reports on this device + for the given ReportType + HIDP_STATUS_NOT_BUTTON_ARRAY -- if the control specified is not a + button array -- a button array will have + a ReportCount field in the + HIDP_BUTTON_CAPS structure that is > 1. + If ReportCount == 1, Use HidP_SetUsages instead. + HIDP_STATUS_INCOMPATIBLE_REPORT_ID -- the specified usage page, usage and + link collection exist but exists in + a report with a different report ID + than the report being passed in. To + set this value, call + HidP_SetButtonArray again with + a zero-initialized report packet + HIDP_STATUS_USAGE_NOT_FOUND -- if the usage page, usage, and link + collection combination does not exist + in any reports for this ReportType + HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE -- if the ArrayIndex for one of the supplied HIDP_BUTTON_ARRAY_DATA + is outside the valid range for this button array (i.e. >= HIDP_BUTTON_CAPS.ReportCount) +--*/ + + +// +// Produce Make or Break Codes +// +typedef enum _HIDP_KEYBOARD_DIRECTION { + HidP_Keyboard_Break, + HidP_Keyboard_Make +} HIDP_KEYBOARD_DIRECTION; + +// +// A bitmap of the current shift state of the keyboard when using the +// below keyboard usages to i8042 translation function. +// +typedef struct _HIDP_KEYBOARD_MODIFIER_STATE { + union { + struct { + ULONG LeftControl: 1; + ULONG LeftShift: 1; + ULONG LeftAlt: 1; + ULONG LeftGUI: 1; + ULONG RightControl: 1; + ULONG RightShift: 1; + ULONG RightAlt: 1; + ULONG RigthGUI: 1; + ULONG CapsLock: 1; + ULONG ScollLock: 1; + ULONG NumLock: 1; + ULONG Reserved: 21; + }; + ULONG ul; + }; + +} HIDP_KEYBOARD_MODIFIER_STATE, * PHIDP_KEYBOARD_MODIFIER_STATE; + +// +// A call back function to give the i8042 scan codes to the caller of +// the below translation function. +// +typedef BOOLEAN (* PHIDP_INSERT_SCANCODES) ( + _In_opt_ PVOID Context, // Some caller supplied context. + _In_reads_bytes_(Length) PCHAR NewScanCodes, // A list of i8042 scan codes. + _In_ ULONG Length // the length of the scan codes. + ); + +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_TranslateUsageAndPagesToI8042ScanCodes ( + _In_reads_(UsageListLength) PUSAGE_AND_PAGE ChangedUsageList, + _In_ ULONG UsageListLength, + _In_ HIDP_KEYBOARD_DIRECTION KeyAction, + _Inout_ PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, + _In_ PHIDP_INSERT_SCANCODES InsertCodesProcedure, + _In_opt_ PVOID InsertCodesContext + ); +/*++ +Routine Description: +Parameters: +--*/ +_Must_inspect_result_ +NTSTATUS __stdcall +HidP_TranslateUsagesToI8042ScanCodes ( + _In_reads_(UsageListLength) PUSAGE ChangedUsageList, + _In_ ULONG UsageListLength, + _In_ HIDP_KEYBOARD_DIRECTION KeyAction, + _Inout_ PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, + _In_ PHIDP_INSERT_SCANCODES InsertCodesProcedure, + _In_opt_ PVOID InsertCodesContext + ); +/*++ +Routine Description: +Parameters: +--*/ + +// +// Define NT Status codes with Facility Code of FACILITY_HID_ERROR_CODE +// + +// FACILITY_HID_ERROR_CODE defined in ntstatus.h +#ifndef FACILITY_HID_ERROR_CODE +#define FACILITY_HID_ERROR_CODE 0x11 +#endif + +#define HIDP_ERROR_CODES(SEV, CODE) \ + ((NTSTATUS) (((SEV) << 28) | (FACILITY_HID_ERROR_CODE << 16) | (CODE))) + +#define HIDP_STATUS_SUCCESS (HIDP_ERROR_CODES(0x0,0)) +#define HIDP_STATUS_NULL (HIDP_ERROR_CODES(0x8,1)) +#define HIDP_STATUS_INVALID_PREPARSED_DATA (HIDP_ERROR_CODES(0xC,1)) +#define HIDP_STATUS_INVALID_REPORT_TYPE (HIDP_ERROR_CODES(0xC,2)) +#define HIDP_STATUS_INVALID_REPORT_LENGTH (HIDP_ERROR_CODES(0xC,3)) +#define HIDP_STATUS_USAGE_NOT_FOUND (HIDP_ERROR_CODES(0xC,4)) +#define HIDP_STATUS_VALUE_OUT_OF_RANGE (HIDP_ERROR_CODES(0xC,5)) +#define HIDP_STATUS_BAD_LOG_PHY_VALUES (HIDP_ERROR_CODES(0xC,6)) +#define HIDP_STATUS_BUFFER_TOO_SMALL (HIDP_ERROR_CODES(0xC,7)) +#define HIDP_STATUS_INTERNAL_ERROR (HIDP_ERROR_CODES(0xC,8)) +#define HIDP_STATUS_I8042_TRANS_UNKNOWN (HIDP_ERROR_CODES(0xC,9)) +#define HIDP_STATUS_INCOMPATIBLE_REPORT_ID (HIDP_ERROR_CODES(0xC,0xA)) +#define HIDP_STATUS_NOT_VALUE_ARRAY (HIDP_ERROR_CODES(0xC,0xB)) +#define HIDP_STATUS_IS_VALUE_ARRAY (HIDP_ERROR_CODES(0xC,0xC)) +#define HIDP_STATUS_DATA_INDEX_NOT_FOUND (HIDP_ERROR_CODES(0xC,0xD)) +#define HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE (HIDP_ERROR_CODES(0xC,0xE)) +#define HIDP_STATUS_BUTTON_NOT_PRESSED (HIDP_ERROR_CODES(0xC,0xF)) +#define HIDP_STATUS_REPORT_DOES_NOT_EXIST (HIDP_ERROR_CODES(0xC,0x10)) +#define HIDP_STATUS_NOT_IMPLEMENTED (HIDP_ERROR_CODES(0xC,0x20)) +#define HIDP_STATUS_NOT_BUTTON_ARRAY (HIDP_ERROR_CODES(0xC,0x21)) + +// +// We blundered this status code. +// +#define HIDP_STATUS_I8242_TRANS_UNKNOWN HIDP_STATUS_I8042_TRANS_UNKNOWN + +#ifndef _KERNEL_MODE + +typedef NTSTATUS +(*PFN_HidP_GetVersionInternal)( + _Out_ ULONG* Version); + +_Must_inspect_result_ +inline NTSTATUS __stdcall +HidP_GetVersion ( + _Out_ ULONG* Version + ) +/*++ +Routine Description: + Header-only implementation of HidP versioning, to separate API versions that support HidP_GetButtonArray && HidP_SetButtonArray + APIs and those that don't. +--*/ +{ + NTSTATUS status = HIDP_STATUS_SUCCESS; + + *Version = 1; + + HMODULE module = LoadLibraryW(L"hid.dll"); + if (module == NULL) + { + // Couldn't Load the hid dll. Something is very wrong. + return HIDP_STATUS_INTERNAL_ERROR; + } + + PFN_HidP_GetVersionInternal fnVersionInternal = (PFN_HidP_GetVersionInternal) GetProcAddress(module, "HidP_GetVersionInternal"); + if (fnVersionInternal != NULL) + { + status = fnVersionInternal(Version); + } + else + { + // This DLL build doesn't support HidP_GetVersionInternal, so the version is 1. + } + + return status; +} + +#endif + +#include + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4115) +#pragma warning(default:4201) +#pragma warning(default:4214) +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidsdi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidsdi.h new file mode 100644 index 0000000000000000000000000000000000000000..925e26cd9babab5244d2c25ef8d168bf0d5aa78b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidsdi.h @@ -0,0 +1,520 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDSDI.H + +Abstract: + + This module contains the PUBLIC definitions for the + code that implements the HID dll. + +Environment: + + Kernel & user mode + +--*/ + + +#ifndef _HIDSDI_H +#define _HIDSDI_H +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +typedef _Return_type_success_(return >= 0) LONG NTSTATUS; +#include "hidusage.h" +#include "hidpi.h" + +typedef struct _HIDD_CONFIGURATION { + PVOID cookie; + ULONG size; + ULONG RingBufferSize; +} HIDD_CONFIGURATION, *PHIDD_CONFIGURATION; + +typedef struct _HIDD_ATTRIBUTES { + ULONG Size; // = sizeof (struct _HIDD_ATTRIBUTES) + + // + // Vendor ids of this hid device + // + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; + + // + // Additional fields will be added to the end of this structure. + // +} HIDD_ATTRIBUTES, *PHIDD_ATTRIBUTES; + +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetAttributes ( + _In_ HANDLE HidDeviceObject, + _Out_ PHIDD_ATTRIBUTES Attributes + ); +/*++ +Routine Description: + Fill in the given HIDD_ATTRIBUTES structure with the attributes of the + given hid device. + +--*/ + + +void __stdcall +HidD_GetHidGuid ( + _Out_ LPGUID HidGuid + ); + +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetPreparsedData ( + _In_ HANDLE HidDeviceObject, + _Out_ _When_(return!=0, __drv_allocatesMem(Mem)) PHIDP_PREPARSED_DATA * PreparsedData + ); +/*++ +Routine Description: + Given a handle to a valid Hid Class Device Object, retrieve the preparsed + data for the device. This routine will allocate the appropriately + sized buffer to hold this preparsed data. It is up to client to call + HidP_FreePreparsedData to free the memory allocated to this structure when + it is no longer needed. + +Arguments: + HidDeviceObject A handle to a Hid Device that the client obtains using + a call to CreateFile on a valid Hid device string name. + The string name can be obtained using standard PnP calls. + + PreparsedData An opaque data structure used by other functions in this + library to retrieve information about a given device. + +Return Value: + TRUE if successful. + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_FreePreparsedData ( + _In_ __drv_freesMem(Mem) PHIDP_PREPARSED_DATA PreparsedData + ); + +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_FlushQueue ( + _In_ HANDLE HidDeviceObject + ); +/*++ +Routine Description: + Flush the input queue for the given HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device that the client obtains using + a call to CreateFile on a valid Hid device string name. + The string name can be obtained using standard PnP calls. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetConfiguration ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(ConfigurationLength) PHIDD_CONFIGURATION Configuration, + _In_ ULONG ConfigurationLength + ); +/*++ +Routine Description: + Get the configuration information for this Hid device + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Configuration A configuration structure. HidD_GetConfiguration MUST + be called before the configuration can be modified and + set using HidD_SetConfiguration + + ConfigurationLength That is ``sizeof (HIDD_CONFIGURATION)''. Using this + parameter, we can later increase the length of the + configuration array and not break older apps. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_SetConfiguration ( + _In_ HANDLE HidDeviceObject, + _In_reads_bytes_(ConfigurationLength) PHIDD_CONFIGURATION Configuration, + _In_ ULONG ConfigurationLength + ); +/*++ +Routine Description: + Set the configuration information for this Hid device... + + NOTE: HidD_GetConfiguration must be called to retrieve the current + configuration information before this information can be modified + and set. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Configuration A configuration structure. HidD_GetConfiguration MUST + be called before the configuration can be modified and + set using HidD_SetConfiguration + + ConfigurationLength That is ``sizeof (HIDD_CONFIGURATION)''. Using this + parameter, we can later increase the length of the + configuration array and not break older apps. + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetFeature ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(ReportBufferLength) PVOID ReportBuffer, + _In_ ULONG ReportBufferLength + ); +/*++ +Routine Description: + Retrieve a feature report from a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer that the feature report should be placed + into. The first byte of the buffer should be set to + the report ID of the desired report + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + FeatureReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_SetFeature ( + _In_ HANDLE HidDeviceObject, + _In_reads_bytes_(ReportBufferLength) PVOID ReportBuffer, + _In_ ULONG ReportBufferLength + ); +/*++ +Routine Description: + Send a feature report to a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer of the feature report to send to the device + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + FeatureReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#if (NTDDI_VERSION >= NTDDI_WINXP) +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetInputReport ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(ReportBufferLength) PVOID ReportBuffer, + _In_ ULONG ReportBufferLength + ); +/*++ +Routine Description: + Retrieve an input report from a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer that the input report should be placed + into. The first byte of the buffer should be set to + the report ID of the desired report + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + InputReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_SetOutputReport ( + _In_ HANDLE HidDeviceObject, + _In_reads_bytes_(ReportBufferLength) PVOID ReportBuffer, + _In_ ULONG ReportBufferLength + ); +/*++ +Routine Description: + Send an output report to a HID device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + ReportBuffer The buffer of the output report to send to the device + + ReportBufferLength The size (in bytes) of ReportBuffer. This value + should be greater than or equal to the + OutputReportByteLength field as specified in the + HIDP_CAPS structure for the device +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#endif +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetNumInputBuffers ( + _In_ HANDLE HidDeviceObject, + _Out_ PULONG NumberBuffers + ); +/*++ +Routine Description: + This function returns the number of input buffers used by the specified + file handle to the Hid device. Each file object has a number of buffers + associated with it to queue reports read from the device but which have + not yet been read by the user-mode app with a handle to that device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + NumberBuffers Number of buffers currently being used for this file + handle to the Hid device + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_SetNumInputBuffers ( + _In_ HANDLE HidDeviceObject, + _In_ ULONG NumberBuffers + ); +/*++ + +Routine Description: + This function sets the number of input buffers used by the specified + file handle to the Hid device. Each file object has a number of buffers + associated with it to queue reports read from the device but which have + not yet been read by the user-mode app with a handle to that device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + NumberBuffers New number of buffers to use for this file handle to + the Hid device + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetPhysicalDescriptor ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the raw physical descriptor for the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the physical + descriptor if one exists for the specified device + handle + + BufferLength Length of buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetManufacturerString ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the manufacturer string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the manufacturer + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetProductString ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the product string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the product + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetIndexedString ( + _In_ HANDLE HidDeviceObject, + _In_ ULONG StringIndex, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves a string from the specified Hid device that is + specified with a certain string index. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + StringIndex Index of the string to retrieve + + Buffer Buffer which on return will contain the product + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetSerialNumberString ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the serial number string from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the serial number + string returned from the device. This string is a + wide-character string + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ + +#if (NTDDI_VERSION >= NTDDI_WINXP) +_Must_inspect_result_ +_Success_(return==TRUE) +BOOLEAN __stdcall +HidD_GetMsGenreDescriptor ( + _In_ HANDLE HidDeviceObject, + _Out_writes_bytes_(BufferLength) PVOID Buffer, + _In_ ULONG BufferLength + ); +/*++ +Routine Description: + This function retrieves the Microsoft Genre descriptor from the specified + Hid device. + +Arguments: + HidDeviceObject A handle to a Hid Device Object. + + Buffer Buffer which on return will contain the descriptor + returned from the device. + + BufferLength Length of Buffer (in bytes) + +Return Value: + TRUE if successful + FALSE otherwise -- Use GetLastError() to get extended error information +--*/ +#endif + + +#include + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidusage.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidusage.h new file mode 100644 index 0000000000000000000000000000000000000000..25ec47ab4e9a54abb688735937629fc123acf3da --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hidusage.h @@ -0,0 +1,3022 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + HIDUSAGE.H + +Abstract: + + Public Definitions of HID USAGES for HID Usage Tables 1.6 + +Environment: + + Kernel & user mode + +--*/ + +#ifndef __HIDUSAGE_H__ +#define __HIDUSAGE_H__ + +// +// Usage Pages +// + +typedef USHORT USAGE, *PUSAGE; + +typedef LONG USAGE_VALUE, *PUSAGE_VALUE; + +#define HID_USAGE_PAGE_UNDEFINED ((USAGE) 0x0000) +#define HID_USAGE_PAGE_ARCADE ((USAGE) 0x0091) +#define HID_USAGE_PAGE_ALPHANUMERIC ((USAGE) 0x0014) +#define HID_USAGE_PAGE_BARCODE_SCANNER ((USAGE) 0x008C) +#define HID_USAGE_PAGE_BATTERY_SYSTEM ((USAGE) 0x0085) +#define HID_USAGE_PAGE_BRAILLE_DISPLAY ((USAGE) 0x0041) +#define HID_USAGE_PAGE_BUTTON ((USAGE) 0x0009) +#define HID_USAGE_PAGE_CAMERA_CONTROL ((USAGE) 0x0090) +#define HID_USAGE_PAGE_CONSUMER ((USAGE) 0x000C) +#define HID_USAGE_PAGE_DIGITIZER ((USAGE) 0x000D) +#define HID_USAGE_PAGE_EYE_AND_HEAD_TRACKERS ((USAGE) 0x0012) +#define HID_USAGE_PAGE_FIDO_ALLIANCE ((USAGE) 0xF1D0) +#define HID_USAGE_PAGE_GAME ((USAGE) 0x0005) +#define HID_USAGE_PAGE_GAMING_DEVICE ((USAGE) 0x0092) +#define HID_USAGE_PAGE_GENERIC ((USAGE) 0x0001) +#define HID_USAGE_PAGE_GENERIC_DEVICE ((USAGE) 0x0006) +#define HID_USAGE_PAGE_HAPTICS ((USAGE) 0x000E) +#define HID_USAGE_PAGE_KEYBOARD ((USAGE) 0x0007) +#define HID_USAGE_PAGE_LED ((USAGE) 0x0008) +#define HID_USAGE_PAGE_LIGHTING_ILLUMINATION ((USAGE) 0x0059) +#define HID_USAGE_PAGE_MAGNETIC_STRIPE_READER ((USAGE) 0x008E) +#define HID_USAGE_PAGE_MEDICAL_INSTRUMENT ((USAGE) 0x0040) +#define HID_USAGE_PAGE_MICROSOFT_BLUETOOTH_HANDSFREE ((USAGE) 0xFFF3) +#define HID_USAGE_PAGE_MONITOR ((USAGE) 0x0080) +#define HID_USAGE_PAGE_MONITOR_ENUMERATED ((USAGE) 0x0081) +#define HID_USAGE_PAGE_ORDINAL ((USAGE) 0x000A) +#define HID_USAGE_PAGE_PID ((USAGE) 0x000F) +#define HID_USAGE_PAGE_POWER ((USAGE) 0x0084) +#define HID_USAGE_PAGE_WEIGHING_DEVICE ((USAGE) 0x008D) +#define HID_USAGE_PAGE_SENSOR ((USAGE) 0x0020) +#define HID_USAGE_PAGE_SIMULATION ((USAGE) 0x0002) +#define HID_USAGE_PAGE_SOC ((USAGE) 0x0011) +#define HID_USAGE_PAGE_SPORT ((USAGE) 0x0004) +#define HID_USAGE_PAGE_TELEPHONY ((USAGE) 0x000B) +#define HID_USAGE_PAGE_UNICODE ((USAGE) 0x0010) +#define HID_USAGE_PAGE_VESA_VIRTUAL_CONTROLS ((USAGE) 0x0082) +#define HID_USAGE_PAGE_VR ((USAGE) 0x0003) + +#define HID_USAGE_PAGE_VENDOR_DEFINED_BEGIN ((USAGE) 0xFF00) +#define HID_USAGE_PAGE_VENDOR_DEFINED_END ((USAGE) 0xFFFF) + +// UsageId of 0 is undefined for every UsagePage +#define HID_USAGE_UNDEFINED ((USAGE) 0x0000) + +// +// Arcade Page (0x91) +// +#define HID_USAGE_ARCADE_GENERAL_PURPOSE_IO_CARD ((USAGE) 0x0001) +#define HID_USAGE_ARCADE_COIN_DOOR ((USAGE) 0x0002) +#define HID_USAGE_ARCADE_WATCHDOG_TIMER ((USAGE) 0x0003) +#define HID_USAGE_ARCADE_GENERAL_PURPOSE_ANALOG_INPUT_STATE ((USAGE) 0x0030) +#define HID_USAGE_ARCADE_GENERAL_PURPOSE_DIGITAL_INPUT_STATE ((USAGE) 0x0031) +#define HID_USAGE_ARCADE_GENERAL_PURPOSE_OPTICAL_INPUT_STATE ((USAGE) 0x0032) +#define HID_USAGE_ARCADE_GENERAL_PURPOSE_DIGITAL_OUTPUT_STATE ((USAGE) 0x0033) +#define HID_USAGE_ARCADE_NUMBER_OF_COIN_DOORS ((USAGE) 0x0034) +#define HID_USAGE_ARCADE_COIN_DRAWER_DROP_COUNT ((USAGE) 0x0035) +#define HID_USAGE_ARCADE_COIN_DRAWER_START ((USAGE) 0x0036) +#define HID_USAGE_ARCADE_COIN_DRAWER_SERVICE ((USAGE) 0x0037) +#define HID_USAGE_ARCADE_COIN_DRAWER_TILT ((USAGE) 0x0038) +#define HID_USAGE_ARCADE_COIN_DOOR_TEST ((USAGE) 0x0039) +#define HID_USAGE_ARCADE_COIN_DOOR_LOCKOUT ((USAGE) 0x0040) +#define HID_USAGE_ARCADE_WATCHDOG_TIMEOUT ((USAGE) 0x0041) +#define HID_USAGE_ARCADE_WATCHDOG_ACTION ((USAGE) 0x0042) +#define HID_USAGE_ARCADE_WATCHDOG_REBOOT ((USAGE) 0x0043) +#define HID_USAGE_ARCADE_WATCHDOG_RESTART ((USAGE) 0x0044) +#define HID_USAGE_ARCADE_ALARM_INPUT ((USAGE) 0x0045) +#define HID_USAGE_ARCADE_COIN_DOOR_COUNTER ((USAGE) 0x0046) +#define HID_USAGE_ARCADE_IO_DIRECTION_MAPPING ((USAGE) 0x0047) +#define HID_USAGE_ARCADE_SET_IO_DIRECTION_MAPPING ((USAGE) 0x0048) +#define HID_USAGE_ARCADE_EXTENDED_OPTICAL_INPUT_STATE ((USAGE) 0x0049) +#define HID_USAGE_ARCADE_PIN_PAD_INPUT_STATE ((USAGE) 0x004A) +#define HID_USAGE_ARCADE_PIN_PAD_STATUS ((USAGE) 0x004B) +#define HID_USAGE_ARCADE_PIN_PAD_OUTPUT ((USAGE) 0x004C) +#define HID_USAGE_ARCADE_PIN_PAD_COMMAND ((USAGE) 0x004D) + +// +// Alphanumeric/Auxiliary Display Page (0x14) +// +#define HID_USAGE_ALPHANUMERIC_ALPHANUMERIC_DISPLAY ((USAGE) 0x0001) +#define HID_USAGE_ALPHANUMERIC_BITMAPPED_DISPLAY ((USAGE) 0x0002) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_ATTRIBUTES_REPORT ((USAGE) 0x0020) +#define HID_USAGE_ALPHANUMERIC_ASCII_CHARACTER_SET ((USAGE) 0x0021) +#define HID_USAGE_ALPHANUMERIC_DATA_READ_BACK ((USAGE) 0x0022) +#define HID_USAGE_ALPHANUMERIC_FONT_READ_BACK ((USAGE) 0x0023) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_CONTROL_REPORT ((USAGE) 0x0024) +#define HID_USAGE_ALPHANUMERIC_CLEAR_DISPLAY ((USAGE) 0x0025) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_ENABLE ((USAGE) 0x0026) +#define HID_USAGE_ALPHANUMERIC_SCREEN_SAVER_DELAY ((USAGE) 0x0027) +#define HID_USAGE_ALPHANUMERIC_SCREEN_SAVER_ENABLE ((USAGE) 0x0028) +#define HID_USAGE_ALPHANUMERIC_VERTICAL_SCROLL ((USAGE) 0x0029) +#define HID_USAGE_ALPHANUMERIC_HORIZONTAL_SCROLL ((USAGE) 0x002A) +#define HID_USAGE_ALPHANUMERIC_CHARACTER_REPORT ((USAGE) 0x002B) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_DATA ((USAGE) 0x002C) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_STATUS ((USAGE) 0x002D) +#define HID_USAGE_ALPHANUMERIC_STATUS_NOT_READY ((USAGE) 0x002E) +#define HID_USAGE_ALPHANUMERIC_STATUS_READY ((USAGE) 0x002F) +#define HID_USAGE_ALPHANUMERIC_ERR_NOT_A_LOADABLE_CHARACTER ((USAGE) 0x0030) +#define HID_USAGE_ALPHANUMERIC_ERR_FONT_DATA_CANNOT_BE_READ ((USAGE) 0x0031) +#define HID_USAGE_ALPHANUMERIC_CURSOR_POSITION_REPORT ((USAGE) 0x0032) +#define HID_USAGE_ALPHANUMERIC_ROW ((USAGE) 0x0033) +#define HID_USAGE_ALPHANUMERIC_COLUMN ((USAGE) 0x0034) +#define HID_USAGE_ALPHANUMERIC_ROWS ((USAGE) 0x0035) +#define HID_USAGE_ALPHANUMERIC_COLUMNS ((USAGE) 0x0036) +#define HID_USAGE_ALPHANUMERIC_CURSOR_PIXEL_POSITIONING ((USAGE) 0x0037) +#define HID_USAGE_ALPHANUMERIC_CURSOR_MODE ((USAGE) 0x0038) +#define HID_USAGE_ALPHANUMERIC_CURSOR_ENABLE ((USAGE) 0x0039) +#define HID_USAGE_ALPHANUMERIC_CURSOR_BLINK ((USAGE) 0x003A) +#define HID_USAGE_ALPHANUMERIC_FONT_REPORT ((USAGE) 0x003B) +#define HID_USAGE_ALPHANUMERIC_FONT_DATA ((USAGE) 0x003C) +#define HID_USAGE_ALPHANUMERIC_CHAR_WIDTH ((USAGE) 0x003D) +#define HID_USAGE_ALPHANUMERIC_CHAR_HEIGHT ((USAGE) 0x003E) +#define HID_USAGE_ALPHANUMERIC_CHAR_SPACING_HORIZONTAL ((USAGE) 0x003F) +#define HID_USAGE_ALPHANUMERIC_CHAR_SPACING_VERTICAL ((USAGE) 0x0040) +#define HID_USAGE_ALPHANUMERIC_UNICODE_CHAR_SET ((USAGE) 0x0041) +#define HID_USAGE_ALPHANUMERIC_FONT_7_SEGMENT ((USAGE) 0x0042) +#define HID_USAGE_ALPHANUMERIC_7_SEGMENT_DIRECT_MAP ((USAGE) 0x0043) +#define HID_USAGE_ALPHANUMERIC_FONT_14_SEGMENT ((USAGE) 0x0044) +#define HID_USAGE_ALPHANUMERIC_14_SEGMENT_DIRECT_MAP ((USAGE) 0x0045) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_BRIGHTNESS ((USAGE) 0x0046) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_CONTRAST ((USAGE) 0x0047) +#define HID_USAGE_ALPHANUMERIC_CHARACTER_ATTRIBUTE ((USAGE) 0x0048) +#define HID_USAGE_ALPHANUMERIC_ATTRIBUTE_READBACK ((USAGE) 0x0049) +#define HID_USAGE_ALPHANUMERIC_ATTRIBUTE_DATA ((USAGE) 0x004A) +#define HID_USAGE_ALPHANUMERIC_CHAR_ATTR_ENHANCE ((USAGE) 0x004B) +#define HID_USAGE_ALPHANUMERIC_CHAR_ATTR_UNDERLINE ((USAGE) 0x004C) +#define HID_USAGE_ALPHANUMERIC_CHAR_ATTR_BLINK ((USAGE) 0x004D) +#define HID_USAGE_ALPHANUMERIC_BITMAP_SIZE_X ((USAGE) 0x0080) +#define HID_USAGE_ALPHANUMERIC_BITMAP_SIZE_Y ((USAGE) 0x0081) +#define HID_USAGE_ALPHANUMERIC_MAX_BLIT_SIZE ((USAGE) 0x0082) +#define HID_USAGE_ALPHANUMERIC_BIT_DEPTH_FORMAT ((USAGE) 0x0083) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_ORIENTATION ((USAGE) 0x0084) +#define HID_USAGE_ALPHANUMERIC_PALETTE_REPORT ((USAGE) 0x0085) +#define HID_USAGE_ALPHANUMERIC_PALETTE_DATA_SIZE ((USAGE) 0x0086) +#define HID_USAGE_ALPHANUMERIC_PALETTE_DATA_OFFSET ((USAGE) 0x0087) +#define HID_USAGE_ALPHANUMERIC_PALETTE_DATA ((USAGE) 0x0088) +#define HID_USAGE_ALPHANUMERIC_BLIT_REPORT ((USAGE) 0x008A) +#define HID_USAGE_ALPHANUMERIC_BLIT_RECTANGLE_X1 ((USAGE) 0x008B) +#define HID_USAGE_ALPHANUMERIC_BLIT_RECTANGLE_Y1 ((USAGE) 0x008C) +#define HID_USAGE_ALPHANUMERIC_BLIT_RECTANGLE_X2 ((USAGE) 0x008D) +#define HID_USAGE_ALPHANUMERIC_BLIT_RECTANGLE_Y2 ((USAGE) 0x008E) +#define HID_USAGE_ALPHANUMERIC_BLIT_DATA ((USAGE) 0x008F) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON ((USAGE) 0x0090) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON_ID ((USAGE) 0x0091) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON_SIDE ((USAGE) 0x0092) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON_OFFSET1 ((USAGE) 0x0093) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON_OFFSET2 ((USAGE) 0x0094) +#define HID_USAGE_ALPHANUMERIC_SOFT_BUTTON_REPORT ((USAGE) 0x0095) +#define HID_USAGE_ALPHANUMERIC_SOFT_KEYS ((USAGE) 0x00C2) +#define HID_USAGE_ALPHANUMERIC_DISPLAY_DATA_EXTENSIONS ((USAGE) 0x00CC) +#define HID_USAGE_ALPHANUMERIC_CHARACTER_MAPPING ((USAGE) 0x00CF) +#define HID_USAGE_ALPHANUMERIC_UNICODE_EQUIVALENT ((USAGE) 0x00DD) +#define HID_USAGE_ALPHANUMERIC_CHARACTER_PAGE_MAPPING ((USAGE) 0x00DF) +#define HID_USAGE_ALPHANUMERIC_REQUEST_REPORT ((USAGE) 0x00FF) + +// +// Barcode Scanner Page (0x8C) +// +#define HID_USAGE_BARCODE_SCANNER_BARCODE_BADGE_READER ((USAGE) 0x0001) +#define HID_USAGE_BARCODE_SCANNER_BARCODE_SCANNER ((USAGE) 0x0002) +#define HID_USAGE_BARCODE_SCANNER_DUMB_BAR_CODE_SCANNER ((USAGE) 0x0003) +#define HID_USAGE_BARCODE_SCANNER_CORDLESS_SCANNER_BASE ((USAGE) 0x0004) +#define HID_USAGE_BARCODE_SCANNER_BAR_CODE_SCANNER_CRADLE ((USAGE) 0x0005) +#define HID_USAGE_BARCODE_SCANNER_ATTRIBUTE_REPORT ((USAGE) 0x0010) +#define HID_USAGE_BARCODE_SCANNER_SETTINGS_REPORT ((USAGE) 0x0011) +#define HID_USAGE_BARCODE_SCANNER_SCANNED_DATA_REPORT ((USAGE) 0x0012) +#define HID_USAGE_BARCODE_SCANNER_RAW_SCANNED_DATA_REPORT ((USAGE) 0x0013) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_REPORT ((USAGE) 0x0014) +#define HID_USAGE_BARCODE_SCANNER_STATUS_REPORT ((USAGE) 0x0015) +#define HID_USAGE_BARCODE_SCANNER_UPCEAN_CONTROL_REPORT ((USAGE) 0x0016) +#define HID_USAGE_BARCODE_SCANNER_EAN_23_LABEL_CONTROL_REPORT ((USAGE) 0x0017) +#define HID_USAGE_BARCODE_SCANNER_CODE_39_CONTROL_REPORT ((USAGE) 0x0018) +#define HID_USAGE_BARCODE_SCANNER_INTERLEAVED_2_OF_5_CONTROL_REPORT ((USAGE) 0x0019) +#define HID_USAGE_BARCODE_SCANNER_STANDARD_2_OF_5_CONTROL_REPORT ((USAGE) 0x001A) +#define HID_USAGE_BARCODE_SCANNER_MSI_PLESSEY_CONTROL_REPORT ((USAGE) 0x001B) +#define HID_USAGE_BARCODE_SCANNER_CODABAR_CONTROL_REPORT ((USAGE) 0x001C) +#define HID_USAGE_BARCODE_SCANNER_CODE_128_CONTROL_REPORT ((USAGE) 0x001D) +#define HID_USAGE_BARCODE_SCANNER_MISC_1D_CONTROL_REPORT ((USAGE) 0x001E) +#define HID_USAGE_BARCODE_SCANNER_2D_CONTROL_REPORT ((USAGE) 0x001F) +#define HID_USAGE_BARCODE_SCANNER_AIMINGPOINTER_MODE ((USAGE) 0x0030) +#define HID_USAGE_BARCODE_SCANNER_BAR_CODE_PRESENT_SENSOR ((USAGE) 0x0031) +#define HID_USAGE_BARCODE_SCANNER_CLASS_1A_LASER ((USAGE) 0x0032) +#define HID_USAGE_BARCODE_SCANNER_CLASS_2_LASER ((USAGE) 0x0033) +#define HID_USAGE_BARCODE_SCANNER_HEATER_PRESENT ((USAGE) 0x0034) +#define HID_USAGE_BARCODE_SCANNER_CONTACT_SCANNER ((USAGE) 0x0035) +#define HID_USAGE_BARCODE_SCANNER_ELECTRONIC_ARTICLE_SURVEILLANCE_NOTIFICATION ((USAGE) 0x0036) +#define HID_USAGE_BARCODE_SCANNER_CONSTANT_ELECTRONIC_ARTICLE_SURVEILLANCE ((USAGE) 0x0037) +#define HID_USAGE_BARCODE_SCANNER_ERROR_INDICATION ((USAGE) 0x0038) +#define HID_USAGE_BARCODE_SCANNER_FIXED_BEEPER ((USAGE) 0x0039) +#define HID_USAGE_BARCODE_SCANNER_GOOD_DECODE_INDICATION ((USAGE) 0x003A) +#define HID_USAGE_BARCODE_SCANNER_HANDS_FREE_SCANNING ((USAGE) 0x003B) +#define HID_USAGE_BARCODE_SCANNER_INTRINSICALLY_SAFE ((USAGE) 0x003C) +#define HID_USAGE_BARCODE_SCANNER_KLASSE_EINS_LASER ((USAGE) 0x003D) +#define HID_USAGE_BARCODE_SCANNER_LONG_RANGE_SCANNER ((USAGE) 0x003E) +#define HID_USAGE_BARCODE_SCANNER_MIRROR_SPEED_CONTROL ((USAGE) 0x003F) +#define HID_USAGE_BARCODE_SCANNER_NOT_ON_FILE_INDICATION ((USAGE) 0x0040) +#define HID_USAGE_BARCODE_SCANNER_PROGRAMMABLE_BEEPER ((USAGE) 0x0041) +#define HID_USAGE_BARCODE_SCANNER_TRIGGERLESS ((USAGE) 0x0042) +#define HID_USAGE_BARCODE_SCANNER_WAND ((USAGE) 0x0043) +#define HID_USAGE_BARCODE_SCANNER_WATER_RESISTANT ((USAGE) 0x0044) +#define HID_USAGE_BARCODE_SCANNER_MULTIRANGE_SCANNER ((USAGE) 0x0045) +#define HID_USAGE_BARCODE_SCANNER_PROXIMITY_SENSOR ((USAGE) 0x0046) +#define HID_USAGE_BARCODE_SCANNER_FRAGMENT_DECODING ((USAGE) 0x004D) +#define HID_USAGE_BARCODE_SCANNER_SCANNER_READ_CONFIDENCE ((USAGE) 0x004E) +#define HID_USAGE_BARCODE_SCANNER_DATA_PREFIX ((USAGE) 0x004F) +#define HID_USAGE_BARCODE_SCANNER_PREFIX_AIMI ((USAGE) 0x0050) +#define HID_USAGE_BARCODE_SCANNER_PREFIX_NONE ((USAGE) 0x0051) +#define HID_USAGE_BARCODE_SCANNER_PREFIX_PROPRIETARY ((USAGE) 0x0052) +#define HID_USAGE_BARCODE_SCANNER_ACTIVE_TIME ((USAGE) 0x0055) +#define HID_USAGE_BARCODE_SCANNER_AIMING_LASER_PATTERN ((USAGE) 0x0056) +#define HID_USAGE_BARCODE_SCANNER_BAR_CODE_PRESENT ((USAGE) 0x0057) +#define HID_USAGE_BARCODE_SCANNER_BEEPER_STATE ((USAGE) 0x0058) +#define HID_USAGE_BARCODE_SCANNER_LASER_ON_TIME ((USAGE) 0x0059) +#define HID_USAGE_BARCODE_SCANNER_LASER_STATE ((USAGE) 0x005A) +#define HID_USAGE_BARCODE_SCANNER_LOCKOUT_TIME ((USAGE) 0x005B) +#define HID_USAGE_BARCODE_SCANNER_MOTOR_STATE ((USAGE) 0x005C) +#define HID_USAGE_BARCODE_SCANNER_MOTOR_TIMEOUT ((USAGE) 0x005D) +#define HID_USAGE_BARCODE_SCANNER_POWER_ON_RESET_SCANNER ((USAGE) 0x005E) +#define HID_USAGE_BARCODE_SCANNER_PREVENT_READ_OF_BARCODES ((USAGE) 0x005F) +#define HID_USAGE_BARCODE_SCANNER_INITIATE_BARCODE_READ ((USAGE) 0x0060) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_STATE ((USAGE) 0x0061) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_MODE ((USAGE) 0x0062) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_MODE_BLINKING_LASER_ON ((USAGE) 0x0063) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_MODE_CONTINUOUS_LASER_ON ((USAGE) 0x0064) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_MODE_LASER_ON_WHILE_PULLED ((USAGE) 0x0065) +#define HID_USAGE_BARCODE_SCANNER_TRIGGER_MODE_LASER_STAYS_ON_AFTER_RELEASE ((USAGE) 0x0066) +#define HID_USAGE_BARCODE_SCANNER_COMMIT_PARAMETERS_TO_NVM ((USAGE) 0x006D) +#define HID_USAGE_BARCODE_SCANNER_PARAMETER_SCANNING ((USAGE) 0x006E) +#define HID_USAGE_BARCODE_SCANNER_PARAMETERS_CHANGED ((USAGE) 0x006F) +#define HID_USAGE_BARCODE_SCANNER_SET_PARAMETER_DEFAULT_VALUES ((USAGE) 0x0070) +#define HID_USAGE_BARCODE_SCANNER_SCANNER_IN_CRADLE ((USAGE) 0x0075) +#define HID_USAGE_BARCODE_SCANNER_SCANNER_IN_RANGE ((USAGE) 0x0076) +#define HID_USAGE_BARCODE_SCANNER_AIM_DURATION ((USAGE) 0x007A) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_LAMP_DURATION ((USAGE) 0x007B) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_LAMP_INTENSITY ((USAGE) 0x007C) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_LED ((USAGE) 0x007D) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_TONE_FREQUENCY ((USAGE) 0x007E) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_TONE_LENGTH ((USAGE) 0x007F) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_TONE_VOLUME ((USAGE) 0x0080) +#define HID_USAGE_BARCODE_SCANNER_NO_READ_MESSAGE ((USAGE) 0x0082) +#define HID_USAGE_BARCODE_SCANNER_NOT_ON_FILE_VOLUME ((USAGE) 0x0083) +#define HID_USAGE_BARCODE_SCANNER_POWERUP_BEEP ((USAGE) 0x0084) +#define HID_USAGE_BARCODE_SCANNER_SOUND_ERROR_BEEP ((USAGE) 0x0085) +#define HID_USAGE_BARCODE_SCANNER_SOUND_GOOD_READ_BEEP ((USAGE) 0x0086) +#define HID_USAGE_BARCODE_SCANNER_SOUND_NOT_ON_FILE_BEEP ((USAGE) 0x0087) +#define HID_USAGE_BARCODE_SCANNER_GOOD_READ_WHEN_TO_WRITE ((USAGE) 0x0088) +#define HID_USAGE_BARCODE_SCANNER_GRWTI_AFTER_DECODE ((USAGE) 0x0089) +#define HID_USAGE_BARCODE_SCANNER_GRWTI_BEEPLAMP_AFTER_TRANSMIT ((USAGE) 0x008A) +#define HID_USAGE_BARCODE_SCANNER_GRWTI_NO_BEEPLAMP_USE_AT_ALL ((USAGE) 0x008B) +#define HID_USAGE_BARCODE_SCANNER_BOOKLAND_EAN ((USAGE) 0x0091) +#define HID_USAGE_BARCODE_SCANNER_CONVERT_EAN_8_TO_13_TYPE ((USAGE) 0x0092) +#define HID_USAGE_BARCODE_SCANNER_CONVERT_UPC_A_TO_EAN13 ((USAGE) 0x0093) +#define HID_USAGE_BARCODE_SCANNER_CONVERT_UPCE_TO_A ((USAGE) 0x0094) +#define HID_USAGE_BARCODE_SCANNER_EAN13 ((USAGE) 0x0095) +#define HID_USAGE_BARCODE_SCANNER_EAN8 ((USAGE) 0x0096) +#define HID_USAGE_BARCODE_SCANNER_EAN99_128_MANDATORY ((USAGE) 0x0097) +#define HID_USAGE_BARCODE_SCANNER_EAN99_P5128_OPTIONAL ((USAGE) 0x0098) +#define HID_USAGE_BARCODE_SCANNER_ENABLE_EAN_TWO_LABEL ((USAGE) 0x0099) +#define HID_USAGE_BARCODE_SCANNER_UPCEAN ((USAGE) 0x009A) +#define HID_USAGE_BARCODE_SCANNER_UPCEAN_COUPON_CODE ((USAGE) 0x009B) +#define HID_USAGE_BARCODE_SCANNER_UPCEAN_PERIODICALS ((USAGE) 0x009C) +#define HID_USAGE_BARCODE_SCANNER_UPCA ((USAGE) 0x009D) +#define HID_USAGE_BARCODE_SCANNER_UPCA_WITH_128_MANDATORY ((USAGE) 0x009E) +#define HID_USAGE_BARCODE_SCANNER_UPCA_WITH_128_OPTIONAL ((USAGE) 0x009F) +#define HID_USAGE_BARCODE_SCANNER_UPCA_WITH_P5_OPTIONAL ((USAGE) 0x00A0) +#define HID_USAGE_BARCODE_SCANNER_UPCE ((USAGE) 0x00A1) +#define HID_USAGE_BARCODE_SCANNER_UPCE1 ((USAGE) 0x00A2) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL ((USAGE) 0x00A9) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_AUTODISCRIMINATE_2 ((USAGE) 0x00AA) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_ONLY_DECODE_WITH_2 ((USAGE) 0x00AB) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_IGNORE_2 ((USAGE) 0x00AC) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_AUTODISCRIMINATE_5 ((USAGE) 0x00AD) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_ONLY_DECODE_WITH_5 ((USAGE) 0x00AE) +#define HID_USAGE_BARCODE_SCANNER_PERIODICAL_IGNORE_5 ((USAGE) 0x00AF) +#define HID_USAGE_BARCODE_SCANNER_CHECK ((USAGE) 0x00B0) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DISABLE_PRICE ((USAGE) 0x00B1) +#define HID_USAGE_BARCODE_SCANNER_CHECK_ENABLE_4_DIGIT_PRICE ((USAGE) 0x00B2) +#define HID_USAGE_BARCODE_SCANNER_CHECK_ENABLE_5_DIGIT_PRICE ((USAGE) 0x00B3) +#define HID_USAGE_BARCODE_SCANNER_CHECK_ENABLE_EUROPEAN_4_DIGIT_PRICE ((USAGE) 0x00B4) +#define HID_USAGE_BARCODE_SCANNER_CHECK_ENABLE_EUROPEAN_5_DIGIT_PRICE ((USAGE) 0x00B5) +#define HID_USAGE_BARCODE_SCANNER_EAN_TWO_LABEL ((USAGE) 0x00B7) +#define HID_USAGE_BARCODE_SCANNER_EAN_THREE_LABEL ((USAGE) 0x00B8) +#define HID_USAGE_BARCODE_SCANNER_EAN_8_FLAG_DIGIT_1 ((USAGE) 0x00B9) +#define HID_USAGE_BARCODE_SCANNER_EAN_8_FLAG_DIGIT_2 ((USAGE) 0x00BA) +#define HID_USAGE_BARCODE_SCANNER_EAN_8_FLAG_DIGIT_3 ((USAGE) 0x00BB) +#define HID_USAGE_BARCODE_SCANNER_EAN_13_FLAG_DIGIT_1 ((USAGE) 0x00BC) +#define HID_USAGE_BARCODE_SCANNER_EAN_13_FLAG_DIGIT_2 ((USAGE) 0x00BD) +#define HID_USAGE_BARCODE_SCANNER_EAN_13_FLAG_DIGIT_3 ((USAGE) 0x00BE) +#define HID_USAGE_BARCODE_SCANNER_ADD_EAN_23_LABEL_DEFINITION ((USAGE) 0x00BF) +#define HID_USAGE_BARCODE_SCANNER_CLEAR_ALL_EAN_23_LABEL_DEFINITIONS ((USAGE) 0x00C0) +#define HID_USAGE_BARCODE_SCANNER_CODABAR ((USAGE) 0x00C3) +#define HID_USAGE_BARCODE_SCANNER_CODE_128 ((USAGE) 0x00C4) +#define HID_USAGE_BARCODE_SCANNER_CODE_39 ((USAGE) 0x00C7) +#define HID_USAGE_BARCODE_SCANNER_CODE_93 ((USAGE) 0x00C8) +#define HID_USAGE_BARCODE_SCANNER_FULL_ASCII_CONVERSION ((USAGE) 0x00C9) +#define HID_USAGE_BARCODE_SCANNER_INTERLEAVED_2_OF_5 ((USAGE) 0x00CA) +#define HID_USAGE_BARCODE_SCANNER_ITALIAN_PHARMACY_CODE ((USAGE) 0x00CB) +#define HID_USAGE_BARCODE_SCANNER_MSIPLESSEY ((USAGE) 0x00CC) +#define HID_USAGE_BARCODE_SCANNER_STANDARD_2_OF_5_IATA ((USAGE) 0x00CD) +#define HID_USAGE_BARCODE_SCANNER_STANDARD_2_OF_5 ((USAGE) 0x00CE) +#define HID_USAGE_BARCODE_SCANNER_TRANSMIT_STARTSTOP ((USAGE) 0x00D3) +#define HID_USAGE_BARCODE_SCANNER_TRIOPTIC ((USAGE) 0x00D4) +#define HID_USAGE_BARCODE_SCANNER_UCCEAN128 ((USAGE) 0x00D5) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT ((USAGE) 0x00D6) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_DISABLE ((USAGE) 0x00D7) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_INTERLEAVED_2_OF_5_OPCC ((USAGE) 0x00D8) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_INTERLEAVED_2_OF_5_USS ((USAGE) 0x00D9) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_STANDARD_2_OF_5_OPCC ((USAGE) 0x00DA) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_STANDARD_2_OF_5_USS ((USAGE) 0x00DB) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_ONE_MSI_PLESSEY ((USAGE) 0x00DC) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_ENABLE_TWO_MSI_PLESSEY ((USAGE) 0x00DD) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_CODABAR_ENABLE ((USAGE) 0x00DE) +#define HID_USAGE_BARCODE_SCANNER_CHECK_DIGIT_CODE_39_ENABLE ((USAGE) 0x00DF) +#define HID_USAGE_BARCODE_SCANNER_TRANSMIT_CHECK_DIGIT ((USAGE) 0x00F0) +#define HID_USAGE_BARCODE_SCANNER_DISABLE_CHECK_DIGIT_TRANSMIT ((USAGE) 0x00F1) +#define HID_USAGE_BARCODE_SCANNER_ENABLE_CHECK_DIGIT_TRANSMIT ((USAGE) 0x00F2) +#define HID_USAGE_BARCODE_SCANNER_SYMBOLOGY_IDENTIFIER_1 ((USAGE) 0x00FB) +#define HID_USAGE_BARCODE_SCANNER_SYMBOLOGY_IDENTIFIER_2 ((USAGE) 0x00FC) +#define HID_USAGE_BARCODE_SCANNER_SYMBOLOGY_IDENTIFIER_3 ((USAGE) 0x00FD) +#define HID_USAGE_BARCODE_SCANNER_DECODED_DATA ((USAGE) 0x00FE) +#define HID_USAGE_BARCODE_SCANNER_DECODE_DATA_CONTINUED ((USAGE) 0x00FF) +#define HID_USAGE_BARCODE_SCANNER_BAR_SPACE_DATA ((USAGE) 0x0100) +#define HID_USAGE_BARCODE_SCANNER_SCANNER_DATA_ACCURACY ((USAGE) 0x0101) +#define HID_USAGE_BARCODE_SCANNER_RAW_DATA_POLARITY ((USAGE) 0x0102) +#define HID_USAGE_BARCODE_SCANNER_POLARITY_INVERTED_BAR_CODE ((USAGE) 0x0103) +#define HID_USAGE_BARCODE_SCANNER_POLARITY_NORMAL_BAR_CODE ((USAGE) 0x0104) +#define HID_USAGE_BARCODE_SCANNER_MINIMUM_LENGTH_TO_DECODE ((USAGE) 0x0106) +#define HID_USAGE_BARCODE_SCANNER_MAXIMUM_LENGTH_TO_DECODE ((USAGE) 0x0107) +#define HID_USAGE_BARCODE_SCANNER_DISCRETE_LENGTH_TO_DECODE_1 ((USAGE) 0x0108) +#define HID_USAGE_BARCODE_SCANNER_DISCRETE_LENGTH_TO_DECODE_2 ((USAGE) 0x0109) +#define HID_USAGE_BARCODE_SCANNER_DATA_LENGTH_METHOD ((USAGE) 0x010A) +#define HID_USAGE_BARCODE_SCANNER_DL_METHOD_READ_ANY ((USAGE) 0x010B) +#define HID_USAGE_BARCODE_SCANNER_DL_METHOD_CHECK_IN_RANGE ((USAGE) 0x010C) +#define HID_USAGE_BARCODE_SCANNER_DL_METHOD_CHECK_FOR_DISCRETE ((USAGE) 0x010D) +#define HID_USAGE_BARCODE_SCANNER_AZTEC_CODE ((USAGE) 0x0110) +#define HID_USAGE_BARCODE_SCANNER_BC412 ((USAGE) 0x0111) +#define HID_USAGE_BARCODE_SCANNER_CHANNEL_CODE ((USAGE) 0x0112) +#define HID_USAGE_BARCODE_SCANNER_CODE_16 ((USAGE) 0x0113) +#define HID_USAGE_BARCODE_SCANNER_CODE_32 ((USAGE) 0x0114) +#define HID_USAGE_BARCODE_SCANNER_CODE_49 ((USAGE) 0x0115) +#define HID_USAGE_BARCODE_SCANNER_CODE_ONE ((USAGE) 0x0116) +#define HID_USAGE_BARCODE_SCANNER_COLORCODE ((USAGE) 0x0117) +#define HID_USAGE_BARCODE_SCANNER_DATA_MATRIX ((USAGE) 0x0118) +#define HID_USAGE_BARCODE_SCANNER_MAXICODE ((USAGE) 0x0119) +#define HID_USAGE_BARCODE_SCANNER_MICROPDF ((USAGE) 0x011A) +#define HID_USAGE_BARCODE_SCANNER_PDF417 ((USAGE) 0x011B) +#define HID_USAGE_BARCODE_SCANNER_POSICODE ((USAGE) 0x011C) +#define HID_USAGE_BARCODE_SCANNER_QR_CODE ((USAGE) 0x011D) +#define HID_USAGE_BARCODE_SCANNER_SUPERCODE ((USAGE) 0x011E) +#define HID_USAGE_BARCODE_SCANNER_ULTRACODE ((USAGE) 0x011F) +#define HID_USAGE_BARCODE_SCANNER_USD5_SLUG_CODE ((USAGE) 0x0120) +#define HID_USAGE_BARCODE_SCANNER_VERICODE ((USAGE) 0x0121) + +// +// Battery System Page (0x85) +// +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_BATTERY_MODE ((USAGE) 0x0001) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_BATTERY_STATUS ((USAGE) 0x0002) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_ALARM_WARNING ((USAGE) 0x0003) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_CHARGER_MODE ((USAGE) 0x0004) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_CHARGER_STATUS ((USAGE) 0x0005) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_CHARGER_SPEC_INFO ((USAGE) 0x0006) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_SELECTOR_STATE ((USAGE) 0x0007) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_SELECTOR_PRESETS ((USAGE) 0x0008) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_SELECTOR_INFO ((USAGE) 0x0009) +#define HID_USAGE_BATTERY_SYSTEM_OPTIONAL_MFG_FUNCTION_1 ((USAGE) 0x0010) +#define HID_USAGE_BATTERY_SYSTEM_OPTIONAL_MFG_FUNCTION_2 ((USAGE) 0x0011) +#define HID_USAGE_BATTERY_SYSTEM_OPTIONAL_MFG_FUNCTION_3 ((USAGE) 0x0012) +#define HID_USAGE_BATTERY_SYSTEM_OPTIONAL_MFG_FUNCTION_4 ((USAGE) 0x0013) +#define HID_USAGE_BATTERY_SYSTEM_OPTIONAL_MFG_FUNCTION_5 ((USAGE) 0x0014) +#define HID_USAGE_BATTERY_SYSTEM_CONNECTION_TO_SM_BUS ((USAGE) 0x0015) +#define HID_USAGE_BATTERY_SYSTEM_OUTPUT_CONNECTION ((USAGE) 0x0016) +#define HID_USAGE_BATTERY_SYSTEM_CHARGER_CONNECTION ((USAGE) 0x0017) +#define HID_USAGE_BATTERY_SYSTEM_BATTERY_INSERTION ((USAGE) 0x0018) +#define HID_USAGE_BATTERY_SYSTEM_USE_NEXT ((USAGE) 0x0019) +#define HID_USAGE_BATTERY_SYSTEM_OK_TO_USE ((USAGE) 0x001A) +#define HID_USAGE_BATTERY_SYSTEM_BATTERY_SUPPORTED ((USAGE) 0x001B) +#define HID_USAGE_BATTERY_SYSTEM_SELECTOR_REVISION ((USAGE) 0x001C) +#define HID_USAGE_BATTERY_SYSTEM_CHARGING_INDICATOR ((USAGE) 0x001D) +#define HID_USAGE_BATTERY_SYSTEM_MANUFACTURER_ACCESS ((USAGE) 0x0028) +#define HID_USAGE_BATTERY_SYSTEM_REMAINING_CAPACITY_LIMIT ((USAGE) 0x0029) +#define HID_USAGE_BATTERY_SYSTEM_REMAINING_TIME_LIMIT ((USAGE) 0x002A) +#define HID_USAGE_BATTERY_SYSTEM_AT_RATE ((USAGE) 0x002B) +#define HID_USAGE_BATTERY_SYSTEM_CAPACITY_MODE ((USAGE) 0x002C) +#define HID_USAGE_BATTERY_SYSTEM_BROADCAST_TO_CHARGER ((USAGE) 0x002D) +#define HID_USAGE_BATTERY_SYSTEM_PRIMARY_BATTERY ((USAGE) 0x002E) +#define HID_USAGE_BATTERY_SYSTEM_CHARGE_CONTROLLER ((USAGE) 0x002F) +#define HID_USAGE_BATTERY_SYSTEM_TERMINATE_CHARGE ((USAGE) 0x0040) +#define HID_USAGE_BATTERY_SYSTEM_TERMINATE_DISCHARGE ((USAGE) 0x0041) +#define HID_USAGE_BATTERY_SYSTEM_BELOW_REMAINING_CAPACITY_LIMIT ((USAGE) 0x0042) +#define HID_USAGE_BATTERY_SYSTEM_REMAINING_TIME_LIMIT_EXPIRED ((USAGE) 0x0043) +#define HID_USAGE_BATTERY_SYSTEM_CHARGING ((USAGE) 0x0044) +#define HID_USAGE_BATTERY_SYSTEM_DISCHARGING ((USAGE) 0x0045) +#define HID_USAGE_BATTERY_SYSTEM_FULLY_CHARGED ((USAGE) 0x0046) +#define HID_USAGE_BATTERY_SYSTEM_FULLY_DISCHARGED ((USAGE) 0x0047) +#define HID_USAGE_BATTERY_SYSTEM_CONDITIONING_FLAG ((USAGE) 0x0048) +#define HID_USAGE_BATTERY_SYSTEM_AT_RATE_OK ((USAGE) 0x0049) +#define HID_USAGE_BATTERY_SYSTEM_SMART_BATTERY_ERROR_CODE ((USAGE) 0x004A) +#define HID_USAGE_BATTERY_SYSTEM_NEED_REPLACEMENT ((USAGE) 0x004B) +#define HID_USAGE_BATTERY_SYSTEM_AT_RATE_TIME_TO_FULL ((USAGE) 0x0060) +#define HID_USAGE_BATTERY_SYSTEM_AT_RATE_TIME_TO_EMPTY ((USAGE) 0x0061) +#define HID_USAGE_BATTERY_SYSTEM_AVERAGE_CURRENT ((USAGE) 0x0062) +#define HID_USAGE_BATTERY_SYSTEM_MAX_ERROR ((USAGE) 0x0063) +#define HID_USAGE_BATTERY_SYSTEM_RELATIVE_STATE_OF_CHARGE ((USAGE) 0x0064) +#define HID_USAGE_BATTERY_SYSTEM_ABSOLUTE_STATE_OF_CHARGE ((USAGE) 0x0065) +#define HID_USAGE_BATTERY_SYSTEM_REMAINING_CAPACITY ((USAGE) 0x0066) +#define HID_USAGE_BATTERY_SYSTEM_FULL_CHARGE_CAPACITY ((USAGE) 0x0067) +#define HID_USAGE_BATTERY_SYSTEM_RUN_TIME_TO_EMPTY ((USAGE) 0x0068) +#define HID_USAGE_BATTERY_SYSTEM_AVERAGE_TIME_TO_EMPTY ((USAGE) 0x0069) +#define HID_USAGE_BATTERY_SYSTEM_AVERAGE_TIME_TO_FULL ((USAGE) 0x006A) +#define HID_USAGE_BATTERY_SYSTEM_CYCLE_COUNT ((USAGE) 0x006B) +#define HID_USAGE_BATTERY_SYSTEM_BATTERY_PACK_MODEL_LEVEL ((USAGE) 0x0080) +#define HID_USAGE_BATTERY_SYSTEM_INTERNAL_CHARGE_CONTROLLER ((USAGE) 0x0081) +#define HID_USAGE_BATTERY_SYSTEM_PRIMARY_BATTERY_SUPPORT ((USAGE) 0x0082) +#define HID_USAGE_BATTERY_SYSTEM_DESIGN_CAPACITY ((USAGE) 0x0083) +#define HID_USAGE_BATTERY_SYSTEM_SPECIFICATION_INFO ((USAGE) 0x0084) +#define HID_USAGE_BATTERY_SYSTEM_MANUFACTURE_DATE ((USAGE) 0x0085) +#define HID_USAGE_BATTERY_SYSTEM_SERIAL_NUMBER ((USAGE) 0x0086) +#define HID_USAGE_BATTERY_SYSTEM_IMANUFACTURER_NAME ((USAGE) 0x0087) +#define HID_USAGE_BATTERY_SYSTEM_IDEVICE_NAME ((USAGE) 0x0088) +#define HID_USAGE_BATTERY_SYSTEM_IDEVICE_CHEMISTRY ((USAGE) 0x0089) +#define HID_USAGE_BATTERY_SYSTEM_MANUFACTURER_DATA ((USAGE) 0x008A) +#define HID_USAGE_BATTERY_SYSTEM_RECHARGABLE ((USAGE) 0x008B) +#define HID_USAGE_BATTERY_SYSTEM_WARNING_CAPACITY_LIMIT ((USAGE) 0x008C) +#define HID_USAGE_BATTERY_SYSTEM_CAPACITY_GRANULARITY_1 ((USAGE) 0x008D) +#define HID_USAGE_BATTERY_SYSTEM_CAPACITY_GRANULARITY_2 ((USAGE) 0x008E) +#define HID_USAGE_BATTERY_SYSTEM_IOEM_INFORMATION ((USAGE) 0x008F) +#define HID_USAGE_BATTERY_SYSTEM_INHIBIT_CHARGE ((USAGE) 0x00C0) +#define HID_USAGE_BATTERY_SYSTEM_ENABLE_POLLING ((USAGE) 0x00C1) +#define HID_USAGE_BATTERY_SYSTEM_RESET_TO_ZERO ((USAGE) 0x00C2) +#define HID_USAGE_BATTERY_SYSTEM_AC_PRESENT ((USAGE) 0x00D0) +#define HID_USAGE_BATTERY_SYSTEM_BATTERY_PRESENT ((USAGE) 0x00D1) +#define HID_USAGE_BATTERY_SYSTEM_POWER_FAIL ((USAGE) 0x00D2) +#define HID_USAGE_BATTERY_SYSTEM_ALARM_INHIBITED ((USAGE) 0x00D3) +#define HID_USAGE_BATTERY_SYSTEM_THERMISTOR_UNDER_RANGE ((USAGE) 0x00D4) +#define HID_USAGE_BATTERY_SYSTEM_THERMISTOR_HOT ((USAGE) 0x00D5) +#define HID_USAGE_BATTERY_SYSTEM_THERMISTOR_COLD ((USAGE) 0x00D6) +#define HID_USAGE_BATTERY_SYSTEM_THERMISTOR_OVER_RANGE ((USAGE) 0x00D7) +#define HID_USAGE_BATTERY_SYSTEM_VOLTAGE_OUT_OF_RANGE ((USAGE) 0x00D8) +#define HID_USAGE_BATTERY_SYSTEM_CURRENT_OUT_OF_RANGE ((USAGE) 0x00D9) +#define HID_USAGE_BATTERY_SYSTEM_CURRENT_NOT_REGULATED ((USAGE) 0x00DA) +#define HID_USAGE_BATTERY_SYSTEM_VOLTAGE_NOT_REGULATED ((USAGE) 0x00DB) +#define HID_USAGE_BATTERY_SYSTEM_MASTER_MODE ((USAGE) 0x00DC) +#define HID_USAGE_BATTERY_SYSTEM_CHARGER_SELECTOR_SUPPORT ((USAGE) 0x00F0) +#define HID_USAGE_BATTERY_SYSTEM_CHARGER_SPEC ((USAGE) 0x00F1) +#define HID_USAGE_BATTERY_SYSTEM_LEVEL_2 ((USAGE) 0x00F2) +#define HID_USAGE_BATTERY_SYSTEM_LEVEL_3 ((USAGE) 0x00F3) + +// +// Braille Display Page (0x41) +// +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DISPLAY ((USAGE) 0x0001) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_ROW ((USAGE) 0x0002) +#define HID_USAGE_BRAILLE_DISPLAY_8_DOT_BRAILLE_CELL ((USAGE) 0x0003) +#define HID_USAGE_BRAILLE_DISPLAY_6_DOT_BRAILLE_CELL ((USAGE) 0x0004) +#define HID_USAGE_BRAILLE_DISPLAY_NUMBER_OF_BRAILLE_CELLS ((USAGE) 0x0005) +#define HID_USAGE_BRAILLE_DISPLAY_SCREEN_READER_CONTROL ((USAGE) 0x0006) +#define HID_USAGE_BRAILLE_DISPLAY_SCREEN_READER_IDENTIFIER ((USAGE) 0x0007) +#define HID_USAGE_BRAILLE_DISPLAY_ROUTER_SET_1 ((USAGE) 0x00FA) +#define HID_USAGE_BRAILLE_DISPLAY_ROUTER_SET_2 ((USAGE) 0x00FB) +#define HID_USAGE_BRAILLE_DISPLAY_ROUTER_SET_3 ((USAGE) 0x00FC) +#define HID_USAGE_BRAILLE_DISPLAY_ROUTER_KEY ((USAGE) 0x0100) +#define HID_USAGE_BRAILLE_DISPLAY_ROW_ROUTER_KEY ((USAGE) 0x0101) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_BUTTONS ((USAGE) 0x0200) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_1 ((USAGE) 0x0201) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_2 ((USAGE) 0x0202) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_3 ((USAGE) 0x0203) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_4 ((USAGE) 0x0204) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_5 ((USAGE) 0x0205) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_6 ((USAGE) 0x0206) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_7 ((USAGE) 0x0207) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_DOT_8 ((USAGE) 0x0208) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_SPACE ((USAGE) 0x0209) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_LEFT_SPACE ((USAGE) 0x020A) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_KEYBOARD_RIGHT_SPACE ((USAGE) 0x020B) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_FACE_CONTROLS ((USAGE) 0x020C) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_LEFT_CONTROLS ((USAGE) 0x020D) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_RIGHT_CONTROLS ((USAGE) 0x020E) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_TOP_CONTROLS ((USAGE) 0x020F) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_JOYSTICK_CENTER ((USAGE) 0x0210) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_JOYSTICK_UP ((USAGE) 0x0211) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_JOYSTICK_DOWN ((USAGE) 0x0212) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_JOYSTICK_LEFT ((USAGE) 0x0213) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_JOYSTICK_RIGHT ((USAGE) 0x0214) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DPAD_CENTER ((USAGE) 0x0215) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DPAD_UP ((USAGE) 0x0216) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DPAD_DOWN ((USAGE) 0x0217) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DPAD_LEFT ((USAGE) 0x0218) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_DPAD_RIGHT ((USAGE) 0x0219) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_PAN_LEFT ((USAGE) 0x021A) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_PAN_RIGHT ((USAGE) 0x021B) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_ROCKER_UP ((USAGE) 0x021C) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_ROCKER_DOWN ((USAGE) 0x021D) +#define HID_USAGE_BRAILLE_DISPLAY_BRAILLE_ROCKER_PRESS ((USAGE) 0x021E) + +// +// Button Page (0x09) +// +// There is no need to label these Usages. +// As a convenience for strongly-typed scenarios, below macro is provided. +// +#define HID_USAGE_BUTTON_ID(id) ((USAGE) id) + +// +// Camera Control Page (0x90) +// +#define HID_USAGE_CAMERA_AUTO_FOCUS ((USAGE) 0x0020) +#define HID_USAGE_CAMERA_SHUTTER ((USAGE) 0x0021) + +// +// Consumer Page (0x0C) +// +#define HID_USAGE_CONSUMERCTRL ((USAGE) 0x0001) +#define HID_USAGE_CONSUMER_NUMERIC_KEY_PAD ((USAGE) 0x0002) +#define HID_USAGE_CONSUMER_PROGRAMMABLE_BUTTONS ((USAGE) 0x0003) +#define HID_USAGE_CONSUMER_MICROPHONE ((USAGE) 0x0004) +#define HID_USAGE_CONSUMER_HEADPHONE ((USAGE) 0x0005) +#define HID_USAGE_CONSUMER_GRAPHIC_EQUALIZER ((USAGE) 0x0006) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT ((USAGE) 0x0007) +#define HID_USAGE_CONSUMER_10 ((USAGE) 0x0020) +#define HID_USAGE_CONSUMER_100 ((USAGE) 0x0021) +#define HID_USAGE_CONSUMER_AMPM ((USAGE) 0x0022) +#define HID_USAGE_CONSUMER_POWER ((USAGE) 0x0030) +#define HID_USAGE_CONSUMER_RESET ((USAGE) 0x0031) +#define HID_USAGE_CONSUMER_SLEEP ((USAGE) 0x0032) +#define HID_USAGE_CONSUMER_SLEEP_AFTER ((USAGE) 0x0033) +#define HID_USAGE_CONSUMER_SLEEP_MODE ((USAGE) 0x0034) +#define HID_USAGE_CONSUMER_ILLUMINATION ((USAGE) 0x0035) +#define HID_USAGE_CONSUMER_FUNCTION_BUTTONS ((USAGE) 0x0036) +#define HID_USAGE_CONSUMER_MENU ((USAGE) 0x0040) +#define HID_USAGE_CONSUMER_MENU_PICK ((USAGE) 0x0041) +#define HID_USAGE_CONSUMER_MENU_UP ((USAGE) 0x0042) +#define HID_USAGE_CONSUMER_MENU_DOWN ((USAGE) 0x0043) +#define HID_USAGE_CONSUMER_MENU_LEFT ((USAGE) 0x0044) +#define HID_USAGE_CONSUMER_MENU_RIGHT ((USAGE) 0x0045) +#define HID_USAGE_CONSUMER_MENU_ESCAPE ((USAGE) 0x0046) +#define HID_USAGE_CONSUMER_MENU_VALUE_INCREASE ((USAGE) 0x0047) +#define HID_USAGE_CONSUMER_MENU_VALUE_DECREASE ((USAGE) 0x0048) +#define HID_USAGE_CONSUMER_DATA_ON_SCREEN ((USAGE) 0x0060) +#define HID_USAGE_CONSUMER_CLOSED_CAPTION ((USAGE) 0x0061) +#define HID_USAGE_CONSUMER_CLOSED_CAPTION_SELECT ((USAGE) 0x0062) +#define HID_USAGE_CONSUMER_VCRTV ((USAGE) 0x0063) +#define HID_USAGE_CONSUMER_BROADCAST_MODE ((USAGE) 0x0064) +#define HID_USAGE_CONSUMER_SNAPSHOT ((USAGE) 0x0065) +#define HID_USAGE_CONSUMER_STILL ((USAGE) 0x0066) +#define HID_USAGE_CONSUMER_PICTUREINPICTURE_TOGGLE ((USAGE) 0x0067) +#define HID_USAGE_CONSUMER_PICTUREINPICTURE_SWAP ((USAGE) 0x0068) +#define HID_USAGE_CONSUMER_RED_MENU_BUTTON ((USAGE) 0x0069) +#define HID_USAGE_CONSUMER_GREEN_MENU_BUTTON ((USAGE) 0x006A) +#define HID_USAGE_CONSUMER_BLUE_MENU_BUTTON ((USAGE) 0x006B) +#define HID_USAGE_CONSUMER_YELLOW_MENU_BUTTON ((USAGE) 0x006C) +#define HID_USAGE_CONSUMER_ASPECT ((USAGE) 0x006D) +#define HID_USAGE_CONSUMER_3D_MODE_SELECT ((USAGE) 0x006E) +#define HID_USAGE_CONSUMER_DISPLAY_BRIGHTNESS_INCREMENT ((USAGE) 0x006F) +#define HID_USAGE_CONSUMER_DISPLAY_BRIGHTNESS_DECREMENT ((USAGE) 0x0070) +#define HID_USAGE_CONSUMER_DISPLAY_BRIGHTNESS ((USAGE) 0x0071) +#define HID_USAGE_CONSUMER_DISPLAY_BACKLIGHT_TOGGLE ((USAGE) 0x0072) +#define HID_USAGE_CONSUMER_DISPLAY_SET_BRIGHTNESS_TO_MINIMUM ((USAGE) 0x0073) +#define HID_USAGE_CONSUMER_DISPLAY_SET_BRIGHTNESS_TO_MAXIMUM ((USAGE) 0x0074) +#define HID_USAGE_CONSUMER_DISPLAY_SET_AUTO_BRIGHTNESS ((USAGE) 0x0075) +#define HID_USAGE_CONSUMER_CAMERA_ACCESS_ENABLED ((USAGE) 0x0076) +#define HID_USAGE_CONSUMER_CAMERA_ACCESS_DISABLED ((USAGE) 0x0077) +#define HID_USAGE_CONSUMER_CAMERA_ACCESS_TOGGLE ((USAGE) 0x0078) +#define HID_USAGE_CONSUMER_KEYBOARD_BRIGHTNESS_INCREMENT ((USAGE) 0x0079) +#define HID_USAGE_CONSUMER_KEYBOARD_BRIGHTNESS_DECREMENT ((USAGE) 0x007A) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_SET_LEVEL ((USAGE) 0x007B) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_OOC ((USAGE) 0x007C) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_SET_MINIMUM ((USAGE) 0x007D) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_SET_MAXIMUM ((USAGE) 0x007E) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_AUTO ((USAGE) 0x007F) +#define HID_USAGE_CONSUMER_SELECTION ((USAGE) 0x0080) +#define HID_USAGE_CONSUMER_ASSIGN_SELECTION ((USAGE) 0x0081) +#define HID_USAGE_CONSUMER_MODE_STEP ((USAGE) 0x0082) +#define HID_USAGE_CONSUMER_RECALL_LAST ((USAGE) 0x0083) +#define HID_USAGE_CONSUMER_ENTER_CHANNEL ((USAGE) 0x0084) +#define HID_USAGE_CONSUMER_ORDER_MOVIE ((USAGE) 0x0085) +#define HID_USAGE_CONSUMER_CHANNEL ((USAGE) 0x0086) +#define HID_USAGE_CONSUMER_MEDIA_SELECTION ((USAGE) 0x0087) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_COMPUTER ((USAGE) 0x0088) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_TV ((USAGE) 0x0089) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_WWW ((USAGE) 0x008A) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_DVD ((USAGE) 0x008B) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_TELEPHONE ((USAGE) 0x008C) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_PROGRAM_GUIDE ((USAGE) 0x008D) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_VIDEO_PHONE ((USAGE) 0x008E) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_GAMES ((USAGE) 0x008F) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_MESSAGES ((USAGE) 0x0090) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_CD ((USAGE) 0x0091) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_VCR ((USAGE) 0x0092) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_TUNER ((USAGE) 0x0093) +#define HID_USAGE_CONSUMER_QUIT ((USAGE) 0x0094) +#define HID_USAGE_CONSUMER_HELP ((USAGE) 0x0095) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_TAPE ((USAGE) 0x0096) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_CABLE ((USAGE) 0x0097) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_SATELLITE ((USAGE) 0x0098) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_SECURITY ((USAGE) 0x0099) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_HOME ((USAGE) 0x009A) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_CALL ((USAGE) 0x009B) +#define HID_USAGE_CONSUMER_CHANNEL_INCREMENT ((USAGE) 0x009C) +#define HID_USAGE_CONSUMER_CHANNEL_DECREMENT ((USAGE) 0x009D) +#define HID_USAGE_CONSUMER_MEDIA_SELECT_SAP ((USAGE) 0x009E) +#define HID_USAGE_CONSUMER_VCR_PLUS ((USAGE) 0x00A0) +#define HID_USAGE_CONSUMER_ONCE ((USAGE) 0x00A1) +#define HID_USAGE_CONSUMER_DAILY ((USAGE) 0x00A2) +#define HID_USAGE_CONSUMER_WEEKLY ((USAGE) 0x00A3) +#define HID_USAGE_CONSUMER_MONTHLY ((USAGE) 0x00A4) +#define HID_USAGE_CONSUMER_PLAY ((USAGE) 0x00B0) +#define HID_USAGE_CONSUMER_PAUSE ((USAGE) 0x00B1) +#define HID_USAGE_CONSUMER_RECORD ((USAGE) 0x00B2) +#define HID_USAGE_CONSUMER_FAST_FORWARD ((USAGE) 0x00B3) +#define HID_USAGE_CONSUMER_REWIND ((USAGE) 0x00B4) +#define HID_USAGE_CONSUMER_SCAN_NEXT_TRACK ((USAGE) 0x00B5) +#define HID_USAGE_CONSUMER_SCAN_PREV_TRACK ((USAGE) 0x00B6) +#define HID_USAGE_CONSUMER_STOP ((USAGE) 0x00B7) +#define HID_USAGE_CONSUMER_EJECT ((USAGE) 0x00B8) +#define HID_USAGE_CONSUMER_RANDOM_PLAY ((USAGE) 0x00B9) +#define HID_USAGE_CONSUMER_SELECT_DISC ((USAGE) 0x00BA) +#define HID_USAGE_CONSUMER_ENTER_DISC ((USAGE) 0x00BB) +#define HID_USAGE_CONSUMER_REPEAT ((USAGE) 0x00BC) +#define HID_USAGE_CONSUMER_TRACKING ((USAGE) 0x00BD) +#define HID_USAGE_CONSUMER_TRACK_NORMAL ((USAGE) 0x00BE) +#define HID_USAGE_CONSUMER_SLOW_TRACKING ((USAGE) 0x00BF) +#define HID_USAGE_CONSUMER_FRAME_FORWARD ((USAGE) 0x00C0) +#define HID_USAGE_CONSUMER_FRAME_BACK ((USAGE) 0x00C1) +#define HID_USAGE_CONSUMER_MARK ((USAGE) 0x00C2) +#define HID_USAGE_CONSUMER_CLEAR_MARK ((USAGE) 0x00C3) +#define HID_USAGE_CONSUMER_REPEAT_FROM_MARK ((USAGE) 0x00C4) +#define HID_USAGE_CONSUMER_RETURN_TO_MARK ((USAGE) 0x00C5) +#define HID_USAGE_CONSUMER_SEARCH_MARK_FORWARD ((USAGE) 0x00C6) +#define HID_USAGE_CONSUMER_SEARCH_MARK_BACKWARDS ((USAGE) 0x00C7) +#define HID_USAGE_CONSUMER_COUNTER_RESET ((USAGE) 0x00C8) +#define HID_USAGE_CONSUMER_SHOW_COUNTER ((USAGE) 0x00C9) +#define HID_USAGE_CONSUMER_TRACKING_INCREMENT ((USAGE) 0x00CA) +#define HID_USAGE_CONSUMER_TRACKING_DECREMENT ((USAGE) 0x00CB) +#define HID_USAGE_CONSUMER_STOPEJECT ((USAGE) 0x00CC) +#define HID_USAGE_CONSUMER_PLAY_PAUSE ((USAGE) 0x00CD) +#define HID_USAGE_CONSUMER_PLAYSKIP ((USAGE) 0x00CE) +#define HID_USAGE_CONSUMER_VOICE_COMMAND ((USAGE) 0x00CF) +#define HID_USAGE_CONSUMER_GAMEDVR_OPEN_GAMEBAR ((USAGE) 0x00D0) +#define HID_USAGE_CONSUMER_GAMEDVR_TOGGLE_RECORD ((USAGE) 0x00D1) +#define HID_USAGE_CONSUMER_GAMEDVR_RECORD_CLIP ((USAGE) 0x00D2) +#define HID_USAGE_CONSUMER_GAMEDVR_SCREENSHOT ((USAGE) 0x00D3) +#define HID_USAGE_CONSUMER_GAMEDVR_TOGGLE_INDICATOR ((USAGE) 0x00D4) +#define HID_USAGE_CONSUMER_GAMEDVR_TOGGLE_MICROPHONE ((USAGE) 0x00D5) +#define HID_USAGE_CONSUMER_GAMEDVR_TOGGLE_CAMERA ((USAGE) 0x00D6) +#define HID_USAGE_CONSUMER_GAMEDVR_TOGGLE_BROADCAST ((USAGE) 0x00D7) +#define HID_USAGE_CONSUMER_START_OR_STOP_VOICE_DICTATION_SESSION ((USAGE) 0x00D8) +#define HID_USAGE_CONSUMER_INVOKEDISMISS_EMOJI_PICKER ((USAGE) 0x00D9) +#define HID_USAGE_CONSUMER_VOLUME ((USAGE) 0x00E0) +#define HID_USAGE_CONSUMER_BALANCE ((USAGE) 0x00E1) +#define HID_USAGE_CONSUMER_MUTE ((USAGE) 0x00E2) +#define HID_USAGE_CONSUMER_BASS ((USAGE) 0x00E3) +#define HID_USAGE_CONSUMER_TREBLE ((USAGE) 0x00E4) +#define HID_USAGE_CONSUMER_BASS_BOOST ((USAGE) 0x00E5) +#define HID_USAGE_CONSUMER_SURROUND_MODE ((USAGE) 0x00E6) +#define HID_USAGE_CONSUMER_LOUDNESS ((USAGE) 0x00E7) +#define HID_USAGE_CONSUMER_MPX ((USAGE) 0x00E8) +#define HID_USAGE_CONSUMER_VOLUME_INCREMENT ((USAGE) 0x00E9) +#define HID_USAGE_CONSUMER_VOLUME_DECREMENT ((USAGE) 0x00EA) +#define HID_USAGE_CONSUMER_SPEED_SELECT ((USAGE) 0x00F0) +#define HID_USAGE_CONSUMER_PLAYBACK_SPEED ((USAGE) 0x00F1) +#define HID_USAGE_CONSUMER_STANDARD_PLAY ((USAGE) 0x00F2) +#define HID_USAGE_CONSUMER_LONG_PLAY ((USAGE) 0x00F3) +#define HID_USAGE_CONSUMER_EXTENDED_PLAY ((USAGE) 0x00F4) +#define HID_USAGE_CONSUMER_SLOW ((USAGE) 0x00F5) +#define HID_USAGE_CONSUMER_FAN_ENABLE ((USAGE) 0x0100) +#define HID_USAGE_CONSUMER_FAN_SPEED ((USAGE) 0x0101) +#define HID_USAGE_CONSUMER_LIGHT_ENABLE ((USAGE) 0x0102) +#define HID_USAGE_CONSUMER_LIGHT_ILLUMINATION_LEVEL ((USAGE) 0x0103) +#define HID_USAGE_CONSUMER_CLIMATE_CONTROL_ENABLE ((USAGE) 0x0104) +#define HID_USAGE_CONSUMER_ROOM_TEMPERATURE ((USAGE) 0x0105) +#define HID_USAGE_CONSUMER_SECURITY_ENABLE ((USAGE) 0x0106) +#define HID_USAGE_CONSUMER_FIRE_ALARM ((USAGE) 0x0107) +#define HID_USAGE_CONSUMER_POLICE_ALARM ((USAGE) 0x0108) +#define HID_USAGE_CONSUMER_PROXIMITY ((USAGE) 0x0109) +#define HID_USAGE_CONSUMER_MOTION ((USAGE) 0x010A) +#define HID_USAGE_CONSUMER_DURESS_ALARM ((USAGE) 0x010B) +#define HID_USAGE_CONSUMER_HOLDUP_ALARM ((USAGE) 0x010C) +#define HID_USAGE_CONSUMER_MEDICAL_ALARM ((USAGE) 0x010D) +#define HID_USAGE_CONSUMER_BALANCE_RIGHT ((USAGE) 0x0150) +#define HID_USAGE_CONSUMER_BALANCE_LEFT ((USAGE) 0x0151) +#define HID_USAGE_CONSUMER_BASS_INCREMENT ((USAGE) 0x0152) +#define HID_USAGE_CONSUMER_BASS_DECREMENT ((USAGE) 0x0153) +#define HID_USAGE_CONSUMER_TREBLE_INCREMENT ((USAGE) 0x0154) +#define HID_USAGE_CONSUMER_TREBLE_DECREMENT ((USAGE) 0x0155) +#define HID_USAGE_CONSUMER_SPEAKER_SYSTEM ((USAGE) 0x0160) +#define HID_USAGE_CONSUMER_CHANNEL_LEFT ((USAGE) 0x0161) +#define HID_USAGE_CONSUMER_CHANNEL_RIGHT ((USAGE) 0x0162) +#define HID_USAGE_CONSUMER_CHANNEL_CENTER ((USAGE) 0x0163) +#define HID_USAGE_CONSUMER_CHANNEL_FRONT ((USAGE) 0x0164) +#define HID_USAGE_CONSUMER_CHANNEL_CENTER_FRONT ((USAGE) 0x0165) +#define HID_USAGE_CONSUMER_CHANNEL_SIDE ((USAGE) 0x0166) +#define HID_USAGE_CONSUMER_CHANNEL_SURROUND ((USAGE) 0x0167) +#define HID_USAGE_CONSUMER_CHANNEL_LOW_FREQUENCY_ENHANCEMENT ((USAGE) 0x0168) +#define HID_USAGE_CONSUMER_CHANNEL_TOP ((USAGE) 0x0169) +#define HID_USAGE_CONSUMER_CHANNEL_UNKNOWN ((USAGE) 0x016A) +#define HID_USAGE_CONSUMER_SUBCHANNEL ((USAGE) 0x0170) +#define HID_USAGE_CONSUMER_SUBCHANNEL_INCREMENT ((USAGE) 0x0171) +#define HID_USAGE_CONSUMER_SUBCHANNEL_DECREMENT ((USAGE) 0x0172) +#define HID_USAGE_CONSUMER_ALTERNATE_AUDIO_INCREMENT ((USAGE) 0x0173) +#define HID_USAGE_CONSUMER_ALTERNATE_AUDIO_DECREMENT ((USAGE) 0x0174) +#define HID_USAGE_CONSUMER_APPLICATION_LAUNCH_BUTTONS ((USAGE) 0x0180) +#define HID_USAGE_CONSUMER_AL_LAUNCH_BUTTON_CONFIGURATION_TOOL ((USAGE) 0x0181) +#define HID_USAGE_CONSUMER_AL_PROGRAMMABLE_BUTTON_CONFIGURATION ((USAGE) 0x0182) +#define HID_USAGE_CONSUMER_AL_CONFIGURATION ((USAGE) 0x0183) +#define HID_USAGE_CONSUMER_AL_WORD_PROCESSOR ((USAGE) 0x0184) +#define HID_USAGE_CONSUMER_AL_TEXT_EDITOR ((USAGE) 0x0185) +#define HID_USAGE_CONSUMER_AL_SPREADSHEET ((USAGE) 0x0186) +#define HID_USAGE_CONSUMER_AL_GRAPHICS_EDITOR ((USAGE) 0x0187) +#define HID_USAGE_CONSUMER_AL_PRESENTATION_APP ((USAGE) 0x0188) +#define HID_USAGE_CONSUMER_AL_DATABASE_APP ((USAGE) 0x0189) +#define HID_USAGE_CONSUMER_AL_EMAIL ((USAGE) 0x018A) +#define HID_USAGE_CONSUMER_AL_NEWSREADER ((USAGE) 0x018B) +#define HID_USAGE_CONSUMER_AL_VOICEMAIL ((USAGE) 0x018C) +#define HID_USAGE_CONSUMER_AL_CONTACTSADDRESS_BOOK ((USAGE) 0x018D) +#define HID_USAGE_CONSUMER_AL_CALENDARSCHEDULE ((USAGE) 0x018E) +#define HID_USAGE_CONSUMER_AL_TASKPROJECT_MANAGER ((USAGE) 0x018F) +#define HID_USAGE_CONSUMER_AL_LOGJOURNALTIMECARD ((USAGE) 0x0190) +#define HID_USAGE_CONSUMER_AL_CHECKBOOKFINANCE ((USAGE) 0x0191) +#define HID_USAGE_CONSUMER_AL_CALCULATOR ((USAGE) 0x0192) +#define HID_USAGE_CONSUMER_AL_AV_CAPTUREPLAYBACK ((USAGE) 0x0193) +#define HID_USAGE_CONSUMER_AL_BROWSER ((USAGE) 0x0194) +#define HID_USAGE_CONSUMER_AL_LANWAN_BROWSER ((USAGE) 0x0195) +#define HID_USAGE_CONSUMER_AL_INTERNET_BROWSER ((USAGE) 0x0196) +#define HID_USAGE_CONSUMER_AL_REMOTE_NETWORKINGISP_CONNECT ((USAGE) 0x0197) +#define HID_USAGE_CONSUMER_AL_NETWORK_CONFERENCE ((USAGE) 0x0198) +#define HID_USAGE_CONSUMER_AL_NETWORK_CHAT ((USAGE) 0x0199) +#define HID_USAGE_CONSUMER_AL_TELEPHONYDIALER ((USAGE) 0x019A) +#define HID_USAGE_CONSUMER_AL_LOGON ((USAGE) 0x019B) +#define HID_USAGE_CONSUMER_AL_LOGOFF ((USAGE) 0x019C) +#define HID_USAGE_CONSUMER_AL_LOGONLOGOFF ((USAGE) 0x019D) +#define HID_USAGE_CONSUMER_AL_TERMINAL_LOCKSCREENSAVER ((USAGE) 0x019E) +#define HID_USAGE_CONSUMER_AL_CONTROL_PANEL ((USAGE) 0x019F) +#define HID_USAGE_CONSUMER_AL_COMMAND_LINE_PROCESSORRUN ((USAGE) 0x01A0) +#define HID_USAGE_CONSUMER_AL_PROCESSTASK_MANAGER ((USAGE) 0x01A1) +#define HID_USAGE_CONSUMER_AL_SELECT_TASKAPPLICATION ((USAGE) 0x01A2) +#define HID_USAGE_CONSUMER_AL_NEXT_TASKAPPLICATION ((USAGE) 0x01A3) +#define HID_USAGE_CONSUMER_AL_PREVIOUS_TASKAPPLICATION ((USAGE) 0x01A4) +#define HID_USAGE_CONSUMER_AL_PREEMPTIVE_HALT_TASKAPPLICATION ((USAGE) 0x01A5) +#define HID_USAGE_CONSUMER_AL_INTEGRATED_HELP_CENTER ((USAGE) 0x01A6) +#define HID_USAGE_CONSUMER_AL_DOCUMENTS ((USAGE) 0x01A7) +#define HID_USAGE_CONSUMER_AL_THESAURUS ((USAGE) 0x01A8) +#define HID_USAGE_CONSUMER_AL_DICTIONARY ((USAGE) 0x01A9) +#define HID_USAGE_CONSUMER_AL_DESKTOP ((USAGE) 0x01AA) +#define HID_USAGE_CONSUMER_AL_SPELL_CHECK ((USAGE) 0x01AB) +#define HID_USAGE_CONSUMER_AL_GRAMMAR_CHECK ((USAGE) 0x01AC) +#define HID_USAGE_CONSUMER_AL_WIRELESS_STATUS ((USAGE) 0x01AD) +#define HID_USAGE_CONSUMER_AL_KEYBOARD_LAYOUT ((USAGE) 0x01AE) +#define HID_USAGE_CONSUMER_AL_VIRUS_PROTECTION ((USAGE) 0x01AF) +#define HID_USAGE_CONSUMER_AL_ENCRYPTION ((USAGE) 0x01B0) +#define HID_USAGE_CONSUMER_AL_SCREEN_SAVER ((USAGE) 0x01B1) +#define HID_USAGE_CONSUMER_AL_ALARMS ((USAGE) 0x01B2) +#define HID_USAGE_CONSUMER_AL_CLOCK ((USAGE) 0x01B3) +#define HID_USAGE_CONSUMER_AL_FILE_BROWSER ((USAGE) 0x01B4) +#define HID_USAGE_CONSUMER_AL_POWER_STATUS ((USAGE) 0x01B5) +#define HID_USAGE_CONSUMER_AL_IMAGE_BROWSER ((USAGE) 0x01B6) +#define HID_USAGE_CONSUMER_AL_AUDIO_BROWSER ((USAGE) 0x01B7) +#define HID_USAGE_CONSUMER_AL_MOVIE_BROWSER ((USAGE) 0x01B8) +#define HID_USAGE_CONSUMER_AL_DIGITAL_RIGHTS_MANAGER ((USAGE) 0x01B9) +#define HID_USAGE_CONSUMER_AL_DIGITAL_WALLET ((USAGE) 0x01BA) +#define HID_USAGE_CONSUMER_AL_INSTANT_MESSAGING ((USAGE) 0x01BC) +#define HID_USAGE_CONSUMER_AL_OEM_FEATURES_TIPSTUTORIAL_BROWSER ((USAGE) 0x01BD) +#define HID_USAGE_CONSUMER_AL_OEM_HELP ((USAGE) 0x01BE) +#define HID_USAGE_CONSUMER_AL_ONLINE_COMMUNITY ((USAGE) 0x01BF) +#define HID_USAGE_CONSUMER_AL_ENTERTAINMENT_CONTENT_BROWSER ((USAGE) 0x01C0) +#define HID_USAGE_CONSUMER_AL_ONLINE_SHOPPING_BROWSER ((USAGE) 0x01C1) +#define HID_USAGE_CONSUMER_AL_SMARTCARD_INFORMATIONHELP ((USAGE) 0x01C2) +#define HID_USAGE_CONSUMER_AL_MARKET_MONITORFINANCE_BROWSER ((USAGE) 0x01C3) +#define HID_USAGE_CONSUMER_AL_CUSTOMIZED_CORPORATE_NEWS_BROWSER ((USAGE) 0x01C4) +#define HID_USAGE_CONSUMER_AL_ONLINE_ACTIVITY_BROWSER ((USAGE) 0x01C5) +#define HID_USAGE_CONSUMER_AL_SEARCH ((USAGE) 0x01C6) +#define HID_USAGE_CONSUMER_AL_AUDIO_PLAYER ((USAGE) 0x01C7) +#define HID_USAGE_CONSUMER_AL_MESSAGE_STATUS ((USAGE) 0x01C8) +#define HID_USAGE_CONSUMER_AL_CONTACT_SYNC ((USAGE) 0x01C9) +#define HID_USAGE_CONSUMER_AL_NAVIGATION ((USAGE) 0x01CA) +#define HID_USAGE_CONSUMER_AL_CONTEXTAWARE_DESKTOP_ASSISTANT ((USAGE) 0x01CB) +#define HID_USAGE_CONSUMER_GENERIC_GUI_APPLICATION_CONTROLS ((USAGE) 0x0200) +#define HID_USAGE_CONSUMER_AC_NEW ((USAGE) 0x0201) +#define HID_USAGE_CONSUMER_AC_OPEN ((USAGE) 0x0202) +#define HID_USAGE_CONSUMER_AC_CLOSE ((USAGE) 0x0203) +#define HID_USAGE_CONSUMER_AC_EXIT ((USAGE) 0x0204) +#define HID_USAGE_CONSUMER_AC_MAXIMIZE ((USAGE) 0x0205) +#define HID_USAGE_CONSUMER_AC_MINIMIZE ((USAGE) 0x0206) +#define HID_USAGE_CONSUMER_AC_SAVE ((USAGE) 0x0207) +#define HID_USAGE_CONSUMER_AC_PRINT ((USAGE) 0x0208) +#define HID_USAGE_CONSUMER_AC_PROPERTIES ((USAGE) 0x0209) +#define HID_USAGE_CONSUMER_AC_UNDO ((USAGE) 0x021A) +#define HID_USAGE_CONSUMER_AC_COPY ((USAGE) 0x021B) +#define HID_USAGE_CONSUMER_AC_CUT ((USAGE) 0x021C) +#define HID_USAGE_CONSUMER_AC_PASTE ((USAGE) 0x021D) +#define HID_USAGE_CONSUMER_AC_SELECT_ALL ((USAGE) 0x021E) +#define HID_USAGE_CONSUMER_AC_FIND ((USAGE) 0x021F) +#define HID_USAGE_CONSUMER_AC_FIND_AND_REPLACE ((USAGE) 0x0220) +#define HID_USAGE_CONSUMER_AC_SEARCH ((USAGE) 0x0221) +#define HID_USAGE_CONSUMER_AC_GOTO ((USAGE) 0x0222) +#define HID_USAGE_CONSUMER_AC_HOME ((USAGE) 0x0223) +#define HID_USAGE_CONSUMER_AC_BACK ((USAGE) 0x0224) +#define HID_USAGE_CONSUMER_AC_FORWARD ((USAGE) 0x0225) +#define HID_USAGE_CONSUMER_AC_STOP ((USAGE) 0x0226) +#define HID_USAGE_CONSUMER_AC_REFRESH ((USAGE) 0x0227) +#define HID_USAGE_CONSUMER_AC_PREVIOUS ((USAGE) 0x0228) +#define HID_USAGE_CONSUMER_AC_NEXT ((USAGE) 0x0229) +#define HID_USAGE_CONSUMER_AC_BOOKMARKS ((USAGE) 0x022A) +#define HID_USAGE_CONSUMER_AC_HISTORY ((USAGE) 0x022B) +#define HID_USAGE_CONSUMER_AC_SUBSCRIPTIONS ((USAGE) 0x022C) +#define HID_USAGE_CONSUMER_AC_ZOOM_IN ((USAGE) 0x022D) +#define HID_USAGE_CONSUMER_AC_ZOOM_OUT ((USAGE) 0x022E) +#define HID_USAGE_CONSUMER_AC_ZOOM ((USAGE) 0x022F) +#define HID_USAGE_CONSUMER_AC_FULL_SCREEN_VIEW ((USAGE) 0x0230) +#define HID_USAGE_CONSUMER_AC_NORMAL_VIEW ((USAGE) 0x0231) +#define HID_USAGE_CONSUMER_AC_VIEW_TOGGLE ((USAGE) 0x0232) +#define HID_USAGE_CONSUMER_AC_SCROLL_UP ((USAGE) 0x0233) +#define HID_USAGE_CONSUMER_AC_SCROLL_DOWN ((USAGE) 0x0234) +#define HID_USAGE_CONSUMER_AC_SCROLL ((USAGE) 0x0235) +#define HID_USAGE_CONSUMER_AC_PAN_LEFT ((USAGE) 0x0236) +#define HID_USAGE_CONSUMER_AC_PAN_RIGHT ((USAGE) 0x0237) +#define HID_USAGE_CONSUMER_AC_PAN ((USAGE) 0x0238) +#define HID_USAGE_CONSUMER_AC_NEW_WINDOW ((USAGE) 0x0239) +#define HID_USAGE_CONSUMER_AC_TILE_HORIZONTALLY ((USAGE) 0x023A) +#define HID_USAGE_CONSUMER_AC_TILE_VERTICALLY ((USAGE) 0x023B) +#define HID_USAGE_CONSUMER_AC_FORMAT ((USAGE) 0x023C) +#define HID_USAGE_CONSUMER_AC_EDIT ((USAGE) 0x023D) +#define HID_USAGE_CONSUMER_AC_BOLD ((USAGE) 0x023E) +#define HID_USAGE_CONSUMER_AC_ITALICS ((USAGE) 0x023F) +#define HID_USAGE_CONSUMER_AC_UNDERLINE ((USAGE) 0x0240) +#define HID_USAGE_CONSUMER_AC_STRIKETHROUGH ((USAGE) 0x0241) +#define HID_USAGE_CONSUMER_AC_SUBSCRIPT ((USAGE) 0x0242) +#define HID_USAGE_CONSUMER_AC_SUPERSCRIPT ((USAGE) 0x0243) +#define HID_USAGE_CONSUMER_AC_ALL_CAPS ((USAGE) 0x0244) +#define HID_USAGE_CONSUMER_AC_ROTATE ((USAGE) 0x0245) +#define HID_USAGE_CONSUMER_AC_RESIZE ((USAGE) 0x0246) +#define HID_USAGE_CONSUMER_AC_FLIP_HORIZONTAL ((USAGE) 0x0247) +#define HID_USAGE_CONSUMER_AC_FLIP_VERTICAL ((USAGE) 0x0248) +#define HID_USAGE_CONSUMER_AC_MIRROR_HORIZONTAL ((USAGE) 0x0249) +#define HID_USAGE_CONSUMER_AC_MIRROR_VERTICAL ((USAGE) 0x024A) +#define HID_USAGE_CONSUMER_AC_FONT_SELECT ((USAGE) 0x024B) +#define HID_USAGE_CONSUMER_AC_FONT_COLOR ((USAGE) 0x024C) +#define HID_USAGE_CONSUMER_AC_FONT_SIZE ((USAGE) 0x024D) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_LEFT ((USAGE) 0x024E) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_CENTER_H ((USAGE) 0x024F) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_RIGHT ((USAGE) 0x0250) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_BLOCK_H ((USAGE) 0x0251) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_TOP ((USAGE) 0x0252) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_CENTER_V ((USAGE) 0x0253) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_BOTTOM ((USAGE) 0x0254) +#define HID_USAGE_CONSUMER_AC_JUSTIFY_BLOCK_V ((USAGE) 0x0255) +#define HID_USAGE_CONSUMER_AC_INDENT_DECREASE ((USAGE) 0x0256) +#define HID_USAGE_CONSUMER_AC_INDENT_INCREASE ((USAGE) 0x0257) +#define HID_USAGE_CONSUMER_AC_NUMBERED_LIST ((USAGE) 0x0258) +#define HID_USAGE_CONSUMER_AC_RESTART_NUMBERING ((USAGE) 0x0259) +#define HID_USAGE_CONSUMER_AC_BULLETED_LIST ((USAGE) 0x025A) +#define HID_USAGE_CONSUMER_AC_PROMOTE ((USAGE) 0x025B) +#define HID_USAGE_CONSUMER_AC_DEMOTE ((USAGE) 0x025C) +#define HID_USAGE_CONSUMER_AC_YES ((USAGE) 0x025D) +#define HID_USAGE_CONSUMER_AC_NO ((USAGE) 0x025E) +#define HID_USAGE_CONSUMER_AC_CANCEL ((USAGE) 0x025F) +#define HID_USAGE_CONSUMER_AC_CATALOG ((USAGE) 0x0260) +#define HID_USAGE_CONSUMER_AC_BUYCHECKOUT ((USAGE) 0x0261) +#define HID_USAGE_CONSUMER_AC_ADD_TO_CART ((USAGE) 0x0262) +#define HID_USAGE_CONSUMER_AC_EXPAND ((USAGE) 0x0263) +#define HID_USAGE_CONSUMER_AC_EXPAND_ALL ((USAGE) 0x0264) +#define HID_USAGE_CONSUMER_AC_COLLAPSE ((USAGE) 0x0265) +#define HID_USAGE_CONSUMER_AC_COLLAPSE_ALL ((USAGE) 0x0266) +#define HID_USAGE_CONSUMER_AC_PRINT_PREVIEW ((USAGE) 0x0267) +#define HID_USAGE_CONSUMER_AC_PASTE_SPECIAL ((USAGE) 0x0268) +#define HID_USAGE_CONSUMER_AC_INSERT_MODE ((USAGE) 0x0269) +#define HID_USAGE_CONSUMER_AC_DELETE ((USAGE) 0x026A) +#define HID_USAGE_CONSUMER_AC_LOCK ((USAGE) 0x026B) +#define HID_USAGE_CONSUMER_AC_UNLOCK ((USAGE) 0x026C) +#define HID_USAGE_CONSUMER_AC_PROTECT ((USAGE) 0x026D) +#define HID_USAGE_CONSUMER_AC_UNPROTECT ((USAGE) 0x026E) +#define HID_USAGE_CONSUMER_AC_ATTACH_COMMENT ((USAGE) 0x026F) +#define HID_USAGE_CONSUMER_AC_DELETE_COMMENT ((USAGE) 0x0270) +#define HID_USAGE_CONSUMER_AC_VIEW_COMMENT ((USAGE) 0x0271) +#define HID_USAGE_CONSUMER_AC_SELECT_WORD ((USAGE) 0x0272) +#define HID_USAGE_CONSUMER_AC_SELECT_SENTENCE ((USAGE) 0x0273) +#define HID_USAGE_CONSUMER_AC_SELECT_PARAGRAPH ((USAGE) 0x0274) +#define HID_USAGE_CONSUMER_AC_SELECT_COLUMN ((USAGE) 0x0275) +#define HID_USAGE_CONSUMER_AC_SELECT_ROW ((USAGE) 0x0276) +#define HID_USAGE_CONSUMER_AC_SELECT_TABLE ((USAGE) 0x0277) +#define HID_USAGE_CONSUMER_AC_SELECT_OBJECT ((USAGE) 0x0278) +#define HID_USAGE_CONSUMER_AC_REDOREPEAT ((USAGE) 0x0279) +#define HID_USAGE_CONSUMER_AC_SORT ((USAGE) 0x027A) +#define HID_USAGE_CONSUMER_AC_SORT_ASCENDING ((USAGE) 0x027B) +#define HID_USAGE_CONSUMER_AC_SORT_DESCENDING ((USAGE) 0x027C) +#define HID_USAGE_CONSUMER_AC_FILTER ((USAGE) 0x027D) +#define HID_USAGE_CONSUMER_AC_SET_CLOCK ((USAGE) 0x027E) +#define HID_USAGE_CONSUMER_AC_VIEW_CLOCK ((USAGE) 0x027F) +#define HID_USAGE_CONSUMER_AC_SELECT_TIME_ZONE ((USAGE) 0x0280) +#define HID_USAGE_CONSUMER_AC_EDIT_TIME_ZONES ((USAGE) 0x0281) +#define HID_USAGE_CONSUMER_AC_SET_ALARM ((USAGE) 0x0282) +#define HID_USAGE_CONSUMER_AC_CLEAR_ALARM ((USAGE) 0x0283) +#define HID_USAGE_CONSUMER_AC_SNOOZE_ALARM ((USAGE) 0x0284) +#define HID_USAGE_CONSUMER_AC_RESET_ALARM ((USAGE) 0x0285) +#define HID_USAGE_CONSUMER_AC_SYNCHRONIZE ((USAGE) 0x0286) +#define HID_USAGE_CONSUMER_AC_SENDRECEIVE ((USAGE) 0x0287) +#define HID_USAGE_CONSUMER_AC_SEND_TO ((USAGE) 0x0288) +#define HID_USAGE_CONSUMER_AC_REPLY ((USAGE) 0x0289) +#define HID_USAGE_CONSUMER_AC_REPLY_ALL ((USAGE) 0x028A) +#define HID_USAGE_CONSUMER_AC_FORWARD_MSG ((USAGE) 0x028B) +#define HID_USAGE_CONSUMER_AC_SEND ((USAGE) 0x028C) +#define HID_USAGE_CONSUMER_AC_ATTACH_FILE ((USAGE) 0x028D) +#define HID_USAGE_CONSUMER_AC_UPLOAD ((USAGE) 0x028E) +#define HID_USAGE_CONSUMER_AC_DOWNLOAD_SAVE_TARGET_AS ((USAGE) 0x028F) +#define HID_USAGE_CONSUMER_AC_SET_BORDERS ((USAGE) 0x0290) +#define HID_USAGE_CONSUMER_AC_INSERT_ROW ((USAGE) 0x0291) +#define HID_USAGE_CONSUMER_AC_INSERT_COLUMN ((USAGE) 0x0292) +#define HID_USAGE_CONSUMER_AC_INSERT_FILE ((USAGE) 0x0293) +#define HID_USAGE_CONSUMER_AC_INSERT_PICTURE ((USAGE) 0x0294) +#define HID_USAGE_CONSUMER_AC_INSERT_OBJECT ((USAGE) 0x0295) +#define HID_USAGE_CONSUMER_AC_INSERT_SYMBOL ((USAGE) 0x0296) +#define HID_USAGE_CONSUMER_AC_SAVE_AND_CLOSE ((USAGE) 0x0297) +#define HID_USAGE_CONSUMER_AC_RENAME ((USAGE) 0x0298) +#define HID_USAGE_CONSUMER_AC_MERGE ((USAGE) 0x0299) +#define HID_USAGE_CONSUMER_AC_SPLIT ((USAGE) 0x029A) +#define HID_USAGE_CONSUMER_AC_DISRIBUTE_HORIZONTALLY ((USAGE) 0x029B) +#define HID_USAGE_CONSUMER_AC_DISTRIBUTE_VERTICALLY ((USAGE) 0x029C) +#define HID_USAGE_CONSUMER_AC_NEXT_KEYBOARD_LAYOUT_SELECT ((USAGE) 0x029D) +#define HID_USAGE_CONSUMER_AC_NAVIGATION_GUIDANCE ((USAGE) 0x029E) +#define HID_USAGE_CONSUMER_AC_DESKTOP_SHOW_ALL_WINDOWS ((USAGE) 0x029F) +#define HID_USAGE_CONSUMER_AC_SOFT_KEY_LEFT ((USAGE) 0x02A0) +#define HID_USAGE_CONSUMER_AC_SOFT_KEY_RIGHT ((USAGE) 0x02A1) +#define HID_USAGE_CONSUMER_AC_DESKTOP_SHOW_ALL_APPLICATIONS ((USAGE) 0x02A2) +#define HID_USAGE_CONSUMER_AC_IDLE_KEEP_ALIVE ((USAGE) 0x02B0) +#define HID_USAGE_CONSUMER_EXTENDED_KEYBOARD_ATTRIBUTES_COLLECTION ((USAGE) 0x02C0) +#define HID_USAGE_CONSUMER_KEYBOARD_FORM_FACTOR ((USAGE) 0x02C1) +#define HID_USAGE_CONSUMER_KEYBOARD_KEY_TYPE ((USAGE) 0x02C2) +#define HID_USAGE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT ((USAGE) 0x02C3) +#define HID_USAGE_CONSUMER_VENDOR_SPECIFIC_KEYBOARD_PHYSICAL_LAYOUT ((USAGE) 0x02C4) +#define HID_USAGE_CONSUMER_KEYBOARD_IETF_LANGUAGE_TAG_INDEX ((USAGE) 0x02C5) +#define HID_USAGE_CONSUMER_IMPLEMENTED_KEYBOARD_INPUT_ASSIST_CONTROLS ((USAGE) 0x02C6) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_PREVIOUS ((USAGE) 0x02C7) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_NEXT ((USAGE) 0x02C8) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_PREVIOUS_GROUP ((USAGE) 0x02C9) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_NEXT_GROUP ((USAGE) 0x02CA) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_ACCEPT ((USAGE) 0x02CB) +#define HID_USAGE_CONSUMER_KEYBOARD_INPUT_ASSIST_CANCEL ((USAGE) 0x02CC) +#define HID_USAGE_CONSUMER_PRIVACY_SCREEN_TOGGLE ((USAGE) 0x02D0) +#define HID_USAGE_CONSUMER_PRIVACY_SCREEN_LEVEL_DECREMENT ((USAGE) 0x02D1) +#define HID_USAGE_CONSUMER_PRIVACY_SCREEN_LEVEL_INCREMENT ((USAGE) 0x02D2) +#define HID_USAGE_CONSUMER_PRIVACY_SCREEN_LEVEL_MINIMUM ((USAGE) 0x02D3) +#define HID_USAGE_CONSUMER_PRIVACY_SCREEN_LEVEL_MAXIMUM ((USAGE) 0x02D4) +#define HID_USAGE_CONSUMER_CONTACT_EDITED ((USAGE) 0x0500) +#define HID_USAGE_CONSUMER_CONTACT_ADDED ((USAGE) 0x0501) +#define HID_USAGE_CONSUMER_CONTACT_RECORD_ACTIVE ((USAGE) 0x0502) +#define HID_USAGE_CONSUMER_CONTACT_INDEX ((USAGE) 0x0503) +#define HID_USAGE_CONSUMER_CONTACT_NICKNAME ((USAGE) 0x0504) +#define HID_USAGE_CONSUMER_CONTACT_FIRST_NAME ((USAGE) 0x0505) +#define HID_USAGE_CONSUMER_CONTACT_LAST_NAME ((USAGE) 0x0506) +#define HID_USAGE_CONSUMER_CONTACT_FULL_NAME ((USAGE) 0x0507) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_PERSONAL ((USAGE) 0x0508) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_BUSINESS ((USAGE) 0x0509) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_MOBILE ((USAGE) 0x050A) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_PAGER ((USAGE) 0x050B) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_FAX ((USAGE) 0x050C) +#define HID_USAGE_CONSUMER_CONTACT_PHONE_NUMBER_OTHER ((USAGE) 0x050D) +#define HID_USAGE_CONSUMER_CONTACT_EMAIL_PERSONAL ((USAGE) 0x050E) +#define HID_USAGE_CONSUMER_CONTACT_EMAIL_BUSINESS ((USAGE) 0x050F) +#define HID_USAGE_CONSUMER_CONTACT_EMAIL_OTHER ((USAGE) 0x0510) +#define HID_USAGE_CONSUMER_CONTACT_EMAIL_MAIN ((USAGE) 0x0511) +#define HID_USAGE_CONSUMER_CONTACT_SPEED_DIAL_NUMBER ((USAGE) 0x0512) +#define HID_USAGE_CONSUMER_CONTACT_STATUS_FLAG ((USAGE) 0x0513) +#define HID_USAGE_CONSUMER_CONTACT_MISC ((USAGE) 0x0514) +#define HID_USAGE_CONSUMER_KEYBOARD_BRIGHTNESS_NEXT ((USAGE) 0x0515) +#define HID_USAGE_CONSUMER_KEYBOARD_BRIGHTNESS_PREVIOUS ((USAGE) 0x0516) +#define HID_USAGE_CONSUMER_KEYBOARD_BACKLIGHT_LEVEL_SUGGESTION ((USAGE) 0x0517) + +#define HID_VALUE_CONSUMER_KEYBOARD_FORM_FACTOR_UNKNOWN ((USAGE_VALUE) 0x0000) +#define HID_VALUE_CONSUMER_KEYBOARD_FORM_FACTOR_FULL_SIZE ((USAGE_VALUE) 0x0001) +#define HID_VALUE_CONSUMER_KEYBOARD_FORM_FACTOR_COMPACT ((USAGE_VALUE) 0x0002) + +#define HID_VALUE_CONSUMER_KEYBOARD_KEY_TYPE_UNKNOWN ((USAGE_VALUE) 0x0000) +#define HID_VALUE_CONSUMER_KEYBOARD_KEY_TYPE_FULL_TRAVEL ((USAGE_VALUE) 0x0001) +#define HID_VALUE_CONSUMER_KEYBOARD_KEY_TYPE_LOW_TRAVEL ((USAGE_VALUE) 0x0002) +#define HID_VALUE_CONSUMER_KEYBOARD_KEY_TYPE_ZERO_TRAVEL ((USAGE_VALUE) 0x0003) + +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_UNKNOWN ((USAGE_VALUE) 0x0000) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_US_101 ((USAGE_VALUE) 0x0001) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_KOREA_103 ((USAGE_VALUE) 0x0002) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_EUROPE_102 ((USAGE_VALUE) 0x0003) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_BRAZIL_104 ((USAGE_VALUE) 0x0004) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_JAPAN_106 ((USAGE_VALUE) 0x0005) +#define HID_VALUE_CONSUMER_KEYBOARD_PHYSICAL_LAYOUT_VENDOR ((USAGE_VALUE) 0x0006) + +// +// Digitizers Page (0x0D) +// +#define HID_USAGE_DIGITIZER_DIGITIZER ((USAGE) 0x0001) +#define HID_USAGE_DIGITIZER_PEN ((USAGE) 0x0002) +#define HID_USAGE_DIGITIZER_LIGHT_PEN ((USAGE) 0x0003) +#define HID_USAGE_DIGITIZER_TOUCH_SCREEN ((USAGE) 0x0004) +#define HID_USAGE_DIGITIZER_TOUCH_PAD ((USAGE) 0x0005) +#define HID_USAGE_DIGITIZER_WHITE_BOARD ((USAGE) 0x0006) +#define HID_USAGE_DIGITIZER_COORD_MEASURING ((USAGE) 0x0007) +#define HID_USAGE_DIGITIZER_3D_DIGITIZER ((USAGE) 0x0008) +#define HID_USAGE_DIGITIZER_STEREO_PLOTTER ((USAGE) 0x0009) +#define HID_USAGE_DIGITIZER_ARTICULATED_ARM ((USAGE) 0x000A) +#define HID_USAGE_DIGITIZER_ARMATURE ((USAGE) 0x000B) +#define HID_USAGE_DIGITIZER_MULTI_POINT ((USAGE) 0x000C) +#define HID_USAGE_DIGITIZER_FREE_SPACE_WAND ((USAGE) 0x000D) +#define HID_USAGE_DIGITIZER_DEVICE_CONFIGURATION ((USAGE) 0x000E) +#define HID_USAGE_DIGITIZER_HEAT_MAP ((USAGE) 0x000F) +#define HID_USAGE_DIGITIZER_STYLUS ((USAGE) 0x0020) +#define HID_USAGE_DIGITIZER_PUCK ((USAGE) 0x0021) +#define HID_USAGE_DIGITIZER_FINGER ((USAGE) 0x0022) +#define HID_USAGE_DIGITIZER_DEVICE_SETTINGS ((USAGE) 0x0023) +#define HID_USAGE_DIGITIZER_CHARACTER_GESTURE ((USAGE) 0x0024) +#define HID_USAGE_DIGITIZER_TIP_PRESSURE ((USAGE) 0x0030) +#define HID_USAGE_DIGITIZER_BARREL_PRESSURE ((USAGE) 0x0031) +#define HID_USAGE_DIGITIZER_IN_RANGE ((USAGE) 0x0032) +#define HID_USAGE_DIGITIZER_TOUCH ((USAGE) 0x0033) +#define HID_USAGE_DIGITIZER_UNTOUCH ((USAGE) 0x0034) +#define HID_USAGE_DIGITIZER_TAP ((USAGE) 0x0035) +#define HID_USAGE_DIGITIZER_QUALITY ((USAGE) 0x0036) +#define HID_USAGE_DIGITIZER_DATA_VALID ((USAGE) 0x0037) +#define HID_USAGE_DIGITIZER_TRANSDUCER_INDEX ((USAGE) 0x0038) +#define HID_USAGE_DIGITIZER_TABLET_FUNC_KEYS ((USAGE) 0x0039) +#define HID_USAGE_DIGITIZER_PROG_CHANGE_KEYS ((USAGE) 0x003A) +#define HID_USAGE_DIGITIZER_BATTERY_STRENGTH ((USAGE) 0x003B) +#define HID_USAGE_DIGITIZER_INVERT ((USAGE) 0x003C) +#define HID_USAGE_DIGITIZER_X_TILT ((USAGE) 0x003D) +#define HID_USAGE_DIGITIZER_Y_TILT ((USAGE) 0x003E) +#define HID_USAGE_DIGITIZER_AZIMUTH ((USAGE) 0x003F) +#define HID_USAGE_DIGITIZER_ALTITUDE ((USAGE) 0x0040) +#define HID_USAGE_DIGITIZER_TWIST ((USAGE) 0x0041) +#define HID_USAGE_DIGITIZER_TIP_SWITCH ((USAGE) 0x0042) +#define HID_USAGE_DIGITIZER_SECONDARY_TIP_SWITCH ((USAGE) 0x0043) +#define HID_USAGE_DIGITIZER_BARREL_SWITCH ((USAGE) 0x0044) +#define HID_USAGE_DIGITIZER_ERASER ((USAGE) 0x0045) +#define HID_USAGE_DIGITIZER_TABLET_PICK ((USAGE) 0x0046) +#define HID_USAGE_DIGITIZER_TOUCH_VALID ((USAGE) 0x0047) +#define HID_USAGE_DIGITIZER_WIDTH ((USAGE) 0x0048) +#define HID_USAGE_DIGITIZER_HEIGHT ((USAGE) 0x0049) +#define HID_USAGE_DIGITIZER_CONTACT_IDENTIFIER ((USAGE) 0x0051) +#define HID_USAGE_DIGITIZER_DEVICE_MODE ((USAGE) 0x0052) +#define HID_USAGE_DIGITIZER_DEVICE_IDENTIFIER ((USAGE) 0x0053) +#define HID_USAGE_DIGITIZER_CONTACT_COUNT ((USAGE) 0x0054) +#define HID_USAGE_DIGITIZER_CONTACT_COUNT_MAXIMUM ((USAGE) 0x0055) +#define HID_USAGE_DIGITIZER_SCAN_TIME ((USAGE) 0x0056) +#define HID_USAGE_DIGITIZER_SURFACE_SWITCH ((USAGE) 0x0057) +#define HID_USAGE_DIGITIZER_BUTTON_SWITCH ((USAGE) 0x0058) +#define HID_USAGE_DIGITIZER_PAD_TYPE ((USAGE) 0x0059) +#define HID_USAGE_DIGITIZER_SECONDARY_BARREL_SWITCH ((USAGE) 0x005A) +#define HID_USAGE_DIGITIZER_TRANSDUCER_SERIAL ((USAGE) 0x005B) +#define HID_USAGE_DIGITIZER_PREFERRED_COLOR ((USAGE) 0x005C) +#define HID_USAGE_DIGITIZER_PREFERRED_COLOR_IS_LOCKED ((USAGE) 0x005D) +#define HID_USAGE_DIGITIZER_PREFERRED_LINE_WIDTH ((USAGE) 0x005E) +#define HID_USAGE_DIGITIZER_PREFERRED_LINE_WIDTH_IS_LOCKED ((USAGE) 0x005F) +#define HID_USAGE_DIGITIZER_LATENCY_MODE ((USAGE) 0x0060) +#define HID_USAGE_DIGITIZER_GESTURE_CHARACTER_QUALITY ((USAGE) 0x0061) +#define HID_USAGE_DIGITIZER_CHARACTER_GESTURE_DATA_LENGTH ((USAGE) 0x0062) +#define HID_USAGE_DIGITIZER_CHARACTER_GESTURE_DATA ((USAGE) 0x0063) +#define HID_USAGE_DIGITIZER_GESTURE_CHARACTER_ENCODING ((USAGE) 0x0064) +#define HID_USAGE_DIGITIZER_UTF8_CHARACTER_GESTURE_ENCODING ((USAGE) 0x0065) +#define HID_USAGE_DIGITIZER_UTF16_LITTLE_ENDIAN_CHARACTER_GESTURE_ENCODING ((USAGE) 0x0066) +#define HID_USAGE_DIGITIZER_UTF16_BIG_ENDIAN_CHARACTER_GESTURE_ENCODING ((USAGE) 0x0067) +#define HID_USAGE_DIGITIZER_UTF32_LITTLE_ENDIAN_CHARACTER_GESTURE_ENCODING ((USAGE) 0x0068) +#define HID_USAGE_DIGITIZER_UTF32_BIG_ENDIAN_CHARACTER_GESTURE_ENCODING ((USAGE) 0x0069) +#define HID_USAGE_DIGITIZER_HEAT_MAP_PROTOCOL_VENDOR_ID ((USAGE) 0x006A) +#define HID_USAGE_DIGITIZER_HEAT_MAP_PROTOCOL_VERSION ((USAGE) 0x006B) +#define HID_USAGE_DIGITIZER_HEAT_MAP_FRAME_DATA ((USAGE) 0x006C) +#define HID_USAGE_DIGITIZER_GESTURE_CHARACTER_ENABLE ((USAGE) 0x006D) +#define HID_USAGE_DIGITIZER_TRANSDUCER_SERIAL_PART2 ((USAGE) 0x006E) +#define HID_USAGE_DIGITIZER_NO_PREFERRED_COLOR ((USAGE) 0x006F) +#define HID_USAGE_DIGITIZER_PREFERRED_LINE_STYLE ((USAGE) 0x0070) +#define HID_USAGE_DIGITIZER_PREFERRED_LINE_STYLE_IS_LOCKED ((USAGE) 0x0071) +#define HID_USAGE_DIGITIZER_INK ((USAGE) 0x0072) +#define HID_USAGE_DIGITIZER_PENCIL ((USAGE) 0x0073) +#define HID_USAGE_DIGITIZER_HIGHLIGHTER ((USAGE) 0x0074) +#define HID_USAGE_DIGITIZER_CHISEL_MARKER ((USAGE) 0x0075) +#define HID_USAGE_DIGITIZER_BRUSH ((USAGE) 0x0076) +#define HID_USAGE_DIGITIZER_NO_PREFERENCE ((USAGE) 0x0077) +#define HID_USAGE_DIGITIZER_DIGITIZER_DIAGNOSTIC ((USAGE) 0x0080) +#define HID_USAGE_DIGITIZER_DIGITIZER_ERROR ((USAGE) 0x0081) +#define HID_USAGE_DIGITIZER_ERR_NORMAL_STATUS ((USAGE) 0x0082) +#define HID_USAGE_DIGITIZER_ERR_TRANSDUCERS_EXCEEDED ((USAGE) 0x0083) +#define HID_USAGE_DIGITIZER_ERR_FULL_TRANS_FEATURES_UNAVAILABLE ((USAGE) 0x0084) +#define HID_USAGE_DIGITIZER_ERR_CHARGE_LOW ((USAGE) 0x0085) +#define HID_USAGE_DIGITIZER_TRANSDUCER_SOFTWARE_INFO ((USAGE) 0x0090) +#define HID_USAGE_DIGITIZER_TRANSDUCER_VENDOR ((USAGE) 0x0091) +#define HID_USAGE_DIGITIZER_TRANSDUCER_PRODUCT ((USAGE) 0x0092) +#define HID_USAGE_DIGITIZER_DEVICE_SUPPORTED_PROTOCOLS ((USAGE) 0x0093) +#define HID_USAGE_DIGITIZER_TRANSDUCER_SUPPORTED_PROTOCOLS ((USAGE) 0x0094) +#define HID_USAGE_DIGITIZER_NO_PROTOCOL ((USAGE) 0x0095) +#define HID_USAGE_DIGITIZER_WACOM_AES_PROTOCOL ((USAGE) 0x0096) +#define HID_USAGE_DIGITIZER_USI_PROTOCOL ((USAGE) 0x0097) +#define HID_USAGE_DIGITIZER_MICROSOFT_PEN_PROTOCOL ((USAGE) 0x0098) +#define HID_USAGE_DIGITIZER_SUPPORTED_REPORT_RATES ((USAGE) 0x00A0) +#define HID_USAGE_DIGITIZER_REPORT_RATE ((USAGE) 0x00A1) +#define HID_USAGE_DIGITIZER_TRANSDUCER_CONNECTED ((USAGE) 0x00A2) +#define HID_USAGE_DIGITIZER_SWITCH_DISABLED ((USAGE) 0x00A3) +#define HID_USAGE_DIGITIZER_SWITCH_UNIMPLEMENTED ((USAGE) 0x00A4) +#define HID_USAGE_DIGITIZER_TRANSDUCER_SWITCHES ((USAGE) 0x00A5) +#define HID_USAGE_DIGITIZER_TRANSDUCER_INDEX_SELECTOR ((USAGE) 0x00A6) +#define HID_USAGE_DIGITIZER_BUTTON_PRESS_THRESHOLD ((USAGE) 0x00B0) + +// +// Eye and Head Trackers Page (0x12) +// +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_EYE_TRACKER ((USAGE) 0x0001) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_HEAD_TRACKER ((USAGE) 0x0002) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_TRACKING_DATA ((USAGE) 0x0010) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CAPABILITIES ((USAGE) 0x0011) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CONFIGURATION ((USAGE) 0x0012) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_STATUS ((USAGE) 0x0013) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CONTROL ((USAGE) 0x0014) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_SENSOR_TIMESTAMP ((USAGE) 0x0020) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_POSITION_X ((USAGE) 0x0021) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_POSITION_Y ((USAGE) 0x0022) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_POSITION_Z ((USAGE) 0x0023) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_GAZE_POINT ((USAGE) 0x0024) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_LEFT_EYE_POSITION ((USAGE) 0x0025) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_RIGHT_EYE_POSITION ((USAGE) 0x0026) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_HEAD_POSITION ((USAGE) 0x0027) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_HEAD_DIRECTION_POINT ((USAGE) 0x0028) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_ROTATION_ABOUT_X_AXIS ((USAGE) 0x0029) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_ROTATION_ABOUT_Y_AXIS ((USAGE) 0x002A) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_ROTATION_ABOUT_Z_AXIS ((USAGE) 0x002B) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_TRACKER_QUALITY ((USAGE) 0x0100) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_MINIMUM_TRACKING_DISTANCE ((USAGE) 0x0101) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_OPTIMUM_TRACKING_DISTANCE ((USAGE) 0x0102) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_MAXIMUM_TRACKING_DISTANCE ((USAGE) 0x0103) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_MAXIMUM_SCREEN_PLANE_WIDTH ((USAGE) 0x0104) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_MAXIMUM_SCREEN_PLANE_HEIGHT ((USAGE) 0x0105) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_DISPLAY_MANUFACTURER_ID ((USAGE) 0x0200) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_DISPLAY_PRODUCT_ID ((USAGE) 0x0201) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_DISPLAY_SERIAL_NUMBER ((USAGE) 0x0202) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_DISPLAY_MANUFACTURER_DATE ((USAGE) 0x0203) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CALIBRATED_SCREEN_WIDTH ((USAGE) 0x0204) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CALIBRATED_SCREEN_HEIGHT ((USAGE) 0x0205) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_SAMPLING_FREQUENCY ((USAGE) 0x0300) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_CONFIGURATION_STATUS ((USAGE) 0x0301) +#define HID_USAGE_EYE_AND_HEAD_TRACKERS_DEVICE_MODE_REQUEST ((USAGE) 0x0400) + +// +// FIDO Alliance Page (0xF1D0) +// +#define HID_USAGE_FIDO_ALLIANCE_U2F_AUTHENTICATOR_DEVICE ((USAGE) 0x0001) +#define HID_USAGE_FIDO_ALLIANCE_INPUT_REPORT_DATA ((USAGE) 0x0020) +#define HID_USAGE_FIDO_ALLIANCE_OUTPUT_REPORT_DATA ((USAGE) 0x0021) + +// +// Game Controls Page (0x05) +// +#define HID_USAGE_GAME_3D_GAME_CONTROLLER ((USAGE) 0x0001) +#define HID_USAGE_GAME_PINBALL_DEVICE ((USAGE) 0x0002) +#define HID_USAGE_GAME_GUN_DEVICE ((USAGE) 0x0003) +#define HID_USAGE_GAME_POV ((USAGE) 0x0020) +#define HID_USAGE_GAME_TURN_RIGHT_LEFT ((USAGE) 0x0021) +#define HID_USAGE_GAME_PITCH_FORWARD_BACK ((USAGE) 0x0022) +#define HID_USAGE_GAME_ROLL_RIGHT_LEFT ((USAGE) 0x0023) +#define HID_USAGE_GAME_MOVE_RIGHT_LEFT ((USAGE) 0x0024) +#define HID_USAGE_GAME_MOVE_FORWARD_BACK ((USAGE) 0x0025) +#define HID_USAGE_GAME_MOVE_UP_DOWN ((USAGE) 0x0026) +#define HID_USAGE_GAME_LEAN_RIGHT_LEFT ((USAGE) 0x0027) +#define HID_USAGE_GAME_LEAN_FORWARD_BACK ((USAGE) 0x0028) +#define HID_USAGE_GAME_POV_HEIGHT ((USAGE) 0x0029) +#define HID_USAGE_GAME_FLIPPER ((USAGE) 0x002A) +#define HID_USAGE_GAME_SECONDARY_FLIPPER ((USAGE) 0x002B) +#define HID_USAGE_GAME_BUMP ((USAGE) 0x002C) +#define HID_USAGE_GAME_NEW_GAME ((USAGE) 0x002D) +#define HID_USAGE_GAME_SHOOT_BALL ((USAGE) 0x002E) +#define HID_USAGE_GAME_PLAYER ((USAGE) 0x002F) +#define HID_USAGE_GAME_GUN_BOLT ((USAGE) 0x0030) +#define HID_USAGE_GAME_GUN_CLIP ((USAGE) 0x0031) +#define HID_USAGE_GAME_GUN_SELECTOR ((USAGE) 0x0032) +#define HID_USAGE_GAME_GUN_SINGLE_SHOT ((USAGE) 0x0033) +#define HID_USAGE_GAME_GUN_BURST ((USAGE) 0x0034) +#define HID_USAGE_GAME_GUN_AUTOMATIC ((USAGE) 0x0035) +#define HID_USAGE_GAME_GUN_SAFETY ((USAGE) 0x0036) +#define HID_USAGE_GAME_GAMEPAD_FIRE_JUMP ((USAGE) 0x0037) +#define HID_USAGE_GAME_GAMEPAD_TRIGGER ((USAGE) 0x0039) +#define HID_USAGE_GAME_FORMFITTING_GAMEPAD ((USAGE) 0x003A) + +// +// Gaming Device Page (0x92) +// +// There is no need to label these usages. +// + +// +// Generic Desktop Page (0x01) +// +#define HID_USAGE_GENERIC_POINTER ((USAGE) 0x0001) +#define HID_USAGE_GENERIC_MOUSE ((USAGE) 0x0002) +#define HID_USAGE_GENERIC_JOYSTICK ((USAGE) 0x0004) +#define HID_USAGE_GENERIC_GAMEPAD ((USAGE) 0x0005) +#define HID_USAGE_GENERIC_KEYBOARD ((USAGE) 0x0006) +#define HID_USAGE_GENERIC_KEYPAD ((USAGE) 0x0007) +#define HID_USAGE_GENERIC_MULTI_AXIS_CONTROLLER ((USAGE) 0x0008) +#define HID_USAGE_GENERIC_TABLET_PC_SYSTEM_CTL ((USAGE) 0x0009) +#define HID_USAGE_GENERIC_WATER_COOLING_DEVICE ((USAGE) 0x000A) +#define HID_USAGE_GENERIC_COMPUTER_CHASSIS_DEVICE ((USAGE) 0x000B) +#define HID_USAGE_GENERIC_WIRELESS_RADIO_CONTROLS ((USAGE) 0x000C) +#define HID_USAGE_GENERIC_PORTABLE_DEVICE_CONTROL ((USAGE) 0x000D) +#define HID_USAGE_GENERIC_INTERACTIVE_CONTROL ((USAGE) 0x000E) +#define HID_USAGE_GENERIC_SPATIAL_CONTROLLER ((USAGE) 0x000F) +#define HID_USAGE_GENERIC_ASSISTIVE_CONTROL ((USAGE) 0x0010) +#define HID_USAGE_GENERIC_DEVICE_DOCK ((USAGE) 0x0011) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE ((USAGE) 0x0012) +#define HID_USAGE_GENERIC_CALL_STATE_MANAGEMENT_CONTROL ((USAGE) 0x0013) +#define HID_USAGE_GENERIC_X ((USAGE) 0x0030) +#define HID_USAGE_GENERIC_Y ((USAGE) 0x0031) +#define HID_USAGE_GENERIC_Z ((USAGE) 0x0032) +#define HID_USAGE_GENERIC_RX ((USAGE) 0x0033) +#define HID_USAGE_GENERIC_RY ((USAGE) 0x0034) +#define HID_USAGE_GENERIC_RZ ((USAGE) 0x0035) +#define HID_USAGE_GENERIC_SLIDER ((USAGE) 0x0036) +#define HID_USAGE_GENERIC_DIAL ((USAGE) 0x0037) +#define HID_USAGE_GENERIC_WHEEL ((USAGE) 0x0038) +#define HID_USAGE_GENERIC_HATSWITCH ((USAGE) 0x0039) +#define HID_USAGE_GENERIC_COUNTED_BUFFER ((USAGE) 0x003A) +#define HID_USAGE_GENERIC_BYTE_COUNT ((USAGE) 0x003B) +#define HID_USAGE_GENERIC_MOTION_WAKEUP ((USAGE) 0x003C) +#define HID_USAGE_GENERIC_START ((USAGE) 0x003D) +#define HID_USAGE_GENERIC_SELECT ((USAGE) 0x003E) +#define HID_USAGE_GENERIC_VX ((USAGE) 0x0040) +#define HID_USAGE_GENERIC_VY ((USAGE) 0x0041) +#define HID_USAGE_GENERIC_VZ ((USAGE) 0x0042) +#define HID_USAGE_GENERIC_VBRX ((USAGE) 0x0043) +#define HID_USAGE_GENERIC_VBRY ((USAGE) 0x0044) +#define HID_USAGE_GENERIC_VBRZ ((USAGE) 0x0045) +#define HID_USAGE_GENERIC_VNO ((USAGE) 0x0046) +#define HID_USAGE_GENERIC_FEATURE_NOTIFICATION ((USAGE) 0x0047) +#define HID_USAGE_GENERIC_RESOLUTION_MULTIPLIER ((USAGE) 0x0048) +#define HID_USAGE_GENERIC_QX ((USAGE) 0x0049) +#define HID_USAGE_GENERIC_QY ((USAGE) 0x004A) +#define HID_USAGE_GENERIC_QZ ((USAGE) 0x004B) +#define HID_USAGE_GENERIC_QW ((USAGE) 0x004C) +#define HID_USAGE_GENERIC_SYSTEM_CTL ((USAGE) 0x0080) +#define HID_USAGE_GENERIC_SYSCTL_POWER ((USAGE) 0x0081) +#define HID_USAGE_GENERIC_SYSCTL_SLEEP ((USAGE) 0x0082) +#define HID_USAGE_GENERIC_SYSCTL_WAKE ((USAGE) 0x0083) +#define HID_USAGE_GENERIC_SYSCTL_CONTEXT_MENU ((USAGE) 0x0084) +#define HID_USAGE_GENERIC_SYSCTL_MAIN_MENU ((USAGE) 0x0085) +#define HID_USAGE_GENERIC_SYSCTL_APP_MENU ((USAGE) 0x0086) +#define HID_USAGE_GENERIC_SYSCTL_HELP_MENU ((USAGE) 0x0087) +#define HID_USAGE_GENERIC_SYSCTL_MENU_EXIT ((USAGE) 0x0088) +#define HID_USAGE_GENERIC_SYSCTL_MENU_SELECT ((USAGE) 0x0089) +#define HID_USAGE_GENERIC_SYSCTL_MENU_RIGHT ((USAGE) 0x008A) +#define HID_USAGE_GENERIC_SYSCTL_MENU_LEFT ((USAGE) 0x008B) +#define HID_USAGE_GENERIC_SYSCTL_MENU_UP ((USAGE) 0x008C) +#define HID_USAGE_GENERIC_SYSCTL_MENU_DOWN ((USAGE) 0x008D) +#define HID_USAGE_GENERIC_SYSCTL_COLD_RESTART ((USAGE) 0x008E) +#define HID_USAGE_GENERIC_SYSCTL_WARM_RESTART ((USAGE) 0x008F) +#define HID_USAGE_GENERIC_DPAD_UP ((USAGE) 0x0090) +#define HID_USAGE_GENERIC_DPAD_DOWN ((USAGE) 0x0091) +#define HID_USAGE_GENERIC_DPAD_RIGHT ((USAGE) 0x0092) +#define HID_USAGE_GENERIC_DPAD_LEFT ((USAGE) 0x0093) +#define HID_USAGE_GENERIC_INDEX_TRIGGER ((USAGE) 0x0094) +#define HID_USAGE_GENERIC_PALM_TRIGGER ((USAGE) 0x0095) +#define HID_USAGE_GENERIC_THUMBSTICK ((USAGE) 0x0096) +#define HID_USAGE_GENERIC_SYSCTL_FN ((USAGE) 0x0097) +#define HID_USAGE_GENERIC_SYSCTL_FN_LOCK ((USAGE) 0x0098) +#define HID_USAGE_GENERIC_SYSCTL_FN_LOCK_INDICATOR ((USAGE) 0x0099) +#define HID_USAGE_GENERIC_SYSCTL_DISMISS_NOTIFICATION ((USAGE) 0x009A) +#define HID_USAGE_GENERIC_SYSTEM_DO_NOT_DISTURB ((USAGE) 0x009B) +#define HID_USAGE_GENERIC_SYSCTL_DOCK ((USAGE) 0x00A0) +#define HID_USAGE_GENERIC_SYSCTL_UNDOCK ((USAGE) 0x00A1) +#define HID_USAGE_GENERIC_SYSCTL_SETUP ((USAGE) 0x00A2) +#define HID_USAGE_GENERIC_SYSCTL_SYS_BREAK ((USAGE) 0x00A3) +#define HID_USAGE_GENERIC_SYSCTL_SYS_DBG_BREAK ((USAGE) 0x00A4) +#define HID_USAGE_GENERIC_SYSCTL_APP_BREAK ((USAGE) 0x00A5) +#define HID_USAGE_GENERIC_SYSCTL_APP_DBG_BREAK ((USAGE) 0x00A6) +#define HID_USAGE_GENERIC_SYSCTL_MUTE ((USAGE) 0x00A7) +#define HID_USAGE_GENERIC_SYSCTL_HIBERNATE ((USAGE) 0x00A8) +#define HID_USAGE_GENERIC_SYSCTL_MICROPHONE_MUTE ((USAGE) 0x00A9) +#define HID_USAGE_GENERIC_SYSCTL_ACCESSIBILITY_BINDING ((USAGE) 0x00AA) +#define HID_USAGE_GENERIC_SYSCTL_DISP_INVERT ((USAGE) 0x00B0) +#define HID_USAGE_GENERIC_SYSCTL_DISP_INTERNAL ((USAGE) 0x00B1) +#define HID_USAGE_GENERIC_SYSCTL_DISP_EXTERNAL ((USAGE) 0x00B2) +#define HID_USAGE_GENERIC_SYSCTL_DISP_BOTH ((USAGE) 0x00B3) +#define HID_USAGE_GENERIC_SYSCTL_DISP_DUAL ((USAGE) 0x00B4) +#define HID_USAGE_GENERIC_SYSCTL_DISP_TOGGLE ((USAGE) 0x00B5) +#define HID_USAGE_GENERIC_SYSCTL_DISP_SWAP ((USAGE) 0x00B6) +#define HID_USAGE_GENERIC_SYSCTL_DISP_AUTOSCALE ((USAGE) 0x00B7) +#define HID_USAGE_GENERIC_SENSOR_ZONE ((USAGE) 0x00C0) +#define HID_USAGE_GENERIC_RPM ((USAGE) 0x00C1) +#define HID_USAGE_GENERIC_COOLANT_LEVEL ((USAGE) 0x00C2) +#define HID_USAGE_GENERIC_COOLANT_CRITICAL_LEVEL ((USAGE) 0x00C3) +#define HID_USAGE_GENERIC_COOLANT_PUMP ((USAGE) 0x00C4) +#define HID_USAGE_GENERIC_CHASSIS_ENCLOSURE ((USAGE) 0x00C5) +#define HID_USAGE_GENERIC_WIRELESS_RADIO_BUTTON ((USAGE) 0x00C6) +#define HID_USAGE_GENERIC_WIRELESS_RADIO_LED ((USAGE) 0x00C7) +#define HID_USAGE_GENERIC_WIRELESS_RADIO_SLIDER_SWITCH ((USAGE) 0x00C8) +#define HID_USAGE_GENERIC_SYSTEM_DISPLAY_ROTATION_LOCK_BUTTON ((USAGE) 0x00C9) +#define HID_USAGE_GENERIC_SYSTEM_DISPLAY_ROTATION_LOCK_SLIDER_SWITCH ((USAGE) 0x00CA) +#define HID_USAGE_GENERIC_CONTROL_ENABLE ((USAGE) 0x00CB) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_UNIQUE_ID ((USAGE) 0x00D0) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_VENDOR_ID ((USAGE) 0x00D1) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_PRIMARY_USAGE_PAGE ((USAGE) 0x00D2) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_PRIMARY_USAGE_ID ((USAGE) 0x00D3) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_DOCKING_STATE ((USAGE) 0x00D4) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_DISPLAY_OCCLUSION ((USAGE) 0x00D5) +#define HID_USAGE_GENERIC_DOCKABLE_DEVICE_OBJECT_TYPE ((USAGE) 0x00D6) +#define HID_USAGE_GENERIC_CALL_ACTIVE_LED ((USAGE) 0x00E0) +#define HID_USAGE_GENERIC_CALL_MUTE_TOGGLE ((USAGE) 0x00E1) +#define HID_USAGE_GENERIC_CALL_MUTE_LED ((USAGE) 0x00E2) + +// +// Generic Device Controls Page (0x06) +// +#define HID_USAGE_GENERIC_DEVICE_BACKGROUNDNONUSER_CONTROLS ((USAGE) 0x0001) +#define HID_USAGE_GENERIC_DEVICE_BATTERY_STRENGTH ((USAGE) 0x0020) +#define HID_USAGE_GENERIC_DEVICE_WIRELESS_CHANNEL ((USAGE) 0x0021) +#define HID_USAGE_GENERIC_DEVICE_WIRELESS_ID ((USAGE) 0x0022) +#define HID_USAGE_GENERIC_DEVICE_DISCOVER_WIRELESS_CONTROL ((USAGE) 0x0023) +#define HID_USAGE_GENERIC_DEVICE_SECURITY_CODE_CHAR_ENTERED ((USAGE) 0x0024) +#define HID_USAGE_GENERIC_DEVICE_SECURITY_CODE_CHAR_ERASED ((USAGE) 0x0025) +#define HID_USAGE_GENERIC_DEVICE_SECURITY_CODE_CLEARED ((USAGE) 0x0026) +#define HID_USAGE_GENERIC_DEVICE_SEQUENCE_ID ((USAGE) 0x0027) +#define HID_USAGE_GENERIC_DEVICE_SEQUENCE_ID_RESET ((USAGE) 0x0028) +#define HID_USAGE_GENERIC_DEVICE_RF_SIGNAL_STRENGTH ((USAGE) 0x0029) +#define HID_USAGE_GENERIC_DEVICE_SOFTWARE_VERSION ((USAGE) 0x002A) +#define HID_USAGE_GENERIC_DEVICE_PROTOCOL_VERSION ((USAGE) 0x002B) +#define HID_USAGE_GENERIC_DEVICE_HARDWARE_VERSION ((USAGE) 0x002C) +#define HID_USAGE_GENERIC_DEVICE_MAJOR ((USAGE) 0x002D) +#define HID_USAGE_GENERIC_DEVICE_MINOR ((USAGE) 0x002E) +#define HID_USAGE_GENERIC_DEVICE_REVISION ((USAGE) 0x002F) +#define HID_USAGE_GENERIC_DEVICE_HANDEDNESS ((USAGE) 0x0030) +#define HID_USAGE_GENERIC_DEVICE_EITHER_HAND ((USAGE) 0x0031) +#define HID_USAGE_GENERIC_DEVICE_LEFT_HAND ((USAGE) 0x0032) +#define HID_USAGE_GENERIC_DEVICE_RIGHT_HAND ((USAGE) 0x0033) +#define HID_USAGE_GENERIC_DEVICE_BOTH_HANDS ((USAGE) 0x0034) +#define HID_USAGE_GENERIC_DEVICE_GRIP_POSE_OFFSET ((USAGE) 0x0040) +#define HID_USAGE_GENERIC_DEVICE_POINTER_POSE_OFFSET ((USAGE) 0x0041) + +// +// Haptics Page (0x0E) +// +#define HID_USAGE_HAPTICS_SIMPLE_CONTROLLER ((USAGE) 0x0001) +#define HID_USAGE_HAPTICS_WAVEFORM_LIST ((USAGE) 0x0010) +#define HID_USAGE_HAPTICS_DURATION_LIST ((USAGE) 0x0011) +#define HID_USAGE_HAPTICS_AUTO_TRIGGER ((USAGE) 0x0020) +#define HID_USAGE_HAPTICS_MANUAL_TRIGGER ((USAGE) 0x0021) +#define HID_USAGE_HAPTICS_AUTO_ASSOCIATED_CONTROL ((USAGE) 0x0022) +#define HID_USAGE_HAPTICS_INTENSITY ((USAGE) 0x0023) +#define HID_USAGE_HAPTICS_REPEAT_COUNT ((USAGE) 0x0024) +#define HID_USAGE_HAPTICS_RETRIGGER_PERIOD ((USAGE) 0x0025) +#define HID_USAGE_HAPTICS_WAVEFORM_VENDOR_PAGE ((USAGE) 0x0026) +#define HID_USAGE_HAPTICS_WAVEFORM_VENDOR_ID ((USAGE) 0x0027) +#define HID_USAGE_HAPTICS_WAVEFORM_CUTOFF_TIME ((USAGE) 0x0028) +#define HID_USAGE_HAPTICS_WAVEFORM_NONE ((USAGE) 0x1001) +#define HID_USAGE_HAPTICS_WAVEFORM_STOP ((USAGE) 0x1002) +#define HID_USAGE_HAPTICS_WAVEFORM_CLICK ((USAGE) 0x1003) +#define HID_USAGE_HAPTICS_WAVEFORM_BUZZ ((USAGE) 0x1004) +#define HID_USAGE_HAPTICS_WAVEFORM_RUMBLE ((USAGE) 0x1005) +#define HID_USAGE_HAPTICS_WAVEFORM_PRESS ((USAGE) 0x1006) +#define HID_USAGE_HAPTICS_WAVEFORM_RELEASE ((USAGE) 0x1007) +#define HID_USAGE_HAPTICS_WAVEFORM_HOVER ((USAGE) 0x1008) +#define HID_USAGE_HAPTICS_WAVEFORM_SUCCESS ((USAGE) 0x1009) +#define HID_USAGE_HAPTICS_WAVEFORM_ERROR ((USAGE) 0x100A) +#define HID_USAGE_HAPTICS_WAVEFORM_INK_CONTINUOUS ((USAGE) 0x100B) +#define HID_USAGE_HAPTICS_WAVEFORM_PENCIL_CONTINUOUS ((USAGE) 0x100C) +#define HID_USAGE_HAPTICS_WAVEFORM_MARKER_CONTINUOUS ((USAGE) 0x100D) +#define HID_USAGE_HAPTICS_WAVEFORM_CHISEL_MARKER_CONTINUOUS ((USAGE) 0x100E) +#define HID_USAGE_HAPTICS_WAVEFORM_BRUSH_CONTINUOUS ((USAGE) 0x100F) +#define HID_USAGE_HAPTICS_WAVEFORM_ERASER_CONTINUOUS ((USAGE) 0x1010) +#define HID_USAGE_HAPTICS_WAVEFORM_SPARKLE_CONTINUOUS ((USAGE) 0x1011) + +// +// Keyboard/Keypad Page (0x07) +// +#define HID_USAGE_KEYBOARD_NOEVENT ((USAGE) 0x0000) +#define HID_USAGE_KEYBOARD_ROLLOVER ((USAGE) 0x0001) +#define HID_USAGE_KEYBOARD_POSTFAIL ((USAGE) 0x0002) +#define HID_USAGE_KEYBOARD_UNDEFINED ((USAGE) 0x0003) +#define HID_USAGE_KEYBOARD_aA ((USAGE) 0x0004) +#define HID_USAGE_KEYBOARD_bB ((USAGE) 0x0005) +#define HID_USAGE_KEYBOARD_cC ((USAGE) 0x0006) +#define HID_USAGE_KEYBOARD_dD ((USAGE) 0x0007) +#define HID_USAGE_KEYBOARD_eE ((USAGE) 0x0008) +#define HID_USAGE_KEYBOARD_fF ((USAGE) 0x0009) +#define HID_USAGE_KEYBOARD_gG ((USAGE) 0x000A) +#define HID_USAGE_KEYBOARD_hH ((USAGE) 0x000B) +#define HID_USAGE_KEYBOARD_iI ((USAGE) 0x000C) +#define HID_USAGE_KEYBOARD_jJ ((USAGE) 0x000D) +#define HID_USAGE_KEYBOARD_kK ((USAGE) 0x000E) +#define HID_USAGE_KEYBOARD_lL ((USAGE) 0x000F) +#define HID_USAGE_KEYBOARD_mM ((USAGE) 0x0010) +#define HID_USAGE_KEYBOARD_nN ((USAGE) 0x0011) +#define HID_USAGE_KEYBOARD_oO ((USAGE) 0x0012) +#define HID_USAGE_KEYBOARD_pP ((USAGE) 0x0013) +#define HID_USAGE_KEYBOARD_qQ ((USAGE) 0x0014) +#define HID_USAGE_KEYBOARD_rR ((USAGE) 0x0015) +#define HID_USAGE_KEYBOARD_sS ((USAGE) 0x0016) +#define HID_USAGE_KEYBOARD_tT ((USAGE) 0x0017) +#define HID_USAGE_KEYBOARD_uU ((USAGE) 0x0018) +#define HID_USAGE_KEYBOARD_vV ((USAGE) 0x0019) +#define HID_USAGE_KEYBOARD_wW ((USAGE) 0x001A) +#define HID_USAGE_KEYBOARD_xX ((USAGE) 0x001B) +#define HID_USAGE_KEYBOARD_yY ((USAGE) 0x001C) +#define HID_USAGE_KEYBOARD_zZ ((USAGE) 0x001D) +#define HID_USAGE_KEYBOARD_ONE ((USAGE) 0x001E) +#define HID_USAGE_KEYBOARD_TWO_AND_AT ((USAGE) 0x001F) +#define HID_USAGE_KEYBOARD_THREE_AND_HASH ((USAGE) 0x0020) +#define HID_USAGE_KEYBOARD_FOUR_AND_DOLLAR ((USAGE) 0x0021) +#define HID_USAGE_KEYBOARD_FIVE_AND_PERCENT ((USAGE) 0x0022) +#define HID_USAGE_KEYBOARD_SIX_AND_CARET ((USAGE) 0x0023) +#define HID_USAGE_KEYBOARD_SEVEN_AND_AMPERSAND ((USAGE) 0x0024) +#define HID_USAGE_KEYBOARD_EIGHT_AND_STAR ((USAGE) 0x0025) +#define HID_USAGE_KEYBOARD_NINE_AND_LEFT_BRACKET ((USAGE) 0x0026) +#define HID_USAGE_KEYBOARD_ZERO ((USAGE) 0x0027) +#define HID_USAGE_KEYBOARD_RETURN ((USAGE) 0x0028) +#define HID_USAGE_KEYBOARD_ESCAPE ((USAGE) 0x0029) +#define HID_USAGE_KEYBOARD_DELETE ((USAGE) 0x002A) +#define HID_USAGE_KEYBOARD_TAB ((USAGE) 0x002B) +#define HID_USAGE_KEYBOARD_SPACEBAR ((USAGE) 0x002C) +#define HID_USAGE_KEYBOARD_DASH_AND_UNDERSCORE ((USAGE) 0x002D) +#define HID_USAGE_KEYBOARD_EQUALS_AND_PLUS ((USAGE) 0x002E) +#define HID_USAGE_KEYBOARD_LEFT_BRACE ((USAGE) 0x002F) +#define HID_USAGE_KEYBOARD_RIGHT_BRACE ((USAGE) 0x0030) +#define HID_USAGE_KEYBOARD_BACKSLASH_AND_PIPE ((USAGE) 0x0031) +#define HID_USAGE_KEYBOARD_NONUS_HASH_AND_TILDE ((USAGE) 0x0032) +#define HID_USAGE_KEYBOARD_SEMICOLON_AND_COLON ((USAGE) 0x0033) +#define HID_USAGE_KEYBOARD_LEFT_APOS_AND_DOUBLE ((USAGE) 0x0034) +#define HID_USAGE_KEYBOARD_GRAVE_ACCENT_AND_TILDE ((USAGE) 0x0035) +#define HID_USAGE_KEYBOARD_COMMA_AND_LESSTHAN ((USAGE) 0x0036) +#define HID_USAGE_KEYBOARD_PERIOD_AND_GREATERTHAN ((USAGE) 0x0037) +#define HID_USAGE_KEYBOARD_FORWARDSLASH_AND_QUESTIONMARK ((USAGE) 0x0038) +#define HID_USAGE_KEYBOARD_CAPS_LOCK ((USAGE) 0x0039) +#define HID_USAGE_KEYBOARD_F1 ((USAGE) 0x003A) +#define HID_USAGE_KEYBOARD_F2 ((USAGE) 0x003B) +#define HID_USAGE_KEYBOARD_F3 ((USAGE) 0x003C) +#define HID_USAGE_KEYBOARD_F4 ((USAGE) 0x003D) +#define HID_USAGE_KEYBOARD_F5 ((USAGE) 0x003E) +#define HID_USAGE_KEYBOARD_F6 ((USAGE) 0x003F) +#define HID_USAGE_KEYBOARD_F7 ((USAGE) 0x0040) +#define HID_USAGE_KEYBOARD_F8 ((USAGE) 0x0041) +#define HID_USAGE_KEYBOARD_F9 ((USAGE) 0x0042) +#define HID_USAGE_KEYBOARD_F10 ((USAGE) 0x0043) +#define HID_USAGE_KEYBOARD_F11 ((USAGE) 0x0044) +#define HID_USAGE_KEYBOARD_F12 ((USAGE) 0x0045) +#define HID_USAGE_KEYBOARD_PRINT_SCREEN ((USAGE) 0x0046) +#define HID_USAGE_KEYBOARD_SCROLL_LOCK ((USAGE) 0x0047) +#define HID_USAGE_KEYBOARD_PAUSE ((USAGE) 0x0048) +#define HID_USAGE_KEYBOARD_INSERT ((USAGE) 0x0049) +#define HID_USAGE_KEYBOARD_HOME ((USAGE) 0x004A) +#define HID_USAGE_KEYBOARD_PAGEUP ((USAGE) 0x004B) +#define HID_USAGE_KEYBOARD_DELETE_FORWARD ((USAGE) 0x004C) +#define HID_USAGE_KEYBOARD_END ((USAGE) 0x004D) +#define HID_USAGE_KEYBOARD_PAGEDOWN ((USAGE) 0x004E) +#define HID_USAGE_KEYBOARD_RIGHTARROW ((USAGE) 0x004F) +#define HID_USAGE_KEYBOARD_LEFTARROW ((USAGE) 0x0050) +#define HID_USAGE_KEYBOARD_DOWNARROW ((USAGE) 0x0051) +#define HID_USAGE_KEYBOARD_UPARROW ((USAGE) 0x0052) +#define HID_USAGE_KEYBOARD_NUM_LOCK ((USAGE) 0x0053) +#define HID_USAGE_KEYBOARD_KEYPAD_FORWARDSLASH ((USAGE) 0x0054) +#define HID_USAGE_KEYBOARD_KEYPAD_STAR ((USAGE) 0x0055) +#define HID_USAGE_KEYBOARD_DASH ((USAGE) 0x0056) +#define HID_USAGE_KEYBOARD_KEYPAD_PLUS ((USAGE) 0x0057) +#define HID_USAGE_KEYBOARD_KEYPAD_ENTER ((USAGE) 0x0058) +#define HID_USAGE_KEYBOARD_KEYPAD_ONE_AND_END ((USAGE) 0x0059) +#define HID_USAGE_KEYBOARD_KEYPAD_TWO_AND_DOWN_ARROW ((USAGE) 0x005A) +#define HID_USAGE_KEYBOARD_KEYPAD_THREE_AND_PAGEDN ((USAGE) 0x005B) +#define HID_USAGE_KEYBOARD_KEYPAD_FOUR_AND_LEFT_ARROW ((USAGE) 0x005C) +#define HID_USAGE_KEYBOARD_KEYPAD_FIVE ((USAGE) 0x005D) +#define HID_USAGE_KEYBOARD_KEYPAD_SIX_AND_RIGHT_ARROW ((USAGE) 0x005E) +#define HID_USAGE_KEYBOARD_KEYPAD_SEVEN_AND_HOME ((USAGE) 0x005F) +#define HID_USAGE_KEYBOARD_KEYPAD_EIGHT_AND_UP_ARROW ((USAGE) 0x0060) +#define HID_USAGE_KEYBOARD_KEYPAD_NINE_AND_PAGEUP ((USAGE) 0x0061) +#define HID_USAGE_KEYBOARD_KEYPAD_ZERO_AND_INSERT ((USAGE) 0x0062) +#define HID_USAGE_KEYBOARD_KEYPAD_PERIOD_AND_DELETE ((USAGE) 0x0063) +#define HID_USAGE_KEYBOARD_NONUS_BACKSLASH_AND_PIPE ((USAGE) 0x0064) +#define HID_USAGE_KEYBOARD_APPLICATION ((USAGE) 0x0065) +#define HID_USAGE_KEYBOARD_POWER ((USAGE) 0x0066) +#define HID_USAGE_KEYBOARD_KEYPAD_EQUALS ((USAGE) 0x0067) +#define HID_USAGE_KEYBOARD_F13 ((USAGE) 0x0068) +#define HID_USAGE_KEYBOARD_F14 ((USAGE) 0x0069) +#define HID_USAGE_KEYBOARD_F15 ((USAGE) 0x006A) +#define HID_USAGE_KEYBOARD_F16 ((USAGE) 0x006B) +#define HID_USAGE_KEYBOARD_F17 ((USAGE) 0x006C) +#define HID_USAGE_KEYBOARD_F18 ((USAGE) 0x006D) +#define HID_USAGE_KEYBOARD_F19 ((USAGE) 0x006E) +#define HID_USAGE_KEYBOARD_F20 ((USAGE) 0x006F) +#define HID_USAGE_KEYBOARD_F21 ((USAGE) 0x0070) +#define HID_USAGE_KEYBOARD_F22 ((USAGE) 0x0071) +#define HID_USAGE_KEYBOARD_F23 ((USAGE) 0x0072) +#define HID_USAGE_KEYBOARD_F24 ((USAGE) 0x0073) +#define HID_USAGE_KEYBOARD_EXECUTE ((USAGE) 0x0074) +#define HID_USAGE_KEYBOARD_HELP ((USAGE) 0x0075) +#define HID_USAGE_KEYBOARD_MENU ((USAGE) 0x0076) +#define HID_USAGE_KEYBOARD_SELECT ((USAGE) 0x0077) +#define HID_USAGE_KEYBOARD_STOP ((USAGE) 0x0078) +#define HID_USAGE_KEYBOARD_AGAIN ((USAGE) 0x0079) +#define HID_USAGE_KEYBOARD_UNDO ((USAGE) 0x007A) +#define HID_USAGE_KEYBOARD_CUT ((USAGE) 0x007B) +#define HID_USAGE_KEYBOARD_COPY ((USAGE) 0x007C) +#define HID_USAGE_KEYBOARD_PASTE ((USAGE) 0x007D) +#define HID_USAGE_KEYBOARD_FIND ((USAGE) 0x007E) +#define HID_USAGE_KEYBOARD_MUTE ((USAGE) 0x007F) +#define HID_USAGE_KEYBOARD_VOLUME_UP ((USAGE) 0x0080) +#define HID_USAGE_KEYBOARD_VOLUME_DOWN ((USAGE) 0x0081) +#define HID_USAGE_KEYBOARD_LOCKING_CAPS_LOCK ((USAGE) 0x0082) +#define HID_USAGE_KEYBOARD_LOCKING_NUM_LOCK ((USAGE) 0x0083) +#define HID_USAGE_KEYBOARD_LOCKING_SCROLL_LOCK ((USAGE) 0x0084) +#define HID_USAGE_KEYBOARD_KEYPAD_COMMA ((USAGE) 0x0085) +#define HID_USAGE_KEYBOARD_KEYPAD_EQUAL_SIGN ((USAGE) 0x0086) +#define HID_USAGE_KEYBOARD_INTERNATIONAL1 ((USAGE) 0x0087) +#define HID_USAGE_KEYBOARD_INTERNATIONAL2 ((USAGE) 0x0088) +#define HID_USAGE_KEYBOARD_INTERNATIONAL3 ((USAGE) 0x0089) +#define HID_USAGE_KEYBOARD_INTERNATIONAL4 ((USAGE) 0x008A) +#define HID_USAGE_KEYBOARD_INTERNATIONAL5 ((USAGE) 0x008B) +#define HID_USAGE_KEYBOARD_INTERNATIONAL6 ((USAGE) 0x008C) +#define HID_USAGE_KEYBOARD_INTERNATIONAL7 ((USAGE) 0x008D) +#define HID_USAGE_KEYBOARD_INTERNATIONAL8 ((USAGE) 0x008E) +#define HID_USAGE_KEYBOARD_INTERNATIONAL9 ((USAGE) 0x008F) +#define HID_USAGE_KEYBOARD_LANG1 ((USAGE) 0x0090) +#define HID_USAGE_KEYBOARD_LANG2 ((USAGE) 0x0091) +#define HID_USAGE_KEYBOARD_LANG3 ((USAGE) 0x0092) +#define HID_USAGE_KEYBOARD_LANG4 ((USAGE) 0x0093) +#define HID_USAGE_KEYBOARD_LANG5 ((USAGE) 0x0094) +#define HID_USAGE_KEYBOARD_LANG6 ((USAGE) 0x0095) +#define HID_USAGE_KEYBOARD_LANG7 ((USAGE) 0x0096) +#define HID_USAGE_KEYBOARD_LANG8 ((USAGE) 0x0097) +#define HID_USAGE_KEYBOARD_LANG9 ((USAGE) 0x0098) +#define HID_USAGE_KEYBOARD_ALTERNATE_ERASE ((USAGE) 0x0099) +#define HID_USAGE_KEYBOARD_SYSREQ_ATTENTION ((USAGE) 0x009A) +#define HID_USAGE_KEYBOARD_CANCEL ((USAGE) 0x009B) +#define HID_USAGE_KEYBOARD_CLEAR ((USAGE) 0x009C) +#define HID_USAGE_KEYBOARD_PRIOR ((USAGE) 0x009D) +#define HID_USAGE_KEYBOARD_RETURN_NO_ENTER ((USAGE) 0x009E) +#define HID_USAGE_KEYBOARD_SEPARATOR ((USAGE) 0x009F) +#define HID_USAGE_KEYBOARD_OUT ((USAGE) 0x00A0) +#define HID_USAGE_KEYBOARD_OPER ((USAGE) 0x00A1) +#define HID_USAGE_KEYBOARD_CLEAR_AGAIN ((USAGE) 0x00A2) +#define HID_USAGE_KEYBOARD_CRSEL_PROPS ((USAGE) 0x00A3) +#define HID_USAGE_KEYBOARD_EXSEL ((USAGE) 0x00A4) +#define HID_USAGE_KEYBOARD_KEYPAD_DOUBLE_0 ((USAGE) 0x00B0) +#define HID_USAGE_KEYBOARD_KEYPAD_TRIPLE_0 ((USAGE) 0x00B1) +#define HID_USAGE_KEYBOARD_THOUSANDS_SEPARATOR ((USAGE) 0x00B2) +#define HID_USAGE_KEYBOARD_DECIMAL_SEPARATOR ((USAGE) 0x00B3) +#define HID_USAGE_KEYBOARD_CURRENCY_UNIT ((USAGE) 0x00B4) +#define HID_USAGE_KEYBOARD_CURRENCY_SUBUNIT ((USAGE) 0x00B5) +#define HID_USAGE_KEYBOARD_KEYPAD_LEFT_BRACKET ((USAGE) 0x00B6) +#define HID_USAGE_KEYBOARD_KEYPAD_RIGHT_BRACKET ((USAGE) 0x00B7) +#define HID_USAGE_KEYBOARD_KEYPAD_LEFT_BRACE ((USAGE) 0x00B8) +#define HID_USAGE_KEYBOARD_KEYPAD_RIGHT_BRACE ((USAGE) 0x00B9) +#define HID_USAGE_KEYBOARD_KEYPAD_TAB ((USAGE) 0x00BA) +#define HID_USAGE_KEYBOARD_KEYPAD_BACKSPACE ((USAGE) 0x00BB) +#define HID_USAGE_KEYBOARD_KEYPAD_A ((USAGE) 0x00BC) +#define HID_USAGE_KEYBOARD_KEYPAD_B ((USAGE) 0x00BD) +#define HID_USAGE_KEYBOARD_KEYPAD_C ((USAGE) 0x00BE) +#define HID_USAGE_KEYBOARD_KEYPAD_D ((USAGE) 0x00BF) +#define HID_USAGE_KEYBOARD_KEYPAD_E ((USAGE) 0x00C0) +#define HID_USAGE_KEYBOARD_KEYPAD_F ((USAGE) 0x00C1) +#define HID_USAGE_KEYBOARD_KEYPAD_XOR ((USAGE) 0x00C2) +#define HID_USAGE_KEYBOARD_KEYPAD_CARET ((USAGE) 0x00C3) +#define HID_USAGE_KEYBOARD_KEYPAD_PERCENTAGE ((USAGE) 0x00C4) +#define HID_USAGE_KEYBOARD_KEYPAD_LESS ((USAGE) 0x00C5) +#define HID_USAGE_KEYBOARD_KEYPAD_GREATER ((USAGE) 0x00C6) +#define HID_USAGE_KEYBOARD_KEYPAD_AMPERSAND ((USAGE) 0x00C7) +#define HID_USAGE_KEYBOARD_KEYPAD_DOUBLE_AMPERSAND ((USAGE) 0x00C8) +#define HID_USAGE_KEYBOARD_KEYPAD_BAR ((USAGE) 0x00C9) +#define HID_USAGE_KEYBOARD_KEYPAD_DOUBLE_BAR ((USAGE) 0x00CA) +#define HID_USAGE_KEYBOARD_KEYPAD_COLON ((USAGE) 0x00CB) +#define HID_USAGE_KEYBOARD_KEYPAD_HASH ((USAGE) 0x00CC) +#define HID_USAGE_KEYBOARD_KEYPAD_SPACE ((USAGE) 0x00CD) +#define HID_USAGE_KEYBOARD_KEYPAD_AT ((USAGE) 0x00CE) +#define HID_USAGE_KEYBOARD_KEYPAD_BANG ((USAGE) 0x00CF) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_STORE ((USAGE) 0x00D0) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_RECALL ((USAGE) 0x00D1) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_CLEAR ((USAGE) 0x00D2) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_ADD ((USAGE) 0x00D3) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_SUBTRACT ((USAGE) 0x00D4) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_MULTIPLY ((USAGE) 0x00D5) +#define HID_USAGE_KEYBOARD_KEYPAD_MEMORY_DIVIDE ((USAGE) 0x00D6) +#define HID_USAGE_KEYBOARD_KEYPAD_PLUS_MINUS ((USAGE) 0x00D7) +#define HID_USAGE_KEYBOARD_KEYPAD_CLEAR ((USAGE) 0x00D8) +#define HID_USAGE_KEYBOARD_KEYPAD_CLEAR_ENTRY ((USAGE) 0x00D9) +#define HID_USAGE_KEYBOARD_KEYPAD_BINARY ((USAGE) 0x00DA) +#define HID_USAGE_KEYBOARD_KEYPAD_OCTAL ((USAGE) 0x00DB) +#define HID_USAGE_KEYBOARD_KEYPAD_DECIMAL ((USAGE) 0x00DC) +#define HID_USAGE_KEYBOARD_KEYPAD_HEXADECIMAL ((USAGE) 0x00DD) +#define HID_USAGE_KEYBOARD_LCTRL ((USAGE) 0x00E0) +#define HID_USAGE_KEYBOARD_LSHFT ((USAGE) 0x00E1) +#define HID_USAGE_KEYBOARD_LALT ((USAGE) 0x00E2) +#define HID_USAGE_KEYBOARD_LGUI ((USAGE) 0x00E3) +#define HID_USAGE_KEYBOARD_RCTRL ((USAGE) 0x00E4) +#define HID_USAGE_KEYBOARD_RSHFT ((USAGE) 0x00E5) +#define HID_USAGE_KEYBOARD_RALT ((USAGE) 0x00E6) +#define HID_USAGE_KEYBOARD_RGUI ((USAGE) 0x00E7) + +// +// LED Page (0x08) +// +#define HID_USAGE_LED_NUM_LOCK ((USAGE) 0x0001) +#define HID_USAGE_LED_CAPS_LOCK ((USAGE) 0x0002) +#define HID_USAGE_LED_SCROLL_LOCK ((USAGE) 0x0003) +#define HID_USAGE_LED_COMPOSE ((USAGE) 0x0004) +#define HID_USAGE_LED_KANA ((USAGE) 0x0005) +#define HID_USAGE_LED_POWER ((USAGE) 0x0006) +#define HID_USAGE_LED_SHIFT ((USAGE) 0x0007) +#define HID_USAGE_LED_DO_NOT_DISTURB ((USAGE) 0x0008) +#define HID_USAGE_LED_MUTE ((USAGE) 0x0009) +#define HID_USAGE_LED_TONE_ENABLE ((USAGE) 0x000A) +#define HID_USAGE_LED_HIGH_CUT_FILTER ((USAGE) 0x000B) +#define HID_USAGE_LED_LOW_CUT_FILTER ((USAGE) 0x000C) +#define HID_USAGE_LED_EQUALIZER_ENABLE ((USAGE) 0x000D) +#define HID_USAGE_LED_SOUND_FIELD_ON ((USAGE) 0x000E) +#define HID_USAGE_LED_SURROUND_FIELD_ON ((USAGE) 0x000F) +#define HID_USAGE_LED_REPEAT ((USAGE) 0x0010) +#define HID_USAGE_LED_STEREO ((USAGE) 0x0011) +#define HID_USAGE_LED_SAMPLING_RATE_DETECT ((USAGE) 0x0012) +#define HID_USAGE_LED_SPINNING ((USAGE) 0x0013) +#define HID_USAGE_LED_CAV ((USAGE) 0x0014) +#define HID_USAGE_LED_CLV ((USAGE) 0x0015) +#define HID_USAGE_LED_RECORDING_FORMAT_DET ((USAGE) 0x0016) +#define HID_USAGE_LED_OFF_HOOK ((USAGE) 0x0017) +#define HID_USAGE_LED_RING ((USAGE) 0x0018) +#define HID_USAGE_LED_MESSAGE_WAITING ((USAGE) 0x0019) +#define HID_USAGE_LED_DATA_MODE ((USAGE) 0x001A) +#define HID_USAGE_LED_BATTERY_OPERATION ((USAGE) 0x001B) +#define HID_USAGE_LED_BATTERY_OK ((USAGE) 0x001C) +#define HID_USAGE_LED_BATTERY_LOW ((USAGE) 0x001D) +#define HID_USAGE_LED_SPEAKER ((USAGE) 0x001E) +#define HID_USAGE_LED_HEAD_SET ((USAGE) 0x001F) +#define HID_USAGE_LED_HOLD ((USAGE) 0x0020) +#define HID_USAGE_LED_MICROPHONE ((USAGE) 0x0021) +#define HID_USAGE_LED_COVERAGE ((USAGE) 0x0022) +#define HID_USAGE_LED_NIGHT_MODE ((USAGE) 0x0023) +#define HID_USAGE_LED_SEND_CALLS ((USAGE) 0x0024) +#define HID_USAGE_LED_CALL_PICKUP ((USAGE) 0x0025) +#define HID_USAGE_LED_CONFERENCE ((USAGE) 0x0026) +#define HID_USAGE_LED_STAND_BY ((USAGE) 0x0027) +#define HID_USAGE_LED_CAMERA_ON ((USAGE) 0x0028) +#define HID_USAGE_LED_CAMERA_OFF ((USAGE) 0x0029) +#define HID_USAGE_LED_ON_LINE ((USAGE) 0x002A) +#define HID_USAGE_LED_OFF_LINE ((USAGE) 0x002B) +#define HID_USAGE_LED_BUSY ((USAGE) 0x002C) +#define HID_USAGE_LED_READY ((USAGE) 0x002D) +#define HID_USAGE_LED_PAPER_OUT ((USAGE) 0x002E) +#define HID_USAGE_LED_PAPER_JAM ((USAGE) 0x002F) +#define HID_USAGE_LED_REMOTE ((USAGE) 0x0030) +#define HID_USAGE_LED_FORWARD ((USAGE) 0x0031) +#define HID_USAGE_LED_REVERSE ((USAGE) 0x0032) +#define HID_USAGE_LED_STOP ((USAGE) 0x0033) +#define HID_USAGE_LED_REWIND ((USAGE) 0x0034) +#define HID_USAGE_LED_FAST_FORWARD ((USAGE) 0x0035) +#define HID_USAGE_LED_PLAY ((USAGE) 0x0036) +#define HID_USAGE_LED_PAUSE ((USAGE) 0x0037) +#define HID_USAGE_LED_RECORD ((USAGE) 0x0038) +#define HID_USAGE_LED_ERROR ((USAGE) 0x0039) +#define HID_USAGE_LED_SELECTED_INDICATOR ((USAGE) 0x003A) +#define HID_USAGE_LED_IN_USE_INDICATOR ((USAGE) 0x003B) +#define HID_USAGE_LED_MULTI_MODE_INDICATOR ((USAGE) 0x003C) +#define HID_USAGE_LED_INDICATOR_ON ((USAGE) 0x003D) +#define HID_USAGE_LED_INDICATOR_FLASH ((USAGE) 0x003E) +#define HID_USAGE_LED_INDICATOR_SLOW_BLINK ((USAGE) 0x003F) +#define HID_USAGE_LED_INDICATOR_FAST_BLINK ((USAGE) 0x0040) +#define HID_USAGE_LED_INDICATOR_OFF ((USAGE) 0x0041) +#define HID_USAGE_LED_FLASH_ON_TIME ((USAGE) 0x0042) +#define HID_USAGE_LED_SLOW_BLINK_ON_TIME ((USAGE) 0x0043) +#define HID_USAGE_LED_SLOW_BLINK_OFF_TIME ((USAGE) 0x0044) +#define HID_USAGE_LED_FAST_BLINK_ON_TIME ((USAGE) 0x0045) +#define HID_USAGE_LED_FAST_BLINK_OFF_TIME ((USAGE) 0x0046) +#define HID_USAGE_LED_INDICATOR_COLOR ((USAGE) 0x0047) +#define HID_USAGE_LED_RED ((USAGE) 0x0048) +#define HID_USAGE_LED_GREEN ((USAGE) 0x0049) +#define HID_USAGE_LED_AMBER ((USAGE) 0x004A) +#define HID_USAGE_LED_GENERIC_INDICATOR ((USAGE) 0x004B) +#define HID_USAGE_LED_SYSTEM_SUSPEND ((USAGE) 0x004C) +#define HID_USAGE_LED_EXTERNAL_POWER ((USAGE) 0x004D) +#define HID_USAGE_LED_INDICATOR_BLUE ((USAGE) 0x004E) +#define HID_USAGE_LED_INDICATOR_ORANGE ((USAGE) 0x004F) +#define HID_USAGE_LED_GOOD_STATUS ((USAGE) 0x0050) +#define HID_USAGE_LED_WARNING_STATUS ((USAGE) 0x0051) +#define HID_USAGE_LED_RGB_LED ((USAGE) 0x0052) +#define HID_USAGE_LED_RED_LED_CHANNEL ((USAGE) 0x0053) +#define HID_USAGE_LED_BLUE_LED_CHANNEL ((USAGE) 0x0054) +#define HID_USAGE_LED_GREEN_LED_CHANNEL ((USAGE) 0x0055) +#define HID_USAGE_LED_LED_INTENSITY ((USAGE) 0x0056) +#define HID_USAGE_LED_SYSTEM_MICROPHONE_MUTE ((USAGE) 0x0057) +#define HID_USAGE_LED_PLAYER_INDICATOR ((USAGE) 0x0060) +#define HID_USAGE_LED_PLAYER_1 ((USAGE) 0x0061) +#define HID_USAGE_LED_PLAYER_2 ((USAGE) 0x0062) +#define HID_USAGE_LED_PLAYER_3 ((USAGE) 0x0063) +#define HID_USAGE_LED_PLAYER_4 ((USAGE) 0x0064) +#define HID_USAGE_LED_PLAYER_5 ((USAGE) 0x0065) +#define HID_USAGE_LED_PLAYER_6 ((USAGE) 0x0066) +#define HID_USAGE_LED_PLAYER_7 ((USAGE) 0x0067) +#define HID_USAGE_LED_PLAYER_8 ((USAGE) 0x0068) + +// +// Lighting And Illumination Page (0x59) +// +#define HID_USAGE_LAMPARRAY ((USAGE) 0x0001) +#define HID_USAGE_LAMPARRAY_ATTRBIUTES_REPORT ((USAGE) 0x0002) +#define HID_USAGE_LAMPARRAY_LAMP_COUNT ((USAGE) 0x0003) +#define HID_USAGE_LAMPARRAY_BOUNDING_BOX_WIDTH_IN_MICROMETERS ((USAGE) 0x0004) +#define HID_USAGE_LAMPARRAY_BOUNDING_BOX_HEIGHT_IN_MICROMETERS ((USAGE) 0x0005) +#define HID_USAGE_LAMPARRAY_BOUNDING_BOX_DEPTH_IN_MICROMETERS ((USAGE) 0x0006) +#define HID_USAGE_LAMPARRAY_KIND ((USAGE) 0x0007) +#define HID_USAGE_LAMPARRAY_MIN_UPDATE_INTERVAL_IN_MICROSECONDS ((USAGE) 0x0008) +#define HID_USAGE_LAMPARRAY_LAMP_ATTRIBUTES_REQUEST_REPORT ((USAGE) 0x0020) +#define HID_USAGE_LAMPARRAY_LAMP_ID ((USAGE) 0x0021) +#define HID_USAGE_LAMPARRAY_LAMP_ATTRIBUTES_RESPONSE_REPORT ((USAGE) 0x0022) +#define HID_USAGE_LAMPARRAY_POSITION_X_IN_MICROMETERS ((USAGE) 0x0023) +#define HID_USAGE_LAMPARRAY_POSITION_Y_IN_MICROMETERS ((USAGE) 0x0024) +#define HID_USAGE_LAMPARRAY_POSITION_Z_IN_MICROMETERS ((USAGE) 0x0025) +#define HID_USAGE_LAMPARRAY_LAMP_PURPOSES ((USAGE) 0x0026) +#define HID_USAGE_LAMPARRAY_UPDATE_LATENCY_IN_MICROSECONDS ((USAGE) 0x0027) +#define HID_USAGE_LAMPARRAY_RED_LEVEL_COUNT ((USAGE) 0x0028) +#define HID_USAGE_LAMPARRAY_GREEN_LEVEL_COUNT ((USAGE) 0x0029) +#define HID_USAGE_LAMPARRAY_BLUE_LEVEL_COUNT ((USAGE) 0x002A) +#define HID_USAGE_LAMPARRAY_INTENSITY_LEVEL_COUNT ((USAGE) 0x002B) +#define HID_USAGE_LAMPARRAY_IS_PROGRAMMABLE ((USAGE) 0x002C) +#define HID_USAGE_LAMPARRAY_INPUT_BINDING ((USAGE) 0x002D) +#define HID_USAGE_LAMPARRAY_LAMP_MULTI_UPDATE_REPORT ((USAGE) 0x0050) +#define HID_USAGE_LAMPARRAY_LAMP_RED_UPDATE_CHANNEL ((USAGE) 0x0051) +#define HID_USAGE_LAMPARRAY_LAMP_GREEN_UPDATE_CHANNEL ((USAGE) 0x0052) +#define HID_USAGE_LAMPARRAY_LAMP_BLUE_UPDATE_CHANNEL ((USAGE) 0x0053) +#define HID_USAGE_LAMPARRAY_LAMP_INTENSITY_UPDATE_CHANNEL ((USAGE) 0x0054) +#define HID_USAGE_LAMPARRAY_LAMP_UPDATE_FLAGS ((USAGE) 0x0055) +#define HID_USAGE_LAMPARRAY_LAMP_RANGE_UPDATE_REPORT ((USAGE) 0x0060) +#define HID_USAGE_LAMPARRAY_LAMP_ID_START ((USAGE) 0x0061) +#define HID_USAGE_LAMPARRAY_LAMP_ID_END ((USAGE) 0x0062) +#define HID_USAGE_LAMPARRAY_CONTROL_REPORT ((USAGE) 0x0070) +#define HID_USAGE_LAMPARRAY_AUTONOMOUS_MODE ((USAGE) 0x0071) + +// +// Magnetic Stripe Reader Page (0x8E) +// +#define HID_USAGE_MAGNETIC_STRIPE_READER_MSR_DEVICE_READONLY ((USAGE) 0x0001) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_1_LENGTH ((USAGE) 0x0011) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_2_LENGTH ((USAGE) 0x0012) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_3_LENGTH ((USAGE) 0x0013) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_JIS_LENGTH ((USAGE) 0x0014) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_DATA ((USAGE) 0x0020) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_1_DATA ((USAGE) 0x0021) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_2_DATA ((USAGE) 0x0022) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_3_DATA ((USAGE) 0x0023) +#define HID_USAGE_MAGNETIC_STRIPE_READER_TRACK_JIS_DATA ((USAGE) 0x0024) + +// +// Medical Instrument Page (0x40) +// +#define HID_USAGE_MEDICAL_INSTRUMENT_MEDICAL_ULTRASOUND ((USAGE) 0x0001) +#define HID_USAGE_MEDICAL_INSTRUMENT_VCRACQUISITION ((USAGE) 0x0020) +#define HID_USAGE_MEDICAL_INSTRUMENT_FREEZETHAW ((USAGE) 0x0021) +#define HID_USAGE_MEDICAL_INSTRUMENT_CLIP_STORE ((USAGE) 0x0022) +#define HID_USAGE_MEDICAL_INSTRUMENT_UPDATE ((USAGE) 0x0023) +#define HID_USAGE_MEDICAL_INSTRUMENT_NEXT ((USAGE) 0x0024) +#define HID_USAGE_MEDICAL_INSTRUMENT_SAVE ((USAGE) 0x0025) +#define HID_USAGE_MEDICAL_INSTRUMENT_PRINT ((USAGE) 0x0026) +#define HID_USAGE_MEDICAL_INSTRUMENT_MICROPHONE_ENABLE ((USAGE) 0x0027) +#define HID_USAGE_MEDICAL_INSTRUMENT_CINE ((USAGE) 0x0040) +#define HID_USAGE_MEDICAL_INSTRUMENT_TRANSMIT_POWER ((USAGE) 0x0041) +#define HID_USAGE_MEDICAL_INSTRUMENT_VOLUME ((USAGE) 0x0042) +#define HID_USAGE_MEDICAL_INSTRUMENT_FOCUS ((USAGE) 0x0043) +#define HID_USAGE_MEDICAL_INSTRUMENT_DEPTH ((USAGE) 0x0044) +#define HID_USAGE_MEDICAL_INSTRUMENT_SOFT_STEP__PRIMARY ((USAGE) 0x0060) +#define HID_USAGE_MEDICAL_INSTRUMENT_SOFT_STEP__SECONDARY ((USAGE) 0x0061) +#define HID_USAGE_MEDICAL_INSTRUMENT_DEPTH_GAIN_COMPENSATION ((USAGE) 0x0070) +#define HID_USAGE_MEDICAL_INSTRUMENT_ZOOM_SELECT ((USAGE) 0x0080) +#define HID_USAGE_MEDICAL_INSTRUMENT_ZOOM_ADJUST ((USAGE) 0x0081) +#define HID_USAGE_MEDICAL_INSTRUMENT_SPECTRAL_DOPPLER_MODE_SELECT ((USAGE) 0x0082) +#define HID_USAGE_MEDICAL_INSTRUMENT_SPECTRAL_DOPPLER_ADJUST ((USAGE) 0x0083) +#define HID_USAGE_MEDICAL_INSTRUMENT_COLOR_DOPPLER_MODE_SELECT ((USAGE) 0x0084) +#define HID_USAGE_MEDICAL_INSTRUMENT_COLOR_DOPPLER_ADJUST ((USAGE) 0x0085) +#define HID_USAGE_MEDICAL_INSTRUMENT_MOTION_MODE_SELECT ((USAGE) 0x0086) +#define HID_USAGE_MEDICAL_INSTRUMENT_MOTION_MODE_ADJUST ((USAGE) 0x0087) +#define HID_USAGE_MEDICAL_INSTRUMENT_2D_MODE_SELECT ((USAGE) 0x0088) +#define HID_USAGE_MEDICAL_INSTRUMENT_2D_MODE_ADJUST ((USAGE) 0x0089) +#define HID_USAGE_MEDICAL_INSTRUMENT_SOFT_CONTROL_SELECT ((USAGE) 0x00A0) +#define HID_USAGE_MEDICAL_INSTRUMENT_SOFT_CONTROL_ADJUST ((USAGE) 0x00A1) + +// +// Microsoft Bluetooth Handsfree Page (0xFFF3) +// +#define HID_USAGE_MICROSOFT_BLUETOOTH_HANDSFREE_GENERAL ((USAGE) 0x0001) +#define HID_USAGE_MICROSOFT_BLUETOOTH_HANDSFREE_DIAL_NUMBER ((USAGE) 0x0021) +#define HID_USAGE_MICROSOFT_BLUETOOTH_HANDSFREE_DIAL_MEMORY ((USAGE) 0x0022) +#define HID_USAGE_MICROSOFT_BLUETOOTH_HANDSFREE_CALL_SETUP ((USAGE) 0x0024) + +// +// Monitor Page (0x80) +// +#define HID_USAGE_MONITOR_MONITOR_CONTROL ((USAGE) 0x0001) +#define HID_USAGE_MONITOR_EDID_INFORMATION ((USAGE) 0x0002) +#define HID_USAGE_MONITOR_VDIF_INFORMATION ((USAGE) 0x0003) +#define HID_USAGE_MONITOR_VESA_VERSION ((USAGE) 0x0004) + +// +// Monitor Enumerated Page (0x81) +// +// There is no need to label these usages. +// + +// +// Ordinal Page (0x0A) +// +// There is no need to label these usages. +// + +// +// Physical Input Device Page (0x0F) +// +#define HID_USAGE_PID_PHYSICAL_INPUT_DEVICE ((USAGE) 0x0001) +#define HID_USAGE_PID_NORMAL ((USAGE) 0x0020) +#define HID_USAGE_PID_SET_EFFECT_REPORT ((USAGE) 0x0021) +#define HID_USAGE_PID_EFFECT_BLOCK_INDEX ((USAGE) 0x0022) +#define HID_USAGE_PID_PARAMETER_BLOCK_OFFSET ((USAGE) 0x0023) +#define HID_USAGE_PID_ROM_FLAG ((USAGE) 0x0024) +#define HID_USAGE_PID_EFFECT_TYPE ((USAGE) 0x0025) +#define HID_USAGE_PID_ET_CONSTANT ((USAGE) 0x0026) +#define HID_USAGE_PID_ET_RAMP ((USAGE) 0x0027) +#define HID_USAGE_PID_ET_CUSTOM ((USAGE) 0x0028) +#define HID_USAGE_PID_ET_SQUARE ((USAGE) 0x0030) +#define HID_USAGE_PID_ET_SINE ((USAGE) 0x0031) +#define HID_USAGE_PID_ET_TRIANGLE ((USAGE) 0x0032) +#define HID_USAGE_PID_ET_SAWTOOTH_UP ((USAGE) 0x0033) +#define HID_USAGE_PID_ET_SAWTOOTH_DOWN ((USAGE) 0x0034) +#define HID_USAGE_PID_ET_SPRING ((USAGE) 0x0040) +#define HID_USAGE_PID_ET_DAMPER ((USAGE) 0x0041) +#define HID_USAGE_PID_ET_INERTIA ((USAGE) 0x0042) +#define HID_USAGE_PID_ET_FRICTION ((USAGE) 0x0043) +#define HID_USAGE_PID_DURATION ((USAGE) 0x0050) +#define HID_USAGE_PID_SAMPLE_PERIOD ((USAGE) 0x0051) +#define HID_USAGE_PID_GAIN ((USAGE) 0x0052) +#define HID_USAGE_PID_TRIGGER_BUTTON ((USAGE) 0x0053) +#define HID_USAGE_PID_TRIGGER_REPEAT_INTERVAL ((USAGE) 0x0054) +#define HID_USAGE_PID_AXES_ENABLE ((USAGE) 0x0055) +#define HID_USAGE_PID_DIRECTION_ENABLE ((USAGE) 0x0056) +#define HID_USAGE_PID_DIRECTION ((USAGE) 0x0057) +#define HID_USAGE_PID_TYPE_SPECIFIC_BLOCK_OFFSET ((USAGE) 0x0058) +#define HID_USAGE_PID_BLOCK_TYPE ((USAGE) 0x0059) +#define HID_USAGE_PID_SET_ENVELOPE_REPORT ((USAGE) 0x005A) +#define HID_USAGE_PID_ATTACK_LEVEL ((USAGE) 0x005B) +#define HID_USAGE_PID_ATTACK_TIME ((USAGE) 0x005C) +#define HID_USAGE_PID_FADE_LEVEL ((USAGE) 0x005D) +#define HID_USAGE_PID_FADE_TIME ((USAGE) 0x005E) +#define HID_USAGE_PID_SET_CONDITION_REPORT ((USAGE) 0x005F) +#define HID_USAGE_PID_CP_OFFSET ((USAGE) 0x0060) +#define HID_USAGE_PID_POSITIVE_COEFFICIENT ((USAGE) 0x0061) +#define HID_USAGE_PID_NEGATIVE_COEFFICIENT ((USAGE) 0x0062) +#define HID_USAGE_PID_POSITIVE_SATURATION ((USAGE) 0x0063) +#define HID_USAGE_PID_NEGATIVE_SATURATION ((USAGE) 0x0064) +#define HID_USAGE_PID_DEAD_BAND ((USAGE) 0x0065) +#define HID_USAGE_PID_DOWNLOAD_FORCE_SAMPLE ((USAGE) 0x0066) +#define HID_USAGE_PID_ISOCH_CUSTOMFORCE_ENABLE ((USAGE) 0x0067) +#define HID_USAGE_PID_CUSTOM_FORCE_DATA_REPORT ((USAGE) 0x0068) +#define HID_USAGE_PID_CUSTOM_FORCE_DATA ((USAGE) 0x0069) +#define HID_USAGE_PID_CUSTOM_FORCE_VENDOR_DEFINED_DATA ((USAGE) 0x006A) +#define HID_USAGE_PID_SET_CUSTOM_FORCE_REPORT ((USAGE) 0x006B) +#define HID_USAGE_PID_CUSTOM_FORCE_DATA_OFFSET ((USAGE) 0x006C) +#define HID_USAGE_PID_SAMPLE_COUNT ((USAGE) 0x006D) +#define HID_USAGE_PID_SET_PERIODIC_REPORT ((USAGE) 0x006E) +#define HID_USAGE_PID_OFFSET ((USAGE) 0x006F) +#define HID_USAGE_PID_MAGNITUDE ((USAGE) 0x0070) +#define HID_USAGE_PID_PHASE ((USAGE) 0x0071) +#define HID_USAGE_PID_PERIOD ((USAGE) 0x0072) +#define HID_USAGE_PID_SET_CONSTANT_FORCE_REPORT ((USAGE) 0x0073) +#define HID_USAGE_PID_SET_RAMP_FORCE_REPORT ((USAGE) 0x0074) +#define HID_USAGE_PID_RAMP_START ((USAGE) 0x0075) +#define HID_USAGE_PID_RAMP_END ((USAGE) 0x0076) +#define HID_USAGE_PID_EFFECT_OPERATION_REPORT ((USAGE) 0x0077) +#define HID_USAGE_PID_EFFECT_OPERATION ((USAGE) 0x0078) +#define HID_USAGE_PID_OP_EFFECT_START ((USAGE) 0x0079) +#define HID_USAGE_PID_OP_EFFECT_START_SOLO ((USAGE) 0x007A) +#define HID_USAGE_PID_OP_EFFECT_STOP ((USAGE) 0x007B) +#define HID_USAGE_PID_LOOP_COUNT ((USAGE) 0x007C) +#define HID_USAGE_PID_DEVICE_GAIN_REPORT ((USAGE) 0x007D) +#define HID_USAGE_PID_DEVICE_GAIN ((USAGE) 0x007E) +#define HID_USAGE_PID_POOL_REPORT ((USAGE) 0x007F) +#define HID_USAGE_PID_RAM_POOL_SIZE ((USAGE) 0x0080) +#define HID_USAGE_PID_ROM_POOL_SIZE ((USAGE) 0x0081) +#define HID_USAGE_PID_ROM_EFFECT_BLOCK_COUNT ((USAGE) 0x0082) +#define HID_USAGE_PID_SIMULTANEOUS_EFFECTS_MAX ((USAGE) 0x0083) +#define HID_USAGE_PID_POOL_ALIGNMENT ((USAGE) 0x0084) +#define HID_USAGE_PID_PARAMETER_BLOCK_MOVE_REPORT ((USAGE) 0x0085) +#define HID_USAGE_PID_MOVE_SOURCE ((USAGE) 0x0086) +#define HID_USAGE_PID_MOVE_DESTINATION ((USAGE) 0x0087) +#define HID_USAGE_PID_MOVE_LENGTH ((USAGE) 0x0088) +#define HID_USAGE_PID_BLOCK_LOAD_REPORT ((USAGE) 0x0089) +#define HID_USAGE_PID_BLOCK_LOAD_STATUS ((USAGE) 0x008B) +#define HID_USAGE_PID_BLOCK_LOAD_SUCCESS ((USAGE) 0x008C) +#define HID_USAGE_PID_BLOCK_LOAD_FULL ((USAGE) 0x008D) +#define HID_USAGE_PID_BLOCK_LOAD_ERROR ((USAGE) 0x008E) +#define HID_USAGE_PID_BLOCK_HANDLE ((USAGE) 0x008F) +#define HID_USAGE_PID_BLOCK_FREE_REPORT ((USAGE) 0x0090) +#define HID_USAGE_PID_TYPE_SPECIFIC_BLOCK_HANDLE ((USAGE) 0x0091) +#define HID_USAGE_PID_STATE_REPORT ((USAGE) 0x0092) +#define HID_USAGE_PID_EFFECT_PLAYING ((USAGE) 0x0094) +#define HID_USAGE_PID_PID_DEVICE_CONTROL_REPORT ((USAGE) 0x0095) +#define HID_USAGE_PID_DEVICE_CONTROL ((USAGE) 0x0096) +#define HID_USAGE_PID_DC_ENABLE_ACTUATORS ((USAGE) 0x0097) +#define HID_USAGE_PID_DC_DISABLE_ACTUATORS ((USAGE) 0x0098) +#define HID_USAGE_PID_DC_STOP_ALL_EFFECTS ((USAGE) 0x0099) +#define HID_USAGE_PID_DC_DEVICE_RESET ((USAGE) 0x009A) +#define HID_USAGE_PID_DC_DEVICE_PAUSE ((USAGE) 0x009B) +#define HID_USAGE_PID_DC_DEVICE_CONTINUE ((USAGE) 0x009C) +#define HID_USAGE_PID_DEVICE_PAUSED ((USAGE) 0x009F) +#define HID_USAGE_PID_ACTUATORS_ENABLED ((USAGE) 0x00A0) +#define HID_USAGE_PID_SAFETY_SWITCH ((USAGE) 0x00A4) +#define HID_USAGE_PID_ACTUATOR_OVERRIDE_SWITCH ((USAGE) 0x00A5) +#define HID_USAGE_PID_ACTUATOR_POWER ((USAGE) 0x00A6) +#define HID_USAGE_PID_START_DELAY ((USAGE) 0x00A7) +#define HID_USAGE_PID_PARAMETER_BLOCK_SIZE ((USAGE) 0x00A8) +#define HID_USAGE_PID_DEVICE_MANAGED_POOL ((USAGE) 0x00A9) +#define HID_USAGE_PID_SHARED_PARAMETER_BLOCKS ((USAGE) 0x00AA) +#define HID_USAGE_PID_CREATE_NEW_EFFECT ((USAGE) 0x00AB) +#define HID_USAGE_PID_RAMPOOL_AVAILABLE ((USAGE) 0x00AC) + +// +// Power Page (0x84) +// +#define HID_USAGE_POWER_INAME ((USAGE) 0x0001) +#define HID_USAGE_POWER_PRESENT_STATUS ((USAGE) 0x0002) +#define HID_USAGE_POWER_CHANGED_STATUS ((USAGE) 0x0003) +#define HID_USAGE_POWER_UPS ((USAGE) 0x0004) +#define HID_USAGE_POWER_POWER_SUPPLY ((USAGE) 0x0005) +#define HID_USAGE_POWER_BATTERY_SYSTEM ((USAGE) 0x0010) +#define HID_USAGE_POWER_BATTERY_SYSTEM_ID ((USAGE) 0x0011) +#define HID_USAGE_POWER_BATTERY ((USAGE) 0x0012) +#define HID_USAGE_POWER_BATTERY_ID ((USAGE) 0x0013) +#define HID_USAGE_POWER_CHARGER ((USAGE) 0x0014) +#define HID_USAGE_POWER_CHARGER_ID ((USAGE) 0x0015) +#define HID_USAGE_POWER_POWER_CONVERTER ((USAGE) 0x0016) +#define HID_USAGE_POWER_POWER_CONVERTER_ID ((USAGE) 0x0017) +#define HID_USAGE_POWER_OUTLET_SYSTEM ((USAGE) 0x0018) +#define HID_USAGE_POWER_OUTLET_SYSTEM_ID ((USAGE) 0x0019) +#define HID_USAGE_POWER_INPUT ((USAGE) 0x001A) +#define HID_USAGE_POWER_INPUT_ID ((USAGE) 0x001B) +#define HID_USAGE_POWER_OUTPUT ((USAGE) 0x001C) +#define HID_USAGE_POWER_OUTPUT_ID ((USAGE) 0x001D) +#define HID_USAGE_POWER_FLOW ((USAGE) 0x001E) +#define HID_USAGE_POWER_FLOW_ID ((USAGE) 0x001F) +#define HID_USAGE_POWER_OUTLET ((USAGE) 0x0020) +#define HID_USAGE_POWER_OUTLET_ID ((USAGE) 0x0021) +#define HID_USAGE_POWER_GANG ((USAGE) 0x0022) +#define HID_USAGE_POWER_GANG_ID ((USAGE) 0x0023) +#define HID_USAGE_POWER_POWER_SUMMARY ((USAGE) 0x0024) +#define HID_USAGE_POWER_POWER_SUMMARY_ID ((USAGE) 0x0025) +#define HID_USAGE_POWER_VOLTAGE ((USAGE) 0x0030) +#define HID_USAGE_POWER_CURRENT ((USAGE) 0x0031) +#define HID_USAGE_POWER_FREQUENCY ((USAGE) 0x0032) +#define HID_USAGE_POWER_APPARENT_POWER ((USAGE) 0x0033) +#define HID_USAGE_POWER_ACTIVE_POWER ((USAGE) 0x0034) +#define HID_USAGE_POWER_PERCENT_LOAD ((USAGE) 0x0035) +#define HID_USAGE_POWER_TEMPERATURE ((USAGE) 0x0036) +#define HID_USAGE_POWER_HUMIDITY ((USAGE) 0x0037) +#define HID_USAGE_POWER_BAD_COUNT ((USAGE) 0x0038) +#define HID_USAGE_POWER_CONFIG_VOLTAGE ((USAGE) 0x0040) +#define HID_USAGE_POWER_CONFIG_CURRENT ((USAGE) 0x0041) +#define HID_USAGE_POWER_CONFIG_FREQUENCY ((USAGE) 0x0042) +#define HID_USAGE_POWER_CONFIG_APPARENT_POWER ((USAGE) 0x0043) +#define HID_USAGE_POWER_CONFIG_ACTIVE_POWER ((USAGE) 0x0044) +#define HID_USAGE_POWER_CONFIG_PERCENT_LOAD ((USAGE) 0x0045) +#define HID_USAGE_POWER_CONFIG_TEMPERATURE ((USAGE) 0x0046) +#define HID_USAGE_POWER_CONFIG_HUMIDITY ((USAGE) 0x0047) +#define HID_USAGE_POWER_SWITCH_ON_CONTROL ((USAGE) 0x0050) +#define HID_USAGE_POWER_SWITCH_OFF_CONTROL ((USAGE) 0x0051) +#define HID_USAGE_POWER_TOGGLE_CONTROL ((USAGE) 0x0052) +#define HID_USAGE_POWER_LOW_VOLTAGE_TRANSFER ((USAGE) 0x0053) +#define HID_USAGE_POWER_HIGH_VOLTAGE_TRANSFER ((USAGE) 0x0054) +#define HID_USAGE_POWER_DELAY_BEFORE_REBOOT ((USAGE) 0x0055) +#define HID_USAGE_POWER_DELAY_BEFORE_STARTUP ((USAGE) 0x0056) +#define HID_USAGE_POWER_DELAY_BEFORE_SHUTDOWN ((USAGE) 0x0057) +#define HID_USAGE_POWER_TEST ((USAGE) 0x0058) +#define HID_USAGE_POWER_MODULE_RESET ((USAGE) 0x0059) +#define HID_USAGE_POWER_AUDIBLE_ALARM_CONTROL ((USAGE) 0x005A) +#define HID_USAGE_POWER_PRESENT ((USAGE) 0x0060) +#define HID_USAGE_POWER_GOOD ((USAGE) 0x0061) +#define HID_USAGE_POWER_INTERNAL_FAILURE ((USAGE) 0x0062) +#define HID_USAGE_POWER_VOLTAG_OUT_OF_RANGE ((USAGE) 0x0063) +#define HID_USAGE_POWER_FREQUENCY_OUT_OF_RANGE ((USAGE) 0x0064) +#define HID_USAGE_POWER_OVERLOAD ((USAGE) 0x0065) +#define HID_USAGE_POWER_OVER_CHARGED ((USAGE) 0x0066) +#define HID_USAGE_POWER_OVER_TEMPERATURE ((USAGE) 0x0067) +#define HID_USAGE_POWER_SHUTDOWN_REQUESTED ((USAGE) 0x0068) +#define HID_USAGE_POWER_SHUTDOWN_IMMINENT ((USAGE) 0x0069) +#define HID_USAGE_POWER_SWITCH_ONOFF ((USAGE) 0x006B) +#define HID_USAGE_POWER_SWITCHABLE ((USAGE) 0x006C) +#define HID_USAGE_POWER_USED ((USAGE) 0x006D) +#define HID_USAGE_POWER_BOOST ((USAGE) 0x006E) +#define HID_USAGE_POWER_BUCK ((USAGE) 0x006F) +#define HID_USAGE_POWER_INITIALIZED ((USAGE) 0x0070) +#define HID_USAGE_POWER_TESTED ((USAGE) 0x0071) +#define HID_USAGE_POWER_AWAITING_POWER ((USAGE) 0x0072) +#define HID_USAGE_POWER_COMMUNICATION_LOST ((USAGE) 0x0073) +#define HID_USAGE_POWER_IMANUFACTURER ((USAGE) 0x00FD) +#define HID_USAGE_POWER_IPRODUCT ((USAGE) 0x00FE) +#define HID_USAGE_POWER_ISERIALNUMBER ((USAGE) 0x00FF) + +// +// Scales Page (0x8D) +// +#define HID_USAGE_WEIGHING_DEVICE_SCALES ((USAGE) 0x0001) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_DEVICE ((USAGE) 0x0020) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS ((USAGE) 0x0021) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_I_METRIC ((USAGE) 0x0022) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_II_METRIC ((USAGE) 0x0023) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_III_METRIC ((USAGE) 0x0024) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_IIIL_METRIC ((USAGE) 0x0025) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_IV_METRIC ((USAGE) 0x0026) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_III_ENGLISH ((USAGE) 0x0027) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_IIIL_ENGLISH ((USAGE) 0x0028) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_IV_ENGLISH ((USAGE) 0x0029) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CLASS_GENERIC ((USAGE) 0x002A) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_ATTRIBUTE_REPORT ((USAGE) 0x0030) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_CONTROL_REPORT ((USAGE) 0x0031) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_DATA_REPORT ((USAGE) 0x0032) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_REPORT ((USAGE) 0x0033) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_WEIGHT_LIMIT_REPORT ((USAGE) 0x0034) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATISTICS_REPORT ((USAGE) 0x0035) +#define HID_USAGE_WEIGHING_DEVICE_DATA_WEIGHT ((USAGE) 0x0040) +#define HID_USAGE_WEIGHING_DEVICE_DATA_SCALING ((USAGE) 0x0041) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT ((USAGE) 0x0050) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_MILLIGRAM ((USAGE) 0x0051) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_GRAM ((USAGE) 0x0052) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_KILOGRAM ((USAGE) 0x0053) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_CARATS ((USAGE) 0x0054) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_TAELS ((USAGE) 0x0055) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_GRAINS ((USAGE) 0x0056) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_PENNYWEIGHTS ((USAGE) 0x0057) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_METRIC_TON ((USAGE) 0x0058) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_AVOIR_TON ((USAGE) 0x0059) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_TROY_OUNCE ((USAGE) 0x005A) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_OUNCE ((USAGE) 0x005B) +#define HID_USAGE_WEIGHING_DEVICE_WEIGHT_UNIT_POUND ((USAGE) 0x005C) +#define HID_USAGE_WEIGHING_DEVICE_CALIBRATION_COUNT ((USAGE) 0x0060) +#define HID_USAGE_WEIGHING_DEVICE_REZERO_COUNT ((USAGE) 0x0061) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS ((USAGE) 0x0070) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_FAULT ((USAGE) 0x0071) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_STABLE_AT_CENTER_OF_ZERO ((USAGE) 0x0072) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_IN_MOTION ((USAGE) 0x0073) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_WEIGHT_STABLE ((USAGE) 0x0074) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_UNDER_ZERO ((USAGE) 0x0075) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_OVER_WEIGHT_LIMIT ((USAGE) 0x0076) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_REQUIRES_CALIBRATION ((USAGE) 0x0077) +#define HID_USAGE_WEIGHING_DEVICE_SCALE_STATUS_REQUIRES_REZEROING ((USAGE) 0x0078) +#define HID_USAGE_WEIGHING_DEVICE_ZERO_SCALE ((USAGE) 0x0080) +#define HID_USAGE_WEIGHING_DEVICE_ENFORCED_ZERO_RETURN ((USAGE) 0x0081) + +// +// Sensors Page (0x20) +// +#define HID_USAGE_SENSORS_SENSOR ((USAGE) 0x0001) +#define HID_USAGE_SENSORS_BIOMETRIC ((USAGE) 0x0010) +#define HID_USAGE_SENSORS_BIOMETRIC_HUMAN_PRESENCE ((USAGE) 0x0011) +#define HID_USAGE_SENSORS_BIOMETRIC_HUMAN_PROXIMITY ((USAGE) 0x0012) +#define HID_USAGE_SENSORS_BIOMETRIC_HUMAN_TOUCH ((USAGE) 0x0013) +#define HID_USAGE_SENSORS_BIOMETRIC_BLOOD_PRESSURE ((USAGE) 0x0014) +#define HID_USAGE_SENSORS_BIOMETRIC_BODY_TEMPERATURE ((USAGE) 0x0015) +#define HID_USAGE_SENSORS_BIOMETRIC_HEART_RATE ((USAGE) 0x0016) +#define HID_USAGE_SENSORS_BIOMETRIC_HEART_RATE_VARIABILITY ((USAGE) 0x0017) +#define HID_USAGE_SENSORS_BIOMETRIC_PERIPHERAL_OXYGEN_SATURATION ((USAGE) 0x0018) +#define HID_USAGE_SENSORS_BIOMETRIC_RESPIRATORY_RATE ((USAGE) 0x0019) +#define HID_USAGE_SENSORS_ELECTRICAL ((USAGE) 0x0020) +#define HID_USAGE_SENSORS_ELECTRICAL_CAPACITANCE ((USAGE) 0x0021) +#define HID_USAGE_SENSORS_ELECTRICAL_CURRENT ((USAGE) 0x0022) +#define HID_USAGE_SENSORS_ELECTRICAL_POWER ((USAGE) 0x0023) +#define HID_USAGE_SENSORS_ELECTRICAL_INDUCTANCE ((USAGE) 0x0024) +#define HID_USAGE_SENSORS_ELECTRICAL_RESISTANCE ((USAGE) 0x0025) +#define HID_USAGE_SENSORS_ELECTRICAL_VOLTAGE ((USAGE) 0x0026) +#define HID_USAGE_SENSORS_ELECTRICAL_POTENTIOMETER ((USAGE) 0x0027) +#define HID_USAGE_SENSORS_ELECTRICAL_FREQUENCY ((USAGE) 0x0028) +#define HID_USAGE_SENSORS_ELECTRICAL_PERIOD ((USAGE) 0x0029) +#define HID_USAGE_SENSORS_ENVIRONMENTAL ((USAGE) 0x0030) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_ATMOSPHERIC_PRESSURE ((USAGE) 0x0031) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_HUMIDITY ((USAGE) 0x0032) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_TEMPERATURE ((USAGE) 0x0033) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_WIND_DIRECTION ((USAGE) 0x0034) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_WIND_SPEED ((USAGE) 0x0035) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_AIR_QUALITY ((USAGE) 0x0036) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_HEAT_INDEX ((USAGE) 0x0037) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_SURFACE_TEMPERATURE ((USAGE) 0x0038) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_VOLATILE_ORGANIC_COMPOUNDS ((USAGE) 0x0039) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_OBJECT_PRESENCE ((USAGE) 0x003A) +#define HID_USAGE_SENSORS_ENVIRONMENTAL_OBJECT_PROXIMITY ((USAGE) 0x003B) +#define HID_USAGE_SENSORS_LIGHT ((USAGE) 0x0040) +#define HID_USAGE_SENSORS_LIGHT_AMBIENT_LIGHT ((USAGE) 0x0041) +#define HID_USAGE_SENSORS_LIGHT_CONSUMER_INFRARED ((USAGE) 0x0042) +#define HID_USAGE_SENSORS_LIGHT_INFRARED_LIGHT ((USAGE) 0x0043) +#define HID_USAGE_SENSORS_LIGHT_VISIBLE_LIGHT ((USAGE) 0x0044) +#define HID_USAGE_SENSORS_LIGHT_ULTRAVIOLET_LIGHT ((USAGE) 0x0045) +#define HID_USAGE_SENSORS_LOCATION ((USAGE) 0x0050) +#define HID_USAGE_SENSORS_LOCATION_BROADCAST ((USAGE) 0x0051) +#define HID_USAGE_SENSORS_LOCATION_DEAD_RECKONING ((USAGE) 0x0052) +#define HID_USAGE_SENSORS_LOCATION_GPS_GLOBAL_POSITIONING_SYSTEM ((USAGE) 0x0053) +#define HID_USAGE_SENSORS_LOCATION_LOOKUP ((USAGE) 0x0054) +#define HID_USAGE_SENSORS_LOCATION_OTHER ((USAGE) 0x0055) +#define HID_USAGE_SENSORS_LOCATION_STATIC ((USAGE) 0x0056) +#define HID_USAGE_SENSORS_LOCATION_TRIANGULATION ((USAGE) 0x0057) +#define HID_USAGE_SENSORS_MECHANICAL ((USAGE) 0x0060) +#define HID_USAGE_SENSORS_MECHANICAL_BOOLEAN_SWITCH ((USAGE) 0x0061) +#define HID_USAGE_SENSORS_MECHANICAL_BOOLEAN_SWITCH_ARRAY ((USAGE) 0x0062) +#define HID_USAGE_SENSORS_MECHANICAL_MULTIVALUE_SWITCH ((USAGE) 0x0063) +#define HID_USAGE_SENSORS_MECHANICAL_FORCE ((USAGE) 0x0064) +#define HID_USAGE_SENSORS_MECHANICAL_PRESSURE ((USAGE) 0x0065) +#define HID_USAGE_SENSORS_MECHANICAL_STRAIN ((USAGE) 0x0066) +#define HID_USAGE_SENSORS_MECHANICAL_WEIGHT ((USAGE) 0x0067) +#define HID_USAGE_SENSORS_MECHANICAL_HAPTIC_VIBRATOR ((USAGE) 0x0068) +#define HID_USAGE_SENSORS_MECHANICAL_HALL_EFFECT_SWITCH ((USAGE) 0x0069) +#define HID_USAGE_SENSORS_MOTION ((USAGE) 0x0070) +#define HID_USAGE_SENSORS_MOTION_ACCELEROMETER_1D ((USAGE) 0x0071) +#define HID_USAGE_SENSORS_MOTION_ACCELEROMETER_2D ((USAGE) 0x0072) +#define HID_USAGE_SENSORS_MOTION_ACCELEROMETER_3D ((USAGE) 0x0073) +#define HID_USAGE_SENSORS_MOTION_GYROMETER_1D ((USAGE) 0x0074) +#define HID_USAGE_SENSORS_MOTION_GYROMETER_2D ((USAGE) 0x0075) +#define HID_USAGE_SENSORS_MOTION_GYROMETER_3D ((USAGE) 0x0076) +#define HID_USAGE_SENSORS_MOTION_MOTION_DETECTOR ((USAGE) 0x0077) +#define HID_USAGE_SENSORS_MOTION_SPEEDOMETER ((USAGE) 0x0078) +#define HID_USAGE_SENSORS_MOTION_ACCELEROMETER ((USAGE) 0x0079) +#define HID_USAGE_SENSORS_MOTION_GYROMETER ((USAGE) 0x007A) +#define HID_USAGE_SENSORS_MOTION_GRAVITY_VECTOR ((USAGE) 0x007B) +#define HID_USAGE_SENSORS_MOTION_LINEAR_ACCELEROMETER ((USAGE) 0x007C) +#define HID_USAGE_SENSORS_ORIENTATION ((USAGE) 0x0080) +#define HID_USAGE_SENSORS_ORIENTATION_COMPASS_1D ((USAGE) 0x0081) +#define HID_USAGE_SENSORS_ORIENTATION_COMPASS_2D ((USAGE) 0x0082) +#define HID_USAGE_SENSORS_ORIENTATION_COMPASS_3D ((USAGE) 0x0083) +#define HID_USAGE_SENSORS_ORIENTATION_INCLINOMETER_1D ((USAGE) 0x0084) +#define HID_USAGE_SENSORS_ORIENTATION_INCLINOMETER_2D ((USAGE) 0x0085) +#define HID_USAGE_SENSORS_ORIENTATION_INCLINOMETER_3D ((USAGE) 0x0086) +#define HID_USAGE_SENSORS_ORIENTATION_DISTANCE_1D ((USAGE) 0x0087) +#define HID_USAGE_SENSORS_ORIENTATION_DISTANCE_2D ((USAGE) 0x0088) +#define HID_USAGE_SENSORS_ORIENTATION_DISTANCE_3D ((USAGE) 0x0089) +#define HID_USAGE_SENSORS_ORIENTATION_DEVICE_ORIENTATION ((USAGE) 0x008A) +#define HID_USAGE_SENSORS_ORIENTATION_COMPASS ((USAGE) 0x008B) +#define HID_USAGE_SENSORS_ORIENTATION_INCLINOMETER ((USAGE) 0x008C) +#define HID_USAGE_SENSORS_ORIENTATION_DISTANCE ((USAGE) 0x008D) +#define HID_USAGE_SENSORS_ORIENTATION_RELATIVE_ORIENTATION ((USAGE) 0x008E) +#define HID_USAGE_SENSORS_ORIENTATION_SIMPLE_ORIENTATION ((USAGE) 0x008F) +#define HID_USAGE_SENSORS_SCANNER ((USAGE) 0x0090) +#define HID_USAGE_SENSORS_SCANNER_BARCODE ((USAGE) 0x0091) +#define HID_USAGE_SENSORS_SCANNER_RFID ((USAGE) 0x0092) +#define HID_USAGE_SENSORS_SCANNER_NFC ((USAGE) 0x0093) +#define HID_USAGE_SENSORS_TIME ((USAGE) 0x00A0) +#define HID_USAGE_SENSORS_TIME_ALARM_TIMER ((USAGE) 0x00A1) +#define HID_USAGE_SENSORS_TIME_REAL_TIME_CLOCK ((USAGE) 0x00A2) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY ((USAGE) 0x00B0) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY_ACTIVITY_DETECTION ((USAGE) 0x00B1) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY_DEVICE_POSITION ((USAGE) 0x00B2) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY_FLOOR_TRACKER ((USAGE) 0x00B3) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY_PEDOMETER ((USAGE) 0x00B4) +#define HID_USAGE_SENSORS_PERSONAL_ACTIVITY_STEP_DETECTION ((USAGE) 0x00B5) +#define HID_USAGE_SENSORS_ORIENTATION_EXTENDED ((USAGE) 0x00C0) +#define HID_USAGE_SENSORS_ORIENTATION_EXTENDED_GEOMAGNETIC_ORIENTATION ((USAGE) 0x00C1) +#define HID_USAGE_SENSORS_ORIENTATION_EXTENDED_MAGNETOMETER ((USAGE) 0x00C2) +#define HID_USAGE_SENSORS_GESTURE ((USAGE) 0x00D0) +#define HID_USAGE_SENSORS_GESTURE_CHASSIS_FLIP_GESTURE ((USAGE) 0x00D1) +#define HID_USAGE_SENSORS_GESTURE_HINGE_FOLD_GESTURE ((USAGE) 0x00D2) +#define HID_USAGE_SENSORS_OTHER ((USAGE) 0x00E0) +#define HID_USAGE_SENSORS_OTHER_CUSTOM ((USAGE) 0x00E1) +#define HID_USAGE_SENSORS_OTHER_GENERIC ((USAGE) 0x00E2) +#define HID_USAGE_SENSORS_OTHER_GENERIC_ENUMERATOR ((USAGE) 0x00E3) +#define HID_USAGE_SENSORS_OTHER_HINGE_ANGLE ((USAGE) 0x00E4) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_1 ((USAGE) 0x00F0) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_2 ((USAGE) 0x00F1) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_3 ((USAGE) 0x00F2) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_4 ((USAGE) 0x00F3) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_5 ((USAGE) 0x00F4) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_6 ((USAGE) 0x00F5) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_7 ((USAGE) 0x00F6) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_8 ((USAGE) 0x00F7) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_9 ((USAGE) 0x00F8) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_10 ((USAGE) 0x00F9) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_11 ((USAGE) 0x00FA) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_12 ((USAGE) 0x00FB) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_13 ((USAGE) 0x00FC) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_14 ((USAGE) 0x00FD) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_15 ((USAGE) 0x00FE) +#define HID_USAGE_SENSORS_VENDOR_RESERVED_16 ((USAGE) 0x00FF) +#define HID_USAGE_SENSORS_EVENT ((USAGE) 0x0200) +#define HID_USAGE_SENSORS_EVENT_SENSOR_STATE ((USAGE) 0x0201) +#define HID_USAGE_SENSORS_EVENT_SENSOR_EVENT ((USAGE) 0x0202) +#define HID_USAGE_SENSORS_PROPERTY ((USAGE) 0x0300) +#define HID_USAGE_SENSORS_PROPERTY_FRIENDLY_NAME ((USAGE) 0x0301) +#define HID_USAGE_SENSORS_PROPERTY_PERSISTENT_UNIQUE_ID ((USAGE) 0x0302) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_STATUS ((USAGE) 0x0303) +#define HID_USAGE_SENSORS_PROPERTY_MINIMUM_REPORT_INTERVAL ((USAGE) 0x0304) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_MANUFACTURER ((USAGE) 0x0305) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_MODEL ((USAGE) 0x0306) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_SERIAL_NUMBER ((USAGE) 0x0307) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_DESCRIPTION ((USAGE) 0x0308) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_CONNECTION_TYPE ((USAGE) 0x0309) +#define HID_USAGE_SENSORS_PROPERTY_SENSOR_DEVICE_PATH ((USAGE) 0x030A) +#define HID_USAGE_SENSORS_PROPERTY_HARDWARE_REVISION ((USAGE) 0x030B) +#define HID_USAGE_SENSORS_PROPERTY_FIRMWARE_VERSION ((USAGE) 0x030C) +#define HID_USAGE_SENSORS_PROPERTY_RELEASE_DATE ((USAGE) 0x030D) +#define HID_USAGE_SENSORS_PROPERTY_REPORT_INTERVAL ((USAGE) 0x030E) +#define HID_USAGE_SENSORS_PROPERTY_CHANGE_SENSITIVITY_ABSOLUTE ((USAGE) 0x030F) +#define HID_USAGE_SENSORS_PROPERTY_CHANGE_SENSITIVITY_PERCENT_OF_RANGE ((USAGE) 0x0310) +#define HID_USAGE_SENSORS_PROPERTY_CHANGE_SENSITIVITY_PERCENT_RELATIVE ((USAGE) 0x0311) +#define HID_USAGE_SENSORS_PROPERTY_ACCURACY ((USAGE) 0x0312) +#define HID_USAGE_SENSORS_PROPERTY_RESOLUTION ((USAGE) 0x0313) +#define HID_USAGE_SENSORS_PROPERTY_MAXIMUM ((USAGE) 0x0314) +#define HID_USAGE_SENSORS_PROPERTY_MINIMUM ((USAGE) 0x0315) +#define HID_USAGE_SENSORS_PROPERTY_REPORTING_STATE ((USAGE) 0x0316) +#define HID_USAGE_SENSORS_PROPERTY_SAMPLING_RATE ((USAGE) 0x0317) +#define HID_USAGE_SENSORS_PROPERTY_RESPONSE_CURVE ((USAGE) 0x0318) +#define HID_USAGE_SENSORS_PROPERTY_POWER_STATE ((USAGE) 0x0319) +#define HID_USAGE_SENSORS_PROPERTY_MAXIMUM_FIFO_EVENTS ((USAGE) 0x031A) +#define HID_USAGE_SENSORS_PROPERTY_REPORT_LATENCY ((USAGE) 0x031B) +#define HID_USAGE_SENSORS_PROPERTY_FLUSH_FIFO_EVENTS ((USAGE) 0x031C) +#define HID_USAGE_SENSORS_PROPERTY_MAXIMUM_POWER_CONSUMPTION ((USAGE) 0x031D) +#define HID_USAGE_SENSORS_PROPERTY_IS_PRIMARY ((USAGE) 0x031E) +#define HID_USAGE_SENSORS_PROPERTY_HUMAN_PRESENCE_DETECTION_TYPE ((USAGE) 0x031F) +#define HID_USAGE_SENSORS_DATA_FIELD_LOCATION ((USAGE) 0x0400) +#define HID_USAGE_SENSORS_DATA_FIELD_ALTITUDE_ANTENNA_SEA_LEVEL ((USAGE) 0x0402) +#define HID_USAGE_SENSORS_DATA_FIELD_DIFFERENTIAL_REFERENCE_STATION_ID ((USAGE) 0x0403) +#define HID_USAGE_SENSORS_DATA_FIELD_ALTITUDE_ELLIPSOID_ERROR ((USAGE) 0x0404) +#define HID_USAGE_SENSORS_DATA_FIELD_ALTITUDE_ELLIPSOID ((USAGE) 0x0405) +#define HID_USAGE_SENSORS_DATA_FIELD_ALTITUDE_SEA_LEVEL_ERROR ((USAGE) 0x0406) +#define HID_USAGE_SENSORS_DATA_FIELD_ALTITUDE_SEA_LEVEL ((USAGE) 0x0407) +#define HID_USAGE_SENSORS_DATA_FIELD_DIFFERENTIAL_GPS_DATA_AGE ((USAGE) 0x0408) +#define HID_USAGE_SENSORS_DATA_FIELD_ERROR_RADIUS ((USAGE) 0x0409) +#define HID_USAGE_SENSORS_DATA_FIELD_FIX_QUALITY ((USAGE) 0x040A) +#define HID_USAGE_SENSORS_DATA_FIELD_FIX_TYPE ((USAGE) 0x040B) +#define HID_USAGE_SENSORS_DATA_FIELD_GEOIDAL_SEPARATION ((USAGE) 0x040C) +#define HID_USAGE_SENSORS_DATA_FIELD_GPS_OPERATION_MODE ((USAGE) 0x040D) +#define HID_USAGE_SENSORS_DATA_FIELD_GPS_SELECTION_MODE ((USAGE) 0x040E) +#define HID_USAGE_SENSORS_DATA_FIELD_GPS_STATUS ((USAGE) 0x040F) +#define HID_USAGE_SENSORS_DATA_FIELD_POSITION_DILUTION_OF_PRECISION ((USAGE) 0x0410) +#define HID_USAGE_SENSORS_DATA_FIELD_HORIZONTAL_DILUTION_OF_PRECISION ((USAGE) 0x0411) +#define HID_USAGE_SENSORS_DATA_FIELD_VERTICAL_DILUTION_OF_PRECISION ((USAGE) 0x0412) +#define HID_USAGE_SENSORS_DATA_FIELD_LATITUDE ((USAGE) 0x0413) +#define HID_USAGE_SENSORS_DATA_FIELD_LONGITUDE ((USAGE) 0x0414) +#define HID_USAGE_SENSORS_DATA_FIELD_TRUE_HEADING ((USAGE) 0x0415) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_HEADING ((USAGE) 0x0416) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_VARIATION ((USAGE) 0x0417) +#define HID_USAGE_SENSORS_DATA_FIELD_SPEED ((USAGE) 0x0418) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW ((USAGE) 0x0419) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW_AZIMUTH ((USAGE) 0x041A) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW_ELEVATION ((USAGE) 0x041B) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW_IDS ((USAGE) 0x041C) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW_PRNS ((USAGE) 0x041D) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_IN_VIEW_SN_RATIOS ((USAGE) 0x041E) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_USED_COUNT ((USAGE) 0x041F) +#define HID_USAGE_SENSORS_DATA_FIELD_SATELLITES_USED_PRNS ((USAGE) 0x0420) +#define HID_USAGE_SENSORS_DATA_FIELD_NMEA_SENTENCE ((USAGE) 0x0421) +#define HID_USAGE_SENSORS_DATA_FIELD_ADDRESS_LINE_1 ((USAGE) 0x0422) +#define HID_USAGE_SENSORS_DATA_FIELD_ADDRESS_LINE_2 ((USAGE) 0x0423) +#define HID_USAGE_SENSORS_DATA_FIELD_CITY ((USAGE) 0x0424) +#define HID_USAGE_SENSORS_DATA_FIELD_STATE_OR_PROVINCE ((USAGE) 0x0425) +#define HID_USAGE_SENSORS_DATA_FIELD_COUNTRY_OR_REGION ((USAGE) 0x0426) +#define HID_USAGE_SENSORS_DATA_FIELD_POSTAL_CODE ((USAGE) 0x0427) +#define HID_USAGE_SENSORS_PROPERTY_LOCATION ((USAGE) 0x042A) +#define HID_USAGE_SENSORS_PROPERTY_LOCATION_DESIRED_ACCURACY ((USAGE) 0x042B) +#define HID_USAGE_SENSORS_DATA_FIELD_ENVIRONMENTAL ((USAGE) 0x0430) +#define HID_USAGE_SENSORS_DATA_FIELD_ATMOSPHERIC_PRESSURE ((USAGE) 0x0431) +#define HID_USAGE_SENSORS_DATA_FIELD_RELATIVE_HUMIDITY ((USAGE) 0x0433) +#define HID_USAGE_SENSORS_DATA_FIELD_TEMPERATURE ((USAGE) 0x0434) +#define HID_USAGE_SENSORS_DATA_FIELD_WIND_DIRECTION ((USAGE) 0x0435) +#define HID_USAGE_SENSORS_DATA_FIELD_WIND_SPEED ((USAGE) 0x0436) +#define HID_USAGE_SENSORS_DATA_FIELD_AIR_QUALITY_INDEX ((USAGE) 0x0437) +#define HID_USAGE_SENSORS_DATA_FIELD_EQUIVALENT_CO2 ((USAGE) 0x0438) +#define HID_USAGE_SENSORS_DATA_FIELD_VOLATILE_ORGANIC_COMPOUND_CONCENTRATION ((USAGE) 0x0439) +#define HID_USAGE_SENSORS_DATA_FIELD_OBJECT_PRESENCE ((USAGE) 0x043A) +#define HID_USAGE_SENSORS_DATA_FIELD_OBJECT_PROXIMITY_RANGE ((USAGE) 0x043B) +#define HID_USAGE_SENSORS_DATA_FIELD_OBJECT_PROXIMITY_OUT_OF_RANGE ((USAGE) 0x043C) +#define HID_USAGE_SENSORS_PROPERTY_ENVIRONMENTAL ((USAGE) 0x0440) +#define HID_USAGE_SENSORS_PROPERTY_REFERENCE_PRESSURE ((USAGE) 0x0441) +#define HID_USAGE_SENSORS_DATA_FIELD_MOTION ((USAGE) 0x0450) +#define HID_USAGE_SENSORS_DATA_FIELD_MOTION_STATE ((USAGE) 0x0451) +#define HID_USAGE_SENSORS_DATA_FIELD_ACCELERATION ((USAGE) 0x0452) +#define HID_USAGE_SENSORS_DATA_FIELD_ACCELERATION_AXIS_X ((USAGE) 0x0453) +#define HID_USAGE_SENSORS_DATA_FIELD_ACCELERATION_AXIS_Y ((USAGE) 0x0454) +#define HID_USAGE_SENSORS_DATA_FIELD_ACCELERATION_AXIS_Z ((USAGE) 0x0455) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_VELOCITY ((USAGE) 0x0456) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_VELOCITY_ABOUT_X_AXIS ((USAGE) 0x0457) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_VELOCITY_ABOUT_Y_AXIS ((USAGE) 0x0458) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_VELOCITY_ABOUT_Z_AXIS ((USAGE) 0x0459) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_POSITION ((USAGE) 0x045A) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_POSITION_ABOUT_X_AXIS ((USAGE) 0x045B) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_POSITION_ABOUT_Y_AXIS ((USAGE) 0x045C) +#define HID_USAGE_SENSORS_DATA_FIELD_ANGULAR_POSITION_ABOUT_Z_AXIS ((USAGE) 0x045D) +#define HID_USAGE_SENSORS_DATA_FIELD_MOTION_SPEED ((USAGE) 0x045E) +#define HID_USAGE_SENSORS_DATA_FIELD_MOTION_INTENSITY ((USAGE) 0x045F) +#define HID_USAGE_SENSORS_DATA_FIELD_ORIENTATION ((USAGE) 0x0470) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING ((USAGE) 0x0471) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_X_AXIS ((USAGE) 0x0472) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_Y_AXIS ((USAGE) 0x0473) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_Z_AXIS ((USAGE) 0x0474) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_COMPENSATED_MAGNETIC_NORTH ((USAGE) 0x0475) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_COMPENSATED_TRUE_NORTH ((USAGE) 0x0476) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_MAGNETIC_NORTH ((USAGE) 0x0477) +#define HID_USAGE_SENSORS_DATA_FIELD_HEADING_TRUE_NORTH ((USAGE) 0x0478) +#define HID_USAGE_SENSORS_DATA_FIELD_DISTANCE ((USAGE) 0x0479) +#define HID_USAGE_SENSORS_DATA_FIELD_DISTANCE_X_AXIS ((USAGE) 0x047A) +#define HID_USAGE_SENSORS_DATA_FIELD_DISTANCE_Y_AXIS ((USAGE) 0x047B) +#define HID_USAGE_SENSORS_DATA_FIELD_DISTANCE_Z_AXIS ((USAGE) 0x047C) +#define HID_USAGE_SENSORS_DATA_FIELD_DISTANCE_OUTOFRANGE ((USAGE) 0x047D) +#define HID_USAGE_SENSORS_DATA_FIELD_TILT ((USAGE) 0x047E) +#define HID_USAGE_SENSORS_DATA_FIELD_TILT_X_AXIS ((USAGE) 0x047F) +#define HID_USAGE_SENSORS_DATA_FIELD_TILT_Y_AXIS ((USAGE) 0x0480) +#define HID_USAGE_SENSORS_DATA_FIELD_TILT_Z_AXIS ((USAGE) 0x0481) +#define HID_USAGE_SENSORS_DATA_FIELD_ROTATION_MATRIX ((USAGE) 0x0482) +#define HID_USAGE_SENSORS_DATA_FIELD_QUATERNION ((USAGE) 0x0483) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_FLUX ((USAGE) 0x0484) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_FLUX_X_AXIS ((USAGE) 0x0485) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_FLUX_Y_AXIS ((USAGE) 0x0486) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETIC_FLUX_Z_AXIS ((USAGE) 0x0487) +#define HID_USAGE_SENSORS_DATA_FIELD_MAGNETOMETER_ACCURACY ((USAGE) 0x0488) +#define HID_USAGE_SENSORS_DATA_FIELD_SIMPLE_ORIENTATION_DIRECTION ((USAGE) 0x0489) +#define HID_USAGE_SENSORS_DATA_FIELD_MECHANICAL ((USAGE) 0x0490) +#define HID_USAGE_SENSORS_DATA_FIELD_BOOLEAN_SWITCH_STATE ((USAGE) 0x0491) +#define HID_USAGE_SENSORS_DATA_FIELD_BOOLEAN_SWITCH_ARRAY_STATES ((USAGE) 0x0492) +#define HID_USAGE_SENSORS_DATA_FIELD_MULTIVALUE_SWITCH_VALUE ((USAGE) 0x0493) +#define HID_USAGE_SENSORS_DATA_FIELD_FORCE ((USAGE) 0x0494) +#define HID_USAGE_SENSORS_DATA_FIELD_ABSOLUTE_PRESSURE ((USAGE) 0x0495) +#define HID_USAGE_SENSORS_DATA_FIELD_GAUGE_PRESSURE ((USAGE) 0x0496) +#define HID_USAGE_SENSORS_DATA_FIELD_STRAIN ((USAGE) 0x0497) +#define HID_USAGE_SENSORS_DATA_FIELD_WEIGHT ((USAGE) 0x0498) +#define HID_USAGE_SENSORS_PROPERTY_MECHANICAL ((USAGE) 0x04A0) +#define HID_USAGE_SENSORS_PROPERTY_VIBRATION_STATE ((USAGE) 0x04A1) +#define HID_USAGE_SENSORS_PROPERTY_FORWARD_VIBRATION_SPEED ((USAGE) 0x04A2) +#define HID_USAGE_SENSORS_PROPERTY_BACKWARD_VIBRATION_SPEED ((USAGE) 0x04A3) +#define HID_USAGE_SENSORS_DATA_FIELD_BIOMETRIC ((USAGE) 0x04B0) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_PRESENCE ((USAGE) 0x04B1) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_PROXIMITY_RANGE ((USAGE) 0x04B2) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_PROXIMITY_OUT_OF_RANGE ((USAGE) 0x04B3) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_TOUCH_STATE ((USAGE) 0x04B4) +#define HID_USAGE_SENSORS_DATA_FIELD_BLOOD_PRESSURE ((USAGE) 0x04B5) +#define HID_USAGE_SENSORS_DATA_FIELD_BLOOD_PRESSURE_DIASTOLIC ((USAGE) 0x04B6) +#define HID_USAGE_SENSORS_DATA_FIELD_BLOOD_PRESSURE_SYSTOLIC ((USAGE) 0x04B7) +#define HID_USAGE_SENSORS_DATA_FIELD_HEART_RATE ((USAGE) 0x04B8) +#define HID_USAGE_SENSORS_DATA_FIELD_RESTING_HEART_RATE ((USAGE) 0x04B9) +#define HID_USAGE_SENSORS_DATA_FIELD_HEARTBEAT_INTERVAL ((USAGE) 0x04BA) +#define HID_USAGE_SENSORS_DATA_FIELD_RESPIRATORY_RATE ((USAGE) 0x04BB) +#define HID_USAGE_SENSORS_DATA_FIELD_SPO2 ((USAGE) 0x04BC) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_ATTENTION_DETECTED ((USAGE) 0x04BD) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_HEAD_AZIMUTH ((USAGE) 0x04BE) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_HEAD_ALTITUDE ((USAGE) 0x04BF) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_HEAD_ROLL ((USAGE) 0x04C0) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_HEAD_PITCH ((USAGE) 0x04C1) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_HEAD_YAW ((USAGE) 0x04C2) +#define HID_USAGE_SENSORS_DATA_FIELD_HUMAN_CORRELATION_ID ((USAGE) 0x04C3) +#define HID_USAGE_SENSORS_DATA_FIELD_LIGHT ((USAGE) 0x04D0) +#define HID_USAGE_SENSORS_DATA_FIELD_ILLUMINANCE ((USAGE) 0x04D1) +#define HID_USAGE_SENSORS_DATA_FIELD_COLOR_TEMPERATURE ((USAGE) 0x04D2) +#define HID_USAGE_SENSORS_DATA_FIELD_CHROMATICITY ((USAGE) 0x04D3) +#define HID_USAGE_SENSORS_DATA_FIELD_CHROMATICITY_X ((USAGE) 0x04D4) +#define HID_USAGE_SENSORS_DATA_FIELD_CHROMATICITY_Y ((USAGE) 0x04D5) +#define HID_USAGE_SENSORS_DATA_FIELD_CONSUMER_IR_SENTENCE_RECEIVE ((USAGE) 0x04D6) +#define HID_USAGE_SENSORS_DATA_FIELD_INFRARED_LIGHT ((USAGE) 0x04D7) +#define HID_USAGE_SENSORS_DATA_FIELD_RED_LIGHT ((USAGE) 0x04D8) +#define HID_USAGE_SENSORS_DATA_FIELD_GREEN_LIGHT ((USAGE) 0x04D9) +#define HID_USAGE_SENSORS_DATA_FIELD_BLUE_LIGHT ((USAGE) 0x04DA) +#define HID_USAGE_SENSORS_DATA_FIELD_ULTRAVIOLET_A_LIGHT ((USAGE) 0x04DB) +#define HID_USAGE_SENSORS_DATA_FIELD_ULTRAVIOLET_B_LIGHT ((USAGE) 0x04DC) +#define HID_USAGE_SENSORS_DATA_FIELD_ULTRAVIOLET_INDEX ((USAGE) 0x04DD) +#define HID_USAGE_SENSORS_DATA_FIELD_NEAR_INFRARED_LIGHT ((USAGE) 0x04DE) +#define HID_USAGE_SENSORS_PROPERTY_LIGHT ((USAGE) 0x04DF) +#define HID_USAGE_SENSORS_PROPERTY_CONSUMER_IR_SENTENCE_SEND ((USAGE) 0x04E0) +#define HID_USAGE_SENSORS_PROPERTY_AUTO_BRIGHTNESS_PREFERRED ((USAGE) 0x04E2) +#define HID_USAGE_SENSORS_PROPERTY_AUTO_COLOR_PREFERRED ((USAGE) 0x04E3) +#define HID_USAGE_SENSORS_DATA_FIELD_SCANNER ((USAGE) 0x04F0) +#define HID_USAGE_SENSORS_DATA_FIELD_RFID_TAG_40_BIT ((USAGE) 0x04F1) +#define HID_USAGE_SENSORS_DATA_FIELD_NFC_SENTENCE_RECEIVE ((USAGE) 0x04F2) +#define HID_USAGE_SENSORS_PROPERTY_SCANNER ((USAGE) 0x04F8) +#define HID_USAGE_SENSORS_PROPERTY_NFC_SENTENCE_SEND ((USAGE) 0x04F9) +#define HID_USAGE_SENSORS_DATA_FIELD_ELECTRICAL ((USAGE) 0x0500) +#define HID_USAGE_SENSORS_DATA_FIELD_CAPACITANCE ((USAGE) 0x0501) +#define HID_USAGE_SENSORS_DATA_FIELD_CURRENT ((USAGE) 0x0502) +#define HID_USAGE_SENSORS_DATA_FIELD_ELECTRICAL_POWER ((USAGE) 0x0503) +#define HID_USAGE_SENSORS_DATA_FIELD_INDUCTANCE ((USAGE) 0x0504) +#define HID_USAGE_SENSORS_DATA_FIELD_RESISTANCE ((USAGE) 0x0505) +#define HID_USAGE_SENSORS_DATA_FIELD_VOLTAGE ((USAGE) 0x0506) +#define HID_USAGE_SENSORS_DATA_FIELD_FREQUENCY ((USAGE) 0x0507) +#define HID_USAGE_SENSORS_DATA_FIELD_PERIOD ((USAGE) 0x0508) +#define HID_USAGE_SENSORS_DATA_FIELD_PERCENT_OF_RANGE ((USAGE) 0x0509) +#define HID_USAGE_SENSORS_DATA_FIELD_TIME ((USAGE) 0x0520) +#define HID_USAGE_SENSORS_DATA_FIELD_YEAR ((USAGE) 0x0521) +#define HID_USAGE_SENSORS_DATA_FIELD_MONTH ((USAGE) 0x0522) +#define HID_USAGE_SENSORS_DATA_FIELD_DAY ((USAGE) 0x0523) +#define HID_USAGE_SENSORS_DATA_FIELD_DAY_OF_WEEK ((USAGE) 0x0524) +#define HID_USAGE_SENSORS_DATA_FIELD_HOUR ((USAGE) 0x0525) +#define HID_USAGE_SENSORS_DATA_FIELD_MINUTE ((USAGE) 0x0526) +#define HID_USAGE_SENSORS_DATA_FIELD_SECOND ((USAGE) 0x0527) +#define HID_USAGE_SENSORS_DATA_FIELD_MILLISECOND ((USAGE) 0x0528) +#define HID_USAGE_SENSORS_DATA_FIELD_TIMESTAMP ((USAGE) 0x0529) +#define HID_USAGE_SENSORS_DATA_FIELD_JULIAN_DAY_OF_YEAR ((USAGE) 0x052A) +#define HID_USAGE_SENSORS_DATA_FIELD_TIME_SINCE_SYSTEM_BOOT ((USAGE) 0x052B) +#define HID_USAGE_SENSORS_PROPERTY_TIME ((USAGE) 0x0530) +#define HID_USAGE_SENSORS_PROPERTY_TIME_ZONE_OFFSET_FROM_UTC ((USAGE) 0x0531) +#define HID_USAGE_SENSORS_PROPERTY_TIME_ZONE_NAME ((USAGE) 0x0532) +#define HID_USAGE_SENSORS_PROPERTY_DAYLIGHT_SAVINGS_TIME_OBSERVED ((USAGE) 0x0533) +#define HID_USAGE_SENSORS_PROPERTY_TIME_TRIM_ADJUSTMENT ((USAGE) 0x0534) +#define HID_USAGE_SENSORS_PROPERTY_ARM_ALARM ((USAGE) 0x0535) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM ((USAGE) 0x0540) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_USAGE ((USAGE) 0x0541) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_BOOLEAN_ARRAY ((USAGE) 0x0542) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE ((USAGE) 0x0543) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_1 ((USAGE) 0x0544) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_2 ((USAGE) 0x0545) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_3 ((USAGE) 0x0546) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_4 ((USAGE) 0x0547) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_5 ((USAGE) 0x0548) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_6 ((USAGE) 0x0549) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_7 ((USAGE) 0x054A) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_8 ((USAGE) 0x054B) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_9 ((USAGE) 0x054C) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_10 ((USAGE) 0x054D) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_11 ((USAGE) 0x054E) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_12 ((USAGE) 0x054F) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_13 ((USAGE) 0x0550) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_14 ((USAGE) 0x0551) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_15 ((USAGE) 0x0552) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_16 ((USAGE) 0x0553) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_17 ((USAGE) 0x0554) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_18 ((USAGE) 0x0555) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_19 ((USAGE) 0x0556) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_20 ((USAGE) 0x0557) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_21 ((USAGE) 0x0558) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_22 ((USAGE) 0x0559) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_23 ((USAGE) 0x055A) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_24 ((USAGE) 0x055B) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_25 ((USAGE) 0x055C) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_26 ((USAGE) 0x055D) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_27 ((USAGE) 0x055E) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_VALUE_28 ((USAGE) 0x055F) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC ((USAGE) 0x0560) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_GUID_OR_PROPERTYKEY ((USAGE) 0x0561) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_CATEGORY_GUID ((USAGE) 0x0562) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_TYPE_GUID ((USAGE) 0x0563) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_EVENT_PROPERTYKEY ((USAGE) 0x0564) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_PROPERTY_PROPERTYKEY ((USAGE) 0x0565) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_DATA_FIELD_PROPERTYKEY ((USAGE) 0x0566) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_EVENT ((USAGE) 0x0567) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_PROPERTY ((USAGE) 0x0568) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_DATA_FIELD ((USAGE) 0x0569) +#define HID_USAGE_SENSORS_DATA_FIELD_ENUMERATOR_TABLE_ROW_INDEX ((USAGE) 0x056A) +#define HID_USAGE_SENSORS_DATA_FIELD_ENUMERATOR_TABLE_ROW_COUNT ((USAGE) 0x056B) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_GUID_OR_PROPERTYKEY_KIND ((USAGE) 0x056C) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_GUID ((USAGE) 0x056D) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_PROPERTYKEY ((USAGE) 0x056E) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_TOP_LEVEL_COLLECTION_ID ((USAGE) 0x056F) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_REPORT_ID ((USAGE) 0x0570) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_REPORT_ITEM_POSITION_INDEX ((USAGE) 0x0571) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_FIRMWARE_VARTYPE ((USAGE) 0x0572) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_UNIT_OF_MEASURE ((USAGE) 0x0573) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_UNIT_EXPONENT ((USAGE) 0x0574) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_REPORT_SIZE ((USAGE) 0x0575) +#define HID_USAGE_SENSORS_DATA_FIELD_GENERIC_REPORT_COUNT ((USAGE) 0x0576) +#define HID_USAGE_SENSORS_PROPERTY_GENERIC ((USAGE) 0x0580) +#define HID_USAGE_SENSORS_PROPERTY_ENUMERATOR_TABLE_ROW_INDEX ((USAGE) 0x0581) +#define HID_USAGE_SENSORS_PROPERTY_ENUMERATOR_TABLE_ROW_COUNT ((USAGE) 0x0582) +#define HID_USAGE_SENSORS_DATA_FIELD_PERSONAL_ACTIVITY ((USAGE) 0x0590) +#define HID_USAGE_SENSORS_DATA_FIELD_ACTIVITY_TYPE ((USAGE) 0x0591) +#define HID_USAGE_SENSORS_DATA_FIELD_ACTIVITY_STATE ((USAGE) 0x0592) +#define HID_USAGE_SENSORS_DATA_FIELD_DEVICE_POSITION ((USAGE) 0x0593) +#define HID_USAGE_SENSORS_DATA_FIELD_STEP_COUNT ((USAGE) 0x0594) +#define HID_USAGE_SENSORS_DATA_FIELD_STEP_COUNT_RESET ((USAGE) 0x0595) +#define HID_USAGE_SENSORS_DATA_FIELD_STEP_DURATION ((USAGE) 0x0596) +#define HID_USAGE_SENSORS_DATA_FIELD_STEP_TYPE ((USAGE) 0x0597) +#define HID_USAGE_SENSORS_PROPERTY_MINIMUM_ACTIVITY_DETECTION_INTERVAL ((USAGE) 0x05A0) +#define HID_USAGE_SENSORS_PROPERTY_SUPPORTED_ACTIVITY_TYPES ((USAGE) 0x05A1) +#define HID_USAGE_SENSORS_PROPERTY_SUBSCRIBED_ACTIVITY_TYPES ((USAGE) 0x05A2) +#define HID_USAGE_SENSORS_PROPERTY_SUPPORTED_STEP_TYPES ((USAGE) 0x05A3) +#define HID_USAGE_SENSORS_PROPERTY_SUBSCRIBED_STEP_TYPES ((USAGE) 0x05A4) +#define HID_USAGE_SENSORS_PROPERTY_FLOOR_HEIGHT ((USAGE) 0x05A5) +#define HID_USAGE_SENSORS_DATA_FIELD_CUSTOM_TYPE_ID ((USAGE) 0x05B0) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM ((USAGE) 0x05C0) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_1 ((USAGE) 0x05C1) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_2 ((USAGE) 0x05C2) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_3 ((USAGE) 0x05C3) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_4 ((USAGE) 0x05C4) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_5 ((USAGE) 0x05C5) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_6 ((USAGE) 0x05C6) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_7 ((USAGE) 0x05C7) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_8 ((USAGE) 0x05C8) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_9 ((USAGE) 0x05C9) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_10 ((USAGE) 0x05CA) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_11 ((USAGE) 0x05CB) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_12 ((USAGE) 0x05CC) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_13 ((USAGE) 0x05CD) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_14 ((USAGE) 0x05CE) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_15 ((USAGE) 0x05CF) +#define HID_USAGE_SENSORS_PROPERTY_CUSTOM_VALUE_16 ((USAGE) 0x05D0) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE ((USAGE) 0x05E0) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE_ANGLE ((USAGE) 0x05E1) +#define HID_USAGE_SENSORS_DATA_FIELD_GESTURE_SENSOR ((USAGE) 0x05F0) +#define HID_USAGE_SENSORS_DATA_FIELD_GESTURE_STATE ((USAGE) 0x05F1) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE_FOLD_INITIAL_ANGLE ((USAGE) 0x05F2) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE_FOLD_FINAL_ANGLE ((USAGE) 0x05F3) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE_FOLD_CONTRIBUTING_PANEL ((USAGE) 0x05F4) +#define HID_USAGE_SENSORS_DATA_FIELD_HINGE_FOLD_TYPE ((USAGE) 0x05F5) +#define HID_USAGE_SENSORS_SENSOR_STATE_UNDEFINED ((USAGE) 0x0800) +#define HID_USAGE_SENSORS_SENSOR_STATE_READY ((USAGE) 0x0801) +#define HID_USAGE_SENSORS_SENSOR_STATE_NOT_AVAILABLE ((USAGE) 0x0802) +#define HID_USAGE_SENSORS_SENSOR_STATE_NO_DATA ((USAGE) 0x0803) +#define HID_USAGE_SENSORS_SENSOR_STATE_INITIALIZING ((USAGE) 0x0804) +#define HID_USAGE_SENSORS_SENSOR_STATE_ACCESS_DENIED ((USAGE) 0x0805) +#define HID_USAGE_SENSORS_SENSOR_STATE_ERROR ((USAGE) 0x0806) +#define HID_USAGE_SENSORS_SENSOR_EVENT_UNKNOWN ((USAGE) 0x0810) +#define HID_USAGE_SENSORS_SENSOR_EVENT_STATE_CHANGED ((USAGE) 0x0811) +#define HID_USAGE_SENSORS_SENSOR_EVENT_PROPERTY_CHANGED ((USAGE) 0x0812) +#define HID_USAGE_SENSORS_SENSOR_EVENT_DATA_UPDATED ((USAGE) 0x0813) +#define HID_USAGE_SENSORS_SENSOR_EVENT_POLL_RESPONSE ((USAGE) 0x0814) +#define HID_USAGE_SENSORS_SENSOR_EVENT_CHANGE_SENSITIVITY ((USAGE) 0x0815) +#define HID_USAGE_SENSORS_SENSOR_EVENT_RANGE_MAXIMUM_REACHED ((USAGE) 0x0816) +#define HID_USAGE_SENSORS_SENSOR_EVENT_RANGE_MINIMUM_REACHED ((USAGE) 0x0817) +#define HID_USAGE_SENSORS_SENSOR_EVENT_HIGH_THRESHOLD_CROSS_UPWARD ((USAGE) 0x0818) +#define HID_USAGE_SENSORS_SENSOR_EVENT_HIGH_THRESHOLD_CROSS_DOWNWARD ((USAGE) 0x0819) +#define HID_USAGE_SENSORS_SENSOR_EVENT_LOW_THRESHOLD_CROSS_UPWARD ((USAGE) 0x081A) +#define HID_USAGE_SENSORS_SENSOR_EVENT_LOW_THRESHOLD_CROSS_DOWNWARD ((USAGE) 0x081B) +#define HID_USAGE_SENSORS_SENSOR_EVENT_ZERO_THRESHOLD_CROSS_UPWARD ((USAGE) 0x081C) +#define HID_USAGE_SENSORS_SENSOR_EVENT_ZERO_THRESHOLD_CROSS_DOWNWARD ((USAGE) 0x081D) +#define HID_USAGE_SENSORS_SENSOR_EVENT_PERIOD_EXCEEDED ((USAGE) 0x081E) +#define HID_USAGE_SENSORS_SENSOR_EVENT_FREQUENCY_EXCEEDED ((USAGE) 0x081F) +#define HID_USAGE_SENSORS_SENSOR_EVENT_COMPLEX_TRIGGER ((USAGE) 0x0820) +#define HID_USAGE_SENSORS_CONNECTION_TYPE_PC_INTEGRATED ((USAGE) 0x0830) +#define HID_USAGE_SENSORS_CONNECTION_TYPE_PC_ATTACHED ((USAGE) 0x0831) +#define HID_USAGE_SENSORS_CONNECTION_TYPE_PC_EXTERNAL ((USAGE) 0x0832) +#define HID_USAGE_SENSORS_REPORTING_STATE_REPORT_NO_EVENTS ((USAGE) 0x0840) +#define HID_USAGE_SENSORS_REPORTING_STATE_REPORT_ALL_EVENTS ((USAGE) 0x0841) +#define HID_USAGE_SENSORS_REPORTING_STATE_REPORT_THRESHOLD_EVENTS ((USAGE) 0x0842) +#define HID_USAGE_SENSORS_REPORTING_STATE_WAKE_ON_NO_EVENTS ((USAGE) 0x0843) +#define HID_USAGE_SENSORS_REPORTING_STATE_WAKE_ON_ALL_EVENTS ((USAGE) 0x0844) +#define HID_USAGE_SENSORS_REPORTING_STATE_WAKE_ON_THRESHOLD_EVENTS ((USAGE) 0x0845) +#define HID_USAGE_SENSORS_REPORTING_STATE_ANYTIME_SEL ((USAGE) 0x0846) +#define HID_USAGE_SENSORS_POWER_STATE_UNDEFINED ((USAGE) 0x0850) +#define HID_USAGE_SENSORS_POWER_STATE_D0_FULL_POWER ((USAGE) 0x0851) +#define HID_USAGE_SENSORS_POWER_STATE_D1_LOW_POWER ((USAGE) 0x0852) +#define HID_USAGE_SENSORS_POWER_STATE_D2_STANDBY_POWER_WITH_WAKEUP ((USAGE) 0x0853) +#define HID_USAGE_SENSORS_POWER_STATE_D3_SLEEP_WITH_WAKEUP ((USAGE) 0x0854) +#define HID_USAGE_SENSORS_POWER_STATE_D4_POWER_OFF ((USAGE) 0x0855) +#define HID_USAGE_SENSORS_ACCURACY_DEFAULT ((USAGE) 0x0860) +#define HID_USAGE_SENSORS_ACCURACY_HIGH ((USAGE) 0x0861) +#define HID_USAGE_SENSORS_ACCURACY_MEDIUM ((USAGE) 0x0862) +#define HID_USAGE_SENSORS_ACCURACY_LOW ((USAGE) 0x0863) +#define HID_USAGE_SENSORS_FIX_QUALITY_NO_FIX ((USAGE) 0x0870) +#define HID_USAGE_SENSORS_FIX_QUALITY_GPS ((USAGE) 0x0871) +#define HID_USAGE_SENSORS_FIX_QUALITY_DGPS ((USAGE) 0x0872) +#define HID_USAGE_SENSORS_FIX_TYPE_NO_FIX ((USAGE) 0x0880) +#define HID_USAGE_SENSORS_FIX_TYPE_GPS_SPS_MODE_FIX_VALID ((USAGE) 0x0881) +#define HID_USAGE_SENSORS_FIX_TYPE_DGPS_SPS_MODE_FIX_VALID ((USAGE) 0x0882) +#define HID_USAGE_SENSORS_FIX_TYPE_GPS_PPS_MODE_FIX_VALID ((USAGE) 0x0883) +#define HID_USAGE_SENSORS_FIX_TYPE_REAL_TIME_KINEMATIC ((USAGE) 0x0884) +#define HID_USAGE_SENSORS_FIX_TYPE_FLOAT_RTK ((USAGE) 0x0885) +#define HID_USAGE_SENSORS_FIX_TYPE_ESTIMATED_DEAD_RECKONED ((USAGE) 0x0886) +#define HID_USAGE_SENSORS_FIX_TYPE_MANUAL_INPUT_MODE ((USAGE) 0x0887) +#define HID_USAGE_SENSORS_FIX_TYPE_SIMULATOR_MODE ((USAGE) 0x0888) +#define HID_USAGE_SENSORS_GPS_OPERATION_MODE_MANUAL ((USAGE) 0x0890) +#define HID_USAGE_SENSORS_GPS_OPERATION_MODE_AUTOMATIC ((USAGE) 0x0891) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_AUTONOMOUS ((USAGE) 0x08A0) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_DGPS ((USAGE) 0x08A1) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_ESTIMATED_DEAD_RECKONED ((USAGE) 0x08A2) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_MANUAL_INPUT ((USAGE) 0x08A3) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_SIMULATOR ((USAGE) 0x08A4) +#define HID_USAGE_SENSORS_GPS_SELECTION_MODE_DATA_NOT_VALID ((USAGE) 0x08A5) +#define HID_USAGE_SENSORS_GPS_STATUS_DATA_VALID ((USAGE) 0x08B0) +#define HID_USAGE_SENSORS_GPS_STATUS_DATA_NOT_VALID ((USAGE) 0x08B1) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_SUNDAY ((USAGE) 0x08C0) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_MONDAY ((USAGE) 0x08C1) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_TUESDAY ((USAGE) 0x08C2) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_WEDNESDAY ((USAGE) 0x08C3) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_THURSDAY ((USAGE) 0x08C4) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_FRIDAY ((USAGE) 0x08C5) +#define HID_USAGE_SENSORS_DAY_OF_WEEK_SATURDAY ((USAGE) 0x08C6) +#define HID_USAGE_SENSORS_KIND_CATEGORY ((USAGE) 0x08D0) +#define HID_USAGE_SENSORS_KIND_TYPE ((USAGE) 0x08D1) +#define HID_USAGE_SENSORS_KIND_EVENT ((USAGE) 0x08D2) +#define HID_USAGE_SENSORS_KIND_PROPERTY ((USAGE) 0x08D3) +#define HID_USAGE_SENSORS_KIND_DATA_FIELD ((USAGE) 0x08D4) +#define HID_USAGE_SENSORS_MAGNETOMETER_ACCURACY_LOW ((USAGE) 0x08E0) +#define HID_USAGE_SENSORS_MAGNETOMETER_ACCURACY_MEDIUM ((USAGE) 0x08E1) +#define HID_USAGE_SENSORS_MAGNETOMETER_ACCURACY_HIGH ((USAGE) 0x08E2) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_NOT_ROTATED ((USAGE) 0x08F0) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_ROTATED_90_DEGREES_CCW ((USAGE) 0x08F1) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_ROTATED_180_DEGREES_CCW ((USAGE) 0x08F2) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_ROTATED_270_DEGREES_CCW ((USAGE) 0x08F3) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_FACE_UP ((USAGE) 0x08F4) +#define HID_USAGE_SENSORS_SIMPLE_ORIENTATION_DIRECTION_FACE_DOWN ((USAGE) 0x08F5) +#define HID_USAGE_SENSORS_VT_NULL ((USAGE) 0x0900) +#define HID_USAGE_SENSORS_VT_BOOL ((USAGE) 0x0901) +#define HID_USAGE_SENSORS_VT_UI1 ((USAGE) 0x0902) +#define HID_USAGE_SENSORS_VT_I1 ((USAGE) 0x0903) +#define HID_USAGE_SENSORS_VT_UI2 ((USAGE) 0x0904) +#define HID_USAGE_SENSORS_VT_I2 ((USAGE) 0x0905) +#define HID_USAGE_SENSORS_VT_UI4 ((USAGE) 0x0906) +#define HID_USAGE_SENSORS_VT_I4 ((USAGE) 0x0907) +#define HID_USAGE_SENSORS_VT_UI8 ((USAGE) 0x0908) +#define HID_USAGE_SENSORS_VT_I8 ((USAGE) 0x0909) +#define HID_USAGE_SENSORS_VT_R4 ((USAGE) 0x090A) +#define HID_USAGE_SENSORS_VT_R8 ((USAGE) 0x090B) +#define HID_USAGE_SENSORS_VT_WSTR ((USAGE) 0x090C) +#define HID_USAGE_SENSORS_VT_STR ((USAGE) 0x090D) +#define HID_USAGE_SENSORS_VT_CLSID ((USAGE) 0x090E) +#define HID_USAGE_SENSORS_VT_VECTOR_VT_UI1 ((USAGE) 0x090F) +#define HID_USAGE_SENSORS_VT_F16E0 ((USAGE) 0x0910) +#define HID_USAGE_SENSORS_VT_F16E1 ((USAGE) 0x0911) +#define HID_USAGE_SENSORS_VT_F16E2 ((USAGE) 0x0912) +#define HID_USAGE_SENSORS_VT_F16E3 ((USAGE) 0x0913) +#define HID_USAGE_SENSORS_VT_F16E4 ((USAGE) 0x0914) +#define HID_USAGE_SENSORS_VT_F16E5 ((USAGE) 0x0915) +#define HID_USAGE_SENSORS_VT_F16E6 ((USAGE) 0x0916) +#define HID_USAGE_SENSORS_VT_F16E7 ((USAGE) 0x0917) +#define HID_USAGE_SENSORS_VT_F16E8 ((USAGE) 0x0918) +#define HID_USAGE_SENSORS_VT_F16E9 ((USAGE) 0x0919) +#define HID_USAGE_SENSORS_VT_F16EA ((USAGE) 0x091A) +#define HID_USAGE_SENSORS_VT_F16EB ((USAGE) 0x091B) +#define HID_USAGE_SENSORS_VT_F16EC ((USAGE) 0x091C) +#define HID_USAGE_SENSORS_VT_F16ED ((USAGE) 0x091D) +#define HID_USAGE_SENSORS_VT_F16EE ((USAGE) 0x091E) +#define HID_USAGE_SENSORS_VT_F16EF ((USAGE) 0x091F) +#define HID_USAGE_SENSORS_VT_F32E0 ((USAGE) 0x0920) +#define HID_USAGE_SENSORS_VT_F32E1 ((USAGE) 0x0921) +#define HID_USAGE_SENSORS_VT_F32E2 ((USAGE) 0x0922) +#define HID_USAGE_SENSORS_VT_F32E3 ((USAGE) 0x0923) +#define HID_USAGE_SENSORS_VT_F32E4 ((USAGE) 0x0924) +#define HID_USAGE_SENSORS_VT_F32E5 ((USAGE) 0x0925) +#define HID_USAGE_SENSORS_VT_F32E6 ((USAGE) 0x0926) +#define HID_USAGE_SENSORS_VT_F32E7 ((USAGE) 0x0927) +#define HID_USAGE_SENSORS_VT_F32E8 ((USAGE) 0x0928) +#define HID_USAGE_SENSORS_VT_F32E9 ((USAGE) 0x0929) +#define HID_USAGE_SENSORS_VT_F32EA ((USAGE) 0x092A) +#define HID_USAGE_SENSORS_VT_F32EB ((USAGE) 0x092B) +#define HID_USAGE_SENSORS_VT_F32EC ((USAGE) 0x092C) +#define HID_USAGE_SENSORS_VT_F32ED ((USAGE) 0x092D) +#define HID_USAGE_SENSORS_VT_F32EE ((USAGE) 0x092E) +#define HID_USAGE_SENSORS_VT_F32EF ((USAGE) 0x092F) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_UNKNOWN ((USAGE) 0x0930) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_STATIONARY ((USAGE) 0x0931) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_FIDGETING ((USAGE) 0x0932) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_WALKING ((USAGE) 0x0933) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_RUNNING ((USAGE) 0x0934) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_IN_VEHICLE ((USAGE) 0x0935) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_BIKING ((USAGE) 0x0936) +#define HID_USAGE_SENSORS_ACTIVITY_TYPE_IDLE ((USAGE) 0x0937) +#define HID_USAGE_SENSORS_UNIT_NOT_SPECIFIED ((USAGE) 0x0940) +#define HID_USAGE_SENSORS_UNIT_LUX ((USAGE) 0x0941) +#define HID_USAGE_SENSORS_UNIT_DEGREES_KELVIN ((USAGE) 0x0942) +#define HID_USAGE_SENSORS_UNIT_DEGREES_CELSIUS ((USAGE) 0x0943) +#define HID_USAGE_SENSORS_UNIT_PASCAL ((USAGE) 0x0944) +#define HID_USAGE_SENSORS_UNIT_NEWTON ((USAGE) 0x0945) +#define HID_USAGE_SENSORS_UNIT_METERSSECOND ((USAGE) 0x0946) +#define HID_USAGE_SENSORS_UNIT_KILOGRAM ((USAGE) 0x0947) +#define HID_USAGE_SENSORS_UNIT_METER ((USAGE) 0x0948) +#define HID_USAGE_SENSORS_UNIT_METERSSECONDSECOND ((USAGE) 0x0949) +#define HID_USAGE_SENSORS_UNIT_FARAD ((USAGE) 0x094A) +#define HID_USAGE_SENSORS_UNIT_AMPERE ((USAGE) 0x094B) +#define HID_USAGE_SENSORS_UNIT_WATT ((USAGE) 0x094C) +#define HID_USAGE_SENSORS_UNIT_HENRY ((USAGE) 0x094D) +#define HID_USAGE_SENSORS_UNIT_OHM ((USAGE) 0x094E) +#define HID_USAGE_SENSORS_UNIT_VOLT ((USAGE) 0x094F) +#define HID_USAGE_SENSORS_UNIT_HERTZ ((USAGE) 0x0950) +#define HID_USAGE_SENSORS_UNIT_BAR ((USAGE) 0x0951) +#define HID_USAGE_SENSORS_UNIT_DEGREES_ANTICLOCKWISE ((USAGE) 0x0952) +#define HID_USAGE_SENSORS_UNIT_DEGREES_CLOCKWISE ((USAGE) 0x0953) +#define HID_USAGE_SENSORS_UNIT_DEGREES ((USAGE) 0x0954) +#define HID_USAGE_SENSORS_UNIT_DEGREESSECOND ((USAGE) 0x0955) +#define HID_USAGE_SENSORS_UNIT_DEGREESSECONDSECOND ((USAGE) 0x0956) +#define HID_USAGE_SENSORS_UNIT_KNOT ((USAGE) 0x0957) +#define HID_USAGE_SENSORS_UNIT_PERCENT ((USAGE) 0x0958) +#define HID_USAGE_SENSORS_UNIT_SECOND ((USAGE) 0x0959) +#define HID_USAGE_SENSORS_UNIT_MILLISECOND ((USAGE) 0x095A) +#define HID_USAGE_SENSORS_UNIT_G ((USAGE) 0x095B) +#define HID_USAGE_SENSORS_UNIT_BYTES ((USAGE) 0x095C) +#define HID_USAGE_SENSORS_UNIT_MILLIGAUSS ((USAGE) 0x095D) +#define HID_USAGE_SENSORS_UNIT_BITS ((USAGE) 0x095E) +#define HID_USAGE_SENSORS_ACTIVITY_STATE_NO_STATE_CHANGE ((USAGE) 0x0960) +#define HID_USAGE_SENSORS_ACTIVITY_STATE_START_ACTIVITY ((USAGE) 0x0961) +#define HID_USAGE_SENSORS_ACTIVITY_STATE_END_ACTIVITY ((USAGE) 0x0962) +#define HID_USAGE_SENSORS_EXPONENT_0 ((USAGE) 0x0970) +#define HID_USAGE_SENSORS_EXPONENT_1 ((USAGE) 0x0971) +#define HID_USAGE_SENSORS_EXPONENT_2 ((USAGE) 0x0972) +#define HID_USAGE_SENSORS_EXPONENT_3 ((USAGE) 0x0973) +#define HID_USAGE_SENSORS_EXPONENT_4 ((USAGE) 0x0974) +#define HID_USAGE_SENSORS_EXPONENT_5 ((USAGE) 0x0975) +#define HID_USAGE_SENSORS_EXPONENT_6 ((USAGE) 0x0976) +#define HID_USAGE_SENSORS_EXPONENT_7 ((USAGE) 0x0977) +#define HID_USAGE_SENSORS_EXPONENT_8 ((USAGE) 0x0978) +#define HID_USAGE_SENSORS_EXPONENT_9 ((USAGE) 0x0979) +#define HID_USAGE_SENSORS_EXPONENT_A ((USAGE) 0x097A) +#define HID_USAGE_SENSORS_EXPONENT_B ((USAGE) 0x097B) +#define HID_USAGE_SENSORS_EXPONENT_C ((USAGE) 0x097C) +#define HID_USAGE_SENSORS_EXPONENT_D ((USAGE) 0x097D) +#define HID_USAGE_SENSORS_EXPONENT_E ((USAGE) 0x097E) +#define HID_USAGE_SENSORS_EXPONENT_F ((USAGE) 0x097F) +#define HID_USAGE_SENSORS_DEVICE_POSITION_UNKNOWN ((USAGE) 0x0980) +#define HID_USAGE_SENSORS_DEVICE_POSITION_UNCHANGED ((USAGE) 0x0981) +#define HID_USAGE_SENSORS_DEVICE_POSITION_ON_DESK ((USAGE) 0x0982) +#define HID_USAGE_SENSORS_DEVICE_POSITION_IN_HAND ((USAGE) 0x0983) +#define HID_USAGE_SENSORS_DEVICE_POSITION_MOVING_IN_BAG ((USAGE) 0x0984) +#define HID_USAGE_SENSORS_DEVICE_POSITION_STATIONARY_IN_BAG ((USAGE) 0x0985) +#define HID_USAGE_SENSORS_STEP_TYPE_UNKNOWN ((USAGE) 0x0990) +#define HID_USAGE_SENSORS_STEP_TYPE_WALKING ((USAGE) 0x0991) +#define HID_USAGE_SENSORS_STEP_TYPE_RUNNING ((USAGE) 0x0992) +#define HID_USAGE_SENSORS_GESTURE_STATE_UNKNOWN ((USAGE) 0x09A0) +#define HID_USAGE_SENSORS_GESTURE_STATE_STARTED ((USAGE) 0x09A1) +#define HID_USAGE_SENSORS_GESTURE_STATE_COMPLETED ((USAGE) 0x09A2) +#define HID_USAGE_SENSORS_GESTURE_STATE_CANCELLED ((USAGE) 0x09A3) +#define HID_USAGE_SENSORS_HINGE_FOLD_CONTRIBUTING_PANEL_UNKNOWN ((USAGE) 0x09B0) +#define HID_USAGE_SENSORS_HINGE_FOLD_CONTRIBUTING_PANEL_PANEL_1 ((USAGE) 0x09B1) +#define HID_USAGE_SENSORS_HINGE_FOLD_CONTRIBUTING_PANEL_PANEL_2 ((USAGE) 0x09B2) +#define HID_USAGE_SENSORS_HINGE_FOLD_CONTRIBUTING_PANEL_BOTH ((USAGE) 0x09B3) +#define HID_USAGE_SENSORS_HINGE_FOLD_TYPE_UNKNOWN ((USAGE) 0x09B4) +#define HID_USAGE_SENSORS_HINGE_FOLD_TYPE_INCREASING ((USAGE) 0x09B5) +#define HID_USAGE_SENSORS_HINGE_FOLD_TYPE_DECREASING ((USAGE) 0x09B6) +#define HID_USAGE_SENSORS_HUMAN_PRESENCE_DETECTION_TYPE_VENDORDEFINED_NONBIOMETRIC ((USAGE) 0x09C0) +#define HID_USAGE_SENSORS_HUMAN_PRESENCE_DETECTION_TYPE_VENDORDEFINED_BIOMETRIC ((USAGE) 0x09C1) +#define HID_USAGE_SENSORS_HUMAN_PRESENCE_DETECTION_TYPE_FACIAL_BIOMETRIC ((USAGE) 0x09C2) +#define HID_USAGE_SENSORS_HUMAN_PRESENCE_DETECTION_TYPE_AUDIO_BIOMETRIC ((USAGE) 0x09C3) +#define HID_USAGE_SENSORS_MODIFIER_CHANGE_SENSITIVITY_ABSOLUTE ((USAGE) 0x1000) +#define HID_USAGE_SENSORS_MODIFIER_MAXIMUM ((USAGE) 0x2000) +#define HID_USAGE_SENSORS_MODIFIER_MINIMUM ((USAGE) 0x3000) +#define HID_USAGE_SENSORS_MODIFIER_ACCURACY ((USAGE) 0x4000) +#define HID_USAGE_SENSORS_MODIFIER_RESOLUTION ((USAGE) 0x5000) +#define HID_USAGE_SENSORS_MODIFIER_THRESHOLD_HIGH ((USAGE) 0x6000) +#define HID_USAGE_SENSORS_MODIFIER_THRESHOLD_LOW ((USAGE) 0x7000) +#define HID_USAGE_SENSORS_MODIFIER_CALIBRATION_OFFSET ((USAGE) 0x8000) +#define HID_USAGE_SENSORS_MODIFIER_CALIBRATION_MULTIPLIER ((USAGE) 0x9000) +#define HID_USAGE_SENSORS_MODIFIER_REPORT_INTERVAL ((USAGE) 0xA000) +#define HID_USAGE_SENSORS_MODIFIER_FREQUENCY_MAX ((USAGE) 0xB000) +#define HID_USAGE_SENSORS_MODIFIER_PERIOD_MAX ((USAGE) 0xC000) +#define HID_USAGE_SENSORS_MODIFIER_CHANGE_SENSITIVITY_PERCENT_OF_RANGE ((USAGE) 0xD000) +#define HID_USAGE_SENSORS_MODIFIER_CHANGE_SENSITIVITY_PERCENT_RELATIVE ((USAGE) 0xE000) +#define HID_USAGE_SENSORS_MODIFIER_VENDOR_RESERVED ((USAGE) 0xF000) + +// +// Simulation Controls Page (0x02) +// +#define HID_USAGE_SIMULATION_FLIGHT_SIMULATION_DEVICE ((USAGE) 0x0001) +#define HID_USAGE_SIMULATION_AUTOMOBILE_SIMULATION_DEVICE ((USAGE) 0x0002) +#define HID_USAGE_SIMULATION_TANK_SIMULATION_DEVICE ((USAGE) 0x0003) +#define HID_USAGE_SIMULATION_SPACESHIP_SIMULATION_DEVICE ((USAGE) 0x0004) +#define HID_USAGE_SIMULATION_SUBMARINE_SIMULATION_DEVICE ((USAGE) 0x0005) +#define HID_USAGE_SIMULATION_SAILING_SIMULATION_DEVICE ((USAGE) 0x0006) +#define HID_USAGE_SIMULATION_MOTORCYCLE_SIMULATION_DEVICE ((USAGE) 0x0007) +#define HID_USAGE_SIMULATION_SPORTS_SIMULATION_DEVICE ((USAGE) 0x0008) +#define HID_USAGE_SIMULATION_AIRPLANE_SIMULATION_DEVICE ((USAGE) 0x0009) +#define HID_USAGE_SIMULATION_HELICOPTER_SIMULATION_DEVICE ((USAGE) 0x000A) +#define HID_USAGE_SIMULATION_MAGIC_CARPET_SIMULATION_DEVICE ((USAGE) 0x000B) +#define HID_USAGE_SIMULATION_BICYCLE_SIMULATION_DEVICE ((USAGE) 0x000C) +#define HID_USAGE_SIMULATION_FLIGHT_CONTROL_STICK ((USAGE) 0x0020) +#define HID_USAGE_SIMULATION_FLIGHT_STICK ((USAGE) 0x0021) +#define HID_USAGE_SIMULATION_CYCLIC_CONTROL ((USAGE) 0x0022) +#define HID_USAGE_SIMULATION_CYCLIC_TRIM ((USAGE) 0x0023) +#define HID_USAGE_SIMULATION_FLIGHT_YOKE ((USAGE) 0x0024) +#define HID_USAGE_SIMULATION_TRACK_CONTROL ((USAGE) 0x0025) +#define HID_USAGE_SIMULATION_AILERON ((USAGE) 0x00B0) +#define HID_USAGE_SIMULATION_AILERON_TRIM ((USAGE) 0x00B1) +#define HID_USAGE_SIMULATION_ANTI_TORQUE_CONTROL ((USAGE) 0x00B2) +#define HID_USAGE_SIMULATION_AUTOPIOLOT_ENABLE ((USAGE) 0x00B3) +#define HID_USAGE_SIMULATION_CHAFF_RELEASE ((USAGE) 0x00B4) +#define HID_USAGE_SIMULATION_COLLECTIVE_CONTROL ((USAGE) 0x00B5) +#define HID_USAGE_SIMULATION_DIVE_BRAKE ((USAGE) 0x00B6) +#define HID_USAGE_SIMULATION_ELECTRONIC_COUNTERMEASURES ((USAGE) 0x00B7) +#define HID_USAGE_SIMULATION_ELEVATOR ((USAGE) 0x00B8) +#define HID_USAGE_SIMULATION_ELEVATOR_TRIM ((USAGE) 0x00B9) +#define HID_USAGE_SIMULATION_RUDDER ((USAGE) 0x00BA) +#define HID_USAGE_SIMULATION_THROTTLE ((USAGE) 0x00BB) +#define HID_USAGE_SIMULATION_FLIGHT_COMMUNICATIONS ((USAGE) 0x00BC) +#define HID_USAGE_SIMULATION_FLARE_RELEASE ((USAGE) 0x00BD) +#define HID_USAGE_SIMULATION_LANDING_GEAR ((USAGE) 0x00BE) +#define HID_USAGE_SIMULATION_TOE_BRAKE ((USAGE) 0x00BF) +#define HID_USAGE_SIMULATION_TRIGGER ((USAGE) 0x00C0) +#define HID_USAGE_SIMULATION_WEAPONS_ARM ((USAGE) 0x00C1) +#define HID_USAGE_SIMULATION_WEAPONS_SELECT ((USAGE) 0x00C2) +#define HID_USAGE_SIMULATION_WING_FLAPS ((USAGE) 0x00C3) +#define HID_USAGE_SIMULATION_ACCELERATOR ((USAGE) 0x00C4) +#define HID_USAGE_SIMULATION_BRAKE ((USAGE) 0x00C5) +#define HID_USAGE_SIMULATION_CLUTCH ((USAGE) 0x00C6) +#define HID_USAGE_SIMULATION_SHIFTER ((USAGE) 0x00C7) +#define HID_USAGE_SIMULATION_STEERING ((USAGE) 0x00C8) +#define HID_USAGE_SIMULATION_TURRET_DIRECTION ((USAGE) 0x00C9) +#define HID_USAGE_SIMULATION_BARREL_ELEVATION ((USAGE) 0x00CA) +#define HID_USAGE_SIMULATION_DIVE_PLANE ((USAGE) 0x00CB) +#define HID_USAGE_SIMULATION_BALLAST ((USAGE) 0x00CC) +#define HID_USAGE_SIMULATION_BICYCLE_CRANK ((USAGE) 0x00CD) +#define HID_USAGE_SIMULATION_HANDLE_BARS ((USAGE) 0x00CE) +#define HID_USAGE_SIMULATION_FRONT_BRAKE ((USAGE) 0x00CF) +#define HID_USAGE_SIMULATION_REAR_BRAKE ((USAGE) 0x00D0) + +// +// SoC (System on Chip) Page (0x11) +// +#define HID_USAGE_SOC_SOC_CONTROL ((USAGE) 0x0001) +#define HID_USAGE_SOC_FIRMWARE_TRANSFER ((USAGE) 0x0002) +#define HID_USAGE_SOC_FIRMWARE_FILE_ID ((USAGE) 0x0003) +#define HID_USAGE_SOC_FILE_OFFSET_IN_BYTES ((USAGE) 0x0004) +#define HID_USAGE_SOC_FILE_TRANSFER_SIZE_MAX_IN_BYTES ((USAGE) 0x0005) +#define HID_USAGE_SOC_FILE_PAYLOAD ((USAGE) 0x0006) +#define HID_USAGE_SOC_FILE_PAYLOAD_SIZE_IN_BYTES ((USAGE) 0x0007) +#define HID_USAGE_SOC_FILE_PAYLOAD_CONTAINS_LAST_BYTES ((USAGE) 0x0008) +#define HID_USAGE_SOC_FILE_TRANSFER_STOP ((USAGE) 0x0009) +#define HID_USAGE_SOC_FILE_TRANSFER_TILL_END ((USAGE) 0x000A) + +// +// Sport Controls Page (0x04) +// +#define HID_USAGE_SPORT_BASEBALL_BAT ((USAGE) 0x0001) +#define HID_USAGE_SPORT_GOLF_CLUB ((USAGE) 0x0002) +#define HID_USAGE_SPORT_ROWING_MACHINE ((USAGE) 0x0003) +#define HID_USAGE_SPORT_TREADMILL ((USAGE) 0x0004) +#define HID_USAGE_SPORT_OAR ((USAGE) 0x0030) +#define HID_USAGE_SPORT_SLOPE ((USAGE) 0x0031) +#define HID_USAGE_SPORT_RATE ((USAGE) 0x0032) +#define HID_USAGE_SPORT_STICK_SPEED ((USAGE) 0x0033) +#define HID_USAGE_SPORT_STICK_FACE_ANGLE ((USAGE) 0x0034) +#define HID_USAGE_SPORT_HEEL_TOE ((USAGE) 0x0035) +#define HID_USAGE_SPORT_FOLLOW_THROUGH ((USAGE) 0x0036) +#define HID_USAGE_SPORT_TEMPO ((USAGE) 0x0037) +#define HID_USAGE_SPORT_STICK_TYPE ((USAGE) 0x0038) +#define HID_USAGE_SPORT_HEIGHT ((USAGE) 0x0039) +#define HID_USAGE_SPORT_PUTTER ((USAGE) 0x0050) +#define HID_USAGE_SPORT_1_IRON ((USAGE) 0x0051) +#define HID_USAGE_SPORT_2_IRON ((USAGE) 0x0052) +#define HID_USAGE_SPORT_3_IRON ((USAGE) 0x0053) +#define HID_USAGE_SPORT_4_IRON ((USAGE) 0x0054) +#define HID_USAGE_SPORT_5_IRON ((USAGE) 0x0055) +#define HID_USAGE_SPORT_6_IRON ((USAGE) 0x0056) +#define HID_USAGE_SPORT_7_IRON ((USAGE) 0x0057) +#define HID_USAGE_SPORT_8_IRON ((USAGE) 0x0058) +#define HID_USAGE_SPORT_9_IRON ((USAGE) 0x0059) +#define HID_USAGE_SPORT_10_IRON ((USAGE) 0x005A) +#define HID_USAGE_SPORT_11_IRON ((USAGE) 0x005B) +#define HID_USAGE_SPORT_SAND_WEDGE ((USAGE) 0x005C) +#define HID_USAGE_SPORT_LOFT_WEDGE ((USAGE) 0x005D) +#define HID_USAGE_SPORT_POWER_WEDGE ((USAGE) 0x005E) +#define HID_USAGE_SPORT_1_WOOD ((USAGE) 0x005F) +#define HID_USAGE_SPORT_3_WOOD ((USAGE) 0x0060) +#define HID_USAGE_SPORT_5_WOOD ((USAGE) 0x0061) +#define HID_USAGE_SPORT_7_WOOD ((USAGE) 0x0062) +#define HID_USAGE_SPORT_9_WOOD ((USAGE) 0x0063) + +// +// Telephony Device Page (0x0B) +// +#define HID_USAGE_TELEPHONY_PHONE ((USAGE) 0x0001) +#define HID_USAGE_TELEPHONY_ANSWERING_MACHINE ((USAGE) 0x0002) +#define HID_USAGE_TELEPHONY_MESSAGE_CONTROLS ((USAGE) 0x0003) +#define HID_USAGE_TELEPHONY_HANDSET ((USAGE) 0x0004) +#define HID_USAGE_TELEPHONY_HEADSET ((USAGE) 0x0005) +#define HID_USAGE_TELEPHONY_KEYPAD ((USAGE) 0x0006) +#define HID_USAGE_TELEPHONY_PROGRAMMABLE_BUTTON ((USAGE) 0x0007) +#define HID_USAGE_TELEPHONY_HOOK_SWITCH ((USAGE) 0x0020) +#define HID_USAGE_TELEPHONY_FLASH ((USAGE) 0x0021) +#define HID_USAGE_TELEPHONY_FEATURE ((USAGE) 0x0022) +#define HID_USAGE_TELEPHONY_HOLD ((USAGE) 0x0023) +#define HID_USAGE_TELEPHONY_REDIAL ((USAGE) 0x0024) +#define HID_USAGE_TELEPHONY_TRANSFER ((USAGE) 0x0025) +#define HID_USAGE_TELEPHONY_DROP ((USAGE) 0x0026) +#define HID_USAGE_TELEPHONY_PARK ((USAGE) 0x0027) +#define HID_USAGE_TELEPHONY_FORWARD_CALLS ((USAGE) 0x0028) +#define HID_USAGE_TELEPHONY_ALTERNATE_FUNCTION ((USAGE) 0x0029) +#define HID_USAGE_TELEPHONY_LINE ((USAGE) 0x002A) +#define HID_USAGE_TELEPHONY_SPEAKER_PHONE ((USAGE) 0x002B) +#define HID_USAGE_TELEPHONY_CONFERENCE ((USAGE) 0x002C) +#define HID_USAGE_TELEPHONY_RING_ENABLE ((USAGE) 0x002D) +#define HID_USAGE_TELEPHONY_RING_SELECT ((USAGE) 0x002E) +#define HID_USAGE_TELEPHONY_PHONE_MUTE ((USAGE) 0x002F) +#define HID_USAGE_TELEPHONY_CALLER_ID ((USAGE) 0x0030) +#define HID_USAGE_TELEPHONY_SEND ((USAGE) 0x0031) +#define HID_USAGE_TELEPHONY_SPEED_DIAL ((USAGE) 0x0050) +#define HID_USAGE_TELEPHONY_STORE_NUMBER ((USAGE) 0x0051) +#define HID_USAGE_TELEPHONY_RECALL_NUMBER ((USAGE) 0x0052) +#define HID_USAGE_TELEPHONY_PHONE_DIRECTORY ((USAGE) 0x0053) +#define HID_USAGE_TELEPHONY_VOICE_MAIL ((USAGE) 0x0070) +#define HID_USAGE_TELEPHONY_SCREEN_CALLS ((USAGE) 0x0071) +#define HID_USAGE_TELEPHONY_DO_NOT_DISTURB ((USAGE) 0x0072) +#define HID_USAGE_TELEPHONY_MESSAGE ((USAGE) 0x0073) +#define HID_USAGE_TELEPHONY_ANSWER_ONOFF ((USAGE) 0x0074) +#define HID_USAGE_TELEPHONY_INSIDE_DIAL_TONE ((USAGE) 0x0090) +#define HID_USAGE_TELEPHONY_OUTSIDE_DIAL_TONE ((USAGE) 0x0091) +#define HID_USAGE_TELEPHONY_INSIDE_RING_TONE ((USAGE) 0x0092) +#define HID_USAGE_TELEPHONY_OUTSIDE_RING_TONE ((USAGE) 0x0093) +#define HID_USAGE_TELEPHONY_PRIORITY_RING_TONE ((USAGE) 0x0094) +#define HID_USAGE_TELEPHONY_INSIDE_RINGBACK ((USAGE) 0x0095) +#define HID_USAGE_TELEPHONY_PRIORITY_RINGBACK ((USAGE) 0x0096) +#define HID_USAGE_TELEPHONY_LINE_BUSY_TONE ((USAGE) 0x0097) +#define HID_USAGE_TELEPHONY_REORDER_TONE ((USAGE) 0x0098) +#define HID_USAGE_TELEPHONY_CALL_WAITING_TONE ((USAGE) 0x0099) +#define HID_USAGE_TELEPHONY_CONFIRMATION_TONE_1 ((USAGE) 0x009A) +#define HID_USAGE_TELEPHONY_CONFIRMATION_TONE_2 ((USAGE) 0x009B) +#define HID_USAGE_TELEPHONY_TONES_OFF ((USAGE) 0x009C) +#define HID_USAGE_TELEPHONY_OUTSIDE_RINGBACK ((USAGE) 0x009D) +#define HID_USAGE_TELEPHONY_RINGER ((USAGE) 0x009E) +#define HID_USAGE_TELEPHONY_PHONE_KEY_0 ((USAGE) 0x00B0) +#define HID_USAGE_TELEPHONY_PHONE_KEY_1 ((USAGE) 0x00B1) +#define HID_USAGE_TELEPHONY_PHONE_KEY_2 ((USAGE) 0x00B2) +#define HID_USAGE_TELEPHONY_PHONE_KEY_3 ((USAGE) 0x00B3) +#define HID_USAGE_TELEPHONY_PHONE_KEY_4 ((USAGE) 0x00B4) +#define HID_USAGE_TELEPHONY_PHONE_KEY_5 ((USAGE) 0x00B5) +#define HID_USAGE_TELEPHONY_PHONE_KEY_6 ((USAGE) 0x00B6) +#define HID_USAGE_TELEPHONY_PHONE_KEY_7 ((USAGE) 0x00B7) +#define HID_USAGE_TELEPHONY_PHONE_KEY_8 ((USAGE) 0x00B8) +#define HID_USAGE_TELEPHONY_PHONE_KEY_9 ((USAGE) 0x00B9) +#define HID_USAGE_TELEPHONY_PHONE_KEY_STAR ((USAGE) 0x00BA) +#define HID_USAGE_TELEPHONY_PHONE_KEY_POUND ((USAGE) 0x00BB) +#define HID_USAGE_TELEPHONY_PHONE_KEY_A ((USAGE) 0x00BC) +#define HID_USAGE_TELEPHONY_PHONE_KEY_B ((USAGE) 0x00BD) +#define HID_USAGE_TELEPHONY_PHONE_KEY_C ((USAGE) 0x00BE) +#define HID_USAGE_TELEPHONY_PHONE_KEY_D ((USAGE) 0x00BF) +#define HID_USAGE_TELEPHONY_PHONE_CALL_HISTORY_KEY ((USAGE) 0x00C0) +#define HID_USAGE_TELEPHONY_PHONE_CALLER_ID_KEY ((USAGE) 0x00C1) +#define HID_USAGE_TELEPHONY_PHONE_SETTINGS_KEY ((USAGE) 0x00C2) +#define HID_USAGE_TELEPHONY_HOST_CONTROL ((USAGE) 0x00F0) +#define HID_USAGE_TELEPHONY_HOST_AVAILABLE ((USAGE) 0x00F1) +#define HID_USAGE_TELEPHONY_HOST_CALL_ACTIVE ((USAGE) 0x00F2) +#define HID_USAGE_TELEPHONY_ACTIVATE_HANDSET_AUDIO ((USAGE) 0x00F3) +#define HID_USAGE_TELEPHONY_RING_TYPE ((USAGE) 0x00F4) +#define HID_USAGE_TELEPHONY_REDIALABLE_PHONE_NUMBER ((USAGE) 0x00F5) +#define HID_USAGE_TELEPHONY_STOP_RING_TONE ((USAGE) 0x00F8) +#define HID_USAGE_TELEPHONY_PSTN_RING_TONE ((USAGE) 0x00F9) +#define HID_USAGE_TELEPHONY_HOST_RING_TONE ((USAGE) 0x00FA) +#define HID_USAGE_TELEPHONY_ALERT_SOUND_ERROR ((USAGE) 0x00FB) +#define HID_USAGE_TELEPHONY_ALERT_SOUND_CONFIRM ((USAGE) 0x00FC) +#define HID_USAGE_TELEPHONY_ALERT_SOUND_NOTIFICATION ((USAGE) 0x00FD) +#define HID_USAGE_TELEPHONY_SILENT_RING ((USAGE) 0x00FE) +#define HID_USAGE_TELEPHONY_EMAIL_MESSAGE_WAITING ((USAGE) 0x0108) +#define HID_USAGE_TELEPHONY_VOICEMAIL_MESSAGE_WAITING ((USAGE) 0x0109) +#define HID_USAGE_TELEPHONY_HOST_HOLD ((USAGE) 0x010A) +#define HID_USAGE_TELEPHONY_INCOMING_CALL_HISTORY_COUNT ((USAGE) 0x0110) +#define HID_USAGE_TELEPHONY_OUTGOING_CALL_HISTORY_COUNT ((USAGE) 0x0111) +#define HID_USAGE_TELEPHONY_INCOMING_CALL_HISTORY ((USAGE) 0x0112) +#define HID_USAGE_TELEPHONY_OUTGOING_CALL_HISTORY ((USAGE) 0x0113) +#define HID_USAGE_TELEPHONY_PHONE_LOCALE ((USAGE) 0x0114) +#define HID_USAGE_TELEPHONY_PHONE_TIME_SECOND ((USAGE) 0x0140) +#define HID_USAGE_TELEPHONY_PHONE_TIME_MINUTE ((USAGE) 0x0141) +#define HID_USAGE_TELEPHONY_PHONE_TIME_HOUR ((USAGE) 0x0142) +#define HID_USAGE_TELEPHONY_PHONE_DATE_DAY ((USAGE) 0x0143) +#define HID_USAGE_TELEPHONY_PHONE_DATE_MONTH ((USAGE) 0x0144) +#define HID_USAGE_TELEPHONY_PHONE_DATE_YEAR ((USAGE) 0x0145) +#define HID_USAGE_TELEPHONY_HANDSET_NICKNAME ((USAGE) 0x0146) +#define HID_USAGE_TELEPHONY_ADDRESS_BOOK_ID ((USAGE) 0x0147) +#define HID_USAGE_TELEPHONY_CALL_DURATION ((USAGE) 0x014A) +#define HID_USAGE_TELEPHONY_DUAL_MODE_PHONE ((USAGE) 0x014B) + +// +// Unicode Page (0x10) +// +// There is no need to label these usages. +// + +// +// VESA Virtual Controls Page (0x82) +// +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_DEGAUSS ((USAGE) 0x0001) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_BRIGHTNESS ((USAGE) 0x0010) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_CONTRAST ((USAGE) 0x0012) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_RED_VIDEO_GAIN ((USAGE) 0x0016) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_GREEN_VIDEO_GAIN ((USAGE) 0x0018) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_BLUE_VIDEO_GAIN ((USAGE) 0x001A) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_FOCUS ((USAGE) 0x001C) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_POSITION ((USAGE) 0x0020) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_SIZE ((USAGE) 0x0022) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_PINCUSHION ((USAGE) 0x0024) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_PINCUSHION_BALANCE ((USAGE) 0x0026) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_MISCONVERGENCE ((USAGE) 0x0028) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_LINEARITY ((USAGE) 0x002A) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_LINEARITY_BALANCE ((USAGE) 0x002C) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_POSITION ((USAGE) 0x0030) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_SIZE ((USAGE) 0x0032) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_PINCUSHION ((USAGE) 0x0034) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_PINCUSHION_BALANCE ((USAGE) 0x0036) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_MISCONVERGENCE ((USAGE) 0x0038) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_LINEARITY ((USAGE) 0x003A) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_LINEARITY_BALANCE ((USAGE) 0x003C) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_PARALLELOGRAM_DISTORTION_KEY_BALANCE ((USAGE) 0x0040) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_TRAPEZOIDAL_DISTORTION_KEY ((USAGE) 0x0042) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_TILT_ROTATION ((USAGE) 0x0044) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_TOP_CORNER_DISTORTION_CONTROL ((USAGE) 0x0046) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_TOP_CORNER_DISTORTION_BALANCE ((USAGE) 0x0048) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_BOTTOM_CORNER_DISTORTION_CONTROL ((USAGE) 0x004A) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_BOTTOM_CORNER_DISTORTION_BALANCE ((USAGE) 0x004C) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_MOIRE ((USAGE) 0x0056) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_MOIRE ((USAGE) 0x0058) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_INPUT_LEVEL_SELECT ((USAGE) 0x005E) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_INPUT_SOURCE_SELECT ((USAGE) 0x0060) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_RED_VIDEO_BLACK_LEVEL ((USAGE) 0x006C) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_GREEN_VIDEO_BLACK_LEVEL ((USAGE) 0x006E) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_BLUE_VIDEO_BLACK_LEVEL ((USAGE) 0x0070) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_AUTO_SIZE_CENTER ((USAGE) 0x00A2) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_POLARITY_HORIZONTAL_SYNCHRONIZATION ((USAGE) 0x00A4) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_POLARITY_VERTICAL_SYNCHRONIZATION ((USAGE) 0x00A6) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_SYNCHRONIZATION_TYPE ((USAGE) 0x00A8) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_SCREEN_ORIENTATION ((USAGE) 0x00AA) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_HORIZONTAL_FREQUENCY ((USAGE) 0x00AC) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_VERTICAL_FREQUENCY ((USAGE) 0x00AE) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_SETTINGS ((USAGE) 0x00B0) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_ON_SCREEN_DISPLAY ((USAGE) 0x00CA) +#define HID_USAGE_VESA_VIRTUAL_CONTROLS_STEREO_MODE ((USAGE) 0x00D4) + +// +// VR Controls Page (0x03) +// +#define HID_USAGE_VR_BELT ((USAGE) 0x0001) +#define HID_USAGE_VR_BODY_SUIT ((USAGE) 0x0002) +#define HID_USAGE_VR_FLEXOR ((USAGE) 0x0003) +#define HID_USAGE_VR_GLOVE ((USAGE) 0x0004) +#define HID_USAGE_VR_HEAD_TRACKER ((USAGE) 0x0005) +#define HID_USAGE_VR_HEAD_MOUNTED_DISPLAY ((USAGE) 0x0006) +#define HID_USAGE_VR_HAND_TRACKER ((USAGE) 0x0007) +#define HID_USAGE_VR_OCULOMETER ((USAGE) 0x0008) +#define HID_USAGE_VR_VEST ((USAGE) 0x0009) +#define HID_USAGE_VR_ANIMATRONIC_DEVICE ((USAGE) 0x000A) +#define HID_USAGE_VR_STEREO_ENABLE ((USAGE) 0x0020) +#define HID_USAGE_VR_DISPLAY_ENABLE ((USAGE) 0x0021) + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hvsocket.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hvsocket.h new file mode 100644 index 0000000000000000000000000000000000000000..3d157da49e4a729b1969d44ad5094fa6db65a5a5 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hvsocket.h @@ -0,0 +1,182 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + HvSocket.h + +Abstract: + + This file contains the core definitions for the Hyper-V + socket address family that can be used by both user-mode and + kernel mode modules. + + Reference AF_HYPERV in ws2def.h + +--*/ + +#ifdef _MSC_VER +#pragma once +#endif //_MSC_VER + +#include +#include + +// +// Hyper-v Socket options. +// + +// +// Following options are available for Socket option level +// HV_PROTOCOL_RAW: +// + +// +// HVSOCKET_CONNECT_TIMEOUT: +// Input: +// Type: ULONG. +// Description: +// The timeout in milliseconds. +// +#define HVSOCKET_CONNECT_TIMEOUT 0x01 + +// +// The maximum connect timeout is 5 minutes. +// +#define HVSOCKET_CONNECT_TIMEOUT_MAX 300000 + +// +// HVSOCKET_CONNECTED_SUSPEND: +// Input: +// Type: ULONG. +// Description: +// Set socket connected suspend flag. Non-zero value indicates the socket will not disconnect +// on VM pause. +// +#define HVSOCKET_CONNECTED_SUSPEND 0x04 + +// +// HVSOCKET_HIGH_VTL: +// Input: +// Type: ULONG. +// Description: +// Set socket high VTL flag. Non-zero value set on a host socket indicates that the socket will +// connect to guest VTL 2. +// +#define HVSOCKET_HIGH_VTL 0x08 + +// +// Well-known GUIDs. +// +DEFINE_GUID(HV_GUID_ZERO, 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00); +DEFINE_GUID(HV_GUID_BROADCAST, 0xFFFFFFFF, 0xFFFF, 0xFFFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF); + +// +// HV_GUID_WILDCARD: +// +// Wildcard address. Listeners should bind to this VmId to accept +// connection from all partitions. +// +// 00000000-0000-0000-0000-000000000000 +// +#define HV_GUID_WILDCARD HV_GUID_ZERO + +// +// HV_GUID_CHILDREN: +// +// Wildcard address for children. Listeners should bind to this VmId +// to accept connection from its children. +// +// 90db8b89-0d35-4f79-8ce9-49ea0ac8b7cd +// + +DEFINE_GUID(HV_GUID_CHILDREN, 0x90db8b89, 0x0d35, 0x4f79, 0x8c, 0xe9, 0x49, 0xea, 0x0a, 0xc8, 0xb7, 0xcd); + +// +// HV_GUID_LOOPBACK: +// +// Loopback address. Using this VmId connects to the same partition as the connector. +// +// e0e16197-dd56-4a10-9195-5ee7a155a838 +// +DEFINE_GUID(HV_GUID_LOOPBACK, 0xe0e16197, 0xdd56, 0x4a10, 0x91, 0x95, 0x5e, 0xe7, 0xa1, 0x55, 0xa8, 0x38); + +// +// HV_GUID_PARENT: +// +// Parent address. Using this VmId connects to the parent partition of the connector. +// The parent of a virtual machine is its host. +// The parent of a hosted silo is the VM's host. (passthru) +// +// Listening on this VmId accepts connection from: +// Inside silos: silo host partition. +// Inside hosted silo: host of the VM. +// Inside VM: VM host. +// Physical host: Not supported. +// +// a42e7cda-d03f-480c-9cc2-a4de20abb878 +// +DEFINE_GUID(HV_GUID_PARENT, 0xa42e7cda, 0xd03f, 0x480c, 0x9c, 0xc2, 0xa4, 0xde, 0x20, 0xab, 0xb8, 0x78); + +// +// HV_GUID_SILOHOST: +// +// Address of a silo's host partition. +// +// The silo host of a hosted silo is the utility VM. +// The silo host of a silo on a physical host is the physical host. +// +// 36bd0c5c-7276-4223-88ba-7d03b654c568 +// +DEFINE_GUID(HV_GUID_SILOHOST, 0x36bd0c5c, 0x7276, 0x4223, 0x88, 0xba, 0x7d, 0x03, 0xb6, 0x54, 0xc5, 0x68); + +// +// HV_GUID_VSOCK_TEMPLATE: +// +// Template to facilitate mapping between AF_HYPERV.ServiceId (GUID) and AF_VSOCK.port (uint32) +// Services offered to Linux guests must use a ServiceId that matches this template. +// +// Linux guests use AF_VSOCK to communicate to a Hyper-V host using Hyper-V Sockets. +// The following mappings from cid to VmId are included in the Linux Hyper-V Socket driver: +// VMADDR_CID_HOST (2) HV_GUID_PARENT +// VMADDR_CID_ANY (0xffffffff) HV_GUID_WILDCARD +// +// The Linux Hyper-V Socket driver will map the AF_VSOCK port to the Data1 value of a GUID where Data2, Data3, +// and Data4 match HV_GUID_VSOCK_TEMPLATE (i.e. -facb-11e6-bd58-64006a7986d3) +// Valid port mappings are 0-0x7FFFFFFF +// Here is a table of possible mappings from port to GUID: +// 0 00000000-facb-11e6-bd58-64006a7986d3 +// 1 00000001-facb-11e6-bd58-64006a7986d3 +// 50 00000032-facb-11e6-bd58-64006a7986d3 +// 2147483647 7fffffff-facb-11e6-bd58-64006a7986d3 +// +// 00000000-facb-11e6-bd58-64006a7986d3 +// +DEFINE_GUID(HV_GUID_VSOCK_TEMPLATE, 0x00000000, 0xfacb, 0x11e6, 0xbd, 0x58, 0x64, 0x00, 0x6a, 0x79, 0x86, 0xd3); + + + + +#define HV_PROTOCOL_RAW 1 + +typedef struct _SOCKADDR_HV +{ + ADDRESS_FAMILY Family; + USHORT Reserved; + GUID VmId; + GUID ServiceId; +}SOCKADDR_HV, *PSOCKADDR_HV; + + +#define HVSOCKET_ADDRESS_FLAG_PASSTHRU 0x00000001 + +typedef struct _HVSOCKET_ADDRESS_INFO +{ + GUID SystemId; + GUID VirtualMachineId; + GUID SiloId; + ULONG Flags; + +} HVSOCKET_ADDRESS_INFO, *PHVSOCKET_ADDRESS_INFO; + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hwn.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hwn.h new file mode 100644 index 0000000000000000000000000000000000000000..893a9938053b0f35aef46fc0c9e4c32138713687 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/hwn.h @@ -0,0 +1,140 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + hwn.h + +Abstract: + + Header file that defines structures, prototypes and definitions required + by consumers of Hardware Notification services. + +Environment: + + Kernel mode or User mode + +--*/ + +#ifndef __HWN_H__ +#define __HWN_H__ + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Define IOCTLs to get and set Hardware Notifications. +// + +#define IOCTL_HWN_SET_STATE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_HWN_GET_STATE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 1, METHOD_BUFFERED, FILE_READ_ACCESS | \ + FILE_WRITE_ACCESS) + +DEFINE_GUID (HWN_DEVINTERFACE, + 0x81ca6602, 0xdae3, 0x476f, 0x8e, 0x3a, 0x60, 0x76, 0x6b, 0x2f, 0xff, 0x1b); + +DEFINE_GUID (HWN_DEVINTERFACE_VIBRATOR, + 0x825e8fd3, 0x6467, 0x4a5b, 0xab, 0xfb, 0xbb, 0x01, 0x07, 0x34, 0xff, 0x4d); + +DEFINE_GUID (HWN_DEVINTERFACE_NLED, + 0x6b2a25e2, 0xaaf5, 0x482c, 0x99, 0xa5, 0x62, 0x05, 0xcd, 0xcc, 0x17, 0x6a); + +#define HWN_SUPPORTED 0xAAAA +#define HWN_NOT_SUPPORTED 0x5555 +#define HWN_CURRENT_MTE_NOT_SUPPORTED 0xFFFFFFFF + +// +// The various states devices can be set to +// + +typedef enum _HWN_STATE +{ + HWN_OFF = 0, + HWN_ON = 1, + HWN_BLINK = 2, + HWN_TOTAL_STATES +} HWN_STATE; + +// +// The various types of devices supported +// + +typedef enum _HWN_TYPE +{ + HWN_UNKNOWN = 0, + HWN_LED = 1, + HWN_VIBRATOR = 2, + HWN_TOTAL_TYPES +} HWN_TYPE; + +// +// Defines the capabilities or settings a client driver may support. +// Specifically, it is used as the index to HwNSettings[] member of the +// HWN_SETTINGS structure. +// + +typedef enum _HWN_SETTINGS_OPTIONS +{ + HWN_INTENSITY = 0, // HwN intensity (0 - 100%) + HWN_PERIOD = 1, // HwN period in milliseconds + HWN_DUTY_CYCLE = 2, // HwN duty cycle (0 - 100%) + HWN_CYCLE_COUNT = 3, // HwN number of repetitions of cycle + HWN_CYCLE_GRANULARITY = 4, // HwN adjustment granularity - read only + HWN_CURRENT_MTE_RESERVED = 5, // HwN device current in mA for MTE use only + HWN_TOTAL_SETTINGS +} HWN_SETTINGS_OPTIONS; + +// +// A structure for getting data from or setting data to a device +// + +typedef struct _HWN_SETTINGS +{ + ULONG HwNId; // HwN ID number, 0 is first + HWN_TYPE HwNType; // specifies type of a device + ULONG HwNSettings[HWN_TOTAL_SETTINGS]; // holds the current device's settings + HWN_STATE OffOnBlink; // 0-off, 1-on, 2-blink +} HWN_SETTINGS, *PHWN_SETTINGS; + +#define HWN_SETTINGS_SIZE (sizeof(HWN_SETTINGS)) + +// +// Defines a structure for a header of each data packet +// +// Data packet format: +// +// |-------------------| +// | HWN_HEADER | +// |-------------------| +// | HWN_SETTINGS[0] | +// |-------------------| +// | HWN_SETTINGS[1] | +// |-------------------| +// | HWN_SETTINGS[N] | +// |-------------------| +// + +typedef struct _HWN_HEADER +{ + ULONG HwNPayloadSize; //Total size of a payload + ULONG HwNPayloadVersion; //Version number of a payload + ULONG HwNRequests; //Number of requests in a payload + HWN_SETTINGS HwNSettingsInfo[ANYSIZE_ARRAY]; +} HWN_HEADER, *PHWN_HEADER; + +#define HWN_HEADER_SIZE (sizeof(HWN_HEADER)-sizeof(HWN_SETTINGS)) + +#ifdef __cplusplus +} +#endif + +#endif + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifdef.h new file mode 100644 index 0000000000000000000000000000000000000000..ca24e16f4d2f9e148a7e98cf406bffc9e41421c8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifdef.h @@ -0,0 +1,394 @@ + + +#ifndef _IFDEF_ +#define _IFDEF_ +#pragma once +#include + +#pragma region Desktop Application or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Get definitions for IFTYPE and IF_ACCESS_TYPE. +// +#include + +// +// Define compartment ID type: +// +typedef UINT32 NET_IF_COMPARTMENT_ID, *PNET_IF_COMPARTMENT_ID; + +#define NET_IF_COMPARTMENT_ID_UNSPECIFIED (NET_IF_COMPARTMENT_ID)0 +#define NET_IF_COMPARTMENT_ID_PRIMARY (NET_IF_COMPARTMENT_ID)1 + +// +// Define NetworkGUID type: +// +typedef GUID NET_IF_NETWORK_GUID, *PNET_IF_NETWORK_GUID; + +typedef enum _NET_IF_OPER_STATUS // ifOperStatus +{ + NET_IF_OPER_STATUS_UP = 1, + NET_IF_OPER_STATUS_DOWN = 2, + NET_IF_OPER_STATUS_TESTING = 3, + NET_IF_OPER_STATUS_UNKNOWN = 4, + NET_IF_OPER_STATUS_DORMANT = 5, + NET_IF_OPER_STATUS_NOT_PRESENT = 6, + NET_IF_OPER_STATUS_LOWER_LAYER_DOWN = 7 +} NET_IF_OPER_STATUS, *PNET_IF_OPER_STATUS; + +typedef ULONG32 NET_IF_OBJECT_ID, *PNET_IF_OBJECT_ID; + +typedef enum _NET_IF_ADMIN_STATUS // ifAdminStatus +{ + NET_IF_ADMIN_STATUS_UP = 1, + NET_IF_ADMIN_STATUS_DOWN = 2, + NET_IF_ADMIN_STATUS_TESTING = 3 +} NET_IF_ADMIN_STATUS, *PNET_IF_ADMIN_STATUS; + + +// +// Flags to extend operational status +// +#define NET_IF_OPER_STATUS_DOWN_NOT_AUTHENTICATED 0x00000001 +#define NET_IF_OPER_STATUS_DOWN_NOT_MEDIA_CONNECTED 0x00000002 +#define NET_IF_OPER_STATUS_DORMANT_PAUSED 0x00000004 +#define NET_IF_OPER_STATUS_DORMANT_LOW_POWER 0x00000008 + +typedef UINT32 NET_IF_COMPARTMENT_SCOPE, *PNET_IF_COMPARTMENT_SCOPE; + +#define NET_IF_COMPARTMENT_SCOPE_UNSPECIFIED (NET_IF_COMPARTMENT_SCOPE)0 +#define NET_IF_COMPARTMENT_SCOPE_ALL ((NET_IF_COMPARTMENT_SCOPE)-1) + +#define NET_IF_OID_IF_ALIAS 0x00000001 // identifies the ifAlias string for an interface +#define NET_IF_OID_COMPARTMENT_ID 0x00000002 // identifies the compartment ID for an interface. +#define NET_IF_OID_NETWORK_GUID 0x00000003 // identifies the NetworkGuid for an interface. +#define NET_IF_OID_IF_ENTRY 0x00000004 // identifies statistics for an interface. + +// +// Define macros for an "unspecified" NetworkGUID value to be used in structures +// that haven't had the NET_LUID field filled in yet. +// +#define NET_SET_UNSPECIFIED_NETWORK_GUID(_pNetworkGuid) +#define NET_IS_UNSPECIFIED_NETWORK_GUID(_NetworkGuidValue) + +// +// To prevent collisions between user-assigned and system-assigned site-ids, +// we partition the site-id space into two: +// 1. User-Assigned: NET_SITEID_UNSPECIFIED < SiteId < NET_SITEID_MAXUSER +// 2. System-Assigned: NET_SITEID_MAXUSER < SiteId < NET_SITEID_MAXSYSTEM +// +// Note: A network's SiteId doesn't really need to be settable. +// 1. The network profile manager creates a network per network profile. +// 2. NDIS/IF assigns a unique SiteId to each network. +// +#define NET_SITEID_UNSPECIFIED (0) +#define NET_SITEID_MAXUSER (0x07ffffff) +#define NET_SITEID_MAXSYSTEM (0x0fffffff) +#ifndef MIDL_PASS +C_ASSERT(NET_SITEID_MAXUSER < NET_SITEID_MAXSYSTEM); +#endif + +typedef enum _NET_IF_RCV_ADDRESS_TYPE // ifRcvAddressType +{ + NET_IF_RCV_ADDRESS_TYPE_OTHER = 1, + NET_IF_RCV_ADDRESS_TYPE_VOLATILE = 2, + NET_IF_RCV_ADDRESS_TYPE_NON_VOLATILE = 3 +} NET_IF_RCV_ADDRESS_TYPE, *PNET_IF_RCV_ADDRESS_TYPE; + +typedef struct _NET_IF_RCV_ADDRESS_LH +{ + NET_IF_RCV_ADDRESS_TYPE ifRcvAddressType; + USHORT ifRcvAddressLength; + USHORT ifRcvAddressOffset; // from beginning of this struct +} NET_IF_RCV_ADDRESS_LH, *PNET_IF_RCV_ADDRESS_LH; + +typedef struct _NET_IF_ALIAS_LH +{ + USHORT ifAliasLength; // in bytes, of ifAlias string + USHORT ifAliasOffset; // in bytes, from beginning of this struct +} NET_IF_ALIAS_LH, *PNET_IF_ALIAS_LH; + +#pragma warning(push) +#pragma warning(disable:4214) // bit field types other than int +typedef union _NET_LUID_LH +{ + ULONG64 Value; + struct + { + ULONG64 Reserved:24; + ULONG64 NetLuidIndex:24; + ULONG64 IfType:16; // equal to IANA IF type + }Info; +} NET_LUID_LH, *PNET_LUID_LH; +#pragma warning(pop) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef NET_IF_RCV_ADDRESS_LH NET_IF_RCV_ADDRESS; +typedef NET_IF_RCV_ADDRESS* PNET_IF_RCV_ADDRESS; + +typedef NET_IF_ALIAS_LH NET_IF_ALIAS; +typedef NET_IF_ALIAS* PNET_IF_ALIAS; +#endif //NTDDI_VISTA + +// +// Need to make this visible on all platforms (for the purpose of IF_LUID). +// +typedef NET_LUID_LH NET_LUID; +typedef NET_LUID* PNET_LUID; + +// +// IF_LUID +// +// Define the locally unique datalink interface identifier type. +// This type is persistable. +// +typedef NET_LUID IF_LUID, *PIF_LUID; + + +typedef ULONG NET_IFINDEX, *PNET_IFINDEX; // Interface Index (ifIndex) +typedef UINT16 NET_IFTYPE, *PNET_IFTYPE; // Interface Type (IANA ifType) + +#define NET_IFINDEX_UNSPECIFIED (NET_IFINDEX)(0) // Not a valid ifIndex +#define NET_IFLUID_UNSPECIFIED (0) // Not a valid if Luid + +#ifndef __IF_INDEX_DEFINED__ +#define __IF_INDEX_DEFINED__ + +// +// IF_INDEX +// +// Define the interface index type. +// This type is not persistable. +// This must be unsigned (not an enum) to replace previous uses of +// an index that used a DWORD type. +// + +#endif // __IF_INDEX_DEFINED__ + +typedef NET_IFINDEX IF_INDEX, *PIF_INDEX; + + +typedef enum _NET_IF_CONNECTION_TYPE +{ + NET_IF_CONNECTION_DEDICATED = 1, + NET_IF_CONNECTION_PASSIVE = 2, + NET_IF_CONNECTION_DEMAND = 3, + NET_IF_CONNECTION_MAXIMUM = 4 +} NET_IF_CONNECTION_TYPE, *PNET_IF_CONNECTION_TYPE; + +// +// Types of tunnels (sub-type of IF_TYPE when IF_TYPE is IF_TYPE_TUNNEL). +// See http://www.iana.org/assignments/ianaiftype-mib. +// +typedef enum { + TUNNEL_TYPE_NONE = 0, + TUNNEL_TYPE_OTHER = 1, + TUNNEL_TYPE_DIRECT = 2, + TUNNEL_TYPE_6TO4 = 11, + TUNNEL_TYPE_ISATAP = 13, + TUNNEL_TYPE_TEREDO = 14, + TUNNEL_TYPE_IPHTTPS = 15, +} TUNNEL_TYPE, *PTUNNEL_TYPE; + +#define IFI_UNSPECIFIED NET_IFINDEX_UNSPECIFIED + +// +// Definitions for NET_IF_INFORMATION.Flags +// +#define NIIF_HARDWARE_INTERFACE 0x00000001 // Set iff hardware +#define NIIF_FILTER_INTERFACE 0x00000002 +#define NIIF_NDIS_RESERVED1 0x00000004 +#define NIIF_NDIS_RESERVED2 0x00000008 +#define NIIF_NDIS_RESERVED3 0x00000010 +#define NIIF_NDIS_WDM_INTERFACE 0x00000020 +#define NIIF_NDIS_ENDPOINT_INTERFACE 0x00000040 +#define NIIF_NDIS_ISCSI_INTERFACE 0x00000080 +#define NIIF_NDIS_RESERVED4 0x00000100 + +#define NIIF_WAN_TUNNEL_TYPE_UNKNOWN ((ULONG)(-1)) + +// +// Define datalink interface access types. +// +typedef enum _NET_IF_ACCESS_TYPE +{ + NET_IF_ACCESS_LOOPBACK = 1, + NET_IF_ACCESS_BROADCAST = 2, + NET_IF_ACCESS_POINT_TO_POINT = 3, + NET_IF_ACCESS_POINT_TO_MULTI_POINT = 4, + NET_IF_ACCESS_MAXIMUM = 5 +} NET_IF_ACCESS_TYPE, *PNET_IF_ACCESS_TYPE; + + +// +// Define datalink interface direction types. +// +typedef enum _NET_IF_DIRECTION_TYPE +{ + NET_IF_DIRECTION_SENDRECEIVE, + NET_IF_DIRECTION_SENDONLY, + NET_IF_DIRECTION_RECEIVEONLY, + NET_IF_DIRECTION_MAXIMUM +} NET_IF_DIRECTION_TYPE, *PNET_IF_DIRECTION_TYPE; + + +typedef enum _NET_IF_MEDIA_CONNECT_STATE +{ + MediaConnectStateUnknown, + MediaConnectStateConnected, + MediaConnectStateDisconnected +} NET_IF_MEDIA_CONNECT_STATE, *PNET_IF_MEDIA_CONNECT_STATE; + +#define NET_IF_LINK_SPEED_UNKNOWN ((ULONG64)(-1)) + +// +// Defines the duplex state of media +// +typedef enum _NET_IF_MEDIA_DUPLEX_STATE +{ + MediaDuplexStateUnknown, + MediaDuplexStateHalf, + MediaDuplexStateFull +} NET_IF_MEDIA_DUPLEX_STATE, *PNET_IF_MEDIA_DUPLEX_STATE; + + +// Special values for fields in NET_PHYSICAL_LOCATION +#define NIIF_BUS_NUMBER_UNKNOWN ((ULONG)(-1)) +#define NIIF_SLOT_NUMBER_UNKNOWN ((ULONG)(-1)) +#define NIIF_FUNCTION_NUMBER_UNKNOWN ((ULONG)(-1)) + +typedef struct _NET_PHYSICAL_LOCATION_LH +{ + ULONG BusNumber; // Physical location + ULONG SlotNumber; // ... for hardware + ULONG FunctionNumber; // ... devices. +} NET_PHYSICAL_LOCATION_LH, *PNET_PHYSICAL_LOCATION_LH; + +// +// maximum string size in -wchar- units +// +#define IF_MAX_STRING_SIZE 256 + +typedef struct _IF_COUNTED_STRING_LH +{ + _Field_range_(0, (IF_MAX_STRING_SIZE + 1) * sizeof(WCHAR)) + USHORT Length; // in -Bytes- + WCHAR String[IF_MAX_STRING_SIZE + 1]; +} IF_COUNTED_STRING_LH, *PIF_COUNTED_STRING_LH; + +#define IF_MAX_PHYS_ADDRESS_LENGTH 32 + +typedef struct _IF_PHYSICAL_ADDRESS_LH +{ + _Field_range_(0, IF_MAX_PHYS_ADDRESS_LENGTH) + USHORT Length; + UCHAR Address[IF_MAX_PHYS_ADDRESS_LENGTH]; +} IF_PHYSICAL_ADDRESS_LH, *PIF_PHYSICAL_ADDRESS_LH; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef NET_PHYSICAL_LOCATION_LH NET_PHYSICAL_LOCATION; +typedef NET_PHYSICAL_LOCATION* PNET_PHYSICAL_LOCATION; + +typedef IF_COUNTED_STRING_LH IF_COUNTED_STRING; +typedef IF_COUNTED_STRING* PIF_COUNTED_STRING; + +typedef IF_PHYSICAL_ADDRESS_LH IF_PHYSICAL_ADDRESS; +typedef IF_PHYSICAL_ADDRESS* PIF_PHYSICAL_ADDRESS; +#endif + + + +// +// IF_ADMINISTRATIVE_STATE +// +// Datalink Interface Administrative State. +// Indicates whether the interface has been administratively enabled. +// + +typedef enum _IF_ADMINISTRATIVE_STATE { + IF_ADMINISTRATIVE_DISABLED, + IF_ADMINISTRATIVE_ENABLED, + IF_ADMINISTRATIVE_DEMANDDIAL, +} IF_ADMINISTRATIVE_STATE, *PIF_ADMINISTRATIVE_STATE; + +// +// Note: Interface is Operational iff +// ((MediaSense is Connected) and (AdministrativeState is Enabled)) +// or +// ((MediaSense is Connected) and (AdministrativeState is OnDemand)) +// +// !Operational iff +// ((MediaSense != Connected) or (AdministrativeState is Disabled)) +// + +// +// OperStatus values from RFC 2863 +// +typedef enum { + IfOperStatusUp = 1, + IfOperStatusDown, + IfOperStatusTesting, + IfOperStatusUnknown, + IfOperStatusDormant, + IfOperStatusNotPresent, + IfOperStatusLowerLayerDown +} IF_OPER_STATUS; + +typedef struct _NDIS_INTERFACE_INFORMATION +{ + // + // rod fields + // + NET_IF_OPER_STATUS ifOperStatus; + ULONG ifOperStatusFlags; + NET_IF_MEDIA_CONNECT_STATE MediaConnectState; + NET_IF_MEDIA_DUPLEX_STATE MediaDuplexState; + ULONG ifMtu; + BOOLEAN ifPromiscuousMode; + BOOLEAN ifDeviceWakeUpEnable; + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; + + ULONG64 ifLastChange; + ULONG64 ifCounterDiscontinuityTime; + ULONG64 ifInUnknownProtos; + + // + // OID_GEN_STATISTICS + // + ULONG64 ifInDiscards; // OID_GEN_RCV_DISCARDS = OID_GEN_RCV_ERROR + OID_GEN_RCV_NO_BUFFER + ULONG64 ifInErrors; // OID_GEN_RCV_ERROR + ULONG64 ifHCInOctets; // OID_GEN_BYTES_RCV = OID_GEN_DIRECTED_BYTES_RCV + OID_GEN_MULTICAST_BYTES_RCV + OID_GEN_BROADCAST_BYTES_RCV + ULONG64 ifHCInUcastPkts; // OID_GEN_DIRECTED_FRAMES_RCV + ULONG64 ifHCInMulticastPkts; // OID_GEN_MULTICAST_FRAMES_RCV + ULONG64 ifHCInBroadcastPkts; // OID_GEN_BROADCAST_FRAMES_RCV + ULONG64 ifHCOutOctets; // OID_GEN_BYTES_XMIT = OID_GEN_DIRECTED_BYTES_XMIT + OID_GEN_MULTICAST_BYTES_XMIT + OID_GEN_BROADCAST_BYTES_XMIT + ULONG64 ifHCOutUcastPkts; // OID_GEN_DIRECTED_FRAMES_XMIT + ULONG64 ifHCOutMulticastPkts; // OID_GEN_MULTICAST_FRAMES_XMIT + ULONG64 ifHCOutBroadcastPkts; // OID_GEN_BROADCAST_FRAMES_XMIT + ULONG64 ifOutErrors; // OID_GEN_XMIT_ERROR + ULONG64 ifOutDiscards; // OID_GEN_XMIT_DISCARDS + ULONG64 ifHCInUcastOctets; // OID_GEN_DIRECTED_BYTES_RCV + ULONG64 ifHCInMulticastOctets; // OID_GEN_MULTICAST_BYTES_RCV + ULONG64 ifHCInBroadcastOctets; // OID_GEN_BROADCAST_BYTES_RCV + ULONG64 ifHCOutUcastOctets; // OID_GEN_DIRECTED_BYTES_XMIT + ULONG64 ifHCOutMulticastOctets; // OID_GEN_MULTICAST_BYTES_XMIT + ULONG64 ifHCOutBroadcastOctets; // OID_GEN_BROADCAST_BYTES_XMIT + NET_IF_COMPARTMENT_ID CompartmentId; + ULONG SupportedStatistics; +}NDIS_INTERFACE_INFORMATION, *PNDIS_INTERFACE_INFORMATION; + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _IFDEF_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifmib.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifmib.h new file mode 100644 index 0000000000000000000000000000000000000000..0a7c989bc07de338045d56895d9e5667832ac989 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ifmib.h @@ -0,0 +1,87 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + ifmib.h + +Abstract: + + This module contains the public definitions and structures for the + non-TCP/IP specific parts of MIB-II. These definitions were previously + in iprtrmib.h, which now includes this file. + +--*/ + +#ifndef _IFMIB_ +#define _IFMIB_ +#pragma once +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +#include + +#ifndef ANY_SIZE +#define ANY_SIZE 1 +#endif + +typedef struct _MIB_IFNUMBER +{ + DWORD dwValue; +} MIB_IFNUMBER, *PMIB_IFNUMBER; + + +// +// $REVIEW: This has always been defined as 8. However, this is not +// sufficient for all media types. +// +#define MAXLEN_PHYSADDR 8 + +#define MAXLEN_IFDESCR 256 + +#define MAX_INTERFACE_NAME_LEN 256 + +typedef struct _MIB_IFROW { + WCHAR wszName[MAX_INTERFACE_NAME_LEN]; + IF_INDEX dwIndex; + IFTYPE dwType; + DWORD dwMtu; + DWORD dwSpeed; + DWORD dwPhysAddrLen; + UCHAR bPhysAddr[MAXLEN_PHYSADDR]; + DWORD dwAdminStatus; + INTERNAL_IF_OPER_STATUS dwOperStatus; + DWORD dwLastChange; + DWORD dwInOctets; + DWORD dwInUcastPkts; + DWORD dwInNUcastPkts; + DWORD dwInDiscards; + DWORD dwInErrors; + DWORD dwInUnknownProtos; + DWORD dwOutOctets; + DWORD dwOutUcastPkts; + DWORD dwOutNUcastPkts; + DWORD dwOutDiscards; + DWORD dwOutErrors; + DWORD dwOutQLen; + DWORD dwDescrLen; + UCHAR bDescr[MAXLEN_IFDESCR]; +} MIB_IFROW, *PMIB_IFROW; + +typedef struct _MIB_IFTABLE { + DWORD dwNumEntries; + MIB_IFROW table[ANY_SIZE]; +} MIB_IFTABLE, *PMIB_IFTABLE; + +#define SIZEOF_IFTABLE(X) (FIELD_OFFSET(MIB_IFTABLE,table[0]) + \ + ((X) * sizeof(MIB_IFROW)) + ALIGN_SIZE) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _IFMIB_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.h new file mode 100644 index 0000000000000000000000000000000000000000..c23299d3db5bba1267082b378ce9af11e43ede65 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.h @@ -0,0 +1,913 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + + +#ifndef __iketypes_h__ +#define __iketypes_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +/* header files for imported files */ +#include "fwptypes.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_iketypes_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family or AppRuntime Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) +#pragma once +#pragma warning(push) +#pragma warning(disable:4668) +#pragma once +#pragma region Input Buffer SAL 1 compatibility macros +#pragma endregion Input Buffer SAL 1 compatibility macros +#pragma once +#pragma once +#pragma warning(pop) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif +typedef struct IPSEC_V4_UDP_ENCAPSULATION0_ IPSEC_V4_UDP_ENCAPSULATION0; + +typedef /* [v1_enum] */ +enum IKEEXT_KEY_MODULE_TYPE_ + { + IKEEXT_KEY_MODULE_IKE = 0, + IKEEXT_KEY_MODULE_AUTHIP = ( IKEEXT_KEY_MODULE_IKE + 1 ) , + IKEEXT_KEY_MODULE_IKEV2 = ( IKEEXT_KEY_MODULE_AUTHIP + 1 ) , + IKEEXT_KEY_MODULE_MAX = ( IKEEXT_KEY_MODULE_IKEV2 + 1 ) + } IKEEXT_KEY_MODULE_TYPE; + +typedef /* [v1_enum] */ +enum IKEEXT_AUTHENTICATION_METHOD_TYPE_ + { + IKEEXT_PRESHARED_KEY = 0, + IKEEXT_CERTIFICATE = ( IKEEXT_PRESHARED_KEY + 1 ) , + IKEEXT_KERBEROS = ( IKEEXT_CERTIFICATE + 1 ) , + IKEEXT_ANONYMOUS = ( IKEEXT_KERBEROS + 1 ) , + IKEEXT_SSL = ( IKEEXT_ANONYMOUS + 1 ) , + IKEEXT_NTLM_V2 = ( IKEEXT_SSL + 1 ) , + IKEEXT_IPV6_CGA = ( IKEEXT_NTLM_V2 + 1 ) , + IKEEXT_CERTIFICATE_ECDSA_P256 = ( IKEEXT_IPV6_CGA + 1 ) , + IKEEXT_CERTIFICATE_ECDSA_P384 = ( IKEEXT_CERTIFICATE_ECDSA_P256 + 1 ) , + IKEEXT_SSL_ECDSA_P256 = ( IKEEXT_CERTIFICATE_ECDSA_P384 + 1 ) , + IKEEXT_SSL_ECDSA_P384 = ( IKEEXT_SSL_ECDSA_P256 + 1 ) , + IKEEXT_EAP = ( IKEEXT_SSL_ECDSA_P384 + 1 ) , + IKEEXT_RESERVED = ( IKEEXT_EAP + 1 ) , + IKEEXT_AUTHENTICATION_METHOD_TYPE_MAX = ( IKEEXT_RESERVED + 1 ) + } IKEEXT_AUTHENTICATION_METHOD_TYPE; + +typedef /* [v1_enum] */ +enum IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE_ + { + IKEEXT_IMPERSONATION_NONE = 0, + IKEEXT_IMPERSONATION_SOCKET_PRINCIPAL = ( IKEEXT_IMPERSONATION_NONE + 1 ) , + IKEEXT_IMPERSONATION_MAX = ( IKEEXT_IMPERSONATION_SOCKET_PRINCIPAL + 1 ) + } IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE; + +typedef struct IKEEXT_PRESHARED_KEY_AUTHENTICATION0__ + { + FWP_BYTE_BLOB presharedKey; + } IKEEXT_PRESHARED_KEY_AUTHENTICATION0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_PSK_FLAG_LOCAL_AUTH_ONLY (0x00000001) +#define IKEEXT_PSK_FLAG_REMOTE_AUTH_ONLY (0x00000002) +typedef struct IKEEXT_PRESHARED_KEY_AUTHENTICATION1__ + { + FWP_BYTE_BLOB presharedKey; + UINT32 flags; + } IKEEXT_PRESHARED_KEY_AUTHENTICATION1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_CERT_FLAG_ENABLE_ACCOUNT_MAPPING (0x00000001) +#define IKEEXT_CERT_FLAG_DISABLE_REQUEST_PAYLOAD (0x00000002) +#define IKEEXT_CERT_FLAG_USE_NAP_CERTIFICATE (0x00000004) +#define IKEEXT_CERT_FLAG_INTERMEDIATE_CA (0x00000008) +#define IKEEXT_CERT_FLAG_IGNORE_INIT_CERT_MAP_FAILURE (0x00000010) +#define IKEEXT_CERT_FLAG_PREFER_NAP_CERTIFICATE_OUTBOUND (0x00000020) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_CERT_FLAG_SELECT_NAP_CERTIFICATE (0x00000040) +#define IKEEXT_CERT_FLAG_VERIFY_NAP_CERTIFICATE (0x00000080) +#define IKEEXT_CERT_FLAG_FOLLOW_RENEWAL_CERTIFICATE (0x00000100) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_CERT_ROOT_CONFIG0_ + { + FWP_BYTE_BLOB certData; + UINT32 flags; + } IKEEXT_CERT_ROOT_CONFIG0; + +#define IKEEXT_CERT_AUTH_FLAG_SSL_ONE_WAY (0x00000001) +#define IKEEXT_CERT_AUTH_FLAG_DISABLE_CRL_CHECK (0x00000002) +#define IKEEXT_CERT_AUTH_ENABLE_CRL_CHECK_STRONG (0x00000004) +#define IKEEXT_CERT_AUTH_DISABLE_SSL_CERT_VALIDATION (0x00000008) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_CERT_AUTH_ALLOW_HTTP_CERT_LOOKUP (0x00000010) +#define IKEEXT_CERT_AUTH_URL_CONTAINS_BUNDLE (0x00000020) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) +#define IKEEXT_CERT_AUTH_FLAG_DISABLE_REQUEST_PAYLOAD (0x00000040) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef /* [v1_enum] */ +enum IKEEXT_CERT_CONFIG_TYPE_ + { + IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST = 0, + IKEEXT_CERT_CONFIG_ENTERPRISE_STORE = ( IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST + 1 ) , + IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE = ( IKEEXT_CERT_CONFIG_ENTERPRISE_STORE + 1 ) , + IKEEXT_CERT_CONFIG_UNSPECIFIED = ( IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE + 1 ) , + IKEEXT_CERT_CONFIG_TYPE_MAX = ( IKEEXT_CERT_CONFIG_UNSPECIFIED + 1 ) + } IKEEXT_CERT_CONFIG_TYPE; + +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION0_ + { + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 inboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundRootArray; + } ; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundEnterpriseStoreConfig; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundTrustedRootStoreConfig; + } ; + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 outboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundRootArray; + } ; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundEnterpriseStoreConfig; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundTrustedRootStoreConfig; + } ; + UINT32 flags; + } IKEEXT_CERTIFICATE_AUTHENTICATION0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION1_ + { + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 inboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundRootArray; + } ; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundEnterpriseStoreConfig; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *inboundTrustedRootStoreConfig; + /* [case()] */ /* Empty union arm */ + } ; + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 outboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundRootArray; + } ; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundEnterpriseStoreConfig; + /* [case()][unique] */ IKEEXT_CERT_ROOT_CONFIG0 *outboundTrustedRootStoreConfig; + /* [case()] */ /* Empty union arm */ + } ; + UINT32 flags; + FWP_BYTE_BLOB localCertLocationUrl; + } IKEEXT_CERTIFICATE_AUTHENTICATION1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef +enum IKEEXT_CERT_CRITERIA_NAME_TYPE_ + { + IKEEXT_CERT_CRITERIA_DNS = 0, + IKEEXT_CERT_CRITERIA_UPN = ( IKEEXT_CERT_CRITERIA_DNS + 1 ) , + IKEEXT_CERT_CRITERIA_RFC822 = ( IKEEXT_CERT_CRITERIA_UPN + 1 ) , + IKEEXT_CERT_CRITERIA_CN = ( IKEEXT_CERT_CRITERIA_RFC822 + 1 ) , + IKEEXT_CERT_CRITERIA_OU = ( IKEEXT_CERT_CRITERIA_CN + 1 ) , + IKEEXT_CERT_CRITERIA_O = ( IKEEXT_CERT_CRITERIA_OU + 1 ) , + IKEEXT_CERT_CRITERIA_DC = ( IKEEXT_CERT_CRITERIA_O + 1 ) , + IKEEXT_CERT_CRITERIA_NAME_TYPE_MAX = ( IKEEXT_CERT_CRITERIA_DC + 1 ) + } IKEEXT_CERT_CRITERIA_NAME_TYPE; + +typedef struct IKEEXT_CERT_EKUS0_ + { + ULONG numEku; + /* [ref][size_is][string] */ LPSTR *eku; + } IKEEXT_CERT_EKUS0; + +typedef struct IKEEXT_CERT_NAME0_ + { + IKEEXT_CERT_CRITERIA_NAME_TYPE nameType; + /* [ref][string] */ LPWSTR certName; + } IKEEXT_CERT_NAME0; + +typedef struct IKEEXT_CERTIFICATE_CRITERIA0_ + { + FWP_BYTE_BLOB certData; + FWP_BYTE_BLOB certHash; + /* [unique] */ IKEEXT_CERT_EKUS0 *eku; + /* [unique] */ IKEEXT_CERT_NAME0 *name; + UINT32 flags; + } IKEEXT_CERTIFICATE_CRITERIA0; + +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION2_ + { + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 inboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *inboundRootCriteria; + } ; + /* [case()] */ struct + { + UINT32 inboundEnterpriseStoreArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *inboundEnterpriseStoreCriteria; + } ; + /* [case()] */ struct + { + UINT32 inboundRootStoreArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *inboundTrustedRootStoreCriteria; + } ; + /* [case()] */ /* Empty union arm */ + } ; + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ struct + { + UINT32 outboundRootArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *outboundRootCriteria; + } ; + /* [case()] */ struct + { + UINT32 outboundEnterpriseStoreArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *outboundEnterpriseStoreCriteria; + } ; + /* [case()] */ struct + { + UINT32 outboundRootStoreArraySize; + /* [unique][size_is] */ IKEEXT_CERTIFICATE_CRITERIA0 *outboundTrustedRootStoreCriteria; + } ; + /* [case()] */ /* Empty union arm */ + } ; + UINT32 flags; + FWP_BYTE_BLOB localCertLocationUrl; + } IKEEXT_CERTIFICATE_AUTHENTICATION2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_IPV6_CGA_AUTHENTICATION0_ + { + /* [ref][string] */ wchar_t *keyContainerName; + /* [unique][string] */ wchar_t *cspName; + UINT32 cspType; + FWP_BYTE_ARRAY16 cgaModifier; + BYTE cgaCollisionCount; + } IKEEXT_IPV6_CGA_AUTHENTICATION0; + +#define IKEEXT_KERB_AUTH_DISABLE_INITIATOR_TOKEN_GENERATION (0x00000001) +#define IKEEXT_KERB_AUTH_DONT_ACCEPT_EXPLICIT_CREDENTIALS (0x00000002) +typedef struct IKEEXT_KERBEROS_AUTHENTICATION0__ + { + UINT32 flags; + } IKEEXT_KERBEROS_AUTHENTICATION0; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_KERB_AUTH_FORCE_PROXY_ON_INITIATOR (0x00000004) +typedef struct IKEEXT_KERBEROS_AUTHENTICATION1__ + { + UINT32 flags; + /* [unique][string] */ wchar_t *proxyServer; + } IKEEXT_KERBEROS_AUTHENTICATION1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_RESERVED_AUTH_DISABLE_INITIATOR_TOKEN_GENERATION (0x00000001) +typedef struct IKEEXT_RESERVED_AUTHENTICATION0__ + { + UINT32 flags; + } IKEEXT_RESERVED_AUTHENTICATION0; + +#define IKEEXT_NTLM_V2_AUTH_DONT_ACCEPT_EXPLICIT_CREDENTIALS (0x00000001) +typedef struct IKEEXT_NTLM_V2_AUTHENTICATION0__ + { + UINT32 flags; + } IKEEXT_NTLM_V2_AUTHENTICATION0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IKEEXT_EAP_FLAG_LOCAL_AUTH_ONLY (0x00000001) +#define IKEEXT_EAP_FLAG_REMOTE_AUTH_ONLY (0x00000002) +typedef struct IKEEXT_EAP_AUTHENTICATION0__ + { + UINT32 flags; + } IKEEXT_EAP_AUTHENTICATION0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_AUTHENTICATION_METHOD0_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION0 presharedKeyAuthentication; + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION0 certificateAuthentication; + /* [case()] */ IKEEXT_KERBEROS_AUTHENTICATION0 kerberosAuthentication; + /* [case()] */ IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + /* [case()] */ /* Empty union arm */ + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION0 sslAuthentication; + /* [case()] */ IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + } ; + } IKEEXT_AUTHENTICATION_METHOD0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_AUTHENTICATION_METHOD1_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION1 presharedKeyAuthentication; + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION1 certificateAuthentication; + /* [case()] */ IKEEXT_KERBEROS_AUTHENTICATION0 kerberosAuthentication; + /* [case()] */ IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + /* [case()] */ /* Empty union arm */ + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION1 sslAuthentication; + /* [case()] */ IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + /* [case()] */ IKEEXT_EAP_AUTHENTICATION0 eapAuthentication; + } ; + } IKEEXT_AUTHENTICATION_METHOD1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_AUTHENTICATION_METHOD2_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION1 presharedKeyAuthentication; + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION2 certificateAuthentication; + /* [case()] */ IKEEXT_KERBEROS_AUTHENTICATION1 kerberosAuthentication; + /* [case()] */ IKEEXT_RESERVED_AUTHENTICATION0 reservedAuthentication; + /* [case()] */ IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + /* [case()] */ /* Empty union arm */ + /* [case()] */ IKEEXT_CERTIFICATE_AUTHENTICATION2 sslAuthentication; + /* [case()] */ IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + /* [case()] */ IKEEXT_EAP_AUTHENTICATION0 eapAuthentication; + } ; + } IKEEXT_AUTHENTICATION_METHOD2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef /* [v1_enum] */ +enum IKEEXT_CIPHER_TYPE_ + { + IKEEXT_CIPHER_DES = 0, + IKEEXT_CIPHER_3DES = ( IKEEXT_CIPHER_DES + 1 ) , + IKEEXT_CIPHER_AES_128 = ( IKEEXT_CIPHER_3DES + 1 ) , + IKEEXT_CIPHER_AES_192 = ( IKEEXT_CIPHER_AES_128 + 1 ) , + IKEEXT_CIPHER_AES_256 = ( IKEEXT_CIPHER_AES_192 + 1 ) , + IKEEXT_CIPHER_AES_GCM_128_16ICV = ( IKEEXT_CIPHER_AES_256 + 1 ) , + IKEEXT_CIPHER_AES_GCM_256_16ICV = ( IKEEXT_CIPHER_AES_GCM_128_16ICV + 1 ) , + IKEEXT_CIPHER_TYPE_MAX = ( IKEEXT_CIPHER_AES_GCM_256_16ICV + 1 ) + } IKEEXT_CIPHER_TYPE; + +typedef struct IKEEXT_CIPHER_ALGORITHM0_ + { + IKEEXT_CIPHER_TYPE algoIdentifier; + UINT32 keyLen; + UINT32 rounds; + } IKEEXT_CIPHER_ALGORITHM0; + +typedef /* [v1_enum] */ +enum IKEEXT_INTEGRITY_TYPE_ + { + IKEEXT_INTEGRITY_MD5 = 0, + IKEEXT_INTEGRITY_SHA1 = ( IKEEXT_INTEGRITY_MD5 + 1 ) , + IKEEXT_INTEGRITY_SHA_256 = ( IKEEXT_INTEGRITY_SHA1 + 1 ) , + IKEEXT_INTEGRITY_SHA_384 = ( IKEEXT_INTEGRITY_SHA_256 + 1 ) , + IKEEXT_INTEGRITY_TYPE_MAX = ( IKEEXT_INTEGRITY_SHA_384 + 1 ) + } IKEEXT_INTEGRITY_TYPE; + +typedef struct IKEEXT_INTEGRITY_ALGORITHM0_ + { + IKEEXT_INTEGRITY_TYPE algoIdentifier; + } IKEEXT_INTEGRITY_ALGORITHM0; + +typedef /* [v1_enum] */ +enum IKEEXT_DH_GROUP_ + { + IKEEXT_DH_GROUP_NONE = 0, + IKEEXT_DH_GROUP_1 = ( IKEEXT_DH_GROUP_NONE + 1 ) , + IKEEXT_DH_GROUP_2 = ( IKEEXT_DH_GROUP_1 + 1 ) , + IKEEXT_DH_GROUP_14 = ( IKEEXT_DH_GROUP_2 + 1 ) , + IKEEXT_DH_GROUP_2048 = IKEEXT_DH_GROUP_14, + IKEEXT_DH_ECP_256 = ( IKEEXT_DH_GROUP_2048 + 1 ) , + IKEEXT_DH_ECP_384 = ( IKEEXT_DH_ECP_256 + 1 ) , + IKEEXT_DH_GROUP_24 = ( IKEEXT_DH_ECP_384 + 1 ) , + IKEEXT_DH_GROUP_MAX = ( IKEEXT_DH_GROUP_24 + 1 ) + } IKEEXT_DH_GROUP; + +typedef struct IKEEXT_PROPOSAL0_ + { + IKEEXT_CIPHER_ALGORITHM0 cipherAlgorithm; + IKEEXT_INTEGRITY_ALGORITHM0 integrityAlgorithm; + UINT32 maxLifetimeSeconds; + IKEEXT_DH_GROUP dhGroup; + UINT32 quickModeLimit; + } IKEEXT_PROPOSAL0; + +#define IKEEXT_POLICY_FLAG_DISABLE_DIAGNOSTICS (0x00000001) +#define IKEEXT_POLICY_FLAG_NO_MACHINE_LUID_VERIFY (0x00000002) +#define IKEEXT_POLICY_FLAG_NO_IMPERSONATION_LUID_VERIFY (0x00000004) +#define IKEEXT_POLICY_FLAG_ENABLE_OPTIONAL_DH (0x00000008) +#define IKEEXT_POLICY_FLAG_MOBIKE_NOT_SUPPORTED (0x00000010) +#define IKEEXT_POLICY_FLAG_SITE_TO_SITE (0x00000020) +#define IKEEXT_POLICY_FLAG_IMS_VPN (0x00000040) +#define IKEEXT_POLICY_ENABLE_IKEV2_FRAGMENTATION (0x00000080) +#define IKEEXT_POLICY_SUPPORT_LOW_POWER_MODE (0x00000100) +#define IKEEXT_POLICY_FLAG_POINT_TO_SITE (0x00000200) +typedef struct IKEEXT_POLICY0_ + { + UINT32 softExpirationTime; + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD0 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + UINT32 numIkeProposals; + /* [ref][size_is] */ IKEEXT_PROPOSAL0 *ikeProposals; + UINT32 flags; + UINT32 maxDynamicFilters; + } IKEEXT_POLICY0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_POLICY1_ + { + UINT32 softExpirationTime; + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD1 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + UINT32 numIkeProposals; + /* [ref][size_is] */ IKEEXT_PROPOSAL0 *ikeProposals; + UINT32 flags; + UINT32 maxDynamicFilters; + UINT32 retransmitDurationSecs; + } IKEEXT_POLICY1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_POLICY2_ + { + UINT32 softExpirationTime; + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD2 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + UINT32 numIkeProposals; + /* [ref][size_is] */ IKEEXT_PROPOSAL0 *ikeProposals; + UINT32 flags; + UINT32 maxDynamicFilters; + UINT32 retransmitDurationSecs; + } IKEEXT_POLICY2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_EM_POLICY0_ + { + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD0 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + } IKEEXT_EM_POLICY0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_EM_POLICY1_ + { + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD1 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + } IKEEXT_EM_POLICY1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_EM_POLICY2_ + { + UINT32 numAuthenticationMethods; + /* [ref][size_is] */ IKEEXT_AUTHENTICATION_METHOD2 *authenticationMethods; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + } IKEEXT_EM_POLICY2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#define IKEEXT_ERROR_CODE_COUNT (ERROR_IPSEC_IKE_NEG_STATUS_END - ERROR_IPSEC_IKE_NEG_STATUS_BEGIN) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0_ + { + UINT32 currentActiveMainModes; + UINT32 totalMainModesStarted; + UINT32 totalSuccessfulMainModes; + UINT32 totalFailedMainModes; + UINT32 totalResponderMainModes; + UINT32 currentNewResponderMainModes; + UINT32 currentActiveQuickModes; + UINT32 totalQuickModesStarted; + UINT32 totalSuccessfulQuickModes; + UINT32 totalFailedQuickModes; + UINT32 totalAcquires; + UINT32 totalReinitAcquires; + UINT32 currentActiveExtendedModes; + UINT32 totalExtendedModesStarted; + UINT32 totalSuccessfulExtendedModes; + UINT32 totalFailedExtendedModes; + UINT32 totalImpersonationExtendedModes; + UINT32 totalImpersonationMainModes; + } IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1_ + { + UINT32 currentActiveMainModes; + UINT32 totalMainModesStarted; + UINT32 totalSuccessfulMainModes; + UINT32 totalFailedMainModes; + UINT32 totalResponderMainModes; + UINT32 currentNewResponderMainModes; + UINT32 currentActiveQuickModes; + UINT32 totalQuickModesStarted; + UINT32 totalSuccessfulQuickModes; + UINT32 totalFailedQuickModes; + UINT32 totalAcquires; + UINT32 totalReinitAcquires; + UINT32 currentActiveExtendedModes; + UINT32 totalExtendedModesStarted; + UINT32 totalSuccessfulExtendedModes; + UINT32 totalFailedExtendedModes; + UINT32 totalImpersonationExtendedModes; + UINT32 totalImpersonationMainModes; + } IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_KEYMODULE_STATISTICS0_ + { + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0 v4Statistics; + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0 v6Statistics; + UINT32 errorFrequencyTable[ 97 ]; + UINT32 mainModeNegotiationTime; + UINT32 quickModeNegotiationTime; + UINT32 extendedModeNegotiationTime; + } IKEEXT_KEYMODULE_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_KEYMODULE_STATISTICS1_ + { + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1 v4Statistics; + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1 v6Statistics; + UINT32 errorFrequencyTable[ 97 ]; + UINT32 mainModeNegotiationTime; + UINT32 quickModeNegotiationTime; + UINT32 extendedModeNegotiationTime; + } IKEEXT_KEYMODULE_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0_ + { + UINT32 totalSocketReceiveFailures; + UINT32 totalSocketSendFailures; + } IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1_ + { + UINT32 totalSocketReceiveFailures; + UINT32 totalSocketSendFailures; + } IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_COMMON_STATISTICS0_ + { + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0 v4Statistics; + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0 v6Statistics; + UINT32 totalPacketsReceived; + UINT32 totalInvalidPacketsReceived; + UINT32 currentQueuedWorkitems; + } IKEEXT_COMMON_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_COMMON_STATISTICS1_ + { + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1 v4Statistics; + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1 v6Statistics; + UINT32 totalPacketsReceived; + UINT32 totalInvalidPacketsReceived; + UINT32 currentQueuedWorkitems; + } IKEEXT_COMMON_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_STATISTICS0_ + { + IKEEXT_KEYMODULE_STATISTICS0 ikeStatistics; + IKEEXT_KEYMODULE_STATISTICS0 authipStatistics; + IKEEXT_COMMON_STATISTICS0 commonStatistics; + } IKEEXT_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_STATISTICS1_ + { + IKEEXT_KEYMODULE_STATISTICS1 ikeStatistics; + IKEEXT_KEYMODULE_STATISTICS1 authipStatistics; + IKEEXT_KEYMODULE_STATISTICS1 ikeV2Statistics; + IKEEXT_COMMON_STATISTICS1 commonStatistics; + } IKEEXT_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_TRAFFIC0_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + UINT64 authIpFilterId; + } IKEEXT_TRAFFIC0; + +typedef UINT64 IKEEXT_COOKIE; + +typedef struct IKEEXT_COOKIE_PAIR0_ + { + IKEEXT_COOKIE initiator; + IKEEXT_COOKIE responder; + } IKEEXT_COOKIE_PAIR0; + +#define IKEEXT_CERT_CREDENTIAL_FLAG_NAP_CERT (0x00000001) +typedef struct IKEEXT_CERTIFICATE_CREDENTIAL0_ + { + FWP_BYTE_BLOB subjectName; + FWP_BYTE_BLOB certHash; + UINT32 flags; + } IKEEXT_CERTIFICATE_CREDENTIAL0; + +typedef struct IKEEXT_NAME_CREDENTIAL0_ + { + /* [ref][string] */ wchar_t *principalName; + } IKEEXT_NAME_CREDENTIAL0; + +typedef struct IKEEXT_CREDENTIAL0_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION0 *presharedKey; + /* [case()][unique] */ IKEEXT_CERTIFICATE_CREDENTIAL0 *certificate; + /* [case()][unique] */ IKEEXT_NAME_CREDENTIAL0 *name; + /* [case()] */ /* Empty union arm */ + } ; + } IKEEXT_CREDENTIAL0; + +typedef struct IKEEXT_CREDENTIAL_PAIR0_ + { + IKEEXT_CREDENTIAL0 localCredentials; + IKEEXT_CREDENTIAL0 peerCredentials; + } IKEEXT_CREDENTIAL_PAIR0; + +typedef struct IKEEXT_CREDENTIALS0_ + { + UINT32 numCredentials; + /* [ref][size_is] */ IKEEXT_CREDENTIAL_PAIR0 *credentials; + } IKEEXT_CREDENTIALS0; + +typedef struct IKEEXT_SA_DETAILS0_ + { + UINT64 saId; + IKEEXT_KEY_MODULE_TYPE keyModuleType; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *v4UdpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + IKEEXT_TRAFFIC0 ikeTraffic; + IKEEXT_PROPOSAL0 ikeProposal; + IKEEXT_COOKIE_PAIR0 cookiePair; + IKEEXT_CREDENTIALS0 ikeCredentials; + GUID ikePolicyKey; + UINT64 virtualIfTunnelId; + } IKEEXT_SA_DETAILS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IKEEXT_CERTIFICATE_CREDENTIAL1_ + { + FWP_BYTE_BLOB subjectName; + FWP_BYTE_BLOB certHash; + UINT32 flags; + FWP_BYTE_BLOB certificate; + } IKEEXT_CERTIFICATE_CREDENTIAL1; + +typedef struct IKEEXT_CREDENTIAL1_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION1 *presharedKey; + /* [case()][unique] */ IKEEXT_CERTIFICATE_CREDENTIAL1 *certificate; + /* [case()][unique] */ IKEEXT_NAME_CREDENTIAL0 *name; + /* [case()] */ /* Empty union arm */ + } ; + } IKEEXT_CREDENTIAL1; + +typedef struct IKEEXT_CREDENTIAL_PAIR1_ + { + IKEEXT_CREDENTIAL1 localCredentials; + IKEEXT_CREDENTIAL1 peerCredentials; + } IKEEXT_CREDENTIAL_PAIR1; + +typedef struct IKEEXT_CREDENTIALS1_ + { + UINT32 numCredentials; + /* [ref][size_is] */ IKEEXT_CREDENTIAL_PAIR1 *credentials; + } IKEEXT_CREDENTIALS1; + +typedef struct IKEEXT_SA_DETAILS1_ + { + UINT64 saId; + IKEEXT_KEY_MODULE_TYPE keyModuleType; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *v4UdpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + IKEEXT_TRAFFIC0 ikeTraffic; + IKEEXT_PROPOSAL0 ikeProposal; + IKEEXT_COOKIE_PAIR0 cookiePair; + IKEEXT_CREDENTIALS1 ikeCredentials; + GUID ikePolicyKey; + UINT64 virtualIfTunnelId; + FWP_BYTE_BLOB correlationKey; + } IKEEXT_SA_DETAILS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_CREDENTIAL2_ + { + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IKEEXT_PRESHARED_KEY_AUTHENTICATION1 *presharedKey; + /* [case()][unique] */ IKEEXT_CERTIFICATE_CREDENTIAL1 *certificate; + /* [case()][unique] */ IKEEXT_NAME_CREDENTIAL0 *name; + /* [case()] */ /* Empty union arm */ + } ; + } IKEEXT_CREDENTIAL2; + +typedef struct IKEEXT_CREDENTIAL_PAIR2_ + { + IKEEXT_CREDENTIAL2 localCredentials; + IKEEXT_CREDENTIAL2 peerCredentials; + } IKEEXT_CREDENTIAL_PAIR2; + +typedef struct IKEEXT_CREDENTIALS2_ + { + UINT32 numCredentials; + /* [ref][size_is] */ IKEEXT_CREDENTIAL_PAIR2 *credentials; + } IKEEXT_CREDENTIALS2; + +typedef struct IKEEXT_SA_DETAILS2_ + { + UINT64 saId; + IKEEXT_KEY_MODULE_TYPE keyModuleType; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *v4UdpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + IKEEXT_TRAFFIC0 ikeTraffic; + IKEEXT_PROPOSAL0 ikeProposal; + IKEEXT_COOKIE_PAIR0 cookiePair; + IKEEXT_CREDENTIALS2 ikeCredentials; + GUID ikePolicyKey; + UINT64 virtualIfTunnelId; + FWP_BYTE_BLOB correlationKey; + } IKEEXT_SA_DETAILS2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IKEEXT_SA_ENUM_TEMPLATE0_ + { + FWP_CONDITION_VALUE0 localSubNet; + FWP_CONDITION_VALUE0 remoteSubNet; + FWP_BYTE_BLOB localMainModeCertHash; + } IKEEXT_SA_ENUM_TEMPLATE0; + +typedef /* [v1_enum] */ +enum IKEEXT_MM_SA_STATE_ + { + IKEEXT_MM_SA_STATE_NONE = 0, + IKEEXT_MM_SA_STATE_SA_SENT = ( IKEEXT_MM_SA_STATE_NONE + 1 ) , + IKEEXT_MM_SA_STATE_SSPI_SENT = ( IKEEXT_MM_SA_STATE_SA_SENT + 1 ) , + IKEEXT_MM_SA_STATE_FINAL = ( IKEEXT_MM_SA_STATE_SSPI_SENT + 1 ) , + IKEEXT_MM_SA_STATE_FINAL_SENT = ( IKEEXT_MM_SA_STATE_FINAL + 1 ) , + IKEEXT_MM_SA_STATE_COMPLETE = ( IKEEXT_MM_SA_STATE_FINAL_SENT + 1 ) , + IKEEXT_MM_SA_STATE_MAX = ( IKEEXT_MM_SA_STATE_COMPLETE + 1 ) + } IKEEXT_MM_SA_STATE; + +typedef /* [v1_enum] */ +enum IKEEXT_QM_SA_STATE_ + { + IKEEXT_QM_SA_STATE_NONE = 0, + IKEEXT_QM_SA_STATE_INITIAL = ( IKEEXT_QM_SA_STATE_NONE + 1 ) , + IKEEXT_QM_SA_STATE_FINAL = ( IKEEXT_QM_SA_STATE_INITIAL + 1 ) , + IKEEXT_QM_SA_STATE_COMPLETE = ( IKEEXT_QM_SA_STATE_FINAL + 1 ) , + IKEEXT_QM_SA_STATE_MAX = ( IKEEXT_QM_SA_STATE_COMPLETE + 1 ) + } IKEEXT_QM_SA_STATE; + +typedef /* [v1_enum] */ +enum IKEEXT_EM_SA_STATE_ + { + IKEEXT_EM_SA_STATE_NONE = 0, + IKEEXT_EM_SA_STATE_SENT_ATTS = ( IKEEXT_EM_SA_STATE_NONE + 1 ) , + IKEEXT_EM_SA_STATE_SSPI_SENT = ( IKEEXT_EM_SA_STATE_SENT_ATTS + 1 ) , + IKEEXT_EM_SA_STATE_AUTH_COMPLETE = ( IKEEXT_EM_SA_STATE_SSPI_SENT + 1 ) , + IKEEXT_EM_SA_STATE_FINAL = ( IKEEXT_EM_SA_STATE_AUTH_COMPLETE + 1 ) , + IKEEXT_EM_SA_STATE_COMPLETE = ( IKEEXT_EM_SA_STATE_FINAL + 1 ) , + IKEEXT_EM_SA_STATE_MAX = ( IKEEXT_EM_SA_STATE_COMPLETE + 1 ) + } IKEEXT_EM_SA_STATE; + +typedef /* [v1_enum] */ +enum IKEEXT_SA_ROLE_ + { + IKEEXT_SA_ROLE_INITIATOR = 0, + IKEEXT_SA_ROLE_RESPONDER = ( IKEEXT_SA_ROLE_INITIATOR + 1 ) , + IKEEXT_SA_ROLE_MAX = ( IKEEXT_SA_ROLE_RESPONDER + 1 ) + } IKEEXT_SA_ROLE; + +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */ +#pragma endregion + + +extern RPC_IF_HANDLE __MIDL_itf_iketypes_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_iketypes_0000_0000_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.idl new file mode 100644 index 0000000000000000000000000000000000000000..b202edd93835086ee516b2181f3a4d8023e57158 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iketypes.idl @@ -0,0 +1,1547 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Defines data types used by the IKE keying module. +*/ +cpp_quote("#include ") + +#pragma region Desktop Family or AppRuntime Package +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME)") + + +#include "winerror.h" + +import "fwptypes.idl"; + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(push)") +cpp_quote("#endif") +cpp_quote("#pragma warning(disable:4201)") +cpp_quote("#endif") + +typedef struct IPSEC_V4_UDP_ENCAPSULATION0_ IPSEC_V4_UDP_ENCAPSULATION0; + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building IKE, Authip policies. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef [v1_enum] enum IKEEXT_KEY_MODULE_TYPE_ +{ + IKEEXT_KEY_MODULE_IKE, + IKEEXT_KEY_MODULE_AUTHIP, + IKEEXT_KEY_MODULE_IKEV2, + IKEEXT_KEY_MODULE_MAX +} IKEEXT_KEY_MODULE_TYPE; + +// Type of authentication method +typedef [v1_enum] enum IKEEXT_AUTHENTICATION_METHOD_TYPE_ +{ + IKEEXT_PRESHARED_KEY, + IKEEXT_CERTIFICATE, + IKEEXT_KERBEROS, + IKEEXT_ANONYMOUS, + IKEEXT_SSL, + IKEEXT_NTLM_V2, + IKEEXT_IPV6_CGA, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384, + IKEEXT_EAP, + IKEEXT_RESERVED, + IKEEXT_AUTHENTICATION_METHOD_TYPE_MAX +} IKEEXT_AUTHENTICATION_METHOD_TYPE; + +// Type of impersonation to perform while authentication. Ike can only perform +// machine authentication, so this should be set to IKEEXT_IMPERSONATION_NONE +// when specifying IKE policy. For Authip policy, specify +// IKEEXT_IMPERSONATION_SOCKET_PRINCIPAL to enable impersonation. +typedef [v1_enum] enum IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE_ +{ + IKEEXT_IMPERSONATION_NONE, + IKEEXT_IMPERSONATION_SOCKET_PRINCIPAL, + IKEEXT_IMPERSONATION_MAX +} IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE; + +// Stores information needed for preshared key authentication +typedef struct IKEEXT_PRESHARED_KEY_AUTHENTICATION0__ +{ + // The preshared key + FWP_BYTE_BLOB presharedKey; +} IKEEXT_PRESHARED_KEY_AUTHENTICATION0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") + +// Use PSK for authenticating local entity to remote entity only +cpp_quote("#define IKEEXT_PSK_FLAG_LOCAL_AUTH_ONLY (0x00000001)") +// Use PSK for authenticating remote entity to local entity only +cpp_quote("#define IKEEXT_PSK_FLAG_REMOTE_AUTH_ONLY (0x00000002)") + + +typedef struct IKEEXT_PRESHARED_KEY_AUTHENTICATION1__ +{ + // The preshared key + FWP_BYTE_BLOB presharedKey; + // Flags + UINT32 flags; +} IKEEXT_PRESHARED_KEY_AUTHENTICATION1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +////////// +// Flags specifying certificate root characteristics. +////////// + +// Enable certificate to account mapping for this root. +cpp_quote("#define IKEEXT_CERT_FLAG_ENABLE_ACCOUNT_MAPPING (0x00000001)") +// Do not send a Cert request payload for this root. +cpp_quote("#define IKEEXT_CERT_FLAG_DISABLE_REQUEST_PAYLOAD (0x00000002)") +// Enable NAP certificate handling +cpp_quote("#define IKEEXT_CERT_FLAG_USE_NAP_CERTIFICATE (0x00000004)") +// The corresponding CA could be an intermediate CA and need not be a ROOT CA. +// If this flag is not specified, the name will have to refer to a ROOT CA. +cpp_quote("#define IKEEXT_CERT_FLAG_INTERMEDIATE_CA (0x00000008)") +// If certificate to account mapping is enabled, this flag allows IKE to ignore +// mapping failures on initiator. Not applicable for Authip. Can be set only +// if IKEEXT_CERT_FLAG_ENABLE_ACCOUNT_MAPPING is also specified. By default IKE +// will not ignore cert-mapping failures even on initiator. +cpp_quote("#define IKEEXT_CERT_FLAG_IGNORE_INIT_CERT_MAP_FAILURE (0x00000010)") +//If this flag is specified, then NAP certs are preferred for +//local cert selection +cpp_quote("#define IKEEXT_CERT_FLAG_PREFER_NAP_CERTIFICATE_OUTBOUND (0x00000020)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Select a NAP certificate for outbound +cpp_quote("#define IKEEXT_CERT_FLAG_SELECT_NAP_CERTIFICATE (0x00000040)") +// Verify that inbound certificate is NAP +cpp_quote("#define IKEEXT_CERT_FLAG_VERIFY_NAP_CERTIFICATE (0x00000080)") +// Follow renewal property on the certificate when selecting local certificate for outbound. +// Only applicable when hash of the certificate is specified. +cpp_quote("#define IKEEXT_CERT_FLAG_FOLLOW_RENEWAL_CERTIFICATE (0x00000100)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +typedef struct IKEEXT_CERT_ROOT_CONFIG0_ +{ + // X509/ASN.1 encoded name of the certificate root. Should be empty when + // specifying Enterprise or trusted root store config. + FWP_BYTE_BLOB certData; + // Flags + UINT32 flags; +} IKEEXT_CERT_ROOT_CONFIG0; + +////////// +// Flags specifying certificate authentication characteristics. +////////// + +// Enable SSL one way authentication +cpp_quote("#define IKEEXT_CERT_AUTH_FLAG_SSL_ONE_WAY (0x00000001)") + +// Disable CRL checking. By default weak CRL checking is enabled. Weak checking +// means that a certificate will be rejected if and only if CRL is successfully +// looked up and the certificate is found to be revoked. +cpp_quote("#define IKEEXT_CERT_AUTH_FLAG_DISABLE_CRL_CHECK (0x00000002)") + +// Enable strong CRL checking. Strong checking means that a certificate will be +// rejected if certificate is found to be revoked, or if any other error +// (for ex: CRL could not be retrieved) takes place while performing the +// revokation checking. By default weak CRL checking is enabled. +cpp_quote("#define IKEEXT_CERT_AUTH_ENABLE_CRL_CHECK_STRONG (0x00000004)") + +// SSL validation requires certain EKUs, like server auth EKU from a server. +// This disables the server auth EKU check, but still performs the other +// IKE-style certificate verification +cpp_quote("#define IKEEXT_CERT_AUTH_DISABLE_SSL_CERT_VALIDATION (0x00000008)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Allow lookup of peer certificate information from an HTTP URL. Only supported +// by IKEv2. +cpp_quote("#define IKEEXT_CERT_AUTH_ALLOW_HTTP_CERT_LOOKUP (0x00000010)") + +// The URL specified in the certificate authentication policy points to an +// encoded certificate-bundle. If this flag is not specifed, IKEv2 will assume +// that the URL points to an encoded certificate. Only supported by IKEv2. +cpp_quote("#define IKEEXT_CERT_AUTH_URL_CONTAINS_BUNDLE (0x00000020)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Disable sending CERT_REQ payload from the Client +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS2)") +cpp_quote("#define IKEEXT_CERT_AUTH_FLAG_DISABLE_REQUEST_PAYLOAD (0x00000040)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3)") + +// Type of certificate configuration +typedef [v1_enum] enum IKEEXT_CERT_CONFIG_TYPE_ +{ + // Use an explicit trust list for authentication + IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST, + // Use the enterprise store as the trust list for authentication + IKEEXT_CERT_CONFIG_ENTERPRISE_STORE, + // Use the trusted root CA store as the trust list for authentication + IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE, + // No Cert auth in direction (inbound/outbound) in which config applies + IKEEXT_CERT_CONFIG_UNSPECIFIED, + // Not a valid type -- used for parameter validation only. + IKEEXT_CERT_CONFIG_TYPE_MAX +} IKEEXT_CERT_CONFIG_TYPE; + +// Type used to specify various parameters for authentication with certificates. +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION0_ +{ + // Certificate configuration type for inbound peer cert verification. + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + // Configuration for inbound peer cert verification. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(inboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for verifying the peer certificate chain. + struct + { + UINT32 inboundRootArraySize; + [size_is(inboundRootArraySize), unique] + IKEEXT_CERT_ROOT_CONFIG0* inboundRootArray; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for verifying the peer certificate chain. + [unique] IKEEXT_CERT_ROOT_CONFIG0* inboundEnterpriseStoreConfig; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for verifying the peer certificate chain. + [unique] IKEEXT_CERT_ROOT_CONFIG0* inboundTrustedRootStoreConfig; + }; + + // Certificate configuration type for outbound local cert selection. + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + // Configuration for outbound local cert selection. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(outboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for selecting a certificate chain to send to the + // peer. + struct + { + UINT32 outboundRootArraySize; + [size_is(outboundRootArraySize), unique] + IKEEXT_CERT_ROOT_CONFIG0* outboundRootArray; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for selecting a certificate chain to send to + // the peer. + [unique] IKEEXT_CERT_ROOT_CONFIG0* outboundEnterpriseStoreConfig; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for selecting a certificate chain to send + // to the peer. + [unique] IKEEXT_CERT_ROOT_CONFIG0* outboundTrustedRootStoreConfig; + }; + // Flags + UINT32 flags; +} IKEEXT_CERTIFICATE_AUTHENTICATION0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type used to specify various parameters for authentication with +// certificates. +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION1_ +{ + // Certificate configuration type for inbound peer cert verification. + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + // Configuration for inbound peer cert verification. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(inboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for verifying the peer certificate chain. + struct + { + UINT32 inboundRootArraySize; + [size_is(inboundRootArraySize), unique] + IKEEXT_CERT_ROOT_CONFIG0* inboundRootArray; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for verifying the peer certificate chain. + [unique] IKEEXT_CERT_ROOT_CONFIG0* inboundEnterpriseStoreConfig; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for verifying the peer certificate chain. + [unique] IKEEXT_CERT_ROOT_CONFIG0* inboundTrustedRootStoreConfig; + [case(IKEEXT_CERT_CONFIG_UNSPECIFIED)]; + }; + + // Certificate configuration type for outbound local cert selection. + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + // Configuration for outbound local cert selection. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(outboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for selecting a certificate chain to send to the + // peer. + struct + { + UINT32 outboundRootArraySize; + [size_is(outboundRootArraySize), unique] + IKEEXT_CERT_ROOT_CONFIG0* outboundRootArray; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for selecting a certificate chain to send to + // the peer. + [unique] IKEEXT_CERT_ROOT_CONFIG0* outboundEnterpriseStoreConfig; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for selecting a certificate chain to send + // to the peer. + [unique] IKEEXT_CERT_ROOT_CONFIG0* outboundTrustedRootStoreConfig; + [case(IKEEXT_CERT_CONFIG_UNSPECIFIED)]; + }; + // Flags + UINT32 flags; + + // HTTP URL pointing to an encoded certificate or certificate-bundle, that + // will be used by IKEv2 for authenticating local machine to a peer. + // Only supported by IKEv2. + FWP_BYTE_BLOB localCertLocationUrl; +} IKEEXT_CERTIFICATE_AUTHENTICATION1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +typedef enum IKEEXT_CERT_CRITERIA_NAME_TYPE_ +{ + // DNS name in the Subject Alternative Name of the certificate + IKEEXT_CERT_CRITERIA_DNS, + // UPN name in the Subject Alternative Name of the certificate + IKEEXT_CERT_CRITERIA_UPN, + // RFC 822 name in the Subject Alternative Name of the certificate + IKEEXT_CERT_CRITERIA_RFC822, + // CN in the Subject of the certificate + IKEEXT_CERT_CRITERIA_CN, + // OU in the Subject of the certificate + IKEEXT_CERT_CRITERIA_OU, + // O in the Subject of the certificate + IKEEXT_CERT_CRITERIA_O, + // DC in the Subject of the certificate + IKEEXT_CERT_CRITERIA_DC, + IKEEXT_CERT_CRITERIA_NAME_TYPE_MAX +} IKEEXT_CERT_CRITERIA_NAME_TYPE; + +typedef struct IKEEXT_CERT_EKUS0_ +{ + ULONG numEku; + [string, size_is(numEku), ref] LPSTR* eku; +} IKEEXT_CERT_EKUS0; + +typedef struct IKEEXT_CERT_NAME0_ +{ + IKEEXT_CERT_CRITERIA_NAME_TYPE nameType; + [string, ref] LPWSTR certName; +} IKEEXT_CERT_NAME0; + +typedef struct IKEEXT_CERTIFICATE_CRITERIA0_ +{ + // X509/ASN.1 encoded name of the certificate root. Should be empty when + // specifying Enterprise or trusted root store config. + FWP_BYTE_BLOB certData; + FWP_BYTE_BLOB certHash; + [unique] IKEEXT_CERT_EKUS0* eku; + [unique] IKEEXT_CERT_NAME0* name; + // Flags + UINT32 flags; +} IKEEXT_CERTIFICATE_CRITERIA0; + +// Version-2 of type used to specify various parameters for authentication with +// certificates. +typedef struct IKEEXT_CERTIFICATE_AUTHENTICATION2_ +{ + // Certificate configuration type for inbound peer cert verification. + IKEEXT_CERT_CONFIG_TYPE inboundConfigType; + // Configuration for inbound peer cert verification. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(inboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for verifying the peer certificate chain. + struct + { + UINT32 inboundRootArraySize; + [size_is(inboundRootArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* inboundRootCriteria; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for verifying the peer certificate chain. + struct + { + UINT32 inboundEnterpriseStoreArraySize; + [size_is(inboundEnterpriseStoreArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* inboundEnterpriseStoreCriteria; + }; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for verifying the peer certificate chain. + struct + { + UINT32 inboundRootStoreArraySize; + [size_is(inboundRootStoreArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* inboundTrustedRootStoreCriteria; + }; + [case(IKEEXT_CERT_CONFIG_UNSPECIFIED)]; + }; + + // Certificate configuration type for outbound local cert selection. + IKEEXT_CERT_CONFIG_TYPE outboundConfigType; + // Configuration for outbound local cert selection. It is a union of + // explicit trust list, enterprise store, or trusted root store config + // depending on the configType. + [switch_type(IKEEXT_CERT_CONFIG_TYPE), switch_is(outboundConfigType)] + union + { + [case(IKEEXT_CERT_CONFIG_EXPLICIT_TRUST_LIST)] + // Explicit trust list for selecting a certificate chain to send to the + // peer. + struct + { + UINT32 outboundRootArraySize; + [size_is(outboundRootArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* outboundRootCriteria; + }; + [case(IKEEXT_CERT_CONFIG_ENTERPRISE_STORE)] + // Enterprise store config for selecting a certificate chain to send to + // the peer. + struct + { + UINT32 outboundEnterpriseStoreArraySize; + [size_is(outboundEnterpriseStoreArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* outboundEnterpriseStoreCriteria; + }; + [case(IKEEXT_CERT_CONFIG_TRUSTED_ROOT_STORE)] + // Trusted root store config for selecting a certificate chain to send + // to the peer. + struct + { + UINT32 outboundRootStoreArraySize; + [size_is(outboundRootStoreArraySize), unique] + IKEEXT_CERTIFICATE_CRITERIA0* outboundTrustedRootStoreCriteria; + }; + [case(IKEEXT_CERT_CONFIG_UNSPECIFIED)]; + }; + // Flags + UINT32 flags; + + // HTTP URL pointing to an encoded certificate or certificate-bundle, that + // will be used by IKEv2 for authenticating local machine to a peer. + // Only supported by IKEv2. + FWP_BYTE_BLOB localCertLocationUrl; +} IKEEXT_CERTIFICATE_AUTHENTICATION2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +// Type used to specify various parameters for IPV6 CGA authentication. +typedef struct IKEEXT_IPV6_CGA_AUTHENTICATION0_ +{ + // Key container name of the public key/private key pair that was used to + // generate the CGA. Same semantics as CRYPT_KEY_PROV_INFO->pwszContainerName + [string, ref] wchar_t* keyContainerName; + // Name of the CSP that stores the key container. If NULL, default provider + // will be used. Same semantics as CRYPT_KEY_PROV_INFO->pwszProvName. + [string, unique] wchar_t* cspName; + // Type of the CSP that stores the key container. Same semantics as + // CRYPT_KEY_PROV_INFO->dwProvType + UINT32 cspType; + // Modifier used during CGA generation. See CGA RFC for more information. + FWP_BYTE_ARRAY16 cgaModifier; + // Collision count used during CGA generation. See CGA RFC for more information. + BYTE cgaCollisionCount; +} IKEEXT_IPV6_CGA_AUTHENTICATION0; + +// Disable initiator generation of peer token from the peer's name string +cpp_quote("#define IKEEXT_KERB_AUTH_DISABLE_INITIATOR_TOKEN_GENERATION (0x00000001)") +// Refuse connections if the peer is using explicit credentials +cpp_quote("#define IKEEXT_KERB_AUTH_DONT_ACCEPT_EXPLICIT_CREDENTIALS (0x00000002)") + +// Stores information needed for kerberos authentication +typedef struct IKEEXT_KERBEROS_AUTHENTICATION0__ +{ + UINT32 flags; +} IKEEXT_KERBEROS_AUTHENTICATION0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +// Force the use of a Kerberos proxy server when acting as initiator. +cpp_quote("#define IKEEXT_KERB_AUTH_FORCE_PROXY_ON_INITIATOR (0x00000004)") + +// Stores information needed for Kerberos authentication +typedef struct IKEEXT_KERBEROS_AUTHENTICATION1__ +{ + UINT32 flags; + [string, unique] wchar_t* proxyServer; +} IKEEXT_KERBEROS_AUTHENTICATION1; + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +// Disable initiator generation of peer token from the peer's name string +cpp_quote("#define IKEEXT_RESERVED_AUTH_DISABLE_INITIATOR_TOKEN_GENERATION (0x00000001)") + +// Stores information needed for RESERVED authentication +typedef struct IKEEXT_RESERVED_AUTHENTICATION0__ +{ + UINT32 flags; +} IKEEXT_RESERVED_AUTHENTICATION0; + + +// Refuse connections if the peer is using explicit credentials +cpp_quote("#define IKEEXT_NTLM_V2_AUTH_DONT_ACCEPT_EXPLICIT_CREDENTIALS (0x00000001)") +// Stores information needed for ntlmV2 authentication +typedef struct IKEEXT_NTLM_V2_AUTHENTICATION0__ +{ + UINT32 flags; +} IKEEXT_NTLM_V2_AUTHENTICATION0; + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") + +// Use EAP for authenticating local entity to remote entity only +cpp_quote("#define IKEEXT_EAP_FLAG_LOCAL_AUTH_ONLY (0x00000001)") +// Use EAP for authenticating remote entity to local entity only +cpp_quote("#define IKEEXT_EAP_FLAG_REMOTE_AUTH_ONLY (0x00000002)") + +// Stores information needed for EAP authentication +typedef struct IKEEXT_EAP_AUTHENTICATION0__ +{ + UINT32 flags; +} IKEEXT_EAP_AUTHENTICATION0; + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Type specifying various parameters for IKE/Authip authentication +typedef struct IKEEXT_AUTHENTICATION_METHOD0_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing parameters specific to the authentication method + // type. + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] + union + { + [case(IKEEXT_PRESHARED_KEY)] + IKEEXT_PRESHARED_KEY_AUTHENTICATION0 presharedKeyAuthentication; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION0 certificateAuthentication; + [case(IKEEXT_KERBEROS)] + IKEEXT_KERBEROS_AUTHENTICATION0 kerberosAuthentication; + [case(IKEEXT_NTLM_V2)] + IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + [case(IKEEXT_ANONYMOUS)]; + [case(IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION0 sslAuthentication; + [case(IKEEXT_IPV6_CGA)] + IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + }; +} IKEEXT_AUTHENTICATION_METHOD0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type specifying various parameters for IKE/Authip authentication +typedef struct IKEEXT_AUTHENTICATION_METHOD1_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing parameters specific to the authentication method + // type. + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] + union + { + [case(IKEEXT_PRESHARED_KEY)] + IKEEXT_PRESHARED_KEY_AUTHENTICATION1 presharedKeyAuthentication; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION1 certificateAuthentication; + [case(IKEEXT_KERBEROS)] + IKEEXT_KERBEROS_AUTHENTICATION0 kerberosAuthentication; + [case(IKEEXT_NTLM_V2)] + IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + [case(IKEEXT_ANONYMOUS)]; + [case(IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION1 sslAuthentication; + [case(IKEEXT_IPV6_CGA)] + IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + [case(IKEEXT_EAP)] + IKEEXT_EAP_AUTHENTICATION0 eapAuthentication; + }; +} IKEEXT_AUTHENTICATION_METHOD1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-2 of type specifying various parameters for IKE/Authip authentication +typedef struct IKEEXT_AUTHENTICATION_METHOD2_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing parameters specific to the authentication method + // type. + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] + union + { + [case(IKEEXT_PRESHARED_KEY)] + IKEEXT_PRESHARED_KEY_AUTHENTICATION1 presharedKeyAuthentication; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION2 certificateAuthentication; + [case(IKEEXT_KERBEROS)] + IKEEXT_KERBEROS_AUTHENTICATION1 kerberosAuthentication; + [case(IKEEXT_RESERVED)] + IKEEXT_RESERVED_AUTHENTICATION0 reservedAuthentication; + [case(IKEEXT_NTLM_V2)] + IKEEXT_NTLM_V2_AUTHENTICATION0 ntlmV2Authentication; + [case(IKEEXT_ANONYMOUS)]; + [case(IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384)] + IKEEXT_CERTIFICATE_AUTHENTICATION2 sslAuthentication; + [case(IKEEXT_IPV6_CGA)] + IKEEXT_IPV6_CGA_AUTHENTICATION0 cgaAuthentication; + [case(IKEEXT_EAP)] + IKEEXT_EAP_AUTHENTICATION0 eapAuthentication; + }; +} IKEEXT_AUTHENTICATION_METHOD2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +// Type of encryption algorithm used for encrypting the IKE/Authip messages +typedef [v1_enum] enum IKEEXT_CIPHER_TYPE_ +{ + IKEEXT_CIPHER_DES, + IKEEXT_CIPHER_3DES, + IKEEXT_CIPHER_AES_128, + IKEEXT_CIPHER_AES_192, + IKEEXT_CIPHER_AES_256, + IKEEXT_CIPHER_AES_GCM_128_16ICV, + IKEEXT_CIPHER_AES_GCM_256_16ICV, + IKEEXT_CIPHER_TYPE_MAX +} IKEEXT_CIPHER_TYPE; + +// Stores information about the IKE/Authip encryption algorithm +typedef struct IKEEXT_CIPHER_ALGORITHM0_ +{ + // The type of encryption algorithm + IKEEXT_CIPHER_TYPE algoIdentifier; + // length of the encryption key + UINT32 keyLen; + // Number of rounds in the encryption algorithm + UINT32 rounds; +} IKEEXT_CIPHER_ALGORITHM0; + +// Type of hash algorithm used for integrity protection of IKE/Authip messages +typedef [v1_enum] enum IKEEXT_INTEGRITY_TYPE_ +{ + IKEEXT_INTEGRITY_MD5, + IKEEXT_INTEGRITY_SHA1, + IKEEXT_INTEGRITY_SHA_256, + IKEEXT_INTEGRITY_SHA_384, + IKEEXT_INTEGRITY_TYPE_MAX +} IKEEXT_INTEGRITY_TYPE; + +// Stores the IKE/Authip hash algorithm +typedef struct IKEEXT_INTEGRITY_ALGORITHM0_ +{ + // The type of hash algorithm + IKEEXT_INTEGRITY_TYPE algoIdentifier; +} IKEEXT_INTEGRITY_ALGORITHM0; + +// Type of Diffie Hellman group used for IKE/Authip key generation +typedef [v1_enum] enum IKEEXT_DH_GROUP_ +{ + IKEEXT_DH_GROUP_NONE, + IKEEXT_DH_GROUP_1, + IKEEXT_DH_GROUP_2, + IKEEXT_DH_GROUP_14, + IKEEXT_DH_GROUP_2048 = IKEEXT_DH_GROUP_14, + IKEEXT_DH_ECP_256, + IKEEXT_DH_ECP_384, + IKEEXT_DH_GROUP_24, + IKEEXT_DH_GROUP_MAX +} IKEEXT_DH_GROUP; + +// Type used to store an IKE/Authip main mode proposal. The proposal describes +// the various parameters of the IKE/Authip main mode SA that is potentially +// generated from this proposal. +typedef struct IKEEXT_PROPOSAL0_ +{ + // Parameters for the encryption algorithm + IKEEXT_CIPHER_ALGORITHM0 cipherAlgorithm; + // Parameters for the hash algorithm + IKEEXT_INTEGRITY_ALGORITHM0 integrityAlgorithm; + // Main mode SA Lifetime in seconds + UINT32 maxLifetimeSeconds; + // The Diffie Hellman group + IKEEXT_DH_GROUP dhGroup; + // Maximum number of IPsec quick mode SAs that can be generated from this + // main mode SA. O means infinite. + UINT32 quickModeLimit; +} IKEEXT_PROPOSAL0; + +////////// +// Flags specifying IKE/Authip main mode policy characteristics. +////////// + +// Disable special diagnostics mode for IKE/Authip. This will prevent IKE, AuthIp +// from accepting unauthenticated notifies from peer, or sending MS_STATUS +// notifies to peer. +cpp_quote("#define IKEEXT_POLICY_FLAG_DISABLE_DIAGNOSTICS (0x00000001)") +// Disable SA verification of machine LUID +cpp_quote("#define IKEEXT_POLICY_FLAG_NO_MACHINE_LUID_VERIFY (0x00000002)") +// Disable SA verification of machine impersonation LUID +cpp_quote("#define IKEEXT_POLICY_FLAG_NO_IMPERSONATION_LUID_VERIFY (0x00000004)") +// AuthIP only: allow responder to accept any DH proposal (including NO dh) +// regardless of what is configured in policy +cpp_quote("#define IKEEXT_POLICY_FLAG_ENABLE_OPTIONAL_DH (0x00000008)") +// IKEv2 only: Disable MOBIKE +cpp_quote("#define IKEEXT_POLICY_FLAG_MOBIKE_NOT_SUPPORTED (0x00000010)") +// IKEv2 Site to Site +cpp_quote("#define IKEEXT_POLICY_FLAG_SITE_TO_SITE (0x00000020)") +//IKEv2 ePDG VPN Connection +cpp_quote("#define IKEEXT_POLICY_FLAG_IMS_VPN (0x00000040)") +//IKEv2 Do not allow IKEv2 Fragmentation +cpp_quote("#define IKEEXT_POLICY_ENABLE_IKEV2_FRAGMENTATION (0x00000080)") +//IKEv2 Tunnel Support for Low Power Mode +cpp_quote("#define IKEEXT_POLICY_SUPPORT_LOW_POWER_MODE (0x00000100)") +cpp_quote("#define IKEEXT_POLICY_FLAG_POINT_TO_SITE (0x00000200)") + +// Type used to store the IKE/Authip main mode negotiation policy +typedef struct IKEEXT_POLICY0_ +{ + // Lifetime in seconds of the IPsec soft SA + UINT32 softExpirationTime; + // number of authentication methods + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD0* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + // Number of main mode proposals + UINT32 numIkeProposals; + // Array of main mode proposals + [size_is(numIkeProposals), ref] IKEEXT_PROPOSAL0* ikeProposals; + // Flags + UINT32 flags; + // Maximum number of dynamic IPsec filters (per remote IP address and per + // transport layer) that is allowed to be added for any SA negotiated using + // this policy. This throttle prevents an attacker from making IKE, Authip + // add too many dynamic filters. If this is set to 0, then dynamic filter + // addition will be disabled. + UINT32 maxDynamicFilters; +} IKEEXT_POLICY0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type used to store the IKE/Authip main mode negotiation policy +typedef struct IKEEXT_POLICY1_ +{ + // Lifetime in seconds of the IPsec soft SA + UINT32 softExpirationTime; + // number of authentication methods + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD1* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + // Number of main mode proposals + UINT32 numIkeProposals; + // Array of main mode proposals + [size_is(numIkeProposals), ref] IKEEXT_PROPOSAL0* ikeProposals; + // Flags + UINT32 flags; + // Maximum number of dynamic IPsec filters (per remote IP address and per + // transport layer) that is allowed to be added for any SA negotiated using + // this policy. This throttle prevents an attacker from making IKE, Authip + // add too many dynamic filters. If this is set to 0, then dynamic filter + // addition will be disabled. + UINT32 maxDynamicFilters; + // Duration of time (in seconds) IKEv2 request will be retransmitted before giving up + // Must be set to atleast 120 seconds (or 2mins) + // Applies to IkeV2 only. + UINT32 retransmitDurationSecs; +} IKEEXT_POLICY1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-2 of type used to store the IKE/Authip main mode negotiation policy +typedef struct IKEEXT_POLICY2_ +{ + // Lifetime in seconds of the IPsec soft SA + UINT32 softExpirationTime; + // number of authentication methods + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD2* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + // Number of main mode proposals + UINT32 numIkeProposals; + // Array of main mode proposals + [size_is(numIkeProposals), ref] IKEEXT_PROPOSAL0* ikeProposals; + // Flags + UINT32 flags; + // Maximum number of dynamic IPsec filters (per remote IP address and per + // transport layer) that is allowed to be added for any SA negotiated using + // this policy. This throttle prevents an attacker from making IKE, Authip + // add too many dynamic filters. If this is set to 0, then dynamic filter + // addition will be disabled. + UINT32 maxDynamicFilters; + // Duration of time (in seconds) IKEv2 request will be retransmitted before giving up + // Must be set to atleast 120 seconds (or 2mins) + // Applies to IkeV2 only. + UINT32 retransmitDurationSecs; +} IKEEXT_POLICY2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +// Type used to store Authip's extended mode negotiation policy. +typedef struct IKEEXT_EM_POLICY0_ +{ + // Number of authentication methods in the array + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD0* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; + +} IKEEXT_EM_POLICY0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type used to store Authip's extended mode negotiation policy. +typedef struct IKEEXT_EM_POLICY1_ +{ + // Number of authentication methods in the array + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD1* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; +} IKEEXT_EM_POLICY1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-2 of type used to store Authip's extended mode negotiation policy. +typedef struct IKEEXT_EM_POLICY2_ +{ + // Number of authentication methods in the array + UINT32 numAuthenticationMethods; + // Array of acceptable authentication methods + [size_is(numAuthenticationMethods), ref] + IKEEXT_AUTHENTICATION_METHOD2* authenticationMethods; + // Type of impersonation. Applies only to Authip. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE initiatorImpersonationType; +} IKEEXT_EM_POLICY2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for retrieving IKE statistics. +// +/////////////////////////////////////////////////////////////////////////////// + +//Number of WinError failure codes specific to IKE +cpp_quote("#define IKEEXT_ERROR_CODE_COUNT (ERROR_IPSEC_IKE_NEG_STATUS_END - ERROR_IPSEC_IKE_NEG_STATUS_BEGIN)") +#define IKEEXT_ERROR_CODE_COUNT \ +(ERROR_IPSEC_IKE_NEG_STATUS_END - ERROR_IPSEC_IKE_NEG_STATUS_BEGIN) + +// Various statistics specific to the keying module (IKE or Authip) and +// specific to the IP version +typedef struct IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0_ +{ + // Following statistics are Main Mode specific + + // Current number of active Main Mode SAs + UINT32 currentActiveMainModes; + // Total number of Main Mode negotiations. + UINT32 totalMainModesStarted; + // Total number of successful Main Mode negotiations + UINT32 totalSuccessfulMainModes; + // Total number of failed Main Mode negotiations + UINT32 totalFailedMainModes; + // Total number of Main Mode negotiations that were externally intiated by + // a peer (responder) + UINT32 totalResponderMainModes; + // Current number of newly created responder Main Modes that are still in + // the initial state. + UINT32 currentNewResponderMainModes; + + // Following statistics are Quick Mode specific + + // Current number of active Quick Mode SAs + UINT32 currentActiveQuickModes; + // Total number of Quick Mode negotiations. + UINT32 totalQuickModesStarted; + // Total number of successful Quick Mode negotiations + UINT32 totalSuccessfulQuickModes; + // Total number of failed Quick Mode negotiations + UINT32 totalFailedQuickModes; + + // Total number of acquires received from BFE. + UINT32 totalAcquires; + // Total number of acquires that were internally reinitiated. + UINT32 totalReinitAcquires; + + // Following statistics are applicable only to Authip + + // Current number of active extended mode SAs + UINT32 currentActiveExtendedModes; + // Total number of extended mode negotiations. + UINT32 totalExtendedModesStarted; + // Total number of successful extended mode negotiations. + UINT32 totalSuccessfulExtendedModes; + // Total number of failed extended mode negotiations. + UINT32 totalFailedExtendedModes; + // Total number of successful extended mode negotiations that used + // impersonation + UINT32 totalImpersonationExtendedModes; + // Total number of successful Main Mode negotiations that used impersonation + UINT32 totalImpersonationMainModes; +} IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Various statistics specific to the keying module (IKE,Authip and IkeV2) and +// specific to the IP version +typedef struct IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1_ +{ + // Following statistics are Main Mode specific + + // Current number of active Main Mode SAs + UINT32 currentActiveMainModes; + // Total number of Main Mode negotiations. + UINT32 totalMainModesStarted; + // Total number of successful Main Mode negotiations + UINT32 totalSuccessfulMainModes; + // Total number of failed Main Mode negotiations + UINT32 totalFailedMainModes; + // Total number of Main Mode negotiations that were externally intiated by + // a peer (responder) + UINT32 totalResponderMainModes; + // Current number of newly created responder Main Modes that are still in + // the initial state. + UINT32 currentNewResponderMainModes; + + // Following statistics are Quick Mode specific + + // Current number of active Quick Mode SAs + UINT32 currentActiveQuickModes; + // Total number of Quick Mode negotiations. + UINT32 totalQuickModesStarted; + // Total number of successful Quick Mode negotiations + UINT32 totalSuccessfulQuickModes; + // Total number of failed Quick Mode negotiations + UINT32 totalFailedQuickModes; + + // Total number of acquires received from BFE. + UINT32 totalAcquires; + // Total number of acquires that were internally reinitiated. + UINT32 totalReinitAcquires; + + // Following statistics are applicable only to Authip + + // Current number of active extended mode SAs + UINT32 currentActiveExtendedModes; + // Total number of extended mode negotiations. + UINT32 totalExtendedModesStarted; + // Total number of successful extended mode negotiations. + UINT32 totalSuccessfulExtendedModes; + // Total number of failed extended mode negotiations. + UINT32 totalFailedExtendedModes; + // Total number of successful extended mode negotiations that used + // impersonation + UINT32 totalImpersonationExtendedModes; + // Total number of successful Main Mode negotiations that used impersonation + UINT32 totalImpersonationMainModes; +} IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +// Various statistics specific to the keying module (IKE or Authip) +typedef struct IKEEXT_KEYMODULE_STATISTICS0_ +{ + // IPv4 specific statistics + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0 v4Statistics; + // IPv6 specific statistics + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS0 v6Statistics; + // Table containing the frequencies of various IKE Win32 error codes + // (ranging from ERROR_IPSEC_IKE_NEG_STATUS_BEGIN to + // ERROR_IPSEC_IKE_NEG_STATUS_END) encountered during negotiations. + UINT32 errorFrequencyTable[IKEEXT_ERROR_CODE_COUNT]; + // Current Main Mode negotiation time (in msecs) + UINT32 mainModeNegotiationTime; + // Current Quick Mode negotiation time (in msecs) + UINT32 quickModeNegotiationTime; + // Current extended mode negotiation time (in msecs) (applicable to Authip + // only) + UINT32 extendedModeNegotiationTime; +} IKEEXT_KEYMODULE_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Various statistics specific to the keying module (IKE, Authip or IkeV2) +typedef struct IKEEXT_KEYMODULE_STATISTICS1_ +{ + // IPv4 specific statistics + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1 v4Statistics; + // IPv6 specific statistics + IKEEXT_IP_VERSION_SPECIFIC_KEYMODULE_STATISTICS1 v6Statistics; + // Table containing the frequencies of various IKE Win32 error codes + // (ranging from ERROR_IPSEC_IKE_NEG_STATUS_BEGIN to + // ERROR_IPSEC_IKE_NEG_STATUS_END) encountered during negotiations. + UINT32 errorFrequencyTable[IKEEXT_ERROR_CODE_COUNT]; + // Current Main Mode negotiation time (in msecs) + UINT32 mainModeNegotiationTime; + // Current Quick Mode negotiation time (in msecs) + UINT32 quickModeNegotiationTime; + // Current extended mode negotiation time (in msecs) (applicable to Authip + // only) + UINT32 extendedModeNegotiationTime; +} IKEEXT_KEYMODULE_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Various statistics common to IKE and Authip and specific to the protocol +// (IPv4 or IPv6) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0_ +{ + // Total number of UDP 500/4500 socket receive failures. + UINT32 totalSocketReceiveFailures; + // Total number of UDP 500/4500 socket send failures. + UINT32 totalSocketSendFailures; +} IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Various statistics common to IKE ,Authip and IkeV1 specific to the protocol +// (IPv4 or IPv6) +typedef struct IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1_ +{ + // Total number of UDP 500/4500 socket receive failures. + UINT32 totalSocketReceiveFailures; + // Total number of UDP 500/4500 socket send failures. + UINT32 totalSocketSendFailures; +} IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Various statistics common to IKE and Authip. +typedef struct IKEEXT_COMMON_STATISTICS0_ +{ + // IPv4 specific common statistics + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0 v4Statistics; + // IPv6 specific common statistics + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS0 v6Statistics; + // Total number of packets received. + UINT32 totalPacketsReceived; + // Total number of invalid packets received. + UINT32 totalInvalidPacketsReceived; + // Current number of workitems that are queued and waiting to be processed. + UINT32 currentQueuedWorkitems; +} IKEEXT_COMMON_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Various statistics common to IKE ,Authip and IkeV2. +typedef struct IKEEXT_COMMON_STATISTICS1_ +{ + // IPv4 specific common statistics + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1 v4Statistics; + // IPv6 specific common statistics + IKEEXT_IP_VERSION_SPECIFIC_COMMON_STATISTICS1 v6Statistics; + // Total number of packets received. + UINT32 totalPacketsReceived; + // Total number of invalid packets received. + UINT32 totalInvalidPacketsReceived; + // Current number of workitems that are queued and waiting to be processed. + UINT32 currentQueuedWorkitems; +} IKEEXT_COMMON_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Various statistics for IKE and Authip together +typedef struct IKEEXT_STATISTICS0_ +{ + // Statistics specific to IKE + IKEEXT_KEYMODULE_STATISTICS0 ikeStatistics; + // Statistics specific to Authip + IKEEXT_KEYMODULE_STATISTICS0 authipStatistics; + // Statistics common to IKE and Authip + IKEEXT_COMMON_STATISTICS0 commonStatistics; +} IKEEXT_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Various statistics for IKE ,Authip and IkeV2 together +typedef struct IKEEXT_STATISTICS1_ +{ + // Statistics specific to IKE + IKEEXT_KEYMODULE_STATISTICS1 ikeStatistics; + // Statistics specific to Authip + IKEEXT_KEYMODULE_STATISTICS1 authipStatistics; + // Statistics specific to IkeV2 + IKEEXT_KEYMODULE_STATISTICS1 ikeV2Statistics; + // Statistics common to IKE and Authip + IKEEXT_COMMON_STATISTICS1 commonStatistics; +} IKEEXT_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for retrieving IKE SA details. +// +/////////////////////////////////////////////////////////////////////////////// + +// Type describing the IKE/Authip traffic +typedef struct IKEEXT_TRAFFIC0_ +{ + // IP version + FWP_IP_VERSION ipVersion; + // Tagged union containing the local address of the traffic + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote address of the traffic + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + + // Filter ID from QM policy of matching EM filter + // FWPM_LAYER_IPSEC_XX + UINT64 authIpFilterId; + +} IKEEXT_TRAFFIC0; + +// Type used to store an IKE/Authip cookie +typedef UINT64 IKEEXT_COOKIE; + +// Type used to store a pair of IKE/Authip cookies +typedef struct IKEEXT_COOKIE_PAIR0_ +{ + // Initiator cookie + IKEEXT_COOKIE initiator; + // Responder cookie + IKEEXT_COOKIE responder; +} IKEEXT_COOKIE_PAIR0; + +// Certificate is a NAP (health) certificate +cpp_quote("#define IKEEXT_CERT_CREDENTIAL_FLAG_NAP_CERT (0x00000001)") + + +// Type used to store credential information specific to certificate +// authentication +typedef struct IKEEXT_CERTIFICATE_CREDENTIAL0_ +{ + // Encoded subject name of the certificate used for authentication + FWP_BYTE_BLOB subjectName; + // SHA thumbprint of the certificate + FWP_BYTE_BLOB certHash; + // Flags + UINT32 flags; +} IKEEXT_CERTIFICATE_CREDENTIAL0; + +// Type used to store credential name information +typedef struct IKEEXT_NAME_CREDENTIAL0_ +{ + // Name of the principal + [string, ref] wchar_t* principalName; +} IKEEXT_NAME_CREDENTIAL0; + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL0_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing credential information specific to the + // authentication method type. + // Type of impersonation. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] union + { + [case(IKEEXT_PRESHARED_KEY)] + [unique] IKEEXT_PRESHARED_KEY_AUTHENTICATION0* presharedKey; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384, + IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384, + IKEEXT_IPV6_CGA + )] + [unique] IKEEXT_CERTIFICATE_CREDENTIAL0* certificate; + [case(IKEEXT_KERBEROS, + IKEEXT_EAP, + IKEEXT_NTLM_V2)] + [unique] IKEEXT_NAME_CREDENTIAL0* name; + [case(IKEEXT_ANONYMOUS)]; + }; +} IKEEXT_CREDENTIAL0; + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL_PAIR0_ +{ + // Local credentials used for authentication + IKEEXT_CREDENTIAL0 localCredentials; + // Peer credentials used for authentication + IKEEXT_CREDENTIAL0 peerCredentials; +} IKEEXT_CREDENTIAL_PAIR0; + + +// Used to store multiple credential pairs. IKE has only 1 pair. AuthIp +// will have 1 or 2. IKEv2 can also have 1 or 2 (depending on if EAP was +// enabled). The MM auth is always index 0. EM auth, if it occurs is index 1. +typedef struct IKEEXT_CREDENTIALS0_ +{ + UINT32 numCredentials; + [size_is(numCredentials), ref] IKEEXT_CREDENTIAL_PAIR0* credentials; + +} IKEEXT_CREDENTIALS0; + + +// Type used to store information returned when enumerating IKE, Authip SAs. +typedef struct IKEEXT_SA_DETAILS0_ +{ + // LUID identifying the SA. + UINT64 saId; + // Key module type + IKEEXT_KEY_MODULE_TYPE keyModuleType; + // IP version + FWP_IP_VERSION ipVersion; + // If a NAT was detected, this stores the UDP ports corresponding to the + // main mode. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* v4UdpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // The traffic corresponding to this SA + IKEEXT_TRAFFIC0 ikeTraffic; + // The main mode proposal corresponding to this SA + IKEEXT_PROPOSAL0 ikeProposal; + // SA cookies + IKEEXT_COOKIE_PAIR0 cookiePair; + // Credential information for the SA + IKEEXT_CREDENTIALS0 ikeCredentials; + // GUID of the main mode policy provider context corresponding to this SA. + GUID ikePolicyKey; + // ID/Handle to virtual interface tunneling state. Currently this is specific + // to IKEv2. + UINT64 virtualIfTunnelId; +} IKEEXT_SA_DETAILS0; + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Type used to store credential information specific to certificate +// authentication +typedef struct IKEEXT_CERTIFICATE_CREDENTIAL1_ +{ + // Encoded subject name of the certificate used for authentication + FWP_BYTE_BLOB subjectName; + // SHA thumbprint of the certificate + FWP_BYTE_BLOB certHash; + // Flags + UINT32 flags; + // Encoded certificate + FWP_BYTE_BLOB certificate; +} IKEEXT_CERTIFICATE_CREDENTIAL1; + + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL1_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing credential information specific to the + // authentication method type. + // Type of impersonation. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] union + { + [case(IKEEXT_PRESHARED_KEY)] + [unique] IKEEXT_PRESHARED_KEY_AUTHENTICATION1* presharedKey; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384, + IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384, + IKEEXT_IPV6_CGA + )] + [unique] IKEEXT_CERTIFICATE_CREDENTIAL1* certificate; + [case(IKEEXT_KERBEROS, + IKEEXT_EAP, + IKEEXT_NTLM_V2)] + [unique] IKEEXT_NAME_CREDENTIAL0* name; + [case(IKEEXT_ANONYMOUS)]; + }; +} IKEEXT_CREDENTIAL1; + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL_PAIR1_ +{ + // Local credentials used for authentication + IKEEXT_CREDENTIAL1 localCredentials; + // Peer credentials used for authentication + IKEEXT_CREDENTIAL1 peerCredentials; +} IKEEXT_CREDENTIAL_PAIR1; + + +// Used to store multiple credential pairs. IKE has only 1 pair. AuthIp +// will have 1 or 2. IKEv2 can also have 1 or 2 (depending on if EAP was +// enabled). The MM auth is always index 0. EM auth, if it occurs is index 1. +typedef struct IKEEXT_CREDENTIALS1_ +{ + UINT32 numCredentials; + [size_is(numCredentials), ref] IKEEXT_CREDENTIAL_PAIR1* credentials; + +} IKEEXT_CREDENTIALS1; + + +// Type used to store information returned when enumerating IKE, Authip SAs. +typedef struct IKEEXT_SA_DETAILS1_ +{ + // LUID identifying the SA. + UINT64 saId; + // Key module type + IKEEXT_KEY_MODULE_TYPE keyModuleType; + // IP version + FWP_IP_VERSION ipVersion; + // If a NAT was detected, this stores the UDP ports corresponding to the + // main mode. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* v4UdpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // The traffic corresponding to this SA + IKEEXT_TRAFFIC0 ikeTraffic; + // The main mode proposal corresponding to this SA + IKEEXT_PROPOSAL0 ikeProposal; + // SA cookies + IKEEXT_COOKIE_PAIR0 cookiePair; + // Credential information for the SA + IKEEXT_CREDENTIALS1 ikeCredentials; + // GUID of the main mode policy provider context corresponding to this SA. + GUID ikePolicyKey; + // ID/Handle to virtual interface tunneling state. Currently this is specific + // to IKEv2. + UINT64 virtualIfTunnelId; + // Key derived from authentications so external apps can cryptographically bind + // their exchanges with the this SA + FWP_BYTE_BLOB correlationKey; +} IKEEXT_SA_DETAILS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL2_ +{ + // Type of authentication method + IKEEXT_AUTHENTICATION_METHOD_TYPE authenticationMethodType; + // Tagged union containing credential information specific to the + // authentication method type. + // Type of impersonation. + IKEEXT_AUTHENTICATION_IMPERSONATION_TYPE impersonationType; + + [switch_type(IKEEXT_AUTHENTICATION_METHOD_TYPE), + switch_is(authenticationMethodType)] union + { + [case(IKEEXT_PRESHARED_KEY)] + [unique] IKEEXT_PRESHARED_KEY_AUTHENTICATION1* presharedKey; + [case(IKEEXT_CERTIFICATE, + IKEEXT_CERTIFICATE_ECDSA_P256, + IKEEXT_CERTIFICATE_ECDSA_P384, + IKEEXT_SSL, + IKEEXT_SSL_ECDSA_P256, + IKEEXT_SSL_ECDSA_P384, + IKEEXT_IPV6_CGA + )] + [unique] IKEEXT_CERTIFICATE_CREDENTIAL1* certificate; + [case(IKEEXT_KERBEROS, + IKEEXT_EAP, + IKEEXT_NTLM_V2, + IKEEXT_RESERVED)] + [unique] IKEEXT_NAME_CREDENTIAL0* name; + [case(IKEEXT_ANONYMOUS)]; + }; +} IKEEXT_CREDENTIAL2; + +// Type used to store credential information used for the authentication +typedef struct IKEEXT_CREDENTIAL_PAIR2_ +{ + // Local credentials used for authentication + IKEEXT_CREDENTIAL2 localCredentials; + // Peer credentials used for authentication + IKEEXT_CREDENTIAL2 peerCredentials; +} IKEEXT_CREDENTIAL_PAIR2; + + +// Used to store multiple credential pairs. IKE has only 1 pair. AuthIp +// will have 1 or 2. IKEv2 can also have 1 or 2 (depending on if EAP was +// enabled). The MM auth is always index 0. EM auth, if it occurs is index 1. +typedef struct IKEEXT_CREDENTIALS2_ +{ + UINT32 numCredentials; + [size_is(numCredentials), ref] IKEEXT_CREDENTIAL_PAIR2* credentials; + +} IKEEXT_CREDENTIALS2; + + +// Type used to store information returned when enumerating IKE, Authip SAs. +typedef struct IKEEXT_SA_DETAILS2_ +{ + // LUID identifying the SA. + UINT64 saId; + // Key module type + IKEEXT_KEY_MODULE_TYPE keyModuleType; + // IP version + FWP_IP_VERSION ipVersion; + // If a NAT was detected, this stores the UDP ports corresponding to the + // main mode. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* v4UdpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // The traffic corresponding to this SA + IKEEXT_TRAFFIC0 ikeTraffic; + // The main mode proposal corresponding to this SA + IKEEXT_PROPOSAL0 ikeProposal; + // SA cookies + IKEEXT_COOKIE_PAIR0 cookiePair; + // Credential information for the SA + IKEEXT_CREDENTIALS2 ikeCredentials; + // GUID of the main mode policy provider context corresponding to this SA. + GUID ikePolicyKey; + // ID/Handle to virtual interface tunneling state. Currently this is specific + // to IKEv2. + UINT64 virtualIfTunnelId; + // Key derived from authentications so external apps can cryptographically bind + // their exchanges with the this SA + FWP_BYTE_BLOB correlationKey; +} IKEEXT_SA_DETAILS2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +// Enumeration template used for enumerating IKE SAs +typedef struct IKEEXT_SA_ENUM_TEMPLATE0_ +{ + // If not empty, only SAs whose local address is on the specified subnet + // will be returned. May be of type FWP_UINT32, FWP_BYTE_ARRAY16_TYPE, + // FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 localSubNet; + // If not empty, only SAs whose remote address is on the specified subnet + // will be returned. May be of type FWP_UINT32, FWP_BYTE_ARRAY16_TYPE, + // FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 remoteSubNet; + // If not zero-length, only SAs with a matching local main mode SHA + // thumbprint will be returned. + FWP_BYTE_BLOB localMainModeCertHash; +} IKEEXT_SA_ENUM_TEMPLATE0; + +// IKE main mode states +typedef [v1_enum] enum IKEEXT_MM_SA_STATE_ +{ + // Initial state. No MM packets have been sent to the peer yet. + IKEEXT_MM_SA_STATE_NONE, + // First roundtrip packet has been sent to the peer. + IKEEXT_MM_SA_STATE_SA_SENT, + // Second roundtrip packet has been sent to the peer, for SSPI auth. + IKEEXT_MM_SA_STATE_SSPI_SENT, + // Second roundtrip packet has been sent to the peer. + IKEEXT_MM_SA_STATE_FINAL, + // Final roundtrip packet has been sent to the peer. + IKEEXT_MM_SA_STATE_FINAL_SENT, + // MM has been completed. + IKEEXT_MM_SA_STATE_COMPLETE, + // Invalid value. + IKEEXT_MM_SA_STATE_MAX +} IKEEXT_MM_SA_STATE; + +// IKE quick mode states +typedef [v1_enum] enum IKEEXT_QM_SA_STATE_ +{ + // Initial state. No QM packets have been sent to the peer yet. + IKEEXT_QM_SA_STATE_NONE, + // State corresponding to the first QM roundtrip + IKEEXT_QM_SA_STATE_INITIAL, + // State corresponding to the final QM roundtrip + IKEEXT_QM_SA_STATE_FINAL, + // QM has been completed. + IKEEXT_QM_SA_STATE_COMPLETE, + // Invalid value. + IKEEXT_QM_SA_STATE_MAX +} IKEEXT_QM_SA_STATE; + +// IKE extended mode states +typedef [v1_enum] enum IKEEXT_EM_SA_STATE_ +{ + // Initial state. No EM packets have been sent to the peer yet. + IKEEXT_EM_SA_STATE_NONE, + // State corresponding to the first EM roundtrip + IKEEXT_EM_SA_STATE_SENT_ATTS, + // State corresponding to the second EM roundtrip + IKEEXT_EM_SA_STATE_SSPI_SENT, + // State corresponding to the final EM roundtrip + IKEEXT_EM_SA_STATE_AUTH_COMPLETE, + // State corresponding to the final EM roundtrip + IKEEXT_EM_SA_STATE_FINAL, + // EM has been completed + IKEEXT_EM_SA_STATE_COMPLETE, + // Invalid value. + IKEEXT_EM_SA_STATE_MAX +} IKEEXT_EM_SA_STATE; + +// IKE main mode or quick mode SA role +typedef [v1_enum] enum IKEEXT_SA_ROLE_ +{ + // SA is initiator + IKEEXT_SA_ROLE_INITIATOR, + // SA is responder + IKEEXT_SA_ROLE_RESPONDER, + // Invalid value. + IKEEXT_SA_ROLE_MAX +} IKEEXT_SA_ROLE; + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(pop)") +cpp_quote("#else") +cpp_quote("#pragma warning(default:4201)") +cpp_quote("#endif") +cpp_quote("#endif") + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */") +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/in6addr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/in6addr.h new file mode 100644 index 0000000000000000000000000000000000000000..df2902cb6c6f3badedde3be6d85ba15c2da662d1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/in6addr.h @@ -0,0 +1,50 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + in6addr.h + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef s6_addr +#pragma once + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// IPv6 Internet address (RFC 2553) +// This is an 'on-wire' format structure. +// +typedef struct in6_addr { + union { + UCHAR Byte[16]; + USHORT Word[8]; + } u; +} IN6_ADDR, *PIN6_ADDR, FAR *LPIN6_ADDR; + +#define in_addr6 in6_addr + +// +// Defines to match RFC 2553. +// +#define _S6_un u +#define _S6_u8 Byte +#define s6_addr _S6_un._S6_u8 + +// +// Defines for our implementation. +// +#define s6_bytes u.Byte +#define s6_words u.Word + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/inaddr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/inaddr.h new file mode 100644 index 0000000000000000000000000000000000000000..596d52fec149d748897336515f653ea04b4ea626 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/inaddr.h @@ -0,0 +1,42 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + inaddr.h + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef s_addr +#pragma once + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// IPv4 Internet address +// This is an 'on-wire' format structure. +// +typedef struct in_addr { + union { + struct { UCHAR s_b1,s_b2,s_b3,s_b4; } S_un_b; + struct { USHORT s_w1,s_w2; } S_un_w; + ULONG S_addr; + } S_un; +#define s_addr S_un.S_addr /* can be used for most tcp & ip code */ +#define s_host S_un.S_un_b.s_b2 // host on imp +#define s_net S_un.S_un_b.s_b1 // network +#define s_imp S_un.S_un_w.s_w2 // imp +#define s_impno S_un.S_un_b.s_b4 // imp # +#define s_lh S_un.S_un_b.s_b3 // logical host +} IN_ADDR, *PIN_ADDR, FAR *LPIN_ADDR; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/infstr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/infstr.h new file mode 100644 index 0000000000000000000000000000000000000000..6dc7751da95f8fa8ce71f0e50cf5a3ce2025dfac --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/infstr.h @@ -0,0 +1,439 @@ +/*** infstr.h - SetupAPI INF string definitions + * + * This module contains public registry string definitions. + * + * Copyright (c) Microsoft Corporation. All rights reserved. + * + * MODIFICATION HISTORY + */ + + +#ifndef _INC_INFSTR +#define _INC_INFSTR + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +//*************************************************************************** +// +// Misc. key strings used by Setup Info. File +// +//*************************************************************************** + +#define MAX_KEY_LEN 100 + +#define SZ_KEY_OPTIONDESC TEXT("OptionDesc") +#define SZ_KEY_LDIDOEM TEXT("LdidOEM") +#define SZ_KEY_SRCDISKFILES TEXT("SourceDisksFiles") +#define SZ_KEY_SRCDISKNAMES TEXT("SourceDisksNames") +#define SZ_KEY_STRINGS TEXT("Strings") +#define SZ_KEY_DESTDIRS TEXT("DestinationDirs") +#define SZ_KEY_LAYOUT_FILE TEXT("LayoutFile") +#define SZ_KEY_DEFDESTDIR TEXT("DefaultDestDir") +#define SZ_KEY_LFN_SECTION TEXT("VarLDID.LFN") +#define SZ_KEY_SFN_SECTION TEXT("VarLDID.SFN") + +#define SZ_KEY_UPDATEINIS TEXT("UpdateInis") +#define SZ_KEY_UPDATEINIFIELDS TEXT("UpdateIniFields") +#define SZ_KEY_INI2REG TEXT("Ini2Reg") +#define SZ_KEY_COPYFILES TEXT("CopyFiles") +#define SZ_KEY_RENFILES TEXT("RenFiles") +#define SZ_KEY_DELFILES TEXT("DelFiles") +#define SZ_KEY_ADDREG TEXT("AddReg") +#define SZ_KEY_ADDREGNOCLOBBER TEXT("AddRegNoClobber") +#define SZ_KEY_DELREG TEXT("DelReg") +#define SZ_KEY_BITREG TEXT("BitReg") +#define SZ_KEY_COPYINF TEXT("CopyINF") +#define SZ_KEY_LOGCONFIG TEXT("LogConfig") +#define SZ_KEY_ADDSERVICE TEXT("AddService") +#define SZ_KEY_DELSERVICE TEXT("DelService") +#define SZ_KEY_ADDTRIGGER TEXT("AddTrigger") +#define SZ_KEY_FAILUREACTIONS TEXT("FailureActions") +#define SZ_KEY_ADDINTERFACE TEXT("AddInterface") +#define SZ_KEY_ADDIME TEXT("AddIme") +#define SZ_KEY_DELIME TEXT("DelIme") +#define SZ_KEY_REGSVR TEXT("RegisterDlls") +#define SZ_KEY_UNREGSVR TEXT("UnregisterDlls") +#define SZ_KEY_PROFILEITEMS TEXT("ProfileItems") +#define SZ_KEY_MODULES TEXT("Modules") +#define SZ_KEY_DEFAULTOPTION TEXT("DefaultOption") +#define SZ_KEY_LISTOPTIONS TEXT("ListOptions") +#define SZ_KEY_CLEANONLY TEXT("CleanOnly") +#define SZ_KEY_UPGRADEONLY TEXT("UpgradeOnly") +#define SZ_KEY_EXCLUDEID TEXT("ExcludeId") +#define SZ_KEY_ADDPOWERSETTING TEXT("AddPowerSetting") +#define SZ_KEY_ADDPROP TEXT("AddProperty") +#define SZ_KEY_DELPROP TEXT("DelProperty") +#define SZ_KEY_FEATURESCORE TEXT("FeatureScore") +#define SZ_KEY_ADDEVENTPROVIDER TEXT("AddEventProvider") +#define SZ_KEY_ADDCOMSERVER TEXT("AddComServer") +#define SZ_KEY_ADDCOMCLASS TEXT("AddComClass") +#define SZ_KEY_ADDCHANNEL TEXT("AddChannel") +#define SZ_KEY_IMPORTCHANNEL TEXT("ImportChannel") +#define SZ_KEY_ADDAUTOLOGGER TEXT("AddAutoLogger") +#define SZ_KEY_UPDATEAUTOLOGGER TEXT("UpdateAutoLogger") +#define SZ_KEY_ADDAUTOLOGGERPROVIDER TEXT("AddAutoLoggerProvider") +#define SZ_KEY_ADDFILTER TEXT("AddFilter") +#define SZ_KEY_FILTERLEVEL TEXT("FilterLevel") +#define SZ_KEY_FILTERPOSITION TEXT("FilterPosition") +#define SZ_KEY_ADDCOMPONENT TEXT("AddComponent") + +// These are here for compatability with SetupX +// They are registry keys, and are not used by SetupAPI +#define SZ_KEY_PHASE1 TEXT("Phase1") +#define SZ_KEY_HARDWARE TEXT("Hardware") + +// Foll. char is used to enclose a STRING KEY -- A key enclosed by this char +// should be in the [Strings] section of the INF file. +#define CH_STRINGKEY TEXT('%') + +// Foll. char is used to specify that what follows it is a file name +// rather than a section with files in the Copy= file of a Generic +// Install_Section. +// +#define CH_FILESPECIFIER TEXT('@') + + + +/*** Strings that will be used in the PnP INF files to specify + * LogConfig information, etc. This will be used to update the + * registry appropriately. + */ + +#define INFSTR_KEY_CONFIGPRIORITY TEXT("ConfigPriority") + +// Foll. is length of buffer for the strings like HARDWIRED, etc. +#define MAX_PRIORITYSTR_LEN 16 + +/*** Foll. are strings that can be used for ConfigPriority= + */ +#define INFSTR_CFGPRI_HARDWIRED TEXT("HARDWIRED") +#define INFSTR_CFGPRI_DESIRED TEXT("DESIRED") +#define INFSTR_CFGPRI_NORMAL TEXT("NORMAL") +#define INFSTR_CFGPRI_SUBOPTIMAL TEXT("SUBOPTIMAL") +#define INFSTR_CFGPRI_DISABLED TEXT("DISABLED") +#define INFSTR_CFGPRI_RESTART TEXT("RESTART") +#define INFSTR_CFGPRI_REBOOT TEXT("REBOOT") +#define INFSTR_CFGPRI_POWEROFF TEXT("POWEROFF") +#define INFSTR_CFGPRI_HARDRECONFIG TEXT("HARDRECONFIG") +#define INFSTR_CFGPRI_FORCECONFIG TEXT("FORCECONFIG") + +#define INFSTR_CFGTYPE_BASIC TEXT("BASIC") +#define INFSTR_CFGTYPE_FORCED TEXT("FORCED") +#define INFSTR_CFGTYPE_OVERRIDE TEXT("OVERRIDE") + + +#define INFSTR_KEY_MEMCONFIG TEXT("MemConfig") +#define INFSTR_KEY_MEMLARGECONFIG TEXT("MemLargeConfig") +#define INFSTR_KEY_IOCONFIG TEXT("IOConfig") +#define INFSTR_KEY_IRQCONFIG TEXT("IRQConfig") +#define INFSTR_KEY_DMACONFIG TEXT("DMAConfig") +#define INFSTR_KEY_PCCARDCONFIG TEXT("PcCardConfig") +#define INFSTR_KEY_MFCARDCONFIG TEXT("MfCardConfig") + +// +// Used to install a class installer +// +#define INFSTR_SECT_CLASS_INSTALL TEXT("ClassInstall") +#define INFSTR_SECT_CLASS_INSTALL_32 TEXT("ClassInstall32") + +// +// Used to install a primitive INF +// +#define INFSTR_SECT_DEFAULT_INSTALL TEXT("DefaultInstall") +#define INFSTR_SECT_DEFAULT_UNINSTALL TEXT("DefaultUninstall") + +// +// Used to install an interface class +// +#define INFSTR_SECT_INTERFACE_INSTALL_32 TEXT("InterfaceInstall32") + +// General information about the contents/origins of the .INF. +#define INFSTR_SECT_VERSION TEXT("Version") + +// Provider name under [version] section +#define INFSTR_KEY_PROVIDER TEXT("Provider") + +// Signature under [version] section indicates a Win95-style device INF +#define INFSTR_KEY_SIGNATURE TEXT("Signature") + +// Dependent driver subset under [Version] section +#define INFSTR_KEY_DRIVERSET TEXT("DriverSet") + +// [Version] +// Specifies what the hardware class of any devices contained in this .INF. +#define MAX_INF_FLAG 20 +#define INFSTR_KEY_HARDWARE_CLASS TEXT("Class") +#define INFSTR_KEY_HARDWARE_CLASSGUID TEXT("ClassGUID") +#define INFSTR_KEY_NOSETUPINF TEXT("NoSetupInf") +#define INFSTR_KEY_FROMINET TEXT("FromINet") +#define INFSTR_KEY_CATALOGFILE TEXT("CatalogFile") +#define INFSTR_KEY_PNPLOCKDOWN TEXT("PnpLockDown") +#define INFSTR_KEY_EXTENSIONID TEXT("ExtensionId") + +// +// Manufacturer section name +// +#define INFSTR_SECT_MFG TEXT("Manufacturer") + +#define INFSTR_SECT_TARGETCOMPUTERS TEXT("TargetComputers") + +#define INFSTR_SECT_EXTENSIONCONTRACTS TEXT("ExtensionContracts") + +// +// Specifies the hardware class of this device. +// +#define INFSTR_KEY_CLASS TEXT("Class") +#define INFSTR_KEY_CLASSGUID TEXT("ClassGUID") + +// +// Used by (Setup)DiInstallDevice to know that need to reboot or restart after +// installing the device. +// +#define INFSTR_RESTART TEXT("Restart") +#define INFSTR_REBOOT TEXT("Reboot") + +// +// Used by SetupDiInstallDevice to specify the service parameters passed +// to the Service Control Manager to create/modify a service. +// +#define INFSTR_KEY_DISPLAYNAME TEXT("DisplayName") +#define INFSTR_KEY_SERVICETYPE TEXT("ServiceType") +#define INFSTR_KEY_STARTTYPE TEXT("StartType") +#define INFSTR_KEY_ERRORCONTROL TEXT("ErrorControl") +#define INFSTR_KEY_SERVICEBINARY TEXT("ServiceBinary") +#define INFSTR_KEY_LOADORDERGROUP TEXT("LoadOrderGroup") +#define INFSTR_KEY_DEPENDENCIES TEXT("Dependencies") +#define INFSTR_KEY_REQUIREDPRIVILEGES TEXT("RequiredPrivileges") +#define INFSTR_KEY_STARTNAME TEXT("StartName") +#define INFSTR_KEY_SECURITY TEXT("Security") +#define INFSTR_KEY_DESCRIPTION TEXT("Description") +#define INFSTR_KEY_SERVICESIDTYPE TEXT("ServiceSidType") +#define INFSTR_KEY_DELAYEDAUTOSTART TEXT("DelayedAutoStart") +#define INFSTR_KEY_BOOTFLAGS TEXT("BootFlags") + +// +// Used for Triggers within a Service section. +// +#define INFSTR_KEY_TRIGGER_TYPE TEXT("TriggerType") +#define INFSTR_KEY_ACTION TEXT("Action") +#define INFSTR_KEY_SUB_TYPE TEXT("SubType") +#define INFSTR_KEY_DATA_ITEM TEXT("DataItem") + +// +// Used for FailureActions within a Service section +// +#define INFSTR_KEY_RESET_PERIOD TEXT("ResetPeriod") +#define INFSTR_KEY_NON_CRASH_FAILURES TEXT("NonCrashFailures") +#define INFSTR_KEY_FAILURE_ACTION TEXT("Action") + +// +// Used in event provider section +// +#define INFSTR_KEY_PROVIDER_NAME TEXT("ProviderName") +#define INFSTR_KEY_RESOURCE_FILE TEXT("ResourceFile") +#define INFSTR_KEY_MESSAGE_FILE TEXT("MessageFile") +#define INFSTR_KEY_PARAMETER_FILE TEXT("ParameterFile") + +// +// Used in COM server section +// +#define INFSTR_KEY_COM_SERVER_TYPE TEXT("ServerType") +#define INFSTR_KEY_COM_SERVER_BINARY TEXT("ServerBinary") +#define INFSTR_KEY_COM_SERVER_BINARY_WOW64 TEXT("ServerBinaryWow64") +#define INFSTR_KEY_COM_SERVER_ADD_COM_CLASS TEXT("AddComClass") + +// +// Used in COM class section +// +#define INFSTR_KEY_COM_CLASS_THREADING_MODEL TEXT("ThreadingModel") +#define INFSTR_KEY_COM_CLASS_DESCRIPTION TEXT("Description") + +// +// Used in components section +// +#define INFSTR_KEY_COMPONENTIDS TEXT("ComponentIds") + +// +// Used for channel attributes in event channel section +// +#define INFSTR_KEY_CHANNEL_ACCESS TEXT("Access") +#define INFSTR_KEY_CHANNEL_ISOLATION TEXT("Isolation") +#define INFSTR_KEY_CHANNEL_ENABLED TEXT("Enabled") +#define INFSTR_KEY_CHANNEL_VALUE TEXT("Value") + +// +// Used for logging attributes in event channel section +// +#define INFSTR_KEY_LOGGING_MAXSIZE TEXT("LoggingMaxSize") +#define INFSTR_KEY_LOGGING_RETENTION TEXT("LoggingRetention") +#define INFSTR_KEY_LOGGING_AUTOBACKUP TEXT("LoggingAutoBackup") + +// +// Used in event autologger section +// +#define INFSTR_KEY_START TEXT("Start") +#define INFSTR_KEY_BUFFER_SIZE TEXT("BufferSize") +#define INFSTR_KEY_CLOCK_TYPE TEXT("ClockType") +#define INFSTR_KEY_DISABLE_REALTIME_PERSISTENCE TEXT("DisableRealtimePersistence") +#define INFSTR_KEY_FILE_NAME TEXT("FileName") +#define INFSTR_KEY_FILE_MAX TEXT("FileMax") +#define INFSTR_KEY_FLUSH_TIMER TEXT("FlushTimer") +#define INFSTR_KEY_LOG_FILE_MODE TEXT("LogFileMode") +#define INFSTR_KEY_MAX_FILE_SIZE TEXT("MaxFileSize") +#define INFSTR_KEY_MAXIMUM_BUFFERS TEXT("MaximumBuffers") +#define INFSTR_KEY_MINIMUM_BUFFERS TEXT("MinimumBuffers") + +// +// Used in event autologger provider section +// +#define INFSTR_KEY_ENABLED TEXT("Enabled") +#define INFSTR_KEY_ENABLE_FLAGS TEXT("EnableFlags") +#define INFSTR_KEY_ENABLE_LEVEL TEXT("EnableLevel") +#define INFSTR_KEY_ENABLE_PROPERTY TEXT("EnableProperty") +#define INFSTR_KEY_MATCH_ANY_KEYWORD TEXT("MatchAnyKeyword") +#define INFSTR_KEY_MATCH_ALL_KEYWORD TEXT("MatchAllKeyword") + +// The following are the characters to parse IORange and MemRange fields. +#define CH_SIZE_DELIM TEXT('@') +#define CH_MINMAX_SEP TEXT('-') +#define CH_ALIGNMASK_BEGIN TEXT('%') +#define CH_TRAIL_BEGIN TEXT('(') +#define CH_TRAIL_SEP TEXT(':') +#define CH_TRAIL_END TEXT(')') + + +// The following is char to parse IRQ and DMA attr from the numbers! +#define CH_ATTR_DELIM TEXT(':') + +// The following is for Windows 9x System Detection +#define INFSTR_SECT_DETMODULES TEXT("Det.Modules") +#define INFSTR_SECT_DETCLASSINFO TEXT("Det.ClassInfo") +#define INFSTR_SECT_MANUALDEV TEXT("Det.ManualDev") +#define INFSTR_SECT_AVOIDCFGSYSDEV TEXT("Det.AvoidCfgSysDev") +#define INFSTR_SECT_REGCFGSYSDEV TEXT("Det.RegCfgSysDev") +#define INFSTR_SECT_DEVINFS TEXT("Det.DevINFs") +#define INFSTR_SECT_AVOIDINIDEV TEXT("Det.AvoidIniDev") +#define INFSTR_SECT_AVOIDENVDEV TEXT("Det.AvoidEnvDev") +#define INFSTR_SECT_REGINIDEV TEXT("Det.RegIniDev") +#define INFSTR_SECT_REGENVDEV TEXT("Det.RegEnvDev") +#define INFSTR_SECT_HPOMNIBOOK TEXT("Det.HPOmnibook") +#define INFSTR_SECT_FORCEHWVERIFY TEXT("Det.ForceHWVerify") +#define INFSTR_SECT_DETOPTIONS TEXT("Det.Options") +#define INFSTR_SECT_BADPNPBIOS TEXT("BadPnpBios") +#define INFSTR_SECT_GOODACPIBIOS TEXT("GoodACPIBios") +#define INFSTR_SECT_BADACPIBIOS TEXT("BadACPIBios") +#define INFSTR_SECT_BADROUTINGTABLEBIOS TEXT("BadPCIIRQRoutingTableBios") +#define INFSTR_SECT_BADPMCALLBIOS TEXT("BadProtectedModeCallBios") +#define INFSTR_SECT_BADRMCALLBIOS TEXT("BadRealModeCallBios") +#define INFSTR_SECT_MACHINEIDBIOS TEXT("MachineIDBios") +#define INFSTR_SECT_BADDISKBIOS TEXT("BadDiskBios") +#define INFSTR_SECT_BADDSBIOS TEXT("BadDSBios") +#define INFSTR_KEY_DETPARAMS TEXT("Params") +#define INFSTR_KEY_SKIPLIST TEXT("SkipList") +#define INFSTR_KEY_DETECTLIST TEXT("DetectList") +#define INFSTR_KEY_EXCLUDERES TEXT("ExcludeRes") + +//Subkeys are used in the form x. +#define INFSTR_SUBKEY_LOGCONFIG TEXT("LogConfig") +#define INFSTR_SUBKEY_DET TEXT("Det") +#define INFSTR_SUBKEY_FACTDEF TEXT("FactDef") +#define INFSTR_SUBKEY_POSSIBLEDUPS TEXT("PosDup") +#define INFSTR_SUBKEY_NORESOURCEDUPS TEXT("NoResDup") +#define INFSTR_SUBKEY_HW TEXT("Hw") +#define INFSTR_SUBKEY_CTL TEXT("CTL") +#define INFSTR_SUBKEY_SERVICES TEXT("Services") +#define INFSTR_SUBKEY_SOFTWARE TEXT("Software") +#define INFSTR_SUBKEY_INTERFACES TEXT("Interfaces") +#define INFSTR_SUBKEY_COINSTALLERS TEXT("CoInstallers") +#define INFSTR_SUBKEY_LOGCONFIGOVERRIDE TEXT("LogConfigOverride") +#define INFSTR_SUBKEY_WMI TEXT("WMI") +#define INFSTR_SUBKEY_EVENTS TEXT("Events") +#define INFSTR_SUBKEY_COM TEXT("COM") +#define INFSTR_SUBKEY_FILTERS TEXT("Filters") +#define INFSTR_SUBKEY_COMPONENTS TEXT("Components") + +// Control Section +#define INFSTR_CONTROLFLAGS_SECTION TEXT("ControlFlags") +#define INFSTR_KEY_COPYFILESONLY TEXT("CopyFilesOnly") +#define INFSTR_KEY_EXCLUDEFROMSELECT TEXT("ExcludeFromSelect") +#define INFSTR_KEY_ALWAYSEXCLUDEFROMSELECT TEXT("AlwaysExcludeFromSelect") +#define INFSTR_KEY_INTERACTIVEINSTALL TEXT("InteractiveInstall") +#define INFSTR_KEY_REQUESTADDITIONALSOFTWARE TEXT("RequestAdditionalSoftware") + +// Platform-specific suffixes (e.g., "ExcludeFromSelect.NT") +#define INFSTR_PLATFORM_WIN TEXT("Win") +#define INFSTR_PLATFORM_NT TEXT("NT") +#define INFSTR_PLATFORM_NTX86 TEXT("NTx86") +#define INFSTR_PLATFORM_NTMIPS TEXT("NTMIPS") +#define INFSTR_PLATFORM_NTALPHA TEXT("NTAlpha") +#define INFSTR_PLATFORM_NTPPC TEXT("NTPPC") +#define INFSTR_PLATFORM_NTIA64 TEXT("NTIA64") +#define INFSTR_PLATFORM_NTAXP64 TEXT("NTAXP64") +#define INFSTR_PLATFORM_NTAMD64 TEXT("NTAMD64") +#define INFSTR_PLATFORM_NTARM TEXT("NTARM") +#define INFSTR_PLATFORM_NTARM64 TEXT("NTARM64") + +// Fields that will by used to dereference strings. +// These are of the form x. were strkey is limited to +// MAX_INFSTR_STRKEY_LEN characters +#define MAX_INFSTR_STRKEY_LEN 32 +#define INFSTR_STRKEY_DRVDESC TEXT("DriverDesc") +// DriverSelect +#define INFSTR_DRIVERSELECT_SECTION TEXT("DriverSelect") +#define INFSTR_DRIVERSELECT_FUNCTIONS TEXT("DriverSelectFunctions") + +// Driver Version +#define INFSTR_DRIVERVERSION_SECTION TEXT("DriverVer") + +// Software Version +#define INFSTR_SOFTWAREVERSION_SECTION TEXT("SoftwareVersion") + +// The following is for PCMCIA.INF parsing +#define INFSTR_SECT_CFGSYS TEXT("ConfigSysDrivers") +#define INFSTR_SECT_AUTOEXECBAT TEXT("AutoexecBatDrivers") +#define INFSTR_SECT_SYSINI TEXT("SystemIniDrivers") +#define INFSTR_SECT_SYSINIDRV TEXT("SystemIniDriversLine") +#define INFSTR_SECT_WININIRUN TEXT("WinIniRunLine") + +//Keys in the config.sys device sections +#define INFSTR_KEY_PATH TEXT("Path") +#define INFSTR_KEY_NAME TEXT("Name") +#define INFSTR_KEY_IO TEXT("IO") +#define INFSTR_KEY_MEM TEXT("Mem") +#define INFSTR_KEY_IRQ TEXT("IRQ") +#define INFSTR_KEY_DMA TEXT("DMA") + +//Fields of detection function registration +#define INFSTR_BUS_ISA TEXT("BUS_ISA") +#define INFSTR_BUS_EISA TEXT("BUS_EISA") +#define INFSTR_BUS_MCA TEXT("BUS_MCA") +#define INFSTR_BUS_ALL TEXT("BUS_ALL") +#define INFSTR_RISK_NONE TEXT("RISK_NONE") +#define INFSTR_RISK_VERYLOW TEXT("RISK_VERYLOW") +#define INFSTR_RISK_BIOSROMRD TEXT("RISK_BIOSROMRD") +#define INFSTR_RISK_QUERYDRV TEXT("RISK_QUERYDRV") +#define INFSTR_RISK_SWINT TEXT("RISK_SWINT") +#define INFSTR_RISK_LOW TEXT("RISK_LOW") +#define INFSTR_RISK_DELICATE TEXT("RISK_DELICATE") +#define INFSTR_RISK_MEMRD TEXT("RISK_MEMRD") +#define INFSTR_RISK_IORD TEXT("RISK_IORD") +#define INFSTR_RISK_MEMWR TEXT("RISK_MEMWR") +#define INFSTR_RISK_IOWR TEXT("RISK_IOWR") +#define INFSTR_RISK_UNRELIABLE TEXT("RISK_UNRELIABLE") +#define INFSTR_RISK_VERYHIGH TEXT("RISK_VERYHIGH") +#define INFSTR_CLASS_SAFEEXCL TEXT("SAFE_EXCL") + +#define INFSTR_SECT_DISPLAY_CLEANUP TEXT("DisplayCleanup") + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif //_INC_INFSTR diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/initguid.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/initguid.h new file mode 100644 index 0000000000000000000000000000000000000000..12a43f69e2dfc3ba7081930ff70e1ba0463dad40 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/initguid.h @@ -0,0 +1,16 @@ +/*****************************************************************************\ +* * +* initguid.h - Definitions for controlling GUID initialization * +* * +* OLE Version 2.0 * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +\*****************************************************************************/ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#define INITGUID +#include diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/intsafe.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/intsafe.h new file mode 100644 index 0000000000000000000000000000000000000000..78693755824fe765b1215ab853eadadbca28a113 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/intsafe.h @@ -0,0 +1,8689 @@ +/****************************************************************** +* * +* intsafe.h -- This module defines helper functions to prevent * +* integer overflow bugs. * +* * +* Copyright (c) Microsoft Corp. All rights reserved. * +* * +******************************************************************/ +#ifndef _INTSAFE_H_INCLUDED_ +#define _INTSAFE_H_INCLUDED_ + +#include + + +#if (_MSC_VER > 1000) +#pragma once +#endif + +#pragma region Application Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#include // for _In_, etc. + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#endif + +#if !defined(_W64) +#if !defined(__midl) && (defined(_X86_) || defined(_M_IX86) || defined(_ARM_) || defined(_M_ARM)) && (_MSC_VER >= 1300) +#define _W64 __w64 +#else +#define _W64 +#endif +#endif + +// +// typedefs +// +typedef char CHAR; +typedef signed char INT8; +typedef unsigned char UCHAR; +typedef unsigned char UINT8; +typedef unsigned char BYTE; +typedef short SHORT; +typedef signed short INT16; +typedef unsigned short USHORT; +typedef unsigned short UINT16; +typedef unsigned short WORD; +typedef int INT; +typedef signed int INT32; +typedef unsigned int UINT; +typedef unsigned int UINT32; +typedef long LONG; +typedef unsigned long ULONG; +typedef unsigned long DWORD; +typedef __int64 LONGLONG; +typedef __int64 LONG64; +typedef signed __int64 INT64; +typedef unsigned __int64 ULONGLONG; +typedef unsigned __int64 DWORDLONG; +typedef unsigned __int64 ULONG64; +typedef unsigned __int64 DWORD64; +typedef unsigned __int64 UINT64; + +#if (__midl > 501) +typedef [public] __int3264 INT_PTR; +typedef [public] unsigned __int3264 UINT_PTR; +typedef [public] __int3264 LONG_PTR; +typedef [public] unsigned __int3264 ULONG_PTR; +#else +#ifdef _WIN64 +typedef __int64 INT_PTR; +typedef unsigned __int64 UINT_PTR; +typedef __int64 LONG_PTR; +typedef unsigned __int64 ULONG_PTR; +#else +typedef _W64 int INT_PTR; +typedef _W64 unsigned int UINT_PTR; +typedef _W64 long LONG_PTR; +typedef _W64 unsigned long ULONG_PTR; +#endif // WIN64 +#endif // (__midl > 501) + +#ifdef _WIN64 +typedef __int64 ptrdiff_t; +typedef unsigned __int64 size_t; +#else +typedef _W64 int ptrdiff_t; +typedef _W64 unsigned int size_t; +#endif + +typedef ULONG_PTR DWORD_PTR; +typedef LONG_PTR SSIZE_T; +typedef ULONG_PTR SIZE_T; + +#undef _USE_INTRINSIC_MULTIPLY128 + +#if !defined(_ARM64_MULT_INTRINS_SUPPORTED) +#define _ARM64_MULT_INTRINS_SUPPORTED 0 +#if (defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64)) +#if defined(__clang__) +#if __has_builtin(__umulh) && __has_builtin(__mulh) +#undef _ARM64_MULT_INTRINS_SUPPORTED +#define _ARM64_MULT_INTRINS_SUPPORTED 1 +#endif // __has_builtin(__umulh) && __has_builtin(__mulh) +#else // defined(__clang__) +#undef _ARM64_MULT_INTRINS_SUPPORTED +#define _ARM64_MULT_INTRINS_SUPPORTED 1 +#endif // defined(__clang__) +#endif // (defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64)) +#endif // !defined(_ARM64_MULT_INTRINS_SUPPORTED) + +#if !defined(_M_CEE) && \ + ((defined(_M_X64) && !defined(_M_ARM64EC)) || \ + (defined(_ARM64_MULT_INTRINS_SUPPORTED) && _ARM64_MULT_INTRINS_SUPPORTED) || \ + (defined(_M_IA64) && (_MSC_VER >= 1400))) +#define _USE_INTRINSIC_MULTIPLY128 +#endif + +#if defined(_USE_INTRINSIC_MULTIPLY128) +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(_M_X64) && !defined(_M_ARM64EC) + +#define __UnsignedMultiply128 _umul128 + +#endif // defined(_M_X64) && !defined(_M_ARM64EC) + +ULONG64 +__UnsignedMultiply128( + _In_ ULONG64 Multiplicand, + _In_ ULONG64 Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) ULONG64* HighProduct); + +#if defined(_M_X64) && !defined(_M_ARM64EC) +#pragma intrinsic(_umul128) +#endif + +#if defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64) + +ULONG64 +__umulh( + _In_ ULONG64 Multiplicand, + _In_ ULONG64 Multiplier + ); + +#pragma intrinsic(__umulh) + +__inline +ULONG64 +__UnsignedMultiply128( + _In_ ULONG64 Multiplicand, + _In_ ULONG64 Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) ULONG64* HighProduct) +{ + *HighProduct = __umulh(Multiplier, Multiplicand); + return Multiplier * Multiplicand; +} + +#endif // defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64) + +#ifdef __cplusplus +} +#endif +#endif // _USE_INTRINSIC_MULTIPLY128 + + + +typedef _Return_type_success_(return >= 0) long HRESULT; + +#define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0) +#define FAILED(hr) (((HRESULT)(hr)) < 0) + +#define S_OK ((HRESULT)0L) + +#define INTSAFE_E_ARITHMETIC_OVERFLOW ((HRESULT)0x80070216L) // 0x216 = 534 = ERROR_ARITHMETIC_OVERFLOW +#ifndef SORTPP_PASS +// compiletime asserts (failure results in error C2118: negative subscript) +#define C_ASSERT(e) typedef char __C_ASSERT__[(e)?1:-1] +#else +#define C_ASSERT(e) +#endif + +// +// UInt32x32To64 macro +// +#ifndef UInt32x32To64 +#if defined(MIDL_PASS) || defined(RC_INVOKED) || defined(_M_CEE_PURE) \ + || defined(_68K_) || defined(_MPPC_) \ + || defined(_M_IA64) || defined(_M_X64) || defined(_M_ARM) || defined(_M_ARM64) \ + || defined(_M_HYBRID_X86_ARM64) +#define UInt32x32To64(a, b) (((unsigned __int64)((unsigned int)(a))) * ((unsigned __int64)((unsigned int)(b)))) +#elif defined(_M_IX86) +#define UInt32x32To64(a, b) ((unsigned __int64)(((unsigned __int64)((unsigned int)(a))) * ((unsigned int)(b)))) +#else +#error Must define a target architecture. +#endif +#endif + +// +// Min/Max type values +// +#define INT8_MIN (-127i8 - 1) +#define SHORT_MIN (-32768) +#define INT16_MIN (-32767i16 - 1) +#ifndef INT_MIN +#define INT_MIN (-2147483647 - 1) +#endif +#define INT32_MIN (-2147483647i32 - 1) +#ifndef LONG_MIN +#define LONG_MIN (-2147483647L - 1) +#endif +#define LONGLONG_MIN (-9223372036854775807i64 - 1) +#define LONG64_MIN (-9223372036854775807i64 - 1) +#define INT64_MIN (-9223372036854775807i64 - 1) +#define INT128_MIN (-170141183460469231731687303715884105727i128 - 1) + +#ifdef _WIN64 +#define INT_PTR_MIN (-9223372036854775807i64 - 1) +#define LONG_PTR_MIN (-9223372036854775807i64 - 1) +#define PTRDIFF_T_MIN (-9223372036854775807i64 - 1) +#define SSIZE_T_MIN (-9223372036854775807i64 - 1) +#else +#define INT_PTR_MIN (-2147483647 - 1) +#define LONG_PTR_MIN (-2147483647L - 1) +#define PTRDIFF_T_MIN (-2147483647 - 1) +#define SSIZE_T_MIN (-2147483647L - 1) +#endif + +#define INT8_MAX 127i8 +#define UINT8_MAX 0xffui8 +#define BYTE_MAX 0xff +#define SHORT_MAX 32767 +#define INT16_MAX 32767i16 +#define USHORT_MAX 0xffff +#define UINT16_MAX 0xffffui16 +#define WORD_MAX 0xffff +#ifndef INT_MAX +#define INT_MAX 2147483647 +#endif +#define INT32_MAX 2147483647i32 +#ifndef UINT_MAX +#define UINT_MAX 0xffffffff +#endif +#define UINT32_MAX 0xffffffffui32 +#ifndef LONG_MAX +#define LONG_MAX 2147483647L +#endif +#ifndef ULONG_MAX +#define ULONG_MAX 0xffffffffUL +#endif +#define DWORD_MAX 0xffffffffUL +#define LONGLONG_MAX 9223372036854775807i64 +#define LONG64_MAX 9223372036854775807i64 +#define INT64_MAX 9223372036854775807i64 +#define ULONGLONG_MAX 0xffffffffffffffffui64 +#define DWORDLONG_MAX 0xffffffffffffffffui64 +#define ULONG64_MAX 0xffffffffffffffffui64 +#define DWORD64_MAX 0xffffffffffffffffui64 +#define UINT64_MAX 0xffffffffffffffffui64 +#define INT128_MAX 170141183460469231731687303715884105727i128 +#define UINT128_MAX 0xffffffffffffffffffffffffffffffffui128 + +#undef SIZE_T_MAX + +#ifdef _WIN64 +#define INT_PTR_MAX 9223372036854775807i64 +#define UINT_PTR_MAX 0xffffffffffffffffui64 +#define LONG_PTR_MAX 9223372036854775807i64 +#define ULONG_PTR_MAX 0xffffffffffffffffui64 +#define DWORD_PTR_MAX 0xffffffffffffffffui64 +#define PTRDIFF_T_MAX 9223372036854775807i64 +#define SIZE_T_MAX 0xffffffffffffffffui64 +#define SSIZE_T_MAX 9223372036854775807i64 +#define _SIZE_T_MAX 0xffffffffffffffffui64 +#else +#define INT_PTR_MAX 2147483647 +#define UINT_PTR_MAX 0xffffffff +#define LONG_PTR_MAX 2147483647L +#define ULONG_PTR_MAX 0xffffffffUL +#define DWORD_PTR_MAX 0xffffffffUL +#define PTRDIFF_T_MAX 2147483647 +#define SIZE_T_MAX 0xffffffff +#define SSIZE_T_MAX 2147483647L +#define _SIZE_T_MAX 0xffffffffUL +#endif + + +// +// It is common for -1 to be used as an error value +// +#define INT8_ERROR (-1i8) +#define UINT8_ERROR 0xffui8 +#define BYTE_ERROR 0xff +#define SHORT_ERROR (-1) +#define INT16_ERROR (-1i16) +#define USHORT_ERROR 0xffff +#define UINT16_ERROR 0xffffui16 +#define WORD_ERROR 0xffff +#define INT_ERROR (-1) +#define INT32_ERROR (-1i32) +#define UINT_ERROR 0xffffffff +#define UINT32_ERROR 0xffffffffui32 +#define LONG_ERROR (-1L) +#define ULONG_ERROR 0xffffffffUL +#define DWORD_ERROR 0xffffffffUL +#define LONGLONG_ERROR (-1i64) +#define LONG64_ERROR (-1i64) +#define INT64_ERROR (-1i64) +#define ULONGLONG_ERROR 0xffffffffffffffffui64 +#define DWORDLONG_ERROR 0xffffffffffffffffui64 +#define ULONG64_ERROR 0xffffffffffffffffui64 +#define UINT64_ERROR 0xffffffffffffffffui64 + +#ifdef _WIN64 +#define INT_PTR_ERROR (-1i64) +#define UINT_PTR_ERROR 0xffffffffffffffffui64 +#define LONG_PTR_ERROR (-1i64) +#define ULONG_PTR_ERROR 0xffffffffffffffffui64 +#define DWORD_PTR_ERROR 0xffffffffffffffffui64 +#define PTRDIFF_T_ERROR (-1i64) +#define SIZE_T_ERROR 0xffffffffffffffffui64 +#define SSIZE_T_ERROR (-1i64) +#define _SIZE_T_ERROR 0xffffffffffffffffui64 +#else +#define INT_PTR_ERROR (-1) +#define UINT_PTR_ERROR 0xffffffff +#define LONG_PTR_ERROR (-1L) +#define ULONG_PTR_ERROR 0xffffffffUL +#define DWORD_PTR_ERROR 0xffffffffUL +#define PTRDIFF_T_ERROR (-1) +#define SIZE_T_ERROR 0xffffffff +#define SSIZE_T_ERROR (-1L) +#define _SIZE_T_ERROR 0xffffffffUL +#endif + + +// +// We make some assumptions about the sizes of various types. Let's be +// explicit about those assumptions and check them. +// +C_ASSERT(sizeof(USHORT) == 2); +C_ASSERT(sizeof(INT) == 4); +C_ASSERT(sizeof(UINT) == 4); +C_ASSERT(sizeof(LONG) == 4); +C_ASSERT(sizeof(ULONG) == 4); +C_ASSERT(sizeof(UINT_PTR) == sizeof(ULONG_PTR)); + + +//============================================================================= +// Conversion functions +// +// There are three reasons for having conversion functions: +// +// 1. We are converting from a signed type to an unsigned type of the same +// size, or vice-versa. +// +// Since we default to only having unsigned math functions, +// (see ENABLE_INTSAFE_SIGNED_FUNCTIONS below) we prefer people to convert +// to unsigned, do the math, and then convert back to signed. +// +// 2. We are converting to a smaller type, and we could therefore possibly +// overflow. +// +// 3. We are converting to a bigger type, and we are signed and the type we are +// converting to is unsigned. +// +//============================================================================= + + +// +// INT8 -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToUChar( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) UCHAR* pch) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pch = (UCHAR)i8Operand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToUInt8( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) UINT8* pu8Result) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pu8Result = (UINT8)i8Operand; + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> BYTE conversion +// +#define Int8ToByte Int8ToUInt8 + +// +// INT8 -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToUShort( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) USHORT* pusResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pusResult = (USHORT)i8Operand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> UINT16 conversion +// +#define Int8ToUInt16 Int8ToUShort + +// +// INT8 -> WORD conversion +// +#define Int8ToWord Int8ToUShort + +// +// INT8 -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToUInt( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) UINT* puResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *puResult = (UINT)i8Operand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> UINT32 conversion +// +#define Int8ToUInt32 Int8ToUInt + +// +// INT8 -> UINT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToUIntPtr( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) UINT_PTR* puResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *puResult = (UINT_PTR)i8Operand; + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToULong( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) ULONG* pulResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pulResult = (ULONG)i8Operand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> ULONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToULongPtr( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pulResult = (ULONG_PTR)i8Operand; + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> DWORD conversion +// +#define Int8ToDWord Int8ToULong + +// +// INT8 -> DWORD_PTR conversion +// +#define Int8ToDWordPtr Int8ToULongPtr + +// +// INT8 -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +Int8ToULongLong( + _In_ INT8 i8Operand, + _Out_ _Deref_out_range_(==, i8Operand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (i8Operand >= 0) + { + *pullResult = (ULONGLONG)i8Operand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT8 -> DWORDLONG conversion +// +#define Int8ToDWordLong Int8ToULongLong + +// +// INT8 -> ULONG64 conversion +// +#define Int8ToULong64 Int8ToULongLong + +// +// INT8 -> DWORD64 conversion +// +#define Int8ToDWord64 Int8ToULongLong + +// +// INT8 -> UINT64 conversion +// +#define Int8ToUInt64 Int8ToULongLong + +// +// INT8 -> size_t conversion +// +#define Int8ToSizeT Int8ToUIntPtr + +// +// INT8 -> SIZE_T conversion +// +#define Int8ToSIZET Int8ToULongPtr + +// +// UINT8 -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UInt8ToInt8( + _In_ UINT8 u8Operand, + _Out_ _Deref_out_range_(==, u8Operand) INT8* pi8Result) +{ + HRESULT hr; + + if (u8Operand <= INT8_MAX) + { + *pi8Result = (INT8)u8Operand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT8 -> CHAR conversion +// +__forceinline +HRESULT +UInt8ToChar( + _In_ UINT8 u8Operand, + _Out_ _Deref_out_range_(==, u8Operand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + *pch = (CHAR)u8Operand; + return S_OK; +#else + return UInt8ToInt8(u8Operand, (INT8*)pch); +#endif +} + +// +// BYTE -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ByteToInt8( + _In_ BYTE bOperand, + _Out_ _Deref_out_range_(==, bOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (bOperand <= INT8_MAX) + { + *pi8Result = (INT8)bOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// BYTE -> CHAR conversion +// +__forceinline +HRESULT +ByteToChar( + _In_ BYTE bOperand, + _Out_ _Deref_out_range_(==, bOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + *pch = (CHAR)bOperand; + return S_OK; +#else + return ByteToInt8(bOperand, (INT8*)pch); +#endif +} + +// +// SHORT -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToInt8( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((sOperand >= INT8_MIN) && (sOperand <= INT8_MAX)) + { + *pi8Result = (INT8)sOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToUChar( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((sOperand >= 0) && (sOperand <= 255)) + { + *pch = (UCHAR)sOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> CHAR conversion +// +__forceinline +HRESULT +ShortToChar( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return ShortToUChar(sOperand, (UCHAR*)pch); +#else + return ShortToInt8(sOperand, (INT8*)pch); +#endif // _CHAR_UNSIGNED +} + +// +// SHORT -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToUInt8( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if ((sOperand >= 0) && (sOperand <= UINT8_MAX)) + { + *pui8Result = (UINT8)sOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> BYTE conversion +// +#define ShortToByte ShortToUInt8 + +// +// SHORT -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToUShort( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *pusResult = (USHORT)sOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> UINT16 conversion +// +#define ShortToUInt16 ShortToUShort + +// +// SHORT -> WORD conversion +// +#define ShortToWord ShortToUShort + +// +// SHORT -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToUInt( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) UINT* puResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *puResult = (UINT)sOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> UINT32 conversion +// +#define ShortToUInt32 ShortToUInt + +// +// SHORT -> UINT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToUIntPtr( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) UINT_PTR* puResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *puResult = (UINT_PTR)sOperand; + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToULong( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *pulResult = (ULONG)sOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> ULONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToULongPtr( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *pulResult = (ULONG_PTR)sOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> DWORD conversion +// +#define ShortToDWord ShortToULong + +// +// SHORT -> DWORD_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToDWordPtr( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) DWORD_PTR* pdwResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *pdwResult = (DWORD_PTR)sOperand; + hr = S_OK; + } + else + { + *pdwResult = DWORD_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ShortToULongLong( + _In_ SHORT sOperand, + _Out_ _Deref_out_range_(==, sOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (sOperand >= 0) + { + *pullResult = (ULONGLONG)sOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SHORT -> DWORDLONG conversion +// +#define ShortToDWordLong ShortToULongLong + +// +// SHORT -> ULONG64 conversion +// +#define ShortToULong64 ShortToULongLong + +// +// SHORT -> DWORD64 conversion +// +#define ShortToDWord64 ShortToULongLong + +// +// SHORT -> UINT64 conversion +// +#define ShortToUInt64 ShortToULongLong + +// +// SHORT -> size_t conversion +// +#define ShortToSizeT ShortToUIntPtr + +// +// SHORT -> SIZE_T conversion +// +#define ShortToSIZET ShortToULongPtr + +// +// INT16 -> CHAR conversion +// +#define Int16ToChar ShortToChar + +// +// INT16 -> INT8 conversion +// +#define Int16ToInt8 ShortToInt8 + +// +// INT16 -> UCHAR conversion +// +#define Int16ToUChar ShortToUChar + +// +// INT16 -> UINT8 conversion +// +#define Int16ToUInt8 ShortToUInt8 + +// +// INT16 -> BYTE conversion +// +#define Int16ToByte ShortToUInt8 + +// +// INT16 -> USHORT conversion +// +#define Int16ToUShort ShortToUShort + +// +// INT16 -> UINT16 conversion +// +#define Int16ToUInt16 ShortToUShort + +// +// INT16 -> WORD conversion +// +#define Int16ToWord ShortToUShort + +// +// INT16 -> UINT conversion +// +#define Int16ToUInt ShortToUInt + +// +// INT16 -> UINT32 conversion +// +#define Int16ToUInt32 ShortToUInt + +// +// INT16 -> UINT_PTR conversion +// +#define Int16ToUIntPtr ShortToUIntPtr + +// +// INT16 -> ULONG conversion +// +#define Int16ToULong ShortToULong + +// +// INT16 -> ULONG_PTR conversion +// +#define Int16ToULongPtr ShortToULongPtr + +// +// INT16 -> DWORD conversion +// +#define Int16ToDWord ShortToULong + +// +// INT16 -> DWORD_PTR conversion +// +#define Int16ToDWordPtr ShortToULongPtr + +// +// INT16 -> ULONGLONG conversion +// +#define Int16ToULongLong ShortToULongLong + +// +// INT16 -> DWORDLONG conversion +// +#define Int16ToDWordLong ShortToULongLong + +// +// INT16 -> ULONG64 conversion +// +#define Int16ToULong64 ShortToULongLong + +// +// INT16 -> DWORD64 conversion +// +#define Int16ToDWord64 ShortToULongLong + +// +// INT16 -> UINT64 conversion +// +#define Int16ToUInt64 ShortToULongLong + +// +// INT16 -> size_t conversion +// +#define Int16ToSizeT ShortToUIntPtr + +// +// INT16 -> SIZE_T conversion +// +#define Int16ToSIZET ShortToULongPtr + +// +// USHORT -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UShortToInt8( + _In_ USHORT usOperand, + _Out_ _Deref_out_range_(==, usOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (usOperand <= INT8_MAX) + { + *pi8Result = (INT8)usOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +UShortToUChar( + _In_ USHORT usOperand, + _Out_ _Deref_out_range_(==, usOperand) UCHAR* pch) +{ + HRESULT hr; + + if (usOperand <= 255) + { + *pch = (UCHAR)usOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT -> CHAR conversion +// +__forceinline +HRESULT +UShortToChar( + _In_ USHORT usOperand, + _Out_ _Deref_out_range_(==, usOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return UShortToUChar(usOperand, (UCHAR*)pch); +#else + return UShortToInt8(usOperand, (INT8*)pch); +#endif // _CHAR_UNSIGNED +} + +// +// USHORT -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UShortToUInt8( + _In_ USHORT usOperand, + _Out_ _Deref_out_range_(==, usOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if (usOperand <= UINT8_MAX) + { + *pui8Result = (UINT8)usOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT -> BYTE conversion +// +#define UShortToByte UShortToUInt8 + +// +// USHORT -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UShortToShort( + _In_ USHORT usOperand, + _Out_ _Deref_out_range_(==, usOperand) SHORT* psResult) +{ + HRESULT hr; + + if (usOperand <= SHORT_MAX) + { + *psResult = (SHORT)usOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT -> INT16 conversion +// +#define UShortToInt16 UShortToShort + +// +// UINT16 -> CHAR conversion +// +#define UInt16ToChar UShortToChar + +// +// UINT16 -> INT8 conversion +// +#define UInt16ToInt8 UShortToInt8 + +// +// UINT16 -> UCHAR conversion +// +#define UInt16ToUChar UShortToUChar + +// +// UINT16 -> UINT8 conversion +// +#define UInt16ToUInt8 UShortToUInt8 + +// +// UINT16 -> BYTE conversion +// +#define UInt16ToByte UShortToUInt8 + +// +// UINT16 -> SHORT conversion +// +#define UInt16ToShort UShortToShort + +// +// UINT16 -> INT16 conversion +// +#define UInt16ToInt16 UShortToShort + +// +// WORD -> INT8 conversion +// +#define WordToInt8 UShortToInt8 + +// +// WORD -> CHAR conversion +// +#define WordToChar UShortToChar + +// +// WORD -> UCHAR conversion +// +#define WordToUChar UShortToUChar + +// +// WORD -> UINT8 conversion +// +#define WordToUInt8 UShortToUInt8 + +// +// WORD -> BYTE conversion +// +#define WordToByte UShortToUInt8 + +// +// WORD -> SHORT conversion +// +#define WordToShort UShortToShort + +// +// WORD -> INT16 conversion +// +#define WordToInt16 UShortToShort + +// +// INT -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToInt8( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((iOperand >= INT8_MIN) && (iOperand <= INT8_MAX)) + { + *pi8Result = (INT8)iOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToUChar( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= 255)) + { + *pch = (UCHAR)iOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> CHAR conversion +// +__forceinline +HRESULT +IntToChar( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return IntToUChar(iOperand, (UCHAR*)pch); +#else + return IntToInt8(iOperand, (INT8*)pch); +#endif // _CHAR_UNSIGNED +} + +// +// INT -> BYTE conversion +// +#define IntToByte IntToUInt8 + +// +// INT -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToUInt8( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= UINT8_MAX)) + { + *pui8Result = (UINT8)iOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToShort( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) SHORT* psResult) +{ + HRESULT hr; + + if ((iOperand >= SHORT_MIN) && (iOperand <= SHORT_MAX)) + { + *psResult = (SHORT)iOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> INT16 conversion +// +#define IntToInt16 IntToShort + +// +// INT -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToUShort( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) USHORT* pusResult) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= USHORT_MAX)) + { + *pusResult = (USHORT)iOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> UINT16 conversion +// +#define IntToUInt16 IntToUShort + +// +// INT -> WORD conversion +// +#define IntToWord IntToUShort + +// +// INT -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToUInt( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) UINT* puResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *puResult = (UINT)iOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> UINT_PTR conversion +// +#ifdef _WIN64 +#define IntToUIntPtr IntToULongLong +#else +#define IntToUIntPtr IntToUInt +#endif + +// +// INT -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToULong( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *pulResult = (ULONG)iOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> ULONG_PTR conversion +// +#ifdef _WIN64 +#define IntToULongPtr IntToULongLong +#else +#define IntToULongPtr IntToULong +#endif + +// +// INT -> DWORD conversion +// +#define IntToDWord IntToULong + +// +// INT -> DWORD_PTR conversion +// +#define IntToDWordPtr IntToULongPtr + +// +// INT -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntToULongLong( + _In_ INT iOperand, + _Out_ _Deref_out_range_(==, iOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *pullResult = (ULONGLONG)iOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT -> DWORDLONG conversion +// +#define IntToDWordLong IntToULongLong + +// +// INT -> ULONG64 conversion +// +#define IntToULong64 IntToULongLong + +// +// INT -> DWORD64 conversion +// +#define IntToDWord64 IntToULongLong + +// +// INT -> UINT64 conversion +// +#define IntToUInt64 IntToULongLong + +// +// INT -> size_t conversion +// +#define IntToSizeT IntToUIntPtr + +// +// INT -> SIZE_T conversion +// +#define IntToSIZET IntToULongPtr + +// +// INT32 -> CHAR conversion +// +#define Int32ToChar IntToChar + +// +// INT32 -> INT328 conversion +// +#define Int32ToInt8 IntToInt8 + +// +// INT32 -> UCHAR conversion +// +#define Int32ToUChar IntToUChar + +// +// INT32 -> BYTE conversion +// +#define Int32ToByte IntToUInt8 + +// +// INT32 -> UINT8 conversion +// +#define Int32ToUInt8 IntToUInt8 + +// +// INT32 -> SHORT conversion +// +#define Int32ToShort IntToShort + +// +// INT32 -> INT16 conversion +// +#define Int32ToInt16 IntToShort + +// +// INT32 -> USHORT conversion +// +#define Int32ToUShort IntToUShort + +// +// INT32 -> UINT16 conversion +// +#define Int32ToUInt16 IntToUShort + +// +// INT32 -> WORD conversion +// +#define Int32ToWord IntToUShort + +// +// INT32 -> UINT conversion +// +#define Int32ToUInt IntToUInt + +// +// INT32 -> UINT32 conversion +// +#define Int32ToUInt32 IntToUInt + +// +// INT32 -> UINT_PTR conversion +// +#define Int32ToUIntPtr IntToUIntPtr + +// +// INT32 -> ULONG conversion +// +#define Int32ToULong IntToULong + +// +// INT32 -> ULONG_PTR conversion +// +#define Int32ToULongPtr IntToULongPtr + +// +// INT32 -> DWORD conversion +// +#define Int32ToDWord IntToULong + +// +// INT32 -> DWORD_PTR conversion +// +#define Int32ToDWordPtr IntToULongPtr + +// +// INT32 -> ULONGLONG conversion +// +#define Int32ToULongLong IntToULongLong + +// +// INT32 -> DWORDLONG conversion +// +#define Int32ToDWordLong IntToULongLong + +// +// INT32 -> ULONG64 conversion +// +#define Int32ToULong64 IntToULongLong + +// +// INT32 -> DWORD64 conversion +// +#define Int32ToDWord64 IntToULongLong + +// +// INT32 -> UINT64 conversion +// +#define Int32ToUInt64 IntToULongLong + +// +// INT32 -> size_t conversion +// +#define Int32ToSizeT IntToUIntPtr + +// +// INT32 -> SIZE_T conversion +// +#define Int32ToSIZET IntToULongPtr + +// +// INT_PTR -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToInt8( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((iOperand >= INT8_MIN) && (iOperand <= INT8_MAX)) + { + *pi8Result = (INT8)iOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT_PTR -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToUChar( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= 255)) + { + *pch = (UCHAR)iOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT_PTR -> CHAR conversion +// +__forceinline +HRESULT +IntPtrToChar( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return IntPtrToUChar(iOperand, (UCHAR*)pch); +#else + return IntPtrToInt8(iOperand, (INT8*)pch); +#endif // _CHAR_UNSIGNED +} + +// +// INT_PTR -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToUInt8( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= UINT8_MAX)) + { + *pui8Result = (UINT8)iOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT_PTR -> BYTE conversion +// +#define IntPtrToByte IntPtrToUInt8 + +// +// INT_PTR -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToShort( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) SHORT* psResult) +{ + HRESULT hr; + + if ((iOperand >= SHORT_MIN) && (iOperand <= SHORT_MAX)) + { + *psResult = (SHORT)iOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT_PTR -> INT16 conversion +// +#define IntPtrToInt16 IntPtrToShort + +// +// INT_PTR -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToUShort( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) USHORT* pusResult) +{ + HRESULT hr; + + if ((iOperand >= 0) && (iOperand <= USHORT_MAX)) + { + *pusResult = (USHORT)iOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// INT_PTR -> UINT16 conversion +// +#define IntPtrToUInt16 IntPtrToUShort + +// +// INT_PTR -> WORD conversion +// +#define IntPtrToWord IntPtrToUShort + +// +// INT_PTR -> INT conversion +// +#ifdef _WIN64 +#define IntPtrToInt LongLongToInt +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToInt( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) INT* piResult) +{ + *piResult = (INT)iOperand; + return S_OK; +} +#endif + +// +// INT_PTR -> INT32 conversion +// +#define IntPtrToInt32 IntPtrToInt + +// +// INT_PTR -> UINT conversion +// +#ifdef _WIN64 +#define IntPtrToUInt LongLongToUInt +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToUInt( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) UINT* puResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *puResult = (UINT)iOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// INT_PTR -> UINT32 conversion +// +#define IntPtrToUInt32 IntPtrToUInt + +// +// INT_PTR -> UINT_PTR conversion +// +#ifdef _WIN64 +#define IntPtrToUIntPtr LongLongToULongLong +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToUIntPtr( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) UINT_PTR* puResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *puResult = (UINT_PTR)iOperand; + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// INT_PTR -> LONG conversion +// +#ifdef _WIN64 +#define IntPtrToLong LongLongToLong +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToLong( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) LONG* plResult) +{ + *plResult = (LONG)iOperand; + return S_OK; +} +#endif + +// +// INT_PTR -> LONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +IntPtrToLongPtr( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) LONG_PTR* plResult) +{ + *plResult = (LONG_PTR)iOperand; + return S_OK; +} + +// +// INT_PTR -> ULONG conversion +// +#ifdef _WIN64 +#define IntPtrToULong LongLongToULong +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToULong( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *pulResult = (ULONG)iOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// INT_PTR -> ULONG_PTR conversion +// +#ifdef _WIN64 +#define IntPtrToULongPtr LongLongToULongLong +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToULongPtr( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *pulResult = (ULONG_PTR)iOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// INT_PTR -> DWORD conversion +// +#define IntPtrToDWord IntPtrToULong + +// +// INT_PTR -> DWORD_PTR conversion +// +#define IntPtrToDWordPtr IntPtrToULongPtr + +// +// INT_PTR -> ULONGLONG conversion +// +#ifdef _WIN64 +#define IntPtrToULongLong LongLongToULongLong +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrToULongLong( + _In_ INT_PTR iOperand, + _Out_ _Deref_out_range_(==, iOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (iOperand >= 0) + { + *pullResult = (ULONGLONG)iOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// INT_PTR -> DWORDLONG conversion +// +#define IntPtrToDWordLong IntPtrToULongLong + +// +// INT_PTR -> ULONG64 conversion +// +#define IntPtrToULong64 IntPtrToULongLong + +// +// INT_PTR -> DWORD64 conversion +// +#define IntPtrToDWord64 IntPtrToULongLong + +// +// INT_PTR -> UINT64 conversion +// +#define IntPtrToUInt64 IntPtrToULongLong + +// +// INT_PTR -> size_t conversion +// +#define IntPtrToSizeT IntPtrToUIntPtr + +// +// INT_PTR -> SIZE_T conversion +// +#define IntPtrToSIZET IntPtrToULongPtr + +// +// UINT -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToInt8( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (uOperand <= INT8_MAX) + { + *pi8Result = (INT8)uOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToUChar( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) UCHAR* pch) +{ + HRESULT hr; + + if (uOperand <= 255) + { + *pch = (UCHAR)uOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> CHAR conversion +// +__forceinline +HRESULT +UIntToChar( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return UIntToUChar(uOperand, (UCHAR*)pch); +#else + return UIntToInt8(uOperand, (INT8*)pch); +#endif +} + +// +// UINT -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToUInt8( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if (uOperand <= UINT8_MAX) + { + *pui8Result = (UINT8)uOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> BYTE conversion +// +#define UIntToByte UIntToUInt8 + +// +// UINT -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToShort( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) SHORT* psResult) +{ + HRESULT hr; + + if (uOperand <= SHORT_MAX) + { + *psResult = (SHORT)uOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> INT16 conversion +// +#define UIntToInt16 UIntToShort + +// +// UINT -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToUShort( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (uOperand <= USHORT_MAX) + { + *pusResult = (USHORT)uOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> UINT16 conversion +// +#define UIntToUInt16 UIntToUShort + +// +// UINT -> WORD conversion +// +#define UIntToWord UIntToUShort + +// +// UINT -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToInt( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT* piResult) +{ + HRESULT hr; + + if (uOperand <= INT_MAX) + { + *piResult = (INT)uOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> INT32 conversion +// +#define UIntToInt32 UIntToInt + +// +// UINT -> INT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +UIntToIntPtr( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT_PTR* piResult) +{ + *piResult = uOperand; + return S_OK; +} +#else +#define UIntToIntPtr UIntToInt +#endif + +// +// UINT -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntToLong( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) LONG* plResult) +{ + HRESULT hr; + + if (uOperand <= LONG_MAX) + { + *plResult = (LONG)uOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT -> LONG_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +UIntToLongPtr( + _In_ UINT uOperand, + _Out_ _Deref_out_range_(==, uOperand) LONG_PTR* plResult) +{ + *plResult = uOperand; + return S_OK; +} +#else +#define UIntToLongPtr UIntToLong +#endif + +// +// UINT -> ptrdiff_t conversion +// +#define UIntToPtrdiffT UIntToIntPtr + +// +// UINT -> SSIZE_T conversion +// +#define UIntToSSIZET UIntToLongPtr + +// +// UINT32 -> CHAR conversion +// +#define UInt32ToChar UIntToChar + +// +// UINT32 -> INT8 conversion +// +#define UInt32ToInt8 UIntToInt8 + +// +// UINT32 -> UCHAR conversion +// +#define UInt32ToUChar UIntToUChar + +// +// UINT32 -> UINT8 conversion +// +#define UInt32ToUInt8 UIntToUInt8 + +// +// UINT32 -> BYTE conversion +// +#define UInt32ToByte UInt32ToUInt8 + +// +// UINT32 -> SHORT conversion +// +#define UInt32ToShort UIntToShort + +// +// UINT32 -> INT16 conversion +// +#define UInt32ToInt16 UIntToShort + +// +// UINT32 -> USHORT conversion +// +#define UInt32ToUShort UIntToUShort + +// +// UINT32 -> UINT16 conversion +// +#define UInt32ToUInt16 UIntToUShort + +// +// UINT32 -> WORD conversion +// +#define UInt32ToWord UIntToUShort + +// +// UINT32 -> INT conversion +// +#define UInt32ToInt UIntToInt + +// +// UINT32 -> INT_PTR conversion +// +#define UInt32ToIntPtr UIntToIntPtr + +// +// UINT32 -> INT32 conversion +// +#define UInt32ToInt32 UIntToInt + +// +// UINT32 -> LONG conversion +// +#define UInt32ToLong UIntToLong + +// +// UINT32 -> LONG_PTR conversion +// +#define UInt32ToLongPtr UIntToLongPtr + +// +// UINT32 -> ptrdiff_t conversion +// +#define UInt32ToPtrdiffT UIntToPtrdiffT + +// +// UINT32 -> SSIZE_T conversion +// +#define UInt32ToSSIZET UIntToSSIZET + +// +// UINT_PTR -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToInt8( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (uOperand <= INT8_MAX) + { + *pi8Result = (INT8)uOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToUChar( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) UCHAR* pch) +{ + HRESULT hr; + + if (uOperand <= 255) + { + *pch = (UCHAR)uOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> CHAR conversion +// +__forceinline +HRESULT +UIntPtrToChar( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return UIntPtrToUChar(uOperand, (UCHAR*)pch); +#else + return UIntPtrToInt8(uOperand, (INT8*)pch); +#endif +} + +// +// UINT_PTR -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToUInt8( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==,uOperand) UINT8* pu8Result) +{ + HRESULT hr; + + if (uOperand <= UINT8_MAX) + { + *pu8Result = (UINT8)uOperand; + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> BYTE conversion +// +#define UIntPtrToByte UIntPtrToUInt8 + +// +// UINT_PTR -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToShort( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) SHORT* psResult) +{ + HRESULT hr; + + if (uOperand <= SHORT_MAX) + { + *psResult = (SHORT)uOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> INT16 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToInt16( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT16* pi16Result) +{ + HRESULT hr; + + if (uOperand <= INT16_MAX) + { + *pi16Result = (INT16)uOperand; + hr = S_OK; + } + else + { + *pi16Result = INT16_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToUShort( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (uOperand <= USHORT_MAX) + { + *pusResult = (USHORT)uOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> UINT16 conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToUInt16( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) UINT16* pu16Result) +{ + HRESULT hr; + + if (uOperand <= UINT16_MAX) + { + *pu16Result = (UINT16)uOperand; + hr = S_OK; + } + else + { + *pu16Result = UINT16_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> WORD conversion +// +#define UIntPtrToWord UIntPtrToUShort + +// +// UINT_PTR -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToInt( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT* piResult) +{ + HRESULT hr; + + if (uOperand <= INT_MAX) + { + *piResult = (INT)uOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> INT32 conversion +// +#define UIntPtrToInt32 UIntPtrToInt + +// +// UINT_PTR -> INT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToIntPtr( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) INT_PTR* piResult) +{ + HRESULT hr; + + if (uOperand <= INT_PTR_MAX) + { + *piResult = (INT_PTR)uOperand; + hr = S_OK; + } + else + { + *piResult = INT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> UINT conversion +// +#ifdef _WIN64 +#define UIntPtrToUInt ULongLongToUInt +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToUInt( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) UINT* puResult) +{ + *puResult = (UINT)uOperand; + return S_OK; +} +#endif + +// +// UINT_PTR -> UINT32 conversion +// +#define UIntPtrToUInt32 UIntPtrToUInt + +// +// UINT_PTR -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToLong( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) LONG* plResult) +{ + HRESULT hr; + + if (uOperand <= LONG_MAX) + { + *plResult = (LONG)uOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> LONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToLongPtr( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) LONG_PTR* plResult) +{ + HRESULT hr; + + if (uOperand <= LONG_PTR_MAX) + { + *plResult = (LONG_PTR)uOperand; + hr = S_OK; + } + else + { + *plResult = LONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT_PTR -> ULONG conversion +// +#ifdef _WIN64 +#define UIntPtrToULong ULongLongToULong +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToULong( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) ULONG* pulResult) +{ + *pulResult = (ULONG)uOperand; + return S_OK; +} +#endif + +// +// UINT_PTR -> DWORD conversion +// +#define UIntPtrToDWord UIntPtrToULong + +// +// UINT_PTR -> LONGLONG conversion +// +#ifdef _WIN64 +#define UIntPtrToLongLong ULongLongToLongLong +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrToLongLong( + _In_ UINT_PTR uOperand, + _Out_ _Deref_out_range_(==, uOperand) LONGLONG* pllResult) +{ + *pllResult = (LONGLONG)uOperand; + return S_OK; +} +#endif + +// +// UINT_PTR -> LONG64 conversion +// +#define UIntPtrToLong64 UIntPtrToLongLong + +// +// UINT_PTR -> INT64 conversion +// +#define UIntPtrToInt64 UIntPtrToLongLong + +// +// UINT_PTR -> ptrdiff_t conversion +// +#define UIntPtrToPtrdiffT UIntPtrToIntPtr + +// +// UINT_PTR -> SSIZE_T conversion +// +#define UIntPtrToSSIZET UIntPtrToLongPtr + +// +// LONG -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToInt8( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((lOperand >= INT8_MIN) && (lOperand <= INT8_MAX)) + { + *pi8Result = (INT8)lOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToUChar( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= 255)) + { + *pch = (UCHAR)lOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> CHAR conversion +// +__forceinline +HRESULT +LongToChar( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return LongToUChar(lOperand, (UCHAR*)pch); +#else + return LongToInt8(lOperand, (INT8*)pch); +#endif +} + +// +// LONG -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToUInt8( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= UINT8_MAX)) + { + *pui8Result = (UINT8)lOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> BYTE conversion +// +#define LongToByte LongToUInt8 + +// +// LONG -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToShort( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) SHORT* psResult) +{ + HRESULT hr; + + if ((lOperand >= SHORT_MIN) && (lOperand <= SHORT_MAX)) + { + *psResult = (SHORT)lOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> INT16 conversion +// +#define LongToInt16 LongToShort + +// +// LONG -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToUShort( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) USHORT* pusResult) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= USHORT_MAX)) + { + *pusResult = (USHORT)lOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> UINT16 conversion +// +#define LongToUInt16 LongToUShort + +// +// LONG -> WORD conversion +// +#define LongToWord LongToUShort + +// +// LONG -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToInt( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT* piResult) +{ + C_ASSERT(sizeof(INT) == sizeof(LONG)); + *piResult = (INT)lOperand; + return S_OK; +} + +// +// LONG -> INT32 conversion +// +#define LongToInt32 LongToInt + +// +// LONG -> INT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +LongToIntPtr( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT_PTR* piResult) +{ + *piResult = lOperand; + return S_OK; +} +#else +#define LongToIntPtr LongToInt +#endif + +// +// LONG -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToUInt( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT* puResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *puResult = (UINT)lOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> UINT32 conversion +// +#define LongToUInt32 LongToUInt + +// +// LONG -> UINT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +LongToUIntPtr( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT_PTR* puResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *puResult = (UINT_PTR)lOperand; + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#else +#define LongToUIntPtr LongToUInt +#endif + +// +// LONG -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToULong( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pulResult = (ULONG)lOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> ULONG_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +LongToULongPtr( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pulResult = (ULONG_PTR)lOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#else +#define LongToULongPtr LongToULong +#endif + +// +// LONG -> DWORD conversion +// +#define LongToDWord LongToULong + +// +// LONG -> DWORD_PTR conversion +// +#define LongToDWordPtr LongToULongPtr + +// +// LONG -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongToULongLong( + _In_ LONG lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pullResult = (ULONGLONG)lOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG -> DWORDLONG conversion +// +#define LongToDWordLong LongToULongLong + +// +// LONG -> ULONG64 conversion +// +#define LongToULong64 LongToULongLong + +// +// LONG -> DWORD64 conversion +// +#define LongToDWord64 LongToULongLong + +// +// LONG -> UINT64 conversion +// +#define LongToUInt64 LongToULongLong + +// +// LONG -> ptrdiff_t conversion +// +#define LongToPtrdiffT LongToIntPtr + +// +// LONG -> size_t conversion +// +#define LongToSizeT LongToUIntPtr + +// +// LONG -> SIZE_T conversion +// +#define LongToSIZET LongToULongPtr + +// +// LONG_PTR -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToInt8( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((lOperand >= INT8_MIN) && (lOperand <= INT8_MAX)) + { + *pi8Result = (INT8)lOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToUChar( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= 255)) + { + *pch = (UCHAR)lOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> CHAR conversion +// +__forceinline +HRESULT +LongPtrToChar( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return LongPtrToUChar(lOperand, (UCHAR*)pch); +#else + return LongPtrToInt8(lOperand, (INT8*)pch); +#endif +} + +// +// LONG_PTR -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToUInt8( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= UINT8_MAX)) + { + *pui8Result = (UINT8)lOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> BYTE conversion +// +#define LongPtrToByte LongPtrToUInt8 + +// +// LONG_PTR -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToShort( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) SHORT* psResult) +{ + HRESULT hr; + + if ((lOperand >= SHORT_MIN) && (lOperand <= SHORT_MAX)) + { + *psResult = (SHORT)lOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> INT16 conversion +// +#define LongPtrToInt16 LongPtrToShort + +// +// LONG_PTR -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToUShort( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) USHORT* pusResult) +{ + HRESULT hr; + + if ((lOperand >= 0) && (lOperand <= USHORT_MAX)) + { + *pusResult = (USHORT)lOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> UINT16 conversion +// +#define LongPtrToUInt16 LongPtrToUShort + +// +// LONG_PTR -> WORD conversion +// +#define LongPtrToWord LongPtrToUShort + +// +// LONG_PTR -> INT conversion +// +#ifdef _WIN64 +#define LongPtrToInt LongLongToInt +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrToInt( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT* piResult) +{ + C_ASSERT(sizeof(INT) == sizeof(LONG_PTR)); + *piResult = (INT)lOperand; + return S_OK; +} +#endif + +// +// LONG_PTR -> INT32 conversion +// +#define LongPtrToInt32 LongPtrToInt + +// +// LONG_PTR -> INT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToIntPtr( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) INT_PTR* piResult) +{ + C_ASSERT(sizeof(LONG_PTR) == sizeof(INT_PTR)); + *piResult = (INT_PTR)lOperand; + return S_OK; +} + +// +// LONG_PTR -> UINT conversion +// +#ifdef _WIN64 +#define LongPtrToUInt LongLongToUInt +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrToUInt( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT* puResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *puResult = (UINT)lOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// LONG_PTR -> UINT32 conversion +// +#define LongPtrToUInt32 LongPtrToUInt + +// +// LONG_PTR -> UINT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToUIntPtr( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) UINT_PTR* puResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *puResult = (UINT_PTR)lOperand; + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> LONG conversion +// +#ifdef _WIN64 +#define LongPtrToLong LongLongToLong +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrToLong( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) LONG* plResult) +{ + *plResult = (LONG)lOperand; + return S_OK; +} +#endif + +// +// LONG_PTR -> ULONG conversion +// +#ifdef _WIN64 +#define LongPtrToULong LongLongToULong +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrToULong( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pulResult = (ULONG)lOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif + +// +// LONG_PTR -> ULONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToULongPtr( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pulResult = (ULONG_PTR)lOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> DWORD conversion +// +#define LongPtrToDWord LongPtrToULong + +// +// LONG_PTR -> DWORD_PTR conversion +// +#define LongPtrToDWordPtr LongPtrToULongPtr + +// +// LONG_PTR -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongPtrToULongLong( + _In_ LONG_PTR lOperand, + _Out_ _Deref_out_range_(==, lOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (lOperand >= 0) + { + *pullResult = (ULONGLONG)lOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONG_PTR -> DWORDLONG conversion +// +#define LongPtrToDWordLong LongPtrToULongLong + +// +// LONG_PTR -> ULONG64 conversion +// +#define LongPtrToULong64 LongPtrToULongLong + +// +// LONG_PTR -> DWORD64 conversion +// +#define LongPtrToDWord64 LongPtrToULongLong + +// +// LONG_PTR -> UINT64 conversion +// +#define LongPtrToUInt64 LongPtrToULongLong + +// +// LONG_PTR -> size_t conversion +// +#define LongPtrToSizeT LongPtrToUIntPtr + +// +// LONG_PTR -> SIZE_T conversion +// +#define LongPtrToSIZET LongPtrToULongPtr + +// +// ULONG -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToInt8( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (ulOperand <= INT8_MAX) + { + *pi8Result = (INT8)ulOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToUChar( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UCHAR* pch) +{ + HRESULT hr; + + if (ulOperand <= 255) + { + *pch = (UCHAR)ulOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> CHAR conversion +// +__forceinline +HRESULT +ULongToChar( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return ULongToUChar(ulOperand, (UCHAR*)pch); +#else + return ULongToInt8(ulOperand, (INT8*)pch); +#endif +} + +// +// ULONG -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToUInt8( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if (ulOperand <= UINT8_MAX) + { + *pui8Result = (UINT8)ulOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> BYTE conversion +// +#define ULongToByte ULongToUInt8 + +// +// ULONG -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToShort( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) SHORT* psResult) +{ + HRESULT hr; + + if (ulOperand <= SHORT_MAX) + { + *psResult = (SHORT)ulOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> INT16 conversion +// +#define ULongToInt16 ULongToShort + +// +// ULONG -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToUShort( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (ulOperand <= USHORT_MAX) + { + *pusResult = (USHORT)ulOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> UINT16 conversion +// +#define ULongToUInt16 ULongToUShort + +// +// ULONG -> WORD conversion +// +#define ULongToWord ULongToUShort + +// +// ULONG -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToInt( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT* piResult) +{ + HRESULT hr; + + if (ulOperand <= INT_MAX) + { + *piResult = (INT)ulOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> INT32 conversion +// +#define ULongToInt32 ULongToInt + +// +// ULONG -> INT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +ULongToIntPtr( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT_PTR* piResult) +{ + *piResult = (INT_PTR)ulOperand; + return S_OK; +} +#else +#define ULongToIntPtr ULongToInt +#endif + +// +// ULONG -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToUInt( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT* puResult) +{ + C_ASSERT(sizeof(ULONG) == sizeof(UINT)); + *puResult = (UINT)ulOperand; + return S_OK; +} + +// +// ULONG -> UINT32 conversion +// +#define ULongToUInt32 ULongToUInt + +// +// ULONG -> UINT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +ULongToUIntPtr( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT_PTR* puiResult) +{ + C_ASSERT(sizeof(UINT_PTR) > sizeof(ULONG)); + *puiResult = (UINT_PTR)ulOperand; + return S_OK; +} +#else +#define ULongToUIntPtr ULongToUInt +#endif + +// +// ULONG -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongToLong( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) LONG* plResult) +{ + HRESULT hr; + + if (ulOperand <= LONG_MAX) + { + *plResult = (LONG)ulOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG -> LONG_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +ULongToLongPtr( + _In_ ULONG ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) LONG_PTR* plResult) +{ + C_ASSERT(sizeof(LONG_PTR) > sizeof(ULONG)); + *plResult = (LONG_PTR)ulOperand; + return S_OK; +} +#else +#define ULongToLongPtr ULongToLong +#endif + +// +// ULONG -> ptrdiff_t conversion +// +#define ULongToPtrdiffT ULongToIntPtr + +// +// ULONG -> SSIZE_T conversion +// +#define ULongToSSIZET ULongToLongPtr + +// +// ULONG_PTR -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToInt8( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (ulOperand <= INT8_MAX) + { + *pi8Result = (INT8)ulOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToUChar( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UCHAR* pch) +{ + HRESULT hr; + + if (ulOperand <= 255) + { + *pch = (UCHAR)ulOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> CHAR conversion +// +__forceinline +HRESULT +ULongPtrToChar( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return ULongPtrToUChar(ulOperand, (UCHAR*)pch); +#else + return ULongPtrToInt8(ulOperand, (INT8*)pch); +#endif +} + +// +// ULONG_PTR -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToUInt8( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT8* pui8Result) +{ + HRESULT hr; + + if (ulOperand <= UINT8_MAX) + { + *pui8Result = (UINT8)ulOperand; + hr = S_OK; + } + else + { + *pui8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> BYTE conversion +// +#define ULongPtrToByte ULongPtrToUInt8 + +// +// ULONG_PTR -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToShort( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) SHORT* psResult) +{ + HRESULT hr; + + if (ulOperand <= SHORT_MAX) + { + *psResult = (SHORT)ulOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> INT16 conversion +// +#define ULongPtrToInt16 ULongPtrToShort + +// +// ULONG_PTR -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToUShort( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (ulOperand <= USHORT_MAX) + { + *pusResult = (USHORT)ulOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> UINT16 conversion +// +#define ULongPtrToUInt16 ULongPtrToUShort + +// +// ULONG_PTR -> WORD conversion +// +#define ULongPtrToWord ULongPtrToUShort + +// +// ULONG_PTR -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToInt( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT* piResult) +{ + HRESULT hr; + + if (ulOperand <= INT_MAX) + { + *piResult = (INT)ulOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> INT32 conversion +// +#define ULongPtrToInt32 ULongPtrToInt + +// +// ULONG_PTR -> INT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToIntPtr( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) INT_PTR* piResult) +{ + HRESULT hr; + + if (ulOperand <= INT_PTR_MAX) + { + *piResult = (INT_PTR)ulOperand; + hr = S_OK; + } + else + { + *piResult = INT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> UINT conversion +// +#ifdef _WIN64 +#define ULongPtrToUInt ULongLongToUInt +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToUInt( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT* puResult) +{ + C_ASSERT(sizeof(ULONG_PTR) == sizeof(UINT)); + *puResult = (UINT)ulOperand; + return S_OK; +} +#endif + +// +// ULONG_PTR -> UINT32 conversion +// +#define ULongPtrToUInt32 ULongPtrToUInt + +// +// ULONG_PTR -> UINT_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToUIntPtr( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) UINT_PTR* puResult) +{ + *puResult = (UINT_PTR)ulOperand; + return S_OK; +} + +// +// ULONG_PTR -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToLong( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) LONG* plResult) +{ + HRESULT hr; + + if (ulOperand <= LONG_MAX) + { + *plResult = (LONG)ulOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> LONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToLongPtr( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) LONG_PTR* plResult) +{ + HRESULT hr; + + if (ulOperand <= LONG_PTR_MAX) + { + *plResult = (LONG_PTR)ulOperand; + hr = S_OK; + } + else + { + *plResult = LONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR -> ULONG conversion +// +#ifdef _WIN64 +#define ULongPtrToULong ULongLongToULong +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToULong( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) ULONG* pulResult) +{ + *pulResult = (ULONG)ulOperand; + return S_OK; +} +#endif + +// +// ULONG_PTR -> DWORD conversion +// +#define ULongPtrToDWord ULongPtrToULong + +// +// ULONG_PTR -> LONGLONG conversion +// +#ifdef _WIN64 +#define ULongPtrToLongLong ULongLongToLongLong +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrToLongLong( + _In_ ULONG_PTR ulOperand, + _Out_ _Deref_out_range_(==, ulOperand) LONGLONG* pllResult) +{ + *pllResult = (LONGLONG)ulOperand; + return S_OK; +} +#endif + +// +// ULONG_PTR -> LONG64 conversion +// +#define ULongPtrToLong64 ULongPtrToLongLong + +// +// ULONG_PTR -> INT64 +// +#define ULongPtrToInt64 ULongPtrToLongLong + +// +// ULONG_PTR -> ptrdiff_t conversion +// +#define ULongPtrToPtrdiffT ULongPtrToIntPtr + +// +// ULONG_PTR -> SSIZE_T conversion +// +#define ULongPtrToSSIZET ULongPtrToLongPtr + +// +// DWORD -> INT8 conversion +// +#define DWordToInt8 ULongToInt8 + +// +// DWORD -> CHAR conversion +// +#define DWordToChar ULongToChar + +// +// DWORD -> UCHAR conversion +// +#define DWordToUChar ULongToUChar + +// +// DWORD -> UINT8 conversion +// +#define DWordToUInt8 ULongToUInt8 + +// +// DWORD -> BYTE conversion +// +#define DWordToByte ULongToUInt8 + +// +// DWORD -> SHORT conversion +// +#define DWordToShort ULongToShort + +// +// DWORD -> INT16 conversion +// +#define DWordToInt16 ULongToShort + +// +// DWORD -> USHORT conversion +// +#define DWordToUShort ULongToUShort + +// +// DWORD -> UINT16 conversion +// +#define DWordToUInt16 ULongToUShort + +// +// DWORD -> WORD conversion +// +#define DWordToWord ULongToUShort + +// +// DWORD -> INT conversion +// +#define DWordToInt ULongToInt + +// +// DWORD -> INT32 conversion +// +#define DWordToInt32 ULongToInt + +// +// DWORD -> INT_PTR conversion +// +#define DWordToIntPtr ULongToIntPtr + +// +// DWORD -> UINT conversion +// +#define DWordToUInt ULongToUInt + +// +// DWORD -> UINT32 conversion +// +#define DWordToUInt32 ULongToUInt + +// +// DWORD -> UINT_PTR conversion +// +#define DWordToUIntPtr ULongToUIntPtr + +// +// DWORD -> LONG conversion +// +#define DWordToLong ULongToLong + +// +// DWORD -> LONG_PTR conversion +// +#define DWordToLongPtr ULongToLongPtr + +// +// DWORD -> ptrdiff_t conversion +// +#define DWordToPtrdiffT ULongToIntPtr + +// +// DWORD -> SSIZE_T conversion +// +#define DWordToSSIZET ULongToLongPtr + +// +// DWORD_PTR -> INT8 conversion +// +#define DWordPtrToInt8 ULongPtrToInt8 + +// +// DWORD_PTR -> UCHAR conversion +// +#define DWordPtrToUChar ULongPtrToUChar + +// +// DWORD_PTR -> CHAR conversion +// +#define DWordPtrToChar ULongPtrToChar + +// +// DWORD_PTR -> UINT8 conversion +// +#define DWordPtrToUInt8 ULongPtrToUInt8 + +// +// DWORD_PTR -> BYTE conversion +// +#define DWordPtrToByte ULongPtrToUInt8 + +// +// DWORD_PTR -> SHORT conversion +// +#define DWordPtrToShort ULongPtrToShort + +// +// DWORD_PTR -> INT16 conversion +// +#define DWordPtrToInt16 ULongPtrToShort + +// +// DWORD_PTR -> USHORT conversion +// +#define DWordPtrToUShort ULongPtrToUShort + +// +// DWORD_PTR -> UINT16 conversion +// +#define DWordPtrToUInt16 ULongPtrToUShort + +// +// DWORD_PTR -> WORD conversion +// +#define DWordPtrToWord ULongPtrToUShort + +// +// DWORD_PTR -> INT conversion +// +#define DWordPtrToInt ULongPtrToInt + +// +// DWORD_PTR -> INT32 conversion +// +#define DWordPtrToInt32 ULongPtrToInt + +// +// DWORD_PTR -> INT_PTR conversion +// +#define DWordPtrToIntPtr ULongPtrToIntPtr + +// +// DWORD_PTR -> UINT conversion +// +#define DWordPtrToUInt ULongPtrToUInt + +// +// DWORD_PTR -> UINT32 conversion +// +#define DWordPtrToUInt32 ULongPtrToUInt + +// +// DWODR_PTR -> UINT_PTR conversion +// +#define DWordPtrToUIntPtr ULongPtrToUIntPtr + +// +// DWORD_PTR -> LONG conversion +// +#define DWordPtrToLong ULongPtrToLong + +// +// DWORD_PTR -> LONG_PTR conversion +// +#define DWordPtrToLongPtr ULongPtrToLongPtr + +// +// DWORD_PTR -> ULONG conversion +// +#define DWordPtrToULong ULongPtrToULong + +// +// DWORD_PTR -> DWORD conversion +// +#define DWordPtrToDWord ULongPtrToULong + +// +// DWORD_PTR -> LONGLONG conversion +// +#define DWordPtrToLongLong ULongPtrToLongLong + +// +// DWORD_PTR -> LONG64 conversion +// +#define DWordPtrToLong64 ULongPtrToLongLong + +// +// DWORD_PTR -> INT64 conversion +// +#define DWordPtrToInt64 ULongPtrToLongLong + +// +// DWORD_PTR -> ptrdiff_t conversion +// +#define DWordPtrToPtrdiffT ULongPtrToIntPtr + +// +// DWORD_PTR -> SSIZE_T conversion +// +#define DWordPtrToSSIZET ULongPtrToLongPtr + +// +// LONGLONG -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToInt8( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) INT8* pi8Result) +{ + HRESULT hr; + + if ((llOperand >= INT8_MIN) && (llOperand <= INT8_MAX)) + { + *pi8Result = (INT8)llOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToUChar( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) UCHAR* pch) +{ + HRESULT hr; + + if ((llOperand >= 0) && (llOperand <= 255)) + { + *pch = (UCHAR)llOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> CHAR conversion +// +__forceinline +HRESULT +LongLongToChar( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return LongLongToUChar(llOperand, (UCHAR*)pch); +#else + return LongLongToInt8(llOperand, (INT8*)pch); +#endif +} + +// +// LONGLONG -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToUInt8( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) UINT8* pu8Result) +{ + HRESULT hr; + + if ((llOperand >= 0) && (llOperand <= UINT8_MAX)) + { + *pu8Result = (UINT8)llOperand; + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> BYTE conversion +// +#define LongLongToByte LongLongToUInt8 + +// +// LONGLONG -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToShort( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) SHORT* psResult) +{ + HRESULT hr; + + if ((llOperand >= SHORT_MIN) && (llOperand <= SHORT_MAX)) + { + *psResult = (SHORT)llOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> INT16 conversion +// +#define LongLongToInt16 LongLongToShort + +// +// LONGLONG -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToUShort( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) USHORT* pusResult) +{ + HRESULT hr; + + if ((llOperand >= 0) && (llOperand <= USHORT_MAX)) + { + *pusResult = (USHORT)llOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> UINT16 conversion +// +#define LongLongToUInt16 LongLongToUShort + +// +// LONGLONG -> WORD conversion +// +#define LongLongToWord LongLongToUShort + +// +// LONGLONG -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToInt( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) INT* piResult) +{ + HRESULT hr; + + if ((llOperand >= INT_MIN) && (llOperand <= INT_MAX)) + { + *piResult = (INT)llOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> INT32 conversion +// +#define LongLongToInt32 LongLongToInt + +// +// LONGLONG -> INT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +LongLongToIntPtr( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) INT_PTR* piResult) +{ + *piResult = llOperand; + return S_OK; +} +#else +#define LongLongToIntPtr LongLongToInt +#endif + +// +// LONGLONG -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToUInt( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) UINT* puResult) +{ + HRESULT hr; + + if ((llOperand >= 0) && (llOperand <= UINT_MAX)) + { + *puResult = (UINT)llOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> UINT32 conversion +// +#define LongLongToUInt32 LongLongToUInt + +// +// LONGLONG -> UINT_PTR conversion +// +#ifdef _WIN64 +#define LongLongToUIntPtr LongLongToULongLong +#else +#define LongLongToUIntPtr LongLongToUInt +#endif + +// +// LONGLONG -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToLong( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) LONG* plResult) +{ + HRESULT hr; + + if ((llOperand >= LONG_MIN) && (llOperand <= LONG_MAX)) + { + *plResult = (LONG)llOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> LONG_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +LongLongToLongPtr( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) LONG_PTR* plResult) +{ + *plResult = (LONG_PTR)llOperand; + return S_OK; +} +#else +#define LongLongToLongPtr LongLongToLong +#endif + +// +// LONGLONG -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToULong( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) ULONG* pulResult) +{ + HRESULT hr; + + if ((llOperand >= 0) && (llOperand <= ULONG_MAX)) + { + *pulResult = (ULONG)llOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> ULONG_PTR conversion +// +#ifdef _WIN64 +#define LongLongToULongPtr LongLongToULongLong +#else +#define LongLongToULongPtr LongLongToULong +#endif + +// +// LONGLONG -> DWORD conversion +// +#define LongLongToDWord LongLongToULong + +// +// LONGLONG -> DWORD_PTR conversion +// +#define LongLongToDWordPtr LongLongToULongPtr + +// +// LONGLONG -> ULONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +LongLongToULongLong( + _In_ LONGLONG llOperand, + _Out_ _Deref_out_range_(==, llOperand) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (llOperand >= 0) + { + *pullResult = (ULONGLONG)llOperand; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// LONGLONG -> DWORDLONG conversion +// +#define LongLongToDWordLong LongLongToULongLong + +// +// LONGLONG -> ULONG64 conversion +// +#define LongLongToULong64 LongLongToULongLong + +// +// LONGLONG -> DWORD64 conversion +// +#define LongLongToDWord64 LongLongToULongLong + +// +// LONGLONG -> UINT64 conversion +// +#define LongLongToUInt64 LongLongToULongLong + +// +// LONGLONG -> ptrdiff_t conversion +// +#define LongLongToPtrdiffT LongLongToIntPtr + +// +// LONGLONG -> size_t conversion +// +#define LongLongToSizeT LongLongToUIntPtr + +// +// LONGLONG -> SSIZE_T conversion +// +#define LongLongToSSIZET LongLongToLongPtr + +// +// LONGLONG -> SIZE_T conversion +// +#define LongLongToSIZET LongLongToULongPtr + +// +// LONG64 -> CHAR conversion +// +#define Long64ToChar LongLongToChar + +// +// LONG64 -> INT8 conversion +// +#define Long64ToInt8 LongLongToInt8 + +// +// LONG64 -> UCHAR conversion +// +#define Long64ToUChar LongLongToUChar + +// +// LONG64 -> UINT8 conversion +// +#define Long64ToUInt8 LongLongToUInt8 + +// +// LONG64 -> BYTE conversion +// +#define Long64ToByte LongLongToUInt8 + +// +// LONG64 -> SHORT conversion +// +#define Long64ToShort LongLongToShort + +// +// LONG64 -> INT16 conversion +// +#define Long64ToInt16 LongLongToShort + +// +// LONG64 -> USHORT conversion +// +#define Long64ToUShort LongLongToUShort + +// +// LONG64 -> UINT16 conversion +// +#define Long64ToUInt16 LongLongToUShort + +// +// LONG64 -> WORD conversion +// +#define Long64ToWord LongLongToUShort + +// +// LONG64 -> INT conversion +// +#define Long64ToInt LongLongToInt + +// +// LONG64 -> INT32 conversion +// +#define Long64ToInt32 LongLongToInt + +// +// LONG64 -> INT_PTR conversion +// +#define Long64ToIntPtr LongLongToIntPtr + +// +// LONG64 -> UINT conversion +// +#define Long64ToUInt LongLongToUInt + +// +// LONG64 -> UINT32 conversion +// +#define Long64ToUInt32 LongLongToUInt + +// +// LONG64 -> UINT_PTR conversion +// +#define Long64ToUIntPtr LongLongToUIntPtr + +// +// LONG64 -> LONG conversion +// +#define Long64ToLong LongLongToLong + +// +// LONG64 -> LONG_PTR conversion +// +#define Long64ToLongPtr LongLongToLongPtr + +// +// LONG64 -> ULONG conversion +// +#define Long64ToULong LongLongToULong + +// +// LONG64 -> ULONG_PTR conversion +// +#define Long64ToULongPtr LongLongToULongPtr + +// +// LONG64 -> DWORD conversion +// +#define Long64ToDWord LongLongToULong + +// +// LONG64 -> DWORD_PTR conversion +// +#define Long64ToDWordPtr LongLongToULongPtr + +// +// LONG64 -> ULONGLONG conversion +// +#define Long64ToULongLong LongLongToULongLong + +// +// LONG64 -> ptrdiff_t conversion +// +#define Long64ToPtrdiffT LongLongToIntPtr + +// +// LONG64 -> size_t conversion +// +#define Long64ToSizeT LongLongToUIntPtr + +// +// LONG64 -> SSIZE_T conversion +// +#define Long64ToSSIZET LongLongToLongPtr + +// +// LONG64 -> SIZE_T conversion +// +#define Long64ToSIZET LongLongToULongPtr + +// +// INT64 -> CHAR conversion +// +#define Int64ToChar LongLongToChar + +// +// INT64 -> INT8 conversion +// +#define Int64ToInt8 LongLongToInt8 + +// +// INT64 -> UCHAR conversion +// +#define Int64ToUChar LongLongToUChar + +// +// INT64 -> UINT8 conversion +// +#define Int64ToUInt8 LongLongToUInt8 + +// +// INT64 -> BYTE conversion +// +#define Int64ToByte LongLongToUInt8 + +// +// INT64 -> SHORT conversion +// +#define Int64ToShort LongLongToShort + +// +// INT64 -> INT16 conversion +// +#define Int64ToInt16 LongLongToShort + +// +// INT64 -> USHORT conversion +// +#define Int64ToUShort LongLongToUShort + +// +// INT64 -> UINT16 conversion +// +#define Int64ToUInt16 LongLongToUShort + +// +// INT64 -> WORD conversion +// +#define Int64ToWord LongLongToUShort + +// +// INT64 -> INT conversion +// +#define Int64ToInt LongLongToInt + +// +// INT64 -> INT32 conversion +// +#define Int64ToInt32 LongLongToInt + +// +// INT64 -> INT_PTR conversion +// +#define Int64ToIntPtr LongLongToIntPtr + +// +// INT64 -> UINT conversion +// +#define Int64ToUInt LongLongToUInt + +// +// INT64 -> UINT32 conversion +// +#define Int64ToUInt32 LongLongToUInt + +// +// INT64 -> UINT_PTR conversion +// +#define Int64ToUIntPtr LongLongToUIntPtr + +// +// INT64 -> LONG conversion +// +#define Int64ToLong LongLongToLong + +// +// INT64 -> LONG_PTR conversion +// +#define Int64ToLongPtr LongLongToLongPtr + +// +// INT64 -> ULONG conversion +// +#define Int64ToULong LongLongToULong + +// +// INT64 -> ULONG_PTR conversion +// +#define Int64ToULongPtr LongLongToULongPtr + +// +// INT64 -> DWORD conversion +// +#define Int64ToDWord LongLongToULong + +// +// INT64 -> DWORD_PTR conversion +// +#define Int64ToDWordPtr LongLongToULongPtr + +// +// INT64 -> ULONGLONG conversion +// +#define Int64ToULongLong LongLongToULongLong + +// +// INT64 -> DWORDLONG conversion +// +#define Int64ToDWordLong LongLongToULongLong + +// +// INT64 -> ULONG64 conversion +// +#define Int64ToULong64 LongLongToULongLong + +// +// INT64 -> DWORD64 conversion +// +#define Int64ToDWord64 LongLongToULongLong + +// +// INT64 -> UINT64 conversion +// +#define Int64ToUInt64 LongLongToULongLong + +// +// INT64 -> ptrdiff_t conversion +// +#define Int64ToPtrdiffT LongLongToIntPtr + +// +// INT64 -> size_t conversion +// +#define Int64ToSizeT LongLongToUIntPtr + +// +// INT64 -> SSIZE_T conversion +// +#define Int64ToSSIZET LongLongToLongPtr + +// +// INT64 -> SIZE_T conversion +// +#define Int64ToSIZET LongLongToULongPtr + +// +// ULONGLONG -> INT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToInt8( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) INT8* pi8Result) +{ + HRESULT hr; + + if (ullOperand <= INT8_MAX) + { + *pi8Result = (INT8)ullOperand; + hr = S_OK; + } + else + { + *pi8Result = INT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> UCHAR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToUChar( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) UCHAR* pch) +{ + HRESULT hr; + + if (ullOperand <= 255) + { + *pch = (UCHAR)ullOperand; + hr = S_OK; + } + else + { + *pch = '\0'; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> CHAR conversion +// +__forceinline +HRESULT +ULongLongToChar( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) CHAR* pch) +{ +#ifdef _CHAR_UNSIGNED + return ULongLongToUChar(ullOperand, (UCHAR*)pch); +#else + return ULongLongToInt8(ullOperand, (INT8*)pch); +#endif +} + +// +// ULONGLONG -> UINT8 conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToUInt8( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) UINT8* pu8Result) +{ + HRESULT hr; + + if (ullOperand <= UINT8_MAX) + { + *pu8Result = (UINT8)ullOperand; + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> BYTE conversion +// +#define ULongLongToByte ULongLongToUInt8 + +// +// ULONGLONG -> SHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToShort( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) SHORT* psResult) +{ + HRESULT hr; + + if (ullOperand <= SHORT_MAX) + { + *psResult = (SHORT)ullOperand; + hr = S_OK; + } + else + { + *psResult = SHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> INT16 conversion +// +#define ULongLongToInt16 ULongLongToShort + +// +// ULONGLONG -> USHORT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToUShort( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) USHORT* pusResult) +{ + HRESULT hr; + + if (ullOperand <= USHORT_MAX) + { + *pusResult = (USHORT)ullOperand; + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> UINT16 conversion +// +#define ULongLongToUInt16 ULongLongToUShort + +// +// ULONGLONG -> WORD conversion +// +#define ULongLongToWord ULongLongToUShort + +// +// ULONGLONG -> INT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToInt( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) INT* piResult) +{ + HRESULT hr; + + if (ullOperand <= INT_MAX) + { + *piResult = (INT)ullOperand; + hr = S_OK; + } + else + { + *piResult = INT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> INT32 conversion +// +#define ULongLongToInt32 ULongLongToInt + +// +// ULONGLONG -> INT_PTR conversion +// +#ifdef _WIN64 +#define ULongLongToIntPtr ULongLongToLongLong +#else +#define ULongLongToIntPtr ULongLongToInt +#endif + +// +// ULONGLONG -> UINT conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToUInt( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) UINT* puResult) +{ + HRESULT hr; + + if (ullOperand <= UINT_MAX) + { + *puResult = (UINT)ullOperand; + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> UINT32 conversion +// +#define ULongLongToUInt32 ULongLongToUInt + +// +// ULONGLONG -> UINT_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +ULongLongToUIntPtr( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) UINT_PTR* puResult) +{ + *puResult = ullOperand; + return S_OK; +} +#else +#define ULongLongToUIntPtr ULongLongToUInt +#endif + +// +// ULONGLONG -> LONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToLong( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) LONG* plResult) +{ + HRESULT hr; + + if (ullOperand <= LONG_MAX) + { + *plResult = (LONG)ullOperand; + hr = S_OK; + } + else + { + *plResult = LONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> LONG_PTR conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToLongPtr( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) LONG_PTR* plResult) +{ + HRESULT hr; + + if (ullOperand <= LONG_PTR_MAX) + { + *plResult = (LONG_PTR)ullOperand; + hr = S_OK; + } + else + { + *plResult = LONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> ULONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToULong( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) ULONG* pulResult) +{ + HRESULT hr; + + if (ullOperand <= ULONG_MAX) + { + *pulResult = (ULONG)ullOperand; + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> ULONG_PTR conversion +// +#ifdef _WIN64 +_Must_inspect_result_ +__inline +HRESULT +ULongLongToULongPtr( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) ULONG_PTR* pulResult) +{ + *pulResult = ullOperand; + return S_OK; +} +#else +#define ULongLongToULongPtr ULongLongToULong +#endif + +// +// ULONGLONG -> DWORD conversion +// +#define ULongLongToDWord ULongLongToULong + +// +// ULONGLONG -> DWORD_PTR conversion +// +#define ULongLongToDWordPtr ULongLongToULongPtr + +// +// ULONGLONG -> LONGLONG conversion +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongToLongLong( + _In_ ULONGLONG ullOperand, + _Out_ _Deref_out_range_(==, ullOperand) LONGLONG* pllResult) +{ + HRESULT hr; + + if (ullOperand <= LONGLONG_MAX) + { + *pllResult = (LONGLONG)ullOperand; + hr = S_OK; + } + else + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONGLONG -> INT64 conversion +// +#define ULongLongToInt64 ULongLongToLongLong + +// +// ULONGLONG -> LONG64 conversion +// +#define ULongLongToLong64 ULongLongToLongLong + +// +// ULONGLONG -> ptrdiff_t conversion +// +#define ULongLongToPtrdiffT ULongLongToIntPtr + +// +// ULONGLONG -> size_t conversion +// +#define ULongLongToSizeT ULongLongToUIntPtr + +// +// ULONGLONG -> SSIZE_T conversion +// +#define ULongLongToSSIZET ULongLongToLongPtr + +// +// ULONGLONG -> SIZE_T conversion +// +#define ULongLongToSIZET ULongLongToULongPtr + +// +// DWORDLONG -> CHAR conversion +// +#define DWordLongToChar ULongLongToChar + +// +// DWORDLONG -> INT8 conversion +// +#define DWordLongToInt8 ULongLongToInt8 + +// +// DWORDLONG -> UCHAR conversion +// +#define DWordLongToUChar ULongLongToUChar + +// +// DWORDLONG -> UINT8 conversion +// +#define DWordLongToUInt8 ULongLongToUInt8 + +// +// DWORDLONG -> BYTE conversion +// +#define DWordLongToByte ULongLongToUInt8 + +// +// DWORDLONG -> SHORT conversion +// +#define DWordLongToShort ULongLongToShort + +// +// DWORDLONG -> INT16 conversion +// +#define DWordLongToInt16 ULongLongToShort + +// +// DWORDLONG -> USHORT conversion +// +#define DWordLongToUShort ULongLongToUShort + +// +// DWORDLONG -> UINT16 conversion +// +#define DWordLongToUInt16 ULongLongToUShort + +// +// DWORDLONG -> WORD conversion +// +#define DWordLongToWord ULongLongToUShort + +// +// DWORDLONG -> INT conversion +// +#define DWordLongToInt ULongLongToInt + +// +// DWORDLONG -> INT32 conversion +// +#define DWordLongToInt32 ULongLongToInt + +// +// DWORDLONG -> INT_PTR conversion +// +#define DWordLongToIntPtr ULongLongToIntPtr + +// +// DWORDLONG -> UINT conversion +// +#define DWordLongToUInt ULongLongToUInt + +// +// DWORDLONG -> UINT32 conversion +// +#define DWordLongToUInt32 ULongLongToUInt + +// +// DWORDLONG -> UINT_PTR conversion +// +#define DWordLongToUIntPtr ULongLongToUIntPtr + +// +// DWORDLONG -> LONG conversion +// +#define DWordLongToLong ULongLongToLong + +// +// DWORDLONG -> LONG_PTR conversion +// +#define DWordLongToLongPtr ULongLongToLongPtr + +// +// DWORDLONG -> ULONG conversion +// +#define DWordLongToULong ULongLongToULong + +// +// DWORDLONG -> ULONG_PTR conversion +// +#define DWordLongToULongPtr ULongLongToULongPtr + +// +// DWORDLONG -> DWORD conversion +// +#define DWordLongToDWord ULongLongToULong + +// +// DWORDLONG -> DWORD_PTR conversion +// +#define DWordLongToDWordPtr ULongLongToULongPtr + +// +// DWORDLONG -> LONGLONG conversion +// +#define DWordLongToLongLong ULongLongToLongLong + +// +// DWORDLONG -> LONG64 conversion +// +#define DWordLongToLong64 ULongLongToLongLong + +// +// DWORDLONG -> INT64 conversion +// +#define DWordLongToInt64 ULongLongToLongLong + +// +// DWORDLONG -> ptrdiff_t conversion +// +#define DWordLongToPtrdiffT ULongLongToIntPtr + +// +// DWORDLONG -> size_t conversion +// +#define DWordLongToSizeT ULongLongToUIntPtr + +// +// DWORDLONG -> SSIZE_T conversion +// +#define DWordLongToSSIZET ULongLongToLongPtr + +// +// DWORDLONG -> SIZE_T conversion +// +#define DWordLongToSIZET ULongLongToULongPtr + +// +// ULONG64 -> CHAR conversion +// +#define ULong64ToChar ULongLongToChar + +// +// ULONG64 -> INT8 conversion +// +#define ULong64ToInt8 ULongLongToInt8 + +// +// ULONG64 -> UCHAR conversion +// +#define ULong64ToUChar ULongLongToUChar + +// +// ULONG64 -> UINT8 conversion +// +#define ULong64ToUInt8 ULongLongToUInt8 + +// +// ULONG64 -> BYTE conversion +// +#define ULong64ToByte ULongLongToUInt8 + +// +// ULONG64 -> SHORT conversion +// +#define ULong64ToShort ULongLongToShort + +// +// ULONG64 -> INT16 conversion +// +#define ULong64ToInt16 ULongLongToShort + +// +// ULONG64 -> USHORT conversion +// +#define ULong64ToUShort ULongLongToUShort + +// +// ULONG64 -> UINT16 conversion +// +#define ULong64ToUInt16 ULongLongToUShort + +// +// ULONG64 -> WORD conversion +// +#define ULong64ToWord ULongLongToUShort + +// +// ULONG64 -> INT conversion +// +#define ULong64ToInt ULongLongToInt + +// +// ULONG64 -> INT32 conversion +// +#define ULong64ToInt32 ULongLongToInt + +// +// ULONG64 -> INT_PTR conversion +// +#define ULong64ToIntPtr ULongLongToIntPtr + +// +// ULONG64 -> UINT conversion +// +#define ULong64ToUInt ULongLongToUInt + +// +// ULONG64 -> UINT32 conversion +// +#define ULong64ToUInt32 ULongLongToUInt + +// +// ULONG64 -> UINT_PTR conversion +// +#define ULong64ToUIntPtr ULongLongToUIntPtr + +// +// ULONG64 -> LONG conversion +// +#define ULong64ToLong ULongLongToLong + +// +// ULONG64 -> LONG_PTR conversion +// +#define ULong64ToLongPtr ULongLongToLongPtr + +// +// ULONG64 -> ULONG conversion +// +#define ULong64ToULong ULongLongToULong + +// +// ULONG64 -> ULONG_PTR conversion +// +#define ULong64ToULongPtr ULongLongToULongPtr + +// +// ULONG64 -> DWORD conversion +// +#define ULong64ToDWord ULongLongToULong + +// +// ULONG64 -> DWORD_PTR conversion +// +#define ULong64ToDWordPtr ULongLongToULongPtr + +// +// ULONG64 -> LONGLONG conversion +// +#define ULong64ToLongLong ULongLongToLongLong + +// +// ULONG64 -> LONG64 conversion +// +#define ULong64ToLong64 ULongLongToLongLong + +// +// ULONG64 -> INT64 conversion +// +#define ULong64ToInt64 ULongLongToLongLong + +// +// ULONG64 -> ptrdiff_t conversion +// +#define ULong64ToPtrdiffT ULongLongToIntPtr + +// +// ULONG64 -> size_t conversion +// +#define ULong64ToSizeT ULongLongToUIntPtr + +// +// ULONG64 -> SSIZE_T conversion +// +#define ULong64ToSSIZET ULongLongToLongPtr + +// +// ULONG64 -> SIZE_T conversion +// +#define ULong64ToSIZET ULongLongToULongPtr + +// +// DWORD64 -> CHAR conversion +// +#define DWord64ToChar ULongLongToChar + +// +// DWORD64 -> INT8 conversion +// +#define DWord64ToInt8 ULongLongToInt8 + +// +// DWORD64 -> UCHAR conversion +// +#define DWord64ToUChar ULongLongToUChar + +// +// DWORD64 -> UINT8 conversion +// +#define DWord64ToUInt8 ULongLongToUInt8 + +// +// DWORD64 -> BYTE conversion +// +#define DWord64ToByte ULongLongToUInt8 + +// +// DWORD64 -> SHORT conversion +// +#define DWord64ToShort ULongLongToShort + +// +// DWORD64 -> INT16 conversion +// +#define DWord64ToInt16 ULongLongToShort + +// +// DWORD64 -> USHORT conversion +// +#define DWord64ToUShort ULongLongToUShort + +// +// DWORD64 -> UINT16 conversion +// +#define DWord64ToUInt16 ULongLongToUShort + +// +// DWORD64 -> WORD conversion +// +#define DWord64ToWord ULongLongToUShort + +// +// DWORD64 -> INT conversion +// +#define DWord64ToInt ULongLongToInt + +// +// DWORD64 -> INT32 conversion +// +#define DWord64ToInt32 ULongLongToInt + +// +// DWORD64 -> INT_PTR conversion +// +#define DWord64ToIntPtr ULongLongToIntPtr + +// +// DWORD64 -> UINT conversion +// +#define DWord64ToUInt ULongLongToUInt + +// +// DWORD64 -> UINT32 conversion +// +#define DWord64ToUInt32 ULongLongToUInt + +// +// DWORD64 -> UINT_PTR conversion +// +#define DWord64ToUIntPtr ULongLongToUIntPtr + +// +// DWORD64 -> LONG conversion +// +#define DWord64ToLong ULongLongToLong + +// +// DWORD64 -> LONG_PTR conversion +// +#define DWord64ToLongPtr ULongLongToLongPtr + +// +// DWORD64 -> ULONG conversion +// +#define DWord64ToULong ULongLongToULong + +// +// DWORD64 -> ULONG_PTR conversion +// +#define DWord64ToULongPtr ULongLongToULongPtr + +// +// DWORD64 -> DWORD conversion +// +#define DWord64ToDWord ULongLongToULong + +// +// DWORD64 -> DWORD_PTR conversion +// +#define DWord64ToDWordPtr ULongLongToULongPtr + +// +// DWORD64 -> LONGLONG conversion +// +#define DWord64ToLongLong ULongLongToLongLong + +// +// DWORD64 -> LONG64 conversion +// +#define DWord64ToLong64 ULongLongToLongLong + +// +// DWORD64 -> INT64 conversion +// +#define DWord64ToInt64 ULongLongToLongLong + +// +// DWORD64 -> ptrdiff_t conversion +// +#define DWord64ToPtrdiffT ULongLongToIntPtr + +// +// DWORD64 -> size_t conversion +// +#define DWord64ToSizeT ULongLongToUIntPtr + +// +// DWORD64 -> SSIZE_T conversion +// +#define DWord64ToSSIZET ULongLongToLongPtr + +// +// DWORD64 -> SIZE_T conversion +// +#define DWord64ToSIZET ULongLongToULongPtr + +// +// UINT64 -> CHAR conversion +// +#define UInt64ToChar ULongLongToChar + +// +// UINT64 -> INT8 conversion +// +#define UInt64ToInt8 ULongLongToInt8 + +// +// UINT64 -> UCHAR conversion +// +#define UInt64ToUChar ULongLongToUChar + +// +// UINT64 -> UINT8 conversion +// +#define UInt64ToUInt8 ULongLongToUInt8 + +// +// UINT64 -> BYTE conversion +// +#define UInt64ToByte ULongLongToUInt8 + +// +// UINT64 -> SHORT conversion +// +#define UInt64ToShort ULongLongToShort + +// +// UINT64 -> INT16 conversion +// +// +#define UInt64ToInt16 ULongLongToShort + +// +// UINT64 -> USHORT conversion +// +#define UInt64ToUShort ULongLongToUShort + +// +// UINT64 -> UINT16 conversion +// +#define UInt64ToUInt16 ULongLongToUShort + +// +// UINT64 -> WORD conversion +// +#define UInt64ToWord ULongLongToUShort + +// +// UINT64 -> INT conversion +// +#define UInt64ToInt ULongLongToInt + +// +// UINT64 -> INT32 conversion +// +#define UInt64ToInt32 ULongLongToInt + +// +// UINT64 -> INT_PTR conversion +// +#define UInt64ToIntPtr ULongLongToIntPtr + +// +// UINT64 -> UINT conversion +// +#define UInt64ToUInt ULongLongToUInt + +// +// UINT64 -> UINT32 conversion +// +#define UInt64ToUInt32 ULongLongToUInt + +// +// UINT64 -> UINT_PTR conversion +// +#define UInt64ToUIntPtr ULongLongToUIntPtr + +// +// UINT64 -> LONG conversion +// +#define UInt64ToLong ULongLongToLong + +// +// UINT64 -> LONG_PTR conversion +// +#define UInt64ToLongPtr ULongLongToLongPtr + +// +// UINT64 -> ULONG conversion +// +#define UInt64ToULong ULongLongToULong + +// +// UINT64 -> ULONG_PTR conversion +// +#define UInt64ToULongPtr ULongLongToULongPtr + +// +// UINT64 -> DWORD conversion +// +#define UInt64ToDWord ULongLongToULong + +// +// UINT64 -> DWORD_PTR conversion +// +#define UInt64ToDWordPtr ULongLongToULongPtr + +// +// UINT64 -> LONGLONG conversion +// +#define UInt64ToLongLong ULongLongToLongLong + +// +// UINT64 -> LONG64 conversion +// +#define UInt64ToLong64 ULongLongToLongLong + +// +// UINT64 -> INT64 conversion +// +#define UInt64ToInt64 ULongLongToLongLong + +// +// UINT64 -> ptrdiff_t conversion +// +#define UInt64ToPtrdiffT ULongLongToIntPtr + +// +// UINT64 -> size_t conversion +// +#define UInt64ToSizeT ULongLongToUIntPtr + +// +// UINT64 -> SSIZE_T conversion +// +#define UInt64ToSSIZET ULongLongToLongPtr + +// +// UINT64 -> SIZE_T conversion +// +#define UInt64ToSIZET ULongLongToULongPtr + +// +// ptrdiff_t -> CHAR conversion +// +#define PtrdiffTToChar IntPtrToChar + +// +// ptrdiff_t -> INT8 conversion +// +#define PtrdiffTToInt8 IntPtrToInt8 + +// +// ptrdiff_t -> UCHAR conversion +// +#define PtrdiffTToUChar IntPtrToUChar + +// +// ptrdiff_t -> UINT8 conversion +// +#define PtrdiffTToUInt8 IntPtrToUInt8 + +// +// ptrdiff_t -> BYTE conversion +// +#define PtrdiffTToByte IntPtrToUInt8 + +// +// ptrdiff_t -> SHORT conversion +// +#define PtrdiffTToShort IntPtrToShort + +// +// ptrdiff_t -> INT16 conversion +// +#define PtrdiffTToInt16 IntPtrToShort + +// +// ptrdiff_t -> USHORT conversion +// +#define PtrdiffTToUShort IntPtrToUShort + +// +// ptrdiff_t -> UINT16 conversion +// +#define PtrdiffTToUInt16 IntPtrToUShort + +// +// ptrdiff_t -> WORD conversion +// +#define PtrdiffTToWord IntPtrToUShort + +// +// ptrdiff_t -> INT conversion +// +#define PtrdiffTToInt IntPtrToInt + +// +// ptrdiff_t -> INT32 conversion +// +#define PtrdiffTToInt32 IntPtrToInt + +// +// ptrdiff_t -> UINT conversion +// +#define PtrdiffTToUInt IntPtrToUInt + +// +// ptrdiff_t -> UINT32 conversion +// +#define PtrdiffTToUInt32 IntPtrToUInt + +// +// ptrdiff_t -> UINT_PTR conversion +// +#define PtrdiffTToUIntPtr IntPtrToUIntPtr + +// +// ptrdiff_t -> LONG conversion +// +#define PtrdiffTToLong IntPtrToLong + +// +// ptrdiff_t -> LONG_PTR conversion +// +#define PtrdiffTToLongPtr IntPtrToLongPtr + +// +// ptrdiff_t -> ULONG conversion +// +#define PtrdiffTToULong IntPtrToULong + +// +// ptrdiff_t -> ULONG_PTR conversion +// +#define PtrdiffTToULongPtr IntPtrToULongPtr + +// +// ptrdiff_t -> DWORD conversion +// +#define PtrdiffTToDWord IntPtrToULong + +// +// ptrdiff_t -> DWORD_PTR conversion +// +#define PtrdiffTToDWordPtr IntPtrToULongPtr + +// +// ptrdiff_t -> ULONGLONG conversion +// +#define PtrdiffTToULongLong IntPtrToULongLong + +// +// ptrdiff_t -> DWORDLONG conversion +// +#define PtrdiffTToDWordLong IntPtrToULongLong + +// +// ptrdiff_t -> ULONG64 conversion +// +#define PtrdiffTToULong64 IntPtrToULongLong + +// +// ptrdiff_t -> DWORD64 conversion +// +#define PtrdiffTToDWord64 IntPtrToULongLong + +// +// ptrdiff_t -> UINT64 conversion +// +#define PtrdiffTToUInt64 IntPtrToULongLong + +// +// ptrdiff_t -> size_t conversion +// +#define PtrdiffTToSizeT IntPtrToUIntPtr + +// +// ptrdiff_t -> SIZE_T conversion +// +#define PtrdiffTToSIZET IntPtrToULongPtr + +// +// size_t -> INT8 conversion +// +#define SizeTToInt8 UIntPtrToInt8 + +// +// size_t -> UCHAR conversion +// +#define SizeTToUChar UIntPtrToUChar + +// +// size_t -> CHAR conversion +// +#define SizeTToChar UIntPtrToChar + +// +// size_t -> UINT8 conversion +// +#define SizeTToUInt8 UIntPtrToUInt8 + +// +// size_t -> BYTE conversion +// +#define SizeTToByte UIntPtrToUInt8 + +// +// size_t -> SHORT conversion +// +#define SizeTToShort UIntPtrToShort + +// +// size_t -> INT16 conversion +// +#define SizeTToInt16 UIntPtrToShort + +// +// size_t -> USHORT conversion +// +#define SizeTToUShort UIntPtrToUShort + +// +// size_t -> UINT16 conversion +// +#define SizeTToUInt16 UIntPtrToUShort + +// +// size_t -> WORD +// +#define SizeTToWord UIntPtrToUShort + +// +// size_t -> INT conversion +// +#define SizeTToInt UIntPtrToInt + +// +// size_t -> INT32 conversion +// +#define SizeTToInt32 UIntPtrToInt + +// +// size_t -> INT_PTR conversion +// +#define SizeTToIntPtr UIntPtrToIntPtr + +// +// size_t -> UINT conversion +// +#define SizeTToUInt UIntPtrToUInt + +// +// size_t -> UINT32 conversion +// +#define SizeTToUInt32 UIntPtrToUInt + +// +// size_t -> LONG conversion +// +#define SizeTToLong UIntPtrToLong + +// +// size_t -> LONG_PTR conversion +// +#define SizeTToLongPtr UIntPtrToLongPtr + +// +// size_t -> ULONG conversion +// +#define SizeTToULong UIntPtrToULong + +// +// size_t -> DWORD conversion +// +#define SizeTToDWord UIntPtrToULong + +// +// size_t -> LONGLONG conversion +// +#define SizeTToLongLong UIntPtrToLongLong + +// +// size_t -> LONG64 conversion +// +#define SizeTToLong64 UIntPtrToLongLong + +// +// size_t -> INT64 +// +#define SizeTToInt64 UIntPtrToLongLong + +// +// size_t -> ptrdiff_t conversion +// +#define SizeTToPtrdiffT UIntPtrToIntPtr + +// +// size_t -> SSIZE_T conversion +// +#define SizeTToSSIZET UIntPtrToLongPtr + +// +// SSIZE_T -> INT8 conversion +// +#define SSIZETToInt8 LongPtrToInt8 + +// +// SSIZE_T -> UCHAR conversion +// +#define SSIZETToUChar LongPtrToUChar + +// +// SSIZE_T -> CHAR conversion +// +#define SSIZETToChar LongPtrToChar + +// +// SSIZE_T -> UINT8 conversion +// +#define SSIZETToUInt8 LongPtrToUInt8 + +// +// SSIZE_T -> BYTE conversion +// +#define SSIZETToByte LongPtrToUInt8 + +// +// SSIZE_T -> SHORT conversion +// +#define SSIZETToShort LongPtrToShort + +// +// SSIZE_T -> INT16 conversion +// +#define SSIZETToInt16 LongPtrToShort + +// +// SSIZE_T -> USHORT conversion +// +#define SSIZETToUShort LongPtrToUShort + +// +// SSIZE_T -> UINT16 conversion +// +#define SSIZETToUInt16 LongPtrToUShort + +// +// SSIZE_T -> WORD conversion +// +#define SSIZETToWord LongPtrToUShort + +// +// SSIZE_T -> INT conversion +// +#define SSIZETToInt LongPtrToInt + +// +// SSIZE_T -> INT32 conversion +// +#define SSIZETToInt32 LongPtrToInt + +// +// SSIZE_T -> INT_PTR conversion +// +#define SSIZETToIntPtr LongPtrToIntPtr + +// +// SSIZE_T -> UINT conversion +// +#define SSIZETToUInt LongPtrToUInt + +// +// SSIZE_T -> UINT32 conversion +// +#define SSIZETToUInt32 LongPtrToUInt + +// +// SSIZE_T -> UINT_PTR conversion +// +#define SSIZETToUIntPtr LongPtrToUIntPtr + +// +// SSIZE_T -> LONG conversion +// +#define SSIZETToLong LongPtrToLong + +// +// SSIZE_T -> ULONG conversion +// +#define SSIZETToULong LongPtrToULong + +// +// SSIZE_T -> ULONG_PTR conversion +// +#define SSIZETToULongPtr LongPtrToULongPtr + +// +// SSIZE_T -> DWORD conversion +// +#define SSIZETToDWord LongPtrToULong + +// +// SSIZE_T -> DWORD_PTR conversion +// +#define SSIZETToDWordPtr LongPtrToULongPtr + +// +// SSIZE_T -> ULONGLONG conversion +// +#define SSIZETToULongLong LongPtrToULongLong + +// +// SSIZE_T -> DWORDLONG conversion +// +#define SSIZETToDWordLong LongPtrToULongLong + +// +// SSIZE_T -> ULONG64 conversion +// +#define SSIZETToULong64 LongPtrToULongLong + +// +// SSIZE_T -> DWORD64 conversion +// +#define SSIZETToDWord64 LongPtrToULongLong + +// +// SSIZE_T -> UINT64 conversion +// +#define SSIZETToUInt64 LongPtrToULongLong + +// +// SSIZE_T -> size_t conversion +// +#define SSIZETToSizeT LongPtrToUIntPtr + +// +// SSIZE_T -> SIZE_T conversion +// +#define SSIZETToSIZET LongPtrToULongPtr + +// +// SIZE_T -> INT8 conversion +// +#define SIZETToInt8 ULongPtrToInt8 + +// +// SIZE_T -> UCHAR conversion +// +#define SIZETToUChar ULongPtrToUChar + +// +// SIZE_T -> CHAR conversion +// +#define SIZETToChar ULongPtrToChar + +// +// SIZE_T -> UINT8 conversion +// +#define SIZETToUInt8 ULongPtrToUInt8 + +// +// SIZE_T -> BYTE conversion +// +#define SIZETToByte ULongPtrToUInt8 + +// +// SIZE_T -> SHORT conversion +// +#define SIZETToShort ULongPtrToShort + +// +// SIZE_T -> INT16 conversion +// +#define SIZETToInt16 ULongPtrToShort + +// +// SIZE_T -> USHORT conversion +// +#define SIZETToUShort ULongPtrToUShort + +// +// SIZE_T -> UINT16 conversion +// +#define SIZETToUInt16 ULongPtrToUShort + +// +// SIZE_T -> WORD +// +#define SIZETToWord ULongPtrToUShort + +// +// SIZE_T -> INT conversion +// +#define SIZETToInt ULongPtrToInt + +// +// SIZE_T -> INT32 conversion +// +#define SIZETToInt32 ULongPtrToInt + +// +// SIZE_T -> INT_PTR conversion +// +#define SIZETToIntPtr ULongPtrToIntPtr + +// +// SIZE_T -> UINT conversion +// +#define SIZETToUInt ULongPtrToUInt + +// +// SIZE_T -> UINT32 conversion +// +#define SIZETToUInt32 ULongPtrToUInt + +// +// SIZE_T -> UINT_PTR conversion +// +#define SIZETToUIntPtr ULongPtrToUIntPtr + +// +// SIZE_T -> LONG conversion +// +#define SIZETToLong ULongPtrToLong + +// +// SIZE_T -> LONG_PTR conversion +// +#define SIZETToLongPtr ULongPtrToLongPtr + +// +// SIZE_T -> ULONG conversion +// +#define SIZETToULong ULongPtrToULong + +// +// SIZE_T -> DWORD conversion +// +#define SIZETToDWord ULongPtrToULong + +// +// SIZE_T -> LONGLONG conversion +// +#define SIZETToLongLong ULongPtrToLongLong + +// +// SIZE_T -> LONG64 conversion +// +#define SIZETToLong64 ULongPtrToLongLong + +// +// SIZE_T -> INT64 +// +#define SIZETToInt64 ULongPtrToLongLong + +// +// SIZE_T -> ptrdiff_t conversion +// +#define SIZETToPtrdiffT ULongPtrToIntPtr + +// +// SIZE_T -> SSIZE_T conversion +// +#define SIZETToSSIZET ULongPtrToLongPtr + + +//============================================================================= +// Addition functions +//============================================================================= + +// +// UINT8 addition +// +_Must_inspect_result_ +__inline +HRESULT +UInt8Add( + _In_ UINT8 u8Augend, + _In_ UINT8 u8Addend, + _Out_ _Deref_out_range_(==, u8Augend + u8Addend) UINT8* pu8Result) +{ + HRESULT hr; + + if (((UINT8)(u8Augend + u8Addend)) >= u8Augend) + { + *pu8Result = (UINT8)(u8Augend + u8Addend); + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT addition +// +_Must_inspect_result_ +__inline +HRESULT +UShortAdd( + _In_ USHORT usAugend, + _In_ USHORT usAddend, + _Out_ _Deref_out_range_(==, usAugend + usAddend) USHORT* pusResult) +{ + HRESULT hr; + + if (((USHORT)(usAugend + usAddend)) >= usAugend) + { + *pusResult = (USHORT)(usAugend + usAddend); + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT16 addition +// +#define UInt16Add UShortAdd + +// +// WORD addtition +// +#define WordAdd UShortAdd + +// +// UINT addition +// +_Must_inspect_result_ +__inline +HRESULT +UIntAdd( + _In_ UINT uAugend, + _In_ UINT uAddend, + _Out_ _Deref_out_range_(==, uAugend + uAddend) UINT* puResult) +{ + HRESULT hr; + + if ((uAugend + uAddend) >= uAugend) + { + *puResult = (uAugend + uAddend); + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT32 addition +// +#define UInt32Add UIntAdd + +// +// UINT_PTR addition +// +#ifdef _WIN64 +#define UIntPtrAdd ULongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrAdd( + _In_ UINT_PTR uAugend, + _In_ UINT_PTR uAddend, + _Out_ _Deref_out_range_(==, uAugend + uAddend) UINT_PTR* puResult) +{ + HRESULT hr; + + if ((uAugend + uAddend) >= uAugend) + { + *puResult = (uAugend + uAddend); + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// ULONG addition +// +_Must_inspect_result_ +__inline +HRESULT +ULongAdd( + _In_ ULONG ulAugend, + _In_ ULONG ulAddend, + _Out_ _Deref_out_range_(==, ulAugend + ulAddend) ULONG* pulResult) +{ + HRESULT hr; + + if ((ulAugend + ulAddend) >= ulAugend) + { + *pulResult = (ulAugend + ulAddend); + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR addition +// +#ifdef _WIN64 +#define ULongPtrAdd ULongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrAdd( + _In_ ULONG_PTR ulAugend, + _In_ ULONG_PTR ulAddend, + _Out_ _Deref_out_range_(==, ulAugend + ulAddend) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if ((ulAugend + ulAddend) >= ulAugend) + { + *pulResult = (ulAugend + ulAddend); + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// DWORD addition +// +#define DWordAdd ULongAdd + +// +// DWORD_PTR addition +// +#ifdef _WIN64 +#define DWordPtrAdd ULongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +DWordPtrAdd( + _In_ DWORD_PTR dwAugend, + _In_ DWORD_PTR dwAddend, + _Out_ _Deref_out_range_(==, dwAugend + dwAddend) DWORD_PTR* pdwResult) +{ + HRESULT hr; + + if ((dwAugend + dwAddend) >= dwAugend) + { + *pdwResult = (dwAugend + dwAddend); + hr = S_OK; + } + else + { + *pdwResult = DWORD_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// size_t addition +// +_Must_inspect_result_ +__inline +HRESULT +SizeTAdd( + _In_ size_t Augend, + _In_ size_t Addend, + _Out_ _Deref_out_range_(==, Augend + Addend) size_t* pResult) +{ + HRESULT hr; + + if ((Augend + Addend) >= Augend) + { + *pResult = (Augend + Addend); + hr = S_OK; + } + else + { + *pResult = SIZE_T_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SIZE_T addition +// +#ifdef _WIN64 +#define SIZETAdd ULongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +SIZETAdd( + _In_ SIZE_T Augend, + _In_ SIZE_T Addend, + _Out_ _Deref_out_range_(==, Augend + Addend) SIZE_T* pResult) +{ + HRESULT hr; + + if ((Augend + Addend) >= Augend) + { + *pResult = (Augend + Addend); + hr = S_OK; + } + else + { + *pResult = _SIZE_T_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// ULONGLONG addition +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongAdd( + _In_ ULONGLONG ullAugend, + _In_ ULONGLONG ullAddend, + _Out_ _Deref_out_range_(==, ullAugend + ullAddend) ULONGLONG* pullResult) +{ + HRESULT hr; + + if ((ullAugend + ullAddend) >= ullAugend) + { + *pullResult = (ullAugend + ullAddend); + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// DWORDLONG addition +// +#define DWordLongAdd ULongLongAdd + +// +// ULONG64 addition +// +#define ULong64Add ULongLongAdd + +// +// DWORD64 addition +// +#define DWord64Add ULongLongAdd + +// +// UINT64 addition +// +#define UInt64Add ULongLongAdd + + +//============================================================================= +// Subtraction functions +//============================================================================= + +// +// UINT8 subtraction +// +_Must_inspect_result_ +__inline +HRESULT +UInt8Sub( + _In_ UINT8 u8Minuend, + _In_ UINT8 u8Subtrahend, + _Out_ _Deref_out_range_(==, u8Minuend - u8Subtrahend) UINT8* pu8Result) +{ + HRESULT hr; + + if (u8Minuend >= u8Subtrahend) + { + *pu8Result = (UINT8)(u8Minuend - u8Subtrahend); + hr = S_OK; + } + else + { + *pu8Result = UINT8_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// USHORT subtraction +// +_Must_inspect_result_ +__inline +HRESULT +UShortSub( + _In_ USHORT usMinuend, + _In_ USHORT usSubtrahend, + _Out_ _Deref_out_range_(==, usMinuend - usSubtrahend) USHORT* pusResult) +{ + HRESULT hr; + + if (usMinuend >= usSubtrahend) + { + *pusResult = (USHORT)(usMinuend - usSubtrahend); + hr = S_OK; + } + else + { + *pusResult = USHORT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT16 subtraction +// +#define UInt16Sub UShortSub + +// +// WORD subtraction +// +#define WordSub UShortSub + + +// +// UINT subtraction +// +_Must_inspect_result_ +__inline +HRESULT +UIntSub( + _In_ UINT uMinuend, + _In_ UINT uSubtrahend, + _Out_ _Deref_out_range_(==, uMinuend - uSubtrahend) UINT* puResult) +{ + HRESULT hr; + + if (uMinuend >= uSubtrahend) + { + *puResult = (uMinuend - uSubtrahend); + hr = S_OK; + } + else + { + *puResult = UINT_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// UINT32 subtraction +// +#define UInt32Sub UIntSub + +// +// UINT_PTR subtraction +// +#ifdef _WIN64 +#define UIntPtrSub ULongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrSub( + _In_ UINT_PTR uMinuend, + _In_ UINT_PTR uSubtrahend, + _Out_ _Deref_out_range_(==, uMinuend - uSubtrahend) UINT_PTR* puResult) +{ + HRESULT hr; + + if (uMinuend >= uSubtrahend) + { + *puResult = (uMinuend - uSubtrahend); + hr = S_OK; + } + else + { + *puResult = UINT_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// ULONG subtraction +// +_Must_inspect_result_ +__inline +HRESULT +ULongSub( + _In_ ULONG ulMinuend, + _In_ ULONG ulSubtrahend, + _Out_ _Deref_out_range_(==, ulMinuend - ulSubtrahend) ULONG* pulResult) +{ + HRESULT hr; + + if (ulMinuend >= ulSubtrahend) + { + *pulResult = (ulMinuend - ulSubtrahend); + hr = S_OK; + } + else + { + *pulResult = ULONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// ULONG_PTR subtraction +// +#ifdef _WIN64 +#define ULongPtrSub ULongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrSub( + _In_ ULONG_PTR ulMinuend, + _In_ ULONG_PTR ulSubtrahend, + _Out_ _Deref_out_range_(==, ulMinuend - ulSubtrahend) ULONG_PTR* pulResult) +{ + HRESULT hr; + + if (ulMinuend >= ulSubtrahend) + { + *pulResult = (ulMinuend - ulSubtrahend); + hr = S_OK; + } + else + { + *pulResult = ULONG_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + + +// +// DWORD subtraction +// +#define DWordSub ULongSub + +// +// DWORD_PTR subtraction +// +#ifdef _WIN64 +#define DWordPtrSub ULongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +DWordPtrSub( + _In_ DWORD_PTR dwMinuend, + _In_ DWORD_PTR dwSubtrahend, + _Out_ _Deref_out_range_(==, dwMinuend - dwSubtrahend) DWORD_PTR* pdwResult) +{ + HRESULT hr; + + if (dwMinuend >= dwSubtrahend) + { + *pdwResult = (dwMinuend - dwSubtrahend); + hr = S_OK; + } + else + { + *pdwResult = DWORD_PTR_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// size_t subtraction +// +_Must_inspect_result_ +__inline +HRESULT +SizeTSub( + _In_ size_t Minuend, + _In_ size_t Subtrahend, + _Out_ _Deref_out_range_(==, Minuend - Subtrahend) size_t* pResult) +{ + HRESULT hr; + + if (Minuend >= Subtrahend) + { + *pResult = (Minuend - Subtrahend); + hr = S_OK; + } + else + { + *pResult = SIZE_T_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// SIZE_T subtraction +// +#ifdef _WIN64 +#define SIZETSub ULongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +SIZETSub( + _In_ SIZE_T Minuend, + _In_ SIZE_T Subtrahend, + _Out_ _Deref_out_range_(==, Minuend - Subtrahend) SIZE_T* pResult) +{ + HRESULT hr; + + if (Minuend >= Subtrahend) + { + *pResult = (Minuend - Subtrahend); + hr = S_OK; + } + else + { + *pResult = _SIZE_T_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} +#endif // _WIN64 + +// +// ULONGLONG subtraction +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongSub( + _In_ ULONGLONG ullMinuend, + _In_ ULONGLONG ullSubtrahend, + _Out_ _Deref_out_range_(==, ullMinuend - ullSubtrahend) ULONGLONG* pullResult) +{ + HRESULT hr; + + if (ullMinuend >= ullSubtrahend) + { + *pullResult = (ullMinuend - ullSubtrahend); + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + + return hr; +} + +// +// DWORDLONG subtraction +// +#define DWordLongSub ULongLongSub + +// +// ULONG64 subtraction +// +#define ULong64Sub ULongLongSub + +// +// DWORD64 subtraction +// +#define DWord64Sub ULongLongSub + +// +// UINT64 subtraction +// +#define UInt64Sub ULongLongSub + + +//============================================================================= +// Multiplication functions +//============================================================================= + +// +// UINT8 multiplication +// +_Must_inspect_result_ +__inline +HRESULT +UInt8Mult( + _In_ UINT8 u8Multiplicand, + _In_ UINT8 u8Multiplier, + _Out_ _Deref_out_range_(==, u8Multiplicand * u8Multiplier) UINT8* pu8Result) +{ + UINT uResult = ((UINT)u8Multiplicand) * ((UINT)u8Multiplier); + + return UIntToUInt8(uResult, pu8Result); +} + +// +// USHORT multiplication +// +_Must_inspect_result_ +__inline +HRESULT +UShortMult( + _In_ USHORT usMultiplicand, + _In_ USHORT usMultiplier, + _Out_ _Deref_out_range_(==, usMultiplicand * usMultiplier) USHORT* pusResult) +{ + ULONG ulResult = ((ULONG)usMultiplicand) * ((ULONG)usMultiplier); + + return ULongToUShort(ulResult, pusResult); +} + +// +// UINT16 multiplication +// +#define UInt16Mult UShortMult + +// +// WORD multiplication +// +#define WordMult UShortMult + +// +// UINT multiplication +// +_Must_inspect_result_ +__inline +HRESULT +UIntMult( + _In_ UINT uMultiplicand, + _In_ UINT uMultiplier, + _Out_ _Deref_out_range_(==, uMultiplicand * uMultiplier) UINT* puResult) +{ + ULONGLONG ull64Result = UInt32x32To64(uMultiplicand, uMultiplier); + + return ULongLongToUInt(ull64Result, puResult); +} + +// +// UINT32 multiplication +// +#define UInt32Mult UIntMult + +// +// UINT_PTR multiplication +// +#ifdef _WIN64 +#define UIntPtrMult ULongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +UIntPtrMult( + _In_ UINT_PTR uMultiplicand, + _In_ UINT_PTR uMultiplier, + _Out_ _Deref_out_range_(==, uMultiplicand * uMultiplier) UINT_PTR* puResult) +{ + ULONGLONG ull64Result = UInt32x32To64(uMultiplicand, uMultiplier); + + return ULongLongToUIntPtr(ull64Result, puResult); +} +#endif // _WIN64 + +// +// ULONG multiplication +// +_Must_inspect_result_ +__inline +HRESULT +ULongMult( + _In_ ULONG ulMultiplicand, + _In_ ULONG ulMultiplier, + _Out_ _Deref_out_range_(==, ulMultiplicand * ulMultiplier) ULONG* pulResult) +{ + ULONGLONG ull64Result = UInt32x32To64(ulMultiplicand, ulMultiplier); + + return ULongLongToULong(ull64Result, pulResult); +} + +// +// ULONG_PTR multiplication +// +#ifdef _WIN64 +#define ULongPtrMult ULongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +ULongPtrMult( + _In_ ULONG_PTR ulMultiplicand, + _In_ ULONG_PTR ulMultiplier, + _Out_ _Deref_out_range_(==, ulMultiplicand * ulMultiplier) ULONG_PTR* pulResult) +{ + ULONGLONG ull64Result = UInt32x32To64(ulMultiplicand, ulMultiplier); + + return ULongLongToULongPtr(ull64Result, pulResult); +} +#endif // _WIN64 + +// +// DWORD multiplication +// +#define DWordMult ULongMult + +// +// DWORD_PTR multiplication +// +#ifdef _WIN64 +#define DWordPtrMult ULongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +DWordPtrMult( + _In_ DWORD_PTR dwMultiplicand, + _In_ DWORD_PTR dwMultiplier, + _Out_ _Deref_out_range_(==, dwMultiplicand * dwMultiplier) DWORD_PTR* pdwResult) +{ + ULONGLONG ull64Result = UInt32x32To64(dwMultiplicand, dwMultiplier); + + return ULongLongToDWordPtr(ull64Result, pdwResult); +} +#endif // _WIN64 + +// +// size_t multiplication +// + +#ifdef _WIN64 +#define SizeTMult ULongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +SizeTMult( + _In_ size_t Multiplicand, + _In_ size_t Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) size_t* pResult) +{ + ULONGLONG ull64Result = UInt32x32To64(Multiplicand, Multiplier); + + return ULongLongToSizeT(ull64Result, pResult); +} +#endif // _WIN64 + +// +// SIZE_T multiplication +// +#ifdef _WIN64 +#define SIZETMult ULongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +SIZETMult( + _In_ SIZE_T Multiplicand, + _In_ SIZE_T Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) SIZE_T* pResult) +{ + ULONGLONG ull64Result = UInt32x32To64(Multiplicand, Multiplier); + + return ULongLongToSIZET(ull64Result, pResult); +} +#endif // _WIN64 + +// +// ULONGLONG multiplication +// +_Must_inspect_result_ +__inline +HRESULT +ULongLongMult( + _In_ ULONGLONG ullMultiplicand, + _In_ ULONGLONG ullMultiplier, + _Out_ _Deref_out_range_(==, ullMultiplicand * ullMultiplier) ULONGLONG* pullResult) +{ + HRESULT hr; +#if defined(_USE_INTRINSIC_MULTIPLY128) + ULONGLONG ullResultHigh; + ULONGLONG ullResultLow; + + ullResultLow = __UnsignedMultiply128(ullMultiplicand, ullMultiplier, &ullResultHigh); + if (ullResultHigh == 0) + { + _Analysis_assume_(ullMultiplicand * ullMultiplier == ullResultLow); + *pullResult = ullResultLow; + hr = S_OK; + } + else + { + *pullResult = ULONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } +#else + // 64x64 into 128 is like 32.32 x 32.32. + // + // a.b * c.d = a*(c.d) + .b*(c.d) = a*c + a*.d + .b*c + .b*.d + // back in non-decimal notation where A=a*2^32 and C=c*2^32: + // A*C + A*d + b*C + b*d + // So there are four components to add together. + // result = (a*c*2^64) + (a*d*2^32) + (b*c*2^32) + (b*d) + // + // a * c must be 0 or there would be bits in the high 64-bits + // a * d must be less than 2^32 or there would be bits in the high 64-bits + // b * c must be less than 2^32 or there would be bits in the high 64-bits + // then there must be no overflow of the resulting values summed up. + + ULONG dw_a; + ULONG dw_b; + ULONG dw_c; + ULONG dw_d; + ULONGLONG ad = 0; + ULONGLONG bc = 0; + ULONGLONG bd = 0; + ULONGLONG ullResult = 0; + + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + + dw_a = (ULONG)(ullMultiplicand >> 32); + dw_c = (ULONG)(ullMultiplier >> 32); + + // common case -- if high dwords are both zero, no chance for overflow + if ((dw_a == 0) && (dw_c == 0)) + { + dw_b = (DWORD)ullMultiplicand; + dw_d = (DWORD)ullMultiplier; + + *pullResult = (((ULONGLONG)dw_b) * (ULONGLONG)dw_d); + hr = S_OK; + } + else + { + // a * c must be 0 or there would be bits set in the high 64-bits + if ((dw_a == 0) || + (dw_c == 0)) + { + dw_d = (DWORD)ullMultiplier; + + // a * d must be less than 2^32 or there would be bits set in the high 64-bits + ad = (((ULONGLONG)dw_a) * (ULONGLONG)dw_d); + if ((ad & 0xffffffff00000000) == 0) + { + dw_b = (DWORD)ullMultiplicand; + + // b * c must be less than 2^32 or there would be bits set in the high 64-bits + bc = (((ULONGLONG)dw_b) * (ULONGLONG)dw_c); + if ((bc & 0xffffffff00000000) == 0) + { + // now sum them all up checking for overflow. + // shifting is safe because we already checked for overflow above + if (SUCCEEDED(ULongLongAdd(bc << 32, ad << 32, &ullResult))) + { + // b * d + bd = (((ULONGLONG)dw_b) * (ULONGLONG)dw_d); + + if (SUCCEEDED(ULongLongAdd(ullResult, bd, &ullResult))) + { + *pullResult = ullResult; + hr = S_OK; + } + } + } + } + } + } + + if (FAILED(hr)) + { + *pullResult = ULONGLONG_ERROR; + } +#pragma warning(suppress:26071) +#endif // _USE_INTRINSIC_MULTIPLY128 + return hr; +} + +// +// DWORDLONG multiplication +// +#define DWordLongMult ULongLongMult + +// +// ULONG64 multiplication +// +#define ULong64Mult ULongLongMult + +// +// DWORD64 multiplication +// +#define DWord64Mult ULongLongMult + +// +// UINT64 multiplication +// +#define UInt64Mult ULongLongMult + + +///////////////////////////////////////////////////////////////////////// +// +// signed operations +// +// Strongly consider using unsigned numbers. +// +// Signed numbers are often used where unsigned numbers should be used. +// For example file sizes and array indices should always be unsigned. +// (File sizes should be 64bit integers; array indices should be size_t.) +// Subtracting a larger positive signed number from a smaller positive +// signed number with IntSub will succeed, producing a negative number, +// that then must not be used as an array index (but can occasionally be +// used as a pointer index.) Similarly for adding a larger magnitude +// negative number to a smaller magnitude positive number. +// +// intsafe.h does not protect you from such errors. It tells you if your +// integer operations overflowed, not if you are doing the right thing +// with your non-overflowed integers. +// +// Likewise you can overflow a buffer with a non-overflowed unsigned index. +// +#if defined(ENABLE_INTSAFE_SIGNED_FUNCTIONS) + +#if defined(_USE_INTRINSIC_MULTIPLY128) +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(_M_X64) && !defined(_M_ARM64EC) + +#define __Multiply128 _mul128 + +#endif // defined(_M_X64) && !defined(_M_ARM64EC) + +LONG64 +__Multiply128( + _In_ LONG64 Multiplier, + _In_ LONG64 Multiplicand, + _Out_ LONG64 *HighProduct + ); + +#if defined(_M_X64) && !defined(_M_ARM64EC) + +#pragma intrinsic(_mul128) + +#endif // defined(_M_X64) && !defined(_M_ARM64EC) + +#if defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64) + +LONG64 +__mulh( + LONG64 Multiplier, + LONG64 Multiplicand + ); + +#pragma intrinsic(__mulh) + +__inline +LONG64 +__Multiply128( + _In_ LONG64 Multiplier, + _In_ LONG64 Multiplicand, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) LONG64* HighProduct) +{ + *HighProduct = __mulh(Multiplier, Multiplicand); + return Multiplier * Multiplicand; +} + +#endif // defined(_M_ARM64) || defined(_M_ARM64EC) || defined(_M_HYBRID_X86_ARM64) + +#ifdef __cplusplus +} +#endif +#endif // _USE_INTRINSIC_MULTIPLY128 + + +//============================================================================= +// Signed addition functions +//============================================================================= + +// +// INT8 Addition +// +_Must_inspect_result_ +__inline +HRESULT +Int8Add( + _In_ INT8 i8Augend, + _In_ INT8 i8Addend, + _Out_ _Deref_out_range_(==, i8Augend + i8Addend) INT8* pi8Result + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(INT8)); + return LongToInt8(((LONG)i8Augend) + ((LONG)i8Addend), pi8Result); +} + +// +// SHORT Addition +// +_Must_inspect_result_ +__inline +HRESULT +ShortAdd( + _In_ SHORT sAugend, + _In_ SHORT sAddend, + _Out_ _Deref_out_range_(==, sAugend + sAddend) SHORT* psResult + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(SHORT)); + return LongToShort(((LONG)sAugend) + ((LONG)sAddend), psResult); +} + +// +// INT16 Addition +// +#define Int16Add ShortAdd + +// +// INT Addition +// +_Must_inspect_result_ +__inline +HRESULT +IntAdd( + _In_ INT iAugend, + _In_ INT iAddend, + _Out_ _Deref_out_range_(==, iAugend + iAddend) INT* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT)); + return LongLongToInt(((LONGLONG)iAugend) + ((LONGLONG)iAddend), piResult); +} + +// +// INT32 Addition +// +#define Int32Add IntAdd + +// +// INT_PTR addition +// +#ifdef _WIN64 +#define IntPtrAdd LongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrAdd( + _In_ INT_PTR iAugend, + _In_ INT_PTR iAddend, + _Out_ _Deref_out_range_(==, iAugend + iAddend) INT_PTR* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT_PTR)); + return LongLongToIntPtr(((LONGLONG)iAugend) + ((LONGLONG)iAddend), piResult); +} +#endif + +// +// LONG Addition +// +_Must_inspect_result_ +__inline +HRESULT +LongAdd( + _In_ LONG lAugend, + _In_ LONG lAddend, + _Out_ _Deref_out_range_(==, lAugend + lAddend) LONG* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG)); + return LongLongToLong(((LONGLONG)lAugend) + ((LONGLONG)lAddend), plResult); +} + +// +// LONG32 Addition +// +#define Long32Add IntAdd + +// +// LONG_PTR Addition +// +#ifdef _WIN64 +#define LongPtrAdd LongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrAdd( + _In_ LONG_PTR lAugend, + _In_ LONG_PTR lAddend, + _Out_ _Deref_out_range_(==, lAugend + lAddend) LONG_PTR* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG_PTR)); + return LongLongToLongPtr(((LONGLONG)lAugend) + ((LONGLONG)lAddend), plResult); +} +#endif + +// +// LONGLONG Addition +// +_Must_inspect_result_ +__inline +HRESULT +LongLongAdd( + _In_ LONGLONG llAugend, + _In_ LONGLONG llAddend, + _Out_ _Deref_out_range_(==, llAugend + llAddend) LONGLONG* pllResult + ) +{ + HRESULT hr; + + // + // Signed integer overflow is undefined and must be avoided. + // Compilers do sometimes propagate undefined. + // Unsigned integer overflow is well defined to silently wraparound + // mod 2^n and may be used without problem. + // + ULONGLONG ullResult = ((ULONGLONG)llAugend) + (ULONGLONG)llAddend; + + // + // Adding positive to negative never overflows. + // If you add two positive numbers, you expect a positive result. + // If you add two negative numbers, you expect a negative result. + // Overflow if inputs have the same sign and output has the other sign. + // Unsigned greater than signed maximum, cast to signed, will be negative. + // + if (((llAugend < 0) == (llAddend < 0)) && + ((llAugend < 0) != (ullResult > (ULONGLONG)LONGLONG_MAX))) + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + else + { + *pllResult = (LONGLONG)ullResult; + hr = S_OK; + } + + return hr; +} + +// +// LONG64 Addition +// +#define Long64Add LongLongAdd + +// +// INT64 Addition +// +#define Int64Add LongLongAdd + +// +// ptrdiff_t Addition +// +#ifdef _WIN64 +#define PtrdiffTAdd LongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +PtrdiffTAdd( + _In_ ptrdiff_t Augend, + _In_ ptrdiff_t Addend, + _Out_ _Deref_out_range_(==, Augend + Addend) ptrdiff_t* pResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(ptrdiff_t)); + return LongLongToPtrdiffT(((LONGLONG)Augend) + ((LONGLONG)Addend), pResult); +} +#endif + +// +// SSIZE_T Addition +// +#ifdef _WIN64 +#define SSIZETAdd LongLongAdd +#else +_Must_inspect_result_ +__inline +HRESULT +SSIZETAdd( + _In_ SSIZE_T Augend, + _In_ SSIZE_T Addend, + _Out_ _Deref_out_range_(==, Augend + Addend) SSIZE_T* pResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(SSIZE_T)); + return LongLongToSSIZET(((LONGLONG)Augend) + ((LONGLONG)Addend), pResult); +} +#endif + + +//============================================================================= +// Signed subtraction functions +//============================================================================= + +// +// INT8 Subtraction +// +_Must_inspect_result_ +__inline +HRESULT +Int8Sub( + _In_ INT8 i8Minuend, + _In_ INT8 i8Subtrahend, + _Out_ _Deref_out_range_(==, i8Minuend - i8Subtrahend) INT8* pi8Result + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(INT8)); + return LongToInt8(((LONG)i8Minuend) - ((LONG)i8Subtrahend), pi8Result); +} + +// +// SHORT Subtraction +// +_Must_inspect_result_ +__inline +HRESULT +ShortSub( + _In_ SHORT sMinuend, + _In_ SHORT sSubtrahend, + _Out_ _Deref_out_range_(==, sMinuend - sSubtrahend) SHORT* psResult + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(SHORT)); + return LongToShort(((LONG)sMinuend) - ((LONG)sSubtrahend), psResult); +} + +// +// INT16 Subtraction +// +#define Int16Sub ShortSub + +// +// INT Subtraction +// +_Must_inspect_result_ +__inline +HRESULT +IntSub( + _In_ INT iMinuend, + _In_ INT iSubtrahend, + _Out_ _Deref_out_range_(==, iMinuend - iSubtrahend) INT* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT)); + return LongLongToInt(((LONGLONG)iMinuend) - ((LONGLONG)iSubtrahend), piResult); +} + +// +// INT32 Subtraction +// +#define Int32Sub IntSub + +// +// INT_PTR Subtraction +// +#ifdef _WIN64 +#define IntPtrSub LongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrSub( + _In_ INT_PTR iMinuend, + _In_ INT_PTR iSubtrahend, + _Out_ _Deref_out_range_(==, iMinuend - iSubtrahend) INT_PTR* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT_PTR)); + return LongLongToIntPtr(((LONGLONG)iMinuend) - ((LONGLONG)iSubtrahend), piResult); +} +#endif + +// +// LONG Subtraction +// +_Must_inspect_result_ +__inline +HRESULT +LongSub( + _In_ LONG lMinuend, + _In_ LONG lSubtrahend, + _Out_ _Deref_out_range_(==, lMinuend - lSubtrahend) LONG* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG)); + return LongLongToLong(((LONGLONG)lMinuend) - ((LONGLONG)lSubtrahend), plResult); +} + +// +// LONG32 Subtraction +// +#define Long32Sub IntSub + +// +// LONG_PTR Subtraction +// +#ifdef _WIN64 +#define LongPtrSub LongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrSub( + _In_ LONG_PTR lMinuend, + _In_ LONG_PTR lSubtrahend, + _Out_ _Deref_out_range_(==, lMinuend - lSubtrahend) LONG_PTR* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG_PTR)); + return LongLongToLongPtr(((LONGLONG)lMinuend) - ((LONGLONG)lSubtrahend), plResult); +} +#endif + +// +// LongLongSub +// +_Must_inspect_result_ +__inline +HRESULT +LongLongSub( + _In_ LONGLONG llMinuend, + _In_ LONGLONG llSubtrahend, + _Out_ _Deref_out_range_(==, llMinuend - llSubtrahend) LONGLONG* pllResult + ) +{ + HRESULT hr; + + // + // Signed integer overflow is undefined and must be avoided. + // Compilers do sometimes propagate undefined. + // Unsigned integer overflow is well defined to silently wraparound + // mod 2^n and may be used without problem. + // + ULONGLONG ullResult = ((ULONGLONG)llMinuend) - (ULONGLONG)llSubtrahend; + + // + // Subtracting a positive number from a positive number never overflows. + // Subtracting a negative number from a negative number never overflows. + // If you subtract a negative number from a positive number, you expect a positive result. + // If you subtract a positive number from a negative number, you expect a negative result. + // Overflow if inputs vary in sign and the output does not have the same sign as the first input. + // Unsigned greater than signed maximum, cast to signed, will be negative. + // + if (((llMinuend < 0) != (llSubtrahend < 0)) && + ((llMinuend < 0) != (ullResult > (ULONGLONG)LONGLONG_MAX))) + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + else + { + *pllResult = (LONGLONG)ullResult; + hr = S_OK; + } + + return hr; +} + +// +// LONG64 Subtraction +// +#define Long64Sub LongLongSub + +// +// INT64 Subtraction +// +#define Int64Sub LongLongSub + +// +// ptrdiff_t Subtraction +// +#ifdef _WIN64 +#define PtrdiffTSub LongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +PtrdiffTSub( + _In_ ptrdiff_t Minuend, + _In_ ptrdiff_t Subtrahend, + _Out_ _Deref_out_range_(==, Minuend - Subtrahend) ptrdiff_t* pResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(ptrdiff_t)); + return LongLongToPtrdiffT(((LONGLONG)Minuend) - ((LONGLONG)Subtrahend), pResult); +} +#endif + +// +// SSIZE_T Subtraction +// +#ifdef _WIN64 +#define SSIZETSub LongLongSub +#else +_Must_inspect_result_ +__inline +HRESULT +SSIZETSub( + _In_ SSIZE_T Minuend, + _In_ SSIZE_T Subtrahend, + _Out_ _Deref_out_range_(==, Minuend - Subtrahend) SSIZE_T* pResult) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(SSIZE_T)); + return LongLongToSSIZET(((LONGLONG)Minuend) - ((LONGLONG)Subtrahend), pResult); +} +#endif + + +//============================================================================= +// Signed multiplication functions +//============================================================================= + +// +// INT8 multiplication +// +_Must_inspect_result_ +__inline +HRESULT +Int8Mult( + _In_ INT8 i8Multiplicand, + _In_ INT8 i8Multiplier, + _Out_ _Deref_out_range_(==, i8Multiplicand * i8Multiplier) INT8* pi8Result + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(INT8)); + return LongToInt8(((LONG)i8Multiplier) * ((LONG)i8Multiplicand), pi8Result); +} + +// +// SHORT multiplication +// +_Must_inspect_result_ +__inline +HRESULT +ShortMult( + _In_ SHORT sMultiplicand, + _In_ SHORT sMultiplier, + _Out_ _Deref_out_range_(==, sMultiplicand * sMultiplier) SHORT* psResult + ) +{ + C_ASSERT(sizeof(LONG) > sizeof(SHORT)); + return LongToShort(((LONG)sMultiplicand) * ((LONG)sMultiplier), psResult); +} + +// +// INT16 multiplication +// +#define Int16Mult ShortMult + +// +// INT multiplication +// +_Must_inspect_result_ +__inline +HRESULT +IntMult( + _In_ INT iMultiplicand, + _In_ INT iMultiplier, + _Out_ _Deref_out_range_(==, iMultiplicand * iMultiplier) INT* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT)); + return LongLongToInt(((LONGLONG)iMultiplicand) * ((LONGLONG)iMultiplier), piResult); +} + +// +// INT32 multiplication +// +#define Int32Mult IntMult + +// +// INT_PTR multiplication +// +#ifdef _WIN64 +#define IntPtrMult LongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +IntPtrMult( + _In_ INT_PTR iMultiplicand, + _In_ INT_PTR iMultiplier, + _Out_ _Deref_out_range_(==, iMultiplicand * iMultiplier) INT_PTR* piResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(INT_PTR)); + return LongLongToIntPtr(((LONGLONG)iMultiplicand) * ((LONGLONG)iMultiplier), piResult); +} +#endif + +// +// LONG multiplication +// +_Must_inspect_result_ +__inline +HRESULT +LongMult( + _In_ LONG lMultiplicand, + _In_ LONG lMultiplier, + _Out_ _Deref_out_range_(==, lMultiplicand * lMultiplier) LONG* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG)); + return LongLongToLong(((LONGLONG)lMultiplicand) * ((LONGLONG)lMultiplier), plResult); +} + +// +// LONG32 multiplication +// +#define Long32Mult IntMult + +// +// LONG_PTR multiplication +// +#ifdef _WIN64 +#define LongPtrMult LongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +LongPtrMult( + _In_ LONG_PTR lMultiplicand, + _In_ LONG_PTR lMultiplier, + _Out_ _Deref_out_range_(==, lMultiplicand * lMultiplier) LONG_PTR* plResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(LONG_PTR)); + return LongLongToLongPtr(((LONGLONG)lMultiplicand) * ((LONGLONG)lMultiplier), plResult); +} +#endif + +// +// LONGLONG multiplication +// +_Must_inspect_result_ +__inline +HRESULT +LongLongMult( + _In_ LONGLONG llMultiplicand, + _In_ LONGLONG llMultiplier, + _Out_ _Deref_out_range_(==, llMultiplicand * llMultiplier) LONGLONG* pllResult + ) +{ + HRESULT hr; + +#if defined(_USE_INTRINSIC_MULTIPLY128) + LONGLONG llResultHigh; + LONGLONG llResultLow; + + llResultLow = __Multiply128(llMultiplicand, llMultiplier, &llResultHigh); + + if (((llResultLow < 0) && (llResultHigh != -1)) || + ((llResultLow >= 0) && (llResultHigh != 0))) + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + else + { + *pllResult = llResultLow; + hr = S_OK; + } +#else // _USE_INTRINSIC_MULTIPLY128 + // + // Split into sign and magnitude, do unsigned operation, apply sign. + // + + ULONGLONG ullMultiplicand; + ULONGLONG ullMultiplier; + ULONGLONG ullResult; + const ULONGLONG LONGLONG_MIN_MAGNITUDE = ((((ULONGLONG) - (LONGLONG_MIN + 1))) + 1); + + if (llMultiplicand < 0) + { + // + // Avoid negating the most negative number. + // + ullMultiplicand = ((ULONGLONG)(- (llMultiplicand + 1))) + 1; + } + else + { + ullMultiplicand = (ULONGLONG)llMultiplicand; + } + + if (llMultiplier < 0) + { + // + // Avoid negating the most negative number. + // + ullMultiplier = ((ULONGLONG)(- (llMultiplier + 1))) + 1; + } + else + { + ullMultiplier = (ULONGLONG)llMultiplier; + } + + hr = ULongLongMult(ullMultiplicand, ullMultiplier, &ullResult); + if (SUCCEEDED(hr)) + { + if ((llMultiplicand < 0) != (llMultiplier < 0)) + { + if (ullResult > LONGLONG_MIN_MAGNITUDE) + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + else + { + *pllResult = - ((LONGLONG)ullResult); + } + } + else + { + if (ullResult > LONGLONG_MAX) + { + *pllResult = LONGLONG_ERROR; + hr = INTSAFE_E_ARITHMETIC_OVERFLOW; + } + else + { + *pllResult = (LONGLONG)ullResult; + } + } + } + else + { + *pllResult = LONGLONG_ERROR; + } +#endif // _USE_INTRINSIC_MULTIPLY128 + + return hr; +} + +// +// LONG64 multiplication +// +#define Long64Mult LongLongMult + +// +// INT64 multiplication +// +#define Int64Mult LongLongMult + +// +// ptrdiff_t multiplication +// +#ifdef _WIN64 +#define PtrdiffTMult LongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +PtrdiffTMult( + _In_ ptrdiff_t Multiplicand, + _In_ ptrdiff_t Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) ptrdiff_t* pResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(ptrdiff_t)); + return LongLongToPtrdiffT(((LONGLONG)Multiplicand) * ((LONGLONG)Multiplier), pResult); +} +#endif + +// +// SSIZE_T multiplication +// +#ifdef _WIN64 +#define SSIZETMult LongLongMult +#else +_Must_inspect_result_ +__inline +HRESULT +SSIZETMult( + _In_ SSIZE_T Multiplicand, + _In_ SSIZE_T Multiplier, + _Out_ _Deref_out_range_(==, Multiplicand * Multiplier) SSIZE_T* pResult + ) +{ + C_ASSERT(sizeof(LONGLONG) > sizeof(SSIZE_T)); + return LongLongToSSIZET(((LONGLONG)Multiplicand) * ((LONGLONG)Multiplier), pResult); +} +#endif + +#endif // ENABLE_INTSAFE_SIGNED_FUNCTIONS + +// +// Macros that are no longer used in this header but which clients may +// depend on being defined here. +// +#ifndef LOWORD +#define LOWORD(l) ((WORD)(((DWORD_PTR)(l)) & 0xffff)) +#endif +#ifndef HIWORD +#define HIWORD(l) ((WORD)((((DWORD_PTR)(l)) >> 16) & 0xffff)) +#endif +#ifndef LODWORD +#define LODWORD(_qw) ((DWORD)(_qw)) +#endif +#ifndef HIDWORD +#define HIDWORD(_qw) ((DWORD)(((_qw) >> 32) & 0xffffffff)) +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _INTSAFE_H_INCLUDED_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ioevent.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ioevent.h new file mode 100644 index 0000000000000000000000000000000000000000..2eca2abb1889f000a2a438a50d905d0a5baf27a8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ioevent.h @@ -0,0 +1,309 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ioevent.h + +Abstract: + + This module contains the GUIDS and event structures for io system + initiated events. These events are reported in kernel mode and are + available to both user mode and kernel mode clients. + + +--*/ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// Label change event. This event is signalled upon successful completion +// of a label change. There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_CHANGE, 0x7373654aL, 0x812a, 0x11d0, 0xbe, 0xc7, 0x08, 0x00, 0x2b, 0xe2, 0x09, 0x2f ); + +// +// Volume dismount event. This event is signalled when an attempt is made to +// dismount a volume. There is no additional data. Note that this will not +// necessarily be preceded by a GUID_IO_VOLUME_LOCK notification. +// + +DEFINE_GUID( GUID_IO_VOLUME_DISMOUNT, 0xd16a55e8L, 0x1059, 0x11d2, 0x8f, 0xfd, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + +// +// Volume dismount failed event. This event is signalled when a volume dismount fails. +// There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_DISMOUNT_FAILED, 0xe3c5b178L, 0x105d, 0x11d2, 0x8f, 0xfd, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + +// +// Volume mount event. This event is signalled when a volume mount occurs. +// There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_MOUNT, 0xb5804878L, 0x1a96, 0x11d2, 0x8f, 0xfd, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + +typedef struct _DEVICE_EVENT_MOUNT { + ULONG Version; + ULONG Flags; + ULONG FileSystemNameLength; + ULONG FileSystemNameOffset; +} DEVICE_EVENT_MOUNT, *PDEVICE_EVENT_MOUNT; + +// +// Volume lock event. This event is signalled when an attempt is made to +// lock a volume. There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_LOCK, 0x50708874L, 0xc9af, 0x11d1, 0x8f, 0xef, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + +// +// Volume lock failed event. This event is signalled when an attempt is made to +// lock a volume, but it fails. There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_LOCK_FAILED, 0xae2eed10L, 0x0ba8, 0x11d2, 0x8f, 0xfb, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + + +// +// Volume unlock event. This event is signalled when an attempt is made to +// unlock a volume. There is no additional data. +// + +DEFINE_GUID( GUID_IO_VOLUME_UNLOCK, 0x9a8c3d68L, 0xd0cb, 0x11d1, 0x8f, 0xef, 0x00, 0xa0, 0xc9, 0xa0, 0x6d, 0x32 ); + + +// +// Volume name change. This event is signalled when the list of persistent +// names (like drive letters) for a volume changes. There is no additional +// data. +// + +DEFINE_GUID( GUID_IO_VOLUME_NAME_CHANGE, 0x2de97f83, 0x4c06, 0x11d2, 0xa5, 0x32, 0x0, 0x60, 0x97, 0x13, 0x5, 0x5a); + + +// +// Volume needs chkdsk event. Sent when a file system detects corruption. +// + +DEFINE_GUID( GUID_IO_VOLUME_NEED_CHKDSK, 0x799a0960, 0x0a0b, 0x4e03, 0xad, 0x88, 0x2f, 0xa7, 0xc6, 0xce, 0x74, 0x8a); + + +// +// WORK near full event. Send when a wolume with write-once-read-many characteristics +// (e.g. CD-R) is becoming full (on these media modifying existing file data +// consumes space) so that the user can be notified. +// + +DEFINE_GUID( GUID_IO_VOLUME_WORM_NEAR_FULL, 0xf3bfff82, 0xf3de, 0x48d2, 0xaf, 0x95, 0x45, 0x7f, 0x80, 0xb7, 0x63, 0xf2); + + +// +// Media wearing out. Sent when a file sytem determines that the error rate +// on a volume is too high, or sparing (defect replacement) space is almost +// exhausted. +// + +DEFINE_GUID( GUID_IO_VOLUME_WEARING_OUT, 0x873113ca, 0x1486, 0x4508, 0x82, 0xac, 0xc3, 0xb2, 0xe5, 0x29, 0x7a, 0xaa); + + +// +// Volume force closed event. Sent when a volume has been finalised and made +// read-only by the filesystem due to (e,g.) WORM type volume full, or sparing +// (defect replacement) space has been exhausted. +// + +DEFINE_GUID( GUID_IO_VOLUME_FORCE_CLOSED, 0x411ad84f, 0x433e, 0x4dc2, 0xa5, 0xae, 0x4a, 0x2d, 0x1a, 0x2d, 0xe6, 0x54); + + +// +// Notify make compatible function available. Sent after the user removes a disc +// which may not be readable in all drives in it's current state (e.g. CD-R with +// open session). +// + +DEFINE_GUID( GUID_IO_VOLUME_INFO_MAKE_COMPAT, 0x3ab9a0d2, 0xef80, 0x45cf, 0x8c, 0xdc, 0xcb, 0xe0, 0x2a, 0x21, 0x29, 0x06); + + +// +// Notify that the drive is preparing the disc for eject (e.g. stopping a background format). +// + +DEFINE_GUID( GUID_IO_VOLUME_PREPARING_EJECT, 0xc79eb16e, 0x0dac, 0x4e7a, 0xa8, 0x6c, 0xb2, 0x5c, 0xee, 0xaa, 0x88, 0xf6); + + +// +// Notify that a background format has been initiated on the disc. +// + +DEFINE_GUID( GUID_IO_VOLUME_BACKGROUND_FORMAT, 0xa2e5fc86, 0xd5cd, 0x4038, 0xb2, 0xe3, 0x44, 0x45, 0x6, 0x5c, 0x23, 0x77); + +// +// Volume physical configuration change. This event is signalled when the +// physical makeup or current physical state of the volume changes. +// + +DEFINE_GUID( GUID_IO_VOLUME_PHYSICAL_CONFIGURATION_CHANGE, 0x2de97f84, 0x4c06, 0x11d2, 0xa5, 0x32, 0x0, 0x60, 0x97, 0x13, 0x5, 0x5a); + +// +// Volume being deleted. This event is signalled when the +// volume is in the process of being deleted. +// + +DEFINE_GUID( GUID_IO_VOLUME_PREPARE_DELETE, 0xac0707fb, 0x4a9a, 0x4c81, 0x9e, 0x2e, 0x38, 0x5b, 0x79, 0xa8, 0xfd, 0x28); + +// +// Volume unique ID change. This event is signalled when the +// unique ID of the volume changes. +// + +DEFINE_GUID( GUID_IO_VOLUME_UNIQUE_ID_CHANGE, 0xaf39da42, 0x6622, 0x41f5, 0x97, 0xb, 0x13, 0x9d, 0x9, 0x2f, 0xa3, 0xd9); + +// +// Volume BitLocker Drive Encryption status change. +// This event is signalled when BDE is enabled / disabled, or when encryption +// begins, ends, pauses or resumes. +// + +DEFINE_GUID( GUID_IO_VOLUME_FVE_STATUS_CHANGE, 0x062998b2, 0xee1f, 0x4b6a, 0xb8, 0x57, 0xe7, 0x6c, 0xbb, 0xe9, 0xa6, 0xda); + + +// +// Volume device interface. This is a device interface GUID that appears +// when the device object associated with a volume is created and disappears +// when the device object associated with the volume is destroyed. +// + +DEFINE_GUID( GUID_IO_VOLUME_DEVICE_INTERFACE, 0x53f5630d, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); + +// +// The size of the filesystem on the volume has changed. +// + +DEFINE_GUID( GUID_IO_VOLUME_CHANGE_SIZE, 0x3a1625be, 0xad03, 0x49f1, 0x8e, 0xf8, 0x6b, 0xba, 0xc1, 0x82, 0xd1, 0xfd); + +// +// Sent when the removable media is changed (added, removed) from a device +// (such as a CDROM, tape, changer, etc). +// +// The additional data is a DWORD representing the data event. +// + +DEFINE_GUID( GUID_IO_MEDIA_ARRIVAL, 0xd07433c0, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); +DEFINE_GUID( GUID_IO_MEDIA_REMOVAL, 0xd07433c1, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); + +// +// Sent when the CDROM device locked/unlocked for exclusive access +// + +DEFINE_GUID(GUID_IO_CDROM_EXCLUSIVE_LOCK, 0xbc56c139, 0x7a10, 0x47ee, 0xa2, 0x94, 0x4c, 0x6a, 0x38, 0xf0, 0x14, 0x9a); +DEFINE_GUID(GUID_IO_CDROM_EXCLUSIVE_UNLOCK, 0xa3b6d27d, 0x5e35, 0x4885, 0x81, 0xe5, 0xee, 0x18, 0xc0, 0xe, 0xd7, 0x79); + +// +// Sent when the media is returning that it is not ready right now, but will +// be ready soon. This can be because the drive has spun down to save power +// or because new media has been inserted but is not ready for access yet. +// + +DEFINE_GUID( GUID_IO_DEVICE_BECOMING_READY, 0xd07433f0, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); + +typedef struct _DEVICE_EVENT_BECOMING_READY { + ULONG Version; + ULONG Reason; + ULONG Estimated100msToReady; +} DEVICE_EVENT_BECOMING_READY, *PDEVICE_EVENT_BECOMING_READY; + +// +// Sent when the user presses the eject button on the front of the drive, +// or when other buttons on the front are pressed via GESN command polling +// (GESN support to be added) +// + +DEFINE_GUID( GUID_IO_DEVICE_EXTERNAL_REQUEST, 0xd07433d0, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); +DEFINE_GUID( GUID_IO_MEDIA_EJECT_REQUEST, 0xd07433d1, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); + +typedef struct _DEVICE_EVENT_EXTERNAL_REQUEST { + ULONG Version; + ULONG DeviceClass; // 0 == MMC Storage Devices + USHORT ButtonStatus; // 1 == down, 2 == up + USHORT Request; + LARGE_INTEGER SystemTime; // for time-related info +} DEVICE_EVENT_EXTERNAL_REQUEST, *PDEVICE_EVENT_EXTERNAL_REQUEST; + +// +// Sent when a tape drive requires cleaning +// +DEFINE_GUID(GUID_IO_DRIVE_REQUIRES_CLEANING, 0x7207877c, 0x90ed, 0x44e5, 0xa0, 0x0, 0x81, 0x42, 0x8d, 0x4c, 0x79, 0xbb); + +// +// Sent when a tape is erased +// +DEFINE_GUID(GUID_IO_TAPE_ERASE, 0x852d11eb, 0x4bb8, 0x4507, 0x9d, 0x9b, 0x41, 0x7c, 0xc2, 0xb1, 0xb4, 0x38); + +typedef struct _DEVICE_EVENT_GENERIC_DATA { + ULONG EventNumber; +} DEVICE_EVENT_GENERIC_DATA, *PDEVICE_EVENT_GENERIC_DATA; + + +// +// Represents any asynchronous notification coming from a device driver whose +// notification protocol is RBC +// Additional data is provided + +DEFINE_GUID( GUID_DEVICE_EVENT_RBC, 0xd0744792, 0xa98e, 0x11d2, 0x91, 0x7a, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); + +typedef struct _DEVICE_EVENT_RBC_DATA { + ULONG EventNumber; + UCHAR SenseQualifier; + UCHAR SenseCode; + UCHAR SenseKey; + UCHAR Reserved; + ULONG Information; +} DEVICE_EVENT_RBC_DATA, *PDEVICE_EVENT_RBC_DATA; + +// +// A clone of this disk has just arrived in the system. +// + +DEFINE_GUID( GUID_IO_DISK_CLONE_ARRIVAL, 0x6a61885b, 0x7c39, 0x43dd, 0x9b, 0x56, 0xb8, 0xac, 0x22, 0xa5, 0x49, 0xaa); + +typedef struct _GUID_IO_DISK_CLONE_ARRIVAL_INFORMATION { + ULONG DiskNumber; // The disk number of the new disk arriving in the system. +} GUID_IO_DISK_CLONE_ARRIVAL_INFORMATION, *PGUID_IO_DISK_CLONE_ARRIVAL_INFORMATION; + +// +// The disk layout has changed +// + +DEFINE_GUID( GUID_IO_DISK_LAYOUT_CHANGE, 0x11dff54c, 0x8469, 0x41f9, 0xb3, 0xde, 0xef, 0x83, 0x64, 0x87, 0xc5, 0x4a); + +// +// This notification may be sent by storage drivers to +// alert other components of changes in the health status +// of a device. A component that registers for this +// custom PNP notification should query for the +// StorageDeviceManagementStatus property to learn +// more about the device's health status. +// + +// {0F1BD644-3916-49C5-B063-991940118FB2} +DEFINE_GUID( GUID_IO_DISK_HEALTH_NOTIFICATION, 0xf1bd644, 0x3916, 0x49c5, 0xb0, 0x63, 0x99, 0x19, 0x40, 0x11, 0x8f, 0xb2); + +typedef struct _DISK_HEALTH_NOTIFICATION_DATA { + + // + // The GUID of the device reporting the health change. + // This is the same GUID returned by IOCTL_STORAGE_GET_DEVICE_NUMBER_EX. + // + GUID DeviceGuid; + +} DISK_HEALTH_NOTIFICATION_DATA, *PDISK_HEALTH_NOTIFICATION_DATA; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ip2string.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ip2string.h new file mode 100644 index 0000000000000000000000000000000000000000..7f23bcd32402a816f4fb1ef23771cc798c7e31d9 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ip2string.h @@ -0,0 +1,281 @@ +/*++ BUILD Version: 0006 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ip2string.h + +Abstract: + + Include file for NT runtime routines that are callable by both + kernel mode code in the executive and user mode code in various + NT subsystems. + + This module contains definitions that are exposed in kit headers + for use by external developers. Splited from ntrtl_x.h + +Author: + + Zhihui Chen (stevewo) 03-May-2006 + +Environment: + + These routines are dynamically linked in the caller's executable and + are callable in either kernel mode or user mode. + + +--*/ + +#ifndef __IP2STRING__ +#define __IP2STRING__ +#pragma once +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Some simple Rtl routines for IP address <-> string literal conversion +// ... and Ethernet +// + +struct in_addr; +struct in6_addr; +union _DL_EUI48; +typedef union _DL_EUI48 DL_EUI48, *PDL_EUI48; + +NTSYSAPI +PSTR +NTAPI +RtlIpv4AddressToStringA ( + _In_ const struct in_addr *Addr, + _Out_writes_(16) PSTR S + ); + +NTSYSAPI +PSTR +NTAPI +RtlIpv6AddressToStringA ( + _In_ const struct in6_addr *Addr, + _Out_writes_(46) PSTR S + ); + +NTSYSAPI +PSTR +NTAPI +RtlEthernetAddressToStringA ( + _In_ const DL_EUI48 *Addr, + _Out_writes_(18) PSTR S + ); + +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4AddressToStringExA( + _In_ const struct in_addr *Address, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6AddressToStringExA( + _In_ const struct in6_addr *Address, + _In_ ULONG ScopeId, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +PWSTR +NTAPI +RtlIpv4AddressToStringW ( + _In_ const struct in_addr *Addr, + _Out_writes_(16) PWSTR S + ); + +NTSYSAPI +PWSTR +NTAPI +RtlIpv6AddressToStringW ( + _In_ const struct in6_addr *Addr, + _Out_writes_(46) PWSTR S + ); + +NTSYSAPI +PWSTR +NTAPI +RtlEthernetAddressToStringW ( + _In_ const DL_EUI48 *Addr, + _Out_writes_(18) PWSTR S + ); + +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4AddressToStringExW( + _In_ const struct in_addr *Address, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PWSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6AddressToStringExW( + _In_ const struct in6_addr *Address, + _In_ ULONG ScopeId, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PWSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4StringToAddressA ( + _In_ PCSTR S, + _In_ BOOLEAN Strict, + _Out_ PCSTR *Terminator, + _Out_ struct in_addr *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6StringToAddressA ( + _In_ PCSTR S, + _Out_ PCSTR *Terminator, + _Out_ struct in6_addr *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlEthernetStringToAddressA ( + _In_ PCSTR S, + _Out_ PCSTR *Terminator, + _Out_ DL_EUI48 *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4StringToAddressExA ( + _In_ PCSTR AddressString, + _In_ BOOLEAN Strict, + _Out_ struct in_addr *Address, + _Out_ PUSHORT Port + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6StringToAddressExA ( + _In_ PCSTR AddressString, + _Out_ struct in6_addr *Address, + _Out_ PULONG ScopeId, + _Out_ PUSHORT Port + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4StringToAddressW ( + _In_ PCWSTR S, + _In_ BOOLEAN Strict, + _Out_ LPCWSTR *Terminator, + _Out_ struct in_addr *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6StringToAddressW ( + _In_ PCWSTR S, + _Out_ PCWSTR *Terminator, + _Out_ struct in6_addr *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlEthernetStringToAddressW ( + _In_ PCWSTR S, + _Out_ LPCWSTR *Terminator, + _Out_ DL_EUI48 *Addr + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv4StringToAddressExW ( + _In_ PCWSTR AddressString, + _In_ BOOLEAN Strict, + _Out_ struct in_addr *Address, + _Out_ PUSHORT Port + ); + +_Must_inspect_result_ +NTSYSAPI +NTSTATUS +NTAPI +RtlIpv6StringToAddressExW ( + _In_ PCWSTR AddressString, + _Out_ struct in6_addr *Address, + _Out_ PULONG ScopeId, + _Out_ PUSHORT Port + ); + +#ifdef UNICODE +#define RtlIpv4AddressToString RtlIpv4AddressToStringW +#define RtlIpv6AddressToString RtlIpv6AddressToStringW +#define RtlEthernetAddressToString RtlEthernetAddressToStringW +#define RtlIpv4StringToAddress RtlIpv4StringToAddressW +#define RtlIpv6StringToAddress RtlIpv6StringToAddressW +#define RtlEthernetStringToAddress RtlEthernetStringToAddressW +#define RtlIpv6StringToAddressEx RtlIpv6StringToAddressExW +#define RtlIpv4AddressToStringEx RtlIpv4AddressToStringExW +#define RtlIpv6AddressToStringEx RtlIpv6AddressToStringExW +#define RtlIpv4StringToAddressEx RtlIpv4StringToAddressExW +#else +#define RtlIpv4AddressToString RtlIpv4AddressToStringA +#define RtlIpv6AddressToString RtlIpv6AddressToStringA +#define RtlEthernetAddressToString RtlEthernetAddressToStringA +#define RtlIpv4StringToAddress RtlIpv4StringToAddressA +#define RtlIpv6StringToAddress RtlIpv6StringToAddressA +#define RtlEthernetStringToAddress RtlEthernetStringToAddressA +#define RtlIpv6StringToAddressEx RtlIpv6StringToAddressExA +#define RtlIpv4AddressToStringEx RtlIpv4AddressToStringExA +#define RtlIpv6AddressToStringEx RtlIpv6AddressToStringExA +#define RtlIpv4StringToAddressEx RtlIpv4StringToAddressExA +#endif // UNICODE + +#ifdef __cplusplus +} // extern "C" +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // __IP2STRING__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipifcons.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipifcons.h new file mode 100644 index 0000000000000000000000000000000000000000..42474e2492b3d42935b45993fa4b987ba7e4661b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipifcons.h @@ -0,0 +1,359 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ipifcons.h + +Abstract: + Constants needed for the Interface Object + +--*/ + +#ifndef __IPIFCONS_H__ +#define __IPIFCONS_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +#ifdef __cplusplus +extern "C" { +#endif + +////////////////////////////////////////////////////////////////////////////// +// // +// Media types // +// // +// These are enumerated values of the ifType object defined in MIB-II's // +// ifTable. They are registered with IANA which publishes this list // +// periodically, in either the Assigned Numbers RFC, or some derivative // +// of it specific to Internet Network Management number assignments. // +// See ftp://ftp.isi.edu/mib/ianaiftype.mib // +// // +////////////////////////////////////////////////////////////////////////////// + +#define MIN_IF_TYPE 1 + +#define IF_TYPE_OTHER 1 // None of the below +#define IF_TYPE_REGULAR_1822 2 +#define IF_TYPE_HDH_1822 3 +#define IF_TYPE_DDN_X25 4 +#define IF_TYPE_RFC877_X25 5 +#define IF_TYPE_ETHERNET_CSMACD 6 +#define IF_TYPE_IS088023_CSMACD 7 +#define IF_TYPE_ISO88024_TOKENBUS 8 +#define IF_TYPE_ISO88025_TOKENRING 9 +#define IF_TYPE_ISO88026_MAN 10 +#define IF_TYPE_STARLAN 11 +#define IF_TYPE_PROTEON_10MBIT 12 +#define IF_TYPE_PROTEON_80MBIT 13 +#define IF_TYPE_HYPERCHANNEL 14 +#define IF_TYPE_FDDI 15 +#define IF_TYPE_LAP_B 16 +#define IF_TYPE_SDLC 17 +#define IF_TYPE_DS1 18 // DS1-MIB +#define IF_TYPE_E1 19 // Obsolete; see DS1-MIB +#define IF_TYPE_BASIC_ISDN 20 +#define IF_TYPE_PRIMARY_ISDN 21 +#define IF_TYPE_PROP_POINT2POINT_SERIAL 22 // proprietary serial +#define IF_TYPE_PPP 23 +#define IF_TYPE_SOFTWARE_LOOPBACK 24 +#define IF_TYPE_EON 25 // CLNP over IP +#define IF_TYPE_ETHERNET_3MBIT 26 +#define IF_TYPE_NSIP 27 // XNS over IP +#define IF_TYPE_SLIP 28 // Generic Slip +#define IF_TYPE_ULTRA 29 // ULTRA Technologies +#define IF_TYPE_DS3 30 // DS3-MIB +#define IF_TYPE_SIP 31 // SMDS, coffee +#define IF_TYPE_FRAMERELAY 32 // DTE only +#define IF_TYPE_RS232 33 +#define IF_TYPE_PARA 34 // Parallel port +#define IF_TYPE_ARCNET 35 +#define IF_TYPE_ARCNET_PLUS 36 +#define IF_TYPE_ATM 37 // ATM cells +#define IF_TYPE_MIO_X25 38 +#define IF_TYPE_SONET 39 // SONET or SDH +#define IF_TYPE_X25_PLE 40 +#define IF_TYPE_ISO88022_LLC 41 +#define IF_TYPE_LOCALTALK 42 +#define IF_TYPE_SMDS_DXI 43 +#define IF_TYPE_FRAMERELAY_SERVICE 44 // FRNETSERV-MIB +#define IF_TYPE_V35 45 +#define IF_TYPE_HSSI 46 +#define IF_TYPE_HIPPI 47 +#define IF_TYPE_MODEM 48 // Generic Modem +#define IF_TYPE_AAL5 49 // AAL5 over ATM +#define IF_TYPE_SONET_PATH 50 +#define IF_TYPE_SONET_VT 51 +#define IF_TYPE_SMDS_ICIP 52 // SMDS InterCarrier Interface +#define IF_TYPE_PROP_VIRTUAL 53 // Proprietary virtual/internal +#define IF_TYPE_PROP_MULTIPLEXOR 54 // Proprietary multiplexing +#define IF_TYPE_IEEE80212 55 // 100BaseVG +#define IF_TYPE_FIBRECHANNEL 56 +#define IF_TYPE_HIPPIINTERFACE 57 +#define IF_TYPE_FRAMERELAY_INTERCONNECT 58 // Obsolete, use 32 or 44 +#define IF_TYPE_AFLANE_8023 59 // ATM Emulated LAN for 802.3 +#define IF_TYPE_AFLANE_8025 60 // ATM Emulated LAN for 802.5 +#define IF_TYPE_CCTEMUL 61 // ATM Emulated circuit +#define IF_TYPE_FASTETHER 62 // Fast Ethernet (100BaseT) +#define IF_TYPE_ISDN 63 // ISDN and X.25 +#define IF_TYPE_V11 64 // CCITT V.11/X.21 +#define IF_TYPE_V36 65 // CCITT V.36 +#define IF_TYPE_G703_64K 66 // CCITT G703 at 64Kbps +#define IF_TYPE_G703_2MB 67 // Obsolete; see DS1-MIB +#define IF_TYPE_QLLC 68 // SNA QLLC +#define IF_TYPE_FASTETHER_FX 69 // Fast Ethernet (100BaseFX) +#define IF_TYPE_CHANNEL 70 +#define IF_TYPE_IEEE80211 71 // Radio spread spectrum +#define IF_TYPE_IBM370PARCHAN 72 // IBM System 360/370 OEMI Channel +#define IF_TYPE_ESCON 73 // IBM Enterprise Systems Connection +#define IF_TYPE_DLSW 74 // Data Link Switching +#define IF_TYPE_ISDN_S 75 // ISDN S/T interface +#define IF_TYPE_ISDN_U 76 // ISDN U interface +#define IF_TYPE_LAP_D 77 // Link Access Protocol D +#define IF_TYPE_IPSWITCH 78 // IP Switching Objects +#define IF_TYPE_RSRB 79 // Remote Source Route Bridging +#define IF_TYPE_ATM_LOGICAL 80 // ATM Logical Port +#define IF_TYPE_DS0 81 // Digital Signal Level 0 +#define IF_TYPE_DS0_BUNDLE 82 // Group of ds0s on the same ds1 +#define IF_TYPE_BSC 83 // Bisynchronous Protocol +#define IF_TYPE_ASYNC 84 // Asynchronous Protocol +#define IF_TYPE_CNR 85 // Combat Net Radio +#define IF_TYPE_ISO88025R_DTR 86 // ISO 802.5r DTR +#define IF_TYPE_EPLRS 87 // Ext Pos Loc Report Sys +#define IF_TYPE_ARAP 88 // Appletalk Remote Access Protocol +#define IF_TYPE_PROP_CNLS 89 // Proprietary Connectionless Proto +#define IF_TYPE_HOSTPAD 90 // CCITT-ITU X.29 PAD Protocol +#define IF_TYPE_TERMPAD 91 // CCITT-ITU X.3 PAD Facility +#define IF_TYPE_FRAMERELAY_MPI 92 // Multiproto Interconnect over FR +#define IF_TYPE_X213 93 // CCITT-ITU X213 +#define IF_TYPE_ADSL 94 // Asymmetric Digital Subscrbr Loop +#define IF_TYPE_RADSL 95 // Rate-Adapt Digital Subscrbr Loop +#define IF_TYPE_SDSL 96 // Symmetric Digital Subscriber Loop +#define IF_TYPE_VDSL 97 // Very H-Speed Digital Subscrb Loop +#define IF_TYPE_ISO88025_CRFPRINT 98 // ISO 802.5 CRFP +#define IF_TYPE_MYRINET 99 // Myricom Myrinet +#define IF_TYPE_VOICE_EM 100 // Voice recEive and transMit +#define IF_TYPE_VOICE_FXO 101 // Voice Foreign Exchange Office +#define IF_TYPE_VOICE_FXS 102 // Voice Foreign Exchange Station +#define IF_TYPE_VOICE_ENCAP 103 // Voice encapsulation +#define IF_TYPE_VOICE_OVERIP 104 // Voice over IP encapsulation +#define IF_TYPE_ATM_DXI 105 // ATM DXI +#define IF_TYPE_ATM_FUNI 106 // ATM FUNI +#define IF_TYPE_ATM_IMA 107 // ATM IMA +#define IF_TYPE_PPPMULTILINKBUNDLE 108 // PPP Multilink Bundle +#define IF_TYPE_IPOVER_CDLC 109 // IBM ipOverCdlc +#define IF_TYPE_IPOVER_CLAW 110 // IBM Common Link Access to Workstn +#define IF_TYPE_STACKTOSTACK 111 // IBM stackToStack +#define IF_TYPE_VIRTUALIPADDRESS 112 // IBM VIPA +#define IF_TYPE_MPC 113 // IBM multi-proto channel support +#define IF_TYPE_IPOVER_ATM 114 // IBM ipOverAtm +#define IF_TYPE_ISO88025_FIBER 115 // ISO 802.5j Fiber Token Ring +#define IF_TYPE_TDLC 116 // IBM twinaxial data link control +#define IF_TYPE_GIGABITETHERNET 117 +#define IF_TYPE_HDLC 118 +#define IF_TYPE_LAP_F 119 +#define IF_TYPE_V37 120 +#define IF_TYPE_X25_MLP 121 // Multi-Link Protocol +#define IF_TYPE_X25_HUNTGROUP 122 // X.25 Hunt Group +#define IF_TYPE_TRANSPHDLC 123 +#define IF_TYPE_INTERLEAVE 124 // Interleave channel +#define IF_TYPE_FAST 125 // Fast channel +#define IF_TYPE_IP 126 // IP (for APPN HPR in IP networks) +#define IF_TYPE_DOCSCABLE_MACLAYER 127 // CATV Mac Layer +#define IF_TYPE_DOCSCABLE_DOWNSTREAM 128 // CATV Downstream interface +#define IF_TYPE_DOCSCABLE_UPSTREAM 129 // CATV Upstream interface +#define IF_TYPE_A12MPPSWITCH 130 // Avalon Parallel Processor +#define IF_TYPE_TUNNEL 131 // Encapsulation interface +#define IF_TYPE_COFFEE 132 // Coffee pot +#define IF_TYPE_CES 133 // Circuit Emulation Service +#define IF_TYPE_ATM_SUBINTERFACE 134 // ATM Sub Interface +#define IF_TYPE_L2_VLAN 135 // Layer 2 Virtual LAN using 802.1Q +#define IF_TYPE_L3_IPVLAN 136 // Layer 3 Virtual LAN using IP +#define IF_TYPE_L3_IPXVLAN 137 // Layer 3 Virtual LAN using IPX +#define IF_TYPE_DIGITALPOWERLINE 138 // IP over Power Lines +#define IF_TYPE_MEDIAMAILOVERIP 139 // Multimedia Mail over IP +#define IF_TYPE_DTM 140 // Dynamic syncronous Transfer Mode +#define IF_TYPE_DCN 141 // Data Communications Network +#define IF_TYPE_IPFORWARD 142 // IP Forwarding Interface +#define IF_TYPE_MSDSL 143 // Multi-rate Symmetric DSL +#define IF_TYPE_IEEE1394 144 // IEEE1394 High Perf Serial Bus +#define IF_TYPE_IF_GSN 145 +#define IF_TYPE_DVBRCC_MACLAYER 146 +#define IF_TYPE_DVBRCC_DOWNSTREAM 147 +#define IF_TYPE_DVBRCC_UPSTREAM 148 +#define IF_TYPE_ATM_VIRTUAL 149 +#define IF_TYPE_MPLS_TUNNEL 150 +#define IF_TYPE_SRP 151 +#define IF_TYPE_VOICEOVERATM 152 +#define IF_TYPE_VOICEOVERFRAMERELAY 153 +#define IF_TYPE_IDSL 154 +#define IF_TYPE_COMPOSITELINK 155 +#define IF_TYPE_SS7_SIGLINK 156 +#define IF_TYPE_PROP_WIRELESS_P2P 157 +#define IF_TYPE_FR_FORWARD 158 +#define IF_TYPE_RFC1483 159 +#define IF_TYPE_USB 160 +#define IF_TYPE_IEEE8023AD_LAG 161 +#define IF_TYPE_BGP_POLICY_ACCOUNTING 162 +#define IF_TYPE_FRF16_MFR_BUNDLE 163 +#define IF_TYPE_H323_GATEKEEPER 164 +#define IF_TYPE_H323_PROXY 165 +#define IF_TYPE_MPLS 166 +#define IF_TYPE_MF_SIGLINK 167 +#define IF_TYPE_HDSL2 168 +#define IF_TYPE_SHDSL 169 +#define IF_TYPE_DS1_FDL 170 +#define IF_TYPE_POS 171 +#define IF_TYPE_DVB_ASI_IN 172 +#define IF_TYPE_DVB_ASI_OUT 173 +#define IF_TYPE_PLC 174 +#define IF_TYPE_NFAS 175 +#define IF_TYPE_TR008 176 +#define IF_TYPE_GR303_RDT 177 +#define IF_TYPE_GR303_IDT 178 +#define IF_TYPE_ISUP 179 +#define IF_TYPE_PROP_DOCS_WIRELESS_MACLAYER 180 +#define IF_TYPE_PROP_DOCS_WIRELESS_DOWNSTREAM 181 +#define IF_TYPE_PROP_DOCS_WIRELESS_UPSTREAM 182 +#define IF_TYPE_HIPERLAN2 183 +#define IF_TYPE_PROP_BWA_P2MP 184 +#define IF_TYPE_SONET_OVERHEAD_CHANNEL 185 +#define IF_TYPE_DIGITAL_WRAPPER_OVERHEAD_CHANNEL 186 +#define IF_TYPE_AAL2 187 +#define IF_TYPE_RADIO_MAC 188 +#define IF_TYPE_ATM_RADIO 189 +#define IF_TYPE_IMT 190 +#define IF_TYPE_MVL 191 +#define IF_TYPE_REACH_DSL 192 +#define IF_TYPE_FR_DLCI_ENDPT 193 +#define IF_TYPE_ATM_VCI_ENDPT 194 +#define IF_TYPE_OPTICAL_CHANNEL 195 +#define IF_TYPE_OPTICAL_TRANSPORT 196 +#define IF_TYPE_IEEE80216_WMAN 237 +#define IF_TYPE_WWANPP 243 // WWAN devices based on GSM technology +#define IF_TYPE_WWANPP2 244 // WWAN devices based on CDMA technology +#define IF_TYPE_IEEE802154 259 // IEEE 802.15.4 WPAN interface +#define IF_TYPE_XBOX_WIRELESS 281 + +#define MAX_IF_TYPE 281 + +typedef ULONG IFTYPE; + +////////////////////////////////////////////////////////////////////////////// +// // +// Access types // +// // +////////////////////////////////////////////////////////////////////////////// + +typedef enum _IF_ACCESS_TYPE { + IF_ACCESS_LOOPBACK = 1, + IF_ACCESS_BROADCAST = 2, + IF_ACCESS_POINT_TO_POINT = 3, // New definition. + IF_ACCESS_POINTTOPOINT = 3, // Old definition. + IF_ACCESS_POINT_TO_MULTI_POINT = 4, // New definition. + IF_ACCESS_POINTTOMULTIPOINT = 4, // Old definition. +} IF_ACCESS_TYPE; + + +////////////////////////////////////////////////////////////////////////////// +// // +// Interface Capabilities (bit flags) // +// // +////////////////////////////////////////////////////////////////////////////// + +#define IF_CHECK_NONE 0x00 +#define IF_CHECK_MCAST 0x01 +#define IF_CHECK_SEND 0x02 + + +////////////////////////////////////////////////////////////////////////////// +// // +// Connection Types // +// // +////////////////////////////////////////////////////////////////////////////// + +#define IF_CONNECTION_DEDICATED 1 +#define IF_CONNECTION_PASSIVE 2 +#define IF_CONNECTION_DEMAND 3 + + +#define IF_ADMIN_STATUS_UP 1 +#define IF_ADMIN_STATUS_DOWN 2 +#define IF_ADMIN_STATUS_TESTING 3 + +////////////////////////////////////////////////////////////////////////////// +// // +// The following are the the operational states for WAN and LAN interfaces. // +// The order of the states seems weird, but is done for a purpose. All // +// states >= CONNECTED can transmit data right away. States >= DISCONNECTED // +// can tx data but some set up might be needed. States < DISCONNECTED can // +// not transmit data. // +// A card is marked UNREACHABLE if DIM calls InterfaceUnreachable for // +// reasons other than failure to connect. // +// // +// NON_OPERATIONAL -- Valid for LAN Interfaces. Means the card is not // +// working or not plugged in or has no address. // +// UNREACHABLE -- Valid for WAN Interfaces. Means the remote site is // +// not reachable at this time. // +// DISCONNECTED -- Valid for WAN Interfaces. Means the remote site is // +// not connected at this time. // +// CONNECTING -- Valid for WAN Interfaces. Means a connection attempt // +// has been initiated to the remote site. // +// CONNECTED -- Valid for WAN Interfaces. Means the remote site is // +// connected. // +// OPERATIONAL -- Valid for LAN Interfaces. Means the card is plugged // +// in and working. // +// // +// It is the users duty to convert these values to MIB-II values if they // +// are to be used by a subagent // +// // +////////////////////////////////////////////////////////////////////////////// + +typedef enum _INTERNAL_IF_OPER_STATUS { + IF_OPER_STATUS_NON_OPERATIONAL = 0, + IF_OPER_STATUS_UNREACHABLE = 1, + IF_OPER_STATUS_DISCONNECTED = 2, + IF_OPER_STATUS_CONNECTING = 3, + IF_OPER_STATUS_CONNECTED = 4, + IF_OPER_STATUS_OPERATIONAL = 5, +} INTERNAL_IF_OPER_STATUS; + +#define MIB_IF_TYPE_OTHER 1 +#define MIB_IF_TYPE_ETHERNET 6 +#define MIB_IF_TYPE_TOKENRING 9 +#define MIB_IF_TYPE_FDDI 15 +#define MIB_IF_TYPE_PPP 23 +#define MIB_IF_TYPE_LOOPBACK 24 +#define MIB_IF_TYPE_SLIP 28 + +#define MIB_IF_ADMIN_STATUS_UP 1 +#define MIB_IF_ADMIN_STATUS_DOWN 2 +#define MIB_IF_ADMIN_STATUS_TESTING 3 + +// +// N.B. The name is a misnomer. These are NOT the values used by MIB-II. +// +#define MIB_IF_OPER_STATUS_NON_OPERATIONAL IF_OPER_STATUS_NON_OPERATIONAL +#define MIB_IF_OPER_STATUS_UNREACHABLE IF_OPER_STATUS_UNREACHABLE +#define MIB_IF_OPER_STATUS_DISCONNECTED IF_OPER_STATUS_DISCONNECTED +#define MIB_IF_OPER_STATUS_CONNECTING IF_OPER_STATUS_CONNECTING +#define MIB_IF_OPER_STATUS_CONNECTED IF_OPER_STATUS_CONNECTED +#define MIB_IF_OPER_STATUS_OPERATIONAL IF_OPER_STATUS_OPERATIONAL + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif //__ROUTING_IPIFCONS_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipmib.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipmib.h new file mode 100644 index 0000000000000000000000000000000000000000..78285b58a1169e60fde7f6ba0652462b53e9a82b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipmib.h @@ -0,0 +1,572 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + ipmib.h + +Abstract: + + This module contains the public definitions and structures for the + IP-specific parts of MIB-II. These definitions were previously + in iprtrmib.h, which now includes this file. + +--*/ + +#ifndef _IPMIB_ +#define _IPMIB_ + +#if defined(_MSC_VER) && (_MSC_VER > 1000) +#pragma once +#endif +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +#ifndef ANY_SIZE +#define ANY_SIZE 1 +#endif + +// +// Pick up definitions of MAXLEN_PHYSADDR, etc. +// +#include +#include + +#if defined(_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) /* nonstandard extension used : nameless struct/union */ +#endif // defined(_MSC_VER) + +#define MIB_IPADDR_PRIMARY 0x0001 // Primary ipaddr +#define MIB_IPADDR_DYNAMIC 0x0004 // Dynamic ipaddr +#define MIB_IPADDR_DISCONNECTED 0x0008 // Address is on disconnected interface +#define MIB_IPADDR_DELETED 0x0040 // Address being deleted +#define MIB_IPADDR_TRANSIENT 0x0080 // Transient address +#define MIB_IPADDR_DNS_ELIGIBLE 0X0100 // Address is published in DNS. + +typedef struct _MIB_IPADDRROW_XP { + DWORD dwAddr; + IF_INDEX dwIndex; + DWORD dwMask; + DWORD dwBCastAddr; + DWORD dwReasmSize; + unsigned short unused1; + unsigned short wType; +} MIB_IPADDRROW_XP, *PMIB_IPADDRROW_XP; + +typedef struct _MIB_IPADDRROW_W2K { + DWORD dwAddr; + DWORD dwIndex; + DWORD dwMask; + DWORD dwBCastAddr; + DWORD dwReasmSize; + unsigned short unused1; + unsigned short unused2; +} MIB_IPADDRROW_W2K, *PMIB_IPADDRROW_W2K; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef MIB_IPADDRROW_XP MIB_IPADDRROW; +typedef MIB_IPADDRROW_XP *PMIB_IPADDRROW; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_IPADDRROW_W2K MIB_IPADDRROW; +typedef MIB_IPADDRROW_W2K *PMIB_IPADDRROW; +#else +typedef MIB_IPADDRROW_XP MIB_IPADDRROW; +typedef MIB_IPADDRROW_XP *PMIB_IPADDRROW; +#endif + +typedef struct _MIB_IPADDRTABLE { + DWORD dwNumEntries; + MIB_IPADDRROW table[ANY_SIZE]; +} MIB_IPADDRTABLE, *PMIB_IPADDRTABLE; + + +#define SIZEOF_IPADDRTABLE(X) (FIELD_OFFSET(MIB_IPADDRTABLE,table[0]) + \ + ((X) * sizeof(MIB_IPADDRROW)) + ALIGN_SIZE) + +typedef struct _MIB_IPFORWARDNUMBER { + DWORD dwValue; +} MIB_IPFORWARDNUMBER,*PMIB_IPFORWARDNUMBER; + +typedef NL_ROUTE_PROTOCOL MIB_IPFORWARD_PROTO; + +typedef enum { + MIB_IPROUTE_TYPE_OTHER = 1, + MIB_IPROUTE_TYPE_INVALID = 2, + MIB_IPROUTE_TYPE_DIRECT = 3, + MIB_IPROUTE_TYPE_INDIRECT = 4, +} MIB_IPFORWARD_TYPE; + +typedef struct _MIB_IPFORWARDROW { + DWORD dwForwardDest; + DWORD dwForwardMask; + DWORD dwForwardPolicy; + DWORD dwForwardNextHop; + IF_INDEX dwForwardIfIndex; + union { + DWORD dwForwardType; // Old field name uses DWORD type. + MIB_IPFORWARD_TYPE ForwardType; // New field name uses enum type. + }; + union { + DWORD dwForwardProto; // Old field name uses DWORD type. + MIB_IPFORWARD_PROTO ForwardProto; // New field name uses enum type. + }; + DWORD dwForwardAge; + DWORD dwForwardNextHopAS; + DWORD dwForwardMetric1; + DWORD dwForwardMetric2; + DWORD dwForwardMetric3; + DWORD dwForwardMetric4; + DWORD dwForwardMetric5; +} MIB_IPFORWARDROW, *PMIB_IPFORWARDROW; + +#define MIB_IPROUTE_TYPE_OTHER 1 +#define MIB_IPROUTE_TYPE_INVALID 2 +#define MIB_IPROUTE_TYPE_DIRECT 3 +#define MIB_IPROUTE_TYPE_INDIRECT 4 + +#define MIB_IPROUTE_METRIC_UNUSED (DWORD)-1 + + +typedef struct _MIB_IPFORWARDTABLE { + DWORD dwNumEntries; + MIB_IPFORWARDROW table[ANY_SIZE]; +} MIB_IPFORWARDTABLE, *PMIB_IPFORWARDTABLE; + +#define SIZEOF_IPFORWARDTABLE(X) \ + (FIELD_OFFSET(MIB_IPFORWARDTABLE,table[0]) + \ + ((X) * sizeof(MIB_IPFORWARDROW)) + ALIGN_SIZE) + + +typedef enum { + MIB_IPNET_TYPE_OTHER = 1, + MIB_IPNET_TYPE_INVALID = 2, + MIB_IPNET_TYPE_DYNAMIC = 3, + MIB_IPNET_TYPE_STATIC = 4, +} MIB_IPNET_TYPE; + +typedef struct _MIB_IPNETROW_LH { + IF_INDEX dwIndex; + DWORD dwPhysAddrLen; + UCHAR bPhysAddr[MAXLEN_PHYSADDR]; + DWORD dwAddr; + union { + DWORD dwType; // Old field name was just a DWORD. + MIB_IPNET_TYPE Type; // New field name uses the enum type. + }; +} MIB_IPNETROW_LH, *PMIB_IPNETROW_LH; + +typedef struct _MIB_IPNETROW_W2K { + IF_INDEX dwIndex; + DWORD dwPhysAddrLen; + UCHAR bPhysAddr[MAXLEN_PHYSADDR]; + DWORD dwAddr; + DWORD dwType; +} MIB_IPNETROW_W2K, *PMIB_IPNETROW_W2K; + + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef MIB_IPNETROW_LH MIB_IPNETROW; +typedef MIB_IPNETROW_LH *PMIB_IPNETROW; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_IPNETROW_W2K MIB_IPNETROW; +typedef MIB_IPNETROW_W2K *PMIB_IPNETROW; +#else +typedef MIB_IPNETROW_LH MIB_IPNETROW; +typedef MIB_IPNETROW_LH *PMIB_IPNETROW; +#endif + +typedef struct _MIB_IPNETTABLE { + DWORD dwNumEntries; + MIB_IPNETROW table[ANY_SIZE]; +} MIB_IPNETTABLE, *PMIB_IPNETTABLE; + +#define SIZEOF_IPNETTABLE(X) (FIELD_OFFSET(MIB_IPNETTABLE, table[0]) + \ + ((X) * sizeof(MIB_IPNETROW)) + ALIGN_SIZE) + +typedef enum { + MIB_IP_FORWARDING = 1, + MIB_IP_NOT_FORWARDING = 2, +} MIB_IPSTATS_FORWARDING, *PMIB_IPSTATS_FORWARDING; + +#define MIB_USE_CURRENT_TTL ((DWORD)-1) +#define MIB_USE_CURRENT_FORWARDING ((DWORD)-1) + +typedef struct _MIB_IPSTATS_LH { + union { + DWORD dwForwarding; + MIB_IPSTATS_FORWARDING Forwarding; + }; + DWORD dwDefaultTTL; + DWORD dwInReceives; + DWORD dwInHdrErrors; + DWORD dwInAddrErrors; + DWORD dwForwDatagrams; + DWORD dwInUnknownProtos; + DWORD dwInDiscards; + DWORD dwInDelivers; + DWORD dwOutRequests; + DWORD dwRoutingDiscards; + DWORD dwOutDiscards; + DWORD dwOutNoRoutes; + DWORD dwReasmTimeout; + DWORD dwReasmReqds; + DWORD dwReasmOks; + DWORD dwReasmFails; + DWORD dwFragOks; + DWORD dwFragFails; + DWORD dwFragCreates; + DWORD dwNumIf; + DWORD dwNumAddr; + DWORD dwNumRoutes; +} MIB_IPSTATS_LH, *PMIB_IPSTATS_LH; + +typedef struct _MIB_IPSTATS_W2K { + DWORD dwForwarding; + DWORD dwDefaultTTL; + DWORD dwInReceives; + DWORD dwInHdrErrors; + DWORD dwInAddrErrors; + DWORD dwForwDatagrams; + DWORD dwInUnknownProtos; + DWORD dwInDiscards; + DWORD dwInDelivers; + DWORD dwOutRequests; + DWORD dwRoutingDiscards; + DWORD dwOutDiscards; + DWORD dwOutNoRoutes; + DWORD dwReasmTimeout; + DWORD dwReasmReqds; + DWORD dwReasmOks; + DWORD dwReasmFails; + DWORD dwFragOks; + DWORD dwFragFails; + DWORD dwFragCreates; + DWORD dwNumIf; + DWORD dwNumAddr; + DWORD dwNumRoutes; +} MIB_IPSTATS_W2K, *PMIB_IPSTATS_W2K; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef MIB_IPSTATS_LH MIB_IPSTATS; +typedef MIB_IPSTATS_LH *PMIB_IPSTATS; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_IPSTATS_W2K MIB_IPSTATS; +typedef MIB_IPSTATS_W2K *PMIB_IPSTATS; +#endif + +typedef struct _MIBICMPSTATS { + DWORD dwMsgs; + DWORD dwErrors; + DWORD dwDestUnreachs; + DWORD dwTimeExcds; + DWORD dwParmProbs; + DWORD dwSrcQuenchs; + DWORD dwRedirects; + DWORD dwEchos; + DWORD dwEchoReps; + DWORD dwTimestamps; + DWORD dwTimestampReps; + DWORD dwAddrMasks; + DWORD dwAddrMaskReps; +} MIBICMPSTATS, *PMIBICMPSTATS; + +typedef struct _MIBICMPINFO { + MIBICMPSTATS icmpInStats; + MIBICMPSTATS icmpOutStats; +} MIBICMPINFO; + +typedef struct _MIB_ICMP { + MIBICMPINFO stats; +} MIB_ICMP,*PMIB_ICMP; + +typedef struct _MIBICMPSTATS_EX_XPSP1 { + DWORD dwMsgs; + DWORD dwErrors; + DWORD rgdwTypeCount[256]; +} MIBICMPSTATS_EX_XPSP1, *PMIBICMPSTATS_EX_XPSP1; + +typedef MIBICMPSTATS_EX_XPSP1 MIBICMPSTATS_EX; +typedef MIBICMPSTATS_EX_XPSP1 *PMIBICMPSTATS_EX; + +typedef struct _MIB_ICMP_EX_XPSP1 { + MIBICMPSTATS_EX icmpInStats; + MIBICMPSTATS_EX icmpOutStats; +} MIB_ICMP_EX_XPSP1,*PMIB_ICMP_EX_XPSP1; + +typedef MIB_ICMP_EX_XPSP1 MIB_ICMP_EX; +typedef MIB_ICMP_EX_XPSP1 *PMIB_ICMP_EX; + + +// +// ICMP6_TYPE +// +// ICMPv6 Type Values from RFC 2292, 2461 (ND), and 3810 (MLDv2) +// +typedef enum { + ICMP6_DST_UNREACH = 1, + ICMP6_PACKET_TOO_BIG = 2, + ICMP6_TIME_EXCEEDED = 3, + ICMP6_PARAM_PROB = 4, + ICMP6_ECHO_REQUEST = 128, + ICMP6_ECHO_REPLY = 129, + ICMP6_MEMBERSHIP_QUERY = 130, + ICMP6_MEMBERSHIP_REPORT = 131, + ICMP6_MEMBERSHIP_REDUCTION = 132, + ND_ROUTER_SOLICIT = 133, + ND_ROUTER_ADVERT = 134, + ND_NEIGHBOR_SOLICIT = 135, + ND_NEIGHBOR_ADVERT = 136, + ND_REDIRECT = 137, + ICMP6_V2_MEMBERSHIP_REPORT = 143, +} ICMP6_TYPE, *PICMP6_TYPE; + + +// +// Used to identify informational/error messages. +// +#define ICMP6_INFOMSG_MASK 0x80 +#define ICMP6_ISTYPEINFORMATIONAL(Type) (((Type) & ICMP6_INFOMSG_MASK) != 0) +#define ICMP6_ISTYPEERROR(Type) (!ICMP6_ISTYPEINFORMATIONAL(Type)) + +// +// ICMP4_TYPE +// +// There are no RFC-specified defines for ICMPv4 message types, so we try to +// use the ICMP6 values from RFC 2292 modified to be prefixed with ICMP4. +// +typedef enum { + ICMP4_ECHO_REPLY = 0, // Echo Reply. + ICMP4_DST_UNREACH = 3, // Destination Unreachable. + ICMP4_SOURCE_QUENCH = 4, // Source Quench. + ICMP4_REDIRECT = 5, // Redirect. + ICMP4_ECHO_REQUEST = 8, // Echo Request. + ICMP4_ROUTER_ADVERT = 9, // Router Advertisement. + ICMP4_ROUTER_SOLICIT = 10, // Router Solicitation. + ICMP4_TIME_EXCEEDED = 11, // Time Exceeded. + ICMP4_PARAM_PROB = 12, // Parameter Problem. + ICMP4_TIMESTAMP_REQUEST = 13, // Timestamp Request. + ICMP4_TIMESTAMP_REPLY = 14, // Timestamp Reply. + ICMP4_MASK_REQUEST = 17, // Address Mask Request. + ICMP4_MASK_REPLY = 18, // Address Mask Reply. +} ICMP4_TYPE, *PICMP4_TYPE; + +// +// See RFC 1812, section 4.3.1. +// +#define ICMP4_ISTYPEERROR(Type) \ + (((Type) == ICMP4_DST_UNREACH) || \ + ((Type) == ICMP4_SOURCE_QUENCH) || \ + ((Type) == ICMP4_REDIRECT) || \ + ((Type) == ICMP4_PARAM_PROB) || \ + ((Type) == ICMP4_TIME_EXCEEDED)) \ + +typedef struct _MIB_IPMCAST_OIF_XP { + DWORD dwOutIfIndex; + DWORD dwNextHopAddr; + DWORD dwReserved; + DWORD dwReserved1; +} MIB_IPMCAST_OIF_XP, *PMIB_IPMCAST_OIF_XP ; + +typedef struct _MIB_IPMCAST_OIF_W2K { + DWORD dwOutIfIndex; + DWORD dwNextHopAddr; + PVOID pvReserved; + DWORD dwReserved; +} MIB_IPMCAST_OIF_W2K, *PMIB_IPMCAST_OIF_W2K; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef MIB_IPMCAST_OIF_XP MIB_IPMCAST_OIF; +typedef MIB_IPMCAST_OIF_XP *PMIB_IPMCAST_OIF; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_IPMCAST_OIF_W2K MIB_IPMCAST_OIF; +typedef MIB_IPMCAST_OIF_W2K *PMIB_IPMCAST_OIF; +#else +typedef MIB_IPMCAST_OIF_XP MIB_IPMCAST_OIF; +typedef MIB_IPMCAST_OIF_XP *PMIB_IPMCAST_OIF; +#endif + +typedef struct _MIB_IPMCAST_MFE { + DWORD dwGroup; + DWORD dwSource; + DWORD dwSrcMask; + DWORD dwUpStrmNgbr; + DWORD dwInIfIndex; + DWORD dwInIfProtocol; + DWORD dwRouteProtocol; + DWORD dwRouteNetwork; + DWORD dwRouteMask; + ULONG ulUpTime; + ULONG ulExpiryTime; + ULONG ulTimeOut; + ULONG ulNumOutIf; + DWORD fFlags; + DWORD dwReserved; + MIB_IPMCAST_OIF rgmioOutInfo[ANY_SIZE]; +} MIB_IPMCAST_MFE, *PMIB_IPMCAST_MFE; + +typedef struct _MIB_MFE_TABLE { + DWORD dwNumEntries; + MIB_IPMCAST_MFE table[ANY_SIZE]; +} MIB_MFE_TABLE, *PMIB_MFE_TABLE; + + +#define SIZEOF_BASIC_MIB_MFE \ + (ULONG)(FIELD_OFFSET(MIB_IPMCAST_MFE, rgmioOutInfo[0])) + +#define SIZEOF_MIB_MFE(X) \ + (SIZEOF_BASIC_MIB_MFE + ((X) * sizeof(MIB_IPMCAST_OIF))) + + +typedef struct _MIB_IPMCAST_OIF_STATS_LH { + DWORD dwOutIfIndex; + DWORD dwNextHopAddr; + DWORD dwDialContext; + ULONG ulTtlTooLow; + ULONG ulFragNeeded; + ULONG ulOutPackets; + ULONG ulOutDiscards; +} MIB_IPMCAST_OIF_STATS_LH, *PMIB_IPMCAST_OIF_STATS_LH; + +typedef struct _MIB_IPMCAST_OIF_STATS_W2K { + DWORD dwOutIfIndex; + DWORD dwNextHopAddr; + PVOID pvDialContext; + ULONG ulTtlTooLow; + ULONG ulFragNeeded; + ULONG ulOutPackets; + ULONG ulOutDiscards; +} MIB_IPMCAST_OIF_STATS_W2K, *PMIB_IPMCAST_OIF_STATS_W2K; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef MIB_IPMCAST_OIF_STATS_LH MIB_IPMCAST_OIF_STATS; +typedef MIB_IPMCAST_OIF_STATS_LH *PMIB_IPMCAST_OIF_STATS; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_IPMCAST_OIF_STATS_W2K MIB_IPMCAST_OIF_STATS; +typedef MIB_IPMCAST_OIF_STATS_W2K *PMIB_IPMCAST_OIF_STATS; +#else +typedef MIB_IPMCAST_OIF_STATS_LH MIB_IPMCAST_OIF_STATS; +typedef MIB_IPMCAST_OIF_STATS_LH *PMIB_IPMCAST_OIF_STATS; +#endif + +typedef struct _MIB_IPMCAST_MFE_STATS { + DWORD dwGroup; + DWORD dwSource; + DWORD dwSrcMask; + DWORD dwUpStrmNgbr; + DWORD dwInIfIndex; + DWORD dwInIfProtocol; + DWORD dwRouteProtocol; + DWORD dwRouteNetwork; + DWORD dwRouteMask; + ULONG ulUpTime; + ULONG ulExpiryTime; + ULONG ulNumOutIf; + ULONG ulInPkts; + ULONG ulInOctets; + ULONG ulPktsDifferentIf; + ULONG ulQueueOverflow; + + MIB_IPMCAST_OIF_STATS rgmiosOutStats[ANY_SIZE]; +} MIB_IPMCAST_MFE_STATS, *PMIB_IPMCAST_MFE_STATS; + +typedef struct _MIB_MFE_STATS_TABLE { + DWORD dwNumEntries; + MIB_IPMCAST_MFE_STATS table[ANY_SIZE]; +} MIB_MFE_STATS_TABLE, *PMIB_MFE_STATS_TABLE; + +#define SIZEOF_BASIC_MIB_MFE_STATS \ + (ULONG)(FIELD_OFFSET(MIB_IPMCAST_MFE_STATS, rgmiosOutStats[0])) + +#define SIZEOF_MIB_MFE_STATS(X) \ + (SIZEOF_BASIC_MIB_MFE_STATS + ((X) * sizeof(MIB_IPMCAST_OIF_STATS))) + + +typedef struct _MIB_IPMCAST_MFE_STATS_EX_XP { + DWORD dwGroup; + DWORD dwSource; + DWORD dwSrcMask; + DWORD dwUpStrmNgbr; + DWORD dwInIfIndex; + DWORD dwInIfProtocol; + DWORD dwRouteProtocol; + DWORD dwRouteNetwork; + DWORD dwRouteMask; + ULONG ulUpTime; + ULONG ulExpiryTime; + ULONG ulNumOutIf; + ULONG ulInPkts; + ULONG ulInOctets; + ULONG ulPktsDifferentIf; + ULONG ulQueueOverflow; + ULONG ulUninitMfe; + ULONG ulNegativeMfe; + ULONG ulInDiscards; + ULONG ulInHdrErrors; + ULONG ulTotalOutPackets; + + MIB_IPMCAST_OIF_STATS rgmiosOutStats[ANY_SIZE]; +} MIB_IPMCAST_MFE_STATS_EX_XP, + *PMIB_IPMCAST_MFE_STATS_EX_XP; +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef MIB_IPMCAST_MFE_STATS_EX_XP MIB_IPMCAST_MFE_STATS_EX; +typedef MIB_IPMCAST_MFE_STATS_EX_XP *PMIB_IPMCAST_MFE_STATS_EX; +#endif + +typedef struct _MIB_MFE_STATS_TABLE_EX_XP { + DWORD dwNumEntries; + PMIB_IPMCAST_MFE_STATS_EX_XP table[ANY_SIZE]; +} MIB_MFE_STATS_TABLE_EX_XP, *PMIB_MFE_STATS_TABLE_EX_XP; +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef MIB_MFE_STATS_TABLE_EX_XP MIB_MFE_STATS_TABLE_EX; +typedef MIB_MFE_STATS_TABLE_EX_XP *PMIB_MFE_STATS_TABLE_EX; + +#define SIZEOF_BASIC_MIB_MFE_STATS_EX \ + (ULONG)(FIELD_OFFSET(MIB_IPMCAST_MFE_STATS_EX, rgmiosOutStats[0])) + +#define SIZEOF_MIB_MFE_STATS_EX(X) \ + (SIZEOF_BASIC_MIB_MFE_STATS_EX + ((X) * sizeof(MIB_IPMCAST_OIF_STATS))) +#endif + +typedef struct _MIB_IPMCAST_GLOBAL { + DWORD dwEnable; +} MIB_IPMCAST_GLOBAL, *PMIB_IPMCAST_GLOBAL; + +typedef struct _MIB_IPMCAST_IF_ENTRY { + DWORD dwIfIndex; + DWORD dwTtl; + DWORD dwProtocol; + DWORD dwRateLimit; + ULONG ulInMcastOctets; + ULONG ulOutMcastOctets; +} MIB_IPMCAST_IF_ENTRY, *PMIB_IPMCAST_IF_ENTRY; + +typedef struct _MIB_IPMCAST_IF_TABLE { + DWORD dwNumEntries; + MIB_IPMCAST_IF_ENTRY table[ANY_SIZE]; +} MIB_IPMCAST_IF_TABLE, *PMIB_IPMCAST_IF_TABLE; + +#define SIZEOF_MCAST_IF_TABLE(X) \ + (FIELD_OFFSET(MIB_IPMCAST_IF_TABLE, table[0]) + \ + ((X) * sizeof(MIB_IPMCAST_IF_ENTRY)) + \ + ALIGN_SIZE) + +#if defined (_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) /* nonstandard extension used : nameless struct/union */ +#endif +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _IPMIB_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.h new file mode 100644 index 0000000000000000000000000000000000000000..b9a25ecfb8c5ce2d95e5bc1cbf4a712832f59714 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.h @@ -0,0 +1,991 @@ + + +/* this ALWAYS GENERATED file contains the definitions for the interfaces */ + + + /* File created by MIDL compiler version 8.01.0628 */ +/* @@MIDL_FILE_HEADING( ) */ + + + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCNDR_H_VERSION__ +#define __REQUIRED_RPCNDR_H_VERSION__ 501 +#endif + +/* verify that the version is high enough to compile this file*/ +#ifndef __REQUIRED_RPCSAL_H_VERSION__ +#define __REQUIRED_RPCSAL_H_VERSION__ 100 +#endif + +#include "rpc.h" +#include "rpcndr.h" + +#ifndef __RPCNDR_H_VERSION__ +#error this stub requires an updated version of +#endif /* __RPCNDR_H_VERSION__ */ + + +#ifndef __ipsectypes_h__ +#define __ipsectypes_h__ + +#if defined(_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef DECLSPEC_XFGVIRT +#if defined(_CONTROL_FLOW_GUARD_XFG) +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +/* Forward Declarations */ + +/* header files for imported files */ +#include "fwptypes.h" +#include "iketypes.h" + +#ifdef __cplusplus +extern "C"{ +#endif + + +/* interface __MIDL_itf_ipsectypes_0000_0000 */ +/* [local] */ + +#include +#pragma region Desktop Family or AppRuntime Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif +typedef struct FWPM_FILTER0_ FWPM_FILTER0; + +typedef struct FWPM_DISPLAY_DATA0_ FWPM_DISPLAY_DATA0; + +typedef struct IPSEC_SA_LIFETIME0_ + { + UINT32 lifetimeSeconds; + UINT32 lifetimeKilobytes; + UINT32 lifetimePackets; + } IPSEC_SA_LIFETIME0; + +typedef /* [v1_enum] */ +enum IPSEC_TRANSFORM_TYPE_ + { + IPSEC_TRANSFORM_AH = 1, + IPSEC_TRANSFORM_ESP_AUTH = ( IPSEC_TRANSFORM_AH + 1 ) , + IPSEC_TRANSFORM_ESP_CIPHER = ( IPSEC_TRANSFORM_ESP_AUTH + 1 ) , + IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER = ( IPSEC_TRANSFORM_ESP_CIPHER + 1 ) , + IPSEC_TRANSFORM_ESP_AUTH_FW = ( IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER + 1 ) , + IPSEC_TRANSFORM_TYPE_MAX = ( IPSEC_TRANSFORM_ESP_AUTH_FW + 1 ) + } IPSEC_TRANSFORM_TYPE; + +typedef /* [v1_enum] */ +enum IPSEC_AUTH_TYPE_ + { + IPSEC_AUTH_MD5 = 0, + IPSEC_AUTH_SHA_1 = ( IPSEC_AUTH_MD5 + 1 ) , + IPSEC_AUTH_SHA_256 = ( IPSEC_AUTH_SHA_1 + 1 ) , + IPSEC_AUTH_AES_128 = ( IPSEC_AUTH_SHA_256 + 1 ) , + IPSEC_AUTH_AES_192 = ( IPSEC_AUTH_AES_128 + 1 ) , + IPSEC_AUTH_AES_256 = ( IPSEC_AUTH_AES_192 + 1 ) , + IPSEC_AUTH_MAX = ( IPSEC_AUTH_AES_256 + 1 ) + } IPSEC_AUTH_TYPE; + +typedef UINT8 IPSEC_AUTH_CONFIG; + +#define IPSEC_AUTH_CONFIG_HMAC_MD5_96 (0) +#define IPSEC_AUTH_CONFIG_HMAC_SHA_1_96 (1) +#define IPSEC_AUTH_CONFIG_HMAC_SHA_256_128 (2) +#define IPSEC_AUTH_CONFIG_GCM_AES_128 (3) +#define IPSEC_AUTH_CONFIG_GCM_AES_192 (4) +#define IPSEC_AUTH_CONFIG_GCM_AES_256 (5) +#define IPSEC_AUTH_CONFIG_MAX (6) +typedef struct IPSEC_AUTH_TRANSFORM_ID0_ + { + IPSEC_AUTH_TYPE authType; + IPSEC_AUTH_CONFIG authConfig; + } IPSEC_AUTH_TRANSFORM_ID0; + +typedef GUID IPSEC_CRYPTO_MODULE_ID; + +typedef struct IPSEC_AUTH_TRANSFORM0_ + { + IPSEC_AUTH_TRANSFORM_ID0 authTransformId; + /* [unique] */ IPSEC_CRYPTO_MODULE_ID *cryptoModuleId; + } IPSEC_AUTH_TRANSFORM0; + +typedef /* [v1_enum] */ +enum IPSEC_CIPHER_TYPE_ + { + IPSEC_CIPHER_TYPE_DES = 1, + IPSEC_CIPHER_TYPE_3DES = ( IPSEC_CIPHER_TYPE_DES + 1 ) , + IPSEC_CIPHER_TYPE_AES_128 = ( IPSEC_CIPHER_TYPE_3DES + 1 ) , + IPSEC_CIPHER_TYPE_AES_192 = ( IPSEC_CIPHER_TYPE_AES_128 + 1 ) , + IPSEC_CIPHER_TYPE_AES_256 = ( IPSEC_CIPHER_TYPE_AES_192 + 1 ) , + IPSEC_CIPHER_TYPE_MAX = ( IPSEC_CIPHER_TYPE_AES_256 + 1 ) + } IPSEC_CIPHER_TYPE; + +typedef UINT8 IPSEC_CIPHER_CONFIG; + +#define IPSEC_CIPHER_CONFIG_CBC_DES (1) +#define IPSEC_CIPHER_CONFIG_CBC_3DES (2) +#define IPSEC_CIPHER_CONFIG_CBC_AES_128 (3) +#define IPSEC_CIPHER_CONFIG_CBC_AES_192 (4) +#define IPSEC_CIPHER_CONFIG_CBC_AES_256 (5) +#define IPSEC_CIPHER_CONFIG_GCM_AES_128 (6) +#define IPSEC_CIPHER_CONFIG_GCM_AES_192 (7) +#define IPSEC_CIPHER_CONFIG_GCM_AES_256 (8) +#define IPSEC_CIPHER_CONFIG_MAX (9) +typedef struct IPSEC_CIPHER_TRANSFORM_ID0_ + { + IPSEC_CIPHER_TYPE cipherType; + IPSEC_CIPHER_CONFIG cipherConfig; + } IPSEC_CIPHER_TRANSFORM_ID0; + +typedef struct IPSEC_CIPHER_TRANSFORM0_ + { + IPSEC_CIPHER_TRANSFORM_ID0 cipherTransformId; + /* [unique] */ IPSEC_CRYPTO_MODULE_ID *cryptoModuleId; + } IPSEC_CIPHER_TRANSFORM0; + +typedef struct IPSEC_AUTH_AND_CIPHER_TRANSFORM0_ + { + IPSEC_AUTH_TRANSFORM0 authTransform; + IPSEC_CIPHER_TRANSFORM0 cipherTransform; + } IPSEC_AUTH_AND_CIPHER_TRANSFORM0; + +typedef struct IPSEC_SA_TRANSFORM0_ + { + IPSEC_TRANSFORM_TYPE ipsecTransformType; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_AUTH_TRANSFORM0 *ahTransform; + /* [case()][unique] */ IPSEC_AUTH_TRANSFORM0 *espAuthTransform; + /* [case()][unique] */ IPSEC_CIPHER_TRANSFORM0 *espCipherTransform; + /* [case()][unique] */ IPSEC_AUTH_AND_CIPHER_TRANSFORM0 *espAuthAndCipherTransform; + /* [case()][unique] */ IPSEC_AUTH_TRANSFORM0 *espAuthFwTransform; + } ; + } IPSEC_SA_TRANSFORM0; + +#define espAuthTranform espAuthTransform +typedef /* [v1_enum] */ +enum IPSEC_PFS_GROUP_ + { + IPSEC_PFS_NONE = 0, + IPSEC_PFS_1 = ( IPSEC_PFS_NONE + 1 ) , + IPSEC_PFS_2 = ( IPSEC_PFS_1 + 1 ) , + IPSEC_PFS_2048 = ( IPSEC_PFS_2 + 1 ) , + IPSEC_PFS_14 = IPSEC_PFS_2048, + IPSEC_PFS_ECP_256 = ( IPSEC_PFS_14 + 1 ) , + IPSEC_PFS_ECP_384 = ( IPSEC_PFS_ECP_256 + 1 ) , + IPSEC_PFS_MM = ( IPSEC_PFS_ECP_384 + 1 ) , + IPSEC_PFS_24 = ( IPSEC_PFS_MM + 1 ) , + IPSEC_PFS_MAX = ( IPSEC_PFS_24 + 1 ) + } IPSEC_PFS_GROUP; + +typedef struct IPSEC_PROPOSAL0_ + { + IPSEC_SA_LIFETIME0 lifetime; + UINT32 numSaTransforms; + /* [ref][size_is] */ IPSEC_SA_TRANSFORM0 *saTransforms; + IPSEC_PFS_GROUP pfsGroup; + } IPSEC_PROPOSAL0; + +typedef struct IPSEC_SA_IDLE_TIMEOUT0_ + { + UINT32 idleTimeoutSeconds; + UINT32 idleTimeoutSecondsFailOver; + } IPSEC_SA_IDLE_TIMEOUT0; + +typedef struct IPSEC_TRAFFIC_SELECTOR0_ + { + UINT8 protocolId; + UINT16 portStart; + UINT16 portEnd; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 startV4Address; + /* [case()] */ UINT8 startV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 endV4Address; + /* [case()] */ UINT8 endV6Address[ 16 ]; + } ; + } IPSEC_TRAFFIC_SELECTOR0; + +typedef struct IPSEC_TRAFFIC_SELECTOR_POLICY0_ + { + UINT32 flags; + UINT32 numLocalTrafficSelectors; + /* [unique][size_is] */ IPSEC_TRAFFIC_SELECTOR0 *localTrafficSelectors; + UINT32 numRemoteTrafficSelectors; + /* [unique][size_is] */ IPSEC_TRAFFIC_SELECTOR0 *remoteTrafficSelectors; + } IPSEC_TRAFFIC_SELECTOR_POLICY0; + +#define IPSEC_POLICY_FLAG_ND_SECURE (0x00000002) +#define IPSEC_POLICY_FLAG_ND_BOUNDARY (0x00000004) +#define IPSEC_POLICY_FLAG_CLEAR_DF_ON_TUNNEL (0x00000008) +#define IPSEC_POLICY_FLAG_NAT_ENCAP_ALLOW_PEER_BEHIND_NAT (0x00000010) +#define IPSEC_POLICY_FLAG_NAT_ENCAP_ALLOW_GENERAL_NAT_TRAVERSAL (0x00000020) +#define IPSEC_POLICY_FLAG_DONT_NEGOTIATE_SECOND_LIFETIME (0x00000040) +#define IPSEC_POLICY_FLAG_DONT_NEGOTIATE_BYTE_LIFETIME (0x00000080) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_POLICY_FLAG_ENABLE_V6_IN_V4_TUNNELING (0x00000100) +#define IPSEC_POLICY_FLAG_ENABLE_SERVER_ADDR_ASSIGNMENT (0x00000200) +#define IPSEC_POLICY_FLAG_TUNNEL_ALLOW_OUTBOUND_CLEAR_CONNECTION (0x00000400) +#define IPSEC_POLICY_FLAG_TUNNEL_BYPASS_ALREADY_SECURE_CONNECTION (0x00000800) +#define IPSEC_POLICY_FLAG_TUNNEL_BYPASS_ICMPV6 (0x00001000) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_POLICY_FLAG_KEY_MANAGER_ALLOW_DICTATE_KEY (0x00002000) +#define IPSEC_POLICY_FLAG_KEY_MANAGER_ALLOW_NOTIFY_KEY (0x00004000) +#define IPSEC_POLICY_FLAG_RESERVED1 (0x00008000) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define IPSEC_POLICY_FLAG_SITE_TO_SITE_TUNNEL (0x00010000) +#endif // (NTDDI_VERSION > NTDDI_WIN10_RS3) +#define IPSEC_POLICY_FLAG_POINT_TO_SITE_TUNNEL (0x00020000) +#define IPSEC_POLICY_FLAG_BANDWIDTH1 (0x10000000) +#define IPSEC_POLICY_FLAG_BANDWIDTH2 (0x20000000) +#define IPSEC_POLICY_FLAG_BANDWIDTH3 (0x40000000) +#define IPSEC_POLICY_FLAG_BANDWIDTH4 (0x80000000) +typedef struct IPSEC_TRANSPORT_POLICY0_ + { + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + UINT32 flags; + UINT32 ndAllowClearTimeoutSeconds; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY0 *emPolicy; + } IPSEC_TRANSPORT_POLICY0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TRANSPORT_POLICY1_ + { + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + UINT32 flags; + UINT32 ndAllowClearTimeoutSeconds; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY1 *emPolicy; + } IPSEC_TRANSPORT_POLICY1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IPSEC_TRANSPORT_POLICY2_ + { + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + UINT32 flags; + UINT32 ndAllowClearTimeoutSeconds; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY2 *emPolicy; + } IPSEC_TRANSPORT_POLICY2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IPSEC_TUNNEL_ENDPOINTS0_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + } IPSEC_TUNNEL_ENDPOINTS0; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IPSEC_TUNNEL_ENDPOINT0_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 v4Address; + /* [case()] */ UINT8 v6Address[ 16 ]; + } ; + } IPSEC_TUNNEL_ENDPOINT0; + +typedef struct IPSEC_TUNNEL_ENDPOINTS2_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + UINT64 localIfLuid; + /* [unique][string] */ wchar_t *remoteFqdn; + UINT32 numAddresses; + /* [size_is] */ IPSEC_TUNNEL_ENDPOINT0 *remoteAddresses; + } IPSEC_TUNNEL_ENDPOINTS2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TUNNEL_ENDPOINTS1_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + UINT64 localIfLuid; + } IPSEC_TUNNEL_ENDPOINTS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TUNNEL_POLICY0_ + { + UINT32 flags; + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + IPSEC_TUNNEL_ENDPOINTS0 tunnelEndpoints; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY0 *emPolicy; + } IPSEC_TUNNEL_POLICY0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TUNNEL_POLICY1_ + { + UINT32 flags; + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + IPSEC_TUNNEL_ENDPOINTS1 tunnelEndpoints; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY1 *emPolicy; + } IPSEC_TUNNEL_POLICY1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IPSEC_TUNNEL_POLICY2_ + { + UINT32 flags; + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + IPSEC_TUNNEL_ENDPOINTS2 tunnelEndpoints; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY2 *emPolicy; + UINT32 fwdPathSaLifetime; + } IPSEC_TUNNEL_POLICY2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct IPSEC_TUNNEL_POLICY3_ + { + UINT32 flags; + UINT32 numIpsecProposals; + /* [ref][size_is] */ IPSEC_PROPOSAL0 *ipsecProposals; + IPSEC_TUNNEL_ENDPOINTS2 tunnelEndpoints; + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + /* [unique] */ IKEEXT_EM_POLICY2 *emPolicy; + UINT32 fwdPathSaLifetime; + UINT32 compartmentId; + UINT32 numTrafficSelectorPolicy; + /* [unique][size_is] */ IPSEC_TRAFFIC_SELECTOR_POLICY0 *trafficSelectorPolicies; + } IPSEC_TUNNEL_POLICY3; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct IPSEC_KEYING_POLICY0_ + { + UINT32 numKeyMods; + /* [ref][size_is] */ GUID *keyModKeys; + } IPSEC_KEYING_POLICY0; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_KEYING_POLICY_FLAG_TERMINATING_MATCH (0x00000001) +typedef struct IPSEC_KEYING_POLICY1_ + { + UINT32 numKeyMods; + /* [ref][size_is] */ GUID *keyModKeys; + UINT32 flags; + } IPSEC_KEYING_POLICY1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct IPSEC_AGGREGATE_SA_STATISTICS0_ + { + UINT32 activeSas; + UINT32 pendingSaNegotiations; + UINT32 totalSasAdded; + UINT32 totalSasDeleted; + UINT32 successfulRekeys; + UINT32 activeTunnels; + UINT32 offloadedSas; + } IPSEC_AGGREGATE_SA_STATISTICS0; + +typedef struct IPSEC_ESP_DROP_PACKET_STATISTICS0_ + { + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 saNotInitializedOnInbound; + } IPSEC_ESP_DROP_PACKET_STATISTICS0; + +typedef struct IPSEC_AH_DROP_PACKET_STATISTICS0_ + { + UINT32 invalidSpisOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 saNotInitializedOnInbound; + } IPSEC_AH_DROP_PACKET_STATISTICS0; + +typedef struct IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0_ + { + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 udpEspValidationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 invalidClearTextInbound; + UINT32 saNotInitializedOnInbound; + UINT32 receiveOverIncorrectSaInbound; + UINT32 secureReceivesNotMatchingFilters; + } IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1_ + { + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 udpEspValidationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 invalidClearTextInbound; + UINT32 saNotInitializedOnInbound; + UINT32 receiveOverIncorrectSaInbound; + UINT32 secureReceivesNotMatchingFilters; + UINT32 totalDropPacketsInbound; + } IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TRAFFIC_STATISTICS0_ + { + UINT64 encryptedByteCount; + UINT64 authenticatedAHByteCount; + UINT64 authenticatedESPByteCount; + UINT64 transportByteCount; + UINT64 tunnelByteCount; + UINT64 offloadByteCount; + } IPSEC_TRAFFIC_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TRAFFIC_STATISTICS1_ + { + UINT64 encryptedByteCount; + UINT64 authenticatedAHByteCount; + UINT64 authenticatedESPByteCount; + UINT64 transportByteCount; + UINT64 tunnelByteCount; + UINT64 offloadByteCount; + UINT64 totalSuccessfulPackets; + } IPSEC_TRAFFIC_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_STATISTICS0_ + { + IPSEC_AGGREGATE_SA_STATISTICS0 aggregateSaStatistics; + IPSEC_ESP_DROP_PACKET_STATISTICS0 espDropPacketStatistics; + IPSEC_AH_DROP_PACKET_STATISTICS0 ahDropPacketStatistics; + IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0 aggregateDropPacketStatistics; + IPSEC_TRAFFIC_STATISTICS0 inboundTrafficStatistics; + IPSEC_TRAFFIC_STATISTICS0 outboundTrafficStatistics; + } IPSEC_STATISTICS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_STATISTICS1_ + { + IPSEC_AGGREGATE_SA_STATISTICS0 aggregateSaStatistics; + IPSEC_ESP_DROP_PACKET_STATISTICS0 espDropPacketStatistics; + IPSEC_AH_DROP_PACKET_STATISTICS0 ahDropPacketStatistics; + IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1 aggregateDropPacketStatistics; + IPSEC_TRAFFIC_STATISTICS1 inboundTrafficStatistics; + IPSEC_TRAFFIC_STATISTICS1 outboundTrafficStatistics; + } IPSEC_STATISTICS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef UINT32 IPSEC_SA_SPI; + +typedef struct IPSEC_SA_AUTH_INFORMATION0_ + { + IPSEC_AUTH_TRANSFORM0 authTransform; + FWP_BYTE_BLOB authKey; + } IPSEC_SA_AUTH_INFORMATION0; + +typedef struct IPSEC_SA_CIPHER_INFORMATION0_ + { + IPSEC_CIPHER_TRANSFORM0 cipherTransform; + FWP_BYTE_BLOB cipherKey; + } IPSEC_SA_CIPHER_INFORMATION0; + +typedef struct IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0_ + { + IPSEC_SA_CIPHER_INFORMATION0 saCipherInformation; + IPSEC_SA_AUTH_INFORMATION0 saAuthInformation; + } IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0; + +typedef struct IPSEC_SA0_ + { + IPSEC_SA_SPI spi; + IPSEC_TRANSFORM_TYPE saTransformType; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_SA_AUTH_INFORMATION0 *ahInformation; + /* [case()][unique] */ IPSEC_SA_AUTH_INFORMATION0 *espAuthInformation; + /* [case()][unique] */ IPSEC_SA_CIPHER_INFORMATION0 *espCipherInformation; + /* [case()][unique] */ IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0 *espAuthAndCipherInformation; + /* [case()][unique] */ IPSEC_SA_AUTH_INFORMATION0 *espAuthFwInformation; + } ; + } IPSEC_SA0; + +typedef struct IPSEC_KEYMODULE_STATE0_ + { + GUID keyModuleKey; + FWP_BYTE_BLOB stateBlob; + } IPSEC_KEYMODULE_STATE0; + +typedef UINT64 IPSEC_TOKEN_HANDLE; + +typedef /* [v1_enum] */ +enum IPSEC_TOKEN_TYPE_ + { + IPSEC_TOKEN_TYPE_MACHINE = 0, + IPSEC_TOKEN_TYPE_IMPERSONATION = ( IPSEC_TOKEN_TYPE_MACHINE + 1 ) , + IPSEC_TOKEN_TYPE_MAX = ( IPSEC_TOKEN_TYPE_IMPERSONATION + 1 ) + } IPSEC_TOKEN_TYPE; + +typedef /* [v1_enum] */ +enum IPSEC_TOKEN_PRINCIPAL_ + { + IPSEC_TOKEN_PRINCIPAL_LOCAL = 0, + IPSEC_TOKEN_PRINCIPAL_PEER = ( IPSEC_TOKEN_PRINCIPAL_LOCAL + 1 ) , + IPSEC_TOKEN_PRINCIPAL_MAX = ( IPSEC_TOKEN_PRINCIPAL_PEER + 1 ) + } IPSEC_TOKEN_PRINCIPAL; + +typedef /* [v1_enum] */ +enum IPSEC_TOKEN_MODE_ + { + IPSEC_TOKEN_MODE_MAIN = 0, + IPSEC_TOKEN_MODE_EXTENDED = ( IPSEC_TOKEN_MODE_MAIN + 1 ) , + IPSEC_TOKEN_MODE_MAX = ( IPSEC_TOKEN_MODE_EXTENDED + 1 ) + } IPSEC_TOKEN_MODE; + +typedef struct IPSEC_TOKEN0_ + { + IPSEC_TOKEN_TYPE type; + IPSEC_TOKEN_PRINCIPAL principal; + IPSEC_TOKEN_MODE mode; + IPSEC_TOKEN_HANDLE token; + } IPSEC_TOKEN0; + +typedef struct IPSEC_ID0_ + { + /* [unique][string] */ wchar_t *mmTargetName; + /* [unique][string] */ wchar_t *emTargetName; + UINT32 numTokens; + /* [unique][size_is] */ IPSEC_TOKEN0 *tokens; + UINT64 explicitCredentials; + UINT64 logonId; + } IPSEC_ID0; + +#define IPSEC_SA_BUNDLE_FLAG_ND_SECURE (0x00000001) +#define IPSEC_SA_BUNDLE_FLAG_ND_BOUNDARY (0x00000002) +#define IPSEC_SA_BUNDLE_FLAG_ND_PEER_NAT_BOUNDARY (0x00000004) +#define IPSEC_SA_BUNDLE_FLAG_GUARANTEE_ENCRYPTION (0x00000008) +#define IPSEC_SA_BUNDLE_FLAG_NLB (0x00000010) +#define IPSEC_SA_BUNDLE_FLAG_NO_MACHINE_LUID_VERIFY (0x00000020) +#define IPSEC_SA_BUNDLE_FLAG_NO_IMPERSONATION_LUID_VERIFY (0x00000040) +#define IPSEC_SA_BUNDLE_FLAG_NO_EXPLICIT_CRED_MATCH (0x00000080) +#define IPSEC_SA_BUNDLE_FLAG_ALLOW_NULL_TARGET_NAME_MATCH (0x00000200) +#define IPSEC_SA_BUNDLE_FLAG_CLEAR_DF_ON_TUNNEL (0x00000400) +#define IPSEC_SA_BUNDLE_FLAG_ASSUME_UDP_CONTEXT_OUTBOUND (0x00000800) +#if (NTDDI_VERSION >= NTDDI_WIN6SP1) +#define IPSEC_SA_BUNDLE_FLAG_ND_PEER_BOUNDARY (0x00001000) +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_SA_BUNDLE_FLAG_SUPPRESS_DUPLICATE_DELETION (0x00002000) +#define IPSEC_SA_BUNDLE_FLAG_PEER_SUPPORTS_GUARANTEE_ENCRYPTION (0x00004000) +#define IPSEC_SA_BUNDLE_FLAG_FORCE_INBOUND_CONNECTIONS (0x00008000) +#define IPSEC_SA_BUNDLE_FLAG_FORCE_OUTBOUND_CONNECTIONS (0x00010000) +#define IPSEC_SA_BUNDLE_FLAG_FORWARD_PATH_INITIATOR (0x00020000) +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_SA_BUNDLE_FLAG_ENABLE_OPTIONAL_ASYMMETRIC_IDLE (0x0040000) +#define IPSEC_SA_BUNDLE_FLAG_USING_DICTATED_KEYS (0x00080000) +#define IPSEC_SA_BUNDLE_FLAG_LOCALLY_DICTATED_KEYS (0x00100000) +#define IPSEC_SA_BUNDLE_FLAG_SA_OFFLOADED (0x00200000) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define IPSEC_SA_BUNDLE_FLAG_IP_IN_IP_PKT (0x00400000) +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +#define IPSEC_SA_BUNDLE_FLAG_LOW_POWER_MODE_SUPPORT (0x00800000) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS5) +#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH1 (0x10000000) +#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH2 (0x20000000) +#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH3 (0x40000000) +#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH4 (0x80000000) +typedef struct IPSEC_SA_BUNDLE0_ + { + UINT32 flags; + IPSEC_SA_LIFETIME0 lifetime; + UINT32 idleTimeoutSeconds; + UINT32 ndAllowClearTimeoutSeconds; + /* [unique] */ IPSEC_ID0 *ipsecId; + UINT32 napContext; + UINT32 qmSaId; + UINT32 numSAs; + /* [unique][size_is] */ IPSEC_SA0 *saList; + /* [unique] */ IPSEC_KEYMODULE_STATE0 *keyModuleState; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 peerV4PrivateAddress; + /* [case()] */ /* Empty union arm */ + } ; + UINT64 mmSaId; + IPSEC_PFS_GROUP pfsGroup; + } IPSEC_SA_BUNDLE0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_BUNDLE1_ + { + UINT32 flags; + IPSEC_SA_LIFETIME0 lifetime; + UINT32 idleTimeoutSeconds; + UINT32 ndAllowClearTimeoutSeconds; + /* [unique] */ IPSEC_ID0 *ipsecId; + UINT32 napContext; + UINT32 qmSaId; + UINT32 numSAs; + /* [unique][size_is] */ IPSEC_SA0 *saList; + /* [unique] */ IPSEC_KEYMODULE_STATE0 *keyModuleState; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 peerV4PrivateAddress; + /* [case()] */ /* Empty union arm */ + } ; + UINT64 mmSaId; + IPSEC_PFS_GROUP pfsGroup; + GUID saLookupContext; + UINT64 qmFilterId; + } IPSEC_SA_BUNDLE1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef /* [v1_enum] */ +enum IPSEC_TRAFFIC_TYPE_ + { + IPSEC_TRAFFIC_TYPE_TRANSPORT = 0, + IPSEC_TRAFFIC_TYPE_TUNNEL = ( IPSEC_TRAFFIC_TYPE_TRANSPORT + 1 ) , + IPSEC_TRAFFIC_TYPE_MAX = ( IPSEC_TRAFFIC_TYPE_TUNNEL + 1 ) + } IPSEC_TRAFFIC_TYPE; + +typedef struct IPSEC_TRAFFIC0_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + IPSEC_TRAFFIC_TYPE trafficType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT64 ipsecFilterId; + /* [case()] */ UINT64 tunnelPolicyId; + } ; + UINT16 remotePort; + } IPSEC_TRAFFIC0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_TRAFFIC1_ + { + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 localV4Address; + /* [case()] */ UINT8 localV6Address[ 16 ]; + } ; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT32 remoteV4Address; + /* [case()] */ UINT8 remoteV6Address[ 16 ]; + } ; + IPSEC_TRAFFIC_TYPE trafficType; + /* [switch_is][switch_type] */ union + { + /* [case()] */ UINT64 ipsecFilterId; + /* [case()] */ UINT64 tunnelPolicyId; + } ; + UINT16 remotePort; + UINT16 localPort; + UINT8 ipProtocol; + UINT64 localIfLuid; + UINT32 realIfProfileId; + } IPSEC_TRAFFIC1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_V4_UDP_ENCAPSULATION0_ + { + UINT16 localUdpEncapPort; + UINT16 remoteUdpEncapPort; + } IPSEC_V4_UDP_ENCAPSULATION0; + +typedef struct IPSEC_GETSPI0_ + { + IPSEC_TRAFFIC0 inboundIpsecTraffic; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *inboundUdpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + /* [unique] */ IPSEC_CRYPTO_MODULE_ID *rngCryptoModuleID; + } IPSEC_GETSPI0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_GETSPI1_ + { + IPSEC_TRAFFIC1 inboundIpsecTraffic; + FWP_IP_VERSION ipVersion; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *inboundUdpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + /* [unique] */ IPSEC_CRYPTO_MODULE_ID *rngCryptoModuleID; + } IPSEC_GETSPI1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_DETAILS0_ + { + FWP_IP_VERSION ipVersion; + FWP_DIRECTION saDirection; + IPSEC_TRAFFIC0 traffic; + IPSEC_SA_BUNDLE0 saBundle; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *udpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + /* [unique] */ FWPM_FILTER0 *transportFilter; + } IPSEC_SA_DETAILS0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_DETAILS1_ + { + FWP_IP_VERSION ipVersion; + FWP_DIRECTION saDirection; + IPSEC_TRAFFIC1 traffic; + IPSEC_SA_BUNDLE1 saBundle; + /* [switch_is][switch_type] */ union + { + /* [case()][unique] */ IPSEC_V4_UDP_ENCAPSULATION0 *udpEncapsulation; + /* [case()] */ /* Empty union arm */ + } ; + /* [unique] */ FWPM_FILTER0 *transportFilter; + IPSEC_VIRTUAL_IF_TUNNEL_INFO0 virtualIfTunnelInfo; + } IPSEC_SA_DETAILS1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_CONTEXT0_ + { + UINT64 saContextId; + /* [unique] */ IPSEC_SA_DETAILS0 *inboundSa; + /* [unique] */ IPSEC_SA_DETAILS0 *outboundSa; + } IPSEC_SA_CONTEXT0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_CONTEXT1_ + { + UINT64 saContextId; + /* [unique] */ IPSEC_SA_DETAILS1 *inboundSa; + /* [unique] */ IPSEC_SA_DETAILS1 *outboundSa; + } IPSEC_SA_CONTEXT1; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +typedef struct IPSEC_SA_CONTEXT_ENUM_TEMPLATE0_ + { + FWP_CONDITION_VALUE0 localSubNet; + FWP_CONDITION_VALUE0 remoteSubNet; + } IPSEC_SA_CONTEXT_ENUM_TEMPLATE0; + +typedef struct IPSEC_SA_ENUM_TEMPLATE0_ + { + FWP_DIRECTION saDirection; + } IPSEC_SA_ENUM_TEMPLATE0; + +typedef struct IPSEC_SA_CONTEXT_SUBSCRIPTION0_ + { + IPSEC_SA_CONTEXT_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; + GUID sessionKey; + } IPSEC_SA_CONTEXT_SUBSCRIPTION0; + +typedef +enum IPSEC_SA_CONTEXT_EVENT_TYPE0_ + { + IPSEC_SA_CONTEXT_EVENT_ADD = 1, + IPSEC_SA_CONTEXT_EVENT_DELETE = ( IPSEC_SA_CONTEXT_EVENT_ADD + 1 ) , + IPSEC_SA_CONTEXT_EVENT_MAX = ( IPSEC_SA_CONTEXT_EVENT_DELETE + 1 ) + } IPSEC_SA_CONTEXT_EVENT_TYPE0; + +typedef struct IPSEC_SA_CONTEXT_CHANGE0_ + { + IPSEC_SA_CONTEXT_EVENT_TYPE0 changeType; + UINT64 saContextId; + } IPSEC_SA_CONTEXT_CHANGE0; + +typedef /* [v1_enum] */ +enum IPSEC_FAILURE_POINT_ + { + IPSEC_FAILURE_NONE = 0, + IPSEC_FAILURE_ME = ( IPSEC_FAILURE_NONE + 1 ) , + IPSEC_FAILURE_PEER = ( IPSEC_FAILURE_ME + 1 ) , + IPSEC_FAILURE_POINT_MAX = ( IPSEC_FAILURE_PEER + 1 ) + } IPSEC_FAILURE_POINT; + +typedef struct IPSEC_ADDRESS_INFO0_ + { + UINT32 numV4Addresses; + /* [unique][size_is] */ UINT32 *v4Addresses; + UINT32 numV6Addresses; + /* [unique][size_is] */ FWP_BYTE_ARRAY16 *v6Addresses; + } IPSEC_ADDRESS_INFO0; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define IPSEC_DOSP_FLAG_ENABLE_IKEV1 (0x00000001) +#define IPSEC_DOSP_FLAG_ENABLE_IKEV2 (0x00000002) +#define IPSEC_DOSP_FLAG_DISABLE_AUTHIP (0x00000004) +#define IPSEC_DOSP_FLAG_DISABLE_DEFAULT_BLOCK (0x00000008) +#define IPSEC_DOSP_FLAG_FILTER_BLOCK (0x00000010) +#define IPSEC_DOSP_FLAG_FILTER_EXEMPT (0x00000020) +#define IPSEC_DOSP_DSCP_DISABLE_VALUE (0xff) +#define IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE (0) +typedef struct IPSEC_DOSP_OPTIONS0_ + { + UINT32 stateIdleTimeoutSeconds; + UINT32 perIPRateLimitQueueIdleTimeoutSeconds; + UINT8 ipV6IPsecUnauthDscp; + UINT32 ipV6IPsecUnauthRateLimitBytesPerSec; + UINT32 ipV6IPsecUnauthPerIPRateLimitBytesPerSec; + UINT8 ipV6IPsecAuthDscp; + UINT32 ipV6IPsecAuthRateLimitBytesPerSec; + UINT8 icmpV6Dscp; + UINT32 icmpV6RateLimitBytesPerSec; + UINT8 ipV6FilterExemptDscp; + UINT32 ipV6FilterExemptRateLimitBytesPerSec; + UINT8 defBlockExemptDscp; + UINT32 defBlockExemptRateLimitBytesPerSec; + UINT32 maxStateEntries; + UINT32 maxPerIPRateLimitQueues; + UINT32 flags; + UINT32 numPublicIFLuids; + /* [unique][size_is] */ UINT64 *publicIFLuids; + UINT32 numInternalIFLuids; + /* [unique][size_is] */ UINT64 *internalIFLuids; + FWP_V6_ADDR_AND_MASK publicV6AddrMask; + FWP_V6_ADDR_AND_MASK internalV6AddrMask; + } IPSEC_DOSP_OPTIONS0; + +typedef struct IPSEC_DOSP_STATISTICS0_ + { + UINT64 totalStateEntriesCreated; + UINT64 currentStateEntries; + UINT64 totalInboundAllowedIPv6IPsecUnauthPkts; + UINT64 totalInboundRatelimitDiscardedIPv6IPsecUnauthPkts; + UINT64 totalInboundPerIPRatelimitDiscardedIPv6IPsecUnauthPkts; + UINT64 totalInboundOtherDiscardedIPv6IPsecUnauthPkts; + UINT64 totalInboundAllowedIPv6IPsecAuthPkts; + UINT64 totalInboundRatelimitDiscardedIPv6IPsecAuthPkts; + UINT64 totalInboundOtherDiscardedIPv6IPsecAuthPkts; + UINT64 totalInboundAllowedICMPv6Pkts; + UINT64 totalInboundRatelimitDiscardedICMPv6Pkts; + UINT64 totalInboundAllowedIPv6FilterExemptPkts; + UINT64 totalInboundRatelimitDiscardedIPv6FilterExemptPkts; + UINT64 totalInboundDiscardedIPv6FilterBlockPkts; + UINT64 totalInboundAllowedDefBlockExemptPkts; + UINT64 totalInboundRatelimitDiscardedDefBlockExemptPkts; + UINT64 totalInboundDiscardedDefBlockPkts; + UINT64 currentInboundIPv6IPsecUnauthPerIPRateLimitQueues; + } IPSEC_DOSP_STATISTICS0; + +typedef struct IPSEC_DOSP_STATE0_ + { + UINT8 publicHostV6Addr[ 16 ]; + UINT8 internalHostV6Addr[ 16 ]; + UINT64 totalInboundIPv6IPsecAuthPackets; + UINT64 totalOutboundIPv6IPsecAuthPackets; + UINT32 durationSecs; + } IPSEC_DOSP_STATE0; + +typedef struct IPSEC_DOSP_STATE_ENUM_TEMPLATE0_ + { + FWP_V6_ADDR_AND_MASK publicV6AddrMask; + FWP_V6_ADDR_AND_MASK internalV6AddrMask; + } IPSEC_DOSP_STATE_ENUM_TEMPLATE0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define IPSEC_KEY_MANAGER_FLAG_DICTATE_KEY (0x00000001) +typedef struct _IPSEC_KEY_MANAGER0 + { + GUID keyManagerKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + UINT8 keyDictationTimeoutHint; + } IPSEC_KEY_MANAGER0; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) +#if _MSC_VER >= 800 +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */ +#pragma endregion + + +extern RPC_IF_HANDLE __MIDL_itf_ipsectypes_0000_0000_v0_0_c_ifspec; +extern RPC_IF_HANDLE __MIDL_itf_ipsectypes_0000_0000_v0_0_s_ifspec; + +/* Additional Prototypes for ALL interfaces */ + +/* end of Additional Prototypes */ + +#ifdef __cplusplus +} +#endif + +#endif + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.idl b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.idl new file mode 100644 index 0000000000000000000000000000000000000000..ca9befba6c28f30f1a86d4cdfca893311fa4cfaa --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipsectypes.idl @@ -0,0 +1,1573 @@ +/* + Copyright (c) Microsoft Corporation + + SYNOPSIS + + Defines data types used by IPsec. +*/ +cpp_quote("#include ") + +#pragma region Desktop Family or AppRuntime Package +cpp_quote("#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME)") + + +import "fwptypes.idl"; +import "iketypes.idl"; + + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(push)") +cpp_quote("#endif") +cpp_quote("#pragma warning(disable:4201)") +cpp_quote("#endif") + +typedef struct FWPM_FILTER0_ FWPM_FILTER0; +typedef struct FWPM_DISPLAY_DATA0_ FWPM_DISPLAY_DATA0; + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building IPsec policies. +// +/////////////////////////////////////////////////////////////////////////////// + +// Stores the lifetime in seconds/kilobytes/packets for an IPsec SA. +typedef struct IPSEC_SA_LIFETIME0_ +{ + UINT32 lifetimeSeconds; + UINT32 lifetimeKilobytes; + UINT32 lifetimePackets; +} IPSEC_SA_LIFETIME0; + +// Indicates the type of an IPsec SA transform. +typedef [v1_enum] enum IPSEC_TRANSFORM_TYPE_ +{ + IPSEC_TRANSFORM_AH=1, + IPSEC_TRANSFORM_ESP_AUTH, + IPSEC_TRANSFORM_ESP_CIPHER, + IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER, + IPSEC_TRANSFORM_ESP_AUTH_FW, + IPSEC_TRANSFORM_TYPE_MAX +} IPSEC_TRANSFORM_TYPE; + +// Indicates the type of hash algorithm used in an IPsec SA for data origin +// authentication and integrity protection. +typedef [v1_enum] enum IPSEC_AUTH_TYPE_ +{ + IPSEC_AUTH_MD5, + IPSEC_AUTH_SHA_1, + IPSEC_AUTH_SHA_256, + IPSEC_AUTH_AES_128, + IPSEC_AUTH_AES_192, + IPSEC_AUTH_AES_256, + IPSEC_AUTH_MAX +} IPSEC_AUTH_TYPE; + +// Type used to specify additional configuration information for an IPsec SA +// hash algorithm. +typedef UINT8 IPSEC_AUTH_CONFIG; + +// Various values allowed for this type. +cpp_quote("#define IPSEC_AUTH_CONFIG_HMAC_MD5_96 (0)") +cpp_quote("#define IPSEC_AUTH_CONFIG_HMAC_SHA_1_96 (1)") +cpp_quote("#define IPSEC_AUTH_CONFIG_HMAC_SHA_256_128 (2)") +cpp_quote("#define IPSEC_AUTH_CONFIG_GCM_AES_128 (3)") +cpp_quote("#define IPSEC_AUTH_CONFIG_GCM_AES_192 (4)") +cpp_quote("#define IPSEC_AUTH_CONFIG_GCM_AES_256 (5)") +cpp_quote("#define IPSEC_AUTH_CONFIG_MAX (6)") + +// Type used to uniquely identify the hash algorithm used in an IPsec SA. +typedef struct IPSEC_AUTH_TRANSFORM_ID0_ +{ + // The type of the hash algorithm. + IPSEC_AUTH_TYPE authType; + // Additional configuration information for the hash algorithm. + IPSEC_AUTH_CONFIG authConfig; +} IPSEC_AUTH_TRANSFORM_ID0; + +// Type used to store identifier of a pluggable crypto module. +typedef GUID IPSEC_CRYPTO_MODULE_ID; + +// Type used to store hash specific information for an SA transform. +typedef struct IPSEC_AUTH_TRANSFORM0_ +{ + // The identifier of the hash algorithm. + IPSEC_AUTH_TRANSFORM_ID0 authTransformId; + // The idenitifier of the pluggable crypto module that should implement this + // hash transform. + [unique] IPSEC_CRYPTO_MODULE_ID* cryptoModuleId; +} IPSEC_AUTH_TRANSFORM0; + +// Indicates the type of encryption algorithm used in an IPsec SA for data +// privacy. +typedef [v1_enum] enum IPSEC_CIPHER_TYPE_ +{ + IPSEC_CIPHER_TYPE_DES=1, + IPSEC_CIPHER_TYPE_3DES, + IPSEC_CIPHER_TYPE_AES_128, + IPSEC_CIPHER_TYPE_AES_192, + IPSEC_CIPHER_TYPE_AES_256, + IPSEC_CIPHER_TYPE_MAX +} IPSEC_CIPHER_TYPE; + +// Type used to specify additional configuration information for an IPsec SA +// encryption algorithm. +typedef UINT8 IPSEC_CIPHER_CONFIG; + +// Various values allowed for this type. +cpp_quote("#define IPSEC_CIPHER_CONFIG_CBC_DES (1)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_CBC_3DES (2)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_CBC_AES_128 (3)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_CBC_AES_192 (4)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_CBC_AES_256 (5)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_GCM_AES_128 (6)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_GCM_AES_192 (7)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_GCM_AES_256 (8)") +cpp_quote("#define IPSEC_CIPHER_CONFIG_MAX (9)") + +// Type used to uniquely identify the encryption algorithm used in an IPsec SA. +typedef struct IPSEC_CIPHER_TRANSFORM_ID0_ +{ + // The type of the encryption algorithm. + IPSEC_CIPHER_TYPE cipherType; + // Additional configuration information for the encryption algorithm. + IPSEC_CIPHER_CONFIG cipherConfig; +} IPSEC_CIPHER_TRANSFORM_ID0; + +// Type used to store encryption specific information for an SA transform. +typedef struct IPSEC_CIPHER_TRANSFORM0_ +{ + // The identifier of the encryption algorithm. + IPSEC_CIPHER_TRANSFORM_ID0 cipherTransformId; + // The idenitifier of the pluggable crypto module that should implement this + // encryption transform. + [unique] IPSEC_CRYPTO_MODULE_ID* cryptoModuleId; +} IPSEC_CIPHER_TRANSFORM0; + +// Type used to store hash and encryption specific information together for an +// SA transform. +typedef struct IPSEC_AUTH_AND_CIPHER_TRANSFORM0_ +{ + // Hash specific information + IPSEC_AUTH_TRANSFORM0 authTransform; + // encryption specific information + IPSEC_CIPHER_TRANSFORM0 cipherTransform; +} IPSEC_AUTH_AND_CIPHER_TRANSFORM0; + +// Type used to store an SA transform. +typedef struct IPSEC_SA_TRANSFORM0_ +{ + // Type of the transform. + IPSEC_TRANSFORM_TYPE ipsecTransformType; + // Tagged union containing transform type specific data. + [switch_type(IPSEC_TRANSFORM_TYPE), + switch_is(ipsecTransformType)] union + { + [case(IPSEC_TRANSFORM_AH)] + [unique] IPSEC_AUTH_TRANSFORM0* ahTransform; + [case(IPSEC_TRANSFORM_ESP_AUTH)] + [unique] IPSEC_AUTH_TRANSFORM0* espAuthTransform; + [case(IPSEC_TRANSFORM_ESP_CIPHER)] + [unique] IPSEC_CIPHER_TRANSFORM0* espCipherTransform; + [case(IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER)] + [unique] IPSEC_AUTH_AND_CIPHER_TRANSFORM0* espAuthAndCipherTransform; + [case(IPSEC_TRANSFORM_ESP_AUTH_FW)] + [unique] IPSEC_AUTH_TRANSFORM0* espAuthFwTransform; + + }; +} IPSEC_SA_TRANSFORM0; + +// Workaround for typo in older version of the header. +cpp_quote("#define espAuthTranform espAuthTransform") + +// Type that specifies the Diffie Hellman algorithm that should be used for +// Quick Mode PFS (Perfect Forward Secrecy). +typedef [v1_enum] enum IPSEC_PFS_GROUP_ +{ + // No PFS needed. + IPSEC_PFS_NONE = 0, + IPSEC_PFS_1, + IPSEC_PFS_2, + IPSEC_PFS_2048, + IPSEC_PFS_14 = IPSEC_PFS_2048, + IPSEC_PFS_ECP_256, + IPSEC_PFS_ECP_384, + // Use the same diffie hellman as the Main Mode that contains this quick + // mode. + IPSEC_PFS_MM, + IPSEC_PFS_24, + IPSEC_PFS_MAX +} IPSEC_PFS_GROUP; + +// Type used to store an IPsec quick mode proposal. The proposal describes the +// various parameters of the IPsec SA that is potentially generated from this +// proposal. +typedef struct IPSEC_PROPOSAL0_ +{ + // Lifetime of the IPsec SA + IPSEC_SA_LIFETIME0 lifetime; + // Number of IPsec SA transforms + UINT32 numSaTransforms; + // Array of IPsec SA transforms + [size_is(numSaTransforms), ref] IPSEC_SA_TRANSFORM0* saTransforms; + // PFS group of the IPsec SA + IPSEC_PFS_GROUP pfsGroup; +} IPSEC_PROPOSAL0; + +// Type used to specify the SA idle timeout in IPsec policy. +typedef struct IPSEC_SA_IDLE_TIMEOUT0_ +{ + // Timeout in seconds after which the IPsec SAs in the bundle should idle + // out. + UINT32 idleTimeoutSeconds; + // Timeout in seconds after which the IPsec SAs in the bundle should idle + // out, if the peer machine supports fail over (NLBS, cluster, etc). + UINT32 idleTimeoutSecondsFailOver; +} IPSEC_SA_IDLE_TIMEOUT0; + +typedef struct IPSEC_TRAFFIC_SELECTOR0_ +{ + UINT8 protocolId; + UINT16 portStart; + UINT16 portEnd; + + // IP version + FWP_IP_VERSION ipVersion; + // Tagged union containing the starting address of the IPsec traffic selector + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 startV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 startV6Address[16]; + }; + // Tagged union containing the ending address of the IPsec traffic selector + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 endV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 endV6Address[16]; + }; +}IPSEC_TRAFFIC_SELECTOR0; + +typedef struct IPSEC_TRAFFIC_SELECTOR_POLICY0_ +{ + // Flags + UINT32 flags; + // Number of local traffic selectors + UINT32 numLocalTrafficSelectors; + // Array of traffic selectors + [size_is(numLocalTrafficSelectors), unique] IPSEC_TRAFFIC_SELECTOR0 * localTrafficSelectors; + // Number of remote traffic selectors + UINT32 numRemoteTrafficSelectors; + // Array of traffic selectors + [size_is(numRemoteTrafficSelectors), unique] IPSEC_TRAFFIC_SELECTOR0 * remoteTrafficSelectors; +} IPSEC_TRAFFIC_SELECTOR_POLICY0; + +////////// +// Flags specifying policy characteristics. +////////// + +// Do negotiation discovery in secure ring. +cpp_quote("#define IPSEC_POLICY_FLAG_ND_SECURE (0x00000002)") +// Do negotiation discovery on the perimeter network. +cpp_quote("#define IPSEC_POLICY_FLAG_ND_BOUNDARY (0x00000004)") +// Clear the "DontFragment" bit on the outer IP header of an IPsec tunneled +// packet. Applicable only to tunnel mode policy. +cpp_quote("#define IPSEC_POLICY_FLAG_CLEAR_DF_ON_TUNNEL (0x00000008)") + +// The 2 flags below are used to control the IPsec behavior for assuming default +// encapsulation ports {4500, 4500} when matching an SA (negotiated using this +// policy) with packets on outbound connections that don't have an associated +// IPsec-NAT-shim context. Note that this rule comes into play only when a NAT +// is detected. By default, if neither of the 2 flags are specified, IPsec is +// most secure and assumes default ports only when local machine is behind NAT +// and remote machine is not (which is the most common case). +// +// If this flag is specified, IPsec assumes default ports when either local +// machine or remote machine is behind NAT, but not both. Behavior becomes less +// secure but more flexible. +cpp_quote("#define IPSEC_POLICY_FLAG_NAT_ENCAP_ALLOW_PEER_BEHIND_NAT (0x00000010)") +// If this flag is specified, IPsec assumes default ports when either local +// machine or remote machine is behind NAT, or even when both are behind NATs. +// Behavior becomes least secure but most flexible. +cpp_quote("#define IPSEC_POLICY_FLAG_NAT_ENCAP_ALLOW_GENERAL_NAT_TRAVERSAL (0x00000020)") + +// If this flag is specified, IKE will not send the ISAKMP attribute for 'seconds' +// lifetime during quick mode negotiation. This flag is useful when +// interoperating with 3rd party devices that dont support 'seconds' lifetime. +cpp_quote("#define IPSEC_POLICY_FLAG_DONT_NEGOTIATE_SECOND_LIFETIME (0x00000040)") +// If this flag is specified, IKE will not send the ISAKMP attribute for 'byte' +// lifetime during quick mode negotiation. This flag is useful when +// interoperating with 3rd party devices that dont support 'byte' lifetime. +cpp_quote("#define IPSEC_POLICY_FLAG_DONT_NEGOTIATE_BYTE_LIFETIME (0x00000080)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Negotiate IPv6 inside IPv4 IPsec tunneling. Applicable only for tunnel mode +// policy, and currently supported only by IKEv2. +cpp_quote("#define IPSEC_POLICY_FLAG_ENABLE_V6_IN_V4_TUNNELING (0x00000100)") +// Enable calls to RAS VPN server for address assignment. Applicable only for +// tunnel mode policy, and supported only by IKEv2. +cpp_quote("#define IPSEC_POLICY_FLAG_ENABLE_SERVER_ADDR_ASSIGNMENT (0x00000200)") +// Allow outbound connections to go in clear-text. Applicable only for tunnel +// mode policy on a tunnel gateway. Don't set this flag on a tunnel client. +cpp_quote("#define IPSEC_POLICY_FLAG_TUNNEL_ALLOW_OUTBOUND_CLEAR_CONNECTION (0x00000400)") +// Allow traffic that is already IPsec related (ESP, or UDP 500/4500) to bypass +// the tunnel . Applicable only for tunnel mode policy. +cpp_quote("#define IPSEC_POLICY_FLAG_TUNNEL_BYPASS_ALREADY_SECURE_CONNECTION (0x00000800)") +// Allow ICMPv6 traffic to bypass the tunnel. Applicable only for tunnel mode +// policy. +cpp_quote("#define IPSEC_POLICY_FLAG_TUNNEL_BYPASS_ICMPV6 (0x00001000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// If set, allows the local TIA to dictate key +cpp_quote("#define IPSEC_POLICY_FLAG_KEY_MANAGER_ALLOW_DICTATE_KEY (0x00002000)") +// If set, allows the local TIA to receive key notifications +cpp_quote("#define IPSEC_POLICY_FLAG_KEY_MANAGER_ALLOW_NOTIFY_KEY (0x00004000)") +cpp_quote("#define IPSEC_POLICY_FLAG_RESERVED1 (0x00008000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS3)") +// site to site tunnel mode IPsec policy +cpp_quote("#define IPSEC_POLICY_FLAG_SITE_TO_SITE_TUNNEL (0x00010000)") +cpp_quote("#endif // (NTDDI_VERSION > NTDDI_WIN10_RS3)") + +cpp_quote("#define IPSEC_POLICY_FLAG_POINT_TO_SITE_TUNNEL (0x00020000)") + +cpp_quote("#define IPSEC_POLICY_FLAG_BANDWIDTH1 (0x10000000)") +cpp_quote("#define IPSEC_POLICY_FLAG_BANDWIDTH2 (0x20000000)") +cpp_quote("#define IPSEC_POLICY_FLAG_BANDWIDTH3 (0x40000000)") +cpp_quote("#define IPSEC_POLICY_FLAG_BANDWIDTH4 (0x80000000)") + +// Type used to store transport mode quick mode negotiation policy +typedef struct IPSEC_TRANSPORT_POLICY0_ +{ + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Flags + UINT32 flags; + // Timeout in seconds, after which the IPsec SA should stop accepting + // packets coming in the clear. Used for negotiation discovery. + UINT32 ndAllowClearTimeoutSeconds; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY0* emPolicy; +} IPSEC_TRANSPORT_POLICY0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type used to store transport mode quick mode negotiation policy +typedef struct IPSEC_TRANSPORT_POLICY1_ +{ + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Flags + UINT32 flags; + // Timeout in seconds, after which the IPsec SA should stop accepting + // packets coming in the clear. Used for negotiation discovery. + UINT32 ndAllowClearTimeoutSeconds; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY1* emPolicy; +} IPSEC_TRANSPORT_POLICY1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-1 of type used to store transport mode quick mode negotiation policy +typedef struct IPSEC_TRANSPORT_POLICY2_ +{ + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Flags + UINT32 flags; + // Timeout in seconds, after which the IPsec SA should stop accepting + // packets coming in the clear. Used for negotiation discovery. + UINT32 ndAllowClearTimeoutSeconds; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY2* emPolicy; +} IPSEC_TRANSPORT_POLICY2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +// Type used to store end points of a tunnel mode SA +typedef struct IPSEC_TUNNEL_ENDPOINTS0_ +{ + // IP version of the addresses + FWP_IP_VERSION ipVersion; + // Tagged union containing the local tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; +} IPSEC_TUNNEL_ENDPOINTS0; + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +typedef struct IPSEC_TUNNEL_ENDPOINT0_ +{ + // IP version of the addresses + FWP_IP_VERSION ipVersion; + // Tagged union containing the local tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 v4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 v6Address[16]; + }; +} IPSEC_TUNNEL_ENDPOINT0; + +typedef struct IPSEC_TUNNEL_ENDPOINTS2_ +{ + // IP version of the addresses + FWP_IP_VERSION ipVersion; + // Tagged union containing the local tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + // Optional LUID of the local interface corresponding to the local address + // specified above. + UINT64 localIfLuid; + + // Allows configuration of multiple remote addresses and FQDN for asymmetric tunneling support + // If set, these settings obviate the remoteV4/V6 address fields above + [string, unique] wchar_t* remoteFqdn; + UINT32 numAddresses; + [size_is(numAddresses)] IPSEC_TUNNEL_ENDPOINT0* remoteAddresses; + +} IPSEC_TUNNEL_ENDPOINTS2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Type used to store end points of a tunnel mode SA +typedef struct IPSEC_TUNNEL_ENDPOINTS1_ +{ + // IP version of the addresses + FWP_IP_VERSION ipVersion; + // Tagged union containing the local tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote tunnel end point address. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + // Optional LUID of the local interface corresponding to the local address + // specified above. + UINT64 localIfLuid; +} IPSEC_TUNNEL_ENDPOINTS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Type used to store tunnel mode quick mode negotiation policy +typedef struct IPSEC_TUNNEL_POLICY0_ +{ + // Flags + UINT32 flags; + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Tunnel end points of the IPsec SA generated from this policy. + IPSEC_TUNNEL_ENDPOINTS0 tunnelEndpoints; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY0* emPolicy; +} IPSEC_TUNNEL_POLICY0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type used to store tunnel mode quick mode negotiation policy +typedef struct IPSEC_TUNNEL_POLICY1_ +{ + // Flags + UINT32 flags; + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Tunnel end points of the IPsec SA generated from this policy. + IPSEC_TUNNEL_ENDPOINTS1 tunnelEndpoints; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY1* emPolicy; +} IPSEC_TUNNEL_POLICY1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Version-1 of type used to store tunnel mode quick mode negotiation policy +typedef struct IPSEC_TUNNEL_POLICY2_ +{ + // Flags + UINT32 flags; + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Tunnel end points of the IPsec SA generated from this policy. + IPSEC_TUNNEL_ENDPOINTS2 tunnelEndpoints; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY2* emPolicy; + // If non-0, specifies the lifetime in seconds for SA initiated by traffic on the forward path + UINT32 fwdPathSaLifetime; +} IPSEC_TUNNEL_POLICY2; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS3)") +// Version-3 of type used to store compartment Id for the tunnel policy +typedef struct IPSEC_TUNNEL_POLICY3_ +{ + // Flags + UINT32 flags; + // Number of quick mode proposals in the policy + UINT32 numIpsecProposals; + // Array of quick mode proposals. + [size_is(numIpsecProposals), ref] IPSEC_PROPOSAL0* ipsecProposals; + // Tunnel end points of the IPsec SA generated from this policy. + IPSEC_TUNNEL_ENDPOINTS2 tunnelEndpoints; + // The SA idle timeout + IPSEC_SA_IDLE_TIMEOUT0 saIdleTimeout; + // The Authip extended mode authentication policy + [unique] IKEEXT_EM_POLICY2* emPolicy; + // If non-0, specifies the lifetime in seconds for SA initiated by traffic on the forward path + UINT32 fwdPathSaLifetime; + // If non-0, specifies the Compartment Id for the Tunnel Policy + UINT32 compartmentId; + // Number of traffic selector policies + UINT32 numTrafficSelectorPolicy; + // Array of traffic selectors + [size_is(numTrafficSelectorPolicy), unique] IPSEC_TRAFFIC_SELECTOR_POLICY0 * trafficSelectorPolicies; +} IPSEC_TUNNEL_POLICY3; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3)") + +// Defines an unordered set of keying modules that will be tried for IPsec. +typedef struct IPSEC_KEYING_POLICY0_ +{ + // Array of allowed keying modules. + UINT32 numKeyMods; + [size_is(numKeyMods), ref] GUID* keyModKeys; +} IPSEC_KEYING_POLICY0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +// Force the use of a Kerberos proxy server when acting as initiator. +cpp_quote("#define IPSEC_KEYING_POLICY_FLAG_TERMINATING_MATCH (0x00000001)") + +// Defines an unordered set of keying modules that will be tried for IPsec. +typedef struct IPSEC_KEYING_POLICY1_ +{ + // Array of allowed keying modules. + UINT32 numKeyMods; + [size_is(numKeyMods), ref] GUID* keyModKeys; + UINT32 flags; +} IPSEC_KEYING_POLICY1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for retrieving IPsec statistics. +// +/////////////////////////////////////////////////////////////////////////////// + +typedef struct IPSEC_AGGREGATE_SA_STATISTICS0_ +{ + UINT32 activeSas; + UINT32 pendingSaNegotiations; + UINT32 totalSasAdded; + UINT32 totalSasDeleted; + UINT32 successfulRekeys ; + UINT32 activeTunnels; + UINT32 offloadedSas; +} IPSEC_AGGREGATE_SA_STATISTICS0; + +typedef struct IPSEC_ESP_DROP_PACKET_STATISTICS0_ +{ + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 saNotInitializedOnInbound; +} IPSEC_ESP_DROP_PACKET_STATISTICS0; + +typedef struct IPSEC_AH_DROP_PACKET_STATISTICS0_ +{ + UINT32 invalidSpisOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 saNotInitializedOnInbound; +} IPSEC_AH_DROP_PACKET_STATISTICS0; + +typedef struct IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0_ +{ + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 udpEspValidationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 invalidClearTextInbound; + UINT32 saNotInitializedOnInbound; + UINT32 receiveOverIncorrectSaInbound; + UINT32 secureReceivesNotMatchingFilters; +}IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +typedef struct IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1_ +{ + UINT32 invalidSpisOnInbound; + UINT32 decryptionFailuresOnInbound; + UINT32 authenticationFailuresOnInbound; + UINT32 udpEspValidationFailuresOnInbound; + UINT32 replayCheckFailuresOnInbound; + UINT32 invalidClearTextInbound; + UINT32 saNotInitializedOnInbound; + UINT32 receiveOverIncorrectSaInbound; + UINT32 secureReceivesNotMatchingFilters; + UINT32 totalDropPacketsInbound; +}IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +typedef struct IPSEC_TRAFFIC_STATISTICS0_ +{ + UINT64 encryptedByteCount; + UINT64 authenticatedAHByteCount; + UINT64 authenticatedESPByteCount; + UINT64 transportByteCount; + UINT64 tunnelByteCount; + UINT64 offloadByteCount; +} IPSEC_TRAFFIC_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +typedef struct IPSEC_TRAFFIC_STATISTICS1_ +{ + UINT64 encryptedByteCount; + UINT64 authenticatedAHByteCount; + UINT64 authenticatedESPByteCount; + UINT64 transportByteCount; + UINT64 tunnelByteCount; + UINT64 offloadByteCount; + UINT64 totalSuccessfulPackets; +} IPSEC_TRAFFIC_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +typedef struct IPSEC_STATISTICS0_ +{ + IPSEC_AGGREGATE_SA_STATISTICS0 aggregateSaStatistics; + IPSEC_ESP_DROP_PACKET_STATISTICS0 espDropPacketStatistics; + IPSEC_AH_DROP_PACKET_STATISTICS0 ahDropPacketStatistics; + IPSEC_AGGREGATE_DROP_PACKET_STATISTICS0 aggregateDropPacketStatistics; + IPSEC_TRAFFIC_STATISTICS0 inboundTrafficStatistics; + IPSEC_TRAFFIC_STATISTICS0 outboundTrafficStatistics; +} IPSEC_STATISTICS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +typedef struct IPSEC_STATISTICS1_ +{ + IPSEC_AGGREGATE_SA_STATISTICS0 aggregateSaStatistics; + IPSEC_ESP_DROP_PACKET_STATISTICS0 espDropPacketStatistics; + IPSEC_AH_DROP_PACKET_STATISTICS0 ahDropPacketStatistics; + IPSEC_AGGREGATE_DROP_PACKET_STATISTICS1 aggregateDropPacketStatistics; + IPSEC_TRAFFIC_STATISTICS1 inboundTrafficStatistics; + IPSEC_TRAFFIC_STATISTICS1 outboundTrafficStatistics; +} IPSEC_STATISTICS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for building IPsec SA bundles. +// +/////////////////////////////////////////////////////////////////////////////// + +// Type used to store the SPI for an IPsec SA. +typedef UINT32 IPSEC_SA_SPI; + +// Type used to store hash specific information for an IPsec SA. +typedef struct IPSEC_SA_AUTH_INFORMATION0_ +{ + // Hash algorithm specific details + IPSEC_AUTH_TRANSFORM0 authTransform; + // Key used for the hash algorithm. + FWP_BYTE_BLOB authKey; +} IPSEC_SA_AUTH_INFORMATION0; + +// Type used to store encryption specific information for an IPsec SA. +typedef struct IPSEC_SA_CIPHER_INFORMATION0_ +{ + // Encryption algorithm specific details + IPSEC_CIPHER_TRANSFORM0 cipherTransform; + // Key used for the encryption algorithm. + FWP_BYTE_BLOB cipherKey; +} IPSEC_SA_CIPHER_INFORMATION0; + +// Type used to store hash and encryption specific information for an IPsec SA. +typedef struct IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0_ +{ + // Encryption specific information + IPSEC_SA_CIPHER_INFORMATION0 saCipherInformation; + // Hash specific information + IPSEC_SA_AUTH_INFORMATION0 saAuthInformation; +} IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0; + +// Type to store information about an IPsec SA +typedef struct IPSEC_SA0_ +{ + // SPI of the SA + IPSEC_SA_SPI spi; + // Transform type of the SA + IPSEC_TRANSFORM_TYPE saTransformType; + // Tagged union containing information about the SA transform. + [switch_type(IPSEC_TRANSFORM_TYPE), switch_is(saTransformType)] union + { + [case(IPSEC_TRANSFORM_AH)] + [unique] IPSEC_SA_AUTH_INFORMATION0* ahInformation; + [case(IPSEC_TRANSFORM_ESP_AUTH)] + [unique] IPSEC_SA_AUTH_INFORMATION0* espAuthInformation; + [case(IPSEC_TRANSFORM_ESP_CIPHER)] + [unique] IPSEC_SA_CIPHER_INFORMATION0* espCipherInformation; + [case(IPSEC_TRANSFORM_ESP_AUTH_AND_CIPHER)] + [unique] IPSEC_SA_AUTH_AND_CIPHER_INFORMATION0* espAuthAndCipherInformation; + [case(IPSEC_TRANSFORM_ESP_AUTH_FW)] + [unique] IPSEC_SA_AUTH_INFORMATION0* espAuthFwInformation; + }; +} IPSEC_SA0; + +// Type used to store keying module specific information in the SA. +typedef struct IPSEC_KEYMODULE_STATE0_ +{ + // The identifier of the keying module. + GUID keyModuleKey; + // A byte blob containing opaques keying module specific information. + FWP_BYTE_BLOB stateBlob; +} IPSEC_KEYMODULE_STATE0; + +// Type used to store handle to an access token. +typedef UINT64 IPSEC_TOKEN_HANDLE; + +typedef [v1_enum] enum IPSEC_TOKEN_TYPE_ +{ + IPSEC_TOKEN_TYPE_MACHINE, + IPSEC_TOKEN_TYPE_IMPERSONATION, + IPSEC_TOKEN_TYPE_MAX +} IPSEC_TOKEN_TYPE; + +typedef [v1_enum] enum IPSEC_TOKEN_PRINCIPAL_ +{ + IPSEC_TOKEN_PRINCIPAL_LOCAL, + IPSEC_TOKEN_PRINCIPAL_PEER, + IPSEC_TOKEN_PRINCIPAL_MAX +} IPSEC_TOKEN_PRINCIPAL; + +typedef [v1_enum] enum IPSEC_TOKEN_MODE_ +{ + IPSEC_TOKEN_MODE_MAIN, + IPSEC_TOKEN_MODE_EXTENDED, + IPSEC_TOKEN_MODE_MAX +} IPSEC_TOKEN_MODE; + +// Type containing various pieces of IPsec-specific information for an access +// token +typedef struct IPSEC_TOKEN0_ +{ + // Type of the token + IPSEC_TOKEN_TYPE type; + // Token principal + IPSEC_TOKEN_PRINCIPAL principal; + // Mode in which token was obtained + IPSEC_TOKEN_MODE mode; + // This can be the handle to an access token or the + // TOKEN_STATISTICS.ModifiedId of an access token depending on the context + // in which this type is being used. + IPSEC_TOKEN_HANDLE token; +} IPSEC_TOKEN0; + +// Type containing various pieces of information corresponding to identities +// that are authenticated by IPsec. +typedef struct IPSEC_ID0_ +{ + // Optional Main Mode target SPN + [string, unique] wchar_t* mmTargetName; + // Optional Extended Mode target SPN + [string, unique] wchar_t* emTargetName; + + // Optional array of IPsec tokens + UINT32 numTokens; + [size_is(numTokens), unique] IPSEC_TOKEN0* tokens; + + // Optional handle to explicit credentials + UINT64 explicitCredentials; + + // Unused parameter, it should always be 0. + UINT64 logonId; + +} IPSEC_ID0; + +////////// +// Flags specifying IPsec SA characteristics. +////////// + +// Negotiation discovery is enabled in secure ring. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ND_SECURE (0x00000001)") +// Negotiation discovery is enabled on the perimeter network. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ND_BOUNDARY (0x00000002)") +// Peer is on a perimeter network and a NAT is in the way. Used with +// negotiation discovery. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ND_PEER_NAT_BOUNDARY (0x00000004)") +// Is a guarantee encryption SA +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_GUARANTEE_ENCRYPTION (0x00000008)") +// Is SA to NLB server +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_NLB (0x00000010)") +// Should SA bypass machine luid verification +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_NO_MACHINE_LUID_VERIFY (0x00000020)") +// Should SA bypass impersonation luid verification +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_NO_IMPERSONATION_LUID_VERIFY (0x00000040)") +// Should SA bypass explicit credential handle match +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_NO_EXPLICIT_CRED_MATCH (0x00000080)") +// Let SA formed with peer name carry traffic that doesn't have a +// peer target associated with it +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ALLOW_NULL_TARGET_NAME_MATCH (0x00000200)") +// Clear the "DontFragment" bit on the outer IP header of an IPsec tunneled +// packet. Applicable only to tunnel mode SAs. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_CLEAR_DF_ON_TUNNEL (0x00000400)") +// Specifies if it is ok to assume default encapsulation ports {4500, 4500} when +// matching this SA with packets on outbound connections that don't have an +// associated IPsec-NAT-shim context. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ASSUME_UDP_CONTEXT_OUTBOUND (0x00000800)") +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN6SP1)") +// Peer has negotiation discovery enabled, and is on a perimeter network. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ND_PEER_BOUNDARY (0x00001000)") +cpp_quote("#endif") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Suppress the duplicate SA deletion logic. This logic is performed by kernel +// when an outbound SA is added, to prevent unnecessary duplicate SAs. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_SUPPRESS_DUPLICATE_DELETION (0x00002000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_PEER_SUPPORTS_GUARANTEE_ENCRYPTION (0x00004000)") +// Only allow inbound connections to use this SA +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_FORCE_INBOUND_CONNECTIONS (0x00008000)") +// Only allow outbound connections to use this SA. Only valid for tunnel mode. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_FORCE_OUTBOUND_CONNECTIONS (0x00010000)") +// SA is was originally initiated by forward path traffic. Only valid for tunnel +// mode. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_FORWARD_PATH_INITIATOR (0x00020000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") +// Allows (tunnel)SAs to idle based on inbound or outbound for asymmetric route support +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_ENABLE_OPTIONAL_ASYMMETRIC_IDLE (0x0040000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_USING_DICTATED_KEYS (0x00080000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_LOCALLY_DICTATED_KEYS (0x00100000)") +// Flag indicating whether the SA's in this bundle have been offloaded +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_SA_OFFLOADED (0x00200000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") +// Flags indicating these are tunnel mode SAs associated to transport layer filters +// based on tunnel EP and IP-in-IP protocol. In outbound path, IPsec does not +// perform encapsulation as IP-in-IP packets are expected to be injected. +// In inbound path however IPsec does decrypt (if needed) and decapsulation as well. +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_IP_IN_IP_PKT (0x00400000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD)") + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN10_RS5)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_LOW_POWER_MODE_SUPPORT (0x00800000)") +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS5)") + +// For IKEV2 Tunnel SAs, the top 4 bits are the tunnel bandwidth +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH1 (0x10000000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH2 (0x20000000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH3 (0x40000000)") +cpp_quote("#define IPSEC_SA_BUNDLE_FLAG_TUNNEL_BANDWIDTH4 (0x80000000)") + +// Type used to store information about an IPsec SA bundle. +typedef struct IPSEC_SA_BUNDLE0_ +{ + // Flags + UINT32 flags; + // Lifetime of all the SAs in the bundle. If any lifetime value (seconds, + // kilobytes, or packets) is specifed as 0, then the corresponding lifetime + // check will be disabled. Security note: specifying 0 for lifetimePackets + // has the adverse side-effect of also disabling IPsec replay checks for the + // SA bundle. + IPSEC_SA_LIFETIME0 lifetime; + // Timeout in seconds after which the SAs in the bundle will idle out. + // Specifying 0 will disable idle timeout of the SA bundle. + UINT32 idleTimeoutSeconds; + // Timeout in seconds, after which the IPsec SA should stop accepting + // packets coming in the clear. Used for negotiation discovery. + UINT32 ndAllowClearTimeoutSeconds; + + // Optional IPsec identity info. Note in this context, if present, the + // ipsecId->tokens[i].token will be the handle to an access token. + // Also note: the targetNames in the ipsecId should only be trusted on the + // MM/EM initiator. On responder, they are used for SA lookups + // only, but have no associated identity guarantee + [unique] IPSEC_ID0* ipsecId; + + // NAP peer credentials info + UINT32 napContext; + // In scenarios where multiple simultaneous SA bundles are established for + // the same traffic, the qmSaId is used by IPSec for choosing the SA to + // expire. Note that for an IPsec SA pair, the qmSaId must be the same + // between initiator & responder machines and across inbound & outbound SA + // bundles, and for different IPsec SA pairs the qmSaIds must be different. + UINT32 qmSaId; + // Number of SAs in the bundle. + UINT32 numSAs; + // Array of IPSec SAs in the bundle. + [size_is(numSAs), unique] IPSEC_SA0* saList; + // Optional keying module specific information + [unique] IPSEC_KEYMODULE_STATE0* keyModuleState; + // IP version + FWP_IP_VERSION ipVersion; + // If IP version is V4, and peer is behind a NAT, this stores the the peer + // private address + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 peerV4PrivateAddress; + [case(FWP_IP_VERSION_V6)]; + }; + // LUID of the MM SA used to generate this QM SA. + UINT64 mmSaId; + // Specifies whether Quick Mode PFS (Pefect Forward Secrecy) was enabled for + // this SA, and if so, contains the Diffie Hellman group that was used for + // PFS. + IPSEC_PFS_GROUP pfsGroup; +} IPSEC_SA_BUNDLE0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Type used to store information about an IPsec SA bundle. +typedef struct IPSEC_SA_BUNDLE1_ +{ + // Flags + UINT32 flags; + // Lifetime of all the SAs in the bundle. If any lifetime value (seconds, + // kilobytes, or packets) is specifed as 0, then the corresponding lifetime + // check will be disabled. Security note: specifying 0 for lifetimePackets + // has the adverse side-effect of also disabling IPsec replay checks for the + // SA bundle. + IPSEC_SA_LIFETIME0 lifetime; + // Timeout in seconds after which the SAs in the bundle will idle out. + // Specifying 0 will disable idle timeout of the SA bundle. + UINT32 idleTimeoutSeconds; + // Timeout in seconds, after which the IPsec SA should stop accepting + // packets coming in the clear. Used for negotiation discovery. + UINT32 ndAllowClearTimeoutSeconds; + + // Optional IPsec identity info. Note in this context, if present, the + // ipsecId->tokens[i].token will be the handle to an access token. + // Also note: the targetNames in the ipsecId should only be trusted on the + // MM/EM initiator. On responder, they are used for SA lookups + // only, but have no associated identity guarantee + [unique] IPSEC_ID0* ipsecId; + + // NAP peer credentials info + UINT32 napContext; + // In scenarios where multiple simultaneous SA bundles are established for + // the same traffic, the qmSaId is used by IPSec for choosing the SA to + // expire. Note that for an IPsec SA pair, the qmSaId must be the same + // between initiator & responder machines and across inbound & outbound SA + // bundles, and for different IPsec SA pairs the qmSaIds must be different. + UINT32 qmSaId; + // Number of SAs in the bundle. + UINT32 numSAs; + // Array of IPSec SAs in the bundle. + [size_is(numSAs), unique] IPSEC_SA0* saList; + // Optional keying module specific information + [unique] IPSEC_KEYMODULE_STATE0* keyModuleState; + // IP version + FWP_IP_VERSION ipVersion; + // If IP version is V4, and peer is behind a NAT, this stores the the peer + // private address + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 peerV4PrivateAddress; + [case(FWP_IP_VERSION_V6)]; + }; + // LUID of the MM SA used to generate this QM SA. + UINT64 mmSaId; + // Specifies whether Quick Mode PFS (Pefect Forward Secrecy) was enabled for + // this SA, and if so, contains the Diffie Hellman group that was used for + // PFS. + IPSEC_PFS_GROUP pfsGroup; + // Opaque SA context used to correlate socket api queries with SA state lookups + GUID saLookupContext; + // LUID of the FWPS_LAYER_IPSEC_XX layer FWPS filter corresponding to this SA + // bundle. This is useful for enumeration purposes. + UINT64 qmFilterId; +} IPSEC_SA_BUNDLE1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for describing IPsec traffic. +// +/////////////////////////////////////////////////////////////////////////////// + +// Type of IPsec traffic being described. +typedef [v1_enum] enum IPSEC_TRAFFIC_TYPE_ +{ + IPSEC_TRAFFIC_TYPE_TRANSPORT, + IPSEC_TRAFFIC_TYPE_TUNNEL, + IPSEC_TRAFFIC_TYPE_MAX +} IPSEC_TRAFFIC_TYPE; + +// Type containing parameters used to describe IPsec traffic +typedef struct IPSEC_TRAFFIC0_ +{ + // IP version (version of outer header in tunnel mode) + FWP_IP_VERSION ipVersion; + // Tagged union containing the local address of the IPsec traffic + // In tunnel mode, this is the local tunnel endpoint + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote address of the IPsec traffic + // In tunnel mode, this is the remote tunnel endpoint + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + // type of traffic being described + IPSEC_TRAFFIC_TYPE trafficType; + // If traffic type is transport mode, this is the LUID of the FWPS transport + // layer filter corresponding to this traffic. If traffic type is tunnel + // mode, this is the LUID of the associated QM policy. + // In tunnel mode, this represents the QM traffic selectors for the tunnel + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(trafficType)] union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)] + UINT64 ipsecFilterId; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + UINT64 tunnelPolicyId; + }; + // The remote TCP/UDP port for this traffic. This is normally only specified + // in specific scenarios where the remote port condition in the transport + // layer filter is more generic than the actual remote port. + UINT16 remotePort; +} IPSEC_TRAFFIC0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type containing parameters used to describe IPsec traffic +typedef struct IPSEC_TRAFFIC1_ +{ + // IP version (version of outer header in tunnel mode) + FWP_IP_VERSION ipVersion; + // Tagged union containing the local address of the IPsec traffic + // In tunnel mode, this is the local tunnel endpoint + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 localV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 localV6Address[16]; + }; + // Tagged union containing the remote address of the IPsec traffic + // In tunnel mode, this is the remote tunnel endpoint + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + UINT32 remoteV4Address; + [case(FWP_IP_VERSION_V6)] + UINT8 remoteV6Address[16]; + }; + // type of traffic being described + IPSEC_TRAFFIC_TYPE trafficType; + // If traffic type is transport mode, this is the LUID of the FWPS transport + // layer filter corresponding to this traffic. If traffic type is tunnel + // mode, this is the LUID of the associated QM policy. + // In tunnel mode, this represents the QM traffic selectors for the tunnel + [switch_type(IPSEC_TRAFFIC_TYPE), switch_is(trafficType)] union + { + [case (IPSEC_TRAFFIC_TYPE_TRANSPORT)] + UINT64 ipsecFilterId; + [case (IPSEC_TRAFFIC_TYPE_TUNNEL)] + UINT64 tunnelPolicyId; + }; + // The remote TCP/UDP port for this traffic. This is normally only specified + // in specific scenarios where the remote port condition in the transport + // layer filter is more generic than the actual remote port. + UINT16 remotePort; + // The local TCP/UDP port for this traffic. This is normally only specified + // in specific scenarios where the local port condition in the transport + // layer filter is more generic than the actual remote port. + UINT16 localPort; + // The IP protocol for this traffic. This is normally only specified + // in specific scenarios where the IP protocol condition in the transport + // layer filter is more generic than the actual IP protocol. + UINT8 ipProtocol; + // The LUID of the local interface corresponding to the local address + // specified above. + UINT64 localIfLuid; + // The profile ID corresponding to the actual interface that the traffic is + // going out on or coming in from the wire. + UINT32 realIfProfileId; +} IPSEC_TRAFFIC1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Type used to store the UDP encapsulation ports, if UDP-ESP encapsulation is +// taking place. +typedef struct IPSEC_V4_UDP_ENCAPSULATION0_ +{ + // Local UDP encapsulation port + UINT16 localUdpEncapPort; + // Remote UDP encapsulation port + UINT16 remoteUdpEncapPort; +} IPSEC_V4_UDP_ENCAPSULATION0; + + +/////////////////////////////////////////////////////////////////////////////// +// +// Definitions for managing IPsec SAs. +// +/////////////////////////////////////////////////////////////////////////////// + +// Information that must be supplied when requesting a SPI from the IPsec +// driver, or specifying a SPI to IPsec driver. +typedef struct IPSEC_GETSPI0_ +{ + // Traffic description corresponding to the inbound SA. + IPSEC_TRAFFIC0 inboundIpsecTraffic; + FWP_IP_VERSION ipVersion; + // For IPv4 this specifies the NATT UDP encapsulation ports. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* inboundUdpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // Not used currently. + [unique] IPSEC_CRYPTO_MODULE_ID* rngCryptoModuleID; +} IPSEC_GETSPI0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type containing information that must be supplied when +// requesting a SPI from the IPsec driver. +typedef struct IPSEC_GETSPI1_ +{ + // Traffic description corresponding to the inbound SA. + IPSEC_TRAFFIC1 inboundIpsecTraffic; + FWP_IP_VERSION ipVersion; + // For IPv4 this specifies the NATT UDP encapsulation ports. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* inboundUdpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // Not used currently. + [unique] IPSEC_CRYPTO_MODULE_ID* rngCryptoModuleID; +} IPSEC_GETSPI1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Public state associated with an IPsec security association. +typedef struct IPSEC_SA_DETAILS0_ +{ + // IP version (version of outer header in tunnel mode) + FWP_IP_VERSION ipVersion; + // Indicates direction of the Ipsec SA + FWP_DIRECTION saDirection; + // The traffic being secured by this IPsec SA. For tunnel mode, this + // contains both the tunnel endpoints and QM traffic selectors + IPSEC_TRAFFIC0 traffic; + // various parameters of the SA. + IPSEC_SA_BUNDLE0 saBundle; + // If UDP-ESP encapsulation is enabled on the SA, this stores the UDP + // encapsulation ports. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* udpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // The transport layer filter corresponding to this IPsec SA. + [unique] FWPM_FILTER0* transportFilter; +} IPSEC_SA_DETAILS0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of public state associated with an IPsec security association. +typedef struct IPSEC_SA_DETAILS1_ +{ + // IP version (version of outer header in tunnel mode) + FWP_IP_VERSION ipVersion; + // Indicates direction of the Ipsec SA + FWP_DIRECTION saDirection; + // The traffic being secured by this IPsec SA. For tunnel mode, this + // contains both the tunnel endpoints and QM traffic selectors + IPSEC_TRAFFIC1 traffic; + // various parameters of the SA. + IPSEC_SA_BUNDLE1 saBundle; + // If UDP-ESP encapsulation is enabled on the SA, this stores the UDP + // encapsulation ports. + [switch_type(FWP_IP_VERSION), switch_is(ipVersion)] union + { + [case(FWP_IP_VERSION_V4)] + [unique] IPSEC_V4_UDP_ENCAPSULATION0* udpEncapsulation; + [case(FWP_IP_VERSION_V6)]; + }; + // The transport layer filter corresponding to this IPsec SA. + [unique] FWPM_FILTER0* transportFilter; + // The virtual interface tunnel info + IPSEC_VIRTUAL_IF_TUNNEL_INFO0 virtualIfTunnelInfo; +} IPSEC_SA_DETAILS1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Encapsulates an inbound/outbound SA pair. +typedef struct IPSEC_SA_CONTEXT0_ +{ + // LUID identifying the SA context. + UINT64 saContextId; + // Inbound SA -- may be NULL. + [unique] IPSEC_SA_DETAILS0* inboundSa; + // Outbound SA -- may be NULL. + [unique] IPSEC_SA_DETAILS0* outboundSa; +} IPSEC_SA_CONTEXT0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") +// Version-1 of type that encapsulates an inbound/outbound SA pair. +typedef struct IPSEC_SA_CONTEXT1_ +{ + // LUID identifying the SA context. + UINT64 saContextId; + // Inbound SA -- may be NULL. + [unique] IPSEC_SA_DETAILS1* inboundSa; + // Outbound SA -- may be NULL. + [unique] IPSEC_SA_DETAILS1* outboundSa; +} IPSEC_SA_CONTEXT1; +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + +// Template used for enumerating IPsec SA contexts +typedef struct IPSEC_SA_CONTEXT_ENUM_TEMPLATE0_ +{ + // If not empty, only SA contexts containing an SA whose local address is on + // the specified subnet will be returned. May be of type FWP_UINT32, + // FWP_BYTE_ARRAY16_TYPE, FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 localSubNet; + // If not empty, only SA contexts containing an SA whose remote address is + // on the specified subnet will be returned. May be of type FWP_UINT32, + // FWP_BYTE_ARRAY16_TYPE, FWP_V4_ADDR_MASK, or FWP_V6_ADDR_MASK. + FWP_CONDITION_VALUE0 remoteSubNet; +} IPSEC_SA_CONTEXT_ENUM_TEMPLATE0; + +// Template used for enumerating IPsec SAs +typedef struct IPSEC_SA_ENUM_TEMPLATE0_ +{ + // Direction of the SA + FWP_DIRECTION saDirection; +} IPSEC_SA_ENUM_TEMPLATE0; + + +typedef struct IPSEC_SA_CONTEXT_SUBSCRIPTION0_ { + // enum template used to match SA contexts the caller + // is interested in getting notifications + IPSEC_SA_CONTEXT_ENUM_TEMPLATE0 *enumTemplate; + UINT32 flags; // reserved flags + // + GUID sessionKey; +} IPSEC_SA_CONTEXT_SUBSCRIPTION0; + +typedef enum IPSEC_SA_CONTEXT_EVENT_TYPE0_ { + IPSEC_SA_CONTEXT_EVENT_ADD = 1, + IPSEC_SA_CONTEXT_EVENT_DELETE, + IPSEC_SA_CONTEXT_EVENT_MAX +} IPSEC_SA_CONTEXT_EVENT_TYPE0; + +typedef struct IPSEC_SA_CONTEXT_CHANGE0_ +{ + // Type of change. + IPSEC_SA_CONTEXT_EVENT_TYPE0 changeType; + // LUID of the SA context that changed. + UINT64 saContextId; +} IPSEC_SA_CONTEXT_CHANGE0; + +// Type used for indicating where an IPsec failure occured +typedef [v1_enum] enum IPSEC_FAILURE_POINT_ +{ + // No information available. + IPSEC_FAILURE_NONE, + // IPsec failure happened on local machine. + IPSEC_FAILURE_ME, + // IPsec failure happened on remote machine. + IPSEC_FAILURE_PEER, + // Invalid value, used for parameter validation. + IPSEC_FAILURE_POINT_MAX +} IPSEC_FAILURE_POINT; + +// Type used for mobike additional address net events +typedef struct IPSEC_ADDRESS_INFO0_ +{ + // Local addresses to indicate to peer + UINT32 numV4Addresses; + [size_is(numV4Addresses),unique] UINT32* v4Addresses; + UINT32 numV6Addresses; + [size_is(numV6Addresses),unique] FWP_BYTE_ARRAY16* v6Addresses; +} IPSEC_ADDRESS_INFO0; + +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN7)") + +////////// +// Flags specifying IPsec DoS Protection characteristics. +////////// + +// Flag to allow IKEv1 keying module. By default it is blocked. +cpp_quote("#define IPSEC_DOSP_FLAG_ENABLE_IKEV1 (0x00000001)") +// Flag to allow IKEv2 keying module. By default it is blocked. +cpp_quote("#define IPSEC_DOSP_FLAG_ENABLE_IKEV2 (0x00000002)") +// Flag to block AuthIP keying module. By default it is allowed. +cpp_quote("#define IPSEC_DOSP_FLAG_DISABLE_AUTHIP (0x00000004)") +// Flag to exempt all matching IPv4 traffic & non-IPsec IPv6 traffic. By default +// all IPv4 traffic & non-IPsec IPv6 traffic, except IPv6 ICMP, will be blocked. +cpp_quote("#define IPSEC_DOSP_FLAG_DISABLE_DEFAULT_BLOCK (0x00000008)") +// Flag to block all matching IPv6 traffic. +cpp_quote("#define IPSEC_DOSP_FLAG_FILTER_BLOCK (0x00000010)") +// Flag to exempt all matching IPv6 traffic. +cpp_quote("#define IPSEC_DOSP_FLAG_FILTER_EXEMPT (0x00000020)") + +// Value to set in the XXXDscp fields below, if caller wants to disable the +// DSCP marking for that category. +cpp_quote("#define IPSEC_DOSP_DSCP_DISABLE_VALUE (0xff)") + +// Value to set in the XXXRateLimitBytesPerSec fields above, if caller wants to +// disable rate limiting for that category. +cpp_quote("#define IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE (0)") + +// Type containing configuration parameters for IPsec DoS Protection. +typedef struct IPSEC_DOSP_OPTIONS0_ +{ + // State entry idle timeout in seconds. Value must be > 0. + UINT32 stateIdleTimeoutSeconds; + // Per internal IP address rate limit queue idle timeout in seconds. + // Value must be > 0. + UINT32 perIPRateLimitQueueIdleTimeoutSeconds; + // DSCP (RFC 2474) marking for unauthenticated inbound IPv6 IPsec traffic. + // Value must be <= 63. Specify IPSEC_DOSP_DSCP_DISABLE_VALUE to skip this + // marking. + UINT8 ipV6IPsecUnauthDscp; + // Rate limit for unauthenticated inbound IPv6 IPsec traffic. + // Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate limit. + UINT32 ipV6IPsecUnauthRateLimitBytesPerSec; + // Per internal IP address rate limit for unauthenticated inbound IPv6 IPsec + // traffic. Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate + // limit. + UINT32 ipV6IPsecUnauthPerIPRateLimitBytesPerSec; + // DSCP (RFC 2474) marking for authenticated inbound IPv6 IPsec traffic. + // Value must be <= 63. Specify IPSEC_DOSP_DSCP_DISABLE_VALUE to skip this + // marking. + UINT8 ipV6IPsecAuthDscp; + // Rate limit for authenticated inbound IPv6 IPsec traffic. + // Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate limit. + UINT32 ipV6IPsecAuthRateLimitBytesPerSec; + // DSCP (RFC 2474) marking for inbound ICMPv6 traffic. + // Value must be <= 63. Specify IPSEC_DOSP_DSCP_DISABLE_VALUE to skip this + // marking. + UINT8 icmpV6Dscp; + // Rate limit for inbound ICMPv6 traffic. + // Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate limit. + UINT32 icmpV6RateLimitBytesPerSec; + // DSCP (RFC 2474) marking for inbound IPv6 filter exempted traffic. + // Value must be <= 63. Specify IPSEC_DOSP_DSCP_DISABLE_VALUE to skip this + // marking. + UINT8 ipV6FilterExemptDscp; + // Rate limit for inbound IPv6 filter exempted traffic. + // Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate limit. + UINT32 ipV6FilterExemptRateLimitBytesPerSec; + // DSCP (RFC 2474) marking for inbound default-block exempted traffic. + // Value must be <= 63. Specify IPSEC_DOSP_DSCP_DISABLE_VALUE to skip this + // marking. + UINT8 defBlockExemptDscp; + // Rate limit for inbound default-block exempted traffic. + // Specify IPSEC_DOSP_RATE_LIMIT_DISABLE_VALUE to skip this rate limit. + UINT32 defBlockExemptRateLimitBytesPerSec; + // Maximum number of state entries in the table. Value must be > 0. + UINT32 maxStateEntries; + // Maximum number of per internal IP address rate limit queues for inbound + // unauthenticated IPv6 IPsec traffic. Value must be > 0. + UINT32 maxPerIPRateLimitQueues; + // Flags + UINT32 flags; + // Array of public interface LUIDs + UINT32 numPublicIFLuids; + [size_is(numPublicIFLuids), unique] UINT64* publicIFLuids; + // Array of internal interface LUIDs + UINT32 numInternalIFLuids; + [size_is(numInternalIFLuids), unique] UINT64* internalIFLuids; + // Optional public IPv6 address or subnet, for which this policy is + // specified. + FWP_V6_ADDR_AND_MASK publicV6AddrMask; + // Optional internal IPv6 address or subnet, for which this policy is + // specified. + FWP_V6_ADDR_AND_MASK internalV6AddrMask; +} IPSEC_DOSP_OPTIONS0; + +// IPsec DoS Protection statistics. +typedef struct IPSEC_DOSP_STATISTICS0_ +{ + // Total number of state entries created since the machine was last started. + UINT64 totalStateEntriesCreated; + // Current number of state entries in the table. + UINT64 currentStateEntries; + // Total number of inbound IPv6 IPsec unauthenticated packets allowed since + // machine was last started. + UINT64 totalInboundAllowedIPv6IPsecUnauthPkts; + // Total number of inbound IPv6 IPsec unauthenticated packets discarded due + // to rate-limiting since machine was last started. + UINT64 totalInboundRatelimitDiscardedIPv6IPsecUnauthPkts; + // Total number of inbound IPv6 IPsec unauthenticated packets discarded due + // to per internal IP address rate-limiting since machine was last started. + UINT64 totalInboundPerIPRatelimitDiscardedIPv6IPsecUnauthPkts; + // Total number of inbound IPv6 IPsec unauthenticated packets discarded due + // to other reasons since machine was last started. + UINT64 totalInboundOtherDiscardedIPv6IPsecUnauthPkts; + // Total number of inbound IPv6 IPsec authenticated packets allowed since + // machine was last started. + UINT64 totalInboundAllowedIPv6IPsecAuthPkts; + // Total number of inbound IPv6 IPsec authenticated packets discarded due to + // rate-limiting since machine was last started. + UINT64 totalInboundRatelimitDiscardedIPv6IPsecAuthPkts; + // Total number of inbound IPv6 IPsec authenticated packets discarded due to + // other reasons since machine was last started. + UINT64 totalInboundOtherDiscardedIPv6IPsecAuthPkts; + // Total number of inbound ICMPv6 packets allowed since machine was last + // started. + UINT64 totalInboundAllowedICMPv6Pkts; + // Total number of inbound ICMPv6 packets discarded due to rate-limiting + // since machine was last started. + UINT64 totalInboundRatelimitDiscardedICMPv6Pkts; + // Total number of inbound IPv6 filter exempted packets allowed since machine + // was last started. + UINT64 totalInboundAllowedIPv6FilterExemptPkts; + // Total number of inbound IPv6 filter exempted packets discarded due to + // rate-limiting since machine was last started. + UINT64 totalInboundRatelimitDiscardedIPv6FilterExemptPkts; + // Total number of inbound IPv6 filter blocked packets discarded since + // machine was last started. + UINT64 totalInboundDiscardedIPv6FilterBlockPkts; + // Total number of inbound default-block exempted packets allowed since + // machine was last started. + UINT64 totalInboundAllowedDefBlockExemptPkts; + // Total number of inbound default-block exempted packets discarded due to + // rate-limiting since machine was last started. + UINT64 totalInboundRatelimitDiscardedDefBlockExemptPkts; + // Total number of inbound default-block packets discarded since machine was + // last started. + UINT64 totalInboundDiscardedDefBlockPkts; + // Current number of per internal IP address rate limit queues for inbound + // IPv6 unauthenticated IPsec traffic. + UINT64 currentInboundIPv6IPsecUnauthPerIPRateLimitQueues; +} IPSEC_DOSP_STATISTICS0; + +// IPsec DoS Protection state entry. +typedef struct IPSEC_DOSP_STATE0_ +{ + // IPv6 address of the public host + UINT8 publicHostV6Addr[16]; + // IPv6 address of the internal host + UINT8 internalHostV6Addr[16]; + // Total number of inbound IPv6 IPsec packets allowed since the state entry + // was created. + UINT64 totalInboundIPv6IPsecAuthPackets; + // Total number of outbound IPv6 IPsec packets, allowed since the state entry + // was created. + UINT64 totalOutboundIPv6IPsecAuthPackets; + // Duration in seconds since this entry was created + UINT32 durationSecs; +} IPSEC_DOSP_STATE0; + +// Template used for enumerating IPsec DoS Protection state entries. +typedef struct IPSEC_DOSP_STATE_ENUM_TEMPLATE0_ +{ + // Only state entries whose public host address is on the specified subnet + // will be returned. + FWP_V6_ADDR_AND_MASK publicV6AddrMask; + // Only state entries whose internal host address is on the specified subnet + // will be returned. + FWP_V6_ADDR_AND_MASK internalV6AddrMask; +} IPSEC_DOSP_STATE_ENUM_TEMPLATE0; + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN7)") + + +// No IDL definition requd since this sturct never crosses RPC boundary? +cpp_quote("#if (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#define IPSEC_KEY_MANAGER_FLAG_DICTATE_KEY (0x00000001)") + + +typedef struct _IPSEC_KEY_MANAGER0 +{ + GUID keyManagerKey; + FWPM_DISPLAY_DATA0 displayData; + UINT32 flags; + UINT8 keyDictationTimeoutHint; +} IPSEC_KEY_MANAGER0; + +cpp_quote("#endif // (NTDDI_VERSION >= NTDDI_WIN8)") + +cpp_quote("#if _MSC_VER >= 800") +cpp_quote("#if _MSC_VER >= 1200") +cpp_quote("#pragma warning(pop)") +cpp_quote("#else") +cpp_quote("#pragma warning(default:4201)") +cpp_quote("#endif") +cpp_quote("#endif") + +cpp_quote("#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_APPRUNTIME) */") +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipv6prefast.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipv6prefast.h new file mode 100644 index 0000000000000000000000000000000000000000..abb9f54d35734a46a82a555c41989cc042ac1497 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ipv6prefast.h @@ -0,0 +1,23 @@ +/*++ + +Copyright (c) 2005 Microsoft Corporation + +Module Name: + + ipv6prefast.h + +Abstract: + + Provides control over IPv6-related PREfast warnings. + +Revision History: + +--*/ + +#pragma once + +#if defined(_PREFAST_) && defined(IPV6_PREFAST_SAFE) + +#pragma prefast(disable:24001 24002 24003 24004 24007, "This code is IPv6 ready and IPv4-specific warnings may be safely disabled.") + +#endif // _PREFAST_ ... diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iscsierr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iscsierr.h new file mode 100644 index 0000000000000000000000000000000000000000..3c9b7815a4d1129ca60580e34e16c78eefa8e0c6 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/iscsierr.h @@ -0,0 +1,1030 @@ +/*++ + +Copyright (c) 2001 Microsoft Corporation + +Module Name: + + iscsierr.h + +Abstract: + + Constant definitions for the IScsi discover error codes + +Revision History: + +--*/ + +#ifndef _ISCSIERR_ +#define _ISCSIERR_ + +// +// Status values are 32 bit values layed out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-------------------------+-------------------------------+ +// |Sev|C| Facility | Code | +// +---+-+-------------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// Facility - is the facility code +// +// Code - is the facility's status code +// + +// +// Error status code for ISCSI discovery apis. Error codes can be a +// standard Windows error code as defined in Winerror.h or one of the +// iscsi discovery specific error codes defined below. +// +#ifndef MOFCOMP_PASS +typedef ULONG ISDSC_STATUS; +#endif + +// +// Values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// + + +// +// Define the severity codes +// +#define STATUS_SEVERITY_SUCCESS 0x0 +#define STATUS_SEVERITY_INFORMATIONAL 0x1 +#define STATUS_SEVERITY_WARNING 0x2 +#define STATUS_SEVERITY_ERROR 0x3 + + +// +// MessageId: ISDSC_NON_SPECIFIC_ERROR +// +// MessageText: +// +// A non specific error occurred. +// +#define ISDSC_NON_SPECIFIC_ERROR ((ISDSC_STATUS)0xEFFF0001L) + +// +// MessageId: ISDSC_LOGIN_FAILED +// +// MessageText: +// +// Login Failed. +// +#define ISDSC_LOGIN_FAILED ((ISDSC_STATUS)0xEFFF0002L) + +// +// MessageId: ISDSC_CONNECTION_FAILED +// +// MessageText: +// +// Connection Failed. +// +#define ISDSC_CONNECTION_FAILED ((ISDSC_STATUS)0xEFFF0003L) + +// +// MessageId: ISDSC_INITIATOR_NODE_ALREADY_EXISTS +// +// MessageText: +// +// Initiator Node Already Exists. +// +#define ISDSC_INITIATOR_NODE_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0004L) + +// +// MessageId: ISDSC_INITIATOR_NODE_NOT_FOUND +// +// MessageText: +// +// Initiator Node Does Not Exist. +// +#define ISDSC_INITIATOR_NODE_NOT_FOUND ((ISDSC_STATUS)0xEFFF0005L) + +// +// MessageId: ISDSC_TARGET_MOVED_TEMPORARILY +// +// MessageText: +// +// Target Moved Temporarily. +// +#define ISDSC_TARGET_MOVED_TEMPORARILY ((ISDSC_STATUS)0xEFFF0006L) + +// +// MessageId: ISDSC_TARGET_MOVED_PERMANENTLY +// +// MessageText: +// +// Target Moved Permanently. +// +#define ISDSC_TARGET_MOVED_PERMANENTLY ((ISDSC_STATUS)0xEFFF0007L) + +// +// MessageId: ISDSC_INITIATOR_ERROR +// +// MessageText: +// +// Initiator Error. +// +#define ISDSC_INITIATOR_ERROR ((ISDSC_STATUS)0xEFFF0008L) + +// +// MessageId: ISDSC_AUTHENTICATION_FAILURE +// +// MessageText: +// +// Authentication Failure. +// +#define ISDSC_AUTHENTICATION_FAILURE ((ISDSC_STATUS)0xEFFF0009L) + +// +// MessageId: ISDSC_AUTHORIZATION_FAILURE +// +// MessageText: +// +// Authorization Failure. +// +#define ISDSC_AUTHORIZATION_FAILURE ((ISDSC_STATUS)0xEFFF000AL) + +// +// MessageId: ISDSC_NOT_FOUND +// +// MessageText: +// +// Not Found. +// +#define ISDSC_NOT_FOUND ((ISDSC_STATUS)0xEFFF000BL) + +// +// MessageId: ISDSC_TARGET_REMOVED +// +// MessageText: +// +// Target Removed. +// +#define ISDSC_TARGET_REMOVED ((ISDSC_STATUS)0xEFFF000CL) + +// +// MessageId: ISDSC_UNSUPPORTED_VERSION +// +// MessageText: +// +// Unsupported Version. +// +#define ISDSC_UNSUPPORTED_VERSION ((ISDSC_STATUS)0xEFFF000DL) + +// +// MessageId: ISDSC_TOO_MANY_CONNECTIONS +// +// MessageText: +// +// Too many Connections. +// +#define ISDSC_TOO_MANY_CONNECTIONS ((ISDSC_STATUS)0xEFFF000EL) + +// +// MessageId: ISDSC_MISSING_PARAMETER +// +// MessageText: +// +// Missing Parameter. +// +#define ISDSC_MISSING_PARAMETER ((ISDSC_STATUS)0xEFFF000FL) + +// +// MessageId: ISDSC_CANT_INCLUDE_IN_SESSION +// +// MessageText: +// +// Can not include in session. +// +#define ISDSC_CANT_INCLUDE_IN_SESSION ((ISDSC_STATUS)0xEFFF0010L) + +// +// MessageId: ISDSC_SESSION_TYPE_NOT_SUPPORTED +// +// MessageText: +// +// Session type not supported. +// +#define ISDSC_SESSION_TYPE_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF0011L) + +// +// MessageId: ISDSC_TARGET_ERROR +// +// MessageText: +// +// Target Error. +// +#define ISDSC_TARGET_ERROR ((ISDSC_STATUS)0xEFFF0012L) + +// +// MessageId: ISDSC_SERVICE_UNAVAILABLE +// +// MessageText: +// +// Service Unavailable. +// +#define ISDSC_SERVICE_UNAVAILABLE ((ISDSC_STATUS)0xEFFF0013L) + +// +// MessageId: ISDSC_OUT_OF_RESOURCES +// +// MessageText: +// +// Out of Resources. +// +#define ISDSC_OUT_OF_RESOURCES ((ISDSC_STATUS)0xEFFF0014L) + +// +// MessageId: ISDSC_CONNECTION_ALREADY_EXISTS +// +// MessageText: +// +// Connections already exist on initiator node. +// +#define ISDSC_CONNECTION_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0015L) + +// +// MessageId: ISDSC_SESSION_ALREADY_EXISTS +// +// MessageText: +// +// Session Already Exists. +// +#define ISDSC_SESSION_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0016L) + +// +// MessageId: ISDSC_INITIATOR_INSTANCE_NOT_FOUND +// +// MessageText: +// +// Initiator Instance Does Not Exist. +// +#define ISDSC_INITIATOR_INSTANCE_NOT_FOUND ((ISDSC_STATUS)0xEFFF0017L) + +// +// MessageId: ISDSC_TARGET_ALREADY_EXISTS +// +// MessageText: +// +// Target Already Exists. +// +#define ISDSC_TARGET_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0018L) + +// +// MessageId: ISDSC_DRIVER_BUG +// +// MessageText: +// +// The iscsi driver implementation did not complete an operation correctly. +// +#define ISDSC_DRIVER_BUG ((ISDSC_STATUS)0xEFFF0019L) + +// +// MessageId: ISDSC_INVALID_TEXT_KEY +// +// MessageText: +// +// An invalid key text was encountered. +// +#define ISDSC_INVALID_TEXT_KEY ((ISDSC_STATUS)0xEFFF001AL) + +// +// MessageId: ISDSC_INVALID_SENDTARGETS_TEXT +// +// MessageText: +// +// Invalid SendTargets response text was encountered. +// +#define ISDSC_INVALID_SENDTARGETS_TEXT ((ISDSC_STATUS)0xEFFF001BL) + +// +// MessageId: ISDSC_INVALID_SESSION_ID +// +// MessageText: +// +// Invalid Session Id. +// +#define ISDSC_INVALID_SESSION_ID ((ISDSC_STATUS)0xEFFF001CL) + +// +// MessageId: ISDSC_SCSI_REQUEST_FAILED +// +// MessageText: +// +// The scsi request failed. +// +#define ISDSC_SCSI_REQUEST_FAILED ((ISDSC_STATUS)0xEFFF001DL) + +// +// MessageId: ISDSC_TOO_MANY_SESSIONS +// +// MessageText: +// +// Exceeded max sessions for this initiator. +// +#define ISDSC_TOO_MANY_SESSIONS ((ISDSC_STATUS)0xEFFF001EL) + +// +// MessageId: ISDSC_SESSION_BUSY +// +// MessageText: +// +// Session is busy since a request is already in progress. +// +#define ISDSC_SESSION_BUSY ((ISDSC_STATUS)0xEFFF001FL) + +// +// MessageId: ISDSC_TARGET_MAPPING_UNAVAILABLE +// +// MessageText: +// +// The target mapping requested is not available. +// +#define ISDSC_TARGET_MAPPING_UNAVAILABLE ((ISDSC_STATUS)0xEFFF0020L) + +// +// MessageId: ISDSC_ADDRESS_TYPE_NOT_SUPPORTED +// +// MessageText: +// +// The Target Address type given is not supported. +// +#define ISDSC_ADDRESS_TYPE_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF0021L) + +// +// MessageId: ISDSC_LOGON_FAILED +// +// MessageText: +// +// Logon Failed. +// +#define ISDSC_LOGON_FAILED ((ISDSC_STATUS)0xEFFF0022L) + +// +// MessageId: ISDSC_SEND_FAILED +// +// MessageText: +// +// TCP Send Failed. +// +#define ISDSC_SEND_FAILED ((ISDSC_STATUS)0xEFFF0023L) + +// +// MessageId: ISDSC_TRANSPORT_ERROR +// +// MessageText: +// +// TCP Transport Error +// +#define ISDSC_TRANSPORT_ERROR ((ISDSC_STATUS)0xEFFF0024L) + +// +// MessageId: ISDSC_VERSION_MISMATCH +// +// MessageText: +// +// iSCSI Version Mismatch +// +#define ISDSC_VERSION_MISMATCH ((ISDSC_STATUS)0xEFFF0025L) + +// +// MessageId: ISDSC_TARGET_MAPPING_OUT_OF_RANGE +// +// MessageText: +// +// The Target Mapping Address passed is out of range for the adapter configuration. +// +#define ISDSC_TARGET_MAPPING_OUT_OF_RANGE ((ISDSC_STATUS)0xEFFF0026L) + +// +// MessageId: ISDSC_TARGET_PRESHAREDKEY_UNAVAILABLE +// +// MessageText: +// +// The preshared key for the target or IKE identification payload is not available. +// +#define ISDSC_TARGET_PRESHAREDKEY_UNAVAILABLE ((ISDSC_STATUS)0xEFFF0027L) + +// +// MessageId: ISDSC_TARGET_AUTHINFO_UNAVAILABLE +// +// MessageText: +// +// The authentication information for the target is not available. +// +#define ISDSC_TARGET_AUTHINFO_UNAVAILABLE ((ISDSC_STATUS)0xEFFF0028L) + +// +// MessageId: ISDSC_TARGET_NOT_FOUND +// +// MessageText: +// +// The target name is not found or is marked as hidden from login. +// +#define ISDSC_TARGET_NOT_FOUND ((ISDSC_STATUS)0xEFFF0029L) + +// +// MessageId: ISDSC_LOGIN_USER_INFO_BAD +// +// MessageText: +// +// One or more parameters specified in LoginTargetIN structure is invalid. +// +#define ISDSC_LOGIN_USER_INFO_BAD ((ISDSC_STATUS)0xEFFF002AL) + +// +// MessageId: ISDSC_TARGET_MAPPING_EXISTS +// +// MessageText: +// +// Given target mapping already exists. +// +#define ISDSC_TARGET_MAPPING_EXISTS ((ISDSC_STATUS)0xEFFF002BL) + +// +// MessageId: ISDSC_HBA_SECURITY_CACHE_FULL +// +// MessageText: +// +// The HBA security information cache is full. +// +#define ISDSC_HBA_SECURITY_CACHE_FULL ((ISDSC_STATUS)0xEFFF002CL) + +// +// MessageId: ISDSC_INVALID_PORT_NUMBER +// +// MessageText: +// +// The port number passed is not valid for the initiator. +// +#define ISDSC_INVALID_PORT_NUMBER ((ISDSC_STATUS)0xEFFF002DL) + +// +// MessageId: ISDSC_OPERATION_NOT_ALL_SUCCESS +// +// MessageText: +// +// The operation was not successful for all initiators or discovery methods. +// +#define ISDSC_OPERATION_NOT_ALL_SUCCESS ((ISDSC_STATUS)0xAFFF002EL) + +// +// MessageId: ISDSC_HBA_SECURITY_CACHE_NOT_SUPPORTED +// +// MessageText: +// +// The HBA security information cache is not supported by this adapter. +// +#define ISDSC_HBA_SECURITY_CACHE_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF002FL) + +// +// MessageId: ISDSC_IKE_ID_PAYLOAD_TYPE_NOT_SUPPORTED +// +// MessageText: +// +// The IKE id payload type specified is not supported. +// +#define ISDSC_IKE_ID_PAYLOAD_TYPE_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF0030L) + +// +// MessageId: ISDSC_IKE_ID_PAYLOAD_INCORRECT_SIZE +// +// MessageText: +// +// The IKE id payload size specified is not correct. +// +#define ISDSC_IKE_ID_PAYLOAD_INCORRECT_SIZE ((ISDSC_STATUS)0xEFFF0031L) + +// +// MessageId: ISDSC_TARGET_PORTAL_ALREADY_EXISTS +// +// MessageText: +// +// Target Portal Structure Already Exists. +// +#define ISDSC_TARGET_PORTAL_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0032L) + +// +// MessageId: ISDSC_TARGET_ADDRESS_ALREADY_EXISTS +// +// MessageText: +// +// Target Address Structure Already Exists. +// +#define ISDSC_TARGET_ADDRESS_ALREADY_EXISTS ((ISDSC_STATUS)0xEFFF0033L) + +// +// MessageId: ISDSC_NO_AUTH_INFO_AVAILABLE +// +// MessageText: +// +// There is no IKE authentication information available. +// +#define ISDSC_NO_AUTH_INFO_AVAILABLE ((ISDSC_STATUS)0xEFFF0034L) + +// +// MessageId: ISDSC_NO_TUNNEL_OUTER_MODE_ADDRESS +// +// MessageText: +// +// There is no tunnel mode outer address specified. +// +#define ISDSC_NO_TUNNEL_OUTER_MODE_ADDRESS ((ISDSC_STATUS)0xEFFF0035L) + +// +// MessageId: ISDSC_CACHE_CORRUPTED +// +// MessageText: +// +// Authentication or tunnel address cache is corrupted. +// +#define ISDSC_CACHE_CORRUPTED ((ISDSC_STATUS)0xEFFF0036L) + +// +// MessageId: ISDSC_REQUEST_NOT_SUPPORTED +// +// MessageText: +// +// The request or operation is not supported. +// +#define ISDSC_REQUEST_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF0037L) + +// +// MessageId: ISDSC_TARGET_OUT_OF_RESORCES +// +// MessageText: +// +// The target does not have enough resources to process the given request. +// +#define ISDSC_TARGET_OUT_OF_RESORCES ((ISDSC_STATUS)0xEFFF0038L) + +// +// MessageId: ISDSC_SERVICE_DID_NOT_RESPOND +// +// MessageText: +// +// The initiator service did not respond to the request sent by the driver. +// +#define ISDSC_SERVICE_DID_NOT_RESPOND ((ISDSC_STATUS)0xEFFF0039L) + +// +// MessageId: ISDSC_ISNS_SERVER_NOT_FOUND +// +// MessageText: +// +// The Internet Storage Name Server (iSNS) server was not found or is unavailable. +// +#define ISDSC_ISNS_SERVER_NOT_FOUND ((ISDSC_STATUS)0xEFFF003AL) + +// +// MessageId: ISDSC_OPERATION_REQUIRES_REBOOT +// +// MessageText: +// +// The operation was successful but requires a driver reload or reboot to become effective. +// +#define ISDSC_OPERATION_REQUIRES_REBOOT ((ISDSC_STATUS)0xAFFF003BL) + +// +// MessageId: ISDSC_NO_PORTAL_SPECIFIED +// +// MessageText: +// +// There is no target portal available to complete the login. +// +#define ISDSC_NO_PORTAL_SPECIFIED ((ISDSC_STATUS)0xEFFF003CL) + +// +// MessageId: ISDSC_CANT_REMOVE_LAST_CONNECTION +// +// MessageText: +// +// Cannot remove the last connection for a session. +// +#define ISDSC_CANT_REMOVE_LAST_CONNECTION ((ISDSC_STATUS)0xEFFF003DL) + +// +// MessageId: ISDSC_SERVICE_NOT_RUNNING +// +// MessageText: +// +// The Microsoft iSCSI Initiator Service is not running. Please start the service and retry. +// +#define ISDSC_SERVICE_NOT_RUNNING ((ISDSC_STATUS)0xEFFF003EL) + +// +// MessageId: ISDSC_TARGET_ALREADY_LOGGED_IN +// +// MessageText: +// +// The target has already been logged in via an iSCSI session. +// +#define ISDSC_TARGET_ALREADY_LOGGED_IN ((ISDSC_STATUS)0xEFFF003FL) + +// +// MessageId: ISDSC_DEVICE_BUSY_ON_SESSION +// +// MessageText: +// +// The session cannot be logged out since a device on that session is currently being used. +// +#define ISDSC_DEVICE_BUSY_ON_SESSION ((ISDSC_STATUS)0xEFFF0040L) + +// +// MessageId: ISDSC_COULD_NOT_SAVE_PERSISTENT_LOGIN_DATA +// +// MessageText: +// +// Failed to save persistent login information. +// +#define ISDSC_COULD_NOT_SAVE_PERSISTENT_LOGIN_DATA ((ISDSC_STATUS)0xEFFF0041L) + +// +// MessageId: ISDSC_COULD_NOT_REMOVE_PERSISTENT_LOGIN_DATA +// +// MessageText: +// +// Failed to remove persistent login information. +// +#define ISDSC_COULD_NOT_REMOVE_PERSISTENT_LOGIN_DATA ((ISDSC_STATUS)0xEFFF0042L) + +// +// MessageId: ISDSC_PORTAL_NOT_FOUND +// +// MessageText: +// +// The specified portal was not found. +// +#define ISDSC_PORTAL_NOT_FOUND ((ISDSC_STATUS)0xEFFF0043L) + +// +// MessageId: ISDSC_INITIATOR_NOT_FOUND +// +// MessageText: +// +// The specified initiator name was not found. +// +#define ISDSC_INITIATOR_NOT_FOUND ((ISDSC_STATUS)0xEFFF0044L) + +// +// MessageId: ISDSC_DISCOVERY_MECHANISM_NOT_FOUND +// +// MessageText: +// +// The specified discovery mechanism was not found. +// +#define ISDSC_DISCOVERY_MECHANISM_NOT_FOUND ((ISDSC_STATUS)0xEFFF0045L) + +// +// MessageId: ISDSC_IPSEC_NOT_SUPPORTED_ON_OS +// +// MessageText: +// +// iSCSI does not support IPSEC for this version of the OS. +// +#define ISDSC_IPSEC_NOT_SUPPORTED_ON_OS ((ISDSC_STATUS)0xEFFF0046L) + +// +// MessageId: ISDSC_PERSISTENT_LOGIN_TIMEOUT +// +// MessageText: +// +// The iSCSI service timed out waiting for all persistent logins to complete. +// +#define ISDSC_PERSISTENT_LOGIN_TIMEOUT ((ISDSC_STATUS)0xEFFF0047L) + +// +// MessageId: ISDSC_SHORT_CHAP_SECRET +// +// MessageText: +// +// The specified CHAP secret is less than 96 bits and will not be usable for authenticating over non ipsec connections. +// +#define ISDSC_SHORT_CHAP_SECRET ((ISDSC_STATUS)0xAFFF0048L) + +// +// MessageId: ISDSC_EVALUATION_PEROID_EXPIRED +// +// MessageText: +// +// The evaluation period for the iSCSI initiator service has expired. +// +#define ISDSC_EVALUATION_PEROID_EXPIRED ((ISDSC_STATUS)0xEFFF0049L) + +// +// MessageId: ISDSC_INVALID_CHAP_SECRET +// +// MessageText: +// +// CHAP secret given does not conform to the standard. Please see system event log for more information. +// +#define ISDSC_INVALID_CHAP_SECRET ((ISDSC_STATUS)0xEFFF004AL) + +// +// MessageId: ISDSC_INVALID_TARGET_CHAP_SECRET +// +// MessageText: +// +// Target CHAP secret given is invalid. Maximum size of CHAP secret is 16 bytes. Minimum size is 12 bytes if IPSec is not used. +// +#define ISDSC_INVALID_TARGET_CHAP_SECRET ((ISDSC_STATUS)0xEFFF004BL) + +// +// MessageId: ISDSC_INVALID_INITIATOR_CHAP_SECRET +// +// MessageText: +// +// Initiator CHAP secret given is invalid. Maximum size of CHAP secret is 16 bytes. Minimum size is 12 bytes if IPSec is not used. +// +#define ISDSC_INVALID_INITIATOR_CHAP_SECRET ((ISDSC_STATUS)0xEFFF004CL) + +// +// MessageId: ISDSC_INVALID_CHAP_USER_NAME +// +// MessageText: +// +// CHAP Username given is invalid. +// +#define ISDSC_INVALID_CHAP_USER_NAME ((ISDSC_STATUS)0xEFFF004DL) + +// +// MessageId: ISDSC_INVALID_LOGON_AUTH_TYPE +// +// MessageText: +// +// Logon Authentication type given is invalid. +// +#define ISDSC_INVALID_LOGON_AUTH_TYPE ((ISDSC_STATUS)0xEFFF004EL) + +// +// MessageId: ISDSC_INVALID_TARGET_MAPPING +// +// MessageText: +// +// Target Mapping information given is invalid. +// +#define ISDSC_INVALID_TARGET_MAPPING ((ISDSC_STATUS)0xEFFF004FL) + +// +// MessageId: ISDSC_INVALID_TARGET_ID +// +// MessageText: +// +// Target Id given in Target Mapping is invalid. +// +#define ISDSC_INVALID_TARGET_ID ((ISDSC_STATUS)0xEFFF0050L) + +// +// MessageId: ISDSC_INVALID_ISCSI_NAME +// +// MessageText: +// +// The iSCSI name specified contains invalid characters or is too long. +// +#define ISDSC_INVALID_ISCSI_NAME ((ISDSC_STATUS)0xEFFF0051L) + +// +// MessageId: ISDSC_INCOMPATIBLE_ISNS_VERSION +// +// MessageText: +// +// The version number returned from the Internet Storage Name Server (iSNS) server is not compatible with this version of the iSNS client. +// +#define ISDSC_INCOMPATIBLE_ISNS_VERSION ((ISDSC_STATUS)0xEFFF0052L) + +// +// MessageId: ISDSC_FAILED_TO_CONFIGURE_IPSEC +// +// MessageText: +// +// Initiator failed to configure IPSec for the given connection. This could be because of low resources. +// +#define ISDSC_FAILED_TO_CONFIGURE_IPSEC ((ISDSC_STATUS)0xEFFF0053L) + +// +// MessageId: ISDSC_BUFFER_TOO_SMALL +// +// MessageText: +// +// The buffer given for processing the request is too small. +// +#define ISDSC_BUFFER_TOO_SMALL ((ISDSC_STATUS)0xEFFF0054L) + +// +// MessageId: ISDSC_INVALID_LOAD_BALANCE_POLICY +// +// MessageText: +// +// The given Load Balance policy is not recognized by iScsi initiator. +// +#define ISDSC_INVALID_LOAD_BALANCE_POLICY ((ISDSC_STATUS)0xEFFF0055L) + +// +// MessageId: ISDSC_INVALID_PARAMETER +// +// MessageText: +// +// One or more paramaters specified is not valid. +// +#define ISDSC_INVALID_PARAMETER ((ISDSC_STATUS)0xEFFF0056L) + +// +// MessageId: ISDSC_DUPLICATE_PATH_SPECIFIED +// +// MessageText: +// +// Duplicate PathIds were specified in the call to set Load Balance Policy. +// +#define ISDSC_DUPLICATE_PATH_SPECIFIED ((ISDSC_STATUS)0xEFFF0057L) + +// +// MessageId: ISDSC_PATH_COUNT_MISMATCH +// +// MessageText: +// +// Number of paths specified in Set Load Balance Policy does not match the number of paths to the target. +// +#define ISDSC_PATH_COUNT_MISMATCH ((ISDSC_STATUS)0xEFFF0058L) + +// +// MessageId: ISDSC_INVALID_PATH_ID +// +// MessageText: +// +// Path Id specified in the call to set Load Balance Policy is not valid +// +#define ISDSC_INVALID_PATH_ID ((ISDSC_STATUS)0xEFFF0059L) + +// +// MessageId: ISDSC_MULTIPLE_PRIMARY_PATHS_SPECIFIED +// +// MessageText: +// +// Multiple primary paths specified when only one primary path is expected. +// +#define ISDSC_MULTIPLE_PRIMARY_PATHS_SPECIFIED ((ISDSC_STATUS)0xEFFF005AL) + +// +// MessageId: ISDSC_NO_PRIMARY_PATH_SPECIFIED +// +// MessageText: +// +// No primary path specified when at least one is expected. +// +#define ISDSC_NO_PRIMARY_PATH_SPECIFIED ((ISDSC_STATUS)0xEFFF005BL) + +// +// MessageId: ISDSC_DEVICE_ALREADY_PERSISTENTLY_BOUND +// +// MessageText: +// +// Device is already a persistently bound device. +// +#define ISDSC_DEVICE_ALREADY_PERSISTENTLY_BOUND ((ISDSC_STATUS)0xEFFF005CL) + +// +// MessageId: ISDSC_DEVICE_NOT_FOUND +// +// MessageText: +// +// Device was not found. +// +#define ISDSC_DEVICE_NOT_FOUND ((ISDSC_STATUS)0xEFFF005DL) + +// +// MessageId: ISDSC_DEVICE_NOT_ISCSI_OR_PERSISTENT +// +// MessageText: +// +// The device specified does not originate from an iSCSI disk or a persistent iSCSI login. +// +#define ISDSC_DEVICE_NOT_ISCSI_OR_PERSISTENT ((ISDSC_STATUS)0xEFFF005EL) + +// +// MessageId: ISDSC_DNS_NAME_UNRESOLVED +// +// MessageText: +// +// The DNS name specified was not resolved. +// +#define ISDSC_DNS_NAME_UNRESOLVED ((ISDSC_STATUS)0xEFFF005FL) + +// +// MessageId: ISDSC_NO_CONNECTION_AVAILABLE +// +// MessageText: +// +// There is no connection available in the iSCSI session to process the request. +// +#define ISDSC_NO_CONNECTION_AVAILABLE ((ISDSC_STATUS)0xEFFF0060L) + +// +// MessageId: ISDSC_LB_POLICY_NOT_SUPPORTED +// +// MessageText: +// +// The given Load Balance policy is not supported. +// +#define ISDSC_LB_POLICY_NOT_SUPPORTED ((ISDSC_STATUS)0xEFFF0061L) + +// +// MessageId: ISDSC_REMOVE_CONNECTION_IN_PROGRESS +// +// MessageText: +// +// A remove connection request is already in progress for this session. +// +#define ISDSC_REMOVE_CONNECTION_IN_PROGRESS ((ISDSC_STATUS)0xEFFF0062L) + +// +// MessageId: ISDSC_INVALID_CONNECTION_ID +// +// MessageText: +// +// Given connection was not found in the session. +// +#define ISDSC_INVALID_CONNECTION_ID ((ISDSC_STATUS)0xEFFF0063L) + +// +// MessageId: ISDSC_CANNOT_REMOVE_LEADING_CONNECTION +// +// MessageText: +// +// The leading connection in the session cannot be removed. +// +#define ISDSC_CANNOT_REMOVE_LEADING_CONNECTION ((ISDSC_STATUS)0xEFFF0064L) + +// +// MessageId: ISDSC_RESTRICTED_BY_GROUP_POLICY +// +// MessageText: +// +// The operation cannot be performed since it does not conform with the group policy assigned to this computer. +// +#define ISDSC_RESTRICTED_BY_GROUP_POLICY ((ISDSC_STATUS)0xEFFF0065L) + +// +// MessageId: ISDSC_ISNS_FIREWALL_BLOCKED +// +// MessageText: +// +// The operation cannot be performed since the Internet Storage Name Server (iSNS) firewall exception has not been enabled. +// +#define ISDSC_ISNS_FIREWALL_BLOCKED ((ISDSC_STATUS)0xEFFF0066L) + +// +// MessageId: ISDSC_FAILURE_TO_PERSIST_LB_POLICY +// +// MessageText: +// +// Failed to persist load balancing policy parameters. +// +#define ISDSC_FAILURE_TO_PERSIST_LB_POLICY ((ISDSC_STATUS)0xEFFF0067L) + +// +// MessageId: ISDSC_INVALID_HOST +// +// MessageText: +// +// The name could not be resolved to an IP Address. +// +#define ISDSC_INVALID_HOST ((ISDSC_STATUS)0xEFFF0068L) + +#endif /* _ISCSIERR_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kernelspecs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kernelspecs.h new file mode 100644 index 0000000000000000000000000000000000000000..2a251c3435bcf0510167fbc834f2f70f2cc91b7e --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kernelspecs.h @@ -0,0 +1,262 @@ +/*****************************************************************************\ +* * +* KernelSpecs.h - markers for documenting the semantics of driver APIs * +* See DriverSpecs.h for detailed comments * +* See also * +* * +* Version 1.2.00 * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +\*****************************************************************************/ + +/*****************************************************************************\ +* NOTE * +* NOTE * +* NOTE * +* The macro bodies in this file are subject to change without notice. * +* Attempting to use the annotations in the macro bodies directly is not * +* supported. * +* NOTE * +* NOTE * +* NOTE * +\*****************************************************************************/ + +/*****************************************************************************\ +* As noted in DriverSpecs.h, this header contains "real" definitions for +* annotations that either never appear in user space, or which are meaningles +* in user space and are #defined to nothing by DriverSpecs.h. +* +* Further commentary appears in DriverSpecs.h. +\*****************************************************************************/ + +#ifndef KERNELSPECS_H +#define KERNELSPECS_H + +#include "DriverSpecs.h" + +#if _MSC_VER > 1000 // [ +#pragma once +#endif // ] + +#ifdef __cplusplus // [ +extern "C" { +#endif // ] + + // --------------------------------------------------------------------- + // The symbolic IRQL values can sometimes end up undefined, so define + // the usual ones here, for PREfast purposes only. + + #define DISPATCH_LEVEL 2 + #define APC_LEVEL 1 + #define PASSIVE_LEVEL 0 + + #if defined(_X86_) + #define HIGH_LEVEL 31 + #endif + #if defined(_AMD64_) + #define HIGH_LEVEL 15 + #endif + #if defined(_ARM_) + #define HIGH_LEVEL 15 + #endif + #if defined(_IA64_) + #define HIGH_LEVEL 15 + #endif + #if defined(_ARM64_) + #define HIGH_LEVEL 15 + #endif + + // + // --------------------------------------------------------------------- + // IRQL annotations: + // + // _IRQL_raises_(irql) + // _IRQL_requires_(irql) + // _IRQL_requires_max_(irql) + // _IRQL_requires_min_(irql) + // _IRQL_saves_ + // _IRQL_saves_global_(kind,param) + // _IRQL_restores_ + // _IRQL_restores_global_(kind,param) + // _IRQL_always_function_min_(irql) + // _IRQL_always_function_max_(irql) + // _IRQL_requires_same_ + // _IRQL_uses_cancel_ + // + // Legacy IRQL annotations: + // Legacy annotation: Use instead: + // __drv_setsIRQL (Obsolete, use _IRQL_raises_) + // __drv_raisesIRQL _IRQL_raises_ + // __drv_requiresIRQL _IRQL_requires_ + // __drv_maxIRQL _IRQL_requires_max_ + // __drv_minIRQL _IRQL_requires_min_ + // __drv_savesIRQL _IRQL_saves_ + // __drv_savesIRQLGlobal _IRQL_saves_global_ + // __drv_restoresIRQL _IRQL_restores_ + // __drv_restoresIRQLGlobal _IRQL_restores_global_ + // __drv_minFunctionIRQL _IRQL_always_function_min_ + // __drv_maxFunctionIRQL _IRQL_always_function_max_ + // __drv_sameIRQL _IRQL_requires_same_ + // __drv_useCancelIRQL _IRQL_uses_cancel_ + // + + // + // The function exits at IRQL irql (obsolete, use _IRQL_raises_) + // + // ';' inside the parens to keep MIDL happy + __ANNOTATION(SAL_IRQL(__int64);) + #undef __drv_setsIRQL + #define __drv_setsIRQL(irql) \ + _SAL1_Source_(__drv_setsIRQL, (), _Post_ _SA_annotes1(SAL_IRQL,irql)) /* legacy */ + + // + // The function exits at IRQL irql, but this may only raise the irql. + // + __ANNOTATION(SAL_raiseIRQL(__int64);) + #undef _IRQL_raises_ + #define _IRQL_raises_(irql) \ + _SAL2_Source_(_IRQL_raises_, (), _Post_ _SA_annotes1(SAL_raiseIRQL,irql)) + #undef __drv_raisesIRQL + #define __drv_raisesIRQL(irql) _SAL1_Source_(__drv_raisesIRQL, (), _IRQL_raises_(irql)) /* legacy */ + + // + // The called function must be entered at IRQL level + // + __ANNOTATION(SAL_IRQL(__int64);) + #undef _IRQL_requires_ + #define _IRQL_requires_(irql) \ + _SAL2_Source_(_IRQL_requires_, (irql), _Pre_ _SA_annotes1(SAL_IRQL,irql)) + #undef __drv_requiresIRQL + #define __drv_requiresIRQL(irql) _SAL1_Source_(__drv_requiresIRQL, (), _IRQL_requires_(irql)) /* legacy */ + + // + // The maximum IRQL at which the function may be called. + // + __ANNOTATION(SAL_maxIRQL(__int64);) + #undef _IRQL_requires_max_ + #define _IRQL_requires_max_(irql) \ + _SAL2_Source_(_IRQL_requires_max_, (irql), _Pre_ _SA_annotes1(SAL_maxIRQL,irql)) + #undef __drv_maxIRQL + #define __drv_maxIRQL(irql) _SAL1_Source_(__drv_maxIRQL, (), _IRQL_requires_max_(irql)) /* legacy */ + + // + // The minimum IRQL at which the function may be called. + // + __ANNOTATION(SAL_minIRQL(__int64);) + #undef _IRQL_requires_min_ + #define _IRQL_requires_min_(irql) \ + _SAL2_Source_(_IRQL_requires_min_, (irql), _Pre_ _SA_annotes1(SAL_minIRQL,irql)) + #undef __drv_minIRQL + #define __drv_minIRQL(irql) _SAL1_Source_(__drv_minIRQL, (), _IRQL_requires_min_(irql)) /* legacy */ + + // + // The current IRQL is saved in the annotated parameter + // + __ANNOTATION(SAL_saveIRQL(void);) + #undef _IRQL_saves_ + #define _IRQL_saves_ \ + _SAL2_Source_(_IRQL_saves_, (), _Post_ _SA_annotes0(SAL_saveIRQL)) + #undef __drv_savesIRQL + #define __drv_savesIRQL _SAL1_Source_(__drv_savesIRQL, (), _IRQL_saves_) /* legacy */ + + // + // The current IRQL is saved in the (otherwise anonymous) global object + // identified by kind and further refined by param. + // + __ANNOTATION(SAL_saveIRQLGlobal(__In_impl_ char *, ...);) + #undef _IRQL_saves_global_ + #define _IRQL_saves_global_(kind,param) \ + _SAL2_Source_(_IRQL_saves_global_, (kind, param), _Post_ _SA_annotes2(SAL_saveIRQLGlobal,#kind, param\t)) + #undef __drv_savesIRQLGlobal + #define __drv_savesIRQLGlobal(kind,param) _SAL1_Source_(__drv_savesIRQLGlobal, (), _IRQL_saves_global_(kind, param)) /* legacy */ + + // + // The current IRQL is restored from the annotated parameter + // + __ANNOTATION(SAL_restoreIRQL(void);) + #undef _IRQL_restores_ + #define _IRQL_restores_ \ + _SAL2_Source_(_IRQL_restores_, (), _Post_ _SA_annotes0(SAL_restoreIRQL)) + #undef __drv_restoresIRQL + #define __drv_restoresIRQL _SAL1_Source_(__drv_restoresIRQL, (), _IRQL_restores_) /* legacy */ + + // + // The current IRQL is restored from the (otherwise anonymous) global + // object identified by kind and further refined by param. + // + __ANNOTATION(SAL_restoreIRQLGlobal(__In_impl_ char *, ...);) + #undef _IRQL_restores_global_ + #define _IRQL_restores_global_(kind,param) \ + _SAL2_Source_(_IRQL_restores_global_, (kind, param), _Post_ _SA_annotes2(SAL_restoreIRQLGlobal, #kind, param\t)) + #undef __drv_restoresIRQLGlobal + #define __drv_restoresIRQLGlobal(kind,param) _SAL1_Source_(__drv_restoresIRQLGlobal, (), _IRQL_restores_global_(kind, param)) /* legacy */ + + // + // The minimum IRQL to which the function can lower itself. The IRQL + // at entry is assumed to be that value unless overridden. + // + __ANNOTATION(SAL_minFunctionIrql(__int64);) + #undef _IRQL_always_function_min_ + #define _IRQL_always_function_min_(irql) \ + _SAL2_Source_(_IRQL_always_function_min_, (irql), _Pre_ _SA_annotes1(SAL_minFunctionIrql,irql)) + #undef __drv_minFunctionIRQL + #define __drv_minFunctionIRQL(irql) _SAL1_Source_(__drv_minFunctionIRQL, (), _IRQL_always_function_min_(irql)) /* legacy */ + + // + // The maximum IRQL to which the function can raise itself. + // + __ANNOTATION(SAL_maxFunctionIrql(__int64);) + #undef _IRQL_always_function_max_ + #define _IRQL_always_function_max_(irql) \ + _SAL2_Source_(_IRQL_always_function_max_, (irql), _Pre_ _SA_annotes1(SAL_maxFunctionIrql,irql)) + #undef __drv_maxFunctionIRQL + #define __drv_maxFunctionIRQL(irql) _SAL1_Source_(__drv_maxFunctionIRQL, (), _IRQL_always_function_max_(irql) ) /* legacy */ + + // + // The function must exit with the same IRQL it was entered with. + // (It may change it but it must restore it.) + // + __ANNOTATION(SAL_sameIRQL(void);) + #undef _IRQL_requires_same_ + #define _IRQL_requires_same_ \ + _SAL2_Source_(_IRQL_requires_same_, (), _Post_ _SA_annotes0(SAL_sameIRQL)) + #undef __drv_sameIRQL + #define __drv_sameIRQL _SAL1_Source_(__drv_sameIRQL, (), _IRQL_requires_same_) /* legacy */ + + // + // The annotated parameter contains the cancelIRQL, which will be restored + // by the called function. + // + __ANNOTATION(SAL_UseCancelIrql(void);) + #undef _IRQL_uses_cancel_ + #define _IRQL_uses_cancel_ \ + _SAL2_Source_(_IRQL_uses_cancel_, (), _Post_ _SA_annotes0(SAL_UseCancelIrql)) + #undef __drv_useCancelIRQL + #define __drv_useCancelIRQL _SAL1_Source_(__drv_useCancelIRQL, (), _IRQL_uses_cancel_) /* legacy */ + + // + // The annotated parameter is an IRQL that will be restored and a new (probably the same) + // value will be inserted. (Use this in preference to directly coding it.) + #undef _IRQL_inout_ + #define _IRQL_inout_ \ + _IRQL_saves_ _IRQL_restores_ + + +#ifdef _PREFAST_ // RC workaround; already #defined to nothing if not needed + // Passing the cancel Irql to a utility function + #undef _IRQL_is_cancel_ + #define _IRQL_is_cancel_ \ + _SAL2_Source_(_IRQL_is_cancel_, (), _IRQL_uses_cancel_ \ + _Releases_nonreentrant_lock_(_Global_cancel_spin_lock_) \ + _At_(return, _IRQL_always_function_min_(DISPATCH_LEVEL) \ + _IRQL_requires_(DISPATCH_LEVEL)) + #undef __drv_isCancelIRQL + #define __drv_isCancelIRQL _SAL1_Source_(__drv_isCancelIRQL, (), _IRQL_is_cancel_) /* legacy */ +#endif + +#ifdef __cplusplus +} +#endif + +#endif // KERNELSPECS_H diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ks.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ks.h new file mode 100644 index 0000000000000000000000000000000000000000..64d983f7c86cf47ed35c92ae6321cca988deee8f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ks.h @@ -0,0 +1,6600 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ks.h + +Abstract: + + Windows Driver Model/Connection and Streaming Architecture (WDM-CSA) + core definitions. +--*/ +#if !defined(_KS_) +#define _KS_ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4214) // bit field types other than int + +#if defined(__TCS__) +#define _KS_NO_ANONYMOUS_STRUCTURES_ 1 +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#if !defined(_NTRTL_) + #ifndef DEFINE_GUIDEX + #define DEFINE_GUIDEX(name) EXTERN_C const CDECL GUID name + #endif // !defined(DEFINE_GUIDEX) + + #ifndef STATICGUIDOF + #define STATICGUIDOF(guid) STATIC_##guid + #endif // !defined(STATICGUIDOF) +#endif // !defined(_NTRTL_) + +#ifndef SIZEOF_ARRAY + #define SIZEOF_ARRAY(ar) (sizeof(ar)/sizeof((ar)[0])) +#endif // !defined(SIZEOF_ARRAY) + +#if defined(__cplusplus) && _MSC_VER >= 1100 +#define DEFINE_GUIDSTRUCT(g, n) struct __declspec(uuid(g)) n +#define DEFINE_GUIDNAMED(n) __uuidof(struct n) +#else // !defined(__cplusplus) +#define DEFINE_GUIDSTRUCT(g, n) DEFINE_GUIDEX(n) +#define DEFINE_GUIDNAMED(n) n +#endif // !defined(__cplusplus) + +//=========================================================================== + +#define STATIC_GUID_NULL \ + 0x00000000L, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 + +#pragma prefast(suppress: 6244, "duplicate definition is harmless in this case") +DEFINE_GUIDSTRUCT("00000000-0000-0000-0000-000000000000", GUID_NULL); +#define GUID_NULL DEFINE_GUIDNAMED(GUID_NULL) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +//=========================================================================== + +#define IOCTL_KS_PROPERTY CTL_CODE(FILE_DEVICE_KS, 0x000, METHOD_NEITHER, FILE_ANY_ACCESS) +#define IOCTL_KS_ENABLE_EVENT CTL_CODE(FILE_DEVICE_KS, 0x001, METHOD_NEITHER, FILE_ANY_ACCESS) +#define IOCTL_KS_DISABLE_EVENT CTL_CODE(FILE_DEVICE_KS, 0x002, METHOD_NEITHER, FILE_ANY_ACCESS) +#define IOCTL_KS_METHOD CTL_CODE(FILE_DEVICE_KS, 0x003, METHOD_NEITHER, FILE_ANY_ACCESS) +#define IOCTL_KS_WRITE_STREAM CTL_CODE(FILE_DEVICE_KS, 0x004, METHOD_NEITHER, FILE_WRITE_ACCESS) +#define IOCTL_KS_READ_STREAM CTL_CODE(FILE_DEVICE_KS, 0x005, METHOD_NEITHER, FILE_READ_ACCESS) +#define IOCTL_KS_RESET_STATE CTL_CODE(FILE_DEVICE_KS, 0x006, METHOD_NEITHER, FILE_ANY_ACCESS) + +//=========================================================================== + +typedef enum { + KSRESET_BEGIN, + KSRESET_END +} KSRESET; + +typedef enum { + KSSTATE_STOP, + KSSTATE_ACQUIRE, + KSSTATE_PAUSE, + KSSTATE_RUN +} KSSTATE, *PKSSTATE; + +#define KSPRIORITY_LOW 0x00000001 +#define KSPRIORITY_NORMAL 0x40000000 +#define KSPRIORITY_HIGH 0x80000000 +#define KSPRIORITY_EXCLUSIVE 0xFFFFFFFF + +typedef struct { + ULONG PriorityClass; + ULONG PrioritySubClass; +} KSPRIORITY, *PKSPRIORITY; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#pragma warning(disable:4201) // nameless struct/union + +typedef struct { + union { +#if defined( _KS_NO_ANONYMOUS_STRUCTURES_ ) + struct _IDENTIFIER { +#else + struct { +#endif + GUID Set; + ULONG Id; + ULONG Flags; + }; + LONGLONG Alignment; + }; +} KSIDENTIFIER, *PKSIDENTIFIER; + +typedef KSIDENTIFIER KSPROPERTY, *PKSPROPERTY, KSMETHOD, *PKSMETHOD, KSEVENT, *PKSEVENT; + +#define KSMETHOD_TYPE_NONE 0x00000000 +#define KSMETHOD_TYPE_READ 0x00000001 +#define KSMETHOD_TYPE_WRITE 0x00000002 +#define KSMETHOD_TYPE_MODIFY 0x00000003 +#define KSMETHOD_TYPE_SOURCE 0x00000004 + +#define KSMETHOD_TYPE_SEND 0x00000001 +#define KSMETHOD_TYPE_SETSUPPORT 0x00000100 +#define KSMETHOD_TYPE_BASICSUPPORT 0x00000200 + +#define KSMETHOD_TYPE_TOPOLOGY 0x10000000 + +#define KSPROPERTY_TYPE_GET 0x00000001 +#define KSPROPERTY_TYPE_GETPAYLOADSIZE 0x00000004 +#define KSPROPERTY_TYPE_SET 0x00000002 +#define KSPROPERTY_TYPE_GETPAYLOADSIZE 0x00000004 +#define KSPROPERTY_TYPE_SETSUPPORT 0x00000100 +#define KSPROPERTY_TYPE_BASICSUPPORT 0x00000200 +#define KSPROPERTY_TYPE_RELATIONS 0x00000400 +#define KSPROPERTY_TYPE_SERIALIZESET 0x00000800 +#define KSPROPERTY_TYPE_UNSERIALIZESET 0x00001000 +#define KSPROPERTY_TYPE_SERIALIZERAW 0x00002000 +#define KSPROPERTY_TYPE_UNSERIALIZERAW 0x00004000 +#define KSPROPERTY_TYPE_SERIALIZESIZE 0x00008000 +#define KSPROPERTY_TYPE_DEFAULTVALUES 0x00010000 + +#define KSPROPERTY_TYPE_TOPOLOGY 0x10000000 +#define KSPROPERTY_TYPE_HIGHPRIORITY 0x08000000 +#define KSPROPERTY_TYPE_FSFILTERSCOPE 0x40000000 +#define KSPROPERTY_TYPE_COPYPAYLOAD 0x80000000 + +typedef struct { + KSPROPERTY Property; + ULONG NodeId; + ULONG Reserved; +} KSP_NODE, *PKSP_NODE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct { + KSMETHOD Method; + ULONG NodeId; + ULONG Reserved; +} KSM_NODE, *PKSM_NODE; + +typedef struct { + KSEVENT Event; + ULONG NodeId; + ULONG Reserved; +} KSE_NODE, *PKSE_NODE; + +#define STATIC_KSPROPTYPESETID_General \ + 0x97E99BA0L, 0xBDEA, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("97E99BA0-BDEA-11CF-A5D6-28DB04C10000", KSPROPTYPESETID_General); +#define KSPROPTYPESETID_General DEFINE_GUIDNAMED(KSPROPTYPESETID_General) + +#if defined(_NTDDK_) && !defined(__wtypes_h__) +enum VARENUM { + VT_EMPTY = 0, + VT_NULL = 1, + VT_I2 = 2, + VT_I4 = 3, + VT_R4 = 4, + VT_R8 = 5, + VT_CY = 6, + VT_DATE = 7, + VT_BSTR = 8, + VT_DISPATCH = 9, + VT_ERROR = 10, + VT_BOOL = 11, + VT_VARIANT = 12, + VT_UNKNOWN = 13, + VT_DECIMAL = 14, + VT_I1 = 16, + VT_UI1 = 17, + VT_UI2 = 18, + VT_UI4 = 19, + VT_I8 = 20, + VT_UI8 = 21, + VT_INT = 22, + VT_UINT = 23, + VT_VOID = 24, + VT_HRESULT = 25, + VT_PTR = 26, + VT_SAFEARRAY = 27, + VT_CARRAY = 28, + VT_USERDEFINED = 29, + VT_LPSTR = 30, + VT_LPWSTR = 31, + VT_FILETIME = 64, + VT_BLOB = 65, + VT_STREAM = 66, + VT_STORAGE = 67, + VT_STREAMED_OBJECT = 68, + VT_STORED_OBJECT = 69, + VT_BLOB_OBJECT = 70, + VT_CF = 71, + VT_CLSID = 72, + VT_VECTOR = 0x1000, + VT_ARRAY = 0x2000, + VT_BYREF = 0x4000, + VT_RESERVED = 0x8000, + VT_ILLEGAL = 0xffff, + VT_ILLEGALMASKED = 0xfff, + VT_TYPEMASK = 0xfff +}; +#endif // _NTDDK_ && !__wtypes_h__ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +typedef struct { + ULONG Size; + ULONG Count; +} KSMULTIPLE_ITEM, *PKSMULTIPLE_ITEM; + +typedef struct { + ULONG AccessFlags; + ULONG DescriptionSize; + KSIDENTIFIER PropTypeSet; + ULONG MembersListCount; + ULONG Reserved; +} KSPROPERTY_DESCRIPTION, *PKSPROPERTY_DESCRIPTION; + +#define KSPROPERTY_MEMBER_RANGES 0x00000001 +#define KSPROPERTY_MEMBER_STEPPEDRANGES 0x00000002 +#define KSPROPERTY_MEMBER_VALUES 0x00000003 + +#define KSPROPERTY_MEMBER_FLAG_DEFAULT 0x00000001 +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define KSPROPERTY_MEMBER_FLAG_BASICSUPPORT_MULTICHANNEL 0x00000002 +#define KSPROPERTY_MEMBER_FLAG_BASICSUPPORT_UNIFORM 0x00000004 +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +typedef struct { + ULONG MembersFlags; + ULONG MembersSize; + ULONG MembersCount; + ULONG Flags; +} KSPROPERTY_MEMBERSHEADER, *PKSPROPERTY_MEMBERSHEADER; + +typedef union { +#if defined( _KS_NO_ANONYMOUS_STRUCTURES_ ) + struct _SIGNED { +#else + struct { +#endif + LONG SignedMinimum; + LONG SignedMaximum; + }; +#if defined( _KS_NO_ANONYMOUS_STRUCTURES_ ) + struct _UNSIGNED { +#else + struct { +#endif + ULONG UnsignedMinimum; + ULONG UnsignedMaximum; + }; +} KSPROPERTY_BOUNDS_LONG, *PKSPROPERTY_BOUNDS_LONG; + +typedef union { +#if defined( _KS_NO_ANONYMOUS_STRUCTURES_ ) + struct _SIGNED64 { +#else + struct { +#endif + LONGLONG SignedMinimum; + LONGLONG SignedMaximum; + }; +#if defined( _KS_NO_ANONYMOUS_STRUCTURES_ ) + struct _UNSIGNED64 { +#else + struct { +#endif +#if defined(_NTDDK_) + ULONGLONG UnsignedMinimum; + ULONGLONG UnsignedMaximum; +#else // !_NTDDK_ + DWORDLONG UnsignedMinimum; + DWORDLONG UnsignedMaximum; +#endif // !_NTDDK_ + }; +} KSPROPERTY_BOUNDS_LONGLONG, *PKSPROPERTY_BOUNDS_LONGLONG; + +typedef struct { + ULONG SteppingDelta; + ULONG Reserved; + KSPROPERTY_BOUNDS_LONG Bounds; +} KSPROPERTY_STEPPING_LONG, *PKSPROPERTY_STEPPING_LONG; + +typedef struct { +#if defined(_NTDDK_) + ULONGLONG SteppingDelta; +#else // !_NTDDK_ + DWORDLONG SteppingDelta; +#endif // !_NTDDK_ + KSPROPERTY_BOUNDS_LONGLONG Bounds; +} KSPROPERTY_STEPPING_LONGLONG, *PKSPROPERTY_STEPPING_LONGLONG; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +//=========================================================================== +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#if defined(_NTDDK_) +// +// Structure forward declarations. +// +typedef struct _KSDEVICE_DESCRIPTOR +KSDEVICE_DESCRIPTOR, *PKSDEVICE_DESCRIPTOR; +typedef struct _KSDEVICE_DISPATCH +KSDEVICE_DISPATCH, *PKSDEVICE_DISPATCH; +typedef struct _KSDEVICE +KSDEVICE, *PKSDEVICE; +typedef struct _KSFILTERFACTORY +KSFILTERFACTORY, *PKSFILTERFACTORY; +typedef struct _KSFILTER_DESCRIPTOR +KSFILTER_DESCRIPTOR, *PKSFILTER_DESCRIPTOR; +typedef struct _KSFILTER_DISPATCH +KSFILTER_DISPATCH, *PKSFILTER_DISPATCH; +typedef struct _KSFILTER +KSFILTER, *PKSFILTER; +typedef struct _KSPIN_DESCRIPTOR_EX +KSPIN_DESCRIPTOR_EX, *PKSPIN_DESCRIPTOR_EX; +typedef struct _KSPIN_DISPATCH +KSPIN_DISPATCH, *PKSPIN_DISPATCH; +typedef struct _KSCLOCK_DISPATCH +KSCLOCK_DISPATCH, *PKSCLOCK_DISPATCH; +typedef struct _KSALLOCATOR_DISPATCH +KSALLOCATOR_DISPATCH, *PKSALLOCATOR_DISPATCH; +typedef struct _KSPIN +KSPIN, *PKSPIN; +typedef struct _KSNODE_DESCRIPTOR +KSNODE_DESCRIPTOR, *PKSNODE_DESCRIPTOR; +typedef struct _KSSTREAM_POINTER_OFFSET +KSSTREAM_POINTER_OFFSET, *PKSSTREAM_POINTER_OFFSET; +typedef struct _KSSTREAM_POINTER +KSSTREAM_POINTER, *PKSSTREAM_POINTER; +typedef struct _KSMAPPING +KSMAPPING, *PKSMAPPING; +typedef struct _KSPROCESSPIN +KSPROCESSPIN, *PKSPROCESSPIN; +typedef struct _KSPROCESSPIN_INDEXENTRY +KSPROCESSPIN_INDEXENTRY, *PKSPROCESSPIN_INDEXENTRY; +#endif // _NTDDK_ + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +typedef PVOID PKSWORKER; + +typedef struct { + ULONG NotificationType; + union { + struct { + HANDLE Event; + ULONG_PTR Reserved[2]; + } EventHandle; + struct { + HANDLE Semaphore; + ULONG Reserved; + LONG Adjustment; + } SemaphoreHandle; +#if defined(_NTDDK_) + struct { + PVOID Event; + KPRIORITY Increment; + ULONG_PTR Reserved; + } EventObject; + struct { + PVOID Semaphore; + KPRIORITY Increment; + LONG Adjustment; + } SemaphoreObject; + struct { + PKDPC Dpc; + ULONG ReferenceCount; + ULONG_PTR Reserved; + } Dpc; + struct { + PWORK_QUEUE_ITEM WorkQueueItem; + WORK_QUEUE_TYPE WorkQueueType; + ULONG_PTR Reserved; + } WorkItem; + struct { + PWORK_QUEUE_ITEM WorkQueueItem; + PKSWORKER KsWorkerObject; + ULONG_PTR Reserved; + } KsWorkItem; +#endif // defined(_NTDDK_) + struct { + PVOID Unused; + LONG_PTR Alignment[2]; + } Alignment; + }; +} KSEVENTDATA, *PKSEVENTDATA; + +#define KSEVENTF_EVENT_HANDLE 0x00000001 +#define KSEVENTF_SEMAPHORE_HANDLE 0x00000002 +#if defined(_NTDDK_) +#define KSEVENTF_EVENT_OBJECT 0x00000004 +#define KSEVENTF_SEMAPHORE_OBJECT 0x00000008 +#define KSEVENTF_DPC 0x00000010 +#define KSEVENTF_WORKITEM 0x00000020 +#define KSEVENTF_KSWORKITEM 0x00000080 +#endif // defined(_NTDDK_) + +#define KSEVENT_TYPE_ENABLE 0x00000001 +#define KSEVENT_TYPE_ONESHOT 0x00000002 +#define KSEVENT_TYPE_ENABLEBUFFERED 0x00000004 +#define KSEVENT_TYPE_SETSUPPORT 0x00000100 +#define KSEVENT_TYPE_BASICSUPPORT 0x00000200 +#define KSEVENT_TYPE_QUERYBUFFER 0x00000400 + +#define KSEVENT_TYPE_TOPOLOGY 0x10000000 + +typedef struct { + KSEVENT Event; + PKSEVENTDATA EventData; + PVOID Reserved; +} KSQUERYBUFFER, *PKSQUERYBUFFER; + +typedef struct { + ULONG Size; + ULONG Flags; + union { + HANDLE ObjectHandle; + PVOID ObjectPointer; + }; + PVOID Reserved; + KSEVENT Event; + KSEVENTDATA EventData; +} KSRELATIVEEVENT; + +#define KSRELATIVEEVENT_FLAG_HANDLE 0x00000001 +#define KSRELATIVEEVENT_FLAG_POINTER 0x00000002 + +//=========================================================================== + +typedef struct { + KSEVENTDATA EventData; + LONGLONG MarkTime; +} KSEVENT_TIME_MARK, *PKSEVENT_TIME_MARK; + +typedef struct { + KSEVENTDATA EventData; + LONGLONG TimeBase; + LONGLONG Interval; +} KSEVENT_TIME_INTERVAL, *PKSEVENT_TIME_INTERVAL; + +typedef struct { + LONGLONG TimeBase; + LONGLONG Interval; +} KSINTERVAL, *PKSINTERVAL; + +//=========================================================================== + +#define STATIC_KSPROPSETID_General\ + 0x1464EDA5L, 0x6A8F, 0x11D1, 0x9A, 0xA7, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("1464EDA5-6A8F-11D1-9AA7-00A0C9223196", KSPROPSETID_General); +#define KSPROPSETID_General DEFINE_GUIDNAMED(KSPROPSETID_General) + +typedef enum { + KSPROPERTY_GENERAL_COMPONENTID +} KSPROPERTY_GENERAL; + +typedef struct { + GUID Manufacturer; + GUID Product; + GUID Component; + GUID Name; + ULONG Version; + ULONG Revision; +} KSCOMPONENTID, *PKSCOMPONENTID; + +#define DEFINE_KSPROPERTY_ITEM_GENERAL_COMPONENTID(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_GENERAL_COMPONENTID,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSCOMPONENTID),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define STATIC_KSMETHODSETID_StreamIo\ + 0x65D003CAL, 0x1523, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("65D003CA-1523-11D2-B27A-00A0C9223196", KSMETHODSETID_StreamIo); +#define KSMETHODSETID_StreamIo DEFINE_GUIDNAMED(KSMETHODSETID_StreamIo) + +typedef enum { + KSMETHOD_STREAMIO_READ, + KSMETHOD_STREAMIO_WRITE +} KSMETHOD_STREAMIO; + +#define DEFINE_KSMETHOD_ITEM_STREAMIO_READ(Handler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_STREAMIO_READ,\ + KSMETHOD_TYPE_WRITE,\ + (Handler),\ + sizeof(KSMETHOD),\ + 0,\ + NULL) + +#define DEFINE_KSMETHOD_ITEM_STREAMIO_WRITE(Handler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_STREAMIO_WRITE,\ + KSMETHOD_TYPE_READ,\ + (Handler),\ + sizeof(KSMETHOD),\ + 0,\ + NULL) + +#define STATIC_KSPROPSETID_MediaSeeking\ + 0xEE904F0CL, 0xD09B, 0x11D0, 0xAB, 0xE9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("EE904F0C-D09B-11D0-ABE9-00A0C9223196", KSPROPSETID_MediaSeeking); +#define KSPROPSETID_MediaSeeking DEFINE_GUIDNAMED(KSPROPSETID_MediaSeeking) + +typedef enum { + KSPROPERTY_MEDIASEEKING_CAPABILITIES, + KSPROPERTY_MEDIASEEKING_FORMATS, + KSPROPERTY_MEDIASEEKING_TIMEFORMAT, + KSPROPERTY_MEDIASEEKING_POSITION, + KSPROPERTY_MEDIASEEKING_STOPPOSITION, + KSPROPERTY_MEDIASEEKING_POSITIONS, + KSPROPERTY_MEDIASEEKING_DURATION, + KSPROPERTY_MEDIASEEKING_AVAILABLE, + KSPROPERTY_MEDIASEEKING_PREROLL, + KSPROPERTY_MEDIASEEKING_CONVERTTIMEFORMAT +} KSPROPERTY_MEDIASEEKING; + +typedef enum { + KS_SEEKING_NoPositioning, + KS_SEEKING_AbsolutePositioning, + KS_SEEKING_RelativePositioning, + KS_SEEKING_IncrementalPositioning, + KS_SEEKING_PositioningBitsMask = 0x3, + KS_SEEKING_SeekToKeyFrame, + KS_SEEKING_ReturnTime = 0x8 +} KS_SEEKING_FLAGS; + +typedef enum { + KS_SEEKING_CanSeekAbsolute = 0x1, + KS_SEEKING_CanSeekForwards = 0x2, + KS_SEEKING_CanSeekBackwards = 0x4, + KS_SEEKING_CanGetCurrentPos = 0x8, + KS_SEEKING_CanGetStopPos = 0x10, + KS_SEEKING_CanGetDuration = 0x20, + KS_SEEKING_CanPlayBackwards = 0x40 +} KS_SEEKING_CAPABILITIES; + +typedef struct { + LONGLONG Current; + LONGLONG Stop; + KS_SEEKING_FLAGS CurrentFlags; + KS_SEEKING_FLAGS StopFlags; +} KSPROPERTY_POSITIONS, *PKSPROPERTY_POSITIONS; + +typedef struct { + LONGLONG Earliest; + LONGLONG Latest; +} KSPROPERTY_MEDIAAVAILABLE, *PKSPROPERTY_MEDIAAVAILABLE; + +typedef struct { + KSPROPERTY Property; + GUID SourceFormat; + GUID TargetFormat; + LONGLONG Time; +} KSP_TIMEFORMAT, *PKSP_TIMEFORMAT; + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_CAPABILITIES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_CAPABILITIES,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KS_SEEKING_CAPABILITIES),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_FORMATS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_FORMATS,\ + (Handler),\ + sizeof(KSPROPERTY),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_TIMEFORMAT(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_TIMEFORMAT,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(GUID),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_POSITION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_POSITION,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_STOPPOSITION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_STOPPOSITION,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_POSITIONS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_POSITIONS,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(KSPROPERTY_POSITIONS),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_DURATION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_DURATION,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_AVAILABLE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_AVAILABLE,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSPROPERTY_MEDIAAVAILABLE),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_PREROLL(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_PREROLL,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_MEDIASEEKING_CONVERTTIMEFORMAT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEDIASEEKING_CONVERTTIMEFORMAT,\ + (Handler),\ + sizeof(KSP_TIMEFORMAT),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +//=========================================================================== + +#define STATIC_KSPROPSETID_Topology\ + 0x720D4AC0L, 0x7533, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("720D4AC0-7533-11D0-A5D6-28DB04C10000", KSPROPSETID_Topology); +#define KSPROPSETID_Topology DEFINE_GUIDNAMED(KSPROPSETID_Topology) + +typedef enum { + KSPROPERTY_TOPOLOGY_CATEGORIES, + KSPROPERTY_TOPOLOGY_NODES, + KSPROPERTY_TOPOLOGY_CONNECTIONS, + KSPROPERTY_TOPOLOGY_NAME +} KSPROPERTY_TOPOLOGY; + +#define DEFINE_KSPROPERTY_ITEM_TOPOLOGY_CATEGORIES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_TOPOLOGY_CATEGORIES,\ + (Handler),\ + sizeof(KSPROPERTY),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_TOPOLOGY_NODES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_TOPOLOGY_NODES,\ + (Handler),\ + sizeof(KSPROPERTY),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_TOPOLOGY_CONNECTIONS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_TOPOLOGY_CONNECTIONS,\ + (Handler),\ + sizeof(KSPROPERTY),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_TOPOLOGY_NAME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_TOPOLOGY_NAME,\ + (Handler),\ + sizeof(KSP_NODE),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_TOPOLOGYSET(TopologySet, Handler)\ +DEFINE_KSPROPERTY_TABLE(TopologySet) {\ + DEFINE_KSPROPERTY_ITEM_TOPOLOGY_CATEGORIES(Handler),\ + DEFINE_KSPROPERTY_ITEM_TOPOLOGY_NODES(Handler),\ + DEFINE_KSPROPERTY_ITEM_TOPOLOGY_CONNECTIONS(Handler),\ + DEFINE_KSPROPERTY_ITEM_TOPOLOGY_NAME(Handler)\ +} + +//============================================================================= + +// +// properties used by graph manager to talk to particular filters +// +#if defined(_NTDDK_) + +#define STATIC_KSPROPSETID_GM \ + 0xAF627536L, 0xE719, 0x11D2, 0x8A, 0x1D, 0x00, 0x60, 0x97, 0xD2, 0xDF, 0x5D +DEFINE_GUIDSTRUCT("AF627536-E719-11D2-8A1D-006097D2DF5D", KSPROPSETID_GM); +#define KSPROPSETID_GM DEFINE_GUIDNAMED(KSPROPSETID_GM) + +typedef VOID (*PFNKSGRAPHMANAGER_NOTIFY)(_In_ PFILE_OBJECT GraphManager, + _In_ ULONG EventId, + _In_ PVOID Filter, + _In_ PVOID Pin, + _In_ PVOID Frame, + _In_ ULONG Duration); + +typedef struct KSGRAPHMANAGER_FUNCTIONTABLE { + PFNKSGRAPHMANAGER_NOTIFY NotifyEvent; +} KSGRAPHMANAGER_FUNCTIONTABLE, PKSGRAPHMANAGER_FUNCTIONTABLE; + +typedef struct _KSPROPERTY_GRAPHMANAGER_INTERFACE { + PFILE_OBJECT GraphManager; + KSGRAPHMANAGER_FUNCTIONTABLE FunctionTable; +} KSPROPERTY_GRAPHMANAGER_INTERFACE, *PKSPROPERTY_GRAPHMANAGER_INTERFACE; + + +// +// Commands +// +typedef enum { + KSPROPERTY_GM_GRAPHMANAGER, + KSPROPERTY_GM_TIMESTAMP_CLOCK, + KSPROPERTY_GM_RATEMATCH, + KSPROPERTY_GM_RENDER_CLOCK, +} KSPROPERTY_GM; + +#endif + +//=========================================================================== + + +#define STATIC_KSCATEGORY_BRIDGE \ + 0x085AFF00L, 0x62CE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("085AFF00-62CE-11CF-A5D6-28DB04C10000", KSCATEGORY_BRIDGE); +#define KSCATEGORY_BRIDGE DEFINE_GUIDNAMED(KSCATEGORY_BRIDGE) + +#define STATIC_KSCATEGORY_CAPTURE \ + 0x65E8773DL, 0x8F56, 0x11D0, 0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("65E8773D-8F56-11D0-A3B9-00A0C9223196", KSCATEGORY_CAPTURE); +#define KSCATEGORY_CAPTURE DEFINE_GUIDNAMED(KSCATEGORY_CAPTURE) + +#define STATIC_KSCATEGORY_VIDEO_CAMERA \ + 0xe5323777, 0xf976, 0x4f5b, 0x9b, 0x55, 0xb9, 0x46, 0x99, 0xc4, 0x6e, 0x44 +DEFINE_GUIDSTRUCT("E5323777-F976-4f5b-9B55-B94699C46E44", KSCATEGORY_VIDEO_CAMERA); +#define KSCATEGORY_VIDEO_CAMERA DEFINE_GUIDNAMED(KSCATEGORY_VIDEO_CAMERA) + +#define STATIC_KSCATEGORY_SENSOR_CAMERA \ + 0x24e552d7, 0x6523, 0x47f7, 0xa6, 0x47, 0xd3, 0x46, 0x5b, 0xf1, 0xf5, 0xca +DEFINE_GUIDSTRUCT("24E552D7-6523-47F7-A647-D3465BF1F5CA", KSCATEGORY_SENSOR_CAMERA); +#define KSCATEGORY_SENSOR_CAMERA DEFINE_GUIDNAMED(KSCATEGORY_SENSOR_CAMERA) + +#define STATIC_KSCATEGORY_NETWORK_CAMERA \ + 0xb8238652, 0xb500, 0x41eb, 0xb4, 0xf3, 0x42, 0x34, 0xf7, 0xf5, 0xae, 0x99 +DEFINE_GUIDSTRUCT("B8238652-B500-41EB-B4F3-4234F7F5AE99", KSCATEGORY_NETWORK_CAMERA); +#define KSCATEGORY_NETWORK_CAMERA DEFINE_GUIDNAMED(KSCATEGORY_NETWORK_CAMERA) + +#define STATIC_KSCATEGORY_SENSOR_GROUP \ + 0x669C7214, 0x0A88, 0x4311, 0xA7, 0xF3, 0x4E, 0x79, 0x82, 0x0E, 0x33, 0xBD +DEFINE_GUIDSTRUCT("669C7214-0A88-4311-A7F3-4E79820E33BD", KSCATEGORY_SENSOR_GROUP); +#define KSCATEGORY_SENSOR_GROUP DEFINE_GUIDNAMED(KSCATEGORY_SENSOR_GROUP) + +#define STATIC_KSCATEGORY_RENDER \ + 0x65E8773EL, 0x8F56, 0x11D0, 0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("65E8773E-8F56-11D0-A3B9-00A0C9223196", KSCATEGORY_RENDER); +#define KSCATEGORY_RENDER DEFINE_GUIDNAMED(KSCATEGORY_RENDER) + +#define STATIC_KSCATEGORY_MIXER \ + 0xAD809C00L, 0x7B88, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("AD809C00-7B88-11D0-A5D6-28DB04C10000", KSCATEGORY_MIXER); +#define KSCATEGORY_MIXER DEFINE_GUIDNAMED(KSCATEGORY_MIXER) + +#define STATIC_KSCATEGORY_SPLITTER \ + 0x0A4252A0L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("0A4252A0-7E70-11D0-A5D6-28DB04C10000", KSCATEGORY_SPLITTER); +#define KSCATEGORY_SPLITTER DEFINE_GUIDNAMED(KSCATEGORY_SPLITTER) + +#define STATIC_KSCATEGORY_DATACOMPRESSOR \ + 0x1E84C900L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("1E84C900-7E70-11D0-A5D6-28DB04C10000", KSCATEGORY_DATACOMPRESSOR); +#define KSCATEGORY_DATACOMPRESSOR DEFINE_GUIDNAMED(KSCATEGORY_DATACOMPRESSOR) + +#define STATIC_KSCATEGORY_DATADECOMPRESSOR \ + 0x2721AE20L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("2721AE20-7E70-11D0-A5D6-28DB04C10000", KSCATEGORY_DATADECOMPRESSOR); +#define KSCATEGORY_DATADECOMPRESSOR DEFINE_GUIDNAMED(KSCATEGORY_DATADECOMPRESSOR) + +#define STATIC_KSCATEGORY_DATATRANSFORM \ + 0x2EB07EA0L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("2EB07EA0-7E70-11D0-A5D6-28DB04C10000", KSCATEGORY_DATATRANSFORM); +#define KSCATEGORY_DATATRANSFORM DEFINE_GUIDNAMED(KSCATEGORY_DATATRANSFORM) + +// +// KSMFT_CATEGORY_XXX are MF Transform category guids redefined in ks.h +// to facilitate KS Mini drivers to register KS Filters under MF Transform categories. +// +#define STATIC_KSMFT_CATEGORY_VIDEO_DECODER \ + 0xd6c02d4b, 0x6833, 0x45b4, 0x97, 0x1a, 0x05, 0xa4, 0xb0, 0x4b, 0xab, 0x91 +DEFINE_GUIDSTRUCT("d6c02d4b-6833-45b4-971a-05a4b04bab91", KSMFT_CATEGORY_VIDEO_DECODER); +#define KSMFT_CATEGORY_VIDEO_DECODER DEFINE_GUIDNAMED(KSMFT_CATEGORY_VIDEO_DECODER) + +#define STATIC_KSMFT_CATEGORY_VIDEO_ENCODER \ + 0xf79eac7d, 0xe545, 0x4387, 0xbd, 0xee, 0xd6, 0x47, 0xd7, 0xbd, 0xe4, 0x2a +DEFINE_GUIDSTRUCT("f79eac7d-e545-4387-bdee-d647d7bde42a", KSMFT_CATEGORY_VIDEO_ENCODER); +#define KSMFT_CATEGORY_VIDEO_ENCODER DEFINE_GUIDNAMED(KSMFT_CATEGORY_VIDEO_ENCODER) + +#define STATIC_KSMFT_CATEGORY_VIDEO_EFFECT \ + 0x12e17c21, 0x532c, 0x4a6e, 0x8a, 0x1c, 0x40, 0x82, 0x5a, 0x73, 0x63, 0x97 +DEFINE_GUIDSTRUCT("12e17c21-532c-4a6e-8a1c-40825a736397", KSMFT_CATEGORY_VIDEO_EFFECT); +#define KSMFT_CATEGORY_VIDEO_EFFECT DEFINE_GUIDNAMED(KSMFT_CATEGORY_VIDEO_EFFECT) + +#define STATIC_KSMFT_CATEGORY_MULTIPLEXER \ + 0x059c561e, 0x05ae, 0x4b61, 0xb6, 0x9d, 0x55, 0xb6, 0x1e, 0xe5, 0x4a, 0x7b +DEFINE_GUIDSTRUCT("059c561e-05ae-4b61-b69d-55b61ee54a7b", KSMFT_CATEGORY_MULTIPLEXER); +#define KSMFT_CATEGORY_MULTIPLEXER DEFINE_GUIDNAMED(KSMFT_CATEGORY_MULTIPLEXER) + +#define STATIC_KSMFT_CATEGORY_DEMULTIPLEXER \ + 0xa8700a7a, 0x939b, 0x44c5, 0x99, 0xd7, 0x76, 0x22, 0x6b, 0x23, 0xb3, 0xf1 +DEFINE_GUIDSTRUCT("a8700a7a-939b-44c5-99d7-76226b23b3f1", KSMFT_CATEGORY_DEMULTIPLEXER); +#define KSMFT_CATEGORY_DEMULTIPLEXER DEFINE_GUIDNAMED(KSMFT_CATEGORY_DEMULTIPLEXER) + +#define STATIC_KSMFT_CATEGORY_AUDIO_DECODER \ + 0x9ea73fb4, 0xef7a, 0x4559, 0x8d, 0x5d, 0x71, 0x9d, 0x8f, 0x04, 0x26, 0xc7 +DEFINE_GUIDSTRUCT("9ea73fb4-ef7a-4559-8d5d-719d8f0426c7", KSMFT_CATEGORY_AUDIO_DECODER); +#define KSMFT_CATEGORY_AUDIO_DECODER DEFINE_GUIDNAMED(KSMFT_CATEGORY_AUDIO_DECODER) + +#define STATIC_KSMFT_CATEGORY_AUDIO_ENCODER \ + 0x91c64bd0, 0xf91e, 0x4d8c, 0x92, 0x76, 0xdb, 0x24, 0x82, 0x79, 0xd9, 0x75 +DEFINE_GUIDSTRUCT("91c64bd0-f91e-4d8c-9276-db248279d975", KSMFT_CATEGORY_AUDIO_ENCODER); +#define KSMFT_CATEGORY_AUDIO_ENCODER DEFINE_GUIDNAMED(KSMFT_CATEGORY_AUDIO_ENCODER) + +#define STATIC_KSMFT_CATEGORY_AUDIO_EFFECT \ + 0x11064c48, 0x3648, 0x4ed0, 0x93, 0x2e, 0x05, 0xce, 0x8a, 0xc8, 0x11, 0xb7 +DEFINE_GUIDSTRUCT("11064c48-3648-4ed0-932e-05ce8ac811b7", KSMFT_CATEGORY_AUDIO_EFFECT); +#define KSMFT_CATEGORY_AUDIO_EFFECT DEFINE_GUIDNAMED(KSMFT_CATEGORY_AUDIO_EFFECT) + +#define STATIC_KSMFT_CATEGORY_VIDEO_PROCESSOR \ + 0x302ea3fc, 0xaa5f, 0x47f9, 0x9f, 0x7a, 0xc2, 0x18, 0x8b, 0xb1, 0x63, 0x2 +DEFINE_GUIDSTRUCT("302ea3fc-aa5f-47f9-9f7a-c2188bb16302", KSMFT_CATEGORY_VIDEO_PROCESSOR); +#define KSMFT_CATEGORY_VIDEO_PROCESSOR DEFINE_GUIDNAMED(KSMFT_CATEGORY_VIDEO_PROCESSOR) + +#define STATIC_KSMFT_CATEGORY_OTHER \ + 0x90175d57, 0xb7ea, 0x4901, 0xae, 0xb3, 0x93, 0x3a, 0x87, 0x47, 0x75, 0x6f +DEFINE_GUIDSTRUCT("90175d57-b7ea-4901-aeb3-933a8747756f", KSMFT_CATEGORY_OTHER); +#define KSMFT_CATEGORY_OTHER DEFINE_GUIDNAMED(KSMFT_CATEGORY_OTHER) + +#define STATIC_KSCATEGORY_COMMUNICATIONSTRANSFORM \ + 0xCF1DDA2CL, 0x9743, 0x11D0, 0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("CF1DDA2C-9743-11D0-A3EE-00A0C9223196", KSCATEGORY_COMMUNICATIONSTRANSFORM); +#define KSCATEGORY_COMMUNICATIONSTRANSFORM DEFINE_GUIDNAMED(KSCATEGORY_COMMUNICATIONSTRANSFORM) + +#define STATIC_KSCATEGORY_INTERFACETRANSFORM \ + 0xCF1DDA2DL, 0x9743, 0x11D0, 0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("CF1DDA2D-9743-11D0-A3EE-00A0C9223196", KSCATEGORY_INTERFACETRANSFORM); +#define KSCATEGORY_INTERFACETRANSFORM DEFINE_GUIDNAMED(KSCATEGORY_INTERFACETRANSFORM) + +#define STATIC_KSCATEGORY_MEDIUMTRANSFORM \ + 0xCF1DDA2EL, 0x9743, 0x11D0, 0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("CF1DDA2E-9743-11D0-A3EE-00A0C9223196", KSCATEGORY_MEDIUMTRANSFORM); +#define KSCATEGORY_MEDIUMTRANSFORM DEFINE_GUIDNAMED(KSCATEGORY_MEDIUMTRANSFORM) + +#define STATIC_KSCATEGORY_FILESYSTEM \ + 0x760FED5EL, 0x9357, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("760FED5E-9357-11D0-A3CC-00A0C9223196", KSCATEGORY_FILESYSTEM); +#define KSCATEGORY_FILESYSTEM DEFINE_GUIDNAMED(KSCATEGORY_FILESYSTEM) + +// KSNAME_Clock +#define STATIC_KSCATEGORY_CLOCK \ + 0x53172480L, 0x4791, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("53172480-4791-11D0-A5D6-28DB04C10000", KSCATEGORY_CLOCK); +#define KSCATEGORY_CLOCK DEFINE_GUIDNAMED(KSCATEGORY_CLOCK) + +#define STATIC_KSCATEGORY_PROXY \ + 0x97EBAACAL, 0x95BD, 0x11D0, 0xA3, 0xEA, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("97EBAACA-95BD-11D0-A3EA-00A0C9223196", KSCATEGORY_PROXY); +#define KSCATEGORY_PROXY DEFINE_GUIDNAMED(KSCATEGORY_PROXY) + +#define STATIC_KSCATEGORY_QUALITY \ + 0x97EBAACBL, 0x95BD, 0x11D0, 0xA3, 0xEA, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("97EBAACB-95BD-11D0-A3EA-00A0C9223196", KSCATEGORY_QUALITY); +#define KSCATEGORY_QUALITY DEFINE_GUIDNAMED(KSCATEGORY_QUALITY) + +typedef struct { + ULONG FromNode; + ULONG FromNodePin; + ULONG ToNode; + ULONG ToNodePin; +} KSTOPOLOGY_CONNECTION, *PKSTOPOLOGY_CONNECTION; + +typedef struct { + ULONG CategoriesCount; + _Field_size_(CategoriesCount) + const GUID* Categories; + ULONG TopologyNodesCount; + _Field_size_(TopologyNodesCount) + const GUID* TopologyNodes; + ULONG TopologyConnectionsCount; + _Field_size_(TopologyConnectionsCount) + const KSTOPOLOGY_CONNECTION* TopologyConnections; + _Field_size_(TopologyNodesCount) + const GUID* TopologyNodesNames; + ULONG Reserved; +} KSTOPOLOGY, *PKSTOPOLOGY; + +#define KSFILTER_NODE ((ULONG)-1) +#define KSALL_NODES ((ULONG)-1) + +typedef struct { + ULONG CreateFlags; + ULONG Node; +} KSNODE_CREATE, *PKSNODE_CREATE; + +//=========================================================================== + +// TIME_FORMAT_NONE +#define STATIC_KSTIME_FORMAT_NONE STATIC_GUID_NULL +#define KSTIME_FORMAT_NONE GUID_NULL + +// TIME_FORMAT_FRAME +#define STATIC_KSTIME_FORMAT_FRAME\ + 0x7b785570L, 0x8c82, 0x11cf, 0xbc, 0x0c, 0x00, 0xaa, 0x00, 0xac, 0x74, 0xf6 +DEFINE_GUIDSTRUCT("7b785570-8c82-11cf-bc0c-00aa00ac74f6", KSTIME_FORMAT_FRAME); +#define KSTIME_FORMAT_FRAME DEFINE_GUIDNAMED(KSTIME_FORMAT_FRAME) + +// TIME_FORMAT_BYTE +#define STATIC_KSTIME_FORMAT_BYTE\ + 0x7b785571L, 0x8c82, 0x11cf, 0xbc, 0x0c, 0x00, 0xaa, 0x00, 0xac, 0x74, 0xf6 +DEFINE_GUIDSTRUCT("7b785571-8c82-11cf-bc0c-00aa00ac74f6", KSTIME_FORMAT_BYTE); +#define KSTIME_FORMAT_BYTE DEFINE_GUIDNAMED(KSTIME_FORMAT_BYTE) + +// TIME_FORMAT_SAMPLE +#define STATIC_KSTIME_FORMAT_SAMPLE\ + 0x7b785572L, 0x8c82, 0x11cf, 0xbc, 0x0c, 0x00, 0xaa, 0x00, 0xac, 0x74, 0xf6 +DEFINE_GUIDSTRUCT("7b785572-8c82-11cf-bc0c-00aa00ac74f6", KSTIME_FORMAT_SAMPLE); +#define KSTIME_FORMAT_SAMPLE DEFINE_GUIDNAMED(KSTIME_FORMAT_SAMPLE) + +// TIME_FORMAT_FIELD +#define STATIC_KSTIME_FORMAT_FIELD\ + 0x7b785573L, 0x8c82, 0x11cf, 0xbc, 0x0c, 0x00, 0xaa, 0x00, 0xac, 0x74, 0xf6 +DEFINE_GUIDSTRUCT("7b785573-8c82-11cf-bc0c-00aa00ac74f6", KSTIME_FORMAT_FIELD); +#define KSTIME_FORMAT_FIELD DEFINE_GUIDNAMED(KSTIME_FORMAT_FIELD) + +// TIME_FORMAT_MEDIA_TIME +#define STATIC_KSTIME_FORMAT_MEDIA_TIME\ + 0x7b785574L, 0x8c82, 0x11cf, 0xbc, 0x0c, 0x00, 0xaa, 0x00, 0xac, 0x74, 0xf6 +DEFINE_GUIDSTRUCT("7b785574-8c82-11cf-bc0c-00aa00ac74f6", KSTIME_FORMAT_MEDIA_TIME); +#define KSTIME_FORMAT_MEDIA_TIME DEFINE_GUIDNAMED(KSTIME_FORMAT_MEDIA_TIME) + +//=========================================================================== + +typedef KSIDENTIFIER KSPIN_INTERFACE, *PKSPIN_INTERFACE; + +#define STATIC_KSINTERFACESETID_Standard \ + 0x1A8766A0L, 0x62CE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("1A8766A0-62CE-11CF-A5D6-28DB04C10000", KSINTERFACESETID_Standard); +#define KSINTERFACESETID_Standard DEFINE_GUIDNAMED(KSINTERFACESETID_Standard) + +typedef enum { + KSINTERFACE_STANDARD_STREAMING, + KSINTERFACE_STANDARD_LOOPED_STREAMING, + KSINTERFACE_STANDARD_CONTROL //Reserved for system use +} KSINTERFACE_STANDARD; + +#define STATIC_KSINTERFACESETID_FileIo \ + 0x8C6F932CL, 0xE771, 0x11D0, 0xB8, 0xFF, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("8C6F932C-E771-11D0-B8FF-00A0C9223196", KSINTERFACESETID_FileIo); +#define KSINTERFACESETID_FileIo DEFINE_GUIDNAMED(KSINTERFACESETID_FileIo) + +typedef enum { + KSINTERFACE_FILEIO_STREAMING +} KSINTERFACE_FILEIO; + +//=========================================================================== + +#define KSMEDIUM_TYPE_ANYINSTANCE 0 + +#define STATIC_KSMEDIUMSETID_Standard \ + 0x4747B320L, 0x62CE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("4747B320-62CE-11CF-A5D6-28DB04C10000", KSMEDIUMSETID_Standard); +#define KSMEDIUMSETID_Standard DEFINE_GUIDNAMED(KSMEDIUMSETID_Standard) + +//For compatibility only +#define KSMEDIUM_STANDARD_DEVIO KSMEDIUM_TYPE_ANYINSTANCE + +//=========================================================================== + +#define STATIC_KSPROPSETID_Pin\ + 0x8C134960L, 0x51AD, 0x11CF, 0x87, 0x8A, 0x94, 0xF8, 0x01, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("8C134960-51AD-11CF-878A-94F801C10000", KSPROPSETID_Pin); +#define KSPROPSETID_Pin DEFINE_GUIDNAMED(KSPROPSETID_Pin) + + + +typedef enum { + KSPROPERTY_PIN_CINSTANCES, + KSPROPERTY_PIN_CTYPES, + KSPROPERTY_PIN_DATAFLOW, + KSPROPERTY_PIN_DATARANGES, + KSPROPERTY_PIN_DATAINTERSECTION, + KSPROPERTY_PIN_INTERFACES, + KSPROPERTY_PIN_MEDIUMS, + KSPROPERTY_PIN_COMMUNICATION, + KSPROPERTY_PIN_GLOBALCINSTANCES, + KSPROPERTY_PIN_NECESSARYINSTANCES, + KSPROPERTY_PIN_PHYSICALCONNECTION, + KSPROPERTY_PIN_CATEGORY, + KSPROPERTY_PIN_NAME, + KSPROPERTY_PIN_CONSTRAINEDDATARANGES, + KSPROPERTY_PIN_PROPOSEDATAFORMAT, + KSPROPERTY_PIN_PROPOSEDATAFORMAT2, + KSPROPERTY_PIN_MODEDATAFORMATS, +} KSPROPERTY_PIN; + +#define KSPROPERTY_PIN_FLAGS_ATTRIBUTE_RANGE_AWARE 0x00000001 +#define KSPROPERTY_PIN_FLAGS_MASK KSPROPERTY_PIN_FLAGS_ATTRIBUTE_RANGE_AWARE + +typedef struct { + KSPROPERTY Property; + ULONG PinId; + union { + ULONG Reserved; + ULONG Flags; + }; +} KSP_PIN, *PKSP_PIN; + +typedef struct { + KSEVENT Event; + ULONG PinId; + ULONG Reserved; +} KSE_PIN, *PKSE_PIN; + +#define KSINSTANCE_INDETERMINATE ((ULONG)-1) + +typedef struct { + ULONG PossibleCount; + ULONG CurrentCount; +} KSPIN_CINSTANCES, *PKSPIN_CINSTANCES; + +typedef enum { + KSPIN_DATAFLOW_IN = 1, + KSPIN_DATAFLOW_OUT +} KSPIN_DATAFLOW, *PKSPIN_DATAFLOW; + +#define KSDATAFORMAT_BIT_TEMPORAL_COMPRESSION 0 +#define KSDATAFORMAT_TEMPORAL_COMPRESSION (1 << KSDATAFORMAT_BIT_TEMPORAL_COMPRESSION) +#define KSDATAFORMAT_BIT_ATTRIBUTES 1 +#define KSDATAFORMAT_ATTRIBUTES (1 << KSDATAFORMAT_BIT_ATTRIBUTES) + +#define KSDATARANGE_BIT_ATTRIBUTES 1 +#define KSDATARANGE_ATTRIBUTES (1 << KSDATARANGE_BIT_ATTRIBUTES) +#define KSDATARANGE_BIT_REQUIRED_ATTRIBUTES 2 +#define KSDATARANGE_REQUIRED_ATTRIBUTES (1 << KSDATARANGE_BIT_REQUIRED_ATTRIBUTES) + +#if !defined( _MSC_VER ) +typedef struct { + ULONG FormatSize; + ULONG Flags; + ULONG SampleSize; + ULONG Reserved; + GUID MajorFormat; + GUID SubFormat; + GUID Specifier; +} KSDATAFORMAT, *PKSDATAFORMAT, KSDATARANGE, *PKSDATARANGE; +#else +typedef union { + struct { + ULONG FormatSize; + ULONG Flags; + ULONG SampleSize; + ULONG Reserved; + GUID MajorFormat; + GUID SubFormat; + GUID Specifier; + }; + LONGLONG Alignment; +} KSDATAFORMAT, *PKSDATAFORMAT, KSDATARANGE, *PKSDATARANGE; +#endif + +#define KSATTRIBUTE_REQUIRED 0x00000001 + +typedef struct { + ULONG Size; + ULONG Flags; + GUID Attribute; +} KSATTRIBUTE, *PKSATTRIBUTE; + +#if defined(_NTDDK_) +typedef struct { + ULONG Count; + _Field_size_(Count) PKSATTRIBUTE* Attributes; +} KSATTRIBUTE_LIST, *PKSATTRIBUTE_LIST; +#endif // _NTDDK_ + +typedef enum { + KSPIN_COMMUNICATION_NONE, + KSPIN_COMMUNICATION_SINK, + KSPIN_COMMUNICATION_SOURCE, + KSPIN_COMMUNICATION_BOTH, + KSPIN_COMMUNICATION_BRIDGE +} KSPIN_COMMUNICATION, *PKSPIN_COMMUNICATION; + +typedef KSIDENTIFIER KSPIN_MEDIUM, *PKSPIN_MEDIUM; + +typedef struct { + KSPIN_INTERFACE Interface; + KSPIN_MEDIUM Medium; + ULONG PinId; + HANDLE PinToHandle; + KSPRIORITY Priority; +} KSPIN_CONNECT, *PKSPIN_CONNECT; + +typedef struct { + ULONG Size; + ULONG Pin; + WCHAR SymbolicLinkName[1]; +} KSPIN_PHYSICALCONNECTION, *PKSPIN_PHYSICALCONNECTION; + +#if defined(_NTDDK_) +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSINTERSECTHANDLER)( + _In_ PIRP Irp, + _In_ PKSP_PIN Pin, + _In_ PKSDATARANGE DataRange, + _Out_opt_ PVOID Data + ); +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSINTERSECTHANDLEREX)( + _In_ PVOID Context, + _In_ PIRP Irp, + _In_ PKSP_PIN Pin, + _In_ PKSDATARANGE DataRange, + _In_ PKSDATARANGE MatchingDataRange, + _In_ ULONG DataBufferSize, + _Out_writes_bytes_to_opt_(DataBufferSize, *DataSize) PVOID Data, + _Out_ PULONG DataSize + ); +#endif // _NTDDK_ + +#define DEFINE_KSPIN_INTERFACE_TABLE(tablename)\ + const KSPIN_INTERFACE tablename[] = + +#define DEFINE_KSPIN_INTERFACE_ITEM(guid, interface)\ + {\ + STATICGUIDOF(guid),\ + (interface),\ + 0\ + } + +#define DEFINE_KSPIN_MEDIUM_TABLE( tablename )\ + const KSPIN_MEDIUM tablename[] = + +#define DEFINE_KSPIN_MEDIUM_ITEM(guid, medium)\ + DEFINE_KSPIN_INTERFACE_ITEM(guid, medium) + +#define DEFINE_KSPROPERTY_ITEM_PIN_CINSTANCES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_CINSTANCES,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(KSPIN_CINSTANCES),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_CTYPES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_CTYPES,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_DATAFLOW(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_DATAFLOW,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(KSPIN_DATAFLOW),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_DATARANGES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_DATARANGES,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_DATAINTERSECTION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_DATAINTERSECTION,\ + (Handler),\ + sizeof(KSP_PIN) + sizeof(KSMULTIPLE_ITEM),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_INTERFACES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_INTERFACES,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_MEDIUMS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_MEDIUMS,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_COMMUNICATION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_COMMUNICATION,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(KSPIN_COMMUNICATION),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_GLOBALCINSTANCES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_GLOBALCINSTANCES,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(KSPIN_CINSTANCES),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_NECESSARYINSTANCES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_NECESSARYINSTANCES,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(ULONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_PHYSICALCONNECTION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_PHYSICALCONNECTION,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_CATEGORY(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_CATEGORY,\ + (Handler),\ + sizeof(KSP_PIN),\ + sizeof(GUID),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_NAME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_NAME,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_CONSTRAINEDDATARANGES(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_CONSTRAINEDDATARANGES,\ + (Handler),\ + sizeof(KSP_PIN),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_PIN_PROPOSEDATAFORMAT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PIN_PROPOSEDATAFORMAT,\ + NULL,\ + sizeof(KSP_PIN),\ + sizeof(KSDATAFORMAT),\ + (Handler), NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_PINSET(PinSet,\ + PropGeneral, PropInstances, PropIntersection)\ +DEFINE_KSPROPERTY_TABLE(PinSet) {\ + DEFINE_KSPROPERTY_ITEM_PIN_CINSTANCES(PropInstances),\ + DEFINE_KSPROPERTY_ITEM_PIN_CTYPES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATAFLOW(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATARANGES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATAINTERSECTION(PropIntersection),\ + DEFINE_KSPROPERTY_ITEM_PIN_INTERFACES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_MEDIUMS(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_COMMUNICATION(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_CATEGORY(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_NAME(PropGeneral)\ +} + +#define DEFINE_KSPROPERTY_PINSETCONSTRAINED(PinSet,\ + PropGeneral, PropInstances, PropIntersection)\ +DEFINE_KSPROPERTY_TABLE(PinSet) {\ + DEFINE_KSPROPERTY_ITEM_PIN_CINSTANCES(PropInstances),\ + DEFINE_KSPROPERTY_ITEM_PIN_CTYPES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATAFLOW(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATARANGES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_DATAINTERSECTION(PropIntersection),\ + DEFINE_KSPROPERTY_ITEM_PIN_INTERFACES(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_MEDIUMS(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_COMMUNICATION(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_CATEGORY(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_NAME(PropGeneral),\ + DEFINE_KSPROPERTY_ITEM_PIN_CONSTRAINEDDATARANGES(PropGeneral)\ +} + +#define STATIC_KSEVENTSETID_PinCapsChange \ + 0xDD4F192E, 0x3B78, 0x49AD, 0xA5, 0x34, 0x2C, 0x31, 0x5b, 0x82, 0x20, 0x00 +DEFINE_GUIDSTRUCT("DD4F192E-3B78-49AD-A534-2C315B822000", KSEVENTSETID_PinCapsChange); +#define KSEVENTSETID_PinCapsChange DEFINE_GUIDNAMED(KSEVENTSETID_PinCapsChange) + +typedef enum { + KSEVENT_PINCAPS_FORMATCHANGE, + KSEVENT_PINCAPS_JACKINFOCHANGE +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) + , KSEVENT_PINCAPS_INVALIDATECLIENTS +#endif +} KSEVENT_PINCAPS_CHANGENOTIFICATIONS; + +#define STATIC_KSEVENTSETID_VolumeLimit \ + 0xda168465, 0x3a7c, 0x4858, 0x9d, 0x4a, 0x3e, 0x8e, 0x24, 0x70, 0x1a, 0xef +DEFINE_GUIDSTRUCT("DA168465-3A7C-4858-9D4A-3E8E24701AEF", KSEVENTSETID_VolumeLimit); +#define KSEVENTSETID_VolumeLimit DEFINE_GUIDNAMED(KSEVENTSETID_VolumeLimit) + +typedef enum { + KSEVENT_VOLUMELIMIT_CHANGED +} KSEVENT_VOLUMELIMIT; + + +#define STATIC_KSNAME_Filter\ + 0x9b365890L, 0x165f, 0x11d0, 0xa1, 0x95, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("9b365890-165f-11d0-a195-0020afd156e4", KSNAME_Filter); +#define KSNAME_Filter DEFINE_GUIDNAMED(KSNAME_Filter) + +#define KSSTRING_Filter L"{9B365890-165F-11D0-A195-0020AFD156E4}" + +#define STATIC_KSNAME_Pin\ + 0x146F1A80L, 0x4791, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("146F1A80-4791-11D0-A5D6-28DB04C10000", KSNAME_Pin); +#define KSNAME_Pin DEFINE_GUIDNAMED(KSNAME_Pin) + +#define KSSTRING_Pin L"{146F1A80-4791-11D0-A5D6-28DB04C10000}" + +#define STATIC_KSNAME_Clock\ + 0x53172480L, 0x4791, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("53172480-4791-11D0-A5D6-28DB04C10000", KSNAME_Clock); +#define KSNAME_Clock DEFINE_GUIDNAMED(KSNAME_Clock) + +#define KSSTRING_Clock L"{53172480-4791-11D0-A5D6-28DB04C10000}" + +#define STATIC_KSNAME_Allocator\ + 0x642F5D00L, 0x4791, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("642F5D00-4791-11D0-A5D6-28DB04C10000", KSNAME_Allocator); +#define KSNAME_Allocator DEFINE_GUIDNAMED(KSNAME_Allocator) + +#define KSSTRING_Allocator L"{642F5D00-4791-11D0-A5D6-28DB04C10000}" + +#define KSSTRING_AllocatorEx L"{091BB63B-603F-11D1-B067-00A0C9062802}" + +#define STATIC_KSNAME_TopologyNode\ + 0x0621061AL, 0xEE75, 0x11D0, 0xB9, 0x15, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("0621061A-EE75-11D0-B915-00A0C9223196", KSNAME_TopologyNode); +#define KSNAME_TopologyNode DEFINE_GUIDNAMED(KSNAME_TopologyNode) + +#define KSSTRING_TopologyNode L"{0621061A-EE75-11D0-B915-00A0C9223196}" + +#if defined(_NTDDK_) + +typedef struct { + ULONG InterfacesCount; + _Field_size_(InterfacesCount) + const KSPIN_INTERFACE* Interfaces; + ULONG MediumsCount; + _Field_size_(MediumsCount) + const KSPIN_MEDIUM* Mediums; + ULONG DataRangesCount; + _Field_size_(DataRangesCount) + const PKSDATARANGE* DataRanges; + KSPIN_DATAFLOW DataFlow; + KSPIN_COMMUNICATION Communication; + const GUID* Category; + const GUID* Name; + union { + LONGLONG Reserved; + struct { + ULONG ConstrainedDataRangesCount; + _Field_size_(ConstrainedDataRangesCount) + PKSDATARANGE* ConstrainedDataRanges; + }; + }; +} KSPIN_DESCRIPTOR, *PKSPIN_DESCRIPTOR; +typedef const KSPIN_DESCRIPTOR *PCKSPIN_DESCRIPTOR; + +#define DEFINE_KSPIN_DESCRIPTOR_TABLE(tablename)\ + const KSPIN_DESCRIPTOR tablename[] = + +#define DEFINE_KSPIN_DESCRIPTOR_ITEM(\ + InterfacesCount, Interfaces,\ + MediumsCount, Mediums,\ + DataRangesCount, DataRanges,\ + DataFlow, Communication)\ +{\ + InterfacesCount, Interfaces, MediumsCount, Mediums,\ + DataRangesCount, DataRanges, DataFlow, Communication,\ + NULL, NULL, 0\ +} +#define DEFINE_KSPIN_DESCRIPTOR_ITEMEX(\ + InterfacesCount, Interfaces,\ + MediumsCount, Mediums,\ + DataRangesCount, DataRanges,\ + DataFlow, Communication,\ + Category, Name)\ +{\ + InterfacesCount, Interfaces, MediumsCount, Mediums,\ + DataRangesCount, DataRanges, DataFlow, Communication,\ + Category, Name, 0\ +} + +#endif // defined(_NTDDK_) + +//=========================================================================== + +// MEDIATYPE_NULL +#define STATIC_KSDATAFORMAT_TYPE_WILDCARD STATIC_GUID_NULL +#define KSDATAFORMAT_TYPE_WILDCARD GUID_NULL + +// MEDIASUBTYPE_NULL +#define STATIC_KSDATAFORMAT_SUBTYPE_WILDCARD STATIC_GUID_NULL +#define KSDATAFORMAT_SUBTYPE_WILDCARD GUID_NULL + +// MEDIATYPE_Stream +#define STATIC_KSDATAFORMAT_TYPE_STREAM\ + 0xE436EB83L, 0x524F, 0x11CE, 0x9F, 0x53, 0x00, 0x20, 0xAF, 0x0B, 0xA7, 0x70 +DEFINE_GUIDSTRUCT("E436EB83-524F-11CE-9F53-0020AF0BA770", KSDATAFORMAT_TYPE_STREAM); +#define KSDATAFORMAT_TYPE_STREAM DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_STREAM) + +// MEDIASUBTYPE_None +#define STATIC_KSDATAFORMAT_SUBTYPE_NONE\ + 0xE436EB8EL, 0x524F, 0x11CE, 0x9F, 0x53, 0x00, 0x20, 0xAF, 0x0B, 0xA7, 0x70 +DEFINE_GUIDSTRUCT("E436EB8E-524F-11CE-9F53-0020AF0BA770", KSDATAFORMAT_SUBTYPE_NONE); +#define KSDATAFORMAT_SUBTYPE_NONE DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_NONE) + +#define STATIC_KSDATAFORMAT_SPECIFIER_WILDCARD STATIC_GUID_NULL +#define KSDATAFORMAT_SPECIFIER_WILDCARD GUID_NULL + +#define STATIC_KSDATAFORMAT_SPECIFIER_FILENAME\ + 0xAA797B40L, 0xE974, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("AA797B40-E974-11CF-A5D6-28DB04C10000", KSDATAFORMAT_SPECIFIER_FILENAME); +#define KSDATAFORMAT_SPECIFIER_FILENAME DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_FILENAME) + +#define STATIC_KSDATAFORMAT_SPECIFIER_FILEHANDLE\ + 0x65E8773CL, 0x8F56, 0x11D0, 0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("65E8773C-8F56-11D0-A3B9-00A0C9223196", KSDATAFORMAT_SPECIFIER_FILEHANDLE); +#define KSDATAFORMAT_SPECIFIER_FILEHANDLE DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_FILEHANDLE) + +// FORMAT_None +#define STATIC_KSDATAFORMAT_SPECIFIER_NONE\ + 0x0F6417D6L, 0xC318, 0x11D0, 0xA4, 0x3F, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("0F6417D6-C318-11D0-A43F-00A0C9223196", KSDATAFORMAT_SPECIFIER_NONE); +#define KSDATAFORMAT_SPECIFIER_NONE DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_NONE) + +//=========================================================================== + +#define STATIC_KSPROPSETID_Quality \ + 0xD16AD380L, 0xAC1A, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("D16AD380-AC1A-11CF-A5D6-28DB04C10000", KSPROPSETID_Quality); +#define KSPROPSETID_Quality DEFINE_GUIDNAMED(KSPROPSETID_Quality) + +typedef enum { + KSPROPERTY_QUALITY_REPORT, + KSPROPERTY_QUALITY_ERROR +} KSPROPERTY_QUALITY; + +#define DEFINE_KSPROPERTY_ITEM_QUALITY_REPORT(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_QUALITY_REPORT,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSQUALITY),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_QUALITY_ERROR(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_QUALITY_ERROR,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSERROR),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//=========================================================================== + +#define STATIC_KSPROPSETID_Connection \ + 0x1D58C920L, 0xAC9B, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("1D58C920-AC9B-11CF-A5D6-28DB04C10000", KSPROPSETID_Connection); +#define KSPROPSETID_Connection DEFINE_GUIDNAMED(KSPROPSETID_Connection) + +typedef enum { + KSPROPERTY_CONNECTION_STATE, + KSPROPERTY_CONNECTION_PRIORITY, + KSPROPERTY_CONNECTION_DATAFORMAT, + KSPROPERTY_CONNECTION_ALLOCATORFRAMING, + KSPROPERTY_CONNECTION_PROPOSEDATAFORMAT, + KSPROPERTY_CONNECTION_ACQUIREORDERING, + KSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX, + KSPROPERTY_CONNECTION_STARTAT +} KSPROPERTY_CONNECTION; + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_STATE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_STATE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSSTATE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_PRIORITY(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_PRIORITY,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSPRIORITY),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_DATAFORMAT(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_DATAFORMAT,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_ALLOCATORFRAMING(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_ALLOCATORFRAMING,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSALLOCATOR_FRAMING),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_ALLOCATORFRAMING_EX(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_ALLOCATORFRAMING_EX,\ + (Handler),\ + sizeof(KSPROPERTY),\ + 0,\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_PROPOSEDATAFORMAT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_PROPOSEDATAFORMAT,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(KSDATAFORMAT),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_ACQUIREORDERING(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_ACQUIREORDERING,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(int),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_STARTAT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CONNECTION_STARTAT,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(KSRELATIVEEVENT),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +//=========================================================================== +//VRAM transport related propset +//=========================================================================== + +#define STATIC_KSPROPSETID_MemoryTransport \ + 0xa3d1c5d, 0x5243, 0x4819, 0x9e, 0xd0, 0xae, 0xe8, 0x4, 0x4c, 0xee, 0x2b +DEFINE_GUIDSTRUCT("0A3D1C5D-5243-4819-9ED0-AEE8044CEE2B", KSPROPSETID_MemoryTransport); +#define KSPROPSETID_MemoryTransport DEFINE_GUIDNAMED(KSPROPSETID_MemoryTransport) +enum { + // a value of zero is ignored + KSPROPERTY_MEMORY_TRANSPORT = 1 //Sets pin's memory transport mechanism e.g. VRAM or SYSMEM +}; + +#define DEFINE_KSPROPERTY_ITEM_MEMORY_TRANSPORT(SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MEMORY_TRANSPORT,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(BOOL),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +//=========================================================================== +// +// pins flags +// +#define KSALLOCATOR_REQUIREMENTF_INPLACE_MODIFIER 0x00000001 +#define KSALLOCATOR_REQUIREMENTF_SYSTEM_MEMORY 0x00000002 +#define KSALLOCATOR_REQUIREMENTF_FRAME_INTEGRITY 0x00000004 +#define KSALLOCATOR_REQUIREMENTF_MUST_ALLOCATE 0x00000008 +#define KSALLOCATOR_REQUIREMENTF_SYSTEM_MEMORY_CUSTOM_ALLOCATION 0x00000010 +#define KSALLOCATOR_REQUIREMENTF_PREFERENCES_ONLY 0x80000000 + +#define KSALLOCATOR_OPTIONF_COMPATIBLE 0x00000001 +#define KSALLOCATOR_OPTIONF_SYSTEM_MEMORY 0x00000002 +#define KSALLOCATOR_OPTIONF_VALID 0x00000003 +// +// pins extended framing flags +// +#define KSALLOCATOR_FLAG_PARTIAL_READ_SUPPORT 0x00000010 +#define KSALLOCATOR_FLAG_DEVICE_SPECIFIC 0x00000020 +#define KSALLOCATOR_FLAG_CAN_ALLOCATE 0x00000040 +#define KSALLOCATOR_FLAG_INSIST_ON_FRAMESIZE_RATIO 0x00000080 + +// +// allocator pipes flags +// +// there is at least one data modification in a pipe +#define KSALLOCATOR_FLAG_NO_FRAME_INTEGRITY 0x00000100 +#define KSALLOCATOR_FLAG_MULTIPLE_OUTPUT 0x00000200 +#define KSALLOCATOR_FLAG_CYCLE 0x00000400 +#define KSALLOCATOR_FLAG_ALLOCATOR_EXISTS 0x00000800 +// there is no framing dependency between neighbouring pipes. +#define KSALLOCATOR_FLAG_INDEPENDENT_RANGES 0x00001000 +#define KSALLOCATOR_FLAG_ATTENTION_STEPPING 0x00002000 + + +#define KSALLOCATOR_FLAG_ENABLE_CACHED_MDL 0x00004000 +#define KSALLOCATOR_FLAG_2D_BUFFER_REQUIRED 0x00008000 + +// +// old Framing structure +// +typedef struct { + union { + ULONG OptionsFlags; // allocator options (create) + ULONG RequirementsFlags; // allocation requirements (query) + }; +#if defined(_NTDDK_) + POOL_TYPE PoolType; +#else // !_NTDDK_ + ULONG PoolType; +#endif // !_NTDDK_ + ULONG Frames; // total number of allowable outstanding frames + ULONG FrameSize; // total size of frame + union { + ULONG FileAlignment; + LONG FramePitch; // When KSALLOCATOR_FLAG_2D_BUFFER_REQUIRED is set this field specifies the required 2d pitch for the buffer i.e. the width + stride + }; + + ULONG Reserved; +} KSALLOCATOR_FRAMING, *PKSALLOCATOR_FRAMING; + +#if defined(_NTDDK_) +typedef +PVOID +(*PFNKSDEFAULTALLOCATE)( + _In_ PVOID Context + ); + +typedef +VOID +(*PFNKSDEFAULTFREE)( + _In_ PVOID Context, + _In_ PVOID Buffer + ); + +typedef +NTSTATUS +(*PFNKSINITIALIZEALLOCATOR)( + _In_ PVOID InitialContext, + _In_ PKSALLOCATOR_FRAMING AllocatorFraming, + _Outptr_ PVOID* Context + ); + +typedef +VOID +(*PFNKSDELETEALLOCATOR)( + _In_ PVOID Context + ); +#endif // !_NTDDK_ + +// +// new Framing structure, eventually will replace KSALLOCATOR_FRAMING. +// +typedef struct { + ULONG MinFrameSize; + ULONG MaxFrameSize; + ULONG Stepping; +} KS_FRAMING_RANGE, *PKS_FRAMING_RANGE; + + +typedef struct { + KS_FRAMING_RANGE Range; + ULONG InPlaceWeight; + ULONG NotInPlaceWeight; +} KS_FRAMING_RANGE_WEIGHTED, *PKS_FRAMING_RANGE_WEIGHTED; + + +typedef struct { + ULONG RatioNumerator; // compression/expansion ratio + ULONG RatioDenominator; + ULONG RatioConstantMargin; +} KS_COMPRESSION, *PKS_COMPRESSION; + + +// +// Memory Types and Buses are repeated in each entry. +// Easiest to use but takes a little more memory than the varsize layout Pin\Memories\Buses\Ranges. +// +typedef struct { + GUID MemoryType; + GUID BusType; + ULONG MemoryFlags; + ULONG BusFlags; + ULONG Flags; + ULONG Frames; // total number of allowable outstanding frames + union { + ULONG FileAlignment; + LONG FramePitch; // When KSALLOCATOR_FLAG_2D_BUFFER_REQUIRED is set this field specifies the required 2d pitch for the buffer i.e. the width + stride + }; + ULONG MemoryTypeWeight; // this memory type Weight pin-wide + KS_FRAMING_RANGE PhysicalRange; + KS_FRAMING_RANGE_WEIGHTED FramingRange; +} KS_FRAMING_ITEM, *PKS_FRAMING_ITEM; + + +typedef struct { + ULONG CountItems; // count of FramingItem-s below. + ULONG PinFlags; + KS_COMPRESSION OutputCompression; + ULONG PinWeight; // this pin framing's Weight graph-wide + KS_FRAMING_ITEM FramingItem[1]; +} KSALLOCATOR_FRAMING_EX, *PKSALLOCATOR_FRAMING_EX; + + + +// +// define memory type GUIDs +// +#define KSMEMORY_TYPE_WILDCARD GUID_NULL +#define STATIC_KSMEMORY_TYPE_WILDCARD STATIC_GUID_NULL + +#define KSMEMORY_TYPE_DONT_CARE GUID_NULL +#define STATIC_KSMEMORY_TYPE_DONT_CARE STATIC_GUID_NULL + +#define KS_TYPE_DONT_CARE GUID_NULL +#define STATIC_KS_TYPE_DONT_CARE STATIC_GUID_NULL + +#define STATIC_KSMEMORY_TYPE_SYSTEM \ + 0x091bb638L, 0x603f, 0x11d1, 0xb0, 0x67, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 +DEFINE_GUIDSTRUCT("091bb638-603f-11d1-b067-00a0c9062802", KSMEMORY_TYPE_SYSTEM); +#define KSMEMORY_TYPE_SYSTEM DEFINE_GUIDNAMED(KSMEMORY_TYPE_SYSTEM) + +#define STATIC_KSMEMORY_TYPE_USER \ + 0x8cb0fc28L, 0x7893, 0x11d1, 0xb0, 0x69, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 +DEFINE_GUIDSTRUCT("8cb0fc28-7893-11d1-b069-00a0c9062802", KSMEMORY_TYPE_USER); +#define KSMEMORY_TYPE_USER DEFINE_GUIDNAMED(KSMEMORY_TYPE_USER) + +#define STATIC_KSMEMORY_TYPE_KERNEL_PAGED \ + 0xd833f8f8L, 0x7894, 0x11d1, 0xb0, 0x69, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 +DEFINE_GUIDSTRUCT("d833f8f8-7894-11d1-b069-00a0c9062802", KSMEMORY_TYPE_KERNEL_PAGED); +#define KSMEMORY_TYPE_KERNEL_PAGED DEFINE_GUIDNAMED(KSMEMORY_TYPE_KERNEL_PAGED) + +#define STATIC_KSMEMORY_TYPE_KERNEL_NONPAGED \ + 0x4a6d5fc4L, 0x7895, 0x11d1, 0xb0, 0x69, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 +DEFINE_GUIDSTRUCT("4a6d5fc4-7895-11d1-b069-00a0c9062802", KSMEMORY_TYPE_KERNEL_NONPAGED); +#define KSMEMORY_TYPE_KERNEL_NONPAGED DEFINE_GUIDNAMED(KSMEMORY_TYPE_KERNEL_NONPAGED) + +// old KS clients did not specify the device memory type +#define STATIC_KSMEMORY_TYPE_DEVICE_UNKNOWN \ + 0x091bb639L, 0x603f, 0x11d1, 0xb0, 0x67, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 +DEFINE_GUIDSTRUCT("091bb639-603f-11d1-b067-00a0c9062802", KSMEMORY_TYPE_DEVICE_UNKNOWN); +#define KSMEMORY_TYPE_DEVICE_UNKNOWN DEFINE_GUIDNAMED(KSMEMORY_TYPE_DEVICE_UNKNOWN) + +// +// Helper framing macros. +// +#define DECLARE_SIMPLE_FRAMING_EX(FramingExName, MemoryType, Flags, Frames, Alignment, MinFrameSize, MaxFrameSize) \ + const KSALLOCATOR_FRAMING_EX FramingExName = \ + {\ + 1, \ + 0, \ + {\ + 1, \ + 1, \ + 0 \ + }, \ + 0, \ + {\ + {\ + MemoryType, \ + STATIC_KS_TYPE_DONT_CARE, \ + 0, \ + 0, \ + Flags, \ + Frames, \ + Alignment, \ + 0, \ + {\ + 0, \ + (ULONG)-1, \ + 1 \ + }, \ + {\ + {\ + MinFrameSize, \ + MaxFrameSize, \ + 1 \ + }, \ + 0, \ + 0 \ + }\ + }\ + }\ + } + +#define SetDefaultKsCompression(KsCompressionPointer) \ +{\ + KsCompressionPointer->RatioNumerator = 1;\ + KsCompressionPointer->RatioDenominator = 1;\ + KsCompressionPointer->RatioConstantMargin = 0;\ +} + +#define SetDontCareKsFramingRange(KsFramingRangePointer) \ +{\ + KsFramingRangePointer->MinFrameSize = 0;\ + KsFramingRangePointer->MaxFrameSize = (ULONG) -1;\ + KsFramingRangePointer->Stepping = 1;\ +} + +#define SetKsFramingRange(KsFramingRangePointer, P_MinFrameSize, P_MaxFrameSize) \ +{\ + KsFramingRangePointer->MinFrameSize = P_MinFrameSize;\ + KsFramingRangePointer->MaxFrameSize = P_MaxFrameSize;\ + KsFramingRangePointer->Stepping = 1;\ +} + +#define SetKsFramingRangeWeighted(KsFramingRangeWeightedPointer, P_MinFrameSize, P_MaxFrameSize) \ +{\ + KS_FRAMING_RANGE *KsFramingRange = &KsFramingRangeWeightedPointer->Range;\ + SetKsFramingRange(KsFramingRange, P_MinFrameSize, P_MaxFrameSize);\ + KsFramingRangeWeightedPointer->InPlaceWeight = 0;\ + KsFramingRangeWeightedPointer->NotInPlaceWeight = 0;\ +} + +#define INITIALIZE_SIMPLE_FRAMING_EX(FramingExPointer, P_MemoryType, P_Flags, P_Frames, P_Alignment, P_MinFrameSize, P_MaxFrameSize) \ +{\ + KS_COMPRESSION *KsCompression = &FramingExPointer->OutputCompression;\ + KS_FRAMING_RANGE *KsFramingRange = &FramingExPointer->FramingItem[0].PhysicalRange;\ + KS_FRAMING_RANGE_WEIGHTED *KsFramingRangeWeighted = &FramingExPointer->FramingItem[0].FramingRange;\ + FramingExPointer->CountItems = 1;\ + FramingExPointer->PinFlags = 0;\ + SetDefaultKsCompression(KsCompression);\ + FramingExPointer->PinWeight = 0;\ + FramingExPointer->FramingItem[0].MemoryType = P_MemoryType;\ + FramingExPointer->FramingItem[0].BusType = KS_TYPE_DONT_CARE;\ + FramingExPointer->FramingItem[0].MemoryFlags = 0;\ + FramingExPointer->FramingItem[0].BusFlags = 0;\ + FramingExPointer->FramingItem[0].Flags = P_Flags;\ + FramingExPointer->FramingItem[0].Frames = P_Frames;\ + FramingExPointer->FramingItem[0].FileAlignment = P_Alignment;\ + FramingExPointer->FramingItem[0].MemoryTypeWeight = 0;\ + SetDontCareKsFramingRange(KsFramingRange);\ + SetKsFramingRangeWeighted(KsFramingRangeWeighted, P_MinFrameSize, P_MaxFrameSize);\ +} + + + +// KSEVENTSETID_StreamAllocator: {75D95571-073C-11d0-A161-0020AFD156E4} + +#define STATIC_KSEVENTSETID_StreamAllocator\ + 0x75d95571L, 0x073c, 0x11d0, 0xa1, 0x61, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("75d95571-073c-11d0-a161-0020afd156e4", KSEVENTSETID_StreamAllocator); +#define KSEVENTSETID_StreamAllocator DEFINE_GUIDNAMED(KSEVENTSETID_StreamAllocator) + +typedef enum { + KSEVENT_STREAMALLOCATOR_INTERNAL_FREEFRAME, + KSEVENT_STREAMALLOCATOR_FREEFRAME +} KSEVENT_STREAMALLOCATOR; + +#define STATIC_KSMETHODSETID_StreamAllocator\ + 0xcf6e4341L, 0xec87, 0x11cf, 0xa1, 0x30, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("cf6e4341-ec87-11cf-a130-0020afd156e4", KSMETHODSETID_StreamAllocator); +#define KSMETHODSETID_StreamAllocator DEFINE_GUIDNAMED(KSMETHODSETID_StreamAllocator) + +typedef enum { + KSMETHOD_STREAMALLOCATOR_ALLOC, + KSMETHOD_STREAMALLOCATOR_FREE +} KSMETHOD_STREAMALLOCATOR; + +#define DEFINE_KSMETHOD_ITEM_STREAMALLOCATOR_ALLOC(Handler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_STREAMALLOCATOR_ALLOC,\ + KSMETHOD_TYPE_WRITE,\ + (Handler),\ + sizeof(KSMETHOD),\ + sizeof(PVOID),\ + NULL) + +#define DEFINE_KSMETHOD_ITEM_STREAMALLOCATOR_FREE(Handler)\ + DEFINE_KSMETHOD_ITEM(\ + KSMETHOD_STREAMALLOCATOR_FREE,\ + KSMETHOD_TYPE_READ,\ + (Handler),\ + sizeof(KSMETHOD),\ + sizeof(PVOID),\ + NULL) + +#define DEFINE_KSMETHOD_ALLOCATORSET(AllocatorSet, MethodAlloc, MethodFree)\ +DEFINE_KSMETHOD_TABLE(AllocatorSet) {\ + DEFINE_KSMETHOD_ITEM_STREAMALLOCATOR_ALLOC(MethodAlloc),\ + DEFINE_KSMETHOD_ITEM_STREAMALLOCATOR_FREE(MethodFree)\ +} + +#define STATIC_KSPROPSETID_StreamAllocator\ + 0xcf6e4342L, 0xec87, 0x11cf, 0xa1, 0x30, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("cf6e4342-ec87-11cf-a130-0020afd156e4", KSPROPSETID_StreamAllocator); +#define KSPROPSETID_StreamAllocator DEFINE_GUIDNAMED(KSPROPSETID_StreamAllocator) + +#if defined(_NTDDK_) +typedef enum { + KSPROPERTY_STREAMALLOCATOR_FUNCTIONTABLE, + KSPROPERTY_STREAMALLOCATOR_STATUS +} KSPROPERTY_STREAMALLOCATOR; + +#define DEFINE_KSPROPERTY_ITEM_STREAMALLOCATOR_FUNCTIONTABLE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAMALLOCATOR_FUNCTIONTABLE,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSSTREAMALLOCATOR_FUNCTIONTABLE),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAMALLOCATOR_STATUS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAMALLOCATOR_STATUS,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSSTREAMALLOCATOR_STATUS),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ALLOCATORSET(AllocatorSet, PropFunctionTable, PropStatus)\ +DEFINE_KSPROPERTY_TABLE(AllocatorSet) {\ + DEFINE_KSPROPERTY_ITEM_STREAMALLOCATOR_STATUS(PropStatus),\ + DEFINE_KSPROPERTY_ITEM_STREAMALLOCATOR_FUNCTIONTABLE(PropFunctionTable)\ +} + +typedef +NTSTATUS +(*PFNALLOCATOR_ALLOCATEFRAME)( + _In_ PFILE_OBJECT FileObject, + _Outptr_ PVOID *Frame + ); + +typedef +VOID +(*PFNALLOCATOR_FREEFRAME)( + _In_ PFILE_OBJECT FileObject, + _In_ PVOID Frame + ); + +typedef struct { + PFNALLOCATOR_ALLOCATEFRAME AllocateFrame; + PFNALLOCATOR_FREEFRAME FreeFrame; +} KSSTREAMALLOCATOR_FUNCTIONTABLE, *PKSSTREAMALLOCATOR_FUNCTIONTABLE; +#endif // defined(_NTDDK_) + +typedef struct { + KSALLOCATOR_FRAMING Framing; + ULONG AllocatedFrames; + ULONG Reserved; +} KSSTREAMALLOCATOR_STATUS, *PKSSTREAMALLOCATOR_STATUS; + +typedef struct { + KSALLOCATOR_FRAMING_EX Framing; + ULONG AllocatedFrames; + ULONG Reserved; +} KSSTREAMALLOCATOR_STATUS_EX, *PKSSTREAMALLOCATOR_STATUS_EX; + + +#define KSSTREAM_HEADER_OPTIONSF_SPLICEPOINT 0x00000001 +#define KSSTREAM_HEADER_OPTIONSF_PREROLL 0x00000002 +#define KSSTREAM_HEADER_OPTIONSF_DATADISCONTINUITY 0x00000004 +#define KSSTREAM_HEADER_OPTIONSF_TYPECHANGED 0x00000008 +#define KSSTREAM_HEADER_OPTIONSF_TIMEVALID 0x00000010 +#define KSSTREAM_HEADER_OPTIONSF_TIMEDISCONTINUITY 0x00000040 +#define KSSTREAM_HEADER_OPTIONSF_FLUSHONPAUSE 0x00000080 +#define KSSTREAM_HEADER_OPTIONSF_DURATIONVALID 0x00000100 +#define KSSTREAM_HEADER_OPTIONSF_ENDOFSTREAM 0x00000200 +#define KSSTREAM_HEADER_OPTIONSF_BUFFEREDTRANSFER 0x00000400 +#define KSSTREAM_HEADER_OPTIONSF_VRAM_DATA_TRANSFER 0x00000800 +#define KSSTREAM_HEADER_OPTIONSF_METADATA 0x00001000 +#define KSSTREAM_HEADER_OPTIONSF_ENDOFPHOTOSEQUENCE 0x00002000 +#define KSSTREAM_HEADER_OPTIONSF_FRAMEINFO 0x00004000 +// +//Start of MDL caching related definitions +// +#define KSSTREAM_HEADER_OPTIONSF_PERSIST_SAMPLE 0x00008000 +#define KSSTREAM_HEADER_OPTIONSF_SAMPLE_PERSISTED 0x00010000 + +// +// This flag tells the user mode to look at frame completion numbers +// +#define KSSTREAM_HEADER_TRACK_COMPLETION_NUMBERS 0x00020000 + +// +//End of MDL caching related definitions +#define KSSTREAM_HEADER_OPTIONSF_SECUREBUFFERTRANSFER 0x00040000 +#define KSSTREAM_HEADER_OPTIONSF_LOOPEDDATA 0x80000000 + +typedef struct { + LONGLONG Time; + ULONG Numerator; + ULONG Denominator; +} KSTIME, *PKSTIME; + +typedef struct { + ULONG Size; + ULONG TypeSpecificFlags; + KSTIME PresentationTime; + LONGLONG Duration; + ULONG FrameExtent; + ULONG DataUsed; + _Field_size_bytes_(FrameExtent) + PVOID Data; + ULONG OptionsFlags; +#if _WIN64 + ULONG Reserved; +#endif +} KSSTREAM_HEADER, *PKSSTREAM_HEADER; + +typedef struct { + ULONG BufferSize; + ULONG UsedSize; + _Field_size_bytes_(BufferSize) + PVOID Data; // Metadata buffer passed down by user mode (mapped to SystemVa) + _Field_size_bytes_(BufferSize) + PVOID SystemVa; // Metadata buffer that driver will fill metadata to + ULONG Flags; + ULONG Reserved; +} KSSTREAM_METADATA_INFO, *PKSSTREAM_METADATA_INFO; + +typedef struct +{ + ULONG PresentationTimeStamp; + ULONG SourceClockReference; + union + { + struct + { + USHORT Counter : 11; + USHORT Reserved : 5; + }; + USHORT SCRToken; + }; + USHORT Reserved0; + ULONG Reserved1; +} KSSTREAM_UVC_METADATATYPE_TIMESTAMP, *PKSSTREAM_UVC_METADATATYPE_TIMESTAMP; + +typedef struct { + KSSTREAM_UVC_METADATATYPE_TIMESTAMP StartOfFrameTimestamp; + KSSTREAM_UVC_METADATATYPE_TIMESTAMP EndOfFrameTimestamp; +} KSSTREAM_UVC_METADATA, *PKSSTREAM_UVC_METADATA; + +// +// Additional space for UVC Attribute data to be stamped in the payload by the +// Inbox UVC driver +// +#define KSSTREAM_UVC_SECURE_ATTRIBUTE_SIZE (0x2000) + +typedef enum{ + KSPIN_MDL_CACHING_NOTIFY_CLEANUP, + KSPIN_MDL_CACHING_NOTIFY_CLEANALL_WAIT, + KSPIN_MDL_CACHING_NOTIFY_CLEANALL_NOWAIT, + KSPIN_MDL_CACHING_NOTIFY_ADDSAMPLE +}KSPIN_MDL_CACHING_EVENT; + +typedef struct { + KSPIN_MDL_CACHING_EVENT Event; + PVOID Buffer; +} KSPIN_MDL_CACHING_NOTIFICATION, *PKSPIN_MDL_CACHING_NOTIFICATION; + +typedef struct { + KSPIN_MDL_CACHING_EVENT Event; + ULONG Buffer; +} KSPIN_MDL_CACHING_NOTIFICATION32, *PKSPIN_MDL_CACHING_NOTIFICATION32; + + + +#define STATIC_KSPROPSETID_StreamInterface\ + 0x1fdd8ee1L, 0x9cd3, 0x11d0, 0x82, 0xaa, 0x00, 0x00, 0xf8, 0x22, 0xfe, 0x8a +DEFINE_GUIDSTRUCT("1fdd8ee1-9cd3-11d0-82aa-0000f822fe8a", KSPROPSETID_StreamInterface); +#define KSPROPSETID_StreamInterface DEFINE_GUIDNAMED(KSPROPSETID_StreamInterface) + +typedef enum { + KSPROPERTY_STREAMINTERFACE_HEADERSIZE +} KSPROPERTY_STREAMINTERFACE; + +#define DEFINE_KSPROPERTY_ITEM_STREAMINTERFACE_HEADERSIZE( GetHandler )\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAMINTERFACE_HEADERSIZE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_STREAMINTERFACESET(StreamInterfaceSet,\ + HeaderSizeHandler)\ +DEFINE_KSPROPERTY_TABLE(StreamInterfaceSet) {\ + DEFINE_KSPROPERTY_ITEM_STREAMINTERFACE_HEADERSIZE( HeaderSizeHandler )\ +} + +#define STATIC_KSPROPSETID_Stream\ + 0x65aaba60L, 0x98ae, 0x11cf, 0xa1, 0x0d, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("65aaba60-98ae-11cf-a10d-0020afd156e4", KSPROPSETID_Stream); +#define KSPROPSETID_Stream DEFINE_GUIDNAMED(KSPROPSETID_Stream) + +typedef enum { + KSPROPERTY_STREAM_ALLOCATOR, + KSPROPERTY_STREAM_QUALITY, + KSPROPERTY_STREAM_DEGRADATION, + KSPROPERTY_STREAM_MASTERCLOCK, + KSPROPERTY_STREAM_TIMEFORMAT, + KSPROPERTY_STREAM_PRESENTATIONTIME, + KSPROPERTY_STREAM_PRESENTATIONEXTENT, + KSPROPERTY_STREAM_FRAMETIME, + KSPROPERTY_STREAM_RATECAPABILITY, + KSPROPERTY_STREAM_RATE, + KSPROPERTY_STREAM_PIPE_ID +} KSPROPERTY_STREAM; + +#define DEFINE_KSPROPERTY_ITEM_STREAM_ALLOCATOR(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_ALLOCATOR,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(HANDLE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_QUALITY(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_QUALITY,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSQUALITY_MANAGER),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_DEGRADATION(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_DEGRADATION,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + 0,\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_MASTERCLOCK(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_MASTERCLOCK,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(HANDLE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_TIMEFORMAT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_TIMEFORMAT,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(GUID),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_PRESENTATIONTIME(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_PRESENTATIONTIME,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSTIME),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_PRESENTATIONEXTENT(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_PRESENTATIONEXTENT,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_FRAMETIME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_FRAMETIME,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSFRAMETIME),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_RATECAPABILITY(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_RATECAPABILITY,\ + (Handler),\ + sizeof(KSRATE_CAPABILITY),\ + sizeof(KSRATE),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_RATE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_RATE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(KSRATE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_STREAM_PIPE_ID(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_STREAM_PIPE_ID,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(HANDLE),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + +typedef enum{ + KSPROPERTY_ALLOCATOR_CLEANUP_CACHEDMDLPAGES = 1 +}KSPPROPERTY_ALLOCATOR_MDLCACHING; + + + +#define DEFINE_KSPROPERTY_ITEM_CONNECTION_MDLCACHING(SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_ALLOCATOR_CLEANUP_CACHEDMDLPAGES,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(KSPIN_MDL_CACHING_NOTIFICATION),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) + + +#define STATIC_KSPROPSETID_PinMDLCacheClearProp \ + 0xbd718a7b, 0x97fc, 0x40c7, 0x88, 0xce, 0xd3, 0xff, 0x6, 0xf5, 0x5b, 0x16 +DEFINE_GUIDSTRUCT("BD718A7B-97FC-40C7-88CE-D3FF06F55B16", KSPROPSETID_PinMDLCacheClearProp); +#define KSPROPSETID_PinMDLCacheClearProp DEFINE_GUIDNAMED(KSPROPSETID_PinMDLCacheClearProp) + + + +typedef struct { + HANDLE QualityManager; + PVOID Context; +} KSQUALITY_MANAGER, *PKSQUALITY_MANAGER; + + +typedef struct { + LONGLONG Duration; + ULONG FrameFlags; + ULONG Reserved; +} KSFRAMETIME, *PKSFRAMETIME; + +#define KSFRAMETIME_VARIABLESIZE 0x00000001 + +typedef struct { + LONGLONG PresentationStart; + LONGLONG Duration; + KSPIN_INTERFACE Interface; + LONG Rate; + ULONG Flags; +} KSRATE, *PKSRATE; + +#define KSRATE_NOPRESENTATIONSTART 0x00000001 +#define KSRATE_NOPRESENTATIONDURATION 0x00000002 + +typedef struct { + KSPROPERTY Property; + KSRATE Rate; +} KSRATE_CAPABILITY, *PKSRATE_CAPABILITY; + +#define STATIC_KSPROPSETID_Clock \ + 0xDF12A4C0L, 0xAC17, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("DF12A4C0-AC17-11CF-A5D6-28DB04C10000", KSPROPSETID_Clock); +#define KSPROPSETID_Clock DEFINE_GUIDNAMED(KSPROPSETID_Clock) + +// +// Performs a x*y/z operation on 64 bit quantities by splitting the operation. The equation +// is simplified with respect to adding in the remainder for the upper 32 bits. +// +// (xh * 10000000 / Frequency) * 2^32 + ((((xh * 10000000) % Frequency) * 2^32 + (xl * 10000000)) / Frequency) +// +#define NANOSECONDS 10000000 +#define KSCONVERT_PERFORMANCE_TIME(Frequency, PerformanceTime) \ + ((((ULONGLONG)(ULONG)(PerformanceTime).HighPart * NANOSECONDS / (Frequency)) << 32) + \ + ((((((ULONGLONG)(ULONG)(PerformanceTime).HighPart * NANOSECONDS) % (Frequency)) << 32) + \ + ((ULONGLONG)(PerformanceTime).LowPart * NANOSECONDS)) / (Frequency))) + +typedef struct { + ULONG CreateFlags; +} KSCLOCK_CREATE, *PKSCLOCK_CREATE; + +typedef struct { + LONGLONG Time; + LONGLONG SystemTime; +} KSCORRELATED_TIME, *PKSCORRELATED_TIME; + +typedef struct { + LONGLONG Granularity; + LONGLONG Error; +} KSRESOLUTION, *PKSRESOLUTION; + +typedef enum { + KSPROPERTY_CLOCK_TIME, + KSPROPERTY_CLOCK_PHYSICALTIME, + KSPROPERTY_CLOCK_CORRELATEDTIME, + KSPROPERTY_CLOCK_CORRELATEDPHYSICALTIME, + KSPROPERTY_CLOCK_RESOLUTION, + KSPROPERTY_CLOCK_STATE, +#if defined(_NTDDK_) + KSPROPERTY_CLOCK_FUNCTIONTABLE +#endif // defined(_NTDDK_) +} KSPROPERTY_CLOCK; + +#if defined(_NTDDK_) + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +LONGLONG +(FASTCALL *PFNKSCLOCK_GETTIME)( + _In_ PFILE_OBJECT FileObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +LONGLONG +(FASTCALL *PFNKSCLOCK_CORRELATEDTIME)( + _In_ PFILE_OBJECT FileObject, + _Out_ PLONGLONG SystemTime); + +typedef struct { + PFNKSCLOCK_GETTIME GetTime; + PFNKSCLOCK_GETTIME GetPhysicalTime; + PFNKSCLOCK_CORRELATEDTIME GetCorrelatedTime; + PFNKSCLOCK_CORRELATEDTIME GetCorrelatedPhysicalTime; +} KSCLOCK_FUNCTIONTABLE, *PKSCLOCK_FUNCTIONTABLE; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +BOOLEAN +(*PFNKSSETTIMER)( + _In_ PVOID Context, + _In_ PKTIMER Timer, + _In_ LARGE_INTEGER DueTime, + _In_ PKDPC Dpc + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +BOOLEAN +(*PFNKSCANCELTIMER)( + _In_ PVOID Context, + _In_ PKTIMER Timer + ); + +typedef +LONGLONG +(FASTCALL *PFNKSCORRELATEDTIME)( + _In_ PVOID Context, + _Out_ PLONGLONG SystemTime); + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +typedef PVOID PKSDEFAULTCLOCK; + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_TIME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_TIME,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_PHYSICALTIME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_PHYSICALTIME,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(LONGLONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_CORRELATEDTIME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_CORRELATEDTIME,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSCORRELATED_TIME),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_CORRELATEDPHYSICALTIME(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_CORRELATEDPHYSICALTIME,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSCORRELATED_TIME),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_RESOLUTION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_RESOLUTION,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSRESOLUTION),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_STATE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_STATE,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSSTATE),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_CLOCK_FUNCTIONTABLE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CLOCK_FUNCTIONTABLE,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(KSCLOCK_FUNCTIONTABLE),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_CLOCKSET(ClockSet,\ + PropTime, PropPhysicalTime,\ + PropCorrelatedTime, PropCorrelatedPhysicalTime,\ + PropResolution, PropState, PropFunctionTable)\ +DEFINE_KSPROPERTY_TABLE(ClockSet) {\ + DEFINE_KSPROPERTY_ITEM_CLOCK_TIME(PropTime),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_PHYSICALTIME(PropPhysicalTime),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_CORRELATEDTIME(PropCorrelatedTime),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_CORRELATEDPHYSICALTIME(PropCorrelatedPhysicalTime),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_RESOLUTION(PropResolution),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_STATE(PropState),\ + DEFINE_KSPROPERTY_ITEM_CLOCK_FUNCTIONTABLE(PropFunctionTable)\ +} + +#endif // defined(_NTDDK_) + +#define STATIC_KSEVENTSETID_Clock \ + 0x364D8E20L, 0x62C7, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("364D8E20-62C7-11CF-A5D6-28DB04C10000", KSEVENTSETID_Clock); +#define KSEVENTSETID_Clock DEFINE_GUIDNAMED(KSEVENTSETID_Clock) + +typedef enum { + KSEVENT_CLOCK_INTERVAL_MARK, + KSEVENT_CLOCK_POSITION_MARK +} KSEVENT_CLOCK_POSITION; + +#define STATIC_KSEVENTSETID_Connection\ + 0x7f4bcbe0L, 0x9ea5, 0x11cf, 0xa5, 0xd6, 0x28, 0xdb, 0x04, 0xc1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("7f4bcbe0-9ea5-11cf-a5d6-28db04c10000", KSEVENTSETID_Connection); +#define KSEVENTSETID_Connection DEFINE_GUIDNAMED(KSEVENTSETID_Connection) + +typedef enum { + KSEVENT_CONNECTION_POSITIONUPDATE, + KSEVENT_CONNECTION_DATADISCONTINUITY, + KSEVENT_CONNECTION_TIMEDISCONTINUITY, + KSEVENT_CONNECTION_PRIORITY, + KSEVENT_CONNECTION_ENDOFSTREAM +} KSEVENT_CONNECTION; + +typedef struct { + PVOID Context; + ULONG Proportion; + LONGLONG DeltaTime; +} KSQUALITY, *PKSQUALITY; + +typedef struct { + PVOID Context; + ULONG Status; +} KSERROR, *PKSERROR; + +typedef enum { + KSDEVICE_THERMAL_STATE_LOW, + KSDEVICE_THERMAL_STATE_HIGH +} KSDEVICE_THERMAL_STATE; + + +#define STATIC_KSEVENTSETID_Device\ + 0x288296ec, 0x9f94, 0x41b4, 0xa1, 0x53, 0xaa, 0x31, 0xae, 0xec, 0xb3, 0x3f +DEFINE_GUIDSTRUCT("288296EC-9F94-41b4-A153-AA31AEECB33F", KSEVENTSETID_Device); +#define KSEVENTSETID_Device DEFINE_GUIDNAMED(KSEVENTSETID_Device) + +typedef enum { + KSEVENT_DEVICE_LOST, + KSEVENT_DEVICE_PREEMPTED, + KSEVENT_DEVICE_THERMAL_HIGH, + KSEVENT_DEVICE_THERMAL_LOW +} KSEVENT_DEVICE; + +typedef KSIDENTIFIER KSDEGRADE, *PKSDEGRADE; + +#define STATIC_KSDEGRADESETID_Standard\ + 0x9F564180L, 0x704C, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("9F564180-704C-11D0-A5D6-28DB04C10000", KSDEGRADESETID_Standard); +#define KSDEGRADESETID_Standard DEFINE_GUIDNAMED(KSDEGRADESETID_Standard) + +typedef enum { + KSDEGRADE_STANDARD_SAMPLE, + KSDEGRADE_STANDARD_QUALITY, + KSDEGRADE_STANDARD_COMPUTATION, + KSDEGRADE_STANDARD_SKIP +} KSDEGRADE_STANDARD; + +#if defined(_NTDDK_) + +#define KSPROBE_STREAMREAD 0x00000000 +#define KSPROBE_STREAMWRITE 0x00000001 +#define KSPROBE_ALLOCATEMDL 0x00000010 +#define KSPROBE_PROBEANDLOCK 0x00000020 +#define KSPROBE_SYSTEMADDRESS 0x00000040 +#define KSPROBE_MODIFY 0x00000200 +#define KSPROBE_STREAMWRITEMODIFY (KSPROBE_MODIFY | KSPROBE_STREAMWRITE) +#define KSPROBE_ALLOWFORMATCHANGE 0x00000080 + +#define KSSTREAM_READ KSPROBE_STREAMREAD +#define KSSTREAM_WRITE KSPROBE_STREAMWRITE +#define KSSTREAM_PAGED_DATA 0x00000000 +#define KSSTREAM_NONPAGED_DATA 0x00000100 +#define KSSTREAM_SYNCHRONOUS 0x00001000 +#define KSSTREAM_FAILUREEXCEPTION 0x00002000 + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSCONTEXT_DISPATCH)( + _In_ PVOID Context, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSHANDLER)( + _In_ PIRP Irp, + _In_ PKSIDENTIFIER Request, + _Inout_ PVOID Data + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +BOOLEAN +(*PFNKSFASTHANDLER)( + _In_ PFILE_OBJECT FileObject, + _In_reads_bytes_(RequestLength) PKSIDENTIFIER Request, + _In_ ULONG RequestLength, + _Inout_updates_bytes_(DataLength) PVOID Data, + _In_ ULONG DataLength, + _Out_ PIO_STATUS_BLOCK IoStatus + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSALLOCATOR)( + _In_ PIRP Irp, + _In_ ULONG BufferSize, + _In_ BOOLEAN InputOperation + ); + +typedef struct { + KSPROPERTY_MEMBERSHEADER MembersHeader; + const VOID* Members; +} KSPROPERTY_MEMBERSLIST, *PKSPROPERTY_MEMBERSLIST; + +typedef struct { + KSIDENTIFIER PropTypeSet; + ULONG MembersListCount; + _Field_size_(MembersListCount) + const KSPROPERTY_MEMBERSLIST* MembersList; +} KSPROPERTY_VALUES, *PKSPROPERTY_VALUES; + +#define DEFINE_KSPROPERTY_TABLE(tablename)\ + const KSPROPERTY_ITEM tablename[] = + +#define DEFINE_KSPROPERTY_ITEM(PropertyId, GetHandler,\ + MinProperty,\ + MinData,\ + SetHandler,\ + Values, RelationsCount, Relations, SupportHandler,\ + SerializedSize)\ +{\ + PropertyId, (PFNKSHANDLER)GetHandler, MinProperty, MinData,\ + (PFNKSHANDLER)SetHandler,\ + (PKSPROPERTY_VALUES)Values, RelationsCount, (PKSPROPERTY)Relations,\ + (PFNKSHANDLER)SupportHandler, (ULONG)SerializedSize\ +} + +typedef struct { + ULONG PropertyId; + union { + PFNKSHANDLER GetPropertyHandler; + BOOLEAN GetSupported; + }; + ULONG MinProperty; + ULONG MinData; + union { + PFNKSHANDLER SetPropertyHandler; + BOOLEAN SetSupported; + }; + const KSPROPERTY_VALUES*Values; + ULONG RelationsCount; + _Field_size_(RelationsCount) + const KSPROPERTY* Relations; + PFNKSHANDLER SupportHandler; + ULONG SerializedSize; +} KSPROPERTY_ITEM, *PKSPROPERTY_ITEM; + +#define DEFINE_KSFASTPROPERTY_ITEM(PropertyId, GetHandler, SetHandler)\ +{\ + PropertyId, (PFNKSFASTHANDLER)GetHandler, (PFNKSFASTHANDLER)SetHandler, 0\ +} + +typedef struct { + ULONG PropertyId; + union { + PFNKSFASTHANDLER GetPropertyHandler; + BOOLEAN GetSupported; + }; + union { + PFNKSFASTHANDLER SetPropertyHandler; + BOOLEAN SetSupported; + }; + ULONG Reserved; +} KSFASTPROPERTY_ITEM, *PKSFASTPROPERTY_ITEM; + +#define DEFINE_KSPROPERTY_SET(Set,\ + PropertiesCount,\ + PropertyItem,\ + FastIoCount,\ + FastIoTable)\ +{\ + Set,\ + PropertiesCount,\ + PropertyItem,\ + FastIoCount,\ + FastIoTable\ +} + +#define DEFINE_KSPROPERTY_SET_TABLE(tablename)\ + const KSPROPERTY_SET tablename[] = + +typedef struct { + const GUID* Set; + ULONG PropertiesCount; + _Field_size_(PropertiesCount) + const KSPROPERTY_ITEM* PropertyItem; + ULONG FastIoCount; + const KSFASTPROPERTY_ITEM* FastIoTable; +} KSPROPERTY_SET, *PKSPROPERTY_SET; + +#define DEFINE_KSMETHOD_TABLE(tablename)\ + const KSMETHOD_ITEM tablename[] = + +#define DEFINE_KSMETHOD_ITEM(MethodId, Flags,\ + MethodHandler,\ + MinMethod, MinData, SupportHandler)\ +{\ + MethodId, (PFNKSHANDLER)MethodHandler, MinMethod, MinData,\ + SupportHandler, Flags\ +} + +typedef struct { + ULONG MethodId; + union { + PFNKSHANDLER MethodHandler; + BOOLEAN MethodSupported; + }; + ULONG MinMethod; + ULONG MinData; + PFNKSHANDLER SupportHandler; + ULONG Flags; +} KSMETHOD_ITEM, *PKSMETHOD_ITEM; + +#define DEFINE_KSFASTMETHOD_ITEM(MethodId, MethodHandler)\ +{\ + MethodId, (PFNKSFASTHANDLER)MethodHandler\ +} + +typedef struct { + ULONG MethodId; + union { + PFNKSFASTHANDLER MethodHandler; + BOOLEAN MethodSupported; + }; +} KSFASTMETHOD_ITEM, *PKSFASTMETHOD_ITEM; + +#define DEFINE_KSMETHOD_SET(Set,\ + MethodsCount,\ + MethodItem,\ + FastIoCount,\ + FastIoTable)\ +{\ + Set,\ + MethodsCount,\ + MethodItem,\ + FastIoCount,\ + FastIoTable\ +} + +#define DEFINE_KSMETHOD_SET_TABLE(tablename)\ + const KSMETHOD_SET tablename[] = + +typedef struct { + const GUID* Set; + ULONG MethodsCount; + _Field_size_(MethodsCount) + const KSMETHOD_ITEM* MethodItem; + ULONG FastIoCount; + _Field_size_(FastIoCount) const KSFASTMETHOD_ITEM*FastIoTable; +} KSMETHOD_SET, *PKSMETHOD_SET; + +typedef struct _KSEVENT_ENTRY +KSEVENT_ENTRY, *PKSEVENT_ENTRY; + +typedef +NTSTATUS +(*PFNKSADDEVENT)( + _In_ PIRP Irp, + _In_ PKSEVENTDATA EventData, + _In_ struct _KSEVENT_ENTRY* EventEntry + ); + +typedef +VOID +(*PFNKSREMOVEEVENT)( + _In_ PFILE_OBJECT FileObject, + _In_ struct _KSEVENT_ENTRY* EventEntry + ); + +#define DEFINE_KSEVENT_TABLE(tablename)\ + const KSEVENT_ITEM tablename[] = + +#define DEFINE_KSEVENT_ITEM(EventId, DataInput, ExtraEntryData,\ + AddHandler, RemoveHandler, SupportHandler)\ +{\ + EventId,\ + DataInput,\ + ExtraEntryData,\ + AddHandler,\ + RemoveHandler,\ + SupportHandler\ +} + +typedef struct { + ULONG EventId; + ULONG DataInput; + ULONG ExtraEntryData; + PFNKSADDEVENT AddHandler; + PFNKSREMOVEEVENT RemoveHandler; + PFNKSHANDLER SupportHandler; +} KSEVENT_ITEM, *PKSEVENT_ITEM; + +#define DEFINE_KSEVENT_SET(Set,\ + EventsCount,\ + EventItem)\ +{\ + Set, EventsCount, EventItem\ +} + +#define DEFINE_KSEVENT_SET_TABLE(tablename)\ + const KSEVENT_SET tablename[] = + +typedef struct { + const GUID* Set; + ULONG EventsCount; + _Field_size_(EventsCount) const KSEVENT_ITEM* EventItem; +} KSEVENT_SET, *PKSEVENT_SET; + +typedef struct { + KDPC Dpc; + ULONG ReferenceCount; + KSPIN_LOCK AccessLock; +} KSDPC_ITEM, *PKSDPC_ITEM; + +typedef struct { + KSDPC_ITEM DpcItem; + LIST_ENTRY BufferList; +} KSBUFFER_ITEM, *PKSBUFFER_ITEM; + +#define KSEVENT_ENTRY_DELETED 1 +#define KSEVENT_ENTRY_ONESHOT 2 +#define KSEVENT_ENTRY_BUFFERED 4 + +struct _KSEVENT_ENTRY { + LIST_ENTRY ListEntry; + PVOID Object; + union { + PKSDPC_ITEM DpcItem; + PKSBUFFER_ITEM BufferItem; + }; + PKSEVENTDATA EventData; + ULONG NotificationType; + const KSEVENT_SET* EventSet; + const KSEVENT_ITEM* EventItem; + PFILE_OBJECT FileObject; + ULONG SemaphoreAdjustment; + ULONG Reserved; + ULONG Flags; +}; + +typedef enum { + KSEVENTS_NONE, + KSEVENTS_SPINLOCK, + KSEVENTS_MUTEX, + KSEVENTS_FMUTEX, + KSEVENTS_FMUTEXUNSAFE, + KSEVENTS_INTERRUPT, + KSEVENTS_ERESOURCE +} KSEVENTS_LOCKTYPE; + +#define KSDISPATCH_FASTIO 0x80000000 + +typedef struct { + PDRIVER_DISPATCH Create; + PVOID Context; + UNICODE_STRING ObjectClass; + PSECURITY_DESCRIPTOR SecurityDescriptor; + ULONG Flags; +} KSOBJECT_CREATE_ITEM, *PKSOBJECT_CREATE_ITEM; + +typedef +VOID +(*PFNKSITEMFREECALLBACK)( + _In_ PKSOBJECT_CREATE_ITEM CreateItem + ); + +#define KSCREATE_ITEM_SECURITYCHANGED 0x00000001 +#define KSCREATE_ITEM_WILDCARD 0x00000002 +#define KSCREATE_ITEM_NOPARAMETERS 0x00000004 +#define KSCREATE_ITEM_FREEONSTOP 0x00000008 + +#define DEFINE_KSCREATE_DISPATCH_TABLE( tablename )\ + KSOBJECT_CREATE_ITEM tablename[] = + +#define DEFINE_KSCREATE_ITEM(DispatchCreate, TypeName, Context)\ +{\ + (DispatchCreate),\ + (PVOID)(Context),\ + {\ + sizeof(TypeName) - sizeof(UNICODE_NULL),\ + sizeof(TypeName),\ + (PWCHAR)(TypeName)\ + },\ + NULL, 0\ +} + +#define DEFINE_KSCREATE_ITEMEX(DispatchCreate, TypeName, Context, Flags)\ +{\ + (DispatchCreate),\ + (PVOID)(Context),\ + {\ + sizeof(TypeName) - sizeof(UNICODE_NULL),\ + sizeof(TypeName),\ + (PWCHAR)(TypeName)\ + },\ + NULL, (Flags)\ +} + +#define DEFINE_KSCREATE_ITEMNULL( DispatchCreate, Context )\ +{\ + DispatchCreate,\ + Context,\ + {\ + 0,\ + 0,\ + NULL,\ + },\ + NULL, 0\ +} + +typedef struct { + ULONG CreateItemsCount; + _Field_size_(CreateItemsCount) PKSOBJECT_CREATE_ITEM CreateItemsList; +} KSOBJECT_CREATE, *PKSOBJECT_CREATE; + +typedef struct { + PDRIVER_DISPATCH DeviceIoControl; + PDRIVER_DISPATCH Read; + PDRIVER_DISPATCH Write; + PDRIVER_DISPATCH Flush; + PDRIVER_DISPATCH Close; + PDRIVER_DISPATCH QuerySecurity; + PDRIVER_DISPATCH SetSecurity; + PFAST_IO_DEVICE_CONTROL FastDeviceIoControl; + PFAST_IO_READ FastRead; + PFAST_IO_WRITE FastWrite; +} KSDISPATCH_TABLE, *PKSDISPATCH_TABLE; + +#define DEFINE_KSDISPATCH_TABLE( tablename, DeviceIoControl, Read, Write,\ + Flush, Close, QuerySecurity, SetSecurity,\ + FastDeviceIoControl, FastRead, FastWrite )\ + const KSDISPATCH_TABLE tablename = \ + {\ + DeviceIoControl, \ + Read, \ + Write, \ + Flush, \ + Close, \ + QuerySecurity, \ + SetSecurity, \ + FastDeviceIoControl, \ + FastRead, \ + FastWrite, \ + } + +#define KSCREATE_ITEM_IRP_STORAGE(Irp) (*(PKSOBJECT_CREATE_ITEM*)&(Irp)->Tail.Overlay.DriverContext[0]) +#define KSEVENT_SET_IRP_STORAGE(Irp) (*(const KSEVENT_SET**)&(Irp)->Tail.Overlay.DriverContext[0]) +#define KSEVENT_ITEM_IRP_STORAGE(Irp) (*(const KSEVENT_ITEM**)&(Irp)->Tail.Overlay.DriverContext[3]) +#define KSEVENT_ENTRY_IRP_STORAGE(Irp) (*(PKSEVENT_ENTRY*)&(Irp)->Tail.Overlay.DriverContext[0]) +#define KSMETHOD_SET_IRP_STORAGE(Irp) (*(const KSMETHOD_SET**)&(Irp)->Tail.Overlay.DriverContext[0]) +#define KSMETHOD_ITEM_IRP_STORAGE(Irp) (*(const KSMETHOD_ITEM**)&(Irp)->Tail.Overlay.DriverContext[3]) +#define KSMETHOD_TYPE_IRP_STORAGE(Irp) (*(ULONG_PTR*)(&(Irp)->Tail.Overlay.DriverContext[2])) +#define KSQUEUE_SPINLOCK_IRP_STORAGE(Irp) (*(PKSPIN_LOCK*)&(Irp)->Tail.Overlay.DriverContext[1]) +#define KSPROPERTY_SET_IRP_STORAGE(Irp) (*(const KSPROPERTY_SET**)&(Irp)->Tail.Overlay.DriverContext[0]) +#define KSPROPERTY_ITEM_IRP_STORAGE(Irp) (*(const KSPROPERTY_ITEM**)&(Irp)->Tail.Overlay.DriverContext[3]) +#define KSPROPERTY_ATTRIBUTES_IRP_STORAGE(Irp) (*(PKSATTRIBUTE_LIST*)&(Irp)->Tail.Overlay.DriverContext[2]) + +typedef PVOID KSDEVICE_HEADER, KSOBJECT_HEADER; + +typedef enum { + KsInvokeOnSuccess = 1, + KsInvokeOnError = 2, + KsInvokeOnCancel = 4 +} KSCOMPLETION_INVOCATION; + +typedef enum { + KsListEntryTail, + KsListEntryHead +} KSLIST_ENTRY_LOCATION; + +typedef enum { + KsAcquireOnly, + KsAcquireAndRemove, + KsAcquireOnlySingleItem, + KsAcquireAndRemoveOnlySingleItem +} KSIRP_REMOVAL_OPERATION; + +typedef enum { + KsStackCopyToNewLocation, + KsStackReuseCurrentLocation, + KsStackUseNewLocation +} KSSTACK_USE; + +typedef enum { + KSTARGET_STATE_DISABLED, + KSTARGET_STATE_ENABLED +} KSTARGET_STATE; + +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +NTSTATUS +(*PFNKSIRPLISTCALLBACK)( + _In_ PIRP Irp, + _In_ PVOID Context + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +VOID +(*PFNREFERENCEDEVICEOBJECT)( + _In_ PVOID Context + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +VOID +(*PFNDEREFERENCEDEVICEOBJECT)( + _In_ PVOID Context + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNQUERYREFERENCESTRING)( + _In_ PVOID Context, + _Inout_ PWCHAR *String + ); + +#define BUS_INTERFACE_REFERENCE_VERSION 0x100 + +typedef struct { + // + // Standard interface header + // + + INTERFACE Interface; + + // + // Standard bus interfaces + // + + PFNREFERENCEDEVICEOBJECT ReferenceDeviceObject; + PFNDEREFERENCEDEVICEOBJECT DereferenceDeviceObject; + PFNQUERYREFERENCESTRING QueryReferenceString; + +} BUS_INTERFACE_REFERENCE, *PBUS_INTERFACE_REFERENCE; + +#define STATIC_REFERENCE_BUS_INTERFACE STATIC_KSMEDIUMSETID_Standard +#define REFERENCE_BUS_INTERFACE KSMEDIUMSETID_Standard + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNQUERYMEDIUMSLIST)( + _In_ PVOID Context, + _Out_ ULONG* MediumsCount, + _Out_writes_(MediumsCount) PKSPIN_MEDIUM* MediumList + ); + +typedef struct { + // + // Standard interface header + // + + INTERFACE Interface; + + // + // Interface definition + // + + PFNQUERYMEDIUMSLIST QueryMediumsList; + +} BUS_INTERFACE_MEDIUMS, *PBUS_INTERFACE_MEDIUMS; + +#define STATIC_GUID_BUS_INTERFACE_MEDIUMS \ + 0x4EC35C3EL, 0x201B, 0x11D2, 0x87, 0x45, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("4EC35C3E-201B-11D2-8745-00A0C9223196", GUID_BUS_INTERFACE_MEDIUMS); +#define GUID_BUS_INTERFACE_MEDIUMS DEFINE_GUIDNAMED(GUID_BUS_INTERFACE_MEDIUMS) + +#endif // defined(_NTDDK_) + +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif + +typedef struct { + GUID PropertySet; + ULONG Count; +} KSPROPERTY_SERIALHDR, *PKSPROPERTY_SERIALHDR; + +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif + +typedef struct { + KSIDENTIFIER PropTypeSet; + ULONG Id; + ULONG PropertyLength; +} KSPROPERTY_SERIAL, *PKSPROPERTY_SERIAL; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#if defined(_NTDDK_) + +#define IOCTL_KS_HANDSHAKE CTL_CODE(FILE_DEVICE_KS, 0x007, METHOD_NEITHER, FILE_ANY_ACCESS) + +typedef struct { + GUID ProtocolId; + PVOID Argument1; + PVOID Argument2; +} KSHANDSHAKE, *PKSHANDSHAKE; + +typedef struct _KSGATE +KSGATE, *PKSGATE; + +struct _KSGATE { + LONG Count; + PKSGATE NextGate; +}; + +#ifndef _NTOS_ + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateTurnInputOn( + _In_opt_ PKSGATE Gate + ) +{ + while (Gate && (InterlockedIncrement(&Gate->Count) == 1)) { + Gate = Gate->NextGate; + } +} + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateTurnInputOff( + _In_opt_ PKSGATE Gate + ) +{ + while (Gate && (InterlockedDecrement(&Gate->Count) == 0)) { + Gate = Gate->NextGate; + } +} + +_IRQL_requires_max_(HIGH_LEVEL) +BOOLEAN __inline +KsGateGetStateUnsafe( + _In_ PKSGATE Gate + ) +{ + ASSERT(Gate); + return((BOOLEAN)(Gate->Count > 0)); +} + +_IRQL_requires_max_(HIGH_LEVEL) +BOOLEAN __inline +KsGateCaptureThreshold( + _In_ PKSGATE Gate + ) +{ + BOOLEAN captured; + + ASSERT(Gate); + + captured = (BOOLEAN)(InterlockedCompareExchange(&Gate->Count,0,1) == 1); + + // + // If we made a transition, it must be propagated. + // + if (captured) { + KsGateTurnInputOff(Gate->NextGate); + } + + // + // We return whatever the state was prior to the compare/exchange. If + // the state was on, the state is now off. + // + return captured; +} + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateInitialize( + _In_ PKSGATE Gate, + _In_ LONG InitialCount, + _In_opt_ PKSGATE NextGate, + _In_ BOOLEAN StateToPropagate // _In_ BOOLEAN NextGateIsAnOrGate + ) +{ + ASSERT(Gate); + Gate->Count = InitialCount; + Gate->NextGate = NextGate; + + if (NextGate) { + if (InitialCount > 0) { + if (StateToPropagate) { + KsGateTurnInputOn(NextGate); + } + } else { + if (! StateToPropagate) { + KsGateTurnInputOff(NextGate); + } + } + } +} + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateInitializeAnd( + _In_ PKSGATE AndGate, + _In_opt_ PKSGATE NextOrGate + ) +{ + KsGateInitialize(AndGate,1,NextOrGate,TRUE); +} + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateInitializeOr( + _In_ PKSGATE OrGate, + _In_opt_ PKSGATE NextAndGate + ) +{ + KsGateInitialize(OrGate,0,NextAndGate,FALSE); +} + +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateAddOnInputToAnd(_In_ PKSGATE AndGate) { UNREFERENCED_PARAMETER (AndGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateAddOffInputToAnd(_In_ PKSGATE AndGate) { KsGateTurnInputOff(AndGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateRemoveOnInputFromAnd(_In_ PKSGATE AndGate) { UNREFERENCED_PARAMETER (AndGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateRemoveOffInputFromAnd(_In_ PKSGATE AndGate) { KsGateTurnInputOn(AndGate); } + +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateAddOnInputToOr(_In_ PKSGATE OrGate) { KsGateTurnInputOn(OrGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateAddOffInputToOr(_In_ PKSGATE OrGate) { UNREFERENCED_PARAMETER (OrGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateRemoveOnInputFromOr(_In_ PKSGATE OrGate) { KsGateTurnInputOff(OrGate); } +_IRQL_requires_max_(HIGH_LEVEL) void __inline KsGateRemoveOffInputFromOr(_In_ PKSGATE OrGate) { UNREFERENCED_PARAMETER (OrGate); } + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateTerminateAnd( + _In_ PKSGATE AndGate + ) +{ + ASSERT(AndGate); + if (KsGateGetStateUnsafe(AndGate)) { + KsGateRemoveOnInputFromOr(AndGate->NextGate); + } else { + KsGateRemoveOffInputFromOr(AndGate->NextGate); + } +} + +_IRQL_requires_max_(HIGH_LEVEL) +void __inline +KsGateTerminateOr( + _In_ PKSGATE OrGate + ) +{ + ASSERT(OrGate); + if (KsGateGetStateUnsafe(OrGate)) { + KsGateRemoveOnInputFromAnd(OrGate->NextGate); + } else { + KsGateRemoveOffInputFromAnd(OrGate->NextGate); + } +} + +#endif // !_NTOS_ + +typedef PVOID KSOBJECT_BAG; + +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +BOOLEAN +(*PFNKSGENERATEEVENTCALLBACK)( + _In_ PVOID Context, + _In_ PKSEVENT_ENTRY EventEntry + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICECREATE)( + _In_ PKSDEVICE Device + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICEPNPSTART)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp, + _In_opt_ PCM_RESOURCE_LIST TranslatedResourceList, + _In_opt_ PCM_RESOURCE_LIST UntranslatedResourceList + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICE)( + _In_ PKSDEVICE Device + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICEIRP)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSDEVICEIRPVOID)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICEQUERYCAPABILITIES)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp, + _Inout_ PDEVICE_CAPABILITIES Capabilities + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSDEVICEQUERYPOWER)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp, + _In_ DEVICE_POWER_STATE DeviceTo, + _In_ DEVICE_POWER_STATE DeviceFrom, + _In_ SYSTEM_POWER_STATE SystemTo, + _In_ SYSTEM_POWER_STATE SystemFrom, + _In_ POWER_ACTION Action + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSDEVICESETPOWER)( + _In_ PKSDEVICE Device, + _In_ PIRP Irp, + _In_ DEVICE_POWER_STATE To, + _In_ DEVICE_POWER_STATE From + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSFILTERFACTORYVOID)( + _In_ PKSFILTERFACTORY FilterFactory + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSFILTERFACTORYPOWER)( + _In_ PKSFILTERFACTORY FilterFactory, + _In_ DEVICE_POWER_STATE State + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSFILTERIRP)( + _In_ PKSFILTER Filter, + _In_ PIRP Irp + ); +typedef +NTSTATUS +(*PFNKSFILTERPROCESS)( + _In_ PKSFILTER Filter, + _In_ PKSPROCESSPIN_INDEXENTRY Index + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSFILTERVOID)( + _In_ PKSFILTER Filter + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSFILTERPOWER)( + _In_ PKSFILTER Filter, + _In_ DEVICE_POWER_STATE State + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSPINIRP)( + _In_ PKSPIN Pin, + _In_ PIRP Irp + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSPINSETDEVICESTATE)( + _In_ PKSPIN Pin, + _In_ KSSTATE ToState, + _In_ KSSTATE FromState + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSPINSETDATAFORMAT)( + _In_ PKSPIN Pin, + _In_opt_ PKSDATAFORMAT OldFormat, + _In_opt_ PKSMULTIPLE_ITEM OldAttributeList, + _In_ const KSDATARANGE* DataRange, + _In_opt_ const KSATTRIBUTE_LIST* AttributeRange + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSPINHANDSHAKE)( + _In_ PKSPIN Pin, + _In_ PKSHANDSHAKE In, + _In_ PKSHANDSHAKE Out + ); +typedef +NTSTATUS +(*PFNKSPIN)( + _In_ PKSPIN Pin + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSPINVOID)( + _In_ PKSPIN Pin + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSPINPOWER)( + _In_ PKSPIN Pin, + _In_ DEVICE_POWER_STATE State + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +BOOLEAN +(*PFNKSPINSETTIMER)( + _In_ PKSPIN Pin, + _In_ PKTIMER Timer, + _In_ LARGE_INTEGER DueTime, + _In_ PKDPC Dpc + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +BOOLEAN +(*PFNKSPINCANCELTIMER)( + _In_ PKSPIN Pin, + _In_ PKTIMER Timer + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +LONGLONG +(FASTCALL *PFNKSPINCORRELATEDTIME)( + _In_ PKSPIN Pin, + _Out_ PLONGLONG SystemTime + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +void +(*PFNKSPINRESOLUTION)( + _In_ PKSPIN Pin, + _Out_ PKSRESOLUTION Resolution + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +NTSTATUS +(*PFNKSPININITIALIZEALLOCATOR)( + _In_ PKSPIN Pin, + _In_ PKSALLOCATOR_FRAMING AllocatorFraming, + _Out_ PVOID* Context + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +void +(*PFNKSSTREAMPOINTER)( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +typedef struct KSAUTOMATION_TABLE_ +KSAUTOMATION_TABLE, *PKSAUTOMATION_TABLE; +struct KSAUTOMATION_TABLE_ { + ULONG PropertySetsCount; + ULONG PropertyItemSize; + _Field_size_bytes_(PropertySetsCount * PropertyItemSize) const KSPROPERTY_SET* PropertySets; + ULONG MethodSetsCount; + ULONG MethodItemSize; + _Field_size_bytes_(MethodSetsCount * MethodItemSize) const KSMETHOD_SET* MethodSets; + ULONG EventSetsCount; + ULONG EventItemSize; + _Field_size_bytes_(EventSetsCount * EventItemSize) const KSEVENT_SET* EventSets; +#if !defined(_WIN64) + PVOID Alignment; +#endif // !defined(_WIN64) +}; + +#define DEFINE_KSAUTOMATION_TABLE(table)\ + const KSAUTOMATION_TABLE table = + +#define DEFINE_KSAUTOMATION_PROPERTIES(table)\ + SIZEOF_ARRAY(table),\ + sizeof(KSPROPERTY_ITEM),\ + table + +#define DEFINE_KSAUTOMATION_METHODS(table)\ + SIZEOF_ARRAY(table),\ + sizeof(KSMETHOD_ITEM),\ + table + +#define DEFINE_KSAUTOMATION_EVENTS(table)\ + SIZEOF_ARRAY(table),\ + sizeof(KSEVENT_ITEM),\ + table + +#define DEFINE_KSAUTOMATION_PROPERTIES_NULL\ + 0,\ + sizeof(KSPROPERTY_ITEM),\ + NULL + +#define DEFINE_KSAUTOMATION_METHODS_NULL\ + 0,\ + sizeof(KSMETHOD_ITEM),\ + NULL + +#define DEFINE_KSAUTOMATION_EVENTS_NULL\ + 0,\ + sizeof(KSEVENT_ITEM),\ + NULL + +#define MIN_DEV_VER_FOR_QI (0x100) + +struct _KSDEVICE_DISPATCH { + PFNKSDEVICECREATE Add; + PFNKSDEVICEPNPSTART Start; + PFNKSDEVICE PostStart; + PFNKSDEVICEIRP QueryStop; + PFNKSDEVICEIRPVOID CancelStop; + PFNKSDEVICEIRPVOID Stop; + PFNKSDEVICEIRP QueryRemove; + PFNKSDEVICEIRPVOID CancelRemove; + PFNKSDEVICEIRPVOID Remove; + PFNKSDEVICEQUERYCAPABILITIES QueryCapabilities; + PFNKSDEVICEIRPVOID SurpriseRemoval; + PFNKSDEVICEQUERYPOWER QueryPower; + PFNKSDEVICESETPOWER SetPower; + PFNKSDEVICEIRP QueryInterface; // added in version 0x100 +}; + +struct _KSFILTER_DISPATCH { + PFNKSFILTERIRP Create; + PFNKSFILTERIRP Close; + PFNKSFILTERPROCESS Process; + PFNKSFILTERVOID Reset; +}; + +struct _KSPIN_DISPATCH { + PFNKSPINIRP Create; + PFNKSPINIRP Close; + PFNKSPIN Process; + PFNKSPINVOID Reset; + PFNKSPINSETDATAFORMAT SetDataFormat; + PFNKSPINSETDEVICESTATE SetDeviceState; + PFNKSPIN Connect; + PFNKSPINVOID Disconnect; + const KSCLOCK_DISPATCH* Clock; + const KSALLOCATOR_DISPATCH* Allocator; +}; + +struct _KSCLOCK_DISPATCH { + PFNKSPINSETTIMER SetTimer; + PFNKSPINCANCELTIMER CancelTimer; + PFNKSPINCORRELATEDTIME CorrelatedTime; + PFNKSPINRESOLUTION Resolution; +}; + +struct _KSALLOCATOR_DISPATCH { + PFNKSPININITIALIZEALLOCATOR InitializeAllocator; + PFNKSDELETEALLOCATOR DeleteAllocator; + PFNKSDEFAULTALLOCATE Allocate; + PFNKSDEFAULTFREE Free; +}; + +// +// VERSION indicates support of the following: +// +// - QueryInterface dispatch of KSDEVICE_DISPATCH +// +#define KSDEVICE_DESCRIPTOR_VERSION (0x100) + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +// +// VERSION_2 indicates support of the following: +// +// - Flags field of KSDEVICE_DESCRIPTOR +// - Loading a VERSION_2 descriptor on earlier versions of AVStream +// will work; however, all flags will be considered to be zero. +// - Using an earlier version descriptor on later versions of +// AVStream causes no flags to be specificed. +// +#define KSDEVICE_DESCRIPTOR_VERSION_2 (0x110) + +#define MIN_DEV_VER_FOR_FLAGS (0x110) + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +struct _KSDEVICE_DESCRIPTOR { + const KSDEVICE_DISPATCH* Dispatch; + ULONG FilterDescriptorsCount; + _Field_size_(FilterDescriptorsCount) const KSFILTER_DESCRIPTOR*const* FilterDescriptors; + ULONG Version; // this is 0 for pre-version 100 driver + +#if (NTDDI_VERSION >= NTDDI_VISTA) + + ULONG Flags; +#define KSDEVICE_FLAG_ENABLE_REMOTE_WAKEUP 0x00000001 +#define KSDEVICE_FLAG_LOWPOWER_PASSTHROUGH 0x00000002 + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define KSDEVICE_FLAG_ENABLE_QUERYINTERFACE 0x00000004 +#endif + +#if !defined(_WIN64) + PVOID Alignment; +#endif //!defined(_WIN64) + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +}; + +struct _KSFILTER_DESCRIPTOR { + const KSFILTER_DISPATCH* Dispatch; + const KSAUTOMATION_TABLE* AutomationTable; + ULONG Version; +#define KSFILTER_DESCRIPTOR_VERSION ((ULONG)-1) + ULONG Flags; +#define KSFILTER_FLAG_DISPATCH_LEVEL_PROCESSING 0x00000001 +#define KSFILTER_FLAG_CRITICAL_PROCESSING 0x00000002 +#define KSFILTER_FLAG_HYPERCRITICAL_PROCESSING 0x00000004 +#define KSFILTER_FLAG_RECEIVE_ZERO_LENGTH_SAMPLES 0x00000008 +#if (NTDDI_VERSION >= NTDDI_WINXPSP2) +#define KSFILTER_FLAG_DENY_USERMODE_ACCESS 0x80000000 +#endif // (NTDDI_VERSION >= NTDDI_WINXPSP2) +// This flag is added to prioritize the ReferenceGUID when creating +// filter factory over the reference string. All devices that publish +// camera profiles must set this flag. +#define KSFILTER_FLAG_PRIORITIZE_REFERENCEGUID 0x00000010 + const GUID* ReferenceGuid; + ULONG PinDescriptorsCount; + ULONG PinDescriptorSize; + _Field_size_bytes_(PinDescriptorsCount * PinDescriptorSize) const KSPIN_DESCRIPTOR_EX* PinDescriptors; + ULONG CategoriesCount; + _Field_size_(CategoriesCount) + const GUID* Categories; + ULONG NodeDescriptorsCount; + ULONG NodeDescriptorSize; + _Field_size_bytes_(NodeDescriptorsCount * NodeDescriptorSize) const KSNODE_DESCRIPTOR* NodeDescriptors; + ULONG ConnectionsCount; + _Field_size_(ConnectionsCount) const KSTOPOLOGY_CONNECTION* Connections; + const KSCOMPONENTID* ComponentId; +}; + +#define DEFINE_KSFILTER_DESCRIPTOR(descriptor)\ + const KSFILTER_DESCRIPTOR descriptor = + +#define DEFINE_KSFILTER_PIN_DESCRIPTORS(table)\ + SIZEOF_ARRAY(table),\ + sizeof(table[0]),\ + table + +#define DEFINE_KSFILTER_CATEGORIES(table)\ + SIZEOF_ARRAY(table),\ + table + +#define DEFINE_KSFILTER_CATEGORY(category)\ + 1,\ + &(category) + +#define DEFINE_KSFILTER_CATEGORIES_NULL\ + 0,\ + NULL + +#define DEFINE_KSFILTER_NODE_DESCRIPTORS(table)\ + SIZEOF_ARRAY(table),\ + sizeof(table[0]),\ + table + +#define DEFINE_KSFILTER_NODE_DESCRIPTORS_NULL\ + 0,\ + sizeof(KSNODE_DESCRIPTOR),\ + NULL + +#define DEFINE_KSFILTER_CONNECTIONS(table)\ + SIZEOF_ARRAY(table),\ + table + +#define DEFINE_KSFILTER_DEFAULT_CONNECTIONS\ + 0,\ + NULL + +#define DEFINE_KSFILTER_DESCRIPTOR_TABLE(table)\ + const KSFILTER_DESCRIPTOR*const table[] = + +struct _KSPIN_DESCRIPTOR_EX { + const KSPIN_DISPATCH* Dispatch; + const KSAUTOMATION_TABLE* AutomationTable; + KSPIN_DESCRIPTOR PinDescriptor; + ULONG Flags; +#define KSPIN_FLAG_DISPATCH_LEVEL_PROCESSING KSFILTER_FLAG_DISPATCH_LEVEL_PROCESSING +#define KSPIN_FLAG_CRITICAL_PROCESSING KSFILTER_FLAG_CRITICAL_PROCESSING +#define KSPIN_FLAG_HYPERCRITICAL_PROCESSING KSFILTER_FLAG_HYPERCRITICAL_PROCESSING +#define KSPIN_FLAG_ASYNCHRONOUS_PROCESSING 0x00000008 +#define KSPIN_FLAG_DO_NOT_INITIATE_PROCESSING 0x00000010 +#define KSPIN_FLAG_INITIATE_PROCESSING_ON_EVERY_ARRIVAL 0x00000020 +#define KSPIN_FLAG_FRAMES_NOT_REQUIRED_FOR_PROCESSING 0x00000040 +#define KSPIN_FLAG_ENFORCE_FIFO 0x00000080 + +#define KSPIN_FLAG_GENERATE_MAPPINGS 0x00000100 +#define KSPIN_FLAG_DISTINCT_TRAILING_EDGE 0x00000200 + +#define KSPIN_FLAG_PROCESS_IN_RUN_STATE_ONLY 0x00010000 +#define KSPIN_FLAG_SPLITTER 0x00020000 +#define KSPIN_FLAG_USE_STANDARD_TRANSPORT 0x00040000 +#define KSPIN_FLAG_DO_NOT_USE_STANDARD_TRANSPORT 0x00080000 +#define KSPIN_FLAG_FIXED_FORMAT 0x00100000 +#define KSPIN_FLAG_GENERATE_EOS_EVENTS 0x00200000 +#define KSPIN_FLAG_RENDERER (KSPIN_FLAG_PROCESS_IN_RUN_STATE_ONLY|KSPIN_FLAG_GENERATE_EOS_EVENTS) +#define KSPIN_FLAG_IMPLEMENT_CLOCK 0x00400000 +#define KSPIN_FLAG_SOME_FRAMES_REQUIRED_FOR_PROCESSING 0x00800000 +#define KSPIN_FLAG_PROCESS_IF_ANY_IN_RUN_STATE 0x01000000 +#if (NTDDI_VERSION >= NTDDI_WINXPSP2) +#define KSPIN_FLAG_DENY_USERMODE_ACCESS 0x80000000 +#endif // (NTDDI_VERSION >= NTDDI_WINXPSP2) + ULONG InstancesPossible; + ULONG InstancesNecessary; + const KSALLOCATOR_FRAMING_EX* AllocatorFraming; + PFNKSINTERSECTHANDLEREX IntersectHandler; +}; + +#define DEFINE_KSPIN_DEFAULT_INTERFACES\ + 0,\ + NULL + +#define DEFINE_KSPIN_DEFAULT_MEDIUMS\ + 0,\ + NULL + +struct _KSNODE_DESCRIPTOR { + const KSAUTOMATION_TABLE* AutomationTable; + const GUID* Type; + const GUID* Name; +#if !defined(_WIN64) + PVOID Alignment; +#endif // !defined(_WIN64) +}; + +#if !defined(_WIN64) +#define DEFINE_NODE_DESCRIPTOR(automation,type,name) \ + { (automation), (type), (name), NULL } +#else // !defined(_WIN64) +#define DEFINE_NODE_DESCRIPTOR(automation,type,name) \ + { (automation), (type), (name) } +#endif // !defined(_WIN64) + +struct _KSDEVICE { + const KSDEVICE_DESCRIPTOR* Descriptor; + KSOBJECT_BAG Bag; + PVOID Context; + PDEVICE_OBJECT FunctionalDeviceObject; + PDEVICE_OBJECT PhysicalDeviceObject; + PDEVICE_OBJECT NextDeviceObject; + BOOLEAN Started; + SYSTEM_POWER_STATE SystemPowerState; + DEVICE_POWER_STATE DevicePowerState; +}; + +struct _KSFILTERFACTORY { + const KSFILTER_DESCRIPTOR* FilterDescriptor; + KSOBJECT_BAG Bag; + PVOID Context; +}; + +struct _KSFILTER { + const KSFILTER_DESCRIPTOR* Descriptor; + KSOBJECT_BAG Bag; + PVOID Context; +}; + +struct _KSPIN { + const KSPIN_DESCRIPTOR_EX* Descriptor; + KSOBJECT_BAG Bag; + PVOID Context; + ULONG Id; + KSPIN_COMMUNICATION Communication; + BOOLEAN ConnectionIsExternal; + KSPIN_INTERFACE ConnectionInterface; + KSPIN_MEDIUM ConnectionMedium; + KSPRIORITY ConnectionPriority; + PKSDATAFORMAT ConnectionFormat; + PKSMULTIPLE_ITEM AttributeList; + ULONG StreamHeaderSize; + KSPIN_DATAFLOW DataFlow; + KSSTATE DeviceState; + KSRESET ResetState; + KSSTATE ClientState; +}; + +struct _KSMAPPING { + PHYSICAL_ADDRESS PhysicalAddress; + ULONG ByteCount; + ULONG Alignment; +}; + +struct _KSSTREAM_POINTER_OFFSET +{ +#if defined(_NTDDK_) + union { + PUCHAR Data; + PKSMAPPING Mappings; + }; +#else // !defined(_NTDDK_) + PUCHAR Data; +#endif // !defined(_NTDDK_) +#if !defined(_WIN64) + PVOID Alignment; +#endif // !defined(_WIN64) + ULONG Count; + ULONG Remaining; +}; + +struct _KSSTREAM_POINTER +{ + PVOID Context; + PKSPIN Pin; + PKSSTREAM_HEADER StreamHeader; + PKSSTREAM_POINTER_OFFSET Offset; + KSSTREAM_POINTER_OFFSET OffsetIn; + KSSTREAM_POINTER_OFFSET OffsetOut; +}; + +struct _KSPROCESSPIN { + PKSPIN Pin; + PKSSTREAM_POINTER StreamPointer; + PKSPROCESSPIN InPlaceCounterpart; + PKSPROCESSPIN DelegateBranch; + PKSPROCESSPIN CopySource; + _Field_size_bytes_(BytesAvailable) PVOID Data; + ULONG BytesAvailable; + ULONG BytesUsed; + ULONG Flags; + BOOLEAN Terminate; +}; + +struct _KSPROCESSPIN_INDEXENTRY { + _Field_size_(Count) PKSPROCESSPIN *Pins; + ULONG Count; +}; + +typedef enum { + KsObjectTypeDevice, + KsObjectTypeFilterFactory, + KsObjectTypeFilter, + KsObjectTypePin +} KSOBJECTTYPE; + +typedef +void +(*PFNKSFREE)( + _In_ PVOID Data + ); + +typedef +void +(*PFNKSPINFRAMERETURN)( + _In_ PKSPIN Pin, + _In_reads_bytes_opt_(Size) PVOID Data, + _In_ ULONG Size OPTIONAL, + _In_opt_ PMDL Mdl, + _In_opt_ PVOID Context, + _In_ NTSTATUS Status + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +typedef +void +(*PFNKSPINIRPCOMPLETION)( + _In_ PKSPIN Pin, + _In_ PIRP Irp + ); + +#if defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) +#if !defined(_IKsControl_) +#define _IKsControl_ + +typedef interface IKsControl* PIKSCONTROL; + +#if !defined(DEFINE_ABSTRACT_UNKNOWN) + +#define DEFINE_ABSTRACT_UNKNOWN() \ + STDMETHOD_(NTSTATUS, QueryInterface)(THIS_ \ + _In_ REFIID InterfaceId, \ + _COM_Outptr_ PVOID* Interface \ + ) PURE; \ + STDMETHOD_(ULONG,AddRef)(THIS) PURE; \ + STDMETHOD_(ULONG,Release)(THIS) PURE; + +#endif //!defined(DEFINE_ABSTRACT_UNKNOWN) + +#undef INTERFACE +#define INTERFACE IKsControl +DECLARE_INTERFACE_(IKsControl,IUnknown) +{ + DEFINE_ABSTRACT_UNKNOWN() // For C + + STDMETHOD_(NTSTATUS, KsProperty)(THIS_ + _In_reads_bytes_(PropertyLength) PKSPROPERTY Property, + _In_ ULONG PropertyLength, + _Inout_updates_bytes_(DataLength) PVOID PropertyData, + _In_ ULONG DataLength, + _Out_ ULONG* BytesReturned + ) PURE; + STDMETHOD_(NTSTATUS, KsMethod)(THIS_ + _In_reads_bytes_(MethodLength) PKSMETHOD Method, + _In_ ULONG MethodLength, + _Inout_updates_bytes_(DataLength) PVOID MethodData, + _In_ ULONG DataLength, + _Out_ ULONG* BytesReturned + ) PURE; + STDMETHOD_(NTSTATUS, KsEvent)(THIS_ + _In_reads_bytes_opt_(EventLength) PKSEVENT Event, + _In_ ULONG EventLength, + _Inout_updates_bytes_(DataLength) PVOID EventData, + _In_ ULONG DataLength, + _Out_ ULONG* BytesReturned + ) PURE; +}; + +typedef interface IKsReferenceClock* PIKSREFERENCECLOCK; + +#undef INTERFACE +#define INTERFACE IKsReferenceClock +DECLARE_INTERFACE_(IKsReferenceClock,IUnknown) +{ + DEFINE_ABSTRACT_UNKNOWN() // For C + + STDMETHOD_(LONGLONG,GetTime)(THIS + ) PURE; + STDMETHOD_(LONGLONG,GetPhysicalTime)(THIS + ) PURE; + STDMETHOD_(LONGLONG,GetCorrelatedTime)(THIS_ + _Out_ PLONGLONG SystemTime + ) PURE; + STDMETHOD_(LONGLONG,GetCorrelatedPhysicalTime)(THIS_ + _Out_ PLONGLONG SystemTime + ) PURE; + STDMETHOD_(NTSTATUS, GetResolution)(THIS_ + _Out_ PKSRESOLUTION Resolution + ) PURE; + STDMETHOD_(NTSTATUS, GetState)(THIS_ + _Out_ PKSSTATE State + ) PURE; +}; +#undef INTERFACE + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define INTERFACE IKsDeviceFunctions +DECLARE_INTERFACE_(IKsDeviceFunctions, IUnknown) +{ + DEFINE_ABSTRACT_UNKNOWN() // For C + + STDMETHOD_(NTSTATUS, RegisterAdapterObjectEx)(THIS_ + _In_ PADAPTER_OBJECT AdapterObject, + _In_ PDEVICE_DESCRIPTION DeviceDescription, + _In_ ULONG NumberOfMapRegisters, + _In_ ULONG MaxMappingsByteCount, + _In_ ULONG MappingTableStride + ) PURE; +}; + +#undef INTERFACE + +#endif // (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define STATIC_IID_IKsControl \ +0x28F54685L, 0x06FD, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUID(IID_IKsControl, +0x28F54685L, 0x06FD, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96); +#if defined(__cplusplus) && _MSC_VER >= 1100 +struct __declspec(uuid("28F54685-06FD-11D2-B27A-00A0C9223196")) IKsControl; +#endif + +#define STATIC_IID_IKsFastClock \ +0xc9902485, 0xc180, 0x11d2, 0x84, 0x73, 0xd4, 0x23, 0x94, 0x45, 0x9e, 0x5e +DEFINE_GUID(IID_IKsFastClock, +0xc9902485, 0xc180, 0x11d2, 0x84, 0x73, 0xd4, 0x23, 0x94, 0x45, 0x9e, 0x5e); +#if defined(__cplusplus) && _MSC_VER >= 1100 +struct __declspec(uuid("C9902485-C180-11d2-8473-D42394459E5E")) IKsFastClock; +#endif + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define STATIC_IID_IKsDeviceFunctions \ +0xe234f2e2, 0xbd69, 0x4f8c, 0xb3, 0xf2, 0x7c, 0xd7, 0x9e, 0xd4, 0x66, 0xbd +DEFINE_GUID(IID_IKsDeviceFunctions, +0xe234f2e2, 0xbd69, 0x4f8c, 0xb3, 0xf2, 0x7c, 0xd7, 0x9e, 0xd4, 0x66, 0xbd); +#if defined(__cplusplus) && _MSC_VER >= 1100 +struct __declspec(uuid("E234F2E2-BD69-4F8C-B3F2-7CD79ED466BD")) IKsDeviceFunctions; +#endif + +#endif // (NTDDI_VERSION >= NTDDI_WS03SP1) + +#endif // !defined(_IKsControl_) +#endif // defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) + +#endif // defined(_NTDDK_) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +//=========================================================================== + +#if defined(__cplusplus) +extern "C" { +#endif // defined(__cplusplus) + +// +// exported prototypes +// + +#ifdef _KSDDK_ +#define KSDDKAPI +#else // !_KSDDK_ +#define KSDDKAPI DECLSPEC_IMPORT +#endif // _KSDDK_ + +#if defined(_NTDDK_) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsEnableEvent( + _In_ PIRP Irp, + _In_ ULONG EventSetsCount, + _In_reads_(EventSetsCount) const KSEVENT_SET* EventSet, + _Inout_opt_ PLIST_ENTRY EventsList, + _In_opt_ KSEVENTS_LOCKTYPE EventsFlags, + _In_opt_ PVOID EventsLock + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsEnableEventWithAllocator( + _In_ PIRP Irp, + _In_ ULONG EventSetsCount, + _In_reads_(EventSetsCount) const KSEVENT_SET* EventSet, + _Inout_opt_ PLIST_ENTRY EventsList, + _In_ KSEVENTS_LOCKTYPE EventsFlags OPTIONAL, + _In_opt_ PVOID EventsLock, + _In_opt_ PFNKSALLOCATOR Allocator, + _In_opt_ ULONG EventItemSize + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDisableEvent( + _In_ PIRP Irp, + _Inout_ PLIST_ENTRY EventsList, + _In_ KSEVENTS_LOCKTYPE EventsFlags, + _In_ PVOID EventsLock + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsDiscardEvent( + _In_ PKSEVENT_ENTRY EventEntry + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsFreeEventList( + _In_ PFILE_OBJECT FileObject, + _Inout_ PLIST_ENTRY EventsList, + _In_ KSEVENTS_LOCKTYPE EventsFlags, + _In_ PVOID EventsLock + ); + +KSDDKAPI +NTSTATUS +NTAPI +KsGenerateEvent( + _In_ PKSEVENT_ENTRY EventEntry + ); + +KSDDKAPI +NTSTATUS +NTAPI +KsGenerateDataEvent( + _In_ PKSEVENT_ENTRY EventEntry, + _In_ ULONG DataSize, + _In_reads_bytes_(DataSize) PVOID Data + ); + +KSDDKAPI +VOID +NTAPI +KsGenerateEventList( + _In_opt_ GUID* Set, + _In_ ULONG EventId, + _In_ PLIST_ENTRY EventsList, + _In_ KSEVENTS_LOCKTYPE EventsFlags, + _In_ PVOID EventsLock + ); + + + + +KSDDKAPI +NTSTATUS +NTAPI +KsGenerateThermalEvent( + _In_ PVOID Object, + _In_ KSDEVICE_THERMAL_STATE Value +); + +// +//Independent KS Thermal notifications.. +// + + + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(* PFNKSDEVICETHERMALACTIVECOOLING)( +_In_ PKSDEVICE KsDevice, +_In_ BOOLEAN Engaged, +_Out_ KSDEVICE_THERMAL_STATE* DeviceThermalState +); + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +void +(*PFNKSDEVICETHERMALPASSIVECOOLING)( +_In_ PKSDEVICE KsDevice, +_In_ ULONG Percentage, +_Out_ KSDEVICE_THERMAL_STATE* DeviceThermalState +); + +typedef struct _KSDEVICE_THERMAL_DISPATCH { + PFNKSDEVICETHERMALACTIVECOOLING ActiveCooling; + PFNKSDEVICETHERMALPASSIVECOOLING PassiveCooling; +} KSDEVICE_THERMAL_DISPATCH, *PKSDEVICE_THERMAL_DISPATCH; + +KSDDKAPI +NTSTATUS +NTAPI +KsDeviceRegisterThermalDispatch( + _In_ PKSDEVICE KsDevice, + _In_ PKSDEVICE_THERMAL_DISPATCH KsDeviceThermalDispatch +); + + + +// property.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPropertyHandler( + _In_ PIRP Irp, + _In_ ULONG PropertySetsCount, + _In_reads_(PropertySetsCount) const KSPROPERTY_SET* PropertySet + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPropertyHandlerWithAllocator( + _In_ PIRP Irp, + _In_ ULONG PropertySetsCount, + _In_reads_(PropertySetsCount) const KSPROPERTY_SET* PropertySet, + _In_opt_ PFNKSALLOCATOR Allocator, + _In_ ULONG PropertyItemSize OPTIONAL + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +BOOLEAN +NTAPI +KsFastPropertyHandler( + _In_ PFILE_OBJECT FileObject, + _In_reads_bytes_(PropertyLength) PKSPROPERTY Property, + _In_ ULONG PropertyLength, + _In_reads_bytes_(DataLength)PVOID Data, + _In_ ULONG DataLength, + _Out_ PIO_STATUS_BLOCK IoStatus, + _In_ ULONG PropertySetsCount, + _In_reads_(PropertySetsCount) const KSPROPERTY_SET* PropertySet + ); + +// method.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsMethodHandler( + _In_ PIRP Irp, + _In_ ULONG MethodSetsCount, + _In_reads_(MethodSetsCount) const KSMETHOD_SET* MethodSet + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsMethodHandlerWithAllocator( + _In_ PIRP Irp, + _In_ ULONG MethodSetsCount, + _In_reads_(MethodSetsCount) const KSMETHOD_SET* MethodSet, + _In_opt_ PFNKSALLOCATOR Allocator, + _In_ ULONG MethodItemSize OPTIONAL + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +BOOLEAN +NTAPI +KsFastMethodHandler( + _In_ PFILE_OBJECT FileObject, + _In_reads_bytes_(MethodLength) PKSMETHOD Method, + _In_ ULONG MethodLength, + _Inout_updates_bytes_(DataLength) PVOID Data, + _In_ ULONG DataLength, + _Out_ PIO_STATUS_BLOCK IoStatus, + _In_ ULONG MethodSetsCount, + _In_reads_(MethodSetsCount) const KSMETHOD_SET* MethodSet + ); + +// alloc.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateDefaultAllocator( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateDefaultAllocatorEx( + _In_ PIRP Irp, + _In_opt_ PVOID InitializeContext, + _In_opt_ PFNKSDEFAULTALLOCATE DefaultAllocate, + _In_opt_ PFNKSDEFAULTFREE DefaultFree, + _In_opt_ PFNKSINITIALIZEALLOCATOR InitializeAllocator, + _In_opt_ PFNKSDELETEALLOCATOR DeleteAllocator + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateAllocator( + _In_ HANDLE ConnectionHandle, + _In_ PKSALLOCATOR_FRAMING AllocatorFraming, + _Out_ PHANDLE AllocatorHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsValidateAllocatorCreateRequest( + _In_ PIRP Irp, + _Out_ PKSALLOCATOR_FRAMING* AllocatorFraming + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsValidateAllocatorFramingEx( + _In_ PKSALLOCATOR_FRAMING_EX Framing, + _In_ ULONG BufferSize, + _In_ const KSALLOCATOR_FRAMING_EX *PinFraming + ); + +// clock.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateDefaultClock( + _Out_ PKSDEFAULTCLOCK* DefaultClock + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateDefaultClockEx( + _Out_ PKSDEFAULTCLOCK* DefaultClock, + _In_opt_ PVOID Context, + _In_opt_ PFNKSSETTIMER SetTimer, + _In_opt_ PFNKSCANCELTIMER CancelTimer, + _In_opt_ PFNKSCORRELATEDTIME CorrelatedTime, + _In_opt_ const KSRESOLUTION* Resolution, + _In_ ULONG Flags + ); + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsFreeDefaultClock( + _In_ PKSDEFAULTCLOCK DefaultClock + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateDefaultClock( + _In_ PIRP Irp, + _In_ PKSDEFAULTCLOCK DefaultClock + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateClock( + _In_ HANDLE ConnectionHandle, + _In_ PKSCLOCK_CREATE ClockCreate, + _Out_ PHANDLE ClockHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsValidateClockCreateRequest( + _In_ PIRP Irp, + _Outptr_ PKSCLOCK_CREATE* ClockCreate + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +KSSTATE +NTAPI +KsGetDefaultClockState( + _In_ PKSDEFAULTCLOCK DefaultClock + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetDefaultClockState( + _In_ PKSDEFAULTCLOCK DefaultClock, + _In_ KSSTATE State + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +LONGLONG +NTAPI +KsGetDefaultClockTime( + _In_ PKSDEFAULTCLOCK DefaultClock + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetDefaultClockTime( + _In_ PKSDEFAULTCLOCK DefaultClock, + _In_ LONGLONG Time + ); + +// connect.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreatePin( + _In_ HANDLE FilterHandle, + _In_ PKSPIN_CONNECT Connect, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE ConnectionHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsValidateConnectRequest( + _In_ PIRP Irp, + _In_ ULONG DescriptorsCount, + _In_reads_(DescriptorsCount) const KSPIN_DESCRIPTOR* Descriptor, + _Out_ PKSPIN_CONNECT* Connect + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinPropertyHandler( + _In_ PIRP Irp, + _In_ PKSPROPERTY Property, + _Inout_ PVOID Data, + _In_ ULONG DescriptorsCount, + _In_reads_(DescriptorsCount) const KSPIN_DESCRIPTOR* Descriptor + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinDataIntersection( + _In_ PIRP Irp, + _In_ PKSP_PIN Pin, + _Out_opt_ PVOID Data, + _In_ ULONG DescriptorsCount, + _In_reads_(DescriptorsCount) const KSPIN_DESCRIPTOR* Descriptor, + _In_ PFNKSINTERSECTHANDLER IntersectHandler + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinDataIntersectionEx( + _In_ PIRP Irp, + _In_ PKSP_PIN Pin, + _Out_ PVOID Data, + _In_ ULONG DescriptorsCount, + _In_reads_bytes_(DescriptorsCount * DescriptorSize) const KSPIN_DESCRIPTOR* Descriptor, + _In_ ULONG DescriptorSize, + _In_opt_ PFNKSINTERSECTHANDLEREX IntersectHandler, + _In_opt_ PVOID HandlerContext + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsHandleSizedListQuery( + _In_ PIRP Irp, + _In_ ULONG DataItemsCount, + _In_ ULONG DataItemSize, + _In_reads_bytes_(DataItemsCount * DataItemSize) const VOID* DataItems + ); + +// image.c: + +#if (!defined( MAKEINTRESOURCE )) +#define MAKEINTRESOURCE( res ) ((ULONG_PTR) (USHORT) res) +#endif + +#if (!defined( RT_STRING )) +#define RT_STRING MAKEINTRESOURCE( 6 ) +#define RT_RCDATA MAKEINTRESOURCE( 10 ) +#endif + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsLoadResource( + _In_ PVOID ImageBase, + _In_ POOL_TYPE PoolType, + _In_ ULONG_PTR ResourceName, + _In_ ULONG ResourceType, + _Outptr_result_bytebuffer_(*ResourceSize) PVOID *Resource, + _Out_opt_ PULONG ResourceSize + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsGetImageNameAndResourceId( + _In_ HANDLE RegKey, + _Out_ PUNICODE_STRING ImageName, + _Out_ PULONG_PTR ResourceId, + _Out_ PULONG ValueType +); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsMapModuleName( + _In_ PDEVICE_OBJECT PhysicalDeviceObject, + _In_ PUNICODE_STRING ModuleName, + _Out_ PUNICODE_STRING ImageName, + _Out_ PULONG_PTR ResourceId, + _Out_ PULONG ValueType + ); + +// irp.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsReferenceBusObject( + _In_ KSDEVICE_HEADER Header + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsDereferenceBusObject( + _In_ KSDEVICE_HEADER Header + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchQuerySecurity( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchSetSecurity( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchSpecificProperty( + _In_ PIRP Irp, + _In_ PFNKSHANDLER Handler + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchSpecificMethod( + _In_ PIRP Irp, + _In_ PFNKSHANDLER Handler + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsReadFile( + _In_ PFILE_OBJECT FileObject, + _In_opt_ PKEVENT Event, + _In_opt_ PVOID PortContext, + _Out_ PIO_STATUS_BLOCK IoStatusBlock, + _Out_writes_bytes_(Length) PVOID Buffer, + _In_ ULONG Length, + _In_ ULONG Key OPTIONAL, + _In_ KPROCESSOR_MODE RequestorMode + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsWriteFile( + _In_ PFILE_OBJECT FileObject, + _In_opt_ PKEVENT Event, + _In_opt_ PVOID PortContext, + _Out_ PIO_STATUS_BLOCK IoStatusBlock, + _In_reads_bytes_(Length) PVOID Buffer, + _In_ ULONG Length, + _In_ ULONG Key OPTIONAL, + _In_ KPROCESSOR_MODE RequestorMode + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsQueryInformationFile( + _In_ PFILE_OBJECT FileObject, + _Out_writes_bytes_(Length) PVOID FileInformation, + _In_ ULONG Length, + _In_ FILE_INFORMATION_CLASS FileInformationClass + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsSetInformationFile( + _In_ PFILE_OBJECT FileObject, + _In_reads_bytes_(Length) PVOID FileInformation, + _In_ ULONG Length, + _In_ FILE_INFORMATION_CLASS FileInformationClass + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamIo( + _In_ PFILE_OBJECT FileObject, + _In_opt_ PKEVENT Event, + _In_opt_ PVOID PortContext, + _In_opt_ PIO_COMPLETION_ROUTINE CompletionRoutine, + _In_opt_ PVOID CompletionContext, + _In_ KSCOMPLETION_INVOCATION CompletionInvocationFlags OPTIONAL, + _Out_ PIO_STATUS_BLOCK IoStatusBlock, + _Inout_updates_bytes_(Length) PVOID StreamHeaders, + _In_ ULONG Length, + _In_ ULONG Flags, + _In_ KPROCESSOR_MODE RequestorMode + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsProbeStreamIrp( + _Inout_ PIRP Irp, + _In_ ULONG ProbeFlags, + _In_ ULONG HeaderSize OPTIONAL + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateExtraData( + _Inout_ PIRP Irp, + _In_ ULONG ExtraSize, + _Out_ PVOID* ExtraBuffer + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsNullDriverUnload( + _In_ PDRIVER_OBJECT DriverObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsSetMajorFunctionHandler( + _In_ PDRIVER_OBJECT DriverObject, + _In_ ULONG MajorFunction + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchInvalidDeviceRequest( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDefaultDeviceIoCompletion( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDispatchIrp( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +BOOLEAN +NTAPI +KsDispatchFastIoDeviceControlFailure( + _In_ PFILE_OBJECT FileObject, + _In_ BOOLEAN Wait, + _In_reads_bytes_opt_(InputBufferLength) PVOID InputBuffer, + _In_ ULONG InputBufferLength, + _Out_writes_bytes_opt_(OutputBufferLength) PVOID OutputBuffer, + _In_ ULONG OutputBufferLength, + _In_ ULONG IoControlCode, + _Out_ PIO_STATUS_BLOCK IoStatus, + _In_ PDEVICE_OBJECT DeviceObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +BOOLEAN +NTAPI +KsDispatchFastReadFailure( + _In_ PFILE_OBJECT FileObject, + _In_ PLARGE_INTEGER FileOffset, + _In_ ULONG Length, + _In_ BOOLEAN Wait, + _In_ ULONG LockKey, + _Out_ PVOID Buffer, + _Out_ PIO_STATUS_BLOCK IoStatus, + _In_ PDEVICE_OBJECT DeviceObject + ); + +#define KsDispatchFastWriteFailure KsDispatchFastReadFailure + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +DRIVER_CANCEL KsCancelRoutine; + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsCancelIo( + _Inout_ PLIST_ENTRY QueueHead, + _In_ PKSPIN_LOCK SpinLock + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsReleaseIrpOnCancelableQueue( + _In_ PIRP Irp, + _In_opt_ PDRIVER_CANCEL DriverCancel + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PIRP +NTAPI +KsRemoveIrpFromCancelableQueue( + _Inout_ PLIST_ENTRY QueueHead, + _In_ PKSPIN_LOCK SpinLock, + _In_ KSLIST_ENTRY_LOCATION ListLocation, + _In_ KSIRP_REMOVAL_OPERATION RemovalOperation + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsMoveIrpsOnCancelableQueue( + _Inout_ PLIST_ENTRY SourceList, + _In_ PKSPIN_LOCK SourceLock, + _Inout_ PLIST_ENTRY DestinationList, + _In_opt_ PKSPIN_LOCK DestinationLock, + _In_ KSLIST_ENTRY_LOCATION ListLocation, + _In_ PFNKSIRPLISTCALLBACK ListCallback, + _In_ PVOID Context + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsRemoveSpecificIrpFromCancelableQueue( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsAddIrpToCancelableQueue( + _Inout_ PLIST_ENTRY QueueHead, + _In_ PKSPIN_LOCK SpinLock, + _In_ PIRP Irp, + _In_ KSLIST_ENTRY_LOCATION ListLocation, + _In_opt_ PDRIVER_CANCEL DriverCancel + ); + +// api.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAcquireResetValue( + _In_ PIRP Irp, + _Out_ KSRESET* ResetValue + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsTopologyPropertyHandler( + _In_ PIRP Irp, + _In_ PKSPROPERTY Property, + _Inout_ PVOID Data, + _In_ const KSTOPOLOGY* Topology + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +VOID +NTAPI +KsAcquireDeviceSecurityLock( + _In_ KSDEVICE_HEADER Header, + _In_ BOOLEAN Exclusive + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +VOID +NTAPI +KsReleaseDeviceSecurityLock( + _In_ KSDEVICE_HEADER Header + ); + +KSDDKAPI +_Dispatch_type_(IRP_MJ_PNP) DRIVER_DISPATCH KsDefaultDispatchPnp; + +KSDDKAPI +_Dispatch_type_(IRP_MJ_POWER) DRIVER_DISPATCH KsDefaultDispatchPower; + +KSDDKAPI +_Dispatch_type_(IRP_MJ_SYSTEM_CONTROL) +_Dispatch_type_(IRP_MJ_DEVICE_CONTROL) +DRIVER_DISPATCH KsDefaultForwardIrp; + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetDevicePnpAndBaseObject( + _In_ KSDEVICE_HEADER Header, + _In_ PDEVICE_OBJECT PnpDeviceObject, + _In_ PDEVICE_OBJECT BaseObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PDEVICE_OBJECT +NTAPI +KsQueryDevicePnpObject( + _In_ KSDEVICE_HEADER Header + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +ACCESS_MASK +NTAPI +KsQueryObjectAccessMask( + _In_ KSOBJECT_HEADER Header + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsRecalculateStackDepth( + _In_ KSDEVICE_HEADER Header, + _In_ BOOLEAN ReuseStackLocation + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetTargetState( + _In_ KSOBJECT_HEADER Header, + _In_ KSTARGET_STATE TargetState + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetTargetDeviceObject( + _In_ KSOBJECT_HEADER Header, + _In_opt_ PDEVICE_OBJECT TargetDevice + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsSetPowerDispatch( + _In_ KSOBJECT_HEADER Header, + _In_opt_ PFNKSCONTEXT_DISPATCH PowerDispatch, + _In_opt_ PVOID PowerContext + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSOBJECT_CREATE_ITEM +NTAPI +KsQueryObjectCreateItem( + _In_ KSOBJECT_HEADER Header + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateDeviceHeader( + _Out_ KSDEVICE_HEADER* Header, + _In_ ULONG ItemsCount, + _In_reads_opt_(ItemsCount) PKSOBJECT_CREATE_ITEM ItemsList + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +VOID +NTAPI +KsFreeDeviceHeader( + _In_ KSDEVICE_HEADER Header + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateObjectHeader( + _Out_ KSOBJECT_HEADER* Header, + _In_ ULONG ItemsCount, + _In_reads_opt_(ItemsCount) PKSOBJECT_CREATE_ITEM ItemsList, + _In_ PIRP Irp, + _In_ const KSDISPATCH_TABLE* Table + ); + +_IRQL_requires_max_(APC_LEVEL) +KSDDKAPI +VOID +NTAPI +KsFreeObjectHeader( + _In_ KSOBJECT_HEADER Header + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAddObjectCreateItemToDeviceHeader( + _In_ KSDEVICE_HEADER Header, + _In_ PDRIVER_DISPATCH Create, + _In_ PVOID Context, + _In_ PWSTR ObjectClass, + _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAddObjectCreateItemToObjectHeader( + _In_ KSOBJECT_HEADER Header, + _In_ PDRIVER_DISPATCH Create, + _In_ PVOID Context, + _In_ PWSTR ObjectClass, + _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateObjectCreateItem( + _In_ KSDEVICE_HEADER Header, + _In_ PKSOBJECT_CREATE_ITEM CreateItem, + _In_ BOOLEAN AllocateEntry, + _In_opt_ PFNKSITEMFREECALLBACK ItemFreeCallback + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFreeObjectCreateItem( + _In_ KSDEVICE_HEADER Header, + _In_ PUNICODE_STRING CreateItem + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFreeObjectCreateItemsByContext( + _In_ KSDEVICE_HEADER Header, + _In_ PVOID Context + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateDefaultSecurity( + _In_opt_ PSECURITY_DESCRIPTOR ParentSecurity, + _Out_ PSECURITY_DESCRIPTOR* DefaultSecurity + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsForwardIrp( + _In_ PIRP Irp, + _In_ PFILE_OBJECT FileObject, + _In_ BOOLEAN ReuseStackLocation + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsForwardAndCatchIrp( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp, + _In_ PFILE_OBJECT FileObject, + _In_ KSSTACK_USE StackUse + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsSynchronousIoControlDevice( + _In_ PFILE_OBJECT FileObject, + _In_ KPROCESSOR_MODE RequestorMode, + _In_ ULONG IoControl, + _In_reads_bytes_(InSize) PVOID InBuffer, + _In_ ULONG InSize, + _Out_writes_bytes_to_(OutSize, *BytesReturned) PVOID OutBuffer, + _In_ ULONG OutSize, + _Out_ PULONG BytesReturned + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsUnserializeObjectPropertiesFromRegistry( + _In_ PFILE_OBJECT FileObject, + _In_opt_ HANDLE ParentKey, + _In_opt_ PUNICODE_STRING RegistryPath + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCacheMedium( + _In_ PUNICODE_STRING SymbolicLink, + _In_ PKSPIN_MEDIUM Medium, + _In_ ULONG PinDirection + ); + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// thread.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsRegisterWorker( + _In_ WORK_QUEUE_TYPE WorkQueueType, + _Out_ PKSWORKER* Worker + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsRegisterCountedWorker( + _In_ WORK_QUEUE_TYPE WorkQueueType, + _Inout_ PWORK_QUEUE_ITEM CountedWorkItem, + _Out_ PKSWORKER* Worker + ); +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +VOID +NTAPI +KsUnregisterWorker( + _Inout_ PKSWORKER Worker + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsQueueWorkItem( + _Inout_ PKSWORKER Worker, + _Inout_ PWORK_QUEUE_ITEM WorkItem + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsIncrementCountedWorker( + _Inout_ PKSWORKER Worker + ); +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsDecrementCountedWorker( + _Inout_ PKSWORKER Worker + ); + +// topology.c: + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateTopologyNode( + _In_ HANDLE ParentHandle, + _In_ PKSNODE_CREATE NodeCreate, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE NodeHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsValidateTopologyNodeCreateRequest( + _In_ PIRP Irp, + _In_ PKSTOPOLOGY Topology, + _Out_ PKSNODE_CREATE* NodeCreate + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsMergeAutomationTables( + _Out_ PKSAUTOMATION_TABLE* AutomationTableAB, + _In_opt_ PKSAUTOMATION_TABLE AutomationTableA, + _In_opt_ PKSAUTOMATION_TABLE AutomationTableB, + _In_opt_ KSOBJECT_BAG Bag + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsInitializeDriver( + _In_ PDRIVER_OBJECT DriverObject, + _In_ PUNICODE_STRING RegistryPathName, + _In_opt_ const KSDEVICE_DESCRIPTOR* Descriptor + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAddDevice( + _In_ PDRIVER_OBJECT DriverObject, + _In_ PDEVICE_OBJECT PhysicalDeviceObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateDevice( + _In_ PDRIVER_OBJECT DriverObject, + _In_ PDEVICE_OBJECT PhysicalDeviceObject, + _In_opt_ const KSDEVICE_DESCRIPTOR* Descriptor, + _In_ ULONG ExtensionSize, + _Out_opt_ PKSDEVICE* Device + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsInitializeDevice( + _In_ PDEVICE_OBJECT FunctionalDeviceObject, + _In_ PDEVICE_OBJECT PhysicalDeviceObject, + _In_ PDEVICE_OBJECT NextDeviceObject, + _In_opt_ const KSDEVICE_DESCRIPTOR* Descriptor + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsTerminateDevice( + _In_ PDEVICE_OBJECT DeviceObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSDEVICE +NTAPI +KsGetDeviceForDeviceObject( + _In_ PDEVICE_OBJECT FunctionalDeviceObject + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsAcquireDevice( + _In_ PKSDEVICE Device + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsReleaseDevice( + _In_ PKSDEVICE Device + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsDeviceRegisterAdapterObject( + _In_ PKSDEVICE Device, + _In_ PADAPTER_OBJECT AdapterObject, + _In_ ULONG MaxMappingsByteCount, + _In_ ULONG MappingTableStride + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsDeviceGetBusData( + _In_ PKSDEVICE Device, + _In_ ULONG DataType, + _In_reads_bytes_(Length) PVOID Buffer, + _In_ ULONG Offset, + _In_ ULONG Length + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsDeviceSetBusData( + _In_ PKSDEVICE Device, + _In_ ULONG DataType, + _In_reads_bytes_(Length) PVOID Buffer, + _In_ ULONG Offset, + _In_ ULONG Length + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCreateFilterFactory( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ const KSFILTER_DESCRIPTOR *Descriptor, + _In_opt_ PWSTR RefString, + _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor, + _In_ ULONG CreateItemFlags, + _In_opt_ PFNKSFILTERFACTORYPOWER SleepCallback, + _In_opt_ PFNKSFILTERFACTORYPOWER WakeCallback, + _Out_opt_ PKSFILTERFACTORY *FilterFactory + ); + +#define KsDeleteFilterFactory(FilterFactory) \ + KsFreeObjectCreateItemsByContext(\ + *(KSDEVICE_HEADER *)(\ + KsFilterFactoryGetParentDevice(FilterFactory)->FunctionalDeviceObject->\ + DeviceExtension),\ + FilterFactory) + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterFactoryUpdateCacheData( + _In_ PKSFILTERFACTORY FilterFactory, + _In_opt_ const KSFILTER_DESCRIPTOR *FilterDescriptor + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterFactoryAddCreateItem( + _In_ PKSFILTERFACTORY FilterFactory, + _In_ PWSTR RefString, + _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor, + _In_ ULONG CreateItemFlags + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterFactorySetDeviceClassesState( + _In_ PKSFILTERFACTORY FilterFactory, + _In_ BOOLEAN NewState + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PUNICODE_STRING +NTAPI +KsFilterFactoryGetSymbolicLink( + _In_ PKSFILTERFACTORY FilterFactory + ); + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +// Forward decl. +typedef struct _KSDEVICE_PROFILE_INFO +KSDEVICE_PROFILE_INFO, *PKSDEVICE_PROFILE_INFO; + +__drv_maxIRQL(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsInitializeDeviceProfile( + _In_ PKSFILTERFACTORY FilterFactory + ); + +__drv_maxIRQL(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPublishDeviceProfile( + _In_ PKSFILTERFACTORY FilterFactory, + _In_ PKSDEVICE_PROFILE_INFO Profile + ); + +__drv_maxIRQL(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPersistDeviceProfile( + _In_ PKSFILTERFACTORY FilterFactory + ); + +#endif // NTDDI_WINTHRESHOLD + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsAddEvent( + _In_ PVOID Object, + _In_ PKSEVENT_ENTRY EventEntry + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +void _inline +KsFilterAddEvent( + _In_ PKSFILTER Filter, + _In_ PKSEVENT_ENTRY EventEntry + ) +{ + KsAddEvent(Filter,EventEntry); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +void _inline +KsPinAddEvent( + _In_ PKSPIN Pin, + _In_ PKSEVENT_ENTRY EventEntry + ) +{ + KsAddEvent(Pin,EventEntry); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsDefaultAddEventHandler( + _In_ PIRP Irp, + _In_ PKSEVENTDATA EventData, + _Inout_ PKSEVENT_ENTRY EventEntry + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsGenerateEvents( + _In_ PVOID Object, + _In_opt_ const GUID* EventSet, + _In_ ULONG EventId, + _In_ ULONG DataSize, + _In_reads_bytes_opt_(DataSize) PVOID Data, + _In_opt_ PFNKSGENERATEEVENTCALLBACK CallBack, + _In_opt_ PVOID CallBackContext + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +void _inline +KsFilterGenerateEvents( + _In_ PKSFILTER Filter, + _In_opt_ const GUID* EventSet, + _In_ ULONG EventId, + _In_ ULONG DataSize, + _In_reads_bytes_(DataSize) PVOID Data, + _In_opt_ PFNKSGENERATEEVENTCALLBACK CallBack, + _In_opt_ PVOID CallBackContext + ) +{ + KsGenerateEvents( + Filter, + EventSet, + EventId, + DataSize, + Data, + CallBack, + CallBackContext); +} + +_IRQL_requires_max_(DISPATCH_LEVEL) +void _inline +KsPinGenerateEvents( + _In_ PKSPIN Pin, + _In_opt_ const GUID* EventSet, + _In_ ULONG EventId, + _In_ ULONG DataSize, + _In_reads_bytes_opt_(DataSize) PVOID Data, + _In_opt_ PFNKSGENERATEEVENTCALLBACK CallBack, + _In_opt_ PVOID CallBackContext + ) +{ + KsGenerateEvents( + Pin, + EventSet, + EventId, + DataSize, + Data, + CallBack, + CallBackContext); +} + +typedef enum { + KSSTREAM_POINTER_STATE_UNLOCKED = 0, + KSSTREAM_POINTER_STATE_LOCKED +} KSSTREAM_POINTER_STATE; + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinGetAvailableByteCount( + _In_ PKSPIN Pin, + _Out_opt_ PLONG InputDataBytes, + _Out_opt_ PLONG OutputBufferBytes + ); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSSTREAM_POINTER +NTAPI +KsPinGetLeadingEdgeStreamPointer( + _In_ PKSPIN Pin, + _In_ KSSTREAM_POINTER_STATE State + ); + + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSSTREAM_POINTER +NTAPI +KsPinGetTrailingEdgeStreamPointer( + _In_ PKSPIN Pin, + _In_ KSSTREAM_POINTER_STATE State + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamPointerSetStatusCode( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_ NTSTATUS Status + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamPointerLock( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsStreamPointerUnlock( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_ BOOLEAN Eject + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsStreamPointerAdvanceOffsetsAndUnlock( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_ ULONG InUsed, + _In_ ULONG OutUsed, + _In_ BOOLEAN Eject + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsStreamPointerDelete( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamPointerClone( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_opt_ PFNKSSTREAMPOINTER CancelCallback, + _In_ ULONG ContextSize, + _Out_ PKSSTREAM_POINTER* CloneStreamPointer + ); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamPointerAdvanceOffsets( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_ ULONG InUsed, + _In_ ULONG OutUsed, + _In_ BOOLEAN Eject + ); + +_Must_inspect_result_ +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsStreamPointerAdvance( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PMDL +NTAPI +KsStreamPointerGetMdl( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PIRP +NTAPI +KsStreamPointerGetIrp( + _In_ PKSSTREAM_POINTER StreamPointer, + _Out_opt_ PBOOLEAN FirstFrameInIrp, + _Out_opt_ PBOOLEAN LastFrameInIrp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsStreamPointerScheduleTimeout( + _In_ PKSSTREAM_POINTER StreamPointer, + _In_ PFNKSSTREAMPOINTER Callback, + _In_ ULONGLONG Interval + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsStreamPointerCancelTimeout( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSSTREAM_POINTER +NTAPI +KsPinGetFirstCloneStreamPointer( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSSTREAM_POINTER +NTAPI +KsStreamPointerGetNextClone( + _In_ PKSSTREAM_POINTER StreamPointer + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinHandshake( + _In_ PKSPIN Pin, + _In_ PKSHANDSHAKE In, + _Out_ PKSHANDSHAKE Out + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsCompletePendingRequest( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +KSOBJECTTYPE +NTAPI +KsGetObjectTypeFromIrp( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PVOID +NTAPI +KsGetObjectFromFileObject( + _In_ PFILE_OBJECT FileObject + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +KSOBJECTTYPE +NTAPI +KsGetObjectTypeFromFileObject( + _In_ PFILE_OBJECT FileObject + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +PKSFILTER __inline +KsGetFilterFromFileObject( + _In_ PFILE_OBJECT FileObject + ) +{ + return (PKSFILTER) KsGetObjectFromFileObject(FileObject); +} + +_IRQL_requires_max_(DISPATCH_LEVEL) +PKSPIN __inline +KsGetPinFromFileObject( + _In_ PFILE_OBJECT FileObject + ) +{ + return (PKSPIN) KsGetObjectFromFileObject(FileObject); +} + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSGATE +NTAPI +KsFilterGetAndGate( + _In_ PKSFILTER Filter + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsFilterAcquireProcessingMutex( + _In_ PKSFILTER Filter + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsFilterReleaseProcessingMutex( + _In_ PKSFILTER Filter + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsFilterAttemptProcessing( + _In_ PKSFILTER Filter, + _In_ BOOLEAN Asynchronous + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSGATE +NTAPI +KsPinGetAndGate( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinAttachAndGate( + _In_ PKSPIN Pin, + _In_opt_ PKSGATE AndGate + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinAttachOrGate( + _In_ PKSPIN Pin, + _In_opt_ PKSGATE OrGate + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinAcquireProcessingMutex( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinReleaseProcessingMutex( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +BOOLEAN +NTAPI +KsProcessPinUpdate( + _In_ PKSPROCESSPIN ProcessPin + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsPinGetCopyRelationships( + _In_ PKSPIN Pin, + _Out_ PKSPIN* CopySource, + _Out_ PKSPIN* DelegateBranch + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +void +NTAPI +KsPinAttemptProcessing( + _In_ PKSPIN Pin, + _In_ BOOLEAN Asynchronous + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PVOID +NTAPI +KsGetParent( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSDEVICE __inline +KsFilterFactoryGetParentDevice( + _In_ PKSFILTERFACTORY FilterFactory + ) +{ + return (PKSDEVICE) KsGetParent((PVOID) FilterFactory); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSFILTERFACTORY __inline +KsFilterGetParentFilterFactory( + _In_ PKSFILTER Filter + ) +{ + return (PKSFILTERFACTORY) KsGetParent((PVOID) Filter); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSFILTER +NTAPI +KsPinGetParentFilter( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PVOID +NTAPI +KsGetFirstChild( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSFILTERFACTORY __inline +KsDeviceGetFirstChildFilterFactory( + _In_ PKSDEVICE Device + ) +{ + return (PKSFILTERFACTORY) KsGetFirstChild((PVOID) Device); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSFILTER __inline +KsFilterFactoryGetFirstChildFilter( + _In_ PKSFILTERFACTORY FilterFactory + ) +{ + return (PKSFILTER) KsGetFirstChild((PVOID) FilterFactory); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsFilterGetChildPinCount( + _In_ PKSFILTER Filter, + _In_ ULONG PinId + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSPIN +NTAPI +KsFilterGetFirstChildPin( + _In_ PKSFILTER Filter, + _In_ ULONG PinId + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PVOID +NTAPI +KsGetNextSibling( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSPIN +NTAPI +KsPinGetNextSiblingPin( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSFILTERFACTORY __inline +KsFilterFactoryGetNextSiblingFilterFactory( + _In_ PKSFILTERFACTORY FilterFactory + ) +{ + return (PKSFILTERFACTORY) KsGetNextSibling((PVOID) FilterFactory); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSFILTER __inline +KsFilterGetNextSiblingFilter( + _In_ PKSFILTER Filter + ) +{ + return (PKSFILTER) KsGetNextSibling((PVOID) Filter); +} + + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PKSDEVICE +NTAPI +KsGetDevice( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSDEVICE __inline +KsFilterFactoryGetDevice( + _In_ PKSFILTERFACTORY FilterFactory + ) +{ + return KsGetDevice((PVOID) FilterFactory); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSDEVICE __inline +KsFilterGetDevice( + _In_ PKSFILTER Filter + ) +{ + return KsGetDevice((PVOID) Filter); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PKSDEVICE __inline +KsPinGetDevice( + _In_ PKSPIN Pin + ) +{ + return KsGetDevice((PVOID) Pin); +} + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSFILTER +NTAPI +KsGetFilterFromIrp( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +PKSPIN +NTAPI +KsGetPinFromIrp( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsGetNodeIdFromIrp( + _In_ PIRP Irp + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsAcquireControl( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsReleaseControl( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +void __inline +KsFilterAcquireControl( + _In_ PKSFILTER Filter + ) +{ + KsAcquireControl((PVOID) Filter); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +void __inline +KsFilterReleaseControl( + _In_ PKSFILTER Filter + ) +{ + KsReleaseControl((PVOID) Filter); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +void __inline +KsPinAcquireControl( + _In_ PKSPIN Pin + ) +{ + KsAcquireControl((PVOID) Pin); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +void __inline +KsPinReleaseControl( + _In_ PKSPIN Pin + ) +{ + KsReleaseControl((PVOID) Pin); +} + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAddItemToObjectBag( + _In_ KSOBJECT_BAG ObjectBag, + _In_ __drv_aliasesMem PVOID Item, + _In_opt_ PFNKSFREE Free + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +ULONG +NTAPI +KsRemoveItemFromObjectBag( + _In_ KSOBJECT_BAG ObjectBag, + _In_ PVOID Item, + _In_ BOOLEAN Free + ); + +#define KsDiscard(Object,Pointer)\ + KsRemoveItemFromObjectBag(\ + (Object)->Bag,\ + (PVOID)(Pointer),\ + TRUE) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsAllocateObjectBag( + _In_ PKSDEVICE Device, + _Out_ KSOBJECT_BAG* ObjectBag + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsFreeObjectBag( + _In_ KSOBJECT_BAG ObjectBag + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsCopyObjectBagItems( + _In_ KSOBJECT_BAG ObjectBagDestination, + _In_ KSOBJECT_BAG ObjectBagSource + ); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +_KsEdit( + _In_ KSOBJECT_BAG ObjectBag, + _At_(*PointerToPointerToItem, _Pre_maybenull_ _Pre_readable_byte_size_(OldSize)) _Outptr_result_bytebuffer_(NewSize) PVOID* PointerToPointerToItem, + _In_ ULONG NewSize, + _In_ ULONG OldSize, + _In_ ULONG Tag + ); + +#define KsEdit(Object,PointerToPointer,Tag)\ + _KsEdit(\ + (Object)->Bag,\ + (PVOID*)(PointerToPointer),\ + sizeof(**(PointerToPointer)),\ + sizeof(**(PointerToPointer)),\ + (Tag)) +#define KsEditSized(Object,PointerToPointer,NewSize,OldSize,Tag)\ + _KsEdit((Object)->Bag,(PVOID*)(PointerToPointer),(NewSize),(OldSize),(Tag)) + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsRegisterFilterWithNoKSPins( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ const GUID * InterfaceClassGUID, + _In_ ULONG PinCount, + _In_reads_(PinCount) BOOL * PinDirection, + _In_reads_(PinCount) KSPIN_MEDIUM * MediumList, + _In_reads_opt_(PinCount) GUID * CategoryList +); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterCreatePinFactory ( + _In_ PKSFILTER Filter, + _In_ const KSPIN_DESCRIPTOR_EX *const PinDescriptor, + _Out_ PULONG PinID + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterCreateNode ( + _In_ PKSFILTER Filter, + _In_ const KSNODE_DESCRIPTOR *const NodeDescriptor, + _Out_ PULONG NodeID + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsFilterAddTopologyConnections ( + _In_ PKSFILTER Filter, + _In_ ULONG NewConnectionsCount, + _In_reads_(NewConnectionsCount) const KSTOPOLOGY_CONNECTION *const NewTopologyConnections + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinGetConnectedPinInterface( + _In_ PKSPIN Pin, + _In_ const GUID* InterfaceId, + _Out_ PVOID* Interface + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PFILE_OBJECT +NTAPI +KsPinGetConnectedPinFileObject( + _In_ PKSPIN Pin + ); + +KSDDKAPI +PDEVICE_OBJECT +NTAPI +KsPinGetConnectedPinDeviceObject( + _In_ PKSPIN Pin + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinGetConnectedFilterInterface( + _In_ PKSPIN Pin, + _In_ const GUID* InterfaceId, + _Out_ PVOID* Interface + ); + +#if defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinGetReferenceClockInterface( + _In_ PKSPIN Pin, + _Out_ PIKSREFERENCECLOCK* Interface + ); + +#endif //defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +VOID +NTAPI +KsPinSetPinClockTime( + _In_ PKSPIN Pin, + _In_ LONGLONG Time + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinSubmitFrame( + _In_ PKSPIN Pin, + _In_reads_bytes_opt_(Size) PVOID Data, + _In_ ULONG Size OPTIONAL, + _In_opt_ PKSSTREAM_HEADER StreamHeader, + _In_opt_ PVOID Context + ); + +_IRQL_requires_max_(DISPATCH_LEVEL) +KSDDKAPI +NTSTATUS +NTAPI +KsPinSubmitFrameMdl( + _In_ PKSPIN Pin, + _In_opt_ PMDL Mdl, + _In_opt_ PKSSTREAM_HEADER StreamHeader, + _In_opt_ PVOID Context + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinRegisterFrameReturnCallback( + _In_ PKSPIN Pin, + _In_ PFNKSPINFRAMERETURN FrameReturn + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinRegisterIrpCompletionCallback( + _In_ PKSPIN Pin, + _In_ PFNKSPINIRPCOMPLETION IrpCompletion + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinRegisterHandshakeCallback( + _In_ PKSPIN Pin, + _In_ PFNKSPINHANDSHAKE Handshake + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsFilterRegisterPowerCallbacks( + _In_ PKSFILTER Filter, + _In_opt_ PFNKSFILTERPOWER Sleep, + _In_opt_ PFNKSFILTERPOWER Wake + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +void +NTAPI +KsPinRegisterPowerCallbacks( + _In_ PKSPIN Pin, + _In_opt_ PFNKSPINPOWER Sleep, + _In_opt_ PFNKSPINPOWER Wake + ); + +#if defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PUNKNOWN +NTAPI +KsRegisterAggregatedClientUnknown( + _In_ PVOID Object, + _In_ PUNKNOWN ClientUnknown + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +PUNKNOWN +NTAPI +KsGetOuterUnknown( + _In_ PVOID Object + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsDeviceRegisterAggregatedClientUnknown( + _In_ PKSDEVICE Device, + _In_ PUNKNOWN ClientUnknown + ) +{ + return KsRegisterAggregatedClientUnknown((PVOID) Device,ClientUnknown); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsDeviceGetOuterUnknown( + _In_ PKSDEVICE Device + ) +{ + return KsGetOuterUnknown((PVOID) Device); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsFilterFactoryRegisterAggregatedClientUnknown( + _In_ PKSFILTERFACTORY FilterFactory, + _In_ PUNKNOWN ClientUnknown + ) +{ + return KsRegisterAggregatedClientUnknown((PVOID) FilterFactory,ClientUnknown); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsFilterFactoryGetOuterUnknown( + _In_ PKSFILTERFACTORY FilterFactory + ) +{ + return KsGetOuterUnknown((PVOID) FilterFactory); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsFilterRegisterAggregatedClientUnknown( + _In_ PKSFILTER Filter, + _In_ PUNKNOWN ClientUnknown + ) +{ + return KsRegisterAggregatedClientUnknown((PVOID) Filter,ClientUnknown); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsFilterGetOuterUnknown( + _In_ PKSFILTER Filter + ) +{ + return KsGetOuterUnknown((PVOID) Filter); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsPinRegisterAggregatedClientUnknown( + _In_ PKSPIN Pin, + _In_ PUNKNOWN ClientUnknown + ) +{ + return KsRegisterAggregatedClientUnknown((PVOID) Pin,ClientUnknown); +} + +_IRQL_requires_max_(PASSIVE_LEVEL) +PUNKNOWN __inline +KsPinGetOuterUnknown( + _In_ PKSPIN Pin + ) +{ + return KsGetOuterUnknown((PVOID) Pin); +} + +#endif // defined(_UNKNOWN_H_) || defined(__IUnknown_INTERFACE_DEFINED__) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#else // !defined(_NTDDK_) + +#if !defined( KS_NO_CREATE_FUNCTIONS ) + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +DWORD +WINAPI +KsCreateAllocator( + _In_ HANDLE ConnectionHandle, + _In_ PKSALLOCATOR_FRAMING AllocatorFraming, + _Out_ PHANDLE AllocatorHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +DWORD +NTAPI +KsCreateClock( + _In_ HANDLE ConnectionHandle, + _In_ PKSCLOCK_CREATE ClockCreate, + _Out_ PHANDLE ClockHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +DWORD +WINAPI +KsCreatePin( + _In_ HANDLE FilterHandle, + _In_ PKSPIN_CONNECT Connect, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE ConnectionHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +DWORD +WINAPI +KsCreateTopologyNode( + _In_ HANDLE ParentHandle, + _In_ PKSNODE_CREATE NodeCreate, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE NodeHandle + ); + +// +// KS create function that needs to be called after initializing COM +// +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +HRESULT +WINAPI +KsCreateAllocator2( + _In_ HANDLE ConnectionHandle, + _In_ PKSALLOCATOR_FRAMING AllocatorFraming, + _Out_ PHANDLE AllocatorHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +HRESULT +NTAPI +KsCreateClock2( + _In_ HANDLE ConnectionHandle, + _In_ PKSCLOCK_CREATE ClockCreate, + _Out_ PHANDLE ClockHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +HRESULT +WINAPI +KsCreatePin2( + _In_ HANDLE FilterHandle, + _In_ PKSPIN_CONNECT Connect, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE ConnectionHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +HRESULT +WINAPI +KsCreateTopologyNode2( + _In_ HANDLE ParentHandle, + _In_ PKSNODE_CREATE NodeCreate, + _In_ ACCESS_MASK DesiredAccess, + _Out_ PHANDLE NodeHandle + ); + +#endif + +#endif // !defined(_NTDDK_) + +#if defined(__cplusplus) +} +#endif // defined(__cplusplus) + +// +//Start of MDL caching related decisions +// + + +#if defined(__cplusplus) +extern "C" { +#endif // defined(__cplusplus) + + // + //MDL sharing related definitions + // + typedef union _MF_MDL_SHARED_PAYLOAD_KEY{ + struct { + ULONG pHandle; /* The Handle which represents the user mode Pin Handle */ + ULONG fHandle; + ULONG64 uPayload; /* The PayLoad from Sample, which is the Buffer attached */ + }combined; + GUID GMDLHandle; + }MF_MDL_SHARED_PAYLOAD_KEY, *PMF_MDL_SHARED_PAYLOAD_KEY; + // + //We need the handle and upayload to be ULONG64 + //to adjust for 64 bit systems and 32 bit systems + // +#define MF_SET_SHARED_MDLHANDLE(a,b,c,d){\ + d.combined.phandle = (ULONG32)a;\ + d.combined.fhandle = (ULONG32)b;\ + d.combined.upayload = (ULONG64)c;\ +} + + + + + +#if defined(_NTDDK_) + + _IRQL_requires_max_(DISPATCH_LEVEL) + typedef + VOID + (*PFNKSCANCELPINNEDMDL)( + _In_ GUID, + _In_ PVOID, + _In_ PVOID + ); + + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +WINAPI +KsAcquireCachedMdl( +_In_ PIRP Irp, +_In_ REFGUID Guid, +_In_ PFNKSCANCELPINNEDMDL CancelRoutine, +_In_ PVOID CancelContext, +_Outptr_result_maybenull_ PMDL *MdlAddr, +_Outptr_result_maybenull_ PVOID* ReleaseContext +); + +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +KSDDKAPI +NTSTATUS +WINAPI +KsReleaseCachedMdl( +_In_ REFGUID Guid, +_In_ PMDL MdlAddr, +_In_ HANDLE ReleaseContext +); + +#endif + +#if defined(__cplusplus) +} +#endif // defined(__cplusplus) + +// +//End of MDL sharing related definitions +// + + +#define DENY_USERMODE_ACCESS( pIrp, CompleteRequest ) \ +if ( pIrp->RequestorMode != KernelMode ) { \ + pIrp->IoStatus.Information = 0; \ + pIrp->IoStatus.Status = STATUS_INVALID_DEVICE_REQUEST; \ + if ( CompleteRequest ) IoCompleteRequest ( pIrp, IO_NO_INCREMENT ); \ + return STATUS_INVALID_DEVICE_REQUEST; \ +} + + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // !_KS_ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64.inc b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64.inc new file mode 100644 index 0000000000000000000000000000000000000000..1316f1d1823599cc220730bf6f074f4c33d5127a --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64.inc @@ -0,0 +1,2049 @@ + +include kxamd64.inc + +; +; Pointer size in bytes +; + +SizeofPointer equ 00008H + +; +; Process State Enumerated Type Values +; + +ProcessInMemory equ 00000H +ProcessOutOfMemory equ 00001H +ProcessInTransition equ 00002H + +; +; Thread State Enumerated Type Values +; + +Initialized equ 00000H +Ready equ 00001H +Running equ 00002H +Standby equ 00003H +Terminated equ 00004H +Waiting equ 00005H + +; +; Processor Mode Definitions +; + +KernelMode equ 00000H +UserMode equ 00001H + +; +; Wait Reason and Wait Type Enumerated Type Values +; + +WrExecutive equ 00000H +WrDispatchInt equ 0001FH +WaitAny equ 00001H +WaitAll equ 00000H + +; +; Apc State Structure Offset Definitions +; + +AsApcListHead equ 00000H +AsProcess equ 00020H +AsKernelApcPending equ 00029H +AsUserApcPendingAll equ 0002AH +KAPC_STATE_ANY_USER_APC_PENDING_MASK equ 00003H + + +; +; Apc Record Structure Offset Definitions +; + +ArNormalRoutine equ 00000H +ArNormalContext equ 00008H +ArSystemArgument1 equ 00010H +ArSystemArgument2 equ 00018H +ArFlags equ 00020H +KAPC_RECORD_LENGTH equ 00030H +KAPC_RECORD_FLAGS_CHECK_ALERT equ 00001H + + +; +; Apc Callback Data Structure Offset Definitions +; + +AcdContextRecord equ 00008H +KAPC_CALLBACK_DATA_LENGTH equ 00020H + +; +; Bug Check Code Definitions +; + +APC_INDEX_MISMATCH equ 00001H +KERNEL_APC_PENDING_DURING_EXIT equ 00020H +ATTEMPTED_SWITCH_FROM_DPC equ 000B8H +DATA_BUS_ERROR equ 0002EH +DATA_COHERENCY_EXCEPTION equ 00055H +HAL1_INITIALIZATION_FAILED equ 00061H +INSTRUCTION_BUS_ERROR equ 0002FH +INSTRUCTION_COHERENCY_EXCEPTION equ 00056H +INTERRUPT_EXCEPTION_NOT_HANDLED equ 0003DH +INTERRUPT_UNWIND_ATTEMPTED equ 0003CH +INVALID_AFFINITY_SET equ 00003H +INVALID_DATA_ACCESS_TRAP equ 00004H +IRQL_GT_ZERO_AT_SYSTEM_SERVICE equ 0004AH +IRQL_NOT_LESS_OR_EQUAL equ 0000AH +KMODE_EXCEPTION_NOT_HANDLED equ 0001EH +NMI_HARDWARE_FAILURE equ 00080H +NO_USER_MODE_CONTEXT equ 0000EH +PAGE_FAULT_WITH_INTERRUPTS_OFF equ 00049H +PANIC_STACK_SWITCH equ 0002BH +SPIN_LOCK_INIT_FAILURE equ 00081H +SYSTEM_EXIT_OWNED_MUTEX equ 00039H +SYSTEM_SERVICE_EXCEPTION equ 0003BH +SYSTEM_UNWIND_PREVIOUS_USER equ 0003AH +TRAP_CAUSE_UNKNOWN equ 00012H +UNEXPECTED_KERNEL_MODE_TRAP equ 0007FH +HARDWARE_INTERRUPT_STORM equ 000F2H +RECURSIVE_MACHINE_CHECK equ 000FBH +RECURSIVE_NMI equ 00111H +KERNEL_SECURITY_CHECK_FAILURE equ 00139H +UNSUPPORTED_INSTRUCTION_MODE equ 00151H +BUGCHECK_CONTEXT_MODIFIER equ 080000000H +INVALID_CALLBACK_STACK_ADDRESS equ 001CDH +INVALID_KERNEL_STACK_ADDRESS equ 001CEH +PREVIOUS_MODE_MISMATCH equ 001F9H + +; +; Breakpoint type definitions +; + +DBG_STATUS_CONTROL_C equ 00001H +STATUS_ASSERTION_FAILURE equ 0C0000420H + +; +; Client Id Structure Offset Definitions +; + +CidUniqueProcess equ 00000H +CidUniqueThread equ 00008H + +; +; Exception Record Offset, Flag, and Enumerated Type Definitions +; + +EXCEPTION_NONCONTINUABLE equ 00001H +EXCEPTION_UNWINDING equ 00002H +EXCEPTION_EXIT_UNWIND equ 00004H +EXCEPTION_STACK_INVALID equ 00008H +EXCEPTION_NESTED_CALL equ 00010H +EXCEPTION_TARGET_UNWIND equ 00020H +EXCEPTION_COLLIDED_UNWIND equ 00040H +EXCEPTION_UNWIND equ 00066H +EXCEPTION_EXECUTE_HANDLER equ 00001H +EXCEPTION_CONTINUE_SEARCH equ 00000H +EXCEPTION_CONTINUE_EXECUTION equ 0FFFFFFFFH + +ExceptionContinueExecution equ 00000H +ExceptionContinueSearch equ 00001H +ExceptionNestedException equ 00002H +ExceptionCollidedUnwind equ 00003H + +ErExceptionCode equ 00000H +ErExceptionFlags equ 00004H +ErExceptionRecord equ 00008H +ErExceptionAddress equ 00010H +ErNumberParameters equ 00018H +ErExceptionInformation equ 00020H +ExceptionRecordLength equ 000A0H + +; +; Fast Mutex Structure Offset Definitions +; + +FmCount equ 00000H +FmOwner equ 00008H +FmContention equ 00010H +FmOldIrql equ 00030H + +; +; Interrupt Priority Request Level Definitions +; + +PASSIVE_LEVEL equ 00000H +APC_LEVEL equ 00001H +DISPATCH_LEVEL equ 00002H +CLOCK_LEVEL equ 0000DH +IPI_LEVEL equ 0000EH +POWER_LEVEL equ 0000EH +PROFILE_LEVEL equ 0000FH +HIGH_LEVEL equ 0000FH +ifdef NT_UP +SYNCH_LEVEL equ 00002H +else +SYNCH_LEVEL equ 0000CH +endif + +; +; Large Integer Structure Offset Definitions +; + +LiLowPart equ 00000H +LiHighPart equ 00004H + +; +; List Entry Structure Offset Definitions +; + +LsFlink equ 00000H +LsBlink equ 00008H + +; +; String Structure Offset Definitions +; + +StrLength equ 00000H +StrMaximumLength equ 00002H +StrBuffer equ 00008H + +; +; System DLL Init Block Structure Offset Definitions +; + +IbCfgBitMap equ 000B8H +IbWow64CfgBitMap equ 000C8H +IbMitigationOptionsMap equ 000A0H +PS_MITIGATION_OPTION_BITS_PER_OPTION equ 00004H +PS_MITIGATION_OPTION_ALWAYS_ON equ 00001H +PS_MITIGATION_OPTION_ALWAYS_OFF equ 00002H +PS_MITIGATION_OPTION_MASK equ 00003H +PS_MITIGATION_OPTION_RETURN_FLOW_GUARD equ 00010H +PS_MITIGATION_OPTION_RESTRICT_SET_THREAD_CONTEXT equ 00013H +PS_MITIGATION_OPTION_CET_USER_SHADOW_STACKS equ 0001FH +PsneKiUserCallbackDispatcher equ 00030H + +; +; User Shared Data Structure Offset Definitions +; + +UsTickCountMultiplier equ 00004H +UsInterruptTime equ 00008H +UsSystemTime equ 00014H +UsTimeZoneBias equ 00020H +UsImageNumberLow equ 0002CH +UsImageNumberHigh equ 0002EH +UsNtSystemRoot equ 00030H +UsMaxStackTraceDepth equ 00238H +UsCryptoExponent equ 0023CH +UsTimeZoneId equ 00240H +UsLargePageMinimum equ 00244H +UsNtBuildNumber equ 00260H +UsNtProductType equ 00264H +UsProductTypeIsValid equ 00268H +UsNtMajorVersion equ 0026CH +UsNtMinorVersion equ 00270H +UsProcessorFeatures equ 00274H +UsReserved1 equ 002B4H +UsReserved3 equ 002B8H +UsTimeSlip equ 002BCH +UsAlternativeArchitecture equ 002C0H +UsSystemExpirationDate equ 002C8H +UsSuiteMask equ 002D0H +UsKdDebuggerEnabled equ 002D4H +UsActiveConsoleId equ 002D8H +UsDismountCount equ 002DCH +UsComPlusPackage equ 002E0H +UsLastSystemRITEventTickCount equ 002E4H +UsNumberOfPhysicalPages equ 002E8H +UsSafeBootMode equ 002ECH +UsTestRetInstruction equ 002F8H +UsSystemCallPad equ 00318H +UsTickCount equ 00320H +UsTickCountQuad equ 00320H +UsXState equ 003D8H + +; +; Time Structure Offset Definitions +; + +TmLowTime equ 00000H +TmHighTime equ 00004H + +; +; Thread Switch Counter Offset Definitions +; + +TwFindAny equ 00000H +TwFindIdeal equ 00004H +TwFindLast equ 00008H +TwIdleAny equ 0000CH +TwIdleCurrent equ 00010H +TwIdleIdeal equ 00014H +TwIdleLast equ 00018H +TwPreemptAny equ 0001CH +TwPreemptCurrent equ 00020H +TwPreemptLast equ 00024H +TwSwitchToIdle equ 00028H + +; +; Status Code Definitions +; + +STATUS_ACCESS_VIOLATION equ 0C0000005H +STATUS_ARRAY_BOUNDS_EXCEEDED equ 0C000008CH +STATUS_BAD_COMPRESSION_BUFFER equ 0C0000242H +STATUS_BREAKPOINT equ 080000003H +STATUS_CALLBACK_POP_STACK equ 0C0000423H +STATUS_DATATYPE_MISALIGNMENT equ 080000002H +STATUS_FLOAT_DENORMAL_OPERAND equ 0C000008DH +STATUS_FLOAT_DIVIDE_BY_ZERO equ 0C000008EH +STATUS_FLOAT_INEXACT_RESULT equ 0C000008FH +STATUS_FLOAT_INVALID_OPERATION equ 0C0000090H +STATUS_FLOAT_OVERFLOW equ 0C0000091H +STATUS_FLOAT_STACK_CHECK equ 0C0000092H +STATUS_FLOAT_UNDERFLOW equ 0C0000093H +STATUS_FLOAT_MULTIPLE_FAULTS equ 0C00002B4H +STATUS_FLOAT_MULTIPLE_TRAPS equ 0C00002B5H +STATUS_GUARD_PAGE_VIOLATION equ 080000001H +STATUS_ILLEGAL_FLOAT_CONTEXT equ 0C000014AH +STATUS_ILLEGAL_INSTRUCTION equ 0C000001DH +STATUS_INSTRUCTION_MISALIGNMENT equ 0C00000AAH +STATUS_INVALID_HANDLE equ 0C0000008H +STATUS_INVALID_LOCK_SEQUENCE equ 0C000001EH +STATUS_INVALID_OWNER equ 0C000005AH +STATUS_INVALID_PARAMETER equ 0C000000DH +STATUS_INVALID_PARAMETER_1 equ 0C00000EFH +STATUS_INVALID_SYSTEM_SERVICE equ 0C000001CH +STATUS_INVALID_THREAD equ 0C000071CH +STATUS_INTEGER_DIVIDE_BY_ZERO equ 0C0000094H +STATUS_INTEGER_OVERFLOW equ 0C0000095H +STATUS_IN_PAGE_ERROR equ 0C0000006H +STATUS_KERNEL_APC equ 00100H +STATUS_LONGJUMP equ 080000026H +STATUS_NO_CALLBACK_ACTIVE equ 0C0000258H +STATUS_PRIVILEGED_INSTRUCTION equ 0C0000096H +STATUS_SINGLE_STEP equ 080000004H +STATUS_STACK_BUFFER_OVERRUN equ 0C0000409H +STATUS_STACK_OVERFLOW equ 0C00000FDH +STATUS_SUCCESS equ 00000H +STATUS_THREAD_IS_TERMINATING equ 0C000004BH +STATUS_TIMEOUT equ 00102H +STATUS_UNWIND equ 0C0000027H +STATUS_UNWIND_CONSOLIDATE equ 080000029H +STATUS_USER_APC equ 000C0H +STATUS_WAKE_SYSTEM equ 040000294H +STATUS_WAKE_SYSTEM_DEBUGGER equ 080000007H +STATUS_SET_CONTEXT_DENIED equ 0C000060AH +STATUS_RETURN_ADDRESS_HIJACK_ATTEMPT equ 080000033H + +; +; Fast Fail Code Definitions +; + +FAST_FAIL_INVALID_BUFFER_ACCESS equ 0001CH +FAST_FAIL_INVALID_NEXT_THREAD equ 0001EH +FAST_FAIL_INVALID_CONTROL_STACK equ 0002FH +FAST_FAIL_SET_CONTEXT_DENIED equ 00030H +FAST_FAIL_ENCLAVE_CALL_FAILURE equ 00035H +FAST_FAIL_FLAGS_CORRUPTION equ 0003BH + +; +; Bounds Callback Status Code Definitions +; + +BoundExceptionContinueSearch equ 00000H +BoundExceptionHandled equ 00001H +BoundExceptionError equ 00002H + +; +; APC Object Structure Offset Definitions +; + +ApType equ 00000H +ApSize equ 00002H +ApThread equ 00008H +ApApcListEntry equ 00010H +ApKernelRoutine equ 00020H +ApRundownRoutine equ 00028H +ApNormalRoutine equ 00030H +ApNormalContext equ 00038H +ApSystemArgument1 equ 00040H +ApSystemArgument2 equ 00048H +ApApcStateIndex equ 00050H +ApApcMode equ 00051H +ApInserted equ 00052H +ApcObjectLength equ 00058H + +; +; DPC object Structure Offset Definitions +; + +DpType equ 00000H +DpNumber equ 00002H +DpImportance equ 00001H +DpDpcListEntry equ 00008H +DpDeferredRoutine equ 00018H +DpDeferredContext equ 00020H +DpSystemArgument1 equ 00028H +DpSystemArgument2 equ 00030H +DpDpcData equ 00038H +DpcObjectLength equ 00040H + +KI_DPC_ALL_FLAGS equ 000BFH +KI_DPC_ANY_DPC_ACTIVE equ 010001H + +; +; Device Queue Object Structure Offset Definitions +; + +DvType equ 00000H +DvSize equ 00002H +DvDeviceListHead equ 00008H +DvSpinLock equ 00018H +DvBusy equ 00020H +DeviceQueueObjectLength equ 00028H + +; +; Device Queue Entry Structure Offset Definitions +; + +DeDeviceListEntry equ 00000H +DeSortKey equ 00010H +DeInserted equ 00014H +DeviceQueueEntryLength equ 00018H + +; +; Event Object Structure Offset Definitions +; + +EvType equ 00000H +EvSize equ 00002H +EvSignalState equ 00004H +EvWaitListHead equ 00008H +EventObjectLength equ 00018H + +; +; Interrupt Object Structure Offset Definitions +; + +KINTERRUPT_STATE_DISABLED_BIT equ 00000H +KINTERRUPT_STATE_DISABLED equ 00001H +InLevelSensitive equ 00000H +InLatched equ 00001H + +InType equ 00000H +InSize equ 00002H +InInterruptListEntry equ 00008H +InServiceRoutine equ 00018H +InServiceContext equ 00030H +InSpinLock equ 00038H +InTickCount equ 00040H +InActualLock equ 00048H +InDispatchAddress equ 00050H +InVector equ 00058H +InIrql equ 0005CH +InSynchronizeIrql equ 0005DH +InFloatingSave equ 0005EH +InConnected equ 0005FH +InNumber equ 00060H +InShareVector equ 00064H +InInternalState equ 00068H +InMode equ 0006CH +InServiceCount equ 00074H +InDispatchCount equ 00078H +InTrapFrame equ 00088H +InterruptObjectLength equ 00120H + +; +; Process Object Structure Offset Definitions +; + +PrType equ 00000H +PrSize equ 00002H +PrSignalState equ 00004H +PrProfileListHead equ 00018H +PrDirectoryTableBase equ 00028H +PrThreadListHead equ 00030H +PrAffinity equ 00050H +PrReadyListHead equ 00068H +PrSwapListEntry equ 00078H +PrActiveProcessors equ 00080H +PrProcessFlags equ 00088H +PrBasePriority equ 00090H +PrQuantumReset equ 00091H +PrCycleTime equ 00120H +PrInstrumentationCallback equ 00168H +PrMitigationFlags2 equ 00754H +KernelProcessObjectLength equ 001C8H +ExecutiveProcessObjectLength equ 00840H +Win32BatchFlushCallout equ 00007H + +; +; Profile Object Structure Offset Definitions +; + +PfType equ 00000H +PfSize equ 00002H +PfProfileListEntry equ 00008H +PfProcess equ 00018H +PfRangeBase equ 00020H +PfRangeLimit equ 00028H +PfBucketShift equ 00030H +PfBuffer equ 00038H +PfSegment equ 00040H +PfAffinity equ 00048H +PfSource equ 00260H +PfStarted equ 00262H +ProfileObjectLength equ 00268H + +; +; Queue Object Structure Offset Definitions +; + +QuSignalState equ 00004H +QuEntryListHead equ 00018H +QuCurrentCount equ 00028H +QuMaximumCount equ 0002CH +QuThreadListHead equ 00030H +QueueObjectLength equ 00040H + +; +; Thread Object Structure Offset Definitions +; + +EtCid equ 00508H +EtPicoContext equ 00670H + +ThType equ 00000H +ThSize equ 00002H +ThLock equ 00000H +THREAD_FLAGS_CYCLE_PROFILING equ 00001H +THREAD_FLAGS_CYCLE_PROFILING_LOCK_BIT equ 00010H +THREAD_FLAGS_CYCLE_PROFILING_LOCK equ 010000H +THREAD_FLAGS_COUNTER_PROFILING equ 00002H +THREAD_FLAGS_COUNTER_PROFILING_LOCK_BIT equ 00011H +THREAD_FLAGS_COUNTER_PROFILING_LOCK equ 020000H +THREAD_FLAGS_GROUP_SCHEDULING equ 00004H +THREAD_FLAGS_AFFINITY_SET equ 00008H +THREAD_FLAGS_ACCOUNTING_CSWITCH equ 000B6H +THREAD_FLAGS_ACCOUNTING_INTERRUPT equ 00072H +THREAD_FLAGS_ACCOUNTING_ANY equ 000BEH +ThDebugActive equ 00003H +ThThreadControlFlags equ 00002H +ThSignalState equ 00004H +ThCycleTime equ 00048H +ThCurrentRunTime equ 00050H +ThStateSaveArea equ 00060H +ThInitialStack equ 00028H +ThStackLimit equ 00030H +ThKernelStack equ 00058H +ThThreadLock equ 00040H +ThApcState equ 00098H +ThProcess equ 00220H +ThNextProcessor equ 00218H +ThAdjustReason equ 00236H +ThAdjustIncrement equ 00237H +ThWaitReason equ 00283H +ThRunning equ 00071H +ThAlerted equ 00072H +ThWaitTime equ 001B4H +ThCombinedApcDisable equ 001E4H +ThKernelApcDisable equ 001E4H +ThSpecialApcDisable equ 001E6H +ThTeb equ 000F0H +ThTimer equ 00100H +thProcess equ 00220H + +KTHREAD_AUTO_ALIGNMENT_BIT equ 00002H +KTHREAD_GUI_THREAD_MASK equ 00080H +KTHREAD_RESTRICTED_GUI_THREAD_MASK equ 0200000H +KTHREAD_SYSTEM_THREAD_BIT equ 0000AH +KTHREAD_QUEUE_DEFER_PREEMPTION_BIT equ 0000BH +KTHREAD_CET_USER_SHADOW_STACK_BIT equ 00014H +KTHREAD_CET_KERNEL_SHADOW_STACK_BIT equ 00016H + +DEBUG_ACTIVE_ALT_SYSCALL_HANDLER equ 00024H +PsSystemCallMapToSystem equ 00001H + +ThMiscFlags equ 00074H +ThThreadFlags equ 00078H +ThPreviousMode equ 00232H +ThContextSwitches equ 00154H +ThState equ 00184H +ThWaitIrql equ 00186H +ThTrapFrame equ 00090H +ThFirstArgument equ 00088H +ThApcStateIndex equ 0024AH +ThSystemCallNumber equ 00080H +ThWin32Thread equ 001C8H +ThStackBase equ 00038H +ThLegoData equ 002D0H +KernelThreadObjectLength equ 004C0H +ExecutiveThreadObjectLength equ 00798H + + +; +; Timer object Structure Offset Definitions +; + +TiType equ 00000H +TiSize equ 00002H +TiSignalState equ 00004H +TiDueTime equ 00018H +TiTimerListEntry equ 00020H +TiDpc equ 00030H +TiPeriod equ 0003CH +TimerObjectLength equ 00040H + + +; +; Wait Block Structure Offset Definitions +; + +WbWaitListEntry equ 00000H +WbThread equ 00018H +WbObject equ 00020H +WbWaitKey equ 00012H +WbWaitType equ 00010H + +; +; Fiber Structure Offset Definitions +; + +FbFiberData equ 00000H +FbExceptionList equ 00008H +FbStackBase equ 00010H +FbStackLimit equ 00018H +FbDeallocationStack equ 00020H +FbFiberContext equ 00030H +FbWx86Tib equ 00500H +FbActivationContextStackPointer equ 00508H +FbFlsData equ 00510H +FbGuaranteedStackBytes equ 00518H +FbTebFlags equ 0051CH +FbSsp equ 00528H + +; +; Process Environment Block Structure Offset Definitions +; + +PeBeingDebugged equ 00002H +PeProcessParameters equ 00020H +PeKernelCallbackTable equ 00058H +ProcessEnvironmentBlockLength equ 007D0H + +; +; Process Parameters Block Structure Offset Definitions +; + +PpFlags equ 00008H +USER_CALLBACK_FILTER equ 080000H + +; +; System Service Descriptor Table Structure Definitions +; + +NUMBER_SERVICE_TABLES equ 00002H +SERVICE_NUMBER_MASK equ 00FFFH +SERVICE_TABLE_SHIFT equ 00007H +SERVICE_TABLE_MASK equ 00020H +SERVICE_TABLE_TEST equ 00020H + +ThBase equ 00000H +ThLimit equ 00008H +SdBase equ 00000H +SdLimit equ 00010H +SdNumber equ 00018H +SdLength equ 00020H + +; +; Thread Environment Block Structure Offset Definitions +; + +TeCmTeb equ 00000H +TeStackBase equ 00008H +TeStackLimit equ 00010H +TeFiberData equ 00020H +TeSelf equ 00030H +TeEnvironmentPointer equ 00038H +TeClientId equ 00040H +TeActiveRpcHandle equ 00050H +TeThreadLocalStoragePointer equ 00058H +TeCountOfOwnedCriticalSections equ 0006CH +TePeb equ 00060H +TeCsrClientThread equ 00070H +TeWOW32Reserved equ 00100H +TeSoftFpcr equ 0010CH +TeExceptionCode equ 002C0H +TeActivationContextStackPointer equ 002C8H +TeInstrumentationCallbackSp equ 002D0H +TeInstrumentationCallbackPreviousPc equ 002D8H +TeInstrumentationCallbackPreviousSp equ 002E0H +TeGdiClientPID equ 007F0H +TeGdiClientTID equ 007F4H +TeGdiThreadLocalInfo equ 007F8H +TeglDispatchTable equ 009F0H +TeglReserved1 equ 01138H +TeglReserved2 equ 01220H +TeglSectionInfo equ 01228H +TeglSection equ 01230H +TeglTable equ 01238H +TeglCurrentRC equ 01240H +TeglContext equ 01248H +TeDeallocationStack equ 01478H +TeTlsSlots equ 01480H +TeTlsExpansionSlots equ 01780H +TeLastErrorValue equ 00068H +TeVdm equ 01690H +TeInstrumentation equ 016B8H +TeGdiBatchCount equ 01740H +TeGuaranteedStackBytes equ 01748H +TeFlsData equ 017C8H +TeCurrentIdealProcessor equ 01744H +TePrimaryGroupAffinity equ 01860H +ThreadEnvironmentBlockLength equ 01878H +CmThreadEnvironmentBlockOffset equ 02000H +TLS_MINIMUM_AVAILABLE equ 00040H +TLS_EXPANSION_SLOTS equ 00400H + +; +; Lock Queue Structure Offset Definitions +; + +LOCK_QUEUE_WAIT equ 00001H +LOCK_QUEUE_OWNER equ 00002H +LOCK_QUEUE_HEADER_SIZE equ 00010H + + +LqNext equ 00000H +LqLock equ 00008H + +LqhLockQueue equ 00000H +LqhOldIrql equ 00010H +LqhNext equ 00000H +LqhLock equ 00008H + +; +; Kernel Stack Control Structure Offset (relative to initial stack pointer) Definitions +; + +KSTACK_CONTROL_LENGTH equ 00050H +KcPreviousBase equ 00010H +KcPreviousLimit equ 00018H +KcPreviousKernel equ 00020H +KcPreviousInitial equ 00028H +KcPreviousKernelShadowStack equ 00040H +KcPreviousKernelShadowStackInitial equ 00048H +KcPreviousKernelShadowStackBase equ 00030H +KcPreviousKernelShadowStackLimit equ 00038H +KcCurrentBase equ 00000H +KcActualLimit equ 00008H +KSTACK_ACTUAL_LIMIT_EXPANDED equ 00001H + + +; +; ETW Definitions +; + +PERF_CONTEXTSWAP_OFFSET equ 00004H +PERF_CONTEXTSWAP_FLAG equ 00004H +PERF_INTERRUPT equ 020004000H +PERF_INTERRUPT_OFFSET equ 00004H +PERF_INTERRUPT_FLAG equ 04000H +PERF_SYSCALL_OFFSET equ 00008H +PERF_SYSCALL_FLAG equ 00040H +PERF_SPEC_CONTROL_OFFSET equ 00014H +PERF_SPEC_CONTROL_FLAG equ 00002H +NTOS_YIELD_MACRO equ 00001H +EtwTSLength equ 00020H +CONTEXT_SWAP_TRACING equ 00001H +LAST_BRANCH_RECORD_IN_USE equ 00002H +PROCESSOR_TRACE_ON_EACH_CORE_ENABLED equ 00004H + +; +; Enlightenment structure definitions +; + +HeEnlightenments equ 00000H +HeHypervisorConnected equ 00004H +HeEndOfInterrupt equ 00008H +HeApicWriteIcr equ 00010H +HeSpinCountMask equ 0001CH +HeLongSpinWait equ 00020H + +; +; XState context structure offset definitions +; + +XctxMask equ 00000H +XctxLength equ 00008H +XctxArea equ 00010H + +; +; XState configuration structure offset definitions +; + +XcfgEnabledFeatures equ 00000H +XcfgEnabledVolatileFeatures equ 00008H +XcfgEnabledSupervisorFeatures equ 00218H +XSAVE_ALIGN equ 00040H + +; +; XSAVE_AREA structure offset definitions +; + +XsaHeader equ 00200H +XsaHeaderLength equ 00040H +XSTATE_MASK_LEGACY_FLOATING_POINT equ 00001H +XSTATE_MASK_LEGACY_SSE equ 00002H +XSTATE_MASK_LEGACY equ 00003H +XSTATE_MASK_GSSE equ 00004H +XSTATE_MASK_IPT equ 00100H +XSTATE_MASK_LARGE_FEATURES equ 040000H + +; +; KERNEL_CET_CONTEXT structure offset definitions +; + +KccSsp equ 00000H +KccRip equ 00008H +KccSegCs equ 00010H + +; +; Extended context structure offset definitions +; + +CxxAllOffset equ 00000H +CxxAllLength equ 00004H +CxxLegacyOffset equ 00008H +CxxLegacyLength equ 0000CH +CxxXStateOffset equ 00010H +CxxXStateLength equ 00014H +CxxKernelCetOffset equ 00018H +CxxKernelCetLength equ 0001CH + +; +; KAFFINITY_EX offsets +; + +AfCount equ 00000H +AfBitmap equ 00008H +CFlushSize equ 000E8H +PbEntropyCount equ 08FE0H +PbEntropyBuffer equ 08FE4H +KENTROPY_TIMING_INTERRUPTS_PER_BUFFER equ 00400H +KENTROPY_TIMING_BUFFER_MASK equ 007FFH +KENTROPY_TIMING_ANALYSIS equ 00000H + +; +; Priority state definitions +; + +KPRIORITY_STATE_PRIORITY_BITMASK equ 0007FH +PnGroup equ 00000H +PnNumber equ 00002H +GaGroup equ 00008H +GaMask equ 00000H +KgsProcessorNumberToIndexMappingTable equ 00008H + +; +; Register Argument Home Address Offset Definitions +; + +P1Home equ 00008H +P2Home equ 00010H +P3Home equ 00018H +P4Home equ 00020H + +; +; Special Register Structure Offset Definition +; + +SrKernelDr0 equ 00020H +SrKernelDr1 equ 00028H +SrKernelDr2 equ 00030H +SrKernelDr3 equ 00038H +SrKernelDr6 equ 00040H +SrKernelDr7 equ 00048H +SrGdtr equ 00050H +SrIdtr equ 00060H +SrTr equ 00070H +SrMxCsr equ 00074H +SrMsrGsBase equ 000A8H +SrMsrGsSwap equ 000B0H +SrMsrStar equ 000B8H +SrMsrLStar equ 000C0H +SrMsrCStar equ 000C8H +SrMsrSyscallMask equ 000D0H +SrXcr0 equ 000D8H +SrMsrFsBase equ 000E0H + +; +; Processor Control Region Structure Offset Definitions +; + +PcGdt equ 00000H +PcTss equ 00008H +PcUserRsp equ 00010H +PcUserRspShadow equ 0B010H +PcSelf equ 00018H +PcCurrentPrcb equ 00020H +PcLockArray equ 00028H +PcTeb equ 00030H +PcIdt equ 00038H +PcDbgMceNestingLevel equ 0B02CH +PcDbgMceFlags equ 0B030H +PcProcessorDescriptorArea equ 00038H +PcIrql equ 00050H +PcStallScaleFactor equ 00064H +PcHalReserved equ 000C0H +PcPrcb equ 00180H +PcMxCsr equ 00180H +PcInterruptRequest equ 00186H +PcIdleHalt equ 00187H +PcCurrentThread equ 00188H +PcNextThread equ 00190H +PcIdleThread equ 00198H +PcIpiFrozen equ 02F08H +PcNestingLevel equ 001A0H +PcNumber equ 001A4H +PcRspBase equ 001A8H +PcRspBaseShadow equ 0B008H +PcShadowFlags equ 0B018H +PcVerwSelector equ 0B02AH +PcIsrStackNesting equ 0A360H +PcPrcbLock equ 001B0H +PcCr0 equ 00280H +PcCr2 equ 00288H +PcCr3 equ 00290H +PcCr4 equ 00298H +PcKernelDr0 equ 002A0H +PcKernelDr1 equ 002A8H +PcKernelDr2 equ 002B0H +PcKernelDr3 equ 002B8H +PcKernelDr7 equ 002C8H +PcGdtrLimit equ 002D6H +PcGdtrBase equ 002D8H +PcIdtrLimit equ 002E6H +PcIdtrBase equ 002E8H +PcTr equ 002F0H +PcLdtr equ 002F2H +PcDebugControl equ 002F8H +PcLastBranchToRip equ 00300H +PcLastBranchFromRip equ 00308H +PcLastExceptionToRip equ 00310H +PcLastExceptionFromRip equ 00318H +PcCr8 equ 00320H +PcCpuType equ 001C0H +PcCpuID equ 001C1H +PcCpuStep equ 001C2H +PcCpuVendor equ 0020DH +PcVirtualApicAssist equ 08D88H +PcFeatureBits equ 09120H +PcNmiActive equ 08526H +PcMceActive equ 08527H +PcCombinedNmiMceActive equ 08526H +PcSfCode equ 09568H +PcSfVa equ 09570H +PcSfPa equ 09578H +PcKernelDirectoryTableBase equ 0B000H +PcExceptionStack equ 088E8H +PcExceptionStackActive equ 088E6H +PcDpcRequestSummary equ 03A3CH +PcTransitionShadowStack equ 09D20H +PcKernelShadowStackInitial equ 09D28H +; +; +CPU_AMD equ 00001H +CPU_INTEL equ 00002H +CPU_VIA equ 00003H +PcCFlushSize equ 00268H +PcDeepSleep equ 087DAH +PcDeferredReadyListHead equ 02E88H +PcSystemCalls equ 02EB8H +PcDpcRoutineActive equ 03A3AH +PcInterruptCount equ 087C0H +PcDebuggerSavedIRQL equ 087D8H +PcStartCycles equ 08800H +PcSelfIpiRequestSummary equ 00228H +PcMceRecoveryContext equ 08860H +RTL_KERNELSCP_STUBS_UNWIND_INFO_MAX_SIZE equ 001F4H +ProcessorControlRegisterLength equ 02D040H + +; +; Defines kernel process structure +; + +PrUserDirectoryTableBase equ 00158H +PrAddressPolicy equ 00160H + +; +; Defines for user shared data +; + +ifdef RELOCATABLE_USER_SHARED_DATA +MM_SHARED_USER_DATA_VA_NOT_RELOCATABLE equ 0000000007FFE0000H +else +USER_SHARED_DATA equ 0FFFFF78000000000H +MM_SHARED_USER_DATA_VA equ 0000000007FFE0000H +endif +PF_COMPARE_EXCHANGE128 equ 0000000000000000EH +PF_RDWRFSGSBASE_AVAILABLE equ 00000000000000016H +PF_RDTSCP_INSTRUCTION_AVAILABLE equ 00000000000000020H +PF_RDPID_INSTRUCTION_AVAILABLE equ 00000000000000021H +SYSTEM_CALL_INT_2E equ 00001H +UsTickCountMultiplier equ 00004H +UsInterruptTime equ 00008H +UsSystemTime equ 00014H +UsTestRetInstruction equ 002F8H +UsSystemCall equ 00308H +UsProcessorFeatures equ 00274H + +; +; Tss Structure Offset Definitions +; + +TssRsp0 equ 00004H +TssRsp1 equ 0000CH +TssRsp2 equ 00014H +TssPanicStack equ 00024H +TssMcaStack equ 0002CH +TssNmiStack equ 00034H +TssIoMapBase equ 00066H +TssLength equ 00068H + +; +; Gdt Descriptor Offset Definitions +; + +KGDT64_NULL equ 00000H +KGDT64_R0_CODE equ 00010H +KGDT64_R0_DATA equ 00018H +KGDT64_R3_CMCODE equ 00020H +KGDT64_R3_DATA equ 00028H +KGDT64_R3_CODE equ 00030H +KGDT64_SYS_TSS equ 00040H +KGDT64_R3_CMTEB equ 00050H + +; +; Constants for AMD64 compatibility mode switching +; + +X86AMD64_R3_LONG_MODE_CODE equ 00033H + +; +; GDT Entry Offset Definitions +; + +KgdtBaseLow equ 00002H +KgdtBaseMiddle equ 00004H +KgdtBaseHigh equ 00007H +KgdtBaseUpper equ 00008H +KgdtFlags1 equ 00005H +KgdtLimitHigh equ 00006H +KgdtLimitLow equ 00000H +KGDT_LIMIT_ENCODE_MASK equ 03C00H +KGDT_ENTRY_PRESENT equ 00080H + + +; +; Processor Block Structure Offset Definitions +; + +PbMxCsr equ 00000H +PbInterruptRequest equ 00006H +PbIdleHalt equ 00007H +PbCurrentThread equ 00008H +PbNextThread equ 00010H +PbIdleThread equ 00018H +PbSmtIsolationThread equ 08E80H +PbNestingLevel equ 00020H +PbNumber equ 00024H +PbRspBase equ 00028H +PbRspBaseShadow equ 0AE88H +PbPrcbLock equ 00030H +PbTscFrequency equ 00090H +PbKeSpinLockOrdering equ 083B0H +KI_SPINLOCK_ORDER_PRCB_LOCK equ 00200H +PbGroup equ 000D0H +PbGroupIndex equ 000D1H +PbProcessorState equ 00100H +PbContext equ 08FC0H +PbCpuType equ 00040H +PbCpuID equ 00041H +PbCpuStep equ 00042H +PbHalReserved equ 00048H +PbMinorVersion equ 00088H +PbMajorVersion equ 0008AH +PbBuildType equ 0008CH +PbCpuVendor equ 0008DH +PbCoresPerPhysicalProcessor equ 000A0H +PbLogicalProcessorsPerCore equ 000A4H +PbApicMask equ 000DCH +PbCFlushSize equ 000E8H +PbAcpiReserved equ 000E0H +PbInitialApicId equ 000D4H +PbPrcbFlags equ 000ECH +KPRCB_BAM_QOS_LEVEL_MASK equ 0000FH +PbPriorityState equ 00038H +PbLockQueue equ 006F0H +PbPPLookasideList equ 00800H +PbPPNPagedLookasideList equ 01500H +PbPPPagedLookasideList equ 02100H +PbPacketBarrier equ 02D80H +PbDeferredReadyListHead equ 02D08H +PbLookasideIrpFloat equ 02D9CH +PbSystemCalls equ 02D38H +PbReadOperationCount equ 02D5CH +PbWriteOperationCount equ 02D60H +PbOtherOperationCount equ 02D64H +PbReadTransferCount equ 02D68H +PbWriteTransferCount equ 02D70H +PbOtherTransferCount equ 02D78H +PbContextSwitches equ 02D3CH +PbTargetCount equ 02D84H +PbIpiFrozen equ 02D88H +PbRequestMailbox equ 0CEC0H +PbMailbox equ 09AC0H +PbDpcList equ 03840H +PbDpcLock equ 03850H +PbDpcCount equ 0385CH +PbDpcStack equ 038A0H +PbIsrStack equ 08FD8H +PbMaximumDpcQueueDepth equ 038A8H +PbDpcRequestRate equ 038ACH +PbMinimumDpcRate equ 038B0H +PbDpcRoutineActive equ 038BAH +PbDpcRequestSummary equ 038BCH +PbNormalDpcState equ 038BCH +PbDpcLastCount equ 038B4H +PbQuantumEnd equ 038B9H +PbIdleSchedule equ 038BBH +PbInterruptObject equ 03900H +PbReadySummary equ 083D8H +PbDispatcherReadyListHead equ 08440H +PbInterruptCount equ 08640H +PbKernelTime equ 08644H +PbUserTime equ 08648H +PbDpcTime equ 0864CH +PbInterruptTime equ 08650H +PbAdjustDpcThreshold equ 08654H +PbStartCycles equ 08680H +PbPageColor equ 08750H +PbNodeColor equ 08754H +PbCycleTime equ 08778H +PbCpuCycleScalingFactor equ 086B8H +PPM_FRACTION_SHIFT equ 00010H +PbFastReadNoWait equ 02D44H +PbFastReadWait equ 02D48H +PbFastReadNotPossible equ 02D4CH +PbCopyReadNoWait equ 02D50H +PbCopyReadWait equ 02D54H +PbCopyReadNoWaitMiss equ 02D58H +PbAlignmentFixupCount equ 08BB8H +PbExceptionDispatchCount equ 08670H +PbVendorString equ 08F90H +ProcessorBlockLength equ 0CF00H +PbShadowFlags equ 0AE98H +PbTrappedSecurityDomain equ 006D0H +PbKernelShadowStackInitial equ 09BA8H + +; +; Time Fields (TIME_FIELDS) Structure Offset Definitions +; + +TfSecond equ 0000AH +TfMinute equ 00008H +TfHour equ 00006H +TfWeekday equ 0000EH +TfDay equ 00004H +TfMonth equ 00002H +TfYear equ 00000H +TfMilliseconds equ 0000CH + + +; +; Define constants for system IRQL and IDT vector conversion +; + +MAXIMUM_IDTVECTOR equ 000FFH +MAXIMUM_PRIMARY_VECTOR equ 000FFH +PRIMARY_VECTOR_BASE equ 00030H +RPL_MASK equ 00003H +MODE_BIT equ 00000H +MODE_MASK equ 00001H +LDT_MASK equ 00004H + +; +; Flags in the CR0 register +; + +CR0_PG equ 080000000H +CR0_ET equ 00010H +CR0_TS equ 00008H +CR0_EM equ 00004H +CR0_MP equ 00002H +CR0_PE equ 00001H +CR0_CD equ 040000000H +CR0_NW equ 020000000H +CR0_AM equ 040000H +CR0_WP equ 010000H +CR0_NE equ 00020H + +; +; Flags in the CR4 register +; + +CR4_VME equ 00001H +CR4_PVI equ 00002H +CR4_TSD equ 00004H +CR4_DE equ 00008H +CR4_PSE equ 00010H +CR4_PAE equ 00020H +CR4_MCE equ 00040H +CR4_PGE equ 00080H +CR4_FXSR equ 00200H +CR4_XMMEXCPT equ 00400H +CR4_LA57 equ 01000H +CR4_XSAVE equ 040000H +CR4_PCIDE equ 020000H +CR4_CET equ 0800000H +CR4_LASS equ 08000000H + +; +; Legacy Floating Status Bit Masks +; + +FSW_INVALID_OPERATION equ 00001H +FSW_DENORMAL equ 00002H +FSW_ZERO_DIVIDE equ 00004H +FSW_OVERFLOW equ 00008H +FSW_UNDERFLOW equ 00010H +FSW_PRECISION equ 00020H +FSW_STACK_FAULT equ 00040H +FSW_ERROR_SUMMARY equ 00080H +FSW_CONDITION_CODE_0 equ 00100H +FSW_CONDITION_CODE_1 equ 00200H +FSW_CONDITION_CODE_2 equ 00400H +FSW_CONDITION_CODE_3 equ 04000H +FSW_ERROR_MASK equ 0003FH + +; +; MXCSR Floating Control/Status Bit Masks +; + +XSW_INVALID_OPERATION equ 00001H +XSW_DENORMAL equ 00002H +XSW_ZERO_DIVIDE equ 00004H +XSW_OVERFLOW equ 00008H +XSW_UNDERFLOW equ 00010H +XSW_PRECISION equ 00020H +XSW_ERROR_MASK equ 0003FH +XSW_ERROR_SHIFT equ 00007H +XCW_INVALID_OPERATION equ 00080H +XCW_DENORMAL equ 00100H +XCW_ZERO_DIVIDE equ 00200H +XCW_OVERFLOW equ 00400H +XCW_UNDERFLOW equ 00800H +XCW_PRECISION equ 01000H +XCW_ROUND_CONTROL equ 06000H +XCW_FLUSH_ZERO equ 08000H +INITIAL_FPCSR equ 0027FH +INITIAL_MXCSR equ 01F80H + +; +; Machine Specific Register Numbers +; + +MSR_EFER equ 0C0000080H +MSR_STAR equ 0C0000081H +MSR_LSTAR equ 0C0000082H +MSR_CSTAR equ 0C0000083H +MSR_SYSCALL_MASK equ 0C0000084H +MSR_FS_BASE equ 0C0000100H +MSR_GS_BASE equ 0C0000101H +MSR_GS_SWAP equ 0C0000102H +MSR_MCG_STATUS equ 0017AH +MSR_AMD_ACCESS equ 09C5A203AH +MSR_AMD_HWCR equ 0C0010015H +MSR_AMD_HW_FEEDBACK_RESET equ 0C0000502H +MSR_IA32_MISC_ENABLE equ 001A0H +MSR_IA32_U_CET equ 006A0H +MSR_IA32_S_CET equ 006A2H +MSR_IA32_PL0_SSP equ 006A4H +MSR_IA32_PL3_SSP equ 006A7H +MSR_IA32_XFD equ 001C4H +MSR_IA32_XFD_ERR equ 001C5H + +; +; Flags within MSR_EFER +; + +MSR_LMA equ 00400H +MSR_LME equ 00100H +MSR_SCE equ 00001H +MSR_NXE equ 00800H +MSR_PAT equ 00277H +MSR_DEBUG_CTL equ 001D9H + +; +; Flags within MSR_IA32_MISC_ENABLE +; + +MSR_XD_ENABLE_MASK equ 0FFFFFFFBH + +; +; Flags within MSR_IA32_U_CET +; + +IA32_CET_SH_STK_EN equ 00001H +IA32_CET_WR_SHSTK_EN equ 00002H + +; +; Flags within MSR_DEGUG_CTL +; + +MSR_DEBUG_CTL_LBR equ 00001H +MSR_DEBUG_CTL_BTF equ 00002H + +; +; Flags within MSR_IA32_MCG_STATUS +; + +MSR_IA32_MCG_STATUS_MCIP equ 00004H + +; +; Flags within MSR_AMD_HWCR +; + +MSR_AMD_HWCR_FAST_TPR_LOWER_DISABLE_UPPER_BIT equ 00000H + +; +; Miscellaneous Definitions +; + +MAXIMUM_PROCESSORS equ 00040H +INITIAL_STALL_COUNT equ 00064H +IRQL_NOT_GREATER_OR_EQUAL equ 00009H +IRQL_NOT_LESS_OR_EQUAL equ 0000AH +MUTEX_ALREADY_OWNED equ 000BFH +THREAD_NOT_MUTEX_OWNER equ 00011H +SPIN_LOCK_ALREADY_OWNED equ 0000FH +SPIN_LOCK_NOT_OWNED equ 00010H +Executive equ 00000H +FALSE equ 00000H +TRUE equ 00001H +NMI_BLOCKING_MASK equ 00004H +KERNEL_MCA_EXCEPTION_STACK_SIZE equ 02000H +EXCEPTION_EXECUTE_FAULT equ 00008H +KCACHE_ERRATA_MONITOR_FLAGS equ 00003H + +; +; Machine check nesting simulation debug controls +; + +DBG_MCE_NMI_ON_MCE equ 00000H +DBG_MCE_MCE_ON_NMI equ 00001H +DBG_MCE_MCE_ON_NMI_MCE_TAIL equ 00002H +DBG_MCE_MCE_ON_MCE_MCE_TAIL equ 00003H +DBG_MCE_NMI_ON_MCE_MCE_TAIL equ 00004H +DBG_MCE_NMI_PENDING equ 0001FH + +; +; Flags returned from KiProcessControlProtection +; + +KI_CP_HANDLED equ 00001H +KI_CP_NOT_HANDLED equ 00002H +KI_CP_SUPPORTED_HIJACK equ 00003H + +; +; Fast Fail Definitions +; + +FAST_FAIL_GUARD_ICALL_CHECK_FAILURE equ 0000AH +FAST_FAIL_INVALID_JUMP_BUFFER equ 00012H +FAST_FAIL_INVALID_SET_OF_CONTEXT equ 0000DH +FAST_FAIL_GUARD_SS_FAILURE equ 0002CH +FAST_FAIL_CONTROL_INVALID_RETURN_ADDRESS equ 00039H +BASE_PRIORITY_THRESHOLD equ 00008H +EVENT_INCREMENT equ 00001H +LOW_REALTIME_PRIORITY equ 00010H +DOUBLE_FAULT_STACK_SIZE equ 02000H +KI_KERNEL_SHADOW_STACK_SIZE_WITH_GUARD_PAGES equ 03000H +BREAKPOINT_BREAK equ 00000H +BREAKPOINT_COMMAND_STRING equ 00005H +BREAKPOINT_PRINT equ 00001H +BREAKPOINT_PROMPT equ 00002H +BREAKPOINT_LOAD_SYMBOLS equ 00003H +BREAKPOINT_UNLOAD_SYMBOLS equ 00004H +CLOCK_QUANTUM_DECREMENT equ 00003H +READY_SKIP_QUANTUM equ 00002H +THREAD_QUANTUM equ 00006H +WAIT_QUANTUM_DECREMENT equ 00001H +ROUND_TRIP_DECREMENT_COUNT equ 00010H +KI_EXCEPTION_GP_FAULT equ 010000001H +KI_EXCEPTION_INVALID_OP equ 010000002H +KI_EXCEPTION_INTEGER_DIVIDE_BY_ZERO equ 010000003H +KI_EXCEPTION_ACCESS_VIOLATION equ 010000004H +KI_EXCEPTION_SECURE_FAULT equ 010000006H +KI_EXCEPTION_SEGMENT_NOT_PRESENT equ 010000007H +KI_EXCEPTION_XFD_ERROR equ 010000010H +TARGET_FREEZE equ 00005H +KI_DPC_INTERRUPT_FLAGS equ 000AFH +KI_DPC_THREAD_ACTIVE equ 010000H +KernelShadowStackTypeRstorssp equ 00002H + +; +; Equates for exceptions which cause system fatal error +; + +EXCEPTION_DIVIDED_BY_ZERO equ 00000H +EXCEPTION_DEBUG equ 00001H +EXCEPTION_NMI equ 00002H +EXCEPTION_INT3 equ 00003H +EXCEPTION_BOUND_CHECK equ 00005H +EXCEPTION_INVALID_OPCODE equ 00006H +EXCEPTION_NPX_NOT_AVAILABLE equ 00007H +EXCEPTION_DOUBLE_FAULT equ 00008H +EXCEPTION_NPX_OVERRUN equ 00009H +EXCEPTION_INVALID_TSS equ 0000AH +EXCEPTION_SEGMENT_NOT_PRESENT equ 0000BH +EXCEPTION_STACK_FAULT equ 0000CH +EXCEPTION_GP_FAULT equ 0000DH +EXCEPTION_RESERVED_TRAP equ 0000FH +EXCEPTION_NPX_ERROR equ 00010H +EXCEPTION_ALIGNMENT_CHECK equ 00011H +EXCEPTION_CP_FAULT equ 00015H +EXCEPTION_SE_FAULT equ 00017H +EXCEPTION_VIRTUALIZATION_FAULT equ 00020H + +; +; Exception Frame Offset Definitions and Length +; + +ExP1Home equ 00000H +ExP2Home equ 00008H +ExP3Home equ 00010H +ExP4Home equ 00018H +ExP5 equ 00020H +ExXmm6 equ 00030H +ExXmm7 equ 00040H +ExXmm8 equ 00050H +ExXmm9 equ 00060H +ExXmm10 equ 00070H +ExXmm11 equ 00080H +ExXmm12 equ 00090H +ExXmm13 equ 000A0H +ExXmm14 equ 000B0H +ExXmm15 equ 000C0H +ExMxCsr equ 000F0H +ExRbp equ 000F8H +ExRbx equ 00100H +ExRdi equ 00108H +ExRsi equ 00110H +ExR12 equ 00118H +ExR13 equ 00120H +ExR14 equ 00128H +ExR15 equ 00130H +ExReturn equ 00138H + +KEXCEPTION_FRAME_LENGTH equ 00140H +EXCEPTION_RECORD_LENGTH equ 000A0H + + +; +; Kernel Dynamic Tracing flags +; + +KI_DYNAMIC_TRACE_SYSCALL_FLAG equ 00001H + + +; +; Processor Descriptor Area definitions +; + +PdaGdt equ 02FB0H +PdaKernelGsBase equ 01070H +PdaIdleStack equ 01078H +PdaKernelTransitionStack equ 04200H +PdaMceTransitionStack equ 04600H +PdaNmiTransitionStack equ 04800H +KSHADOW_FLAG_DEFERRED_FLUSH equ 00001H +KSHADOW_FLAG_DEFERRED_FLUSH_BIT equ 00000H +KSHADOW_FLAG_KERNEL_DIRECTORY equ 00002H +KSHADOW_FLAG_KERNEL_DIRECTORY_BIT equ 00001H + + +; +; IST Base Frame definitions +; + +IbfKernelGsBase equ 00000H +IbfIstStack equ 00008H +IbfPreviousGsBase equ 00010H +IbfPreviousCr3 equ 00018H +IstBaseFrameLength equ 00030H +IstLinkFrameLength equ 00020H +IST_TRANSITION_STACK_SIZE equ 001D0H + + +; +; IST Link Frame definitions +; + +KIST_LINK_FRAME_SIGNATURE equ 0464C494BH +IlfIstBaseFrame equ 00000H +IlfSignature equ 00008H +IstLinkFrameLength equ 00020H + + +; +; PCID definitions +; + +PCID_MASK equ 00003H +PCID_USER equ 00001H +PCID_USER_BIT equ 00000H +PCID_KERNEL equ 00002H +PCID_KERNEL_BIT equ 00001H +PCID_PRESERVE_TB_BIT equ 0003FH + +KI_FLUSH_PCID equ 00001H +KI_FLUSH_INVPCID equ 00002H + +KvaShadowEnabledUserGlobal equ 00002H + +; +; Jump Offset Definitions and Length +; + +JbFrame equ 00000H +JbRbx equ 00008H +JbRsp equ 00010H +JbRbp equ 00018H +JbRsi equ 00020H +JbRdi equ 00028H +JbR12 equ 00030H +JbR13 equ 00038H +JbR14 equ 00040H +JbR15 equ 00048H +JbRip equ 00050H +JbMxCsr equ 00058H +JbFpCsr equ 0005CH +JbSpare equ 0005EH +JbXmm6 equ 00060H +JbXmm7 equ 00070H +JbXmm8 equ 00080H +JbXmm9 equ 00090H +JbXmm10 equ 000A0H +JbXmm11 equ 000B0H +JbXmm12 equ 000C0H +JbXmm13 equ 000D0H +JbXmm14 equ 000E0H +JbXmm15 equ 000F0H + +; +; Switch Frame Offset Definitions and Length +; + +SwP5Home equ 00020H +SwApcBypass equ 00028H +SwRbp equ 00030H +SwReturn equ 00038H + +KSWITCH_FRAME_LENGTH equ 00040H + +; +; Start System Thread Frame Offset Definitions and Length +; + +SfP1Home equ 00000H +SfP2Home equ 00008H +SfP3Home equ 00010H +SfP4Home equ 00018H +SfReturn equ 00028H + +KSTART_FRAME_LENGTH equ 00030H + +; +; Trap Frame Offset and EFLAG Definitions and Length +; + +EFLAGS_TF_MASK equ 00100H +EFLAGS_TF_SHIFT equ 00008H +EFLAGS_ID_MASK equ 0200000H +EFLAGS_AC_MASK equ 040000H +EFLAGS_IF_MASK equ 00200H +EFLAGS_IF_SHIFT equ 00009H +EFLAGS_IF_BIT equ 00009H +KEXCEPTION_ACTIVE_INTERRUPT_FRAME equ 00000H +KEXCEPTION_ACTIVE_EXCEPTION_FRAME equ 00001H +KEXCEPTION_ACTIVE_SERVICE_FRAME equ 00002H + +TrP1Home equ 0FFFFFF80H +TrP2Home equ 0FFFFFF88H +TrP3Home equ 0FFFFFF90H +TrP4Home equ 0FFFFFF98H +TrP5 equ 0FFFFFFA0H +TrPreviousMode equ 0FFFFFFA8H +TrPreviousIrql equ 0FFFFFFA9H +TrFaultIndicator equ 0FFFFFFAAH +TrExceptionActive equ 0FFFFFFABH +TrMxCsr equ 0FFFFFFACH +TrRax equ 0FFFFFFB0H +TrRcx equ 0FFFFFFB8H +TrRdx equ 0FFFFFFC0H +TrR8 equ 0FFFFFFC8H +TrR9 equ 0FFFFFFD0H +TrR10 equ 0FFFFFFD8H +TrR11 equ 0FFFFFFE0H +TrGsBase equ 0FFFFFFE8H +TrGsSwap equ 0FFFFFFE8H +TrXmm0 equ 0FFFFFFF0H +TrXmm1 equ 00000H +TrXmm2 equ 00010H +TrXmm3 equ 00020H +TrXmm4 equ 00030H +TrXmm5 equ 00040H +TrFaultAddress equ 00050H +TrDr0 equ 00058H +TrDr1 equ 00060H +TrDr2 equ 00068H +TrDr3 equ 00070H +TrDr6 equ 00078H +TrDr7 equ 00080H +TrShadowStackFrame equ 00058H +TrDebugControl equ 00088H +TrLastBranchToRip equ 00090H +TrLastBranchFromRip equ 00098H +TrLastExceptionToRip equ 000A0H +TrLastExceptionFromRip equ 000A8H +TrSegDs equ 000B0H +TrSegEs equ 000B2H +TrSegFs equ 000B4H +TrSegGs equ 000B6H +TrTrapFrame equ 000B8H +TrRbx equ 000C0H +TrRdi equ 000C8H +TrRsi equ 000D0H +TrRbp equ 000D8H +TrErrorCode equ 000E0H +TrRip equ 000E8H +TrSegCs equ 000F0H +TrLogging equ 000F3H +TrEFlags equ 000F8H +TrRsp equ 00100H +TrSegSs equ 00108H +; +; + +KTRAP_FRAME_LENGTH equ 00190H + +; +; CPU information structure offset definitions +; + +CpuEax equ 00000H +CpuEbx equ 00004H +CpuEcx equ 00008H +CpuEdx equ 0000CH + +; +; Usermode Callout User Frame Definitions +; + +CkBuffer equ 00020H +CkLength equ 00028H +CkApiNumber equ 0002CH +CkRsp equ 00048H +CkRip equ 00030H +CalloutFrameLength equ 00058H + +; +; Machine Frame Offset Definitions +; + +MfRip equ 00000H +MfSegCs equ 00008H +MfEFlags equ 00010H +MfRsp equ 00018H +MfSegSs equ 00020H +MachineFrameLength equ 00028H + +; +; Shadow Stack Machine Frame Offset Definitions +; + +SmSsp equ 00000H +SmRip equ 00008H +SmSegCs equ 00010H + +; +; DPC Stack Frame Defintions +; + +DpRsp equ 00040H +DpRip equ 00028H +DpP5 equ 00020H +DpcStackFrameLength equ 00050H + +; +; Context Frame Offset and Flag Definitions +; + +CONTEXT_FULL equ 010000BH +CONTEXT_CONTROL equ 0100001H +CONTEXT_INTEGER equ 0100002H +CONTEXT_SEGMENTS equ 0100004H +CONTEXT_FLOATING_POINT equ 0100008H +CONTEXT_DEBUG_REGISTERS equ 0100010H +CONTEXT_XSTATE equ 0100040H +CONTEXT_KERNEL_CET equ 0100080H + +CxP1Home equ 00000H +CxP2Home equ 00008H +CxP3Home equ 00010H +CxP4Home equ 00018H +CxP5Home equ 00020H +CxP6Home equ 00028H +CxContextFlags equ 00030H +CxMxCsr equ 00034H +CxSegCs equ 00038H +CxSegDs equ 0003AH +CxSegEs equ 0003CH +CxSegFs equ 0003EH +CxSegGs equ 00040H +CxSegSs equ 00042H +CxEFlags equ 00044H +CxDr0 equ 00048H +CxDr1 equ 00050H +CxDr2 equ 00058H +CxDr3 equ 00060H +CxDr6 equ 00068H +CxDr7 equ 00070H +CxRax equ 00078H +CxRcx equ 00080H +CxRdx equ 00088H +CxRbx equ 00090H +CxRsp equ 00098H +CxRbp equ 000A0H +CxRsi equ 000A8H +CxRdi equ 000B0H +CxR8 equ 000B8H +CxR9 equ 000C0H +CxR10 equ 000C8H +CxR11 equ 000D0H +CxR12 equ 000D8H +CxR13 equ 000E0H +CxR14 equ 000E8H +CxR15 equ 000F0H +CxRip equ 000F8H +CxFltSave equ 00100H +CxXmm0 equ 001A0H +CxXmm1 equ 001B0H +CxXmm2 equ 001C0H +CxXmm3 equ 001D0H +CxXmm4 equ 001E0H +CxXmm5 equ 001F0H +CxXmm6 equ 00200H +CxXmm7 equ 00210H +CxXmm8 equ 00220H +CxXmm9 equ 00230H +CxXmm10 equ 00240H +CxXmm11 equ 00250H +CxXmm12 equ 00260H +CxXmm13 equ 00270H +CxXmm14 equ 00280H +CxXmm15 equ 00290H +CxDebugControl equ 004A8H +CxLastBranchToRip equ 004B0H +CxLastBranchFromRip equ 004B8H +CxLastExceptionToRip equ 004C0H +CxLastExceptionFromRip equ 004C8H +CxVectorControl equ 004A0H +CxVectorRegister equ 00300H +CONTEXT_FRAME_LENGTH equ 004D0H +CONTEXT_EX_LENGTH equ 00020H + +; +; Debug Control Register Masks +; + +DR7_LEGAL equ 0FFFF0355H +DR7_ACTIVE equ 00355H +DR7_TRACE_BRANCH equ 00200H +DR7_LAST_BRANCH equ 00100H +DEBUG_ACTIVE_DR7 equ 00001H +DEBUG_ACTIVE_INSTRUMENTED equ 00002H +DEBUG_ACTIVE_DBG_INSTRUMENTED equ 00003H +DEBUG_ACTIVE_MINIMAL_THREAD equ 00004H +DEBUG_ACTIVE_SET_CONTEXT_STATE_LOCK_BIT equ 0001BH +DEBUG_ACTIVE_SET_CONTEXT_STATE_LOCK equ 08000000H + +; +; Continue Argument Structure Definitions +; + +KCONTINUE_INVALID equ 00004H +KCONTINUE_ARGUMENT_LENGTH equ 00020H + +; +; SK Shadow Stack Assist Operation Definitions +; + +SkShadowStackAssistDebugTrapCopyFrame equ 00002H + +; +; Dispatcher Context Structure Offset Definitions +; + +DcControlPc equ 00000H +DcImageBase equ 00008H +DcFunctionEntry equ 00010H +DcEstablisherFrame equ 00018H +DcTargetIp equ 00020H +DcContextRecord equ 00028H +DcLanguageHandler equ 00030H +DcHandlerData equ 00038H +DcHistoryTable equ 00040H +DcScopeIndex equ 00048H + +; +; Legacy Floating Save Area Structure Offset definitions +; + +LfControlWord equ 00000H +LfStatusWord equ 00002H +LfTagWord equ 00004H +LfErrorOpcode equ 00006H +LfErrorOffset equ 00008H +LfErrorSelector equ 0000CH +LfDataOffset equ 00010H +LfDataSelector equ 00014H +LfMxCsr equ 00018H +LfMxCsr_Mask equ 0001CH +LfFloatRegisters equ 00020H +LfXmmRegisters equ 000A0H +LfFloatSaveLength equ 00200H +X87ErrorOffset equ 0000CH +X87FloatSaveLength equ 0006CH + + +; +; Processor State Frame Offset Definitions +; + +PsSpecialRegisters equ 00000H +PsCr0 equ 00000H +PsCr2 equ 00008H +PsCr3 equ 00010H +PsCr4 equ 00018H +PsKernelDr0 equ 00020H +PsKernelDr1 equ 00028H +PsKernelDr2 equ 00030H +PsKernelDr3 equ 00038H +PsKernelDr6 equ 00040H +PsKernelDr7 equ 00048H +PsGdtr equ 00056H +PsIdtr equ 00066H +PsTr equ 00070H +PsLdtr equ 00072H +PsMxCsr equ 00074H +PsMsrGsBase equ 000A8H +PsMsrGsSwap equ 000B0H +PsMsrStar equ 000B8H +PsMsrLStar equ 000C0H +PsMsrCStar equ 000C8H +PsMsrSyscallMask equ 000D0H +PsXcr0 equ 000D8H +PsMsrFsBase equ 000E0H +PsContextFrame equ 000F0H +PsDebugControl equ 00078H +PsLastBranchToRip equ 00080H +PsLastBranchFromRip equ 00088H +PsLastExceptionToRip equ 00090H +PsLastExceptionFromRip equ 00098H +PsCr8 equ 000A0H +ProcessorStateLength equ 005C0H + +; +; Processor Start Block Offset Definitions +; + +PsbCompletionFlag equ 00004H +PsbGdt32 equ 0000CH +PsbIdt32 equ 00012H +PsbGdt equ 00018H +PsbTiledMemoryMap equ 00058H +PsbPmTarget equ 00060H +PsbLmTarget equ 00070H +PsbLmIdentityTarget equ 00066H +PsbSelfMap equ 00078H +PsbMsrPat equ 00080H +PsbMsrEFER equ 00088H +PsbProcessorState equ 00090H +PsbFlags equ 00008H +PROCESSOR_START_FLAG_FORCE_ENABLE_NX equ 00001H +PROCESSOR_START_FLAG_LA57 equ 00002H +PROCESSOR_START_FLAG_HIDDEN equ 00004H +ProcessorStartBlockLength equ 00650H +XHF_NOEXECUTE equ 0100000H + +; +; MCE Recovery Context Offset Definitions +; + +MrcFlags equ 00000H +MrcPhysicalAddress equ 00008H +MrcRecord equ 00008H +MceRecoveryContextLength equ 00010H + +; +; MCE Recovery Context Flags Definitions +; + +KMRC_ALTERNATE_CONTEXT equ 00001H +KMRC_WORK_ITEM equ 00002H +KMRC_OFFLINE_PAGE equ 00004H +KMRC_TERMINATE_PROCESS equ 00008H +KMRC_KERNEL_CONSUMER equ 00010H + +; +; KTHREAD +; + +ThNpxState equ 00250H +ThThreadFlags2 equ 00200H +ThSpecCtrl equ 0007EH +KTHREAD_RUNNING_NON_RETPOLINE_CODE_BIT equ 00000H +KTHREAD_RUNNING_NON_RETPOLINE_CODE equ 00001H +ThKernelShadowStack equ 00408H +ThKernelShadowStackBase equ 00418H +ThKernelShadowStackInitial equ 00410H +ThKernelShadowStackLimit equ 00420H +ThExtendedFeatureDisableMask equ 00428H +ThBamQosLevel equ 00204H + +; +; ETHREAD +; + +ThSetContextState equ 006A8H +ThUserFsBase equ 00678H +ThUserGsBase equ 00680H +PICO_SYSTEM_CALL equ 00008H + +; +; EPROCESS +; + +EpDebugPort equ 00308H +EpWoW64Process equ 00310H +EpFlags3 equ 005FCH +PS_PROCESS_FLAGS3_SECURITY_DOMAIN_CHANGED_V equ 00015H +PS_PROCESS_MITIGATION_FLAGS2_CET_RELATED equ 0C0F6C000H +; +; + +; +; Machine type definitions (Temporarily) +; + +MACHINE_TYPE_ISA equ 00000H +MACHINE_TYPE_EISA equ 00001H +MACHINE_TYPE_MCA equ 00002H + +; +; KeFeatureBits defines +; + +KF_RDTSC equ 00002H +KF_RDTSCP equ 00000000400000000H +KF_CR4 equ 00004H +KF_GLOBAL_PAGE equ 00010H +KF_LARGE_PAGE equ 00020H +KF_CMPXCHG8B equ 00080H +KF_FAST_SYSCALL equ 01000H +KF_BRANCH equ 020000H +KF_XSTATE equ 0800000H +KF_XSAVEOPT_BIT equ 0000FH +KF_XSTATE_BIT equ 00017H +KF_XSAVES_BIT equ 00026H +KF_RDWRFSGSBASE_BIT equ 0001CH +KF_CET_SS equ 00000400000000000H +KF_XFD equ 00080000000000000H +KF_FPU_LEAKAGE_BIT equ 00029H +KF_CAT_BIT equ 0002CH +KF_XFD_BIT equ 00037H + +; +; LoaderParameterBlock offsets relative to base +; + +LpbKernelStack equ 00080H +LpbPrcb equ 00088H +LpbProcess equ 00090H +LpbThread equ 00098H +PAGE_SIZE equ 01000H + +; +; Kernel Mode Callout Frame Definitions +; + +CuTrapFrame equ 000D0H +CuOutputBuffer equ 000D8H +CuOutputLength equ 000E0H + +; +; Enclave call dispatch frame +; + +EcEnclaveNumber equ 00020H +EcParameterAddress equ 00028H +EcParameterValue equ 00030H +EcOriginalReturn equ 00038H +EcFramePointer equ 00040H +EcReturnAddress equ 00048H + +; +; Hypervisor Enlightenment Definitions +; + +HV_MMU_USE_HYPERCALL_FOR_ADDRESS_SWITCH equ 00001H +HV_MMU_USE_HYPERCALL_FOR_LOCAL_FLUSH equ 00002H +HV_MMU_USE_HYPERCALL_FOR_REMOTE_FLUSH equ 00004H +HV_APIC_ENLIGHTENED equ 00010H +HV_KE_USE_HYPERCALL_FOR_LONG_SPIN_WAIT equ 00040H +HV_DEPRECATE_AUTO_EOI equ 01000H +HV_X64_MSR_EOI equ 040000070H +HV_X64_MSR_ICR equ 040000071H +HV_X64_MSR_TSC_FREQUENCY equ 040000022H +APIC_DELIVER_NMI equ 00400H +LAPIC_ICR_SELF equ 040000H +HV_VIRTUAL_APIC_NO_EOI_REQUIRED equ 00000H +HvApicFlags equ 00000H +HvVirtualFaultCode equ 00044H +HvVirtualFaultParam equ 00048H +HvExtVirtualizationFaultEpf equ 00001H + +; +; IO Status Block Offset Definitions +; + +IoStatus equ 00000H +IoPointer equ 00000H +IoInformation equ 00008H + +; +; KAFFINITY_EX size +; + +AffinityExLength equ 00108H + +; +; WoW Compatibility mode transition thunk +; + +ServiceCpupReturnFromSimulatedCode equ 0001FH +HV_VECTOR equ 00030H +MmWriteCombined equ 00002H +; diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64_stub.inc b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64_stub.inc new file mode 100644 index 0000000000000000000000000000000000000000..47380fc5c4a233db31cdaf7bc8feae8743104d83 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksamd64_stub.inc @@ -0,0 +1 @@ +include kxamd64.inc \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksarm64.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksarm64.h new file mode 100644 index 0000000000000000000000000000000000000000..fbe7c1c8222580c1fb241a5bbfde37db7ce10cbe --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksarm64.h @@ -0,0 +1,2653 @@ + + +// +// Pointer size in bytes +// + +#define SizeofPointer 0x8 + +// +// Process State Enumerated Type Values +// + +#define ProcessInMemory 0x0 +#define ProcessOutOfMemory 0x1 +#define ProcessInTransition 0x2 + +// +// Thread State Enumerated Type Values +// + +#define Initialized 0x0 +#define Ready 0x1 +#define Running 0x2 +#define Standby 0x3 +#define Terminated 0x4 +#define Waiting 0x5 + +// +// Processor Mode Definitions +// + +#define KernelMode 0x0 +#define UserMode 0x1 + +// +// Wait Reason and Wait Type Enumerated Type Values +// + +#define WrExecutive 0x0 +#define WrDispatchInt 0x1f +#define WaitAny 0x1 +#define WaitAll 0x0 + +// +// Apc State Structure Offset Definitions +// + +#define AsApcListHead 0x0 +#define AsProcess 0x20 +#define AsKernelApcPending 0x29 +#define AsUserApcPendingAll 0x2a +#define KAPC_STATE_ANY_USER_APC_PENDING_MASK 0x3 + + +// +// Apc Record Structure Offset Definitions +// + +#define ArNormalRoutine 0x0 +#define ArNormalContext 0x8 +#define ArSystemArgument1 0x10 +#define ArSystemArgument2 0x18 +#define ArFlags 0x20 +#define KAPC_RECORD_LENGTH 0x30 +#define KAPC_RECORD_FLAGS_CHECK_ALERT 0x1 + + +// +// Apc Callback Data Structure Offset Definitions +// + +#define AcdContextRecord 0x8 +#define KAPC_CALLBACK_DATA_LENGTH 0x20 + +// +// Bug Check Code Definitions +// + +#define APC_INDEX_MISMATCH 0x1 +#define KERNEL_APC_PENDING_DURING_EXIT 0x20 +#define ATTEMPTED_SWITCH_FROM_DPC 0xb8 +#define DATA_BUS_ERROR 0x2e +#define DATA_COHERENCY_EXCEPTION 0x55 +#define HAL1_INITIALIZATION_FAILED 0x61 +#define INSTRUCTION_BUS_ERROR 0x2f +#define INSTRUCTION_COHERENCY_EXCEPTION 0x56 +#define INTERRUPT_EXCEPTION_NOT_HANDLED 0x3d +#define INTERRUPT_UNWIND_ATTEMPTED 0x3c +#define INVALID_AFFINITY_SET 0x3 +#define INVALID_DATA_ACCESS_TRAP 0x4 +#define IRQL_GT_ZERO_AT_SYSTEM_SERVICE 0x4a +#define IRQL_NOT_LESS_OR_EQUAL 0xa +#define KMODE_EXCEPTION_NOT_HANDLED 0x1e +#define NMI_HARDWARE_FAILURE 0x80 +#define NO_USER_MODE_CONTEXT 0xe +#define PAGE_FAULT_WITH_INTERRUPTS_OFF 0x49 +#define PANIC_STACK_SWITCH 0x2b +#define SPIN_LOCK_INIT_FAILURE 0x81 +#define SYSTEM_EXIT_OWNED_MUTEX 0x39 +#define SYSTEM_SERVICE_EXCEPTION 0x3b +#define SYSTEM_UNWIND_PREVIOUS_USER 0x3a +#define TRAP_CAUSE_UNKNOWN 0x12 +#define UNEXPECTED_KERNEL_MODE_TRAP 0x7f +#define HARDWARE_INTERRUPT_STORM 0xf2 +#define RECURSIVE_MACHINE_CHECK 0xfb +#define RECURSIVE_NMI 0x111 +#define KERNEL_SECURITY_CHECK_FAILURE 0x139 +#define UNSUPPORTED_INSTRUCTION_MODE 0x151 +#define BUGCHECK_CONTEXT_MODIFIER 0x80000000 +#define INVALID_CALLBACK_STACK_ADDRESS 0x1cd +#define INVALID_KERNEL_STACK_ADDRESS 0x1ce +#define PREVIOUS_MODE_MISMATCH 0x1f9 + +// +// Breakpoint type definitions +// + +#define DBG_STATUS_CONTROL_C 0x1 +#define STATUS_ASSERTION_FAILURE 0xc0000420 + +// +// Client Id Structure Offset Definitions +// + +#define CidUniqueProcess 0x0 +#define CidUniqueThread 0x8 + +// +// Exception Record Offset, Flag, and Enumerated Type Definitions +// + +#define EXCEPTION_NONCONTINUABLE 0x1 +#define EXCEPTION_UNWINDING 0x2 +#define EXCEPTION_EXIT_UNWIND 0x4 +#define EXCEPTION_STACK_INVALID 0x8 +#define EXCEPTION_NESTED_CALL 0x10 +#define EXCEPTION_TARGET_UNWIND 0x20 +#define EXCEPTION_COLLIDED_UNWIND 0x40 +#define EXCEPTION_UNWIND 0x66 +#define EXCEPTION_EXECUTE_HANDLER 0x1 +#define EXCEPTION_CONTINUE_SEARCH 0x0 +#define EXCEPTION_CONTINUE_EXECUTION 0xffffffff + +#define ExceptionContinueExecution 0x0 +#define ExceptionContinueSearch 0x1 +#define ExceptionNestedException 0x2 +#define ExceptionCollidedUnwind 0x3 + +#define ErExceptionCode 0x0 +#define ErExceptionFlags 0x4 +#define ErExceptionRecord 0x8 +#define ErExceptionAddress 0x10 +#define ErNumberParameters 0x18 +#define ErExceptionInformation 0x20 +#define ExceptionRecordLength 0xa0 + +// +// Fast Mutex Structure Offset Definitions +// + +#define FmCount 0x0 +#define FmOwner 0x8 +#define FmContention 0x10 +#define FmOldIrql 0x30 + +// +// Interrupt Priority Request Level Definitions +// + +#define PASSIVE_LEVEL 0x0 +#define APC_LEVEL 0x1 +#define DISPATCH_LEVEL 0x2 +#define IPI_LEVEL 0xe +#define POWER_LEVEL 0xe +#define PROFILE_LEVEL 0xf +#define HIGH_LEVEL 0xf +#ifdef NT_UP +#define SYNCH_LEVEL 0x2 +#else +#define SYNCH_LEVEL 0xc +#endif + +// +// Large Integer Structure Offset Definitions +// + +#define LiLowPart 0x0 +#define LiHighPart 0x4 + +// +// List Entry Structure Offset Definitions +// + +#define LsFlink 0x0 +#define LsBlink 0x8 + +// +// String Structure Offset Definitions +// + +#define StrLength 0x0 +#define StrMaximumLength 0x2 +#define StrBuffer 0x8 + +// +// System DLL Init Block Structure Offset Definitions +// + +#define IbCfgBitMap 0xb8 +#define IbWow64CfgBitMap 0xc8 +#define IbMitigationOptionsMap 0xa0 +#define PS_MITIGATION_OPTION_BITS_PER_OPTION 0x4 +#define PS_MITIGATION_OPTION_ALWAYS_ON 0x1 +#define PS_MITIGATION_OPTION_ALWAYS_OFF 0x2 +#define PS_MITIGATION_OPTION_MASK 0x3 +#define PS_MITIGATION_OPTION_RETURN_FLOW_GUARD 0x10 +#define PS_MITIGATION_OPTION_RESTRICT_SET_THREAD_CONTEXT 0x13 +#define PS_MITIGATION_OPTION_CET_USER_SHADOW_STACKS 0x1f +#define PsneKiUserCallbackDispatcher 0x30 + +// +// User Shared Data Structure Offset Definitions +// + +#define UsTickCountMultiplier 0x4 +#define UsInterruptTime 0x8 +#define UsSystemTime 0x14 +#define UsTimeZoneBias 0x20 +#define UsImageNumberLow 0x2c +#define UsImageNumberHigh 0x2e +#define UsNtSystemRoot 0x30 +#define UsMaxStackTraceDepth 0x238 +#define UsCryptoExponent 0x23c +#define UsTimeZoneId 0x240 +#define UsLargePageMinimum 0x244 +#define UsNtBuildNumber 0x260 +#define UsNtProductType 0x264 +#define UsProductTypeIsValid 0x268 +#define UsNtMajorVersion 0x26c +#define UsNtMinorVersion 0x270 +#define UsProcessorFeatures 0x274 +#define UsReserved1 0x2b4 +#define UsReserved3 0x2b8 +#define UsTimeSlip 0x2bc +#define UsAlternativeArchitecture 0x2c0 +#define UsSystemExpirationDate 0x2c8 +#define UsSuiteMask 0x2d0 +#define UsKdDebuggerEnabled 0x2d4 +#define UsActiveConsoleId 0x2d8 +#define UsDismountCount 0x2dc +#define UsComPlusPackage 0x2e0 +#define UsLastSystemRITEventTickCount 0x2e4 +#define UsNumberOfPhysicalPages 0x2e8 +#define UsSafeBootMode 0x2ec +#define UsTestRetInstruction 0x2f8 +#define UsSystemCallPad 0x318 +#define UsTickCount 0x320 +#define UsTickCountQuad 0x320 +#define UsXState 0x3d8 + +// +// Time Structure Offset Definitions +// + +#define TmLowTime 0x0 +#define TmHighTime 0x4 + +// +// Thread Switch Counter Offset Definitions +// + +#define TwFindAny 0x0 +#define TwFindIdeal 0x4 +#define TwFindLast 0x8 +#define TwIdleAny 0xc +#define TwIdleCurrent 0x10 +#define TwIdleIdeal 0x14 +#define TwIdleLast 0x18 +#define TwPreemptAny 0x1c +#define TwPreemptCurrent 0x20 +#define TwPreemptLast 0x24 +#define TwSwitchToIdle 0x28 + +// +// Status Code Definitions +// + +#define STATUS_ACCESS_VIOLATION 0xc0000005 +#define STATUS_ARRAY_BOUNDS_EXCEEDED 0xc000008c +#define STATUS_BAD_COMPRESSION_BUFFER 0xc0000242 +#define STATUS_BREAKPOINT 0x80000003 +#define STATUS_CALLBACK_POP_STACK 0xc0000423 +#define STATUS_DATATYPE_MISALIGNMENT 0x80000002 +#define STATUS_FLOAT_DENORMAL_OPERAND 0xc000008d +#define STATUS_FLOAT_DIVIDE_BY_ZERO 0xc000008e +#define STATUS_FLOAT_INEXACT_RESULT 0xc000008f +#define STATUS_FLOAT_INVALID_OPERATION 0xc0000090 +#define STATUS_FLOAT_OVERFLOW 0xc0000091 +#define STATUS_FLOAT_STACK_CHECK 0xc0000092 +#define STATUS_FLOAT_UNDERFLOW 0xc0000093 +#define STATUS_FLOAT_MULTIPLE_FAULTS 0xc00002b4 +#define STATUS_FLOAT_MULTIPLE_TRAPS 0xc00002b5 +#define STATUS_GUARD_PAGE_VIOLATION 0x80000001 +#define STATUS_ILLEGAL_FLOAT_CONTEXT 0xc000014a +#define STATUS_ILLEGAL_INSTRUCTION 0xc000001d +#define STATUS_INSTRUCTION_MISALIGNMENT 0xc00000aa +#define STATUS_INVALID_HANDLE 0xc0000008 +#define STATUS_INVALID_LOCK_SEQUENCE 0xc000001e +#define STATUS_INVALID_OWNER 0xc000005a +#define STATUS_INVALID_PARAMETER 0xc000000d +#define STATUS_INVALID_PARAMETER_1 0xc00000ef +#define STATUS_INVALID_SYSTEM_SERVICE 0xc000001c +#define STATUS_INVALID_THREAD 0xc000071c +#define STATUS_INTEGER_DIVIDE_BY_ZERO 0xc0000094 +#define STATUS_INTEGER_OVERFLOW 0xc0000095 +#define STATUS_IN_PAGE_ERROR 0xc0000006 +#define STATUS_KERNEL_APC 0x100 +#define STATUS_LONGJUMP 0x80000026 +#define STATUS_NO_CALLBACK_ACTIVE 0xc0000258 +#define STATUS_PRIVILEGED_INSTRUCTION 0xc0000096 +#define STATUS_SINGLE_STEP 0x80000004 +#define STATUS_STACK_BUFFER_OVERRUN 0xc0000409 +#define STATUS_STACK_OVERFLOW 0xc00000fd +#define STATUS_SUCCESS 0x0 +#define STATUS_THREAD_IS_TERMINATING 0xc000004b +#define STATUS_TIMEOUT 0x102 +#define STATUS_UNWIND 0xc0000027 +#define STATUS_UNWIND_CONSOLIDATE 0x80000029 +#define STATUS_USER_APC 0xc0 +#define STATUS_WAKE_SYSTEM 0x40000294 +#define STATUS_WAKE_SYSTEM_DEBUGGER 0x80000007 +#define STATUS_SET_CONTEXT_DENIED 0xc000060a +#define STATUS_RETURN_ADDRESS_HIJACK_ATTEMPT 0x80000033 + +// +// Fast Fail Code Definitions +// + +#define FAST_FAIL_INVALID_BUFFER_ACCESS 0x1c +#define FAST_FAIL_INVALID_NEXT_THREAD 0x1e +#define FAST_FAIL_INVALID_CONTROL_STACK 0x2f +#define FAST_FAIL_SET_CONTEXT_DENIED 0x30 +#define FAST_FAIL_ENCLAVE_CALL_FAILURE 0x35 +#define FAST_FAIL_FLAGS_CORRUPTION 0x3b + +// +// APC Object Structure Offset Definitions +// + +#define ApType 0x0 +#define ApSize 0x2 +#define ApThread 0x8 +#define ApApcListEntry 0x10 +#define ApKernelRoutine 0x20 +#define ApRundownRoutine 0x28 +#define ApNormalRoutine 0x30 +#define ApNormalContext 0x38 +#define ApSystemArgument1 0x40 +#define ApSystemArgument2 0x48 +#define ApApcStateIndex 0x50 +#define ApApcMode 0x51 +#define ApInserted 0x52 +#define ApcObjectLength 0x58 + +// +// DPC object Structure Offset Definitions +// + +#define DpType 0x0 +#define DpNumber 0x2 +#define DpImportance 0x1 +#define DpDpcListEntry 0x8 +#define DpDeferredRoutine 0x18 +#define DpDeferredContext 0x20 +#define DpSystemArgument1 0x28 +#define DpSystemArgument2 0x30 +#define DpDpcData 0x38 +#define DpcObjectLength 0x40 + +#define KI_DPC_ALL_FLAGS 0xbf +#define KI_DPC_ANY_DPC_ACTIVE 0x10001 + +// +// Device Queue Object Structure Offset Definitions +// + +#define DvType 0x0 +#define DvSize 0x2 +#define DvDeviceListHead 0x8 +#define DvSpinLock 0x18 +#define DvBusy 0x20 +#define DeviceQueueObjectLength 0x28 + +// +// Device Queue Entry Structure Offset Definitions +// + +#define DeDeviceListEntry 0x0 +#define DeSortKey 0x10 +#define DeInserted 0x14 +#define DeviceQueueEntryLength 0x18 + +// +// Event Object Structure Offset Definitions +// + +#define EvType 0x0 +#define EvSize 0x2 +#define EvSignalState 0x4 +#define EvWaitListHead 0x8 +#define EventObjectLength 0x18 + +// +// Interrupt Object Structure Offset Definitions +// + +#define KINTERRUPT_STATE_DISABLED_BIT 0x0 +#define KINTERRUPT_STATE_DISABLED 0x1 +#define InLevelSensitive 0x0 +#define InLatched 0x1 + +#define InType 0x0 +#define InSize 0x2 +#define InInterruptListEntry 0x8 +#define InServiceRoutine 0x18 +#define InServiceContext 0x30 +#define InSpinLock 0x38 +#define InTickCount 0x40 +#define InActualLock 0x48 +#define InDispatchAddress 0x50 +#define InVector 0x58 +#define InIrql 0x5c +#define InSynchronizeIrql 0x5d +#define InFloatingSave 0x5e +#define InConnected 0x5f +#define InNumber 0x60 +#define InShareVector 0x64 +#define InInternalState 0x68 +#define InMode 0x6c +#define InServiceCount 0x74 +#define InDispatchCount 0x78 +#define InTrapFrame 0x88 +#define InterruptObjectLength 0x118 + +// +// Process Object Structure Offset Definitions +// + +#define PrType 0x0 +#define PrSize 0x2 +#define PrSignalState 0x4 +#define PrProfileListHead 0x18 +#define PrDirectoryTableBase 0x28 +#define PrThreadListHead 0x38 +#define PrAffinity 0x58 +#define PrReadyListHead 0x70 +#define PrSwapListEntry 0x80 +#define PrActiveProcessors 0x88 +#define PrProcessFlags 0x90 +#define PrBasePriority 0x98 +#define PrQuantumReset 0x99 +#define PrCycleTime 0x128 +#define PrInstrumentationCallback 0x160 +#define PrMitigationFlags2 0x814 +#define KernelProcessObjectLength 0x1b8 +#define ExecutiveProcessObjectLength 0x900 +#define Win32BatchFlushCallout 0x7 + +// +// Profile Object Structure Offset Definitions +// + +#define PfType 0x0 +#define PfSize 0x2 +#define PfProfileListEntry 0x8 +#define PfProcess 0x18 +#define PfRangeBase 0x20 +#define PfRangeLimit 0x28 +#define PfBucketShift 0x30 +#define PfBuffer 0x38 +#define PfSegment 0x40 +#define PfAffinity 0x48 +#define PfSource 0x260 +#define PfStarted 0x262 +#define ProfileObjectLength 0x268 + +// +// Queue Object Structure Offset Definitions +// + +#define QuSignalState 0x4 +#define QuEntryListHead 0x18 +#define QuCurrentCount 0x28 +#define QuMaximumCount 0x2c +#define QuThreadListHead 0x30 +#define QueueObjectLength 0x40 + +// +// Thread Object Structure Offset Definitions +// + +#define EtCid 0x4e8 +#define EtPicoContext 0x650 + +#define ThType 0x0 +#define ThSize 0x2 +#define ThLock 0x0 +#define THREAD_FLAGS_CYCLE_PROFILING 0x1 +#define THREAD_FLAGS_CYCLE_PROFILING_LOCK_BIT 0x10 +#define THREAD_FLAGS_CYCLE_PROFILING_LOCK 0x10000 +#define THREAD_FLAGS_COUNTER_PROFILING 0x2 +#define THREAD_FLAGS_COUNTER_PROFILING_LOCK_BIT 0x11 +#define THREAD_FLAGS_COUNTER_PROFILING_LOCK 0x20000 +#define THREAD_FLAGS_GROUP_SCHEDULING 0x4 +#define THREAD_FLAGS_AFFINITY_SET 0x8 +#define THREAD_FLAGS_ACCOUNTING_CSWITCH 0xb6 +#define THREAD_FLAGS_ACCOUNTING_INTERRUPT 0x72 +#define THREAD_FLAGS_ACCOUNTING_ANY 0xbe +#define ThDebugActive 0x3 +#define ThThreadControlFlags 0x2 +#define ThSignalState 0x4 +#define ThCycleTime 0x48 +#define ThCurrentRunTime 0x50 +#define ThStateSaveArea 0x478 +#define ThStateSaveAreaSveVectorOffset 0x428 +#define ThStateSaveAreaSvePredicateOffset 0x42c +#define ThVfpState 0x230 +#define ThInitialStack 0x28 +#define ThStackLimit 0x30 +#define ThKernelStack 0x58 +#define ThThreadLock 0x40 +#define ThApcState 0x90 +#define ThProcess 0x240 +#define ThNextProcessor 0x238 +#define ThAdjustReason 0x256 +#define ThAdjustIncrement 0x257 +#define ThWaitReason 0x2a3 +#define ThRunning 0x69 +#define ThAlerted 0x6a +#define ThWaitTime 0x1ac +#define ThCombinedApcDisable 0x1dc +#define ThKernelApcDisable 0x1dc +#define ThSpecialApcDisable 0x1de +#define ThTeb 0xe8 +#define ThTimer 0xf8 +#define thProcess 0x240 + +#define KTHREAD_AUTO_ALIGNMENT_BIT 0x2 +#define KTHREAD_GUI_THREAD_MASK 0x80 +#define KTHREAD_RESTRICTED_GUI_THREAD_MASK 0x200000 +#define KTHREAD_SYSTEM_THREAD_BIT 0xa +#define KTHREAD_QUEUE_DEFER_PREEMPTION_BIT 0xb +#define KTHREAD_CET_USER_SHADOW_STACK_BIT 0x14 +#define KTHREAD_CET_KERNEL_SHADOW_STACK_BIT 0x16 + +#define DEBUG_ACTIVE_ALT_SYSCALL_HANDLER 0x24 +#define PsSystemCallMapToSystem 0x1 + +#define ThMiscFlags 0x6c +#define ThThreadFlags 0x70 +#define ThPreviousMode 0x252 +#define ThContextSwitches 0x14c +#define ThState 0x17c +#define ThWaitIrql 0x17e +#define ThTrapFrame 0x88 +#define ThFirstArgument 0x80 +#define ThApcStateIndex 0x26a +#define ThSystemCallNumber 0x78 +#define ThWin32Thread 0x1c0 +#define ThStackBase 0x38 +#define ThLegoData 0x2f0 +#define KernelThreadObjectLength 0x4a0 +#define ExecutiveThreadObjectLength 0x778 + + +// +// Timer object Structure Offset Definitions +// + +#define TiType 0x0 +#define TiSize 0x2 +#define TiSignalState 0x4 +#define TiDueTime 0x18 +#define TiTimerListEntry 0x20 +#define TiDpc 0x30 +#define TiPeriod 0x3c +#define TimerObjectLength 0x40 + + +// +// Wait Block Structure Offset Definitions +// + +#define WbWaitListEntry 0x0 +#define WbThread 0x18 +#define WbObject 0x20 +#define WbWaitKey 0x12 +#define WbWaitType 0x10 + +// +// Fiber Structure Offset Definitions +// + +#define FbFiberData 0x0 +#define FbExceptionList 0x8 +#define FbStackBase 0x10 +#define FbStackLimit 0x18 +#define FbDeallocationStack 0x20 +#define FbFiberContext 0x30 +#define FbWx86Tib 0x3c0 +#define FbActivationContextStackPointer 0x3c8 +#define FbFlsData 0x3d0 +#define FbGuaranteedStackBytes 0x3d8 +#define FbTebFlags 0x3dc + +// +// ARM64EC Fiber Structure Offset Definitions +// + +#define EcFbFiberData 0x0 +#define EcFbExceptionList 0x8 +#define EcFbStackBase 0x10 +#define EcFbStackLimit 0x18 +#define EcFbDeallocationStack 0x20 +#define EcFbFiberContext 0x30 +#define EcFbWx86Tib 0x500 +#define EcFbActivationContextStackPointer 0x508 +#define EcFbFlsData 0x510 +#define EcFbGuaranteedStackBytes 0x518 +#define EcFbTebFlags 0x51c + +// +// Process Environment Block Structure Offset Definitions +// + +#define PeBeingDebugged 0x2 +#define PeProcessParameters 0x20 +#define PeKernelCallbackTable 0x58 +#define ProcessEnvironmentBlockLength 0x7d0 + +// +// Process Parameters Block Structure Offset Definitions +// + +#define PpFlags 0x8 +#define USER_CALLBACK_FILTER 0x80000 + +// +// System Service Descriptor Table Structure Definitions +// + +#define NUMBER_SERVICE_TABLES 0x2 +#define SERVICE_NUMBER_MASK 0xfff +#define SERVICE_TABLE_SHIFT 0x7 +#define SERVICE_TABLE_MASK 0x20 +#define SERVICE_TABLE_TEST 0x20 + +#define SdBase 0x0 +#define SdLimit 0x10 +#define SdNumber 0x18 +#define SdLength 0x20 + +// +// CHPEV2 EC Code Range Bitmap +// + +#define PeEcCodeBitMap 0x368 + +// +// CHPEV2 Per-Thread Emulation Structure Definitions +// + +#define Cv2ciInSimulation 0x0 +#define Cv2ciInSyscallCallback 0x1 +#define Cv2ciEmulatorData 0x30 +#define Cv2ciEmulatorData2 0x38 +#define Cv2ciEmulatorData3 0x40 +#define Cv2ciEmulatorData4 0x48 +#define Cv2ciEmulatorDataInline 0x50 +#define Cv2ciEmulatorStackBase 0x8 +#define Cv2ciEmulatorStackLimit 0x10 +#define Cv2ciContextAmd64 0x18 +#define Cv2ciSuspendDoorbell 0x20 +#define Cv2ciLoadingModuleModflag 0x28 + +// +// Thread Environment Block Structure Offset Definitions +// + +#define TeCmTeb 0x0 +#define TeStackBase 0x8 +#define TeStackLimit 0x10 +#define TeFiberData 0x20 +#define TeSelf 0x30 +#define TeEnvironmentPointer 0x38 +#define TeClientId 0x40 +#define TeActiveRpcHandle 0x50 +#define TeThreadLocalStoragePointer 0x58 +#define TeCountOfOwnedCriticalSections 0x6c +#define TePeb 0x60 +#define TeCsrClientThread 0x70 +#define TeWOW32Reserved 0x100 +#define TeSoftFpcr 0x10c +#define TeExceptionCode 0x2c0 +#define TeActivationContextStackPointer 0x2c8 +#define TeInstrumentationCallbackSp 0x2d0 +#define TeInstrumentationCallbackPreviousPc 0x2d8 +#define TeInstrumentationCallbackPreviousSp 0x2e0 +#define TeUnalignedLoadStoreExceptions 0x2ed +#define TeGdiClientPID 0x7f0 +#define TeGdiClientTID 0x7f4 +#define TeGdiThreadLocalInfo 0x7f8 +#define TeglDispatchTable 0x9f0 +#define TeglReserved1 0x1138 +#define TeglReserved2 0x1220 +#define TeglSectionInfo 0x1228 +#define TeglSection 0x1230 +#define TeglTable 0x1238 +#define TeglCurrentRC 0x1240 +#define TeglContext 0x1248 +#define TeDeallocationStack 0x1478 +#define TeTlsSlots 0x1480 +#define TeTlsExpansionSlots 0x1780 +#define TeLastErrorValue 0x68 +#define TeVdm 0x1690 +#define TeInstrumentation 0x16b8 +#define TeGdiBatchCount 0x1740 +#define TeGuaranteedStackBytes 0x1748 +#define TeChpeV2CpuAreaInfo 0x1788 +#define TeFlsData 0x17c8 +#define TeCurrentIdealProcessor 0x1744 +#define TePrimaryGroupAffinity 0x1860 +#define ThreadEnvironmentBlockLength 0x1878 +#define CmThreadEnvironmentBlockOffset 0x2000 +#define TLS_MINIMUM_AVAILABLE 0x40 +#define TLS_EXPANSION_SLOTS 0x400 + +// +// Lock Queue Structure Offset Definitions +// + +#define LOCK_QUEUE_WAIT 0x1 +#define LOCK_QUEUE_OWNER 0x2 +#define LOCK_QUEUE_HEADER_SIZE 0x10 + + +#define LqNext 0x0 +#define LqLock 0x8 + +#define LqhLockQueue 0x0 +#define LqhOldIrql 0x10 +#define LqhNext 0x0 +#define LqhLock 0x8 + +// +// Kernel Stack Control Structure Offset (relative to initial stack pointer) Definitions +// + +#define KSTACK_CONTROL_LENGTH 0x40 +#define KcPreviousBase 0x20 +#define KcPreviousLimit 0x28 +#define KcPreviousKernel 0x30 +#define KcPreviousInitial 0x38 +#define KcCurrentBase 0x0 +#define KcActualLimit 0x8 +#define KSTACK_ACTUAL_LIMIT_EXPANDED 0x1 + + +// +// ETW Definitions +// + +#define PERF_CONTEXTSWAP_OFFSET 0x4 +#define PERF_CONTEXTSWAP_FLAG 0x4 +#define PERF_INTERRUPT 0x20004000 +#define PERF_INTERRUPT_OFFSET 0x4 +#define PERF_INTERRUPT_FLAG 0x4000 +#define PERF_SYSCALL_OFFSET 0x8 +#define PERF_SYSCALL_FLAG 0x40 +#define PERF_SPEC_CONTROL_OFFSET 0x14 +#define PERF_SPEC_CONTROL_FLAG 0x2 +#define NTOS_YIELD_MACRO 0x1 +#define EtwTSLength 0x20 + +// +// Extended context structure offset definitions +// + +#define CxxAllOffset 0x0 +#define CxxAllLength 0x4 +#define CxxLegacyOffset 0x8 +#define CxxLegacyLength 0xc +#define CxxXStateOffset 0x10 +#define CxxXStateLength 0x14 +#define CxxKernelCetOffset 0x18 +#define CxxKernelCetLength 0x1c + +// +// KAFFINITY_EX offsets +// + +#define AfCount 0x0 +#define AfBitmap 0x8 +#define PbEntropyCount 0xff8 +#define PbEntropyBuffer 0xffc +#define KENTROPY_TIMING_INTERRUPTS_PER_BUFFER 0x400 +#define KENTROPY_TIMING_BUFFER_MASK 0x7ff +#define KENTROPY_TIMING_ANALYSIS 0x0 + +// +// Priority state definitions +// + +#define KPRIORITY_STATE_PRIORITY_BITMASK 0x7f +#define PnGroup 0x0 +#define PnNumber 0x2 +#define GaGroup 0x8 +#define GaMask 0x0 +#define KgsProcessorNumberToIndexMappingTable 0x8 +#define PERF_SYSCALL_FLAG_BIT 0x6 + +// +// Special Register Structure Offset Definition +// + +#define KsElr_El1 0x0 +#define KsSpsr_El1 0x8 +#define KsTpidr_El0 0x10 +#define KsTpidrro_El0 0x18 +#define KsTpidr_El1 0x20 +#define KsKernelBcr 0x68 +#define KsKernelBvr 0x28 +#define KsKernelWcr 0x98 +#define KsKernelBvr 0x28 + +// +// ARM Architectural State Structure Offset Definitions +// + +#define AaMidr_El1 0x0 +#define AaSctlr_El1 0x8 +#define AaActlr_El1 0x10 +#define AaCpacr_El1 0x18 +#define AaTcr_El1 0x20 +#define AaTtbr0_El1 0x28 +#define AaTtbr1_El1 0x30 +#define AaEsr_El1 0x38 +#define AaFar_El1 0x40 +#define AaPmcr_El0 0x48 +#define AaPmcntenset_El0 0x50 +#define AaPmccntr_El0 0x58 +#define AaPmxevcntr_El0 0x60 +#define AaPmxevtyper_El0 0x158 +#define AaPmovsclr_El0 0x250 +#define AaPmselr_El0 0x258 +#define AaPmuserenr_El0 0x260 +#define AaMair_El1 0x268 +#define AaVbar_El1 0x270 + +// +// Processor Control Region Structure Offset Definitions +// + +#define PCR_MITIGATION_VBAR_MASK 0xf +#define PCR_KVA_MITIGATION_VBAR_MASK 0x1 +#define PCR_BTI_MITIGATION_VBAR_MASK 0xe +#define PCR_BTI_MITIGATION_CSWAP_HVC 0x10 +#define PCR_BTI_MITIGATION_CSWAP_SMC 0x20 +#define PCR_BTI_MITIGATION_TRAP_HVC 0x2 +#define PCR_BTI_MITIGATION_CSWAP_HVC_BIT 0x4 +#define PCR_BTI_MITIGATION_CSWAP_SMC_BIT 0x5 +#define ARM64_ASID_KVA_SHADOW 0x8000 +#define PSCI_FUNCTION_CODE_SMCCC_ARCH_WORKAROUND_1 0x80008000 +#define PcSelf 0x18 +#define PcLockArray 0x28 +#define PcCurrentIrql 0x38 +#define PcTeb 0x30 +#define PcStallScaleFactor 0x40 +#define PcBtiMitigation 0x4c +#define PcSsbMitigationFlags 0x4d +#define PcCachePrefetcherMitigationFlags 0x4f +#define PcBhbMitigation 0x4e +#define PcPanicStorage 0x50 +#define PcHalReserved 0x88 +#define PcPrcb 0x980 +#define PcKvaUserModeTtbr1 0xf8 +#define PcIdleHalt 0x982 +#define PcCurrentThread 0x988 +#define PcNextThread 0x990 +#define PcIdleThread 0x998 +#define PcNestingLevel 0x9a0 +#define PcNumber 0x9a4 +#define PcGroup 0x1108 +#define PcPrcbLock 0x9a8 +#define PcGroupSetMember 0x1100 +#define PcFeatureBits 0x1294 +#define PcVirtualApicAssist 0x23a8 +#define PcTrappedSecurityDomain 0x15f8 +#define PcEmulatedFaultSyndrome 0x12b0 +#define PcEmulatedAccess 0x12ac +#define RTL_KERNELSCP_STUBS_UNWIND_INFO_MAX_SIZE 0x1f4 +#define TlThread 0x0 +#define TlCpuNumber 0x8 +#define TlTrapType 0x9 +#define TlPadding 0xa +#define TlCpsr 0xc +#define TlX0 0x10 +#define TlX1 0x18 +#define TlX2 0x20 +#define TlX3 0x28 +#define TlX4 0x30 +#define TlX5 0x38 +#define TlX6 0x40 +#define TlX7 0x48 +#define TlFp 0x50 +#define TlLr 0x58 +#define TlSp 0x60 +#define TlPc 0x68 +#define TRAP_TYPE_INTERRUPT 0x1 +#define TRAP_TYPE_SYSCALL 0x2 +#define TRAP_TYPE_UNDEFINED 0x3 +#define TRAP_TYPE_DATA_ABORT 0x4 +#define TRAP_TYPE_PREFETCH_ABORT 0x5 +#define TRAP_TYPE_RESET 0x6 +#define TRAP_TYPE_FIQ 0x7 +#define PcInterruptCount 0x1900 +#define PcDebuggerSavedIRQL 0x1919 +#define PcDeferredReadyListHead 0x1408 +#define PcInterruptCount 0x1900 +#define PcSystemCalls 0x1438 +#define PcDpcRoutineActive 0x151a +#define PcDeferredReadyListHead 0x1408 +#define PcSkipTick 0x1918 +#define PcStartCycles 0x1948 +#define PcSpBase 0x1500 +#define ProcessorControlRegisterLength 0x2a940 + +// +// Defines for user shared data +// + +#define USER_SHARED_DATA 0xfffff78000000000 +#define MM_SHARED_USER_DATA_VA 0x000000007ffe0000 +#define UsTickCountMultiplier 0x4 +#define UsTickCount 0x320 +#define UsInterruptTime 0x8 +#define UsSystemTime 0x14 +#define UsProcessorFeatures 0x274 + +// +// Defines for user address space. +// + +#define MM_LOWEST_USER_ADDRESS 0x0000000000010000 + +#define ARM64_CPACR_VFP_MASK 0x300000 +#define ARM64_CPACR_VFP_MASK_BIT 0x14 + +// +// Processor Block Structure Offset Definitions +// + +#define PbNestingLevel 0x20 +#define PbIdleHalt 0x2 +#define PbCurrentThread 0x8 +#define PbNextThread 0x10 +#define PbIdleThread 0x18 +#define PbNumber 0x24 +#define PbPrcbLock 0x28 +#define PbKeSpinLockOrdering 0xc74 +#define KI_SPINLOCK_ORDER_PRCB_LOCK 0x200 +#define PbProcessorState 0x40 +#define PbHalReserved 0x710 +#define PbMinorVersion 0x760 +#define PbMajorVersion 0x762 +#define PbBuildType 0x764 +#define PbCoresPerPhysicalProcessor 0x790 +#define PbLogicalProcessorsPerCore 0x794 +#define PbPriorityState 0x30 +#define PbLockQueue 0x800 +#define PbPPLookasideList 0x980 +#define PbPPNPagedLookasideList 0x6a00 +#define PbPPPagedLookasideList 0x7600 +#define PbPacketBarrier 0xa80 +#define PbDeferredReadyListHead 0xa88 +#define PbLookasideIrpFloat 0xad8 +#define PbRequestMailbox 0x9f80 +#define PbMailbox 0xb00 +#define PbDpcGate 0xc00 +#define PbWaitListHead 0xc80 +#define PbCcFastMdlReadNoWait 0x1380 +#define PbPowerState 0x1400 +#define PbSpinLockAcquireCount 0x1a80 +#define PbSystemCalls 0xab8 +#define PbReadOperationCount 0xadc +#define PbWriteOperationCount 0xae0 +#define PbOtherOperationCount 0xae4 +#define PbReadTransferCount 0xae8 +#define PbWriteTransferCount 0xaf0 +#define PbOtherTransferCount 0xaf8 +#define PbContextSwitches 0xabc +#define PbIpiFrozen 0xb0c +#define PbDpcList 0xb18 +#define PbDpcLock 0xb28 +#define PbDpcCount 0xb34 +#define PbDpcStack 0xb78 +#define PbSpBase 0xb80 +#define PbMaximumDpcQueueDepth 0xb88 +#define PbDpcRequestRate 0xb8c +#define PbMinimumDpcRate 0xb90 +#define PbDpcRoutineActive 0xb9a +#define PbDpcRequestSummary 0xb9c +#define PbNormalDpcState 0xb9c +#define PbDpcLastCount 0xb94 +#define PbQuantumEnd 0xb99 +#define PbIdleSchedule 0xb9b +#define PbDispatcherReadyListHead 0xd80 +#define PbInterruptCount 0xf80 +#define PbKernelTime 0xf84 +#define PbUserTime 0xf88 +#define PbDpcTime 0xf8c +#define PbInterruptTime 0xf90 +#define PbAdjustDpcThreshold 0xf94 +#define PbStartCycles 0xfc8 +#define PbPageColor 0x1160 +#define PbNodeColor 0x1164 +#define PbCycleTime 0x1170 +#define PbFastReadNoWait 0xac0 +#define PbFastReadWait 0xac4 +#define PbFastReadNotPossible 0xac8 +#define PbCopyReadNoWait 0xacc +#define PbCopyReadWait 0xad0 +#define PbCopyReadNoWaitMiss 0xad4 +#define PbAlignmentFixupCount 0x1678 +#define PbExceptionDispatchCount 0xfb4 +#define PbProcessorVendorString 0x910 +#define PbFeatureBits 0x914 +#define PbPanicStackBase 0x1b58 + +// +// KTHREAD state +// + +#define Initialized 0x0 +#define Ready 0x1 +#define Running 0x2 +#define Standby 0x3 +#define Terminated 0x4 +#define Waiting 0x5 +#define Transition 0x6 +#define DeferredReady 0x7 +#define GateWaitObsolete 0x8 +#define THREAD_FLAGS_CYCLE_PROFILING_BIT 0x0 + +// +// Immediate Interprocessor Command Definitions +// + +#define IPI_APC 0x1 +#define IPI_DPC 0x2 +#define IPI_FREEZE 0x4 +#define IPI_PACKET_READY 0x5 + +// +// Processor Idle Times Offset Definitions +// + +#define PiStartTime 0x0 +#define PiEndTime 0x8 + +// +// Immediate Interprocessor Command Definitions +// + +#define IPI_PACKET_READY 0x5 +#define KI_USER_PER_PROCESS_IP_AUTH_ENABLED_BIT 0x0 +#define KI_USER_GLOBAL_IP_AUTH_ENABLED_BIT 0x1 +#define KI_KERNEL_IP_AUTH_ENABLED_BIT 0x2 + +// +// Time Fields (TIME_FIELDS) Structure Offset Definitions +// + +#define TfSecond 0xa +#define TfMinute 0x8 +#define TfHour 0x6 +#define TfWeekday 0xe +#define TfDay 0x4 +#define TfMonth 0x2 +#define TfYear 0x0 +#define TfMilliseconds 0xc + + +// +// CPSR mode constants +// + +#define CPSRM_EL3h 0xd +#define CPSRM_EL3t 0xc +#define CPSRM_EL2h 0x9 +#define CPSRM_EL2t 0x8 +#define CPSRM_EL1h 0x5 +#define CPSRM_EL1t 0x4 +#define CPSRM_EL0t 0x0 +#define CPSRM_MASK 0xf +#define SYSCALL_PSR 0x0 +#define CPSREL_3 0xc +#define CPSREL_2 0x8 +#define CPSREL_1 0x4 +#define CPSREL_0 0x0 +#define CPSREL_MASK 0xc +#define CPSREL_1_BIT 0x2 + +// +// DAIF enable/disables +// + +#define DAIF_DEBUG 0x200 +#define DAIF_ABORT 0x100 +#define DAIF_INT 0x80 +#define DAIF_FIQ 0x40 +#define DAIF_DEBUG_BIT 0x9 +#define DAIF_ABORT_BIT 0x8 +#define DAIF_INT_BIT 0x7 +#define DAIF_FIQ_BIT 0x6 + +// +// NZCV flags +// + +#define NZCV_N 0x80000000 +#define NZCV_Z 0x40000000 +#define NZCV_C 0x20000000 +#define NZCV_V 0x10000000 +#define NZCV_N_BIT 0x1f +#define NZCV_Z_BIT 0x1e +#define NZCV_C_BIT 0x1d +#define NZCV_V_BIT 0x1c + +// +// New ARM64 CSPR flags +// + +#define CPSRM_T 0x20 +#define CPSRM_AA32 0x10 +#define CPSR_IL 0x100000 +#define CPSR_SS 0x200000 +#define CPSR_SSBS32 0x800000 +#define CPSR_SSBS64 0x1000 +#define CPSR_IL_BIT 0x14 +#define CPSR_SS_BIT 0x15 +#define CPSR_SSBS32_BIT 0x17 +#define CPSR_SSBS64_BIT 0xc + +// +// FPCR modes +// + +#define FPCRM_AHP 0x4000000 +#define FPCRM_DN 0x2000000 +#define FPCRM_FZ 0x1000000 +#define FPCRM_AHP_BIT 0x1a +#define FPCRM_DN_BIT 0x19 +#define FPCRM_FZ_BIT 0x18 +#define FPCRM_RMODE_MASK 0xc00000 +#define FPCRM_RMODE_RN 0x0 +#define FPCRM_RMODE_RP 0x400000 +#define FPCRM_RMODE_RM 0x800000 +#define FPCRM_RMODE_RZ 0xc00000 + +// +// FPCR exception controls +// + +#define FPCR_IDE 0x8000 +#define FPCR_IXE 0x1000 +#define FPCR_UFE 0x800 +#define FPCR_OFE 0x400 +#define FPCR_DZE 0x200 +#define FPCR_IOE 0x100 + +// +// FPSR exception states +// + +#define FPSR_IDC 0x80 +#define FPSR_IXC 0x10 +#define FPSR_UFC 0x8 +#define FPSR_OFC 0x4 +#define FPSR_DZC 0x2 +#define FPSR_IOC 0x1 + +// +// ARMv8-A Architecture (System Registers) +// + + +// +// A64 Base Instruction Descriptions +// + + +// +// Special-purpose registers +// + +#define ARM64_CurrentEL 0x4212 +#define ARM64_DAIF 0x5a11 +#define ARM64_DIT 0x5a15 +#define ARM64_DLR 0x5a29 +#define ARM64_DSPSR 0x5a28 +#define ARM64_ELR_EL1 0x4201 +#define ARM64_ELR_EL2 0x6201 +#define ARM64_FPCR 0x5a20 +#define ARM64_FPSR 0x5a21 +#define ARM64_NZCV 0x5a10 +#define ARM64_PAN 0x4213 +#define ARM64_SP_EL0 0x4208 +#define ARM64_SP_EL1 0x6208 +#define ARM64_SP_EL2 0x7208 +#define ARM64_SPSel 0x4210 +#define ARM64_SPSR_EL1 0x4200 +#define ARM64_SPSR_EL2 0x6200 +#define ARM64_SSBS 0x5a16 +#define ARM64_TCO 0x5a17 +#define ARM64_UAO 0x4214 + +// +// AArch64 System Register Descriptions +// + + +// +// ID Registers +// + +#define ARM64_ID_AA64AFR0_EL1 0x402c +#define ARM64_ID_AA64AFR1_EL1 0x402d +#define ARM64_ID_AA64DFR0_EL1 0x4028 +#define ARM64_ID_AA64DFR1_EL1 0x4029 +#define ARM64_ID_AA64ISAR0_EL1 0x4030 +#define ARM64_ID_AA64ISAR1_EL1 0x4031 +#define ARM64_ID_AA64ISAR2_EL1 0x4032 +#define ARM64_ID_AA64MMFR0_EL1 0x4038 +#define ARM64_ID_AA64MMFR1_EL1 0x4039 +#define ARM64_ID_AA64MMFR2_EL1 0x403a +#define ARM64_ID_AA64PFR0_EL1 0x4020 +#define ARM64_ID_AA64PFR1_EL1 0x4021 +#define ARM64_ID_AA64SMFR0_EL1 0x4025 +#define ARM64_ID_AA64ZFR0_EL1 0x4024 + +// +// General system control registers (minus the ID registers) +// + +#define ARM64_ACCDATA_EL1 0x4685 +#define ARM64_ACTLR_EL1 0x4081 +#define ARM64_ACTLR_EL2 0x6081 +#define ARM64_AFSR0_EL1 0x4288 +#define ARM64_AFSR0_EL2 0x6288 +#define ARM64_AFSR1_EL1 0x4289 +#define ARM64_AFSR1_EL2 0x6289 +#define ARM64_AIDR_EL1 0x4807 +#define ARM64_AMAIR_EL1 0x4518 +#define ARM64_AMAIR_EL2 0x6518 +#define ARM64_APDAKeyHi_EL1 0x4111 +#define ARM64_APDAKeyLo_EL1 0x4110 +#define ARM64_APDBKeyHi_EL1 0x4113 +#define ARM64_APDBKeyLo_EL1 0x4112 +#define ARM64_APGAKeyHi_EL1 0x4119 +#define ARM64_APGAKeyLo_EL1 0x4118 +#define ARM64_APIAKeyHi_EL1 0x4109 +#define ARM64_APIAKeyLo_EL1 0x4108 +#define ARM64_APIBKeyHi_EL1 0x410b +#define ARM64_APIBKeyLo_EL1 0x410a +#define ARM64_CCSIDR_EL1 0x4800 +#define ARM64_CLIDR_EL1 0x4801 +#define ARM64_CONTEXTIDR_EL1 0x4681 +#define ARM64_CONTEXTIDR_EL2 0x6681 +#define ARM64_CPACR_EL1 0x4082 +#define ARM64_CPTR_EL2 0x608a +#define ARM64_CSSELR_EL1 0x5000 +#define ARM64_CTR_EL0 0x5801 +#define ARM64_DACR32_EL2 0x6180 +#define ARM64_DCZID_EL0 0x5807 +#define ARM64_ESR_EL1 0x4290 +#define ARM64_ESR_EL2 0x6290 +#define ARM64_FAR_EL1 0x4300 +#define ARM64_FAR_EL2 0x6300 +#define ARM64_FPEXC32_EL2 0x6298 +#define ARM64_GCR_EL1 0x4086 +#define ARM64_GMID_EL1 0x4804 +#define ARM64_HACR_EL2 0x608f +#define ARM64_HAFGRTR_EL2 0x618e +#define ARM64_HCR_EL2 0x6088 +#define ARM64_HCRX_EL2 0x6092 +#define ARM64_HDFGRTR_EL2 0x618c +#define ARM64_HDFGWTR_EL2 0x618d +#define ARM64_HFGITR_EL2 0x608e +#define ARM64_HFGRTR_EL2 0x608c +#define ARM64_HFGWTR_EL2 0x608d +#define ARM64_HPFAR_EL2 0x6304 +#define ARM64_HSTR_EL2 0x608b +#define ARM64_IFSR32_EL2 0x6281 +#define ARM64_ISR_EL1 0x4608 +#define ARM64_LORC_EL1 0x4523 +#define ARM64_LOREA_EL1 0x4521 +#define ARM64_LORID_EL1 0x4527 +#define ARM64_LORN_EL1 0x4522 +#define ARM64_LORSA_EL1 0x4520 +#define ARM64_MAIR_EL1 0x4510 +#define ARM64_MAIR_EL2 0x6510 +#define ARM64_MIDR_EL1 0x4000 +#define ARM64_MPIDR_EL1 0x4005 +#define ARM64_MVFR0_EL1 0x4018 +#define ARM64_MVFR1_EL1 0x4019 +#define ARM64_MVFR2_EL1 0x401a +#define ARM64_PAR_EL1 0x43a0 +#define ARM64_REVIDR_EL1 0x4006 +#define ARM64_RGSR_EL1 0x4085 +#define ARM64_RNDR 0x5920 +#define ARM64_RNDRRS 0x5921 +#define ARM64_SCTLR_EL1 0x4080 +#define ARM64_SCTLR_EL2 0x6080 +#define ARM64_SCXTNUM_EL0 0x5e87 +#define ARM64_SCXTNUM_EL1 0x4687 +#define ARM64_SCXTNUM_EL2 0x6687 +#define ARM64_SMCR_EL1 0x4096 +#define ARM64_SMCR_EL2 0x6096 +#define ARM64_SMIDR_EL1 0x4806 +#define ARM64_SMPRI_EL1 0x4094 +#define ARM64_SMPRIMAP_EL2 0x6095 +#define ARM64_TCR_EL1 0x4102 +#define ARM64_TCR_EL2 0x6102 +#define ARM64_TFSRE0_EL1 0x42b1 +#define ARM64_TFSR_EL1 0x42b0 +#define ARM64_TFSR_EL2 0x6330 +#define ARM64_TPIDR2_EL0 0x5e85 +#define ARM64_TPIDR_EL0 0x5e82 +#define ARM64_TPIDR_EL1 0x4684 +#define ARM64_TPIDR_EL2 0x6682 +#define ARM64_TPIDRRO_EL0 0x5e83 +#define ARM64_TTBR0_EL1 0x4100 +#define ARM64_TTBR0_EL2 0x6100 +#define ARM64_TTBR1_EL1 0x4101 +#define ARM64_VBAR_EL1 0x4600 +#define ARM64_VBAR_EL2 0x6600 +#define ARM64_VMPIDR_EL2 0x6005 +#define ARM64_VNCR_EL2 0x6110 +#define ARM64_VPIDR_EL2 0x6000 +#define ARM64_VSTCR_EL2 0x6132 +#define ARM64_VSTTBR_EL2 0x6130 +#define ARM64_VTCR_EL2 0x610a +#define ARM64_VTTBR_EL2 0x6108 +#define ARM64_ZCR_EL1 0x4090 +#define ARM64_ZCR_EL2 0x6090 + +// +// Debug Registers +// + +#define ARM64_DBGAUTHSTATUS_EL1 0x3f6 +#define ARM64_DBGBCR0_EL1 0x5 +#define ARM64_DBGBCR1_EL1 0xd +#define ARM64_DBGBCR2_EL1 0x15 +#define ARM64_DBGBCR3_EL1 0x1d +#define ARM64_DBGBCR4_EL1 0x25 +#define ARM64_DBGBCR5_EL1 0x2d +#define ARM64_DBGBCR6_EL1 0x35 +#define ARM64_DBGBCR7_EL1 0x3d +#define ARM64_DBGBCR8_EL1 0x45 +#define ARM64_DBGBCR9_EL1 0x4d +#define ARM64_DBGBCR10_EL1 0x55 +#define ARM64_DBGBCR11_EL1 0x5d +#define ARM64_DBGBCR12_EL1 0x65 +#define ARM64_DBGBCR13_EL1 0x6d +#define ARM64_DBGBCR14_EL1 0x75 +#define ARM64_DBGBCR15_EL1 0x7d +#define ARM64_DBGBVR0_EL1 0x4 +#define ARM64_DBGBVR1_EL1 0xc +#define ARM64_DBGBVR2_EL1 0x14 +#define ARM64_DBGBVR3_EL1 0x1c +#define ARM64_DBGBVR4_EL1 0x24 +#define ARM64_DBGBVR5_EL1 0x2c +#define ARM64_DBGBVR6_EL1 0x34 +#define ARM64_DBGBVR7_EL1 0x3c +#define ARM64_DBGBVR8_EL1 0x44 +#define ARM64_DBGBVR9_EL1 0x4c +#define ARM64_DBGBVR10_EL1 0x54 +#define ARM64_DBGBVR11_EL1 0x5c +#define ARM64_DBGBVR12_EL1 0x64 +#define ARM64_DBGBVR13_EL1 0x6c +#define ARM64_DBGBVR14_EL1 0x74 +#define ARM64_DBGBVR15_EL1 0x7c +#define ARM64_DBGCLAIMCLR_EL1 0x3ce +#define ARM64_DBGCLAIMSET_EL1 0x3c6 +#define ARM64_DBGDTRRX_EL0 0x1828 +#define ARM64_DBGDTRTX_EL0 0x1828 +#define ARM64_DBGPRCR_EL1 0xa4 +#define ARM64_DBGVCR32_EL2 0x2038 +#define ARM64_DBGWCR0_EL1 0x7 +#define ARM64_DBGWCR1_EL1 0xf +#define ARM64_DBGWCR2_EL1 0x17 +#define ARM64_DBGWCR3_EL1 0x1f +#define ARM64_DBGWCR4_EL1 0x27 +#define ARM64_DBGWCR5_EL1 0x2f +#define ARM64_DBGWCR6_EL1 0x37 +#define ARM64_DBGWCR7_EL1 0x3f +#define ARM64_DBGWCR8_EL1 0x47 +#define ARM64_DBGWCR9_EL1 0x4f +#define ARM64_DBGWCR10_EL1 0x57 +#define ARM64_DBGWCR11_EL1 0x5f +#define ARM64_DBGWCR12_EL1 0x67 +#define ARM64_DBGWCR13_EL1 0x6f +#define ARM64_DBGWCR14_EL1 0x77 +#define ARM64_DBGWCR15_EL1 0x7f +#define ARM64_DBGWVR0_EL1 0x6 +#define ARM64_DBGWVR1_EL1 0xe +#define ARM64_DBGWVR2_EL1 0x16 +#define ARM64_DBGWVR3_EL1 0x1e +#define ARM64_DBGWVR4_EL1 0x26 +#define ARM64_DBGWVR5_EL1 0x2e +#define ARM64_DBGWVR6_EL1 0x36 +#define ARM64_DBGWVR7_EL1 0x3e +#define ARM64_DBGWVR8_EL1 0x46 +#define ARM64_DBGWVR9_EL1 0x4e +#define ARM64_DBGWVR10_EL1 0x56 +#define ARM64_DBGWVR11_EL1 0x5e +#define ARM64_DBGWVR12_EL1 0x66 +#define ARM64_DBGWVR13_EL1 0x6e +#define ARM64_DBGWVR14_EL1 0x76 +#define ARM64_DBGWVR15_EL1 0x7e +#define ARM64_DLR_EL0 0x5a29 +#define ARM64_DSPSR_EL0 0x5a28 +#define ARM64_MDCCINT_EL1 0x10 +#define ARM64_MDCCSR_EL0 0x1808 +#define ARM64_MDCR_EL2 0x6089 +#define ARM64_MDRAR_EL1 0x80 +#define ARM64_MDSCR_EL1 0x12 +#define ARM64_OSDLR_EL1 0x9c +#define ARM64_OSDTRRX_EL1 0x2 +#define ARM64_OSDTRTX_EL1 0x1a +#define ARM64_OSECCR_EL1 0x32 +#define ARM64_OSLAR_EL1 0x84 +#define ARM64_OSLSR_EL1 0x8c +#define ARM64_SDER32_EL2 0x6099 +#define ARM64_TRFCR_EL1 0x4091 +#define ARM64_TRFCR_EL2 0x6091 + +// +// Trace Registers +// + + +// +// Performance Monitors Registers +// + +#define ARM64_PMCCFILTR_EL0 0x5f7f +#define ARM64_PMCCNTR_EL0 0x5ce8 +#define ARM64_PMCEID0_EL0 0x5ce6 +#define ARM64_PMCEID1_EL0 0x5ce7 +#define ARM64_PMCNTENCLR_EL0 0x5ce2 +#define ARM64_PMCNTENSET_EL0 0x5ce1 +#define ARM64_PMCR_EL0 0x5ce0 +#define ARM64_PMEVCNTR0_EL0 0x5f40 +#define ARM64_PMEVCNTR1_EL0 0x5f41 +#define ARM64_PMEVCNTR2_EL0 0x5f42 +#define ARM64_PMEVCNTR3_EL0 0x5f43 +#define ARM64_PMEVCNTR4_EL0 0x5f44 +#define ARM64_PMEVCNTR5_EL0 0x5f45 +#define ARM64_PMEVCNTR6_EL0 0x5f46 +#define ARM64_PMEVCNTR7_EL0 0x5f47 +#define ARM64_PMEVCNTR8_EL0 0x5f48 +#define ARM64_PMEVCNTR9_EL0 0x5f49 +#define ARM64_PMEVCNTR10_EL0 0x5f4a +#define ARM64_PMEVCNTR11_EL0 0x5f4b +#define ARM64_PMEVCNTR12_EL0 0x5f4c +#define ARM64_PMEVCNTR13_EL0 0x5f4d +#define ARM64_PMEVCNTR14_EL0 0x5f4e +#define ARM64_PMEVCNTR15_EL0 0x5f4f +#define ARM64_PMEVCNTR16_EL0 0x5f50 +#define ARM64_PMEVCNTR17_EL0 0x5f51 +#define ARM64_PMEVCNTR18_EL0 0x5f52 +#define ARM64_PMEVCNTR19_EL0 0x5f53 +#define ARM64_PMEVCNTR20_EL0 0x5f54 +#define ARM64_PMEVCNTR21_EL0 0x5f55 +#define ARM64_PMEVCNTR22_EL0 0x5f56 +#define ARM64_PMEVCNTR23_EL0 0x5f57 +#define ARM64_PMEVCNTR24_EL0 0x5f58 +#define ARM64_PMEVCNTR25_EL0 0x5f59 +#define ARM64_PMEVCNTR26_EL0 0x5f5a +#define ARM64_PMEVCNTR27_EL0 0x5f5b +#define ARM64_PMEVCNTR28_EL0 0x5f5c +#define ARM64_PMEVCNTR29_EL0 0x5f5d +#define ARM64_PMEVCNTR30_EL0 0x5f5e +#define ARM64_PMEVTYPER0_EL0 0x5f60 +#define ARM64_PMEVTYPER1_EL0 0x5f61 +#define ARM64_PMEVTYPER2_EL0 0x5f62 +#define ARM64_PMEVTYPER3_EL0 0x5f63 +#define ARM64_PMEVTYPER4_EL0 0x5f64 +#define ARM64_PMEVTYPER5_EL0 0x5f65 +#define ARM64_PMEVTYPER6_EL0 0x5f66 +#define ARM64_PMEVTYPER7_EL0 0x5f67 +#define ARM64_PMEVTYPER8_EL0 0x5f68 +#define ARM64_PMEVTYPER9_EL0 0x5f69 +#define ARM64_PMEVTYPER10_EL0 0x5f6a +#define ARM64_PMEVTYPER11_EL0 0x5f6b +#define ARM64_PMEVTYPER12_EL0 0x5f6c +#define ARM64_PMEVTYPER13_EL0 0x5f6d +#define ARM64_PMEVTYPER14_EL0 0x5f6e +#define ARM64_PMEVTYPER15_EL0 0x5f6f +#define ARM64_PMEVTYPER16_EL0 0x5f70 +#define ARM64_PMEVTYPER17_EL0 0x5f71 +#define ARM64_PMEVTYPER18_EL0 0x5f72 +#define ARM64_PMEVTYPER19_EL0 0x5f73 +#define ARM64_PMEVTYPER20_EL0 0x5f74 +#define ARM64_PMEVTYPER21_EL0 0x5f75 +#define ARM64_PMEVTYPER22_EL0 0x5f76 +#define ARM64_PMEVTYPER23_EL0 0x5f77 +#define ARM64_PMEVTYPER24_EL0 0x5f78 +#define ARM64_PMEVTYPER25_EL0 0x5f79 +#define ARM64_PMEVTYPER26_EL0 0x5f7a +#define ARM64_PMEVTYPER27_EL0 0x5f7b +#define ARM64_PMEVTYPER28_EL0 0x5f7c +#define ARM64_PMEVTYPER29_EL0 0x5f7d +#define ARM64_PMEVTYPER30_EL0 0x5f7e +#define ARM64_PMINTENCLR_EL1 0x44f2 +#define ARM64_PMINTENSET_EL1 0x44f1 +#define ARM64_PMMIR_EL1 0x44f6 +#define ARM64_PMOVSCLR_EL0 0x5ce3 +#define ARM64_PMOVSSET_EL0 0x5cf3 +#define ARM64_PMSELR_EL0 0x5ce5 +#define ARM64_PMSWINC_EL0 0x5ce4 +#define ARM64_PMUSERENR_EL0 0x5cf0 +#define ARM64_PMXEVCNTR_EL0 0x5cea +#define ARM64_PMXEVTYPER_EL0 0x5ce9 + +// +// Activity Monitors registers +// + +#define ARM64_AMCNTENSET0_EL0 0x5e95 +#define ARM64_AMEVCNTR00_EL0 0x5ea0 +#define ARM64_AMEVCNTR01_EL0 0x5ea1 +#define ARM64_AMEVCNTR02_EL0 0x5ea2 +#define ARM64_AMEVCNTR03_EL0 0x5ea3 +#define ARM64_AMUSERENR_EL0 0x5e93 + +// +// Statistical Profiling Extensions +// + +#define ARM64_PMBIDR_EL1 0x44d7 +#define ARM64_PMBLIMITR_EL1 0x44d0 +#define ARM64_PMBPTR_EL1 0x44d1 +#define ARM64_PMBSR_EL1 0x44d3 +#define ARM64_PMSCR_EL1 0x44c8 +#define ARM64_PMSCR_EL2 0x64c8 +#define ARM64_PMSEVFR_EL1 0x44cd +#define ARM64_PMSFCR_EL1 0x44cc +#define ARM64_PMSICR_EL1 0x44ca +#define ARM64_PMSIDR_EL1 0x44cf +#define ARM64_PMSIRR_EL1 0x44cb +#define ARM64_PMSLATFR_EL1 0x44ce +#define ARM64_PMSNEVFR_EL1 0x44c9 + +// +// Branch Record Buffer Extension Registers +// + + +// +// RAS Registers +// + +#define ARM64_DISR_EL1 0x4609 +#define ARM64_ERRIDR_EL1 0x4298 +#define ARM64_ERRSELR_EL1 0x4299 +#define ARM64_ERXADDR_EL1 0x42a3 +#define ARM64_ERXCTLR_EL1 0x42a1 +#define ARM64_ERRXFR_EL1 0x42a0 +#define ARM64_ERXMISC0_EL1 0x42a8 +#define ARM64_ERXMISC1_EL1 0x42a9 +#define ARM64_ERXMISC2_EL1 0x42aa +#define ARM64_ERXPFGCDN_EL1 0x42a6 +#define ARM64_ERXPFGCTL_EL1 0x42a5 +#define ARM64_ERXPFGF_EL1 0x42a4 +#define ARM64_ERXSTATUS_EL1 0x42a2 +#define ARM64_VDISR_EL2 0x6609 +#define ARM64_VSESR_EL2 0x6293 + +// +// Realm Management Extension Registers +// + + +// +// Generic Timer Registers +// + +#define ARM64_CNTFRQ_EL0 0x5f00 +#define ARM64_CNTHCTL_EL2 0x6708 +#define ARM64_CNTHP_CTL_EL2 0x6711 +#define ARM64_CNTHP_CVAL_EL2 0x6712 +#define ARM64_CNTHP_TVAL_EL2 0x6710 +#define ARM64_CNTHV_CTL_EL2 0x6719 +#define ARM64_CNTHV_CVAL_EL2 0x671a +#define ARM64_CNTHV_TVAL_EL2 0x6718 +#define ARM64_CNTKCTL_EL1 0x4708 +#define ARM64_CNTP_CTL_EL0 0x5f11 +#define ARM64_CNTP_CVAL_EL0 0x5f12 +#define ARM64_CNTP_TVAL_EL0 0x5f10 +#define ARM64_CNTPCT_EL0 0x5f01 +#define ARM64_CNTPOFF_EL2 0x6706 +#define ARM64_CNTV_CTL_EL0 0x5f19 +#define ARM64_CNTV_CVAL_EL0 0x5f1a +#define ARM64_CNTV_TVAL_EL0 0x5f18 +#define ARM64_CNTVCT_EL0 0x5f02 +#define ARM64_CNTVOFF_EL2 0x6703 +#define ARM64_CNTV_OFF_EL2 0x6703 +#define ARM64_CNTK_CTL_EL1 0x4708 +#define ARM64_CNT_HCTL_EL2 0x6708 +#define ARM64_CNTVCT 0x5f02 +#define ARM64_CNTKCTL 0x4708 +#define ARM64_CNTV_CTL 0x5f19 +#define ARM64_CNTV_CVAL 0x5f1a + +// +// AArch32 System Register Descriptions +// + + +// +// ID Registers +// + +#define ARM64_ID_DFR0_EL1 0x400a +#define ARM64_ID_DFR1_EL1 0x401d +#define ARM64_ID_ISAR0_EL1 0x4010 +#define ARM64_ID_ISAR1_EL1 0x4011 +#define ARM64_ID_ISAR2_EL1 0x4012 +#define ARM64_ID_ISAR3_EL1 0x4013 +#define ARM64_ID_ISAR4_EL1 0x4014 +#define ARM64_ID_ISAR5_EL1 0x4015 +#define ARM64_ID_ISAR6_EL1 0x4017 +#define ARM64_ID_MMFR0_EL1 0x400c +#define ARM64_ID_MMFR1_EL1 0x400d +#define ARM64_ID_MMFR2_EL1 0x400e +#define ARM64_ID_MMFR3_EL1 0x400f +#define ARM64_ID_MMFR4_EL1 0x4016 +#define ARM64_ID_MMFR5_EL1 0x401e +#define ARM64_ID_PFR0_EL1 0x4008 +#define ARM64_ID_PFR1_EL1 0x4009 +#define ARM64_ID_PFR2_EL1 0x401c +#define ARM64_MVFR0_EL1 0x4018 +#define ARM64_MVFR1_EL1 0x4019 +#define ARM64_MVFR2_EL1 0x401a + +// +// ARM GIC (System Registers) +// + + +// +// AArch64 System Register Descriptions +// + +#define ARM64_ICC_AP1R0_EL1 0x4648 +#define ARM64_ICC_AP1R1_EL1 0x4649 +#define ARM64_ICC_AP1R2_EL1 0x464a +#define ARM64_ICC_AP1R3_EL1 0x464b +#define ARM64_ICC_ASGI1R_EL1 0x465e +#define ARM64_ICC_BPR1_EL1 0x4663 +#define ARM64_ICC_CTLR_EL1 0x4664 +#define ARM64_ICC_DIR_EL1 0x4659 +#define ARM64_ICC_EOIR1_EL1 0x4661 +#define ARM64_ICC_HPPIR1_EL1 0x4662 +#define ARM64_ICC_IAR1_EL1 0x4660 +#define ARM64_ICC_IGRPEN1_EL1 0x4667 +#define ARM64_ICC_PMR_EL1 0x4230 +#define ARM64_ICC_RPR_EL1 0x465b +#define ARM64_ICC_SGI1R_EL1 0x465d +#define ARM64_ICC_SRE_EL1 0x4665 +#define ARM64_ICC_SRE_EL2 0x664d + +// +// AArch64 Virtualization Control System Registers +// + +#define ARM64_ICH_AP1R0_EL2 0x6648 +#define ARM64_ICH_AP1R1_EL2 0x6649 +#define ARM64_ICH_AP1R2_EL2 0x664a +#define ARM64_ICH_AP1R3_EL2 0x664b +#define ARM64_ICH_EISR_EL2 0x665b +#define ARM64_ICH_ELRSR_EL2 0x665d +#define ARM64_ICH_HCR_EL2 0x6658 +#define ARM64_ICH_LR0_EL2 0x6660 +#define ARM64_ICH_LR1_EL2 0x6661 +#define ARM64_ICH_LR2_EL2 0x6662 +#define ARM64_ICH_LR3_EL2 0x6663 +#define ARM64_ICH_LR4_EL2 0x6664 +#define ARM64_ICH_LR5_EL2 0x6665 +#define ARM64_ICH_LR6_EL2 0x6666 +#define ARM64_ICH_LR7_EL2 0x6667 +#define ARM64_ICH_LR8_EL2 0x6668 +#define ARM64_ICH_LR9_EL2 0x6669 +#define ARM64_ICH_LR10_EL2 0x666a +#define ARM64_ICH_LR11_EL2 0x666b +#define ARM64_ICH_LR12_EL2 0x666c +#define ARM64_ICH_LR13_EL2 0x666d +#define ARM64_ICH_LR14_EL2 0x666e +#define ARM64_ICH_LR15_EL2 0x666f +#define ARM64_ICH_MISR_EL2 0x665a +#define ARM64_ICH_VMCR_EL2 0x665f +#define ARM64_ICH_VTR_EL2 0x6659 + +// +// AArch64 Memory Partitioning and Monitoring (MPAM) System Registers +// + +#define ARM64_MPAM0_EL1 0x4529 +#define ARM64_MPAM1_EL1 0x4528 +#define ARM64_MPAM2_EL2 0x6528 +#define ARM64_MPAM3_EL3 0x7528 +#define ARM64_MPAM1_EL12 0x6d28 +#define ARM64_MPAMHCR_EL2 0x6520 +#define ARM64_MPAMIDR_EL1 0x4524 +#define ARM64_MPAMVPM0_EL2 0x6530 +#define ARM64_MPAMVPM1_EL2 0x6531 +#define ARM64_MPAMVPM2_EL2 0x6532 +#define ARM64_MPAMVPM3_EL2 0x6533 +#define ARM64_MPAMVPM4_EL2 0x6534 +#define ARM64_MPAMVPM5_EL2 0x6535 +#define ARM64_MPAMVPM6_EL2 0x6536 +#define ARM64_MPAMVPM7_EL2 0x6537 +#define ARM64_MPAMVPMV_EL2 0x6521 + +// +// Constants for flags for ARM64_MPAM0_EL1 +// + +#define ARM64_MPAM0_EL1_PARTID_I 0x000000000000ffff +#define ARM64_MPAM0_EL1_PARTID_D 0x00000000ffff0000 +#define ARM64_MPAM0_EL1_PMG_I 0x000000ff00000000 +#define ARM64_MPAM0_EL1_PMG_D 0x0000ff0000000000 + +// +// Constants for flags for ARM64_MPAM1_EL1 +// + +#define ARM64_MPAM1_EL1_PARTID_I 0x000000000000ffff +#define ARM64_MPAM1_EL1_PARTID_D 0x00000000ffff0000 +#define ARM64_MPAM1_EL1_PMG_I 0x000000ff00000000 +#define ARM64_MPAM1_EL1_PMG_D 0x0000ff0000000000 +#define ARM64_MPAM1_EL1_FORCED_NS 0x1000000000000000 +#define ARM64_MPAM1_EL1_MPAMEN 0x8000000000000000 + +// +// Constants for flags for ARM64_MPAM2_EL2 +// + +#define ARM64_MPAM2_EL2_PARTID_I 0x000000000000ffff +#define ARM64_MPAM2_EL2_PARTID_D 0x00000000ffff0000 +#define ARM64_MPAM2_EL2_PMG_I 0x000000ff00000000 +#define ARM64_MPAM2_EL2_PMG_D 0x0000ff0000000000 +#define ARM64_MPAM2_EL2_TRAPMPAM0EL1 0x0001000000000000 +#define ARM64_MPAM2_EL2_TRAPMPAM1EL1 0x0002000000000000 +#define ARM64_MPAM2_EL2_TIDR 0x0400000000000000 +#define ARM64_MPAM2_EL2_MPAMEN 0x8000000000000000 + +// +// Constants for flags for ARM64_MPAMHCR_EL2 +// + +#define ARM64_MPAMHCR_EL2_TRAP_MPAMIDR_EL1 0x0000000080000000 +#define ARM64_MPAMHCR_EL2_GSTAPP_PLK 0x0000000000000100 +#define ARM64_MPAMHCR_EL2_EL1_VPMEN 0x0000000000000002 +#define ARM64_MPAMHCR_EL2_EL0_VPMEN 0x0000000000000001 + +// +// ARMv8-A Architecture (System Instructions) +// + + +// +// A64 System instructions for cache maintenance +// + +#define ARM64_DC_CGDSW_EL1 0x3d6 +#define ARM64_DC_CGDVAC_EL1 0x1bd5 +#define ARM64_DC_CGDVADP_EL1 0x1bed +#define ARM64_DC_CGDVAP_EL1 0x1be5 +#define ARM64_DC_CGSW_EL1 0x3d4 +#define ARM64_DC_CGVAC_EL1 0x1bd3 +#define ARM64_DC_CGVADP_EL1 0x1beb +#define ARM64_DC_CGVAP_EL1 0x1be3 +#define ARM64_DC_CIGDSW_EL1 0x3f6 +#define ARM64_DC_CIGDVAC_EL1 0x1bf5 +#define ARM64_DC_CIGSW_EL1 0x3f4 +#define ARM64_DC_CIGVAC_EL1 0x1bf3 +#define ARM64_DC_CISW_EL1 0x3f2 +#define ARM64_DC_CIVAC_EL1 0x1bf1 +#define ARM64_DC_CSW_EL1 0x3d2 +#define ARM64_DC_CVAC_EL1 0x1bd1 +#define ARM64_DC_CVADP_EL1 0x1be9 +#define ARM64_DC_CVAP_EL1 0x1be1 +#define ARM64_DC_CVAU_EL1 0x1bd9 +#define ARM64_DC_GVA_EL1 0x1ba3 +#define ARM64_DC_GZVA_EL1 0x1ba4 +#define ARM64_DC_IGDSW_EL1 0x3b6 +#define ARM64_DC_IGDVAC_EL1 0x3b5 +#define ARM64_DC_IGSW_EL1 0x3b4 +#define ARM64_DC_IGVAC_EL1 0x3b3 +#define ARM64_DC_ISW_EL1 0x3b2 +#define ARM64_DC_IVAC_EL1 0x3b1 +#define ARM64_DC_ZVA_EL1 0x1ba1 +#define ARM64_IC_IALLU_EL1 0x3a8 +#define ARM64_IC_IALLUIS_EL1 0x388 +#define ARM64_IC_IVAU_EL1 0x1ba9 +#define ARM64_DC_ZVA 0x1ba1 +#define ARM64_DC_IVAC 0x3b1 +#define ARM64_DC_ISW 0x3b2 +#define ARM64_DC_CVAC 0x1bd1 +#define ARM64_DC_CSW 0x3d2 +#define ARM64_DC_CVAU 0x1bd9 +#define ARM64_DC_CIVAC 0x1bf1 +#define ARM64_DC_CISW 0x3f2 +#define ARM64_IC_IALLUIS 0x388 +#define ARM64_IC_IALLU 0x3a8 +#define ARM64_IC_IVAU 0x1ba9 + +// +// A64 System instructions for address translation +// + +#define ARM64_AT_S1E2R 0x23c0 +#define ARM64_AT_S1E2W 0x23c1 +#define ARM64_AT_S1E1R 0x3c0 +#define ARM64_AT_S1E1W 0x3c1 +#define ARM64_AT_S1E0R 0x3c2 +#define ARM64_AT_S1E0W 0x3c3 +#define ARM64_AT_S12E1R 0x23c4 +#define ARM64_AT_S12E1W 0x23c5 +#define ARM64_AT_S12E0R 0x23c6 +#define ARM64_AT_S12E0W 0x23c7 + +// +// A64 System instructions for TLB maintenance +// + +#define ARM64_TLBI_VMALLE1 0x438 +#define ARM64_TLBI_VAE1 0x439 +#define ARM64_TLBI_ASIDE1 0x43a +#define ARM64_TLBI_VAAE1 0x43b +#define ARM64_TLBI_VALE1 0x43d +#define ARM64_TLBI_VAALE1 0x43f +#define ARM64_TLBI_VMALLE1IS 0x418 +#define ARM64_TLBI_VAE1IS 0x419 +#define ARM64_TLBI_ASIDE1IS 0x41a +#define ARM64_TLBI_VAAE1IS 0x41b +#define ARM64_TLBI_VALE1IS 0x41d +#define ARM64_TLBI_VAALE1IS 0x41f +#define ARM64_TLBI_ALLE1 0x243c +#define ARM64_TLBI_VMALLS12E1 0x243e +#define ARM64_TLBI_IPAS2E1 0x2421 +#define ARM64_TLBI_IPAS2LE1 0x2425 +#define ARM64_TLBI_ALLE1IS 0x241c +#define ARM64_TLBI_VMALLS12E1IS 0x241e +#define ARM64_TLBI_IPAS2E1IS 0x2401 +#define ARM64_TLBI_IPAS2LE1IS 0x2405 +#define ARM64_TLBI_ALLE2 0x2438 +#define ARM64_TLBI_VAE2 0x2439 +#define ARM64_TLBI_VALE2 0x243d +#define ARM64_TLBI_ALLE2IS 0x2418 +#define ARM64_TLBI_VAE2IS 0x2419 +#define ARM64_TLBI_VALE2IS 0x241d + +// +// Constants for flags for ARM64_CPTR_EL2 +// + +#define ARM64_CPTR_TFP 0x0000000000000400 +#define ARM64_CPTR_TTA 0x0000000000100000 +#define ARM64_CPTR_TAM 0x0000000040000000 +#define ARM64_CPTR_CPAC 0x0000000080000000 + +// +// Constants for flags for ARM64_OSLSR_EL1 +// + +#define ARM64_OSLSR_LOCK_IMP 0x0000000000000001 +#define ARM64_OSLSR_LOCKED 0x0000000000000002 + +// +// Constants for flags for ARM64_CNT_HCTL_EL2 +// + +#define ARM64_CNT_HCTL_EL1PCTEN 0x0000000000000001 +#define ARM64_CNT_HCTL_EL1PCEN 0x0000000000000002 +#define ARM64_CNT_HCTL_EVNTEN 0x0000000000000004 +#define ARM64_CNT_HCTL_EVNTDIR 0x0000000000000008 +#define ARM64_CNT_HCTL_EVNTI_MASK 0x00000000000000f0 +#define ARM64_CNT_HCTL_EVNTI_SHIFT 0x0000000000000004 + +// +// Constants for flags for ??? +// + +#define ARM64_CNT_CTL_ENABLE 0x0000000000000001 +#define ARM64_CNT_CTL_IMASK 0x0000000000000002 +#define ARM64_CNT_CTL_ISTATUS 0x0000000000000004 + +// +// Constants for flags for ARM64_CNTK_CTL_EL1 +// + +#define ARM64_CNTK_CTL_EL0PCTEN 0x0000000000000001 +#define ARM64_CNTK_CTL_EL0VCTEN 0x0000000000000002 +#define ARM64_CNTK_CTL_EVNTEN 0x0000000000000004 +#define ARM64_CNTK_CTL_EVNTDIR 0x0000000000000008 +#define ARM64_CNTK_CTL_EVNTI_MASK 0x00000000000000f0 +#define ARM64_CNTK_CTL_EL0VTEN 0x0000000000000100 +#define ARM64_CNTK_CTL_EL0PTEN 0x0000000000000200 + +// +// Constants for flags in system control register. +// + +#define ARM64_SCTLR_M 0x0000000000000001 +#define ARM64_SCTLR_A 0x0000000000000002 +#define ARM64_SCTLR_C 0x0000000000000004 +#define ARM64_SCTLR_SA 0x0000000000000008 +#define ARM64_SCTLR_SA0 0x0000000000000010 +#define ARM64_SCTLR_CP15BEN 0x0000000000000020 +#define ARM64_SCTLR_NAA 0x0000000000000040 +#define ARM64_SCTLR_ITD 0x0000000000000080 +#define ARM64_SCTLR_SED 0x0000000000000100 +#define ARM64_SCTLR_UMA 0x0000000000000200 +#define ARM64_SCTLR_RES0_10 0x0000000000000400 +#define ARM64_SCTLR_RES1_11 0x0000000000000800 +#define ARM64_SCTLR_I 0x0000000000001000 +#define ARM64_SCTLR_EnDB 0x0000000000002000 +#define ARM64_SCTLR_DZE 0x0000000000004000 +#define ARM64_SCTLR_UCT 0x0000000000008000 +#define ARM64_SCTLR_nTWI 0x0000000000010000 +#define ARM64_SCTLR_RES0_17 0x0000000000020000 +#define ARM64_SCTLR_nTWE 0x0000000000040000 +#define ARM64_SCTLR_WXN 0x0000000000080000 +#define ARM64_SCTLR_RES1_20 0x0000000000100000 +#define ARM64_SCTLR_RES0_21 0x0000000000200000 +#define ARM64_SCTLR_RES1_22 0x0000000000400000 +#define ARM64_SCTLR_SPAN 0x0000000000800000 +#define ARM64_SCTLR_E0E 0x0000000001000000 +#define ARM64_SCTLR_EE 0x0000000002000000 +#define ARM64_SCTLR_UCI 0x0000000004000000 +#define ARM64_SCTLR_EnDA 0x0000000008000000 +#define ARM64_SCTLR_RES1_28 0x0000000010000000 +#define ARM64_SCTLR_RES1_29 0x0000000020000000 +#define ARM64_SCTLR_EnIB 0x0000000040000000 +#define ARM64_SCTLR_EnIB_BIT 0x1e +#define ARM64_SCTLR_EnIA 0x0000000080000000 +#define ARM64_SCTLR_RES0_32 0x0000000100000000 +#define ARM64_SCTLR_RES0_33 0x0000000200000000 +#define ARM64_SCTLR_RES0_34 0x0000000400000000 +#define ARM64_SCTLR_BT0 0x0000000800000000 +#define ARM64_SCTLR_BT1 0x0000001000000000 +#define ARM64_SCTLR_ITFSB 0x0000002000000000 +#define ARM64_SCTLR_TCF0_MASK 0x000000c000000000 +#define ARM64_SCTLR_TCF_MASK 0x0000030000000000 +#define ARM64_SCTLR_ATA0 0x0000040000000000 +#define ARM64_SCTLR_ATA 0x0000080000000000 +#define ARM64_SCTLR_DSSBS 0x0000100000000000 +#define ARM64_SCTLR_TWEDEn 0x0000200000000000 +#define ARM64_SCTLR_TWEDEL_MASK 0x0003c00000000000 +#define ARM64_SCTLR_RES0_50 0x0004000000000000 +#define ARM64_SCTLR_RES0_51 0x0008000000000000 +#define ARM64_SCTLR_RES0_52 0x0010000000000000 +#define ARM64_SCTLR_RES0_53 0x0020000000000000 +#define ARM64_SCTLR_EnASR 0x0040000000000000 +#define ARM64_SCTLR_EnAS0 0x0080000000000000 +#define ARM64_SCTLR_EnALS 0x0100000000000000 +#define ARM64_SCTLR_EPAN 0x0200000000000000 +#define ARM64_SCTLR_RES0_58 0x0400000000000000 +#define ARM64_SCTLR_RES0_59 0x0800000000000000 +#define ARM64_SCTLR_RES0_60 0x1000000000000000 +#define ARM64_SCTLR_RES0_61 0x2000000000000000 +#define ARM64_SCTLR_RES0_62 0x4000000000000000 +#define ARM64_SCTLR_RES0_63 0x8000000000000000 + +// +// Processor feature register definitions and masks +// + +#define ARM64_PFR0_EL1_EL0_MASK 0x000000000000000f +#define ARM64_PFR0_EL1_EL1_MASK 0x00000000000000f0 +#define ARM64_PFR0_EL1_EL2_MASK 0x0000000000000f00 +#define ARM64_PFR0_EL1_EL3_MASK 0x000000000000f000 +#define ARM64_PFR0_EL1_FP_MASK 0x00000000000f0000 +#define ARM64_PFR0_EL1_ADVSIMD_MASK 0x0000000000f00000 +#define ARM64_PFR0_EL1_GIC_MASK 0x000000000f000000 +#define ARM64_PFR0_EL1_RAS_MASK 0x00000000f0000000 +#define ARM64_PFR0_EL1_SVE_MASK 0x0000000f00000000 +#define ARM64_PFR0_EL1_SEL2_MASK 0x000000f000000000 +#define ARM64_PFR0_EL1_MPAM_MASK 0x00000f0000000000 +#define ARM64_PFR0_EL1_AMU_MASK 0x0000f00000000000 +#define ARM64_PFR0_EL1_DIT_MASK 0x000f000000000000 +#define ARM64_PFR0_EL1_RES0_MASK 0x00f0000000000000 +#define ARM64_PFR0_EL1_CSV2_MASK 0x0f00000000000000 +#define ARM64_PFR0_EL1_CSV3_MASK 0xf000000000000000 +#define ARM64_PFR0_EL1_MPAM_SHIFT 0x0000000000000028 +#define ARM64_PFR1_EL1_BT_MASK 0x000000000000000f +#define ARM64_PFR1_EL1_SBSS_MASK 0x00000000000000f0 +#define ARM64_PFR1_EL1_MTE_MASK 0x0000000000000f00 +#define ARM64_PFR1_EL1_RAS_FRAC_MASK 0x000000000000f000 +#define ARM64_PFR1_EL1_MPAM_FRAC_MASK 0x00000000000f0000 +#define ARM64_PFR1_EL1_RES0_MASK 0x00000000fff00000 +#define ARM64_PFR1_EL1_CSV2_FRAC_MASK 0x0000000f00000000 +#define ARM64_PFR1_EL1_RES1_MASK 0xfffffff000000000 +#define ARM64_PFR1_EL1_MPAM_FRAC_SHIFT 0x0000000000000010 + +// +// Constants for flags in the hypervisor control register +// + +#define ARM64_HCR_EL2_VM 0x0000000000000001 +#define ARM64_HCR_EL2_SWIO 0x0000000000000002 +#define ARM64_HCR_EL2_PTW 0x0000000000000004 +#define ARM64_HCR_EL2_FMO 0x0000000000000008 +#define ARM64_HCR_EL2_IMO 0x0000000000000010 +#define ARM64_HCR_EL2_AMO 0x0000000000000020 +#define ARM64_HCR_EL2_VF 0x0000000000000040 +#define ARM64_HCR_EL2_VI 0x0000000000000080 +#define ARM64_HCR_EL2_VSE 0x0000000000000100 +#define ARM64_HCR_EL2_FB 0x0000000000000200 +#define ARM64_HCR_EL2_BSU_NONE 0x0000000000000000 +#define ARM64_HCR_EL2_BSU_ISH 0x0000000000000400 +#define ARM64_HCR_EL2_BSU_OSH 0x0000000000000800 +#define ARM64_HCR_EL2_BSU_FS 0x0000000000000c00 +#define ARM64_HCR_EL2_BSU_MASK 0x0000000000000c00 +#define ARM64_HCR_EL2_DC 0x0000000000001000 +#define ARM64_HCR_EL2_TWI 0x0000000000002000 +#define ARM64_HCR_EL2_TWE 0x0000000000004000 +#define ARM64_HCR_EL2_TID0 0x0000000000008000 +#define ARM64_HCR_EL2_TID1 0x0000000000010000 +#define ARM64_HCR_EL2_TID2 0x0000000000020000 +#define ARM64_HCR_EL2_TID3 0x0000000000040000 +#define ARM64_HCR_EL2_TSC 0x0000000000080000 +#define ARM64_HCR_EL2_TIDCP 0x0000000000100000 +#define ARM64_HCR_EL2_TACR 0x0000000000200000 +#define ARM64_HCR_EL2_TSW 0x0000000000400000 +#define ARM64_HCR_EL2_TPC 0x0000000000800000 +#define ARM64_HCR_EL2_TPU 0x0000000001000000 +#define ARM64_HCR_EL2_TTLB 0x0000000002000000 +#define ARM64_HCR_EL2_TVM 0x0000000004000000 +#define ARM64_HCR_EL2_TGE 0x0000000008000000 +#define ARM64_HCR_EL2_TDZ 0x0000000010000000 +#define ARM64_HCR_EL2_HCD 0x0000000020000000 +#define ARM64_HCR_EL2_TRVM 0x0000000040000000 +#define ARM64_HCR_EL2_RW 0x0000000080000000 +#define ARM64_HCR_EL2_CD 0x0000000100000000 +#define ARM64_HCR_EL2_ID 0x0000000200000000 + +// +// Constants for flags in translation control register. +// + +#define ARM64_TCR_T0SZ_MASK 0x000000000000003f +#define ARM64_TCR_RES0_1 0x0000000000000040 +#define ARM64_TCR_EPD0 0x0000000000000080 +#define ARM64_TCR_IRGN0_NC 0x0000000000000000 +#define ARM64_TCR_IRGN0_WBWA 0x0000000000000100 +#define ARM64_TCR_IRGN0_WT 0x0000000000000200 +#define ARM64_TCR_IRGN0_WB 0x0000000000000300 +#define ARM64_TCR_IRGN0_MASK 0x0000000000000300 +#define ARM64_TCR_ORGN0_NC 0x0000000000000000 +#define ARM64_TCR_ORGN0_WBWA 0x0000000000000400 +#define ARM64_TCR_ORGN0_WT 0x0000000000000800 +#define ARM64_TCR_ORGN0_WB 0x0000000000000c00 +#define ARM64_TCR_ORGN0_MASK 0x0000000000000c00 +#define ARM64_TCR_SH0_NON_SHARED 0x0000000000000000 +#define ARM64_TCR_SH0_OUTER_SHARED 0x0000000000002000 +#define ARM64_TCR_SH0_INNER_SHARED 0x0000000000003000 +#define ARM64_TCR_SH0_MASK 0x0000000000003000 +#define ARM64_TCR_TG0_4K 0x0000000000000000 +#define ARM64_TCR_TG0_16K 0x0000000000008000 +#define ARM64_TCR_TG0_64K 0x0000000000004000 +#define ARM64_TCR_TG0_RESERVED 0x000000000000c000 +#define ARM64_TCR_TG0_MASK 0x000000000000c000 +#define ARM64_TCR_T1SZ_MASK 0x00000000003f0000 +#define ARM64_TCR_A1 0x0000000000400000 +#define ARM64_TCR_EPD1 0x0000000000800000 +#define ARM64_TCR_IRGN1_NC 0x0000000000000000 +#define ARM64_TCR_IRGN1_WBWA 0x0000000001000000 +#define ARM64_TCR_IRGN1_WT 0x0000000002000000 +#define ARM64_TCR_IRGN1_WB 0x0000000003000000 +#define ARM64_TCR_IRGN1_MASK 0x0000000003000000 +#define ARM64_TCR_ORGN1_NC 0x0000000000000000 +#define ARM64_TCR_ORGN1_WBWA 0x0000000004000000 +#define ARM64_TCR_ORGN1_WT 0x0000000008000000 +#define ARM64_TCR_ORGN1_WB 0x000000000c000000 +#define ARM64_TCR_ORGN1_MASK 0x000000000c000000 +#define ARM64_TCR_SH1_NON_SHARED 0x0000000000000000 +#define ARM64_TCR_SH1_OUTER_SHARED 0x0000000020000000 +#define ARM64_TCR_SH1_INNER_SHARED 0x0000000030000000 +#define ARM64_TCR_SH1_MASK 0x0000000030000000 +#define ARM64_TCR_TG1_4K 0x0000000080000000 +#define ARM64_TCR_TG1_16K 0x0000000040000000 +#define ARM64_TCR_TG1_64K 0x00000000c0000000 +#define ARM64_TCR_TG1_RESERVED 0x0000000000000000 +#define ARM64_TCR_TG1_MASK 0x00000000c0000000 +#define ARM64_TCR_IPASize_4G 0x0000000000000000 +#define ARM64_TCR_IPASize_64G 0x0000000100000000 +#define ARM64_TCR_IPASize_1T 0x0000000200000000 +#define ARM64_TCR_IPASize_4T 0x0000000300000000 +#define ARM64_TCR_IPASize_16T 0x0000000400000000 +#define ARM64_TCR_IPASize_256T 0x0000000500000000 +#define ARM64_TCR_IPASize_MASK 0x0000000700000000 +#define ARM64_TCR_RES0_35 0x0000000800000000 +#define ARM64_TCR_AS 0x0000001000000000 +#define ARM64_TCR_TBI0 0x0000002000000000 +#define ARM64_TCR_TBI1 0x0000004000000000 +#define ARM64_TCR_HA 0x0000008000000000 +#define ARM64_TCR_HD 0x0000010000000000 +#define ARM64_TCR_HPD0 0x0000020000000000 +#define ARM64_TCR_HPD1 0x0000040000000000 +#define ARM64_TCR_T0SZ_SHIFT 0x0000000000000000 +#define ARM64_TCR_T1SZ_SHIFT 0x0000000000000010 +#define ARM64_TCR_IPASize_SHIFT 0x0000000000000020 + +// +// Constants for flags in translation control register for EL2. +// + +#define ARM64_TCR_PASize_4G 0x0000000000000000 +#define ARM64_TCR_PASize_64G 0x0000000000010000 +#define ARM64_TCR_PASize_1T 0x0000000000020000 +#define ARM64_TCR_PASize_4T 0x0000000000030000 +#define ARM64_TCR_PASize_16T 0x0000000000040000 +#define ARM64_TCR_PASize_256T 0x0000000000050000 +#define ARM64_TCR_PASize_MASK 0x0000000000070000 +#define ARM64_TCR_EL2_TBI 0x0000000000100000 +#define ARM64_TCR_EL2_PASize_SHIFT 0x0000000000000010 + +// +// Performance counter register bits +// + +#define ARM64_PMCR_N_MASK 0x000000000000f800 +#define ARM64_PMCR_N_SHIFT 0x000000000000000b +#define ARM64_PMCR_LC 0x0000000000000040 +#define ARM64_PMCR_DP 0x0000000000000020 +#define ARM64_PMCR_X 0x0000000000000010 +#define ARM64_PMCR_D 0x0000000000000008 +#define ARM64_PMCR_C 0x0000000000000004 +#define ARM64_PMCR_P 0x0000000000000002 +#define ARM64_PMCR_E 0x0000000000000001 + +// +// Performance counter enable register bits +// + +#define ARM64_PMCNTEN_PMCCNT 0x0000000080000000 + +// +// Performance counter select register bits +// + +#define ARM64_PMSELR_PMCCNT 0x000000000000001f + +// +// Performance counter user-enable register bits +// + +#define ARM64_PMUSERENR_EN 0x0000000000000001 +#define ARM64_PMUSERENR_SW 0x0000000000000002 +#define ARM64_PMUSERENR_CR 0x0000000000000004 +#define ARM64_PMUSERENR_ER 0x0000000000000008 + +// +// Performance filter register bits +// + +#define ARM64_PMCCFILTR_M 0x0000000004000000 +#define ARM64_PMCCFILTR_NSH 0x0000000008000000 +#define ARM64_PMCCFILTR_NSU 0x0000000010000000 +#define ARM64_PMCCFILTR_NSK 0x0000000020000000 +#define ARM64_PMCCFILTR_U 0x0000000040000000 +#define ARM64_PMCCFILTR_P 0x0000000080000000 + +// +// Activity monitors count enable set register 0 bits +// + +#define ARM64_AMCNTENSET0_P0 0x0000000000000001 +#define ARM64_AMCNTENSET0_P1 0x0000000000000002 +#define ARM64_AMCNTENSET0_P2 0x0000000000000004 +#define ARM64_AMCNTENSET0_P3 0x0000000000000008 + +// +// Activity monitors user-enable register bits +// + +#define ARM64_AMUSERENR_EN 0x0000000000000001 + +// +// Monitor Debug Configuration Register bits +// + +#define ARM64_MDCR_HPMN_MASK 0x000000000000001f +#define ARM64_MDCR_TPMCR 0x0000000000000020 +#define ARM64_MDCR_TPM 0x0000000000000040 +#define ARM64_MDCR_HPME 0x0000000000000080 +#define ARM64_MDCR_TDE 0x0000000000000100 +#define ARM64_MDCR_TDA 0x0000000000000200 +#define ARM64_MDCR_TDOSA 0x0000000000000400 +#define ARM64_MDCR_TDRA 0x0000000000000800 +#define ARM64_MDCR_SPE_PBUF_MASK 0x0000000000003000 + +// +// MDSCR bits +// + +#define ARM64_MDSCR_SS 0x1 +#define ARM64_MDSCR_MDE 0x8000 +#define ARM64_MDSCR_KDE 0x2000 +#define ARM64_MDSCR_SS_KDE_MDE 0xa001 +#define ARM64_MDSCR_SS_BIT 0x0 + +// +// BRK opcodes +// + +#define ARM64_BREAKPOINT 0xf000 +#define ARM64_ASSERT 0xf001 +#define ARM64_DEBUG_SERVICE 0xf002 +#define ARM64_FASTFAIL 0xf003 +#define ARM64_DIVIDE_BY_0 0xf004 +#define ARM64_EMULATE_ATOMIC16 0xf801 +#define ARM64_EMULATE_ATOMIC32 0xf802 +#define ARM64_EMULATE_ATOMIC64 0xf803 + +// +// Miscellaneous Definitions +// + +#define MAXIMUM_PROCESSORS 0x40 +#define INITIAL_STALL_COUNT 0x64 +#define IRQL_NOT_GREATER_OR_EQUAL 0x9 +#define IRQL_NOT_LESS_OR_EQUAL 0xa +#define MUTEX_ALREADY_OWNED 0xbf +#define THREAD_NOT_MUTEX_OWNER 0x11 +#define SPIN_LOCK_ALREADY_OWNED 0xf +#define SPIN_LOCK_NOT_OWNED 0x10 +#define Executive 0x0 +#define KernelMode 0x0 +#define UserMode 0x1 +#define FALSE 0x0 +#define TRUE 0x1 + +// +// Fast Fail Definitions +// + +#define FAST_FAIL_GUARD_ICALL_CHECK_FAILURE 0xa +#define FAST_FAIL_CONTROL_INVALID_RETURN_ADDRESS 0x39 +#define BASE_PRIORITY_THRESHOLD 0x8 +#define LOW_REALTIME_PRIORITY 0x10 +#define DOUBLE_FAULT_STACK_SIZE 0x8000 +#define BREAKPOINT_BREAK 0x0 +#define BREAKPOINT_HW_BREAK 0x7 +#define BREAKPOINT_HW_WATCH 0x6 +#define BREAKPOINT_COMMAND_STRING 0x5 +#define BREAKPOINT_PRINT 0x1 +#define BREAKPOINT_PROMPT 0x2 +#define BREAKPOINT_LOAD_SYMBOLS 0x3 +#define BREAKPOINT_UNLOAD_SYMBOLS 0x4 +#define CLOCK_QUANTUM_DECREMENT 0x3 +#define READY_SKIP_QUANTUM 0x2 +#define THREAD_QUANTUM 0x6 +#define WAIT_QUANTUM_DECREMENT 0x1 +#define ROUND_TRIP_DECREMENT_COUNT 0x10 +#define KI_EXCEPTION_INTERNAL 0x10000000 +#define KI_EXCEPTION_GP_FAULT 0x10000001 +#define KI_EXCEPTION_INVALID_OP 0x10000002 +#define KI_EXCEPTION_ACCESS_VIOLATION 0x10000004 +#define KI_EXCEPTION_HARDWARE_ERROR 0x10000005 +#define KI_DPC_INTERRUPT_FLAGS 0xaf +#define STATUS_UNSUCCESSFUL 0xc0000001 +#define SKCALL_MAXPARAMETERS 0xc + +// +// Exception Frame Offset Definitions and Length +// + +#define ExX19 0x0 +#define ExX20 0x8 +#define ExX21 0x10 +#define ExX22 0x18 +#define ExX23 0x20 +#define ExX24 0x28 +#define ExX25 0x30 +#define ExX26 0x38 +#define ExX27 0x40 +#define ExX28 0x48 +#define ExFp 0x50 +#define ExReturn 0x58 + +#define KEXCEPTION_FRAME_LENGTH 0x60 +#define EXCEPTION_RECORD_LENGTH 0xa0 + + +// +// Kernel Dynamic Tracing flags +// + +#define KI_DYNAMIC_TRACE_SYSCALL_FLAG_BIT 0x0 + + +// +// Jump Offset Definitions and Length +// + +#define JbFrame 0x0 +#define JbX19 0x10 +#define JbX20 0x18 +#define JbX21 0x20 +#define JbX22 0x28 +#define JbX23 0x30 +#define JbX24 0x38 +#define JbX25 0x40 +#define JbX26 0x48 +#define JbX27 0x50 +#define JbX28 0x58 +#define JbFp 0x60 +#define JbLr 0x68 +#define JbSp 0x70 +#define JbFpcr 0x78 +#define JbFpsr 0x7c +#define JbD 0x80 + +// +// Switch Frame Offset Definitions and Length +// + +#define SwApcBypass 0x0 +#define SwFp 0x10 +#define SwReturn 0x18 + +#define KSWITCH_FRAME_LENGTH 0x20 + +// +// Start System Thread Frame Offset Definitions and Length +// + +#define SfX0 0x0 +#define SfX1 0x8 +#define SfX2 0x10 +#define SfReturn 0x18 + +#define KSTART_FRAME_LENGTH 0x20 + + +// +// Trap Frame Definitions +// + +#define KEXCEPTION_ACTIVE_INTERRUPT_FRAME 0x0 +#define KEXCEPTION_ACTIVE_EXCEPTION_FRAME 0x1 +#define KEXCEPTION_ACTIVE_SERVICE_FRAME 0x2 +#define KTRAP_FRAME_SIGNATURE 0x7072544b + +#define TrReserved 0x4 +#define TrFaultAddress 0x8 +#define TrTrapFrame 0x8 +#define TrExceptionActive 0x0 +#define TrContextFromKFramesUnwound 0x1 +#define TrDebugRegistersValid 0x2 +#define TrPreviousMode 0x3 +#define TrPreviousIrql 0x3 +#define TrVfpState 0x10 +#define TrBvr 0x38 +#define TrBcr 0x18 +#define TrWvr 0x80 +#define TrWcr 0x78 +#define TrX 0xa0 +#define TrFp 0x140 +#define TrLr 0x138 +#define TrSp 0x98 +#define TrPc 0x148 +#define TrSpsr 0x90 +#define TrEsr 0x94 + +#define KTRAP_FRAME_LENGTH 0x150 +#define KTRAP_FRAME_ARGUMENTS 0x50 +#define ARM64_RED_ZONE_BYTES 0x10 + +// +// Usermode Callout User Frame Definitions +// + +#define CkBuffer 0x0 +#define CkLength 0x8 +#define CkApiNumber 0xc +#define CkOriginalLr 0x18 +#define CkPc 0x28 +#define CkSp 0x20 +#define CalloutFrameLength 0x30 + +// +// Machine Frame Offset Definitions +// + +#define MfPc 0x8 +#define MfSp 0x0 +#define MachineFrameLength 0x10 + +// +// DPC Stack Frame Defintions +// + +#define DpSp 0x0 +#define DpPc 0x8 + +// +// Context Frame Offset and Flag Definitions +// + +#define CONTEXT_FULL 0x400007 +#define CONTEXT_CONTROL 0x400001 +#define CONTEXT_INTEGER 0x400002 +#define CONTEXT_FLOATING_POINT 0x400004 +#define CONTEXT_DEBUG_REGISTERS 0x400008 +#define CONTEXT_XSTATE 0x400020 + +#define CxContextFlags 0x0 +#define CxCpsr 0x4 +#define CxX 0x8 +#define CxFp 0xf0 +#define CxLr 0xf8 +#define CxSp 0x100 +#define CxPc 0x108 +#define CxFpsr 0x314 +#define CxFpcr 0x310 +#define CxV 0x110 +#define CxBvr 0x338 +#define CxBcr 0x318 +#define CxWvr 0x380 +#define CxWcr 0x378 +#define CONTEXT_FRAME_LENGTH 0x390 +#define CONTEXT_EX_LENGTH 0x20 +#define CONTEXT_ALIGN 0x10 +#define DEBUG_ACTIVE_DBG 0x1 +#define DEBUG_ACTIVE_DBG_BIT 0x0 +#define DEBUG_ACTIVE_DBG_INSTRUMENTED 0x3 +#define DEBUG_ACTIVE_INSTRUMENTED 0x2 +#define DEBUG_ACTIVE_MINIMAL_THREAD 0x4 +#define DEBUG_ACTIVE_MINIMAL_THREAD_BIT 0x2 +#define DEBUG_ACTIVE_EMULATION_THREAD 0x40 +#define DEBUG_ACTIVE_EMULATION_THREAD_BIT 0x6 + +// +// ARM64EC Context Frame Offsets +// + +#define EcContextFlags 0x30 +#define EcAMD64_MxCsr_copy 0x34 +#define EcAMD64_SegCs 0x38 +#define EcAMD64_SegDs 0x3a +#define EcAMD64_SegEs 0x3c +#define EcAMD64_SegFs 0x3e +#define EcAMD64_SegGs 0x40 +#define EcAMD64_SegSs 0x42 +#define EcAMD64_EFlags 0x44 +#define EcAMD64_Dr0 0x48 +#define EcAMD64_Dr1 0x50 +#define EcAMD64_Dr2 0x58 +#define EcAMD64_Dr3 0x60 +#define EcAMD64_Dr6 0x68 +#define EcAMD64_Dr7 0x70 +#define EcX8 0x78 +#define EcX0 0x80 +#define EcX1 0x88 +#define EcX27 0x90 +#define EcSp 0x98 +#define EcFp 0xa0 +#define EcX25 0xa8 +#define EcX26 0xb0 +#define EcX2 0xb8 +#define EcX3 0xc0 +#define EcX4 0xc8 +#define EcX5 0xd0 +#define EcX19 0xd8 +#define EcX20 0xe0 +#define EcX21 0xe8 +#define EcX22 0xf0 +#define EcPc 0xf8 +#define EcAMD64_ControlWord 0x100 +#define EcAMD64_StatusWord 0x102 +#define EcAMD64_TagWord 0x104 +#define EcAMD64_ErrorOpcode 0x106 +#define EcAMD64_ErrorOffset 0x108 +#define EcAMD64_ErrorSelector 0x10c +#define EcAMD64_DataOffset 0x110 +#define EcAMD64_DataSelector 0x114 +#define EcAMD64_DataSelector 0x114 +#define EcAMD64_MxCsr 0x118 +#define EcAMD64_MxCsr_Mask 0x11c +#define EcLr 0x120 +#define EcX16_0 0x128 +#define EcX6 0x130 +#define EcX16_1 0x138 +#define EcX7 0x140 +#define EcX16_2 0x148 +#define EcX9 0x150 +#define EcX16_3 0x158 +#define EcX10 0x160 +#define EcX17_0 0x168 +#define EcX11 0x170 +#define EcX17_1 0x178 +#define EcX12 0x180 +#define EcX17_2 0x188 +#define EcX15 0x190 +#define EcX17_3 0x198 +#define EcV 0x1a0 +#define EcAMD64_VectorRegister 0x300 +#define EcAMD64_VectorControl 0x4a0 +#define EcAMD64_DebugControl 0x4a8 +#define EcAMD64_LastBranchToRip 0x4b0 +#define EcAMD64_LastBranchFromRip 0x4b8 +#define EcAMD64_LastExceptionToRip 0x4c0 +#define EcAMD64_LastExceptionFromRip 0x4c8 +#define ARM64EC_CONTEXT_LENGTH 0x4d0 +#define AMD64_CONTEXT_XSTATE 0x100040 + +// +// Dispatcher Context Structure Offset Definitions +// + +#define DcControlPc 0x0 +#define DcImageBase 0x8 +#define DcFunctionEntry 0x10 +#define DcEstablisherFrame 0x18 +#define DcTargetPc 0x20 +#define DcContextRecord 0x28 +#define DcLanguageHandler 0x30 +#define DcHandlerData 0x38 +#define DcHistoryTable 0x40 +#define DcScopeIndex 0x48 +#define DcControlPcIsUnwound 0x4c +#define DcNonVolatileRegisters 0x50 +#define VsLink 0x0 +#define VsFpcr 0x8 +#define VsFpsr 0xc +#define VsV 0x10 +#define VFP_STATE_LENGTH 0x210 + + +#define ARM64_ID_AA64MMFR0_EL1 0x4038 +#define ARM64_ID_AA64PFR0_EL1 0x4020 +#define PF_ARM_V81_ATOMIC_INSTRUCTIONS_AVAILABLE 0x22 + +// +// Processor State Frame Offset Definitions +// + +#define PsCpuid 0xa0 +#define PsControl 0xa8 +#define PsAuxControl 0xb0 +#define PsCpacr 0xb8 +#define PsTtbControl 0xc0 +#define PsTtbr0 0xc8 +#define PsTtbr1 0xd0 +#define PsVBARns 0x310 +#define PsMemoryRemap 0x308 +#define PsUsrRW 0x10 +#define PsUsrRO 0x18 +#define PsSvcRW 0x20 +#define PsSpecialRegisters 0x0 +#define PsArchState 0xa0 +#define PsContextFrame 0x340 +#define ProcessorStateLength 0x6d0 + +// +// Processor Parked Page Offset Definitions +// + +#define PppArchitecturalStateVirtualAddress 0x10 +#define PppArchitecturalState 0x20 +#define ProcessorParkedPageLength 0x1000 + +// +// Processor Start Block Offset Definitions +// + +#define PsbSelfMap 0x0 +#define PsbTiledTtb0 0x8 +#define ProcessorStartBlockLength 0x10 + +// +// Enclave call dispatch frame +// + +#define EcFramePointer 0x0 +#define EcReturnAddress 0x8 +#define EcOriginalFramePointer 0x10 +#define EcOriginalReturn 0x18 +#define EcEnclaveNumber 0x20 +#define EcParameterAddress 0x28 +#define EcParameterValue 0x30 +#define EnclaveDispatchFrameLength 0x40 + +// +// EPROCESS +// + +#define EpDebugPort 0x2f8 +#define EpSecurityDomain 0x820 +#define EpPointerAuthUserIpKey 0x850 + +// +// EPROCESS MitigationFlags2 +// + +#define PS_PROCESS_MITIGATION_FLAGS2_POINTER_AUTH_USER_IP_BIT 0x1b +#define PS_PROCESS_MITIGATION_FLAGS2_SPECULATIVE_STORE_BYPASS_DISABLE 0xd + +// +// KeFeatureBits defines +// + + +// +// LoaderParameterBlock offsets relative to base +// + +#define LpbKernelStack 0x80 +#define LpbPrcb 0x88 +#define LpbProcess 0x90 +#define LpbThread 0x98 +#define PAGE_SIZE 0x1000 +#define PAGE_SHIFT 0xc +#define TRANSITION_ASID 0x0 +#define ARM64_TTBRx_ASID_SHIFT 0x30 + +// +// KAFFINITY_EX size +// + +#define AffinityExLength 0x108 +#define KAPC_RECORD_FLAGS_CALLBACK_DATA_CONTEXT_BIT 0x2 +#include "kxarm64.h" +; diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksguid.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksguid.h new file mode 100644 index 0000000000000000000000000000000000000000..4df3c58bf2aae897181847ca1681dd812674ea3d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksguid.h @@ -0,0 +1,38 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ksguid.h + +Abstract: + + Define guids for non-C++. + +--*/ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#define INITGUID +#include + +#if defined( DEFINE_GUIDEX ) + #undef DEFINE_GUIDEX +#endif +#define DEFINE_GUIDEX(name) EXTERN_C const CDECL GUID __declspec(selectany) name = { STATICGUIDOF(name) } + +#ifndef STATICGUIDOF + #define STATICGUIDOF(guid) STATIC_##guid +#endif // !defined(STATICGUIDOF) + +#if !defined( DEFINE_WAVEFORMATEX_GUID ) +#define DEFINE_WAVEFORMATEX_GUID(x) (USHORT)(x), 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksmedia.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksmedia.h new file mode 100644 index 0000000000000000000000000000000000000000..1a53f1695fa9c7e162f91598735c8ae2388d6308 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksmedia.h @@ -0,0 +1,8711 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ksmedia.h + +Abstract: + + WDM-CSA Multimedia Definitions. + +--*/ + +#if !defined(_KS_) +#error KS.H must be included before KSMEDIA.H +#endif // !defined(_KS_) + +#if !defined(_KSMEDIA_) +#define _KSMEDIA_ + + +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4214) // bit field types other than int + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct { + KSPROPERTY Property; + KSMULTIPLE_ITEM MultipleItem; +} KSMULTIPLE_DATA_PROP, *PKSMULTIPLE_DATA_PROP; + +#define STATIC_KSMEDIUMSETID_MidiBus \ + 0x05908040L, 0x3246, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("05908040-3246-11D0-A5D6-28DB04C10000", KSMEDIUMSETID_MidiBus); +#define KSMEDIUMSETID_MidiBus DEFINE_GUIDNAMED(KSMEDIUMSETID_MidiBus) + +#define STATIC_KSMEDIUMSETID_VPBus \ + 0xA18C15ECL, 0xCE43, 0x11D0, 0xAB, 0xE7, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("A18C15EC-CE43-11D0-ABE7-00A0C9223196", KSMEDIUMSETID_VPBus); +#define KSMEDIUMSETID_VPBus DEFINE_GUIDNAMED(KSMEDIUMSETID_VPBus) + +#define STATIC_KSINTERFACESETID_Media \ + 0x3A13EB40L, 0x30A7, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("3A13EB40-30A7-11D0-A5D6-28DB04C10000", KSINTERFACESETID_Media); +#define KSINTERFACESETID_Media DEFINE_GUIDNAMED(KSINTERFACESETID_Media) + +typedef enum { + KSINTERFACE_MEDIA_MUSIC, //Reserved for system use + KSINTERFACE_MEDIA_WAVE_BUFFERED, //Reserved for system use + KSINTERFACE_MEDIA_WAVE_QUEUED +} KSINTERFACE_MEDIA; + + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#if !defined(INIT_USBAUDIO_MID) +// {4e1cecd2-1679-463b-a72f-a5bf64c86eba} +#define INIT_USBAUDIO_MID(guid, id)\ +{\ + (guid)->Data1 = 0x4e1cecd2 + (USHORT)(id);\ + (guid)->Data2 = 0x1679;\ + (guid)->Data3 = 0x463b;\ + (guid)->Data4[0] = 0xa7;\ + (guid)->Data4[1] = 0x2f;\ + (guid)->Data4[2] = 0xa5;\ + (guid)->Data4[3] = 0xbf;\ + (guid)->Data4[4] = 0x64;\ + (guid)->Data4[5] = 0xc8;\ + (guid)->Data4[6] = 0x6e;\ + (guid)->Data4[7] = 0xba;\ +} +#define EXTRACT_USBAUDIO_MID(guid)\ + (USHORT)((guid)->Data1 - 0x4e1cecd2) +#define DEFINE_USBAUDIO_MID_GUID(id)\ + 0x4e1cecd2+(USHORT)(id), 0x1679, 0x463b, 0xa7, 0x2f, 0xa5, 0xbf, 0x64, 0xc8, 0x6e, 0xba + +#define INIT_EXBUS_MANUFACTURER_ID INIT_USBAUDIO_MID + +#define IS_COMPATIBLE_USBAUDIO_MID(guid)\ + (((guid)->Data1 >= 0x4e1cecd2) &&\ + ((guid)->Data1 < 0x4e1cecd2 + 0xffff) &&\ + ((guid)->Data2 == 0x1679) &&\ + ((guid)->Data3 == 0x463b) &&\ + ((guid)->Data4[0] == 0xa7) &&\ + ((guid)->Data4[1] == 0x2f) &&\ + ((guid)->Data4[2] == 0xa5) &&\ + ((guid)->Data4[3] == 0xbf) &&\ + ((guid)->Data4[4] == 0x64) &&\ + ((guid)->Data4[5] == 0xc8) &&\ + ((guid)->Data4[6] == 0x6e) &&\ + ((guid)->Data4[7] == 0xba)) +#endif // !defined(INIT_USBAUDIO_MID) + +#if !defined(INIT_USBAUDIO_PID) +// {abcc5a5e-c263-463b-a72f-a5bf64c86eba} +#define INIT_USBAUDIO_PID(guid, id)\ +{\ + (guid)->Data1 = 0xabcc5a5e + (USHORT)(id);\ + (guid)->Data2 = 0xc263;\ + (guid)->Data3 = 0x463b;\ + (guid)->Data4[0] = 0xa7;\ + (guid)->Data4[1] = 0x2f;\ + (guid)->Data4[2] = 0xa5;\ + (guid)->Data4[3] = 0xbf;\ + (guid)->Data4[4] = 0x64;\ + (guid)->Data4[5] = 0xc8;\ + (guid)->Data4[6] = 0x6e;\ + (guid)->Data4[7] = 0xba;\ +} +#define EXTRACT_USBAUDIO_PID(guid)\ + (USHORT)((guid)->Data1 - 0xabcc5a5e) +#define DEFINE_USBAUDIO_PID_GUID(id)\ + 0xabcc5a5e+(USHORT)(id), 0xc263, 0x463b, 0xa7, 0x2f, 0xa5, 0xbf, 0x64, 0xc8, 0x6e, 0xba + +#define INIT_EXBUS_PRODUCT_ID INIT_USBAUDIO_PID + +#define IS_COMPATIBLE_USBAUDIO_PID(guid)\ + (((guid)->Data1 >= 0xabcc5a5e) &&\ + ((guid)->Data1 < 0xabcc5a5e + 0xffff) &&\ + ((guid)->Data2 == 0xc263) &&\ + ((guid)->Data3 == 0x463b) &&\ + ((guid)->Data4[0] == 0xa7) &&\ + ((guid)->Data4[1] == 0x2f) &&\ + ((guid)->Data4[2] == 0xa5) &&\ + ((guid)->Data4[3] == 0xbf) &&\ + ((guid)->Data4[4] == 0x64) &&\ + ((guid)->Data4[5] == 0xc8) &&\ + ((guid)->Data4[6] == 0x6e) &&\ + ((guid)->Data4[7] == 0xba)) +#endif // !defined(INIT_USBAUDIO_PID) + +#if !defined(INIT_USBAUDIO_PRODUCT_NAME) +// {FC575048-2E08-463B-A72F-A5BF64C86EBA} +#define INIT_USBAUDIO_PRODUCT_NAME(guid, vid, pid, strIndex)\ +{\ + (guid)->Data1 = 0XFC575048 + (USHORT)(vid);\ + (guid)->Data2 = 0x2E08 + (USHORT)(pid);\ + (guid)->Data3 = 0x463B + (USHORT)(strIndex);\ + (guid)->Data4[0] = 0xA7;\ + (guid)->Data4[1] = 0x2F;\ + (guid)->Data4[2] = 0xA5;\ + (guid)->Data4[3] = 0xBF;\ + (guid)->Data4[4] = 0x64;\ + (guid)->Data4[5] = 0xC8;\ + (guid)->Data4[6] = 0x6E;\ + (guid)->Data4[7] = 0xBA;\ +} +#define DEFINE_USBAUDIO_PRODUCT_NAME(vid, pid, strIndex)\ + 0xFC575048+(USHORT)(vid), 0x2E08+(USHORT)(pid), 0x463B+(USHORT)(strIndex), 0xA7, 0x2F, 0xA5, 0xBF, 0x64, 0xC8, 0x6E, 0xBA +#endif // !defined(INIT_USBAUDIO_PRODUCT_NAME) + +#define INIT_EXBUS_PRODUCT_NAME INIT_USBAUDIO_PRODUCT_NAME + +// USB Component ID +#define STATIC_KSCOMPONENTID_USBAUDIO \ + 0x8F1275F0, 0x26E9, 0x4264, 0xBA, 0x4D, 0x39, 0xFF, 0xF0, 0x1D, 0x94, 0xAA +DEFINE_GUIDSTRUCT("8F1275F0-26E9-4264-BA4D-39FFF01D94AA", KSCOMPONENTID_USBAUDIO); +#define KSCOMPONENTID_USBAUDIO DEFINE_GUIDNAMED(KSCOMPONENTID_USBAUDIO) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// USB Terminals +#define INIT_USB_TERMINAL(guid, id)\ +{\ + (guid)->Data1 = 0xDFF219E0 + (USHORT)(id);\ + (guid)->Data2 = 0xF70F;\ + (guid)->Data3 = 0x11D0;\ + (guid)->Data4[0] = 0xb9;\ + (guid)->Data4[1] = 0x17;\ + (guid)->Data4[2] = 0x00;\ + (guid)->Data4[3] = 0xa0;\ + (guid)->Data4[4] = 0xc9;\ + (guid)->Data4[5] = 0x22;\ + (guid)->Data4[6] = 0x31;\ + (guid)->Data4[7] = 0x96;\ +} +#define EXTRACT_USB_TERMINAL(guid)\ + (USHORT)((guid)->Data1 - 0xDFF219E0) +#define DEFINE_USB_TERMINAL_GUID(id)\ + 0xDFF219E0+(USHORT)(id), 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#define STATIC_KSNODETYPE_INPUT_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0200) +DEFINE_GUIDSTRUCT("DFF21BE0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_INPUT_UNDEFINED); +#define KSNODETYPE_INPUT_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_INPUT_UNDEFINED) + +#define STATIC_KSNODETYPE_MICROPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0201) +DEFINE_GUIDSTRUCT("DFF21BE1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_MICROPHONE); +#define KSNODETYPE_MICROPHONE DEFINE_GUIDNAMED(KSNODETYPE_MICROPHONE) + +#define STATIC_KSNODETYPE_DESKTOP_MICROPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0202) +DEFINE_GUIDSTRUCT("DFF21BE2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DESKTOP_MICROPHONE); +#define KSNODETYPE_DESKTOP_MICROPHONE DEFINE_GUIDNAMED(KSNODETYPE_DESKTOP_MICROPHONE) + +#define STATIC_KSNODETYPE_PERSONAL_MICROPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0203) +DEFINE_GUIDSTRUCT("DFF21BE3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_PERSONAL_MICROPHONE); +#define KSNODETYPE_PERSONAL_MICROPHONE DEFINE_GUIDNAMED(KSNODETYPE_PERSONAL_MICROPHONE) + +#define STATIC_KSNODETYPE_OMNI_DIRECTIONAL_MICROPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0204) +DEFINE_GUIDSTRUCT("DFF21BE4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_OMNI_DIRECTIONAL_MICROPHONE); +#define KSNODETYPE_OMNI_DIRECTIONAL_MICROPHONE DEFINE_GUIDNAMED(KSNODETYPE_OMNI_DIRECTIONAL_MICROPHONE) + +#define STATIC_KSNODETYPE_MICROPHONE_ARRAY\ + DEFINE_USB_TERMINAL_GUID(0x0205) +DEFINE_GUIDSTRUCT("DFF21BE5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_MICROPHONE_ARRAY); +#define KSNODETYPE_MICROPHONE_ARRAY DEFINE_GUIDNAMED(KSNODETYPE_MICROPHONE_ARRAY) + +#define STATIC_KSNODETYPE_PROCESSING_MICROPHONE_ARRAY\ + DEFINE_USB_TERMINAL_GUID(0x0206) +DEFINE_GUIDSTRUCT("DFF21BE6-F70F-11D0-B917-00A0C9223196", KSNODETYPE_PROCESSING_MICROPHONE_ARRAY); +#define KSNODETYPE_PROCESSING_MICROPHONE_ARRAY DEFINE_GUIDNAMED(KSNODETYPE_PROCESSING_MICROPHONE_ARRAY) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR \ + 0x830a44f2, 0xa32d, 0x476b, 0xbe, 0x97, 0x42, 0x84, 0x56, 0x73, 0xb3, 0x5a +DEFINE_GUIDSTRUCT("830a44f2-a32d-476b-be97-42845673b35a", KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR); +#define KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR DEFINE_GUIDNAMED(KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_OUTPUT_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0300) +DEFINE_GUIDSTRUCT("DFF21CE0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_OUTPUT_UNDEFINED); +#define KSNODETYPE_OUTPUT_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_OUTPUT_UNDEFINED) + +#define STATIC_KSNODETYPE_SPEAKER\ + DEFINE_USB_TERMINAL_GUID(0x0301) +DEFINE_GUIDSTRUCT("DFF21CE1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_SPEAKER); +#define KSNODETYPE_SPEAKER DEFINE_GUIDNAMED(KSNODETYPE_SPEAKER) + +#define STATIC_KSNODETYPE_HEADPHONES\ + DEFINE_USB_TERMINAL_GUID(0x0302) +DEFINE_GUIDSTRUCT("DFF21CE2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_HEADPHONES); +#define KSNODETYPE_HEADPHONES DEFINE_GUIDNAMED(KSNODETYPE_HEADPHONES) + +#define STATIC_KSNODETYPE_HEAD_MOUNTED_DISPLAY_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x0303) +DEFINE_GUIDSTRUCT("DFF21CE3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_HEAD_MOUNTED_DISPLAY_AUDIO); +#define KSNODETYPE_HEAD_MOUNTED_DISPLAY_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_HEAD_MOUNTED_DISPLAY_AUDIO) + +#define STATIC_KSNODETYPE_DESKTOP_SPEAKER\ + DEFINE_USB_TERMINAL_GUID(0x0304) +DEFINE_GUIDSTRUCT("DFF21CE4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DESKTOP_SPEAKER); +#define KSNODETYPE_DESKTOP_SPEAKER DEFINE_GUIDNAMED(KSNODETYPE_DESKTOP_SPEAKER) + +#define STATIC_KSNODETYPE_ROOM_SPEAKER\ + DEFINE_USB_TERMINAL_GUID(0x0305) +DEFINE_GUIDSTRUCT("DFF21CE5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_ROOM_SPEAKER); +#define KSNODETYPE_ROOM_SPEAKER DEFINE_GUIDNAMED(KSNODETYPE_ROOM_SPEAKER) + +#define STATIC_KSNODETYPE_COMMUNICATION_SPEAKER\ + DEFINE_USB_TERMINAL_GUID(0x0306) +DEFINE_GUIDSTRUCT("DFF21CE6-F70F-11D0-B917-00A0C9223196", KSNODETYPE_COMMUNICATION_SPEAKER); +#define KSNODETYPE_COMMUNICATION_SPEAKER DEFINE_GUIDNAMED(KSNODETYPE_COMMUNICATION_SPEAKER) + +#define STATIC_KSNODETYPE_LOW_FREQUENCY_EFFECTS_SPEAKER\ + DEFINE_USB_TERMINAL_GUID(0x0307) +DEFINE_GUIDSTRUCT("DFF21CE7-F70F-11D0-B917-00A0C9223196", KSNODETYPE_LOW_FREQUENCY_EFFECTS_SPEAKER); +#define KSNODETYPE_LOW_FREQUENCY_EFFECTS_SPEAKER DEFINE_GUIDNAMED(KSNODETYPE_LOW_FREQUENCY_EFFECTS_SPEAKER) + +#define STATIC_KSNODETYPE_BIDIRECTIONAL_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0400) +DEFINE_GUIDSTRUCT("DFF21DE0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_BIDIRECTIONAL_UNDEFINED); +#define KSNODETYPE_BIDIRECTIONAL_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_BIDIRECTIONAL_UNDEFINED) + +#define STATIC_KSNODETYPE_HANDSET\ + DEFINE_USB_TERMINAL_GUID(0x0401) +DEFINE_GUIDSTRUCT("DFF21DE1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_HANDSET); +#define KSNODETYPE_HANDSET DEFINE_GUIDNAMED(KSNODETYPE_HANDSET) + +#define KSNODETYPE_HEADSET_MICROPHONE KSNODETYPE_PERSONAL_MICROPHONE +#define KSNODETYPE_HEADSET_SPEAKERS KSNODETYPE_COMMUNICATION_SPEAKER + +#define STATIC_KSNODETYPE_HEADSET\ + DEFINE_USB_TERMINAL_GUID(0x0402) +DEFINE_GUIDSTRUCT("DFF21DE2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_HEADSET); +#define KSNODETYPE_HEADSET DEFINE_GUIDNAMED(KSNODETYPE_HEADSET) + +#define STATIC_KSNODETYPE_SPEAKERPHONE_NO_ECHO_REDUCTION\ + DEFINE_USB_TERMINAL_GUID(0x0403) +DEFINE_GUIDSTRUCT("DFF21DE3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_SPEAKERPHONE_NO_ECHO_REDUCTION); +#define KSNODETYPE_SPEAKERPHONE_NO_ECHO_REDUCTION DEFINE_GUIDNAMED(KSNODETYPE_SPEAKERPHONE_NO_ECHO_REDUCTION) + +#define STATIC_KSNODETYPE_ECHO_SUPPRESSING_SPEAKERPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0404) +DEFINE_GUIDSTRUCT("DFF21DE4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_ECHO_SUPPRESSING_SPEAKERPHONE); +#define KSNODETYPE_ECHO_SUPPRESSING_SPEAKERPHONE DEFINE_GUIDNAMED(KSNODETYPE_ECHO_SUPPRESSING_SPEAKERPHONE) + +#define STATIC_KSNODETYPE_ECHO_CANCELING_SPEAKERPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0405) +DEFINE_GUIDSTRUCT("DFF21DE5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_ECHO_CANCELING_SPEAKERPHONE); +#define KSNODETYPE_ECHO_CANCELING_SPEAKERPHONE DEFINE_GUIDNAMED(KSNODETYPE_ECHO_CANCELING_SPEAKERPHONE) + +#define STATIC_KSNODETYPE_TELEPHONY_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0500) +DEFINE_GUIDSTRUCT("DFF21EE0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_TELEPHONY_UNDEFINED); +#define KSNODETYPE_TELEPHONY_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_TELEPHONY_UNDEFINED) + +#define STATIC_KSNODETYPE_PHONE_LINE\ + DEFINE_USB_TERMINAL_GUID(0x0501) +DEFINE_GUIDSTRUCT("DFF21EE1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_PHONE_LINE); +#define KSNODETYPE_PHONE_LINE DEFINE_GUIDNAMED(KSNODETYPE_PHONE_LINE) + +#define STATIC_KSNODETYPE_TELEPHONE\ + DEFINE_USB_TERMINAL_GUID(0x0502) +DEFINE_GUIDSTRUCT("DFF21EE2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_TELEPHONE); +#define KSNODETYPE_TELEPHONE DEFINE_GUIDNAMED(KSNODETYPE_TELEPHONE) + +#define STATIC_KSNODETYPE_DOWN_LINE_PHONE\ + DEFINE_USB_TERMINAL_GUID(0x0503) +DEFINE_GUIDSTRUCT("DFF21EE3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DOWN_LINE_PHONE); +#define KSNODETYPE_DOWN_LINE_PHONE DEFINE_GUIDNAMED(KSNODETYPE_DOWN_LINE_PHONE) + +#define STATIC_KSNODETYPE_EXTERNAL_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0600) +DEFINE_GUIDSTRUCT("DFF21FE0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_EXTERNAL_UNDEFINED); +#define KSNODETYPE_EXTERNAL_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_EXTERNAL_UNDEFINED) + +#define STATIC_KSNODETYPE_ANALOG_CONNECTOR\ + DEFINE_USB_TERMINAL_GUID(0x601) +DEFINE_GUIDSTRUCT("DFF21FE1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_ANALOG_CONNECTOR); +#define KSNODETYPE_ANALOG_CONNECTOR DEFINE_GUIDNAMED(KSNODETYPE_ANALOG_CONNECTOR) + +#define STATIC_KSNODETYPE_DIGITAL_AUDIO_INTERFACE\ + DEFINE_USB_TERMINAL_GUID(0x0602) +DEFINE_GUIDSTRUCT("DFF21FE2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DIGITAL_AUDIO_INTERFACE); +#define KSNODETYPE_DIGITAL_AUDIO_INTERFACE DEFINE_GUIDNAMED(KSNODETYPE_DIGITAL_AUDIO_INTERFACE) + +#define STATIC_KSNODETYPE_LINE_CONNECTOR\ + DEFINE_USB_TERMINAL_GUID(0x0603) +DEFINE_GUIDSTRUCT("DFF21FE3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_LINE_CONNECTOR); +#define KSNODETYPE_LINE_CONNECTOR DEFINE_GUIDNAMED(KSNODETYPE_LINE_CONNECTOR) + +#define STATIC_KSNODETYPE_LEGACY_AUDIO_CONNECTOR\ + DEFINE_USB_TERMINAL_GUID(0x0604) +DEFINE_GUIDSTRUCT("DFF21FE4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_LEGACY_AUDIO_CONNECTOR); +#define KSNODETYPE_LEGACY_AUDIO_CONNECTOR DEFINE_GUIDNAMED(KSNODETYPE_LEGACY_AUDIO_CONNECTOR) + +#define STATIC_KSNODETYPE_SPDIF_INTERFACE\ + DEFINE_USB_TERMINAL_GUID(0x0605) +DEFINE_GUIDSTRUCT("DFF21FE5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_SPDIF_INTERFACE); +#define KSNODETYPE_SPDIF_INTERFACE DEFINE_GUIDNAMED(KSNODETYPE_SPDIF_INTERFACE) + +#define STATIC_KSNODETYPE_1394_DA_STREAM\ + DEFINE_USB_TERMINAL_GUID(0x0606) +DEFINE_GUIDSTRUCT("DFF21FE6-F70F-11D0-B917-00A0C9223196", KSNODETYPE_1394_DA_STREAM); +#define KSNODETYPE_1394_DA_STREAM DEFINE_GUIDNAMED(KSNODETYPE_1394_DA_STREAM) + +#define STATIC_KSNODETYPE_1394_DV_STREAM_SOUNDTRACK\ + DEFINE_USB_TERMINAL_GUID(0x0607) +DEFINE_GUIDSTRUCT("DFF21FE7-F70F-11D0-B917-00A0C9223196", KSNODETYPE_1394_DV_STREAM_SOUNDTRACK); +#define KSNODETYPE_1394_DV_STREAM_SOUNDTRACK DEFINE_GUIDNAMED(KSNODETYPE_1394_DV_STREAM_SOUNDTRACK) + +#define STATIC_KSNODETYPE_EMBEDDED_UNDEFINED\ + DEFINE_USB_TERMINAL_GUID(0x0700) +DEFINE_GUIDSTRUCT("DFF220E0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_EMBEDDED_UNDEFINED); +#define KSNODETYPE_EMBEDDED_UNDEFINED DEFINE_GUIDNAMED(KSNODETYPE_EMBEDDED_UNDEFINED) + +#define STATIC_KSNODETYPE_LEVEL_CALIBRATION_NOISE_SOURCE\ + DEFINE_USB_TERMINAL_GUID(0x0701) +DEFINE_GUIDSTRUCT("DFF220E1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_LEVEL_CALIBRATION_NOISE_SOURCE); +#define KSNODETYPE_LEVEL_CALIBRATION_NOISE_SOURCE DEFINE_GUIDNAMED(KSNODETYPE_LEVEL_CALIBRATION_NOISE_SOURCE) + +#define STATIC_KSNODETYPE_EQUALIZATION_NOISE\ + DEFINE_USB_TERMINAL_GUID(0x0702) +DEFINE_GUIDSTRUCT("DFF220E2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_EQUALIZATION_NOISE); +#define KSNODETYPE_EQUALIZATION_NOISE DEFINE_GUIDNAMED(KSNODETYPE_EQUALIZATION_NOISE) + +#define STATIC_KSNODETYPE_CD_PLAYER\ + DEFINE_USB_TERMINAL_GUID(0x0703) +DEFINE_GUIDSTRUCT("DFF220E3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_CD_PLAYER); +#define KSNODETYPE_CD_PLAYER DEFINE_GUIDNAMED(KSNODETYPE_CD_PLAYER) + +#define STATIC_KSNODETYPE_DAT_IO_DIGITAL_AUDIO_TAPE\ + DEFINE_USB_TERMINAL_GUID(0x0704) +DEFINE_GUIDSTRUCT("DFF220E4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DAT_IO_DIGITAL_AUDIO_TAPE); +#define KSNODETYPE_DAT_IO_DIGITAL_AUDIO_TAPE DEFINE_GUIDNAMED(KSNODETYPE_DAT_IO_DIGITAL_AUDIO_TAPE) + +#define STATIC_KSNODETYPE_DCC_IO_DIGITAL_COMPACT_CASSETTE\ + DEFINE_USB_TERMINAL_GUID(0x0705) +DEFINE_GUIDSTRUCT("DFF220E5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DCC_IO_DIGITAL_COMPACT_CASSETTE); +#define KSNODETYPE_DCC_IO_DIGITAL_COMPACT_CASSETTE DEFINE_GUIDNAMED(KSNODETYPE_DCC_IO_DIGITAL_COMPACT_CASSETTE) + +#define STATIC_KSNODETYPE_MINIDISK\ + DEFINE_USB_TERMINAL_GUID(0x0706) +DEFINE_GUIDSTRUCT("DFF220E6-F70F-11D0-B917-00A0C9223196", KSNODETYPE_MINIDISK); +#define KSNODETYPE_MINIDISK DEFINE_GUIDNAMED(KSNODETYPE_MINIDISK) + +#define STATIC_KSNODETYPE_ANALOG_TAPE\ + DEFINE_USB_TERMINAL_GUID(0x0707) +DEFINE_GUIDSTRUCT("DFF220E7-F70F-11D0-B917-00A0C9223196", KSNODETYPE_ANALOG_TAPE); +#define KSNODETYPE_ANALOG_TAPE DEFINE_GUIDNAMED(KSNODETYPE_ANALOG_TAPE) + +#define STATIC_KSNODETYPE_PHONOGRAPH\ + DEFINE_USB_TERMINAL_GUID(0x0708) +DEFINE_GUIDSTRUCT("DFF220E8-F70F-11D0-B917-00A0C9223196", KSNODETYPE_PHONOGRAPH); +#define KSNODETYPE_PHONOGRAPH DEFINE_GUIDNAMED(KSNODETYPE_PHONOGRAPH) + +#define STATIC_KSNODETYPE_VCR_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x0708) +DEFINE_GUIDSTRUCT("DFF220E9-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VCR_AUDIO); +#define KSNODETYPE_VCR_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_VCR_AUDIO) + +#define STATIC_KSNODETYPE_VIDEO_DISC_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070A) +DEFINE_GUIDSTRUCT("DFF220EA-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_DISC_AUDIO); +#define KSNODETYPE_VIDEO_DISC_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_DISC_AUDIO) + +#define STATIC_KSNODETYPE_DVD_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070B) +DEFINE_GUIDSTRUCT("DFF220EB-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DVD_AUDIO); +#define KSNODETYPE_DVD_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_DVD_AUDIO) + +#define STATIC_KSNODETYPE_TV_TUNER_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070C) +DEFINE_GUIDSTRUCT("DFF220EC-F70F-11D0-B917-00A0C9223196", KSNODETYPE_TV_TUNER_AUDIO); +#define KSNODETYPE_TV_TUNER_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_TV_TUNER_AUDIO) + +#define STATIC_KSNODETYPE_SATELLITE_RECEIVER_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070D) +DEFINE_GUIDSTRUCT("DFF220ED-F70F-11D0-B917-00A0C9223196", KSNODETYPE_SATELLITE_RECEIVER_AUDIO); +#define KSNODETYPE_SATELLITE_RECEIVER_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_SATELLITE_RECEIVER_AUDIO) + +#define STATIC_KSNODETYPE_CABLE_TUNER_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070E) +DEFINE_GUIDSTRUCT("DFF220EE-F70F-11D0-B917-00A0C9223196", KSNODETYPE_CABLE_TUNER_AUDIO); +#define KSNODETYPE_CABLE_TUNER_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_CABLE_TUNER_AUDIO) + +#define STATIC_KSNODETYPE_DSS_AUDIO\ + DEFINE_USB_TERMINAL_GUID(0x070F) +DEFINE_GUIDSTRUCT("DFF220EF-F70F-11D0-B917-00A0C9223196", KSNODETYPE_DSS_AUDIO); +#define KSNODETYPE_DSS_AUDIO DEFINE_GUIDNAMED(KSNODETYPE_DSS_AUDIO) + +#define STATIC_KSNODETYPE_RADIO_RECEIVER\ + DEFINE_USB_TERMINAL_GUID(0x0710) +DEFINE_GUIDSTRUCT("DFF220F0-F70F-11D0-B917-00A0C9223196", KSNODETYPE_RADIO_RECEIVER); +#define KSNODETYPE_RADIO_RECEIVER DEFINE_GUIDNAMED(KSNODETYPE_RADIO_RECEIVER) + +#define STATIC_KSNODETYPE_RADIO_TRANSMITTER\ + DEFINE_USB_TERMINAL_GUID(0x0711) +DEFINE_GUIDSTRUCT("DFF220F1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_RADIO_TRANSMITTER); +#define KSNODETYPE_RADIO_TRANSMITTER DEFINE_GUIDNAMED(KSNODETYPE_RADIO_TRANSMITTER) + +#define STATIC_KSNODETYPE_MULTITRACK_RECORDER\ + DEFINE_USB_TERMINAL_GUID(0x0712) +DEFINE_GUIDSTRUCT("DFF220F2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_MULTITRACK_RECORDER); +#define KSNODETYPE_MULTITRACK_RECORDER DEFINE_GUIDNAMED(KSNODETYPE_MULTITRACK_RECORDER) + +#define STATIC_KSNODETYPE_SYNTHESIZER\ + DEFINE_USB_TERMINAL_GUID(0x0713) +DEFINE_GUIDSTRUCT("DFF220F3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_SYNTHESIZER); +#define KSNODETYPE_SYNTHESIZER DEFINE_GUIDNAMED(KSNODETYPE_SYNTHESIZER) + +#define STATIC_KSNODETYPE_HDMI_INTERFACE\ + 0xd1b9cc2a, 0xf519, 0x417f, 0x91, 0xc9, 0x55, 0xfa, 0x65, 0x48, 0x10, 0x01 +DEFINE_GUIDSTRUCT("D1B9CC2A-F519-417f-91C9-55FA65481001", KSNODETYPE_HDMI_INTERFACE); +#define KSNODETYPE_HDMI_INTERFACE DEFINE_GUIDNAMED(KSNODETYPE_HDMI_INTERFACE) + +#define STATIC_KSNODETYPE_DISPLAYPORT_INTERFACE\ + 0xe47e4031, 0x3ea6, 0x418d, 0x8f, 0x9b, 0xb7, 0x38, 0x43, 0xcc, 0xba, 0x97 +DEFINE_GUIDSTRUCT("E47E4031-3EA6-418d-8F9B-B73843CCBA97", KSNODETYPE_DISPLAYPORT_INTERFACE); +#define KSNODETYPE_DISPLAYPORT_INTERFACE DEFINE_GUIDNAMED(KSNODETYPE_DISPLAYPORT_INTERFACE) + +#define STATIC_KSNODETYPE_AUDIO_LOOPBACK\ + 0x8f42c0b2, 0x91ce, 0x4bcf, 0x9c, 0xcd, 0xe, 0x59, 0x90, 0x37, 0xab, 0x35 +DEFINE_GUIDSTRUCT("8F42C0B2-91CE-4BCF-9CCD-0E599037AB35", KSNODETYPE_AUDIO_LOOPBACK); +#define KSNODETYPE_AUDIO_LOOPBACK DEFINE_GUIDNAMED(KSNODETYPE_AUDIO_LOOPBACK) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define STATIC_KSNODETYPE_AUDIO_KEYWORDDETECTOR\ + 0x3817e0b8, 0xdf58, 0x4375, 0xb6, 0x69, 0xc4, 0x96, 0x34, 0x33, 0x1f, 0x9d +DEFINE_GUIDSTRUCT("3817E0B8-DF58-4375-B669-C49634331F9D", KSNODETYPE_AUDIO_KEYWORDDETECTOR); +#define KSNODETYPE_AUDIO_KEYWORDDETECTOR DEFINE_GUIDNAMED(KSNODETYPE_AUDIO_KEYWORDDETECTOR) +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define STATIC_KSNODETYPE_AUDIO_MODULE\ + 0x45aab42e, 0xcaeb, 0x4052, 0x8a, 0xa9, 0xb3, 0x8c, 0xb5, 0x10, 0x96, 0x19 +DEFINE_GUIDSTRUCT("45AAB42E-CAEB-4052-8AA9-B38CB5109619", KSNODETYPE_AUDIO_MODULE); +#define KSNODETYPE_AUDIO_MODULE DEFINE_GUIDNAMED(KSNODETYPE_AUDIO_MODULE) +#endif + + +// USB MIDI Nodes +#define STATIC_KSNODETYPE_MIDI_JACK\ + 0x265e0c3f, 0xfa39, 0x4df3, 0xab, 0x04, 0xbe, 0x01, 0xb9, 0x1e, 0x29, 0x9a +DEFINE_GUIDSTRUCT("265E0C3F-FA39-4df3-AB04-BE01B91E299A", KSNODETYPE_MIDI_JACK); +#define KSNODETYPE_MIDI_JACK DEFINE_GUIDNAMED(KSNODETYPE_MIDI_JACK) + +#define STATIC_KSNODETYPE_MIDI_ELEMENT\ + 0x01c6fe66, 0x6e48, 0x4c65, 0xac, 0x9b, 0x52, 0xdb, 0x5d, 0x65, 0x6c, 0x7e +DEFINE_GUIDSTRUCT("01C6FE66-6E48-4c65-AC9B-52DB5D656C7E", KSNODETYPE_MIDI_ELEMENT); +#define KSNODETYPE_MIDI_ELEMENT DEFINE_GUIDNAMED(KSNODETYPE_MIDI_ELEMENT) + +// Hardware Audio Engine Node +#define STATIC_KSNODETYPE_AUDIO_ENGINE\ + 0x35caf6e4, 0xf3b3, 0x4168, 0xbb, 0x4b, 0x55, 0xe7, 0x7a, 0x46, 0x1c, 0x7e +DEFINE_GUIDSTRUCT("35CAF6E4-F3B3-4168-BB4B-55E77A461C7E", KSNODETYPE_AUDIO_ENGINE); +#define KSNODETYPE_AUDIO_ENGINE DEFINE_GUIDNAMED(KSNODETYPE_AUDIO_ENGINE) + +// KS Node type for speakers node with static jack +#define STATIC_KSNODETYPE_SPEAKERS_STATIC_JACK\ + 0x28e04f87, 0x4dbe, 0x4f8d, 0x85, 0x89, 0x2, 0x5d, 0x20, 0x9d, 0xfb, 0x4a +DEFINE_GUIDSTRUCT("28E04F87-4DBE-4f8d-8589-025D209DFB4A", KSNODETYPE_SPEAKERS_STATIC_JACK); +#define KSNODETYPE_SPEAKERS_STATIC_JACK DEFINE_GUIDNAMED(KSNODETYPE_SPEAKERS_STATIC_JACK) + +// GUID for Spdif Out pin name +#define STATIC_PINNAME_SPDIF_OUT\ + 0x3a264481, 0xe52c, 0x4b82, 0x8e, 0x7a, 0xc8, 0xe2, 0xf9, 0x1d, 0xc3, 0x80 +DEFINE_GUIDSTRUCT("3A264481-E52C-4b82-8E7A-C8E2F91DC380", PINNAME_SPDIF_OUT); +#define PINNAME_SPDIF_OUT DEFINE_GUIDNAMED(PINNAME_SPDIF_OUT) + +// GUID for Spdif In pin name +#define STATIC_PINNAME_SPDIF_IN\ + 0x15dc9025, 0x22ad, 0x41b3, 0x88, 0x75, 0xf4, 0xce, 0xb0, 0x29, 0x9e, 0x20 +DEFINE_GUIDSTRUCT("15DC9025-22AD-41b3-8875-F4CEB0299E20", PINNAME_SPDIF_IN); +#define PINNAME_SPDIF_IN DEFINE_GUIDNAMED(PINNAME_SPDIF_IN) + +// GUID for HDMI Out pin name +#define STATIC_PINNAME_HDMI_OUT\ + 0x387bfc03, 0xe7ef, 0x4901, 0x86, 0xe0, 0x35, 0xb7, 0xc3, 0x2b, 0x0, 0xef +DEFINE_GUIDSTRUCT("387BFC03-E7EF-4901-86E0-35B7C32B00EF", PINNAME_HDMI_OUT); +#define PINNAME_HDMI_OUT DEFINE_GUIDNAMED(PINNAME_HDMI_OUT) + +// GUID for Display Port Out pin name +#define STATIC_PINNAME_DISPLAYPORT_OUT\ + 0x21fbb329, 0x1a4a, 0x48da, 0xa0, 0x76, 0x23, 0x18, 0xa3, 0xc5, 0x9b, 0x26 +DEFINE_GUIDSTRUCT("21FBB329-1A4A-48da-A076-2318A3C59B26", PINNAME_DISPLAYPORT_OUT); +#define PINNAME_DISPLAYPORT_OUT DEFINE_GUIDNAMED(PINNAME_DISPLAYPORT_OUT) + +#if (NTDDI_VERSION < NTDDI_VISTA) + +// Microsoft's WDMAUD virtual swsynth pin name guid + +#define STATIC_KSNODETYPE_SWSYNTH\ + 0x423274A0L, 0x8B81, 0x11D1, 0xA0, 0x50, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("423274A0-8B81-11D1-A050-0000F8004788", KSNODETYPE_SWSYNTH); +#define KSNODETYPE_SWSYNTH DEFINE_GUIDNAMED(KSNODETYPE_SWSYNTH) + +// Microsoft's SWMIDI midi pin and node name guid + +#define STATIC_KSNODETYPE_SWMIDI\ + 0xCB9BEFA0L, 0xA251, 0x11D1, 0xA0, 0x50, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("CB9BEFA0-A251-11D1-A050-0000F8004788", KSNODETYPE_SWMIDI); +#define KSNODETYPE_SWMIDI DEFINE_GUIDNAMED(KSNODETYPE_SWMIDI) + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_DRM_DESCRAMBLE\ + 0xFFBB6E3FL, 0xCCFE, 0x4D84, 0x90, 0xD9, 0x42, 0x14, 0x18, 0xB0, 0x3A, 0x8E +DEFINE_GUIDSTRUCT("FFBB6E3F-CCFE-4D84-90D9-421418B03A8E", KSNODETYPE_DRM_DESCRAMBLE); +#define KSNODETYPE_DRM_DESCRAMBLE DEFINE_GUIDNAMED(KSNODETYPE_DRM_DESCRAMBLE) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +// +// Nodetypes for Windows Phone Cellular Streaming. +// + +// {686D7CC0-D903-4258-B443-3A3D3580741C} +#define STATIC_KSNODETYPE_TELEPHONY_BIDI \ + 0x686d7cc0, 0xd903, 0x4258, 0xb4, 0x43, 0x3a, 0x3d, 0x35, 0x80, 0x74, 0x1c +DEFINE_GUIDSTRUCT("686D7CC0-D903-4258-B443-3A3D3580741C", KSNODETYPE_TELEPHONY_BIDI); +#define KSNODETYPE_TELEPHONY_BIDI DEFINE_GUIDNAMED(KSNODETYPE_TELEPHONY_BIDI) + +// +// Nodetype for FM Receiver. +// + +// {834A733C-F485-41C0-A62B-513025014E40} +#define STATIC_KSNODETYPE_FM_RX \ + 0x834a733c, 0xf485, 0x41c0, 0xa6, 0x2b, 0x51, 0x30, 0x25, 0x1, 0x4e, 0x40 +DEFINE_GUIDSTRUCT("834A733C-F485-41C0-A62B-513025014E40", KSNODETYPE_FM_RX); +#define KSNODETYPE_FM_RX DEFINE_GUIDNAMED(KSNODETYPE_FM_RX) + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + + +// General categories +#define STATIC_KSCATEGORY_AUDIO \ + 0x6994AD04L, 0x93EF, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("6994AD04-93EF-11D0-A3CC-00A0C9223196", KSCATEGORY_AUDIO); +#define KSCATEGORY_AUDIO DEFINE_GUIDNAMED(KSCATEGORY_AUDIO) + + +#define STATIC_KSCATEGORY_VIDEO \ + 0x6994AD05L, 0x93EF, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("6994AD05-93EF-11D0-A3CC-00A0C9223196", KSCATEGORY_VIDEO); +#define KSCATEGORY_VIDEO DEFINE_GUIDNAMED(KSCATEGORY_VIDEO) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define STATIC_KSCATEGORY_REALTIME \ + 0xEB115FFCL, 0x10C8, 0x4964, 0x83, 0x1D, 0x6D, 0xCB, 0x02, 0xE6, 0xF2, 0x3F +DEFINE_GUIDSTRUCT("EB115FFC-10C8-4964-831D-6DCB02E6F23F", KSCATEGORY_REALTIME); +#define KSCATEGORY_REALTIME DEFINE_GUIDNAMED(KSCATEGORY_REALTIME) +#endif + +#define STATIC_KSCATEGORY_TEXT \ + 0x6994AD06L, 0x93EF, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("6994AD06-93EF-11D0-A3CC-00A0C9223196", KSCATEGORY_TEXT); +#define KSCATEGORY_TEXT DEFINE_GUIDNAMED(KSCATEGORY_TEXT) + +#define STATIC_KSCATEGORY_NETWORK \ + 0x67C9CC3CL, 0x69C4, 0x11D2, 0x87, 0x59, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("67C9CC3C-69C4-11D2-8759-00A0C9223196", KSCATEGORY_NETWORK); +#define KSCATEGORY_NETWORK DEFINE_GUIDNAMED(KSCATEGORY_NETWORK) + +#define STATIC_KSCATEGORY_TOPOLOGY \ + 0xDDA54A40L, 0x1E4C, 0x11D1, 0xA0, 0x50, 0x40, 0x57, 0x05, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("DDA54A40-1E4C-11D1-A050-405705C10000", KSCATEGORY_TOPOLOGY); +#define KSCATEGORY_TOPOLOGY DEFINE_GUIDNAMED(KSCATEGORY_TOPOLOGY) + +#define STATIC_KSCATEGORY_VIRTUAL \ + 0x3503EAC4L, 0x1F26, 0x11D1, 0x8A, 0xB0, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("3503EAC4-1F26-11D1-8AB0-00A0C9223196", KSCATEGORY_VIRTUAL); +#define KSCATEGORY_VIRTUAL DEFINE_GUIDNAMED(KSCATEGORY_VIRTUAL) + +#define STATIC_KSCATEGORY_ACOUSTIC_ECHO_CANCEL \ + 0xBF963D80L, 0xC559, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("BF963D80-C559-11D0-8A2B-00A0C9255AC1", KSCATEGORY_ACOUSTIC_ECHO_CANCEL); +#define KSCATEGORY_ACOUSTIC_ECHO_CANCEL DEFINE_GUIDNAMED(KSCATEGORY_ACOUSTIC_ECHO_CANCEL) + +#if (NTDDI_VERSION < NTDDI_VISTA) + +#define STATIC_KSCATEGORY_SYSAUDIO \ + 0xA7C7A5B1L, 0x5AF3, 0x11D1, 0x9C, 0xED, 0x00, 0xA0, 0x24, 0xBF, 0x04, 0x07 +DEFINE_GUIDSTRUCT("A7C7A5B1-5AF3-11D1-9CED-00A024BF0407", KSCATEGORY_SYSAUDIO); +#define KSCATEGORY_SYSAUDIO DEFINE_GUIDNAMED(KSCATEGORY_SYSAUDIO) + +#define STATIC_KSCATEGORY_WDMAUD \ + 0x3E227E76L, 0x690D, 0x11D2, 0x81, 0x61, 0x00, 0x00, 0xF8, 0x77, 0x5B, 0xF1 +DEFINE_GUIDSTRUCT("3E227E76-690D-11D2-8161-0000F8775BF1", KSCATEGORY_WDMAUD); +#define KSCATEGORY_WDMAUD DEFINE_GUIDNAMED(KSCATEGORY_WDMAUD) + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#define STATIC_KSCATEGORY_AUDIO_GFX \ + 0x9BAF9572L, 0x340C, 0x11D3, 0xAB, 0xDC, 0x00, 0xA0, 0xC9, 0x0A, 0xB1, 0x6F +DEFINE_GUIDSTRUCT("9BAF9572-340C-11D3-ABDC-00A0C90AB16F", KSCATEGORY_AUDIO_GFX); +#define KSCATEGORY_AUDIO_GFX DEFINE_GUIDNAMED(KSCATEGORY_AUDIO_GFX) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#define STATIC_KSCATEGORY_AUDIO_SPLITTER \ + 0x9EA331FAL, 0xB91B, 0x45F8, 0x92, 0x85, 0xBD, 0x2B, 0xC7, 0x7A, 0xFC, 0xDE +DEFINE_GUIDSTRUCT("9EA331FA-B91B-45F8-9285-BD2BC77AFCDE", KSCATEGORY_AUDIO_SPLITTER); +#define KSCATEGORY_AUDIO_SPLITTER DEFINE_GUIDNAMED(KSCATEGORY_AUDIO_SPLITTER) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#define STATIC_KSCATEGORY_SYNTHESIZER STATIC_KSNODETYPE_SYNTHESIZER +#define KSCATEGORY_SYNTHESIZER KSNODETYPE_SYNTHESIZER + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSCATEGORY_DRM_DESCRAMBLE STATIC_KSNODETYPE_DRM_DESCRAMBLE +#define KSCATEGORY_DRM_DESCRAMBLE KSNODETYPE_DRM_DESCRAMBLE + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION < NTDDI_VISTA) + +#define STATIC_KSCATEGORY_AUDIO_DEVICE \ + 0xFBF6F530L, 0x07B9, 0x11D2, 0xA7, 0x1E, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("FBF6F530-07B9-11D2-A71E-0000F8004788", KSCATEGORY_AUDIO_DEVICE); +#define KSCATEGORY_AUDIO_DEVICE DEFINE_GUIDNAMED(KSCATEGORY_AUDIO_DEVICE) + +#define STATIC_KSCATEGORY_PREFERRED_WAVEOUT_DEVICE \ + 0xD6C5066EL, 0x72C1, 0x11D2, 0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("D6C5066E-72C1-11D2-9755-0000F8004788", KSCATEGORY_PREFERRED_WAVEOUT_DEVICE); +#define KSCATEGORY_PREFERRED_WAVEOUT_DEVICE DEFINE_GUIDNAMED(KSCATEGORY_PREFERRED_WAVEOUT_DEVICE) + +#define STATIC_KSCATEGORY_PREFERRED_WAVEIN_DEVICE \ + 0xD6C50671L, 0x72C1, 0x11D2, 0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("D6C50671-72C1-11D2-9755-0000F8004788", KSCATEGORY_PREFERRED_WAVEIN_DEVICE); +#define KSCATEGORY_PREFERRED_WAVEIN_DEVICE DEFINE_GUIDNAMED(KSCATEGORY_PREFERRED_WAVEIN_DEVICE) + +#define STATIC_KSCATEGORY_PREFERRED_MIDIOUT_DEVICE \ + 0xD6C50674L, 0x72C1, 0x11D2, 0x97, 0x55, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("D6C50674-72C1-11D2-9755-0000F8004788", KSCATEGORY_PREFERRED_MIDIOUT_DEVICE); +#define KSCATEGORY_PREFERRED_MIDIOUT_DEVICE DEFINE_GUIDNAMED(KSCATEGORY_PREFERRED_MIDIOUT_DEVICE) + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +// Special pin category for wdmaud + +#define STATIC_KSCATEGORY_WDMAUD_USE_PIN_NAME \ + 0x47A4FA20L, 0xA251, 0x11D1, 0xA0, 0x50, 0x00, 0x00, 0xF8, 0x00, 0x47, 0x88 +DEFINE_GUIDSTRUCT("47A4FA20-A251-11D1-A050-0000F8004788", KSCATEGORY_WDMAUD_USE_PIN_NAME); +#define KSCATEGORY_WDMAUD_USE_PIN_NAME DEFINE_GUIDNAMED(KSCATEGORY_WDMAUD_USE_PIN_NAME) + +// Escalante Platform Interface + +#define STATIC_KSCATEGORY_ESCALANTE_PLATFORM_DRIVER \ + 0x74f3aea8L, 0x9768, 0x11d1, 0x8e, 0x07, 0x00, 0xa0, 0xc9, 0x5e, 0xc2, 0x2e +DEFINE_GUIDSTRUCT("74f3aea8-9768-11d1-8e07-00a0c95ec22e", KSCATEGORY_ESCALANTE_PLATFORM_DRIVER); +#define KSCATEGORY_ESCALANTE_PLATFORM_DRIVER DEFINE_GUIDNAMED(KSCATEGORY_ESCALANTE_PLATFORM_DRIVER) + +// -- major types --- + +// 'vids' == MEDIATYPE_Video, +#define STATIC_KSDATAFORMAT_TYPE_VIDEO\ + 0x73646976L, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("73646976-0000-0010-8000-00aa00389b71", KSDATAFORMAT_TYPE_VIDEO); +#define KSDATAFORMAT_TYPE_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_VIDEO) + +// 'auds' == MEDIATYPE_Audio +#define STATIC_KSDATAFORMAT_TYPE_AUDIO\ + 0x73647561L, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("73647561-0000-0010-8000-00aa00389b71", KSDATAFORMAT_TYPE_AUDIO); +#define KSDATAFORMAT_TYPE_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_AUDIO) + +// 'txts' == MEDIATYPE_Text +#define STATIC_KSDATAFORMAT_TYPE_TEXT\ + 0x73747874L, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("73747874-0000-0010-8000-00aa00389b71", KSDATAFORMAT_TYPE_TEXT); +#define KSDATAFORMAT_TYPE_TEXT DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_TEXT) + +#if !defined( DEFINE_WAVEFORMATEX_GUID ) +#define DEFINE_WAVEFORMATEX_GUID(x) (USHORT)(x), 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +#endif + +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_WAVEFORMATEX ) +#define STATIC_KSDATAFORMAT_SUBTYPE_WAVEFORMATEX\ + 0x00000000L, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000000-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_WAVEFORMATEX); +#define KSDATAFORMAT_SUBTYPE_WAVEFORMATEX DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_WAVEFORMATEX) +#endif + +#if !defined( INIT_WAVEFORMATEX_GUID ) +#define INIT_WAVEFORMATEX_GUID(Guid, x)\ +{\ + *(Guid) = KSDATAFORMAT_SUBTYPE_WAVEFORMATEX;\ + (Guid)->Data1 = (USHORT)(x);\ +} +#endif + +#if !defined( EXTRACT_WAVEFORMATEX_ID ) +#define EXTRACT_WAVEFORMATEX_ID(Guid)\ + (USHORT)((Guid)->Data1) +#endif + +#if !defined( IS_VALID_WAVEFORMATEX_GUID ) +#define IS_VALID_WAVEFORMATEX_GUID(Guid)\ + (!memcmp(((PUSHORT)&KSDATAFORMAT_SUBTYPE_WAVEFORMATEX) + 1, ((PUSHORT)(Guid)) + 1, sizeof(GUID) - sizeof(USHORT))) +#endif + +#if !defined(INIT_MMREG_MID) +//{d5a47fa7-6d98-11d1-a21a-00a0c9223196} +#define INIT_MMREG_MID(guid, id)\ +{\ + (guid)->Data1 = 0xd5a47fa7 + (USHORT)(id);\ + (guid)->Data2 = 0x6d98;\ + (guid)->Data3 = 0x11d1;\ + (guid)->Data4[0] = 0xa2;\ + (guid)->Data4[1] = 0x1a;\ + (guid)->Data4[2] = 0x00;\ + (guid)->Data4[3] = 0xa0;\ + (guid)->Data4[4] = 0xc9;\ + (guid)->Data4[5] = 0x22;\ + (guid)->Data4[6] = 0x31;\ + (guid)->Data4[7] = 0x96;\ +} +#define EXTRACT_MMREG_MID(guid)\ + (USHORT)((guid)->Data1 - 0xd5a47fa7) +#define DEFINE_MMREG_MID_GUID(id)\ + 0xd5a47fa7+(USHORT)(id), 0x6d98, 0x11d1, 0xa2, 0x1a, 0x00, 0xa0, 0xc9, 0x22, 0x31, 0x96 + +#define IS_COMPATIBLE_MMREG_MID(guid)\ + (((guid)->Data1 >= 0xd5a47fa7) &&\ + ((guid)->Data1 < 0xd5a47fa7 + 0xffff) &&\ + ((guid)->Data2 == 0x6d98) &&\ + ((guid)->Data3 == 0x11d1) &&\ + ((guid)->Data4[0] == 0xa2) &&\ + ((guid)->Data4[1] == 0x1a) &&\ + ((guid)->Data4[2] == 0x00) &&\ + ((guid)->Data4[3] == 0xa0) &&\ + ((guid)->Data4[4] == 0xc9) &&\ + ((guid)->Data4[5] == 0x22) &&\ + ((guid)->Data4[6] == 0x31) &&\ + ((guid)->Data4[7] == 0x96)) +#endif // !defined(INIT_MMREG_MID) + +#if !defined(INIT_MMREG_PID) +//{e36dc2ac-6d9a-11d1-a21a-00a0c9223196} +#define INIT_MMREG_PID(guid, id)\ +{\ + (guid)->Data1 = 0xe36dc2ac + (USHORT)(id);\ + (guid)->Data2 = 0x6d9a;\ + (guid)->Data3 = 0x11d1;\ + (guid)->Data4[0] = 0xa2;\ + (guid)->Data4[1] = 0x1a;\ + (guid)->Data4[2] = 0x00;\ + (guid)->Data4[3] = 0xa0;\ + (guid)->Data4[4] = 0xc9;\ + (guid)->Data4[5] = 0x22;\ + (guid)->Data4[6] = 0x31;\ + (guid)->Data4[7] = 0x96;\ +} +#define EXTRACT_MMREG_PID(guid)\ + (USHORT)((guid)->Data1 - 0xe36dc2ac) +#define DEFINE_MMREG_PID_GUID(id)\ + 0xe36dc2ac+(USHORT)(id), 0x6d9a, 0x11d1, 0xa2, 0x1a, 0x00, 0xa0, 0xc9, 0x22, 0x31, 0x96 + +#define IS_COMPATIBLE_MMREG_PID(guid)\ + (((guid)->Data1 >= 0xe36dc2ac) &&\ + ((guid)->Data1 < 0xe36dc2ac + 0xffff) &&\ + ((guid)->Data2 == 0x6d9a) &&\ + ((guid)->Data3 == 0x11d1) &&\ + ((guid)->Data4[0] == 0xa2) &&\ + ((guid)->Data4[1] == 0x1a) &&\ + ((guid)->Data4[2] == 0x00) &&\ + ((guid)->Data4[3] == 0xa0) &&\ + ((guid)->Data4[4] == 0xc9) &&\ + ((guid)->Data4[5] == 0x22) &&\ + ((guid)->Data4[6] == 0x31) &&\ + ((guid)->Data4[7] == 0x96)) +#endif // !defined(INIT_MMREG_PID) + +#define STATIC_KSDATAFORMAT_SUBTYPE_ANALOG\ + 0x6dba3190L, 0x67bd, 0x11cf, 0xa0, 0xf7, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("6dba3190-67bd-11cf-a0f7-0020afd156e4", KSDATAFORMAT_SUBTYPE_ANALOG); +#define KSDATAFORMAT_SUBTYPE_ANALOG DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_ANALOG) + +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_PCM ) +#define STATIC_KSDATAFORMAT_SUBTYPE_PCM\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_PCM) +DEFINE_GUIDSTRUCT("00000001-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_PCM); +#define KSDATAFORMAT_SUBTYPE_PCM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_PCM) +#endif + +#if defined(_INC_MMREG) +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT ) +#define STATIC_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_IEEE_FLOAT) +DEFINE_GUIDSTRUCT("00000003-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEEE_FLOAT); +#define KSDATAFORMAT_SUBTYPE_IEEE_FLOAT DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEEE_FLOAT) +#endif + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSDATAFORMAT_SUBTYPE_DRM\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_DRM) +DEFINE_GUIDSTRUCT("00000009-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_DRM); +#define KSDATAFORMAT_SUBTYPE_DRM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_DRM) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSDATAFORMAT_SUBTYPE_ALAW\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_ALAW) +DEFINE_GUIDSTRUCT("00000006-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_ALAW); +#define KSDATAFORMAT_SUBTYPE_ALAW DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_ALAW) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MULAW\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_MULAW) +DEFINE_GUIDSTRUCT("00000007-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MULAW); +#define KSDATAFORMAT_SUBTYPE_MULAW DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MULAW) + +#define STATIC_KSDATAFORMAT_SUBTYPE_ADPCM\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_ADPCM) +DEFINE_GUIDSTRUCT("00000002-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_ADPCM); +#define KSDATAFORMAT_SUBTYPE_ADPCM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_ADPCM) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_MPEG) +DEFINE_GUIDSTRUCT("00000050-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MPEG); +#define KSDATAFORMAT_SUBTYPE_MPEG DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG) +#endif // defined(_INC_MMREG) + +#define STATIC_KSDATAFORMAT_SPECIFIER_VC_ID\ + 0xAD98D184L, 0xAAC3, 0x11D0, 0xA4, 0x1C, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("AD98D184-AAC3-11D0-A41C-00A0C9223196", KSDATAFORMAT_SPECIFIER_VC_ID); +#define KSDATAFORMAT_SPECIFIER_VC_ID DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_VC_ID) + +#define STATIC_KSDATAFORMAT_SPECIFIER_WAVEFORMATEX\ + 0x05589f81L, 0xc356, 0x11ce, 0xbf, 0x01, 0x00, 0xaa, 0x00, 0x55, 0x59, 0x5a +DEFINE_GUIDSTRUCT("05589f81-c356-11ce-bf01-00aa0055595a", KSDATAFORMAT_SPECIFIER_WAVEFORMATEX); +#define KSDATAFORMAT_SPECIFIER_WAVEFORMATEX DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_WAVEFORMATEX) + +#define STATIC_KSDATAFORMAT_SPECIFIER_DSOUND\ + 0x518590a2L, 0xa184, 0x11d0, 0x85, 0x22, 0x00, 0xc0, 0x4f, 0xd9, 0xba, 0xf3 +DEFINE_GUIDSTRUCT("518590a2-a184-11d0-8522-00c04fd9baf3", KSDATAFORMAT_SPECIFIER_DSOUND); +#define KSDATAFORMAT_SPECIFIER_DSOUND DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DSOUND) + +#if defined(_INC_MMSYSTEM) || defined(_INC_MMREG) +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif +// Convenient wrapper structure for the case in which the WaveFormatEx is +// known not to contain extra data. +typedef struct { + KSDATAFORMAT DataFormat; + WAVEFORMATEX WaveFormatEx; +} KSDATAFORMAT_WAVEFORMATEX, *PKSDATAFORMAT_WAVEFORMATEX; + +#ifndef _WAVEFORMATEXTENSIBLE_ +#define _WAVEFORMATEXTENSIBLE_ +typedef struct { + WAVEFORMATEX Format; + union { + WORD wValidBitsPerSample; /* bits of precision */ + WORD wSamplesPerBlock; /* valid if wBitsPerSample==0 */ + WORD wReserved; /* If neither applies, set to zero. */ + } Samples; + DWORD dwChannelMask; /* which channels are */ + /* present in stream */ + GUID SubFormat; +} WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE; +#endif // !_WAVEFORMATEXTENSIBLE_ + +#ifndef _WAVEFORMATEXTENSIBLE_IEC61937_ +#define _WAVEFORMATEXTENSIBLE_IEC61937_ +typedef struct { + WAVEFORMATEXTENSIBLE FormatExt; /* Format of encoded data as it is */ + /* intended to be streamed over the link */ + DWORD dwEncodedSamplesPerSec; /* Sampling rate of the post-decode audio. */ + DWORD dwEncodedChannelCount; /* Channel count of the post-decode audio. */ + DWORD dwAverageBytesPerSec; /* Byte rate of the content, can be 0. */ +} WAVEFORMATEXTENSIBLE_IEC61937, *PWAVEFORMATEXTENSIBLE_IEC61937; +#endif // !_WAVEFORMATEXTENSIBLE_IEC61937_ + +#if !defined(WAVE_FORMAT_EXTENSIBLE) +#define WAVE_FORMAT_EXTENSIBLE 0xFFFE +#endif // !defined(WAVE_FORMAT_EXTENSIBLE) + +// Convenient wrapper structure for the case in which the WaveFormatExt is +// known not to contain extra data. +typedef struct +{ + KSDATAFORMAT DataFormat; + WAVEFORMATEXTENSIBLE WaveFormatExt; +} KSDATAFORMAT_WAVEFORMATEXTENSIBLE, *PKSDATAFORMAT_WAVEFORMATEXTENSIBLE; + +// DirectSound buffer description +typedef struct { + ULONG Flags; + ULONG Control; + WAVEFORMATEX WaveFormatEx; +} KSDSOUND_BUFFERDESC, *PKSDSOUND_BUFFERDESC; + +// DirectSound format +typedef struct { + KSDATAFORMAT DataFormat; + KSDSOUND_BUFFERDESC BufferDesc; +} KSDATAFORMAT_DSOUND, *PKSDATAFORMAT_DSOUND; + +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif +#endif // defined(_INC_MMSYSTEM) || defined(_INC_MMREG) + + + +// DirectSound buffer flags +#define KSDSOUND_BUFFER_PRIMARY 0x00000001 +#define KSDSOUND_BUFFER_STATIC 0x00000002 +#define KSDSOUND_BUFFER_LOCHARDWARE 0x00000004 +#define KSDSOUND_BUFFER_LOCSOFTWARE 0x00000008 + +// DirectSound buffer control flags +#define KSDSOUND_BUFFER_CTRL_3D 0x00000001 +#define KSDSOUND_BUFFER_CTRL_FREQUENCY 0x00000002 +#define KSDSOUND_BUFFER_CTRL_PAN 0x00000004 +#define KSDSOUND_BUFFER_CTRL_VOLUME 0x00000008 +#define KSDSOUND_BUFFER_CTRL_POSITIONNOTIFY 0x00000010 + +typedef struct { +#if defined(_NTDDK_) + ULONGLONG PlayOffset; + ULONGLONG WriteOffset; +#else // !_NTDDK_ + DWORDLONG PlayOffset; + DWORDLONG WriteOffset; +#endif // !_NTDDK_ +} KSAUDIO_POSITION, *PKSAUDIO_POSITION; + +//The KSAUDIO_PRESENTATION_POSITION structure specifies the current positions of audio data being rendered to the KS pin instance. +typedef struct +{ + UINT64 u64PositionInBlocks; // The block offset from the start of the stream to the current post-decoded uncompressed + // position in the stream, where a block is the group of channels in the same sample; for a PCM stream, + // a block is same as a frame. For compressed formats, a block is a single sample within a frame + // (eg. each MP3 frame has 1152 samples or 1152 blocks) + UINT64 u64QPCPosition; // The value of the performance counter at the time that the audio endpoint device read the device + // position (*pu64Position) in response to the KSAUDIO_PRESENTATION_POSITION call. +} KSAUDIO_PRESENTATION_POSITION, *PKSAUDIO_PRESENTATION_POSITION; + + +typedef enum { + CONSTRICTOR_OPTION_DISABLE = 0, + CONSTRICTOR_OPTION_MUTE +} CONSTRICTOR_OPTION; + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#ifdef DEFINE_DEVPROPKEY +// {13E004D6-B066-43BD-913B-A415CD13DA87},2 +DEFINE_DEVPROPKEY(DEVPKEY_KsAudio_PacketSize_Constraints, 0x13e004d6, 0xb066, 0x43bd, 0x91, 0x3b, 0xa4, 0x15, 0xcd, 0x13, 0xda, 0x87, 2); // DEVPROP_TYPE_BINARY +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +#ifdef DEFINE_DEVPROPKEY +// {13E004D6-B066-43BD-913B-A415CD13DA87},3 +// This property is the symbolic link to an interface of type 'GUID_KSCATEGORY_AUDIO_CONTROLLER_INTERFACE' published +// by the KS Filter or miniport drivers on the KSCATEGORY_AUDIO interface to indicate the audio system about the 'controller' +// device interface symbolic link that will provide extended information about this audio endpoint +DEFINE_DEVPROPKEY(DEVPKEY_KsAudio_Controller_DeviceInterface_Path, 0x13e004d6, 0xb066, 0x43bd, 0x91, 0x3b, 0xa4, 0x15, 0xcd, 0x13, 0xda, 0x87, 3); // DEVPROP_TYPE_STRING +#endif // DEFINE_DEVPROPKEY +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS5) + +typedef struct _KSAUDIO_PACKETSIZE_SIGNALPROCESSINGMODE_CONSTRAINT +{ + GUID ProcessingMode; + ULONG SamplesPerProcessingPacket; + ULONG ProcessingPacketDurationInHns; +} KSAUDIO_PACKETSIZE_PROCESSINGMODE_CONSTRAINT; + +typedef struct _KSAUDIO_PACKETSIZE_CONSTRAINTS +{ + ULONG MinPacketPeriodInHns; + ULONG PacketSizeFileAlignment; + ULONG Reserved; + ULONG NumProcessingModeConstraints; + _Field_size_(NumProcessingModeConstraints) KSAUDIO_PACKETSIZE_PROCESSINGMODE_CONSTRAINT ProcessingModeConstraints[ANYSIZE_ARRAY]; +} KSAUDIO_PACKETSIZE_CONSTRAINTS; +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) +#ifdef DEFINE_DEVPROPKEY +// {9404F781-7191-409B-8B0B-80BF6EC229AE},2 +DEFINE_DEVPROPKEY(DEVPKEY_KsAudio_PacketSize_Constraints2, 0x9404f781, 0x7191, 0x409b, 0x8b, 0xb, 0x80, 0xbf, 0x6e, 0xc2, 0x29, 0xae, 2); // DEVPROP_TYPE_BINARY +#endif + +typedef struct _KSAUDIO_PACKETSIZE_CONSTRAINTS2 +{ + ULONG MinPacketPeriodInHns; + ULONG PacketSizeFileAlignment; + ULONG MaxPacketSizeInBytes; + ULONG NumProcessingModeConstraints; + _Field_size_(NumProcessingModeConstraints) KSAUDIO_PACKETSIZE_PROCESSINGMODE_CONSTRAINT ProcessingModeConstraints[ANYSIZE_ARRAY]; +} KSAUDIO_PACKETSIZE_CONSTRAINTS2; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +//=========================================================================== +// Microphone array pin descriptor + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef enum { + KSMICARRAY_MICTYPE_OMNIDIRECTIONAL, + KSMICARRAY_MICTYPE_SUBCARDIOID, + KSMICARRAY_MICTYPE_CARDIOID, + KSMICARRAY_MICTYPE_SUPERCARDIOID, + KSMICARRAY_MICTYPE_HYPERCARDIOID, + KSMICARRAY_MICTYPE_8SHAPED, + KSMICARRAY_MICTYPE_VENDORDEFINED = 0x0F +} KSMICARRAY_MICTYPE; + +typedef struct { + USHORT usType; // Type of Microphone + SHORT wXCoord; // X Coordinate of Mic + SHORT wYCoord; // Y Coordinate of Mic + SHORT wZCoord; // Z Coordinate of Mic + SHORT wVerticalAngle; // MRA Vertical Angle + SHORT wHorizontalAngle; // MRA Horizontal Angle +} KSAUDIO_MICROPHONE_COORDINATES, *PKSAUDIO_MICROPHONE_COORDINATES; + +typedef enum { + KSMICARRAY_MICARRAYTYPE_LINEAR, + KSMICARRAY_MICARRAYTYPE_PLANAR, + KSMICARRAY_MICARRAYTYPE_3D +} KSMICARRAY_MICARRAYTYPE; + +typedef struct { + USHORT usVersion; // Version of Mic array specification (0x0100) + USHORT usMicArrayType; // Type of Mic Array + SHORT wVerticalAngleBegin; // Work Volume Vertical Angle Begin + SHORT wVerticalAngleEnd; // Work Volume Vertical Angle End + SHORT wHorizontalAngleBegin; // Work Volume HorizontalAngle Begin + SHORT wHorizontalAngleEnd; // Work Volume HorizontalAngle End + USHORT usFrequencyBandLo; // Low end of Freq Range + USHORT usFrequencyBandHi; // High end of Freq Range + + USHORT usNumberOfMicrophones; // Count of microphone + // coordinate structures + // to follow. + + KSAUDIO_MICROPHONE_COORDINATES KsMicCoord[1]; // Array of Microphone + // Coordinate structures +} KSAUDIO_MIC_ARRAY_GEOMETRY, *PKSAUDIO_MIC_ARRAY_GEOMETRY; + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +//=========================================================================== +// DirectSound3D HAL + + +typedef struct _DS3DVECTOR { + union { + FLOAT x; + FLOAT dvX; + }; + union { + FLOAT y; + FLOAT dvY; + }; + union { + FLOAT z; + FLOAT dvZ; + }; +} DS3DVECTOR, *PDS3DVECTOR; + + +//=========================================================================== +//=========================================================================== + +// KSPROPSETID_DirectSound3DListener : {437B3414-D060-11d0-8583-00C04FD9BAF3} + +#define STATIC_KSPROPSETID_DirectSound3DListener\ + 0x437b3414L, 0xd060, 0x11d0, 0x85, 0x83, 0x00, 0xc0, 0x4f, 0xd9, 0xba, 0xf3 +DEFINE_GUIDSTRUCT("437b3414-d060-11d0-8583-00c04fd9baf3",KSPROPSETID_DirectSound3DListener); +#define KSPROPSETID_DirectSound3DListener DEFINE_GUIDNAMED(KSPROPSETID_DirectSound3DListener) + +typedef enum { + KSPROPERTY_DIRECTSOUND3DLISTENER_ALL, + KSPROPERTY_DIRECTSOUND3DLISTENER_POSITION, + KSPROPERTY_DIRECTSOUND3DLISTENER_VELOCITY, + KSPROPERTY_DIRECTSOUND3DLISTENER_ORIENTATION, + KSPROPERTY_DIRECTSOUND3DLISTENER_DISTANCEFACTOR, + KSPROPERTY_DIRECTSOUND3DLISTENER_ROLLOFFFACTOR, + KSPROPERTY_DIRECTSOUND3DLISTENER_DOPPLERFACTOR, + KSPROPERTY_DIRECTSOUND3DLISTENER_BATCH, + KSPROPERTY_DIRECTSOUND3DLISTENER_ALLOCATION +} KSPROPERTY_DIRECTSOUND3DLISTENER; + +typedef struct { + DS3DVECTOR Position; + DS3DVECTOR Velocity; + DS3DVECTOR OrientFront; + DS3DVECTOR OrientTop; + FLOAT DistanceFactor; + FLOAT RolloffFactor; + FLOAT DopplerFactor; +} KSDS3D_LISTENER_ALL, *PKSDS3D_LISTENER_ALL; + +typedef struct { + DS3DVECTOR Front; + DS3DVECTOR Top; +} KSDS3D_LISTENER_ORIENTATION, *PKSDS3D_LISTENER_ORIENTATION; + + +//=========================================================================== +//=========================================================================== +// KSPROPSETID_DirectSound3DBuffer : {437B3411-D060-11d0-8583-00C04FD9BAF3} + +#define STATIC_KSPROPSETID_DirectSound3DBuffer\ + 0x437b3411L, 0xd060, 0x11d0, 0x85, 0x83, 0x00, 0xc0, 0x4f, 0xd9, 0xba, 0xf3 +DEFINE_GUIDSTRUCT("437b3411-d060-11d0-8583-00c04fd9baf3", KSPROPSETID_DirectSound3DBuffer); +#define KSPROPSETID_DirectSound3DBuffer DEFINE_GUIDNAMED(KSPROPSETID_DirectSound3DBuffer) + + +typedef enum { + KSPROPERTY_DIRECTSOUND3DBUFFER_ALL, + KSPROPERTY_DIRECTSOUND3DBUFFER_POSITION, + KSPROPERTY_DIRECTSOUND3DBUFFER_VELOCITY, + KSPROPERTY_DIRECTSOUND3DBUFFER_CONEANGLES, + KSPROPERTY_DIRECTSOUND3DBUFFER_CONEORIENTATION, + KSPROPERTY_DIRECTSOUND3DBUFFER_CONEOUTSIDEVOLUME, + KSPROPERTY_DIRECTSOUND3DBUFFER_MINDISTANCE, + KSPROPERTY_DIRECTSOUND3DBUFFER_MAXDISTANCE, + KSPROPERTY_DIRECTSOUND3DBUFFER_MODE +} KSPROPERTY_DIRECTSOUND3DBUFFER; + + +typedef struct { + DS3DVECTOR Position; + DS3DVECTOR Velocity; + ULONG InsideConeAngle; + ULONG OutsideConeAngle; + DS3DVECTOR ConeOrientation; + LONG ConeOutsideVolume; + FLOAT MinDistance; + FLOAT MaxDistance; + ULONG Mode; +} KSDS3D_BUFFER_ALL, *PKSDS3D_BUFFER_ALL; + +typedef struct { + ULONG InsideConeAngle; + ULONG OutsideConeAngle; +} KSDS3D_BUFFER_CONE_ANGLES, *PKSDS3D_BUFFER_CONE_ANGLES; + +#define KSAUDIO_STEREO_SPEAKER_GEOMETRY_HEADPHONE (-1) +#define KSAUDIO_STEREO_SPEAKER_GEOMETRY_MIN 5 +#define KSAUDIO_STEREO_SPEAKER_GEOMETRY_NARROW 10 +#define KSAUDIO_STEREO_SPEAKER_GEOMETRY_WIDE 20 +#define KSAUDIO_STEREO_SPEAKER_GEOMETRY_MAX 180 + +#define KSDSOUND_3D_MODE_NORMAL 0x00000000 +#define KSDSOUND_3D_MODE_HEADRELATIVE 0x00000001 +#define KSDSOUND_3D_MODE_DISABLE 0x00000002 + +//=========================================================================== +// Definitions intended for hardware acceleration of the HRTF 3D algorithm +//=========================================================================== + +#define KSDSOUND_BUFFER_CTRL_HRTF_3D 0x40000000 + +typedef struct { + ULONG Size; // This is the size of the struct in bytes + ULONG Enabled; + BOOL SwapChannels; + BOOL ZeroAzimuth; + BOOL CrossFadeOutput; + ULONG FilterSize; // This is the additional size of the filter coeff in bytes +} KSDS3D_HRTF_PARAMS_MSG, *PKSDS3D_HRTF_PARAMS_MSG; + +// HRTF filter quality levels +typedef enum { + FULL_FILTER, + LIGHT_FILTER, + KSDS3D_FILTER_QUALITY_COUNT +} KSDS3D_HRTF_FILTER_QUALITY; + +typedef struct { + ULONG Size; // This is the size of the struct in bytes + KSDS3D_HRTF_FILTER_QUALITY Quality; + FLOAT SampleRate; + ULONG MaxFilterSize; + ULONG FilterTransientMuteLength; + ULONG FilterOverlapBufferLength; + ULONG OutputOverlapBufferLength; + ULONG Reserved; +} KSDS3D_HRTF_INIT_MSG, *PKSDS3D_HRTF_INIT_MSG; + +// Coefficient formats +typedef enum { + FLOAT_COEFF, + SHORT_COEFF, + KSDS3D_COEFF_COUNT +} KSDS3D_HRTF_COEFF_FORMAT; + +// Filter methods +typedef enum { + DIRECT_FORM, + CASCADE_FORM, + KSDS3D_FILTER_METHOD_COUNT +} KSDS3D_HRTF_FILTER_METHOD; + +// Filter methods +typedef enum { + DS3D_HRTF_VERSION_1 +} KSDS3D_HRTF_FILTER_VERSION; + +typedef struct { + KSDS3D_HRTF_FILTER_METHOD FilterMethod; + KSDS3D_HRTF_COEFF_FORMAT CoeffFormat; + KSDS3D_HRTF_FILTER_VERSION Version; + ULONG Reserved; +} KSDS3D_HRTF_FILTER_FORMAT_MSG, *PKSDS3D_HRTF_FILTER_FORMAT_MSG; + +#define STATIC_KSPROPSETID_Hrtf3d\ + 0xb66decb0L, 0xa083, 0x11d0, 0x85, 0x1e, 0x00, 0xc0, 0x4f, 0xd9, 0xba, 0xf3 +DEFINE_GUIDSTRUCT("b66decb0-a083-11d0-851e-00c04fd9baf3", KSPROPSETID_Hrtf3d); +#define KSPROPSETID_Hrtf3d DEFINE_GUIDNAMED(KSPROPSETID_Hrtf3d) + +typedef enum { + KSPROPERTY_HRTF3D_PARAMS = 0, + KSPROPERTY_HRTF3D_INITIALIZE, + KSPROPERTY_HRTF3D_FILTER_FORMAT +} KSPROPERTY_HRTF3D; + + +//=========================================================================== +// Definitions related to the obsolete Interaural Time Delay 3D algorithm +//=========================================================================== + +// DirectSound3D FIR context +typedef struct { + LONG Channel; + FLOAT VolSmoothScale; + FLOAT TotalDryAttenuation; + FLOAT TotalWetAttenuation; + LONG SmoothFrequency; + LONG Delay; +} KSDS3D_ITD_PARAMS, *PKSDS3D_ITD_PARAMS; + +typedef struct { + ULONG Enabled; + KSDS3D_ITD_PARAMS LeftParams; + KSDS3D_ITD_PARAMS RightParams; + ULONG Reserved; +} KSDS3D_ITD_PARAMS_MSG, *PKSDS3D_ITD_PARAMS_MSG; + +#define STATIC_KSPROPSETID_Itd3d\ + 0x6429f090L, 0x9fd9, 0x11d0, 0xa7, 0x5b, 0x00, 0xa0, 0xc9, 0x03, 0x65, 0xe3 +DEFINE_GUIDSTRUCT("6429f090-9fd9-11d0-a75b-00a0c90365e3", KSPROPSETID_Itd3d); +#define KSPROPSETID_Itd3d DEFINE_GUIDNAMED(KSPROPSETID_Itd3d) + +typedef enum { + KSPROPERTY_ITD3D_PARAMS = 0 +} KSPROPERTY_ITD3D; + + +typedef struct { + KSDATARANGE DataRange; + ULONG MaximumChannels; + ULONG MinimumBitsPerSample; + ULONG MaximumBitsPerSample; + ULONG MinimumSampleFrequency; + ULONG MaximumSampleFrequency; +} KSDATARANGE_AUDIO, *PKSDATARANGE_AUDIO; + +//--------------------------------------------------------------------------- + +#define STATIC_KSDATAFORMAT_SUBTYPE_RIFF\ + 0x4995DAEEL, 0x9EE6, 0x11D0, 0xA4, 0x0E, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("4995DAEE-9EE6-11D0-A40E-00A0C9223196", KSDATAFORMAT_SUBTYPE_RIFF); +#define KSDATAFORMAT_SUBTYPE_RIFF DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_RIFF) + +#define STATIC_KSDATAFORMAT_SUBTYPE_RIFFWAVE\ + 0xe436eb8bL, 0x524f, 0x11ce, 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70 +DEFINE_GUIDSTRUCT("e436eb8b-524f-11ce-9f53-0020af0ba770", KSDATAFORMAT_SUBTYPE_RIFFWAVE); +#define KSDATAFORMAT_SUBTYPE_RIFFWAVE DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_RIFFWAVE) + +//=========================================================================== +//=========================================================================== + +#define STATIC_KSPROPSETID_Bibliographic \ + 0x07BA150EL, 0xE2B1, 0x11D0, 0xAC, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("07BA150E-E2B1-11D0-AC17-00A0C9223196", KSPROPSETID_Bibliographic); +#define KSPROPSETID_Bibliographic DEFINE_GUIDNAMED(KSPROPSETID_Bibliographic) + +//Repeatable tags contain all entries within the property, each preceeded by length +typedef enum { + KSPROPERTY_BIBLIOGRAPHIC_LEADER = 'RDL ', + KSPROPERTY_BIBLIOGRAPHIC_LCCN = '010 ', + KSPROPERTY_BIBLIOGRAPHIC_ISBN = '020 ', + KSPROPERTY_BIBLIOGRAPHIC_ISSN = '220 ', + KSPROPERTY_BIBLIOGRAPHIC_CATALOGINGSOURCE = '040 ', + KSPROPERTY_BIBLIOGRAPHIC_MAINPERSONALNAME = '001 ', + KSPROPERTY_BIBLIOGRAPHIC_MAINCORPORATEBODY = '011 ', + KSPROPERTY_BIBLIOGRAPHIC_MAINMEETINGNAME = '111 ', + KSPROPERTY_BIBLIOGRAPHIC_MAINUNIFORMTITLE = '031 ', + KSPROPERTY_BIBLIOGRAPHIC_UNIFORMTITLE = '042 ', + KSPROPERTY_BIBLIOGRAPHIC_TITLESTATEMENT = '542 ', + KSPROPERTY_BIBLIOGRAPHIC_VARYINGFORMTITLE = '642 ', + KSPROPERTY_BIBLIOGRAPHIC_PUBLICATION = '062 ', + KSPROPERTY_BIBLIOGRAPHIC_PHYSICALDESCRIPTION = '003 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYTITLE = '044 ', + KSPROPERTY_BIBLIOGRAPHIC_SERIESSTATEMENT = '094 ', + KSPROPERTY_BIBLIOGRAPHIC_GENERALNOTE = '005 ', + KSPROPERTY_BIBLIOGRAPHIC_BIBLIOGRAPHYNOTE = '405 ', + KSPROPERTY_BIBLIOGRAPHIC_CONTENTSNOTE = '505 ', + KSPROPERTY_BIBLIOGRAPHIC_CREATIONCREDIT = '805 ', + KSPROPERTY_BIBLIOGRAPHIC_CITATION = '015 ', + KSPROPERTY_BIBLIOGRAPHIC_PARTICIPANT = '115 ', + KSPROPERTY_BIBLIOGRAPHIC_SUMMARY = '025 ', + KSPROPERTY_BIBLIOGRAPHIC_TARGETAUDIENCE = '125 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDFORMAVAILABLE = '035 ', + KSPROPERTY_BIBLIOGRAPHIC_SYSTEMDETAILS = '835 ', + KSPROPERTY_BIBLIOGRAPHIC_AWARDS = '685 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYPERSONALNAME = '006 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYTOPICALTERM = '056 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYGEOGRAPHIC = '156 ', + KSPROPERTY_BIBLIOGRAPHIC_INDEXTERMGENRE = '556 ', + KSPROPERTY_BIBLIOGRAPHIC_INDEXTERMCURRICULUM = '856 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYUNIFORMTITLE = '037 ', + KSPROPERTY_BIBLIOGRAPHIC_ADDEDENTRYRELATED = '047 ', + KSPROPERTY_BIBLIOGRAPHIC_SERIESSTATEMENTPERSONALNAME = '008 ', + KSPROPERTY_BIBLIOGRAPHIC_SERIESSTATEMENTUNIFORMTITLE = '038 ' +} KSPROPERTY_BIBLIOGRAPHIC; + +#define STATIC_KSPROPSETID_TopologyNode\ + 0x45FFAAA1L, 0x6E1B, 0x11D0, 0xBC, 0xF2, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00 +DEFINE_GUIDSTRUCT("45FFAAA1-6E1B-11D0-BCF2-444553540000", KSPROPSETID_TopologyNode); +#define KSPROPSETID_TopologyNode DEFINE_GUIDNAMED(KSPROPSETID_TopologyNode) + +typedef enum { + KSPROPERTY_TOPOLOGYNODE_ENABLE = 1 +#if (NTDDI_VERSION >= NTDDI_WINXP) + , KSPROPERTY_TOPOLOGYNODE_RESET +#endif // (NTDDI_VERSION >= NTDDI_WINXP) +} KSPROPERTY_TOPOLOGYNODE; + +//=========================================================================== + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#if defined(_NTDDK_) +typedef NTSTATUS (CALLBACK *PRTAUDIOGETPOSITION)(_In_ PFILE_OBJECT PinFileObject, + _Out_ PUCHAR *ppPlayPosition, + _Out_ PLONG plOffset); +#endif // defined(_NTDDK_) + +#define STATIC_KSPROPSETID_RtAudio\ + 0xa855a48c, 0x2f78, 0x4729, 0x90, 0x51, 0x19, 0x68, 0x74, 0x6b, 0x9e, 0xef +DEFINE_GUIDSTRUCT("A855A48C-2F78-4729-9051-1968746B9EEF", KSPROPSETID_RtAudio); +#define KSPROPSETID_RtAudio DEFINE_GUIDNAMED(KSPROPSETID_RtAudio) + +typedef enum { + KSPROPERTY_RTAUDIO_GETPOSITIONFUNCTION, +#if (NTDDI_VERSION >= NTDDI_VISTA) + KSPROPERTY_RTAUDIO_BUFFER, + KSPROPERTY_RTAUDIO_HWLATENCY, + KSPROPERTY_RTAUDIO_POSITIONREGISTER, + KSPROPERTY_RTAUDIO_CLOCKREGISTER, + KSPROPERTY_RTAUDIO_BUFFER_WITH_NOTIFICATION, + KSPROPERTY_RTAUDIO_REGISTER_NOTIFICATION_EVENT, + KSPROPERTY_RTAUDIO_UNREGISTER_NOTIFICATION_EVENT, +#endif +#if (NTDDI_VERSION >= NTDDI_WIN7) + KSPROPERTY_RTAUDIO_QUERY_NOTIFICATION_SUPPORT, +#endif +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + KSPROPERTY_RTAUDIO_PACKETCOUNT, + KSPROPERTY_RTAUDIO_PRESENTATION_POSITION, + KSPROPERTY_RTAUDIO_GETREADPACKET, + KSPROPERTY_RTAUDIO_SETWRITEPACKET, +#endif +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) + KSPROPERTY_RTAUDIO_PACKETVREGISTER, +#endif +} KSPROPERTY_RTAUDIO; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef struct { + KSPROPERTY Property; + PVOID BaseAddress; + ULONG RequestedBufferSize; +} KSRTAUDIO_BUFFER_PROPERTY, *PKSRTAUDIO_BUFFER_PROPERTY; + +typedef struct { + KSPROPERTY Property; + ULONG BaseAddress; + ULONG RequestedBufferSize; +} KSRTAUDIO_BUFFER_PROPERTY32, *PKSRTAUDIO_BUFFER_PROPERTY32; + +typedef struct { + KSPROPERTY Property; + PVOID BaseAddress; + ULONG RequestedBufferSize; + ULONG NotificationCount; +} KSRTAUDIO_BUFFER_PROPERTY_WITH_NOTIFICATION, *PKSRTAUDIO_BUFFER_PROPERTY_WITH_NOTIFICATION; + +typedef struct { + KSPROPERTY Property; + ULONG BaseAddress; + ULONG RequestedBufferSize; + ULONG NotificationCount; +} KSRTAUDIO_BUFFER_PROPERTY_WITH_NOTIFICATION32, *PKSRTAUDIO_BUFFER_PROPERTY_WITH_NOTIFICATION32; + +typedef struct { + PVOID BufferAddress; + ULONG ActualBufferSize; + BOOL CallMemoryBarrier; +} KSRTAUDIO_BUFFER, *PKSRTAUDIO_BUFFER; + +typedef struct { + ULONG BufferAddress; + ULONG ActualBufferSize; + BOOL CallMemoryBarrier; +} KSRTAUDIO_BUFFER32, *PKSRTAUDIO_BUFFER32; + +typedef struct { + ULONG FifoSize; + ULONG ChipsetDelay; + ULONG CodecDelay; +} KSRTAUDIO_HWLATENCY, *PKSRTAUDIO_HWLATENCY; + +typedef struct { + KSPROPERTY Property; + PVOID BaseAddress; +} KSRTAUDIO_HWREGISTER_PROPERTY, *PKSRTAUDIO_HWREGISTER_PROPERTY; + +typedef struct { + KSPROPERTY Property; + ULONG BaseAddress; +} KSRTAUDIO_HWREGISTER_PROPERTY32, *PKSRTAUDIO_HWREGISTER_PROPERTY32; + +typedef struct { + PVOID Register; + ULONG Width; + ULONGLONG Numerator; + ULONGLONG Denominator; + ULONG Accuracy; +} KSRTAUDIO_HWREGISTER, *PKSRTAUDIO_HWREGISTER; + +typedef struct { + ULONG Register; + ULONG Width; + ULONGLONG Numerator; + ULONGLONG Denominator; + ULONG Accuracy; +} KSRTAUDIO_HWREGISTER32, *PKSRTAUDIO_HWREGISTER32; + +typedef struct { + KSPROPERTY Property; + HANDLE NotificationEvent; +} KSRTAUDIO_NOTIFICATION_EVENT_PROPERTY, *PKSRTAUDIO_NOTIFICATION_EVENT_PROPERTY; + +typedef struct { + KSPROPERTY Property; + ULONG NotificationEvent; +} KSRTAUDIO_NOTIFICATION_EVENT_PROPERTY32, *PKSRTAUDIO_NOTIFICATION_EVENT_PROPERTY32; +#endif + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +typedef struct { + ULONG PacketNumber; + DWORD Flags; + ULONG64 PerformanceCounterValue; + BOOL MoreData; +} KSRTAUDIO_GETREADPACKET_INFO, *PKSRTAUDIO_GETREADPACKET_INFO; + +typedef struct { + ULONG PacketNumber; + DWORD Flags; + ULONG EosPacketLength; +} KSRTAUDIO_SETWRITEPACKET_INFO, *PKSRTAUDIO_SETWRITEPACKET_INFO; +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct { + KSPROPERTY Property; + PVOID BaseAddress; +} KSRTAUDIO_PACKETVREGISTER_PROPERTY, *PKSRTAUDIO_PACKETVREGISTER_PROPERTY; + +typedef struct { + PULONG64 CompletedPacketCount; + PULONG64 CompletedPacketQPC; + PULONG64 CompletedPacketHash; +} KSRTAUDIO_PACKETVREGISTER, *PKSRTAUDIO_PACKETVREGISTER; +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +//=========================================================================== + +//=========================================================================== + +#define STATIC_KSPROPSETID_BtAudio\ + 0x7FA06C40, 0xB8F6, 0x4C7E, 0x85, 0x56, 0xE8, 0xC3, 0x3A, 0x12, 0xE5, 0x4D +DEFINE_GUIDSTRUCT("7FA06C40-B8F6-4C7E-8556-E8C33A12E54D", KSPROPSETID_BtAudio); +#define KSPROPSETID_BtAudio DEFINE_GUIDNAMED(KSPROPSETID_BtAudio) + +typedef enum { + KSPROPERTY_ONESHOT_RECONNECT, + KSPROPERTY_ONESHOT_DISCONNECT, +} KSPROPERTY_BTAUDIO; + + +#endif + +//=========================================================================== +#define STATIC_KSPROPSETID_DrmAudioStream\ + 0x2f2c8ddd, 0x4198, 0x4fac, 0xba, 0x29, 0x61, 0xbb, 0x5, 0xb7, 0xde, 0x6 +DEFINE_GUIDSTRUCT("2F2C8DDD-4198-4fac-BA29-61BB05B7DE06", KSPROPSETID_DrmAudioStream); +#define KSPROPSETID_DrmAudioStream DEFINE_GUIDNAMED(KSPROPSETID_DrmAudioStream) + +typedef enum { + KSPROPERTY_DRMAUDIOSTREAM_CONTENTID +} KSPROPERTY_DRMAUDIOSTREAM; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +//=========================================================================== +#define STATIC_KSPROPSETID_SoundDetector\ + 0x113c425e, 0xfd17, 0x4057, 0xb4, 0x22, 0xed, 0x40, 0x74, 0xf1, 0xaf, 0xdf +DEFINE_GUIDSTRUCT("113C425E-FD17-4057-B422-ED4074F1AFDF", KSPROPSETID_SoundDetector); +#define KSPROPSETID_SoundDetector DEFINE_GUIDNAMED(KSPROPSETID_SoundDetector) + +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +#define STATIC_KSPROPSETID_SoundDetector2\ + 0xfe07e322, 0x450c, 0x4bd5, 0x84, 0xca, 0xa9, 0x48, 0x50, 0xe, 0xa6, 0xaa +DEFINE_GUIDSTRUCT("FE07E322-450C-4BD5-84CA-A948500EA6AA", KSPROPSETID_SoundDetector2); +#define KSPROPSETID_SoundDetector2 DEFINE_GUIDNAMED(KSPROPSETID_SoundDetector2) + +#define STATIC_KSPROPSETID_InterleavedAudio\ + 0xe9ebe550, 0xd619, 0x4c0a, 0x97, 0x6b, 0x70, 0x62, 0x32, 0x2b, 0x30, 0x6 +DEFINE_GUIDSTRUCT("E9EBE550-D619-4C0A-976B-7062322B3006", KSPROPSETID_InterleavedAudio); +#define KSPROPSETID_InterleavedAudio DEFINE_GUIDNAMED(KSPROPSETID_InterleavedAudio) + +typedef enum { + KSPROPERTY_INTERLEAVEDAUDIO_FORMATINFORMATION = 1, +} KSPROPERTY_INTERLEAVEDAUDIO; + +typedef struct { + ULONG Size; + DWORD PrimaryChannelCount; + DWORD PrimaryChannelStartPosition; + DWORD PrimaryChannelMask; + DWORD InterleavedChannelCount; + DWORD InterleavedChannelStartPosition; + DWORD InterleavedChannelMask; +} INTERLEAVED_AUDIO_FORMAT_INFORMATION; + +typedef struct { + KSPROPERTY Property; + GUID EventId; +} KSSOUNDDETECTORPROPERTY, *PKSSOUNDDETECTORPROPERTY; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) + + +typedef enum { + KSPROPERTY_SOUNDDETECTOR_SUPPORTEDPATTERNS = 1, + KSPROPERTY_SOUNDDETECTOR_PATTERNS, + KSPROPERTY_SOUNDDETECTOR_ARMED, + KSPROPERTY_SOUNDDETECTOR_MATCHRESULT, +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) + KSPROPERTY_SOUNDDETECTOR_RESET, + KSPROPERTY_SOUNDDETECTOR_STREAMINGSUPPORT, +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) +} KSPROPERTY_SOUNDDETECTOR; + +typedef struct { + ULONG Size; + GUID PatternType; +} SOUNDDETECTOR_PATTERNHEADER; + +#define STATIC_KSEVENTSETID_SoundDetector\ + 0x69785c9b, 0xfc2d, 0x49d6, 0xac, 0x32, 0x47, 0x99, 0xf8, 0x7d, 0xe9, 0xf6 +DEFINE_GUIDSTRUCT("69785C9B-FC2D-49D6-AC32-4799F87DE9F6", KSEVENTSETID_SoundDetector); +#define KSEVENTSETID_SoundDetector DEFINE_GUIDNAMED(KSEVENTSETID_SoundDetector) + +typedef enum { + KSEVENT_SOUNDDETECTOR_MATCHDETECTED = 1, +} KSEVENT_SOUNDDETECTOR; +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) +// The payload of this notification is a SOUNDDETECTOR_PATTERNHEADER +#define STATIC_KSNOTIFICATIONID_SoundDetector\ + 0x6389d844, 0xbb32, 0x4c4c, 0xa8, 0x2, 0xf4, 0xb4, 0xb7, 0x7a, 0xfe, 0xad +DEFINE_GUIDSTRUCT("6389D844-BB32-4C4C-A802-F4B4B77AFEAD", KSNOTIFICATIONID_SoundDetector); +#define KSNOTIFICATIONID_SoundDetector DEFINE_GUIDNAMED(KSNOTIFICATIONID_SoundDetector) +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) + +//=========================================================================== +#define STATIC_KSPROPSETID_Audio\ + 0x45FFAAA0L, 0x6E1B, 0x11D0, 0xBC, 0xF2, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00 +DEFINE_GUIDSTRUCT("45FFAAA0-6E1B-11D0-BCF2-444553540000", KSPROPSETID_Audio); +#define KSPROPSETID_Audio DEFINE_GUIDNAMED(KSPROPSETID_Audio) + +typedef enum { + KSPROPERTY_AUDIO_LATENCY = 1, + KSPROPERTY_AUDIO_COPY_PROTECTION, + KSPROPERTY_AUDIO_CHANNEL_CONFIG, + KSPROPERTY_AUDIO_VOLUMELEVEL, + KSPROPERTY_AUDIO_POSITION, + KSPROPERTY_AUDIO_DYNAMIC_RANGE, + KSPROPERTY_AUDIO_QUALITY, + KSPROPERTY_AUDIO_SAMPLING_RATE, + KSPROPERTY_AUDIO_DYNAMIC_SAMPLING_RATE, + KSPROPERTY_AUDIO_MIX_LEVEL_TABLE, + KSPROPERTY_AUDIO_MIX_LEVEL_CAPS, + KSPROPERTY_AUDIO_MUX_SOURCE, + KSPROPERTY_AUDIO_MUTE, + KSPROPERTY_AUDIO_BASS, + KSPROPERTY_AUDIO_MID, + KSPROPERTY_AUDIO_TREBLE, + KSPROPERTY_AUDIO_BASS_BOOST, + KSPROPERTY_AUDIO_EQ_LEVEL, + KSPROPERTY_AUDIO_NUM_EQ_BANDS, + KSPROPERTY_AUDIO_EQ_BANDS, + KSPROPERTY_AUDIO_AGC, + KSPROPERTY_AUDIO_DELAY, + KSPROPERTY_AUDIO_LOUDNESS, + KSPROPERTY_AUDIO_WIDE_MODE, //Reserved for system use + KSPROPERTY_AUDIO_WIDENESS, + KSPROPERTY_AUDIO_REVERB_LEVEL, + KSPROPERTY_AUDIO_CHORUS_LEVEL, + KSPROPERTY_AUDIO_DEV_SPECIFIC, + KSPROPERTY_AUDIO_DEMUX_DEST, + KSPROPERTY_AUDIO_STEREO_ENHANCE, //Reserved for system use + KSPROPERTY_AUDIO_MANUFACTURE_GUID, //Reserved for system use + KSPROPERTY_AUDIO_PRODUCT_GUID, //Reserved for system use + KSPROPERTY_AUDIO_CPU_RESOURCES, + KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY, + KSPROPERTY_AUDIO_SURROUND_ENCODE, + KSPROPERTY_AUDIO_3D_INTERFACE + +#if (NTDDI_VERSION >= NTDDI_WINXP) + , KSPROPERTY_AUDIO_PEAKMETER + , KSPROPERTY_AUDIO_ALGORITHM_INSTANCE + , KSPROPERTY_AUDIO_FILTER_STATE + , KSPROPERTY_AUDIO_PREFERRED_STATUS + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION >= NTDDI_VISTA) + , KSPROPERTY_AUDIO_PEQ_MAX_BANDS + , KSPROPERTY_AUDIO_PEQ_NUM_BANDS + , KSPROPERTY_AUDIO_PEQ_BAND_CENTER_FREQ + , KSPROPERTY_AUDIO_PEQ_BAND_Q_FACTOR + , KSPROPERTY_AUDIO_PEQ_BAND_LEVEL + , KSPROPERTY_AUDIO_CHORUS_MODULATION_RATE + , KSPROPERTY_AUDIO_CHORUS_MODULATION_DEPTH + , KSPROPERTY_AUDIO_REVERB_TIME + , KSPROPERTY_AUDIO_REVERB_DELAY_FEEDBACK + , KSPROPERTY_AUDIO_POSITIONEX + , KSPROPERTY_AUDIO_MIC_ARRAY_GEOMETRY +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + , KSPROPERTY_AUDIO_PRESENTATION_POSITION + , KSPROPERTY_AUDIO_WAVERT_CURRENT_WRITE_POSITION + , KSPROPERTY_AUDIO_LINEAR_BUFFER_POSITION + , KSPROPERTY_AUDIO_PEAKMETER2 +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + , KSPROPERTY_AUDIO_WAVERT_CURRENT_WRITE_LASTBUFFER_POSITION + , KSPROPERTY_AUDIO_VOLUMELIMIT_ENGAGED +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) + , KSPROPERTY_AUDIO_MIC_SENSITIVITY // deprecated in favor of KSPROPERTY_AUDIO_MIC_SENSITIVITY2 + , KSPROPERTY_AUDIO_MIC_SNR +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS1) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) + , KSPROPERTY_AUDIO_MIC_SENSITIVITY2 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4) + +} KSPROPERTY_AUDIO; + +// Audio quality constants +#define KSAUDIO_QUALITY_WORST 0x0 +#define KSAUDIO_QUALITY_PC 0x1 +#define KSAUDIO_QUALITY_BASIC 0x2 +#define KSAUDIO_QUALITY_ADVANCED 0x3 + +// Audio CPU resource constants +#define KSAUDIO_CPU_RESOURCES_NOT_HOST_CPU 0x00000000 +#define KSAUDIO_CPU_RESOURCES_HOST_CPU 0x7FFFFFFF + +typedef struct { + BOOL fCopyrighted; + BOOL fOriginal; +} KSAUDIO_COPY_PROTECTION, *PKSAUDIO_COPY_PROTECTION; + +typedef struct { + LONG ActiveSpeakerPositions; +} KSAUDIO_CHANNEL_CONFIG, *PKSAUDIO_CHANNEL_CONFIG; + +// Speaker Positions: +#define SPEAKER_FRONT_LEFT 0x1 +#define SPEAKER_FRONT_RIGHT 0x2 +#define SPEAKER_FRONT_CENTER 0x4 +#define SPEAKER_LOW_FREQUENCY 0x8 +#define SPEAKER_BACK_LEFT 0x10 +#define SPEAKER_BACK_RIGHT 0x20 +#define SPEAKER_FRONT_LEFT_OF_CENTER 0x40 +#define SPEAKER_FRONT_RIGHT_OF_CENTER 0x80 +#define SPEAKER_BACK_CENTER 0x100 +#define SPEAKER_SIDE_LEFT 0x200 +#define SPEAKER_SIDE_RIGHT 0x400 +#define SPEAKER_TOP_CENTER 0x800 +#define SPEAKER_TOP_FRONT_LEFT 0x1000 +#define SPEAKER_TOP_FRONT_CENTER 0x2000 +#define SPEAKER_TOP_FRONT_RIGHT 0x4000 +#define SPEAKER_TOP_BACK_LEFT 0x8000 +#define SPEAKER_TOP_BACK_CENTER 0x10000 +#define SPEAKER_TOP_BACK_RIGHT 0x20000 + +// Bit mask locations reserved for future use +#define SPEAKER_RESERVED 0x7FFC0000 + +// Used to specify that any possible permutation of speaker configurations +#define SPEAKER_ALL 0x80000000 + +// DirectSound Speaker Config +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define KSAUDIO_SPEAKER_DIRECTOUT 0 +#endif +#define KSAUDIO_SPEAKER_MONO (SPEAKER_FRONT_CENTER) +#define KSAUDIO_SPEAKER_1POINT1 (SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY) +#define KSAUDIO_SPEAKER_STEREO (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT) +#define KSAUDIO_SPEAKER_2POINT1 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | SPEAKER_LOW_FREQUENCY) +#define KSAUDIO_SPEAKER_3POINT0 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | SPEAKER_FRONT_CENTER) +#define KSAUDIO_SPEAKER_3POINT1 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY) +#define KSAUDIO_SPEAKER_QUAD (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_BACK_LEFT | SPEAKER_BACK_RIGHT) +#define KSAUDIO_SPEAKER_SURROUND (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_BACK_CENTER) +#define KSAUDIO_SPEAKER_5POINT0 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | SPEAKER_FRONT_CENTER | \ + SPEAKER_SIDE_LEFT | SPEAKER_SIDE_RIGHT) +#define KSAUDIO_SPEAKER_5POINT1 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY | \ + SPEAKER_BACK_LEFT | SPEAKER_BACK_RIGHT) +#define KSAUDIO_SPEAKER_7POINT0 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | SPEAKER_FRONT_CENTER | \ + SPEAKER_BACK_LEFT | SPEAKER_BACK_RIGHT | \ + SPEAKER_SIDE_LEFT | SPEAKER_SIDE_RIGHT) +#define KSAUDIO_SPEAKER_7POINT1 (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY | \ + SPEAKER_BACK_LEFT | SPEAKER_BACK_RIGHT | \ + SPEAKER_FRONT_LEFT_OF_CENTER | SPEAKER_FRONT_RIGHT_OF_CENTER) + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define KSAUDIO_SPEAKER_5POINT1_SURROUND (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY | \ + SPEAKER_SIDE_LEFT | SPEAKER_SIDE_RIGHT) +#define KSAUDIO_SPEAKER_7POINT1_SURROUND (SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT | \ + SPEAKER_FRONT_CENTER | SPEAKER_LOW_FREQUENCY | \ + SPEAKER_BACK_LEFT | SPEAKER_BACK_RIGHT | \ + SPEAKER_SIDE_LEFT | SPEAKER_SIDE_RIGHT) +// The following are obsolete 5.1 and 7.1 settings (they lack side speakers). Note this means +// that the default 5.1 and 7.1 settings (KSAUDIO_SPEAKER_5POINT1 and KSAUDIO_SPEAKER_7POINT1 are +// similarly obsolete but are unchanged for compatibility reasons). +#define KSAUDIO_SPEAKER_5POINT1_BACK KSAUDIO_SPEAKER_5POINT1 +#define KSAUDIO_SPEAKER_7POINT1_WIDE KSAUDIO_SPEAKER_7POINT1 + +#endif // XP SP2 and later (chronologically) + +// DVD Speaker Positions +#define KSAUDIO_SPEAKER_GROUND_FRONT_LEFT SPEAKER_FRONT_LEFT +#define KSAUDIO_SPEAKER_GROUND_FRONT_CENTER SPEAKER_FRONT_CENTER +#define KSAUDIO_SPEAKER_GROUND_FRONT_RIGHT SPEAKER_FRONT_RIGHT +#define KSAUDIO_SPEAKER_GROUND_REAR_LEFT SPEAKER_BACK_LEFT +#define KSAUDIO_SPEAKER_GROUND_REAR_RIGHT SPEAKER_BACK_RIGHT +#define KSAUDIO_SPEAKER_TOP_MIDDLE SPEAKER_TOP_CENTER +#define KSAUDIO_SPEAKER_SUPER_WOOFER SPEAKER_LOW_FREQUENCY + +typedef struct { + ULONG QuietCompression; + ULONG LoudCompression; +} KSAUDIO_DYNAMIC_RANGE, *PKSAUDIO_DYNAMIC_RANGE; + +typedef struct { + BOOL Mute; + LONG Level; +} KSAUDIO_MIXLEVEL, *PKSAUDIO_MIXLEVEL; + +typedef struct { + BOOL Mute; + LONG Minimum; + LONG Maximum; + union { + LONG Reset; + LONG Resolution; + }; +} KSAUDIO_MIX_CAPS, *PKSAUDIO_MIX_CAPS; + +typedef struct { + ULONG InputChannels; + ULONG OutputChannels; + KSAUDIO_MIX_CAPS Capabilities[1]; +} KSAUDIO_MIXCAP_TABLE, *PKSAUDIO_MIXCAP_TABLE; + +#if (NTDDI_VERSION < NTDDI_VISTA) + +typedef enum { // preferred device index + KSPROPERTY_SYSAUDIO_NORMAL_DEFAULT = 0, + KSPROPERTY_SYSAUDIO_PLAYBACK_DEFAULT, + KSPROPERTY_SYSAUDIO_RECORD_DEFAULT, + KSPROPERTY_SYSAUDIO_MIDI_DEFAULT, + KSPROPERTY_SYSAUDIO_MIXER_DEFAULT +} KSPROPERTY_SYSAUDIO_DEFAULT_TYPE; + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +typedef struct { + BOOL Enable; + KSPROPERTY_SYSAUDIO_DEFAULT_TYPE DeviceType; + ULONG Flags; + ULONG Reserved; +} KSAUDIO_PREFERRED_STATUS, *PKSAUDIO_PREFERRED_STATUS; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef struct { + LARGE_INTEGER TimerFrequency; + LARGE_INTEGER TimeStamp1; + KSAUDIO_POSITION Position; + LARGE_INTEGER TimeStamp2; +} KSAUDIO_POSITIONEX, *PKSAUDIO_POSITIONEX; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define STATIC_KSPROPSETID_TelephonyControl\ + 0xb6df7eb1, 0xd099, 0x489f, 0xa6, 0xa0, 0xc0, 0x10, 0x6f, 0x8, 0x87, 0xa7 +DEFINE_GUIDSTRUCT("B6DF7EB1-D099-489F-A6A0-C0106F0887A7", KSPROPSETID_TelephonyControl); +#define KSPROPSETID_TelephonyControl DEFINE_GUIDNAMED(KSPROPSETID_TelephonyControl) + +typedef enum { + KSPROPERTY_TELEPHONY_PROVIDERID = 0, + KSPROPERTY_TELEPHONY_CALLINFO, + KSPROPERTY_TELEPHONY_CALLCONTROL, + KSPROPERTY_TELEPHONY_PROVIDERCHANGE, + KSPROPERTY_TELEPHONY_CALLHOLD, + KSPROPERTY_TELEPHONY_MUTE_TX +} KSPROPERTY_TELEPHONY_CONTROL; + +typedef enum { + TELEPHONY_CALLTYPE_CIRCUITSWITCHED = 0, + TELEPHONY_CALLTYPE_PACKETSWITCHED_LTE, + TELEPHONY_CALLTYPE_PACKETSWITCHED_WLAN +} TELEPHONY_CALLTYPE; + +typedef enum { + TELEPHONY_CALLCONTROLOP_DISABLE = 0, + TELEPHONY_CALLCONTROLOP_ENABLE +} TELEPHONY_CALLCONTROLOP; + +typedef struct _tagKSTELEPHONY_CALLCONTROL +{ + TELEPHONY_CALLTYPE CallType; + TELEPHONY_CALLCONTROLOP CallControlOp; +} KSTELEPHONY_CALLCONTROL, *PKSTELEPHONY_CALLCONTROL; + +typedef enum { + TELEPHONY_PROVIDERCHANGEOP_END = 0, + TELEPHONY_PROVIDERCHANGEOP_BEGIN, + TELEPHONY_PROVIDERCHANGEOP_CANCEL +} TELEPHONY_PROVIDERCHANGEOP; + +typedef struct _tagKSTELEPHONY_PROVIDERCHANGE +{ + TELEPHONY_CALLTYPE CallType; + TELEPHONY_PROVIDERCHANGEOP ProviderChangeOp; +} KSTELEPHONY_PROVIDERCHANGE, *PKSTELEPHONY_PROVIDERCHANGE; + +typedef enum { + TELEPHONY_CALLSTATE_DISABLED = 0, + TELEPHONY_CALLSTATE_ENABLED, + TELEPHONY_CALLSTATE_HOLD, + TELEPHONY_CALLSTATE_PROVIDERTRANSITION +} TELEPHONY_CALLSTATE; + +typedef struct _tagKSTELEPHONY_CALLINFO +{ + TELEPHONY_CALLTYPE CallType; + TELEPHONY_CALLSTATE CallState; +} KSTELEPHONY_CALLINFO, *PKSTELEPHONY_CALLINFO; + +#define STATIC_KSPROPSETID_TelephonyTopology\ + 0xabf25c7e, 0x0e64, 0x4e32, 0xb1, 0x90, 0xd0, 0xf6, 0xd7, 0xc5, 0x3e, 0x97 +DEFINE_GUIDSTRUCT("ABF25C7E-0E64-4E32-B190-D0F6D7C53E97", KSPROPSETID_TelephonyTopology); +#define KSPROPSETID_TelephonyTopology DEFINE_GUIDNAMED(KSPROPSETID_TelephonyTopology) + +typedef enum +{ + KSPROPERTY_TELEPHONY_ENDPOINTIDPAIR = 0, + KSPROPERTY_TELEPHONY_VOLUME +} KSPROPERTY_TELEPHONY_TOPOLOGY; + +typedef struct _tagKSTOPOLOGY_ENDPOINTID +{ + WCHAR TopologyName[MAX_PATH]; // Reference string for topology filter of an endpoint + ULONG PinId; // Topology filter pin id to which endpoint is connected +} KSTOPOLOGY_ENDPOINTID, *PKSTOPOLOGY_ENDPOINTID; + +typedef struct _tagKSTOPOLOGY_ENDPOINTIDPAIR +{ + KSTOPOLOGY_ENDPOINTID RenderEndpoint; + KSTOPOLOGY_ENDPOINTID CaptureEndpoint; +} KSTOPOLOGY_ENDPOINTIDPAIR, *PKSTOPOLOGY_ENDPOINTIDPAIR; + +#define STATIC_KSPROPSETID_FMRXTopology\ + 0xc46ce8f, 0xdc2d, 0x4204, 0x9d, 0xc9, 0xf5, 0x89, 0x63, 0x36, 0x65, 0x63 +DEFINE_GUIDSTRUCT("0C46CE8F-DC2D-4204-9DC9-F58963366563", KSPROPSETID_FMRXTopology); +#define KSPROPSETID_FMRXTopology DEFINE_GUIDNAMED(KSPROPSETID_FMRXTopology) + +typedef enum +{ + KSPROPERTY_FMRX_ENDPOINTID = 0, + KSPROPERTY_FMRX_VOLUME, + KSPROPERTY_FMRX_ANTENNAENDPOINTID +} KSPROPERTY_FMRX_TOPOLOGY; + +#define STATIC_KSPROPSETID_FMRXControl\ + 0x947BBA3A, 0xE8EE, 0x4786, 0x90, 0xC4, 0x84, 0x28, 0x18, 0x5F, 0x05, 0xBE +DEFINE_GUIDSTRUCT("947BBA3A-E8EE-4786-90C4-8428185F05BE", KSPROPSETID_FMRXControl); +#define KSPROPSETID_FMRXControl DEFINE_GUIDNAMED(KSPROPSETID_FMRXControl) + +typedef enum +{ + KSPROPERTY_FMRX_STATE = 0 +} KSPROPERTY_FMRX_CONTROL; + + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) + +#define STATIC_KSEVENTSETID_Telephony \ + 0xb77f12b4, 0xceb4, 0x4484, 0x8d, 0x5e, 0x52, 0xc1, 0xe7, 0xd8, 0x76, 0x2d +DEFINE_GUIDSTRUCT("B77F12B4-CEB4-4484-8D5E-52C1E7D8762D", KSEVENTSETID_Telephony); +#define KSEVENTSETID_Telephony DEFINE_GUIDNAMED(KSEVENTSETID_Telephony) + +typedef enum { + KSEVENT_TELEPHONY_ENDPOINTPAIRS_CHANGED +} KSEVENT_TELEPHONY; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4) + +//=========================================================================== +// Topology Node Type GUIDs + +#define STATIC_KSNODETYPE_DAC\ + 0x507AE360L, 0xC554, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("507AE360-C554-11D0-8A2B-00A0C9255AC1", KSNODETYPE_DAC); +#define KSNODETYPE_DAC DEFINE_GUIDNAMED(KSNODETYPE_DAC) + +#define STATIC_KSNODETYPE_ADC\ + 0x4D837FE0L, 0xC555, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("4D837FE0-C555-11D0-8A2B-00A0C9255AC1", KSNODETYPE_ADC); +#define KSNODETYPE_ADC DEFINE_GUIDNAMED(KSNODETYPE_ADC) + +#define STATIC_KSNODETYPE_SRC\ + 0x9DB7B9E0L, 0xC555, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("9DB7B9E0-C555-11D0-8A2B-00A0C9255AC1", KSNODETYPE_SRC); +#define KSNODETYPE_SRC DEFINE_GUIDNAMED(KSNODETYPE_SRC) + +#define STATIC_KSNODETYPE_SUPERMIX\ + 0xE573ADC0L, 0xC555, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("E573ADC0-C555-11D0-8A2B-00A0C9255AC1", KSNODETYPE_SUPERMIX); +#define KSNODETYPE_SUPERMIX DEFINE_GUIDNAMED(KSNODETYPE_SUPERMIX) + +#define STATIC_KSNODETYPE_MUX\ + 0x2CEAF780L, 0xC556, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("2CEAF780-C556-11D0-8A2B-00A0C9255AC1", KSNODETYPE_MUX); +#define KSNODETYPE_MUX DEFINE_GUIDNAMED(KSNODETYPE_MUX) + +#define STATIC_KSNODETYPE_DEMUX\ + 0xC0EB67D4L, 0xE807, 0x11D0, 0x95, 0x8A, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("C0EB67D4-E807-11D0-958A-00C04FB925D3", KSNODETYPE_DEMUX); +#define KSNODETYPE_DEMUX DEFINE_GUIDNAMED(KSNODETYPE_DEMUX) + +#define STATIC_KSNODETYPE_SUM\ + 0xDA441A60L, 0xC556, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("DA441A60-C556-11D0-8A2B-00A0C9255AC1", KSNODETYPE_SUM); +#define KSNODETYPE_SUM DEFINE_GUIDNAMED(KSNODETYPE_SUM) + +#define STATIC_KSNODETYPE_MUTE\ + 0x02B223C0L, 0xC557, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("02B223C0-C557-11D0-8A2B-00A0C9255AC1", KSNODETYPE_MUTE); +#define KSNODETYPE_MUTE DEFINE_GUIDNAMED(KSNODETYPE_MUTE) + +#define STATIC_KSNODETYPE_VOLUME\ + 0x3A5ACC00L, 0xC557, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("3A5ACC00-C557-11D0-8A2B-00A0C9255AC1", KSNODETYPE_VOLUME); +#define KSNODETYPE_VOLUME DEFINE_GUIDNAMED(KSNODETYPE_VOLUME) + +#define STATIC_KSNODETYPE_TONE\ + 0x7607E580L, 0xC557, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("7607E580-C557-11D0-8A2B-00A0C9255AC1", KSNODETYPE_TONE); +#define KSNODETYPE_TONE DEFINE_GUIDNAMED(KSNODETYPE_TONE) + +#define STATIC_KSNODETYPE_EQUALIZER\ + 0x9D41B4A0L, 0xC557, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("9D41B4A0-C557-11D0-8A2B-00A0C9255AC1", KSNODETYPE_EQUALIZER); +#define KSNODETYPE_EQUALIZER DEFINE_GUIDNAMED(KSNODETYPE_EQUALIZER) + +#define STATIC_KSNODETYPE_AGC\ + 0xE88C9BA0L, 0xC557, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("E88C9BA0-C557-11D0-8A2B-00A0C9255AC1", KSNODETYPE_AGC); +#define KSNODETYPE_AGC DEFINE_GUIDNAMED(KSNODETYPE_AGC) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_NOISE_SUPPRESS\ + 0xe07f903f, 0x62fd, 0x4e60, 0x8c, 0xdd, 0xde, 0xa7, 0x23, 0x66, 0x65, 0xb5 +DEFINE_GUIDSTRUCT("E07F903F-62FD-4e60-8CDD-DEA7236665B5", KSNODETYPE_NOISE_SUPPRESS); +#define KSNODETYPE_NOISE_SUPPRESS DEFINE_GUIDNAMED(KSNODETYPE_NOISE_SUPPRESS) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_DELAY\ + 0x144981E0L, 0xC558, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("144981E0-C558-11D0-8A2B-00A0C9255AC1", KSNODETYPE_DELAY); +#define KSNODETYPE_DELAY DEFINE_GUIDNAMED(KSNODETYPE_DELAY) + +#define STATIC_KSNODETYPE_LOUDNESS\ + 0x41887440L, 0xC558, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("41887440-C558-11D0-8A2B-00A0C9255AC1", KSNODETYPE_LOUDNESS); +#define KSNODETYPE_LOUDNESS DEFINE_GUIDNAMED(KSNODETYPE_LOUDNESS) + +#define STATIC_KSNODETYPE_PROLOGIC_DECODER\ + 0x831C2C80L, 0xC558, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("831C2C80-C558-11D0-8A2B-00A0C9255AC1", KSNODETYPE_PROLOGIC_DECODER); +#define KSNODETYPE_PROLOGIC_DECODER DEFINE_GUIDNAMED(KSNODETYPE_PROLOGIC_DECODER) + +#define STATIC_KSNODETYPE_STEREO_WIDE\ + 0xA9E69800L, 0xC558, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("A9E69800-C558-11D0-8A2B-00A0C9255AC1", KSNODETYPE_STEREO_WIDE); +#define KSNODETYPE_STEREO_WIDE DEFINE_GUIDNAMED(KSNODETYPE_STEREO_WIDE) + +#define STATIC_KSNODETYPE_REVERB\ + 0xEF0328E0L, 0xC558, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("EF0328E0-C558-11D0-8A2B-00A0C9255AC1", KSNODETYPE_REVERB); +#define KSNODETYPE_REVERB DEFINE_GUIDNAMED(KSNODETYPE_REVERB) + +#define STATIC_KSNODETYPE_CHORUS\ + 0x20173F20L, 0xC559, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("20173F20-C559-11D0-8A2B-00A0C9255AC1", KSNODETYPE_CHORUS); +#define KSNODETYPE_CHORUS DEFINE_GUIDNAMED(KSNODETYPE_CHORUS) + +#define STATIC_KSNODETYPE_3D_EFFECTS\ + 0x55515860L, 0xC559, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("55515860-C559-11D0-8A2B-00A0C9255AC1", KSNODETYPE_3D_EFFECTS); +#define KSNODETYPE_3D_EFFECTS DEFINE_GUIDNAMED(KSNODETYPE_3D_EFFECTS) + +#define STATIC_KSNODETYPE_PARAMETRIC_EQUALIZER\ + 0x19bb3a6a, 0xce2b, 0x4442, 0x87, 0xec, 0x67, 0x27, 0xc3, 0xca, 0xb4, 0x77 +DEFINE_GUIDSTRUCT("19BB3A6A-CE2B-4442-87EC-6727C3CAB477", KSNODETYPE_PARAMETRIC_EQUALIZER); +#define KSNODETYPE_PARAMETRIC_EQUALIZER DEFINE_GUIDNAMED(KSNODETYPE_PARAMETRIC_EQUALIZER) + +#define STATIC_KSNODETYPE_UPDOWN_MIX\ + 0xb7edc5cf, 0x7b63, 0x4ee2, 0xa1, 0x0, 0x29, 0xee, 0x2c, 0xb6, 0xb2, 0xde +DEFINE_GUIDSTRUCT("B7EDC5CF-7B63-4ee2-A100-29EE2CB6B2DE", KSNODETYPE_UPDOWN_MIX); +#define KSNODETYPE_UPDOWN_MIX DEFINE_GUIDNAMED(KSNODETYPE_UPDOWN_MIX) + +#define STATIC_KSNODETYPE_DYN_RANGE_COMPRESSOR\ + 0x8c8a6a8, 0x601f, 0x4af8, 0x87, 0x93, 0xd9, 0x5, 0xff, 0x4c, 0xa9, 0x7d +DEFINE_GUIDSTRUCT("08C8A6A8-601F-4af8-8793-D905FF4CA97D", KSNODETYPE_DYN_RANGE_COMPRESSOR); +#define KSNODETYPE_DYN_RANGE_COMPRESSOR DEFINE_GUIDNAMED(KSNODETYPE_DYN_RANGE_COMPRESSOR) + +#define STATIC_KSNODETYPE_ACOUSTIC_ECHO_CANCEL STATIC_KSCATEGORY_ACOUSTIC_ECHO_CANCEL +#define KSNODETYPE_ACOUSTIC_ECHO_CANCEL KSCATEGORY_ACOUSTIC_ECHO_CANCEL + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL\ + 0x1c22c56dL, 0x9879, 0x4f5b, 0xa3, 0x89, 0x27, 0x99, 0x6d, 0xdc, 0x28, 0x10 +DEFINE_GUIDSTRUCT("1C22C56D-9879-4f5b-A389-27996DDC2810", KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL); +#define KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL DEFINE_GUIDNAMED(KSALGORITHMINSTANCE_SYSTEM_ACOUSTIC_ECHO_CANCEL) + +#define STATIC_KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS\ + 0x5ab0882eL, 0x7274, 0x4516, 0x87, 0x7d, 0x4e, 0xee, 0x99, 0xba, 0x4f, 0xd0 +DEFINE_GUIDSTRUCT("5AB0882E-7274-4516-877D-4EEE99BA4FD0", KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS); +#define KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS DEFINE_GUIDNAMED(KSALGORITHMINSTANCE_SYSTEM_NOISE_SUPPRESS) + +#define STATIC_KSALGORITHMINSTANCE_SYSTEM_AGC\ + 0x950e55b9L, 0x877c, 0x4c67, 0xbe, 0x8, 0xe4, 0x7b, 0x56, 0x11, 0x13, 0xa +DEFINE_GUIDSTRUCT("950E55B9-877C-4c67-BE08-E47B5611130A", KSALGORITHMINSTANCE_SYSTEM_AGC); +#define KSALGORITHMINSTANCE_SYSTEM_AGC DEFINE_GUIDNAMED(KSALGORITHMINSTANCE_SYSTEM_AGC) + +#define STATIC_KSALGORITHMINSTANCE_SYSTEM_MICROPHONE_ARRAY_PROCESSOR\ + 0xB6F5A0A0L, 0x9E61, 0x4F8C, 0x91, 0xE3, 0x76, 0xCF, 0xF, 0x3C, 0x47, 0x1F +DEFINE_GUIDSTRUCT("B6F5A0A0-9E61-4f8c-91E3-76CF0F3C471F", KSALGORITHMINSTANCE_SYSTEM_MICROPHONE_ARRAY_PROCESSOR); +#define KSALGORITHMINSTANCE_SYSTEM_MICROPHONE_ARRAY_PROCESSOR DEFINE_GUIDNAMED(KSALGORITHMINSTANCE_SYSTEM_MICROPHONE_ARRAY_PROCESSOR) + +#define STATIC_KSNODETYPE_MICROPHONE_ARRAY_PROCESSOR STATIC_KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR +#define KSNODETYPE_MICROPHONE_ARRAY_PROCESSOR KSCATEGORY_MICROPHONE_ARRAY_PROCESSOR + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_DEV_SPECIFIC\ + 0x941C7AC0L, 0xC559, 0x11D0, 0x8A, 0x2B, 0x00, 0xA0, 0xC9, 0x25, 0x5A, 0xC1 +DEFINE_GUIDSTRUCT("941C7AC0-C559-11D0-8A2B-00A0C9255AC1", KSNODETYPE_DEV_SPECIFIC); +#define KSNODETYPE_DEV_SPECIFIC DEFINE_GUIDNAMED(KSNODETYPE_DEV_SPECIFIC) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSNODETYPE_PROLOGIC_ENCODER\ + 0x8074C5B2L, 0x3C66, 0x11D2, 0xB4, 0x5A, 0x30, 0x78, 0x30, 0x2C, 0x20, 0x30 +DEFINE_GUIDSTRUCT("8074C5B2-3C66-11D2-B45A-3078302C2030", KSNODETYPE_PROLOGIC_ENCODER); +#define KSNODETYPE_PROLOGIC_ENCODER DEFINE_GUIDNAMED(KSNODETYPE_PROLOGIC_ENCODER) +#define KSNODETYPE_SURROUND_ENCODER KSNODETYPE_PROLOGIC_ENCODER + +#define STATIC_KSNODETYPE_PEAKMETER\ + 0xa085651eL, 0x5f0d, 0x4b36, 0xa8, 0x69, 0xd1, 0x95, 0xd6, 0xab, 0x4b, 0x9e +DEFINE_GUIDSTRUCT("A085651E-5F0D-4b36-A869-D195D6AB4B9E", KSNODETYPE_PEAKMETER); +#define KSNODETYPE_PEAKMETER DEFINE_GUIDNAMED(KSNODETYPE_PEAKMETER) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION < NTDDI_WINXP) + +#define STATIC_KSNODETYPE_SURROUND_ENCODER\ + 0x8074C5B2L, 0x3C66, 0x11D2, 0xB4, 0x5A, 0x30, 0x78, 0x30, 0x2C, 0x20, 0x30 +DEFINE_GUIDSTRUCT("8074C5B2-3C66-11D2-B45A-3078302C2030", KSNODETYPE_SURROUND_ENCODER); +#define KSNODETYPE_SURROUND_ENCODER DEFINE_GUIDNAMED(KSNODETYPE_SURROUND_ENCODER) + +#endif // (NTDDI_VERSION < NTDDI_WINXP) + +//=========================================================================== +// Topology Node Name GUIDs for common audio nodes +#define STATIC_KSAUDFNAME_BASS\ + 0x185FEDE0L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE0-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_BASS); +#define KSAUDFNAME_BASS DEFINE_GUIDNAMED(KSAUDFNAME_BASS) + +#define STATIC_KSAUDFNAME_TREBLE\ + 0x185FEDE1L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE1-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_TREBLE); +#define KSAUDFNAME_TREBLE DEFINE_GUIDNAMED(KSAUDFNAME_TREBLE) + +#define STATIC_KSAUDFNAME_MIDRANGE\ + 0xA2CBE478, 0xAE84, 0x49A1, 0x8B, 0x72, 0x4A, 0xD0, 0x9B, 0x78, 0xED, 0x34 +DEFINE_GUIDSTRUCT("A2CBE478-AE84-49A1-8B72-4AD09B78ED34", KSAUDFNAME_MIDRANGE); +#define KSAUDFNAME_MIDRANGE DEFINE_GUIDNAMED(KSAUDFNAME_MIDRANGE) + +#define STATIC_KSAUDFNAME_3D_STEREO\ + 0x185FEDE2L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE2-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_3D_STEREO); +#define KSAUDFNAME_3D_STEREO DEFINE_GUIDNAMED(KSAUDFNAME_3D_STEREO) + +#define STATIC_KSAUDFNAME_MASTER_VOLUME\ + 0x185FEDE3L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE3-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MASTER_VOLUME); +#define KSAUDFNAME_MASTER_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MASTER_VOLUME) + +#define STATIC_KSAUDFNAME_MASTER_MUTE\ + 0x185FEDE4L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE4-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MASTER_MUTE); +#define KSAUDFNAME_MASTER_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_MASTER_MUTE) + +#define STATIC_KSAUDFNAME_WAVE_VOLUME\ + 0x185FEDE5L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE5-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_WAVE_VOLUME); +#define KSAUDFNAME_WAVE_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_WAVE_VOLUME) + +#define STATIC_KSAUDFNAME_WAVE_MUTE\ + 0x185FEDE6L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE6-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_WAVE_MUTE); +#define KSAUDFNAME_WAVE_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_WAVE_MUTE) + +#define STATIC_KSAUDFNAME_MIDI_VOLUME\ + 0x185FEDE7L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE7-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIDI_VOLUME); +#define KSAUDFNAME_MIDI_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MIDI_VOLUME) + +#define STATIC_KSAUDFNAME_MIDI_MUTE\ + 0x185FEDE8L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE8-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIDI_MUTE); +#define KSAUDFNAME_MIDI_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_MIDI_MUTE) + +#define STATIC_KSAUDFNAME_CD_VOLUME\ + 0x185FEDE9L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDE9-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_CD_VOLUME); +#define KSAUDFNAME_CD_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_CD_VOLUME) + +#define STATIC_KSAUDFNAME_CD_MUTE\ + 0x185FEDEAL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDEA-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_CD_MUTE); +#define KSAUDFNAME_CD_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_CD_MUTE) + +#define STATIC_KSAUDFNAME_LINE_VOLUME\ + 0x185FEDEBL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDEB-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_LINE_VOLUME); +#define KSAUDFNAME_LINE_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_LINE_VOLUME) + +#define STATIC_KSAUDFNAME_LINE_MUTE\ + 0x185FEDECL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDEC-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_LINE_MUTE); +#define KSAUDFNAME_LINE_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_LINE_MUTE) + +#define STATIC_KSAUDFNAME_MIC_VOLUME\ + 0x185FEDEDL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDED-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIC_VOLUME); +#define KSAUDFNAME_MIC_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MIC_VOLUME) + +#define STATIC_KSAUDFNAME_MIC_MUTE\ + 0x185FEDEEL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDEE-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIC_MUTE); +#define KSAUDFNAME_MIC_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_MIC_MUTE) + +#define STATIC_KSAUDFNAME_RECORDING_SOURCE\ + 0x185FEDEFL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDEF-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_RECORDING_SOURCE); +#define KSAUDFNAME_RECORDING_SOURCE DEFINE_GUIDNAMED(KSAUDFNAME_RECORDING_SOURCE) + +#define STATIC_KSAUDFNAME_PC_SPEAKER_VOLUME\ + 0x185FEDF0L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF0-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_PC_SPEAKER_VOLUME); +#define KSAUDFNAME_PC_SPEAKER_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_PC_SPEAKER_VOLUME) + +#define STATIC_KSAUDFNAME_PC_SPEAKER_MUTE\ + 0x185FEDF1L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF1-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_PC_SPEAKER_MUTE); +#define KSAUDFNAME_PC_SPEAKER_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_PC_SPEAKER_MUTE) + +#define STATIC_KSAUDFNAME_MIDI_IN_VOLUME\ + 0x185FEDF2L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF2-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIDI_IN_VOLUME); +#define KSAUDFNAME_MIDI_IN_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MIDI_IN_VOLUME) + +#define STATIC_KSAUDFNAME_CD_IN_VOLUME\ + 0x185FEDF3L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF3-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_CD_IN_VOLUME); +#define KSAUDFNAME_CD_IN_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_CD_IN_VOLUME) + +#define STATIC_KSAUDFNAME_LINE_IN_VOLUME\ + 0x185FEDF4L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF4-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_LINE_IN_VOLUME); +#define KSAUDFNAME_LINE_IN_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_LINE_IN_VOLUME) + +#define STATIC_KSAUDFNAME_MIC_IN_VOLUME\ + 0x185FEDF5L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF5-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIC_IN_VOLUME); +#define KSAUDFNAME_MIC_IN_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MIC_IN_VOLUME) + +#define STATIC_KSAUDFNAME_WAVE_IN_VOLUME\ + 0x185FEDF6L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF6-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_WAVE_IN_VOLUME); +#define KSAUDFNAME_WAVE_IN_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_WAVE_IN_VOLUME) + +#define STATIC_KSAUDFNAME_VOLUME_CONTROL\ + 0x185FEDF7L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF7-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_VOLUME_CONTROL); +#define KSAUDFNAME_VOLUME_CONTROL DEFINE_GUIDNAMED(KSAUDFNAME_VOLUME_CONTROL) + +#define STATIC_KSAUDFNAME_MIDI\ + 0x185FEDF8L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF8-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_MIDI); +#define KSAUDFNAME_MIDI DEFINE_GUIDNAMED(KSAUDFNAME_MIDI) + +#define STATIC_KSAUDFNAME_LINE_IN\ + 0x185FEDF9L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDF9-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_LINE_IN); +#define KSAUDFNAME_LINE_IN DEFINE_GUIDNAMED(KSAUDFNAME_LINE_IN) + +#define STATIC_KSAUDFNAME_RECORDING_CONTROL\ + 0x185FEDFAL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFA-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_RECORDING_CONTROL); +#define KSAUDFNAME_RECORDING_CONTROL DEFINE_GUIDNAMED(KSAUDFNAME_RECORDING_CONTROL) + +#define STATIC_KSAUDFNAME_CD_AUDIO\ + 0x185FEDFBL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFB-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_CD_AUDIO); +#define KSAUDFNAME_CD_AUDIO DEFINE_GUIDNAMED(KSAUDFNAME_CD_AUDIO) + +#define STATIC_KSAUDFNAME_AUX_VOLUME\ + 0x185FEDFCL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFC-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_AUX_VOLUME); +#define KSAUDFNAME_AUX_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_AUX_VOLUME) + +#define STATIC_KSAUDFNAME_AUX_MUTE\ + 0x185FEDFDL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFD-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_AUX_MUTE); +#define KSAUDFNAME_AUX_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_AUX_MUTE) + +#define STATIC_KSAUDFNAME_AUX\ + 0x185FEDFEL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFE-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_AUX); +#define KSAUDFNAME_AUX DEFINE_GUIDNAMED(KSAUDFNAME_AUX) + +#define STATIC_KSAUDFNAME_PC_SPEAKER\ + 0x185FEDFFL, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEDFF-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_PC_SPEAKER); +#define KSAUDFNAME_PC_SPEAKER DEFINE_GUIDNAMED(KSAUDFNAME_PC_SPEAKER) + +#define STATIC_KSAUDFNAME_WAVE_OUT_MIX\ + 0x185FEE00L, 0x9905, 0x11D1, 0x95, 0xA9, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("185FEE00-9905-11D1-95A9-00C04FB925D3", KSAUDFNAME_WAVE_OUT_MIX); +#define KSAUDFNAME_WAVE_OUT_MIX DEFINE_GUIDNAMED(KSAUDFNAME_WAVE_OUT_MIX) + +#define STATIC_KSAUDFNAME_MONO_OUT\ + 0xf9b41dc3L, 0x96e2, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("F9B41DC3-96E2-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_OUT); +#define KSAUDFNAME_MONO_OUT DEFINE_GUIDNAMED(KSAUDFNAME_MONO_OUT) + +#define STATIC_KSAUDFNAME_STEREO_MIX\ + 0xdff077L, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("00DFF077-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_STEREO_MIX); +#define KSAUDFNAME_STEREO_MIX DEFINE_GUIDNAMED(KSAUDFNAME_STEREO_MIX) + +#define STATIC_KSAUDFNAME_MONO_MIX\ + 0xdff078L, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("00DFF078-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_MIX); +#define KSAUDFNAME_MONO_MIX DEFINE_GUIDNAMED(KSAUDFNAME_MONO_MIX) + +#define STATIC_KSAUDFNAME_MONO_OUT_VOLUME\ + 0x1ad247ebL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("1AD247EB-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_OUT_VOLUME); +#define KSAUDFNAME_MONO_OUT_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MONO_OUT_VOLUME) + +#define STATIC_KSAUDFNAME_MONO_OUT_MUTE\ + 0x1ad247ecL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("1AD247EC-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_OUT_MUTE); +#define KSAUDFNAME_MONO_OUT_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_MONO_OUT_MUTE) + +#define STATIC_KSAUDFNAME_STEREO_MIX_VOLUME\ + 0x1ad247edL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("1AD247ED-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_STEREO_MIX_VOLUME); +#define KSAUDFNAME_STEREO_MIX_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_STEREO_MIX_VOLUME) + +#define STATIC_KSAUDFNAME_STEREO_MIX_MUTE\ + 0x22b0eafdL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("22B0EAFD-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_STEREO_MIX_MUTE); +#define KSAUDFNAME_STEREO_MIX_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_STEREO_MIX_MUTE) + +#define STATIC_KSAUDFNAME_MONO_MIX_VOLUME\ + 0x22b0eafeL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("22B0EAFE-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_MIX_VOLUME); +#define KSAUDFNAME_MONO_MIX_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_MONO_MIX_VOLUME) + +#define STATIC_KSAUDFNAME_MONO_MIX_MUTE\ + 0x2bc31d69L, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("2BC31D69-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MONO_MIX_MUTE); +#define KSAUDFNAME_MONO_MIX_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_MONO_MIX_MUTE) + +#define STATIC_KSAUDFNAME_MICROPHONE_BOOST\ + 0x2bc31d6aL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("2BC31D6A-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_MICROPHONE_BOOST); +#define KSAUDFNAME_MICROPHONE_BOOST DEFINE_GUIDNAMED(KSAUDFNAME_MICROPHONE_BOOST) + +#define STATIC_KSAUDFNAME_ALTERNATE_MICROPHONE\ + 0x2bc31d6bL, 0x96e3, 0x11d2, 0xac, 0x4c, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("2BC31D6B-96E3-11d2-AC4C-00C04F8EFB68", KSAUDFNAME_ALTERNATE_MICROPHONE); +#define KSAUDFNAME_ALTERNATE_MICROPHONE DEFINE_GUIDNAMED(KSAUDFNAME_ALTERNATE_MICROPHONE) + +#define STATIC_KSAUDFNAME_3D_DEPTH\ + 0x63ff5747L, 0x991f, 0x11d2, 0xac, 0x4d, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("63FF5747-991F-11d2-AC4D-00C04F8EFB68", KSAUDFNAME_3D_DEPTH); +#define KSAUDFNAME_3D_DEPTH DEFINE_GUIDNAMED(KSAUDFNAME_3D_DEPTH) + +#define STATIC_KSAUDFNAME_3D_CENTER\ + 0x9f0670b4L, 0x991f, 0x11d2, 0xac, 0x4d, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("9F0670B4-991F-11d2-AC4D-00C04F8EFB68", KSAUDFNAME_3D_CENTER); +#define KSAUDFNAME_3D_CENTER DEFINE_GUIDNAMED(KSAUDFNAME_3D_CENTER) + +#define STATIC_KSAUDFNAME_VIDEO_VOLUME\ + 0x9b46e708L, 0x992a, 0x11d2, 0xac, 0x4d, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("9B46E708-992A-11d2-AC4D-00C04F8EFB68", KSAUDFNAME_VIDEO_VOLUME); +#define KSAUDFNAME_VIDEO_VOLUME DEFINE_GUIDNAMED(KSAUDFNAME_VIDEO_VOLUME) + +#define STATIC_KSAUDFNAME_VIDEO_MUTE\ + 0x9b46e709L, 0x992a, 0x11d2, 0xac, 0x4d, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("9B46E709-992A-11d2-AC4D-00C04F8EFB68", KSAUDFNAME_VIDEO_MUTE); +#define KSAUDFNAME_VIDEO_MUTE DEFINE_GUIDNAMED(KSAUDFNAME_VIDEO_MUTE) + +#define STATIC_KSAUDFNAME_VIDEO\ + 0x915daec4L, 0xa434, 0x11d2, 0xac, 0x52, 0x0, 0xc0, 0x4f, 0x8e, 0xfb, 0x68 +DEFINE_GUIDSTRUCT("915DAEC4-A434-11d2-AC52-00C04F8EFB68", KSAUDFNAME_VIDEO); +#define KSAUDFNAME_VIDEO DEFINE_GUIDNAMED(KSAUDFNAME_VIDEO) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_KSAUDFNAME_PEAKMETER\ + 0x57e24340L, 0xfc5b, 0x4612, 0xa5, 0x62, 0x72, 0xb1, 0x1a, 0x29, 0xdf, 0xae +DEFINE_GUIDSTRUCT("57E24340-FC5B-4612-A562-72B11A29DFAE", KSAUDFNAME_PEAKMETER); +#define KSAUDFNAME_PEAKMETER DEFINE_GUIDNAMED(KSAUDFNAME_PEAKMETER) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + + +// Internal topology node pin definitions + +#define KSNODEPIN_STANDARD_IN 1 +#define KSNODEPIN_STANDARD_OUT 0 + +#define KSNODEPIN_SUM_MUX_IN 1 // can be >= 1 +#define KSNODEPIN_SUM_MUX_OUT 0 + +#define KSNODEPIN_DEMUX_IN 0 +#define KSNODEPIN_DEMUX_OUT 1 // can be >= 1 + +#if (NTDDI_VERSION < NTDDI_VISTA) + +#define KSNODEPIN_AEC_RENDER_IN 1 +#define KSNODEPIN_AEC_RENDER_OUT 0 +#define KSNODEPIN_AEC_CAPTURE_IN 2 +#define KSNODEPIN_AEC_CAPTURE_OUT 3 + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +//=========================================================================== +//=========================================================================== + +#define STATIC_KSMETHODSETID_Wavetable\ + 0xDCEF31EBL, 0xD907, 0x11D0, 0x95, 0x83, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("DCEF31EB-D907-11D0-9583-00C04FB925D3", KSMETHODSETID_Wavetable); +#define KSMETHODSETID_Wavetable DEFINE_GUIDNAMED(KSMETHODSETID_Wavetable) + +typedef enum { + KSMETHOD_WAVETABLE_WAVE_ALLOC, + KSMETHOD_WAVETABLE_WAVE_FREE, + KSMETHOD_WAVETABLE_WAVE_FIND, + KSMETHOD_WAVETABLE_WAVE_WRITE +} KSMETHOD_WAVETABLE; + +typedef struct { + KSIDENTIFIER Identifier; // wave identifier + ULONG Size; // wave size + BOOL Looped; // wave looped flag + ULONG LoopPoint; // wave loop point + BOOL InROM; // wave InROM flag + KSDATAFORMAT Format; // wave format +} KSWAVETABLE_WAVE_DESC, *PKSWAVETABLE_WAVE_DESC; + + +//=========================================================================== +//=========================================================================== + +/* + Property sets and items +*/ + +//=========================================================================== +//=========================================================================== + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) +#define STATIC_KSPROPSETID_Acoustic_Echo_Cancel\ + 0xd7a4af8bL, 0x3dc1, 0x4902, 0x91, 0xea, 0x8a, 0x15, 0xc9, 0x0e, 0x05, 0xb2 +DEFINE_GUIDSTRUCT("D7A4AF8B-3DC1-4902-91EA-8A15C90E05B2", KSPROPSETID_Acoustic_Echo_Cancel); +#define KSPROPSETID_Acoustic_Echo_Cancel DEFINE_GUIDNAMED(KSPROPSETID_Acoustic_Echo_Cancel) + +typedef enum { + KSPROPERTY_AEC_NOISE_FILL_ENABLE = 0, + KSPROPERTY_AEC_STATUS, + KSPROPERTY_AEC_MODE +} KSPROPERTY_AEC; + +#define AEC_STATUS_FD_HISTORY_UNINITIALIZED 0x0 +#define AEC_STATUS_FD_HISTORY_CONTINUOUSLY_CONVERGED 0x1 +#define AEC_STATUS_FD_HISTORY_PREVIOUSLY_DIVERGED 0x2 +#define AEC_STATUS_FD_CURRENTLY_CONVERGED 0x8 + +#define AEC_MODE_PASS_THROUGH 0x0 +#define AEC_MODE_HALF_DUPLEX 0x1 +#define AEC_MODE_FULL_DUPLEX 0x2 + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +//=========================================================================== +//=========================================================================== +#if (NTDDI_VERSION < NTDDI_WS03) + +#define STATIC_KSPROPSETID_Wave_Queued\ + 0x16a15b10L, 0x16f0, 0x11d0, 0xa1, 0x95, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("16a15b10-16f0-11d0-a195-0020afd156e4", KSPROPSETID_Wave_Queued); +#define KSPROPSETID_Wave_Queued DEFINE_GUIDNAMED(KSPROPSETID_Wave_Queued) + +#define KSPROPERTY_WAVE_QUEUED_POSITION 0x00000001 + +#define STATIC_KSMETHODSETID_Wave_Queued\ + 0x7432c160L, 0x8827, 0x11cf, 0xa1, 0x02, 0x00, 0x20, 0xaf, 0xd1, 0x56, 0xe4 +DEFINE_GUIDSTRUCT("7432c160-8827-11cf-a102-0020afd156e4", KSMETHODSETID_Wave_Queued); +#define KSMETHODSETID_Wave_Queued DEFINE_GUIDNAMED(KSMETHODSETID_Wave_Queued) + +#define KSMETHOD_WAVE_QUEUED_BREAKLOOP 0x00000001 + +#endif // (NTDDI_VERSION < NTDDI_WS03) + + +#define STATIC_KSPROPSETID_Wave\ + 0x924e54b0L, 0x630f, 0x11cf, 0xad, 0xa7, 0x08, 0x00, 0x3e, 0x30, 0x49, 0x4a +DEFINE_GUIDSTRUCT("924e54b0-630f-11cf-ada7-08003e30494a", KSPROPSETID_Wave); +#define KSPROPSETID_Wave DEFINE_GUIDNAMED(KSPROPSETID_Wave) + +typedef enum { + KSPROPERTY_WAVE_COMPATIBLE_CAPABILITIES, + KSPROPERTY_WAVE_INPUT_CAPABILITIES, + KSPROPERTY_WAVE_OUTPUT_CAPABILITIES, + KSPROPERTY_WAVE_BUFFER, + KSPROPERTY_WAVE_FREQUENCY, + KSPROPERTY_WAVE_VOLUME, + KSPROPERTY_WAVE_PAN +} KSPROPERTY_WAVE; + +typedef struct { + ULONG ulDeviceType; +} KSWAVE_COMPATCAPS, *PKSWAVE_COMPATCAPS; + +#define KSWAVE_COMPATCAPS_INPUT 0x00000000 +#define KSWAVE_COMPATCAPS_OUTPUT 0x00000001 + +typedef struct { + ULONG MaximumChannelsPerConnection; + ULONG MinimumBitsPerSample; + ULONG MaximumBitsPerSample; + ULONG MinimumSampleFrequency; + ULONG MaximumSampleFrequency; + ULONG TotalConnections; + ULONG ActiveConnections; +} KSWAVE_INPUT_CAPABILITIES, *PKSWAVE_INPUT_CAPABILITIES; + +typedef struct { + ULONG MaximumChannelsPerConnection; + ULONG MinimumBitsPerSample; + ULONG MaximumBitsPerSample; + ULONG MinimumSampleFrequency; + ULONG MaximumSampleFrequency; + ULONG TotalConnections; + ULONG StaticConnections; + ULONG StreamingConnections; + ULONG ActiveConnections; + ULONG ActiveStaticConnections; + ULONG ActiveStreamingConnections; + ULONG Total3DConnections; + ULONG Static3DConnections; + ULONG Streaming3DConnections; + ULONG Active3DConnections; + ULONG ActiveStatic3DConnections; + ULONG ActiveStreaming3DConnections; + ULONG TotalSampleMemory; + ULONG FreeSampleMemory; + ULONG LargestFreeContiguousSampleMemory; +} KSWAVE_OUTPUT_CAPABILITIES, *PKSWAVE_OUTPUT_CAPABILITIES; + +typedef struct { + LONG LeftAttenuation; + LONG RightAttenuation; +} KSWAVE_VOLUME, *PKSWAVE_VOLUME; + +#define KSWAVE_BUFFER_ATTRIBUTEF_LOOPING 0x00000001 +#define KSWAVE_BUFFER_ATTRIBUTEF_STATIC 0x00000002 + +typedef struct { + ULONG Attributes; + ULONG BufferSize; + PVOID BufferAddress; +} KSWAVE_BUFFER, *PKSWAVE_BUFFER; + +//=========================================================================== +//=========================================================================== + +#define STATIC_KSMUSIC_TECHNOLOGY_PORT\ + 0x86C92E60L, 0x62E8, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("86C92E60-62E8-11CF-A5D6-28DB04C10000", KSMUSIC_TECHNOLOGY_PORT); +#define KSMUSIC_TECHNOLOGY_PORT DEFINE_GUIDNAMED(KSMUSIC_TECHNOLOGY_PORT) + +#define STATIC_KSMUSIC_TECHNOLOGY_SQSYNTH\ + 0x0ECF4380L, 0x62E9, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("0ECF4380-62E9-11CF-A5D6-28DB04C10000", KSMUSIC_TECHNOLOGY_SQSYNTH); +#define KSMUSIC_TECHNOLOGY_SQSYNTH DEFINE_GUIDNAMED(KSMUSIC_TECHNOLOGY_SQSYNTH) + +#define STATIC_KSMUSIC_TECHNOLOGY_FMSYNTH\ + 0x252C5C80L, 0x62E9, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("252C5C80-62E9-11CF-A5D6-28DB04C10000", KSMUSIC_TECHNOLOGY_FMSYNTH); +#define KSMUSIC_TECHNOLOGY_FMSYNTH DEFINE_GUIDNAMED(KSMUSIC_TECHNOLOGY_FMSYNTH) + +#define STATIC_KSMUSIC_TECHNOLOGY_WAVETABLE\ + 0x394EC7C0L, 0x62E9, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("394EC7C0-62E9-11CF-A5D6-28DB04C10000", KSMUSIC_TECHNOLOGY_WAVETABLE); +#define KSMUSIC_TECHNOLOGY_WAVETABLE DEFINE_GUIDNAMED(KSMUSIC_TECHNOLOGY_WAVETABLE) + +#define STATIC_KSMUSIC_TECHNOLOGY_SWSYNTH\ + 0x37407736L, 0x3620, 0x11D1, 0x85, 0xD3, 0x00, 0x00, 0xF8, 0x75, 0x43, 0x80 +DEFINE_GUIDSTRUCT("37407736-3620-11D1-85D3-0000F8754380", KSMUSIC_TECHNOLOGY_SWSYNTH); +#define KSMUSIC_TECHNOLOGY_SWSYNTH DEFINE_GUIDNAMED(KSMUSIC_TECHNOLOGY_SWSYNTH) + +#if (NTDDI_VERSION < NTDDI_WS03) + +#define STATIC_KSPROPSETID_WaveTable\ + 0x8539E660L, 0x62E9, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("8539E660-62E9-11CF-A5D6-28DB04C10000", KSPROPSETID_WaveTable); +#define KSPROPSETID_WaveTable DEFINE_GUIDNAMED(KSPROPSETID_WaveTable) + +typedef enum { + KSPROPERTY_WAVETABLE_LOAD_SAMPLE, + KSPROPERTY_WAVETABLE_UNLOAD_SAMPLE, + KSPROPERTY_WAVETABLE_MEMORY, + KSPROPERTY_WAVETABLE_VERSION +} KSPROPERTY_WAVETABLE; + +#endif // (NTDDI_VERSION < NTDDI_WS03) + +typedef struct { + KSDATARANGE DataRange; + GUID Technology; + ULONG Channels; + ULONG Notes; + ULONG ChannelMask; +} KSDATARANGE_MUSIC, *PKSDATARANGE_MUSIC; + +//=========================================================================== + +#if (NTDDI_VERSION < NTDDI_WS03) + +#define STATIC_KSEVENTSETID_Cyclic\ + 0x142C1AC0L, 0x072A, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("142C1AC0-072A-11D0-A5D6-28DB04C10000", KSEVENTSETID_Cyclic); +#define KSEVENTSETID_Cyclic DEFINE_GUIDNAMED(KSEVENTSETID_Cyclic) + +typedef enum { + KSEVENT_CYCLIC_TIME_INTERVAL, +} KSEVENT_CYCLIC_TIME; + +#endif // (NTDDI_VERSION < NTDDI_WS03) + +#define STATIC_KSPROPSETID_Cyclic\ + 0x3FFEAEA0L, 0x2BEE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("3FFEAEA0-2BEE-11CF-A5D6-28DB04C10000", KSPROPSETID_Cyclic); +#define KSPROPSETID_Cyclic DEFINE_GUIDNAMED(KSPROPSETID_Cyclic) + +typedef enum { + KSPROPERTY_CYCLIC_POSITION, +} KSPROPERTY_CYCLIC; + +//=========================================================================== +#define STATIC_KSEVENTSETID_AudioControlChange\ + 0xE85E9698L, 0xFA2F, 0x11D1, 0x95, 0xBD, 0x00, 0xC0, 0x4F, 0xB9, 0x25, 0xD3 +DEFINE_GUIDSTRUCT("E85E9698-FA2F-11D1-95BD-00C04FB925D3", KSEVENTSETID_AudioControlChange); +#define KSEVENTSETID_AudioControlChange DEFINE_GUIDNAMED(KSEVENTSETID_AudioControlChange) + +typedef enum { + KSEVENT_CONTROL_CHANGE, +} KSEVENT_AUDIO_CONTROL_CHANGE; + +//=========================================================================== + +#define STATIC_KSEVENTSETID_LoopedStreaming\ + 0x4682B940L, 0xC6EF, 0x11D0, 0x96, 0xD8, 0x00, 0xAA, 0x00, 0x51, 0xE5, 0x1D +DEFINE_GUIDSTRUCT("4682B940-C6EF-11D0-96D8-00AA0051E51D", KSEVENTSETID_LoopedStreaming); +#define KSEVENTSETID_LoopedStreaming DEFINE_GUIDNAMED(KSEVENTSETID_LoopedStreaming) + +typedef enum { + KSEVENT_LOOPEDSTREAMING_POSITION, +} KSEVENT_LOOPEDSTREAMING; + +typedef struct { + KSEVENTDATA KsEventData; +#if defined(_NTDDK_) + ULONGLONG Position; +#else // !_NTDDK_ + DWORDLONG Position; +#endif // !_NTDDK_ +} LOOPEDSTREAMING_POSITION_EVENT_DATA, *PLOOPEDSTREAMING_POSITION_EVENT_DATA ; + +#if (NTDDI_VERSION <= NTDDI_WINXP) + +#define STATIC_KSEVENTSETID_Sysaudio \ + 0x04800320L, 0x4491, 0x11D1, 0xA0, 0x50, 0x40, 0x57, 0x05, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("04800320-4491-11D1-A050-405705C10000", KSEVENTSETID_Sysaudio); +#define KSEVENTSETID_Sysaudio DEFINE_GUIDNAMED(KSEVENTSETID_Sysaudio) + +typedef enum { + KSEVENT_SYSAUDIO_ADDREMOVE_DEVICE +#if (NTDDI_VERSION == NTDDI_WINXP) + , KSEVENT_SYSAUDIO_CHANGE_DEVICE +#endif +} KSEVENT_SYSAUDIO; + +#endif // (NTDDI_VERSION <= NTDDI_WINXP) + + +#if (NTDDI_VERSION < NTDDI_VISTA) + +//=========================================================================== +#define STATIC_KSPROPSETID_Sysaudio\ + 0xCBE3FAA0L, 0xCC75, 0x11D0, 0xB4, 0x65, 0x00, 0x00, 0x1A, 0x18, 0x18, 0xE6 +DEFINE_GUIDSTRUCT("CBE3FAA0-CC75-11D0-B465-00001A1818E6", KSPROPSETID_Sysaudio); +#define KSPROPSETID_Sysaudio DEFINE_GUIDNAMED(KSPROPSETID_Sysaudio) + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +typedef enum { + KSPROPERTY_SYSAUDIO_DEVICE_COUNT = 1, + KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME = 2, + KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE = 3, + KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME = 4, + KSPROPERTY_SYSAUDIO_SELECT_GRAPH = 5, + KSPROPERTY_SYSAUDIO_CREATE_VIRTUAL_SOURCE = 6, + KSPROPERTY_SYSAUDIO_DEVICE_DEFAULT = 7, + KSPROPERTY_SYSAUDIO_INSTANCE_INFO = 14, + KSPROPERTY_SYSAUDIO_COMPONENT_ID = 16, +} KSPROPERTY_SYSAUDIO; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION < NTDDI_WINXP) + +typedef enum { + KSPROPERTY_SYSAUDIO_DEVICE_COUNT = 1, + KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME, + KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE, + KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME, + KSPROPERTY_SYSAUDIO_SELECT_GRAPH, + KSPROPERTY_SYSAUDIO_CREATE_VIRTUAL_SOURCE, + KSPROPERTY_SYSAUDIO_DEVICE_DEFAULT, + KSPROPERTY_SYSAUDIO_ALWAYS_CREATE_VIRTUAL_SOURCE, + KSPROPERTY_SYSAUDIO_ADDREMOVE_LOCK, + KSPROPERTY_SYSAUDIO_ADDREMOVE_UNLOCK, + KSPROPERTY_SYSAUDIO_RENDER_PIN_INSTANCES, + KSPROPERTY_SYSAUDIO_RENDER_CONNECTION_INDEX, + KSPROPERTY_SYSAUDIO_CREATE_VIRTUAL_SOURCE_ONLY, + KSPROPERTY_SYSAUDIO_INSTANCE_INFO, + KSPROPERTY_SYSAUDIO_PREFERRED_DEVICE +} KSPROPERTY_SYSAUDIO; + +#endif // (NTDDI_VERSION < NTDDI_WINXP) + +#if (NTDDI_VERSION < NTDDI_VISTA) + +typedef struct { + KSPROPERTY Property; + GUID PinCategory; + GUID PinName; +} SYSAUDIO_CREATE_VIRTUAL_SOURCE, *PSYSAUDIO_CREATE_VIRTUAL_SOURCE; + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + + +#if (NTDDI_VERSION < NTDDI_VISTA) + +typedef struct { + KSPROPERTY Property; + ULONG PinId; + ULONG NodeId; + ULONG Flags; + ULONG Reserved; +} SYSAUDIO_SELECT_GRAPH, *PSYSAUDIO_SELECT_GRAPH; + +typedef struct { + KSPROPERTY Property; + ULONG Flags; + ULONG DeviceNumber; +} SYSAUDIO_INSTANCE_INFO, *PSYSAUDIO_INSTANCE_INFO; + +#define SYSAUDIO_FLAGS_DONT_COMBINE_PINS 0x00000001 + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION < NTDDI_WINXP) +typedef struct { + KSPROPERTY Property; + ULONG Flags; + ULONG Index; // KSPROPERTY_SYSAUDIO_DEFAULT_TYPE +} SYSAUDIO_PREFERRED_DEVICE, *PSYSAUDIO_PREFERRED_DEVICE; + +#define SYSAUDIO_FLAGS_CLEAR_PREFERRED 0x00000002 +#endif // (NTDDI_VERSION < NTDDI_WINXP) + +#if (NTDDI_VERSION < NTDDI_VISTA) + + +#define STATIC_KSPROPSETID_Sysaudio_Pin \ + 0xA3A53220L, 0xC6E4, 0x11D0, 0xB4, 0x65, 0x00, 0x00, 0x1A, 0x18, 0x18, 0xE6 +DEFINE_GUIDSTRUCT("A3A53220-C6E4-11D0-B465-00001A1818E6", KSPROPSETID_Sysaudio_Pin); +#define KSPROPSETID_Sysaudio_Pin DEFINE_GUIDNAMED(KSPROPSETID_Sysaudio_Pin) + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +typedef enum { + KSPROPERTY_SYSAUDIO_ATTACH_VIRTUAL_SOURCE = 1, +} KSPROPERTY_SYSAUDIO_PIN; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +#if (NTDDI_VERSION < NTDDI_WINXP) + +typedef enum { + KSPROPERTY_SYSAUDIO_TOPOLOGY_CONNECTION_INDEX, + KSPROPERTY_SYSAUDIO_ATTACH_VIRTUAL_SOURCE, + KSPROPERTY_SYSAUDIO_PIN_VOLUME_NODE +} KSPROPERTY_SYSAUDIO_PIN; + +#endif // (NTDDI_VERSION < NTDDI_WINXP) + +#if (NTDDI_VERSION < NTDDI_VISTA) + +typedef struct { + KSPROPERTY Property; + ULONG MixerPinId; + ULONG Reserved; +} SYSAUDIO_ATTACH_VIRTUAL_SOURCE, *PSYSAUDIO_ATTACH_VIRTUAL_SOURCE; + +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +//=========================================================================== + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +typedef struct { + KSPROPERTY Property; + ULONG NodeId; + ULONG Reserved; +} KSNODEPROPERTY, *PKSNODEPROPERTY; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct { + KSNODEPROPERTY NodeProperty; + LONG Channel; // value to get or set + ULONG Reserved; +} KSNODEPROPERTY_AUDIO_CHANNEL, *PKSNODEPROPERTY_AUDIO_CHANNEL; + +typedef struct { + KSNODEPROPERTY NodeProperty; + ULONG DevSpecificId; + ULONG DeviceInfo; + ULONG Length; +} KSNODEPROPERTY_AUDIO_DEV_SPECIFIC, *PKSNODEPROPERTY_AUDIO_DEV_SPECIFIC; + +typedef struct { + KSNODEPROPERTY NodeProperty; + PVOID ListenerId; +#ifndef _WIN64 + ULONG Reserved; +#endif // _WIN64 +} KSNODEPROPERTY_AUDIO_3D_LISTENER, *PKSNODEPROPERTY_AUDIO_3D_LISTENER; + +typedef struct { + KSNODEPROPERTY NodeProperty; + PVOID AppContext; + ULONG Length; +#ifndef _WIN64 + ULONG Reserved; +#endif // _WIN64 +} KSNODEPROPERTY_AUDIO_PROPERTY, *PKSNODEPROPERTY_AUDIO_PROPERTY; + +#if (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +//=========================================================================== +// {79A9312E-59AE-43b0-A350-8B05284CAB24} +#define STATIC_KSPROPSETID_AudioGfx\ + 0x79a9312eL, 0x59ae, 0x43b0, 0xa3, 0x50, 0x8b, 0x5, 0x28, 0x4c, 0xab, 0x24 +DEFINE_GUIDSTRUCT("79A9312E-59AE-43b0-A350-8B05284CAB24", KSPROPSETID_AudioGfx); +#define KSPROPSETID_AudioGfx DEFINE_GUIDNAMED(KSPROPSETID_AudioGfx) + +typedef enum { + KSPROPERTY_AUDIOGFX_RENDERTARGETDEVICEID, + KSPROPERTY_AUDIOGFX_CAPTURETARGETDEVICEID +} KSPROPERTY_AUDIOGFX; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP && NTDDI_VERSION < NTDDI_VISTA) + +//=========================================================================== + +#if (NTDDI_VERSION < NTDDI_WS03) + +#define STATIC_KSPROPSETID_Linear\ + 0x5A2FFE80L, 0x16B9, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("5A2FFE80-16B9-11D0-A5D6-28DB04C10000", KSPROPSETID_Linear); +#define KSPROPSETID_Linear DEFINE_GUIDNAMED(KSPROPSETID_Linear) + +typedef enum { + KSPROPERTY_LINEAR_POSITION, +} KSPROPERTY_LINEAR; + +#endif // (NTDDI_VERSION < NTDDI_WS03) + +//=========================================================================== + + +// +// Midi definitions +// + +/* + Formats +*/ + +#define STATIC_KSDATAFORMAT_TYPE_MUSIC\ + 0xE725D360L, 0x62CC, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("E725D360-62CC-11CF-A5D6-28DB04C10000", KSDATAFORMAT_TYPE_MUSIC); +#define KSDATAFORMAT_TYPE_MUSIC DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MUSIC) + +// 'mids' == MEDIATYPE_Midi +#define STATIC_KSDATAFORMAT_TYPE_MIDI\ + 0x7364696DL, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("7364696D-0000-0010-8000-00aa00389b71", KSDATAFORMAT_TYPE_MIDI); +#define KSDATAFORMAT_TYPE_MIDI DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MIDI) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MIDI\ + 0x1D262760L, 0xE957, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("1D262760-E957-11CF-A5D6-28DB04C10000", KSDATAFORMAT_SUBTYPE_MIDI); +#define KSDATAFORMAT_SUBTYPE_MIDI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MIDI) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MIDI_BUS\ + 0x2CA15FA0L, 0x6CFE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00 +DEFINE_GUIDSTRUCT("2CA15FA0-6CFE-11CF-A5D6-28DB04C10000", KSDATAFORMAT_SUBTYPE_MIDI_BUS); +#define KSDATAFORMAT_SUBTYPE_MIDI_BUS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MIDI_BUS) + +#define STATIC_KSDATAFORMAT_SUBTYPE_RIFFMIDI\ + 0x4995DAF0L, 0x9EE6, 0x11D0, 0xA4, 0x0E, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("4995DAF0-9EE6-11D0-A40E-00A0C9223196", KSDATAFORMAT_SUBTYPE_RIFFMIDI); +#define KSDATAFORMAT_SUBTYPE_RIFFMIDI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_RIFFMIDI) + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) +#define STATIC_KSDATAFORMAT_SUBTYPE_UNIVERSALMIDIPACKET\ + 0xfbffd49e, 0xce26, 0x464a, 0x9d, 0xfc, 0xfe, 0xe4, 0x24, 0x56, 0xc8, 0x1c +DEFINE_GUIDSTRUCT("FBFFD49E-CE26-464A-9DFC-FEE42456C81C", KSDATAFORMAT_SUBTYPE_UNIVERSALMIDIPACKET); +#define KSDATAFORMAT_SUBTYPE_UNIVERSALMIDIPACKET DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_UNIVERSALMIDIPACKET) + +#define STATIC_KSPROPSETID_MidiLoopedStreaming\ + 0x1f306ba6, 0xfd9b, 0x427a, 0xbc, 0xb3, 0x27, 0xcb, 0xcf, 0xe, 0xf, 0x19 + DEFINE_GUIDSTRUCT("1F306BA6-FD9B-427A-BCB3-27CBCF0E0F19", KSPROPSETID_MidiLoopedStreaming); +#define KSPROPSETID_MidiLoopedStreaming DEFINE_GUIDNAMED(KSPROPSETID_MidiLoopedStreaming) + +typedef enum { + KSPROPERTY_MIDILOOPEDSTREAMING_BUFFER, + KSPROPERTY_MIDILOOPEDSTREAMING_REGISTERS, + KSPROPERTY_MIDILOOPEDSTREAMING_NOTIFICATION_EVENT, +} KSPROPERTY_MIDILOOPEDSTREAMING; + +typedef struct { + PVOID BufferAddress; + ULONG ActualBufferSize; +} KSMIDILOOPED_BUFFER, *PKSMIDILOOPED_BUFFER; + +typedef struct { + PVOID WritePosition; + PVOID ReadPosition; +} KSMIDILOOPED_REGISTERS, *PKSMIDILOOPED_REGISTERS; + +typedef struct { + HANDLE WriteEvent; +} KSMIDILOOPED_EVENT, *PKSMIDILOOPED_EVENT; + +#define MIDILOOPED_EVENT2 +typedef struct { + HANDLE WriteEvent; + HANDLE ReadEvent; +} KSMIDILOOPED_EVENT2, *PKSMIDILOOPED_EVENT2; + +typedef struct { + KSPROPERTY Property; + ULONG RequestedBufferSize; +} KSMIDILOOPED_BUFFER_PROPERTY, *PKSMIDILOOPED_BUFFER_PROPERTY; + +// Data format for KSDATAFORMAT_SUBTYPE_UNIVERSALMIDIPACKET +typedef struct { + LONGLONG Position; + ULONG ByteCount; +} UMPDATAFORMAT, *PUMPDATAFORMAT; + +#define LOOPEDDATAFORMAT UMPDATAFORMAT +#define PLOOPEDDATAFORMAT PUMPDATAFORMAT +#endif // (NTDDI_VERSION >= NTDDI_WIN11_GE) + +/* + KSDATAFORMAT_SUBTYPE_DIRECTMUSIC + see DMusicKS.h +*/ + +// WARNING! This structure MUST be dword aligned +// regardless of the number of data bytes. + +typedef struct { + ULONG TimeDeltaMs; // Delta Milliseconds from the previous midiformat + // in the packet. The first midiformat in the packet + // is a delta from the PTS in the KSSTREAM_HEADER. + ULONG ByteCount; // Number of bytes of data that follow this struct. +} KSMUSICFORMAT, *PKSMUSICFORMAT; + +// +// This entire set of MPEG Standard/Dialect Guids are obsolete. Do not use them. +// +//==================================================================================================== +//==================================================================================================== +// The following official MPEG Formats, Subtypes and Specifiers are listed as required or optional +// These official MPEG GUIDs are the preferred method of supporting MPEG/AC-3 media types in new code. +// Older MPEG GUIDs should also be supported for compatibilty, but these new modes are still required. +//==================================================================================================== +//==================================================================================================== + +/* +This is a summary of what media types/specifiers will be required for all DVD+DSS+DVB+DTV MPEG decoders. +These media types are what the decoder driver must accept, hardware support for all of these media types +may or may not actually be provided by the decoder natively. These media types are intended to define +the "officially" supported MPEG/AC-3 media types that all WHQL certified decoders must implement. This +specifically includes driver and/or hardware support for all the required standards and dialects. + +All MPEG video decoders must support all of the MPEG video modes shown as [required] below. +All MPEG audio decoders must support all of the MPEG audio modes shown as [required] below. +All AC-3 audio decoders must support all of the AC-3 audio modes shown as [required] below. +The line items shown as [optional] need not be implemented, but are possible formats that might be implemented. + +Note that the input/output pin formats are defined by 2 or 3 GUIDs: TYPE, SUBTYPE, and maybe SPECIFIER. +The specifiers are included if the data format is a "dialect" that needs to be differentiated during decoding. +The decoder MUST be prepared to deal with ALL requests for _required_ "Standard" formats OR _required_ "Dialects". + +STATIC_KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO [optional] +STATIC_KSDATAFORMAT_TYPE_STANDARD_PES_PACKET [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO [optional] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO [optional] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO [optional] +STATIC_KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO [required] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO [optional] + STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO [required] + STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO [optional] + +Note that the SPECIFIER GUIDs normally identify particular versions of MPEG such as DSS and DVD. +This approach was taken to minimize the number of DSS/DVB/DVD/DTV etc. media SUBTYPES. +These specifiers are currently required to disambiguate MPEG syntax _parsing_ by the decoder +using alternate parsing routines or downloadable firmware or hardware decode settings. + +In the future these specifiers will be extended to cover new KS MPEG flavors such as DVB and DTV. +Thus, the optional specifiers will be subject to clarification and/or definition as they are needed. + +Important note: Per the ITU MPEG specs, MPEG 2 media may contain pure MPEG 1 syntax and +any "MPEG 2" PES packets may actually contain MPEG 1 payloads and MPEG 1 syntax. Some MPEG +broadcasts can revert from MPEG2 to MPEG1 format data at their discretion, without warning. + +CAUTION: Decoders MUST attempt to process MPEG data AS SOON AS POSSIBLE after reception. +In particular, elementary MPEG or MPEG PES packet streams should not be aggregated into DVD +"pack headers" internally before submission to the codec hardware if AT ALL POSSIBLE. The +reason is that mpeg data may need to be processed immediately but there may be no additional +MPEG data forthcoming to fill up the PES packet OR DVD "pack" in a timely fashion. This is +particularly true of MPEG dialects that utilize "repeat field signally" to reuse the last +decoded MPEG video field. + +*/ + +///////////////////////////////////////////////////////////////////////// +// The major data type GUIDs that define the data packet encapsulation // +///////////////////////////////////////////////////////////////////////// + +// STATIC_KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM +#define STATIC_KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM \ + 0x36523b11L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B11-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM ); +#define KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_STANDARD_ELEMENTARY_STREAM) + +// STATIC_KSDATAFORMAT_TYPE_STANDARD_PES_PACKET +#define STATIC_KSDATAFORMAT_TYPE_STANDARD_PES_PACKET \ + 0x36523b12L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B12-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_TYPE_STANDARD_PES_PACKET ); +#define KSDATAFORMAT_TYPE_STANDARD_PES_PACKET DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_STANDARD_PES_PACKET) + +// STATIC_KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER +#define STATIC_KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER \ + 0x36523b13L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B13-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER ); +#define KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_STANDARD_PACK_HEADER) + +/////////////////////////////////////////////////////////////////////////////// +// The minor data subtype GUIDs that define the exact class of the data type.// +/////////////////////////////////////////////////////////////////////////////// + +// STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO +#define STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO \ + 0x36523b21L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B21-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO ); +#define KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_VIDEO) + +// STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO +#define STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO \ + 0x36523b22L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B22-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO ); +#define KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_STANDARD_MPEG1_AUDIO) + +// STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO +#define STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO \ + 0x36523b23L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B23-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO ); +#define KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_VIDEO) + +// STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO +#define STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO \ + 0x36523b24L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B24-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO ); +#define KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_STANDARD_MPEG2_AUDIO) + +// STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO +#define STATIC_KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO \ + 0x36523b25L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B25-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO ); +#define KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_STANDARD_AC3_AUDIO) + +/////////////////////////////////////////////////////////////////////////////// +// The low-level specifier GUIDs that define the flavor of the data subtype. // +// Some SUBTYPES, notably MPEG2_VIDEO, MPEG2_AUDIO have different dialects. // +// These specifiers are intended to be accompanied by a specifier structure. // +/////////////////////////////////////////////////////////////////////////////// + +// STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO +#define STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO \ + 0x36523b31L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B31-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO ); +#define KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_VIDEO) + +// STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO +#define STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO \ + 0x36523b32L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B32-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO ); +#define KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DIALECT_MPEG1_AUDIO) + +// STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO Associated with KS_MPEGVIDEOINFO2 defined later +#define STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO \ + 0x36523b33L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B33-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO ); +#define KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_VIDEO) + +// STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO Associated with KS_MPEGAUDIOINFO defined later +#define STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO \ + 0x36523b34L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B34-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO ); +#define KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DIALECT_MPEG2_AUDIO) + +// STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO +#define STATIC_KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO \ + 0x36523b35L, 0x8ee5, 0x11d1, 0x8c, 0xa3, 0x00, 0x60, 0xb0, 0x57, 0x66, 0x4a +DEFINE_GUIDSTRUCT("36523B35-8EE5-11d1-8CA3-0060B057664A", KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO ); +#define KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_DIALECT_AC3_AUDIO) + +//==================================================================================================== +//==================================================================================================== +// *** COMPATIBILITY WARNING *** +// The *following* older DSS, MPEG, DVD & AC-3 GUID definitions are retained for backward compability. +// These MPEG GUIDs should also be supported for compatibilty, but the above newer modes are still required. +//==================================================================================================== +//==================================================================================================== + +// +// DSS definitions +// + +#define STATIC_KSDATAFORMAT_SUBTYPE_DSS_VIDEO\ + 0xa0af4f81L, 0xe163, 0x11d0, 0xba, 0xd9, 0x00, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("a0af4f81-e163-11d0-bad9-00609744111a", KSDATAFORMAT_SUBTYPE_DSS_VIDEO); +#define KSDATAFORMAT_SUBTYPE_DSS_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_DSS_VIDEO) + +#define STATIC_KSDATAFORMAT_SUBTYPE_DSS_AUDIO\ + 0xa0af4f82L, 0xe163, 0x11d0, 0xba, 0xd9, 0x00, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("a0af4f82-e163-11d0-bad9-00609744111a", KSDATAFORMAT_SUBTYPE_DSS_AUDIO); +#define KSDATAFORMAT_SUBTYPE_DSS_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_DSS_AUDIO) + +// +// End of obsolete MPEG definitions. +// + +// +// mpeg 1 definitions +// +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG1Packet\ + 0xe436eb80, 0x524f, 0x11ce, 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70 +DEFINE_GUIDSTRUCT("e436eb80-524f-11ce-9F53-0020af0ba770", KSDATAFORMAT_SUBTYPE_MPEG1Packet); +#define KSDATAFORMAT_SUBTYPE_MPEG1Packet DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG1Packet) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG1Payload\ + 0xe436eb81, 0x524f, 0x11ce, 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70 +DEFINE_GUIDSTRUCT("e436eb81-524f-11ce-9F53-0020af0ba770", KSDATAFORMAT_SUBTYPE_MPEG1Payload); +#define KSDATAFORMAT_SUBTYPE_MPEG1Payload DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG1Payload) + +// MEDIASUBTYPE_MPEG1Video +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG1Video\ + 0xe436eb86, 0x524f, 0x11ce, 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70 +DEFINE_GUIDSTRUCT("e436eb86-524f-11ce-9f53-0020af0ba770", KSDATAFORMAT_SUBTYPE_MPEG1Video); +#define KSDATAFORMAT_SUBTYPE_MPEG1Video DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG1Video) + +//FORMAT_MPEGVideo +#define STATIC_KSDATAFORMAT_SPECIFIER_MPEG1_VIDEO\ + 0x05589f82L, 0xc356, 0x11ce, 0xbf, 0x01, 0x00, 0xaa, 0x00, 0x55, 0x59, 0x5a +DEFINE_GUIDSTRUCT("05589f82-c356-11ce-bf01-00aa0055595a", KSDATAFORMAT_SPECIFIER_MPEG1_VIDEO); +#define KSDATAFORMAT_SPECIFIER_MPEG1_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_MPEG1_VIDEO) + +// +// mpeg 2 definitions +// +#define STATIC_KSDATAFORMAT_TYPE_MPEG2_PES\ + 0xe06d8020L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8020-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_TYPE_MPEG2_PES); +#define KSDATAFORMAT_TYPE_MPEG2_PES DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MPEG2_PES) + +#define STATIC_KSDATAFORMAT_TYPE_MPEG2_PROGRAM\ + 0xe06d8022L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8022-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_TYPE_MPEG2_PROGRAM); +#define KSDATAFORMAT_TYPE_MPEG2_PROGRAM DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MPEG2_PROGRAM) + +#define STATIC_KSDATAFORMAT_TYPE_MPEG2_TRANSPORT\ + 0xe06d8023L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8023-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_TYPE_MPEG2_TRANSPORT); +#define KSDATAFORMAT_TYPE_MPEG2_TRANSPORT DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_MPEG2_TRANSPORT) + +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG2_VIDEO\ + 0xe06d8026L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8026-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_MPEG2_VIDEO); +#define KSDATAFORMAT_SUBTYPE_MPEG2_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG2_VIDEO) + +// use MPEGVIDEOINFO2 (defined below) with KSDATAFORMAT_SPECIFIER_MPEG2_VIDEO +#define STATIC_KSDATAFORMAT_SPECIFIER_MPEG2_VIDEO\ + 0xe06d80e3L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d80e3-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SPECIFIER_MPEG2_VIDEO); +#define KSDATAFORMAT_SPECIFIER_MPEG2_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_MPEG2_VIDEO) + +// +// Mpeg2 video properties +// + + +#define STATIC_KSPROPSETID_Mpeg2Vid\ + 0xC8E11B60L, 0x0CC9, 0x11D0, 0xBD, 0x69, 0x00, 0x35, 0x05, 0xC1, 0x03, 0xA9 +DEFINE_GUIDSTRUCT("C8E11B60-0CC9-11D0-BD69-003505C103A9", KSPROPSETID_Mpeg2Vid); +#define KSPROPSETID_Mpeg2Vid DEFINE_GUIDNAMED( KSPROPSETID_Mpeg2Vid ) + + +typedef enum { + KSPROPERTY_MPEG2VID_MODES, // available output modes of decoder + KSPROPERTY_MPEG2VID_CUR_MODE, // current mode of the decoder + KSPROPERTY_MPEG2VID_4_3_RECT, // output coordinates for 4:3 source + KSPROPERTY_MPEG2VID_16_9_RECT, // output coordinates for 16:9 source + KSPROPERTY_MPEG2VID_16_9_PANSCAN, // pan and scan vectors +} KSPROPERTY_MPEG2VID; + +// +// bit field definitions for MPEG2 VIDEO mode +// + +#define KSMPEGVIDMODE_PANSCAN 0x0001 +#define KSMPEGVIDMODE_LTRBOX 0x0002 +#define KSMPEGVIDMODE_SCALE 0x0004 + +// +// rectangle definitions for the 4/3 and 16/9 cropping properties of +// the MPEG2Video decoder +// + +typedef struct _KSMPEGVID_RECT { + ULONG StartX; + ULONG StartY; + ULONG EndX; + ULONG EndY; +} KSMPEGVID_RECT, *PKSMPEGVID_RECT; + +// +// Params for pan / scan +// + + +// +// MPEG2 Audio definition +// + +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG2_AUDIO\ + 0xe06d802bL, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d802b-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_MPEG2_AUDIO); +#define KSDATAFORMAT_SUBTYPE_MPEG2_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG2_AUDIO) + +#define STATIC_KSDATAFORMAT_SPECIFIER_MPEG2_AUDIO\ + 0xe06d80e5L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d80e5-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SPECIFIER_MPEG2_AUDIO); +#define KSDATAFORMAT_SPECIFIER_MPEG2_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_MPEG2_AUDIO) + +// +// DVD LPCM Audio definition +// + +#define STATIC_KSDATAFORMAT_SUBTYPE_LPCM_AUDIO\ + 0xe06d8032L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8032-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_LPCM_AUDIO); +#define KSDATAFORMAT_SUBTYPE_LPCM_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_LPCM_AUDIO) + +#define STATIC_KSDATAFORMAT_SPECIFIER_LPCM_AUDIO\ + 0xe06d80e6L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d80e6-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SPECIFIER_LPCM_AUDIO); +#define KSDATAFORMAT_SPECIFIER_LPCM_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_LPCM_AUDIO) + +// +// AC-3 definition +// + +#define STATIC_KSDATAFORMAT_SUBTYPE_AC3_AUDIO\ + 0xe06d802cL, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d802c-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_AC3_AUDIO); +#define KSDATAFORMAT_SUBTYPE_AC3_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_AC3_AUDIO) + +#define STATIC_KSDATAFORMAT_SPECIFIER_AC3_AUDIO\ + 0xe06d80e4L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d80e4-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SPECIFIER_AC3_AUDIO); +#define KSDATAFORMAT_SPECIFIER_AC3_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_AC3_AUDIO) + +#define STATIC_KSPROPSETID_AC3\ + 0xBFABE720L, 0x6E1F, 0x11D0, 0xBC, 0xF2, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00 +DEFINE_GUIDSTRUCT("BFABE720-6E1F-11D0-BCF2-444553540000", KSPROPSETID_AC3); +#define KSPROPSETID_AC3 DEFINE_GUIDNAMED(KSPROPSETID_AC3) + +typedef enum { + KSPROPERTY_AC3_ERROR_CONCEALMENT = 1, + KSPROPERTY_AC3_ALTERNATE_AUDIO, + KSPROPERTY_AC3_DOWNMIX, + KSPROPERTY_AC3_BIT_STREAM_MODE, + KSPROPERTY_AC3_DIALOGUE_LEVEL, + KSPROPERTY_AC3_LANGUAGE_CODE, + KSPROPERTY_AC3_ROOM_TYPE +} KSPROPERTY_AC3; + +typedef struct { + BOOL fRepeatPreviousBlock; + BOOL fErrorInCurrentBlock; +} KSAC3_ERROR_CONCEALMENT, *PKSAC3_ERROR_CONCEALMENT; + +typedef struct { + BOOL fStereo; + ULONG DualMode; +} KSAC3_ALTERNATE_AUDIO, *PKSAC3_ALTERNATE_AUDIO; + +#define KSAC3_ALTERNATE_AUDIO_1 1 +#define KSAC3_ALTERNATE_AUDIO_2 2 +#define KSAC3_ALTERNATE_AUDIO_BOTH 3 + +typedef struct { + BOOL fDownMix; + BOOL fDolbySurround; +} KSAC3_DOWNMIX, *PKSAC3_DOWNMIX; + +typedef struct { + LONG BitStreamMode; +} KSAC3_BIT_STREAM_MODE, *PKSAC3_BIT_STREAM_MODE; + +#define KSAC3_SERVICE_MAIN_AUDIO 0 +#define KSAC3_SERVICE_NO_DIALOG 1 +#define KSAC3_SERVICE_VISUALLY_IMPAIRED 2 +#define KSAC3_SERVICE_HEARING_IMPAIRED 3 +#define KSAC3_SERVICE_DIALOG_ONLY 4 +#define KSAC3_SERVICE_COMMENTARY 5 +#define KSAC3_SERVICE_EMERGENCY_FLASH 6 +#define KSAC3_SERVICE_VOICE_OVER 7 + +typedef struct { + ULONG DialogueLevel; +} KSAC3_DIALOGUE_LEVEL, *PKSAC3_DIALOGUE_LEVEL; + +typedef struct { + BOOL fLargeRoom; +} KSAC3_ROOM_TYPE, *PKSAC3_ROOM_TYPE; + +// New formats enabled by CEA 861 specifciation +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_DOLBY_AC3_SPDIF) +DEFINE_GUIDSTRUCT("00000092-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_WMA_PRO\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_WMASPDIF) +DEFINE_GUIDSTRUCT("00000164-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_WMA_PRO); +#define KSDATAFORMAT_SUBTYPE_IEC61937_WMA_PRO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_WMA_PRO) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DTS\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_DTS) +DEFINE_GUIDSTRUCT("00000008-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DTS); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DTS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DTS) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEG1 \ + 0x00000003L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000003-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEG1); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEG1 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEG1) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEG2 \ + 0x00000004L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000004-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEG2); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEG2 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEG2) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEG3 \ + 0x00000005L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000005-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEG3); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEG3 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEG3) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_AAC \ + 0x00000006L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000006-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_AAC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_AAC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_AAC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_ATRAC \ + 0x00000008L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000008-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_ATRAC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_ATRAC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_ATRAC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_ONE_BIT_AUDIO \ + 0x00000009L, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000009-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_ONE_BIT_AUDIO); +#define KSDATAFORMAT_SUBTYPE_IEC61937_ONE_BIT_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_ONE_BIT_AUDIO) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS \ + 0x0000000aL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000000a-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS_ATMOS \ + 0x0000010aL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000010a-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS_ATMOS); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS_ATMOS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_DIGITAL_PLUS_ATMOS) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DTS_HD \ + 0x0000000bL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000000b-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DTS_HD); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DTS_HD DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DTS_HD) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E1 \ + 0x0000010bL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000010b-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E1); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E1 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E1) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E2 \ + 0x0000030bL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000030b-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E2); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E2 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DTSX_E2) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MLP \ + 0x0000000cL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000000c-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MLP); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MLP DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MLP) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT20 \ + 0x0000010cL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000010c-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT20); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT20 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT20) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21 \ + 0x0000030cL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000030c-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21_PROFILE4 \ + 0x0000070cL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000070c-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21_PROFILE4); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21_PROFILE4 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DOLBY_MAT21_PROFILE4) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_DST \ + 0x0000000dL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("0000000d-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_DST); +#define KSDATAFORMAT_SUBTYPE_IEC61937_DST DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_DST) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_LC \ + 0x000110bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000110bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_LC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_LC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_LC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_LC \ + 0x000120bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000120bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_LC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_LC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_LC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_LC \ + 0x000130bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000130bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_LC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_LC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_LC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_LC \ + 0x000140bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000140bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_LC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_LC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_LC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_LC \ + 0x000150bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000150bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_LC); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_LC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_LC) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_BL \ + 0x000210bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000210bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_BL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_BL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL1_BL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_BL \ + 0x000220bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000220bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_BL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_BL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL2_BL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_BL \ + 0x000230bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000230bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_BL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_BL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL3_BL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_BL \ + 0x000240bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000240bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_BL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_BL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL4_BL) + +#define STATIC_KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_BL \ + 0x000250bfL, 0x0cea, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("000250bf-0cea-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_BL); +#define KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_BL DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEC61937_MPEGH_LEVEL5_BL) + +//MP3 +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEGLAYER3 \ +DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_MPEGLAYER3) +DEFINE_GUIDSTRUCT("00000055-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MPEGLAYER3); +#define KSDATAFORMAT_SUBTYPE_MPEGLAYER3 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEGLAYER3) + +// AAC +#define STATIC_KSDATAFORMAT_SUBTYPE_MPEG_HEAAC \ +DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_MPEG_HEAAC) +DEFINE_GUIDSTRUCT("00001610-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MPEG_HEAAC); +#define KSDATAFORMAT_SUBTYPE_MPEG_HEAAC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MPEG_HEAAC) + +//WMA STD +#define STATIC_KSDATAFORMAT_SUBTYPE_WMAUDIO2 \ +DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_WMAUDIO2) +DEFINE_GUIDSTRUCT("00000161-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_WMAUDIO2); +#define KSDATAFORMAT_SUBTYPE_WMAUDIO2 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_WMAUDIO2) + +//WMA PRO +#define STATIC_KSDATAFORMAT_SUBTYPE_WMAUDIO3 \ +DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_WMAUDIO3) +DEFINE_GUIDSTRUCT("00000162-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_WMAUDIO3); +#define KSDATAFORMAT_SUBTYPE_WMAUDIO3 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_WMAUDIO3) + +//WMA LOSSLESS +#define STATIC_KSDATAFORMAT_SUBTYPE_WMAUDIO_LOSSLESS \ +DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_WMAUDIO_LOSSLESS) +DEFINE_GUIDSTRUCT("00000163-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_WMAUDIO_LOSSLESS); +#define KSDATAFORMAT_SUBTYPE_WMAUDIO_LOSSLESS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_WMAUDIO_LOSSLESS) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// +// DTS and SDDS definitions (media subtype GUIDs) +// +#define STATIC_KSDATAFORMAT_SUBTYPE_DTS_AUDIO\ + 0xe06d8033L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8033-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_DTS_AUDIO); +#define KSDATAFORMAT_SUBTYPE_DTS_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_DTS_AUDIO) + +#define STATIC_KSDATAFORMAT_SUBTYPE_SDDS_AUDIO\ + 0xe06d8034L, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d8034-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_SDDS_AUDIO); +#define KSDATAFORMAT_SUBTYPE_SDDS_AUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_SDDS_AUDIO) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// +// audio decoder output properties +// + +#define STATIC_KSPROPSETID_AudioDecoderOut\ + 0x6ca6e020L, 0x43bd, 0x11d0, 0xbd, 0x6a, 0x00, 0x35, 0x05, 0xc1, 0x03, 0xa9 +DEFINE_GUIDSTRUCT("6ca6e020-43bd-11d0-bd6a-003505c103a9", KSPROPSETID_AudioDecoderOut); +#define KSPROPSETID_AudioDecoderOut DEFINE_GUIDNAMED(KSPROPSETID_AudioDecoderOut) + +typedef enum { + KSPROPERTY_AUDDECOUT_MODES, // available output modes of decoder + KSPROPERTY_AUDDECOUT_CUR_MODE, // current mode of the decoder +} KSPROPERTY_AUDDECOUT; + +#define KSAUDDECOUTMODE_STEREO_ANALOG 0x0001 +#define KSAUDDECOUTMODE_PCM_51 0x0002 +#define KSAUDDECOUTMODE_SPDIFF 0x0004 + + + +// +// subpicture definition +// + +#define STATIC_KSDATAFORMAT_SUBTYPE_SUBPICTURE\ + 0xe06d802dL, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea +DEFINE_GUIDSTRUCT("e06d802d-db46-11cf-b4d1-00805f6cbbea", KSDATAFORMAT_SUBTYPE_SUBPICTURE); +#define KSDATAFORMAT_SUBTYPE_SUBPICTURE DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_SUBPICTURE) + + +#define STATIC_KSPROPSETID_DvdSubPic\ + 0xac390460L, 0x43af, 0x11d0, 0xbd, 0x6a, 0x00, 0x35, 0x05, 0xc1, 0x03, 0xa9 +DEFINE_GUIDSTRUCT("ac390460-43af-11d0-bd6a-003505c103a9", KSPROPSETID_DvdSubPic); +#define KSPROPSETID_DvdSubPic DEFINE_GUIDNAMED(KSPROPSETID_DvdSubPic) + +typedef enum { + KSPROPERTY_DVDSUBPIC_PALETTE, + KSPROPERTY_DVDSUBPIC_HLI, + KSPROPERTY_DVDSUBPIC_COMPOSIT_ON, // TRUE for subpicture is displayed +} KSPROPERTY_DVDSUBPIC; + +typedef struct _KS_DVD_YCrCb { + UCHAR Reserved; + UCHAR Y; + UCHAR Cr; + UCHAR Cb; +} KS_DVD_YCrCb, *PKS_DVD_YCrCb; + +/* The KS_DVD_YUV structure is now superseded by KS_DVD_YCrCb above and is + here for backward compatibility only */ + +typedef struct _KS_DVD_YUV { + UCHAR Reserved; + UCHAR Y; + UCHAR V; + UCHAR U; +} KS_DVD_YUV, *PKS_DVD_YUV; + +typedef struct _KSPROPERTY_SPPAL { + KS_DVD_YUV sppal[16]; +} KSPROPERTY_SPPAL, *PKSPROPERTY_SPPAL; + +typedef struct _KS_COLCON { + UCHAR emph1col:4; + UCHAR emph2col:4; + UCHAR backcol:4; + UCHAR patcol:4; + UCHAR emph1con:4; + UCHAR emph2con:4; + UCHAR backcon:4; + UCHAR patcon:4; + +} KS_COLCON, *PKS_COLCON; + +typedef struct _KSPROPERTY_SPHLI { + USHORT HLISS; + USHORT Reserved; + ULONG StartPTM; // start presentation time in x/90000 + ULONG EndPTM; // end PTM in x/90000 + USHORT StartX; + USHORT StartY; + USHORT StopX; + USHORT StopY; + KS_COLCON ColCon; // color contrast description (4 bytes as given in HLI) +} KSPROPERTY_SPHLI, *PKSPROPERTY_SPHLI; + +typedef BOOL KSPROPERTY_COMPOSIT_ON, *PKSPROPERTY_COMPOSIT_ON; + +#define STATIC_KSPROPSETID_CopyProt \ + 0x0E8A0A40L, 0x6AEF, 0x11D0, 0x9E, 0xD0, 0x00, 0xA0, 0x24, 0xCA, 0x19, 0xB3 +DEFINE_GUIDSTRUCT("0E8A0A40-6AEF-11D0-9ED0-00A024CA19B3", KSPROPSETID_CopyProt); +#define KSPROPSETID_CopyProt DEFINE_GUIDNAMED(KSPROPSETID_CopyProt) + +typedef enum { + + KSPROPERTY_DVDCOPY_CHLG_KEY = 0x01, + KSPROPERTY_DVDCOPY_DVD_KEY1, + KSPROPERTY_DVDCOPY_DEC_KEY2, + KSPROPERTY_DVDCOPY_TITLE_KEY, + KSPROPERTY_COPY_MACROVISION, + KSPROPERTY_DVDCOPY_REGION, + KSPROPERTY_DVDCOPY_SET_COPY_STATE, + KSPROPERTY_DVDCOPY_DISC_KEY = 0x80 + +} KSPROPERTY_COPYPROT; + +typedef struct _KS_DVDCOPY_CHLGKEY { + BYTE ChlgKey[10]; + BYTE Reserved[2]; +} KS_DVDCOPY_CHLGKEY, *PKS_DVDCOPY_CHLGKEY; + +typedef struct _KS_DVDCOPY_BUSKEY { + BYTE BusKey[5]; + BYTE Reserved[1]; +} KS_DVDCOPY_BUSKEY, *PKS_DVDCOPY_BUSKEY; + + +typedef struct _KS_DVDCOPY_DISCKEY { + BYTE DiscKey[2048]; +} KS_DVDCOPY_DISCKEY, *PKS_DVDCOPY_DISCKEY; + +typedef struct _KS_DVDCOPY_REGION { + UCHAR Reserved; + UCHAR RegionData; + UCHAR Reserved2[2]; +} KS_DVDCOPY_REGION, *PKS_DVDCOPY_REGION; + +typedef struct _KS_DVDCOPY_TITLEKEY { + ULONG KeyFlags; + ULONG ReservedNT[2]; + UCHAR TitleKey[6]; + UCHAR Reserved[2]; +} KS_DVDCOPY_TITLEKEY, *PKS_DVDCOPY_TITLEKEY; + +typedef struct _KS_COPY_MACROVISION { + ULONG MACROVISIONLevel; +} KS_COPY_MACROVISION, *PKS_COPY_MACROVISION; + +typedef struct _KS_DVDCOPY_SET_COPY_STATE { + ULONG DVDCopyState; +} KS_DVDCOPY_SET_COPY_STATE, *PKS_DVDCOPY_SET_COPY_STATE; + +typedef enum { + KS_DVDCOPYSTATE_INITIALIZE, // indicates we are starting a full + // copy protection sequence. + KS_DVDCOPYSTATE_INITIALIZE_TITLE, // indicates we are starting a title + // key copy protection sequence + KS_DVDCOPYSTATE_AUTHENTICATION_NOT_REQUIRED, + KS_DVDCOPYSTATE_AUTHENTICATION_REQUIRED, + KS_DVDCOPYSTATE_DONE, +} KS_DVDCOPYSTATE; + +typedef enum { + KS_MACROVISION_DISABLED, + KS_MACROVISION_LEVEL1, + KS_MACROVISION_LEVEL2, + KS_MACROVISION_LEVEL3 +} KS_COPY_MACROVISION_LEVEL, *PKS_COPY_MACROVISION_LEVEL; + +// +// CGMS Copy Protection Flags +// + +#define KS_DVD_CGMS_RESERVED_MASK 0x00000078 + +#define KS_DVD_CGMS_COPY_PROTECT_MASK 0x00000018 +#define KS_DVD_CGMS_COPY_PERMITTED 0x00000000 +#define KS_DVD_CGMS_COPY_ONCE 0x00000010 +#define KS_DVD_CGMS_NO_COPY 0x00000018 + +#define KS_DVD_COPYRIGHT_MASK 0x00000040 +#define KS_DVD_NOT_COPYRIGHTED 0x00000000 +#define KS_DVD_COPYRIGHTED 0x00000040 + +#define KS_DVD_SECTOR_PROTECT_MASK 0x00000020 +#define KS_DVD_SECTOR_NOT_PROTECTED 0x00000000 +#define KS_DVD_SECTOR_PROTECTED 0x00000020 + + +//=========================================================================== +// The following MUST match the structures in WinGDI.h and AMVideo.h +//=========================================================================== + +#define STATIC_KSCATEGORY_TVTUNER \ + 0xa799a800L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4 +DEFINE_GUIDSTRUCT("a799a800-a46d-11d0-a18c-00a02401dcd4", KSCATEGORY_TVTUNER); +#define KSCATEGORY_TVTUNER DEFINE_GUIDNAMED(KSCATEGORY_TVTUNER) + +#define STATIC_KSCATEGORY_CROSSBAR \ + 0xa799a801L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4 +DEFINE_GUIDSTRUCT("a799a801-a46d-11d0-a18c-00a02401dcd4", KSCATEGORY_CROSSBAR); +#define KSCATEGORY_CROSSBAR DEFINE_GUIDNAMED(KSCATEGORY_CROSSBAR) + +#define STATIC_KSCATEGORY_TVAUDIO \ + 0xa799a802L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4 +DEFINE_GUIDSTRUCT("a799a802-a46d-11d0-a18c-00a02401dcd4", KSCATEGORY_TVAUDIO); +#define KSCATEGORY_TVAUDIO DEFINE_GUIDNAMED(KSCATEGORY_TVAUDIO) + +#define STATIC_KSCATEGORY_VPMUX \ + 0xa799a803L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4 +DEFINE_GUIDSTRUCT("a799a803-a46d-11d0-a18c-00a02401dcd4", KSCATEGORY_VPMUX); +#define KSCATEGORY_VPMUX DEFINE_GUIDNAMED(KSCATEGORY_VPMUX) + +#define STATIC_KSCATEGORY_VBICODEC \ + 0x07dad660L, 0x22f1, 0x11d1, 0xa9, 0xf4, 0x00, 0xc0, 0x4f, 0xbb, 0xde, 0x8f +DEFINE_GUIDSTRUCT("07dad660-22f1-11d1-a9f4-00c04fbbde8f", KSCATEGORY_VBICODEC); +#define KSCATEGORY_VBICODEC DEFINE_GUIDNAMED(KSCATEGORY_VBICODEC) + +// SUBTYPE_VPVideo +#define STATIC_KSDATAFORMAT_SUBTYPE_VPVideo\ + 0x5a9b6a40L, 0x1a22, 0x11d1, 0xba, 0xd9, 0x0, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("5a9b6a40-1a22-11d1-bad9-00609744111a", KSDATAFORMAT_SUBTYPE_VPVideo); +#define KSDATAFORMAT_SUBTYPE_VPVideo DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_VPVideo) + +// SUBTYPE_VPVBI +#define STATIC_KSDATAFORMAT_SUBTYPE_VPVBI\ + 0x5a9b6a41L, 0x1a22, 0x11d1, 0xba, 0xd9, 0x0, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("5a9b6a41-1a22-11d1-bad9-00609744111a", KSDATAFORMAT_SUBTYPE_VPVBI); +#define KSDATAFORMAT_SUBTYPE_VPVBI DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_VPVBI) + + +// FORMAT_VideoInfo +#define STATIC_KSDATAFORMAT_SPECIFIER_VIDEOINFO\ + 0x05589f80L, 0xc356, 0x11ce, 0xbf, 0x01, 0x00, 0xaa, 0x00, 0x55, 0x59, 0x5a +DEFINE_GUIDSTRUCT("05589f80-c356-11ce-bf01-00aa0055595a", KSDATAFORMAT_SPECIFIER_VIDEOINFO); +#define KSDATAFORMAT_SPECIFIER_VIDEOINFO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_VIDEOINFO) + +// FORMAT_VideoInfo2 +#define STATIC_KSDATAFORMAT_SPECIFIER_VIDEOINFO2\ + 0xf72a76A0L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x00, 0x00, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("f72a76A0-eb0a-11d0-ace4-0000c0cc16ba", KSDATAFORMAT_SPECIFIER_VIDEOINFO2); +#define KSDATAFORMAT_SPECIFIER_VIDEOINFO2 DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_VIDEOINFO2) + +// FORMAT_UVCH264Video +#define STATIC_KSDATAFORMAT_SPECIFIER_H264_VIDEO\ + 0x2017be05L, 0x6629, 0x4248, 0xaa, 0xed, 0x7e, 0x1a, 0x47, 0xbc, 0x9b, 0x9c +DEFINE_GUIDSTRUCT("2017be05-6629-4248-aaed-7e1a47bc9b9c", KSDATAFORMAT_SPECIFIER_H264_VIDEO); +#define KSDATAFORMAT_SPECIFIER_H264_VIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_H264_VIDEO) + +// FORMAT_JPEGImage +#define STATIC_KSDATAFORMAT_SPECIFIER_JPEG_IMAGE\ + 0x692fa379, 0xd3e8, 0x4651, 0xb5, 0xb4, 0xb, 0x94, 0xb0, 0x13, 0xee, 0xaf +DEFINE_GUIDSTRUCT("692fa379-d3e8-4651-b5b4-0b94b013eeaf", KSDATAFORMAT_SPECIFIER_JPEG_IMAGE); +#define KSDATAFORMAT_SPECIFIER_JPEG_IMAGE DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_JPEG_IMAGE) + +// FORMAT_Image +#define STATIC_KSDATAFORMAT_SPECIFIER_IMAGE\ + 0x692fa379, 0xd3e8, 0x4651, 0xb5, 0xb4, 0xb, 0x94, 0xb0, 0x13, 0xee, 0xaf +DEFINE_GUIDSTRUCT("692fa379-d3e8-4651-b5b4-0b94b013eeaf", KSDATAFORMAT_SPECIFIER_IMAGE); +#define KSDATAFORMAT_SPECIFIER_IMAGE DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_IMAGE) + +// MEDIATYPE_Image: same as MFMEDIATYPE_Image +#define STATIC_KSDATAFORMAT_TYPE_IMAGE\ + 0x72178c23, 0xe45b, 0x11d5, 0xbc, 0x2a, 0x00, 0xb0, 0xd0, 0xf3, 0xf4, 0xab +DEFINE_GUIDSTRUCT("72178c23-e45b-11d5-bc2a-00b0d0f3f4ab", KSDATAFORMAT_TYPE_IMAGE); +#define KSDATAFORMAT_TYPE_IMAGE DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_IMAGE) + +// SUBTYPE_JPEG: same as WIC container format JPEG +#define STATIC_KSDATAFORMAT_SUBTYPE_JPEG\ + 0x19e4a5aa, 0x5662, 0x4fc5, 0xa0, 0xc0, 0x17, 0x58, 0x2, 0x8e, 0x10, 0x57 +DEFINE_GUIDSTRUCT("19e4a5aa-5662-4fc5-a0c0-1758028e1057", KSDATAFORMAT_SUBTYPE_JPEG); +#define KSDATAFORMAT_SUBTYPE_JPEG DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_JPEG) + +// SUBTYPE_IMAGE_RGB32: same as MFVideoFormat_RGB32 +#define STATIC_KSDATAFORMAT_SUBTYPE_IMAGE_RGB32\ + 0x00000016, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000016-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IMAGE_RGB32); +#define KSDATAFORMAT_SUBTYPE_IMAGE_RGB32 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IMAGE_RGB32) + +#if (NTDDI_VERSION >= NTDDI_WIN10) + +// KSDATAFORMAT_SUBTYPE_L8: +#define STATIC_KSDATAFORMAT_SUBTYPE_L8\ + 0x00000032, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000032-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L8); +#define KSDATAFORMAT_SUBTYPE_L8 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L8) + +// KSDATAFORMAT_SUBTYPE_L8_IR: +#define STATIC_KSDATAFORMAT_SUBTYPE_L8_IR\ + 0x00000032, 0x0002, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000032-0002-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L8_IR); +#define KSDATAFORMAT_SUBTYPE_L8_IR DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L8_IR) + +// KSDATAFORMAT_SUBTYPE_L8_CUSTOM: +#define STATIC_KSDATAFORMAT_SUBTYPE_L8_CUSTOM\ + 0x00000032, 0x8000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000032-8000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L8_CUSTOM); +#define KSDATAFORMAT_SUBTYPE_L8_CUSTOM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L8_CUSTOM) + +// KSDATAFORMAT_SUBTYPE_L16: +#define STATIC_KSDATAFORMAT_SUBTYPE_L16\ + 0x00000051, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000051-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L16); +#define KSDATAFORMAT_SUBTYPE_L16 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L16) + +// KSDATAFORMAT_SUBTYPE_L16_IR: +#define STATIC_KSDATAFORMAT_SUBTYPE_L16_IR\ + 0x00000051, 0x0002, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000051-0002-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L16_IR); +#define KSDATAFORMAT_SUBTYPE_L16_IR DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L16_IR) + +// KSDATAFORMAT_SUBTYPE_D16: +#define STATIC_KSDATAFORMAT_SUBTYPE_D16\ + 0x00000050, 0x0004, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000050-0004-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_D16); +#define KSDATAFORMAT_SUBTYPE_D16 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_D16) + +// KSDATAFORMAT_SUBTYPE_L16_CUSTOM: +#define STATIC_KSDATAFORMAT_SUBTYPE_L16_CUSTOM\ + 0x00000051, 0x8000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000051-8000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_L16_CUSTOM); +#define KSDATAFORMAT_SUBTYPE_L16_CUSTOM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_L16_CUSTOM) + +// KSDATAFORMAT_SUBTYPE_MJPG_IR: +#define STATIC_KSDATAFORMAT_SUBTYPE_MJPG_IR\ + 0x47504a4d, 0x0002, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("47504a4d-0002-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MJPG_IR); +#define KSDATAFORMAT_SUBTYPE_MJPG_IR DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MJPG_IR) + +// KSDATAFORMAT_SUBTYPE_MJPG_DEPTH: +#define STATIC_KSDATAFORMAT_SUBTYPE_MJPG_DEPTH\ + 0x47504a4d, 0x0004, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("47504a4d-0004-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MJPG_DEPTH); +#define KSDATAFORMAT_SUBTYPE_MJPG_DEPTH DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MJPG_DEPTH) + +// KSDATAFORMAT_SUBTYPE_MJPG_CUSTOM: +#define STATIC_KSDATAFORMAT_SUBTYPE_MJPG_CUSTOM\ + 0x47504a4d, 0x8000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("47504a4d-8000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_MJPG_CUSTOM); +#define KSDATAFORMAT_SUBTYPE_MJPG_CUSTOM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_MJPG_CUSTOM) + + +#endif //(NTDDI_VERSION >= NTDDI_WIN10) + +// MEDIATYPE_AnalogVideo +#define STATIC_KSDATAFORMAT_TYPE_ANALOGVIDEO\ + 0x0482dde1L, 0x7817, 0x11cf, 0x8a, 0x03, 0x00, 0xaa, 0x00, 0x6e, 0xcb, 0x65 +DEFINE_GUIDSTRUCT("0482dde1-7817-11cf-8a03-00aa006ecb65", KSDATAFORMAT_TYPE_ANALOGVIDEO); +#define KSDATAFORMAT_TYPE_ANALOGVIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_ANALOGVIDEO) + +// FORMAT_AnalogVideo +#define STATIC_KSDATAFORMAT_SPECIFIER_ANALOGVIDEO\ + 0x0482dde0L, 0x7817, 0x11cf, 0x8a, 0x03, 0x00, 0xaa, 0x00, 0x6e, 0xcb, 0x65 +DEFINE_GUIDSTRUCT("0482dde0-7817-11cf-8a03-00aa006ecb65", KSDATAFORMAT_SPECIFIER_ANALOGVIDEO); +#define KSDATAFORMAT_SPECIFIER_ANALOGVIDEO DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_ANALOGVIDEO) + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +// MEDIATYPE_AnalogAudio +#define STATIC_KSDATAFORMAT_TYPE_ANALOGAUDIO \ + 0x0482dee1L, 0x7817, 0x11cf, 0x8a, 0x03, 0x00, 0xaa, 0x00, 0x6e, 0xcb, 0x65 +DEFINE_GUIDSTRUCT("0482DEE1-7817-11cf-8a03-00aa006ecb65", KSDATAFORMAT_TYPE_ANALOGAUDIO); +#define KSDATAFORMAT_TYPE_ANALOGAUDIO DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_ANALOGAUDIO) + +#endif // XP SP2 and later (chronologically) + +// FORMAT_VBI +#define STATIC_KSDATAFORMAT_SPECIFIER_VBI\ + 0xf72a76e0L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x00, 0x00, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("f72a76e0-eb0a-11d0-ace4-0000c0cc16ba", KSDATAFORMAT_SPECIFIER_VBI); +#define KSDATAFORMAT_SPECIFIER_VBI DEFINE_GUIDNAMED(KSDATAFORMAT_SPECIFIER_VBI) + +// MEDIATYPE_VBI +#define STATIC_KSDATAFORMAT_TYPE_VBI\ + 0xf72a76e1L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x00, 0x00, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("f72a76e1-eb0a-11d0-ace4-0000c0cc16ba", KSDATAFORMAT_TYPE_VBI); +#define KSDATAFORMAT_TYPE_VBI DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_VBI) + +// SUBTYPE_RAW8 +#define STATIC_KSDATAFORMAT_SUBTYPE_RAW8\ + 0xca20d9a0, 0x3e3e, 0x11d1, 0x9b, 0xf9, 0x0, 0xc0, 0x4f, 0xbb, 0xde, 0xbf +DEFINE_GUIDSTRUCT("ca20d9a0-3e3e-11d1-9bf9-00c04fbbdebf", KSDATAFORMAT_SUBTYPE_RAW8); +#define KSDATAFORMAT_SUBTYPE_RAW8 DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_RAW8) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// MEDIASUBTYPE_CC +#define STATIC_KSDATAFORMAT_SUBTYPE_CC\ + 0x33214cc1, 0x11f, 0x11d2, 0xb4, 0xb1, 0x0, 0xa0, 0xd1, 0x2, 0xcf, 0xbe +DEFINE_GUIDSTRUCT("33214CC1-011F-11D2-B4B1-00A0D102CFBE", KSDATAFORMAT_SUBTYPE_CC); +#define KSDATAFORMAT_SUBTYPE_CC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_CC) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// MEDIASUBTYPE_NABTS +#define STATIC_KSDATAFORMAT_SUBTYPE_NABTS\ + 0xf72a76e2L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x00, 0x00, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("f72a76e2-eb0a-11d0-ace4-0000c0cc16ba", KSDATAFORMAT_SUBTYPE_NABTS); +#define KSDATAFORMAT_SUBTYPE_NABTS DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_NABTS) + +// MEDIASUBTYPE_TELETEXT +#define STATIC_KSDATAFORMAT_SUBTYPE_TELETEXT\ + 0xf72a76e3L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x00, 0x00, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("f72a76e3-eb0a-11d0-ace4-0000c0cc16ba", KSDATAFORMAT_SUBTYPE_TELETEXT); +#define KSDATAFORMAT_SUBTYPE_TELETEXT DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_TELETEXT) + + + +/* constants for the biCompression field */ +#define KS_BI_RGB 0L +#define KS_BI_RLE8 1L +#define KS_BI_RLE4 2L +#define KS_BI_BITFIELDS 3L +#define KS_BI_JPEG 4L + +typedef struct tagKS_RGBQUAD { // rgbq + BYTE rgbBlue; + BYTE rgbGreen; + BYTE rgbRed; + BYTE rgbReserved; +} KS_RGBQUAD, *PKS_RGBQUAD; + +/* constants for palettes */ +#define KS_iPALETTE_COLORS 256 // Maximum colours in palette +#define KS_iEGA_COLORS 16 // Number colours in EGA palette +#define KS_iMASK_COLORS 3 // Maximum three components +#define KS_iTRUECOLOR 16 // Minimum true colour device +#define KS_iRED 0 // Index position for RED mask +#define KS_iGREEN 1 // Index position for GREEN mask +#define KS_iBLUE 2 // Index position for BLUE mask +#define KS_iPALETTE 8 // Maximum colour depth using a palette +#define KS_iMAXBITS 8 // Maximum bits per colour component +#define KS_SIZE_EGA_PALETTE (KS_iEGA_COLORS * sizeof(KS_RGBQUAD)) +#define KS_SIZE_PALETTE (KS_iPALETTE_COLORS * sizeof(KS_RGBQUAD)) + +typedef struct tagKS_BITMAPINFOHEADER{ + DWORD biSize; + LONG biWidth; + LONG biHeight; + WORD biPlanes; + WORD biBitCount; + DWORD biCompression; + DWORD biSizeImage; + LONG biXPelsPerMeter; + LONG biYPelsPerMeter; + DWORD biClrUsed; + DWORD biClrImportant; +} KS_BITMAPINFOHEADER, *PKS_BITMAPINFOHEADER; + +// Used for true colour images that also have a palette + +typedef struct tag_KS_TRUECOLORINFO { + DWORD dwBitMasks[KS_iMASK_COLORS]; + KS_RGBQUAD bmiColors[KS_iPALETTE_COLORS]; +} KS_TRUECOLORINFO, *PKS_TRUECOLORINFO; + + +#define KS_WIDTHBYTES(bits) ((DWORD)(((bits)+31) & (~31)) / 8) +#define KS_DIBWIDTHBYTES(bi) (DWORD)KS_WIDTHBYTES((DWORD)(bi).biWidth * (DWORD)(bi).biBitCount) +#define KS__DIBSIZE(bi) (KS_DIBWIDTHBYTES(bi) * (DWORD)(bi).biHeight) +#define KS_DIBSIZE(bi) ((bi).biHeight < 0 ? (-1)*(KS__DIBSIZE(bi)) : KS__DIBSIZE(bi)) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application and Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +typedef LONGLONG REFERENCE_TIME; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// The BITMAPINFOHEADER contains all the details about the video stream such +// as the actual image dimensions and their pixel depth. A source filter may +// also request that the sink take only a section of the video by providing a +// clipping rectangle in rcSource. In the worst case where the sink filter +// forgets to check this on connection it will simply render the whole thing +// which isn't a disaster. Ideally a sink filter will check the rcSource and +// if it doesn't support image extraction and the rectangle is not empty then +// it will reject the connection. A filter should use SetRectEmpty to reset a +// rectangle to all zeroes (and IsRectEmpty to later check the rectangle). +// The rcTarget specifies the destination rectangle for the video, for most +// source filters they will set this to all zeroes, a downstream filter may +// request that the video be placed in a particular area of the buffers it +// supplies in which case it will call QueryAccept with a non empty target + +typedef struct tagKS_VIDEOINFOHEADER { + + RECT rcSource; // The bit we really want to use + RECT rcTarget; // Where the video should go + DWORD dwBitRate; // Approximate bit data rate + DWORD dwBitErrorRate; // Bit error rate for this stream + REFERENCE_TIME AvgTimePerFrame; // Average time per frame (100ns units) + + KS_BITMAPINFOHEADER bmiHeader; + +} KS_VIDEOINFOHEADER, *PKS_VIDEOINFOHEADER; + +// !!! WARNING !!! +// DO NOT use the following structure unless you are sure that the BITMAPINFOHEADER +// has a normal biSize == sizeof(BITMAPINFOHEADER) ! +// !!! WARNING !!! + +typedef struct tagKS_VIDEOINFO { + + RECT rcSource; // The bit we really want to use + RECT rcTarget; // Where the video should go + DWORD dwBitRate; // Approximate bit data rate + DWORD dwBitErrorRate; // Bit error rate for this stream + REFERENCE_TIME AvgTimePerFrame; // Average time per frame (100ns units) + + KS_BITMAPINFOHEADER bmiHeader; + + union { + KS_RGBQUAD bmiColors[KS_iPALETTE_COLORS]; // Colour palette + DWORD dwBitMasks[KS_iMASK_COLORS]; // True colour masks + KS_TRUECOLORINFO TrueColorInfo; // Both of the above + }; + +} KS_VIDEOINFO, *PKS_VIDEOINFO; + + +#define KS_SIZE_MASKS (KS_iMASK_COLORS * sizeof(DWORD)) +#define KS_SIZE_PREHEADER (FIELD_OFFSET(KS_VIDEOINFOHEADER,bmiHeader)) + +// For normal size +// #define KS_SIZE_VIDEOHEADER (sizeof(KS_BITMAPINFOHEADER) + KS_SIZE_PREHEADER) +// !!! for abnormal biSizes +#define KS_SIZE_VIDEOHEADER(pbmi) ((pbmi)->bmiHeader.biSize + KS_SIZE_PREHEADER) + +// VBI +// Used for NABTS, CC, Intercast, WST +typedef struct tagKS_VBIINFOHEADER { + ULONG StartLine; // inclusive + ULONG EndLine; // inclusive + ULONG SamplingFrequency; // Hz. + ULONG MinLineStartTime; // microSec * 100 from HSync LE + ULONG MaxLineStartTime; // microSec * 100 from HSync LE + ULONG ActualLineStartTime; // microSec * 100 from HSync LE + ULONG ActualLineEndTime; // microSec * 100 from HSync LE + ULONG VideoStandard; // KS_AnalogVideoStandard* + ULONG SamplesPerLine; + ULONG StrideInBytes; // May be > SamplesPerLine + ULONG BufferSize; // Bytes +} KS_VBIINFOHEADER, *PKS_VBIINFOHEADER; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// VBI Sampling Rates +#define KS_VBIDATARATE_NABTS (5727272L) +#define KS_VBIDATARATE_CC ( 503493L) // ~= 1/1.986125e-6 +#define KS_VBISAMPLINGRATE_4X_NABTS ((long)(4*KS_VBIDATARATE_NABTS)) +#define KS_VBISAMPLINGRATE_47X_NABTS ((long)(27000000)) +#define KS_VBISAMPLINGRATE_5X_NABTS ((long)(5*KS_VBIDATARATE_NABTS)) + +#define KS_47NABTS_SCALER (KS_VBISAMPLINGRATE_47X_NABTS/(double)KS_VBIDATARATE_NABTS) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// Analog video variant - Use this when the format is FORMAT_AnalogVideo +// +// rcSource defines the portion of the active video signal to use +// rcTarget defines the destination rectangle +// both of the above are relative to the dwActiveWidth and dwActiveHeight fields +// dwActiveWidth is currently set to 720 for all formats (but could change for HDTV) +// dwActiveHeight is 483 for NTSC and 575 for PAL/SECAM (but could change for HDTV) + +typedef struct tagKS_AnalogVideoInfo { + RECT rcSource; // Width max is 720, height varies w/ TransmissionStd + RECT rcTarget; // Where the video should go + DWORD dwActiveWidth; // Always 720 (CCIR-601 active samples per line) + DWORD dwActiveHeight; // 483 for NTSC, 575 for PAL/SECAM + REFERENCE_TIME AvgTimePerFrame; // Normal ActiveMovie units (100 nS) +} KS_ANALOGVIDEOINFO, *PKS_ANALOGVIDEOINFO; + +//=========================================================================== +// Data packet passed on Analog video stream channel change +//=========================================================================== + +#define KS_TVTUNER_CHANGE_BEGIN_TUNE 0x0001L // Starting a tuning operation +#define KS_TVTUNER_CHANGE_END_TUNE 0x0002L // Ending a tuning operation + +typedef struct tagKS_TVTUNER_CHANGE_INFO { + DWORD dwFlags; // KS_TVTUNER_CHANGE_* + DWORD dwCountryCode; + DWORD dwAnalogVideoStandard; // KS_AnalogVideoStandard + DWORD dwChannel; +} KS_TVTUNER_CHANGE_INFO, *PKS_TVTUNER_CHANGE_INFO; + +//=========================================================================== +// Video format blocks +//=========================================================================== + +typedef enum { + KS_MPEG2Level_Low, + KS_MPEG2Level_Main, + KS_MPEG2Level_High1440, + KS_MPEG2Level_High +} KS_MPEG2Level; + +typedef enum { + KS_MPEG2Profile_Simple, + KS_MPEG2Profile_Main, + KS_MPEG2Profile_SNRScalable, + KS_MPEG2Profile_SpatiallyScalable, + KS_MPEG2Profile_High +} KS_MPEG2Profile; + +#define KS_INTERLACE_IsInterlaced 0x00000001 // if 0, other interlace bits are irrelevent +#define KS_INTERLACE_1FieldPerSample 0x00000002 // else 2 fields per media sample +#define KS_INTERLACE_Field1First 0x00000004 // else Field 2 is first; top field in PAL is field 1, top field in NTSC is field 2? +#define KS_INTERLACE_UNUSED 0x00000008 // +#define KS_INTERLACE_FieldPatternMask 0x00000030 // use this mask with AMINTERLACE_FieldPat* +#define KS_INTERLACE_FieldPatField1Only 0x00000000 // Data never contains a Field2 +#define KS_INTERLACE_FieldPatField2Only 0x00000010 // Data never contains a Field1 +#define KS_INTERLACE_FieldPatBothRegular 0x00000020 // There will be a Field2 for every Field1 (required for Weave?) +#define KS_INTERLACE_FieldPatBothIrregular 0x00000030 // Random pattern of Field1s and Field2s +#define KS_INTERLACE_DisplayModeMask 0x000000c0 +#define KS_INTERLACE_DisplayModeBobOnly 0x00000000 +#define KS_INTERLACE_DisplayModeWeaveOnly 0x00000040 +#define KS_INTERLACE_DisplayModeBobOrWeave 0x00000080 + +#define KS_COPYPROTECT_RestrictDuplication 0x00000001 // duplication of this stream should be restricted + +#define KS_MPEG2_DoPanScan 0x00000001 //if set, the MPEG-2 video decoder should crop output image + // based on pan-scan vectors in picture_display_extension + // and change the picture aspect ratio accordingly. +#define KS_MPEG2_DVDLine21Field1 0x00000002 //if set, the MPEG-2 decoder must be able to produce an output + // pin for DVD style closed caption data found in GOP layer of field 1 +#define KS_MPEG2_DVDLine21Field2 0x00000004 //if set, the MPEG-2 decoder must be able to produce an output + // pin for DVD style closed caption data found in GOP layer of field 2 +#define KS_MPEG2_SourceIsLetterboxed 0x00000008 //if set, indicates that black bars have been encoded in the top + // and bottom of the video. +#define KS_MPEG2_FilmCameraMode 0x00000010 //if set, indicates "film mode" used for 625/50 content. If cleared, + // indicates that "camera mode" was used. +#define KS_MPEG2_LetterboxAnalogOut 0x00000020 //if set and this stream is sent to an analog output, it should + // be letterboxed. Streams sent to VGA should be letterboxed only by renderers. +#define KS_MPEG2_DSS_UserData 0x00000040 //if set, the MPEG-2 decoder must process DSS style user data +#define KS_MPEG2_DVB_UserData 0x00000080 //if set, the MPEG-2 decoder must process DVB style user data +#define KS_MPEG2_27MhzTimebase 0x00000100 //if set, the PTS,DTS timestamps advance at 27MHz rather than 90KHz + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define KS_MPEG2_WidescreenAnalogOut 0x00000200 //if set and this stream is sent to an analog output, it should + // be in widescreen format (4x3 content should be centered on a 16x9 output). + // Streams sent to VGA should be widescreened only by renderers. + +#define KS_AMCONTROL_USED 0x00000001 // Used to test if these flags are supported. Set and test for AcceptMediaType. + // If rejected, then you cannot use the AMCONTROL flags (send 0 for dwReserved1) +#define KS_AMCONTROL_PAD_TO_4x3 0x00000002 // if set means display the image in a 4x3 area +#define KS_AMCONTROL_PAD_TO_16x9 0x00000004 // if set means display the image in a 16x9 area +#define KS_AMCONTROL_COLORINFO_PRESENT 0x00000080 // if set, indicates DXVA color info is present in the upper (24) bits of the dwControlFlags + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +typedef struct tagKS_VIDEOINFOHEADER2 { + RECT rcSource; + RECT rcTarget; + DWORD dwBitRate; + DWORD dwBitErrorRate; + REFERENCE_TIME AvgTimePerFrame; + DWORD dwInterlaceFlags; // use AMINTERLACE_* defines. Reject connection if undefined bits are not 0 + DWORD dwCopyProtectFlags; // use KS_COPYPROTECT_* defines. Reject connection if undefined bits are not 0 + DWORD dwPictAspectRatioX; // X dimension of picture aspect ratio, e.g. 16 for 16x9 display + DWORD dwPictAspectRatioY; // Y dimension of picture aspect ratio, e.g. 9 for 16x9 display + union { + DWORD dwControlFlags; // use KS_AMCONTROL_* defines, use this from now on + DWORD dwReserved1; // for backward compatiblity (was "must be 0"; connection rejected otherwise) + }; + DWORD dwReserved2; // must be 0; reject connection otherwise + KS_BITMAPINFOHEADER bmiHeader; +} KS_VIDEOINFOHEADER2, *PKS_VIDEOINFOHEADER2; + +typedef struct tagKS_MPEG1VIDEOINFO { + KS_VIDEOINFOHEADER hdr; // Compatible with VIDEOINFO + DWORD dwStartTimeCode; // 25-bit Group of pictures time code at start of data + DWORD cbSequenceHeader; // Length in bytes of bSequenceHeader + BYTE bSequenceHeader[1]; // Sequence header including quantization matrices if any +} KS_MPEG1VIDEOINFO, *PKS_MPEG1VIDEOINFO; + +#define KS_MAX_SIZE_MPEG1_SEQUENCE_INFO 140 +#define KS_SIZE_MPEG1VIDEOINFO(pv) (FIELD_OFFSET(KS_MPEG1VIDEOINFO, bSequenceHeader[0]) + (pv)->cbSequenceHeader) +#define KS_MPEG1_SEQUENCE_INFO(pv) ((const BYTE *)(pv)->bSequenceHeader) + +typedef struct tagKS_MPEGVIDEOINFO2 { + KS_VIDEOINFOHEADER2 hdr; + DWORD dwStartTimeCode; // ?? not used for DVD ?? + DWORD cbSequenceHeader; // is 0 for DVD (no sequence header) + DWORD dwProfile; // use enum MPEG2Profile + DWORD dwLevel; // use enum MPEG2Level + DWORD dwFlags; // use AMMPEG2_* defines. Reject connection if undefined bits are not 0 + DWORD bSequenceHeader[1]; // DWORD instead of Byte for alignment purposes + // For MPEG-2, if a sequence_header is included, the sequence_extension + // should also be included +} KS_MPEGVIDEOINFO2, *PKS_MPEGVIDEOINFO2; + + +typedef struct tagKS_H264VIDEOINFO { + // from UVC 1.5 H.264 frame descriptor + WORD wWidth; + WORD wHeight; + WORD wSARwidth; + WORD wSARheight; + WORD wProfile; + BYTE bLevelIDC; + WORD wConstrainedToolset; + DWORD bmSupportedUsages; + WORD bmCapabilities; + DWORD bmSVCCapabilities; + DWORD bmMVCCapabilities; + DWORD dwFrameInterval; + + // from UVC 1.5 H.264 format descriptor + BYTE bMaxCodecConfigDelay; + BYTE bmSupportedSliceModes; + BYTE bmSupportedSyncFrameTypes; + BYTE bResolutionScaling; + BYTE bSimulcastSupport; + BYTE bmSupportedRateControlModes; + WORD wMaxMBperSecOneResolutionNoScalability; + WORD wMaxMBperSecTwoResolutionsNoScalability; + WORD wMaxMBperSecThreeResolutionsNoScalability; + WORD wMaxMBperSecFourResolutionsNoScalability; + WORD wMaxMBperSecOneResolutionTemporalScalability; + WORD wMaxMBperSecTwoResolutionsTemporalScalablility; + WORD wMaxMBperSecThreeResolutionsTemporalScalability; + WORD wMaxMBperSecFourResolutionsTemporalScalability; + WORD wMaxMBperSecOneResolutionTemporalQualityScalability; + WORD wMaxMBperSecTwoResolutionsTemporalQualityScalability; + WORD wMaxMBperSecThreeResolutionsTemporalQualityScalablity; + WORD wMaxMBperSecFourResolutionsTemporalQualityScalability; + WORD wMaxMBperSecOneResolutionTemporalSpatialScalability; + WORD wMaxMBperSecTwoResolutionsTemporalSpatialScalability; + WORD wMaxMBperSecThreeResolutionsTemporalSpatialScalablity; + WORD wMaxMBperSecFourResolutionsTemporalSpatialScalability; + WORD wMaxMBperSecOneResolutionFullScalability; + WORD wMaxMBperSecTwoResolutionsFullScalability; + WORD wMaxMBperSecThreeResolutionsFullScalability; + WORD wMaxMBperSecFourResolutionsFullScalability; +} KS_H264VIDEOINFO, *PKS_H264VIDEOINFO; + + +#define KS_SIZE_MPEGVIDEOINFO2(pv) (FIELD_OFFSET(KS_MPEGVIDEOINFO2, bSequenceHeader[0]) + (pv)->cbSequenceHeader) +#define KS_MPEG1_SEQUENCE_INFO(pv) ((const BYTE *)(pv)->bSequenceHeader) + +//=========================================================================== +// Audio format blocks +//=========================================================================== + +//if set, the PTS,DTS timestamps advance at 27MHz rather than 90KHz +#define KS_MPEGAUDIOINFO_27MhzTimebase 0x00000001 + +typedef struct tagKS_MPEAUDIOINFO { + DWORD dwFlags; // use KS_MPEGAUDIOINFO_* defines. Reject connection if undefined bits are not 0 + DWORD dwReserved1; // must be 0; reject connection otherwise + DWORD dwReserved2; // must be 0; reject connection otherwise + DWORD dwReserved3; // must be 0; reject connection otherwise +} KS_MPEGAUDIOINFO, *PKS_MPEGAUDIOINFO; + +//=========================================================================== +// Video DATAFORMATs +//=========================================================================== + +typedef struct tagKS_DATAFORMAT_VIDEOINFOHEADER { + KSDATAFORMAT DataFormat; + KS_VIDEOINFOHEADER VideoInfoHeader; +} KS_DATAFORMAT_VIDEOINFOHEADER, *PKS_DATAFORMAT_VIDEOINFOHEADER; + +typedef struct tagKS_DATAFORMAT_VIDEOINFOHEADER2 { + KSDATAFORMAT DataFormat; + KS_VIDEOINFOHEADER2 VideoInfoHeader2; +} KS_DATAFORMAT_VIDEOINFOHEADER2, *PKS_DATAFORMAT_VIDEOINFOHEADER2; + +typedef struct tagKS_DATAFORMAT_MPEGVIDEOINFO2 { + KSDATAFORMAT DataFormat; + KS_MPEGVIDEOINFO2 MpegVideoInfoHeader2; +} KS_DATAFORMAT_MPEGVIDEOINFO2, *PKS_DATAFORMAT_MPEGVIDEOINFO2; + +typedef struct tagKS_DATAFORMAT_H264VIDEOINFO { + KSDATAFORMAT DataFormat; + KS_H264VIDEOINFO H264VideoInfoHeader; +} KS_DATAFORMAT_H264VIDEOINFO, *PKS_DATAFORMAT_H264VIDEOINFO; + +typedef struct tagKS_DATAFORMAT_IMAGEINFO { + KSDATAFORMAT DataFormat; + KS_BITMAPINFOHEADER ImageInfoHeader; +} KS_DATAFORMAT_IMAGEINFO, *PKS_DATAFORMAT_IMAGEINFO; + + +typedef struct tagKS_DATAFORMAT_VIDEOINFO_PALETTE { + KSDATAFORMAT DataFormat; + KS_VIDEOINFO VideoInfo; +} KS_DATAFORMAT_VIDEOINFO_PALETTE, *PKS_DATAFORMAT_VIDEOINFO_PALETTE; + +typedef struct tagKS_DATAFORMAT_VBIINFOHEADER { + KSDATAFORMAT DataFormat; + KS_VBIINFOHEADER VBIInfoHeader; +} KS_DATAFORMAT_VBIINFOHEADER, *PKS_DATAFORMAT_VBIINFOHEADER; + +typedef struct _KS_VIDEO_STREAM_CONFIG_CAPS { + GUID guid; // will be MEDIATYPE_Video + ULONG VideoStandard; // logical OR of all AnalogVideoStandards + // supported + SIZE InputSize; // the inherent size of the incoming signal + // (every pixel unique) + SIZE MinCroppingSize; // smallest rcSrc cropping rect allowed + SIZE MaxCroppingSize; // largest rcSrc cropping rect allowed + int CropGranularityX; // granularity of cropping size + int CropGranularityY; + int CropAlignX; // alignment of cropping rect + int CropAlignY; + SIZE MinOutputSize; // smallest bitmap stream can produce + SIZE MaxOutputSize; // largest bitmap stream can produce + int OutputGranularityX; // granularity of output bitmap size + int OutputGranularityY; + int StretchTapsX; // 0, no stretch, 1 pix dup, 2 interp, ... + int StretchTapsY; // Describes quality of hardware scaler + int ShrinkTapsX; // + int ShrinkTapsY; // + LONGLONG MinFrameInterval; // 100 nS units + LONGLONG MaxFrameInterval; + LONG MinBitsPerSecond; + LONG MaxBitsPerSecond; +} KS_VIDEO_STREAM_CONFIG_CAPS, *PKS_VIDEO_STREAM_CONFIG_CAPS; + +//=========================================================================== +// Video DATARANGEs +//=========================================================================== + +typedef struct tagKS_DATARANGE_VIDEO { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_VIDEOINFOHEADER VideoInfoHeader; // default format +} KS_DATARANGE_VIDEO, *PKS_DATARANGE_VIDEO; + +typedef struct tagKS_DATARANGE_VIDEO2 { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_VIDEOINFOHEADER2 VideoInfoHeader; // default format +} KS_DATARANGE_VIDEO2, *PKS_DATARANGE_VIDEO2; + +typedef struct tagKS_DATARANGE_MPEG1_VIDEO { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_MPEG1VIDEOINFO VideoInfoHeader; // default format +} KS_DATARANGE_MPEG1_VIDEO, *PKS_DATARANGE_MPEG1_VIDEO; + +typedef struct tagKS_DATARANGE_MPEG2_VIDEO { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_MPEGVIDEOINFO2 VideoInfoHeader; // default format +} KS_DATARANGE_MPEG2_VIDEO, *PKS_DATARANGE_MPEG2_VIDEO; + +typedef struct tagKS_DATARANGE_H264_VIDEO { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_H264VIDEOINFO VideoInfoHeader; // default format +} KS_DATARANGE_H264_VIDEO, *PKS_DATARANGE_H264_VIDEO; + +typedef struct tagKS_DATARANGE_IMAGE { + KSDATARANGE DataRange; + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_BITMAPINFOHEADER ImageInfoHeader; +} KS_DATARANGE_IMAGE, *PKS_DATARANGE_IMAGE; + +typedef struct tagKS_DATARANGE_VIDEO_PALETTE { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_VIDEOINFO VideoInfo; // default format +} KS_DATARANGE_VIDEO_PALETTE, *PKS_DATARANGE_VIDEO_PALETTE; + +typedef struct tagKS_DATARANGE_VIDEO_VBI { + KSDATARANGE DataRange; + BOOL bFixedSizeSamples; // all samples same size? + BOOL bTemporalCompression; // all I frames? + DWORD StreamDescriptionFlags; // KS_VIDEO_DESC_* + DWORD MemoryAllocationFlags; // KS_VIDEO_ALLOC_* + KS_VIDEO_STREAM_CONFIG_CAPS ConfigCaps; + KS_VBIINFOHEADER VBIInfoHeader; // default format +} KS_DATARANGE_VIDEO_VBI, *PKS_DATARANGE_VIDEO_VBI; + +typedef struct tagKS_DATARANGE_ANALOGVIDEO { + KSDATARANGE DataRange; + KS_ANALOGVIDEOINFO AnalogVideoInfo; +} KS_DATARANGE_ANALOGVIDEO, *PKS_DATARANGE_ANALOGVIDEO; + +//=========================================================================== +// StreamDescriptionFlags +// +// These define the "purpose" of each video stream +//=========================================================================== + +#define KS_VIDEOSTREAM_PREVIEW 0x0001 // Preview stream +#define KS_VIDEOSTREAM_CAPTURE 0x0002 // Capture stream +#define KS_VIDEOSTREAM_VBI 0x0010 // Field1 VBI +#define KS_VIDEOSTREAM_NABTS 0x0020 // Field1 NABTS +#define KS_VIDEOSTREAM_CC 0x0100 // Closed Captioning +#define KS_VIDEOSTREAM_EDS 0x0200 // Extended Data Services +#define KS_VIDEOSTREAM_TELETEXT 0x0400 // Field1 Teletext only +#define KS_VIDEOSTREAM_STILL 0x1000 // Still image input +#define KS_VIDEOSTREAM_IS_VPE 0x8000 // Is a VPE based stream? + +// MemoryAllocationFlags +#define KS_VIDEO_ALLOC_VPE_SYSTEM 0x0001 // VPE surface in system memory +#define KS_VIDEO_ALLOC_VPE_DISPLAY 0x0002 // VPE surface in display memory +#define KS_VIDEO_ALLOC_VPE_AGP 0x0004 // VPE surface in AGP memory + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +////////////////////////////////////////////////////////////// +// Capture driver VBI property sets +////////////////////////////////////////////////////////////// + +// {F162C607-7B35-496f-AD7F-2DCA3B46B718} +#define STATIC_KSPROPSETID_VBICAP_PROPERTIES\ + 0xf162c607, 0x7b35, 0x496f, 0xad, 0x7f, 0x2d, 0xca, 0x3b, 0x46, 0xb7, 0x18 +DEFINE_GUIDSTRUCT("F162C607-7B35-496f-AD7F-2DCA3B46B718", KSPROPSETID_VBICAP_PROPERTIES); +#define KSPROPSETID_VBICAP_PROPERTIES DEFINE_GUIDNAMED(KSPROPSETID_VBICAP_PROPERTIES) + +typedef enum { + KSPROPERTY_VBICAP_PROPERTIES_PROTECTION = 0x01, +} KSPROPERTY_VBICAP; + +typedef struct _VBICAP_PROPERTIES_PROTECTION_S { + KSPROPERTY Property; + ULONG StreamIndex; // Index of stream + ULONG Status; +} VBICAP_PROPERTIES_PROTECTION_S, *PVBICAP_PROPERTIES_PROTECTION_S; +#define KS_VBICAP_PROTECTION_MV_PRESENT 0x0001L +#define KS_VBICAP_PROTECTION_MV_HARDWARE 0x0002L +#define KS_VBICAP_PROTECTION_MV_DETECTED 0x0004L + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +/***************************************************************************/ +/* VBI Related GUIDs, structs and properties for codecs(generic, cc, nabts)*/ +/***************************************************************************/ + +/////////////////////////////////////////////////////////////////////////////////////// +// IP/NABTS Protocol Reserved Group IDs - Overall Range 0x800-0x8FF [Decimal 2048-2079] +// Intervening values(0-F) are used if there are multiple providers at a particular tier +/////////////////////////////////////////////////////////////////////////////////////// + +// Used by individual content creators in show footage/data +#define KS_NABTS_GROUPID_ORIGINAL_CONTENT_BASE 0x800 +#define KS_NABTS_GROUPID_ORIGINAL_CONTENT_ADVERTISER_BASE 0x810 + +// Used by production company in finished show data +#define KS_NABTS_GROUPID_PRODUCTION_COMPANY_CONTENT_BASE 0x820 +#define KS_NABTS_GROUPID_PRODUCTION_COMPANY_ADVERTISER_BASE 0x830 + +// Used by broadcast syndicates in syndicated show data +#define KS_NABTS_GROUPID_SYNDICATED_SHOW_CONTENT_BASE 0x840 +#define KS_NABTS_GROUPID_SYNDICATED_SHOW_ADVERTISER_BASE 0x850 + +// Used by tv networks in network television data +#define KS_NABTS_GROUPID_NETWORK_WIDE_CONTENT_BASE 0x860 +#define KS_NABTS_GROUPID_NETWORK_WIDE_ADVERTISER_BASE 0x870 + +// Used by telvision stations in local programming data +#define KS_NABTS_GROUPID_TELEVISION_STATION_CONTENT_BASE 0x880 +#define KS_NABTS_GROUPID_TELEVISION_STATION_ADVERTISER_BASE 0x890 + +// Used by cable system in cable head-end originated data +#define KS_NABTS_GROUPID_LOCAL_CABLE_SYSTEM_CONTENT_BASE 0x8A0 +#define KS_NABTS_GROUPID_LOCAL_CABLE_SYSTEM_ADVERTISER_BASE 0x8B0 + +// The values between 0x8C0 - 0x8EF are reserved for future expansion + +// Used by Microsoft for Testing purposes (0x8F0 - 0x8FF) +#define KS_NABTS_GROUPID_MICROSOFT_RESERVED_TEST_DATA_BASE 0x8F0 + +////////////////////////////////////////////////////////////// +// Stream Format FEC-corrected NABTS bundles +////////////////////////////////////////////////////////////// + +#define STATIC_KSDATAFORMAT_TYPE_NABTS \ + 0xe757bca0, 0x39ac, 0x11d1, 0xa9, 0xf5, 0x0, 0xc0, 0x4f, 0xbb, 0xde, 0x8f +DEFINE_GUIDSTRUCT("E757BCA0-39AC-11d1-A9F5-00C04FBBDE8F", KSDATAFORMAT_TYPE_NABTS); +#define KSDATAFORMAT_TYPE_NABTS DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_NABTS) + +#define STATIC_KSDATAFORMAT_SUBTYPE_NABTS_FEC \ + 0xe757bca1, 0x39ac, 0x11d1, 0xa9, 0xf5, 0x0, 0xc0, 0x4f, 0xbb, 0xde, 0x8f +DEFINE_GUIDSTRUCT("E757BCA1-39AC-11d1-A9F5-00C04FBBDE8F", KSDATAFORMAT_SUBTYPE_NABTS_FEC); +#define KSDATAFORMAT_SUBTYPE_NABTS_FEC DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_NABTS_FEC) + + +////////////////////////////////////////////////////////////// +// NABTS Bundle data structure definition +////////////////////////////////////////////////////////////// + +#define MAX_NABTS_VBI_LINES_PER_FIELD 11 +#define NABTS_LINES_PER_BUNDLE 16 +#define NABTS_PAYLOAD_PER_LINE 28 +#define NABTS_BYTES_PER_LINE 36 + +typedef struct _NABTSFEC_BUFFER { + ULONG dataSize; + USHORT groupID; + USHORT Reserved; + UCHAR data[NABTS_LINES_PER_BUNDLE * NABTS_PAYLOAD_PER_LINE]; +} NABTSFEC_BUFFER, *PNABTSFEC_BUFFER; + +////////////////////////////////////////////////////////////// +// vbi codec filtering pin properties +////////////////////////////////////////////////////////////// + +#define STATIC_KSPROPSETID_VBICodecFiltering \ + 0xcafeb0caL, 0x8715, 0x11d0, 0xbd, 0x6a, 0x00, 0x35, 0xc0, 0xed, 0xba, 0xbe +DEFINE_GUIDSTRUCT("cafeb0ca-8715-11d0-bd6a-0035c0edbabe", KSPROPSETID_VBICodecFiltering); +#define KSPROPSETID_VBICodecFiltering DEFINE_GUIDNAMED(KSPROPSETID_VBICodecFiltering) + +typedef enum { + KSPROPERTY_VBICODECFILTERING_SCANLINES_REQUESTED_BIT_ARRAY = 0x01, + KSPROPERTY_VBICODECFILTERING_SCANLINES_DISCOVERED_BIT_ARRAY, + KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_REQUESTED_BIT_ARRAY, + KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_DISCOVERED_BIT_ARRAY, + KSPROPERTY_VBICODECFILTERING_STATISTICS, +} KSPROPERTY_VBICODECFILTERING; + +typedef struct _VBICODECFILTERING_SCANLINES { + DWORD DwordBitArray[32]; // An array of scanline bits 0..1024(32*32) +} VBICODECFILTERING_SCANLINES, *PVBICODECFILTERING_SCANLINES; + +typedef struct _VBICODECFILTERING_NABTS_SUBSTREAMS { + DWORD SubstreamMask[128]; // An array of 4096 bits (one for each NABTS GroupID) +} VBICODECFILTERING_NABTS_SUBSTREAMS, *PVBICODECFILTERING_NABTS_SUBSTREAMS; + +typedef struct _VBICODECFILTERING_CC_SUBSTREAMS { + DWORD SubstreamMask; // An array of 32 bits (see KS_CC_SUBSTREAM *) +} VBICODECFILTERING_CC_SUBSTREAMS, *PVBICODECFILTERING_CC_SUBSTREAMS; + +// These KS_CC_SUBSTREAM_* bitmasks are used with VBICODECFILTERING_CC_SUBSTREAMS +#define KS_CC_SUBSTREAM_ODD 0x0001L // Unfiltered Field 1 Data +#define KS_CC_SUBSTREAM_EVEN 0x0002L // Unfiltered Field 2 Data + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// The following flags describe CC field 1 substreams: CC1,CC2,TT1,TT2 +#define KS_CC_SUBSTREAM_FIELD1_MASK 0x00F0L +#define KS_CC_SUBSTREAM_SERVICE_CC1 0x0010L +#define KS_CC_SUBSTREAM_SERVICE_CC2 0x0020L +#define KS_CC_SUBSTREAM_SERVICE_T1 0x0040L +#define KS_CC_SUBSTREAM_SERVICE_T2 0x0080L + +// The following flags describe CC field 2 substreams: CC3,CC4,TT3,TT4,XDS +#define KS_CC_SUBSTREAM_FIELD2_MASK 0x1F00L +#define KS_CC_SUBSTREAM_SERVICE_CC3 0x0100L +#define KS_CC_SUBSTREAM_SERVICE_CC4 0x0200L +#define KS_CC_SUBSTREAM_SERVICE_T3 0x0400L +#define KS_CC_SUBSTREAM_SERVICE_T4 0x0800L +#define KS_CC_SUBSTREAM_SERVICE_XDS 0x1000L + +// Special Note: field 1 or 2 substreams are usually on found on field 1 and 2 respectively +// If the VBI odd/even polarity is reversed, the correct filtered data will still be found. + +/////////////////////////////////////////////////////////////////// +// Hardware decoded CC stream format +/////////////////////////////////////////////////////////////////// + +#define CC_MAX_HW_DECODE_LINES 12 +typedef struct _CC_BYTE_PAIR { + BYTE Decoded[2]; + USHORT Reserved; +} CC_BYTE_PAIR, *PCC_BYTE_PAIR; + +typedef struct _CC_HW_FIELD { + VBICODECFILTERING_SCANLINES ScanlinesRequested; + ULONG fieldFlags; // KS_VBI_FLAG_FIELD1,2 + LONGLONG PictureNumber; + CC_BYTE_PAIR Lines[CC_MAX_HW_DECODE_LINES]; +} CC_HW_FIELD, *PCC_HW_FIELD; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +/////////////////////////////////////////////////////////////////// +// Raw NABTS stream format (TYPE_NABTS, SUBTYPE_NABTS) +/////////////////////////////////////////////////////////////////// + +// These low-level structures are byte packed( -Zp1 ) +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif +typedef struct _NABTS_BUFFER_LINE { + BYTE Confidence; + BYTE Bytes[NABTS_BYTES_PER_LINE]; +} NABTS_BUFFER_LINE, *PNABTS_BUFFER_LINE; + +#define NABTS_BUFFER_PICTURENUMBER_SUPPORT 1 +typedef struct _NABTS_BUFFER { + VBICODECFILTERING_SCANLINES ScanlinesRequested; + LONGLONG PictureNumber; + NABTS_BUFFER_LINE NabtsLines[MAX_NABTS_VBI_LINES_PER_FIELD]; +} NABTS_BUFFER, *PNABTS_BUFFER; +#if !defined( PACK_PRAGMAS_NOT_SUPPORTED ) +#include +#endif + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +////////////////////////////////////////////////////////////// +// WST Codec Teletext Media Sample Format +////////////////////////////////////////////////////////////// + +#define WST_TVTUNER_CHANGE_BEGIN_TUNE 0x1000L // Starting a tuning operation +#define WST_TVTUNER_CHANGE_END_TUNE 0x2000L // Ending a tuning operation + +#define MAX_WST_VBI_LINES_PER_FIELD 17 +#define WST_BYTES_PER_LINE 42 + +typedef struct _WST_BUFFER_LINE { + BYTE Confidence; + BYTE Bytes[WST_BYTES_PER_LINE]; +} WST_BUFFER_LINE, *PWST_BUFFER_LINE; + +typedef struct _WST_BUFFER { + VBICODECFILTERING_SCANLINES ScanlinesRequested; + WST_BUFFER_LINE WstLines[MAX_WST_VBI_LINES_PER_FIELD]; +} WST_BUFFER, *PWST_BUFFER; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +// +// Common codec statistics +// + +typedef struct _VBICODECFILTERING_STATISTICS_COMMON { + DWORD InputSRBsProcessed; // upstream SRBs received + DWORD OutputSRBsProcessed; // downstream SRBs sent + DWORD SRBsIgnored; // SRBs ignored due to no requests + DWORD InputSRBsMissing; // SRBs dropped upstream + DWORD OutputSRBsMissing; // Output dropped because no SRB pending + DWORD OutputFailures; // dropped because of other failure + DWORD InternalErrors; // could not process due to int. failure + DWORD ExternalErrors; // could not process due to ext. failure + DWORD InputDiscontinuities; // discontinuities received + DWORD DSPFailures; // DSP confidence failure + DWORD TvTunerChanges; // number of received KS_TVTUNER_CHANGE_BEGIN_TUNE and KS_TVTUNER_CHANGE_END_TUNE pairs. + DWORD VBIHeaderChanges; // number of received KS_VBI_FLAG_VBIINFOHEADER_CHANGE + DWORD LineConfidenceAvg; // Average of all DSP confidence results + DWORD BytesOutput; // Bytes sent downstream +} VBICODECFILTERING_STATISTICS_COMMON, *PVBICODECFILTERING_STATISTICS_COMMON; + +typedef struct _VBICODECFILTERING_STATISTICS_COMMON_PIN { + DWORD SRBsProcessed; // SRBs sent/received + DWORD SRBsIgnored; // SRBs ignored due to filtering + DWORD SRBsMissing; // SRBs not sent/received + DWORD InternalErrors; // could not send/receive due to int. failure + DWORD ExternalErrors; // could not send/receive due to ext. failure + DWORD Discontinuities; // discontinuities received/sent + DWORD LineConfidenceAvg; // Average of all DSP confidence results for this pin + DWORD BytesOutput; // Bytes sent downstream +} VBICODECFILTERING_STATISTICS_COMMON_PIN, *PVBICODECFILTERING_STATISTICS_COMMON_PIN; + +// +// Codec-specific statistics - NABTS +// + +typedef struct _VBICODECFILTERING_STATISTICS_NABTS { + VBICODECFILTERING_STATISTICS_COMMON Common; // Generic VBI statistics + DWORD FECBundleBadLines; // Un-FEC-correctable lines + DWORD FECQueueOverflows; // Number of times FEC queue overflowed + DWORD FECCorrectedLines; // Lines CSUM corrected by FEC + DWORD FECUncorrectableLines; // FEC input lines not CSUM correctable + DWORD BundlesProcessed; // Bundles received from FEC + DWORD BundlesSent2IP; // Bundles sent to IP driver + DWORD FilteredLines; // Lines processed and then dropped + // because no one was interested +} VBICODECFILTERING_STATISTICS_NABTS, *PVBICODECFILTERING_STATISTICS_NABTS; + +typedef struct _VBICODECFILTERING_STATISTICS_NABTS_PIN { + VBICODECFILTERING_STATISTICS_COMMON_PIN Common;// Generic VBI pin statistics +} VBICODECFILTERING_STATISTICS_NABTS_PIN, *PVBICODECFILTERING_STATISTICS_NABTS_PIN; + +// +// Codec-specific statistics - Closed Caption +// + +typedef struct _VBICODECFILTERING_STATISTICS_CC { + VBICODECFILTERING_STATISTICS_COMMON Common; // Generic VBI statistics +} VBICODECFILTERING_STATISTICS_CC, *PVBICODECFILTERING_STATISTICS_CC; + + +typedef struct _VBICODECFILTERING_STATISTICS_CC_PIN { + VBICODECFILTERING_STATISTICS_COMMON_PIN Common;// Generic VBI pin statistics +} VBICODECFILTERING_STATISTICS_CC_PIN, *PVBICODECFILTERING_STATISTICS_CC_PIN; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// +// Codec-specific statistics - Teletext +// + +typedef struct _VBICODECFILTERING_STATISTICS_TELETEXT { + VBICODECFILTERING_STATISTICS_COMMON Common; // Generic VBI statistics +} VBICODECFILTERING_STATISTICS_TELETEXT, *PVBICODECFILTERING_STATISTICS_TELETEXT; + +typedef struct _VBICODECFILTERING_STATISTICS_TELETEXT_PIN { + VBICODECFILTERING_STATISTICS_COMMON_PIN Common;// Generic VBI pin statistics +} VBICODECFILTERING_STATISTICS_TELETEXT_PIN, *PVBICODECFILTERING_STATISTICS_TELETEXT_PIN; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +//////////////////////////////////////////////////////////////////////////// +// VBI codec property structures(based on KSPROPERTY_VBICODECFILTERING enum) +//////////////////////////////////////////////////////////////////////////// + +// *** Most codecs support this property +// KSPROPERTY_VBICODECFILTERING_SCANLINES_REQUESTED_BIT_ARRAY +// KSPROPERTY_VBICODECFILTERING_SCANLINES_DISCOVERED_BIT_ARRAY, +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_SCANLINES Scanlines; +} KSPROPERTY_VBICODECFILTERING_SCANLINES_S, *PKSPROPERTY_VBICODECFILTERING_SCANLINES_S; + +// *** NABTS codecs support this property +// KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_REQUESTED_BIT_ARRAY, +// KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_DISCOVERED_BIT_ARRAY, +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_NABTS_SUBSTREAMS Substreams; +} KSPROPERTY_VBICODECFILTERING_NABTS_SUBSTREAMS_S, *PKSPROPERTY_VBICODECFILTERING_NABTS_SUBSTREAMS_S; + +// *** Closed captioning codecs support this property +// KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_REQUESTED_BIT_ARRAY, +// KSPROPERTY_VBICODECFILTERING_SUBSTREAMS_DISCOVERED_BIT_ARRAY, +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_CC_SUBSTREAMS Substreams; +} KSPROPERTY_VBICODECFILTERING_CC_SUBSTREAMS_S, *PKSPROPERTY_VBICODECFILTERING_CC_SUBSTREAMS_S; + +// *** Most codecs support these versions of the global and pin properties +// KSPROPERTY_VBICODECFILTERING_STATISTICS +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_COMMON Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_COMMON_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_COMMON_S; + +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_COMMON_PIN Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_COMMON_PIN_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_COMMON_PIN_S; + +// *** NABTS codecs support this version of the global and pin properties +// KSPROPERTY_VBICODECFILTERING_STATISTICS +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_NABTS Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_NABTS_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_NABTS_S; + +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_NABTS_PIN Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_NABTS_PIN_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_NABTS_PIN_S; + +// *** Closed captioning codecs support this version of the global and pin properties +// KSPROPERTY_VBICODECFILTERING_STATISTICS + +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_CC Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_CC_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_CC_S; + +typedef struct { + KSPROPERTY Property; + VBICODECFILTERING_STATISTICS_CC_PIN Statistics; +} KSPROPERTY_VBICODECFILTERING_STATISTICS_CC_PIN_S, *PKSPROPERTY_VBICODECFILTERING_STATISTICS_CC_PIN_S; + +// Standard Pin Names for the video capture filter +//=========================================================================== + +#define STATIC_PINNAME_VIDEO_CAPTURE \ + 0xfb6c4281, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +#define STATIC_PINNAME_CAPTURE STATIC_PINNAME_VIDEO_CAPTURE +DEFINE_GUIDSTRUCT("FB6C4281-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_CAPTURE); +#define PINNAME_VIDEO_CAPTURE DEFINE_GUIDNAMED(PINNAME_VIDEO_CAPTURE) +#define PINNAME_CAPTURE PINNAME_VIDEO_CAPTURE + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_PINNAME_VIDEO_CC_CAPTURE \ + 0x1aad8061, 0x12d, 0x11d2, 0xb4, 0xb1, 0x0, 0xa0, 0xd1, 0x2, 0xcf, 0xbe +#define STATIC_PINNAME_CC_CAPTURE STATIC_PINNAME_VIDEO_CC_CAPTURE +DEFINE_GUIDSTRUCT("1AAD8061-012D-11d2-B4B1-00A0D102CFBE", PINNAME_VIDEO_CC_CAPTURE); +#define PINNAME_VIDEO_CC_CAPTURE DEFINE_GUIDNAMED(PINNAME_VIDEO_CC_CAPTURE) + +#define STATIC_PINNAME_VIDEO_NABTS_CAPTURE \ + 0x29703660, 0x498a, 0x11d2, 0xb4, 0xb1, 0x0, 0xa0, 0xd1, 0x2, 0xcf, 0xbe +#define STATIC_PINNAME_NABTS_CAPTURE STATIC_PINNAME_VIDEO_NABTS_CAPTURE +DEFINE_GUIDSTRUCT("29703660-498A-11d2-B4B1-00A0D102CFBE", PINNAME_VIDEO_NABTS_CAPTURE); +#define PINNAME_VIDEO_NABTS_CAPTURE DEFINE_GUIDNAMED(PINNAME_VIDEO_NABTS_CAPTURE) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define STATIC_PINNAME_VIDEO_PREVIEW \ + 0xfb6c4282, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +#define STATIC_PINNAME_PREVIEW STATIC_PINNAME_VIDEO_PREVIEW +DEFINE_GUIDSTRUCT("FB6C4282-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_PREVIEW); +#define PINNAME_VIDEO_PREVIEW DEFINE_GUIDNAMED(PINNAME_VIDEO_PREVIEW) +#define PINNAME_PREVIEW PINNAME_VIDEO_PREVIEW + +#define STATIC_PINNAME_VIDEO_ANALOGVIDEOIN \ + 0xfb6c4283, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4283-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_ANALOGVIDEOIN); +#define PINNAME_VIDEO_ANALOGVIDEOIN DEFINE_GUIDNAMED(PINNAME_VIDEO_ANALOGVIDEOIN) + +#define STATIC_PINNAME_VIDEO_VBI \ + 0xfb6c4284, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4284-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_VBI); +#define PINNAME_VIDEO_VBI DEFINE_GUIDNAMED(PINNAME_VIDEO_VBI) + +#define STATIC_PINNAME_VIDEO_VIDEOPORT \ + 0xfb6c4285, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4285-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_VIDEOPORT); +#define PINNAME_VIDEO_VIDEOPORT DEFINE_GUIDNAMED(PINNAME_VIDEO_VIDEOPORT) + +#define STATIC_PINNAME_VIDEO_NABTS \ + 0xfb6c4286, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4286-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_NABTS); +#define PINNAME_VIDEO_NABTS DEFINE_GUIDNAMED(PINNAME_VIDEO_NABTS) + +#define STATIC_PINNAME_VIDEO_EDS \ + 0xfb6c4287, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4287-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_EDS); +#define PINNAME_VIDEO_EDS DEFINE_GUIDNAMED(PINNAME_VIDEO_EDS) + +#define STATIC_PINNAME_VIDEO_TELETEXT \ + 0xfb6c4288, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4288-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_TELETEXT); +#define PINNAME_VIDEO_TELETEXT DEFINE_GUIDNAMED(PINNAME_VIDEO_TELETEXT) + +#define STATIC_PINNAME_VIDEO_CC \ + 0xfb6c4289, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C4289-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_CC); +#define PINNAME_VIDEO_CC DEFINE_GUIDNAMED(PINNAME_VIDEO_CC) + +#define STATIC_PINNAME_VIDEO_STILL \ + 0xfb6c428A, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C428A-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_STILL); +#define PINNAME_VIDEO_STILL DEFINE_GUIDNAMED(PINNAME_VIDEO_STILL) + +#define STATIC_PINNAME_IMAGE \ + 0x38a0cd98, 0xd49b, 0x4ce8, 0xb4, 0x8a, 0x34, 0x46, 0x67, 0xa1, 0x78, 0x30 +DEFINE_GUIDSTRUCT("38A0CD98-D49B-4ce8-B48A-344667A17830", PINNAME_IMAGE); +#define PINNAME_IMAGE DEFINE_GUIDNAMED(PINNAME_IMAGE) + +#define STATIC_PINNAME_VIDEO_TIMECODE \ + 0xfb6c428B, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C428B-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_TIMECODE); +#define PINNAME_VIDEO_TIMECODE DEFINE_GUIDNAMED(PINNAME_VIDEO_TIMECODE) + +#define STATIC_PINNAME_VIDEO_VIDEOPORT_VBI \ + 0xfb6c428C, 0x353, 0x11d1, 0x90, 0x5f, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("FB6C428C-0353-11d1-905F-0000C0CC16BA", PINNAME_VIDEO_VIDEOPORT_VBI); +#define PINNAME_VIDEO_VIDEOPORT_VBI DEFINE_GUIDNAMED(PINNAME_VIDEO_VIDEOPORT_VBI) + +// KSPROPSETID_VIDMEM_TRANSPORT related guids, structs and enums +//=========================================================================== + +// +// Capture MemoryAllocationFlags +// +typedef enum { + KS_CAPTURE_ALLOC_INVALID = 0, + KS_CAPTURE_ALLOC_SYSTEM = 0x0001, // surface in system memory + KS_CAPTURE_ALLOC_VRAM = 0x0002, // surface in display memory + KS_CAPTURE_ALLOC_SYSTEM_AGP = 0x0004, // surface in system memory tagged as AGP accessible + KS_CAPTURE_ALLOC_VRAM_MAPPED = 0x0008, // surface in system memory mapped into VRAM address space + KS_CAPTURE_ALLOC_SECURE_BUFFER = 0x0010 // secure buffer in VTL1 +}CAPTURE_MEMORY_ALLOCATION_FLAGS, *PCAPTURE_MEMORY_ALLOCATION_FLAGS; + +// +//Video memory capture KSPROPSETID +// +#define STATIC_KSPROPSETID_VramCapture\ + 0xe73face3, 0x2880, 0x4902, 0xb7, 0x99, 0x88, 0xd0, 0xcd, 0x63, 0x4e, 0xf +DEFINE_GUIDSTRUCT("E73FACE3-2880-4902-B799-88D0CD634E0F", KSPROPSETID_VramCapture); +#define KSPROPSETID_VramCapture DEFINE_GUIDNAMED(KSPROPSETID_VramCapture) + +typedef enum { + // + // enum value '0' means an invalid KSPROPERTY request. + // Drivers should return an error. + // + KSPROPERTY_DISPLAY_ADAPTER_GUID = 1, //Returns the Adapter GUID. + KSPROPERTY_PREFERRED_CAPTURE_SURFACE, //Returns the memory surface preferred by that pin + KSPROPERTY_CURRENT_CAPTURE_SURFACE, //Sets/Gets currently selected capture surface + KSPROPERTY_MAP_CAPTURE_HANDLE_TO_VRAM_ADDRESS //Maps VRAM surface handle to VRAM physical address +} KSPROPERTY_VIDMEM_TRANSPORT; + +#define DEFINE_KSPROPERTY_ITEM_DISPLAY_ADAPTER_GUID(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_DISPLAY_ADAPTER_GUID,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(GUID),\ + NULL,\ + NULL, 0, NULL, NULL, 0) +#define DEFINE_KSPROPERTY_PREFERRED_CAPTURE_SURFACE(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_PREFERRED_CAPTURE_SURFACE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(CAPTURE_MEMORY_ALLOCATION_FLAGS),\ + NULL,\ + NULL, 0, NULL, NULL, 0) +#define DEFINE_KSPROPERTY_CURRENT_CAPTURE_SURFACE(GetHandler, SetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_CURRENT_CAPTURE_SURFACE,\ + (GetHandler),\ + sizeof(KSPROPERTY),\ + sizeof(CAPTURE_MEMORY_ALLOCATION_FLAGS),\ + (SetHandler),\ + NULL, 0, NULL, NULL, 0) +#define DEFINE_KSPROPERTY_MAP_CAPTURE_HANDLE_TO_VRAM_ADDRESS(GetHandler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_MAP_CAPTURE_HANDLE_TO_VRAM_ADDRESS,\ + (GetHandler),\ + sizeof(VRAM_SURFACE_INFO_PROPERTY_S),\ + sizeof(DWORD),\ + NULL,\ + NULL, 0, NULL, NULL, 0) + +// +//Surface info passed on to the mini driver. +// +typedef struct { + UINT_PTR hSurface; + LONGLONG VramPhysicalAddress; + DWORD cbCaptured; + DWORD dwWidth; + DWORD dwHeight; + DWORD dwLinearSize; + LONG lPitch; + ULONGLONG ullReserved[16]; +} VRAM_SURFACE_INFO, *PVRAM_SURFACE_INFO; + +typedef struct { + KSPROPERTY Property; + PVRAM_SURFACE_INFO pVramSurfaceInfo; +}VRAM_SURFACE_INFO_PROPERTY_S, *PVRAM_SURFACE_INFO_PROPERTY_S; + +// +//Secure buffer info passed on to the mini driver. +// +typedef struct { + GUID guidBufferIdentifier; + DWORD cbBufferSize; + DWORD cbCaptured; + ULONGLONG ullReserved[16]; +} SECURE_BUFFER_INFO, *PSECURE_BUFFER_INFO; + +// Sceanrio ID for secure buffer for camera +#define STATIC_KS_SECURE_CAMERA_SCENARIO_ID \ + 0xAE53FC6E, 0x8D89, 0x4488, 0x9D, 0x2E, 0x4D, 0x00, 0x87, 0x31, 0xC5, 0xFD +DEFINE_GUIDSTRUCT("AE53FC6E-8D89-4488-9D2E-4D008731C5FD", KS_SECURE_CAMERA_SCENARIO_ID); +#define KS_SECURE_CAMERA_SCENARIO_ID DEFINE_GUIDNAMED(KS_SECURE_CAMERA_SCENARIO_ID) + +#define STATIC_KSPROPSETID_MPEG4_MediaType_Attributes\ + 0xff6c4bfa, 0x7a9, 0x4c7b, 0xa2, 0x37, 0x67, 0x2f, 0x9d, 0x68, 0x6, 0x5f +DEFINE_GUIDSTRUCT("FF6C4BFA-07A9-4c7b-A237-672F9D68065F", KSPROPSETID_MPEG4_MediaType_Attributes); +#define KSPROPSETID_MPEG4_MediaType_Attributes DEFINE_GUIDNAMED(KSPROPSETID_MPEG4_MediaType_Attributes) + +typedef enum { + KSPROPERTY_MPEG4_MEDIATYPE_SD_BOX = 1 +}KSPROPERTY_MPEG4_MEDIATYPE_ATTRIBUTES; + +#define STATIC_KSEVENTSETID_DynamicFormatChange\ + 0x162ac456, 0x83d7, 0x4239, 0x96, 0xdf, 0xc7, 0x5f, 0xfa, 0x13, 0x8b, 0xc6 +DEFINE_GUIDSTRUCT("162AC456-83D7-4239-96DF-C75FFA138BC6", KSEVENTSETID_DynamicFormatChange); +#define KSEVENTSETID_DynamicFormatChange DEFINE_GUIDNAMED(KSEVENTSETID_DynamicFormatChange) + +typedef enum { + KSEVENT_DYNAMIC_FORMAT_CHANGE = 0 +} KSEVENT_DYNAMICFORMATCHANGE; + +// {FC9D87B5-0B02-438E-89B0-E241FCE889AD} +#define STATIC_KSATTRIBUTEID_VIDEOFORMAT_DX12 \ + 0xfc9d87b5, 0x0b02, 0x438e, 0x89, 0xb0, 0xe2, 0x41, 0xfc, 0xe8, 0x89, 0xad +DEFINE_GUIDSTRUCT("FC9D87B5-0B02-438E-89B0-E241FCE889AD", KSATTRIBUTEID_VIDEOFORMAT_DX12); +#define KSATTRIBUTEID_VIDEOFORMAT_DX12 DEFINE_GUIDNAMED(KSATTRIBUTEID_VIDEOFORMAT_DX12) + +typedef struct _VideoDXFormat +{ + KSATTRIBUTE Header; + ULONG resourceLayout; // D3D12_TEXTURE_LAYOUT + ULONG resourceFlags; // D3D12_RESOURCE_FLAGS + GUID customLayout; +} VIDEOFORMAT_DX12, *PVIDEOFORMAT_DX12; + +//=========================================================================== +// KSSTREAM_HEADER extensions for digital video +//=========================================================================== + +#define KS_VIDEO_FLAG_FIELD_MASK 0x0003L // Frame or Field (default is frame) +#define KS_VIDEO_FLAG_FRAME 0x0000L // Frame or Field (default is frame) +#define KS_VIDEO_FLAG_FIELD1 0x0001L +#define KS_VIDEO_FLAG_FIELD2 0x0002L +#define KS_VIDEO_FLAG_FIELD1FIRST 0x0004L +#define KS_VIDEO_FLAG_WEAVE 0x0008L + +#define KS_VIDEO_FLAG_IPB_MASK 0x0030L // I, B, or P (default is I) +#define KS_VIDEO_FLAG_I_FRAME 0x0000L // I, B, or P (default is I) +#define KS_VIDEO_FLAG_P_FRAME 0x0010L +#define KS_VIDEO_FLAG_B_FRAME 0x0020L +#define KS_VIDEO_FLAG_REPEAT_FIELD 0x0040L + + +typedef struct tagKS_FRAME_INFO { + ULONG ExtendedHeaderSize; // Size of this extended header + DWORD dwFrameFlags; // Field1, Field2, or Frame + LONGLONG PictureNumber; + LONGLONG DropCount; + + // The following are only set when using OverlayMixer + HANDLE hDirectDraw; // user mode DDraw handle + HANDLE hSurfaceHandle; // user mode surface handle + RECT DirectDrawRect; // portion of surface locked + union { + LONG lSurfacePitch; + // Contains surface pitch a.k.a stride + DWORD Reserved1; + }; + + DWORD Reserved2; + + union { + struct { + DWORD Reserved3; + DWORD Reserved4; + }; + ULONGLONG FrameCompletionNumber; + }; + +} KS_FRAME_INFO, *PKS_FRAME_INFO; + +//=========================================================================== +// KSSTREAM_HEADER extensions for VBI +//=========================================================================== + +#if (NTDDI_VERSION < NTDDI_WINXP) +#define KS_VBI_FLAG_FRAME 0x0000L // Frame or Field (default is frame) +#endif +#define KS_VBI_FLAG_FIELD1 0x0001L +#define KS_VBI_FLAG_FIELD2 0x0002L + +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define KS_VBI_FLAG_MV_PRESENT 0x0100L +#define KS_VBI_FLAG_MV_HARDWARE 0x0200L +#define KS_VBI_FLAG_MV_DETECTED 0x0400L +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define KS_VBI_FLAG_TVTUNER_CHANGE 0x0010L // TvTunerChangeInfo is valid +#define KS_VBI_FLAG_VBIINFOHEADER_CHANGE 0x0020L // VBIInfoHeader is valid + +typedef struct tagKS_VBI_FRAME_INFO { + ULONG ExtendedHeaderSize; // Size of this extended header + DWORD dwFrameFlags; // Field1, Field2, or Frame; & etc + LONGLONG PictureNumber; // Test only? + LONGLONG DropCount; // Test only? + DWORD dwSamplingFrequency; + KS_TVTUNER_CHANGE_INFO TvTunerChangeInfo; + KS_VBIINFOHEADER VBIInfoHeader; + // + //The following are for VRAM surface transport to support LDDM Capture + // + //VRAM_SURFACE_INFO VramSurfaceInfo; +} KS_VBI_FRAME_INFO, *PKS_VBI_FRAME_INFO; + + +//=========================================================================== +// Analog video formats, used with: +// Analog Video Decoders +// TVTuners +// Analog Video Encoders +// +// XXX_STANDARDS_SUPPORTED returns a bitmask +//=========================================================================== + +typedef enum +{ + KS_AnalogVideo_None = 0x00000000, // This is a digital sensor + KS_AnalogVideo_NTSC_M = 0x00000001, // 75 IRE Setup + KS_AnalogVideo_NTSC_M_J = 0x00000002, // Japan, 0 IRE Setup + KS_AnalogVideo_NTSC_433 = 0x00000004, + + KS_AnalogVideo_PAL_B = 0x00000010, + KS_AnalogVideo_PAL_D = 0x00000020, + KS_AnalogVideo_PAL_G = 0x00000040, + KS_AnalogVideo_PAL_H = 0x00000080, + KS_AnalogVideo_PAL_I = 0x00000100, + KS_AnalogVideo_PAL_M = 0x00000200, + KS_AnalogVideo_PAL_N = 0x00000400, + + KS_AnalogVideo_PAL_60 = 0x00000800, + + KS_AnalogVideo_SECAM_B = 0x00001000, + KS_AnalogVideo_SECAM_D = 0x00002000, + KS_AnalogVideo_SECAM_G = 0x00004000, + KS_AnalogVideo_SECAM_H = 0x00008000, + KS_AnalogVideo_SECAM_K = 0x00010000, + KS_AnalogVideo_SECAM_K1 = 0x00020000, + KS_AnalogVideo_SECAM_L = 0x00040000, + KS_AnalogVideo_SECAM_L1 = 0x00080000 + +#if (NTDDI_VERSION >= NTDDI_WINXP) + , KS_AnalogVideo_PAL_N_COMBO + = 0x00100000 +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +} KS_AnalogVideoStandard; + +#define KS_AnalogVideo_NTSC_Mask 0x00000007 +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define KS_AnalogVideo_PAL_Mask 0x00100FF0 +#else +#define KS_AnalogVideo_PAL_Mask 0x00000FF0 +#endif +#define KS_AnalogVideo_SECAM_Mask 0x000FF000 + +//=========================================================================== +// Property set definitions +// The comments show whether a given property is: +// R : READ only +// w : WRITE only +// RW : READ / WRITE +// O : Optional (return E_UNSUPPORTED if you don't handle this) +//=========================================================================== + +#define STATIC_PROPSETID_ALLOCATOR_CONTROL\ + 0x53171960, 0x148e, 0x11d2, 0x99, 0x79, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba +DEFINE_GUIDSTRUCT("53171960-148E-11d2-9979-0000C0CC16BA", PROPSETID_ALLOCATOR_CONTROL); +#define PROPSETID_ALLOCATOR_CONTROL DEFINE_GUIDNAMED(PROPSETID_ALLOCATOR_CONTROL) +typedef enum { + KSPROPERTY_ALLOCATOR_CONTROL_HONOR_COUNT, // R O (will allocate exactly this number of buffers) + KSPROPERTY_ALLOCATOR_CONTROL_SURFACE_SIZE // R O (return 2 DWORDs specifying surface size) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + + // W I (informn a capture driver whether interleave capture is possible or + // not - a value of 1 means that interleaved capture is supported) + , KSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_CAPS + + // R O (if value == 1, then the ovmixer will turn on the DDVP_INTERLEAVE + // flag thus allowing interleaved capture of the video) + , KSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_INTERLEAVE + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +} KSPROPERTY_ALLOCATOR_CONTROL; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +typedef struct { + //KSPROPERTY Property; + ULONG CX; + ULONG CY; +} KSPROPERTY_ALLOCATOR_CONTROL_SURFACE_SIZE_S, *PKSPROPERTY_ALLOCATOR_CONTROL_SURFACE_SIZE_S; + +typedef struct { + //KSPROPERTY Property; + ULONG InterleavedCapSupported; +} KSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_CAPS_S, *PKSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_CAPS_S; + + +typedef struct { + //KSPROPERTY Property; + ULONG InterleavedCapPossible; +} KSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_INTERLEAVE_S, *PKSPROPERTY_ALLOCATOR_CONTROL_CAPTURE_INTERLEAVE_S; + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion +//=========================================================================== + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#define STATIC_PROPSETID_VIDCAP_VIDEOPROCAMP\ + 0xC6E13360L, 0x30AC, 0x11d0, 0xa1, 0x8c, 0x00, 0xA0, 0xC9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("C6E13360-30AC-11d0-A18C-00A0C9118956", PROPSETID_VIDCAP_VIDEOPROCAMP); +#define PROPSETID_VIDCAP_VIDEOPROCAMP DEFINE_GUIDNAMED(PROPSETID_VIDCAP_VIDEOPROCAMP) + +typedef enum { + KSPROPERTY_VIDEOPROCAMP_BRIGHTNESS, // RW O + KSPROPERTY_VIDEOPROCAMP_CONTRAST, // RW O + KSPROPERTY_VIDEOPROCAMP_HUE, // RW O + KSPROPERTY_VIDEOPROCAMP_SATURATION, // RW O + KSPROPERTY_VIDEOPROCAMP_SHARPNESS, // RW O + KSPROPERTY_VIDEOPROCAMP_GAMMA, // RW O + KSPROPERTY_VIDEOPROCAMP_COLORENABLE, // RW O + KSPROPERTY_VIDEOPROCAMP_WHITEBALANCE, // RW O + KSPROPERTY_VIDEOPROCAMP_BACKLIGHT_COMPENSATION // RW O + +#if (NTDDI_VERSION >= NTDDI_WINXP) + + , KSPROPERTY_VIDEOPROCAMP_GAIN // RW O + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + + , KSPROPERTY_VIDEOPROCAMP_DIGITAL_MULTIPLIER // RW O + , KSPROPERTY_VIDEOPROCAMP_DIGITAL_MULTIPLIER_LIMIT // RW O + , KSPROPERTY_VIDEOPROCAMP_WHITEBALANCE_COMPONENT // RW O + , KSPROPERTY_VIDEOPROCAMP_POWERLINE_FREQUENCY // RW O + +#endif // XP SP2 and later (chronologically) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +} KSPROPERTY_VIDCAP_VIDEOPROCAMP; + +typedef struct { + KSPROPERTY Property; + LONG Value; // Value to set or get + ULONG Flags; // KSPROPERTY_VIDEOPROCAMP_FLAGS_* + ULONG Capabilities; // KSPROPERTY_VIDEOPROCAMP_FLAGS_* +} KSPROPERTY_VIDEOPROCAMP_S, *PKSPROPERTY_VIDEOPROCAMP_S; + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +typedef struct { + KSP_NODE NodeProperty; + LONG Value; // Value to set or get + ULONG Flags; // KSPROPERTY_VIDEOPROCAMP_FLAGS_* + ULONG Capabilities; // KSPROPERTY_VIDEOPROCAMP_FLAGS_* +} KSPROPERTY_VIDEOPROCAMP_NODE_S, *PKSPROPERTY_VIDEOPROCAMP_NODE_S; + +typedef struct { + KSPROPERTY Property; + LONG Value1; + ULONG Flags; + ULONG Capabilities; + LONG Value2; +} KSPROPERTY_VIDEOPROCAMP_S2, *PKSPROPERTY_VIDEOPROCAMP_S2; + +typedef struct { + KSP_NODE NodeProperty; + LONG Value1; + ULONG Flags; + ULONG Capabilities; + LONG Value2; +} KSPROPERTY_VIDEOPROCAMP_NODE_S2, *PKSPROPERTY_VIDEOPROCAMP_NODE_S2; + +#endif // XP SP2 and later (chronologically) + +#define KSPROPERTY_VIDEOPROCAMP_FLAGS_AUTO 0X0001L +#define KSPROPERTY_VIDEOPROCAMP_FLAGS_MANUAL 0X0002L + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion +//=========================================================================== + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define STATIC_PROPSETID_VIDCAP_SELECTOR \ + 0x1ABDAECA, 0x68B6, 0x4F83, 0x93, 0x71, 0xB4, 0x13, 0x90, 0x7C, 0x7B, 0x9F +DEFINE_GUIDSTRUCT("1ABDAECA-68B6-4F83-9371-B413907C7B9F", PROPSETID_VIDCAP_SELECTOR); +#define PROPSETID_VIDCAP_SELECTOR DEFINE_GUIDNAMED(PROPSETID_VIDCAP_SELECTOR) + +typedef enum { + KSPROPERTY_SELECTOR_SOURCE_NODE_ID, // RW + KSPROPERTY_SELECTOR_NUM_SOURCES // R +} KSPROPERTY_VIDCAP_SELECTOR, *PKSPROPERTY_VIDCAP_SELECTOR; + +typedef struct { + KSPROPERTY Property; + LONG Value; // Value to set or get + ULONG Flags; + ULONG Capabilities; +} KSPROPERTY_SELECTOR_S, *PKSPROPERTY_SELECTOR_S; + +typedef struct { + KSP_NODE NodeProperty; + LONG Value; // Value to set or get + ULONG Flags; + ULONG Capabilities; +} KSPROPERTY_SELECTOR_NODE_S, *PKSPROPERTY_SELECTOR_NODE_S; + +#endif // XP SP2 and later (chronologically) + +//=========================================================================== + + +#define STATIC_PROPSETID_TUNER\ + 0x6a2e0605L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0605-28e4-11d0-a18c-00a0c9118956", PROPSETID_TUNER); +#define PROPSETID_TUNER DEFINE_GUIDNAMED(PROPSETID_TUNER) + +typedef enum { + KSPROPERTY_TUNER_CAPS, // R -overall device capabilities + KSPROPERTY_TUNER_MODE_CAPS, // R -capabilities in this mode + KSPROPERTY_TUNER_MODE, // RW -set a mode (TV, FM, AM, DSS) + KSPROPERTY_TUNER_STANDARD, // R -get TV standard (only if TV mode) + KSPROPERTY_TUNER_FREQUENCY, // RW -set/get frequency + KSPROPERTY_TUNER_INPUT, // RW -select an input + KSPROPERTY_TUNER_STATUS, // R -tuning status + KSPROPERTY_TUNER_IF_MEDIUM, // R O-Medium for IF or Transport Pin + KSPROPERTY_TUNER_SCAN_CAPS, // R -overall device capabilities for scanning + KSPROPERTY_TUNER_SCAN_STATUS, // R -status of scan + KSPROPERTY_TUNER_STANDARD_MODE, // RW -autodetect mode for signal standard + KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS // R -network type specific tuner capabilities +} KSPROPERTY_TUNER; + + +// +// Tuning support definitions and interfaces +// + +// Definitions + +typedef enum { + KSPROPERTY_TUNER_MODE_TV = 0X0001, + KSPROPERTY_TUNER_MODE_FM_RADIO = 0X0002, + KSPROPERTY_TUNER_MODE_AM_RADIO = 0X0004, + KSPROPERTY_TUNER_MODE_DSS = 0X0008, + KSPROPERTY_TUNER_MODE_ATSC = 0X0010, // also used for DVB-T, DVB-C +} KSPROPERTY_TUNER_MODES; + +// Describes how the device tunes. Only one of these flags may be set +// in KSPROPERTY_TUNER_MODE_CAPS_S.Strategy + +// Describe how the driver should attempt to tune: +// EXACT: just go to the frequency specified (no fine tuning) +// FINE: (slow) do an exhaustive search for the best signal +// COARSE: (fast) use larger frequency jumps to just determine if any signal + +typedef enum { + KS_TUNER_TUNING_EXACT = 1, // No fine tuning + KS_TUNER_TUNING_FINE, // Fine grained search + KS_TUNER_TUNING_COARSE, // Coarse search +}KS_TUNER_TUNING_FLAGS; + +typedef enum { + KS_TUNER_STRATEGY_PLL = 0X01, // Tune by PLL offset + KS_TUNER_STRATEGY_SIGNAL_STRENGTH = 0X02, // Tune by signal strength + KS_TUNER_STRATEGY_DRIVER_TUNES = 0X04, // Driver does fine tuning +}KS_TUNER_STRATEGY; + + +// Tuning operations + +typedef struct { + KSPROPERTY Property; + ULONG ModesSupported; // KS_PROPERTY_TUNER_MODES_* + KSPIN_MEDIUM VideoMedium; // GUID_NULL (no pin), or GUID + KSPIN_MEDIUM TVAudioMedium; // GUID_NULL (no pin), or GUID + KSPIN_MEDIUM RadioAudioMedium; // GUID_NULL (no pin), or GUID +} KSPROPERTY_TUNER_CAPS_S, *PKSPROPERTY_TUNER_CAPS_S; + +typedef struct { + KSPROPERTY Property; + KSPIN_MEDIUM IFMedium; // GUID_NULL (no pin), or GUID +} KSPROPERTY_TUNER_IF_MEDIUM_S, *PKSPROPERTY_TUNER_IF_MEDIUM_S; + +typedef struct { + KSPROPERTY Property; + ULONG Mode; // IN: KSPROPERTY_TUNER_MODE + ULONG StandardsSupported; // KS_AnalogVideo_* (if TV or DSS) + ULONG MinFrequency; // Hz + ULONG MaxFrequency; // Hz + ULONG TuningGranularity; // Hz + ULONG NumberOfInputs; // count of inputs + ULONG SettlingTime; // milliSeconds + ULONG Strategy; // KS_TUNER_STRATEGY +} KSPROPERTY_TUNER_MODE_CAPS_S, *PKSPROPERTY_TUNER_MODE_CAPS_S; + +typedef struct { + KSPROPERTY Property; + ULONG Mode; // IN: KSPROPERTY_TUNER_MODE +} KSPROPERTY_TUNER_MODE_S, *PKSPROPERTY_TUNER_MODE_S; + +typedef struct { + KSPROPERTY Property; + ULONG Frequency; // Hz + ULONG LastFrequency; // Hz (last known good) + ULONG TuningFlags; // KS_TUNER_TUNING_FLAGS + ULONG VideoSubChannel; // DSS + ULONG AudioSubChannel; // DSS + ULONG Channel; // VBI decoders + ULONG Country; // VBI decoders +} KSPROPERTY_TUNER_FREQUENCY_S, *PKSPROPERTY_TUNER_FREQUENCY_S; + +typedef struct { + KSPROPERTY Property; + ULONG Standard; // KS_AnalogVideo_* +} KSPROPERTY_TUNER_STANDARD_S, *PKSPROPERTY_TUNER_STANDARD_S; + +typedef struct { + KSPROPERTY Property; + BOOL AutoDetect; // RW - specifies whether the driver is in auto-detect mode for the signal standard +} KSPROPERTY_TUNER_STANDARD_MODE_S, *PKSPROPERTY_TUNER_STANDARD_MODE_S; + +typedef struct { + KSPROPERTY Property; + ULONG InputIndex; // 0 to (n-1) inputs +} KSPROPERTY_TUNER_INPUT_S, *PKSPROPERTY_TUNER_INPUT_S; + +typedef struct { + KSPROPERTY Property; + ULONG CurrentFrequency; // Hz + ULONG PLLOffset; // if Strategy.KS_TUNER_STRATEGY_PLL + ULONG SignalStrength; // if Stretegy.KS_TUNER_STRATEGY_SIGNAL_STRENGTH + ULONG Busy; // TRUE if in the process of tuning +} KSPROPERTY_TUNER_STATUS_S, *PKSPROPERTY_TUNER_STATUS_S; + + +// +// Exhaustive Scanning tuner support definitions and interfaces +// + +// Definitions + +typedef enum _TunerDecoderLockType { + Tuner_LockType_None = 0x00, // Not locked on a signal. Can be returned at end of scan. + Tuner_LockType_Within_Scan_Sensing_Range = 0x01, // Signal is near by, not able to report exact frequency. Can be returned at end of scan. + Tuner_LockType_Locked = 0x02 // Fine tune signal lock established. Can be returned at end of scan. +} TunerLockType; + +// Data structures returned for KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS_S operations + +typedef struct { + ULONG Mode; // IN -KSPROPERTY_TUNER_MODE + ULONG StandardsSupported; // KS_AnalogVideo_* (defined in KS_AnalogVideoStandard) + ULONG MinFrequency; // R -Hz + ULONG MaxFrequency; // R -Hz + ULONG TuningGranularity; // R -Hz + ULONG SettlingTime; // R -milliSeconds + ULONG ScanSensingRange; // R -max range (Hz) in which tuner can detect presence of a signal + ULONG FineTuneSensingRange; // R -max range (Hz) in which tuner can detect actual frequency of a signal +}TUNER_ANALOG_CAPS_S, *PTUNER_ANALOG_CAPS_S; + +// ... +// More to come if new structures are needed for different network types. + +#define STATIC_EVENTSETID_TUNER\ + 0x6a2e0606L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0606-28e4-11d0-a18c-00a0c9118956", EVENTSETID_TUNER); +#define EVENTSETID_TUNER DEFINE_GUIDNAMED(EVENTSETID_TUNER) + +typedef enum { + KSEVENT_TUNER_CHANGED, + KSEVENT_TUNER_INITIATE_SCAN // initiate frequency scan +} KSEVENT_TUNER; + + +// Exhaustive Scanning operations + +// Determine if ES is possible with device +typedef struct { + KSPROPERTY Property; + BOOL fSupportsHardwareAssistedScanning; // R + ULONG SupportedBroadcastStandards; // R + PVOID GUIDBucket; // RW + ULONG lengthofBucket; // R +} KSPROPERTY_TUNER_SCAN_CAPS_S, *PKSPROPERTY_TUNER_SCAN_CAPS_S; + +// Get specific network type capabilities structure (such as TUNER_ANALOG_CAPS_S for example) +typedef struct { + KSPROPERTY Property; + GUID NetworkType; // R -one of the interested GUIDs returned in KSPROPERTY_TUNER_SCAN_CAPS_S + ULONG BufferSize; // R -size of the buffer; + PVOID NetworkTunerCapabilities; // RW -Buffer +}KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS_S, *PKSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS_S; + +// Obtain current scan operation status +typedef struct { + KSPROPERTY Property; + TunerLockType LockStatus; // R -none, within scan sensing range, or locked + ULONG CurrentFrequency; // R -current frequency +} KSPROPERTY_TUNER_SCAN_STATUS_S, *PKSPROPERTY_TUNER_SCAN_STATUS_S; + +// Start a scan +typedef struct { + KSEVENTDATA EventData; + ULONG StartFrequency; // W -initial frequency for the scan + ULONG EndFrequency; // W -final frequency for the scan +} KSEVENT_TUNER_INITIATE_SCAN_S, *PKSEVENT_TUNER_INITIATE_SCAN_S; + + + +// +// Kernel Streaming Video node type definitions +// + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +//=========================================================================== +// USB Video Class Definitions + +#define STATIC_KSNODETYPE_VIDEO_STREAMING \ + 0xDFF229E1L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E1-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_STREAMING); +#define KSNODETYPE_VIDEO_STREAMING DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_STREAMING) + +#define STATIC_KSNODETYPE_VIDEO_INPUT_TERMINAL \ + 0xDFF229E2L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E2-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_INPUT_TERMINAL); +#define KSNODETYPE_VIDEO_INPUT_TERMINAL DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_INPUT_TERMINAL) + +#define STATIC_KSNODETYPE_VIDEO_OUTPUT_TERMINAL \ + 0xDFF229E3L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E3-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_OUTPUT_TERMINAL); +#define KSNODETYPE_VIDEO_OUTPUT_TERMINAL DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_OUTPUT_TERMINAL) + +#define STATIC_KSNODETYPE_VIDEO_SELECTOR \ + 0xDFF229E4L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E4-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_SELECTOR); +#define KSNODETYPE_VIDEO_SELECTOR DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_SELECTOR) + +#define STATIC_KSNODETYPE_VIDEO_PROCESSING \ + 0xDFF229E5L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E5-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_PROCESSING); +#define KSNODETYPE_VIDEO_PROCESSING DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_PROCESSING) + +#define STATIC_KSNODETYPE_VIDEO_CAMERA_TERMINAL \ + 0xDFF229E6L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E6-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_CAMERA_TERMINAL); +#define KSNODETYPE_VIDEO_CAMERA_TERMINAL DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_CAMERA_TERMINAL) + +#define STATIC_KSNODETYPE_VIDEO_INPUT_MTT \ + 0xDFF229E7L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E7-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_INPUT_MTT); +#define KSNODETYPE_VIDEO_INPUT_MTT DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_INPUT_MTT) + +#define STATIC_KSNODETYPE_VIDEO_OUTPUT_MTT \ + 0xDFF229E8L, 0xF70F, 0x11D0, 0xB9, 0x17, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("DFF229E8-F70F-11D0-B917-00A0C9223196", KSNODETYPE_VIDEO_OUTPUT_MTT); +#define KSNODETYPE_VIDEO_OUTPUT_MTT DEFINE_GUIDNAMED(KSNODETYPE_VIDEO_OUTPUT_MTT) + +#endif // XP SP2 and later (chronologically) + +//=========================================================================== + + +#define STATIC_PROPSETID_VIDCAP_VIDEOENCODER\ + 0x6a2e0610L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0610-28e4-11d0-a18c-00a0c9118956", PROPSETID_VIDCAP_VIDEOENCODER); +#define PROPSETID_VIDCAP_VIDEOENCODER DEFINE_GUIDNAMED(PROPSETID_VIDCAP_VIDEOENCODER) + +typedef enum { + KSPROPERTY_VIDEOENCODER_CAPS, // R + KSPROPERTY_VIDEOENCODER_STANDARD, // RW + KSPROPERTY_VIDEOENCODER_COPYPROTECTION, // RW O + KSPROPERTY_VIDEOENCODER_CC_ENABLE, // RW O +} KSPROPERTY_VIDCAP_VIDEOENCODER; + +typedef struct { + KSPROPERTY Property; + LONG Value; // value to get or set + ULONG Flags; // + ULONG Capabilities; // +} KSPROPERTY_VIDEOENCODER_S, *PKSPROPERTY_VIDEOENCODER_S; + +//=========================================================================== + +#define STATIC_PROPSETID_VIDCAP_VIDEODECODER\ + 0xC6E13350L, 0x30AC, 0x11d0, 0xA1, 0x8C, 0x00, 0xA0, 0xC9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("C6E13350-30AC-11d0-A18C-00A0C9118956", PROPSETID_VIDCAP_VIDEODECODER); +#define PROPSETID_VIDCAP_VIDEODECODER DEFINE_GUIDNAMED(PROPSETID_VIDCAP_VIDEODECODER) + +typedef enum { + KSPROPERTY_VIDEODECODER_CAPS, // R + KSPROPERTY_VIDEODECODER_STANDARD, // RW + KSPROPERTY_VIDEODECODER_STATUS, // R + KSPROPERTY_VIDEODECODER_OUTPUT_ENABLE, // Rw O + KSPROPERTY_VIDEODECODER_VCR_TIMING, // RW O + KSPROPERTY_VIDEODECODER_STATUS2 // R +} KSPROPERTY_VIDCAP_VIDEODECODER; + +typedef enum { + KS_VIDEODECODER_FLAGS_CAN_DISABLE_OUTPUT = 0X0001, // VP Output can tri-stae + KS_VIDEODECODER_FLAGS_CAN_USE_VCR_LOCKING = 0X0002, // VCR PLL timings + KS_VIDEODECODER_FLAGS_CAN_INDICATE_LOCKED = 0X0004, // Can indicate valid signal +}KS_VIDEODECODER_FLAGS; + +typedef struct { + KSPROPERTY Property; + ULONG StandardsSupported; // KS_AnalogVideo_* + ULONG Capabilities; // KS_VIDEODECODER_FLAGS_* + ULONG SettlingTime; // milliseconds + ULONG HSyncPerVSync; // Number of HSync Pulses per VSync +} KSPROPERTY_VIDEODECODER_CAPS_S, *PKSPROPERTY_VIDEODECODER_CAPS_S; + +typedef struct { + KSPROPERTY Property; + ULONG NumberOfLines; // 525 or 625 lines detected + ULONG SignalLocked; // TRUE if signal is locked +} KSPROPERTY_VIDEODECODER_STATUS_S, *PKSPROPERTY_VIDEODECODER_STATUS_S; + +typedef struct { + KSPROPERTY Property; + ULONG NumberOfLines; // R - 525 or 625 lines detected + ULONG SignalLocked; // R - TRUE if signal is locked + ULONG ChromaLock; // R - TRUE if a chroma signal is present +} KSPROPERTY_VIDEODECODER_STATUS2_S, *PKSPROPERTY_VIDEODECODER_STATUS2_S; + +typedef struct { + KSPROPERTY Property; + ULONG Value; // Get or set a value +} KSPROPERTY_VIDEODECODER_S, *PKSPROPERTY_VIDEODECODER_S; + +#define STATIC_EVENTSETID_VIDEODECODER\ + 0x6a2e0621L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0621-28e4-11d0-a18c-00a0c9118956", EVENTSETID_VIDEODECODER); +#define EVENTSETID_VIDEODECODER DEFINE_GUIDNAMED(EVENTSETID_VIDEODECODER) + +typedef enum { + KSEVENT_VIDEODECODER_CHANGED +} KSEVENT_VIDEODECODER; + +//=========================================================================== + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define STATIC_KSEVENTSETID_CameraAsyncControl\ + 0x22A11754L, 0x9701, 0x4088, 0xB3, 0x3F, 0x6B, 0x9C, 0xBC, 0x52, 0xDF, 0x5E +DEFINE_GUIDSTRUCT("22A11754-9701-4088-B33F-6B9CBC52DF5E", KSEVENTSETID_CameraAsyncControl); +#define KSEVENTSETID_CameraAsyncControl DEFINE_GUIDNAMED(KSEVENTSETID_CameraAsyncControl) + +typedef enum { + KSEVENT_CAMERACONTROL_FOCUS, + KSEVENT_CAMERACONTROL_ZOOM +} KSEVENT_CAMERACONTROL; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#define STATIC_PROPSETID_VIDCAP_CAMERACONTROL\ + 0xC6E13370L, 0x30AC, 0x11d0, 0xa1, 0x8C, 0x00, 0xA0, 0xC9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("C6E13370-30AC-11d0-A18C-00A0C9118956", PROPSETID_VIDCAP_CAMERACONTROL); +#define PROPSETID_VIDCAP_CAMERACONTROL DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CAMERACONTROL) + +typedef enum { + KSPROPERTY_CAMERACONTROL_PAN, // RW O + KSPROPERTY_CAMERACONTROL_TILT, // RW O + KSPROPERTY_CAMERACONTROL_ROLL, // RW O + KSPROPERTY_CAMERACONTROL_ZOOM, // RW O + KSPROPERTY_CAMERACONTROL_EXPOSURE, // RW O + KSPROPERTY_CAMERACONTROL_IRIS, // RW O + KSPROPERTY_CAMERACONTROL_FOCUS // RW O + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + + , KSPROPERTY_CAMERACONTROL_SCANMODE // RW O + , KSPROPERTY_CAMERACONTROL_PRIVACY // RW O + , KSPROPERTY_CAMERACONTROL_PANTILT // RW O + , KSPROPERTY_CAMERACONTROL_PAN_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_TILT_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_ROLL_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_ZOOM_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_EXPOSURE_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_IRIS_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_FOCUS_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_PANTILT_RELATIVE // RW O + , KSPROPERTY_CAMERACONTROL_FOCAL_LENGTH // R O + , KSPROPERTY_CAMERACONTROL_AUTO_EXPOSURE_PRIORITY // RW O + +#endif // XP SP2 and later (chronologically) + +} KSPROPERTY_VIDCAP_CAMERACONTROL; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef enum { + KS_CAMERACONTROL_ASYNC_START = 0x0001, + KS_CAMERACONTROL_ASYNC_STOP = 0x0002, + KS_CAMERACONTROL_ASYNC_RESET = 0x0003 +} KS_CameraControlAsyncOperation; + +typedef struct { + KSPROPERTY Property; + LONG Value; // value to get or set + ULONG Flags; // KSPROPERTY_CAMERACONTROL_FLAGS_* + ULONG Capabilities; // KSPROPERTY_CAMERACONTROL_FLAGS_* + RECT FocusRect; +} KSPROPERTY_CAMERACONTROL_S_EX, *PKSPROPERTY_CAMERACONTROL_S_EX; +#endif + +typedef struct { + KSPROPERTY Property; + LONG Value; // value to get or set + ULONG Flags; // KSPROPERTY_CAMERACONTROL_FLAGS_* + ULONG Capabilities; // KSPROPERTY_CAMERACONTROL_FLAGS_* +} KSPROPERTY_CAMERACONTROL_S, *PKSPROPERTY_CAMERACONTROL_S; + +#define KSPROPERTY_CAMERACONTROL_FLAGS_AUTO 0X0001L +#define KSPROPERTY_CAMERACONTROL_FLAGS_MANUAL 0X0002L +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define KSPROPERTY_CAMERACONTROL_FLAGS_ASYNCHRONOUS 0X0004L +#endif + +#define KSPROPERTY_CAMERACONTROL_FLAGS_ABSOLUTE 0X0000L +#define KSPROPERTY_CAMERACONTROL_FLAGS_RELATIVE 0X0010L + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +typedef struct { + KSP_NODE NodeProperty; + LONG Value; // value to get or set + ULONG Flags; // KSPROPERTY_CAMERACONTROL_FLAGS_* + ULONG Capabilities; // KSPROPERTY_CAMERACONTROL_FLAGS_* +} KSPROPERTY_CAMERACONTROL_NODE_S, PKSPROPERTY_CAMERACONTROL_NODE_S; + +typedef struct { + KSPROPERTY Property; + LONG Value1; + ULONG Flags; + ULONG Capabilities; + LONG Value2; +} KSPROPERTY_CAMERACONTROL_S2, *PKSPROPERTY_CAMERACONTROL_S2; + +typedef struct { + KSP_NODE NodeProperty; + LONG Value1; + ULONG Flags; + ULONG Capabilities; + LONG Value2; +} KSPROPERTY_CAMERACONTROL_NODE_S2, *PKSPROPERTY_CAMERACONTROL_NODE_S2; + +typedef struct { + KSPROPERTY Property; + LONG lOcularFocalLength; + LONG lObjectiveFocalLengthMin; + LONG lObjectiveFocalLengthMax; +} KSPROPERTY_CAMERACONTROL_FOCAL_LENGTH_S, *PKSPROPERTY_CAMERACONTROL_FOCAL_LENGTH_S; + +typedef struct { + KSNODEPROPERTY NodeProperty; + LONG lOcularFocalLength; + LONG lObjectiveFocalLengthMin; + LONG lObjectiveFocalLengthMax; +} KSPROPERTY_CAMERACONTROL_NODE_FOCAL_LENGTH_S, *PKSPROPERTY_CAMERACONTROL_NODE_FOCAL_LENGTH_S; +#endif // XP SP2 and later (chronologically) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define STATIC_PROPSETID_VIDCAP_CAMERACONTROL_FLASH \ + 0x785e8f49, 0x63a2, 0x4144, 0xab, 0x70, 0xff, 0xb2, 0x78, 0xfa, 0x26, 0xce +DEFINE_GUIDSTRUCT("785E8F49-63A2-4144-AB70-FFB278FA26CE", PROPSETID_VIDCAP_CAMERACONTROL_FLASH ); +#define PROPSETID_VIDCAP_CAMERACONTROL_FLASH DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CAMERACONTROL_FLASH ) + +typedef enum { + KSPROPERTY_CAMERACONTROL_FLASH_PROPERTY_ID = 0 +} KSPROPERTY_CAMERACONTROL_FLASH; + +#define KSPROPERTY_CAMERACONTROL_FLASH_OFF 0x00000000L +#define KSPROPERTY_CAMERACONTROL_FLASH_ON 0x00000001L +#define KSPROPERTY_CAMERACONTROL_FLASH_AUTO 0x00000002L + +#define KSPROPERTY_CAMERACONTROL_FLASH_FLAGS_AUTO 0x00000001L +#define KSPROPERTY_CAMERACONTROL_FLASH_FLAGS_MANUAL 0x00000002L + +typedef struct { + ULONG Flash; + ULONG Capabilities; +} KSPROPERTY_CAMERACONTROL_FLASH_S, *PKSPROPERTY_CAMERACONTROL_FLASH_S; + +#define STATIC_PROPSETID_VIDCAP_CAMERACONTROL_VIDEO_STABILIZATION \ + 0x43964bd3, 0x7716, 0x404e, 0x8b, 0xe1, 0xd2, 0x99, 0xb2, 0xe, 0x50, 0xfd +DEFINE_GUIDSTRUCT("43964BD3-7716-404e-8BE1-D299B20E50FD", PROPSETID_VIDCAP_CAMERACONTROL_VIDEO_STABILIZATION); +#define PROPSETID_VIDCAP_CAMERACONTROL_VIDEO_STABILIZATION DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CAMERACONTROL_VIDEO_STABILIZATION) + +typedef enum { + KSPROPERTY_CAMERACONTROL_VIDEO_STABILIZATION_MODE_PROPERTY_ID = 0 +} KSPROPERTY_CAMERACONTROL_VIDEO_STABILIZATION_MODE; + +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_OFF 0x00000000L +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_HIGH 0x00000001L +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_MEDIUM 0x00000002L +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_LOW 0x00000003L +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_AUTO 0x00000004L + +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_FLAGS_AUTO 0x00000001L +#define KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_FLAGS_MANUAL 0x00000002L + +typedef struct { + ULONG VideoStabilizationMode; + ULONG Capabilities; +} KSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_S, *PKSPROPERTY_CAMERACONTROL_VIDEOSTABILIZATION_MODE_S; + +#define STATIC_PROPSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST \ + 0x9d12d198, 0xf86c, 0x4fed, 0xb0, 0x23, 0x5d, 0x87, 0x65, 0x3d, 0xa7, 0x93 +DEFINE_GUIDSTRUCT("9D12D198-F86C-4fed-B023-5D87653DA793", PROPSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST); +#define PROPSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST) + +typedef enum { + KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_PROPERTY_ID = 0 +} KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST; + +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_FLAGS_AUTO 0x00000001L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_FLAGS_MANUAL 0x00000002L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_FLAGS_ASYNC 0x80000000L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_CONFIG_FOCUS 0x00000100L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_CONFIG_EXPOSURE 0x00000200L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_CONFIG_WB 0x00000400L +#define KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_CONVERGEMODE 0x40000000L + +#define STATIC_EVENTSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST \ + 0x2FDFFC5D, 0xC732, 0x4BA6, 0xB5, 0xDF, 0x6B, 0x4D, 0x7F, 0xC8, 0x8B, 0x8B +DEFINE_GUIDSTRUCT("2FDFFC5D-C732-4BA6-B5DF-6B4D7FC88B8B", EVENTSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST); +#define EVENTSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST DEFINE_GUIDNAMED(EVENTSETID_VIDCAP_CAMERACONTROL_REGION_OF_INTEREST) + +typedef struct { + RECT FocusRect; + BOOL AutoFocusLock; + BOOL AutoExposureLock; + BOOL AutoWhitebalanceLock; + union { + ULONG Capabilities; + ULONG Configuration; + }; +} KSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_S, *PKSPROPERTY_CAMERACONTROL_REGION_OF_INTEREST_S; + +#define STATIC_PROPSETID_VIDCAP_CAMERACONTROL_IMAGE_PIN_CAPABILITY \ + 0x9d3d7bbf, 0x5c6d, 0x4138, 0xbb, 0x0, 0x58, 0x4e, 0xdd, 0x20, 0xf7, 0xc5 +DEFINE_GUIDSTRUCT("9D3D7BBF-5C6D-4138-BB00-584EDD20F7C5", PROPSETID_VIDCAP_CAMERACONTROL_IMAGE_PIN_CAPABILITY); +#define PROPSETID_VIDCAP_CAMERACONTROL_IMAGE_PIN_CAPABILITY DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CAMERACONTROL_IMAGE_PIN_CAPABILITY) + +typedef enum { + KSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY_PROPERTY_ID = 0 +} KSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY; + +#define KSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY_EXCLUSIVE_WITH_RECORD 0x00000001L +#define KSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY_SEQUENCE_EXCLUSIVE_WITH_RECORD 0x00000002L + +typedef struct { + ULONG Capabilities; + ULONG Reserved0; +} KSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY_S, *PKSPROPERTY_CAMERACONTROL_IMAGE_PIN_CAPABILITY_S; + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +typedef enum { + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOMODE, // 0 + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOFRAMERATE, // 1 + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOMAXFRAMERATE, // 2 + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOTRIGGERTIME, // 3 + KSPROPERTY_CAMERACONTROL_EXTENDED_WARMSTART, // 4 + KSPROPERTY_CAMERACONTROL_EXTENDED_MAXVIDFPS_PHOTORES, // 5 + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOTHUMBNAIL, // 6 + KSPROPERTY_CAMERACONTROL_EXTENDED_SCENEMODE, // 7 + KSPROPERTY_CAMERACONTROL_EXTENDED_TORCHMODE, // 8 + KSPROPERTY_CAMERACONTROL_EXTENDED_FLASHMODE, // 9 + KSPROPERTY_CAMERACONTROL_EXTENDED_OPTIMIZATIONHINT, // 10 + KSPROPERTY_CAMERACONTROL_EXTENDED_WHITEBALANCEMODE, // 11 + KSPROPERTY_CAMERACONTROL_EXTENDED_EXPOSUREMODE, // 12 + KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSMODE, // 13 + KSPROPERTY_CAMERACONTROL_EXTENDED_ISO, // 14 + KSPROPERTY_CAMERACONTROL_EXTENDED_FIELDOFVIEW, // 15 + KSPROPERTY_CAMERACONTROL_EXTENDED_EVCOMPENSATION, // 16 + KSPROPERTY_CAMERACONTROL_EXTENDED_CAMERAANGLEOFFSET, // 17 +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + KSPROPERTY_CAMERACONTROL_EXTENDED_METADATA, // 18 + KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSPRIORITY, // 19 + KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSSTATE, // 20 + KSPROPERTY_CAMERACONTROL_EXTENDED_ROI_CONFIGCAPS, // 21 + KSPROPERTY_CAMERACONTROL_EXTENDED_ROI_ISPCONTROL, // 22 + KSPROPERTY_CAMERACONTROL_EXTENDED_PHOTOCONFIRMATION, // 23 + KSPROPERTY_CAMERACONTROL_EXTENDED_ZOOM, // 24 + KSPROPERTY_CAMERACONTROL_EXTENDED_MCC, // 25 + KSPROPERTY_CAMERACONTROL_EXTENDED_ISO_ADVANCED, // 26 +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + KSPROPERTY_CAMERACONTROL_EXTENDED_VIDEOSTABILIZATION, // 27 + KSPROPERTY_CAMERACONTROL_EXTENDED_VFR, // 28 + KSPROPERTY_CAMERACONTROL_EXTENDED_FACEDETECTION, // 29 + KSPROPERTY_CAMERACONTROL_EXTENDED_VIDEOHDR, // 30 + KSPROPERTY_CAMERACONTROL_EXTENDED_HISTOGRAM, // 31 + KSPROPERTY_CAMERACONTROL_EXTENDED_OIS, // 32 + KSPROPERTY_CAMERACONTROL_EXTENDED_ADVANCEDPHOTO, // 33 + KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE, // 34 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) + KSPROPERTY_CAMERACONTROL_EXTENDED_FACEAUTH_MODE, // 35 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS1) + + KSPROPERTY_CAMERACONTROL_EXTENDED_SECURE_MODE, // 36 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + KSPROPERTY_CAMERACONTROL_EXTENDED_VIDEOTEMPORALDENOISING, // 37 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +#if (NTDDI_VERSION >= NTDDI_WIN10_19H1) + KSPROPERTY_CAMERACONTROL_EXTENDED_IRTORCHMODE, // 38 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_19H1) + +#if (NTDDI_VERSION >= NTDDI_WIN10_VB) + KSPROPERTY_CAMERACONTROL_EXTENDED_RELATIVEPANELOPTIMIZATION, // 39 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_VB) + +#if(NTDDI_VERSION >= NTDDI_WIN10_MN) + KSPROPERTY_CAMERACONTROL_EXTENDED_EYEGAZECORRECTION, // 40 + KSPROPERTY_CAMERACONTROL_EXTENDED_BACKGROUNDSEGMENTATION, // 41 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_MN) + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + KSPROPERTY_CAMERACONTROL_EXTENDED_DIGITALWINDOW_CONFIGCAPS, // 42 + KSPROPERTY_CAMERACONTROL_EXTENDED_DIGITALWINDOW, // 43 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_FE) + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) + KSPROPERTY_CAMERACONTROL_EXTENDED_FRAMERATE_THROTTLE, // 44 + KSPROPERTY_CAMERACONTROL_EXTENDED_FIELDOFVIEW2_CONFIGCAPS, // 45 + KSPROPERTY_CAMERACONTROL_EXTENDED_FIELDOFVIEW2, // 46 +#endif // (NTDDI_VERSION >= NTDDI_WIN11_ZN) + + KSPROPERTY_CAMERACONTROL_EXTENDED_END, // All new controls must be before this! + KSPROPERTY_CAMERACONTROL_EXTENDED_END2 = KSPROPERTY_CAMERACONTROL_EXTENDED_END +} KSPROPERTY_CAMERACONTROL_EXTENDED_PROPERTY; + + +#define STATIC_KSPROPERTYSETID_ExtendedCameraControl \ + 0x1CB79112, 0xC0D2, 0x4213, 0x9C, 0xA6, 0xCD, 0x4F, 0xDB, 0x92, 0x79, 0x72 +DEFINE_GUIDSTRUCT("1CB79112-C0D2-4213-9CA6-CD4FDB927972", KSPROPERTYSETID_ExtendedCameraControl); +#define KSPROPERTYSETID_ExtendedCameraControl DEFINE_GUIDNAMED(KSPROPERTYSETID_ExtendedCameraControl) + +#define STATIC_KSEVENTSETID_ExtendedCameraControl \ + 0x571C92C9, 0x13A2, 0x47E3, 0xA6, 0x49, 0xD2, 0xA7, 0x78, 0x16, 0x63, 0x84 +DEFINE_GUIDSTRUCT("571C92C9-13A2-47E3-A649-D2A778166384", KSEVENTSETID_ExtendedCameraControl); +#define KSEVENTSETID_ExtendedCameraControl DEFINE_GUIDNAMED(KSEVENTSETID_ExtendedCameraControl) + +#define KSCAMERA_EXTENDEDPROP_FILTERSCOPE 0xFFFFFFFF + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define KSCAMERA_EXTENDEDPROP_CAPS_RESERVED 0xFF00000000000000 + +#define STATIC_KSEVENTSETID_CameraEvent \ + 0x7899b2e0, 0x6b43, 0x4964, 0x9d, 0x2a, 0xa2, 0x1f, 0x40, 0x61, 0xf5, 0x76 +DEFINE_GUIDSTRUCT("7899B2E0-6B43-4964-9D2A-A21F4061F576", KSEVENTSETID_CameraEvent); +#define KSEVENTSETID_CameraEvent DEFINE_GUIDNAMED(KSEVENTSETID_CameraEvent) + +typedef enum { + KSEVENT_PHOTO_SAMPLE_SCANNED, +} KSEVENT_CAMERAEVENT; + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +// Property set implemented exclusively by Windows Studio camera effect pack (also known as MEP) +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) +#define STATIC_KSPROPERTYSETID_WindowsCameraEffect \ + 0x1666d655, 0x21a6, 0x4982, 0x97, 0x28, 0x52, 0xc3, 0x9e, 0x86, 0x9f, 0x90 + DEFINE_GUIDSTRUCT("1666D655-21A6-4982-9728-52C39E869F90", KSPROPERTYSETID_WindowsCameraEffect); +#define KSPROPERTYSETID_WindowsCameraEffect DEFINE_GUIDNAMED(KSPROPERTYSETID_WindowsCameraEffect) +#endif // (NTDDI_VERSION >= NTDDI_WIN11_ZN) + + +#define KSCAMERA_EXTENDEDPROP_CAPS_ASYNCCONTROL 0x8000000000000000 +#define KSCAMERA_EXTENDEDPROP_CAPS_CANCELLABLE 0x4000000000000000 + +#define KSCAMERA_EXTENDEDPROP_FLAG_CANCELOPERATION 0x8000000000000000 + +// This mask represents the reserved bits for all capability flags. All EXTENDEDPROP capability +// flags defined below must NOT use the upper 8 bits. +// Same applies to the flags. +#define KSCAMERA_EXTENDEDPROP_CAPS_MASK 0xFF00000000000000 +#define KSCAMERA_EXTENDEDPROP_FLAG_MASK 0xFF00000000000000 + +#define KSCAMERA_EXTENDEDPROP_PHOTOMODE_NORMAL 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_PHOTOMODE_SEQUENCE 0x0000000000000001 + +#define KSCAMERA_EXTENDEDPROP_WARMSTART_MODE_DISABLED 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_WARMSTART_MODE_ENABLED 0x0000000000000001 + +#define KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_DISABLE 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_2X 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_4X 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_8X 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_PHOTOTHUMBNAIL_16X 0x0000000000000008 + +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_AUTO 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_MACRO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_PORTRAIT 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_SPORT 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_SNOW 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_NIGHT 0x0000000000000010 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_BEACH 0x0000000000000020 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_SUNSET 0x0000000000000040 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_CANDLELIGHT 0x0000000000000080 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_LANDSCAPE 0x0000000000000100 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_NIGHTPORTRAIT 0x0000000000000200 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_BACKLIT 0x0000000000000400 +#define KSCAMERA_EXTENDEDPROP_SCENEMODE_MANUAL 0x0080000000000000 + +#define KSCAMERA_EXTENDEDPROP_VIDEOTORCH_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON_ADJUSTABLEPOWER 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_FLASH_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_FLASH_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_FLASH_ON_ADJUSTABLEPOWER 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_FLASH_AUTO 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_FLASH_AUTO_ADJUSTABLEPOWER 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_FLASH_REDEYEREDUCTION 0x0000000000000010 +#define KSCAMERA_EXTENDEDPROP_FLASH_SINGLEFLASH 0x0000000000000020 +#define KSCAMERA_EXTENDEDPROP_FLASH_MULTIFLASHSUPPORTED 0x0000000000000040 +#define KSCAMERA_EXTENDEDPROP_FLASH_MODE_MASK (KSCAMERA_EXTENDEDPROP_FLASH_ON|\ + KSCAMERA_EXTENDEDPROP_FLASH_ON_ADJUSTABLEPOWER|\ + KSCAMERA_EXTENDEDPROP_FLASH_AUTO|\ + KSCAMERA_EXTENDEDPROP_FLASH_AUTO_ADJUSTABLEPOWER) + + +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_PHOTO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_VIDEO 0x0000000000000002 + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_DEFAULT 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_QUALITY 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_LATENCY 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_POWER 0x0000000000000010 + +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_PERF_MASK (KSCAMERA_EXTENDEDPROP_OPTIMIZATION_QUALITY| \ + KSCAMERA_EXTENDEDPROP_OPTIMIZATION_LATENCY| \ + KSCAMERA_EXTENDEDPROP_OPTIMIZATION_POWER) + +#define KSCAMERA_EXTENDEDPROP_OPTIMIZATION_PRIMARYUSE_MASK (KSCAMERA_EXTENDEDPROP_OPTIMIZATION_PHOTO| \ + KSCAMERA_EXTENDEDPROP_OPTIMIZATION_VIDEO) + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK 0x0000000000000004 + +// This combines the generic Video Proc bits shared by all video proc controls. +#define KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MASK (KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO|\ + KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL|\ + KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK) + +typedef enum { + KSCAMERA_EXTENDEDPROP_WHITEBALANCE_TEMPERATURE = 1, + KSCAMERA_EXTENDEDPROP_WHITEBALANCE_PRESET +} KSCAMERA_EXTENDEDPROP_WHITEBALANCE_MODE; + +typedef enum { + KSCAMERA_EXTENDEDPROP_WBPRESET_CLOUDY = 1, + KSCAMERA_EXTENDEDPROP_WBPRESET_DAYLIGHT, + KSCAMERA_EXTENDEDPROP_WBPRESET_FLASH, + KSCAMERA_EXTENDEDPROP_WBPRESET_FLUORESCENT, + KSCAMERA_EXTENDEDPROP_WBPRESET_TUNGSTEN, + KSCAMERA_EXTENDEDPROP_WBPRESET_CANDLELIGHT, +} KSCAMERA_EXTENDEDPROP_WBPRESET; + +#define KSCAMERA_EXTENDEDPROP_FOCUS_CONTINUOUS 0x0000000000000100 + +// Focus control extends the generic video proc mask by adding the continous flag. +#define KSCAMERA_EXTENDEDPROP_FOCUS_MODE_MASK (KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MASK| \ + KSCAMERA_EXTENDEDPROP_FOCUS_CONTINUOUS) + +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_MACRO 0x0000000000010000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_NORMAL 0x0000000000020000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_FULLRANGE 0x0000000000040000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_INFINITY 0x0000000000080000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_HYPERFOCAL 0x0000000000100000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_MASK (KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_MACRO| \ + KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_NORMAL| \ + KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_FULLRANGE| \ + KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_INFINITY| \ + KSCAMERA_EXTENDEDPROP_FOCUS_RANGE_HYPERFOCAL) + + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +// Spare bits 0x200000 - 0x800000 in case of future range expansion +#define KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_INFINITY 0x0000000001000000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_HYPERFOCAL 0x0000000002000000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_NEAREST 0x0000000004000000 +#define KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_MASK (KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_INFINITY| \ + KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_HYPERFOCAL| \ + KSCAMERA_EXTENDEDPROP_FOCUS_DISTANCE_NEAREST) +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + + + +#define KSCAMERA_EXTENDEDPROP_ISO_AUTO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_ISO_50 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_ISO_80 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_ISO_100 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_ISO_200 0x0000000000000010 +#define KSCAMERA_EXTENDEDPROP_ISO_400 0x0000000000000020 +#define KSCAMERA_EXTENDEDPROP_ISO_800 0x0000000000000040 +#define KSCAMERA_EXTENDEDPROP_ISO_1600 0x0000000000000080 +#define KSCAMERA_EXTENDEDPROP_ISO_3200 0x0000000000000100 +#define KSCAMERA_EXTENDEDPROP_ISO_6400 0x0000000000000200 +#define KSCAMERA_EXTENDEDPROP_ISO_12800 0x0000000000000400 +#define KSCAMERA_EXTENDEDPROP_ISO_25600 0x0000000000000800 + + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define KSCAMERA_EXTENDEDPROP_FOCUS_CONTINUOUSLOCK 0x0000000000000200 +#define KSCAMERA_EXTENDEDPROP_FOCUS_UNLOCK 0x0000000000000400 +#define KSCAMERA_EXTENDEDPROP_FOCUS_DRIVERFALLBACK_OFF 0x0000000000000800 +#define KSCAMERA_EXTENDEDPROP_FOCUS_REGIONBASED 0x0000000000001000 + +#define KSCAMERA_EXTENDEDPROP_FOCUS_MODE_ADVANCED_MASK (KSCAMERA_EXTENDEDPROP_FOCUS_CONTINUOUSLOCK| \ + KSCAMERA_EXTENDEDPROP_FOCUS_UNLOCK| \ + KSCAMERA_EXTENDEDPROP_FOCUS_DRIVERFALLBACK_OFF| \ + KSCAMERA_EXTENDEDPROP_FOCUS_REGIONBASED) + +#define KSCAMERA_EXTENDEDPROP_ISO_MANUAL 0x0080000000000000 + +#define KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_ON 0x0000000000000080 +#define KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_AUTO 0x0000000000000100 +#define KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_MASK (KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_ON|\ + KSCAMERA_EXTENDEDPROP_FLASH_ASSISTANT_AUTO) + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + + +#define KSCAMERA_EXTENDEDPROP_EVCOMP_SIXTHSTEP 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_EVCOMP_QUARTERSTEP 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_EVCOMP_THIRDSTEP 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_EVCOMP_HALFSTEP 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_EVCOMP_FULLSTEP 0x0000000000000010 + +typedef enum { + KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_CLEAR, + KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_SET, +} KSPROPERTY_CAMERA_PHOTOTRIGGERTIME_FLAGS; + +typedef struct tagKSCAMERA_EXTENDEDPROP_HEADER { + ULONG Version; + ULONG PinId; + ULONG Size; + ULONG Result; + ULONGLONG Flags; + ULONGLONG Capability; +} KSCAMERA_EXTENDEDPROP_HEADER, *PKSCAMERA_EXTENDEDPROP_HEADER; + +typedef struct tagKSCAMERA_EXTENDEDPROP_VALUE { + union + { + double dbl; + ULONGLONG ull; + ULONG ul; + ULARGE_INTEGER ratio; + LONG l; + LONGLONG ll; + } Value; +} KSCAMERA_EXTENDEDPROP_VALUE, *PKSCAMERA_EXTENDEDPROP_VALUE; + +// This is the payload structure fo the Maximum video sensor frame rate possible +// based on the photo resolution being programmed on the sensor. The PhotoRes fields +// are provided by the application, the preview/capture FPS fields are filled in +// by the driver to indicate the maximum sensor frame rate. +typedef struct tagKSCAMERA_MAXVIDEOFPS_FORPHOTORES +{ + ULONG PhotoResWidth; + ULONG PhotoResHeight; + ULONG PreviewFPSNum; + ULONG PreviewFPSDenom; + ULONG CaptureFPSNum; + ULONG CaptureFPSDenom; +} KSCAMERA_MAXVIDEOFPS_FORPHOTORES, *PKSCAMERA_MAXVIDEOFPS_FORPHOTORES; + + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define KSCAMERA_EXTENDEDPROP_PHOTOMODE_SEQUENCE_SUB_NONE 0x00000000 +#define KSCAMERA_EXTENDEDPROP_PHOTOMODE_SEQUENCE_SUB_VARIABLE 0x00000001 + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + + +typedef struct tagKSCAMERA_EXTENDEDPROP_PHOTOMODE { + ULONG RequestedHistoryFrames; + ULONG MaxHistoryFrames; + ULONG SubMode; + ULONG Reserved; +} KSCAMERA_EXTENDEDPROP_PHOTOMODE, *PKSCAMERA_EXTENDEDPROP_PHOTOMODE; + +typedef struct tagKSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING { + ULONG Mode; + LONG Min; + LONG Max; + LONG Step; + KSCAMERA_EXTENDEDPROP_VALUE VideoProc; + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING, *PKSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING; + +typedef struct tagKSCAMERA_EXTENDEDPROP_EVCOMPENSATION { + ULONG Mode; + LONG Min; + LONG Max; + LONG Value; + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_EVCOMPENSATION, *PKSCAMERA_EXTENDEDPROP_EVCOMPENSATION; + +typedef struct tagKSCAMERA_EXTENDEDPROP_FIELDOFVIEW { + ULONG NormalizedFocalLengthX; + ULONG NormalizedFocalLengthY; + ULONG Flag; + ULONG Reserved; +} KSCAMERA_EXTENDEDPROP_FIELDOFVIEW, *PKSCAMERA_EXTENDEDPROP_FIELDOFVIEW; + +typedef struct tagKSCAMERA_EXTENDEDPROP_CAMERAOFFSET { + LONG PitchAngle; + LONG YawAngle; + ULONG Flag; + ULONG Reserved; +} KSCAMERA_EXTENDEDPROP_CAMERAOFFSET, *PKSCAMERA_EXTENDEDPROP_CAMERAOFFSET; + + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +// Metadata +typedef struct tagKSCAMERA_EXTENDEDPROP_METADATAINFO { + LONG BufferAlignment; // Required alignment for metadata buffer + ULONG MaxMetadataBufferSize; // Required metadata buffer size +} KSCAMERA_EXTENDEDPROP_METADATAINFO, *PKSCAMERA_EXTENDEDPROP_METADATAINFO; + +typedef enum { + KSCAMERA_EXTENDEDPROP_MetadataAlignment_16 = 4, // Aligned at 16 bytes + KSCAMERA_EXTENDEDPROP_MetadataAlignment_32, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_64, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_128, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_256, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_512, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_1024, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_2048, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_4096, + KSCAMERA_EXTENDEDPROP_MetadataAlignment_8192 +} KSCAMERA_EXTENDEDPROP_MetadataAlignment; + +#define KSCAMERA_EXTENDEDPROP_METADATA_MEMORYTYPE_MASK 0x00000000000000FF + +#define KSCAMERA_EXTENDEDPROP_METADATA_SYSTEMMEMORY 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_METADATA_ALIGNMENTREQUIRED 0x0000000000000100 + +typedef enum { + MetadataId_Standard_Start = 1, + MetadataId_PhotoConfirmation = MetadataId_Standard_Start, + MetadataId_UsbVideoHeader, + MetadataId_CaptureStats, + MetadataId_CameraExtrinsics, + MetadataId_CameraIntrinsics, + MetadataId_FrameIllumination, + MetadataId_DigitalWindow, + MetadataId_BackgroundSegmentationMask, + MetadataId_Standard_End = MetadataId_BackgroundSegmentationMask, + MetadataId_Custom_Start = 0x80000000, +} KSCAMERA_MetadataId; + +typedef struct tagKSCAMERA_METADATA_ITEMHEADER { + ULONG MetadataId; + ULONG Size; // Size of this header + metadata payload following +} KSCAMERA_METADATA_ITEMHEADER, *PKSCAMERA_METADATA_ITEMHEADER; + +typedef struct tagKSCAMERA_METADATA_PHOTOCONFIRMATION { + KSCAMERA_METADATA_ITEMHEADER Header; + ULONG PhotoConfirmationIndex; + ULONG Reserved; +}KSCAMERA_METADATA_PHOTOCONFIRMATION, *PKSCAMERA_METADATA_PHOTOCONFIRMATION; + +typedef struct tagKSCAMERA_METADATA_FRAMEILLUMINATION { + KSCAMERA_METADATA_ITEMHEADER Header; + ULONG Flags; + ULONG Reserved; +}KSCAMERA_METADATA_FRAMEILLUMINATION, *PKSCAMERA_METADATA_FRAMEILLUMINATION; + +#define KSCAMERA_METADATA_FRAMEILLUMINATION_FLAG_ON 0x00000001 + +typedef struct tagKSCAMERA_METADATA_CAPTURESTATS { + KSCAMERA_METADATA_ITEMHEADER Header; + ULONG Flags; + ULONG Reserved; + ULONGLONG ExposureTime; + ULONGLONG ExposureCompensationFlags; + LONG ExposureCompensationValue; + ULONG IsoSpeed; + ULONG FocusState; + ULONG LensPosition; // a.k.a Focus + ULONG WhiteBalance; + ULONG Flash; + ULONG FlashPower; + ULONG ZoomFactor; + ULONGLONG SceneMode; + ULONGLONG SensorFramerate; +}KSCAMERA_METADATA_CAPTURESTATS, *PKSCAMERA_METADATA_CAPTURESTATS; + +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_EXPOSURETIME 0x00000001 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_EXPOSURECOMPENSATION 0x00000002 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_ISOSPEED 0x00000004 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_FOCUSSTATE 0x00000008 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_LENSPOSITION 0x00000010 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_WHITEBALANCE 0x00000020 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_FLASH 0x00000040 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_FLASHPOWER 0x00000080 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_ZOOMFACTOR 0x00000100 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_SCENEMODE 0x00000200 +#define KSCAMERA_METADATA_CAPTURESTATS_FLAG_SENSORFRAMERATE 0x00000400 + + +// Focus Priority +#define KSCAMERA_EXTENDEDPROP_FOCUSPRIORITY_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_FOCUSPRIORITY_ON 0x0000000000000001 + +// Focus State +typedef enum +{ + KSCAMERA_EXTENDEDPROP_FOCUSSTATE_UNINITIALIZED = 0, + KSCAMERA_EXTENDEDPROP_FOCUSSTATE_LOST, + KSCAMERA_EXTENDEDPROP_FOCUSSTATE_SEARCHING, + KSCAMERA_EXTENDEDPROP_FOCUSSTATE_FOCUSED, + KSCAMERA_EXTENDEDPROP_FOCUSSTATE_FAILED, +} KSCAMERA_EXTENDEDPROP_FOCUSSTATE; + +// Extended ROI +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPSHEADER { + ULONG Size; // Size of this header + all _CONFIGCAPS structures followed + ULONG ConfigCapCount; // Number of _CONFIGCAPS structures followed + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPSHEADER, *PKSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPSHEADER; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPS { + ULONG ControlId; // ISP control ID (focus, exposure, or white balance) + ULONG MaxNumberOfROIs; // Max ROIs supported for this ISP control + ULONGLONG Capability; // Caps for this ISP control +} KSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPS, *PKSCAMERA_EXTENDEDPROP_ROI_CONFIGCAPS; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_ISPCONTROLHEADER { + ULONG Size; // Size of this header + all _ ISPCONTROL + all _RECTINFO + ULONG ControlCount; // Number of ISP controls. 0 indicating clear all ROIs + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_ISPCONTROLHEADER, *PKSCAMERA_EXTENDEDPROP_ROI_ISPCONTROLHEADER; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_ISPCONTROL { + ULONG ControlId; // ISP control ID (focus, exposure, or white balance) + ULONG ROICount; // Number of ROIs associated with this ISP control + ULONG Result; // Error results of the last SET operation for this ISP control + ULONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_ISPCONTROL, *PKSCAMERA_EXTENDEDPROP_ROI_ISPCONTROL; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_INFO { + RECT Region; // Relative coordinates on the frame that face detection is running (Q31 format) + ULONGLONG Flags; // VIDEOPROCFLAG flags indicating the op mode for the ISP control. Default is 0 for focus + LONG Weight; // Weight of the region (0 -100) + LONG RegionOfInterestType; // KSCAMERA_EXTENDEDPROP_ROITYPE_FACE, if the region is a face; Unknown otherwise +} KSCAMERA_EXTENDEDPROP_ROI_INFO, *PKSCAMERA_EXTENDEDPROP_ROI_INFO; + +typedef enum +{ + KSCAMERA_EXTENDEDPROP_ROITYPE_UNKNOWN = 0, + KSCAMERA_EXTENDEDPROP_ROITYPE_FACE, +} KSCAMERA_EXTENDEDPROP_ROITYPE; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_WHITEBALANCE { + KSCAMERA_EXTENDEDPROP_ROI_INFO ROIInfo; // Must be the first field + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_WHITEBALANCE, *PKSCAMERA_EXTENDEDPROP_ROI_WHITEBALANCE; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_EXPOSURE { + KSCAMERA_EXTENDEDPROP_ROI_INFO ROIInfo; // Must be the first field + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_EXPOSURE, *PKSCAMERA_EXTENDEDPROP_ROI_EXPOSURE; + +typedef struct tagKSCAMERA_EXTENDEDPROP_ROI_FOCUS { + KSCAMERA_EXTENDEDPROP_ROI_INFO ROIInfo; // Must be the first field + ULONGLONG Reserved; +} KSCAMERA_EXTENDEDPROP_ROI_FOCUS, *PKSCAMERA_EXTENDEDPROP_ROI_FOCUS; + +// Photo confirmation (aka still confirmation) +#define KSCAMERA_EXTENDEDPROP_PHOTOCONFIRMATION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_PHOTOCONFIRMATION_ON 0x0000000000000001 + +// +// Per Frame Settings +// +#define STATIC_KSPROPERTYSETID_PerFrameSettingControl \ + 0xf1f3e261, 0xdee6, 0x4537, 0xbf, 0xf5, 0xee, 0x20, 0x6d, 0xb5, 0x4a, 0xac +DEFINE_GUIDSTRUCT("F1F3E261-DEE6-4537-BFF5-EE206DB54AAC", KSPROPERTYSETID_PerFrameSettingControl); +#define KSPROPERTYSETID_PerFrameSettingControl DEFINE_GUIDNAMED(KSPROPERTYSETID_PerFrameSettingControl) + +typedef enum { + KSPROPERTY_CAMERACONTROL_PERFRAMESETTING_CAPABILITY = 0, + KSPROPERTY_CAMERACONTROL_PERFRAMESETTING_SET, + KSPROPERTY_CAMERACONTROL_PERFRAMESETTING_CLEAR +} KSPROPERTY_CAMERACONTROL_PERFRAMESETTING_PROPERTY; + +#define KSCAMERA_PERFRAMESETTING_AUTO 0x0000000100000000 +#define KSCAMERA_PERFRAMESETTING_MANUAL 0x0000000200000000 + +typedef enum { + KSCAMERA_PERFRAMESETTING_ITEM_EXPOSURE_TIME = 1, + KSCAMERA_PERFRAMESETTING_ITEM_FLASH, + KSCAMERA_PERFRAMESETTING_ITEM_EXPOSURE_COMPENSATION, + KSCAMERA_PERFRAMESETTING_ITEM_ISO, + KSCAMERA_PERFRAMESETTING_ITEM_FOCUS, + KSCAMERA_PERFRAMESETTING_ITEM_PHOTOCONFIRMATION, + KSCAMERA_PERFRAMESETTING_ITEM_CUSTOM +} KSCAMERA_PERFRAMESETTING_ITEM_TYPE; + +typedef struct { + ULONG Size; + ULONG Type; // KSCAMERA_PERFRAMESETTING_ITEM_TYPE + ULONGLONG Flags; // Supported Flags +} KSCAMERA_PERFRAMESETTING_CAP_ITEM_HEADER, *PKSCAMERA_PERFRAMESETTING_CAP_ITEM_HEADER; + +typedef struct { + ULONG Size; + ULONG ItemCount; + ULONGLONG Flags; +} KSCAMERA_PERFRAMESETTING_CAP_HEADER, *PKSCAMERA_PERFRAMESETTING_CAP_HEADER; + +typedef struct { + ULONG Size; + ULONG Reserved; + GUID Id; +} KSCAMERA_PERFRAMESETTING_CUSTOM_ITEM, *PKSCAMERA_PERFRAMESETTING_CUSTOM_ITEM; + +typedef struct { + ULONG Size; + ULONG Type; // KSCAMERA_PERFRAMESETTING_ITEM_TYPE + ULONGLONG Flags; +} KSCAMERA_PERFRAMESETTING_ITEM_HEADER, *PKSCAMERA_PERFRAMESETTING_ITEM_HEADER; + +typedef struct { + ULONG Size; + ULONG Id; + ULONG ItemCount; + ULONG Reserved; +} KSCAMERA_PERFRAMESETTING_FRAME_HEADER, *PKSCAMERA_PERFRAMESETTING_FRAME_HEADER; + +typedef struct { + ULONG Size; + ULONG FrameCount; + GUID Id; + ULONGLONG Flags; + ULONG LoopCount; + ULONG Reserved; +} KSCAMERA_PERFRAMESETTING_HEADER, *PKSCAMERA_PERFRAMESETTING_HEADER; + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#define KSCAMERA_EXTENDEDPROP_VIDEOSTABILIZATION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_VIDEOSTABILIZATION_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_VIDEOSTABILIZATION_AUTO 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_VFR_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_VFR_ON 0x0000000000000001 + +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_PREVIEW 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_VIDEO 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_PHOTO 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_BLINK 0x0000000000000008 +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_SMILE 0x0000000000000010 + +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_MASK (KSCAMERA_EXTENDEDPROP_FACEDETECTION_PREVIEW| \ + KSCAMERA_EXTENDEDPROP_FACEDETECTION_VIDEO| \ + KSCAMERA_EXTENDEDPROP_FACEDETECTION_PHOTO) + +#define KSCAMERA_EXTENDEDPROP_FACEDETECTION_ADVANCED_MASK (KSCAMERA_EXTENDEDPROP_FACEDETECTION_BLINK| \ + KSCAMERA_EXTENDEDPROP_FACEDETECTION_SMILE) + +#define KSCAMERA_EXTENDEDPROP_VIDEOHDR_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_VIDEOHDR_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_VIDEOHDR_AUTO 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_HISTOGRAM_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_HISTOGRAM_ON 0x0000000000000001 + +#define KSCAMERA_EXTENDEDPROP_OIS_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_OIS_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_OIS_AUTO 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_ADVANCEDPHOTO_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_ADVANCEDPHOTO_AUTO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_ADVANCEDPHOTO_HDR 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_ADVANCEDPHOTO_FNF 0x0000000000000004 +#define KSCAMERA_EXTENDEDPROP_ADVANCEDPHOTO_ULTRALOWLIGHT 0x0000000000000008 + +#define KSCAMERA_EXTENDEDPROP_ZOOM_DEFAULT 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_ZOOM_DIRECT 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_ZOOM_SMOOTH 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION 0x0000000000000004 + +#define KSCAMERA_EXTENDEDPROP_SECUREMODE_DISABLED 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_SECUREMODE_ENABLED 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_VIDEOTEMPORALDENOISING_AUTO 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_VIDEOTEMPORALDENOISING_OFF 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_VIDEOTEMPORALDENOISING_ON 0x0000000000000004 + +#define KSCAMERA_EXTENDEDPROP_IRTORCHMODE_OFF 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_IRTORCHMODE_ALWAYS_ON 0x0000000000000002 +#define KSCAMERA_EXTENDEDPROP_IRTORCHMODE_ALTERNATING_FRAME_ILLUMINATION 0x0000000000000004 + +#define KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_ON 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_DYNAMIC 0x0000000000000002 + +#define KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_MASK (KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_ON| \ + KSCAMERA_EXTENDEDPROP_RELATIVEPANELOPTIMIZATION_DYNAMIC) + + +#define KSCAMERA_EXTENDEDPROP_EYEGAZECORRECTION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_EYEGAZECORRECTION_ON 0x0000000000000001 +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +#define KSCAMERA_EXTENDEDPROP_EYEGAZECORRECTION_STARE 0x0000000000000002 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) + +#define KSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_BLUR 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_MASK 0x0000000000000002 +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +#define KSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_SHALLOWFOCUS 0x0000000000000004 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) + +// Digital Window Framing Flags +#define KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_MANUAL 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_AUTOFACEFRAMING 0x0000000000000001 +#define KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_MASK (KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_MANUAL | \ + KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_AUTOFACEFRAMING) + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) + +// Dynamic Framerate Throttle Flags +#define KSCAMERA_EXTENDEDPROP_FRAMERATE_THROTTLE_OFF 0x0000000000000000 +#define KSCAMERA_EXTENDEDPROP_FRAMERATE_THROTTLE_ON 0x0000000000000001 + +#endif // (NTDDI_VERSION >= NTDDI_WIN11_ZN) + +// Digital Window Region +typedef struct tagKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_SETTING { + LONG OriginX; // in Q24 + LONG OriginY; // in Q24 + LONG WindowSize; // in Q24 + ULONG Reserved; +} KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_SETTING, *PKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_SETTING; + +typedef struct tagKSCAMERA_METADATA_DIGITALWINDOW { + KSCAMERA_METADATA_ITEMHEADER Header; + KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_SETTING Window; +}KSCAMERA_METADATA_DIGITALWINDOW, *PKSCAMERA_METADATA_DIGITALWINDOW; + +// Digital Window Capabilities +typedef struct tagKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPSHEADER { + ULONG Size; // Size of this header + all _CONFIGCAPS structures followed + ULONG Count; // Number of _CONFIGCAPS structures followed +} KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPSHEADER, *PKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPSHEADER; + +typedef struct tagKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPS { + LONG ResolutionX; // Output width in pixels + LONG ResolutionY; // Output height in pixels + LONG PorchTop; // Upper porch region in Q24 + LONG PorchLeft; // Left-most porch region in Q24 + LONG PorchBottom; // Lower porch region in Q24 + LONG PorchRight; // Right-most porch region in Q24 + LONG NonUpscalingWindowSize; // Q24 value to get no scaling + LONG MinWindowSize; // Smallest legal WindowSize + LONG MaxWindowSize; // Largest legal WindowSize + LONG Reserved; // Reserved +} KSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPS, *PKSCAMERA_EXTENDEDPROP_DIGITALWINDOW_CONFIGCAPS; + +#if (NTDDI_VERSION >= NTDDI_WIN11_ZN) + + +typedef struct tagKSCAMERA_EXTENDEDPROP_FIELDOFVIEW2_CONFIGCAPS { + WORD DefaultDiagonalFieldOfViewInDegrees; // This is the default Field of View value in degrees. + WORD DiscreteFoVStopsCount; // Count of used entries in DiscreteFoVStops array. + WORD DiscreteFoVStops[360]; // Descending list of FoV Stops in degrees. + ULONG Reserved; // For 8-byte size align +} KSCAMERA_EXTENDEDPROP_FIELDOFVIEW2_CONFIGCAPS, *PKSCAMERA_EXTENDEDPROP_FIELDOFVIEW2_CONFIGCAPS; + +#endif // (NTDDI_VERSION >= NTDDI_WIN11_ZN) + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) + +typedef struct tagKSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_CONFIGCAPS { + // Output width and height in pixels + SIZE Resolution; + + // The maximum frame rate the driver can accommodate for achieving + // background segmentation for each frame corresponding to Resolution + struct + { + LONG Numerator; + LONG Denominator; + } MaxFrameRate; + + // The width and height of the mask produced when streaming + // with a MediaType corresponding to Resolution and MaxFrameRate + SIZE MaskResolution; + + // Optional subtype for which this configuration capability applies. If left + // to zero, all streams conforming the Resolution and MaxFrameRate will support + // background segmentation with the specified MaskResolution. + GUID SubType; + +} KSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_CONFIGCAPS, *PKSCAMERA_EXTENDEDPROP_BACKGROUNDSEGMENTATION_CONFIGCAPS; + +typedef struct tagKSCAMERA_METADATA_BACKGROUNDSEGMENTATIONMASK { + KSCAMERA_METADATA_ITEMHEADER Header; + RECT MaskCoverageBoundingBox; + SIZE MaskResolution; + RECT ForegroundBoundingBox; + BYTE MaskData[1]; // Array of mask data of dimension MaskResolution.cx * MaskResolution.cy +}KSCAMERA_METADATA_BACKGROUNDSEGMENTATIONMASK, *PKSCAMERA_METADATA_BACKGROUNDSEGMENTATIONMASK; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO) + +typedef struct _KSCAMERA_EXTENDEDPROP_PROFILE +{ + GUID ProfileId; + UINT32 Index; + UINT32 Reserved; +} KSCAMERA_EXTENDEDPROP_PROFILE, *PKSCAMERA_EXTENDEDPROP_PROFILE; + +#define STATIC_KSCAMERAPROFILE_Legacy \ + 0xB4894D81, 0x62B7, 0x4EEC, 0x87, 0x40, 0x80, 0x65, 0x8C, 0x4A, 0x9D, 0x3E +DEFINE_GUIDSTRUCT("B4894D81-62B7-4EEC-8740-80658C4A9D3E", KSCAMERAPROFILE_Legacy); +#define KSCAMERAPROFILE_Legacy DEFINE_GUIDNAMED(KSCAMERAPROFILE_Legacy) + +#define STATIC_KSCAMERAPROFILE_VideoRecording \ + 0xA0E517E8, 0x8F8C, 0x4F6F, 0x9A, 0x57, 0x46, 0xFC, 0x2F, 0x64, 0x7E, 0xC0 +DEFINE_GUIDSTRUCT("A0E517E8-8F8C-4F6F-9A57-46FC2F647EC0", KSCAMERAPROFILE_VideoRecording); +#define KSCAMERAPROFILE_VideoRecording DEFINE_GUIDNAMED(KSCAMERAPROFILE_VideoRecording) + +#define STATIC_KSCAMERAPROFILE_HighQualityPhoto \ + 0x32440725, 0x961B, 0x4CA3, 0xB5, 0xB2, 0x85, 0x4E, 0x71, 0x9D, 0x9E, 0x1B +DEFINE_GUIDSTRUCT("32440725-961B-4CA3-B5B2-854E719D9E1B", KSCAMERAPROFILE_HighQualityPhoto); +#define KSCAMERAPROFILE_HighQualityPhoto DEFINE_GUIDNAMED(KSCAMERAPROFILE_HighQualityPhoto) + +#define STATIC_KSCAMERAPROFILE_BalancedVideoAndPhoto \ + 0x6B52B017, 0x42C7, 0x4A21, 0xBF, 0xE3, 0x23, 0xF0, 0x09, 0x14, 0x98, 0x87 +DEFINE_GUIDSTRUCT("6B52B017-42C7-4A21-BFE3-23F009149887", KSCAMERAPROFILE_BalancedVideoAndPhoto); +#define KSCAMERAPROFILE_BalancedVideoAndPhoto DEFINE_GUIDNAMED(KSCAMERAPROFILE_BalancedVideoAndPhoto) + +#define STATIC_KSCAMERAPROFILE_VideoConferencing \ + 0xC5444A88, 0xE1BF, 0x4597, 0xB2, 0xDD, 0x9E, 0x1E, 0xAD, 0x86, 0x4B, 0xB8 +DEFINE_GUIDSTRUCT("C5444A88-E1BF-4597-B2DD-9E1EAD864BB8", KSCAMERAPROFILE_VideoConferencing); +#define KSCAMERAPROFILE_VideoConferencing DEFINE_GUIDNAMED(KSCAMERAPROFILE_VideoConferencing) + +#define STATIC_KSCAMERAPROFILE_PhotoSequence \ + 0x02399D9D, 0x4EE8, 0x49BA, 0xBC, 0x07, 0x5F, 0xF1, 0x56, 0x53, 0x14, 0x13 +DEFINE_GUIDSTRUCT("02399D9D-4EE8-49BA-BC07-5FF156531413", KSCAMERAPROFILE_PhotoSequence); +#define KSCAMERAPROFILE_PhotoSequence DEFINE_GUIDNAMED(KSCAMERAPROFILE_PhotoSequence) + +#define STATIC_KSCAMERAPROFILE_FaceAuth_Mode \ + 0x81361b22, 0x700b, 0x4546, 0xa2, 0xd4, 0xc5, 0x2e, 0x90, 0x7b, 0xfc, 0x27 +DEFINE_GUIDSTRUCT("81361B22-700B-4546-A2D4-C52E907BFC27", KSCAMERAPROFILE_FaceAuth_Mode); +#define KSCAMERAPROFILE_FaceAuth_Mode DEFINE_GUIDNAMED(KSCAMERAPROFILE_FaceAuth_Mode) + +#define STATIC_KSCAMERAPROFILE_HighFrameRate \ + 0x566E6113, 0x8C35, 0x48E7, 0xB8, 0x9F, 0xD2, 0x3F, 0xDC, 0x12, 0x19, 0xDC +DEFINE_GUIDSTRUCT("566E6113-8C35-48E7-B89F-D23FDC1219DC", KSCAMERAPROFILE_HighFrameRate); +#define KSCAMERAPROFILE_HighFrameRate DEFINE_GUIDNAMED(KSCAMERAPROFILE_HighFrameRate) + +#define STATIC_KSCAMERAPROFILE_HDRWithWCGVideo \ + 0x4B27C336, 0x4924, 0x4989, 0xB9, 0x94, 0xFD, 0xAF, 0x1D, 0xC7, 0xCD, 0x85 +DEFINE_GUIDSTRUCT("4B27C336-4924-4989-B994-FDAF1DC7CD85", KSCAMERAPROFILE_HDRWithWCGVideo); +#define KSCAMERAPROFILE_HDRWithWCGVideo DEFINE_GUIDNAMED(KSCAMERAPROFILE_HDRWithWCGVideo) + +#define STATIC_KSCAMERAPROFILE_HDRWithWCGPhoto \ + 0x9BF6F1FF, 0xB555, 0x4625, 0xB3, 0x26, 0xA4, 0x6D, 0xEF, 0x31, 0x8F, 0xB7 +DEFINE_GUIDSTRUCT("9BF6F1FF-B555-4625-B326-A46DEF318FB7", KSCAMERAPROFILE_HDRWithWCGPhoto); +#define KSCAMERAPROFILE_HDRWithWCGPhoto DEFINE_GUIDNAMED(KSCAMERAPROFILE_HDRWithWCGPhoto) + +#define STATIC_KSCAMERAPROFILE_VariablePhotoSequence \ + 0x9FF2CB56, 0xE75A, 0x49B1, 0xA9, 0x28, 0x99, 0x85, 0xD5, 0x94, 0x6F, 0x87 +DEFINE_GUIDSTRUCT("9FF2CB56-E75A-49B1-A928-9985D5946F87", KSCAMERAPROFILE_VariablePhotoSequence); +#define KSCAMERAPROFILE_VariablePhotoSequence DEFINE_GUIDNAMED(KSCAMERAPROFILE_VariablePhotoSequence) + +#define STATIC_KSCAMERAPROFILE_VideoHDR8 \ + 0xD4F3F4EC, 0xBDFF, 0x4314, 0xB1, 0xD4, 0x00, 0x8E, 0x28, 0x1F, 0x74, 0xE7 +DEFINE_GUIDSTRUCT("D4F3F4EC-BDFF-4314-B1D4-008E281F74E7", KSCAMERAPROFILE_VideoHDR8); +#define KSCAMERAPROFILE_VideoHDR8 DEFINE_GUIDNAMED(KSCAMERAPROFILE_VideoHDR8) + +#if (NTDDI_VERSION >= NTDDI_WIN10_MN) +#define STATIC_KSCAMERAPROFILE_CompressedCamera \ + 0xe34cdc1, 0x27ad, 0x437f, 0xab, 0xde, 0x2, 0xb6, 0x29, 0xf3, 0x7b, 0x44 +DEFINE_GUIDSTRUCT("0E34CDC1-27AD-437F-ABDE-02B629F37B44", KSCAMERAPROFILE_CompressedCamera); +#define KSCAMERAPROFILE_CompressedCamera DEFINE_GUIDNAMED(KSCAMERAPROFILE_CompressedCamera) +#endif + +#define KSCAMERAPROFILE_FLAGS_VIDEOSTABLIZATION 0x0000000000000001 +#define KSCAMERAPROFILE_FLAGS_VIDEOHDR 0x0000000000000002 +#define KSCAMERAPROFILE_FLAGS_PHOTOHDR 0x0000000000000004 +#define KSCAMERAPROFILE_FLAGS_FACEDETECTION 0x0000000000000008 +#define KSCAMERAPROFILE_FLAGS_VARIABLEPHOTOSEQUENCE 0x0000000000000010 +#define KSCAMERAPROFILE_FLAGS_PREVIEW_RES_MUSTMATCH 0x0000000000000020 + +#define KSDEVICE_PROFILE_TYPE_UNKNOWN 0x00000000 +#define KSDEVICE_PROFILE_TYPE_CAMERA 0x00000001 + +// +// Camera Pin Sensor output type should be in sync with MFFrameSourceTypes +// +#define KSCameraProfileSensorType_RGB 0x0001 +#define KSCameraProfileSensorType_Infrared 0x0002 +#define KSCameraProfileSensorType_Depth 0x0004 +#define KSCameraProfileSensorType_PoseTracking 0x0008 +#define KSCameraProfileSensorType_ImageSegmentation 0x0010 +#define KSCameraProfileSensorType_Custom 0x0080 + +typedef struct _KSCAMERA_PROFILE_MEDIAINFO +{ + struct + { + UINT32 X; + UINT32 Y; + } Resolution; + struct + { + UINT32 Numerator; + UINT32 Denominator; + } MaxFrameRate; + + ULONGLONG Flags; + UINT32 Data0; + UINT32 Data1; + UINT32 Data2; + UINT32 Data3; +} KSCAMERA_PROFILE_MEDIAINFO, *PKSCAMERA_PROFILE_MEDIAINFO; + +typedef struct _KSCAMERA_PROFILE_PININFO +{ + GUID PinCategory; + union + { + struct + { + USHORT PinIndex; + USHORT ProfileSensorType; + }; + UINT32 Reserved; + }; + UINT32 MediaInfoCount; + PKSCAMERA_PROFILE_MEDIAINFO MediaInfos; +} KSCAMERA_PROFILE_PININFO, *PKSCAMERA_PROFILE_PININFO; + +typedef struct _KSCAMERA_PROFILE_INFO +{ + GUID ProfileId; + UINT32 Index; + UINT32 PinCount; + PKSCAMERA_PROFILE_PININFO Pins; +} KSCAMERA_PROFILE_INFO, *PKSCAMERA_PROFILE_INFO; + +typedef struct _KSCAMERA_PROFILE_CONCURRENCYINFO +{ + GUID ReferenceGuid; + UINT32 Reserved; + UINT32 ProfileCount; + PKSCAMERA_PROFILE_INFO Profiles; +} KSCAMERA_PROFILE_CONCURRENCYINFO,*PKSCAMERA_PROFILE_CONCURRENCYINFO; + +typedef struct _KSDEVICE_PROFILE_INFO +{ + UINT32 Type; + UINT32 Size; + union + { + struct + { + KSCAMERA_PROFILE_INFO Info; + UINT32 Reserved; + UINT32 ConcurrencyCount; + PKSCAMERA_PROFILE_CONCURRENCYINFO Concurrency; + } Camera; + + // Add other device type specific "profiles" here. + }; +} KSDEVICE_PROFILE_INFO, *PKSDEVICE_PROFILE_INFO; + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + + +typedef struct _WNF_KSCAMERA_STREAMSTATE_INFO +{ + ULONG ProcessId; + ULONG SessionId; + ULONG StreamState; + ULONG Reserved; +} WNF_KSCAMERA_STREAMSTATE_INFO, *PWNF_KSCAMERA_STREAMSTATE_INFO; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) + +// +// Network Camera related definitions +// +typedef enum +{ + KSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_TYPE_DISABLE = 0, + KSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_TYPE_HOSTNTP, + KSPROPERYT_NETWORKCAMERACONTROL_NTPINFO_TYPE_CUSTOM, +} KSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_TYPE; + +typedef struct +{ + ULONG Size; + KSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_TYPE Type; +} +KSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_HEADER, *PKSPROPERTY_NETWORKCAMERACONTROL_NTPINFO_HEADER; + +#define STATIC_KSPROPERTYSETID_NetworkCameraControl \ + 0xe780f09, 0x5745, 0x4e3a, 0xbc, 0x9f, 0xf2, 0x26, 0xea, 0x43, 0xa6, 0xec +DEFINE_GUIDSTRUCT("0E780F09-5745-4E3A-BC9F-F226EA43A6EC", KSPROPERTYSETID_NetworkCameraControl); +#define KSPROPERTYSETID_NetworkCameraControl DEFINE_GUIDNAMED(KSPROPERTYSETID_NetworkCameraControl) + +typedef enum +{ + KSPROPERTY_NETWORKCAMERACONTROL_NTP, + KSPROPERTY_NETWORKCAMERACONTROL_URI, +#if(NTDDI_VERSION >= NTDDI_WIN10_FE) + KSPROPERTY_NETWORKCAMERACONTROL_METADATA, + KSPROPERTY_NETWORKCAMERACONTROL_EVENTTOPICS_XML, +#endif +} KSPROPERTY_NETWORKCAMERACONTROL_PROPERTY; + +#if(NTDDI_VERSION >= NTDDI_WIN10_FE) +typedef enum +{ + KSPROPERTY_NETWORKCAMERACONTROL_METADATA_TYPE_EVENTSINFO, +} KSPROPERTY_NETWORKCAMERACONTROL_METADATA_TYPE; + +typedef struct _KSPROPERTY_NETWORKCAMERACONTROL_METADATA_INFO +{ + ULONG MetadataItems; + ULONG Size; + BOOL PTZStatus; + BOOL Events; + BOOL Analytics; + BOOL Reserved; +} KSPROPERTY_NETWORKCAMERACONTROL_METADATA_INFO, *PKSPROPERTY_NETWORKCAMERACONTROL_METADATA_INFO; + +typedef struct _KSPROPERTY_NETWORKCAMERACONTROL_EVENT_INFO +{ + KSCAMERA_METADATA_ITEMHEADER Header; + WCHAR EventFilter[1]; +}KSPROPERTY_NETWORKCAMERACONTROL_EVENT_INFO, *PKSPROPERTY_NETWORKCAMERACONTROL_EVENT_INFO; + +#endif // NTDDI_VERSION >= NTDDI_WIN10_FE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if(NTDDI_VERSION >= NTDDI_WIN10_NI) +#endif + +#ifndef __EDevCtrl__ +#define __EDevCtrl__ +//=========================================================================== + +#define STATIC_PROPSETID_EXT_DEVICE\ + 0xB5730A90L, 0x1A2C, 0x11cf, 0x8c, 0x23, 0x00, 0xAA, 0x00, 0x6B, 0x68, 0x14 +DEFINE_GUIDSTRUCT("B5730A90-1A2C-11cf-8C23-00AA006B6814", PROPSETID_EXT_DEVICE); +#define PROPSETID_EXT_DEVICE DEFINE_GUIDNAMED(PROPSETID_EXT_DEVICE) + +typedef enum { + KSPROPERTY_EXTDEVICE_ID, // R + KSPROPERTY_EXTDEVICE_VERSION, // R + KSPROPERTY_EXTDEVICE_POWER_STATE, // RW + KSPROPERTY_EXTDEVICE_PORT, // R + KSPROPERTY_EXTDEVICE_CAPABILITIES // R +} KSPROPERTY_EXTDEVICE; + +typedef struct tagDEVCAPS{ + LONG CanRecord; + LONG CanRecordStrobe; + LONG HasAudio; + LONG HasVideo; + LONG UsesFiles; + LONG CanSave; + LONG DeviceType; + LONG TCRead; + LONG TCWrite; + LONG CTLRead; + LONG IndexRead; + LONG Preroll; + LONG Postroll; + LONG SyncAcc; + LONG NormRate; + LONG CanPreview; + LONG CanMonitorSrc; + LONG CanTest; + LONG VideoIn; + LONG AudioIn; + LONG Calibrate; + LONG SeekType; + LONG SimulatedHardware; +} DEVCAPS, *PDEVCAPS; + +typedef struct { + KSPROPERTY Property; + union { + DEVCAPS Capabilities; // Device capabilities + ULONG DevPort; // 1394, USB, etc. + ULONG PowerState; // On, standby or off + WCHAR pawchString[MAX_PATH]; // Version + DWORD NodeUniqueID[2]; // Unique NodeID + } u; +} KSPROPERTY_EXTDEVICE_S, *PKSPROPERTY_EXTDEVICE_S; + +//=========================================================================== + +#define STATIC_PROPSETID_EXT_TRANSPORT\ + 0xA03CD5F0L, 0x3045, 0x11cf, 0x8c, 0x44, 0x00, 0xAA, 0x00, 0x6B, 0x68, 0x14 +DEFINE_GUIDSTRUCT("A03CD5F0-3045-11cf-8C44-00AA006B6814", PROPSETID_EXT_TRANSPORT); +#define PROPSETID_EXT_TRANSPORT DEFINE_GUIDNAMED(PROPSETID_EXT_TRANSPORT) + +typedef enum { + KSPROPERTY_EXTXPORT_CAPABILITIES, // (R) Transport specific capability + KSPROPERTY_EXTXPORT_INPUT_SIGNAL_MODE, // (RW) Input signal: e.g. dvsd/NTSC/PAL, dvsl/NTSC/PAL, MPEG2-TS etc + KSPROPERTY_EXTXPORT_OUTPUT_SIGNAL_MODE, // (RW) Output signal: e.g. dvsd/NTSC/PAL, dvsl/NTSC/PAL, MPEG2-TS etc + KSPROPERTY_EXTXPORT_LOAD_MEDIUM, // (RW) Eject, open tray, close tray + KSPROPERTY_EXTXPORT_MEDIUM_INFO, // (R) Cassettte type, tape grade and write protection + KSPROPERTY_EXTXPORT_STATE, // (RW) Current transport mode and state + KSPROPERTY_EXTXPORT_STATE_NOTIFY, // (RW) Notify of transport mode and state change + KSPROPERTY_EXTXPORT_TIMECODE_SEARCH, // (W) Search to a specific timecode on a tape + KSPROPERTY_EXTXPORT_ATN_SEARCH, // (W) Search to a specific absolute track number (ATN) on a tape + KSPROPERTY_EXTXPORT_RTC_SEARCH, // (W) Search to a specific relative time counter (RTC) on a tape + KSPROPERTY_RAW_AVC_CMD // (RW) Issue a raw AVC commnad +} KSPROPERTY_EXTXPORT; + +typedef struct tagTRANSPORTSTATUS{ + LONG Mode; + LONG LastError; + LONG RecordInhibit; + LONG ServoLock; + LONG MediaPresent; + LONG MediaLength; + LONG MediaSize; + LONG MediaTrackCount; + LONG MediaTrackLength; + LONG MediaTrackSide; + LONG MediaType; + LONG LinkMode; + LONG NotifyOn; +} TRANSPORTSTATUS, *PTRANSPORTSTATUS; + +typedef struct tagTRANSPORTBASICPARMS{ + LONG TimeFormat; + LONG TimeReference; + LONG Superimpose; + LONG EndStopAction; + LONG RecordFormat; + LONG StepFrames; + LONG SetpField; + LONG Preroll; + LONG RecPreroll; + LONG Postroll; + LONG EditDelay; + LONG PlayTCDelay; + LONG RecTCDelay; + LONG EditField; + LONG FrameServo; + LONG ColorFrameServo; + LONG ServoRef; + LONG WarnGenlock; + LONG SetTracking; + TCHAR VolumeName[40]; + LONG Ballistic[20]; + LONG Speed; + LONG CounterFormat; + LONG TunerChannel; + LONG TunerNumber; + LONG TimerEvent; + LONG TimerStartDay; + LONG TimerStartTime; + LONG TimerStopDay; + LONG TimerStopTime; +} TRANSPORTBASICPARMS, *PTRANSPORTBASICPARMS; + +typedef struct tagTRANSPORTVIDEOPARMS{ + LONG OutputMode; + LONG Input; +} TRANSPORTVIDEOPARMS, *PTRANSPORTVIDEOPARMS; + +typedef struct tagTRANSPORTAUDIOPARMS{ + LONG EnableOutput; + LONG EnableRecord; + LONG EnableSelsync; + LONG Input; + LONG MonitorSource; +} TRANSPORTAUDIOPARMS, *PTRANSPORTAUDIOPARMS; + +typedef struct { + BOOL MediaPresent; + ULONG MediaType; + BOOL RecordInhibit; +} MEDIUM_INFO, *PMEDIUM_INFO; + +typedef struct { + ULONG Mode; + ULONG State; +} TRANSPORT_STATE, *PTRANSPORT_STATE; + +typedef struct { + KSPROPERTY Property; + union { + ULONG Capabilities; + ULONG SignalMode; + ULONG LoadMedium; + MEDIUM_INFO MediumInfo; + TRANSPORT_STATE XPrtState; + struct { + BYTE frame; + BYTE second; + BYTE minute; + BYTE hour; + } Timecode; + DWORD dwTimecode; + DWORD dwAbsTrackNumber; + struct { + ULONG PayloadSize; + BYTE Payload[512]; + } RawAVC; + } u; + +} KSPROPERTY_EXTXPORT_S, *PKSPROPERTY_EXTXPORT_S; + +typedef struct { + KSP_NODE NodeProperty; + union { + ULONG Capabilities; + ULONG SignalMode; + ULONG LoadMedium; + MEDIUM_INFO MediumInfo; + TRANSPORT_STATE XPrtState; + struct { + BYTE frame; + BYTE second; + BYTE minute; + BYTE hour; + } Timecode; + DWORD dwTimecode; + DWORD dwAbsTrackNumber; + struct { + ULONG PayloadSize; + BYTE Payload[512]; + } RawAVC; + } u; + +} KSPROPERTY_EXTXPORT_NODE_S, *PKSPROPERTY_EXTXPORT_NODE_S; + +//=========================================================================== + +#define STATIC_PROPSETID_TIMECODE_READER\ + 0x9B496CE1L, 0x811B, 0x11cf, 0x8C, 0x77, 0x00, 0xAA, 0x00, 0x6B, 0x68, 0x14 +DEFINE_GUIDSTRUCT("9B496CE1-811B-11cf-8C77-00AA006B6814", PROPSETID_TIMECODE_READER); +#define PROPSETID_TIMECODE_READER DEFINE_GUIDNAMED(PROPSETID_TIMECODE_READER) + +typedef enum { + KSPROPERTY_TIMECODE_READER, // (R) Timecode for the current tape position + KSPROPERTY_ATN_READER, // (R) Absolute track number for the current tape position + KSPROPERTY_RTC_READER // (R) Relative time counter for the current tape position +} KSPROPERTY_TIMECODE; + +#ifndef TIMECODE_DEFINED +#define TIMECODE_DEFINED +typedef union _timecode { + struct { + WORD wFrameRate; + WORD wFrameFract; + DWORD dwFrames; + }; + DWORDLONG qw; +} TIMECODE; +typedef TIMECODE *PTIMECODE; + +typedef struct tagTIMECODE_SAMPLE { + LONGLONG qwTick; + TIMECODE timecode; + DWORD dwUser; + DWORD dwFlags; +} TIMECODE_SAMPLE; + +typedef TIMECODE_SAMPLE *PTIMECODE_SAMPLE; + +#endif /* TIMECODE_DEFINED */ + +typedef struct { + KSPROPERTY Property; + TIMECODE_SAMPLE TimecodeSamp; +} KSPROPERTY_TIMECODE_S, *PKSPROPERTY_TIMECODE_S; + +typedef struct { + KSP_NODE NodeProperty; + TIMECODE_SAMPLE TimecodeSamp; +} KSPROPERTY_TIMECODE_NODE_S, *PKSPROPERTY_TIMECODE_NODE_S; + +//=========================================================================== + +#define STATIC_KSEVENTSETID_EXTDEV_Command\ + 0x109c7988L, 0xb3cb, 0x11d2, 0xb4, 0x8e, 0x00, 0x60, 0x97, 0xb3, 0x39, 0x1b +DEFINE_GUIDSTRUCT("109c7988-b3cb-11d2-b48e-006097b3391b", KSEVENTSETID_EXTDEV_Command); +#define KSEVENTSETID_EXTDEV_Command DEFINE_GUIDNAMED(KSEVENTSETID_EXTDEV_Command) + +typedef enum { + KSEVENT_EXTDEV_COMMAND_NOTIFY_INTERIM_READY, // Final response is ready for notify command + KSEVENT_EXTDEV_COMMAND_CONTROL_INTERIM_READY, // Final response is ready for control command. + KSEVENT_EXTDEV_COMMAND_BUSRESET, // A bus reset has occured. + KSEVENT_EXTDEV_TIMECODE_UPDATE, // Timecode has changed. + KSEVENT_EXTDEV_OPERATION_MODE_UPDATE, // Operting mode (VCR,Camera, etc.) has changed. + KSEVENT_EXTDEV_TRANSPORT_STATE_UPDATE, // Transport state has changed. + KSEVENT_EXTDEV_NOTIFY_REMOVAL, // Device was surprise removal. + KSEVENT_EXTDEV_NOTIFY_MEDIUM_CHANGE // Tape medium is removed or added. +} KSEVENT_DEVCMD; + +#endif // __EDevCtrl__ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // XP SP2 and later (chronologically) + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +//=========================================================================== + +#define STATIC_PROPSETID_VIDCAP_CROSSBAR\ + 0x6a2e0640L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0640-28e4-11d0-a18c-00a0c9118956", PROPSETID_VIDCAP_CROSSBAR); +#define PROPSETID_VIDCAP_CROSSBAR DEFINE_GUIDNAMED(PROPSETID_VIDCAP_CROSSBAR) + +typedef enum { + KSPROPERTY_CROSSBAR_CAPS, // R + KSPROPERTY_CROSSBAR_PININFO, // R + KSPROPERTY_CROSSBAR_CAN_ROUTE, // R + KSPROPERTY_CROSSBAR_ROUTE, // RW + KSPROPERTY_CROSSBAR_INPUT_ACTIVE // R +} KSPROPERTY_VIDCAP_CROSSBAR; + +typedef struct { + KSPROPERTY Property; + ULONG NumberOfInputs; // the number of audio and video input pins + ULONG NumberOfOutputs; // the number of audio and video output pins +} KSPROPERTY_CROSSBAR_CAPS_S, *PKSPROPERTY_CROSSBAR_CAPS_S; + +typedef struct { + KSPROPERTY Property; + KSPIN_DATAFLOW Direction; // KSPIN_DATAFLOW_IN or KSPIN_DATAFLOW_OUT? + ULONG Index; // Which pin to return data for? + ULONG PinType; // KS_PhysConn_Video_* or KS_PhysConn_Audio_* + ULONG RelatedPinIndex; // For video pins, this is the related audio pin + KSPIN_MEDIUM Medium; // Identifies the hardware connection +} KSPROPERTY_CROSSBAR_PININFO_S, *PKSPROPERTY_CROSSBAR_PININFO_S; + +typedef struct { + KSPROPERTY Property; + ULONG IndexInputPin; // Zero based index of the input pin + ULONG IndexOutputPin; // Zero based index of the output pin + ULONG CanRoute; // returns non-zero on CAN_ROUTE if routing is possible +} KSPROPERTY_CROSSBAR_ROUTE_S, *PKSPROPERTY_CROSSBAR_ROUTE_S; + +typedef struct { + KSPROPERTY Property; + ULONG IndexInputPin; // W - Zero based index of the input pin + ULONG Active; // R - returns whether an active signal is present on the given input +} KSPROPERTY_CROSSBAR_ACTIVE_S, *PKSPROPERTY_CROSSBAR_ACTIVE_S; + +#define STATIC_EVENTSETID_CROSSBAR\ + 0x6a2e0641L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0641-28e4-11d0-a18c-00a0c9118956", EVENTSETID_CROSSBAR); +#define EVENTSETID_CROSSBAR DEFINE_GUIDNAMED(EVENTSETID_CROSSBAR) + +typedef enum { + KSEVENT_CROSSBAR_CHANGED +} KSEVENT_CROSSBAR; + +// The following IDs should match the AM equivalents +typedef enum { + KS_PhysConn_Video_Tuner = 1, + KS_PhysConn_Video_Composite, + KS_PhysConn_Video_SVideo, + KS_PhysConn_Video_RGB, + KS_PhysConn_Video_YRYBY, + KS_PhysConn_Video_SerialDigital, + KS_PhysConn_Video_ParallelDigital, + KS_PhysConn_Video_SCSI, + KS_PhysConn_Video_AUX, + KS_PhysConn_Video_1394, + KS_PhysConn_Video_USB, + KS_PhysConn_Video_VideoDecoder, + KS_PhysConn_Video_VideoEncoder, + KS_PhysConn_Video_SCART, + + KS_PhysConn_Audio_Tuner = 4096, + KS_PhysConn_Audio_Line, + KS_PhysConn_Audio_Mic, + KS_PhysConn_Audio_AESDigital, + KS_PhysConn_Audio_SPDIFDigital, + KS_PhysConn_Audio_SCSI, + KS_PhysConn_Audio_AUX, + KS_PhysConn_Audio_1394, + KS_PhysConn_Audio_USB, + KS_PhysConn_Audio_AudioDecoder +} KS_PhysicalConnectorType; + + +//=========================================================================== + +#define STATIC_PROPSETID_VIDCAP_TVAUDIO\ + 0x6a2e0650L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0650-28e4-11d0-a18c-00a0c9118956", PROPSETID_VIDCAP_TVAUDIO); +#define PROPSETID_VIDCAP_TVAUDIO DEFINE_GUIDNAMED(PROPSETID_VIDCAP_TVAUDIO) + +typedef enum { + KSPROPERTY_TVAUDIO_CAPS, // R + KSPROPERTY_TVAUDIO_MODE, // RW + KSPROPERTY_TVAUDIO_CURRENTLY_AVAILABLE_MODES // R +} KSPROPERTY_VIDCAP_TVAUDIO; + +#define KS_TVAUDIO_MODE_MONO 0x0001 // Mono +#define KS_TVAUDIO_MODE_STEREO 0x0002 // Stereo +#define KS_TVAUDIO_MODE_LANG_A 0x0010 // Primary language +#define KS_TVAUDIO_MODE_LANG_B 0x0020 // 2nd avail language +#define KS_TVAUDIO_MODE_LANG_C 0x0040 // 3rd avail language +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define KS_TVAUDIO_PRESET_STEREO 0x0200 // if present, stereo +#define KS_TVAUDIO_PRESET_LANG_A 0x1000 // if present, Language A +#define KS_TVAUDIO_PRESET_LANG_B 0x2000 // if present, Language B +#define KS_TVAUDIO_PRESET_LANG_C 0x4000 // if present, Language C +#endif // (NTDDI_VERSION >= NTDDI_VISTA + +typedef struct { + KSPROPERTY Property; + ULONG Capabilities; // Bitmask of KS_TVAUDIO_MODE_* + KSPIN_MEDIUM InputMedium; + KSPIN_MEDIUM OutputMedium; +} KSPROPERTY_TVAUDIO_CAPS_S, *PKSPROPERTY_TVAUDIO_CAPS_S; + +typedef struct { + KSPROPERTY Property; + ULONG Mode; // KS_TVAUDIO_MODE_* +} KSPROPERTY_TVAUDIO_S, *PKSPROPERTY_TVAUDIO_S; + + +#define STATIC_KSEVENTSETID_VIDCAP_TVAUDIO\ + 0x6a2e0651L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0651-28e4-11d0-a18c-00a0c9118956", KSEVENTSETID_VIDCAP_TVAUDIO); +#define KSEVENTSETID_VIDCAP_TVAUDIO DEFINE_GUIDNAMED(KSEVENTSETID_VIDCAP_TVAUDIO) + +typedef enum { + KSEVENT_TVAUDIO_CHANGED, +} KSEVENT_TVAUDIO; + +//=========================================================================== +#define STATIC_PROPSETID_VIDCAP_VIDEOCOMPRESSION\ + 0xC6E13343L, 0x30AC, 0x11d0, 0xA1, 0x8C, 0x00, 0xA0, 0xC9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("C6E13343-30AC-11d0-A18C-00A0C9118956", PROPSETID_VIDCAP_VIDEOCOMPRESSION); +#define PROPSETID_VIDCAP_VIDEOCOMPRESSION DEFINE_GUIDNAMED(PROPSETID_VIDCAP_VIDEOCOMPRESSION) + +typedef enum { + KSPROPERTY_VIDEOCOMPRESSION_GETINFO, // R + KSPROPERTY_VIDEOCOMPRESSION_KEYFRAME_RATE, // RW + KSPROPERTY_VIDEOCOMPRESSION_PFRAMES_PER_KEYFRAME, // RW + KSPROPERTY_VIDEOCOMPRESSION_QUALITY, // RW + KSPROPERTY_VIDEOCOMPRESSION_OVERRIDE_KEYFRAME, // W + KSPROPERTY_VIDEOCOMPRESSION_OVERRIDE_FRAME_SIZE, // W + KSPROPERTY_VIDEOCOMPRESSION_WINDOWSIZE // RW +} KSPROPERTY_VIDCAP_VIDEOCOMPRESSION; + +typedef enum { + KS_CompressionCaps_CanQuality = 1, + KS_CompressionCaps_CanCrunch = 2, + KS_CompressionCaps_CanKeyFrame = 4, + KS_CompressionCaps_CanBFrame = 8, + KS_CompressionCaps_CanWindow = 0x10 +} KS_CompressionCaps; + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +typedef enum { + KS_StreamingHint_FrameInterval = 0x0100, + KS_StreamingHint_KeyFrameRate = 0x0200, + KS_StreamingHint_PFrameRate = 0x0400, + KS_StreamingHint_CompQuality = 0x0800, + KS_StreamingHint_CompWindowSize = 0x1000 +} KS_VideoStreamingHints; + +#endif // XP SP2 and later (chronologically) + +typedef struct { + KSPROPERTY Property; + // Note, no VersionString! + // Note, no DescriptionString! + ULONG StreamIndex; // zero based index of stream + LONG DefaultKeyFrameRate; // Key frame rate + LONG DefaultPFrameRate; // Predeicted frames per Key frame + LONG DefaultQuality; // 0 to 10000 + LONG NumberOfQualitySettings; // How many discreet quality settings? + LONG Capabilities; // KS_CompressionCaps_* +} KSPROPERTY_VIDEOCOMPRESSION_GETINFO_S, *PKSPROPERTY_VIDEOCOMPRESSION_GETINFO_S; + +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; // zero based index of stream + LONG Value; // value to get or set +} KSPROPERTY_VIDEOCOMPRESSION_S, *PKSPROPERTY_VIDEOCOMPRESSION_S; + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; // zero based index of stream + LONG Value; // value to get or set + ULONG Flags; +} KSPROPERTY_VIDEOCOMPRESSION_S1, *PKSPROPERTY_VIDEOCOMPRESSION_S1; + +#endif // XP SP2 and later (chronologically) + +//=========================================================================== +// MEDIASUBTYPE_Overlay +#define STATIC_KSDATAFORMAT_SUBTYPE_OVERLAY\ + 0xe436eb7fL, 0x524f, 0x11ce, 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70 +DEFINE_GUIDSTRUCT("e436eb7f-524f-11ce-9f53-0020af0ba770", KSDATAFORMAT_SUBTYPE_OVERLAY); +#define KSDATAFORMAT_SUBTYPE_OVERLAY DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_OVERLAY) + +#define STATIC_KSPROPSETID_OverlayUpdate\ + 0x490EA5CFL, 0x7681, 0x11D1, 0xA2, 0x1C, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +DEFINE_GUIDSTRUCT("490EA5CF-7681-11D1-A21C-00A0C9223196", KSPROPSETID_OverlayUpdate); +#define KSPROPSETID_OverlayUpdate DEFINE_GUIDNAMED(KSPROPSETID_OverlayUpdate) + +typedef enum { + KSPROPERTY_OVERLAYUPDATE_INTERESTS, + KSPROPERTY_OVERLAYUPDATE_CLIPLIST = 0x1, + KSPROPERTY_OVERLAYUPDATE_PALETTE = 0x2, + KSPROPERTY_OVERLAYUPDATE_COLORKEY = 0x4, + KSPROPERTY_OVERLAYUPDATE_VIDEOPOSITION = 0x8, + KSPROPERTY_OVERLAYUPDATE_DISPLAYCHANGE = 0x10, + KSPROPERTY_OVERLAYUPDATE_COLORREF = 0x10000000 +} KSPROPERTY_OVERLAYUPDATE; + +typedef struct { + ULONG PelsWidth; + ULONG PelsHeight; + ULONG BitsPerPel; + WCHAR DeviceID[1]; +} KSDISPLAYCHANGE, *PKSDISPLAYCHANGE; + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_INTERESTS(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_INTERESTS,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(ULONG),\ + NULL, NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_PALETTE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_PALETTE,\ + NULL,\ + sizeof(KSPROPERTY),\ + 0,\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_COLORKEY(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_COLORKEY,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(COLORKEY),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_CLIPLIST(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_CLIPLIST,\ + NULL,\ + sizeof(KSPROPERTY),\ + 2 * sizeof(RECT) + sizeof(RGNDATAHEADER),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_VIDEOPOSITION(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_VIDEOPOSITION,\ + NULL,\ + sizeof(KSPROPERTY),\ + 2 * sizeof(RECT),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_DISPLAYCHANGE(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_DISPLAYCHANGE,\ + NULL,\ + sizeof(KSPROPERTY),\ + sizeof(KSDISPLAYCHANGE),\ + (Handler),\ + NULL, 0, NULL, NULL, 0) + +#define DEFINE_KSPROPERTY_ITEM_OVERLAYUPDATE_COLORREF(Handler)\ + DEFINE_KSPROPERTY_ITEM(\ + KSPROPERTY_OVERLAYUPDATE_COLORREF,\ + (Handler),\ + sizeof(KSPROPERTY),\ + sizeof(COLORREF),\ + NULL,\ + NULL, 0, NULL, NULL, 0) + +//=========================================================================== +#define STATIC_PROPSETID_VIDCAP_VIDEOCONTROL\ + 0x6a2e0670L, 0x28e4, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("6a2e0670-28e4-11d0-a18c-00a0c9118956", PROPSETID_VIDCAP_VIDEOCONTROL); +#define PROPSETID_VIDCAP_VIDEOCONTROL DEFINE_GUIDNAMED(PROPSETID_VIDCAP_VIDEOCONTROL) + +typedef enum { + KSPROPERTY_VIDEOCONTROL_CAPS, // R + KSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE, // R O + KSPROPERTY_VIDEOCONTROL_FRAME_RATES, // R O + KSPROPERTY_VIDEOCONTROL_MODE // RWO +} KSPROPERTY_VIDCAP_VIDEOCONTROL; + +typedef enum { + KS_VideoControlFlag_FlipHorizontal = 0x0001, + KS_VideoControlFlag_FlipVertical = 0x0002, + KS_Obsolete_VideoControlFlag_ExternalTriggerEnable = 0x0010, // ***WARNING *** Flag msimatch with DSHOW. + KS_Obsolete_VideoControlFlag_Trigger = 0x0020, // ***WARNING *** Flag msimatch with DSHOW. + KS_VideoControlFlag_ExternalTriggerEnable = 0x0004, + KS_VideoControlFlag_Trigger = 0x0008, + KS_VideoControlFlag_IndependentImagePin = 0x0040 + #if (NTDDI_VERSION >= NTDDI_WIN8) + , KS_VideoControlFlag_StillCapturePreviewFrame = 0x0080, + KS_VideoControlFlag_StartPhotoSequenceCapture = 0x0100, + KS_VideoControlFlag_StopPhotoSequenceCapture = 0x0200 + #endif +} KS_VideoControlFlags; + +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; + ULONG VideoControlCaps; // KS_VideoControlFlags_* +} KSPROPERTY_VIDEOCONTROL_CAPS_S, *PKSPROPERTY_VIDEOCONTROL_CAPS_S; + +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; + LONG Mode; // KS_VideoControlFlags_* +} KSPROPERTY_VIDEOCONTROL_MODE_S, *PKSPROPERTY_VIDEOCONTROL_MODE_S; + +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; // Index of stream + ULONG RangeIndex; // Index of range + SIZE Dimensions; // Size of image + LONGLONG CurrentActualFrameRate; // Only correct if pin is open + LONGLONG CurrentMaxAvailableFrameRate; // Max Rate temporarily limited on USB or 1394? +} KSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S, *PKSPROPERTY_VIDEOCONTROL_ACTUAL_FRAME_RATE_S; + +// KSPROPERTY_VIDEOCONTROL_FRAME_RATES returns a list of available frame rates in 100 nS units +typedef struct { + KSPROPERTY Property; + ULONG StreamIndex; // Index of stream + ULONG RangeIndex; // Index of range + SIZE Dimensions; // Size of image +} KSPROPERTY_VIDEOCONTROL_FRAME_RATES_S, *PKSPROPERTY_VIDEOCONTROL_FRAME_RATES_S; + +//=========================================================================== +#define STATIC_PROPSETID_VIDCAP_DROPPEDFRAMES\ + 0xC6E13344L, 0x30AC, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0xc9, 0x11, 0x89, 0x56 +DEFINE_GUIDSTRUCT("C6E13344-30AC-11d0-A18C-00A0C9118956", PROPSETID_VIDCAP_DROPPEDFRAMES); +#define PROPSETID_VIDCAP_DROPPEDFRAMES DEFINE_GUIDNAMED(PROPSETID_VIDCAP_DROPPEDFRAMES) + +typedef enum { + KSPROPERTY_DROPPEDFRAMES_CURRENT // R +} KSPROPERTY_VIDCAP_DROPPEDFRAMES; + +typedef struct { + KSPROPERTY Property; + LONGLONG PictureNumber; // Current Picture Number + LONGLONG DropCount; // Count of frames dropped + ULONG AverageFrameSize; // Average size of frames captured +} KSPROPERTY_DROPPEDFRAMES_CURRENT_S, *PKSPROPERTY_DROPPEDFRAMES_CURRENT_S; + +//=========================================================================== +// VPE + +#define STATIC_KSPROPSETID_VPConfig\ + 0xbc29a660L, 0x30e3, 0x11d0, 0x9e, 0x69, 0x00, 0xc0, 0x4f, 0xd7, 0xc1, 0x5b +DEFINE_GUIDSTRUCT("bc29a660-30e3-11d0-9e69-00c04fd7c15b", KSPROPSETID_VPConfig); +#define KSPROPSETID_VPConfig DEFINE_GUIDNAMED(KSPROPSETID_VPConfig) + +#define STATIC_KSPROPSETID_VPVBIConfig\ + 0xec529b00L, 0x1a1f, 0x11d1, 0xba, 0xd9, 0x0, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("ec529b00-1a1f-11d1-bad9-00609744111a", KSPROPSETID_VPVBIConfig); +#define KSPROPSETID_VPVBIConfig DEFINE_GUIDNAMED(KSPROPSETID_VPVBIConfig) + +// Both of the above property sets use the same list of properties below + +typedef enum { + KSPROPERTY_VPCONFIG_NUMCONNECTINFO, + KSPROPERTY_VPCONFIG_GETCONNECTINFO, + KSPROPERTY_VPCONFIG_SETCONNECTINFO, + KSPROPERTY_VPCONFIG_VPDATAINFO, + KSPROPERTY_VPCONFIG_MAXPIXELRATE, + KSPROPERTY_VPCONFIG_INFORMVPINPUT, + KSPROPERTY_VPCONFIG_NUMVIDEOFORMAT, + KSPROPERTY_VPCONFIG_GETVIDEOFORMAT, + KSPROPERTY_VPCONFIG_SETVIDEOFORMAT, + KSPROPERTY_VPCONFIG_INVERTPOLARITY, + KSPROPERTY_VPCONFIG_DECIMATIONCAPABILITY, // E_NOTIMPL for VBI + KSPROPERTY_VPCONFIG_SCALEFACTOR, // E_NOTIMPL for VBI + KSPROPERTY_VPCONFIG_DDRAWHANDLE, + KSPROPERTY_VPCONFIG_VIDEOPORTID, + KSPROPERTY_VPCONFIG_DDRAWSURFACEHANDLE, + KSPROPERTY_VPCONFIG_SURFACEPARAMS +} KSPROPERTY_VPCONFIG; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +//========================= +// IBasicAudio +// +#define STATIC_CLSID_KsIBasicAudioInterfaceHandler\ + 0xb9f8ac3e, 0x0f71, 0x11d2, 0xb7, 0x2c, 0x00, 0xc0, 0x4f, 0xb6, 0xbd, 0x3d +DEFINE_GUIDSTRUCT("b9f8ac3e-0f71-11d2-b72c-00c04fb6bd3d", CLSID_KsIBasicAudioInterfaceHandler); +#define CLSID_KsIBasicAudioInterfaceHandler DEFINE_GUIDNAMED(CLSID_KsIBasicAudioInterfaceHandler) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if defined(__IVPType__) + +typedef struct { + AMVPSIZE Size; + DWORD MaxPixelsPerSecond; + DWORD Reserved; +} KSVPMAXPIXELRATE, *PKSVPMAXPIXELRATE; + +typedef struct { + KSPROPERTY Property; + AMVPSIZE Size; +} KSVPSIZE_PROP, *PKSVPSIZE_PROP; + +typedef struct { + DWORD dwPitch; + DWORD dwXOrigin; + DWORD dwYOrigin; +} KSVPSURFACEPARAMS, *PKSVPSURFACEPARAMS; + +#else // !defined(__IVPType__) + +#if !defined(__DDRAW_INCLUDED__) + +//========================================================================== +// The following definitions must be in sync with DDraw.h in DirectX SDK +//========================================================================== + +/* + * The FourCC code is valid. + */ +#define DDPF_FOURCC 0x00000004l + +#ifndef _DDPIXELFORMAT_DEFINED +#define _DDPIXELFORMAT_DEFINED +typedef struct _DDPIXELFORMAT +{ + DWORD dwSize; // size of structure + DWORD dwFlags; // pixel format flags + DWORD dwFourCC; // (FOURCC code) + union + { + DWORD dwRGBBitCount; // how many bits per pixel (BD_1,2,4,8,16,24,32) + DWORD dwYUVBitCount; // how many bits per pixel (BD_4,8,16,24,32) + DWORD dwZBufferBitDepth; // how many bits for z buffers (BD_8,16,24,32) + DWORD dwAlphaBitDepth; // how many bits for alpha channels (BD_1,2,4,8) + }; + union + { + DWORD dwRBitMask; // mask for red bit + DWORD dwYBitMask; // mask for Y bits + }; + union + { + DWORD dwGBitMask; // mask for green bits + DWORD dwUBitMask; // mask for U bits + }; + union + { + DWORD dwBBitMask; // mask for blue bits + DWORD dwVBitMask; // mask for V bits + }; + union + { + DWORD dwRGBAlphaBitMask; // mask for alpha channel + DWORD dwYUVAlphaBitMask; // mask for alpha channel + DWORD dwRGBZBitMask; // mask for Z channel + DWORD dwYUVZBitMask; // mask for Z channel + }; +} DDPIXELFORMAT, * LPDDPIXELFORMAT; +#endif // _DDPIXELFORMAT_DEFINED + +#endif // !defined(__DDRAW_INCLUDED__) + +//========================================================================== +// End of DDraw.h header info +//========================================================================== + +//========================================================================== +// The following definitions must be in sync with DVP.h in DirectX SDK +//========================================================================== + +#if !defined(__DVP_INCLUDED__) + +typedef struct _DDVIDEOPORTCONNECT { + DWORD dwSize; // size of the DDVIDEOPORTCONNECT structure + DWORD dwPortWidth; // Width of the video port + GUID guidTypeID; // Description of video port connection + DWORD dwFlags; // Connection flags + ULONG_PTR dwReserved1; // Reserved, set to zero. +} DDVIDEOPORTCONNECT, * LPDDVIDEOPORTCONNECT; + +#define DDVPTYPE_E_HREFH_VREFH \ + 0x54F39980L,0xDA60,0x11CF,0x9B,0x06,0x00,0xA0,0xC9,0x03,0xA3,0xB8 + +#define DDVPTYPE_E_HREFL_VREFL \ + 0xE09C77E0L,0xDA60,0x11CF,0x9B,0x06,0x00,0xA0,0xC9,0x03,0xA3,0xB8 + +#endif // !defined(__DVP_INCLUDED__) + +//========================================================================== +// End of DVP.h header info +//========================================================================== + + +//========================================================================== +// The following definitions must be in sync with VPType.h in AM 2.0 SDK +//========================================================================== + +// pixel aspect ratios corresponding to a 720x480 NTSC image or a 720x576 image +typedef enum // AMPixAspectRatio +{ + KS_PixAspectRatio_NTSC4x3, + KS_PixAspectRatio_NTSC16x9, + KS_PixAspectRatio_PAL4x3, + KS_PixAspectRatio_PAL16x9 +} KS_AMPixAspectRatio ; + +typedef enum // AMVP_SELECTFORMATBY +{ + KS_AMVP_DO_NOT_CARE, + KS_AMVP_BEST_BANDWIDTH, + KS_AMVP_INPUT_SAME_AS_OUTPUT +} KS_AMVP_SELECTFORMATBY; + +typedef enum // AMVP_MODE +{ + KS_AMVP_MODE_WEAVE, + KS_AMVP_MODE_BOBINTERLEAVED, + KS_AMVP_MODE_BOBNONINTERLEAVED, + KS_AMVP_MODE_SKIPEVEN, + KS_AMVP_MODE_SKIPODD +} KS_AMVP_MODE ; + +typedef struct tagKS_AMVPDIMINFO // AMVPDIMINFO +{ + DWORD dwFieldWidth ; // [out] field width + DWORD dwFieldHeight ; // [out] field height + DWORD dwVBIWidth ; // [out] VBI data width + DWORD dwVBIHeight ; // [out] VBI data height + RECT rcValidRegion ; // [out] valid rect for data cropping +} KS_AMVPDIMINFO, *PKS_AMVPDIMINFO ; + +typedef struct tagKS_AMVPDATAINFO // AMVPDATAINFO +{ + DWORD dwSize; // Size of the struct + DWORD dwMicrosecondsPerField; // Time taken by each field + KS_AMVPDIMINFO amvpDimInfo; // Dimensional Information + DWORD dwPictAspectRatioX; // Pict aspect ratio in X dimn + DWORD dwPictAspectRatioY; // Pict aspect ratio in Y dimn + BOOL bEnableDoubleClock; // Videoport should enable double clocking + BOOL bEnableVACT; // Videoport should use an external VACT signal + BOOL bDataIsInterlaced; // Indicates that the signal is interlaced + LONG lHalfLinesOdd; // number of halflines in the odd field + BOOL bFieldPolarityInverted; // Device inverts the polarity by default + DWORD dwNumLinesInVREF; // Number of lines of data in VREF + LONG lHalfLinesEven; // number of halflines in the even field + DWORD dwReserved1; // Reserved for future use +} KS_AMVPDATAINFO, *PKS_AMVPDATAINFO; + +typedef struct tagKS_AMVPSIZE // AMVPSIZE +{ + DWORD dwWidth ; // [in] width in pixels + DWORD dwHeight ; // [in] height in pixels +} KS_AMVPSIZE, *PKS_AMVPSIZE ; + +//========================================================================== +// End of VPType.h header info +//========================================================================== + +typedef struct { + KS_AMVPSIZE Size; + DWORD MaxPixelsPerSecond; + DWORD Reserved; +} KSVPMAXPIXELRATE, *PKSVPMAXPIXELRATE; + +typedef struct { + KSPROPERTY Property; + KS_AMVPSIZE Size; +} KSVPSIZE_PROP, *PKSVPSIZE_PROP; + +typedef struct { + DWORD dwPitch; + DWORD dwXOrigin; + DWORD dwYOrigin; +} KSVPSURFACEPARAMS, *PKSVPSURFACEPARAMS; + +#endif // !defined(__IVPType__) + +// +// IVPNotify event notification +// +#define STATIC_KSEVENTSETID_VPNotify\ + 0x20c5598eL, 0xd3c8, 0x11d0, 0x8d, 0xfc, 0x00, 0xc0, 0x4f, 0xd7, 0xc0, 0x8b +DEFINE_GUIDSTRUCT("20c5598e-d3c8-11d0-8dfc-00c04fd7c08b", KSEVENTSETID_VPNotify); +#define KSEVENTSETID_VPNotify DEFINE_GUIDNAMED(KSEVENTSETID_VPNotify) + +typedef enum { + KSEVENT_VPNOTIFY_FORMATCHANGE +} KSEVENT_VPNOTIFY; + +// +// VIDCAPTOSTI event notification +// +#define STATIC_KSEVENTSETID_VIDCAPTOSTI\ + 0xdb47de20, 0xf628, 0x11d1, 0xba, 0x41, 0x0, 0xa0, 0xc9, 0xd, 0x2b, 0x5 +DEFINE_GUIDSTRUCT("DB47DE20-F628-11d1-BA41-00A0C90D2B05", KSEVENTSETID_VIDCAPTOSTI); +#define KSEVENTSETID_VIDCAPNotify DEFINE_GUIDNAMED(KSEVENTSETID_VIDCAPTOSTI) + +typedef enum { + KSEVENT_VIDCAPTOSTI_EXT_TRIGGER +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + , KSEVENT_VIDCAP_AUTO_UPDATE + , KSEVENT_VIDCAP_SEARCH +#endif // XP SP2 and later (chronologically) +} KSEVENT_VIDCAPTOSTI; + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +// +// Extension Unit Properties +// +typedef enum { + KSPROPERTY_EXTENSION_UNIT_INFO, // (R) + KSPROPERTY_EXTENSION_UNIT_CONTROL, // (RW) + KSPROPERTY_EXTENSION_UNIT_PASS_THROUGH = 0xffff // (RW) +} KSPROPERTY_EXTENSION_UNIT, *PKSPROPERTY_EXTENSION_UNIT; + +#endif // XP SP2 and later (chronologically) + +// +// IVPVBINotify event notification +// +#define STATIC_KSEVENTSETID_VPVBINotify\ + 0xec529b01L, 0x1a1f, 0x11d1, 0xba, 0xd9, 0x0, 0x60, 0x97, 0x44, 0x11, 0x1a +DEFINE_GUIDSTRUCT("ec529b01-1a1f-11d1-bad9-00609744111a", KSEVENTSETID_VPVBINotify); +#define KSEVENTSETID_VPVBINotify DEFINE_GUIDNAMED(KSEVENTSETID_VPVBINotify) + +typedef enum { + KSEVENT_VPVBINOTIFY_FORMATCHANGE +} KSEVENT_VPVBINOTIFY; + + +// +// closed caption information +// + +#define STATIC_KSDATAFORMAT_TYPE_AUXLine21Data \ +0x670aea80L, 0x3a82, 0x11d0, 0xb7, 0x9b, 0x00, 0xaa, 0x00, 0x37, 0x67, 0xa7 +DEFINE_GUIDSTRUCT("670aea80-3a82-11d0-b79b-00aa003767a7", KSDATAFORMAT_TYPE_AUXLine21Data); +#define KSDATAFORMAT_TYPE_AUXLine21Data DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_AUXLine21Data) + +#define STATIC_KSDATAFORMAT_SUBTYPE_Line21_BytePair \ +0x6e8d4a22L, 0x310c, 0x11d0, 0xb7, 0x9a, 0x00, 0xaa, 0x00, 0x37, 0x67, 0xa7 +DEFINE_GUIDSTRUCT("6e8d4a22-310c-11d0-b79a-00aa003767a7", KSDATAFORMAT_SUBTYPE_Line21_BytePair); +#define KSDATAFORMAT_SUBTYPE_Line21_BytePair DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_Line21_BytePair) + +#define STATIC_KSDATAFORMAT_SUBTYPE_Line21_GOPPacket \ +0x6e8d4a23L, 0x310c, 0x11d0, 0xb7, 0x9a, 0x00, 0xaa, 0x00, 0x37, 0x67, 0xa7 +DEFINE_GUIDSTRUCT("6e8d4a23-310c-11d0-b79a-00aa003767a7", KSDATAFORMAT_SUBTYPE_Line21_GOPPacket); +#define KSDATAFORMAT_SUBTYPE_Line21_GOPPacket DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_Line21_GOPPacket) + +typedef struct _KSGOP_USERDATA { + ULONG sc; + ULONG reserved1; + BYTE cFields; + CHAR l21Data[3]; +} KSGOP_USERDATA, *PKSGOP_USERDATA; + +// +// DVD encrypted PACK format type definition +// + +#define STATIC_KSDATAFORMAT_TYPE_DVD_ENCRYPTED_PACK\ + 0xed0b916a, 0x044d, 0x11d1, 0xaa, 0x78, 0x00, 0xc0, 0x4f, 0xc3, 0x1d, 0x60 +DEFINE_GUIDSTRUCT("ed0b916a-044d-11d1-aa78-00c04fc31d60", KSDATAFORMAT_TYPE_DVD_ENCRYPTED_PACK); +#define KSDATAFORMAT_TYPE_DVD_ENCRYPTED_PACK DEFINE_GUIDNAMED(KSDATAFORMAT_TYPE_DVD_ENCRYPTED_PACK) + +#define KS_AM_UseNewCSSKey 0x0001L +// ----------------------------------------------------------------------- +// KS_AM_KSPROPSETID_TSRateChange property set definitions for time stamp +// rate changes. +// ----------------------------------------------------------------------- + + +#define STATIC_KSPROPSETID_TSRateChange\ + 0xa503c5c0, 0x1d1d, 0x11d1, 0xad, 0x80, 0x44, 0x45, 0x53, 0x54, 0x0, 0x0 + +DEFINE_GUIDSTRUCT("A503C5C0-1D1D-11D1-AD80-444553540000", KSPROPSETID_TSRateChange); +#define KSPROPSETID_TSRateChange DEFINE_GUIDNAMED(KSPROPSETID_TSRateChange) +typedef enum { + KS_AM_RATE_SimpleRateChange=1, // rw, use KS_AM_SimpleRateChange + KS_AM_RATE_ExactRateChange=2, // rw, use KS_AM_ExactRateChange + KS_AM_RATE_MaxFullDataRate=3, // r, use KS_AM_MaxFullDataRate + KS_AM_RATE_Step=4 // w, use KS_AM_Step +} KS_AM_PROPERTY_TS_RATE_CHANGE; + +typedef struct { + // this is the simplest mechanism to set a time stamp rate change on + // a filter (simplest for the person setting the rate change, harder + // for the filter doing the rate change). + REFERENCE_TIME StartTime; //stream time at which to start this rate + LONG Rate; //new rate * 10000 (decimal) +} KS_AM_SimpleRateChange, *PKS_AM_SimpleRateChange; + +typedef struct { + REFERENCE_TIME OutputZeroTime; //input TS that maps to zero output TS + LONG Rate; //new rate * 10000 (decimal) +} KS_AM_ExactRateChange, *PKS_AM_ExactRateChange; + +typedef LONG KS_AM_MaxFullDataRate; //rate * 10000 (decimal) + +typedef DWORD KS_AM_Step; // number of frame to step + +#if (NTDDI_VERSION >= NTDDI_WINXPSP1) + +//=========================================================================== +//ENCODER API DEFINITIONS +//=========================================================================== + +#define STATIC_KSCATEGORY_ENCODER \ + 0x19689bf6, 0xc384, 0x48fd, 0xad, 0x51, 0x90, 0xe5, 0x8c, 0x79, 0xf7, 0xb +DEFINE_GUIDSTRUCT("19689BF6-C384-48fd-AD51-90E58C79F70B", KSCATEGORY_ENCODER); +#define KSCATEGORY_ENCODER DEFINE_GUIDNAMED(KSCATEGORY_ENCODER) + +#define STATIC_KSCATEGORY_MULTIPLEXER \ + 0x7a5de1d3, 0x1a1, 0x452c, 0xb4, 0x81, 0x4f, 0xa2, 0xb9, 0x62, 0x71, 0xe8 +DEFINE_GUIDSTRUCT("7A5DE1D3-01A1-452c-B481-4FA2B96271E8", KSCATEGORY_MULTIPLEXER); +#define KSCATEGORY_MULTIPLEXER DEFINE_GUIDNAMED(KSCATEGORY_MULTIPLEXER) + +#ifndef __ENCODER_API_GUIDS__ +#define __ENCODER_API_GUIDS__ + +#define STATIC_ENCAPIPARAM_BITRATE \ + 0x49cc4c43, 0xca83, 0x4ad4, 0xa9, 0xaf, 0xf3, 0x69, 0x6a, 0xf6, 0x66, 0xdf +DEFINE_GUIDSTRUCT("49CC4C43-CA83-4ad4-A9AF-F3696AF666DF", ENCAPIPARAM_BITRATE); +#define ENCAPIPARAM_BITRATE DEFINE_GUIDNAMED(ENCAPIPARAM_BITRATE) + +#define STATIC_ENCAPIPARAM_PEAK_BITRATE \ + 0x703f16a9, 0x3d48, 0x44a1, 0xb0, 0x77, 0x1, 0x8d, 0xff, 0x91, 0x5d, 0x19 +DEFINE_GUIDSTRUCT("703F16A9-3D48-44a1-B077-018DFF915D19", ENCAPIPARAM_PEAK_BITRATE); +#define ENCAPIPARAM_PEAK_BITRATE DEFINE_GUIDNAMED(ENCAPIPARAM_PEAK_BITRATE) + +#define STATIC_ENCAPIPARAM_BITRATE_MODE \ + 0xee5fb25c, 0xc713, 0x40d1, 0x9d, 0x58, 0xc0, 0xd7, 0x24, 0x1e, 0x25, 0xf +DEFINE_GUIDSTRUCT("EE5FB25C-C713-40d1-9D58-C0D7241E250F", ENCAPIPARAM_BITRATE_MODE); +#define ENCAPIPARAM_BITRATE_MODE DEFINE_GUIDNAMED(ENCAPIPARAM_BITRATE_MODE) + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +#define STATIC_CODECAPI_CHANGELISTS \ + 0x62b12acf, 0xf6b0, 0x47d9, 0x94, 0x56, 0x96, 0xf2, 0x2c, 0x4e, 0x0b, 0x9d +DEFINE_GUIDSTRUCT("62B12ACF-F6B0-47D9-9456-96F22C4E0B9D", CODECAPI_CHANGELISTS ); +#define CODECAPI_CHANGELISTS DEFINE_GUIDNAMED(CODECAPI_CHANGELISTS ) + +#define STATIC_CODECAPI_VIDEO_ENCODER \ + 0x7112e8e1, 0x3d03, 0x47ef, 0x8e, 0x60, 0x03, 0xf1, 0xcf, 0x53, 0x73, 0x01 +DEFINE_GUIDSTRUCT("7112E8E1-3D03-47EF-8E60-03F1CF537301", CODECAPI_VIDEO_ENCODER ); +#define CODECAPI_VIDEO_ENCODER DEFINE_GUIDNAMED(CODECAPI_VIDEO_ENCODER ) + +#define STATIC_CODECAPI_AUDIO_ENCODER \ + 0xb9d19a3e, 0xf897, 0x429c, 0xbc, 0x46, 0x81, 0x38, 0xb7, 0x27, 0x2b, 0x2d +DEFINE_GUIDSTRUCT("B9D19A3E-F897-429C-BC46-8138B7272B2D", CODECAPI_AUDIO_ENCODER ); +#define CODECAPI_AUDIO_ENCODER DEFINE_GUIDNAMED(CODECAPI_AUDIO_ENCODER ) + +#define STATIC_CODECAPI_SETALLDEFAULTS \ + 0x6c5e6a7c, 0xacf8, 0x4f55, 0xa9, 0x99, 0x1a, 0x62, 0x81, 0x09, 0x05, 0x1b +DEFINE_GUIDSTRUCT("6C5E6A7C-ACF8-4F55-A999-1A628109051B", CODECAPI_SETALLDEFAULTS ); +#define CODECAPI_SETALLDEFAULTS DEFINE_GUIDNAMED(CODECAPI_SETALLDEFAULTS ) + +#define STATIC_CODECAPI_ALLSETTINGS \ + 0x6a577e92, 0x83e1, 0x4113, 0xad, 0xc2, 0x4f, 0xce, 0xc3, 0x2f, 0x83, 0xa1 +DEFINE_GUIDSTRUCT("6A577E92-83E1-4113-ADC2-4FCEC32F83A1", CODECAPI_ALLSETTINGS ); +#define CODECAPI_ALLSETTINGS DEFINE_GUIDNAMED(CODECAPI_ALLSETTINGS ) + +#define STATIC_CODECAPI_SUPPORTSEVENTS \ + 0x0581af97, 0x7693, 0x4dbd, 0x9d, 0xca, 0x3f, 0x9e, 0xbd, 0x65, 0x85, 0xa1 +DEFINE_GUIDSTRUCT("0581AF97-7693-4DBD-9DCA-3F9EBD6585A1", CODECAPI_SUPPORTSEVENTS ); +#define CODECAPI_SUPPORTSEVENTS DEFINE_GUIDNAMED(CODECAPI_SUPPORTSEVENTS ) + +#define STATIC_CODECAPI_CURRENTCHANGELIST \ + 0x1cb14e83, 0x7d72, 0x4657, 0x83, 0xfd, 0x47, 0xa2, 0xc5, 0xb9, 0xd1, 0x3d +DEFINE_GUIDSTRUCT("1CB14E83-7D72-4657-83FD-47A2C5B9D13D", CODECAPI_CURRENTCHANGELIST ); +#define CODECAPI_CURRENTCHANGELIST DEFINE_GUIDNAMED(CODECAPI_CURRENTCHANGELIST ) + +#endif // XP SP2 and later (chronologically) + +#endif // __ENCODER_API_GUIDS__ + +#ifndef __ENCODER_API_DEFINES__ +#define __ENCODER_API_DEFINES__ + +typedef enum { + + // + // Bit rate used for encoding is constant + // + ConstantBitRate = 0, + + // + // Bit rate used for encoding is variable with the specified bitrate used + // as a guaranteed average over a specified window. The default window + // size is considered to be 5 minutes. + // + VariableBitRateAverage, + + // + // Bit rate used for encoding is variable with the specified bitrate used + // as an average with a peak not to exceed the specified peak bitrate over + // a specified window. The default window size is considered to be 500ms + // (classically one GOP). + // + VariableBitRatePeak + +} VIDEOENCODER_BITRATE_MODE; + +#endif // __ENCODER_API_DEFINES__ + +//=========================================================================== +// JACK DESCRIPTION DEFINITIONS +//=========================================================================== +#define STATIC_KSPROPSETID_Jack\ + 0x4509f757, 0x2d46, 0x4637, 0x8e, 0x62, 0xce, 0x7d, 0xb9, 0x44, 0xf5, 0x7b +DEFINE_GUIDSTRUCT("4509F757-2D46-4637-8E62-CE7DB944F57B", KSPROPSETID_Jack); +#define KSPROPSETID_Jack DEFINE_GUIDNAMED(KSPROPSETID_Jack) + +// define new property id +typedef enum { + KSPROPERTY_JACK_DESCRIPTION = 1, + KSPROPERTY_JACK_DESCRIPTION2, + KSPROPERTY_JACK_SINK_INFO, + KSPROPERTY_JACK_CONTAINERID +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) + , KSPROPERTY_JACK_DESCRIPTION3 +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) +} KSPROPERTY_JACK; + +// Enums used in KSPROPERTY_JACK_INFO_STRUCT + +typedef enum +{ + eConnTypeUnknown, + eConnType3Point5mm, + eConnTypeQuarter, + eConnTypeAtapiInternal, + eConnTypeRCA, + eConnTypeOptical, + eConnTypeOtherDigital, + eConnTypeOtherAnalog, + eConnTypeMultichannelAnalogDIN, + eConnTypeXlrProfessional, + eConnTypeRJ11Modem, + eConnTypeCombination +} EPcxConnectionType; + +#define eGeoLocReserved5 eGeoLocNotApplicable +typedef enum +{ + eGeoLocRear = 0x1, + eGeoLocFront, + eGeoLocLeft, + eGeoLocRight, + eGeoLocTop, + eGeoLocBottom, + eGeoLocRearPanel, + eGeoLocRiser, + eGeoLocInsideMobileLid, + eGeoLocDrivebay, + eGeoLocHDMI, + eGeoLocOutsideMobileLid, + eGeoLocATAPI, + eGeoLocNotApplicable, + eGeoLocReserved6, + EPcxGeoLocation_enum_count +} EPcxGeoLocation; + +typedef enum +{ + eGenLocPrimaryBox = 0, + eGenLocInternal, + eGenLocSeparate, + eGenLocOther, + EPcxGenLocation_enum_count +} EPcxGenLocation; + +typedef enum +{ + ePortConnJack = 0, + ePortConnIntegratedDevice, + ePortConnBothIntegratedAndJack, + ePortConnUnknown +} EPxcPortConnection; + +// structure for KSPROPERTY_JACK_DESCRIPTION pin property +typedef struct +{ + DWORD ChannelMapping; + DWORD Color; // 0x00rrggbb; (NOT a COLORREF) + EPcxConnectionType ConnectionType; + EPcxGeoLocation GeoLocation; + EPcxGenLocation GenLocation; + EPxcPortConnection PortConnection; + BOOL IsConnected; +} KSJACK_DESCRIPTION, *PKSJACK_DESCRIPTION; + +typedef enum +{ + KSJACK_SINK_CONNECTIONTYPE_HDMI = 0, // HDMI + KSJACK_SINK_CONNECTIONTYPE_DISPLAYPORT, // DisplayPort +} KSJACK_SINK_CONNECTIONTYPE; + +#define MAX_SINK_DESCRIPTION_NAME_LENGTH 32 +typedef struct _tagKSJACK_SINK_INFORMATION +{ + KSJACK_SINK_CONNECTIONTYPE ConnType; // Connection Type + WORD ManufacturerId; // Sink manufacturer ID + WORD ProductId; // Sink product ID + WORD AudioLatency; // Sink audio latency + BOOL HDCPCapable; // HDCP Support + BOOL AICapable; // ACP Packet, ISRC1, and ISRC2 Support + UCHAR SinkDescriptionLength; // Monitor/Sink name length + WCHAR SinkDescription[MAX_SINK_DESCRIPTION_NAME_LENGTH]; // Monitor/Sink name + LUID PortId; // Video port identifier +} KSJACK_SINK_INFORMATION, *PKSJACK_SINK_INFORMATION; + +#define JACKDESC2_PRESENCE_DETECT_CAPABILITY 0x00000001 +#define JACKDESC2_DYNAMIC_FORMAT_CHANGE_CAPABILITY 0x00000002 + +typedef struct _tagKSJACK_DESCRIPTION2 +{ + DWORD DeviceStateInfo; // Top 16 bits: Report current device state, active, streaming, idle, or hardware not ready + // Bottom 16 bits: detailed reason to further explain state in top 16 bits + DWORD JackCapabilities; // Report jack capabilities such as jack presence detection capability + // or dynamic format changing capability +} KSJACK_DESCRIPTION2, *PKSJACK_DESCRIPTION2; + +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +typedef struct _tagKSJACK_DESCRIPTION3 +{ + ULONG ConfigId; // Driver defined bitmask or enum describing the current configuration, changing this value causes + // audioendpointbuilder to refresh the cache to ensure that the published endpoint matches the current config. +} KSJACK_DESCRIPTION3, *PKSJACK_DESCRIPTION3; +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) + +#endif // (NTDDI_VERSION >= NTDDI_WINXPSP1) + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) +//=========================================================================== +// AUDIO POSTURE DEFINITIONS +//=========================================================================== +// {A3FB7B0D-474E-4F51-A379-51282DD4FA8F} +#define STATIC_KSPROPSETID_AudioPosture\ + 0xa3fb7b0d, 0x474e, 0x4f51, 0xa3, 0x79, 0x51, 0x28, 0x2d, 0xd4, 0xfa, 0x8f +DEFINE_GUIDSTRUCT("A3FB7B0D-474E-4F51-A379-51282DD4FA8F", KSPROPSETID_AudioPosture); +#define KSPROPSETID_AudioPosture DEFINE_GUIDNAMED(KSPROPSETID_AudioPosture) + +typedef enum { + KSPROPERTY_AUDIOPOSTURE_ORIENTATION = 1 +} KSPROPERTY_AUDIOPOSTURE; + +typedef enum +{ + AUDIOPOSTURE_ORIENTATION_NOTROTATED = 0, + AUDIOPOSTURE_ORIENTATION_ROTATED90DEGREESCOUNTERCLOCKWISE, + AUDIOPOSTURE_ORIENTATION_ROTATED180DEGREESCOUNTERCLOCKWISE, + AUDIOPOSTURE_ORIENTATION_ROTATED270DEGREESCOUNTERCLOCKWISE +} AUDIOPOSTURE_ORIENTATION; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_FE) + +//=========================================================================== +// Audio Buffer Duration +#define STATIC_KSPROPSETID_AudioBufferDuration\ + 0x4e73c07f, 0x23cc, 0x4955, 0xa7, 0xea, 0x3d, 0xa5, 0x2, 0x49, 0x62, 0x90 +DEFINE_GUIDSTRUCT("4E73C07F-23CC-4955-A7EA-3DA502496290", KSPROPSETID_AudioBufferDuration); +#define KSPROPSETID_AudioBufferDuration DEFINE_GUIDNAMED(KSPROPSETID_AudioBufferDuration) + +// define new property id +#define KSPROPERTY_AUDIO_BUFFER_DURATION 1 + +//=========================================================================== +// HARDWARE AUDIO ENGINE DEFINITIONS +//=========================================================================== +#define STATIC_KSPROPSETID_AudioEngine\ + 0x3A2F82DCL, 0x886F, 0x4BAA, 0x9E, 0xB4, 0x8, 0x2B, 0x90, 0x25, 0xC5, 0x36 +DEFINE_GUIDSTRUCT("3A2F82DC-886F-4BAA-9EB4-082B9025C536", KSPROPSETID_AudioEngine); +#define KSPROPSETID_AudioEngine DEFINE_GUIDNAMED(KSPROPSETID_AudioEngine) + +typedef enum { + KSPROPERTY_AUDIOENGINE_LFXENABLE = 0, + KSPROPERTY_AUDIOENGINE_GFXENABLE = 1, + KSPROPERTY_AUDIOENGINE_MIXFORMAT = 2, + // constant "3" was skipped on purpose for backward compatibility + // from the removal of unused KSPROPERTY_AUDIOENGINE_PROCESSINGPERIOD + KSPROPERTY_AUDIOENGINE_DEVICEFORMAT = 4, + KSPROPERTY_AUDIOENGINE_SUPPORTEDDEVICEFORMATS = 5, + KSPROPERTY_AUDIOENGINE_DESCRIPTOR = 6, + KSPROPERTY_AUDIOENGINE_BUFFER_SIZE_RANGE = 7, + KSPROPERTY_AUDIOENGINE_LOOPBACK_PROTECTION = 8, + KSPROPERTY_AUDIOENGINE_VOLUMELEVEL = 9, +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) + KSPROPERTY_AUDIOENGINE_DEVICECONTROLS = 10, +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) +} KSPROPERTY_AUDIOENGINE; + +typedef struct _tagKSAUDIOENGINE_DESCRIPTOR +{ + UINT nHostPinId; + UINT nOffloadPinId; + UINT nLoopbackPinId; +} KSAUDIOENGINE_DESCRIPTOR, *PKSAUDIOENGINE_DESCRIPTOR; + +typedef struct _tagKSAUDIOENGINE_BUFFER_SIZE_RANGE +{ + ULONG MinBufferBytes; + ULONG MaxBufferBytes; +} KSAUDIOENGINE_BUFFER_SIZE_RANGE, *PKSAUDIOENGINE_BUFFER_SIZE_RANGE; + +#ifndef _AUDIO_CURVE_TYPE_ +#define _AUDIO_CURVE_TYPE_ +typedef enum { + AUDIO_CURVE_TYPE_NONE = 0, + AUDIO_CURVE_TYPE_WINDOWS_FADE = 1, +} AUDIO_CURVE_TYPE; +#endif // _AUDIO_CURVE_TYPE_ + +typedef struct _tagKSAUDIOENGINE_VOLUMELEVEL +{ + LONG TargetVolume; + AUDIO_CURVE_TYPE CurveType; + ULONGLONG CurveDuration; +} KSAUDIOENGINE_VOLUMELEVEL, *PKSAUDIOENGINE_VOLUMELEVEL; + +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +typedef enum { + eDeviceControlUseMissing = 0, + eDeviceControlUsePrimary = 1, + eDeviceControlUseSecondary = 2, +} EDeviceControlUseType; + +typedef struct _tagKSAUDIOENGINE_DEVICECONTROLS +{ + EDeviceControlUseType Volume; + EDeviceControlUseType Mute; + EDeviceControlUseType PeakMeter; +} KSAUDIOENGINE_DEVICECONTROLS, *PKSAUDIOENGINE_DEVICECONTROLS; +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) + +//=========================================================================== +// AUDIO SIGNAL PROCESSING DEFINITIONS +//=========================================================================== + +#define STATIC_KSPROPSETID_AudioSignalProcessing\ + 0x4f67b528, 0x30c9, 0x40de, 0xb2, 0xfb, 0x85, 0x9d, 0xdd, 0x1f, 0x34, 0x70 +DEFINE_GUIDSTRUCT("4F67B528-30C9-40DE-B2FB-859DDD1F3470", KSPROPSETID_AudioSignalProcessing); +#define KSPROPSETID_AudioSignalProcessing DEFINE_GUIDNAMED(KSPROPSETID_AudioSignalProcessing) + +typedef enum { + KSPROPERTY_AUDIOSIGNALPROCESSING_MODES, +} KSPROPERTY_AUDIOSIGNALPROCESSING; + +#define STATIC_KSATTRIBUTEID_AUDIOSIGNALPROCESSING_MODE 0xe1f89eb5, 0x5f46, 0x419b, 0x96, 0x7b, 0xff, 0x67, 0x70, 0xb9, 0x84, 0x1 +DEFINE_GUIDSTRUCT("E1F89EB5-5F46-419B-967B-FF6770B98401", KSATTRIBUTEID_AUDIOSIGNALPROCESSING_MODE); +#define KSATTRIBUTEID_AUDIOSIGNALPROCESSING_MODE DEFINE_GUIDNAMED(KSATTRIBUTEID_AUDIOSIGNALPROCESSING_MODE) + +// Define structure of the KSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE attribute +typedef struct tagKSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE +{ + KSATTRIBUTE AttributeHeader; + GUID SignalProcessingMode; +} KSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE, *PKSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE; + +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_DEFAULT 0xc18e2f7e, 0x933d, 0x4965, 0xb7, 0xd1, 0x1e, 0xef, 0x22, 0x8d, 0x2a, 0xf3 +DEFINE_GUIDSTRUCT("C18E2F7E-933D-4965-B7D1-1EEF228D2AF3", AUDIO_SIGNALPROCESSINGMODE_DEFAULT); +#define AUDIO_SIGNALPROCESSINGMODE_DEFAULT DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_DEFAULT) + +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_RAW 0x9e90ea20, 0xb493, 0x4fd1, 0xa1, 0xa8, 0x7e, 0x13, 0x61, 0xa9, 0x56, 0xcf +DEFINE_GUIDSTRUCT("9E90EA20-B493-4FD1-A1A8-7E1361A956CF", AUDIO_SIGNALPROCESSINGMODE_RAW); +#define AUDIO_SIGNALPROCESSINGMODE_RAW DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_RAW) + +#if (NTDDI_VERSION >= NTDDI_WIN10_CU) +//=========================================================================== +// AUDIO LOOPBACK DEFINITIONS +//=========================================================================== + +#define STATIC_KSPROPSETID_AudioLoopback 0xb3648bc8, 0x5b91, 0x468a, 0xb9, 0x4d, 0xf4, 0x64, 0x12, 0x50, 0x91, 0x7c +DEFINE_GUIDSTRUCT("B3648BC8-5B91-468A-B94D-F4641250917C", KSPROPSETID_AudioLoopback); +#define KSPROPSETID_AudioLoopback DEFINE_GUIDNAMED(KSPROPSETID_AudioLoopback) + +typedef enum { + KSPROPERTY_AUDIOLOOPBACK_TAPPOINT_CAPS, +} KSPROPERTY_AUDIOLOOPBACK; + +#define AUDIOLOOPBACK_TAPPOINT_CAPS_PREVOLUMEMUTE (0x1) +#define AUDIOLOOPBACK_TAPPOINT_CAPS_POSTVOLUMEMUTE (0x2) + +#define STATIC_KSATTRIBUTEID_AUDIOLOOPBACK_TAPPOINT 0x2795a0f7, 0x1688, 0x44fe, 0xbc, 0x14, 0xbf, 0x82, 0x73, 0x99, 0x21, 0x41 +DEFINE_GUIDSTRUCT("2795A0F7-1688-44FE-BC14-BF8273992141", KSATTRIBUTEID_AUDIOLOOPBACK_TAPPOINT); +#define KSATTRIBUTEID_AUDIOLOOPBACK_TAPPOINT DEFINE_GUIDNAMED(KSATTRIBUTEID_AUDIOLOOPBACK_TAPPOINT) + +typedef enum tagAUDIOLOOPBACK_TAPPOINT_TYPE +{ + AUDIOLOOPBACK_TAPPOINT_PREVOLUMEMUTE, + AUDIOLOOPBACK_TAPPOINT_POSTVOLUMEMUTE, +} AUDIOLOOPBACK_TAPPOINT_TYPE; + +// Define structure of the KSATTRIBUTE_AUDIOLOOPBACK_TAPPOINT attribute +typedef struct tagKSATTRIBUTE_AUDIOLOOPBACK_TAPPOINT +{ + KSATTRIBUTE AttributeHeader; + AUDIOLOOPBACK_TAPPOINT_TYPE TapPoint; +} KSATTRIBUTE_AUDIOLOOPBACK_TAPPOINT, *PKSATTRIBUTE_AUDIOLOOPBACK_TAPPOINT; +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CU) + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +//=========================================================================== +// AUDIO RESOURCE MANAGEMENT DEFINITIONS +//=========================================================================== +// {D0B305E1-B2CC-484C-8F23-E5D28AD9CF88} +#define STATIC_KSPROPSETID_AudioResourceManagement\ + 0xd0b305e1, 0xb2cc, 0x484c, 0x8f, 0x23, 0xe5, 0xd2, 0x8a, 0xd9, 0xcf, 0x88 +DEFINE_GUIDSTRUCT("D0B305E1-B2CC-484C-8F23-E5D28AD9CF88", KSPROPSETID_AudioResourceManagement); +#define KSPROPSETID_AudioResourceManagement DEFINE_GUIDNAMED(KSPROPSETID_AudioResourceManagement) + +// define new property id +typedef enum { + KSPROPERTY_AUDIORESOURCEMANAGEMENT_RESOURCEGROUP +} KSPROPERTY_AUDIORESOURCEMANAGEMENT; + +#define MAX_RESOURCEGROUPID_LENGTH 256 + +// structure for KSPROPERTY_AUDIORESOURCEMANAGEMENT_RESOURCEGROUP +typedef struct +{ + BOOL ResourceGroupAcquired; + WCHAR ResourceGroupName[MAX_RESOURCEGROUPID_LENGTH]; +} AUDIORESOURCEMANAGEMENT_RESOURCEGROUP, *PAUDIORESOURCEMANAGEMENT_RESOURCEGROUP; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO) + +// +// UUIDs defined for Bluetooth Midi +// +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) + +// Bluetooth MIDI service UUID +#define STATIC_BLUETOOTHLE_MIDI_SERVICE_UUID \ + 0x03B80E5AL, 0xEDE8, 0x4B33, 0xA7, 0x51, 0x6C, 0xE3, 0x4E, 0xC4, 0xC7, 0x00 +DEFINE_GUIDSTRUCT("03B80E5A-EDE8-4B33-A751-6CE34EC4C700", BLUETOOTHLE_MIDI_SERVICE_UUID); +#define BLUETOOTHLE_MIDI_SERVICE_UUID DEFINE_GUIDNAMED(BLUETOOTHLE_MIDI_SERVICE_UUID) + +// Bluetooth MIDI IO Characteristic UUID +#define STATIC_BLUETOOTH_MIDI_DATAIO_CHARACTERISTIC \ + 0x7772E5DBL, 0x3868, 0x4112, 0xA1, 0xA9, 0xF2, 0x66, 0x9D, 0x10, 0x6B, 0xF3 +DEFINE_GUIDSTRUCT("7772E5DB-3868-4112-A1A9-F2669D106BF3", BLUETOOTH_MIDI_DATAIO_CHARACTERISTIC); +#define BLUETOOTH_MIDI_DATAIO_CHARACTERISTIC DEFINE_GUIDNAMED(BLUETOOTH_MIDI_DATAIO_CHARACTERISTIC) + +// +// UUID for Audio Processing Object (APO) device class +// +#define STATIC_APO_CLASS_UUID \ + 0x5989fce8L, 0x9cd0, 0x467d, 0x8a, 0x6a, 0x54, 0x19, 0xe3, 0x15, 0x29, 0xd4 +DEFINE_GUIDSTRUCT("5989fce8-9cd0-467d-8a6a-5419e31529d4", APO_CLASS_UUID); +#define APO_CLASS_UUID DEFINE_GUIDNAMED(APO_CLASS_UUID) + +// +// UUID for audio endpoint device class +// +#define STATIC_AUDIOENDPOINT_CLASS_UUID \ + 0xC166523CL, 0xFE0C, 0x4A94, 0xA5, 0x86, 0xF1, 0xA8, 0x0C, 0xFB, 0xBF, 0x3E +DEFINE_GUIDSTRUCT("C166523C-FE0C-4A94-A586-F1A80CFBBF3E", AUDIOENDPOINT_CLASS_UUID); +#define AUDIOENDPOINT_CLASS_UUID DEFINE_GUIDNAMED(AUDIOENDPOINT_CLASS_UUID) + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS1) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +// Communications mode specifies that the application expects VoIP specific signal processing at the lowest latency and the hardware preferred sample rate for wideband speech (such as 16 kHz). +// For both Capture and Render. +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_COMMUNICATIONS 0x98951333, 0xb9cd, 0x48b1, 0xa0, 0xa3, 0xff, 0x40, 0x68, 0x2d, 0x73, 0xf7 +DEFINE_GUIDSTRUCT("98951333-B9CD-48B1-A0A3-FF40682D73F7", AUDIO_SIGNALPROCESSINGMODE_COMMUNICATIONS); +#define AUDIO_SIGNALPROCESSINGMODE_COMMUNICATIONS DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_COMMUNICATIONS) + +// Speech mode specifies that the application expects speech recognition specific signal processing at the lowest latency and the hardware preferred sample rate for wideband speech (such as 16 kHz). +// For Capture only. +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_SPEECH 0xfc1cfc9b, 0xb9d6, 0x4cfa, 0xb5, 0xe0, 0x4b, 0xb2, 0x16, 0x68, 0x78, 0xb2 +DEFINE_GUIDSTRUCT("FC1CFC9B-B9D6-4CFA-B5E0-4BB2166878B2", AUDIO_SIGNALPROCESSINGMODE_SPEECH); +#define AUDIO_SIGNALPROCESSINGMODE_SPEECH DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_SPEECH) + +// Notification Mode +// For both render and capture. +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_NOTIFICATION 0x9cf2a70b, 0xf377, 0x403b, 0xbd, 0x6b, 0x36, 0x8, 0x63, 0xe0, 0x35, 0x5c +DEFINE_GUIDSTRUCT("9CF2A70B-F377-403B-BD6B-360863E0355C", AUDIO_SIGNALPROCESSINGMODE_NOTIFICATION); +#define AUDIO_SIGNALPROCESSINGMODE_NOTIFICATION DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_NOTIFICATION) + +// Media Mode specifies that the application expects post processing suitable for media content if available or else the same treatments as Default mode. +// For Render only. +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_MEDIA 0x4780004e, 0x7133, 0x41d8, 0x8c, 0x74, 0x66, 0x0d, 0xad, 0xd2, 0xc0, 0xee +DEFINE_GUIDSTRUCT("4780004E-7133-41D8-8C74-660DADD2C0EE", AUDIO_SIGNALPROCESSINGMODE_MEDIA); +#define AUDIO_SIGNALPROCESSINGMODE_MEDIA DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_MEDIA) + +// Movie Mode specifies that the application expects post processing suitable for movie or video content if available or else the same treatments as Default mode. +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_MOVIE 0xb26feb0d, 0xec94, 0x477c, 0x94, 0x94, 0xd1, 0xab, 0x8e, 0x75, 0x3f, 0x6e +DEFINE_GUIDSTRUCT("B26FEB0D-EC94-477C-9494-D1AB8E753F6E", AUDIO_SIGNALPROCESSINGMODE_MOVIE); +#define AUDIO_SIGNALPROCESSINGMODE_MOVIE DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_MOVIE) + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + +// Far-Field speech mode specifies that the application expects speech recognition from the far-field +// For capture only +#define STATIC_AUDIO_SIGNALPROCESSINGMODE_FAR_FIELD_SPEECH 0x28941cba, 0x3be6, 0x4a78, 0x9a, 0x76, 0x30, 0xfd, 0x91, 0x55, 0x9b, 0x64 +DEFINE_GUIDSTRUCT("28941CBA-3BE6-4A78-9A76-30FD91559B64", AUDIO_SIGNALPROCESSINGMODE_FAR_FIELD_SPEECH); +#define AUDIO_SIGNALPROCESSINGMODE_FAR_FIELD_SPEECH DEFINE_GUIDNAMED(AUDIO_SIGNALPROCESSINGMODE_FAR_FIELD_SPEECH) + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_FE) + +#define STATIC_AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION 0x6f64adbe, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adbe-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION); +#define AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION) + +#define STATIC_AUDIO_EFFECT_TYPE_NOISE_SUPPRESSION 0x6f64adbf, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adbf-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_NOISE_SUPPRESSION); +#define AUDIO_EFFECT_TYPE_NOISE_SUPPRESSION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_NOISE_SUPPRESSION) + +#define STATIC_AUDIO_EFFECT_TYPE_AUTOMATIC_GAIN_CONTROL 0x6f64adc0, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc0-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_AUTOMATIC_GAIN_CONTROL); +#define AUDIO_EFFECT_TYPE_AUTOMATIC_GAIN_CONTROL DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_AUTOMATIC_GAIN_CONTROL) + +#define STATIC_AUDIO_EFFECT_TYPE_BEAMFORMING 0x6f64adc1, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc1-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_BEAMFORMING); +#define AUDIO_EFFECT_TYPE_BEAMFORMING DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_BEAMFORMING) + +#define STATIC_AUDIO_EFFECT_TYPE_CONSTANT_TONE_REMOVAL 0x6f64adc2, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc2-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_CONSTANT_TONE_REMOVAL); +#define AUDIO_EFFECT_TYPE_CONSTANT_TONE_REMOVAL DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_CONSTANT_TONE_REMOVAL) + +#define STATIC_AUDIO_EFFECT_TYPE_EQUALIZER 0x6f64adc3, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc3-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_EQUALIZER); +#define AUDIO_EFFECT_TYPE_EQUALIZER DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_EQUALIZER) + +#define STATIC_AUDIO_EFFECT_TYPE_LOUDNESS_EQUALIZER 0x6f64adc4, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc4-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_LOUDNESS_EQUALIZER); +#define AUDIO_EFFECT_TYPE_LOUDNESS_EQUALIZER DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_LOUDNESS_EQUALIZER) + +#define STATIC_AUDIO_EFFECT_TYPE_BASS_BOOST 0x6f64adc5, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc5-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_BASS_BOOST); +#define AUDIO_EFFECT_TYPE_BASS_BOOST DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_BASS_BOOST) + +#define STATIC_AUDIO_EFFECT_TYPE_VIRTUAL_SURROUND 0x6f64adc6, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc6-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_VIRTUAL_SURROUND); +#define AUDIO_EFFECT_TYPE_VIRTUAL_SURROUND DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_VIRTUAL_SURROUND) + +#define STATIC_AUDIO_EFFECT_TYPE_VIRTUAL_HEADPHONES 0x6f64adc7, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc7-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_VIRTUAL_HEADPHONES); +#define AUDIO_EFFECT_TYPE_VIRTUAL_HEADPHONES DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_VIRTUAL_HEADPHONES) + +#define STATIC_AUDIO_EFFECT_TYPE_SPEAKER_FILL 0x6f64adc8, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc8-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_SPEAKER_FILL); +#define AUDIO_EFFECT_TYPE_SPEAKER_FILL DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_SPEAKER_FILL) + +#define STATIC_AUDIO_EFFECT_TYPE_ROOM_CORRECTION 0x6f64adc9, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adc9-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_ROOM_CORRECTION); +#define AUDIO_EFFECT_TYPE_ROOM_CORRECTION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_ROOM_CORRECTION) + +#define STATIC_AUDIO_EFFECT_TYPE_BASS_MANAGEMENT 0x6f64adca, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adca-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_BASS_MANAGEMENT); +#define AUDIO_EFFECT_TYPE_BASS_MANAGEMENT DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_BASS_MANAGEMENT) + +#define STATIC_AUDIO_EFFECT_TYPE_ENVIRONMENTAL_EFFECTS 0x6f64adcb, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adcb-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_ENVIRONMENTAL_EFFECTS); +#define AUDIO_EFFECT_TYPE_ENVIRONMENTAL_EFFECTS DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_ENVIRONMENTAL_EFFECTS) + +#define STATIC_AUDIO_EFFECT_TYPE_SPEAKER_PROTECTION 0x6f64adcc, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adcc-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_SPEAKER_PROTECTION); +#define AUDIO_EFFECT_TYPE_SPEAKER_PROTECTION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_SPEAKER_PROTECTION) + +#define STATIC_AUDIO_EFFECT_TYPE_SPEAKER_COMPENSATION 0x6f64adcd, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adcd-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_SPEAKER_COMPENSATION); +#define AUDIO_EFFECT_TYPE_SPEAKER_COMPENSATION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_SPEAKER_COMPENSATION) + +#define STATIC_AUDIO_EFFECT_TYPE_DYNAMIC_RANGE_COMPRESSION 0x6f64adce, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adce-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_DYNAMIC_RANGE_COMPRESSION); +#define AUDIO_EFFECT_TYPE_DYNAMIC_RANGE_COMPRESSION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_DYNAMIC_RANGE_COMPRESSION) + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + +#define STATIC_AUDIO_EFFECT_TYPE_FAR_FIELD_BEAMFORMING 0x6f64adcf, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64adcf-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_FAR_FIELD_BEAMFORMING); +#define AUDIO_EFFECT_TYPE_FAR_FIELD_BEAMFORMING DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_FAR_FIELD_BEAMFORMING) + +#define STATIC_AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION 0x6f64add0, 0x8211, 0x11e2, 0x8c, 0x70, 0x2c, 0x27, 0xd7, 0xf0, 0x01, 0xfa +DEFINE_GUIDSTRUCT("6f64add0-8211-11e2-8c70-2c27d7f001fa", AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION); +#define AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION DEFINE_GUIDNAMED(AUDIO_EFFECT_TYPE_DEEP_NOISE_SUPPRESSION) + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_FE) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) +// +// Interface to get audio modules information. +// +#define STATIC_KSPROPSETID_AudioModule \ + 0xc034fdb0, 0xff75, 0x47c8, 0xaa, 0x3c, 0xee, 0x46, 0x71, 0x6b, 0x50, 0xc6 +DEFINE_GUIDSTRUCT("C034FDB0-FF75-47C8-AA3C-EE46716B50C6", KSPROPSETID_AudioModule); +#define KSPROPSETID_AudioModule DEFINE_GUIDNAMED(KSPROPSETID_AudioModule) + +typedef enum { + KSPROPERTY_AUDIOMODULE_DESCRIPTORS = 1, + KSPROPERTY_AUDIOMODULE_COMMAND = 2, + KSPROPERTY_AUDIOMODULE_NOTIFICATION_DEVICE_ID = 3, +} KSPROPERTY_AUDIOMODULE; + +#define AUDIOMODULE_MAX_DATA_SIZE 64000 +#define AUDIOMODULE_MAX_NAME_CCH_SIZE 128 + +typedef struct _KSAUDIOMODULE_DESCRIPTOR +{ + GUID ClassId; + ULONG InstanceId; + ULONG VersionMajor; + ULONG VersionMinor; + WCHAR Name[AUDIOMODULE_MAX_NAME_CCH_SIZE]; +} KSAUDIOMODULE_DESCRIPTOR, *PKSAUDIOMODULE_DESCRIPTOR; + +typedef struct _KSAUDIOMODULE_PROPERTY +{ + KSPROPERTY Property; + GUID ClassId; + ULONG InstanceId; +} KSAUDIOMODULE_PROPERTY, *PKSAUDIOMODULE_PROPERTY; + +// +// Audio module notification definitions. +// +#define STATIC_KSNOTIFICATIONID_AudioModule \ + 0x9C2220F0, 0xD9A6, 0x4D5C, 0xA0, 0x36, 0x57, 0x38, 0x57, 0xFD, 0x50, 0xD2 +DEFINE_GUIDSTRUCT("9C2220F0-D9A6-4D5C-A036-573857FD50D2", KSNOTIFICATIONID_AudioModule); +#define KSNOTIFICATIONID_AudioModule DEFINE_GUIDNAMED(KSNOTIFICATIONID_AudioModule) + +typedef struct _KSAUDIOMODULE_NOTIFICATION { + union { + struct { + GUID DeviceId; + GUID ClassId; + ULONG InstanceId; + ULONG Reserved; + } ProviderId; + LONGLONG Alignment; + }; +} KSAUDIOMODULE_NOTIFICATION, *PKSAUDIOMODULE_NOTIFICATION; + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS2) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // !defined(_KSMEDIA_) + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksproxy.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksproxy.h new file mode 100644 index 0000000000000000000000000000000000000000..1f0b101176b6c6f2406643328b52c63c3b9ea61f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksproxy.h @@ -0,0 +1,872 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ksproxy.h + +Abstract: + + Interface definitions for WDM-CSA proxy filters. + +--*/ + +#ifndef __KSPROXY__ +#define __KSPROXY__ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifdef __cplusplus +extern "C" { +#endif + +#undef KSDDKAPI +#ifdef _KSDDK_ +#define KSDDKAPI +#else // !_KSDDK_ +#define KSDDKAPI DECLSPEC_IMPORT +#endif // _KSDDK_ + +#define STATIC_IID_IKsObject\ + 0x423c13a2L, 0x2070, 0x11d0, 0x9e, 0xf7, 0x00, 0xaa, 0x00, 0xa2, 0x16, 0xa1 + +#define STATIC_IID_IKsPinEx\ + 0x7bb38260L, 0xd19c, 0x11d2, 0xb3, 0x8a, 0x00, 0xa0, 0xc9, 0x5e, 0xc2, 0x2e + +#define STATIC_IID_IKsPin\ + 0xb61178d1L, 0xa2d9, 0x11cf, 0x9e, 0x53, 0x00, 0xaa, 0x00, 0xa2, 0x16, 0xa1 + +#define STATIC_IID_IKsPinPipe\ + 0xe539cd90L, 0xa8b4, 0x11d1, 0x81, 0x89, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 + +#define STATIC_IID_IKsDataTypeHandler\ + 0x5ffbaa02L, 0x49a3, 0x11d0, 0x9f, 0x36, 0x00, 0xaa, 0x00, 0xa2, 0x16, 0xa1 + +#define STATIC_IID_IKsDataTypeCompletion\ + 0x827D1A0EL, 0x0F73, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#define STATIC_IID_IKsInterfaceHandler\ + 0xD3ABC7E0L, 0x9A61, 0x11D0, 0xA4, 0x0D, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#define STATIC_IID_IKsClockPropertySet\ + 0x5C5CBD84L, 0xE755, 0x11D0, 0xAC, 0x18, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#define STATIC_IID_IKsAllocator\ + 0x8da64899L, 0xc0d9, 0x11d0, 0x84, 0x13, 0x00, 0x00, 0xf8, 0x22, 0xfe, 0x8a + +#define STATIC_IID_IKsAllocatorEx\ + 0x091bb63aL, 0x603f, 0x11d1, 0xb0, 0x67, 0x00, 0xa0, 0xc9, 0x06, 0x28, 0x02 + + +#ifndef STATIC_IID_IKsPropertySet +#define STATIC_IID_IKsPropertySet\ + 0x31EFAC30L, 0x515C, 0x11d0, 0xA9, 0xAA, 0x00, 0xAA, 0x00, 0x61, 0xBE, 0x93 +#endif // STATIC_IID_IKsPropertySet + +#define STATIC_IID_IKsTopology\ + 0x28F54683L, 0x06FD, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#ifndef STATIC_IID_IKsControl +#define STATIC_IID_IKsControl\ + 0x28F54685L, 0x06FD, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 +#endif // STATIC_IID_IKsControl + +#define STATIC_IID_IKsAggregateControl\ + 0x7F40EAC0L, 0x3947, 0x11D2, 0x87, 0x4E, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#define STATIC_CLSID_Proxy \ + 0x17CCA71BL, 0xECD7, 0x11D0, 0xB9, 0x08, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96 + +#ifdef _KS_ + +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUIDEX(IID_IKsObject); + +DEFINE_GUIDEX(IID_IKsPin); + +DEFINE_GUIDEX(IID_IKsPinEx); + +DEFINE_GUIDEX(IID_IKsPinPipe); + +DEFINE_GUIDEX(IID_IKsDataTypeHandler); + +DEFINE_GUIDEX(IID_IKsDataTypeCompletion); + +DEFINE_GUIDEX(IID_IKsInterfaceHandler); + +DEFINE_GUIDEX(IID_IKsClockPropertySet); + +DEFINE_GUIDEX(IID_IKsAllocator); + +DEFINE_GUIDEX(IID_IKsAllocatorEx); + +#define IID_IKsQualityForwarder KSCATEGORY_QUALITY +#endif // !defined(__cplusplus) || _MSC_VER < 1100 + +#define STATIC_IID_IKsQualityForwarder STATIC_KSCATEGORY_QUALITY + +typedef enum { + KsAllocatorMode_User, + KsAllocatorMode_Kernel +} KSALLOCATORMODE; + + +typedef enum { + FramingProp_Uninitialized, + FramingProp_None, + FramingProp_Old, + FramingProp_Ex +} FRAMING_PROP; + +typedef FRAMING_PROP *PFRAMING_PROP; + + +typedef enum { + Framing_Cache_Update, // request to bypass cache when read/write + Framing_Cache_ReadLast, + Framing_Cache_ReadOrig, + Framing_Cache_Write +} FRAMING_CACHE_OPS; + + +typedef struct { + LONGLONG MinTotalNominator; + LONGLONG MaxTotalNominator; + LONGLONG TotalDenominator; +} OPTIMAL_WEIGHT_TOTALS; + +// forward declaration +typedef struct IPin IPin; +typedef struct IKsPin IKsPin; +typedef struct IKsAllocator IKsAllocator; +typedef struct IKsAllocatorEx IKsAllocatorEx; + + +// +// allocators strategy is defined by graph manager +// +#define AllocatorStrategy_DontCare 0 + +// +// what to optimize +// +#define AllocatorStrategy_MinimizeNumberOfFrames 0x00000001 +#define AllocatorStrategy_MinimizeFrameSize 0x00000002 +#define AllocatorStrategy_MinimizeNumberOfAllocators 0x00000004 +#define AllocatorStrategy_MaximizeSpeed 0x00000008 + +// +// factors (flags) defining the Pipes properties +// +#define PipeFactor_None 0 +#define PipeFactor_UserModeUpstream 0x00000001 +#define PipeFactor_UserModeDownstream 0x00000002 +#define PipeFactor_MemoryTypes 0x00000004 +#define PipeFactor_Flags 0x00000008 +#define PipeFactor_PhysicalRanges 0x00000010 +#define PipeFactor_OptimalRanges 0x00000020 +#define PipeFactor_FixedCompression 0x00000040 +#define PipeFactor_UnknownCompression 0x00000080 + +#define PipeFactor_Buffers 0x00000100 +#define PipeFactor_Align 0x00000200 + +#define PipeFactor_PhysicalEnd 0x00000400 +#define PipeFactor_LogicalEnd 0x00000800 + + + +typedef enum { + PipeState_DontCare, + PipeState_RangeNotFixed, + PipeState_RangeFixed, + PipeState_CompressionUnknown, + PipeState_Finalized +} PIPE_STATE; + + +// +// pipe dimensions relative to BeginPin. +// + +typedef struct _PIPE_DIMENSIONS { + KS_COMPRESSION AllocatorPin; + KS_COMPRESSION MaxExpansionPin; + KS_COMPRESSION EndPin; +} PIPE_DIMENSIONS, *PPIPE_DIMENSIONS; + + +typedef enum { + Pipe_Allocator_None, + Pipe_Allocator_FirstPin, + Pipe_Allocator_LastPin, + Pipe_Allocator_MiddlePin +} PIPE_ALLOCATOR_PLACE; + +typedef PIPE_ALLOCATOR_PLACE *PPIPE_ALLOCATOR_PLACE; + + +typedef enum { + KS_MemoryTypeDontCare = 0, + KS_MemoryTypeKernelPaged, + KS_MemoryTypeKernelNonPaged, + KS_MemoryTypeDeviceHostMapped, + KS_MemoryTypeDeviceSpecific, + KS_MemoryTypeUser, + KS_MemoryTypeAnyHost +} KS_LogicalMemoryType; + +typedef KS_LogicalMemoryType *PKS_LogicalMemoryType; + + + +typedef struct _PIPE_TERMINATION { + ULONG Flags; + ULONG OutsideFactors; + ULONG Weigth; // outside weight + KS_FRAMING_RANGE PhysicalRange; + KS_FRAMING_RANGE_WEIGHTED OptimalRange; + KS_COMPRESSION Compression; // relative to the connected pin on a neighboring filter. +} PIPE_TERMINATION; + + +// +// extended allocator properties +// +typedef struct _ALLOCATOR_PROPERTIES_EX + { + long cBuffers; + long cbBuffer; + long cbAlign; + long cbPrefix; +// new part + GUID MemoryType; + GUID BusType; // one of the buses this pipe is using + PIPE_STATE State; + PIPE_TERMINATION Input; + PIPE_TERMINATION Output; + ULONG Strategy; + ULONG Flags; + ULONG Weight; + KS_LogicalMemoryType LogicalMemoryType; + PIPE_ALLOCATOR_PLACE AllocatorPlace; + PIPE_DIMENSIONS Dimensions; + KS_FRAMING_RANGE PhysicalRange; // on allocator pin + IKsAllocatorEx* PrevSegment; // doubly-linked list of KS allocators + ULONG CountNextSegments; // possible multiple dependent pipes + IKsAllocatorEx** NextSegments; + ULONG InsideFactors; // existing factors (different from "don't care") + ULONG NumberPins; +} ALLOCATOR_PROPERTIES_EX; + +typedef ALLOCATOR_PROPERTIES_EX *PALLOCATOR_PROPERTIES_EX; + + +#ifdef __STREAMS__ + +struct DECLSPEC_UUID("5C5CBD84-E755-11D0-AC18-00A0C9223196") IKsClockPropertySet; +#undef INTERFACE +#define INTERFACE IKsClockPropertySet +DECLARE_INTERFACE_(IKsClockPropertySet, IUnknown) +{ + STDMETHOD(KsGetTime)( + THIS_ + _Out_ LONGLONG* Time + ) PURE; + STDMETHOD(KsSetTime)( + THIS_ + _In_ LONGLONG Time + ) PURE; + STDMETHOD(KsGetPhysicalTime)( + THIS_ + _Out_ LONGLONG* Time + ) PURE; + STDMETHOD(KsSetPhysicalTime)( + THIS_ + _In_ LONGLONG Time + ) PURE; + STDMETHOD(KsGetCorrelatedTime)( + THIS_ + _Out_ KSCORRELATED_TIME* CorrelatedTime + ) PURE; + STDMETHOD(KsSetCorrelatedTime)( + THIS_ + _In_ KSCORRELATED_TIME* CorrelatedTime + ) PURE; + STDMETHOD(KsGetCorrelatedPhysicalTime)( + THIS_ + _Out_ KSCORRELATED_TIME* CorrelatedTime + ) PURE; + STDMETHOD(KsSetCorrelatedPhysicalTime)( + THIS_ + _In_ KSCORRELATED_TIME* CorrelatedTime + ) PURE; + STDMETHOD(KsGetResolution)( + THIS_ + _Out_ KSRESOLUTION* Resolution + ) PURE; + STDMETHOD(KsGetState)( + THIS_ + _Out_ KSSTATE* State + ) PURE; +}; + + +interface DECLSPEC_UUID("8da64899-c0d9-11d0-8413-0000f822fe8a") IKsAllocator; +#undef INTERFACE +#define INTERFACE IKsAllocator +DECLARE_INTERFACE_(IKsAllocator, IUnknown) +{ + STDMETHOD_(HANDLE, KsGetAllocatorHandle)( + THIS + ) PURE; + STDMETHOD_(KSALLOCATORMODE, KsGetAllocatorMode)( + THIS + ) PURE; + STDMETHOD(KsGetAllocatorStatus)( + THIS_ + _Out_ PKSSTREAMALLOCATOR_STATUS AllocatorStatus + ) PURE; + STDMETHOD_(VOID, KsSetAllocatorMode)( + THIS_ + _In_ KSALLOCATORMODE Mode + ) PURE; +}; + +interface DECLSPEC_UUID("091bb63a-603f-11d1-b067-00a0c9062802") IKsAllocatorEx; +#undef INTERFACE +#define INTERFACE IKsAllocatorEx +DECLARE_INTERFACE_(IKsAllocatorEx, IKsAllocator) +{ + STDMETHOD_(PALLOCATOR_PROPERTIES_EX, KsGetProperties)( + THIS + ) PURE; + STDMETHOD_(VOID, KsSetProperties)( + THIS_ + _In_ PALLOCATOR_PROPERTIES_EX + ) PURE; + STDMETHOD_(VOID, KsSetAllocatorHandle)( + THIS_ + _In_ HANDLE AllocatorHandle + ) PURE; + STDMETHOD_(HANDLE, KsCreateAllocatorAndGetHandle)( + THIS_ + _In_ IKsPin* KsPin + ) PURE; +}; + +typedef enum { + KsPeekOperation_PeekOnly, + KsPeekOperation_AddRef +} KSPEEKOPERATION; + +typedef struct _KSSTREAM_SEGMENT *PKSSTREAM_SEGMENT; + +interface DECLSPEC_UUID("b61178d1-a2d9-11cf-9e53-00aa00a216a1") IKsPin; + +#undef INTERFACE +#define INTERFACE IKsPin +DECLARE_INTERFACE_(IKsPin, IUnknown) +{ + STDMETHOD(KsQueryMediums)( + THIS_ + _Outptr_ PKSMULTIPLE_ITEM* MediumList + ) PURE; + STDMETHOD(KsQueryInterfaces)( + THIS_ + _Outptr_ PKSMULTIPLE_ITEM* InterfaceList + ) PURE; + STDMETHOD(KsCreateSinkPinHandle)( + THIS_ + _In_ KSPIN_INTERFACE& Interface, + _In_ KSPIN_MEDIUM& Medium + ) PURE; + STDMETHOD(KsGetCurrentCommunication)( + THIS_ + _Out_opt_ KSPIN_COMMUNICATION *Communication, + _Out_opt_ KSPIN_INTERFACE *Interface, + _Out_opt_ KSPIN_MEDIUM *Medium + ) PURE; + STDMETHOD(KsPropagateAcquire)( + THIS + ) PURE; + STDMETHOD(KsDeliver)( + THIS_ + _In_ IMediaSample* Sample, + _In_ ULONG Flags + ) PURE; + STDMETHOD(KsMediaSamplesCompleted)( + THIS_ + _In_ PKSSTREAM_SEGMENT StreamSegment + ) PURE; + STDMETHOD_(IMemAllocator *, KsPeekAllocator)( + THIS_ + _In_ KSPEEKOPERATION Operation + ) PURE; + STDMETHOD(KsReceiveAllocator)( + THIS_ + _In_opt_ IMemAllocator *MemAllocator + ) PURE; + STDMETHOD(KsRenegotiateAllocator)( + THIS + ) PURE; + STDMETHOD_(LONG, KsIncrementPendingIoCount)( + THIS + ) PURE; + STDMETHOD_(LONG, KsDecrementPendingIoCount)( + THIS + ) PURE; + STDMETHOD(KsQualityNotify)( + THIS_ + _In_ ULONG Proportion, + _In_ REFERENCE_TIME TimeDelta + ) PURE; +}; + +interface DECLSPEC_UUID("7bb38260-d19c-11d2-b38a-00a0c95ec22e") IKsPinEx; +#undef INTERFACE +#define INTERFACE IKsPinEx +DECLARE_INTERFACE_(IKsPinEx, IKsPin) +{ + STDMETHOD_(VOID, KsNotifyError)( + THIS_ + _In_ IMediaSample* Sample, + _In_ HRESULT hr + ) PURE; +}; + +interface DECLSPEC_UUID("e539cd90-a8b4-11d1-8189-00a0c9062802") IKsPinPipe; +#undef INTERFACE +#define INTERFACE IKsPinPipe +DECLARE_INTERFACE_(IKsPinPipe, IUnknown) +{ + STDMETHOD(KsGetPinFramingCache)( + THIS_ + _Out_ PKSALLOCATOR_FRAMING_EX *FramingEx, + _Out_ PFRAMING_PROP FramingProp, + _In_ FRAMING_CACHE_OPS Option + ) PURE; + STDMETHOD(KsSetPinFramingCache)( + THIS_ + _In_ PKSALLOCATOR_FRAMING_EX FramingEx, + _In_ PFRAMING_PROP FramingProp, + _In_ FRAMING_CACHE_OPS Option + ) PURE; + STDMETHOD_(IPin*, KsGetConnectedPin)( + THIS + ) PURE; + STDMETHOD_(IKsAllocatorEx*, KsGetPipe)( + THIS_ + _In_ KSPEEKOPERATION Operation + ) PURE; + STDMETHOD(KsSetPipe)( + THIS_ + _In_ IKsAllocatorEx *KsAllocator + ) PURE; + STDMETHOD_(ULONG, KsGetPipeAllocatorFlag)( + THIS + ) PURE; + STDMETHOD(KsSetPipeAllocatorFlag)( + THIS_ + _In_ ULONG Flag + ) PURE; + STDMETHOD_(GUID, KsGetPinBusCache)( + THIS + ) PURE; + STDMETHOD(KsSetPinBusCache)( + THIS_ + _In_ GUID Bus + ) PURE; +// +// very useful methods for tracing. +// + STDMETHOD_(PWCHAR, KsGetPinName)( + THIS + ) PURE; + STDMETHOD_(PWCHAR, KsGetFilterName)( + THIS + ) PURE; +}; + + +interface DECLSPEC_UUID("CD5EBE6B-8B6E-11D1-8AE0-00A0C9223196") IKsPinFactory; +#undef INTERFACE +#define INTERFACE IKsPinFactory +DECLARE_INTERFACE_(IKsPinFactory, IUnknown) +{ + STDMETHOD(KsPinFactory)( + THIS_ + _Out_ ULONG* PinFactory + ) PURE; +}; + +typedef enum { + KsIoOperation_Write, + KsIoOperation_Read +} KSIOOPERATION; + +interface DECLSPEC_UUID("5ffbaa02-49a3-11d0-9f36-00aa00a216a1") IKsDataTypeHandler; +#undef INTERFACE +#define INTERFACE IKsDataTypeHandler +DECLARE_INTERFACE_(IKsDataTypeHandler, IUnknown) +{ + STDMETHOD(KsCompleteIoOperation)( + THIS_ + _Inout_ IMediaSample *Sample, + _Inout_ PVOID StreamHeader, + _In_ KSIOOPERATION IoOperation, + _In_ BOOL Cancelled + ) PURE; + STDMETHOD(KsIsMediaTypeInRanges)( + THIS_ + _In_ PVOID DataRanges + ) PURE; + STDMETHOD(KsPrepareIoOperation)( + THIS_ + _Inout_ IMediaSample *Sample, + _Inout_ PVOID StreamHeader, + _In_ KSIOOPERATION IoOperation + ) PURE; + STDMETHOD(KsQueryExtendedSize)( + THIS_ + _Out_ ULONG* ExtendedSize + ) PURE; + STDMETHOD(KsSetMediaType)( + THIS_ + _In_ const AM_MEDIA_TYPE* AmMediaType + ) PURE; +}; + +interface DECLSPEC_UUID("827D1A0E-0F73-11D2-B27A-00A0C9223196") IKsDataTypeCompletion; +#undef INTERFACE +#define INTERFACE IKsDataTypeCompletion +DECLARE_INTERFACE_(IKsDataTypeCompletion, IUnknown) +{ + STDMETHOD(KsCompleteMediaType)( + THIS_ + _In_ HANDLE FilterHandle, + _In_ ULONG PinFactoryId, + _Inout_ AM_MEDIA_TYPE* AmMediaType + ) PURE; +}; + +interface DECLSPEC_UUID("D3ABC7E0-9A61-11d0-A40D-00A0C9223196") IKsInterfaceHandler; +#undef INTERFACE +#define INTERFACE IKsInterfaceHandler +DECLARE_INTERFACE_(IKsInterfaceHandler, IUnknown) +{ + STDMETHOD(KsSetPin)( + THIS_ + _In_ IKsPin *KsPin + ) PURE; + STDMETHOD(KsProcessMediaSamples)( + THIS_ + _In_ IKsDataTypeHandler *KsDataTypeHandler, + _In_reads_(SampleCount) IMediaSample** SampleList, + _Inout_ PLONG SampleCount, + _In_ KSIOOPERATION IoOperation, + _Out_ PKSSTREAM_SEGMENT *StreamSegment + ) PURE; + STDMETHOD(KsCompleteIo)( + THIS_ + _Inout_ PKSSTREAM_SEGMENT StreamSegment + ) PURE; +}; + + +// +// This structure definition is the common header required by the proxy to +// dispatch the stream segment to the interface handler. Interface handlers +// will create extended structures to include other information such as +// media samples, extended header size and so on. +// + +typedef struct _KSSTREAM_SEGMENT { + IKsInterfaceHandler *KsInterfaceHandler; + IKsDataTypeHandler *KsDataTypeHandler; + KSIOOPERATION IoOperation; + HANDLE CompletionEvent; + +} KSSTREAM_SEGMENT; + +interface DECLSPEC_UUID("423c13a2-2070-11d0-9ef7-00aa00a216a1") IKsObject; +#undef INTERFACE +#define INTERFACE IKsObject +DECLARE_INTERFACE_(IKsObject, IUnknown) +{ + STDMETHOD_(HANDLE, KsGetObjectHandle)( + THIS + ) PURE; +}; + +interface DECLSPEC_UUID("97ebaacb-95bd-11d0-a3ea-00a0c9223196") IKsQualityForwarder; +#undef INTERFACE +#define INTERFACE IKsQualityForwarder +DECLARE_INTERFACE_(IKsQualityForwarder, IKsObject) +{ + STDMETHOD_(VOID, KsFlushClient)( + THIS_ + _In_ IKsPin* Pin + ) PURE; +}; + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +interface DECLSPEC_UUID("412bd695-f84b-46c1-ac73-54196dbc8fa7") IKsNotifyEvent; +#undef INTERFACE +#define INTERFACE IKsNotifyEvent +DECLARE_INTERFACE_(IKsNotifyEvent, IUnknown) +{ + STDMETHOD(KsNotifyEvent)( + THIS_ + _In_ ULONG Event, + _In_ ULONG_PTR lParam1, + _In_ ULONG_PTR lParam2 + ) PURE; +}; + +#endif + +KSDDKAPI +HRESULT +WINAPI +KsResolveRequiredAttributes( + _In_ PKSDATARANGE DataRange, + _In_opt_ PKSMULTIPLE_ITEM Attributes + ); + +KSDDKAPI +HRESULT +WINAPI +KsOpenDefaultDevice( + _In_ REFGUID Category, + _In_ ACCESS_MASK Access, + _Out_ PHANDLE DeviceHandle + ); +KSDDKAPI +HRESULT +WINAPI +KsSynchronousDeviceControl( + _In_ HANDLE Handle, + _In_ ULONG IoControl, + _In_reads_bytes_opt_(InLength) PVOID InBuffer, + _In_ ULONG InLength, + _Out_writes_bytes_opt_(OutLength) PVOID OutBuffer, + _In_ ULONG OutLength, + _Inout_opt_ PULONG BytesReturned + ); +KSDDKAPI +HRESULT +WINAPI +KsGetMultiplePinFactoryItems( + _In_ HANDLE FilterHandle, + _In_ ULONG PinFactoryId, + _In_ ULONG PropertyId, + _Outptr_ PVOID* Items + ); +KSDDKAPI +HRESULT +WINAPI +KsGetMediaTypeCount( + _In_ HANDLE FilterHandle, + _In_ ULONG PinFactoryId, + _Out_ ULONG* MediaTypeCount + ); +KSDDKAPI +HRESULT +WINAPI +KsGetMediaType( + _In_ int Position, + _Out_ AM_MEDIA_TYPE* AmMediaType, + _In_ HANDLE FilterHandle, + _In_ ULONG PinFactoryId + ); + +#endif // __STREAMS__ + +#ifndef _IKsPropertySet_ +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUIDEX(IID_IKsPropertySet); +#endif // !defined(__cplusplus) || _MSC_VER < 1100 +#endif // _IKsPropertySet_ + +#ifndef _IKsControl_ +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUIDEX(IID_IKsControl); +#endif // !defined(__cplusplus) || _MSC_VER < 1100 +#endif // _IKsControl_ + +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUIDEX(IID_IKsAggregateControl); +#endif // !defined(__cplusplus) || _MSC_VER < 1100 + +#ifndef _IKsTopology_ +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUIDEX(IID_IKsTopology); +#endif // !defined(__cplusplus) || _MSC_VER < 1100 +#endif // _IKsTopology_ + +DEFINE_GUIDSTRUCT("17CCA71B-ECD7-11D0-B908-00A0C9223196", CLSID_Proxy); +#define CLSID_Proxy DEFINE_GUIDNAMED(CLSID_Proxy) + +#else // !_KS_ + +#ifndef _IKsPropertySet_ +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUID(IID_IKsPropertySet, STATIC_IID_IKsPropertySet); +#endif // !defined(__cplusplus) || _MSC_VER < 1100 +#endif // _IKsPropertySet_ + +#if !defined(__cplusplus) || _MSC_VER < 1100 +DEFINE_GUID(CLSID_Proxy, STATIC_CLSID_Proxy); +#else // defined(__cplusplus) && _MSC_VER >= 1100 +class DECLSPEC_UUID("17CCA71B-ECD7-11D0-B908-00A0C9223196") CLSID_Proxy; +#endif // defined(__cplusplus) && _MSC_VER >= 1100 + +#endif // !_KS_ + +#ifndef _IKsPropertySet_ +#define _IKsPropertySet_ + +#define KSPROPERTY_SUPPORT_GET 1 +#define KSPROPERTY_SUPPORT_SET 2 + +#ifdef DECLARE_INTERFACE_ + +interface DECLSPEC_UUID("31EFAC30-515C-11d0-A9AA-00aa0061be93") IKsPropertySet; +#undef INTERFACE +#define INTERFACE IKsPropertySet +DECLARE_INTERFACE_(IKsPropertySet, IUnknown) +{ + STDMETHOD(Set)( + THIS_ + _In_ REFGUID PropSet, + _In_ ULONG Id, + _In_reads_bytes_(InstanceLength) LPVOID InstanceData, + _In_ ULONG InstanceLength, + _In_reads_bytes_(DataLength) LPVOID PropertyData, + _In_ ULONG DataLength + ) PURE; + + STDMETHOD(Get)( + THIS_ + _In_ REFGUID PropSet, + _In_ ULONG Id, + _In_reads_bytes_(InstanceLength) LPVOID InstanceData, + _In_ ULONG InstanceLength, + _Out_writes_bytes_(DataLength) LPVOID PropertyData, + _In_ ULONG DataLength, + _Out_ ULONG* BytesReturned + ) PURE; + + STDMETHOD(QuerySupported)( + THIS_ + _In_ REFGUID PropSet, + _In_ ULONG Id, + _Out_ ULONG* TypeSupport + ) PURE; +}; + +#endif // DECLARE_INTERFACE_ + +#endif // _IKsPropertySet_ + +#ifndef _IKsControl_ +#define _IKsControl_ + +#ifdef DECLARE_INTERFACE_ + +interface DECLSPEC_UUID("28F54685-06FD-11D2-B27A-00A0C9223196") IKsControl; +#undef INTERFACE +#define INTERFACE IKsControl +DECLARE_INTERFACE_(IKsControl, IUnknown) +{ + STDMETHOD(KsProperty)( + THIS_ + _In_reads_bytes_(PropertyLength) PKSPROPERTY Property, + _In_ ULONG PropertyLength, + _Inout_updates_bytes_(DataLength) LPVOID PropertyData, + _In_ ULONG DataLength, + _Inout_opt_ ULONG* BytesReturned + ) PURE; + STDMETHOD(KsMethod)( + THIS_ + _In_reads_bytes_(MethodLength) PKSMETHOD Method, + _In_ ULONG MethodLength, + _Inout_updates_bytes_(DataLength) LPVOID MethodData, + _In_ ULONG DataLength, + _Inout_opt_ ULONG* BytesReturned + ) PURE; + STDMETHOD(KsEvent)( + THIS_ + _In_reads_bytes_opt_(EventLength) PKSEVENT Event, + _In_ ULONG EventLength, + _Inout_updates_bytes_(DataLength) LPVOID EventData, + _In_ ULONG DataLength, + _Inout_opt_ ULONG* BytesReturned + ) PURE; +}; + +#endif // DECLARE_INTERFACE_ + +#endif // _IKsControl_ + + +#ifdef DECLARE_INTERFACE_ + +interface DECLSPEC_UUID("7F40EAC0-3947-11D2-874E-00A0C9223196") IKsAggregateControl; +#undef INTERFACE +#define INTERFACE IKsAggregateControl +DECLARE_INTERFACE_(IKsAggregateControl, IUnknown) +{ + STDMETHOD(KsAddAggregate)( + THIS_ + _In_ REFGUID AggregateClass + ) PURE; + STDMETHOD(KsRemoveAggregate)( + THIS_ + _In_ REFGUID AggregateClass + ) PURE; +}; + +#endif // DECLARE_INTERFACE_ + +#ifndef _IKsTopology_ +#define _IKsTopology_ + +#ifdef DECLARE_INTERFACE_ + +interface DECLSPEC_UUID("28F54683-06FD-11D2-B27A-00A0C9223196") IKsTopology; +#undef INTERFACE +#define INTERFACE IKsTopology +DECLARE_INTERFACE_(IKsTopology, IUnknown) +{ + STDMETHOD(CreateNodeInstance)( + THIS_ + _In_ ULONG NodeId, + _In_ ULONG Flags, + _In_ ACCESS_MASK DesiredAccess, + _In_opt_ IUnknown* UnkOuter, + _In_ REFGUID InterfaceId, + _Out_ LPVOID* Interface + ) PURE; +}; + +#endif // DECLARE_INTERFACE_ + +#endif // _IKsTopology_ + +#ifdef __cplusplus +} +#endif // __cplusplus + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // __KSPROXY__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksuuids.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksuuids.h new file mode 100644 index 0000000000000000000000000000000000000000..f831bc7b7c6252b5ea2d9b63e46b10bea529d13b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ksuuids.h @@ -0,0 +1,324 @@ +//------------------------------------------------------------------------------ +// File: ksuuids.h +// +// Desc: Contains the GUIDs for the MediaType type, subtype fields and format +// types for DVD/MPEG2 media types. +// +// Copyright (c) Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// --- MPEG 2 definitions --- +// + +// 36523B13-8EE5-11d1-8CA3-0060B057664A +OUR_GUID_ENTRY(MEDIATYPE_MPEG2_PACK, +0x36523B13, 0x8EE5, 0x11d1, 0x8C, 0xA3, 0x00, 0x60, 0xB0, 0x57, 0x66, 0x4A) + +// e06d8020-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIATYPE_MPEG2_PES, +0xe06d8020, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea) + + +#if 0 +DEFINE_GUID(MEDIATYPE_CONTROL, +0xe06d8021, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea); +#endif // #if 0 + +#if ( (NTDDI_VERSION >= NTDDI_WINXPSP2) && (NTDDI_VERSION < NTDDI_WS03) ) || (NTDDI_VERSION >= NTDDI_WS03SP1) + +OUR_GUID_ENTRY( MEDIATYPE_MPEG2_SECTIONS, + 0x455f176c, 0x4b06, 0x47ce, 0x9a, 0xef, 0x8c, 0xae, 0xf7, 0x3d, 0xf7, 0xb5) + +// {1ED988B0-3FFC-4523-8725-347BEEC1A8A0} +OUR_GUID_ENTRY( MEDIASUBTYPE_MPEG2_VERSIONED_TABLES, + 0x1ed988b0, 0x3ffc, 0x4523, 0x87, 0x25, 0x34, 0x7b, 0xee, 0xc1, 0xa8, 0xa0) + +OUR_GUID_ENTRY(MEDIASUBTYPE_ATSC_SI, +0xb3c7397c, 0xd303, 0x414d, 0xb3, 0x3c, 0x4e, 0xd2, 0xc9, 0xd2, 0x97, 0x33) + +OUR_GUID_ENTRY(MEDIASUBTYPE_DVB_SI, +0xe9dd31a3, 0x221d, 0x4adb, 0x85, 0x32, 0x9a, 0xf3, 0x9, 0xc1, 0xa4, 0x8) + +OUR_GUID_ENTRY(MEDIASUBTYPE_ISDB_SI, +0xe89ad298, 0x3601, 0x4b06, 0xaa, 0xec, 0x9d, 0xde, 0xed, 0xcc, 0x5b, 0xd0) + +// {EC232EB2-CB96-4191-B226-0EA129F38250} +OUR_GUID_ENTRY(MEDIASUBTYPE_TIF_SI, +0xec232eb2, 0xcb96, 0x4191, 0xb2, 0x26, 0xe, 0xa1, 0x29, 0xf3, 0x82, 0x50) + +// {C892E55B-252D-42b5-A316-D997E7A5D995} +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2DATA, +0xc892e55b, 0x252d, 0x42b5, 0xa3, 0x16, 0xd9, 0x97, 0xe7, 0xa5, 0xd9, 0x95) + +#endif + +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_WMDRM_TRANSPORT, +0x18BEC4EA, 0x4676, 0x450e, 0xB4, 0x78, 0x0C, 0xD8, 0x4C, 0x54, 0xB3, 0x27) + +// e06d8026-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_VIDEO, +0xe06d8026, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea) + +// use MPEG2VIDEOINFO (defined below) with FORMAT_MPEG2_VIDEO +// e06d80e3-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(FORMAT_MPEG2_VIDEO, +0xe06d80e3, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x5f, 0x6c, 0xbb, 0xea) + +// F72A76A0-EB0A-11d0-ACE4-0000C0CC16BA (FORMAT_VideoInfo2) +OUR_GUID_ENTRY(FORMAT_VIDEOINFO2, +0xf72a76A0L, 0xeb0a, 0x11d0, 0xac, 0xe4, 0x0, 0x0, 0xc0, 0xcc, 0x16, 0xba) + +// MPEG2 Other subtypes +// e06d8022-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_PROGRAM, +0xe06d8022, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d8023-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_TRANSPORT, +0xe06d8023, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// 138AA9A4-1EE2-4c5b-988E-19ABFDBC8A11 +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_TRANSPORT_STRIDE, +0x138aa9a4, 0x1ee2, 0x4c5b, 0x98, 0x8e, 0x19, 0xab, 0xfd, 0xbc, 0x8a, 0x11) + +// {18BEC4EA-4676-450e-B478-0CD84C54B327} +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_UDCR_TRANSPORT, +0x18BEC4EA, 0x4676, 0x450e, 0xB4, 0x78, 0x0C, 0xD8, 0x4C, 0x54, 0xB3, 0x27) + +// {0d7aed42-cb9a-11db-9705-005056c00008} +OUR_GUID_ENTRY( MEDIASUBTYPE_MPEG2_PBDA_TRANSPORT_RAW, +0x0d7aed42, 0xcb9a, 0x11db, 0x97, 0x5, 0x0, 0x50, 0x56, 0xc0, 0x0, 0x8 ) + +// {af748dd4-d800-11db-9705-005056c00008} +OUR_GUID_ENTRY ( MEDIASUBTYPE_MPEG2_PBDA_TRANSPORT_PROCESSED, +0xaf748dd4, 0xd80, 0x11db, 0x97, 0x5, 0x0, 0x50, 0x56, 0xc0, 0x0, 0x8 ) + +#endif + +// e06d802b-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_MPEG2_AUDIO, +0xe06d802b, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d802c-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DOLBY_AC3, +0xe06d802c, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d802d-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DVD_SUBPICTURE, +0xe06d802d, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d8032-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DVD_LPCM_AUDIO, +0xe06d8032, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// e06d8033-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DTS, +0xe06d8033, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d8034-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_SDDS, +0xe06d8034, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +#endif + +// DVD-related mediatypes +// ED0B916A-044D-11d1-AA78-00C04FC31D60 +OUR_GUID_ENTRY(MEDIATYPE_DVD_ENCRYPTED_PACK, +0xed0b916a, 0x044d, 0x11d1, 0xaa, 0x78, 0x00, 0xc0, 0x04f, 0xc3, 0x1d, 0x60) + +// e06d802e-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIATYPE_DVD_NAVIGATION, +0xe06d802e, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d802f-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DVD_NAVIGATION_PCI, +0xe06d802f, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d8030-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DVD_NAVIGATION_DSI, +0xe06d8030, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d8031-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(MEDIASUBTYPE_DVD_NAVIGATION_PROVIDER, +0xe06d8031, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// +// DVD - MPEG2/AC3-related Formats +// +// e06d80e3-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(FORMAT_MPEG2Video, +0xe06d80e3, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d80e4-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(FORMAT_DolbyAC3, +0xe06d80e4, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d80e5-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(FORMAT_MPEG2Audio, +0xe06d80e5, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// e06d80e6-db46-11cf-b4d1-00805f6cbbea +OUR_GUID_ENTRY(FORMAT_DVD_LPCMAudio, +0xe06d80e6, 0xdb46, 0x11cf, 0xb4, 0xd1, 0x00, 0x80, 0x05f, 0x6c, 0xbb, 0xea) + +// +// UVC 1.2 H.264 Video Format +// +// 2017be05-6629-4248-aaed-7e1a47bc9b9c +OUR_GUID_ENTRY(FORMAT_UVCH264Video, +0x2017be05, 0x6629, 0x4248, 0xaa, 0xed, 0x7e, 0x1a, 0x47, 0xbc, 0x9b, 0x9c) + +// +// JPEG Image Format +// +// 692fa379-d3e8-4651-b5b4-0b94b013eeaf +OUR_GUID_ENTRY(FORMAT_JPEGImage, +0x692fa379, 0xd3e8, 0x4651, 0xb5, 0xb4, 0xb, 0x94, 0xb0, 0x13, 0xee, 0xaf) + +// +// Image Format +// +// 692fa379-d3e8-4651-b5b4-0b94b013eeaf +OUR_GUID_ENTRY(FORMAT_Image, +0x692fa379, 0xd3e8, 0x4651, 0xb5, 0xb4, 0xb, 0x94, 0xb0, 0x13, 0xee, 0xaf) + +// +// KS Property Set Id (to communicate with the WDM Proxy filter) -- from +// ksmedia.h of WDM DDK. +// + +// BFABE720-6E1F-11D0-BCF2-444553540000 +OUR_GUID_ENTRY(AM_KSPROPSETID_AC3, +0xBFABE720, 0x6E1F, 0x11D0, 0xBC, 0xF2, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00) + +// ac390460-43af-11d0-bd6a-003505c103a9 +OUR_GUID_ENTRY(AM_KSPROPSETID_DvdSubPic, +0xac390460, 0x43af, 0x11d0, 0xbd, 0x6a, 0x00, 0x35, 0x05, 0xc1, 0x03, 0xa9) + +// 0E8A0A40L-6AEF-11D0-9ED0-00A024CA19B3 +OUR_GUID_ENTRY(AM_KSPROPSETID_CopyProt, +0x0E8A0A40, 0x6AEF, 0x11D0, 0x9E, 0xD0, 0x00, 0xA0, 0x24, 0xCA, 0x19, 0xB3) + +// A503C5C0-1D1D-11d1-AD80-444553540000 +OUR_GUID_ENTRY(AM_KSPROPSETID_TSRateChange, +0xa503c5c0, 0x1d1d, 0x11d1, 0xad, 0x80, 0x44, 0x45, 0x53, 0x54, 0x0, 0x0) + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// 3577EB09-9582-477f-B29C-B0C452A4FF9A +OUR_GUID_ENTRY(AM_KSPROPSETID_DVD_RateChange, +0x3577eb09, 0x9582, 0x477f, 0xb2, 0x9c, 0xb0, 0xc4, 0x52, 0xa4, 0xff, 0x9a) + +// ae4720ae-aa71-42d8-b82a-fffdf58b76fd +OUR_GUID_ENTRY(AM_KSPROPSETID_DvdKaraoke, +0xae4720ae, 0xaa71, 0x42d8, 0xb8, 0x2a, 0xff, 0xfd, 0xf5, 0x8b, 0x76, 0xfd) + +// c830acbd-ab07-492f-8852-45b6987c2979 +OUR_GUID_ENTRY(AM_KSPROPSETID_FrameStep, +0xc830acbd, 0xab07, 0x492f, 0x88, 0x52, 0x45, 0xb6, 0x98, 0x7c, 0x29, 0x79) + +#endif + +// ----------------------------------------------- +// MPEG4 related KSPROPSETIDs from ksmedia.h of WDK +// ----------------------------------------------- + +// FF6C4BFA-07A9-4c7b-A237-672F9D68065F +OUR_GUID_ENTRY(AM_KSPROPSETID_MPEG4_MediaType_Attributes, +0xff6c4bfa, 0x7a9, 0x4c7b, 0xa2, 0x37, 0x67, 0x2f, 0x9d, 0x68, 0x6, 0x5f) + +// +// KS categories from ks.h and ksmedia.h +// +// + +// 65E8773D-8F56-11D0-A3B9-00A0C9223196 +OUR_GUID_ENTRY(AM_KSCATEGORY_CAPTURE, +0x65E8773DL, 0x8F56, 0x11D0, 0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// 65E8773E-8F56-11D0-A3B9-00A0C9223196 +OUR_GUID_ENTRY(AM_KSCATEGORY_RENDER, +0x65E8773EL, 0x8F56, 0x11D0, 0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// 1E84C900-7E70-11D0-A5D6-28DB04C10000 +OUR_GUID_ENTRY(AM_KSCATEGORY_DATACOMPRESSOR, +0x1E84C900L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00) + +// 6994AD04-93EF-11D0-A3CC-00A0C9223196 +OUR_GUID_ENTRY(AM_KSCATEGORY_AUDIO, +0x6994AD04L, 0x93EF, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// 6994AD05-93EF-11D0-A3CC-00A0C9223196 +OUR_GUID_ENTRY(AM_KSCATEGORY_VIDEO, +0x6994AD05L, 0x93EF, 0x11D0, 0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// a799a800-a46d-11d0-a18c-00a02401dcd4 +OUR_GUID_ENTRY(AM_KSCATEGORY_TVTUNER, +0xa799a800L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4) + +// a799a801-a46d-11d0-a18c-00a02401dcd4 +OUR_GUID_ENTRY(AM_KSCATEGORY_CROSSBAR, +0xa799a801L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4) + +// a799a802-a46d-11d0-a18c-00a02401dcd4 +OUR_GUID_ENTRY(AM_KSCATEGORY_TVAUDIO, +0xa799a802L, 0xa46d, 0x11d0, 0xa1, 0x8c, 0x00, 0xa0, 0x24, 0x01, 0xdc, 0xd4) + + +// 07dad660L-22f1-11d1-a9f4-00c04fbbde8f +OUR_GUID_ENTRY(AM_KSCATEGORY_VBICODEC, +0x07dad660L, 0x22f1, 0x11d1, 0xa9, 0xf4, 0x00, 0xc0, 0x4f, 0xbb, 0xde, 0x8f) + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) +// multi-instance safe codec categories(kernel or user mode) +// {9C24A977-0951-451a-8006-0E49BD28CD5F} +OUR_GUID_ENTRY(AM_KSCATEGORY_VBICODEC_MI, +0x9c24a977, 0x951, 0x451a, 0x80, 0x6, 0xe, 0x49, 0xbd, 0x28, 0xcd, 0x5f) +#endif + +// 0A4252A0L-7E70-11D0-A5D6-28DB04C10000 +OUR_GUID_ENTRY(AM_KSCATEGORY_SPLITTER, +0x0A4252A0L, 0x7E70, 0x11D0, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00) + + +// +// GUIDs needed to support IKsPin interface +// + +// d3abc7e0l-9a61-11d0-a40d00a0c9223196 +OUR_GUID_ENTRY(IID_IKsInterfaceHandler, +0xD3ABC7E0L, 0x9A61, 0x11D0, 0xA4, 0x0D, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// 5ffbaa02l-49a3-11d0-9f3600aa00a216a1 +OUR_GUID_ENTRY(IID_IKsDataTypeHandler, +0x5FFBAA02L, 0x49A3, 0x11D0, 0x9F, 0x36, 0x00, 0xAA, 0x00, 0xA2, 0x16, 0xA1) + +// b61178d1-a2d9-11cf-9e53-00aa00a216a1 +OUR_GUID_ENTRY(IID_IKsPin, +0xb61178d1L, 0xa2d9, 0x11cf, 0x9e, 0x53, 0x00, 0xaa, 0x00, 0xa2, 0x16, 0xa1) + +// 28F54685-06FD-11D2-B27A-00A0C9223196 +OUR_GUID_ENTRY(IID_IKsControl, +0x28F54685L, 0x06FD, 0x11D2, 0xB2, 0x7A, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// CD5EBE6B-8B6E-11D1-8AE0-00A0C9223196 +OUR_GUID_ENTRY(IID_IKsPinFactory, +0xCD5EBE6BL, 0x8B6E, 0x11D1, 0x8A, 0xE0, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96) + +// 1A8766A0-62CE-11CF-A5D6-28DB04C10000 +OUR_GUID_ENTRY(AM_INTERFACESETID_Standard, +0x1A8766A0L, 0x62CE, 0x11CF, 0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ktmtypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ktmtypes.h new file mode 100644 index 0000000000000000000000000000000000000000..453e4e1209451e7baf407267b292c1634f524261 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ktmtypes.h @@ -0,0 +1,215 @@ +/*++ + +Copyright (c) 2000 Microsoft Corporation + +Module Name: + + ktmtypes.h + +Abstract: + + Common types for KTM exposed at both the Nt- and Win32-layer. + +Revision History: + +--*/ + +// begin_wdm begin_winnt +#ifndef _KTMTYPES_ +#define _KTMTYPES_ + + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +typedef GUID UOW, *PUOW; +typedef GUID CRM_PROTOCOL_ID, *PCRM_PROTOCOL_ID; + +// +// Define the TransactionManager option values +// + +#define TRANSACTION_MANAGER_VOLATILE 0x00000001 +#define TRANSACTION_MANAGER_COMMIT_DEFAULT 0x00000000 +#define TRANSACTION_MANAGER_COMMIT_SYSTEM_VOLUME 0x00000002 +#define TRANSACTION_MANAGER_COMMIT_SYSTEM_HIVES 0x00000004 +#define TRANSACTION_MANAGER_COMMIT_LOWEST 0x00000008 +#define TRANSACTION_MANAGER_CORRUPT_FOR_RECOVERY 0x00000010 +#define TRANSACTION_MANAGER_CORRUPT_FOR_PROGRESS 0x00000020 +#define TRANSACTION_MANAGER_MAXIMUM_OPTION 0x0000003F + + +// +// Define the Transaction option values +// + +#define TRANSACTION_DO_NOT_PROMOTE 0x00000001 +#define TRANSACTION_MAXIMUM_OPTION 0x00000001 + + +// +// Define the ResourceManager option values +// + +#define RESOURCE_MANAGER_VOLATILE 0x00000001 +#define RESOURCE_MANAGER_COMMUNICATION 0x00000002 +#define RESOURCE_MANAGER_MAXIMUM_OPTION 0x00000003 + + +// +// Define the RegisterProtocol option values +// + +#define CRM_PROTOCOL_EXPLICIT_MARSHAL_ONLY 0x00000001 +#define CRM_PROTOCOL_DYNAMIC_MARSHAL_INFO 0x00000002 +#define CRM_PROTOCOL_MAXIMUM_OPTION 0x00000003 + + +// +// Define the Enlistment option values +// + +#define ENLISTMENT_SUPERIOR 0x00000001 +#define ENLISTMENT_MAXIMUM_OPTION 0x00000001 + + +typedef ULONG NOTIFICATION_MASK; +#define TRANSACTION_NOTIFY_MASK 0x3FFFFFFF +#define TRANSACTION_NOTIFY_PREPREPARE 0x00000001 +#define TRANSACTION_NOTIFY_PREPARE 0x00000002 +#define TRANSACTION_NOTIFY_COMMIT 0x00000004 +#define TRANSACTION_NOTIFY_ROLLBACK 0x00000008 +#define TRANSACTION_NOTIFY_PREPREPARE_COMPLETE 0x00000010 +#define TRANSACTION_NOTIFY_PREPARE_COMPLETE 0x00000020 +#define TRANSACTION_NOTIFY_COMMIT_COMPLETE 0x00000040 +#define TRANSACTION_NOTIFY_ROLLBACK_COMPLETE 0x00000080 +#define TRANSACTION_NOTIFY_RECOVER 0x00000100 +#define TRANSACTION_NOTIFY_SINGLE_PHASE_COMMIT 0x00000200 +#define TRANSACTION_NOTIFY_DELEGATE_COMMIT 0x00000400 +#define TRANSACTION_NOTIFY_RECOVER_QUERY 0x00000800 +#define TRANSACTION_NOTIFY_ENLIST_PREPREPARE 0x00001000 +#define TRANSACTION_NOTIFY_LAST_RECOVER 0x00002000 +#define TRANSACTION_NOTIFY_INDOUBT 0x00004000 +#define TRANSACTION_NOTIFY_PROPAGATE_PULL 0x00008000 +#define TRANSACTION_NOTIFY_PROPAGATE_PUSH 0x00010000 +#define TRANSACTION_NOTIFY_MARSHAL 0x00020000 +#define TRANSACTION_NOTIFY_ENLIST_MASK 0x00040000 +#define TRANSACTION_NOTIFY_RM_DISCONNECTED 0x01000000 +#define TRANSACTION_NOTIFY_TM_ONLINE 0x02000000 +#define TRANSACTION_NOTIFY_COMMIT_REQUEST 0x04000000 +#define TRANSACTION_NOTIFY_PROMOTE 0x08000000 +#define TRANSACTION_NOTIFY_PROMOTE_NEW 0x10000000 +#define TRANSACTION_NOTIFY_REQUEST_OUTCOME 0x20000000 +// +// Note that this flag is not included in the TRANSACTION_NOTIFY_MASK. +// The reason being that KTM does not understand this flag yet. This +// flag is strictly for the use of filter manager. In fact we mask it +// out before enlisting in any transaction. +// +#define TRANSACTION_NOTIFY_COMMIT_FINALIZE 0x40000000 + +// +// Path to the transaction manager objects in the NT +// object namespace. +// +#define TRANSACTIONMANAGER_OBJECT_PATH L"\\TransactionManager\\" +#define TRANSACTION_OBJECT_PATH L"\\Transaction\\" +#define ENLISTMENT_OBJECT_PATH L"\\Enlistment\\" +#define RESOURCE_MANAGER_OBJECT_PATH L"\\ResourceManager\\" + +// +// The following three defines are here to ease the allocation +// of string buffers which are to contain a fully qualified +// transaction manager object name, e.g., \Transaction\{GUID} +// +#define TRANSACTIONMANAGER_OBJECT_NAME_LENGTH_IN_BYTES (sizeof(TRANSACTIONMANAGER_OBJECT_PATH)+(38*sizeof(WCHAR))) +#define TRANSACTION_OBJECT_NAME_LENGTH_IN_BYTES (sizeof(TRANSACTION_OBJECT_PATH)+(38*sizeof(WCHAR))) +#define ENLISTMENT_OBJECT_NAME_LENGTH_IN_BYTES (sizeof(ENLISTMENT_OBJECT_PATH)+(38*sizeof(WCHAR))) +#define RESOURCE_MANAGER_OBJECT_NAME_LENGTH_IN_BYTES (sizeof(RESOURCE_MANAGER_OBJECT_PATH)+(38*sizeof(WCHAR))) + +// TODO: warning, duplicated def in tm.h. +typedef struct _TRANSACTION_NOTIFICATION { + PVOID TransactionKey; + ULONG TransactionNotification; + LARGE_INTEGER TmVirtualClock; + ULONG ArgumentLength; +} TRANSACTION_NOTIFICATION, *PTRANSACTION_NOTIFICATION; + +typedef struct _TRANSACTION_NOTIFICATION_RECOVERY_ARGUMENT { + GUID EnlistmentId; + UOW UOW; +} TRANSACTION_NOTIFICATION_RECOVERY_ARGUMENT, *PTRANSACTION_NOTIFICATION_RECOVERY_ARGUMENT; + +#define TRANSACTION_NOTIFICATION_TM_ONLINE_FLAG_IS_CLUSTERED 0x1 + +typedef struct _TRANSACTION_NOTIFICATION_TM_ONLINE_ARGUMENT { + GUID TmIdentity; + ULONG Flags; +} TRANSACTION_NOTIFICATION_TM_ONLINE_ARGUMENT, *PTRANSACTION_NOTIFICATION_TM_ONLINE_ARGUMENT; + +typedef ULONG SAVEPOINT_ID, *PSAVEPOINT_ID; + +typedef struct _TRANSACTION_NOTIFICATION_SAVEPOINT_ARGUMENT { + SAVEPOINT_ID SavepointId; +} TRANSACTION_NOTIFICATION_SAVEPOINT_ARGUMENT, *PTRANSACTION_NOTIFICATION_SAVEPOINT_ARGUMENT; + +typedef struct _TRANSACTION_NOTIFICATION_PROPAGATE_ARGUMENT { + ULONG PropagationCookie; + GUID UOW; + GUID TmIdentity; + ULONG BufferLength; + // Bufferlength bytes of Buffer follow +} TRANSACTION_NOTIFICATION_PROPAGATE_ARGUMENT, *PTRANSACTION_NOTIFICATION_PROPAGATE_ARGUMENT; + +typedef struct _TRANSACTION_NOTIFICATION_MARSHAL_ARGUMENT { + ULONG MarshalCookie; + GUID UOW; +} TRANSACTION_NOTIFICATION_MARSHAL_ARGUMENT, *PTRANSACTION_NOTIFICATION_MARSHAL_ARGUMENT; + +typedef TRANSACTION_NOTIFICATION_PROPAGATE_ARGUMENT TRANSACTION_NOTIFICATION_PROMOTE_ARGUMENT, *PTRANSACTION_NOTIFICATION_PROMOTE_ARGUMENT; + +#define KTM_MARSHAL_BLOB_VERSION_MAJOR 1 +#define KTM_MARSHAL_BLOB_VERSION_MINOR 1 + +#define MAX_TRANSACTION_DESCRIPTION_LENGTH 64 +#define MAX_RESOURCEMANAGER_DESCRIPTION_LENGTH 64 + +typedef struct _KCRM_MARSHAL_HEADER { + ULONG VersionMajor; + ULONG VersionMinor; + ULONG NumProtocols; + ULONG Unused; // for alignment purposes +} KCRM_MARSHAL_HEADER, *PKCRM_MARSHAL_HEADER, *RESTRICTED_POINTER PRKCRM_MARSHAL_HEADER; + +typedef struct _KCRM_TRANSACTION_BLOB { + UOW UOW; + GUID TmIdentity; + ULONG IsolationLevel; + ULONG IsolationFlags; + ULONG Timeout; + WCHAR Description[MAX_TRANSACTION_DESCRIPTION_LENGTH]; +} KCRM_TRANSACTION_BLOB, *PKCRM_TRANSACTION_BLOB, *RESTRICTED_POINTER PRKCRM_TRANSACTION_BLOB; + +typedef struct _KCRM_PROTOCOL_BLOB { + CRM_PROTOCOL_ID ProtocolId; + _Field_range_ (0,ULONG_MAX/2) ULONG StaticInfoLength; + ULONG TransactionIdInfoLength; //??? ProtocolDynamicInfoLength; + ULONG Unused1; // for alignment purposes + ULONG Unused2; // for alignment purposes +} KCRM_PROTOCOL_BLOB, *PKCRM_PROTOCOL_BLOB, *RESTRICTED_POINTER PRKCRM_PROTOCOL_BLOB; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + +#endif // _KTMTYPES_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64.inc b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64.inc new file mode 100644 index 0000000000000000000000000000000000000000..28088192d3242a0032e2128c31a1a05739fbb633 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64.inc @@ -0,0 +1,846 @@ + +;++ +; +; Copyright (c) Microsoft Corporation. All rights reserved. +; +; +; Module: +; +; kxamd64.w +; +; Astract: +; +; Contains AMD64 architecture constants and assembly macros. +; +; +;-- + +include macamd64.inc + +; +; If the actual CFG dispatch code is not being assembled, then declare the +; guard dispatch function as external. +; + +ifdef CAPXCALL_VIA_CFG +ifndef CFG_ASM + + extern _guard_dispatch_icall:proc + +endif ; CFG_ASM +endif + +; +; + +; +; Retpoline macros +; + +RETPOLINEDIRECTIVE macro RetpolineType + +ifdef _RETPOLINE + ifidn , + .retpolinerax + elseifidn , + .retpolineswitchtable + elseifidn , + .retpolineimport + elseifidn , + .retpolineguardicall + elseifidn , + .retpolineignore + elseifnb + .err @catstr(, ) + endif +endif ; _RETPOLINE + + ENDM + +; +; IceCAP macros +; + +ifdef _CAPKERN + +; +; Define kernel icecap macros for tracing assembly routines. +; + + extern __CAP_Start_DirectCall_Profiling_ASM:proc + extern __CAP_Start_IndirectCall_Profiling_ASM:proc + extern __CAP_Start_DirectCall_Tail_Profiling_ASM:proc + extern __CAP_Start_IndirectCall_Tail_Profiling_ASM:proc + extern __CAP_Start_DirectJmp_Profiling_ASM:proc + extern __CAP_Start_IndirectJmp_Profiling_ASM:proc + extern __CAP_End_Profiling:proc + +endif ; _CAPKERN + +; +; CAPDCALL - Perform an IceCAP instrumented direct function call. +; +; Do NOT use this macro directly. Use CAPCALL instead. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A function label. +; +; NoRet - If set, the function does not return to the caller. +; +; Return value: +; +; Returns the value of the function specified by Callee. +; + +CAPDCALL macro Callee, NoRet + +ifdef _CAPKERN + +ifnb + + call __CAP_Start_DirectCall_Tail_Profiling_ASM ; record profiling information + +else + + call __CAP_Start_DirectCall_Profiling_ASM ; record profiling information + +endif + +endif ; _CAPKERN + + call Callee + +ifdef _CAPKERN + +ifb + + call __CAP_End_Profiling ; record profiling information + +endif + +endif ; _CAPKERN + + endm + +; +; CAPICALL - Perform an IceCAP instrumented indirect function call. +; +; Do NOT use this macro directly. Use CAPCALL instead. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A register or a memory location. +; +; NoRet - If set, the function does not return to the caller. +; +; Return value: +; +; Returns the value of the function specified by Callee. +; + +CAPICALL macro Callee, NoRet, RetpolineType + +ifdef _CAPKERN + +ifnb + + call __CAP_Start_IndirectCall_Tail_Profiling_ASM ; record profiling information + +else + + call __CAP_Start_IndirectCall_Profiling_ASM ; record profiling information + +endif + +endif ; _CAPKERN + + RETPOLINEDIRECTIVE RetpolineType + + call Callee + + +ifdef _CAPKERN + +ifb + + call __CAP_End_Profiling ; record profiling information + +endif + +endif ; _CAPKERN + + endm + +; +; CAPXCALL - Perform a CFG IceCAP instrumented indirect function call. +; +; This macro MUST be used to call CFG checked functions. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A register or a memory location. +; +; NoRet - If set, the function does not return to the caller. +; +; Return value: +; +; Returns the value of the function specified by Callee. +; + +CAPXCALL macro Callee, NoRet + +ifdifi , + + mov rax, Callee + +endif + +ifdef CAPXCALL_VIA_CFG + + CAPDCALL _guard_dispatch_icall, + +else + + CAPICALL rax, , RetpolineRax +endif + + endm + +; +; CAPCALL - Perform an IceCAP instrumented function call. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A function label, a register, or a memory location. +; +; NoRet - If set, the function does not return to the caller. +; +; Return value: +; +; Returns the value of the function specified by Callee. +; + +CAPCALL macro Callee, NoRet, RetpolineType + +; +; The documentation surrounding the .type operator is very poor. +; Here is the significance of each of the bits. +; +; 0 - References a label in the code segment if set. +; 1 - References a memory variable or relocatable data object if set. +; 2 - Is an immediate (absolute/constant) value if set. +; 3 - Uses direct memory addressing if set. +; 4 - Is a register name, if set. +; 5 - References no undefined symbols and there is no error, if set. +; 6 - Is an SS: relative reference, if set. +; 7 - References an external name. +; + +if (.type(Callee)) eq 000h ; direct via local label + + CAPDCALL Callee, NoRet + +elseif (.type(Callee)) eq 022h ; register-direct call + + CAPICALL Callee, NoRet, RetpolineType + +elseif (.type(Callee)) eq 025h ; direct via extern proc + + CAPDCALL Callee, NoRet + +elseif (.type(Callee)) eq 030h ; register-indirect call + + CAPICALL Callee, NoRet, RetpolineType + +elseif (.type(Callee)) eq 062h ; indirect via offset from register + + CAPICALL Callee, NoRet, RetpolineType + +elseif (.type(Callee)) eq 0A5h ; direct via extern proc + + CAPDCALL Callee, NoRet + +elseif (.type(Callee)) eq 0AAh ; indirect via extern qword + + CAPICALL Callee, NoRet, RetpolineType + +else + + .err @catstr(, %(.type(Callee))) + +endif + + endm + +; +; CAPJMP - Perform an IceCAP instrumented tail jump. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A function label, a memory address, or a register. +; +; Return value: +; +; Never returns. +; + +CAPJMP macro Callee, RetpolineType + +; +; Begin jump instrumentation +; + +ifdef _CAPKERN + +; +; The documentation surrounding the .type operator is very poor. +; See above for syntax explanation. +; + +if (.type(Callee)) eq 000h ; direct via local label + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 022h ; register-direct jump + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 025h ; direct via extern proc + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 030h ; register-indirect + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 062h ; indirect via offset from register + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 0A5h ; direct via extern proc + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 0AAh ; indirect via extern qword + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +else + + .err @catstr(, %(.type(Callee))) + +endif + +endif ; _CAPKERN + +; +; End jump instrumentation. Begin common code. +; + + RETPOLINEDIRECTIVE + + jmp Callee + + endm + +; +; CAPRETPOLJMP - Perform an IceCAP instrumented tail jump using retpoline. +; +; Instrumentation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A function label, a memory address or a register. +; +; Return value: +; +; Never returns. +; + +CAPRETPOLJMP macro Callee, Alignment + + LOCAL Jump + +; +; Begin jump instrumentation +; + +ifdef _CAPKERN + +; +; The documentation surrounding the .type operator is very poor. +; See above for syntax explanation. +; + +if (.type(Callee)) eq 000h ; direct via local label + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 022h ; register-direct jump + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 025h ; direct via extern proc + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 030h ; register-indirect + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 062h ; indirect via offset from register + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 0A5h ; direct via extern proc + + call __CAP_Start_DirectJmp_Profiling_ASM ; record profiling information + +elseif (.type(Callee)) eq 0AAh ; indirect via extern qword + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +else + + .err @catstr(, %(.type(Callee))) + +endif + +endif ; _CAPKERN + +; +; End jump instrumentation. Begin common code. +; + + call Jump + int 3 + +ifnb + ALIGN Alignment +else + ALIGN 16 +endif + +Jump: + mov [rsp], Callee + ret + + endm + +; +; CAPEPILOGJMP - Logs a tail jump from an epilog. +; +; Instrumenation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee - A function label, a memory address, or a register. +; +; Return value: +; +; None +; + +CAPEPILOGJMP macro Callee + + LOCAL Exit + +ifdef _CAPKERN + + jmp Exit +Exit: + CAPJMP Callee + +else + + jmp Callee + +endif ; _CAPKERN + + endm + +; +; CAPREX_JMP_REG - Perform an IceCAP instrumented indirect tail jump. +; Use this when a function does not return to the caller +; and when a rex_jmp_reg would normally be specified. +; +; Instrumentation is disabled on non-IceCAP builds. +; +; Arguments: +; +; Callee is a register or memory location. +; +; Return value: +; +; None +; + +CAPREX_JMP_REG macro Callee, RetpolineType + +ifdef _CAPKERN + + call __CAP_Start_IndirectJmp_Profiling_ASM ; record profiling information + +endif ; _CAPKERN + + RETPOLINEDIRECTIVE + rex_jmp_reg Callee ; make the jump + endm + +; +; Define macro to clear legacy floating exceptions. +; + +clfpex macro + + db 0dbh, 0e2h + + endm + +; +; Define macro to perform an enlightened yield. +; +; Arguments: +; +; None. +; +; N.B. This macro is restricted to only freely using the register specified by +; the 'Register' parameter and rcx. 'Register' should be nonvolatile. +; + +EnlightenedYield macro Register + + local skip + +; +;; + +skip: Yield + + endm + +; +; Define macro to perform the equivalent of reading cr8. +; +; Arguments: +; +; None +; +; The equivalent of the contents of cr8 is returned in rax +; +; N.B. This macro is restricted to using only rax. +; + +ReadCr8 macro + + mov rax, cr8 ; read IRQL + + endm + +; +; Define macro to perform the equivalent of writing cr8. +; +; Arguments: +; +; rcx - The desired value of cr8. +; + +WriteCr8 macro + + mov cr8, rcx ; write IRQL + + endm + +; +; Define macro to get current IRQL. +; +; Arguments: +; +; None. +; +; The previous IRQL is returned in rax. +; + +CurrentIrql macro + + ReadCr8 ; get current IRQL + + endm + +; +; Define macro to lower IRQL. +; +; Arguments: +; +; rcx - Supplies the new IRQL. +; +; N.B. The register rax is destroyed. +; +; N.B. This macro is restricted to using only rcx and rdx. +; + +LowerIrql macro + + local exit + +if DBG + + mov rdx, rax ; preserve rax + ReadCr8 ; get current IRQL + cmp eax, ecx ; check new IRQL + jge short exit ; if ge, new IRQL okay + int 3 ; break into debugger +exit: mov rax, rdx + +endif + + WriteCr8 ; set new IRQL + + endm + +; +; Define macro to raise IRQL. +; +; Arguments: +; +; rcx - Supplies the new IRQL. +; +; The previous IRQL is returned in rax. +; +; N.B. This macro is restricted to using only rax and rcx. +; + +RaiseIrql macro + + local exit + + ReadCr8 ; get current IRQL + +if DBG + + cmp eax, ecx ; check new IRQL + jle short exit ; if le, new IRQL okay + int 3 ; break into debugger + +endif + +exit: WriteCr8 ; set new IRQL + + endm + +; +; Define macro to set IRQL. +; +; Arguments: +; +; rcx - Supplies the new IRQL. +; +; N.B. This macro is restricted to using only rcx. +; + +SetIrql macro + + WriteCr8 ; set new IRQL + + endm + +; +; Define macro to swap IRQL. +; +; Arguments: +; +; rcx - Supplies the new IRQL. +; +; The previous IRQL is returned in rax. +; +; N.B. This macro is restricted to using only rax and rcx. +; + +SwapIrql macro + + ReadCr8 ; get current IRQL + WriteCr8 ; set new IRQL + + endm + +; +; + +; +; Define restore exception state macro. +; +; This macro restores the nonvolatile state. +; +; Arguments: +; +; Flag - If blank, then nonvolatile floating and integer registers are +; restored. If nonblank and identical to "Rbp", then rbp is restored +; in addition to the nonvolatile floating and integer registers. If +; nonblank and identical to "NoFp", then only the nonvolatile integer +; registers are restored. +; +; Implicit arguments: +; +; rsp - Supplies the address of the exception frame. +; + +RESTORE_EXCEPTION_STATE macro Flag + + lea rcx, 100h[rsp] ; set frame display pointer + +ifdif , + + movaps xmm6, ExXmm6[rsp] ; restore nonvolatile xmm registers + movaps xmm7, ExXmm7[rsp] ; + movaps xmm8, ExXmm8[rsp] ; + movaps xmm9, ExXmm9[rsp] ; + movaps xmm10, ExXmm10[rsp] ; + movaps xmm11, (ExXmm11 - 100h)[rcx] ; + movaps xmm12, (ExXmm12 - 100h)[rcx] ; + movaps xmm13, (ExXmm13 - 100h)[rcx] ; + movaps xmm14, (ExXmm14 - 100h)[rcx] ; + movaps xmm15, (ExXmm15 - 100h)[rcx] ; + +endif + + mov rbx, (ExRbx - 100h)[rcx] ; restore nonvolatile integer registers + mov rdi, (ExRdi - 100h)[rcx] ; + mov rsi, (ExRsi - 100h)[rcx] ; + mov r12, (ExR12 - 100h)[rcx] ; + mov r13, (ExR13 - 100h)[rcx] ; + mov r14, (ExR14 - 100h)[rcx] ; + mov r15, (ExR15 - 100h)[rcx] ; + +ifdif , + +ifidn , + + mov rbp, (ExRbp - 100h)[rcx] ; restore nonvolatile integer register + +endif + + add rsp, KEXCEPTION_FRAME_LENGTH - (1 * 8) ; deallocate frame + +ifdif , + + BEGIN_EPILOGUE + +endif + +endif + + endm + +; +; Define generate exception frame macro. +; +; This macro allocates an exception frame and saves the nonvolatile state. +; +; Arguments: +; +; Flag - If blank, then nonvolatile floating and integer registers are +; saved. If nonblank and identical to "Rbp", then rbp is saved in +; addition to the nonvolatile floating and integer registers. If +; nonblank and identical to "NoFp", then only the nonvolatile integer +; registers are saved. If nonblank and identical to "NoPop", then +; allocate an exception record in addition to an exception frame. If +; nonblank and identical to "NoFrame", then rbp is saved in addition to +; the other registers but is not established as a frame pointer. +; +; Implicit arguments: +; +; The top of the stack is assumed to contain a return address. +; + +GENERATE_EXCEPTION_FRAME macro Flag + + +ifidn , + + alloc_stack (EXCEPTION_RECORD_LENGTH + KEXCEPTION_FRAME_LENGTH - (1 * 8)) ; allocate frame + +else + + alloc_stack (KEXCEPTION_FRAME_LENGTH - (1 * 8)) ; allocate frame + +endif + + lea rax, 100h[rsp] ; set frame display pointer + +ifdif , + + save_xmm128 xmm6, ExXmm6 ; save xmm nonvolatile registers + save_xmm128 xmm7, ExXmm7 ; + save_xmm128 xmm8, ExXmm8 ; + save_xmm128 xmm9, ExXmm9 ; + save_xmm128 xmm10, ExXmm10 ; + + movaps (ExXmm11 - 100h)[rax], xmm11 ; + .savexmm128 xmm11, ExXmm11 ; + + movaps (ExXmm12 - 100h)[rax], xmm12 ; + .savexmm128 xmm12, ExXmm12 ; + + movaps (ExXmm13 - 100h)[rax], xmm13 ; + .savexmm128 xmm13, ExXmm13 ; + + movaps (ExXmm14 - 100h)[rax], xmm14 ; + .savexmm128 xmm14, ExXmm14 ; + + movaps (ExXmm15 - 100h)[rax], xmm15 ; + .savexmm128 xmm15, ExXmm15 ; + +endif + +ifidn , + + mov (ExRbp - 100h)[rax], rbp ; save nonvolatile integer register + .savereg rbp, ExRbp ; + set_frame rbp, 0 ; set frame pointer + +endif + +ifidn , + + mov (ExRbp - 100h)[rax], rbp ; save nonvolatile integer register + .savereg rbp, ExRbp ; + +endif + + mov (ExRbx - 100h)[rax], rbx ; + .savereg rbx, ExRbx ; + + mov (ExRdi - 100h)[rax], rdi ; + .savereg rdi, ExRdi ; + + mov (ExRsi - 100h)[rax], rsi ; + .savereg rsi, ExRsi ; + + mov (ExR12 - 100h)[rax], r12 ; + .savereg r12, ExR12 ; + + mov (ExR13 - 100h)[rax], r13 ; + .savereg r13, ExR13 ; + + mov (ExR14 - 100h)[rax], r14 ; + .savereg r14, ExR14 ; + + mov (ExR15 - 100h)[rax], r15 ; + .savereg r15, ExR15 ; + + END_PROLOGUE + + endm + +; diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64_stub.inc b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64_stub.inc new file mode 100644 index 0000000000000000000000000000000000000000..7a3839316a06329df38a457b162853ab5b340842 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxamd64_stub.inc @@ -0,0 +1 @@ +include macamd64.inc diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64.h new file mode 100644 index 0000000000000000000000000000000000000000..dde080fe00867bc5d801c971c3c3b9ea11f3f46d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64.h @@ -0,0 +1,1177 @@ +;++ +; +; Copyright (c) Microsoft Corporation. All rights reserved. +; +; +; Module: +; +; kxarm64.w +; +; Abstract: +; +; Contains ARM architecture constants and assembly macros. +; +;-- + +; +; The ARM assembler uses a baroque syntax that is documented as part +; of the online Windows CE documentation. The syntax derives from +; ARM's own assembler and was chosen to allow the migration of +; specific assembly code bases, namely ARM's floating point runtime. +; While this compatibility is no longer strictly necessary, the +; syntax lives on.... +; +; Highlights: +; * Assembler is white space sensitive. Symbols are defined by putting +; them in the first column +; * The macro definition mechanism is very primitive +; +; To augment the assembler, assembly files are run through CPP (as they are +; on IA64). This works well for constants but not structural components due +; to the white space sensitivity. +; +; For now, we use a mix of native assembler and CPP macros. +; + +#undef TRUE +#undef FALSE + +#define TRUE 1 +#define FALSE 0 + +#include "kxarm64unw.h" + + +; +; For assembly files that are built for both ARM64 and ARM64EC (discouraged +; since the files might not have been ported to use X64 behavior in the ARM64EC +; paths), use this macro to wrap all references to function names (ASM and C). +; +; For ARM64, this does nothing. +; +; For ARM64EC, this changes FuncName to |#FuncName|. +; + +#ifndef A64NAME +#define A64NAME_HASHLIT # +#define A64NAME_HASH() A64NAME_HASHLIT +#ifndef _M_ARM64EC +#define A64NAME(FuncName) FuncName +#else +#define A64NAME_DECORATE(FuncName) A64NAME_HASH() ## FuncName +#define A64NAME(FuncName) |A64NAME_DECORATE(FuncName)| +#endif /*_M_ARM64EC*/ +#endif /*A64NAME*/ + + ; + ; Global variables + ; + + ; Current function names and labels + GBLS __FuncNameNoBars + GBLS __FuncStartLabel + GBLS __FuncEpilog1StartLabel + GBLS __FuncEpilog2StartLabel + GBLS __FuncEpilog3StartLabel + GBLS __FuncEpilog4StartLabel + GBLS __FuncPDataLabel + GBLS __FuncXDataLabel + GBLS __FuncXDataPrologLabel + GBLS __FuncXDataEpilog1Label + GBLS __FuncXDataEpilog2Label + GBLS __FuncXDataEpilog3Label + GBLS __FuncXDataEpilog4Label + GBLS __FuncXDataEndLabel + GBLS __FuncEndLabel + GBLS __FuncEntryThunkLabel + GBLS __FuncExitThunkLabel + + ; other globals relating to the current function + GBLS __FuncComDat + GBLS __FuncArea + GBLS __FuncPDataArea + GBLS __FuncXDataArea + GBLA __FuncAlignment +__FuncAlignment SETA 4 + + ; + ; Helper macro: generate the various labels we will use internally + ; for a function + ; + ; Output is placed in the various __Func*Label globals + ; + + MACRO + __DeriveFunctionLabels $FuncName, $AreaName + +__FuncNameNoBars SETS "$FuncName" + IF ("$FuncName":LEFT:1 == "|") && ("$FuncName":RIGHT:1 == "|") +__FuncNameNoBars SETS ("$FuncName":LEFT:(:LEN:"$FuncName" - 1):RIGHT:(:LEN:"$FuncName" - 2)) + ENDIF +__FuncStartLabel SETS "|$__FuncNameNoBars|" +__FuncEndLabel SETS "|$__FuncNameNoBars._end|" +__FuncEpilog1StartLabel SETS "|$__FuncNameNoBars._epilog1_start|" +__FuncEpilog2StartLabel SETS "|$__FuncNameNoBars._epilog2_start|" +__FuncEpilog3StartLabel SETS "|$__FuncNameNoBars._epilog3_start|" +__FuncEpilog4StartLabel SETS "|$__FuncNameNoBars._epilog4_start|" +__FuncPDataLabel SETS "|$__FuncNameNoBars._pdata|" +__FuncXDataLabel SETS "|$__FuncNameNoBars._xdata|" +__FuncXDataPrologLabel SETS "|$__FuncNameNoBars._xdata_prolog|" +__FuncXDataEpilog1Label SETS "|$__FuncNameNoBars._xdata_epilog1|" +__FuncXDataEpilog2Label SETS "|$__FuncNameNoBars._xdata_epilog2|" +__FuncXDataEpilog3Label SETS "|$__FuncNameNoBars._xdata_epilog3|" +__FuncXDataEpilog4Label SETS "|$__FuncNameNoBars._xdata_epilog4|" +__FuncXDataEndLabel SETS "|$__FuncNameNoBars._xdata_end|" +__FuncEntryThunkLabel SETS "|$__FuncNameNoBars._entry_thunk|" +__FuncArea SETS "|.text|" +__FuncPDataArea SETS "|.pdata|" +__FuncXDataArea SETS "|.xdata|" + IF "$AreaName" != "" +__FuncArea SETS "$AreaName" + ENDIF + IF __FuncComDat != "" +__FuncArea SETS __FuncArea:CC:"{|$__FuncNameNoBars|}" +__FuncPDataArea SETS __FuncPDataArea:CC:"{$__FuncPDataLabel}" +__FuncXDataArea SETS __FuncXDataArea:CC:"{$__FuncXDataLabel}" + ENDIF + + MEND + + + ; + ; Helper macro: create a global label for the given name, + ; decorate it, and export it for external consumption. + ; + + MACRO + __ExportName $FuncName + + LCLS Name + + IF ("$FuncName":LEFT:1 == "|") && ("$FuncName":RIGHT:1 == "|") +Name SETS "$FuncName" + ELSE +Name SETS "|$FuncName|" + ENDIF + + ALIGN 4 + EXPORT $Name +$Name + MEND + + MACRO + __ExportProc $FuncName + + LCLS Name +Name SETS "|$FuncName|" + ALIGN 4 + EXPORT $Name +$Name PROC + MEND + + + ; + ; Helper macro to set the AREA to the correct answer + ; for the current function, and configure the alignment. + ; + + MACRO + __SetFunctionAreaAndAlign $Alignment + + LCLS AreaAlign + LCLS AlignStmt + + ; + ; "NOALIGN" is supported to just set the area + ; + + IF "$Alignment" == "NOALIGN" + AREA $__FuncArea + + ; + ; COMDAT functions must set alignment in the AREA + ; statement + ; + + ELIF __FuncComDat != "" + +AreaAlign SETS "4" + IF "$Alignment" != "" + IF $Alignment > 4 +AreaAlign SETS "$Alignment" + ENDIF + ENDIF + + AREA $__FuncArea,CODE,READONLY,ALIGN=$AreaAlign + + ELSE + +AlignStmt SETS "" + IF "$Alignment" != "" +AlignStmt SETS "ALIGN 0x":CC: :STR:(1 << $Alignment) + ENDIF + + AREA $__FuncArea,CODE,READONLY + $AlignStmt + + ENDIF + + MEND + + + ; + ; Helper macro to emit the special DWORD prior to the start of a + ; function which contains an offset to the ARM64EC entry thunk. + ; The entry thunk must have been previously defined or else this + ; macro is a no-op. + ; + + MACRO + __AddEntryThunkPointer $Alignment + + IF :DEF:$__FuncEntryThunkLabel + ASSERT(__FuncComDat == "") + ALIGN (1 << $Alignment),(1 << $Alignment) - 4 + dcd ($__FuncEntryThunkLabel - ({PC} + 4)) + 1 + ENDIF + + MEND + + + ; + ; Declare that all following code/data is to be put in the .text segment + ; + ; N.B. The ALIGN attribute here specifies an exponent of base 2; not a + ; direct byte count. Thus ALIGN=4 specifies a 16 byte alignment. + ; + + MACRO + TEXTAREA + AREA |.text|,ALIGN=4,CODE,READONLY + MEND + + + ; + ; Declare that all following code/data is to be put in the .data segment + ; + + MACRO + DATAAREA + AREA |.data|,DATA + MEND + + + ; + ; Declare that all following code/data is to be put in the .rdata segment + ; + + MACRO + RODATAAREA + AREA |.rdata|,DATA,READONLY + MEND + + + ; + ; Set/reset the alignment for COMDAT functions that follow. + ; + MACRO + SET_COMDAT_ALIGNMENT $Alignment + +__FuncAlignment SETA $Alignment + IF __FuncAlignment < 4 +__FuncAlignment SETA 4 + ENDIF + + MEND + + + MACRO + RESET_COMDAT_ALIGNMENT + +__FuncAlignment SETA 4 + + MEND + + + ; + ; Macro for indicating the start of a nested function. Nested functions + ; imply a prolog, epilog, and unwind codes. This macro presumes that + ; __DeriveFunctionLabels and __SetFunctionAreaAndAlign have already been + ; called as appropriate + ; + + MACRO + NESTED_ENTRY $FuncName, $AreaName, $ExceptHandler, $Alignment + +__FuncComDat SETS "" + __DeriveFunctionLabels $FuncName,$AreaName + __SetFunctionAreaAndAlign $Alignment + + IF ("$Alignment" != "") +__FuncAlignment SETA $Alignment + ELSE +__FuncAlignment SETA 4 + ENDIF + + __AddEntryThunkPointer $__FuncAlignment + __ResetUnwindState $ExceptHandler + __ExportProc $__FuncNameNoBars + ROUT + + MEND + + + MACRO + NESTED_ENTRY_COMDAT $FuncName, $AreaName, $ExceptHandler, $Alignment + + IF ("$Alignment" != "") + SET_COMDAT_ALIGNMENT $Alignment + ENDIF + +__FuncComDat SETS "COMDAT" + __DeriveFunctionLabels $FuncName,$AreaName + __SetFunctionAreaAndAlign $__FuncAlignment + ASSERT (!:DEF:$__FuncEntryThunkLabel) + __ResetUnwindState $ExceptHandler + __ExportProc $__FuncNameNoBars + ROUT + + MEND + + + ; + ; Generate an ARM64EC entry thunk for an upcoming function. + ; Note that only COMDAT functions are supported. + ; + +#if defined(_M_ARM64EC) + IMPORT __os_arm64x_dispatch_ret + + MACRO + ARM64EC_ENTRY_THUNK $FuncName, $Parameters, $SaveQCount, $AreaName, $Alignment + + LCLS OriginalFunc + LCLS OriginalArea + LCLA Params + LCLA QCount + +Params SETA $Parameters + IF "$SaveQCount" == "" +QCount SETA 10 + ELSE +QCount SETA (($SaveQCount + 1)/2)*2 + ENDIF + + EXPORT $FuncName + + ; first derive labels for the original function + ; and set that as the target area +__FuncComDat SETS "" + __DeriveFunctionLabels $FuncName,$AreaName + __SetFunctionAreaAndAlign $Alignment +OriginalFunc SETS __FuncStartLabel +OriginalArea SETS __FuncArea + + ; then derive labels for the thunk + __DeriveFunctionLabels $__FuncEntryThunkLabel,$AreaName +__FuncArea SETS OriginalArea + __ResetUnwindState + __ExportProc $__FuncNameNoBars + + PROLOG_SAVE_REG_PAIR fp, lr, #-16! + + ; load parameters into x4-x8 as appropriate + ASSERT(Params <= 8) + IF (Params >= 6) + PROLOG_NOP ldp x5, x6, [sp, #48] + ELIF (Params >= 5) + PROLOG_NOP ldr x5, [sp, #48] + ENDIF + IF (Params >= 8) + PROLOG_NOP ldp x7, x8, [sp, #64] + ELIF (Params >= 7) + PROLOG_NOP ldr x7, [sp, #64] + ENDIF + + ; optionally save XMMs + IF (QCount >= 10) + PROLOG_SAVE_REG_PAIR q6, q7, #-160! + PROLOG_SAVE_REG_PAIR q8, q9, #32 + PROLOG_SAVE_REG_PAIR q10, q11, #64 + PROLOG_SAVE_REG_PAIR q12, q13, #96 + PROLOG_SAVE_REG_PAIR q14, q15, #128 + ELIF (QCount >= 8) + PROLOG_SAVE_REG_PAIR q6, q7, #-128! + PROLOG_SAVE_REG_PAIR q8, q9, #32 + PROLOG_SAVE_REG_PAIR q10, q11, #64 + PROLOG_SAVE_REG_PAIR q12, q13, #96 + ELIF (QCount >= 6) + PROLOG_SAVE_REG_PAIR q6, q7, #-96! + PROLOG_SAVE_REG_PAIR q8, q9, #32 + PROLOG_SAVE_REG_PAIR q10, q11, #64 + ELIF (QCount >= 4) + PROLOG_SAVE_REG_PAIR q6, q7, #-64! + PROLOG_SAVE_REG_PAIR q8, q9, #32 + ELIF (QCount >= 2) + PROLOG_SAVE_REG_PAIR q6, q7, #-32! + ENDIF + + ; call through and copy return result to x8 + bl $OriginalFunc + mov x8,x0 + + ; optionally restore XMMs + IF (QCount >= 10) + EPILOG_RESTORE_REG_PAIR q14, q15, #128 + EPILOG_RESTORE_REG_PAIR q12, q13, #96 + EPILOG_RESTORE_REG_PAIR q10, q11, #64 + EPILOG_RESTORE_REG_PAIR q8, q9, #32 + EPILOG_RESTORE_REG_PAIR q6, q7, #160! + ELIF (QCount >= 8) + EPILOG_RESTORE_REG_PAIR q12, q13, #96 + EPILOG_RESTORE_REG_PAIR q10, q11, #64 + EPILOG_RESTORE_REG_PAIR q8, q9, #32 + EPILOG_RESTORE_REG_PAIR q6, q7, #128! + ELIF (QCount >= 6) + EPILOG_RESTORE_REG_PAIR q10, q11, #64 + EPILOG_RESTORE_REG_PAIR q8, q9, #32 + EPILOG_RESTORE_REG_PAIR q6, q7, #96! + ELIF (QCount >= 4) + EPILOG_RESTORE_REG_PAIR q8, q9, #32 + EPILOG_RESTORE_REG_PAIR q6, q7, #64! + ELIF (QCount >= 2) + EPILOG_RESTORE_REG_PAIR q6, q7, #32! + ENDIF + + EPILOG_RESTORE_REG_PAIR fp, lr, #16! + + EPILOG_NOP adrp x16, __os_arm64x_dispatch_ret + EPILOG_NOP ldr x16, [x16, __os_arm64x_dispatch_ret] + EPILOG_END br x16 + + NESTED_END + + MEND + + MACRO + ARM64EC_CUSTOM_ENTRY_THUNK $FuncName, $AreaName, $Alignment + + LCLS OriginalFunc + LCLS OriginalArea + + EXPORT $FuncName + + ; first derive labels for the original function + ; and set that as the target area +__FuncComDat SETS "" + __DeriveFunctionLabels $FuncName,$AreaName + __SetFunctionAreaAndAlign $Alignment +OriginalFunc SETS __FuncStartLabel +OriginalArea SETS __FuncArea + + ; then derive labels for the thunk + __DeriveFunctionLabels $__FuncEntryThunkLabel,$AreaName +__FuncArea SETS OriginalArea + __ResetUnwindState + __ExportProc $__FuncNameNoBars + + MEND + + MACRO + ARM64EC_CUSTOM_ENTRY_THUNK_END + + EPILOG_NOP adrp x16, __os_arm64x_dispatch_ret + EPILOG_NOP ldr x16, [x16, __os_arm64x_dispatch_ret] + EPILOG_END br x16 + + NESTED_END + + MEND + +#else + MACRO + ARM64EC_ENTRY_THUNK $FuncName, $Parameters, $SaveQCount, $AreaName, $Alignment + MEND + + MACRO + ARM64EC_CUSTOM_ENTRY_THUNK $FuncName, $AreaName, $Alignment + MEND +#endif + + + ; + ; Macro for indicating the end of a nested function. We generate the + ; .pdata and .xdata records here as necessary. + ; + ; Note that the $FuncName parameter is vestigial and not consumed. + ; + + MACRO + NESTED_END $FuncName + + ; mark the end of the function +$__FuncEndLabel + LTORG + ENDP + + ; generate .pdata + + IF __FuncComDat != "" + AREA $__FuncPDataArea,ALIGN=2,READONLY,ASSOC=$__FuncArea + ELSE + AREA $__FuncPDataArea,ALIGN=2,READONLY + ENDIF + + DCD $__FuncStartLabel + RELOC 2 ; make this relative to image base + + DCD $__FuncXDataLabel + RELOC 2 ; make this relative to image base + + ; generate .xdata + __EmitUnwindXData + + ; back to the original area + __SetFunctionAreaAndAlign NOALIGN + + ; reset the labels +__FuncStartLabel SETS "" +__FuncEndLabel SETS "" + + MEND + + + ; + ; Macro for indicating the start of a leaf function. + ; + + MACRO + LEAF_ENTRY $FuncName, $AreaName, $Alignment + + NESTED_ENTRY $FuncName, $AreaName, "", $Alignment + + MEND + + + MACRO + LEAF_ENTRY_COMDAT $FuncName, $AreaName, $Alignment + + NESTED_ENTRY_COMDAT $FuncName, $AreaName, "", $Alignment + + MEND + + + ; + ; Macro for indicating the end of a leaf function. + ; + + MACRO + LEAF_END $FuncName + + NESTED_END $FuncName + + MEND + + +#if defined(_CHPE_X86_ARM64_) || defined(ARM64_ASM_IN_COMDAT) || (defined(_M_ARM64EC) && defined (ARM64EC_ASM_IN_COMDAT)) +#define NESTED_ENTRY NESTED_ENTRY_COMDAT +#define LEAF_ENTRY LEAF_ENTRY_COMDAT +#endif + + +#if !defined(_CHPE_X86_ARM64_) + + ; + ; Macro for indicating the start of a leaf function. + ; + + MACRO + LEAF_ENTRY_NO_PDATA $FuncName, $AreaName + + ; compute the function's labels + __DeriveFunctionLabels $FuncName,$AreaName + __SetFunctionAreaAndAlign + + ; export the function name + __ExportProc $__FuncNameNoBars + + ; flush any pending literal pool stuff + ROUT + + MEND + + + ; + ; Macro for indicating the end of a leaf function. + ; + + MACRO + LEAF_END_NO_PDATA $FuncName + + ; mark the end of the function +$__FuncEndLabel + LTORG + ENDP + + ; reset the labels +__FuncStartLabel SETS "" +__FuncEndLabel SETS "" + + MEND + +#endif + + + ; + ; Macro for indicating an alternate entry point into a function. + ; + + MACRO + ALTERNATE_ENTRY $FuncName + + ; export the entry point's name + __ExportName $FuncName + + ; flush any pending literal pool stuff + ROUT + + MEND + + + ; + ; Macro for getting the address of a data item. + ; + + MACRO + ADDROF $Reg, $Variable + + adrp $Reg, $Variable ; get the page address first + add $Reg, $Reg, $Variable ; add in the low bits + + MEND + + + ; + ; Macro for loading a 32-bit constant. + ; + + MACRO + MOVL32 $Reg, $Variable + + IF ((($Variable):SHR:16):AND:0xffff) == 0 + movz $Reg, #$Variable + ELIF ((($Variable):SHR:0):AND:0xffff) == 0 + movz $Reg, #((($Variable):SHR:16):AND:0xffff), lsl #16 + ELSE + movz $Reg, #(($Variable):AND:0xffff) + movk $Reg, #((($Variable):SHR:16):AND:0xffff), lsl #16 + ENDIF + + MEND + + +#if defined(_CAPKERN) + + ; + ; Icecap entrypoints + ; + + IMPORT _CAP_Start_Profiling + IMPORT _CAP_End_Profiling + + + ; + ; Macro to record a call record + ; + + MACRO + CAPSTART $arg1, $arg2 + + stp x0, x1, [sp, #-16]! + + ldr x0, =$arg1 + ldr x1, =$arg2 + bl _CAP_Start_Profiling + + ldp x0, x1, [sp], #16 + + MEND + + + ; + ; Macro to record a return record + ; + + MACRO + CAPEND $arg1 + + sub sp, sp, #16 + str x0, [sp, #0] + + ldr x0, =$arg1 + bl _CAP_End_Profiling + + ldr x0, [sp, #0] + add sp, sp, #16 + + MEND + +#else + + MACRO + CAPSTART $arg1, $arg2 + MEND + + MACRO + CAPEND $arg1 + MEND + +#endif + + + ; + ; Macro to align a Control Flow Guard valid call target. + ; Not necessary to use this before functions anymore as + ; it is the default for NESTED_ENTRY/LEAF_ENTRY macros. + ; + + MACRO + CFG_ALIGN + ALIGN 16 + MEND + + + ; + ; Macro to perform a Control Flow Guard check on a live call target. + ; + ; $TargetReg - Target address register + ; x16 - Bitmap address + ; $FailLabel - Label to jump to in the event of a failure + ; + ; N.B. x16-x17 are free, other registers should be treated as live. + ; + ; N.B. ValidTarget should only specify a label for the ARM64EC checkers. + ; The function has logic below which depends on this. + ; + + MACRO + CFG_ICALL_CHECK_BITMAP $TargetReg, $ValidTarget, $FailLabel + + LCLS ValidLabel + +ValidLabel SETS "" + + IF ("$ValidTarget":LEFT:1 != "x" && "$ValidTarget":LEFT:1 != "w" && "$ValidTarget" != "lr") + +ValidLabel SETS "$ValidTarget" + + ENDIF + +; +; Bitmap is an array of 2-bit values. Each 2-bit value represents 16 bytes, with the low +; bit set if jumps are permitted, and the upper bit set if misaligned jumps are permitted. +; +; The bit index is (address >> 4). +; Each byte holds 4 entries, so the byte index is (address >> 6). +; The shift amount is computed as 2*((address >> 4) & 3), or (address >> 3) & 6 +; If address is aligned, (address >> 3) & 7 is equivalent, and ubfx can be used to extract. +; + + lsr x17, $TargetReg, #6 ; compute bitmap byte index + tst $TargetReg, #15 ; misaligned address? + ldrb w17, [x16, x17] ; load byte from bitmap + ubfx x16, $TargetReg, #3, #3 ; compute bit index*2 + bne %F2 ; if misaligned, account for extra bits + lsr x17, x17, x16 ; shift bitmap chunk over to valid align bit + tbz x17, #0, %F3 ; if low bit not set, verify the upper bit to + ; allow an export suppressed target +1 ; Valid + +; +; "ret lr" and "br lr" have different encodings and use of "ret lr" is +; preferred to hint that it is returning to the caller. +; + + IF "$ValidLabel" != "" + b $ValidLabel ; jump to valid target + ELIF "$ValidTarget" != "lr" + br $ValidTarget ; jump to valid target + ELSE + ret lr ; return + ENDIF + +2 ; Misaligned + ; + ; Code on ARM64 should always be 16 byte aligned if address taken. + ; + ; TODO: Compress bitmap format to 1 bit per address on ARM64? + ; TODO: We are seeing 8-byte aligned code now. (1/22/14) + ; + and x16, x16, #0xfffffffffffffffe ; force low bit of shift to 0 + lsr x17, x17, x16 ; shift bitmap chunk down + tbz x17, #0, %F4 ; invalid if the low bit was clear +3 ; FailOpen + tbnz x17, #1, %B1 ; valid if upper bit was set as well +4 ; Failure + IF "$ValidLabel" != "" + ; + ; Don't need to explicitly set mode for ARM64EC. + ; + ELIF "$ValidTarget" != "lr" + mov x16, #1 ; CFG dispatch mode + IF ("$TargetReg" != "x15") + mov x15, $TargetReg ; move CFG target to x15 for failure function + ENDIF + ELSE + mov x16, #0 ; CFG check mode + IF ("$TargetReg" != "x15") + mov x15, $TargetReg ; move CFG target to x15 for failure function + ENDIF + ENDIF + + b $FailLabel ; jump to failure function + MEND + + + ; + ; Macro to perform a Control Flow Guard check on a live call target with export suppression. + ; + ; $TargetReg - Target address register + ; x16 - Bitmap address + ; $FailLabel - Label to jump to in the event of a failure + ; + ; N.B. x16-x17 are free, other registers should be treated as live. + ; + ; N.B. ValidTarget should only specify a label for the ARM64EC checkers. + ; The function has logic below which depends on this. + ; + + MACRO + CFG_ICALL_CHECK_BITMAP_ES $TargetReg, $ValidTarget, $FailLabel + + LCLS ValidLabel + +ValidLabel SETS "" + + IF ("$ValidTarget":LEFT:1 != "x" && "$ValidTarget":LEFT:1 != "w" && "$ValidTarget" != "lr") + +ValidLabel SETS "$ValidTarget" + + ENDIF + +; +; Bitmap is an array of 2-bit values. Each 2-bit value represents 16 bytes, with the low +; bit set if jumps are permitted, and the upper bit set if misaligned jumps are permitted. +; +; The bit index is (address >> 4). +; Each byte holds 4 entries, so the byte index is (address >> 6). +; The shift amount is computed as 2*((address >> 4) & 3), or (address >> 3) & 6 +; If address is aligned, (address >> 3) & 7 is equivalent, and ubfx can be used to extract. +; + + lsr x17, $TargetReg, #6 ; compute bitmap byte index + tst $TargetReg, #15 ; misaligned address? + ldrb w17, [x16, x17] ; load byte from bitmap + ubfx x16, $TargetReg, #3, #3 ; compute bit index*2 + bne %F2 ; if misaligned, account for extra bits + lsr x17, x17, x16 ; shift bitmap chunk over to valid align bit + tbz x17, #0, %F3 ; if low bit not set, either invalid or export + ; suppressed target +1 ; Valid + +; +; "ret lr" and "br lr" have different encodings and use of "ret lr" is +; preferred to hint that it is returning to the caller. +; + + IF "$ValidLabel" != "" + b $ValidLabel ; jump to valid target + ELIF "$ValidTarget" != "lr" + br $ValidTarget ; jump to valid target + ELSE + ret lr ; return + ENDIF + +2 ; Misaligned + ; + ; Code on ARM64 should always be 16 byte aligned if address taken. + ; + ; TODO: Compress bitmap format to 1 bit per address on ARM64? + ; TODO: We are seeing 8-byte aligned code now. (1/22/14) + ; + and x16, x16, #0xfffffffffffffffe ; force low bit of shift to 0 + lsr x17, x17, x16 ; shift bitmap chunk down + tbz x17, #0, %F3 ; invalid if the low bit was clear + tbnz x17, #1, %B1 ; valid if upper bit was set as well + +3 ; Failure + IF "$ValidLabel" != "" + ; + ; Don't need to explicitly set mode for ARM64EC. + ; + ELIF "$ValidTarget" != "lr" + mov x16, #1 ; CFG dispatch mode + IF ("$TargetReg" != "x15") + mov x15, $TargetReg ; move CFG target to x15 for failure function + ENDIF + ELSE + mov x16, #0 ; CFG check mode + IF ("$TargetReg" != "x15") + mov x15, $TargetReg ; move CFG target to x15 for failure function + ENDIF + ENDIF + + b $FailLabel ; jump to failure function + MEND + + + ; + ; Macro to acquire a spin lock at address $Reg + $Offset. Clobbers {r0-r2} + ; + +; ARM64_WORKITEM : should we use acquire/release semantics instead of DMB? + +; +; TODO: Today this routine is not used. If it is used in the future, consider +; whether the yield should be switched to enlightened yield. +; + + MACRO + ACQUIRE_SPIN_LOCK $Reg, $Offset + + mov x0, #1 ; we want to exchange with a 1 + dmb ; memory barrier ahead of the loop +1 + ldxr x1, [$Reg, $Offset] ; load the new value + stxr x2, x0, [$Reg, $Offset] ; attempt to store the 1 + cbnz x2, %B1 ; did we succeed before someone else did? + cbz x1, %F3 ; was the lock previously owned? if not, we're done + yield ; yield execution + b %B1 ; and try again +3 + dmb + + MEND + + + ; + ; Macro to release a spin lock at address $Reg + $Offset. + ; + +; ARM64_WORKITEM : should we use acquire/release semantics instead of DMB? + + MACRO + RELEASE_SPIN_LOCK $Reg, $Offset + + dmb + str xzr, [$Reg, $Offset] ; store 0 + + MEND + + + ; + ; Macro to increment a 64-bit statistic. + ; + + MACRO + INCREMENT_STAT $AddrReg, $Temp1, $Temp2 + +1 ldxr $Temp1, [$AddrReg] ; load current value + add $Temp1, $Temp1, #1 ; increment + stxr $Temp2, $Temp1, [$AddrReg] ; attempt to store + cbnz $Temp2, %B1 ; loop until it works? + + MEND + + + ; + ; Macros to enable/disable interrupts. + ; + + MACRO + ENABLE_INTERRUPTS + msr DAIFClr, #2 ; enable interrupts + MEND + + MACRO + DISABLE_INTERRUPTS + msr DAIFSet, #2 ; disable interrupts + MEND + + + ; + ; Macros to read/write the current IRQL + ; + ; N.B. These macros do not do hardware and software IRQL processing. + ; + + MACRO + GET_IRQL $Irql + ldrb $Irql, [x18, #PcCurrentIrql] ; read IRQL + MEND + + MACRO + RAISE_IRQL $Reg, $NewIrql + +#if DBG + + GET_IRQL $Reg ; get old IRQL + cmp $Reg, #$NewIrql ; check if old IRQL is lower or same + bls %F1 ; if LS, valid transition + + EMIT_BREAKPOINT ; break +1 +#endif + + mov $Reg, #$NewIrql ; get new IRQL + strb $Reg, [x18, #PcCurrentIrql] ; update IRQL + MEND + + + ; + ; Macros to output special undefined opcodes that indicate breakpoints + ; and debug services. + ; + + MACRO + EMIT_BREAKPOINT + brk #ARM64_BREAKPOINT + MEND + + + MACRO + EMIT_DEBUG_SERVICE + brk #ARM64_DEBUG_SERVICE + MEND + + MACRO + FASTFAIL $FastFailCode + mov x0, $FastFailCode + brk #ARM64_FASTFAIL + MEND + + + ; + ; Macro to generate an exception frame; this is intended to + ; be used within the prolog of a function. + ; + + MACRO + GENERATE_EXCEPTION_FRAME + PROLOG_SAVE_REG_PAIR x19, x20, #-96! + PROLOG_SAVE_REG_PAIR x21, x22, #16 +#if !defined(_M_ARM64EC) + PROLOG_SAVE_REG_PAIR x23, x24, #32 +#else + PROLOG_NOP stp xzr, xzr, [sp, #32] +#endif + PROLOG_SAVE_REG_PAIR x25, x26, #48 +#if !defined(_M_ARM64EC) + PROLOG_SAVE_REG_PAIR x27, x28, #64 +#else + PROLOG_SAVE_REG x27, #64 + PROLOG_NOP str xzr, [sp, #72] +#endif + PROLOG_SAVE_REG_PAIR fp, lr, #80 + MEND + + + ; + ; Macro to restore from an exception frame; this is intended to + ; be used within the epilog of a function. + ; + + MACRO + RESTORE_EXCEPTION_STATE + EPILOG_RESTORE_REG_PAIR fp, lr, #80 +#if !defined(_M_ARM64EC) + EPILOG_RESTORE_REG_PAIR x27, x28, #64 +#else + EPILOG_RESTORE_REG x27 , #64 +#endif + EPILOG_RESTORE_REG_PAIR x25, x26, #48 +#if !defined(_M_ARM64EC) + EPILOG_RESTORE_REG_PAIR x23, x24, #32 +#endif + EPILOG_RESTORE_REG_PAIR x21, x22, #16 + EPILOG_RESTORE_REG_PAIR x19, x20, #96! + MEND + + + ; + ; Macro to ensure that any eret is followed by barriers to + ; prevent speculation + ; + MACRO + ERET_FIX + eret + dsb sy + isb sy + DCD 0xD50330FF ; sb + MEND + +#define eret ERET_FIX + + ; + ; Given an address, obtains a pointer to the EC code bitmap from the + ; specified global (typically located in the .mrdata section) and + ; performs a bitmap lookup to determine if the address is EC code. + ; + ; Sets the Zero Flag for X64 targets, clears the Zero Flag for EC targets. + ; + ; xAddress - On input, the code address to be tested. + ; This value is preserved. + ; + ; T1 - On input, the address of the EC Bitmap. + ; This register is then used as scratch. + ; + ; T2 - On input, the max user-land address. + ; This register is then used as scratch. + ; + ; xResult - Returns true(1) if the target is EC code + ; and false(0) otherwise. This can be 'xzr' + ; if a boolen result is not required. It can + ; also overlap with xAddress, T1 or T2. + ; + ; SkipBoundsChecking - If set to "SkipBoundsChecking", no EC + ; Bitmap bounds checks are performed (and + ; T2 doesn't need to provide the max user-land + ; address). T2 is still a scratch reg. + ; + ; Zero Flag - Z=0 for EC code and Z=1 otherwise. + ; + + MACRO + EC_BITMAP_LOOKUP $xAddress, $T1, $T2, $xResult, $SkipBoundsChecking + + IF "$SkipBoundsChecking" != "SkipBoundsChecking" + + cmp $xAddress, x$T2 ; Check if the address is above user space range + bhi %F1 + + cmp $xAddress, #(MM_LOWEST_USER_ADDRESS / 4096), lsl #12 ; Check if address < MM_LOWEST_USER_ADDRESS (64KiB) + blo %F1 ; if so, take the fast path + + ENDIF + + lsr x$T2, $xAddress, #15 ; each byte of bitmap indexes 8*4K = 2^15 byte span + ldrb w$T2, [x$T1, x$T2] ; load the bitmap byte for the 8*4K span + ; + ; * IF THIS INSTRUCTION EVER CHANGES, SO MUST + ; KiOpPreprocessAccessViolation * + ; + ubfx x$T1, $xAddress, #12, #3 ; index to the 4K page within the 8*4K span + lsr x$T1, x$T2, x$T1 + + IF "$SkipBoundsChecking" != "SkipBoundsChecking" + + b %F2 +1 + mov x$T1, xzr + + ENDIF + +2 + ands $xResult, x$T1, #1 ; test the specific page + + MEND diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64unw.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64unw.h new file mode 100644 index 0000000000000000000000000000000000000000..f77dd3514c3059702fa4a963d6ab66be3152ef9b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/kxarm64unw.h @@ -0,0 +1,1061 @@ +;++ +; +; Copyright (c) Microsoft Corporation. All rights reserved. +; +; +; Module: +; +; kxarm64unw.w +; +; Abstract: +; +; Contains ARM64 unwind code helper macros +; +; This file is not really useful on its own without the support from +; kxarm64.h. +; +;-- + +; +; The following macros are defined here: +; +; PROLOG_STACK_ALLOC +; PROLOG_SAVE_REG +; PROLOG_SAVE_REG_PAIR +; PROLOG_SAVE_REG_PAIR_NO_FP +; PROLOG_NOP +; PROLOG_SAVE_NEXT_PAIR +; PROLOG_PUSH_TRAP_FRAME +; PROLOG_PUSH_MACHINE_FRAME +; PROLOG_PUSH_CONTEXT +; PROLOG_PUSH_EC_CONTEXT +; PROLOG_SIGN_RETURN_ADDRESS +; +; EPILOG_STACK_FREE +; EPILOG_RECOVER_SP +; EPILOG_RESTORE_REG +; EPILOG_RESTORE_REG_PAIR +; EPILOG_NOP +; EPILOG_RESTORE_NEXT_PAIR +; EPILOG_AUTHENTICATE_RETURN_ADDRESS +; EPILOG_RETURN +; + + ; + ; Global variables + ; + + ; result from __ParseRegisterNumber + GBLA __ParsedRegNumber + + ; result from __ParseOffset + GBLA __ParsedOffsetAbs + GBLA __ParsedOffsetShifted3 + GBLA __ParsedOffsetShifted4 + GBLA __ParsedOffsetPreinc + GBLS __ParsedOffsetRawString + GBLS __ParsedOffsetString + + ; results from __ComputeCodes[...] + GBLS __ComputedCodes + GBLL __RegPairWasFpLr + + ; global state and accumulators + GBLS __PrologUnwindString + GBLS __PrologLastLabel + GBLA __EpilogUnwindCount + GBLS __Epilog1UnwindString + GBLS __Epilog2UnwindString + GBLS __Epilog3UnwindString + GBLS __Epilog4UnwindString + GBLL __EpilogStartNotDefined + GBLA __RunningIndex + GBLS __RunningLabel + GBLS __FuncExceptionHandler + + + ; + ; Helper macro: emit an opcode with a generated label + ; + ; Output: Name of label is in $__RunningLabel + ; + + MACRO + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4,$O5,$O6 + +__RunningLabel SETS "|Temp.$__RunningIndex|" +__RunningIndex SETA __RunningIndex + 1 + + IF "$O6" != "" +$__RunningLabel $O1,$O2,$O3,$O4,$O5,$O6 + ELIF "$O5" != "" +$__RunningLabel $O1,$O2,$O3,$O4,$O5 + ELIF "$O4" != "" +$__RunningLabel $O1,$O2,$O3,$O4 + ELIF "$O3" != "" +$__RunningLabel $O1,$O2,$O3 + ELIF "$O2" != "" +$__RunningLabel $O1,$O2 + ELIF "$O1" != "" +$__RunningLabel $O1 + ELSE +$__RunningLabel + ENDIF + + MEND + + + ; + ; Helper macro: append unwind codes to the prolog string + ; + ; Input is in __ComputedCodes + ; + + MACRO + __AppendPrologCodes + +__PrologUnwindString SETS "$__ComputedCodes,$__PrologUnwindString" + + MEND + + + ; + ; Helper macro: append unwind codes to the epilog string + ; + ; Input is in __ComputedCodes + ; + + MACRO + __AppendEpilogCodes + + IF __EpilogUnwindCount == 1 +__Epilog1UnwindString SETS "$__Epilog1UnwindString,$__ComputedCodes" + ELIF __EpilogUnwindCount == 2 +__Epilog2UnwindString SETS "$__Epilog2UnwindString,$__ComputedCodes" + ELIF __EpilogUnwindCount == 3 +__Epilog3UnwindString SETS "$__Epilog3UnwindString,$__ComputedCodes" + ELIF __EpilogUnwindCount == 4 +__Epilog4UnwindString SETS "$__Epilog4UnwindString,$__ComputedCodes" + ENDIF + + MEND + + + ; + ; Helper macro: detect prolog end + ; + + MACRO + __DeclarePrologEnd + +__PrologLastLabel SETS "$__RunningLabel" + + MEND + + + ; + ; Helper macro: detect epilog start + ; + + MACRO + __DeclareEpilogStart + + IF __EpilogStartNotDefined +__EpilogStartNotDefined SETL {false} +__EpilogUnwindCount SETA __EpilogUnwindCount + 1 + IF __EpilogUnwindCount == 1 +$__FuncEpilog1StartLabel + ELIF __EpilogUnwindCount == 2 +$__FuncEpilog2StartLabel + ELIF __EpilogUnwindCount == 3 +$__FuncEpilog3StartLabel + ELIF __EpilogUnwindCount == 4 +$__FuncEpilog4StartLabel + ELSE + INFO 1, "Too many epilogues!" + ENDIF + ENDIF + + MEND + + + ; + ; Helper macro: specify epilog end + ; + + MACRO + __DeclareEpilogEnd + +__EpilogStartNotDefined SETL {true} + + MEND + + + ; + ; Parse a register number + ; + ; Calling macro name is in $Name + ; Input is in $Reg + ; Output is placed in __ParsedRegNumber + ; + + MACRO + __ParseRegisterNumber $Name, $Reg + + LCLS RString + +RString SETS "$Reg" + + IF (RString:LEFT:1 == "q") || (RString:LEFT:1 == "v") + +RString SETS RString:RIGHT:(:LEN:RString - 1) +__ParsedRegNumber SETA 64 + $RString + + ELIF RString:LEFT:1 == "d" + +RString SETS RString:RIGHT:(:LEN:RString - 1) +__ParsedRegNumber SETA 32 + $RString + + ELSE + +__ParsedRegNumber SETA :RCONST:$RString + + ENDIF + + MEND + + + ; + ; Parse a stack offset + ; + ; Calling macro name is in $Name + ; Input is in $Offset + ; Which is "Prolog" or "Epilog" + ; Output is placed in __ParsedOffsetAbs, __ParsedOffsetPreinc, __ParsedOffsetString + ; + + MACRO + __ParseOffset $Name, $Offset, $Which + + ; copy to local string + LCLS OffsStr +OffsStr SETS "$Offset" + + ; strip opening # if present + IF OffsStr:LEFT:1 == "#" +OffsStr SETS OffsStr:RIGHT:(:LEN:OffsStr - 1) + ENDIF + + ; look for pre/postincrement forms + IF OffsStr:RIGHT:1 == "!" + + ; prolog must be preincrement with a negative offset + IF "$Which" == "Prolog" + + IF OffsStr:LEFT:1 != "-" + INFO 1, "$Name: Preincrement offsets must be negative" + MEXIT + ENDIF + +OffsStr SETS OffsStr:LEFT:(:LEN:OffsStr - 1) +__ParsedOffsetAbs SETA $OffsStr +__ParsedOffsetAbs SETA -__ParsedOffsetAbs +__ParsedOffsetPreinc SETA 1 +__ParsedOffsetRawString SETS "#":CC:OffsStr +__ParsedOffsetString SETS "[sp, #":CC:OffsStr:CC:"]!" + + ; epilog must be postincrement with a positive offset + ELSE + + IF OffsStr:LEFT:1 == "-" + INFO 1, "$Name: Postincrement offsets must not be negative" + MEXIT + ENDIF + +OffsStr SETS OffsStr:LEFT:(:LEN:OffsStr - 1) +__ParsedOffsetAbs SETA $OffsStr +__ParsedOffsetPreinc SETA 1 +__ParsedOffsetRawString SETS "#":CC:OffsStr +__ParsedOffsetString SETS "[sp], #":CC:OffsStr + + ENDIF + + ; standard form + ELSE + + IF OffsStr:LEFT:1 == "-" + INFO 1, "$Name: Stack offsets must not be negative" + MEXIT + ENDIF + +__ParsedOffsetAbs SETA $OffsStr +__ParsedOffsetPreinc SETA 0 +__ParsedOffsetRawString SETS "#":CC:OffsStr +__ParsedOffsetString SETS "[sp, #":CC:OffsStr:CC:"]" + + ENDIF + +__ParsedOffsetShifted3 SETA __ParsedOffsetAbs:SHR:3 - __ParsedOffsetPreinc +__ParsedOffsetShifted4 SETA __ParsedOffsetAbs:SHR:4 - __ParsedOffsetPreinc + + IF __ParsedOffsetAbs != ((__ParsedOffsetShifted3 + __ParsedOffsetPreinc):SHL:3) || __ParsedOffsetShifted3 >= 0x40 + INFO 1, "$Name: invalid offset $Offset" + MEXIT + ENDIF + + + MEND + + + ; + ; Compute unwind codes for a register save operation + ; + ; Calling macro name is in $Name + ; Input is in $Reg1, $Offset + ; Which specifies "Prolog" or "Epilog" + ; Output is placed in __ComputedCodes + ; + + MACRO + __ComputeSaveRegCodes $Name, $Reg1, $Offset, $Which + + LCLA ByteVal + LCLA ByteVal2 + LCLA ByteVal3 + LCLA RegNum + + __ParseRegisterNumber $Name, $Reg1 +RegNum SETA __ParsedRegNumber + + __ParseOffset $Name, $Offset, $Which + + IF (RegNum >= 19) && (RegNum <= 30) +ByteVal SETA 0xd0:OR:(__ParsedOffsetPreinc:SHL:2):OR:((RegNum - 19):SHR:2) +ByteVal2 SETA (((RegNum - 19):AND:3):SHL:6):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2) + + ELIF (RegNum >= 40) && (RegNum <= 47) +ByteVal SETA 0xdc:OR:(__ParsedOffsetPreinc:SHL:1):OR:((RegNum - 40):SHR:2) +ByteVal2 SETA (((RegNum - 40):AND:3):SHL:6):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2) + +#if defined(_M_ARM64EC) || ENABLE_SAVE_ANY_REG + ELIF (RegNum < 96) + ; 11100111 ' 0pxrrrrr ' ffoooooo + ; p: 0/1 - single/pair + ; x: 0/1 - positive offset / negative offset with writeback + ; r: register number + ; f: 00/01/10 - X / D / Q + ; o: offset * 16 for x=1 or p=1 or f=Q / else offset * 8 +ByteVal SETA 0xe7 +ByteVal2 SETA 0x00:OR:(__ParsedOffsetPreinc:SHL:5):OR:(RegNum:AND:31) +ByteVal3 SETA (RegNum:AND:0x60):SHL:1 + IF (RegNum >= 64) || (__ParsedOffsetPreinc != 0) +ByteVal3 SETA ByteVal3:OR:__ParsedOffsetShifted4 + ELSE +ByteVal3 SETA ByteVal3:OR:__ParsedOffsetShifted3 + ENDIF +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2):CC:",0x":CC:((:STR:ByteVal3):RIGHT:2) +#endif + + ELSE + INFO 1, "$Name: Unsupported register: $Reg1" + ENDIF + + MEND + + + ; + ; Compute unwind codes for a register pair save operation + ; + ; Calling macro name is in $Name + ; Input is in $Reg1, $Reg2, $Offset + ; Which specifies "Prolog" or "Epilog" + ; Output is placed in __ComputedCodes + ; + + MACRO + __ComputeSaveRegPairCodes $Name, $Reg1, $Reg2, $Offset, $Which + + LCLA ByteVal + LCLA ByteVal2 + LCLA ByteVal3 + LCLA RegNum1 + LCLA RegNum2 + + __ParseRegisterNumber $Name, $Reg1 +RegNum1 SETA __ParsedRegNumber + + __ParseRegisterNumber $Name, $Reg2 +RegNum2 SETA __ParsedRegNumber + + __ParseOffset $Name, $Offset, $Which + +__RegPairWasFpLr SETL {false} + + IF (RegNum1 == 29) && (RegNum2 == 30) +ByteVal SETA (0x40+(__ParsedOffsetPreinc*0x40)):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2) +__RegPairWasFpLr SETL {true} + + ELIF (RegNum1 == 19) && (RegNum2 == 20) && (__ParsedOffsetPreinc != 0) +ByteVal SETA 0x20:OR:(__ParsedOffsetShifted3 + 1) +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2) + + ELIF (RegNum1 >= 19) && (RegNum1 <= 30) && (((RegNum1 - 19):AND:1) == 0) && (RegNum2 == 30) && (__ParsedOffsetPreinc == 0) +ByteVal SETA 0xd6:OR:((RegNum1 - 19):SHR:3) +ByteVal2 SETA ((((RegNum1 - 19):SHR:1):AND:3):SHL:6):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2) + + ELIF (RegNum1 >= 19) && (RegNum1 <= 30) && (RegNum2 == (RegNum1 + 1)) +ByteVal SETA 0xc8:OR:(__ParsedOffsetPreinc:SHL:2):OR:((RegNum1 - 19):SHR:2) +ByteVal2 SETA (((RegNum1 - 19):AND:3):SHL:6):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2) + + ELIF (RegNum1 >= 40) && (RegNum1 <= 47) && (RegNum2 == (RegNum1 + 1)) +ByteVal SETA 0xd8:OR:(__ParsedOffsetPreinc:SHL:1):OR:((RegNum1 - 40):SHR:2) +ByteVal2 SETA (((RegNum1 - 40):AND:3):SHL:6):OR:__ParsedOffsetShifted3 +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2) + +#if defined(_M_ARM64EC) || ENABLE_SAVE_ANY_REG + ELIF (RegNum2 == (RegNum1 + 1)) + ; 11100111 ' 0pxrrrrr ' ffoooooo + ; p: 0/1 - single/pair + ; x: 0/1 - positive offset / negative offset with writeback + ; r: register number + ; f: 00/01/10 - X / D / Q + ; o: offset * 16 for x=1 or p=1 or f=Q / else offset * 8 +ByteVal SETA 0xe7 +ByteVal2 SETA 0x40:OR:(__ParsedOffsetPreinc:SHL:5):OR:(RegNum1:AND:31) +ByteVal3 SETA ((RegNum1:AND:0x60):SHL:1):OR:(__ParsedOffsetAbs:SHR:4 - __ParsedOffsetPreinc) +__ComputedCodes SETS "0x":CC:((:STR:ByteVal):RIGHT:2):CC:",0x":CC:((:STR:ByteVal2):RIGHT:2):CC:",0x":CC:((:STR:ByteVal3):RIGHT:2) +#endif + + ELSE + INFO 1, "$Name: Unsupported register pair: $Reg1, $Reg2" + ENDIF + + MEND + + + ; + ; Compute unwind codes for a stack alloc/dealloc operation + ; + ; Output is placed in __ComputedCodes + ; + + MACRO + __ComputeStackAllocCodes $Name, $Amount + + LCLA Shifted + LCLA Byte1 + LCLA Byte2 + LCLA Byte3 + +Shifted SETA ($Amount):SHR:4 + + IF Shifted < 0x20 +__ComputedCodes SETS "0x":CC:((:STR:Shifted):RIGHT:2) + + ELIF Shifted < 0x800 +Byte1 SETA 0xC0:OR:((Shifted:SHR:8):AND:0x7) +Byte2 SETA Shifted:AND:0xFF +__ComputedCodes SETS "0x":CC:((:STR:Byte1):RIGHT:2):CC:",0x":CC:((:STR:Byte2):RIGHT:2) + + ELIF Shifted < 0x1000000 +Byte1 SETA ((Shifted:SHR:16):AND:0xFF) +Byte2 SETA ((Shifted:SHR:8):AND:0xFF) +Byte3 SETA (Shifted:AND:0xFF) +__ComputedCodes SETS "0xE0,0x":CC:((:STR:Byte1):RIGHT:2):CC:",0x":CC:((:STR:Byte2):RIGHT:2):CC:",0x":CC:((:STR:Byte3):RIGHT:2) + + ELSE + INFO 1, "$Name too large for unwind code encoding" + ENDIF + + MEND + + + ; + ; Macro for allocating space on the stack in the prolog + ; + + MACRO + PROLOG_STACK_ALLOC $Amount + + __ComputeStackAllocCodes "PROLOG_STACK_ALLOC", $Amount + + __EmitRunningLabelAndOpcode sub sp, sp, #$Amount + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for a single register save operation in a prologue + ; + + MACRO + PROLOG_SAVE_REG $Reg1, $Offset + + IF "$Offset" == "" + INFO 1, "Must specify offset in PROLOG_SAVE_REG" + MEXIT + ENDIF + + __ComputeSaveRegCodes "PROLOG_SAVE_REG", $Reg1, $Offset, "Prolog" + + __EmitRunningLabelAndOpcode str $Reg1, $__ParsedOffsetString + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for an register pair save operation in a prologue + ; + + MACRO + PROLOG_SAVE_REG_PAIR $Reg1, $Reg2, $Offset + + IF "$Offset" == "" + INFO 1, "Must specify offset in PROLOG_SAVE_REG_PAIR" + MEXIT + ENDIF + + __ComputeSaveRegPairCodes "PROLOG_SAVE_REG_PAIR", $Reg1, $Reg2, $Offset, "Prolog" + + IF __RegPairWasFpLr + +#if defined(_CHPE_X86_ARM64_) + + __EmitRunningLabelAndOpcode stp wfp, wlr, $__ParsedOffsetString + +#else + + __EmitRunningLabelAndOpcode stp fp, lr, $__ParsedOffsetString + +#endif + + IF (__ParsedOffsetAbs != 0) && (__ParsedOffsetPreinc == 0) + __EmitRunningLabelAndOpcode add fp, sp, $__ParsedOffsetRawString +__ComputedCodes SETS "0xe2,0x":CC:((:STR:__ParsedOffsetShifted3):RIGHT:2):CC:",":CC:__ComputedCodes + ELSE + + __EmitRunningLabelAndOpcode mov fp, sp +__ComputedCodes SETS "0xe1,":CC:__ComputedCodes + ENDIF + + ELSE + + __EmitRunningLabelAndOpcode stp $Reg1, $Reg2, $__ParsedOffsetString + + ENDIF + + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Same as above but don't treat FP specially + ; + + MACRO + PROLOG_SAVE_REG_PAIR_NO_FP $Reg1, $Reg2, $Offset + + IF "$Offset" == "" + INFO 1, "Must specify offset in PROLOG_SAVE_REG_PAIR" + MEXIT + ENDIF + + __ComputeSaveRegPairCodes "PROLOG_SAVE_REG_PAIR", $Reg1, $Reg2, $Offset, "Prolog" + + IF __RegPairWasFpLr + +#if defined(_CHPE_X86_ARM64_) + + __EmitRunningLabelAndOpcode stp wfp, wlr, $__ParsedOffsetString + +#else + + __EmitRunningLabelAndOpcode stp fp, lr, $__ParsedOffsetString + +#endif + + ELSE + + __EmitRunningLabelAndOpcode stp $Reg1, $Reg2, $__ParsedOffsetString + + ENDIF + + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for including an arbitrary operation in the prolog + ; + + MACRO + PROLOG_NOP $O1,$O2,$O3,$O4 + +__ComputedCodes SETS "0xE3" + + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4 + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for saving the next pair of registers + ; + + MACRO + PROLOG_SAVE_NEXT_PAIR $O1,$O2,$O3,$O4 + +__ComputedCodes SETS "0xE6" + + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4 + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for indicating a trap frame lives above us + ; + + MACRO + PROLOG_PUSH_TRAP_FRAME + __DeclarePrologEnd + +__ComputedCodes SETS "0xE8" + __AppendPrologCodes + + MEND + + + ; + ; Macro for indicating a machine frame lives above us + ; + + MACRO + PROLOG_PUSH_MACHINE_FRAME + __DeclarePrologEnd + +__ComputedCodes SETS "0xE9" + __AppendPrologCodes + + MEND + + + ; + ; Macro for indicating a ARM64_NT_CONTEXT lives above us + ; + + MACRO + PROLOG_PUSH_CONTEXT + __DeclarePrologEnd + +__ComputedCodes SETS "0xEA" + __AppendPrologCodes + + MEND + + + ; + ; Macro for indicating a ARM64EC_NT_CONTEXT lives above us + ; + + MACRO + PROLOG_PUSH_EC_CONTEXT + __DeclarePrologEnd + +__ComputedCodes SETS "0xEB" + __AppendPrologCodes + + MEND + + + ; + ; Macro for signing the return address in the prolog + ; + + MACRO + PROLOG_SIGN_RETURN_ADDRESS + +__ComputedCodes SETS "0xFC" + + __EmitRunningLabelAndOpcode pacibsp + __DeclarePrologEnd + __AppendPrologCodes + + MEND + + + ; + ; Macro for restoring the stack pointer. + ; + + MACRO + EPILOG_STACK_RESTORE + +__ComputedCodes SETS "0xE1" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode mov sp, fp + __AppendEpilogCodes + + MEND + + + ; + ; Macro for deallocating space on the stack in the prolog + ; + + MACRO + EPILOG_STACK_FREE $Amount + + __ComputeStackAllocCodes "EPILOG_STACK_FREE", $Amount + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode add sp, sp, #$Amount + __AppendEpilogCodes + + MEND + + + ; + ; Macro for a single integer register restore operation in an epilogue + ; + + MACRO + EPILOG_RESTORE_REG $Reg1, $Offset + + IF "$Offset" == "" + INFO 1, "Must specify offset in EPILOG_RESTORE_REG" + MEXIT + ENDIF + + __ComputeSaveRegCodes "EPILOG_RESTORE_REG", $Reg1, $Offset, "Epilog" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode ldr $Reg1, $__ParsedOffsetString + __AppendEpilogCodes + + MEND + + + ; + ; Macro for an integer register pair restore operation in an epilogue + ; + + MACRO + EPILOG_RESTORE_REG_PAIR $Reg1, $Reg2, $Offset + + IF "$Offset" == "" + INFO 1, "Must specify offset in EPILOG_RESTORE_REG_PAIR" + MEXIT + ENDIF + + __ComputeSaveRegPairCodes "EPILOG_RESTORE_REG_PAIR", $Reg1, $Reg2, $Offset, "Epilog" + + __DeclareEpilogStart + + IF __RegPairWasFpLr + +#if defined(_CHPE_X86_ARM64_) + + __EmitRunningLabelAndOpcode ldp wfp, wlr, $__ParsedOffsetString + +#else + + __EmitRunningLabelAndOpcode ldp fp, lr, $__ParsedOffsetString + +#endif + + + ELSE + + __EmitRunningLabelAndOpcode ldp $Reg1, $Reg2, $__ParsedOffsetString + + ENDIF + + __AppendEpilogCodes + + MEND + + + ; + ; Macro for including an arbitrary operation in the epilog + ; + + MACRO + EPILOG_NOP $O1,$O2,$O3,$O4 + +__ComputedCodes SETS "0xE3" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4 + __AppendEpilogCodes + + MEND + + + ; + ; Macro for restoring the next pair of registers + ; + + MACRO + EPILOG_RESTORE_NEXT_PAIR $O1,$O2,$O3,$O4 + +__ComputedCodes SETS "0xE6" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4 + __AppendEpilogCodes + + MEND + + + ; + ; Macro for authenticating the return address in the epilog + ; + + MACRO + EPILOG_AUTHENTICATE_RETURN_ADDRESS + +__ComputedCodes SETS "0xFC" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode autibsp + __AppendEpilogCodes + + MEND + + + ; + ; Macro for a bx lr-style return in the epilog + ; + + MACRO + EPILOG_RETURN + +__ComputedCodes SETS "0xE4" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode ret x30 + __AppendEpilogCodes + __DeclareEpilogEnd + + MEND + + + ; + ; Macro for generic end of epilog such as direct + ; (b) or indirect (br) tail calls. + ; + + MACRO + EPILOG_END $O1,$O2,$O3,$O4 + +__ComputedCodes SETS "0xE4" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode $O1,$O2,$O3,$O4 + __AppendEpilogCodes + __DeclareEpilogEnd + + MEND + + + ; + ; Emit an opcode indicating that the unwind address of this function + ; will be at the next instruction after a call rather than the call + ; instruction. An example where this is necessary is the security cookie + ; pop code, which modifies the caller's frame. + ; + + MACRO + EPILOG_RETURN_CLEAR_UNWIND_TO_CALLER + +__ComputedCodes SETS "0xEC, 0XE4" + + __DeclareEpilogStart + __EmitRunningLabelAndOpcode ret x30 + __EmitRunningLabelAndOpcode nop + __AppendEpilogCodes + __DeclareEpilogEnd + + MEND + + ; + ; Macro to reset the internal uwninding states + ; + + MACRO + __ResetUnwindState $ExceptHandler +__PrologUnwindString SETS "" +__EpilogUnwindCount SETA 0 +__Epilog1UnwindString SETS "" +__Epilog2UnwindString SETS "" +__Epilog3UnwindString SETS "" +__Epilog4UnwindString SETS "" +__EpilogStartNotDefined SETL {true} +__FuncExceptionHandler SETS "" + IF "$ExceptHandler" != "" +__FuncExceptionHandler SETS "$ExceptHandler" + + ; + ; Add bars to the exception handler name only when the name does not have bars + ; + + IF ("$ExceptHandler":LEFT:1 != "|") && ("$ExceptHandler":RIGHT:1 != "|") +__FuncExceptionHandler SETS "|$ExceptHandler|" + ENDIF + + ENDIF + MEND + + + ; + ; Macro to emit the xdata for unwinding + ; + + MACRO + __EmitUnwindXData + + LCLA XBit + +XBit SETA 0 + IF "$__FuncExceptionHandler" != "" +XBit SETA 1:SHL:20 + ENDIF + + ; + ; Append terminators where necessary + ; + IF __EpilogUnwindCount >= 1 +__Epilog1UnwindString SETS __Epilog1UnwindString:RIGHT:(:LEN:__Epilog1UnwindString - 1) + IF (:LEN:__Epilog1UnwindString) >= 5 + IF __Epilog1UnwindString:RIGHT:4 < "0xE4" +__Epilog1UnwindString SETS __Epilog1UnwindString:CC:",0xE4" + ENDIF + ENDIF + ENDIF + + IF __EpilogUnwindCount >= 2 +__Epilog2UnwindString SETS __Epilog2UnwindString:RIGHT:(:LEN:__Epilog2UnwindString - 1) + IF (:LEN:__Epilog2UnwindString) >= 5 + IF __Epilog2UnwindString:RIGHT:4 < "0xE4" +__Epilog2UnwindString SETS __Epilog2UnwindString:CC:",0xE4" + ENDIF + ENDIF + ENDIF + + IF __EpilogUnwindCount >= 3 +__Epilog3UnwindString SETS __Epilog3UnwindString:RIGHT:(:LEN:__Epilog3UnwindString - 1) + IF (:LEN:__Epilog3UnwindString) >= 5 + IF __Epilog3UnwindString:RIGHT:4 < "0xE4" +__Epilog3UnwindString SETS __Epilog3UnwindString:CC:",0xE4" + ENDIF + ENDIF + ENDIF + + IF __EpilogUnwindCount >= 4 +__Epilog4UnwindString SETS __Epilog4UnwindString:RIGHT:(:LEN:__Epilog4UnwindString - 1) + IF (:LEN:__Epilog4UnwindString) >= 5 + IF __Epilog4UnwindString:RIGHT:4 < "0xE4" +__Epilog4UnwindString SETS __Epilog4UnwindString:CC:",0xE4" + ENDIF + ENDIF + ENDIF + + IF "$__PrologUnwindString" != "" +__PrologUnwindString SETS __PrologUnwindString:CC:"0xE4" + ELSE +__PrologUnwindString SETS "0xE4" + ENDIF + + ; optimize out the prolog string if it matches +; IF (:LEN:__Epilog1UnwindString) >= 6 +; IF __Epilog1UnwindString:LEFT:(:LEN:__Epilog1UnwindString - 4) == __PrologUnwindString:LEFT:(:LEN:__PrologUnwindString - 4) +;__PrologUnwindString SETS "" +; ENDIF +; ENDIF + + ; + ; Switch to the .xdata section, aligned to a DWORD + ; + + IF __FuncComDat != "" + AREA $__FuncXDataArea,ALIGN=2,READONLY,ASSOC=$__FuncArea + ELSE + AREA $__FuncXDataArea,ALIGN=2,READONLY + ENDIF + + ALIGN 4 + + ; declare the xdata header with unwind code size, epilog count, + ; exception bit, and function length +$__FuncXDataLabel + DCD ((($__FuncXDataEndLabel - $__FuncXDataPrologLabel)/4):SHL:27) :OR: (__EpilogUnwindCount:SHL:22) :OR: XBit :OR: (($__FuncEndLabel - $__FuncStartLabel)/4) + + ; if we have an epilogue, output a single scope record + IF __EpilogUnwindCount >= 1 + DCD (($__FuncXDataEpilog1Label - $__FuncXDataPrologLabel):SHL:22) :OR: (($__FuncEpilog1StartLabel - $__FuncStartLabel)/4) + ENDIF + IF __EpilogUnwindCount >= 2 + DCD (($__FuncXDataEpilog2Label - $__FuncXDataPrologLabel):SHL:22) :OR: (($__FuncEpilog2StartLabel - $__FuncStartLabel)/4) + ENDIF + IF __EpilogUnwindCount >= 3 + DCD (($__FuncXDataEpilog3Label - $__FuncXDataPrologLabel):SHL:22) :OR: (($__FuncEpilog3StartLabel - $__FuncStartLabel)/4) + ENDIF + IF __EpilogUnwindCount >= 4 + DCD (($__FuncXDataEpilog4Label - $__FuncXDataPrologLabel):SHL:22) :OR: (($__FuncEpilog4StartLabel - $__FuncStartLabel)/4) + ENDIF + + ; output the prolog unwind string +$__FuncXDataPrologLabel + DCB $__PrologUnwindString + + ; if we have an epilogue, output the epilog unwind codes + IF __EpilogUnwindCount >= 1 +$__FuncXDataEpilog1Label + DCB $__Epilog1UnwindString + ENDIF + IF __EpilogUnwindCount >= 2 +$__FuncXDataEpilog2Label + DCB $__Epilog2UnwindString + ENDIF + IF __EpilogUnwindCount >= 3 +$__FuncXDataEpilog3Label + DCB $__Epilog3UnwindString + ENDIF + IF __EpilogUnwindCount >= 4 +$__FuncXDataEpilog4Label + DCB $__Epilog4UnwindString + ENDIF + + ALIGN 4 +$__FuncXDataEndLabel + + ; output the exception handler information + IF "$__FuncExceptionHandler" != "" + DCD $__FuncExceptionHandler + RELOC 2 ; make this relative to image base + DCD 0 ; append a 0 for the data (keeps Vulcan happy) + ENDIF + + ; switch back to the original area + AREA $__FuncArea,CODE,READONLY + + MEND diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lamp.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lamp.h new file mode 100644 index 0000000000000000000000000000000000000000..8cf3c0229f5269b7c0be6f847409bd5d0df8202b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lamp.h @@ -0,0 +1,152 @@ +/*++ + + Copyright (c) Microsoft Corporation. All rights reserved. + + Module Name: + + lamp.h + + Abstract: + + Defines the IOCTL interface to a lamp device. + + Environment: + + Kernel and user modes + +--*/ + +#ifndef _LAMP_H +#define _LAMP_H + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// The device interface class GUID for a lamp device. +DEFINE_GUID(GUID_DEVINTERFACE_LAMP, + 0x6c11e9e3, 0x8238, 0x4f0a, 0x0a, 0x19, 0xaa, 0xec, 0x26, 0xca, 0x5e, 0x98); + +// The string literal for constructing the reference string of the lamp device interface. +#define LAMP_DEVICE_SUFFIX L"Lamp" + +// The PnP event which indicates the hardware resources previously assigned to a +// lamp device have been reassigned to support other activities. +DEFINE_GUID(GUID_LAMP_RESOURCES_LOST, + 0xf770e98c, 0x4403, 0x48c9, 0xb1, 0xd2, 0x4e, 0xec, 0x33, 0x02, 0xe4, 0x1f); + +// The PnP event which indicates the hardware resources previously lost have +// become available to the lamp device again. +DEFINE_GUID(GUID_LAMP_RESOURCES_AVAILABLE, + 0x185fe7ce, 0x2616, 0x481b, 0x90, 0x94, 0x20, 0xbb, 0x89, 0x3a, 0xcd, 0x81); + +// +// IOCTL codes +// + +#define IOCTL_LAMP_BASE FILE_DEVICE_UNKNOWN + +// IOCTL_LAMP_GET_CAPABILITIES_{WHITE|COLOR} + +// Gets the capabilities if the device can emit white light. +// I/O parameter type: LAMP_CAPABILITIES_WHITE +#define IOCTL_LAMP_GET_CAPABILITIES_WHITE \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0000, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Gets the capabilities if the device can emit color light. +// I/O parameter type: LAMP_CAPABILITIES_COLOR +#define IOCTL_LAMP_GET_CAPABILITIES_COLOR \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0001, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// IOCTL_LAMP_{GET|SET}_MODE + +// Gets the operating mode (i.e. white-vs-color light) with which the device is currently configured. +// I/O parameter type: LAMP_MODE +#define IOCTL_LAMP_GET_MODE \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0002, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Sets the operating mode. +// I/O parameter type: LAMP_MODE +#define IOCTL_LAMP_SET_MODE \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0003, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// IOCTL_LAMP_{GET|SET}_INTENSITY_{WHITE|COLOR} + +// Gets the current light intensity if the device is configured to emit white light. +// I/O parameter type: LAMP_INTENSITY_WHITE +#define IOCTL_LAMP_GET_INTENSITY_WHITE \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0004, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Sets the white light intensity. +// I/O parameter type: LAMP_INTENSITY_WHITE +#define IOCTL_LAMP_SET_INTENSITY_WHITE \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0005, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Gets the current light intensity if the device is configured to emit color light. +// I/O parameter type: LAMP_INTENSITY_COLOR +#define IOCTL_LAMP_GET_INTENSITY_COLOR \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0006, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Sets the color light intensity. +// I/O parameter type: LAMP_INTENSITY_COLOR +#define IOCTL_LAMP_SET_INTENSITY_COLOR \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0007, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// IOCTL_LAMP_{GET|SET}_EMITTING_LIGHT + +// Determines if the device is currently emitting light. +// I/O parameter type: BOOLEAN +#define IOCTL_LAMP_GET_EMITTING_LIGHT \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0008, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Toggle the device to start/stop emitting light. +// I/O parameter type: BOOLEAN +#define IOCTL_LAMP_SET_EMITTING_LIGHT \ + CTL_CODE(IOCTL_LAMP_BASE, 0x0009, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// The operating mode of a lamp device. +// This is the I/O parameter type of IOCTL_LAMP_{GET|SET}_MODE. +typedef enum LAMP_MODE +{ + LAMP_MODE_WHITE = 0, // (Required) White light only + LAMP_MODE_COLOR // (Optional) Color light +} LAMP_MODE; + +// The I/O parameter type of IOCTL_LAMP_GET_CAPABILITIES_WHITE. +typedef struct LAMP_CAPABILITIES_WHITE +{ + BOOLEAN IsLightIntensityAdjustable; + // If this field evaluates true, a client can get/set light + // intensity by calling IOCTL_LAMP_{GET|SET}_INTENSITY_WHITE. +} LAMP_CAPABILITIES_WHITE; + +// The I/O parameter type of IOCTL_LAMP_GET_CAPABILITIES_COLOR. +typedef struct LAMP_CAPABILITIES_COLOR +{ + BOOLEAN IsSupported; // True if the device can emit color light; false otherwise. + BOOLEAN IsLightIntensityAdjustable; + // If IsSupported evaluates true (i.e. the driver is capable + // of emitting color light) and this field evaluates true, a + // client can get/set light intensity of a color lamp by + // calling IOCTL_LAMP_{GET|SET}_INTENSITY_COLOR. +} LAMP_CAPABILITIES_COLOR; + +// The I/O parameter type of IOCTL_LAMP_{GET|SET}_INTENSITY_WHITE. +typedef struct LAMP_INTENSITY_WHITE +{ + BYTE Value; // White light intensity in percentage (0-100) +} LAMP_INTENSITY_WHITE; + +// The I/O parameter type of IOCTL_LAMP_{GET|SET}_INTENSITY_COLOR. +typedef struct LAMP_INTENSITY_COLOR +{ + BYTE Red; // Red light intensity in percentage (0-100) + BYTE Green; // Green light intensity in percentage (0-100) + BYTE Blue; // Blue light intensity in percentage (0-100) +} LAMP_INTENSITY_COLOR; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _LAMP_H diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmcons.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmcons.h new file mode 100644 index 0000000000000000000000000000000000000000..06056d32440cfaa8a147ef665ac198cae495de77 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmcons.h @@ -0,0 +1,279 @@ +/*++ BUILD Version: 0003 // Increment this if a change has global effects + +Copyright (c) 1990-1999 Microsoft Corporation + + + LMCONS.H (was NETCONS.H in LM 2.x) + +Abstract: + + This file contains constants used throughout the LAN Manager + API header files. It should be included in any source file + that is going to include other LAN Manager API header files or + call a LAN Manager API. + + NOTE: Lengths of strings are given as the maximum lengths of the + string in characters (not bytes). This does not include space for the + terminating 0-characters. When allocating space for such an item, + use the form: + + TCHAR username[UNLEN+1]; + + Definitions of the form LN20_* define those values in effect for + LanMan 2.0. + + + +--*/ + +/*NOINC*/ +#ifndef NETCONS_INCLUDED + +#define NETCONS_INCLUDED +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +/*INC*/ + +#ifndef PASCAL +#define PASCAL // pascal on OS/2 +#endif + +#ifndef FAR +#define FAR // far on OS/2 +#endif + +// +// String Lengths for various LanMan names +// + +#define CNLEN 15 // Computer name length +#define LM20_CNLEN 15 // LM 2.0 Computer name length +#define DNLEN CNLEN // Maximum domain name length +#define LM20_DNLEN LM20_CNLEN // LM 2.0 Maximum domain name length + +#if (CNLEN != DNLEN) +#error CNLEN and DNLEN are not equal +#endif + +#define UNCLEN (CNLEN+2) // UNC computer name length +#define LM20_UNCLEN (LM20_CNLEN+2) // LM 2.0 UNC computer name length + +#define NNLEN 80 // Net name length (share name) +#define LM20_NNLEN 12 // LM 2.0 Net name length + +#define RMLEN (UNCLEN+1+NNLEN) // Max remote name length +#define LM20_RMLEN (LM20_UNCLEN+1+LM20_NNLEN) // LM 2.0 Max remote name length + +#define SNLEN 80 // Service name length +#define LM20_SNLEN 15 // LM 2.0 Service name length +#define STXTLEN 256 // Service text length +#define LM20_STXTLEN 63 // LM 2.0 Service text length + +#define PATHLEN 256 // Max. path (not including drive name) +#define LM20_PATHLEN 256 // LM 2.0 Max. path + +#define DEVLEN 80 // Device name length +#define LM20_DEVLEN 8 // LM 2.0 Device name length + +#define EVLEN 16 // Event name length + +// +// User, Group and Password lengths +// + +#define UNLEN 256 // Maximum user name length +#define LM20_UNLEN 20 // LM 2.0 Maximum user name length + +#define GNLEN UNLEN // Group name +#define LM20_GNLEN LM20_UNLEN // LM 2.0 Group name + +#define PWLEN 256 // Maximum password length +#define LM20_PWLEN 14 // LM 2.0 Maximum password length + +#define SHPWLEN 8 // Share password length (bytes) + + +#define CLTYPE_LEN 12 // Length of client type string + + +#define MAXCOMMENTSZ 256 // Multipurpose comment length +#define LM20_MAXCOMMENTSZ 48 // LM 2.0 Multipurpose comment length + +#define QNLEN NNLEN // Queue name maximum length +#define LM20_QNLEN LM20_NNLEN // LM 2.0 Queue name maximum length +#if (QNLEN != NNLEN) +# error QNLEN and NNLEN are not equal +#endif + +// +// The ALERTSZ and MAXDEVENTRIES defines have not yet been NT'ized. +// Whoever ports these components should change these values appropriately. +// + +#define ALERTSZ 128 // size of alert string in server +#define MAXDEVENTRIES (sizeof (int)*8) // Max number of device entries + + // + // We use int bitmap to represent + // + +#define NETBIOS_NAME_LEN 16 // NetBIOS net name (bytes) + +// +// Value to be used with APIs which have a "preferred maximum length" +// parameter. This value indicates that the API should just allocate +// "as much as it takes." +// + +#define MAX_PREFERRED_LENGTH ((DWORD) -1) + +// +// Moral equivalent of DNS_MAX_NAME_LENGTH in windnsdef.h. +// +#define LM_DNS_MAX_NAME_LENGTH 255 + +// +// Constants used with encryption +// + +#define CRYPT_KEY_LEN 7 +#define CRYPT_TXT_LEN 8 +#define ENCRYPTED_PWLEN 16 +#define SESSION_PWLEN 24 +#define SESSION_CRYPT_KLEN 21 + +// +// Value to be used with SetInfo calls to allow setting of all +// settable parameters (parmnum zero option) +// +#ifndef PARMNUM_ALL +#define PARMNUM_ALL 0 +#endif + +#define PARM_ERROR_UNKNOWN ( (DWORD) (-1) ) +#define PARM_ERROR_NONE 0 +#define PARMNUM_BASE_INFOLEVEL 1000 + +// +// Only the UNICODE version of the LM APIs are available on NT. +// Non-UNICODE version on other platforms +// +#if defined( _WIN32_WINNT ) || defined( WINNT ) || defined( __midl ) \ + || defined( FORCE_UNICODE ) +#define LMSTR LPWSTR +#define LMCSTR LPCWSTR +#else +#define LMSTR LPSTR +#define LMCSTR LPCSTR +#endif + +// +// Message File Names +// + +#define MESSAGE_FILENAME TEXT("NETMSG") +#define OS2MSG_FILENAME TEXT("BASE") +#define HELP_MSG_FILENAME TEXT("NETH") + +/**INTERNAL_ONLY**/ + +// The backup message file named here is a duplicate of net.msg. It +// is not shipped with the product, but is used at buildtime to +// msgbind certain messages to netapi.dll and some of the services. +// This allows for OEMs to modify the message text in net.msg and +// have those changes show up. Only in case there is an error in +// retrieving the messages from net.msg do we then get the bound +// messages out of bak.msg (really out of the message segment). + +#define BACKUP_MSG_FILENAME TEXT("BAK.MSG") + +/**END_INTERNAL**/ + +#ifndef NULL +#ifdef __cplusplus +#define NULL 0 +#else +#define NULL ((void *)0) +#endif +#endif + +// Define pseudo-keywords. +#ifndef IN +#define IN +#endif + +#ifndef OPTIONAL +#define OPTIONAL +#endif + +#ifndef OUT +#define OUT +#endif +/*INC*/ + + + +// +// The platform ID indicates the levels to use for platform-specific +// information. +// + +#define PLATFORM_ID_DOS 300 +#define PLATFORM_ID_OS2 400 +#define PLATFORM_ID_NT 500 +#define PLATFORM_ID_OSF 600 +#define PLATFORM_ID_VMS 700 + +// +// There message numbers assigned to different LANMAN components +// are as defined below. +// +// lmerr.h: 2100 - 2999 NERR_BASE +// alertmsg.h: 3000 - 3049 ALERT_BASE +// lmsvc.h: 3050 - 3099 SERVICE_BASE +// lmerrlog.h: 3100 - 3299 ERRLOG_BASE +// msgtext.h: 3300 - 3499 MTXT_BASE +// apperr.h: 3500 - 3999 APPERR_BASE +// apperrfs.h: 4000 - 4299 APPERRFS_BASE +// apperr2.h: 4300 - 5299 APPERR2_BASE +// ncberr.h: 5300 - 5499 NRCERR_BASE +// alertmsg.h: 5500 - 5599 ALERT2_BASE +// lmsvc.h: 5600 - 5699 SERVICE2_BASE +// lmerrlog.h 5700 - 5899 ERRLOG2_BASE +// + +#define MIN_LANMAN_MESSAGE_ID NERR_BASE +#define MAX_LANMAN_MESSAGE_ID 5899 + +/*NOINC*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or App Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +// +// Keywords used in Function Prototypes +// + +#define NET_API_STATUS DWORD +#define API_RET_TYPE NET_API_STATUS // Old value: do not use +#if (_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED) +#define NET_API_FUNCTION __stdcall +#else +#define NET_API_FUNCTION +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // NETCONS_INCLUDED +/*INC*/ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmerr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmerr.h new file mode 100644 index 0000000000000000000000000000000000000000..8656a522ff019d08e8fea97a4398189fe3797a80 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/lmerr.h @@ -0,0 +1,668 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects +*/ +/********************************************************************/ +/** Microsoft LAN Manager **/ +/** Copyright(c) Microsoft Corp., 1987-1999 **/ +/********************************************************************/ + +/*** lmerr.h - network error definitions + * + */ + + +/**INTERNAL_ONLY**/ + +/***********WARNING **************** + *See the comment in lmcons.h for * + *info on the allocation of errors * + ***********************************/ + +/**END_INTERNAL**/ + +/*NOINC*/ +#ifndef NETERR_INCLUDED +#define NETERR_INCLUDED + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/*INC*/ + + +#define NERR_Success 0 /* Success */ + +// ERROR_ equates can be intermixed with NERR_ equates. +#include + + + +/*** NERR_BASE is the base of error codes from network utilities, + * chosen to avoid conflict with system and redirector error codes. + * 2100 is a value that has been assigned to us by system. + */ +#define NERR_BASE 2100 + + +/**INTERNAL_ONLY**/ + +/***********WARNING **************** + *See the comment in lmcons.h for * + *info on the allocation of errors * + ***********************************/ + +/***********WARNING **************** + *The range 2750-2799 has been * + *allocated to the IBM LAN Server * + ***********************************/ + +/***********WARNING **************** + *The range 2900-2999 has been * + *reserved for Microsoft OEMs * + ***********************************/ + +/**END_INTERNAL**/ + +/* UNUSED BASE+0 */ +/* UNUSED BASE+1 */ +#define NERR_NetNotStarted (NERR_BASE+2) /* The workstation driver is not installed. */ +#define NERR_UnknownServer (NERR_BASE+3) /* The server could not be located. */ +#define NERR_ShareMem (NERR_BASE+4) /* An internal error occurred. The network cannot access a shared memory segment. */ + +#define NERR_NoNetworkResource (NERR_BASE+5) /* A network resource shortage occurred . */ +#define NERR_RemoteOnly (NERR_BASE+6) /* This operation is not supported on workstations. */ +#define NERR_DevNotRedirected (NERR_BASE+7) /* The device is not connected. */ +/* NERR_BASE+8 is used for ERROR_CONNECTED_OTHER_PASSWORD */ +/* NERR_BASE+9 is used for ERROR_CONNECTED_OTHER_PASSWORD_DEFAULT */ +/* UNUSED BASE+10 */ +/* UNUSED BASE+11 */ +/* UNUSED BASE+12 */ +/* UNUSED BASE+13 */ +#define NERR_ServerNotStarted (NERR_BASE+14) /* The Server service is not started. */ +#define NERR_ItemNotFound (NERR_BASE+15) /* The queue is empty. */ +#define NERR_UnknownDevDir (NERR_BASE+16) /* The device or directory does not exist. */ +#define NERR_RedirectedPath (NERR_BASE+17) /* The operation is invalid on a redirected resource. */ +#define NERR_DuplicateShare (NERR_BASE+18) /* The name has already been shared. */ +#define NERR_NoRoom (NERR_BASE+19) /* The server is currently out of the requested resource. */ +/* UNUSED BASE+20 */ +#define NERR_TooManyItems (NERR_BASE+21) /* Requested addition of items exceeds the maximum allowed. */ +#define NERR_InvalidMaxUsers (NERR_BASE+22) /* The Peer service supports only two simultaneous users. */ +#define NERR_BufTooSmall (NERR_BASE+23) /* The API return buffer is too small. */ +/* UNUSED BASE+24 */ +/* UNUSED BASE+25 */ +/* UNUSED BASE+26 */ +#define NERR_RemoteErr (NERR_BASE+27) /* A remote API error occurred. */ +/* UNUSED BASE+28 */ +/* UNUSED BASE+29 */ +/* UNUSED BASE+30 */ +#define NERR_LanmanIniError (NERR_BASE+31) /* An error occurred when opening or reading the configuration file. */ +/* UNUSED BASE+32 */ +/* UNUSED BASE+33 */ +/* UNUSED BASE+34 */ +/* UNUSED BASE+35 */ +#define NERR_NetworkError (NERR_BASE+36) /* A general network error occurred. */ +#define NERR_WkstaInconsistentState (NERR_BASE+37) + /* The Workstation service is in an inconsistent state. Restart the computer before restarting the Workstation service. */ +#define NERR_WkstaNotStarted (NERR_BASE+38) /* The Workstation service has not been started. */ +#define NERR_BrowserNotStarted (NERR_BASE+39) /* The requested information is not available. */ +#define NERR_InternalError (NERR_BASE+40) /* An internal Windows error occurred.*/ +#define NERR_BadTransactConfig (NERR_BASE+41) /* The server is not configured for transactions. */ +#define NERR_InvalidAPI (NERR_BASE+42) /* The requested API is not supported on the remote server. */ +#define NERR_BadEventName (NERR_BASE+43) /* The event name is invalid. */ +#define NERR_DupNameReboot (NERR_BASE+44) /* The computer name already exists on the network. Change it and restart the computer. */ +/* + * Config API related + * Error codes from BASE+45 to BASE+49 + */ + +/* UNUSED BASE+45 */ +#define NERR_CfgCompNotFound (NERR_BASE+46) /* The specified component could not be found in the configuration information. */ +#define NERR_CfgParamNotFound (NERR_BASE+47) /* The specified parameter could not be found in the configuration information. */ +#define NERR_LineTooLong (NERR_BASE+49) /* A line in the configuration file is too long. */ + +/* + * Spooler API related + * Error codes from BASE+50 to BASE+79 + */ + +#define NERR_QNotFound (NERR_BASE+50) /* The printer does not exist. */ +#define NERR_JobNotFound (NERR_BASE+51) /* The print job does not exist. */ +#define NERR_DestNotFound (NERR_BASE+52) /* The printer destination cannot be found. */ +#define NERR_DestExists (NERR_BASE+53) /* The printer destination already exists. */ +#define NERR_QExists (NERR_BASE+54) /* The printer queue already exists. */ +#define NERR_QNoRoom (NERR_BASE+55) /* No more printers can be added. */ +#define NERR_JobNoRoom (NERR_BASE+56) /* No more print jobs can be added. */ +#define NERR_DestNoRoom (NERR_BASE+57) /* No more printer destinations can be added. */ +#define NERR_DestIdle (NERR_BASE+58) /* This printer destination is idle and cannot accept control operations. */ +#define NERR_DestInvalidOp (NERR_BASE+59) /* This printer destination request contains an invalid control function. */ +#define NERR_ProcNoRespond (NERR_BASE+60) /* The print processor is not responding. */ +#define NERR_SpoolerNotLoaded (NERR_BASE+61) /* The spooler is not running. */ +#define NERR_DestInvalidState (NERR_BASE+62) /* This operation cannot be performed on the print destination in its current state. */ +#define NERR_QInvalidState (NERR_BASE+63) /* This operation cannot be performed on the printer queue in its current state. */ +#define NERR_JobInvalidState (NERR_BASE+64) /* This operation cannot be performed on the print job in its current state. */ +#define NERR_SpoolNoMemory (NERR_BASE+65) /* A spooler memory allocation failure occurred. */ +#define NERR_DriverNotFound (NERR_BASE+66) /* The device driver does not exist. */ +#define NERR_DataTypeInvalid (NERR_BASE+67) /* The data type is not supported by the print processor. */ +#define NERR_ProcNotFound (NERR_BASE+68) /* The print processor is not installed. */ + +/* + * Service API related + * Error codes from BASE+80 to BASE+99 + */ + +#define NERR_ServiceTableLocked (NERR_BASE+80) /* The service database is locked. */ +#define NERR_ServiceTableFull (NERR_BASE+81) /* The service table is full. */ +#define NERR_ServiceInstalled (NERR_BASE+82) /* The requested service has already been started. */ +#define NERR_ServiceEntryLocked (NERR_BASE+83) /* The service does not respond to control actions. */ +#define NERR_ServiceNotInstalled (NERR_BASE+84) /* The service has not been started. */ +#define NERR_BadServiceName (NERR_BASE+85) /* The service name is invalid. */ +#define NERR_ServiceCtlTimeout (NERR_BASE+86) /* The service is not responding to the control function. */ +#define NERR_ServiceCtlBusy (NERR_BASE+87) /* The service control is busy. */ +#define NERR_BadServiceProgName (NERR_BASE+88) /* The configuration file contains an invalid service program name. */ +#define NERR_ServiceNotCtrl (NERR_BASE+89) /* The service could not be controlled in its present state. */ +#define NERR_ServiceKillProc (NERR_BASE+90) /* The service ended abnormally. */ +#define NERR_ServiceCtlNotValid (NERR_BASE+91) /* The requested pause, continue, or stop is not valid for this service. */ +#define NERR_NotInDispatchTbl (NERR_BASE+92) /* The service control dispatcher could not find the service name in the dispatch table. */ +#define NERR_BadControlRecv (NERR_BASE+93) /* The service control dispatcher pipe read failed. */ +#define NERR_ServiceNotStarting (NERR_BASE+94) /* A thread for the new service could not be created. */ + +/* + * Wksta and Logon API related + * Error codes from BASE+100 to BASE+118 + */ + +#define NERR_AlreadyLoggedOn (NERR_BASE+100) /* This workstation is already logged on to the local-area network. */ +#define NERR_NotLoggedOn (NERR_BASE+101) /* The workstation is not logged on to the local-area network. */ +#define NERR_BadUsername (NERR_BASE+102) /* The user name or group name parameter is invalid. */ +#define NERR_BadPassword (NERR_BASE+103) /* The password parameter is invalid. */ +#define NERR_UnableToAddName_W (NERR_BASE+104) /* @W The logon processor did not add the message alias. */ +#define NERR_UnableToAddName_F (NERR_BASE+105) /* The logon processor did not add the message alias. */ +#define NERR_UnableToDelName_W (NERR_BASE+106) /* @W The logoff processor did not delete the message alias. */ +#define NERR_UnableToDelName_F (NERR_BASE+107) /* The logoff processor did not delete the message alias. */ +/* UNUSED BASE+108 */ +#define NERR_LogonsPaused (NERR_BASE+109) /* Network logons are paused. */ +#define NERR_LogonServerConflict (NERR_BASE+110)/* A centralized logon-server conflict occurred. */ +#define NERR_LogonNoUserPath (NERR_BASE+111) /* The server is configured without a valid user path. */ +#define NERR_LogonScriptError (NERR_BASE+112) /* An error occurred while loading or running the logon script. */ +/* UNUSED BASE+113 */ +#define NERR_StandaloneLogon (NERR_BASE+114) /* The logon server was not specified. Your computer will be logged on as STANDALONE. */ +#define NERR_LogonServerNotFound (NERR_BASE+115) /* The logon server could not be found. */ +#define NERR_LogonDomainExists (NERR_BASE+116) /* There is already a logon domain for this computer. */ +#define NERR_NonValidatedLogon (NERR_BASE+117) /* The logon server could not validate the logon. */ + +/* + * ACF API related (access, user, group) + * Error codes from BASE+119 to BASE+149 + */ + +#define NERR_ACFNotFound (NERR_BASE+119) /* The security database could not be found. */ +#define NERR_GroupNotFound (NERR_BASE+120) /* The group name could not be found. */ +#define NERR_UserNotFound (NERR_BASE+121) /* The user name could not be found. */ +#define NERR_ResourceNotFound (NERR_BASE+122) /* The resource name could not be found. */ +#define NERR_GroupExists (NERR_BASE+123) /* The group already exists. */ +#define NERR_UserExists (NERR_BASE+124) /* The account already exists. */ +#define NERR_ResourceExists (NERR_BASE+125) /* The resource permission list already exists. */ +#define NERR_NotPrimary (NERR_BASE+126) /* This operation is only allowed on the primary domain controller of the domain. */ +#define NERR_ACFNotLoaded (NERR_BASE+127) /* The security database has not been started. */ +#define NERR_ACFNoRoom (NERR_BASE+128) /* There are too many names in the user accounts database. */ +#define NERR_ACFFileIOFail (NERR_BASE+129) /* A disk I/O failure occurred.*/ +#define NERR_ACFTooManyLists (NERR_BASE+130) /* The limit of 64 entries per resource was exceeded. */ +#define NERR_UserLogon (NERR_BASE+131) /* Deleting a user with a session is not allowed. */ +#define NERR_ACFNoParent (NERR_BASE+132) /* The parent directory could not be located. */ +#define NERR_CanNotGrowSegment (NERR_BASE+133) /* Unable to add to the security database session cache segment. */ +#define NERR_SpeGroupOp (NERR_BASE+134) /* This operation is not allowed on this special group. */ +#define NERR_NotInCache (NERR_BASE+135) /* This user is not cached in user accounts database session cache. */ +#define NERR_UserInGroup (NERR_BASE+136) /* The user already belongs to this group. */ +#define NERR_UserNotInGroup (NERR_BASE+137) /* The user does not belong to this group. */ +#define NERR_AccountUndefined (NERR_BASE+138) /* This user account is undefined. */ +#define NERR_AccountExpired (NERR_BASE+139) /* This user account has expired. */ +#define NERR_InvalidWorkstation (NERR_BASE+140) /* The user is not allowed to log on from this workstation. */ +#define NERR_InvalidLogonHours (NERR_BASE+141) /* The user is not allowed to log on at this time. */ +#define NERR_PasswordExpired (NERR_BASE+142) /* The password of this user has expired. */ +#define NERR_PasswordCantChange (NERR_BASE+143) /* The password of this user cannot change. */ +#define NERR_PasswordHistConflict (NERR_BASE+144) /* This password cannot be used now. */ +#define NERR_PasswordTooShort (NERR_BASE+145) /* The password does not meet the password policy requirements. Check the minimum password length, password complexity and password history requirements. */ +#define NERR_PasswordTooRecent (NERR_BASE+146) /* The password of this user is too recent to change. */ +#define NERR_InvalidDatabase (NERR_BASE+147) /* The security database is corrupted. */ +#define NERR_DatabaseUpToDate (NERR_BASE+148) /* No updates are necessary to this replicant network/local security database. */ +#define NERR_SyncRequired (NERR_BASE+149) /* This replicant database is outdated; synchronization is required. */ + +/* + * Use API related + * Error codes from BASE+150 to BASE+169 + */ + +#define NERR_UseNotFound (NERR_BASE+150) /* The network connection could not be found. */ +#define NERR_BadAsgType (NERR_BASE+151) /* This asg_type is invalid. */ +#define NERR_DeviceIsShared (NERR_BASE+152) /* This device is currently being shared. */ +#define NERR_SameAsComputerName (NERR_BASE+153) /* The user name may not be same as computer name. */ + + +/* + * Message Server related + * Error codes BASE+170 to BASE+209 + */ + +#define NERR_NoComputerName (NERR_BASE+170) /* The computer name could not be added as a message alias. The name may already exist on the network. */ +#define NERR_MsgAlreadyStarted (NERR_BASE+171) /* The Messenger service is already started. */ +#define NERR_MsgInitFailed (NERR_BASE+172) /* The Messenger service failed to start. */ +#define NERR_NameNotFound (NERR_BASE+173) /* The message alias could not be found on the network. */ +#define NERR_AlreadyForwarded (NERR_BASE+174) /* This message alias has already been forwarded. */ +#define NERR_AddForwarded (NERR_BASE+175) /* This message alias has been added but is still forwarded. */ +#define NERR_AlreadyExists (NERR_BASE+176) /* This message alias already exists locally. */ +#define NERR_TooManyNames (NERR_BASE+177) /* The maximum number of added message aliases has been exceeded. */ +#define NERR_DelComputerName (NERR_BASE+178) /* The computer name could not be deleted.*/ +#define NERR_LocalForward (NERR_BASE+179) /* Messages cannot be forwarded back to the same workstation. */ +#define NERR_GrpMsgProcessor (NERR_BASE+180) /* An error occurred in the domain message processor. */ +#define NERR_PausedRemote (NERR_BASE+181) /* The message was sent, but the recipient has paused the Messenger service. */ +#define NERR_BadReceive (NERR_BASE+182) /* The message was sent but not received. */ +#define NERR_NameInUse (NERR_BASE+183) /* The message alias is currently in use. Try again later. */ +#define NERR_MsgNotStarted (NERR_BASE+184) /* The Messenger service has not been started. */ +#define NERR_NotLocalName (NERR_BASE+185) /* The name is not on the local computer. */ +#define NERR_NoForwardName (NERR_BASE+186) /* The forwarded message alias could not be found on the network. */ +#define NERR_RemoteFull (NERR_BASE+187) /* The message alias table on the remote station is full. */ +#define NERR_NameNotForwarded (NERR_BASE+188) /* Messages for this alias are not currently being forwarded. */ +#define NERR_TruncatedBroadcast (NERR_BASE+189) /* The broadcast message was truncated. */ +#define NERR_InvalidDevice (NERR_BASE+194) /* This is an invalid device name. */ +#define NERR_WriteFault (NERR_BASE+195) /* A write fault occurred. */ +/* UNUSED BASE+196 */ +#define NERR_DuplicateName (NERR_BASE+197) /* A duplicate message alias exists on the network. */ +#define NERR_DeleteLater (NERR_BASE+198) /* @W This message alias will be deleted later. */ +#define NERR_IncompleteDel (NERR_BASE+199) /* The message alias was not successfully deleted from all networks. */ +#define NERR_MultipleNets (NERR_BASE+200) /* This operation is not supported on computers with multiple networks. */ + +/* + * Server API related + * Error codes BASE+210 to BASE+229 + */ + +#define NERR_NetNameNotFound (NERR_BASE+210) /* This shared resource does not exist.*/ +#define NERR_DeviceNotShared (NERR_BASE+211) /* This device is not shared. */ +#define NERR_ClientNameNotFound (NERR_BASE+212) /* A session does not exist with that computer name. */ +#define NERR_FileIdNotFound (NERR_BASE+214) /* There is not an open file with that identification number. */ +#define NERR_ExecFailure (NERR_BASE+215) /* A failure occurred when executing a remote administration command. */ +#define NERR_TmpFile (NERR_BASE+216) /* A failure occurred when opening a remote temporary file. */ +#define NERR_TooMuchData (NERR_BASE+217) /* The data returned from a remote administration command has been truncated to 64K. */ +#define NERR_DeviceShareConflict (NERR_BASE+218) /* This device cannot be shared as both a spooled and a non-spooled resource. */ +#define NERR_BrowserTableIncomplete (NERR_BASE+219) /* The information in the list of servers may be incorrect. */ +#define NERR_NotLocalDomain (NERR_BASE+220) /* The computer is not active in this domain. */ +#define NERR_IsDfsShare (NERR_BASE+221) /* The share must be removed from the Distributed File System before it can be deleted. */ + +/* + * CharDev API related + * Error codes BASE+230 to BASE+249 + */ + +/* UNUSED BASE+230 */ +#define NERR_DevInvalidOpCode (NERR_BASE+231) /* The operation is invalid for this device. */ +#define NERR_DevNotFound (NERR_BASE+232) /* This device cannot be shared. */ +#define NERR_DevNotOpen (NERR_BASE+233) /* This device was not open. */ +#define NERR_BadQueueDevString (NERR_BASE+234) /* This device name list is invalid. */ +#define NERR_BadQueuePriority (NERR_BASE+235) /* The queue priority is invalid. */ +#define NERR_NoCommDevs (NERR_BASE+237) /* There are no shared communication devices. */ +#define NERR_QueueNotFound (NERR_BASE+238) /* The queue you specified does not exist. */ +#define NERR_BadDevString (NERR_BASE+240) /* This list of devices is invalid. */ +#define NERR_BadDev (NERR_BASE+241) /* The requested device is invalid. */ +#define NERR_InUseBySpooler (NERR_BASE+242) /* This device is already in use by the spooler. */ +#define NERR_CommDevInUse (NERR_BASE+243) /* This device is already in use as a communication device. */ + +/* + * NetICanonicalize and NetIType and NetIMakeLMFileName + * NetIListCanon and NetINameCheck + * Error codes BASE+250 to BASE+269 + */ + +#define NERR_InvalidComputer (NERR_BASE+251) /* This computer name is invalid. */ +/* UNUSED BASE+252 */ +/* UNUSED BASE+253 */ +#define NERR_MaxLenExceeded (NERR_BASE+254) /* The string and prefix specified are too long. */ +/* UNUSED BASE+255 */ +#define NERR_BadComponent (NERR_BASE+256) /* This path component is invalid. */ +#define NERR_CantType (NERR_BASE+257) /* Could not determine the type of input. */ +/* UNUSED BASE+258 */ +/* UNUSED BASE+259 */ +#define NERR_TooManyEntries (NERR_BASE+262) /* The buffer for types is not big enough. */ + +/* + * NetProfile + * Error codes BASE+270 to BASE+276 + */ + +#define NERR_ProfileFileTooBig (NERR_BASE+270) /* Profile files cannot exceed 64K. */ +#define NERR_ProfileOffset (NERR_BASE+271) /* The start offset is out of range. */ +#define NERR_ProfileCleanup (NERR_BASE+272) /* The system cannot delete current connections to network resources. */ +#define NERR_ProfileUnknownCmd (NERR_BASE+273) /* The system was unable to parse the command line in this file.*/ +#define NERR_ProfileLoadErr (NERR_BASE+274) /* An error occurred while loading the profile file. */ +#define NERR_ProfileSaveErr (NERR_BASE+275) /* @W Errors occurred while saving the profile file. The profile was partially saved. */ + + +/* + * NetAudit and NetErrorLog + * Error codes BASE+277 to BASE+279 + */ + +#define NERR_LogOverflow (NERR_BASE+277) /* Log file %1 is full. */ +#define NERR_LogFileChanged (NERR_BASE+278) /* This log file has changed between reads. */ +#define NERR_LogFileCorrupt (NERR_BASE+279) /* Log file %1 is corrupt. */ + + +/* + * NetRemote + * Error codes BASE+280 to BASE+299 + */ +#define NERR_SourceIsDir (NERR_BASE+280) /* The source path cannot be a directory. */ +#define NERR_BadSource (NERR_BASE+281) /* The source path is illegal. */ +#define NERR_BadDest (NERR_BASE+282) /* The destination path is illegal. */ +#define NERR_DifferentServers (NERR_BASE+283) /* The source and destination paths are on different servers. */ +/* UNUSED BASE+284 */ +#define NERR_RunSrvPaused (NERR_BASE+285) /* The Run server you requested is paused. */ +/* UNUSED BASE+286 */ +/* UNUSED BASE+287 */ +/* UNUSED BASE+288 */ +#define NERR_ErrCommRunSrv (NERR_BASE+289) /* An error occurred when communicating with a Run server. */ +/* UNUSED BASE+290 */ +#define NERR_ErrorExecingGhost (NERR_BASE+291) /* An error occurred when starting a background process. */ +#define NERR_ShareNotFound (NERR_BASE+292) /* The shared resource you are connected to could not be found.*/ +/* UNUSED BASE+293 */ +/* UNUSED BASE+294 */ + + +/* + * NetWksta.sys (redir) returned error codes. + * + * NERR_BASE + (300-329) + */ + +#define NERR_InvalidLana (NERR_BASE+300) /* The LAN adapter number is invalid. */ +#define NERR_OpenFiles (NERR_BASE+301) /* There are open files on the connection. */ +#define NERR_ActiveConns (NERR_BASE+302) /* Active connections still exist. */ +#define NERR_BadPasswordCore (NERR_BASE+303) /* This share name or password is invalid. */ +#define NERR_DevInUse (NERR_BASE+304) /* The device is being accessed by an active process. */ +#define NERR_LocalDrive (NERR_BASE+305) /* The drive letter is in use locally. */ + +/* + * Alert error codes. + * + * NERR_BASE + (330-339) + */ +#define NERR_AlertExists (NERR_BASE+330) /* The specified client is already registered for the specified event. */ +#define NERR_TooManyAlerts (NERR_BASE+331) /* The alert table is full. */ +#define NERR_NoSuchAlert (NERR_BASE+332) /* An invalid or nonexistent alert name was raised. */ +#define NERR_BadRecipient (NERR_BASE+333) /* The alert recipient is invalid.*/ +#define NERR_AcctLimitExceeded (NERR_BASE+334) /* A user's session with this server has been deleted + * because the user's logon hours are no longer valid. */ + +/* + * Additional Error and Audit log codes. + * + * NERR_BASE +(340-343) + */ +#define NERR_InvalidLogSeek (NERR_BASE+340) /* The log file does not contain the requested record number. */ +/* UNUSED BASE+341 */ +/* UNUSED BASE+342 */ +/* UNUSED BASE+343 */ + +/* + * Additional UAS and NETLOGON codes + * + * NERR_BASE +(350-359) + */ +#define NERR_BadUasConfig (NERR_BASE+350) /* The user accounts database is not configured correctly. */ +#define NERR_InvalidUASOp (NERR_BASE+351) /* This operation is not permitted when the Netlogon service is running. */ +#define NERR_LastAdmin (NERR_BASE+352) /* This operation is not allowed on the last administrative account. */ +#define NERR_DCNotFound (NERR_BASE+353) /* Could not find domain controller for this domain. */ +#define NERR_LogonTrackingError (NERR_BASE+354) /* Could not set logon information for this user. */ +#define NERR_NetlogonNotStarted (NERR_BASE+355) /* The Netlogon service has not been started. */ +#define NERR_CanNotGrowUASFile (NERR_BASE+356) /* Unable to add to the user accounts database. */ +#define NERR_TimeDiffAtDC (NERR_BASE+357) /* This server's clock is not synchronized with the primary domain controller's clock. */ +#define NERR_PasswordMismatch (NERR_BASE+358) /* A password mismatch has been detected. */ + + +/* + * Server Integration error codes. + * + * NERR_BASE +(360-369) + */ +#define NERR_NoSuchServer (NERR_BASE+360) /* The server identification does not specify a valid server. */ +#define NERR_NoSuchSession (NERR_BASE+361) /* The session identification does not specify a valid session. */ +#define NERR_NoSuchConnection (NERR_BASE+362) /* The connection identification does not specify a valid connection. */ +#define NERR_TooManyServers (NERR_BASE+363) /* There is no space for another entry in the table of available servers. */ +#define NERR_TooManySessions (NERR_BASE+364) /* The server has reached the maximum number of sessions it supports. */ +#define NERR_TooManyConnections (NERR_BASE+365) /* The server has reached the maximum number of connections it supports. */ +#define NERR_TooManyFiles (NERR_BASE+366) /* The server cannot open more files because it has reached its maximum number. */ +#define NERR_NoAlternateServers (NERR_BASE+367) /* There are no alternate servers registered on this server. */ +/* UNUSED BASE+368 */ +/* UNUSED BASE+369 */ + +#define NERR_TryDownLevel (NERR_BASE+370) /* Try down-level (remote admin protocol) version of API instead. */ + +/* + * UPS error codes. + * + * NERR_BASE + (380-384) + */ +#define NERR_UPSDriverNotStarted (NERR_BASE+380) /* The UPS driver could not be accessed by the UPS service. */ +#define NERR_UPSInvalidConfig (NERR_BASE+381) /* The UPS service is not configured correctly. */ +#define NERR_UPSInvalidCommPort (NERR_BASE+382) /* The UPS service could not access the specified Comm Port. */ +#define NERR_UPSSignalAsserted (NERR_BASE+383) /* The UPS indicated a line fail or low battery situation. Service not started. */ +#define NERR_UPSShutdownFailed (NERR_BASE+384) /* The UPS service failed to perform a system shut down. */ + +/* + * Remoteboot error codes. + * + * NERR_BASE + (400-419) + * Error codes 400 - 405 are used by RPLBOOT.SYS. + * Error codes 403, 407 - 416 are used by RPLLOADR.COM, + * Error code 417 is the alerter message of REMOTEBOOT (RPLSERVR.EXE). + * Error code 418 is for when REMOTEBOOT can't start + * Error code 419 is for a disallowed 2nd rpl connection + * + */ +#define NERR_BadDosRetCode (NERR_BASE+400) /* The program below returned an MS-DOS error code:*/ +#define NERR_ProgNeedsExtraMem (NERR_BASE+401) /* The program below needs more memory:*/ +#define NERR_BadDosFunction (NERR_BASE+402) /* The program below called an unsupported MS-DOS function:*/ +#define NERR_RemoteBootFailed (NERR_BASE+403) /* The workstation failed to boot.*/ +#define NERR_BadFileCheckSum (NERR_BASE+404) /* The file below is corrupt.*/ +#define NERR_NoRplBootSystem (NERR_BASE+405) /* No loader is specified in the boot-block definition file.*/ +#define NERR_RplLoadrNetBiosErr (NERR_BASE+406) /* NetBIOS returned an error: The NCB and SMB are dumped above.*/ +#define NERR_RplLoadrDiskErr (NERR_BASE+407) /* A disk I/O error occurred.*/ +#define NERR_ImageParamErr (NERR_BASE+408) /* Image parameter substitution failed.*/ +#define NERR_TooManyImageParams (NERR_BASE+409) /* Too many image parameters cross disk sector boundaries.*/ +#define NERR_NonDosFloppyUsed (NERR_BASE+410) /* The image was not generated from an MS-DOS diskette formatted with /S.*/ +#define NERR_RplBootRestart (NERR_BASE+411) /* Remote boot will be restarted later.*/ +#define NERR_RplSrvrCallFailed (NERR_BASE+412) /* The call to the Remoteboot server failed.*/ +#define NERR_CantConnectRplSrvr (NERR_BASE+413) /* Cannot connect to the Remoteboot server.*/ +#define NERR_CantOpenImageFile (NERR_BASE+414) /* Cannot open image file on the Remoteboot server.*/ +#define NERR_CallingRplSrvr (NERR_BASE+415) /* Connecting to the Remoteboot server...*/ +#define NERR_StartingRplBoot (NERR_BASE+416) /* Connecting to the Remoteboot server...*/ +#define NERR_RplBootServiceTerm (NERR_BASE+417) /* Remote boot service was stopped; check the error log for the cause of the problem.*/ +#define NERR_RplBootStartFailed (NERR_BASE+418) /* Remote boot startup failed; check the error log for the cause of the problem.*/ +#define NERR_RPL_CONNECTED (NERR_BASE+419) /* A second connection to a Remoteboot resource is not allowed.*/ + +/* + * FTADMIN API error codes + * + * NERR_BASE + (425-434) + * + * (Currently not used in NT) + * + */ + +/* + * Browser service API error codes + * + * NERR_BASE + (450-475) + * + */ +#define NERR_BrowserConfiguredToNotRun (NERR_BASE+450) /* The browser service was configured with MaintainServerList=No. */ + +/* + * Additional Remoteboot error codes. + * + * NERR_BASE + (510-550) + */ +#define NERR_RplNoAdaptersStarted (NERR_BASE+510) /*Service failed to start since none of the network adapters started with this service.*/ +#define NERR_RplBadRegistry (NERR_BASE+511) /*Service failed to start due to bad startup information in the registry.*/ +#define NERR_RplBadDatabase (NERR_BASE+512) /*Service failed to start because its database is absent or corrupt.*/ +#define NERR_RplRplfilesShare (NERR_BASE+513) /*Service failed to start because RPLFILES share is absent.*/ +#define NERR_RplNotRplServer (NERR_BASE+514) /*Service failed to start because RPLUSER group is absent.*/ +#define NERR_RplCannotEnum (NERR_BASE+515) /*Cannot enumerate service records.*/ +#define NERR_RplWkstaInfoCorrupted (NERR_BASE+516) /*Workstation record information has been corrupted.*/ +#define NERR_RplWkstaNotFound (NERR_BASE+517) /*Workstation record was not found.*/ +#define NERR_RplWkstaNameUnavailable (NERR_BASE+518) /*Workstation name is in use by some other workstation.*/ +#define NERR_RplProfileInfoCorrupted (NERR_BASE+519) /*Profile record information has been corrupted.*/ +#define NERR_RplProfileNotFound (NERR_BASE+520) /*Profile record was not found.*/ +#define NERR_RplProfileNameUnavailable (NERR_BASE+521) /*Profile name is in use by some other profile.*/ +#define NERR_RplProfileNotEmpty (NERR_BASE+522) /*There are workstations using this profile.*/ +#define NERR_RplConfigInfoCorrupted (NERR_BASE+523) /*Configuration record information has been corrupted.*/ +#define NERR_RplConfigNotFound (NERR_BASE+524) /*Configuration record was not found.*/ +#define NERR_RplAdapterInfoCorrupted (NERR_BASE+525) /*Adapter id record information has been corrupted.*/ +#define NERR_RplInternal (NERR_BASE+526) /*An internal service error has occurred.*/ +#define NERR_RplVendorInfoCorrupted (NERR_BASE+527) /*Vendor id record information has been corrupted.*/ +#define NERR_RplBootInfoCorrupted (NERR_BASE+528) /*Boot block record information has been corrupted.*/ +#define NERR_RplWkstaNeedsUserAcct (NERR_BASE+529) /*The user account for this workstation record is missing.*/ +#define NERR_RplNeedsRPLUSERAcct (NERR_BASE+530) /*The RPLUSER local group could not be found.*/ +#define NERR_RplBootNotFound (NERR_BASE+531) /*Boot block record was not found.*/ +#define NERR_RplIncompatibleProfile (NERR_BASE+532) /*Chosen profile is incompatible with this workstation.*/ +#define NERR_RplAdapterNameUnavailable (NERR_BASE+533) /*Chosen network adapter id is in use by some other workstation.*/ +#define NERR_RplConfigNotEmpty (NERR_BASE+534) /*There are profiles using this configuration.*/ +#define NERR_RplBootInUse (NERR_BASE+535) /*There are workstations, profiles or configurations using this boot block.*/ +#define NERR_RplBackupDatabase (NERR_BASE+536) /*Service failed to backup Remoteboot database.*/ +#define NERR_RplAdapterNotFound (NERR_BASE+537) /*Adapter record was not found.*/ +#define NERR_RplVendorNotFound (NERR_BASE+538) /*Vendor record was not found.*/ +#define NERR_RplVendorNameUnavailable (NERR_BASE+539) /*Vendor name is in use by some other vendor record.*/ +#define NERR_RplBootNameUnavailable (NERR_BASE+540) /*(boot name, vendor id) is in use by some other boot block record.*/ +#define NERR_RplConfigNameUnavailable (NERR_BASE+541) /*Configuration name is in use by some other configuration.*/ + +/**INTERNAL_ONLY**/ + +/* + * Dfs API error codes. + * + * NERR_BASE + (560-590) + */ + +#define NERR_DfsInternalCorruption (NERR_BASE+560) /*The internal database maintained by the DFS service is corrupt*/ +#define NERR_DfsVolumeDataCorrupt (NERR_BASE+561) /*One of the records in the internal DFS database is corrupt*/ +#define NERR_DfsNoSuchVolume (NERR_BASE+562) /*There is no DFS name whose entry path matches the input Entry Path*/ +#define NERR_DfsVolumeAlreadyExists (NERR_BASE+563) /*A root or link with the given name already exists*/ +#define NERR_DfsAlreadyShared (NERR_BASE+564) /*The server share specified is already shared in the DFS*/ +#define NERR_DfsNoSuchShare (NERR_BASE+565) /*The indicated server share does not support the indicated DFS namespace*/ +#define NERR_DfsNotALeafVolume (NERR_BASE+566) /*The operation is not valid on this portion of the namespace*/ +#define NERR_DfsLeafVolume (NERR_BASE+567) /*The operation is not valid on this portion of the namespace*/ +#define NERR_DfsVolumeHasMultipleServers (NERR_BASE+568) /*The operation is ambiguous because the link has multiple servers*/ +#define NERR_DfsCantCreateJunctionPoint (NERR_BASE+569) /*Unable to create a link*/ +#define NERR_DfsServerNotDfsAware (NERR_BASE+570) /*The server is not DFS Aware*/ +#define NERR_DfsBadRenamePath (NERR_BASE+571) /*The specified rename target path is invalid*/ +#define NERR_DfsVolumeIsOffline (NERR_BASE+572) /*The specified DFS link is offline*/ +#define NERR_DfsNoSuchServer (NERR_BASE+573) /*The specified server is not a server for this link*/ +#define NERR_DfsCyclicalName (NERR_BASE+574) /*A cycle in the DFS name was detected*/ +#define NERR_DfsNotSupportedInServerDfs (NERR_BASE+575) /*The operation is not supported on a server-based DFS*/ +#define NERR_DfsDuplicateService (NERR_BASE+576) /*This link is already supported by the specified server-share*/ +#define NERR_DfsCantRemoveLastServerShare (NERR_BASE+577) /*Can't remove the last server-share supporting this root or link*/ +#define NERR_DfsVolumeIsInterDfs (NERR_BASE+578) /*The operation is not supported for an Inter-DFS link*/ +#define NERR_DfsInconsistent (NERR_BASE+579) /*The internal state of the DFS Service has become inconsistent*/ +#define NERR_DfsServerUpgraded (NERR_BASE+580) /*The DFS Service has been installed on the specified server*/ +#define NERR_DfsDataIsIdentical (NERR_BASE+581) /*The DFS data being reconciled is identical*/ +#define NERR_DfsCantRemoveDfsRoot (NERR_BASE+582) /*The DFS root cannot be deleted - Uninstall DFS if required*/ +#define NERR_DfsChildOrParentInDfs (NERR_BASE+583) /*A child or parent directory of the share is already in a DFS*/ +#define NERR_DfsInternalError (NERR_BASE+590) /*DFS internal error*/ + +/* + * Net setup error codes. + * + * NERR_BASE + (591-600) + */ +#define NERR_SetupAlreadyJoined (NERR_BASE+591) /*This machine is already joined to a domain.*/ +#define NERR_SetupNotJoined (NERR_BASE+592) /*This machine is not currently joined to a domain.*/ +#define NERR_SetupDomainController (NERR_BASE+593) /*This machine is a domain controller and cannot be unjoined from a domain.*/ +#define NERR_DefaultJoinRequired (NERR_BASE+594) /*The destination domain controller does not support creating machine accounts in OUs.*/ +#define NERR_InvalidWorkgroupName (NERR_BASE+595) /*The specified workgroup name is invalid.*/ +#define NERR_NameUsesIncompatibleCodePage (NERR_BASE+596) /*The specified computer name is incompatible with the default language used on the domain controller.*/ +#define NERR_ComputerAccountNotFound (NERR_BASE+597) /*The specified computer account could not be found. Contact an administrator to verify the account is in the domain. If the account has been deleted unjoin, reboot, and rejoin the domain.*/ +#define NERR_PersonalSku (NERR_BASE+598) /*This version of Windows cannot be joined to a domain.*/ +#define NERR_SetupCheckDNSConfig (NERR_BASE+599) /*An attempt to resolve the DNS name of a domain controller in the domain being joined has failed. Please verify this client is configured to reach a DNS server that can resolve DNS names in the target domain. For information about network troubleshooting, see Windows Help.*/ +#define NERR_AlreadyCloudDomainJoined (NERR_BASE+600) /*This device is joined to Azure AD. To join an Active Directory domain, you must first go to settings and choose to disconnect your device from your work or school.*/ + +/* + * Some Password and account error results + * + * NERR_BASE + (601 - 608) +*/ +#define NERR_PasswordMustChange (NERR_BASE + 601) /* Password must change at next logon */ +#define NERR_AccountLockedOut (NERR_BASE + 602) /* Account is locked out */ +#define NERR_PasswordTooLong (NERR_BASE + 603) /* Password is too long */ +#define NERR_PasswordNotComplexEnough (NERR_BASE + 604) /* Password doesn't meet the complexity policy */ +#define NERR_PasswordFilterError (NERR_BASE + 605) /* Password doesn't meet the requirements of the filter dll's */ + +/* + * Error codes used for offline domain join and completion + * + * NERR_BASE + (609 - 621) + */ +#define NERR_NoOfflineJoinInfo (NERR_BASE + 609) /* Offline join completion information was not found. */ +#define NERR_BadOfflineJoinInfo (NERR_BASE + 610) /* The offline join completion information was bad. */ +#define NERR_CantCreateJoinInfo (NERR_BASE + 611) /* Unable to create offline join information. Please ensure you have access to the specified path location and permissions to modify its contents. Running as an elevated administrator may be required. */ +#define NERR_BadDomainJoinInfo (NERR_BASE + 612) /* The domain join info being saved was incomplete or bad. */ +#define NERR_JoinPerformedMustRestart (NERR_BASE + 613) /* Offline join operation successfully completed but a restart is needed. */ +#define NERR_NoJoinPending (NERR_BASE + 614) /* There was no offline join operation pending. */ +#define NERR_ValuesNotSet (NERR_BASE + 615) /* Unable to set one or more requested machine or domain name values on the local computer. */ +#define NERR_CantVerifyHostname (NERR_BASE + 616) /* Could not verify the current machine's hostname against the saved value in the join completion information. */ +#define NERR_CantLoadOfflineHive (NERR_BASE + 617) /* Unable to load the specified offline registry hive. Please ensure you have access to the specified path location and permissions to modify its contents. Running as an elevated administrator may be required. */ +#define NERR_ConnectionInsecure (NERR_BASE + 618) /* The minimum session security requirements for this operation were not met. */ +#define NERR_ProvisioningBlobUnsupported (NERR_BASE + 619) /* Computer account provisioning blob version is not supported. */ +#define NERR_DS8DCRequired (NERR_BASE + 620) /* The specified domain controller does not meet the version requirement for this operation. Please select a domain controller capable of issuing claims. */ +#define NERR_LDAPCapableDCRequired (NERR_BASE + 621) /* This operation requires a domain controller which supports LDAP. Please select an LDAP-capable domain controller. */ + +/* + * Additional error codes + * + * NERR_BASE + (622 - MAX) + */ +#define NERR_DS8DCNotFound (NERR_BASE + 622) /* A domain controller which meets the version requirement for this operation could not be located. Please ensure that a domain controller capable of issuing claims is available. */ +#define NERR_TargetVersionUnsupported (NERR_BASE + 623) /* The Windows version of the specified image does not support provisioning. */ +#define NERR_InvalidMachineNameForJoin (NERR_BASE + 624) /* The machine name is blocked from joining the domain.*/ +#define NERR_DS9DCNotFound (NERR_BASE + 625) /* The domain controller does not meet the version requirement for this operation. See http://go.microsoft.com/fwlink/?LinkId=294288 for more information. */ +#define NERR_PlainTextSecretsRequired (NERR_BASE + 626) /* The local machine does not allow querying of LSA secrets in plain-text. */ +#define NERR_CannotUnjoinAadDomain (NERR_BASE + 627) /* Unable to leave the Azure AD domain that this machine is joined to. Check the event log for detailed error information. */ +#define NERR_CannotUpdateAadHostName (NERR_BASE + 628) /* Unable to update hostname in Azure AD. Check the event log for detailed error information. */ +#define NERR_DuplicateHostName (NERR_BASE + 629) /* The hostname is already taken by another device. */ +#define NERR_HostNameTooLong (NERR_BASE + 630) /* The hostname is too long. */ +#define NERR_TooManyHostNames (NERR_BASE + 631) /* Too many hostnames specified for the device. */ +#define NERR_AccountReuseBlockedByPolicy (NERR_BASE + 632) /* An account with the same name exists in Active Directory. Re-using the account was blocked by security policy. */ + +/***********WARNING **************** + *The range 2750-2799 has been * + *allocated to the IBM LAN Server * + ***********************************/ + +/***********WARNING **************** + *The range 2900-2999 has been * + *reserved for Microsoft OEMs * + ***********************************/ + +/**END_INTERNAL**/ + +#define MAX_NERR (NERR_BASE+899) /* This is the last error in NERR range. */ + +/* + * end of list + * + * WARNING: Do not exceed MAX_NERR; values above this are used by + * other error code ranges (errlog.h, service.h, apperr.h). + */ + + +/*NOINC*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* NETERR_INCLUDED */ +/*INC*/ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/macamd64.inc b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/macamd64.inc new file mode 100644 index 0000000000000000000000000000000000000000..91b55e55a3798b22276d45957ed2545c832d5cf1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/macamd64.inc @@ -0,0 +1,814 @@ +;++ +; +; Copyright (c) Microsoft Corporation. All rights reserved. +; +; +; Module: +; +; macamd64.w +; +; Astract: +; +; Contains AMD64 public architecture constants and assembly macros. +; +; Author: +;-- + +;++ +; +; push_reg +; +; Macro Description: +; +; This macro emits a single-byte push instruction in a +; nested prologue, as well as the associated unwind code. +; +; Arguments: +; +; reg - supplies the integer register to push +; +;-- + +push_reg macro Reg + + push Reg + .pushreg Reg + + endm + +;++ +; +; rex_push_reg +; +; Macro Description: +; +; This macro emits a single-byte push instruction in a +; nested prologue, as well as the associated unwind code. +; +; This differs from push_reg only in that a redundant rex prefix +; is added. rex_push_reg must be used in lieu of push_reg when it +; appears as the first instruction in a function, as the calling +; standard dictates that functions must not begin with a single +; byte instruction. +; +; Arguments: +; +; reg - supplies the integer register to push +; +;-- + +rex_push_reg macro Reg + + db 048h + push Reg + .pushreg Reg + + endm + +;++ +; +; push_eflags +; +; Macro Description: +; +; This macro emits a single-byte pushfq instruction in a +; nested prologue, as well as the associated unwind code. +; +; Arguments: +; +; none +; +;-- + +push_eflags macro + + pushfq + .allocstack 8 + + endm + +;++ +; +; rex_push_eflags +; +; Macro Description: +; +; This macro emits a single-byte pushfq instruction in a +; nested prologue, as well as the associated unwind code. +; +; This differs from push_eflags only in that a redundant rex prefix +; is added. rex_push_eflags must be used in lieu of push_eflags when it +; appears as the first instruction in a function, as the calling +; standard dictates that functions must not begin with a single +; byte instruction. +; +; Arguments: +; +; none +; +;-- + +rex_push_eflags macro + + db 048h + pushfq + .allocstack 8 + + endm + +;++ +; +; rex_jmp_reg +; +; Macro Description: +; +; This macro emits a jmp instruction in a nested epilogue. +; +; This differs from jmp reg only in that a redundant rex prefix +; is added. rex_jmp_reg must be be used in lieu of jmp when it +; appears as a tail call terminating an epilogue of a function, +; as the calling dictates that functions that exit an epilogue +; with a jmp reg must include a redundant rex prefix to signify +; the presence of a tail call epilogue to the unwinder. +; +; Arguments: +; +; reg - supplies the integer register to jump to. +; +;-- + +rex_jmp_reg macro Reg + + rexw jmp Reg + + endm + +;++ +; +; ret_zero +; +; Macro Description: +; +; This macro emits a three byte return instruction. +; +; This differs from the typical ret in that it adds additional padding bytes +; that prevent branch misprediction problems when the ret is the target of +; a (un)conditional branch, or is immediately preceded by a conditional branch. +; +; Arguments: +; +; none +; +;-- + +ret_zero macro + + ret + + endm + +;++ +; +; alloc_stack +; +; Macro Description: +; +; This macro emits an opcode to subtract from rsp, as well +; as the associated unwind code. +; +; Arguments: +; +; Size - The number of bytes to subtract from rsp. +; +;-- + +alloc_stack macro Size + + sub rsp, Size + .allocstack Size + + endm + +;++ +; +; save_reg , +; +; Macro Description: +; +; This macro emits an opcode to save the non-volatile 64-bit general purpose +; register indicated by at offset relative to the current +; position of the stack pointer. It also generates the associated unwind +; code. +; +; Arguments: +; +; Reg - Supplies the integer register to save +; +; Offset - Supplies the offset relative to the current position of the stack +; pointer. +; +;-- + +save_reg macro Reg, Offset + + mov Offset[rsp], Reg + .savereg Reg, Offset + + endm + +;++ +; +; save_xmm128 , +; +; Macro Description: +; +; This macro emits an opcode to save the 128-bit non-volatile xmm register +; indicated by at offset relative to the current position +; of the stack pointer. It also generates the associated unwind code. +; +; Arguments: +; +; Reg - Supplies the xmm register register to save +; +; Offset - Supplies the offset relative to the current position of the stack +; pointer. +; +;-- + +save_xmm128 macro Reg, Offset + + movaps Offset[rsp], Reg + .savexmm128 Reg, Offset + + endm + +;++ +; +; push_frame +; +; Macro Description: +; +; This macro emits unwind data indicating that a machine frame has been +; pushed on the stack (usually by the CPU in response to a trap or fault). +; +; Arguments: +; +; None. +; +;-- + +push_frame macro Code + + .pushframe Code + + endm + +;++ +; +; set_frame , +; +; Macro Description: +; +; This macro emits an opcode and unwind data establishing the use of +; as the current stack frame pointer. +; +; Arguments: +; +; Reg - Supplies the integer register to use as the current stack frame +; pointer. +; +; Offset - Supplies the optional offset of the frame pointer relative to +; the stack frame. In stack frames greater than 080h bytes, +; a non-zero offset can help reduce the size of subsequent opcodes +; that access portions of the stack frame by facilitating the use of +; positive and negative single-byte displacements. +; +; If not supplied, no offset is assumed. +; +;-- + +set_frame macro Reg, Offset + +if Offset + + lea Reg, Offset[rsp] + +else + + mov Reg, rsp + +endif + + .setframe Reg, Offset + + endm + +;++ +; +; END_PROLOGUE +; +; Macro Description: +; +; This macro marks the end of the prologue. This must appear after all +; of the prologue directives in a nested function. +; +; Arguments: +; +; None. +; +;-- + +END_PROLOGUE macro + + .endprolog + + endm + +;++ +; +; Macro Description: +; +; This macro marks the beginning of a function epilogue. It may appear +; one or more times within a function body. The epilogue ends at the +; next control transfer instruction. +; +; Arguments: +; +; None. +; +;-- + +BEGIN_EPILOGUE macro + + .beginepilog + + endm + +;++ +; +; LEAF_ENTRY ,
, +; +; Macro Description: +; +; This macro indicates the beginning of a leaf function. +; +; A leaf function is one that DOES NOT: +; +; - manipulate non-volatile registers +; - manipulate the stack pointer +; - call other functions +; - reference an exception handler +; - contain a prologue +; - have any unwind data associated with it +; +; Arguments: +; +; Name - Supplies the name of the function +; +; Section - Supplies the name of the section within which the function +; is to appear +; +; NoPad - If present, indicates that the function should not be prefixed +; with 6 bytes of padding. This is for internal use only - the +; calling standard dictates that functions (nested and leaf) must +; be prefixed with padding. +; +;-- + +LEAF_ENTRY macro Name, Section, NoPad + +Section segment para 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align 16 + + public Name +Name proc frame + + END_PROLOGUE + + endm + +;++ +; +; LEAF_ENTRY_ALIGNED ,
, , +; +; Macro Description: +; +; This macro indicates the beginning of a leaf function with custom alignment. +; +; A leaf function is one that DOES NOT: +; +; - manipulate non-volatile registers +; - manipulate the stack pointer +; - call other functions +; - reference an exception handler +; - contain a prologue +; - have any unwind data associated with it +; +; Arguments: +; +; Name - Supplies the name of the function +; +; Section - Supplies the name of the section within which the function +; is to appear +; +; Alignment - Supplies the alignment of the function in bytes. +; +; NoPad - If present, indicates that the function should not be prefixed +; with 6 bytes of padding. This is for internal use only - the +; calling standard dictates that functions (nested and leaf) must +; be prefixed with padding. +; +;-- + +LEAF_ENTRY_ALIGNED macro Name, Section, Alignment, NoPad + +Section segment ALIGN(Alignment) 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align Alignment + + public Name +Name proc frame + + END_PROLOGUE + + endm + +;++ +; +; LEAF_ENTRY_ARG1 ,
, , +; +; Macro Description: +; +; Indicates the beginning of a leaf function, as LEAF_ENTRY above, +; and declares one input parameter so that debug info will be +; generated for it. The other forms, LEAF_ENTRY_ARG2 and LEAF_ENTRY_ARG3, +; are similar. +; +;-- + +LEAF_ENTRY_ARG1 macro Name, Section, Arg1, NoPad + +Section segment para 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align 16 + + public Name +Name proc frame + + END_PROLOGUE + + endm + +;++ +; +; LEAF_ENTRY_ARG2 ,
, , , +; +; Macro Description: +; +; As LEAF_ENTRY_ARG1 above, marks the entry to a leaf function +; and defines 2 input parameters. +; +;-- + +LEAF_ENTRY_ARG2 macro Name, Section, Arg1, Arg2, NoPad + +Section segment para 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align 16 + + public Name +Name proc frame + + END_PROLOGUE + + endm + +;++ +; +; LEAF_ENTRY_ARG3 ,
, , , , +; +; Macro Description: +; +; As LEAF_ENTRY_ARG1 above, marks the entry to a leaf function +; and defines 3 input parameters. +; +;-- + +LEAF_ENTRY_ARG3 macro Name, Section, Arg1, Arg2, Arg3, NoPad + +Section segment para 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align 16 + + public Name +Name proc frame + + END_PROLOGUE + + endm + +;++ +; +; LEAF_END ,
+; +; Macro Description: +; +; This macro indicates the end of a leaf function. It must be paired +; with a LEAF_ENTRY macro that includes matching Name and Section +; parameters. +; +; Arguments: +; +; Name - Supplies the name of the function. Must match that supplied to +; the corresponding LEAF_ENTRY macro. +; +; Section - Supplies the name of the section within which the function +; is to appear. Must match that supplied to the corresponding +; LEAF_ENTRY macro. +; +;-- + +LEAF_END macro Name, section + +Name endp + +Section ends + + endm + +;++ +; +; NESTED_ENTRY ,
, , +; +; Macro Description: +; +; This macro indicates the beginning of a nested function. +; +; A nested function is one that does any of the following: +; +; - manipulates non-volatile registers +; - manipulates the stack pointer +; - references an exception handler +; - calls other functions +; +; A nested function must include a prologue with unwind data. +; +; Arguments: +; +; Name - Supplies the name of the function. +; +; Section - Supplies the name of the section within which the function +; is to appear. +; +; Handler - Supplies the name of the handler for exceptions raised +; within the scope of this function. +; +; NoPad - If present, indicates that the function should not be prefixed +; with 6 bytes of padding. This is for internal use only - the +; calling standard dictates that functions (nested and leaf) must +; be prefixed with padding. +; +;-- + +NESTED_ENTRY macro Name, Section, Handler, NoPad + +ifdef _CurrentSection_ + +ifdif
, _CurrentSection_ + +.err + +endif + +endif + +_CurrentSection_ EQU
+ +Section segment para 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align 16 + + public Name + +ifb + +Name proc frame + +else + +Name proc frame:Handler + +endif + + endm + + +;++ +; +; NESTED_ENTRY_ALIGNED ,
, , , +; +; Macro Description: +; +; This macro indicates the beginning of a nested function with custom +; alignment. +; +; A nested function is one that does any of the following: +; +; - manipulates non-volatile registers +; - manipulates the stack pointer +; - references an exception handler +; - calls other functions +; +; A nested function must include a prologue with unwind data. +; +; Arguments: +; +; Name - Supplies the name of the function. +; +; Section - Supplies the name of the section within which the function +; is to appear. +; +; Alignment - Supplies the alignment of the function in bytes. +; +; Handler - Supplies the name of the handler for exceptions raised +; within the scope of this function. +; +; +; NoPad - If present, indicates that the function should not be prefixed +; with 6 bytes of padding. This is for internal use only - the +; calling standard dictates that functions (nested and leaf) must +; be prefixed with padding. +; +;-- + +NESTED_ENTRY_ALIGNED macro Name, Section, Alignment, Handler, NoPad + +ifdef _CurrentSection_ + +ifdif
, _CurrentSection_ + +.err + +endif + +endif + +_CurrentSection_ EQU
+ +Section segment ALIGN(Alignment) 'CODE' + +ifb + + db 6 dup (0cch) + +endif + + align Alignment + + public Name + +ifb + +Name proc frame + +else + +Name proc frame:Handler + +endif + + endm + +;++ +; +; NESTED_END ,
+; +; Macro Description: +; +; This macro indicates the end of a nested function. It must be paired +; with a NESTED_ENTRY macro that includes matching Name and Section +; parameters. +; +; Arguments: +; +; Name - Supplies the name of the function. Must match that supplied to +; the corresponding NESTED_ENTRY macro. +; +; Section - Supplies the name of the section within which the function +; is to appear. Must match that supplied to the corresponding +; NESTED_ENTRY macro. +; +;-- + +NESTED_END macro Name, section + +Name endp + +Section ends + + endm + +;++ +; +; ALTERNATE_ENTRY +; +; Macro Description: +; +; This macro indicates an alternate entry point in a function, or +; a synonymous name for an existing function. +; +; Arguments: +; +; Name - Supplies the name of the alternate entry point. +; +;-- + +ALTERNATE_ENTRY macro Name + +Name: + endm + +;++ +; +; Yield +; +; Macro Description: +; +; This macro generates a yield instruction, interpreted by SMT processors +; as an indication of a stall or idle condition. +; +; Arguments: +; +; None. +; +;-- + +Yield macro + + pause ; yield execution on SMT processors + + endm + +;++ +; +; RetpolineIgnore +; +; Macro Description: +; +; This macro generates a retpoline ignore directive which informs tools that +; retpoline instrumentation is not required. +; +; Arguments: +; +; None. +; +;-- + +RetpolineIgnore macro + +ifdef _RETPOLINE + + .retpolineignore ; mark branch as retpoline-ignored + +endif + + endm + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/minwindef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/minwindef.h new file mode 100644 index 0000000000000000000000000000000000000000..384fd6d2aa49f700d72284c089ff2a0568ccb9b4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/minwindef.h @@ -0,0 +1,285 @@ +/**************************************************************************** +* * +* minwindef.h -- Basic Windows Type Definitions for minwin partition * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +****************************************************************************/ + + +#ifndef _MINWINDEF_ +#define _MINWINDEF_ +#pragma once + +#include + +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef NO_STRICT +#ifndef STRICT +#define STRICT 1 +#endif +#endif /* NO_STRICT */ + +// Win32 defines _WIN32 automatically, +// but Macintosh doesn't, so if we are using +// Win32 Functions, we must do it here + +#ifdef _MAC +#ifndef _WIN32 +#define _WIN32 +#endif +#endif //_MAC + +#ifndef WIN32 +#define WIN32 +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * BASETYPES is defined in ntdef.h if these types are already defined + */ + +#ifndef BASETYPES +#define BASETYPES +typedef unsigned long ULONG; +typedef ULONG *PULONG; +typedef unsigned short USHORT; +typedef USHORT *PUSHORT; +typedef unsigned char UCHAR; +typedef UCHAR *PUCHAR; +typedef _Null_terminated_ char *PSZ; +#endif /* !BASETYPES */ + +#define MAX_PATH 260 + +#ifndef NULL +#ifdef __cplusplus +#define NULL 0 +#else +#define NULL ((void *)0) +#endif +#endif + +#ifndef FALSE +#define FALSE 0 +#endif + +#ifndef TRUE +#define TRUE 1 +#endif + +#ifndef IN +#define IN +#endif + +#ifndef OUT +#define OUT +#endif + +#ifndef OPTIONAL +#define OPTIONAL +#endif + +#undef far +#undef near +#undef pascal + +#define far +#define near + +#if (!defined(_MAC)) && ((_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED)) +#define pascal __stdcall +#else +#define pascal +#endif + +#if defined(DOSWIN32) || defined(_MAC) +#define cdecl _cdecl +#ifndef CDECL +#define CDECL _cdecl +#endif +#else +#define cdecl +#ifndef CDECL +#define CDECL +#endif +#endif + +#ifdef _MAC +#define CALLBACK PASCAL +#define WINAPI CDECL +#define WINAPIV CDECL +#define APIENTRY WINAPI +#define APIPRIVATE CDECL +#ifdef _68K_ +#define PASCAL __pascal +#else +#define PASCAL +#endif +#elif (_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED) +#define CALLBACK __stdcall +#define WINAPI __stdcall +#define WINAPIV __cdecl +#define APIENTRY WINAPI +#define APIPRIVATE __stdcall +#define PASCAL __stdcall +#else +#define CALLBACK +#define WINAPI +#define WINAPIV +#define APIENTRY WINAPI +#define APIPRIVATE +#define PASCAL pascal +#endif + +#ifndef _M_CEE_PURE +#ifndef WINAPI_INLINE +#define WINAPI_INLINE WINAPI +#endif +#endif + +#undef FAR +#undef NEAR +#define FAR far +#define NEAR near +#ifndef CONST +#define CONST const +#endif + +typedef unsigned long DWORD; +typedef int BOOL; +typedef unsigned char BYTE; +typedef unsigned short WORD; +typedef float FLOAT; +typedef FLOAT *PFLOAT; +typedef BOOL near *PBOOL; +typedef BOOL far *LPBOOL; +typedef BYTE near *PBYTE; +typedef BYTE far *LPBYTE; +typedef int near *PINT; +typedef int far *LPINT; +typedef WORD near *PWORD; +typedef WORD far *LPWORD; +typedef long far *LPLONG; +typedef DWORD near *PDWORD; +typedef DWORD far *LPDWORD; +typedef void far *LPVOID; +typedef CONST void far *LPCVOID; + +typedef int INT; +typedef unsigned int UINT; +typedef unsigned int *PUINT; + + +#ifndef NT_INCLUDED +#include +#endif /* NT_INCLUDED */ + +/* Types use for passing & returning polymorphic values */ +typedef UINT_PTR WPARAM; +typedef LONG_PTR LPARAM; +typedef LONG_PTR LRESULT; + +#ifndef NOMINMAX + +#ifndef max +#define max(a,b) (((a) > (b)) ? (a) : (b)) +#endif + +#ifndef min +#define min(a,b) (((a) < (b)) ? (a) : (b)) +#endif + +#endif /* NOMINMAX */ + +#define MAKEWORD(a, b) ((WORD)(((BYTE)(((DWORD_PTR)(a)) & 0xff)) | ((WORD)((BYTE)(((DWORD_PTR)(b)) & 0xff))) << 8)) +#define MAKELONG(a, b) ((LONG)(((WORD)(((DWORD_PTR)(a)) & 0xffff)) | ((DWORD)((WORD)(((DWORD_PTR)(b)) & 0xffff))) << 16)) +#define LOWORD(l) ((WORD)(((DWORD_PTR)(l)) & 0xffff)) +#define HIWORD(l) ((WORD)((((DWORD_PTR)(l)) >> 16) & 0xffff)) +#define LOBYTE(w) ((BYTE)(((DWORD_PTR)(w)) & 0xff)) +#define HIBYTE(w) ((BYTE)((((DWORD_PTR)(w)) >> 8) & 0xff)) + +typedef HANDLE NEAR *SPHANDLE; +typedef HANDLE FAR *LPHANDLE; +typedef HANDLE HGLOBAL; +typedef HANDLE HLOCAL; +typedef HANDLE GLOBALHANDLE; +typedef HANDLE LOCALHANDLE; + +#ifndef _MANAGED +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4255) // () treated as (void) +#endif +#ifndef _MAC +#ifdef _WIN64 +typedef INT_PTR (FAR WINAPI *FARPROC)(); +typedef INT_PTR (NEAR WINAPI *NEARPROC)(); +typedef INT_PTR (WINAPI *PROC)(); +#else +typedef int (FAR WINAPI *FARPROC)(); +typedef int (NEAR WINAPI *NEARPROC)(); +typedef int (WINAPI *PROC)(); +#endif // _WIN64 +#else +typedef int (CALLBACK *FARPROC)(); +typedef int (CALLBACK *NEARPROC)(); +typedef int (CALLBACK *PROC)(); +#endif +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif +#else +typedef INT_PTR (WINAPI *FARPROC)(void); +typedef INT_PTR (WINAPI *NEARPROC)(void); +typedef INT_PTR (WINAPI *PROC)(void); +#endif + +typedef WORD ATOM; //BUGBUG - might want to remove this from minwin + +DECLARE_HANDLE(HKEY); +typedef HKEY *PHKEY; +DECLARE_HANDLE(HMETAFILE); +DECLARE_HANDLE(HINSTANCE); +typedef HINSTANCE HMODULE; /* HMODULEs can be used in place of HINSTANCEs */ +DECLARE_HANDLE(HRGN); +DECLARE_HANDLE(HRSRC); +DECLARE_HANDLE(HSPRITE); +DECLARE_HANDLE(HLSURF); +DECLARE_HANDLE(HSTR); +DECLARE_HANDLE(HTASK); +DECLARE_HANDLE(HWINSTA); +DECLARE_HANDLE(HKL); + +#ifndef _MAC +typedef int HFILE; +#else +typedef short HFILE; +#endif + +// +// File System time stamps are represented with the following structure: +// + +typedef struct _FILETIME { + DWORD dwLowDateTime; + DWORD dwHighDateTime; +} FILETIME, *PFILETIME, *LPFILETIME; +#define _FILETIME_ + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _MINWINDEF_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mmreg.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mmreg.h new file mode 100644 index 0000000000000000000000000000000000000000..55920c8e3fea4c3311c842d929329c7049ba8252 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mmreg.h @@ -0,0 +1,3814 @@ +#include + +//*@@@+++@@@@****************************************************************** +// +// Copyright (C) Microsoft Corporation. All rights reserved. +// +// Multimedia Registration +// +//*@@@---@@@@****************************************************************** +// + +// Define the following to skip definitions +// +// NOMMIDS Multimedia IDs are not defined +// NONEWWAVE No new waveform types are defined except WAVEFORMATEX +// NONEWRIFF No new RIFF forms are defined +// NOJPEGDIB No JPEG DIB definitions +// NONEWIC No new Image Compressor types are defined +// NOBITMAP No extended bitmap info header definition + +#if !defined(__midl) + +#ifndef _INC_MMREG +/* use version number to verify compatibility */ +#define _INC_MMREG 158 // version * 100 + revision + +#if _MSC_VER > 1000 +#pragma once +#endif + +#if !defined( RC_INVOKED ) && defined( _MSC_VER ) +#if (_MSC_VER <= 800) +#pragma pack(1) +#else +#include "pshpack1.h" /* Assume byte packing throughout */ +#endif +#endif /* RC_INVOKED */ + +#ifdef __cplusplus +extern "C" { /* Assume C declarations for C++ */ +#endif /* __cplusplus */ + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifndef NOMMIDS + +/* manufacturer IDs */ +#ifndef MM_MICROSOFT +#define MM_MICROSOFT 1 /* Microsoft Corporation */ +#endif + +#define MM_CREATIVE 2 /* Creative Labs, Inc. */ +#define MM_MEDIAVISION 3 /* Media Vision, Inc. */ +#define MM_FUJITSU 4 /* Fujitsu Corp. */ +#define MM_PRAGMATRAX 5 /* PRAGMATRAX Software */ +#define MM_CYRIX 6 /* Cyrix Corporation */ +#define MM_PHILIPS_SPEECH_PROCESSING 7 /* Philips Speech Processing */ +#define MM_NETXL 8 /* NetXL, Inc. */ +#define MM_ZYXEL 9 /* ZyXEL Communications, Inc. */ +#define MM_BECUBED 10 /* BeCubed Software Inc. */ +#define MM_AARDVARK 11 /* Aardvark Computer Systems, Inc. */ +#define MM_BINTEC 12 /* Bin Tec Communications GmbH */ +#define MM_HEWLETT_PACKARD 13 /* Hewlett-Packard Company */ +#define MM_ACULAB 14 /* Aculab plc */ +#define MM_FAITH 15 /* Faith,Inc. */ +#define MM_MITEL 16 /* Mitel Corporation */ +#define MM_QUANTUM3D 17 /* Quantum3D, Inc. */ +#define MM_SNI 18 /* Siemens-Nixdorf */ +#define MM_EMU 19 /* E-mu Systems, Inc. */ +#define MM_ARTISOFT 20 /* Artisoft, Inc. */ +#define MM_TURTLE_BEACH 21 /* Turtle Beach, Inc. */ +#define MM_IBM 22 /* IBM Corporation */ +#define MM_VOCALTEC 23 /* Vocaltec Ltd. */ +#define MM_ROLAND 24 /* Roland */ +#define MM_DSP_SOLUTIONS 25 /* DSP Solutions, Inc. */ +#define MM_NEC 26 /* NEC */ +#define MM_ATI 27 /* ATI Technologies Inc. */ +#define MM_WANGLABS 28 /* Wang Laboratories, Inc. */ +#define MM_TANDY 29 /* Tandy Corporation */ +#define MM_VOYETRA 30 /* Voyetra */ +#define MM_ANTEX 31 /* Antex Electronics Corporation */ +#define MM_ICL_PS 32 /* ICL Personal Systems */ +#define MM_INTEL 33 /* Intel Corporation */ +#define MM_GRAVIS 34 /* Advanced Gravis */ +#define MM_VAL 35 /* Video Associates Labs, Inc. */ +#define MM_INTERACTIVE 36 /* InterActive Inc. */ +#define MM_YAMAHA 37 /* Yamaha Corporation of America */ +#define MM_EVEREX 38 /* Everex Systems, Inc. */ +#define MM_ECHO 39 /* Echo Speech Corporation */ +#define MM_SIERRA 40 /* Sierra Semiconductor Corp */ +#define MM_CAT 41 /* Computer Aided Technologies */ +#define MM_APPS 42 /* APPS Software International */ +#define MM_DSP_GROUP 43 /* DSP Group, Inc. */ +#define MM_MELABS 44 /* microEngineering Labs */ +#define MM_COMPUTER_FRIENDS 45 /* Computer Friends, Inc. */ +#define MM_ESS 46 /* ESS Technology */ +#define MM_AUDIOFILE 47 /* Audio, Inc. */ +#define MM_MOTOROLA 48 /* Motorola, Inc. */ +#define MM_CANOPUS 49 /* Canopus, co., Ltd. */ +#define MM_EPSON 50 /* Seiko Epson Corporation */ +#define MM_TRUEVISION 51 /* Truevision */ +#define MM_AZTECH 52 /* Aztech Labs, Inc. */ +#define MM_VIDEOLOGIC 53 /* Videologic */ +#define MM_SCALACS 54 /* SCALACS */ +#define MM_KORG 55 /* Korg Inc. */ +#define MM_APT 56 /* Audio Processing Technology */ +#define MM_ICS 57 /* Integrated Circuit Systems, Inc. */ +#define MM_ITERATEDSYS 58 /* Iterated Systems, Inc. */ +#define MM_METHEUS 59 /* Metheus */ +#define MM_LOGITECH 60 /* Logitech, Inc. */ +#define MM_WINNOV 61 /* Winnov, Inc. */ +#define MM_NCR 62 /* NCR Corporation */ +#define MM_EXAN 63 /* EXAN */ +#define MM_AST 64 /* AST Research Inc. */ +#define MM_WILLOWPOND 65 /* Willow Pond Corporation */ +#define MM_SONICFOUNDRY 66 /* Sonic Foundry */ +#define MM_VITEC 67 /* Vitec Multimedia */ +#define MM_MOSCOM 68 /* MOSCOM Corporation */ +#define MM_SILICONSOFT 69 /* Silicon Soft, Inc. */ +#define MM_TERRATEC 70 /* TerraTec Electronic GmbH */ +#define MM_MEDIASONIC 71 /* MediaSonic Ltd. */ +#define MM_SANYO 72 /* SANYO Electric Co., Ltd. */ +#define MM_SUPERMAC 73 /* Supermac */ +#define MM_AUDIOPT 74 /* Audio Processing Technology */ +#define MM_NOGATECH 75 /* NOGATECH Ltd. */ +#define MM_SPEECHCOMP 76 /* Speech Compression */ +#define MM_AHEAD 77 /* Ahead, Inc. */ +#define MM_DOLBY 78 /* Dolby Laboratories */ +#define MM_OKI 79 /* OKI */ +#define MM_AURAVISION 80 /* AuraVision Corporation */ +#define MM_OLIVETTI 81 /* Ing C. Olivetti & C., S.p.A. */ +#define MM_IOMAGIC 82 /* I/O Magic Corporation */ +#define MM_MATSUSHITA 83 /* Matsushita Electric Industrial Co., Ltd. */ +#define MM_CONTROLRES 84 /* Control Resources Limited */ +#define MM_XEBEC 85 /* Xebec Multimedia Solutions Limited */ +#define MM_NEWMEDIA 86 /* New Media Corporation */ +#define MM_NMS 87 /* Natural MicroSystems */ +#define MM_LYRRUS 88 /* Lyrrus Inc. */ +#define MM_COMPUSIC 89 /* Compusic */ +#define MM_OPTI 90 /* OPTi Computers Inc. */ +#define MM_ADLACC 91 /* Adlib Accessories Inc. */ +#define MM_COMPAQ 92 /* Compaq Computer Corp. */ +#define MM_DIALOGIC 93 /* Dialogic Corporation */ +#define MM_INSOFT 94 /* InSoft, Inc. */ +#define MM_MPTUS 95 /* M.P. Technologies, Inc. */ +#define MM_WEITEK 96 /* Weitek */ +#define MM_LERNOUT_AND_HAUSPIE 97 /* Lernout & Hauspie */ +#define MM_QCIAR 98 /* Quanta Computer Inc. */ +#define MM_APPLE 99 /* Apple Computer, Inc. */ +#define MM_DIGITAL 100 /* Digital Equipment Corporation */ +#define MM_MOTU 101 /* Mark of the Unicorn */ +#define MM_WORKBIT 102 /* Workbit Corporation */ +#define MM_OSITECH 103 /* Ositech Communications Inc. */ +#define MM_MIRO 104 /* miro Computer Products AG */ +#define MM_CIRRUSLOGIC 105 /* Cirrus Logic */ +#define MM_ISOLUTION 106 /* ISOLUTION B.V. */ +#define MM_HORIZONS 107 /* Horizons Technology, Inc. */ +#define MM_CONCEPTS 108 /* Computer Concepts Ltd. */ +#define MM_VTG 109 /* Voice Technologies Group, Inc. */ +#define MM_RADIUS 110 /* Radius */ +#define MM_ROCKWELL 111 /* Rockwell International */ +#define MM_XYZ 112 /* Co. XYZ for testing */ +#define MM_OPCODE 113 /* Opcode Systems */ +#define MM_VOXWARE 114 /* Voxware Inc. */ +#define MM_NORTHERN_TELECOM 115 /* Northern Telecom Limited */ +#define MM_APICOM 116 /* APICOM */ +#define MM_GRANDE 117 /* Grande Software */ +#define MM_ADDX 118 /* ADDX */ +#define MM_WILDCAT 119 /* Wildcat Canyon Software */ +#define MM_RHETOREX 120 /* Rhetorex Inc. */ +#define MM_BROOKTREE 121 /* Brooktree Corporation */ +#define MM_ENSONIQ 125 /* ENSONIQ Corporation */ +#define MM_FAST 126 /* FAST Multimedia AG */ +#define MM_NVIDIA 127 /* NVidia Corporation */ +#define MM_OKSORI 128 /* OKSORI Co., Ltd. */ +#define MM_DIACOUSTICS 129 /* DiAcoustics, Inc. */ +#define MM_GULBRANSEN 130 /* Gulbransen, Inc. */ +#define MM_KAY_ELEMETRICS 131 /* Kay Elemetrics, Inc. */ +#define MM_CRYSTAL 132 /* Crystal Semiconductor Corporation */ +#define MM_SPLASH_STUDIOS 133 /* Splash Studios */ +#define MM_QUARTERDECK 134 /* Quarterdeck Corporation */ +#define MM_TDK 135 /* TDK Corporation */ +#define MM_DIGITAL_AUDIO_LABS 136 /* Digital Audio Labs, Inc. */ +#define MM_SEERSYS 137 /* Seer Systems, Inc. */ +#define MM_PICTURETEL 138 /* PictureTel Corporation */ +#define MM_ATT_MICROELECTRONICS 139 /* AT&T Microelectronics */ +#define MM_OSPREY 140 /* Osprey Technologies, Inc. */ +#define MM_MEDIATRIX 141 /* Mediatrix Peripherals */ +#define MM_SOUNDESIGNS 142 /* SounDesignS M.C.S. Ltd. */ +#define MM_ALDIGITAL 143 /* A.L. Digital Ltd. */ +#define MM_SPECTRUM_SIGNAL_PROCESSING 144 /* Spectrum Signal Processing, Inc. */ +#define MM_ECS 145 /* Electronic Courseware Systems, Inc. */ +#define MM_AMD 146 /* AMD */ +#define MM_COREDYNAMICS 147 /* Core Dynamics */ +#define MM_CANAM 148 /* CANAM Computers */ +#define MM_SOFTSOUND 149 /* Softsound, Ltd. */ +#define MM_NORRIS 150 /* Norris Communications, Inc. */ +#define MM_DDD 151 /* Danka Data Devices */ +#define MM_EUPHONICS 152 /* EuPhonics */ +#define MM_PRECEPT 153 /* Precept Software, Inc. */ +#define MM_CRYSTAL_NET 154 /* Crystal Net Corporation */ +#define MM_CHROMATIC 155 /* Chromatic Research, Inc. */ +#define MM_VOICEINFO 156 /* Voice Information Systems, Inc. */ +#define MM_VIENNASYS 157 /* Vienna Systems */ +#define MM_CONNECTIX 158 /* Connectix Corporation */ +#define MM_GADGETLABS 159 /* Gadget Labs LLC */ +#define MM_FRONTIER 160 /* Frontier Design Group LLC */ +#define MM_VIONA 161 /* Viona Development GmbH */ +#define MM_CASIO 162 /* Casio Computer Co., LTD */ +#define MM_DIAMONDMM 163 /* Diamond Multimedia */ +#define MM_S3 164 /* S3 */ +#define MM_DVISION 165 /* D-Vision Systems, Inc. */ +#define MM_NETSCAPE 166 /* Netscape Communications */ +#define MM_SOUNDSPACE 167 /* Soundspace Audio */ +#define MM_VANKOEVERING 168 /* VanKoevering Company */ +#define MM_QTEAM 169 /* Q-Team */ +#define MM_ZEFIRO 170 /* Zefiro Acoustics */ +#define MM_STUDER 171 /* Studer Professional Audio AG */ +#define MM_FRAUNHOFER_IIS 172 /* Fraunhofer IIS */ +#define MM_QUICKNET 173 /* Quicknet Technologies */ +#define MM_ALARIS 174 /* Alaris, Inc. */ +#define MM_SICRESOURCE 175 /* SIC Resource Inc. */ +#define MM_NEOMAGIC 176 /* NeoMagic Corporation */ +#define MM_MERGING_TECHNOLOGIES 177 /* Merging Technologies S.A. */ +#define MM_XIRLINK 178 /* Xirlink, Inc. */ +#define MM_COLORGRAPH 179 /* Colorgraph (UK) Ltd */ +#define MM_OTI 180 /* Oak Technology, Inc. */ +#define MM_AUREAL 181 /* Aureal Semiconductor */ +#define MM_VIVO 182 /* Vivo Software */ +#define MM_SHARP 183 /* Sharp */ +#define MM_LUCENT 184 /* Lucent Technologies */ +#define MM_ATT 185 /* AT&T Labs, Inc. */ +#define MM_SUNCOM 186 /* Sun Communications, Inc. */ +#define MM_SORVIS 187 /* Sorenson Vision */ +#define MM_INVISION 188 /* InVision Interactive */ +#define MM_BERKOM 189 /* Deutsche Telekom Berkom GmbH */ +#define MM_MARIAN 190 /* Marian GbR Leipzig */ +#define MM_DPSINC 191 /* Digital Processing Systems, Inc. */ +#define MM_BCB 192 /* BCB Holdings Inc. */ +#define MM_MOTIONPIXELS 193 /* Motion Pixels */ +#define MM_QDESIGN 194 /* QDesign Corporation */ +#define MM_NMP 195 /* Nokia Mobile Phones */ +#define MM_DATAFUSION 196 /* DataFusion Systems (Pty) (Ltd) */ +#define MM_DUCK 197 /* The Duck Corporation */ +#define MM_FTR 198 /* Future Technology Resources Pty Ltd */ +#define MM_BERCOS 199 /* BERCOS GmbH */ +#define MM_ONLIVE 200 /* OnLive! Technologies, Inc. */ +#define MM_SIEMENS_SBC 201 /* Siemens Business Communications Systems */ +#define MM_TERALOGIC 202 /* TeraLogic, Inc. */ +#define MM_PHONET 203 /* PhoNet Communications Ltd. */ +#define MM_WINBOND 204 /* Winbond Electronics Corp */ +#define MM_VIRTUALMUSIC 205 /* Virtual Music, Inc. */ +#define MM_ENET 206 /* e-Net, Inc. */ +#define MM_GUILLEMOT 207 /* Guillemot International */ +#define MM_EMAGIC 208 /* Emagic Soft- und Hardware GmbH */ +#define MM_MWM 209 /* MWM Acoustics LLC */ +#define MM_PACIFICRESEARCH 210 /* Pacific Research and Engineering Corporation */ +#define MM_SIPROLAB 211 /* Sipro Lab Telecom Inc. */ +#define MM_LYNX 212 /* Lynx Studio Technology, Inc. */ +#define MM_SPECTRUM_PRODUCTIONS 213 /* Spectrum Productions */ +#define MM_DICTAPHONE 214 /* Dictaphone Corporation */ +#define MM_QUALCOMM 215 /* QUALCOMM, Inc. */ +#define MM_RZS 216 /* Ring Zero Systems, Inc */ +#define MM_AUDIOSCIENCE 217 /* AudioScience Inc. */ +#define MM_PINNACLE 218 /* Pinnacle Systems, Inc. */ +#define MM_EES 219 /* EES Technik fuer Musik GmbH */ +#define MM_HAFTMANN 220 /* haftmann#software */ +#define MM_LUCID 221 /* Lucid Technology, Symetrix Inc. */ +#define MM_HEADSPACE 222 /* Headspace, Inc */ +#define MM_UNISYS 223 /* UNISYS CORPORATION */ +#define MM_LUMINOSITI 224 /* Luminositi, Inc. */ +#define MM_ACTIVEVOICE 225 /* ACTIVE VOICE CORPORATION */ +#define MM_DTS 226 /* Digital Theater Systems, Inc. */ +#define MM_DIGIGRAM 227 /* DIGIGRAM */ +#define MM_SOFTLAB_NSK 228 /* Softlab-Nsk */ +#define MM_FORTEMEDIA 229 /* ForteMedia, Inc */ +#define MM_SONORUS 230 /* Sonorus, Inc. */ +#define MM_ARRAY 231 /* Array Microsystems, Inc. */ +#define MM_DATARAN 232 /* Data Translation, Inc. */ +#define MM_I_LINK 233 /* I-link Worldwide */ +#define MM_SELSIUS_SYSTEMS 234 /* Selsius Systems Inc. */ +#define MM_ADMOS 235 /* AdMOS Technology, Inc. */ +#define MM_LEXICON 236 /* Lexicon Inc. */ +#define MM_SGI 237 /* Silicon Graphics Inc. */ +#define MM_IPI 238 /* Interactive Product Inc. */ +#define MM_ICE 239 /* IC Ensemble, Inc. */ +#define MM_VQST 240 /* ViewQuest Technologies Inc. */ +#define MM_ETEK 241 /* eTEK Labs Inc. */ +#define MM_CS 242 /* Consistent Software */ +#define MM_ALESIS 243 /* Alesis Studio Electronics */ +#define MM_INTERNET 244 /* INTERNET Corporation */ +#define MM_SONY 245 /* Sony Corporation */ +#define MM_HYPERACTIVE 246 /* Hyperactive Audio Systems, Inc. */ +#define MM_UHER_INFORMATIC 247 /* UHER informatic GmbH */ +#define MM_SYDEC_NV 248 /* Sydec NV */ +#define MM_FLEXION 249 /* Flexion Systems Ltd. */ +#define MM_VIA 250 /* Via Technologies, Inc. */ +#define MM_MICRONAS 251 /* Micronas Semiconductors, Inc. */ +#define MM_ANALOGDEVICES 252 /* Analog Devices, Inc. */ +#define MM_HP 253 /* Hewlett Packard Company */ +#define MM_MATROX_DIV 254 /* Matrox */ +#define MM_QUICKAUDIO 255 /* Quick Audio, GbR */ +#define MM_YOUCOM 256 /* You/Com Audiocommunicatie BV */ +#define MM_RICHMOND 257 /* Richmond Sound Design Ltd. */ +#define MM_IODD 258 /* I-O Data Device, Inc. */ +#define MM_ICCC 259 /* ICCC A/S */ +#define MM_3COM 260 /* 3COM Corporation */ +#define MM_MALDEN 261 /* Malden Electronics Ltd. */ +#define MM_3DFX 262 /* 3Dfx Interactive, Inc. */ +#define MM_MINDMAKER 263 /* Mindmaker, Inc. */ +#define MM_TELEKOL 264 /* Telekol Corp. */ +#define MM_ST_MICROELECTRONICS 265 /* ST Microelectronics */ +#define MM_ALGOVISION 266 /* Algo Vision Systems GmbH */ + +#define MM_UNMAPPED 0xffff /* extensible MID mapping */ + +#define MM_PID_UNMAPPED MM_UNMAPPED /* extensible PID mapping */ + +#ifdef GUID_DEFINED +#if !defined(INIT_MMREG_MID) +//{d5a47fa7-6d98-11d1-a21a-00a0c9223196} +#define INIT_MMREG_MID(guid, id)\ +{\ + (guid)->Data1 = 0xd5a47fa7 + (USHORT)(id);\ + (guid)->Data2 = 0x6d98;\ + (guid)->Data3 = 0x11d1;\ + (guid)->Data4[0] = 0xa2;\ + (guid)->Data4[1] = 0x1a;\ + (guid)->Data4[2] = 0x00;\ + (guid)->Data4[3] = 0xa0;\ + (guid)->Data4[4] = 0xc9;\ + (guid)->Data4[5] = 0x22;\ + (guid)->Data4[6] = 0x31;\ + (guid)->Data4[7] = 0x96;\ +} +#define EXTRACT_MMREG_MID(guid)\ + (USHORT)((guid)->Data1 - 0xd5a47fa7) +#define DEFINE_MMREG_MID_GUID(id)\ + 0xd5a47fa7+(USHORT)(id), 0x6d98, 0x11d1, 0xa2, 0x1a, 0x00, 0xa0, 0xc9, 0x22, 0x31, 0x96 + +#define IS_COMPATIBLE_MMREG_MID(guid)\ + (((guid)->Data1 >= 0xd5a47fa7) &&\ + ((guid)->Data1 < 0xd5a47fa7 + 0xffff) &&\ + ((guid)->Data2 == 0x6d98) &&\ + ((guid)->Data3 == 0x11d1) &&\ + ((guid)->Data4[0] == 0xa2) &&\ + ((guid)->Data4[1] == 0x1a) &&\ + ((guid)->Data4[2] == 0x00) &&\ + ((guid)->Data4[3] == 0xa0) &&\ + ((guid)->Data4[4] == 0xc9) &&\ + ((guid)->Data4[5] == 0x22) &&\ + ((guid)->Data4[6] == 0x31) &&\ + ((guid)->Data4[7] == 0x96)) +#endif // !defined(INIT_MMREG_MID) + +#if !defined(INIT_MMREG_PID) +//{e36dc2ac-6d9a-11d1-a21a-00a0c9223196} +#define INIT_MMREG_PID(guid, id)\ +{\ + (guid)->Data1 = 0xe36dc2ac + (USHORT)(id);\ + (guid)->Data2 = 0x6d9a;\ + (guid)->Data3 = 0x11d1;\ + (guid)->Data4[0] = 0xa2;\ + (guid)->Data4[1] = 0x1a;\ + (guid)->Data4[2] = 0x00;\ + (guid)->Data4[3] = 0xa0;\ + (guid)->Data4[4] = 0xc9;\ + (guid)->Data4[5] = 0x22;\ + (guid)->Data4[6] = 0x31;\ + (guid)->Data4[7] = 0x96;\ +} +#define EXTRACT_MMREG_PID(guid)\ + (USHORT)((guid)->Data1 - 0xe36dc2ac) +#define DEFINE_MMREG_PID_GUID(id)\ + 0xe36dc2ac+(USHORT)(id), 0x6d9a, 0x11d1, 0xa2, 0x1a, 0x00, 0xa0, 0xc9, 0x22, 0x31, 0x96 + +#define IS_COMPATIBLE_MMREG_PID(guid)\ + (((guid)->Data1 >= 0xe36dc2ac) &&\ + ((guid)->Data1 < 0xe36dc2ac + 0xffff) &&\ + ((guid)->Data2 == 0x6d9a) &&\ + ((guid)->Data3 == 0x11d1) &&\ + ((guid)->Data4[0] == 0xa2) &&\ + ((guid)->Data4[1] == 0x1a) &&\ + ((guid)->Data4[2] == 0x00) &&\ + ((guid)->Data4[3] == 0xa0) &&\ + ((guid)->Data4[4] == 0xc9) &&\ + ((guid)->Data4[5] == 0x22) &&\ + ((guid)->Data4[6] == 0x31) &&\ + ((guid)->Data4[7] == 0x96)) +#endif // !defined(INIT_MMREG_PID) +#endif // GUID_DEFINED + +/* MM_MICROSOFT product IDs */ + +#ifndef MM_MIDI_MAPPER + +#define MM_MIDI_MAPPER 1 /* Midi Mapper */ +#define MM_WAVE_MAPPER 2 /* Wave Mapper */ +#define MM_SNDBLST_MIDIOUT 3 /* Sound Blaster MIDI output port */ +#define MM_SNDBLST_MIDIIN 4 /* Sound Blaster MIDI input port */ +#define MM_SNDBLST_SYNTH 5 /* Sound Blaster internal synth */ +#define MM_SNDBLST_WAVEOUT 6 /* Sound Blaster waveform output */ +#define MM_SNDBLST_WAVEIN 7 /* Sound Blaster waveform input */ +#define MM_ADLIB 9 /* Ad Lib Compatible synth */ +#define MM_MPU401_MIDIOUT 10 /* MPU 401 compatible MIDI output port */ +#define MM_MPU401_MIDIIN 11 /* MPU 401 compatible MIDI input port */ +#define MM_PC_JOYSTICK 12 /* Joystick adapter */ + +#endif + +#define MM_PCSPEAKER_WAVEOUT 13 /* PC speaker waveform output */ +#define MM_MSFT_WSS_WAVEIN 14 /* MS Audio Board waveform input */ +#define MM_MSFT_WSS_WAVEOUT 15 /* MS Audio Board waveform output */ +#define MM_MSFT_WSS_FMSYNTH_STEREO 16 /* MS Audio Board Stereo FM synth */ +#define MM_MSFT_WSS_MIXER 17 /* MS Audio Board Mixer Driver */ +#define MM_MSFT_WSS_OEM_WAVEIN 18 /* MS OEM Audio Board waveform input */ +#define MM_MSFT_WSS_OEM_WAVEOUT 19 /* MS OEM Audio Board waveform output */ +#define MM_MSFT_WSS_OEM_FMSYNTH_STEREO 20 /* MS OEM Audio Board Stereo FM Synth */ +#define MM_MSFT_WSS_AUX 21 /* MS Audio Board Aux. Port */ +#define MM_MSFT_WSS_OEM_AUX 22 /* MS OEM Audio Aux Port */ +#define MM_MSFT_GENERIC_WAVEIN 23 /* MS Vanilla driver waveform input */ +#define MM_MSFT_GENERIC_WAVEOUT 24 /* MS Vanilla driver wavefrom output */ +#define MM_MSFT_GENERIC_MIDIIN 25 /* MS Vanilla driver MIDI in */ +#define MM_MSFT_GENERIC_MIDIOUT 26 /* MS Vanilla driver MIDI external out */ +#define MM_MSFT_GENERIC_MIDISYNTH 27 /* MS Vanilla driver MIDI synthesizer */ +#define MM_MSFT_GENERIC_AUX_LINE 28 /* MS Vanilla driver aux (line in) */ +#define MM_MSFT_GENERIC_AUX_MIC 29 /* MS Vanilla driver aux (mic) */ +#define MM_MSFT_GENERIC_AUX_CD 30 /* MS Vanilla driver aux (CD) */ +#define MM_MSFT_WSS_OEM_MIXER 31 /* MS OEM Audio Board Mixer Driver */ +#define MM_MSFT_MSACM 32 /* MS Audio Compression Manager */ +#define MM_MSFT_ACM_MSADPCM 33 /* MS ADPCM Codec */ +#define MM_MSFT_ACM_IMAADPCM 34 /* IMA ADPCM Codec */ +#define MM_MSFT_ACM_MSFILTER 35 /* MS Filter */ +#define MM_MSFT_ACM_GSM610 36 /* GSM 610 codec */ +#define MM_MSFT_ACM_G711 37 /* G.711 codec */ +#define MM_MSFT_ACM_PCM 38 /* PCM converter */ + + // Microsoft Windows Sound System drivers + +#define MM_WSS_SB16_WAVEIN 39 /* Sound Blaster 16 waveform input */ +#define MM_WSS_SB16_WAVEOUT 40 /* Sound Blaster 16 waveform output */ +#define MM_WSS_SB16_MIDIIN 41 /* Sound Blaster 16 midi-in */ +#define MM_WSS_SB16_MIDIOUT 42 /* Sound Blaster 16 midi out */ +#define MM_WSS_SB16_SYNTH 43 /* Sound Blaster 16 FM Synthesis */ +#define MM_WSS_SB16_AUX_LINE 44 /* Sound Blaster 16 aux (line in) */ +#define MM_WSS_SB16_AUX_CD 45 /* Sound Blaster 16 aux (CD) */ +#define MM_WSS_SB16_MIXER 46 /* Sound Blaster 16 mixer device */ +#define MM_WSS_SBPRO_WAVEIN 47 /* Sound Blaster Pro waveform input */ +#define MM_WSS_SBPRO_WAVEOUT 48 /* Sound Blaster Pro waveform output */ +#define MM_WSS_SBPRO_MIDIIN 49 /* Sound Blaster Pro midi in */ +#define MM_WSS_SBPRO_MIDIOUT 50 /* Sound Blaster Pro midi out */ +#define MM_WSS_SBPRO_SYNTH 51 /* Sound Blaster Pro FM synthesis */ +#define MM_WSS_SBPRO_AUX_LINE 52 /* Sound Blaster Pro aux (line in ) */ +#define MM_WSS_SBPRO_AUX_CD 53 /* Sound Blaster Pro aux (CD) */ +#define MM_WSS_SBPRO_MIXER 54 /* Sound Blaster Pro mixer */ +#define MM_MSFT_WSS_NT_WAVEIN 55 /* WSS NT wave in */ +#define MM_MSFT_WSS_NT_WAVEOUT 56 /* WSS NT wave out */ +#define MM_MSFT_WSS_NT_FMSYNTH_STEREO 57 /* WSS NT FM synth */ +#define MM_MSFT_WSS_NT_MIXER 58 /* WSS NT mixer */ +#define MM_MSFT_WSS_NT_AUX 59 /* WSS NT aux */ +#define MM_MSFT_SB16_WAVEIN 60 /* Sound Blaster 16 waveform input */ +#define MM_MSFT_SB16_WAVEOUT 61 /* Sound Blaster 16 waveform output */ +#define MM_MSFT_SB16_MIDIIN 62 /* Sound Blaster 16 midi-in */ +#define MM_MSFT_SB16_MIDIOUT 63 /* Sound Blaster 16 midi out */ +#define MM_MSFT_SB16_SYNTH 64 /* Sound Blaster 16 FM Synthesis */ +#define MM_MSFT_SB16_AUX_LINE 65 /* Sound Blaster 16 aux (line in) */ +#define MM_MSFT_SB16_AUX_CD 66 /* Sound Blaster 16 aux (CD) */ +#define MM_MSFT_SB16_MIXER 67 /* Sound Blaster 16 mixer device */ +#define MM_MSFT_SBPRO_WAVEIN 68 /* Sound Blaster Pro waveform input */ +#define MM_MSFT_SBPRO_WAVEOUT 69 /* Sound Blaster Pro waveform output */ +#define MM_MSFT_SBPRO_MIDIIN 70 /* Sound Blaster Pro midi in */ +#define MM_MSFT_SBPRO_MIDIOUT 71 /* Sound Blaster Pro midi out */ +#define MM_MSFT_SBPRO_SYNTH 72 /* Sound Blaster Pro FM synthesis */ +#define MM_MSFT_SBPRO_AUX_LINE 73 /* Sound Blaster Pro aux (line in) */ +#define MM_MSFT_SBPRO_AUX_CD 74 /* Sound Blaster Pro aux (CD) */ +#define MM_MSFT_SBPRO_MIXER 75 /* Sound Blaster Pro mixer */ + +#define MM_MSFT_MSOPL_SYNTH 76 /* Yamaha OPL2/OPL3 compatible FM synthesis */ + +#define MM_MSFT_VMDMS_LINE_WAVEIN 80 /* Voice Modem Serial Line Wave Input */ +#define MM_MSFT_VMDMS_LINE_WAVEOUT 81 /* Voice Modem Serial Line Wave Output */ +#define MM_MSFT_VMDMS_HANDSET_WAVEIN 82 /* Voice Modem Serial Handset Wave Input */ +#define MM_MSFT_VMDMS_HANDSET_WAVEOUT 83 /* Voice Modem Serial Handset Wave Output */ +#define MM_MSFT_VMDMW_LINE_WAVEIN 84 /* Voice Modem Wrapper Line Wave Input */ +#define MM_MSFT_VMDMW_LINE_WAVEOUT 85 /* Voice Modem Wrapper Line Wave Output */ +#define MM_MSFT_VMDMW_HANDSET_WAVEIN 86 /* Voice Modem Wrapper Handset Wave Input */ +#define MM_MSFT_VMDMW_HANDSET_WAVEOUT 87 /* Voice Modem Wrapper Handset Wave Output */ +#define MM_MSFT_VMDMW_MIXER 88 /* Voice Modem Wrapper Mixer */ +#define MM_MSFT_VMDM_GAME_WAVEOUT 89 /* Voice Modem Game Compatible Wave Device */ +#define MM_MSFT_VMDM_GAME_WAVEIN 90 /* Voice Modem Game Compatible Wave Device */ + +#define MM_MSFT_ACM_MSNAUDIO 91 +#define MM_MSFT_ACM_MSG723 92 +#define MM_MSFT_ACM_MSRT24 93 + +#define MM_MSFT_WDMAUDIO_WAVEOUT 100 /* Generic id for WDM Audio drivers */ +#define MM_MSFT_WDMAUDIO_WAVEIN 101 /* Generic id for WDM Audio drivers */ +#define MM_MSFT_WDMAUDIO_MIDIOUT 102 /* Generic id for WDM Audio drivers */ +#define MM_MSFT_WDMAUDIO_MIDIIN 103 /* Generic id for WDM Audio drivers */ +#define MM_MSFT_WDMAUDIO_MIXER 104 /* Generic id for WDM Audio drivers */ +#define MM_MSFT_WDMAUDIO_AUX 105 /* Generic id for WDM Audio drivers */ + + +/* MM_CREATIVE product IDs */ +#define MM_CREATIVE_SB15_WAVEIN 1 /* SB (r) 1.5 waveform input */ +#define MM_CREATIVE_SB20_WAVEIN 2 +#define MM_CREATIVE_SBPRO_WAVEIN 3 +#define MM_CREATIVE_SBP16_WAVEIN 4 +#define MM_CREATIVE_PHNBLST_WAVEIN 5 +#define MM_CREATIVE_SB15_WAVEOUT 101 +#define MM_CREATIVE_SB20_WAVEOUT 102 +#define MM_CREATIVE_SBPRO_WAVEOUT 103 +#define MM_CREATIVE_SBP16_WAVEOUT 104 +#define MM_CREATIVE_PHNBLST_WAVEOUT 105 +#define MM_CREATIVE_MIDIOUT 201 /* SB (r) */ +#define MM_CREATIVE_MIDIIN 202 /* SB (r) */ +#define MM_CREATIVE_FMSYNTH_MONO 301 /* SB (r) */ +#define MM_CREATIVE_FMSYNTH_STEREO 302 /* SB Pro (r) stereo synthesizer */ +#define MM_CREATIVE_MIDI_AWE32 303 +#define MM_CREATIVE_AUX_CD 401 /* SB Pro (r) aux (CD) */ +#define MM_CREATIVE_AUX_LINE 402 /* SB Pro (r) aux (Line in ) */ +#define MM_CREATIVE_AUX_MIC 403 /* SB Pro (r) aux (mic) */ +#define MM_CREATIVE_AUX_MASTER 404 +#define MM_CREATIVE_AUX_PCSPK 405 +#define MM_CREATIVE_AUX_WAVE 406 +#define MM_CREATIVE_AUX_MIDI 407 +#define MM_CREATIVE_SBPRO_MIXER 408 +#define MM_CREATIVE_SB16_MIXER 409 + +/* MM_MEDIAVISION product IDs */ + +// Pro Audio Spectrum +#define MM_MEDIAVISION_PROAUDIO 0x10 +#define MM_PROAUD_MIDIOUT (MM_MEDIAVISION_PROAUDIO+1) +#define MM_PROAUD_MIDIIN (MM_MEDIAVISION_PROAUDIO+2) +#define MM_PROAUD_SYNTH (MM_MEDIAVISION_PROAUDIO+3) +#define MM_PROAUD_WAVEOUT (MM_MEDIAVISION_PROAUDIO+4) +#define MM_PROAUD_WAVEIN (MM_MEDIAVISION_PROAUDIO+5) +#define MM_PROAUD_MIXER (MM_MEDIAVISION_PROAUDIO+6) +#define MM_PROAUD_AUX (MM_MEDIAVISION_PROAUDIO+7) + +// Thunder Board +#define MM_MEDIAVISION_THUNDER 0x20 +#define MM_THUNDER_SYNTH (MM_MEDIAVISION_THUNDER+3) +#define MM_THUNDER_WAVEOUT (MM_MEDIAVISION_THUNDER+4) +#define MM_THUNDER_WAVEIN (MM_MEDIAVISION_THUNDER+5) +#define MM_THUNDER_AUX (MM_MEDIAVISION_THUNDER+7) + +// Audio Port +#define MM_MEDIAVISION_TPORT 0x40 +#define MM_TPORT_WAVEOUT (MM_MEDIAVISION_TPORT+1) +#define MM_TPORT_WAVEIN (MM_MEDIAVISION_TPORT+2) +#define MM_TPORT_SYNTH (MM_MEDIAVISION_TPORT+3) + +// Pro Audio Spectrum Plus +#define MM_MEDIAVISION_PROAUDIO_PLUS 0x50 +#define MM_PROAUD_PLUS_MIDIOUT (MM_MEDIAVISION_PROAUDIO_PLUS+1) +#define MM_PROAUD_PLUS_MIDIIN (MM_MEDIAVISION_PROAUDIO_PLUS+2) +#define MM_PROAUD_PLUS_SYNTH (MM_MEDIAVISION_PROAUDIO_PLUS+3) +#define MM_PROAUD_PLUS_WAVEOUT (MM_MEDIAVISION_PROAUDIO_PLUS+4) +#define MM_PROAUD_PLUS_WAVEIN (MM_MEDIAVISION_PROAUDIO_PLUS+5) +#define MM_PROAUD_PLUS_MIXER (MM_MEDIAVISION_PROAUDIO_PLUS+6) +#define MM_PROAUD_PLUS_AUX (MM_MEDIAVISION_PROAUDIO_PLUS+7) + +// Pro Audio Spectrum 16 +#define MM_MEDIAVISION_PROAUDIO_16 0x60 +#define MM_PROAUD_16_MIDIOUT (MM_MEDIAVISION_PROAUDIO_16+1) +#define MM_PROAUD_16_MIDIIN (MM_MEDIAVISION_PROAUDIO_16+2) +#define MM_PROAUD_16_SYNTH (MM_MEDIAVISION_PROAUDIO_16+3) +#define MM_PROAUD_16_WAVEOUT (MM_MEDIAVISION_PROAUDIO_16+4) +#define MM_PROAUD_16_WAVEIN (MM_MEDIAVISION_PROAUDIO_16+5) +#define MM_PROAUD_16_MIXER (MM_MEDIAVISION_PROAUDIO_16+6) +#define MM_PROAUD_16_AUX (MM_MEDIAVISION_PROAUDIO_16+7) + +// Pro Audio Studio 16 +#define MM_MEDIAVISION_PROSTUDIO_16 0x60 +#define MM_STUDIO_16_MIDIOUT (MM_MEDIAVISION_PROSTUDIO_16+1) +#define MM_STUDIO_16_MIDIIN (MM_MEDIAVISION_PROSTUDIO_16+2) +#define MM_STUDIO_16_SYNTH (MM_MEDIAVISION_PROSTUDIO_16+3) +#define MM_STUDIO_16_WAVEOUT (MM_MEDIAVISION_PROSTUDIO_16+4) +#define MM_STUDIO_16_WAVEIN (MM_MEDIAVISION_PROSTUDIO_16+5) +#define MM_STUDIO_16_MIXER (MM_MEDIAVISION_PROSTUDIO_16+6) +#define MM_STUDIO_16_AUX (MM_MEDIAVISION_PROSTUDIO_16+7) + +// CDPC +#define MM_MEDIAVISION_CDPC 0x70 +#define MM_CDPC_MIDIOUT (MM_MEDIAVISION_CDPC+1) +#define MM_CDPC_MIDIIN (MM_MEDIAVISION_CDPC+2) +#define MM_CDPC_SYNTH (MM_MEDIAVISION_CDPC+3) +#define MM_CDPC_WAVEOUT (MM_MEDIAVISION_CDPC+4) +#define MM_CDPC_WAVEIN (MM_MEDIAVISION_CDPC+5) +#define MM_CDPC_MIXER (MM_MEDIAVISION_CDPC+6) +#define MM_CDPC_AUX (MM_MEDIAVISION_CDPC+7) + +// Opus MV 1208 Chipsent +#define MM_MEDIAVISION_OPUS1208 0x80 +#define MM_OPUS401_MIDIOUT (MM_MEDIAVISION_OPUS1208+1) +#define MM_OPUS401_MIDIIN (MM_MEDIAVISION_OPUS1208+2) +#define MM_OPUS1208_SYNTH (MM_MEDIAVISION_OPUS1208+3) +#define MM_OPUS1208_WAVEOUT (MM_MEDIAVISION_OPUS1208+4) +#define MM_OPUS1208_WAVEIN (MM_MEDIAVISION_OPUS1208+5) +#define MM_OPUS1208_MIXER (MM_MEDIAVISION_OPUS1208+6) +#define MM_OPUS1208_AUX (MM_MEDIAVISION_OPUS1208+7) + +// Opus MV 1216 chipset +#define MM_MEDIAVISION_OPUS1216 0x90 +#define MM_OPUS1216_MIDIOUT (MM_MEDIAVISION_OPUS1216+1) +#define MM_OPUS1216_MIDIIN (MM_MEDIAVISION_OPUS1216+2) +#define MM_OPUS1216_SYNTH (MM_MEDIAVISION_OPUS1216+3) +#define MM_OPUS1216_WAVEOUT (MM_MEDIAVISION_OPUS1216+4) +#define MM_OPUS1216_WAVEIN (MM_MEDIAVISION_OPUS1216+5) +#define MM_OPUS1216_MIXER (MM_MEDIAVISION_OPUS1216+6) +#define MM_OPUS1216_AUX (MM_MEDIAVISION_OPUS1216+7) + +/* MM_CYRIX product IDs */ +#define MM_CYRIX_XASYNTH 1 +#define MM_CYRIX_XAMIDIIN 2 +#define MM_CYRIX_XAMIDIOUT 3 +#define MM_CYRIX_XAWAVEIN 4 +#define MM_CYRIX_XAWAVEOUT 5 +#define MM_CYRIX_XAAUX 6 +#define MM_CYRIX_XAMIXER 7 + +/* MM_PHILIPS_SPEECH_PROCESSING products IDs */ +#define MM_PHILIPS_ACM_LPCBB 1 + +/* MM_NETXL product IDs */ +#define MM_NETXL_XLVIDEO 1 + +/* MM_ZYXEL product IDs */ +#define MM_ZYXEL_ACM_ADPCM 1 + +/* MM_AARDVARK product IDs */ +#define MM_AARDVARK_STUDIO12_WAVEOUT 1 +#define MM_AARDVARK_STUDIO12_WAVEIN 2 +#define MM_AARDVARK_STUDIO88_WAVEOUT 3 +#define MM_AARDVARK_STUDIO88_WAVEIN 4 + +/* MM_BINTEC product IDs */ +#define MM_BINTEC_TAPI_WAVE 1 + +/* MM_HEWLETT_PACKARD product IDs */ +#define MM_HEWLETT_PACKARD_CU_CODEC 1 + +/* MM_MITEL product IDs */ +#define MM_MITEL_TALKTO_LINE_WAVEOUT 100 +#define MM_MITEL_TALKTO_LINE_WAVEIN 101 +#define MM_MITEL_TALKTO_HANDSET_WAVEOUT 102 +#define MM_MITEL_TALKTO_HANDSET_WAVEIN 103 +#define MM_MITEL_TALKTO_BRIDGED_WAVEOUT 104 +#define MM_MITEL_TALKTO_BRIDGED_WAVEIN 105 +#define MM_MITEL_MPA_HANDSET_WAVEOUT 200 +#define MM_MITEL_MPA_HANDSET_WAVEIN 201 +#define MM_MITEL_MPA_HANDSFREE_WAVEOUT 202 +#define MM_MITEL_MPA_HANDSFREE_WAVEIN 203 +#define MM_MITEL_MPA_LINE1_WAVEOUT 204 +#define MM_MITEL_MPA_LINE1_WAVEIN 205 +#define MM_MITEL_MPA_LINE2_WAVEOUT 206 +#define MM_MITEL_MPA_LINE2_WAVEIN 207 +#define MM_MITEL_MEDIAPATH_WAVEOUT 300 +#define MM_MITEL_MEDIAPATH_WAVEIN 301 + +/* MM_SNI product IDs */ +#define MM_SNI_ACM_G721 1 + +/* MM_EMU product IDs */ +#define MM_EMU_APSSYNTH 1 +#define MM_EMU_APSMIDIIN 2 +#define MM_EMU_APSMIDIOUT 3 +#define MM_EMU_APSWAVEIN 4 +#define MM_EMU_APSWAVEOUT 5 + +/* MM_ARTISOFT product IDs */ +#define MM_ARTISOFT_SBWAVEIN 1 /* Artisoft sounding Board waveform input */ +#define MM_ARTISOFT_SBWAVEOUT 2 /* Artisoft sounding Board waveform output */ + +/* MM_TURTLE_BEACH product IDs */ +#define MM_TBS_TROPEZ_WAVEIN 37 +#define MM_TBS_TROPEZ_WAVEOUT 38 +#define MM_TBS_TROPEZ_AUX1 39 +#define MM_TBS_TROPEZ_AUX2 40 +#define MM_TBS_TROPEZ_LINE 41 + +/* MM_IBM product IDs */ +#define MM_MMOTION_WAVEAUX 1 /* IBM M-Motion Auxiliary Device */ +#define MM_MMOTION_WAVEOUT 2 /* IBM M-Motion Waveform output */ +#define MM_MMOTION_WAVEIN 3 /* IBM M-Motion Waveform Input */ +#define MM_IBM_PCMCIA_WAVEIN 11 /* IBM waveform input */ +#define MM_IBM_PCMCIA_WAVEOUT 12 /* IBM Waveform output */ +#define MM_IBM_PCMCIA_SYNTH 13 /* IBM Midi Synthesis */ +#define MM_IBM_PCMCIA_MIDIIN 14 /* IBM external MIDI in */ +#define MM_IBM_PCMCIA_MIDIOUT 15 /* IBM external MIDI out */ +#define MM_IBM_PCMCIA_AUX 16 /* IBM auxiliary control */ +#define MM_IBM_THINKPAD200 17 +#define MM_IBM_MWAVE_WAVEIN 18 +#define MM_IBM_MWAVE_WAVEOUT 19 +#define MM_IBM_MWAVE_MIXER 20 +#define MM_IBM_MWAVE_MIDIIN 21 +#define MM_IBM_MWAVE_MIDIOUT 22 +#define MM_IBM_MWAVE_AUX 23 +#define MM_IBM_WC_MIDIOUT 30 +#define MM_IBM_WC_WAVEOUT 31 +#define MM_IBM_WC_MIXEROUT 33 + +/* MM_VOCALTEC product IDs */ +#define MM_VOCALTEC_WAVEOUT 1 +#define MM_VOCALTEC_WAVEIN 2 + +/* MM_ROLAND product IDs */ +#define MM_ROLAND_RAP10_MIDIOUT 10 /* MM_ROLAND_RAP10 */ +#define MM_ROLAND_RAP10_MIDIIN 11 /* MM_ROLAND_RAP10 */ +#define MM_ROLAND_RAP10_SYNTH 12 /* MM_ROLAND_RAP10 */ +#define MM_ROLAND_RAP10_WAVEOUT 13 /* MM_ROLAND_RAP10 */ +#define MM_ROLAND_RAP10_WAVEIN 14 /* MM_ROLAND_RAP10 */ +#define MM_ROLAND_MPU401_MIDIOUT 15 +#define MM_ROLAND_MPU401_MIDIIN 16 +#define MM_ROLAND_SMPU_MIDIOUTA 17 +#define MM_ROLAND_SMPU_MIDIOUTB 18 +#define MM_ROLAND_SMPU_MIDIINA 19 +#define MM_ROLAND_SMPU_MIDIINB 20 +#define MM_ROLAND_SC7_MIDIOUT 21 +#define MM_ROLAND_SC7_MIDIIN 22 +#define MM_ROLAND_SERIAL_MIDIOUT 23 +#define MM_ROLAND_SERIAL_MIDIIN 24 +#define MM_ROLAND_SCP_MIDIOUT 38 +#define MM_ROLAND_SCP_MIDIIN 39 +#define MM_ROLAND_SCP_WAVEOUT 40 +#define MM_ROLAND_SCP_WAVEIN 41 +#define MM_ROLAND_SCP_MIXER 42 +#define MM_ROLAND_SCP_AUX 48 + +/* MM_DSP_SOLUTIONS product IDs */ +#define MM_DSP_SOLUTIONS_WAVEOUT 1 +#define MM_DSP_SOLUTIONS_WAVEIN 2 +#define MM_DSP_SOLUTIONS_SYNTH 3 +#define MM_DSP_SOLUTIONS_AUX 4 + +/* MM_NEC product IDs */ +#define MM_NEC_73_86_SYNTH 5 +#define MM_NEC_73_86_WAVEOUT 6 +#define MM_NEC_73_86_WAVEIN 7 +#define MM_NEC_26_SYNTH 9 +#define MM_NEC_MPU401_MIDIOUT 10 +#define MM_NEC_MPU401_MIDIIN 11 +#define MM_NEC_JOYSTICK 12 + +/* MM_WANGLABS product IDs */ +#define MM_WANGLABS_WAVEIN1 1 /* Input audio wave on CPU board models: Exec 4010, 4030, 3450; PC 251/25c, pc 461/25s , pc 461/33c */ +#define MM_WANGLABS_WAVEOUT1 2 + +/* MM_TANDY product IDs */ +#define MM_TANDY_VISWAVEIN 1 +#define MM_TANDY_VISWAVEOUT 2 +#define MM_TANDY_VISBIOSSYNTH 3 +#define MM_TANDY_SENS_MMAWAVEIN 4 +#define MM_TANDY_SENS_MMAWAVEOUT 5 +#define MM_TANDY_SENS_MMAMIDIIN 6 +#define MM_TANDY_SENS_MMAMIDIOUT 7 +#define MM_TANDY_SENS_VISWAVEOUT 8 +#define MM_TANDY_PSSJWAVEIN 9 +#define MM_TANDY_PSSJWAVEOUT 10 + +/* MM_ANTEX product IDs */ +#define MM_ANTEX_SX12_WAVEIN 1 +#define MM_ANTEX_SX12_WAVEOUT 2 +#define MM_ANTEX_SX15_WAVEIN 3 +#define MM_ANTEX_SX15_WAVEOUT 4 +#define MM_ANTEX_VP625_WAVEIN 5 +#define MM_ANTEX_VP625_WAVEOUT 6 +#define MM_ANTEX_AUDIOPORT22_WAVEIN 7 +#define MM_ANTEX_AUDIOPORT22_WAVEOUT 8 +#define MM_ANTEX_AUDIOPORT22_FEEDTHRU 9 + +/* MM_INTEL product IDs */ +#define MM_INTELOPD_WAVEIN 1 /* HID2 WaveAudio Driver */ +#define MM_INTELOPD_WAVEOUT 101 /* HID2 */ +#define MM_INTELOPD_AUX 401 /* HID2 for mixing */ +#define MM_INTEL_NSPMODEMLINEIN 501 +#define MM_INTEL_NSPMODEMLINEOUT 502 + +/* MM_VAL product IDs */ +#define MM_VAL_MICROKEY_AP_WAVEIN 1 +#define MM_VAL_MICROKEY_AP_WAVEOUT 2 + +/* MM_INTERACTIVE product IDs */ +#define MM_INTERACTIVE_WAVEIN 0x45 +#define MM_INTERACTIVE_WAVEOUT 0x45 + +/* MM_YAMAHA product IDs */ +#define MM_YAMAHA_GSS_SYNTH 0x01 +#define MM_YAMAHA_GSS_WAVEOUT 0x02 +#define MM_YAMAHA_GSS_WAVEIN 0x03 +#define MM_YAMAHA_GSS_MIDIOUT 0x04 +#define MM_YAMAHA_GSS_MIDIIN 0x05 +#define MM_YAMAHA_GSS_AUX 0x06 +#define MM_YAMAHA_SERIAL_MIDIOUT 0x07 +#define MM_YAMAHA_SERIAL_MIDIIN 0x08 +#define MM_YAMAHA_OPL3SA_WAVEOUT 0x10 +#define MM_YAMAHA_OPL3SA_WAVEIN 0x11 +#define MM_YAMAHA_OPL3SA_FMSYNTH 0x12 +#define MM_YAMAHA_OPL3SA_YSYNTH 0x13 +#define MM_YAMAHA_OPL3SA_MIDIOUT 0x14 +#define MM_YAMAHA_OPL3SA_MIDIIN 0x15 +#define MM_YAMAHA_OPL3SA_MIXER 0x17 +#define MM_YAMAHA_OPL3SA_JOYSTICK 0x18 +#define MM_YAMAHA_YMF724LEG_MIDIOUT 0x19 +#define MM_YAMAHA_YMF724LEG_MIDIIN 0x1a +#define MM_YAMAHA_YMF724_WAVEOUT 0x1b +#define MM_YAMAHA_YMF724_WAVEIN 0x1c +#define MM_YAMAHA_YMF724_MIDIOUT 0x1d +#define MM_YAMAHA_YMF724_AUX 0x1e +#define MM_YAMAHA_YMF724_MIXER 0x1f +#define MM_YAMAHA_YMF724LEG_FMSYNTH 0x20 +#define MM_YAMAHA_YMF724LEG_MIXER 0x21 +#define MM_YAMAHA_SXG_MIDIOUT 0x22 +#define MM_YAMAHA_SXG_WAVEOUT 0x23 +#define MM_YAMAHA_SXG_MIXER 0x24 +#define MM_YAMAHA_ACXG_WAVEIN 0x25 +#define MM_YAMAHA_ACXG_WAVEOUT 0x26 +#define MM_YAMAHA_ACXG_MIDIOUT 0x27 +#define MM_YAMAHA_ACXG_MIXER 0x28 +#define MM_YAMAHA_ACXG_AUX 0x29 + +/* MM_EVEREX product IDs */ +#define MM_EVEREX_CARRIER 1 + +/* MM_ECHO product IDs */ +#define MM_ECHO_SYNTH 1 +#define MM_ECHO_WAVEOUT 2 +#define MM_ECHO_WAVEIN 3 +#define MM_ECHO_MIDIOUT 4 +#define MM_ECHO_MIDIIN 5 +#define MM_ECHO_AUX 6 + +/* MM_SIERRA product IDs */ +#define MM_SIERRA_ARIA_MIDIOUT 0x14 +#define MM_SIERRA_ARIA_MIDIIN 0x15 +#define MM_SIERRA_ARIA_SYNTH 0x16 +#define MM_SIERRA_ARIA_WAVEOUT 0x17 +#define MM_SIERRA_ARIA_WAVEIN 0x18 +#define MM_SIERRA_ARIA_AUX 0x19 +#define MM_SIERRA_ARIA_AUX2 0x20 +#define MM_SIERRA_QUARTET_WAVEIN 0x50 +#define MM_SIERRA_QUARTET_WAVEOUT 0x51 +#define MM_SIERRA_QUARTET_MIDIIN 0x52 +#define MM_SIERRA_QUARTET_MIDIOUT 0x53 +#define MM_SIERRA_QUARTET_SYNTH 0x54 +#define MM_SIERRA_QUARTET_AUX_CD 0x55 +#define MM_SIERRA_QUARTET_AUX_LINE 0x56 +#define MM_SIERRA_QUARTET_AUX_MODEM 0x57 +#define MM_SIERRA_QUARTET_MIXER 0x58 + +/* MM_CAT product IDs */ +#define MM_CAT_WAVEOUT 1 + +/* MM_DSP_GROUP product IDs */ +#define MM_DSP_GROUP_TRUESPEECH 1 + +/* MM_MELABS product IDs */ +#define MM_MELABS_MIDI2GO 1 + +/* MM_ESS product IDs */ +#define MM_ESS_AMWAVEOUT 0x01 +#define MM_ESS_AMWAVEIN 0x02 +#define MM_ESS_AMAUX 0x03 +#define MM_ESS_AMSYNTH 0x04 +#define MM_ESS_AMMIDIOUT 0x05 +#define MM_ESS_AMMIDIIN 0x06 +#define MM_ESS_MIXER 0x07 +#define MM_ESS_AUX_CD 0x08 +#define MM_ESS_MPU401_MIDIOUT 0x09 +#define MM_ESS_MPU401_MIDIIN 0x0A +#define MM_ESS_ES488_WAVEOUT 0x10 +#define MM_ESS_ES488_WAVEIN 0x11 +#define MM_ESS_ES488_MIXER 0x12 +#define MM_ESS_ES688_WAVEOUT 0x13 +#define MM_ESS_ES688_WAVEIN 0x14 +#define MM_ESS_ES688_MIXER 0x15 +#define MM_ESS_ES1488_WAVEOUT 0x16 +#define MM_ESS_ES1488_WAVEIN 0x17 +#define MM_ESS_ES1488_MIXER 0x18 +#define MM_ESS_ES1688_WAVEOUT 0x19 +#define MM_ESS_ES1688_WAVEIN 0x1A +#define MM_ESS_ES1688_MIXER 0x1B +#define MM_ESS_ES1788_WAVEOUT 0x1C +#define MM_ESS_ES1788_WAVEIN 0x1D +#define MM_ESS_ES1788_MIXER 0x1E +#define MM_ESS_ES1888_WAVEOUT 0x1F +#define MM_ESS_ES1888_WAVEIN 0x20 +#define MM_ESS_ES1888_MIXER 0x21 +#define MM_ESS_ES1868_WAVEOUT 0x22 +#define MM_ESS_ES1868_WAVEIN 0x23 +#define MM_ESS_ES1868_MIXER 0x24 +#define MM_ESS_ES1878_WAVEOUT 0x25 +#define MM_ESS_ES1878_WAVEIN 0x26 +#define MM_ESS_ES1878_MIXER 0x27 + +/* MM_CANOPUS product IDs */ +#define MM_CANOPUS_ACM_DVREX 1 + +/* MM_EPSON product IDs */ +#define MM_EPS_FMSND 1 + +/* MM_TRUEVISION product IDs */ +#define MM_TRUEVISION_WAVEIN1 1 +#define MM_TRUEVISION_WAVEOUT1 2 + +/* MM_AZTECH product IDs */ +#define MM_AZTECH_MIDIOUT 3 +#define MM_AZTECH_MIDIIN 4 +#define MM_AZTECH_WAVEIN 17 +#define MM_AZTECH_WAVEOUT 18 +#define MM_AZTECH_FMSYNTH 20 +#define MM_AZTECH_MIXER 21 +#define MM_AZTECH_PRO16_WAVEIN 33 +#define MM_AZTECH_PRO16_WAVEOUT 34 +#define MM_AZTECH_PRO16_FMSYNTH 38 +#define MM_AZTECH_DSP16_WAVEIN 65 +#define MM_AZTECH_DSP16_WAVEOUT 66 +#define MM_AZTECH_DSP16_FMSYNTH 68 +#define MM_AZTECH_DSP16_WAVESYNTH 70 +#define MM_AZTECH_NOVA16_WAVEIN 71 +#define MM_AZTECH_NOVA16_WAVEOUT 72 +#define MM_AZTECH_NOVA16_MIXER 73 +#define MM_AZTECH_WASH16_WAVEIN 74 +#define MM_AZTECH_WASH16_WAVEOUT 75 +#define MM_AZTECH_WASH16_MIXER 76 +#define MM_AZTECH_AUX_CD 401 +#define MM_AZTECH_AUX_LINE 402 +#define MM_AZTECH_AUX_MIC 403 +#define MM_AZTECH_AUX 404 + +/* MM_VIDEOLOGIC product IDs */ +#define MM_VIDEOLOGIC_MSWAVEIN 1 +#define MM_VIDEOLOGIC_MSWAVEOUT 2 + +/* MM_KORG product IDs */ +#define MM_KORG_PCIF_MIDIOUT 1 +#define MM_KORG_PCIF_MIDIIN 2 +#define MM_KORG_1212IO_MSWAVEIN 3 +#define MM_KORG_1212IO_MSWAVEOUT 4 + +/* MM_APT product IDs */ +#define MM_APT_ACE100CD 1 + +/* MM_ICS product IDs */ +#define MM_ICS_WAVEDECK_WAVEOUT 1 /* MS WSS compatible card and driver */ +#define MM_ICS_WAVEDECK_WAVEIN 2 +#define MM_ICS_WAVEDECK_MIXER 3 +#define MM_ICS_WAVEDECK_AUX 4 +#define MM_ICS_WAVEDECK_SYNTH 5 +#define MM_ICS_WAVEDEC_SB_WAVEOUT 6 +#define MM_ICS_WAVEDEC_SB_WAVEIN 7 +#define MM_ICS_WAVEDEC_SB_FM_MIDIOUT 8 +#define MM_ICS_WAVEDEC_SB_MPU401_MIDIOUT 9 +#define MM_ICS_WAVEDEC_SB_MPU401_MIDIIN 10 +#define MM_ICS_WAVEDEC_SB_MIXER 11 +#define MM_ICS_WAVEDEC_SB_AUX 12 +#define MM_ICS_2115_LITE_MIDIOUT 13 +#define MM_ICS_2120_LITE_MIDIOUT 14 + +/* MM_ITERATEDSYS product IDs */ +#define MM_ITERATEDSYS_FUFCODEC 1 + +/* MM_METHEUS product IDs */ +#define MM_METHEUS_ZIPPER 1 + +/* MM_WINNOV product IDs */ +#define MM_WINNOV_CAVIAR_WAVEIN 1 +#define MM_WINNOV_CAVIAR_WAVEOUT 2 +#define MM_WINNOV_CAVIAR_VIDC 3 +#define MM_WINNOV_CAVIAR_CHAMPAGNE 4 /* Fourcc is CHAM */ +#define MM_WINNOV_CAVIAR_YUV8 5 /* Fourcc is YUV8 */ + +/* MM_NCR product IDs */ +#define MM_NCR_BA_WAVEIN 1 +#define MM_NCR_BA_WAVEOUT 2 +#define MM_NCR_BA_SYNTH 3 +#define MM_NCR_BA_AUX 4 +#define MM_NCR_BA_MIXER 5 + +/* MM_AST product IDs */ +#define MM_AST_MODEMWAVE_WAVEIN 13 +#define MM_AST_MODEMWAVE_WAVEOUT 14 + +/* MM_WILLOWPOND product IDs */ +#define MM_WILLOWPOND_FMSYNTH_STEREO 20 +#define MM_WILLOWPOND_MPU401 21 +#define MM_WILLOWPOND_SNDPORT_WAVEIN 100 +#define MM_WILLOWPOND_SNDPORT_WAVEOUT 101 +#define MM_WILLOWPOND_SNDPORT_MIXER 102 +#define MM_WILLOWPOND_SNDPORT_AUX 103 +#define MM_WILLOWPOND_PH_WAVEIN 104 +#define MM_WILLOWPOND_PH_WAVEOUT 105 +#define MM_WILLOWPOND_PH_MIXER 106 +#define MM_WILLOWPOND_PH_AUX 107 +#define MM_WILLOPOND_SNDCOMM_WAVEIN 108 +#define MM_WILLOWPOND_SNDCOMM_WAVEOUT 109 +#define MM_WILLOWPOND_SNDCOMM_MIXER 110 +#define MM_WILLOWPOND_SNDCOMM_AUX 111 +#define MM_WILLOWPOND_GENERIC_WAVEIN 112 +#define MM_WILLOWPOND_GENERIC_WAVEOUT 113 +#define MM_WILLOWPOND_GENERIC_MIXER 114 +#define MM_WILLOWPOND_GENERIC_AUX 115 + +/* MM_VITEC product IDs */ +#define MM_VITEC_VMAKER 1 +#define MM_VITEC_VMPRO 2 + +/* MM_MOSCOM product IDs */ +#define MM_MOSCOM_VPC2400_IN 1 /* Four Port Voice Processing / Voice Recognition Board */ +#define MM_MOSCOM_VPC2400_OUT 2 /* VPC2400 */ + +/* MM_SILICONSOFT product IDs */ +#define MM_SILICONSOFT_SC1_WAVEIN 1 /* Waveform in , high sample rate */ +#define MM_SILICONSOFT_SC1_WAVEOUT 2 /* Waveform out , high sample rate */ +#define MM_SILICONSOFT_SC2_WAVEIN 3 /* Waveform in 2 channels, high sample rate */ +#define MM_SILICONSOFT_SC2_WAVEOUT 4 /* Waveform out 2 channels, high sample rate */ +#define MM_SILICONSOFT_SOUNDJR2_WAVEOUT 5 /* Waveform out, self powered, efficient */ +#define MM_SILICONSOFT_SOUNDJR2PR_WAVEIN 6 /* Waveform in, self powered, efficient */ +#define MM_SILICONSOFT_SOUNDJR2PR_WAVEOUT 7 /* Waveform out 2 channels, self powered, efficient */ +#define MM_SILICONSOFT_SOUNDJR3_WAVEOUT 8 /* Waveform in 2 channels, self powered, efficient */ + +/* MM_TERRATEC product IDs */ +#define MM_TTEWS_WAVEIN 1 +#define MM_TTEWS_WAVEOUT 2 +#define MM_TTEWS_MIDIIN 3 +#define MM_TTEWS_MIDIOUT 4 +#define MM_TTEWS_MIDISYNTH 5 +#define MM_TTEWS_MIDIMONITOR 6 +#define MM_TTEWS_VMIDIIN 7 +#define MM_TTEWS_VMIDIOUT 8 +#define MM_TTEWS_AUX 9 +#define MM_TTEWS_MIXER 10 + +/* MM_MEDIASONIC product IDs */ +#define MM_MEDIASONIC_ACM_G723 1 +#define MM_MEDIASONIC_ICOM 2 +#define MM_ICOM_WAVEIN 3 +#define MM_ICOM_WAVEOUT 4 +#define MM_ICOM_MIXER 5 +#define MM_ICOM_AUX 6 +#define MM_ICOM_LINE 7 + +/* MM_SANYO product IDs */ +#define MM_SANYO_ACM_LD_ADPCM 1 + +/* MM_AHEAD product IDs */ +#define MM_AHEAD_MULTISOUND 1 +#define MM_AHEAD_SOUNDBLASTER 2 +#define MM_AHEAD_PROAUDIO 3 +#define MM_AHEAD_GENERIC 4 + +/* MM_OLIVETTI product IDs */ +#define MM_OLIVETTI_WAVEIN 1 +#define MM_OLIVETTI_WAVEOUT 2 +#define MM_OLIVETTI_MIXER 3 +#define MM_OLIVETTI_AUX 4 +#define MM_OLIVETTI_MIDIIN 5 +#define MM_OLIVETTI_MIDIOUT 6 +#define MM_OLIVETTI_SYNTH 7 +#define MM_OLIVETTI_JOYSTICK 8 +#define MM_OLIVETTI_ACM_GSM 9 +#define MM_OLIVETTI_ACM_ADPCM 10 +#define MM_OLIVETTI_ACM_CELP 11 +#define MM_OLIVETTI_ACM_SBC 12 +#define MM_OLIVETTI_ACM_OPR 13 + +/* MM_IOMAGIC product IDs */ +#define MM_IOMAGIC_TEMPO_WAVEOUT 1 +#define MM_IOMAGIC_TEMPO_WAVEIN 2 +#define MM_IOMAGIC_TEMPO_SYNTH 3 +#define MM_IOMAGIC_TEMPO_MIDIOUT 4 +#define MM_IOMAGIC_TEMPO_MXDOUT 5 +#define MM_IOMAGIC_TEMPO_AUXOUT 6 + +/* MM_MATSUSHITA product IDs */ +#define MM_MATSUSHITA_WAVEIN 1 +#define MM_MATSUSHITA_WAVEOUT 2 +#define MM_MATSUSHITA_FMSYNTH_STEREO 3 +#define MM_MATSUSHITA_MIXER 4 +#define MM_MATSUSHITA_AUX 5 + +/* MM_NEWMEDIA product IDs */ +#define MM_NEWMEDIA_WAVJAMMER 1 /* WSS Compatible sound card. */ + +/* MM_LYRRUS product IDs */ +#define MM_LYRRUS_BRIDGE_GUITAR 1 + +/* MM_OPTI product IDs */ +#define MM_OPTI_M16_FMSYNTH_STEREO 0x0001 +#define MM_OPTI_M16_MIDIIN 0x0002 +#define MM_OPTI_M16_MIDIOUT 0x0003 +#define MM_OPTI_M16_WAVEIN 0x0004 +#define MM_OPTI_M16_WAVEOUT 0x0005 +#define MM_OPTI_M16_MIXER 0x0006 +#define MM_OPTI_M16_AUX 0x0007 +#define MM_OPTI_P16_FMSYNTH_STEREO 0x0010 +#define MM_OPTI_P16_MIDIIN 0x0011 +#define MM_OPTI_P16_MIDIOUT 0x0012 +#define MM_OPTI_P16_WAVEIN 0x0013 +#define MM_OPTI_P16_WAVEOUT 0x0014 +#define MM_OPTI_P16_MIXER 0x0015 +#define MM_OPTI_P16_AUX 0x0016 +#define MM_OPTI_M32_WAVEIN 0x0020 +#define MM_OPTI_M32_WAVEOUT 0x0021 +#define MM_OPTI_M32_MIDIIN 0x0022 +#define MM_OPTI_M32_MIDIOUT 0x0023 +#define MM_OPTI_M32_SYNTH_STEREO 0x0024 +#define MM_OPTI_M32_MIXER 0x0025 +#define MM_OPTI_M32_AUX 0x0026 + +/* MM_COMPAQ product IDs */ +#define MM_COMPAQ_BB_WAVEIN 1 +#define MM_COMPAQ_BB_WAVEOUT 2 +#define MM_COMPAQ_BB_WAVEAUX 3 + +/* MM_MPTUS product IDs */ +#define MM_MPTUS_SPWAVEOUT 1 /* Sound Pallette */ + +/* MM_LERNOUT_AND_HAUSPIE product IDs */ +#define MM_LERNOUT_ANDHAUSPIE_LHCODECACM 1 + +/* MM_DIGITAL product IDs */ +#define MM_DIGITAL_AV320_WAVEIN 1 /* Digital Audio Video Compression Board */ +#define MM_DIGITAL_AV320_WAVEOUT 2 /* Digital Audio Video Compression Board */ +#define MM_DIGITAL_ACM_G723 3 +#define MM_DIGITAL_ICM_H263 4 +#define MM_DIGITAL_ICM_H261 5 + +/* MM_MOTU product IDs */ +#define MM_MOTU_MTP_MIDIOUT_ALL 100 +#define MM_MOTU_MTP_MIDIIN_1 101 +#define MM_MOTU_MTP_MIDIOUT_1 101 +#define MM_MOTU_MTP_MIDIIN_2 102 +#define MM_MOTU_MTP_MIDIOUT_2 102 +#define MM_MOTU_MTP_MIDIIN_3 103 +#define MM_MOTU_MTP_MIDIOUT_3 103 +#define MM_MOTU_MTP_MIDIIN_4 104 +#define MM_MOTU_MTP_MIDIOUT_4 104 +#define MM_MOTU_MTP_MIDIIN_5 105 +#define MM_MOTU_MTP_MIDIOUT_5 105 +#define MM_MOTU_MTP_MIDIIN_6 106 +#define MM_MOTU_MTP_MIDIOUT_6 106 +#define MM_MOTU_MTP_MIDIIN_7 107 +#define MM_MOTU_MTP_MIDIOUT_7 107 +#define MM_MOTU_MTP_MIDIIN_8 108 +#define MM_MOTU_MTP_MIDIOUT_8 108 + +#define MM_MOTU_MTPII_MIDIOUT_ALL 200 +#define MM_MOTU_MTPII_MIDIIN_SYNC 200 +#define MM_MOTU_MTPII_MIDIIN_1 201 +#define MM_MOTU_MTPII_MIDIOUT_1 201 +#define MM_MOTU_MTPII_MIDIIN_2 202 +#define MM_MOTU_MTPII_MIDIOUT_2 202 +#define MM_MOTU_MTPII_MIDIIN_3 203 +#define MM_MOTU_MTPII_MIDIOUT_3 203 +#define MM_MOTU_MTPII_MIDIIN_4 204 +#define MM_MOTU_MTPII_MIDIOUT_4 204 +#define MM_MOTU_MTPII_MIDIIN_5 205 +#define MM_MOTU_MTPII_MIDIOUT_5 205 +#define MM_MOTU_MTPII_MIDIIN_6 206 +#define MM_MOTU_MTPII_MIDIOUT_6 206 +#define MM_MOTU_MTPII_MIDIIN_7 207 +#define MM_MOTU_MTPII_MIDIOUT_7 207 +#define MM_MOTU_MTPII_MIDIIN_8 208 +#define MM_MOTU_MTPII_MIDIOUT_8 208 +#define MM_MOTU_MTPII_NET_MIDIIN_1 209 +#define MM_MOTU_MTPII_NET_MIDIOUT_1 209 +#define MM_MOTU_MTPII_NET_MIDIIN_2 210 +#define MM_MOTU_MTPII_NET_MIDIOUT_2 210 +#define MM_MOTU_MTPII_NET_MIDIIN_3 211 +#define MM_MOTU_MTPII_NET_MIDIOUT_3 211 +#define MM_MOTU_MTPII_NET_MIDIIN_4 212 +#define MM_MOTU_MTPII_NET_MIDIOUT_4 212 +#define MM_MOTU_MTPII_NET_MIDIIN_5 213 +#define MM_MOTU_MTPII_NET_MIDIOUT_5 213 +#define MM_MOTU_MTPII_NET_MIDIIN_6 214 +#define MM_MOTU_MTPII_NET_MIDIOUT_6 214 +#define MM_MOTU_MTPII_NET_MIDIIN_7 215 +#define MM_MOTU_MTPII_NET_MIDIOUT_7 215 +#define MM_MOTU_MTPII_NET_MIDIIN_8 216 +#define MM_MOTU_MTPII_NET_MIDIOUT_8 216 + +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_ALL 300 +#define MM_MOTU_MXP_MIDIIN_SYNC 300 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_1 301 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_1 301 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_2 302 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_2 302 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_3 303 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_3 303 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_4 304 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_4 304 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_5 305 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_5 305 +#define MM_MOTU_MXP_MIDIIN_MIDIIN_6 306 +#define MM_MOTU_MXP_MIDIIN_MIDIOUT_6 306 + +#define MM_MOTU_MXPMPU_MIDIOUT_ALL 400 +#define MM_MOTU_MXPMPU_MIDIIN_SYNC 400 +#define MM_MOTU_MXPMPU_MIDIIN_1 401 +#define MM_MOTU_MXPMPU_MIDIOUT_1 401 +#define MM_MOTU_MXPMPU_MIDIIN_2 402 +#define MM_MOTU_MXPMPU_MIDIOUT_2 402 +#define MM_MOTU_MXPMPU_MIDIIN_3 403 +#define MM_MOTU_MXPMPU_MIDIOUT_3 403 +#define MM_MOTU_MXPMPU_MIDIIN_4 404 +#define MM_MOTU_MXPMPU_MIDIOUT_4 404 +#define MM_MOTU_MXPMPU_MIDIIN_5 405 +#define MM_MOTU_MXPMPU_MIDIOUT_5 405 +#define MM_MOTU_MXPMPU_MIDIIN_6 406 +#define MM_MOTU_MXPMPU_MIDIOUT_6 406 + +#define MM_MOTU_MXN_MIDIOUT_ALL 500 +#define MM_MOTU_MXN_MIDIIN_SYNC 500 +#define MM_MOTU_MXN_MIDIIN_1 501 +#define MM_MOTU_MXN_MIDIOUT_1 501 +#define MM_MOTU_MXN_MIDIIN_2 502 +#define MM_MOTU_MXN_MIDIOUT_2 502 +#define MM_MOTU_MXN_MIDIIN_3 503 +#define MM_MOTU_MXN_MIDIOUT_3 503 +#define MM_MOTU_MXN_MIDIIN_4 504 +#define MM_MOTU_MXN_MIDIOUT_4 504 + +#define MM_MOTU_FLYER_MIDI_IN_SYNC 600 +#define MM_MOTU_FLYER_MIDI_IN_A 601 +#define MM_MOTU_FLYER_MIDI_OUT_A 601 +#define MM_MOTU_FLYER_MIDI_IN_B 602 +#define MM_MOTU_FLYER_MIDI_OUT_B 602 + +#define MM_MOTU_PKX_MIDI_IN_SYNC 700 +#define MM_MOTU_PKX_MIDI_IN_A 701 +#define MM_MOTU_PKX_MIDI_OUT_A 701 +#define MM_MOTU_PKX_MIDI_IN_B 702 +#define MM_MOTU_PKX_MIDI_OUT_B 702 + +#define MM_MOTU_DTX_MIDI_IN_SYNC 800 +#define MM_MOTU_DTX_MIDI_IN_A 801 +#define MM_MOTU_DTX_MIDI_OUT_A 801 +#define MM_MOTU_DTX_MIDI_IN_B 802 +#define MM_MOTU_DTX_MIDI_OUT_B 802 + +#define MM_MOTU_MTPAV_MIDIOUT_ALL 900 +#define MM_MOTU_MTPAV_MIDIIN_SYNC 900 +#define MM_MOTU_MTPAV_MIDIIN_1 901 +#define MM_MOTU_MTPAV_MIDIOUT_1 901 +#define MM_MOTU_MTPAV_MIDIIN_2 902 +#define MM_MOTU_MTPAV_MIDIOUT_2 902 +#define MM_MOTU_MTPAV_MIDIIN_3 903 +#define MM_MOTU_MTPAV_MIDIOUT_3 903 +#define MM_MOTU_MTPAV_MIDIIN_4 904 +#define MM_MOTU_MTPAV_MIDIOUT_4 904 +#define MM_MOTU_MTPAV_MIDIIN_5 905 +#define MM_MOTU_MTPAV_MIDIOUT_5 905 +#define MM_MOTU_MTPAV_MIDIIN_6 906 +#define MM_MOTU_MTPAV_MIDIOUT_6 906 +#define MM_MOTU_MTPAV_MIDIIN_7 907 +#define MM_MOTU_MTPAV_MIDIOUT_7 907 +#define MM_MOTU_MTPAV_MIDIIN_8 908 +#define MM_MOTU_MTPAV_MIDIOUT_8 908 +#define MM_MOTU_MTPAV_NET_MIDIIN_1 909 +#define MM_MOTU_MTPAV_NET_MIDIOUT_1 909 +#define MM_MOTU_MTPAV_NET_MIDIIN_2 910 +#define MM_MOTU_MTPAV_NET_MIDIOUT_2 910 +#define MM_MOTU_MTPAV_NET_MIDIIN_3 911 +#define MM_MOTU_MTPAV_NET_MIDIOUT_3 911 +#define MM_MOTU_MTPAV_NET_MIDIIN_4 912 +#define MM_MOTU_MTPAV_NET_MIDIOUT_4 912 +#define MM_MOTU_MTPAV_NET_MIDIIN_5 913 +#define MM_MOTU_MTPAV_NET_MIDIOUT_5 913 +#define MM_MOTU_MTPAV_NET_MIDIIN_6 914 +#define MM_MOTU_MTPAV_NET_MIDIOUT_6 914 +#define MM_MOTU_MTPAV_NET_MIDIIN_7 915 +#define MM_MOTU_MTPAV_NET_MIDIOUT_7 915 +#define MM_MOTU_MTPAV_NET_MIDIIN_8 916 +#define MM_MOTU_MTPAV_NET_MIDIOUT_8 916 +#define MM_MOTU_MTPAV_MIDIIN_ADAT 917 +#define MM_MOTU_MTPAV_MIDIOUT_ADAT 917 +#define MM_MOTU_MXPXT_MIDIIN_SYNC 1000 +#define MM_MOTU_MXPXT_MIDIOUT_ALL 1000 +#define MM_MOTU_MXPXT_MIDIIN_1 1001 +#define MM_MOTU_MXPXT_MIDIOUT_1 1001 +#define MM_MOTU_MXPXT_MIDIOUT_2 1002 +#define MM_MOTU_MXPXT_MIDIIN_2 1002 +#define MM_MOTU_MXPXT_MIDIIN_3 1003 +#define MM_MOTU_MXPXT_MIDIOUT_3 1003 +#define MM_MOTU_MXPXT_MIDIIN_4 1004 +#define MM_MOTU_MXPXT_MIDIOUT_4 1004 +#define MM_MOTU_MXPXT_MIDIIN_5 1005 +#define MM_MOTU_MXPXT_MIDIOUT_5 1005 +#define MM_MOTU_MXPXT_MIDIOUT_6 1006 +#define MM_MOTU_MXPXT_MIDIIN_6 1006 +#define MM_MOTU_MXPXT_MIDIOUT_7 1007 +#define MM_MOTU_MXPXT_MIDIIN_7 1007 +#define MM_MOTU_MXPXT_MIDIOUT_8 1008 +#define MM_MOTU_MXPXT_MIDIIN_8 1008 + +/* MM_WORKBIT product IDs */ +#define MM_WORKBIT_MIXER 1 /* Harmony Mixer */ +#define MM_WORKBIT_WAVEOUT 2 /* Harmony Mixer */ +#define MM_WORKBIT_WAVEIN 3 /* Harmony Mixer */ +#define MM_WORKBIT_MIDIIN 4 /* Harmony Mixer */ +#define MM_WORKBIT_MIDIOUT 5 /* Harmony Mixer */ +#define MM_WORKBIT_FMSYNTH 6 /* Harmony Mixer */ +#define MM_WORKBIT_AUX 7 /* Harmony Mixer */ +#define MM_WORKBIT_JOYSTICK 8 + +/* MM_OSITECH product IDs */ +#define MM_OSITECH_TRUMPCARD 1 /* Trumpcard */ + +/* MM_MIRO product IDs */ +#define MM_MIRO_MOVIEPRO 1 /* miroMOVIE pro */ +#define MM_MIRO_VIDEOD1 2 /* miroVIDEO D1 */ +#define MM_MIRO_VIDEODC1TV 3 /* miroVIDEO DC1 tv */ +#define MM_MIRO_VIDEOTD 4 /* miroVIDEO 10/20 TD */ +#define MM_MIRO_DC30_WAVEOUT 5 +#define MM_MIRO_DC30_WAVEIN 6 +#define MM_MIRO_DC30_MIX 7 + +/* MM_ISOLUTION product IDs */ +#define MM_ISOLUTION_PASCAL 1 + +/* MM_ROCKWELL product IDs */ +#define MM_VOICEMIXER 1 +#define ROCKWELL_WA1_WAVEIN 100 +#define ROCKWELL_WA1_WAVEOUT 101 +#define ROCKWELL_WA1_SYNTH 102 +#define ROCKWELL_WA1_MIXER 103 +#define ROCKWELL_WA1_MPU401_IN 104 +#define ROCKWELL_WA1_MPU401_OUT 105 +#define ROCKWELL_WA2_WAVEIN 200 +#define ROCKWELL_WA2_WAVEOUT 201 +#define ROCKWELL_WA2_SYNTH 202 +#define ROCKWELL_WA2_MIXER 203 +#define ROCKWELL_WA2_MPU401_IN 204 +#define ROCKWELL_WA2_MPU401_OUT 205 + +/* MM_VOXWARE product IDs */ +#define MM_VOXWARE_CODEC 1 + +/* MM_NORTHERN_TELECOM product IDs */ +#define MM_NORTEL_MPXAC_WAVEIN 1 /* MPX Audio Card Wave Input Device */ +#define MM_NORTEL_MPXAC_WAVEOUT 2 /* MPX Audio Card Wave Output Device */ + +/* MM_ADDX product IDs */ +#define MM_ADDX_PCTV_DIGITALMIX 1 /* MM_ADDX_PCTV_DIGITALMIX */ +#define MM_ADDX_PCTV_WAVEIN 2 /* MM_ADDX_PCTV_WAVEIN */ +#define MM_ADDX_PCTV_WAVEOUT 3 /* MM_ADDX_PCTV_WAVEOUT */ +#define MM_ADDX_PCTV_MIXER 4 /* MM_ADDX_PCTV_MIXER */ +#define MM_ADDX_PCTV_AUX_CD 5 /* MM_ADDX_PCTV_AUX_CD */ +#define MM_ADDX_PCTV_AUX_LINE 6 /* MM_ADDX_PCTV_AUX_LINE */ + +/* MM_WILDCAT product IDs */ +#define MM_WILDCAT_AUTOSCOREMIDIIN 1 /* Autoscore */ + +/* MM_RHETOREX product IDs */ +#define MM_RHETOREX_WAVEIN 1 +#define MM_RHETOREX_WAVEOUT 2 + +/* MM_BROOKTREE product IDs */ +#define MM_BTV_WAVEIN 1 /* Brooktree PCM Wave Audio In */ +#define MM_BTV_WAVEOUT 2 /* Brooktree PCM Wave Audio Out */ +#define MM_BTV_MIDIIN 3 /* Brooktree MIDI In */ +#define MM_BTV_MIDIOUT 4 /* Brooktree MIDI out */ +#define MM_BTV_MIDISYNTH 5 /* Brooktree MIDI FM synth */ +#define MM_BTV_AUX_LINE 6 /* Brooktree Line Input */ +#define MM_BTV_AUX_MIC 7 /* Brooktree Microphone Input */ +#define MM_BTV_AUX_CD 8 /* Brooktree CD Input */ +#define MM_BTV_DIGITALIN 9 /* Brooktree PCM Wave in with subcode information */ +#define MM_BTV_DIGITALOUT 10 /* Brooktree PCM Wave out with subcode information */ +#define MM_BTV_MIDIWAVESTREAM 11 /* Brooktree WaveStream */ +#define MM_BTV_MIXER 12 /* Brooktree WSS Mixer driver */ + +/* MM_ENSONIQ product IDs */ +#define MM_ENSONIQ_SOUNDSCAPE 0x10 /* ENSONIQ Soundscape */ +#define MM_SOUNDSCAPE_WAVEOUT MM_ENSONIQ_SOUNDSCAPE+1 +#define MM_SOUNDSCAPE_WAVEOUT_AUX MM_ENSONIQ_SOUNDSCAPE+2 +#define MM_SOUNDSCAPE_WAVEIN MM_ENSONIQ_SOUNDSCAPE+3 +#define MM_SOUNDSCAPE_MIDIOUT MM_ENSONIQ_SOUNDSCAPE+4 +#define MM_SOUNDSCAPE_MIDIIN MM_ENSONIQ_SOUNDSCAPE+5 +#define MM_SOUNDSCAPE_SYNTH MM_ENSONIQ_SOUNDSCAPE+6 +#define MM_SOUNDSCAPE_MIXER MM_ENSONIQ_SOUNDSCAPE+7 +#define MM_SOUNDSCAPE_AUX MM_ENSONIQ_SOUNDSCAPE+8 + +/* MM_NVIDIA product IDs */ +#define MM_NVIDIA_WAVEOUT 1 +#define MM_NVIDIA_WAVEIN 2 +#define MM_NVIDIA_MIDIOUT 3 +#define MM_NVIDIA_MIDIIN 4 +#define MM_NVIDIA_GAMEPORT 5 +#define MM_NVIDIA_MIXER 6 +#define MM_NVIDIA_AUX 7 + +/* MM_OKSORI product IDs */ +#define MM_OKSORI_BASE 0 /* Oksori Base */ +#define MM_OKSORI_OSR8_WAVEOUT MM_OKSORI_BASE+1 /* Oksori 8bit Wave out */ +#define MM_OKSORI_OSR8_WAVEIN MM_OKSORI_BASE+2 /* Oksori 8bit Wave in */ +#define MM_OKSORI_OSR16_WAVEOUT MM_OKSORI_BASE+3 /* Oksori 16 bit Wave out */ +#define MM_OKSORI_OSR16_WAVEIN MM_OKSORI_BASE+4 /* Oksori 16 bit Wave in */ +#define MM_OKSORI_FM_OPL4 MM_OKSORI_BASE+5 /* Oksori FM Synth Yamaha OPL4 */ +#define MM_OKSORI_MIX_MASTER MM_OKSORI_BASE+6 /* Oksori DSP Mixer - Master Volume */ +#define MM_OKSORI_MIX_WAVE MM_OKSORI_BASE+7 /* Oksori DSP Mixer - Wave Volume */ +#define MM_OKSORI_MIX_FM MM_OKSORI_BASE+8 /* Oksori DSP Mixer - FM Volume */ +#define MM_OKSORI_MIX_LINE MM_OKSORI_BASE+9 /* Oksori DSP Mixer - Line Volume */ +#define MM_OKSORI_MIX_CD MM_OKSORI_BASE+10 /* Oksori DSP Mixer - CD Volume */ +#define MM_OKSORI_MIX_MIC MM_OKSORI_BASE+11 /* Oksori DSP Mixer - MIC Volume */ +#define MM_OKSORI_MIX_ECHO MM_OKSORI_BASE+12 /* Oksori DSP Mixer - Echo Volume */ +#define MM_OKSORI_MIX_AUX1 MM_OKSORI_BASE+13 /* Oksori AD1848 - AUX1 Volume */ +#define MM_OKSORI_MIX_LINE1 MM_OKSORI_BASE+14 /* Oksori AD1848 - LINE1 Volume */ +#define MM_OKSORI_EXT_MIC1 MM_OKSORI_BASE+15 /* Oksori External - One Mic Connect */ +#define MM_OKSORI_EXT_MIC2 MM_OKSORI_BASE+16 /* Oksori External - Two Mic Connect */ +#define MM_OKSORI_MIDIOUT MM_OKSORI_BASE+17 /* Oksori MIDI Out Device */ +#define MM_OKSORI_MIDIIN MM_OKSORI_BASE+18 /* Oksori MIDI In Device */ +#define MM_OKSORI_MPEG_CDVISION MM_OKSORI_BASE+19 /* Oksori CD-Vision MPEG Decoder */ + +/* MM_DIACOUSTICS product IDs */ +#define MM_DIACOUSTICS_DRUM_ACTION 1 /* Drum Action */ + +/* MM_KAY_ELEMETRICS product IDs */ +#define MM_KAY_ELEMETRICS_CSL 0x4300 +#define MM_KAY_ELEMETRICS_CSL_DAT 0x4308 +#define MM_KAY_ELEMETRICS_CSL_4CHANNEL 0x4309 + +/* MM_CRYSTAL product IDs */ +#define MM_CRYSTAL_CS4232_WAVEIN 1 +#define MM_CRYSTAL_CS4232_WAVEOUT 2 +#define MM_CRYSTAL_CS4232_WAVEMIXER 3 +#define MM_CRYSTAL_CS4232_WAVEAUX_AUX1 4 +#define MM_CRYSTAL_CS4232_WAVEAUX_AUX2 5 +#define MM_CRYSTAL_CS4232_WAVEAUX_LINE 6 +#define MM_CRYSTAL_CS4232_WAVEAUX_MONO 7 +#define MM_CRYSTAL_CS4232_WAVEAUX_MASTER 8 +#define MM_CRYSTAL_CS4232_MIDIIN 9 +#define MM_CRYSTAL_CS4232_MIDIOUT 10 +#define MM_CRYSTAL_CS4232_INPUTGAIN_AUX1 13 +#define MM_CRYSTAL_CS4232_INPUTGAIN_LOOP 14 +#define MM_CRYSTAL_SOUND_FUSION_WAVEIN 21 +#define MM_CRYSTAL_SOUND_FUSION_WAVEOUT 22 +#define MM_CRYSTAL_SOUND_FUSION_MIXER 23 +#define MM_CRYSTAL_SOUND_FUSION_MIDIIN 24 +#define MM_CRYSTAL_SOUND_FUSION_MIDIOUT 25 +#define MM_CRYSTAL_SOUND_FUSION_JOYSTICK 26 + +/* MM_QUARTERDECK product IDs */ +#define MM_QUARTERDECK_LHWAVEIN 0 /* Quarterdeck L&H Codec Wave In */ +#define MM_QUARTERDECK_LHWAVEOUT 1 /* Quarterdeck L&H Codec Wave Out */ + +/* MM_TDK product IDs */ +#define MM_TDK_MW_MIDI_SYNTH 1 +#define MM_TDK_MW_MIDI_IN 2 +#define MM_TDK_MW_MIDI_OUT 3 +#define MM_TDK_MW_WAVE_IN 4 +#define MM_TDK_MW_WAVE_OUT 5 +#define MM_TDK_MW_AUX 6 +#define MM_TDK_MW_MIXER 10 +#define MM_TDK_MW_AUX_MASTER 100 +#define MM_TDK_MW_AUX_BASS 101 +#define MM_TDK_MW_AUX_TREBLE 102 +#define MM_TDK_MW_AUX_MIDI_VOL 103 +#define MM_TDK_MW_AUX_WAVE_VOL 104 +#define MM_TDK_MW_AUX_WAVE_RVB 105 +#define MM_TDK_MW_AUX_WAVE_CHR 106 +#define MM_TDK_MW_AUX_VOL 107 +#define MM_TDK_MW_AUX_RVB 108 +#define MM_TDK_MW_AUX_CHR 109 + +/* MM_DIGITAL_AUDIO_LABS product IDs */ +#define MM_DIGITAL_AUDIO_LABS_TC 0x01 +#define MM_DIGITAL_AUDIO_LABS_DOC 0x02 +#define MM_DIGITAL_AUDIO_LABS_V8 0x10 +#define MM_DIGITAL_AUDIO_LABS_CPRO 0x11 +#define MM_DIGITAL_AUDIO_LABS_VP 0x12 +#define MM_DIGITAL_AUDIO_LABS_CDLX 0x13 +#define MM_DIGITAL_AUDIO_LABS_CTDIF 0x14 + +/* MM_SEERSYS product IDs */ +#define MM_SEERSYS_SEERSYNTH 1 +#define MM_SEERSYS_SEERWAVE 2 +#define MM_SEERSYS_SEERMIX 3 +#define MM_SEERSYS_WAVESYNTH 4 +#define MM_SEERSYS_WAVESYNTH_WG 5 +#define MM_SEERSYS_REALITY 6 + +/* MM_OSPREY product IDs */ +#define MM_OSPREY_1000WAVEIN 1 +#define MM_OSPREY_1000WAVEOUT 2 + +/* MM_SOUNDESIGNS product IDs */ +#define MM_SOUNDESIGNS_WAVEIN 1 +#define MM_SOUNDESIGNS_WAVEOUT 2 + +/* MM_SPECTRUM_SIGNAL_PROCESSING product IDs */ +#define MM_SSP_SNDFESWAVEIN 1 /* Sound Festa Wave In Device */ +#define MM_SSP_SNDFESWAVEOUT 2 /* Sound Festa Wave Out Device */ +#define MM_SSP_SNDFESMIDIIN 3 /* Sound Festa MIDI In Device */ +#define MM_SSP_SNDFESMIDIOUT 4 /* Sound Festa MIDI Out Device */ +#define MM_SSP_SNDFESSYNTH 5 /* Sound Festa MIDI Synth Device */ +#define MM_SSP_SNDFESMIX 6 /* Sound Festa Mixer Device */ +#define MM_SSP_SNDFESAUX 7 /* Sound Festa Auxilliary Device */ + +/* MM_ECS product IDs */ +#define MM_ECS_AADF_MIDI_IN 10 +#define MM_ECS_AADF_MIDI_OUT 11 +#define MM_ECS_AADF_WAVE2MIDI_IN 12 + +/* MM_AMD product IDs */ +#define MM_AMD_INTERWAVE_WAVEIN 1 +#define MM_AMD_INTERWAVE_WAVEOUT 2 +#define MM_AMD_INTERWAVE_SYNTH 3 +#define MM_AMD_INTERWAVE_MIXER1 4 +#define MM_AMD_INTERWAVE_MIXER2 5 +#define MM_AMD_INTERWAVE_JOYSTICK 6 +#define MM_AMD_INTERWAVE_EX_CD 7 +#define MM_AMD_INTERWAVE_MIDIIN 8 +#define MM_AMD_INTERWAVE_MIDIOUT 9 +#define MM_AMD_INTERWAVE_AUX1 10 +#define MM_AMD_INTERWAVE_AUX2 11 +#define MM_AMD_INTERWAVE_AUX_MIC 12 +#define MM_AMD_INTERWAVE_AUX_CD 13 +#define MM_AMD_INTERWAVE_MONO_IN 14 +#define MM_AMD_INTERWAVE_MONO_OUT 15 +#define MM_AMD_INTERWAVE_EX_TELEPHONY 16 +#define MM_AMD_INTERWAVE_WAVEOUT_BASE 17 +#define MM_AMD_INTERWAVE_WAVEOUT_TREBLE 18 +#define MM_AMD_INTERWAVE_STEREO_ENHANCED 19 + +/* MM_COREDYNAMICS product IDs */ +#define MM_COREDYNAMICS_DYNAMIXHR 1 /* DynaMax Hi-Rez */ +#define MM_COREDYNAMICS_DYNASONIX_SYNTH 2 /* DynaSonix */ +#define MM_COREDYNAMICS_DYNASONIX_MIDI_IN 3 +#define MM_COREDYNAMICS_DYNASONIX_MIDI_OUT 4 +#define MM_COREDYNAMICS_DYNASONIX_WAVE_IN 5 +#define MM_COREDYNAMICS_DYNASONIX_WAVE_OUT 6 +#define MM_COREDYNAMICS_DYNASONIX_AUDIO_IN 7 +#define MM_COREDYNAMICS_DYNASONIX_AUDIO_OUT 8 +#define MM_COREDYNAMICS_DYNAGRAFX_VGA 9 /* DynaGrfx */ +#define MM_COREDYNAMICS_DYNAGRAFX_WAVE_IN 10 +#define MM_COREDYNAMICS_DYNAGRAFX_WAVE_OUT 11 + +/* MM_CANAM product IDs */ +#define MM_CANAM_CBXWAVEOUT 1 +#define MM_CANAM_CBXWAVEIN 2 + +/* MM_SOFTSOUND product IDs */ +#define MM_SOFTSOUND_CODEC 1 + +/* MM_NORRIS product IDs */ +#define MM_NORRIS_VOICELINK 1 + +/* MM_DDD product IDs */ +#define MM_DDD_MIDILINK_MIDIIN 1 +#define MM_DDD_MIDILINK_MIDIOUT 2 + +/* MM_EUPHONICS product IDs */ +#define MM_EUPHONICS_AUX_CD 1 +#define MM_EUPHONICS_AUX_LINE 2 +#define MM_EUPHONICS_AUX_MASTER 3 +#define MM_EUPHONICS_AUX_MIC 4 +#define MM_EUPHONICS_AUX_MIDI 5 +#define MM_EUPHONICS_AUX_WAVE 6 +#define MM_EUPHONICS_FMSYNTH_MONO 7 +#define MM_EUPHONICS_FMSYNTH_STEREO 8 +#define MM_EUPHONICS_MIDIIN 9 +#define MM_EUPHONICS_MIDIOUT 10 +#define MM_EUPHONICS_MIXER 11 +#define MM_EUPHONICS_WAVEIN 12 +#define MM_EUPHONICS_WAVEOUT 13 +#define MM_EUPHONICS_EUSYNTH 14 + +/* MM_CRYSTAL_NET product IDs */ +#define CRYSTAL_NET_SFM_CODEC 1 + +/* MM_CHROMATIC product IDs */ +#define MM_CHROMATIC_M1 0x0001 +#define MM_CHROMATIC_M1_WAVEIN 0x0002 +#define MM_CHROMATIC_M1_WAVEOUT 0x0003 +#define MM_CHROMATIC_M1_FMSYNTH 0x0004 +#define MM_CHROMATIC_M1_MIXER 0x0005 +#define MM_CHROMATIC_M1_AUX 0x0006 +#define MM_CHROMATIC_M1_AUX_CD 0x0007 +#define MM_CHROMATIC_M1_MIDIIN 0x0008 +#define MM_CHROMATIC_M1_MIDIOUT 0x0009 +#define MM_CHROMATIC_M1_WTSYNTH 0x0010 +#define MM_CHROMATIC_M1_MPEGWAVEIN 0x0011 +#define MM_CHROMATIC_M1_MPEGWAVEOUT 0x0012 +#define MM_CHROMATIC_M2 0x0013 +#define MM_CHROMATIC_M2_WAVEIN 0x0014 +#define MM_CHROMATIC_M2_WAVEOUT 0x0015 +#define MM_CHROMATIC_M2_FMSYNTH 0x0016 +#define MM_CHROMATIC_M2_MIXER 0x0017 +#define MM_CHROMATIC_M2_AUX 0x0018 +#define MM_CHROMATIC_M2_AUX_CD 0x0019 +#define MM_CHROMATIC_M2_MIDIIN 0x0020 +#define MM_CHROMATIC_M2_MIDIOUT 0x0021 +#define MM_CHROMATIC_M2_WTSYNTH 0x0022 +#define MM_CHROMATIC_M2_MPEGWAVEIN 0x0023 +#define MM_CHROMATIC_M2_MPEGWAVEOUT 0x0024 + +/* MM_VIENNASYS product IDs */ +#define MM_VIENNASYS_TSP_WAVE_DRIVER 1 + +/* MM_CONNECTIX product IDs */ +#define MM_CONNECTIX_VIDEC_CODEC 1 + +/* MM_GADGETLABS product IDs */ +#define MM_GADGETLABS_WAVE44_WAVEIN 1 +#define MM_GADGETLABS_WAVE44_WAVEOUT 2 +#define MM_GADGETLABS_WAVE42_WAVEIN 3 +#define MM_GADGETLABS_WAVE42_WAVEOUT 4 +#define MM_GADGETLABS_WAVE4_MIDIIN 5 +#define MM_GADGETLABS_WAVE4_MIDIOUT 6 + +/* MM_FRONTIER product IDs */ +#define MM_FRONTIER_WAVECENTER_MIDIIN 1 /* WaveCenter */ +#define MM_FRONTIER_WAVECENTER_MIDIOUT 2 +#define MM_FRONTIER_WAVECENTER_WAVEIN 3 +#define MM_FRONTIER_WAVECENTER_WAVEOUT 4 + +/* MM_VIONA product IDs */ +#define MM_VIONA_QVINPCI_MIXER 1 /* Q-Motion PCI II/Bravado 2000 */ +#define MM_VIONA_QVINPCI_WAVEIN 2 +#define MM_VIONAQVINPCI_WAVEOUT 3 +#define MM_VIONA_BUSTER_MIXER 4 /* Buster */ +#define MM_VIONA_CINEMASTER_MIXER 5 /* Cinemaster */ +#define MM_VIONA_CONCERTO_MIXER 6 /* Concerto */ + +/* MM_CASIO product IDs */ +#define MM_CASIO_WP150_MIDIOUT 1 /* wp150 */ +#define MM_CASIO_WP150_MIDIIN 2 +#define MM_CASIO_LSG_MIDIOUT 3 + +/* MM_DIAMONDMM product IDs */ +#define MM_DIMD_PLATFORM 0 /* Freedom Audio */ +#define MM_DIMD_DIRSOUND 1 +#define MM_DIMD_VIRTMPU 2 +#define MM_DIMD_VIRTSB 3 +#define MM_DIMD_VIRTJOY 4 +#define MM_DIMD_WAVEIN 5 +#define MM_DIMD_WAVEOUT 6 +#define MM_DIMD_MIDIIN 7 +#define MM_DIMD_MIDIOUT 8 +#define MM_DIMD_AUX_LINE 9 +#define MM_DIMD_MIXER 10 +#define MM_DIMD_WSS_WAVEIN 14 +#define MM_DIMD_WSS_WAVEOUT 15 +#define MM_DIMD_WSS_MIXER 17 +#define MM_DIMD_WSS_AUX 21 +#define MM_DIMD_WSS_SYNTH 76 + +/* MM_S3 product IDs */ +#define MM_S3_WAVEOUT 1 +#define MM_S3_WAVEIN 2 +#define MM_S3_MIDIOUT 3 +#define MM_S3_MIDIIN 4 +#define MM_S3_FMSYNTH 5 +#define MM_S3_MIXER 6 +#define MM_S3_AUX 7 + +/* MM_VANKOEVERING product IDs */ +#define MM_VKC_MPU401_MIDIIN 0x0100 +#define MM_VKC_SERIAL_MIDIIN 0x0101 +#define MM_VKC_MPU401_MIDIOUT 0x0200 +#define MM_VKC_SERIAL_MIDIOUT 0x0201 + +/* MM_ZEFIRO product IDs */ +#define MM_ZEFIRO_ZA2 2 + +/* MM_FRAUNHOFER_IIS product IDs */ +#define MM_FHGIIS_MPEGLAYER3_DECODE 9 +#define MM_FHGIIS_MPEGLAYER3 10 +#define MM_FHGIIS_MPEGLAYER3_LITE 10 +#define MM_FHGIIS_MPEGLAYER3_BASIC 11 +#define MM_FHGIIS_MPEGLAYER3_ADVANCED 12 +#define MM_FHGIIS_MPEGLAYER3_PROFESSIONAL 13 +#define MM_FHGIIS_MPEGLAYER3_ADVANCEDPLUS 14 + + +/* MM_QUICKNET product IDs */ +#define MM_QUICKNET_PJWAVEIN 1 +#define MM_QUICKNET_PJWAVEOUT 2 + +/* MM_SICRESOURCE product IDs */ +#define MM_SICRESOURCE_SSO3D 2 +#define MM_SICRESOURCE_SSOW3DI 3 + +/* MM_NEOMAGIC product IDs */ +#define MM_NEOMAGIC_SYNTH 1 +#define MM_NEOMAGIC_WAVEOUT 2 +#define MM_NEOMAGIC_WAVEIN 3 +#define MM_NEOMAGIC_MIDIOUT 4 +#define MM_NEOMAGIC_MIDIIN 5 +#define MM_NEOMAGIC_AUX 6 +#define MM_NEOMAGIC_MW3DX_WAVEOUT 10 +#define MM_NEOMAGIC_MW3DX_WAVEIN 11 +#define MM_NEOMAGIC_MW3DX_MIDIOUT 12 +#define MM_NEOMAGIC_MW3DX_MIDIIN 13 +#define MM_NEOMAGIC_MW3DX_FMSYNTH 14 +#define MM_NEOMAGIC_MW3DX_GMSYNTH 15 +#define MM_NEOMAGIC_MW3DX_MIXER 16 +#define MM_NEOMAGIC_MW3DX_AUX 17 +#define MM_NEOMAGIC_MWAVE_WAVEOUT 20 +#define MM_NEOMAGIC_MWAVE_WAVEIN 21 +#define MM_NEOMAGIC_MWAVE_MIDIOUT 22 +#define MM_NEOMAGIC_MWAVE_MIDIIN 23 +#define MM_NEOMAGIC_MWAVE_MIXER 24 +#define MM_NEOMAGIC_MWAVE_AUX 25 + +/* MM_MERGING_TECHNOLOGIES product IDs */ +#define MM_MERGING_MPEGL3 1 + +/* MM_XIRLINK product IDs */ +#define MM_XIRLINK_VISIONLINK 1 + +/* MM_OTI product IDs */ +#define MM_OTI_611WAVEIN 5 +#define MM_OTI_611WAVEOUT 6 +#define MM_OTI_611MIXER 7 +#define MM_OTI_611MIDIN 0x12 +#define MM_OTI_611MIDIOUT 0x13 + +/* MM_AUREAL product IDs */ +#define MM_AUREAL_AU8820 16 +#define MM_AU8820_SYNTH 17 +#define MM_AU8820_WAVEOUT 18 +#define MM_AU8820_WAVEIN 19 +#define MM_AU8820_MIXER 20 +#define MM_AU8820_AUX 21 +#define MM_AU8820_MIDIOUT 22 +#define MM_AU8820_MIDIIN 23 +#define MM_AUREAL_AU8830 32 +#define MM_AU8830_SYNTH 33 +#define MM_AU8830_WAVEOUT 34 +#define MM_AU8830_WAVEIN 35 +#define MM_AU8830_MIXER 36 +#define MM_AU8830_AUX 37 +#define MM_AU8830_MIDIOUT 38 +#define MM_AU8830_MIDIIN 39 + +/* MM_VIVO product IDs */ +#define MM_VIVO_AUDIO_CODEC 1 + +/* MM_SHARP product IDs */ +#define MM_SHARP_MDC_MIDI_SYNTH 1 +#define MM_SHARP_MDC_MIDI_IN 2 +#define MM_SHARP_MDC_MIDI_OUT 3 +#define MM_SHARP_MDC_WAVE_IN 4 +#define MM_SHARP_MDC_WAVE_OUT 5 +#define MM_SHARP_MDC_AUX 6 +#define MM_SHARP_MDC_MIXER 10 +#define MM_SHARP_MDC_AUX_MASTER 100 +#define MM_SHARP_MDC_AUX_BASS 101 +#define MM_SHARP_MDC_AUX_TREBLE 102 +#define MM_SHARP_MDC_AUX_MIDI_VOL 103 +#define MM_SHARP_MDC_AUX_WAVE_VOL 104 +#define MM_SHARP_MDC_AUX_WAVE_RVB 105 +#define MM_SHARP_MDC_AUX_WAVE_CHR 106 +#define MM_SHARP_MDC_AUX_VOL 107 +#define MM_SHARP_MDC_AUX_RVB 108 +#define MM_SHARP_MDC_AUX_CHR 109 + +/* MM_LUCENT product IDs */ +#define MM_LUCENT_ACM_G723 0 + +/* MM_ATT product IDs */ +#define MM_ATT_G729A 1 + +/* MM_MARIAN product IDs */ +#define MM_MARIAN_ARC44WAVEIN 1 +#define MM_MARIAN_ARC44WAVEOUT 2 +#define MM_MARIAN_PRODIF24WAVEIN 3 +#define MM_MARIAN_PRODIF24WAVEOUT 4 +#define MM_MARIAN_ARC88WAVEIN 5 +#define MM_MARIAN_ARC88WAVEOUT 6 + +/* MM_BCB product IDs */ +#define MM_BCB_NETBOARD_10 1 +#define MM_BCB_TT75_10 2 + +/* MM_MOTIONPIXELS product IDs */ +#define MM_MOTIONPIXELS_MVI2 1 + +/* MM_QDESIGN product IDs */ +#define MM_QDESIGN_ACM_MPEG 1 +#define MM_QDESIGN_ACM_QDESIGN_MUSIC 2 + +/* MM_NMP product IDs */ +#define MM_NMP_CCP_WAVEIN 1 +#define MM_NMP_CCP_WAVEOUT 2 +#define MM_NMP_ACM_AMR 10 + +/* MM_DATAFUSION product IDs */ +#define MM_DF_ACM_G726 1 +#define MM_DF_ACM_GSM610 2 + +/* MM_BERCOS product IDs */ +#define MM_BERCOS_WAVEIN 1 +#define MM_BERCOS_MIXER 2 +#define MM_BERCOS_WAVEOUT 3 + +/* MM_ONLIVE product IDs */ +#define MM_ONLIVE_MPCODEC 1 + +/* MM_PHONET product IDs */ +#define MM_PHONET_PP_WAVEOUT 1 +#define MM_PHONET_PP_WAVEIN 2 +#define MM_PHONET_PP_MIXER 3 + +/* MM_FTR product IDs */ +#define MM_FTR_ENCODER_WAVEIN 1 +#define MM_FTR_ACM 2 + +/* MM_ENET product IDs */ +#define MM_ENET_T2000_LINEIN 1 +#define MM_ENET_T2000_LINEOUT 2 +#define MM_ENET_T2000_HANDSETIN 3 +#define MM_ENET_T2000_HANDSETOUT 4 + +/* MM_EMAGIC product IDs */ +#define MM_EMAGIC_UNITOR8 1 + +/* MM_SIPROLAB product IDs */ +#define MM_SIPROLAB_ACELPNET 1 + +/* MM_DICTAPHONE product IDs */ +#define MM_DICTAPHONE_G726 1 /* G726 ACM codec (g726pcm.acm) */ + +/* MM_RZS product IDs */ +#define MM_RZS_ACM_TUBGSM 1 /* GSM 06.10 CODEC */ + +/* MM_EES product IDs */ +#define MM_EES_PCMIDI14 1 +#define MM_EES_PCMIDI14_IN 2 +#define MM_EES_PCMIDI14_OUT1 3 +#define MM_EES_PCMIDI14_OUT2 4 +#define MM_EES_PCMIDI14_OUT3 5 +#define MM_EES_PCMIDI14_OUT4 6 + +/* MM_HAFTMANN product IDs */ +#define MM_HAFTMANN_LPTDAC2 1 + +/* MM_LUCID product IDs */ +#define MM_LUCID_PCI24WAVEIN 1 +#define MM_LUCID_PCI24WAVEOUT 2 + +/* MM_HEADSPACE product IDs */ +#define MM_HEADSPACE_HAESYNTH 1 +#define MM_HEADSPACE_HAEWAVEOUT 2 +#define MM_HEADSPACE_HAEWAVEIN 3 +#define MM_HEADSPACE_HAEMIXER 4 + +/* MM_UNISYS product IDs */ +#define MM_UNISYS_ACM_NAP 1 + +/* MM_LUMINOSITI product IDs */ + +#define MM_LUMINOSITI_SCWAVEIN 1 +#define MM_LUMINOSITI_SCWAVEOUT 2 +#define MM_LUMINOSITI_SCWAVEMIX 3 + +/* MM_ACTIVEVOICE product IDs */ +#define MM_ACTIVEVOICE_ACM_VOXADPCM 1 + +/* MM_DTS product IDs */ +#define MM_DTS_DS 1 + +/* MM_SOFTLAB_NSK product IDs */ +#define MM_SOFTLAB_NSK_FRW_WAVEIN 1 +#define MM_SOFTLAB_NSK_FRW_WAVEOUT 2 +#define MM_SOFTLAB_NSK_FRW_MIXER 3 +#define MM_SOFTLAB_NSK_FRW_AUX 4 + +/* MM_FORTEMEDIA product IDs */ +#define MM_FORTEMEDIA_WAVEIN 1 +#define MM_FORTEMEDIA_WAVEOUT 2 +#define MM_FORTEMEDIA_FMSYNC 3 +#define MM_FORTEMEDIA_MIXER 4 +#define MM_FORTEMEDIA_AUX 5 + +/* MM_SONORUS product IDs */ +#define MM_SONORUS_STUDIO 1 + +/* MM_I_LINK product IDs */ +#define MM_I_LINK_VOICE_CODER 1 + +/* MM_SELSIUS_SYSTEMS product IDs */ +#define MM_SELSIUS_SYSTEMS_RTPWAVEOUT 1 +#define MM_SELSIUS_SYSTEMS_RTPWAVEIN 2 + +/* MM_ADMOS product IDs */ +#define MM_ADMOS_FM_SYNTH 1 +#define MM_ADMOS_QS3AMIDIOUT 2 +#define MM_ADMOS_QS3AMIDIIN 3 +#define MM_ADMOS_QS3AWAVEOUT 4 +#define MM_ADMOS_QS3AWAVEIN 5 + +/* MM_LEXICON product IDs */ +#define MM_LEXICON_STUDIO_WAVE_OUT 1 +#define MM_LEXICON_STUDIO_WAVE_IN 2 + +/* MM_SGI product IDs */ +#define MM_SGI_320_WAVEIN 1 +#define MM_SGI_320_WAVEOUT 2 +#define MM_SGI_320_MIXER 3 +#define MM_SGI_540_WAVEIN 4 +#define MM_SGI_540_WAVEOUT 5 +#define MM_SGI_540_MIXER 6 +#define MM_SGI_RAD_ADATMONO1_WAVEIN 7 +#define MM_SGI_RAD_ADATMONO2_WAVEIN 8 +#define MM_SGI_RAD_ADATMONO3_WAVEIN 9 +#define MM_SGI_RAD_ADATMONO4_WAVEIN 10 +#define MM_SGI_RAD_ADATMONO5_WAVEIN 11 +#define MM_SGI_RAD_ADATMONO6_WAVEIN 12 +#define MM_SGI_RAD_ADATMONO7_WAVEIN 13 +#define MM_SGI_RAD_ADATMONO8_WAVEIN 14 +#define MM_SGI_RAD_ADATSTEREO12_WAVEIN 15 +#define MM_SGI_RAD_ADATSTEREO34_WAVEIN 16 +#define MM_SGI_RAD_ADATSTEREO56_WAVEIN 17 +#define MM_SGI_RAD_ADATSTEREO78_WAVEIN 18 +#define MM_SGI_RAD_ADAT8CHAN_WAVEIN 19 +#define MM_SGI_RAD_ADATMONO1_WAVEOUT 20 +#define MM_SGI_RAD_ADATMONO2_WAVEOUT 21 +#define MM_SGI_RAD_ADATMONO3_WAVEOUT 22 +#define MM_SGI_RAD_ADATMONO4_WAVEOUT 23 +#define MM_SGI_RAD_ADATMONO5_WAVEOUT 24 +#define MM_SGI_RAD_ADATMONO6_WAVEOUT 25 +#define MM_SGI_RAD_ADATMONO7_WAVEOUT 26 +#define MM_SGI_RAD_ADATMONO8_WAVEOUT 27 +#define MM_SGI_RAD_ADATSTEREO12_WAVEOUT 28 +#define MM_SGI_RAD_ADATSTEREO32_WAVEOUT 29 +#define MM_SGI_RAD_ADATSTEREO56_WAVEOUT 30 +#define MM_SGI_RAD_ADATSTEREO78_WAVEOUT 31 +#define MM_SGI_RAD_ADAT8CHAN_WAVEOUT 32 +#define MM_SGI_RAD_AESMONO1_WAVEIN 33 +#define MM_SGI_RAD_AESMONO2_WAVEIN 34 +#define MM_SGI_RAD_AESSTEREO_WAVEIN 35 +#define MM_SGI_RAD_AESMONO1_WAVEOUT 36 +#define MM_SGI_RAD_AESMONO2_WAVEOUT 37 +#define MM_SGI_RAD_AESSTEREO_WAVEOUT 38 + +/* MM_IPI product IDs */ +#define MM_IPI_ACM_HSX 1 +#define MM_IPI_ACM_RPELP 2 +#define MM_IPI_WF_ASSS 3 +#define MM_IPI_AT_WAVEOUT 4 +#define MM_IPI_AT_WAVEIN 5 +#define MM_IPI_AT_MIXER 6 + +/* MM_ICE product IDs */ +#define MM_ICE_WAVEOUT 1 +#define MM_ICE_WAVEIN 2 +#define MM_ICE_MTWAVEOUT 3 +#define MM_ICE_MTWAVEIN 4 +#define MM_ICE_MIDIOUT1 5 +#define MM_ICE_MIDIIN1 6 +#define MM_ICE_MIDIOUT2 7 +#define MM_ICE_MIDIIN2 8 +#define MM_ICE_SYNTH 9 +#define MM_ICE_MIXER 10 +#define MM_ICE_AUX 11 + +/* MM_VQST product IDs */ +#define MM_VQST_VQC1 1 +#define MM_VQST_VQC2 2 + +/* MM_ETEK product IDs */ +#define MM_ETEK_KWIKMIDI_MIDIIN 1 +#define MM_ETEK_KWIKMIDI_MIDIOUT 2 + +/* MM_INTERNET product IDs */ +#define MM_INTERNET_SSW_MIDIOUT 10 +#define MM_INTERNET_SSW_MIDIIN 11 +#define MM_INTERNET_SSW_WAVEOUT 12 +#define MM_INTERNET_SSW_WAVEIN 13 + +/* MM_SONY product IDs */ +#define MM_SONY_ACM_SCX 1 + +/* MM_UHER_INFORMATIC product IDs */ +#define MM_UH_ACM_ADPCM 1 + +/* MM_SYDEC_NV product IDs */ +#define MM_SYDEC_NV_WAVEIN 1 +#define MM_SYDEC_NV_WAVEOUT 2 + +/* MM_FLEXION product IDs */ +#define MM_FLEXION_X300_WAVEIN 1 +#define MM_FLEXION_X300_WAVEOUT 2 + +/* MM_VIA product IDs */ +#define MM_VIA_WAVEOUT 1 +#define MM_VIA_WAVEIN 2 +#define MM_VIA_MIXER 3 +#define MM_VIA_AUX 4 +#define MM_VIA_MPU401_MIDIOUT 5 +#define MM_VIA_MPU401_MIDIIN 6 +#define MM_VIA_SWFM_SYNTH 7 +#define MM_VIA_WDM_WAVEOUT 8 +#define MM_VIA_WDM_WAVEIN 9 +#define MM_VIA_WDM_MIXER 10 +#define MM_VIA_WDM_MPU401_MIDIOUT 11 +#define MM_VIA_WDM_MPU401_MIDIIN 12 + +/* MM_MICRONAS product IDs */ +#define MM_MICRONAS_SC4 1 +#define MM_MICRONAS_CLP833 2 + +/* MM_HP product IDs */ +#define MM_HP_WAVEOUT 1 +#define MM_HP_WAVEIN 2 + +/* MM_QUICKAUDIO product IDs */ +#define MM_QUICKAUDIO_MINIMIDI 1 +#define MM_QUICKAUDIO_MAXIMIDI 2 + +/* MM_ICCC product IDs */ +#define MM_ICCC_UNA3_WAVEIN 1 +#define MM_ICCC_UNA3_WAVEOUT 2 +#define MM_ICCC_UNA3_AUX 3 +#define MM_ICCC_UNA3_MIXER 4 + +/* MM_3COM product IDs */ +#define MM_3COM_CB_MIXER 1 +#define MM_3COM_CB_WAVEIN 2 +#define MM_3COM_CB_WAVEOUT 3 + +/* MM_MINDMAKER product IDs */ +#define MM_MINDMAKER_GC_WAVEIN 1 +#define MM_MINDMAKER_GC_WAVEOUT 2 +#define MM_MINDMAKER_GC_MIXER 3 + +/* MM_TELEKOL product IDs */ +#define MM_TELEKOL_WAVEOUT 1 +#define MM_TELEKOL_WAVEIN 2 + +/* MM_ALGOVISION product IDs */ +#define MM_ALGOVISION_VB80WAVEOUT 1 +#define MM_ALGOVISION_VB80WAVEIN 2 +#define MM_ALGOVISION_VB80MIXER 3 +#define MM_ALGOVISION_VB80AUX 4 +#define MM_ALGOVISION_VB80AUX2 5 + +#endif // !NOMMIDS + +/* ------------------------------------------------------------------------------ */ + +/* INFO LIST CHUNKS (from the Multimedia Programmer's Reference + plus new ones) +*/ +#define RIFFINFO_IARL mmioFOURCC ('I', 'A', 'R', 'L') /*Archival location */ +#define RIFFINFO_IART mmioFOURCC ('I', 'A', 'R', 'T') /*Artist */ +#define RIFFINFO_ICMS mmioFOURCC ('I', 'C', 'M', 'S') /*Commissioned */ +#define RIFFINFO_ICMT mmioFOURCC ('I', 'C', 'M', 'T') /*Comments */ +#define RIFFINFO_ICOP mmioFOURCC ('I', 'C', 'O', 'P') /*Copyright */ +#define RIFFINFO_ICRD mmioFOURCC ('I', 'C', 'R', 'D') /*Creation date of subject */ +#define RIFFINFO_ICRP mmioFOURCC ('I', 'C', 'R', 'P') /*Cropped */ +#define RIFFINFO_IDIM mmioFOURCC ('I', 'D', 'I', 'M') /*Dimensions */ +#define RIFFINFO_IDPI mmioFOURCC ('I', 'D', 'P', 'I') /*Dots per inch */ +#define RIFFINFO_IENG mmioFOURCC ('I', 'E', 'N', 'G') /*Engineer */ +#define RIFFINFO_IGNR mmioFOURCC ('I', 'G', 'N', 'R') /*Genre */ +#define RIFFINFO_IKEY mmioFOURCC ('I', 'K', 'E', 'Y') /*Keywords */ +#define RIFFINFO_ILGT mmioFOURCC ('I', 'L', 'G', 'T') /*Lightness settings */ +#define RIFFINFO_IMED mmioFOURCC ('I', 'M', 'E', 'D') /*Medium */ +#define RIFFINFO_INAM mmioFOURCC ('I', 'N', 'A', 'M') /*Name of subject */ +#define RIFFINFO_IPLT mmioFOURCC ('I', 'P', 'L', 'T') /*Palette Settings. No. of colors requested. */ +#define RIFFINFO_IPRD mmioFOURCC ('I', 'P', 'R', 'D') /*Product */ +#define RIFFINFO_ISBJ mmioFOURCC ('I', 'S', 'B', 'J') /*Subject description */ +#define RIFFINFO_ISFT mmioFOURCC ('I', 'S', 'F', 'T') /*Software. Name of package used to create file. */ +#define RIFFINFO_ISHP mmioFOURCC ('I', 'S', 'H', 'P') /*Sharpness. */ +#define RIFFINFO_ISRC mmioFOURCC ('I', 'S', 'R', 'C') /*Source. */ +#define RIFFINFO_ISRF mmioFOURCC ('I', 'S', 'R', 'F') /*Source Form. ie slide, paper */ +#define RIFFINFO_ITCH mmioFOURCC ('I', 'T', 'C', 'H') /*Technician who digitized the subject. */ + +/* New INFO Chunks as of August 30, 1993: */ +#define RIFFINFO_ISMP mmioFOURCC ('I', 'S', 'M', 'P') /*SMPTE time code */ +/* ISMP: SMPTE time code of digitization start point expressed as a NULL terminated + text string "HH:MM:SS:FF". If performing MCI capture in AVICAP, this + chunk will be automatically set based on the MCI start time. +*/ +#define RIFFINFO_IDIT mmioFOURCC ('I', 'D', 'I', 'T') /*Digitization Time */ +/* IDIT: "Digitization Time" Specifies the time and date that the digitization commenced. + The digitization time is contained in an ASCII string which + contains exactly 26 characters and is in the format + "Wed Jan 02 02:03:55 1990\n\0". + The ctime(), asctime(), functions can be used to create strings + in this format. This chunk is automatically added to the capture + file based on the current system time at the moment capture is initiated. +*/ + +#define RIFFINFO_ITRK mmioFOURCC ('I', 'T', 'R', 'K') /*ASCIIZ representation of the 1-based track number of the content. */ +#define RIFFINFO_ITOC mmioFOURCC ('I', 'T', 'O', 'C') /*A dump of the table of contents from the CD the content originated from. */ + +/*Template line for new additions*/ +/*#define RIFFINFO_I mmioFOURCC ('I', '', '', '') */ + +/* ------------------------------------------------------------------------------ */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +#ifndef NONEWWAVE + +/* WAVE form wFormatTag IDs */ +#define WAVE_FORMAT_UNKNOWN 0x0000 /* Microsoft Corporation */ +#define WAVE_FORMAT_ADPCM 0x0002 /* Microsoft Corporation */ +#define WAVE_FORMAT_IEEE_FLOAT 0x0003 /* Microsoft Corporation */ +#define WAVE_FORMAT_VSELP 0x0004 /* Compaq Computer Corp. */ +#define WAVE_FORMAT_IBM_CVSD 0x0005 /* IBM Corporation */ +#define WAVE_FORMAT_ALAW 0x0006 /* Microsoft Corporation */ +#define WAVE_FORMAT_MULAW 0x0007 /* Microsoft Corporation */ +#define WAVE_FORMAT_DTS 0x0008 /* Microsoft Corporation */ +#define WAVE_FORMAT_DRM 0x0009 /* Microsoft Corporation */ +#define WAVE_FORMAT_WMAVOICE9 0x000A /* Microsoft Corporation */ +#define WAVE_FORMAT_WMAVOICE10 0x000B /* Microsoft Corporation */ +#define WAVE_FORMAT_OKI_ADPCM 0x0010 /* OKI */ +#define WAVE_FORMAT_DVI_ADPCM 0x0011 /* Intel Corporation */ +#define WAVE_FORMAT_IMA_ADPCM (WAVE_FORMAT_DVI_ADPCM) /* Intel Corporation */ +#define WAVE_FORMAT_MEDIASPACE_ADPCM 0x0012 /* Videologic */ +#define WAVE_FORMAT_SIERRA_ADPCM 0x0013 /* Sierra Semiconductor Corp */ +#define WAVE_FORMAT_G723_ADPCM 0x0014 /* Antex Electronics Corporation */ +#define WAVE_FORMAT_DIGISTD 0x0015 /* DSP Solutions, Inc. */ +#define WAVE_FORMAT_DIGIFIX 0x0016 /* DSP Solutions, Inc. */ +#define WAVE_FORMAT_DIALOGIC_OKI_ADPCM 0x0017 /* Dialogic Corporation */ +#define WAVE_FORMAT_MEDIAVISION_ADPCM 0x0018 /* Media Vision, Inc. */ +#define WAVE_FORMAT_CU_CODEC 0x0019 /* Hewlett-Packard Company */ +#define WAVE_FORMAT_HP_DYN_VOICE 0x001A /* Hewlett-Packard Company */ +#define WAVE_FORMAT_YAMAHA_ADPCM 0x0020 /* Yamaha Corporation of America */ +#define WAVE_FORMAT_SONARC 0x0021 /* Speech Compression */ +#define WAVE_FORMAT_DSPGROUP_TRUESPEECH 0x0022 /* DSP Group, Inc */ +#define WAVE_FORMAT_ECHOSC1 0x0023 /* Echo Speech Corporation */ +#define WAVE_FORMAT_AUDIOFILE_AF36 0x0024 /* Virtual Music, Inc. */ +#define WAVE_FORMAT_APTX 0x0025 /* Audio Processing Technology */ +#define WAVE_FORMAT_AUDIOFILE_AF10 0x0026 /* Virtual Music, Inc. */ +#define WAVE_FORMAT_PROSODY_1612 0x0027 /* Aculab plc */ +#define WAVE_FORMAT_LRC 0x0028 /* Merging Technologies S.A. */ +#define WAVE_FORMAT_DOLBY_AC2 0x0030 /* Dolby Laboratories */ +#define WAVE_FORMAT_GSM610 0x0031 /* Microsoft Corporation */ +#define WAVE_FORMAT_MSNAUDIO 0x0032 /* Microsoft Corporation */ +#define WAVE_FORMAT_ANTEX_ADPCME 0x0033 /* Antex Electronics Corporation */ +#define WAVE_FORMAT_CONTROL_RES_VQLPC 0x0034 /* Control Resources Limited */ +#define WAVE_FORMAT_DIGIREAL 0x0035 /* DSP Solutions, Inc. */ +#define WAVE_FORMAT_DIGIADPCM 0x0036 /* DSP Solutions, Inc. */ +#define WAVE_FORMAT_CONTROL_RES_CR10 0x0037 /* Control Resources Limited */ +#define WAVE_FORMAT_NMS_VBXADPCM 0x0038 /* Natural MicroSystems */ +#define WAVE_FORMAT_CS_IMAADPCM 0x0039 /* Crystal Semiconductor IMA ADPCM */ +#define WAVE_FORMAT_ECHOSC3 0x003A /* Echo Speech Corporation */ +#define WAVE_FORMAT_ROCKWELL_ADPCM 0x003B /* Rockwell International */ +#define WAVE_FORMAT_ROCKWELL_DIGITALK 0x003C /* Rockwell International */ +#define WAVE_FORMAT_XEBEC 0x003D /* Xebec Multimedia Solutions Limited */ +#define WAVE_FORMAT_G721_ADPCM 0x0040 /* Antex Electronics Corporation */ +#define WAVE_FORMAT_G728_CELP 0x0041 /* Antex Electronics Corporation */ +#define WAVE_FORMAT_MSG723 0x0042 /* Microsoft Corporation */ +#define WAVE_FORMAT_INTEL_G723_1 0x0043 /* Intel Corp. */ +#define WAVE_FORMAT_INTEL_G729 0x0044 /* Intel Corp. */ +#define WAVE_FORMAT_SHARP_G726 0x0045 /* Sharp */ +#define WAVE_FORMAT_MPEG 0x0050 /* Microsoft Corporation */ +#define WAVE_FORMAT_RT24 0x0052 /* InSoft, Inc. */ +#define WAVE_FORMAT_PAC 0x0053 /* InSoft, Inc. */ +#define WAVE_FORMAT_MPEGLAYER3 0x0055 /* ISO/MPEG Layer3 Format Tag */ +#define WAVE_FORMAT_LUCENT_G723 0x0059 /* Lucent Technologies */ +#define WAVE_FORMAT_CIRRUS 0x0060 /* Cirrus Logic */ +#define WAVE_FORMAT_ESPCM 0x0061 /* ESS Technology */ +#define WAVE_FORMAT_VOXWARE 0x0062 /* Voxware Inc */ +#define WAVE_FORMAT_CANOPUS_ATRAC 0x0063 /* Canopus, co., Ltd. */ +#define WAVE_FORMAT_G726_ADPCM 0x0064 /* APICOM */ +#define WAVE_FORMAT_G722_ADPCM 0x0065 /* APICOM */ +#define WAVE_FORMAT_DSAT 0x0066 /* Microsoft Corporation */ +#define WAVE_FORMAT_DSAT_DISPLAY 0x0067 /* Microsoft Corporation */ +#define WAVE_FORMAT_VOXWARE_BYTE_ALIGNED 0x0069 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_AC8 0x0070 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_AC10 0x0071 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_AC16 0x0072 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_AC20 0x0073 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_RT24 0x0074 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_RT29 0x0075 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_RT29HW 0x0076 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_VR12 0x0077 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_VR18 0x0078 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_TQ40 0x0079 /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_SC3 0x007A /* Voxware Inc */ +#define WAVE_FORMAT_VOXWARE_SC3_1 0x007B /* Voxware Inc */ +#define WAVE_FORMAT_SOFTSOUND 0x0080 /* Softsound, Ltd. */ +#define WAVE_FORMAT_VOXWARE_TQ60 0x0081 /* Voxware Inc */ +#define WAVE_FORMAT_MSRT24 0x0082 /* Microsoft Corporation */ +#define WAVE_FORMAT_G729A 0x0083 /* AT&T Labs, Inc. */ +#define WAVE_FORMAT_MVI_MVI2 0x0084 /* Motion Pixels */ +#define WAVE_FORMAT_DF_G726 0x0085 /* DataFusion Systems (Pty) (Ltd) */ +#define WAVE_FORMAT_DF_GSM610 0x0086 /* DataFusion Systems (Pty) (Ltd) */ +#define WAVE_FORMAT_ISIAUDIO 0x0088 /* Iterated Systems, Inc. */ +#define WAVE_FORMAT_ONLIVE 0x0089 /* OnLive! Technologies, Inc. */ +#define WAVE_FORMAT_MULTITUDE_FT_SX20 0x008A /* Multitude Inc. */ +#define WAVE_FORMAT_INFOCOM_ITS_G721_ADPCM 0x008B /* Infocom */ +#define WAVE_FORMAT_CONVEDIA_G729 0x008C /* Convedia Corp. */ +#define WAVE_FORMAT_CONGRUENCY 0x008D /* Congruency Inc. */ +#define WAVE_FORMAT_SBC24 0x0091 /* Siemens Business Communications Sys */ +#define WAVE_FORMAT_DOLBY_AC3_SPDIF 0x0092 /* Sonic Foundry */ +#define WAVE_FORMAT_MEDIASONIC_G723 0x0093 /* MediaSonic */ +#define WAVE_FORMAT_PROSODY_8KBPS 0x0094 /* Aculab plc */ +#define WAVE_FORMAT_ZYXEL_ADPCM 0x0097 /* ZyXEL Communications, Inc. */ +#define WAVE_FORMAT_PHILIPS_LPCBB 0x0098 /* Philips Speech Processing */ +#define WAVE_FORMAT_PACKED 0x0099 /* Studer Professional Audio AG */ +#define WAVE_FORMAT_MALDEN_PHONYTALK 0x00A0 /* Malden Electronics Ltd. */ +#define WAVE_FORMAT_RACAL_RECORDER_GSM 0x00A1 /* Racal recorders */ +#define WAVE_FORMAT_RACAL_RECORDER_G720_A 0x00A2 /* Racal recorders */ +#define WAVE_FORMAT_RACAL_RECORDER_G723_1 0x00A3 /* Racal recorders */ +#define WAVE_FORMAT_RACAL_RECORDER_TETRA_ACELP 0x00A4 /* Racal recorders */ +#define WAVE_FORMAT_NEC_AAC 0x00B0 /* NEC Corp. */ +#define WAVE_FORMAT_RAW_AAC1 0x00FF /* For Raw AAC, with format block AudioSpecificConfig() (as defined by MPEG-4), that follows WAVEFORMATEX */ +#define WAVE_FORMAT_RHETOREX_ADPCM 0x0100 /* Rhetorex Inc. */ +#define WAVE_FORMAT_IRAT 0x0101 /* BeCubed Software Inc. */ +#define WAVE_FORMAT_VIVO_G723 0x0111 /* Vivo Software */ +#define WAVE_FORMAT_VIVO_SIREN 0x0112 /* Vivo Software */ +#define WAVE_FORMAT_PHILIPS_CELP 0x0120 /* Philips Speech Processing */ +#define WAVE_FORMAT_PHILIPS_GRUNDIG 0x0121 /* Philips Speech Processing */ +#define WAVE_FORMAT_DIGITAL_G723 0x0123 /* Digital Equipment Corporation */ +#define WAVE_FORMAT_SANYO_LD_ADPCM 0x0125 /* Sanyo Electric Co., Ltd. */ +#define WAVE_FORMAT_SIPROLAB_ACEPLNET 0x0130 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_SIPROLAB_ACELP4800 0x0131 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_SIPROLAB_ACELP8V3 0x0132 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_SIPROLAB_G729 0x0133 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_SIPROLAB_G729A 0x0134 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_SIPROLAB_KELVIN 0x0135 /* Sipro Lab Telecom Inc. */ +#define WAVE_FORMAT_VOICEAGE_AMR 0x0136 /* VoiceAge Corp. */ +#define WAVE_FORMAT_G726ADPCM 0x0140 /* Dictaphone Corporation */ +#define WAVE_FORMAT_DICTAPHONE_CELP68 0x0141 /* Dictaphone Corporation */ +#define WAVE_FORMAT_DICTAPHONE_CELP54 0x0142 /* Dictaphone Corporation */ +#define WAVE_FORMAT_QUALCOMM_PUREVOICE 0x0150 /* Qualcomm, Inc. */ +#define WAVE_FORMAT_QUALCOMM_HALFRATE 0x0151 /* Qualcomm, Inc. */ +#define WAVE_FORMAT_TUBGSM 0x0155 /* Ring Zero Systems, Inc. */ +#define WAVE_FORMAT_MSAUDIO1 0x0160 /* Microsoft Corporation */ +#define WAVE_FORMAT_WMAUDIO2 0x0161 /* Microsoft Corporation */ +#define WAVE_FORMAT_WMAUDIO3 0x0162 /* Microsoft Corporation */ +#define WAVE_FORMAT_WMAUDIO_LOSSLESS 0x0163 /* Microsoft Corporation */ +#define WAVE_FORMAT_WMASPDIF 0x0164 /* Microsoft Corporation */ +#define WAVE_FORMAT_UNISYS_NAP_ADPCM 0x0170 /* Unisys Corp. */ +#define WAVE_FORMAT_UNISYS_NAP_ULAW 0x0171 /* Unisys Corp. */ +#define WAVE_FORMAT_UNISYS_NAP_ALAW 0x0172 /* Unisys Corp. */ +#define WAVE_FORMAT_UNISYS_NAP_16K 0x0173 /* Unisys Corp. */ +#define WAVE_FORMAT_SYCOM_ACM_SYC008 0x0174 /* SyCom Technologies */ +#define WAVE_FORMAT_SYCOM_ACM_SYC701_G726L 0x0175 /* SyCom Technologies */ +#define WAVE_FORMAT_SYCOM_ACM_SYC701_CELP54 0x0176 /* SyCom Technologies */ +#define WAVE_FORMAT_SYCOM_ACM_SYC701_CELP68 0x0177 /* SyCom Technologies */ +#define WAVE_FORMAT_KNOWLEDGE_ADVENTURE_ADPCM 0x0178 /* Knowledge Adventure, Inc. */ +#define WAVE_FORMAT_FRAUNHOFER_IIS_MPEG2_AAC 0x0180 /* Fraunhofer IIS */ +#define WAVE_FORMAT_DTS_DS 0x0190 /* Digital Theatre Systems, Inc. */ +#define WAVE_FORMAT_CREATIVE_ADPCM 0x0200 /* Creative Labs, Inc */ +#define WAVE_FORMAT_CREATIVE_FASTSPEECH8 0x0202 /* Creative Labs, Inc */ +#define WAVE_FORMAT_CREATIVE_FASTSPEECH10 0x0203 /* Creative Labs, Inc */ +#define WAVE_FORMAT_UHER_ADPCM 0x0210 /* UHER informatic GmbH */ +#define WAVE_FORMAT_ULEAD_DV_AUDIO 0x0215 /* Ulead Systems, Inc. */ +#define WAVE_FORMAT_ULEAD_DV_AUDIO_1 0x0216 /* Ulead Systems, Inc. */ +#define WAVE_FORMAT_QUARTERDECK 0x0220 /* Quarterdeck Corporation */ +#define WAVE_FORMAT_ILINK_VC 0x0230 /* I-link Worldwide */ +#define WAVE_FORMAT_RAW_SPORT 0x0240 /* Aureal Semiconductor */ +#define WAVE_FORMAT_ESST_AC3 0x0241 /* ESS Technology, Inc. */ +#define WAVE_FORMAT_GENERIC_PASSTHRU 0x0249 +#define WAVE_FORMAT_IPI_HSX 0x0250 /* Interactive Products, Inc. */ +#define WAVE_FORMAT_IPI_RPELP 0x0251 /* Interactive Products, Inc. */ +#define WAVE_FORMAT_CS2 0x0260 /* Consistent Software */ +#define WAVE_FORMAT_SONY_SCX 0x0270 /* Sony Corp. */ +#define WAVE_FORMAT_SONY_SCY 0x0271 /* Sony Corp. */ +#define WAVE_FORMAT_SONY_ATRAC3 0x0272 /* Sony Corp. */ +#define WAVE_FORMAT_SONY_SPC 0x0273 /* Sony Corp. */ +#define WAVE_FORMAT_TELUM_AUDIO 0x0280 /* Telum Inc. */ +#define WAVE_FORMAT_TELUM_IA_AUDIO 0x0281 /* Telum Inc. */ +#define WAVE_FORMAT_NORCOM_VOICE_SYSTEMS_ADPCM 0x0285 /* Norcom Electronics Corp. */ +#define WAVE_FORMAT_FM_TOWNS_SND 0x0300 /* Fujitsu Corp. */ +#define WAVE_FORMAT_MICRONAS 0x0350 /* Micronas Semiconductors, Inc. */ +#define WAVE_FORMAT_MICRONAS_CELP833 0x0351 /* Micronas Semiconductors, Inc. */ +#define WAVE_FORMAT_BTV_DIGITAL 0x0400 /* Brooktree Corporation */ +#define WAVE_FORMAT_INTEL_MUSIC_CODER 0x0401 /* Intel Corp. */ +#define WAVE_FORMAT_INDEO_AUDIO 0x0402 /* Ligos */ +#define WAVE_FORMAT_QDESIGN_MUSIC 0x0450 /* QDesign Corporation */ +#define WAVE_FORMAT_ON2_VP7_AUDIO 0x0500 /* On2 Technologies */ +#define WAVE_FORMAT_ON2_VP6_AUDIO 0x0501 /* On2 Technologies */ +#define WAVE_FORMAT_VME_VMPCM 0x0680 /* AT&T Labs, Inc. */ +#define WAVE_FORMAT_TPC 0x0681 /* AT&T Labs, Inc. */ +#define WAVE_FORMAT_LIGHTWAVE_LOSSLESS 0x08AE /* Clearjump */ +#define WAVE_FORMAT_OLIGSM 0x1000 /* Ing C. Olivetti & C., S.p.A. */ +#define WAVE_FORMAT_OLIADPCM 0x1001 /* Ing C. Olivetti & C., S.p.A. */ +#define WAVE_FORMAT_OLICELP 0x1002 /* Ing C. Olivetti & C., S.p.A. */ +#define WAVE_FORMAT_OLISBC 0x1003 /* Ing C. Olivetti & C., S.p.A. */ +#define WAVE_FORMAT_OLIOPR 0x1004 /* Ing C. Olivetti & C., S.p.A. */ +#define WAVE_FORMAT_LH_CODEC 0x1100 /* Lernout & Hauspie */ +#define WAVE_FORMAT_LH_CODEC_CELP 0x1101 /* Lernout & Hauspie */ +#define WAVE_FORMAT_LH_CODEC_SBC8 0x1102 /* Lernout & Hauspie */ +#define WAVE_FORMAT_LH_CODEC_SBC12 0x1103 /* Lernout & Hauspie */ +#define WAVE_FORMAT_LH_CODEC_SBC16 0x1104 /* Lernout & Hauspie */ +#define WAVE_FORMAT_NORRIS 0x1400 /* Norris Communications, Inc. */ +#define WAVE_FORMAT_ISIAUDIO_2 0x1401 /* ISIAudio */ +#define WAVE_FORMAT_SOUNDSPACE_MUSICOMPRESS 0x1500 /* AT&T Labs, Inc. */ +#define WAVE_FORMAT_MPEG_ADTS_AAC 0x1600 /* Microsoft Corporation */ +#define WAVE_FORMAT_MPEG_RAW_AAC 0x1601 /* Microsoft Corporation */ +#define WAVE_FORMAT_MPEG_LOAS 0x1602 /* Microsoft Corporation (MPEG-4 Audio Transport Streams (LOAS/LATM) */ +#define WAVE_FORMAT_NOKIA_MPEG_ADTS_AAC 0x1608 /* Microsoft Corporation */ +#define WAVE_FORMAT_NOKIA_MPEG_RAW_AAC 0x1609 /* Microsoft Corporation */ +#define WAVE_FORMAT_VODAFONE_MPEG_ADTS_AAC 0x160A /* Microsoft Corporation */ +#define WAVE_FORMAT_VODAFONE_MPEG_RAW_AAC 0x160B /* Microsoft Corporation */ +#define WAVE_FORMAT_MPEG_HEAAC 0x1610 /* Microsoft Corporation (MPEG-2 AAC or MPEG-4 HE-AAC v1/v2 streams with any payload (ADTS, ADIF, LOAS/LATM, RAW). Format block includes MP4 AudioSpecificConfig() -- see HEAACWAVEFORMAT below */ +#define WAVE_FORMAT_VOXWARE_RT24_SPEECH 0x181C /* Voxware Inc. */ +#define WAVE_FORMAT_SONICFOUNDRY_LOSSLESS 0x1971 /* Sonic Foundry */ +#define WAVE_FORMAT_INNINGS_TELECOM_ADPCM 0x1979 /* Innings Telecom Inc. */ +#define WAVE_FORMAT_LUCENT_SX8300P 0x1C07 /* Lucent Technologies */ +#define WAVE_FORMAT_LUCENT_SX5363S 0x1C0C /* Lucent Technologies */ +#define WAVE_FORMAT_CUSEEME 0x1F03 /* CUSeeMe */ +#define WAVE_FORMAT_NTCSOFT_ALF2CM_ACM 0x1FC4 /* NTCSoft */ +#define WAVE_FORMAT_DVM 0x2000 /* FAST Multimedia AG */ +#define WAVE_FORMAT_DTS2 0x2001 +#define WAVE_FORMAT_MAKEAVIS 0x3313 +#define WAVE_FORMAT_DIVIO_MPEG4_AAC 0x4143 /* Divio, Inc. */ +#define WAVE_FORMAT_NOKIA_ADAPTIVE_MULTIRATE 0x4201 /* Nokia */ +#define WAVE_FORMAT_DIVIO_G726 0x4243 /* Divio, Inc. */ +#define WAVE_FORMAT_LEAD_SPEECH 0x434C /* LEAD Technologies */ +#define WAVE_FORMAT_LEAD_VORBIS 0x564C /* LEAD Technologies */ +#define WAVE_FORMAT_WAVPACK_AUDIO 0x5756 /* xiph.org */ +#define WAVE_FORMAT_ALAC 0x6C61 /* Apple Lossless */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_1 0x674F /* Ogg Vorbis */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_2 0x6750 /* Ogg Vorbis */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_3 0x6751 /* Ogg Vorbis */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_1_PLUS 0x676F /* Ogg Vorbis */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_2_PLUS 0x6770 /* Ogg Vorbis */ +#define WAVE_FORMAT_OGG_VORBIS_MODE_3_PLUS 0x6771 /* Ogg Vorbis */ +#define WAVE_FORMAT_3COM_NBX 0x7000 /* 3COM Corp. */ +#define WAVE_FORMAT_OPUS 0x704F /* Opus */ +#define WAVE_FORMAT_FAAD_AAC 0x706D +#define WAVE_FORMAT_AMR_NB 0x7361 /* AMR Narrowband */ +#define WAVE_FORMAT_AMR_WB 0x7362 /* AMR Wideband */ +#define WAVE_FORMAT_AMR_WP 0x7363 /* AMR Wideband Plus */ +#define WAVE_FORMAT_GSM_AMR_CBR 0x7A21 /* GSMA/3GPP */ +#define WAVE_FORMAT_GSM_AMR_VBR_SID 0x7A22 /* GSMA/3GPP */ +#define WAVE_FORMAT_COMVERSE_INFOSYS_G723_1 0xA100 /* Comverse Infosys */ +#define WAVE_FORMAT_COMVERSE_INFOSYS_AVQSBC 0xA101 /* Comverse Infosys */ +#define WAVE_FORMAT_COMVERSE_INFOSYS_SBC 0xA102 /* Comverse Infosys */ +#define WAVE_FORMAT_SYMBOL_G729_A 0xA103 /* Symbol Technologies */ +#define WAVE_FORMAT_VOICEAGE_AMR_WB 0xA104 /* VoiceAge Corp. */ +#define WAVE_FORMAT_INGENIENT_G726 0xA105 /* Ingenient Technologies, Inc. */ +#define WAVE_FORMAT_MPEG4_AAC 0xA106 /* ISO/MPEG-4 */ +#define WAVE_FORMAT_ENCORE_G726 0xA107 /* Encore Software */ +#define WAVE_FORMAT_ZOLL_ASAO 0xA108 /* ZOLL Medical Corp. */ +#define WAVE_FORMAT_SPEEX_VOICE 0xA109 /* xiph.org */ +#define WAVE_FORMAT_VIANIX_MASC 0xA10A /* Vianix LLC */ +#define WAVE_FORMAT_WM9_SPECTRUM_ANALYZER 0xA10B /* Microsoft */ +#define WAVE_FORMAT_WMF_SPECTRUM_ANAYZER 0xA10C /* Microsoft */ +#define WAVE_FORMAT_GSM_610 0xA10D +#define WAVE_FORMAT_GSM_620 0xA10E +#define WAVE_FORMAT_GSM_660 0xA10F +#define WAVE_FORMAT_GSM_690 0xA110 +#define WAVE_FORMAT_GSM_ADAPTIVE_MULTIRATE_WB 0xA111 +#define WAVE_FORMAT_POLYCOM_G722 0xA112 /* Polycom */ +#define WAVE_FORMAT_POLYCOM_G728 0xA113 /* Polycom */ +#define WAVE_FORMAT_POLYCOM_G729_A 0xA114 /* Polycom */ +#define WAVE_FORMAT_POLYCOM_SIREN 0xA115 /* Polycom */ +#define WAVE_FORMAT_GLOBAL_IP_ILBC 0xA116 /* Global IP */ +#define WAVE_FORMAT_RADIOTIME_TIME_SHIFT_RADIO 0xA117 /* RadioTime */ +#define WAVE_FORMAT_NICE_ACA 0xA118 /* Nice Systems */ +#define WAVE_FORMAT_NICE_ADPCM 0xA119 /* Nice Systems */ +#define WAVE_FORMAT_VOCORD_G721 0xA11A /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G726 0xA11B /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G722_1 0xA11C /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G728 0xA11D /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G729 0xA11E /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G729_A 0xA11F /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_G723_1 0xA120 /* Vocord Telecom */ +#define WAVE_FORMAT_VOCORD_LBC 0xA121 /* Vocord Telecom */ +#define WAVE_FORMAT_NICE_G728 0xA122 /* Nice Systems */ +#define WAVE_FORMAT_FRACE_TELECOM_G729 0xA123 /* France Telecom */ +#define WAVE_FORMAT_CODIAN 0xA124 /* CODIAN */ +#define WAVE_FORMAT_DOLBY_AC4 0xAC40 /* Dolby AC-4 */ +#define WAVE_FORMAT_FLAC 0xF1AC /* flac.sourceforge.net */ + +#if !defined(WAVE_FORMAT_EXTENSIBLE) +#define WAVE_FORMAT_EXTENSIBLE 0xFFFE /* Microsoft */ +#endif // !defined(WAVE_FORMAT_EXTENSIBLE) + +// +// New wave format development should be based on the +// WAVEFORMATEXTENSIBLE structure. WAVEFORMATEXTENSIBLE allows you to +// avoid having to register a new format tag with Microsoft. However, if +// you must still define a new format tag, the WAVE_FORMAT_DEVELOPMENT +// format tag can be used during the development phase of a new wave +// format. Before shipping, you MUST acquire an official format tag from +// Microsoft. +// +#define WAVE_FORMAT_DEVELOPMENT (0xFFFF) + +#endif /* NONEWWAVE */ + +#ifndef WAVE_FORMAT_PCM + +/* general waveform format structure (information common to all formats) */ +typedef struct waveformat_tag { + WORD wFormatTag; /* format type */ + WORD nChannels; /* number of channels (i.e. mono, stereo...) */ + DWORD nSamplesPerSec; /* sample rate */ + DWORD nAvgBytesPerSec; /* for buffer estimation */ + WORD nBlockAlign; /* block size of data */ +} WAVEFORMAT; +typedef WAVEFORMAT *PWAVEFORMAT; +typedef WAVEFORMAT NEAR *NPWAVEFORMAT; +typedef WAVEFORMAT FAR *LPWAVEFORMAT; + +/* specific waveform format structure for PCM data */ +typedef struct pcmwaveformat_tag { + WAVEFORMAT wf; + WORD wBitsPerSample; +} PCMWAVEFORMAT; +typedef PCMWAVEFORMAT *PPCMWAVEFORMAT; +typedef PCMWAVEFORMAT NEAR *NPPCMWAVEFORMAT; +typedef PCMWAVEFORMAT FAR *LPPCMWAVEFORMAT; + +#endif /* WAVE_FORMAT_PCM */ + +#ifndef WAVE_FORMAT_PCM +#define WAVE_FORMAT_PCM 1 +#endif + +/* general extended waveform format structure + Use this for all NON PCM formats + (information common to all formats) +*/ +#ifndef _WAVEFORMATEX_ +#define _WAVEFORMATEX_ +typedef struct tWAVEFORMATEX +{ + WORD wFormatTag; /* format type */ + WORD nChannels; /* number of channels (i.e. mono, stereo...) */ + DWORD nSamplesPerSec; /* sample rate */ + DWORD nAvgBytesPerSec; /* for buffer estimation */ + WORD nBlockAlign; /* block size of data */ + WORD wBitsPerSample; /* Number of bits per sample of mono data */ + WORD cbSize; /* The count in bytes of the size of + extra information (after cbSize) */ + +} WAVEFORMATEX; +typedef WAVEFORMATEX *PWAVEFORMATEX; +typedef WAVEFORMATEX NEAR *NPWAVEFORMATEX; +typedef WAVEFORMATEX FAR *LPWAVEFORMATEX; +#endif /* _WAVEFORMATEX_ */ + +#ifdef GUID_DEFINED + +#if !defined(_NTRTL_) +#if !defined( DEFINE_GUIDEX ) + #ifndef DEFINE_GUIDEX + #define DEFINE_GUIDEX(name) EXTERN_C const CDECL GUID name + #endif // !defined(DEFINE_GUIDEX) + + #ifndef STATICGUIDOF + #define STATICGUIDOF(guid) STATIC_##guid + #endif // !defined(STATICGUIDOF) +#endif // !defined ( DEFINE_GUIDEX ) +#endif // !defined(_NTRTL_) + +#if !defined( DEFINE_GUIDSTRUCT ) +#if defined(__cplusplus) && _MSC_VER >= 1100 +#define DEFINE_GUIDSTRUCT(g, n) struct __declspec(uuid(g)) n +#define DEFINE_GUIDNAMED(n) __uuidof(struct n) +#else // !defined(__cplusplus) +#define DEFINE_GUIDSTRUCT(g, n) DEFINE_GUIDEX(n) +#define DEFINE_GUIDNAMED(n) n +#endif // !defined(__cplusplus) +#endif + +#if !defined( DEFINE_WAVEFORMATEX_GUID ) +#define DEFINE_WAVEFORMATEX_GUID(x) (USHORT)(x), 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +#endif + +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_PCM ) +#define STATIC_KSDATAFORMAT_SUBTYPE_PCM\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_PCM) +DEFINE_GUIDSTRUCT("00000001-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_PCM); +#define KSDATAFORMAT_SUBTYPE_PCM DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_PCM) +#endif + +#if !defined(RC_INVOKED) /* RC complains about long symbols in #ifs */ +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT ) +#define STATIC_KSDATAFORMAT_SUBTYPE_IEEE_FLOAT\ + DEFINE_WAVEFORMATEX_GUID(WAVE_FORMAT_IEEE_FLOAT) +DEFINE_GUIDSTRUCT("00000003-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_IEEE_FLOAT); +#define KSDATAFORMAT_SUBTYPE_IEEE_FLOAT DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_IEEE_FLOAT) +#endif + +#if !defined( STATIC_KSDATAFORMAT_SUBTYPE_WAVEFORMATEX ) +#define STATIC_KSDATAFORMAT_SUBTYPE_WAVEFORMATEX\ + 0x00000000L, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 +DEFINE_GUIDSTRUCT("00000000-0000-0010-8000-00aa00389b71", KSDATAFORMAT_SUBTYPE_WAVEFORMATEX); +#define KSDATAFORMAT_SUBTYPE_WAVEFORMATEX DEFINE_GUIDNAMED(KSDATAFORMAT_SUBTYPE_WAVEFORMATEX) +#endif +#endif + +#if !defined( INIT_WAVEFORMATEX_GUID ) +#define INIT_WAVEFORMATEX_GUID(Guid, x)\ +{\ + *(Guid) = KSDATAFORMAT_SUBTYPE_WAVEFORMATEX;\ + (Guid)->Data1 = (USHORT)(x);\ +} +#endif + +#if !defined( EXTRACT_WAVEFORMATEX_ID ) +#define EXTRACT_WAVEFORMATEX_ID(Guid)\ + (USHORT)((Guid)->Data1) +#endif + +#if !defined( IS_VALID_WAVEFORMATEX_GUID ) +#define IS_VALID_WAVEFORMATEX_GUID(Guid)\ + (!memcmp(((PUSHORT)&KSDATAFORMAT_SUBTYPE_WAVEFORMATEX) + 1, ((PUSHORT)(Guid)) + 1, sizeof(GUID) - sizeof(USHORT))) +#endif + +// +// New wave format development should be based on the +// WAVEFORMATEXTENSIBLE structure. WAVEFORMATEXTENSIBLE allows you to +// avoid having to register a new format tag with Microsoft. Simply +// define a new GUID value for the WAVEFORMATEXTENSIBLE.SubFormat field +// and use WAVE_FORMAT_EXTENSIBLE in the +// WAVEFORMATEXTENSIBLE.Format.wFormatTag field. +// +#ifndef _WAVEFORMATEXTENSIBLE_ +#define _WAVEFORMATEXTENSIBLE_ +typedef struct { + WAVEFORMATEX Format; + union { + WORD wValidBitsPerSample; /* bits of precision */ + WORD wSamplesPerBlock; /* valid if wBitsPerSample==0 */ + WORD wReserved; /* If neither applies, set to zero. */ + } Samples; + DWORD dwChannelMask; /* which channels are */ + /* present in stream */ + GUID SubFormat; +} WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE; +#endif // !_WAVEFORMATEXTENSIBLE_ + +// +// Extended PCM waveform format structure based on WAVEFORMATEXTENSIBLE. +// Use this for multiple channel and hi-resolution PCM data +// +typedef WAVEFORMATEXTENSIBLE WAVEFORMATPCMEX; /* Format.cbSize = 22 */ +typedef WAVEFORMATPCMEX *PWAVEFORMATPCMEX; +typedef WAVEFORMATPCMEX NEAR *NPWAVEFORMATPCMEX; +typedef WAVEFORMATPCMEX FAR *LPWAVEFORMATPCMEX; + +// +// Extended format structure using IEEE Float data and based +// on WAVEFORMATEXTENSIBLE. Use this for multiple channel +// and hi-resolution PCM data in IEEE floating point format. +// +typedef WAVEFORMATEXTENSIBLE WAVEFORMATIEEEFLOATEX; /* Format.cbSize = 22 */ +typedef WAVEFORMATIEEEFLOATEX *PWAVEFORMATIEEEFLOATEX; +typedef WAVEFORMATIEEEFLOATEX NEAR *NPWAVEFORMATIEEEFLOATEX; +typedef WAVEFORMATIEEEFLOATEX FAR *LPWAVEFORMATIEEEFLOATEX; + +#endif // GUID_DEFINED + +#ifndef _SPEAKER_POSITIONS_ +#define _SPEAKER_POSITIONS_ +// Speaker Positions for dwChannelMask in WAVEFORMATEXTENSIBLE: +#define SPEAKER_FRONT_LEFT 0x1 +#define SPEAKER_FRONT_RIGHT 0x2 +#define SPEAKER_FRONT_CENTER 0x4 +#define SPEAKER_LOW_FREQUENCY 0x8 +#define SPEAKER_BACK_LEFT 0x10 +#define SPEAKER_BACK_RIGHT 0x20 +#define SPEAKER_FRONT_LEFT_OF_CENTER 0x40 +#define SPEAKER_FRONT_RIGHT_OF_CENTER 0x80 +#define SPEAKER_BACK_CENTER 0x100 +#define SPEAKER_SIDE_LEFT 0x200 +#define SPEAKER_SIDE_RIGHT 0x400 +#define SPEAKER_TOP_CENTER 0x800 +#define SPEAKER_TOP_FRONT_LEFT 0x1000 +#define SPEAKER_TOP_FRONT_CENTER 0x2000 +#define SPEAKER_TOP_FRONT_RIGHT 0x4000 +#define SPEAKER_TOP_BACK_LEFT 0x8000 +#define SPEAKER_TOP_BACK_CENTER 0x10000 +#define SPEAKER_TOP_BACK_RIGHT 0x20000 + +// Bit mask locations reserved for future use +#define SPEAKER_RESERVED 0x7FFC0000 + +// Used to specify that any possible permutation of speaker configurations +#define SPEAKER_ALL 0x80000000 +#endif // _SPEAKER_POSITIONS_ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP| WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#ifndef NONEWWAVE + +#pragma region Application or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP| WINAPI_PARTITION_GAMES) + +/* Define data for MS ADPCM */ + +typedef struct adpcmcoef_tag { + short iCoef1; + short iCoef2; +} ADPCMCOEFSET; +typedef ADPCMCOEFSET *PADPCMCOEFSET; +typedef ADPCMCOEFSET NEAR *NPADPCMCOEFSET; +typedef ADPCMCOEFSET FAR *LPADPCMCOEFSET; + +/* + * this pragma disables the warning issued by the Microsoft C compiler + * when using a zero size array as place holder when compiling for + * C++ or with -W4. + * + */ +#ifdef _MSC_VER +#pragma warning(push) +#pragma warning(disable:4200) +#endif + +typedef struct adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; + WORD wNumCoef; +#if defined( _MSC_VER ) + ADPCMCOEFSET aCoef[]; +#else + ADPCMCOEFSET aCoef[1]; +#endif +} ADPCMWAVEFORMAT; +typedef ADPCMWAVEFORMAT *PADPCMWAVEFORMAT; +typedef ADPCMWAVEFORMAT NEAR *NPADPCMWAVEFORMAT; +typedef ADPCMWAVEFORMAT FAR *LPADPCMWAVEFORMAT; + +#ifdef _MSC_VER +#pragma warning(pop) +#endif + +// +// Microsoft's DRM structure definitions +// +typedef struct drmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wReserved; + ULONG ulContentId; + WAVEFORMATEX wfxSecure; +} DRMWAVEFORMAT; +typedef DRMWAVEFORMAT *PDRMWAVEFORMAT; +typedef DRMWAVEFORMAT NEAR *NPDRMWAVEFORMAT; +typedef DRMWAVEFORMAT FAR *LPDRMWAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// Intel's DVI ADPCM structure definitions +// +// for WAVE_FORMAT_DVI_ADPCM (0x0011) +// +// + +typedef struct dvi_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} DVIADPCMWAVEFORMAT; +typedef DVIADPCMWAVEFORMAT *PDVIADPCMWAVEFORMAT; +typedef DVIADPCMWAVEFORMAT NEAR *NPDVIADPCMWAVEFORMAT; +typedef DVIADPCMWAVEFORMAT FAR *LPDVIADPCMWAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +// +// IMA endorsed ADPCM structure definitions--note that this is exactly +// the same format as Intel's DVI ADPCM. +// +// for WAVE_FORMAT_IMA_ADPCM (0x0011) +// +// + +typedef struct ima_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} IMAADPCMWAVEFORMAT; +typedef IMAADPCMWAVEFORMAT *PIMAADPCMWAVEFORMAT; +typedef IMAADPCMWAVEFORMAT NEAR *NPIMAADPCMWAVEFORMAT; +typedef IMAADPCMWAVEFORMAT FAR *LPIMAADPCMWAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/* +//VideoLogic's Media Space ADPCM Structure definitions +// for WAVE_FORMAT_MEDIASPACE_ADPCM (0x0012) +// +// +*/ +typedef struct mediaspace_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} MEDIASPACEADPCMWAVEFORMAT; +typedef MEDIASPACEADPCMWAVEFORMAT *PMEDIASPACEADPCMWAVEFORMAT; +typedef MEDIASPACEADPCMWAVEFORMAT NEAR *NPMEDIASPACEADPCMWAVEFORMAT; +typedef MEDIASPACEADPCMWAVEFORMAT FAR *LPMEDIASPACEADPCMWAVEFORMAT; + +// +// Sierra Semiconductor +// +// for WAVE_FORMAT_SIERRA_ADPCM (0x0013) +// +// + +typedef struct sierra_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} SIERRAADPCMWAVEFORMAT; +typedef SIERRAADPCMWAVEFORMAT *PSIERRAADPCMWAVEFORMAT; +typedef SIERRAADPCMWAVEFORMAT NEAR *NPSIERRAADPCMWAVEFORMAT; +typedef SIERRAADPCMWAVEFORMAT FAR *LPSIERRAADPCMWAVEFORMAT; + +// +// Antex Electronics structure definitions +// +// for WAVE_FORMAT_G723_ADPCM (0x0014) +// +// + +typedef struct g723_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD cbExtraSize; + WORD nAuxBlockSize; +} G723_ADPCMWAVEFORMAT; +typedef G723_ADPCMWAVEFORMAT *PG723_ADPCMWAVEFORMAT; +typedef G723_ADPCMWAVEFORMAT NEAR *NPG723_ADPCMWAVEFORMAT; +typedef G723_ADPCMWAVEFORMAT FAR *LPG723_ADPCMWAVEFORMAT; + +// +// DSP Solutions (formerly DIGISPEECH) structure definitions +// +// for WAVE_FORMAT_DIGISTD (0x0015) +// +// + +typedef struct digistdwaveformat_tag { + WAVEFORMATEX wfx; +} DIGISTDWAVEFORMAT; +typedef DIGISTDWAVEFORMAT *PDIGISTDWAVEFORMAT; +typedef DIGISTDWAVEFORMAT NEAR *NPDIGISTDWAVEFORMAT; +typedef DIGISTDWAVEFORMAT FAR *LPDIGISTDWAVEFORMAT; + +// +// DSP Solutions (formerly DIGISPEECH) structure definitions +// +// for WAVE_FORMAT_DIGIFIX (0x0016) +// +// + +typedef struct digifixwaveformat_tag { + WAVEFORMATEX wfx; +} DIGIFIXWAVEFORMAT; +typedef DIGIFIXWAVEFORMAT *PDIGIFIXWAVEFORMAT; +typedef DIGIFIXWAVEFORMAT NEAR *NPDIGIFIXWAVEFORMAT; +typedef DIGIFIXWAVEFORMAT FAR *LPDIGIFIXWAVEFORMAT; + +// +// Dialogic Corporation +// WAVEFORMAT_DIALOGIC_OKI_ADPCM (0x0017) +// +typedef struct creative_fastspeechformat_tag{ + WAVEFORMATEX ewf; +}DIALOGICOKIADPCMWAVEFORMAT; +typedef DIALOGICOKIADPCMWAVEFORMAT *PDIALOGICOKIADPCMWAVEFORMAT; +typedef DIALOGICOKIADPCMWAVEFORMAT NEAR *NPDIALOGICOKIADPCMWAVEFORMAT; +typedef DIALOGICOKIADPCMWAVEFORMAT FAR *LPDIALOGICOKIADPCMWAVEFORMAT; + +// +// Yamaha Compression's ADPCM structure definitions +// +// for WAVE_FORMAT_YAMAHA_ADPCM (0x0020) +// +// + +typedef struct yamaha_adpmcwaveformat_tag { + WAVEFORMATEX wfx; + +} YAMAHA_ADPCMWAVEFORMAT; +typedef YAMAHA_ADPCMWAVEFORMAT *PYAMAHA_ADPCMWAVEFORMAT; +typedef YAMAHA_ADPCMWAVEFORMAT NEAR *NPYAMAHA_ADPCMWAVEFORMAT; +typedef YAMAHA_ADPCMWAVEFORMAT FAR *LPYAMAHA_ADPCMWAVEFORMAT; + +// +// Speech Compression's Sonarc structure definitions +// +// for WAVE_FORMAT_SONARC (0x0021) +// +// + +typedef struct sonarcwaveformat_tag { + WAVEFORMATEX wfx; + WORD wCompType; +} SONARCWAVEFORMAT; +typedef SONARCWAVEFORMAT *PSONARCWAVEFORMAT; +typedef SONARCWAVEFORMAT NEAR *NPSONARCWAVEFORMAT; +typedef SONARCWAVEFORMAT FAR *LPSONARCWAVEFORMAT; + +// +// DSP Groups's TRUESPEECH structure definitions +// +// for WAVE_FORMAT_DSPGROUP_TRUESPEECH (0x0022) +// +// + +typedef struct truespeechwaveformat_tag { + WAVEFORMATEX wfx; + WORD wRevision; + WORD nSamplesPerBlock; + BYTE abReserved[28]; +} TRUESPEECHWAVEFORMAT; +typedef TRUESPEECHWAVEFORMAT *PTRUESPEECHWAVEFORMAT; +typedef TRUESPEECHWAVEFORMAT NEAR *NPTRUESPEECHWAVEFORMAT; +typedef TRUESPEECHWAVEFORMAT FAR *LPTRUESPEECHWAVEFORMAT; + +// +// Echo Speech Corp structure definitions +// +// for WAVE_FORMAT_ECHOSC1 (0x0023) +// +// + +typedef struct echosc1waveformat_tag { + WAVEFORMATEX wfx; +} ECHOSC1WAVEFORMAT; +typedef ECHOSC1WAVEFORMAT *PECHOSC1WAVEFORMAT; +typedef ECHOSC1WAVEFORMAT NEAR *NPECHOSC1WAVEFORMAT; +typedef ECHOSC1WAVEFORMAT FAR *LPECHOSC1WAVEFORMAT; + +// +// Audiofile Inc.structure definitions +// +// for WAVE_FORMAT_AUDIOFILE_AF36 (0x0024) +// +// + +typedef struct audiofile_af36waveformat_tag { + WAVEFORMATEX wfx; +} AUDIOFILE_AF36WAVEFORMAT; +typedef AUDIOFILE_AF36WAVEFORMAT *PAUDIOFILE_AF36WAVEFORMAT; +typedef AUDIOFILE_AF36WAVEFORMAT NEAR *NPAUDIOFILE_AF36WAVEFORMAT; +typedef AUDIOFILE_AF36WAVEFORMAT FAR *LPAUDIOFILE_AF36WAVEFORMAT; + +// +// Audio Processing Technology structure definitions +// +// for WAVE_FORMAT_APTX (0x0025) +// +// +typedef struct aptxwaveformat_tag { + WAVEFORMATEX wfx; +} APTXWAVEFORMAT; +typedef APTXWAVEFORMAT *PAPTXWAVEFORMAT; +typedef APTXWAVEFORMAT NEAR *NPAPTXWAVEFORMAT; +typedef APTXWAVEFORMAT FAR *LPAPTXWAVEFORMAT; + +// +// Audiofile Inc.structure definitions +// +// for WAVE_FORMAT_AUDIOFILE_AF10 (0x0026) +// +// + +typedef struct audiofile_af10waveformat_tag { + WAVEFORMATEX wfx; +} AUDIOFILE_AF10WAVEFORMAT; +typedef AUDIOFILE_AF10WAVEFORMAT *PAUDIOFILE_AF10WAVEFORMAT; +typedef AUDIOFILE_AF10WAVEFORMAT NEAR *NPAUDIOFILE_AF10WAVEFORMAT; +typedef AUDIOFILE_AF10WAVEFORMAT FAR *LPAUDIOFILE_AF10WAVEFORMAT; + +// +/* Dolby's AC-2 wave format structure definition + WAVE_FORMAT_DOLBY_AC2 (0x0030)*/ +// +typedef struct dolbyac2waveformat_tag { + WAVEFORMATEX wfx; + WORD nAuxBitsCode; +} DOLBYAC2WAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +/*Microsoft's */ +// WAVE_FORMAT_GSM 610 0x0031 +// +typedef struct gsm610waveformat_tag { +WAVEFORMATEX wfx; +WORD wSamplesPerBlock; +} GSM610WAVEFORMAT; +typedef GSM610WAVEFORMAT *PGSM610WAVEFORMAT; +typedef GSM610WAVEFORMAT NEAR *NPGSM610WAVEFORMAT; +typedef GSM610WAVEFORMAT FAR *LPGSM610WAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// Antex Electronics Corp +// +// for WAVE_FORMAT_ADPCME (0x0033) +// +// + +typedef struct adpcmewaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} ADPCMEWAVEFORMAT; +typedef ADPCMEWAVEFORMAT *PADPCMEWAVEFORMAT; +typedef ADPCMEWAVEFORMAT NEAR *NPADPCMEWAVEFORMAT; +typedef ADPCMEWAVEFORMAT FAR *LPADPCMEWAVEFORMAT; + +/* Control Resources Limited */ +// WAVE_FORMAT_CONTROL_RES_VQLPC 0x0034 +// +typedef struct contres_vqlpcwaveformat_tag { +WAVEFORMATEX wfx; +WORD wSamplesPerBlock; +} CONTRESVQLPCWAVEFORMAT; +typedef CONTRESVQLPCWAVEFORMAT *PCONTRESVQLPCWAVEFORMAT; +typedef CONTRESVQLPCWAVEFORMAT NEAR *NPCONTRESVQLPCWAVEFORMAT; +typedef CONTRESVQLPCWAVEFORMAT FAR *LPCONTRESVQLPCWAVEFORMAT; + +// +// +// +// for WAVE_FORMAT_DIGIREAL (0x0035) +// +// + +typedef struct digirealwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} DIGIREALWAVEFORMAT; +typedef DIGIREALWAVEFORMAT *PDIGIREALWAVEFORMAT; +typedef DIGIREALWAVEFORMAT NEAR *NPDIGIREALWAVEFORMAT; +typedef DIGIREALWAVEFORMAT FAR *LPDIGIREALWAVEFORMAT; + +// +// DSP Solutions +// +// for WAVE_FORMAT_DIGIADPCM (0x0036) +// +// + +typedef struct digiadpcmmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} DIGIADPCMWAVEFORMAT; +typedef DIGIADPCMWAVEFORMAT *PDIGIADPCMWAVEFORMAT; +typedef DIGIADPCMWAVEFORMAT NEAR *NPDIGIADPCMWAVEFORMAT; +typedef DIGIADPCMWAVEFORMAT FAR *LPDIGIADPCMWAVEFORMAT; + +/* Control Resources Limited */ +// WAVE_FORMAT_CONTROL_RES_CR10 0x0037 +// +typedef struct contres_cr10waveformat_tag { +WAVEFORMATEX wfx; +WORD wSamplesPerBlock; +} CONTRESCR10WAVEFORMAT; +typedef CONTRESCR10WAVEFORMAT *PCONTRESCR10WAVEFORMAT; +typedef CONTRESCR10WAVEFORMAT NEAR *NPCONTRESCR10WAVEFORMAT; +typedef CONTRESCR10WAVEFORMAT FAR *LPCONTRESCR10WAVEFORMAT; + +// +// Natural Microsystems +// +// for WAVE_FORMAT_NMS_VBXADPCM (0x0038) +// +// + +typedef struct nms_vbxadpcmmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; +} NMS_VBXADPCMWAVEFORMAT; +typedef NMS_VBXADPCMWAVEFORMAT *PNMS_VBXADPCMWAVEFORMAT; +typedef NMS_VBXADPCMWAVEFORMAT NEAR *NPNMS_VBXADPCMWAVEFORMAT; +typedef NMS_VBXADPCMWAVEFORMAT FAR *LPNMS_VBXADPCMWAVEFORMAT; + +// +// Antex Electronics structure definitions +// +// for WAVE_FORMAT_G721_ADPCM (0x0040) +// +// + +typedef struct g721_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD nAuxBlockSize; +} G721_ADPCMWAVEFORMAT; +typedef G721_ADPCMWAVEFORMAT *PG721_ADPCMWAVEFORMAT; +typedef G721_ADPCMWAVEFORMAT NEAR *NPG721_ADPCMWAVEFORMAT; +typedef G721_ADPCMWAVEFORMAT FAR *LPG721_ADPCMWAVEFORMAT; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Application or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) + +// +// +// Microsoft MPEG audio WAV definition +// +/* MPEG-1 audio wave format (audio layer only). (0x0050) */ +typedef struct mpeg1waveformat_tag { + WAVEFORMATEX wfx; + WORD fwHeadLayer; + DWORD dwHeadBitrate; + WORD fwHeadMode; + WORD fwHeadModeExt; + WORD wHeadEmphasis; + WORD fwHeadFlags; + DWORD dwPTSLow; + DWORD dwPTSHigh; +} MPEG1WAVEFORMAT; +typedef MPEG1WAVEFORMAT *PMPEG1WAVEFORMAT; +typedef MPEG1WAVEFORMAT NEAR *NPMPEG1WAVEFORMAT; +typedef MPEG1WAVEFORMAT FAR *LPMPEG1WAVEFORMAT; + +#define ACM_MPEG_LAYER1 (0x0001) +#define ACM_MPEG_LAYER2 (0x0002) +#define ACM_MPEG_LAYER3 (0x0004) +#define ACM_MPEG_STEREO (0x0001) +#define ACM_MPEG_JOINTSTEREO (0x0002) +#define ACM_MPEG_DUALCHANNEL (0x0004) +#define ACM_MPEG_SINGLECHANNEL (0x0008) +#define ACM_MPEG_PRIVATEBIT (0x0001) +#define ACM_MPEG_COPYRIGHT (0x0002) +#define ACM_MPEG_ORIGINALHOME (0x0004) +#define ACM_MPEG_PROTECTIONBIT (0x0008) +#define ACM_MPEG_ID_MPEG1 (0x0010) + +// +// MPEG Layer3 WAVEFORMATEX structure +// for WAVE_FORMAT_MPEGLAYER3 (0x0055) +// +#define MPEGLAYER3_WFX_EXTRA_BYTES 12 + +// WAVE_FORMAT_MPEGLAYER3 format sructure +// +typedef struct mpeglayer3waveformat_tag { + WAVEFORMATEX wfx; + WORD wID; + DWORD fdwFlags; + WORD nBlockSize; + WORD nFramesPerBlock; + WORD nCodecDelay; +} MPEGLAYER3WAVEFORMAT; + +typedef MPEGLAYER3WAVEFORMAT *PMPEGLAYER3WAVEFORMAT; +typedef MPEGLAYER3WAVEFORMAT NEAR *NPMPEGLAYER3WAVEFORMAT; +typedef MPEGLAYER3WAVEFORMAT FAR *LPMPEGLAYER3WAVEFORMAT; + +//==========================================================================; + +#define MPEGLAYER3_ID_UNKNOWN 0 +#define MPEGLAYER3_ID_MPEG 1 +#define MPEGLAYER3_ID_CONSTANTFRAMESIZE 2 + +#define MPEGLAYER3_FLAG_PADDING_ISO 0x00000000 +#define MPEGLAYER3_FLAG_PADDING_ON 0x00000001 +#define MPEGLAYER3_FLAG_PADDING_OFF 0x00000002 + +/* ========================================================================== + + For WAVE_FORMAT_MPEG_HEAAC (0x1610) + + + "MPEG-2" in the comments below refers to ISO/IEC 13818-7 (MPEG-2 AAC spec). + "MPEG-4" in the comments below refers to ISO/IEC 14496-3 (MPEG-4 Audio spec). + + The following defines the format block to be used for MPEG-2 AAC or MPEG-4 HE-AAC v1/v2 streams. + When setting media type attributes in Media Foundation (MF) objects, this will appear in conjunction with + major type MFMediaType_Audio and sub type MFAudioFormat_AAC (=MEDIASUBTYPE_MPEG_HEAAC). + The format block structure HEAACWAVEFORMAT is defined below. It starts with the structure + HEAACWAVEINFO (which is an extension of WAVEFORMATEX), followed by AudioSpecificConfig() as + defined by ISO/IEC 14496-3 (MPEG-4 audio). Since the length of AudioSpecificConfig() may vary + from one stream to another, this is a variable size format block. + + The WAVEFORMATEX fields describe the properties of the core AAC stream, + without SBR/PS extensions (if exists). This is the description of the WAVEFORMATEX fields: + + wfx.wFormatTag - Set this to WAVE_FORMAT_MPEG_HEAAC (0x1610). + + wfx.nChannels - Total number of channels in core AAC stream (including LFE if exists). + This might be different than the decoded number of channels if the MPEG-4 Parametric Stereo (PS) + tool exists. If unknown, set to zero. + + wfx.nSamplesPerSec - Sampling rate of core AAC stream. This will be one of the 12 supported + sampling rate between 8000 and 96000 Hz, as defined in MPEG-2. This might be different than + the decoded sampling rate if the MPEG-4 Spectral Band Replication (SBR) tool exists. + If not know in advance, the sampling rate can be extracted from: + - the 4-bit sampling_frequency_index field in adts_fixed_header(), or + - program_config_element() in adif_header for MPEG-2 streams, or + - the 4-bit samplingFrequencyIndex field in AudioSpecificConfig() for MPEG-4 streams. + + wfx.nAvgBytesPerSec - The average bytes per second calculated based on the average bit rate of + the compressed stream. This value may be used by parsers to seek into a particular time offset + in the stream. It may also be used by applications to determine roughly how much buffer length to allocate. + If this is not known in advance, this value can be estimated by parsing some (or all) of the + compressed HE-AAC frames and calculating bit rate based on average compressed frame size. + If unknown, set to zero. + + wfx.nBlockAlign - Set this to 1. + + wfx.wBitsPerSample - Desired bit depth of the decoded PCM. If unknown, set to zero. + + wfx.cbSize - Set this to 12 (=sizeof(HEAACWAVEINFO)-sizeof(WAVEFORMATEX)) plus the + size of AudioSpecificConfig() in bytes. + + =================================== + + How do we parse this format block? assume pbBuff is the address of the first + byte in the format block. We do the following: + + HEAACWAVEINFO* pwfInfo = (HEAACWAVEINFO *)pbBuff; + + if ( 0 == pwfInfo->wStructType) + { + HEAACWAVEFORMAT* pwf = (HEAACWAVEFORMAT*)pbBuff; + + // All HEAACWAVEFORMAT fields can now be accessed through pwf + // ... + + // + // To parse AudioSpecifiConfig(), write a function such as + // ParseAudioSpecificConfig(BYTE *pbASC, DWORD dwASCLen), + // and call: + // + DWORD dwASCLen = pwf->wfInfo.wfx.cbSize - sizeof(HEAACWAVEINFO) + sizeof(WAVEFORMATEX); + + ParseAudioSpecificConfig(pwf->pbAudioSpecificConfig, dwASCLen); + } + else + { + // Reserved + } +*/ + +typedef struct heaacwaveinfo_tag { + + // Defines core AAC properties. See description above. WAVEFORMATEX is of size 18 bytes. + WAVEFORMATEX wfx; + + // Defines the payload type + // 0-RAW. The stream contains raw_data_block() elements only. + // 1-ADTS. The stream contains an adts_sequence(), as defined by MPEG-2. + // 2-ADIF. The stream contains an adif_sequence(), as defined by MPEG-2. + // 3-LOAS. The stream contains an MPEG-4 audio transport stream with a + // synchronization layer LOAS and a multiplex layer LATM. + // All other codes are reserved. + WORD wPayloadType; + + // This is the 8-bit field audioProfileLevelIndication available in the + // MPEG-4 object descriptor. It is an indication (as defined in MPEG-4 audio) + // of the audio profile and level required to process the content associated + // with this stream. For example values 0x28-0x2B correspond to AAC Profile, + // values 0x2C-0x2F correspond to HE-AAC profile and 0x30-0x33 for HE-AAC v2 profile. + // If unknown, set to zero or 0xFE ("no audio profile specified"). + WORD wAudioProfileLevelIndication; + + // Defines the data that follows this structure. Currently only one data type is supported: + // 0- AudioSpecificConfig() (as defined by MPEG-4 Audio, ISO/IEC 14496-3) will follow this structure. + // wfx.cbSize will indicate the total length including AudioSpecificConfig(). + // Use HEAACWAVEFORMAT to gain easy access to the address of the first byte of + // AudioSpecificConfig() for parsing. + // Typical values for the size of AudioSpecificConfig (ASC) are: + // - 2 bytes for AAC or HE-AAC v1/v2 with implicit signaling of SBR, + // - 5 bytes for HE-AAC v1 with explicit signaling of SBR, + // - 7 bytes for HE-AAC v2 with explicit signaling of SBR and PS. + // The size may be longer than 7 bytes if the 4-bit channelConfiguration field in ASC is zero, + // which means program_config_element() is present in ASC. + // + // All other codes are reserved. + WORD wStructType; + + // Set these to zero + WORD wReserved1; + DWORD dwReserved2; + +} HEAACWAVEINFO; // this structure has a size of 30 bytes + +typedef HEAACWAVEINFO *PHEAACWAVEINFO; +typedef HEAACWAVEINFO NEAR *NPHEAACWAVEINFO; +typedef HEAACWAVEINFO FAR *LPHEAACWAVEINFO; + +// +// This structure describes the format block for wStructType=0 +// +typedef struct heaacwaveformat_tag { + + HEAACWAVEINFO wfInfo; // This structure has a size of 30 bytes + BYTE pbAudioSpecificConfig[1]; // First byte of AudioSpecificConfig() + +} HEAACWAVEFORMAT; // This structure has a size of 31 bytes + +typedef HEAACWAVEFORMAT *PHEAACWAVEFORMAT; +typedef HEAACWAVEFORMAT NEAR *NPHEAACWAVEFORMAT; +typedef HEAACWAVEFORMAT FAR *LPHEAACWAVEFORMAT; + + +//========================================================================== + + +// +// Windows Media Audio (common) +// +// + +#define MM_MSFT_ACM_WMAUDIO 39 + +#define WMAUDIO_BITS_PER_SAMPLE 16 // just an uncompressed size... +#define WMAUDIO_MAX_CHANNELS 2 + +// +// Windows Media Audio V1 (a.k.a. "MSAudio") +// +// for WAVE_FORMAT_MSAUDIO1 (0x0160) +// +// +#define MM_MSFT_ACM_MSAUDIO1 39 + +typedef struct msaudio1waveformat_tag { + WAVEFORMATEX wfx; + WORD wSamplesPerBlock; // only counting "new" samples "= half of what will be used due to overlapping + WORD wEncodeOptions; +} MSAUDIO1WAVEFORMAT; + +typedef MSAUDIO1WAVEFORMAT FAR *LPMSAUDIO1WAVEFORMAT; + +#define MSAUDIO1_BITS_PER_SAMPLE WMAUDIO_BITS_PER_SAMPLE +#define MSAUDIO1_MAX_CHANNELS WMAUDIO_MAX_CHANNELS +#define MSAUDIO1_WFX_EXTRA_BYTES (sizeof(MSAUDIO1WAVEFORMAT) - sizeof(WAVEFORMATEX)) + +// +// Windows Media Audio V2 +// +// for WAVE_FORMAT_WMAUDIO2 (0x0161) +// +// + +#define MM_MSFT_ACM_WMAUDIO2 101 + +typedef struct wmaudio2waveformat_tag { + WAVEFORMATEX wfx; + DWORD dwSamplesPerBlock; // only counting "new" samples "= half of what will be used due to overlapping + WORD wEncodeOptions; + DWORD dwSuperBlockAlign; // the big size... should be multiples of wfx.nBlockAlign. +} WMAUDIO2WAVEFORMAT; + +typedef WMAUDIO2WAVEFORMAT FAR *LPWMAUDIO2WAVEFORMAT; + +#define WMAUDIO2_BITS_PER_SAMPLE WMAUDIO_BITS_PER_SAMPLE +#define WMAUDIO2_MAX_CHANNELS WMAUDIO_MAX_CHANNELS +#define WMAUDIO2_WFX_EXTRA_BYTES (sizeof(WMAUDIO2WAVEFORMAT) - sizeof(WAVEFORMATEX)) + +// +// Windows Media Audio V3 +// +// for WAVE_FORMAT_WMAUDIO3 (0x0162) +// +// + +typedef struct wmaudio3waveformat_tag { + WAVEFORMATEX wfx; + WORD wValidBitsPerSample; // bits of precision + DWORD dwChannelMask; // which channels are present in stream + DWORD dwReserved1; + DWORD dwReserved2; + WORD wEncodeOptions; + WORD wReserved3; +} WMAUDIO3WAVEFORMAT; + +typedef WMAUDIO3WAVEFORMAT FAR *LPWMAUDIO3WAVEFORMAT; +#define WMAUDIO3_WFX_EXTRA_BYTES (sizeof(WMAUDIO3WAVEFORMAT) - sizeof(WAVEFORMATEX)) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// Creative's ADPCM structure definitions +// +// for WAVE_FORMAT_CREATIVE_ADPCM (0x0200) +// +// + +typedef struct creative_adpcmwaveformat_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} CREATIVEADPCMWAVEFORMAT; +typedef CREATIVEADPCMWAVEFORMAT *PCREATIVEADPCMWAVEFORMAT; +typedef CREATIVEADPCMWAVEFORMAT NEAR *NPCREATIVEADPCMWAVEFORMAT; +typedef CREATIVEADPCMWAVEFORMAT FAR *LPCREATIVEADPCMWAVEFORMAT; + +// +// Creative FASTSPEECH +// WAVEFORMAT_CREATIVE_FASTSPEECH8 (0x0202) +// +typedef struct creative_fastspeech8format_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} CREATIVEFASTSPEECH8WAVEFORMAT; +typedef CREATIVEFASTSPEECH8WAVEFORMAT *PCREATIVEFASTSPEECH8WAVEFORMAT; +typedef CREATIVEFASTSPEECH8WAVEFORMAT NEAR *NPCREATIVEFASTSPEECH8WAVEFORMAT; +typedef CREATIVEFASTSPEECH8WAVEFORMAT FAR *LPCREATIVEFASTSPEECH8WAVEFORMAT; +// +// Creative FASTSPEECH +// WAVEFORMAT_CREATIVE_FASTSPEECH10 (0x0203) +// +typedef struct creative_fastspeech10format_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} CREATIVEFASTSPEECH10WAVEFORMAT; +typedef CREATIVEFASTSPEECH10WAVEFORMAT *PCREATIVEFASTSPEECH10WAVEFORMAT; +typedef CREATIVEFASTSPEECH10WAVEFORMAT NEAR *NPCREATIVEFASTSPEECH10WAVEFORMAT; +typedef CREATIVEFASTSPEECH10WAVEFORMAT FAR *LPCREATIVEFASTSPEECH10WAVEFORMAT; + +// +// Fujitsu FM Towns 'SND' structure +// +// for WAVE_FORMAT_FMMTOWNS_SND (0x0300) +// +// + +typedef struct fmtowns_snd_waveformat_tag { + WAVEFORMATEX wfx; + WORD wRevision; +} FMTOWNS_SND_WAVEFORMAT; +typedef FMTOWNS_SND_WAVEFORMAT *PFMTOWNS_SND_WAVEFORMAT; +typedef FMTOWNS_SND_WAVEFORMAT NEAR *NPFMTOWNS_SND_WAVEFORMAT; +typedef FMTOWNS_SND_WAVEFORMAT FAR *LPFMTOWNS_SND_WAVEFORMAT; + +// +// Olivetti structure +// +// for WAVE_FORMAT_OLIGSM (0x1000) +// +// + +typedef struct oligsmwaveformat_tag { + WAVEFORMATEX wfx; +} OLIGSMWAVEFORMAT; +typedef OLIGSMWAVEFORMAT *POLIGSMWAVEFORMAT; +typedef OLIGSMWAVEFORMAT NEAR *NPOLIGSMWAVEFORMAT; +typedef OLIGSMWAVEFORMAT FAR *LPOLIGSMWAVEFORMAT; + +// +// Olivetti structure +// +// for WAVE_FORMAT_OLIADPCM (0x1001) +// +// + +typedef struct oliadpcmwaveformat_tag { + WAVEFORMATEX wfx; +} OLIADPCMWAVEFORMAT; +typedef OLIADPCMWAVEFORMAT *POLIADPCMWAVEFORMAT; +typedef OLIADPCMWAVEFORMAT NEAR *NPOLIADPCMWAVEFORMAT ; +typedef OLIADPCMWAVEFORMAT FAR *LPOLIADPCMWAVEFORMAT; + +// +// Olivetti structure +// +// for WAVE_FORMAT_OLICELP (0x1002) +// +// + +typedef struct olicelpwaveformat_tag { + WAVEFORMATEX wfx; +} OLICELPWAVEFORMAT; +typedef OLICELPWAVEFORMAT *POLICELPWAVEFORMAT; +typedef OLICELPWAVEFORMAT NEAR *NPOLICELPWAVEFORMAT ; +typedef OLICELPWAVEFORMAT FAR *LPOLICELPWAVEFORMAT; + +// +// Olivetti structure +// +// for WAVE_FORMAT_OLISBC (0x1003) +// +// + +typedef struct olisbcwaveformat_tag { + WAVEFORMATEX wfx; +} OLISBCWAVEFORMAT; +typedef OLISBCWAVEFORMAT *POLISBCWAVEFORMAT; +typedef OLISBCWAVEFORMAT NEAR *NPOLISBCWAVEFORMAT ; +typedef OLISBCWAVEFORMAT FAR *LPOLISBCWAVEFORMAT; + +// +// Olivetti structure +// +// for WAVE_FORMAT_OLIOPR (0x1004) +// +// + +typedef struct olioprwaveformat_tag { + WAVEFORMATEX wfx; +} OLIOPRWAVEFORMAT; +typedef OLIOPRWAVEFORMAT *POLIOPRWAVEFORMAT; +typedef OLIOPRWAVEFORMAT NEAR *NPOLIOPRWAVEFORMAT ; +typedef OLIOPRWAVEFORMAT FAR *LPOLIOPRWAVEFORMAT; + +// +// Crystal Semiconductor IMA ADPCM format +// +// for WAVE_FORMAT_CS_IMAADPCM (0x0039) +// +// + +typedef struct csimaadpcmwaveformat_tag { + WAVEFORMATEX wfx; +} CSIMAADPCMWAVEFORMAT; +typedef CSIMAADPCMWAVEFORMAT *PCSIMAADPCMWAVEFORMAT; +typedef CSIMAADPCMWAVEFORMAT NEAR *NPCSIMAADPCMWAVEFORMAT ; +typedef CSIMAADPCMWAVEFORMAT FAR *LPCSIMAADPCMWAVEFORMAT; + +//==========================================================================; +// +// ACM Wave Filters +// +// +//==========================================================================; + +#ifndef _ACM_WAVEFILTER +#define _ACM_WAVEFILTER + +#define WAVE_FILTER_UNKNOWN 0x0000 +#define WAVE_FILTER_DEVELOPMENT (0xFFFF) + +typedef struct wavefilter_tag { + DWORD cbStruct; /* Size of the filter in bytes */ + DWORD dwFilterTag; /* filter type */ + DWORD fdwFilter; /* Flags for the filter (Universal Dfns) */ + DWORD dwReserved[5]; /* Reserved for system use */ +} WAVEFILTER; +typedef WAVEFILTER *PWAVEFILTER; +typedef WAVEFILTER NEAR *NPWAVEFILTER; +typedef WAVEFILTER FAR *LPWAVEFILTER; + +#endif /* _ACM_WAVEFILTER */ + +#ifndef WAVE_FILTER_VOLUME +#define WAVE_FILTER_VOLUME 0x0001 + +typedef struct wavefilter_volume_tag { + WAVEFILTER wfltr; + DWORD dwVolume; +} VOLUMEWAVEFILTER; +typedef VOLUMEWAVEFILTER *PVOLUMEWAVEFILTER; +typedef VOLUMEWAVEFILTER NEAR *NPVOLUMEWAVEFILTER; +typedef VOLUMEWAVEFILTER FAR *LPVOLUMEWAVEFILTER; + +#endif /* WAVE_FILTER_VOLUME */ + +#ifndef WAVE_FILTER_ECHO +#define WAVE_FILTER_ECHO 0x0002 + +typedef struct wavefilter_echo_tag { + WAVEFILTER wfltr; + DWORD dwVolume; + DWORD dwDelay; +} ECHOWAVEFILTER; +typedef ECHOWAVEFILTER *PECHOWAVEFILTER; +typedef ECHOWAVEFILTER NEAR *NPECHOWAVEFILTER; +typedef ECHOWAVEFILTER FAR *LPECHOWAVEFILTER; + +#endif /* WAVEFILTER_ECHO */ + +/* ------------------------------------------------------------------------------ */ +// +// New RIFF WAVE Chunks +// + +#define RIFFWAVE_inst mmioFOURCC('i','n','s','t') + +struct tag_s_RIFFWAVE_inst { + BYTE bUnshiftedNote; + char chFineTune; + char chGain; + BYTE bLowNote; + BYTE bHighNote; + BYTE bLowVelocity; + BYTE bHighVelocity; +}; + +typedef struct tag_s_RIFFWAVE_INST s_RIFFWAVE_inst; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/* ------------------------------------------------------------------------------ */ +// +// New RIFF Forms +// + +#ifndef NONEWRIFF + +/* RIFF AVI */ + +// +// AVI file format is specified in a seperate file (AVIFMT.H), +// which is available in the VfW and Win 32 SDK +// + +/* RIFF CPPO */ + +#define RIFFCPPO mmioFOURCC('C','P','P','O') + +#define RIFFCPPO_objr mmioFOURCC('o','b','j','r') +#define RIFFCPPO_obji mmioFOURCC('o','b','j','i') + +#define RIFFCPPO_clsr mmioFOURCC('c','l','s','r') +#define RIFFCPPO_clsi mmioFOURCC('c','l','s','i') + +#define RIFFCPPO_mbr mmioFOURCC('m','b','r',' ') + +#define RIFFCPPO_char mmioFOURCC('c','h','a','r') + +#define RIFFCPPO_byte mmioFOURCC('b','y','t','e') +#define RIFFCPPO_int mmioFOURCC('i','n','t',' ') +#define RIFFCPPO_word mmioFOURCC('w','o','r','d') +#define RIFFCPPO_long mmioFOURCC('l','o','n','g') +#define RIFFCPPO_dwrd mmioFOURCC('d','w','r','d') +#define RIFFCPPO_flt mmioFOURCC('f','l','t',' ') +#define RIFFCPPO_dbl mmioFOURCC('d','b','l',' ') +#define RIFFCPPO_str mmioFOURCC('s','t','r',' ') + +#endif + +/* +////////////////////////////////////////////////////////////////////////// +// +// DIB Compression Defines +// +*/ + +#ifndef BI_BITFIELDS +#define BI_BITFIELDS 3 +#endif + +#ifndef QUERYDIBSUPPORT + +#define QUERYDIBSUPPORT 3073 +#define QDI_SETDIBITS 0x0001 +#define QDI_GETDIBITS 0x0002 +#define QDI_DIBTOSCREEN 0x0004 +#define QDI_STRETCHDIB 0x0008 + +#endif + +#ifndef NOBITMAP +/* Structure definitions */ + +typedef struct tagEXBMINFOHEADER { + BITMAPINFOHEADER bmi; + /* extended BITMAPINFOHEADER fields */ + DWORD biExtDataOffset; + + /* Other stuff will go here */ + + /* ... */ + + /* Format-specific information */ + /* biExtDataOffset points here */ + +} EXBMINFOHEADER; + +#endif //NOBITMAP + +/* New DIB Compression Defines */ + +#define BICOMP_IBMULTIMOTION mmioFOURCC('U', 'L', 'T', 'I') +#define BICOMP_IBMPHOTOMOTION mmioFOURCC('P', 'H', 'M', 'O') +#define BICOMP_CREATIVEYUV mmioFOURCC('c', 'y', 'u', 'v') + +#ifndef NOJPEGDIB + +/* New DIB Compression Defines */ +#define JPEG_DIB mmioFOURCC('J','P','E','G') /* Still image JPEG DIB biCompression */ +#define MJPG_DIB mmioFOURCC('M','J','P','G') /* Motion JPEG DIB biCompression */ + +/* JPEGProcess Definitions */ +#define JPEG_PROCESS_BASELINE 0 /* Baseline DCT */ + +/* AVI File format extensions */ +#define AVIIF_CONTROLFRAME 0x00000200L /* This is a control frame */ + + /* JIF Marker byte pairs in JPEG Interchange Format sequence */ +#define JIFMK_SOF0 0xFFC0 /* SOF Huff - Baseline DCT*/ +#define JIFMK_SOF1 0xFFC1 /* SOF Huff - Extended sequential DCT*/ +#define JIFMK_SOF2 0xFFC2 /* SOF Huff - Progressive DCT*/ +#define JIFMK_SOF3 0xFFC3 /* SOF Huff - Spatial (sequential) lossless*/ +#define JIFMK_SOF5 0xFFC5 /* SOF Huff - Differential sequential DCT*/ +#define JIFMK_SOF6 0xFFC6 /* SOF Huff - Differential progressive DCT*/ +#define JIFMK_SOF7 0xFFC7 /* SOF Huff - Differential spatial*/ +#define JIFMK_JPG 0xFFC8 /* SOF Arith - Reserved for JPEG extensions*/ +#define JIFMK_SOF9 0xFFC9 /* SOF Arith - Extended sequential DCT*/ +#define JIFMK_SOF10 0xFFCA /* SOF Arith - Progressive DCT*/ +#define JIFMK_SOF11 0xFFCB /* SOF Arith - Spatial (sequential) lossless*/ +#define JIFMK_SOF13 0xFFCD /* SOF Arith - Differential sequential DCT*/ +#define JIFMK_SOF14 0xFFCE /* SOF Arith - Differential progressive DCT*/ +#define JIFMK_SOF15 0xFFCF /* SOF Arith - Differential spatial*/ +#define JIFMK_DHT 0xFFC4 /* Define Huffman Table(s) */ +#define JIFMK_DAC 0xFFCC /* Define Arithmetic coding conditioning(s) */ +#define JIFMK_RST0 0xFFD0 /* Restart with modulo 8 count 0 */ +#define JIFMK_RST1 0xFFD1 /* Restart with modulo 8 count 1 */ +#define JIFMK_RST2 0xFFD2 /* Restart with modulo 8 count 2 */ +#define JIFMK_RST3 0xFFD3 /* Restart with modulo 8 count 3 */ +#define JIFMK_RST4 0xFFD4 /* Restart with modulo 8 count 4 */ +#define JIFMK_RST5 0xFFD5 /* Restart with modulo 8 count 5 */ +#define JIFMK_RST6 0xFFD6 /* Restart with modulo 8 count 6 */ +#define JIFMK_RST7 0xFFD7 /* Restart with modulo 8 count 7 */ +#define JIFMK_SOI 0xFFD8 /* Start of Image */ +#define JIFMK_EOI 0xFFD9 /* End of Image */ +#define JIFMK_SOS 0xFFDA /* Start of Scan */ +#define JIFMK_DQT 0xFFDB /* Define quantization Table(s) */ +#define JIFMK_DNL 0xFFDC /* Define Number of Lines */ +#define JIFMK_DRI 0xFFDD /* Define Restart Interval */ +#define JIFMK_DHP 0xFFDE /* Define Hierarchical progression */ +#define JIFMK_EXP 0xFFDF /* Expand Reference Component(s) */ +#define JIFMK_APP0 0xFFE0 /* Application Field 0*/ +#define JIFMK_APP1 0xFFE1 /* Application Field 1*/ +#define JIFMK_APP2 0xFFE2 /* Application Field 2*/ +#define JIFMK_APP3 0xFFE3 /* Application Field 3*/ +#define JIFMK_APP4 0xFFE4 /* Application Field 4*/ +#define JIFMK_APP5 0xFFE5 /* Application Field 5*/ +#define JIFMK_APP6 0xFFE6 /* Application Field 6*/ +#define JIFMK_APP7 0xFFE7 /* Application Field 7*/ +#define JIFMK_JPG0 0xFFF0 /* Reserved for JPEG extensions */ +#define JIFMK_JPG1 0xFFF1 /* Reserved for JPEG extensions */ +#define JIFMK_JPG2 0xFFF2 /* Reserved for JPEG extensions */ +#define JIFMK_JPG3 0xFFF3 /* Reserved for JPEG extensions */ +#define JIFMK_JPG4 0xFFF4 /* Reserved for JPEG extensions */ +#define JIFMK_JPG5 0xFFF5 /* Reserved for JPEG extensions */ +#define JIFMK_JPG6 0xFFF6 /* Reserved for JPEG extensions */ +#define JIFMK_JPG7 0xFFF7 /* Reserved for JPEG extensions */ +#define JIFMK_JPG8 0xFFF8 /* Reserved for JPEG extensions */ +#define JIFMK_JPG9 0xFFF9 /* Reserved for JPEG extensions */ +#define JIFMK_JPG10 0xFFFA /* Reserved for JPEG extensions */ +#define JIFMK_JPG11 0xFFFB /* Reserved for JPEG extensions */ +#define JIFMK_JPG12 0xFFFC /* Reserved for JPEG extensions */ +#define JIFMK_JPG13 0xFFFD /* Reserved for JPEG extensions */ +#define JIFMK_COM 0xFFFE /* Comment */ +#define JIFMK_TEM 0xFF01 /* for temp private use arith code */ +#define JIFMK_RES 0xFF02 /* Reserved */ +#define JIFMK_00 0xFF00 /* Zero stuffed byte - entropy data */ +#define JIFMK_FF 0xFFFF /* Fill byte */ + +/* JPEGColorSpaceID Definitions */ +#define JPEG_Y 1 /* Y only component of YCbCr */ +#define JPEG_YCbCr 2 /* YCbCr as define by CCIR 601 */ +#define JPEG_RGB 3 /* 3 component RGB */ + +/* Structure definitions */ + +typedef struct tagJPEGINFOHEADER { + /* compression-specific fields */ + /* these fields are defined for 'JPEG' and 'MJPG' */ + DWORD JPEGSize; + DWORD JPEGProcess; + + /* Process specific fields */ + DWORD JPEGColorSpaceID; + DWORD JPEGBitsPerSample; + DWORD JPEGHSubSampling; + DWORD JPEGVSubSampling; +} JPEGINFOHEADER; + +#ifdef MJPGDHTSEG_STORAGE + +/* Default DHT Segment */ + +MJPGDHTSEG_STORAGE BYTE MJPGDHTSeg[0x1A4] = { + /* JPEG DHT Segment for YCrCb omitted from MJPG data */ +0xFF,0xC4,0x01,0xA2, +0x00,0x00,0x01,0x05,0x01,0x01,0x01,0x01,0x01,0x01,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, +0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x01,0x00,0x03,0x01,0x01,0x01,0x01, +0x01,0x01,0x01,0x01,0x01,0x00,0x00,0x00,0x00,0x00,0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07, +0x08,0x09,0x0A,0x0B,0x10,0x00,0x02,0x01,0x03,0x03,0x02,0x04,0x03,0x05,0x05,0x04,0x04,0x00, +0x00,0x01,0x7D,0x01,0x02,0x03,0x00,0x04,0x11,0x05,0x12,0x21,0x31,0x41,0x06,0x13,0x51,0x61, +0x07,0x22,0x71,0x14,0x32,0x81,0x91,0xA1,0x08,0x23,0x42,0xB1,0xC1,0x15,0x52,0xD1,0xF0,0x24, +0x33,0x62,0x72,0x82,0x09,0x0A,0x16,0x17,0x18,0x19,0x1A,0x25,0x26,0x27,0x28,0x29,0x2A,0x34, +0x35,0x36,0x37,0x38,0x39,0x3A,0x43,0x44,0x45,0x46,0x47,0x48,0x49,0x4A,0x53,0x54,0x55,0x56, +0x57,0x58,0x59,0x5A,0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6A,0x73,0x74,0x75,0x76,0x77,0x78, +0x79,0x7A,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8A,0x92,0x93,0x94,0x95,0x96,0x97,0x98,0x99, +0x9A,0xA2,0xA3,0xA4,0xA5,0xA6,0xA7,0xA8,0xA9,0xAA,0xB2,0xB3,0xB4,0xB5,0xB6,0xB7,0xB8,0xB9, +0xBA,0xC2,0xC3,0xC4,0xC5,0xC6,0xC7,0xC8,0xC9,0xCA,0xD2,0xD3,0xD4,0xD5,0xD6,0xD7,0xD8,0xD9, +0xDA,0xE1,0xE2,0xE3,0xE4,0xE5,0xE6,0xE7,0xE8,0xE9,0xEA,0xF1,0xF2,0xF3,0xF4,0xF5,0xF6,0xF7, +0xF8,0xF9,0xFA,0x11,0x00,0x02,0x01,0x02,0x04,0x04,0x03,0x04,0x07,0x05,0x04,0x04,0x00,0x01, +0x02,0x77,0x00,0x01,0x02,0x03,0x11,0x04,0x05,0x21,0x31,0x06,0x12,0x41,0x51,0x07,0x61,0x71, +0x13,0x22,0x32,0x81,0x08,0x14,0x42,0x91,0xA1,0xB1,0xC1,0x09,0x23,0x33,0x52,0xF0,0x15,0x62, +0x72,0xD1,0x0A,0x16,0x24,0x34,0xE1,0x25,0xF1,0x17,0x18,0x19,0x1A,0x26,0x27,0x28,0x29,0x2A, +0x35,0x36,0x37,0x38,0x39,0x3A,0x43,0x44,0x45,0x46,0x47,0x48,0x49,0x4A,0x53,0x54,0x55,0x56, +0x57,0x58,0x59,0x5A,0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6A,0x73,0x74,0x75,0x76,0x77,0x78, +0x79,0x7A,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x8A,0x92,0x93,0x94,0x95,0x96,0x97,0x98, +0x99,0x9A,0xA2,0xA3,0xA4,0xA5,0xA6,0xA7,0xA8,0xA9,0xAA,0xB2,0xB3,0xB4,0xB5,0xB6,0xB7,0xB8, +0xB9,0xBA,0xC2,0xC3,0xC4,0xC5,0xC6,0xC7,0xC8,0xC9,0xCA,0xD2,0xD3,0xD4,0xD5,0xD6,0xD7,0xD8, +0xD9,0xDA,0xE2,0xE3,0xE4,0xE5,0xE6,0xE7,0xE8,0xE9,0xEA,0xF2,0xF3,0xF4,0xF5,0xF6,0xF7,0xF8, +0xF9,0xFA +}; + +/* End DHT default */ +#endif + +/* End JPEG */ +#endif + +/* ------------------------------------------------------------------------------ */ +// +// Defined IC types +// + +#ifndef NONEWIC + +#ifndef ICTYPE_VIDEO +#define ICTYPE_VIDEO mmioFOURCC('v', 'i', 'd', 'c') +#define ICTYPE_AUDIO mmioFOURCC('a', 'u', 'd', 'c') +#endif + +#endif +/* +// Misc. FOURCC registration +*/ + +/* Sierra Semiconductor: RDSP- Proprietary RIFF file format +// for the storage and downloading of DSP +// code for Audio and communications devices. +*/ +#define FOURCC_RDSP mmioFOURCC('R', 'D', 'S', 'P') + +#ifndef MMNOMIXER +#define MIXERCONTROL_CONTROLTYPE_SRS_MTS (MIXERCONTROL_CONTROLTYPE_BOOLEAN + 6) +#define MIXERCONTROL_CONTROLTYPE_SRS_ONOFF (MIXERCONTROL_CONTROLTYPE_BOOLEAN + 7) +#define MIXERCONTROL_CONTROLTYPE_SRS_SYNTHSELECT (MIXERCONTROL_CONTROLTYPE_BOOLEAN + 8) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#if !defined( RC_INVOKED ) && defined( _MSC_VER ) +#if _MSC_VER <= 800 +#pragma pack(1) +#else +#include "poppack.h" /* Revert to default packing */ +#endif +#endif /* RC_INVOKED */ + +#ifdef __cplusplus +} /* End of extern "C" { */ +#endif /* __cplusplus */ + +#endif /* _INC_MMREG */ + +#else /* __midl */ + +cpp_quote("#if 0") +#pragma pack(push, 1) +typedef struct tWAVEFORMATEX +{ + + WORD wFormatTag; + WORD nChannels; + DWORD nSamplesPerSec; + DWORD nAvgBytesPerSec; + WORD nBlockAlign; + WORD wBitsPerSample; + WORD cbSize; + [size_is(cbSize)] BYTE pExtraBytes[]; +} WAVEFORMATEX, *PWAVEFORMATEX, *NPWAVEFORMATEX, *LPWAVEFORMATEX; + +typedef struct { + WORD wFormatTag; + WORD nChannels; + DWORD nSamplesPerSec; + DWORD nAvgBytesPerSec; + WORD nBlockAlign; + WORD wBitsPerSample; + WORD cbSize; + WORD wValidBitsPerSample; + DWORD dwChannelMask; + GUID SubFormat; +} WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE; + +#pragma pack(pop) /* Assume byte packing throughout */ +cpp_quote("#endif /* 0 */") + +#endif /* __midl */ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mprapidef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mprapidef.h new file mode 100644 index 0000000000000000000000000000000000000000..e91dce09c1c0d58728ff62443903191556c9cdf4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mprapidef.h @@ -0,0 +1,22 @@ +/**************************************************************************** +* * +* mprapidef.h -- MPR definitions shared between user and kernel mode * +* * +* Copyright (c) Microsoft Corporation. All rights reserved. * +* * +****************************************************************************/ + +#ifndef _MPRAPIDEF_ +#define _MPRAPIDEF_ + +#include + +#define MAX_INTERFACE_NAME_LEN 256 +#define MAX_TRANSPORT_NAME_LEN 40 +#define MAX_MEDIA_NAME 16 +#define MAX_PORT_NAME 16 +#define MAX_DEVICE_NAME 128 +#define MAX_PHONE_NUMBER_LEN 128 +#define MAX_DEVICETYPE_NAME 16 + +#endif // _MPRAPIDEF_ \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/msapofxproxy.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/msapofxproxy.h new file mode 100644 index 0000000000000000000000000000000000000000..1191a7989f4dffa15dd40e914c55951654dc6994 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/msapofxproxy.h @@ -0,0 +1,47 @@ +// +// MsApoFxProxy.h -- Copyright (c) Microsoft Corporation. All rights reserved. +// +// Description: +// +// Public definitions for MsApoFxProxy APO +// + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#ifndef _MSAPOFXPROXY_PUBLIC_HEADERFILE_ +#define _MSAPOFXPROXY_PUBLIC_HEADERFILE_ + +#ifdef _MSC_VER +#pragma once +#endif // _MSC_VER + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#include + +#define STATIC_KSPROPSETID_AudioEffectsDiscovery\ + 0xb217a72, 0x16b8, 0x4a4d, 0xbd, 0xed, 0xf9, 0xd6, 0xbb, 0xed, 0xcd, 0x8f +DEFINE_GUIDSTRUCT("0B217A72-16B8-4A4D-BDED-F9D6BBEDCD8F", KSPROPSETID_AudioEffectsDiscovery); +#define KSPROPSETID_AudioEffectsDiscovery DEFINE_GUIDNAMED(KSPROPSETID_AudioEffectsDiscovery) + +// define new property id +typedef enum { + KSPROPERTY_AUDIOEFFECTSDISCOVERY_EFFECTSLIST = 1, +} KSPROPERTY_AUDIOEFFECTSDISCOVERY; + +// Property data for KSPROPERTY_AUDIOEFFECTSDISCOVERY_EFFECTSLIST +typedef struct tagKSP_PINMODE +{ + KSP_PIN PinProperty; + GUID AudioProcessingMode; +} KSP_PINMODE, *PKSP_PINMODE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif //_MSAPOFXPROXY_PUBLIC_HEADERFILE_ + +#endif //NTDDI_VERSION \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mstcpip.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mstcpip.h new file mode 100644 index 0000000000000000000000000000000000000000..100f0dd5cfc567193f90df8574fa03748861243b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mstcpip.h @@ -0,0 +1,2177 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + mstcpip.h + +Abstract: + + This module contains Microsoft-specific extensions to the core + Winsock definitions. + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef _MSTCPIP_ +#define _MSTCPIP_ + +#if (NTDDI_VERSION >= NTDDI_WIN7) +// GUID definition for use with Secure Sockets API +// aec2ef9c-3a4d-4d3e-8842-239942e39a47 +DEFINE_GUID( + SOCKET_DEFAULT2_QM_POLICY, + 0xaec2ef9c, + 0x3a4d, + 0x4d3e, + 0x88, 0x42, 0x23, 0x99, 0x42, 0xe3, 0x9a, 0x47 +); +// GUID definition for use with Real Time Notification setting API. +// 6b59819a-5cae-492d-a901-2a3c2c50164f +DEFINE_GUID( + REAL_TIME_NOTIFICATION_CAPABILITY, + 0x6b59819a, + 0x5cae, + 0x492d, + 0xa9, 0x01, 0x2a, 0x3c, 0x2c, 0x50, 0x16, 0x4f +); +// GUID definition for use with Real Time Notification setting API. +// 6843da03-154a-4616-a508-44371295f96b +DEFINE_GUID( + REAL_TIME_NOTIFICATION_CAPABILITY_EX, + 0x6843da03, + 0x154a, + 0x4616, + 0xa5, 0x08, 0x44, 0x37, 0x12, 0x95, 0xf9, 0x6b +); +// GUID definition for use with Associate Namres Context API. +// {59A38B67-D4FE-46E1-BA3C-87EA74CA3049} +DEFINE_GUID( + ASSOCIATE_NAMERES_CONTEXT, + 0x59a38b67, + 0xd4fe, + 0x46e1, + 0xba, 0x3c, 0x87, 0xea, 0x74, 0xca, 0x30, 0x49 +); +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#ifndef GUID_DEFS_ONLY +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma warning(push) +#pragma warning(disable:4200) +#pragma warning(disable:4201) + +#ifdef _PREFAST_ +#pragma prefast(push) +#pragma prefast(disable: 24002, "Requires explicit use of IPv4 address types.") +#endif + +#ifndef ASSERT +#define MSTCPIP_ASSERT_UNDEFINED +#define ASSERT(exp) ((VOID) 0) +#endif + +#ifdef _MSC_VER +#define MSTCPIP_INLINE __inline +#else +#define MSTCPIP_INLINE extern inline /* GNU style */ +#endif + +#include + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) +typedef enum _TCPSTATE { + TCPSTATE_CLOSED, + TCPSTATE_LISTEN, + TCPSTATE_SYN_SENT, + TCPSTATE_SYN_RCVD, + TCPSTATE_ESTABLISHED, + TCPSTATE_FIN_WAIT_1, + TCPSTATE_FIN_WAIT_2, + TCPSTATE_CLOSE_WAIT, + TCPSTATE_CLOSING, + TCPSTATE_LAST_ACK, + TCPSTATE_TIME_WAIT, + TCPSTATE_MAX +} TCPSTATE; +#endif // NTDDI_VERSION >= NTDDI_WIN10_RS2 + +#ifndef _TRANSPORT_SETTING_COMMON_ +#define _TRANSPORT_SETTING_COMMON_ + +// +// This structure represents the key used in query and apply transport setting +// APIs. +// +typedef struct TRANSPORT_SETTING_ID +{ + GUID Guid; +} TRANSPORT_SETTING_ID, *PTRANSPORT_SETTING_ID; + +#endif // _TRANSPORT_SETTING_COMMON_ + +// +// Argument structure for SIO_KEEPALIVE_VALS. +// +struct tcp_keepalive { + ULONG onoff; + ULONG keepalivetime; + ULONG keepaliveinterval; +}; + +// +// Argument structures for SIO_APPLY_TRANSPORT_SETTING and +// SIO_QUERY_TRANSPORT_SETTING. +// +typedef enum +{ + CONTROL_CHANNEL_TRIGGER_STATUS_INVALID = 0, + CONTROL_CHANNEL_TRIGGER_STATUS_SOFTWARE_SLOT_ALLOCATED = 1, + CONTROL_CHANNEL_TRIGGER_STATUS_HARDWARE_SLOT_ALLOCATED = 2, + CONTROL_CHANNEL_TRIGGER_STATUS_POLICY_ERROR = 3, + CONTROL_CHANNEL_TRIGGER_STATUS_SYSTEM_ERROR = 4, + CONTROL_CHANNEL_TRIGGER_STATUS_TRANSPORT_DISCONNECTED = 5, + CONTROL_CHANNEL_TRIGGER_STATUS_SERVICE_UNAVAILABLE = 6, +} CONTROL_CHANNEL_TRIGGER_STATUS, *PCONTROL_CHANNEL_TRIGGER_STATUS; + +#define CONTROL_CHANNEL_TRIGGER_STATUS_MAX CONTROL_CHANNEL_TRIGGER_STATUS_SYSTEM_ERROR + +typedef struct _REAL_TIME_NOTIFICATION_SETTING_INPUT +{ + TRANSPORT_SETTING_ID TransportSettingId; + GUID BrokerEventGuid; +} REAL_TIME_NOTIFICATION_SETTING_INPUT, *PREAL_TIME_NOTIFICATION_SETTING_INPUT; + +typedef struct _REAL_TIME_NOTIFICATION_SETTING_INPUT_EX +{ + TRANSPORT_SETTING_ID TransportSettingId; + GUID BrokerEventGuid; + BOOLEAN Unmark; +} REAL_TIME_NOTIFICATION_SETTING_INPUT_EX, *PREAL_TIME_NOTIFICATION_SETTING_INPUT_EX; + +typedef struct _REAL_TIME_NOTIFICATION_SETTING_OUTPUT +{ + CONTROL_CHANNEL_TRIGGER_STATUS ChannelStatus; +} REAL_TIME_NOTIFICATION_SETTING_OUTPUT, *PREAL_TIME_NOTIFICATION_SETTING_OUTPUT; + +typedef struct _ASSOCIATE_NAMERES_CONTEXT_INPUT +{ + TRANSPORT_SETTING_ID TransportSettingId; + + // + // Stores Handle as UINT64 to keep size consistent accross 32-bit and + // 64-bit processes. + // + UINT64 Handle; +} ASSOCIATE_NAMERES_CONTEXT_INPUT, *PASSOCIATE_NAMERES_CONTEXT_INPUT; + +// +// WSAIoctl Options +// +#define SIO_RCVALL _WSAIOW(IOC_VENDOR,1) +#define SIO_RCVALL_MCAST _WSAIOW(IOC_VENDOR,2) +#define SIO_RCVALL_IGMPMCAST _WSAIOW(IOC_VENDOR,3) +#define SIO_KEEPALIVE_VALS _WSAIOW(IOC_VENDOR,4) +#define SIO_ABSORB_RTRALERT _WSAIOW(IOC_VENDOR,5) +#define SIO_UCAST_IF _WSAIOW(IOC_VENDOR,6) +#define SIO_LIMIT_BROADCASTS _WSAIOW(IOC_VENDOR,7) +#define SIO_INDEX_BIND _WSAIOW(IOC_VENDOR,8) +#define SIO_INDEX_MCASTIF _WSAIOW(IOC_VENDOR,9) +#define SIO_INDEX_ADD_MCAST _WSAIOW(IOC_VENDOR,10) +#define SIO_INDEX_DEL_MCAST _WSAIOW(IOC_VENDOR,11) +#define SIO_RCVALL_MCAST_IF _WSAIOW(IOC_VENDOR,13) +#define SIO_RCVALL_IF _WSAIOW(IOC_VENDOR,14) +#define SIO_LOOPBACK_FAST_PATH _WSAIOW(IOC_VENDOR,16) +#define SIO_TCP_INITIAL_RTO _WSAIOW(IOC_VENDOR,17) +#define SIO_APPLY_TRANSPORT_SETTING _WSAIOW(IOC_VENDOR,19) +#define SIO_QUERY_TRANSPORT_SETTING _WSAIOW(IOC_VENDOR,20) +#define SIO_TCP_SET_ICW _WSAIOW(IOC_VENDOR,22) +#define SIO_TCP_SET_ACK_FREQUENCY _WSAIOW(IOC_VENDOR,23) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +#define SIO_SET_PRIORITY_HINT _WSAIOW(IOC_VENDOR,24) +#endif // NTDDI_VERSION >= NTDDI_WIN10_RS3 +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) +#define SIO_PRIORITY_HINT SIO_SET_PRIORITY_HINT +#endif // NTDDI_VERSION >= NTDDI_WIN10_FE +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) +#define SIO_TCP_INFO _WSAIORW(IOC_VENDOR,39) +#endif // NTDDI_VERSION >= NTDDI_WIN10_RS2 +#if (NTDDI_VERSION >= NTDDI_WIN10_VB) +// +// Socket IOCTL for port sharing per processor sockets. +// +#define SIO_CPU_AFFINITY _WSAIOW(IOC_VENDOR,21) +#endif // NTDDI_VERSION >= NTDDI_WIN10_VB + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) +// +// Socket IOCTL used for configuring timestamp reception. Only valid for +// datagram sockets. +// +#define SIO_TIMESTAMPING _WSAIOW(IOC_VENDOR, 235) + +// +// Input structure for SIO_TIMESTAMPING configuration option. +// +// Flags - Enable/disable timestamp reception for rx/tx direction. +// TxTimestampsBuffered - Determines how many tx timestamps may be buffered. +// When TxTimestampsBuffered tx timestamps are buffered +// and a new tx timestamp has been generated, the new +// timestamp will be discarded. +// +typedef struct _TIMESTAMPING_CONFIG { + ULONG Flags; + USHORT TxTimestampsBuffered; +} TIMESTAMPING_CONFIG, *PTIMESTAMPING_CONFIG; + +// +// Flags for the TIMESTAMPING_CONFIG struct. Specify a flag to enable, or omit +// to disable timestamp reception for that direction. +// +#define TIMESTAMPING_FLAG_RX 0x1 +#define TIMESTAMPING_FLAG_TX 0x2 + +// +// Control message type for returning a rx timestamp through WSARecvMsg. +// The control message data is returned as a UINT64. +// +#define SO_TIMESTAMP 0x300A + +// +// Control message type for specifying a tx timestamp ID through WSASendMsg. +// The control message data is supplied as a UINT32. +// +#define SO_TIMESTAMP_ID 0x300B + +// +// Socket IOCTL to get timestamps for transmitted packets. Enable timestamp +// reception first by using the SIO_TIMESTAMPING socket IOCTL, then retrieve tx +// timestamps by ID using this IOCTL. Only valid for datagram sockets. +// +// Input is a UINT32 timestamp ID. +// Output is a UINT64 timestamp value. +// On success, the tx timestamp is available and is returned. +// On failure, the tx timestamp is unavailable. WSAGetLastError will return +// WSAEWOULDBLOCK. +// +#define SIO_GET_TX_TIMESTAMP _WSAIOW(IOC_VENDOR, 234) + +// +// This enum maps to the PRIORITY_HINT enum defined in WinBase.h. +// +typedef enum { + SocketPriorityHintVeryLow = 0, + SocketPriorityHintLow, + SocketPriorityHintNormal, + SocketMaximumPriorityHintType +} SOCKET_PRIORITY_HINT, *PSOCKET_PRIORITY_HINT; + +typedef struct _PRIORITY_STATUS { + SOCKET_PRIORITY_HINT Sender; + SOCKET_PRIORITY_HINT Receiver; +} PRIORITY_STATUS, *PPRIORITY_STATUS; +#endif // NTDDI_VERSION >= NTDDI_WIN10_FE + + +// +// Values for use with SIO_RCVALL* options +// +typedef enum { + RCVALL_OFF = 0, + RCVALL_ON = 1, + RCVALL_SOCKETLEVELONLY = 2, + RCVALL_IPLEVEL = 3, +} RCVALL_VALUE, *PRCVALL_VALUE; + +#define RCVALL_MAX RCVALL_IPLEVEL + +typedef struct { + RCVALL_VALUE Mode; + ULONG Interface; +} RCVALL_IF, *PRCVALL_IF; + +// +// Parameters to configure the initial RTT. +// + +#define TCP_INITIAL_RTO_UNSPECIFIED_RTT ((USHORT) -1) +#define TCP_INITIAL_RTO_UNSPECIFIED_MAX_SYN_RETRANSMISSIONS ((UCHAR) -1) + +#define TCP_INITIAL_RTO_DEFAULT_RTT (0) +#define TCP_INITIAL_RTO_DEFAULT_MAX_SYN_RETRANSMISSIONS (0) +#define TCP_INITIAL_RTO_NO_SYN_RETRANSMISSIONS ((UCHAR) -2) + +typedef struct _TCP_INITIAL_RTO_PARAMETERS { + + // + // Supplies the initial RTT in milliseconds. + // + + USHORT Rtt; + + // + // Supplies the number of retransmissions attempted before the connection + // setup fails. + // + + UCHAR MaxSynRetransmissions; + +} TCP_INITIAL_RTO_PARAMETERS, *PTCP_INITIAL_RTO_PARAMETERS; + +// +// Values for ICW level +// +typedef enum { + TCP_ICW_LEVEL_DEFAULT = 0, + TCP_ICW_LEVEL_HIGH = 1, + TCP_ICW_LEVEL_VERY_HIGH = 2, + TCP_ICW_LEVEL_AGGRESSIVE = 3, + TCP_ICW_LEVEL_EXPERIMENTAL = 4, + TCP_ICW_LEVEL_COMPAT = 254, + TCP_ICW_LEVEL_MAX = 255 +} TCP_ICW_LEVEL, *PTCP_ICW_LEVEL; + +typedef struct _TCP_ICW_PARAMETERS { + + // + // Supplies the level for choosing ICW. + // + + TCP_ICW_LEVEL Level; + +} TCP_ICW_PARAMETERS, *PTCP_ICW_PARAMETERS; + +typedef struct _TCP_ACK_FREQUENCY_PARAMETERS { + + // + // Supplies the Ack frequency. + // + + UCHAR TcpDelayedAckFrequency; + +} TCP_ACK_FREQUENCY_PARAMETERS, *PTCP_ACK_FREQUENCY_PARAMETERS; + +// +// Output for SIO_TCP_INFO. +// + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) +typedef struct _TCP_INFO_v0 { + TCPSTATE State; + ULONG Mss; + ULONG64 ConnectionTimeMs; + BOOLEAN TimestampsEnabled; + ULONG RttUs; + ULONG MinRttUs; + ULONG BytesInFlight; + ULONG Cwnd; + ULONG SndWnd; + ULONG RcvWnd; + ULONG RcvBuf; + ULONG64 BytesOut; + ULONG64 BytesIn; + ULONG BytesReordered; + ULONG BytesRetrans; + ULONG FastRetrans; + ULONG DupAcksIn; + ULONG TimeoutEpisodes; + UCHAR SynRetrans; +} TCP_INFO_v0, *PTCP_INFO_v0; +#endif // NTDDI_VERSION >= NTDDI_WIN10_RS2 + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +typedef struct _TCP_INFO_v1 { + TCPSTATE State; + ULONG Mss; + ULONG64 ConnectionTimeMs; + BOOLEAN TimestampsEnabled; + ULONG RttUs; + ULONG MinRttUs; + ULONG BytesInFlight; + ULONG Cwnd; + ULONG SndWnd; + ULONG RcvWnd; + ULONG RcvBuf; + ULONG64 BytesOut; + ULONG64 BytesIn; + ULONG BytesReordered; + ULONG BytesRetrans; + ULONG FastRetrans; + ULONG DupAcksIn; + ULONG TimeoutEpisodes; + UCHAR SynRetrans; + + // + // Info about the limiting factor in send throughput. + // + // States: + // -Rwin: peer's receive window. + // -Cwnd: congestion window. + // -Snd: app not writing enough data to its socket. + // + // Per-state statistics: + // -Trans: number of transitions into the state. + // -Time: time spent in the state in milliseconds. + // -Bytes: number of bytes sent while in the state. + // + // These fields match those in TCP_ESTATS_SND_CONG_ROD. + // + ULONG SndLimTransRwin; + ULONG SndLimTimeRwin; + ULONG64 SndLimBytesRwin; + ULONG SndLimTransCwnd; + ULONG SndLimTimeCwnd; + ULONG64 SndLimBytesCwnd; + ULONG SndLimTransSnd; + ULONG SndLimTimeSnd; + ULONG64 SndLimBytesSnd; + +} TCP_INFO_v1, *PTCP_INFO_v1; +#endif // NTDDI_VERSION >= NTDDI_WIN10_RS5 + +#if (NTDDI_VERSION >= NTDDI_WIN11_GA) +typedef struct _TCP_INFO_v2 { + TCPSTATE State; + ULONG Mss; + ULONG64 ConnectionTimeMs; + BOOLEAN TimestampsEnabled; + ULONG RttUs; + ULONG MinRttUs; + ULONG BytesInFlight; + ULONG Cwnd; + ULONG SndWnd; + ULONG RcvWnd; + ULONG RcvBuf; + ULONG64 BytesOut; + ULONG64 BytesIn; + // + // The number of bytes that are considered reordered from the sender side. + // + ULONG BytesReordered; + ULONG BytesRetrans; + ULONG FastRetrans; + ULONG DupAcksIn; + ULONG TimeoutEpisodes; + UCHAR SynRetrans; + + // + // Info about the limiting factor in send throughput. + // + // States: + // -Rwin: peer's receive window. + // -Cwnd: congestion window. + // -Snd: app not writing enough data to its socket. + // + // Per-state statistics: + // -Trans: number of transitions into the state. + // -Time: time spent in the state in milliseconds. + // -Bytes: number of bytes sent while in the state. + // + // These fields match those in TCP_ESTATS_SND_CONG_ROD. + // + ULONG SndLimTransRwin; + ULONG SndLimTimeRwin; + ULONG64 SndLimBytesRwin; + ULONG SndLimTransCwnd; + ULONG SndLimTimeCwnd; + ULONG64 SndLimBytesCwnd; + ULONG SndLimTransSnd; + ULONG SndLimTimeSnd; + ULONG64 SndLimBytesSnd; + + // + // The number of out of order data packets received. + // + ULONG OutOfOrderPktsIn; + + BOOLEAN EcnNegotiated; + ULONG EceAcksIn; + ULONG PtoEpisodes; +} TCP_INFO_v2, *PTCP_INFO_v2; +#endif // NTDDI_VERSION >= NTDDI_WIN11_GA + +// +// TCP/UDP port management definitions. +// +#define SIO_ACQUIRE_PORT_RESERVATION _WSAIOW(IOC_VENDOR, 100) +#define SIO_RELEASE_PORT_RESERVATION _WSAIOW(IOC_VENDOR, 101) +#define SIO_ASSOCIATE_PORT_RESERVATION _WSAIOW(IOC_VENDOR, 102) + +typedef struct _INET_PORT_RANGE { + USHORT StartPort; + USHORT NumberOfPorts; +} INET_PORT_RANGE, *PINET_PORT_RANGE; + +typedef struct _INET_PORT_RANGE INET_PORT_RESERVATION, *PINET_PORT_RESERVATION; + +typedef struct { + ULONG64 Token; +} INET_PORT_RESERVATION_TOKEN, *PINET_PORT_RESERVATION_TOKEN; + +#define INVALID_PORT_RESERVATION_TOKEN ((ULONG64)0) + +typedef struct { +#ifdef __cplusplus + INET_PORT_RESERVATION Reservation; + INET_PORT_RESERVATION_TOKEN Token; +#else + INET_PORT_RESERVATION; + INET_PORT_RESERVATION_TOKEN; +#endif +} INET_PORT_RESERVATION_INSTANCE, *PINET_PORT_RESERVATION_INSTANCE; + +typedef struct { + ULONG OwningPid; +} INET_PORT_RESERVATION_INFORMATION, *PINET_PORT_RESERVATION_INFORMATION; + + +#ifdef _WS2DEF_ + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) +#define _SECURE_SOCKET_TYPES_DEFINED_ + +// +// Secure socket API type definitions. +// + +#define SIO_SET_SECURITY _WSAIOW(IOC_VENDOR, 200) +#define SIO_QUERY_SECURITY _WSAIORW(IOC_VENDOR, 201) +#define SIO_SET_PEER_TARGET_NAME _WSAIOW(IOC_VENDOR, 202) +#define SIO_DELETE_PEER_TARGET_NAME _WSAIOW(IOC_VENDOR, 203) + + +// +// WFP Proxy Connection Tracking API type definitions. +// +#define SIO_QUERY_WFP_CONNECTION_REDIRECT_RECORDS _WSAIOW(IOC_VENDOR, 220) +#define SIO_QUERY_WFP_CONNECTION_REDIRECT_CONTEXT _WSAIOW(IOC_VENDOR, 221) +#define SIO_SET_WFP_CONNECTION_REDIRECT_RECORDS _WSAIOW(IOC_VENDOR, 222) + +// +// iSCSI IOCTLS +// +#define SIO_SOCKET_USAGE_NOTIFICATION _WSAIOW(IOC_VENDOR, 204) +typedef enum _SOCKET_USAGE_TYPE +{ + SYSTEM_CRITICAL_SOCKET = 1 +}SOCKET_USAGE_TYPE; + +// Type of security protocol +typedef enum _SOCKET_SECURITY_PROTOCOL +{ + SOCKET_SECURITY_PROTOCOL_DEFAULT, + SOCKET_SECURITY_PROTOCOL_IPSEC, +#if (NTDDI_VERSION >= NTDDI_WIN7) + SOCKET_SECURITY_PROTOCOL_IPSEC2, //version 2 of secure socket apis +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + SOCKET_SECURITY_PROTOCOL_INVALID +} SOCKET_SECURITY_PROTOCOL; + +// Flags for generic security settings +#define SOCKET_SETTINGS_GUARANTEE_ENCRYPTION 0x1 +#define SOCKET_SETTINGS_ALLOW_INSECURE 0x2 + +// Common security settings for the socket +typedef struct _SOCKET_SECURITY_SETTINGS +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + ULONG SecurityFlags; +} SOCKET_SECURITY_SETTINGS; + +// Flags specific to IPsec security settings. +// NOTE: these flags must be specified under the +// SOCKET_SECURITY_SETTINGS_IPSEC->IpsecFlags field. + +#define SOCKET_SETTINGS_IPSEC_SKIP_FILTER_INSTANTIATION 0x1 +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define SOCKET_SETTINGS_IPSEC_OPTIONAL_PEER_NAME_VERIFICATION 0x2 +#define SOCKET_SETTINGS_IPSEC_ALLOW_FIRST_INBOUND_PKT_UNENCRYPTED 0x4 +#define SOCKET_SETTINGS_IPSEC_PEER_NAME_IS_RAW_FORMAT 0x8 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + + +// IPsec specific security settings for the socket. +typedef struct _SOCKET_SECURITY_SETTINGS_IPSEC +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + ULONG SecurityFlags; + ULONG IpsecFlags; + GUID AuthipMMPolicyKey; + GUID AuthipQMPolicyKey; + GUID Reserved; + UINT64 Reserved2; + ULONG UserNameStringLen; + ULONG DomainNameStringLen; + ULONG PasswordStringLen; + wchar_t AllStrings[0]; +} SOCKET_SECURITY_SETTINGS_IPSEC; + +// Common peer target name for the socket +typedef struct _SOCKET_PEER_TARGET_NAME +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + SOCKADDR_STORAGE PeerAddress; + ULONG PeerTargetNameStringLen; + wchar_t AllStrings[0]; +} SOCKET_PEER_TARGET_NAME; + +// Input for querying socket security +typedef struct _SOCKET_SECURITY_QUERY_TEMPLATE +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + SOCKADDR_STORAGE PeerAddress; + ULONG PeerTokenAccessMask; +} SOCKET_SECURITY_QUERY_TEMPLATE; + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +#define SOCKET_QUERY_IPSEC2_ABORT_CONNECTION_ON_FIELD_CHANGE 0x1 + +#define SOCKET_QUERY_IPSEC2_FIELD_MASK_MM_SA_ID 0x1 +#define SOCKET_QUERY_IPSEC2_FIELD_MASK_QM_SA_ID 0x2 + +// Input for querying socket security +typedef struct _SOCKET_SECURITY_QUERY_TEMPLATE_IPSEC2 +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + SOCKADDR_STORAGE PeerAddress; + ULONG PeerTokenAccessMask; + ULONG Flags; + ULONG FieldMask; +} SOCKET_SECURITY_QUERY_TEMPLATE_IPSEC2; +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +// Flags corresponding to the security query info +#define SOCKET_INFO_CONNECTION_SECURED 0x1 +#define SOCKET_INFO_CONNECTION_ENCRYPTED 0x2 +#define SOCKET_INFO_CONNECTION_IMPERSONATED 0x4 + +// Common security query information from a socket +typedef struct _SOCKET_SECURITY_QUERY_INFO +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + ULONG Flags; + UINT64 PeerApplicationAccessTokenHandle; + UINT64 PeerMachineAccessTokenHandle; +} SOCKET_SECURITY_QUERY_INFO; + +#if (NTDDI_VERSION >= NTDDI_WIN7) +// Common security query information from a socket +typedef struct _SOCKET_SECURITY_QUERY_INFO_IPSEC2 +{ + SOCKET_SECURITY_PROTOCOL SecurityProtocol; + ULONG Flags; + UINT64 PeerApplicationAccessTokenHandle; + UINT64 PeerMachineAccessTokenHandle; + UINT64 MmSaId; + UINT64 QmSaId; + UINT32 NegotiationWinerr; + GUID SaLookupContext; +} SOCKET_SECURITY_QUERY_INFO_IPSEC2; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +// +// WFP ALE endpoint handle query type definition +// + +#define SIO_QUERY_WFP_ALE_ENDPOINT_HANDLE _WSAIOR(IOC_VENDOR, 205) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +// +// Scalability type definitions +// +#define SIO_QUERY_RSS_SCALABILITY_INFO _WSAIOR(IOC_VENDOR, 210) + +// Scalability info for the transport +typedef struct _RSS_SCALABILITY_INFO { + BOOLEAN RssEnabled; +} RSS_SCALABILITY_INFO, *PRSS_SCALABILITY_INFO; + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +// +// Microsoft-specific IPv4 definitions. +// + +#define IN4_CLASSA(i) (((LONG)(i) & 0x00000080) == 0) +#define IN4_CLASSB(i) (((LONG)(i) & 0x000000c0) == 0x00000080) +#define IN4_CLASSC(i) (((LONG)(i) & 0x000000e0) == 0x000000c0) +#define IN4_CLASSD(i) (((LONG)(i) & 0x000000f0) == 0x000000e0) +#define IN4_MULTICAST(i) IN4_CLASSD(i) + +#define IN4ADDR_ANY INADDR_ANY +#define IN4ADDR_LOOPBACK 0x0100007f +#define IN4ADDR_BROADCAST INADDR_BROADCAST +#define IN4ADDR_NONE INADDR_NONE +#define IN4ADDR_ANY_INIT { 0 } +#define IN4ADDR_LOOPBACK_INIT { 0x7f, 0, 0, 1 } +#define IN4ADDR_BROADCAST_INIT { 0xff, 0xff, 0xff, 0xff } +#define IN4ADDR_ALLNODESONLINK_INIT { 0xe0, 0, 0, 1 } +#define IN4ADDR_ALLROUTERSONLINK_INIT { 0xe0, 0, 0, 2 } +#define IN4ADDR_ALLIGMPV3ROUTERSONLINK_INIT { 0xe0, 0, 0, 0x16 } +#define IN4ADDR_ALLTEREDONODESONLINK_INIT { 0xe0, 0, 0, 0xfd } +#define IN4ADDR_LINKLOCALPREFIX_INIT { 0xa9, 0xfe, } +#define IN4ADDR_MULTICASTPREFIX_INIT { 0xe0, } + +#define IN4ADDR_LOOPBACKPREFIX_LENGTH 8 +#define IN4ADDR_LINKLOCALPREFIX_LENGTH 16 +#define IN4ADDR_MULTICASTPREFIX_LENGTH 4 + +#if (NTDDI_VERSION >= NTDDI_WIN2KSP1) +MSTCPIP_INLINE +BOOLEAN +IN4_ADDR_EQUAL(_In_ CONST IN_ADDR *a, _In_ CONST IN_ADDR *b) +{ + return (BOOLEAN)(a->s_addr == b->s_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_UNALIGNED_ADDR_EQUAL(_In_ CONST IN_ADDR UNALIGNED *a, _In_ CONST IN_ADDR UNALIGNED *b) +{ + return (BOOLEAN)(a->s_addr == b->s_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_UNSPECIFIED(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)(a->s_addr == IN4ADDR_ANY); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_UNSPECIFIED(_In_ CONST IN_ADDR UNALIGNED *a) +{ + return (BOOLEAN)(a->s_addr == IN4ADDR_ANY); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_LOOPBACK(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)(*((PUCHAR) a) == 0x7f); // 127/8 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_LOOPBACK(_In_ CONST IN_ADDR UNALIGNED *a) +{ + return (BOOLEAN)(*((PUCHAR) a) == 0x7f); // 127/8 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_BROADCAST(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)(a->s_addr == IN4ADDR_BROADCAST); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_BROADCAST(_In_ CONST IN_ADDR UNALIGNED *a) +{ + return (BOOLEAN)(a->s_addr == IN4ADDR_BROADCAST); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_MULTICAST(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)IN4_MULTICAST(a->s_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_MULTICAST(_In_ CONST IN_ADDR UNALIGNED *a) +{ + return (BOOLEAN)IN4_MULTICAST(a->s_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_LINKLOCAL(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)((a->s_addr & 0xffff) == 0xfea9); // 169.254/16 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_LINKLOCAL(_In_ CONST IN_ADDR UNALIGNED *a) +{ + return (BOOLEAN)((a->s_addr & 0xffff) == 0xfea9); // 169.254/16 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_SITELOCAL(_In_ CONST IN_ADDR *a) +{ + // + // For existing scenarios (e.g. ICS) to work as expected, RFC-1918 prefixes + // are deemed to be global scoped. When appropriate, site border routers + // must explicitly filter packets with these addresses. + // + UNREFERENCED_PARAMETER(a); + return FALSE; +} + +#define IN4_IS_UNALIGNED_ADDR_SITELOCAL IN4_IS_ADDR_SITELOCAL + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_RFC1918(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)(((a->s_addr & 0x00ff) == 0x0a) || // 10/8 + ((a->s_addr & 0xf0ff) == 0x10ac) || // 172.16/12 + ((a->s_addr & 0xffff) == 0xa8c0)); // 192.168/16 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_RFC1918(_In_ CONST IN_ADDR UNALIGNED *a) +{ + IN_ADDR Ipv4Address = *a; + return IN4_IS_ADDR_RFC1918(&Ipv4Address); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_MC_LINKLOCAL(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)((a->s_addr & 0xffffff) == 0xe0); // 224.0.0/24 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_MC_ADMINLOCAL(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)((a->s_addr & 0xffff) == 0xffef); // 239.255/16 +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_MC_SITELOCAL(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)((a->s_addr & 0xff) == 0xef) && + !IN4_IS_ADDR_MC_ADMINLOCAL(a); +} + +MSTCPIP_INLINE +VOID +IN4ADDR_SETSOCKADDR(_Out_ PSOCKADDR_IN a, _In_ CONST IN_ADDR *addr, _In_ USHORT port) +{ + a->sin_family = AF_INET; + a->sin_port = port; + a->sin_addr = *addr; + memset(a->sin_zero, 0, sizeof(a->sin_zero)); +} + +MSTCPIP_INLINE +VOID +IN4ADDR_SETANY(_Out_ PSOCKADDR_IN a) +{ + a->sin_family = AF_INET; + a->sin_port = 0; + a->sin_addr.s_addr = IN4ADDR_ANY; + memset(a->sin_zero, 0, sizeof(a->sin_zero)); +} + +MSTCPIP_INLINE +VOID +IN4ADDR_SETLOOPBACK(_Out_ PSOCKADDR_IN a) +{ + a->sin_family = AF_INET; + a->sin_port = 0; + a->sin_addr.s_addr = IN4ADDR_LOOPBACK; + memset(a->sin_zero, 0, sizeof(a->sin_zero)); +} + +MSTCPIP_INLINE +BOOLEAN +IN4ADDR_ISANY(_In_ CONST SOCKADDR_IN *a) +{ + ASSERT(a->sin_family == AF_INET); + return IN4_IS_ADDR_UNSPECIFIED(&a->sin_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN4ADDR_ISLOOPBACK(_In_ CONST SOCKADDR_IN *a) +{ + ASSERT(a->sin_family == AF_INET); + return IN4_IS_ADDR_LOOPBACK(&a->sin_addr); +} + +MSTCPIP_INLINE +SCOPE_ID +IN4ADDR_SCOPE_ID(_In_ CONST SOCKADDR_IN *a) +{ + SCOPE_ID UnspecifiedScopeId = {0}; + UNREFERENCED_PARAMETER(a); + return UnspecifiedScopeId; +} + +MSTCPIP_INLINE +BOOLEAN +IN4ADDR_ISEQUAL(_In_ CONST SOCKADDR_IN *a, _In_ CONST SOCKADDR_IN *b) +{ + ASSERT(a->sin_family == AF_INET); + return (BOOLEAN)(IN4ADDR_SCOPE_ID(a).Value == IN4ADDR_SCOPE_ID(b).Value && + IN4_ADDR_EQUAL(&a->sin_addr, &b->sin_addr)); +} + +MSTCPIP_INLINE +BOOLEAN +IN4ADDR_ISUNSPECIFIED(_In_ CONST SOCKADDR_IN *a) +{ + ASSERT(a->sin_family == AF_INET); + return (BOOLEAN)(IN4ADDR_SCOPE_ID(a).Value == 0 && + IN4_IS_ADDR_UNSPECIFIED(&a->sin_addr)); +} + +#define INET_IS_ALIGNED(Pointer, Type) \ + (((ULONG_PTR)Pointer & (__builtin_alignof(Type)-1)) == 0) + +MSTCPIP_INLINE +SCOPE_LEVEL +Ipv4UnicastAddressScope( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +/*++ + +Routine Description: + + Determines the scope of an IPv4 unicast address. + + For existing scenarios (e.g. ICS) to work as expected, RFC-1918 prefixes + are deemed to be global scoped. When appropriate, site border routers + must explicitly filter packets with these addresses. + +Arguments: + + Address - Supplies the IPv4 unicast address. + +Return Value: + + Returns the scope level of the address. + +Caller IRQL: + + May be called at PASSIVE through DISPATCH level. + +--*/ +{ + IN_ADDR Ipv4Address; + + if (!INET_IS_ALIGNED(Address, IN_ADDR)) { + Ipv4Address = *(CONST IN_ADDR UNALIGNED *)Address; + Address = (CONST UCHAR *) &Ipv4Address; + } + + if (IN4_IS_ADDR_LINKLOCAL((PIN_ADDR) Address) || + IN4_IS_ADDR_LOOPBACK((PIN_ADDR) Address)) { + return ScopeLevelLink; + } + return ScopeLevelGlobal; +} + +MSTCPIP_INLINE +SCOPE_LEVEL +Ipv4MulticastAddressScope( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +/*++ + +Routine Description: + + Determines the scope of an IPv4 multicast address. + See RFC 2365. + +Arguments: + + Address - Supplies the IPv4 multicast address. + +Return Value: + + Returns the scope level of the multicast address. + +Caller IRQL: + + May be called at PASSIVE through DISPATCH level. + +--*/ +{ + IN_ADDR Ipv4Address; + + if (!INET_IS_ALIGNED(Address, IN_ADDR)) { + Ipv4Address = *(CONST IN_ADDR UNALIGNED *)Address; + Address = (CONST UCHAR *) &Ipv4Address; + } + + if (IN4_IS_ADDR_MC_LINKLOCAL((PIN_ADDR) Address)) { + return ScopeLevelLink; + } else if (IN4_IS_ADDR_MC_ADMINLOCAL((PIN_ADDR) Address)) { + return ScopeLevelAdmin; + } else if (IN4_IS_ADDR_MC_SITELOCAL((PIN_ADDR) Address)) { + return ScopeLevelSite; + } else { + return ScopeLevelGlobal; + } +} + +MSTCPIP_INLINE +SCOPE_LEVEL +Ipv4AddressScope( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +/*++ + +Routine Description: + + Examines an IPv4 address and determines its scope. + +Arguments: + + Address - Supplies the address to test. + +Return Value: + + Returns the scope level of the address. + +Caller IRQL: + + May be called at PASSIVE through DISPATCH level. + +--*/ +{ + IN CONST IN_ADDR Ipv4Address = *(CONST IN_ADDR UNALIGNED *)Address; + + if (IN4_IS_ADDR_BROADCAST(&Ipv4Address)) { + return ScopeLevelLink; + } else if (IN4_IS_ADDR_MULTICAST(&Ipv4Address)) { + return Ipv4MulticastAddressScope((UCHAR *) &Ipv4Address); + } else { + return Ipv4UnicastAddressScope((UCHAR *) &Ipv4Address); + } +} + +MSTCPIP_INLINE +NL_ADDRESS_TYPE +Ipv4AddressType( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +{ + IN_ADDR Ipv4Address = *(CONST IN_ADDR UNALIGNED *) Address; + + if (IN4_IS_ADDR_MULTICAST(&Ipv4Address)) { + return NlatMulticast; + } + + if (IN4_IS_ADDR_BROADCAST(&Ipv4Address)) { + return NlatBroadcast; + } + + if (IN4_IS_ADDR_UNSPECIFIED(&Ipv4Address)) { + return NlatUnspecified; + } + + if (((Ipv4Address.s_addr & 0x000000ff) == 0) || + ((Ipv4Address.s_addr & 0x000000f0) == 240)) { + // + // Following prefixes are invalid: + // 1. 0.0.0.0/8 (except 0.0.0.0/32). + // 2. 240.0.0.0/4 (except 255.255.255.255/32). + // + return NlatInvalid; + } + + // + // Loopback and anycast addresses are treated as unicast. + // + return NlatUnicast; +} + +MSTCPIP_INLINE +VOID +IN4_UNCANONICALIZE_SCOPE_ID( + _In_ CONST IN_ADDR *Address, + _Inout_ SCOPE_ID *ScopeId + ) +{ + SCOPE_LEVEL ScopeLevel = Ipv4AddressScope((CONST UCHAR *)Address); + + if ((IN4_IS_ADDR_LOOPBACK(Address)) || (ScopeLevel == ScopeLevelGlobal)) { + ScopeId->Value = 0; + } + + if ((SCOPE_LEVEL)ScopeId->Level == ScopeLevel) { + ScopeId->Level = 0; + } +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_ADDR_6TO4ELIGIBLE(_In_ CONST IN_ADDR *a) +{ + return (BOOLEAN)((Ipv4AddressType((CONST UCHAR *) a) == NlatUnicast) && + !(IN4_IS_ADDR_LOOPBACK(a) || + IN4_IS_ADDR_LINKLOCAL(a) || + IN4_IS_ADDR_SITELOCAL(a) || + IN4_IS_ADDR_RFC1918(a))); +} + +MSTCPIP_INLINE +BOOLEAN +IN4_IS_UNALIGNED_ADDR_6TO4ELIGIBLE(_In_ CONST IN_ADDR UNALIGNED *a) +{ + IN_ADDR Ipv4Address = *a; + return IN4_IS_ADDR_6TO4ELIGIBLE(&Ipv4Address); +} + +#endif // _WS2DEF_ + + +// +// Microsoft-specific IPv6 definitions. +// + +#ifdef _WS2IPDEF_ + +#ifdef _PREFAST_ +#pragma prefast(push) +#pragma prefast(disable:6385, "apparent one byte buffer overread in IN6_PREFIX_EQUAL") +#endif + +MSTCPIP_INLINE +BOOLEAN +IN6_PREFIX_EQUAL( + _In_ CONST IN6_ADDR *a, + _In_ CONST IN6_ADDR *b, + _In_ _In_range_(0, (sizeof(IN6_ADDR) * 8)) UINT8 len + ) +{ + UINT8 Bytes = len / 8; + UINT8 Bits = len % 8; + UINT8 Mask = 0xff << (8 - Bits); + + return (BOOLEAN) + (((memcmp(a, b, Bytes)) == 0) && + ((Bits == 0) || + ((a->s6_bytes[Bytes] & Mask) == (b->s6_bytes[Bytes] & Mask)))); +} + +#ifdef _PREFAST_ +#pragma prefast(pop) +#endif + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_ALLNODESONNODE(_In_ CONST IN6_ADDR *a) +{ + return IN6_ADDR_EQUAL(a, &in6addr_allnodesonnode); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_ALLNODESONLINK(_In_ CONST IN6_ADDR *a) +{ + return IN6_ADDR_EQUAL(a, &in6addr_allnodesonlink); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_ALLROUTERSONLINK(_In_ CONST IN6_ADDR *a) +{ + return IN6_ADDR_EQUAL(a, &in6addr_allroutersonlink); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_SOLICITEDNODE(_In_ CONST IN6_ADDR *a) +{ + return + IN6_PREFIX_EQUAL( + a, + &in6addr_solicitednodemulticastprefix, + IN6ADDR_SOLICITEDNODEMULTICASTPREFIX_LENGTH); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_ISATAP(_In_ CONST IN6_ADDR *a) +{ + // + // Disregard the u/g bit and compare the first byte of the interface id. + // + return (BOOLEAN)(((a->s6_words[4] & 0xfffd) == 0x0000) && + (a->s6_words[5] == 0xfe5e)); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_6TO4(_In_ CONST IN6_ADDR *a) +{ + C_ASSERT(IN6ADDR_6TO4PREFIX_LENGTH == RTL_BITS_OF(USHORT)); + return (BOOLEAN)(a->s6_words[0] == in6addr_6to4prefix.s6_words[0]); +} + +MSTCPIP_INLINE +BOOLEAN +IN6_IS_ADDR_TEREDO(_In_ CONST IN6_ADDR *a) +{ + C_ASSERT(IN6ADDR_TEREDOPREFIX_LENGTH == 2 * RTL_BITS_OF(USHORT)); + return (BOOLEAN) + (((a->s6_words[0] == in6addr_teredoprefix.s6_words[0]) && + (a->s6_words[1] == in6addr_teredoprefix.s6_words[1])) || + ((a->s6_words[0] == in6addr_teredoprefix_old.s6_words[0]) && + (a->s6_words[1] == in6addr_teredoprefix_old.s6_words[1]))); +} + +MSTCPIP_INLINE +BOOLEAN +IN6ADDR_ISV4MAPPED(_In_ CONST SOCKADDR_IN6 *a) +{ + ASSERT(a->sin6_family == AF_INET6); + return IN6_IS_ADDR_V4MAPPED(&a->sin6_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN6ADDR_ISISATAP(_In_ CONST SOCKADDR_IN6 *a) +{ + ASSERT(a->sin6_family == AF_INET6); + return IN6_IS_ADDR_ISATAP(&a->sin6_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN6ADDR_IS6TO4(_In_ CONST SOCKADDR_IN6 *a) +{ + ASSERT(a->sin6_family == AF_INET6); + return IN6_IS_ADDR_6TO4(&a->sin6_addr); +} + +MSTCPIP_INLINE +BOOLEAN +IN6ADDR_ISTEREDO(_In_ CONST SOCKADDR_IN6 *a) +{ + ASSERT(a->sin6_family == AF_INET6); + return IN6_IS_ADDR_TEREDO(&a->sin6_addr); +} + +MSTCPIP_INLINE +CONST UCHAR* +IN6_GET_ADDR_V4MAPPED(_In_ CONST IN6_ADDR *Ipv6Address) +{ + return (CONST UCHAR *) (Ipv6Address->s6_words + 6); +} + +MSTCPIP_INLINE +CONST UCHAR* +IN6_GET_ADDR_V4COMPAT(_In_ CONST IN6_ADDR *Ipv6Address) +{ + return (CONST UCHAR *) (Ipv6Address->s6_words + 6); +} + +MSTCPIP_INLINE +CONST UCHAR* +IN6_EXTRACT_V4ADDR_FROM_ISATAP(_In_ CONST IN6_ADDR *Ipv6Address) +{ + return (CONST UCHAR *) (Ipv6Address->s6_words + 6); +} + +MSTCPIP_INLINE +CONST UCHAR* +IN6_EXTRACT_V4ADDR_FROM_6TO4(_In_ CONST IN6_ADDR *Ipv6Address) +{ + return (CONST UCHAR *) (Ipv6Address->s6_words + 1); +} + +MSTCPIP_INLINE +VOID +IN6_SET_ADDR_V4MAPPED(_Out_ PIN6_ADDR a6, _In_ CONST IN_ADDR* a4) +{ + *a6 = in6addr_v4mappedprefix; + a6->s6_bytes[12] = ((CONST UCHAR *) a4)[0]; + a6->s6_bytes[13] = ((CONST UCHAR *) a4)[1]; + a6->s6_bytes[14] = ((CONST UCHAR *) a4)[2]; + a6->s6_bytes[15] = ((CONST UCHAR *) a4)[3]; +} + +MSTCPIP_INLINE +VOID +IN6_SET_ADDR_V4COMPAT(_Out_ PIN6_ADDR a6, _In_ CONST IN_ADDR* a4) +{ + *a6 = in6addr_any; + a6->s6_bytes[12] = ((CONST UCHAR *) a4)[0]; + a6->s6_bytes[13] = ((CONST UCHAR *) a4)[1]; + a6->s6_bytes[14] = ((CONST UCHAR *) a4)[2]; + a6->s6_bytes[15] = ((CONST UCHAR *) a4)[3]; +} + +MSTCPIP_INLINE +VOID +IN6_SET_ADDR_SOLICITEDNODE(_Out_ PIN6_ADDR Multicast, _In_ CONST IN6_ADDR *Unicast) +{ + *Multicast = in6addr_solicitednodemulticastprefix; + Multicast->s6_bytes[13] = Unicast->s6_bytes[13]; + Multicast->s6_bytes[14] = Unicast->s6_bytes[14]; + Multicast->s6_bytes[15] = Unicast->s6_bytes[15]; +} + +MSTCPIP_INLINE +VOID +IN6_SET_ISATAP_IDENTIFIER(_Inout_ IN6_ADDR *Ipv6Address, _In_ CONST IN_ADDR *Ipv4Address) +{ + if (IN4_IS_ADDR_6TO4ELIGIBLE(Ipv4Address)) { + Ipv6Address->s6_words[4] = 0x0002; + } else { + Ipv6Address->s6_words[4] = 0x0000; + } + + // + // 24-bit IANA OUI 00-00-5E and the 8-bit hex value 0xFE. + // See section 6.1 of RFC 4214. + // + Ipv6Address->s6_words[5] = 0xFE5E; + *((UNALIGNED IN_ADDR *) (Ipv6Address->s6_words + 6)) = *Ipv4Address; +} + +MSTCPIP_INLINE +VOID +IN6_SET_6TO4_PREFIX(_Inout_ IN6_ADDR *Ipv6Address, _In_ CONST IN_ADDR *Ipv4Address) +{ + Ipv6Address->s6_words[0] = 0x0220; + *((UNALIGNED IN_ADDR *) (Ipv6Address->s6_words + 1)) = *Ipv4Address; + Ipv6Address->s6_words[3] = 0x0000; +} + +MSTCPIP_INLINE +SCOPE_LEVEL +Ipv6UnicastAddressScope( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +/*++ + +Routine Description: + + Examines a unicast address and determines its scope. + + Note that v4-compatible and 6to4 addresses are deemed to have global scope; + it is not legal to derive them from non IN4_IS_ADDR_6TO4ELIGIBLE addresses + (IPv4 loopback, link-local, site-local, and RFC-1918 addresses). + +Arguments: + + Address - Supplies an IPv6 unicast address. + +Return Value: + + Returns the scope level of the address. + +Caller IRQL: + + May be called at PASSIVE through DISPATCH level. + +--*/ +{ + IN6_ADDR Ipv6Address; + + if (!INET_IS_ALIGNED(Address, IN6_ADDR)) { + Ipv6Address = *(CONST IN6_ADDR UNALIGNED *)Address; + Address = (CONST UCHAR *) &Ipv6Address; + } + + if (IN6_IS_ADDR_LINKLOCAL((PIN6_ADDR) Address) || + IN6_IS_ADDR_LOOPBACK((PIN6_ADDR) Address)) { + return ScopeLevelLink; + } else if (IN6_IS_ADDR_SITELOCAL((PIN6_ADDR) Address)) { + return ScopeLevelSite; + } else { + return ScopeLevelGlobal; + } +} + +MSTCPIP_INLINE +SCOPE_LEVEL +IN6_MULTICAST_SCOPE( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +{ + PIN6_ADDR Ipv6Address = (PIN6_ADDR) Address; + return (SCOPE_LEVEL)(Ipv6Address->s6_bytes[1] & 0xf); +} + +MSTCPIP_INLINE +SCOPE_LEVEL +Ipv6AddressScope( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +/*++ + +Routine Description: + + Examines an IPv6 address and determines its scope. + +Arguments: + + Address - Supplies an IPv6 address. + +Return Value: + + Returns the scope level of the address. + +Caller IRQL: + + May be called at PASSIVE through DISPATCH level. + +--*/ +{ + if (IN6_IS_ADDR_MULTICAST((CONST IN6_ADDR *) Address)) { + return IN6_MULTICAST_SCOPE(Address); + } else { + return Ipv6UnicastAddressScope(Address); + } +} + +MSTCPIP_INLINE +NL_ADDRESS_TYPE +Ipv6AddressType( + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address + ) +{ + CONST IN6_ADDR *Ipv6Address = (CONST IN6_ADDR *) Address; + CONST UCHAR *Ipv4Address; + + if (IN6_IS_ADDR_MULTICAST(Ipv6Address)) { + return NlatMulticast; + } + + if (IN6_IS_ADDR_UNSPECIFIED(Ipv6Address)) { + return NlatUnspecified; + } + + // + // Extract embedded IPv4 address, if any. + // + if (IN6_IS_ADDR_ISATAP(Ipv6Address) || + IN6_IS_ADDR_V4COMPAT(Ipv6Address) || + IN6_IS_ADDR_V4MAPPED(Ipv6Address) || + IN6_IS_ADDR_V4TRANSLATED(Ipv6Address)) { + Ipv4Address = IN6_EXTRACT_V4ADDR_FROM_ISATAP(Ipv6Address); + } else if (IN6_IS_ADDR_6TO4(Ipv6Address)) { + Ipv4Address = IN6_EXTRACT_V4ADDR_FROM_6TO4(Ipv6Address); + } else { + // + // Anycast and loopback addresses are treated unicast address. + // + return NlatUnicast; + } + + // + // Ensure that the embedded IPv4 address is unicast. + // + if (Ipv4AddressType(Ipv4Address) != NlatUnicast) { + return NlatInvalid; + } + return NlatUnicast; +} + +MSTCPIP_INLINE +VOID +IN6_UNCANONICALIZE_SCOPE_ID( + _In_ CONST IN6_ADDR *Address, + _Inout_ SCOPE_ID *ScopeId + ) +{ + SCOPE_LEVEL ScopeLevel = Ipv6AddressScope((CONST UCHAR *)Address); + + if ((IN6_IS_ADDR_LOOPBACK(Address)) || (ScopeLevel == ScopeLevelGlobal)) { + ScopeId->Value = 0; + } + + if ((SCOPE_LEVEL)ScopeId->Level == ScopeLevel) { + ScopeId->Level = 0; + } +} + +#if (NTDDI_VERSION >= NTDDI_VISTA) +MSTCPIP_INLINE +VOID +IN6ADDR_SETSOCKADDR(_Out_ PSOCKADDR_IN6 a, _In_ CONST IN6_ADDR *addr, _In_ SCOPE_ID scope, + _In_ USHORT port) +{ + a->sin6_family = AF_INET6; + a->sin6_port = port; + a->sin6_flowinfo = 0; + RtlCopyMemory(&a->sin6_addr, addr, sizeof(IN6_ADDR)); + a->sin6_scope_struct = scope; + IN6_UNCANONICALIZE_SCOPE_ID(&a->sin6_addr, &a->sin6_scope_struct); +} + +MSTCPIP_INLINE +VOID +IN6ADDR_SETV4MAPPED(_Out_ PSOCKADDR_IN6 a6, _In_ CONST IN_ADDR* a4, _In_ SCOPE_ID scope, + _In_ USHORT port) +{ + a6->sin6_family = AF_INET6; + a6->sin6_port = port; + a6->sin6_flowinfo = 0; + IN6_SET_ADDR_V4MAPPED(&a6->sin6_addr, a4); + a6->sin6_scope_struct = scope; + IN4_UNCANONICALIZE_SCOPE_ID(a4, &a6->sin6_scope_struct); +} + +#endif + +// +// Define address-family-independent routines. +// + +MSTCPIP_INLINE +BOOLEAN +INET_ADDR_EQUAL(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a, _In_ CONST VOID* b) +{ + if (af == AF_INET6) { + return IN6_ADDR_EQUAL((CONST IN6_ADDR*)a, (CONST IN6_ADDR*)b); + } else { + ASSERT(af == AF_INET); + return IN4_ADDR_EQUAL((CONST IN_ADDR*)a, (CONST IN_ADDR*)b); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_UNALIGNED_ADDR_EQUAL(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a, _In_ CONST VOID* b) +{ + if (af == AF_INET6) { + return IN6_ADDR_EQUAL((CONST IN6_ADDR*)a, (CONST IN6_ADDR*)b); + } else { + ASSERT(af == AF_INET); + return IN4_UNALIGNED_ADDR_EQUAL((CONST IN_ADDR*)a, (CONST IN_ADDR*)b); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_IS_ADDR_UNSPECIFIED(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a) +{ + if (af == AF_INET6) { + return IN6_IS_ADDR_UNSPECIFIED((CONST IN6_ADDR*)a); + } else { + ASSERT(af == AF_INET); + return IN4_IS_ADDR_UNSPECIFIED((CONST IN_ADDR*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_IS_UNALIGNED_ADDR_UNSPECIFIED(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a) +{ + if (af == AF_INET6) { + return IN6_IS_ADDR_UNSPECIFIED((CONST IN6_ADDR*)a); + } else { + ASSERT(af == AF_INET); + return IN4_IS_UNALIGNED_ADDR_UNSPECIFIED((CONST IN_ADDR UNALIGNED*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_IS_ADDR_LOOPBACK(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a) +{ + if (af == AF_INET6) { + return IN6_IS_ADDR_LOOPBACK((CONST IN6_ADDR*)a); + } else { + ASSERT(af == AF_INET); + return IN4_IS_ADDR_LOOPBACK((CONST IN_ADDR*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_IS_ADDR_BROADCAST(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a) +{ + if (af == AF_INET6) { + return FALSE; + } else { + ASSERT(af == AF_INET); + return IN4_IS_ADDR_BROADCAST((CONST IN_ADDR*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INET_IS_ADDR_MULTICAST(_In_ ADDRESS_FAMILY af, _In_ CONST VOID* a) +{ + if (af == AF_INET6) { + return IN6_IS_ADDR_MULTICAST((CONST IN6_ADDR*)a); + } else { + ASSERT(af == AF_INET); + return IN4_IS_ADDR_MULTICAST((CONST IN_ADDR*)a); + } +} + +MSTCPIP_INLINE +CONST UCHAR* +INET_ADDR_UNSPECIFIED(_In_ ADDRESS_FAMILY af) +{ + if (af == AF_INET6) { + return (CONST UCHAR*)&in6addr_any; + } else { + ASSERT(af == AF_INET); + return (CONST UCHAR*)&in4addr_any; + } +} + +MSTCPIP_INLINE +VOID +INET_SET_ADDRESS( + _In_ ADDRESS_FAMILY Family, + _Out_writes_(_Inexpressible_("Varies")) PUCHAR Address, + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Value) +{ + if (Family == AF_INET6) { + *((PIN6_ADDR)Address) = *((PIN6_ADDR)Value); + } else { + ASSERT(Family == AF_INET); + *((PIN_ADDR)Address) = *((PIN_ADDR)Value); + } +} + +_Ret_range_(sizeof(IN_ADDR), sizeof(IN6_ADDR)) +MSTCPIP_INLINE +SIZE_T +INET_ADDR_LENGTH(_In_ ADDRESS_FAMILY af) +{ + if (af == AF_INET6) { + return sizeof(IN6_ADDR); + } else { + ASSERT(af == AF_INET); + return sizeof(IN_ADDR); + } +} + +_Ret_range_(sizeof(SOCKADDR_IN), sizeof(SOCKADDR_IN6)) +MSTCPIP_INLINE +SIZE_T +INET_SOCKADDR_LENGTH(_In_ ADDRESS_FAMILY af) +{ + if (af == AF_INET6) { + return sizeof(SOCKADDR_IN6); + } else { + ASSERT(af == AF_INET); + return sizeof(SOCKADDR_IN); + } +} + +#if (NTDDI_VERSION >= NTDDI_VISTA) +_At_((PSOCKADDR_IN6)a, _When_(af == AF_INET6, _Out_)) +MSTCPIP_INLINE +VOID +INETADDR_SETSOCKADDR(_In_ ADDRESS_FAMILY af, _Out_ PSOCKADDR a, _In_ CONST VOID* addr, + _In_ SCOPE_ID scope, _In_ USHORT port) +{ + if (af == AF_INET6) { +#pragma prefast (suppress: 6386, "Suppressing due to PREFast bug with _When_") + IN6ADDR_SETSOCKADDR( + (PSOCKADDR_IN6) a, (CONST IN6_ADDR *) addr, scope, port); + } else { + CONST IN_ADDR addr4 = *((IN_ADDR UNALIGNED *) addr); + + ASSERT(af == AF_INET); + IN4ADDR_SETSOCKADDR( + (PSOCKADDR_IN) a, (CONST IN_ADDR *) &addr4, port); + } +} +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +MSTCPIP_INLINE +VOID +INETADDR_SETANY(_Inout_ PSOCKADDR a) +{ + if (a->sa_family == AF_INET6) { + IN6ADDR_SETANY((PSOCKADDR_IN6)a); + } else { + ASSERT(a->sa_family == AF_INET); + IN4ADDR_SETANY((PSOCKADDR_IN)a); + } +} + +MSTCPIP_INLINE +VOID +INETADDR_SETLOOPBACK(_Inout_ PSOCKADDR a) +{ + if (a->sa_family == AF_INET6) { + IN6ADDR_SETLOOPBACK((PSOCKADDR_IN6)a); + } else { + ASSERT(a->sa_family == AF_INET); + IN4ADDR_SETLOOPBACK((PSOCKADDR_IN)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INETADDR_ISANY(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return IN6ADDR_ISANY((CONST SOCKADDR_IN6*)a); + } else { + ASSERT(a->sa_family == AF_INET); + return IN4ADDR_ISANY((CONST SOCKADDR_IN*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INETADDR_ISLOOPBACK(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return IN6ADDR_ISLOOPBACK((CONST SOCKADDR_IN6*)a); + } else { + ASSERT(a->sa_family == AF_INET); + return IN4ADDR_ISLOOPBACK((CONST SOCKADDR_IN*)a); + } +} + +MSTCPIP_INLINE +BOOLEAN +INETADDR_ISV4MAPPED(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return IN6ADDR_ISV4MAPPED((CONST SOCKADDR_IN6*)a); + } else { + return FALSE; + } +} + +MSTCPIP_INLINE +BOOLEAN +NL_ADDR_EQUAL( + _In_ ADDRESS_FAMILY af, + _In_ SCOPE_ID sa, + _In_ CONST UCHAR* aa, + _In_ SCOPE_ID sb, + _In_ CONST UCHAR* ab + ) +{ + return (BOOLEAN)((sa.Value == sb.Value) && INET_ADDR_EQUAL(af, aa, ab)); +} + +MSTCPIP_INLINE +BOOLEAN +NL_IS_ADDR_UNSPECIFIED( + _In_ ADDRESS_FAMILY af, + _In_ SCOPE_ID s, + _In_ CONST UCHAR* a + ) +{ + return (BOOLEAN)((s.Value == 0) && INET_IS_ADDR_UNSPECIFIED(af, a)); +} + +MSTCPIP_INLINE +BOOLEAN +INETADDR_ISEQUAL(_In_ CONST SOCKADDR *a, _In_ CONST SOCKADDR *b) +{ + if (a->sa_family == AF_INET6) { + return (BOOLEAN) + (b->sa_family == AF_INET6 && + IN6ADDR_ISEQUAL((CONST SOCKADDR_IN6*)a, (CONST SOCKADDR_IN6*)b)); + } else { + ASSERT(a->sa_family == AF_INET); + return (BOOLEAN) + (b->sa_family == AF_INET && + IN4ADDR_ISEQUAL((CONST SOCKADDR_IN*)a, (CONST SOCKADDR_IN*)b)); + } +} + +MSTCPIP_INLINE +BOOLEAN +INETADDR_ISUNSPECIFIED(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return IN6ADDR_ISUNSPECIFIED((CONST SOCKADDR_IN6*)a); + } else { + ASSERT(a->sa_family == AF_INET); + return IN4ADDR_ISUNSPECIFIED((CONST SOCKADDR_IN*)a); + } +} + +#if (NTDDI_VERSION >= NTDDI_VISTA) +MSTCPIP_INLINE +SCOPE_ID +INETADDR_SCOPE_ID(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return ((CONST SOCKADDR_IN6*)a)->sin6_scope_struct; + } else { + ASSERT(a->sa_family == AF_INET); + return IN4ADDR_SCOPE_ID((CONST SOCKADDR_IN*)a); + } +} +#endif + +MSTCPIP_INLINE +USHORT +INETADDR_PORT(_In_ CONST SOCKADDR *a) +{ + if (a->sa_family == AF_INET6) { + return ((CONST SOCKADDR_IN6*)a)->sin6_port; + } else { + ASSERT(a->sa_family == AF_INET); + return ((CONST SOCKADDR_IN*)a)->sin_port; + } +} + +MSTCPIP_INLINE +PUCHAR +INETADDR_ADDRESS(_In_ CONST SOCKADDR* a) +{ + if (a->sa_family == AF_INET6) { + return (PUCHAR)&((PSOCKADDR_IN6)a)->sin6_addr; + } else { + ASSERT(a->sa_family == AF_INET); + return (PUCHAR)&((PSOCKADDR_IN)a)->sin_addr; + } +} + +MSTCPIP_INLINE +VOID +INETADDR_SET_PORT(_Inout_ PSOCKADDR a, _In_ USHORT Port) +{ + SS_PORT(a) = Port; +} + +MSTCPIP_INLINE +VOID +INETADDR_SET_ADDRESS( + _Inout_ PSOCKADDR a, + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address) +{ + if (a->sa_family == AF_INET6) { + ((PSOCKADDR_IN6)a)->sin6_addr = *((CONST IN6_ADDR*)Address); + } else { + ASSERT(a->sa_family == AF_INET); + ((PSOCKADDR_IN)a)->sin_addr = *((CONST IN_ADDR*)Address); + } +} + +MSTCPIP_INLINE +VOID +INET_UNCANONICALIZE_SCOPE_ID( + _In_ ADDRESS_FAMILY AddressFamily, + _In_reads_(_Inexpressible_("Varies")) CONST UCHAR *Address, + _Inout_ SCOPE_ID *ScopeId + ) +{ + if (AddressFamily == AF_INET6) { + IN6_UNCANONICALIZE_SCOPE_ID((CONST IN6_ADDR*) Address, ScopeId); + } else { + IN4_UNCANONICALIZE_SCOPE_ID((CONST IN_ADDR*) Address, ScopeId); + } +} + +#endif // _WS2IPDEF_ + +#endif // (NTDDI_VERSION >= NTDDI_WIN2KSP1) + + +#ifndef __IP2STRING__ +#define __IP2STRING__ + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +// +// Some simple Rtl routines for IP address <-> string literal conversion +// +#ifdef _WS2DEF_ + +#pragma region Desktop Family or Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +NTSYSAPI +PSTR +NTAPI +RtlIpv4AddressToStringA ( + _In_ const struct in_addr *Addr, + _Out_writes_(16) PSTR S + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4AddressToStringExA( + _In_ const struct in_addr *Address, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +PWSTR +NTAPI +RtlIpv4AddressToStringW ( + _In_ const struct in_addr *Addr, + _Out_writes_(16) PWSTR S + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4AddressToStringExW( + _In_ const struct in_addr *Address, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PWSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4StringToAddressA ( + _In_ PCSTR S, + _In_ BOOLEAN Strict, + _Out_ PCSTR *Terminator, + _Out_ struct in_addr *Addr + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4StringToAddressExA ( + _In_ PCSTR AddressString, + _In_ BOOLEAN Strict, + _Out_ struct in_addr *Address, + _Out_ PUSHORT Port + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4StringToAddressW ( + _In_ PCWSTR S, + _In_ BOOLEAN Strict, + _Out_ LPCWSTR *Terminator, + _Out_ struct in_addr *Addr + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv4StringToAddressExW ( + _In_ PCWSTR AddressString, + _In_ BOOLEAN Strict, + _Out_ struct in_addr *Address, + _Out_ PUSHORT Port + ); + +#ifdef UNICODE +#define RtlIpv4AddressToString RtlIpv4AddressToStringW +#define RtlIpv4StringToAddress RtlIpv4StringToAddressW +#define RtlIpv4AddressToStringEx RtlIpv4AddressToStringExW +#define RtlIpv4StringToAddressEx RtlIpv4StringToAddressExW +#else +#define RtlIpv4AddressToString RtlIpv4AddressToStringA +#define RtlIpv4StringToAddress RtlIpv4StringToAddressA +#define RtlIpv4AddressToStringEx RtlIpv4AddressToStringExA +#define RtlIpv4StringToAddressEx RtlIpv4StringToAddressExA +#endif // UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ + +#endif //_WS2DEF_ + +#ifdef _WS2IPDEF_ + +#pragma region Desktop Family or Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +NTSYSAPI +PSTR +NTAPI +RtlIpv6AddressToStringA ( + _In_ const struct in6_addr *Addr, + _Out_writes_(46) PSTR S + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6AddressToStringExA( + _In_ const struct in6_addr *Address, + _In_ ULONG ScopeId, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +PWSTR +NTAPI +RtlIpv6AddressToStringW ( + _In_ const struct in6_addr *Addr, + _Out_writes_(46) PWSTR S + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6AddressToStringExW( + _In_ const struct in6_addr *Address, + _In_ ULONG ScopeId, + _In_ USHORT Port, + _Out_writes_to_(*AddressStringLength, *AddressStringLength) PWSTR AddressString, + _Inout_ PULONG AddressStringLength + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6StringToAddressA ( + _In_ PCSTR S, + _Out_ PCSTR *Terminator, + _Out_ struct in6_addr *Addr + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6StringToAddressExA ( + _In_ PCSTR AddressString, + _Out_ struct in6_addr *Address, + _Out_ PULONG ScopeId, + _Out_ PUSHORT Port + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6StringToAddressW ( + _In_ PCWSTR S, + _Out_ PCWSTR *Terminator, + _Out_ struct in6_addr *Addr + ); + +NTSYSAPI +LONG +NTAPI +RtlIpv6StringToAddressExW ( + _In_ PCWSTR AddressString, + _Out_ struct in6_addr *Address, + _Out_ PULONG ScopeId, + _Out_ PUSHORT Port + ); + +#ifdef UNICODE +#define RtlIpv6AddressToString RtlIpv6AddressToStringW +#define RtlIpv6StringToAddress RtlIpv6StringToAddressW +#define RtlIpv6StringToAddressEx RtlIpv6StringToAddressExW +#define RtlIpv6AddressToStringEx RtlIpv6AddressToStringExW +#else +#define RtlIpv6AddressToString RtlIpv6AddressToStringA +#define RtlIpv6StringToAddress RtlIpv6StringToAddressA +#define RtlIpv6StringToAddressEx RtlIpv6StringToAddressExA +#define RtlIpv6AddressToStringEx RtlIpv6AddressToStringExA +#endif // UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ + +#endif // __WS2IPDEF__ + +// +// Some simple Rtl routines for Ethernet address <-> string literal conversion +// +#ifdef _WS2DEF_ + +#pragma region Desktop Family or Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +union _DL_EUI48; +typedef union _DL_EUI48 DL_EUI48, *PDL_EUI48; + +NTSYSAPI +PSTR +NTAPI +RtlEthernetAddressToStringA ( + _In_ const DL_EUI48 *Addr, + _Out_writes_(18) PSTR S + ); + +NTSYSAPI +PWSTR +NTAPI +RtlEthernetAddressToStringW ( + _In_ const DL_EUI48 *Addr, + _Out_writes_(18) PWSTR S + ); + +NTSYSAPI +LONG +NTAPI +RtlEthernetStringToAddressA ( + _In_ PCSTR S, + _Out_ PCSTR *Terminator, + _Out_ DL_EUI48 *Addr + ); + +NTSYSAPI +LONG +NTAPI +RtlEthernetStringToAddressW ( + _In_ PCWSTR S, + _Out_ LPCWSTR *Terminator, + _Out_ DL_EUI48 *Addr + ); + +#ifdef UNICODE +#define RtlEthernetAddressToString RtlEthernetAddressToStringW +#define RtlEthernetStringToAddress RtlEthernetStringToAddressW +#else +#define RtlEthernetAddressToString RtlEthernetAddressToStringA +#define RtlEthernetStringToAddress RtlEthernetStringToAddressA +#endif // UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ + +#endif //_WS2DEF_ + +#endif // (NTDDI >= NTDDI_VISTA) +#endif // __IP2STRING__ + +#ifdef _PREFAST_ +#pragma prefast(pop) +#endif + +#pragma warning(pop) + +#ifdef MSTCPIPDEF_ASSERT_UNDEFINED +#undef ASSERT +#endif + +#ifdef __cplusplus +} +#endif + + +#endif // GUID_DEFS_ONLY + +#endif // !_MSTCPIP_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mswsockdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mswsockdef.h new file mode 100644 index 0000000000000000000000000000000000000000..1ff2969276f503f5c9934be7752deee6e64eb18f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/mswsockdef.h @@ -0,0 +1,152 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + mswsock.h + +Abstract: + + This module contains the Microsoft-specific extensions to the Windows + Sockets API. + +Revision History: + +--*/ + +#ifndef _MSWSOCKDEF_ +#define _MSWSOCKDEF_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#if(_WIN32_WINNT >= 0x0600) +#ifdef _MSC_VER +#define MSWSOCKDEF_INLINE __inline +#else +#define MSWSOCKDEF_INLINE extern inline /* GNU style */ +#endif +#endif //(_WIN32_WINNT>=0x0600) + +#ifndef ASSERT +#define MSWSOCKDEF_ASSERT_UNDEFINED +#define ASSERT(exp) ((VOID) 0) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if(_WIN32_WINNT >= 0x0600) + +#ifdef _WS2DEF_ + +extern CONST UCHAR sockaddr_size[AF_MAX]; + +MSWSOCKDEF_INLINE +UCHAR +SOCKADDR_SIZE(_In_ ADDRESS_FAMILY af) +{ + return (UCHAR)((af < AF_MAX) ? sockaddr_size[af] + : sockaddr_size[AF_UNSPEC]); +} + +MSWSOCKDEF_INLINE +SCOPE_LEVEL +ScopeLevel( + _In_ SCOPE_ID ScopeId + ) +{ + // + // We can't declare the Level field of type SCOPE_LEVEL directly, + // since it gets sign extended to be negative. We can, however, + // safely cast. + // + return (SCOPE_LEVEL)ScopeId.Level; +} + +#endif // _WS2DEF_ + +#define SIO_SET_COMPATIBILITY_MODE _WSAIOW(IOC_VENDOR,300) + +typedef enum _WSA_COMPATIBILITY_BEHAVIOR_ID { + WsaBehaviorAll = 0, + WsaBehaviorReceiveBuffering, + WsaBehaviorAutoTuning +} WSA_COMPATIBILITY_BEHAVIOR_ID, *PWSA_COMPATIBILITY_BEHAVIOR_ID; + +typedef struct _WSA_COMPATIBILITY_MODE { + WSA_COMPATIBILITY_BEHAVIOR_ID BehaviorId; + ULONG TargetOsVersion; +} WSA_COMPATIBILITY_MODE, *PWSA_COMPATIBILITY_MODE; + +#endif //(_WIN32_WINNT>=0x0600) + +typedef struct RIO_BUFFERID_t *RIO_BUFFERID, **PRIO_BUFFERID; +typedef struct RIO_CQ_t *RIO_CQ, **PRIO_CQ; +typedef struct RIO_RQ_t *RIO_RQ, **PRIO_RQ; + +typedef struct _RIORESULT { + LONG Status; + ULONG BytesTransferred; + ULONGLONG SocketContext; + ULONGLONG RequestContext; +} RIORESULT, *PRIORESULT; + +typedef struct _RIO_BUF { + RIO_BUFFERID BufferId; + ULONG Offset; + ULONG Length; +} RIO_BUF, *PRIO_BUF; + +#define RIO_MSG_DONT_NOTIFY 0x00000001 +#define RIO_MSG_DEFER 0x00000002 +#define RIO_MSG_WAITALL 0x00000004 +#define RIO_MSG_COMMIT_ONLY 0x00000008 + +#define RIO_INVALID_BUFFERID ((RIO_BUFFERID)(ULONG_PTR)0xFFFFFFFF) +#define RIO_INVALID_CQ ((RIO_CQ)0) +#define RIO_INVALID_RQ ((RIO_RQ)0) + +#define RIO_MAX_CQ_SIZE 0x8000000 +#define RIO_CORRUPT_CQ 0xFFFFFFFF + +typedef struct _RIO_CMSG_BUFFER { + ULONG TotalLength; + /* followed by CMSG_HDR */ +} RIO_CMSG_BUFFER, *PRIO_CMSG_BUFFER; + +#define RIO_CMSG_BASE_SIZE WSA_CMSGHDR_ALIGN(sizeof(RIO_CMSG_BUFFER)) + +#define RIO_CMSG_FIRSTHDR(buffer) \ + (((buffer)->TotalLength >= RIO_CMSG_BASE_SIZE) \ + ? ((((buffer)->TotalLength - RIO_CMSG_BASE_SIZE) >= \ + sizeof(WSACMSGHDR)) \ + ? (PWSACMSGHDR)((PUCHAR)(buffer) + \ + RIO_CMSG_BASE_SIZE) \ + : (PWSACMSGHDR)NULL) \ + : (PWSACMSGHDR)NULL) + +#define RIO_CMSG_NEXTHDR(buffer, cmsg) \ + ((cmsg) == NULL \ + ? RIO_CMSG_FIRSTHDR(buffer) \ + : (((PUCHAR)(cmsg) + \ + WSA_CMSGHDR_ALIGN((cmsg)->cmsg_len) + \ + sizeof(WSACMSGHDR) > \ + (PUCHAR)(buffer) + \ + (buffer)->TotalLength) \ + ? (PWSACMSGHDR)NULL \ + : (PWSACMSGHDR)((PUCHAR)(cmsg) + \ + WSA_CMSGHDR_ALIGN((cmsg)->cmsg_len)))) + +#ifdef __cplusplus +} +#endif + +#ifdef MSWSOCKDEF_ASSERT_UNDEFINED +#undef ASSERT +#endif +#endif /* _MSWSOCKDEF_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndisguid.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndisguid.h new file mode 100644 index 0000000000000000000000000000000000000000..7884a7f2e0ed5f9812848087c19a52286ab089a7 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndisguid.h @@ -0,0 +1,299 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ndisguid.h + +Abstract: + + GUID definitions for NDIS objects. + +Environment: + + User/Kernel mode + +Revision History: + +--*/ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + + +// +// Guid for Lan Class. +// +DEFINE_GUID(GUID_NDIS_LAN_CLASS, 0xad498944, 0x762f, 0x11d0, 0x8d, 0xcb, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_DEVINTERFACE_NET, 0xcac88484, 0x7515, 0x4c03, 0x82, 0xe6, 0x71, 0xa8, 0x7a, 0xba, 0xc3, 0x61); +DEFINE_GUID(UNSPECIFIED_NETWORK_GUID, 0x12ba5bde, 0x143e, 0x4c0d, 0xb6, 0x6d, 0x23, 0x79, 0xbb, 0x14, 0x19, 0x13); +DEFINE_GUID(GUID_DEVINTERFACE_NETUIO, 0x08336f60, 0x0679, 0x4c6c, 0x85, 0xd2, 0xae, 0x7c, 0xed, 0x65, 0xff, 0xf7); + +// +// NDIS global GUIDs +// +DEFINE_GUID(GUID_NDIS_ENUMERATE_ADAPTER, 0x981f2d7f, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_ADAPTER_REMOVAL, 0x981f2d80, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_ADAPTER_ARRIVAL, 0x981f2d81, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_ENUMERATE_VC, 0x981f2d82, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_VC_REMOVAL, 0x981f2d79, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_VC_ARRIVAL, 0x182f9e0c, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_BIND, 0x5413531c, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_NOTIFY_UNBIND, 0x6e3ce1ec, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_WAKE_ON_MAGIC_PACKET_ONLY, 0xa14f1c97, 0x8839, 0x4f8a, 0x99, 0x96, 0xa2, 0x89, 0x96, 0xeb, 0xbf, 0x1d); +DEFINE_GUID(GUID_NDIS_NOTIFY_DEVICE_POWER_ON, 0x5f81cfd0, 0xf046, 0x4342, 0xaf, 0x61, 0x89, 0x5a, 0xce, 0xda, 0xef, 0xd9); +DEFINE_GUID(GUID_NDIS_NOTIFY_DEVICE_POWER_OFF, 0x81bc8189, 0xb026, 0x46ab, 0xb9, 0x64, 0xf1, 0x82, 0xe3, 0x42, 0x93, 0x4e); + +DEFINE_GUID(GUID_NDIS_NOTIFY_FILTER_REMOVAL, 0x1f177cd9, 0x5955, 0x4721, 0x9f, 0x6a, 0x78, 0xeb, 0xdf, 0xae, 0xf8, 0x89); +DEFINE_GUID(GUID_NDIS_NOTIFY_FILTER_ARRIVAL, 0x0b6d3c89, 0x5917, 0x43ca, 0xb5, 0x78, 0xd0, 0x1a, 0x79, 0x67, 0xc4, 0x1c); + +DEFINE_GUID(GUID_NDIS_NOTIFY_DEVICE_POWER_ON_EX, 0x2b440188, 0x92ac, 0x4f60, 0x9b, 0x2d, 0x20, 0xa3, 0x0c, 0xbb, 0x6b, 0xbe); +DEFINE_GUID(GUID_NDIS_NOTIFY_DEVICE_POWER_OFF_EX, 0x4159353c, 0x5cd7, 0x42ce, 0x8f, 0xe4, 0xa4, 0x5a, 0x23, 0x80, 0xcc, 0x4f); + +// {1528D111-708A-4ca4-9215-C05771161CDA} - used with NDIS_WMI_PM_ADMIN_CONFIG +DEFINE_GUID(GUID_NDIS_PM_ADMIN_CONFIG, 0x1528d111, 0x708a, 0x4ca4, 0x92, 0x15, 0xc0, 0x57, 0x71, 0x16, 0x1c, 0xda); +// {B2CF76E3-B3AE-4394-A01F-338C9870E939} - use with NDIS_WMI_PM_ACTIVE_CAPABILITIES +DEFINE_GUID(GUID_NDIS_PM_ACTIVE_CAPABILITIES, 0xb2cf76e3, 0xb3ae, 0x4394, 0xa0, 0x1f, 0x33, 0x8c, 0x98, 0x70, 0xe9, 0x39); + +DEFINE_GUID(GUID_NDIS_RSS_ENABLED, 0x9565cd55, 0x3402, 0x4e32, 0xa5, 0xb6, 0x2f, 0x14, 0x3f, 0x2f, 0x2c, 0x30); + +// +// GUIDs for General OIDs +// +DEFINE_GUID(GUID_NDIS_GEN_HARDWARE_STATUS, 0x5ec10354, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MEDIA_SUPPORTED, 0x5ec10355, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MEDIA_IN_USE, 0x5ec10356, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MAXIMUM_LOOKAHEAD, 0x5ec10357, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MAXIMUM_FRAME_SIZE, 0x5ec10358, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_LINK_SPEED, 0x5ec10359, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_TRANSMIT_BUFFER_SPACE, 0x5ec1035a, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_RECEIVE_BUFFER_SPACE, 0x5ec1035b, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_TRANSMIT_BLOCK_SIZE, 0x5ec1035c, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_RECEIVE_BLOCK_SIZE, 0x5ec1035d, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_VENDOR_ID, 0x5ec1035e, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_VENDOR_DESCRIPTION, 0x5ec1035f, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CURRENT_PACKET_FILTER, 0x5ec10360, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CURRENT_LOOKAHEAD, 0x5ec10361, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_DRIVER_VERSION, 0x5ec10362, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MAXIMUM_TOTAL_SIZE, 0x5ec10363, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MAC_OPTIONS, 0x5ec10365, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MEDIA_CONNECT_STATUS, 0x5ec10366, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_MAXIMUM_SEND_PACKETS, 0x5ec10367, 0xa61a, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_VENDOR_DRIVER_VERSION, 0x447956f9, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_VLAN_ID, 0x765dc702, 0xc5e8, 0x4b67, 0x84, 0x3b, 0x3f, 0x5a, 0x4f, 0xf2, 0x64, 0x8b); +DEFINE_GUID(GUID_NDIS_GEN_PHYSICAL_MEDIUM, 0x418ca16d, 0x3937, 0x4208, 0x94, 0x0a, 0xec, 0x61, 0x96, 0x27, 0x80, 0x85); +DEFINE_GUID(GUID_NDIS_TCP_OFFLOAD_CURRENT_CONFIG, 0x68542fed, 0x5c74, 0x461e, 0x89, 0x34, 0x91, 0xc6, 0xf9, 0xc6, 0x09, 0x60); // uses NDIS_OFFLOAD +DEFINE_GUID(GUID_NDIS_TCP_OFFLOAD_HARDWARE_CAPABILITIES, 0xcd5f1102, 0x590f, 0x4ada, 0xab, 0x65, 0x5b, 0x31, 0xb1, 0xdc, 0x01, 0x72); // uses NDIS_OFFLOAD +DEFINE_GUID(GUID_NDIS_TCP_OFFLOAD_PARAMETERS, 0x8ead9a22, 0x7f69, 0x4bc6, 0x94, 0x9a, 0xc8, 0x18, 0x7b, 0x07, 0x4e, 0x61); // uses NDIS_OFFLOAD_PARAMETERS +DEFINE_GUID(GUID_NDIS_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG, 0x2ee6aef1, 0x0851, 0x458b, 0xbf, 0x0d, 0x79, 0x23, 0x43, 0xd1, 0xcd, 0xe1); // uses NDIS_TCP_CONNECTION_OFFLOAD +DEFINE_GUID(GUID_NDIS_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES, 0x8ce71f2c, 0xd63a, 0x4390, 0xa4, 0x87, 0x18, 0xfa, 0x47, 0x26, 0x2c, 0xeb); // uses NDIS_TCP_CONNECTION_OFFLOAD +DEFINE_GUID(GUID_NDIS_RECEIVE_SCALE_CAPABILITIES, 0x26c28774, 0x4252, 0x48fe, 0xa6, 0x10, 0xa5, 0x8a, 0x39, 0x8c, 0x0e, 0xb1); + + +DEFINE_GUID(GUID_NDIS_GEN_LINK_STATE, 0xba1f4c14, 0xa945, 0x4762, 0xb9, 0x16, 0x0b, 0x55, 0x15, 0xb6, 0xf4, 0x3a); +DEFINE_GUID(GUID_NDIS_GEN_LINK_PARAMETERS, 0x8c7d3579, 0x252b, 0x4614, 0x82, 0xc5, 0xa6, 0x50, 0xda, 0xa1, 0x50, 0x49); +DEFINE_GUID(GUID_NDIS_GEN_STATISTICS, 0x368c45b5, 0xc129, 0x43c1, 0x93, 0x9e, 0x7e, 0xdc, 0x2d, 0x7f, 0xe6, 0x21); +DEFINE_GUID(GUID_NDIS_GEN_PORT_STATE, 0x6fbf2a5f, 0x8b8f, 0x4920, 0x81, 0x43, 0xe6, 0xc4, 0x60, 0xf5, 0x25, 0x24); +DEFINE_GUID(GUID_NDIS_GEN_ENUMERATE_PORTS, 0xf1d6abe8, 0x15e4, 0x4407, 0x81, 0xb7, 0x6b, 0x83, 0x0c, 0x77, 0x7c, 0xd9); +DEFINE_GUID(GUID_NDIS_ENUMERATE_ADAPTERS_EX, 0x16716917, 0x4306, 0x4be4, 0x9b, 0x5a, 0x38, 0x09, 0xae, 0x44, 0xb1, 0x25); +DEFINE_GUID(GUID_NDIS_GEN_PORT_AUTHENTICATION_PARAMETERS, 0xaab6ac31, 0x86fb, 0x48fb, 0x8b, 0x48, 0x63, 0xdb, 0x23, 0x5a, 0xce, 0x16); +DEFINE_GUID(GUID_NDIS_GEN_INTERRUPT_MODERATION, 0xd9c8eea5, 0xf16e, 0x467c, 0x84, 0xd5, 0x63, 0x45, 0xa2, 0x2c, 0xe2, 0x13); +DEFINE_GUID(GUID_NDIS_GEN_INTERRUPT_MODERATION_PARAMETERS, 0xd789adfa, 0x9c56, 0x433b, 0xad, 0x01, 0x75, 0x74, 0xf3, 0xce, 0xdb, 0xe9); +DEFINE_GUID(GUID_NDIS_GEN_PCI_DEVICE_CUSTOM_PROPERTIES, 0xaa39f5ab, 0xe260,0x4d01, 0x82, 0xb0, 0xb7, 0x37, 0xc8, 0x80, 0xea, 0x05); +DEFINE_GUID(GUID_NDIS_GEN_PHYSICAL_MEDIUM_EX, 0x899e7782, 0x035b,0x43f9, 0x8b, 0xb6, 0x2b, 0x58, 0x97, 0x16, 0x12, 0xe5); +DEFINE_GUID(GUID_NDIS_HD_SPLIT_CURRENT_CONFIG, 0x81d1303c, 0xab00, 0x4e49, 0x80, 0xb1, 0x5e, 0x6e, 0x0b, 0xf9, 0xbe, 0x53); // uses NDIS_HD_SPLIT_CURRENT_CONFIGURATION +DEFINE_GUID(GUID_NDIS_HD_SPLIT_PARAMETERS, 0x8c048bea, 0x2913, 0x4458, 0xb6, 0x8e, 0x17, 0xf6, 0xc1, 0xe5, 0xc6, 0x0e); // uses NDIS_HD_SPLIT_PARAMETERS +DEFINE_GUID(GUID_NDIS_TCP_RSC_STATISTICS, 0x83104445, 0x9b5d, 0x4ee6, 0xa2, 0xa5, 0x2b, 0xd3, 0xfb, 0x3c, 0x36, 0xaf); + +// {ece5360d-3291-4a6e-8044-00511fed27ee} - uses NDIS_PM_CAPABILITIES +DEFINE_GUID(GUID_PM_HARDWARE_CAPABILITIES, 0xece5360d, 0x3291, 0x4a6e, 0x80, 0x44, 0x00, 0x51, 0x1f, 0xed, 0x27, 0xee); +// {3ABDBD14-D44A-4a3f-9A63-A0A42A51B131} - uses NDIS_PM_CAPABILITIES +DEFINE_GUID(GUID_PM_CURRENT_CAPABILITIES, 0x3abdbd14, 0xd44a, 0x4a3f, 0x9a, 0x63, 0xa0, 0xa4, 0x2a, 0x51, 0xb1, 0x31); +// {560245D2-E251-409c-A280-311935BE3B28} - use NDIS_PM_PARAMETERS +DEFINE_GUID(GUID_PM_PARAMETERS, 0x560245d2, 0xe251, 0x409c, 0xa2, 0x80, 0x31, 0x19, 0x35, 0xbe, 0x3b, 0x28); +// {6FC83BA7-52BC-4faa-AC51-7D2FFE63BA90} - use NDIS_PM_WOL_PATTERN +DEFINE_GUID(GUID_PM_ADD_WOL_PATTERN, 0x6fc83ba7, 0x52bc, 0x4faa, 0xac, 0x51, 0x7d, 0x2f, 0xfe, 0x63, 0xba, 0x90); +// {A037A915-C6CA-4322-B3E3-EF754EC498DC} +DEFINE_GUID(GUID_PM_REMOVE_WOL_PATTERN, 0xa037a915, 0xc6ca, 0x4322, 0xb3, 0xe3, 0xef, 0x75, 0x4e, 0xc4, 0x98, 0xdc); +// {4022BE37-7EE2-47be-A5A5-050FC79AFC75} +DEFINE_GUID(GUID_PM_WOL_PATTERN_LIST, 0x4022be37, 0x7ee2, 0x47be, 0xa5, 0xa5, 0x05, 0x0f, 0xc7, 0x9a, 0xfc, 0x75); +// {0C06C112-0D93-439b-9E6D-26BE130C9784} - uses NDIS_PM_PROTOCOL_OFFLOAD +DEFINE_GUID(GUID_PM_ADD_PROTOCOL_OFFLOAD, 0x0c06c112, 0x0d93, 0x439b, 0x9e, 0x6d, 0x26, 0xbe, 0x13, 0x0c, 0x97, 0x84); +// {A6435CD9-149F-498e-951B-2D94BEA3E3A3} - uses NDIS_PM_PROTOCOL_OFFLOAD +DEFINE_GUID(GUID_PM_GET_PROTOCOL_OFFLOAD, 0xa6435cd9, 0x149f, 0x498e, 0x95, 0x1b, 0x2d, 0x94, 0xbe, 0xa3, 0xe3, 0xa3); +// {DECD7BE2-A6B0-43ca-AE45-D000D20E5265} +DEFINE_GUID(GUID_PM_REMOVE_PROTOCOL_OFFLOAD, 0xdecd7be2, 0xa6b0, 0x43ca, 0xae, 0x45, 0xd0, 0x00, 0xd2, 0x0e, 0x52, 0x65); +// {736EC5AB-CA8F-4043-BB58-DA402A48D9CC} +DEFINE_GUID(GUID_PM_PROTOCOL_OFFLOAD_LIST, 0x736ec5ab, 0xca8f, 0x4043, 0xbb, 0x58, 0xda, 0x40, 0x2a, 0x48, 0xd9, 0xcc); + +// +// GUIDs for receive filters +// +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_HARDWARE_CAPABILITIES, 0x3f2c1419, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_FILTER_CAPABILITIES +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS, 0x3f2c141a, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_ENUM_QUEUES, 0x3f2c141b, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_QUEUE_INFO_ARRAY +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_QUEUE_PARAMETERS, 0x3f2c141c, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_QUEUE_PARAMETERS +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_ENUM_FILTERS, 0x3f2c141d, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_FILTER_INFO_ARRAY +DEFINE_GUID(GUID_NDIS_RECEIVE_FILTER_PARAMETERS, 0x3f2c141e, 0x83bc, 0x11dd, 0x94, 0xb8, 0x00, 0x1d, 0x09, 0x16, 0x2b, 0xc3); // uses NDIS_RECEIVE_FILTER_PARAMETERS +DEFINE_GUID(GUID_RECEIVE_FILTER_CURRENT_CAPABILITIES, 0x4054e80f, 0x2bc1, 0x4ccc, 0xb0, 0x33, 0x4a, 0xbc, 0x0c, 0x4a, 0x1e, 0x8c); // uses RECEIVE_FILTER_CAPABILITIES +DEFINE_GUID(GUID_NIC_SWITCH_HARDWARE_CAPABILITIES, 0x37cab40c, 0xd1e8, 0x4301, 0x8c, 0x1d, 0x58, 0x46, 0x5e, 0x0c, 0x4c, 0x0f); // uses NIC_SWITCH_CAPABILITIES +DEFINE_GUID(GUID_NIC_SWITCH_CURRENT_CAPABILITIES, 0xe76fdaf3, 0x0be7, 0x4d95, 0x87, 0xe9, 0x5a, 0xea, 0xd4, 0xb5, 0x90, 0xe9); // uses NIC_SWITCH_CAPABILITIES + +// +// GUIDs for switch policy +// +DEFINE_GUID(GUID_NDIS_SWITCH_MICROSOFT_VENDOR_ID, 0x202547fe, 0x1c9c, 0x40b9, 0xbb, 0xa1, 0x8, 0xad, 0xa1, 0xf9, 0x8b, 0x3c); +DEFINE_GUID(GUID_NDIS_SWITCH_PORT_PROPERTY_PROFILE_ID_DEFAULT_EXTERNAL_NIC, 0xb347846, 0xa0c, 0x470a, 0x9b, 0x7a, 0xd, 0x96, 0x58, 0x50, 0x69, 0x8f); + +// +// GUIDs for General Required Statistics OIDs +// +DEFINE_GUID(GUID_NDIS_GEN_XMIT_OK, 0x447956fa, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_RCV_OK, 0x447956fb, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_XMIT_ERROR, 0x447956fc, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_RCV_ERROR, 0x447956fd, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_RCV_NO_BUFFER, 0x447956fe, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for General Required CO-NDIS OIDs +// +DEFINE_GUID(GUID_NDIS_GEN_CO_HARDWARE_STATUS, 0x791ad192, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_MEDIA_SUPPORTED, 0x791ad193, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_MEDIA_IN_USE, 0x791ad194, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_LINK_SPEED, 0x791ad195, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_VENDOR_ID, 0x791ad196, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_VENDOR_DESCRIPTION, 0x791ad197, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_DRIVER_VERSION, 0x791ad198, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_MAC_OPTIONS, 0x791ad19a, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_MEDIA_CONNECT_STATUS, 0x791ad19b, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_VENDOR_DRIVER_VERSION, 0x791ad19c, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_MINIMUM_LINK_SPEED, 0x791ad19d, 0xe35c, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for General Required CO-NDIS Statistics OIDs +// +DEFINE_GUID(GUID_NDIS_GEN_CO_XMIT_PDUS_OK, 0x0a214805, 0xe35f, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_RCV_PDUS_OK, 0x0a214806, 0xe35f, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_XMIT_PDUS_ERROR, 0x0a214807, 0xe35f, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_RCV_PDUS_ERROR, 0x0a214808, 0xe35f, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_GEN_CO_RCV_PDUS_NO_BUFFER, 0x0a214809, 0xe35f, 0x11d0, 0x96, 0x92, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for Required Ethernet OIDs +// +DEFINE_GUID(GUID_NDIS_802_3_PERMANENT_ADDRESS, 0x447956ff, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_CURRENT_ADDRESS, 0x44795700, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_MULTICAST_LIST, 0x44795701, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_MAXIMUM_LIST_SIZE, 0x44795702, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_MAC_OPTIONS, 0x44795703, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for Required Ethernet Statistics OIDs +// +DEFINE_GUID(GUID_NDIS_802_3_RCV_ERROR_ALIGNMENT, 0x44795704, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_XMIT_ONE_COLLISION, 0x44795705, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_3_XMIT_MORE_COLLISIONS, 0x44795706, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for Required Token-Ring OIDs +// +DEFINE_GUID(GUID_NDIS_802_5_PERMANENT_ADDRESS, 0x44795707, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_CURRENT_ADDRESS, 0x44795708, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_CURRENT_FUNCTIONAL, 0x44795709, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_CURRENT_GROUP, 0x4479570a, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_LAST_OPEN_STATUS, 0x4479570b, 0xa61b, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_CURRENT_RING_STATUS, 0x890a36ec, 0xa61c, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_CURRENT_RING_STATE, 0xacf14032, 0xa61c, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for Required Token-Ring Statistics OIDs +// +DEFINE_GUID(GUID_NDIS_802_5_LINE_ERRORS, 0xacf14033, 0xa61c, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_802_5_LOST_FRAMES, 0xacf14034, 0xa61c, 0x11d0, 0x8d, 0xd4, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); + +// +// GUIDs for required and optional 802.11 Wireless LAN OIDs +// +DEFINE_GUID(GUID_NDIS_802_11_BSSID, 0x2504b6c2, 0x1fa5, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_SSID, 0x7d2a90ea, 0x2041, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_NETWORK_TYPES_SUPPORTED, 0x8531d6e6, 0x2041, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_NETWORK_TYPE_IN_USE, 0x857e2326, 0x2041, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_POWER_MODE, 0x85be837c, 0x2041, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_TX_POWER_LEVEL, 0x11e6ba76, 0x2053, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_RSSI, 0x1507db16, 0x2053, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_RSSI_TRIGGER, 0x155689b8, 0x2053, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_BSSID_LIST, 0x69526f9a, 0x2062, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_INFRASTRUCTURE_MODE, 0x697d5a7e, 0x2062, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_FRAGMENTATION_THRESHOLD, 0x69aaa7c4, 0x2062, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_RTS_THRESHOLD, 0x0134d07e, 0x2064, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_NUMBER_OF_ANTENNAS, 0x01779336, 0x2064, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_RX_ANTENNA_SELECTED, 0x01ac07a2, 0x2064, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_TX_ANTENNA_SELECTED, 0x01dbb74a, 0x2064, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_SUPPORTED_RATES, 0x49db8722, 0x2068, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_DESIRED_RATES, 0x452ee08e, 0x2536, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_CONFIGURATION, 0x4a4df982, 0x2068, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_STATISTICS, 0x42bb73b0, 0x2129, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_ADD_WEP, 0x4307bff0, 0x2129, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_REMOVE_WEP, 0x433c345c, 0x2129, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_DISASSOCIATE, 0x43671f40, 0x2129, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_AUTHENTICATION_MODE, 0x43920a24, 0x2129, 0x11d4, 0x97, 0xeb, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_PRIVACY_FILTER, 0x6733c4e9, 0x4792, 0x11d4, 0x97, 0xf1, 0x00, 0xc0, 0x4f, 0x79, 0xc4, 0x03); +DEFINE_GUID(GUID_NDIS_802_11_BSSID_LIST_SCAN, 0x0d9e01e1, 0xba70, 0x11d4, 0xb6, 0x75, 0x00, 0x20, 0x48, 0x57, 0x03, 0x37); +DEFINE_GUID(GUID_NDIS_802_11_WEP_STATUS, 0xb027a21f, 0x3cfa, 0x4125, 0x80, 0x0b, 0x3f, 0x7a, 0x18, 0xfd, 0xdc, 0xdc); +DEFINE_GUID(GUID_NDIS_802_11_RELOAD_DEFAULTS, 0x748b14e8, 0x32ee, 0x4425, 0xb9, 0x1b, 0xc9, 0x84, 0x8c, 0x58, 0xb5, 0x5a); +DEFINE_GUID(GUID_NDIS_802_11_ADD_KEY, 0xab8b5a62, 0x1d51, 0x49d8, 0xba, 0x5c, 0xfa, 0x98, 0x0b, 0xe0, 0x3a, 0x1d); +DEFINE_GUID(GUID_NDIS_802_11_REMOVE_KEY, 0x73cb28e9, 0x3188, 0x42d5, 0xb5, 0x53, 0xb2, 0x12, 0x37, 0xe6, 0x08, 0x8c); +DEFINE_GUID(GUID_NDIS_802_11_ASSOCIATION_INFORMATION, 0xa08d4dd0, 0x960e, 0x40bd, 0x8c, 0xf6, 0xc5, 0x38, 0xaf, 0x98, 0xf2, 0xe3); +DEFINE_GUID(GUID_NDIS_802_11_TEST, 0x4b9ca16a, 0x6a60, 0x4e9d, 0x92, 0x0c, 0x63, 0x35, 0x95, 0x3f, 0xa0, 0xb5); +DEFINE_GUID(GUID_NDIS_802_11_MEDIA_STREAM_MODE, 0x0a56af66, 0xd84b, 0x49eb, 0xa2, 0x8d, 0x52, 0x82, 0xcb, 0xb6, 0xd0, 0xcd); + +// +// GUIDs for NDIS status indications +// + +DEFINE_GUID(GUID_NDIS_STATUS_RESET_START, 0x981f2d76, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_RESET_END, 0x981f2d77, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_MEDIA_CONNECT, 0x981f2d7d, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_MEDIA_DISCONNECT, 0x981f2d7e, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_MEDIA_SPECIFIC_INDICATION, 0x981f2d84, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_LINK_SPEED_CHANGE, 0x981f2d85, 0xb1f3, 0x11d0, 0x8d, 0xd7, 0x00, 0xc0, 0x4f, 0xc3, 0x35, 0x8c); +DEFINE_GUID(GUID_NDIS_STATUS_PACKET_FILTER, 0xd47c5407, 0x2e75, 0x46dd, 0x81, 0x46, 0x1d, 0x7e, 0xd2, 0xd6, 0xab, 0x1d); +DEFINE_GUID(GUID_NDIS_STATUS_NETWORK_CHANGE, 0xca8a56f9, 0xce81, 0x40e6, 0xa7, 0x0f, 0xa0, 0x67,0xa4,0x76, 0xe9, 0xe9); +DEFINE_GUID(GUID_NDIS_STATUS_TASK_OFFLOAD_CURRENT_CONFIG, 0x45049fc6, 0x54d8, 0x40c8, 0x9c, 0x3d, 0xb0, 0x11, 0xc4, 0xe7, 0x15, 0xbc); // NDIS_STATUS_TASK_OFFLOAD_CURRENT_CONFIG +DEFINE_GUID(GUID_NDIS_STATUS_TASK_OFFLOAD_HARDWARE_CAPABILITIES, 0xb6b8158b, 0x217c, 0x4b2a, 0xbe, 0x86, 0x6a, 0x04, 0xbe, 0xea, 0x65, 0xb8); // NDIS_STATUS_TASK_OFFLOAD_HARDWARE_CAPABILITIES +DEFINE_GUID(GUID_NDIS_STATUS_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG, 0xf8edaeff, 0x24e4, 0x4ae6, 0xa4, 0x13, 0x0b, 0x27, 0xf7, 0x6b, 0x24, 0x3d); // NDIS_STATUS_OFFLOAD_RESUME +DEFINE_GUID(GUID_NDIS_STATUS_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES, 0x391969b6, 0x402c, 0x43bf, 0x89, 0x22, 0x39, 0xea, 0xe0, 0xda, 0x1b, 0xb5); // NDIS_STATUS_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES + +DEFINE_GUID(GUID_NDIS_STATUS_OPER_STATUS, 0xf917b663, 0x845e, 0x4d3d, 0xb6, 0xd4, 0x15, 0xeb, 0x27, 0xaf, 0x81, 0xc5); +DEFINE_GUID(GUID_NDIS_STATUS_LINK_STATE, 0x64c6f797, 0x878c, 0x4311, 0x92, 0x46, 0x65, 0xdb, 0xa8, 0x9c, 0x3a, 0x61); +DEFINE_GUID(GUID_NDIS_STATUS_PORT_STATE, 0x1dac0dfe, 0x43e5, 0x44b7, 0xb7, 0x59, 0x7b, 0xf4, 0x6d, 0xe3, 0x2e, 0x81); +DEFINE_GUID(GUID_NDIS_STATUS_EXTERNAL_CONNECTIVITY_CHANGE, 0xfd306974, 0xc420, 0x4433, 0xb0, 0xfe, 0x4c, 0xf6, 0xa6, 0x13, 0xf5, 0x9f); +DEFINE_GUID(GUID_STATUS_MEDIA_SPECIFIC_INDICATION_EX, 0xaaacfca7, 0x954a, 0x4632, 0xa1, 0x6e, 0xa8, 0xa6, 0x37, 0x93, 0xa9, 0xe5); +DEFINE_GUID(GUID_NDIS_STATUS_HD_SPLIT_CURRENT_CONFIG, 0x6c744b0e, 0xee9c, 0x4205, 0x90, 0xa2, 0x01, 0x5f, 0x6d, 0x65, 0xf4, 0x03); // NDIS_STATUS_HD_SPLIT_CURRENT_CONFIG +DEFINE_GUID(GUID_NDIS_STATUS_PM_WOL_PATTERN_REJECTED, 0xf72cf68e, 0x18d4, 0x4d63, 0x9a, 0x19, 0xe6, 0x9b, 0x13, 0x91, 0x6b, 0x1a); +DEFINE_GUID(GUID_NDIS_STATUS_PM_OFFLOAD_REJECTED, 0xadd1d481, 0x711e, 0x4d1a, 0x92, 0xca, 0xa6, 0x2d, 0xb9, 0x32, 0x97, 0x12); +DEFINE_GUID(GUID_NDIS_STATUS_PM_WAKE_REASON, 0x0933fd58, 0xca62, 0x438f, 0x83, 0xda, 0xdf, 0xc1, 0xcc, 0xcb, 0x81, 0x45); + +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_SCAN_CONFIRM, 0x8500591e, 0xa0c7, 0x4efb, 0x93, 0x42, 0xb6, 0x74, 0xb0, 0x02, 0xcb, 0xe6); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_MPDU_MAX_LENGTH_CHANGED, 0x1d6560ec, 0x8e48, 0x4a3e, 0x9f, 0xd5, 0xa0, 0x1b, 0x69, 0x8d, 0xb6, 0xc5); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_ASSOCIATION_START, 0x3927843b, 0x6980, 0x4b48, 0xb1, 0x5b, 0x4d, 0xe5, 0x09, 0x77, 0xac, 0x40); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_ASSOCIATION_COMPLETION, 0x458bbea7, 0x45a4, 0x4ae2, 0xb1, 0x76, 0xe5, 0x1f, 0x96, 0xfc, 0x05, 0x68); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_CONNECTION_START, 0x7b74299d, 0x998f, 0x4454, 0xad, 0x08, 0xc5, 0xaf, 0x28, 0x57, 0x6d, 0x1b); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_CONNECTION_COMPLETION, 0x96efd9c9, 0x7f1b, 0x4a89, 0xbc, 0x04, 0x3e, 0x9e, 0x27, 0x17, 0x65, 0xf1); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_ROAMING_START, 0xb2412d0d, 0x26c8, 0x4f4e, 0x93, 0xdf, 0xf7, 0xb7, 0x05, 0xa0, 0xb4, 0x33); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_ROAMING_COMPLETION, 0xdd9d47d1, 0x282b, 0x41e4, 0xb9, 0x24, 0x66, 0x36, 0x88, 0x17, 0xfc, 0xd3); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_DISASSOCIATION, 0x3fbeb6fc, 0x0fe2, 0x43fd, 0xb2, 0xad, 0xbd, 0x99, 0xb5, 0xf9, 0x3e, 0x13); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_TKIPMIC_FAILURE, 0x442c2ae4, 0x9bc5, 0x4b90, 0xa8, 0x89, 0x45, 0x5e, 0xf2, 0x20, 0xf4, 0xee); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_PMKID_CANDIDATE_LIST, 0x26d8b8f6, 0xdb82, 0x49eb, 0x8b, 0xf3, 0x4c, 0x13, 0x0e, 0xf0, 0x69, 0x50); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_PHY_STATE_CHANGED, 0xdeb45316, 0x71b5, 0x4736, 0xbd, 0xef, 0x0a, 0x9e, 0x9f, 0x4e, 0x62, 0xdc); +DEFINE_GUID(GUID_NDIS_STATUS_DOT11_LINK_QUALITY, 0xa3285184, 0xea99, 0x48ed, 0x82, 0x5e, 0xa4, 0x26, 0xb1, 0x1c, 0x27, 0x54); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndkinfo.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndkinfo.h new file mode 100644 index 0000000000000000000000000000000000000000..9d9defd5bc565b2a6e69a23239a960e03b7d0abc --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ndkinfo.h @@ -0,0 +1,103 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + ndkinfo.h + +Abstract: + + NetworkDirect adapter information + +Environment: + + User mode and kernel mode + +--*/ + +#ifndef _NDKINFO_H_ +#define _NDKINFO_H_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct { + USHORT Major; + USHORT Minor; +} NDK_VERSION; + +typedef enum _NDK_RDMA_TECHNOLOGY { + NdkUndefined = 0, + NdkiWarp, + NdkInfiniBand, + NdkRoCE, + NdkRoCEv2, + NdkMaxTechnology +} NDK_RDMA_TECHNOLOGY; + +typedef struct _NDK_ADAPTER_INFO { + + NDK_VERSION Version; + + UINT32 VendorId; + + UINT32 DeviceId; + + SIZE_T MaxRegistrationSize; + + SIZE_T MaxWindowSize; + + ULONG FRMRPageCount; + + ULONG MaxInitiatorRequestSge; + + ULONG MaxReceiveRequestSge; + + ULONG MaxReadRequestSge; + + ULONG MaxTransferLength; + + ULONG MaxInlineDataSize; + + ULONG MaxInboundReadLimit; + + ULONG MaxOutboundReadLimit; + + ULONG MaxReceiveQueueDepth; + + ULONG MaxInitiatorQueueDepth; + + ULONG MaxSrqDepth; + + ULONG MaxCqDepth; + + ULONG LargeRequestThreshold; + + ULONG MaxCallerData; + + ULONG MaxCalleeData; + + ULONG AdapterFlags; + + NDK_RDMA_TECHNOLOGY RdmaTechnology; +} NDK_ADAPTER_INFO; + +#define NDK_ADAPTER_FLAG_IN_ORDER_DMA_SUPPORTED 0x00000001 +#define NDK_ADAPTER_FLAG_RDMA_READ_SINK_NOT_REQUIRED 0x00000002 +#define NDK_ADAPTER_FLAG_CQ_INTERRUPT_MODERATION_SUPPORTED 0x00000004 +#define NDK_ADAPTER_FLAG_MULTI_ENGINE_SUPPORTED 0x00000008 +#define NDK_ADAPTER_FLAG_RDMA_READ_LOCAL_INVALIDATE_SUPPORTED 0x00000010 +#define NDK_ADAPTER_FLAG_CQ_RESIZE_SUPPORTED 0x00000100 +#define NDK_ADAPTER_FLAG_LOOPBACK_CONNECTIONS_SUPPORTED 0x00010000 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _NDKINFO_H_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netevent.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netevent.h new file mode 100644 index 0000000000000000000000000000000000000000..60e9ac636c1adcf96575e17eedfd67182e8b1e6c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netevent.h @@ -0,0 +1,7361 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) 1992-1996 Microsoft Corporation + +Module Name: + + netevent.h + +Abstract: + + Definitions for network events. + +Author: + + Portable Systems Group 6-May-1992 + +Revision History: + +Notes: + + This file is generated by the MC tool from the netevent.mc file. + +--*/ + +#ifndef _NETEVENT_ +#define _NETEVENT_ + + +///////////////////////////////////////////////////////////////////////// +// +// Lanman Server Events (2000 - 2999) +// 2000-2499 are generated by the server driver (kernel mode) +// 2500-2999 are generated by the server service (user mode) +// +///////////////////////////////////////////////////////////////////////// + + +// Server driver events, issued from kernel mode. Don't use %1 for +// server-supplied insertion strings -- the I/O system provides the +// first string. + +// +// Values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// + + +// +// Define the severity codes +// +#define STATUS_SEVERITY_SUCCESS 0x0 +#define STATUS_SEVERITY_INFORMATIONAL 0x1 +#define STATUS_SEVERITY_WARNING 0x2 +#define STATUS_SEVERITY_ERROR 0x3 + + +// +// MessageId: EVENT_SRV_SERVICE_FAILED +// +// MessageText: +// +// The server's call to a system service failed unexpectedly. +// +#define EVENT_SRV_SERVICE_FAILED 0xC00007D0L + +// +// MessageId: EVENT_SRV_RESOURCE_SHORTAGE +// +// MessageText: +// +// The server was unable to perform an operation due to a shortage of available resources. +// +#define EVENT_SRV_RESOURCE_SHORTAGE 0xC00007D1L + +// +// MessageId: EVENT_SRV_CANT_CREATE_DEVICE +// +// MessageText: +// +// The server could not create its device. The server could not be started. +// +#define EVENT_SRV_CANT_CREATE_DEVICE 0xC00007D2L + +// +// MessageId: EVENT_SRV_CANT_CREATE_PROCESS +// +// MessageText: +// +// The server could not create a process. The server could not be started. +// +#define EVENT_SRV_CANT_CREATE_PROCESS 0xC00007D3L + +// +// MessageId: EVENT_SRV_CANT_CREATE_THREAD +// +// MessageText: +// +// The server could not create a startup thread. The server could not be started. +// +#define EVENT_SRV_CANT_CREATE_THREAD 0xC00007D4L + +// +// MessageId: EVENT_SRV_UNEXPECTED_DISC +// +// MessageText: +// +// The server received an unexpected disconnection from a client. +// +#define EVENT_SRV_UNEXPECTED_DISC 0xC00007D5L + +// +// MessageId: EVENT_SRV_INVALID_REQUEST +// +// MessageText: +// +// The server received an incorrectly formatted request from %2. +// +#define EVENT_SRV_INVALID_REQUEST 0xC00007D6L + +// +// MessageId: EVENT_SRV_CANT_OPEN_NPFS +// +// MessageText: +// +// The server could not open the named pipe file system. Remote named pipes are disabled. +// +#define EVENT_SRV_CANT_OPEN_NPFS 0xC00007D7L + +// +// MessageId: EVENT_SRV_CANT_GROW_TABLE +// +// MessageText: +// +// The server could not expand a table because the table reached the maximum size. +// +#define EVENT_SRV_CANT_GROW_TABLE 0x800007D9L + +// +// MessageId: EVENT_SRV_CANT_START_SCAVENGER +// +// MessageText: +// +// The server could not start the scavenger thread. The server could not be started. +// +#define EVENT_SRV_CANT_START_SCAVENGER 0xC00007DAL + +// +// MessageId: EVENT_SRV_IRP_STACK_SIZE +// +// MessageText: +// +// The server's configuration parameter "irpstacksize" is too small for the server to use a local device. Please increase the value of this parameter. +// +#define EVENT_SRV_IRP_STACK_SIZE 0xC00007DBL + +// +// MessageId: EVENT_SRV_NETWORK_ERROR +// +// MessageText: +// +// While transmitting or receiving data, the server encountered a network error. +// Occasional errors are expected, but large amounts of these indicate a possible +// error in your network configuration. The error status code is contained within +// the returned data (formatted as Words) and may point you towards the problem. +// +#define EVENT_SRV_NETWORK_ERROR 0x800007DCL + +// +// MessageId: EVENT_SRV_DISK_FULL +// +// MessageText: +// +// The %2 disk is at or near capacity. You may need to delete some files. +// +#define EVENT_SRV_DISK_FULL 0x800007DDL + +// +// MessageId: EVENT_SRV_NO_VIRTUAL_MEMORY +// +// MessageText: +// +// The server was unable to allocate virtual memory. +// +#define EVENT_SRV_NO_VIRTUAL_MEMORY 0xC00007E0L + +// +// MessageId: EVENT_SRV_NONPAGED_POOL_LIMIT +// +// MessageText: +// +// The server was unable to allocate from the system nonpaged pool because the server reached the configured limit for nonpaged pool allocations. +// +#define EVENT_SRV_NONPAGED_POOL_LIMIT 0xC00007E1L + +// +// MessageId: EVENT_SRV_PAGED_POOL_LIMIT +// +// MessageText: +// +// The server was unable to allocate from the system paged pool because the server reached the configured limit for paged pool allocations. +// +#define EVENT_SRV_PAGED_POOL_LIMIT 0xC00007E2L + +// +// MessageId: EVENT_SRV_NO_NONPAGED_POOL +// +// MessageText: +// +// The server was unable to allocate from the system nonpaged pool because the pool was empty. +// +#define EVENT_SRV_NO_NONPAGED_POOL 0xC00007E3L + +// +// MessageId: EVENT_SRV_NO_PAGED_POOL +// +// MessageText: +// +// The server was unable to allocate from the system paged pool because the pool was empty. +// +#define EVENT_SRV_NO_PAGED_POOL 0xC00007E4L + +// +// MessageId: EVENT_SRV_NO_WORK_ITEM +// +// MessageText: +// +// The server was unable to allocate a work item %2 times in the last %3 seconds. +// +#define EVENT_SRV_NO_WORK_ITEM 0x800007E5L + +// +// MessageId: EVENT_SRV_NO_FREE_CONNECTIONS +// +// MessageText: +// +// The server was unable to find a free connection %2 times in the last %3 seconds. This indicates a spike in +// network traffic. If this is happening frequently, you should consider increasing the minimum number of free +// connections to add headroom. To do that, modify the MinFreeConnections and MaxFreeConnections for the LanmanServer +// in the registry. +// +#define EVENT_SRV_NO_FREE_CONNECTIONS 0x800007E6L + +// +// MessageId: EVENT_SRV_NO_FREE_RAW_WORK_ITEM +// +// MessageText: +// +// The server was unable to find a free raw work item %2 times in the last %3 seconds. +// +#define EVENT_SRV_NO_FREE_RAW_WORK_ITEM 0x800007E7L + +// +// MessageId: EVENT_SRV_NO_BLOCKING_IO +// +// MessageText: +// +// The server was unable to allocate resources for blocking I/O %2 times in the last %3 seconds. +// +#define EVENT_SRV_NO_BLOCKING_IO 0x800007E8L + +// +// MessageId: EVENT_SRV_DOS_ATTACK_DETECTED +// +// MessageText: +// +// The server has detected an attempted Denial-Of-Service attack from client %2, and has disconnected the connection. +// +#define EVENT_SRV_DOS_ATTACK_DETECTED 0x800007E9L + +// +// MessageId: EVENT_SRV_TOO_MANY_DOS +// +// MessageText: +// +// The server has detected too many Denial-Of-Service attacks and will stop logging +// events for any more of them. Be advised it is likely someone is actively attacking +// your machine. +// +#define EVENT_SRV_TOO_MANY_DOS 0x800007EAL + +// +// MessageId: EVENT_SRV_OUT_OF_WORK_ITEM_DOS +// +// MessageText: +// +// The server has detected a potential Denial-of-Service attack caused by consuming all the work-items. Some connections +// were disconnected to protect against this. If this is not the case, please raise the MaxWorkItems for the server or +// disable DoS detection. This event will not be logged again for 24 hours. +// +#define EVENT_SRV_OUT_OF_WORK_ITEM_DOS 0x800007EBL + + +// Server service events, issued from user mode. %1 is the first +// service-supplied insertion string. + +// +// MessageId: EVENT_SRV_KEY_NOT_FOUND +// +// MessageText: +// +// The server's Registry key %1 was not present. The server could not start. +// +#define EVENT_SRV_KEY_NOT_FOUND 0xC00009C5L + +// +// MessageId: EVENT_SRV_KEY_NOT_CREATED +// +// MessageText: +// +// The server's Registry key %1 was not present and could not be created. The server could not start. +// +#define EVENT_SRV_KEY_NOT_CREATED 0xC00009C6L + +// +// MessageId: EVENT_SRV_NO_TRANSPORTS_BOUND +// +// MessageText: +// +// The server did not bind to any transports. The server could not start. +// +#define EVENT_SRV_NO_TRANSPORTS_BOUND 0xC00009C7L + +// +// MessageId: EVENT_SRV_CANT_BIND_TO_TRANSPORT +// +// MessageText: +// +// The server could not bind to the transport %1. +// +#define EVENT_SRV_CANT_BIND_TO_TRANSPORT 0x800009C8L + +// +// MessageId: EVENT_SRV_CANT_BIND_DUP_NAME +// +// MessageText: +// +// The server could not bind to the transport %1 because another computer on the network has the same name. The server could not start. +// +#define EVENT_SRV_CANT_BIND_DUP_NAME 0xC00009C9L + +// +// MessageId: EVENT_SRV_INVALID_REGISTRY_VALUE +// +// MessageText: +// +// The value named %1 in the server's registry key %2 was not valid, and was ignored. +// If you want to change the value, change it to one that is the correct type and is +// within the acceptable range, or delete the value to use the default. This value +// might have been set up by an older program that did not use the correct boundaries. +// +#define EVENT_SRV_INVALID_REGISTRY_VALUE 0x800009CAL + +// +// MessageId: EVENT_SRV_INVALID_SD +// +// MessageText: +// +// The security descriptor stored in the Registry for the share %1 was invalid. The share was not automatically recreated. +// +#define EVENT_SRV_INVALID_SD 0x800009CBL + +// +// MessageId: EVENT_SRV_CANT_LOAD_DRIVER +// +// MessageText: +// +// The server service was unable to load the server driver. +// +#define EVENT_SRV_CANT_LOAD_DRIVER 0x800009CCL + +// +// MessageId: EVENT_SRV_CANT_UNLOAD_DRIVER +// +// MessageText: +// +// The server service was unable to unload the server driver. +// +#define EVENT_SRV_CANT_UNLOAD_DRIVER 0x800009CDL + +// +// MessageId: EVENT_SRV_CANT_MAP_ERROR +// +// MessageText: +// +// The server service was unable to map error code %1. +// +#define EVENT_SRV_CANT_MAP_ERROR 0x800009CEL + +// +// MessageId: EVENT_SRV_CANT_RECREATE_SHARE +// +// MessageText: +// +// The server service was unable to recreate the share %1 because the directory %2 no longer exists. Please run "net share %1 /delete" to delete the share, or recreate the directory %2. +// +#define EVENT_SRV_CANT_RECREATE_SHARE 0x800009CFL + +// +// MessageId: EVENT_SRV_CANT_CHANGE_DOMAIN_NAME +// +// MessageText: +// +// The server service was unable to change the domain name from %1 to %2. +// +#define EVENT_SRV_CANT_CHANGE_DOMAIN_NAME 0x800009D0L + +// +// MessageId: EVENT_SRV_TXF_INIT_FAILED +// +// MessageText: +// +// The server service was unable to register to the transaction resource manager. Remote transactions will be unavailable. +// +#define EVENT_SRV_TXF_INIT_FAILED 0x800009D1L + + +///////////////////////////////////////////////////////////////////////// +// +// Lanman Redirector Events +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_RDR_RESOURCE_SHORTAGE +// +// MessageText: +// +// The redirector was unable to allocate memory. +// +#define EVENT_RDR_RESOURCE_SHORTAGE 0x80000BB9L + +// +// MessageId: EVENT_RDR_CANT_CREATE_DEVICE +// +// MessageText: +// +// The redirector could not create its device. The redirector could not be started. +// +#define EVENT_RDR_CANT_CREATE_DEVICE 0x80000BBAL + +// +// MessageId: EVENT_RDR_CANT_CREATE_THREAD +// +// MessageText: +// +// The redirector could not create a system thread. +// +#define EVENT_RDR_CANT_CREATE_THREAD 0x80000BBBL + +// +// MessageId: EVENT_RDR_CANT_SET_THREAD +// +// MessageText: +// +// The redirector could not set the priority for a system thread. +// +#define EVENT_RDR_CANT_SET_THREAD 0x80000BBCL + +// +// MessageId: EVENT_RDR_INVALID_REPLY +// +// MessageText: +// +// The redirector received an incorrectly formatted response from %2. +// +#define EVENT_RDR_INVALID_REPLY 0x80000BBDL + +// +// MessageId: EVENT_RDR_INVALID_SMB +// +// MessageText: +// +// The redirector received an SMB that was too short. +// +#define EVENT_RDR_INVALID_SMB 0x80000BBEL + +// +// MessageId: EVENT_RDR_INVALID_LOCK_REPLY +// +// MessageText: +// +// The redirector received an incorrect response from %2 to a lock request. +// +#define EVENT_RDR_INVALID_LOCK_REPLY 0x80000BBFL + +// +// MessageId: EVENT_RDR_FAILED_UNLOCK +// +// MessageText: +// +// The redirector failed to unlock part of a file on server %2. +// +#define EVENT_RDR_FAILED_UNLOCK 0x80000BC1L + +// +// MessageId: EVENT_RDR_CLOSE_BEHIND +// +// MessageText: +// +// The redirector failed to write data to server %2 after the file was closed. +// +#define EVENT_RDR_CLOSE_BEHIND 0x80000BC3L + +// +// MessageId: EVENT_RDR_UNEXPECTED_ERROR +// +// MessageText: +// +// An unexpected network error has occurred on the virtual circuit to %2. +// +#define EVENT_RDR_UNEXPECTED_ERROR 0x80000BC4L + +// +// MessageId: EVENT_RDR_TIMEOUT +// +// MessageText: +// +// The redirector has timed out a request to %2. +// +#define EVENT_RDR_TIMEOUT 0x80000BC5L + +// +// MessageId: EVENT_RDR_INVALID_OPLOCK +// +// MessageText: +// +// The redirector received an invalid oplock level from %2. +// +#define EVENT_RDR_INVALID_OPLOCK 0x80000BC6L + +// +// MessageId: EVENT_RDR_CONNECTION_REFERENCE +// +// MessageText: +// +// The redirector dereferenced a connection through zero. +// +#define EVENT_RDR_CONNECTION_REFERENCE 0x80000BC7L + +// +// MessageId: EVENT_RDR_SERVER_REFERENCE +// +// MessageText: +// +// The redirector dereferenced a server through zero. +// +#define EVENT_RDR_SERVER_REFERENCE 0x80000BC8L + +// +// MessageId: EVENT_RDR_SMB_REFERENCE +// +// MessageText: +// +// The redirector dereferenced the allocated SMB count through zero. +// +#define EVENT_RDR_SMB_REFERENCE 0x80000BC9L + +// +// MessageId: EVENT_RDR_ENCRYPT +// +// MessageText: +// +// The redirector accessed a share-level server that indicates it encrypts passwords. +// This combination is not supported. +// +#define EVENT_RDR_ENCRYPT 0x80000BCAL + +// +// MessageId: EVENT_RDR_CONNECTION +// +// MessageText: +// +// The redirector failed to determine the connection type. +// +#define EVENT_RDR_CONNECTION 0x80000BCBL + +// +// MessageId: EVENT_RDR_MAXCMDS +// +// MessageText: +// +// The redirector failed to allocate a multiplex table entry. This indicates that +// the MAXCMDS parameter to the redirector is insufficient for the users needs. +// +#define EVENT_RDR_MAXCMDS 0x80000BCDL + +// +// MessageId: EVENT_RDR_OPLOCK_SMB +// +// MessageText: +// +// The redirector failed to allocate a buffer for an oplock break. +// +#define EVENT_RDR_OPLOCK_SMB 0x80000BCEL + +// +// MessageId: EVENT_RDR_DISPOSITION +// +// MessageText: +// +// The redirector failed to map the requested file disposition (for NtCreateFile). +// +#define EVENT_RDR_DISPOSITION 0x80000BCFL + +// +// MessageId: EVENT_RDR_CONTEXTS +// +// MessageText: +// +// The redirector is allocating additional resources for input/output request packet contexts. This is +// probably caused by a resource leak in the redirector. +// +#define EVENT_RDR_CONTEXTS 0x80000BD0L + +// +// MessageId: EVENT_RDR_WRITE_BEHIND_FLUSH_FAILED +// +// MessageText: +// +// A write-behind operation has failed to the remote server %2. The data contains the amount requested to write and the amount actually written. +// +#define EVENT_RDR_WRITE_BEHIND_FLUSH_FAILED 0x80000BD1L + +// +// MessageId: EVENT_RDR_AT_THREAD_MAX +// +// MessageText: +// +// The redirector was unable to create a worker thread because it has already created the maximum number of configured work threads. +// +#define EVENT_RDR_AT_THREAD_MAX 0x80000BD2L + +// +// MessageId: EVENT_RDR_CANT_READ_REGISTRY +// +// MessageText: +// +// The redirector was unable to initialize variables from the Registry. +// +#define EVENT_RDR_CANT_READ_REGISTRY 0x80000BD3L + +// +// MessageId: EVENT_RDR_TIMEZONE_BIAS_TOO_LARGE +// +// MessageText: +// +// The time zone bias calculated between %2 and the current workstation is too +// large. The data specifies the number of 100ns units between the workstation +// and server. Make sure that the time of day on the workstation and server are +// correct. +// +#define EVENT_RDR_TIMEZONE_BIAS_TOO_LARGE 0x80000BD4L + +// +// MessageId: EVENT_RDR_PRIMARY_TRANSPORT_CONNECT_FAILED +// +// MessageText: +// +// The redirector has failed to connect to the server %2 on the primary transport. The data contains the error. +// +#define EVENT_RDR_PRIMARY_TRANSPORT_CONNECT_FAILED 0x80000BD5L + +// +// MessageId: EVENT_RDR_DELAYED_SET_ATTRIBUTES_FAILED +// +// MessageText: +// +// The redirector was unable to update the file attributes on a file located on server %2. +// The data contains the name of the file. +// +#define EVENT_RDR_DELAYED_SET_ATTRIBUTES_FAILED 0x80000BD6L + +// +// MessageId: EVENT_RDR_DELETEONCLOSE_FAILED +// +// MessageText: +// +// The redirector was unable to delete the file specified on server %2 when it was closed by the application. +// The data contains the name of the file. +// +#define EVENT_RDR_DELETEONCLOSE_FAILED 0x80000BD7L + +// +// MessageId: EVENT_RDR_CANT_BIND_TRANSPORT +// +// MessageText: +// +// The redirector was unable to register the domain %2 on to transport %3 for the following reason: %4. Transport has been taken offline. +// +#define EVENT_RDR_CANT_BIND_TRANSPORT 0x80000BD8L + +// +// MessageId: EVENT_RDR_CANT_REGISTER_ADDRESS +// +// MessageText: +// +// The redirector was unable to register the address for transport %3 for the following reason: %4. Transport has been taken offline. +// +#define EVENT_RDR_CANT_REGISTER_ADDRESS 0x80000BD9L + +// +// MessageId: EVENT_RDR_CANT_GET_SECURITY_CONTEXT +// +// MessageText: +// +// The redirector was unable to initialize security context or query context attributes. +// +#define EVENT_RDR_CANT_GET_SECURITY_CONTEXT 0x80000BDAL + +// +// MessageId: EVENT_RDR_CANT_BUILD_SMB_HEADER +// +// MessageText: +// +// The redirector was unable to build SMB header. +// +#define EVENT_RDR_CANT_BUILD_SMB_HEADER 0x80000BDBL + +// +// MessageId: EVENT_RDR_SECURITY_SIGNATURE_MISMATCH +// +// MessageText: +// +// The redirector detected a security signature mismatch. The connection has been disconnected. +// +#define EVENT_RDR_SECURITY_SIGNATURE_MISMATCH 0x80000BDCL + + + +///////////////////////////////////////////////////////////////////////// +// +// IPv6 Events +// +// Codes 3100 - 3199 +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_TCPIP6_STARTED +// +// MessageText: +// +// The Microsoft TCP/IP version 6 driver was started. +// +#define EVENT_TCPIP6_STARTED 0x40000C1CL + + + +///////////////////////////////////////////////////////////////////////// +// +// STREAMS Environment Events +// +// Codes 4000 - 4099 +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_STREAMS_STRLOG +// +// MessageText: +// +// %2 +// +#define EVENT_STREAMS_STRLOG 0xC0000FA0L + +// +// MessageId: EVENT_STREAMS_ALLOCB_FAILURE +// +// MessageText: +// +// Unable to allocate a %2 byte message. +// +#define EVENT_STREAMS_ALLOCB_FAILURE 0x80000FA1L + +// +// MessageId: EVENT_STREAMS_ALLOCB_FAILURE_CNT +// +// MessageText: +// +// %2 message allocations have failed since initialization. +// +#define EVENT_STREAMS_ALLOCB_FAILURE_CNT 0x80000FA2L + +// +// MessageId: EVENT_STREAMS_ESBALLOC_FAILURE +// +// MessageText: +// +// Unable to allocate a %2 byte external message. +// +#define EVENT_STREAMS_ESBALLOC_FAILURE 0x80000FA3L + +// +// MessageId: EVENT_STREAMS_ESBALLOC_FAILURE_CNT +// +// MessageText: +// +// %2 external message allocations have failed since initialization. +// +#define EVENT_STREAMS_ESBALLOC_FAILURE_CNT 0x80000FA4L + + + +///////////////////////////////////////////////////////////////////////// +// +// TCP/IP Events +// +// Codes 4100 - 4299 +// +///////////////////////////////////////////////////////////////////////// + + +// +// Common TCP/IP messages +// +// Codes 4100 - 4149 +// +// + +// +// MessageId: EVENT_TCPIP_CREATE_DEVICE_FAILED +// +// MessageText: +// +// Unable to create device object %2. Initialization failed. +// +#define EVENT_TCPIP_CREATE_DEVICE_FAILED 0xC0001004L + +// +// MessageId: EVENT_TCPIP_NO_RESOURCES_FOR_INIT +// +// MessageText: +// +// Unable to allocate required resources. Initialization failed. +// +#define EVENT_TCPIP_NO_RESOURCES_FOR_INIT 0xC0001005L + + +// +// ARP messages +// +// Codes 4150-4174 + + +// +// IP Loopback messages +// +// Codes 4175-4184 +// + + +// +// IP/ICMP messages +// +// Codes 4185 - 4224 + +// +// MessageId: EVENT_TCPIP_TOO_MANY_NETS +// +// MessageText: +// +// IP has been bound to more than the maximum number of supported interfaces. +// Some interfaces on network adapter %2 will not be initialized. +// +#define EVENT_TCPIP_TOO_MANY_NETS 0xC0001059L + +// +// MessageId: EVENT_TCPIP_NO_MASK +// +// MessageText: +// +// No subnet mask was specified for interface %2. This interface and all +// subsequent interfaces on network adapter %3 cannot be initialized. +// +#define EVENT_TCPIP_NO_MASK 0xC000105AL + +// +// MessageId: EVENT_TCPIP_INVALID_ADDRESS +// +// MessageText: +// +// An invalid address %2 was specified for network adapter %3. This interface +// cannot be initialized. +// +#define EVENT_TCPIP_INVALID_ADDRESS 0xC000105BL + +// +// MessageId: EVENT_TCPIP_INVALID_MASK +// +// MessageText: +// +// An invalid subnet mask %2 was specified for address %3 on network adapter %4. +// This interface cannot be initialized. +// +#define EVENT_TCPIP_INVALID_MASK 0xC000105CL + +// +// MessageId: EVENT_TCPIP_NO_ADAPTER_RESOURCES +// +// MessageText: +// +// IP could not allocate some resources required to configure network adapter %2. +// Some interfaces on this network adapter will not be initialized. +// +#define EVENT_TCPIP_NO_ADAPTER_RESOURCES 0xC000105DL + +// +// MessageId: EVENT_TCPIP_DHCP_INIT_FAILED +// +// MessageText: +// +// IP was unable to initialize network adapter %2 for configuration by DHCP. +// If DHCP is enabled on this network adapter, the primary interface may not be +// configured properly. Interfaces on this network adapter not configured by +// DHCP will be unaffected. +// +#define EVENT_TCPIP_DHCP_INIT_FAILED 0x8000105EL + +// +// MessageId: EVENT_TCPIP_ADAPTER_REG_FAILURE +// +// MessageText: +// +// IP could not open the registry key for network adapter %2. +// Interfaces on this network adapter will not be initialized. +// +#define EVENT_TCPIP_ADAPTER_REG_FAILURE 0xC000105FL + +// +// MessageId: EVENT_TCPIP_INVALID_DEFAULT_GATEWAY +// +// MessageText: +// +// Invalid default gateway address %2 was specified for network adapter %3. +// Some remote networks may not be reachable as a result. +// +#define EVENT_TCPIP_INVALID_DEFAULT_GATEWAY 0x80001060L + +// +// MessageId: EVENT_TCPIP_NO_ADDRESS_LIST +// +// MessageText: +// +// Unable to read the configured IP addresses for network adapter %2. +// IP interfaces will not be initialized on this network adapter. +// +#define EVENT_TCPIP_NO_ADDRESS_LIST 0xC0001061L + +// +// MessageId: EVENT_TCPIP_NO_MASK_LIST +// +// MessageText: +// +// Unable to read the configured subnet masks for network adapter %2. +// IP interfaces will not be initialized on this network adapter. +// +#define EVENT_TCPIP_NO_MASK_LIST 0xC0001062L + +// +// MessageId: EVENT_TCPIP_NO_BINDINGS +// +// MessageText: +// +// IP was unable to read its bindings from the registry. No network interfaces +// were configured. +// +#define EVENT_TCPIP_NO_BINDINGS 0xC0001063L + +// +// MessageId: EVENT_TCPIP_IP_INIT_FAILED +// +// MessageText: +// +// Initialization of IP failed. +// +#define EVENT_TCPIP_IP_INIT_FAILED 0xC0001064L + +// +// MessageId: EVENT_TCPIP_TOO_MANY_GATEWAYS +// +// MessageText: +// +// More than the maximum number of default gateways were specified for +// network adapter %2. Some remote networks may not be reachable as a result. +// +#define EVENT_TCPIP_TOO_MANY_GATEWAYS 0x80001065L + +// +// MessageId: EVENT_TCPIP_ADDRESS_CONFLICT1 +// +// MessageText: +// +// The system detected an address conflict for IP address %2 with the system +// having network hardware address %3. The local interface has been disabled. +// +#define EVENT_TCPIP_ADDRESS_CONFLICT1 0xC0001066L + +// +// MessageId: EVENT_TCPIP_ADDRESS_CONFLICT2 +// +// MessageText: +// +// The system detected an address conflict for IP address %2 with the system +// having network hardware address %3. Network operations on this system may +// be disrupted as a result. +// +#define EVENT_TCPIP_ADDRESS_CONFLICT2 0xC0001067L + +// +// MessageId: EVENT_TCPIP_NTE_CONTEXT_LIST_FAILURE +// +// MessageText: +// +// Unable to read or write the NTE Context list for network adapter %2. +// IP interfaces on this network adapter may not be initialized completely. +// +#define EVENT_TCPIP_NTE_CONTEXT_LIST_FAILURE 0xC0001068L + +// +// MessageId: EVENT_TCPIP_MEDIA_CONNECT +// +// MessageText: +// +// The system detected that network adapter %2 was connected to the network, +// and has initiated normal operation. +// +#define EVENT_TCPIP_MEDIA_CONNECT 0x40001069L + +// +// MessageId: EVENT_TCPIP_MEDIA_DISCONNECT +// +// MessageText: +// +// The system detected that network adapter %2 was disconnected from the network +// and its network configuration has been released. If the network adapter was +// not disconnected, this may indicate that it has malfunctioned. +// Try updating the driver for the network adapter. +// +#define EVENT_TCPIP_MEDIA_DISCONNECT 0x4000106AL + +// +// MessageId: EVENT_TCPIP_IPV4_UNINSTALLED +// +// MessageText: +// +// The system detected that IPv4 is not installed. This may cause some +// networking services to fail to start, or to malfunction. To install IPv4, use +// "netsh interface ipv4 install". +// +#define EVENT_TCPIP_IPV4_UNINSTALLED 0x4000106BL + +// +// MessageId: EVENT_TCPIP_AUTOCONFIGURED_ADDRESS_LIMIT_REACHED +// +// MessageText: +// +// Autoconfigured address limit has been reached. No further autoconfigured addresses will be added until the interface is reconnected. +// +#define EVENT_TCPIP_AUTOCONFIGURED_ADDRESS_LIMIT_REACHED 0x8000106CL + +// +// MessageId: EVENT_TCPIP_AUTOCONFIGURED_ROUTE_LIMIT_REACHED +// +// MessageText: +// +// Autoconfigured route limit has been reached. No further autoconfigured routes will be added until the interface is reconnected. +// +#define EVENT_TCPIP_AUTOCONFIGURED_ROUTE_LIMIT_REACHED 0x8000106DL + +// +// MessageId: EVENT_TCPIP_OUT_OF_ORDER_FRAGMENTS_EXCEEDED +// +// MessageText: +// +// More than the supported number of out of order IP fragments were received. One or +// more fragmented IP packets were dropped as a result. +// +#define EVENT_TCPIP_OUT_OF_ORDER_FRAGMENTS_EXCEEDED 0x8000106EL + +// +// MessageId: EVENT_TCPIP_INTERFACE_BIND_FAILURE +// +// MessageText: +// +// The %2 TCP/IP interface with index %3 failed to bind to its provider. +// +#define EVENT_TCPIP_INTERFACE_BIND_FAILURE 0xC000106FL + + +// +// TCP messages +// +// Codes 4225 - 4264 +// + +// +// MessageId: EVENT_TCPIP_TCP_INIT_FAILED +// +// MessageText: +// +// Initialization of TCP/UDP failed. +// +#define EVENT_TCPIP_TCP_INIT_FAILED 0xC0001081L + +// +// MessageId: EVENT_TCPIP_TCP_CONNECT_LIMIT_REACHED +// +// MessageText: +// +// TCP/IP has reached the security limit imposed on the number of concurrent TCP connect attempts. +// +#define EVENT_TCPIP_TCP_CONNECT_LIMIT_REACHED 0x80001082L + +// +// MessageId: EVENT_TCPIP_TCP_TIME_WAIT_COLLISION +// +// MessageText: +// +// TCP/IP failed to establish an outgoing connection because the selected local endpoint +// was recently used to connect to the same remote endpoint. This error typically occurs +// when outgoing connections are opened and closed at a high rate, causing all available +// local ports to be used and forcing TCP/IP to reuse a local port for an outgoing connection. +// To minimize the risk of data corruption, the TCP/IP standard requires a minimum time period +// to elapse between successive connections from a given local endpoint to a given remote endpoint. +// +#define EVENT_TCPIP_TCP_TIME_WAIT_COLLISION 0x80001083L + +// +// MessageId: EVENT_TCPIP_TCP_WSD_WS_RESTRICTED +// +// MessageText: +// +// TCP/IP has chosen to restrict the scale factor due to a network condition. +// This could be related to a problem in a network device and will cause +// degraded throughput. +// +#define EVENT_TCPIP_TCP_WSD_WS_RESTRICTED 0x80001084L + +// +// MessageId: EVENT_TCPIP_TCP_MPP_ATTACKS_DETECTED +// +// MessageText: +// +// TCP/IP has detected high memory utilization and has terminated some existing connections to +// maintain system stability. +// +#define EVENT_TCPIP_TCP_MPP_ATTACKS_DETECTED 0x80001085L + +// +// MessageId: EVENT_TCPIP_TCP_CONNECTIONS_PERF_IMPACTED +// +// MessageText: +// +// TCP/IP has chosen to restrict the congestion window for several connections due to a network condition. +// This could be related to a problem in the TCP global or supplemental configuration and will cause +// degraded throughput. +// +#define EVENT_TCPIP_TCP_CONNECTIONS_PERF_IMPACTED 0x80001086L + +// +// MessageId: EVENT_TCPIP_TCP_GLOBAL_EPHEMERAL_PORT_SPACE_EXHAUSTED +// +// MessageText: +// +// A request to allocate an ephemeral port number from the global TCP port space has failed due to all such ports being in use. +// +#define EVENT_TCPIP_TCP_GLOBAL_EPHEMERAL_PORT_SPACE_EXHAUSTED 0x80001087L + + +// +// UDP messages +// +// Codes 4265 - 4280 +// + +// +// MessageId: EVENT_TCPIP_UDP_LIMIT_REACHED +// +// MessageText: +// +// Backlog of pending datagram sends reached. Please increase the value of Tcpip\Parameters\DGMaxSendFree in the registry. +// +#define EVENT_TCPIP_UDP_LIMIT_REACHED 0x800010A9L + +// +// MessageId: EVENT_TCPIP_UDP_GLOBAL_EPHEMERAL_PORT_SPACE_EXHAUSTED +// +// MessageText: +// +// A request to allocate an ephemeral port number from the global UDP port space has failed due to all such ports being in use. +// +#define EVENT_TCPIP_UDP_GLOBAL_EPHEMERAL_PORT_SPACE_EXHAUSTED 0x800010AAL + + +// +// Packet Coalesing Filter messages +// +// Codes 4290 - 4299 +// + +// +// MessageId: EVENT_TCPIP_PCF_MULTICAST_OID_ISSUE +// +// MessageText: +// +// Multicast address list could not be set on the network adapter with hardware address %2 (%3 %4 %5 %6). +// +#define EVENT_TCPIP_PCF_MULTICAST_OID_ISSUE 0x800010C2L + +// +// MessageId: EVENT_TCPIP_PCF_MISSING_CAPABILITY +// +// MessageText: +// +// The network adapter with hardware address %2 has indicated packet coalescing capability +// without indicating support for one or more prerequisite receive filter capabilities (%3 %4). +// +#define EVENT_TCPIP_PCF_MISSING_CAPABILITY 0x800010C3L + +// +// MessageId: EVENT_TCPIP_PCF_SET_FILTER_FAILURE +// +// MessageText: +// +// An attempt to set a packet coalescing filter on the network adapter with hardware address %2 has failed (%3 %4 %5). +// +#define EVENT_TCPIP_PCF_SET_FILTER_FAILURE 0x800010C4L + +// +// MessageId: EVENT_TCPIP_PCF_NO_ARP_FILTER +// +// MessageText: +// +// The ARP packet coalescing filter on the network adapter with hardware address %2 is not set +// since more than one IPv4 address is currently assigned to the adapter. An ARP packet coalescing +// filter may be set later when only one IPv4 address is assigned to this adapter (%3 %4). +// +#define EVENT_TCPIP_PCF_NO_ARP_FILTER 0x800010C5L + +// +// MessageId: EVENT_TCPIP_PCF_CLEAR_FILTER_FAILURE +// +// MessageText: +// +// An attempt to clear a packet coalescing filter on the network adapter with hardware address %2 has failed (%3 %4 %5). +// +#define EVENT_TCPIP_PCF_CLEAR_FILTER_FAILURE 0xC00010C6L + + + +///////////////////////////////////////////////////////////////////////// +// +// NBT Events +// +// Codes 4300 - 4399 +// +///////////////////////////////////////////////////////////////////////// + + + +// Don't use %1 for driver supplied insertion strings. The IO subsystem +// supplies the first string!! + +// +// MessageId: EVENT_NBT_CREATE_DRIVER +// +// MessageText: +// +// The driver could not be created. +// +#define EVENT_NBT_CREATE_DRIVER 0xC00010CCL + +// +// MessageId: EVENT_NBT_OPEN_REG_PARAMS +// +// MessageText: +// +// Unable to open the Registry Parameters to read configuration information. +// +#define EVENT_NBT_OPEN_REG_PARAMS 0xC00010CDL + +// +// MessageId: EVENT_NBT_NO_BACKUP_WINS +// +// MessageText: +// +// The backup WINS server address is not configured in the registry. +// +#define EVENT_NBT_NO_BACKUP_WINS 0x800010CEL + +// +// MessageId: EVENT_NBT_NO_WINS +// +// MessageText: +// +// The primary WINS server address is not configured in the registry. +// +#define EVENT_NBT_NO_WINS 0x800010CFL + +// +// MessageId: EVENT_NBT_BAD_BACKUP_WINS_ADDR +// +// MessageText: +// +// The backup WINS server address is not formated correctly in the registry. +// +#define EVENT_NBT_BAD_BACKUP_WINS_ADDR 0x800010D0L + +// +// MessageId: EVENT_NBT_BAD_PRIMARY_WINS_ADDR +// +// MessageText: +// +// The primary WINS server address is not formatted correctly in the registry. +// +#define EVENT_NBT_BAD_PRIMARY_WINS_ADDR 0x800010D1L + +// +// MessageId: EVENT_NBT_NAME_SERVER_ADDRS +// +// MessageText: +// +// Unable to configure the addresses of the WINS servers. +// +#define EVENT_NBT_NAME_SERVER_ADDRS 0xC00010D2L + +// +// MessageId: EVENT_NBT_CREATE_ADDRESS +// +// MessageText: +// +// Initialization failed because the transport refused to open initial addresses. +// +#define EVENT_NBT_CREATE_ADDRESS 0xC00010D3L + +// +// MessageId: EVENT_NBT_CREATE_CONNECTION +// +// MessageText: +// +// Initialization failed because the transport refused to open initial connections. +// +#define EVENT_NBT_CREATE_CONNECTION 0xC00010D4L + +// +// MessageId: EVENT_NBT_NON_OS_INIT +// +// MessageText: +// +// Data structure initialization failed. +// +#define EVENT_NBT_NON_OS_INIT 0xC00010D5L + +// +// MessageId: EVENT_NBT_TIMERS +// +// MessageText: +// +// Initialization failed because the timers could not be started. +// +#define EVENT_NBT_TIMERS 0xC00010D6L + +// +// MessageId: EVENT_NBT_CREATE_DEVICE +// +// MessageText: +// +// Initialization failed because the driver device could not be created. +// Use the string "%2" to identify the interface for which initialization +// failed. It represents the MAC address of the failed interface or the +// Globally Unique Interface Identifier (GUID) if NetBT was unable to +// map from GUID to MAC address. If neither the MAC address nor the GUID were +// available, the string represents a cluster device name. +// +// +#define EVENT_NBT_CREATE_DEVICE 0x400010D7L + +// +// MessageId: EVENT_NBT_NO_DEVICES +// +// MessageText: +// +// There are no network adapters configured for this protocol stack. +// +#define EVENT_NBT_NO_DEVICES 0x800010D8L + +// +// MessageId: EVENT_NBT_OPEN_REG_LINKAGE +// +// MessageText: +// +// Unable to open the Registry Linkage to read configuration information. +// +#define EVENT_NBT_OPEN_REG_LINKAGE 0xC00010D9L + +// +// MessageId: EVENT_NBT_READ_BIND +// +// MessageText: +// +// Unable to read the driver's bindings to the transport from the registry. +// +#define EVENT_NBT_READ_BIND 0xC00010DAL + +// +// MessageId: EVENT_NBT_READ_EXPORT +// +// MessageText: +// +// Unable to read the driver's exported linkage configuration information. +// +#define EVENT_NBT_READ_EXPORT 0xC00010DBL + +// +// MessageId: EVENT_NBT_OPEN_REG_NAMESERVER +// +// MessageText: +// +// Unable to open the registry to read the WINS server addresses. +// +#define EVENT_NBT_OPEN_REG_NAMESERVER 0x800010DCL + +// +// MessageId: EVENT_SCOPE_LABEL_TOO_LONG +// +// MessageText: +// +// The Netbios Name Scope has a component longer than 63 characters. Each label +// in the Scope cannot be longer than 63 bytes. +// +#define EVENT_SCOPE_LABEL_TOO_LONG 0x800010DDL + +// +// MessageId: EVENT_SCOPE_TOO_LONG +// +// MessageText: +// +// The Netbios Name Scope is too long. The scope cannot be longer than +// 255 bytes. +// +#define EVENT_SCOPE_TOO_LONG 0x800010DEL + +// +// MessageId: EVENT_NBT_DUPLICATE_NAME +// +// MessageText: +// +// A duplicate name has been detected on the TCP network. The IP address of +// the computer that sent the message is in the data. Use nbtstat -n in a +// command window to see which name is in the Conflict state. +// +#define EVENT_NBT_DUPLICATE_NAME 0xC00010DFL + +// +// MessageId: EVENT_NBT_NAME_RELEASE +// +// MessageText: +// +// Another computer has sent a name release message to this computer, probably +// because a duplicate name has been detected on the TCP network. The IP address +// of the node that sent the message is in the data. Use nbtstat -n in a +// command window to see which name is in the Conflict state. +// +#define EVENT_NBT_NAME_RELEASE 0xC00010E0L + +// +// MessageId: EVENT_NBT_DUPLICATE_NAME_ERROR +// +// MessageText: +// +// The name "%2" could not be registered on the interface with IP address %3. +// The computer with the IP address %4 did not allow the name to be claimed by +// this computer. +// +#define EVENT_NBT_DUPLICATE_NAME_ERROR 0xC00010E1L + +// +// MessageId: EVENT_NBT_NO_RESOURCES +// +// MessageText: +// +// NetBT failed to process a request because it encountered OutOfResources +// exception(s) in the last 1 hour. +// +#define EVENT_NBT_NO_RESOURCES 0xC00010E2L + + +///////////////////////////////////////////////////////////////////////// +// +// NDIS Environment Events +// +// Codes 5000 - 5099 +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_NDIS_RESOURCE_CONFLICT +// +// MessageText: +// +// %2 : Has encountered a conflict in resources and could not load. +// +#define EVENT_NDIS_RESOURCE_CONFLICT 0xC0001388L + +// +// MessageId: EVENT_NDIS_OUT_OF_RESOURCE +// +// MessageText: +// +// %2 : Could not allocate the resources necessary for operation. +// +#define EVENT_NDIS_OUT_OF_RESOURCE 0xC0001389L + +// +// MessageId: EVENT_NDIS_HARDWARE_FAILURE +// +// MessageText: +// +// %2 : Has determined that the network adapter is not functioning properly. +// +#define EVENT_NDIS_HARDWARE_FAILURE 0xC000138AL + +// +// MessageId: EVENT_NDIS_ADAPTER_NOT_FOUND +// +// MessageText: +// +// %2 : Could not find a network adapter. +// +#define EVENT_NDIS_ADAPTER_NOT_FOUND 0xC000138BL + +// +// MessageId: EVENT_NDIS_INTERRUPT_CONNECT +// +// MessageText: +// +// %2 : Could not connect to the interrupt number supplied. +// +#define EVENT_NDIS_INTERRUPT_CONNECT 0xC000138CL + +// +// MessageId: EVENT_NDIS_DRIVER_FAILURE +// +// MessageText: +// +// %2 : Has encountered an internal error and has failed. +// +#define EVENT_NDIS_DRIVER_FAILURE 0xC000138DL + +// +// MessageId: EVENT_NDIS_BAD_VERSION +// +// MessageText: +// +// %2 : The version number is incorrect for this driver. +// +#define EVENT_NDIS_BAD_VERSION 0xC000138EL + +// +// MessageId: EVENT_NDIS_TIMEOUT +// +// MessageText: +// +// %2 : Timed out during an operation. +// +#define EVENT_NDIS_TIMEOUT 0x8000138FL + +// +// MessageId: EVENT_NDIS_NETWORK_ADDRESS +// +// MessageText: +// +// %2 : Has encountered an invalid network address. +// +#define EVENT_NDIS_NETWORK_ADDRESS 0xC0001390L + +// +// MessageId: EVENT_NDIS_UNSUPPORTED_CONFIGURATION +// +// MessageText: +// +// %2 : Does not support the configuration supplied. +// +#define EVENT_NDIS_UNSUPPORTED_CONFIGURATION 0xC0001391L + +// +// MessageId: EVENT_NDIS_INVALID_VALUE_FROM_ADAPTER +// +// MessageText: +// +// %2 : The network adapter has returned an invalid value to the driver. +// +#define EVENT_NDIS_INVALID_VALUE_FROM_ADAPTER 0xC0001392L + +// +// MessageId: EVENT_NDIS_MISSING_CONFIGURATION_PARAMETER +// +// MessageText: +// +// %2 : A required parameter is missing from the registry. +// +#define EVENT_NDIS_MISSING_CONFIGURATION_PARAMETER 0xC0001393L + +// +// MessageId: EVENT_NDIS_BAD_IO_BASE_ADDRESS +// +// MessageText: +// +// %2 : The I/O base address supplied does not match the jumpers on the adapter. +// +#define EVENT_NDIS_BAD_IO_BASE_ADDRESS 0xC0001394L + +// +// MessageId: EVENT_NDIS_RECEIVE_SPACE_SMALL +// +// MessageText: +// +// %2 : The adapter is configured such that the receive space is smaller than +// the maximum packet size. Some packets may be lost. +// +#define EVENT_NDIS_RECEIVE_SPACE_SMALL 0x40001395L + +// +// MessageId: EVENT_NDIS_ADAPTER_DISABLED +// +// MessageText: +// +// %2 : The driver cannot function because the network adapter is disabled. +// +#define EVENT_NDIS_ADAPTER_DISABLED 0x80001396L + +// +// MessageId: EVENT_NDIS_IO_PORT_CONFLICT +// +// MessageText: +// +// %2 : There is an I/O port conflict. +// +#define EVENT_NDIS_IO_PORT_CONFLICT 0x80001397L + +// +// MessageId: EVENT_NDIS_PORT_OR_DMA_CONFLICT +// +// MessageText: +// +// %2 : There is an I/O port or DMA channel conflict. +// +#define EVENT_NDIS_PORT_OR_DMA_CONFLICT 0x80001398L + +// +// MessageId: EVENT_NDIS_MEMORY_CONFLICT +// +// MessageText: +// +// %2 : There is a memory conflict at address 0x%3. +// +#define EVENT_NDIS_MEMORY_CONFLICT 0x80001399L + +// +// MessageId: EVENT_NDIS_INTERRUPT_CONFLICT +// +// MessageText: +// +// %2 : There is a interrupt conflict at Interrupt %3. +// +#define EVENT_NDIS_INTERRUPT_CONFLICT 0x8000139AL + +// +// MessageId: EVENT_NDIS_DMA_CONFLICT +// +// MessageText: +// +// %2 : There is a resource conflict at DMA channel %3. +// +#define EVENT_NDIS_DMA_CONFLICT 0x8000139BL + +// +// MessageId: EVENT_NDIS_INVALID_DOWNLOAD_FILE_ERROR +// +// MessageText: +// +// %2 : The download file is invalid. The driver is unable to load. +// +#define EVENT_NDIS_INVALID_DOWNLOAD_FILE_ERROR 0xC000139CL + +// +// MessageId: EVENT_NDIS_MAXRECEIVES_ERROR +// +// MessageText: +// +// %2 : The specified registry entry MaxReceives is out of range. Using +// default value. +// +#define EVENT_NDIS_MAXRECEIVES_ERROR 0x8000139DL + +// +// MessageId: EVENT_NDIS_MAXTRANSMITS_ERROR +// +// MessageText: +// +// %2 : The specified registry entry MaxTransmits is out of range. Using +// default value +// +#define EVENT_NDIS_MAXTRANSMITS_ERROR 0x8000139EL + +// +// MessageId: EVENT_NDIS_MAXFRAMESIZE_ERROR +// +// MessageText: +// +// %2 : The specified registry entry MaxFrameSize is out of range. Using +// default value. +// +#define EVENT_NDIS_MAXFRAMESIZE_ERROR 0x8000139FL + +// +// MessageId: EVENT_NDIS_MAXINTERNALBUFS_ERROR +// +// MessageText: +// +// %2 : The specified registry entry MaxInternalBufs is out of range. Using +// default value. +// +#define EVENT_NDIS_MAXINTERNALBUFS_ERROR 0x800013A0L + +// +// MessageId: EVENT_NDIS_MAXMULTICAST_ERROR +// +// MessageText: +// +// %2 : The specified registry entry MaxMulticast is out of range. Using +// default value. +// +#define EVENT_NDIS_MAXMULTICAST_ERROR 0x800013A1L + +// +// MessageId: EVENT_NDIS_PRODUCTID_ERROR +// +// MessageText: +// +// %2 : The specified registry entry ProductId is out of range. Using +// default value. +// +#define EVENT_NDIS_PRODUCTID_ERROR 0x800013A2L + +// +// MessageId: EVENT_NDIS_LOBE_FAILUE_ERROR +// +// MessageText: +// +// %2 : A Token Ring Lobe Wire Fault has occurred. Verify cable connections. +// The network adapter will continue to try to reinsert into the ring. +// +#define EVENT_NDIS_LOBE_FAILUE_ERROR 0x800013A3L + +// +// MessageId: EVENT_NDIS_SIGNAL_LOSS_ERROR +// +// MessageText: +// +// %2 : The adapter had detected a loss of signal on the ring. The adapter +// will continue to try to reinsert back into the ring. +// +#define EVENT_NDIS_SIGNAL_LOSS_ERROR 0x800013A4L + +// +// MessageId: EVENT_NDIS_REMOVE_RECEIVED_ERROR +// +// MessageText: +// +// %2 : The adapter has received a request to deinsert from the +// ring. The adapter will continue to try to reinsert back into the ring. +// +#define EVENT_NDIS_REMOVE_RECEIVED_ERROR 0x800013A5L + +// +// MessageId: EVENT_NDIS_TOKEN_RING_CORRECTION +// +// MessageText: +// +// %2 : The network adapter has successfully reinserted into the ring. +// +#define EVENT_NDIS_TOKEN_RING_CORRECTION 0x400013A6L + +// +// MessageId: EVENT_NDIS_ADAPTER_CHECK_ERROR +// +// MessageText: +// +// %2 : The network adapter has detected an Adapter Check as a result of +// an unrecoverable hardware or software error. +// +#define EVENT_NDIS_ADAPTER_CHECK_ERROR 0xC00013A7L + +// +// MessageId: EVENT_NDIS_RESET_FAILURE_ERROR +// +// MessageText: +// +// %2 : The network adapter failed to reset within a specified time, which could +// be caused by a hardware failure. The network adapter will continue to try to reset. +// +#define EVENT_NDIS_RESET_FAILURE_ERROR 0x800013A8L + +// +// MessageId: EVENT_NDIS_CABLE_DISCONNECTED_ERROR +// +// MessageText: +// +// %2 : The network adapter has detected that the token ring cable is disconnected +// from the network adapter. Please reconnect the cable. +// +#define EVENT_NDIS_CABLE_DISCONNECTED_ERROR 0x800013A9L + +// +// MessageId: EVENT_NDIS_RESET_FAILURE_CORRECTION +// +// MessageText: +// +// %2 : The network adapter has successfully completed a previously failed reset. +// +#define EVENT_NDIS_RESET_FAILURE_CORRECTION 0x800013AAL + + +///////////////////////////////////////////////////////////////////////// +// +// General NT System Events +// +///////////////////////////////////////////////////////////////////////// + +// +// Eventlog Events 6000 - 6099 +// +// +// MessageId: EVENT_EventlogStarted +// +// MessageText: +// +// The Event log service was started. +// +#define EVENT_EventlogStarted 0x80001775L + +// +// MessageId: EVENT_EventlogStopped +// +// MessageText: +// +// The Event log service was stopped. +// +#define EVENT_EventlogStopped 0x80001776L + +// +// MessageId: EVENT_EventlogAbnormalShutdown +// +// MessageText: +// +// The previous system shutdown at %1 on %2 was unexpected. +// +#define EVENT_EventlogAbnormalShutdown 0x80001778L + +// +// MessageId: EVENT_EventLogProductInfo +// +// MessageText: +// +// Microsoft (R) Windows (R) %1 %2 %3 %4. +// +#define EVENT_EventLogProductInfo 0x80001779L + +// +// MessageId: EVENT_ComputerNameChange +// +// MessageText: +// +// The NetBIOS name and DNS host name of this machine have been changed from %1 to %2. +// +#define EVENT_ComputerNameChange 0x8000177BL + +// +// MessageId: EVENT_DNSDomainNameChange +// +// MessageText: +// +// The DNS domain assigned to this computer has been changed from %1 to %2. +// +#define EVENT_DNSDomainNameChange 0x8000177CL + +// +// MessageId: EVENT_EventlogUptime +// +// MessageText: +// +// The system uptime is %5 seconds. +// +#define EVENT_EventlogUptime 0x8000177DL + +// +// System Events 6100 - 6199 +// +// +// MessageId: EVENT_UP_DRIVER_ON_MP +// +// MessageText: +// +// A uniprocessor-specific driver was loaded on a multiprocessor system. The driver could not load. +// +#define EVENT_UP_DRIVER_ON_MP 0xC00017D4L + +// +// Service Controller Events 7000 - 7899 +// +// IMPORTANT NOTE: Do not add any new Vista+ SCM events in netevent.mc, please add those to base\screg\sc\manifests\services.man which contains +// Crimson-friendly event definitions. The SCM events defined here are not used by the eventvwr MMC snapin but continue to remain here due to +// few components depending on the definition (test code, tools code, etc.) +// +// +// MessageId: EVENT_SERVICE_START_FAILED +// +// MessageText: +// +// The %1 service failed to start due to the following error: %n%2 +// +#define EVENT_SERVICE_START_FAILED 0xC0001B58L + +// +// MessageId: EVENT_SERVICE_START_FAILED_II +// +// MessageText: +// +// The %1 service depends on the %2 service which failed to start because of the following error: %n%3 +// +#define EVENT_SERVICE_START_FAILED_II 0xC0001B59L + +// +// MessageId: EVENT_SERVICE_START_FAILED_GROUP +// +// MessageText: +// +// The %1 service depends on the %2 group and no member of this group started. +// +#define EVENT_SERVICE_START_FAILED_GROUP 0xC0001B5AL + +// +// MessageId: EVENT_SERVICE_START_FAILED_NONE +// +// MessageText: +// +// The %1 service depends on the following nonexistent service: %2 +// +#define EVENT_SERVICE_START_FAILED_NONE 0xC0001B5BL + +// +// MessageId: EVENT_CALL_TO_FUNCTION_FAILED +// +// MessageText: +// +// The %1 call failed with the following error: %n%2 +// +#define EVENT_CALL_TO_FUNCTION_FAILED 0xC0001B5DL + +// +// MessageId: EVENT_CALL_TO_FUNCTION_FAILED_II +// +// MessageText: +// +// The %1 call failed for %2 with the following error: %n%3 +// +#define EVENT_CALL_TO_FUNCTION_FAILED_II 0xC0001B5EL + +// +// MessageId: EVENT_REVERTED_TO_LASTKNOWNGOOD +// +// MessageText: +// +// The system reverted to its last known good configuration. The system is restarting.... +// +#define EVENT_REVERTED_TO_LASTKNOWNGOOD 0xC0001B5FL + +// +// MessageId: EVENT_BAD_ACCOUNT_NAME +// +// MessageText: +// +// No backslash is in the account name. +// +#define EVENT_BAD_ACCOUNT_NAME 0xC0001B60L + +// +// MessageId: EVENT_CONNECTION_TIMEOUT +// +// MessageText: +// +// Timeout (%1 milliseconds) waiting for the %2 service to connect. +// +#define EVENT_CONNECTION_TIMEOUT 0xC0001B61L + +// +// MessageId: EVENT_READFILE_TIMEOUT +// +// MessageText: +// +// Timeout (%1 milliseconds) waiting for ReadFile. +// +#define EVENT_READFILE_TIMEOUT 0xC0001B62L + +// +// MessageId: EVENT_TRANSACT_TIMEOUT +// +// MessageText: +// +// Timeout (%1 milliseconds) waiting for a transaction response from the %2 service. +// +#define EVENT_TRANSACT_TIMEOUT 0xC0001B63L + +// +// MessageId: EVENT_TRANSACT_INVALID +// +// MessageText: +// +// Message returned in transaction has incorrect size. +// +#define EVENT_TRANSACT_INVALID 0xC0001B64L + +// +// MessageId: EVENT_FIRST_LOGON_FAILED +// +// MessageText: +// +// Logon attempt with current password failed with the following error: %n%1 +// +#define EVENT_FIRST_LOGON_FAILED 0xC0001B65L + +// +// MessageId: EVENT_SECOND_LOGON_FAILED +// +// MessageText: +// +// Second logon attempt with old password also failed with the following error: %n%1 +// +#define EVENT_SECOND_LOGON_FAILED 0xC0001B66L + +// +// MessageId: EVENT_INVALID_DRIVER_DEPENDENCY +// +// MessageText: +// +// Boot-start or system-start driver (%1) must not depend on a service. +// +#define EVENT_INVALID_DRIVER_DEPENDENCY 0xC0001B67L + +// +// MessageId: EVENT_BAD_SERVICE_STATE +// +// MessageText: +// +// The %1 service has reported an invalid current state %2. +// +#define EVENT_BAD_SERVICE_STATE 0xC0001B68L + +// +// MessageId: EVENT_CIRCULAR_DEPENDENCY_DEMAND +// +// MessageText: +// +// Detected circular dependencies demand starting %1. +// +#define EVENT_CIRCULAR_DEPENDENCY_DEMAND 0xC0001B69L + +// +// MessageId: EVENT_CIRCULAR_DEPENDENCY_AUTO +// +// MessageText: +// +// Detected circular dependencies auto-starting services. +// +#define EVENT_CIRCULAR_DEPENDENCY_AUTO 0xC0001B6AL + +// +// MessageId: EVENT_DEPEND_ON_LATER_SERVICE +// +// MessageText: +// +// Circular dependency: The %1 service depends on a service in a group which starts later. +// +#define EVENT_DEPEND_ON_LATER_SERVICE 0xC0001B6BL + +// +// MessageId: EVENT_DEPEND_ON_LATER_GROUP +// +// MessageText: +// +// Circular dependency: The %1 service depends on a group which starts later. +// +#define EVENT_DEPEND_ON_LATER_GROUP 0xC0001B6CL + +// +// MessageId: EVENT_SEVERE_SERVICE_FAILED +// +// MessageText: +// +// About to revert to the last known good configuration because the %1 service failed to start. +// +#define EVENT_SEVERE_SERVICE_FAILED 0xC0001B6DL + +// +// MessageId: EVENT_SERVICE_START_HUNG +// +// MessageText: +// +// The %1 service hung on starting. +// +#define EVENT_SERVICE_START_HUNG 0xC0001B6EL + +// +// MessageId: EVENT_SERVICE_EXIT_FAILED +// +// MessageText: +// +// The %1 service terminated with the following error: %n%2 +// +#define EVENT_SERVICE_EXIT_FAILED 0xC0001B6FL + +// +// MessageId: EVENT_SERVICE_EXIT_FAILED_SPECIFIC +// +// MessageText: +// +// The %1 service terminated with service-specific error %2. +// +#define EVENT_SERVICE_EXIT_FAILED_SPECIFIC 0xC0001B70L + +// +// MessageId: EVENT_SERVICE_START_AT_BOOT_FAILED +// +// MessageText: +// +// At least one service or driver failed during system startup. Use Event Viewer to examine the event log for details. +// +#define EVENT_SERVICE_START_AT_BOOT_FAILED 0xC0001B71L + +// +// MessageId: EVENT_BOOT_SYSTEM_DRIVERS_FAILED +// +// MessageText: +// +// The following boot-start or system-start driver(s) failed to load: %1 +// +#define EVENT_BOOT_SYSTEM_DRIVERS_FAILED 0xC0001B72L + +// +// MessageId: EVENT_RUNNING_LASTKNOWNGOOD +// +// MessageText: +// +// Windows could not be started as configured. A previous working configuration was used instead. +// +#define EVENT_RUNNING_LASTKNOWNGOOD 0xC0001B73L + +// +// MessageId: EVENT_TAKE_OWNERSHIP +// +// MessageText: +// +// The %1 Registry key denied access to SYSTEM account programs so the Service Control Manager took ownership of the Registry key. +// +#define EVENT_TAKE_OWNERSHIP 0xC0001B74L + +// +// This Text is used as a title for the message box used to display +// MessageId 7027. It is not an event or error message. +// +// +// MessageId: TITLE_SC_MESSAGE_BOX +// +// MessageText: +// +// Service Control Manager %0 +// +#define TITLE_SC_MESSAGE_BOX 0xC0001B75L + +// +// MessageId: EVENT_SERVICE_NOT_INTERACTIVE +// +// MessageText: +// +// The %1 service is marked as an interactive service. However, the system is configured to not allow interactive services. This service may not function properly. +// +#define EVENT_SERVICE_NOT_INTERACTIVE 0xC0001B76L + +// +// Parameter %4 is the value, in decimal, of the SC_ACTION_ constant for +// the action described in parameter %5. +// +// +// MessageId: EVENT_SERVICE_CRASH +// +// MessageText: +// +// The %1 service terminated unexpectedly. It has done this %2 time(s). The following corrective action will be taken in %3 milliseconds: %5. +// +#define EVENT_SERVICE_CRASH 0xC0001B77L + +// +// Parameter %1 is the value, in decimal, of the SC_ACTION_ constant for +// the action described in parameter %2. +// +// +// MessageId: EVENT_SERVICE_RECOVERY_FAILED +// +// MessageText: +// +// The Service Control Manager tried to take a corrective action (%2) after the unexpected termination of the %3 service, but this action failed with the following error: %n%4 +// +#define EVENT_SERVICE_RECOVERY_FAILED 0xC0001B78L + +// +// MessageId: EVENT_SERVICE_SCESRV_FAILED +// +// MessageText: +// +// The Service Control Manager did not initialize successfully. The security +// configuration server (scesrv.dll) failed to initialize with error %1. The +// system is restarting... +// +#define EVENT_SERVICE_SCESRV_FAILED 0xC0001B79L + +// +// MessageId: EVENT_SERVICE_CRASH_NO_ACTION +// +// MessageText: +// +// The %1 service terminated unexpectedly. It has done this %2 time(s). +// +#define EVENT_SERVICE_CRASH_NO_ACTION 0xC0001B7AL + +// +// Parameter %2 is the string name of the control +// +// +// MessageId: EVENT_SERVICE_CONTROL_SUCCESS +// +// MessageText: +// +// The %1 service was successfully sent a %2 control. +// +#define EVENT_SERVICE_CONTROL_SUCCESS 0x40001B7BL + +// +// Parameter %2 is the string name of the control +// +// +// MessageId: EVENT_SERVICE_STATUS_SUCCESS +// +// MessageText: +// +// The %1 service entered the %2 state. +// +#define EVENT_SERVICE_STATUS_SUCCESS 0x40001B7CL + +// +// MessageId: EVENT_SERVICE_CONFIG_BACKOUT_FAILED +// +// MessageText: +// +// The Service Control Manager encountered an error undoing a configuration change +// to the %1 service. The service's %2 is currently in an unpredictable state. +// +// If you do not correct this configuration, you may not be able to restart the %1 +// service or may encounter other errors. To ensure that the service is configured +// properly, use the Services snap-in in Microsoft Management Console (MMC). +// +#define EVENT_SERVICE_CONFIG_BACKOUT_FAILED 0xC0001B7DL + +// +// MessageId: EVENT_FIRST_LOGON_FAILED_II +// +// MessageText: +// +// The %1 service was unable to log on as %2 with the currently configured +// password due to the following error: %n%3%n%nTo ensure that the service is +// configured properly, use the Services snap-in in Microsoft Management +// Console (MMC). +// +#define EVENT_FIRST_LOGON_FAILED_II 0xC0001B7EL + +// +// MessageId: EVENT_SERVICE_DIFFERENT_PID_CONNECTED +// +// MessageText: +// +// A service process other than the one launched by the Service Control Manager +// connected when starting the %1 service. The Service Control Manager launched +// process %2 and process %3 connected instead.%n%n +// +// Note that if this service is configured to start under a debugger, this behavior +// is expected. +// +#define EVENT_SERVICE_DIFFERENT_PID_CONNECTED 0x80001B7FL + +// +// MessageId: EVENT_SERVICE_START_TYPE_CHANGED +// +// MessageText: +// +// The start type of the %1 service was changed from %2 to %3. +// +#define EVENT_SERVICE_START_TYPE_CHANGED 0x40001B80L + +// +// MessageId: EVENT_SERVICE_LOGON_TYPE_NOT_GRANTED +// +// MessageText: +// +// The %1 service was unable to log on as %2 with the currently configured +// password due to the following error: +// %nLogon failure: the user has not been granted the requested logon type at this +// computer.%n +// %nService: %1 +// %nDomain and account: %2%n +// %nThis service account does not have the necessary user right "Log on as a service."%n +// %nUser Action%n +// %nAssign "Log on as a service" to the service account on this computer. You can +// use Local Security Settings (Secpol.msc) to do this. If this computer is a +// node in a cluster, check that this user right is assigned to the Cluster +// service account on all nodes in the cluster.%n +// %nIf you have already assigned this user right to the service account, and the +// user right appears to be removed, a Group Policy object associated with this +// node might be removing the right. Check with your domain administrator to find +// out if this is happening. +// +#define EVENT_SERVICE_LOGON_TYPE_NOT_GRANTED 0xC0001B81L + +// +// MessageId: EVENT_SERVICE_STOP_SUCCESS_WITH_REASON +// +// MessageText: +// +// The %1 service was successfully sent a %2 control.%n%n +// The reason specified was: %3 [%4]%n%n +// Comment: %5 +// +#define EVENT_SERVICE_STOP_SUCCESS_WITH_REASON 0x40001B82L + +// +// MessageId: EVENT_SERVICE_SHUTDOWN_FAILED +// +// MessageText: +// +// The %1 service did not shutdown properly after receiving a preshutdown control. +// +#define EVENT_SERVICE_SHUTDOWN_FAILED 0xC0001B83L + +// +// IMPORTANT NOTE: Do not add any new Vista+ SCM events in netevent.mc, please add those to base\screg\sc\manifests\services.man which contains +// Crimson-friendly event definitions. The SCM events defined here are not used by the eventvwr MMC snapin but continue to remain here due to +// few components depending on the definition (test code, tools code, etc.) +// +// +// Schedule (AT command) Service Events 7900 - 7999 +// +// +// MessageId: EVENT_COMMAND_NOT_INTERACTIVE +// +// MessageText: +// +// The %1 command is marked as an interactive command. However, the system is +// configured to not allow interactive command execution. This command may not +// function properly. +// +#define EVENT_COMMAND_NOT_INTERACTIVE 0xC0001EDCL + +// +// MessageId: EVENT_COMMAND_START_FAILED +// +// MessageText: +// +// The %1 command failed to start due to the following error: %n%2 +// +#define EVENT_COMMAND_START_FAILED 0xC0001EDDL + + +///////////////////////////////////////////////////////////////////////// +// +// Lanman Bowser/Browser Events (8000-8499) +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_BOWSER_OTHER_MASTER_ON_NET +// +// MessageText: +// +// The master browser has received a server announcement from the computer %2 +// that believes that it is the master browser for the domain on transport %3. +// The master browser is stopping or an election is being forced. +// +#define EVENT_BOWSER_OTHER_MASTER_ON_NET 0xC0001F43L + +// +// MessageId: EVENT_BOWSER_PROMOTED_WHILE_ALREADY_MASTER +// +// MessageText: +// +// A request has been submitted to promote the computer to backup when it is already a +// master browser. +// +#define EVENT_BOWSER_PROMOTED_WHILE_ALREADY_MASTER 0x80001F44L + +// +// MessageId: EVENT_BOWSER_NON_MASTER_MASTER_ANNOUNCE +// +// MessageText: +// +// The browser has received a server announcement indicating that the computer %2 +// is a master browser, but this computer is not a master browser. +// +#define EVENT_BOWSER_NON_MASTER_MASTER_ANNOUNCE 0x80001F45L + +// +// MessageId: EVENT_BOWSER_ILLEGAL_DATAGRAM +// +// MessageText: +// +// The browser has received an illegal datagram from the remote computer %2 to name %3 on transport %4. The data is the datagram. +// +#define EVENT_BOWSER_ILLEGAL_DATAGRAM 0x80001F46L + +// +// MessageId: EVENT_BROWSER_STATUS_BITS_UPDATE_FAILED +// +// MessageText: +// +// The browser was unable to update the service status bits. The data is the error. +// +#define EVENT_BROWSER_STATUS_BITS_UPDATE_FAILED 0xC0001F47L + +// +// MessageId: EVENT_BROWSER_ROLE_CHANGE_FAILED +// +// MessageText: +// +// The browser was unable to update its role. The data is the error. +// +#define EVENT_BROWSER_ROLE_CHANGE_FAILED 0xC0001F48L + +// +// MessageId: EVENT_BROWSER_MASTER_PROMOTION_FAILED +// +// MessageText: +// +// The browser was unable to promote itself to master browser. The computer that currently +// believes it is the master browser is %1. +// +#define EVENT_BROWSER_MASTER_PROMOTION_FAILED 0xC0001F49L + +// +// MessageId: EVENT_BOWSER_NAME_CONVERSION_FAILED +// +// MessageText: +// +// The browser driver was unable to convert a character string to a unicode string. +// +#define EVENT_BOWSER_NAME_CONVERSION_FAILED 0xC0001F4AL + +// +// MessageId: EVENT_BROWSER_OTHERDOMAIN_ADD_FAILED +// +// MessageText: +// +// The browser was unable to add the configuration parameter %1. +// +#define EVENT_BROWSER_OTHERDOMAIN_ADD_FAILED 0xC0001F4BL + +// +// MessageId: EVENT_BOWSER_ELECTION_RECEIVED +// +// MessageText: +// +// The browser driver has received an election packet from computer %2 on network %3. The data is the packet received. +// +#define EVENT_BOWSER_ELECTION_RECEIVED 0x00001F4CL + +// +// MessageId: EVENT_BOWSER_ELECTION_SENT_GETBLIST_FAILED +// +// MessageText: +// +// The browser driver has forced an election on network %2 because it was unable to find a master browser to retrieve a backup list on that network. +// +#define EVENT_BOWSER_ELECTION_SENT_GETBLIST_FAILED 0x40001F4DL + +// +// MessageId: EVENT_BOWSER_ELECTION_SENT_FIND_MASTER_FAILED +// +// MessageText: +// +// The browser driver has forced an election on network %2 because it was unable to find a master browser for that network. +// +#define EVENT_BOWSER_ELECTION_SENT_FIND_MASTER_FAILED 0x40001F4EL + +// +// MessageId: EVENT_BROWSER_ELECTION_SENT_LANMAN_NT_STARTED +// +// MessageText: +// +// The browser has forced an election on network %1 because a Windows Server (or domain master) browser is started. +// +#define EVENT_BROWSER_ELECTION_SENT_LANMAN_NT_STARTED 0x40001F4FL + +// +// MessageId: EVENT_BOWSER_ILLEGAL_DATAGRAM_THRESHOLD +// +// MessageText: +// +// The browser driver has received too many illegal datagrams from the remote computer %2 to name %3 on transport %4. The data is the datagram. +// No more events will be generated until the reset frequency has expired. +// +#define EVENT_BOWSER_ILLEGAL_DATAGRAM_THRESHOLD 0xC0001F50L + +// +// MessageId: EVENT_BROWSER_DEPENDANT_SERVICE_FAILED +// +// MessageText: +// +// The browser has failed to start because the dependent service %1 had invalid service status %2. +// Status Meaning +// 1 Service Stopped%n +// 2 Start Pending%n +// 3 Stop Pending%n +// 4 Running%n +// 5 Continue Pending%n +// 6 Pause Pending%n +// 7 Paused%n +// +#define EVENT_BROWSER_DEPENDANT_SERVICE_FAILED 0xC0001F51L + +// +// MessageId: EVENT_BROWSER_MASTER_PROMOTION_FAILED_STOPPING +// +// MessageText: +// +// The browser was unable to promote itself to master browser. The browser will continue +// to attempt to promote itself to the master browser, but will no longer log any events in the event log in Event Viewer. +// +#define EVENT_BROWSER_MASTER_PROMOTION_FAILED_STOPPING 0xC0001F53L + +// +// MessageId: EVENT_BROWSER_MASTER_PROMOTION_FAILED_NO_MASTER +// +// MessageText: +// +// The browser was unable to promote itself to master browser. The computer that currently +// believes it is the master browser is unknown. +// +#define EVENT_BROWSER_MASTER_PROMOTION_FAILED_NO_MASTER 0xC0001F54L + +// +// MessageId: EVENT_BROWSER_SERVER_LIST_FAILED +// +// MessageText: +// +// The browser service was unable to retrieve a list of servers from the browser master %1 on the network %2.%n +// %n +// Browser master: %1%n +// Network: %2%n +// %n +// This event may be caused by a temporary loss of network connectivity. If this message appears again, verify that the server is still connected to the network. The return code is in the Data text box. +// +#define EVENT_BROWSER_SERVER_LIST_FAILED 0x80001F55L + +// +// MessageId: EVENT_BROWSER_DOMAIN_LIST_FAILED +// +// MessageText: +// +// The browser service was unable to retrieve a list of domains from the browser master %1 on the network %2.%n +// %n +// Browser master: %1%n +// Network: %2%n +// %n +// This event may be caused by a temporary loss of network connectivity. If this message appears again, verify that the server is still connected to the network. The return code is in the Data text box. +// +#define EVENT_BROWSER_DOMAIN_LIST_FAILED 0x80001F56L + +// +// MessageId: EVENT_BROWSER_ILLEGAL_CONFIG +// +// MessageText: +// +// The value for the parameter %1 to the browser service was illegal. +// +#define EVENT_BROWSER_ILLEGAL_CONFIG 0x80001F57L + +// +// MessageId: EVENT_BOWSER_OLD_BACKUP_FOUND +// +// MessageText: +// +// The backup browser server %2 is out-of-date. Consider upgrading this computer. +// +#define EVENT_BOWSER_OLD_BACKUP_FOUND 0x40001F58L + +// +// MessageId: EVENT_BROWSER_SERVER_LIST_RETRIEVED +// +// MessageText: +// +// The browser has retrieved a list of servers from remote computer %1 on transport %2.%n +// There were %3 entries read, and %4 total entries. +// +#define EVENT_BROWSER_SERVER_LIST_RETRIEVED 0x00001F59L + +// +// MessageId: EVENT_BROWSER_DOMAIN_LIST_RETRIEVED +// +// MessageText: +// +// The browser has retrieved a list of domains from remote computer %1 on transport %2.%n +// There were %3 entries read, and %4 total entries. +// +#define EVENT_BROWSER_DOMAIN_LIST_RETRIEVED 0x00001F5AL + +// +// MessageId: EVENT_BOWSER_PDC_LOST_ELECTION +// +// MessageText: +// +// The browser running on the Domain Controller has lost an election. The computer that won the election is %2, on the transport %3.%n +// The data contains the election version, election criteria, and remote computer time up, and the same information for +// the current computer. +// +#define EVENT_BOWSER_PDC_LOST_ELECTION 0x40001F5BL + +// +// MessageId: EVENT_BOWSER_NON_PDC_WON_ELECTION +// +// MessageText: +// +// The browser running on this computer has won a browser election on network %2. +// This computer is a member of a domain, so the Domain Controller should become the master +// browser. +// +#define EVENT_BOWSER_NON_PDC_WON_ELECTION 0x40001F5CL + +// +// MessageId: EVENT_BOWSER_CANT_READ_REGISTRY +// +// MessageText: +// +// The browser driver was unable to initialize variables from the Registry. +// +#define EVENT_BOWSER_CANT_READ_REGISTRY 0x40001F5DL + +// +// MessageId: EVENT_BOWSER_MAILSLOT_DATAGRAM_THRESHOLD_EXCEEDED +// +// MessageText: +// +// The browser driver has discarded too many mailslot messages. +// +#define EVENT_BOWSER_MAILSLOT_DATAGRAM_THRESHOLD_EXCEEDED 0x40001F5EL + +// +// MessageId: EVENT_BOWSER_GETBROWSERLIST_THRESHOLD_EXCEEDED +// +// MessageText: +// +// The browser driver has discarded too many GetBrowserServerList requests. +// +#define EVENT_BOWSER_GETBROWSERLIST_THRESHOLD_EXCEEDED 0x40001F5FL + +// +// MessageId: EVENT_BROWSER_BACKUP_STOPPED +// +// MessageText: +// +// The browser service has failed to retrieve the backup list too many times on transport %1. +// The backup browser is stopping. +// +#define EVENT_BROWSER_BACKUP_STOPPED 0xC0001F60L + +// +// MessageId: EVENT_BROWSER_ELECTION_SENT_LANMAN_NT_STOPPED +// +// MessageText: +// +// The browser has forced an election on network %1 because a master browser was stopped. +// +#define EVENT_BROWSER_ELECTION_SENT_LANMAN_NT_STOPPED 0x40001F61L + +// +// MessageId: EVENT_BROWSER_GETBLIST_RECEIVED_NOT_MASTER +// +// MessageText: +// +// The browser has received a GetBrowserServerList request when it is not the master browser. +// +#define EVENT_BROWSER_GETBLIST_RECEIVED_NOT_MASTER 0xC0001F62L + +// +// MessageId: EVENT_BROWSER_ELECTION_SENT_ROLE_CHANGED +// +// MessageText: +// +// The browser has forced an election on network %1 because the Domain Controller (or Server) has changed its role. +// +#define EVENT_BROWSER_ELECTION_SENT_ROLE_CHANGED 0x40001F63L + +// +// MessageId: EVENT_BROWSER_NOT_STARTED_IPX_CONFIG_MISMATCH +// +// MessageText: +// +// The browser has failed to start because of an error in the DirectHostBinding parameter to the browser. +// +#define EVENT_BROWSER_NOT_STARTED_IPX_CONFIG_MISMATCH 0xC0001F64L + +// +// MessageId: EVENT_BROWSER_REMOTE_MAILSLOTS_ENABLED +// +// MessageText: +// +// An administrator has enabled remote mailslots, which are off by default. Microsoft does not recommend enabling remote mailslots. To disable remote mailslots, run the PowerShell command: Set-SmbServerConfiguration -EnableMailslots $FALSE. +// +#define EVENT_BROWSER_REMOTE_MAILSLOTS_ENABLED 0x80001F65L + +// +// MessageId: EVENT_BROWSER_REMOTE_MAILSLOTS_DISABLED +// +// MessageText: +// +// An administrator has disabled remote mailslots. +// +#define EVENT_BROWSER_REMOTE_MAILSLOTS_DISABLED 0x40001F66L + +// +// MessageId: EVENT_BROWSER_REMOTE_MAILSLOTS_ENABLED_BY_POLICY +// +// MessageText: +// +// An administrator has enabled remote mailslots by policy. Microsoft does not recommend enabling remote mailslots. +// +#define EVENT_BROWSER_REMOTE_MAILSLOTS_ENABLED_BY_POLICY 0x80001F67L + +// +// MessageId: EVENT_BROWSER_REMOTE_MAILSLOTS_DISABLED_BY_POLICY +// +// MessageText: +// +// An administrator has disabled remote mailslots by policy. +// +#define EVENT_BROWSER_REMOTE_MAILSLOTS_DISABLED_BY_POLICY 0x40001F68L + + +///////////////////////////////////////////////////////////////////////// +// +// Sap Agent Events (8500-8999) +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: NWSAP_EVENT_KEY_NOT_FOUND +// +// MessageText: +// +// The Registry Key %1 was not present. The Sap Agent could not start. +// +#define NWSAP_EVENT_KEY_NOT_FOUND 0xC0002134L + +// +// MessageId: NWSAP_EVENT_WSASTARTUP_FAILED +// +// MessageText: +// +// Winsock startup routine failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WSASTARTUP_FAILED 0xC0002135L + +// +// MessageId: NWSAP_EVENT_SOCKET_FAILED +// +// MessageText: +// +// Socket create call failed for main socket. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_SOCKET_FAILED 0xC0002136L + +// +// MessageId: NWSAP_EVENT_SETOPTBCAST_FAILED +// +// MessageText: +// +// Setting broadcast option on socket failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_SETOPTBCAST_FAILED 0xC0002137L + +// +// MessageId: NWSAP_EVENT_BIND_FAILED +// +// MessageText: +// +// Binding to SAP Socket failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_BIND_FAILED 0xC0002138L + +// +// MessageId: NWSAP_EVENT_GETSOCKNAME_FAILED +// +// MessageText: +// +// Getting bound address of socket failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_GETSOCKNAME_FAILED 0xC0002139L + +// +// MessageId: NWSAP_EVENT_OPTEXTENDEDADDR_FAILED +// +// MessageText: +// +// Setting option EXTENDED_ADDRESS failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_OPTEXTENDEDADDR_FAILED 0xC000213AL + +// +// MessageId: NWSAP_EVENT_OPTBCASTINADDR_FAILED +// +// MessageText: +// +// Setting NWLink option BCASTINTADDR failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_OPTBCASTINADDR_FAILED 0xC000213BL + +// +// MessageId: NWSAP_EVENT_CARDMALLOC_FAILED +// +// MessageText: +// +// Error allocating memory to hold a card structure. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_CARDMALLOC_FAILED 0xC000213CL + +// +// MessageId: NWSAP_EVENT_NOCARDS +// +// MessageText: +// +// Enumeration of cards returned 0 cards. +// +#define NWSAP_EVENT_NOCARDS 0xC000213DL + +// +// MessageId: NWSAP_EVENT_THREADEVENT_FAIL +// +// MessageText: +// +// Error creating thread counting event. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_THREADEVENT_FAIL 0xC000213EL + +// +// MessageId: NWSAP_EVENT_RECVSEM_FAIL +// +// MessageText: +// +// Error creating receive semaphore. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_RECVSEM_FAIL 0xC000213FL + +// +// MessageId: NWSAP_EVENT_SENDEVENT_FAIL +// +// MessageText: +// +// Error creating send event. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_SENDEVENT_FAIL 0xC0002140L + +// +// MessageId: NWSAP_EVENT_STARTRECEIVE_ERROR +// +// MessageText: +// +// Error starting receive thread. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_STARTRECEIVE_ERROR 0xC0002141L + +// +// MessageId: NWSAP_EVENT_STARTWORKER_ERROR +// +// MessageText: +// +// Error starting worker thread. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_STARTWORKER_ERROR 0xC0002142L + +// +// MessageId: NWSAP_EVENT_TABLE_MALLOC_FAILED +// +// MessageText: +// +// Error allocating database array. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_TABLE_MALLOC_FAILED 0xC0002143L + +// +// MessageId: NWSAP_EVENT_HASHTABLE_MALLOC_FAILED +// +// MessageText: +// +// Error allocating hash table. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_HASHTABLE_MALLOC_FAILED 0xC0002144L + +// +// MessageId: NWSAP_EVENT_STARTLPCWORKER_ERROR +// +// MessageText: +// +// Error starting LPC worker thread. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_STARTLPCWORKER_ERROR 0xC0002145L + +// +// MessageId: NWSAP_EVENT_CREATELPCPORT_ERROR +// +// MessageText: +// +// Error creating the LPC port. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_CREATELPCPORT_ERROR 0xC0002146L + +// +// MessageId: NWSAP_EVENT_CREATELPCEVENT_ERROR +// +// MessageText: +// +// Error creating the LPC thread event. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_CREATELPCEVENT_ERROR 0xC0002147L + +// +// MessageId: NWSAP_EVENT_LPCLISTENMEMORY_ERROR +// +// MessageText: +// +// Error allocating memory for an LPC Client structure. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_LPCLISTENMEMORY_ERROR 0xC0002148L + +// +// MessageId: NWSAP_EVENT_LPCHANDLEMEMORY_ERROR +// +// MessageText: +// +// Error allocating buffer to hold LPC worker thread handles. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_LPCHANDLEMEMORY_ERROR 0xC0002149L + +// +// MessageId: NWSAP_EVENT_BADWANFILTER_VALUE +// +// MessageText: +// +// The value for WANFilter in the registry must be 0-2. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_BADWANFILTER_VALUE 0xC000214AL + +// +// MessageId: NWSAP_EVENT_CARDLISTEVENT_FAIL +// +// MessageText: +// +// Error creating event for card list access synchronization. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_CARDLISTEVENT_FAIL 0xC000214BL + +// +// MessageId: NWSAP_EVENT_SDMDEVENT_FAIL +// +// MessageText: +// +// Error creating event for database access synchronization. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_SDMDEVENT_FAIL 0xC000214CL + +// +// MessageId: NWSAP_EVENT_INVALID_FILTERNAME +// +// MessageText: +// +// Name too long in key %1: Name = %s. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_INVALID_FILTERNAME 0x8000214DL + +// +// MessageId: NWSAP_EVENT_WANSEM_FAIL +// +// MessageText: +// +// Error creating WAN control semaphore. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WANSEM_FAIL 0xC000214EL + +// +// MessageId: NWSAP_EVENT_WANSOCKET_FAILED +// +// MessageText: +// +// Socket create call failed for WAN socket. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WANSOCKET_FAILED 0xC000214FL + +// +// MessageId: NWSAP_EVENT_WANBIND_FAILED +// +// MessageText: +// +// Binding to WAN socket failed. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WANBIND_FAILED 0xC0002150L + +// +// MessageId: NWSAP_EVENT_STARTWANWORKER_ERROR +// +// MessageText: +// +// Error starting WAN worker thread. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_STARTWANWORKER_ERROR 0xC0002151L + +// +// MessageId: NWSAP_EVENT_STARTWANCHECK_ERROR +// +// MessageText: +// +// Error starting WAN check thread. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_STARTWANCHECK_ERROR 0xC0002152L + +// +// MessageId: NWSAP_EVENT_OPTMAXADAPTERNUM_ERROR +// +// MessageText: +// +// Error on getsockopt IPX_MAX_ADAPTER_NUM. Data is the error code. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_OPTMAXADAPTERNUM_ERROR 0xC0002153L + +// +// MessageId: NWSAP_EVENT_WANHANDLEMEMORY_ERROR +// +// MessageText: +// +// Error allocating buffer to hold WAN notify thread handles. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WANHANDLEMEMORY_ERROR 0xC0002154L + +// +// MessageId: NWSAP_EVENT_WANEVENT_ERROR +// +// MessageText: +// +// Error creating the WAN thread event. The Sap Agent cannot continue. +// +#define NWSAP_EVENT_WANEVENT_ERROR 0xC0002155L + + +///////////////////////////////////////////////////////////////////////// +// +// Transport Events (9000-9499) +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_TRANSPORT_RESOURCE_POOL +// +// MessageText: +// +// %2 could not allocate a resource of type %3 due to system resource problems. +// +#define EVENT_TRANSPORT_RESOURCE_POOL 0x80002329L + +// +// MessageId: EVENT_TRANSPORT_RESOURCE_LIMIT +// +// MessageText: +// +// %2 could not allocate a resource of type %3 due to its configured size of %4. +// +#define EVENT_TRANSPORT_RESOURCE_LIMIT 0x8000232AL + +// +// MessageId: EVENT_TRANSPORT_RESOURCE_SPECIFIC +// +// MessageText: +// +// %2 could not allocate a resource of type %3 due to a specifically configured limit of %4. +// +#define EVENT_TRANSPORT_RESOURCE_SPECIFIC 0x8000232BL + +// +// MessageId: EVENT_TRANSPORT_REGISTER_FAILED +// +// MessageText: +// +// %2 failed to register itself with the NDIS wrapper. +// +#define EVENT_TRANSPORT_REGISTER_FAILED 0xC000232CL + +// +// MessageId: EVENT_TRANSPORT_BINDING_FAILED +// +// MessageText: +// +// %2 failed to bind to network adapter %3. +// +#define EVENT_TRANSPORT_BINDING_FAILED 0xC000232DL + +// +// MessageId: EVENT_TRANSPORT_ADAPTER_NOT_FOUND +// +// MessageText: +// +// %2 could not find network adapter %3. +// +#define EVENT_TRANSPORT_ADAPTER_NOT_FOUND 0xC000232EL + +// +// MessageId: EVENT_TRANSPORT_SET_OID_FAILED +// +// MessageText: +// +// %2 failed while setting object identifier %3 on network adapter %4. +// +#define EVENT_TRANSPORT_SET_OID_FAILED 0xC000232FL + +// +// MessageId: EVENT_TRANSPORT_QUERY_OID_FAILED +// +// MessageText: +// +// %2 failed while querying object identifier %3 on network adapter %4. +// +#define EVENT_TRANSPORT_QUERY_OID_FAILED 0xC0002330L + +// +// MessageId: EVENT_TRANSPORT_TRANSFER_DATA +// +// MessageText: +// +// %2 could not transfer a packet from the network adapter. The packet was dropped. +// +#define EVENT_TRANSPORT_TRANSFER_DATA 0x40002331L + +// +// MessageId: EVENT_TRANSPORT_TOO_MANY_LINKS +// +// MessageText: +// +// %2 could not create a link to a remote computer. Your computer has exceeded the number of connections it can make to that remote computer. +// +#define EVENT_TRANSPORT_TOO_MANY_LINKS 0x40002332L + +// +// MessageId: EVENT_TRANSPORT_BAD_PROTOCOL +// +// MessageText: +// +// %2 received an unexpected %3 packet from a remote computer. +// +#define EVENT_TRANSPORT_BAD_PROTOCOL 0x40002333L + + +///////////////////////////////////////////////////////////////////////// +// +// IPX/SPX Events (9500-9999) +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_IPX_NEW_DEFAULT_TYPE +// +// MessageText: +// +// The default frame type for auto-detection on %2 was changed to %3. +// This type is now the default if no frame type can be detected. +// +#define EVENT_IPX_NEW_DEFAULT_TYPE 0x4000251DL + +// +// MessageId: EVENT_IPX_SAP_ANNOUNCE +// +// MessageText: +// +// A SAP announcement was sent over %2 which is configured for multiple +// networks, but no internal network is configured. This may prevent +// machines on some networks from locating the advertised service. +// +#define EVENT_IPX_SAP_ANNOUNCE 0x8000251EL + +// +// MessageId: EVENT_IPX_ILLEGAL_CONFIG +// +// MessageText: +// +// The value for the %2 parameter %3 was illegal. +// +#define EVENT_IPX_ILLEGAL_CONFIG 0x8000251FL + +// +// MessageId: EVENT_IPX_INTERNAL_NET_INVALID +// +// MessageText: +// +// %2 was configured with an internal network number of %3. This network +// number conflicts with one of the attached networks. The configured +// internal network number will be ignored. +// +#define EVENT_IPX_INTERNAL_NET_INVALID 0xC0002520L + +// +// MessageId: EVENT_IPX_NO_FRAME_TYPES +// +// MessageText: +// +// %2 had no frame types configured for the binding to adapter %3. +// +#define EVENT_IPX_NO_FRAME_TYPES 0xC0002521L + +// +// MessageId: EVENT_IPX_CREATE_DEVICE +// +// MessageText: +// +// %2 failed to initialize because the driver device could not be created. +// +#define EVENT_IPX_CREATE_DEVICE 0xC0002522L + +// +// MessageId: EVENT_IPX_NO_ADAPTERS +// +// MessageText: +// +// %2 could not bind to any adapters. The transport could not start. +// +#define EVENT_IPX_NO_ADAPTERS 0xC0002523L + + +///////////////////////////////////////////////////////////////////////// +// +// DCOM Events (10000-10999) +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// MessageId: EVENT_RPCSS_CREATEPROCESS_FAILURE +// +// MessageText: +// +// Unable to start a DCOM Server: %3. +// The error:%n"%%%2"%nHappened while starting this command:%n%1 +// +#define EVENT_RPCSS_CREATEPROCESS_FAILURE 0xC0002710L + +// +// MessageId: EVENT_RPCSS_RUNAS_CREATEPROCESS_FAILURE +// +// MessageText: +// +// Unable to start a DCOM Server: %3 as %4/%5. +// The error:%n"%%%2"%nHappened while starting this command:%n%1 +// +#define EVENT_RPCSS_RUNAS_CREATEPROCESS_FAILURE 0xC0002711L + +// +// MessageId: EVENT_RPCSS_LAUNCH_ACCESS_DENIED +// +// MessageText: +// +// Access denied attempting to launch a DCOM Server. +// The server is:%n%1%nThe user is %2/%3, SID=%4. +// +#define EVENT_RPCSS_LAUNCH_ACCESS_DENIED 0xC0002712L + +// +// MessageId: EVENT_RPCSS_DEFAULT_LAUNCH_ACCESS_DENIED +// +// MessageText: +// +// Access denied attempting to launch a DCOM Server using DefaultLaunchPermssion. +// The server is:%n%1%nThe user is %2/%3, SID=%4. +// +#define EVENT_RPCSS_DEFAULT_LAUNCH_ACCESS_DENIED 0xC0002713L + +// +// MessageId: EVENT_RPCSS_RUNAS_CANT_LOGIN +// +// MessageText: +// +// DCOM got error "%%%1" and was unable to logon %2\%3 +// in order to run the server:%n%4 +// +#define EVENT_RPCSS_RUNAS_CANT_LOGIN 0xC0002714L + +// +// MessageId: EVENT_RPCSS_START_SERVICE_FAILURE +// +// MessageText: +// +// DCOM got error "%%%1" attempting to start the service %2 with arguments "%3" +// in order to run the server:%n%4 +// +#define EVENT_RPCSS_START_SERVICE_FAILURE 0xC0002715L + +// +// MessageId: EVENT_RPCSS_REMOTE_SIDE_ERROR +// +// MessageText: +// +// DCOM got error "%%%1" from the computer %2 when attempting to +// activate the server:%n%3 +// +#define EVENT_RPCSS_REMOTE_SIDE_ERROR 0xC0002716L + +// +// MessageId: EVENT_RPCSS_ACTIVATION_ERROR +// +// MessageText: +// +// DCOM got error "%%%1" when attempting to +// activate the server:%n%2 +// +#define EVENT_RPCSS_ACTIVATION_ERROR 0xC0002717L + +// +// MessageId: EVENT_RPCSS_REMOTE_SIDE_ERROR_WITH_FILE +// +// MessageText: +// +// DCOM got error "%%%1" from the computer %2 when attempting to +// the server:%n%3 with file %4. +// +#define EVENT_RPCSS_REMOTE_SIDE_ERROR_WITH_FILE 0xC0002718L + +// +// MessageId: EVENT_RPCSS_REMOTE_SIDE_UNAVAILABLE +// +// MessageText: +// +// DCOM was unable to communicate with the computer %1 using any of the configured +// protocols. +// +#define EVENT_RPCSS_REMOTE_SIDE_UNAVAILABLE 0xC0002719L + +// +// MessageId: EVENT_RPCSS_SERVER_START_TIMEOUT +// +// MessageText: +// +// The server %1 did not register with DCOM within the required timeout. +// +#define EVENT_RPCSS_SERVER_START_TIMEOUT 0xC000271AL + +// +// MessageId: EVENT_RPCSS_SERVER_NOT_RESPONDING +// +// MessageText: +// +// The server %1 could not be contacted to establish the connection to the client +// +#define EVENT_RPCSS_SERVER_NOT_RESPONDING 0xC000271BL + +// +// MessageId: EVENT_DCOM_ASSERTION_FAILURE +// +// MessageText: +// +// There is an assertion failure in DCOM. Context follows: +// %1 +// %2 +// %3 +// +#define EVENT_DCOM_ASSERTION_FAILURE 0xC000271CL + +// +// MessageId: EVENT_DCOM_INVALID_ENDPOINT_DATA +// +// MessageText: +// +// DCOM server attempted to listen on an invalid endpoint. +// Protseq: %1 +// Endpoint: %2 +// Flags: %3 +// +#define EVENT_DCOM_INVALID_ENDPOINT_DATA 0xC000271DL + +// +// MessageId: EVENT_DCOM_COMPLUS_DISABLED +// +// MessageText: +// +// The activation for CLSID %1 failed because remote activations for COM+ are disabled. +// To enable this functionality use the Configure Your Server wizard and select the Web +// Application Server role. +// +#define EVENT_DCOM_COMPLUS_DISABLED 0xC000271EL + +// +// MessageId: EVENT_RPCSS_STOP_SERVICE_FAILURE +// +// MessageText: +// +// The activation of the CLSID %1 timed out waiting for the service %2 to stop. +// +#define EVENT_RPCSS_STOP_SERVICE_FAILURE 0xC000272DL + +// +// MessageId: EVENT_RPCSS_CREATEDEBUGGERPROCESS_FAILURE +// +// MessageText: +// +// Unable to start a COM Server for debugging: %3. +// The error:%n"%%%2"%nHappened while starting this command:%n%1 +// +#define EVENT_RPCSS_CREATEDEBUGGERPROCESS_FAILURE 0xC000272EL + + +///////////////////////////////////////////////////////////////////////// +// +// DNS Caching Resolvers Service and DNS API Events (11000-11999) +// +///////////////////////////////////////////////////////////////////////// + +// +// Errors +// + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_DLL +// +// MessageText: +// +// Unable to start DNS Client Service. +// Failed to load DLL %2, Error: %1. +// Please reinstall this DLL from installation CD. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_DLL 0xC0002AF8L + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_ENTRY +// +// MessageText: +// +// Unable to start DNS Client service. Can not find entry %3 in DLL %2. +// Please reinstall this DLL from installation CD. See event details +// for specific error code information. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_ENTRY 0xC0002AF9L + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_CONTROL +// +// MessageText: +// +// Unable to start the DNS Client service. The system could not register a +// service control handler and could be out of resources. Close any +// applications not in use or reboot the computer. See event details for +// specific error code information. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_CONTROL 0xC0002AFAL + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_DONE_EVENT +// +// MessageText: +// +// Unable to start DNS Client service. The system could +// not create a termination event for this service and +// could be out of resources. Close any applications not +// in use or reboot the computer. See event details for +// specific error code information. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_DONE_EVENT 0xC0002AFBL + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_RPC +// +// MessageText: +// +// Unable to start DNS Client service. Could not start the +// Remote Procedure Call (RPC) interface for this service. +// To correct the problem, you may restart the RPC and DNS +// Client services. To do so, use the following commands at a command +// prompt: (1) type "net start rpc" to start the RPC service, and (2) +// type "net start dnscache" to start the DNS Client service. +// See event details for specific error code information. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_RPC 0xC0002AFCL + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_SHUTDOWN_NOTIFY +// +// MessageText: +// +// Unable to start DNS Client service. The system could not register +// shutdown notification for this service and could be out of resources. +// Try closing any applications not in use or reboot the computer. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_SHUTDOWN_NOTIFY 0xC0002AFDL + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_NO_UPDATE +// +// MessageText: +// +// Unable to start DNS Client service. Could not update status with +// Service Control Manager. To correct the problem, you may restart +// the RPC and DNS Client services. To do so, use the following commands +// at a command prompt: (1) type "net start rpc" to start the RPC service, +// and (2) type "net start dnscache" to start the DNS Client service. +// See event details for specific error code information. +// +#define EVENT_DNS_CACHE_START_FAILURE_NO_UPDATE 0xC0002AFEL + +// +// MessageId: EVENT_DNS_CACHE_START_FAILURE_LOW_MEMORY +// +// MessageText: +// +// Unable to start DNS Client service because the system failed to allocate +// memory and may be out of available memory. Try closing any applications not +// in use or reboot the computer. See event details for specific error code +// information. +// +#define EVENT_DNS_CACHE_START_FAILURE_LOW_MEMORY 0xC0002AFFL + + +// +// Warnings +// + +// +// MessageId: EVENT_DNS_CACHE_NETWORK_PERF_WARNING +// +// MessageText: +// +// The DNS Client service could not contact any DNS servers for +// a repeated number of attempts. For the next %3 seconds the +// DNS Client service will not use the network to avoid further +// network performance problems. It will resume its normal behavior +// after that. If this problem persists, verify your TCP/IP +// configuration, specifically check that you have a preferred +// (and possibly an alternate) DNS server configured. If the problem +// continues, verify network conditions to these DNS servers or contact +// your network administrator. +// +#define EVENT_DNS_CACHE_NETWORK_PERF_WARNING 0x80002B2AL + +// +// MessageId: EVENT_DNS_CACHE_UNABLE_TO_REACH_SERVER_WARNING +// +// MessageText: +// +// The DNS Client service failed to reach DNS server at address %1. It will +// not use this DNS server for %2 seconds. +// +#define EVENT_DNS_CACHE_UNABLE_TO_REACH_SERVER_WARNING 0x80002B2BL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_TIMEOUT +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS Server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The cause of this DNS registration failure was because the DNS update +// request timed out after being sent to the specified DNS Server. This is +// probably because the authoritative DNS server for the name being updated +// is not running.%n%n You can manually retry registration of the network +// adapter and its settings by typing "ipconfig /registerdns" at the command +// prompt. If problems still persist, contact your network systems +// administrator to verify network conditions. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_TIMEOUT 0x80002B8EL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_SERVERFAIL +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The cause of this DNS registration failure was because of DNS server failure. +// This may be due to a zone transfer that has locked the DNS server for the +// applicable zone that your computer needs to register itself with.%n%n +// (The applicable zone should typically correspond to the Adapter-specific +// Domain Suffix that was indicated above.) You can manually retry registration +// of the network adapter and its settings by typing "ipconfig /registerdns" +// at the command prompt. If problems still persist, contact your network +// systems administrator to verify network conditions. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_SERVERFAIL 0x80002B8FL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_NOTSUPP +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason it could not register was because either: (a) the DNS server +// does not support the DNS dynamic update protocol, or (b) the primary zone +// authoritative for the registering names does not currently accept dynamic +// updates.%n%n To add or register a DNS host (A or AAAA) resource record using +// the specific DNS name for this adapter, contact your DNS server or network +// systems administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_NOTSUPP 0x80002B90L + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_REFUSED +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason it could not register was because the DNS server refused the +// dynamic update request. This could happen for the following reasons: +// (a) current DNS update policies do not allow this computer to update +// the DNS domain name configured for this adapter, or (b) the authoritative +// DNS server for this DNS domain name does not support the DNS dynamic update +// protocol.%n%n +// To register a DNS host (A or AAAA) resource record using the specific DNS +// domain name for this adapter, contact your DNS server or network systems +// administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_REFUSED 0x80002B91L + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_SECURITY +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The system could not register the DNS update request because of a +// security related problem. This could happen for the following reasons: +// (a) the DNS domain name that your computer is trying to register could +// not be updated because your computer does not have the right permissions, +// or (b) there might have been a problem negotiating valid credentials +// with the DNS server to update.%n%n +// You can manually retry DNS registration of the network adapter and its +// settings by typing "ipconfig /registerdns" at the command prompt. If +// problems still persist, contact your DNS server or network systems +// administrator. See event details for specific error code information. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_SECURITY 0x80002B92L + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_OTHER +// +// MessageText: +// +// The system failed to register network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the DNS update request could not be completed was because +// of a system problem. You can manually retry DNS registration of the +// network adapter and its settings by typing "ipconfig /registerdns" +// at the command prompt. If problems still persist, contact your DNS +// server or network systems administrator. See event details for +// specific error code information. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_OTHER 0x80002B93L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_TIMEOUT +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The reason that the system could not register these RRs was because the +// update request that was sent to the specified DNS server timed out. This +// is probably because the authoritative DNS server for the name being +// registered is not running.%n%n You can manually retry DNS registration +// of the network adapter and its settings by typing "ipconfig /registerdns" +// at the command prompt. If problems still persist, contact your DNS +// server or network systems administrator. See event details for specific +// error code information. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_TIMEOUT 0x80002B94L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_SERVERFAIL +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The cause was DNS server failure. This may because the reverse lookup +// zone is busy or missing on the DNS server that your computer needs to +// update. In most cases, this is a minor problem because it does not +// affect normal (forward) name resolution.%n%n If reverse (address-to-name) +// resolution is required for your computer, you can manually retry DNS +// registration of the network adapter and its settings by typing +// "ipconfig /registerdns" at the command prompt. If problems still +// persist, contact your DNS server or network systems administrator. +// See event details for specific error code information. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_SERVERFAIL 0x80002B95L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_NOTSUPP +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The reason that the system could not register these RRs was because +// (a) either the DNS server does not support the DNS dynamic update +// protocol, or (b) the authoritative zone where these records are to +// be registered does not allow dynamic updates.%n%n +// To register DNS pointer (PTR) resource records using the specific +// DNS domain name and IP addresses for this adapter, contact your +// DNS server or network systems administrator. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_NOTSUPP 0x80002B96L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_REFUSED +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The reason that the system could not register these RRs was because +// the DNS server refused the update request. The cause of this could +// be (a) your computer is not allowed to update the adapter-specified DNS +// domain name, or (b) because the DNS server authoritative for the specified +// name does not support the DNS dynamic update protocol.%n%n +// To register the DNS pointer (PTR) resource records using the specific +// DNS domain name and IP addresses for this adapter, contact your DNS +// server or network systems administrator. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_REFUSED 0x80002B97L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_SECURITY +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The reason that the system could not register these RRs was because +// of a security related problem. The cause of this could be (a) your +// computer does not have permissions to register and update the specific +// DNS domain name set for this adapter, or (b) there might have been a +// problem negotiating valid credentials with the DNS server during the +// processing of the update request.%n%n +// You can manually retry DNS registration of the network adapter and +// its settings by typing "ipconfig /registerdns" at the command prompt. +// If problems still persist, contact your DNS server or network systems +// administrator. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_SECURITY 0x80002B98L + +// +// MessageId: EVENT_DNSAPI_PTR_REGISTRATION_FAILED_OTHER +// +// MessageText: +// +// The system failed to register pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The reason the system could not register these RRs during the +// update request was because of a system problem. You can manually +// retry DNS registration of the network adapter and its settings by +// typing "ipconfig /registerdns" at the command prompt. If problems +// still persist, contact your DNS server or network systems +// administrator. See event details for specific error code information. +// +#define EVENT_DNSAPI_PTR_REGISTRATION_FAILED_OTHER 0x80002B99L + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_TIMEOUT_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not register these RRs was because the +// update request it sent to the DNS server timed out. The most likely +// cause of this is that the DNS server authoritative for the name it +// was attempting to register or update is not running at this time.%n%n +// You can manually retry DNS registration of the network adapter and +// its settings by typing "ipconfig /registerdns" at the command prompt. +// If problems still persist, contact your DNS server or network systems +// administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_TIMEOUT_PRIMARY_DN 0x80002B9AL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_SERVERFAIL_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not register these RRs was because the +// DNS server failed the update request. The most likely cause of this +// is that the authoritative DNS server required to process this update +// request has a lock in place on the zone, probably because a zone +// transfer is in progress.%n%n +// You can manually retry DNS registration of the network adapter and +// its settings by typing "ipconfig /registerdns" at the command prompt. +// If problems still persist, contact your DNS server or network systems +// administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_SERVERFAIL_PRIMARY_DN 0x80002B9BL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_NOTSUPP_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// Either the DNS server does not support the DNS dynamic update protocol +// or the authoritative zone for the specified DNS domain name does not +// accept dynamic updates.%n%n +// To register the DNS host (A or AAAA) resource records using the specific +// DNS domain name and IP addresses for this adapter, contact your DNS +// server or network systems administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_NOTSUPP_PRIMARY_DN 0x80002B9CL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_REFUSED_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not register these RRs was because the +// DNS server contacted refused the update request. The reasons for this +// might be (a) you are not allowed to update the specified DNS domain name, +// or (b) because the DNS server authoritative for this name does not support +// the DNS dynamic update protocol.%n%n +// To register the DNS host (A or AAAA) resource records using the specific DNS +// domain name and IP addresses for this adapter, contact your DNS server +// or network systems administrator. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_REFUSED_PRIMARY_DN 0x80002B9DL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_SECURITY_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not register these RRs was because of a +// security related problem. The cause of this could be (a) your computer +// does not have permissions to register and update the specific DNS domain +// name set for this adapter, or (b) there might have been a problem negotiating +// valid credentials with the DNS server during the processing of the update +// request.%n%n +// You can manually retry DNS registration of the network adapter and +// its settings by typing "ipconfig /registerdns" at the command prompt. +// If problems still persist, contact your DNS server or network systems +// administrator. See event details for specific error code information. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_SECURITY_PRIMARY_DN 0x80002B9EL + +// +// MessageId: EVENT_DNSAPI_REGISTRATION_FAILED_OTHER_PRIMARY_DN +// +// MessageText: +// +// The system failed to register host (A or AAAA) resource records (RRs) for +// network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not register these RRs during the +// update request was because of a system problem. You can manually +// retry DNS registration of the network adapter and its settings by +// typing "ipconfig /registerdns" at the command prompt. If problems +// still persist, contact your DNS server or network systems +// administrator. See event details for specific error code information. +// +#define EVENT_DNSAPI_REGISTRATION_FAILED_OTHER_PRIMARY_DN 0x80002B9FL + + +// +// Deregistration update errors +// + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_TIMEOUT +// +// MessageText: +// +// The system failed to update and remove registration for the +// network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason for this failure is because the DNS server it sent the update +// request to timed out. The most likely cause of this failure is that the +// DNS server authoritative for the zone where the registration was originally +// made is either not running or unreachable through the network at this time. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_TIMEOUT 0x80002BACL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_SERVERFAIL +// +// MessageText: +// +// The system failed to update and remove registration for the +// network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason for this failure is because the DNS server it sent the update +// to failed the update request. A possible cause of this failure is that +// the DNS server required to process this update request has a lock in place +// on the zone, probably because a zone transfer is in progress.%n%n +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_SERVERFAIL 0x80002BADL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_NOTSUPP +// +// MessageText: +// +// The system failed to update and remove registration for the network +// adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason for this failure is because the DNS server sent the update +// either (a) does not support the DNS dynamic update protocol, or (b) the +// authoritative zone for the specified DNS domain name does not currently +// accept DNS dynamic updates. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_NOTSUPP 0x80002BAEL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_REFUSED +// +// MessageText: +// +// The system failed to update and remove registration for the network +// adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not perform the update request was the +// DNS server contacted refused update request. The cause of this is +// (a) this computer is not allowed to update the specified DNS domain +// name, or (b) because the DNS server authoritative for the zone that +// requires updating does not support the DNS dynamic update protocol. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_REFUSED 0x80002BAFL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_SECURITY +// +// MessageText: +// +// The system failed to update and remove registration for the network +// adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the system could not perform the update request was because +// of a security related problem. The cause of this could be (a) your computer +// does not have permissions to register and update the specific DNS domain +// name set for this adapter, or (b) there might have been a problem negotiating +// valid credentials with the DNS server during the processing of the update +// request.%n%n +// See event details for specific error code information. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_SECURITY 0x80002BB0L + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_OTHER +// +// MessageText: +// +// The system failed to update and remove the DNS registration for the +// network adapter with settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The system could not update to remove this DNS registration because of +// a system problem. See event details for specific error code information. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_OTHER 0x80002BB1L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_TIMEOUT +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because the update request +// timed out while awaiting a response from the DNS server. This is probably +// because the DNS server authoritative for the zone that requires update +// is not running. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_TIMEOUT 0x80002BB2L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_SERVERFAIL +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because the DNS server failed the +// update request. A possible cause is that a zone transfer is in progress, +// causing a lock for the zone at the DNS server authorized to perform the +// updates for these RRs. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_SERVERFAIL 0x80002BB3L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_NOTSUPP +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because either the DNS server +// does not support the DNS dynamic update protocol or the authoritative zone +// that contains these RRs does not accept dynamic updates. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_NOTSUPP 0x80002BB4L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_REFUSED +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because the DNS server refused the +// update request. The cause of this might be (a) this computer is not allowed +// to update the specified DNS domain name specified by these settings, or +// (b) because the DNS server authorized to perform updates for the zone that +// contains these RRs does not support the DNS dynamic update protocol. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_REFUSED 0x80002BB5L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_SECURITY +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because of a security related +// problem. The cause of this could be that (a) your computer does not have +// permissions to remove and update the specific DNS domain name or IP addresses +// configured for this adapter, or (b) there might have been a problem negotiating +// valid credentials with the DNS server during the processing of the update +// request. See event details for specific error code information. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_SECURITY 0x80002BB6L + +// +// MessageId: EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_OTHER +// +// MessageText: +// +// The system failed to update and remove pointer (PTR) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address : %6%n%n +// The system could not remove these PTR RRs because because of a system +// problem. See event details for specific error code information. +// +#define EVENT_DNSAPI_PTR_DEREGISTRATION_FAILED_OTHER 0x80002BB7L + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_TIMEOUT_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The system could not remove these host (A or AAAA) RRs because the update request +// timed out while awaiting a response from the DNS server. This is probably because +// the DNS server authoritative for the zone where these RRs need to be updated +// is either not currently running or reachable on the network. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_TIMEOUT_PRIMARY_DN 0x80002BB8L + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_SERVERFAIL_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The system could not remove these host (A or AAAA) RRs because the DNS server +// failed the update request. A possible cause is that a zone transfer is in progress, +// causing a lock for the zone at the DNS server authorized to perform the +// updates for these RRs. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_SERVERFAIL_PRIMARY_DN 0x80002BB9L + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_NOTSUPP_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason for this failure is because the DNS server sent the update +// either (a) does not support the DNS dynamic update protocol, or (b) the +// authoritative zone for the DNS domain name specified in these host (A or AAAA) +// RRs does not currently accept DNS dynamic updates. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_NOTSUPP_PRIMARY_DN 0x80002BBAL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_REFUSED_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The request to remove these records failed because the DNS server refused +// the update request. The cause of this might be that either (a) this +// computer is not allowed to update the DNS domain name specified by these +// settings, or (b) because the DNS server authorized to perform updates for +// the zone that contains these RRs does not support the DNS dynamic update +// protocol. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_REFUSED_PRIMARY_DN 0x80002BBBL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_SECURITY_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason for this failure was because of a security related problem. +// The cause of this could be that (a) your computer does not have permissions +// to remove and update the specific DNS domain name or IP addresses +// configured for this adapter, or (b) there might have been a problem +// negotiating valid credentials with the DNS server during the processing of +// the update request. See event details for specific error code information. +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_SECURITY_PRIMARY_DN 0x80002BBCL + +// +// MessageId: EVENT_DNSAPI_DEREGISTRATION_FAILED_OTHER_PRIMARY_DN +// +// MessageText: +// +// The system failed to update and remove host (A or AAAA) resource records (RRs) +// for network adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6%n%n +// The reason the update request failed was because of a system problem. +// See event details for specific error code information +// +#define EVENT_DNSAPI_DEREGISTRATION_FAILED_OTHER_PRIMARY_DN 0x80002BBDL + + +// +// Information +// + +// +// MessageId: EVENT_DNSAPI_REGISTERED_ADAPTER +// +// MessageText: +// +// The system registered network adapter with settings :%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6 +// +#define EVENT_DNSAPI_REGISTERED_ADAPTER 0x40002BC0L + +// +// MessageId: EVENT_DNSAPI_REGISTERED_PTR +// +// MessageText: +// +// The system registered pointer (PTR) resource records (RRs) for network +// adapter%nwith settings:%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Adapter-specific Domain Suffix : %3%n +// Primary Domain Suffix : %4%n +// DNS server list :%n +// %5%n +// Sent update to server : %6%n +// IP Address : %7 +// +#define EVENT_DNSAPI_REGISTERED_PTR 0x40002BC1L + +// +// MessageId: EVENT_DNSAPI_REGISTERED_ADAPTER_PRIMARY_DN +// +// MessageText: +// +// The system registered host (A or AAAA) resource records (RRs) for network +// adapter%nwith settings :%n%n +// Adapter Name : %1%n +// Host Name : %2%n +// Primary Domain Suffix : %3%n +// DNS server list :%n +// %4%n +// Sent update to server : %5%n +// IP Address(es) :%n +// %6 +// +#define EVENT_DNSAPI_REGISTERED_ADAPTER_PRIMARY_DN 0x40002BC2L + + +///////////////////////////////////////////////////////////////////////// +// +// Trk Services Events (12500-12999) +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: EVENT_TRK_INTERNAL_ERROR +// +// MessageText: +// +// An internal error occured in Distributed Link Tracking. The error code was %1. +// +#define EVENT_TRK_INTERNAL_ERROR 0xC00030D4L + +// +// MessageId: EVENT_TRK_SERVICE_START_SUCCESS +// +// MessageText: +// +// Service started successfully +// +#define EVENT_TRK_SERVICE_START_SUCCESS 0x400030D5L + +// +// MessageId: EVENT_TRK_SERVICE_START_FAILURE +// +// MessageText: +// +// Service failed to start. Error = %1 +// +#define EVENT_TRK_SERVICE_START_FAILURE 0xC00030D6L + +// +// MessageId: EVENT_TRK_SERVICE_CORRUPT_LOG +// +// MessageText: +// +// The Distributed Link Tracking log was corrupt on volume %1: and has been re-created. This log is used to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. +// +#define EVENT_TRK_SERVICE_CORRUPT_LOG 0xC00030D7L + +// +// MessageId: EVENT_TRK_SERVICE_VOL_QUOTA_EXCEEDED +// +// MessageText: +// +// The Distributed Link Tracking volume ID quota on this machine has been exceeded. As a result, it is not possible to create new volume IDs. Distributed Link Tracking normally uses these volume IDs to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. +// +#define EVENT_TRK_SERVICE_VOL_QUOTA_EXCEEDED 0x800030D8L + +// +// MessageId: EVENT_TRK_SERVICE_VOLUME_CREATE +// +// MessageText: +// +// A new volume ID has been assigned for %1:%n%2%n%n +// This ID is used by Distributed Link Tracking to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. If there previously were links to files on this volume that are broken, they might not be automatically repairable. +// +#define EVENT_TRK_SERVICE_VOLUME_CREATE 0x400030D9L + +// +// MessageId: EVENT_TRK_SERVICE_VOLUME_CLAIM +// +// MessageText: +// +// Ownership of the volume ID for %1: has been successfully claimed. This volume ID is used by Distributed Link Tracking to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. +// +#define EVENT_TRK_SERVICE_VOLUME_CLAIM 0x400030DAL + +// +// MessageId: EVENT_TRK_SERVICE_DUPLICATE_VOLIDS +// +// MessageText: +// +// The volume ID for %1: has been reset, since it was a duplicate of that on %2:. This volume ID is used by Distributed Link Tracking to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. +// +#define EVENT_TRK_SERVICE_DUPLICATE_VOLIDS 0x400030DBL + +// +// MessageId: EVENT_TRK_SERVICE_MOVE_QUOTA_EXCEEDED +// +// MessageText: +// +// The move table quota for Distributed Link Tracking in this domain has been exceeded. This table is used by Distributed Link Tracking to automatically repair file links, such as Shell Shortcuts and OLE links, when for some reason those links become broken. While this quota is exceeded, it may not be possible to automatically repair some such broken links. +// +#define EVENT_TRK_SERVICE_MOVE_QUOTA_EXCEEDED 0x800030DCL + + +///////////////////////////////////////////////////////////////////////// +// +// ATM Protocol Events (13000-13499) +// +///////////////////////////////////////////////////////////////////////// + +// ATM is removed from the OS so all strings that related to ATM are removed. + +///////////////////////////////////////////////////////////////////////// +// +// File Replication Service (NtFrs) Events (13500-13999) +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: EVENT_FRS_ERROR +// +// MessageText: +// +// File Replication Service +// +#define EVENT_FRS_ERROR 0xC00034BCL + +// +// MessageId: EVENT_FRS_STARTING +// +// MessageText: +// +// The File Replication Service is starting. +// +#define EVENT_FRS_STARTING 0x400034BDL + +// +// MessageId: EVENT_FRS_STOPPING +// +// MessageText: +// +// The File Replication Service is stopping. +// +#define EVENT_FRS_STOPPING 0x400034BEL + +// +// MessageId: EVENT_FRS_STOPPED +// +// MessageText: +// +// The File Replication Service has stopped. +// +#define EVENT_FRS_STOPPED 0x400034BFL + +// +// MessageId: EVENT_FRS_STOPPED_FORCE +// +// MessageText: +// +// The File Replication Service stopped without cleaning up. +// +#define EVENT_FRS_STOPPED_FORCE 0xC00034C0L + +// +// MessageId: EVENT_FRS_STOPPED_ASSERT +// +// MessageText: +// +// The File Replication Service has stopped after taking an assertion failure. +// +#define EVENT_FRS_STOPPED_ASSERT 0xC00034C1L + +// +// MessageId: EVENT_FRS_ASSERT +// +// MessageText: +// +// The File Replication Service failed a consistency check +// %n (%3) +// %nin "%1" at line %2. +// %n +// %nThe File Replication Service will restart automatically at a later time. +// If this problem persists a subsequent entry in this event log describes the +// recovery procedure. +// %n +// For more information about the automatic restart right click on +// My Computer and then click on Manage, System Tools, Services, +// File Replication Service, and Recovery. +// +#define EVENT_FRS_ASSERT 0xC00034C2L + +// +// MessageId: EVENT_FRS_VOLUME_NOT_SUPPORTED +// +// MessageText: +// +// The File Replication Service cannot start replica set %1 on computer %2 +// for directory %3 because the type of volume %4 is not NTFS 5.0 or later. +// %n +// %nThe volume's type can be found by typing "chkdsk %4". +// %n +// %nThe volume can be upgraded to NTFS 5.0 or later by typing "chkntfs /E %4". +// +#define EVENT_FRS_VOLUME_NOT_SUPPORTED 0xC00034C3L + +// +// MessageId: EVENT_FRS_LONG_JOIN +// +// MessageText: +// +// The File Replication Service is having trouble enabling replication +// from %1 to %2 for %3 using the DNS name %4. FRS will keep retrying. +// %n Following are some of the reasons you would see this warning. +// %n +// %n [1] FRS can not correctly resolve the DNS name %4 from this computer. +// %n [2] FRS is not running on %4. +// %n [3] The topology information in the Active Directory for this replica has not +// yet replicated to all the Domain Controllers. +// %n +// %n This event log message will appear once per connection, After the problem +// is fixed you will see another event log message indicating that the connection +// has been established. +// +#define EVENT_FRS_LONG_JOIN 0x800034C4L + +// +// MessageId: EVENT_FRS_LONG_JOIN_DONE +// +// MessageText: +// +// The File Replication Service has enabled replication from %1 to %2 for %3 +// after repeated retries. +// +#define EVENT_FRS_LONG_JOIN_DONE 0x800034C5L + +// +// MessageId: EVENT_FRS_CANNOT_COMMUNICATE +// +// MessageText: +// +// The File Replication Service on the computer %1 cannot communicate with +// the File Replication Service on the computer %2. +// %n +// %nVerify that the computer %2 is up and running. +// %n +// %nVerify that the File Replication Service is running on %2 by +// typing "net start ntfrs" on %2. +// %n +// %nVerify that the network is functioning between %1 and %2 by +// typing "ping %1" on %2 and "ping %2" on %1. +// If the pings succeed then retry the failed operation. +// If the pings fail then there may be problems with the DNS server. +// %n +// %nThe DNS server is responsible for mapping computer names to IP addresses. +// The commands "ipconfig" and "nslookup" help diagnose problems with the +// DNS server. +// %n +// %nTyping "ipconfig /all" will list the computer's IP address and the IP +// address of the computer's DNS servers. Type "ping " +// to verify that a DNS server is available. The DNS mapping for %2 or %1 +// can be verified by typing "nslookup" and then typing "%2" and then "%1" +// on %1 and %2. Be sure to check out the DNS server on both %1 and %2; +// a DNS problem on either computer will prevent proper communication. +// %n +// %nSome network problems between %1 and %2 can be cleared up by flushing +// the DNS Resolver Cache. Type "ipconfig /flushdns". +// %n +// %nSome network problems between %1 and %2 can be cleared up by renewing +// the IP address. Type "ipconfig /release" followed by "ipconfig /renew". +// %n +// %nSome network problems between %1 and %2 can be cleared up by resetting +// the computer's DNS entry. Type "net stop NetLogon" followed by +// "net start NetLogon". +// %n +// %nSome problems between %1 and %2 can be cleared up by restarting +// the File Replication Service. Type "net stop ntfrs" followed by +// "net start ntfrs". +// %n +// %nSome problems between %1 and %2 can be cleared up by restarting +// the computers %1 and %2 AFTER CLOSING RUNNING APPLIATIONS, +// especially dcpromo. Click on Start, Shutdown, select Restart, and +// click on OK. +// %n +// %nOther network and computer problems are beyond the scope of +// this event log message. +// +#define EVENT_FRS_CANNOT_COMMUNICATE 0xC00034C6L + +// +// MessageId: EVENT_FRS_DATABASE_SPACE +// +// MessageText: +// +// The File Replication Service is stopping on computer %1 because there is no free +// space on the volume containing %2. +// %n +// %nThe available space on the volume can be found by typing +// "dir %2". +// %n +// %nOnce free space is made available on the volume containing %2, +// the File Replication Service can be restarted immediately by typing +// "net start ntfrs". Otherwise, the File Replication Service will +// restart automatically at a later time. +// %n +// %nFor more information about the automatic restart right click on +// My Computer and then click on Manage, System Tools, Services, File +// Replication Service, and Recovery. +// %n +// %nFor more information about managing space on a volume type "copy /?", +// "rename /?", "del /?", "rmdir /?", and "dir /?". +// +#define EVENT_FRS_DATABASE_SPACE 0xC00034C7L + +// +// MessageId: EVENT_FRS_DISK_WRITE_CACHE_ENABLED +// +// MessageText: +// +// The File Replication Service has detected an enabled disk write cache +// on the drive containing the directory %2 on the computer %1. +// The File Replication Service might not recover when power to the +// drive is interrupted and critical updates are lost. +// +#define EVENT_FRS_DISK_WRITE_CACHE_ENABLED 0x800034C8L + +// +// MessageId: EVENT_FRS_JET_1414 +// +// MessageText: +// +// The File Replication Service on computer %1 is stopping because the +// database %2 is corrupted. +// %n +// %nThe database can be recovered by typing "esentutl /d %2 /l%3 /s%4". +// %n +// %nOnce the database has been successfully recovered the +// File Replication Service can be restarted by typing "net start ntfrs". +// +#define EVENT_FRS_JET_1414 0xC00034C9L + +// +// MessageId: EVENT_FRS_SYSVOL_NOT_READY +// +// MessageText: +// +// The File Replication Service may be preventing the computer %1 from becoming a +// domain controller while the system volume is being initialized with data +// from another domain controller and then shared as SYSVOL. +// %n +// %nType "net share" to check for the SYSVOL share. The File Replication +// Service has stopped preventing the computer from becoming a domain +// controller once the SYSVOL share appears. +// %n +// %nThe initialization of the system volume can take some time. +// The time is dependent on the amount of data in the system volume, +// the availability of other domain controllers, and the replication +// interval between domain controllers. +// +#define EVENT_FRS_SYSVOL_NOT_READY 0x800034CAL + +// +// MessageId: EVENT_FRS_SYSVOL_NOT_READY_PRIMARY +// +// MessageText: +// +// The File Replication Service may be preventing the computer %1 from becoming a +// domain controller while the system volume is being initialized and then +// shared as SYSVOL. +// %n +// %nType "net share" to check for the SYSVOL share. The File Replication +// Service has stopped preventing the computer from becoming a domain +// controller once the SYSVOL share appears. +// %n +// %nThe initialization of the system volume can take some time. +// The time is dependent on the amount of data in the system volume. +// %n +// %nThe initialization of the system volume can be bypassed by first typing +// regedt32 and setting the value of SysvolReady to 1 and then restarting +// the Netlogon service. +// %n +// %nWARNING - BYPASSING THE SYSTEM VOLUME INITIALIZATION IS NOT RECOMMENDED. +// Applications may fail in unexpected ways. +// %n +// %nThe value SysvolReady is located by clicking on HKEY_LOCAL_MACHINE +// and then clicking on System, CurrentControlSet, Services, Netlogon, +// and Parameters. +// %n +// %nThe Netlogon service can be restarted by typing "net stop netlogon" +// followed by "net start netlogon". +// +#define EVENT_FRS_SYSVOL_NOT_READY_PRIMARY 0x800034CBL + +// +// MessageId: EVENT_FRS_SYSVOL_READY +// +// MessageText: +// +// The File Replication Service is no longer preventing the computer %1 from +// becoming a domain controller. The system volume has been successfully +// initialized and the Netlogon service has been notified that the system +// volume is now ready to be shared as SYSVOL. +// %n +// %nType "net share" to check for the SYSVOL share. +// +#define EVENT_FRS_SYSVOL_READY 0x400034CCL + +// +// MessageId: EVENT_FRS_ACCESS_CHECKS_DISABLED +// +// MessageText: +// +// The File Replication Service will not check access to the API "%1". +// %n +// %nAccess checks can be enabled for "%1" by running regedt32. +// %n +// %nClick on Start, Run, and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, Access Checks, "%1", and "%2". +// Change the string to Enabled. +// %n +// %nPermissions can be changed by highlighting "%1" and then clicking on the +// toolbar option Security and then Permissions... +// +#define EVENT_FRS_ACCESS_CHECKS_DISABLED 0x800034CDL + +// +// MessageId: EVENT_FRS_ACCESS_CHECKS_FAILED_USER +// +// MessageText: +// +// The File Replication Service did not grant the user "%3" access to the +// API "%1". +// %n +// %nPermissions for "%1" can be changed by running regedt32. +// %n +// %nClick on Start, Run, and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, Access Checks, and highlight "%1". +// Click on the toolbar option Security and then Permissions... +// %n +// %nAccess checks can be disabled for "%1". Double click on "%2" and +// change the string to Disabled. +// +#define EVENT_FRS_ACCESS_CHECKS_FAILED_USER 0x800034CEL + +// +// MessageId: EVENT_FRS_ACCESS_CHECKS_FAILED_UNKNOWN +// +// MessageText: +// +// The File Replication Service could not grant an unknown user access to the +// API "%1". +// %n +// %nAccess checks can be disabled for "%1" by running regedt32. +// %n +// %nClick on Start, Run, and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, Access Checks, "%1", and "%2". +// Change the string to Disabled. +// %n +// %nPermissions can be changed by highlighting "%1" and then clicking on the +// toolbar option Security and then Permissions... +// +#define EVENT_FRS_ACCESS_CHECKS_FAILED_UNKNOWN 0xC00034CFL + +// +// MessageId: EVENT_FRS_MOVED_PREEXISTING +// +// MessageText: +// +// The File Replication Service moved the preexisting files in %1 to %2. +// %n +// %nThe File Replication Service may delete the files in %2 at any time. +// Files can be saved from deletion by copying them out of %2. Copying +// the files into %1 may lead to name conflicts if the files already exist +// on some other replicating partner. +// %n +// %nIn some cases, the File Replication Service may copy a file +// from %2 into %1 instead of replicating the file from some other +// replicating partner. +// %n +// %nSpace can be recovered at any time by deleting the files in %2. +// +#define EVENT_FRS_MOVED_PREEXISTING 0x800034D0L + +// +// MessageId: EVENT_FRS_CANNOT_START_BACKUP_RESTORE_IN_PROGRESS +// +// MessageText: +// +// The File Replication Service cannot enable replication on the comptuer %1 +// until a backup/restore application completes. +// %n +// %nA backup/restore application has set a registry key that +// prevents the File Replication Service from starting until the registry +// key is deleted or the system is rebooted. +// %n +// %nThe backup/restore application may still be running. Check with your +// local administrator before proceeding further. +// %n +// %nThe computer can be rebooted by clicking on Start, Shutdown, and +// selecting Restart. +// %n +// %nWARNING - DELETING THE REGISTRY KEY IS NOT RECOMMENDED! +// Applications may fail in unexpected ways. +// %n +// %nThe registry key can be deleted by running regedt32. +// %n +// %nClick on Start, Run, and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, Backup/Restore, +// "Stop NtFrs from Starting". On the toolbar, click on Edit and select +// Delete. Be careful! Deleting a key other than "Stop NtFrs From Starting" +// can have unexpected sideeffects. +// +#define EVENT_FRS_CANNOT_START_BACKUP_RESTORE_IN_PROGRESS 0xC00034D1L + +// +// MessageId: EVENT_FRS_STAGING_AREA_FULL +// +// MessageText: +// +// The File Replication Service paused because the staging area is full. +// Replication will resume if staging space becomes available or if the +// staging space limit is increased. +// %n +// %nThe current value of the staging space limit is %1 KB. +// %n +// %nTo change the staging space limit, run regedt32. +// %n +// %nClick on Start, Run and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, and the value +// "Staging Space Limit in KB". +// +#define EVENT_FRS_STAGING_AREA_FULL 0x800034D2L + +// +// MessageId: EVENT_FRS_HUGE_FILE +// +// MessageText: +// +// The File Replication Service paused because the size of a file exceeds the +// staging space limit. Replication will resume only if the staging space limit +// is increased. +// %n +// %nThe staging space limit is %1 KB and the file size is %2 KB. +// %n +// %nTo change the staging space limit, run regedt32. +// %n +// %nClick on Start, Run and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. Double click on SYSTEM, +// CurrentControlSet, Services, NtFrs, Parameters, and the value +// "Staging Space Limit in KB". +// +#define EVENT_FRS_HUGE_FILE 0x800034D3L + +// +// MessageId: EVENT_FRS_CANNOT_CREATE_UUID +// +// MessageText: +// +// The File Replication Service is stopping on the computer %1 because +// a universally unique ID (UUID) cannot be created. +// %n +// %nThe SDK function UuidCreate() returned the error "%2". +// %n +// %nThe problem may be the lack of an Ethernet address, +// token ring address, or network address. The lack of a network +// address implies an unsupported netcard. +// %n +// %nThe File Replication Service will restart automatically at a later time. +// For more information about the automatic restart right click on +// My Computer and then click on Manage, System Tools, Services, +// File Replication Service, and Recovery. +// +#define EVENT_FRS_CANNOT_CREATE_UUID 0xC00034D4L + +// +// MessageId: EVENT_FRS_NO_DNS_ATTRIBUTE +// +// MessageText: +// +// The File Replication Service cannot find the DNS name for the computer %1 +// because the "%2" attribute could not be read from the distinguished +// name "%3". +// %n +// %nThe File Replication Service will try using the name "%1" until the +// computer's DNS name appears. +// +#define EVENT_FRS_NO_DNS_ATTRIBUTE 0x800034D5L + +// +// MessageId: EVENT_FRS_NO_SID +// +// MessageText: +// +// The File Replication Service cannot replicate %1 with the computer +// %2 because the computer's SID cannot be determined from the distinguished +// name "%3". +// %n +// %nThe File Replication Service will retry later. +// +#define EVENT_FRS_NO_SID 0xC00034D6L + +// +// MessageId: NTFRSPRF_OPEN_RPC_BINDING_ERROR_SET +// +// MessageText: +// +// The RPC binding failed in the Open function of the FileReplicaSet Object. The +// counter data for this object will not be available. The FileReplicaSet object +// contains the performance counters of the Replica sets whose files are being +// replicated by the File Replication Service. +// +#define NTFRSPRF_OPEN_RPC_BINDING_ERROR_SET 0xC00034D7L + +// +// MessageId: NTFRSPRF_OPEN_RPC_BINDING_ERROR_CONN +// +// MessageText: +// +// The RPC binding failed in the Open function of the FileReplicaConn Object. The +// counter data for this object will not be available. The FileReplicaConn object +// contains the performance counters of the connections over which files are being +// replicated by the File Replication Service. +// +#define NTFRSPRF_OPEN_RPC_BINDING_ERROR_CONN 0xC00034D8L + +// +// MessageId: NTFRSPRF_OPEN_RPC_CALL_ERROR_SET +// +// MessageText: +// +// The RPC call failed in the Open function of the FileReplicaSet Object. The +// counter data for this object will not be available. The FileReplicaSet object +// contains the performance counters of the Replica sets whose files are being +// replicated by the File Replication Service. +// +#define NTFRSPRF_OPEN_RPC_CALL_ERROR_SET 0xC00034D9L + +// +// MessageId: NTFRSPRF_OPEN_RPC_CALL_ERROR_CONN +// +// MessageText: +// +// The RPC call failed in the Open function of the FileReplicaConn Object. The +// counter data for this object will not be available. The FileReplicaConn object +// contains the performance counters of the connections over which files are being +// replicated by the File Replication Service. +// +#define NTFRSPRF_OPEN_RPC_CALL_ERROR_CONN 0xC00034DAL + +// +// MessageId: NTFRSPRF_COLLECT_RPC_BINDING_ERROR_SET +// +// MessageText: +// +// The RPC binding failed in the Collect function of the FileReplicaSet Object. The +// counter data for this object will not be available till the binding succeeds. +// The FileReplicaSet object contains the performance counters of the Replica sets +// whose files are being replicated by the File Replication Service. +// +#define NTFRSPRF_COLLECT_RPC_BINDING_ERROR_SET 0xC00034DBL + +// +// MessageId: NTFRSPRF_COLLECT_RPC_BINDING_ERROR_CONN +// +// MessageText: +// +// The RPC binding failed in the Collect function of the FileReplicaConn Object. +// The counter data for this object will not be available till the binding +// succeeds. The FileReplicaConn object contains the performance counters of the +// connections over which files are being replicated by the File Replication +// Service. +// +#define NTFRSPRF_COLLECT_RPC_BINDING_ERROR_CONN 0xC00034DCL + +// +// MessageId: NTFRSPRF_COLLECT_RPC_CALL_ERROR_SET +// +// MessageText: +// +// The RPC call failed in the Collect function of the FileReplicaSet Object. The +// counter data for this object will not be available till the call succeeds. The +// FileReplicaSet object contains the performance counters of the Replica sets +// whose files are being replicated by the File Replication Service. +// +#define NTFRSPRF_COLLECT_RPC_CALL_ERROR_SET 0xC00034DDL + +// +// MessageId: NTFRSPRF_COLLECT_RPC_CALL_ERROR_CONN +// +// MessageText: +// +// The RPC call failed in the Collect function of the FileReplicaConn Object. The +// counter data for this object will not be available till the call succeeds. The +// FileReplicaConn object contains the performance counters of the connections over +// which files are being replicated by the File Replication Service. +// +#define NTFRSPRF_COLLECT_RPC_CALL_ERROR_CONN 0xC00034DEL + +// +// MessageId: NTFRSPRF_VIRTUALALLOC_ERROR_SET +// +// MessageText: +// +// The call to VirtualAlloc failed in the Open function of the FileReplicaSet +// Object. The counter data for this object will not be available. The +// FileReplicaSet object contains the performance counters of the Replica sets +// whose files are being replicated by the File Replication Service. +// +#define NTFRSPRF_VIRTUALALLOC_ERROR_SET 0xC00034DFL + +// +// MessageId: NTFRSPRF_VIRTUALALLOC_ERROR_CONN +// +// MessageText: +// +// The call to VirtualAlloc failed in the Open function of the FileReplicaConn +// Object. The counter data for this object will not be available. The +// FileReplicaConn object contains the performance counters of the connections over +// which files are being replicated by the File Replication Service. +// +#define NTFRSPRF_VIRTUALALLOC_ERROR_CONN 0xC00034E0L + +// +// MessageId: NTFRSPRF_REGISTRY_ERROR_SET +// +// MessageText: +// +// The call to the Registry failed in the Open function of the FileReplicaSet +// Object. The counter data for this object will not be available. The +// FileReplicaSet object contains the performance counters of the Replica sets +// whose files are being replicated by the File Replication Service. +// +#define NTFRSPRF_REGISTRY_ERROR_SET 0xC00034E1L + +// +// MessageId: NTFRSPRF_REGISTRY_ERROR_CONN +// +// MessageText: +// +// The call to the Registry failed in the Open function of the FileReplicaConn +// Object. The counter data for this object will not be available. The +// FileReplicaConn object contains the performance counters of the connections over +// which files are being replicated by the File Replication Service. +// +#define NTFRSPRF_REGISTRY_ERROR_CONN 0xC00034E2L + +// +// MessageId: EVENT_FRS_ROOT_NOT_VALID +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because the +// pathname of the replicated directory is not the fully qualified +// pathname of an existing, accessible local directory. +// +#define EVENT_FRS_ROOT_NOT_VALID 0xC00034E3L + +// +// MessageId: EVENT_FRS_STAGE_NOT_VALID +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because the pathname +// of the customer designated staging directory: +// %n %2 +// %n is not the fully qualified pathname of an existing, accessible local directory. +// +#define EVENT_FRS_STAGE_NOT_VALID 0xC00034E4L + +// +// MessageId: EVENT_FRS_OVERLAPS_LOGGING +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because it overlaps +// the File Replication Service's logging pathname %2. +// +#define EVENT_FRS_OVERLAPS_LOGGING 0xC00034E5L + +// +// MessageId: EVENT_FRS_OVERLAPS_WORKING +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because it overlaps +// the File Replication Service's working directory %2. +// +#define EVENT_FRS_OVERLAPS_WORKING 0xC00034E6L + +// +// MessageId: EVENT_FRS_OVERLAPS_STAGE +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because it overlaps +// the staging directory %2. +// +#define EVENT_FRS_OVERLAPS_STAGE 0xC00034E7L + +// +// MessageId: EVENT_FRS_OVERLAPS_ROOT +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because it overlaps +// the replicating directory %2. +// +#define EVENT_FRS_OVERLAPS_ROOT 0xC00034E8L + +// +// MessageId: EVENT_FRS_OVERLAPS_OTHER_STAGE +// +// MessageText: +// +// The File Replication Service cannot replicate %1 because it overlaps +// the staging directory %2 of the replicating directory %3. +// +#define EVENT_FRS_OVERLAPS_OTHER_STAGE 0xC00034E9L + +// +// MessageId: EVENT_FRS_PREPARE_ROOT_FAILED +// +// MessageText: +// +// The File Replication Service could not prepare the root directory +// %1 for replication. This is likely due to a problem creating the +// root directory or a problem removing preexisting files in the root +// directory. +// %n +// %nCheck that the path leading up to the root directory exists and is +// accessible. +// +#define EVENT_FRS_PREPARE_ROOT_FAILED 0xC00034EAL + +// +// MessageId: EVENT_FRS_BAD_REG_DATA +// +// MessageText: +// +// The File Replication Service detected an invalid parameter value in the +// registry. %1. +// %n +// %nThe expected registry key name is "%2". +// %nThe expected value name is "%3". +// %nThe expected registry data type is %4. +// %nThe allowed range for this parameter is %5 +// %nThe data units for this parameter value are %6. +// %nThe File Replication Service is using a default value of "%7". +// %n +// %nTo change this parameter, run regedt32. +// %n +// %nClick on Start, Run and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. +// %nClick down the key path: "%8" +// %nDouble click on the value name - +// %n "%9" +// %nand update the value. +// %nIf the value name is not present you may add it with the Add Value function +// under the Edit Menu item. Type the value name exactly as shown above using the +// above registry data type. Make sure you observe the data units and allowed range +// when entering the value. +// +#define EVENT_FRS_BAD_REG_DATA 0x800034EBL + +// +// MessageId: EVENT_FRS_JOIN_FAIL_TIME_SKEW +// +// MessageText: +// +// The File Replication Service is unable to replicate with its partner computer +// because the difference in clock times is outside the range of plus or minus +// %1 minutes. +// %n +// %nThe connection to the partner computer is: +// %n "%2" +// %nThe detected time difference is: %3 minutes. +// %n +// %nNote: If this time difference is close to a multiple of 60 minutes then it +// is likely that either this computer or its partner computer was set to the +// incorrect time zone when the computer time was initially set. Check that +// the time zone and the system time are correctly set on both computers. +// %n +// %nIf necessary, the default value used to test for computer time consistency +// may be changed in the registry on this computer. (Note: This is not recommended.) +// %n +// %nTo change this parameter, run regedt32. +// %n +// %nClick on Start, Run and type regedt32. +// %n +// %nClick on the window entitled HKEY_LOCAL_MACHINE. +// %nClick down the key path: +// %n "System\CurrentControlSet\Services\NtFrs\Parameters" +// %nDouble click on the value name +// %n "Partner Clock Skew In Minutes" +// %nand update the value. +// %n +// %nIf the value name is not present you may add it with the Add Value function +// under the Edit Menu item. Type the value name exactly as shown above using the +// the registry data type REG_DWORD. +// +#define EVENT_FRS_JOIN_FAIL_TIME_SKEW 0xC00034ECL + +// +// MessageId: EVENT_FRS_RMTCO_TIME_SKEW +// +// MessageText: +// +// The File Replication Service is unable to replicate from a partner computer +// because the event time associated with the file to be replicated is too far +// into the future. It is %1 minutes greater than the current time. This can +// happen if the system time on the partner computer was set incorrectly when +// the file was created or updated. To preserve the integrity of the replica +// set this file update will not be performed or propagated further. +// %n +// %nThe file name is: "%2" +// %nThe connection to the partner computer is: +// %n "%3" +// %n +// %nNote: If this time difference is close to a multiple of 60 minutes then it +// is likely that this file may have been created or updated on the partner +// computer while the computer was set to the incorrect time zone when its +// computer time was initially set. Check that the timezone and time are +// correctly set on the partner computer. +// +#define EVENT_FRS_RMTCO_TIME_SKEW 0xC00034EDL + +// +// MessageId: EVENT_FRS_CANT_OPEN_STAGE +// +// MessageText: +// +// The File Replication Service is unable to open the customer designated +// staging directory for replica set %1. The path used for the staging +// directory is, +// %n "%2" +// %nThe customer designated root path for this replica set is: +// %n "%3" +// %n +// The service is unable to start replication on this replica set. Among the +// possible errors to check are: +// %n -- an invalid staging path, +// %n -- a missing directory, +// %n -- a missing disk volume, +// %n -- a file system on the volume that does not support ACLs, +// %n -- a sharing conflict on the staging directory with some other application. +// %n +// %nCorrect the problem and the service will attempt to restart replication +// automatically at a later time. +// +#define EVENT_FRS_CANT_OPEN_STAGE 0xC00034EEL + +// +// MessageId: EVENT_FRS_CANT_OPEN_PREINSTALL +// +// MessageText: +// +// The File Replication Service is unable to open (or create) the pre-install +// directory under the customer designated replica tree directory for +// replica set %1. The path used for the pre-install +// directory is, +// %n "%2" +// %nThe customer designated root path for this replica set is: +// %n "%3" +// %n +// The service is unable to start replication on this replica set. Among the +// possible errors to check are: +// %n -- an invalid root path, +// %n -- a missing directory, +// %n -- a missing disk volume, +// %n -- a file system on the volume that does not support NTFS 5.0 +// %n -- a sharing conflict on the pre-install directory with some other application. +// %n +// %nCorrect the problem and the service will attempt to restart replication +// automatically at a later time. +// +#define EVENT_FRS_CANT_OPEN_PREINSTALL 0xC00034EFL + +// +// MessageId: EVENT_FRS_REPLICA_SET_CREATE_FAIL +// +// MessageText: +// +// The File Replication Service is unable to add this computer to the following +// replica set: +// %n "%1" +// %n +// %nThis could be caused by a number of problems such as: +// %n -- an invalid root path, +// %n -- a missing directory, +// %n -- a missing disk volume, +// %n -- a file system on the volume that does not support NTFS 5.0 +// %n +// %nThe information below may help to resolve the problem: +// %nComputer DNS name is "%2" +// %nReplica set member name is "%3" +// %nReplica set root path is "%4" +// %nReplica staging directory path is "%5" +// %nReplica working directory path is "%6" +// %nWindows error status code is %7 +// %nFRS error status code is %8 +// %n +// %nOther event log messages may also help determine the problem. Correct the +// problem and the service will attempt to restart replication automatically at +// a later time. +// +#define EVENT_FRS_REPLICA_SET_CREATE_FAIL 0xC00034F0L + +// +// MessageId: EVENT_FRS_REPLICA_SET_CREATE_OK +// +// MessageText: +// +// The File Replication Service successfully added this computer to the following +// replica set: +// %n "%1" +// %n +// %nInformation related to this event is shown below: +// %nComputer DNS name is "%2" +// %nReplica set member name is "%3" +// %nReplica set root path is "%4" +// %nReplica staging directory path is "%5" +// %nReplica working directory path is "%6" +// +#define EVENT_FRS_REPLICA_SET_CREATE_OK 0x400034F1L + +// +// MessageId: EVENT_FRS_REPLICA_SET_CXTIONS +// +// MessageText: +// +// The File Replication Service successfully added the connections shown below +// to the replica set: +// %n "%1" +// %n +// %n %2 +// %n %3 +// %n %4 +// %n %5 +// %n %6 +// %n %7 +// %n %8 +// %n %9 +// %n +// %nMore information may appear in subsequent event log messages. +// +#define EVENT_FRS_REPLICA_SET_CXTIONS 0x400034F2L + +// +// MessageId: EVENT_FRS_IN_ERROR_STATE +// +// MessageText: +// +// The File Replication Service is in an error state. Files will not replicate +// to or from one or all of the replica sets on his computer until the +// following recovery steps are performed: +// %n +// %n Recovery Steps: +// %n +// %n [1] The error state may clear itself if you stop and restart the FRS service. +// This can be done by performing the following in a command window: +// %n +// %n net stop ntfrs +// %n net start ntfrs +// %n +// %nIf this fails to clear up the problem then proceed as follows. +// %n +// %n [2] For Active Directory Domain Controllers that DO NOT host any DFS +// alternates or other replica sets with replication enabled: +// %n +// %nIf there is at least one other Domain Controller in this domain then +// restore the "system state" of this DC from backup (using ntbackup or other +// backup-restore utility) and make it non-authoritative. +// %n +// %nIf there are NO other Domain Controllers in this domain then restore +// the "system state" of this DC from backup (using ntbackup or other +// backup-restore utility) and choose the Advanced option which marks +// the sysvols as primary. +// %n +// %nIf there are other Domain Controllers in this domain but ALL of +// them have this event log message then restore one of them as primary +// (data files from primary will replicate everywhere) and the others as +// non-authoritative. +// %n +// %n +// %n [3] For Active Directory Domain Controllers that host DFS alternates +// or other replica sets with replication enabled: +// %n +// %n (3-a) If the Dfs alternates on this DC do not have any other replication +// partners then copy the data under that Dfs share to a safe location. +// %n (3-b) If this server is the only Active Directory Domain Controller for this +// domain then, before going to (3-c), make sure this server does not have any +// inbound or outbound connections to other servers that were formerly Domain +// Controllers for this domain but are now off the net (and will never be +// coming back online) or have been fresh installed without being demoted. +// To delete connections use the Sites and Services snapin and look for +// %nSites->NAME_OF_SITE->Servers->NAME_OF_SERVER->NTDS Settings->CONNECTIONS. +// %n (3-c) Restore the "system state" of this DC from backup (using ntbackup +// or other backup-restore utility) and make it non-authoritative. +// %n (3-d) Copy the data from step (3-a) above to the original location +// after the sysvol share is published. +// %n +// %n +// %n [4] For other Windows 2000 servers: +// %n +// %n (4-a) If any of the DFS alternates or other replica sets hosted by +// this server do not have any other replication partners then copy the +// data under its share or replica tree root to a safe location. +// %n (4-b) net stop ntfrs +// %n (4-c) rd /s /q %1 +// %n (4-d) net start ntfrs +// %n (4-e) Copy the data from step (4-a) above to the original location after +// the service has initialized (5 minutes is a safe waiting time). +// %n +// %nNote: If this error message is in the eventlog of all the members of a +// particular replica set then perform steps (4-a) and (4-e) above on only +// one of the members. +// +#define EVENT_FRS_IN_ERROR_STATE 0xC00034F3L + +// +// MessageId: EVENT_FRS_REPLICA_NO_ROOT_CHANGE +// +// MessageText: +// +// The File Replication Service has detected what appears to be an attempt +// to change the root path for the following replica set: +// %n "%1" +// %n +// %nThis is not allowed. To perform this operation you must remove this member +// from the replica set and add the member back with the new root path. +// %n +// %nIt is possible that this is a transient error due to Active Directory +// replication delays associated with updating FRS configuration objects. If +// file replication does not take place after an appropriate waiting time, +// which could be several hours if cross site Active Directory replication +// is required, you must delete and re-add this member to the replica set. +// %n +// %nInformation related to this event is shown below: +// %nComputer DNS name is "%2" +// %nReplica set member name is "%3" +// %nThe current Replica set root path is "%4" +// %nThe desired new Replica set root path is "%5" +// %nReplica staging directory path is "%6" +// +#define EVENT_FRS_REPLICA_NO_ROOT_CHANGE 0xC00034F4L + +// +// MessageId: EVENT_FRS_DUPLICATE_IN_CXTION_SYSVOL +// +// MessageText: +// +// The File Replication Service has detected a duplicate connection object between +// this computer "%6" and a computer named "%1". +// %nThis was detected for the following replica set: +// %n "%2" +// %n +// %nThis is not allowed and replication will not occur between these two +// computers until the duplicate connection objects are removed. +// %n +// %nIt is possible that this is a transient error due to Active Directory +// replication delays associated with updating FRS configuration objects. If +// file replication does not take place after an appropriate waiting time, +// which could be several hours if cross site Active Directory replication +// is required, you must manually delete the duplicate connection objects by +// following the steps below: +// %n +// %n [1] Start the Active Directory Sites and Services Snapin. +// %n [2] Click on "%3, %4, %5, %6, %7". +// %n [3] Look for duplicate connections from "%1" in site "%8". +// %n [4] Delete all but one of the connections. +// +#define EVENT_FRS_DUPLICATE_IN_CXTION_SYSVOL 0xC00034F5L + +// +// MessageId: EVENT_FRS_DUPLICATE_IN_CXTION +// +// MessageText: +// +// The File Replication Service has detected a duplicate connection object between +// this computer "%7" and a computer named "%1". +// %nThis was detected for the following replica set: +// %n "%2" +// %n +// %nThis is not allowed and replication will not occur between these two +// computers until the duplicate connection objects are removed. +// %n +// %nIt is possible that this is a transient error due to Active Directory +// replication delays associated with updating FRS configuration objects. If +// file replication does not take place after an appropriate waiting time, +// which could be several hours if cross site Active Directory replication +// is required, you must manually delete the duplicate connection objects by +// following the steps below: +// %n +// %n [1] Start the Active Directory Users and Computers Snapin. +// %n [2] Click the view button and advanced features to display the system node. +// %n [3] Click on "%3, %4, %5". +// %n [4] Under "%5" you will see one or more DFS related replica set objects. +// Look for the FRS member object "%6" under the subtree for replica set "%2". +// %n [5] Under "%6" look for duplicate connections from "%1". +// %n [6] Delete all but one of the connections. +// +#define EVENT_FRS_DUPLICATE_IN_CXTION 0xC00034F6L + +// +// MessageId: EVENT_FRS_ROOT_HAS_MOVED +// +// MessageText: +// +// The File Replication Service has detected that the replica root path has changed +// from "%2" to "%3". If this is an intentional move then a file with the name +// NTFRS_CMD_FILE_MOVE_ROOT needs to be created under the new root path. +// %nThis was detected for the following replica set: +// %n "%1" +// %n +// %nChanging the replica root path is a two step process which is triggered by +// the creation of the NTFRS_CMD_FILE_MOVE_ROOT file. +// %n +// %n [1] At the first poll which will occur in %4 minutes this computer will be +// deleted from the replica set. +// %n [2] At the poll following the deletion this computer will be re-added to the +// replica set with the new root path. This re-addition will trigger a full tree +// sync for the replica set. At the end of the sync all the files will be at the new +// location. The files may or may not be deleted from the old location depending on whether +// they are needed or not. +// +#define EVENT_FRS_ROOT_HAS_MOVED 0xC00034F7L + +// +// MessageId: EVENT_FRS_ERROR_REPLICA_SET_DELETED +// +// MessageText: +// +// The File Replication Service is deleting this computer from the replica set "%1" as an attempt to +// recover from the error state, +// %n Error status = %2 +// %n At the next poll, which will occur in %3 minutes, this computer will be re-added to the +// replica set. The re-addition will trigger a full tree sync for the replica set. +// +#define EVENT_FRS_ERROR_REPLICA_SET_DELETED 0x800034F8L + +// +// MessageId: EVENT_FRS_REPLICA_IN_JRNL_WRAP_ERROR +// +// MessageText: +// +// The File Replication Service has detected that the replica set "%1" is in JRNL_WRAP_ERROR. +// %n +// %n Replica set name is : "%1" +// %n Replica root path is : "%2" +// %n Replica root volume is : "%3" +// %n +// +// A Replica set hits JRNL_WRAP_ERROR when the record that it is trying to read from the NTFS USN journal is not found. +// This can occur because of one of the following reasons. +// %n +// %n [1] Volume "%3" has been formatted. +// %n [2] The NTFS USN journal on volume "%3" has been deleted. +// %n [3] The NTFS USN journal on volume "%3" has been truncated. Chkdsk can truncate +// the journal if it finds corrupt entries at the end of the journal. +// %n [4] File Replication Service was not running on this computer for a long time. +// %n [5] File Replication Service could not keep up with the rate of Disk IO activity on "%3". +// %n +// %n Following recovery steps will be taken to automatically recover from this error state. +// %n [1] At the first poll which will occur in %4 minutes this computer will be +// deleted from the replica set. +// %n [2] At the poll following the deletion this computer will be re-added to the +// replica set. The re-addition will trigger a full tree sync for the replica set. +// +#define EVENT_FRS_REPLICA_IN_JRNL_WRAP_ERROR 0xC00034F9L + +// +// MessageId: EVENT_FRS_DS_POLL_ERROR_SUMMARY +// +// MessageText: +// +// Following is the summary of warnings and errors encountered by File Replication Service +// while polling the Domain Controller %1 for FRS replica set configuration information. +// %n +// %n %2 +// %n +// +#define EVENT_FRS_DS_POLL_ERROR_SUMMARY 0x800034FAL + +///////////////////////////////////////////////////////////////////////// +// +// PSCHED Events +// +// Codes 14000 - 14299 +// +///////////////////////////////////////////////////////////////////////// +// +// Driver wide events (14000 - 14099) +// +// +// MessageId: EVENT_PS_GPC_REGISTER_FAILED +// +// MessageText: +// +// QoS: The Packet Scheduler failed to register with the Generic Packet Classifier (msgpc.sys). +// +#define EVENT_PS_GPC_REGISTER_FAILED 0xC00036B0L + +// +// MessageId: EVENT_PS_NO_RESOURCES_FOR_INIT +// +// MessageText: +// +// QoS: The Packet Scheduler was unable to allocate required resources for initialization. +// +#define EVENT_PS_NO_RESOURCES_FOR_INIT 0xC00036B1L + +// +// MessageId: EVENT_PS_REGISTER_PROTOCOL_FAILED +// +// MessageText: +// +// QoS: The Packet Scheduler failed to register as a protocol with NDIS. +// +#define EVENT_PS_REGISTER_PROTOCOL_FAILED 0xC00036B2L + +// +// MessageId: EVENT_PS_REGISTER_MINIPORT_FAILED +// +// MessageText: +// +// QoS: The Packet Scheduler failed to register as a miniport with NDIS. +// +#define EVENT_PS_REGISTER_MINIPORT_FAILED 0xC00036B3L + +// +// Adapter events (14100 - 14199) +// +// +// MessageId: EVENT_PS_BAD_BESTEFFORT_LIMIT +// +// MessageText: +// +// QoS [Adapter %2]:%nThe BestEffortLimit value set in the registry exceeds the LinkSpeed. Defaulting to Unlimited BestEffort. +// +#define EVENT_PS_BAD_BESTEFFORT_LIMIT 0x80003714L + +// +// MessageId: EVENT_PS_QUERY_OID_GEN_MAXIMUM_FRAME_SIZE +// +// MessageText: +// +// QoS [Adapter %2]:%nThe network adapter driver failed the query for OID_GEN_MAXIMUM_FRAME_SIZE. +// +#define EVENT_PS_QUERY_OID_GEN_MAXIMUM_FRAME_SIZE 0xC0003715L + +// +// MessageId: EVENT_PS_QUERY_OID_GEN_MAXIMUM_TOTAL_SIZE +// +// MessageText: +// +// QoS [Adapter %2]:%nThe network adapter driver failed the query for OID_GEN_MAXIMUM_TOTAL_SIZE. +// +#define EVENT_PS_QUERY_OID_GEN_MAXIMUM_TOTAL_SIZE 0xC0003716L + +// +// MessageId: EVENT_PS_QUERY_OID_GEN_LINK_SPEED +// +// MessageText: +// +// QoS [Adapter %2]:%nThe network adapter driver failed the query for OID_GEN_LINK_SPEED. +// +#define EVENT_PS_QUERY_OID_GEN_LINK_SPEED 0xC0003717L + +// +// MessageId: EVENT_PS_BINDING_FAILED +// +// MessageText: +// +// QoS [Adapter %2]:%nThe Packet Scheduler failed to bind to the network adapter's miniport driver. +// +#define EVENT_PS_BINDING_FAILED 0xC0003718L + +// +// MessageId: EVENT_PS_MISSING_ADAPTER_REGISTRY_DATA +// +// MessageText: +// +// QoS [Adapter %2]:%nThe UpperBindings key is missing from the registry. +// +#define EVENT_PS_MISSING_ADAPTER_REGISTRY_DATA 0xC0003719L + +// +// MessageId: EVENT_PS_REGISTER_ADDRESS_FAMILY_FAILED +// +// MessageText: +// +// QoS [Adapter %2]:%nThe Packet Scheduler was unable to register with the NDISWAN Call Manager. +// +#define EVENT_PS_REGISTER_ADDRESS_FAMILY_FAILED 0xC000371AL + +// +// MessageId: EVENT_PS_INIT_DEVICE_FAILED +// +// MessageText: +// +// QoS [Adapter %2]:%nThe Packet Scheduler could not initialize the virtual miniport with NDIS. +// +#define EVENT_PS_INIT_DEVICE_FAILED 0xC000371BL + +// +// MessageId: EVENT_PS_WMI_INSTANCE_NAME_FAILED +// +// MessageText: +// +// QoS [Adapter %2]:%nThe Packet Scheduler could not obtain the network adapter's friendly name from NDIS. +// +#define EVENT_PS_WMI_INSTANCE_NAME_FAILED 0xC000371CL + +// +// MessageId: EVENT_PS_WAN_LIMITED_BESTEFFORT +// +// MessageText: +// +// QoS [Adapter %2]:%nThe registry entry for BestEffortLimit is not supported over WAN links. Defaulting to Unlimited BestEffort mode. +// +#define EVENT_PS_WAN_LIMITED_BESTEFFORT 0x8000371DL + +// +// MessageId: EVENT_PS_RESOURCE_POOL +// +// MessageText: +// +// QoS [Adapter %2]:%nCould not initialize due to insufficient nonpaged pool memory. +// +#define EVENT_PS_RESOURCE_POOL 0xC000371EL + +// +// MessageId: EVENT_PS_ADMISSIONCONTROL_OVERFLOW +// +// MessageText: +// +// QoS [Adapter %2]:%nTotal bandwidth allocated to flows exceeds the NonBestEffortLimit. This is because of a reduction in the LinkSpeed or because of a change to the NonBestEffortLimit registry key. +// +#define EVENT_PS_ADMISSIONCONTROL_OVERFLOW 0x8000371FL + +// +// MessageId: EVENT_PS_NETWORK_ADDRESS_FAIL +// +// MessageText: +// +// QoS [Adapter %2]:%nCould not allocate non-paged pool memory for storing network addresses. +// +#define EVENT_PS_NETWORK_ADDRESS_FAIL 0xC0003720L + + +///////////////////////////////////////////////////////////////////////// +// +// Distributed File System (Dfs) Events (14300-14599) +// +///////////////////////////////////////////////////////////////////////// + +// +// Server-side (dfs.sys) errors (14300-14399) +// +// NOTE: events 14300-14317 are UNUSED as of WS03. They need to remain so that +// downlevel eventlogs can be parsed by uplevel systems. +// +// +// MessageId: EXTRA_EXIT_POINT +// +// MessageText: +// +// An extra ExitPoint %2 was found at server %3 +// +#define EXTRA_EXIT_POINT 0xC00037DCL + +// +// MessageId: MISSING_EXIT_POINT +// +// MessageText: +// +// The ExitPoint %2 was missing at server %3 +// +#define MISSING_EXIT_POINT 0xC00037DDL + +// +// MessageId: MISSING_VOLUME +// +// MessageText: +// +// The Volume %2 was missing at server %3 +// +#define MISSING_VOLUME 0xC00037DEL + +// +// MessageId: EXTRA_VOLUME +// +// MessageText: +// +// The extra Volume %2 was found at server %3 +// +#define EXTRA_VOLUME 0xC00037DFL + +// +// MessageId: EXTRA_EXIT_POINT_DELETED +// +// MessageText: +// +// The extra ExitPoint %2 was deleted successfully from the server %3 +// +#define EXTRA_EXIT_POINT_DELETED 0xC00037E0L + +// +// MessageId: EXTRA_EXIT_POINT_NOT_DELETED +// +// MessageText: +// +// Unable to delete the extra ExitPoint %2 at the server %3 +// +#define EXTRA_EXIT_POINT_NOT_DELETED 0xC00037E1L + +// +// MessageId: MISSING_EXIT_POINT_CREATED +// +// MessageText: +// +// The missing ExitPoint %2 was created at the server %3 successfully +// +#define MISSING_EXIT_POINT_CREATED 0xC00037E2L + +// +// MessageId: MISSING_EXIT_POINT_NOT_CREATED +// +// MessageText: +// +// Unable to create the missing Exit Point %2 at the server %3 +// +#define MISSING_EXIT_POINT_NOT_CREATED 0xC00037E3L + +// +// MessageId: MISSING_VOLUME_CREATED +// +// MessageText: +// +// Successfully created the missing volume %2 knowledge at the server %3 +// +#define MISSING_VOLUME_CREATED 0xC00037E4L + +// +// MessageId: MISSING_VOLUME_NOT_CREATED +// +// MessageText: +// +// Unable to create the missing Volume %2 info at server %3 +// +#define MISSING_VOLUME_NOT_CREATED 0xC00037E5L + +// +// MessageId: EXTRA_VOLUME_DELETED +// +// MessageText: +// +// The extra Volume %2 info was deleted at server %3 +// +#define EXTRA_VOLUME_DELETED 0xC00037E6L + +// +// MessageId: EXTRA_VOLUME_NOT_DELETED +// +// MessageText: +// +// The extra Volume %2 info was not deleted at server %3 +// +#define EXTRA_VOLUME_NOT_DELETED 0xC00037E7L + +// +// MessageId: COULD_NOT_VERIFY_VOLUMES +// +// MessageText: +// +// Since the DC %2 was unavailable could not verify volumes knowledge. +// +#define COULD_NOT_VERIFY_VOLUMES 0xC00037E8L + +// +// MessageId: KNOWLEDGE_INCONSISTENCY_DETECTED +// +// MessageText: +// +// Detected Knowledge inconsistency with the volume %2 at server %3 +// +#define KNOWLEDGE_INCONSISTENCY_DETECTED 0xC00037E9L + +// +// MessageId: PREFIX_MISMATCH +// +// MessageText: +// +// The local Prefix %2 was represented as %3 at remote server %4 +// +#define PREFIX_MISMATCH 0xC00037EAL + +// +// MessageId: PREFIX_MISMATCH_FIXED +// +// MessageText: +// +// The remote Prefix %3 was corrected to %2 at remote server %4 +// +#define PREFIX_MISMATCH_FIXED 0xC00037EBL + +// +// MessageId: PREFIX_MISMATCH_NOT_FIXED +// +// MessageText: +// +// The remote Prefix %3 was NOT corrected to %2 at remote server %4 +// +#define PREFIX_MISMATCH_NOT_FIXED 0xC00037ECL + +// +// MessageId: MACHINE_UNJOINED +// +// MessageText: +// +// The machine %2 has become unlinked from the domain. Re-join the machine the machine to this domain. +// +#define MACHINE_UNJOINED 0xC00037EDL + +// +// MessageId: DFS_REFERRAL_REQUEST +// +// MessageText: +// +// Dfs received a referral request for "%2". The return code is in the data. +// +#define DFS_REFERRAL_REQUEST 0x400037EEL + +// +// Client-side Dfs (mup.sys) errors (14400-14499) +// +// NOTE: events 14400-14407 are UNUSED as of Vista. They need to remain so that +// downlevel eventlogs can be parsed by uplevel systems. +// +// +// MessageId: NOT_A_DFS_PATH +// +// MessageText: +// +// The path "%2" is not a dfs path +// +#define NOT_A_DFS_PATH 0x40003840L + +// +// MessageId: LM_REDIR_FAILURE +// +// MessageText: +// +// Dfs was unable to open the Lan Redir +// +#define LM_REDIR_FAILURE 0x40003841L + +// +// MessageId: DFS_CONNECTION_FAILURE +// +// MessageText: +// +// Dfs was unable to open a connection to server %2. The error returned is in the record data. +// +#define DFS_CONNECTION_FAILURE 0x40003842L + +// +// MessageId: DFS_REFERRAL_FAILURE +// +// MessageText: +// +// Dfs was unable to obtain a referral for "%2" from %3. The error returned is in the record data. +// +#define DFS_REFERRAL_FAILURE 0x40003843L + +// +// MessageId: DFS_REFERRAL_SUCCESS +// +// MessageText: +// +// Dfs obtained a referral for "%2" from %3 +// +#define DFS_REFERRAL_SUCCESS 0x40003844L + +// +// MessageId: DFS_MAX_DNR_ATTEMPTS +// +// MessageText: +// +// Dfs reached its limit of attempts of resolution of "%2". +// +#define DFS_MAX_DNR_ATTEMPTS 0x40003845L + +// +// MessageId: DFS_SPECIAL_REFERRAL_FAILURE +// +// MessageText: +// +// Dfs was unable to obtain the special referral table from %2. The error returned is in the record data. +// +#define DFS_SPECIAL_REFERRAL_FAILURE 0x40003846L + +// +// MessageId: DFS_OPEN_FAILURE +// +// MessageText: +// +// Dfs failed on open of %2 directed to %3. The error returned is in the record data. +// +#define DFS_OPEN_FAILURE 0x40003847L + +// +// Dfs service (dfssvc) errors (14500-14599) +// +// NOTE: events 14500-14501 are UNUSED as of WS03. +// events 14502, 14506-07, 14525, 14527-28 were defined in WS03 development +// but never issued in retail, and have been removed. +// +// +// MessageId: NET_DFS_ENUM +// +// MessageText: +// +// NetrDfsEnum received an enumeration. The return code is in the record data. +// +#define NET_DFS_ENUM 0x400038A4L + +// +// MessageId: NET_DFS_ENUMEX +// +// MessageText: +// +// NetrDfsEnumEx received an enumeration. The return code is in the record data. +// +#define NET_DFS_ENUMEX 0x400038A5L + +// +// MessageId: DFS_ERROR_CREATE_REPARSEPOINT_FAILURE +// +// MessageText: +// +// Dfs could not create reparse point for directory %1 under directory %2. The return code is in the record data. +// +#define DFS_ERROR_CREATE_REPARSEPOINT_FAILURE 0xC00038A7L + +// +// MessageId: DFS_ERROR_UNSUPPORTED_FILESYSTEM +// +// MessageText: +// +// Share %1 mapped to %2 does not support reparse points. Upgrade Filesystem and retry. +// +#define DFS_ERROR_UNSUPPORTED_FILESYSTEM 0xC00038A8L + +// +// MessageId: DFS_ERROR_OVERLAPPING_DIRECTORIES +// +// MessageText: +// +// Share %1 mapped to %2 directory overlaps an existing root. The DFS Root will not be created. +// +#define DFS_ERROR_OVERLAPPING_DIRECTORIES 0xC00038A9L + +// +// MessageId: DFS_INFO_ACTIVEDIRECTORY_ONLINE +// +// MessageText: +// +// DFS re-established a connection to the PDC to initiate Domain DFS operations. +// +#define DFS_INFO_ACTIVEDIRECTORY_ONLINE 0x400038ACL + +// +// MessageId: DFS_ERROR_TOO_MANY_ERRORS +// +// MessageText: +// +// Root %1 has too many errors. No further eventlogs will be logged on this root. +// +#define DFS_ERROR_TOO_MANY_ERRORS 0xC00038ADL + +// +// MessageId: DFS_ERROR_WINSOCKINIT_FAILED +// +// MessageText: +// +// DFS could not initialize winsock library. The return code is in the record data. +// +#define DFS_ERROR_WINSOCKINIT_FAILED 0xC00038AEL + +// +// MessageId: DFS_ERROR_SECURITYINIT_FAILED +// +// MessageText: +// +// DFS could not initialize security library. The return code is in the record data. +// +#define DFS_ERROR_SECURITYINIT_FAILED 0xC00038AFL + +// +// MessageId: DFS_ERROR_THREADINIT_FAILED +// +// MessageText: +// +// DFS could not create DFS support thread. The return code is in the record data. +// +#define DFS_ERROR_THREADINIT_FAILED 0xC00038B0L + +// +// MessageId: DFS_ERROR_SITECACHEINIT_FAILED +// +// MessageText: +// +// DFS could not initialize IP site cache. The return code is in the record data. +// +#define DFS_ERROR_SITECACHEINIT_FAILED 0xC00038B1L + +// +// MessageId: DFS_ERROR_ROOTSYNCINIT_FAILED +// +// MessageText: +// +// DFS could not synchronize all DFS roots. The return code is in the record data. +// +#define DFS_ERROR_ROOTSYNCINIT_FAILED 0xC00038B2L + +// +// MessageId: DFS_ERROR_CREATEEVENT_FAILED +// +// MessageText: +// +// DFS could not create event handle. The return code is in the record data. +// +#define DFS_ERROR_CREATEEVENT_FAILED 0xC00038B3L + +// +// MessageId: DFS_ERROR_COMPUTERINFO_FAILED +// +// MessageText: +// +// DFS could not get required computer information. The return code is in the record data. +// +#define DFS_ERROR_COMPUTERINFO_FAILED 0xC00038B4L + +// +// MessageId: DFS_ERROR_CLUSTERINFO_FAILED +// +// MessageText: +// +// DFS could not get required cluster information. The return code is in the record data. +// +#define DFS_ERROR_CLUSTERINFO_FAILED 0xC00038B5L + +// +// MessageId: DFS_ERROR_DCINFO_FAILED +// +// MessageText: +// +// DFS could not get required DC information. The return code is in the record data. +// +#define DFS_ERROR_DCINFO_FAILED 0xC00038B6L + +// +// MessageId: DFS_ERROR_PREFIXTABLE_FAILED +// +// MessageText: +// +// DFS could not initialize prefix table. The return code is in the record data. +// +#define DFS_ERROR_PREFIXTABLE_FAILED 0xC00038B7L + +// +// MessageId: DFS_ERROR_HANDLENAMESPACE_FAILED +// +// MessageText: +// +// DFS could not initialize DFS namespace.The return code is in the record data. +// +#define DFS_ERROR_HANDLENAMESPACE_FAILED 0xC00038B8L + +// +// MessageId: DFS_ERROR_REGISTERSTORE_FAILED +// +// MessageText: +// +// DFS could not Register DFS Namespaces. The return code is in the record data. +// +#define DFS_ERROR_REGISTERSTORE_FAILED 0xC00038B9L + +// +// MessageId: DFS_ERROR_REFLECTIONENGINE_FAILED +// +// MessageText: +// +// DFS could not initialize User/kernel communication package. The return code is in the record data. +// +#define DFS_ERROR_REFLECTIONENGINE_FAILED 0xC00038BAL + +// +// MessageId: DFS_ERROR_ACTIVEDIRECTORY_OFFLINE +// +// MessageText: +// +// DFS could not contact any DC for Domain DFS operations. This operation will be retried periodically. +// +#define DFS_ERROR_ACTIVEDIRECTORY_OFFLINE 0xC00038BBL + +// +// MessageId: DFS_ERROR_SITESUPPOR_FAILED +// +// MessageText: +// +// DFS could not initialize site support table. The return code is in the record data. +// +#define DFS_ERROR_SITESUPPOR_FAILED 0xC00038BCL + +// +// MessageId: DFS_ERROR_DSCONNECT_FAILED +// +// MessageText: +// +// DFS could not contact the %1 Active Directory. DFS will be using cached data. The return code is in the record data. +// +#define DFS_ERROR_DSCONNECT_FAILED 0x800038BEL + +// +// MessageId: DFS_INFO_DS_RECONNECTED +// +// MessageText: +// +// DFS has connected to the %1 Active Directory. +// +#define DFS_INFO_DS_RECONNECTED 0x400038C1L + +// +// MessageId: DFS_ERROR_NO_DFS_DATA +// +// MessageText: +// +// DFS could not access its private data from the Active Directory. Please manually check +// network connectivity, security access, and/or consistency of DFS information +// in the Active Directory. This error occurred on root %1. +// +#define DFS_ERROR_NO_DFS_DATA 0xC00038C2L + +// +// MessageId: DFS_INFO_FINISH_INIT +// +// MessageText: +// +// DFS server has finished initializing. +// +#define DFS_INFO_FINISH_INIT 0x400038C3L + +// +// MessageId: DFS_INFO_RECONNECT_DATA +// +// MessageText: +// +// DFS has recovered from an error and is able to read its private data from +// the Active Directory. Root %1 is now able to read information from the Active Directory. +// +#define DFS_INFO_RECONNECT_DATA 0x400038C4L + +// +// MessageId: DFS_INFO_FINISH_BUILDING_NAMESPACE +// +// MessageText: +// +// DFS has finished building all namespaces. +// +#define DFS_INFO_FINISH_BUILDING_NAMESPACE 0x400038C5L + +// +// MessageId: DFS_ERROR_ON_ROOT +// +// MessageText: +// +// DFS Root %1 failed during initialization. The root will not be available. +// +#define DFS_ERROR_ON_ROOT 0x800038C6L + +// +// MessageId: DFS_ERROR_MUTLIPLE_ROOTS_NOT_SUPPORTED +// +// MessageText: +// +// DFS does not support multiple roots on Standard server SKU. Please cleanup the roots or upgrade. +// +#define DFS_ERROR_MUTLIPLE_ROOTS_NOT_SUPPORTED 0xC00038C7L + +// +// MessageId: DFS_WARN_DOMAIN_REFERRAL_OVERFLOW +// +// MessageText: +// +// DFS is unable to return the entire list of trusted domains to the client. There are too many trusted domains. +// +#define DFS_WARN_DOMAIN_REFERRAL_OVERFLOW 0x800038C8L + +// +// MessageId: DFS_INFO_DOMAIN_REFERRAL_MIN_OVERFLOW +// +// MessageText: +// +// DFS is requesting the client for a larger buffer for trusted domain information. Some Win98 clients may not be able to access DFS namespaces. +// +#define DFS_INFO_DOMAIN_REFERRAL_MIN_OVERFLOW 0x400038C9L + +// +// MessageId: DFS_WARN_INCOMPLETE_MOVE +// +// MessageText: +// +// DFS was unable to move all matching links of root: %1 for path %2 to new path %3 +// +#define DFS_WARN_INCOMPLETE_MOVE 0x800038CAL + +// +// MessageId: DFS_ERROR_RESYNCHRONIZE_FAILED +// +// MessageText: +// +// DFS was unable to resynchronize this root target for root: %1. This may lead to inaccessability of portions of the DFS namespace. +// Please verify the share %1 has all the link directories created for the DFS links. This error may occur if there are directories +// on this share that may be preventing creation of links. +// +#define DFS_ERROR_RESYNCHRONIZE_FAILED 0xC00038CBL + +// +// MessageId: DFS_ERROR_REMOVE_LINK_FAILED +// +// MessageText: +// +// DFS was unable to delete link: %2 for root: %1 during a link move operation. +// +#define DFS_ERROR_REMOVE_LINK_FAILED 0xC00038CCL + +// +// MessageId: DFS_WARN_METADATA_LINK_TYPE_INCORRECT +// +// MessageText: +// +// DFS link %1 was marked incorrectly as a DFS root. The DFS namespace is operational on this server. If this namespace is hosted on servers running Windows Server 2003 prior to Service Pack 2 (SP2), or if the server is running Windows 2000 Server, the namespace might not be fully functional on those servers. +// +// Please consult the Microsoft Knowledge Base for more information on correcting this issue. +// +#define DFS_WARN_METADATA_LINK_TYPE_INCORRECT 0x800038CDL + +// +// MessageId: DFS_WARN_METADATA_LINK_INFO_INVALID +// +// MessageText: +// +// DFS metadata object %1 is empty in the metadata for DFS root %2. The DFS namespace is operational on this server. If this namespace is hosted on servers running Windows Server 2003 prior to Service Pack 2 (SP2), or if the server is running Windows 2000 Server, the namespace might not be fully functional on those servers. +// +// Please consult the Microsoft Knowledge Base for more information on correcting this issue. +// +#define DFS_WARN_METADATA_LINK_INFO_INVALID 0x800038CEL + +// +// MessageId: DFS_ERROR_TARGET_LIST_INCORRECT +// +// MessageText: +// +// The list of folder targets for the following Distributed File System (DFS) folder is corrupt. DFS folder: %1 +// +#define DFS_ERROR_TARGET_LIST_INCORRECT 0xC00038CFL + +// +// MessageId: DFS_ERROR_LINKS_OVERLAP +// +// MessageText: +// +// A Distributed File System (DFS) folder with folder targets was created that contains other DFS folders. This can occur if two administrators on different namespace servers create conflicting folder structures at approximately the same time. Namespace: %1 DFS folder 1: %2 DFS folder 2: %3 +// +#define DFS_ERROR_LINKS_OVERLAP 0xC00038D0L + +// +// MessageId: DFS_ERROR_LINK_OVERLAP +// +// MessageText: +// +// A Distributed File System (DFS) folder with folder targets was created that contains other DFS folders. This can occur if two administrators on different namespace servers create conflicting folder structures at approximately the same time. Namespace: %1 DFS folder: %2 +// +#define DFS_ERROR_LINK_OVERLAP 0xC00038D1L + +// +// MessageId: DFS_ERROR_CREATE_REPARSEPOINT_SUCCESS +// +// MessageText: +// +// Dfs successfully created the reparse point for directory %1 under directory %2. This operation had previously failed. +// +#define DFS_ERROR_CREATE_REPARSEPOINT_SUCCESS 0x400038D2L + +// +// MessageId: DFS_ERROR_DUPLICATE_LINK +// +// MessageText: +// +// A Distributed File System (DFS) folder was created with conflicting descriptions. This can occur if two administrators on different namespace servers create conflicting folder structures at approximately the same time. Namespace: %1 DFS folder path: %2 DFS folder 1: %3 DFS folder 2: %4 +// +#define DFS_ERROR_DUPLICATE_LINK 0xC00038D3L + +// +// MessageId: DFS_ERROR_TRUSTED_DOMAIN_INFO_FAILED +// +// MessageText: +// +// The DFS Namespace service could not initialize the trusted domain information on this domain controller, but it will periodically retry the operation. The return code is in the record data. +// +#define DFS_ERROR_TRUSTED_DOMAIN_INFO_FAILED 0xC00038D4L + +// +// MessageId: DFS_INFO_TRUSTED_DOMAIN_INFO_SUCCESS +// +// MessageText: +// +// The DFS Namespace service successfully initialized the trusted domain information on this domain controller. +// +#define DFS_INFO_TRUSTED_DOMAIN_INFO_SUCCESS 0x400038D5L + +// +// MessageId: DFS_ERROR_CROSS_FOREST_TRUST_INFO_FAILED +// +// MessageText: +// +// The DFS Namespace service could not initialize cross forest trust information on this domain controller, but it will periodically retry the operation. The return code is in the record data. +// +#define DFS_ERROR_CROSS_FOREST_TRUST_INFO_FAILED 0xC00038D6L + +// +// MessageId: DFS_INFO_CROSS_FOREST_TRUST_INFO_SUCCESS +// +// MessageText: +// +// The DFS Namespace service successfully initialized cross forest trust information on this domain controller. +// +#define DFS_INFO_CROSS_FOREST_TRUST_INFO_SUCCESS 0x400038D7L + +// +// MessageId: DFS_INIT_SUCCESS +// +// MessageText: +// +// The DFS Namespaces service has successfully initialized the following namespace: %1 +// +#define DFS_INIT_SUCCESS 0x400038D8L + +// +// MessageId: DFS_ROOT_SHARE_ACQUIRE_FAILED +// +// MessageText: +// +// The DFS Namespaces service failed to initialize the shared folder that hosts the namespace root. Shared folder: %1 +// +#define DFS_ROOT_SHARE_ACQUIRE_FAILED 0x800038D9L + +// +// MessageId: DFS_ROOT_SHARE_ACQUIRE_SUCCESS +// +// MessageText: +// +// The DFS Namespaces service has successfully initialized the shared folder that hosts the namespace root. Shared folder: %1 +// +#define DFS_ROOT_SHARE_ACQUIRE_SUCCESS 0x400038DAL + +///////////////////////////////////////////////////////////////////////// +// +// BRIDGE Events +// +// Codes 14600 - 14899 +// +///////////////////////////////////////////////////////////////////////// +// +// Driver-wide events (14600 - 14699) +// +// +// MessageId: EVENT_BRIDGE_PROTOCOL_REGISTER_FAILED +// +// MessageText: +// +// Bridge: The bridge could not be initialized because the bridge failed to register as a protocol with NDIS. +// +#define EVENT_BRIDGE_PROTOCOL_REGISTER_FAILED 0xC0003908L + +// +// MessageId: EVENT_BRIDGE_MINIPROT_DEVNAME_MISSING +// +// MessageText: +// +// Bridge: The bridge could not be initialized because the bridge's miniport device name is missing from the registry. +// +#define EVENT_BRIDGE_MINIPROT_DEVNAME_MISSING 0xC0003909L + +// +// MessageId: EVENT_BRIDGE_MINIPORT_REGISTER_FAILED +// +// MessageText: +// +// Bridge: The bridge could not be initialized because the bridge failed to register as a miniport with NDIS. +// +#define EVENT_BRIDGE_MINIPORT_REGISTER_FAILED 0xC000390AL + +// +// MessageId: EVENT_BRIDGE_DEVICE_CREATION_FAILED +// +// MessageText: +// +// Bridge: The bridge could not be initialized because the bridge failed to create a device object. +// +#define EVENT_BRIDGE_DEVICE_CREATION_FAILED 0xC000390BL + +// +// MessageId: EVENT_BRIDGE_NO_BRIDGE_MAC_ADDR +// +// MessageText: +// +// Bridge: The bridge could not be initialized because the bridge failed to determine a MAC address for itself. +// +#define EVENT_BRIDGE_NO_BRIDGE_MAC_ADDR 0xC000390CL + +// +// MessageId: EVENT_BRIDGE_MINIPORT_INIT_FAILED +// +// MessageText: +// +// Bridge: The bridge failed to create its virtual miniport. +// +#define EVENT_BRIDGE_MINIPORT_INIT_FAILED 0xC000390DL + +// +// MessageId: EVENT_BRIDGE_ETHERNET_NOT_OFFERED +// +// MessageText: +// +// Bridge: The bridge could not initialize its miniport because Ethernet was not offered as a supported medium. +// +#define EVENT_BRIDGE_ETHERNET_NOT_OFFERED 0xC000390EL + +// +// MessageId: EVENT_BRIDGE_THREAD_CREATION_FAILED +// +// MessageText: +// +// Bridge: The bridge could not initialize because it failed to create a system thread. +// +#define EVENT_BRIDGE_THREAD_CREATION_FAILED 0xC000390FL + +// +// MessageId: EVENT_BRIDGE_THREAD_REF_FAILED +// +// MessageText: +// +// Bridge: The bridge could not initialize because it failed to reference its system thread. +// +#define EVENT_BRIDGE_THREAD_REF_FAILED 0xC0003910L + +// +// MessageId: EVENT_BRIDGE_PACKET_POOL_CREATION_FAILED +// +// MessageText: +// +// Bridge: The bridge could not initialize because it failed to create a packet pool. +// +#define EVENT_BRIDGE_PACKET_POOL_CREATION_FAILED 0xC0003911L + +// +// MessageId: EVENT_BRIDGE_BUFFER_POOL_CREATION_FAILED +// +// MessageText: +// +// Bridge: The bridge could not initialize because it failed to create a buffer pool. +// +#define EVENT_BRIDGE_BUFFER_POOL_CREATION_FAILED 0xC0003912L + +// +// MessageId: EVENT_BRIDGE_INIT_MALLOC_FAILED +// +// MessageText: +// +// Bridge: The bridge could not initialize because it failed to allocate memory. +// +#define EVENT_BRIDGE_INIT_MALLOC_FAILED 0xC0003913L + +// +// Adapter-specific events (14700 - 14799) +// +// +// MessageId: EVENT_BRIDGE_ADAPTER_LINK_SPEED_QUERY_FAILED +// +// MessageText: +// +// Bridge [Adapter %2]:%nThe bridge could not determine the network adapter's link speed. The network adapter will not be used. +// +#define EVENT_BRIDGE_ADAPTER_LINK_SPEED_QUERY_FAILED 0xC000396CL + +// +// MessageId: EVENT_BRIDGE_ADAPTER_MAC_ADDR_QUERY_FAILED +// +// MessageText: +// +// Bridge [Adapter %2]:%nThe bridge could not determine the network adapter's MAC address. The network adapter will not be used. +// +#define EVENT_BRIDGE_ADAPTER_MAC_ADDR_QUERY_FAILED 0xC000396DL + +// +// MessageId: EVENT_BRIDGE_ADAPTER_FILTER_FAILED +// +// MessageText: +// +// Bridge [Adapter %2]:%nThe bridge could not modify the network adapter's packet filter. The network adapter will not function correctly. +// +#define EVENT_BRIDGE_ADAPTER_FILTER_FAILED 0xC000396EL + +// +// MessageId: EVENT_BRIDGE_ADAPTER_NAME_QUERY_FAILED +// +// MessageText: +// +// Bridge [Adapter %2]:%nThe bridge could not retrieve the network adapter's description string. The network adapter will not be used. +// +#define EVENT_BRIDGE_ADAPTER_NAME_QUERY_FAILED 0xC000396FL + +// +// MessageId: EVENT_BRIDGE_ADAPTER_BIND_FAILED +// +// MessageText: +// +// Bridge [Adapter %2]:%nThe bridge failed to bind to the network adapter. The network adapter will not be used. +// +#define EVENT_BRIDGE_ADAPTER_BIND_FAILED 0xC0003970L + +// +// DAV Redir Events (14800 - 14899) +// +// +// MessageId: EVENT_DAV_REDIR_DELAYED_WRITE_FAILED +// +// MessageText: +// +// Windows was unable to save data for file %2. The data has been lost. This error may be caused by a failure of your computer hardware or network connection. Please try to save this file elsewhere. +// +#define EVENT_DAV_REDIR_DELAYED_WRITE_FAILED 0x800039D0L + +// +// WebClient Service Events (14900 - 14999) +// +// +// MessageId: EVENT_WEBCLIENT_CLOSE_PUT_FAILED +// +// MessageText: +// +// PUT failed for file %1 on Close. ErrorStatus: %2. +// +#define EVENT_WEBCLIENT_CLOSE_PUT_FAILED 0x80003A35L + +// +// MessageId: EVENT_WEBCLIENT_CLOSE_DELETE_FAILED +// +// MessageText: +// +// DELETE failed for file %1 on Close. ErrorStatus: %2. +// +#define EVENT_WEBCLIENT_CLOSE_DELETE_FAILED 0x80003A36L + +// +// MessageId: EVENT_WEBCLIENT_CLOSE_PROPPATCH_FAILED +// +// MessageText: +// +// PROPPATCH failed for file %1 on Close. ErrorStatus: %2. +// +#define EVENT_WEBCLIENT_CLOSE_PROPPATCH_FAILED 0x80003A37L + +// +// MessageId: EVENT_WEBCLIENT_SETINFO_PROPPATCH_FAILED +// +// MessageText: +// +// PROPPATCH failed for file %1 on SetFileInfo. ErrorStatus: %2. +// +#define EVENT_WEBCLIENT_SETINFO_PROPPATCH_FAILED 0x80003A38L + + +///////////////////////////////////////////////////////////////////////// +// +// Winsock/WSK Events (16000-16199) +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: EVENT_WSK_OWNINGTHREAD_PARAMETER_IGNORED +// +// MessageText: +// +// WSK provider has ignored the OwningThread parameter passed to a WSK socket creation request. This happens when the socket needs to be created over a TDI transport provider either because a TDI filter driver is installed or because a client-specified TDI mapping exists that matches the AddressFamily, socketType, and Protocol specified in the socket creation request. +// +#define EVENT_WSK_OWNINGTHREAD_PARAMETER_IGNORED 0xC0003E80L + +// +// MessageId: EVENT_WINSOCK_TDI_FILTER_DETECTED +// +// MessageText: +// +// A TDI filter (%2) was detected. This filter has not been certified by Microsoft and may cause system instability. +// +#define EVENT_WINSOCK_TDI_FILTER_DETECTED 0x80003E81L + +// +// MessageId: EVENT_WINSOCK_CLOSESOCKET_STUCK +// +// MessageText: +// +// Closing a %2 socket with local port number %3 in process %4 is taking longer than expected. The local port number may not be available until the close operation is completed. This happens typically due to misbehaving network drivers. Ensure latest updates are installed for Windows and any third-party networking software including NIC drivers, firewalls, or other security products. +// +#define EVENT_WINSOCK_CLOSESOCKET_STUCK 0x80003E82L + + +///////////////////////////////////////////////////////////////////////// +// +// eQoS Events (16500 -16999) +// +///////////////////////////////////////////////////////////////////////// + + +// +// Informational +// + +// +// MessageId: EVENT_EQOS_INFO_MACHINE_POLICY_REFRESH_NO_CHANGE +// +// MessageText: +// +// Computer QoS policies successfully refreshed. No changes detected. +// +#define EVENT_EQOS_INFO_MACHINE_POLICY_REFRESH_NO_CHANGE 0x40004074L + +// +// MessageId: EVENT_EQOS_INFO_MACHINE_POLICY_REFRESH_WITH_CHANGE +// +// MessageText: +// +// Computer QoS policies successfully refreshed. Policy changes detected. +// +#define EVENT_EQOS_INFO_MACHINE_POLICY_REFRESH_WITH_CHANGE 0x40004075L + +// +// MessageId: EVENT_EQOS_INFO_USER_POLICY_REFRESH_NO_CHANGE +// +// MessageText: +// +// User QoS policies successfully refreshed. No changes detected. +// +#define EVENT_EQOS_INFO_USER_POLICY_REFRESH_NO_CHANGE 0x40004076L + +// +// MessageId: EVENT_EQOS_INFO_USER_POLICY_REFRESH_WITH_CHANGE +// +// MessageText: +// +// User QoS policies successfully refreshed. Policy changes detected. +// +#define EVENT_EQOS_INFO_USER_POLICY_REFRESH_WITH_CHANGE 0x40004077L + +// +// MessageId: EVENT_EQOS_INFO_TCP_AUTOTUNING_NOT_CONFIGURED +// +// MessageText: +// +// The Advanced QoS Setting for inbound TCP throughput level successfully refreshed. +// Setting value is not specified by any QoS policy. Local computer default will be applied. +// +#define EVENT_EQOS_INFO_TCP_AUTOTUNING_NOT_CONFIGURED 0x40004078L + +// +// MessageId: EVENT_EQOS_INFO_TCP_AUTOTUNING_OFF +// +// MessageText: +// +// The Advanced QoS Setting for inbound TCP throughput level successfully refreshed. +// Setting value is Level 0 (minimum throughput). +// +#define EVENT_EQOS_INFO_TCP_AUTOTUNING_OFF 0x40004079L + +// +// MessageId: EVENT_EQOS_INFO_TCP_AUTOTUNING_HIGHLY_RESTRICTED +// +// MessageText: +// +// The Advanced QoS Setting for inbound TCP throughput level successfully refreshed. +// Setting value is Level 1. +// +#define EVENT_EQOS_INFO_TCP_AUTOTUNING_HIGHLY_RESTRICTED 0x4000407AL + +// +// MessageId: EVENT_EQOS_INFO_TCP_AUTOTUNING_RESTRICTED +// +// MessageText: +// +// The Advanced QoS Setting for inbound TCP throughput level successfully refreshed. +// Setting value is Level 2. +// +#define EVENT_EQOS_INFO_TCP_AUTOTUNING_RESTRICTED 0x4000407BL + +// +// MessageId: EVENT_EQOS_INFO_TCP_AUTOTUNING_NORMAL +// +// MessageText: +// +// The Advanced QoS Setting for inbound TCP throughput level successfully refreshed. +// Setting value is Level 3 (maximum throughput). +// +#define EVENT_EQOS_INFO_TCP_AUTOTUNING_NORMAL 0x4000407CL + +// +// MessageId: EVENT_EQOS_INFO_APP_MARKING_NOT_CONFIGURED +// +// MessageText: +// +// The Advanced QoS Setting for DSCP marking overrides successfully refreshed. +// Setting value is not specified by any QoS policy. Local computer default will be applied. By default, applications can set DSCP values independently of QoS policies. +// +#define EVENT_EQOS_INFO_APP_MARKING_NOT_CONFIGURED 0x4000407DL + +// +// MessageId: EVENT_EQOS_INFO_APP_MARKING_IGNORED +// +// MessageText: +// +// The Advanced QoS Setting for DSCP marking overrides successfully refreshed. +// Application DSCP marking requests will be ignored. Only QoS policies can set DSCP values. +// +#define EVENT_EQOS_INFO_APP_MARKING_IGNORED 0x4000407EL + +// +// MessageId: EVENT_EQOS_INFO_APP_MARKING_ALLOWED +// +// MessageText: +// +// The Advanced QoS Setting for DSCP marking overrides successfully refreshed. +// Applications can set DSCP values independently of QoS policies. +// +#define EVENT_EQOS_INFO_APP_MARKING_ALLOWED 0x4000407FL + +// +// MessageId: EVENT_EQOS_INFO_LOCAL_SETTING_DONT_USE_NLA +// +// MessageText: +// +// Selective application of QoS policies based on domain or non-domain network category has been disabled on this machine. +// QoS policies will be applied to all network interfaces. +// +#define EVENT_EQOS_INFO_LOCAL_SETTING_DONT_USE_NLA 0x40004080L + +// +// MessageId: EVENT_EQOS_URL_QOS_APPLICATION_CONFLICT +// +// MessageText: +// +// In the past %1 hour(s) and %2 minute(s), %3 HTTP.SYS responses have had their application requested QoS conflict with URL QoS policies. +// +#define EVENT_EQOS_URL_QOS_APPLICATION_CONFLICT 0x40004081L + + +// +// Warnings +// + +// +// MessageId: EVENT_EQOS_WARNING_TEST_1 +// +// MessageText: +// +// EQOS: ***Testing***, with one string %2. +// +#define EVENT_EQOS_WARNING_TEST_1 0x800040D8L + +// +// MessageId: EVENT_EQOS_WARNING_TEST_2 +// +// MessageText: +// +// EQOS: ***Testing***, with two strings, string1 is %2, string2 is %3. +// +#define EVENT_EQOS_WARNING_TEST_2 0x800040D9L + +// +// MessageId: EVENT_EQOS_WARNING_MACHINE_POLICY_VERSION +// +// MessageText: +// +// A computer QoS policy "%2" has an invalid version number. This policy will not be applied. +// +#define EVENT_EQOS_WARNING_MACHINE_POLICY_VERSION 0x800040DAL + +// +// MessageId: EVENT_EQOS_WARNING_USER_POLICY_VERSION +// +// MessageText: +// +// A user QoS policy "%2" has an invalid version number. This policy will not be applied. +// +#define EVENT_EQOS_WARNING_USER_POLICY_VERSION 0x800040DBL + +// +// MessageId: EVENT_EQOS_WARNING_MACHINE_POLICY_PROFILE_NOT_SPECIFIED +// +// MessageText: +// +// A computer QoS policy "%2" does not specify a DSCP value or throttle rate. This policy will not be applied. +// +#define EVENT_EQOS_WARNING_MACHINE_POLICY_PROFILE_NOT_SPECIFIED 0x800040DCL + +// +// MessageId: EVENT_EQOS_WARNING_USER_POLICY_PROFILE_NOT_SPECIFIED +// +// MessageText: +// +// A user QoS policy "%2" does not specify a DSCP value or throttle rate. This policy will not be applied. +// +#define EVENT_EQOS_WARNING_USER_POLICY_PROFILE_NOT_SPECIFIED 0x800040DDL + +// +// MessageId: EVENT_EQOS_WARNING_MACHINE_POLICY_QUOTA_EXCEEDED +// +// MessageText: +// +// Exceeded the maximum number of computer QoS policies. +// The computer QoS policy "%2" and subsequent computer QoS policies will not be applied. +// +#define EVENT_EQOS_WARNING_MACHINE_POLICY_QUOTA_EXCEEDED 0x800040DEL + +// +// MessageId: EVENT_EQOS_WARNING_USER_POLICY_QUOTA_EXCEEDED +// +// MessageText: +// +// Exceeded the maximum number of user QoS policies. +// The user QoS policy "%2" and subsequent user QoS policies will not be applied. +// +#define EVENT_EQOS_WARNING_USER_POLICY_QUOTA_EXCEEDED 0x800040DFL + +// +// MessageId: EVENT_EQOS_WARNING_MACHINE_POLICY_CONFLICT +// +// MessageText: +// +// A computer QoS policy "%2" potentially conflicts with other QoS policies. +// See documentation for rules about which policy will be applied at packet send time. +// +#define EVENT_EQOS_WARNING_MACHINE_POLICY_CONFLICT 0x800040E0L + +// +// MessageId: EVENT_EQOS_WARNING_USER_POLICY_CONFLICT +// +// MessageText: +// +// A user QoS policy "%2" potentially conflicts with other QoS policies. +// See documentation for rules about which policy will be applied at packet send time. +// +#define EVENT_EQOS_WARNING_USER_POLICY_CONFLICT 0x800040E1L + +// +// MessageId: EVENT_EQOS_WARNING_MACHINE_POLICY_NO_FULLPATH_APPNAME +// +// MessageText: +// +// A computer QoS policy "%2" was ignored because the application path cannot be processed. +// The application path may be totally invalid, or has an invalid drive letter, or contains network-mapped drive letter. +// +#define EVENT_EQOS_WARNING_MACHINE_POLICY_NO_FULLPATH_APPNAME 0x800040E2L + +// +// MessageId: EVENT_EQOS_WARNING_USER_POLICY_NO_FULLPATH_APPNAME +// +// MessageText: +// +// A user QoS policy "%2" was ignored because the application path cannot be processed. +// The application path may be totally invalid, or has an invalid drive letter, or contains network-mapped drive letter. +// +#define EVENT_EQOS_WARNING_USER_POLICY_NO_FULLPATH_APPNAME 0x800040E3L + + +// +// Errors +// + +// +// MessageId: EVENT_EQOS_ERROR_MACHINE_POLICY_REFERESH +// +// MessageText: +// +// Computer QoS policies failed to refresh. Error code: %2. +// +#define EVENT_EQOS_ERROR_MACHINE_POLICY_REFERESH 0xC000413CL + +// +// MessageId: EVENT_EQOS_ERROR_USER_POLICY_REFERESH +// +// MessageText: +// +// User QoS policies failed to refresh. Error code: %2. +// +#define EVENT_EQOS_ERROR_USER_POLICY_REFERESH 0xC000413DL + +// +// MessageId: EVENT_EQOS_ERROR_OPENING_MACHINE_POLICY_ROOT_KEY +// +// MessageText: +// +// QoS failed to open the computer-level root key for QoS policies. Error code: %2. +// +#define EVENT_EQOS_ERROR_OPENING_MACHINE_POLICY_ROOT_KEY 0xC000413EL + +// +// MessageId: EVENT_EQOS_ERROR_OPENING_USER_POLICY_ROOT_KEY +// +// MessageText: +// +// QoS failed to open the user-level root key for QoS policies. Error code: %2. +// +#define EVENT_EQOS_ERROR_OPENING_USER_POLICY_ROOT_KEY 0xC000413FL + +// +// MessageId: EVENT_EQOS_ERROR_MACHINE_POLICY_KEYNAME_TOO_LONG +// +// MessageText: +// +// A computer QoS policy exceeds the maximum allowed name length. +// The offending policy is listed under the computer-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_MACHINE_POLICY_KEYNAME_TOO_LONG 0xC0004140L + +// +// MessageId: EVENT_EQOS_ERROR_USER_POLICY_KEYNAME_TOO_LONG +// +// MessageText: +// +// A user QoS policy exceeds the maximum allowed name length. +// The offending policy is listed under the user-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_USER_POLICY_KEYNAME_TOO_LONG 0xC0004141L + +// +// MessageId: EVENT_EQOS_ERROR_MACHINE_POLICY_KEYNAME_SIZE_ZERO +// +// MessageText: +// +// A computer QoS policy has a zero length name. +// The offending policy is listed under the computer-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_MACHINE_POLICY_KEYNAME_SIZE_ZERO 0xC0004142L + +// +// MessageId: EVENT_EQOS_ERROR_USER_POLICY_KEYNAME_SIZE_ZERO +// +// MessageText: +// +// A user QoS policy has a zero length name. +// The offending policy is listed under the user-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_USER_POLICY_KEYNAME_SIZE_ZERO 0xC0004143L + +// +// MessageId: EVENT_EQOS_ERROR_OPENING_MACHINE_POLICY_SUBKEY +// +// MessageText: +// +// QoS failed to open the registry subkey for a computer QoS policy. +// The policy is listed under the computer-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_OPENING_MACHINE_POLICY_SUBKEY 0xC0004144L + +// +// MessageId: EVENT_EQOS_ERROR_OPENING_USER_POLICY_SUBKEY +// +// MessageText: +// +// QoS failed to open the registry subkey for a user QoS policy. +// The policy is listed under the user-level QoS policy root key, with index %2. +// +#define EVENT_EQOS_ERROR_OPENING_USER_POLICY_SUBKEY 0xC0004145L + +// +// MessageId: EVENT_EQOS_ERROR_PROCESSING_MACHINE_POLICY_FIELD +// +// MessageText: +// +// QoS failed to read or validate the "%2" field for the computer QoS policy "%3". +// +#define EVENT_EQOS_ERROR_PROCESSING_MACHINE_POLICY_FIELD 0xC0004146L + +// +// MessageId: EVENT_EQOS_ERROR_PROCESSING_USER_POLICY_FIELD +// +// MessageText: +// +// QoS failed to read or validate the "%2" field for the user QoS policy "%3". +// +#define EVENT_EQOS_ERROR_PROCESSING_USER_POLICY_FIELD 0xC0004147L + +// +// MessageId: EVENT_EQOS_ERROR_SETTING_TCP_AUTOTUNING +// +// MessageText: +// +// QoS failed to read or set inbound TCP throughput level, error code: "%2". +// +#define EVENT_EQOS_ERROR_SETTING_TCP_AUTOTUNING 0xC0004148L + +// +// MessageId: EVENT_EQOS_ERROR_SETTING_APP_MARKING +// +// MessageText: +// +// QoS failed to read or set the DSCP marking override setting, error code: "%2". +// +#define EVENT_EQOS_ERROR_SETTING_APP_MARKING 0xC0004149L + + +///////////////////////////////////////////////////////////////////////// +// +// WinNat Events (17000 - 17100) +// +///////////////////////////////////////////////////////////////////////// + + +// +// Warnings +// + +// +// MessageId: EVENT_WINNAT_SESSION_LIMIT_REACHED +// +// MessageText: +// +// WinNat session limit has been reached. +// +#define EVENT_WINNAT_SESSION_LIMIT_REACHED 0x80004268L + + +#endif // _NETEVENT + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netioapi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netioapi.h new file mode 100644 index 0000000000000000000000000000000000000000..ca51682f694e29f3cfa44865fc89da7437a9d8a7 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netioapi.h @@ -0,0 +1,3930 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +/*++ + +Module Name: + + netioapi.h + +Abstract: + + This module contains definitions for version agnostic IP helper APIs. + + +Environment: + + User mode or kernel mode. + + In user mode this file should be included from iphlpapi.h, + after including the following headers: + + #include + #include + + In kernel mode the following files should be included. + + #include + + For all APIs, the caller IRQL should be less than DISPATCH_LEVEL. + +Notes: + + Please follow these notes to maintain consistency within this API set, + as well as across the legacy IP helper API: + + 1. Express objects and functions in terms of MIB operations if possible. + E.g. MIB_UNICASTIPADDRESS_ROW structure is associated with the + GetUnicastIpAddress() function. + + 2. Use the NETIO/RTL coding convention for naming structures and functions. + When modifying a structure with a legacy IP helper API counterpart, + try to maintain the same name (without abbreviations). + The hungarian convention must not be used and, for structure fields, + the structure name need not prefix the field. + + 3. For versioning a new structure or API, + append a version number to the constructs. + + 4. The functions in this file are grouped by the object they operate upon. + Within the group, they are sorted alphabetically. + +--*/ + +#ifndef _NETIOAPI_H_ +#define _NETIOAPI_H_ +#pragma once +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifdef __cplusplus +extern "C" { +#endif + +// +// General types. +// + +// +// Nameless structure/union. +// +#pragma warning(push) +#pragma warning(disable:4201) +#pragma warning(disable:4214) + +#ifndef ANY_SIZE +#define ANY_SIZE 1 +#endif + +#ifdef __IPHLPAPI_H__ + +// +// User Mode. This file should be included from iphlpapi.h +// User should include ws2ipdef.h to use these APIs. +// + +#define NETIO_STATUS DWORD +#define NETIO_SUCCESS(x) ((x) == NO_ERROR) +#define NETIOAPI_API_ WINAPI +#define _NETIOAPI_SUCCESS_ _Success_(return==NO_ERROR) +#else + +// +// Kernel Mode. +// + +#include +#include +#include +#include + +#define NETIO_STATUS NTSTATUS +#define NETIO_SUCCESS(x) NT_SUCCESS(x) +#define NETIOAPI_API_ NTAPI +#define _NETIOAPI_SUCCESS_ + +#ifdef IPHLPAPI_DLL_LINKAGE +#undef IPHLPAPI_DLL_LINKAGE +#endif +#define IPHLPAPI_DLL_LINKAGE + +#endif /* __IPHLPAPI_H__ */ + +#define NETIOAPI_API NETIO_STATUS NETIOAPI_API_ + +typedef enum _MIB_NOTIFICATION_TYPE { + // + // ParameterChange. + // + MibParameterNotification, + // + // Addition. + // + MibAddInstance, + // + // Deletion. + // + MibDeleteInstance, + // + // Initial notification. + // + MibInitialNotification, +} MIB_NOTIFICATION_TYPE, *PMIB_NOTIFICATION_TYPE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +// +// Interface management routines. +// + +// +// The MIB structure for Interface management routines. +// + +#ifdef _WS2IPDEF_ + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#include + +typedef struct _MIB_IF_ROW2 { + // + // Key structure. Sorted by preference. + // + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + + // + // Read-Only fields. + // + GUID InterfaceGuid; + WCHAR Alias[IF_MAX_STRING_SIZE + 1]; + WCHAR Description[IF_MAX_STRING_SIZE + 1]; + ULONG PhysicalAddressLength; + UCHAR PhysicalAddress[IF_MAX_PHYS_ADDRESS_LENGTH]; + UCHAR PermanentPhysicalAddress[IF_MAX_PHYS_ADDRESS_LENGTH]; + + ULONG Mtu; + IFTYPE Type; // Interface Type. + TUNNEL_TYPE TunnelType; // Tunnel Type, if Type = IF_TUNNEL. + NDIS_MEDIUM MediaType; + NDIS_PHYSICAL_MEDIUM PhysicalMediumType; + NET_IF_ACCESS_TYPE AccessType; + NET_IF_DIRECTION_TYPE DirectionType; + struct { + BOOLEAN HardwareInterface : 1; + BOOLEAN FilterInterface : 1; + BOOLEAN ConnectorPresent : 1; + BOOLEAN NotAuthenticated : 1; + BOOLEAN NotMediaConnected : 1; + BOOLEAN Paused : 1; + BOOLEAN LowPower : 1; + BOOLEAN EndPointInterface : 1; + } InterfaceAndOperStatusFlags; + + IF_OPER_STATUS OperStatus; + NET_IF_ADMIN_STATUS AdminStatus; + NET_IF_MEDIA_CONNECT_STATE MediaConnectState; + NET_IF_NETWORK_GUID NetworkGuid; + NET_IF_CONNECTION_TYPE ConnectionType; + + // + // Statistics. + // + ULONG64 TransmitLinkSpeed; + ULONG64 ReceiveLinkSpeed; + + ULONG64 InOctets; + ULONG64 InUcastPkts; + ULONG64 InNUcastPkts; + ULONG64 InDiscards; + ULONG64 InErrors; + ULONG64 InUnknownProtos; + ULONG64 InUcastOctets; + ULONG64 InMulticastOctets; + ULONG64 InBroadcastOctets; + ULONG64 OutOctets; + ULONG64 OutUcastPkts; + ULONG64 OutNUcastPkts; + ULONG64 OutDiscards; + ULONG64 OutErrors; + ULONG64 OutUcastOctets; + ULONG64 OutMulticastOctets; + ULONG64 OutBroadcastOctets; + ULONG64 OutQLen; +} MIB_IF_ROW2, *PMIB_IF_ROW2; + +typedef struct _MIB_IF_TABLE2 { + ULONG NumEntries; + MIB_IF_ROW2 Table[ANY_SIZE]; +} MIB_IF_TABLE2, *PMIB_IF_TABLE2; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIfEntry2( + _Inout_ PMIB_IF_ROW2 Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified interface on the local computer. + +Arguments: + + Row - Supplies a MIB_IF_ROW2 structure with either the Luid or Index + initialized to that of the interface for which to retrieve + information. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS2) + +typedef enum _MIB_IF_ENTRY_LEVEL { + MibIfEntryNormal = 0, + MibIfEntryNormalWithoutStatistics = 2 +} MIB_IF_ENTRY_LEVEL, *PMIB_IF_ENTRY_LEVEL; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIfEntry2Ex( + _In_ MIB_IF_ENTRY_LEVEL Level, + _Inout_ PMIB_IF_ROW2 Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified interface on the local computer. + +Arguments: + + Level - Value from MIB_IF_ENTRY_LEVEL indicating how much information + should be retrieved + + Row - Supplies a MIB_IF_ROW2 structure with either the Luid or Index + initialized to that of the interface for which to retrieve + information. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + + The fields prefixed with "In" or "Out" will always be zero if + MibIfEntryNormalWithoutStatistics is used. + +--*/ +#endif + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIfTable2( + _Outptr_ PMIB_IF_TABLE2 *Table + ); +/*++ + +Routine Description: + + Retrieves the MIB-II interface table. + +Arguments: + + Table - Returns the table of interfaces in a MIB_IFTABLE2 structure. + Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +typedef enum _MIB_IF_TABLE_LEVEL { + MibIfTableNormal, + MibIfTableRaw, + #if (NTDDI_VERSION >= NTDDI_WIN10_RS2) + MibIfTableNormalWithoutStatistics + #endif +} MIB_IF_TABLE_LEVEL, *PMIB_IF_TABLE_LEVEL; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIfTable2Ex( + _In_ MIB_IF_TABLE_LEVEL Level, + _Outptr_ PMIB_IF_TABLE2 *Table + ); +/*++ + +Routine Description: + + Retrieves the MIB-II interface table. + +Arguments: + + Table - Returns the table of interfaces in a MIB_IFTABLE2 structure. + Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + + The fields prefixed with "In" or "Out" will always be zero if + MibIfEntryNormalWithoutStatistics is used. + +--*/ + +// +// IpInterface management routines. +// + +// +// The MIB structure for Network layer Interface management routines. +// +typedef struct _MIB_IPINTERFACE_ROW { + // + // Key Structure; + // + ADDRESS_FAMILY Family; + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + + // + // Read-Write fields. + // + + // + // Fields currently not exposed. + // + ULONG MaxReassemblySize; + ULONG64 InterfaceIdentifier; + ULONG MinRouterAdvertisementInterval; + ULONG MaxRouterAdvertisementInterval; + + // + // Fileds currently exposed. + // + BOOLEAN AdvertisingEnabled; + BOOLEAN ForwardingEnabled; + BOOLEAN WeakHostSend; + BOOLEAN WeakHostReceive; + BOOLEAN UseAutomaticMetric; + BOOLEAN UseNeighborUnreachabilityDetection; + BOOLEAN ManagedAddressConfigurationSupported; + BOOLEAN OtherStatefulConfigurationSupported; + BOOLEAN AdvertiseDefaultRoute; + + NL_ROUTER_DISCOVERY_BEHAVIOR RouterDiscoveryBehavior; + ULONG DadTransmits; // DupAddrDetectTransmits in RFC 4862. + ULONG BaseReachableTime; + ULONG RetransmitTime; + ULONG PathMtuDiscoveryTimeout; // Path MTU discovery timeout (in ms). + + NL_LINK_LOCAL_ADDRESS_BEHAVIOR LinkLocalAddressBehavior; + ULONG LinkLocalAddressTimeout; // In ms. + ULONG ZoneIndices[ScopeLevelCount]; // Zone part of a SCOPE_ID. + ULONG SitePrefixLength; + ULONG Metric; + ULONG NlMtu; + + // + // Read Only fields. + // + BOOLEAN Connected; + BOOLEAN SupportsWakeUpPatterns; + BOOLEAN SupportsNeighborDiscovery; + BOOLEAN SupportsRouterDiscovery; + + ULONG ReachableTime; + + NL_INTERFACE_OFFLOAD_ROD TransmitOffload; + NL_INTERFACE_OFFLOAD_ROD ReceiveOffload; + + // + // Disables using default route on the interface. This flag + // can be used by VPN clients to restrict Split tunnelling. + // + BOOLEAN DisableDefaultRoutes; +} MIB_IPINTERFACE_ROW, *PMIB_IPINTERFACE_ROW; + +typedef struct _MIB_IPINTERFACE_TABLE { + ULONG NumEntries; + MIB_IPINTERFACE_ROW Table[ANY_SIZE]; +} MIB_IPINTERFACE_TABLE, *PMIB_IPINTERFACE_TABLE; + +typedef struct _MIB_IFSTACK_ROW { + NET_IFINDEX HigherLayerInterfaceIndex; + NET_IFINDEX LowerLayerInterfaceIndex; +} MIB_IFSTACK_ROW, *PMIB_IFSTACK_ROW; + +typedef struct _MIB_INVERTEDIFSTACK_ROW { + NET_IFINDEX LowerLayerInterfaceIndex; + NET_IFINDEX HigherLayerInterfaceIndex; +} MIB_INVERTEDIFSTACK_ROW, *PMIB_INVERTEDIFSTACK_ROW; + +typedef struct _MIB_IFSTACK_TABLE { + ULONG NumEntries; + MIB_IFSTACK_ROW Table[ANY_SIZE]; +} MIB_IFSTACK_TABLE, *PMIB_IFSTACK_TABLE; + +typedef struct _MIB_INVERTEDIFSTACK_TABLE { + ULONG NumEntries; + MIB_INVERTEDIFSTACK_ROW Table[ANY_SIZE]; +} MIB_INVERTEDIFSTACK_TABLE, *PMIB_INVERTEDIFSTACK_TABLE; + +typedef +VOID +(NETIOAPI_API_ *PIPINTERFACE_CHANGE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_ PMIB_IPINTERFACE_ROW Row OPTIONAL, + _In_ MIB_NOTIFICATION_TYPE NotificationType + ); + +typedef struct _MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES { + NL_BANDWIDTH_INFORMATION InboundBandwidthInformation; + NL_BANDWIDTH_INFORMATION OutboundBandwidthInformation; +} MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES, + *PMIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIfStackTable( + _Outptr_ PMIB_IFSTACK_TABLE *Table + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetInvertedIfStackTable( + _Outptr_ PMIB_INVERTEDIFSTACK_TABLE *Table + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpInterfaceEntry( + _Inout_ PMIB_IPINTERFACE_ROW Row + ); +/*++ + +Routine Description: + + Retrieves IP information for the specified interface on the local computer. + +Arguments: + + Row - Supplies a MIB_IPINTERFACE_ROW structure with either the Luid or + Index initialized to that of the interface for which to retrieve + information. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Family: it must be either AF_INET or AF_INET6 + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpInterfaceTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_IPINTERFACE_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the network-layer interface table. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 MIB entries. + + AF_INET6: Only returns IPv6 MIB entries. + + AF_UNSPEC: Returns both IPv4 and IPv6 MIB entries. + + Table - Returns the table of interfaces in a MIB_IPINTERFACE_TABLE + structure. Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +VOID +NETIOAPI_API_ +InitializeIpInterfaceEntry( + _Inout_ PMIB_IPINTERFACE_ROW Row + ); +/*++ + +Routine Description: + + Initialize the MIB_IPINTERFACE_ROW entry for use in SetIpInterfaceRow. + +Arguments: + + Row - Returns an initialized MIB_IPINTERFACE_ROW structure. + +Return Value: + + None. + +Notes: + + InitializeIpInterfaceEntry must be used to initialize the fields of + MIB_IPINTERFACE_ROW with default values. The caller can then update the + fields it wishes to modify and invoke SetIpInterfaceEntry. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyIpInterfaceChange( + _In_ ADDRESS_FAMILY Family, + _In_ PIPINTERFACE_CHANGE_CALLBACK Callback, + _In_opt_ PVOID CallerContext, + _In_ BOOLEAN InitialNotification, + _Inout_ HANDLE *NotificationHandle + ); +/*++ + +Routine Description: + + Register for notification for IP interface changes. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only register for IPv4 change notifications. + + AF_INET6: Only register for IPv6 change notifications. + + AF_UNSPEC: Register for both IPv4 and IPv6 change notifications. + + Callback - Supplies a callback function. This function will be invoked + when an interface notification is received. + + CallerContext - Provides the user specific caller context. This context + will be supplied to the callback function. + + InitialNotification - Supplies a boolean to indicate whether an + initialization notification should be provided. + + NotificationHandle - Returns a handle to the notification registration. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + 1. Invokation of the callback function is serialized. + + 2. Use CancelMibChangeNotify2 to deregister for change notifications. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetIpInterfaceEntry( + _Inout_ PMIB_IPINTERFACE_ROW Row + ); +/*++ + +Routine Description: + + Set the properties of an IP interface. + +Arguments: + + Row - Supplies a MIB_IPINTERFACE_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeIpInterfaceEntry must be used to initialize the fields of + MIB_IPINTERFACE_ROW with default values. The caller can then update the + fields it wishes to modify and invoke SetIpInterfaceEntry. + + On input, the following key fields of Row must be initialized after + invoking InitializeIpInterfaceEntry: + 1. Family: To AF_INET or AF_INET6. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpNetworkConnectionBandwidthEstimates( + _In_ NET_IFINDEX InterfaceIndex, + _In_ ADDRESS_FAMILY AddressFamily, + _Out_ PMIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES BandwidthEstimates + ); +/*++ + +Routine Description: + + Retrieves historical bandwidth estimates for the network connection of + the specified interface. + +Arguments: + + InterfaceIndex - Supplies the interface index. + + AddressFamily - Supplies the address family associated with the interface. + + BandwidthEstimates - Returns the historical bandwidth estimates. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +// +// Unicast address management routines. +// + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// The structure for unicast IP Address management. +// +typedef struct _MIB_UNICASTIPADDRESS_ROW { + // + // Key Structure. + // + SOCKADDR_INET Address; + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + + // + // Read-Write Fileds. + // + NL_PREFIX_ORIGIN PrefixOrigin; + NL_SUFFIX_ORIGIN SuffixOrigin; + ULONG ValidLifetime; + ULONG PreferredLifetime; + UINT8 OnLinkPrefixLength; + BOOLEAN SkipAsSource; + + // + // Read-Only Fields. + // + NL_DAD_STATE DadState; + SCOPE_ID ScopeId; + LARGE_INTEGER CreationTimeStamp; +} MIB_UNICASTIPADDRESS_ROW, *PMIB_UNICASTIPADDRESS_ROW; + +typedef struct _MIB_UNICASTIPADDRESS_TABLE { + ULONG NumEntries; + MIB_UNICASTIPADDRESS_ROW Table[ANY_SIZE]; +} MIB_UNICASTIPADDRESS_TABLE, *PMIB_UNICASTIPADDRESS_TABLE; + +typedef +VOID +(NETIOAPI_API_ *PUNICAST_IPADDRESS_CHANGE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_opt_ PMIB_UNICASTIPADDRESS_ROW Row, + _In_ MIB_NOTIFICATION_TYPE NotificationType + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateUnicastIpAddressEntry( + _In_ CONST MIB_UNICASTIPADDRESS_ROW *Row + ); +/*++ + +Routine Description: + + Create a unicast IP address entry on the local computer. + +Arguments: + + Row - Supplies a MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeUnicastIpAddressEntry must be used to initialize the fields of + MIB_UNICASTIPADDRESS_ROW with default values. The caller can then update + the fields it wishes to modify and invoke CreateIpInterfaceEntry. + + On input, the following key fields of Row must be initialized after + invoking InitializeUnicastIpAddressEntry: + 1. Address to a valid IPv4 or IPv6 unicast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +DeleteUnicastIpAddressEntry( + _In_ CONST MIB_UNICASTIPADDRESS_ROW *Row + ); +/*++ + +Routine Description: + + Delete a unicast IP address entry on the local computer. + +Arguments: + + Row - Supplies a MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Address to a valid IPv4 or IPv6 unicast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetUnicastIpAddressEntry( + _Inout_ PMIB_UNICASTIPADDRESS_ROW Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified unicast IP address entry on the + local computer. + +Arguments: + + Address - Supplies a MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Address to a valid IPv4 or IPv6 unicast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetUnicastIpAddressTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_UNICASTIPADDRESS_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the unicast IP address table on a local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 unicast addresses. + + AF_INET6: Only returns IPv6 unicast addresses. + + AF_UNSPEC: Returns both IPv4 and IPv6 unicast addresses. + + Table - Returns the table of unicast IP addresses in a + MIB_UNICASTIPADDRESS_TABLE Structure. Use FreeMibTable to free this + buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +VOID +NETIOAPI_API_ +InitializeUnicastIpAddressEntry( + _Out_ PMIB_UNICASTIPADDRESS_ROW Row + ); +/*++ + +Routine Description: + + Initialize the MIB_UNICASTIPADDRESS_ROW entry for use in + CreateUnicastIpAddressEntry and SetUnicastIpAddressEntry. + +Arguments: + + Address - Returns an initialized MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + None. + +Notes: + + InitializeUnicastIpAddressEntry must be used to initialize the fields of + MIB_UNICASTIPADDRESS_ROW with default values. The caller can then update + the fields it wishes to modify and invoke CreateUnicastIpAddressEntry or + SetUnicastIpAddressEntry. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyUnicastIpAddressChange( + _In_ ADDRESS_FAMILY Family, + _In_ PUNICAST_IPADDRESS_CHANGE_CALLBACK Callback, + _In_opt_ PVOID CallerContext, + _In_ BOOLEAN InitialNotification, + _Inout_ HANDLE *NotificationHandle + ); +/*++ + +Routine Description: + + Register for notification for unicast IP address changes. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only register for IPv4 change notifications. + + AF_INET6: Only register for IPv6 change notifications. + + AF_UNSPEC: Register for both IPv4 and IPv6 change notifications. + + Callback - Supplies a callback function. This function will be invoked + when an unicast IP address notification is received. + + CallerContext - Provides the user specific caller context. This context + will be supplied to the callback function. + + InitialNotification - Supplies a boolean to indicate whether an + initialization notification should be provided. + + NotificationHandle - Returns a handle to the notification registration. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + 1. Invokation of the callback function is serialized. + + 2. Use CancelMibChangeNotify2 to deregister for change notifications. + +--*/ + +typedef +VOID +(NETIOAPI_API_ *PSTABLE_UNICAST_IPADDRESS_TABLE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_ PMIB_UNICASTIPADDRESS_TABLE AddressTable + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyStableUnicastIpAddressTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_UNICASTIPADDRESS_TABLE* Table, + _In_ PSTABLE_UNICAST_IPADDRESS_TABLE_CALLBACK CallerCallback, + _In_ PVOID CallerContext, + _Inout_ HANDLE *NotificationHandle + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetUnicastIpAddressEntry( + _In_ CONST MIB_UNICASTIPADDRESS_ROW *Row + ); +/*++ + +Routine Description: + + Set the properties of an unicast IP address. + +Arguments: + + Address - Supplies a MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeUnicastIpAddressEntry must be used to initialize the fields of + MIB_UNICASTIPADDRESS_ROW with default values. The caller can then update + the fields it wishes to modify and invoke SetUnicastIpAddressEntry. + + On input, the following key fields of Row must be initialized after + invoking InitializeUnicastIpAddressEntry: + 1. Address to a valid IPv4 or IPv6 unicast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +// +// Anycast address management routines. +// + +typedef struct _MIB_ANYCASTIPADDRESS_ROW { + // + // Key Structure. + // + SOCKADDR_INET Address; + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + + // + // Read-Only Fields. + // + SCOPE_ID ScopeId; +} MIB_ANYCASTIPADDRESS_ROW, *PMIB_ANYCASTIPADDRESS_ROW; + +typedef struct _MIB_ANYCASTIPADDRESS_TABLE { + ULONG NumEntries; + MIB_ANYCASTIPADDRESS_ROW Table[ANY_SIZE]; +} MIB_ANYCASTIPADDRESS_TABLE, *PMIB_ANYCASTIPADDRESS_TABLE; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateAnycastIpAddressEntry( + _In_ CONST MIB_ANYCASTIPADDRESS_ROW *Row + ); +/*++ + +Routine Description: + + Create an anycast IP address entry on the local computer. + +Arguments: + + Address - Supplies a MIB_ANYCASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Address to a valid IPv4 or IPv6 anycast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +DeleteAnycastIpAddressEntry( + _In_ CONST MIB_ANYCASTIPADDRESS_ROW *Row + ); +/*++ + +Routine Description: + + Delete an anycast IP address entry on the local computer. + +Arguments: + + Address - Supplies a MIB_ANYCASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Address to a valid IPv4 or IPv6 anycast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetAnycastIpAddressEntry( + _Inout_ PMIB_ANYCASTIPADDRESS_ROW Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified anycast IP address entry on the + local computer. + +Arguments: + + Address - Supplies a MIB_ANYCASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Address to a valid IPv4 or IPv6 anycast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetAnycastIpAddressTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_ANYCASTIPADDRESS_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the anycast IP address table. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 anycast addresses. + + AF_INET6: Only returns IPv6 anycast addresses. + + AF_UNSPEC: Returns both IPv4 and IPv6 anycast addresses. + + Table - Returns the table of anycast IP addresses in a + MIB_ANYCASTIPADDRESS_TABLE Structure. Use FreeMibTable to free this + buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + + +// +// Multicast address management routines. +// +typedef struct _MIB_MULTICASTIPADDRESS_ROW { + // + // Key Structure. + // + SOCKADDR_INET Address; + NET_IFINDEX InterfaceIndex; + NET_LUID InterfaceLuid; + + // + // Read-Only Fields. + // + SCOPE_ID ScopeId; +} MIB_MULTICASTIPADDRESS_ROW, *PMIB_MULTICASTIPADDRESS_ROW; + +typedef struct _MIB_MULTICASTIPADDRESS_TABLE { + ULONG NumEntries; + MIB_MULTICASTIPADDRESS_ROW Table[ANY_SIZE]; +} MIB_MULTICASTIPADDRESS_TABLE, *PMIB_MULTICASTIPADDRESS_TABLE; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetMulticastIpAddressEntry( + _Inout_ PMIB_MULTICASTIPADDRESS_ROW Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified mulitcast IP address entry on the + local computer. + +Arguments: + + Row - Supplies a MIB_MULTICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized. + 1. Address to a valid IPv4 or IPv6 multicast address. + 2. At least one of InterfaceLuid or InterfaceIndex must be specified. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetMulticastIpAddressTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_MULTICASTIPADDRESS_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the multicast IP address table on the local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 multicast addresses. + + AF_INET6: Only returns IPv6 multicast addresses. + + AF_UNSPEC: Returns both IPv4 and IPv6 multicast addresses. + + Table - Returns the table of multicast IP addresses in a + MIB_MULTICASTIPADDRESS_TABLE Structure. Use FreeMibTable to free this + buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +// +// Route management routines. +// + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +typedef struct _IP_ADDRESS_PREFIX { + SOCKADDR_INET Prefix; + UINT8 PrefixLength; +} IP_ADDRESS_PREFIX, *PIP_ADDRESS_PREFIX; + +typedef struct _MIB_IPFORWARD_ROW2 { + // + // Key Structure. + // + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + IP_ADDRESS_PREFIX DestinationPrefix; + SOCKADDR_INET NextHop; + + // + // Read-Write Fields. + // + UCHAR SitePrefixLength; + ULONG ValidLifetime; + ULONG PreferredLifetime; + ULONG Metric; + NL_ROUTE_PROTOCOL Protocol; + + BOOLEAN Loopback; + BOOLEAN AutoconfigureAddress; + BOOLEAN Publish; + BOOLEAN Immortal; + + // + // Read-Only Fields. + // + ULONG Age; + NL_ROUTE_ORIGIN Origin; +} MIB_IPFORWARD_ROW2, *PMIB_IPFORWARD_ROW2; + +typedef struct _MIB_IPFORWARD_TABLE2 { + ULONG NumEntries; + MIB_IPFORWARD_ROW2 Table[ANY_SIZE]; +} MIB_IPFORWARD_TABLE2, *PMIB_IPFORWARD_TABLE2; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +typedef +VOID +(NETIOAPI_API_ *PIPFORWARD_CHANGE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_opt_ PMIB_IPFORWARD_ROW2 Row, + _In_ MIB_NOTIFICATION_TYPE NotificationType + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateIpForwardEntry2( + _In_ CONST MIB_IPFORWARD_ROW2 *Row + ); +/*++ + +Routine Description: + + Create a route on the local computer. + +Arguments: + + Row - Supplies a MIB_IPFORWARD_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeIpForwardEntry must be used to initialize the fields of + MIB_IPFORWARD_ROW2 with default values. The caller can then update the + fields it wishes to modify and invoke CreateIpForwardEntry2. + + On input, the following key fields of Row must be initialized after + invoking InitializeIpForwardEntry: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. DestinationPrefix. + 3. NextHop. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +DeleteIpForwardEntry2( + _In_ CONST MIB_IPFORWARD_ROW2 *Row + ); +/*++ + +Routine Description: + + Delete a route on the local computer. + +Arguments: + + Row - Supplies a MIB_IPFORWARD_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. DestinationPrefix. + 3. NextHop. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetBestRoute2( + _In_opt_ NET_LUID *InterfaceLuid, + _In_ NET_IFINDEX InterfaceIndex, + _In_opt_ CONST SOCKADDR_INET *SourceAddress, + _In_ CONST SOCKADDR_INET *DestinationAddress, + _In_ ULONG AddressSortOptions, + _Out_ PMIB_IPFORWARD_ROW2 BestRoute, + _Out_ SOCKADDR_INET *BestSourceAddress + ); +/*++ + +Routine Description: + + Retrieve the best route between source and destination address on a local + computer. + +Arguments: + + InterfaceLuid - Supplies Luid to specify an interface. + + InterfaceIndex - Supplies Index to specify an interface. + + SourceAddress - Supplies source address. + + DestinationAddress - Supplies destination address. + + AddressSortOptions - Supplies AddressSortOptions. + + BestRoute - Returns the MIB structure that holds the best route. + + BestSourceAddress - Returns the source address of the best route. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following parameters must be supplied: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. SourceAddress. + 3. DestinationAddress. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpForwardEntry2( + _Inout_ PMIB_IPFORWARD_ROW2 Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified route entry on the local computer. + +Arguments: + + Route - Supplies a MIB_IPFORWARD_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. DestinationPrefix and NextHop can be specified. + + On output, the remaining fields of Row are filled in. + + If one or more routes matches the specified criteria, + this API matches the first entry. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpForwardTable2( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_IPFORWARD_TABLE2 *Table + ); +/*++ + +Routine Description: + + Retrieves the route table on a local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 route entries. + + AF_INET6: Only returns IPv6 route entries. + + AF_UNSPEC: Returns both IPv4 and IPv6 route entries. + + Table - Returns the table of routes in a MIB_IPFORWARD_TABLE2 Structure. + Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +VOID +NETIOAPI_API_ +InitializeIpForwardEntry( + _Out_ PMIB_IPFORWARD_ROW2 Row + ); +/*++ + +Routine Description: + + Initialize the MIB_IPFORWARD_ROW2 entry for use in SetIpForwardEntry2. + +Arguments: + + Row - Returns an initialized PMIB_IPFORWARD_ROW2 structure. + +Return Value: + + None. + +Notes: + + InitializeIpForwardEntry must be used to initialize the fields of + MIB_IPFORWARD_ROW2 with default values. The caller can then update the + fields it wishes to modify and invoke SetIpForwardEntry2. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyRouteChange2( + _In_ ADDRESS_FAMILY AddressFamily, + _In_ PIPFORWARD_CHANGE_CALLBACK Callback, + _In_ PVOID CallerContext, + _In_ BOOLEAN InitialNotification, + _Inout_ HANDLE *NotificationHandle + ); +/*++ + +Routine Description: + + Register for notification for route changes. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only register for IPv4 route change notifications. + + AF_INET6: Only register for IPv6 route change notifications. + + AF_UNSPEC: Register for both IPv4 and IPv6 route change notifications. + + Callback - Supplies a callback function. This function will be invoked when + an unicast IP address notification is received. + + CallerContext - Provides the user specific caller context. This context + will be supplied to the callback function. + + InitialNotification - Supplies a boolean to indicate whether an + initialization notification should be provided. + + NotificationHandle - Returns a handle to the notification registration. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + 1. Invokation of the callback function is serialized. + + 2. Use CancelMibChangeNotify2 to deregister for change notifications. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetIpForwardEntry2( + _In_ CONST MIB_IPFORWARD_ROW2 *Route + ); +/*++ + +Routine Description: + + Set the properties of a route entry. + +Arguments: + + Route - Supplies a MIB_UNICASTIPADDRESS_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeIpForwardEntry must be used to initialize the fields of + MIB_IPFORWARD_ROW2 with default values. The caller can then update the + fields it wishes to modify and invoke SetIpForwardEntry2. + + On input, the following key fields of Row must be initialized after + invoking InitializeIpForwardEntry: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. DestinationPrefix. + 3. NextHop. + +--*/ + +// +// Path management routines. +// + +typedef struct _MIB_IPPATH_ROW { + // + // Key. + // + + SOCKADDR_INET Source; + SOCKADDR_INET Destination; + NET_LUID InterfaceLuid; + NET_IFINDEX InterfaceIndex; + + // + // RO. + // + // + // The current next hop. This can change over the lifetime of a path. + // + SOCKADDR_INET CurrentNextHop; + + // + // MTU of path to destination. Includes the IP header length. + // + ULONG PathMtu; + + // + // Estimated mean RTT. + // + ULONG RttMean; + + // + // Mean deviation of RTT. + // + ULONG RttDeviation; + union { + ULONG LastReachable; // Milliseconds. + ULONG LastUnreachable; // Milliseconds. + }; + BOOLEAN IsReachable; + + // + // Estimated speed. + // + ULONG64 LinkTransmitSpeed; + ULONG64 LinkReceiveSpeed; + +} MIB_IPPATH_ROW, *PMIB_IPPATH_ROW; + +typedef struct _MIB_IPPATH_TABLE { + ULONG NumEntries; + MIB_IPPATH_ROW Table[ANY_SIZE]; +} MIB_IPPATH_TABLE, *PMIB_IPPATH_TABLE; + + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +FlushIpPathTable( + _In_ ADDRESS_FAMILY Family + ); +/*++ + +Routine Description: + + Flush the IP Path table on the local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only flush the IPv4 path table. + + AF_INET6: Only flush the IPv6 path table. + + AF_UNSPEC: Flush both IPv4 and IPv6 path table. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpPathEntry( + _Inout_ PMIB_IPPATH_ROW Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified path entry on the local computer. + +Arguments: + + Row - Supplies a MIB_IPPATH_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Source. + 3. Destination. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpPathTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_IPPATH_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the path table on a local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 paths. + + AF_INET6: Only returns IPv6 paths. + + AF_UNSPEC: Returns both IPv4 and IPv6 paths. + + Table - Returns the table of paths in a MIB_IPPATH_TABLE + structure. Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +// +// ARP and IPv6 Neighbor management routines. +// + +typedef struct _MIB_IPNET_ROW2 { + // + // Key Struture. + // + SOCKADDR_INET Address; + NET_IFINDEX InterfaceIndex; + NET_LUID InterfaceLuid; + + // + // Read-Write. + // + UCHAR PhysicalAddress[IF_MAX_PHYS_ADDRESS_LENGTH]; + + // + // Read-Only. + // + ULONG PhysicalAddressLength; + NL_NEIGHBOR_STATE State; + + union { + struct { + BOOLEAN IsRouter : 1; + BOOLEAN IsUnreachable : 1; + }; + UCHAR Flags; + }; + + union { + ULONG LastReachable; + ULONG LastUnreachable; + } ReachabilityTime; +} MIB_IPNET_ROW2, *PMIB_IPNET_ROW2; + +typedef struct _MIB_IPNET_TABLE2 { + ULONG NumEntries; + MIB_IPNET_ROW2 Table[ANY_SIZE]; +} MIB_IPNET_TABLE2, *PMIB_IPNET_TABLE2; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateIpNetEntry2( + _In_ CONST MIB_IPNET_ROW2 *Row + ); +/*++ + +Routine Description: + + Create a neighbor entry on the local computer. + +Arguments: + + Row - Supplies a MIB_IPNET_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Address. + 3. PhysicalAddress. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +DeleteIpNetEntry2( + _In_ CONST MIB_IPNET_ROW2 *Row + ); +/*++ + +Routine Description: + + Delete a neighbor entry on the local computer. + +Arguments: + + Row - Supplies a MIB_IPNET_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Address. + +--*/ + + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +FlushIpNetTable2( + _In_ ADDRESS_FAMILY Family, + _In_ NET_IFINDEX InterfaceIndex + ); +/*++ + +Routine Description: + + Flush the neighbor entry table on the local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only flush the IPv4 neighbor table. + + AF_INET6: Only flush the IPv6 neighbor table. + + AF_UNSPEC: Flush both IPv4 and IPv6 neighbor table. + + InterfaceIndex - Supplies the Interface index. If the index is specified, + flush the neighbor entries on a specific interface, otherwise flush the + neighbor entries on all the interfaces. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpNetEntry2( + _Inout_ PMIB_IPNET_ROW2 Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified neighbor entry on the local + computer. + +Arguments: + + Row - Supplies a MIB_IPNET_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Address. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetIpNetTable2( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_IPNET_TABLE2 *Table + ); +/*++ + +Routine Description: + + Retrieves the neighbor table on the local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 neighbor entries. + + AF_INET6: Only returns IPv6 neighbor entries. + + AF_UNSPEC: Returns both IPv4 and IPv6 neighbor entries. + + Table - Returns the table of neighbor entries in a MIB_IPNET_TABLE2 + structure. Use FreeMibTable to free this buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ResolveIpNetEntry2( + _Inout_ PMIB_IPNET_ROW2 Row, + _In_opt_ CONST SOCKADDR_INET *SourceAddress + ); +/*++ + +Routine Description: + + Resolve the physical address of a specific neighbor. + +Arguments: + + NetEntry - Supplies a MIB_IPNET_ROW2 structure. + + SourceAddress - Supplies the source address. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + This API flushes any existing neighbor entry and resolves the MAC address + by sending ARP requests (IPv4) or Neighbor Solicitation (IPv6). + If source address is not provided, the API will automatically select the + best interface to send the request on. + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Address. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetIpNetEntry2( + _In_ PMIB_IPNET_ROW2 Row + ); +/*++ + +Routine Description: + + Set the physical address of a neighbor entry. + +Arguments: + + NetEntry - Supplies a MIB_IPNET_ROW2 structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. At least one of InterfaceLuid or InterfaceIndex must be specified. + 2. Address. + 3. PhysicalAddress. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// +// Teredo APIs. +// +#define MIB_INVALID_TEREDO_PORT_NUMBER 0 + +typedef +VOID +(NETIOAPI_API_ *PTEREDO_PORT_CHANGE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_ USHORT Port, + _Inout_ MIB_NOTIFICATION_TYPE NotificationType + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyTeredoPortChange( + _In_ PTEREDO_PORT_CHANGE_CALLBACK Callback, + _In_ PVOID CallerContext, + _In_ BOOLEAN InitialNotification, + _Inout_ HANDLE *NotificationHandle + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetTeredoPort( + _Out_ USHORT *Port + ); +/*++ + +Routine Description: + + Get the Teredo client port. + +Arguments: + + Port - returns the Teredo port. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +#ifndef TEREDO_API_NO_DEPRECATE + +// +// Deprecate all of the unsafe functions to generate compiletime errors. +// Use the following routines instead : FwpmSystemPortsGet +// + +#pragma deprecated(NotifyTeredoPortChange) +#pragma deprecated(GetTeredoPort) + +#endif // TEREDO_API_NO_DEPRECATE + +// +// Generic (not IP-specific) interface definitions. +// + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NETIOAPI_API +CancelMibChangeNotify2( + _In_ HANDLE NotificationHandle + ); +/*++ + +Routine Description: + + Deregister for change notifications. + +Arguments: + + NotificationHandle - Supplies the handle returned from a notification + registration. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + Blocks until all callback have returned. + +--*/ + +IPHLPAPI_DLL_LINKAGE +VOID +NETIOAPI_API_ +FreeMibTable( + _In_ PVOID Memory + ); +/*++ + +Routine Description: + + Free the buffer allocated by Get*Table APIs. + +Arguments: + + Memory - Supplies the buffer to free. + +Return Value: + + None. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateSortedAddressPairs( + _In_opt_ const PSOCKADDR_IN6 SourceAddressList, + _In_ ULONG SourceAddressCount, + _In_ const PSOCKADDR_IN6 DestinationAddressList, + _In_ ULONG DestinationAddressCount, + _In_ ULONG AddressSortOptions, + _Outptr_result_buffer_(*SortedAddressPairCount) + PSOCKADDR_IN6_PAIR *SortedAddressPairList, + _Out_ ULONG *SortedAddressPairCount + ); +/*++ + +Routine Description: + + Given a list of source and destination addresses, returns a list of + pairs of addresses in sorted order. The list is sorted by which address + pair is best suited for communication between two peers. + + The list of source addresses is optional, in which case the function + automatically uses all the host machine's local addresses. + +Arguments: + + SourceAddressList - Supplies list of potential source addresses. + If NULL the routine automatically uses all local addresses. + IPv4 addresses can be specified in IPv4-mapped format. + Reserved for future use. Must be NULL. + + SourceAddressCount - Supplies the number of addresses in the + SourceAddressList. + Reserved for future use. Must be 0. + + DestinationAddressList - Supplies list of potential destination addresses. + IPv4 addresses can be specified in IPv4-mapped format. + + DestinationAddressCount - Supplies the number of addresses in the + DestinationAddressList. + + AddressSortOptions - Reserved for future use. Must be 0. + + SortedAddressPairList - Returns a sorted list of pairs of addresses + in prefered order of communication. The list must be freed with a + single call to NetioFreeMemory. + + SortedAddressPairCount - Returns the number of address pairs in + SortedAddressPairList. + +Return Value: + + ERROR_SUCCESS on success. WIN32 error code on error. + +--*/ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif //_WS2IPDEF_ + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertCompartmentGuidToId( + _In_ CONST GUID *CompartmentGuid, + _Out_ PNET_IF_COMPARTMENT_ID CompartmentId + ); +/*++ + +Routine Description: + + Converts a compartment GUID to a compartment ID. + +Arguments: + + CompartmentGuid - Supplies the compartment GUID. + + CompartmentId - Returns the compartment ID. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertCompartmentIdToGuid( + _In_ NET_IF_COMPARTMENT_ID CompartmentId, + _Out_ GUID *CompartmentGuid + ); +/*++ + +Routine Description: + + Converts a compartment ID to a compartment GUID. + +Arguments: + + CompartmentId - Supplies the compartment ID. + + CompartmentGuid - Returns the compartment GUID. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceNameToLuidA( + _In_z_ CONST CHAR *InterfaceName, + _Out_ NET_LUID *InterfaceLuid + ); +/*++ + +Routine Description: + + Convert an Interface Name to Luid. + +Arguments: + + InterfaceName - Supplies the interface name to be converted. + + InterfaceLuid - Returns the interface Luid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceNameToLuidW( + _In_z_ CONST WCHAR *InterfaceName, + _Out_ NET_LUID *InterfaceLuid + ); +/*++ + +Routine Description: + + Convert an Interface Name to Luid. + +Arguments: + + InterfaceName - Supplies the interface name to be converted. + + InterfaceLuid - Returns the interface Luid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceLuidToNameA( + _In_ CONST NET_LUID *InterfaceLuid, + _Out_writes_(Length) PSTR InterfaceName, + _In_ SIZE_T Length + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Name. + +Arguments: + + InterfaceLuid - Supplies the interface Luid to be converted. + + InterfaceName - Returns the interface name. + + Lenght - Supplies the length of the InterfaceName buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceLuidToNameW( + _In_ CONST NET_LUID *InterfaceLuid, + _Out_writes_(Length) PWSTR InterfaceName, + _In_ SIZE_T Length + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Name. + +Arguments: + + InterfaceLuid - Supplies the interface Luid to be converted. + + InterfaceName - Returns the interface name. + + Length - Supplies the length of the InterfaceName buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceLuidToIndex( + _In_ CONST NET_LUID *InterfaceLuid, + _Out_ PNET_IFINDEX InterfaceIndex + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Index. + +Arguments: + + InterfaceLuid - Supplies the interface Luid to be converted. + + InterfaceName - Returns the interface Index. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceIndexToLuid( + _In_ NET_IFINDEX InterfaceIndex, + _Out_ PNET_LUID InterfaceLuid + ); +/*++ + +Routine Description: + + Convert an Interface Index to Luid. + +Arguments: + + InterfaceName - Supplies the interface Index to be converted. + + InterfaceLuid - Returns the interface Luid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceLuidToAlias( + _In_ CONST NET_LUID *InterfaceLuid, + _Out_writes_(Length) PWSTR InterfaceAlias, + _In_ SIZE_T Length + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Alias. + +Arguments: + + InterfaceLuid - Supplies the interface Luid to be converted. + + InterfaceAlias - Returns the interface Alias. + + Length - Supplies the length of InterfaceAlias buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceAliasToLuid( + _In_z_ CONST WCHAR *InterfaceAlias, + _Out_ PNET_LUID InterfaceLuid + ); +/*++ + +Routine Description: + + Convert an Interface Alias to Luid. + +Arguments: + + InterfaceAlias - Supplies the null terminated interface Alias. + + InterfaceLuid - Returns the interface Luid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceLuidToGuid( + _In_ CONST NET_LUID *InterfaceLuid, + _Out_ GUID *InterfaceGuid + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Guid. + +Arguments: + + InterfaceLuid - Supplies the interface Luid to be converted. + + InterfaceGuid - Returns the interface Guid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +ConvertInterfaceGuidToLuid( + _In_ CONST GUID *InterfaceGuid, + _Out_ PNET_LUID InterfaceLuid + ); +/*++ + +Routine Description: + + Convert an Interface Luid to Guid. + +Arguments: + + InterfaceGuid - Supplies the interface Guid to be converted. + + InterfaceGuid - Returns the interface Luid. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +#define IF_NAMESIZE NDIS_IF_MAX_STRING_SIZE + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NET_IFINDEX +NETIOAPI_API_ +if_nametoindex( + _In_ PCSTR InterfaceName + ); +/*++ + +Routine Description: + + Convert an Interface name to Index. + +Arguments: + + InterfaceName - Supplies the null terminated interface name to convert. + +Return Value: + + Interface index on success, 0 otherwise. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +PCHAR +NETIOAPI_API_ +if_indextoname( + _In_ NET_IFINDEX InterfaceIndex, + _Out_writes_(IF_NAMESIZE) PCHAR InterfaceName + ); +/*++ + +Routine Description: + + Convert an Interface index to Name. + +Arguments: + + InterfaceIndex - Supplies the Interface index to convert. + + InterfaceName - Returns the null terminated interface name. + +Return Value: + + Interface name on success, NULL otherwise. + +Notes: + + The length of InterfaceName buffer must be equal to or greater than + IF_NAMESIZE. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NET_IF_COMPARTMENT_ID +NETIOAPI_API_ +GetCurrentThreadCompartmentId( + VOID + ); +/*++ + +Routine Description: + + Get the compartment ID of current thread. + +Arguments: + + None. + +Return Value: + + The compartment ID of current thread. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetCurrentThreadCompartmentId( + _In_ NET_IF_COMPARTMENT_ID CompartmentId + ); +/*++ + +Routine Description: + + Set the compartment ID of current thread. + +Arguments: + + CompartmentId - Supplies the compartment ID to be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +VOID +NETIOAPI_API_ +GetCurrentThreadCompartmentScope( + _Out_ PNET_IF_COMPARTMENT_SCOPE CompartmentScope, + _Out_ PNET_IF_COMPARTMENT_ID CompartmentId + ); +/*++ + +Routine Description: + + Returns the compartment scope and ID for the current thread. + +Arguments: + + CompartmentScope - Receives the compartment scope. + + CompartmentId - Optionally receives the compartment ID. + +Return Value: + + None. + +Permissions: + + This is open to all callers. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetCurrentThreadCompartmentScope( + _In_ NET_IF_COMPARTMENT_SCOPE CompartmentScope + ); +/*++ + +Routine Description: + + Sets the compartment scope for the current thread. + +Arguments: + + CompartmentScope - Supplies the compartment scope. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Permissions: + + This is a privileged operation available only to admin-like accounts + used by services (LocalSystem, NetworkService, LocalService). + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NET_IF_COMPARTMENT_ID +NETIOAPI_API_ +GetJobCompartmentId( + _In_ HANDLE JobHandle + ); +/*++ + +Routine Description: + + Gets the compartment ID of a given job object. + +Arguments: + + JobHandle - Supplies the job handle. + +Return Value: + + Returns the compartment ID associated with the job. + +Permissions: + + This is open to all callers. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetJobCompartmentId( + _In_ HANDLE JobHandle, + _In_ NET_IF_COMPARTMENT_ID CompartmentId + ); +/*++ + +Routine Description: + + Sets the compartment ID of the given job object. + +Arguments: + + JobHandle - Supplies the job handle. + + CompartmentId - Supplies the new compartment ID. + +Return Value: + + If the function succeeds, the return value is NO_ERROR. + If the function fails, use FormatMessage to obtain the message string for + the returned error. + +Permissions: + + This is a privileged operation available only to network-admin-like + accounts (LocalSystem, NetworkService, LocalService). + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NET_IF_COMPARTMENT_ID +NETIOAPI_API_ +GetSessionCompartmentId( + _In_ ULONG SessionId + ); +/*++ + +Routine Description: + + Get the compartment ID of the session. + +Arguments: + + SessionId - Supplies the session ID. + +Return Value: + + The compartment ID of the session. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetSessionCompartmentId( + _In_ ULONG SessionId, + _In_ NET_IF_COMPARTMENT_ID CompartmentId + ); +/*++ + +Routine Description: + + Set the compartment ID of the session. + +Arguments: + + SessionId - Supplies the session ID. + + CompartmentId - Supplies the compartment ID to be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +NET_IF_COMPARTMENT_ID +NETIOAPI_API_ +GetDefaultCompartmentId( + VOID + ); +/*++ + +Routine Description: + + Returns the default compartment ID of the current network namespace. + +Return Value: + + Returns the default Compartment ID if successful, + NET_IF_COMPARTMENT_ID_UNSPECIFIED otherwise. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetNetworkInformation( + _In_ CONST NET_IF_NETWORK_GUID *NetworkGuid, + _Out_ PNET_IF_COMPARTMENT_ID CompartmentId, + _Out_ PULONG SiteId, + _Out_writes_(Length) PWCHAR NetworkName, + _In_ ULONG Length + ); +/*++ + +Routine Description: + + Get the network information. + +Arguments: + + NetworkGuid - Supplies the Network GUID. + + CompartmentId - Returns the compartment ID. + + SiteId - Returns Site ID. + + NetowrkName - Returns the network name. + + Length - Supplies the length of NetworkName buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetNetworkInformation( + _In_ CONST NET_IF_NETWORK_GUID *NetworkGuid, + _In_ NET_IF_COMPARTMENT_ID CompartmentId, + _In_z_ CONST WCHAR *NetworkName + ); +/*++ + +Routine Description: + + Set the Network Information. + +Arguments: + + NetworkGuid - Supplies the session ID. + + CompartmentId - Supplies the compartment ID to be set. + + NetworkName - Supplies the Network name to be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +#pragma warning(pop) + +IPHLPAPI_DLL_LINKAGE +NETIOAPI_API +ConvertLengthToIpv4Mask( + _In_ ULONG MaskLength, + _Out_ PULONG Mask + ); +/*++ + +Routine Description: + + Converts a prefixLength to a subnet mask. + +Arguments: + + MaskLength - Prefix Length. + + Mask - Mask generated. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +IPHLPAPI_DLL_LINKAGE +NETIOAPI_API +ConvertIpv4MaskToLength( + _In_ ULONG Mask, + _Out_ PUINT8 MaskLength + ); +/*++ + +Routine Description: + + Converts a subnet mask to a prefix length. + +Arguments: + + Mask - Subnet mask to use. + + MaskLength - Prefix length computed. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +#define DNS_SETTINGS_VERSION1 0x0001 +#define DNS_SETTINGS_VERSION2 0x0002 + +#define DNS_INTERFACE_SETTINGS_VERSION1 0x0001 +#define DNS_INTERFACE_SETTINGS_VERSION2 0x0002 +#define DNS_INTERFACE_SETTINGS_VERSION3 0x0003 +#define DNS_INTERFACE_SETTINGS_VERSION4 0x0004 + + +#define DNS_SETTING_IPV6 0x0001 +#define DNS_SETTING_NAMESERVER 0x0002 +#define DNS_SETTING_SEARCHLIST 0x0004 +#define DNS_SETTING_REGISTRATION_ENABLED 0x0008 +#define DNS_SETTING_REGISTER_ADAPTER_NAME 0x0010 +#define DNS_SETTING_DOMAIN 0x0020 +#define DNS_SETTING_HOSTNAME 0x0040 +#define DNS_SETTINGS_ENABLE_LLMNR 0x0080 +#define DNS_SETTINGS_QUERY_ADAPTER_NAME 0x0100 +#define DNS_SETTING_PROFILE_NAMESERVER 0x0200 +#define DNS_SETTING_DISABLE_UNCONSTRAINED_QUERIES 0x0400 +#define DNS_SETTING_SUPPLEMENTAL_SEARCH_LIST 0x0800 +#define DNS_SETTING_DOH 0x1000 +#define DNS_SETTING_DOH_PROFILE 0x2000 +#define DNS_SETTING_ENCRYPTED_DNS_ADAPTER_FLAGS 0x4000 +#define DNS_SETTING_DDR 0x8000 +#define DNS_SETTING_DOT 0x10000 +#define DNS_SETTING_DOT_PROFILE 0x20000 + +#define DNS_ENABLE_DOH 0x0001 + +#define DNS_DOH_POLICY_NOT_CONFIGURED 0x0004 +#define DNS_DOH_POLICY_DISABLE 0x0008 +#define DNS_DOH_POLICY_AUTO 0x0010 +#define DNS_DOH_POLICY_REQUIRED 0x0020 + +// +// For backwards compatibility reasons, we need to keep the old names as well. +// + +#define DNS_ENCRYPTION_POLICY_NOT_CONFIGURED DNS_DOH_POLICY_NOT_CONFIGURED +#define DNS_ENCRYPTION_POLICY_DISABLE DNS_DOH_POLICY_DISABLE +#define DNS_ENCRYPTION_POLICY_AUTO DNS_DOH_POLICY_AUTO +#define DNS_ENCRYPTION_POLICY_REQUIRED DNS_DOH_POLICY_REQUIRED + +#define DNS_ENABLE_DDR 0x0040 +#define DNS_ENABLE_DOT 0x0080 +#define DNS_DOT_POLICY_BLOCK 0x0100 +#define DNS_DOH_POLICY_BLOCK 0x0200 +#define DNS_ENABLE_DNR 0x0400 + +#define DNS_SERVER_PROPERTY_VERSION1 0x0001 + +#define DNS_DOH_SERVER_SETTINGS_ENABLE_AUTO 0x0001 +#define DNS_DOH_SERVER_SETTINGS_ENABLE 0x0002 +#define DNS_DOH_SERVER_SETTINGS_FALLBACK_TO_UDP 0x0004 +#define DNS_DOH_AUTO_UPGRADE_SERVER 0x0008 +#define DNS_DOH_SERVER_SETTINGS_ENABLE_DDR 0x0010 +#define DNS_DOH_SERVER_SETTINGS_MAKE_DDR_NON_BLOCKING 0x0020 + +#define DNS_DOT_SERVER_SETTINGS_ENABLE 0x0001 +#define DNS_DOT_SERVER_SETTINGS_FALLBACK_TO_UDP 0x0002 +#define DNS_DOT_AUTO_UPGRADE_SERVER 0x0004 +#define DNS_DOT_SERVER_SETTINGS_ENABLE_AUTO 0x0008 +#define DNS_DOT_SERVER_SETTINGS_ENABLE_DDR 0x0010 +#define DNS_DOT_SERVER_SETTINGS_MAKE_DDR_NON_BLOCKING 0x0020 + +#define DNS_DDR_ADAPTER_ENABLE_DOH 0x0001 +#define DNS_DDR_ADAPTER_ENABLE DNS_DDR_ADAPTER_ENABLE_DOH +#define DNS_DDR_ADAPTER_ENABLE_UDP_FALLBACK 0x0002 +#define DNS_DDR_ADAPTER_MAKE_DDR_NON_BLOCKING 0x0004 + +typedef struct _DNS_SETTINGS +{ + ULONG Version; + ULONG64 Flags; + PWSTR Hostname; + PWSTR Domain; + PWSTR SearchList; +} DNS_SETTINGS; + +typedef struct _DNS_SETTINGS2 +{ + ULONG Version; + ULONG64 Flags; + PWSTR Hostname; + PWSTR Domain; + PWSTR SearchList; + ULONG64 SettingFlags; +} DNS_SETTINGS2; + +typedef struct _DNS_DOH_SERVER_SETTINGS +{ +#ifdef MIDL_PASS + [unique, string] PWSTR Template; +#else + PWSTR Template; +#endif + ULONG64 Flags; +} DNS_DOH_SERVER_SETTINGS; + +typedef struct _DNS_DOT_SERVER_SETTINGS +{ +#ifdef MIDL_PASS + [unique, string] PWSTR Hostname; +#else + PWSTR Hostname; +#endif + + ULONG64 Flags; + USHORT Port; +} DNS_DOT_SERVER_SETTINGS; + +typedef enum _DNS_SERVER_PROPERTY_TYPE +{ + DnsServerInvalidProperty = 0, + DnsServerDohProperty, + DnsServerDotProperty +} DNS_SERVER_PROPERTY_TYPE; + +#ifdef MIDL_PASS +typedef [switch_type(DNS_SERVER_PROPERTY_TYPE)] union _DNS_SERVER_PROPERTY_TYPES +{ + [case(DnsServerDohProperty)] [unique] DNS_DOH_SERVER_SETTINGS *DohSettings; + [case(DnsServerDotProperty)] [unique] DNS_DOT_SERVER_SETTINGS *DotSettings; +} DNS_SERVER_PROPERTY_TYPES; +#else +typedef union _DNS_SERVER_PROPERTY_TYPES +{ + DNS_DOH_SERVER_SETTINGS *DohSettings; + DNS_DOT_SERVER_SETTINGS *DotSettings; +} DNS_SERVER_PROPERTY_TYPES; +#endif + +typedef struct _DNS_SERVER_PROPERTY +{ + ULONG Version; + ULONG ServerIndex; + DNS_SERVER_PROPERTY_TYPE Type; +#ifdef MIDL_PASS + [switch_is(Type)] DNS_SERVER_PROPERTY_TYPES Property; +#else + DNS_SERVER_PROPERTY_TYPES Property; +#endif +} DNS_SERVER_PROPERTY; + +typedef struct _DNS_INTERFACE_SETTINGS +{ + ULONG Version; + ULONG64 Flags; + PWSTR Domain; + PWSTR NameServer; + PWSTR SearchList; + ULONG RegistrationEnabled; + ULONG RegisterAdapterName; + ULONG EnableLLMNR; + ULONG QueryAdapterName; + PWSTR ProfileNameServer; +} DNS_INTERFACE_SETTINGS; + +typedef struct _DNS_INTERFACE_SETTINGS_EX +{ + DNS_INTERFACE_SETTINGS SettingsV1; + ULONG DisableUnconstrainedQueries; + PWSTR SupplementalSearchList; +} DNS_INTERFACE_SETTINGS_EX; + +typedef struct _DNS_INTERFACE_SETTINGS3 +{ + ULONG Version; + ULONG64 Flags; + PWSTR Domain; + PWSTR NameServer; + PWSTR SearchList; + ULONG RegistrationEnabled; + ULONG RegisterAdapterName; + ULONG EnableLLMNR; + ULONG QueryAdapterName; + PWSTR ProfileNameServer; + ULONG DisableUnconstrainedQueries; + PWSTR SupplementalSearchList; + ULONG cServerProperties; + DNS_SERVER_PROPERTY *ServerProperties; + ULONG cProfileServerProperties; + DNS_SERVER_PROPERTY *ProfileServerProperties; +} DNS_INTERFACE_SETTINGS3; + +typedef struct _DNS_INTERFACE_SETTINGS4 +{ + ULONG Version; + ULONG64 Flags; + PWSTR Domain; + PWSTR NameServer; + PWSTR SearchList; + ULONG RegistrationEnabled; + ULONG RegisterAdapterName; + ULONG EnableLLMNR; + ULONG QueryAdapterName; + PWSTR ProfileNameServer; + ULONG DisableUnconstrainedQueries; + PWSTR SupplementalSearchList; + ULONG cServerProperties; + DNS_SERVER_PROPERTY *ServerProperties; + ULONG cProfileServerProperties; + DNS_SERVER_PROPERTY *ProfileServerProperties; + ULONG EncryptedDnsAdapterFlags; +} DNS_INTERFACE_SETTINGS4; + +NETIOAPI_API +GetDnsSettings( + _Inout_ DNS_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Retrieves the DNS settings specified in the Settings parameter. + + The user must call FreeDnsSettings(Settings) afterwards. + +Arguments: + + Settings - GetDnsSettings will populate all the settings + in this structure. Version must be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +VOID +NETIOAPI_API_ +FreeDnsSettings( + _Inout_ DNS_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Frees the settings previously retrieved by GetDnsSettings. + This is done by invoking MIDL_user_free. + +Arguments: + + Settings - The settings structure. Version must be set. + +Return Value: + + None. + +--*/ + +NETIOAPI_API +SetDnsSettings( + _In_ const DNS_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Set the DNS settings specified in the Settings parameter. + +Arguments: + + Settings - Specifies the settings to be set. + Version must be set. + Flags is used to control which settings are to be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +NETIOAPI_API +GetInterfaceDnsSettings( + _In_ GUID Interface, + _Inout_ DNS_INTERFACE_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Retrieves the DNS settings specified in the Settings parameter. + + The user must call FreeInterfaceDnsSettings(Settings) afterwards. + +Arguments: + + Interface - The Interface GUID that the settings refer to. + + Settings - GetInterfaceDnsSettings will populate all the settings + in this structure. Version must be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +VOID +NETIOAPI_API_ +FreeInterfaceDnsSettings( + _Inout_ DNS_INTERFACE_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Frees the settings previously retrieved by GetInterfaceDnsSettings. + This is done by invoking MIDL_user_free. + +Arguments: + + Settings - The settings structure. Version must be set. + +Return Value: + + None. + +--*/ + +NETIOAPI_API +SetInterfaceDnsSettings( + _In_ GUID Interface, + _In_ const DNS_INTERFACE_SETTINGS *Settings + ); +/*++ + +Routine Description: + + Set the per interface DNS settings specified in the Settings parameter. + +Arguments: + + Interface - The Interface GUID that the settings refer to. + + Settings - Specifies the settings to be set. + Version must be set. + Flags is used to control which settings are to be set. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetNetworkConnectivityHint( + _Out_ NL_NETWORK_CONNECTIVITY_HINT *ConnectivityHint + ); +/*++ + +Routine Description: + + Queries for the aggregate level and cost of network connectivity that an + app or service is likely to experience. + +Arguments: + + ConnectivityHint - Receives the aggregate connectivity level and cost hints. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetNetworkConnectivityHintForInterface( + _In_ NET_IFINDEX InterfaceIndex, + _Out_ NL_NETWORK_CONNECTIVITY_HINT *ConnectivityHint + ); +/*++ + +Routine Description: + + Queries for the level and cost of network connectivity for the specified + interface. + +Arguments: + + InterfaceIndex - The index of the interface for which to retrieve + connectivity information. + + ConnectivityHint - Receives the connectivity level and cost hints for the + specified interface. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +--*/ + +typedef +VOID +(NETIOAPI_API_ *PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK) ( + _In_ PVOID CallerContext, + _In_ NL_NETWORK_CONNECTIVITY_HINT ConnectivityHint + ); + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +NotifyNetworkConnectivityHintChange( + _In_ PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK Callback, + _In_opt_ PVOID CallerContext, + _In_ BOOLEAN InitialNotification, + _Out_ PHANDLE NotificationHandle + ); +/*++ + +Routine Description: + + Register for notification when the aggregate network connectivity level + and cost hints change. + +Arguments: + + Callback - Supplies a callback function. This function will be invoked + when a network connectivity level or cost change occurs. + + CallerContext - Provides the user specific caller context. This context + will be supplied to the callback function. + + InitialNotification - Supplies a boolean to indicate whether an + initialization notification should be provided. + + NotificationHandle - Returns a handle to the notification registration. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + 1. Invocation of the callback function is serialized. + + 2. Use CancelMibChangeNotify2 to deregister for change notifications. + +--*/ + +#ifdef _WS2DEF_ + +// +// FL virtual interface routines. +// + +typedef enum _NET_FL_VIRTUAL_INTERFACE_ORIGIN { + NetFlVirtualInterfaceOriginOid, + NetFlVirtualInterfaceOriginApi, + NetFlVirtualInterfaceOriginDefault, +} NET_FL_VIRTUAL_INTERFACE_ORIGIN; + +typedef enum _NET_FL_ISOLATION_MODE { + NetFlIsolationModeNone, + NetFlIsolationModeVlan, + NetFlIsolationModeVsid, +} NET_FL_ISOLATION_MODE; + +typedef struct _MIB_FL_VIRTUAL_INTERFACE_ROW { + // + // Key fields. + // + + ADDRESS_FAMILY Family; + IF_LUID IfLuid; + ULONG VirtualIfId; + + // + // Mandatory fields for create, read-only for existing entries. + // + GUID CompartmentGuid; + NET_FL_ISOLATION_MODE IsolationMode; + + // + // Read-only fields. + // + + NET_FL_VIRTUAL_INTERFACE_ORIGIN Origin; + IF_LUID VirtualIfLuid; + IF_INDEX VirtualIfIndex; + + // + // Read-Write fields. + // + + BOOLEAN AllowLocalNd; + + // + // Statistics. + // + ULONG AttachedFlsnpiClients; + ULONG FlsnpiClientConfigErrors; + ULONG64 FlsnpiClientInjectErrors; + ULONG64 FlsnpiClientCloneErrors; + ULONG64 InFlsnpiIndicatedPackets; + ULONG64 InFlsnpiClientReturnedPackets; + ULONG64 InFlsnpiClientSilentlyDroppedPackets; + ULONG64 InFlsnpiClientDroppedPackets; + ULONG64 InFlsnpiClientInjectedPackets; + ULONG64 InFlsnpiClientClonedPackets; + ULONG64 OutFlsnpiIndicatedPackets; + ULONG64 OutFlsnpiClientReturnedPackets; + ULONG64 OutFlsnpiClientDroppedPackets; + ULONG64 OutFlsnpiClientSilentlyDroppedPackets; + ULONG64 OutFlsnpiClientInjectedPackets; + ULONG64 OutFlsnpiClientClonedPackets; + ULONG64 OutFlsnpiClientClonedPacketsForNbSplit; +} MIB_FL_VIRTUAL_INTERFACE_ROW, *PMIB_FL_VIRTUAL_INTERFACE_ROW; + +typedef struct _MIB_FL_VIRTUAL_INTERFACE_TABLE { + ULONG NumEntries; + MIB_FL_VIRTUAL_INTERFACE_ROW Table[ANY_SIZE]; +} MIB_FL_VIRTUAL_INTERFACE_TABLE, *PMIB_FL_VIRTUAL_INTERFACE_TABLE; + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +CreateFlVirtualInterface( + _In_ CONST MIB_FL_VIRTUAL_INTERFACE_ROW *Row + ); +/*++ + +Routine Description: + + Create an FL virtual interface on the local computer. + +Arguments: + + Row - Supplies a MIB_FL_VIRTUAL_INTERFACE_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeFlVirtualInterfaceEntry must be used to initialize the fields of + MIB_FL_VIRTUAL_INTERFACE_ROW with default values. + + On input, the following fields of Row must be set: + + 1. Family. + 2. IfLuid. + 3. VirtualIfId. + 4. CompartmentGuid. + 5. IsolationMode. + + Optionally, any read/write field may also be set. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +DeleteFlVirtualInterface( + _In_ CONST MIB_FL_VIRTUAL_INTERFACE_ROW *Row + ); +/*++ + +Routine Description: + + Delete an FL virtual interface on the local computer. + +Arguments: + + Row - Supplies a MIB_FL_VIRTUAL_INTERFACE_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Family. + 2. IfLuid. + 3. VirtualIfId. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +VOID +InitializeFlVirtualInterfaceEntry( + _Out_ PMIB_FL_VIRTUAL_INTERFACE_ROW Row + ); +/*++ + +Routine Description: + + Initialize an MIB_FL_VIRTUAL_INTERFACE_ROW entry. + +Arguments: + + Row - The MIB_FL_VIRTUAL_INTERFACE_ROW entry to initialize. + +Return Value: + + None. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +SetFlVirtualInterface( + _In_ CONST MIB_FL_VIRTUAL_INTERFACE_ROW *Row + ); +/*++ + +Routine Description: + + Sets information for the specified FL virtual interface on the local + computer. + +Arguments: + + Row - Supplies a PMIB_FL_VIRTUAL_INTERFACE_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + InitializeFlVirtualInterfaceEntry must be used to initialize the fields of + MIB_FL_VIRTUAL_INTERFACE_ROW with default values. The caller can then + update the fields it wishes to modify and invoke SetFlVirtualInterface. + + On input, the following key fields of Row must be initialized: + 1. Family. + 2. IfLuid. + 3. VirtualIfId. + + The FL virtual interface is updated the with value of any modified + read-write field. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetFlVirtualInterface( + _Inout_ PMIB_FL_VIRTUAL_INTERFACE_ROW Row + ); +/*++ + +Routine Description: + + Retrieves information for the specified FL virtual interface on the local + computer. + +Arguments: + + Row - Supplies a PMIB_FL_VIRTUAL_INTERFACE_ROW structure. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + On input, the following key fields of Row must be initialized: + 1. Family. + 2. IfLuid. + 3. VirtualIfId. + + On output, the remaining fields of Row are filled in. + +--*/ + +_IRQL_requires_max_(PASSIVE_LEVEL) +IPHLPAPI_DLL_LINKAGE +_NETIOAPI_SUCCESS_ +NETIOAPI_API +GetFlVirtualInterfaceTable( + _In_ ADDRESS_FAMILY Family, + _Outptr_ PMIB_FL_VIRTUAL_INTERFACE_TABLE *Table + ); +/*++ + +Routine Description: + + Retrieves the FL virtual interface table on a local computer. + +Arguments: + + Family - Supplies the address family. + + AF_INET: Only returns IPv4 FL virtual interfaces. + + AF_INET6: Only returns IPv6 FL virtual interfaces. + + AF_UNSPEC: Returns both IPv4 and IPv6 FL virtual interfaces. + + Table - Returns the table of FL virtual interfaces in a + PMIB_FL_VIRTUAL_INTERFACE_TABLE structure. Use FreeMibTable to free this + buffer. + +Return Value: + + User-Mode: NO_ERROR on success, error code on failure. + + Kernel-Mode: STATUS_SUCCESS on success, error code on failure. + +Notes: + + The API allocates the buffer for Table. Use FreeMibTable to free it. + +--*/ + +#endif // _WS2DEF_ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +//4201. +// +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _NETIOAPI_H_. diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netiodef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netiodef.h new file mode 100644 index 0000000000000000000000000000000000000000..c3afcc7a2a3fcaa093a135fea439faafb338a537 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/netiodef.h @@ -0,0 +1,2126 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + netiodef.h + +Abstract: + + This module contains the basic definitions and structures for the + network I/O subsystem. + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef _NETIODEF_ +#define _NETIODEF_ +#pragma once + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#pragma warning(push) +#pragma warning(disable:4200) // zero-sized array in struct/union +#pragma warning(disable:4214) // bit field types other than int +#pragma warning(disable:4201) // nameless struct/union + + +#include +#include +#include +#include +#include + +#ifndef ASSERT +#define ASSERT(exp) ((void) 0) +#define NETIODEF_DEFINED_ASSERT +#endif + +#ifndef NETIO_INLINE +#if DBG +#define NETIO_INLINE __inline +#else +#define NETIO_INLINE __forceinline +#endif +#endif + + +#define IS_POWER_OF_TWO(x) (((x) != 0) && (((x) & ((x) - 1)) == 0)) + +#if defined(_NTDDK_) || defined(_NTRTL_) + +#define IS_VALID_IPV4_MASK(x) \ + ((x.S_un.S_addr == (ULONG)-1) || IS_POWER_OF_TWO(~RtlUlongByteSwap(x.S_un.S_addr)+1)) + +#endif + +#ifndef BYTE_ORDER + +#define _LITTLE_ENDIAN 1234 // least-significant byte first (vax) +#define _BIG_ENDIAN 4321 // most-significant byte first (IBM, net) +#define _PDP_ENDIAN 3412 // LSB first in word, MSW first in long (pdp) + +#if defined(vax) || defined(ns32000) || defined(sun386) || defined(MIPSEL) || \ + defined(BIT_ZERO_ON_RIGHT) +#define BYTE_ORDER _LITTLE_ENDIAN +#endif + +#if defined(sel) || defined(pyr) || defined(mc68000) || defined(sparc) || \ + defined(is68k) || defined(tahoe) || defined(ibm032) || defined(ibm370) || \ + defined(MIPSEB) || defined (BIT_ZERO_ON_LEFT) +#define BYTE_ORDER _BIG_ENDIAN +#endif + +#ifndef BYTE_ORDER // still not defined +#if defined(u3b2) || defined(m68k) +#define BYTE_ORDER _BIG_ENDIAN +#endif + +#if defined(i286) || defined(_X86_) || defined(_AMD64_) || defined(_IA64_) || defined(_ARM_) || defined(_ARM64_) +#define BYTE_ORDER _LITTLE_ENDIAN +#endif + +#endif +#endif + +#ifndef BYTE_ORDER + // you must determine what the correct bit order is for your compiler + UNDEFINED_BIT_ORDER; +#endif + +// +// Opaque handles that are a specific number of bits wide. +// + +typedef UINT8 HANDLE8, *PHANDLE8; +typedef UINT16 HANDLE16, *PHANDLE16; +typedef UINT32 HANDLE32, *PHANDLE32; + +#ifndef __HANDLE64_DEFINED__ +#define __HANDLE64_DEFINED__ +typedef void* POINTER_64 HANDLE64; +typedef HANDLE64 *PHANDLE64; +#endif + + +#define MAKE_DD_DEVICE_NAME(x) (L"\\Device\\" x) +#define MAKE_WIN_DEVICE_NAME(x) (L"\\\\.\\" x) + + +#include + +#if defined(_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4001) /* nonstandard extension : single line comment */ +#pragma warning(disable:4200) /* nonstandard extension used : zero-sized array in struct/union */ +#pragma warning(disable:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning(disable:4214) /* nonstandard extension used : bit field types other then int */ +#endif // defined(_MSC_VER) + +// +// For buffer sizing convenience, define a maximum datalink address length. +// +#define DL_ADDRESS_LENGTH_MAXIMUM IF_MAX_PHYS_ADDRESS_LENGTH +#define DL_HEADER_LENGTH_MAXIMUM 64 + +#define DL_ETHERNET_HEADER_LENGTH_MAXIMUM \ + (sizeof(ETHERNET_HEADER) + sizeof(SNAP_HEADER)) + +#define DL_TUNNEL_HEADER_LENGTH_MAXIMUM \ + max(sizeof(IPV4_HEADER), sizeof(IPV6_HEADER)) + + +// +// DL_ADDRESS_TYPE +// +// Define datalink layer address types. +// +#ifndef _DEFINE_DL_ADDRESS_TYPE_ +#define _DEFINE_DL_ADDRESS_TYPE_ +typedef enum { + DlUnicast, + DlMulticast, + DlBroadcast +} DL_ADDRESS_TYPE, *PDL_ADDRESS_TYPE; +#endif // _DEFINE_DL_ADDRESS_TYPE_ + +// +// DL_OUI +// +// Define Organizationally Unique Identifier. +// + +union _DL_OUI { + UINT8 Byte[3]; + struct { // 1st byte. 0bxxxxxxLG. + UINT8 Group : 1; // least significant bit. + UINT8 Local : 1; + }; +}; + +typedef union _DL_OUI DL_OUI, *PDL_OUI; + + +// +// DL_EI48 +// +// Define Extension Identifier for EUI-48 Addresses. +// + +union _DL_EI48 { + UINT8 Byte[3]; +}; + +typedef union _DL_EI48 DL_EI48, *PDL_EI48; + +// +// DL_EUI48 +// +// Define EUI-48 Address. +// + +union _DL_EUI48 { + UINT8 Byte[6]; + struct { + DL_OUI Oui; + DL_EI48 Ei48; + }; +}; + +typedef union _DL_EUI48 DL_EUI48, *PDL_EUI48; + +C_ASSERT(DL_ADDRESS_LENGTH_MAXIMUM >= sizeof(DL_EUI48)); + +#define EUI48_BROADCAST_INIT { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } + +extern CONST DL_EUI48 eui48_broadcast; + + +// +// DL_EI64 +// +// Define Extension Identifier for EUI-64 Addresses. +// + +union _DL_EI64 { + UINT8 Byte[5]; +}; + +typedef union _DL_EI64 DL_EI64, *PDL_EI64; + + +// +// DL_EUI64 +// +// Define EUI-64 Address. +// + +union _DL_EUI64 { + UINT8 Byte[8]; + UINT64 Value; + struct { + DL_OUI Oui; + union { + DL_EI64 Ei64; + struct { // draft-templin-ngtrans-v6v4compat-02. + UINT8 Type; // Determines interpretation of rest. + UINT8 Tse; // Type specific extention. + DL_EI48 Ei48; // Encapsulated EUI-48 EI. + }; + }; + }; +}; + +typedef union _DL_EUI64 DL_EUI64, *PDL_EUI64; + + +// +// SNAP_HEADER +// +// Define a structure for the SNAP header. +// + +typedef struct _SNAP_HEADER { + UINT8 Dsap; + UINT8 Ssap; + UINT8 Control; + UINT8 Oui[3]; + UINT16 Type; +} SNAP_HEADER, *PSNAP_HEADER; + +#define SNAP_DSAP 0xaa +#define SNAP_SSAP 0xaa +#define SNAP_CONTROL 0x03 +#define SNAP_OUI 0x00 + +// +// Since TYPE values are identical to those used by ethernet... +// + +#define SNAP_TYPE_ARP ETHERNET_TYPE_ARP +#define SNAP_TYPE_IPV4 ETHERNET_TYPE_IPV4 +#define SNAP_TYPE_IPV6 ETHERNET_TYPE_IPV6 + + +// +// ETHERNET_HEADER +// +// Define a common structure for the ethernet and IEEE 802 headers. +// NOTE: An IEEE 802 header is followed by a SNAP header. +// + +typedef struct _ETHERNET_HEADER { + DL_EUI48 Destination; + DL_EUI48 Source; + union { + UINT16 Type; // Ethernet + UINT16 Length; // IEEE 802 + }; +} ETHERNET_HEADER, *PETHERNET_HEADER; + +#define ETH_LENGTH_OF_HEADER 14 +#define ETH_LENGTH_OF_VLAN_HEADER 4 +#define ETH_LENGTH_OF_SNAP_HEADER 8 + +C_ASSERT(ETH_LENGTH_OF_HEADER == sizeof(ETHERNET_HEADER)); +C_ASSERT(ETH_LENGTH_OF_SNAP_HEADER == sizeof(SNAP_HEADER)); + +#define ETHERNET_TYPE_MINIMUM 0x0600 // Minimum valid Type value. +#define ETHERNET_TYPE_IPV4 0x0800 +#define ETHERNET_TYPE_ARP 0x0806 +#define ETHERNET_TYPE_IPV6 0x86dd +#define ETHERNET_TYPE_802_1Q 0x8100 +#define ETHERNET_TYPE_802_1AD 0x88a8 + +// +// VLAN_TAG +// + +typedef struct _VLAN_TAG { + union { + UINT16 Tag; + struct { + UINT16 VID:12; // least significant bit + UINT16 CFI:1; + UINT16 User_Priority:3; + }; + }; + UINT16 Type; // this really is the type, since we come after the SNAP header +} VLAN_TAG; + +C_ASSERT(ETH_LENGTH_OF_VLAN_HEADER == sizeof(VLAN_TAG)); + + +__inline +DL_ADDRESS_TYPE +EthernetAddressType( + _In_reads_(sizeof(DL_EUI48)) CONST UCHAR *Address + ) +{ + if (((PDL_EUI48) Address)->Oui.Group) { + if (RtlEqualMemory(Address, &eui48_broadcast, sizeof(DL_EUI48))) { + return DlBroadcast; + } + return DlMulticast; + } else { + return DlUnicast; + } +} + +#if defined (_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4001) /* nonstandard extension : single line comment */ +#pragma warning(default:4200) /* nonstandard extension used : zero-sized array in struct/union */ +#pragma warning(default:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning(default:4214) /* nonstandard extension used : bit field types other then int */ +#endif +#endif + + +typedef struct _ICMP_HEADER { + UINT8 Type; // Type of message (high bit zero for error messages). + UINT8 Code; // Type-specific differentiater. + UINT16 Checksum; // Calculated over ICMP message and IPvx pseudo-header. +} ICMP_HEADER, *PICMP_HEADER; + +typedef struct _ICMP_MESSAGE { + ICMP_HEADER Header; + union { + UINT32 Data32[1]; // Type-specific field. + UINT16 Data16[2]; // Type-specific field. + UINT8 Data8[4]; // Type-specific field. + } Data; +} ICMP_MESSAGE, *PICMP_MESSAGE; + + +#if defined(_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4001) /* nonstandard extension : single line comment */ +#pragma warning(disable:4200) /* nonstandard extension used : zero-sized array in struct/union */ +#pragma warning(disable:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning(disable:4214) /* nonstandard extension used : bit field types other then int */ +#endif // defined(_MSC_VER) + +// +// IPV4_HEADER +// +// Define the structure of an IPv4 header. +// The field names match those in section 3.1 of RFC 791. +// RFC 2474 redefines type of service to the 6 bit DSCP value. RFC 2780 and +// 3168 redefine the unused 2 bits in the traffic class octet as used by +// ECN. +// + +typedef struct _IPV4_HEADER { + union { + UINT8 VersionAndHeaderLength; // Version and header length. + struct { + UINT8 HeaderLength : 4; + UINT8 Version : 4; + }; + }; + union { + UINT8 TypeOfServiceAndEcnField; // Type of service & ECN (RFC 3168). + struct { + UINT8 EcnField : 2; + UINT8 TypeOfService : 6; + }; + }; + UINT16 TotalLength; // Total length of datagram. + UINT16 Identification; + union { + UINT16 FlagsAndOffset; // Flags and fragment offset. + struct { + UINT16 DontUse1 : 5; // High bits of fragment offset. + UINT16 MoreFragments : 1; + UINT16 DontFragment : 1; + UINT16 Reserved : 1; + UINT16 DontUse2 : 8; // Low bits of fragment offset. + }; + }; + UINT8 TimeToLive; + UINT8 Protocol; + UINT16 HeaderChecksum; + IN_ADDR SourceAddress; + IN_ADDR DestinationAddress; +} IPV4_HEADER, *PIPV4_HEADER; + +#define ip4_hdr _IPV4_HEADER +#define ip4_ver_hlen VersionAndHeaderLength +#define ip4_ver Version +#define ip4_hlen HeaderLength +#define ip4_tos TypeOfService +#define ip4_len TotalLength +#define ip4_id Identification +#define ip4_flags_offset FlagsAndOffset +#define ip4_flags Flags +#define ip4_offset FragmentOffset +#define ip4_ttl TimeToLive +#define ip4_protocol Protocol +#define ip4_xsum HeaderChecksum +#define ip4_src SourceAddress +#define ip4_dest DestinationAddress + +C_ASSERT(sizeof(IPV4_HEADER) == 20); + +#define IP_VER_MASK 0xF0 // Version is high 4 bits of ip4_ver_hlen. +#define IPV4_VERSION 4 +#define IPV4_VERSION_BYTE (IPV4_VERSION << 4) +#define IPV4_DEFAULT_VERHLEN ((IPV4_VERSION_BYTE) | \ + (sizeof(IPV4_HEADER) / sizeof(UINT32))) + +#define MAX_IPV4_PACKET 65535 +#define MAX_IPV4_PAYLOAD (MAX_IPV4_PACKET - sizeof(IPV4_HEADER)) + +#define MAX_IPV4_HLEN 60 + +#define IPV4_MINIMUM_MTU 576 +#define IPV4_MINIMUM_ULMTU (IPV4_MINIMUM_MTU - sizeof(IPV4_HEADER)) + +// +// The maximum and minimum values for the lower limit of the value the MTU can +// have during PMTU discovery. +// +// The minimum value was chosen to be a reasonable limit for real-world +// scenarios, while at the same time minimizing security risks. +// + +#define IPV4_MIN_MINIMUM_MTU 352 +#define IPV4_MAX_MINIMUM_MTU IPV4_MINIMUM_MTU + +// +// TODO: remove UNALIGNED qualifier once NetGetDataBuffer takes an +// alignment argument. +// +__inline +UCHAR +Ip4HeaderLengthInBytes( + _In_ CONST UNALIGNED IPV4_HEADER *Header + ) +{ + return (Header->HeaderLength << 2); +} + +// +// Maximum length of IP options. +// +#define MAX_IP_OPTIONS_LENGTH ((0xF * sizeof(UINT32)) - sizeof(IPV4_HEADER)) + +#define SIZEOF_IP_OPT_ROUTING_HEADER 3 + +#define SIZEOF_IP_OPT_TIMESTAMP_HEADER 4 + +#define SIZEOF_IP_OPT_SECURITY 11 +#define SIZEOF_IP_OPT_STREAMIDENTIFIER 4 +#define SIZEOF_IP_OPT_ROUTERALERT 4 + +#define IP4_OFF_MASK 0xff1f // Mask out offset from FlagsAndOffset. + +#if defined(_NTDDK_) || defined(_NTRTL_) +// +// Only include this definition if RtlUshortByteSwap is defined. +// + +__inline +UINT16 +Ip4FragmentOffset( + _In_ CONST UNALIGNED IPV4_HEADER *Header + ) +{ + return RtlUshortByteSwap(Header->FlagsAndOffset & IP4_OFF_MASK) << 3; +} + +#endif + +// +// IPV4_OPTION_HEADER +// +typedef struct _IPV4_OPTION_HEADER { + union { + UINT8 OptionType; // Option type. + struct { + UINT8 OptionNumber : 5; + UINT8 OptionClass : 2; + UINT8 CopiedFlag : 1; + }; + }; + UINT8 OptionLength; // Length in bytes, starting from the OptionType field. +} IPV4_OPTION_HEADER, *PIPV4_OPTION_HEADER; + +C_ASSERT(sizeof(IPV4_OPTION_HEADER) == 2); + +#ifndef IP_EXPORT_INCLUDED +typedef enum { + IP_OPT_EOL = 0x00, // End of list option. + IP_OPT_NOP = 0x01, // No operation. + IP_OPT_SECURITY = 0x82, // Security option (RFC 1108). + IP_OPT_LSRR = 0x83, // Loose source route. + IP_OPT_TS = 0x44, // Timestamp. + IP_OPT_RR = 0x07, // Record route. + IP_OPT_SSRR = 0x89, // Struct source route. + IP_OPT_SID = 0x88, // Stream ID (obsolete). + IP_OPT_ROUTER_ALERT = 0x94, // Router alert option (RFC 2113). + IP_OPT_MULTIDEST = 0x95, // Multi-destination option (RFC 1770). +} IPV4_OPTION_TYPE; + +#else // IP_EXPORT_INCLUDED +typedef ULONG IPV4_OPTION_TYPE; + +#endif // IP_EXPORT_INCLUDED + +typedef struct _IPV4_TIMESTAMP_OPTION { +#ifdef __cplusplus + IPV4_OPTION_HEADER OptionHeader; +#else + IPV4_OPTION_HEADER; +#endif + UINT8 Pointer; + union { + UINT8 FlagsOverflow; + struct { + UINT8 Flags : 4; + UINT8 Overflow : 4; + }; + }; +} IPV4_TIMESTAMP_OPTION, *PIPV4_TIMESTAMP_OPTION; + +typedef enum { + IP_OPTION_TIMESTAMP_ONLY = 0, + IP_OPTION_TIMESTAMP_ADDRESS = 1, + IP_OPTION_TIMESTAMP_SPECIFIC_ADDRESS = 3 +} IP_OPTION_TIMESTAMP_FLAGS; + +// +// Structure to interpret the IPv4 loose and strict source routing options as +// a routing header similar to IPv6. +// +typedef struct _IPV4_ROUTING_HEADER { +#ifdef __cplusplus + IPV4_OPTION_HEADER OptionHeader; +#else + IPV4_OPTION_HEADER; +#endif + UINT8 Pointer; +} IPV4_ROUTING_HEADER; +typedef IPV4_ROUTING_HEADER UNALIGNED *PIPV4_ROUTING_HEADER; + +// +// ICMPV4_HEADER +// +// Define the structure of an ICMPv4 header. +// + +typedef ICMP_HEADER ICMPV4_HEADER, *PICMPV4_HEADER; + +typedef ICMP_MESSAGE ICMPV4_MESSAGE, *PICMPV4_MESSAGE; + +#define icmp4_hdr _ICMPV4_MESSAGE +#define icmp4_type Header.Type +#define icmp4_code Header.Code +#define icmp4_cksum Header.Checksum +#define icmp4_un_data32 Data32 +#define icmp4_un_data16 Data16 +#define icmp4_un_data8 Data8 +#define icmp4_dataun Data + +#define icmp4_data32 icmp4_dataun.icmp4_un_data32 +#define icmp4_data16 icmp4_dataun.icmp4_un_data16 +#define icmp4_data8 icmp4_dataun.icmp4_un_data8 +#define icmp4_pptr icmp4_data32[0] // Parameter problem. +#define icmp4_mtu icmp4_data32[0] // Packet too big. +#define icmp4_id icmp4_data16[0] // Echo request/reply. +#define icmp4_seq icmp4_data16[1] // Echo request/reply. +#define icmp4_maxdelay icmp4_data16[0] // Multicast group membership. + +// +// ICMP4_UNREACH_CODE +// +// Define codes for the ICMPv4 destination-unreachable error message. +// + +typedef enum { + ICMP4_UNREACH_NET = 0, + ICMP4_UNREACH_HOST = 1, + ICMP4_UNREACH_PROTOCOL = 2, + ICMP4_UNREACH_PORT = 3, + ICMP4_UNREACH_FRAG_NEEDED = 4, + ICMP4_UNREACH_SOURCEROUTE_FAILED = 5, + ICMP4_UNREACH_NET_UNKNOWN = 6, + ICMP4_UNREACH_HOST_UNKNOWN = 7, + ICMP4_UNREACH_ISOLATED = 8, + ICMP4_UNREACH_NET_ADMIN = 9, + ICMP4_UNREACH_HOST_ADMIN = 10, + ICMP4_UNREACH_NET_TOS = 11, + ICMP4_UNREACH_HOST_TOS = 12, + ICMP4_UNREACH_ADMIN = 13, +} ICMP4_UNREACH_CODE, *PICMP4_UNREACH_CODE; + +// +// ICMP4_TIME_EXCEED_CODE +// +// Define codes for the ICMPv4 time-exceeded error message. +// + +typedef enum { + ICMP4_TIME_EXCEED_TRANSIT = 0, // TTL == 0 in transit + ICMP4_TIME_EXCEED_REASSEMBLY = 1, // Reassembly time out +} ICMP4_TIME_EXCEED_CODE, *PICMP4_TIME_EXCEED_CODE; + +// +// Define a structure for IPv4 router solicitation. +// +typedef struct _ICMPV4_ROUTER_SOLICIT { + ICMPV4_MESSAGE RsHeader; +} ICMPV4_ROUTER_SOLICIT, *PICMPV4_ROUTER_SOLICIT; + +#define RsType RsHeader.icmp4_type +#define RsCode RsHeader.icmp4_code +#define RsCksum RsHeader.icmp4_cksum +#define RsReserved RsHeader.icmp4_data32[0] + +typedef struct _ICMPV4_ROUTER_ADVERT_HEADER { + ICMPV4_MESSAGE RaHeader; + // + // Could be followed by a list of router addresses. + // +} ICMPV4_ROUTER_ADVERT_HEADER, *PICMPV4_ROUTER_ADVERT_HEADER; + +#define RaType RaHeader.icmp4_type +#define RaCode RaHeader.icmp4_code +#define RaCksum RaHeader.icmp4_cksum +#define RaNumAddr RaHeader.icmp4_data8[0] +#define RaAddrEntrySize RaHeader.icmp4_data8[1] +#define RaAddrLifetime RaHeader.icmp4_data16[1] + +typedef struct _ICMPV4_ROUTER_ADVERT_ENTRY { + IN_ADDR RouterAdvertAddr; + LONG PreferenceLevel; +} ICMPV4_ROUTER_ADVERT_ENTRY, *PICMPV4_ROUTER_ADVERT_ENTRY; + +#define ICMPV4_INVALID_PREFERENCE_LEVEL 0x80000000 + +typedef struct _ICMPV4_TIMESTAMP_MESSAGE { + ICMPV4_MESSAGE Header; + UINT32 OriginateTimestamp; + UINT32 ReceiveTimestamp; + UINT32 TransmitTimestamp; +} ICMPV4_TIMESTAMP_MESSAGE, *PICMPV4_TIMESTAMP_MESSAGE; + +typedef struct _ICMPV4_ADDRESS_MASK_MESSAGE { + ICMPV4_MESSAGE Header; + UINT32 AddressMask; +} ICMPV4_ADDRESS_MASK_MESSAGE, *PICMPV4_ADDRESS_MASK_MESSAGE; + +#define icmp4_ts_type Header.icmp4_type +#define icmp4_ts_code Header.icmp4_code +#define icmp4_ts_cksum Header.icmp4_cksum +#define icmp4_ts_id Header.icmp4_id +#define icmp4_ts_seq Header.icmp4_seq +#define icmp4_ts_originate OriginateTimestamp +#define icmp4_ts_receive ReceiveTimestamp +#define icmp4_ts_transmit TransmitTimestamp + +// +// ARP_HEADER +// +// Define the structure of an ARP header. +// The field names are derived from those in RFC 826. +// + +typedef struct _ARP_HEADER { + USHORT HardwareAddressSpace; + USHORT ProtocolAddressSpace; + UCHAR HardwareAddressLength; + UCHAR ProtocolAddressLength; + USHORT Opcode; + UCHAR SenderHardwareAddress[0]; + // + // Followed by: + // SenderProtocolAddress, + // TargetHardwareAddress, + // TargetProtocolAddress. + // +} ARP_HEADER, *PARP_HEADER; + +// +// Opcode values in the ARP header. +// http://www.iana.org/assignments/arp-parameters +// is the authoritative source of these. +// + +typedef enum { + ARP_REQUEST = 1, + ARP_RESPONSE = 2 +} ARP_OPCODE; + +// +// HardwareAddressSpace values in the ARP header. +// http://www.iana.org/assignments/arp-parameters +// is the authoritative source of these. +// + +typedef enum { + ARP_HW_ENET = 1, + ARP_HW_802 = 6 +} ARP_HARDWARE_TYPE; + +// +// Types of IGMP messages. +// +#define IGMP_QUERY_TYPE 0x11 +#define IGMP_VERSION1_REPORT_TYPE 0x12 +#define IGMP_VERSION2_REPORT_TYPE 0x16 +#define IGMP_LEAVE_GROUP_TYPE 0x17 +#define IGMP_VERSION3_REPORT_TYPE 0x22 + +// +// IGMP_HEADER +// +// Define the structure of an IGMPv1/IGMPv2 header. +// +typedef struct _IGMP_HEADER { + union { + struct { + UINT8 Type : 4; + UINT8 Version : 4; + }; + UINT8 VersionType; + }; + union { + UINT8 Reserved; // IGMPv1. + UINT8 MaxRespTime; // IGMPv2. + UINT8 Code; // DVMRP. + }; + UINT16 Checksum; + IN_ADDR MulticastAddress; +} IGMP_HEADER, *PIGMP_HEADER; + +typedef enum { + IGMP_MAX_RESP_CODE_TYPE_NORMAL = 0, + IGMP_MAX_RESP_CODE_TYPE_FLOAT +} IGMP_MAX_RESP_CODE_TYPE; + +// +// IGMPV3_QUERY_HEADER +// +// Define the structure of an IGMPv3 query header. The fields names are derived +// from RFC 3376. +// +typedef struct _IGMPV3_QUERY_HEADER { + UINT8 Type; + union { + UINT8 MaxRespCode; + struct { + UINT8 MaxRespCodeMantissa : 4; + UINT8 MaxRespCodeExponent : 3; + UINT8 MaxRespCodeType : 1; + }; + }; + UINT16 Checksum; + IN_ADDR MulticastAddress; + UINT8 QuerierRobustnessVariable : 3; + UINT8 SuppressRouterSideProcessing : 1; + UINT8 Reserved : 4; + union { + UINT8 QueriersQueryInterfaceCode; + struct { + UINT8 QQCMantissa : 4; + UINT8 QQCExponent : 3; + UINT8 QQCType : 1; + }; + }; + UINT16 SourceCount; +} IGMPV3_QUERY_HEADER, *PIGMPV3_QUERY_HEADER; + +// +// IGMPV3_REPORT_RECORD_HEADER +// +// Defines the structure of the record header within a IGMPv3 report message +// (RFC 3376). +// +typedef struct _IGMPV3_REPORT_RECORD_HEADER { + UINT8 Type; + UINT8 AuxillaryDataLength; + UINT16 SourceCount; + IN_ADDR MulticastAddress; +} IGMPV3_REPORT_RECORD_HEADER, *PIGMPV3_REPORT_RECORD_HEADER; + +// +// IGMPV3_HEADER +// +// Define the structure of an IGMPv3 report message header (RFC 3376). +// +typedef struct _IGMPV3_REPORT_HEADER_ { + UINT8 Type; + UINT8 Reserved; + UINT16 Checksum; + UINT16 Reserved2; + UINT16 RecordCount; +} IGMPV3_REPORT_HEADER, *PIGMPV3_REPORT_HEADER; + +#if defined (_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4001) /* nonstandard extension : single line comment */ +#pragma warning(default:4200) /* nonstandard extension used : zero-sized array in struct/union */ +#pragma warning(default:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning(default:4214) /* nonstandard extension used : bit field types other then int */ +#endif +#endif + + +// +// IPV6_HEADER +// +// The structure for an IPv6 header. +// RAW socket applications, packetization layer modules, and +// network-layer services all need access to this structure. +// +typedef struct _IPV6_HEADER { + union { + UINT32 VersionClassFlow; // 4 bits Version, 8 Traffic Class, 20 Flow Label. + struct { // Convenience structure to access Version field only. + UINT32 : 4; + UINT32 Version : 4; + UINT32 : 24; + }; + }; + UINT16 PayloadLength; // Zero indicates Jumbo Payload hop-by-hop option. + UINT8 NextHeader; // Values are superset of IPv4's Protocol field. + UINT8 HopLimit; + IN6_ADDR SourceAddress; + IN6_ADDR DestinationAddress; +} IPV6_HEADER, *PIPV6_HEADER; + +// +// Defines for RFC 3542 compatibility. +// +#define ip6_hdr _IPV6_HEADER +#define ip6_flow VersionClassFlow +#define ip6_plen PayloadLength +#define ip6_nxt NextHeader +#define ip6_hops HopLimit +#define ip6_hlim HopLimit +#define ip6_src SourceAddress +#define ip6_dst DestinationAddress + +// +// Useful constants for working with various fields in the IPv6 header. +// +// NOTE: We keep the Version, Traffic Class and Flow Label fields as a single +// NOTE: 32 bit value (VersionClassFlow) in network byte order (big-endian). +// NOTE: Since NT is little-endian, this means all loads/stores to/from this +// NOTE: field need to be byte swapped. +// +#define IP_VER_MASK 0xF0 // Version is high 4 bits of VersionClassFlow. +#define IPV6_VERSION 0x60 // This is 6 << 4. + +// +// RFC 2474 redefines traffic class to the 6 bit DSCP value. RFC 2780 and +// 3168 redefine the unused 2 bits in the traffic class octet as used by +// ECN. +// +#define IPV6_TRAFFIC_CLASS_MASK 0x0000C00F // 0x0FC00000 (after byte swap). +#define IPV6_FULL_TRAFFIC_CLASS_MASK 0x0000F00F // 0x0FF00000 (after byte swap). +#define IPV6_ECN_MASK 0x00003000 // 0x00300000 (after byte swap). +#define IPV6_FLOW_LABEL_MASK 0xFFFF0F00 // 0x000FFFFF (after byte swap). +#define MAX_IPV6_PAYLOAD 65535 +#define MAX_IPV6_PACKET (MAX_IPV6_PAYLOAD + sizeof(IPV6_HEADER)) + +#define IPV6_ECN_SHIFT 12 // Bits to shift to recover ECN field. + +#define IPV6_MINIMUM_MTU 1280 +#define IPV6_MINIMUM_ULMTU (IPV6_MINIMUM_MTU - sizeof(IPV6_HEADER)) + +#define IPV6_TRAFFIC_CLASS(VersionClassFlow) \ + ((UCHAR)((((VersionClassFlow) & IPV6_TRAFFIC_CLASS_MASK) >> 12) + \ + (((VersionClassFlow) & IPV6_TRAFFIC_CLASS_MASK) << 4))) + +#define IPV6_FULL_TRAFFIC_CLASS(VersionClassFlow) \ + ((UCHAR)((((VersionClassFlow) & IPV6_FULL_TRAFFIC_CLASS_MASK) >> 12) + \ + (((VersionClassFlow) & IPV6_FULL_TRAFFIC_CLASS_MASK) << 4))) + +// +// IPV6_FRAGMENT_HEADER +// +// The structure for an IPv6 Fragment Header. +// RAW socket applications and network-layer services all need +// access to this structure. +// +typedef struct _IPV6_FRAGMENT_HEADER { + UINT8 NextHeader; // Next Header. + UINT8 Reserved; // Reserved field. + union { + struct { + UINT16 DontUse1 : 8; + UINT16 MoreFragments : 1; // Least significant bit. + UINT16 ReservedBits : 2; + UINT16 DontUse2 : 5; + }; + UINT16 OffsetAndFlags; + }; + UINT32 Id; // Identification. +} IPV6_FRAGMENT_HEADER, *PIPV6_FRAGMENT_HEADER; + +C_ASSERT(sizeof(IPV6_FRAGMENT_HEADER) == 8); + +// +// Defines for RFC 3542 compatibility. +// +#define ip6_frag _IPV6_FRAGMENT_HEADER +#define ip6f_nxt NextHeader +#define ip6f_reserved Reserved +#define ip6f_offlg OffsetAndFlags +#define ip6f_ident Id + +// +// Useful constants from RFC 3542 for working with the ip6f_offlg field. +// These are in network byte order. +// +#define IP6F_OFF_MASK 0xf8ff // Mask out offset from _offlg. +#define IP6F_RESERVED_MASK 0x0600 // Reserved bits in ip6f_offlg. +#define IP6F_MORE_FRAG 0x0100 // More-fragments flag. + +#if defined(_NTDDK_) || defined(_NTRTL_) +// +// Only include this definition if RtlUshortByteSwap is defined. +// + +__inline +UINT16 +Ip6FragmentOffset( + _In_ CONST UNALIGNED IPV6_FRAGMENT_HEADER *Header + ) +{ + return RtlUshortByteSwap(Header->OffsetAndFlags & IP6F_OFF_MASK); +} + +#endif + +// +// IPV6_EXTENSION_HEADER +// +typedef struct _IPV6_EXTENSION_HEADER { + UINT8 NextHeader; // Next header. + UINT8 Length; // In 8-byte units, not counting first 8. +} IPV6_EXTENSION_HEADER, *PIPV6_EXTENSION_HEADER; + +#define EXT_LEN_UNIT 8 // 8-byte units used for extension hdr length. + +#define IPV6_EXTENSION_HEADER_LENGTH(Blocks) ((Blocks + 1) * EXT_LEN_UNIT) +#define MAX_IPV6_EXTENSION_HEADER_LENGTH IPV6_EXTENSION_HEADER_LENGTH(0xFF) +#define IPV6_EXTENSION_HEADER_BLOCKS(Length) ((Length / EXT_LEN_UNIT) - 1) +#define IP_AUTHENTICATION_HEADER_LENGTH(Blocks) ((Blocks + 2) * 4) +#define IP_AUTHENTICATION_HEADER_BLOCKS(Length) \ + (((Length + sizeof(AUTHENTICATION_HEADER)) / 4) - 2) + +#define IPV6_ROUTER_ALERT_LENGTH IPV6_EXTENSION_HEADER_LENGTH(0) + +// +// Defines for RFC 3542 compatibility. +// +#define ip6_hbh _IPV6_EXTENSION_HEADER +#define ip6h_nxt NextHeader +#define ip6h_len Length +#define ip6_dest _IPV6_EXTENSION_HEADER +#define ip6d_nxt NextHeader +#define ip6d_len Length + + +// +// IPV6_OPTION_HEADER +// + +typedef struct _IPV6_OPTION_HEADER { + UINT8 Type; + UINT8 DataLength; // In bytes, not counting two for the header. +} IPV6_OPTION_HEADER, *PIPV6_OPTION_HEADER; + +typedef enum { + IP6OPT_PAD1 = 0x00, // 00 0 00000. Single byte pad. + IP6OPT_PADN = 0x01, // 00 0 00001. Multiple byte pad. + IP6OPT_TUNNEL_LIMIT = 0x04, // 00 0 00100. + IP6OPT_ROUTER_ALERT = 0x05, // 00 0 00101. Router alert. + IP6OPT_JUMBO = 0xc2, // 11 0 00010. Jumbogram, greater than 64KB. + IP6OPT_NSAP_ADDR = 0xc3, // 11 0 00011. +} IPV6_OPTION_TYPE, *PIPV6_OPTION_TYPE; + +#define IP6OPT_TYPE(Type) ((Type) & 0xc0) +#define IP6OPT_TYPE_SKIP 0x00 +#define IP6OPT_TYPE_DISCARD 0x40 +#define IP6OPT_TYPE_FORCEICMP 0x80 +#define IP6OPT_TYPE_ICMP 0xc0 + +#define IP6OPT_MUTABLE 0x20 +#define IP6OPT_ISMUTABLE(Type) (((Type) & IP6OPT_MUTABLE) != 0) + +typedef struct _IPV6_OPTION_JUMBOGRAM { + IPV6_OPTION_HEADER Header; + UINT8 JumbogramLength[4]; +} IPV6_OPTION_JUMBOGRAM, *PIPV6_OPTION_JUMBOGRAM; + +#define ip6_opt_jumbo _IPV6_OPTION_JUMBOGRAM +#define ip6oj_type Header.Type +#define ip6oj_len Header.DataLength +#define ip6oj_jumbo_len JumbogramLength + + +typedef struct _IPV6_OPTION_ROUTER_ALERT { + IPV6_OPTION_HEADER Header; + UINT8 Value[2]; +} IPV6_OPTION_ROUTER_ALERT, *PIPV6_OPTION_ROUTER_ALERT; + +#define ip6_opt_router _IPV6_OPTION_ROUTER_ALERT +#define ip6or_type Header.Type +#define ip6or_len Header.DataLength +#define ip6or_value Value + +#define SIZEOF_IPV6_ROUTERALERT IPV6_EXTENSION_HEADER_LENGTH(0) + + +typedef _Struct_size_bytes_(_Inexpressible_(Length)) struct _IPV6_ROUTING_HEADER { + UCHAR NextHeader; + UCHAR Length; // In 8-byte units, not counting first 8. + UCHAR RoutingType; + UCHAR SegmentsLeft; // Number of nodes still left to be visited. + UCHAR Reserved[4]; // Not a u_int to avoid alignment. +} IPV6_ROUTING_HEADER, *PIPV6_ROUTING_HEADER; + +// +// Defines for RFC 3542 compatibility. +// +#define ip6_rthdr _IPV6_ROUTING_HEADER +#define ip6r_nxt NextHeader +#define ip6r_len Length +#define ip6r_type RoutingType +#define ip6r_segleft SegmentsLeft + +// +// ICMPV6_HEADER +// +// struct icmp6_hdr is the RFC 3542 structure for an ICMPv6 header. +// RAW socket applications and network-layer services all need +// access to this structure. +// + +typedef ICMP_HEADER ICMPV6_HEADER, *PICMPV6_HEADER; + +typedef ICMP_MESSAGE ICMPV6_MESSAGE, *PICMPV6_MESSAGE; + +// +// Defines for RFC 3542 compatibility. +// +#define icmp6_hdr _ICMPV6_MESSAGE +#define icmp6_type Header.Type +#define icmp6_code Header.Code +#define icmp6_cksum Header.Checksum +#define icmp6_un_data32 Data32 +#define icmp6_un_data16 Data16 +#define icmp6_un_data8 Data8 +#define icmp6_dataun Data + +#define icmp6_data32 icmp6_dataun.icmp6_un_data32 +#define icmp6_data16 icmp6_dataun.icmp6_un_data16 +#define icmp6_data8 icmp6_dataun.icmp6_un_data8 +#define icmp6_pptr icmp6_data32[0] // Parameter problem. +#define icmp6_mtu icmp6_data32[0] // Packet too big. +#define icmp6_id icmp6_data16[0] // Echo request/reply. +#define icmp6_seq icmp6_data16[1] // Echo request/reply. +#define icmp6_maxdelay icmp6_data16[0] // Multicast group membership. + +#define ICMP6_INFOMSG_MASK 0x80 // All informational messages. + +#define ICMP6_DST_UNREACH_NOROUTE 0 // No route to destination. +#define ICMP6_DST_UNREACH_ADMIN 1 // Communication with destination + // administratively prohibited. +#define ICMP6_DST_UNREACH_BEYONDSCOPE 2 // Beyond scope of source address. +#define ICMP6_DST_UNREACH_ADDR 3 // Address unreachable. +#define ICMP6_DST_UNREACH_NOPORT 4 // Bad port. + +#define ICMP6_TIME_EXCEED_TRANSIT 0 // Hop Limit == 0 in transit. +#define ICMP6_TIME_EXCEED_REASSEMBLY 1 // Reassembly time out. + +#define ICMP6_PARAMPROB_HEADER 0 // Erroneous header field. +#define ICMP6_PARAMPROB_NEXTHEADER 1 // Unrecognized Next Header. +#define ICMP6_PARAMPROB_OPTION 2 // Unrecognized IPv6 option. +#define ICMP6_PARAMPROB_FIRSTFRAGMENT 3 // IPv6 First Fragment is incomplete. + +#define ICMPV6_ECHO_REQUEST_FLAG_REVERSE 0x1 + +// +// ND_ROUTER_SOLICIT_HEADER +// +// Define a structure for an IPv6 Router Solicitation header. +// + +typedef struct nd_router_solicit { + ICMPV6_MESSAGE nd_rs_hdr; + // + // Could be followed by options. + // +} ND_ROUTER_SOLICIT_HEADER, *PND_ROUTER_SOLICIT_HEADER; + +#define nd_rs_type nd_rs_hdr.icmp6_type +#define nd_rs_code nd_rs_hdr.icmp6_code +#define nd_rs_cksum nd_rs_hdr.icmp6_cksum +#define nd_rs_reserved nd_rs_hdr.icmp6_data32[0] + + +// +// ND_ROUTER_ADVERT_HEADER +// +// Define a structure for an IPv6 Router Advertisement header. +// + +typedef struct nd_router_advert { + ICMPV6_MESSAGE nd_ra_hdr; + UINT32 nd_ra_reachable; // Reachable Time. + UINT32 nd_ra_retransmit; // Retransmit Timer. + // + // Could be followed by options. + // +} ND_ROUTER_ADVERT_HEADER, *PND_ROUTER_ADVERT_HEADER; + +#define nd_ra_type nd_ra_hdr.icmp6_type +#define nd_ra_code nd_ra_hdr.icmp6_code +#define nd_ra_cksum nd_ra_hdr.icmp6_cksum +#define nd_ra_curhoplimit nd_ra_hdr.icmp6_data8[0] +#define nd_ra_flags_reserved nd_ra_hdr.icmp6_data8[1] +#define ND_RA_FLAG_MANAGED 0x80 +#define ND_RA_FLAG_OTHER 0x40 +#define ND_RA_FLAG_HOME_AGENT 0x20 +#define ND_RA_FLAG_PREFERENCE 0x18 +#define nd_ra_router_lifetime nd_ra_hdr.icmp6_data16[1] + + +// +// IPV6_ROUTER_ADVERTISEMENT_FLAGS +// +// Define flags included in an IPv6 Router Advertisement message. +// + +typedef union _IPV6_ROUTER_ADVERTISEMENT_FLAGS { + struct { + UINT8 Reserved : 3; // Least significant bits. + UINT8 Preference : 2; + UINT8 HomeAgent : 1; + UINT8 OtherStatefulConfiguration : 1; + UINT8 ManagedAddressConfiguration : 1; + }; + UINT8 Value; +} IPV6_ROUTER_ADVERTISEMENT_FLAGS, *PIPV6_ROUTER_ADVERTISEMENT_FLAGS; + + +// +// ND_NEIGHBOR_SOLICIT_HEADER +// +// Define a structure for an IPv6 Neighbor Solicitation header. +// + +typedef struct nd_neighbor_solicit { + ICMPV6_MESSAGE nd_ns_hdr; + IN6_ADDR nd_ns_target; // Target Address. + // + // Could be followed by options. + // +} ND_NEIGHBOR_SOLICIT_HEADER, *PND_NEIGHBOR_SOLICIT_HEADER; + +#define nd_ns_type nd_ns_hdr.icmp6_type +#define nd_ns_code nd_ns_hdr.icmp6_code +#define nd_ns_cksum nd_ns_hdr.icmp6_cksum +#define nd_ns_reserved nd_ns_hdr.icmp6_data32[0] + + +// +// ND_NEIGHBOR_ADVERT_HEADER +// +// Define a structure for an IPv6 Neighbor Advertisement header. +// + +typedef struct nd_neighbor_advert { + ICMPV6_MESSAGE nd_na_hdr; + IN6_ADDR nd_na_target; // Target Address. + // + // Could be followed by options. + // +} ND_NEIGHBOR_ADVERT_HEADER, *PND_NEIGHBOR_ADVERT_HEADER; + +#define nd_na_type nd_na_hdr.icmp6_type +#define nd_na_code nd_na_hdr.icmp6_code +#define nd_na_cksum nd_na_hdr.icmp6_cksum +#define nd_na_flags_reserved nd_na_hdr.icmp6_data32[0] + +#if (BYTE_ORDER == _BIG_ENDIAN) +#define ND_NA_FLAG_ROUTER 0x80000000 +#define ND_NA_FLAG_SOLICITED 0x40000000 +#define ND_NA_FLAG_OVERRIDE 0x20000000 +#else // BYTE_ORDER == _LITTLE_ENDIAN +#define ND_NA_FLAG_ROUTER 0x00000080 +#define ND_NA_FLAG_SOLICITED 0x00000040 +#define ND_NA_FLAG_OVERRIDE 0x00000020 +#endif + + +// +// IPV6_NEIGHBOR_ADVERTISEMENT_FLAGS +// +// Define flags included in an IPv6 Neighbor Advertisement message. +// + +typedef union _IPV6_NEIGHBOR_ADVERTISEMENT_FLAGS { + struct { + UINT8 Reserved1 : 5; // Least significant bits. + UINT8 Override : 1; + UINT8 Solicited : 1; + UINT8 Router : 1; + UINT8 Reserved2[3]; + }; + UINT32 Value; +} IPV6_NEIGHBOR_ADVERTISEMENT_FLAGS, *PIPV6_NEIGHBOR_ADVERTISEMENT_FLAGS; + + +// +// ND_REDIRECT_HEADER +// +// Define a structure for an IPv6 Router Redirect header. +// + +typedef struct nd_redirect { + ICMPV6_MESSAGE nd_rd_hdr; + IN6_ADDR nd_rd_target; // Target Address. + IN6_ADDR nd_rd_dst; // Destination Address. + // + // Could be followed by options. + // +} ND_REDIRECT_HEADER, *PND_REDIRECT_HEADER; + +#define nd_rd_type nd_rd_hdr.icmp6_type +#define nd_rd_code nd_rd_hdr.icmp6_code +#define nd_rd_cksum nd_rd_hdr.icmp6_cksum +#define nd_rd_reserved nd_rd_hdr.icmp6_data32[0] + + +// +// ND_OPTION_HDR +// +// Define a structure for neighbor discovery option header. +// + +typedef struct nd_opt_hdr { + UINT8 nd_opt_type; + UINT8 nd_opt_len; // In units of 8 octets. + // + // Followed by option specific data. + // +} ND_OPTION_HDR, *PND_OPTION_HDR; + + +// +// ND_OPTION_TYPE +// +// Define values for neighbor discovery option type. +// + +typedef enum { + ND_OPT_SOURCE_LINKADDR = 1, + ND_OPT_TARGET_LINKADDR = 2, + ND_OPT_PREFIX_INFORMATION = 3, + ND_OPT_REDIRECTED_HEADER = 4, + ND_OPT_MTU = 5, + ND_OPT_NBMA_SHORTCUT_LIMIT = 6, + ND_OPT_ADVERTISEMENT_INTERVAL = 7, + ND_OPT_HOME_AGENT_INFORMATION = 8, + ND_OPT_SOURCE_ADDR_LIST = 9, + ND_OPT_TARGET_ADDR_LIST = 10, + ND_OPT_ROUTE_INFO = 24, + ND_OPT_RDNSS = 25, + ND_OPT_DNSSL = 31, + ND_OPT_PREF64 = 38, +} ND_OPTION_TYPE, *PND_OPTION_TYPE; + + +// +// ND_OPTION_PREFIX_INFO +// +// Define a structure for a Prefix Information option. +// + +typedef struct nd_opt_prefix_info { + UINT8 nd_opt_pi_type; + UINT8 nd_opt_pi_len; + UINT8 nd_opt_pi_prefix_len; + union { + UINT8 nd_opt_pi_flags_reserved; + struct { + UINT8 Route : 1; // Least significant bit. + UINT8 Reserved1 : 3; + UINT8 SitePrefix : 1; + UINT8 RouterAddress : 1; + UINT8 Autonomous : 1; + UINT8 OnLink : 1; + } Flags; + }; + UINT32 nd_opt_pi_valid_time; + UINT32 nd_opt_pi_preferred_time; + union { + UINT32 nd_opt_pi_reserved2; + struct { + UINT8 nd_opt_pi_reserved3[3]; + UINT8 nd_opt_pi_site_prefix_len; + }; + }; + IN6_ADDR nd_opt_pi_prefix; +} ND_OPTION_PREFIX_INFO, *PND_OPTION_PREFIX_INFO; + +#define ND_OPT_PI_FLAG_ONLINK 0x80 +#define ND_OPT_PI_FLAG_AUTO 0x40 +#define ND_OPT_PI_FLAG_ROUTER_ADDR 0x20 +#define ND_OPT_PI_FLAG_SITE_PREFIX 0x10 +#define ND_OPT_PI_FLAG_ROUTE 0x01 + + +// +// ND_OPTION_RD_HDR +// +// Define a structure for a Redirected Header option. +// + +typedef struct nd_opt_rd_hdr { + UINT8 nd_opt_rh_type; + UINT8 nd_opt_rh_len; + UINT16 nd_opt_rh_reserved1; + UINT32 nd_opt_rh_reserved2; + // + // Followed by IP header and data. + // +} ND_OPTION_RD_HDR, *PND_OPTION_RD_HDR; + + +// +// ND_OPTION_MTU +// +// Define a structure for an MTU option. +// + +typedef struct nd_opt_mtu { + UINT8 nd_opt_mtu_type; + UINT8 nd_opt_mtu_len; + UINT16 nd_opt_mtu_reserved; + UINT32 nd_opt_mtu_mtu; +} ND_OPTION_MTU, *PND_OPTION_MTU; + + +// +// ND_OPTION_ROUTE_INFO +// +// Define a structure for a Route Information option. +// +// If PrefixLength is zero, then the Prefix field may be 0 bytes. +// If PrefixLength is <= 64, then the Prefix field may be 8 bytes. +// Otherwise the Prefix field is a full 16 bytes. +// + +typedef struct nd_opt_route_info { + UINT8 nd_opt_ri_type; + UINT8 nd_opt_ri_len; + UINT8 nd_opt_ri_prefix_len; + union { + UINT8 nd_opt_ri_flags_reserved; + struct { + UINT8 Reserved : 3; // Least significant bits. + UINT8 Preference : 2; + } Flags; + }; + UINT32 nd_opt_ri_route_lifetime; + IN6_ADDR nd_opt_ri_prefix; +} ND_OPTION_ROUTE_INFO, *PND_OPTION_ROUTE_INFO; + +#define ND_OPT_RI_FLAG_PREFERENCE 0x18 + +// +// ND_OPTION_RDNSS +// +// Define a structure for a RDNSS option. +// + +typedef struct nd_opt_rdnss { + UINT8 nd_opt_rdnss_type; + UINT8 nd_opt_rdnss_len; + UINT16 nd_opt_rdnss_reserved; + UINT32 nd_opt_rdnss_lifetime; + // + // Followed by one or more 128-bit IPv6 addresses of + // the recursive DNS servers. The number of addresses + // is determined by the Length field. i.e. the number + // of addresses is equal to (nd_opt_rdnss_len - 1) / 2. + // +} ND_OPTION_RDNSS, *PND_OPTION_RDNSS; + +// +// Minimum length in bytes of the RDNSS option if there is +// at least one IPv6 address (3 * 8 = 24 octets). +// +#define ND_OPT_RDNSS_MIN_LEN 24 + +// +// ND_OPTION_DNSSL +// +// Define a structure for a DNSSL option. +// + +typedef struct nd_opt_dnssl { + UINT8 nd_opt_dnssl_type; + UINT8 nd_opt_dnssl_len; + UINT16 nd_opt_dnssl_reserved; + UINT32 nd_opt_dnssl_lifetime; + // + // Followed by one or more domain names of DNS Search List + // that MUST be encoded using the technique described in + // Section 3.1 of [RFC1035]. By this technique, each domain + // name is represented as a sequence of labels ending in + // a zero octet, defined as domain name representation. + // For more than one domain name, the corresponding + // domain name representations are concatenated as they + // are. Because the size of this field MUST be a multiple + // of 8 octets, for the minimum multiple including the + // domain name representations, the remaining octets other + // than the encoding parts of the domain name representations + // MUST be padded with zeros. + // +} ND_OPTION_DNSSL, *PND_OPTION_DNSSL; + +// +// Minimum length in bytes of the DNSSL option if there is +// atleast one suffix (2 * 8 = 16 octets). +// +#define ND_OPT_DNSSL_MIN_LEN 16 + +// +// ND_OPTION_PREF64 +// +// Define a structure for a PREF64 option. +// + +typedef struct nd_opt_pref64_info { + UINT8 nd_opt_p64_type; + UINT8 nd_opt_p64_len; + union { + UINT16 nd_opt_p64_lifetime_plc; + struct { + UINT16 nd_opt_p64_prefix_length_code : 3; // Least significant bits. + UINT16 nd_opt_p64_scaled_lifetime : 13; + }; + }; + UINT8 nd_opt_p64_prefix[12]; +} ND_OPTION_PREF64, *PND_OPTION_PREF64; + +// +// PREF64 prefix length encoding. +// + +typedef enum { + ND_OPT_PREF64_PREFIX_LENGTH_96 = 0, // prefix length is 96 bits + ND_OPT_PREF64_PREFIX_LENGTH_64, // prefix length is 64 bits + ND_OPT_PREF64_PREFIX_LENGTH_56, // prefix length is 56 bits + ND_OPT_PREF64_PREFIX_LENGTH_48, // prefix length is 48 bits + ND_OPT_PREF64_PREFIX_LENGTH_40, // prefix length is 40 bits + ND_OPT_PREF64_PREFIX_LENGTH_32, // prefix length is 32 bits +} ND_OPT_PREF64_PREFIX_LENGTH_CODE; + +// +// MLD_HEADER. +// +// Defines the structure of the MLD (version 1) header. +// +typedef struct _MLD_HEADER { + ICMPV6_HEADER IcmpHeader; + UINT16 MaxRespTime; + UINT16 Reserved; + IN6_ADDR MulticastAddress; +} MLD_HEADER, *PMLD_HEADER; + +#define mld_type IcmpHeader.Type +#define mld_checksum IcmpHeader.Checksum + +typedef enum { + MLD_MAX_RESP_CODE_TYPE_NORMAL = 0, + MLD_MAX_RESP_CODE_TYPE_FLOAT +} MLD_MAX_RESP_CODE_TYPE; + +// +// MLDV2_QUERY_HEADER. +// +// Defines the structure of MLDv2 query header. +// +typedef struct _MLDV2_QUERY_HEADER { + ICMPV6_HEADER IcmpHeader; + union { + UINT16 MaxRespCode; + struct { + UINT16 MaxRespCodeMantissaHi : 4; + UINT16 MaxRespCodeExponent : 3; + UINT16 MaxRespCodeType : 1; + UINT16 MaxRespCodeMantissaLo : 8; + }; + }; + UINT16 Reserved; + IN6_ADDR MulticastAddress; + UINT8 QuerierRobustnessVariable : 3; + UINT8 SuppressRouterSideProcessing : 1; + UINT8 QueryReserved : 4; + union { + UINT8 QueriersQueryInterfaceCode; + struct { + UINT8 QQCMantissa : 4; + UINT8 QQCExponent : 3; + UINT8 QQCType : 1; + }; + }; + UINT16 SourceCount; +} MLDV2_QUERY_HEADER, *PMLDV2_QUERY_HEADER; + +// +// MLDV2_REPORT_RECORD_HEADER. +// +// Defines the structure of the MLDv2 record header contained in a MLDv2 +// report. There can be multiple record headers in a single MLDv2 report. +// +typedef struct _MLDV2_REPORT_RECORD_HEADER { + UINT8 Type; + UINT8 AuxillaryDataLength; + UINT16 SourceCount; + IN6_ADDR MulticastAddress; +} MLDV2_REPORT_RECORD_HEADER, *PMLDV2_REPORT_RECORD_HEADER; + +// +// MLDV2_REPORT_HEADER. +// +// Defines the structure of a MLDv2 report. +// +typedef struct _MLDV2_REPORT_HEADER { + ICMPV6_HEADER IcmpHeader; + UINT16 Reserved; + UINT16 RecordCount; +} MLDV2_REPORT_HEADER, *PMLDV2_REPORT_HEADER; + +#if defined(_NTDDK_) || defined(_NTRTL_) + +__inline +UINT32 +Ipv6pGetVersionClassEcnFlow( + IN UINT8 Class, + IN UINT8 EcnField, + IN UINT32 Flow + ) +{ + // + // IPv6 Version, Traffic Class, ECN Field and Flow Label fields in host + // byte order. + // + union { + struct { + UINT32 Flow : 20; + UINT32 EcnField : 2; + UINT32 Class : 6; + UINT32 Version : 4; // Most significant bits. + }; + UINT32 Value; + } VersionClassEcnFlow = {0}; + + VersionClassEcnFlow.Version = 6; + VersionClassEcnFlow.Class = Class; + VersionClassEcnFlow.EcnField = EcnField; + VersionClassEcnFlow.Flow = Flow; + if ((Flow != 0) && (VersionClassEcnFlow.Flow == 0)) { + // + // If LSBs (20 bits) of Flow are all 0s, use its MSBs. + // + VersionClassEcnFlow.Flow = (Flow >> 12); + } + return RtlUlongByteSwap(VersionClassEcnFlow.Value); +} + +#endif + +// +// Shared definitions for NAT64 / DNS64 +// + +#define IN6_EMBEDDEDV4_UOCTET_POSITION 8 +#define IN6_EMBEDDEDV4_BITS_IN_BYTE 8 + +__inline +UINT32 +In6IsEmbeddedV4AddrPrefixLengthValid( + _In_ ULONG PrefixLength + ) +{ + // + // Checks per draft-ietf-behave-address-format-06. + // + if ((PrefixLength % IN6_EMBEDDEDV4_BITS_IN_BYTE) != 0) { + return FALSE; + } + + if ((PrefixLength != 32) && + (PrefixLength != 40) && + (PrefixLength != 48) && + (PrefixLength != 56) && + (PrefixLength != 64) && + (PrefixLength != 96)) { + return FALSE; + } + + return TRUE; +} + +_Success_(return) +__inline +UINT32 +In6ExtractEmbeddedV4AddrFromV6( + _In_ const IN6_ADDR *Ipv6Address, + _In_ ULONG PrefixLength, + _Out_ IN_ADDR *Ipv4Address + ) +{ + IN6_ADDR TmpAddress; + + if (!In6IsEmbeddedV4AddrPrefixLengthValid(PrefixLength)) { + return FALSE; + } + + if (PrefixLength < 96) { + RtlCopyMemory( + &TmpAddress, + Ipv6Address, + sizeof(IN6_ADDR)); + + RtlMoveMemory( + (((PUCHAR)&TmpAddress) + IN6_EMBEDDEDV4_UOCTET_POSITION), + (((PUCHAR)&TmpAddress) + IN6_EMBEDDEDV4_UOCTET_POSITION + 1), + sizeof(IN6_ADDR) - (IN6_EMBEDDEDV4_UOCTET_POSITION + 1)); + + RtlCopyMemory( + Ipv4Address, + (((PUCHAR) &TmpAddress) + PrefixLength / IN6_EMBEDDEDV4_BITS_IN_BYTE), + sizeof(IN_ADDR)); + } else { + RtlCopyMemory( + Ipv4Address, + (((PUCHAR) Ipv6Address) + PrefixLength / IN6_EMBEDDEDV4_BITS_IN_BYTE), + sizeof(IN_ADDR)); + } + + return TRUE; +} + +_Success_(return) +__inline +UINT32 +In6SetAddrV4Embedded( + _In_ const IN6_ADDR *Prefix, + _In_ ULONG PrefixLength, + _In_ IN_ADDR *Ipv4Address, + _Out_ IN6_ADDR *Ipv6Address + ) +{ + ULONG PrefixByteLength; + + if (!In6IsEmbeddedV4AddrPrefixLengthValid(PrefixLength)) { + return FALSE; + } + + PrefixByteLength = PrefixLength / IN6_EMBEDDEDV4_BITS_IN_BYTE; + + RtlCopyMemory(Ipv6Address, Prefix, PrefixByteLength); + + RtlCopyMemory( + (((PUCHAR)Ipv6Address) + PrefixByteLength), + Ipv4Address, + sizeof(IN_ADDR)); + + if (PrefixLength < 96) { + RtlZeroMemory( + (((PUCHAR)Ipv6Address) + PrefixByteLength + sizeof(IN_ADDR)), + sizeof(IN6_ADDR) - (PrefixByteLength + sizeof(IN_ADDR))); + RtlMoveMemory( + (((PUCHAR)Ipv6Address) + IN6_EMBEDDEDV4_UOCTET_POSITION + 1), + (((PUCHAR)Ipv6Address) + IN6_EMBEDDEDV4_UOCTET_POSITION), + sizeof(IN6_ADDR) - (IN6_EMBEDDEDV4_UOCTET_POSITION + 1)); + + *(((PUCHAR)Ipv6Address) + IN6_EMBEDDEDV4_UOCTET_POSITION) = 0; + } + + return TRUE; +} + + +// +// SEQ_NUM +// +// Define a type for TCP sequence numbers. +// + +typedef UINT32 SEQ_NUM, *PSEQ_NUM; + +// +// TCP_HDR +// +// Define the structure of a TCP header. +// +// $REVIEW: We shouldn't have two different structures for representing +// a TCP header. Can we get rid of this one? +// + +#pragma pack(push, 1) + +typedef struct tcp_hdr { + UINT16 th_sport; + UINT16 th_dport; + SEQ_NUM th_seq; + SEQ_NUM th_ack; + UINT8 th_x2 : 4; + UINT8 th_len : 4; + UINT8 th_flags; + UINT16 th_win; + UINT16 th_sum; + UINT16 th_urp; +} TCP_HDR +#if NDIS_RECEIVE_UNALIGNED + ; +typedef TCP_HDR UNALIGNED *PTCP_HDR; +#else + , *PTCP_HDR; +#endif + +#pragma pack(pop) + +// +// Define the maximum length of a TCP header with options. +// + +#define TH_MAX_LEN (0x0F << 2) + +// +// Define the bits in TCP_HDR.th_flags. +// + +#define TH_FIN 0x01 +#define TH_SYN 0x02 +#define TH_RST 0x04 +#define TH_PSH 0x08 +#define TH_ACK 0x10 +#define TH_URG 0x20 +#define TH_ECE 0x40 +#define TH_CWR 0x80 +#define TH_ALL \ + (TH_FIN | TH_SYN | TH_RST | TH_PSH | TH_ACK | TH_URG | TH_ECE | TH_CWR) +#define TH_SYN_ALL \ + (TH_FIN | TH_SYN | TH_RST | TH_ACK) + +// +// Define the options appearing in a TCP header. +// + +#define TH_OPT_EOL 0x00 +#define TH_OPT_NOP 0x01 +#define TH_OPT_MSS 0x02 +#define TH_OPT_WS 0x03 +#define TH_OPT_SACK_PERMITTED 0x04 +#define TH_OPT_SACK 0x05 +#define TH_OPT_TS 0x08 +#define TH_OPT_FASTOPEN 0x22 + +#pragma pack(push, 1) + +// +// TCP_OPT_MSS +// + +typedef struct tcp_opt_mss { + UINT8 Kind; + UINT8 Length; + UINT16 Mss; +} TCP_OPT_MSS; + +// +// TCP_OPT_WS +// + +typedef struct tcp_opt_ws { + UINT8 Kind; + UINT8 Length; + UINT8 ShiftCnt; +} TCP_OPT_WS; + +// +// TCP_OPT_SACK_PERMITTED +// + +typedef struct tcp_opt_sack_permitted { + UINT8 Kind; + UINT8 Length; +} TCP_OPT_SACK_PERMITTED; + +// +// TCP_OPT_SACK +// + +typedef struct tcp_opt_sack { + UINT8 Kind; + UINT8 Length; + struct tcp_opt_sack_block { + SEQ_NUM Left; + SEQ_NUM Right; + } Block[0]; +} TCP_OPT_SACK; + +// +// TCP_OPT_TS +// + +typedef struct tcp_opt_ts { + UINT8 Kind; + UINT8 Length; + UINT32 Val; + UINT32 EcR; +} TCP_OPT_TS; + +// +// TCP_OPT_UNKNOWN +// + +typedef struct tcp_opt_unknown { + UINT8 Kind; + UINT8 Length; +} TCP_OPT_UNKNOWN; + +// +// TCP_OPT_FASTOPEN +// +// A fastopen cookie can be zero bytes (for a request) or 4 to 16 bytes. +// + +typedef struct tcp_opt_fastopen { + UINT8 Kind; + UINT8 Length; + UINT8 Cookie[0]; +} TCP_OPT_FASTOPEN; + +#pragma pack(pop) + + +#include + +#if defined(_MSC_VER) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4001) /* nonstandard extension : single line comment */ +#pragma warning(disable:4200) /* nonstandard extension used : zero-sized array in struct/union */ +#pragma warning(disable:4201) /* nonstandard extension used : nameless struct/union */ +#pragma warning(disable:4214) /* nonstandard extension used : bit field types other then int */ +#endif // defined(_MSC_VER) + +// +// DL_TUNNEL_ADDRESS +// +// Define IP in IP tunnel datalink address. +// + +typedef struct DL_TUNNEL_ADDRESS { + COMPARTMENT_ID CompartmentId; + SCOPE_ID ScopeId; + UCHAR IpAddress[0]; +} DL_TUNNEL_ADDRESS, *PDL_TUNNEL_ADDRESS; + +#define DL_SIZEOF_TUNNEL_ADDRESS(AddressBytes) \ + (FIELD_OFFSET(DL_TUNNEL_ADDRESS, IpAddress) + (AddressBytes)) +#define DL_SIZEOF_IPV4_TUNNEL_ADDRESS \ + DL_SIZEOF_TUNNEL_ADDRESS(sizeof(IN_ADDR)) +#define DL_SIZEOF_IPV6_TUNNEL_ADDRESS \ + DL_SIZEOF_TUNNEL_ADDRESS(sizeof(IN6_ADDR)) + +C_ASSERT(DL_ADDRESS_LENGTH_MAXIMUM >= DL_SIZEOF_IPV4_TUNNEL_ADDRESS); + +C_ASSERT(DL_ADDRESS_LENGTH_MAXIMUM >= DL_SIZEOF_IPV6_TUNNEL_ADDRESS); + + +// +// Tunnel sub-type used to differentiate different tunnel +// technologies when the tunnel-type is TUNNEL_TYPE_OTHER +// +typedef enum _TUNNEL_SUB_TYPE { + TUNNEL_SUB_TYPE_NONE = 0, + TUNNEL_SUB_TYPE_CP = 1, + TUNNEL_SUB_TYPE_IPTLS = 2, + TUNNEL_SUB_TYPE_HA = 3 +} TUNNEL_SUB_TYPE, *PTUNNEL_SUB_TYPE; + + +// +// DL_TEREDO_ADDRESS +// +// Define Teredo tunnel datalink address. +// + +#pragma pack(push, 1) +typedef struct DL_TEREDO_ADDRESS { + UINT8 Reserved[6]; + union { + DL_EUI64 Eui64; + struct { + USHORT Flags; + USHORT MappedPort; + IN_ADDR MappedAddress; + }; + }; +} DL_TEREDO_ADDRESS, *PDL_TEREDO_ADDRESS; + +typedef struct DL_TEREDO_ADDRESS_PRV { + UINT8 Reserved[6]; + union { + DL_EUI64 Eui64; + struct { + USHORT Flags; + USHORT MappedPort; + IN_ADDR MappedAddress; + // + // FL shunt + // + IN_ADDR LocalAddress; + IF_INDEX InterfaceIndex; + USHORT LocalPort; + DL_EUI48 DlDestination; + }; + }; +} DL_TEREDO_ADDRESS_PRV, *PDL_TEREDO_ADDRESS_PRV; +#pragma pack(pop) + +#pragma pack(push, 1) +typedef struct _IPTLS_METADATA { + ULONGLONG SequenceNumber; +} IPTLS_METADATA,*PIPTLS_METADATA; +#pragma pack(pop) + +C_ASSERT(DL_ADDRESS_LENGTH_MAXIMUM >= sizeof(DL_TEREDO_ADDRESS)); + + +#include + +#define NMR_REG_KEY_PATH L"\\Registry\\Machine\\System\\CurrentControlSet\\Control\\NMR\\providers" + +typedef enum _NPI_MODULEID_TYPE { + MIT_GUID = 1, + MIT_IF_LUID, +} NPI_MODULEID_TYPE; + + +// +// Network Module Identifier. +// This type is persistable. +// +typedef struct _NPI_MODULEID { + USHORT Length; + + NPI_MODULEID_TYPE Type; +#ifdef __midl + [switch_type(NPI_MODULEID_TYPE), switch_is(Type)] +#endif + union + { + // + // Valid for MIT_GUID + // + #ifdef __midl + [case(MIT_GUID)] + #endif + GUID Guid; + + // + // Valid for MIT_IF_LUID + // TODO: NET_IFLUID is not an "RPC'able" define yet. + // + + #ifdef __midl + [case(MIT_IF_LUID)] + #endif + LUID IfLuid; + #ifdef __midl + [default]; + #endif + }; +} NPI_MODULEID; +typedef CONST NPI_MODULEID *PNPI_MODULEID; + +#ifndef __midl +__inline +BOOLEAN +NmrIsEqualNpiModuleId( + _In_ PNPI_MODULEID ModuleId1, + _In_ PNPI_MODULEID ModuleId2 + ) +{ + if (ModuleId1->Type == ModuleId2->Type) { + if (ModuleId1->Type == MIT_GUID) { +#ifdef __cplusplus + return !!InlineIsEqualGUID(ModuleId1->Guid, ModuleId2->Guid); +#else + return (BOOLEAN)InlineIsEqualGUID(&ModuleId1->Guid, &ModuleId2->Guid); +#endif + } else if (ModuleId1->Type == MIT_IF_LUID) { + return (BOOLEAN)RtlEqualMemory(&ModuleId1->IfLuid, + &ModuleId2->IfLuid, + sizeof(LUID)); + } + } + return FALSE; +} +#endif + +// +// Network Programming Interface Identifier: an immutable, globally +// unique identifier for the programming interface. +// +typedef GUID NPIID; +typedef CONST NPIID *PNPIID; + +extern CONST NPI_MODULEID NPI_MS_NMR_MODULEID; + + +// +// "Requested Packet Filter" Bits. +// + +#define FL_PACKET_TYPE_FLAGS \ + (NDIS_PACKET_TYPE_ALL_MULTICAST | NDIS_PACKET_TYPE_PROMISCUOUS | \ + NDIS_PACKET_TYPE_NO_LOCAL) + +extern CONST NPIID NPI_FRAMING_LAYER_ID; + +extern CONST NPI_MODULEID NPI_MS_TUN_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL48_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL68_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL4L_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL6L_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL4T_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL6T_MODULEID; +extern CONST NPI_MODULEID NPI_MS_WANARPV4_MODULEID; +extern CONST NPI_MODULEID NPI_MS_WANARPV6_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FL_WANARP_MODULEID; +extern CONST NPI_MODULEID NPI_MS_FLRDMA_MODULEID; + +// +// TODO: remove this. +// +extern CONST NPI_MODULEID NPI_MS_NDIS_MODULEID; + + +extern CONST NPIID NPI_NETWORK_LAYER_ID; + +extern CONST NPI_MODULEID NPI_MS_IPV6_MODULEID; +extern CONST NPI_MODULEID NPI_MS_IPV4_MODULEID; + +typedef enum { + FallbackIndexTcpFastopen, + FallbackIndexMax +} FALLBACK_INDEX; + + + +#ifdef NETIODEF_DEFINED_ASSERT +// +// ASSERT wasn't defined before, so undefine it now to restore the original +// state. +// +#undef ASSERT +#endif + +#pragma warning(pop) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#endif // _NETIODEF_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nettypes.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nettypes.h new file mode 100644 index 0000000000000000000000000000000000000000..78e0ebbdd8544f89b73924677fc7ca5bbee8df88 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nettypes.h @@ -0,0 +1,88 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + nettypes.h + +Abstract: + + This header file contains type definitions for the NT TDI, NDI, + DDI, and PDI interfaces which are not specific to a single interface. + +Revision History: + +--*/ + +#ifndef _NETTYPES_ +#define _NETTYPES_ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +// +// The following basic type is used to provide extensibility in request +// and response packets. The OFFSET type is used to contain a value which +// is interpreted as a relative address consisting of a number of bytes +// from the beginning of the immediate parent structure. +// + +typedef ULONG OFFSET; + +// +// The following basic type is used throughout all the layers to pass a +// string through an I/O interface which does not allow embedded pointers. +// To allocate a FLAT_STRING, one must make room for the correct number of +// buffer bytes in the allocation. +// + +typedef struct _FLAT_STRING { + SHORT MaximumLength; // total size of string buffer. + SHORT Length; // number of bytes represented in string. + char Buffer [1]; // the buffer itself follows this struct. +} FLAT_STRING, *PFLAT_STRING; + +// +// Basic type used to represent a network name, typically as a component of +// a transport address structure through the TDI. This type is also passed +// through the NDI interface. This type is declared as a structure so that +// it can be extended easily without modifying applications, even though it +// currently only has one element. +// +// + +typedef struct _NETWORK_NAME { + FLAT_STRING Name; // network name in FLAT_STRING format. +} NETWORK_NAME, *PNETWORK_NAME; + +// +// Basic type used to represent an address at the hardware level of the +// network. Hardware addresses are abstract types which are mapped to +// adapter addresses by the physical provider. See the Physical Driver +// Interface specification for details on how this is accomplished. +// + +#define HARDWARE_ADDRESS_LENGTH 6 // number of octets in a hardware address. + +typedef struct _HARDWARE_ADDRESS { + UCHAR Address [HARDWARE_ADDRESS_LENGTH]; +} HARDWARE_ADDRESS, *PHARDWARE_ADDRESS; + +// +// Network management variable types used by all interface levels. +// + +#define NETMAN_VARTYPE_ULONG 0 // type is a ULONG. +#define NETMAN_VARTYPE_HARDWARE_ADDRESS 1 // type is a HARDWARE_ADDRESS. +#define NETMAN_VARTYPE_STRING 2 // type is a FLAT_STRING. + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _NETTYPES_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcdtadev.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcdtadev.h new file mode 100644 index 0000000000000000000000000000000000000000..07f9b442c07d98171ea889d58ff46528eff117cb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcdtadev.h @@ -0,0 +1,544 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + +Module Name: + + NFCDTADev.h + +Abstract: + + Header file for the NFC DTA device driver interface + +--*/ + +#pragma once + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +// +// Interface GUIDs +// +#ifdef DEFINE_GUID + +// {7fd3f30b-5e49-4be1-b3aa-af06260d236a} +DEFINE_GUID(GUID_DEVINTERFACE_NFCDTA, 0x7fd3f30b, 0x5e49, 0x4be1, 0xb3, 0xaa, 0xaf, 0x06, 0x26, 0x0d, 0x23, 0x6a); + +#endif + +// +// NFC DTA DDI +// + +#define IOCTL_NFCDTA_CONFIG_RF_DISCOVERY \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0500, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_RF_DISCOVERY_CONFIG +#define IOCTL_NFCDTA_REMOTE_DEV_GET_NEXT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0501, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFC_REMOTE_DEV_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_CONNECT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0502, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_REMOTE_DEV_DISCONNECT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0503, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEVICE_DISCONNET +#define IOCTL_NFCDTA_REMOTE_DEV_TRANSCEIVE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0504, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_SEND_INFO Output: NFC_REMOTE_DEV_RECV_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_RECV \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0505, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFC_REMOTE_DEV_RECV_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_SEND \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0506, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_SEND_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_CHECK_PRESENCE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0507, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_CONFIG_P2P_PARAM \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0508, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_P2P_PARAM_CONFIG +#define IOCTL_NFCDTA_SET_RF_CONFIG \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0509, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: TLV-encoded BYTE array, 1st byte contains number of parameters + +// +// NDEF +// +#define IOCTL_NFCDTA_REMOTE_DEV_NDEF_WRITE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0510, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_SEND_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_NDEF_READ \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0511, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE Output: NFC_REMOTE_DEV_RECV_INFO +#define IOCTL_NFCDTA_REMOTE_DEV_NDEF_CONVERT_READ_ONLY \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0512, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_REMOTE_DEV_NDEF_CHECK \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0513, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE Output: NFC_NDEF_INFO + +// +// LLCP +// +#define IOCTL_NFCDTA_LLCP_CONFIG CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0520, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_CONFIG +#define IOCTL_NFCDTA_LLCP_ACTIVATE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0521, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_LLCP_DEACTIVATE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0522, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_LLCP_DISCOVER_SERVICES \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0523, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SERVICE_DISCOVER_REQUEST Output: NFC_LLCP_SERVICE_DISCOVER_SAP +#define IOCTL_NFCDTA_LLCP_LINK_STATUS_CHECK \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0524, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_REMOTE_DEV_HANDLE +#define IOCTL_NFCDTA_LLCP_GET_NEXT_LINK_STATUS \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0525, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFC_LLCP_LINK_STATUS +#define IOCTL_NFCDTA_LLCP_SOCKET_CREATE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0526, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_INFO Output: NFC_LLCP_SOCKET_HANDLE +#define IOCTL_NFCDTA_LLCP_SOCKET_CLOSE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0527, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE +#define IOCTL_NFCDTA_LLCP_SOCKET_BIND \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0528, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_SERVICE_INFO +#define IOCTL_NFCDTA_LLCP_SOCKET_LISTEN \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0529, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE Output: NFC_LLCP_SOCKET_HANDLE +#define IOCTL_NFCDTA_LLCP_SOCKET_ACCEPT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052a, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_ACCEPT_INFO +#define IOCTL_NFCDTA_LLCP_SOCKET_CONNECT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052b, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_CONNECT_INFO +#define IOCTL_NFCDTA_LLCP_SOCKET_DISCONNECT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052c, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE +#define IOCTL_NFCDTA_LLCP_SOCKET_RECV \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052d, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE Output: NFC_LLCP_SOCKET_PAYLOAD +#define IOCTL_NFCDTA_LLCP_SOCKET_RECV_FROM \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052e, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE Output: NFC_LLCP_SOCKET_PAYLOAD +#define IOCTL_NFCDTA_LLCP_SOCKET_SEND \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x052f, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_PAYLOAD +#define IOCTL_NFCDTA_LLCP_SOCKET_SNED_TO \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0530, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_CL_PAYLOAD +#define IOCTL_NFCDTA_LLCP_SOCKET_GET_NEXT_ERROR \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0531, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_LLCP_SOCKET_HANDLE Output: NFC_LLCP_SOCKET_ERROR_INFO + +// +// SNEP Server +// +#define IOCTL_NFCDTA_SNEP_INIT_SERVER \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0540, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_INFO Output: NFC_SNEP_SERVER_HANDLE +#define IOCTL_NFCDTA_SNEP_DEINIT_SERVER \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0541, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_HANDLE +#define IOCTL_NFCDTA_SNEP_SERVER_GET_NEXT_CONNECTION \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0542, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_HANDLE Output: NFC_SNEP_SERVER_CONNECTION_HANDLE +#define IOCTL_NFCDTA_SNEP_SERVER_ACCEPT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0543, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_ACCEPT_INFO +#define IOCTL_NFCDTA_SNEP_SERVER_GET_NEXT_REQUEST \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0544, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_HANDLE Output: NFC_SNEP_SERVER_REQUEST +#define IOCTL_NFCDTA_SNEP_SERVER_SEND_RESPONSE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0545, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_SERVER_RESPONSE_INFO Output: NFC_SNEP_SERVER_RESPONSE_INFO + +// +// SNEP Client +// +#define IOCTL_NFCDTA_SNEP_INIT_CLIENT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0550, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_CLIENT_INFO Output: NFC_SNEP_CLIENT_HANDLE +#define IOCTL_NFCDTA_SNEP_DEINIT_CLIENT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0551, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_CLIENT_HANDLE +#define IOCTL_NFCDTA_SNEP_CLIENT_PUT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0552, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_CLIENT_PUT_INFO +#define IOCTL_NFCDTA_SNEP_CLIENT_GET \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0553, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SNEP_CLIENT_GET_INFO Output: NFC_SNEP_CLIENT_DATA_BUFFER + +// +// SE +// +#define IOCTL_NFCDTA_SE_ENUMERATE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0560, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFC_SE_LIST +#define IOCTL_NFCDTA_SE_SET_EMULATION_MODE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0561, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SE_EMULATION_MODE_INFO +#define IOCTL_NFCDTA_SE_SET_ROUTING_TABLE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0562, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFC_SE_ROUTING_TABLE +#define IOCTL_NFCDTA_SE_GET_NEXT_EVENT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0563, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFC_SE_EVENT_INFO + +typedef enum _NFC_RF_DISCOVERY_MODE +{ + RfDiscoveryConfig, + RfDiscoveryStart, + RFDiscoveryResume +} NFC_RF_DISCOVERY_MODE, + *PNFC_RF_DISCOVERY_MODE; + +typedef struct _NFC_RF_DISCOVERY_CONFIG +{ + USHORT usTotalDuration; + ULONG ulPollConfig; + BOOLEAN fDisableCardEmulation; + UCHAR ucNfcIPMode; + BOOLEAN fNfcIPTgtModeDisable; + UCHAR ucNfcIPTgtMode; + UCHAR ucNfcCEMode; + UCHAR ucBailoutConfig; + UCHAR ucSystemCode[2]; + UCHAR ucRequestCode; + UCHAR ucTimeSlotNumber; + NFC_RF_DISCOVERY_MODE eRfDiscoveryMode; +} NFC_RF_DISCOVERY_CONFIG, *PNFC_RF_DISCOVERY_CONFIG; + +typedef enum _NFC_P2P_MODE +{ + NfcDepDefault, + NfcDepPoll, + NfcDepListen +} NFC_P2P_MODE, + *PNFC_P2P_MODE; + +#define MAX_ATR_LENGTH 48 + +typedef struct _NFC_P2P_PARAM_CONFIG +{ + NFC_P2P_MODE eP2pMode; + _Field_range_(<=, MAX_ATR_LENGTH) BYTE cbGeneralBytes; + _Field_size_bytes_(cbGeneralBytes) BYTE pbGeneralBytes[MAX_ATR_LENGTH]; +} NFC_P2P_PARAM_CONFIG, *PNFC_P2P_PARAM_CONFIG; + +typedef enum _NFC_DEVICE_TYPE +{ + NfcType1Tag, + NfcType2Tag, + NfcType3Tag, + NfcType4Tag, + NfcIP1Target, + NfcIP1Initiator, + NfcReader +} NFC_DEVICE_TYPE, + *PNFC_DEVICE_TYPE; + +typedef BYTE NFC_RF_TECHNOLOGY; +typedef BYTE NFC_RF_PROTOCOL; + +#define MAX_UID_SIZE 16 + +typedef HANDLE NFC_REMOTE_DEV_HANDLE, *PNFC_REMOTE_DEV_HANDLE; + +typedef struct _NFC_REMOTE_DEV_INFO +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + NFC_DEVICE_TYPE eType; + NFC_RF_TECHNOLOGY eRFTech; + NFC_RF_PROTOCOL eProtocol; + _Field_range_(<=, MAX_UID_SIZE) BYTE cbUid; + _Field_size_bytes_(cbUid) BYTE pbUid[MAX_UID_SIZE]; +} NFC_REMOTE_DEV_INFO, *PNFC_REMOTE_DEV_INFO; + +typedef enum _NFC_RELEASE_TYPE +{ + IdleMode, + SleepMode, + Discovery, +} NFC_RELEASE_TYPE, + *PNFC_RELEASE_TYPE; + +typedef struct _NFC_REMOTE_DEVICE_DISCONNET +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + NFC_RELEASE_TYPE eReleaseType; +} NFC_REMOTE_DEVICE_DISCONNET, *PNFC_REMOTE_DEVICE_DISCONNET; + +typedef struct _NFC_DATA_BUFFER +{ + USHORT cbBuffer; + _Field_size_bytes_(cbBuffer) BYTE pbBuffer[ANYSIZE_ARRAY]; +} NFC_DATA_BUFFER, *PNFC_DATA_BUFFER; + +typedef struct _NFC_REMOTE_DEV_SEND_INFO +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + USHORT usTimeOut; + NFC_DATA_BUFFER sSendBuffer; +} NFC_REMOTE_DEV_SEND_INFO, *PNFC_REMOTE_DEV_SEND_INFO; + +typedef struct _NFC_REMOTE_DEV_RECV_INFO +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + NFC_DATA_BUFFER sRecvBuffer; +} NFC_REMOTE_DEV_RECV_INFO, *PNFC_REMOTE_DEV_RECV_INFO; + +typedef struct _NFC_NDEF_INFO +{ + BOOLEAN fIsNdefFormatted; + BOOLEAN fIsReadOnly; + DWORD dwActualMessageLength; + DWORD dwMaxMessageLength; +} NFC_NDEF_INFO, *PNFC_NDEF_INFO; + +typedef struct _LLCP_SOCKET_OPTION +{ + USHORT uMIUX; + BYTE bRW; +} NFC_LLCP_SOCKET_OPTION, *PNFC_LLCP_SOCKET_OPTION; + +#define MAX_LLCP_SERVICE_NAME_SIZE 256 + +typedef struct _NFC_LLCP_CONFIG +{ + USHORT uMIU; + USHORT uWKS; + BYTE bLTO; + BYTE bOptions; + BOOLEAN fAutoActivate; +} NFC_LLCP_CONFIG, *PNFC_LLCP_CONFIG; + +typedef struct _NFC_LLCP_SERVICE_NAME_ENTRY +{ + _Field_range_(<=, MAX_LLCP_SERVICE_NAME_SIZE) DWORD cbServiceName; + _Field_size_bytes_(cbServiceName) BYTE pbServiceName[ANYSIZE_ARRAY]; +} NFC_LLCP_SERVICE_NAME_ENTRY, *PNFC_LLCP_SERVICE_NAME_ENTRY; + +typedef struct _NFC_LLCP_SERVICE_DISCOVER_REQUEST +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + DWORD NumberOfEntries; + _Field_size_(NumberOfEntries) NFC_LLCP_SERVICE_NAME_ENTRY ServiceNameEntries[ANYSIZE_ARRAY]; +} NFC_LLCP_SERVICE_DISCOVER_REQUEST, *PNFC_LLCP_SERVICE_DISCOVER_REQUEST; + +typedef struct _NFC_LLCP_SERVICE_DISCOVER_SAP +{ + DWORD NumberOfEntries; + _Field_size_(NumberOfEntries) BYTE SAPEntries[ANYSIZE_ARRAY]; +} NFC_LLCP_SERVICE_DISCOVER_SAP, *PNFC_LLCP_SERVICE_DISCOVER_SAP; + +#define NFC_LLCP_SERVICE_DISCOVER_SAP_HEADER offsetof(NFC_LLCP_SERVICE_DISCOVER_SAP, SAPEntries) + +typedef enum _NFC_LLCP_SOCKET_TYPE +{ + ConnectionOriented, + Connectionless, +} NFC_LLCP_SOCKET_TYPE, + *PNFC_LLCP_SOCKET_TYPE; + +typedef enum _NFC_LLCP_LINK_STATUS +{ + LinkActivated, + LinkDeactivated +} NFC_LLCP_LINK_STATUS, + *PNFC_LLCP_LINK_STATUS; + +typedef HANDLE NFC_LLCP_SOCKET_HANDLE, *PNFC_LLCP_SOCKET_HANDLE; + +typedef struct _NFC_LLCP_SOCKET_INFO +{ + NFC_LLCP_SOCKET_TYPE eSocketType; + NFC_LLCP_SOCKET_OPTION sSocketOption; +} NFC_LLCP_SOCKET_INFO, *PNFC_LLCP_SOCKET_INFO; + +typedef struct _NFC_LLCP_SOCKET_SERVICE_INFO +{ + NFC_LLCP_SOCKET_HANDLE hSocket; + BYTE bSAP; + NFC_LLCP_SERVICE_NAME_ENTRY sServiceName; +} NFC_LLCP_SOCKET_SERVICE_INFO, *PNFC_LLCP_SOCKET_SERVICE_INFO; + +typedef struct _NFC_LLCP_SOCKET_PAYLOAD +{ + NFC_LLCP_SOCKET_HANDLE hSocket; + BYTE bSAP; + NFC_DATA_BUFFER sPayload; +} NFC_LLCP_SOCKET_PAYLOAD, *PNFC_LLCP_SOCKET_PAYLOAD; + +typedef struct _NFC_LLCP_SOCKET_ACCEPT_INFO +{ + NFC_LLCP_SOCKET_HANDLE hSocket; + NFC_LLCP_SOCKET_OPTION sSocketOption; +} NFC_LLCP_SOCKET_ACCEPT_INFO, *PNFC_LLCP_SOCKET_ACCEPT_INFO; + +typedef enum _NFC_LLCP_SOCKET_CONNECT_TYPE +{ + NfcConnectBySap, + NfcConnectByUri +} NFC_LLCP_SOCKET_CONNECT_TYPE, + *PNFC_LLCP_SOCKET_CONNECT_TYPE; + +typedef struct _NFC_LLCP_SOCKET_CONNECT_INFO +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + NFC_LLCP_SOCKET_HANDLE hSocket; + NFC_LLCP_SOCKET_CONNECT_TYPE eConnectType; + union + { + BYTE bSAP; + NFC_LLCP_SERVICE_NAME_ENTRY sServiceName; + }; +} NFC_LLCP_SOCKET_CONNECT_INFO, *PNFC_LLCP_SOCKET_CONNECT_INFO; + +typedef struct _NFC_LLCP_SOCKET_CL_PAYLOAD +{ + NFC_LLCP_SOCKET_HANDLE hSocket; + BYTE bSAP; + NFC_DATA_BUFFER sPayload; +} NFC_LLCP_SOCKET_CL_PAYLOAD, *PNFC_LLCP_SOCKET_CL_PAYLOAD; + +typedef enum _NFC_LLCP_SOCKET_ERROR +{ + NfcLlcpErrorDisconnected, + NfcLlcpErrorFrameRejected, + NfcLlcpErrorBusyCondition, + NfcLlcpErrorNotBusyCondition, +} NFC_LLCP_SOCKET_ERROR, + *PNFC_LLCP_SOCKET_ERROR; + +typedef struct _NFC_LLCP_SOCKET_ERROR_INFO +{ + NFC_LLCP_SOCKET_HANDLE hSocket; + NFC_LLCP_SOCKET_ERROR eSocketError; +} NFC_LLCP_SOCKET_ERROR_INFO, *PNFC_LLCP_SOCKET_ERROR_INFO; + +typedef enum _NFC_SNEP_SERVER_TYPE +{ + DefaultSnepServer = 0, + ExtendedSnepServer +} NFC_SNEP_SERVER_TYPE, + *PNFC_SNEP_SERVER_TYPE; + +typedef enum _NFC_SNEP_REQUEST_TYPE +{ + SnepRequestGet = 0, + SnepRequestPut, +} NFC_SNEP_REQUEST_TYPE, + *PNFC_SNEP_REQUEST_TYPE; + +#define MAX_SNEP_SERVER_NAME_SIZE 256 + +typedef HANDLE NFC_SNEP_SERVER_HANDLE, *PNFC_SNEP_SERVER_HANDLE; +typedef HANDLE NFC_SNEP_SERVER_CONNECTION_HANDLE, *PNFC_SNEP_SERVER_CONNECTION_HANDLE; +typedef NFC_LLCP_SOCKET_OPTION NFC_SNEP_SOCKET_OPTION, *PNFC_SNEP_SOCKET_OPTION; +typedef struct _NFC_LLCP_SERVICE_NAME_ENTRY NFC_SNEP_SERVICE_NAME, *PNFC_SNEP_SERVICE_NAME; + +typedef struct _NFC_SNEP_SERVER_INFO +{ + NFC_SNEP_SERVER_TYPE eServerType; + NFC_SNEP_SOCKET_OPTION sSocketOption; + USHORT usInboxSize; + BYTE bSAP; + NFC_SNEP_SERVICE_NAME sService; +} NFC_SNEP_SERVER_INFO, *PNFC_SNEP_SERVER_INFO; + +typedef struct _NFC_SNEP_SERVER_ACCEPT_INFO +{ + NFC_SNEP_SERVER_HANDLE hSnepServer; + NFC_SNEP_SERVER_CONNECTION_HANDLE hConnection; + NFC_SNEP_SOCKET_OPTION sSocketOption; +} NFC_SNEP_SERVER_ACCEPT_INFO, *PNFC_SNEP_SERVER_ACCEPT_INFO; + +typedef struct _NFC_SNEP_SERVER_REQUEST +{ + NFC_SNEP_SERVER_HANDLE hSnepServer; + NFC_SNEP_SERVER_CONNECTION_HANDLE hConnection; + NFC_SNEP_REQUEST_TYPE eRequestType; + NFC_DATA_BUFFER sRequestPayload; +} NFC_SNEP_SERVER_REQUEST, *PNFC_SNEP_SERVER_REQUEST; + +typedef struct _NFC_SNEP_SERVER_RESPONSE_INFO +{ + NFC_SNEP_SERVER_HANDLE hSnepServer; + NFC_SNEP_SERVER_CONNECTION_HANDLE hConnection; + DWORD dwResponseStatus; + NFC_DATA_BUFFER sResponsePayload; +} NFC_SNEP_SERVER_RESPONSE_INFO, *PNFC_SNEP_SERVER_RESPONSE_INFO; + +#define NFC_SNEP_SERVER_RESPONSE_HEADER \ + offsetof(NFC_SNEP_SERVER_RESPONSE_INFO, sResponsePayload) + offsetof(NFC_DATA_BUFFER, pbBuffer) + +typedef HANDLE NFC_SNEP_CLIENT_HANDLE, *PNFC_SNEP_CLIENT_HANDLE; +typedef NFC_DATA_BUFFER NFC_SNEP_CLIENT_DATA_BUFFER, *PNFC_SNEP_CLIENT_DATA_BUFFER; + +typedef struct _NFC_SNEP_CLIENT_INFO +{ + NFC_REMOTE_DEV_HANDLE hRemoteDev; + NFC_SNEP_SERVER_TYPE eServerType; + NFC_SNEP_SOCKET_OPTION sSocketOption; + NFC_SNEP_SERVICE_NAME sService; +} NFC_SNEP_CLIENT_INFO, *PNFC_SNEP_CLIENT_INFO; + +typedef struct _NFC_SNEP_CLIENT_PUT_INFO +{ + NFC_SNEP_CLIENT_HANDLE hSnepClient; + NFC_DATA_BUFFER sPutPayload; +} NFC_SNEP_CLIENT_PUT_INFO, *PNFC_SNEP_CLIENT_PUT_INFO; + +#define NFC_SNEP_CLIENT_PUT_HEADER offsetof(NFC_SNEP_CLIENT_PUT_INFO, sPutPayload) + offsetof(NFC_DATA_BUFFER, pbBuffer) + +typedef struct _NFC_SNEP_CLIENT_GET_INFO +{ + NFC_SNEP_CLIENT_HANDLE hSnepClient; + NFC_DATA_BUFFER sGetPayload; +} NFC_SNEP_CLIENT_GET_INFO, *PNFC_SNEP_CLIENT_GET_INFO; + +#define NFC_SNEP_CLIENT_GET_HEADER offsetof(NFC_SNEP_CLIENT_GET_INFO, sGetPayload) + offsetof(NFC_DATA_BUFFER, pbBuffer) + +typedef SECURE_ELEMENT_TYPE NFC_SE_TYPE; +typedef HANDLE NFC_SE_HANDLE; +typedef SECURE_ELEMENT_EVENT_TYPE NFC_SE_EVENT_TYPE; + +typedef enum _NFC_SE_EMULATION_MODE +{ + EmulationDisabled = 0, + EmulationEnabled = 1, +} NFC_SE_EMULATION_MODE, + *PNFC_SE_EMULATION_MODE; + +typedef struct _NFC_SE_INFO +{ + NFC_SE_HANDLE hSecureElement; + NFC_SE_TYPE eSecureElementType; +} NFC_SE_INFO, *PNFC_SE_INFO; + +typedef struct _NFC_SE_LIST +{ + DWORD NumberOfEndpoints; + _Field_size_(NumberOfEndpoints) NFC_SE_INFO EndpointList[ANYSIZE_ARRAY]; +} NFC_SE_LIST, *PNFC_SE_LIST; + +typedef struct _NFC_SE_EMULATION_MODE_INFO +{ + NFC_SE_HANDLE hSecureElement; + NFC_SE_EMULATION_MODE eMode; +} NFC_SE_EMULATION_MODE_INFO, *PNFC_SE_EMULATION_MODE_INFO; + +typedef SECURE_ELEMENT_ROUTING_TYPE NFC_SE_ROUTING_TABLE_TYPE; + +typedef struct _NFC_SE_TECH_ROUTING_INFO +{ + NFC_SE_HANDLE hSecureElement; + BYTE bPowerState; + BYTE eRfTechType; +} NFC_SE_TECH_ROUTING_INFO, *PNFC_SE_TECH_ROUTING_INFO; + +typedef struct _NFC_SE_PROTO_ROUTING_INFO +{ + NFC_SE_HANDLE hSecureElement; + BYTE bPowerState; + BYTE eRfProtocolType; +} NFC_SE_PROTO_ROUTING_INFO, *PNFC_SE_PROTO_ROUTING_INFO; + +typedef struct _NFC_SE_AID_ROUTING_INFO +{ + NFC_SE_HANDLE hSecureElement; + BYTE bPowerState; + _Field_range_(<=, ISO_7816_MAXIMUM_AID_LENGTH) DWORD cbAid; + _Field_size_bytes_(cbAid) BYTE pbAid[ISO_7816_MAXIMUM_AID_LENGTH]; +} NFC_SE_AID_ROUTING_INFO, *PNFC_SE_AID_ROUTING_INFO; + +typedef struct _NFC_SE_ROUTING_TABLE_ENTRY +{ + NFC_SE_ROUTING_TABLE_TYPE eRoutingType; + union + { + NFC_SE_TECH_ROUTING_INFO TechRoutingInfo; + NFC_SE_PROTO_ROUTING_INFO ProtoRoutingInfo; + NFC_SE_AID_ROUTING_INFO AidRoutingInfo; + }; +} NFC_SE_ROUTING_TABLE_ENTRY, *PNFC_SE_ROUTING_TABLE_ENTRY; + +typedef struct _NFC_SE_ROUTING_TABLE +{ + DWORD NumberOfEntries; + _Field_size_(NumberOfEntries) NFC_SE_ROUTING_TABLE_ENTRY TableEntries[ANYSIZE_ARRAY]; +} NFC_SE_ROUTING_TABLE, *PNFC_SE_ROUTING_TABLE; + +#define NFC_SE_ROUTING_TABLE_AND_ENTRIES(n) \ + struct \ + { \ + NFC_SE_ROUTING_TABLE Table; \ + NFC_SE_ROUTING_TABLE_ENTRY ExtraEntries[n - 1]; \ + } + +typedef struct _NFC_SE_EVENT_INFO +{ + NFC_SE_HANDLE hSecureElement; + NFC_SE_EVENT_TYPE eEventType; + DWORD cbEventData; + _Field_size_bytes_(cbEventData) BYTE pbEventData[ANYSIZE_ARRAY]; +} NFC_SE_EVENT_INFO, *PNFC_SE_EVENT_INFO; + +#endif // NTDDI_VERSION diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcradiodev.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcradiodev.h new file mode 100644 index 0000000000000000000000000000000000000000..06f48f9b320071570caa0faf2e5d3f45b7f2c8d7 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcradiodev.h @@ -0,0 +1,62 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + +Module Name: + + NfcRadioDev.h + +Abstract: + + IOCTL codes and structure common to the NFC Radio Device Interface + +--*/ +#pragma once + +#ifdef __cplusplus +extern "C" +{ +#endif + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + + //{4d51e930-750d-4a36-a9f791dc540fcd30} + DEFINE_GUID(GUID_NFC_RADIO_MEDIA_DEVICE_INTERFACE, 0x4d51e930, 0x750d, 0x4a36, 0xa9, 0xf7, 0x91, 0xdc, 0x54, 0x0f, 0xcd, 0x30); + + // {EF8BA08F-148D-4116-83EF-A2679DFC3FA5} + DEFINE_GUID(GUID_NFCSE_RADIO_MEDIA_DEVICE_INTERFACE, 0xef8ba08f, 0x148d, 0x4116, 0x83, 0xef, 0xa2, 0x67, 0x9d, 0xfc, 0x3f, 0xa5); + +// +// IOCTL definitions. +// +#define NFCRMDDI_IOCTL_BASE 0x50 + +#define IOCTL_NFCRM_SET_RADIO_STATE \ + CTL_CODE(FILE_DEVICE_NFP, (NFCRMDDI_IOCTL_BASE + 0x11), METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFCRM_SET_RADIO_STATE +#define IOCTL_NFCRM_QUERY_RADIO_STATE \ + CTL_CODE(FILE_DEVICE_NFP, (NFCRMDDI_IOCTL_BASE + 0x12), METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFCRM_RADIO_STATE +#define IOCTL_NFCSERM_SET_RADIO_STATE \ + CTL_CODE(FILE_DEVICE_NFP, (NFCRMDDI_IOCTL_BASE + 0x13), METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: NFCRM_SET_RADIO_STATE +#define IOCTL_NFCSERM_QUERY_RADIO_STATE \ + CTL_CODE(FILE_DEVICE_NFP, (NFCRMDDI_IOCTL_BASE + 0x14), METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: NFCRM_RADIO_STATE + +#include + + typedef struct _NFCRM_SET_RADIO_STATE + { + BOOLEAN SystemStateUpdate; // TRUE if this is a system state update + BOOLEAN MediaRadioOn; + } NFCRM_SET_RADIO_STATE, *PNFCRM_SET_RADIO_STATE; + + typedef struct _NFCRM_RADIO_STATE + { + BOOLEAN MediaRadioOn; + } NFCRM_RADIO_STATE, *PNFCRM_RADIO_STATE; + +#include + +#endif // NTDDI_WINBLUE + +#ifdef __cplusplus +} +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcsedev.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcsedev.h new file mode 100644 index 0000000000000000000000000000000000000000..73eb737dc3dc935f1a4a1d0ce750daabca7c0235 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfcsedev.h @@ -0,0 +1,240 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + +Module Name: + + NfcSEDev.h + +Abstract: + + Header file for the NFC SE device driver interface + +--*/ + +#pragma once + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +// +// Interface GUIDs +// +#ifdef DEFINE_GUID + +// {8DC7C854-F5E5-4bed-815D-0C85AD047725} +DEFINE_GUID(GUID_DEVINTERFACE_NFCSE, 0x8dc7c854, 0xf5e5, 0x4bed, 0x81, 0x5d, 0xc, 0x85, 0xad, 0x4, 0x77, 0x25); + +#endif + +// +// Secure Element DDI +// +#define IOCTL_NFCSE_ENUM_ENDPOINTS \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0200, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: SECURE_ELEMENT_ENDPOINT_LIST +#define IOCTL_NFCSE_SUBSCRIBE_FOR_EVENT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0201, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: SECURE_ELEMENT_EVENT_SUBSCRIPTION_INFO +#define IOCTL_NFCSE_GET_NEXT_EVENT \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0202, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: SECURE_ELEMENT_EVENT_INFO +#define IOCTL_NFCSE_SET_CARD_EMULATION_MODE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0203, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: SECURE_ELEMENT_SET_CARD_EMULATION_MODE_INFO +#define IOCTL_NFCSE_GET_NFCC_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0204, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: SECURE_ELEMENT_NFCC_CAPABILITIES +#define IOCTL_NFCSE_GET_ROUTING_TABLE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0205, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: SECURE_ELEMENT_ROUTING_TABLE +#define IOCTL_NFCSE_SET_ROUTING_TABLE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0206, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: SECURE_ELEMENT_ROUTING_TABLE +#define IOCTL_NFCSE_HCE_REMOTE_RECV \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0250, METHOD_BUFFERED, FILE_ANY_ACCESS) // Output: SECURE_ELEMENT_HCE_DATA_PACKET +#define IOCTL_NFCSE_HCE_REMOTE_SEND \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0251, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: SECURE_ELEMENT_HCE_DATA_PACKET +#define IOCTL_NFCSE_SET_POWER_MODE \ + CTL_CODE(FILE_DEVICE_UNKNOWN, 0x0252, METHOD_BUFFERED, FILE_ANY_ACCESS) // Input: SECURE_ELEMENT_SET_POWER_MODE_INFO + +// +// EVT_TRANSACTION TLV definitions, from ETSI/HCI v12.1, Section 11.2.2.4 EVT_TRANSACTION +#define EVT_TRANSACTION_TAG_AID 0x81 +#define EVT_TRANSACTION_TAG_PARAMETERS 0x82 +#define EVT_TRANSACTION_PARAMETER_MAX_LEN 255 + +typedef enum _SECURE_ELEMENT_TYPE +{ + Integrated = 0, + External = 1, + DeviceHost = 2 +} SECURE_ELEMENT_TYPE, + *PSECURE_ELEMENT_TYPE; + +typedef enum _SECURE_ELEMENT_EVENT_TYPE +{ + // Signals that an external reader has been discovered and the initial protocol handshake has occured. + ExternalReaderArrival = 0, + // Signals that the external reader is no longer present. + ExternalReaderDeparture = 1, + // Deprecated. + ApplicationSelected = 2, + // Signals that an EVT_TRANSACTION event has been triggered by an SE. + Transaction = 3, + // Signals that a HCE connection has been established. + HceActivated = 4, + // Signals that the HCE connection has been disconnected. + HceDeactivated = 5, + // Signals that an external NFC field has been detected. + ExternalFieldEnter = 6, + // Signals that the external NFC field is no longer present. + ExternalFieldExit = 7, +} SECURE_ELEMENT_EVENT_TYPE, + *PSECURE_ELEMENT_EVENT_TYPE; + +typedef enum _SECURE_ELEMENT_CARD_EMULATION_MODE +{ + EmulationOff = 0, + EmulationOnPowerIndependent = 1, + EmulationOnPowerDependent = 2, + EmulationStealthListen = 3, +} SECURE_ELEMENT_CARD_EMULATION_MODE, + *PSECURE_ELEMENT_CARD_EMULATION_MODE; + +typedef struct _SECURE_ELEMENT_ENDPOINT_INFO +{ + GUID guidSecureElementId; + SECURE_ELEMENT_TYPE eSecureElementType; +} SECURE_ELEMENT_ENDPOINT_INFO, *PSECURE_ELEMENT_ENDPOINT_INFO; + +typedef struct _SECURE_ELEMENT_ENDPOINT_LIST +{ + DWORD NumberOfEndpoints; + _Field_size_(NumberOfEndpoints) SECURE_ELEMENT_ENDPOINT_INFO EndpointList[ANYSIZE_ARRAY]; +} SECURE_ELEMENT_ENDPOINT_LIST, *PSECURE_ELEMENT_ENDPOINT_LIST; + +#define SECURE_ELEMENT_ENDPOINT_LIST_AND_ENTRIES(n) \ + struct \ + { \ + SECURE_ELEMENT_ENDPOINT_LIST List; \ + SECURE_ELEMENT_ENDPOINT_INFO ExtraInfo[n - 1]; \ + } + +typedef struct _SECURE_ELEMENT_EVENT_SUBSCRIPTION_INFO +{ + GUID guidSecureElementId; + SECURE_ELEMENT_EVENT_TYPE eEventType; +} SECURE_ELEMENT_EVENT_SUBSCRIPTION_INFO, *PSECURE_ELEMENT_EVENT_SUBSCRIPTION_INFO; + +typedef struct _SECURE_ELEMENT_EVENT_INFO +{ + GUID guidSecureElementId; + SECURE_ELEMENT_EVENT_TYPE eEventType; + DWORD cbEventData; + _Field_size_bytes_(cbEventData) BYTE pbEventData[ANYSIZE_ARRAY]; +} SECURE_ELEMENT_EVENT_INFO, *PSECURE_ELEMENT_EVENT_INFO; + +#define SECURE_ELEMENT_EVENT_INFO_HEADER offsetof(SECURE_ELEMENT_EVENT_INFO, pbEventData) + +#define SECURE_ELEMENT_EVENT_INFO_AND_PAYLOAD(n) \ + struct \ + { \ + SECURE_ELEMENT_EVENT_INFO Info; \ + BYTE ExtraPayload[n - 1]; \ + } + +typedef struct _SECURE_ELEMENT_SET_CARD_EMULATION_MODE_INFO +{ + GUID guidSecureElementId; + SECURE_ELEMENT_CARD_EMULATION_MODE eMode; +} SECURE_ELEMENT_SET_CARD_EMULATION_MODE_INFO, *PSECURE_ELEMENT_SET_CARD_EMULATION_MODE_INFO; + +typedef struct _SECURE_ELEMENT_NFCC_CAPABILITIES +{ + USHORT cbMaxRoutingTableSize; + BOOLEAN IsAidRoutingSupported; + BOOLEAN IsProtocolRoutingSupported; + BOOLEAN IsTechRoutingSupported; +} SECURE_ELEMENT_NFCC_CAPABILITIES, *PSECURE_ELEMENT_NFCC_CAPABILITIES; + +typedef enum _SECURE_ELEMENT_ROUTING_TYPE +{ + RoutingTypeTech = 0, + RoutingTypeProtocol = 1, + RoutingTypeAid = 2 +} SECURE_ELEMENT_ROUTING_TYPE, + *PSECURE_ELEMENT_ROUTING_TYPE; + +typedef struct _SECURE_ELEMENT_TECH_ROUTING_INFO +{ + GUID guidSecureElementId; + BYTE eRfTechType; +} SECURE_ELEMENT_TECH_ROUTING_INFO, *PSECURE_ELEMENT_TECH_ROUTING_INFO; + +typedef struct _SECURE_ELEMENT_PROTO_ROUTING_INFO +{ + GUID guidSecureElementId; + BYTE eRfProtocolType; +} SECURE_ELEMENT_PROTO_ROUTING_INFO, *PSECURE_ELEMENT_PROTO_ROUTING_INFO; + +#define ISO_7816_MINIMUM_AID_LENGTH 5 +#define ISO_7816_MAXIMUM_AID_LENGTH 16 + +typedef struct _SECURE_ELEMENT_AID_ROUTING_INFO +{ + GUID guidSecureElementId; + _Field_range_(<=, ISO_7816_MAXIMUM_AID_LENGTH) DWORD cbAid; + _Field_size_bytes_(cbAid) BYTE pbAid[ISO_7816_MAXIMUM_AID_LENGTH]; +} SECURE_ELEMENT_AID_ROUTING_INFO, *PSECURE_ELEMENT_AID_ROUTING_INFO; + +#pragma warning(push) +#pragma warning(disable : 4201) // anonymous unions warning + +typedef struct _SECURE_ELEMENT_ROUTING_TABLE_ENTRY +{ + SECURE_ELEMENT_ROUTING_TYPE eRoutingType; + union + { + SECURE_ELEMENT_TECH_ROUTING_INFO TechRoutingInfo; + SECURE_ELEMENT_PROTO_ROUTING_INFO ProtoRoutingInfo; + SECURE_ELEMENT_AID_ROUTING_INFO AidRoutingInfo; + }; +} SECURE_ELEMENT_ROUTING_TABLE_ENTRY, *PSECURE_ELEMENT_ROUTING_TABLE_ENTRY; + +#pragma warning(pop) + +typedef struct _SECURE_ELEMENT_ROUTING_TABLE +{ + DWORD NumberOfEntries; + _Field_size_(NumberOfEntries) SECURE_ELEMENT_ROUTING_TABLE_ENTRY TableEntries[ANYSIZE_ARRAY]; +} SECURE_ELEMENT_ROUTING_TABLE, *PSECURE_ELEMENT_ROUTING_TABLE; + +#define SECURE_ELEMENT_ROUTING_TABLE_AND_ENTRIES(n) \ + struct \ + { \ + SECURE_ELEMENT_ROUTING_TABLE Table; \ + SECURE_ELEMENT_ROUTING_TABLE_ENTRY ExtraEntries[n - 1]; \ + } + +typedef struct _SECURE_ELEMENT_HCE_ACTIVATION_PAYLOAD +{ + USHORT bConnectionId; + BYTE eRfTechType; + BYTE eRfProtocolType; +} SECURE_ELEMENT_HCE_ACTIVATION_PAYLOAD, *PSECURE_ELEMENT_HCE_ACTIVATION_PAYLOAD; + +typedef struct _SECURE_ELEMENT_HCE_DATA_PACKET +{ + USHORT bConnectionId; + USHORT cbPayload; + _Field_size_bytes_(cbPayload) BYTE pbPayload[ANYSIZE_ARRAY]; +} SECURE_ELEMENT_HCE_DATA_PACKET, *PSECURE_ELEMENT_HCE_DATA_PACKET; + +#define SECURE_ELEMENT_HCE_DATA_PACKET_HEADER offsetof(SECURE_ELEMENT_HCE_DATA_PACKET, pbPayload) + +typedef enum _SECURE_ELEMENT_POWER_MODE +{ + SEPowerMode_ForceOn, + SEPowerMode_AllowOff, +} SECURE_ELEMENT_POWER_MODE; + +typedef struct _SECURE_ELEMENT_SET_POWER_MODE_INFO +{ + GUID guidSecureElementId; + SECURE_ELEMENT_POWER_MODE powerMode; +} SECURE_ELEMENT_SET_POWER_MODE_INFO; + +#endif // NTDDI_VERSION diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfpdev.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfpdev.h new file mode 100644 index 0000000000000000000000000000000000000000..9cc90118a8cf30bf560f7ca2ad098b55516425ed --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nfpdev.h @@ -0,0 +1,65 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + NfpDev.h + +Abstract: + + This is the include file that defines all constants and types for + implementing a NearFieldProximity device. + +Revision History: + +--*/ + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifdef _MSC_VER +#pragma once +#endif + +#if NTDDI_VERSION >= NTDDI_VISTA + +// +// Interface GUIDs +// +#ifdef DEFINE_GUID + +/* {FB3842CD-9E2A-4F83-8FCC-4B0761139AE9} */ +DEFINE_GUID(GUID_DEVINTERFACE_NFP, 0xFB3842CD, 0x9E2A, 0x4F83, 0x8F, 0xCC, 0x4B, 0x07, 0x61, 0x13, 0x9A, 0xE9); + +DEFINE_DEVPROPKEY(DEVPKEY_NFP_Capabilities, 0xFB3842CD, 0x9E2A, 0x4F83, 0x8F, 0xCC, 0x4B, 0x07, 0x61, 0x13, 0x9A, 0xE9, 2); // DEVPROP_TYPE_STRING_LIST +// NOTE: All DEVPKEY_NFP_* values are reserved for future use. +// An IHV MAY use a GUID owned by the IHV to define their own properties. + +#endif + +#define IOCTL_NFP_GET_NEXT_SUBSCRIBED_MESSAGE CTL_CODE(FILE_DEVICE_NFP, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_SET_PAYLOAD CTL_CODE(FILE_DEVICE_NFP, 0x0011, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_GET_NEXT_TRANSMITTED_MESSAGE CTL_CODE(FILE_DEVICE_NFP, 0x0012, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_DISABLE CTL_CODE(FILE_DEVICE_NFP, 0x0013, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_ENABLE CTL_CODE(FILE_DEVICE_NFP, 0x0014, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_GET_MAX_MESSAGE_BYTES CTL_CODE(FILE_DEVICE_NFP, 0x0020, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NFP_GET_KILO_BYTES_PER_SECOND CTL_CODE(FILE_DEVICE_NFP, 0x0021, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// NOTE: For FILE_DEVICE_NFP, functions 0x0000 - 0x00FF are reserved for future use +// An IHV MAY use functions 0x0100 - 0x01FF for IHV-specific extension IOCTLs + +typedef struct _SUBSCRIBED_MESSAGE +{ + DWORD cbPayloadHint; + + BYTE payload[1]; // Variably sized payload +} SUBSCRIBED_MESSAGE; + + +#endif // NTDDI_VERSION >= NTDDI_VISTA + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nldef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nldef.h new file mode 100644 index 0000000000000000000000000000000000000000..6296c18dbbd7f91460fe08eb4fb0df4413904934 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nldef.h @@ -0,0 +1,306 @@ +/*++ + +Copyright (c) 2000-2001 Microsoft Corporation + +Module Name: + + nldef.h + +Abstract: + + This module contains basic network layer definitions. + Previously some of these were duplicated in both routprot.h and + iprtrmib.h. + +Author: +Environment: + + user mode or kernel mode + +--*/ + +#ifndef _NLDEF_ +#define _NLDEF_ +#pragma once +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +typedef enum { + // + // These values are from iptypes.h. + // They need to fit in a 4 bit field. + // + IpPrefixOriginOther = 0, + IpPrefixOriginManual, + IpPrefixOriginWellKnown, + IpPrefixOriginDhcp, + IpPrefixOriginRouterAdvertisement, + IpPrefixOriginUnchanged = 1 << 4 +} NL_PREFIX_ORIGIN; + +// +// TODO: Remove these definitions. +// +#define NlpoOther IpPrefixOriginOther +#define NlpoManual IpPrefixOriginManual +#define NlpoWellKnown IpPrefixOriginWellKnown +#define NlpoDhcp IpPrefixOriginDhcp +#define NlpoRouterAdvertisement IpPrefixOriginRouterAdvertisement + +typedef enum { + // + // TODO: Remove the Nlso* definitions. + // + NlsoOther = 0, + NlsoManual, + NlsoWellKnown, + NlsoDhcp, + NlsoLinkLayerAddress, + NlsoRandom, + + // + // These values are from in iptypes.h. + // They need to fit in a 4 bit field. + // + IpSuffixOriginOther = 0, + IpSuffixOriginManual, + IpSuffixOriginWellKnown, + IpSuffixOriginDhcp, + IpSuffixOriginLinkLayerAddress, + IpSuffixOriginRandom, + IpSuffixOriginUnchanged = 1 << 4 +} NL_SUFFIX_ORIGIN; + +typedef enum { + // + // TODO: Remove the Nlds* definitions. + // + NldsInvalid, + NldsTentative, + NldsDuplicate, + NldsDeprecated, + NldsPreferred, + + // + // These values are from in iptypes.h. + // + IpDadStateInvalid = 0, + IpDadStateTentative, + IpDadStateDuplicate, + IpDadStateDeprecated, + IpDadStatePreferred, +} NL_DAD_STATE; + + +#define NL_MAX_METRIC_COMPONENT ((((ULONG) 1) << 31) - 1) + +// +// MIB_IPPROTO_* values were previously in iprtrmib.h. +// PROTO_IP_* values were previously in routprot.h. +// +#define MAKE_ROUTE_PROTOCOL(suffix, value) \ + MIB_IPPROTO_ ## suffix = value, \ + PROTO_IP_ ## suffix = value + +// +// Routing protocol values from RFC. +// +typedef enum { + // + // TODO: Remove the RouteProtocol* definitions. + // + RouteProtocolOther = 1, + RouteProtocolLocal = 2, + RouteProtocolNetMgmt = 3, + RouteProtocolIcmp = 4, + RouteProtocolEgp = 5, + RouteProtocolGgp = 6, + RouteProtocolHello = 7, + RouteProtocolRip = 8, + RouteProtocolIsIs = 9, + RouteProtocolEsIs = 10, + RouteProtocolCisco = 11, + RouteProtocolBbn = 12, + RouteProtocolOspf = 13, + RouteProtocolBgp = 14, + RouteProtocolIdpr = 15, + RouteProtocolEigrp = 16, + RouteProtocolDvmrp = 17, + RouteProtocolRpl = 18, + RouteProtocolDhcp = 19, + + MAKE_ROUTE_PROTOCOL(OTHER, 1), + MAKE_ROUTE_PROTOCOL(LOCAL, 2), + MAKE_ROUTE_PROTOCOL(NETMGMT, 3), + MAKE_ROUTE_PROTOCOL(ICMP, 4), + MAKE_ROUTE_PROTOCOL(EGP, 5), + MAKE_ROUTE_PROTOCOL(GGP, 6), + MAKE_ROUTE_PROTOCOL(HELLO, 7), + MAKE_ROUTE_PROTOCOL(RIP, 8), + MAKE_ROUTE_PROTOCOL(IS_IS, 9), + MAKE_ROUTE_PROTOCOL(ES_IS, 10), + MAKE_ROUTE_PROTOCOL(CISCO, 11), + MAKE_ROUTE_PROTOCOL(BBN, 12), + MAKE_ROUTE_PROTOCOL(OSPF, 13), + MAKE_ROUTE_PROTOCOL(BGP, 14), + MAKE_ROUTE_PROTOCOL(IDPR, 15), + MAKE_ROUTE_PROTOCOL(EIGRP, 16), + MAKE_ROUTE_PROTOCOL(DVMRP, 17), + MAKE_ROUTE_PROTOCOL(RPL, 18), + MAKE_ROUTE_PROTOCOL(DHCP, 19), + + // + // Windows-specific definitions. + // + MAKE_ROUTE_PROTOCOL(NT_AUTOSTATIC, 10002), + MAKE_ROUTE_PROTOCOL(NT_STATIC, 10006), + MAKE_ROUTE_PROTOCOL(NT_STATIC_NON_DOD, 10007), + +} NL_ROUTE_PROTOCOL, *PNL_ROUTE_PROTOCOL; + +typedef enum { + NlatUnspecified, + NlatUnicast, + NlatAnycast, + NlatMulticast, + NlatBroadcast, + NlatInvalid +} NL_ADDRESS_TYPE, *PNL_ADDRESS_TYPE; + +// +// NL_ROUTE_ORIGIN +// +// Define route origin values. +// + +typedef enum _NL_ROUTE_ORIGIN { + NlroManual, + NlroWellKnown, + NlroDHCP, + NlroRouterAdvertisement, + Nlro6to4, +} NL_ROUTE_ORIGIN, *PNL_ROUTE_ORIGIN; + +// +// NL_NEIGHBOR_STATE +// +// Define network layer neighbor state. RFC 2461, section 7.3.2 has details. +// Note: Only state names are documented, we chose the values used here. +// + +typedef enum _NL_NEIGHBOR_STATE { + NlnsUnreachable, + NlnsIncomplete, + NlnsProbe, + NlnsDelay, + NlnsStale, + NlnsReachable, + NlnsPermanent, + NlnsMaximum, +} NL_NEIGHBOR_STATE, *PNL_NEIGHBOR_STATE; + +typedef enum _NL_LINK_LOCAL_ADDRESS_BEHAVIOR{ + LinkLocalAlwaysOff = 0, // Never use link locals. + LinkLocalDelayed, // Use link locals only if no other addresses. + // (default for IPv4). + // Legacy mapping: IPAutoconfigurationEnabled. + LinkLocalAlwaysOn, // Always use link locals (default for IPv6). + LinkLocalUnchanged = -1 +} NL_LINK_LOCAL_ADDRESS_BEHAVIOR; + +#pragma warning(push) +#pragma warning(disable:4214) + +typedef struct _NL_INTERFACE_OFFLOAD_ROD { + BOOLEAN NlChecksumSupported : 1; + BOOLEAN NlOptionsSupported : 1; + BOOLEAN TlDatagramChecksumSupported : 1; + BOOLEAN TlStreamChecksumSupported : 1; + BOOLEAN TlStreamOptionsSupported : 1; + BOOLEAN FastPathCompatible : 1; + BOOLEAN TlLargeSendOffloadSupported : 1; + BOOLEAN TlGiantSendOffloadSupported : 1; +} NL_INTERFACE_OFFLOAD_ROD, *PNL_INTERFACE_OFFLOAD_ROD; + +#pragma warning(pop) + +typedef enum _NL_ROUTER_DISCOVERY_BEHAVIOR { + RouterDiscoveryDisabled = 0, + RouterDiscoveryEnabled, + RouterDiscoveryDhcp, + RouterDiscoveryUnchanged = -1 +} NL_ROUTER_DISCOVERY_BEHAVIOR; + +typedef enum _NL_BANDWIDTH_FLAG { + NlbwDisabled = 0, + NlbwEnabled, + NlbwUnchanged = -1 +} NL_BANDWIDTH_FLAG, *PNL_BANDWIDTH_FLAG; + +typedef struct _NL_PATH_BANDWIDTH_ROD { + ULONG64 Bandwidth; + ULONG64 Instability; + BOOLEAN BandwidthPeaked; +} NL_PATH_BANDWIDTH_ROD, *PNL_PATH_BANDWIDTH_ROD; + +typedef enum _NL_NETWORK_CATEGORY { + NetworkCategoryPublic, + NetworkCategoryPrivate, + NetworkCategoryDomainAuthenticated, + NetworkCategoryUnchanged = -1, // used in a set operation + NetworkCategoryUnknown = -1 // returned in a query operation +} NL_NETWORK_CATEGORY, *PNL_NETWORK_CATEGORY; + +typedef enum _NL_INTERFACE_NETWORK_CATEGORY_STATE { + NlincCategoryUnknown = 0, + NlincPublic = 1, + NlincPrivate = 2, + NlincDomainAuthenticated = 3, + NlincCategoryStateMax +} NL_INTERFACE_NETWORK_CATEGORY_STATE, +*PNL_INTERFACE_NETWORK_CATEGORY_STATE; + +typedef enum _NL_NETWORK_CONNECTIVITY_LEVEL_HINT { + NetworkConnectivityLevelHintUnknown = 0, + NetworkConnectivityLevelHintNone, + NetworkConnectivityLevelHintLocalAccess, + NetworkConnectivityLevelHintInternetAccess, + NetworkConnectivityLevelHintConstrainedInternetAccess, + NetworkConnectivityLevelHintHidden, +} NL_NETWORK_CONNECTIVITY_LEVEL_HINT; + +typedef enum _NL_NETWORK_CONNECTIVITY_COST_HINT { + NetworkConnectivityCostHintUnknown = 0, + NetworkConnectivityCostHintUnrestricted, + NetworkConnectivityCostHintFixed, + NetworkConnectivityCostHintVariable, +} NL_NETWORK_CONNECTIVITY_COST_HINT; + +typedef struct _NL_NETWORK_CONNECTIVITY_HINT { + NL_NETWORK_CONNECTIVITY_LEVEL_HINT ConnectivityLevel; + + // + // Fields reflecting cost factors. + // + NL_NETWORK_CONNECTIVITY_COST_HINT ConnectivityCost; + BOOLEAN ApproachingDataLimit; + BOOLEAN OverDataLimit; + BOOLEAN Roaming; +} NL_NETWORK_CONNECTIVITY_HINT; + +#define NET_IF_CURRENT_SESSION ((ULONG)-1) + +typedef struct _NL_BANDWIDTH_INFORMATION { + ULONG64 Bandwidth; + ULONG64 Instability; + BOOLEAN BandwidthPeaked; +} NL_BANDWIDTH_INFORMATION, *PNL_BANDWIDTH_INFORMATION; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _NLDEF_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/no_sal2.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/no_sal2.h new file mode 100644 index 0000000000000000000000000000000000000000..7330cf04ce790d30d0d2379189c01f349033ad09 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/no_sal2.h @@ -0,0 +1,1042 @@ + +/*** +* no_sal2.h - renders the SAL annotations for documenting APIs harmless. +* +* Copyright (c) Microsoft Corporation. All rights reserved. +* +*Purpose: +* sal.h provides a set of SAL2 annotations to describe how a function uses its +* parameters - the assumptions it makes about them, and the guarantees it makes +* upon finishing. This file redefines all those annotation macros to be harmless. +* It is designed for use in down-level build environments where the tooling may +* be unhappy with the standard SAL2 macro definitions. +* +* [Public] +* +****/ + +#ifndef _NO_SAL_2_H_ +#define _NO_SAL_2_H_ + +#ifdef _When_ +#undef _When_ +#endif +#define _When_(c,a) +#ifdef _At_ +#undef _At_ +#endif +#define _At_(t,a) +#ifdef _At_buffer_ +#undef _At_buffer_ +#endif +#define _At_buffer_(t,i,c,a) +#ifdef _Group_ +#undef _Group_ +#endif +#define _Group_(a) +#ifdef _Pre_ +#undef _Pre_ +#endif +#define _Pre_ +#ifdef _Post_ +#undef _Post_ +#endif +#define _Post_ +#ifdef _Deref_ +#undef _Deref_ +#endif +#define _Deref_ +#ifdef _Null_ +#undef _Null_ +#endif +#define _Null_ +#ifdef _Notnull_ +#undef _Notnull_ +#endif +#define _Notnull_ +#ifdef _Maybenull_ +#undef _Maybenull_ +#endif +#define _Maybenull_ +#ifdef _Const_ +#undef _Const_ +#endif +#define _Const_ +#ifdef _Check_return_ +#undef _Check_return_ +#endif +#define _Check_return_ +#ifdef _Must_inspect_result_ +#undef _Must_inspect_result_ +#endif +#define _Must_inspect_result_ +#ifdef _Pre_satisfies_ +#undef _Pre_satisfies_ +#endif +#define _Pre_satisfies_(e) +#ifdef _Post_satisfies_ +#undef _Post_satisfies_ +#endif +#define _Post_satisfies_(e) +#ifdef _Writable_elements_ +#undef _Writable_elements_ +#endif +#define _Writable_elements_(s) +#ifdef _Writable_bytes_ +#undef _Writable_bytes_ +#endif +#define _Writable_bytes_(s) +#ifdef _Readable_elements_ +#undef _Readable_elements_ +#endif +#define _Readable_elements_(s) +#ifdef _Readable_bytes_ +#undef _Readable_bytes_ +#endif +#define _Readable_bytes_(s) +#ifdef _Null_terminated_ +#undef _Null_terminated_ +#endif +#define _Null_terminated_ +#ifdef _NullNull_terminated_ +#undef _NullNull_terminated_ +#endif +#define _NullNull_terminated_ +#ifdef _Valid_ +#undef _Valid_ +#endif +#define _Valid_ +#ifdef _Notvalid_ +#undef _Notvalid_ +#endif +#define _Notvalid_ +#ifdef _Success_ +#undef _Success_ +#endif +#define _Success_(c) +#ifdef _Return_type_success_ +#undef _Return_type_success_ +#endif +#define _Return_type_success_(c) +#ifdef _On_failure_ +#undef _On_failure_ +#endif +#define _On_failure_(a) +#ifdef _Always_ +#undef _Always_ +#endif +#define _Always_(a) +#ifdef _Use_decl_annotations_ +#undef _Use_decl_annotations_ +#endif +#define _Use_decl_annotations_ +#ifdef _Pre_defensive_ +#undef _Pre_defensive_ +#endif +#define _Pre_defensive_ +#ifdef _Post_defensive_ +#undef _Post_defensive_ +#endif +#define _Post_defensive_ +#ifdef _Pre_unknown_ +#undef _Pre_unknown_ +#endif +#define _Pre_unknown_ +#ifdef _Acquires_lock_ +#undef _Acquires_lock_ +#endif +#define _Acquires_lock_(e) +#ifdef _Releases_lock_ +#undef _Releases_lock_ +#endif +#define _Releases_lock_(e) +#ifdef _Requires_lock_held_ +#undef _Requires_lock_held_ +#endif +#define _Requires_lock_held_(e) +#ifdef _Requires_lock_not_held_ +#undef _Requires_lock_not_held_ +#endif +#define _Requires_lock_not_held_(e) +#ifdef _Requires_no_locks_held_ +#undef _Requires_no_locks_held_ +#endif +#define _Requires_no_locks_held_ +#ifdef _Guarded_by_ +#undef _Guarded_by_ +#endif +#define _Guarded_by_(e) +#ifdef _Write_guarded_by_ +#undef _Write_guarded_by_ +#endif +#define _Write_guarded_by_(e) +#ifdef _Interlocked_ +#undef _Interlocked_ +#endif +#define _Interlocked_ +#ifdef _Post_same_lock_ +#undef _Post_same_lock_ +#endif +#define _Post_same_lock_(e1,e2) +#ifdef _Benign_race_begin_ +#undef _Benign_race_begin_ +#endif +#define _Benign_race_begin_ +#ifdef _Benign_race_end_ +#undef _Benign_race_end_ +#endif +#define _Benign_race_end_ +#ifdef _No_competing_thread_ +#undef _No_competing_thread_ +#endif +#define _No_competing_thread_ +#ifdef _No_competing_thread_begin_ +#undef _No_competing_thread_begin_ +#endif +#define _No_competing_thread_begin_ +#ifdef _No_competing_thread_end_ +#undef _No_competing_thread_end_ +#endif +#define _No_competing_thread_end_ +#ifdef _Acquires_shared_lock_ +#undef _Acquires_shared_lock_ +#endif +#define _Acquires_shared_lock_(e) +#ifdef _Releases_shared_lock_ +#undef _Releases_shared_lock_ +#endif +#define _Releases_shared_lock_(e) +#ifdef _Requires_shared_lock_held_ +#undef _Requires_shared_lock_held_ +#endif +#define _Requires_shared_lock_held_(e) +#ifdef _Acquires_exclusive_lock_ +#undef _Acquires_exclusive_lock_ +#endif +#define _Acquires_exclusive_lock_(e) +#ifdef _Releases_exclusive_lock_ +#undef _Releases_exclusive_lock_ +#endif +#define _Releases_exclusive_lock_(e) +#ifdef _Requires_exclusive_lock_held_ +#undef _Requires_exclusive_lock_held_ +#endif +#define _Requires_exclusive_lock_held_(e) +#ifdef _Has_lock_kind_ +#undef _Has_lock_kind_ +#endif +#define _Has_lock_kind_(n) +#ifdef _Create_lock_level_ +#undef _Create_lock_level_ +#endif +#define _Create_lock_level_(n) +#ifdef _Has_lock_level_ +#undef _Has_lock_level_ +#endif +#define _Has_lock_level_(n) +#ifdef _Lock_level_order_ +#undef _Lock_level_order_ +#endif +#define _Lock_level_order_(n1,n2) +#ifdef _Analysis_assume_lock_acquired_ +#undef _Analysis_assume_lock_acquired_ +#endif +#define _Analysis_assume_lock_acquired_(e) +#ifdef _Analysis_assume_lock_released_ +#undef _Analysis_assume_lock_released_ +#endif +#define _Analysis_assume_lock_released_(e) +#ifdef _Analysis_assume_lock_held_ +#undef _Analysis_assume_lock_held_ +#endif +#define _Analysis_assume_lock_held_(e) +#ifdef _Analysis_assume_lock_not_held_ +#undef _Analysis_assume_lock_not_held_ +#endif +#define _Analysis_assume_lock_not_held_(e) +#ifdef _Analysis_assume_same_lock_ +#undef _Analysis_assume_same_lock_ +#endif +#define _Analysis_assume_same_lock_(e) +#ifdef _In_ +#undef _In_ +#endif +#define _In_ +#ifdef _Out_ +#undef _Out_ +#endif +#define _Out_ +#ifdef _Inout_ +#undef _Inout_ +#endif +#define _Inout_ +#ifdef _In_z_ +#undef _In_z_ +#endif +#define _In_z_ +#ifdef _Inout_z_ +#undef _Inout_z_ +#endif +#define _Inout_z_ +#ifdef _In_reads_ +#undef _In_reads_ +#endif +#define _In_reads_(s) +#ifdef _In_reads_bytes_ +#undef _In_reads_bytes_ +#endif +#define _In_reads_bytes_(s) +#ifdef _In_reads_z_ +#undef _In_reads_z_ +#endif +#define _In_reads_z_(s) +#ifdef _In_reads_or_z_ +#undef _In_reads_or_z_ +#endif +#define _In_reads_or_z_(s) +#ifdef _Out_writes_ +#undef _Out_writes_ +#endif +#define _Out_writes_(s) +#ifdef _Out_writes_bytes_ +#undef _Out_writes_bytes_ +#endif +#define _Out_writes_bytes_(s) +#ifdef _Out_writes_z_ +#undef _Out_writes_z_ +#endif +#define _Out_writes_z_(s) +#ifdef _Inout_updates_ +#undef _Inout_updates_ +#endif +#define _Inout_updates_(s) +#ifdef _Inout_updates_bytes_ +#undef _Inout_updates_bytes_ +#endif +#define _Inout_updates_bytes_(s) +#ifdef _Inout_updates_z_ +#undef _Inout_updates_z_ +#endif +#define _Inout_updates_z_(s) +#ifdef _Out_writes_to_ +#undef _Out_writes_to_ +#endif +#define _Out_writes_to_(s,c) +#ifdef _Out_writes_bytes_to_ +#undef _Out_writes_bytes_to_ +#endif +#define _Out_writes_bytes_to_(s,c) +#ifdef _Out_writes_all_ +#undef _Out_writes_all_ +#endif +#define _Out_writes_all_(s) +#ifdef _Out_writes_bytes_all_ +#undef _Out_writes_bytes_all_ +#endif +#define _Out_writes_bytes_all_(s) +#ifdef _Inout_updates_to_ +#undef _Inout_updates_to_ +#endif +#define _Inout_updates_to_(s,c) +#ifdef _Inout_updates_bytes_to_ +#undef _Inout_updates_bytes_to_ +#endif +#define _Inout_updates_bytes_to_(s,c) +#ifdef _Inout_updates_all_ +#undef _Inout_updates_all_ +#endif +#define _Inout_updates_all_(s) +#ifdef _Inout_updates_bytes_all_ +#undef _Inout_updates_bytes_all_ +#endif +#define _Inout_updates_bytes_all_(s) +#ifdef _In_reads_to_ptr_ +#undef _In_reads_to_ptr_ +#endif +#define _In_reads_to_ptr_(p) +#ifdef _In_reads_to_ptr_z_ +#undef _In_reads_to_ptr_z_ +#endif +#define _In_reads_to_ptr_z_(p) +#ifdef _Out_writes_to_ptr_ +#undef _Out_writes_to_ptr_ +#endif +#define _Out_writes_to_ptr_(p) +#ifdef _Out_writes_to_ptr_z_ +#undef _Out_writes_to_ptr_z_ +#endif +#define _Out_writes_to_ptr_z_(p) +#ifdef _In_opt_ +#undef _In_opt_ +#endif +#define _In_opt_ +#ifdef _Out_opt_ +#undef _Out_opt_ +#endif +#define _Out_opt_ +#ifdef _Inout_opt_ +#undef _Inout_opt_ +#endif +#define _Inout_opt_ +#ifdef _In_opt_z_ +#undef _In_opt_z_ +#endif +#define _In_opt_z_ +#ifdef _Inout_opt_z_ +#undef _Inout_opt_z_ +#endif +#define _Inout_opt_z_ +#ifdef _In_reads_opt_ +#undef _In_reads_opt_ +#endif +#define _In_reads_opt_(s) +#ifdef _In_reads_opt_z_ +#undef _In_reads_opt_z_ +#endif +#define _In_reads_opt_z_(s) +#ifdef _In_reads_bytes_opt_ +#undef _In_reads_bytes_opt_ +#endif +#define _In_reads_bytes_opt_(s) +#ifdef _Out_writes_opt_ +#undef _Out_writes_opt_ +#endif +#define _Out_writes_opt_(s) +#ifdef _Out_writes_bytes_opt_ +#undef _Out_writes_bytes_opt_ +#endif +#define _Out_writes_bytes_opt_(s) +#ifdef _Out_writes_opt_z_ +#undef _Out_writes_opt_z_ +#endif +#define _Out_writes_opt_z_(s) +#ifdef _Inout_updates_opt_ +#undef _Inout_updates_opt_ +#endif +#define _Inout_updates_opt_(s) +#ifdef _Inout_updates_bytes_opt_ +#undef _Inout_updates_bytes_opt_ +#endif +#define _Inout_updates_bytes_opt_(s) +#ifdef _Inout_updates_opt_z_ +#undef _Inout_updates_opt_z_ +#endif +#define _Inout_updates_opt_z_(s) +#ifdef _Out_writes_to_opt_ +#undef _Out_writes_to_opt_ +#endif +#define _Out_writes_to_opt_(s,c) +#ifdef _Out_writes_bytes_to_opt_ +#undef _Out_writes_bytes_to_opt_ +#endif +#define _Out_writes_bytes_to_opt_(s,c) +#ifdef _Out_writes_all_opt_ +#undef _Out_writes_all_opt_ +#endif +#define _Out_writes_all_opt_(s) +#ifdef _Out_writes_bytes_all_opt_ +#undef _Out_writes_bytes_all_opt_ +#endif +#define _Out_writes_bytes_all_opt_(s) +#ifdef _Inout_updates_to_opt_ +#undef _Inout_updates_to_opt_ +#endif +#define _Inout_updates_to_opt_(s,c) +#ifdef _Inout_updates_bytes_to_opt_ +#undef _Inout_updates_bytes_to_opt_ +#endif +#define _Inout_updates_bytes_to_opt_(s,c) +#ifdef _Inout_updates_all_opt_ +#undef _Inout_updates_all_opt_ +#endif +#define _Inout_updates_all_opt_(s) +#ifdef _Inout_updates_bytes_all_opt_ +#undef _Inout_updates_bytes_all_opt_ +#endif +#define _Inout_updates_bytes_all_opt_(s) +#ifdef _In_reads_to_ptr_opt_ +#undef _In_reads_to_ptr_opt_ +#endif +#define _In_reads_to_ptr_opt_(p) +#ifdef _In_reads_to_ptr_opt_z_ +#undef _In_reads_to_ptr_opt_z_ +#endif +#define _In_reads_to_ptr_opt_z_(p) +#ifdef _Out_writes_to_ptr_opt_ +#undef _Out_writes_to_ptr_opt_ +#endif +#define _Out_writes_to_ptr_opt_(p) +#ifdef _Out_writes_to_ptr_opt_z_ +#undef _Out_writes_to_ptr_opt_z_ +#endif +#define _Out_writes_to_ptr_opt_z_(p) +#ifdef _Outptr_ +#undef _Outptr_ +#endif +#define _Outptr_ +#ifdef _Outptr_opt_ +#undef _Outptr_opt_ +#endif +#define _Outptr_opt_ +#ifdef _Outptr_result_maybenull_ +#undef _Outptr_result_maybenull_ +#endif +#define _Outptr_result_maybenull_ +#ifdef _Outptr_opt_result_maybenull_ +#undef _Outptr_opt_result_maybenull_ +#endif +#define _Outptr_opt_result_maybenull_ +#ifdef _Outptr_result_z_ +#undef _Outptr_result_z_ +#endif +#define _Outptr_result_z_ +#ifdef _Outptr_opt_result_z_ +#undef _Outptr_opt_result_z_ +#endif +#define _Outptr_opt_result_z_ +#ifdef _Outptr_result_maybenull_z_ +#undef _Outptr_result_maybenull_z_ +#endif +#define _Outptr_result_maybenull_z_ +#ifdef _Outptr_opt_result_maybenull_z_ +#undef _Outptr_opt_result_maybenull_z_ +#endif +#define _Outptr_opt_result_maybenull_z_ +#ifdef _COM_Outptr_ +#undef _COM_Outptr_ +#endif +#define _COM_Outptr_ +#ifdef _COM_Outptr_opt_ +#undef _COM_Outptr_opt_ +#endif +#define _COM_Outptr_opt_ +#ifdef _COM_Outptr_result_maybenull_ +#undef _COM_Outptr_result_maybenull_ +#endif +#define _COM_Outptr_result_maybenull_ +#ifdef _COM_Outptr_opt_result_maybenull_ +#undef _COM_Outptr_opt_result_maybenull_ +#endif +#define _COM_Outptr_opt_result_maybenull_ +#ifdef _Outptr_result_buffer_ +#undef _Outptr_result_buffer_ +#endif +#define _Outptr_result_buffer_(s) +#ifdef _Outptr_result_buffer_maybenull_ +#undef _Outptr_result_buffer_maybenull_ +#endif +#define _Outptr_result_buffer_maybenull_(s) +#ifdef _Outptr_result_bytebuffer_ +#undef _Outptr_result_bytebuffer_ +#endif +#define _Outptr_result_bytebuffer_(s) +#ifdef _Outptr_result_bytebuffer_maybenull_ +#undef _Outptr_result_bytebuffer_maybenull_ +#endif +#define _Outptr_result_bytebuffer_maybenull_(s) +#ifdef _Outptr_opt_result_buffer_ +#undef _Outptr_opt_result_buffer_ +#endif +#define _Outptr_opt_result_buffer_(s) +#ifdef _Outptr_opt_result_buffer_maybenull_ +#undef _Outptr_opt_result_buffer_maybenull_ +#endif +#define _Outptr_opt_result_buffer_maybenull_(s) +#ifdef _Outptr_opt_result_bytebuffer_ +#undef _Outptr_opt_result_bytebuffer_ +#endif +#define _Outptr_opt_result_bytebuffer_(s) +#ifdef _Outptr_opt_result_bytebuffer_maybenull_ +#undef _Outptr_opt_result_bytebuffer_maybenull_ +#endif +#define _Outptr_opt_result_bytebuffer_maybenull_(s) +#ifdef _Outptr_result_buffer_to_ +#undef _Outptr_result_buffer_to_ +#endif +#define _Outptr_result_buffer_to_(s,c) +#ifdef _Outptr_result_bytebuffer_to_ +#undef _Outptr_result_bytebuffer_to_ +#endif +#define _Outptr_result_bytebuffer_to_(s,c) +#ifdef _Outptr_opt_result_buffer_to_ +#undef _Outptr_opt_result_buffer_to_ +#endif +#define _Outptr_opt_result_buffer_to_(s,c) +#ifdef _Outptr_opt_result_bytebuffer_to_ +#undef _Outptr_opt_result_bytebuffer_to_ +#endif +#define _Outptr_opt_result_bytebuffer_to_(s,c) +#ifdef _Ret_ +#undef _Ret_ +#endif +#define _Ret_ +#ifdef _Ret_valid_ +#undef _Ret_valid_ +#endif +#define _Ret_valid_ +#ifdef _Ret_z_ +#undef _Ret_z_ +#endif +#define _Ret_z_ +#ifdef _Ret_writes_ +#undef _Ret_writes_ +#endif +#define _Ret_writes_(s) +#ifdef _Ret_writes_bytes_ +#undef _Ret_writes_bytes_ +#endif +#define _Ret_writes_bytes_(s) +#ifdef _Ret_writes_z_ +#undef _Ret_writes_z_ +#endif +#define _Ret_writes_z_(s) +#ifdef _Ret_writes_to_ +#undef _Ret_writes_to_ +#endif +#define _Ret_writes_to_(s,c) +#ifdef _Ret_writes_bytes_to_ +#undef _Ret_writes_bytes_to_ +#endif +#define _Ret_writes_bytes_to_(s,c) +#ifdef _Ret_writes_to_ptr_ +#undef _Ret_writes_to_ptr_ +#endif +#define _Ret_writes_to_ptr_(p) +#ifdef _Ret_writes_to_ptr_z_ +#undef _Ret_writes_to_ptr_z_ +#endif +#define _Ret_writes_to_ptr_z_(p) +#ifdef _Ret_writes_maybenull_ +#undef _Ret_writes_maybenull_ +#endif +#define _Ret_writes_maybenull_(s) +#ifdef _Ret_writes_bytes_maybenull_ +#undef _Ret_writes_bytes_maybenull_ +#endif +#define _Ret_writes_bytes_maybenull_(s) +#ifdef _Ret_writes_to_maybenull_ +#undef _Ret_writes_to_maybenull_ +#endif +#define _Ret_writes_to_maybenull_(s,c) +#ifdef _Ret_writes_bytes_to_maybenull_ +#undef _Ret_writes_bytes_to_maybenull_ +#endif +#define _Ret_writes_bytes_to_maybenull_(s,c) +#ifdef _Ret_writes_maybenull_z_ +#undef _Ret_writes_maybenull_z_ +#endif +#define _Ret_writes_maybenull_z_(s) +#ifdef _Ret_null_ +#undef _Ret_null_ +#endif +#define _Ret_null_ +#ifdef _Ret_notnull_ +#undef _Ret_notnull_ +#endif +#define _Ret_notnull_ +#ifdef _Ret_maybenull_ +#undef _Ret_maybenull_ +#endif +#define _Ret_maybenull_ +#ifdef _Ret_maybenull_z_ +#undef _Ret_maybenull_z_ +#endif +#define _Ret_maybenull_z_ +#ifdef _Field_size_ +#undef _Field_size_ +#endif +#define _Field_size_(s) +#ifdef _Field_size_opt_ +#undef _Field_size_opt_ +#endif +#define _Field_size_opt_(s) +#ifdef _Field_size_bytes_ +#undef _Field_size_bytes_ +#endif +#define _Field_size_bytes_(s) +#ifdef _Field_size_bytes_opt_ +#undef _Field_size_bytes_opt_ +#endif +#define _Field_size_bytes_opt_(s) +#ifdef _Field_size_part_ +#undef _Field_size_part_ +#endif +#define _Field_size_part_(s,c) +#ifdef _Field_size_part_opt_ +#undef _Field_size_part_opt_ +#endif +#define _Field_size_part_opt_(s,c) +#ifdef _Field_size_bytes_part_ +#undef _Field_size_bytes_part_ +#endif +#define _Field_size_bytes_part_(s,c) +#ifdef _Field_size_bytes_part_opt_ +#undef _Field_size_bytes_part_opt_ +#endif +#define _Field_size_bytes_part_opt_(s,c) +#ifdef _Field_size_full_ +#undef _Field_size_full_ +#endif +#define _Field_size_full_(s) +#ifdef _Field_size_full_opt_ +#undef _Field_size_full_opt_ +#endif +#define _Field_size_full_opt_(s) +#ifdef _Field_size_bytes_full_ +#undef _Field_size_bytes_full_ +#endif +#define _Field_size_bytes_full_(s) +#ifdef _Field_size_bytes_full_opt_ +#undef _Field_size_bytes_full_opt_ +#endif +#define _Field_size_bytes_full_opt_(s) +#ifdef _Printf_format_string_ +#undef _Printf_format_string_ +#endif +#define _Printf_format_string_ +#ifdef _Scanf_format_string_ +#undef _Scanf_format_string_ +#endif +#define _Scanf_format_string_ +#ifdef _Scanf_s_format_string_ +#undef _Scanf_s_format_string_ +#endif +#define _Scanf_s_format_string_ +#ifdef _Printf_format_string_params_ +#undef _Printf_format_string_params_ +#endif +#define _Printf_format_string_params_(x) +#ifdef _Scanf_format_string_params_ +#undef _Scanf_format_string_params_ +#endif +#define _Scanf_format_string_params_(x) +#ifdef _Scanf_s_format_string_params_ +#undef _Scanf_s_format_string_params_ +#endif +#define _Scanf_s_format_string_params_(x) +#ifdef _In_range_ +#undef _In_range_ +#endif +#define _In_range_(l,h) +#ifdef _Out_range_ +#undef _Out_range_ +#endif +#define _Out_range_(l,h) +#ifdef _Ret_range_ +#undef _Ret_range_ +#endif +#define _Ret_range_(l,h) +#ifdef _Deref_in_range_ +#undef _Deref_in_range_ +#endif +#define _Deref_in_range_(l,h) +#ifdef _Deref_out_range_ +#undef _Deref_out_range_ +#endif +#define _Deref_out_range_(l,h) +#ifdef _Deref_inout_range_ +#undef _Deref_inout_range_ +#endif +#define _Deref_inout_range_(l,h) +#ifdef _Field_range_ +#undef _Field_range_ +#endif +#define _Field_range_(l,h) +#ifdef _Pre_equal_to_ +#undef _Pre_equal_to_ +#endif +#define _Pre_equal_to_(e) +#ifdef _Post_equal_to_ +#undef _Post_equal_to_ +#endif +#define _Post_equal_to_(e) +#ifdef _Struct_size_bytes_ +#undef _Struct_size_bytes_ +#endif +#define _Struct_size_bytes_(s) +#ifdef _Analysis_assume_ +#undef _Analysis_assume_ +#endif +#define _Analysis_assume_ +#ifdef _Analysis_assume_nullterminated_ +#undef _Analysis_assume_nullterminated_ +#endif +#define _Analysis_assume_nullterminated_(s) +#ifdef _Analysis_mode_ +#undef _Analysis_mode_ +#endif +#define _Analysis_mode_(m) +#ifdef _Analysis_noreturn_ +#undef _Analysis_noreturn_ +#endif +#define _Analysis_noreturn_ +#ifdef _Raises_SEH_exception_ +#undef _Raises_SEH_exception_ +#endif +#define _Raises_SEH_exception_ +#ifdef _Maybe_raises_SEH_exception_ +#undef _Maybe_raises_SEH_exception_ +#endif +#define _Maybe_raises_SEH_exception_ +#ifdef _Function_class_ +#undef _Function_class_ +#endif +#define _Function_class_(n) +#ifdef _Literal_ +#undef _Literal_ +#endif +#define _Literal_ +#ifdef _Notliteral_ +#undef _Notliteral_ +#endif +#define _Notliteral_ +#ifdef _Enum_is_bitflag_ +#undef _Enum_is_bitflag_ +#endif +#define _Enum_is_bitflag_ +#ifdef _Strict_type_match_ +#undef _Strict_type_match_ +#endif +#define _Strict_type_match_ +#ifdef _Points_to_data_ +#undef _Points_to_data_ +#endif +#define _Points_to_data_ +#ifdef _Interlocked_operand_ +#undef _Interlocked_operand_ +#endif +#define _Interlocked_operand_ +#ifdef _IRQL_raises_ +#undef _IRQL_raises_ +#endif +#define _IRQL_raises_(i) +#ifdef _IRQL_requires_ +#undef _IRQL_requires_ +#endif +#define _IRQL_requires_(i) +#ifdef _IRQL_requires_max_ +#undef _IRQL_requires_max_ +#endif +#define _IRQL_requires_max_(i) +#ifdef _IRQL_requires_min_ +#undef _IRQL_requires_min_ +#endif +#define _IRQL_requires_min_(i) +#ifdef _IRQL_saves_ +#undef _IRQL_saves_ +#endif +#define _IRQL_saves_ +#ifdef _IRQL_saves_global_ +#undef _IRQL_saves_global_ +#endif +#define _IRQL_saves_global_(k,s) +#ifdef _IRQL_restores_ +#undef _IRQL_restores_ +#endif +#define _IRQL_restores_ +#ifdef _IRQL_restores_global_ +#undef _IRQL_restores_global_ +#endif +#define _IRQL_restores_global_(k,s) +#ifdef _IRQL_always_function_min_ +#undef _IRQL_always_function_min_ +#endif +#define _IRQL_always_function_min_(i) +#ifdef _IRQL_always_function_max_ +#undef _IRQL_always_function_max_ +#endif +#define _IRQL_always_function_max_(i) +#ifdef _IRQL_requires_same_ +#undef _IRQL_requires_same_ +#endif +#define _IRQL_requires_same_ +#ifdef _IRQL_uses_cancel_ +#undef _IRQL_uses_cancel_ +#endif +#define _IRQL_uses_cancel_ +#ifdef _IRQL_is_cancel_ +#undef _IRQL_is_cancel_ +#endif +#define _IRQL_is_cancel_ +#ifdef _Kernel_float_saved_ +#undef _Kernel_float_saved_ +#endif +#define _Kernel_float_saved_ +#ifdef _Kernel_float_restored_ +#undef _Kernel_float_restored_ +#endif +#define _Kernel_float_restored_ +#ifdef _Kernel_float_used_ +#undef _Kernel_float_used_ +#endif +#define _Kernel_float_used_ +#ifdef _Kernel_acquires_resource_ +#undef _Kernel_acquires_resource_ +#endif +#define _Kernel_acquires_resource_(k) +#ifdef _Kernel_releases_resource_ +#undef _Kernel_releases_resource_ +#endif +#define _Kernel_releases_resource_(k) +#ifdef _Kernel_requires_resource_held_ +#undef _Kernel_requires_resource_held_ +#endif +#define _Kernel_requires_resource_held_(k) +#ifdef _Kernel_requires_resource_not_held_ +#undef _Kernel_requires_resource_not_held_ +#endif +#define _Kernel_requires_resource_not_held_(k) +#ifdef _Kernel_clear_do_init_ +#undef _Kernel_clear_do_init_ +#endif +#define _Kernel_clear_do_init_(yn) +#ifdef _Kernel_IoGetDmaAdapter_ +#undef _Kernel_IoGetDmaAdapter_ +#endif +#define _Kernel_IoGetDmaAdapter_ +#ifdef _Outref_ +#undef _Outref_ +#endif +#define _Outref_ +#ifdef _Outref_result_maybenull_ +#undef _Outref_result_maybenull_ +#endif +#define _Outref_result_maybenull_ +#ifdef _Outref_result_buffer_ +#undef _Outref_result_buffer_ +#endif +#define _Outref_result_buffer_(s) +#ifdef _Outref_result_bytebuffer_ +#undef _Outref_result_bytebuffer_ +#endif +#define _Outref_result_bytebuffer_(s) +#ifdef _Outref_result_buffer_to_ +#undef _Outref_result_buffer_to_ +#endif +#define _Outref_result_buffer_to_(s,c) +#ifdef _Outref_result_bytebuffer_to_ +#undef _Outref_result_bytebuffer_to_ +#endif +#define _Outref_result_bytebuffer_to_(s,c) +#ifdef _Outref_result_buffer_all_ +#undef _Outref_result_buffer_all_ +#endif +#define _Outref_result_buffer_all_(s) +#ifdef _Outref_result_bytebuffer_all_ +#undef _Outref_result_bytebuffer_all_ +#endif +#define _Outref_result_bytebuffer_all_(s) +#ifdef _Outref_result_buffer_maybenull_ +#undef _Outref_result_buffer_maybenull_ +#endif +#define _Outref_result_buffer_maybenull_(s) +#ifdef _Outref_result_bytebuffer_maybenull_ +#undef _Outref_result_bytebuffer_maybenull_ +#endif +#define _Outref_result_bytebuffer_maybenull_(s) +#ifdef _Outref_result_buffer_to_maybenull_ +#undef _Outref_result_buffer_to_maybenull_ +#endif +#define _Outref_result_buffer_to_maybenull_(s,c) +#ifdef _Outref_result_bytebuffer_to_maybenull_ +#undef _Outref_result_bytebuffer_to_maybenull_ +#endif +#define _Outref_result_bytebuffer_to_maybenull_(s,c) +#ifdef _Outref_result_buffer_all_maybenull_ +#undef _Outref_result_buffer_all_maybenull_ +#endif +#define _Outref_result_buffer_all_maybenull_(s) +#ifdef _Outref_result_bytebuffer_all_maybenull_ +#undef _Outref_result_bytebuffer_all_maybenull_ +#endif +#define _Outref_result_bytebuffer_all_maybenull_(s) +#ifdef _In_defensive_ +#undef _In_defensive_ +#endif +#define _In_defensive_(a) +#ifdef _Out_defensive_ +#undef _Out_defensive_ +#endif +#define _Out_defensive_(a) +#ifdef _Inout_defensive_ +#undef _Inout_defensive_ +#endif +#define _Inout_defensive_(a) +#ifdef _Outptr_result_nullonfailure_ +#undef _Outptr_result_nullonfailure_ +#endif +#define _Outptr_result_nullonfailure_ +#ifdef _Outptr_opt_result_nullonfailure_ +#undef _Outptr_opt_result_nullonfailure_ +#endif +#define _Outptr_opt_result_nullonfailure_ +#ifdef _Outref_result_nullonfailure_ +#undef _Outref_result_nullonfailure_ +#endif +#define _Outref_result_nullonfailure_ +#ifdef _Result_nullonfailure_ +#undef _Result_nullonfailure_ +#endif +#define _Result_nullonfailure_ +#ifdef _Result_zeroonfailure_ +#undef _Result_zeroonfailure_ +#endif +#define _Result_zeroonfailure_ +#ifdef _Acquires_nonreentrant_lock_ +#undef _Acquires_nonreentrant_lock_ +#endif +#define _Acquires_nonreentrant_lock_(e) +#ifdef _Releases_nonreentrant_lock_ +#undef _Releases_nonreentrant_lock_ +#endif +#define _Releases_nonreentrant_lock_(e) +#ifdef _Function_ignore_lock_checking_ +#undef _Function_ignore_lock_checking_ +#endif +#define _Function_ignore_lock_checking_(e) +#ifdef _Analysis_suppress_lock_checking_ +#undef _Analysis_suppress_lock_checking_ +#endif +#define _Analysis_suppress_lock_checking_(e) +#undef _Reserved_ +#define _Reserved_ _Pre_equal_to_(0) _Pre_ _Null_ +#undef _Pre_z_ +#define _Pre_z_ _Pre_ _Null_terminated_ +#undef _Post_z_ +#define _Post_z_ _Post_ _Null_terminated_ +#undef _Prepost_z_ +#define _Prepost_z_ _Pre_z_ _Post_z_ +#undef _Pre_null_ +#define _Pre_null_ _Pre_ _Null_ +#undef _Pre_maybenull_ +#define _Pre_maybenull_ _Pre_ _Maybenull_ +#undef _Pre_notnull_ +#define _Pre_notnull_ _Pre_ _Notnull_ +#undef _Pre_valid_ +#define _Pre_valid_ _Pre_notnull_ _Pre_ _Valid_ +#undef _Pre_opt_valid_ +#define _Pre_opt_valid_ _Pre_maybenull_ _Pre_ _Valid_ +#undef _Post_valid_ +#define _Post_valid_ _Post_ _Valid_ +#undef _Post_invalid_ +#define _Post_invalid_ _Post_ _Deref_ _Notvalid_ +#undef _Post_ptr_invalid_ +#define _Post_ptr_invalid_ _Post_ _Notvalid_ +#undef _Pre_readable_size_ +#define _Pre_readable_size_(s) _Pre_ _Readable_elements_(s) _Pre_ _Valid_ +#undef _Pre_writable_size_ +#define _Pre_writable_size_(s) _Pre_ _Writable_elements_(s) +#undef _Pre_readable_byte_size_ +#define _Pre_readable_byte_size_(s) _Pre_ _Readable_bytes_(s) _Pre_ _Valid_ +#undef _Pre_writable_byte_size_ +#define _Pre_writable_byte_size_(s) _Pre_ _Writable_bytes_(s) +#undef _Post_readable_size_ +#define _Post_readable_size_(s) _Post_ _Readable_elements_(s) _Post_ _Valid_ +#undef _Post_writable_size_ +#define _Post_writable_size_(s) _Post_ _Writable_elements_(s) +#undef _Post_readable_byte_size_ +#define _Post_readable_byte_size_(s) _Post_ _Readable_bytes_(s) _Post_ _Valid_ +#undef _Post_writable_byte_size_ +#define _Post_writable_byte_size_(s) _Post_ _Writable_bytes_(s) + +#endif /* _NO_SAL_2_H_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdd1394.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdd1394.h new file mode 100644 index 0000000000000000000000000000000000000000..4b64434d237dd84163b574201b6a039a4a8a2c2f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdd1394.h @@ -0,0 +1,231 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntdd1394.h + +Abstract: + + Definitions for the 1394 api + +Environment: + + Kernel mode only + +Revision History: + + +--*/ + +#ifndef _NTDD1394_H_ +#define _NTDD1394_H_ + +#if (_MSC_VER >= 1020) +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +// +// registry definitions +// + +#define BUS1394_VIRTUAL_DEVICE_LIST_KEY L"Virtual Device List" +#define BUS1394_LOCAL_HOST_INSTANCE_KEY L"LOCAL HOST EUI64" + + +// +// Various definitions +// + +#define IOCTL_IEEE1394_API_REQUEST CTL_CODE( \ + FILE_DEVICE_UNKNOWN, \ + 0x100, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS \ + ) + +// +// IEEE 1394 Sbp2 Request packet. It is how other +// device drivers communicate with the 1sbp2 trasnport. +// + +typedef struct _IEEE1394_VDEV_PNP_REQUEST{ + + ULONG fulFlags; + ULONG Reserved; + ULARGE_INTEGER InstanceId; + UCHAR DeviceId; + +} IEEE1394_VDEV_PNP_REQUEST,*PIEEE1394_VDEV_PNP_REQUEST; + + +typedef struct _IEEE1394_API_REQUEST { + + // + // Holds the zero based Function number that corresponds to the request + // that device drivers are asking the sbp2 port driver to carry out. + // + + ULONG RequestNumber; + + // + // Holds Flags that may be unique to this particular operation + // + + ULONG Flags; + + // + // Holds the structures used in performing the various 1394 APIs + // + + union { + + IEEE1394_VDEV_PNP_REQUEST AddVirtualDevice; + IEEE1394_VDEV_PNP_REQUEST RemoveVirtualDevice; + +#if(_WIN32_WINNT <= _WIN32_WINNT_WIN2K) // available in Win2K and below + struct { + + ULONG fulFlags; + ULONG fulDesiredAccess; + ULARGE_INTEGER DeviceEUI; + + } DeviceAccessTransfer; +#endif + + } u; + +} IEEE1394_API_REQUEST, *PIEEE1394_API_REQUEST; + +// +// Request Number +// + +#define IEEE1394_API_ADD_VIRTUAL_DEVICE 0x00000001 +#define IEEE1394_API_REMOVE_VIRTUAL_DEVICE 0x00000002 +#if(_WIN32_WINNT <= _WIN32_WINNT_WIN2K) // available in Win2K and below +#define IEEE1394_API_DEVICE_ACCESS_TRANSFER 0x00000003 +#define IEEE1394_API_SET_LOCAL_NODE_PROPERTIES 0x00000004 +#endif + +// +// flags for the add/remove requests +// + +#define IEEE1394_REQUEST_FLAG_UNICODE 0x00000001 +//#if(_WIN32_WINNT >= _WIN32_WINNT_WINXP) // available in WinXP and above +#define IEEE1394_REQUEST_FLAG_PERSISTENT 0x00000002 +#define IEEE1394_REQUEST_FLAG_USE_LOCAL_HOST_EUI 0x00000004 +//#endif + +// +// definitions for the access/ownership 1394 scheme +// +#if(_WIN32_WINNT <= _WIN32_WINNT_WIN2K) // available in Win2K and below +// +// GUID used to register for PnP notifications on access status changes +// + +static const GUID IEEE1394_API_NOTIFICATION_EVENT = +{ 0xA8E0BA12, 0x4ACF, 0x4278, { 0x87, 0x78, 0xED, 0x7F, 0x28, 0xF2, 0x73, 0xAA } }; + + +typedef struct _IEEE1394_NOTIFICATION_DATA { + + ULONG Version; + ULONG BusGeneration; + ULONG Type; + ULONG Flags; + + union { + + struct { + + ULONG fulFlags; + ULONG AccessFlags; + ULARGE_INTEGER RemoteNodeEUI; + + } AccessChange; + + struct { + + ULONG BusResetFlags; + + } BusReset; + + } u; + +} IEEE1394_NOTIFICATION_DATA, *PIEEE1394_NOTIFICATION_DATA; + +// +// Type definitions +// + +#define IEEE1394API_NOTIFICATION_DEVICE_ACCESS 0x00000001 +#define IEEE1394API_NOTIFICATION_BUS_RESET 0x00000002 + +// +// AccessChange.AccessFlags field +// + +#define IEEE1394API_DEVICE_OWNERSHIP_LOCAL_NODE 0x00000001 +#define IEEE1394API_RESOURCE_OWNERSHIP_LOCAL_NODE 0x00000002 + +#define IEEE1394API_DEVICE_OWNERSHIP_REMOTE_NODE 0x00000004 +#define IEEE1394API_RESOURCE_OWNERSHIP_REMOTE_NODE 0x00000008 + +#define IEEE1394API_ACCESS_SHARED_READ 0x00000010 +#define IEEE1394API_ACCESS_SHARED_WRITE 0x00000020 +#define IEEE1394API_ACCESS_EXCLUSIVE 0x00000040 + +// +// AccessChange.fulFlags field +// + +#define IEEE1394API_REMOTE_ACCESS_TRANSFER_REQUEST 0x00000001 + +// +// BusReset.BusResetFlags +// + +#define IEEE1394API_BUS_RESET_LOCAL_NODE_IS_ROOT 0x00000001 +#define IEEE1394API_BUS_RESET_LOCAL_NODE_IS_IRM 0x00000002 +#define IEEE1394API_BUS_RESET_LOCAL_NODE_INITIATED 0x00000004 + +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDD1394_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddbeep.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddbeep.h new file mode 100644 index 0000000000000000000000000000000000000000..7c2203cc2a398a60141aea861e152783d971e6fb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddbeep.h @@ -0,0 +1,75 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddbeep.h + +Abstract: + + This is the include file that defines all constants and types for + the beep device. + + +--*/ + +#ifndef _NTDDBEEP_ +#define _NTDDBEEP_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_BEEP_DEVICE_NAME "\\Device\\Beep" +#define DD_BEEP_DEVICE_NAME_U L"\\Device\\Beep" + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_BEEP_SET CTL_CODE(FILE_DEVICE_BEEP, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// NtDeviceIoControlFile OutputBuffer record structures for +// IOCTL_BEEP_SET. +// + +typedef struct _BEEP_SET_PARAMETERS { + ULONG Frequency; + ULONG Duration; +} BEEP_SET_PARAMETERS, *PBEEP_SET_PARAMETERS; + +#define BEEP_FREQUENCY_MINIMUM 0x25 +#define BEEP_FREQUENCY_MAXIMUM 0x7FFF + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDBEEP_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdrm.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdrm.h new file mode 100644 index 0000000000000000000000000000000000000000..001794f8ad935ce7c5f2432687b6fe9f32b884a6 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdrm.h @@ -0,0 +1,948 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddcdrm.h + +Abstract: + + This module contains structures and definitions + associated with CDROM IOCTls. + + +--*/ + +// begin_winioctl + +#ifndef _NTDDCDRM_ +#define _NTDDCDRM_ + + +#ifdef __cplusplus +extern "C" { +#endif + + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// remove some level 4 warnings for this header file: +#pragma warning(disable:4200) // array[0] +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int + +#ifdef __cplusplus +extern "C" { +#endif + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_CDROM_BASE FILE_DEVICE_CD_ROM + +#define IOCTL_CDROM_UNLOAD_DRIVER CTL_CODE(IOCTL_CDROM_BASE, 0x0402, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// CDROM Audio Device Control Functions +// + +#define IOCTL_CDROM_READ_TOC CTL_CODE(IOCTL_CDROM_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_SEEK_AUDIO_MSF CTL_CODE(IOCTL_CDROM_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_STOP_AUDIO CTL_CODE(IOCTL_CDROM_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_PAUSE_AUDIO CTL_CODE(IOCTL_CDROM_BASE, 0x0003, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_RESUME_AUDIO CTL_CODE(IOCTL_CDROM_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_GET_VOLUME CTL_CODE(IOCTL_CDROM_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_PLAY_AUDIO_MSF CTL_CODE(IOCTL_CDROM_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_SET_VOLUME CTL_CODE(IOCTL_CDROM_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_READ_Q_CHANNEL CTL_CODE(IOCTL_CDROM_BASE, 0x000B, METHOD_BUFFERED, FILE_READ_ACCESS) +#if (NTDDI_VERSION < NTDDI_WS03) +#define IOCTL_CDROM_GET_CONTROL CTL_CODE(IOCTL_CDROM_BASE, 0x000D, METHOD_BUFFERED, FILE_READ_ACCESS) +#else +#define OBSOLETE_IOCTL_CDROM_GET_CONTROL CTL_CODE(IOCTL_CDROM_BASE, 0x000D, METHOD_BUFFERED, FILE_READ_ACCESS) +#endif +#define IOCTL_CDROM_GET_LAST_SESSION CTL_CODE(IOCTL_CDROM_BASE, 0x000E, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_RAW_READ CTL_CODE(IOCTL_CDROM_BASE, 0x000F, METHOD_OUT_DIRECT, FILE_READ_ACCESS) +#define IOCTL_CDROM_DISK_TYPE CTL_CODE(IOCTL_CDROM_BASE, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_CDROM_GET_DRIVE_GEOMETRY CTL_CODE(IOCTL_CDROM_BASE, 0x0013, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_GET_DRIVE_GEOMETRY_EX CTL_CODE(IOCTL_CDROM_BASE, 0x0014, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_CDROM_READ_TOC_EX CTL_CODE(IOCTL_CDROM_BASE, 0x0015, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_GET_CONFIGURATION CTL_CODE(IOCTL_CDROM_BASE, 0x0016, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_CDROM_EXCLUSIVE_ACCESS CTL_CODE(IOCTL_CDROM_BASE, 0x0017, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_CDROM_SET_SPEED CTL_CODE(IOCTL_CDROM_BASE, 0x0018, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_GET_INQUIRY_DATA CTL_CODE(IOCTL_CDROM_BASE, 0x0019, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_CDROM_ENABLE_STREAMING CTL_CODE(IOCTL_CDROM_BASE, 0x001A, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_SEND_OPC_INFORMATION CTL_CODE(IOCTL_CDROM_BASE, 0x001B, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_CDROM_GET_PERFORMANCE CTL_CODE(IOCTL_CDROM_BASE, 0x001C, METHOD_BUFFERED, FILE_READ_ACCESS) + +// end_winioctl + +// +// The following device control codes are common for all class drivers. The +// functions codes defined here must match all of the other class drivers. +// +// Warning: these codes will be replaced in the future with the IOCTL_STORAGE +// codes included below +// + +#define IOCTL_CDROM_CHECK_VERIFY CTL_CODE(IOCTL_CDROM_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_MEDIA_REMOVAL CTL_CODE(IOCTL_CDROM_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_EJECT_MEDIA CTL_CODE(IOCTL_CDROM_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_LOAD_MEDIA CTL_CODE(IOCTL_CDROM_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_RESERVE CTL_CODE(IOCTL_CDROM_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_RELEASE CTL_CODE(IOCTL_CDROM_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CDROM_FIND_NEW_DEVICES CTL_CODE(IOCTL_CDROM_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// The following file contains the IOCTL_STORAGE class ioctl definitions +// + +#include + +// begin_winioctl + + +#define MINIMUM_CDROM_INQUIRY_SIZE 36 // RTL_SIZEOF_THROUGH_FIELD(INQUIRYDATA, ProductRevisionLevel) +#define MAXIMUM_CDROM_INQUIRY_SIZE 260 // MAXUCHAR + RTL_SIZEOF_THROUGH_FIELD(INQUIRYDATA, AdditionalLength) + +// +// The following device control code is for the SIMBAD simulated bad +// sector facility. See SIMBAD.H in this directory for related structures. +// + +#define IOCTL_CDROM_SIMBAD CTL_CODE(IOCTL_CDROM_BASE, 0x1003, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// Maximum CD Rom size +// + +#define MAXIMUM_NUMBER_TRACKS 100 +#define MAXIMUM_CDROM_SIZE 804 +#define MINIMUM_CDROM_READ_TOC_EX_SIZE 2 // two bytes min transferred + +// +// READ_TOC_EX structure +// +typedef struct _CDROM_READ_TOC_EX { + UCHAR Format : 4; + UCHAR Reserved1 : 3; // future expansion + UCHAR Msf : 1; + UCHAR SessionTrack; + UCHAR Reserved2; // future expansion + UCHAR Reserved3; // future expansion +} CDROM_READ_TOC_EX, *PCDROM_READ_TOC_EX; + +#define CDROM_READ_TOC_EX_FORMAT_TOC 0x00 +#define CDROM_READ_TOC_EX_FORMAT_SESSION 0x01 +#define CDROM_READ_TOC_EX_FORMAT_FULL_TOC 0x02 +#define CDROM_READ_TOC_EX_FORMAT_PMA 0x03 +#define CDROM_READ_TOC_EX_FORMAT_ATIP 0x04 +#define CDROM_READ_TOC_EX_FORMAT_CDTEXT 0x05 + +// +// CD ROM Table OF Contents (TOC) +// Format 0 - Get table of contents +// + +typedef struct _TRACK_DATA { + UCHAR Reserved; + UCHAR Control : 4; + UCHAR Adr : 4; + UCHAR TrackNumber; + UCHAR Reserved1; + UCHAR Address[4]; +} TRACK_DATA, *PTRACK_DATA; + +typedef struct _CDROM_TOC { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR FirstTrack; + UCHAR LastTrack; + + // + // Track data + // + + TRACK_DATA TrackData[MAXIMUM_NUMBER_TRACKS]; +} CDROM_TOC, *PCDROM_TOC; + +#define CDROM_TOC_SIZE sizeof(CDROM_TOC) + +// +// CD ROM Table OF Contents +// Format 1 - Session Information +// + +typedef struct _CDROM_TOC_SESSION_DATA { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR FirstCompleteSession; + UCHAR LastCompleteSession; + + // + // One track, representing the first track + // of the last finished session + // + + TRACK_DATA TrackData[1]; + +} CDROM_TOC_SESSION_DATA, *PCDROM_TOC_SESSION_DATA; + + +// +// CD ROM Table OF Contents +// Format 2 - Full TOC +// + +typedef struct _CDROM_TOC_FULL_TOC_DATA_BLOCK { + UCHAR SessionNumber; + UCHAR Control : 4; + UCHAR Adr : 4; + UCHAR Reserved1; + UCHAR Point; + UCHAR MsfExtra[3]; + UCHAR Zero; + UCHAR Msf[3]; +} CDROM_TOC_FULL_TOC_DATA_BLOCK, *PCDROM_TOC_FULL_TOC_DATA_BLOCK; + +typedef struct _CDROM_TOC_FULL_TOC_DATA { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR FirstCompleteSession; + UCHAR LastCompleteSession; + + // + // one to N descriptors included + // + +#if !defined(__midl) + CDROM_TOC_FULL_TOC_DATA_BLOCK Descriptors[0]; +#endif + +} CDROM_TOC_FULL_TOC_DATA, *PCDROM_TOC_FULL_TOC_DATA; + +// +// CD ROM Table OF Contents +// Format 3 - Program Memory Area +// +typedef struct _CDROM_TOC_PMA_DATA { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR Reserved1; + UCHAR Reserved2; + + // + // one to N descriptors included + // + +#if !defined(__midl) + CDROM_TOC_FULL_TOC_DATA_BLOCK Descriptors[0]; +#endif + +} CDROM_TOC_PMA_DATA, *PCDROM_TOC_PMA_DATA; + +// +// CD ROM Table OF Contents +// Format 4 - Absolute Time In Pregroove +// + +typedef struct _CDROM_TOC_ATIP_DATA_BLOCK { + + UCHAR CdrwReferenceSpeed : 3; + UCHAR Reserved3 : 1; + UCHAR WritePower : 3; + UCHAR True1 : 1; + UCHAR Reserved4 : 6; + UCHAR UnrestrictedUse : 1; + UCHAR Reserved5 : 1; + UCHAR A3Valid : 1; + UCHAR A2Valid : 1; + UCHAR A1Valid : 1; + UCHAR DiscSubType : 3; + UCHAR IsCdrw : 1; + UCHAR True2 : 1; + UCHAR Reserved7; + + UCHAR LeadInMsf[3]; + UCHAR Reserved8; + + UCHAR LeadOutMsf[3]; + UCHAR Reserved9; + + UCHAR A1Values[3]; + UCHAR Reserved10; + + UCHAR A2Values[3]; + UCHAR Reserved11; + + UCHAR A3Values[3]; + UCHAR Reserved12; + +} CDROM_TOC_ATIP_DATA_BLOCK, *PCDROM_TOC_ATIP_DATA_BLOCK; + +typedef struct _CDROM_TOC_ATIP_DATA { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR Reserved1; + UCHAR Reserved2; + + // + // zero? to N descriptors included. + // + +#if !defined(__midl) + CDROM_TOC_ATIP_DATA_BLOCK Descriptors[0]; +#endif + +} CDROM_TOC_ATIP_DATA, *PCDROM_TOC_ATIP_DATA; + +// +// CD ROM Table OF Contents +// Format 5 - CD Text Info +// +typedef struct _CDROM_TOC_CD_TEXT_DATA_BLOCK { + UCHAR PackType; + UCHAR TrackNumber : 7; + UCHAR ExtensionFlag : 1; // should be zero! + UCHAR SequenceNumber; + UCHAR CharacterPosition : 4; + UCHAR BlockNumber : 3; + UCHAR Unicode : 1; + union { + UCHAR Text[12]; + WCHAR WText[6]; + }; + UCHAR CRC[2]; +} CDROM_TOC_CD_TEXT_DATA_BLOCK, *PCDROM_TOC_CD_TEXT_DATA_BLOCK; + +typedef struct _CDROM_TOC_CD_TEXT_DATA { + + // + // Header + // + + UCHAR Length[2]; // add two bytes for this field + UCHAR Reserved1; + UCHAR Reserved2; + + // + // the text info comes in discrete blocks of + // a heavily-overloaded structure + // + +#if !defined(__midl) + CDROM_TOC_CD_TEXT_DATA_BLOCK Descriptors[0]; +#endif + +} CDROM_TOC_CD_TEXT_DATA, *PCDROM_TOC_CD_TEXT_DATA; + +// +// These are the types used for PackType field in CDROM_TOC_CD_TEXT_DATA_BLOCK +// and also for requesting specific info from IOCTL_CDROM_READ_CD_TEXT +// +#define CDROM_CD_TEXT_PACK_ALBUM_NAME 0x80 +#define CDROM_CD_TEXT_PACK_PERFORMER 0x81 +#define CDROM_CD_TEXT_PACK_SONGWRITER 0x82 +#define CDROM_CD_TEXT_PACK_COMPOSER 0x83 +#define CDROM_CD_TEXT_PACK_ARRANGER 0x84 +#define CDROM_CD_TEXT_PACK_MESSAGES 0x85 +#define CDROM_CD_TEXT_PACK_DISC_ID 0x86 +#define CDROM_CD_TEXT_PACK_GENRE 0x87 +#define CDROM_CD_TEXT_PACK_TOC_INFO 0x88 +#define CDROM_CD_TEXT_PACK_TOC_INFO2 0x89 +// 0x8a - 0x8d are reserved.... +#define CDROM_CD_TEXT_PACK_UPC_EAN 0x8e +#define CDROM_CD_TEXT_PACK_SIZE_INFO 0x8f + +// +// Play audio starting at MSF and ending at MSF +// + +typedef struct _CDROM_PLAY_AUDIO_MSF { + UCHAR StartingM; + UCHAR StartingS; + UCHAR StartingF; + UCHAR EndingM; + UCHAR EndingS; + UCHAR EndingF; +} CDROM_PLAY_AUDIO_MSF, *PCDROM_PLAY_AUDIO_MSF; + +// +// Seek to MSF +// + +typedef struct _CDROM_SEEK_AUDIO_MSF { + UCHAR M; + UCHAR S; + UCHAR F; +} CDROM_SEEK_AUDIO_MSF, *PCDROM_SEEK_AUDIO_MSF; + + +// +// Flags for the disk type +// + +typedef struct _CDROM_DISK_DATA { + + ULONG DiskData; + +} CDROM_DISK_DATA, *PCDROM_DISK_DATA; + +#define CDROM_DISK_AUDIO_TRACK (0x00000001) +#define CDROM_DISK_DATA_TRACK (0x00000002) + +// +// CD ROM Data Mode Codes, used with IOCTL_CDROM_READ_Q_CHANNEL +// + +#define IOCTL_CDROM_SUB_Q_CHANNEL 0x00 +#define IOCTL_CDROM_CURRENT_POSITION 0x01 +#define IOCTL_CDROM_MEDIA_CATALOG 0x02 +#define IOCTL_CDROM_TRACK_ISRC 0x03 + +typedef struct _CDROM_SUB_Q_DATA_FORMAT { + UCHAR Format; + UCHAR Track; +} CDROM_SUB_Q_DATA_FORMAT, *PCDROM_SUB_Q_DATA_FORMAT; + + +// +// CD ROM Sub-Q Channel Data Format +// + +typedef struct _SUB_Q_HEADER { + UCHAR Reserved; + UCHAR AudioStatus; + UCHAR DataLength[2]; +} SUB_Q_HEADER, *PSUB_Q_HEADER; + +typedef struct _SUB_Q_CURRENT_POSITION { + SUB_Q_HEADER Header; + UCHAR FormatCode; + UCHAR Control : 4; + UCHAR ADR : 4; + UCHAR TrackNumber; + UCHAR IndexNumber; + UCHAR AbsoluteAddress[4]; + UCHAR TrackRelativeAddress[4]; +} SUB_Q_CURRENT_POSITION, *PSUB_Q_CURRENT_POSITION; + +typedef struct _SUB_Q_MEDIA_CATALOG_NUMBER { + SUB_Q_HEADER Header; + UCHAR FormatCode; + UCHAR Reserved[3]; + UCHAR Reserved1 : 7; + UCHAR Mcval : 1; + UCHAR MediaCatalog[15]; +} SUB_Q_MEDIA_CATALOG_NUMBER, *PSUB_Q_MEDIA_CATALOG_NUMBER; + +typedef struct _SUB_Q_TRACK_ISRC { + SUB_Q_HEADER Header; + UCHAR FormatCode; + UCHAR Reserved0; + UCHAR Track; + UCHAR Reserved1; + UCHAR Reserved2 : 7; + UCHAR Tcval : 1; + UCHAR TrackIsrc[15]; +} SUB_Q_TRACK_ISRC, *PSUB_Q_TRACK_ISRC; + +typedef union _SUB_Q_CHANNEL_DATA { + SUB_Q_CURRENT_POSITION CurrentPosition; + SUB_Q_MEDIA_CATALOG_NUMBER MediaCatalog; + SUB_Q_TRACK_ISRC TrackIsrc; +} SUB_Q_CHANNEL_DATA, *PSUB_Q_CHANNEL_DATA; + +// +// Audio Status Codes +// + +#define AUDIO_STATUS_NOT_SUPPORTED 0x00 +#define AUDIO_STATUS_IN_PROGRESS 0x11 +#define AUDIO_STATUS_PAUSED 0x12 +#define AUDIO_STATUS_PLAY_COMPLETE 0x13 +#define AUDIO_STATUS_PLAY_ERROR 0x14 +#define AUDIO_STATUS_NO_STATUS 0x15 + +// +// ADR Sub-channel Q Field +// + +#define ADR_NO_MODE_INFORMATION 0x0 +#define ADR_ENCODES_CURRENT_POSITION 0x1 +#define ADR_ENCODES_MEDIA_CATALOG 0x2 +#define ADR_ENCODES_ISRC 0x3 + +// +// Sub-channel Q Control Bits +// + +#define AUDIO_WITH_PREEMPHASIS 0x1 +#define DIGITAL_COPY_PERMITTED 0x2 +#define AUDIO_DATA_TRACK 0x4 +#define TWO_FOUR_CHANNEL_AUDIO 0x8 + +#if (NTDDI_VERSION < NTDDI_WS03) +typedef struct _CDROM_AUDIO_CONTROL { + UCHAR LbaFormat; + USHORT LogicalBlocksPerSecond; +} CDROM_AUDIO_CONTROL, *PCDROM_AUDIO_CONTROL; +#else +#if PRAGMA_DEPRECATED_DDK +#define _CDROM_AUDIO_CONTROL _this_is_obsoleted__CDROM_AUDIO_CONTROL +#define CDROM_AUDIO_CONTROL _this_is_obsoleted_CDROM_AUDIO_CONTROL +#define PCDROM_AUDIO_CONTROL _this_is_obsoleted_PCDROM_AUDIO_CONTROL +#endif // PRAGMA_DEPRECATED_DDK +#endif + +// +// Volume control - Volume takes a value between 1 and 0xFF. +// SCSI-II CDROM audio suppports up to 4 audio ports with +// Independent volume control. +// + +typedef struct _VOLUME_CONTROL { + UCHAR PortVolume[4]; +} VOLUME_CONTROL, *PVOLUME_CONTROL; + +typedef enum _TRACK_MODE_TYPE { + YellowMode2, + XAForm2, + CDDA, + RawWithC2AndSubCode, // CD_RAW_SECTOR_WITH_C2_AND_SUBCODE_SIZE per sector + RawWithC2, // CD_RAW_SECTOR_WITH_C2_SIZE per sector + RawWithSubCode // CD_RAW_SECTOR_WITH_SUBCODE_SIZE per sector +} TRACK_MODE_TYPE, *PTRACK_MODE_TYPE; + +#define CD_RAW_READ_C2_SIZE ( 296 ) +#define CD_RAW_READ_SUBCODE_SIZE ( 96) +#define CD_RAW_SECTOR_WITH_C2_SIZE (2352+296 ) +#define CD_RAW_SECTOR_WITH_SUBCODE_SIZE (2352 +96) +#define CD_RAW_SECTOR_WITH_C2_AND_SUBCODE_SIZE (2352+296+96) + +// +// Passed to cdrom to describe the raw read, ie. Mode 2, Form 2, CDDA... +// + +typedef struct __RAW_READ_INFO { + LARGE_INTEGER DiskOffset; + ULONG SectorCount; + TRACK_MODE_TYPE TrackMode; +} RAW_READ_INFO, *PRAW_READ_INFO; + +typedef enum _MEDIA_BLANK_TYPE { + MediaBlankTypeFull = 0, // mandatory support + MediaBlankTypeMinimal = 1, // mandatory support + MediaBlankTypeIncompleteTrack = 2, // optional support + MediaBlankTypeUnreserveLastTrack = 3, // optional support, hairy + MediaBlankTypeTrackTail = 4, // mandatory support + MediaBlankTypeUncloseLastSession = 5, // optional support + MediaBlankTypeEraseLastSession = 6, // optional support + // MediaBlankType7 is reserved +} MEDIA_BLANK_TYPE, *PMEDIA_BLANK_TYPE; + +// +// IOCTL_CDROM_EXCLUSIVE_ACCESS can be used to get exclusive +// access to the CDROM device. +// + +#define CDROM_EXCLUSIVE_CALLER_LENGTH 64 + +// +// Input values (Flags) for ExclusiveAccessLockDevice +// +// CDROM_LOCK_IGNORE_VOLUME: +// Set it to lock the device even if the file system is mounted. +// WARNING: setting this may cause data corruption! +// +// CDROM_NO_MEDIA_NOTIFICATIONS: +// Set it to prevent sending of a media removal notification +// on exclusive access lock and a media arrival notification +// on unlock. +// + +#define CDROM_LOCK_IGNORE_VOLUME (1 << 0) +#define CDROM_NO_MEDIA_NOTIFICATIONS (1 << 1) + +// +// Output values (Flags) for ExclusiveAccessQueryState +// + +#define CDROM_NOT_IN_EXCLUSIVE_MODE 0 +#define CDROM_IN_EXCLUSIVE_MODE 1 + + +typedef enum _EXCLUSIVE_ACCESS_REQUEST_TYPE { + ExclusiveAccessQueryState, + ExclusiveAccessLockDevice, + ExclusiveAccessUnlockDevice +} EXCLUSIVE_ACCESS_REQUEST_TYPE, *PEXCLUSIVE_ACCESS_REQUEST_TYPE; + + +typedef struct _CDROM_EXCLUSIVE_ACCESS { + + // + // Request type + // + EXCLUSIVE_ACCESS_REQUEST_TYPE RequestType; + + // + // Additional parameters for each request type + // + ULONG Flags; + +} CDROM_EXCLUSIVE_ACCESS, *PCDROM_EXCLUSIVE_ACCESS; + + +typedef struct _CDROM_EXCLUSIVE_LOCK { + + CDROM_EXCLUSIVE_ACCESS Access; + + // + // Caller name string + // + UCHAR CallerName[CDROM_EXCLUSIVE_CALLER_LENGTH]; + +} CDROM_EXCLUSIVE_LOCK, *PCDROM_EXCLUSIVE_LOCK; + + +typedef struct _CDROM_EXCLUSIVE_LOCK_STATE { + + BOOLEAN LockState; + + // + // Caller name string + // + UCHAR CallerName[CDROM_EXCLUSIVE_CALLER_LENGTH]; + +} CDROM_EXCLUSIVE_LOCK_STATE, *PCDROM_EXCLUSIVE_LOCK_STATE; + +// +// Structure definitions for IOCTL_CDROM_SET_SPEED +// + +typedef enum _CDROM_SPEED_REQUEST { + CdromSetSpeed, + CdromSetStreaming +} CDROM_SPEED_REQUEST, *PCDROM_SPEED_REQUEST; + +typedef enum _WRITE_ROTATION { + CdromDefaultRotation, + CdromCAVRotation +} WRITE_ROTATION, *PWRITE_ROTATION; + +typedef struct _CDROM_SET_SPEED { + + // + // Request type for setting speed + // + CDROM_SPEED_REQUEST RequestType; + + // + // Drive read speed in KB/sec. + // + USHORT ReadSpeed; + + // + // Drive write speed in KB/sec. + // + USHORT WriteSpeed; + + // + // Drive rotation control for write + // + WRITE_ROTATION RotationControl; + +} CDROM_SET_SPEED, *PCDROM_SET_SPEED; + +typedef struct _CDROM_SET_STREAMING { + + // + // Request type for setting speed + // + CDROM_SPEED_REQUEST RequestType; + + // + // Drive read size in KB per ReadTime + // + ULONG ReadSize; + + // + // Read time in milliseconds + // + ULONG ReadTime; + + // + // Drive write size in KB per WriteTime + // + ULONG WriteSize; + + // + // Write time in milliseconds + // + ULONG WriteTime; + + // + // First Logical Block Address of the request + // + ULONG StartLba; + + // + // Last Logical Block Address of the request + // + ULONG EndLba; + + // + // Drive rotation control for write + // + WRITE_ROTATION RotationControl; + + // + // Restore drive defaults + // + BOOLEAN RestoreDefaults; + + // + // Set drive to exact value given + // + BOOLEAN SetExact; + + // + // Optimize performance for random changes + // + BOOLEAN RandomAccess; + + // + // Restore default speed on media change + // + BOOLEAN Persistent; + +} CDROM_SET_STREAMING, *PCDROM_SET_STREAMING; + + +// +// Structure definitions for IOCTL_CDROM_ENABLE_STREAMING +// + +typedef enum _STREAMING_CONTROL_REQUEST_TYPE { + CdromStreamingDisable = 1, + CdromStreamingEnableForReadOnly = 2, + CdromStreamingEnableForWriteOnly = 3, + CdromStreamingEnableForReadWrite = 4 +} STREAMING_CONTROL_REQUEST_TYPE, *PSTREAMING_CONTROL_REQUEST_TYPE; + +typedef struct _CDROM_STREAMING_CONTROL { + + // + // Request type + // + STREAMING_CONTROL_REQUEST_TYPE RequestType; + +} CDROM_STREAMING_CONTROL, *PCDROM_STREAMING_CONTROL; + + +// +// Structure definitions for IOCTL_CDROM_SEND_OPC_INFORMATION +// + +typedef enum _CDROM_OPC_INFO_TYPE { + SimpleOpcInfo = 1 +} CDROM_OPC_INFO_TYPE, *PCDROM_OPC_INFO_TYPE; + +typedef struct _CDROM_SIMPLE_OPC_INFO { + + // + // Request type (must be SimpleOpcInfo) + // + CDROM_OPC_INFO_TYPE RequestType; + + // + // Exclude Layer 0 from OPC + // + BOOLEAN Exclude0; + + // + // Exclude Layer 1 from OPC + // + BOOLEAN Exclude1; + +} CDROM_SIMPLE_OPC_INFO, *PCDROM_SIMPLE_OPC_INFO; + + +// +// Structure definitions for IOCTL_CDROM_GET_PERFORMANCE +// + +typedef enum _CDROM_PERFORMANCE_REQUEST_TYPE { + CdromPerformanceRequest = 1, + CdromWriteSpeedRequest = 2 +} CDROM_PERFORMANCE_REQUEST_TYPE, *PCDROM_PERFORMANCE_REQUEST_TYPE; + +typedef enum _CDROM_PERFORMANCE_TYPE { + CdromReadPerformance = 1, + CdromWritePerformance = 2 +} CDROM_PERFORMANCE_TYPE, *PCDROM_PERFORMANCE_TYPE; + +typedef enum _CDROM_PERFORMANCE_EXCEPTION_TYPE { + CdromNominalPerformance = 1, + CdromEntirePerformanceList = 2, + CdromPerformanceExceptionsOnly = 3 +} CDROM_PERFORMANCE_EXCEPTION_TYPE, *PCDROM_PERFORMANCE_EXCEPTION_TYPE; + +typedef enum _CDROM_PERFORMANCE_TOLERANCE_TYPE { + Cdrom10Nominal20Exceptions = 1 +} CDROM_PERFORMANCE_TOLERANCE_TYPE, *PCDROM_PERFORMANCE_TOLERANCE_TYPE; + +typedef struct _CDROM_PERFORMANCE_REQUEST { + + // + // Request type (must be CdromPerformanceRequest) + // + CDROM_PERFORMANCE_REQUEST_TYPE RequestType; + + // + // Performance type + // + CDROM_PERFORMANCE_TYPE PerformanceType; + + // + // Exceptions to be covered + // + CDROM_PERFORMANCE_EXCEPTION_TYPE Exceptions; + + // + // Tolerance to be ensured + // + CDROM_PERFORMANCE_TOLERANCE_TYPE Tolerance; + + // + // Starting LBA for entire performance list + // + ULONG StaringLba; + +} CDROM_PERFORMANCE_REQUEST, *PCDROM_PERFORMANCE_REQUEST; + +typedef struct _CDROM_WRITE_SPEED_REQUEST { + + // + // Request type (must be CdromWriteSpeedRequest) + // + CDROM_PERFORMANCE_REQUEST_TYPE RequestType; + +} CDROM_WRITE_SPEED_REQUEST, *PCDROM_WRITE_SPEED_REQUEST; + +// Header for data returned by IOCTL_CDROM_GET_PERFORMANCE +typedef struct _CDROM_PERFORMANCE_HEADER { + + // + // Size of available data (vs returned data), not including this field + // + UCHAR DataLength[4]; + + UCHAR Except : 1; + UCHAR Write : 1; + UCHAR Reserved1 : 6; + UCHAR Reserved2[3]; + + // + // Contains a list of the following records (depending on the request): + // CDROM_NOMINAL_PERFORMANCE_DESCRIPTOR, + // CDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR, + // CDROM_WRITE_SPEED_DESCRIPTOR + // + UCHAR Data[0]; + +} CDROM_PERFORMANCE_HEADER, *PCDROM_PERFORMANCE_HEADER; + +typedef struct _CDROM_NOMINAL_PERFORMANCE_DESCRIPTOR { + UCHAR StartLba[4]; + UCHAR StartPerformance[4]; + UCHAR EndLba[4]; + UCHAR EndPerformance[4]; +} CDROM_NOMINAL_PERFORMANCE_DESCRIPTOR, *PCDROM_NOMINAL_PERFORMANCE_DESCRIPTOR; + +typedef struct _CDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR { + UCHAR Lba[4]; + UCHAR Time[2]; +} CDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR, *PCDROM_EXCEPTION_PERFORMANCE_DESCRIPTOR; + +typedef struct _CDROM_WRITE_SPEED_DESCRIPTOR { + UCHAR MixedReadWrite : 1; + UCHAR Exact : 1; + UCHAR Reserved1 : 1; + UCHAR WriteRotationControl : 2; + UCHAR Reserved2 : 3; + UCHAR Reserved3[3]; + UCHAR EndLba[4]; + UCHAR ReadSpeed[4]; + UCHAR WriteSpeed[4]; +} CDROM_WRITE_SPEED_DESCRIPTOR, *PCDROM_WRITE_SPEED_DESCRIPTOR; + + +#ifdef __cplusplus +} +#endif + + +#if _MSC_VER >= 1200 +#pragma warning(pop) // un-sets any local warning changes +#else +#pragma warning(default:4200) // array[0] is not a warning for this file +#pragma warning(default:4201) // nameless struct/unions +#pragma warning(default:4214) // bit fields other than int +#endif + + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDCDRM_ + +// end_winioctl + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdvd.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdvd.h new file mode 100644 index 0000000000000000000000000000000000000000..ea0bf95020a332e7261db22216e93d12b87345cf --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddcdvd.h @@ -0,0 +1,799 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddcdvd.h + +Abstract: + + This module contains structures and definitions + associated with DVD ioctls. + + This module is used in conjunction with ntddcdrm.h which contains the + cdrom specific ioctls which will work on CDVD drives + + +--*/ + +// begin_winioctl + +#ifndef _NTDDCDVD_ +#define _NTDDCDVD_ +#pragma warning(push) +#pragma warning(disable:4200) // zero-sized array +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union +#pragma warning(disable:4214) // bitfield other than int + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_DVD_BASE FILE_DEVICE_DVD + +// +// CDVD Device Control Functions +// +// Warning: Ioctls from 200 through 300 are used for the old common class +// driver ioctls and should not be used for device specific functionality +// + +// +// CSS-related IOCTLs +// + +#define IOCTL_DVD_START_SESSION CTL_CODE(IOCTL_DVD_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_READ_KEY CTL_CODE(IOCTL_DVD_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_SEND_KEY CTL_CODE(IOCTL_DVD_BASE, 0x0402, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_END_SESSION CTL_CODE(IOCTL_DVD_BASE, 0x0403, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_SET_READ_AHEAD CTL_CODE(IOCTL_DVD_BASE, 0x0404, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_GET_REGION CTL_CODE(IOCTL_DVD_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DVD_SEND_KEY2 CTL_CODE(IOCTL_DVD_BASE, 0x0406, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// AACS-related IOCTLs +// +#define IOCTL_AACS_READ_MEDIA_KEY_BLOCK_SIZE CTL_CODE(IOCTL_DVD_BASE, 0x430, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_READ_MEDIA_KEY_BLOCK CTL_CODE(IOCTL_DVD_BASE, 0x431, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_START_SESSION CTL_CODE(IOCTL_DVD_BASE, 0x432, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_END_SESSION CTL_CODE(IOCTL_DVD_BASE, 0x433, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_SEND_CERTIFICATE CTL_CODE(IOCTL_DVD_BASE, 0x434, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_GET_CERTIFICATE CTL_CODE(IOCTL_DVD_BASE, 0x435, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_GET_CHALLENGE_KEY CTL_CODE(IOCTL_DVD_BASE, 0x436, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_SEND_CHALLENGE_KEY CTL_CODE(IOCTL_DVD_BASE, 0x437, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_READ_VOLUME_ID CTL_CODE(IOCTL_DVD_BASE, 0x438, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_READ_SERIAL_NUMBER CTL_CODE(IOCTL_DVD_BASE, 0x439, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_READ_MEDIA_ID CTL_CODE(IOCTL_DVD_BASE, 0x43A, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_READ_BINDING_NONCE CTL_CODE(IOCTL_DVD_BASE, 0x43B, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_AACS_GENERATE_BINDING_NONCE CTL_CODE(IOCTL_DVD_BASE, 0x43C, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// DVD Structure queries +// + +#define IOCTL_DVD_READ_STRUCTURE CTL_CODE(IOCTL_DVD_BASE, 0x0450, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// The following file contains the IOCTL_STORAGE class ioctl definitions +// + +#define IOCTL_STORAGE_SET_READ_AHEAD CTL_CODE(IOCTL_STORAGE_BASE, 0x0100, METHOD_BUFFERED, FILE_READ_ACCESS) + +// end_winioctl + +#include + +// begin_winioctl + + +#ifdef __cplusplus +extern "C" { +#endif + + +typedef enum { + DvdChallengeKey = 0x01, + DvdBusKey1, + DvdBusKey2, + DvdTitleKey, + DvdAsf, + DvdSetRpcKey = 0x6, + DvdGetRpcKey = 0x8, + DvdDiskKey = 0x80, + DvdInvalidateAGID = 0x3f +} DVD_KEY_TYPE; + +typedef _At_((LONG)_Curr_, _Field_range_(-1,3)) ULONG DVD_SESSION_ID, *PDVD_SESSION_ID; + +#include +typedef struct _DVD_COPY_PROTECT_KEY { + ULONG KeyLength; + DVD_SESSION_ID SessionId; + DVD_KEY_TYPE KeyType; + ULONG KeyFlags; + union { + HANDLE FileHandle; + LARGE_INTEGER TitleOffset; + } Parameters; + UCHAR KeyData[0]; +} DVD_COPY_PROTECT_KEY, *PDVD_COPY_PROTECT_KEY; +#include + +// +// Predefined (Mt. Fuji) key sizes +// Add sizeof(DVD_COPY_PROTECT_KEY) to get allocation size for +// the full key structure +// + +#define DVD_CHALLENGE_KEY_LENGTH (12 + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_BUS_KEY_LENGTH (8 + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_TITLE_KEY_LENGTH (8 + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_DISK_KEY_LENGTH (2048 + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_RPC_KEY_LENGTH (sizeof(DVD_RPC_KEY) + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_SET_RPC_KEY_LENGTH (sizeof(DVD_SET_RPC_KEY) + sizeof(DVD_COPY_PROTECT_KEY)) +#define DVD_ASF_LENGTH (sizeof(DVD_ASF) + sizeof(DVD_COPY_PROTECT_KEY)) + +// +// Used with IOCTL_DVD_END_SESSION to end all DVD sessions at once +// + +#define DVD_END_ALL_SESSIONS ((DVD_SESSION_ID) 0xffffffff) + +// +// CGMS Copy Protection Flags +// + +#define DVD_CGMS_RESERVED_MASK 0x00000078 + +#define DVD_CGMS_COPY_PROTECT_MASK 0x00000018 +#define DVD_CGMS_COPY_PERMITTED 0x00000000 +#define DVD_CGMS_COPY_ONCE 0x00000010 +#define DVD_CGMS_NO_COPY 0x00000018 + +#define DVD_COPYRIGHT_MASK 0x00000040 +#define DVD_NOT_COPYRIGHTED 0x00000000 +#define DVD_COPYRIGHTED 0x00000040 + +#define DVD_SECTOR_PROTECT_MASK 0x00000020 +#define DVD_SECTOR_NOT_PROTECTED 0x00000000 +#define DVD_SECTOR_PROTECTED 0x00000020 + +/*++ + +IOCTL_STORAGE_SET_READ_AHEAD + +Requests that the storage device skip to TargetAddress once it has run across +TriggerAddress during the course of it's read-ahead caching operations. + +Input: + + a STORAGE_SET_READ_AHEAD structure which contains: + * the trigger address + * the target address + +Output: + + none + +--*/ + +#include +typedef struct _STORAGE_SET_READ_AHEAD { + LARGE_INTEGER TriggerAddress; + LARGE_INTEGER TargetAddress; +} STORAGE_SET_READ_AHEAD, *PSTORAGE_SET_READ_AHEAD; +#include + +/*++ + +IOCTL_DVD_READ_STRUCTURE + +Issues a READ_DVD_STRUCTURE command to the drive. + +Input: + + a DVD_READ_STRUCTURE describing what information is requested + +Output: + + a DVD Layer Descriptor as defined below + +--*/ + +typedef enum DVD_STRUCTURE_FORMAT { + DvdPhysicalDescriptor, // 0x00 + DvdCopyrightDescriptor, // 0x01 + DvdDiskKeyDescriptor, // 0x02 + DvdBCADescriptor, // 0x03 + DvdManufacturerDescriptor, // 0x04 + DvdMaxDescriptor // 0x05 +} DVD_STRUCTURE_FORMAT, *PDVD_STRUCTURE_FORMAT; + +///////////////////////////////////////////////////////////// +// ALL THE FOLLOWING STRUCTURES ARE BYTE-PACKED: +#include + +typedef struct DVD_READ_STRUCTURE { + LARGE_INTEGER BlockByteOffset; + DVD_STRUCTURE_FORMAT Format; + DVD_SESSION_ID SessionId; + UCHAR LayerNumber; +} DVD_READ_STRUCTURE, *PDVD_READ_STRUCTURE; + +typedef struct _DVD_DESCRIPTOR_HEADER { + USHORT Length; + UCHAR Reserved[2]; +#if !defined(__midl) + UCHAR Data[0]; +#endif +} DVD_DESCRIPTOR_HEADER, *PDVD_DESCRIPTOR_HEADER; +C_ASSERT(sizeof(DVD_DESCRIPTOR_HEADER) == 4); + +// format 0x00 - DvdPhysicalDescriptor +typedef struct _DVD_LAYER_DESCRIPTOR { + UCHAR BookVersion : 4; // in MMC 5 : Part Version + UCHAR BookType : 4; // Disk Category + UCHAR MinimumRate : 4; // Maximum Rate + UCHAR DiskSize : 4; + UCHAR LayerType : 4; + UCHAR TrackPath : 1; + UCHAR NumberOfLayers : 2; + UCHAR Reserved1 : 1; + UCHAR TrackDensity : 4; + UCHAR LinearDensity : 4; + ULONG StartingDataSector; // 3bytes + 1 zeroed byte + ULONG EndDataSector; // 3bytes + 1 zeroed byte + ULONG EndLayerZeroSector; // 3bytes + 1 zeroed byte + UCHAR Reserved5 : 7; + UCHAR BCAFlag : 1; + // The large Media Specific field is not declared here to enable stack allocation +} DVD_LAYER_DESCRIPTOR, *PDVD_LAYER_DESCRIPTOR; +C_ASSERT(sizeof(DVD_LAYER_DESCRIPTOR) == 17); +typedef struct _DVD_FULL_LAYER_DESCRIPTOR { + DVD_LAYER_DESCRIPTOR commonHeader; + UCHAR MediaSpecific[2031]; +} DVD_FULL_LAYER_DESCRIPTOR, *PDVD_FULL_LAYER_DESCRIPTOR; +C_ASSERT(sizeof(DVD_FULL_LAYER_DESCRIPTOR) == 2048); + +// format 0x01 - DvdCopyrightDescriptor +typedef struct _DVD_COPYRIGHT_DESCRIPTOR { + UCHAR CopyrightProtectionType; + UCHAR RegionManagementInformation; + USHORT Reserved; +} DVD_COPYRIGHT_DESCRIPTOR, *PDVD_COPYRIGHT_DESCRIPTOR; +C_ASSERT(sizeof(DVD_COPYRIGHT_DESCRIPTOR) == 4); + +// format 0x02 - DvdDiskKeyDescriptor +typedef struct _DVD_DISK_KEY_DESCRIPTOR { + UCHAR DiskKeyData[2048]; +} DVD_DISK_KEY_DESCRIPTOR, *PDVD_DISK_KEY_DESCRIPTOR; +C_ASSERT(sizeof(DVD_DISK_KEY_DESCRIPTOR) == 2048); + +// format 0x03 - DvdBCADescriptor +typedef struct _DVD_BCA_DESCRIPTOR { + UCHAR BCAInformation[0]; +} DVD_BCA_DESCRIPTOR, *PDVD_BCA_DESCRIPTOR; + +// format 0x04 - DvdManufacturerDescriptor +typedef struct _DVD_MANUFACTURER_DESCRIPTOR { + UCHAR ManufacturingInformation[2048]; +} DVD_MANUFACTURER_DESCRIPTOR, *PDVD_MANUFACTURER_DESCRIPTOR; +C_ASSERT(sizeof(DVD_MANUFACTURER_DESCRIPTOR) == 2048); + +// format 0x05 - not defined in enum +typedef struct _DVD_COPYRIGHT_MANAGEMENT_DESCRIPTOR { + union { + struct { + UCHAR CopyProtectionMode : 4; + UCHAR ContentGenerationManagementSystem : 2; + UCHAR CopyProtectedSector : 1; + UCHAR CopyProtectedMaterial : 1; + } Dvdrom; + struct { + UCHAR Reserved0001 : 4; + UCHAR ContentGenerationManagementSystem : 2; + UCHAR Reserved0002 : 1; + UCHAR CopyProtectedMaterial : 1; + } DvdRecordable_Version1; + struct { + UCHAR Reserved0003; + } Dvdram; + struct { + UCHAR Reserved0004 : 2; + UCHAR ADP_TY : 2; // what is this mean? + UCHAR Reserved0005 : 4; + } DvdRecordable; + UCHAR CPR_MAI; + }; + UCHAR Reserved0[3]; +} DVD_COPYRIGHT_MANAGEMENT_DESCRIPTOR, *PDVD_COPYRIGHT_MANAGEMENT_DESCRIPTOR; +C_ASSERT(FIELD_OFFSET(DVD_COPYRIGHT_MANAGEMENT_DESCRIPTOR, Reserved0) == 1); +C_ASSERT(sizeof(DVD_COPYRIGHT_MANAGEMENT_DESCRIPTOR) == 4); + +// format 0x06 (media ID) is unstructured in public spec +// format 0x07 (media key block) is unstructured in public spec +// format 0x08 (DVD-RAM DDS) is unstructured in public spec + +// format 0x09 - not defined in enum +// This is valid for DVD-RAM and also HD DVD-RAM +typedef struct _DVD_RAM_MEDIUM_STATUS { + UCHAR Reserved0 : 1; + UCHAR PersistentWriteProtect : 1; + UCHAR CartridgeWriteProtect : 1; + UCHAR MediaSpecificWriteInhibit : 1; + UCHAR Reserved1 : 2; + UCHAR CartridgeNotSealed : 1; + UCHAR MediaInCartridge : 1; + UCHAR DiscTypeIdentification; + UCHAR Reserved2; + UCHAR MediaSpecificWriteInhibitInformation; +} DVD_RAM_MEDIUM_STATUS, *PDVD_RAM_MEDIUM_STATUS; +C_ASSERT(sizeof(DVD_RAM_MEDIUM_STATUS) == 4); + +// format 0x0A - not defined in enum +typedef struct _DVD_RAM_SPARE_AREA_INFORMATION { + UCHAR FreePrimarySpareSectors[4]; + UCHAR FreeSupplementalSpareSectors[4]; + UCHAR AllocatedSupplementalSpareSectors[4]; +} DVD_RAM_SPARE_AREA_INFORMATION, *PDVD_RAM_SPARE_AREA_INFORMATION; +C_ASSERT(sizeof(DVD_RAM_SPARE_AREA_INFORMATION) == 12); + +// format 0x0B - not defined in enum +typedef struct _DVD_RAM_RECORDING_TYPE { + UCHAR Reserved0 : 4; + UCHAR RealTimeData : 1; + UCHAR Reserved1 : 3; + UCHAR Reserved2[3]; +} DVD_RAM_RECORDING_TYPE, *PDVD_RAM_RECORDING_TYPE; +C_ASSERT(sizeof(DVD_RAM_RECORDING_TYPE) == 4); + +// format 0x0C (RMD in last border-out) is unstructured in public spec +// format 0x0D - not defined in enum +typedef struct _DVD_RECORDING_MANAGEMENT_AREA_DATA { + UCHAR LastRecordedRMASectorNumber[4]; +#if !defined(__midl) + UCHAR RMDBytes[0]; +#endif +} DVD_RECORDING_MANAGEMENT_AREA_DATA, *PDVD_RECORDING_MANAGEMENT_AREA_DATA; +C_ASSERT(sizeof(DVD_RECORDING_MANAGEMENT_AREA_DATA) == 4); + +// format 0x0E - not define in enum +typedef struct _DVD_PRERECORDED_INFORMATION { + UCHAR FieldID_1; + UCHAR DiscApplicationCode; + UCHAR DiscPhysicalCode; + UCHAR LastAddressOfDataRecordableArea[3]; + UCHAR ExtensionCode : 4; // -R for general/authoring v2.0 + UCHAR PartVers1on : 4; // -R for general/authoring v2.0 + UCHAR Reserved0; + UCHAR FieldID_2; + UCHAR OpcSuggestedCode; + UCHAR WavelengthCode; + UCHAR WriteStrategyCode[4]; + UCHAR Reserved2; + UCHAR FieldID_3; + UCHAR ManufacturerId_3[6]; + UCHAR Reserved3; + UCHAR FieldID_4; + UCHAR ManufacturerId_4[6]; + UCHAR Reserved4; + UCHAR FieldID_5; + UCHAR ManufacturerId_5[6]; + UCHAR Reserved5; + UCHAR Reserved99[24]; +} DVD_PRERECORDED_INFORMATION, *PDVD_PRERECORDED_INFORMATION; +C_ASSERT(FIELD_OFFSET(DVD_PRERECORDED_INFORMATION, FieldID_2) == 8); +C_ASSERT(FIELD_OFFSET(DVD_PRERECORDED_INFORMATION, FieldID_3) == 16); +C_ASSERT(FIELD_OFFSET(DVD_PRERECORDED_INFORMATION, FieldID_4) == 24); +C_ASSERT(FIELD_OFFSET(DVD_PRERECORDED_INFORMATION, FieldID_5) == 32); +C_ASSERT(sizeof(DVD_PRERECORDED_INFORMATION) == 64); + +// format 0x0F - not defined in enum +typedef struct _DVD_UNIQUE_DISC_IDENTIFIER { + UCHAR Reserved0[2]; + UCHAR RandomNumber[2]; + UCHAR Year[4]; // ASCII? + UCHAR Month[2]; // ASCII? + UCHAR Day[2]; // ASCII? + UCHAR Hour[2]; // ASCII? + UCHAR Minute[2]; // ASCII? + UCHAR Second[2]; // ASCII? +} DVD_UNIQUE_DISC_IDENTIFIER, *PDVD_UNIQUE_DISC_IDENTIFIER; +C_ASSERT(sizeof(DVD_UNIQUE_DISC_IDENTIFIER) == 18); + +// format 0x10 - not define in enum - use DVD_LAYER_DESCRIPTOR structure above +// format 0x11 (ADIP information) is unstructured in public spec +// formats 0x12, 0x15 are is unstructured in public spec +// formats 0x13, 0x14, 0x16 through 0x18 are not yet defined + +// format 0x19 - not defined in enum +typedef struct _HD_DVD_R_MEDIUM_STATUS { + UCHAR ExtendedTestZone : 1; + UCHAR Reserved1 : 7; + UCHAR NumberOfRemainingRMDsInRDZ; + UCHAR NumberOfRemainingRMDsInCurrentRMZ[2]; +} HD_DVD_R_MEDIUM_STATUS, *PHD_DVD_R_MEDIUM_STATUS; +C_ASSERT(sizeof(HD_DVD_R_MEDIUM_STATUS) == 4); + +// format 0x1A (HD DVD-R - Last recorded RMD in the latest R) is unstructured in public spec +// formats 0x1B through 0x1F are not yet defined + +// format 0x20 - not define in enum +typedef struct _DVD_DUAL_LAYER_RECORDING_INFORMATION { + UCHAR Reserved0 : 7; + UCHAR Layer0SectorsImmutable : 1; + UCHAR Reserved1[3]; + UCHAR Layer0Sectors[4]; +} DVD_DUAL_LAYER_RECORDING_INFORMATION, *PDVD_DUAL_LAYER_RECORDING_INFORMATION; + +// format 0x21 - not define in enum +typedef struct _DVD_DUAL_LAYER_MIDDLE_ZONE_START_ADDRESS { + UCHAR Reserved0 : 7; + UCHAR InitStatus : 1; + UCHAR Reserved1[3]; + UCHAR ShiftedMiddleAreaStartAddress[4]; +} DVD_DUAL_LAYER_MIDDLE_ZONE_START_ADDRESS, *PDVD_DUAL_LAYER_MIDDLE_ZONE_START_ADDRESS; + +// format 0x22 - not define in enum +typedef struct _DVD_DUAL_LAYER_JUMP_INTERVAL_SIZE { + UCHAR Reserved1[4]; + UCHAR JumpIntervalSize[4]; +} DVD_DUAL_LAYER_JUMP_INTERVAL_SIZE, *PDVD_DUAL_LAYER_JUMP_INTERVAL_SIZE; + +// format 0x23 - not define in enum +typedef struct _DVD_DUAL_LAYER_MANUAL_LAYER_JUMP { + UCHAR Reserved1[4]; + UCHAR ManualJumpLayerAddress[4]; +} DVD_DUAL_LAYER_MANUAL_LAYER_JUMP, *PDVD_DUAL_LAYER_MANUAL_LAYER_JUMP; + +// format 0x24 - not define in enum +typedef struct _DVD_DUAL_LAYER_REMAPPING_INFORMATION { + UCHAR Reserved1[4]; + UCHAR RemappingAddress[4]; +} DVD_DUAL_LAYER_REMAPPING_INFORMATION, *PDVD_DUAL_LAYER_REMAPPING_INFORMATION; + +// formats 0x25 through 0x2F are not yet defined + +// format 0x30 - not defined in enum (common header) +typedef struct _DVD_DISC_CONTROL_BLOCK_HEADER { + UCHAR ContentDescriptor[4]; + union { + struct { + UCHAR ReservedDoNotUse_UseAsByteInstead_0[3]; + UCHAR RecordingWithinTheUserDataArea : 1; + UCHAR ReadingDiscControlBlocks : 1; + UCHAR FormattingTheMedium : 1; + UCHAR ModificationOfThisDiscControlBlock : 1; + UCHAR ReservedDoNotUse_UseAsByteInstead_1 : 4; + }; + UCHAR AsByte[4]; + } ProhibitedActions; + UCHAR VendorId[32]; // actually "non-specified" data + // UCHAR DCBData[32728]; +} DVD_DISC_CONTROL_BLOCK_HEADER, *PDVD_DISC_CONTROL_BLOCK_HEADER; +C_ASSERT(sizeof(DVD_DISC_CONTROL_BLOCK_HEADER) == 40); + +// publicly defined DCB types +typedef enum _DISC_CONTROL_BLOCK_TYPE { + FormattingDiscControlBlock = 0x46444300, // 'FDC\0' + WriteInhibitDiscControlBlock = 0x57444300, // 'WDC\0' + SessionInfoDiscControlBlock = 0x53444300, // 'SDC\0' + DiscControlBlockList = 0xFFFFFFFF +} DISC_CONTROL_BLOCK_TYPE, *PDISC_CONTROL_BLOCK_TYPE; + +// format 0x30 - not defined in enum -- Format DCB, not in MMC. + +// format 0x30 - not defined in enum -- Write Inhibit DCB +typedef struct _DVD_DISC_CONTROL_BLOCK_WRITE_INHIBIT { + DVD_DISC_CONTROL_BLOCK_HEADER header; + UCHAR UpdateCount[4]; + union { + struct { + UCHAR ReservedDoNotUse_UseAsByteInstead_0[3]; + UCHAR WriteProtectStatus : 2; + UCHAR ReservedDoNotUse_UseAsByteInstead_1 : 5; + UCHAR UpdateRequiresPassword : 1; + }; + UCHAR AsByte[4]; + } WriteProtectActions; + UCHAR Reserved0[16]; + UCHAR UpdatePassword[32]; + UCHAR Reserved1[32672]; +} DVD_DISC_CONTROL_BLOCK_WRITE_INHIBIT, *PDVD_DISC_CONTROL_BLOCK_WRITE_INHIBIT; +C_ASSERT(sizeof(DVD_DISC_CONTROL_BLOCK_WRITE_INHIBIT) == (16*2048)); + +// format 0x30 - not defined in enum - Session DCB +typedef struct _DVD_DISC_CONTROL_BLOCK_SESSION_ITEM { + UCHAR AsByte[16]; // not publicly defined? +} DVD_DISC_CONTROL_BLOCK_SESSION_ITEM, *PDVD_DISC_CONTROL_BLOCK_SESSION_ITEM; +typedef struct _DVD_DISC_CONTROL_BLOCK_SESSION { + DVD_DISC_CONTROL_BLOCK_HEADER header; + UCHAR SessionNumber[2]; + UCHAR Reserved0[22]; + UCHAR DiscID[32]; + UCHAR Reserved1[32]; + DVD_DISC_CONTROL_BLOCK_SESSION_ITEM SessionItem[504]; + UCHAR Reserved2[24576]; // 3 Repetitions of bytes 0 through 8191 +} DVD_DISC_CONTROL_BLOCK_SESSION, *PDVD_DISC_CONTROL_BLOCK_SESSION; +C_ASSERT(sizeof(DVD_DISC_CONTROL_BLOCK_SESSION) == ((8*1024) * 4)); + +// format 0x30 - not defined in enum - DCB list +typedef struct _DVD_DISC_CONTROL_BLOCK_LIST_DCB { + UCHAR DcbIdentifier[4]; +} DVD_DISC_CONTROL_BLOCK_LIST_DCB, *PDVD_DISC_CONTROL_BLOCK_LIST_DCB; +typedef struct _DVD_DISC_CONTROL_BLOCK_LIST { + DVD_DISC_CONTROL_BLOCK_HEADER header; + UCHAR Reserved0; + UCHAR ReadabldDCBs; + UCHAR Reserved1; + UCHAR WritableDCBs; +#if !defined(__midl) + DVD_DISC_CONTROL_BLOCK_LIST_DCB Dcbs[0]; +#endif +} DVD_DISC_CONTROL_BLOCK_LIST, *PDVD_DISC_CONTROL_BLOCK_LIST; +C_ASSERT(sizeof(DVD_DISC_CONTROL_BLOCK_LIST) == 44); + +// format 0x31 (MTA ECC Block) is unstructured in public spec +// formats 0x32 through 0xBF are not yet defined + +// format 0xC0 - not defined in enum +typedef struct _DVD_WRITE_PROTECTION_STATUS { + UCHAR SoftwareWriteProtectUntilPowerdown : 1; + UCHAR MediaPersistentWriteProtect : 1; + UCHAR CartridgeWriteProtect : 1; + UCHAR MediaSpecificWriteProtect : 1; + UCHAR Reserved0 : 4; + UCHAR Reserved1[3]; +} DVD_WRITE_PROTECTION_STATUS, *PDVD_WRITE_PROTECTION_STATUS; +C_ASSERT(sizeof(DVD_WRITE_PROTECTION_STATUS) == 4); + +// formats 0xC1 through 0x7F are not yet defined +// format 0x80 (AACS volume identifier) is unstructured in public spec +// format 0x81 (Pre-Recorded AACS media serial number) is unstructured in public spec +// format 0x82 (AACS media identifier) is unstructured in public spec +// format 0x83 (AACS media key block) is unstructured in public spec +// formats 0x84 through 0x8F are not yet defined + +// format 0x90 - not defined in enum +typedef struct _DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS_TYPE_CODE { + UCHAR TypeCodeOfFormatLayer[2]; +} DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS, *PDVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS; +typedef struct _DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS { + UCHAR NumberOfRecognizedFormatLayers; + UCHAR OnlineFormatlayer : 2; + UCHAR Reserved1 : 2; + UCHAR DefaultFormatLayer : 2; + UCHAR Reserved2 : 2; + // DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS_TYPE_CODE TypeCodes[0]; +} DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS_TYPE_CODE, *PDVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS_TYPE_CODE; +C_ASSERT(sizeof(DVD_LIST_OF_RECOGNIZED_FORMAT_LAYERS_TYPE_CODE) == 2); + +// formats 0x91 through 0xFE are not yet defined + +// format 0xFF - not defined in enum +typedef struct _DVD_STRUCTURE_LIST_ENTRY { + UCHAR FormatCode; + UCHAR Reserved0 : 6; + UCHAR Readable : 1; + UCHAR Sendable : 1; + UCHAR FormatLength[2]; +} DVD_STRUCTURE_LIST_ENTRY, *PDVD_STRUCTURE_LIST_ENTRY; +C_ASSERT(sizeof(DVD_STRUCTURE_LIST_ENTRY) == 4); + +// BD Disc Structures + +// format 0x00 (BD Disc Information) is unstructured in public spec +// format 0x08 (BD Disc Definition Structure) is unstructured in public spec +// format 0x09 (BD Cartridge Status) is identical to DVD_RAM_MEDIUM_STATUS but +// only CartridgeWriteProtect, CartridgeNotSealed and MediaInCartridge are +// valid. Other fields are reserved. + +// format 0x09 (BD Spare Area Information) - not defined in enum +typedef struct _DVD_BD_SPARE_AREA_INFORMATION { + UCHAR Reserved1[4]; + UCHAR NumberOfFreeSpareBlocks[4]; + UCHAR NumberOfAllocatedSpareBlocks[4]; +} DVD_BD_SPARE_AREA_INFORMATION, *PDVD_BD_SPARE_AREA_INFORMATION; +C_ASSERT(sizeof(DVD_BD_SPARE_AREA_INFORMATION) == 12); + +// format 0x12 (BD Raw Defect List). DFL is not fully defined in public spec + +// format 0x30 (BD Physical Access Control). +typedef struct _BD_PAC_HEADER { + UCHAR PACId[3]; + UCHAR PACFormatNumber; + UCHAR PACUpdateCount[4]; + UCHAR UnknownPACRules[4]; + UCHAR UnkownPACEntireDiscFlag; + UCHAR Reserved1[2]; + UCHAR NumberOfSegments; + UCHAR Segments[8][32]; + UCHAR Reserved2[112]; +} BD_PAC_HEADER, *PBD_PAC_HEADER; +C_ASSERT(sizeof(BD_PAC_HEADER) == 384); + +// Primary PAC is unstructured in public spec + +// Disc Write Protect PAC +typedef struct _BD_DISC_WRITE_PROTECT_PAC { + BD_PAC_HEADER Header; + UCHAR KnownPACEntireDiscFlags; + UCHAR Reserved1[3]; + UCHAR WriteProtectControlByte; + UCHAR Reserved2[7]; + UCHAR WriteProtectPassword[32]; +} BD_DISC_WRITE_PROTECT_PAC, *PBD_DISC_WRITE_PROTECT_PAC; +C_ASSERT(sizeof(BD_DISC_WRITE_PROTECT_PAC) == 428); + + +typedef struct _DVD_RPC_KEY { + UCHAR UserResetsAvailable:3; + UCHAR ManufacturerResetsAvailable:3; + UCHAR TypeCode:2; + UCHAR RegionMask; + UCHAR RpcScheme; + UCHAR Reserved02; +} DVD_RPC_KEY, * PDVD_RPC_KEY; +C_ASSERT(sizeof(DVD_RPC_KEY) == 4); + +typedef struct _DVD_SET_RPC_KEY { + UCHAR PreferredDriveRegionCode; + UCHAR Reserved[3]; +} DVD_SET_RPC_KEY, * PDVD_SET_RPC_KEY; +C_ASSERT(sizeof(DVD_SET_RPC_KEY) == 4); + +typedef struct _DVD_ASF { // Authentication Success Flag + UCHAR Reserved0[3]; + UCHAR SuccessFlag:1; + UCHAR Reserved1:7; +} DVD_ASF, * PDVD_ASF; +C_ASSERT(sizeof(DVD_ASF) == 4); + +typedef struct _DVD_REGION { + UCHAR CopySystem; + UCHAR RegionData; // current media region (not playable when set) + UCHAR SystemRegion; // current drive region (playable when set) + UCHAR ResetCount; // number of resets available +} DVD_REGION, *PDVD_REGION; +C_ASSERT(sizeof(DVD_REGION) == 4); + +// ALL THE ABOVE STRUCTURES ARE BYTE-PACKED: +///////////////////////////////////////////////////////////// +#include + + +#ifdef __cplusplus +} +#endif + + +///////////////////////////////////////////////////////////// +// AACS-related structures +// (mostly opaque data, but useful for allocation) + +// The AACS layer number refers to the layer of the disc a structure +// is read from. This can only be a single byte in the CDB, so limit +// the value to 0..255. +typedef _Field_range_(0,255) ULONG AACS_LAYER_NUMBER, *PAACS_LAYER_NUMBER; +typedef _Field_range_(0,255) const ULONG CAACS_LAYER_NUMBER, *PCAACS_LAYER_NUMBER; + + +// The AACS Certificate (opaque data structure) is used to validate +// the host to the logical unit, as well as to validate the logical +// unit to the host. +typedef struct _AACS_CERTIFICATE { + UCHAR Nonce[20]; + UCHAR Certificate[92]; +} AACS_CERTIFICATE, *PAACS_CERTIFICATE; +typedef const AACS_CERTIFICATE CAACS_CERTIFICATE; +typedef const AACS_CERTIFICATE *PCAACS_CERTIFICATE; +C_ASSERT(sizeof(AACS_CERTIFICATE) == 112); + +// The AACS challenge key (opaque data structure) is used to setup +// a shared bus key for AACS-protected structure transfer. +typedef struct _AACS_CHALLENGE_KEY { + UCHAR EllipticCurvePoint[40]; + UCHAR Signature[40]; +} AACS_CHALLENGE_KEY, *PAACS_CHALLENGE_KEY; +typedef const AACS_CHALLENGE_KEY CAACS_CHALLENGE_KEY; +typedef const AACS_CHALLENGE_KEY *PCAACS_CHALLENGE_KEY; +C_ASSERT(sizeof(AACS_CHALLENGE_KEY) == 80); + +// The VolumeID is one of the unique identifiers on AACS protected media +typedef struct _AACS_VOLUME_ID { + UCHAR VolumeID[16]; + UCHAR MAC[16]; // MessageAuthenticationCode +} AACS_VOLUME_ID, *PAACS_VOLUME_ID; +typedef const AACS_VOLUME_ID CAACS_VOLUME_ID; +typedef const AACS_VOLUME_ID *PCAACS_VOLUME_ID; +C_ASSERT(sizeof(AACS_VOLUME_ID) == 32); + +// The prerecorded Serial Number is one of the unique identifiers on AACS protected media +typedef struct _AACS_SERIAL_NUMBER { + UCHAR PrerecordedSerialNumber[16]; + UCHAR MAC[16]; // MessageAuthenticationCode +} AACS_SERIAL_NUMBER, *PAACS_SERIAL_NUMBER; +typedef const AACS_SERIAL_NUMBER CAACS_SERIAL_NUMBER; +typedef const AACS_SERIAL_NUMBER *PCAACS_SERIAL_NUMBER; +C_ASSERT(sizeof(AACS_SERIAL_NUMBER) == 32); + +// The MediaID is one of the unique identifiers on AACS protected media +typedef struct _AACS_MEDIA_ID { + UCHAR MediaID[16]; + UCHAR MAC[16]; // MessageAuthenticationCode +} AACS_MEDIA_ID, *PAACS_MEDIA_ID; +typedef const AACS_MEDIA_ID CAACS_MEDIA_ID; +typedef const AACS_MEDIA_ID *PCAACS_MEDIA_ID; +C_ASSERT(sizeof(AACS_MEDIA_ID) == 32); + +// When sending a certificate or challenge key, need to wrap +// the data structure with a DVD_SESSION_ID. +typedef struct _AACS_SEND_CERTIFICATE { + DVD_SESSION_ID SessionId; + AACS_CERTIFICATE Certificate; +} AACS_SEND_CERTIFICATE, *PAACS_SEND_CERTIFICATE; +typedef const AACS_SEND_CERTIFICATE CAACS_SEND_CERTIFICATE; +typedef const AACS_SEND_CERTIFICATE *PCAACS_SEND_CERTIFICATE; + +// When sending a certificate or challenge key, need to wrap +// the data structure with a DVD_SESSION_ID. +typedef struct _AACS_SEND_CHALLENGE_KEY { + DVD_SESSION_ID SessionId; + AACS_CHALLENGE_KEY ChallengeKey; +} AACS_SEND_CHALLENGE_KEY, *PAACS_SEND_CHALLENGE_KEY; +typedef const AACS_SEND_CHALLENGE_KEY CAACS_SEND_CHALLENGE_KEY; +typedef const AACS_SEND_CHALLENGE_KEY *PCAACS_SEND_CHALLENGE_KEY; + + +// The AACS binding nonce (opaque data structure) is used to +// protect individual content. +typedef struct _AACS_BINDING_NONCE { + UCHAR BindingNonce[16]; + UCHAR MAC[16]; // MessageAuthenticationCode +} AACS_BINDING_NONCE, *PAACS_BINDING_NONCE; +typedef const AACS_BINDING_NONCE CAACS_BINDING_NONCE; +typedef const AACS_BINDING_NONCE *PCAACS_BINDING_NONCE; +C_ASSERT(sizeof(AACS_BINDING_NONCE) == 32); + + +// This structure is sent when reading a binding nonce +// either from the medium or when having the logical unit +// generate a new binding nonce for a set of sectors +// NOTE: This structure must be identically aligned for 32/64 bit builds +// +typedef struct _AACS_READ_BINDING_NONCE { + DVD_SESSION_ID SessionId; + _Field_range_(0,255) ULONG NumberOfSectors; // spec only provides one byte + ULONGLONG StartLba; + + // 32-bit HANDLE is 32 bits, 64-bit HANDLE is 64 bits + union { + HANDLE Handle; + ULONGLONG ForceStructureLengthToMatch64bit; + }; +} AACS_READ_BINDING_NONCE, *PAACS_READ_BINDING_NONCE; + +///////////////////////////////////////////////////////////// + +#pragma warning(pop) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDCDVD_ + +// end_winioctl + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddchgr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddchgr.h new file mode 100644 index 0000000000000000000000000000000000000000..3fd46cefc05d25b0db9d17d2dd93931e46157942 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddchgr.h @@ -0,0 +1,803 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddchgr.h + +Abstract: + + This is the include file that defines all constants and types for + accessing medium changer devices. + +--*/ + +#ifndef _NTDDCHGR_H_ +#define _NTDDCHGR_H_ + +#include + +#if _MSC_VER > 1000 +#pragma once +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_CHANGER_DEVICE_NAME "\\Device\\Changer" + +// +// NtDeviceIoControlFile IoControlCode values for changer devices. +// + + +// begin_winioctl + +#define IOCTL_CHANGER_BASE FILE_DEVICE_CHANGER + +#define IOCTL_CHANGER_GET_PARAMETERS CTL_CODE(IOCTL_CHANGER_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_GET_STATUS CTL_CODE(IOCTL_CHANGER_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_GET_PRODUCT_DATA CTL_CODE(IOCTL_CHANGER_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_SET_ACCESS CTL_CODE(IOCTL_CHANGER_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_CHANGER_GET_ELEMENT_STATUS CTL_CODE(IOCTL_CHANGER_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS CTL_CODE(IOCTL_CHANGER_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_SET_POSITION CTL_CODE(IOCTL_CHANGER_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_EXCHANGE_MEDIUM CTL_CODE(IOCTL_CHANGER_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_MOVE_MEDIUM CTL_CODE(IOCTL_CHANGER_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_REINITIALIZE_TRANSPORT CTL_CODE(IOCTL_CHANGER_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_CHANGER_QUERY_VOLUME_TAGS CTL_CODE(IOCTL_CHANGER_BASE, 0x000B, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +// end_winioctl + +// +// The following file contains the IOCTL_STORAGE class ioctls +// + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +// begin_winioctl + +#define MAX_VOLUME_ID_SIZE 36 +#define MAX_VOLUME_TEMPLATE_SIZE 40 + +#define VENDOR_ID_LENGTH 8 +#define PRODUCT_ID_LENGTH 16 +#define REVISION_LENGTH 4 +#define SERIAL_NUMBER_LENGTH 32 + +// +// Common structures describing elements. +// + +typedef enum _ELEMENT_TYPE { + AllElements, // As defined by SCSI + ChangerTransport, // As defined by SCSI + ChangerSlot, // As defined by SCSI + ChangerIEPort, // As defined by SCSI + ChangerDrive, // As defined by SCSI + ChangerDoor, // Front panel, used to access internal of cabinet. + ChangerKeypad, // Keypad/input on front panel. + ChangerMaxElement // Placeholder only. Not a valid type. +} ELEMENT_TYPE, *PELEMENT_TYPE; + +typedef struct _CHANGER_ELEMENT { + ELEMENT_TYPE ElementType; + ULONG ElementAddress; +} CHANGER_ELEMENT, *PCHANGER_ELEMENT; + +typedef struct _CHANGER_ELEMENT_LIST { + CHANGER_ELEMENT Element; + ULONG NumberOfElements; +} CHANGER_ELEMENT_LIST , *PCHANGER_ELEMENT_LIST; + + +// +// Definitions for IOCTL_CHANGER_GET_PARAMETERS +// + +// +// Definitions for Features0 of GET_CHANGER_PARAMETERS +// + +#define CHANGER_BAR_CODE_SCANNER_INSTALLED 0x00000001 // The medium-changer has a bar code scanner installed. +#define CHANGER_INIT_ELEM_STAT_WITH_RANGE 0x00000002 // The medium-changer has the ability to initialize elements within a specified range. +#define CHANGER_CLOSE_IEPORT 0x00000004 // The medium-changer has the ability to close the i/e port door. +#define CHANGER_OPEN_IEPORT 0x00000008 // The medium-changer can open the i/e port door. + +#define CHANGER_STATUS_NON_VOLATILE 0x00000010 // The medium-changer uses non-volatile memory for element status information. +#define CHANGER_EXCHANGE_MEDIA 0x00000020 // The medium-changer supports exchange operations. +#define CHANGER_CLEANER_SLOT 0x00000040 // The medium-changer has a fixed slot designated for cleaner cartridges. +#define CHANGER_LOCK_UNLOCK 0x00000080 // The medium-changer can be (un)secured to (allow)prevent media removal. + +#define CHANGER_CARTRIDGE_MAGAZINE 0x00000100 // The medium-changer uses cartridge magazines for some storage slots. +#define CHANGER_MEDIUM_FLIP 0x00000200 // The medium-changer can flip medium. +#define CHANGER_POSITION_TO_ELEMENT 0x00000400 // The medium-changer can position the transport to a particular element. +#define CHANGER_REPORT_IEPORT_STATE 0x00000800 // The medium-changer can determine whether media is present + // in the IE Port. + +#define CHANGER_STORAGE_DRIVE 0x00001000 // The medium-changer can use a drive as an independent storage element. +#define CHANGER_STORAGE_IEPORT 0x00002000 // The medium-changer can use a i/e port as an independent storage element. +#define CHANGER_STORAGE_SLOT 0x00004000 // The medium-changer can use a slot as an independent storage element. +#define CHANGER_STORAGE_TRANSPORT 0x00008000 // The medium-changer can use a transport as an independent storage element. + +#define CHANGER_DRIVE_CLEANING_REQUIRED 0x00010000 // The drives controlled by the medium changer require periodic cleaning + // initiated by an application. +#define CHANGER_PREDISMOUNT_EJECT_REQUIRED 0x00020000 // The medium-changer requires a drive eject command to be issued, before a changer + // move / exchange command can be issued to the drive. + +#define CHANGER_CLEANER_ACCESS_NOT_VALID 0x00040000 // The access bit in GES isn't valid for cleaner cartridges. +#define CHANGER_PREMOUNT_EJECT_REQUIRED 0x00080000 // The medium-changer requires a drive eject command to be issued + // before a move / exchange command can be issued with the drive as src/dst. + +#define CHANGER_VOLUME_IDENTIFICATION 0x00100000 // The medium-changer supports volume identification. +#define CHANGER_VOLUME_SEARCH 0x00200000 // The medium-changer can search for volume information. +#define CHANGER_VOLUME_ASSERT 0x00400000 // The medium-changer can verify volume information. +#define CHANGER_VOLUME_REPLACE 0x00800000 // The medium-changer can replace volume information. +#define CHANGER_VOLUME_UNDEFINE 0x01000000 // The medium-changer can undefine volume information. + +#define CHANGER_SERIAL_NUMBER_VALID 0x04000000 // The serial number reported in GetProductData is valid + // and unique. + +#define CHANGER_DEVICE_REINITIALIZE_CAPABLE 0x08000000 // The medium-changer can be issued a ChangerReinitializeUnit. +#define CHANGER_KEYPAD_ENABLE_DISABLE 0x10000000 // Indicates that the keypad can be enabled/disabled. +#define CHANGER_DRIVE_EMPTY_ON_DOOR_ACCESS 0x20000000 // Drives must be empty before access via the door is possible. + +#define CHANGER_RESERVED_BIT 0x80000000 // Will be used to indicate Features1 capability bits. + + +// +// Definitions for Features1 of GET_CHANGER_PARAMETERS +// + +#define CHANGER_PREDISMOUNT_ALIGN_TO_SLOT 0x80000001 // The transport must be prepositioned to the slot prior to ejecting the media. +#define CHANGER_PREDISMOUNT_ALIGN_TO_DRIVE 0x80000002 // The transport must be prepositioned to the drive prior to ejecting the media. +#define CHANGER_CLEANER_AUTODISMOUNT 0x80000004 // The device will move the cleaner cartridge back into the slot when cleaning has completed. +#define CHANGER_TRUE_EXCHANGE_CAPABLE 0x80000008 // Device can do src -> dest2 exchanges. +#define CHANGER_SLOTS_USE_TRAYS 0x80000010 // Slots have removable trays, requiring multiple moves for inject/eject. +#define CHANGER_RTN_MEDIA_TO_ORIGINAL_ADDR 0x80000020 // Media must be returned to the slot from which it originated after a move to another element. +#define CHANGER_CLEANER_OPS_NOT_SUPPORTED 0x80000040 // Automated cleaning operations are not supported on this device. +#define CHANGER_IEPORT_USER_CONTROL_OPEN 0x80000080 // Indicates that user action is necessary to open a closed ieport. +#define CHANGER_IEPORT_USER_CONTROL_CLOSE 0x80000100 // Indicates that user action is necessary to close an opened ieport. +#define CHANGER_MOVE_EXTENDS_IEPORT 0x80000200 // Indicates that a move media to the ieport extends the tray. +#define CHANGER_MOVE_RETRACTS_IEPORT 0x80000400 // Indicates that a move media from the ieport retracts the tray. + + +// +// Definitions for MoveFrom, ExchangeFrom, and PositionCapabilities +// + +#define CHANGER_TO_TRANSPORT 0x01 // The device can carry out the operation to a transport from the specified element. +#define CHANGER_TO_SLOT 0x02 // The device can carry out the operation to a slot from the specified element. +#define CHANGER_TO_IEPORT 0x04 // The device can carry out the operation to an IE Port from the specified element. +#define CHANGER_TO_DRIVE 0x08 // The device can carry out the operation to a drive from the specified element. + +// +// Definitions for LockUnlockCapabilities +// + +#define LOCK_UNLOCK_IEPORT 0x01 // The device can lock/unlock the ieport(s). +#define LOCK_UNLOCK_DOOR 0x02 // The device can lock/unlock the door(s). +#define LOCK_UNLOCK_KEYPAD 0x04 // The device can lock/unlock the keypad. + +typedef struct _GET_CHANGER_PARAMETERS { + + // + // Size of the structure. Can be used for versioning. + // + + ULONG Size; + + // + // Number of N element(s) as defined by the Element Address Page (or equivalent...). + // + + USHORT NumberTransportElements; + USHORT NumberStorageElements; // for data cartridges only + USHORT NumberCleanerSlots; // for cleaner cartridges + USHORT NumberIEElements; + USHORT NumberDataTransferElements; + + // + // Number of doors/front panels (allows user entry into the cabinet). + // + + USHORT NumberOfDoors; + + // + // The device-specific address (from user manual of the device) of the first N element. Used + // by the UI to relate the various elements to the user. + // + + USHORT FirstSlotNumber; + USHORT FirstDriveNumber; + USHORT FirstTransportNumber; + USHORT FirstIEPortNumber; + USHORT FirstCleanerSlotAddress; + + // + // Indicates the capacity of each magazine, if they exist. + // + + USHORT MagazineSize; + + // + // Specifies the approximate number of seconds for when a cleaning should be completed. + // Only applicable if drive cleaning is supported. See Features0. + // + + ULONG DriveCleanTimeout; + + // + // See features bits, above. + // + + ULONG Features0; + ULONG Features1; + + // + // Bitmask defining Move from N element to element. Defined by Device Capabilities Page (or equivalent). + // AND-masking with the TO_XXX values will indicate legal destinations. + // + + UCHAR MoveFromTransport; + UCHAR MoveFromSlot; + UCHAR MoveFromIePort; + UCHAR MoveFromDrive; + + // + // Bitmask defining Exchange from N element to element. Defined by Device Capabilities Page (or equivalent). + // AND-masking with the TO_XXX values will indicate legal destinations. + // + + UCHAR ExchangeFromTransport; + UCHAR ExchangeFromSlot; + UCHAR ExchangeFromIePort; + UCHAR ExchangeFromDrive; + + // + // Bitmask defining which elements are capable of lock/unlock. Valid only if + // CHANGER_LOCK_UNLOCK is set in Features0. + // + + UCHAR LockUnlockCapabilities; + + // + // Bitmask defining which elements valid for positioning operations. Valid only if + // CHANGER_POSITION_TO_ELEMENT is set in Features0. + // + + UCHAR PositionCapabilities; + + // + // For future expansion. + // + + UCHAR Reserved1[2]; + ULONG Reserved2[2]; + +} GET_CHANGER_PARAMETERS, * PGET_CHANGER_PARAMETERS; + + +// +// Definitions for IOCTL_CHANGER_GET_PRODUCT_DATA +// + +typedef struct _CHANGER_PRODUCT_DATA { + + // + // Device manufacturer's name - based on inquiry data + // + + UCHAR VendorId[VENDOR_ID_LENGTH]; + + // + // Product identification as defined by the vendor - based on Inquiry data + // + + UCHAR ProductId[PRODUCT_ID_LENGTH]; + + // + // Product revision as defined by the vendor. + // + + UCHAR Revision[REVISION_LENGTH]; + + // + // Vendor unique value used to globally identify this device. Can + // be from Vital Product Data, for example. + // + + UCHAR SerialNumber[SERIAL_NUMBER_LENGTH]; + + // + // Indicates device type of data transports, as defined by SCSI-2. + // + + UCHAR DeviceType; + +} CHANGER_PRODUCT_DATA, *PCHANGER_PRODUCT_DATA; + + +// +// Definitions for IOCTL_CHANGER_SET_ACCESS +// + +#define LOCK_ELEMENT 0 +#define UNLOCK_ELEMENT 1 +#define EXTEND_IEPORT 2 +#define RETRACT_IEPORT 3 + +typedef struct _CHANGER_SET_ACCESS { + + // + // Element can be ChangerIEPort, ChangerDoor, ChangerKeypad + // + + CHANGER_ELEMENT Element; + + // + // See above for possible operations. + // + + ULONG Control; +} CHANGER_SET_ACCESS, *PCHANGER_SET_ACCESS; + + +// +// Definitions for IOCTL_CHANGER_GET_ELEMENT_STATUS +// + +// +// Input buffer. +// + +typedef struct _CHANGER_READ_ELEMENT_STATUS { + + // + // List describing the elements and range on which to return information. + // + + CHANGER_ELEMENT_LIST ElementList; + + // + // Indicates whether volume tag information is to be returned. + // + + BOOLEAN VolumeTagInfo; +} CHANGER_READ_ELEMENT_STATUS, *PCHANGER_READ_ELEMENT_STATUS; + +// +// Output buffer. +// + +typedef struct _CHANGER_ELEMENT_STATUS { + + // + // Element to which this structure refers. + // + + CHANGER_ELEMENT Element; + + // + // Address of the element from which the media was originally moved. + // Valid if ELEMENT_STATUS_SVALID bit of Flags ULONG is set. + // Needs to be converted to a zero-based offset from the device-unique value. + // + + CHANGER_ELEMENT SrcElementAddress; + + // + // See below. + // + + ULONG Flags; + + // + // See below for possible values. + // + + ULONG ExceptionCode; + + // + // Scsi Target Id of this element. + // Valid only if ELEMENT_STATUS_ID_VALID is set in Flags. + // + + UCHAR TargetId; + + // + // LogicalUnitNumber of this element. + // Valid only if ELEMENT_STATUS_LUN_VALID is set in Flags. + // + + UCHAR Lun; + USHORT Reserved; + + // + // Primary volume identification for the media. + // Valid only if ELEMENT_STATUS_PVOLTAG bit is set in Flags. + // + + UCHAR PrimaryVolumeID[MAX_VOLUME_ID_SIZE]; + + // + // Alternate volume identification for the media. + // Valid for two-sided media only, and pertains to the id. of the inverted side. + // Valid only if ELEMENT_STATUS_AVOLTAG bit is set in Flags. + // + + UCHAR AlternateVolumeID[MAX_VOLUME_ID_SIZE]; + +} CHANGER_ELEMENT_STATUS, *PCHANGER_ELEMENT_STATUS; + +// +// Output buffer. This is same as CHANGER_ELEMENT_STATUS with +// the addition of product info fields. New applications should +// use this struct instead of the older CHANGER_ELEMENT_STATUS +// + +typedef struct _CHANGER_ELEMENT_STATUS_EX { + + // + // Element to which this structure refers. + // + + CHANGER_ELEMENT Element; + + // + // Address of the element from which the media was originally moved. + // Valid if ELEMENT_STATUS_SVALID bit of Flags ULONG is set. + // Needs to be converted to a zero-based offset from the device-unique value. + // + + CHANGER_ELEMENT SrcElementAddress; + + // + // See below. + // + + ULONG Flags; + + // + // See below for possible values. + // + + ULONG ExceptionCode; + + // + // Scsi Target Id of this element. + // Valid only if ELEMENT_STATUS_ID_VALID is set in Flags. + // + + UCHAR TargetId; + + // + // LogicalUnitNumber of this element. + // Valid only if ELEMENT_STATUS_LUN_VALID is set in Flags. + // + + UCHAR Lun; + USHORT Reserved; + + // + // Primary volume identification for the media. + // Valid only if ELEMENT_STATUS_PVOLTAG bit is set in Flags. + // + + UCHAR PrimaryVolumeID[MAX_VOLUME_ID_SIZE]; + + // + // Alternate volume identification for the media. + // Valid for two-sided media only, and pertains to the id. of the inverted side. + // Valid only if ELEMENT_STATUS_AVOLTAG bit is set in Flags. + // + + UCHAR AlternateVolumeID[MAX_VOLUME_ID_SIZE]; + + // + // Vendor ID + // + UCHAR VendorIdentification[VENDOR_ID_LENGTH]; + + // + // Product ID + // + UCHAR ProductIdentification[PRODUCT_ID_LENGTH]; + + // + // Serial number + // + UCHAR SerialNumber[SERIAL_NUMBER_LENGTH]; + +} CHANGER_ELEMENT_STATUS_EX, *PCHANGER_ELEMENT_STATUS_EX; + +// +// Possible flag values +// + +#define ELEMENT_STATUS_FULL 0x00000001 // Element contains a unit of media. +#define ELEMENT_STATUS_IMPEXP 0x00000002 // Media in i/e port was placed there by an operator. +#define ELEMENT_STATUS_EXCEPT 0x00000004 // Element is in an abnormal state; check ExceptionCode field for more information. +#define ELEMENT_STATUS_ACCESS 0x00000008 // Access to the i/e port from the medium changer is allowed. +#define ELEMENT_STATUS_EXENAB 0x00000010 // Export of media is supported. +#define ELEMENT_STATUS_INENAB 0x00000020 // Import of media is supported. + +#define ELEMENT_STATUS_PRODUCT_DATA 0x00000040 // Serial number valid for the drive + +#define ELEMENT_STATUS_LUN_VALID 0x00001000 // Lun information is valid. +#define ELEMENT_STATUS_ID_VALID 0x00002000 // SCSI Id information is valid. +#define ELEMENT_STATUS_NOT_BUS 0x00008000 // Lun and SCSI Id fields are not on same bus as medium changer. +#define ELEMENT_STATUS_INVERT 0x00400000 // Media in element was inverted (valid only if ELEMENT_STATUS_SVALID bit is set) +#define ELEMENT_STATUS_SVALID 0x00800000 // SourceElementAddress field and ELEMENT_STATUS_INVERT bit are valid. + +#define ELEMENT_STATUS_PVOLTAG 0x10000000 // Primary volume information is valid. +#define ELEMENT_STATUS_AVOLTAG 0x20000000 // Alternate volume information is valid. + +// +// ExceptionCode values. +// + +#define ERROR_LABEL_UNREADABLE 0x00000001 // Bar code scanner could not read bar code label. +#define ERROR_LABEL_QUESTIONABLE 0x00000002 // Label could be invalid due to unit attention condition. +#define ERROR_SLOT_NOT_PRESENT 0x00000004 // Slot is currently not addressable in the device. +#define ERROR_DRIVE_NOT_INSTALLED 0x00000008 // Drive is not installed. +#define ERROR_TRAY_MALFUNCTION 0x00000010 // Media tray is malfunctioning/broken. +#define ERROR_INIT_STATUS_NEEDED 0x00000011 // An Initialize Element Status command is needed. +#define ERROR_UNHANDLED_ERROR 0xFFFFFFFF // Unknown error condition + + +// +// Definitions for IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS +// + +typedef struct _CHANGER_INITIALIZE_ELEMENT_STATUS { + + // + // List describing the elements and range on which to initialize. + // + + CHANGER_ELEMENT_LIST ElementList; + + // + // Indicates whether a bar code scan should be used. Only applicable if + // CHANGER_BAR_CODE_SCANNER_INSTALLED is set in Features0 of CHANGER_GET_PARAMETERS. + // + + BOOLEAN BarCodeScan; +} CHANGER_INITIALIZE_ELEMENT_STATUS, *PCHANGER_INITIALIZE_ELEMENT_STATUS; + + +// +// Definitions for IOCTL_CHANGER_SET_POSITION +// + +typedef struct _CHANGER_SET_POSITION { + + + // + // Indicates which transport to move. + // + + CHANGER_ELEMENT Transport; + + // + // Indicates the final destination of the transport. + // + + CHANGER_ELEMENT Destination; + + // + // Indicates whether the media currently carried by Transport, should be flipped. + // + + BOOLEAN Flip; +} CHANGER_SET_POSITION, *PCHANGER_SET_POSITION; + + +// +// Definitions for IOCTL_CHANGER_EXCHANGE_MEDIUM +// + +typedef struct _CHANGER_EXCHANGE_MEDIUM { + + // + // Indicates which transport to use for the exchange operation. + // + + CHANGER_ELEMENT Transport; + + // + // Indicates the source for the media that is to be moved. + // + + CHANGER_ELEMENT Source; + + // + // Indicates the final destination of the media originally at Source. + // + + CHANGER_ELEMENT Destination1; + + // + // Indicates the destination of the media moved from Destination1. + // + + CHANGER_ELEMENT Destination2; + + // + // Indicates whether the medium should be flipped. + // + + BOOLEAN Flip1; + BOOLEAN Flip2; +} CHANGER_EXCHANGE_MEDIUM, *PCHANGER_EXCHANGE_MEDIUM; + + +// +// Definitions for IOCTL_CHANGER_MOVE_MEDIUM +// + +typedef struct _CHANGER_MOVE_MEDIUM { + + // + // Indicates which transport to use for the move operation. + // + + CHANGER_ELEMENT Transport; + + // + // Indicates the source for the media that is to be moved. + // + + CHANGER_ELEMENT Source; + + // + // Indicates the destination of the media originally at Source. + // + + CHANGER_ELEMENT Destination; + + // + // Indicates whether the media should be flipped. + // + + BOOLEAN Flip; +} CHANGER_MOVE_MEDIUM, *PCHANGER_MOVE_MEDIUM; + + + +// +// Definitions for IOCTL_QUERY_VOLUME_TAGS +// + +// +// Input buffer. +// + +typedef struct _CHANGER_SEND_VOLUME_TAG_INFORMATION { + + // + // Describes the starting element for which to return information. + // + + CHANGER_ELEMENT StartingElement; + + // + // Indicates the specific action to perform. See below. + // + + ULONG ActionCode; + + // + // Template used by the device to search for volume ids. + // + + UCHAR VolumeIDTemplate[MAX_VOLUME_TEMPLATE_SIZE]; +} CHANGER_SEND_VOLUME_TAG_INFORMATION, *PCHANGER_SEND_VOLUME_TAG_INFORMATION; + + +// +// Output buffer. +// + +typedef struct _READ_ELEMENT_ADDRESS_INFO { + + // + // Number of elements matching criteria set forth by ActionCode. + // + + ULONG NumberOfElements; + + // + // Array of CHANGER_ELEMENT_STATUS structures, one for each element that corresponded + // with the information passed in with the CHANGER_SEND_VOLUME_TAG_INFORMATION structure. + // + + CHANGER_ELEMENT_STATUS ElementStatus[1]; +} READ_ELEMENT_ADDRESS_INFO, *PREAD_ELEMENT_ADDRESS_INFO; + +// +// Possible ActionCode values. See Features0 of CHANGER_GET_PARAMETERS for compatibility with +// the current device. +// + +#define SEARCH_ALL 0x0 // Translate - search all defined volume tags. +#define SEARCH_PRIMARY 0x1 // Translate - search only primary volume tags. +#define SEARCH_ALTERNATE 0x2 // Translate - search only alternate volume tags. +#define SEARCH_ALL_NO_SEQ 0x4 // Translate - search all defined volume tags but ignore sequence numbers. +#define SEARCH_PRI_NO_SEQ 0x5 // Translate - search only primary volume tags but ignore sequence numbers. +#define SEARCH_ALT_NO_SEQ 0x6 // Translate - search only alternate volume tags but ignore sequence numbers. + +#define ASSERT_PRIMARY 0x8 // Assert - as the primary volume tag - if tag now undefined. +#define ASSERT_ALTERNATE 0x9 // Assert - as the alternate volume tag - if tag now undefined. + +#define REPLACE_PRIMARY 0xA // Replace - the primary volume tag - current tag ignored. +#define REPLACE_ALTERNATE 0xB // Replace - the alternate volume tag - current tag ignored. + +#define UNDEFINE_PRIMARY 0xC // Undefine - the primary volume tag - current tag ignored. +#define UNDEFINE_ALTERNATE 0xD // Undefine - the alternate volume tag - current tag ignored. + + +// +// Changer diagnostic test related definitions +// +typedef enum _CHANGER_DEVICE_PROBLEM_TYPE { + DeviceProblemNone, + DeviceProblemHardware, + DeviceProblemCHMError, + DeviceProblemDoorOpen, + DeviceProblemCalibrationError, + DeviceProblemTargetFailure, + DeviceProblemCHMMoveError, + DeviceProblemCHMZeroError, + DeviceProblemCartridgeInsertError, + DeviceProblemPositionError, + DeviceProblemSensorError, + DeviceProblemCartridgeEjectError, + DeviceProblemGripperError, + DeviceProblemDriveError +} CHANGER_DEVICE_PROBLEM_TYPE, *PCHANGER_DEVICE_PROBLEM_TYPE; + +// end_winioctl + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // _NTDDCHGR_H_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdddisk.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdddisk.h new file mode 100644 index 0000000000000000000000000000000000000000..f28a2640ec22e26a864e8c6c1ce5708fd4fbe216 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdddisk.h @@ -0,0 +1,2046 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntdddisk.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Disk device. + +Revision History: + +--*/ + + +// begin_winioctl + +#ifndef _NTDDDISK_H_ +#define _NTDDDISK_H_ + +#include + + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// end_winioctl + +#if _MSC_VER > 1000 +#pragma once +#endif + +#if (NTDDI_VERSION >= NTDDI_WINXP) +#include +#endif + +#if defined __cplusplus && !defined __ALT_GENERATOR__ +extern "C" { +#endif + +// begin_winioctl + +#if defined(_MSC_VER) +#if (_MSC_VER >= 1200) +#pragma warning(push) +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union +#pragma warning(disable:4214) // nonstandard extension used : bitfield other than int +#pragma warning(disable:4820) // padding added after data member +#endif +#endif + +// end_winioctl + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_DISK_DEVICE_NAME "\\Device\\UNKNOWN" + + +// +// NtDeviceIoControlFile + +// begin_winioctl + +// +// IoControlCode values for disk devices. +// + +#define IOCTL_DISK_BASE FILE_DEVICE_DISK +#define IOCTL_DISK_GET_DRIVE_GEOMETRY CTL_CODE(IOCTL_DISK_BASE, 0x0000, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_GET_PARTITION_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_PARTITION_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_GET_DRIVE_LAYOUT CTL_CODE(IOCTL_DISK_BASE, 0x0003, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_DRIVE_LAYOUT CTL_CODE(IOCTL_DISK_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_VERIFY CTL_CODE(IOCTL_DISK_BASE, 0x0005, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_FORMAT_TRACKS CTL_CODE(IOCTL_DISK_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_REASSIGN_BLOCKS CTL_CODE(IOCTL_DISK_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_PERFORMANCE CTL_CODE(IOCTL_DISK_BASE, 0x0008, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_IS_WRITABLE CTL_CODE(IOCTL_DISK_BASE, 0x0009, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_LOGGING CTL_CODE(IOCTL_DISK_BASE, 0x000a, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_FORMAT_TRACKS_EX CTL_CODE(IOCTL_DISK_BASE, 0x000b, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_HISTOGRAM_STRUCTURE CTL_CODE(IOCTL_DISK_BASE, 0x000c, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_HISTOGRAM_DATA CTL_CODE(IOCTL_DISK_BASE, 0x000d, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_HISTOGRAM_RESET CTL_CODE(IOCTL_DISK_BASE, 0x000e, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_REQUEST_STRUCTURE CTL_CODE(IOCTL_DISK_BASE, 0x000f, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_REQUEST_DATA CTL_CODE(IOCTL_DISK_BASE, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_PERFORMANCE_OFF CTL_CODE(IOCTL_DISK_BASE, 0x0018, METHOD_BUFFERED, FILE_ANY_ACCESS) + + + +#if(_WIN32_WINNT >= 0x0400) +#define IOCTL_DISK_CONTROLLER_NUMBER CTL_CODE(IOCTL_DISK_BASE, 0x0011, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL support for SMART drive fault prediction. +// + +#define SMART_GET_VERSION CTL_CODE(IOCTL_DISK_BASE, 0x0020, METHOD_BUFFERED, FILE_READ_ACCESS) +#define SMART_SEND_DRIVE_COMMAND CTL_CODE(IOCTL_DISK_BASE, 0x0021, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define SMART_RCV_DRIVE_DATA CTL_CODE(IOCTL_DISK_BASE, 0x0022, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#if(NTDDI_VERSION >= NTDDI_WIN10_CO) +#define SMART_RCV_DRIVE_DATA_EX CTL_CODE(IOCTL_DISK_BASE, 0x0023, METHOD_BUFFERED, FILE_ANY_ACCESS) +#endif /* NTDDI_VERSION >= NTDDI_WIN10_CO */ + +#endif /* _WIN32_WINNT >= 0x0400 */ + +#if (_WIN32_WINNT >= 0x500) + +// +// New IOCTLs for GUID Partition tabled disks. +// + +#define IOCTL_DISK_GET_PARTITION_INFO_EX CTL_CODE(IOCTL_DISK_BASE, 0x0012, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_SET_PARTITION_INFO_EX CTL_CODE(IOCTL_DISK_BASE, 0x0013, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_GET_DRIVE_LAYOUT_EX CTL_CODE(IOCTL_DISK_BASE, 0x0014, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_SET_DRIVE_LAYOUT_EX CTL_CODE(IOCTL_DISK_BASE, 0x0015, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_CREATE_DISK CTL_CODE(IOCTL_DISK_BASE, 0x0016, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_GET_LENGTH_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0017, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_GET_DRIVE_GEOMETRY_EX CTL_CODE(IOCTL_DISK_BASE, 0x0028, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#endif /* _WIN32_WINNT >= 0x0500 */ + + +#if (_WIN32_WINNT >= 0x0502) + +// +// New IOCTL for disk devices that support 8 byte LBA +// +#define IOCTL_DISK_REASSIGN_BLOCKS_EX CTL_CODE(IOCTL_DISK_BASE, 0x0029, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#endif //_WIN32_WINNT >= 0x0502 + +#if(_WIN32_WINNT >= 0x0500) +#define IOCTL_DISK_UPDATE_DRIVE_SIZE CTL_CODE(IOCTL_DISK_BASE, 0x0032, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_GROW_PARTITION CTL_CODE(IOCTL_DISK_BASE, 0x0034, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_DISK_GET_CACHE_INFORMATION CTL_CODE(IOCTL_DISK_BASE, 0x0035, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_CACHE_INFORMATION CTL_CODE(IOCTL_DISK_BASE, 0x0036, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#if (NTDDI_VERSION < NTDDI_WS03) +#define IOCTL_DISK_GET_WRITE_CACHE_STATE CTL_CODE(IOCTL_DISK_BASE, 0x0037, METHOD_BUFFERED, FILE_READ_ACCESS) +#else +#define OBSOLETE_DISK_GET_WRITE_CACHE_STATE CTL_CODE(IOCTL_DISK_BASE, 0x0037, METHOD_BUFFERED, FILE_READ_ACCESS) +#endif +#define IOCTL_DISK_DELETE_DRIVE_LAYOUT CTL_CODE(IOCTL_DISK_BASE, 0x0040, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// Called to flush cached information that the driver may have about this +// device's characteristics. Not all drivers cache characteristics, and not +// cached properties can be flushed. This simply serves as an update to the +// driver that it may want to do an expensive reexamination of the device's +// characteristics now (fixed media size, partition table, etc...) +// + +#define IOCTL_DISK_UPDATE_PROPERTIES CTL_CODE(IOCTL_DISK_BASE, 0x0050, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Special IOCTLs needed to support PC-98 machines in Japan +// + +#define IOCTL_DISK_FORMAT_DRIVE CTL_CODE(IOCTL_DISK_BASE, 0x00f3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_DISK_SENSE_DEVICE CTL_CODE(IOCTL_DISK_BASE, 0x00f8, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#endif /* _WIN32_WINNT >= 0x0500 */ + +// end_winioctl + +// +// IOCTLs to report and modify our caching behavior +// + +#define IOCTL_DISK_GET_CACHE_SETTING CTL_CODE(IOCTL_DISK_BASE, 0x0038, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_CACHE_SETTING CTL_CODE(IOCTL_DISK_BASE, 0x0039, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +typedef enum _DISK_CACHE_STATE { + + DiskCacheNormal, + DiskCacheWriteThroughNotSupported, + DiskCacheModifyUnsuccessful + +} DISK_CACHE_STATE, *PDISK_CACHE_STATE; + +typedef struct _DISK_CACHE_SETTING { + + // + // The size of this structure is used for versioning + // + ULONG Version; + + // + // Indicates whether there are any issues with the disk cache + // + DISK_CACHE_STATE State; + + // + // Indicates whether the disk cache is power protected or not + // + BOOLEAN IsPowerProtected; + +} DISK_CACHE_SETTING, *PDISK_CACHE_SETTING; + + +// +// IOCTL for moving copying a run of sectors from one location of the disk +// to another. The caller of this IOCTL needs to be prepared for the call to +// fail and do the copy manually since this IOCTL will only rarely be +// implemented. +// + +#define IOCTL_DISK_COPY_DATA CTL_CODE(IOCTL_DISK_BASE, 0x0019, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// This structure is passed in for a IOCTL_DISK_COPY_DATA call. +// + +typedef struct _DISK_COPY_DATA_PARAMETERS { + + // + // Byte offset from which to start the copy. + // + LARGE_INTEGER SourceOffset; + + // + // Byte offset of the copy destination. + // + LARGE_INTEGER DestinationOffset; + + // + // Length, in bytes, of the copy. + // + LARGE_INTEGER CopyLength; + + // + // Must be 0. + // + ULONGLONG Reserved; + + +} DISK_COPY_DATA_PARAMETERS, *PDISK_COPY_DATA_PARAMETERS; + +// +// Internal disk driver device controls to maintain the verify status bit +// for the device object. +// + +#define IOCTL_DISK_INTERNAL_SET_VERIFY CTL_CODE(IOCTL_DISK_BASE, 0x0100, METHOD_NEITHER, FILE_ANY_ACCESS) +#define IOCTL_DISK_INTERNAL_CLEAR_VERIFY CTL_CODE(IOCTL_DISK_BASE, 0x0101, METHOD_NEITHER, FILE_ANY_ACCESS) + +// +// Internal disk driver device control to set notification routine for +// the device object. Used in DiskPerf. +// + +#define IOCTL_DISK_INTERNAL_SET_NOTIFY CTL_CODE(IOCTL_DISK_BASE, 0x0102, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// begin_winioctl +// +// The following device control codes are common for all class drivers. The +// functions codes defined here must match all of the other class drivers. +// +// Warning: these codes will be replaced in the future by equivalent +// IOCTL_STORAGE codes +// + +#define IOCTL_DISK_CHECK_VERIFY CTL_CODE(IOCTL_DISK_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_MEDIA_REMOVAL CTL_CODE(IOCTL_DISK_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_EJECT_MEDIA CTL_CODE(IOCTL_DISK_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_LOAD_MEDIA CTL_CODE(IOCTL_DISK_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_RESERVE CTL_CODE(IOCTL_DISK_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_RELEASE CTL_CODE(IOCTL_DISK_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_FIND_NEW_DEVICES CTL_CODE(IOCTL_DISK_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_GET_MEDIA_TYPES CTL_CODE(IOCTL_DISK_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// end_winioctl + +// +// The following file contains the IOCTL_STORAGE class ioctls +// + +#include + +// begin_winioctl +// +// Define the partition types returnable by known disk drivers. +// + +#define PARTITION_ENTRY_UNUSED 0x00 // Entry unused +#define PARTITION_FAT_12 0x01 // 12-bit FAT entries +#define PARTITION_XENIX_1 0x02 // Xenix +#define PARTITION_XENIX_2 0x03 // Xenix +#define PARTITION_FAT_16 0x04 // 16-bit FAT entries +#define PARTITION_EXTENDED 0x05 // Extended partition entry +#define PARTITION_HUGE 0x06 // Huge partition MS-DOS V4 +#define PARTITION_IFS 0x07 // IFS Partition +#define PARTITION_OS2BOOTMGR 0x0A // OS/2 Boot Manager/OPUS/Coherent swap +#define PARTITION_FAT32 0x0B // FAT32 +#define PARTITION_FAT32_XINT13 0x0C // FAT32 using extended int13 services +#define PARTITION_XINT13 0x0E // Win95 partition using extended int13 services +#define PARTITION_XINT13_EXTENDED 0x0F // Same as type 5 but uses extended int13 services +#define PARTITION_MSFT_RECOVERY 0x27 // Microsoft recovery partition +#define PARTITION_MAIN_OS 0x28 // Main OS partition +#define PARTIITON_OS_DATA 0x29 // OS data partition +#define PARTITION_PRE_INSTALLED 0x2a // PreInstalled partition +#define PARTITION_BSP 0x2b // BSP partition +#define PARTITION_DPP 0x2c // DPP partition +#define PARTITION_WINDOWS_SYSTEM 0x2d // Windows system partition +#define PARTITION_PREP 0x41 // PowerPC Reference Platform (PReP) Boot Partition +#define PARTITION_LDM 0x42 // Logical Disk Manager partition +#define PARTITION_DM 0x54 // OnTrack Disk Manager partition +#define PARTITION_EZDRIVE 0x55 // EZ-Drive partition +#define PARTITION_UNIX 0x63 // Unix +#define PARTITION_SPACES_DATA 0xD7 // Storage Spaces protective partition +#define PARTITION_SPACES 0xE7 // Storage Spaces protective partition +#define PARTITION_GPT 0xEE // Gpt protective partition +#define PARTITION_SYSTEM 0xEF // System partition + +#define VALID_NTFT 0xC0 // NTFT uses high order bits + +// +// The high bit of the partition type code indicates that a partition +// is part of an NTFT mirror or striped array. +// + +#define PARTITION_NTFT 0x80 // NTFT partition + +// +// The following macro is used to determine which partitions should be +// assigned drive letters. +// + +//++ +// +// BOOLEAN +// IsRecognizedPartition( +// IN ULONG PartitionType +// ) +// +// Routine Description: +// +// This macro is used to determine to which partitions drive letters +// should be assigned. +// +// Arguments: +// +// PartitionType - Supplies the type of the partition being examined. +// +// Return Value: +// +// The return value is TRUE if the partition type is recognized, +// otherwise FALSE is returned. +// +//-- +#if (NTDDI_VERSION < NTDDI_VISTA) +#define IsRecognizedPartition( PartitionType ) ( \ + ((PartitionType & PARTITION_NTFT) && (((PartitionType & ~0xC0) == PARTITION_HUGE) || \ + ((PartitionType & ~0xC0) == PARTITION_IFS) || \ + ((PartitionType & ~0xC0) == PARTITION_FAT32) || \ + ((PartitionType & ~0xC0) == PARTITION_FAT32_XINT13))) || \ + ((PartitionType) == PARTITION_FAT_12) || \ + ((PartitionType) == PARTITION_FAT_16) || \ + ((PartitionType) == PARTITION_HUGE) || \ + ((PartitionType) == PARTITION_IFS) || \ + ((PartitionType) == PARTITION_FAT32) || \ + ((PartitionType) == PARTITION_FAT32_XINT13) || \ + ((PartitionType) == PARTITION_XINT13) ) +#else +#define IsRecognizedPartition( PartitionType ) ( \ + ((PartitionType) == PARTITION_BSP) || \ + ((PartitionType) == PARTITION_DPP) || \ + ((PartitionType) == PARTITION_FAT_12) || \ + ((PartitionType) == PARTITION_FAT_16) || \ + ((PartitionType) == PARTITION_FAT32) || \ + ((PartitionType) == PARTITION_FAT32_XINT13) || \ + ((PartitionType) == PARTITION_HUGE) || \ + ((PartitionType) == PARTITION_IFS) || \ + ((PartitionType) == PARTITION_MAIN_OS) || \ + ((PartitionType) == PARTITION_MSFT_RECOVERY) || \ + ((PartitionType) == PARTIITON_OS_DATA) || \ + ((PartitionType) == PARTITION_PRE_INSTALLED) || \ + ((PartitionType) == PARTITION_SYSTEM) || \ + ((PartitionType) == PARTITION_WINDOWS_SYSTEM) || \ + ((PartitionType) == PARTITION_XINT13) ) +#endif + +//++ +// +// BOOLEAN +// IsContainerPartition( +// IN ULONG PartitionType +// ) +// +// Routine Description: +// +// This macro is used to determine to which partition types are actually +// containers for other partitions (ie, extended partitions). +// +// Arguments: +// +// PartitionType - Supplies the type of the partition being examined. +// +// Return Value: +// +// The return value is TRUE if the partition type is a container, +// otherwise FALSE is returned. +// +//-- + +#define IsContainerPartition( PartitionType ) \ + ((PartitionType == PARTITION_EXTENDED) || (PartitionType == PARTITION_XINT13_EXTENDED)) + +//++ +// +// BOOLEAN +// IsFTPartition( +// IN ULONG PartitionType +// ) +// +// Routine Description: +// +// This macro is used to determine if the given partition is an FT +// partition. +// +// Arguments: +// +// PartitionType - Supplies the type of the partition being examined. +// +// Return Value: +// +// The return value is TRUE if the partition type is an FT partition, +// otherwise FALSE is returned. +// +//-- + +#define IsFTPartition( PartitionType ) \ + ((PartitionType & PARTITION_NTFT) && (((PartitionType & ~0xC0) == PARTITION_HUGE) || \ + ((PartitionType & ~0xC0) == PARTITION_IFS) || \ + ((PartitionType & ~0xC0) == PARTITION_FAT32) || \ + ((PartitionType & ~0xC0) == PARTITION_FAT32_XINT13))) + +// +// Define the media types supported by the driver. +// + +typedef enum _MEDIA_TYPE { + Unknown, // Format is unknown + F5_1Pt2_512, // 5.25", 1.2MB, 512 bytes/sector + F3_1Pt44_512, // 3.5", 1.44MB, 512 bytes/sector + F3_2Pt88_512, // 3.5", 2.88MB, 512 bytes/sector + F3_20Pt8_512, // 3.5", 20.8MB, 512 bytes/sector + F3_720_512, // 3.5", 720KB, 512 bytes/sector + F5_360_512, // 5.25", 360KB, 512 bytes/sector + F5_320_512, // 5.25", 320KB, 512 bytes/sector + F5_320_1024, // 5.25", 320KB, 1024 bytes/sector + F5_180_512, // 5.25", 180KB, 512 bytes/sector + F5_160_512, // 5.25", 160KB, 512 bytes/sector + RemovableMedia, // Removable media other than floppy + FixedMedia, // Fixed hard disk media + F3_120M_512, // 3.5", 120M Floppy + F3_640_512, // 3.5" , 640KB, 512 bytes/sector + F5_640_512, // 5.25", 640KB, 512 bytes/sector + F5_720_512, // 5.25", 720KB, 512 bytes/sector + F3_1Pt2_512, // 3.5" , 1.2Mb, 512 bytes/sector + F3_1Pt23_1024, // 3.5" , 1.23Mb, 1024 bytes/sector + F5_1Pt23_1024, // 5.25", 1.23MB, 1024 bytes/sector + F3_128Mb_512, // 3.5" MO 128Mb 512 bytes/sector + F3_230Mb_512, // 3.5" MO 230Mb 512 bytes/sector + F8_256_128, // 8", 256KB, 128 bytes/sector + F3_200Mb_512, // 3.5", 200M Floppy (HiFD) + F3_240M_512, // 3.5", 240Mb Floppy (HiFD) + F3_32M_512 // 3.5", 32Mb Floppy +} MEDIA_TYPE, *PMEDIA_TYPE; + +// +// Define the input buffer structure for the driver, when +// it is called with IOCTL_DISK_FORMAT_TRACKS. +// + +typedef struct _FORMAT_PARAMETERS { + MEDIA_TYPE MediaType; + ULONG StartCylinderNumber; + ULONG EndCylinderNumber; + ULONG StartHeadNumber; + ULONG EndHeadNumber; +} FORMAT_PARAMETERS, *PFORMAT_PARAMETERS; + +// +// Define the BAD_TRACK_NUMBER type. An array of elements of this type is +// returned by the driver on IOCTL_DISK_FORMAT_TRACKS requests, to indicate +// what tracks were bad during formatting. The length of that array is +// reported in the `Information' field of the I/O Status Block. +// + +typedef USHORT BAD_TRACK_NUMBER; +typedef USHORT *PBAD_TRACK_NUMBER; + +// +// Define the input buffer structure for the driver, when +// it is called with IOCTL_DISK_FORMAT_TRACKS_EX. +// + +typedef struct _FORMAT_EX_PARAMETERS { + MEDIA_TYPE MediaType; + ULONG StartCylinderNumber; + ULONG EndCylinderNumber; + ULONG StartHeadNumber; + ULONG EndHeadNumber; + USHORT FormatGapLength; + USHORT SectorsPerTrack; + USHORT SectorNumber[1]; +} FORMAT_EX_PARAMETERS, *PFORMAT_EX_PARAMETERS; + +// +// The following structure is returned on an IOCTL_DISK_GET_DRIVE_GEOMETRY +// request and an array of them is returned on an IOCTL_DISK_GET_MEDIA_TYPES +// request. +// + +typedef struct _DISK_GEOMETRY { + + LARGE_INTEGER Cylinders; + + MEDIA_TYPE MediaType; + + ULONG TracksPerCylinder; + + ULONG SectorsPerTrack; + + ULONG BytesPerSector; + +} DISK_GEOMETRY, *PDISK_GEOMETRY; + + + +// +// This wmi guid returns a DISK_GEOMETRY structure +// +#define WMI_DISK_GEOMETRY_GUID { 0x25007f51, 0x57c2, 0x11d1, { 0xa5, 0x28, 0x0, 0xa0, 0xc9, 0x6, 0x29, 0x10 } } + + + +// +// The following structure is returned on an IOCTL_DISK_GET_PARTITION_INFO +// and an IOCTL_DISK_GET_DRIVE_LAYOUT request. It is also used in a request +// to change the drive layout, IOCTL_DISK_SET_DRIVE_LAYOUT. +// + +typedef struct _PARTITION_INFORMATION { + LARGE_INTEGER StartingOffset; + LARGE_INTEGER PartitionLength; + ULONG HiddenSectors; + ULONG PartitionNumber; + UCHAR PartitionType; + BOOLEAN BootIndicator; + BOOLEAN RecognizedPartition; + BOOLEAN RewritePartition; +} PARTITION_INFORMATION, *PPARTITION_INFORMATION; + +// +// The following structure is used to change the partition type of a +// specified disk partition using an IOCTL_DISK_SET_PARTITION_INFO +// request. +// + +typedef struct _SET_PARTITION_INFORMATION { + UCHAR PartitionType; +} SET_PARTITION_INFORMATION, *PSET_PARTITION_INFORMATION; + +// +// The following structures is returned on an IOCTL_DISK_GET_DRIVE_LAYOUT +// request and given as input to an IOCTL_DISK_SET_DRIVE_LAYOUT request. +// + +typedef struct _DRIVE_LAYOUT_INFORMATION { + ULONG PartitionCount; + ULONG Signature; + PARTITION_INFORMATION PartitionEntry[1]; +} DRIVE_LAYOUT_INFORMATION, *PDRIVE_LAYOUT_INFORMATION; + +// +// The following structure is passed in on an IOCTL_DISK_VERIFY request. +// The offset and length parameters are both given in bytes. +// + +typedef struct _VERIFY_INFORMATION { + LARGE_INTEGER StartingOffset; + ULONG Length; +} VERIFY_INFORMATION, *PVERIFY_INFORMATION; + +// +// The following structure is passed in on an IOCTL_DISK_REASSIGN_BLOCKS +// request. +// + +typedef struct _REASSIGN_BLOCKS { + USHORT Reserved; + USHORT Count; + ULONG BlockNumber[1]; +} REASSIGN_BLOCKS, *PREASSIGN_BLOCKS; + +// +// The following structure is passed in on an IOCTL_DISK_REASSIGN_BLOCKS_EX +// request. +// + +#include +typedef struct _REASSIGN_BLOCKS_EX { + USHORT Reserved; + USHORT Count; + LARGE_INTEGER BlockNumber[1]; +} REASSIGN_BLOCKS_EX, *PREASSIGN_BLOCKS_EX; +#include + + +#if(_WIN32_WINNT >= 0x500) + +// +// Support for GUID Partition Table (GPT) disks. +// + +// +// There are currently two ways a disk can be partitioned. With a traditional +// AT-style master boot record (PARTITION_STYLE_MBR) and with a new, GPT +// partition table (PARTITION_STYLE_GPT). RAW is for an unrecognizable +// partition style. There are a very limited number of things you can +// do with a RAW partititon. +// + +typedef enum _PARTITION_STYLE { + PARTITION_STYLE_MBR, + PARTITION_STYLE_GPT, + PARTITION_STYLE_RAW +} PARTITION_STYLE; + + +// +// The following structure defines information in a GPT partition that is +// not common to both GPT and MBR partitions. +// + +typedef struct _PARTITION_INFORMATION_GPT { + + GUID PartitionType; // Partition type. See table 16-3. + + GUID PartitionId; // Unique GUID for this partition. + + ULONG64 Attributes; // See table 16-4. + + WCHAR Name [36]; // Partition Name in Unicode. + +} PARTITION_INFORMATION_GPT, *PPARTITION_INFORMATION_GPT; + +// +// The following are GPT partition attributes applicable for any +// partition type. These attributes are not OS-specific +// + +#define GPT_ATTRIBUTE_PLATFORM_REQUIRED (0x0000000000000001) +#define GPT_ATTRIBUTE_NO_BLOCK_IO_PROTOCOL (0x0000000000000002) +#define GPT_ATTRIBUTE_LEGACY_BIOS_BOOTABLE (0x0000000000000004) + +// +// The following are GPT partition attributes applicable when the +// PartitionType is PARTITION_BASIC_DATA_GUID. +// + +#define GPT_BASIC_DATA_ATTRIBUTE_NO_DRIVE_LETTER (0x8000000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_HIDDEN (0x4000000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_SHADOW_COPY (0x2000000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_READ_ONLY (0x1000000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_OFFLINE (0x0800000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_DAX (0x0400000000000000) +#define GPT_BASIC_DATA_ATTRIBUTE_SERVICE (0x0200000000000000) + +// +// The following are GPT partition attributes applicable when the +// PartitionType is PARTITION_SPACES_GUID. +// + +#define GPT_SPACES_ATTRIBUTE_NO_METADATA (0x8000000000000000) + +// +// The following structure defines information in an MBR partition that is not +// common to both GPT and MBR partitions. +// + +typedef struct _PARTITION_INFORMATION_MBR { + + UCHAR PartitionType; + + BOOLEAN BootIndicator; + + BOOLEAN RecognizedPartition; + + ULONG HiddenSectors; + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) /* ABRACADABRA_THRESHOLD */ + GUID PartitionId; +#endif + +} PARTITION_INFORMATION_MBR, *PPARTITION_INFORMATION_MBR; + + +// +// The structure SET_PARTITION_INFO_EX is used with the ioctl +// IOCTL_SET_PARTITION_INFO_EX to set information about a specific +// partition. Note that for MBR partitions, you can only set the partition +// signature, whereas GPT partitions allow setting of all fields that +// you can get. +// + +typedef SET_PARTITION_INFORMATION SET_PARTITION_INFORMATION_MBR; +typedef PARTITION_INFORMATION_GPT SET_PARTITION_INFORMATION_GPT; + + +typedef struct _SET_PARTITION_INFORMATION_EX { + PARTITION_STYLE PartitionStyle; + union { + SET_PARTITION_INFORMATION_MBR Mbr; + SET_PARTITION_INFORMATION_GPT Gpt; + } DUMMYUNIONNAME; +} SET_PARTITION_INFORMATION_EX, *PSET_PARTITION_INFORMATION_EX; + + +// +// The structure CREATE_DISK_GPT with the ioctl IOCTL_DISK_CREATE_DISK +// to initialize a disk with an empty GPT partition table. +// + +typedef struct _CREATE_DISK_GPT { + GUID DiskId; // Unique disk id for the disk. + ULONG MaxPartitionCount; // Maximim number of partitions allowable. +} CREATE_DISK_GPT, *PCREATE_DISK_GPT; + +// +// The structure CREATE_DISK_MBR with the ioctl IOCTL_DISK_CREATE_DISK +// to initialize a disk with an empty MBR partition table. +// + +typedef struct _CREATE_DISK_MBR { + ULONG Signature; +} CREATE_DISK_MBR, *PCREATE_DISK_MBR; + + +typedef struct _CREATE_DISK { + PARTITION_STYLE PartitionStyle; + union { + CREATE_DISK_MBR Mbr; + CREATE_DISK_GPT Gpt; + } DUMMYUNIONNAME; +} CREATE_DISK, *PCREATE_DISK; + + +// +// The structure GET_LENGTH_INFORMATION is used with the ioctl +// IOCTL_DISK_GET_LENGTH_INFO to obtain the length, in bytes, of the +// disk, partition, or volume. +// + +typedef struct _GET_LENGTH_INFORMATION { + LARGE_INTEGER Length; +} GET_LENGTH_INFORMATION, *PGET_LENGTH_INFORMATION; + +// +// The PARTITION_INFORMATION_EX structure is used with the +// IOCTL_DISK_GET_DRIVE_LAYOUT_EX, IOCTL_DISK_SET_DRIVE_LAYOUT_EX, +// IOCTL_DISK_GET_PARTITION_INFO_EX and IOCTL_DISK_SET_PARTITION_INFO_EX calls. +// + +typedef struct _PARTITION_INFORMATION_EX { + + PARTITION_STYLE PartitionStyle; + + LARGE_INTEGER StartingOffset; + + LARGE_INTEGER PartitionLength; + + ULONG PartitionNumber; + + BOOLEAN RewritePartition; + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) /* ABRACADABRA_WIN10_RS3 */ + BOOLEAN IsServicePartition; +#endif + + union { + + PARTITION_INFORMATION_MBR Mbr; + + PARTITION_INFORMATION_GPT Gpt; + + } DUMMYUNIONNAME; + +} PARTITION_INFORMATION_EX, *PPARTITION_INFORMATION_EX; + + +// +// GPT specific drive layout information. +// + +typedef struct _DRIVE_LAYOUT_INFORMATION_GPT { + + GUID DiskId; + + LARGE_INTEGER StartingUsableOffset; + + LARGE_INTEGER UsableLength; + + ULONG MaxPartitionCount; + +} DRIVE_LAYOUT_INFORMATION_GPT, *PDRIVE_LAYOUT_INFORMATION_GPT; + + +// +// MBR specific drive layout information. +// + +typedef struct _DRIVE_LAYOUT_INFORMATION_MBR { + + ULONG Signature; + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) /* ABRACADABRA_WIN10_RS1 */ + ULONG CheckSum; +#endif + +} DRIVE_LAYOUT_INFORMATION_MBR, *PDRIVE_LAYOUT_INFORMATION_MBR; + +// +// The structure DRIVE_LAYOUT_INFORMATION_EX is used with the +// IOCTL_SET_DRIVE_LAYOUT_EX and IOCTL_GET_DRIVE_LAYOUT_EX calls. +// + +typedef struct _DRIVE_LAYOUT_INFORMATION_EX { + + ULONG PartitionStyle; + + ULONG PartitionCount; + + union { + + DRIVE_LAYOUT_INFORMATION_MBR Mbr; + + DRIVE_LAYOUT_INFORMATION_GPT Gpt; + + } DUMMYUNIONNAME; + + PARTITION_INFORMATION_EX PartitionEntry[1]; + +} DRIVE_LAYOUT_INFORMATION_EX, *PDRIVE_LAYOUT_INFORMATION_EX; + + +#endif // (_WIN32_WINNT >= 0x0500) + + +#if(_WIN32_WINNT >= 0x0500) + +// +// The DISK_GEOMETRY_EX structure is returned on issuing an +// IOCTL_DISK_GET_DRIVE_GEOMETRY_EX ioctl. +// + +typedef enum _DETECTION_TYPE { + DetectNone, + DetectInt13, + DetectExInt13 +} DETECTION_TYPE; + +typedef struct _DISK_INT13_INFO { + USHORT DriveSelect; + ULONG MaxCylinders; + USHORT SectorsPerTrack; + USHORT MaxHeads; + USHORT NumberDrives; +} DISK_INT13_INFO, *PDISK_INT13_INFO; + +typedef struct _DISK_EX_INT13_INFO { + USHORT ExBufferSize; + USHORT ExFlags; + ULONG ExCylinders; + ULONG ExHeads; + ULONG ExSectorsPerTrack; + ULONG64 ExSectorsPerDrive; + USHORT ExSectorSize; + USHORT ExReserved; +} DISK_EX_INT13_INFO, *PDISK_EX_INT13_INFO; + +#if (_MSC_VER >= 1200) +#pragma warning(push) +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union +#endif + +typedef struct _DISK_DETECTION_INFO { + ULONG SizeOfDetectInfo; + DETECTION_TYPE DetectionType; + union { + struct { + + // + // If DetectionType == DETECTION_INT13 then we have just the Int13 + // information. + // + + DISK_INT13_INFO Int13; + + // + // If DetectionType == DETECTION_EX_INT13, then we have the + // extended int 13 information. + // + + DISK_EX_INT13_INFO ExInt13; // If DetectionType == DetectExInt13 + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; +} DISK_DETECTION_INFO, *PDISK_DETECTION_INFO; + + +typedef struct _DISK_PARTITION_INFO { + ULONG SizeOfPartitionInfo; + PARTITION_STYLE PartitionStyle; // PartitionStyle = RAW, GPT or MBR + union { + struct { // If PartitionStyle == MBR + ULONG Signature; // MBR Signature + ULONG CheckSum; // MBR CheckSum + } Mbr; + struct { // If PartitionStyle == GPT + GUID DiskId; + } Gpt; + } DUMMYUNIONNAME; +} DISK_PARTITION_INFO, *PDISK_PARTITION_INFO; + +#if (_MSC_VER >= 1200) +#pragma warning(pop) +#endif + +// +// The Geometry structure is a variable length structure composed of a +// DISK_GEOMETRY_EX structure followed by a DISK_PARTITION_INFO structure +// followed by a DISK_DETECTION_DATA structure. +// + +#if (NTDDI_VERSION < NTDDI_WS03) +#define DiskGeometryGetPartition(Geometry)\ + ((PDISK_PARTITION_INFO)((Geometry)+1)) + +#define DiskGeometryGetDetect(Geometry)\ + ((PDISK_DETECTION_INFO)(((PBYTE)DiskGeometryGetPartition(Geometry)+\ + DiskGeometryGetPartition(Geometry)->SizeOfPartitionInfo))) +#else +#define DiskGeometryGetPartition(Geometry)\ + ((PDISK_PARTITION_INFO)((Geometry)->Data)) + +#define DiskGeometryGetDetect(Geometry)\ + ((PDISK_DETECTION_INFO)(((ULONG_PTR)DiskGeometryGetPartition(Geometry)+\ + DiskGeometryGetPartition(Geometry)->SizeOfPartitionInfo))) +#endif +typedef struct _DISK_GEOMETRY_EX { + DISK_GEOMETRY Geometry; // Standard disk geometry: may be faked by driver. + LARGE_INTEGER DiskSize; // Must always be correct + UCHAR Data[1]; // Partition, Detect info +} DISK_GEOMETRY_EX, *PDISK_GEOMETRY_EX; + +#endif // (_WIN32_WINNT > 0x0500) + +#if(_WIN32_WINNT >= 0x0400) +// +// IOCTL_DISK_CONTROLLER_NUMBER returns the controller and disk +// number for the handle. This is used to determine if a disk +// is attached to the primary or secondary IDE controller. +// + +typedef struct _DISK_CONTROLLER_NUMBER { + ULONG ControllerNumber; + ULONG DiskNumber; +} DISK_CONTROLLER_NUMBER, *PDISK_CONTROLLER_NUMBER; +#endif /* _WIN32_WINNT >= 0x0400 */ + +#if(_WIN32_WINNT >= 0x0500) + +// +// IOCTL_DISK_SET_CACHE_INFORMATION +// +// Input Buffer: +// A DISK_CACHE_INFORMATION structure which describes how the disk +// read/write caches should be configured. +// +// Output Buffer: +// None +// + +// +// IOCTL_DISK_GET_CACHE_INFORMATION +// +// Input Buffer: +// None +// +// Output Buffer: +// A DISK_CACHE_INFORMATION structure which contains the current state +// of the disk read/write caches. +// + +typedef enum { + EqualPriority, + KeepPrefetchedData, + KeepReadData +} DISK_CACHE_RETENTION_PRIORITY; + +#if (OSVER(NTDDI_VERSION) == NTDDI_WINXP) +typedef enum _DISK_WRITE_CACHE_STATE { + DiskWriteCacheNormal, + DiskWriteCacheForceDisable, + DiskWriteCacheDisableNotSupported +} DISK_WRITE_CACHE_STATE, *PDISK_WRITE_CACHE_STATE; +#endif + +typedef struct _DISK_CACHE_INFORMATION { + + // + // on return indicates that the device is capable of saving any parameters + // in non-volatile storage. On send indicates that the device should + // save the state in non-volatile storage. + // + + BOOLEAN ParametersSavable; + + // + // Indicates whether the write and read caches are enabled. + // + + BOOLEAN ReadCacheEnabled; + BOOLEAN WriteCacheEnabled; + + // + // Controls the likelyhood of data remaining in the cache depending on how + // it got there. Data cached from a READ or WRITE operation may be given + // higher, lower or equal priority to data entered into the cache for other + // means (like prefetch) + // + + DISK_CACHE_RETENTION_PRIORITY ReadRetentionPriority; + DISK_CACHE_RETENTION_PRIORITY WriteRetentionPriority; + + // + // Requests for a larger number of blocks than this may have prefetching + // disabled. If this value is set to 0 prefetch will be disabled. + // + + USHORT DisablePrefetchTransferLength; + + // + // If TRUE then ScalarPrefetch (below) will be valid. If FALSE then + // the minimum and maximum values should be treated as a block count + // (BlockPrefetch) + // + + BOOLEAN PrefetchScalar; + + // + // Contains the minimum and maximum amount of data which will be + // will be prefetched into the cache on a disk operation. This value + // may either be a scalar multiplier of the transfer length of the request, + // or an abolute number of disk blocks. PrefetchScalar (above) indicates + // which interpretation is used. + // + + union { + struct { + USHORT Minimum; + USHORT Maximum; + + // + // The maximum number of blocks which will be prefetched - useful + // with the scalar limits to set definite upper limits. + // + + USHORT MaximumBlocks; + } ScalarPrefetch; + + struct { + USHORT Minimum; + USHORT Maximum; + } BlockPrefetch; + } DUMMYUNIONNAME; + +} DISK_CACHE_INFORMATION, *PDISK_CACHE_INFORMATION; + + +// +// IOCTL_DISK_GROW_PARTITION will update the size of a partition +// by adding sectors to the length. The number of sectors must be +// predetermined by examining PARTITION_INFORMATION. +// + +typedef struct _DISK_GROW_PARTITION { + ULONG PartitionNumber; + LARGE_INTEGER BytesToGrow; +} DISK_GROW_PARTITION, *PDISK_GROW_PARTITION; +#endif /* _WIN32_WINNT >= 0x0500 */ + +/////////////////////////////////////////////////////// +// // +// The following structures define disk performance // +// statistics: specifically the locations of all the // +// reads and writes which have occured on the disk. // +// // +// To use these structures, you must issue an IOCTL_ // +// DISK_HIST_STRUCTURE (with a DISK_HISTOGRAM) to // +// obtain the basic histogram information. The // +// number of buckets which must allocated is part of // +// this structure. Allocate the required number of // +// buckets and call an IOCTL_DISK_HIST_DATA to fill // +// in the data // +// // +/////////////////////////////////////////////////////// + +#define HIST_NO_OF_BUCKETS 24 + +typedef struct _HISTOGRAM_BUCKET { + ULONG Reads; + ULONG Writes; +} HISTOGRAM_BUCKET, *PHISTOGRAM_BUCKET; + +#define HISTOGRAM_BUCKET_SIZE sizeof(HISTOGRAM_BUCKET) + +typedef struct _DISK_HISTOGRAM { + LARGE_INTEGER DiskSize; + LARGE_INTEGER Start; + LARGE_INTEGER End; + LARGE_INTEGER Average; + LARGE_INTEGER AverageRead; + LARGE_INTEGER AverageWrite; + ULONG Granularity; + ULONG Size; + ULONG ReadCount; + ULONG WriteCount; + PHISTOGRAM_BUCKET Histogram; +} DISK_HISTOGRAM, *PDISK_HISTOGRAM; + +#define DISK_HISTOGRAM_SIZE sizeof(DISK_HISTOGRAM) + +/////////////////////////////////////////////////////// +// // +// The following structures define disk debugging // +// capabilities. The IOCTLs are directed to one of // +// the two disk filter drivers. // +// // +// DISKPERF is a utilty for collecting disk request // +// statistics. // +// // +// SIMBAD is a utility for injecting faults in // +// IO requests to disks. // +// // +/////////////////////////////////////////////////////// + +// +// The following structure is exchanged on an IOCTL_DISK_GET_PERFORMANCE +// request. This ioctl collects summary disk request statistics used +// in measuring performance. +// + +typedef struct _DISK_PERFORMANCE { + LARGE_INTEGER BytesRead; + LARGE_INTEGER BytesWritten; + LARGE_INTEGER ReadTime; + LARGE_INTEGER WriteTime; + LARGE_INTEGER IdleTime; + ULONG ReadCount; + ULONG WriteCount; + ULONG QueueDepth; + ULONG SplitCount; + LARGE_INTEGER QueryTime; + ULONG StorageDeviceNumber; + WCHAR StorageManagerName[8]; +} DISK_PERFORMANCE, *PDISK_PERFORMANCE; + +// +// This structure defines the disk logging record. When disk logging +// is enabled, one of these is written to an internal buffer for each +// disk request. +// + +typedef struct _DISK_RECORD { + LARGE_INTEGER ByteOffset; + LARGE_INTEGER StartTime; + LARGE_INTEGER EndTime; + PVOID VirtualAddress; + ULONG NumberOfBytes; + UCHAR DeviceNumber; + BOOLEAN ReadRequest; +} DISK_RECORD, *PDISK_RECORD; + +// +// The following structure is exchanged on an IOCTL_DISK_LOG request. +// Not all fields are valid with each function type. +// + +typedef struct _DISK_LOGGING { + UCHAR Function; + PVOID BufferAddress; + ULONG BufferSize; +} DISK_LOGGING, *PDISK_LOGGING; + +// +// Disk logging functions +// +// Start disk logging. Only the Function and BufferSize fields are valid. +// + +#define DISK_LOGGING_START 0 + +// +// Stop disk logging. Only the Function field is valid. +// + +#define DISK_LOGGING_STOP 1 + +// +// Return disk log. All fields are valid. Data will be copied from internal +// buffer to buffer specified for the number of bytes requested. +// + +#define DISK_LOGGING_DUMP 2 + +// +// DISK BINNING +// +// DISKPERF will keep counters for IO that falls in each of these ranges. +// The application determines the number and size of the ranges. +// Joe Lin wanted me to keep it flexible as possible, for instance, IO +// sizes are interesting in ranges like 0-4096, 4097-16384, 16385-65536, 65537+. +// + +#define DISK_BINNING 3 + +// +// Bin types +// + +typedef enum _BIN_TYPES { + RequestSize, + RequestLocation +} BIN_TYPES; + +// +// Bin ranges +// + +typedef struct _BIN_RANGE { + LARGE_INTEGER StartValue; + LARGE_INTEGER Length; +} BIN_RANGE, *PBIN_RANGE; + +// +// Bin definition +// + +typedef struct _PERF_BIN { + ULONG NumberOfBins; + ULONG TypeOfBin; + BIN_RANGE BinsRanges[1]; +} PERF_BIN, *PPERF_BIN ; + +// +// Bin count +// + +typedef struct _BIN_COUNT { + BIN_RANGE BinRange; + ULONG BinCount; +} BIN_COUNT, *PBIN_COUNT; + +// +// Bin results +// + +typedef struct _BIN_RESULTS { + ULONG NumberOfBins; + BIN_COUNT BinCounts[1]; +} BIN_RESULTS, *PBIN_RESULTS; + +#if(_WIN32_WINNT >= 0x0400) +// +// Data structures for SMART drive fault prediction. +// +// GETVERSIONINPARAMS contains the data returned from the +// Get Driver Version function. +// + +#include +typedef struct _GETVERSIONINPARAMS { + UCHAR bVersion; // Binary driver version. + UCHAR bRevision; // Binary driver revision. + UCHAR bReserved; // Not used. + UCHAR bIDEDeviceMap; // Bit map of IDE devices. + ULONG fCapabilities; // Bit mask of driver capabilities. + ULONG dwReserved[4]; // For future use. +} GETVERSIONINPARAMS, *PGETVERSIONINPARAMS, *LPGETVERSIONINPARAMS; +#include + +// +// Bits returned in the fCapabilities member of GETVERSIONINPARAMS +// + +#define CAP_ATA_ID_CMD 1 // ATA ID command supported +#define CAP_ATAPI_ID_CMD 2 // ATAPI ID command supported +#define CAP_SMART_CMD 4 // SMART commannds supported + +// +// IDE registers +// + +#include +typedef struct _IDEREGS { + UCHAR bFeaturesReg; // Used for specifying SMART "commands". + UCHAR bSectorCountReg; // IDE sector count register + UCHAR bSectorNumberReg; // IDE sector number register + UCHAR bCylLowReg; // IDE low order cylinder value + UCHAR bCylHighReg; // IDE high order cylinder value + UCHAR bDriveHeadReg; // IDE drive/head register + UCHAR bCommandReg; // Actual IDE command. + UCHAR bReserved; // reserved for future use. Must be zero. +} IDEREGS, *PIDEREGS, *LPIDEREGS; +#include + +// +// Valid values for the bCommandReg member of IDEREGS. +// + +#define ATAPI_ID_CMD 0xA1 // Returns ID sector for ATAPI. +#define ID_CMD 0xEC // Returns ID sector for ATA. +#define SMART_CMD 0xB0 // Performs SMART cmd. + // Requires valid bFeaturesReg, + // bCylLowReg, and bCylHighReg + +// +// Cylinder register defines for SMART command +// + +#define SMART_CYL_LOW 0x4F +#define SMART_CYL_HI 0xC2 + + +// +// SENDCMDINPARAMS contains the input parameters for the +// Send Command to Drive function. +// + +#include +typedef struct _SENDCMDINPARAMS { + ULONG cBufferSize; // Buffer size in bytes + IDEREGS irDriveRegs; // Structure with drive register values. + UCHAR bDriveNumber; // Physical drive number to send + // command to (0,1,2,3). + UCHAR bReserved[3]; // Reserved for future expansion. + ULONG dwReserved[4]; // For future use. + UCHAR bBuffer[1]; // Input buffer. +} SENDCMDINPARAMS, *PSENDCMDINPARAMS, *LPSENDCMDINPARAMS; +#include + +// +// Status returned from driver +// + +#include +typedef struct _DRIVERSTATUS { + UCHAR bDriverError; // Error code from driver, + // or 0 if no error. + UCHAR bIDEError; // Contents of IDE Error register. + // Only valid when bDriverError + // is SMART_IDE_ERROR. + UCHAR bReserved[2]; // Reserved for future expansion. + ULONG dwReserved[2]; // Reserved for future expansion. +} DRIVERSTATUS, *PDRIVERSTATUS, *LPDRIVERSTATUS; +#include + +// +// bDriverError values +// + +#define SMART_NO_ERROR 0 // No error +#define SMART_IDE_ERROR 1 // Error from IDE controller +#define SMART_INVALID_FLAG 2 // Invalid command flag +#define SMART_INVALID_COMMAND 3 // Invalid command byte +#define SMART_INVALID_BUFFER 4 // Bad buffer (null, invalid addr..) +#define SMART_INVALID_DRIVE 5 // Drive number not valid +#define SMART_INVALID_IOCTL 6 // Invalid IOCTL +#define SMART_ERROR_NO_MEM 7 // Could not lock user's buffer +#define SMART_INVALID_REGISTER 8 // Some IDE Register not valid +#define SMART_NOT_SUPPORTED 9 // Invalid cmd flag set +#define SMART_NO_IDE_DEVICE 10 // Cmd issued to device not present + // although drive number is valid +// +// SMART sub commands for execute offline diags +// +#define SMART_OFFLINE_ROUTINE_OFFLINE 0 +#define SMART_SHORT_SELFTEST_OFFLINE 1 +#define SMART_EXTENDED_SELFTEST_OFFLINE 2 +#define SMART_ABORT_OFFLINE_SELFTEST 127 +#define SMART_SHORT_SELFTEST_CAPTIVE 129 +#define SMART_EXTENDED_SELFTEST_CAPTIVE 130 + + +#include +typedef struct _SENDCMDOUTPARAMS { + ULONG cBufferSize; // Size of bBuffer in bytes + DRIVERSTATUS DriverStatus; // Driver status structure. + UCHAR bBuffer[1]; // Buffer of arbitrary length in which to store the data read from the // drive. +} SENDCMDOUTPARAMS, *PSENDCMDOUTPARAMS, *LPSENDCMDOUTPARAMS; +#include + + +#define READ_ATTRIBUTE_BUFFER_SIZE 512 +#define IDENTIFY_BUFFER_SIZE 512 +#define READ_THRESHOLD_BUFFER_SIZE 512 +#define SMART_LOG_SECTOR_SIZE 512 + +// +// Feature register defines for SMART "sub commands" +// + +#define READ_ATTRIBUTES 0xD0 +#define READ_THRESHOLDS 0xD1 +#define ENABLE_DISABLE_AUTOSAVE 0xD2 +#define SAVE_ATTRIBUTE_VALUES 0xD3 +#define EXECUTE_OFFLINE_DIAGS 0xD4 +#define SMART_READ_LOG 0xD5 +#define SMART_WRITE_LOG 0xd6 +#define ENABLE_SMART 0xD8 +#define DISABLE_SMART 0xD9 +#define RETURN_SMART_STATUS 0xDA +#define ENABLE_DISABLE_AUTO_OFFLINE 0xDB +#endif /* _WIN32_WINNT >= 0x0400 */ + +// end_winioctl + + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +// +// IOCTLs to query and modify attributes +// associated with partitions. These are +// persisted within the partition table. +// + +#define IOCTL_DISK_GET_PARTITION_ATTRIBUTES CTL_CODE(IOCTL_DISK_BASE, 0x003a, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_SET_PARTITION_ATTRIBUTES CTL_CODE(IOCTL_DISK_BASE, 0x003b, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_DISK_GET_PARTITION_ATTRIBUTES +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type GET_PARTITION_ATTRIBUTES +// + +typedef struct _GET_PARTITION_ATTRIBUTES { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // For alignment purposes. + // + ULONG Reserved1; + + // + // Specifies the partition + // attributes. + // + ULONGLONG Attributes; + +} GET_PARTITION_ATTRIBUTES, *PGET_PARTITION_ATTRIBUTES; + +// +// IOCTL_DISK_SET_PARTITION_ATTRIBUTES +// +// Input Buffer: +// Structure of type SET_PARTITION_ATTRIBUTES +// +// Output Buffer: +// None +// + +typedef struct _SET_PARTITION_ATTRIBUTES { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // Indicates whether to remember + // these settings across reboots + // or not. + // + BOOLEAN Persist; + + // + // For alignment purposes. + // + BOOLEAN Reserved1[3]; + + // + // Specifies the new attributes. + // + ULONGLONG Attributes; + + // + // Specifies the attributes + // that are being modified. + // + ULONGLONG AttributesMask; + +} SET_PARTITION_ATTRIBUTES, *PSET_PARTITION_ATTRIBUTES; + + +// begin_winioctl +// +// IOCTLs to query and modify attributes +// associated with the given disk. These +// are persisted within the registry. +// + +#define IOCTL_DISK_GET_DISK_ATTRIBUTES CTL_CODE(IOCTL_DISK_BASE, 0x003c, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_SET_DISK_ATTRIBUTES CTL_CODE(IOCTL_DISK_BASE, 0x003d, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define DISK_ATTRIBUTE_OFFLINE 0x0000000000000001 +#define DISK_ATTRIBUTE_READ_ONLY 0x0000000000000002 +// end_winioctl +#define DISK_ATTRIBUTE_HIDDEN 0x0000000000000004 +#define DISK_ATTRIBUTE_MAINTENANCE 0x0000000000000008 +#define DISK_ATTRIBUTE_SPACES_BYPASS 0x0000000000000010 +#define DISK_ATTRIBUTE_IGNORE_CONFLICTS 0x0000000000000020 +#define DISK_ATTRIBUTE_PASSTHROUGH 0x0000000000000040 + +// begin_winioctl +// +// IOCTL_DISK_GET_DISK_ATTRIBUTES +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type GET_DISK_ATTRIBUTES +// + +typedef struct _GET_DISK_ATTRIBUTES { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // Reserved. Must ignore. + // + ULONG Reserved1; + + // + // Specifies the attributes + // associated with the disk. + // + ULONGLONG Attributes; + +} GET_DISK_ATTRIBUTES, *PGET_DISK_ATTRIBUTES; + +// +// IOCTL_DISK_SET_DISK_ATTRIBUTES +// +// Input Buffer: +// Structure of type SET_DISK_ATTRIBUTES +// +// Output Buffer: +// None +// + +typedef struct _SET_DISK_ATTRIBUTES { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // Indicates whether to remember + // these settings across reboots + // or not. + // + BOOLEAN Persist; +// end_winioctl + + // + // Indicates whether the ownership + // taken earlier is being released. + // + BOOLEAN RelinquishOwnership; + + // + // For alignment purposes. + // + BOOLEAN Reserved1[2]; + + /* + The following field obfuscates + the above two for winioctl.h +// begin_winioctl + + // + // Reserved. Must set to zero. + // + UCHAR Reserved1[3]; +// end_winioctl + */ +// begin_winioctl + + // + // Specifies the new attributes. + // + ULONGLONG Attributes; + + // + // Specifies the attributes + // that are being modified. + // + ULONGLONG AttributesMask; +// end_winioctl + + // + // Specifies an identifier to be + // associated with the caller. + // This setting is not persisted + // across reboots. + // + GUID Owner; + + /* + The following field obfuscates + the GUID above for winioctl.h +// begin_winioctl + + // + // Reserved. Must set to zero. + // + ULONG Reserved2[4]; +// end_winioctl + */ +// begin_winioctl + +} SET_DISK_ATTRIBUTES, *PSET_DISK_ATTRIBUTES; +// end_winioctl + + +// +// IOCTL to determine if the disk is +// owned by the cluster service or not. +// + +#define IOCTL_DISK_IS_CLUSTERED CTL_CODE(IOCTL_DISK_BASE, 0x003e, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_DISK_IS_CLUSTERED +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type BOOLEAN +// + + +// +// IOCTLs to query and modify the current +// SAN settings. For instance, the policy +// associated with newly discovered disks. +// + +#define IOCTL_DISK_GET_SAN_SETTINGS CTL_CODE(IOCTL_DISK_BASE, 0x0080, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_SAN_SETTINGS CTL_CODE(IOCTL_DISK_BASE, 0x0081, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_DISK_GET_SAN_SETTINGS +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type DISK_SAN_SETTINGS +// + +// +// IOCTL_DISK_SET_SAN_SETTINGS +// +// Input Buffer: +// Structure of type DISK_SAN_SETTINGS +// +// Output Buffer: +// None +// + +typedef enum _DISK_SAN_POLICY { + + DiskSanPolicyUnknown, + DiskSanPolicyOnline, + DiskSanPolicyOfflineShared, + DiskSanPolicyOffline, + DiskSanPolicyOfflineInternal, + DiskSanPolicyPassthrough, + DiskSanPolicyMax + +} DISK_SAN_POLICY, *PDISK_SAN_POLICY; + +typedef struct _DISK_SAN_SETTINGS { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // Specifies the policy to be + // applied to all new disks. + // + DISK_SAN_POLICY SanPolicy; + +} DISK_SAN_SETTINGS, *PDISK_SAN_SETTINGS; + + +// +// IOCTLs to query and modify the context +// associated with snapshot disks created +// in hardware. +// + +#define IOCTL_DISK_GET_SNAPSHOT_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0082, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_SET_SNAPSHOT_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0083, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// begin_winioctl + +#define IOCTL_DISK_RESET_SNAPSHOT_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0084, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// end_winioctl + +// +// IOCTL_DISK_GET_SNAPSHOT_INFO +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type DISK_SNAPSHOT_INFO +// + +// +// IOCTL_DISK_SET_SNAPSHOT_INFO +// +// Input Buffer: +// Structure of type DISK_SNAPSHOT_INFO +// +// Output Buffer: +// None +// + +typedef enum _DISK_SNAPSHOT_STATE { + + DiskSnapshotNormalDisk, + DiskSnapshotSnapshotCheckRequired, + DiskSnapshotPreSnapshot, + DiskSnapshotSnapshotDisk + +} DISK_SNAPSHOT_STATE, *PDISK_SNAPSHOT_STATE; + +typedef struct _DISK_SNAPSHOT_INFO { + + // + // Specifies the size of the + // structure for versioning. + // + ULONG Version; + + // + // Specifies the state that this + // disk is in or the state to be + // transitioned to. + // + DISK_SNAPSHOT_STATE State; + + // + // Specifies a unique id that + // represents all of the disks + // involved in this snapshot. + // + GUID SnapshotSetId; + + // + // Specifies a unique id that + // represents this snapshot. + // + GUID SnapshotId; + + // + // Specifies a unique id that + // represents the logical unit + // whose snapshot was taken. + // + GUID LunId; + + // + // Specifies the time when this + // snapshot was taken. + // + LARGE_INTEGER CreationTimeStamp; + + // + // Specifies the number of times + // that this snapshot has been + // imported. + // + ULONG ImportCount; + + // + // Specifies attributes that are + // associated with this snapshot. + // + ULONG Flags; + + // + // Specifies the size in bytes of + // the following field. + // + ULONG AdditionalDataSize; + + // + // Specifies disk meta data that + // needs to be restored in the + // event of a fast recovery. + // + UCHAR AdditionalData[ANYSIZE_ARRAY]; + +} DISK_SNAPSHOT_INFO, *PDISK_SNAPSHOT_INFO; + +#endif // NTDDI_VERSION >= NTDDI_VISTA + + +#if (NTDDI_VERSION >= NTDDI_WIN8) + + +// +// IOCTLs to query and modify the context +// associated with clustered disks. +// + +#define IOCTL_DISK_GET_CLUSTER_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0085, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_DISK_SET_CLUSTER_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0086, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_DISK_GET_CLUSTER_INFO +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type DISK_CLUSTER_INFO +// + +// +// IOCTL_DISK_SET_CLUSTER_INFO +// +// Input Buffer: +// Structure of type DISK_CLUSTER_INFO +// +// Output Buffer: +// None +// + +#define DISK_CLUSTER_FLAG_ENABLED 0x0000000000000001 +#define DISK_CLUSTER_FLAG_CSV 0x0000000000000002 +#define DISK_CLUSTER_FLAG_IN_MAINTENANCE 0x0000000000000004 +#define DISK_CLUSTER_FLAG_PNP_ARRIVAL_COMPLETE 0x0000000000000008 + +typedef struct _DISK_CLUSTER_INFO { + + // + // Size of this structure serves + // as the version + // + ULONG Version; + + // + // Specifies whether or not this + // disk is clustered, csv, etc + // + ULONGLONG Flags; + + // + // Specifies the flags that are + // being modified + // + ULONGLONG FlagsMask; + + // + // Indicates whether or not a + // layout change notification is + // to be sent + // + BOOLEAN Notify; + +} DISK_CLUSTER_INFO, *PDISK_CLUSTER_INFO; + + +// +// IOCTLs to determine when all of the +// volumes on a disk are ready for use +// + +#define IOCTL_DISK_ARE_VOLUMES_READY CTL_CODE(IOCTL_DISK_BASE, 0x0087, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_DISK_VOLUMES_ARE_READY CTL_CODE(IOCTL_DISK_BASE, 0x0088, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_DISK_ARE_VOLUMES_READY +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +// +// IOCTL_DISK_VOLUMES_ARE_READY +// +// Input Buffer: +// Structure of type ULONG +// +// Output Buffer: +// None +// + + +// +// IOCTL to query disk performance counters. +// Similar to IOCTL_DISK_PERFORMANCE with support +// for flushes and non-low priority I/Os. +// + +#define IOCTL_DISK_GET_PERFORMANCE_INFO CTL_CODE(IOCTL_DISK_BASE, 0x0089, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_DISK_GET_PERFORMANCE_INFO +// +// Input Buffer: +// Structure of type DISK_PERFORMANCE_PARAMETERS +// +// Output Buffer: +// Structure of type DISK_PERFORMANCE_INFO +// + +typedef enum _DISK_PERFORMANCE_TYPE { + + DiskPerformanceTypeAllPriority, + DiskPerformanceTypeNonLowPriority, + DiskPerformanceTypeMax + +} DISK_PERFORMANCE_TYPE, *PDISK_PERFORMANCE_TYPE; + +typedef struct _DISK_PERFORMANCE_PARAMETERS { + + ULONG Version; + DISK_PERFORMANCE_TYPE Type; + +} DISK_PERFORMANCE_PARAMETERS, *PDISK_PERFORMANCE_PARAMETERS; + +typedef struct _DISK_PERFORMANCE_INFO { + + ULONG Version; + DISK_PERFORMANCE_TYPE Type; + LARGE_INTEGER QueryTime; + LARGE_INTEGER BytesRead; + LARGE_INTEGER BytesWritten; + LARGE_INTEGER ReadTime; + LARGE_INTEGER WriteTime; + LARGE_INTEGER FlushTime; + LARGE_INTEGER IdleTime; + ULONG ReadCount; + ULONG WriteCount; + ULONG FlushCount; + ULONG QueueDepth; + ULONG SplitCount; + +} DISK_PERFORMANCE_INFO, *PDISK_PERFORMANCE_INFO; + +#endif // NTDDI_VERSION >= NTDDI_WIN8 + +// +// The following device control code is for the SIMBAD simulated bad +// sector facility. See SIMBAD.H in this directory for related structures. +// + +#define IOCTL_DISK_SIMBAD CTL_CODE(IOCTL_DISK_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// Queue link for mapped addresses stored for unmapping. +// + +typedef struct _MAPPED_ADDRESS { + struct _MAPPED_ADDRESS *NextMappedAddress; + PVOID MappedAddress; + ULONG NumberOfBytes; + LARGE_INTEGER IoAddress; + ULONG BusNumber; +} MAPPED_ADDRESS, *PMAPPED_ADDRESS; + +// begin_winioctl + +#if defined(_MSC_VER) +#if (_MSC_VER >= 1200) +#pragma warning(pop) +#endif +#endif + +// end_winioctl + +#if defined __cplusplus && !defined __ALT_GENERATOR__ +} +#endif + +// begin_winioctl + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDDISK_H_ + +// end_winioctl diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddkbd.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddkbd.h new file mode 100644 index 0000000000000000000000000000000000000000..edfaa5f4f45ff7aad55e8aa0a36b9e5b4438e49c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddkbd.h @@ -0,0 +1,426 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddkbd.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the keyboard device. + +--*/ + +#ifndef _NTDDKBD_ +#define _NTDDKBD_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_KEYBOARD_DEVICE_NAME "\\Device\\KeyboardClass" +#define DD_KEYBOARD_DEVICE_NAME_U L"\\Device\\KeyboardClass" + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_KEYBOARD_QUERY_ATTRIBUTES CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0000, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_SET_TYPEMATIC CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0001, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_SET_INDICATORS CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0002, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_QUERY_TYPEMATIC CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0008, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_QUERY_INDICATORS CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0020, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_INSERT_DATA CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0040, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_QUERY_EXTENDED_ATTRIBUTES CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0080, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// These Device IO control query/set IME status to keyboard hardware. +// +#define IOCTL_KEYBOARD_QUERY_IME_STATUS CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0400, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_KEYBOARD_SET_IME_STATUS CTL_CODE(FILE_DEVICE_KEYBOARD, 0x0401, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Declare the GUID that represents the device interface for keyboards. +// +#ifndef FAR +#define FAR +#endif + +DEFINE_GUID( GUID_DEVINTERFACE_KEYBOARD, 0x884b96c3, 0x56ef, 0x11d1, \ + 0xbc, 0x8c, 0x00, 0xa0, 0xc9, 0x14, 0x05, 0xdd); + +// +// Obsolete device interface class GUID name. +// (use of above GUID_DEVINTERFACE_* name is recommended). +// + +#define GUID_CLASS_KEYBOARD GUID_DEVINTERFACE_KEYBOARD + + +// +// NtReadFile Output Buffer record structures for this device. +// + +typedef struct _KEYBOARD_INPUT_DATA { + + // + // Unit number. E.g., for \Device\KeyboardPort0 the unit is '0', + // for \Device\KeyboardPort1 the unit is '1', and so on. + // + + USHORT UnitId; + + // + // The "make" scan code (key depression). + // + + USHORT MakeCode; + + // + // The flags field indicates a "break" (key release) and other + // miscellaneous scan code information defined below. + // + + USHORT Flags; + + USHORT Reserved; + + // + // Device-specific additional information for the event. + // + + ULONG ExtraInformation; + +} KEYBOARD_INPUT_DATA, *PKEYBOARD_INPUT_DATA; + + +// +// Define the keyboard overrun MakeCode. +// + +#define KEYBOARD_OVERRUN_MAKE_CODE 0xFF + +// +// Define the keyboard input data Flags. +// + +#define KEY_MAKE 0 +#define KEY_BREAK 1 +#define KEY_E0 2 +#define KEY_E1 4 +#define KEY_TERMSRV_SET_LED 8 +#define KEY_TERMSRV_SHADOW 0x10 +#define KEY_TERMSRV_VKPACKET 0x20 +#define KEY_RIM_VKEY 0x40 +#define KEY_FROM_KEYBOARD_OVERRIDER 0x80 +#define KEY_UNICODE_SEQUENCE_ITEM 0x100 +#define KEY_UNICODE_SEQUENCE_END 0x200 + +// +// NtDeviceIoControlFile Input/Output Buffer record structures for +// IOCTL_KEYBOARD_QUERY_TYPEMATIC/IOCTL_KEYBOARD_SET_TYPEMATIC. +// + +typedef struct _KEYBOARD_TYPEMATIC_PARAMETERS { + + // + // Unit identifier. Specifies the device unit for which this + // request is intended. + // + + USHORT UnitId; + + // + // Typematic rate, in repeats per second. + // + + USHORT Rate; + + // + // Typematic delay, in milliseconds. + // + + USHORT Delay; + +} KEYBOARD_TYPEMATIC_PARAMETERS, *PKEYBOARD_TYPEMATIC_PARAMETERS; + +// +// NtDeviceIoControlFile OutputBuffer record structures for +// IOCTL_KEYBOARD_QUERY_ATTRIBUTES. +// + +typedef struct _KEYBOARD_ID { + UCHAR Type; // Keyboard type + UCHAR Subtype; // Keyboard subtype (OEM-dependent value) +} KEYBOARD_ID, *PKEYBOARD_ID; + +typedef struct _KEYBOARD_ATTRIBUTES { + + // + // Keyboard ID value. Used to distinguish between keyboard types. + // + + KEYBOARD_ID KeyboardIdentifier; + + // + // Scan code mode. + // + + USHORT KeyboardMode; + + // + // Number of function keys located on the keyboard. + // + + USHORT NumberOfFunctionKeys; + + // + // Number of LEDs located on the keyboard. + // + + USHORT NumberOfIndicators; + + // + // Total number of keys located on the keyboard. + // + + USHORT NumberOfKeysTotal; + + // + // Length of the typeahead buffer, in bytes. + // + + ULONG InputDataQueueLength; + + // + // Minimum allowable values of keyboard typematic rate and delay. + // + + KEYBOARD_TYPEMATIC_PARAMETERS KeyRepeatMinimum; + + // + // Maximum allowable values of keyboard typematic rate and delay. + // + + KEYBOARD_TYPEMATIC_PARAMETERS KeyRepeatMaximum; + +} KEYBOARD_ATTRIBUTES, *PKEYBOARD_ATTRIBUTES; + + +// +// The structure used by IOCTL_KEYBOARD_QUERY_EXTENDED_ATTRIBUTES +// + +#define KEYBOARD_EXTENDED_ATTRIBUTES_STRUCT_VERSION_1 (1) + +typedef struct _KEYBOARD_EXTENDED_ATTRIBUTES { + // + // The version of this structure. + // Only accept KEYBOARD_EXTENDED_ATTRIBUTES_STRUCT_VERSION_1 now. + // + UCHAR Version; + + // + // Keyboard Form Factor (Usage ID: 0x2C1) + // + UCHAR FormFactor; + + // + // Keyboard Key Type (Usage ID: 0x2C2) + // + UCHAR KeyType; + + // + // Keyboard Physical Layout (Usage ID: 0x2C3) + // + UCHAR PhysicalLayout; + + // + // Vendor-Specific Keyboard Layout (Usage ID: 0x2C4) + // + UCHAR VendorSpecificPhysicalLayout; + + // + // Keyboard IETF Language Tag Index (Usage ID: 0x2C5) + // + UCHAR IETFLanguageTagIndex; + + // + // Implemented Keyboard Input Assist Controls (Usage ID: 0x2C6) + // + UCHAR ImplementedInputAssistControls; + +} KEYBOARD_EXTENDED_ATTRIBUTES, *PKEYBOARD_EXTENDED_ATTRIBUTES; + +// +// ENHANCED_KEYBOARD() is TRUE if the value for keyboard type indicates an +// Enhanced (101- or 102-key) or compatible keyboard. The result is FALSE +// if the keyboard is an old-style AT keyboard (83- or 84- or 86-key keyboard). +// +#define ENHANCED_KEYBOARD(Id) ((Id).Type == 2 || (Id).Type == 4 || FAREAST_KEYBOARD(Id)) +// +// Japanese keyboard(7) and Korean keyboard(8) are also Enhanced (101-) +// or compatible keyboard. +// +#define FAREAST_KEYBOARD(Id) ((Id).Type == 7 || (Id).Type == 8) + +// +// NtDeviceIoControlFile Input/Output Buffer record structures for +// IOCTL_KEYBOARD_QUERY_INDICATORS/IOCTL_KEYBOARD_SET_INDICATORS. +// + +typedef struct _KEYBOARD_INDICATOR_PARAMETERS { + + // + // Unit identifier. Specifies the device unit for which this + // request is intended. + // + + USHORT UnitId; + + // + // LED indicator state. + // + + USHORT LedFlags; + +} KEYBOARD_INDICATOR_PARAMETERS, *PKEYBOARD_INDICATOR_PARAMETERS; + +// +// NtDeviceIoControlFile Output Buffer record structures for +// IOCTL_KEYBOARD_QUERY_INDICATOR_TRANSLATION. +// + +typedef struct _INDICATOR_LIST { + + // + // The "make" scan code (key depression). + // + + USHORT MakeCode; + + // + // The associated LED indicators. + // + + USHORT IndicatorFlags; + +} INDICATOR_LIST, *PINDICATOR_LIST; + +typedef struct _KEYBOARD_INDICATOR_TRANSLATION { + + // + // Number of entries in IndicatorList. + // + + USHORT NumberOfIndicatorKeys; + + // + // List of the scancode-to-indicator mappings. + // + + INDICATOR_LIST IndicatorList[1]; + +} KEYBOARD_INDICATOR_TRANSLATION, *PKEYBOARD_INDICATOR_TRANSLATION; + +// +// Define the keyboard indicators. +// + +#define KEYBOARD_LED_INJECTED 0x8000 //Used by Terminal Server +#define KEYBOARD_SHADOW 0x4000 //Used by Terminal Server +#define KEYBOARD_KANA_LOCK_ON 8 // Japanese keyboard +#define KEYBOARD_CAPS_LOCK_ON 4 +#define KEYBOARD_NUM_LOCK_ON 2 +#define KEYBOARD_SCROLL_LOCK_ON 1 + +// +// Generic NtDeviceIoControlFile Input Buffer record structure for +// various keyboard IOCTLs. +// + +typedef struct _KEYBOARD_UNIT_ID_PARAMETER { + + // + // Unit identifier. Specifies the device unit for which this + // request is intended. + // + + USHORT UnitId; + +} KEYBOARD_UNIT_ID_PARAMETER, *PKEYBOARD_UNIT_ID_PARAMETER; + +// +// Define the base values for the keyboard error log packet's +// UniqueErrorValue field. +// + +#define KEYBOARD_ERROR_VALUE_BASE 10000 + +// +// NtDeviceIoControlFile Input/Output Buffer record structures for +// IOCTL_KEYBOARD_QUERY_IME_STATUS/IOCTL_KEYBOARD_SET_IME_STATUS. +// + +typedef struct _KEYBOARD_IME_STATUS { + + // + // Unit identifier. Specifies the device unit for which this + // request is intended. + // + + USHORT UnitId; + + // + // Ime open or close status. + // + ULONG ImeOpen; + + // + // Ime conversion status. + // + ULONG ImeConvMode; + +} KEYBOARD_IME_STATUS, *PKEYBOARD_IME_STATUS; + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // _NTDDKBD_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmmc.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmmc.h new file mode 100644 index 0000000000000000000000000000000000000000..2d4c0978e885f4e1fb49864a5c014e2329aff440 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmmc.h @@ -0,0 +1,855 @@ +/* Copyright (c) Microsoft Corporation. All rights reserved. */ + +#ifndef __NTDDMMC__ +#define __NTDDMMC__ + +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef __cplusplus +extern "C" { +#endif + + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4200) // array[0] is not a warning for this file +#pragma warning(disable:4214) // bitfield other than int + + +// +// NOTE: All FEATURE_* structures may be extended. use of these structures +// requires verification that the FeatureHeader->AdditionLength field +// contains AT LEAST enough data to cover the data fields being accessed. +// This is due to the design, which allows extending the size of the +// various structures, which will result in these structures sizes +// being changed over time. +// A 0-element array is however not declared in the variable size +// structures. Such array is declared on some structures to preserve +// legacy, yet it is deprecated. To access variable size structures, +// as they are always at the end of the fixed size structure, use a sizeof +// of the declared fixed size structure as an offset. +// *** Programmers beware! *** +// + +// +// NOTE: This is based on MMC 3, extended to MMC 5 rev 3 +// Further revisions will maintain backward compatibility +// with the non-reserved fields listed here. If you need +// to access a new field, please typecast to FEATURE_DATA_RESERVED +// and access the appropriate bits there. +// + +// +// NOTE: The definition of FEATURE_DATA_REMOVABLE_MEDIUM is based on MMC 6 rev 2. +// MMC 5 rev 4, section 5.3.4, specified bit 4 after feature header as reserved. +// MMC 6 rev 2, section 5.3.4, specifies this bit as the Load bit. +// + +typedef struct _GET_CONFIGURATION_HEADER { + UCHAR DataLength[4]; // [0] == MSB, [3] == LSB + UCHAR Reserved[2]; + UCHAR CurrentProfile[2]; // [0] == MSB, [1] == LSB +#if !defined(__midl) + UCHAR Data[0]; // extra data, typically FEATURE_HEADER +#endif +} GET_CONFIGURATION_HEADER, *PGET_CONFIGURATION_HEADER; + +typedef struct _FEATURE_HEADER { + UCHAR FeatureCode[2]; // [0] == MSB, [1] == LSB + UCHAR Current : 1; // The feature is currently active + UCHAR Persistent : 1; // The feature is always current + UCHAR Version : 4; + UCHAR Reserved0 : 2; + UCHAR AdditionalLength; // sizeof(Header) + AdditionalLength = size +} FEATURE_HEADER, *PFEATURE_HEADER; + +typedef enum _FEATURE_PROFILE_TYPE { + ProfileInvalid = 0x0000, + ProfileNonRemovableDisk = 0x0001, + ProfileRemovableDisk = 0x0002, + ProfileMOErasable = 0x0003, + ProfileMOWriteOnce = 0x0004, + ProfileAS_MO = 0x0005, + // Reserved 0x0006 - 0x0007 + ProfileCdrom = 0x0008, + ProfileCdRecordable = 0x0009, + ProfileCdRewritable = 0x000a, + // Reserved 0x000b - 0x000f + ProfileDvdRom = 0x0010, + ProfileDvdRecordable = 0x0011, + ProfileDvdRam = 0x0012, + ProfileDvdRewritable = 0x0013, // restricted overwrite + ProfileDvdRWSequential = 0x0014, + ProfileDvdDashRDualLayer = 0x0015, + ProfileDvdDashRLayerJump = 0x0016, + // Reserved 0x0017 - 0x0019 + ProfileDvdPlusRW = 0x001A, + ProfileDvdPlusR = 0x001B, + // Reserved 0x001C - 001F + ProfileDDCdrom = 0x0020, // obsolete + ProfileDDCdRecordable = 0x0021, // obsolete + ProfileDDCdRewritable = 0x0022, // obsolete + // Reserved 0x0023 - 0x0029 + ProfileDvdPlusRWDualLayer = 0x002A, + ProfileDvdPlusRDualLayer = 0x002B, + // Reserved 0x002C - 0x003F + ProfileBDRom = 0x0040, + ProfileBDRSequentialWritable = 0x0041, // BD-R 'SRM' + ProfileBDRRandomWritable = 0x0042, // BD-R 'RRM' + ProfileBDRewritable = 0x0043, + // Reserved 0x0044 - 0x004F + ProfileHDDVDRom = 0x0050, + ProfileHDDVDRecordable = 0x0051, + ProfileHDDVDRam = 0x0052, + ProfileHDDVDRewritable = 0x0053, + // Reserved 0x0054 - 0x0057 + ProfileHDDVDRDualLayer = 0x0058, + // Reserved 0x0059 - 0x0059 + ProfileHDDVDRWDualLayer = 0x005A, + // Reserved 0x005B - 0xfffe + ProfileNonStandard = 0xffff +} FEATURE_PROFILE_TYPE, *PFEATURE_PROFILE_TYPE; + +typedef enum _FEATURE_NUMBER { + FeatureProfileList = 0x0000, + FeatureCore = 0x0001, + FeatureMorphing = 0x0002, + FeatureRemovableMedium = 0x0003, + FeatureWriteProtect = 0x0004, + // Reserved 0x0005 - 0x000f + FeatureRandomReadable = 0x0010, + // Reserved 0x0011 - 0x001c + FeatureMultiRead = 0x001D, + FeatureCdRead = 0x001E, + FeatureDvdRead = 0x001F, + FeatureRandomWritable = 0x0020, + FeatureIncrementalStreamingWritable = 0x0021, + FeatureSectorErasable = 0x0022, + FeatureFormattable = 0x0023, + FeatureDefectManagement = 0x0024, + FeatureWriteOnce = 0x0025, + FeatureRestrictedOverwrite = 0x0026, + FeatureCdrwCAVWrite = 0x0027, + FeatureMrw = 0x0028, + FeatureEnhancedDefectReporting = 0x0029, + FeatureDvdPlusRW = 0x002A, + FeatureDvdPlusR = 0x002B, + FeatureRigidRestrictedOverwrite = 0x002C, + FeatureCdTrackAtOnce = 0x002D, + FeatureCdMastering = 0x002E, + FeatureDvdRecordableWrite = 0x002F, // both -R and -RW + FeatureDDCDRead = 0x0030, // obsolete + FeatureDDCDRWrite = 0x0031, // obsolete + FeatureDDCDRWWrite = 0x0032, // obsolete + FeatureLayerJumpRecording = 0x0033, + // Reserved 0x0034 - 0x0036 + FeatureCDRWMediaWriteSupport = 0x0037, + FeatureBDRPseudoOverwrite = 0x0038, + // Reserved 0x0039 + FeatureDvdPlusRWDualLayer = 0x003A, + FeatureDvdPlusRDualLayer = 0x003B, + // Reserved 0x003c - 0x003f + FeatureBDRead = 0x0040, + FeatureBDWrite = 0x0041, + FeatureTSR = 0x0042, + // Reserved 0x0043 - 0x004f + FeatureHDDVDRead = 0x0050, + FeatureHDDVDWrite = 0x0051, + // Reserved 0x0052 - 0x007f + FeatureHybridDisc = 0x0080, + // Reserved 0x0081 - 0x00ff + FeaturePowerManagement = 0x0100, + FeatureSMART = 0x0101, + FeatureEmbeddedChanger = 0x0102, + FeatureCDAudioAnalogPlay = 0x0103, // obsolete + FeatureMicrocodeUpgrade = 0x0104, + FeatureTimeout = 0x0105, + FeatureDvdCSS = 0x0106, + FeatureRealTimeStreaming = 0x0107, + FeatureLogicalUnitSerialNumber = 0x0108, + FeatureMediaSerialNumber = 0x0109, + FeatureDiscControlBlocks = 0x010A, + FeatureDvdCPRM = 0x010B, + FeatureFirmwareDate = 0x010C, + FeatureAACS = 0x010D, + // Reserved 0x010e - 0x010f + FeatureVCPS = 0x0110, + // Reserved 0x0111 - 0xfeff + // Vendor Unique 0xff00 - 0xffff +} FEATURE_NUMBER, *PFEATURE_NUMBER; + +// 0x0000 - FeatureProfileList +// an integral multiple of the _EX structures are returned for page 0000 +typedef struct _FEATURE_DATA_PROFILE_LIST_EX { + UCHAR ProfileNumber[2]; // [0] == MSB, [1] == LSB + UCHAR Current : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; +} FEATURE_DATA_PROFILE_LIST_EX, *PFEATURE_DATA_PROFILE_LIST_EX; + +typedef struct _FEATURE_DATA_PROFILE_LIST { + FEATURE_HEADER Header; +#if !defined(__midl) + FEATURE_DATA_PROFILE_LIST_EX Profiles[0]; +#endif +} FEATURE_DATA_PROFILE_LIST, *PFEATURE_DATA_PROFILE_LIST; + +// 0x0001 - FeatureCore +typedef struct _FEATURE_DATA_CORE { + FEATURE_HEADER Header; + UCHAR PhysicalInterface[4]; // [0] == MSB, [3] == LSB + UCHAR DeviceBusyEvent : 1; + UCHAR INQUIRY2 : 1; + UCHAR Reserved1 : 6; + UCHAR Reserved2[3]; +} FEATURE_DATA_CORE, *PFEATURE_DATA_CORE; + +// 0x0002 - FeatureMorphing +typedef struct _FEATURE_DATA_MORPHING { + FEATURE_HEADER Header; + UCHAR Asynchronous : 1; + UCHAR OCEvent : 1; + UCHAR Reserved01 : 6; + UCHAR Reserved2[3]; +} FEATURE_DATA_MORPHING, *PFEATURE_DATA_MORPHING; + +// 0x0003 - FeatureRemovableMedium +typedef struct _FEATURE_DATA_REMOVABLE_MEDIUM { + FEATURE_HEADER Header; + UCHAR Lockable : 1; + UCHAR DBML : 1; // MMC 6 rev 2g + UCHAR DefaultToPrevent : 1; + UCHAR Eject : 1; + UCHAR Load : 1; // MMC 6 rev 2 + UCHAR LoadingMechanism : 3; + UCHAR Reserved3[3]; +} FEATURE_DATA_REMOVABLE_MEDIUM, *PFEATURE_DATA_REMOVABLE_MEDIUM; + +// 0x0004 - FeatureWriteProtect +typedef struct _FEATURE_DATA_WRITE_PROTECT { + FEATURE_HEADER Header; + UCHAR SupportsSWPPBit : 1; + UCHAR SupportsPersistentWriteProtect : 1; + UCHAR WriteInhibitDCB : 1; + UCHAR DiscWriteProtectPAC : 1; + UCHAR Reserved01 : 4; + UCHAR Reserved2[3]; +} FEATURE_DATA_WRITE_PROTECT, *PFEATURE_DATA_WRITE_PROTECT; + +// 0x0005 - 0x000f are Reserved + +// 0x0010 - FeatureRandomReadable +typedef struct _FEATURE_DATA_RANDOM_READABLE { + FEATURE_HEADER Header; + UCHAR LogicalBlockSize[4]; + UCHAR Blocking[2]; + UCHAR ErrorRecoveryPagePresent : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; +} FEATURE_DATA_RANDOM_READABLE, *PFEATURE_DATA_RANDOM_READABLE; + +// 0x0011 - 0x001c are Reserved + +// 0x001D - FeatureMultiRead +typedef struct _FEATURE_DATA_MULTI_READ { + FEATURE_HEADER Header; +} FEATURE_DATA_MULTI_READ, *PFEATURE_DATA_MULTI_READ; + +// 0x001E - FeatureCdRead +typedef struct _FEATURE_DATA_CD_READ { + FEATURE_HEADER Header; + UCHAR CDText : 1; + UCHAR C2ErrorData : 1; + UCHAR Reserved01 : 5; + UCHAR DigitalAudioPlay : 1; + UCHAR Reserved2[3]; +} FEATURE_DATA_CD_READ, *PFEATURE_DATA_CD_READ; + +// 0x001F - FeatureDvdRead +typedef struct _FEATURE_DATA_DVD_READ { + FEATURE_HEADER Header; + UCHAR Multi110 : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; + UCHAR DualDashR : 1; + UCHAR Reserved3 : 7; + UCHAR Reserved4; +} FEATURE_DATA_DVD_READ, *PFEATURE_DATA_DVD_READ; + +// 0x0020 - FeatureRandomWritable +typedef struct _FEATURE_DATA_RANDOM_WRITABLE { + FEATURE_HEADER Header; + UCHAR LastLBA[4]; + UCHAR LogicalBlockSize[4]; + UCHAR Blocking[2]; + UCHAR ErrorRecoveryPagePresent : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; +} FEATURE_DATA_RANDOM_WRITABLE, *PFEATURE_DATA_RANDOM_WRITABLE; + +// 0x0021 - FeatureIncrementalStreamingWritable +typedef struct _FEATURE_DATA_INCREMENTAL_STREAMING_WRITABLE { + FEATURE_HEADER Header; + UCHAR DataTypeSupported[2]; // [0] == MSB, [1] == LSB // see also FeatureCdTrackAtOnce + UCHAR BufferUnderrunFree : 1; + UCHAR AddressModeReservation : 1; + UCHAR TrackRessourceInformation : 1; + UCHAR Reserved01 : 5; + UCHAR NumberOfLinkSizes; +#if !defined(__midl) + UCHAR LinkSize[0]; +#endif +} FEATURE_DATA_INCREMENTAL_STREAMING_WRITABLE, *PFEATURE_DATA_INCREMENTAL_STREAMING_WRITABLE; + +// 0x0022 - FeatureSectorErasable +typedef struct _FEATURE_DATA_SECTOR_ERASABLE { + FEATURE_HEADER Header; +} FEATURE_DATA_SECTOR_ERASABLE, *PFEATURE_DATA_SECTOR_ERASABLE; + +// 0x0023 - FeatureFormattable +typedef struct _FEATURE_DATA_FORMATTABLE { + FEATURE_HEADER Header; + UCHAR FullCertification : 1; + UCHAR QuickCertification : 1; + UCHAR SpareAreaExpansion : 1; + UCHAR RENoSpareAllocated : 1; + UCHAR Reserved1 : 4; + UCHAR Reserved2[3]; + UCHAR RRandomWritable : 1; + UCHAR Reserved3 : 7; + UCHAR Reserved4[3]; +} FEATURE_DATA_FORMATTABLE, *PFEATURE_DATA_FORMATTABLE; + +// 0x0024 - FeatureDefectManagement +typedef struct _FEATURE_DATA_DEFECT_MANAGEMENT { + FEATURE_HEADER Header; + UCHAR Reserved1 : 7; + UCHAR SupplimentalSpareArea : 1; + UCHAR Reserved2[3]; +} FEATURE_DATA_DEFECT_MANAGEMENT, *PFEATURE_DATA_DEFECT_MANAGEMENT; + +// 0x0025 - FeatureWriteOnce +typedef struct _FEATURE_DATA_WRITE_ONCE { + FEATURE_HEADER Header; + UCHAR LogicalBlockSize[4]; + UCHAR Blocking[2]; + UCHAR ErrorRecoveryPagePresent : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; +} FEATURE_DATA_WRITE_ONCE, *PFEATURE_DATA_WRITE_ONCE; + +// 0x0026 - FeatureRestrictedOverwrite +typedef struct _FEATURE_DATA_RESTRICTED_OVERWRITE { + FEATURE_HEADER Header; +} FEATURE_DATA_RESTRICTED_OVERWRITE, *PFEATURE_DATA_RESTRICTED_OVERWRITE; + +// 0x0027 - FeatureCdrwCAVWrite +typedef struct _FEATURE_DATA_CDRW_CAV_WRITE { + FEATURE_HEADER Header; + UCHAR Reserved1[4]; + /* + UCHAR SupportsWritingCDRWSubType0 : 1; // 1x - 4x media + UCHAR SupportsWritingCDRWSubType1 : 1; // 4x - 10x media ?? + UCHAR SupportsWritingCDRWSubType2 : 1; // ??? + UCHAR SupportsWritingCDRWSubType3 : 1; // ??? + UCHAR SupportsWritingCDRWSubType4 : 1; // ??? + UCHAR SupportsWritingCDRWSubType5 : 1; // ??? + UCHAR SupportsWritingCDRWSubType6 : 1; // ??? + UCHAR SupportsWritingCDRWSubType7 : 1; // ??? + UCHAR Reserved2[3]; + */ +} FEATURE_DATA_CDRW_CAV_WRITE, *PFEATURE_DATA_CDRW_CAV_WRITE; + +// 0x0028 - FeatureMrw +typedef struct _FEATURE_DATA_MRW { + FEATURE_HEADER Header; + UCHAR Write : 1; // Cd Write + UCHAR DvdPlusRead : 1; + UCHAR DvdPlusWrite : 1; + UCHAR Reserved01 : 5; + UCHAR Reserved2[3]; +} FEATURE_DATA_MRW, *PFEATURE_DATA_MRW; + +// 0x0029 - Enhanced Defect Reporting +typedef struct _FEATURE_ENHANCED_DEFECT_REPORTING { + FEATURE_HEADER Header; + UCHAR DRTDMSupported : 1; + UCHAR Reserved0 : 7; + UCHAR NumberOfDBICacheZones; + UCHAR NumberOfEntries[2]; +} FEATURE_ENHANCED_DEFECT_REPORTING, *PFEATURE_ENHANCED_DEFECT_REPORTING; + +// 0x002A - FeatureDvdPlusRW +typedef struct _FEATURE_DATA_DVD_PLUS_RW { + FEATURE_HEADER Header; + UCHAR Write : 1; + UCHAR Reserved1 : 7; + UCHAR CloseOnly : 1; + UCHAR QuickStart : 1; + UCHAR Reserved02 : 6; + UCHAR Reserved03[2]; +} FEATURE_DATA_DVD_PLUS_RW, *PFEATURE_DATA_DVD_PLUS_RW; + +// 0x002B - FeatureDvdPlusR +typedef struct _FEATURE_DATA_DVD_PLUS_R { + FEATURE_HEADER Header; + UCHAR Write : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[3]; +} FEATURE_DATA_DVD_PLUS_R, *PFEATURE_DATA_DVD_PLUS_R; + +// 0x002C - FeatureDvdRwRestrictedOverwrite +typedef struct _FEATURE_DATA_DVD_RW_RESTRICTED_OVERWRITE { + FEATURE_HEADER Header; + UCHAR Blank : 1; + UCHAR Intermediate : 1; + UCHAR DefectStatusDataRead : 1; + UCHAR DefectStatusDataGenerate : 1; + UCHAR Reserved0 : 4; + UCHAR Reserved1[3]; +} FEATURE_DATA_DVD_RW_RESTRICTED_OVERWRITE, *PFEATURE_DATA_DVD_RW_RESTRICTED_OVERWRITE; + +// 0x002D - FeatureCdTrackAtOnce +typedef struct _FEATURE_DATA_CD_TRACK_AT_ONCE { + FEATURE_HEADER Header; + UCHAR RWSubchannelsRecordable : 1; + UCHAR CdRewritable : 1; + UCHAR TestWriteOk : 1; + UCHAR RWSubchannelPackedOk : 1; // MMC 3 + + UCHAR RWSubchannelRawOk : 1; // MMC 3 + + UCHAR Reserved1 : 1; + UCHAR BufferUnderrunFree : 1; // MMC 3 + + UCHAR Reserved3 : 1; + UCHAR Reserved2; + UCHAR DataTypeSupported[2]; // [0] == MSB, [1] == LSB // see also FeatureIncrementalStreamingWritable +} FEATURE_DATA_CD_TRACK_AT_ONCE, *PFEATURE_DATA_CD_TRACK_AT_ONCE; + +// 0x002E - FeatureCdMastering +typedef struct _FEATURE_DATA_CD_MASTERING { + FEATURE_HEADER Header; + UCHAR RWSubchannelsRecordable : 1; + UCHAR CdRewritable : 1; + UCHAR TestWriteOk : 1; + UCHAR RawRecordingOk : 1; + UCHAR RawMultiSessionOk : 1; + UCHAR SessionAtOnceOk : 1; + UCHAR BufferUnderrunFree : 1; + UCHAR Reserved1 : 1; + UCHAR MaximumCueSheetLength[3]; // [0] == MSB, [2] == LSB +} FEATURE_DATA_CD_MASTERING, *PFEATURE_DATA_CD_MASTERING; + +// 0x002F - FeatureDvdRecordableWrite +typedef struct _FEATURE_DATA_DVD_RECORDABLE_WRITE { + FEATURE_HEADER Header; + UCHAR Reserved1 : 1; + UCHAR DVD_RW : 1; + UCHAR TestWrite : 1; + UCHAR RDualLayer : 1; + UCHAR Reserved02 : 2; + UCHAR BufferUnderrunFree : 1; + UCHAR Reserved3 : 1; + UCHAR Reserved4[3]; +} FEATURE_DATA_DVD_RECORDABLE_WRITE, *PFEATURE_DATA_DVD_RECORDABLE_WRITE; + +// 0x0030 - FeatureDDCDRead +typedef struct _FEATURE_DATA_DDCD_READ { + FEATURE_HEADER Header; +} FEATURE_DATA_DDCD_READ, *PFEATURE_DATA_DDCD_READ; + +// 0x0031 - FeatureDDCDRWrite (obsolete) +typedef struct _FEATURE_DATA_DDCD_R_WRITE { + FEATURE_HEADER Header; + UCHAR Reserved1 : 2; + UCHAR TestWrite : 1; + UCHAR Reserved2 : 5; + UCHAR Reserved3[3]; +} FEATURE_DATA_DDCD_R_WRITE, *PFEATURE_DATA_DDCD_R_WRITE; + +// 0x0032 - FeatureDDCDRWWrite (obsolete) +typedef struct _FEATURE_DATA_DDCD_RW_WRITE { + FEATURE_HEADER Header; + UCHAR Blank : 1; + UCHAR Intermediate : 1; + UCHAR Reserved1 : 6; + UCHAR Reserved2[3]; +} FEATURE_DATA_DDCD_RW_WRITE, *PFEATURE_DATA_DDCD_RW_WRITE; + +// 0x0033 - FeatureLayerJumpRecording +typedef struct _FEATURE_DATA_LAYER_JUMP_RECORDING { + FEATURE_HEADER Header; + UCHAR Reserved0[3]; + UCHAR NumberOfLinkSizes; +#if !defined(__midl) + UCHAR LinkSizes[0]; +#endif +} FEATURE_DATA_LAYER_JUMP_RECORDING, *PFEATURE_DATA_LAYER_JUMP_RECORDING; + +// 0x0034 - 0x0036 are Reserved + +// 0x0037 - FeatureCDRWMediaWriteSupport +typedef struct _FEATURE_CD_RW_MEDIA_WRITE_SUPPORT { + FEATURE_HEADER Header; + UCHAR Reserved1; + struct{ + UCHAR Subtype0 :1; + UCHAR Subtype1 :1; + UCHAR Subtype2 :1; + UCHAR Subtype3 :1; + UCHAR Subtype4 :1; + UCHAR Subtype5 :1; + UCHAR Subtype6 :1; + UCHAR Subtype7 :1; + } CDRWMediaSubtypeSupport; + UCHAR Reserved2[2]; +} FEATURE_CD_RW_MEDIA_WRITE_SUPPORT, *PFEATURE_CD_RW_MEDIA_WRITE_SUPPORT; + +// 0x0038 - FeatureBDRPseudoOverwrite +typedef struct _FEATURE_BD_R_PSEUDO_OVERWRITE { + FEATURE_HEADER Header; + UCHAR Reserved[4]; +} FEATURE_BD_R_PSEUDO_OVERWRITE, *PFEATURE_BD_R_PSEUDO_OVERWRITE; + +// 0x0039 is Reserved + +// 0x003A - FeatureDvdPlusRWDualLayer +typedef struct _FEATURE_DATA_DVD_PLUS_RW_DUAL_LAYER { + FEATURE_HEADER Header; + UCHAR Write : 1; + UCHAR Reserved1 : 7; + UCHAR CloseOnly : 1; + UCHAR QuickStart : 1; + UCHAR Reserved2 : 6; + UCHAR Reserved3[2]; +} FEATURE_DATA_DVD_PLUS_RW_DUAL_LAYER, *PFEATURE_DATA_DVD_PLUS_RW_DUAL_LAYER; + +// 0x003B - FeatureDvdPlusRDualLayer +typedef struct _FEATURE_DATA_DVD_PLUS_R_DUAL_LAYER { + FEATURE_HEADER Header; + UCHAR Write : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[3]; +} FEATURE_DATA_DVD_PLUS_R_DUAL_LAYER, *PFEATURE_DATA_DVD_PLUS_R_DUAL_LAYER; + +// 0x003C - 0x0039 are Reserved + +// 0x0040 - FeatureBDRead + +typedef struct _BD_CLASS_SUPPORT_BITMAP { + UCHAR Version8 :1; + UCHAR Version9 :1; + UCHAR Version10 :1; + UCHAR Version11 :1; + UCHAR Version12 :1; + UCHAR Version13 :1; + UCHAR Version14 :1; + UCHAR Version15 :1; + UCHAR Version0 :1; + UCHAR Version1 :1; + UCHAR Version2 :1; + UCHAR Version3 :1; + UCHAR Version4 :1; + UCHAR Version5 :1; + UCHAR Version6 :1; + UCHAR Version7 :1; +} BD_CLASS_SUPPORT_BITMAP, *PBD_CLASS_SUPPORT_BITMAP; + +typedef struct _FEATURE_BD_READ { + FEATURE_HEADER Header; + UCHAR Reserved[4]; + BD_CLASS_SUPPORT_BITMAP Class0BitmapBDREReadSupport; + BD_CLASS_SUPPORT_BITMAP Class1BitmapBDREReadSupport; + BD_CLASS_SUPPORT_BITMAP Class2BitmapBDREReadSupport; + BD_CLASS_SUPPORT_BITMAP Class3BitmapBDREReadSupport; + BD_CLASS_SUPPORT_BITMAP Class0BitmapBDRReadSupport; + BD_CLASS_SUPPORT_BITMAP Class1BitmapBDRReadSupport; + BD_CLASS_SUPPORT_BITMAP Class2BitmapBDRReadSupport; + BD_CLASS_SUPPORT_BITMAP Class3BitmapBDRReadSupport; + BD_CLASS_SUPPORT_BITMAP Class0BitmapBDROMReadSupport; + BD_CLASS_SUPPORT_BITMAP Class1BitmapBDROMReadSupport; + BD_CLASS_SUPPORT_BITMAP Class2BitmapBDROMReadSupport; + BD_CLASS_SUPPORT_BITMAP Class3BitmapBDROMReadSupport; +} FEATURE_BD_READ, *PFEATURE_BD_READ; + +// 0x0041 - FeatureBDWrite +typedef struct _FEATURE_BD_WRITE { + FEATURE_HEADER Header; + UCHAR SupportsVerifyNotRequired :1; + UCHAR Reserved1 :7; + UCHAR Reserved2[3]; + BD_CLASS_SUPPORT_BITMAP Class0BitmapBDREWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class1BitmapBDREWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class2BitmapBDREWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class3BitmapBDREWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class0BitmapBDRWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class1BitmapBDRWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class2BitmapBDRWriteSupport; + BD_CLASS_SUPPORT_BITMAP Class3BitmapBDRWriteSupport; +} FEATURE_BD_WRITE, *PFEATURE_BD_WRITE; + +// 0x0042 - FeatureTSR +typedef struct _FEATURE_TSR { + FEATURE_HEADER Header; +} FEATURE_TSR, *PFEATURE_TSR; + +// 0x0043 - 0x004F are Reserved + +// 0x0050 - FeatureHDDVDRead +typedef struct _FEATURE_DATA_HDDVD_READ { + FEATURE_HEADER Header; + UCHAR Recordable : 1; + UCHAR Reserved0 : 7; + UCHAR Reserved1; + UCHAR Rewritable : 1; // Stands for HD DVD-RAM + UCHAR Reserved2 : 7; + UCHAR Reserved3; +} FEATURE_DATA_HDDVD_READ, *PFEATURE_DATA_HDDVD_READ; + +// 0x0051 - FeatureHDDVDWrite +typedef struct _FEATURE_DATA_HDDVD_WRITE { + FEATURE_HEADER Header; + UCHAR Recordable : 1; + UCHAR Reserved0 : 7; + UCHAR Reserved1; + UCHAR Rewritable : 1; // Stands for HD DVD-RAM + UCHAR Reserved2 : 7; + UCHAR Reserved3; +} FEATURE_DATA_HDDVD_WRITE, *PFEATURE_DATA_HDDVD_WRITE; + +// 0x0052 - 0x007F are Reserved + +// 0x0080 - FeatureHybridDisc +typedef struct _FEATURE_HYBRID_DISC { + FEATURE_HEADER Header; + UCHAR ResetImmunity : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[3]; +} FEATURE_HYBRID_DISC, *PFEATURE_HYBRID_DISC; + +// 0x0081 - 0x00FF are Reserved + +// 0x0100 - FeaturePowerManagement +typedef struct _FEATURE_DATA_POWER_MANAGEMENT { + FEATURE_HEADER Header; +} FEATURE_DATA_POWER_MANAGEMENT, *PFEATURE_DATA_POWER_MANAGEMENT; + +// 0x0101 - FeatureSMART (not in MMC 2) +typedef struct _FEATURE_DATA_SMART { + FEATURE_HEADER Header; + UCHAR FaultFailureReportingPagePresent : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved02[3]; +} FEATURE_DATA_SMART, *PFEATURE_DATA_SMART; + +// 0x0102 - FeatureEmbeddedChanger +typedef struct _FEATURE_DATA_EMBEDDED_CHANGER { + FEATURE_HEADER Header; + UCHAR Reserved1 : 2; + UCHAR SupportsDiscPresent : 1; + UCHAR Reserved2 : 1; + UCHAR SideChangeCapable : 1; + UCHAR Reserved3 : 3; + UCHAR Reserved4[2]; + UCHAR HighestSlotNumber : 5; + UCHAR Reserved : 3; +} FEATURE_DATA_EMBEDDED_CHANGER, *PFEATURE_DATA_EMBEDDED_CHANGER; + +// 0x0103 - FeatureCDAudioAnalogPlay (obsolete) +typedef struct _FEATURE_DATA_CD_AUDIO_ANALOG_PLAY { + FEATURE_HEADER Header; + UCHAR SeperateVolume : 1; + UCHAR SeperateChannelMute : 1; + UCHAR ScanSupported : 1; + UCHAR Reserved1 : 5; + UCHAR Reserved2; + UCHAR NumerOfVolumeLevels[2]; // [0] == MSB, [1] == LSB +} FEATURE_DATA_CD_AUDIO_ANALOG_PLAY, *PFEATURE_DATA_CD_AUDIO_ANALOG_PLAY; + +// 0x0104 - FeatureMicrocodeUpgrade +typedef struct _FEATURE_DATA_MICROCODE_UPDATE { + FEATURE_HEADER Header; + UCHAR M5 : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[3]; +} FEATURE_DATA_MICROCODE_UPDATE, *PFEATURE_DATA_MICROCODE_UPDATE; + +// 0x0105 - FeatureTimeout +typedef struct _FEATURE_DATA_TIMEOUT { + FEATURE_HEADER Header; + UCHAR Group3 : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; + UCHAR UnitLength[2]; +} FEATURE_DATA_TIMEOUT, *PFEATURE_DATA_TIMEOUT; + +// 0x0106 - FeatureDvdCSS +typedef struct _FEATURE_DATA_DVD_CSS { + FEATURE_HEADER Header; + UCHAR Reserved1[3]; + UCHAR CssVersion; +} FEATURE_DATA_DVD_CSS, *PFEATURE_DATA_DVD_CSS; + +// 0x0107 - FeatureRealTimeStreaming +typedef struct _FEATURE_DATA_REAL_TIME_STREAMING { + FEATURE_HEADER Header; + UCHAR StreamRecording : 1; + UCHAR WriteSpeedInGetPerf : 1; + UCHAR WriteSpeedInMP2A : 1; + UCHAR SetCDSpeed : 1; + UCHAR ReadBufferCapacityBlock : 1; + UCHAR Reserved1 : 3; + UCHAR Reserved2[3]; +} FEATURE_DATA_REAL_TIME_STREAMING, *PFEATURE_DATA_REAL_TIME_STREAMING; + +// 0x0108 - FeatureLogicalUnitSerialNumber +typedef struct _FEATURE_DATA_LOGICAL_UNIT_SERIAL_NUMBER { + FEATURE_HEADER Header; +#if !defined(__midl) + UCHAR SerialNumber[0]; +#endif +} FEATURE_DATA_LOGICAL_UNIT_SERIAL_NUMBER, *PFEATURE_DATA_LOGICAL_UNIT_SERIAL_NUMBER; + +// 0x0109 - FeatureMediaSerialNumber +typedef struct _FEATURE_MEDIA_SERIAL_NUMBER { + FEATURE_HEADER Header; +} FEATURE_MEDIA_SERIAL_NUMBER, *PFEATURE_MEDIA_SERIAL_NUMBER; + +// 0x010A - FeatureDiscControlBlocks +// an integral multiple of the _EX structures are returned for page 010A +typedef struct _FEATURE_DATA_DISC_CONTROL_BLOCKS_EX { + UCHAR ContentDescriptor[4]; +} FEATURE_DATA_DISC_CONTROL_BLOCKS_EX, *PFEATURE_DATA_DISC_CONTROL_BLOCKS_EX; +// use a zero-sized array for this.... +typedef struct _FEATURE_DATA_DISC_CONTROL_BLOCKS { + FEATURE_HEADER Header; +#if !defined(__midl) + FEATURE_DATA_DISC_CONTROL_BLOCKS_EX Data[0]; +#endif +} FEATURE_DATA_DISC_CONTROL_BLOCKS, *PFEATURE_DATA_DISC_CONTROL_BLOCKS; + +// 0x010B - FeatureDvdCPRM +typedef struct _FEATURE_DATA_DVD_CPRM { + FEATURE_HEADER Header; + UCHAR Reserved0[3]; + UCHAR CPRMVersion; +} FEATURE_DATA_DVD_CPRM, *PFEATURE_DATA_DVD_CPRM; + +// 0x010C - FeatureFirmwareDate +typedef struct _FEATURE_DATA_FIRMWARE_DATE { + FEATURE_HEADER Header; + UCHAR Year[4]; + UCHAR Month[2]; + UCHAR Day[2]; + UCHAR Hour[2]; + UCHAR Minute[2]; + UCHAR Seconds[2]; + UCHAR Reserved[2]; +} FEATURE_DATA_FIRMWARE_DATE, *PFEATURE_DATA_FIRMWARE_DATE; + +// 0x010D - FeatureAACS +typedef struct _FEATURE_DATA_AACS { + FEATURE_HEADER Header; + UCHAR BindingNonceGeneration : 1; + UCHAR Reserved0 : 7; + UCHAR BindingNonceBlockCount; + UCHAR NumberOfAGIDs : 4; + UCHAR Reserved1 : 4; + UCHAR AACSVersion; +} FEATURE_DATA_AACS, *PFEATURE_DATA_AACS; + +// 0x010E - 0x010F are Reserved + +// 0x0110 - FeatureVCPS +typedef struct _FEATURE_VCPS { + FEATURE_HEADER Header; + UCHAR Reserved[4]; +} FEATURE_VCPS, *PFEATURE_VCPS; + +// 0x0111 - 0xFEFF are Reserved +typedef struct _FEATURE_DATA_RESERVED { + FEATURE_HEADER Header; +#if !defined(__midl) + UCHAR Data[0]; +#endif +} FEATURE_DATA_RESERVED, *PFEATURE_DATA_RESERVED; + +// 0xff00 - 0xffff are Vendor Specific +typedef struct _FEATURE_DATA_VENDOR_SPECIFIC { + FEATURE_HEADER Header; +#if !defined(__midl) + UCHAR VendorSpecificData[0]; +#endif +} FEATURE_DATA_VENDOR_SPECIFIC, *PFEATURE_DATA_VENDOR_SPECIFIC; + + +// +// NOTE: All FEATURE_* structures may be extended. use of these structures +// requires verification that the FeatureHeader->AdditionLength field +// contains AT LEAST enough data to cover the data fields being accessed. +// This is due to the design, which allows extending the size of the +// various structures, which will result in these structures sizes +// being changed over time. +// A 0-element array is however not declared in the variable size +// structures. Such array is declared on some structures to preserve +// legacy, yet it is deprecated. To access variable size structures, +// as they are always at the end of the fixed size structure, use a sizeof +// of the declared fixed size structure as an offset. +// *** Programmers beware! *** +// + +// +// NOTE: This is based on MMC 3, extended to MMC 5 rev 3 +// Further revisions will maintain backward compatibility +// with the non-reserved fields listed here. If you need +// to access a new field, please typecast to FEATURE_DATA_RESERVED +// and access the appropriate bits there. +// + +// +// IOCTL_CDROM_GET_CONFIGURATION returns a FEATURE_* struct, which always +// starts with a FEATURE_HEADER structure. +// + +// +// these are to be used for the request type +// + +#define SCSI_GET_CONFIGURATION_REQUEST_TYPE_ALL 0x0 +#define SCSI_GET_CONFIGURATION_REQUEST_TYPE_CURRENT 0x1 +#define SCSI_GET_CONFIGURATION_REQUEST_TYPE_ONE 0x2 + + +typedef struct _GET_CONFIGURATION_IOCTL_INPUT { + FEATURE_NUMBER Feature; + ULONG RequestType; // SCSI_GET_CONFIGURATION_REQUEST_TYPE_* + PVOID Reserved[2]; +} GET_CONFIGURATION_IOCTL_INPUT, *PGET_CONFIGURATION_IOCTL_INPUT; + +#if defined(_WIN64) +typedef struct _GET_CONFIGURATION_IOCTL_INPUT32 { + FEATURE_NUMBER Feature; + ULONG RequestType; // SCSI_GET_CONFIGURATION_REQUEST_TYPE_* + VOID* UPOINTER_32 Reserved[2]; +} GET_CONFIGURATION_IOCTL_INPUT32, *PGET_CONFIGURATION_IOCTL_INPUT32; +#endif + + +#if _MSC_VER >= 1200 +#pragma warning(pop) // un-sets any local warning changes +#else +#pragma warning(default:4200) // array[0] is not a warning for this file +#endif + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // __NTDDMMC__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmodm.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmodm.h new file mode 100644 index 0000000000000000000000000000000000000000..83ab6e4cbff39c5fa5140bbab71eeca390574117 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmodm.h @@ -0,0 +1,114 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddmodm.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the modem device. + + +--*/ + +#ifndef _NTDDMODM_ +#define _NTDDMODM_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// + +#define IOCTL_MODEM_GET_PASSTHROUGH CTL_CODE(FILE_DEVICE_MODEM, 1,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_MODEM_SET_PASSTHROUGH CTL_CODE(FILE_DEVICE_MODEM, 2,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_SET_DLE_MONITORING CTL_CODE(FILE_DEVICE_MODEM, 3,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_GET_DLE CTL_CODE(FILE_DEVICE_MODEM, 4,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_SET_DLE_SHIELDING CTL_CODE(FILE_DEVICE_MODEM, 5,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_STOP_WAVE_RECEIVE CTL_CODE(FILE_DEVICE_MODEM, 6,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_SEND_MESSAGE CTL_CODE(FILE_DEVICE_MODEM, 7,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_MODEM_GET_MESSAGE CTL_CODE(FILE_DEVICE_MODEM, 8,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_MODEM_SEND_GET_MESSAGE CTL_CODE(FILE_DEVICE_MODEM, 9,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_SEND_LOOPBACK_MESSAGE CTL_CODE(FILE_DEVICE_MODEM, 10,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_CHECK_FOR_MODEM CTL_CODE(FILE_DEVICE_MODEM, 11,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_SET_MIN_POWER CTL_CODE(FILE_DEVICE_MODEM, 12,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_MODEM_WATCH_FOR_RESUME CTL_CODE(FILE_DEVICE_MODEM, 13,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_CANCEL_GET_SEND_MESSAGE CTL_CODE(FILE_DEVICE_MODEM, 14,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_SET_SERVER_STATE CTL_CODE(FILE_DEVICE_MODEM, 15,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define MODEM_NOPASSTHROUGH 0x00000000U +#define MODEM_PASSTHROUGH 0x00000001U +#define MODEM_DCDSNIFF 0x00000002U +#define MODEM_NOPASSTHROUGH_INC_SESSION_COUNT 0x00000003U + +#define MODEM_DLE_MONITORING_OFF 0x00000000 +#define MODEM_DLE_MONITORING_ON 0x00000001 + +#define MODEM_DLE_SHIELDING_OFF 0x00000000 +#define MODEM_DLE_SHIELDING_ON 0x00000001 + +#define MODEM_OPEN_TYPE_TSP 0 +#define MODEM_OPEN_TYPE_CLIENT 1 +#define MODEM_OPEN_TYPE_WAVE 2 + +typedef struct _MODEM_MESSAGE { + + ULONG TotalSize; + ULONG Flags; + ULONG SessionId; + ULONG RequestId; + ULONG Reserved[2]; + +} MODEM_MESSAGE, *PMODEM_MESSAGE; + +#ifdef DEFINE_GUID + +// +// Declare the GUID that represents the device interface for modems. +// + +DEFINE_GUID(GUID_DEVINTERFACE_MODEM, 0x2c7089aa, 0x2e0e, 0x11d1, 0xb1, 0x14, 0x00, 0xc0, 0x4f, 0xc2, 0xaa, 0xe4); + +// +// Obsolete device interface class GUID name. +// (use of above GUID_DEVINTERFACE_* name is recommended). +// + +#define GUID_CLASS_MODEM GUID_DEVINTERFACE_MODEM + +#endif //DEFINE_GUID + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _NTDDMODM_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmou.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmou.h new file mode 100644 index 0000000000000000000000000000000000000000..4c3f55b9674460fff9b96bb2ad3095c4308d8ba4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddmou.h @@ -0,0 +1,267 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddmou.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the mouse device. + +--*/ + +#ifndef _NTDDMOU_ +#define _NTDDMOU_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_MOUSE_DEVICE_NAME "\\Device\\PointerClass" +#define DD_MOUSE_DEVICE_NAME_U L"\\Device\\PointerClass" + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_MOUSE_QUERY_ATTRIBUTES CTL_CODE(FILE_DEVICE_MOUSE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_MOUSE_INSERT_DATA CTL_CODE(FILE_DEVICE_MOUSE, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Declare the GUID that represents the device interface for mice. +// + +#ifndef FAR +#define FAR +#endif + +DEFINE_GUID( GUID_DEVINTERFACE_MOUSE, 0x378de44c, 0x56ef, 0x11d1, + 0xbc, 0x8c, 0x00, 0xa0, 0xc9, 0x14, 0x05, 0xdd ); + +// +// Obsolete device interface class GUID name. +// (use of above GUID_DEVINTERFACE_* name is recommended). +// + +#define GUID_CLASS_MOUSE GUID_DEVINTERFACE_MOUSE + +// +// NtReadFile Output Buffer record structures for this device. +// + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union +#endif + +typedef struct _MOUSE_INPUT_DATA { + + // + // Unit number. E.g., for \Device\PointerPort0 the unit is '0', + // for \Device\PointerPort1 the unit is '1', and so on. + // + + USHORT UnitId; + + // + // Indicator flags. + // + + USHORT Flags; + + // + // The transition state of the mouse buttons. + // + + union { + ULONG Buttons; + struct { + USHORT ButtonFlags; + USHORT ButtonData; + }; + }; + + + // + // The raw state of the mouse buttons. + // + + ULONG RawButtons; + + // + // The signed relative or absolute motion in the X direction. + // + + LONG LastX; + + // + // The signed relative or absolute motion in the Y direction. + // + + LONG LastY; + + // + // Device-specific additional information for the event. + // + + ULONG ExtraInformation; + +} MOUSE_INPUT_DATA, *PMOUSE_INPUT_DATA; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +// +// Define the mouse button state indicators. +// + +#define MOUSE_LEFT_BUTTON_DOWN 0x0001 // Left Button changed to down. +#define MOUSE_LEFT_BUTTON_UP 0x0002 // Left Button changed to up. +#define MOUSE_RIGHT_BUTTON_DOWN 0x0004 // Right Button changed to down. +#define MOUSE_RIGHT_BUTTON_UP 0x0008 // Right Button changed to up. +#define MOUSE_MIDDLE_BUTTON_DOWN 0x0010 // Middle Button changed to down. +#define MOUSE_MIDDLE_BUTTON_UP 0x0020 // Middle Button changed to up. + +#define MOUSE_BUTTON_1_DOWN MOUSE_LEFT_BUTTON_DOWN +#define MOUSE_BUTTON_1_UP MOUSE_LEFT_BUTTON_UP +#define MOUSE_BUTTON_2_DOWN MOUSE_RIGHT_BUTTON_DOWN +#define MOUSE_BUTTON_2_UP MOUSE_RIGHT_BUTTON_UP +#define MOUSE_BUTTON_3_DOWN MOUSE_MIDDLE_BUTTON_DOWN +#define MOUSE_BUTTON_3_UP MOUSE_MIDDLE_BUTTON_UP + +#define MOUSE_BUTTON_4_DOWN 0x0040 +#define MOUSE_BUTTON_4_UP 0x0080 +#define MOUSE_BUTTON_5_DOWN 0x0100 +#define MOUSE_BUTTON_5_UP 0x0200 + +#define MOUSE_WHEEL 0x0400 +#define MOUSE_HWHEEL 0x0800 + +// +// Define the mouse indicator flags. +// + +#define MOUSE_MOVE_RELATIVE 0 +#define MOUSE_MOVE_ABSOLUTE 1 +#define MOUSE_VIRTUAL_DESKTOP 0x02 // the coordinates are mapped to the virtual desktop +#define MOUSE_ATTRIBUTES_CHANGED 0x04 // requery for mouse attributes +#if(_WIN32_WINNT >= 0x0600) +#define MOUSE_MOVE_NOCOALESCE 0x08 // do not coalesce WM_MOUSEMOVEs +#endif /* _WIN32_WINNT >= 0x0600 */ + +#define MOUSE_TERMSRV_SRC_SHADOW 0x100 + +// +// NtDeviceIoControlFile OutputBuffer record structures for +// IOCTL_MOUSE_QUERY_ATTRIBUTES. +// + +typedef struct _MOUSE_ATTRIBUTES { + + // + // Mouse ID value. Used to distinguish between mouse types. + // + + USHORT MouseIdentifier; + + // + // Number of buttons located on the mouse. + // + + USHORT NumberOfButtons; + + // + // Specifies the rate at which the hardware reports mouse input + // (reports per second). This may not be applicable for every mouse device. + // + + USHORT SampleRate; + + // + // Length of the readahead buffer, in bytes. + // + + ULONG InputDataQueueLength; + +} MOUSE_ATTRIBUTES, *PMOUSE_ATTRIBUTES; + +// +// Define the mouse identifier types. +// + +#define MOUSE_INPORT_HARDWARE 0x0001 +#define MOUSE_I8042_HARDWARE 0x0002 +#define MOUSE_SERIAL_HARDWARE 0x0004 +#define BALLPOINT_I8042_HARDWARE 0x0008 +#define BALLPOINT_SERIAL_HARDWARE 0x0010 +#define WHEELMOUSE_I8042_HARDWARE 0x0020 +#define WHEELMOUSE_SERIAL_HARDWARE 0x0040 +#define MOUSE_HID_HARDWARE 0x0080 +#define WHEELMOUSE_HID_HARDWARE 0x0100 +#define HORIZONTAL_WHEEL_PRESENT 0x8000 + +// +// Generic NtDeviceIoControlFile Input Buffer record structure for +// various mouse IOCTLs. +// + +typedef struct _MOUSE_UNIT_ID_PARAMETER { + + // + // Unit identifier. Specifies the device unit for which this + // request is intended. + // + + USHORT UnitId; + +} MOUSE_UNIT_ID_PARAMETER, *PMOUSE_UNIT_ID_PARAMETER; + +// +// Define the base values for the mouse error log packet's +// UniqueErrorValue field. +// + +#define MOUSE_ERROR_VALUE_BASE 20000 + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDMOU_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddndis.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddndis.h new file mode 100644 index 0000000000000000000000000000000000000000..33845b763b9f4d46d35bafefd0bf53b68742a135 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddndis.h @@ -0,0 +1,10918 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddndis.h + +Abstract: + + This is the include file that defines constants and types for interfacing + with network drivers. + +Environment: + + User mode or Kernel mode + +Notes: + + If you are writing kernel mode code, you should #include instead + of including this header directly. + + If you are writing user mode code, you can declare the NDIS contract + version that you are targeting. Available versions are: + + Version First available in + ------------------------------------------------------------------ + 689 Windows 11, gallium release + 688 Windows 11, copper release + 687 Windows 11, nickel release + 686 Windows 11, cobalt release + 685 Windows 10, iron release / Windows Server 2022 + 684 Windows 10, vibranium release + 683 Windows 10, version 1903 + 682 Windows 10, version 1809 + 681 Windows 10, version 1803 + 680 Windows 10, version 1709 + 670 Windows 10, version 1703 + 660 Windows 10, version 1607 / Windows Server 2016 + 651 Windows 10, version 1511 + 650 Windows 10, version 1507 + 640 Windows 8.1 / Windows Server 2012 R2 + 630 Windows 8 / Windows Server 2012 + 620 Windows 7 / Windows Server 2008 R2 + 61 Windows Vista SP1 / Windows Server 2008 RTM + 60 Windows Vista RTM + + To declare the version, use a macro like this (where '630' is any version + from the above table): + + #define UM_NDIS630 + + Alternatively, add the definition to your compiler's options: + + -DUM_NDIS630=1 + + Versions are cumulative; defining 630 will automatically include 620 and + below. There's no need to manually define them all. + +--*/ + +#ifndef _NTDDNDIS_ +#define _NTDDNDIS_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region App Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +//disable warnings +#if _MSC_VER >= 1200 + +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member + +#endif + +#pragma warning(disable:4201) // named type definition in parentheses + +#ifdef __cplusplus +extern "C" { +#endif + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +#include +#include +#include +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define NDIS_INCLUDE_LEGACY_NAMES + +#include + +#include + +#define IOCTL_NDIS_QUERY_GLOBAL_STATS _NDIS_CONTROL_CODE(0, METHOD_OUT_DIRECT) +#define IOCTL_NDIS_QUERY_ALL_STATS _NDIS_CONTROL_CODE(1, METHOD_OUT_DIRECT) +#define IOCTL_NDIS_DO_PNP_OPERATION _NDIS_CONTROL_CODE(2, METHOD_BUFFERED) +#define IOCTL_NDIS_QUERY_SELECTED_STATS _NDIS_CONTROL_CODE(3, METHOD_OUT_DIRECT) +#define IOCTL_NDIS_ENUMERATE_INTERFACES _NDIS_CONTROL_CODE(4, METHOD_BUFFERED) +#define IOCTL_NDIS_ADD_TDI_DEVICE _NDIS_CONTROL_CODE(5, METHOD_BUFFERED) +#define IOCTL_NDIS_GET_LOG_DATA _NDIS_CONTROL_CODE(7, METHOD_OUT_DIRECT) +#define IOCTL_NDIS_GET_VERSION _NDIS_CONTROL_CODE(8, METHOD_BUFFERED) + +#define IOCTL_NDIS_RESERVED1 _NDIS_CONTROL_CODE(9, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED2 _NDIS_CONTROL_CODE(0xA, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED3 _NDIS_CONTROL_CODE(0xB, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED4 _NDIS_CONTROL_CODE(0xC, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED5 CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD, 0xD, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_NDIS_RESERVED6 CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD, 0xE, METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_NDIS_RESERVED7 _NDIS_CONTROL_CODE(0xF, METHOD_OUT_DIRECT) +#define IOCTL_NDIS_RESERVED8 _NDIS_CONTROL_CODE(0x10, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED9 _NDIS_CONTROL_CODE(0x11, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED10 _NDIS_CONTROL_CODE(0x12, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED11 _NDIS_CONTROL_CODE(0x13, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED12 _NDIS_CONTROL_CODE(0x14, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED13 _NDIS_CONTROL_CODE(0x15, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED14 _NDIS_CONTROL_CODE(0x16, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED15 _NDIS_CONTROL_CODE(0x17, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED16 _NDIS_CONTROL_CODE(0x18, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED17 _NDIS_CONTROL_CODE(0x19, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED18 _NDIS_CONTROL_CODE(0x1A, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED19 _NDIS_CONTROL_CODE(0x1B, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED20 _NDIS_CONTROL_CODE(0x1C, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED21 _NDIS_CONTROL_CODE(0x1D, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED22 _NDIS_CONTROL_CODE(0x1E, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED23 _NDIS_CONTROL_CODE(0x1F, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED24 _NDIS_CONTROL_CODE(0x20, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED25 _NDIS_CONTROL_CODE(0x21, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED26 _NDIS_CONTROL_CODE(0x22, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED27 _NDIS_CONTROL_CODE(0x23, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED28 _NDIS_CONTROL_CODE(0x24, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED29 _NDIS_CONTROL_CODE(0x25, METHOD_BUFFERED) +#define IOCTL_NDIS_RESERVED30 _NDIS_CONTROL_CODE(0x26, METHOD_BUFFERED) + +// +// NtDeviceIoControlFile InputBuffer/OutputBuffer record structures for +// this device. +// + +#include + +// +// IOCTL_NDIS_QUERY_ALL_STATS returns a sequence of these, packed +// together. This structure is unaligned because not all statistics +// have a length that is a ULONG multiple. +// + +typedef struct _NDIS_STATISTICS_VALUE +{ + NDIS_OID Oid; + ULONG DataLength; + _Field_size_bytes_(DataLength) + UCHAR Data[1]; // variable length +} NDIS_STATISTICS_VALUE; + +typedef NDIS_STATISTICS_VALUE UNALIGNED *PNDIS_STATISTICS_VALUE; + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +typedef _Struct_size_bytes_(Length) struct _NDIS_STATISTICS_VALUE_EX +{ + NDIS_OID Oid; + ULONG DataLength; // the length of the OID data + ULONG Length; // the length of this instance of NDIS_STATISTICS_VALUE_EX + _Field_size_bytes_(DataLength) + UCHAR Data[1]; // variable length +} NDIS_STATISTICS_VALUE_EX; + +typedef NDIS_STATISTICS_VALUE_EX UNALIGNED *PNDIS_STATISTICS_VALUE_EX; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +// +// Structure used to define a self-contained variable data structure +// +typedef struct _NDIS_VAR_DATA_DESC +{ + USHORT Length; // # of octects of data + USHORT MaximumLength; // # of octects available + ULONG_PTR Offset; // Offset of data relative to the descriptor +} NDIS_VAR_DATA_DESC, *PNDIS_VAR_DATA_DESC; + +#ifndef GUID_DEFINED +#include +#endif // !GUID_DEFINED + +// +// NDIS Object Types used in NDIS_OBJECT_HEADER +// +#define NDIS_OBJECT_TYPE_DEFAULT 0x80 // used when object type is implicit in the API call +#define NDIS_OBJECT_TYPE_MINIPORT_INIT_PARAMETERS 0x81 // used by NDIS in NDIS_MINIPORT_INIT_PARAMETERS +#define NDIS_OBJECT_TYPE_SG_DMA_DESCRIPTION 0x83 // used by miniport drivers in NDIS_SG_DMA_DESCRIPTION +#define NDIS_OBJECT_TYPE_MINIPORT_INTERRUPT 0x84 // used by miniport drivers in NDIS_MINIPORT_INTERRUPT_EX +#define NDIS_OBJECT_TYPE_DEVICE_OBJECT_ATTRIBUTES 0x85 // used by miniport or filter drivers in NDIS_DEVICE_OBJECT_ATTRIBUTES +#define NDIS_OBJECT_TYPE_BIND_PARAMETERS 0x86 // used by NDIS in NDIS_BIND_PARAMETERS +#define NDIS_OBJECT_TYPE_OPEN_PARAMETERS 0x87 // used by protocols in NDIS_OPEN_PARAMETERS +#define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88 // used by miniport in NDIS_RECEIVE_SCALE_CAPABILITIES +#define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89 // used by miniport and protocol in NDIS_RECEIVE_SCALE_PARAMETERS +#define NDIS_OBJECT_TYPE_MINIPORT_DRIVER_CHARACTERISTICS 0x8A +#define NDIS_OBJECT_TYPE_FILTER_DRIVER_CHARACTERISTICS 0x8B +#define NDIS_OBJECT_TYPE_FILTER_PARTIAL_CHARACTERISTICS 0x8C +#define NDIS_OBJECT_TYPE_FILTER_ATTRIBUTES 0x8D +#define NDIS_OBJECT_TYPE_CLIENT_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS 0x8E +#define NDIS_OBJECT_TYPE_PROVIDER_CHIMNEY_OFFLOAD_GENERIC_CHARACTERISTICS 0x8F +#define NDIS_OBJECT_TYPE_CO_PROTOCOL_CHARACTERISTICS 0x90 +#define NDIS_OBJECT_TYPE_CO_MINIPORT_CHARACTERISTICS 0x91 +#define NDIS_OBJECT_TYPE_MINIPORT_PNP_CHARACTERISTICS 0x92 +#define NDIS_OBJECT_TYPE_CLIENT_CHIMNEY_OFFLOAD_CHARACTERISTICS 0x93 +#define NDIS_OBJECT_TYPE_PROVIDER_CHIMNEY_OFFLOAD_CHARACTERISTICS 0x94 +#define NDIS_OBJECT_TYPE_PROTOCOL_DRIVER_CHARACTERISTICS 0x95 +#define NDIS_OBJECT_TYPE_REQUEST_EX 0x96 // deprecated +#define NDIS_OBJECT_TYPE_TIMER_CHARACTERISTICS 0x97 +#define NDIS_OBJECT_TYPE_STATUS_INDICATION 0x98 +#define NDIS_OBJECT_TYPE_FILTER_ATTACH_PARAMETERS 0x99 +#define NDIS_OBJECT_TYPE_FILTER_PAUSE_PARAMETERS 0x9A +#define NDIS_OBJECT_TYPE_FILTER_RESTART_PARAMETERS 0x9B +#define NDIS_OBJECT_TYPE_PORT_CHARACTERISTICS 0x9C +#define NDIS_OBJECT_TYPE_PORT_STATE 0x9D +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_REGISTRATION_ATTRIBUTES 0x9E +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_GENERAL_ATTRIBUTES 0x9F +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_OFFLOAD_ATTRIBUTES 0xA0 +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_NATIVE_802_11_ATTRIBUTES 0xA1 +#define NDIS_OBJECT_TYPE_RESTART_GENERAL_ATTRIBUTES 0xA2 +#define NDIS_OBJECT_TYPE_PROTOCOL_RESTART_PARAMETERS 0xA3 +#define NDIS_OBJECT_TYPE_MINIPORT_ADD_DEVICE_REGISTRATION_ATTRIBUTES 0xA4 +#define NDIS_OBJECT_TYPE_CO_CALL_MANAGER_OPTIONAL_HANDLERS 0xA5 +#define NDIS_OBJECT_TYPE_CO_CLIENT_OPTIONAL_HANDLERS 0xA6 +#define NDIS_OBJECT_TYPE_OFFLOAD 0xA7 +#define NDIS_OBJECT_TYPE_OFFLOAD_ENCAPSULATION 0xA8 +#define NDIS_OBJECT_TYPE_CONFIGURATION_OBJECT 0xA9 +#define NDIS_OBJECT_TYPE_DRIVER_WRAPPER_OBJECT 0xAA +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_OBJECT_TYPE_HD_SPLIT_ATTRIBUTES 0xAB +#endif // (NDIS_SUPPORT_NDIS61) +#define NDIS_OBJECT_TYPE_NSI_NETWORK_RW_STRUCT 0xAC +#define NDIS_OBJECT_TYPE_NSI_COMPARTMENT_RW_STRUCT 0xAD +#define NDIS_OBJECT_TYPE_NSI_INTERFACE_PERSIST_RW_STRUCT 0xAE +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES 0xAF +#endif // (NDIS_SUPPORT_NDIS61) +#if (NDIS_SUPPORT_NDIS620) +#define NDIS_OBJECT_TYPE_SHARED_MEMORY_PROVIDER_CHARACTERISTICS 0xB0 +#define NDIS_OBJECT_TYPE_RSS_PROCESSOR_INFO 0xB1 +#endif // (NDIS_SUPPORT_NDIS620) +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_OBJECT_TYPE_NDK_PROVIDER_CHARACTERISTICS 0xB2 +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_NDK_ATTRIBUTES 0xB3 +#define NDIS_OBJECT_TYPE_MINIPORT_SS_CHARACTERISTICS 0xB4 +#define NDIS_OBJECT_TYPE_QOS_CAPABILITIES 0xB5 +#define NDIS_OBJECT_TYPE_QOS_PARAMETERS 0xB6 +#define NDIS_OBJECT_TYPE_QOS_CLASSIFICATION_ELEMENT 0xB7 +#define NDIS_OBJECT_TYPE_SWITCH_OPTIONAL_HANDLERS 0xB8 + +#endif // (NDIS_SUPPORT_NDIS630) + + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_OBJECT_TYPE_PD_TRANSMIT_QUEUE 0xBE +#define NDIS_OBJECT_TYPE_PD_RECEIVE_QUEUE 0xBF +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_PACKET_DIRECT_ATTRIBUTES 0xC5 +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS670) +#define NDIS_OBJECT_TYPE_MINIPORT_DEVICE_POWER_NOTIFICATION 0xC6 +#endif // (NDIS_SUPPORT_NDIS670) + + +#define NDIS_OBJECT_TYPE_RSS_PARAMETERS_V2 0xC8 // used by miniport and protocol in NDIS_RECEIVE_SCALE_PARAMETERS_V2 +#define NDIS_OBJECT_TYPE_RSS_SET_INDIRECTION_ENTRIES 0xC9 // used by miniport and protocol in NDIS_RSS_SET_INDIRECTION_ENTRIES + +#include + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + +// +// flags for NDIS_STATISTICS_INFO->SupportedStatistics structure +// +#define NDIS_STATISTICS_FLAGS_VALID_DIRECTED_FRAMES_RCV 0x00000001 +#define NDIS_STATISTICS_FLAGS_VALID_MULTICAST_FRAMES_RCV 0x00000002 +#define NDIS_STATISTICS_FLAGS_VALID_BROADCAST_FRAMES_RCV 0x00000004 +#define NDIS_STATISTICS_FLAGS_VALID_BYTES_RCV 0x00000008 +#define NDIS_STATISTICS_FLAGS_VALID_RCV_DISCARDS 0x00000010 +#define NDIS_STATISTICS_FLAGS_VALID_RCV_ERROR 0x00000020 +#define NDIS_STATISTICS_FLAGS_VALID_DIRECTED_FRAMES_XMIT 0x00000040 +#define NDIS_STATISTICS_FLAGS_VALID_MULTICAST_FRAMES_XMIT 0x00000080 +#define NDIS_STATISTICS_FLAGS_VALID_BROADCAST_FRAMES_XMIT 0x00000100 +#define NDIS_STATISTICS_FLAGS_VALID_BYTES_XMIT 0x00000200 +#define NDIS_STATISTICS_FLAGS_VALID_XMIT_ERROR 0x00000400 +#define NDIS_STATISTICS_FLAGS_VALID_XMIT_DISCARDS 0x00008000 +#define NDIS_STATISTICS_FLAGS_VALID_DIRECTED_BYTES_RCV 0x00010000 +#define NDIS_STATISTICS_FLAGS_VALID_MULTICAST_BYTES_RCV 0x00020000 +#define NDIS_STATISTICS_FLAGS_VALID_BROADCAST_BYTES_RCV 0x00040000 +#define NDIS_STATISTICS_FLAGS_VALID_DIRECTED_BYTES_XMIT 0x00080000 +#define NDIS_STATISTICS_FLAGS_VALID_MULTICAST_BYTES_XMIT 0x00100000 +#define NDIS_STATISTICS_FLAGS_VALID_BROADCAST_BYTES_XMIT 0x00200000 + + +#define NDIS_STATISTICS_INFO_REVISION_1 1 + +// +// structure used in OID_GEN_STATISTICS +// +typedef struct _NDIS_STATISTICS_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG SupportedStatistics; + ULONG64 ifInDiscards; // OID_GEN_RCV_DISCARDS + ULONG64 ifInErrors; // OID_GEN_RCV_ERROR + ULONG64 ifHCInOctets; // OID_GEN_BYTES_RCV = OID_GEN_DIRECTED_BYTES_RCV + OID_GEN_MULTICAST_BYTES_RCV + OID_GEN_BROADCAST_BYTES_RCV + ULONG64 ifHCInUcastPkts; // OID_GEN_DIRECTED_FRAMES_RCV + ULONG64 ifHCInMulticastPkts; // OID_GEN_MULTICAST_FRAMES_RCV + ULONG64 ifHCInBroadcastPkts; // OID_GEN_BROADCAST_FRAMES_RCV + ULONG64 ifHCOutOctets; // OID_GEN_BYTES_XMIT = OID_GEN_DIRECTED_BYTES_XMIT + OID_GEN_MULTICAST_BYTES_XMIT + OID_GEN_BROADCAST_BYTES_XMIT + ULONG64 ifHCOutUcastPkts; // OID_GEN_DIRECTED_FRAMES_XMIT + ULONG64 ifHCOutMulticastPkts; // OID_GEN_MULTICAST_FRAMES_XMIT + ULONG64 ifHCOutBroadcastPkts; // OID_GEN_BROADCAST_FRAMES_XMIT + ULONG64 ifOutErrors; // OID_GEN_XMIT_ERROR + ULONG64 ifOutDiscards; // OID_GEN_XMIT_DISCARDS + ULONG64 ifHCInUcastOctets; // OID_GEN_DIRECTED_BYTES_RCV + ULONG64 ifHCInMulticastOctets; // OID_GEN_MULTICAST_BYTES_RCV + ULONG64 ifHCInBroadcastOctets; // OID_GEN_BROADCAST_BYTES_RCV + ULONG64 ifHCOutUcastOctets; // OID_GEN_DIRECTED_BYTES_XMIT + ULONG64 ifHCOutMulticastOctets; // OID_GEN_MULTICAST_BYTES_XMIT + ULONG64 ifHCOutBroadcastOctets; // OID_GEN_BROADCAST_BYTES_XMIT + +}NDIS_STATISTICS_INFO, *PNDIS_STATISTICS_INFO; + +#define NDIS_SIZEOF_STATISTICS_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_STATISTICS_INFO, ifHCOutBroadcastOctets) + +#if (NDIS_SUPPORT_NDIS630) + +// +// structure used in OID_TCP_RSC_STATISTICS +// +typedef struct _NDIS_RSC_STATISTICS_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG64 CoalescedPkts; // Total number of packets that were coalesced + ULONG64 CoalescedOctets; // Total number of bytes that were coalesced + ULONG64 CoalesceEvents; // Total number of coalescing events (i.e. packets formed from coalescing) + ULONG64 Aborts; // Total number of Abort events + +}NDIS_RSC_STATISTICS_INFO, *PNDIS_RSC_STATISTICS_INFO; + +#define NDIS_RSC_STATISTICS_REVISION_1 1 + +#define NDIS_SIZEOF_RSC_STATISTICS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSC_STATISTICS_INFO, Aborts) + +#endif // (NDIS_SUPPORT_NDIS630) + +// +// interrupt moderation structures and definitions +// + +// +// enum value used in NDIS_INTERRUPT_MODERATION_PARAMETERS structure +// +typedef enum _NDIS_INTERRUPT_MODERATION +{ + NdisInterruptModerationUnknown, + NdisInterruptModerationNotSupported, + NdisInterruptModerationEnabled, + NdisInterruptModerationDisabled +} NDIS_INTERRUPT_MODERATION, *PNDIS_INTERRUPT_MODERATION; + +// +// Bits used in Flags parameter of NDIS_INTERRUPT_MODERATION_PARAMETERS structure: +// +#define NDIS_INTERRUPT_MODERATION_CHANGE_NEEDS_RESET 0x00000001 +#define NDIS_INTERRUPT_MODERATION_CHANGE_NEEDS_REINITIALIZE 0x00000002 + + +// +// structure used in OID_GEN_INTERRUPT_MODERATION +// + +#define NDIS_INTERRUPT_MODERATION_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_INTERRUPT_MODERATION_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_INTERRUPT_MODERATION InterruptModeration; +}NDIS_INTERRUPT_MODERATION_PARAMETERS, *PNDIS_INTERRUPT_MODERATION_PARAMETERS; + +#define NDIS_SIZEOF_INTERRUPT_MODERATION_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_INTERRUPT_MODERATION_PARAMETERS, InterruptModeration) + +// +// structure used in OID_GEN_TIMEOUT_DPC_REQUEST_CAPABILITIES +// + +#define NDIS_TIMEOUT_DPC_REQUEST_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_TIMEOUT_DPC_REQUEST_CAPABILITIES +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG TimeoutArrayLength; + ULONG TimeoutArray[1]; +}NDIS_TIMEOUT_DPC_REQUEST_CAPABILITIES, *PNDIS_TIMEOUT_DPC_REQUEST_CAPABILITIES; + +#define NDIS_SIZEOF_TIMEOUT_DPC_REQUEST_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_TIMEOUT_DPC_REQUEST_CAPABILITIES, TimeoutArray) + +// +// PCI custom properties. used in OID_GEN_PCI_DEVICE_CUSTOM_PROPERTIES +// + +#define NDIS_OBJECT_TYPE_PCI_DEVICE_CUSTOM_PROPERTIES_REVISION_1 1 + +#if ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) +#define NDIS_OBJECT_TYPE_PCI_DEVICE_CUSTOM_PROPERTIES_REVISION_2 2 +#endif + +typedef struct _NDIS_PCI_DEVICE_CUSTOM_PROPERTIES +{ + NDIS_OBJECT_HEADER Header; + UINT32 DeviceType; // conventional, PCI-X, PCI-E, etc. + UINT32 CurrentSpeedAndMode; // PCI_DEVICE_CONVENTIONAL_xx or PCIX_MODExxx. valid only for conventional and PCI-X devices + UINT32 CurrentPayloadSize; // PCI_EXPRESS_MAX_PAYLOAD_SIZE, valid only for PCI-E devices + UINT32 MaxPayloadSize; // PCI_EXPRESS_MAX_PAYLOAD_SIZE, valid only for PCI-E devices + UINT32 MaxReadRequestSize; // PCI_EXPRESS_MAX_PAYLOAD_SIZE, valid only for PCI-E devices + UINT32 CurrentLinkSpeed; // PCI_EXPRESS_LINK_SPEED_xxx. valid only for PCI-E devices + UINT32 CurrentLinkWidth; // PCI_EXPRESS_LINK_WIDTH_xx. valid only for PCI-E devices + UINT32 MaxLinkSpeed; // PCI_EXPRESS_LINK_SPEED_xxx. valid only for PCI-E devices + UINT32 MaxLinkWidth; // PCI_EXPRESS_LINK_WIDTH_xx. valid only for PCI-E devices +#if ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) + UINT32 PciExpressVersion; // DevProp_PciExpressDevice_Spec_Version_xx, valid for PCI -E devices + UINT32 InterruptType; // DevProp_PciDevice_InterruptType_xx + UINT32 MaxInterruptMessages; +#endif +} NDIS_PCI_DEVICE_CUSTOM_PROPERTIES, *PNDIS_PCI_DEVICE_CUSTOM_PROPERTIES; + +#define NDIS_SIZEOF_PCI_DEVICE_CUSTOM_PROPERTIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PCI_DEVICE_CUSTOM_PROPERTIES, MaxLinkWidth) + +#if ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) +#define NDIS_SIZEOF_PCI_DEVICE_CUSTOM_PROPERTIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PCI_DEVICE_CUSTOM_PROPERTIES, MaxInterruptMessages) +#endif + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + + +// +// General Objects +// + +// +// Required OIDs +// +#define OID_GEN_SUPPORTED_LIST 0x00010101 +#define OID_GEN_HARDWARE_STATUS 0x00010102 +#define OID_GEN_MEDIA_SUPPORTED 0x00010103 +#define OID_GEN_MEDIA_IN_USE 0x00010104 +#define OID_GEN_MAXIMUM_LOOKAHEAD 0x00010105 +#define OID_GEN_MAXIMUM_FRAME_SIZE 0x00010106 +#define OID_GEN_LINK_SPEED 0x00010107 +#define OID_GEN_TRANSMIT_BUFFER_SPACE 0x00010108 +#define OID_GEN_RECEIVE_BUFFER_SPACE 0x00010109 +#define OID_GEN_TRANSMIT_BLOCK_SIZE 0x0001010A +#define OID_GEN_RECEIVE_BLOCK_SIZE 0x0001010B +#define OID_GEN_VENDOR_ID 0x0001010C +#define OID_GEN_VENDOR_DESCRIPTION 0x0001010D +#define OID_GEN_CURRENT_PACKET_FILTER 0x0001010E +#define OID_GEN_CURRENT_LOOKAHEAD 0x0001010F +#define OID_GEN_DRIVER_VERSION 0x00010110 +#define OID_GEN_MAXIMUM_TOTAL_SIZE 0x00010111 +#define OID_GEN_PROTOCOL_OPTIONS 0x00010112 +#define OID_GEN_MAC_OPTIONS 0x00010113 +#define OID_GEN_MEDIA_CONNECT_STATUS 0x00010114 +#define OID_GEN_MAXIMUM_SEND_PACKETS 0x00010115 + +// +// Optional OIDs +// +#define OID_GEN_VENDOR_DRIVER_VERSION 0x00010116 +#define OID_GEN_SUPPORTED_GUIDS 0x00010117 +#define OID_GEN_NETWORK_LAYER_ADDRESSES 0x00010118 // Set only +#define OID_GEN_TRANSPORT_HEADER_OFFSET 0x00010119 // Set only +#define OID_GEN_MEDIA_CAPABILITIES 0x00010201 +#define OID_GEN_PHYSICAL_MEDIUM 0x00010202 + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +// +// new optional for NDIS 6.0 +// +#define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 // query only +#define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 // query and set + +// +// new for NDIS 6.0. NDIS will handle on behalf of the miniports +// +#define OID_GEN_MAC_ADDRESS 0x00010205 // query and set +#define OID_GEN_MAX_LINK_SPEED 0x00010206 // query only +#define OID_GEN_LINK_STATE 0x00010207 // query only + +// +// new and required for NDIS 6 miniports +// +#define OID_GEN_LINK_PARAMETERS 0x00010208 // set only +#define OID_GEN_INTERRUPT_MODERATION 0x00010209 // query and set +#define OID_GEN_NDIS_RESERVED_3 0x0001020A +#define OID_GEN_NDIS_RESERVED_4 0x0001020B +#define OID_GEN_NDIS_RESERVED_5 0x0001020C + + +// +// Port related OIDs +// +#define OID_GEN_ENUMERATE_PORTS 0x0001020D // query only, handled by NDIS +#define OID_GEN_PORT_STATE 0x0001020E // query only, handled by NDIS +#define OID_GEN_PORT_AUTHENTICATION_PARAMETERS 0x0001020F // Set only + +// +// optional OID for NDIS 6 miniports +// +#define OID_GEN_TIMEOUT_DPC_REQUEST_CAPABILITIES 0x00010210 // query only + +// +// this OID is handled by NDIS for PCI devices +// +#define OID_GEN_PCI_DEVICE_CUSTOM_PROPERTIES 0x00010211 // query only +#define OID_GEN_NDIS_RESERVED_6 0x00010212 +#define OID_GEN_PHYSICAL_MEDIUM_EX 0x00010213 // query only + + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS3) || NDIS_SUPPORT_NDIS680) +// RSSv2 standard OID: control scaling parameters +#define OID_GEN_RECEIVE_SCALE_PARAMETERS_V2 0x00010214 // query and set +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_RS3) || NDIS_SUPPORT_NDIS680) + +#define OID_GEN_MACHINE_NAME 0x0001021A // set only +#define OID_GEN_RNDIS_CONFIG_PARAMETER 0x0001021B // Set only +#define OID_GEN_VLAN_ID 0x0001021C + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +#define OID_GEN_RECEIVE_HASH 0x0001021F // query and set +#define OID_GEN_MINIPORT_RESTART_ATTRIBUTES 0x0001021D + +#if (NDIS_SUPPORT_NDIS61) +// +// Optional OID for header data/split +// +#define OID_GEN_HD_SPLIT_PARAMETERS 0x0001021E // Set only +#define OID_GEN_HD_SPLIT_CURRENT_CONFIG 0x00010220 // Query only +#endif // (NDIS_SUPPORT_NDIS61) + +// +// the following OIDs are used in querying interfaces +// +#define OID_GEN_PROMISCUOUS_MODE 0x00010280 // used in querying interfaces +#define OID_GEN_LAST_CHANGE 0x00010281 // used in querying interfaces +#define OID_GEN_DISCONTINUITY_TIME 0x00010282 // used in querying interfaces +#define OID_GEN_OPERATIONAL_STATUS 0x00010283 // used in querying interfaces +#define OID_GEN_XMIT_LINK_SPEED 0x00010284 // used in querying interfaces +#define OID_GEN_RCV_LINK_SPEED 0x00010285 // used in querying interfaces +#define OID_GEN_UNKNOWN_PROTOS 0x00010286 // used in querying interfaces +#define OID_GEN_INTERFACE_INFO 0x00010287 // used in querying interfaces +#define OID_GEN_ADMIN_STATUS 0x00010288 // used in querying interfaces +#define OID_GEN_ALIAS 0x00010289 // used in querying interfaces +#define OID_GEN_MEDIA_CONNECT_STATUS_EX 0x0001028A // used in querying interfaces +#define OID_GEN_LINK_SPEED_EX 0x0001028B // used in querying interfaces +#define OID_GEN_MEDIA_DUPLEX_STATE 0x0001028C // used in querying interfaces +#define OID_GEN_IP_OPER_STATUS 0x0001028D // used in querying interfaces + +// +// WWAN specific oids +// +#define OID_WWAN_DRIVER_CAPS 0x0e010100 +#define OID_WWAN_DEVICE_CAPS 0x0e010101 +#define OID_WWAN_READY_INFO 0x0e010102 +#define OID_WWAN_RADIO_STATE 0x0e010103 +#define OID_WWAN_PIN 0x0e010104 +#define OID_WWAN_PIN_LIST 0x0e010105 +#define OID_WWAN_HOME_PROVIDER 0x0e010106 +#define OID_WWAN_PREFERRED_PROVIDERS 0x0e010107 +#define OID_WWAN_VISIBLE_PROVIDERS 0x0e010108 +#define OID_WWAN_REGISTER_STATE 0x0e010109 +#define OID_WWAN_PACKET_SERVICE 0x0e01010a +#define OID_WWAN_SIGNAL_STATE 0x0e01010b +#define OID_WWAN_CONNECT 0x0e01010c +#define OID_WWAN_PROVISIONED_CONTEXTS 0x0e01010d +#define OID_WWAN_SERVICE_ACTIVATION 0x0e01010e +#define OID_WWAN_SMS_CONFIGURATION 0x0e01010f +#define OID_WWAN_SMS_READ 0x0e010110 +#define OID_WWAN_SMS_SEND 0x0e010111 +#define OID_WWAN_SMS_DELETE 0x0e010112 +#define OID_WWAN_SMS_STATUS 0x0e010113 +#define OID_WWAN_VENDOR_SPECIFIC 0x0e010114 + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if ((NTDDI_VERSION >= NTDDI_WIN8) || NDIS_SUPPORT_NDIS630) + +// +// More WWAN specific oids +// +#define OID_WWAN_AUTH_CHALLENGE 0x0e010115 +#define OID_WWAN_ENUMERATE_DEVICE_SERVICES 0x0e010116 +#define OID_WWAN_SUBSCRIBE_DEVICE_SERVICE_EVENTS 0x0e010117 +#define OID_WWAN_DEVICE_SERVICE_COMMAND 0x0e010118 +#define OID_WWAN_USSD 0x0e010119 +#define OID_WWAN_PIN_EX 0x0e010121 +#define OID_WWAN_ENUMERATE_DEVICE_SERVICE_COMMANDS 0x0e010122 +#define OID_WWAN_DEVICE_SERVICE_SESSION 0x0e010123 +#define OID_WWAN_DEVICE_SERVICE_SESSION_WRITE 0x0e010124 +#define OID_WWAN_PREFERRED_MULTICARRIER_PROVIDERS 0x0e010125 +#define OID_WWAN_CREATE_MAC 0x0e010126 +#define OID_WWAN_DELETE_MAC 0x0e010127 +#endif // ((NTDDI_VERSION >= NTDDI_WIN8) || NDIS_SUPPORT_NDIS630) + +#if ((NTDDI_VERSION >= NTDDI_WINTHRESHOLD) || NDIS_SUPPORT_NDIS650) +// +// More WWAN specific oids +// +#define OID_WWAN_UICC_FILE_STATUS 0x0e010128 +#define OID_WWAN_UICC_ACCESS_BINARY 0x0e010129 +#define OID_WWAN_UICC_ACCESS_RECORD 0x0e01012a +#define OID_WWAN_PIN_EX2 0x0e01012b +#define OID_WWAN_MBIM_VERSION 0x0e01012c +#define OID_WWAN_SYS_CAPS 0x0e01012d +#define OID_WWAN_DEVICE_CAPS_EX 0x0e01012e +#define OID_WWAN_SYS_SLOTMAPPINGS 0x0e01012f +#define OID_WWAN_SLOT_INFO_STATUS 0x0e010130 +#define OID_WWAN_DEVICE_BINDINGS 0x0e010131 +#define OID_WWAN_REGISTER_STATE_EX 0x0e010132 +#define OID_WWAN_IMS_VOICE_STATE 0x0e010133 +#define OID_WWAN_SIGNAL_STATE_EX 0x0e010134 +#define OID_WWAN_LOCATION_STATE 0x0e010135 +#define OID_WWAN_NITZ 0x0e010136 +#define OID_WWAN_NETWORK_IDLE_HINT 0x0e010137 +#endif // ((NTDDI_VERSION >= NTDDI_WINTHRESHOLD) || NDIS_SUPPORT_NDIS650) + +#if ((NTDDI_VERSION >= NTDDI_WIN10) || NDIS_SUPPORT_NDIS651) +// +// More WWAN specific oids +// +#define OID_WWAN_PRESHUTDOWN 0x0e010138 +#endif // ((NTDDI_VERSION >= NTDDI_WIN10) || NDIS_SUPPORT_NDIS651) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS1) || NDIS_SUPPORT_NDIS660) +// +// More WWAN specific oids +// +#define OID_WWAN_UICC_ATR 0x0e010139 +#define OID_WWAN_UICC_OPEN_CHANNEL 0x0e01013a +#define OID_WWAN_UICC_CLOSE_CHANNEL 0x0e01013b +#define OID_WWAN_UICC_APDU 0x0e01013c +#define OID_WWAN_UICC_TERMINAL_CAPABILITY 0x0e01013d +#define OID_WWAN_PS_MEDIA_CONFIG 0x0e01013e +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_RS1) || NDIS_SUPPORT_NDIS660) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS2) || NDIS_SUPPORT_NDIS670) +// +// More WWAN specific oids +// +#define OID_WWAN_SAR_CONFIG 0x0e01013f +#define OID_WWAN_SAR_TRANSMISSION_STATUS 0x0e010140 +#define OID_WWAN_NETWORK_BLACKLIST 0x0e010141 +#define OID_WWAN_LTE_ATTACH_CONFIG 0x0e010142 +#define OID_WWAN_LTE_ATTACH_STATUS 0x0e010143 +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_RS2) || NDIS_SUPPORT_NDIS670) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS3) || NDIS_SUPPORT_NDIS680) +// +// Even more WWAN specific oids +// +#define OID_WWAN_MODEM_CONFIG_INFO 0x0e010144 +#define OID_WWAN_PCO 0x0e010145 +#define OID_WWAN_UICC_RESET 0x0e010146 +#define OID_WWAN_DEVICE_RESET 0x0e010147 +#define OID_WWAN_BASE_STATIONS_INFO 0x0e010148 +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_RS3) || NDIS_SUPPORT_NDIS680) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS4) || NDIS_SUPPORT_NDIS680) +// +// more WWAN specific oids (may need to restrict to higher NDIS version such as 7.0) +// +#define OID_WWAN_MPDP 0x0e010149 +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_RS4) || NDIS_SUPPORT_NDIS680) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_19H1) || NDIS_SUPPORT_NDIS683) +#define OID_WWAN_UICC_APP_LIST 0x0e01014a +#define OID_WWAN_MODEM_LOGGING_CONFIG 0x0e01014b +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_19H1) || NDIS_SUPPORT_NDIS683) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_VB) || NDIS_SUPPORT_NDIS684) +#define OID_WWAN_REGISTER_PARAMS 0x0e01014c +#define OID_WWAN_NETWORK_PARAMS 0x0e01014d +#endif // ((NTDDI_VERSION >= NTDDI_WIN10_VB) || NDIS_SUPPORT_NDIS684) + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) +#define OID_WWAN_UE_POLICY 0x0e01014e +#endif + +// +// Required statistics +// +#define OID_GEN_XMIT_OK 0x00020101 +#define OID_GEN_RCV_OK 0x00020102 +#define OID_GEN_XMIT_ERROR 0x00020103 +#define OID_GEN_RCV_ERROR 0x00020104 +#define OID_GEN_RCV_NO_BUFFER 0x00020105 + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +// +// mandatory for NDIS 6.0 and higher miniports +// +#define OID_GEN_STATISTICS 0x00020106 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +// +// Optional statistics +// +#define OID_GEN_DIRECTED_BYTES_XMIT 0x00020201 +#define OID_GEN_DIRECTED_FRAMES_XMIT 0x00020202 +#define OID_GEN_MULTICAST_BYTES_XMIT 0x00020203 +#define OID_GEN_MULTICAST_FRAMES_XMIT 0x00020204 +#define OID_GEN_BROADCAST_BYTES_XMIT 0x00020205 +#define OID_GEN_BROADCAST_FRAMES_XMIT 0x00020206 +#define OID_GEN_DIRECTED_BYTES_RCV 0x00020207 +#define OID_GEN_DIRECTED_FRAMES_RCV 0x00020208 +#define OID_GEN_MULTICAST_BYTES_RCV 0x00020209 +#define OID_GEN_MULTICAST_FRAMES_RCV 0x0002020A +#define OID_GEN_BROADCAST_BYTES_RCV 0x0002020B +#define OID_GEN_BROADCAST_FRAMES_RCV 0x0002020C +#define OID_GEN_RCV_CRC_ERROR 0x0002020D +#define OID_GEN_TRANSMIT_QUEUE_LENGTH 0x0002020E + +#define OID_GEN_GET_TIME_CAPS 0x0002020F +#define OID_GEN_GET_NETCARD_TIME 0x00020210 +#define OID_GEN_NETCARD_LOAD 0x00020211 +#define OID_GEN_DEVICE_PROFILE 0x00020212 + +// +// The following are exported by NDIS itself and are only queryable. +// + +// +// the time in milliseconds a driver took to initialize. +// +#define OID_GEN_INIT_TIME_MS 0x00020213 + +// +// the number of times the miniport adapter was reset +// +#define OID_GEN_RESET_COUNTS 0x00020214 + +// +// the number of timer the miniport reported a media state change +// +#define OID_GEN_MEDIA_SENSE_COUNTS 0x00020215 + +// +// the friendly name of the adapter +// +#define OID_GEN_FRIENDLY_NAME 0x00020216 + +// +// returns miniport information such as whether the driver is serialized or not +// if it supports sending multiple packets, etc. refer to NDIS_MINIPORT_XXX flags +// +#define OID_GEN_NDIS_RESERVED_1 0x00020217 + +// +// handled by NDIS to reset the test verification parameters on the +// miniport +// +#define OID_GEN_NDIS_RESERVED_2 0x00020218 +#define OID_GEN_NDIS_RESERVED_5 0x0001020C + + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +// +// more optional OIDs new for NDIS 6.0 +// + +#define OID_GEN_BYTES_RCV 0x00020219 +#define OID_GEN_BYTES_XMIT 0x0002021A +#define OID_GEN_RCV_DISCARDS 0x0002021B +#define OID_GEN_XMIT_DISCARDS 0x0002021C +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) || NDIS_SUPPORT_NDIS630 +// +// Optional OIDs for NDIS 6.30 +// +#define OID_TCP_RSC_STATISTICS 0x0002021D + +#define OID_GEN_NDIS_RESERVED_7 0x0002021E + + +#endif + +// +// These are connection-oriented general OIDs. +// These replace the above OIDs for connection-oriented media. +// +#define OID_GEN_CO_SUPPORTED_LIST OID_GEN_SUPPORTED_LIST +#define OID_GEN_CO_HARDWARE_STATUS OID_GEN_HARDWARE_STATUS +#define OID_GEN_CO_MEDIA_SUPPORTED OID_GEN_MEDIA_SUPPORTED +#define OID_GEN_CO_MEDIA_IN_USE OID_GEN_MEDIA_IN_USE +#define OID_GEN_CO_LINK_SPEED OID_GEN_LINK_SPEED +#define OID_GEN_CO_VENDOR_ID OID_GEN_VENDOR_ID +#define OID_GEN_CO_VENDOR_DESCRIPTION OID_GEN_VENDOR_DESCRIPTION +#define OID_GEN_CO_DRIVER_VERSION OID_GEN_DRIVER_VERSION +#define OID_GEN_CO_PROTOCOL_OPTIONS OID_GEN_PROTOCOL_OPTIONS +#define OID_GEN_CO_MAC_OPTIONS OID_GEN_MAC_OPTIONS +#define OID_GEN_CO_MEDIA_CONNECT_STATUS OID_GEN_MEDIA_CONNECT_STATUS +#define OID_GEN_CO_VENDOR_DRIVER_VERSION OID_GEN_VENDOR_DRIVER_VERSION +#define OID_GEN_CO_SUPPORTED_GUIDS OID_GEN_SUPPORTED_GUIDS +#define OID_GEN_CO_GET_TIME_CAPS OID_GEN_GET_TIME_CAPS +#define OID_GEN_CO_GET_NETCARD_TIME OID_GEN_GET_NETCARD_TIME +#define OID_GEN_CO_MINIMUM_LINK_SPEED 0x00020120 + +// +// These are connection-oriented statistics OIDs. +// +#define OID_GEN_CO_XMIT_PDUS_OK OID_GEN_XMIT_OK +#define OID_GEN_CO_RCV_PDUS_OK OID_GEN_RCV_OK +#define OID_GEN_CO_XMIT_PDUS_ERROR OID_GEN_XMIT_ERROR +#define OID_GEN_CO_RCV_PDUS_ERROR OID_GEN_RCV_ERROR +#define OID_GEN_CO_RCV_PDUS_NO_BUFFER OID_GEN_RCV_NO_BUFFER + + +#define OID_GEN_CO_RCV_CRC_ERROR OID_GEN_RCV_CRC_ERROR +#define OID_GEN_CO_TRANSMIT_QUEUE_LENGTH OID_GEN_TRANSMIT_QUEUE_LENGTH +#define OID_GEN_CO_BYTES_XMIT OID_GEN_DIRECTED_BYTES_XMIT +#define OID_GEN_CO_BYTES_RCV OID_GEN_DIRECTED_BYTES_RCV +#define OID_GEN_CO_NETCARD_LOAD OID_GEN_NETCARD_LOAD +#define OID_GEN_CO_DEVICE_PROFILE OID_GEN_DEVICE_PROFILE +#define OID_GEN_CO_BYTES_XMIT_OUTSTANDING 0x00020221 + + +#if (NDIS_SUPPORT_NDIS686) + +// +// Optional OIDs to handle network multiple PF feature. +// +#define OID_KDNET_ENUMERATE_PFS 0x00020222 +#define OID_KDNET_ADD_PF 0x00020223 +#define OID_KDNET_REMOVE_PF 0x00020224 +#define OID_KDNET_QUERY_PF_INFORMATION 0x00020225 + +#endif // (NDIS_SUPPORT_NDIS686) + +// +// 802.3 Objects (Ethernet) +// +#define OID_802_3_PERMANENT_ADDRESS 0x01010101 +#define OID_802_3_CURRENT_ADDRESS 0x01010102 +#define OID_802_3_MULTICAST_LIST 0x01010103 +#define OID_802_3_MAXIMUM_LIST_SIZE 0x01010104 +// +// This OID has been deprecated for NDIS 6 drivers. +// +#define OID_802_3_MAC_OPTIONS 0x01010105 // deprecated + + +// +// This Flag has been deprecated for NDIS 6 drivers. +// +#define NDIS_802_3_MAC_OPTION_PRIORITY 0x00000001 // deprecated + +#define OID_802_3_RCV_ERROR_ALIGNMENT 0x01020101 +#define OID_802_3_XMIT_ONE_COLLISION 0x01020102 +#define OID_802_3_XMIT_MORE_COLLISIONS 0x01020103 + +#define OID_802_3_XMIT_DEFERRED 0x01020201 +#define OID_802_3_XMIT_MAX_COLLISIONS 0x01020202 +#define OID_802_3_RCV_OVERRUN 0x01020203 +#define OID_802_3_XMIT_UNDERRUN 0x01020204 +#define OID_802_3_XMIT_HEARTBEAT_FAILURE 0x01020205 +#define OID_802_3_XMIT_TIMES_CRS_LOST 0x01020206 +#define OID_802_3_XMIT_LATE_COLLISIONS 0x01020207 + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +// +// new for NDIS 6 +// +#define OID_802_3_ADD_MULTICAST_ADDRESS 0x01010208 +#define OID_802_3_DELETE_MULTICAST_ADDRESS 0x01010209 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +// +// 802.5 Objects (Token-Ring) +// +#define OID_802_5_PERMANENT_ADDRESS 0x02010101 +#define OID_802_5_CURRENT_ADDRESS 0x02010102 +#define OID_802_5_CURRENT_FUNCTIONAL 0x02010103 +#define OID_802_5_CURRENT_GROUP 0x02010104 +#define OID_802_5_LAST_OPEN_STATUS 0x02010105 +#define OID_802_5_CURRENT_RING_STATUS 0x02010106 +#define OID_802_5_CURRENT_RING_STATE 0x02010107 + + +#define OID_802_5_LINE_ERRORS 0x02020101 +#define OID_802_5_LOST_FRAMES 0x02020102 + +#define OID_802_5_BURST_ERRORS 0x02020201 +#define OID_802_5_AC_ERRORS 0x02020202 +#define OID_802_5_ABORT_DELIMETERS 0x02020203 +#define OID_802_5_FRAME_COPIED_ERRORS 0x02020204 +#define OID_802_5_FREQUENCY_ERRORS 0x02020205 +#define OID_802_5_TOKEN_ERRORS 0x02020206 +#define OID_802_5_INTERNAL_ERRORS 0x02020207 + + +// +// FDDI Objects +// +#define OID_FDDI_LONG_PERMANENT_ADDR 0x03010101 +#define OID_FDDI_LONG_CURRENT_ADDR 0x03010102 +#define OID_FDDI_LONG_MULTICAST_LIST 0x03010103 +#define OID_FDDI_LONG_MAX_LIST_SIZE 0x03010104 +#define OID_FDDI_SHORT_PERMANENT_ADDR 0x03010105 +#define OID_FDDI_SHORT_CURRENT_ADDR 0x03010106 +#define OID_FDDI_SHORT_MULTICAST_LIST 0x03010107 +#define OID_FDDI_SHORT_MAX_LIST_SIZE 0x03010108 + +#define OID_FDDI_ATTACHMENT_TYPE 0x03020101 +#define OID_FDDI_UPSTREAM_NODE_LONG 0x03020102 +#define OID_FDDI_DOWNSTREAM_NODE_LONG 0x03020103 +#define OID_FDDI_FRAME_ERRORS 0x03020104 +#define OID_FDDI_FRAMES_LOST 0x03020105 +#define OID_FDDI_RING_MGT_STATE 0x03020106 +#define OID_FDDI_LCT_FAILURES 0x03020107 +#define OID_FDDI_LEM_REJECTS 0x03020108 +#define OID_FDDI_LCONNECTION_STATE 0x03020109 + +#define OID_FDDI_SMT_STATION_ID 0x03030201 +#define OID_FDDI_SMT_OP_VERSION_ID 0x03030202 +#define OID_FDDI_SMT_HI_VERSION_ID 0x03030203 +#define OID_FDDI_SMT_LO_VERSION_ID 0x03030204 +#define OID_FDDI_SMT_MANUFACTURER_DATA 0x03030205 +#define OID_FDDI_SMT_USER_DATA 0x03030206 +#define OID_FDDI_SMT_MIB_VERSION_ID 0x03030207 +#define OID_FDDI_SMT_MAC_CT 0x03030208 +#define OID_FDDI_SMT_NON_MASTER_CT 0x03030209 +#define OID_FDDI_SMT_MASTER_CT 0x0303020A +#define OID_FDDI_SMT_AVAILABLE_PATHS 0x0303020B +#define OID_FDDI_SMT_CONFIG_CAPABILITIES 0x0303020C +#define OID_FDDI_SMT_CONFIG_POLICY 0x0303020D +#define OID_FDDI_SMT_CONNECTION_POLICY 0x0303020E +#define OID_FDDI_SMT_T_NOTIFY 0x0303020F +#define OID_FDDI_SMT_STAT_RPT_POLICY 0x03030210 +#define OID_FDDI_SMT_TRACE_MAX_EXPIRATION 0x03030211 +#define OID_FDDI_SMT_PORT_INDEXES 0x03030212 +#define OID_FDDI_SMT_MAC_INDEXES 0x03030213 +#define OID_FDDI_SMT_BYPASS_PRESENT 0x03030214 +#define OID_FDDI_SMT_ECM_STATE 0x03030215 +#define OID_FDDI_SMT_CF_STATE 0x03030216 +#define OID_FDDI_SMT_HOLD_STATE 0x03030217 +#define OID_FDDI_SMT_REMOTE_DISCONNECT_FLAG 0x03030218 +#define OID_FDDI_SMT_STATION_STATUS 0x03030219 +#define OID_FDDI_SMT_PEER_WRAP_FLAG 0x0303021A +#define OID_FDDI_SMT_MSG_TIME_STAMP 0x0303021B +#define OID_FDDI_SMT_TRANSITION_TIME_STAMP 0x0303021C +#define OID_FDDI_SMT_SET_COUNT 0x0303021D +#define OID_FDDI_SMT_LAST_SET_STATION_ID 0x0303021E +#define OID_FDDI_MAC_FRAME_STATUS_FUNCTIONS 0x0303021F +#define OID_FDDI_MAC_BRIDGE_FUNCTIONS 0x03030220 +#define OID_FDDI_MAC_T_MAX_CAPABILITY 0x03030221 +#define OID_FDDI_MAC_TVX_CAPABILITY 0x03030222 +#define OID_FDDI_MAC_AVAILABLE_PATHS 0x03030223 +#define OID_FDDI_MAC_CURRENT_PATH 0x03030224 +#define OID_FDDI_MAC_UPSTREAM_NBR 0x03030225 +#define OID_FDDI_MAC_DOWNSTREAM_NBR 0x03030226 +#define OID_FDDI_MAC_OLD_UPSTREAM_NBR 0x03030227 +#define OID_FDDI_MAC_OLD_DOWNSTREAM_NBR 0x03030228 +#define OID_FDDI_MAC_DUP_ADDRESS_TEST 0x03030229 +#define OID_FDDI_MAC_REQUESTED_PATHS 0x0303022A +#define OID_FDDI_MAC_DOWNSTREAM_PORT_TYPE 0x0303022B +#define OID_FDDI_MAC_INDEX 0x0303022C +#define OID_FDDI_MAC_SMT_ADDRESS 0x0303022D +#define OID_FDDI_MAC_LONG_GRP_ADDRESS 0x0303022E +#define OID_FDDI_MAC_SHORT_GRP_ADDRESS 0x0303022F +#define OID_FDDI_MAC_T_REQ 0x03030230 +#define OID_FDDI_MAC_T_NEG 0x03030231 +#define OID_FDDI_MAC_T_MAX 0x03030232 +#define OID_FDDI_MAC_TVX_VALUE 0x03030233 +#define OID_FDDI_MAC_T_PRI0 0x03030234 +#define OID_FDDI_MAC_T_PRI1 0x03030235 +#define OID_FDDI_MAC_T_PRI2 0x03030236 +#define OID_FDDI_MAC_T_PRI3 0x03030237 +#define OID_FDDI_MAC_T_PRI4 0x03030238 +#define OID_FDDI_MAC_T_PRI5 0x03030239 +#define OID_FDDI_MAC_T_PRI6 0x0303023A +#define OID_FDDI_MAC_FRAME_CT 0x0303023B +#define OID_FDDI_MAC_COPIED_CT 0x0303023C +#define OID_FDDI_MAC_TRANSMIT_CT 0x0303023D +#define OID_FDDI_MAC_TOKEN_CT 0x0303023E +#define OID_FDDI_MAC_ERROR_CT 0x0303023F +#define OID_FDDI_MAC_LOST_CT 0x03030240 +#define OID_FDDI_MAC_TVX_EXPIRED_CT 0x03030241 +#define OID_FDDI_MAC_NOT_COPIED_CT 0x03030242 +#define OID_FDDI_MAC_LATE_CT 0x03030243 +#define OID_FDDI_MAC_RING_OP_CT 0x03030244 +#define OID_FDDI_MAC_FRAME_ERROR_THRESHOLD 0x03030245 +#define OID_FDDI_MAC_FRAME_ERROR_RATIO 0x03030246 +#define OID_FDDI_MAC_NOT_COPIED_THRESHOLD 0x03030247 +#define OID_FDDI_MAC_NOT_COPIED_RATIO 0x03030248 +#define OID_FDDI_MAC_RMT_STATE 0x03030249 +#define OID_FDDI_MAC_DA_FLAG 0x0303024A +#define OID_FDDI_MAC_UNDA_FLAG 0x0303024B +#define OID_FDDI_MAC_FRAME_ERROR_FLAG 0x0303024C +#define OID_FDDI_MAC_NOT_COPIED_FLAG 0x0303024D +#define OID_FDDI_MAC_MA_UNITDATA_AVAILABLE 0x0303024E +#define OID_FDDI_MAC_HARDWARE_PRESENT 0x0303024F +#define OID_FDDI_MAC_MA_UNITDATA_ENABLE 0x03030250 +#define OID_FDDI_PATH_INDEX 0x03030251 +#define OID_FDDI_PATH_RING_LATENCY 0x03030252 +#define OID_FDDI_PATH_TRACE_STATUS 0x03030253 +#define OID_FDDI_PATH_SBA_PAYLOAD 0x03030254 +#define OID_FDDI_PATH_SBA_OVERHEAD 0x03030255 +#define OID_FDDI_PATH_CONFIGURATION 0x03030256 +#define OID_FDDI_PATH_T_R_MODE 0x03030257 +#define OID_FDDI_PATH_SBA_AVAILABLE 0x03030258 +#define OID_FDDI_PATH_TVX_LOWER_BOUND 0x03030259 +#define OID_FDDI_PATH_T_MAX_LOWER_BOUND 0x0303025A +#define OID_FDDI_PATH_MAX_T_REQ 0x0303025B +#define OID_FDDI_PORT_MY_TYPE 0x0303025C +#define OID_FDDI_PORT_NEIGHBOR_TYPE 0x0303025D +#define OID_FDDI_PORT_CONNECTION_POLICIES 0x0303025E +#define OID_FDDI_PORT_MAC_INDICATED 0x0303025F +#define OID_FDDI_PORT_CURRENT_PATH 0x03030260 +#define OID_FDDI_PORT_REQUESTED_PATHS 0x03030261 +#define OID_FDDI_PORT_MAC_PLACEMENT 0x03030262 +#define OID_FDDI_PORT_AVAILABLE_PATHS 0x03030263 +#define OID_FDDI_PORT_MAC_LOOP_TIME 0x03030264 +#define OID_FDDI_PORT_PMD_CLASS 0x03030265 +#define OID_FDDI_PORT_CONNECTION_CAPABILITIES 0x03030266 +#define OID_FDDI_PORT_INDEX 0x03030267 +#define OID_FDDI_PORT_MAINT_LS 0x03030268 +#define OID_FDDI_PORT_BS_FLAG 0x03030269 +#define OID_FDDI_PORT_PC_LS 0x0303026A +#define OID_FDDI_PORT_EB_ERROR_CT 0x0303026B +#define OID_FDDI_PORT_LCT_FAIL_CT 0x0303026C +#define OID_FDDI_PORT_LER_ESTIMATE 0x0303026D +#define OID_FDDI_PORT_LEM_REJECT_CT 0x0303026E +#define OID_FDDI_PORT_LEM_CT 0x0303026F +#define OID_FDDI_PORT_LER_CUTOFF 0x03030270 +#define OID_FDDI_PORT_LER_ALARM 0x03030271 +#define OID_FDDI_PORT_CONNNECT_STATE 0x03030272 +#define OID_FDDI_PORT_PCM_STATE 0x03030273 +#define OID_FDDI_PORT_PC_WITHHOLD 0x03030274 +#define OID_FDDI_PORT_LER_FLAG 0x03030275 +#define OID_FDDI_PORT_HARDWARE_PRESENT 0x03030276 +#define OID_FDDI_SMT_STATION_ACTION 0x03030277 +#define OID_FDDI_PORT_ACTION 0x03030278 +#define OID_FDDI_IF_DESCR 0x03030279 +#define OID_FDDI_IF_TYPE 0x0303027A +#define OID_FDDI_IF_MTU 0x0303027B +#define OID_FDDI_IF_SPEED 0x0303027C +#define OID_FDDI_IF_PHYS_ADDRESS 0x0303027D +#define OID_FDDI_IF_ADMIN_STATUS 0x0303027E +#define OID_FDDI_IF_OPER_STATUS 0x0303027F +#define OID_FDDI_IF_LAST_CHANGE 0x03030280 +#define OID_FDDI_IF_IN_OCTETS 0x03030281 +#define OID_FDDI_IF_IN_UCAST_PKTS 0x03030282 +#define OID_FDDI_IF_IN_NUCAST_PKTS 0x03030283 +#define OID_FDDI_IF_IN_DISCARDS 0x03030284 +#define OID_FDDI_IF_IN_ERRORS 0x03030285 +#define OID_FDDI_IF_IN_UNKNOWN_PROTOS 0x03030286 +#define OID_FDDI_IF_OUT_OCTETS 0x03030287 +#define OID_FDDI_IF_OUT_UCAST_PKTS 0x03030288 +#define OID_FDDI_IF_OUT_NUCAST_PKTS 0x03030289 +#define OID_FDDI_IF_OUT_DISCARDS 0x0303028A +#define OID_FDDI_IF_OUT_ERRORS 0x0303028B +#define OID_FDDI_IF_OUT_QLEN 0x0303028C +#define OID_FDDI_IF_SPECIFIC 0x0303028D + +// +// WAN objects +// +#define OID_WAN_PERMANENT_ADDRESS 0x04010101 +#define OID_WAN_CURRENT_ADDRESS 0x04010102 +#define OID_WAN_QUALITY_OF_SERVICE 0x04010103 +#define OID_WAN_PROTOCOL_TYPE 0x04010104 +#define OID_WAN_MEDIUM_SUBTYPE 0x04010105 +#define OID_WAN_HEADER_FORMAT 0x04010106 + +#define OID_WAN_GET_INFO 0x04010107 +#define OID_WAN_SET_LINK_INFO 0x04010108 +#define OID_WAN_GET_LINK_INFO 0x04010109 + +#define OID_WAN_LINE_COUNT 0x0401010A +#define OID_WAN_PROTOCOL_CAPS 0x0401010B + +#define OID_WAN_GET_BRIDGE_INFO 0x0401020A +#define OID_WAN_SET_BRIDGE_INFO 0x0401020B +#define OID_WAN_GET_COMP_INFO 0x0401020C +#define OID_WAN_SET_COMP_INFO 0x0401020D +#define OID_WAN_GET_STATS_INFO 0x0401020E + +// +// These are connection-oriented WAN OIDs. +// These replace the above OIDs for CoNDIS WAN Miniports +// +#define OID_WAN_CO_GET_INFO 0x04010180 +#define OID_WAN_CO_SET_LINK_INFO 0x04010181 +#define OID_WAN_CO_GET_LINK_INFO 0x04010182 +#define OID_WAN_CO_GET_COMP_INFO 0x04010280 +#define OID_WAN_CO_SET_COMP_INFO 0x04010281 +#define OID_WAN_CO_GET_STATS_INFO 0x04010282 + + +// +// LocalTalk objects +// +#define OID_LTALK_CURRENT_NODE_ID 0x05010102 + +#define OID_LTALK_IN_BROADCASTS 0x05020101 +#define OID_LTALK_IN_LENGTH_ERRORS 0x05020102 + +#define OID_LTALK_OUT_NO_HANDLERS 0x05020201 +#define OID_LTALK_COLLISIONS 0x05020202 +#define OID_LTALK_DEFERS 0x05020203 +#define OID_LTALK_NO_DATA_ERRORS 0x05020204 +#define OID_LTALK_RANDOM_CTS_ERRORS 0x05020205 +#define OID_LTALK_FCS_ERRORS 0x05020206 + + +// +// Arcnet objects +// +#define OID_ARCNET_PERMANENT_ADDRESS 0x06010101 +#define OID_ARCNET_CURRENT_ADDRESS 0x06010102 + +#define OID_ARCNET_RECONFIGURATIONS 0x06020201 + +// +// TAPI objects +// +#define OID_TAPI_ACCEPT 0x07030101 +#define OID_TAPI_ANSWER 0x07030102 +#define OID_TAPI_CLOSE 0x07030103 +#define OID_TAPI_CLOSE_CALL 0x07030104 +#define OID_TAPI_CONDITIONAL_MEDIA_DETECTION 0x07030105 +#define OID_TAPI_CONFIG_DIALOG 0x07030106 +#define OID_TAPI_DEV_SPECIFIC 0x07030107 +#define OID_TAPI_DIAL 0x07030108 +#define OID_TAPI_DROP 0x07030109 +#define OID_TAPI_GET_ADDRESS_CAPS 0x0703010A +#define OID_TAPI_GET_ADDRESS_ID 0x0703010B +#define OID_TAPI_GET_ADDRESS_STATUS 0x0703010C +#define OID_TAPI_GET_CALL_ADDRESS_ID 0x0703010D +#define OID_TAPI_GET_CALL_INFO 0x0703010E +#define OID_TAPI_GET_CALL_STATUS 0x0703010F +#define OID_TAPI_GET_DEV_CAPS 0x07030110 +#define OID_TAPI_GET_DEV_CONFIG 0x07030111 +#define OID_TAPI_GET_EXTENSION_ID 0x07030112 +#define OID_TAPI_GET_ID 0x07030113 +#define OID_TAPI_GET_LINE_DEV_STATUS 0x07030114 +#define OID_TAPI_MAKE_CALL 0x07030115 +#define OID_TAPI_NEGOTIATE_EXT_VERSION 0x07030116 +#define OID_TAPI_OPEN 0x07030117 +#define OID_TAPI_PROVIDER_INITIALIZE 0x07030118 +#define OID_TAPI_PROVIDER_SHUTDOWN 0x07030119 +#define OID_TAPI_SECURE_CALL 0x0703011A +#define OID_TAPI_SELECT_EXT_VERSION 0x0703011B +#define OID_TAPI_SEND_USER_USER_INFO 0x0703011C +#define OID_TAPI_SET_APP_SPECIFIC 0x0703011D +#define OID_TAPI_SET_CALL_PARAMS 0x0703011E +#define OID_TAPI_SET_DEFAULT_MEDIA_DETECTION 0x0703011F +#define OID_TAPI_SET_DEV_CONFIG 0x07030120 +#define OID_TAPI_SET_MEDIA_MODE 0x07030121 +#define OID_TAPI_SET_STATUS_MESSAGES 0x07030122 +#define OID_TAPI_GATHER_DIGITS 0x07030123 +#define OID_TAPI_MONITOR_DIGITS 0x07030124 + +// +// ATM Connection Oriented OIDs +// +#define OID_ATM_SUPPORTED_VC_RATES 0x08010101 +#define OID_ATM_SUPPORTED_SERVICE_CATEGORY 0x08010102 +#define OID_ATM_SUPPORTED_AAL_TYPES 0x08010103 +#define OID_ATM_HW_CURRENT_ADDRESS 0x08010104 +#define OID_ATM_MAX_ACTIVE_VCS 0x08010105 +#define OID_ATM_MAX_ACTIVE_VCI_BITS 0x08010106 +#define OID_ATM_MAX_ACTIVE_VPI_BITS 0x08010107 +#define OID_ATM_MAX_AAL0_PACKET_SIZE 0x08010108 +#define OID_ATM_MAX_AAL1_PACKET_SIZE 0x08010109 +#define OID_ATM_MAX_AAL34_PACKET_SIZE 0x0801010A +#define OID_ATM_MAX_AAL5_PACKET_SIZE 0x0801010B + +#define OID_ATM_SIGNALING_VPIVCI 0x08010201 +#define OID_ATM_ASSIGNED_VPI 0x08010202 +#define OID_ATM_ACQUIRE_ACCESS_NET_RESOURCES 0x08010203 +#define OID_ATM_RELEASE_ACCESS_NET_RESOURCES 0x08010204 +#define OID_ATM_ILMI_VPIVCI 0x08010205 +#define OID_ATM_DIGITAL_BROADCAST_VPIVCI 0x08010206 +#define OID_ATM_GET_NEAREST_FLOW 0x08010207 +#define OID_ATM_ALIGNMENT_REQUIRED 0x08010208 +#define OID_ATM_LECS_ADDRESS 0x08010209 +#define OID_ATM_SERVICE_ADDRESS 0x0801020A + +#define OID_ATM_CALL_PROCEEDING 0x0801020B // UNI 4.0 +#define OID_ATM_CALL_ALERTING 0x0801020C // UNI 4.0 +#define OID_ATM_PARTY_ALERTING 0x0801020D // UNI 4.0 +#define OID_ATM_CALL_NOTIFY 0x0801020E // UNI 4.0 + +#define OID_ATM_MY_IP_NM_ADDRESS 0x0801020F + + +// +// ATM specific statistics OIDs. +// +#define OID_ATM_RCV_CELLS_OK 0x08020101 +#define OID_ATM_XMIT_CELLS_OK 0x08020102 +#define OID_ATM_RCV_CELLS_DROPPED 0x08020103 + +#define OID_ATM_RCV_INVALID_VPI_VCI 0x08020201 +#define OID_ATM_CELLS_HEC_ERROR 0x08020202 +#define OID_ATM_RCV_REASSEMBLY_ERROR 0x08020203 + + +// +// IEEE 802.11 OIDs +// +#define OID_802_11_BSSID 0x0D010101 +#define OID_802_11_SSID 0x0D010102 +#define OID_802_11_NETWORK_TYPES_SUPPORTED 0x0D010203 +#define OID_802_11_NETWORK_TYPE_IN_USE 0x0D010204 +#define OID_802_11_TX_POWER_LEVEL 0x0D010205 +#define OID_802_11_RSSI 0x0D010206 +#define OID_802_11_RSSI_TRIGGER 0x0D010207 +#define OID_802_11_INFRASTRUCTURE_MODE 0x0D010108 +#define OID_802_11_FRAGMENTATION_THRESHOLD 0x0D010209 +#define OID_802_11_RTS_THRESHOLD 0x0D01020A +#define OID_802_11_NUMBER_OF_ANTENNAS 0x0D01020B +#define OID_802_11_RX_ANTENNA_SELECTED 0x0D01020C +#define OID_802_11_TX_ANTENNA_SELECTED 0x0D01020D +#define OID_802_11_SUPPORTED_RATES 0x0D01020E +#define OID_802_11_DESIRED_RATES 0x0D010210 +#define OID_802_11_CONFIGURATION 0x0D010211 +#define OID_802_11_STATISTICS 0x0D020212 +#define OID_802_11_ADD_WEP 0x0D010113 +#define OID_802_11_REMOVE_WEP 0x0D010114 +#define OID_802_11_DISASSOCIATE 0x0D010115 +#define OID_802_11_POWER_MODE 0x0D010216 +#define OID_802_11_BSSID_LIST 0x0D010217 +#define OID_802_11_AUTHENTICATION_MODE 0x0D010118 +#define OID_802_11_PRIVACY_FILTER 0x0D010119 +#define OID_802_11_BSSID_LIST_SCAN 0x0D01011A +#define OID_802_11_WEP_STATUS 0x0D01011B +// Renamed to reflect better the extended set of encryption status +#define OID_802_11_ENCRYPTION_STATUS OID_802_11_WEP_STATUS +#define OID_802_11_RELOAD_DEFAULTS 0x0D01011C +// Added to allow key mapping and default keys +#define OID_802_11_ADD_KEY 0x0D01011D +#define OID_802_11_REMOVE_KEY 0x0D01011E +#define OID_802_11_ASSOCIATION_INFORMATION 0x0D01011F +#define OID_802_11_TEST 0x0D010120 +#define OID_802_11_MEDIA_STREAM_MODE 0x0D010121 +#define OID_802_11_CAPABILITY 0x0D010122 +#define OID_802_11_PMKID 0x0D010123 +#define OID_802_11_NON_BCAST_SSID_LIST 0x0D010124 +#define OID_802_11_RADIO_STATUS 0x0D010125 + +// +// some of well known Ethernet frame types (in big endian notation) +// +#define NDIS_ETH_TYPE_IPV4 0x0800 // IPV4 +#define NDIS_ETH_TYPE_ARP 0x0806 // ARP +#define NDIS_ETH_TYPE_IPV6 0x86dd // IPV6 +#define NDIS_ETH_TYPE_802_1X 0x888e // 802.1x +#define NDIS_ETH_TYPE_802_1Q 0x8100 // 802.1p +#define NDIS_ETH_TYPE_SLOW_PROTOCOL 0x8809 // Slow protocols (LACP, etc.) + +#define NDIS_802_11_LENGTH_SSID 32 +#define NDIS_802_11_LENGTH_RATES 8 +#define NDIS_802_11_LENGTH_RATES_EX 16 + +// +// IEEE 802.11 Structures and definitions +// +// new types for Media Specific Indications +typedef enum _NDIS_802_11_STATUS_TYPE +{ + Ndis802_11StatusType_Authentication, + Ndis802_11StatusType_MediaStreamMode, + Ndis802_11StatusType_PMKID_CandidateList, + Ndis802_11StatusTypeMax // not a real type, defined as an upper bound +} NDIS_802_11_STATUS_TYPE, *PNDIS_802_11_STATUS_TYPE; + +typedef UCHAR NDIS_802_11_MAC_ADDRESS[6]; + +typedef struct _NDIS_802_11_STATUS_INDICATION +{ + NDIS_802_11_STATUS_TYPE StatusType; +} NDIS_802_11_STATUS_INDICATION, *PNDIS_802_11_STATUS_INDICATION; + +// mask for authentication/integrity fields +#define NDIS_802_11_AUTH_REQUEST_AUTH_FIELDS 0x0f + +#define NDIS_802_11_AUTH_REQUEST_REAUTH 0x01 +#define NDIS_802_11_AUTH_REQUEST_KEYUPDATE 0x02 +#define NDIS_802_11_AUTH_REQUEST_PAIRWISE_ERROR 0x06 +#define NDIS_802_11_AUTH_REQUEST_GROUP_ERROR 0x0E + +typedef struct _NDIS_802_11_AUTHENTICATION_REQUEST +{ + ULONG Length; // Length of structure + NDIS_802_11_MAC_ADDRESS Bssid; + ULONG Flags; +} NDIS_802_11_AUTHENTICATION_REQUEST, *PNDIS_802_11_AUTHENTICATION_REQUEST; + +//Added new types for PMKID Candidate lists. +typedef struct _PMKID_CANDIDATE { + NDIS_802_11_MAC_ADDRESS BSSID; + ULONG Flags; +} PMKID_CANDIDATE, *PPMKID_CANDIDATE; + +typedef struct _NDIS_802_11_PMKID_CANDIDATE_LIST +{ + ULONG Version; // Version of the structure + ULONG NumCandidates; // No. of pmkid candidates + PMKID_CANDIDATE CandidateList[1]; +} NDIS_802_11_PMKID_CANDIDATE_LIST, *PNDIS_802_11_PMKID_CANDIDATE_LIST; + +//Flags for PMKID Candidate list structure +#define NDIS_802_11_PMKID_CANDIDATE_PREAUTH_ENABLED 0x01 + +// Added new types for OFDM 5G and 2.4G +typedef enum _NDIS_802_11_NETWORK_TYPE +{ + Ndis802_11FH, + Ndis802_11DS, + Ndis802_11OFDM5, + Ndis802_11OFDM24, + Ndis802_11Automode, + Ndis802_11NetworkTypeMax // not a real type, defined as an upper bound +} NDIS_802_11_NETWORK_TYPE, *PNDIS_802_11_NETWORK_TYPE; + +typedef struct _NDIS_802_11_NETWORK_TYPE_LIST +{ + ULONG NumberOfItems; // in list below, at least 1 + NDIS_802_11_NETWORK_TYPE NetworkType [1]; +} NDIS_802_11_NETWORK_TYPE_LIST, *PNDIS_802_11_NETWORK_TYPE_LIST; + +typedef enum _NDIS_802_11_POWER_MODE +{ + Ndis802_11PowerModeCAM, + Ndis802_11PowerModeMAX_PSP, + Ndis802_11PowerModeFast_PSP, + Ndis802_11PowerModeMax // not a real mode, defined as an upper bound +} NDIS_802_11_POWER_MODE, *PNDIS_802_11_POWER_MODE; + +typedef ULONG NDIS_802_11_TX_POWER_LEVEL; // in milliwatts + +// +// Received Signal Strength Indication +// +typedef LONG NDIS_802_11_RSSI; // in dBm + +typedef struct _NDIS_802_11_CONFIGURATION_FH +{ + ULONG Length; // Length of structure + ULONG HopPattern; // As defined by 802.11, MSB set + ULONG HopSet; // to one if non-802.11 + ULONG DwellTime; // units are Kusec +} NDIS_802_11_CONFIGURATION_FH, *PNDIS_802_11_CONFIGURATION_FH; + +typedef struct _NDIS_802_11_CONFIGURATION +{ + ULONG Length; // Length of structure + ULONG BeaconPeriod; // units are Kusec + ULONG ATIMWindow; // units are Kusec + ULONG DSConfig; // Frequency, units are kHz + NDIS_802_11_CONFIGURATION_FH FHConfig; +} NDIS_802_11_CONFIGURATION, *PNDIS_802_11_CONFIGURATION; + +typedef struct _NDIS_802_11_STATISTICS +{ + ULONG Length; // Length of structure + LARGE_INTEGER TransmittedFragmentCount; + LARGE_INTEGER MulticastTransmittedFrameCount; + LARGE_INTEGER FailedCount; + LARGE_INTEGER RetryCount; + LARGE_INTEGER MultipleRetryCount; + LARGE_INTEGER RTSSuccessCount; + LARGE_INTEGER RTSFailureCount; + LARGE_INTEGER ACKFailureCount; + LARGE_INTEGER FrameDuplicateCount; + LARGE_INTEGER ReceivedFragmentCount; + LARGE_INTEGER MulticastReceivedFrameCount; + LARGE_INTEGER FCSErrorCount; + LARGE_INTEGER TKIPLocalMICFailures; + LARGE_INTEGER TKIPICVErrorCount; + LARGE_INTEGER TKIPCounterMeasuresInvoked; + LARGE_INTEGER TKIPReplays; + LARGE_INTEGER CCMPFormatErrors; + LARGE_INTEGER CCMPReplays; + LARGE_INTEGER CCMPDecryptErrors; + LARGE_INTEGER FourWayHandshakeFailures; + LARGE_INTEGER WEPUndecryptableCount; + LARGE_INTEGER WEPICVErrorCount; + LARGE_INTEGER DecryptSuccessCount; + LARGE_INTEGER DecryptFailureCount; +} NDIS_802_11_STATISTICS, *PNDIS_802_11_STATISTICS; + +typedef ULONG NDIS_802_11_KEY_INDEX; +typedef ULONGLONG NDIS_802_11_KEY_RSC; + +// Key mapping keys require a BSSID +typedef struct _NDIS_802_11_KEY +{ + ULONG Length; // Length of this structure + ULONG KeyIndex; + ULONG KeyLength; // length of key in bytes + NDIS_802_11_MAC_ADDRESS BSSID; + NDIS_802_11_KEY_RSC KeyRSC; + _Field_size_bytes_(KeyLength) UCHAR KeyMaterial[1]; // variable length depending on above field +} NDIS_802_11_KEY, *PNDIS_802_11_KEY; + +typedef struct _NDIS_802_11_REMOVE_KEY +{ + ULONG Length; // Length of this structure + ULONG KeyIndex; + NDIS_802_11_MAC_ADDRESS BSSID; +} NDIS_802_11_REMOVE_KEY, *PNDIS_802_11_REMOVE_KEY; + +typedef struct _NDIS_802_11_WEP +{ + ULONG Length; // Length of this structure + ULONG KeyIndex; // 0 is the per-client key, 1-N are the + // global keys + ULONG KeyLength; // length of key in bytes + UCHAR KeyMaterial[1]; // variable length depending on above field +} NDIS_802_11_WEP, *PNDIS_802_11_WEP; + + +typedef enum _NDIS_802_11_NETWORK_INFRASTRUCTURE +{ + Ndis802_11IBSS, + Ndis802_11Infrastructure, + Ndis802_11AutoUnknown, + Ndis802_11InfrastructureMax // Not a real value, defined as upper bound +} NDIS_802_11_NETWORK_INFRASTRUCTURE, *PNDIS_802_11_NETWORK_INFRASTRUCTURE; + +// Add new authentication modes +typedef enum _NDIS_802_11_AUTHENTICATION_MODE +{ + Ndis802_11AuthModeOpen, + Ndis802_11AuthModeShared, + Ndis802_11AuthModeAutoSwitch, + Ndis802_11AuthModeWPA, + Ndis802_11AuthModeWPAPSK, + Ndis802_11AuthModeWPANone, + Ndis802_11AuthModeWPA2, + Ndis802_11AuthModeWPA2PSK, + Ndis802_11AuthModeWPA3, +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + Ndis802_11AuthModeWPA3Ent192 = Ndis802_11AuthModeWPA3, +#endif + Ndis802_11AuthModeWPA3SAE, +#if(NDIS_SUPPORT_NDIS684) + Ndis802_11AuthModeOWE, +#endif // (NDIS_SUPPORT_NDIS684) +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + Ndis802_11AuthModeWPA3Ent, +#endif + Ndis802_11AuthModeMax // Not a real mode, defined as upper bound +} NDIS_802_11_AUTHENTICATION_MODE, *PNDIS_802_11_AUTHENTICATION_MODE; + +typedef UCHAR NDIS_802_11_RATES[NDIS_802_11_LENGTH_RATES]; // Set of 8 data rates +typedef UCHAR NDIS_802_11_RATES_EX[NDIS_802_11_LENGTH_RATES_EX]; // Set of 16 data rates + +typedef struct _NDIS_802_11_SSID +{ + ULONG SsidLength; // length of SSID field below, in bytes; + // this can be zero. + UCHAR Ssid[NDIS_802_11_LENGTH_SSID]; // SSID information field +} NDIS_802_11_SSID, *PNDIS_802_11_SSID; + + +typedef struct _NDIS_WLAN_BSSID +{ + ULONG Length; // Length of this structure + NDIS_802_11_MAC_ADDRESS MacAddress; // BSSID + UCHAR Reserved[2]; + NDIS_802_11_SSID Ssid; // SSID + ULONG Privacy; // WEP encryption requirement + NDIS_802_11_RSSI Rssi; // receive signal + // strength in dBm + NDIS_802_11_NETWORK_TYPE NetworkTypeInUse; + NDIS_802_11_CONFIGURATION Configuration; + NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode; + NDIS_802_11_RATES SupportedRates; +} NDIS_WLAN_BSSID, *PNDIS_WLAN_BSSID; + +typedef struct _NDIS_802_11_BSSID_LIST +{ + ULONG NumberOfItems; // in list below, at least 1 + NDIS_WLAN_BSSID Bssid[1]; +} NDIS_802_11_BSSID_LIST, *PNDIS_802_11_BSSID_LIST; + +// Added Capabilities, IELength and IEs for each BSSID +typedef struct _NDIS_WLAN_BSSID_EX +{ + ULONG Length; // Length of this structure + NDIS_802_11_MAC_ADDRESS MacAddress; // BSSID + UCHAR Reserved[2]; + NDIS_802_11_SSID Ssid; // SSID + ULONG Privacy; // WEP encryption requirement + NDIS_802_11_RSSI Rssi; // receive signal + // strength in dBm + NDIS_802_11_NETWORK_TYPE NetworkTypeInUse; + NDIS_802_11_CONFIGURATION Configuration; + NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode; + NDIS_802_11_RATES_EX SupportedRates; + ULONG IELength; + UCHAR IEs[1]; +} NDIS_WLAN_BSSID_EX, *PNDIS_WLAN_BSSID_EX; + +typedef struct _NDIS_802_11_BSSID_LIST_EX +{ + ULONG NumberOfItems; // in list below, at least 1 + NDIS_WLAN_BSSID_EX Bssid[1]; +} NDIS_802_11_BSSID_LIST_EX, *PNDIS_802_11_BSSID_LIST_EX; + +typedef struct _NDIS_802_11_FIXED_IEs +{ + UCHAR Timestamp[8]; + USHORT BeaconInterval; + USHORT Capabilities; +} NDIS_802_11_FIXED_IEs, *PNDIS_802_11_FIXED_IEs; + +typedef struct _NDIS_802_11_VARIABLE_IEs +{ + UCHAR ElementID; + UCHAR Length; // Number of bytes in data field + UCHAR data[1]; +} NDIS_802_11_VARIABLE_IEs, *PNDIS_802_11_VARIABLE_IEs; + +typedef ULONG NDIS_802_11_FRAGMENTATION_THRESHOLD; + +typedef ULONG NDIS_802_11_RTS_THRESHOLD; + +typedef ULONG NDIS_802_11_ANTENNA; + +typedef enum _NDIS_802_11_PRIVACY_FILTER +{ + Ndis802_11PrivFilterAcceptAll, + Ndis802_11PrivFilter8021xWEP +} NDIS_802_11_PRIVACY_FILTER, *PNDIS_802_11_PRIVACY_FILTER; + +// Added new encryption types +// Also aliased typedef to new name +typedef enum _NDIS_802_11_WEP_STATUS +{ + Ndis802_11WEPEnabled, + Ndis802_11Encryption1Enabled = Ndis802_11WEPEnabled, + Ndis802_11WEPDisabled, + Ndis802_11EncryptionDisabled = Ndis802_11WEPDisabled, + Ndis802_11WEPKeyAbsent, + Ndis802_11Encryption1KeyAbsent = Ndis802_11WEPKeyAbsent, + Ndis802_11WEPNotSupported, + Ndis802_11EncryptionNotSupported = Ndis802_11WEPNotSupported, + Ndis802_11Encryption2Enabled, + Ndis802_11Encryption2KeyAbsent, + Ndis802_11Encryption3Enabled, + Ndis802_11Encryption3KeyAbsent +} NDIS_802_11_WEP_STATUS, *PNDIS_802_11_WEP_STATUS, + NDIS_802_11_ENCRYPTION_STATUS, *PNDIS_802_11_ENCRYPTION_STATUS; + +typedef enum _NDIS_802_11_RELOAD_DEFAULTS +{ + Ndis802_11ReloadWEPKeys +} NDIS_802_11_RELOAD_DEFAULTS, *PNDIS_802_11_RELOAD_DEFAULTS; + +#define NDIS_802_11_AI_REQFI_CAPABILITIES 1 +#define NDIS_802_11_AI_REQFI_LISTENINTERVAL 2 +#define NDIS_802_11_AI_REQFI_CURRENTAPADDRESS 4 + +#define NDIS_802_11_AI_RESFI_CAPABILITIES 1 +#define NDIS_802_11_AI_RESFI_STATUSCODE 2 +#define NDIS_802_11_AI_RESFI_ASSOCIATIONID 4 + +typedef struct _NDIS_802_11_AI_REQFI +{ + USHORT Capabilities; + USHORT ListenInterval; + NDIS_802_11_MAC_ADDRESS CurrentAPAddress; +} NDIS_802_11_AI_REQFI, *PNDIS_802_11_AI_REQFI; + +typedef struct _NDIS_802_11_AI_RESFI +{ + USHORT Capabilities; + USHORT StatusCode; + USHORT AssociationId; +} NDIS_802_11_AI_RESFI, *PNDIS_802_11_AI_RESFI; + +typedef struct _NDIS_802_11_ASSOCIATION_INFORMATION +{ + ULONG Length; + USHORT AvailableRequestFixedIEs; + NDIS_802_11_AI_REQFI RequestFixedIEs; + ULONG RequestIELength; + ULONG OffsetRequestIEs; + USHORT AvailableResponseFixedIEs; + NDIS_802_11_AI_RESFI ResponseFixedIEs; + ULONG ResponseIELength; + ULONG OffsetResponseIEs; +} NDIS_802_11_ASSOCIATION_INFORMATION, *PNDIS_802_11_ASSOCIATION_INFORMATION; + +typedef struct _NDIS_802_11_AUTHENTICATION_EVENT +{ + NDIS_802_11_STATUS_INDICATION Status; + NDIS_802_11_AUTHENTICATION_REQUEST Request[1]; +} NDIS_802_11_AUTHENTICATION_EVENT, *PNDIS_802_11_AUTHENTICATION_EVENT; + +typedef struct _NDIS_802_11_TEST +{ + ULONG Length; + ULONG Type; + union + { + NDIS_802_11_AUTHENTICATION_EVENT AuthenticationEvent; + NDIS_802_11_RSSI RssiTrigger; + }; +} NDIS_802_11_TEST, *PNDIS_802_11_TEST; + +// 802.11 Media stream constraints, associated with OID_802_11_MEDIA_STREAM_MODE +typedef enum _NDIS_802_11_MEDIA_STREAM_MODE +{ + Ndis802_11MediaStreamOff, + Ndis802_11MediaStreamOn, +} NDIS_802_11_MEDIA_STREAM_MODE, *PNDIS_802_11_MEDIA_STREAM_MODE; + +// PMKID Structures +typedef UCHAR NDIS_802_11_PMKID_VALUE[16]; + +typedef struct _BSSID_INFO +{ + NDIS_802_11_MAC_ADDRESS BSSID; + NDIS_802_11_PMKID_VALUE PMKID; +} BSSID_INFO, *PBSSID_INFO; + +typedef struct _NDIS_802_11_PMKID +{ + ULONG Length; + ULONG BSSIDInfoCount; + BSSID_INFO BSSIDInfo[1]; +} NDIS_802_11_PMKID, *PNDIS_802_11_PMKID; + +typedef struct _NDIS_802_11_AUTHENTICATION_ENCRYPTION +{ + NDIS_802_11_AUTHENTICATION_MODE AuthModeSupported; + NDIS_802_11_ENCRYPTION_STATUS EncryptStatusSupported; +} NDIS_802_11_AUTHENTICATION_ENCRYPTION, *PNDIS_802_11_AUTHENTICATION_ENCRYPTION; + +typedef struct _NDIS_802_11_CAPABILITY +{ + ULONG Length; + ULONG Version; + ULONG NoOfPMKIDs; + ULONG NoOfAuthEncryptPairsSupported; + NDIS_802_11_AUTHENTICATION_ENCRYPTION AuthenticationEncryptionSupported[1]; +} NDIS_802_11_CAPABILITY, *PNDIS_802_11_CAPABILITY; + +typedef struct _NDIS_802_11_NON_BCAST_SSID_LIST +{ + ULONG NumberOfItems; + NDIS_802_11_SSID Non_Bcast_Ssid[1]; +} NDIS_802_11_NON_BCAST_SSID_LIST, *PNDIS_802_11_NON_BCAST_SSID_LIST; + +// for OID_802_11_RADIO_STATUS +typedef enum _NDIS_802_11_RADIO_STATUS +{ + Ndis802_11RadioStatusOn, + Ndis802_11RadioStatusHardwareOff, + Ndis802_11RadioStatusSoftwareOff, + Ndis802_11RadioStatusHardwareSoftwareOff, + Ndis802_11RadioStatusMax // not a real mode, defined as an upper bound +} +NDIS_802_11_RADIO_STATUS, *PNDIS_802_11_RADIO_STATUS; + +// +// IRDA objects +// +#define OID_IRDA_RECEIVING 0x0A010100 +#define OID_IRDA_TURNAROUND_TIME 0x0A010101 +#define OID_IRDA_SUPPORTED_SPEEDS 0x0A010102 +#define OID_IRDA_LINK_SPEED 0x0A010103 +#define OID_IRDA_MEDIA_BUSY 0x0A010104 + +#define OID_IRDA_EXTRA_RCV_BOFS 0x0A010200 +#define OID_IRDA_RATE_SNIFF 0x0A010201 +#define OID_IRDA_UNICAST_LIST 0x0A010202 +#define OID_IRDA_MAX_UNICAST_LIST_SIZE 0x0A010203 +#define OID_IRDA_MAX_RECEIVE_WINDOW_SIZE 0x0A010204 +#define OID_IRDA_MAX_SEND_WINDOW_SIZE 0x0A010205 +#define OID_IRDA_RESERVED1 0x0A01020A // The range between OID_IRDA_RESERVED1 +#define OID_IRDA_RESERVED2 0x0A01020F // and OID_IRDA_RESERVED2 is reserved + + +// +// IEEE1394 mandatory general OIDs. +// +#define OID_1394_LOCAL_NODE_INFO 0x0C010101 +#define OID_1394_VC_INFO 0x0C010102 + +// +// The following OIDs are not specific to a media. +// + +// +// These are objects for Connection-oriented media call-managers. +// +#define OID_CO_ADD_PVC 0xFE000001 +#define OID_CO_DELETE_PVC 0xFE000002 +#define OID_CO_GET_CALL_INFORMATION 0xFE000003 +#define OID_CO_ADD_ADDRESS 0xFE000004 +#define OID_CO_DELETE_ADDRESS 0xFE000005 +#define OID_CO_GET_ADDRESSES 0xFE000006 +#define OID_CO_ADDRESS_CHANGE 0xFE000007 +#define OID_CO_SIGNALING_ENABLED 0xFE000008 +#define OID_CO_SIGNALING_DISABLED 0xFE000009 +#define OID_CO_AF_CLOSE 0xFE00000A + +// +// Objects for call-managers and MCMs that support TAPI access. +// +#define OID_CO_TAPI_CM_CAPS 0xFE001001 +#define OID_CO_TAPI_LINE_CAPS 0xFE001002 +#define OID_CO_TAPI_ADDRESS_CAPS 0xFE001003 +#define OID_CO_TAPI_TRANSLATE_TAPI_CALLPARAMS 0xFE001004 +#define OID_CO_TAPI_TRANSLATE_NDIS_CALLPARAMS 0xFE001005 +#define OID_CO_TAPI_TRANSLATE_TAPI_SAP 0xFE001006 +#define OID_CO_TAPI_GET_CALL_DIAGNOSTICS 0xFE001007 +#define OID_CO_TAPI_REPORT_DIGITS 0xFE001008 +#define OID_CO_TAPI_DONT_REPORT_DIGITS 0xFE001009 + +// +// PnP and PM OIDs +// +#define OID_PNP_CAPABILITIES 0xFD010100 +#define OID_PNP_SET_POWER 0xFD010101 +#define OID_PNP_QUERY_POWER 0xFD010102 +#define OID_PNP_ADD_WAKE_UP_PATTERN 0xFD010103 +#define OID_PNP_REMOVE_WAKE_UP_PATTERN 0xFD010104 +#define OID_PNP_WAKE_UP_PATTERN_LIST 0xFD010105 +#define OID_PNP_ENABLE_WAKE_UP 0xFD010106 + +// +// PnP/PM Statistics (Optional). +// +#define OID_PNP_WAKE_UP_OK 0xFD020200 +#define OID_PNP_WAKE_UP_ERROR 0xFD020201 + +#if ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) +// +// new power management OIDs for NDIS 6.20 drivers +// + +#define OID_PM_CURRENT_CAPABILITIES 0xFD010107 +#define OID_PM_HARDWARE_CAPABILITIES 0xFD010108 +#define OID_PM_PARAMETERS 0xFD010109 +#define OID_PM_ADD_WOL_PATTERN 0xFD01010A +#define OID_PM_REMOVE_WOL_PATTERN 0xFD01010B +#define OID_PM_WOL_PATTERN_LIST 0xFD01010C +#define OID_PM_ADD_PROTOCOL_OFFLOAD 0xFD01010D +#define OID_PM_GET_PROTOCOL_OFFLOAD 0xFD01010E +#define OID_PM_REMOVE_PROTOCOL_OFFLOAD 0xFD01010F +#define OID_PM_PROTOCOL_OFFLOAD_LIST 0xFD010110 +#define OID_PM_RESERVED_1 0xFD010111 + + +// +// new NDIS 6.20 OIDs for generic packet filtering +// +#define OID_RECEIVE_FILTER_HARDWARE_CAPABILITIES 0x00010221 // query only +#define OID_RECEIVE_FILTER_GLOBAL_PARAMETERS 0x00010222 // query only +#define OID_RECEIVE_FILTER_ALLOCATE_QUEUE 0x00010223 // method only +#define OID_RECEIVE_FILTER_FREE_QUEUE 0x00010224 // set only +#define OID_RECEIVE_FILTER_ENUM_QUEUES 0x00010225 // query only +#define OID_RECEIVE_FILTER_QUEUE_PARAMETERS 0x00010226 // method and set +#define OID_RECEIVE_FILTER_SET_FILTER 0x00010227 // method only +#define OID_RECEIVE_FILTER_CLEAR_FILTER 0x00010228 // set only +#define OID_RECEIVE_FILTER_ENUM_FILTERS 0x00010229 // method only +#define OID_RECEIVE_FILTER_PARAMETERS 0x0001022A // method only +#define OID_RECEIVE_FILTER_QUEUE_ALLOCATION_COMPLETE 0x0001022B // method only +#define OID_RECEIVE_FILTER_CURRENT_CAPABILITIES 0x0001022D // query only +#define OID_NIC_SWITCH_HARDWARE_CAPABILITIES 0x0001022E // query only +#define OID_NIC_SWITCH_CURRENT_CAPABILITIES 0x0001022F // query only + +#if (NDIS_SUPPORT_NDIS630) +#define OID_RECEIVE_FILTER_MOVE_FILTER 0x00010230 // set only +#endif // (NDIS_SUPPORT_NDIS630) + +#define OID_VLAN_RESERVED1 0x00010231 +#define OID_VLAN_RESERVED2 0x00010232 +#define OID_VLAN_RESERVED3 0x00010233 +#define OID_VLAN_RESERVED4 0x00010234 + +#if (NDIS_SUPPORT_NDIS630) +#define OID_PACKET_COALESCING_FILTER_MATCH_COUNT 0x00010235 // query only +#endif // (NDIS_SUPPORT_NDIS630) + +#endif // ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) + +#if ((NTDDI_VERSION >= NTDDI_WIN8) || NDIS_SUPPORT_NDIS630) +// +// OIDs used for SRIOV and NIC switch +// +#define OID_NIC_SWITCH_CREATE_SWITCH 0x00010237 // method only +#define OID_NIC_SWITCH_PARAMETERS 0x00010238 // method and set only +#define OID_NIC_SWITCH_DELETE_SWITCH 0x00010239 // set only +#define OID_NIC_SWITCH_ENUM_SWITCHES 0x00010240 // query only +#define OID_NIC_SWITCH_CREATE_VPORT 0x00010241 // method only +#define OID_NIC_SWITCH_VPORT_PARAMETERS 0x00010242 // query and set only +#define OID_NIC_SWITCH_ENUM_VPORTS 0x00010243 // method only +#define OID_NIC_SWITCH_DELETE_VPORT 0x00010244 // set only +#define OID_NIC_SWITCH_ALLOCATE_VF 0x00010245 // method only +#define OID_NIC_SWITCH_FREE_VF 0x00010246 // set only +#define OID_NIC_SWITCH_VF_PARAMETERS 0x00010247 // method only +#define OID_NIC_SWITCH_ENUM_VFS 0x00010248 // method only + +#define OID_SRIOV_HARDWARE_CAPABILITIES 0x00010249 // query only +#define OID_SRIOV_CURRENT_CAPABILITIES 0x00010250 // query only +#define OID_SRIOV_READ_VF_CONFIG_SPACE 0x00010251 // method only +#define OID_SRIOV_WRITE_VF_CONFIG_SPACE 0x00010252 // set only +#define OID_SRIOV_READ_VF_CONFIG_BLOCK 0x00010253 // method only +#define OID_SRIOV_WRITE_VF_CONFIG_BLOCK 0x00010254 // set only +#define OID_SRIOV_RESET_VF 0x00010255 // set only +#define OID_SRIOV_SET_VF_POWER_STATE 0x00010256 // set only +#define OID_SRIOV_VF_VENDOR_DEVICE_ID 0x00010257 // method only +#define OID_SRIOV_PROBED_BARS 0x00010258 // query only +#define OID_SRIOV_BAR_RESOURCES 0x00010259 // method only +#define OID_SRIOV_PF_LUID 0x00010260 // query only + +// +// These OIDs are applicable to the VF only +// +#define OID_SRIOV_CONFIG_STATE 0x00010261 // set only +#define OID_SRIOV_VF_SERIAL_NUMBER 0x00010262 // query only +#if (NDIS_SUPPORT_NDIS670) +#define OID_SRIOV_OVERLYING_ADAPTER_INFO 0x00010268 // set only +#endif //(NDIS_SUPPORT_NDIS670) +#define OID_SRIOV_VF_INVALIDATE_CONFIG_BLOCK 0x00010269 // method only + +// +// OID's used for Hyper-V extensible switch +// +#define OID_SWITCH_PROPERTY_ADD 0x00010263 // set only +#define OID_SWITCH_PROPERTY_UPDATE 0x00010264 // set only +#define OID_SWITCH_PROPERTY_DELETE 0x00010265 // set only +#define OID_SWITCH_PROPERTY_ENUM 0x00010266 // method only +#define OID_SWITCH_FEATURE_STATUS_QUERY 0x00010267 // method only + +#define OID_SWITCH_NIC_REQUEST 0x00010270 // method only +#define OID_SWITCH_PORT_PROPERTY_ADD 0x00010271 // set only +#define OID_SWITCH_PORT_PROPERTY_UPDATE 0x00010272 // set only +#define OID_SWITCH_PORT_PROPERTY_DELETE 0x00010273 // set only +#define OID_SWITCH_PORT_PROPERTY_ENUM 0x00010274 // method only +#define OID_SWITCH_PARAMETERS 0x00010275 // query only +#define OID_SWITCH_PORT_ARRAY 0x00010276 // query only +#define OID_SWITCH_NIC_ARRAY 0x00010277 // query only +#define OID_SWITCH_PORT_CREATE 0x00010278 // set only +#define OID_SWITCH_PORT_DELETE 0x00010279 // set only +#define OID_SWITCH_NIC_CREATE 0x0001027A // set only +#define OID_SWITCH_NIC_CONNECT 0x0001027B // set only +#define OID_SWITCH_NIC_DISCONNECT 0x0001027C // set only +#define OID_SWITCH_NIC_DELETE 0x0001027D // set only +#define OID_SWITCH_PORT_FEATURE_STATUS_QUERY 0x0001027E // method only +#define OID_SWITCH_PORT_TEARDOWN 0x0001027F // set only +#define OID_SWITCH_NIC_SAVE 0x00010290 // method only +#define OID_SWITCH_NIC_SAVE_COMPLETE 0x00010291 // set only +#define OID_SWITCH_NIC_RESTORE 0x00010292 // set only +#define OID_SWITCH_NIC_RESTORE_COMPLETE 0x00010293 // set only +#define OID_SWITCH_NIC_UPDATED 0x00010294 // set only +#define OID_SWITCH_PORT_UPDATED 0x00010295 // set only + +#endif // ((NTDDI_VERSION >= NTDDI_WIN8) || NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define OID_SWITCH_NIC_DIRECT_REQUEST 0x00010296 // method only +#define OID_SWITCH_NIC_SUSPEND 0x00010297 // set only +#define OID_SWITCH_NIC_RESUME 0x00010298 // set only +#endif //(NDIS_SUPPORT_NDIS650) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) || (NDIS_SUPPORT_NDIS680) + +// +// OIDs issued at source node when a suspended LM for a NIC is starting and +// when it it is finished. +// +#define OID_SWITCH_NIC_SUSPENDED_LM_SOURCE_STARTED 0x00010299 // set only +#define OID_SWITCH_NIC_SUSPENDED_LM_SOURCE_FINISHED 0x0001029A // set only + +// RSSv2 direct OID: move an array of indirection table entries +#define OID_GEN_RSS_SET_INDIRECTION_TABLE_ENTRIES 0x000102C0 // method only + + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS3) || (NDIS_SUPPORT_NDIS680) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) ||(NDIS_SUPPORT_NDIS640) + +#define OID_GEN_ISOLATION_PARAMETERS 0x00010300 // query only + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) ||(NDIS_SUPPORT_NDIS640) + +#if (NDIS_SUPPORT_NDIS650) + +#define OID_GFT_HARDWARE_CAPABILITIES 0x00010401 // query only +#define OID_GFT_CURRENT_CAPABILITIES 0x00010402 // query only +#define OID_GFT_GLOBAL_PARAMETERS 0x00010403 // query and set + +#define OID_GFT_CREATE_TABLE 0x00010404 // method only +#define OID_GFT_DELETE_TABLE 0x00010405 // set only +#define OID_GFT_ENUM_TABLES 0x00010406 // query only + +#define OID_GFT_ALLOCATE_COUNTERS 0x00010407 // method only +#define OID_GFT_FREE_COUNTERS 0x00010408 // set only +#define OID_GFT_ENUM_COUNTERS 0x00010409 // method +#define OID_GFT_COUNTER_VALUES 0x0001040A // direct OID. method + +#define OID_GFT_STATISTICS 0x0001040B // query only, direct OID + +#define OID_GFT_ADD_FLOW_ENTRIES 0x0001040C // method only, direct OID +#define OID_GFT_DELETE_FLOW_ENTRIES 0x0001040D // method only, direct OID +#define OID_GFT_ENUM_FLOW_ENTRIES 0x0001040E // method only +#define OID_GFT_ACTIVATE_FLOW_ENTRIES 0x0001040F // set only, direct OID +#define OID_GFT_DEACTIVATE_FLOW_ENTRIES 0x00010410 // set only, direct OID +#define OID_GFT_FLOW_ENTRY_PARAMETERS 0x00010411 // method only, direct OID + +#define OID_GFT_EXACT_MATCH_PROFILE 0x00010412 // method +#define OID_GFT_HEADER_TRANSPOSITION_PROFILE 0x00010413 // method +#define OID_GFT_WILDCARD_MATCH_PROFILE 0x00010414 // method +#define OID_GFT_ENUM_PROFILES 0x00010415 // query only +#define OID_GFT_DELETE_PROFILE 0x00010416 // set only + +#define OID_GFT_VPORT_PARAMETERS 0x00010417 // query and set + +#define OID_GFT_CREATE_LOGICAL_VPORT 0x00010418 // method +#define OID_GFT_DELETE_LOGICAL_VPORT 0x00010419 // set +#define OID_GFT_ENUM_LOGICAL_VPORTS 0x0001041A // query + +#define OID_QOS_OFFLOAD_HARDWARE_CAPABILITIES 0x00010601 // query only +#define OID_QOS_OFFLOAD_CURRENT_CAPABILITIES 0x00010602 // query only + +#define OID_QOS_OFFLOAD_CREATE_SQ 0x00010603 // set only +#define OID_QOS_OFFLOAD_DELETE_SQ 0x00010604 // set only +#define OID_QOS_OFFLOAD_UPDATE_SQ 0x00010605 // set only +#define OID_QOS_OFFLOAD_ENUM_SQS 0x00010606 // method only +#if (NDIS_SUPPORT_NDIS684) +#define OID_QOS_OFFLOAD_SQ_STATS 0x00010607 // method only +#endif + +#define OID_PD_OPEN_PROVIDER 0x00010501 // method +#define OID_PD_CLOSE_PROVIDER 0x00010502 // set only +#define OID_PD_QUERY_CURRENT_CONFIG 0x00010503 // query + +#endif // (NDIS_SUPPORT_NDIS650) + + +// +// The following bits are defined for OID_PNP_ENABLE_WAKE_UP +// +#define NDIS_PNP_WAKE_UP_MAGIC_PACKET 0x00000001 +#define NDIS_PNP_WAKE_UP_PATTERN_MATCH 0x00000002 +#define NDIS_PNP_WAKE_UP_LINK_CHANGE 0x00000004 + +// +// TCP/IP OIDs +// +#define OID_TCP_TASK_OFFLOAD 0xFC010201 +#define OID_TCP_TASK_IPSEC_ADD_SA 0xFC010202 +#define OID_TCP_TASK_IPSEC_DELETE_SA 0xFC010203 +#define OID_TCP_SAN_SUPPORT 0xFC010204 +#define OID_TCP_TASK_IPSEC_ADD_UDPESP_SA 0xFC010205 +#define OID_TCP_TASK_IPSEC_DELETE_UDPESP_SA 0xFC010206 +#define OID_TCP4_OFFLOAD_STATS 0xFC010207 +#define OID_TCP6_OFFLOAD_STATS 0xFC010208 +#define OID_IP4_OFFLOAD_STATS 0xFC010209 +#define OID_IP6_OFFLOAD_STATS 0xFC01020A + +// +// new offload OIDs for NDIS 6 +// +#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B // query only, handled by NDIS +#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C // set only +#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D // query only +#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E // query only +#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F // query only +#define OID_OFFLOAD_ENCAPSULATION 0x0101010A + +#if (NDIS_SUPPORT_NDIS61) +// +// IPsec Task offload V2 OIDs +// +#define OID_TCP_TASK_IPSEC_OFFLOAD_V2_ADD_SA 0xFC030202 +#define OID_TCP_TASK_IPSEC_OFFLOAD_V2_DELETE_SA 0xFC030203 +#define OID_TCP_TASK_IPSEC_OFFLOAD_V2_UPDATE_SA 0xFC030204 +#endif // (NDIS_SUPPORT_NDIS61) +#if (NDIS_SUPPORT_NDIS630) +#define OID_TCP_TASK_IPSEC_OFFLOAD_V2_ADD_SA_EX 0xFC030205 +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Defines for FFP, obsolete +// +#define OID_FFP_SUPPORT 0xFC010210 +#define OID_FFP_FLUSH 0xFC010211 +#define OID_FFP_CONTROL 0xFC010212 +#define OID_FFP_PARAMS 0xFC010213 +#define OID_FFP_DATA 0xFC010214 + +#define OID_FFP_DRIVER_STATS 0xFC020210 +#define OID_FFP_ADAPTER_STATS 0xFC020211 + + +// +// TCP Connection offload OID +// +#define OID_TCP_CONNECTION_OFFLOAD_PARAMETERS 0xFC030201 + +#if ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) +// +// New Tunnel driver direct OIDs for NDIS 6.20 +// +#define OID_TUNNEL_INTERFACE_SET_OID 0x0f010106 +#define OID_TUNNEL_INTERFACE_RELEASE_OID 0x0f010107 +#endif // ((NTDDI_VERSION >= NTDDI_WIN7) || NDIS_SUPPORT_NDIS620) + + +// +// Defines for QOS +// +#define OID_QOS_RESERVED1 0xFB010100 +#define OID_QOS_RESERVED2 0xFB010101 +#define OID_QOS_RESERVED3 0xFB010102 +#define OID_QOS_RESERVED4 0xFB010103 +#define OID_QOS_RESERVED5 0xFB010104 +#define OID_QOS_RESERVED6 0xFB010105 +#define OID_QOS_RESERVED7 0xFB010106 +#define OID_QOS_RESERVED8 0xFB010107 +#define OID_QOS_RESERVED9 0xFB010108 +#define OID_QOS_RESERVED10 0xFB010109 +#define OID_QOS_RESERVED11 0xFB01010A +#define OID_QOS_RESERVED12 0xFB01010B +#define OID_QOS_RESERVED13 0xFB01010C +#define OID_QOS_RESERVED14 0xFB01010D +#define OID_QOS_RESERVED15 0xFB01010E +#define OID_QOS_RESERVED16 0xFB01010F +#define OID_QOS_RESERVED17 0xFB010110 +#define OID_QOS_RESERVED18 0xFB010111 +#define OID_QOS_RESERVED19 0xFB010112 +#define OID_QOS_RESERVED20 0xFB010113 + + +#if ((NTDDI_VERSION >= NTDDI_WINTHRESHOLD) || NDIS_SUPPORT_NDIS650) + +// +// OIDs reserved for Xbox accessories +// +#define OID_XBOX_ACC_RESERVED0 0xFA000000 +// OIDs 0xFA000000 through 0xFAFFFFFF are reserved +// #define OID_XBOX_ACC_RESERVED_LAST 0xFAFFFFFF + + +#endif // THRESHOLD + + +// +// NDIS Proxy OID_GEN_CO_DEVICE_PROFILE structure. The optional OID and +// this structure is a generic means of describing a CO device's +// capabilities, and is used by the NDIS Proxy to construct a TAPI device +// capabilities structure. +// +typedef struct NDIS_CO_DEVICE_PROFILE +{ + NDIS_VAR_DATA_DESC DeviceDescription; // e.g. 'GigabitATMNet' + NDIS_VAR_DATA_DESC DevSpecificInfo; // special features + + ULONG ulTAPISupplementaryPassThru;// reserved in NT5 + ULONG ulAddressModes; + ULONG ulNumAddresses; + ULONG ulBearerModes; + ULONG ulMaxTxRate; // bytes per second + ULONG ulMinTxRate; // bytes per second + ULONG ulMaxRxRate; // bytes per second + ULONG ulMinRxRate; // bytes per second + ULONG ulMediaModes; + + // + // Tone/digit generation and recognition capabilities + // + ULONG ulGenerateToneModes; + ULONG ulGenerateToneMaxNumFreq; + ULONG ulGenerateDigitModes; + ULONG ulMonitorToneMaxNumFreq; + ULONG ulMonitorToneMaxNumEntries; + ULONG ulMonitorDigitModes; + ULONG ulGatherDigitsMinTimeout;// milliseconds + ULONG ulGatherDigitsMaxTimeout;// milliseconds + + ULONG ulDevCapFlags; // Misc. capabilities + ULONG ulMaxNumActiveCalls; // (This * ulMinRate) = total bandwidth (which may equal ulMaxRate) + ULONG ulAnswerMode; // Effect of answering a new call when an + // existing call is non-idle + // + // User-User info sizes allowed to accompany each operation + // + ULONG ulUUIAcceptSize; // bytes + ULONG ulUUIAnswerSize; // bytes + ULONG ulUUIMakeCallSize; // bytes + ULONG ulUUIDropSize; // bytes + ULONG ulUUISendUserUserInfoSize; // bytes + ULONG ulUUICallInfoSize; // bytes + +} NDIS_CO_DEVICE_PROFILE, *PNDIS_CO_DEVICE_PROFILE; + +// +// Structures for TCP IPsec. +// +#ifndef IP_EXPORT_INCLUDED +typedef ULONG IPAddr, IPMask; +#endif +typedef ULONG SPI_TYPE; + +typedef enum _OFFLOAD_OPERATION_E +{ + AUTHENTICATE = 1, + ENCRYPT +} + OFFLOAD_OPERATION_E; + +typedef struct _OFFLOAD_ALGO_INFO +{ + ULONG algoIdentifier; + ULONG algoKeylen; + ULONG algoRounds; +} + OFFLOAD_ALGO_INFO, + *POFFLOAD_ALGO_INFO; + +typedef enum _OFFLOAD_CONF_ALGO +{ + OFFLOAD_IPSEC_CONF_NONE, + OFFLOAD_IPSEC_CONF_DES, + OFFLOAD_IPSEC_CONF_RESERVED, + OFFLOAD_IPSEC_CONF_3_DES, + OFFLOAD_IPSEC_CONF_MAX +} + OFFLOAD_CONF_ALGO; + +typedef enum _OFFLOAD_INTEGRITY_ALGO +{ + OFFLOAD_IPSEC_INTEGRITY_NONE, + OFFLOAD_IPSEC_INTEGRITY_MD5, + OFFLOAD_IPSEC_INTEGRITY_SHA, + OFFLOAD_IPSEC_INTEGRITY_MAX +} + OFFLOAD_INTEGRITY_ALGO; + +typedef struct _OFFLOAD_SECURITY_ASSOCIATION +{ + OFFLOAD_OPERATION_E Operation; + SPI_TYPE SPI; + OFFLOAD_ALGO_INFO IntegrityAlgo; + OFFLOAD_ALGO_INFO ConfAlgo; + OFFLOAD_ALGO_INFO Reserved; +} + OFFLOAD_SECURITY_ASSOCIATION, + *POFFLOAD_SECURITY_ASSOCIATION; + +#define OFFLOAD_MAX_SAS 3 + +#define OFFLOAD_INBOUND_SA 0x0001 +#define OFFLOAD_OUTBOUND_SA 0x0002 + +typedef struct _OFFLOAD_IPSEC_ADD_SA +{ + IPAddr SrcAddr; + IPMask SrcMask; + IPAddr DestAddr; + IPMask DestMask; + ULONG Protocol; + USHORT SrcPort; + USHORT DestPort; + IPAddr SrcTunnelAddr; + IPAddr DestTunnelAddr; + USHORT Flags; + SHORT NumSAs; + OFFLOAD_SECURITY_ASSOCIATION SecAssoc[OFFLOAD_MAX_SAS]; + HANDLE OffloadHandle; + ULONG KeyLen; + UCHAR KeyMat[1]; +} OFFLOAD_IPSEC_ADD_SA, *POFFLOAD_IPSEC_ADD_SA; + +typedef struct _OFFLOAD_IPSEC_DELETE_SA +{ + HANDLE OffloadHandle; +} OFFLOAD_IPSEC_DELETE_SA, *POFFLOAD_IPSEC_DELETE_SA; + + +typedef enum _UDP_ENCAP_TYPE +{ + OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_IKE, + OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_OTHER +} UDP_ENCAP_TYPE, * PUDP_ENCAP_TYPE; + + +typedef struct _OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY +{ + UDP_ENCAP_TYPE UdpEncapType; + USHORT DstEncapPort; +} OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY, * POFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY; + + +typedef struct _OFFLOAD_IPSEC_ADD_UDPESP_SA +{ + IPAddr SrcAddr; + IPMask SrcMask; + IPAddr DstAddr; + IPMask DstMask; + ULONG Protocol; + USHORT SrcPort; + USHORT DstPort; + IPAddr SrcTunnelAddr; + IPAddr DstTunnelAddr; + USHORT Flags; + SHORT NumSAs; + OFFLOAD_SECURITY_ASSOCIATION SecAssoc[OFFLOAD_MAX_SAS]; + HANDLE OffloadHandle; + OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY EncapTypeEntry; + HANDLE EncapTypeEntryOffldHandle; + ULONG KeyLen; + UCHAR KeyMat[1]; +} OFFLOAD_IPSEC_ADD_UDPESP_SA, * POFFLOAD_IPSEC_ADD_UDPESP_SA; + + +typedef struct _OFFLOAD_IPSEC_DELETE_UDPESP_SA +{ + HANDLE OffloadHandle; + HANDLE EncapTypeEntryOffldHandle; +} OFFLOAD_IPSEC_DELETE_UDPESP_SA, * POFFLOAD_IPSEC_DELETE_UDPESP_SA; + + +// +// Type to go with OID_GEN_VLAN_ID: the least significant 12 bits are +// used as the VLAN ID (VID) per IEEE 802.1Q. Higher order bits are +// reserved and must be set to 0. +// +typedef ULONG NDIS_VLAN_ID; + +// +// Medium the Ndis Driver is running on (OID_GEN_MEDIA_SUPPORTED/ OID_GEN_MEDIA_IN_USE). +// +typedef enum _NDIS_MEDIUM +{ + NdisMedium802_3, + NdisMedium802_5, + NdisMediumFddi, + NdisMediumWan, + NdisMediumLocalTalk, + NdisMediumDix, // defined for convenience, not a real medium + NdisMediumArcnetRaw, + NdisMediumArcnet878_2, + NdisMediumAtm, + NdisMediumWirelessWan, + NdisMediumIrda, + NdisMediumBpc, + NdisMediumCoWan, + NdisMedium1394, + NdisMediumInfiniBand, +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + NdisMediumTunnel, + NdisMediumNative802_11, + NdisMediumLoopback, +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN7) + NdisMediumWiMAX, + NdisMediumIP, +#endif + + NdisMediumMax // Not a real medium, defined as an upper-bound +} NDIS_MEDIUM, *PNDIS_MEDIUM; + + +// +// Physical Medium Type definitions. Used with OID_GEN_PHYSICAL_MEDIUM. +// +typedef enum _NDIS_PHYSICAL_MEDIUM +{ + NdisPhysicalMediumUnspecified, + NdisPhysicalMediumWirelessLan, + NdisPhysicalMediumCableModem, + NdisPhysicalMediumPhoneLine, + NdisPhysicalMediumPowerLine, + NdisPhysicalMediumDSL, // includes ADSL and UADSL (G.Lite) + NdisPhysicalMediumFibreChannel, + NdisPhysicalMedium1394, + NdisPhysicalMediumWirelessWan, + NdisPhysicalMediumNative802_11, + NdisPhysicalMediumBluetooth, + NdisPhysicalMediumInfiniband, + NdisPhysicalMediumWiMax, + NdisPhysicalMediumUWB, + NdisPhysicalMedium802_3, + NdisPhysicalMedium802_5, + NdisPhysicalMediumIrda, + NdisPhysicalMediumWiredWAN, + NdisPhysicalMediumWiredCoWan, + NdisPhysicalMediumOther, + NdisPhysicalMediumNative802_15_4, + NdisPhysicalMediumMax // Not a real physical type, defined as an upper-bound +} NDIS_PHYSICAL_MEDIUM, *PNDIS_PHYSICAL_MEDIUM; + + +// +// Protocol types supported by ndis. These values need to be consistent with ADDRESS_TYPE_XXX defined in TDI.H +// +#define NDIS_PROTOCOL_ID_DEFAULT 0x00 +#define NDIS_PROTOCOL_ID_TCP_IP 0x02 +#define NDIS_PROTOCOL_ID_IP6 0x03 +#define NDIS_PROTOCOL_ID_IPX 0x06 +#define NDIS_PROTOCOL_ID_NBF 0x07 +#define NDIS_PROTOCOL_ID_MAX 0x0F +#define NDIS_PROTOCOL_ID_MASK 0x0F + +// +// The following is used with OID_GEN_TRANSPORT_HEADER_OFFSET to indicate the length of the layer-2 header +// for packets sent by a particular protocol. +// +typedef struct _TRANSPORT_HEADER_OFFSET +{ + USHORT ProtocolType; // The protocol that is sending this OID (NDIS_PROTOCOL_ID_XXX above) + USHORT HeaderOffset; // The header offset +} TRANSPORT_HEADER_OFFSET, *PTRANSPORT_HEADER_OFFSET; + + +// +// The structures below need to be consistent with TRANSPORT_ADDRESS structures in TDI.H +// +typedef struct _NETWORK_ADDRESS +{ + USHORT AddressLength; // length in bytes of Address[] in this + USHORT AddressType; // type of this address (NDIS_PROTOCOL_ID_XXX above) + UCHAR Address[1]; // actually AddressLength bytes long +} NETWORK_ADDRESS, *PNETWORK_ADDRESS; + +// +// The following is used with OID_GEN_NETWORK_LAYER_ADDRESSES to set network layer addresses on an interface +// +typedef struct _NETWORK_ADDRESS_LIST +{ + LONG AddressCount; // number of addresses following + USHORT AddressType; // type of this address (NDIS_PROTOCOL_ID_XXX above) + NETWORK_ADDRESS Address[1]; // actually AddressCount elements long +} NETWORK_ADDRESS_LIST, *PNETWORK_ADDRESS_LIST; + +// +// IP address - This must remain consistent with TDI_ADDRESS_IP in tdi.h +// +typedef struct _NETWORK_ADDRESS_IP +{ + USHORT sin_port; + ULONG in_addr; + UCHAR sin_zero[8]; +} NETWORK_ADDRESS_IP, *PNETWORK_ADDRESS_IP; + +#define NETWORK_ADDRESS_LENGTH_IP sizeof (NETWORK_ADDRESS_IP) + +// +// IPv6 address - This must remain consistent with TDI_ADDRESS_IP6 in tdi.h +// +typedef struct _NETWORK_ADDRESS_IP6 { + USHORT sin6_port; + ULONG sin6_flowinfo; + USHORT sin6_addr[8]; + ULONG sin6_scope_id; +} NETWORK_ADDRESS_IP6, *PNETWORK_ADDRESS_IP6; + +#define NETWORK_ADDRESS_LENGTH_IP6 sizeof (NETWORK_ADDRESS_IP6) + +// +// IPX address - This must remain consistent with TDI_ADDRESS_IPX in tdi.h. +// +typedef struct _NETWORK_ADDRESS_IPX +{ + ULONG NetworkAddress; + UCHAR NodeAddress[6]; + USHORT Socket; +} NETWORK_ADDRESS_IPX, *PNETWORK_ADDRESS_IPX; + +#define NETWORK_ADDRESS_LENGTH_IPX sizeof (NETWORK_ADDRESS_IPX) + +// +// Hardware status codes (OID_GEN_HARDWARE_STATUS). +// + +typedef enum _NDIS_HARDWARE_STATUS +{ + NdisHardwareStatusReady, + NdisHardwareStatusInitializing, + NdisHardwareStatusReset, + NdisHardwareStatusClosing, + NdisHardwareStatusNotReady +} NDIS_HARDWARE_STATUS, *PNDIS_HARDWARE_STATUS; + + +// +// this is the type passed in the OID_GEN_GET_TIME_CAPS request +// +typedef struct _GEN_GET_TIME_CAPS +{ + ULONG Flags; // Bits defined below + ULONG ClockPrecision; +} GEN_GET_TIME_CAPS, *PGEN_GET_TIME_CAPS; + +#define READABLE_LOCAL_CLOCK 0x00000001 +#define CLOCK_NETWORK_DERIVED 0x00000002 +#define CLOCK_PRECISION 0x00000004 +#define RECEIVE_TIME_INDICATION_CAPABLE 0x00000008 +#define TIMED_SEND_CAPABLE 0x00000010 +#define TIME_STAMP_CAPABLE 0x00000020 + +// +// this is the type passed in the OID_GEN_GET_NETCARD_TIME request +// +typedef struct _GEN_GET_NETCARD_TIME +{ + ULONGLONG ReadTime; +} GEN_GET_NETCARD_TIME, *PGEN_GET_NETCARD_TIME; + +// +// NDIS PnP routines and definitions. +// +typedef struct _NDIS_PM_PACKET_PATTERN +{ + ULONG Priority; // Importance of the given pattern. + ULONG Reserved; // Context information for transports. + ULONG MaskSize; // Size in bytes of the pattern mask. + ULONG PatternOffset; // Offset from beginning of this + // structure to the pattern bytes. + ULONG PatternSize; // Size in bytes of the pattern. + ULONG PatternFlags; // Flags (TBD). +} NDIS_PM_PACKET_PATTERN, *PNDIS_PM_PACKET_PATTERN; + + +// +// The following structure defines the device power states. +// +typedef enum _NDIS_DEVICE_POWER_STATE +{ + NdisDeviceStateUnspecified = 0, + NdisDeviceStateD0, + NdisDeviceStateD1, + NdisDeviceStateD2, + NdisDeviceStateD3, + NdisDeviceStateMaximum +} NDIS_DEVICE_POWER_STATE, *PNDIS_DEVICE_POWER_STATE; + +// +// The following structure defines the wake-up capabilities of the device. +// +typedef struct _NDIS_PM_WAKE_UP_CAPABILITIES +{ + NDIS_DEVICE_POWER_STATE MinMagicPacketWakeUp; + NDIS_DEVICE_POWER_STATE MinPatternWakeUp; + NDIS_DEVICE_POWER_STATE MinLinkChangeWakeUp; +} NDIS_PM_WAKE_UP_CAPABILITIES, *PNDIS_PM_WAKE_UP_CAPABILITIES; + +// +// the following flags define the -enabled- wake-up capabilities of the device +// passed in the Flags field of NDIS_PNP_CAPABILITIES structure +// +#define NDIS_DEVICE_WAKE_UP_ENABLE 0x00000001 +#define NDIS_DEVICE_WAKE_ON_PATTERN_MATCH_ENABLE 0x00000002 +#define NDIS_DEVICE_WAKE_ON_MAGIC_PACKET_ENABLE 0x00000004 + +// +// This structure defines general PnP capabilities of the miniport driver. +// +typedef struct _NDIS_PNP_CAPABILITIES +{ + ULONG Flags; + NDIS_PM_WAKE_UP_CAPABILITIES WakeUpCapabilities; +} NDIS_PNP_CAPABILITIES, *PNDIS_PNP_CAPABILITIES; + +// +// Defines the attachment types for FDDI (OID_FDDI_ATTACHMENT_TYPE). +// +typedef enum _NDIS_FDDI_ATTACHMENT_TYPE +{ + NdisFddiTypeIsolated = 1, + NdisFddiTypeLocalA, + NdisFddiTypeLocalB, + NdisFddiTypeLocalAB, + NdisFddiTypeLocalS, + NdisFddiTypeWrapA, + NdisFddiTypeWrapB, + NdisFddiTypeWrapAB, + NdisFddiTypeWrapS, + NdisFddiTypeCWrapA, + NdisFddiTypeCWrapB, + NdisFddiTypeCWrapS, + NdisFddiTypeThrough +} NDIS_FDDI_ATTACHMENT_TYPE, *PNDIS_FDDI_ATTACHMENT_TYPE; + + +// +// Defines the ring management states for FDDI (OID_FDDI_RING_MGT_STATE). +// +typedef enum _NDIS_FDDI_RING_MGT_STATE +{ + NdisFddiRingIsolated = 1, + NdisFddiRingNonOperational, + NdisFddiRingOperational, + NdisFddiRingDetect, + NdisFddiRingNonOperationalDup, + NdisFddiRingOperationalDup, + NdisFddiRingDirected, + NdisFddiRingTrace +} NDIS_FDDI_RING_MGT_STATE, *PNDIS_FDDI_RING_MGT_STATE; + + +// +// Defines the Lconnection state for FDDI (OID_FDDI_LCONNECTION_STATE). +// +typedef enum _NDIS_FDDI_LCONNECTION_STATE +{ + NdisFddiStateOff = 1, + NdisFddiStateBreak, + NdisFddiStateTrace, + NdisFddiStateConnect, + NdisFddiStateNext, + NdisFddiStateSignal, + NdisFddiStateJoin, + NdisFddiStateVerify, + NdisFddiStateActive, + NdisFddiStateMaintenance +} NDIS_FDDI_LCONNECTION_STATE, *PNDIS_FDDI_LCONNECTION_STATE; + + +// +// Defines the medium subtypes for WAN medium (OID_WAN_MEDIUM_SUBTYPE). +// Sub-medium used only by connection-oriented WAN devices +// i.e. NdisMediumWan, NdisMediumCoWan. +// +typedef enum _NDIS_WAN_MEDIUM_SUBTYPE +{ + NdisWanMediumHub, + NdisWanMediumX_25, + NdisWanMediumIsdn, + NdisWanMediumSerial, + NdisWanMediumFrameRelay, + NdisWanMediumAtm, + NdisWanMediumSonet, + NdisWanMediumSW56K, + NdisWanMediumPPTP, + NdisWanMediumL2TP, + NdisWanMediumIrda, + NdisWanMediumParallel, + NdisWanMediumPppoe, +#if (NTDDI_VERSION >= NTDDI_VISTA) + NdisWanMediumSSTP, + NdisWanMediumAgileVPN, +#endif //(NTDDI_VERSION >= NTDDI_VISTA) +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + NdisWanMediumGre, +#endif //(NTDDI_VERSION >= NTDDI_WINBLUE) + NdisWanMediumSubTypeMax +} NDIS_WAN_MEDIUM_SUBTYPE, *PNDIS_WAN_MEDIUM_SUBTYPE; + + +// +// Defines the header format for WAN medium (OID_WAN_HEADER_FORMAT). +// +typedef enum _NDIS_WAN_HEADER_FORMAT +{ + NdisWanHeaderNative, // src/dest based on subtype, followed by NLPID + NdisWanHeaderEthernet // emulation of ethernet header +} NDIS_WAN_HEADER_FORMAT, *PNDIS_WAN_HEADER_FORMAT; + + +// +// Defines the line quality on a WAN line (OID_WAN_QUALITY_OF_SERVICE). +// +typedef enum _NDIS_WAN_QUALITY +{ + NdisWanRaw, + NdisWanErrorControl, + NdisWanReliable +} NDIS_WAN_QUALITY, *PNDIS_WAN_QUALITY; + + +// +// Defines a protocol's WAN specific capabilities (OID_WAN_PROTOCOL_CAPS). +// +typedef struct _NDIS_WAN_PROTOCOL_CAPS +{ + _In_ ULONG Flags; + _In_ ULONG Reserved; +} NDIS_WAN_PROTOCOL_CAPS, *PNDIS_WAN_PROTOCOL_CAPS; + + +// +// Flags used in NDIS_WAN_PROTOCOL_CAPS +// +#define WAN_PROTOCOL_KEEPS_STATS 0x00000001 + + +// +// Defines the state of a token-ring adapter (OID_802_5_CURRENT_RING_STATE). +// +typedef enum _NDIS_802_5_RING_STATE +{ + NdisRingStateOpened = 1, + NdisRingStateClosed, + NdisRingStateOpening, + NdisRingStateClosing, + NdisRingStateOpenFailure, + NdisRingStateRingFailure +} NDIS_802_5_RING_STATE, *PNDIS_802_5_RING_STATE; + +// +// Defines the state of the LAN media +// +typedef enum _NDIS_MEDIA_STATE +{ + NdisMediaStateConnected, + NdisMediaStateDisconnected +} NDIS_MEDIA_STATE, *PNDIS_MEDIA_STATE; + +// +// The following is set on a per-packet basis as OOB data with NdisClass802_3Priority +// +typedef ULONG Priority_802_3; // 0-7 priority levels + +// +// The following structure is used to query OID_GEN_CO_LINK_SPEED and +// OID_GEN_CO_MINIMUM_LINK_SPEED. The first OID will return the current +// link speed of the adapter. The second will return the minimum link speed +// the adapter is capable of. +// +typedef struct _NDIS_CO_LINK_SPEED +{ + ULONG Outbound; + ULONG Inbound; +} NDIS_CO_LINK_SPEED, *PNDIS_CO_LINK_SPEED; + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + +// +// The following structure is used in OID_GEN_LINK_SPEED_EX for interfaces +// and is expressed in bits per second. +// +typedef struct _NDIS_LINK_SPEED +{ + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; +} NDIS_LINK_SPEED, *PNDIS_LINK_SPEED; + + + +// miniports or interfaces that do not know their current link speed +// can report NDIS_LINK_SPEED_UNKNOWN == ((ULONG64)-1) +#define NDIS_LINK_SPEED_UNKNOWN NET_IF_LINK_SPEED_UNKNOWN +#endif + +#include + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) +// Native 802.11 Definitions +#ifndef __WINDOT11_H__ +#include +#endif +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +// +// Structure to be used for OID_GEN_SUPPORTED_GUIDS. +// This structure describes an OID to GUID mapping. +// Or a Status to GUID mapping. +// When ndis receives a request for a give GUID it will +// query the miniport with the supplied OID. +// +typedef struct _NDIS_GUID +{ + GUID Guid; + union + { + NDIS_OID Oid; + NDIS_STATUS Status; + }; + ULONG Size; // Size of the data element. If the GUID + // represents an array then this is the + // size of an element in the array. + // This is -1 for strings. + ULONG Flags; +} NDIS_GUID, *PNDIS_GUID; + +#define fNDIS_GUID_TO_OID 0x00000001 +#define fNDIS_GUID_TO_STATUS 0x00000002 +#define fNDIS_GUID_ANSI_STRING 0x00000004 +#define fNDIS_GUID_UNICODE_STRING 0x00000008 +#define fNDIS_GUID_ARRAY 0x00000010 +#define fNDIS_GUID_ALLOW_READ 0x00000020 +#define fNDIS_GUID_ALLOW_WRITE 0x00000040 +#define fNDIS_GUID_METHOD 0x00000080 +#define fNDIS_GUID_NDIS_RESERVED 0x00000100 +#define fNDIS_GUID_SUPPORT_COMMON_HEADER 0x00000200 + +// +// Ndis Packet Filter Bits (OID_GEN_CURRENT_PACKET_FILTER). +// +#define NDIS_PACKET_TYPE_DIRECTED 0x00000001 +#define NDIS_PACKET_TYPE_MULTICAST 0x00000002 +#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004 +#define NDIS_PACKET_TYPE_BROADCAST 0x00000008 +#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010 +#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020 +#define NDIS_PACKET_TYPE_SMT 0x00000040 +#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080 +#define NDIS_PACKET_TYPE_GROUP 0x00001000 +#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00002000 +#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00004000 +#define NDIS_PACKET_TYPE_MAC_FRAME 0x00008000 +#define NDIS_PACKET_TYPE_NO_LOCAL 0x00010000 + + +// +// Ndis Token-Ring Ring Status Codes (OID_802_5_CURRENT_RING_STATUS). +// +#define NDIS_RING_SIGNAL_LOSS 0x00008000 +#define NDIS_RING_HARD_ERROR 0x00004000 +#define NDIS_RING_SOFT_ERROR 0x00002000 +#define NDIS_RING_TRANSMIT_BEACON 0x00001000 +#define NDIS_RING_LOBE_WIRE_FAULT 0x00000800 +#define NDIS_RING_AUTO_REMOVAL_ERROR 0x00000400 +#define NDIS_RING_REMOVE_RECEIVED 0x00000200 +#define NDIS_RING_COUNTER_OVERFLOW 0x00000100 +#define NDIS_RING_SINGLE_STATION 0x00000080 +#define NDIS_RING_RING_RECOVERY 0x00000040 + + +// +// Ndis protocol option bits (OID_GEN_PROTOCOL_OPTIONS). +// +#define NDIS_PROT_OPTION_ESTIMATED_LENGTH 0x00000001 +#define NDIS_PROT_OPTION_NO_LOOPBACK 0x00000002 +#define NDIS_PROT_OPTION_NO_RSVD_ON_RCVPKT 0x00000004 +#define NDIS_PROT_OPTION_SEND_RESTRICTED 0x00000008 + +// +// Ndis MAC option bits (OID_GEN_MAC_OPTIONS). +// +#define NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA 0x00000001 +#define NDIS_MAC_OPTION_RECEIVE_SERIALIZED 0x00000002 +#define NDIS_MAC_OPTION_TRANSFERS_NOT_PEND 0x00000004 +#define NDIS_MAC_OPTION_NO_LOOPBACK 0x00000008 + +// +// This flag has been deprecated. Deserialized drivers are +// full duplex drivers +// +#define NDIS_MAC_OPTION_FULL_DUPLEX 0x00000010 // deprecated + + +#define NDIS_MAC_OPTION_EOTX_INDICATION 0x00000020 +#define NDIS_MAC_OPTION_8021P_PRIORITY 0x00000040 +#define NDIS_MAC_OPTION_SUPPORTS_MAC_ADDRESS_OVERWRITE 0x00000080 +#define NDIS_MAC_OPTION_RECEIVE_AT_DPC 0x00000100 +#define NDIS_MAC_OPTION_8021Q_VLAN 0x00000200 +#define NDIS_MAC_OPTION_RESERVED 0x80000000 + +// +// NDIS media capabilities bits (OID_GEN_MEDIA_CAPABILITIES). +// +#define NDIS_MEDIA_CAP_TRANSMIT 0x00000001 // Supports sending data +#define NDIS_MEDIA_CAP_RECEIVE 0x00000002 // Supports receiving data + +// +// NDIS MAC option bits for OID_GEN_CO_MAC_OPTIONS. +// +#define NDIS_CO_MAC_OPTION_DYNAMIC_LINK_SPEED 0x00000001 + +// +// The following is set on a per-packet basis as OOB data with NdisClassIrdaPacketInfo +// This is the per-packet info specified on a per-packet basis +// +typedef struct _NDIS_IRDA_PACKET_INFO +{ + ULONG ExtraBOFs; + ULONG MinTurnAroundTime; +} NDIS_IRDA_PACKET_INFO, *PNDIS_IRDA_PACKET_INFO; + + + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + +// +// The following macro is used to build a NET_LUID +// + +#define NDIS_MAKE_NET_LUID(_pNetLuid, _IfType, _NetLuidIndex) \ +{ \ + (_pNetLuid)->Info.IfType = _IfType; \ + (_pNetLuid)->Info.NetLuidIndex = _NetLuidIndex; \ + (_pNetLuid)->Info.Reserved = 0; \ +} + +#define NDIS_IF_MAX_STRING_SIZE IF_MAX_STRING_SIZE +typedef IF_COUNTED_STRING NDIS_IF_COUNTED_STRING, *PNDIS_IF_COUNTED_STRING; + +#define NDIS_MAX_PHYS_ADDRESS_LENGTH IF_MAX_PHYS_ADDRESS_LENGTH +typedef IF_PHYSICAL_ADDRESS NDIS_IF_PHYSICAL_ADDRESS, *PNDIS_IF_PHYSICAL_ADDRESS; + +// +// NDIS_MEDIA_CONNECT_STATE enum type is used in OID_GEN_MEDIA_CONNECT_STATUS_EX +// +typedef NET_IF_MEDIA_CONNECT_STATE NDIS_MEDIA_CONNECT_STATE, *PNDIS_MEDIA_CONNECT_STATE; + +// +// NET_IF_MEDIA_DUPLEX_STATE enum type is used in OID_GEN_MEDIA_DUPLEX_STATE +// +typedef NET_IF_MEDIA_DUPLEX_STATE NDIS_MEDIA_DUPLEX_STATE, *PNDIS_MEDIA_DUPLEX_STATE; + +typedef enum _NDIS_SUPPORTED_PAUSE_FUNCTIONS +{ + NdisPauseFunctionsUnsupported, + NdisPauseFunctionsSendOnly, + NdisPauseFunctionsReceiveOnly, + NdisPauseFunctionsSendAndReceive, + NdisPauseFunctionsUnknown +} NDIS_SUPPORTED_PAUSE_FUNCTIONS, *PNDIS_SUPPORTED_PAUSE_FUNCTIONS; + +#define NDIS_LINK_STATE_XMIT_LINK_SPEED_AUTO_NEGOTIATED 0x00000001 +#define NDIS_LINK_STATE_RCV_LINK_SPEED_AUTO_NEGOTIATED 0x00000002 +#define NDIS_LINK_STATE_DUPLEX_AUTO_NEGOTIATED 0x00000004 +#define NDIS_LINK_STATE_PAUSE_FUNCTIONS_AUTO_NEGOTIATED 0x00000008 + + + +// +// structure used in NDIS_STATUS_LINK_STATE and OID_GEN_LINK_STATE +// + +#define NDIS_LINK_STATE_REVISION_1 1 + +typedef struct _NDIS_LINK_STATE +{ + NDIS_OBJECT_HEADER Header; + NDIS_MEDIA_CONNECT_STATE MediaConnectState; + NDIS_MEDIA_DUPLEX_STATE MediaDuplexState; + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; + NDIS_SUPPORTED_PAUSE_FUNCTIONS PauseFunctions; + ULONG AutoNegotiationFlags; +} NDIS_LINK_STATE, *PNDIS_LINK_STATE; + +#define NDIS_SIZEOF_LINK_STATE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_LINK_STATE, AutoNegotiationFlags) + +// +// the following structure is used in OID_GEN_LINK_PARAMETERS +// + +#define NDIS_LINK_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_LINK_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + NDIS_MEDIA_DUPLEX_STATE MediaDuplexState; + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; + NDIS_SUPPORTED_PAUSE_FUNCTIONS PauseFunctions; + ULONG AutoNegotiationFlags; +} NDIS_LINK_PARAMETERS, *PNDIS_LINK_PARAMETERS; + +#define NDIS_SIZEOF_LINK_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_LINK_PARAMETERS, AutoNegotiationFlags) + +// +// structure used in NDIS_STATUS_LINK_STATE and OID_GEN_LINK_STATE +// + +#define NDIS_OPER_STATE_REVISION_1 1 + +typedef struct _NDIS_OPER_STATE +{ + NDIS_OBJECT_HEADER Header; + NET_IF_OPER_STATUS OperationalStatus; + ULONG OperationalStatusFlags; +} NDIS_OPER_STATE, *PNDIS_OPER_STATE; + +#define NDIS_SIZEOF_OPER_STATE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_OPER_STATE, OperationalStatusFlags) + + +// +// Structure used in OID_GEN_IP_OPER_STATUS. +// + +typedef struct _NDIS_IP_OPER_STATUS +{ + ULONG AddressFamily; + NET_IF_OPER_STATUS OperationalStatus; + ULONG OperationalStatusFlags; +} NDIS_IP_OPER_STATUS, *PNDIS_IP_OPER_STATUS; + +// +// Don't change the value for this macro definition. +// +#define MAXIMUM_IP_OPER_STATUS_ADDRESS_FAMILIES_SUPPORTED 32 + +#define NDIS_IP_OPER_STATUS_INFO_REVISION_1 1 + +typedef struct _NDIS_IP_OPER_STATUS_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG NumberofAddressFamiliesReturned; + NDIS_IP_OPER_STATUS IpOperationalStatus[MAXIMUM_IP_OPER_STATUS_ADDRESS_FAMILIES_SUPPORTED]; +} NDIS_IP_OPER_STATUS_INFO, *PNDIS_IP_OPER_STATUS_INFO; + +#define NDIS_SIZEOF_IP_OPER_STATUS_INFO_REVISION_1 \ + FIELD_OFFSET(NDIS_IP_OPER_STATUS_INFO, IpOperationalStatus) + \ + MAXIMUM_IP_OPER_STATUS_ADDRESS_FAMILIES_SUPPORTED * sizeof(NDIS_IP_OPER_STATUS) + +// +// structure used in NDIS_STATUS_IP_OPER_STATUS +// + +#define NDIS_IP_OPER_STATE_REVISION_1 1 + +typedef struct _NDIS_IP_OPER_STATE +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_IP_OPER_STATUS IpOperationalStatus; +} NDIS_IP_OPER_STATE, *PNDIS_IP_OPER_STATE; + +#define NDIS_SIZEOF_IP_OPER_STATE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_IP_OPER_STATE, IpOperationalStatus) + +// +// These defines and structures are used with +// OID_TCP_OFFLOAD_PARAMETERS +// + +#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0 + +// +// values used in IPv4Checksum, TCPIPv4Checksum, UDPIPv4Checksum +// TCPIPv6Checksum and UDPIPv6Checksum +// +#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2 +#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3 +#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4 + +// +// values used in LsoV1 +// +#define NDIS_OFFLOAD_PARAMETERS_LSOV1_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2 + +// +// values used in IPsecV1 +// +#define NDIS_OFFLOAD_PARAMETERS_IPSECV1_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV1_AH_ENABLED 2 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV1_ESP_ENABLED 3 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV1_AH_AND_ESP_ENABLED 4 + +// +// values used in LsoV2 +// +#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2 + +#if (NDIS_SUPPORT_NDIS61) +// +// values used in IPsecV2 and IPsecV2IPv4 +// +#define NDIS_OFFLOAD_PARAMETERS_IPSECV2_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV2_AH_ENABLED 2 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV2_ESP_ENABLED 3 +#define NDIS_OFFLOAD_PARAMETERS_IPSECV2_AH_AND_ESP_ENABLED 4 +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) + +#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2 + +// +// Flags used in EncapsulationTypes field of NDIS_OFFLOAD_PARAMETERS +// +#define NDIS_ENCAPSULATION_TYPE_GRE_MAC 0x00000001 + +#if (NDIS_SUPPORT_NDIS650) + +#define NDIS_ENCAPSULATION_TYPE_VXLAN 0x00000002 + +#endif // (NDIS_SUPPORT_NDIS650) + +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// values used in TcpConnectionIPv4 and TcpConnectionIPv6 fields +// of NDIS_OFFLOAD_PARAMETERS +// +#define NDIS_OFFLOAD_PARAMETERS_CONNECTION_OFFLOAD_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_CONNECTION_OFFLOAD_ENABLED 2 + +#if (NDIS_SUPPORT_NDIS683) +// +// values used in UDP segmentation offload +// +#define NDIS_OFFLOAD_PARAMETERS_USO_DISABLED 1 +#define NDIS_OFFLOAD_PARAMETERS_USO_ENABLED 2 +#endif // (NDIS_SUPPORT_NDIS683) + +// +// Used in OID_TCP_OFFLOAD_PARAMETERS for setting +// the offload parameters of a NIC +// + +#define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_OFFLOAD_PARAMETERS_REVISION_4 4 +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS683) +#define NDIS_OFFLOAD_PARAMETERS_REVISION_5 5 +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_OFFLOAD_PARAMETERS_REVISION_6 6 +#endif // (NDIS_SUPPORT_NDIS689) + +// +// Bits used in Flags parameter of NDIS_OFFLOAD_PARAMETERS structure: +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_OFFLOAD_PARAMETERS_SKIP_REGISTRY_UPDATE 0x00000001 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_OFFLOAD_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + + UCHAR IPv4Checksum; + UCHAR TCPIPv4Checksum; + UCHAR UDPIPv4Checksum; + + UCHAR TCPIPv6Checksum; + UCHAR UDPIPv6Checksum; + + UCHAR LsoV1; + UCHAR IPsecV1; + + UCHAR LsoV2IPv4; + UCHAR LsoV2IPv6; + + UCHAR TcpConnectionIPv4; + UCHAR TcpConnectionIPv6; + + ULONG Flags; + +#if (NDIS_SUPPORT_NDIS61) + UCHAR IPsecV2; + UCHAR IPsecV2IPv4; +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) + struct + { + UCHAR RscIPv4; + UCHAR RscIPv6; + }; + struct + { + UCHAR EncapsulatedPacketTaskOffload; + UCHAR EncapsulationTypes; + }; +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) + union _ENCAPSULATION_PROTOCOL_PARAMETERS { + struct _VXLAN_PARAMETERS { + USHORT VxlanUDPPortNumber; + } VxlanParameters; + + ULONG Value; + + } EncapsulationProtocolParameters; + +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS683) + struct + { + UCHAR IPv4; + UCHAR IPv6; + } UdpSegmentation; +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) + struct + { + UCHAR Enabled; + } UdpRsc; +#endif // (NDIS_SUPPORT_NDIS689) +} NDIS_OFFLOAD_PARAMETERS, *PNDIS_OFFLOAD_PARAMETERS; + +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_1 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, Flags) + +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_2 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, IPsecV2IPv4) +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_3 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, EncapsulationTypes) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_4 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, EncapsulationProtocolParameters) +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS683) +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_5 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, UdpSegmentation) +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_SIZEOF_OFFLOAD_PARAMETERS_REVISION_6 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD_PARAMETERS, UdpRsc) +#endif // (NDIS_SUPPORT_NDIS689) + +#include +#include + +#pragma warning(push) +#pragma warning(disable:4214) //nonstandard extension used : bit field types other than int + +// +// Describes the large send offload version 1 capabilities +// or configuration of the NIC. Used in NDIS_OFFLOAD structure +// +typedef struct _NDIS_TCP_LARGE_SEND_OFFLOAD_V1 +{ + + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + ULONG TcpOptions:2; + ULONG IpOptions:2; + } IPv4; + +} NDIS_TCP_LARGE_SEND_OFFLOAD_V1, *PNDIS_TCP_LARGE_SEND_OFFLOAD_V1; + + +// +// Describes the checksum task offload capabilities or configuration +// of the NIC. used in NDIS_OFFLOAD structure +// +typedef struct _NDIS_TCP_IP_CHECKSUM_OFFLOAD +{ + + struct + { + ULONG Encapsulation; + ULONG IpOptionsSupported:2; + ULONG TcpOptionsSupported:2; + ULONG TcpChecksum:2; + ULONG UdpChecksum:2; + ULONG IpChecksum:2; + } IPv4Transmit; + + struct + { + ULONG Encapsulation; + ULONG IpOptionsSupported:2; + ULONG TcpOptionsSupported:2; + ULONG TcpChecksum:2; + ULONG UdpChecksum:2; + ULONG IpChecksum:2; + } IPv4Receive; + + + struct + { + ULONG Encapsulation; + ULONG IpExtensionHeadersSupported:2; + ULONG TcpOptionsSupported:2; + ULONG TcpChecksum:2; + ULONG UdpChecksum:2; + + } IPv6Transmit; + + struct + { + ULONG Encapsulation; + ULONG IpExtensionHeadersSupported:2; + ULONG TcpOptionsSupported:2; + ULONG TcpChecksum:2; + ULONG UdpChecksum:2; + + } IPv6Receive; + +} NDIS_TCP_IP_CHECKSUM_OFFLOAD, *PNDIS_TCP_IP_CHECKSUM_OFFLOAD; + + +// +// Describes the IPsec task offload version 1 capabilities +// or configuration of the NIC. Used in NDIS_OFFLOAD structure +// +typedef struct _NDIS_IPSEC_OFFLOAD_V1 +{ + struct + { + ULONG Encapsulation; + ULONG AhEspCombined; + ULONG TransportTunnelCombined; + ULONG IPv4Options; + ULONG Flags; + } Supported; + + struct + { + ULONG Md5:2; + ULONG Sha_1:2; + ULONG Transport:2; + ULONG Tunnel:2; + ULONG Send:2; + ULONG Receive:2; + } IPv4AH; + + struct + { + ULONG Des:2; + ULONG Reserved:2; + ULONG TripleDes:2; + ULONG NullEsp:2; + ULONG Transport:2; + ULONG Tunnel:2; + ULONG Send:2; + ULONG Receive:2; + } IPv4ESP; + +} NDIS_IPSEC_OFFLOAD_V1, *PNDIS_IPSEC_OFFLOAD_V1; + +// +// Describes the large send offload version 2 capabilities +// or configuration of the NIC. Used in NDIS_OFFLOAD structure +// +typedef struct _NDIS_TCP_LARGE_SEND_OFFLOAD_V2 +{ + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + }IPv4; + + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + ULONG IpExtensionHeadersSupported:2; + ULONG TcpOptionsSupported:2; + }IPv6; + +} NDIS_TCP_LARGE_SEND_OFFLOAD_V2, *PNDIS_TCP_LARGE_SEND_OFFLOAD_V2; + +#if (NDIS_SUPPORT_NDIS61) +// +// Structures for IPSec Task Offload V2. +// + +// +// IPsec Algorithms for Authentication used in AuthenticationAlgorithms field +// of NDIS_IPSEC_OFFLOAD_V2 structure +// +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_MD5 0x00000001 +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_SHA_1 0x00000002 +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_SHA_256 0x00000004 +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_AES_GCM_128 0x00000008 +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_AES_GCM_192 0x00000010 +#define IPSEC_OFFLOAD_V2_AUTHENTICATION_AES_GCM_256 0x00000020 + +// +// IPsec Algorithms for Encryption used in EncryptionAlgorithms field of +// NDIS_IPSEC_OFFLOAD_V2 structure +// +#define IPSEC_OFFLOAD_V2_ENCRYPTION_NONE 0x00000001 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_DES_CBC 0x00000002 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_3_DES_CBC 0x00000004 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_GCM_128 0x00000008 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_GCM_192 0x00000010 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_GCM_256 0x00000020 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_CBC_128 0x00000040 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_CBC_192 0x00000080 +#define IPSEC_OFFLOAD_V2_ENCRYPTION_AES_CBC_256 0x00000100 + +// +// IPsec offload V2 capabilities used in NDIS_OFFLOAD +// +typedef struct _NDIS_IPSEC_OFFLOAD_V2 +{ + ULONG Encapsulation; // MAC encap types supported + BOOLEAN IPv6Supported; // IPv6 Supported + BOOLEAN IPv4Options; // Supports offload of packets with IPv4 options + BOOLEAN IPv6NonIPsecExtensionHeaders; // Supports offload of packets with non IPsec Extension headers + BOOLEAN Ah; + BOOLEAN Esp; + BOOLEAN AhEspCombined; + BOOLEAN Transport; + BOOLEAN Tunnel; + BOOLEAN TransportTunnelCombined; + BOOLEAN LsoSupported; + BOOLEAN ExtendedSequenceNumbers; + ULONG UdpEsp; + ULONG AuthenticationAlgorithms; // Bit Mask of Authentication Algorithms + ULONG EncryptionAlgorithms; // Bit Mask of Encryption Algorithms + ULONG SaOffloadCapacity; // Number of SAs that can be offloaded +} NDIS_IPSEC_OFFLOAD_V2, *PNDIS_IPSEC_OFFLOAD_V2; + +#endif // (NDIS_SUPPORT_NDIS61) + +#pragma warning(pop) + + +#if (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_TCP_RECV_SEG_COALESCE_OFFLOAD +{ + struct + { + BOOLEAN Enabled; + } IPv4; + struct + { + BOOLEAN Enabled; + } IPv6; +} NDIS_TCP_RECV_SEG_COALESCE_OFFLOAD, *PNDIS_TCP_RECV_SEG_COALESCE_OFFLOAD; + +#define NDIS_TCP_RECV_SEG_COALESC_OFFLOAD_REVISION_1 1 + +#define NDIS_SIZEOF_TCP_RECV_SEG_COALESC_OFFLOAD_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_TCP_RECV_SEG_COALESCE_OFFLOAD, IPv6.Enabled) + +#define NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_NOT_SUPPORTED 0x00000000 +#define NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_INNER_IPV4 0x00000001 +#define NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_OUTER_IPV4 0x00000002 +#define NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_INNER_IPV6 0x00000004 +#define NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_OUTER_IPV6 0x00000008 + +#pragma warning(push) +#pragma warning(disable:4214) //nonstandard extension used : bit field types other than int + +typedef struct _NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD { + ULONG TransmitChecksumOffloadSupported:4; + ULONG ReceiveChecksumOffloadSupported:4; + ULONG LsoV2Supported:4; + ULONG RssSupported:4; + ULONG VmqSupported:4; +#if (NDIS_SUPPORT_NDIS685) + ULONG UsoSupported:4; + ULONG Reserved:8; +#endif // (NDIS_SUPPORT_NDIS685) + ULONG MaxHeaderSizeSupported; +} NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD, *PNDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD; + +#pragma warning(pop) + +#define NDIS_SIZEOF_ENCAPSULATED_PACKET_TASK_OFFLOAD_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD( \ + NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD, MaxHeaderSizeSupported) + +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) + +typedef struct _NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_V2 { + ULONG TransmitChecksumOffloadSupported:4; + ULONG ReceiveChecksumOffloadSupported:4; + ULONG LsoV2Supported:4; + ULONG RssSupported:4; + ULONG VmqSupported:4; +#if (NDIS_SUPPORT_NDIS685) + ULONG UsoSupported:4; + ULONG Reserved:8; +#else + ULONG Reserved:12; +#endif // (NDIS_SUPPORT_NDIS685) + ULONG MaxHeaderSizeSupported; + + union _ENCAPSULATION_PROTOCOL_INFO { + struct _VXLAN_INFO { + USHORT VxlanUDPPortNumber; + USHORT VxlanUDPPortNumberConfigurable :1; + } VxlanInfo; + + ULONG Value; + + } EncapsulationProtocolInfo; + + ULONG Reserved1; + ULONG Reserved2; +} NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_V2, *PNDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_V2; + +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS670) + +typedef enum _NDIS_RFC6877_464XLAT_OFFLOAD_OPTIONS +{ + NDIS_RFC6877_464XLAT_OFFLOAD_NOT_SUPPORTED = 0, // incapable of 464XLAT hardware offload + NDIS_RFC6877_464XLAT_OFFLOAD_DISABLED, // capable but disabled + NDIS_RFC6877_464XLAT_OFFLOAD_ENABLED, // capable and enabled all time + NDIS_RFC6877_464XLAT_OFFLOAD_ON_DEMAND, // capable and enabled only on-demand +} NDIS_RFC6877_464XLAT_OFFLOAD_OPTIONS; + +typedef struct _NDIS_RFC6877_464XLAT_OFFLOAD +{ + NDIS_RFC6877_464XLAT_OFFLOAD_OPTIONS XlatOffload; + ULONG Flags; // Reserved, always 0 +} NDIS_RFC6877_464XLAT_OFFLOAD, *PNDIS_RFC6877_464XLAT_OFFLOAD; + +#endif // (NDIS_SUPPORT_NDIS670) + +#if (NDIS_SUPPORT_NDIS683) + +typedef struct _NDIS_UDP_SEGMENTATION_OFFLOAD +{ + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount : 6; +#if (NDIS_SUPPORT_NDIS684) + ULONG SubMssFinalSegmentSupported : 1; + ULONG Reserved : 25; +#else + ULONG Reserved : 26; +#endif // (NDIS_SUPPORT_NDIS684) + } IPv4; + + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount : 6; +#if (NDIS_SUPPORT_NDIS684) + ULONG SubMssFinalSegmentSupported : 1; + ULONG Reserved1 : 25; +#else + ULONG Reserved1 : 26; +#endif // (NDIS_SUPPORT_NDIS684) + ULONG IpExtensionHeadersSupported : 2; + ULONG Reserved2 : 30; + } IPv6; +} NDIS_UDP_SEGMENTATION_OFFLOAD, *PNDIS_UDP_SEGMENTATION_OFFLOAD; + +#endif // (NDIS_SUPPORT_NDIS683) + +// +// flags used in Flags field of NDIS_OFFLOAD structure +// +#define NDIS_OFFLOAD_FLAGS_GROUP_CHECKSUM_CAPABILITIES 0x00000001 + +#if (NDIS_SUPPORT_NDIS630) +#define IPSEC_OFFLOAD_V2_AND_TCP_CHECKSUM_COEXISTENCE 0x00000002 +#define IPSEC_OFFLOAD_V2_AND_UDP_CHECKSUM_COEXISTENCE 0x00000004 +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Describes TCP/IP task offload capabilities or configuration +// of the NIC. Used in OID_TCP_OFFLOAD_CURRENT_CONFIG +// and OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES +// +#define NDIS_OFFLOAD_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_OFFLOAD_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_OFFLOAD_REVISION_3 3 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_OFFLOAD_REVISION_4 4 +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS670) +#define NDIS_OFFLOAD_REVISION_5 5 +#endif // (NDIS_SUPPORT_NDIS670) + +#if (NDIS_SUPPORT_NDIS683) +#define NDIS_OFFLOAD_REVISION_6 6 +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS685) +#define NDIS_OFFLOAD_REVISION_7 7 +#endif // (NDIS_SUPPORT_NDIS685) + +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_OFFLOAD_REVISION_8 8 +#endif // (NDIS_SUPPORT_NDIS689) + +typedef struct _NDIS_OFFLOAD +{ + NDIS_OBJECT_HEADER Header; + + // + // Checksum Offload information + // + NDIS_TCP_IP_CHECKSUM_OFFLOAD Checksum; + + // + // Large Send Offload information + // + NDIS_TCP_LARGE_SEND_OFFLOAD_V1 LsoV1; + + // + // IPsec Offload Information + // + NDIS_IPSEC_OFFLOAD_V1 IPsecV1; + + // + // Large Send Offload version 2Information + // + NDIS_TCP_LARGE_SEND_OFFLOAD_V2 LsoV2; + + ULONG Flags; + +#if (NDIS_SUPPORT_NDIS61) + // + //IPsec offload V2 + // + NDIS_IPSEC_OFFLOAD_V2 IPsecV2; +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) + // + // Receive Segment Coalescing information + // + NDIS_TCP_RECV_SEG_COALESCE_OFFLOAD Rsc; + + // + // NVGRE Encapsulated packet task offload information + // + NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD EncapsulatedPacketTaskOffloadGre; +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) + // + // VXLAN Encapsulated packet task offload information + // + NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD_V2 EncapsulatedPacketTaskOffloadVxlan; + + // + // Enabled encapsulation types for Encapsulated packet task offload + // + UCHAR EncapsulationTypes; +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS670) + // + // 464XLAT hardward offload information. + // + NDIS_RFC6877_464XLAT_OFFLOAD Rfc6877Xlat; + +#endif // (NDIS_SUPPORT_NDIS670) + +#if (NDIS_SUPPORT_NDIS683) + // + // UDP segmentation offload. + // + NDIS_UDP_SEGMENTATION_OFFLOAD UdpSegmentation; +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) + // + // UDP RSC offload. + // + NDIS_UDP_RSC_OFFLOAD UdpRsc; +#endif // (NDIS_SUPPORT_NDIS689) + +} NDIS_OFFLOAD, *PNDIS_OFFLOAD; + +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_1 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, Flags) + +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_2 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, IPsecV2) +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_3 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, EncapsulatedPacketTaskOffloadGre) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_4 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, EncapsulationTypes) +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS670) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_5 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, Rfc6877Xlat) +#endif // (NDIS_SUPPORT_NDIS670) + +#if (NDIS_SUPPORT_NDIS683) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_6 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, UdpSegmentation) +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS685) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_7 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, UdpSegmentation) +#endif // (NDIS_SUPPORT_NDIS685) + +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_SIZEOF_NDIS_OFFLOAD_REVISION_8 RTL_SIZEOF_THROUGH_FIELD(NDIS_OFFLOAD, UdpRsc) +#endif // (NDIS_SUPPORT_NDIS689) + +// +// The following data structures are used with offload related WMI +// guids. NDIS will trnaslate these data structures to those used +// in OID and status indications +// +typedef struct _NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V1 +{ + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + ULONG TcpOptions; + ULONG IpOptions; + } IPv4; + +} NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V1, *PNDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V1; + +typedef struct _NDIS_WMI_TCP_IP_CHECKSUM_OFFLOAD +{ + + struct + { + ULONG Encapsulation; + ULONG IpOptionsSupported; + ULONG TcpOptionsSupported; + ULONG TcpChecksum; + ULONG UdpChecksum; + ULONG IpChecksum; + } IPv4Transmit; + + struct + { + ULONG Encapsulation; + ULONG IpOptionsSupported; + ULONG TcpOptionsSupported; + ULONG TcpChecksum; + ULONG UdpChecksum; + ULONG IpChecksum; + } IPv4Receive; + + + struct + { + ULONG Encapsulation; + ULONG IpExtensionHeadersSupported; + ULONG TcpOptionsSupported; + ULONG TcpChecksum; + ULONG UdpChecksum; + + } IPv6Transmit; + + struct + { + ULONG Encapsulation; + ULONG IpExtensionHeadersSupported; + ULONG TcpOptionsSupported; + ULONG TcpChecksum; + ULONG UdpChecksum; + + } IPv6Receive; + +} NDIS_WMI_TCP_IP_CHECKSUM_OFFLOAD, *PNDIS_WMI_TCP_IP_CHECKSUM_OFFLOAD; + +typedef struct _NDIS_WMI_IPSEC_OFFLOAD_V1 +{ + struct + { + ULONG Encapsulation; + ULONG AhEspCombined; + ULONG TransportTunnelCombined; + ULONG IPv4Options; + ULONG Flags; + } Supported; + + struct + { + ULONG Md5; + ULONG Sha_1; + ULONG Transport; + ULONG Tunnel; + ULONG Send; + ULONG Receive; + } IPv4AH; + + struct + { + ULONG Des; + ULONG Reserved; + ULONG TripleDes; + ULONG NullEsp; + ULONG Transport; + ULONG Tunnel; + ULONG Send; + ULONG Receive; + } IPv4ESP; + +} NDIS_WMI_IPSEC_OFFLOAD_V1, *PNDIS_WMI_IPSEC_OFFLOAD_V1; + +typedef struct _NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V2 +{ + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + }IPv4; + + struct + { + ULONG Encapsulation; + ULONG MaxOffLoadSize; + ULONG MinSegmentCount; + ULONG IpExtensionHeadersSupported; + ULONG TcpOptionsSupported; + }IPv6; + +} NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V2, *PNDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V2; + + +typedef struct _NDIS_WMI_OFFLOAD +{ + // + // Header.Type = NDIS_OBJECT_TYPE_OFFLOAD; + // Header.Size = sizeof(NDIS_OFFLOAD); + // Header.Revision = NDIS_OFFLOAD_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + + // + // Checksum Offload information + // + NDIS_WMI_TCP_IP_CHECKSUM_OFFLOAD Checksum; + + // + // Large Send Offload information + // + NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V1 LsoV1; + + // + // IPsec Offload Information + // + NDIS_WMI_IPSEC_OFFLOAD_V1 IPsecV1; + // + // Large Send Offload version 2 Information + // + NDIS_WMI_TCP_LARGE_SEND_OFFLOAD_V2 LsoV2; + + ULONG Flags; + +#if (NDIS_SUPPORT_NDIS61) + // + // IPsec offload version 2 information + // + NDIS_IPSEC_OFFLOAD_V2 IPsecV2; +#endif // (NDIS_SUPPORT_NDIS61) + + +#if (NDIS_SUPPORT_NDIS630) + // + // Recieve Segment Coalescing information + // + NDIS_TCP_RECV_SEG_COALESCE_OFFLOAD Rsc; + + // + // GRE Encapsulated packet task offload information + // + NDIS_ENCAPSULATED_PACKET_TASK_OFFLOAD EncapsulatedPacketTaskOffloadGre; +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS683) + // + // UDP segmentation offload. + // + NDIS_UDP_SEGMENTATION_OFFLOAD UdpSegmentation; +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) + // + // UDP RSC offload. + // + NDIS_UDP_RSC_OFFLOAD UdpRsc; +#endif // (NDIS_SUPPORT_NDIS689) + +} NDIS_WMI_OFFLOAD, *PNDIS_WMI_OFFLOAD; + +#define NDIS_SIZEOF_NDIS_WMI_OFFLOAD_REVISION_1 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OFFLOAD, Flags) + +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_SIZEOF_NDIS_WMI_OFFLOAD_REVISION_2 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OFFLOAD, IPsecV2) +#endif // (NDIS_SUPPORT_NDIS61) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NDIS_WMI_OFFLOAD_REVISION_3 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OFFLOAD, EncapsulatedPacketTaskOffloadGre) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS683) +#define NDIS_SIZEOF_NDIS_WMI_OFFLOAD_REVISION_4 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OFFLOAD, UdpSegmentation) +#endif // (NDIS_SUPPORT_NDIS683) + +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_SIZEOF_NDIS_WMI_OFFLOAD_REVISION_5 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OFFLOAD, UdpRsc) +#endif // (NDIS_SUPPORT_NDIS689) + + +#pragma warning(push) +#pragma warning(disable:4214) //nonstandard extension used : bit field types other than int + +// +// Describes TCP connection offload capabilities or configuration +// of the NIC. Used in OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG, +// OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES and +// NDIS_STATUS_OFFLOAD_RESUME +// +#define NDIS_TCP_CONNECTION_OFFLOAD_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_TCP_CONNECTION_OFFLOAD_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS61) + +typedef struct _NDIS_TCP_CONNECTION_OFFLOAD +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_TCP_CONNECTION_OFFLOAD_REVISION_1; + // Header.Size = sizeof(NDIS_TCP_CONNECTION_OFFLOAD); + // + NDIS_OBJECT_HEADER Header; + ULONG Encapsulation; + ULONG SupportIPv4:2; + ULONG SupportIPv6:2; + ULONG SupportIPv6ExtensionHeaders:2; + ULONG SupportSack:2; +#if (NDIS_SUPPORT_NDIS61) + ULONG CongestionAlgorithm:4; +#endif // (NDIS_SUPPORT_NDIS61) + ULONG TcpConnectionOffloadCapacity; + ULONG Flags; +} NDIS_TCP_CONNECTION_OFFLOAD, *PNDIS_TCP_CONNECTION_OFFLOAD; + +#define NDIS_SIZEOF_TCP_CONNECTION_OFFLOAD_REVISION_1 RTL_SIZEOF_THROUGH_FIELD(NDIS_TCP_CONNECTION_OFFLOAD, Flags) +#if (NDIS_SUPPORT_NDIS61) +#define NDIS_SIZEOF_TCP_CONNECTION_OFFLOAD_REVISION_2 RTL_SIZEOF_THROUGH_FIELD(NDIS_TCP_CONNECTION_OFFLOAD, Flags) +#endif // (NDIS_SUPPORT_NDIS61) + +#pragma warning(pop) + +typedef struct _NDIS_WMI_TCP_CONNECTION_OFFLOAD +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_TCP_CONNECTION_OFFLOAD_REVISION_1; + // Header.Size = sizeof(NDIS_TCP_CONNECTION_OFFLOAD); + // + NDIS_OBJECT_HEADER Header; + ULONG Encapsulation; + ULONG SupportIPv4; + ULONG SupportIPv6; + ULONG SupportIPv6ExtensionHeaders; + ULONG SupportSack; + ULONG TcpConnectionOffloadCapacity; + ULONG Flags; +} NDIS_WMI_TCP_CONNECTION_OFFLOAD, *PNDIS_WMI_TCP_CONNECTION_OFFLOAD; + +#define NDIS_SIZEOF_WMI_TCP_CONNECTION_OFFLOAD_REVISION_1 RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_TCP_CONNECTION_OFFLOAD, Flags) + +#include + +// +// NDIS_PORT_AUTHENTICATION_STATE defines the authentication state of a port +// on a particular data path +// +typedef enum _NDIS_PORT_AUTHORIZATION_STATE +{ + NdisPortAuthorizationUnknown, + NdisPortAuthorized, + NdisPortUnauthorized, + NdisPortReauthorizing +} NDIS_PORT_AUTHORIZATION_STATE, *PNDIS_PORT_AUTHORIZATION_STATE; + + +// +// NDIS_PORT_CONTROL_STATE specifies if a port is "controlled" +// i.e. if it needs authentication, on a particular data path +// + +typedef enum _NDIS_PORT_CONTROL_STATE +{ + NdisPortControlStateUnknown, + NdisPortControlStateControlled, + NdisPortControlStateUncontrolled +} NDIS_PORT_CONTROL_STATE, *PNDIS_PORT_CONTROL_STATE; + +#ifdef NDIS_INCLUDE_LEGACY_NAMES +// Legacy spelling errors +typedef NDIS_PORT_CONTROL_STATE NDIS_PORT_CONTROLL_STATE; +typedef PNDIS_PORT_CONTROL_STATE PNDIS_PORT_CONTROLL_STATE; +#endif // NDIS_INCLUDE_LEGACY_NAMES + +// +// NDIS_PORT_PARAMETERS is used in OID_GEN_PORT_PARAMETERS set OID +// +#define NDIS_PORT_AUTHENTICATION_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_PORT_AUTHENTICATION_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + NDIS_PORT_CONTROL_STATE SendControlState; + NDIS_PORT_CONTROL_STATE RcvControlState; + NDIS_PORT_AUTHORIZATION_STATE SendAuthorizationState; + NDIS_PORT_AUTHORIZATION_STATE RcvAuthorizationState; +}NDIS_PORT_AUTHENTICATION_PARAMETERS, *PNDIS_PORT_AUTHENTICATION_PARAMETERS; + +#define NDIS_SIZEOF_PORT_AUTHENTICATION_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PORT_AUTHENTICATION_PARAMETERS, RcvAuthorizationState) + +typedef enum _NDIS_NETWORK_CHANGE_TYPE +{ + NdisPossibleNetworkChange = 1, + NdisDefinitelyNetworkChange, + NdisNetworkChangeFromMediaConnect, + NdisNetworkChangeMax +} NDIS_NETWORK_CHANGE_TYPE, *PNDIS_NETWORK_CHANGE_TYPE; + + +#define NDIS_WMI_DEFAULT_METHOD_ID 1 + +#define NDIS_WMI_OBJECT_TYPE_SET 0x01 +#define NDIS_WMI_OBJECT_TYPE_METHOD 0x02 +#define NDIS_WMI_OBJECT_TYPE_EVENT 0x03 +#define NDIS_WMI_OBJECT_TYPE_ENUM_ADAPTER 0x04 +#define NDIS_WMI_OBJECT_TYPE_OUTPUT_INFO 0x05 + +#define NDIS_WMI_METHOD_HEADER_REVISION_1 1 + +typedef struct _NDIS_WMI_METHOD_HEADER +{ + NDIS_OBJECT_HEADER Header; + NDIS_PORT_NUMBER PortNumber; + NET_LUID NetLuid; + ULONG64 RequestId; + ULONG Timeout; + UCHAR Padding[4]; +} NDIS_WMI_METHOD_HEADER, *PNDIS_WMI_METHOD_HEADER; + +#define NDIS_SIZEOF_WMI_METHOD_HEADER_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_METHOD_HEADER, Padding) + +#define NDIS_WMI_SET_HEADER_REVISION_1 1 + +typedef struct _NDIS_WMI_SET_HEADER +{ + NDIS_OBJECT_HEADER Header; + NDIS_PORT_NUMBER PortNumber; + NET_LUID NetLuid; + ULONG64 RequestId; + ULONG Timeout; + UCHAR Padding[4]; +} NDIS_WMI_SET_HEADER, *PNDIS_WMI_SET_HEADER; + +#define NDIS_SIZEOF_WMI_SET_HEADER_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_SET_HEADER, Padding) + +#define NDIS_WMI_EVENT_HEADER_REVISION_1 1 + +typedef struct _NDIS_WMI_EVENT_HEADER +{ + NDIS_OBJECT_HEADER Header; + NET_IFINDEX IfIndex; + NET_LUID NetLuid; + ULONG64 RequestId; + NDIS_PORT_NUMBER PortNumber; + ULONG DeviceNameLength; + ULONG DeviceNameOffset; + UCHAR Padding[4]; +} NDIS_WMI_EVENT_HEADER, *PNDIS_WMI_EVENT_HEADER; + +#define NDIS_SIZEOF_WMI_EVENT_HEADER_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_EVENT_HEADER, Padding) + +#define NDIS_WMI_ENUM_ADAPTER_REVISION_1 1 + +typedef struct _NDIS_WMI_ENUM_ADAPTER +{ + NDIS_OBJECT_HEADER Header; + NET_IFINDEX IfIndex; + NET_LUID NetLuid; + USHORT DeviceNameLength; + CHAR DeviceName[1]; +}NDIS_WMI_ENUM_ADAPTER, *PNDIS_WMI_ENUM_ADAPTER; + +#define NDIS_SIZEOF_WMI_ENUM_ADAPTER_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_ENUM_ADAPTER, DeviceName) + +// +// Flags used in standardized keyword *NdisDeviceType +// +#define NDIS_DEVICE_TYPE_ENDPOINT 0x00000001 + + +#if (NDIS_SUPPORT_NDIS61) + +// +// Structure and defines for +// OID_GEN_HD_SPLIT_PARAMETERS +// +#define NDIS_HD_SPLIT_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_HD_SPLIT_PARAMETERS +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_HD_SPLIT_PARAMETERS_REVISION_1; + // Header.Size = sizeof(NDIS_HD_SPLIT_PARAMETERS); + // + NDIS_OBJECT_HEADER Header; + ULONG HDSplitCombineFlags; +}NDIS_HD_SPLIT_PARAMETERS, *PNDIS_HD_SPLIT_PARAMETERS; + +#define NDIS_SIZEOF_HD_SPLIT_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_HD_SPLIT_PARAMETERS, HDSplitCombineFlags) + +// +// Flags used in NDIS_HD_SPLIT_PARAMETERS->HDSplitCombineFlags +// and NDIS_HD_SPLIT_CURRENT_CONFIG->HDSplitCombineFlags +// +#define NDIS_HD_SPLIT_COMBINE_ALL_HEADERS 0x00000001 + +// +// Structure and defines for +// OID_GEN_HD_SPLIT_CURRENT_CONFIG +// +#define NDIS_HD_SPLIT_CURRENT_CONFIG_REVISION_1 1 + +typedef struct _NDIS_HD_SPLIT_CURRENT_CONFIG +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_HD_SPLIT_CURRENT_CONFIG_REVISION_1; + // Header.Size = sizeof(NDIS_HD_SPLIT_CURRENT_CONFIG); + // + NDIS_OBJECT_HEADER Header; + ULONG HardwareCapabilities; + ULONG CurrentCapabilities; + ULONG HDSplitFlags; + ULONG HDSplitCombineFlags; + ULONG BackfillSize; + ULONG MaxHeaderSize; +} NDIS_HD_SPLIT_CURRENT_CONFIG, *PNDIS_HD_SPLIT_CURRENT_CONFIG; + +#define NDIS_SIZEOF_HD_SPLIT_CURRENT_CONFIG_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_HD_SPLIT_CURRENT_CONFIG, MaxHeaderSize) + +// +// Flags used in NDIS_HD_SPLIT_ATTRIBUTES->HardwareCapabilities +// and NDIS_HD_SPLIT_ATTRIBUTES->CurrentCapabilities. They are also +// used in NDIS_HD_SPLIT_CURRENT_CONFIG->HardwareCapabilities +// and NDIS_HD_SPLIT_CURRENT_CONFIG->CurrentCapabilities. +// +#define NDIS_HD_SPLIT_CAPS_SUPPORTS_HEADER_DATA_SPLIT 0x00000001 +#define NDIS_HD_SPLIT_CAPS_SUPPORTS_IPV4_OPTIONS 0x00000002 +#define NDIS_HD_SPLIT_CAPS_SUPPORTS_IPV6_EXTENSION_HEADERS 0x00000004 +#define NDIS_HD_SPLIT_CAPS_SUPPORTS_TCP_OPTIONS 0x00000008 + +// +// Flags used in NDIS_HD_SPLIT_ATTRIBUTES->HDSplitFlags and +// NDIS_HD_SPLIT_CURRENT_CONFIG->HDSplitFlags +// +#define NDIS_HD_SPLIT_ENABLE_HEADER_DATA_SPLIT 0x00000001 + +#endif // (NDIS_SUPPORT_NDIS61) + +#define NDIS_WMI_OUTPUT_INFO_REVISION_1 1; + +typedef struct NDIS_WMI_OUTPUT_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + UCHAR SupportedRevision; + ULONG DataOffset; + +} NDIS_WMI_OUTPUT_INFO, *PNDIS_WMI_OUTPUT_INFO; + +#define NDIS_SIZEOF_WMI_OUTPUT_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_OUTPUT_INFO, DataOffset) + + +#if (NDIS_SUPPORT_NDIS620) + +// +// NDIS 6.20 power management +// + +// +// Flags used in NDIS_PM_CAPABILITIES struct +// +// Flags for NDIS_PM_CAPABILITIES.SupportedWoLPacketPatterns field +// +#define NDIS_PM_WOL_BITMAP_PATTERN_SUPPORTED 0x00000001 +#define NDIS_PM_WOL_MAGIC_PACKET_SUPPORTED 0x00000002 +#define NDIS_PM_WOL_IPV4_TCP_SYN_SUPPORTED 0x00000004 +#define NDIS_PM_WOL_IPV6_TCP_SYN_SUPPORTED 0x00000008 +#define NDIS_PM_WOL_IPV4_DEST_ADDR_WILDCARD_SUPPORTED 0x00000200 +#define NDIS_PM_WOL_IPV6_DEST_ADDR_WILDCARD_SUPPORTED 0x00000800 +#define NDIS_PM_WOL_EAPOL_REQUEST_ID_MESSAGE_SUPPORTED 0x00010000 + +// +// Flags for NDIS_PM_CAPABILITIES.SupportedProtocolOffloads field +// +#define NDIS_PM_PROTOCOL_OFFLOAD_ARP_SUPPORTED 0x00000001 +#define NDIS_PM_PROTOCOL_OFFLOAD_NS_SUPPORTED 0x00000002 +#define NDIS_PM_PROTOCOL_OFFLOAD_80211_RSN_REKEY_SUPPORTED 0x00000080 + +// +// Flags for NDIS_PM_CAPABILITIES.SupportedWakeUpEvents field +// to advertise media-agnostic wake capabilities +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_WAKE_ON_MEDIA_CONNECT_SUPPORTED 0x00000001 +#define NDIS_PM_WAKE_ON_MEDIA_DISCONNECT_SUPPORTED 0x00000002 +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Flags for NDIS_PM_CAPABILITIES.MediaSpecificWakeUpEvents field +// to advertise media-specific wake capabilities for an adapter +// with physical media type NdisPhysicalMediumNative802_11 +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_WLAN_WAKE_ON_NLO_DISCOVERY_SUPPORTED 0x00000001 +#define NDIS_WLAN_WAKE_ON_AP_ASSOCIATION_LOST_SUPPORTED 0x00000002 +#define NDIS_WLAN_WAKE_ON_GTK_HANDSHAKE_ERROR_SUPPORTED 0x00000004 +#define NDIS_WLAN_WAKE_ON_4WAY_HANDSHAKE_REQUEST_SUPPORTED 0x00000008 +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS688) +#define NDIS_WLAN_WAKE_ON_INCOMING_ACTION_FRAME_SUPPORTED 0x00000010 +#endif // (NDIS_SUPPORT_NDIS688) +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_WLAN_WAKE_ON_CLIENT_DRIVER_DIAGNOSTIC_SUPPORTED 0x00000020 +#endif // (NDIS_SUPPORT_NDIS689) + +// +// Flags for NDIS_PM_CAPABILITIES.MediaSpecificWakeUpEvents field +// to advertise media-specific wake capabilities for an adapter +// with physical media type NdisPhysicalMediumWirelessWan +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_WWAN_WAKE_ON_REGISTER_STATE_SUPPORTED 0x00000001 +#define NDIS_WWAN_WAKE_ON_SMS_RECEIVE_SUPPORTED 0x00000002 +#define NDIS_WWAN_WAKE_ON_USSD_RECEIVE_SUPPORTED 0x00000004 +#define NDIS_WWAN_WAKE_ON_PACKET_STATE_SUPPORTED 0x00000008 +#define NDIS_WWAN_WAKE_ON_UICC_CHANGE_SUPPORTED 0x00000010 +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Flags for NDIS_PM_CAPABILITIES.Flags +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_WAKE_PACKET_INDICATION_SUPPORTED 0x00000001 +#define NDIS_PM_SELECTIVE_SUSPEND_SUPPORTED 0x00000002 +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// Flags used in NDIS_PM_PARAMETERS struct +// +// Flags for NDIS_PM_PARAMETERS.EnabledWoLPacketPatterns field +// +#define NDIS_PM_WOL_BITMAP_PATTERN_ENABLED 0x00000001 +#define NDIS_PM_WOL_MAGIC_PACKET_ENABLED 0x00000002 +#define NDIS_PM_WOL_IPV4_TCP_SYN_ENABLED 0x00000004 +#define NDIS_PM_WOL_IPV6_TCP_SYN_ENABLED 0x00000008 +#define NDIS_PM_WOL_IPV4_DEST_ADDR_WILDCARD_ENABLED 0x00000200 +#define NDIS_PM_WOL_IPV6_DEST_ADDR_WILDCARD_ENABLED 0x00000800 +#define NDIS_PM_WOL_EAPOL_REQUEST_ID_MESSAGE_ENABLED 0x00010000 + +// +// Flags for NDIS_PM_PARAMETERS.EnabledProtocolOffloads field +// +#define NDIS_PM_PROTOCOL_OFFLOAD_ARP_ENABLED 0x00000001 +#define NDIS_PM_PROTOCOL_OFFLOAD_NS_ENABLED 0x00000002 +#define NDIS_PM_PROTOCOL_OFFLOAD_80211_RSN_REKEY_ENABLED 0x00000080 + +// +// Flags for NDIS_PM_PARAMETERS.WakeUpFlags field +// +#define NDIS_PM_WAKE_ON_LINK_CHANGE_ENABLED 0x00000001 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_WAKE_ON_MEDIA_DISCONNECT_ENABLED 0x00000002 +#define NDIS_PM_SELECTIVE_SUSPEND_ENABLED 0x00000010 +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// Flags for NDIS_PM_PARAMETERS.MediaSpecificWakeUpEvents field +// when miniport's physical media type is NdisPhysicalMediumNative802_11 +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_WLAN_WAKE_ON_NLO_DISCOVERY_ENABLED 0x00000001 +#define NDIS_WLAN_WAKE_ON_AP_ASSOCIATION_LOST_ENABLED 0x00000002 +#define NDIS_WLAN_WAKE_ON_GTK_HANDSHAKE_ERROR_ENABLED 0x00000004 +#define NDIS_WLAN_WAKE_ON_4WAY_HANDSHAKE_REQUEST_ENABLED 0x00000008 +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS688) +#define NDIS_WLAN_WAKE_ON_INCOMING_ACTION_FRAME_ENABLED 0x00000010 +#endif // (NDIS_SUPPORT_NDIS688) +#if (NDIS_SUPPORT_NDIS689) +#define NDIS_WLAN_WAKE_ON_CLIENT_DRIVER_DIAGNOSTIC_ENABLED 0x00000020 +#endif // (NDIS_SUPPORT_NDIS689) +// +// Flags for NDIS_PM_PARAMETERS.MediaSpecificWakeUpEvents field +// when miniport's physical media type is NdisPhysicalMediumWirelessWan +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_WWAN_WAKE_ON_REGISTER_STATE_ENABLED 0x00000001 +#define NDIS_WWAN_WAKE_ON_SMS_RECEIVE_ENABLED 0x00000002 +#define NDIS_WWAN_WAKE_ON_USSD_RECEIVE_ENABLED 0x00000004 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_WWAN_WAKE_ON_PACKET_STATE_ENABLED 0x00000008 +#define NDIS_WWAN_WAKE_ON_UICC_CHANGE_ENABLED 0x00000010 +#endif // (NDIS_SUPPORT_NDIS650) + + +// +// Values used in Priority field of NDIS_PM_WOL_PATTERN +// +#define NDIS_PM_WOL_PRIORITY_LOWEST 0xFFFFFFFF +#define NDIS_PM_WOL_PRIORITY_NORMAL 0x10000000 +#define NDIS_PM_WOL_PRIORITY_HIGHEST 0x00000001 + + +// +// Values used in Priority field of NDIS_PM_PROTOCOL_OFFLOAD +// +#define NDIS_PM_PROTOCOL_OFFLOAD_PRIORITY_LOWEST 0xFFFFFFFF +#define NDIS_PM_PROTOCOL_OFFLOAD_PRIORITY_NORMAL 0x10000000 +#define NDIS_PM_PROTOCOL_OFFLOAD_PRIORITY_HIGHEST 0x00000001 + + +// +// enum type for wake on lan patterns based on packet type +// used in WoLPacketType field of NDIS_PM_WOL_PATTERN structure +// +typedef enum _NDIS_PM_WOL_PACKET +{ + NdisPMWoLPacketUnspecified, + NdisPMWoLPacketBitmapPattern, + NdisPMWoLPacketMagicPacket, + NdisPMWoLPacketIPv4TcpSyn, + NdisPMWoLPacketIPv6TcpSyn, + NdisPMWoLPacketEapolRequestIdMessage, + NdisPMWoLPacketMaximum +}NDIS_PM_WOL_PACKET, *PNDIS_PM_WOL_PACKET; + +// +// enum types for offloaded protocols used in ProtocolOffloadType +// field of NDIS_PM_PROTOCOL_OFFLOAD structure +// +typedef enum _NDIS_PM_PROTOCOL_OFFLOAD_TYPE +{ + NdisPMProtocolOffloadIdUnspecified, + NdisPMProtocolOffloadIdIPv4ARP, + NdisPMProtocolOffloadIdIPv6NS, + NdisPMProtocolOffload80211RSNRekey, +#if (NDIS_SUPPORT_NDIS684) + NdisPMProtocolOffload80211RSNRekeyV2, +#endif // (NDIS_SUPPORT_NDIS684) + NdisPMProtocolOffloadIdMaximum +}NDIS_PM_PROTOCOL_OFFLOAD_TYPE, *PNDIS_PM_PROTOCOL_OFFLOAD_TYPE; + +// +// Limited size string used in NSID power management structures +// +#define NDIS_PM_MAX_STRING_SIZE 64 + +typedef struct _NDIS_PM_COUNTED_STRING +{ + USHORT Length; // in -Bytes- + WCHAR String[NDIS_PM_MAX_STRING_SIZE + 1]; +} NDIS_PM_COUNTED_STRING, *PNDIS_PM_COUNTED_STRING; + + +// +// NDIS_PM_CAPABILITIES structure is used in PowerManagementCapabilitiesEx field of +// NDIS_MINIPORT_ADAPTER_GENERAL_ATTRIBUTES and NDIS_BIND_PARAMETERS +// +#define NDIS_PM_CAPABILITIES_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_CAPABILITIES_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_PM_CAPABILITIES +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_CAPABILITIES_REVISION_2; + // Header.Size = NDIS_SIZEOF_NDIS_PM_CAPABILITIES_REVISION_2; + // + NDIS_OBJECT_HEADER Header; + + ULONG Flags; // NDIS_PM_XXX_SUPPORTED flags + ULONG SupportedWoLPacketPatterns; // NDIS_PM_WOL_XXX_SUPPORTED flags + ULONG NumTotalWoLPatterns; + ULONG MaxWoLPatternSize; // maximum bytes that can be compared against a pattern + ULONG MaxWoLPatternOffset; // strting from MAC header, how many bytes in the packet can be examined + ULONG MaxWoLPacketSaveBuffer; // how many bytes of WOL packet can be saved to a buffer and indicated up + ULONG SupportedProtocolOffloads; // NDIS_PM_PROTOCOL_OFFLOAD_XXX_SUPPORTED flags + ULONG NumArpOffloadIPv4Addresses; + ULONG NumNSOffloadIPv6Addresses; + NDIS_DEVICE_POWER_STATE MinMagicPacketWakeUp; + NDIS_DEVICE_POWER_STATE MinPatternWakeUp; + NDIS_DEVICE_POWER_STATE MinLinkChangeWakeUp; + +#if (NDIS_SUPPORT_NDIS630) + + ULONG SupportedWakeUpEvents; // NDIS_PM_WAKE_ON_XXX_SUPPORTED flags + ULONG MediaSpecificWakeUpEvents; // NDIS_{WLAN|WWAN}_WAKE_ON_XXX_SUPPORTED flags + +#endif // (NDIS_SUPPORT_NDIS630) + +}NDIS_PM_CAPABILITIES, *PNDIS_PM_CAPABILITIES; + +#define NDIS_SIZEOF_NDIS_PM_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_CAPABILITIES, MinLinkChangeWakeUp) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NDIS_PM_CAPABILITIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_CAPABILITIES, MediaSpecificWakeUpEvents) +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// NDIS_PM_PARAMETERS structure is used in OID_PM_PARAMETERS for quering and +// updating currently enabled power management hardware capabilities. +// +#define NDIS_PM_PARAMETERS_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_PM_PARAMETERS +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_PARAMETERS_REVISION_2; + // Header.Size = NDIS_SIZEOF_NDIS_PM_PARAMETERS_REVISION_2; + // + NDIS_OBJECT_HEADER Header; + + ULONG EnabledWoLPacketPatterns; // NDIS_PM_WOL_XXX_ENABLED flags + ULONG EnabledProtocolOffloads; // NDIS_PM_PROTOCOL_OFFLOAD_XXX_ENABLED flags + ULONG WakeUpFlags; // NDIS_PM_WAKE_ON_XXX_ENABLED flags + +#if (NDIS_SUPPORT_NDIS630) + ULONG MediaSpecificWakeUpEvents; // NDIS_{WLAN|WWAN}_WAKE_ON_XXX_ENABLED flags +#endif // (NDIS_SUPPORT_NDIS630) + +} NDIS_PM_PARAMETERS, *PNDIS_PM_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_PM_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_PARAMETERS, WakeUpFlags) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NDIS_PM_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_PARAMETERS, MediaSpecificWakeUpEvents) +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// Used in _EAPOL_REQUEST_ID_MESSAGE_WOL_PACKET_PARAMETERS +// When the following flag is set, the packet must be encrypted. +// +#define EAPOL_REQUEST_ID_WOL_FLAG_MUST_ENCRYPT 0x00000001 + +// +// Pattern IDs above this number are treated as pre-assigned +// +#define NDIS_PM_MAX_PATTERN_ID 0x0000FFFF + + +// +// This value is used in the Flags field of the NDIS_PM_WOL_PATTERN structure +// It indicates that the a pre-assigned ID is used +// +#define NDIS_PM_PRIVATE_PATTERN_ID 0x00000001 + + +// +// structure used in OID_PM_ADD_WOL_PATTERN and OID_PM_WOL_PATTERN_LIST +// +#define NDIS_PM_WOL_PATTERN_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_PM_WOL_PATTERN_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + + +typedef struct _NDIS_PM_WOL_PATTERN +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_WOL_PATTERN_REVISION_2; + // Header.Size = NDIS_SIZEOF_NDIS_PM_WOL_PATTERN_REVISION_2; + // + NDIS_OBJECT_HEADER Header; + + ULONG Flags; + ULONG Priority; + NDIS_PM_WOL_PACKET WoLPacketType; + NDIS_PM_COUNTED_STRING FriendlyName; + ULONG PatternId; // Pattern ID set by NDIS + ULONG NextWoLPatternOffset; + + union _WOL_PATTERN + { + // + // IPv4 TCP SYN information + // + struct _IPV4_TCP_SYN_WOL_PACKET_PARAMETERS + { + ULONG Flags; + UCHAR IPv4SourceAddress[4]; // IPv4 source address + UCHAR IPv4DestAddress[4]; // IPv4 destination address + USHORT TCPSourcePortNumber; // TCP source port + USHORT TCPDestPortNumber; // TCP destination port + + }IPv4TcpSynParameters; + + // + // IPv6 TCP SYN information + // + struct _IPV6_TCP_SYN_WOL_PACKET_PARAMETERS + { + ULONG Flags; + UCHAR IPv6SourceAddress[16]; // source IPv6 address + UCHAR IPv6DestAddress[16]; // destination IPv6 address + USHORT TCPSourcePortNumber; // source TCP port + USHORT TCPDestPortNumber; // destination TCP port + }IPv6TcpSynParameters; + + // + // 802.1X EAPOL request identity message parameters + // + struct _EAPOL_REQUEST_ID_MESSAGE_WOL_PACKET_PARAMETERS + { + ULONG Flags; + } EapolRequestIdMessageParameters; + + struct _WOL_BITMAP_PATTERN + { + ULONG Flags; + ULONG MaskOffset; // offset for mask buffer from the beginning of NDIS_PM_WOL_PATTERN structure + ULONG MaskSize; // Mask size + ULONG PatternOffset; // offset for pattern buffer from the beginning of NDIS_PM_WOL_PATTERN structure + ULONG PatternSize; // pattern size + }WoLBitMapPattern; + }WoLPattern; + +}NDIS_PM_WOL_PATTERN, *PNDIS_PM_WOL_PATTERN; + + +#define NDIS_SIZEOF_NDIS_PM_WOL_PATTERN_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_WOL_PATTERN, WoLPattern) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NDIS_PM_WOL_PATTERN_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_WOL_PATTERN, WoLPattern) +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// 802.11 RSN handshake values +// Used in DOT11_RSN_REKEY_PARAMETERS structure +// +#define DOT11_RSN_KCK_LENGTH 16 +#define DOT11_RSN_KEK_LENGTH 16 + +#if (NDIS_SUPPORT_NDIS684) +#define DOT11_RSN_MAX_CIPHER_KEY_LENGTH 32 +#endif // (NDIS_SUPPORT_NDIS684) + +// +// structure is used in OID_PM_ADD_PROTOCOL_OFFLOAD and +// OID_PM_PROTOCOL_OFFLOAD_LIST OID requests +// +#define NDIS_PM_PROTOCOL_OFFLOAD_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_PM_PROTOCOL_OFFLOAD_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS684) + +typedef struct _NDIS_PM_PROTOCOL_OFFLOAD +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_PROTOCOL_OFFLOAD_REVISION_1; + // Header.Size = NDIS_SIZEOF_NDIS_PM_PROTOCOL_OFFLOAD_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG Priority; + NDIS_PM_PROTOCOL_OFFLOAD_TYPE ProtocolOffloadType; + NDIS_PM_COUNTED_STRING FriendlyName; + ULONG ProtocolOffloadId; // offloaded protocol ID set by NDIS + ULONG NextProtocolOffloadOffset; + + union _PROTOCOL_OFFLOAD_PARAMETERS + { + // + // IPv4 ARP + // + struct _IPV4_ARP_PARAMETERS + { + ULONG Flags; + UCHAR RemoteIPv4Address[4]; // source IPv4 address (optional) + UCHAR HostIPv4Address[4]; // destination IPv4 address + UCHAR MacAddress[6]; // MAC address + }IPv4ARPParameters; + + // + // IPv6 NS. ICMPv6 type 135 + // flags determine link local or global address. Discovery, reachability or dup address detection + // multicat MAC address: 3333WXYZ where WXYZ is the least significant 4 bytes from + // the solicited node IPv6 address + // + struct _IPV6_NS_PARAMETERS + { + ULONG Flags; + UCHAR RemoteIPv6Address[16]; // source IPv6 address (optional) + UCHAR SolicitedNodeIPv6Address[16]; // solicited node IPv6 address + UCHAR MacAddress[6]; // MAC address + UCHAR TargetIPv6Addresses[2][16]; // An array of local IPv6 addesses + }IPv6NSParameters; + + // + // 802.11 RSN handshake + // + struct _DOT11_RSN_REKEY_PARAMETERS + { + ULONG Flags; + UCHAR KCK[DOT11_RSN_KCK_LENGTH]; + UCHAR KEK[DOT11_RSN_KEK_LENGTH]; + ULONGLONG KeyReplayCounter; + }Dot11RSNRekeyParameters; + +#if (NDIS_SUPPORT_NDIS684) + // + // KCK and KEK keys for drivers that support GTK offload- V2 is for WDI drivers only + // + struct _DOT11_RSN_REKEY_PARAMETERS_V2 + { + ULONG Flags; + ULONGLONG KeyReplayCounter; + + // KCK and KEK lengths are auth-specific + ULONG AuthAlgo; + ULONG KCKLength; + ULONG KEKLength; + UCHAR KCK [DOT11_RSN_MAX_CIPHER_KEY_LENGTH]; + UCHAR KEK [DOT11_RSN_MAX_CIPHER_KEY_LENGTH]; + }Dot11RSNRekeyParametersV2; +#endif // (NDIS_SUPPORT_NDIS684) + + }ProtocolOffloadParameters; + +}NDIS_PM_PROTOCOL_OFFLOAD, *PNDIS_PM_PROTOCOL_OFFLOAD; + +// +// The size of the NDIS_PM_PROTOCOL_OFFLOAD struct for Rev1 was struct-aligned based on the union ProtocolOffloadParameters. +// However any macro that tries to recalculate this size from the new struct based on the size of the largest sub-struct in the older +// union (IPv6NSParameters) does not match the size of the overall struct, so its size is different from the original value. +// Hence we have to hard-code the size based on the value from the original struct. +// +#define NDIS_SIZEOF_NDIS_PM_PROTOCOL_OFFLOAD_REVISION_1 \ + 0xF0 + +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_SIZEOF_NDIS_PM_PROTOCOL_OFFLOAD_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_PROTOCOL_OFFLOAD, ProtocolOffloadParameters) // 256 bytes +#endif // (NDIS_SUPPORT_NDIS684) + +#if (NDIS_SUPPORT_NDIS630) + +typedef enum _NDIS_PM_WAKE_REASON_TYPE +{ + NdisWakeReasonUnspecified = 0x0000, + NdisWakeReasonPacket = 0x0001, + NdisWakeReasonMediaDisconnect = 0x0002, + NdisWakeReasonMediaConnect = 0x0003, + + // WLAN-specific wake reasons + NdisWakeReasonWlanNLODiscovery = 0x1000, + NdisWakeReasonWlanAPAssociationLost = 0x1001, + NdisWakeReasonWlanGTKHandshakeError = 0x1002, + NdisWakeReasonWlan4WayHandshakeRequest = 0x1003, +#if (NDIS_SUPPORT_NDIS688) + NdisWakeReasonWlanIncomingActionFrame = 0x1004, +#endif // (NDIS_SUPPORT_NDIS688) +#if (NDIS_SUPPORT_NDIS689) + NdisWakeReasonWlanClientDriverDiagnostic = 0x1005, +#endif // (NDIS_SUPPORT_NDIS689) + // WWAN-specific wake reasons + NdisWakeReasonWwanRegisterState = 0x2000, + NdisWakeReasonWwanSMSReceive = 0x2001, + NdisWakeReasonWwanUSSDReceive = 0x2002, + //0x2003 has been used for WakeReason.VendorSpecific in nids-nw.man +#if (NDIS_SUPPORT_NDIS684) + NdisWakeReasonWwanPacketState = 0x2004, + NdisWakeReasonWwanUiccChange = 0x2005, +#endif +} NDIS_PM_WAKE_REASON_TYPE, *PNDIS_PM_WAKE_REASON_TYPE; + +// +// NDIS_PM_WAKE_REASON struct is used with +// the NDIS_STATUS_PM_WAKE_REASON status indication +// +#define NDIS_PM_WAKE_REASON_REVISION_1 1 + +typedef struct _NDIS_PM_WAKE_REASON +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_WAKE_REASON_REVISION_1; + // Header.Size = NDIS_SIZEOF_PM_WAKE_REASON_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + + ULONG Flags; // Reserved + NDIS_PM_WAKE_REASON_TYPE WakeReason; + ULONG InfoBufferOffset; + ULONG InfoBufferSize; +} NDIS_PM_WAKE_REASON, *PNDIS_PM_WAKE_REASON; + +#define NDIS_SIZEOF_PM_WAKE_REASON_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_WAKE_REASON, InfoBufferSize) + + +// +// NDIS_PM_WAKE_PACKET struct is used within NDIS_PM_WAKE_REASON's +// InfoBuffer, if the WakeReason is NdisWakeReasonPacket +// +#define NDIS_PM_WAKE_PACKET_REVISION_1 1 + +typedef struct _NDIS_PM_WAKE_PACKET +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PM_WAKE_PACKET_REVISION_1; + // Header.Size = NDIS_SIZEOF_PM_WAKE_PACKET_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + + ULONG Flags; // Reserved + ULONG PatternId; // ID of a corresponding wake pattern + NDIS_PM_COUNTED_STRING PatternFriendlyName; // Pattern name filled by NDIS + ULONG OriginalPacketSize; + ULONG SavedPacketSize; + ULONG SavedPacketOffset; +} NDIS_PM_WAKE_PACKET, *PNDIS_PM_WAKE_PACKET; + +#define NDIS_SIZEOF_PM_WAKE_PACKET_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PM_WAKE_PACKET, SavedPacketOffset) + +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// enum values used in NDIS_WMI_PM_ADMIN_CONFIG structure +// +typedef enum _NDIS_PM_ADMIN_CONFIG_STATE +{ + NdisPMAdminConfigUnspecified = 0, + NdisPMAdminConfigDisabled = 1, + NdisPMAdminConfigEnabled = 2 +} NDIS_PM_ADMIN_CONFIG_STATE, *PNDIS_PM_ADMIN_CONFIG_STATE; + +// +// NDIS_WMI_PM_ADMIN_CONFIG struct is used with +// GUID_NDIS_PM_ADMIN_CONFIG WMI method +// +#define NDIS_WMI_PM_ADMIN_CONFIG_REVISION_1 1 + +typedef struct _NDIS_WMI_PM_ADMIN_CONFIG +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_WMI_PM_ADMIN_CONFIG_REVISION_1; + // Header.Size = NDIS_SIZEOF_WMI_PM_ADMIN_CONFIG_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + + NDIS_PM_ADMIN_CONFIG_STATE WakeOnPattern; + NDIS_PM_ADMIN_CONFIG_STATE WakeOnMagicPacket; + NDIS_PM_ADMIN_CONFIG_STATE DeviceSleepOnDisconnect; + NDIS_PM_ADMIN_CONFIG_STATE PMARPOffload; + NDIS_PM_ADMIN_CONFIG_STATE PMNSOffload; + NDIS_PM_ADMIN_CONFIG_STATE PMWiFiRekeyOffload; + +} NDIS_WMI_PM_ADMIN_CONFIG, *PNDIS_WMI_PM_ADMIN_CONFIG; + +#define NDIS_SIZEOF_WMI_PM_ADMIN_CONFIG_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_PM_ADMIN_CONFIG, PMWiFiRekeyOffload) + +// +// enum values used in NDIS_WMI_PM_ACTIVE_CAPABILITIES structure +// +typedef enum _NDIS_PM_CAPABILITY_STATE +{ + NdisPMAdminConfigUnsupported = 0, + NdisPMAdminConfigInactive = 1, + NdisPMAdminConfigActive = 2 +} NDIS_PM_CAPABILITY_STATE, *PNDIS_PM_CAPABILITY_STATE; + +// +// NDIS_WMI_PM_ACTIVE_CAPABILITIES struct is used with +// GUID_NDIS_PM_ACTIVE_CAPABILITIES WMI method +// +#define NDIS_WMI_PM_ACTIVE_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_WMI_PM_ACTIVE_CAPABILITIES +{ + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_WMI_PM_ACTIVE_CAPABILITIES_REVISION_1; + // Header.Size = NDIS_SIZEOF_WMI_PM_ACTIVE_CAPABILITIES_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + + NDIS_PM_CAPABILITY_STATE WakeOnPattern; + NDIS_PM_CAPABILITY_STATE WakeOnMagicPacket; + NDIS_PM_CAPABILITY_STATE DeviceSleepOnDisconnect; + NDIS_PM_CAPABILITY_STATE PMARPOffload; + NDIS_PM_CAPABILITY_STATE PMNSOffload; + NDIS_PM_CAPABILITY_STATE PMWiFiRekeyOffload; + +} NDIS_WMI_PM_ACTIVE_CAPABILITIES, *PNDIS_WMI_PM_ACTIVE_CAPABILITIES; + +#define NDIS_SIZEOF_WMI_PM_ACTIVE_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_PM_ACTIVE_CAPABILITIES, PMWiFiRekeyOffload) + +// +// receive filter data structures and definitions +// + + +// +// used in SupportedHeaders field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_MAC_HEADER_SUPPORTED 0x00000001 +#define NDIS_RECEIVE_FILTER_IPV4_HEADER_SUPPORTED 0x00000002 +#define NDIS_RECEIVE_FILTER_IPV6_HEADER_SUPPORTED 0x00000004 +#define NDIS_RECEIVE_FILTER_ARP_HEADER_SUPPORTED 0x00000008 +#define NDIS_RECEIVE_FILTER_UDP_HEADER_SUPPORTED 0x00000010 + +// +// used in SupportedMacHeaderFields field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_MAC_HEADER_DEST_ADDR_SUPPORTED 0x00000001 +#define NDIS_RECEIVE_FILTER_MAC_HEADER_SOURCE_ADDR_SUPPORTED 0x00000002 +#define NDIS_RECEIVE_FILTER_MAC_HEADER_PROTOCOL_SUPPORTED 0x00000004 +#define NDIS_RECEIVE_FILTER_MAC_HEADER_VLAN_ID_SUPPORTED 0x00000008 +#define NDIS_RECEIVE_FILTER_MAC_HEADER_PRIORITY_SUPPORTED 0x00000010 +#define NDIS_RECEIVE_FILTER_MAC_HEADER_PACKET_TYPE_SUPPORTED 0x00000020 + +// +// used in SupportedARPHeaderFields field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_ARP_HEADER_OPERATION_SUPPORTED 0x00000001 +#define NDIS_RECEIVE_FILTER_ARP_HEADER_SPA_SUPPORTED 0x00000002 +#define NDIS_RECEIVE_FILTER_ARP_HEADER_TPA_SUPPORTED 0x00000004 + +// +// used in SupportedIPv4HeaderFields field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_IPV4_HEADER_PROTOCOL_SUPPORTED 0x00000001 + +// +// used in SupportedIPv6HeaderFields field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_IPV6_HEADER_PROTOCOL_SUPPORTED 0x00000001 + +// +// used in SupportedUdpHeaderFields field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_UDP_HEADER_DEST_PORT_SUPPORTED 0x00000001 + +// +// used in SupportedFilterTests field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_TEST_HEADER_FIELD_EQUAL_SUPPORTED 0x00000001 +#define NDIS_RECEIVE_FILTER_TEST_HEADER_FIELD_MASK_EQUAL_SUPPORTED 0x00000002 +#define NDIS_RECEIVE_FILTER_TEST_HEADER_FIELD_NOT_EQUAL_SUPPORTED 0x00000004 + +// +// used in SupportedQueueProperties field of NDIS_RECEIVE_FILTER_CAPABILITIES +// structure +// +#define NDIS_RECEIVE_FILTER_MSI_X_SUPPORTED 0x00000001 +#define NDIS_RECEIVE_FILTER_VM_QUEUE_SUPPORTED 0x00000002 +#define NDIS_RECEIVE_FILTER_LOOKAHEAD_SPLIT_SUPPORTED 0x00000004 +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_DYNAMIC_PROCESSOR_AFFINITY_CHANGE_SUPPORTED 0x00000008 +#define NDIS_RECEIVE_FILTER_INTERRUPT_VECTOR_COALESCING_SUPPORTED 0x00000010 +#define NDIS_RECEIVE_FILTER_IMPLAT_MIN_OF_QUEUES_MODE 0x00000040 +#define NDIS_RECEIVE_FILTER_IMPLAT_SUM_OF_QUEUES_MODE 0x00000080 +#define NDIS_RECEIVE_FILTER_PACKET_COALESCING_SUPPORTED_ON_DEFAULT_QUEUE 0x00000100 + +// +// This flag has been deprecated +// +#define NDIS_RECEIVE_FILTER_ANY_VLAN_SUPPORTED 0x00000020 // deprecated +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS680) +#define NDIS_RECEIVE_FILTER_DYNAMIC_PROCESSOR_AFFINITY_CHANGE_FOR_DEFAULT_QUEUE_SUPPORTED 0x00000040 +#endif // (NDIS_SUPPORT_NDIS680) + +// +// The following bits are used in EnabledFilterTypes field of +// NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure and +// EnabledFilterTypes field of NDIS_RECEIVE_FILTER_CAPABILITIES structure +// +#define NDIS_RECEIVE_FILTER_VMQ_FILTERS_ENABLED 0x00000001 +#define NDIS_RECEIVE_FILTER_PACKET_COALESCING_FILTERS_ENABLED 0x00000002 + +// +// The following bits are used in EnabledQueueTypes field of +// NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS structure and +// EnabledQueueTypes field of NDIS_RECEIVE_FILTER_CAPABILITIES structure +// +#define NDIS_RECEIVE_FILTER_VM_QUEUES_ENABLED 0x00000001 + +// +// Data structures for advertising generic filtering capabilities +// in ReceiveFilterCapabilities field of NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES +// structure, OID_RECEIVE_FILTER_HARDWARE_CAPABILITIES and +// OID_RECEIVE_FILTER_CURRENT_CAPABILITIES query OIDs. This structure is also +// used in NDIS_STATUS_RECEIVE_FILTER_CURRENT_CAPABILITIES and +// NDIS_STATUS_RECEIVE_FILTER_HARDWARE_CAPABILITIES structure +// +#define NDIS_RECEIVE_FILTER_CAPABILITIES_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_CAPABILITIES_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_RECEIVE_FILTER_CAPABILITIES +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ ULONG EnabledFilterTypes; + _In_ ULONG EnabledQueueTypes; + _In_ ULONG NumQueues; + _In_ ULONG SupportedQueueProperties; + _In_ ULONG SupportedFilterTests; + _In_ ULONG SupportedHeaders; + _In_ ULONG SupportedMacHeaderFields; + _In_ ULONG MaxMacHeaderFilters; + _In_ ULONG MaxQueueGroups; + _In_ ULONG MaxQueuesPerQueueGroup; + _In_ ULONG MinLookaheadSplitSize; + _In_ ULONG MaxLookaheadSplitSize; +#if (NDIS_SUPPORT_NDIS630) + _In_ ULONG SupportedARPHeaderFields; + _In_ ULONG SupportedIPv4HeaderFields; + _In_ ULONG SupportedIPv6HeaderFields; + _In_ ULONG SupportedUdpHeaderFields; + _In_ ULONG MaxFieldTestsPerPacketCoalescingFilter; + _In_ ULONG MaxPacketCoalescingFilters; + _In_ ULONG NdisReserved; +#endif // (NDIS_SUPPORT_NDIS630) +} NDIS_RECEIVE_FILTER_CAPABILITIES, *PNDIS_RECEIVE_FILTER_CAPABILITIES; + +#define NDIS_SIZEOF_RECEIVE_FILTER_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_CAPABILITIES, MaxLookaheadSplitSize) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_FILTER_CAPABILITIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_CAPABILITIES, NdisReserved) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS630) +// +// used in NicSwitchCapabilities field of NDIS_NIC_SWITCH_CAPABILITIES +// structure +// +#define NDIS_NIC_SWITCH_CAPS_VLAN_SUPPORTED 0x00000001 +#define NDIS_NIC_SWITCH_CAPS_PER_VPORT_INTERRUPT_MODERATION_SUPPORTED 0x00000002 +#define NDIS_NIC_SWITCH_CAPS_ASYMMETRIC_QUEUE_PAIRS_FOR_NONDEFAULT_VPORT_SUPPORTED 0x00000004 +#define NDIS_NIC_SWITCH_CAPS_VF_RSS_SUPPORTED 0x00000008 +#define NDIS_NIC_SWITCH_CAPS_SINGLE_VPORT_POOL 0x00000010 +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_NIC_SWITCH_CAPS_RSS_PARAMETERS_PER_PF_VPORT_SUPPORTED 0x00000020 +#endif // (NDIS_SUPPORT_NDIS650) +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_NIC_SWITCH_CAPS_NIC_SWITCH_WITHOUT_IOV_SUPPORTED 0x00000040 +#define NDIS_NIC_SWITCH_CAPS_RSS_ON_PF_VPORTS_SUPPORTED 0x00000080 +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_INDIRECTION_TABLE_SUPPORTED 0x00000100 +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_FUNCTION_SUPPORTED 0x00000200 +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_TYPE_SUPPORTED 0x00000400 +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_KEY_SUPPORTED 0x00000800 +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_INDIRECTION_TABLE_SIZE_RESTRICTED 0x00001000 + +#define NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_MASK \ + (NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_KEY_SUPPORTED | \ + NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_FUNCTION_SUPPORTED | \ + NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_HASH_TYPE_SUPPORTED | \ + NDIS_NIC_SWITCH_CAPS_RSS_PER_PF_VPORT_INDIRECTION_TABLE_SUPPORTED) +#endif // (NDIS_SUPPORT_NDIS660) + +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Data structure for advertising the NIC Switch capabilities +// Used in HardwareNicSwitchCapabilities and CurrentNicSwitchCapabilities +// fields of NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES, +// OID_NIC_SWITCH_HARDWARE_CAPABILITIES and OID_NIC_SWITCH_CURRENT_CAPABILITIES. Also used +// in NicSwitchCapabilities field of NDIS_BIND_PARAMETERS and NDIS_FILTER_ATTACH_PARAMETERS structure +// Also used in NDIS_STATUS_NIC_SWITCH_CURRENT_CAPABILITIES and NDIS_STATUS_NIC_SWITCH_HARDWARE_CAPABILITIES +// +#define NDIS_NIC_SWITCH_CAPABILITIES_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_NIC_SWITCH_CAPABILITIES_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_NIC_SWITCH_CAPABILITIES_REVISION_3 3 +#endif // (NDIS_SUPPORT_NDIS660) + +typedef struct _NDIS_NIC_SWITCH_CAPABILITIES +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ ULONG NdisReserved1; + _In_ ULONG NumTotalMacAddresses; + _In_ ULONG NumMacAddressesPerPort; + _In_ ULONG NumVlansPerPort; + _In_ ULONG NdisReserved2; + _In_ ULONG NdisReserved3; +#if (NDIS_SUPPORT_NDIS630) + _In_ ULONG NicSwitchCapabilities; + _In_ ULONG MaxNumSwitches; + _In_ ULONG MaxNumVPorts; + _In_ ULONG NdisReserved4; + _In_ ULONG MaxNumVFs; + _In_ ULONG MaxNumQueuePairs; + _In_ ULONG NdisReserved5; + _In_ ULONG NdisReserved6; + _In_ ULONG NdisReserved7; + _In_ ULONG MaxNumQueuePairsPerNonDefaultVPort; + _In_ ULONG NdisReserved8; + _In_ ULONG NdisReserved9; + _In_ ULONG NdisReserved10; + _In_ ULONG NdisReserved11; + _In_ ULONG NdisReserved12; + _In_ ULONG MaxNumMacAddresses; + _In_ ULONG NdisReserved13; + _In_ ULONG NdisReserved14; + _In_ ULONG NdisReserved15; + _In_ ULONG NdisReserved16; + _In_ ULONG NdisReserved17; +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS660) + _In_ ULONG MaxNumRssCapableNonDefaultPFVPorts; + _In_ ULONG NumberOfIndirectionTableEntriesForDefaultVPort; + _In_ ULONG NumberOfIndirectionTableEntriesPerNonDefaultPFVPort; + _In_ ULONG MaxNumQueuePairsForDefaultVPort; +#endif // (NDIS_SUPPORT_NDIS660) +}NDIS_NIC_SWITCH_CAPABILITIES, *PNDIS_NIC_SWITCH_CAPABILITIES; + +#define NDIS_SIZEOF_NIC_SWITCH_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_CAPABILITIES, NdisReserved3) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_NIC_SWITCH_CAPABILITIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_CAPABILITIES, NdisReserved17) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_SIZEOF_NIC_SWITCH_CAPABILITIES_REVISION_3 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_CAPABILITIES, \ + MaxNumQueuePairsForDefaultVPort) +#endif // (NDIS_SUPPORT_NDIS660) + +// +// NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS is used in +// OID_RECEIVE_FILTER_GLOBAL_PARAMETERS query OID +// in order to query particular aspects +// of receive filtering for a miniport adapter +// +#define NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS_REVISION_1 1 +typedef struct _NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ ULONG EnabledFilterTypes; + _In_ ULONG EnabledQueueTypes; +} NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS, *PNDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_FILTER_GLOBAL_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_GLOBAL_PARAMETERS, EnabledQueueTypes) + +typedef ULONG NDIS_RECEIVE_QUEUE_ID, *PNDIS_RECEIVE_QUEUE_ID; +typedef ULONG NDIS_RECEIVE_QUEUE_GROUP_ID, *PNDIS_RECEIVE_QUEUE_GROUP_ID; + +#define NDIS_DEFAULT_RECEIVE_QUEUE_ID 0 +#define NDIS_DEFAULT_RECEIVE_QUEUE_GROUP_ID 0 +#define NDIS_DEFAULT_RECEIVE_FILTER_ID 0 + +typedef ULONG NDIS_RECEIVE_FILTER_ID, *PNDIS_RECEIVE_FILTER_ID; + +typedef enum _NDIS_RECEIVE_FILTER_TYPE +{ + NdisReceiveFilterTypeUndefined, + NdisReceiveFilterTypeVMQueue, + NdisReceiveFilterTypePacketCoalescing, + NdisReceiveFilterTypeMaximum +}NDIS_RECEIVE_FILTER_TYPE, *PNDIS_RECEIVE_FILTER_TYPE; + +typedef enum _NDIS_FRAME_HEADER +{ + NdisFrameHeaderUndefined, + NdisFrameHeaderMac, + NdisFrameHeaderArp, + NdisFrameHeaderIPv4, + NdisFrameHeaderIPv6, + NdisFrameHeaderUdp, + NdisFrameHeaderMaximum +}NDIS_FRAME_HEADER, *PNDIS_FRAME_HEADER; + +typedef enum _NDIS_MAC_HEADER_FIELD +{ + NdisMacHeaderFieldUndefined, + NdisMacHeaderFieldDestinationAddress, + NdisMacHeaderFieldSourceAddress, + NdisMacHeaderFieldProtocol, + NdisMacHeaderFieldVlanId, + NdisMacHeaderFieldPriority, + NdisMacHeaderFieldPacketType, + NdisMacHeaderFieldMaximum +}NDIS_MAC_HEADER_FIELD, *PNDIS_MAC_HEADER_FIELD; + +typedef enum _NDIS_MAC_PACKET_TYPE +{ + NdisMacPacketTypeUndefined = 0, + NdisMacPacketTypeUnicast = 1, + NdisMacPacketTypeMulticast = 2, + NdisMacPacketTypeBroadcast = 3, + NdisMacPacketTypeMaximum +} NDIS_MAC_PACKET_TYPE, *PNDIS_MAC_PACKET_TYPE; + +typedef enum _NDIS_ARP_HEADER_FIELD +{ + NdisARPHeaderFieldUndefined, + NdisARPHeaderFieldOperation, // request or response + NdisARPHeaderFieldSPA, // source protocol address + NdisARPHeaderFieldTPA, // target protocol address + NdisARPHeaderFieldMaximum +} NDIS_ARP_HEADER_FIELD, *PNDIS_ARP_HEADER_FIELD; + +typedef enum _NDIS_IPV4_HEADER_FIELD +{ + NdisIPv4HeaderFieldUndefined, + NdisIPv4HeaderFieldProtocol, + NdisIPv4HeaderFieldMaximum +}NDIS_IPV4_HEADER_FIELD, *PNDIS_IPV4_HEADER_FIELD; + +typedef enum _NDIS_IPV6_HEADER_FIELD +{ + NdisIPv6HeaderFieldUndefined, + NdisIPv6HeaderFieldProtocol, + NdisIPv6HeaderFieldMaximum +}NDIS_IPV6_HEADER_FIELD, *PNDIS_IPV6_HEADER_FIELD; + +typedef enum _NDIS_UDP_HEADER_FIELD +{ + NdisUdpHeaderFieldUndefined, + NdisUdpHeaderFieldDestinationPort, + NdisUdpHeaderFieldMaximum +}NDIS_UDP_HEADER_FIELD, *PNDIS_UDP_HEADER_FIELD; + +typedef enum _NDIS_RECEIVE_FILTER_TEST +{ + NdisReceiveFilterTestUndefined, + NdisReceiveFilterTestEqual, + NdisReceiveFilterTestMaskEqual, + NdisReceiveFilterTestNotEqual, + NdisReceiveFilterTestMaximum +}NDIS_RECEIVE_FILTER_TEST, *PNDIS_RECEIVE_FILTER_TEST; + +// +// Flags used in NDIS_RECEIVE_FILTER_FIELD_PARAMETERS.Flags field +// +#define NDIS_RECEIVE_FILTER_FIELD_MAC_HEADER_VLAN_UNTAGGED_OR_ZERO 0x00000001 +#define NDIS_RECEIVE_FILTER_RESERVED 0x000000FE + +// +// NDIS_RECEIVE_FILTER_FIELD_PARAMETERS is used in +// NDIS_RECEIVE_FILTER_PARAMETERS structure +// +#define NDIS_RECEIVE_FILTER_FIELD_PARAMETERS_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_FIELD_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef struct _NDIS_RECEIVE_FILTER_FIELD_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_FRAME_HEADER FrameHeader; + _In_ NDIS_RECEIVE_FILTER_TEST ReceiveFilterTest; + _In_ union _HEADER_FIELD + { + NDIS_MAC_HEADER_FIELD MacHeaderField; + NDIS_ARP_HEADER_FIELD ArpHeaderField; + NDIS_IPV4_HEADER_FIELD IPv4HeaderField; + NDIS_IPV6_HEADER_FIELD IPv6HeaderField; + NDIS_UDP_HEADER_FIELD UdpHeaderField; + }HeaderField; + + _In_ union _FIELD_VALUE + { + UCHAR FieldByteValue; + USHORT FieldShortValue; + ULONG FieldLongValue; + ULONG64 FieldLong64Value; + UCHAR FieldByteArrayValue[16]; + }FieldValue; + + _In_ union _RESULT_VALUE // used when test operation is MaskEqual + { + UCHAR ResultByteValue; + USHORT ResultShortValue; + ULONG ResultLongValue; + ULONG64 ResultLong64Value; + UCHAR ResultByteArrayValue[16]; + }ResultValue; + +}NDIS_RECEIVE_FILTER_FIELD_PARAMETERS, *PNDIS_RECEIVE_FILTER_FIELD_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_FILTER_FIELD_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_FIELD_PARAMETERS, ResultValue) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_FILTER_FIELD_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_FIELD_PARAMETERS, ResultValue) +#endif // (NDIS_SUPPORT_NDIS630) + +#include + +// +// Flags used in NDIS_RECEIVE_FILTER_PARAMETERS.Flags field +// +#define NDIS_RECEIVE_FILTER_FLAGS_RESERVED 0x00000001 +#define NDIS_RECEIVE_FILTER_PACKET_ENCAPSULATION_GRE 0x00000002 +#if (NDIS_SUPPORT_NDIS650) +// +// NDIS_RECEIVE_FILTER_PACKET_ENCAPSULATION replaces the use of +// NDIS_RECEIVE_FILTER_PACKET_ENCAPSULATION_GRE as a generic flag to indicate +// an inner MAC receive filter for encapsulated packet task offloads. +// +#define NDIS_RECEIVE_FILTER_PACKET_ENCAPSULATION 0x00000002 +#endif // (NDIS_SUPPORT_NDIS650) + +// +// NDIS_RECEIVE_FILTER_PARAMETERS is used in +// OID_RECEIVE_FILTER_PARAMETERS and OID_RECEIVE_FILTER_SET_FILTER +// +#define NDIS_RECEIVE_FILTER_PARAMETERS_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +typedef + _When_(FieldParametersArrayNumElements == 0, _Struct_size_bytes_(sizeof(NDIS_RECEIVE_FILTER_PARAMETERS))) + _When_(FieldParametersArrayNumElements > 0, _Struct_size_bytes_(FieldParametersArrayOffset +FieldParametersArrayNumElements*FieldParametersArrayElementSize)) + struct _NDIS_RECEIVE_FILTER_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_RECEIVE_FILTER_TYPE FilterType; + _In_ NDIS_RECEIVE_QUEUE_ID QueueId; + _Inout_ NDIS_RECEIVE_FILTER_ID FilterId; + _In_ ULONG FieldParametersArrayOffset; // from the beginning of this structure + _In_ ULONG FieldParametersArrayNumElements; + _In_ ULONG FieldParametersArrayElementSize; + _In_ ULONG RequestedFilterIdBitCount; +#if (NDIS_SUPPORT_NDIS630) + _In_ ULONG MaxCoalescingDelay; // valid only for a packet coalescing filter + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; +#endif // (NDIS_SUPPORT_NDIS630) +}NDIS_RECEIVE_FILTER_PARAMETERS, *PNDIS_RECEIVE_FILTER_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_FILTER_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_PARAMETERS, RequestedFilterIdBitCount) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_FILTER_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_PARAMETERS, VPortId) +#endif // (NDIS_SUPPORT_NDIS630) + +// +// NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS is used in +// OID_RECEIVE_FILTER_CLEAR_FILTER +// +#define NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_RECEIVE_QUEUE_ID QueueId; + _In_ NDIS_RECEIVE_FILTER_ID FilterId; +}NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS, *PNDIS_RECEIVE_FILTER_CLEAR_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_FILTER_CLEAR_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_CLEAR_PARAMETERS, FilterId) + +// +// enum value used in QueueType field of NDIS_RECEIVE_QUEUE_PARAMETERS structure +// +typedef enum _NDIS_RECEIVE_QUEUE_TYPE +{ + NdisReceiveQueueTypeUnspecified, + NdisReceiveQueueTypeVMQueue, + NdisReceiveQueueTypeMaximum +}NDIS_RECEIVE_QUEUE_TYPE, *PNDIS_RECEIVE_QUEUE_TYPE; + +// +// bits used in Flags field of NDIS_RECEIVE_QUEUE_PARAMETERS in OID_RECEIVE_FILTER_ALLOCATE_QUEUE +// and OID_RECEIVE_FILTER_QUEUE_PARAMETERS -query- OID +// +#define NDIS_RECEIVE_QUEUE_PARAMETERS_PER_QUEUE_RECEIVE_INDICATION 0x00000001 +#define NDIS_RECEIVE_QUEUE_PARAMETERS_LOOKAHEAD_SPLIT_REQUIRED 0x00000002 + +// +// bits used in Flags field of NDIS_RECEIVE_QUEUE_PARAMETERS in OID_RECEIVE_FILTER_QUEUE_PARAMETERS -set- OID +// +#define NDIS_RECEIVE_QUEUE_PARAMETERS_FLAGS_CHANGED 0x00010000 +#define NDIS_RECEIVE_QUEUE_PARAMETERS_PROCESSOR_AFFINITY_CHANGED 0x00020000 +#define NDIS_RECEIVE_QUEUE_PARAMETERS_SUGGESTED_RECV_BUFFER_NUMBERS_CHANGED 0x00040000 +#define NDIS_RECEIVE_QUEUE_PARAMETERS_NAME_CHANGED 0x00080000 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_QUEUE_PARAMETERS_INTERRUPT_COALESCING_DOMAIN_ID_CHANGED 0x00100000 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_RECEIVE_QUEUE_PARAMETERS_QOS_SQ_ID_CHANGED 0x00200000 +#endif //(NDIS_SUPPORT_NDIS650) + +#define NDIS_RECEIVE_QUEUE_PARAMETERS_CHANGE_MASK 0xFFFF0000 + +typedef NDIS_IF_COUNTED_STRING NDIS_QUEUE_NAME, *PNDIS_QUEUE_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_VM_NAME, *PNDIS_VM_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_VM_FRIENDLYNAME, *PNDIS_VM_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_PORT_PROPERTY_PROFILE_NAME, *PNDIS_SWITCH_PORT_PROPERTY_PROFILE_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_PORT_PROPERTY_PROFILE_CDN_LABEL, *PNDIS_SWITCH_PORT_PROPERTY_PROFILE_CDN_LABEL; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_NAME, *PNDIS_SWITCH_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_FRIENDLYNAME, *PNDIS_SWITCH_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_PORT_NAME, *PNDIS_SWITCH_PORT_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_PORT_FRIENDLYNAME, *PNDIS_SWITCH_PORT_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_NIC_NAME, *PNDIS_SWITCH_NIC_NAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_NIC_FRIENDLYNAME, *PNDIS_SWITCH_NIC_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_SWITCH_EXTENSION_FRIENDLYNAME, *PNDIS_SWITCH_EXTENSION_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_VENDOR_NAME, *PNDIS_VENDOR_NAME; + +#if (NDIS_SUPPORT_NDIS650) +typedef ULONG NDIS_QOS_SQ_ID, *PNDIS_QOS_SQ_ID; +#endif //(NDIS_SUPPORT_NDIS650) + +// +// NDIS_RECEIVE_QUEUE_PARAMETERS is used in +// OID_RECEIVE_FILTER_ALLOCATE_QUEUE and OID_RECEIVE_FILTER_QUEUE_PARAMETERS. +// This structure is also used in NDIS_STATUS_RECEIVE_FILTER_QUEUE_PARAMETERS +// status indication +// +#define NDIS_RECEIVE_QUEUE_PARAMETERS_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_QUEUE_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_RECEIVE_QUEUE_PARAMETERS_REVISION_3 3 +#endif // (NDIS_SUPPORT_NDIS650) + +typedef struct _NDIS_RECEIVE_QUEUE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _Inout_ ULONG Flags; + _In_ NDIS_RECEIVE_QUEUE_TYPE QueueType; + _Inout_ NDIS_RECEIVE_QUEUE_ID QueueId; + _Inout_ NDIS_RECEIVE_QUEUE_GROUP_ID QueueGroupId; + _In_ GROUP_AFFINITY ProcessorAffinity; + _In_ ULONG NumSuggestedReceiveBuffers; + _Out_ ULONG MSIXTableEntry; + _In_ ULONG LookaheadSize; + _In_ NDIS_VM_NAME VmName; + _In_ NDIS_QUEUE_NAME QueueName; +#if (NDIS_SUPPORT_NDIS630) + _In_ ULONG PortId; + _Out_ ULONG InterruptCoalescingDomainId; +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS650) + _In_ NDIS_QOS_SQ_ID QosSqId; +#endif // (NDIS_SUPPORT_NDIS650) +}NDIS_RECEIVE_QUEUE_PARAMETERS, *PNDIS_RECEIVE_QUEUE_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_PARAMETERS, QueueName) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_QUEUE_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_PARAMETERS, InterruptCoalescingDomainId) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_RECEIVE_QUEUE_PARAMETERS_REVISION_3 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_PARAMETERS, QosSqId) +#endif // (NDIS_SUPPORT_NDIS650) + +// +// NDIS_RECEIVE_QUEUE_FREE_PARAMETERS is used in +// OID_RECEIVE_FILTER_FREE_QUEUE +// +#define NDIS_RECEIVE_QUEUE_FREE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_QUEUE_FREE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_RECEIVE_QUEUE_ID QueueId; +}NDIS_RECEIVE_QUEUE_FREE_PARAMETERS, *PNDIS_RECEIVE_QUEUE_FREE_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_FREE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_FREE_PARAMETERS, QueueId) + +// +// the following enum type is used in NDIS_RECEIVE_QUEUE_STATE +// and NDIS_RECEIVE_QUEUE_INFO +// +typedef enum _NDIS_RECEIVE_QUEUE_OPERATIONAL_STATE +{ + NdisReceiveQueueOperationalStateUndefined, + NdisReceiveQueueOperationalStateRunning, + NdisReceiveQueueOperationalStatePaused, + NdisReceiveQueueOperationalStateDmaStopped, + NdisReceiveQueueOperationalStateMaximum +}NDIS_RECEIVE_QUEUE_OPERATIONAL_STATE, *PNDIS_RECEIVE_QUEUE_OPERATIONAL_STATE; + +// +// NDIS_RECEIVE_QUEUE_INFO is used with NDIS_RECEIVE_QUEUE_INFO_ARRAY +// in OID_RECEIVE_FILTER_ENUM_QUEUES that enumerates receive queues +// on a miniport or open +// +#define NDIS_RECEIVE_QUEUE_INFO_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_QUEUE_INFO_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + + +typedef struct _NDIS_RECEIVE_QUEUE_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_RECEIVE_QUEUE_TYPE QueueType; + NDIS_RECEIVE_QUEUE_ID QueueId; + NDIS_RECEIVE_QUEUE_GROUP_ID QueueGroupId; + NDIS_RECEIVE_QUEUE_OPERATIONAL_STATE QueueState; + GROUP_AFFINITY ProcessorAffinity; + ULONG NumSuggestedReceiveBuffers; + ULONG MSIXTableEntry; + ULONG LookaheadSize; + NDIS_VM_NAME VmName; + NDIS_QUEUE_NAME QueueName; +#if (NDIS_SUPPORT_NDIS630) + ULONG NumFilters; + ULONG InterruptCoalescingDomainId; +#endif // (NDIS_SUPPORT_NDIS630) +}NDIS_RECEIVE_QUEUE_INFO, *PNDIS_RECEIVE_QUEUE_INFO; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_INFO, QueueName) + + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_QUEUE_INFO_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_INFO, InterruptCoalescingDomainId) +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// NDIS_RECEIVE_QUEUE_INFO_ARRAY is used in OID_RECEIVE_FILTER_ENUM_QUEUES +// that enumerates receive queues on a miniport or open. Each element in the +// array is an NDIS_RECEIVE_QUEUE_INFO structure +// +#define NDIS_RECEIVE_QUEUE_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_QUEUE_INFO_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG FirstElementOffset; + ULONG NumElements; + ULONG ElementSize; +}NDIS_RECEIVE_QUEUE_INFO_ARRAY, *PNDIS_RECEIVE_QUEUE_INFO_ARRAY; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_INFO_ARRAY, ElementSize) + + +// +// NDIS_RECEIVE_FILTER_INFO is used with NDIS_RECEIVE_FILTER_INFO_ARRAY +// in OID_RECEIVE_FILTER_ENUM_FILTERS that enumerates receive +// filters on a queue +// +#define NDIS_RECEIVE_FILTER_INFO_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_FILTER_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_RECEIVE_FILTER_TYPE FilterType; + NDIS_RECEIVE_FILTER_ID FilterId; +}NDIS_RECEIVE_FILTER_INFO, *PNDIS_RECEIVE_FILTER_INFO; + +#define NDIS_SIZEOF_RECEIVE_FILTER_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_INFO, FilterId) + + +// +// NDIS_RECEIVE_FILTER_INFO_ARRAY is used in OID_RECEIVE_FILTER_ENUM_FILTERS +// that enumerates receive filters on a queue or a VPort. Each element in the array +// is an NDIS_RECEIVE_FILTER_INFO structure +// +#define NDIS_RECEIVE_FILTER_INFO_ARRAY_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_INFO_ARRAY_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +// +// flags used in NDIS_RECEIVE_FILTER_INFO_ARRAY to specify whether +// QueueId or VPortId is specified +// +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_FILTER_INFO_ARRAY_VPORT_ID_SPECIFIED 0x00000001 +#endif + +typedef struct _NDIS_RECEIVE_FILTER_INFO_ARRAY +{ + NDIS_OBJECT_HEADER Header; + NDIS_RECEIVE_QUEUE_ID QueueId; + ULONG FirstElementOffset; + ULONG NumElements; + ULONG ElementSize; +#if (NDIS_SUPPORT_NDIS630) + ULONG Flags; + NDIS_NIC_SWITCH_VPORT_ID VPortId; +#endif // (NDIS_SUPPORT_NDIS630) +}NDIS_RECEIVE_FILTER_INFO_ARRAY, *PNDIS_RECEIVE_FILTER_INFO_ARRAY; + +#define NDIS_SIZEOF_RECEIVE_FILTER_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_INFO_ARRAY, ElementSize) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_FILTER_INFO_ARRAY_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_INFO_ARRAY, VPortId) +#endif // (NDIS_SUPPORT_NDIS630) + +// +// NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS is used +// in OID_RECEIVE_FILTER_QUEUE_ALLOCATION_COMPLETE OID. +// +#define NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_RECEIVE_QUEUE_ID QueueId; + _Out_ NDIS_STATUS CompletionStatus; +}NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS, *PNDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS, CompletionStatus) + +// +// NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY is used in +// OID_RECEIVE_FILTER_QUEUE_ALLOCATION_COMPLETE OID request. +// Each element in array is an NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS +// structure. +// +#define NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY_REVISION_1 1 + +typedef + _When_(NumElements >= 1, + _Struct_size_bytes_(FirstElementOffset + NumElements*ElementSize)) + _When_(NumElements == 0, + _Struct_size_bytes_(sizeof(NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY))) + struct _NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG FirstElementOffset; // offset to an array of NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_PARAMETERS + ULONG NumElements; + ULONG ElementSize; +}NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY, *PNDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY; + +#define NDIS_SIZEOF_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_QUEUE_ALLOCATION_COMPLETE_ARRAY, ElementSize) + +#endif // #if (NDIS_SUPPORT_NDIS620) + +#if ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + +#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_3 3 +#endif // (NDIS_SUPPORT_NDIS660) + + +// +// What kind of hash field type the miniport can support. +// Important, the defined values for NDIS_RSS_CAPS_HASH_TYPE must allow for +// matching the NDIS_HASH_TYPE_MASK. Referrence the NDIS_HASH_TYPE_MASK +// for more info. +// +#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4 0x00000100 +#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6 0x00000200 +#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX 0x00000400 +#if (NDIS_SUPPORT_NDIS680) + #define NDIS_RSS_CAPS_HASH_TYPE_UDP_IPV4 0x00000800 + #define NDIS_RSS_CAPS_HASH_TYPE_UDP_IPV6 0x00001000 + #define NDIS_RSS_CAPS_HASH_TYPE_UDP_IPV6_EX 0x00002000 +#endif // (NDIS_SUPPORT_NDIS680) + +// +// What kind the receive scale capabilities the miniport can support, miniport drivers return +// some of these flags as CapabilitiesFlags in a structure _NDIS_RECEIVE_SCALE_CAPABILITIES +// when they get a query about theire receive side scale capabilities. +// +#define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000 +#define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR 0x02000000 +#define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC 0x04000000 +#if NDIS_SUPPORT_NDIS620 + #define NDIS_RSS_CAPS_USING_MSI_X 0x08000000 +#endif +#if (NDIS_SUPPORT_NDIS630) + #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS 0x10000000 + #define NDIS_RSS_CAPS_SUPPORTS_MSI_X 0x20000000 +#endif // (NDIS_SUPPORT_NDIS630) +#if (NDIS_SUPPORT_NDIS680) + #define NDIS_RSS_CAPS_SUPPORTS_INDEPENDENT_ENTRY_MOVE 0x40000000 +#endif // (NDIS_SUPPORT_NDIS680) +// +// Typedef to use as flags holder to correlate to the NDIS_RSS_CAPS_ prefixed flags above. +// +typedef ULONG NDIS_RSS_CAPS_FLAGS; + +// +// the following structure defines the Receive scale capabilities of the miniport +// +typedef struct _NDIS_RECEIVE_SCALE_CAPABILITIES +{ + NDIS_OBJECT_HEADER Header; + NDIS_RSS_CAPS_FLAGS CapabilitiesFlags; + ULONG NumberOfInterruptMessages; + ULONG NumberOfReceiveQueues; + #if (NDIS_SUPPORT_NDIS630) + USHORT NumberOfIndirectionTableEntries; + #endif // (NDIS_SUPPORT_NDIS630) +} NDIS_RECEIVE_SCALE_CAPABILITIES, *PNDIS_RECEIVE_SCALE_CAPABILITIES; + + +#define NDIS_SIZEOF_RECEIVE_SCALE_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_CAPABILITIES, NumberOfReceiveQueues) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RECEIVE_SCALE_CAPABILITIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_CAPABILITIES, NumberOfIndirectionTableEntries) +#endif // (NDIS_SUPPORT_NDIS630) + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_SIZEOF_RECEIVE_SCALE_CAPABILITIES_REVISION_3 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_CAPABILITIES, NumberOfIndirectionTableEntries) +#endif // (NDIS_SUPPORT_NDIS660) + +#include + +// +// Flags to denote the parameters that are kept unmodified. +// +#define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED 0x0001 +#define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED 0x0002 +#define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED 0x0004 +#define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED 0x0008 +#define NDIS_RSS_PARAM_FLAG_DISABLE_RSS 0x0010 +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_RSS_PARAM_FLAG_DEFAULT_PROCESSOR_UNCHANGED 0x0020 +#endif // NDIS_SUPPORT_NDIS660 + +#define NDIS_RSS_INDIRECTION_TABLE_SIZE_REVISION_1 128 +#define NDIS_RSS_HASH_SECRET_KEY_SIZE_REVISION_1 40 + +// +// used in OID_GEN_RECEIVE_SCALE_PARAMETERS +// +#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_1 1 + +#if NDIS_SUPPORT_NDIS620 + +#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2 + +#endif + +#if NDIS_SUPPORT_NDIS660 + +#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_3 3 + +#endif + +typedef struct _NDIS_RECEIVE_SCALE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + + // Qualifies the rest of the information. + USHORT Flags; + + // The base CPU number to do receive processing. not used. + USHORT BaseCpuNumber; + + // This describes the hash function and type being enabled. + ULONG HashInformation; + + // The size of indirection table array. + USHORT IndirectionTableSize; + // The offset of the indirection table from the beginning of this structure. + ULONG IndirectionTableOffset; + + // The size of the secret key. + USHORT HashSecretKeySize; + // The offset of the secret key from the beginning of this structure. + ULONG HashSecretKeyOffset; + +#if NDIS_SUPPORT_NDIS620 + ULONG ProcessorMasksOffset; // + ULONG NumberOfProcessorMasks; // Array of type GROUP_AFFINITY representing procs used in the indirection table + ULONG ProcessorMasksEntrySize; // +#endif + + // The hash map table is a CCHAR array for Revision 1. + // It is a PROCESSOR_NUMBER array for Revision 2 + +#if NDIS_SUPPORT_NDIS660 + // Specifies default RSS processor. + PROCESSOR_NUMBER DefaultProcessorNumber; +#endif +} NDIS_RECEIVE_SCALE_PARAMETERS, *PNDIS_RECEIVE_SCALE_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_SCALE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_PARAMETERS, HashSecretKeyOffset) + +// +// Maximum indirection table and private key sizes for revision 1 +// +#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_1 128 +#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_1 40 + +#if NDIS_SUPPORT_NDIS620 + +#define NDIS_SIZEOF_RECEIVE_SCALE_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_PARAMETERS, ProcessorMasksEntrySize) + +// +// Maximum indirection table and private key sizes for revision 2 +// +#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128*sizeof(PROCESSOR_NUMBER)) +#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40 + +#endif + +#if NDIS_SUPPORT_NDIS660 + +#define NDIS_SIZEOF_RECEIVE_SCALE_PARAMETERS_REVISION_3 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_PARAMETERS, DefaultProcessorNumber) + +// +// Maximum indirection table and private key sizes for revision 3 +// +#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_3 (128*sizeof(PROCESSOR_NUMBER)) +#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_3 40 + +#endif + + +#if NDIS_SUPPORT_NDIS680 + +// +// Parameter structure used with OID_GEN_RECEIVE_SCALE_PARAMETERS_V2 +// +#define NDIS_RECEIVE_SCALE_PARAMETERS_V2_REVISION_1 1 + +#define NDIS_RECEIVE_SCALE_PARAM_ENABLE_RSS 0x00000001 +#define NDIS_RECEIVE_SCALE_PARAM_HASH_INFO_CHANGED 0x00000002 +#define NDIS_RECEIVE_SCALE_PARAM_HASH_KEY_CHANGED 0x00000004 +#define NDIS_RECEIVE_SCALE_PARAM_NUMBER_OF_QUEUES_CHANGED 0x00000008 +#define NDIS_RECEIVE_SCALE_PARAM_NUMBER_OF_ENTRIES_CHANGED 0x00000010 + +typedef struct _NDIS_RECEIVE_SCALE_PARAMETERS_V2 +{ + // + // Header.Type = NDIS_OBJECT_TYPE_RSS_PARAMETERS_V2; + // Header.Revision = NDIS_RECEIVE_SCALE_PARAMETERS_V2_REVISION_1; + // Header.Size = sizeof(NDIS_RECEIVE_SCALE_PARAMETERS_V2); + // + NDIS_OBJECT_HEADER Header; + + // Qualifies the rest of the information. + ULONG Flags; + + // This describes the hash function and type being enabled. + ULONG HashInformation; + + // The size of the secret key. + ULONG HashSecretKeySize; + // The offset of the secret key from the beginning of this structure. + ULONG HashSecretKeyOffset; + + // Number of queues + ULONG NumberOfQueues; + + // Number of entries in indirection table. Must be power of two. + ULONG NumberOfIndirectionTableEntries; + +} NDIS_RECEIVE_SCALE_PARAMETERS_V2, *PNDIS_RECEIVE_SCALE_PARAMETERS_V2; + +#define NDIS_SIZEOF_RECEIVE_SCALE_PARAMETERS_V2_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_SCALE_PARAMETERS_V2, \ + NumberOfIndirectionTableEntries) + +// +// Flag which tells that NDIS_RSS_SET_INDIRECTION_ENTRY is referring to +// "Primary Processor" of the scaling entity (e.g. VPort). +// IndirectionTableIndex is not used. +// +#define NDIS_RSS_SET_INDIRECTION_ENTRY_FLAG_PRIMARY_PROCESSOR 0x00000001 + +// +// Flag which tells that NDIS_RSS_SET_INDIRECTION_ENTRY is referring to +// "Default Processor" of the scaling entity (e.g. VPort). +// IndirectionTableIndex is not used. +// +#define NDIS_RSS_SET_INDIRECTION_ENTRY_FLAG_DEFAULT_PROCESSOR 0x00000002 + +// +// Command to set a single indirection table entry. +// +typedef struct _NDIS_RSS_SET_INDIRECTION_ENTRY +{ + // Nic Switch where VPort is residing + NDIS_NIC_SWITCH_ID SwitchId; + + // VPort idintifier + NDIS_NIC_SWITCH_VPORT_ID VPortId; + + // Qualifies the information in this structure. + ULONG Flags; + + // Indirection table entry which is being moved. + USHORT IndirectionTableIndex; + + // Target processor number + PROCESSOR_NUMBER TargetProcessorNumber; + + // Result of the set operation described by this entry. + NDIS_STATUS EntryStatus; + +} NDIS_RSS_SET_INDIRECTION_ENTRY, *PNDIS_RSS_SET_INDIRECTION_ENTRY; + +#define NDIS_SIZEOF_RSS_SET_INDIRECTION_ENTRY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSS_SET_INDIRECTION_ENTRY, EntryStatus) + +// +// This structure is a parameter for synchronous direct +// OID_GEN_RSS_SET_INDIRECTION_TABLE_ENTRIES. +// +#define NDIS_RSS_SET_INDIRECTION_ENTRIES_REVISION_1 1 + +typedef struct _NDIS_RSS_SET_INDIRECTION_ENTRIES +{ + // + // Header.Type = NDIS_OBJECT_TYPE_RSS_SET_INDIRECTION_ENTRIES; + // Header.Revision = NDIS_RSS_SET_INDIRECTION_ENTRIES_REVISION_1; + // Header.Size = sizeof(NDIS_RSS_SET_INDIRECTION_ENTRIES); + // + NDIS_OBJECT_HEADER Header; + + // Qualifies the rest of the information, as well as array processing policy + ULONG Flags; + + // RssEntrySize is an opaque number that needs to be added to the pointer + // during array traversal. + ULONG RssEntrySize; + + // Offset of NDIS_RSS_SET_INDIRECTION_ENTRY array from the beginning of + // this structure. + ULONG RssEntryTableOffset; + + // The number of NDIS_RSS_SET_INDIRECTION_ENTRY elements in the array. + ULONG NumberOfRssEntries; + +} NDIS_RSS_SET_INDIRECTION_ENTRIES, *PNDIS_RSS_SET_INDIRECTION_ENTRIES; + +#define NDIS_SIZEOF_RSS_SET_INDIRECTION_ENTRIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSS_SET_INDIRECTION_ENTRIES, \ + NumberOfRssEntries) + +#endif // NDIS_SUPPORT_NDIS680 + +// +// Used in OID_GEN_RECEIVE_HASH +// +#define NDIS_RECEIVE_HASH_FLAG_ENABLE_HASH 0x00000001 +#define NDIS_RECEIVE_HASH_FLAG_HASH_INFO_UNCHANGED 0x00000002 +#define NDIS_RECEIVE_HASH_FLAG_HASH_KEY_UNCHANGED 0x00000004 + +#define NDIS_RECEIVE_HASH_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_HASH_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + + // Qualifies the rest of the information. + ULONG Flags; + + // This describes the hash function and type being enabled. + ULONG HashInformation; + + // The size of the secret key. + USHORT HashSecretKeySize; + + // The offset of the secret key from the beginning of this structure. + ULONG HashSecretKeyOffset; +} NDIS_RECEIVE_HASH_PARAMETERS, *PNDIS_RECEIVE_HASH_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_HASH_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_HASH_PARAMETERS, HashSecretKeyOffset) + + +typedef enum _NDIS_PROCESSOR_VENDOR +{ + NdisProcessorVendorUnknown, + NdisProcessorVendorGenuinIntel, + NdisProcessorVendorGenuineIntel = NdisProcessorVendorGenuinIntel, + NdisProcessorVendorAuthenticAMD +} NDIS_PROCESSOR_VENDOR, *PNDIS_PROCESSOR_VENDOR; + +#if NDIS_SUPPORT_NDIS620 + +// +// Used in the RssProcessorArray in NDIS_RSS_PROCESSOR_INFO +// +typedef struct _NDIS_RSS_PROCESSOR +{ + PROCESSOR_NUMBER ProcNum; + USHORT PreferenceIndex; + USHORT Reserved; +} NDIS_RSS_PROCESSOR, *PNDIS_RSS_PROCESSOR; + +#define NDIS_SIZEOF_RSS_PROCESSOR_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSS_PROCESSOR, PreferenceIndex) + +#define NDIS_RSS_PROCESSOR_INFO_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_RSS_PROCESSOR_INFO_REVISION_2 2 +typedef enum _NDIS_RSS_PROFILE +{ + NdisRssProfileClosest = 1, + NdisRssProfileClosestStatic, + NdisRssProfileNuma, + NdisRssProfileNumaStatic, + NdisRssProfileConservative, + +#if (NDIS_SUPPORT_NDIS688) + NdisRssProfileBalanced, +#endif // (NDIS_SUPPORT_NDIS688) + + NdisRssProfileMaximum, +} NDIS_RSS_PROFILE, *PNDIS_RSS_PROFILE; +#endif // (NDIS_SUPPORT_NDIS630) + + +// +// Used in NdisGetRssProcessorInformation API and OID_IMPLAT_RSS_PROCESSOR_INFO +// +typedef struct _NDIS_RSS_PROCESSOR_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + PROCESSOR_NUMBER RssBaseProcessor; + ULONG MaxNumRssProcessors; + USHORT PreferredNumaNode; + + ULONG RssProcessorArrayOffset;// | + ULONG RssProcessorCount; // | Array of NDIS_RSS_PROCESSOR + ULONG RssProcessorEntrySize; // | + +#if (NDIS_SUPPORT_NDIS630) + PROCESSOR_NUMBER RssMaxProcessor; + NDIS_RSS_PROFILE RssProfile; +#endif // (NDIS_SUPPORT_NDIS630) + +} NDIS_RSS_PROCESSOR_INFO, *PNDIS_RSS_PROCESSOR_INFO; + +C_ASSERT(sizeof(NDIS_RSS_PROCESSOR_INFO) % __alignof(NDIS_RSS_PROCESSOR) == 0); + +#define NDIS_SIZEOF_RSS_PROCESSOR_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSS_PROCESSOR_INFO, RssProcessorEntrySize) + +#if (NDIS_SUPPORT_NDIS630) +#define NDIS_SIZEOF_RSS_PROCESSOR_INFO_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RSS_PROCESSOR_INFO, RssProfile) +#endif // (NDIS_SUPPORT_NDIS630) + +// +// Used in ProcessorInfo array in NDIS_SYSTEM_PROCESSOR_INFO_EX +// +typedef struct _NDIS_PROCESSOR_INFO_EX +{ + PROCESSOR_NUMBER ProcNum; + ULONG SocketId; + ULONG CoreId; + ULONG HyperThreadId; + USHORT NodeId; + USHORT NodeDistance; +}NDIS_PROCESSOR_INFO_EX, *PNDIS_PROCESSOR_INFO_EX; + +#define NDIS_SYSTEM_PROCESSOR_INFO_EX_REVISION_1 1 + +// +// Used in NdisGetProcessorInformationEx API +// +typedef struct _NDIS_SYSTEM_PROCESSOR_INFO_EX +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_PROCESSOR_VENDOR ProcessorVendor; + ULONG NumSockets; + ULONG NumCores; + ULONG NumCoresPerSocket; + ULONG MaxHyperThreadingProcsPerCore; + + ULONG ProcessorInfoOffset; // | + ULONG NumberOfProcessors; // | Array of NDIS_PROCESSOR_INFO_EX + ULONG ProcessorInfoEntrySize; // | + +} NDIS_SYSTEM_PROCESSOR_INFO_EX, *PNDIS_SYSTEM_PROCESSOR_INFO_EX; + +C_ASSERT(sizeof(NDIS_SYSTEM_PROCESSOR_INFO_EX) % __alignof(NDIS_PROCESSOR_INFO_EX) == 0); + +#define NDIS_SIZEOF_SYSTEM_PROCESSOR_INFO_EX_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SYSTEM_PROCESSOR_INFO_EX, ProcessorInfoEntrySize) + +// +// Enum to identify Hypervisor Parition type +// Used in NDIS_HYPERVISOR_INFO.PartitionType +// +typedef enum _NDIS_HYPERVISOR_PARTITION_TYPE +{ + NdisHypervisorPartitionTypeUnknown, + NdisHypervisorPartitionTypeMsHvParent, + NdisHypervisorPartitionMsHvChild, + NdisHypervisorPartitionTypeMax +} NDIS_HYPERVISOR_PARTITION_TYPE, *PNDIS_HYPERVISOR_PARTITION_TYPE; + +// +// Flags used in NDIS_HYPERVISOR_INFO.Flags field +// +#define NDIS_HYPERVISOR_INFO_FLAG_HYPERVISOR_PRESENT 0x00000001 + +#define NDIS_HYPERVISOR_INFO_REVISION_1 1 + +// +// Structure used to return Hypervisor related information +// in NdisGetHypervisorInfo API +// +typedef struct _NDIS_HYPERVISOR_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_HYPERVISOR_PARTITION_TYPE PartitionType; +} NDIS_HYPERVISOR_INFO, *PNDIS_HYPERVISOR_INFO; + +#define NDIS_SIZEOF_HYPERVISOR_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_HYPERVISOR_INFO, PartitionType) + +// +// The following data structures are used with Receive Queue related WMI +// guids. NDIS will translate these data structures to those used +// in OIDs +// + +typedef struct _NDIS_WMI_GROUP_AFFINITY { + ULONG64 Mask; + USHORT Group; + USHORT Reserved[3]; +} NDIS_WMI_GROUP_AFFINITY, *PNDIS_WMI_GROUP_AFFINITY; + +// +// NDIS_WMI_RECEIVE_QUEUE_PARAMETERS is used in GUID_NDIS_RECEIVE_FILTER_QUEUE_PARAMETERS +// +#define NDIS_WMI_RECEIVE_QUEUE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_WMI_RECEIVE_QUEUE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_RECEIVE_QUEUE_TYPE QueueType; + NDIS_RECEIVE_QUEUE_ID QueueId; + NDIS_RECEIVE_QUEUE_GROUP_ID QueueGroupId; + NDIS_WMI_GROUP_AFFINITY ProcessorAffinity; + ULONG NumSuggestedReceiveBuffers; + ULONG MSIXTableEntry; + ULONG LookaheadSize; + NDIS_VM_NAME VmName; + NDIS_QUEUE_NAME QueueName; +}NDIS_WMI_RECEIVE_QUEUE_PARAMETERS, *PNDIS_WMI_RECEIVE_QUEUE_PARAMETERS; + +#define NDIS_SIZEOF_WMI_RECEIVE_QUEUE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_RECEIVE_QUEUE_PARAMETERS, QueueName) + +// +// NDIS_WMI_RECEIVE_QUEUE_INFO is used in GUID_NDIS_RECEIVE_FILTER_ENUM_QUEUES +// +#define NDIS_WMI_RECEIVE_QUEUE_INFO_REVISION_1 1 + +typedef struct _NDIS_WMI_RECEIVE_QUEUE_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_RECEIVE_QUEUE_TYPE QueueType; + NDIS_RECEIVE_QUEUE_ID QueueId; + NDIS_RECEIVE_QUEUE_GROUP_ID QueueGroupId; + NDIS_RECEIVE_QUEUE_OPERATIONAL_STATE QueueState; + NDIS_WMI_GROUP_AFFINITY ProcessorAffinity; + ULONG NumSuggestedReceiveBuffers; + ULONG MSIXTableEntry; + ULONG LookaheadSize; + NDIS_VM_NAME VmName; + NDIS_QUEUE_NAME QueueName; +}NDIS_WMI_RECEIVE_QUEUE_INFO, *PNDIS_WMI_RECEIVE_QUEUE_INFO; + +#define NDIS_SIZEOF_WMI_RECEIVE_QUEUE_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_WMI_RECEIVE_QUEUE_INFO, QueueName) + +#endif // NDIS_SUPPORT_NDIS620 + +#if (NDIS_SUPPORT_NDIS630) + +#include + +// +// NetworkDirect performance counters structure for PCW support. The fields +// (and their order) in this structure must always match the corresponding +// information in the NDIS PCW manifest. +// If this structure is changed, then the NDIS_NDK_STATISTICS_INFO structure +// revision must also be updated accordingly since this structure is embedded in +// NDIS_NDK_STATISTICS_INFO. +// + +typedef struct _NDIS_NDK_PERFORMANCE_COUNTERS { + + // Connection statistics + ULONG64 Connect; // 0 + ULONG64 Accept; // 1 + ULONG64 ConnectFailure; // 2 + ULONG64 ConnectionError; // 3 + ULONG64 ActiveConnection; // 4 + + // Reserved counters + ULONG64 Reserved01; // 5 + ULONG64 Reserved02; // 6 + ULONG64 Reserved03; // 7 + ULONG64 Reserved04; // 8 + ULONG64 Reserved05; // 9 + ULONG64 Reserved06; // 10 + ULONG64 Reserved07; // 11 + ULONG64 Reserved08; // 12 + ULONG64 Reserved09; // 13 + ULONG64 Reserved10; // 14 + ULONG64 Reserved11; // 15 + ULONG64 Reserved12; // 16 + ULONG64 Reserved13; // 17 + ULONG64 Reserved14; // 18 + ULONG64 Reserved15; // 19 + ULONG64 Reserved16; // 20 + ULONG64 Reserved17; // 21 + ULONG64 Reserved18; // 22 + ULONG64 Reserved19; // 23 + ULONG64 Reserved20; // 24 + + // Errors + ULONG64 CQError; // 25 + + // Byte and frame counts + ULONG64 RDMAInOctets; // 26 + ULONG64 RDMAOutOctets; // 27 + ULONG64 RDMAInFrames; // 28 + ULONG64 RDMAOutFrames; // 29 +} NDIS_NDK_PERFORMANCE_COUNTERS, *PNDIS_NDK_PERFORMANCE_COUNTERS; + +#define NDIS_NDK_PERFORMANCE_COUNTER_MASK(CounterFieldName) \ + (1ui64 << (FIELD_OFFSET(NDIS_NDK_PERFORMANCE_COUNTERS, CounterFieldName) / sizeof(ULONG64))) + +#define NDIS_NDK_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_NDK_CAPABILITIES { + + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_NDK_CAPABILITIES_REVISION_1; + // Header.Size = sizeof(NDIS_NDK_CAPABILITIES); + // + NDIS_OBJECT_HEADER Header; + + ULONG Flags; // reserved, must be set to 0 + + // + // Following fields denote NDK adapter capacity limits that are relevant for + // system-wide management/partitioning of resouces available on a given NDK adapter. + // + + // Maximum number of queue pairs supported by the adapter + ULONG MaxQpCount; + + // Maximum number of completion queues supported by the adapter + ULONG MaxCqCount; + + // Maximum number of memory regions supported by the adapter + ULONG MaxMrCount; + + // Maximum number of protection domains supported by the adapter + ULONG MaxPdCount; + + // Maximum number of incoming outstanding read requests supported by the adapter + // If this field is 0, there's no adapter-wide limit. There is still a limit per queue pair, + // which is indicated by the NdkInfo.MaxInboundReadLimit field. + ULONG MaxInboundReadLimit; + + // Maximum number of outgoing outstanding read requests supported by the adapter + // If this field is 0, there's no adapter-wide limit. There is still a limit per queue pair, + // which is indicated by the NdkInfo.MaxOutboundReadLimit field. + ULONG MaxOutboundReadLimit; + + // Maximum number of memory windows supported by the adapter + ULONG MaxMwCount; + + // Maximum number of shared receive queues supported by the adapter + // If this field is 0, adapter does not support shared receive queues. + ULONG MaxSrqCount; + + // ND providers are required to support all the performance counters included + // in NDIS_NDK_PERFORMANCE_COUNTERS. However, in the rare case that + // a provider cannot support a counter due to extreme implementation difficulties, + // it must indicate so via the following field by OR'ing the mask value for the + // counter which it cannot support. + ULONG64 MissingCounterMask; + + // + // Following field points to a structure that denotes NDK adapter capabilities and + // limits that are relevant for an individual NDKPI client (in contrast to system-wide limits). + // + NDK_ADAPTER_INFO *NdkInfo; + +} NDIS_NDK_CAPABILITIES, * PNDIS_NDK_CAPABILITIES; + +#define NDIS_SIZEOF_NDK_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NDK_CAPABILITIES, NdkInfo) + +#define OID_NDK_SET_STATE 0xFC040201 +#define OID_NDK_STATISTICS 0xFC040202 +#define OID_NDK_CONNECTIONS 0xFC040203 +#define OID_NDK_LOCAL_ENDPOINTS 0xFC040204 + +// Embedded output structure for GUID_NDIS_NDK_CAPABILITIES +typedef struct _NDK_WMI_ADAPTER_INFO { + NDK_VERSION Version; + UINT32 VendorId; + UINT32 DeviceId; + ULONGLONG MaxRegistrationSize; + ULONGLONG MaxWindowSize; + ULONG FRMRPageCount; + ULONG MaxInitiatorRequestSge; + ULONG MaxReceiveRequestSge; + ULONG MaxReadRequestSge; + ULONG MaxTransferLength; + ULONG MaxInlineDataSize; + ULONG MaxInboundReadLimit; + ULONG MaxOutboundReadLimit; + ULONG MaxReceiveQueueDepth; + ULONG MaxInitiatorQueueDepth; + ULONG MaxSrqDepth; + ULONG MaxCqDepth; + ULONG LargeRequestThreshold; + ULONG MaxCallerData; + ULONG MaxCalleeData; + ULONG AdapterFlags; +#if (NDIS_SUPPORT_NDIS650) + NDK_RDMA_TECHNOLOGY RdmaTechnology; +#endif +} NDK_WMI_ADAPTER_INFO, *PNDK_WMI_ADAPTER_INFO; + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_NDK_WMI_ADAPTER_INFO_REVISION_1 \ + FIELD_OFFSET(NDK_WMI_ADAPTER_INFO, RdmaTechnology) + +#define NDIS_SIZEOF_NDK_WMI_ADAPTER_INFO_REVISION_2 \ + sizeof(NDK_WMI_ADAPTER_INFO) +#endif + +// Output structure for GUID_NDIS_NDK_CAPABILITIES +typedef struct _NDIS_WMI_NDK_CAPABILITIES { + ULONG MaxQpCount; + ULONG MaxCqCount; + ULONG MaxMrCount; + ULONG MaxPdCount; + ULONG MaxInboundReadLimit; + ULONG MaxOutboundReadLimit; + ULONG MaxMwCount; + ULONG MaxSrqCount; + ULONG64 MissingCounterMask; + NDK_WMI_ADAPTER_INFO NdkInfo; +} NDIS_WMI_NDK_CAPABILITIES, * PNDIS_WMI_NDK_CAPABILITIES; + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_NDK_WMI_CAPABILITIES_REVISION_1 \ + (FIELD_OFFSET(NDIS_WMI_NDK_CAPABILITIES, NdkInfo) + \ + NDIS_SIZEOF_NDK_WMI_ADAPTER_INFO_REVISION_1) + +#define NDIS_SIZEOF_NDK_WMI_CAPABILITIES_REVISION_2 \ + (FIELD_OFFSET(NDIS_WMI_NDK_CAPABILITIES, NdkInfo) + \ + NDIS_SIZEOF_NDK_WMI_ADAPTER_INFO_REVISION_2) +#endif + +// Query ND capabilities of an NDK adapter +DEFINE_GUID(GUID_NDIS_NDK_CAPABILITIES, 0x7969ba4d, 0xdd80, 0x4bc7, 0xb3, 0xe6, 0x68, 0x04, 0x39, 0x97, 0xe5, 0x19); + +// Query/set ND enabled/disabled state of an NDK adapter +DEFINE_GUID(GUID_NDIS_NDK_STATE, 0x530c69c9, 0x2f51, 0x49de, 0xa1, 0xaf, 0x08, 0x8d, 0x54, 0xff, 0xa4, 0x74); + +// +// Structure returned for an OID_NDK_STATISTICS request +// + +#define NDIS_NDK_STATISTICS_INFO_REVISION_1 1 + +typedef struct _NDIS_NDK_STATISTICS_INFO { + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT + // Header.Revision = NDIS_NDK_STATISTICS_INFO_REVISION_1; + // Header.Size = NDIS_SIZEOF_NDK_STATISTICS_INFO_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; // reserved, must be set to 0 + + NDIS_NDK_PERFORMANCE_COUNTERS CounterSet; +} NDIS_NDK_STATISTICS_INFO; + +#define NDIS_SIZEOF_NDK_STATISTICS_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NDK_STATISTICS_INFO, CounterSet) + +#include +#include + +typedef struct _NDIS_NDK_CONNECTION_ENTRY { + SOCKADDR_INET Local; // Local IP address and port + SOCKADDR_INET Remote; // Remote IP address and port + BOOLEAN UserModeOwner; // TRUE if NDSPI (user-mode) connection, FALSE if NDKPI (kernel-mode) + ULONG OwnerPid; // Process ID for NDSPI (user-mode) connection +} NDIS_NDK_CONNECTION_ENTRY; + +// +// Structure returned for an OID_NDK_CONNECTIONS request. +// This structure is variable-sized based on the actual number of connections being returned. +// The actual size of the connection array (as element count) is indicated by the Count field. +// If the RDMA technology for the NDK provider requires the provider to map ND connections +// to TCP connections, then the NDK provider must also report the underlying TCP connection +// 4-tuple for each ND connection as follows: set the NDConnectionsMappedtoTCPConnections +// field to TRUE, and use two consecutive entries for each ND connection where the first entry +// contains the ND addressing information (local & remote IP address/ND port number) and +// the immediate next entry contains the corresponding TCP connection's addressing +// information (local & remote IP address/TCP port number). Fields other than addressing +// information (UserModeOwner, OwnerPid) must be set only in the first entry, and left +// untouched in the next entry. So, entries at index 0, 2, 4, ... will contain ND addressing info (plus +// properly filled-in other fields) and entries at index 1, 3, 5, ... will contain TCP addressing info +// (where other fields are left untouched) when NDConnectionsMappedtoTCPConnections is set to TRUE. +// + +#define NDIS_NDK_CONNECTIONS_REVISION_1 1 + +typedef struct _NDIS_NDK_CONNECTIONS { + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_NDK_CONNECTIONS_REVISION_1; + // Header.Size = (USHORT)min(MAXUSHORT, NDIS_SIZEOF_NDK_CONNECTIONS_REVISION_1(n)); + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; // reserved, must be set to 0 + ULONG Count; + BOOLEAN NDConnectionsMappedtoTCPConnections; + _Field_size_(Count) NDIS_NDK_CONNECTION_ENTRY Connections[1]; +} NDIS_NDK_CONNECTIONS; + +#define NDIS_SIZEOF_NDK_CONNECTIONS_REVISION_1(n) \ + FIELD_OFFSET(NDIS_NDK_CONNECTIONS, Connections[n]) + +typedef struct _NDIS_NDK_LOCAL_ENDPOINT_ENTRY { + SOCKADDR_INET Local; // Local IP address and port + BOOLEAN UserModeOwner; // TRUE if NDSPI (user-mode) listener, FALSE if NDKPI (kernel-mode) + BOOLEAN Listener; // TRUE if a listener, FALSE if a SharedEndpoint (used for connections) + ULONG OwnerPid; // Process ID for NDSPI (user-mode) local endpoint +} NDIS_NDK_LOCAL_ENDPOINT_ENTRY; + +// +// Structure returned for an OID_NDK_LOCAL_ENDPOINTS request. +// This structure is variable-sized based on the actual number of local endpoints being returned. +// The actual size of the local endpoint array (as element count) is indicated by the Count field. +// If the RDMA technology for the NDK provider requires the provider to map ND local endpoints +// to TCP local endpoints, then the NDK provider must also report the underlying TCP local endpoint +// for each ND local endpoint as follows: set the NDLocalEndpointsMappedtoTCPLocalEndpoints +// field to TRUE, and use two consecutive entries for each ND local endpoint where the first entry +// contains the ND addressing information (local IP address/ND port number) and +// the immediate next entry contains the corresponding TCP local endpoint's addressing +// information (local IP address/TCP port number). Fields other than addressing +// information (UserModeOwner, Listener, OwnerPid) must be set only in the first entry, and left +// untouched in the next entry. So, entries at index 0, 2, 4, ... will contain ND addressing info (plus +// properly filled-in other fields) and entries at index 1, 3, 5, ... will contain TCP addressing info +// (where other fields are left untouched) when NDLocalEndpointsMappedtoTCPLocalEndpoints is set to TRUE. +// + +#define NDIS_NDK_LOCAL_ENDPOINTS_REVISION_1 1 + +typedef struct _NDIS_NDK_LOCAL_ENDPOINTS { + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_NDK_LOCAL_ENDPOINTS_REVISION_1; + // Header.Size = (USHORT)min(MAXUSHORT, NDIS_SIZEOF_NDK_LOCAL_ENDPOINTS_REVISION_1(n)); + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; // reserved, must be set to 0 + ULONG Count; + BOOLEAN NDLocalEndpointsMappedtoTCPLocalEndpoints; + _Field_size_(Count) NDIS_NDK_LOCAL_ENDPOINT_ENTRY LocalEndpoints[1]; +} NDIS_NDK_LOCAL_ENDPOINTS; + +#define NDIS_SIZEOF_NDK_LOCAL_ENDPOINTS_REVISION_1(n) \ + FIELD_OFFSET(NDIS_NDK_LOCAL_ENDPOINTS, LocalEndpoints[n]) + + +// +// Quality of Service (QoS) OIDs +// +#define OID_QOS_HARDWARE_CAPABILITIES 0xFC050001 // query only +#define OID_QOS_CURRENT_CAPABILITIES 0xFC050002 // query only +#define OID_QOS_PARAMETERS 0xFC050003 // method only +#define OID_QOS_OPERATIONAL_PARAMETERS 0xFC050004 // query only +#define OID_QOS_REMOTE_PARAMETERS 0xFC050005 // query only + + +#define NDIS_QOS_MAXIMUM_PRIORITIES 8 +#define NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES 8 + +// +// The following bits are used in NDIS_QOS_CAPABILITIES.Flags field. +// +#define NDIS_QOS_CAPABILITIES_STRICT_TSA_SUPPORTED 0x00000001 +#define NDIS_QOS_CAPABILITIES_MACSEC_BYPASS_SUPPORTED 0x00000002 +#define NDIS_QOS_CAPABILITIES_CEE_DCBX_SUPPORTED 0x00000004 +#define NDIS_QOS_CAPABILITIES_IEEE_DCBX_SUPPORTED 0x00000008 + +#define NDIS_QOS_CAPABILITIES_REVISION_1 1 + +// +// NDIS_QOS_CAPABILITIES is used as the return result of the OID_QOS_CURRENT_CAPABILITIES +// and OID_QOS_HARDWARE_CAPABILITIES OID queries. It is also specified as the +// HardwareQosCapabilities and CurrentQosCapabilities fields in the +// NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES structure. +// +typedef _Struct_size_bytes_(Header.Size) struct _NDIS_QOS_CAPABILITIES +{ + // + // Header.Type = NDIS_OBJECT_TYPE_QOS_CAPABILITIES + // Header.Revision = NDIS_QOS_CAPABILITIES_REVISION_1 + // Header.Size = NDIS_SIZEOF_QOS_CAPABILITIES_REVISION_1 + // + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ ULONG MaxNumTrafficClasses; + _In_ _Field_range_(<=, MaxNumTrafficClasses) + ULONG MaxNumEtsCapableTrafficClasses; + _In_ _Field_range_(<=, MaxNumTrafficClasses) + ULONG MaxNumPfcEnabledTrafficClasses; +} NDIS_QOS_CAPABILITIES, *PNDIS_QOS_CAPABILITIES; + +#define NDIS_SIZEOF_QOS_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_CAPABILITIES, MaxNumPfcEnabledTrafficClasses) + +// +// The following bits are used in NDIS_QOS_CLASSIFICATION_ELEMENT.Flags field. +// +#define NDIS_QOS_CLASSIFICATION_SET_BY_MINIPORT_MASK 0xFF000000 // Mask of flags set by miniport only +#define NDIS_QOS_CLASSIFICATION_ENFORCED_BY_MINIPORT 0x01000000 // Set by miniport + +// +// The following values are used in +// NDIS_QOS_CLASSIFICATION_ELEMENT.ConditionSelector field. +// +#define NDIS_QOS_CONDITION_RESERVED 0x0 +#define NDIS_QOS_CONDITION_DEFAULT 0x1 +#define NDIS_QOS_CONDITION_TCP_PORT 0x2 +#define NDIS_QOS_CONDITION_UDP_PORT 0x3 +#define NDIS_QOS_CONDITION_TCP_OR_UDP_PORT 0x4 +#define NDIS_QOS_CONDITION_ETHERTYPE 0x5 +#define NDIS_QOS_CONDITION_NETDIRECT_PORT 0x6 +#define NDIS_QOS_CONDITION_MAXIMUM 0x7 + +// +// The following values are used in +// NDIS_QOS_CLASSIFICATION_ELEMENT.ActionSelector field. +// +#define NDIS_QOS_ACTION_PRIORITY 0x0 // 802.1p priority tagging +#define NDIS_QOS_ACTION_MAXIMUM 0x1 + +#define NDIS_QOS_CLASSIFICATION_ELEMENT_REVISION_1 1 + +// +// NDIS_QOS_CLASSIFICATION_ELEMENT elements are specified by +// NDIS_QOS_PARAMETERS.FirstClassificationElementOffset. +// +typedef _Struct_size_bytes_(Header.Size) struct _NDIS_QOS_CLASSIFICATION_ELEMENT +{ + // + // Header.Type = NDIS_OBJECT_TYPE_QOS_CLASSIFICATION_ELEMENT + // Header.Revision = NDIS_QOS_CLASSIFICATION_ELEMENT_REVISION_1 + // Header.Size = NDIS_SIZEOF_QOS_CLASSIFICATION_ELEMENT_REVISION_1 + // + _In_ NDIS_OBJECT_HEADER Header; + _Inout_ ULONG Flags; + + _In_ _Field_range_(<, NDIS_QOS_CONDITION_MAXIMUM) + USHORT ConditionSelector; + _In_ USHORT ConditionField; + + _In_ _Field_range_(<, NDIS_QOS_ACTION_MAXIMUM) + USHORT ActionSelector; + _In_ USHORT ActionField; +} NDIS_QOS_CLASSIFICATION_ELEMENT, *PNDIS_QOS_CLASSIFICATION_ELEMENT; + +#define NDIS_SIZEOF_QOS_CLASSIFICATION_ELEMENT_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_CLASSIFICATION_ELEMENT, ActionField) + + +// +// The following bits are used in NDIS_QOS_PARAMETERS.Flags field. +// +#define NDIS_QOS_PARAMETERS_ETS_CHANGED 0x00000001 // Used in OID_QOS_PARAMETERS, + // optional in NDIS_STATUS_QOS_XXX_PARAMETERS_CHANGE +#define NDIS_QOS_PARAMETERS_ETS_CONFIGURED 0x00000002 +#define NDIS_QOS_PARAMETERS_PFC_CHANGED 0x00000100 // Used in OID_QOS_PARAMETERS, + // optional in NDIS_STATUS_QOS_XXX_PARAMETERS_CHANGE +#define NDIS_QOS_PARAMETERS_PFC_CONFIGURED 0x00000200 +#define NDIS_QOS_PARAMETERS_CLASSIFICATION_CHANGED 0x00010000 // Used in OID_QOS_PARAMETERS, + // optional in NDIS_STATUS_QOS_XXX_PARAMETERS_CHANGE +#define NDIS_QOS_PARAMETERS_CLASSIFICATION_CONFIGURED 0x00020000 +#define NDIS_QOS_PARAMETERS_WILLING 0x80000000 // Used in OID_QOS_PARAMETERS + +// +// The following values are used in NDIS_QOS_PARAMETERS.TsaAssignmentTable field. +// +#define NDIS_QOS_TSA_STRICT 0x0 // Strict priority +#define NDIS_QOS_TSA_CBS 0x1 // Credit-Based Shaper +#define NDIS_QOS_TSA_ETS 0x2 // Enhanced Transmission Selection +#define NDIS_QOS_TSA_MAXIMUM 0x3 + +#define NDIS_QOS_PARAMETERS_REVISION_1 1 + +// +// NDIS_QOS_PARAMETERS is used by OID_QOS_PARAMETERS. +// +typedef _Struct_size_bytes_(Header.Size) struct _NDIS_QOS_PARAMETERS +{ + // + // Header.Type = NDIS_OBJECT_TYPE_QOS_PARAMETERS + // Header.Revision = NDIS_QOS_PARAMETERS_REVISION_1 + // Header.Size = NDIS_SIZEOF_QOS_PARAMETERS_REVISION_1 + sizeof_all_classification_entries + // + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + // + // The following fields are to configure ETS. + // + _In_ _Field_range_(0, NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES) + ULONG NumTrafficClasses; + _In_ UCHAR PriorityAssignmentTable[NDIS_QOS_MAXIMUM_PRIORITIES]; + _In_ UCHAR TcBandwidthAssignmentTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + _In_ UCHAR TsaAssignmentTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + + // + // The following fields are to configure PFC. + // + _In_ _Field_range_(0, (1ul << NDIS_QOS_MAXIMUM_PRIORITIES) - 1) + ULONG PfcEnable; + + // + // The following fields are to configure the packet classification and tagging + // mechanism. + // + // Each element in the array specified by FirstClassificationElementOffset + // is of type NDIS_QOS_CLASSIFICATION_ELEMENT. Each element occupies exactly + // ClassificationElementSize bytes in the array. + // + _In_ ULONG NumClassificationElements; + _In_ ULONG ClassificationElementSize; + _In_ ULONG FirstClassificationElementOffset; +} NDIS_QOS_PARAMETERS, *PNDIS_QOS_PARAMETERS; + +#define NDIS_SIZEOF_QOS_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_PARAMETERS, FirstClassificationElementOffset) + + +typedef NDIS_IF_COUNTED_STRING NDIS_NIC_SWITCH_FRIENDLYNAME, *PNDIS_NIC_SWITCH_FRIENDLYNAME; +typedef NDIS_IF_COUNTED_STRING NDIS_VPORT_NAME, *PNDIS_VPORT_NAME; +typedef USHORT NDIS_SRIOV_FUNCTION_ID, *PNDIS_SRIOV_FUNCTION_ID; +typedef ULONG NDIS_VF_RID, *PNDIS_VF_RID; + +#define NDIS_PF_FUNCTION_ID (USHORT) -1 +#define NDIS_INVALID_VF_FUNCTION_ID (USHORT) -1 +#define NDIS_INVALID_RID (ULONG) -1 +#define NDIS_DEFAULT_VPORT_ID 0 +#define NDIS_INVALID_VPORT_ID (ULONG) -1 + +// +// This is the default switch identifier. This is the only valid +// switch identifier in Windows 8 +// +#define NDIS_DEFAULT_SWITCH_ID 0 +#define NDIS_INVALID_SWITCH_ID (ULONG) -1 + +// +// Enum to specify the type of NIC embedded switch +// Used in SwitchType fields of NDIS_NIC_SWITCH_PARAMETERS and +// NDIS_NIC_SWITCH_PARAMETERS structures +// +typedef enum _NDIS_NIC_SWITCH_TYPE +{ + NdisNicSwitchTypeUnspecified, + NdisNicSwitchTypeExternal, + NdisNicSwitchTypeMax +} NDIS_NIC_SWITCH_TYPE, *PNDIS_NIC_SWITCH_TYPE; + +// +// The following flags are used in NDIS_NIC_SWITCH_PARAMETERS.Flags field +// +#define NDIS_NIC_SWITCH_PARAMETERS_CHANGE_MASK 0xFFFF0000 +#define NDIS_NIC_SWITCH_PARAMETERS_SWITCH_NAME_CHANGED 0x00010000 + + +// +// The following value must be used for +// NDIS_NIC_SWITCH_PARAMETERS.NumQueuePairsForDefaultVPort field when HW vRSS +// is not availabile or not used. +// +#define NDIS_NIC_SWITCH_PARAMETERS_DEFAULT_NUMBER_OF_QUEUE_PAIRS_FOR_DEFAULT_VPORT 1 + +// +// This structure is used in OID_NIC_SWITCH_CREATE_SWITCH and OID_NIC_SWITCH_PARAMETERS OIDs +// +#define NDIS_NIC_SWITCH_PARAMETERS_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_NIC_SWITCH_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS660) + +typedef struct _NDIS_NIC_SWITCH_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_TYPE SwitchType; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_NIC_SWITCH_FRIENDLYNAME SwitchFriendlyName; + _In_ ULONG NumVFs; + _In_ ULONG NdisReserved1; + _In_ ULONG NdisReserved2; + _In_ ULONG NdisReserved3; +#if (NDIS_SUPPORT_NDIS660) + _In_ ULONG NumQueuePairsForDefaultVPort; +#endif // (NDIS_SUPPORT_NDIS660) +} NDIS_NIC_SWITCH_PARAMETERS, *PNDIS_NIC_SWITCH_PARAMETERS; + +#define NDIS_SIZEOF_NIC_SWITCH_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_PARAMETERS, NdisReserved3) + +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_SIZEOF_NIC_SWITCH_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_PARAMETERS, NumQueuePairsForDefaultVPort) +#endif // (NDIS_SUPPORT_NDIS660) + + +// +// This structure is used in OID_NIC_SWITCH_DELETE_SWITCH OID +// +#define NDIS_NIC_SWITCH_DELETE_SWITCH_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_DELETE_SWITCH_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; +} NDIS_NIC_SWITCH_DELETE_SWITCH_PARAMETERS, *PNDIS_NIC_SWITCH_DELETE_SWITCH_PARAMETERS ; + +#define NDIS_SIZEOF_NIC_SWITCH_DELETE_SWITCH_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_DELETE_SWITCH_PARAMETERS, SwitchId) + +// +// This structure is used for each array element in +// NDIS_NIC_SWITCH_INFO_ARRAY structure +// +#define NDIS_NIC_SWITCH_INFO_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_TYPE SwitchType; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_NIC_SWITCH_FRIENDLYNAME SwitchFriendlyName; + _In_ ULONG NumVFs; + _In_ ULONG NumAllocatedVFs; + _In_ ULONG NumVPorts; + _In_ ULONG NumActiveVPorts; + _In_ ULONG NumQueuePairsForDefaultVPort; + _In_ ULONG NumQueuePairsForNonDefaultVPorts; + _In_ ULONG NumActiveDefaultVPortMacAddresses; + _In_ ULONG NumActiveNonDefaultVPortMacAddresses; + _In_ ULONG NumActiveDefaultVPortVlanIds; + _In_ ULONG NumActiveNonDefaultVPortVlanIds; +}NDIS_NIC_SWITCH_INFO, *PNDIS_NIC_SWITCH_INFO; + +#define NDIS_SIZEOF_NIC_SWITCH_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_INFO, NumActiveNonDefaultVPortVlanIds) + +// +// This structure is used in OID_NIC_SWITCH_ENUM_SWITCHES OID and in +// NicSwitches field of NDIS_BIND_PARAMETERS and NDIS_FILTER_ATTACH_PARAMETERS structures. +// Each element in the array is of type NDIS_NIC_SWITCH_INFO structure +// +#define NDIS_NIC_SWITCH_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_INFO_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG FirstElementOffset; + ULONG NumElements; + ULONG ElementSize; +}NDIS_NIC_SWITCH_INFO_ARRAY, *PNDIS_NIC_SWITCH_INFO_ARRAY; + +#define NDIS_SIZEOF_NIC_SWITCH_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_INFO_ARRAY, ElementSize) + +// +// The following enum type is used in VPortState field of +// NDIS_NIC_SWITCH_VPORT_INFO and NDIS_NIC_SWITCH_VPORT_PARAMETERS +// +typedef enum _NDIS_NIC_SWITCH_VPORT_STATE +{ + NdisNicSwitchVPortStateUndefined, + NdisNicSwitchVPortStateActivated, + NdisNicSwitchVPortStateDeactivated, + NdisNicSwitchVPortStateMaximum +}NDIS_NIC_SWITCH_VPORT_STATE, *PNDIS_NIC_SWITCH_VPORT_STATE; + +// +// The following enum type is used in InterruptModeration field of +// NDIS_NIC_SWITCH_VPORT_INFO and NDIS_NIC_SWITCH_VPORT_PARAMETERS +// +typedef enum _NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION +{ + NdisNicSwitchVPortInterruptModerationUndefined = 0, + NdisNicSwitchVPortInterruptModerationAdaptive = 1, + NdisNicSwitchVPortInterruptModerationOff = 2, + NdisNicSwitchVPortInterruptModerationLow = 100, + NdisNicSwitchVPortInterruptModerationMedium = 200, + NdisNicSwitchVPortInterruptModerationHigh = 300, +}NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION, *PNDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION; + +#if (NDIS_SUPPORT_NDIS650) +// +// NDIS_SWITCH_PORT_ID and NDIS_SWITCH_NIC_INDEX are needed +// in user and kernel level headers without a common include, +// so it is defined in multiple places. +// +#ifndef _NDIS_SWITCH_PORT_ID +#define _NDIS_SWITCH_PORT_ID NDIS_SWITCH_PORT_ID +typedef UINT32 NDIS_SWITCH_PORT_ID, *PNDIS_SWITCH_PORT_ID; +typedef USHORT NDIS_SWITCH_NIC_INDEX, *PNDIS_SWITCH_NIC_INDEX; +#else +// +// If already defined, make sure sizes match. +// +C_ASSERT(sizeof(NDIS_SWITCH_PORT_ID) == sizeof(UINT32)); +C_ASSERT(sizeof(NDIS_SWITCH_NIC_INDEX) == sizeof(USHORT)); +#endif + +typedef struct _NDIS_NDK_REQUEST_PARAMETERS { + BOOLEAN RdmaRequested; + NDIS_SWITCH_PORT_ID SwitchPortId; + NET_IFINDEX IfIndex; + UCHAR MacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + UINT32 VlanId; + NDIS_NDK_CAPABILITIES NdkReserved; +} NDIS_NDK_REQUEST_PARAMETERS, *PNDIS_NDK_REQUEST_PARAMETERS; + +typedef struct _NDIS_NDK_RESPONSE_PARAMETERS { + BOOLEAN CapabilitiesAvailable; + NDIS_NDK_CAPABILITIES ReceivedCapabilities; +} NDIS_NDK_RESPONSE_PARAMETERS, *PNDIS_NDK_RESPONSE_PARAMETERS; + +typedef struct _NDIS_NDK_PARAMETERS { + NDIS_NDK_REQUEST_PARAMETERS NdkRequest; + NDIS_NDK_RESPONSE_PARAMETERS NdkResponse; +} NDIS_NDK_PARAMETERS,*PNDIS_NDK_PARAMETERS; +#endif // NDIS_SUPPORT_NDIS650 + +// +// These flags are used in NDIS_NIC_SWITCH_VPORT_PARAMETERS.Flags field +// +#define NDIS_NIC_SWITCH_VPORT_PARAMS_LOOKAHEAD_SPLIT_ENABLED 0x00000001 + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_NIC_SWITCH_VPORT_PARAMS_PACKET_DIRECT_RX_ONLY 0x00000002 +#endif // (NDIS_SUPPORT_NDIS650) + +#define NDIS_NIC_SWITCH_VPORT_PARAMS_ENFORCE_MAX_SG_LIST 0x00008000 + +#define NDIS_NIC_SWITCH_VPORT_PARAMS_CHANGE_MASK 0xFFFF0000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_FLAGS_CHANGED 0x00010000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_NAME_CHANGED 0x00020000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_INT_MOD_CHANGED 0x00040000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_STATE_CHANGED 0x00080000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_PROCESSOR_AFFINITY_CHANGED 0x00100000 +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_NIC_SWITCH_VPORT_PARAMS_NDK_PARAMS_CHANGED 0x00200000 +#define NDIS_NIC_SWITCH_VPORT_PARAMS_QOS_SQ_ID_CHANGED 0x00400000 +#endif // (NDIS_SUPPORT_NDIS650) +#if (NDIS_SUPPORT_NDIS660) +#define NDIS_NIC_SWITCH_VPORT_PARAMS_NUM_QUEUE_PAIRS_CHANGED 0x00800000 +#endif // (NDIS_SUPPORT_NDIS660) + +// +// This structure is used in OID_NIC_SWITCH_CREATE_VPORT and +// OID_NIC_SWITCH_VPORT_PARAMETERS +// +#define NDIS_NIC_SWITCH_VPORT_PARAMETERS_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_NIC_SWITCH_VPORT_PARAMETERS_REVISION_2 2 +#endif // NDIS_SUPPORT_NDIS650 + +typedef struct _NDIS_NIC_SWITCH_VPORT_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _Inout_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + _In_ NDIS_VPORT_NAME VPortName; + _In_ NDIS_SRIOV_FUNCTION_ID AttachedFunctionId; + _In_ ULONG NumQueuePairs; + _In_ NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION InterruptModeration; + _In_ NDIS_NIC_SWITCH_VPORT_STATE VPortState; + _In_ GROUP_AFFINITY ProcessorAffinity; + _In_ ULONG LookaheadSize; +#if (NDIS_SUPPORT_NDIS650) + _In_ NDIS_NDK_PARAMETERS NdkParams; + _In_ NDIS_QOS_SQ_ID QosSqId; +#endif // (NDIS_SUPPORT_NDIS650) +}NDIS_NIC_SWITCH_VPORT_PARAMETERS, *PNDIS_NIC_SWITCH_VPORT_PARAMETERS; + +#define NDIS_SIZEOF_NIC_SWITCH_VPORT_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VPORT_PARAMETERS, LookaheadSize) + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_SIZEOF_NIC_SWITCH_VPORT_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VPORT_PARAMETERS, QosSqId) +#endif // (NDIS_SUPPORT_NDIS650) + +// +// This structure is used in OID_NIC_SWITCH_DELETE_VPORT OID +// +#define NDIS_NIC_SWITCH_DELETE_VPORT_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_DELETE_VPORT_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; +} NDIS_NIC_SWITCH_DELETE_VPORT_PARAMETERS, *PNDIS_NIC_SWITCH_DELETE_VPORT_PARAMETERS ; + +#define NDIS_SIZEOF_NIC_SWITCH_DELETE_VPORT_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_DELETE_VPORT_PARAMETERS, VPortId) + +// +// Flags used in NDIS_NIC_SWITCH_VPORT_INFO.Flags field +// +#define NDIS_NIC_SWITCH_VPORT_INFO_LOOKAHEAD_SPLIT_ENABLED 0x00000001 + +#if (NDIS_SUPPORT_NDIS650) +#define NDIS_NIC_SWITCH_VPORT_INFO_PACKET_DIRECT_RX_ONLY 0x00000002 +#define NDIS_NIC_SWITCH_VPORT_INFO_GFT_ENABLED 0x00000004 +#endif // (NDIS_SUPPORT_NDIS650) + + +// +// This structure is used in OID_NIC_SWITCH_ENUM_VPORTS OID +// Each element in the array is of type NDIS_NIC_SWITCH_VPORT_INFO structure +// +#define NDIS_NIC_SWITCH_VPORT_INFO_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_VPORT_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_VPORT_NAME VPortName; + _In_ NDIS_SRIOV_FUNCTION_ID AttachedFunctionId; + _In_ ULONG NumQueuePairs; + _In_ NDIS_NIC_SWITCH_VPORT_INTERRUPT_MODERATION InterruptModeration; + _In_ NDIS_NIC_SWITCH_VPORT_STATE VPortState; + _In_ GROUP_AFFINITY ProcessorAffinity; + _In_ ULONG LookaheadSize; + _In_ ULONG NumFilters; + +}NDIS_NIC_SWITCH_VPORT_INFO, *PNDIS_NIC_SWITCH_VPORT_INFO; + +#define NDIS_SIZEOF_NIC_SWITCH_VPORT_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VPORT_INFO, NumFilters) + +// +// The following flags are used in NDIS_NIC_SWITCH_VPORT_INFO_ARRAY.Flags field +// +#define NDIS_NIC_SWITCH_VPORT_INFO_ARRAY_ENUM_ON_SPECIFIC_FUNCTION 0x00000001 +#define NDIS_NIC_SWITCH_VPORT_INFO_ARRAY_ENUM_ON_SPECIFIC_SWITCH 0x00000002 +// +// This structure is used in OID_NIC_SWITCH_ENUM_VPORTS OID +// Each element in the array is of type NDIS_NIC_SWITCH_VPORT_INFO structure +// +#define NDIS_NIC_SWITCH_VPORT_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_VPORT_INFO_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_SRIOV_FUNCTION_ID AttachedFunctionId; + _In_ ULONG FirstElementOffset; + _In_ ULONG NumElements; + _In_ ULONG ElementSize; +}NDIS_NIC_SWITCH_VPORT_INFO_ARRAY, *PNDIS_NIC_SWITCH_VPORT_INFO_ARRAY; + +#define NDIS_SIZEOF_NIC_SWITCH_VPORT_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VPORT_INFO_ARRAY, ElementSize) + +// +// This structure is used in OID_NIC_SWITCH_ALLOCATE_VF and +// OID_NIC_SWITCH_VF_PARAMETERS OIDs +// + +#define NDIS_NIC_SWITCH_VF_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_VF_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_VM_NAME VMName; + _In_ NDIS_VM_FRIENDLYNAME VMFriendlyName; + _In_ NDIS_SWITCH_NIC_NAME NicName; + _In_ USHORT MacAddressLength; + _In_ UCHAR PermanentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + _In_ UCHAR CurrentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + _Inout_ NDIS_SRIOV_FUNCTION_ID VFId; + _Inout_ NDIS_VF_RID RequestorId; +} NDIS_NIC_SWITCH_VF_PARAMETERS, *PNDIS_NIC_SWITCH_VF_PARAMETERS; + +#define NDIS_SIZEOF_NIC_SWITCH_VF_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VF_PARAMETERS, RequestorId) + +// +// This structure is used in OID_NIC_SWITCH_FREE_VF OID +// +#define NDIS_NIC_SWITCH_FREE_VF_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_FREE_VF_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; +} NDIS_NIC_SWITCH_FREE_VF_PARAMETERS, *PNDIS_NIC_SWITCH_FREE_VF_PARAMETERS; + +#define NDIS_SIZEOF_NIC_SWITCH_FREE_VF_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_FREE_VF_PARAMETERS, VFId) + +// +// Thus structure is used in OID_NIC_SWITCH_ENUM_VFS OID +// Each element in the array is of type NDIS_NIC_SWITCH_VF_INFO structure +// +#define NDIS_NIC_SWITCH_VF_INFO_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_VF_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _In_ NDIS_VM_NAME VMName; + _In_ NDIS_VM_FRIENDLYNAME VMFriendlyName; + _In_ NDIS_SWITCH_NIC_NAME NicName; + _In_ USHORT MacAddressLength; + _In_ UCHAR PermanentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + _In_ UCHAR CurrentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ NDIS_VF_RID RequestorId; +} NDIS_NIC_SWITCH_VF_INFO, *PNDIS_NIC_SWITCH_VF_INFO; + +#define NDIS_SIZEOF_NIC_SWITCH_VF_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VF_INFO, RequestorId) + +// +// The following flags are used in _NDIS_NIC_SWITCH_VF_INFO_ARRAY.Flags field +// +#define NDIS_NIC_SWITCH_VF_INFO_ARRAY_ENUM_ON_SPECIFIC_SWITCH 0x00000001 + +// +// This structure is used in OID_NIC_SWITCH_ENUM_VFS OID +// Each element in the array is of type NDIS_NIC_SWITCH_VF_INFO structure +// +#define NDIS_NIC_SWITCH_VF_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_NIC_SWITCH_VF_INFO_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_ID SwitchId; + _Out_ ULONG FirstElementOffset; + _Out_ ULONG NumElements; + _Out_ ULONG ElementSize; +}NDIS_NIC_SWITCH_VF_INFO_ARRAY, *PNDIS_NIC_SWITCH_VF_INFO_ARRAY; + +#define NDIS_SIZEOF_NIC_SWITCH_VF_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_NIC_SWITCH_VF_INFO_ARRAY, ElementSize) + +// +// Following flags are used in NDIS_SRIOV_CAPABILITIES.SriovCapabilities field +// +#define NDIS_SRIOV_CAPS_SRIOV_SUPPORTED 0x00000001 +#define NDIS_SRIOV_CAPS_PF_MINIPORT 0x00000002 +#define NDIS_SRIOV_CAPS_VF_MINIPORT 0x00000004 + +// +// This structure is used in OID_SRIOV_CURRENT_CAPABILITIES and OID_SRIOV_HARDWARE_CAPABILITIES. +// It is also used in the CurrentSriovCapabilities and HardwareSriovCapabilities fields of +// NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES structure . +// It is also used in SriovCapabilities field of NDIS_BIND_PARAMETERS and NDIS_FILTER_ATTACH_PARAMETERS +// +#define NDIS_SRIOV_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_SRIOV_CAPABILITIES +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ ULONG SriovCapabilities; +} NDIS_SRIOV_CAPABILITIES, *PNDIS_SRIOV_CAPABILITIES; + +#define NDIS_SIZEOF_SRIOV_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_CAPABILITIES, SriovCapabilities) + +// +// This structure is used in OID_SRIOV_READ_VF_CONFIG_SPACE +// +#define NDIS_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ ULONG Offset; + _In_ ULONG Length; + _In_ ULONG BufferOffset; +} NDIS_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS, *PNDIS_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_READ_VF_CONFIG_SPACE_PARAMETERS, BufferOffset) + +// +// This structure is used in OID_SRIOV_WRITE_VF_CONFIG_SPACE +// +#define NDIS_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ ULONG Offset; + _In_ ULONG Length; + _In_ ULONG BufferOffset; +} NDIS_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS, *PNDIS_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_WRITE_VF_CONFIG_SPACE_PARAMETERS, BufferOffset) + +// +// This structure is used in OID_SRIOV_READ_VF_CONFIG_BLOCK +// +#define NDIS_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ ULONG BlockId; + _In_ ULONG Length; + _In_ ULONG BufferOffset; +} NDIS_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS, *PNDIS_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_READ_VF_CONFIG_BLOCK_PARAMETERS, BufferOffset) + +// +// This structure is used in OID_SRIOV_WRITE_VF_CONFIG_BLOCK +// +#define NDIS_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ ULONG BlockId; + _In_ ULONG Length; + _In_ ULONG BufferOffset; +} NDIS_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS, *PNDIS_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_WRITE_VF_CONFIG_BLOCK_PARAMETERS, BufferOffset) + +// +// This structure is used in OID_SRIOV_RESET_VF +// +#define NDIS_SRIOV_RESET_VF_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_RESET_VF_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; +} NDIS_SRIOV_RESET_VF_PARAMETERS, *PNDIS_SRIOV_RESET_VF_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_RESET_VF_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_RESET_VF_PARAMETERS, VFId) + +// +// This structure is used in OID_SRIOV_SET_VF_POWER_STATE +// +#define NDIS_SRIOV_SET_VF_POWER_STATE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_SET_VF_POWER_STATE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ NDIS_DEVICE_POWER_STATE PowerState; + _In_ BOOLEAN WakeEnable; +} NDIS_SRIOV_SET_VF_POWER_STATE_PARAMETERS, *PNDIS_SRIOV_SET_VF_POWER_STATE_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_SET_VF_POWER_STATE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_SET_VF_POWER_STATE_PARAMETERS, WakeEnable) + +// +// This structure is used in OID_SRIOV_CONFIG_STATE +// This can be sent only to the VF miniport driver +// +#define NDIS_SRIOV_CONFIG_STATE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SRIOV_CONFIG_STATE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG BlockId; + _In_ ULONG Length; +} NDIS_SRIOV_CONFIG_STATE_PARAMETERS, *PNDIS_SRIOV_CONFIG_STATE_PARAMETERS; + +#define NDIS_SIZEOF_SRIOV_CONFIG_STATE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_CONFIG_STATE_PARAMETERS, Length) + +// +// This structure is used in OID_SRIOV_VF_VENDOR_DEVICE_ID +// +#define NDIS_SRIOV_VF_VENDOR_DEVICE_ID_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_VF_VENDOR_DEVICE_ID_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _Out_ USHORT VendorId; + _Out_ USHORT DeviceId; +} NDIS_SRIOV_VF_VENDOR_DEVICE_ID_INFO, *PNDIS_SRIOV_VF_VENDOR_DEVICE_ID_INFO; + +#define NDIS_SIZEOF_SRIOV_VF_VENDOR_DEVICE_ID_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_VF_VENDOR_DEVICE_ID_INFO, DeviceId) + +// +// This structure is used in OID_SRIOV_PROBED_BARS +// +#define NDIS_SRIOV_PROBED_BARS_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_PROBED_BARS_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG BaseRegisterValuesOffset; +} NDIS_SRIOV_PROBED_BARS_INFO, *PNDIS_SRIOV_PROBED_BARS_INFO; + +#define NDIS_SIZEOF_SRIOV_PROBED_BARS_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_PROBED_BARS_INFO, BaseRegisterValuesOffset) + +// +// This structure is used in OID_RECEIVE_FILTER_MOVE_FILTER +// +#define NDIS_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_RECEIVE_FILTER_ID FilterId; + _In_ NDIS_RECEIVE_QUEUE_ID SourceQueueId; + _In_ NDIS_NIC_SWITCH_VPORT_ID SourceVPortId; + _In_ NDIS_RECEIVE_QUEUE_ID DestQueueId; + _In_ NDIS_NIC_SWITCH_VPORT_ID DestVPortId; +} NDIS_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS, *PNDIS_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS; + +#define NDIS_SIZEOF_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_RECEIVE_FILTER_MOVE_FILTER_PARAMETERS, DestVPortId) + +// +// This structure is used in OID_SRIOV_BAR_RESOURCES +// +#define NDIS_SRIOV_BAR_RESOURCES_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_BAR_RESOURCES_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ NDIS_SRIOV_FUNCTION_ID VFId; + _In_ USHORT BarIndex; + _In_ ULONG BarResourcesOffset; +} NDIS_SRIOV_BAR_RESOURCES_INFO, *PNDIS_SRIOV_BAR_RESOURCES_INFO; + +#define NDIS_SIZEOF_SRIOV_BAR_RESOURCES_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_BAR_RESOURCES_INFO, BarResourcesOffset) + +// +// This structure is used in OID_SRIOV_PF_LUID +// +#define NDIS_SRIOV_PF_LUID_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_PF_LUID_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _Out_ LUID Luid; +} NDIS_SRIOV_PF_LUID_INFO, *PNDIS_SRIOV_PF_LUID_INFO; + +#define NDIS_SIZEOF_SRIOV_PF_LUID_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_PF_LUID_INFO, Luid) + +// +// This structure is used in OID_SRIOV_VF_SERIAL_NUMBER +// +#define NDIS_SRIOV_VF_SERIAL_NUMBER_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_VF_SERIAL_NUMBER_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _Out_ ULONG SerialNumber; +} NDIS_SRIOV_VF_SERIAL_NUMBER_INFO, *PNDIS_SRIOV_VF_SERIAL_NUMBER_INFO; + +#define NDIS_SIZEOF_SRIOV_VF_SERIAL_NUMBER_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_VF_SERIAL_NUMBER_INFO, SerialNumber) + +// +// This structure is used in OID_SRIOV_VF_INVALIDATE_CONFIG_BLOCK +// +#define NDIS_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO_REVISION_1 1 + +typedef struct _NDIS_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG64 BlockMask; +} NDIS_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO, *PNDIS_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO; + +#define NDIS_SIZEOF_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_VF_INVALIDATE_CONFIG_BLOCK_INFO, BlockMask) + +#if (NDIS_SUPPORT_NDIS670) + +typedef struct _NDIS_SRIOV_OVERLYING_ADAPTER_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG IfIndex; + ULONG NdisReserved1; + ULONG NdisReserved2; +} NDIS_SRIOV_OVERLYING_ADAPTER_INFO, *PNDIS_SRIOV_OVERLYING_ADAPTER_INFO; + +#define NDIS_SRIOV_OVERLYING_ADAPTER_INFO_VERSION_1 1 + +#define NDIS_SIZEOF_SRIOV_OVERLYING_ADAPTER_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SRIOV_OVERLYING_ADAPTER_INFO, NdisReserved2) + +#endif //(NDIS_SUPPORT_NDIS670) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) || (NDIS_SUPPORT_NDIS640) + +// +// Supported isolation modes. +// +typedef enum _NDIS_ISOLATION_MODE +{ + NdisIsolationModeNone = 0, + // + // VirtualSubnetId based isolation provided by + // in-box by Windows Network Virtualization. + // + NdisIsolationModeNativeVirtualSubnet = 1, + // + // VirtualSubnetId based isolation provided by a + // switch extension. + // + NdisIsolationModeExternalVirtualSubnet = 2, + // + // VLAN based isolation. + // + NdisIsolationModeVlan = 3, +} NDIS_ISOLATION_MODE, *PNDIS_ISOLATION_MODE; + +typedef GUID NDIS_ROUTING_DOMAIN_ID, *PNDIS_ROUTING_DOMAIN_ID; + +#define NDIS_ISOLATION_NAME_MAX_STRING_SIZE 127 +typedef struct _NDIS_ISOLATION_NAME +{ + USHORT Length; // in -Bytes- + WCHAR String[NDIS_ISOLATION_NAME_MAX_STRING_SIZE + 1]; +} NDIS_ISOLATION_NAME; + +typedef NDIS_ISOLATION_NAME NDIS_ISOLATION_ID_NAME, *PNDIS_ISOLATION_ID_NAME; +typedef NDIS_ISOLATION_NAME NDIS_ROUTING_DOMAIN_NAME, *PNDIS_ROUTING_DOMAIN_NAME; + +// +// Information relating to a single Isolation ID within a +// Routing domain. +// +typedef struct _NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_ISOLATION_ID_NAME IsolationIdName; + union + { + struct + { + UINT32 VirtualSubnetId:24; + }; + struct + { + UINT32 VlanId:12; + }; + UINT32 IsolationId; + }; +} NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY, *PNDIS_ROUTING_DOMAIN_ISOLATION_ENTRY; + +#define NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY, IsolationId) + +// +// Retrieves the next NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY object in the list. +// +#define NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY_GET_NEXT(_IsolationInfoEntry_)\ + ((PNDIS_ROUTING_DOMAIN_ISOLATION_ENTRY)((PUCHAR)(_IsolationInfoEntry_) +\ + (_IsolationInfoEntry_)->Header.Size)) + +// +// Information relating to a single Routing Domain entry. +// +typedef struct _NDIS_ROUTING_DOMAIN_ENTRY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_ROUTING_DOMAIN_ID RoutingDomainId; + NDIS_ROUTING_DOMAIN_NAME RoutingDomainName; + ULONG NumIsolationEntries; + + ULONG FirstIsolationEntryOffset; +} NDIS_ROUTING_DOMAIN_ENTRY, *PNDIS_ROUTING_DOMAIN_ENTRY; + +#define NDIS_ROUTING_DOMAIN_ENTRY_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_ROUTING_DOMAIN_ENTRY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_ROUTING_DOMAIN_ENTRY, FirstIsolationEntryOffset) + +// +// Retrieves the next NDIS_ROUTING_DOMAIN_ENTRY object in the list. +// +#define NDIS_ROUTING_DOMAIN_ENTRY_GET_NEXT(_RoutingDomainEntry_)\ + ((PNDIS_ROUTING_DOMAIN_ENTRY)((PUCHAR)(_RoutingDomainEntry_) +\ + (_RoutingDomainEntry_)->Header.Size)) + +// +// Retrieves the first NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY object in the Isolation info. +// +#define NDIS_ROUTING_DOMAIN_ENTRY_GET_FIRST_ISOLATION_ENTRY(_RoutingDomainEntry_)\ + ((PNDIS_ROUTING_DOMAIN_ISOLATION_ENTRY)((PUCHAR)(_RoutingDomainEntry_) + \ + (_RoutingDomainEntry_)->FirstIsolationEntryOffset)) + +// +// Isolation configuration for a given network adapter. +// +typedef struct _NDIS_ISOLATION_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_ISOLATION_MODE IsolationMode; + BOOLEAN AllowUntaggedTraffic; + ULONG NumRoutingDomainEntries; + ULONG FirstRoutingDomainEntryOffset; +} NDIS_ISOLATION_PARAMETERS, *PNDIS_ISOLATION_PARAMETERS; + +#define NDIS_ISOLATION_PARAMETERS_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_ISOLATION_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_ISOLATION_PARAMETERS, FirstRoutingDomainEntryOffset) + +// +// Retrieves the first NDIS_ROUTING_DOMAIN_ENTRY object in the isolation info. +// +#define NDIS_ISOLATION_PARAMETERS_GET_FIRST_ROUTING_DOMAIN_ENTRY(_MultiTenancyInfo_)\ + ((PNDIS_ROUTING_DOMAIN_ENTRY)((PUCHAR)(_MultiTenancyInfo_) + \ + (_MultiTenancyInfo_)->FirstRoutingDomainEntryOffset)) + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) || (NDIS_SUPPORT_NDIS640) + +// +// NDIS_SWITCH_PORT_ID and NDIS_SWITCH_NIC_INDEX are needed +// in user and kernel level headers without a common include, +// so it is defined in multiple places. +// +#ifndef _NDIS_SWITCH_PORT_ID +#define _NDIS_SWITCH_PORT_ID NDIS_SWITCH_PORT_ID +typedef UINT32 NDIS_SWITCH_PORT_ID, *PNDIS_SWITCH_PORT_ID; +typedef USHORT NDIS_SWITCH_NIC_INDEX, *PNDIS_SWITCH_NIC_INDEX; +#else +// +// If already defined, make sure sizes match. +// +C_ASSERT(sizeof(NDIS_SWITCH_PORT_ID) == sizeof(UINT32)); +C_ASSERT(sizeof(NDIS_SWITCH_NIC_INDEX) == sizeof(USHORT)); +#endif + +typedef GUID NDIS_SWITCH_OBJECT_INSTANCE_ID, *PNDIS_SWITCH_OBJECT_INSTANCE_ID; +typedef GUID NDIS_SWITCH_OBJECT_ID, *PNDIS_SWITCH_OBJECT_ID; +typedef USHORT NDIS_SWITCH_OBJECT_VERSION, *PNDIS_SWITCH_OBJECT_VERSION; +typedef USHORT NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION, *PNDIS_SWITCH_OBJECT_SERIALIZATION_VERSION; + +#define NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION_1 1 + +typedef enum _NDIS_SWITCH_PORT_PROPERTY_TYPE +{ + NdisSwitchPortPropertyTypeUndefined, + NdisSwitchPortPropertyTypeCustom, + NdisSwitchPortPropertyTypeSecurity, + NdisSwitchPortPropertyTypeVlan, + NdisSwitchPortPropertyTypeProfile, + NdisSwitchPortPropertyTypeIsolation, + NdisSwitchPortPropertyTypeRoutingDomain, + NdisSwitchPortPropertyTypeMaximum +} NDIS_SWITCH_PORT_PROPERTY_TYPE, *PNDIS_SWITCH_PORT_PROPERTY_TYPE; + +// +// This structure is used for NdisSwitchPortPropertyTypeSecurity. +// + +#define NDIS_SWITCH_PORT_PROPERTY_SECURITY_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS640) +#define NDIS_SWITCH_PORT_PROPERTY_SECURITY_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS640) + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_SECURITY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + BOOLEAN AllowMacSpoofing; + BOOLEAN AllowIeeePriorityTag; + UINT32 VirtualSubnetId; + BOOLEAN AllowTeaming; + +#if (NDIS_SUPPORT_NDIS640) + UINT32 DynamicIPAddressLimit; +#endif // (NDIS_SUPPORT_NDIS640) + +} NDIS_SWITCH_PORT_PROPERTY_SECURITY, *PNDIS_SWITCH_PORT_PROPERTY_SECURITY; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_SECURITY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_SECURITY, AllowTeaming) + +#if (NDIS_SUPPORT_NDIS640) +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_SECURITY_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_SECURITY, DynamicIPAddressLimit) +#endif // (NDIS_SUPPORT_NDIS640) + +typedef enum _NDIS_SWITCH_PORT_VLAN_MODE +{ + NdisSwitchPortVlanModeUnknown = 0, + NdisSwitchPortVlanModeAccess = 1, + NdisSwitchPortVlanModeTrunk = 2, + NdisSwitchPortVlanModePrivate = 3, + NdisSwitchPortVlanModeMax = 4 +} NDIS_SWITCH_PORT_VLAN_MODE, *PNDIS_SWITCH_PORT_VLAN_MODE; + +typedef enum _NDIS_SWITCH_PORT_PVLAN_MODE +{ + NdisSwitchPortPvlanModeUndefined = 0, + NdisSwitchPortPvlanModeIsolated, + NdisSwitchPortPvlanModeCommunity, + NdisSwitchPortPvlanModePromiscuous +} NDIS_SWITCH_PORT_PVLAN_MODE, *PNDIS_SWITCH_PORT_PVLAN_MODE; + +// +// This structure is used for NdisSwitchPortPropertyTypeVlan. +// + +#define NDIS_SWITCH_PORT_PROPERTY_VLAN_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_VLAN +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + NDIS_SWITCH_PORT_VLAN_MODE OperationMode; + union + { + struct + { + UINT16 AccessVlanId; + UINT16 NativeVlanId; + UINT64 PruneVlanIdArray[64]; + UINT64 TrunkVlanIdArray[64]; + } VlanProperties; + struct + { + NDIS_SWITCH_PORT_PVLAN_MODE + PvlanMode; + UINT16 PrimaryVlanId; + union + { + UINT16 SecondaryVlanId; + UINT64 SecondaryVlanIdArray[64]; + }; + } PvlanProperties; + }; +} NDIS_SWITCH_PORT_PROPERTY_VLAN, *PNDIS_SWITCH_PORT_PROPERTY_VLAN; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_VLAN_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_VLAN, VlanProperties) + +// +// This structure is used for NdisSwitchPortPropertyTypeProfile. +// + +#define NDIS_SWITCH_PORT_PROPERTY_PROFILE_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_PROFILE +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_PROPERTY_PROFILE_NAME ProfileName; + GUID ProfileId; + NDIS_VENDOR_NAME VendorName; + GUID VendorId; + UINT32 ProfileData; + GUID NetCfgInstanceId; + struct + { + UINT32 PciSegmentNumber:16; + UINT32 PciBusNumber:8; + UINT32 PciDeviceNumber:5; + UINT32 PciFunctionNumber:3; + } PciLocation; + UINT32 CdnLabelId; + NDIS_SWITCH_PORT_PROPERTY_PROFILE_CDN_LABEL CdnLabel; +} NDIS_SWITCH_PORT_PROPERTY_PROFILE, *PNDIS_SWITCH_PORT_PROPERTY_PROFILE; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_PROFILE, CdnLabel) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) || (NDIS_SUPPORT_NDIS640) + +// +// This structure is used for NdisSwitchPortPropertyTypeIsolation. +// + +#define NDIS_SWITCH_PORT_PROPERTY_ISOLATION_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_ISOLATION +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_ISOLATION_MODE IsolationMode; + BOOLEAN AllowUntaggedTraffic; + UINT32 DefaultIsolationId; +} NDIS_SWITCH_PORT_PROPERTY_ISOLATION, *PNDIS_SWITCH_PORT_PROPERTY_ISOLATION; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_ISOLATION_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_ISOLATION, DefaultIsolationId) + +// +// This structure is used for NdisSwitchPortPropertyTypeRoutingDomain. +// + +#define NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_ROUTING_DOMAIN_ID RoutingDomainId; + NDIS_ROUTING_DOMAIN_NAME RoutingDomainName; + ULONG NumIsolationEntries; + USHORT FirstIsolationEntryOffset; +} NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN, *PNDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN, FirstIsolationEntryOffset) + +// +// Retrieves the first NDIS_ROUTING_DOMAIN_ISOLATION_ENTRY object in the Isolation info. +// +#define NDIS_SWITCH_PORT_PROPERTY_ROUTING_DOMAIN_GET_FIRST_ISOLATION_ENTRY(_RoutingDomainProperty_)\ + ((PNDIS_ROUTING_DOMAIN_ISOLATION_ENTRY)((PUCHAR)(_RoutingDomainProperty_) + \ + (_RoutingDomainProperty_)->FirstIsolationEntryOffset)) + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) || (NDIS_SUPPORT_NDIS640) + +// +// This structure is used for NdisSwitchPortPropertyTypeCustom. +// + +#define NDIS_SWITCH_PORT_PROPERTY_CUSTOM_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_CUSTOM +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; +} NDIS_SWITCH_PORT_PROPERTY_CUSTOM, *PNDIS_SWITCH_PORT_PROPERTY_CUSTOM; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_CUSTOM_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_CUSTOM, PropertyBufferOffset) + +// +// Retrieves the custom property buffer described by the +// NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure. +// +#define NDIS_SWITCH_PORT_PROPERTY_CUSTOM_GET_BUFFER(_PortPropertyCustom_)\ + ((PVOID)((PUCHAR)(_PortPropertyCustom_) + (_PortPropertyCustom_)->PropertyBufferOffset)) + +// +// Since the property buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +C_ASSERT((sizeof(NDIS_SWITCH_PORT_PROPERTY_CUSTOM) % sizeof(UINT64)) == 0); + +// +// This structure is used in OID_SWITCH_PORT_PROPERTY_ADD, +// OID_SWITCH_PORT_PROPERTY_UPDATE. +// + +#define NDIS_SWITCH_PORT_PROPERTY_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_ID PortId; + NDIS_SWITCH_PORT_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_VERSION PropertyVersion; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; + ULONG Reserved; +} NDIS_SWITCH_PORT_PROPERTY_PARAMETERS, *PNDIS_SWITCH_PORT_PROPERTY_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_PARAMETERS, Reserved) + +// +// Returns the property described by the NDIS_SWITCH_PORT_PROPERTY_PARAMETERS structure. +// +#define NDIS_SWITCH_PORT_PROPERTY_PARAMETERS_GET_PROPERTY(_PortParameters_)\ + ((PVOID)((PUCHAR)(_PortParameters_) + (_PortParameters_)->PropertyBufferOffset)) + +// +// Converts the version defined from the property MOF files (e.g. "1.0") to the serialized +// value passed to vSwitch extensions (e.g. 0x100). +// +#define NDIS_SWITCH_CREATE_PROPERTY_VERSION(_VersionMajor_,_VersionMinor_)\ + (((_VersionMajor_) << 8) + (_VersionMinor_)) + +// +// Since the property buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_PORT_PROPERTY_PARAMETERS) % sizeof(UINT64)) == 0); + +// +// This structure is used in OID_SWITCH_PORT_PROPERTY_DELETE. +// + +#define NDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_ID PortId; + NDIS_SWITCH_PORT_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; +} NDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS, *PNDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_DELETE_PARAMETERS, PropertyInstanceId) + +// +// The following structures are used for OID_SWITCH_PORT_PROPERTY_ENUM. +// + +#define NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_ID PortId; + NDIS_SWITCH_PORT_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + ULONG FirstPropertyOffset; + ULONG NumProperties; + USHORT Reserved; +} NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS, *PNDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS, Reserved) + +// +// Retrieves the first NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO object in the enumeration. +// +#define NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS_GET_FIRST_INFO(_PortEnumParams_)\ + ((PNDIS_SWITCH_PORT_PROPERTY_ENUM_INFO)((PUCHAR)(_PortEnumParams_) + \ + (_PortEnumParams_)->FirstPropertyOffset)) + +// +// Since the property buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS) % sizeof(UINT64)) == 0); + +#define NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_OBJECT_VERSION PropertyVersion; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; + ULONG QwordAlignedPropertyBufferLength; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; +} NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO, *PNDIS_SWITCH_PORT_PROPERTY_ENUM_INFO; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO, PropertyBufferOffset) + +// +// Retrieves the next NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO object in the enumeration. +// +#define NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO_GET_NEXT(_PortEnumInfo_)\ + ((PNDIS_SWITCH_PORT_PROPERTY_ENUM_INFO)\ + ((ULONG_PTR)(_PortEnumInfo_) +\ + (_PortEnumInfo_)->QwordAlignedPropertyBufferLength +\ + sizeof(NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO))) + +// +// Returns the property described by the NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO entry. +// +#define NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO_GET_PROPERTY(_PortEnumInfo_)\ + ((PVOID)((PUCHAR)(_PortEnumInfo_) + (_PortEnumInfo_)->PropertyBufferOffset)) + +// +// Since the property buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO) % sizeof(UINT64)) == 0); + +// +// This structure is used in OID_SWITCH_PORT_FEATURE_STATUS_QUERY. +// + +typedef enum _NDIS_SWITCH_PORT_FEATURE_STATUS_TYPE +{ + NdisSwitchPortFeatureStatusTypeUndefined, + NdisSwitchPortFeatureStatusTypeCustom, + NdisSwitchPortFeatureStatusTypeMaximum +} NDIS_SWITCH_PORT_FEATURE_STATUS_TYPE, *PNDIS_SWITCH_PORT_FEATURE_STATUS_TYPE; + +#define NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_ID PortId; + NDIS_SWITCH_PORT_FEATURE_STATUS_TYPE FeatureStatusType; + NDIS_SWITCH_OBJECT_ID FeatureStatusId; + NDIS_SWITCH_OBJECT_VERSION FeatureStatusVersion; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + NDIS_SWITCH_OBJECT_INSTANCE_ID FeatureStatusInstanceId; + ULONG FeatureStatusBufferLength; + ULONG FeatureStatusBufferOffset; + ULONG Reserved; +} NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS, *PNDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS, Reserved) + +// +// Since the resource buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS) % sizeof(UINT64)) == 0); + +// +// Converts the version defined from the property MOF files (e.g. "1.0") to the serialized +// value passed to vSwitch extensions (e.g. 0x100). +// +#define NDIS_SWITCH_CREATE_FEATURE_STATUS_VERSION(_VersionMajor_,_VersionMinor_)\ + (((_VersionMajor_) << 8) + (_VersionMinor_)) + +// +// This structure is used for the resource status for NdisSwitchPortPropertyTypeCustom. +// + +#define NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG FeatureStatusBufferLength; + ULONG FeatureStatusBufferOffset; +} NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM, *PNDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM; + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM, FeatureStatusBufferOffset) + +typedef enum _NDIS_SWITCH_PROPERTY_TYPE +{ + NdisSwitchPropertyTypeUndefined, + NdisSwitchPropertyTypeCustom, + NdisSwitchPropertyTypeMaximum +} NDIS_SWITCH_PROPERTY_TYPE, *PNDIS_SWITCH_PROPERTY_TYPE; + +// +// This structure is used for NdisSwitchPropertyTypeCustom. +// + +#define NDIS_SWITCH_PROPERTY_CUSTOM_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PROPERTY_CUSTOM +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; +} NDIS_SWITCH_PROPERTY_CUSTOM, *PNDIS_SWITCH_PROPERTY_CUSTOM; + +#define NDIS_SIZEOF_NDIS_SWITCH_PROPERTY_CUSTOM_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PROPERTY_CUSTOM, PropertyBufferOffset) + +// +// Retrieves the custom property buffer described by the +// NDIS_SWITCH_PROPERTY_CUSTOM structure. +// +#define NDIS_SWITCH_PROPERTY_CUSTOM_GET_BUFFER(_SwitchPropertyCustom_)\ + ((PVOID)((PUCHAR)(_SwitchPropertyCustom_) + (_SwitchPropertyCustom_)->PropertyBufferOffset)) + + +#define NDIS_SWITCH_PROPERTY_PARAMETERS_REVISION_1 1 + +// +// This structure is used in OID_SWITCH_PROPERTY_ADD and +// OID_SWITCH_PROPERTY_UPDATE +// +typedef struct _NDIS_SWITCH_PROPERTY_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_VERSION PropertyVersion; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; +} NDIS_SWITCH_PROPERTY_PARAMETERS, *PNDIS_SWITCH_PROPERTY_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PROPERTY_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PROPERTY_PARAMETERS, PropertyBufferOffset) + +// +// Returns the property described by the NNDIS_SWITCH_PROPERTY_PARAMETERS structure. +// +#define NDIS_SWITCH_PROPERTY_PARAMETERS_GET_PROPERTY(_SwitchParameters_)\ + ((PVOID)((PUCHAR)(_SwitchParameters_) + (_SwitchParameters_)->PropertyBufferOffset)) + +C_ASSERT((sizeof(NDIS_SWITCH_PROPERTY_PARAMETERS) % sizeof(UINT64)) == 0); + +#define NDIS_SWITCH_PROPERTY_DELETE_PARAMETERS_REVISION_1 1 + +// +// This structure is used in OID_SWITCH_PROPERTY_DELETE. +// +typedef struct _NDIS_SWITCH_PROPERTY_DELETE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; +} NDIS_SWITCH_PROPERTY_DELETE_PARAMETERS, *PNDIS_SWITCH_PROPERTY_DELETE_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PROPERTY_DELETE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PROPERTY_DELETE_PARAMETERS, PropertyInstanceId) + +#define NDIS_SWITCH_PROPERTY_ENUM_INFO_REVISION_1 1 + +// +// This structure is used in OID_SWITCH_PROPERTY_ENUM. +// +typedef struct _NDIS_SWITCH_PROPERTY_ENUM_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_OBJECT_INSTANCE_ID PropertyInstanceId; + NDIS_SWITCH_OBJECT_VERSION PropertyVersion; + ULONG QwordAlignedPropertyBufferLength; + ULONG PropertyBufferLength; + ULONG PropertyBufferOffset; +} NDIS_SWITCH_PROPERTY_ENUM_INFO, *PNDIS_SWITCH_PROPERTY_ENUM_INFO; + +#define NDIS_SIZEOF_NDIS_SWITCH_PROPERTY_ENUM_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PROPERTY_ENUM_INFO, PropertyBufferOffset) + +// +// Retrieves the next NDIS_SWITCH_PROPERTY_ENUM_INFO object in the enumeration. +// +#define NDIS_SWITCH_PROPERTY_ENUM_INFO_GET_NEXT(_SwitchEnumInfo_)\ + ((PNDIS_SWITCH_PROPERTY_ENUM_INFO)\ + ((ULONG_PTR)(_SwitchEnumInfo_) +\ + (_SwitchEnumInfo_)->QwordAlignedPropertyBufferLength +\ + sizeof(NDIS_SWITCH_PROPERTY_ENUM_INFO))) + +// +// Returns the property described by the NDIS_SWITCH_PROPERTY_ENUM_INFO entry. +// +#define NDIS_SWITCH_PROPERTY_ENUM_INFO_GET_PROPERTY(_SwitchEnumInfo_)\ + ((PVOID)((PUCHAR)(_SwitchEnumInfo_) + (_SwitchEnumInfo_)->PropertyBufferOffset)) + +C_ASSERT((sizeof(NDIS_SWITCH_PROPERTY_ENUM_INFO) % sizeof(UINT64)) == 0); + +#define NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS_REVISION_1 1 + +// +// This structure is used in OID_SWITCH_PROPERTY_ENUM. +// +typedef struct _NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PROPERTY_TYPE PropertyType; + NDIS_SWITCH_OBJECT_ID PropertyId; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + ULONG FirstPropertyOffset; + ULONG NumProperties; +} NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS, *PNDIS_SWITCH_PROPERTY_ENUM_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS, NumProperties) + +// +// Retrieves the first NDIS_SWITCH_PROPERTY_ENUM_INFO object in the enumeration. +// +#define NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS_GET_FIRST_INFO(_SwitchEnumParams_)\ + ((PNDIS_SWITCH_PROPERTY_ENUM_INFO)((PUCHAR)(_SwitchEnumParams_) + \ + (_SwitchEnumParams_)->FirstPropertyOffset)) + +// +// Since the resource buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS) % sizeof(UINT64)) == 0); + + +// +// This structure is used in OID_SWITCH_FEATURE_STATUS_QUERY. +// +#define NDIS_SWITCH_FEATURE_STATUS_PARAMETERS_REVISION_1 1 + +typedef enum _NDIS_SWITCH_FEATURE_STATUS_TYPE +{ + NdisSwitchFeatureStatusTypeUndefined, + NdisSwitchFeatureStatusTypeCustom, + NdisSwitchFeatureStatusTypeMaximum +} NDIS_SWITCH_FEATURE_STATUS_TYPE, *PNDIS_SWITCH_FEATURE_STATUS_TYPE; + +typedef struct _NDIS_SWITCH_FEATURE_STATUS_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_FEATURE_STATUS_TYPE FeatureStatusType; + NDIS_SWITCH_OBJECT_ID FeatureStatusId; + NDIS_SWITCH_OBJECT_INSTANCE_ID FeatureStatusInstanceId; + NDIS_SWITCH_OBJECT_VERSION FeatureStatusVersion; + NDIS_SWITCH_OBJECT_SERIALIZATION_VERSION SerializationVersion; + ULONG FeatureStatusBufferOffset; + ULONG FeatureStatusBufferLength; +} NDIS_SWITCH_FEATURE_STATUS_PARAMETERS, *PNDIS_SWITCH_FEATURE_STATUS_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_FEATURE_STATUS_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_FEATURE_STATUS_PARAMETERS, FeatureStatusBufferLength) + +// +// Since the feature status buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_FEATURE_STATUS_PARAMETERS) % sizeof(UINT64)) == 0); + +// +// This structure is used for the resource status for NdisSwitchFeatureStatusTypeCustom. +// +#define NDIS_SWITCH_FEATURE_STATUS_CUSTOM_REVISION_1 1 + +typedef struct _NDIS_SWITCH_FEATURE_STATUS_CUSTOM +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG FeatureStatusCustomBufferLength; + ULONG FeatureStatusCustomBufferOffset; +} NDIS_SWITCH_FEATURE_STATUS_CUSTOM, *PNDIS_SWITCH_FEATURE_STATUS_CUSTOM; + +#define NDIS_SIZEOF_NDIS_SWITCH_FEATURE_STATUS_CUSTOM_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_FEATURE_STATUS_CUSTOM, FeatureStatusCustomBufferOffset) + +// +// Since the feature status buffer may need 8 byte alignment, we require this struct +// to be 8 byte aligned. +// +C_ASSERT((sizeof(NDIS_SWITCH_FEATURE_STATUS_CUSTOM) % sizeof(UINT64)) == 0); + +// +// This structure is used in OID_SWITCH_PARAMETERS +// +#define NDIS_SWITCH_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_SWITCH_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + // + // Reserved for any future structure flags + // + ULONG Flags; + // + // Switch ID as used by management (e.g. WMI) + // + NDIS_SWITCH_NAME SwitchName; + // + // Name configured by user, displayed in UI + // + NDIS_SWITCH_FRIENDLYNAME SwitchFriendlyName; + // + // The number of ports attached to the switch + // + UINT32 NumSwitchPorts; + // + // Whether or not the switch has been activated yet. + // + BOOLEAN IsActive; +} NDIS_SWITCH_PARAMETERS, *PNDIS_SWITCH_PARAMETERS; + +#define NDIS_SIZEOF_NDIS_SWITCH_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PARAMETERS, IsActive) + +// +// These structures are used in OID_SWITCH_PORT_ARRAY +// + +typedef enum _NDIS_SWITCH_PORT_TYPE +{ + // + // The port type is not known ahead of time. This can occur in + // ports created through legacy interfaces that do not define + // the type ahead of time. + // + NdisSwitchPortTypeGeneric = 0, + // + // An external port, ultimately connected to + // an external Nic. + // + NdisSwitchPortTypeExternal = 1, + // + // A port ultimately connected to a Synthetic VM + // Nic. + // + NdisSwitchPortTypeSynthetic = 2, + // + // A port ultimately connected to an Emulated VM + // Nic. + // + NdisSwitchPortTypeEmulated = 3, + // + // An internal port, ultimately connected + // to an Internal NIC. + // + NdisSwitchPortTypeInternal = 4 +} NDIS_SWITCH_PORT_TYPE; + + +typedef enum _NDIS_SWITCH_PORT_STATE +{ + // + // The port state when state is not known ahead of time. + // + NdisSwitchPortStateUnknown = 0, + + // + // The port state for created ports. + // + NdisSwitchPortStateCreated = 1, + + // + // The port state for ports currently being torn down. + // + NdisSwitchPortStateTeardown = 2, + + // + // The port state for deleted ports. + // + NdisSwitchPortStateDeleted = 3 +} NDIS_SWITCH_PORT_STATE; + +#if (NDIS_SUPPORT_NDIS650) +// +// Indicates that the internal port should be treated as an untrusted entity. +// +#define NDIS_SWITCH_PORT_PARAMETERS_FLAG_UNTRUSTED_INTERNAL_PORT 0x1 +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS660) +// +// Indicates that the port has pending saved state to be restored +// +#define NDIS_SWITCH_PORT_PARAMETERS_FLAG_RESTORING_PORT 0x2 +#endif // (NDIS_SUPPORT_NDIS660) + +typedef struct _NDIS_SWITCH_PORT_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + // + // Reserved for any future structure flags + // + ULONG Flags; + // + // Number based ID for the port + // + NDIS_SWITCH_PORT_ID PortId; + // + // Static port identifier as used by management, such as WMI + // + NDIS_SWITCH_PORT_NAME PortName; + // + // Port friendly name + // + NDIS_SWITCH_PORT_FRIENDLYNAME PortFriendlyName; + // + // Port type + // + NDIS_SWITCH_PORT_TYPE PortType; + // + // If TRUE, the port is for validation and there won't be a + // corresponding NIC connection. If FALSE, this is a concrete + // port that will have a NIC connection. + // + BOOLEAN IsValidationPort; + // + // The current state of the port + // + NDIS_SWITCH_PORT_STATE PortState; +} NDIS_SWITCH_PORT_PARAMETERS, *PNDIS_SWITCH_PORT_PARAMETERS; + +#define NDIS_SWITCH_PORT_PARAMETERS_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_PARAMETERS, PortState) + +typedef struct _NDIS_SWITCH_PORT_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + USHORT FirstElementOffset; + ULONG NumElements; + ULONG ElementSize; +} NDIS_SWITCH_PORT_ARRAY, *PNDIS_SWITCH_PORT_ARRAY; + +#define NDIS_SWITCH_PORT_ARRAY_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_PORT_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_PORT_ARRAY, ElementSize) + +#define NDIS_SWITCH_PORT_AT_ARRAY_INDEX(_PortArray_, _Index_)\ + ((PNDIS_SWITCH_PORT_PARAMETERS)((PUCHAR)(_PortArray_) + \ + (_PortArray_)->FirstElementOffset + \ + ((_PortArray_)->ElementSize * (_Index_)))) + +#if defined(NDIS_SUPPORT_NDIS640) + +// +// Flags for NDIS_SWITCH_NIC_PARAMETERS structure +// +#define NDIS_SWITCH_NIC_FLAGS_NIC_INITIALIZING 0x00000001 + +#endif + +#if defined(NDIS_SUPPORT_NDIS650) +// +// The NIC is currently in suspended state. +// +#define NDIS_SWITCH_NIC_FLAGS_NIC_SUSPENDED 0x00000002 + +#endif + +#if defined(NDIS_SUPPORT_NDIS660) +// +// Preferred mapped NIC for a vNIC has changed. +// +#define NDIS_SWITCH_NIC_FLAGS_MAPPED_NIC_UPDATED 0x00000004 +#endif + +#if defined(NDIS_SUPPORT_NDIS680) +// +// Preferred mapped NIC for a vNIC has changed. +// +#define NDIS_SWITCH_NIC_FLAGS_NIC_SUSPENDED_LM 0x00000010 +#endif + +// +// These structures are used in OID_SWITCH_NIC_ARRAY +// + +typedef enum _NDIS_SWITCH_NIC_TYPE +{ + // + // An External NIC + // + NdisSwitchNicTypeExternal = 0, + // + // A Synthetic NIC in the VM + // + NdisSwitchNicTypeSynthetic = 1, + // + // An Emulated NIC in the VM + // + NdisSwitchNicTypeEmulated = 2, + // + // An Internal NIC on the Host partition + // + NdisSwitchNicTypeInternal = 3 +} NDIS_SWITCH_NIC_TYPE; + + +typedef enum _NDIS_SWITCH_NIC_STATE +{ + // + // The NIC state when state is not known ahead of time. + // + NdisSwitchNicStateUnknown = 0, + + // + // The NIC state for NICs that have been created. + // + NdisSwitchNicStateCreated = 1, + + // + // The NIC state for NICs that have been connected. + // + NdisSwitchNicStateConnected = 2, + + // + // The NIC state for NICs that have been disconnected. + // + NdisSwitchNicStateDisconnected = 3, + + // + // The NIC state for NICs that have been delted. + // + NdisSwitchNicStateDeleted = 4 +} NDIS_SWITCH_NIC_STATE; + + +typedef struct _NDIS_SWITCH_NIC_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + // + // Flags that can be used to pass certain additional info / state. + // + ULONG Flags; + // + // Nic identifier as used by management, such as WMI. For Nics of type + // SwitchNicTypeExternal, this corresponds to the device InstanceId. For Nics + // of type SwitchNicTypeInternal, this corresponds to an automatically + // generated GUID. + // For other Nics the value is set by the management layer. + // + NDIS_SWITCH_NIC_NAME NicName; + // + // Nic friendly name. For Nics of type SwitchNicTypeExternal, this corresponds + // to the device friendly name. For Nics of type SwitchNicTypeExternalInternal, this + // corresponds to the device display name. For other Nics the value is set by the + // management layer. + // + NDIS_SWITCH_NIC_FRIENDLYNAME NicFriendlyName; + // + // ID of the associated Port + // + NDIS_SWITCH_PORT_ID PortId; + // + // In teaming scenarios, this is the sub-interface index. + // Zero otherwise. + // + NDIS_SWITCH_NIC_INDEX NicIndex; + // + // The type of NIC + // + NDIS_SWITCH_NIC_TYPE NicType; + // + // The current state of the NIC + // + NDIS_SWITCH_NIC_STATE NicState; + // + // If NicType is SwitchNicTypeSynthetic or SwitchNicTypeEmulated, + // this field is valid and contains the identifier of the + // Virtual Machine owning the NIC + // + NDIS_VM_NAME VmName; + // + // VM Friendly Name + // + NDIS_VM_FRIENDLYNAME VmFriendlyName; + // + // If NicType is SwitchNicTypeExternal or SwitchNicTypeInternal, + // this field is valid and contains the NetCfgInstanceId of the + // underlying interface. + // + GUID NetCfgInstanceId; + // + // MTU of the NIC + // + ULONG MTU; + // + // Preferred NUMA Node + // + USHORT NumaNodeId; + // + // Permanent MAC address of the NIC + // + UCHAR PermanentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + // + // MAC address of the NIC as set by the VM + // + UCHAR VMMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + // + // Current MAC address of the NIC, to enforce policy against + // + UCHAR CurrentMacAddress[NDIS_MAX_PHYS_ADDRESS_LENGTH]; + // + // If TRUE, the NIC is currently assigned to a VF on the physical adapter. + // + BOOLEAN VFAssigned; +#if defined(NDIS_SUPPORT_NDIS640) + // + // New fields available in NDIS_SWITCH_NIC_PARAMETERS_2 + // + ULONG64 NdisReserved[2]; +#endif +} NDIS_SWITCH_NIC_PARAMETERS, *PNDIS_SWITCH_NIC_PARAMETERS; + +#define NDIS_SWITCH_NIC_PARAMETERS_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_NIC_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_PARAMETERS, VFAssigned) + +#if defined(NDIS_SUPPORT_NDIS640) + #define NDIS_SWITCH_NIC_PARAMETERS_REVISION_2 2 + + #define NDIS_SIZEOF_NDIS_SWITCH_NIC_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_PARAMETERS, NdisReserved) +#endif + +typedef struct _NDIS_SWITCH_NIC_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + USHORT FirstElementOffset; + ULONG NumElements; + ULONG ElementSize; +} NDIS_SWITCH_NIC_ARRAY, *PNDIS_SWITCH_NIC_ARRAY; + +#define NDIS_SWITCH_NIC_ARRAY_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_NIC_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_ARRAY, ElementSize) + +#define NDIS_SWITCH_NIC_AT_ARRAY_INDEX(_NicArray_, _Index_)\ + ((PNDIS_SWITCH_NIC_PARAMETERS)((PUCHAR)(_NicArray_) + \ + (_NicArray_)->FirstElementOffset + \ + ((_NicArray_)->ElementSize * (_Index_)))) + +// +// Forward declaration of OID request pointer. +// +typedef struct _NDIS_OID_REQUEST NDIS_OID_REQUEST, *PNDIS_OID_REQUEST; + +typedef struct _NDIS_SWITCH_NIC_OID_REQUEST +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_SWITCH_PORT_ID SourcePortId; + NDIS_SWITCH_NIC_INDEX SourceNicIndex; + NDIS_SWITCH_PORT_ID DestinationPortId; + NDIS_SWITCH_NIC_INDEX DestinationNicIndex; + PNDIS_OID_REQUEST OidRequest; +} NDIS_SWITCH_NIC_OID_REQUEST, *PNDIS_SWITCH_NIC_OID_REQUEST; + +#define NDIS_SWITCH_NIC_OID_REQUEST_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_NIC_OID_REQUEST_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_OID_REQUEST, OidRequest) + +// +// These structures are used in OID_SWITCH_NIC_SAVE and OID_SWITCH_NIC_RESTORE +// + +typedef struct _NDIS_SWITCH_NIC_SAVE_STATE +{ + NDIS_OBJECT_HEADER Header; + // + // Reserved for any future structure flags. + // + ULONG Flags; + // + // Port Identifier + // + NDIS_SWITCH_PORT_ID PortId; + // + // NIC Index + // + NDIS_SWITCH_NIC_INDEX NicIndex; + // + // Identifier for extension, used by extension on restore to recognize its data. + // + GUID ExtensionId; + // + // Extension name, used for diagnostic purposes. + // + NDIS_SWITCH_EXTENSION_FRIENDLYNAME ExtensionFriendlyName; + // + // Optional FeatureClass identifier to further recognize its data. + // + GUID FeatureClassId; + // + // Size of data in SaveData buffer. + // + USHORT SaveDataSize; + // + // Offset to save data from start of this buffer. + // + USHORT SaveDataOffset; +#if (NDIS_SUPPORT_NDIS650) + // + // Size of data in SaveData buffer in addition to SaveDataSize + // + ULONG SaveDataSizeOverflow; +#endif +} NDIS_SWITCH_NIC_SAVE_STATE, *PNDIS_SWITCH_NIC_SAVE_STATE; + +#define NDIS_SWITCH_NIC_SAVE_STATE_REVISION_1 1 + +#define NDIS_SIZEOF_NDIS_SWITCH_NIC_SAVE_STATE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_SAVE_STATE, SaveDataOffset) + +#if (NDIS_SUPPORT_NDIS650) + +#define NDIS_SWITCH_NIC_SAVE_STATE_REVISION_2 2 + +#define NDIS_SIZEOF_NDIS_SWITCH_NIC_SAVE_STATE_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_SWITCH_NIC_SAVE_STATE, SaveDataSizeOverflow) + +#endif + +#endif // (NDIS_SUPPORT_NDIS630) + +// +// NDIS_PORT_STATE is used in port state change status indications +// as well as OID_GEN_PORT_STATE query OID +// + +#define NDIS_PORT_STATE_REVISION_1 1 + +typedef struct _NDIS_PORT_STATE +{ + NDIS_OBJECT_HEADER Header; + NDIS_MEDIA_CONNECT_STATE MediaConnectState; + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; + NET_IF_DIRECTION_TYPE Direction; + NDIS_PORT_CONTROL_STATE SendControlState; + NDIS_PORT_CONTROL_STATE RcvControlState; + NDIS_PORT_AUTHORIZATION_STATE SendAuthorizationState; + NDIS_PORT_AUTHORIZATION_STATE RcvAuthorizationState; + ULONG Flags; +}NDIS_PORT_STATE, *PNDIS_PORT_STATE; + +#define NDIS_SIZEOF_PORT_STATE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PORT_STATE, Flags) + +// +// Flags used in NDIS_PORT_CHARACTERISTICS Flags field. +// +#define NDIS_PORT_CHAR_USE_DEFAULT_AUTH_SETTINGS 0x00000001 + +// +// NDIS_PORT_CHARACTERISTICS is used in port allocation and +// arrival notification as part of NDIS_PORT structure +// +#define NDIS_PORT_CHARACTERISTICS_REVISION_1 1 + +typedef struct _NDIS_PORT_CHARACTERISTICS +{ + NDIS_OBJECT_HEADER Header; + NDIS_PORT_NUMBER PortNumber; + ULONG Flags; + NDIS_PORT_TYPE Type; + NDIS_MEDIA_CONNECT_STATE MediaConnectState; + ULONG64 XmitLinkSpeed; + ULONG64 RcvLinkSpeed; + NET_IF_DIRECTION_TYPE Direction; + NDIS_PORT_CONTROL_STATE SendControlState; + NDIS_PORT_CONTROL_STATE RcvControlState; + NDIS_PORT_AUTHORIZATION_STATE SendAuthorizationState; + NDIS_PORT_AUTHORIZATION_STATE RcvAuthorizationState; +} NDIS_PORT_CHARACTERISTICS, *PNDIS_PORT_CHARACTERISTICS; + +#define NDIS_SIZEOF_PORT_CHARACTERISTICS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PORT_CHARACTERISTICS, RcvAuthorizationState) + +// +// NDIS_PORT structure is used in port activation +// PnP notification +// +typedef struct _NDIS_PORT NDIS_PORT, *PNDIS_PORT; + +struct _NDIS_PORT +{ + PNDIS_PORT Next; + PVOID NdisReserved; + PVOID MiniportReserved; + PVOID ProtocolReserved; + NDIS_PORT_CHARACTERISTICS PortCharacteristics; +}; + + +#define NDIS_PORT_ARRAY_REVISION_1 1 +// +// NDIS_PORT_ARRAY is used in enumerating the ports +// +typedef struct _NDIS_PORT_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG NumberOfPorts; + ULONG OffsetFirstPort; + ULONG ElementSize; + NDIS_PORT_CHARACTERISTICS Ports[1]; +}NDIS_PORT_ARRAY, *PNDIS_PORT_ARRAY; + +#define NDIS_SIZEOF_PORT_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PORT_ARRAY, Ports) + + +#endif // ((NTDDI_VERSION >= NTDDI_VISTA) || NDIS_SUPPORT_NDIS6) + +#endif // NTDDI_VERSION >= NTDDI_VISTA + +#if (NDIS_SUPPORT_NDIS650) + +#include +#include + +// +// Data structures for NDIS Generic Filtering Platform (GFP) used in +// Generic Flow Table (GFT) offload and Packet Direct +// +#define ETHERNET_LENGTH_OF_ADDRESS 6 + +// +// NDIS_GFP_TABLE_TYPE enum value is used to define the type of table +// For GFT, at the minimum we have an ingress and egress exact match tables. +// we may or may not have an ingress or egress wildcard match table +// + +typedef enum _NDIS_GFP_TABLE_TYPE +{ + NdisGfpTableTypeUndefined, + NdisGfpTableTypeWildcardIngress, + NdisGfpTableTypeWildcardEgress, + NdisGfpTableTypeExactMatchIngress, + NdisGfpTableTypeExactMatchEgress, + NdisGfpTableTypePacketDirect, + NdisGfpTableTypeMax +} NDIS_GFP_TABLE_TYPE, *PNDIS_GFP_TABLE_TYPE; + + +// +// flags used to specify which headers are present in a header group +// +// These flags are used in the HeadersPresent field of +// NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE, NDIS_GFP_HEADER_GROUP_EXACT_MATCH, +// NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE, NDIS_GFT_HEADER_GROUP_TRANSPOSITION, +// NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE, and NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH +// +#define NDIS_GFP_HEADER_PRESENT_ETHERNET 0x00000001 +#define NDIS_GFP_HEADER_PRESENT_IPV4 0x00000002 +#define NDIS_GFP_HEADER_PRESENT_IPV6 0x00000004 +#define NDIS_GFP_HEADER_PRESENT_TCP 0x00000008 +#define NDIS_GFP_HEADER_PRESENT_UDP 0x00000010 +#define NDIS_GFP_HEADER_PRESENT_ICMP 0x00000020 +#define NDIS_GFP_HEADER_PRESENT_NO_ENCAP 0x00000040 +#define NDIS_GFP_HEADER_PRESENT_IP_IN_IP_ENCAP 0x00000080 +#define NDIS_GFP_HEADER_PRESENT_IP_IN_GRE_ENCAP 0x00000100 +#define NDIS_GFP_HEADER_PRESENT_NVGRE_ENCAP 0x00000200 +#define NDIS_GFP_HEADER_PRESENT_VXLAN_ENCAP 0x00000400 +#define NDIS_GFP_HEADER_PRESENT_ESP 0x00000800 + +// +// flags used to specify fields in the Ethernet, IP, Transport and encapsulation headers +// +#define NDIS_GFP_HEADER_FIELD_DEST_MAC_ADDR 0x00000001ULL +#define NDIS_GFP_HEADER_FIELD_SRC_MAC_ADDR 0x00000002ULL +#define NDIS_GFP_HEADER_FIELD_ETH_TYPE 0x00000004ULL +#define NDIS_GFP_HEADER_FIELD_CUSTOMER_VLAN_ID 0x00000008ULL +#define NDIS_GFP_HEADER_FIELD_PROVIDER_VLAN_ID 0x00000010ULL +#define NDIS_GFP_HEADER_FIELD_8021P_PRIORITY 0x00000020ULL +#define NDIS_GFP_HEADER_FIELD_SRC_IP_ADDR 0x00000040ULL +#define NDIS_GFP_HEADER_FIELD_DEST_IP_ADDR 0x00000080ULL +#define NDIS_GFP_HEADER_FIELD_TTL 0x00000100ULL +#define NDIS_GFP_HEADER_FIELD_IP_PROTOCOL 0x00000200ULL +#define NDIS_GFP_HEADER_FIELD_IP_DSCP 0x00000400ULL +#define NDIS_GFP_HEADER_FIELD_TRANSPORT_SRC_PORT 0x00000800ULL +#define NDIS_GFP_HEADER_FIELD_TRANSPORT_DEST_PORT 0x00001000ULL +#define NDIS_GFP_HEADER_FIELD_TCP_FLAGS 0x00002000ULL +#define NDIS_GFP_HEADER_FIELD_TENANT_ID 0x00004000ULL +#define NDIS_GFP_HEADER_FIELD_ENTROPY 0x00008000ULL +#define NDIS_GFP_HEADER_FIELD_ICMP_TYPE 0x00010000ULL +#define NDIS_GFP_HEADER_FIELD_ICMP_CODE 0x00020000ULL +#define NDIS_GFP_HEADER_FIELD_OOB_VLAN 0x00040000ULL +#define NDIS_GFP_HEADER_FIELD_OOB_TENANT_ID 0x00080000ULL +#define NDIS_GFP_HEADER_FIELD_GRE_PROTOCOL 0x00100000ULL + + +// +// flags used to specify encapsulation types, they are also used +// in SupportedEncapsulationTypes field of NDIS_GFT_OFFLOAD_CAPABILITIES structure +// +#define NDIS_GFP_ENCAPSULATION_TYPE_NOT_ENCAPSULATED 0x00000001 +#define NDIS_GFP_ENCAPSULATION_TYPE_IP_IN_IP 0x00000002 +#define NDIS_GFP_ENCAPSULATION_TYPE_IP_IN_GRE 0x00000004 +#define NDIS_GFP_ENCAPSULATION_TYPE_NVGRE 0x00000008 +#define NDIS_GFP_ENCAPSULATION_TYPE_VXLAN 0x00000010 + +typedef ULONG NDIS_GFP_PROFILE_ID, *PNDIS_GFP_PROFILE_ID; +#define NDIS_GFP_UNDEFINED_PROFILE_ID 0 + +// +// flags used in Flags field of NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE +// +#define NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE_IS_TTL_ONE 0x00000001 + +// +// NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE defines a match profile for a +// -single header group-. +// An array of NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILEs are used in +// NDIS_GFP_EXACT_MATCH_PROFILE structure to define a full match profile +// + +#define NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE +{ + NDIS_OBJECT_HEADER Header; + + ULONG Flags; + + // + // NDIS_GFP_HEADER_PRESENT_xxx flags to specify which headers + // are present in the header group + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx flags except NDIS_GFP_HEADER_FIELD_ENTROPY + // specify which fields of the network headers present in the header group + // we should match against. + // + ULONG64 MatchFields; + +} NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE, *PNDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE; + +#define NDIS_SIZEOF_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE, MatchFields) + + + +// +// flags used in Flags field of NDIS_GFP_EXACT_MATCH_PROFILE +// +#define NDIS_GFP_EXACT_MATCH_PROFILE_RDMA_FLOW 0x00000001 + +// +// NDIS_GFP_EXACT_MATCH_PROFILE is used in OID_GFT_EXACT_MATCH_PROFILE +// and NDIS_GFT_PROFILE_INFO. +// +// This structure is used to fully define a match profile that can span multiple header groups +// + +#define NDIS_GFP_EXACT_MATCH_PROFILE_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_EXACT_MATCH_PROFILE +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_GFP_TABLE_TYPE TableType; + + _In_ NDIS_GFP_PROFILE_ID ProfileId; + + _Out_ ULONG NumSupportedEntries; + + + // + // the following fields are used to describe an array of NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE structures + // + _In_ ULONG HeaderGroupExactMatchProfileArrayOffset; // from the beginning of this structure + _In_ ULONG HeaderGroupExactMatchProfileArrayNumElements; + _In_ ULONG HeaderGroupExactMatchProfileArrayElementSize; + +} NDIS_GFP_EXACT_MATCH_PROFILE, *PNDIS_GFP_EXACT_MATCH_PROFILE; + +#define NDIS_SIZEOF_GFP_EXACT_MATCH_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_EXACT_MATCH_PROFILE, HeaderGroupExactMatchProfileArrayElementSize) + +typedef struct _NDIS_GFP_ETHERNET_HEADER_FIELDS +{ + UINT8 DestinationMacAddress[ETHERNET_LENGTH_OF_ADDRESS]; + UINT8 SourceMacAddress[ETHERNET_LENGTH_OF_ADDRESS]; + UINT16 EthType; + UINT16 CustomerVlanId; + UINT16 ProviderVlanId; + UINT8 Priority; +} NDIS_GFP_ETHERNET_HEADER_FIELDS, *PNDIS_GFP_ETHERNET_HEADER_FIELDS; + + +// +// flags used in Flags field of NDIS_GFP_HEADER_GROUP_EXACT_MATCH +// +#define NDIS_GFP_HEADER_GROUP_EXACT_MATCH_IS_TTL_ONE 0x00000001 + +// +// NDIS_GFP_HEADER_GROUP_EXACT_MATCH structure is used with +// NDIS_GFT_EXACT_MATCH_FLOW_ENTRY. This structure defines +// the exact match for a single header group +// +#define NDIS_GFP_HEADER_GROUP_EXACT_MATCH_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_HEADER_GROUP_EXACT_MATCH +{ + + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + // + // NDIS_GFP_HEADER_PRESENT_xxx + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx except NDIS_GFP_HEADER_FIELD_ENTROPY + // + ULONG64 MatchFields; + + // + // Ethernet header + // + NDIS_GFP_ETHERNET_HEADER_FIELDS EthernetFields; + + // + // IP header + // + union + { + struct + { + IN_ADDR SourceIPAddress; + IN_ADDR DestinationIPAddress; + } IPv4Address; + + struct + { + IN6_ADDR SourceIPAddress; + IN6_ADDR DestinationIPAddress; + } IPv6Address; + + } IPAddress; + + UINT8 Dscp; + UINT8 IPProtocol; + + // + // transport/encapsulation header + // + union + { + struct + { + USHORT SourcePort; + USHORT DestinationPort; + } Udp; + + struct + { + USHORT SourcePort; + USHORT DestinationPort; + UINT8 TcpFlags; + } Tcp; + + struct + { + UINT8 Type; + UINT8 Code; + } Icmp; + + struct + { + ULONG TenantId; + USHORT GreProtocol; + } Encapsulation; + } TransportOrEncapsulation; + +} NDIS_GFP_HEADER_GROUP_EXACT_MATCH, *PNDIS_GFP_HEADER_GROUP_EXACT_MATCH; + +#define NDIS_SIZEOF_GFP_HEADER_GROUP_EXACT_MATCH_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_HEADER_GROUP_EXACT_MATCH, TransportOrEncapsulation) + + +// +// wildcard GFP entries +// + +// +// NDIS_GFP_WILDCARD_MATCH_TYPE enum value specifies the type of matches that +// we do in a wildcard match +// +typedef enum _NDIS_GFP_WILDCARD_MATCH_TYPE +{ + NdisGfpWildcardMatchTypeUndefined, + NdisGfpWildcardMatchTypeEqual, + NdisGfpWildcardMatchTypeMaskEqual, + NdisGfpWildcardMatchTypeInRange, + NdisGfpWildcardMatchTypeMax +} NDIS_GFP_WILDCARD_MATCH_TYPE, *PNDIS_GFP_WILDCARD_MATCH_TYPE; + +// +// flags used in Flags field of NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE +// +#define NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE_IS_TTL_ONE 0x00000001 + +// +// NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE structure is used with +// NDIS_GFP_WILDCARD_MATCH_PROFILE. This structure defines a wildcard +// match profile for a single header group +// + +#define NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + // + // NDIS_GFP_HEADER_PRESENT_xxx + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx + // + ULONG64 MatchFields; + + NDIS_GFP_WILDCARD_MATCH_TYPE SourceIPv4AddressMatchType; + NDIS_GFP_WILDCARD_MATCH_TYPE DestinationIPv4AddressMatchType; + NDIS_GFP_WILDCARD_MATCH_TYPE SourceIPv6AddressMatchType; + NDIS_GFP_WILDCARD_MATCH_TYPE DestinationIPv6AddressMatchType; + + NDIS_GFP_WILDCARD_MATCH_TYPE SourcePortMatchType; + NDIS_GFP_WILDCARD_MATCH_TYPE DestinationPortMatchType; + + UINT8 TcpFlags; +} NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE, *PNDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE; + +#define NDIS_SIZEOF_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE, TcpFlags) + + +// +// NDIS_GFP_WILDCARD_MATCH_PROFILE structure is used with OID_GFT_WILDCARD_MATCH_PROFILE +// and NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY. +// +// It uses an array of NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILEs in order to describe +// a full wildcard match profile +// + +#define NDIS_GFP_WILDCARD_MATCH_PROFILE_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_WILDCARD_MATCH_PROFILE +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFP_TABLE_TYPE TableType; + + _In_ NDIS_GFP_PROFILE_ID ProfileId; + + _Out_ ULONG NumSupportedEntries; + + // + // The following fields are used to describe an array of NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE structures + // + _In_ ULONG HeaderGroupWildcardMatchProfileArrayOffset; // from the beginning of this structure + _In_ ULONG HeaderGroupWildcardMatchProfileArrayNumElements; + _In_ ULONG HeaderGroupWildcardMatchProfileArrayElementSize; +} NDIS_GFP_WILDCARD_MATCH_PROFILE, *PNDIS_GFP_WILDCARD_MATCH_PROFILE; + +#define NDIS_SIZEOF_GFP_WILDCARD_MATCH_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_WILDCARD_MATCH_PROFILE, HeaderGroupWildcardMatchProfileArrayElementSize) + +// +// structures used in NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH +// +typedef struct _NDIS_GFP_IPV4_ADDRESS_WILDCARD_MATCH +{ + NDIS_GFP_WILDCARD_MATCH_TYPE MatchType; + IN_ADDR IPAddress; + union + { + ULONG PrefixLength; + ULONG RangeSize; + } MatchValue; + +} NDIS_GFP_IPV4_ADDRESS_WILDCARD_MATCH, *PNDIS_GFP_IPV4_ADDRESS_WILDCARD_MATCH; + +typedef struct _NDIS_GFP_IPV4_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH +{ + NDIS_GFP_IPV4_ADDRESS_WILDCARD_MATCH SourceIPv4Address; + NDIS_GFP_IPV4_ADDRESS_WILDCARD_MATCH DestinationIPv4Address; +} NDIS_GFP_IPV4_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH, *PNDIS_GFP_IPV4_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH; + + +typedef struct _NDIS_GFP_IPV6_ADDRESS_WILDCARD_MATCH +{ + NDIS_GFP_WILDCARD_MATCH_TYPE MatchType; + IN6_ADDR IPAddress; + union + { + ULONG PrefixLength; + ULONG RangeSize; + } MatchValue; + +} NDIS_GFP_IPV6_ADDRESS_WILDCARD_MATCH, *PNDIS_GFP_IPV6_ADDRESS_WILDCARD_MATCH; + +typedef struct _NDIS_GFP_IPV6_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH +{ + NDIS_GFP_IPV6_ADDRESS_WILDCARD_MATCH SourceIPv6Address; + NDIS_GFP_IPV6_ADDRESS_WILDCARD_MATCH DestinationIPv6Address; +} NDIS_GFP_IPV6_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH, *PNDIS_GFP_IPV6_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH; + +typedef union _NDIS_GFP_IP_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH +{ + NDIS_GFP_IPV4_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH IPv4SrcAndDestAddress; + NDIS_GFP_IPV6_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH IPv6SrcAndDestAddress; +} NDIS_GFP_IP_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH, *PNDIS_GFP_IP_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH; + +typedef struct _NDIS_GFP_TRANSPORT_PORT_WILDCARD_MATCH +{ + NDIS_GFP_WILDCARD_MATCH_TYPE MatchType; + USHORT Port; + USHORT Range; +} NDIS_GFP_TRANSPORT_PORT_WILDCARD_MATCH, *PNDIS_GFP_TRANSPORT_PORT_WILDCARD_MATCH; + +typedef struct _NDIS_GFP_TRANSPORT_SRC_AND_DEST_PORT_WILDCARD_MATCH +{ + NDIS_GFP_TRANSPORT_PORT_WILDCARD_MATCH SourcePort; + NDIS_GFP_TRANSPORT_PORT_WILDCARD_MATCH DestinationPort; +} NDIS_GFP_TRANSPORT_SRC_AND_DEST_PORT_WILDCARD_MATCH, *PNDIS_GFP_TRANSPORT_SRC_AND_DEST_PORT_WILDCARD_MATCH; + +// +// flags used in FLags field of NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH +// +#define NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_IS_TTL_ONE 0x00000001 + +// +// NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH structure is used in NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY +// +#define NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_REVISION_1 1 + +typedef struct DECLSPEC_ALIGN(8) _NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + NDIS_GFP_PROFILE_ID ProfileId; + + + // + // NDIS_GFP_HEADER_PRESENT_xxx + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx + // + ULONG64 MatchFields; + + // + // Ethernet header + // + NDIS_GFP_ETHERNET_HEADER_FIELDS EthernetFields; + + // + // IP header + // + NDIS_GFP_IP_SRC_AND_DEST_ADDRESS_WILDCARD_MATCH IPSrcAndDestAddress; + + UINT8 Dscp; + UINT8 IPProtocol; + + // + // transport/encapsulation header + // + union + { + + struct + { + NDIS_GFP_TRANSPORT_SRC_AND_DEST_PORT_WILDCARD_MATCH UdpSrcAndDestPort; + } UdpHeader; + + struct + { + NDIS_GFP_TRANSPORT_SRC_AND_DEST_PORT_WILDCARD_MATCH TcpSrcAndDestPort; + + // + // implied " != 0" + // + UINT8 TcpFlags; + + } TcpHeader; + + struct + { + UINT8 Type; + UINT8 Code; + } IcmpHeader; + + struct + { + ULONG TenantId; + USHORT GreProtocol; + } Encapsulation; + + } TransportOrEncapsulation; + +} NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH, *PNDIS_GFP_HEADER_GROUP_WILDCARD_MATCH; + +#define NDIS_SIZEOF_GFP_HEADER_GROUP_WILDCARD_MATCH_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH, TransportOrEncapsulation) + + +// +// Packet Direct data structures +// + +// +// NDIS PACKETDIRECT Capability/Configuration advertisement and discovery +// definitions. +// + +#define NDIS_PD_QUEUE_COUNT_DYNAMIC ((ULONG)-1) + +// +// NDIS_PD_CAPABILITIES.CapabilityFlags definitions +// + +// +// Indicates that the PD provider supports creation of counters +// with the PDCounterTypeReceiveFilter type. +// +#define NDIS_PD_CAPS_RECEIVE_FILTER_COUNTERS_SUPPORTED 0x00000001 + +// +// Indicates that the PD provider allows PD clients to request a notification +// to be delivered on a per NDIS_PD_QUEUE basis for PD_BUFFER completions. +// +#define NDIS_PD_CAPS_DRAIN_NOTIFICATIONS_SUPPORTED 0x00000002 + +// +// Indicates that the PD provider supports moderating drain notifications +// based on a moderation interval value per PD queue. +// This flag can be set only if NDIS_PD_CAPS_DRAIN_NOTIFICATIONS_SUPPORTED +// is set. +// +#define NDIS_PD_CAPS_NOTIFICATION_MODERATION_INTERVAL_SUPPORTED 0x00000004 + +// +// Indicates that the PD provider supports moderating drain notifications +// based on a moderation count value per PD queue. +// This flag can be set only if NDIS_PD_CAPS_NOTIFICATION_MODERATION_INTERVAL_SUPPORTED +// is set (i.e., there's no moderation support based on purely count). +// +#define NDIS_PD_CAPS_NOTIFICATION_MODERATION_COUNT_SUPPORTED 0x00000008 + + +// +// NDIS_PD_CAPABILITIES structure indicates PD capabilities for +// a miniport adapter. +// +typedef struct DECLSPEC_ALIGN(8) _NDIS_PD_CAPABILITIES { + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PD_CAPABILITIES_REVISION_1; + // Header.Size >= NDIS_SIZEOF_PD_CAPABILITIES_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; // Reserved. Must be set to 0. + + // + // Maximum partial PD_BUFFER chain lengths supported by the provider + // for transmit and receive. + // + ULONG MaximumTxPartialBufferCount; + ULONG MaximumRxPartialBufferCount; + + // + // When creating a packet match filter, PD client can specify a filter + // context value to be returned (via the PD_BUFFER.RxFilterContext field) + // for each packet that matches the filter. PD allows the width of this + // context value to be as large as 64 bits, however not every PD provider + // may be able to support a 64-bit wide context value. PD providers report + // the filter context width that they support via the field below in + // number of bits. + // + UCHAR RxFilterContextWidth; + + ULONG CapabilityFlags; + + // + // Max number of Rx or Tx queues supported. These reflect the max number + // of queues that can be created via the NdisPDAllocateQueue function (hence + // not including any existing RSS receive queues for which PD client can + // ask for PD-mode access) assuming the queues are NOT used for another + // purpose (e.g., VMQ). So, the max number is NOT a guarantee to the client. + // A PD provider must NEVER report 0 for any Tx queue limit. However, it's + // possible for a PD provider to report 0 for a Rx queue limit if it only + // supports existing RSS queues to be put into PD-mode (i.e., PD client + // cannot create any PD Rx queues via NdisPDAllocateQueue, but can only + // request PD-mode access to existing RSS queues via + // NdisPDAcquireReceiveQueues). + // If a PD provider has a flexible implementation where it supports a + // maximum of N queues where any queue can be purposed flexibly as either + // an RX or TX queue, the PD provider should advertise ~N/2 for + // MaxNumberOfRxQueues*** and ~N/2 MaxNumberOfTxQueues*** (because PD + // clients typically create a matching number of RX and TX queues). + // If a PD provider can partition Rx or TX queues flexibly between + // Vports, then it can advertise NDIS_PD_QUEUE_COUNT_DYNAMIC for the + // Vport-specific max counts. + // + ULONG MaxNumberOfRxQueues; // miniport-adapter-wide total maximum + ULONG MaxNumberOfTxQueues; // miniport-adapter-wide total maximum + ULONG MaxNumberOfRxQueuesForDefaultVport; + ULONG MaxNumberOfTxQueuesForDefaultVport; + ULONG MaxNumberOfRxQueuesPerNonDefaultVport; + ULONG MaxNumberOfTxQueuesPerNonDefaultVport; + + // + // The following fields are used to describe an array of + // NDIS_GFP_EXACT_MATCH_PROFILE structures + // + ULONG ExactMatchProfileArrayOffset; // from the beginning of this struct + ULONG ExactMatchProfileArrayNumElements; + ULONG ExactMatchProfileArrayElementSize; + + // + // The following fields are used to describe an array of + // NDIS_GFP_WILDCARD_MATCH_PROFILE structures + // + ULONG WildcardMatchProfileArrayOffset; // from the beginning of this struct + ULONG WildcardMatchProfileArrayNumElements; + ULONG WildcardMatchProfileArrayElementSize; + + // + // Providers that support interrupt moderation advertise their + // ModerationInterval limits and granularity via the following fields. + // All values are in nanoseconds. MinimumModerationInterval and + // MaximumModerationInterval values must be exact multiple of the + // ModerationIntervalGranularity value (which must be >= 1). Example: + // a min value of 200, a max value of 1000, and a granularity value of + // 100 means the provider can support only the following values for + // the ModerationInterval: 200, 300, 400, 500, 600, 700, 800, 900, 1000. + // Note that 0 is always a valid ModerationInterval value and must be + // honored by the PD provider to disable interrupt moderation on the queue. + // For any other ModerationInterval value that does not match any of the + // supported granularity values, PD provider must round-down the input + // ModerationInterval value to the nearest supported value. + // + ULONG MinimumModerationInterval; + ULONG MaximumModerationInterval; + ULONG ModerationIntervalGranularity; + + // + // Maximum Rx and Tx queue sizes supported by the provider. + // 0 means the provider does not have a hard limit. + // + ULONG MaxRxQueueSize; + ULONG MaxTxQueueSize; +} NDIS_PD_CAPABILITIES; + +#define NDIS_PD_CAPABILITIES_REVISION_1 1 +#define NDIS_SIZEOF_PD_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PD_CAPABILITIES, \ + MaxTxQueueSize) + +// +// The following structure is used by PD provider to make an NDIS status +// indication, NDIS_STATUS_PD_CURRENT_CONFIG, for conveying the +// PD status and capabilities up to NDIS. PD client drivers can also use +// OID_PD_QUERY_CURRENT_CONFIG to query the current PD status and capabilities. +// Both NDIS_STATUS_PD_CURRENT_CONFIG and OID_PD_QUERY_CURRENT_CONFIG are +// Vport-aware. However, in the current PD version, the only valid Vport +// ID that can be used with this status indication and OID is +// NDIS_INVALID_VPORT_ID, i.e., the scope and granularity of PD status and +// capability advertisement is the whole PF on the miniport adapter (in contrast +// to each individual Vport of the PF). +// + + +typedef struct DECLSPEC_ALIGN(8) _NDIS_PD_CONFIG { + // + // Header.Type = NDIS_OBJECT_TYPE_DEFAULT; + // Header.Revision = NDIS_PD_CONFIG_REVISION_1; + // Header.Size >= NDIS_SIZEOF_PD_CONFIG_REVISION_1; + // + NDIS_OBJECT_HEADER Header; + ULONG Flags; + BOOLEAN Enabled; + // + // A NDIS_PD_CAPABILITIES struct is at CapabilitiesOffset. + // CapabilitiesSize == 0 means no PD capability exists currently. + // + ULONG CapabilitiesOffset; + ULONG CapabilitiesSize; +} NDIS_PD_CONFIG; + +#define NDIS_PD_CONFIG_REVISION_1 1 +#define NDIS_SIZEOF_PD_CONFIG_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_PD_CONFIG, CapabilitiesSize) + +// +// NDIS miniport driver package adds this NDIS keyword in its INF file +// for devices that support PacketDirect. Mere presence of this keyword +// indicates PacketDirect capability (independent of its value). Value 0 +// means PD functionality of the miniport adapter is disabled. Any non-zero +// value means PD functionality of the miniport adapter is enabled. +// +#define PACKET_DIRECT_KEYWORD NDIS_STRING_CONST("*PacketDirect") + + +// +// GFT flow entry ID +// +typedef ULONG_PTR NDIS_GFT_FLOW_ENTRY_ID, *PNDIS_GFT_FLOW_ENTRY_ID; +#define NDIS_GFT_UNDEFINED_FLOW_ENTRY_ID 0 + +// +// GFT table data structures +// +typedef ULONG NDIS_GFT_TABLE_ID, *PNDIS_GFT_TABLE_ID; +#define NDIS_GFT_UNDEFINED_TABLE_ID 0 + + +// +// flags used in Flags field of NDIS_GFT_TABLE_PARAMETERS +// +#define NDIS_GFT_TABLE_INCLUDE_EXTERNAL_VPPORT 0x00000001 + +// +// NDIS_GFT_TABLE_PARAMETERS is used in OID_GFT_CREATE_TABLE +// +#define NDIS_GFT_TABLE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_TABLE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_GFT_TABLE_ID TableId; + NDIS_GFP_TABLE_TYPE TableType; + NDIS_GFT_TABLE_ID NextTableId; +} NDIS_GFT_TABLE_PARAMETERS, *PNDIS_GFT_TABLE_PARAMETERS; + +#define NDIS_SIZEOF_GFT_TABLE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_TABLE_PARAMETERS, NextTableId) + +// +// NDIS_GFT_TABLE_INFO is used with NDIS_GFT_TABLE_INFO_ARRAY +// in OID_GFT_ENUM_TABLES that enumerates GFT tables +// on a miniport adapter +// +#define NDIS_GFT_TABLE_INFO_REVISION_1 1 + +typedef struct _NDIS_GFT_TABLE_INFO +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + NDIS_GFT_TABLE_ID TableId; + NDIS_GFP_TABLE_TYPE TableType; + NDIS_GFT_TABLE_ID NextTableId; + ULONG NumFlowEntries; +} NDIS_GFT_TABLE_INFO, *PNDIS_GFT_TABLE_INFO; + +#define NDIS_SIZEOF_GFT_TABLE_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_TABLE_INFO, NumFlowEntries) + +// +// NDIS_GFT_TABLE_INFO_ARRAY is used in OID_GFT_ENUM_TABLES +// +#define NDIS_GFT_TABLE_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_TABLE_INFO_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + // + // The following fields are used to describe an array of NDIS_GFT_TABLE_INFO structures + // + _Out_ ULONG TableArrayOffset; // from the beginning of this structure + _Out_ ULONG TableArrayNumElements; + _Out_ ULONG TableArrayElementSize; +} NDIS_GFT_TABLE_INFO_ARRAY, *PNDIS_GFT_TABLE_INFO_ARRAY; + +#define NDIS_SIZEOF_GFT_TABLE_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_TABLE_INFO_ARRAY, TableArrayElementSize) + +// +// NDIS_GFT_DELETE_TABLE_PARAMETERS is used in +// OID_GFT_DELETE_TABLE +// +#define NDIS_GFT_DELETE_TABLE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_DELETE_TABLE_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_GFT_TABLE_ID TableId; +} NDIS_GFT_DELETE_TABLE_PARAMETERS, *PNDIS_GFT_DELETE_TABLE_PARAMETERS; + +#define NDIS_SIZEOF_GFT_DELETE_TABLE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_DELETE_TABLE_PARAMETERS, TableId) + +// +// GFT counter structures +// + +typedef ULONG NDIS_GFT_COUNTER_ID, *PNDIS_GFT_COUNTER_ID; + +#define NDIS_GFT_UNDEFINED_COUNTER_ID 0 + + +// +// maximum number of counter objects associated with a flow entry +// +#define NDIS_GFT_MAX_COUNTER_OBJECTS_PER_FLOW_ENTRY 8 + +// +// NDIS_GFT_COUNTER_UPDATE_FREQUENCY is used with NDIS_GFT_COUNTER in +// OID_GFT_ALLOCATE_COUNTERS. This enum is also used in NDIS_GFT_EXACT_MATCH_FLOW_ENTRY and +// NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY structures used in OID_GFT_ADD_FLOW_ENTRIES +// +typedef enum _NDIS_GFT_COUNTER_UPDATE_FREQUENCY +{ + NdisGftCounterUpdateFrequencyUndefined, + NdisGftCounterUpdateFrequencyOnQuery, + NdisGftCounterUpdateFrequencyPerUpdatePeriod, + NdisGftCounterUpdateFrequencyPerPacket, + NdisGftCounterUpdateFrequencyMax +} NDIS_GFT_COUNTER_UPDATE_FREQUENCY, *PNDIS_GFT_COUNTER_UPDATE_FREQUENCY; + +// +// NDIS_GFT_COUNTER_TYPE enum value defines the type of the GFT counter +// +typedef enum _NDIS_GFT_COUNTER_TYPE +{ + NdisGftCounterTypeUndefined, + NdisGftCounterTypePacket, + NdisGftCounterTypeByte, + NdisGftCounterTypePacketByte, + NdisGftCounterTypePacketByteAndState, + NdisGftCounterTypeMax +} NDIS_GFT_COUNTER_TYPE, *PNDIS_GFT_COUNTER_TYPE; + +typedef volatile struct _NDIS_GFT_PACKET_COUNTER_VALUE +{ + ULONG64 Packets; + LARGE_INTEGER LastUpdate; // Absolute system time returned from KeQuerySystemTime +} NDIS_GFT_PACKET_COUNTER_VALUE, *PNDIS_GFT_PACKET_COUNTER_VALUE; + +typedef volatile struct _NDIS_GFT_BYTE_COUNTER_VALUE +{ + ULONG64 Bytes; + LARGE_INTEGER LastUpdate; // Absolute system time returned from KeQuerySystemTime +} NDIS_GFT_BYTE_COUNTER_VALUE, *PNDIS_GFT_BYTE_COUNTER_VALUE; + + +typedef volatile struct _NDIS_GFT_PACKET_BYTE_COUNTER_VALUE +{ + ULONG64 Packets; + ULONG64 Bytes; + LARGE_INTEGER LastUpdate; // Absolute system time returned from KeQuerySystemTime +} NDIS_GFT_PACKET_BYTE_COUNTER_VALUE, *PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE; + +typedef volatile struct _NDIS_GFT_FLOW_STATE +{ + ULONG TcpSeqNum; + ULONG TcpAckNum; +} NDIS_GFT_FLOW_STATE, *PNDIS_GFT_FLOW_STATE; + +typedef volatile struct _NDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE +{ + NDIS_GFT_PACKET_BYTE_COUNTER_VALUE PacketByteCounterValue; + NDIS_GFT_FLOW_STATE FlowState; +} NDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE, *PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE; + +// +// NDIS_GFT_COUNTER_PARAMETERS is used in OID_GFT_ALLOCATE_COUNTERS +// + +#define NDIS_GFT_COUNTER_PARAMETERS_CLIENT_SPECIFIED_ADDRESS 0x00000001 + +#define NDIS_GFT_COUNTER_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_COUNTER_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + _In_ NDIS_GFT_COUNTER_UPDATE_FREQUENCY CounterUpdateFrequency; + _In_ NDIS_GFT_COUNTER_TYPE CounterType; + _Inout_ NDIS_GFT_COUNTER_ID CounterIdStart; + _In_ ULONG NumCounters; + _In_ ULONG UpdatePeriod; // in milliseconds + + union + { + _Inout_ PNDIS_GFT_PACKET_COUNTER_VALUE PacketCounters; + _Inout_ PNDIS_GFT_BYTE_COUNTER_VALUE ByteCounters; + _Inout_ PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE PacketByteCounters; + _Inout_ PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE PacketByteCountersAndState; + } CounterValuesBufferStart; + +} NDIS_GFT_COUNTER_PARAMETERS, *PNDIS_GFT_COUNTER_PARAMETERS; + +#define NDIS_SIZEOF_GFT_COUNTER_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_COUNTER_PARAMETERS, CounterValuesBufferStart) + + +// +// NDIS_GFT_FREE_COUNTER_PARAMETERS is used in OID_GFT_FREE_COUNTERS +// +#define NDIS_GFT_FREE_COUNTER_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_FREE_COUNTER_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + _In_ NDIS_GFT_COUNTER_ID CounterIdStart; + _In_ ULONG NumCounters; + // + // Last counter values + // The following fields are used to describe an array of NDIS_GFT_COUNTER_VALUE + // + _Out_ ULONG LastCounterValueAndStateArrayOffset; // from the beginning of this structure + _Out_ ULONG LastCounterValueAndStateArrayNumElements; + _Out_ ULONG LastCounterValueAndStateArrayElementSize; +} NDIS_GFT_FREE_COUNTER_PARAMETERS, *PNDIS_GFT_FREE_COUNTER_PARAMETERS; + +#define NDIS_SIZEOF_GFT_FREE_COUNTER_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_FREE_COUNTER_PARAMETERS, LastCounterValueAndStateArrayElementSize) + + +// +// NDIS_GFT_COUNTER_INFO is used with NDIS_GFT_COUNTER_INFO_ARRAY +// in OID_GFT_ENUM_COUNTERS. OID_GFT_ENUM_COUNTERS enumerates the +// allocated counters (types, frequency, etc.) and not their values +// +#define NDIS_GFT_COUNTER_INFO_REVISION_1 1 + +typedef struct _NDIS_GFT_COUNTER_INFO +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _Out_ NDIS_GFT_COUNTER_ID CounterIdStart; + _Out_ ULONG NumCounters; + _Out_ NDIS_GFT_COUNTER_UPDATE_FREQUENCY CounterUpdateFrequency; + _Out_ NDIS_GFT_COUNTER_TYPE CounterType; + _Out_ ULONG UpdatePeriod; // in milliseconds +} NDIS_GFT_COUNTER_INFO, *PNDIS_GFT_COUNTER_INFO; + +#define NDIS_SIZEOF_GFT_COUNTER_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_COUNTER_INFO, UpdatePeriod) + + +// +// NDIS_GFT_COUNTER_INFO_ARRAY is used in OID_GFT_ENUM_COUNTERS +// +#define NDIS_GFT_COUNTER_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_COUNTER_INFO_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + // + // The following fields are used to describe an array of NDIS_GFT_COUNTER_INFO + // + _Out_ ULONG CounterInfoArrayOffset; // from the beginning of this structure + _Out_ ULONG CounterInfoArrayNumElements; + _Out_ ULONG CounterInfoArrayElementSize; +} NDIS_GFT_COUNTER_INFO_ARRAY, *PNDIS_GFT_COUNTER_INFO_ARRAY; + +#define NDIS_SIZEOF_GFT_COUNTER_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_COUNTER_INFO_ARRAY, CounterInfoArrayElementSize) + + +// +// NDIS_GFT_COUNTER_VALUE is used with NDIS_GFT_COUNTER_VALUE_ARRAY +// in OID_GFT_COUNTER_VALUES +// + +typedef struct _NDIS_GFT_COUNTER_VALUE +{ + NDIS_GFT_COUNTER_TYPE CounterType; + union + { + NDIS_GFT_PACKET_COUNTER_VALUE Packets; + NDIS_GFT_BYTE_COUNTER_VALUE Bytes; + NDIS_GFT_PACKET_BYTE_COUNTER_VALUE PacketsBytes; + NDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE PacketsBytesAndState; + } CounterValue; +} NDIS_GFT_COUNTER_VALUE, *PNDIS_GFT_COUNTER_VALUE; + +// +// NDIS_GFT_COUNTER_VALUE_ARRAY is used in OID_GFT_COUNTER_VALUES +// + +// +// flags used in Flags field of NDIS_GFT_COUNTER_VALUE_ARRAY +// +#define NDIS_GFT_COUNTER_VALUE_ARRAY_UPDATE_MEMORY_MAPPED_COUNTERS 0x00000001 +#define NDIS_GFT_COUNTER_VALUE_ARRAY_GET_VALUES 0x00000002 + +typedef enum _NDIS_GFT_COUNTER_VALUE_QUERY_METHOD +{ + NdisGftQueryValueQueryMethodUndefined, + NdisGftQueryValueQueryMethodUsingCounterIds, + NdisGftQueryValueQueryMethodUsingFlowEntryIds, + NdisGftQueryValueQueryMethodVPortFlowEntries, + NdisGftQueryValueQueryMethodAllFlowEntries, + NdisGftQueryValueQueryMethodMax +} NDIS_GFT_COUNTER_VALUE_QUERY_METHOD, *PNDIS_GFT_COUNTER_VALUE_QUERY_METHOD; + +#define NDIS_GFT_COUNTER_VALUE_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_COUNTER_VALUE_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + + union + { + _In_ NDIS_GFT_FLOW_ENTRY_ID FlowEntryId; + _In_ NDIS_GFT_COUNTER_ID CounterId; + } StartId; + + _In_ ULONG NumCounters; + + // + // The following fields are used to describe an array of NDIS_GFT_COUNTER_VALUE + // + _Out_ ULONG CounterValueArrayOffset; // from the beginning of this structure + _Out_ ULONG CounterValueArrayNumElements; + _Out_ ULONG CounterValueArrayElementSize; + +} NDIS_GFT_COUNTER_VALUE_ARRAY, *PNDIS_GFT_COUNTER_VALUE_ARRAY; + +#define NDIS_SIZEOF_GFT_COUNTER_VALUE_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_COUNTER_VALUE_ARRAY, CounterValueArrayElementSize) + +// +// NDIS_GFT_STATISTICS is used in OID_GFT_STATISTICS +// + +#define NDIS_GFT_STATISTICS_REVISION_1 1 + +typedef struct _NDIS_GFT_STATISTICS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; // required + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; // optional + _In_ NDIS_GFT_FLOW_ENTRY_ID ProviderFlowEntryId; // optional + + _Out_ ULONG64 Packets; + _Out_ ULONG64 Bytes; + + _Out_ ULONG64 L1CacheHits; // used with TableId and VPortId + _Out_ ULONG64 L2CacheHits; // used with TableId and VPortId + _Out_ ULONG64 L3CacheHits; // used with TableId and VPortId + + _Out_ ULONG64 L1CacheMisses; // used with TableId and VPortId + _Out_ ULONG64 L2CacheMisses; // used with TableId and VPortId + _Out_ ULONG64 L3CacheMisses; // used with TableId and VPortId + +} NDIS_GFT_STATISTICS, *PNDIS_GFT_STATISTICS; + +#define NDIS_SIZEOF_GFT_STATISTICS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_STATISTICS, L3CacheMisses) + + +// +// NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION specifies the action that must +// be taken on a single header group +// +typedef enum _NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION +{ + NdisGftHeaderGroupTranspositionActionUndefined, + NdisGftHeaderGroupTranspositionActionModify, + NdisGftHeaderGroupTranspositionActionIgnore, + NdisGftHeaderGroupTranspositionActionPush, + NdisGftHeaderGroupTranspositionActionPop, + NdisGftHeaderGroupTranspositionActionMax +} NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION, *PNDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION; + + +// +// flags used in Flags fields of NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE +// +#define NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE_DECREMENT_TTL_IF_NOT_ONE 0x00000001 + +// +// NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE defines a header transposition profile +// for a single header group +// +// An array of NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTIONs are used in +// NDIS_GFT_HEADER_TRANSPOSITION_PROFILE structure to define a +// full transposition profile +// + +#define NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE_REVISION_1 1 + +typedef struct _NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE +{ + NDIS_OBJECT_HEADER Header; + + ULONG Flags; + + NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION Action; + + // + // NDIS_GFP_HEADER_PRESENT_xxx + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx + // + ULONG HeaderFields; +} NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE, *PNDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE; + +#define NDIS_SIZEOF_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE, HeaderFields) + + +typedef ULONG NDIS_GFT_CUSTOM_ACTION_TYPE, *PNDIS_GFT_CUSTOM_ACTION_TYPE; + +#define NDIS_GFT_UNDEFINED_CUSTOM_ACTION 0 + +// +// custom action codes up to 256 are reserved +// +#define NDIS_GFT_RESERVED_CUSTOM_ACTIONS 256 + +// +// NDIS_GFT_CUSTOM_ACTION_PROFILE is used in NDIS_GFT_HEADER_TRANSPOSITION_PROFILE +// structure in order to describe a custom action profile. Custom actions profiles follow +// a TLV (Type Length Value) format to allow linking multiple custom action profiles. +// + +#define NDIS_GFT_CUSTOM_ACTION_PROFILE_REVISION_1 1 + +typedef struct _NDIS_GFT_CUSTOM_ACTION_PROFILE +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_GFP_TABLE_TYPE TableType; + NDIS_GFP_PROFILE_ID ProfileId; + + NDIS_GFT_CUSTOM_ACTION_TYPE Type; + ULONG Length; + + union + { + ULONG_PTR Alignment; + _Field_size_bytes_(Length) + UCHAR ActionProfileData[1]; + }; +} NDIS_GFT_CUSTOM_ACTION_PROFILE, *PNDIS_GFT_CUSTOM_ACTION_PROFILE; + +#define NDIS_SIZEOF_NDIS_GFT_CUSTOM_ACTION_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_CUSTOM_ACTION_PROFILE, Alignment) + +// +// NDIS_GFT_HEADER_TRANSPOSITION_PROFILE is used in OID_GFT_HEADER_TRANSPOSITION_PROFILE +// +// This structure defines a transposition profile for multiple header groups +// + +// +// flags used with Flags field of NDIS_GFT_HEADER_TRANSPOSITION_PROFILE +// HTP=Header Transposition Profile +// +#define NDIS_GFT_HTP_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT 0x00000001 +#define NDIS_GFT_HTP_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT 0x00000002 +#define NDIS_GFT_HTP_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000004 +#define NDIS_GFT_HTP_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000008 +#define NDIS_GFT_HTP_COPY_ALL_PACKETS 0x00000010 +#define NDIS_GFT_HTP_COPY_FIRST_PACKET 0x00000020 +#define NDIS_GFT_HTP_COPY_WHEN_TCP_FLAG_SET 0x00000040 +#define NDIS_GFT_HTP_CUSTOM_ACTION_PRESENT 0x00000080 +#define NDIS_GFT_HTP_META_ACTION_BEFORE_HEADER_TRANSPOSITION 0x00000100 + +#define NDIS_GFT_HEADER_TRANSPOSITION_PROFILE_REVISION_1 1 + +typedef struct _NDIS_GFT_HEADER_TRANSPOSITION_PROFILE +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_GFP_TABLE_TYPE TableType; + + NDIS_GFP_PROFILE_ID ProfileId; + + // + // The following fields are used to describe an array of NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE structures + // + ULONG HeaderGroupTranspositionProfileArrayOffset; // from the beginning of this structure + ULONG HeaderGroupTranspositionProfileArrayNumElements; + ULONG HeaderGroupTranspositionProfileArrayElementSize; + + // + // the offset to the beginning of the custom action profile TLVs + // + ULONG CustomActionProfileOffset; +} NDIS_GFT_HEADER_TRANSPOSITION_PROFILE, *PNDIS_GFT_HEADER_TRANSPOSITION_PROFILE; + +#define NDIS_SIZEOF_GFT_HEADER_TRANSPOSITION_PROFILE_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_HEADER_TRANSPOSITION_PROFILE, CustomActionProfileOffset) + + +// +// flags used in Flags fields of NDIS_GFT_HEADER_GROUP_TRANSPOSITION +// +#define NDIS_GFT_HEADER_GROUP_TRANSPOSITION_DECREMENT_TTL_IF_NOT_ONE 0x00000001 + + +// +// NDIS_GFT_HEADER_GROUP_TRANSPOSITION is used in NDIS_GFT_EXACT_MATCH_FLOW_ENTRY +// +#define NDIS_GFT_HEADER_GROUP_TRANSPOSITION_REVISION_1 1 + +typedef struct _NDIS_GFT_HEADER_GROUP_TRANSPOSITION +{ + + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + + NDIS_GFT_HEADER_GROUP_TRANSPOSITION_ACTION Action; + + // + // NDIS_GFP_HEADER_PRESENT_xxx + // + ULONG HeadersPresent; + + // + // NDIS_GFP_HEADER_FIELD_xxx + // + ULONG64 HeaderFields; + + // + // Ethernet header + // + NDIS_GFP_ETHERNET_HEADER_FIELDS EthernetFields; + + // + // IP header + // + union + { + struct + { + IN_ADDR SourceIPAddress; + IN_ADDR DestinationIPAddress; + } IPv4Address; + + struct + { + IN6_ADDR SourceIPAddress; + IN6_ADDR DestinationIPAddress; + } IPv6Address; + } IPAddress; + + UINT8 Ttl; + UINT8 Dscp; + UINT8 IPProtocol; + + // + // transport / encapsulation header + // + union + { + struct + { + USHORT SourcePort; + USHORT DestinationPort; + } Udp; + + struct + { + USHORT SourcePort; + USHORT DestinationPort; + } Tcp; + + struct + { + ULONG TenantId; + USHORT GreProtocol; + USHORT Entropy; + } Encapsulation; + } TransportOrEncapsulation; + +} NDIS_GFT_HEADER_GROUP_TRANSPOSITION, *PNDIS_GFT_HEADER_GROUP_TRANSPOSITION; + +#define NDIS_SIZEOF_GFT_HEADER_GROUP_TRANSPOSITION_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_HEADER_GROUP_TRANSPOSITION, TransportOrEncapsulation) + +// +// NDIS_GFT_FLOW_ENTRY_CACHE_HINT is used to provide a hint to the GFT offload provider +// so it can use its resources more efficiently +// +typedef enum _NDIS_GFT_FLOW_ENTRY_CACHE_HINT +{ + NdisGftFlowEntryCacheHintUndefined = 0, + NdisGftFlowEntryCacheHintLowFrequency = 100, + NdisGftFlowEntryCacheHintMediumFrequency = 200, + NdisGftFlowEntryCacheHintHighFrequency = 300, + NdisGftFlowEntryCacheHintMax = 1000 +} NDIS_GFT_FLOW_ENTRY_CACHE_HINT, *PNDIS_GFT_FLOW_ENTRY_CACHE_HINT; + + +typedef enum _NDIS_GFT_FLOW_ENTRY_STATE +{ + NdisGftFlowEntryStateUndefined, + NdisGftFlowEntryStateDeactivated, + NdisGftFlowEntryStateActivated, + NdisGftFlowEntryStateMax +} NDIS_GFT_FLOW_ENTRY_STATE, *PNDIS_GFT_FLOW_ENTRY_STATE; + +// +// NDIS_GFT_CUSTOM_ACTION is used in NDIS_GFT_EXACT_MATCH_FLOW_ENTRY +// structure in order to describe a custom action. Custom actions follow +// a TLV (Type Length Value) format to allow linking multiple custom actions. +// +// +// flags used in NDIS_GFT_CUSTOM_ACTION +// +#define NDIS_GFT_CUSTOM_ACTION_LAST_ACTION 0x00000001 + +#define NDIS_GFT_CUSTOM_ACTION_REVISION_1 1 + +typedef struct _NDIS_GFT_CUSTOM_ACTION +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + NDIS_GFP_PROFILE_ID ProfileId; + + NDIS_GFT_CUSTOM_ACTION_TYPE Type; + ULONG Length; + + union + { + ULONG_PTR Alignment; + _Field_size_bytes_(Length) + UCHAR ActionData[1]; + }; +} NDIS_GFT_CUSTOM_ACTION, *PNDIS_GFT_CUSTOM_ACTION; + +#define NDIS_SIZEOF_NDIS_GFT_CUSTOM_ACTION_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_CUSTOM_ACTION, Alignment) + + +// +// NDIS_GFT_EXACT_MATCH_FLOW_ENTRY is used with NDIS_GFT_FLOW_ENTRY_ARRAY +// that is used in OID_GFT_ADD_FLOW_ENTRIES and OID_GFT_FLOW_ENTRY_PARAMETERS. +// And with NDIS_GFT_FLOW_ENTRY_INFO_ARRAY that is used in +// OID_GFT_ENUM_FLOW_ENTRIES +// + +// +// flags used in Flags field of NDIS_GFT_EXACT_MATCH_FLOW_ENTRY. +// EMFE = Exact Match Flow Entry +// +// used with OID_GFT_ADD_FLOW_ENTRIES +// +#define NDIS_GFT_EMFE_ADD_IN_ACTIVATED_STATE 0x00000001 +#define NDIS_GFT_EMFE_MATCH_AND_ACTION_MUST_BE_SUPPORTED 0x00000002 + +// +// used with OID_GFT_ADD_FLOW_ENTRIES, OID_GFT_ENUM_FLOW_ENTRIES +// +#define NDIS_GFT_EMFE_RDMA_FLOW 0x00000004 +// +// used with OID_GFT_ADD_FLOW_ENTRIES, OID_GFT_ENUM_FLOW_ENTRIES, OID_GFT_FLOW_ENTRY_PARAMETERS +// +#define NDIS_GFT_EMFE_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT 0x00001000 +#define NDIS_GFT_EMFE_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT 0x00002000 +#define NDIS_GFT_EMFE_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00004000 +#define NDIS_GFT_EMFE_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00008000 +#define NDIS_GFT_EMFE_COPY_ALL_PACKETS 0x00010000 +#define NDIS_GFT_EMFE_COPY_FIRST_PACKET 0x00020000 +#define NDIS_GFT_EMFE_COPY_WHEN_TCP_FLAG_SET 0x00040000 +#define NDIS_GFT_EMFE_CUSTOM_ACTION_PRESENT 0x00080000 +#define NDIS_GFT_EMFE_META_ACTION_BEFORE_HEADER_TRANSPOSITION 0x00100000 +#define NDIS_GFT_EMFE_COPY_AFTER_TCP_FIN_FLAG_SET 0x00200000 +#define NDIS_GFT_EMFE_COPY_AFTER_TCP_RST_FLAG_SET 0x00400000 + +// +// used with OID_GFT_FLOW_ENTRY_PARAMETERS +// +#define NDIS_GFT_EMFE_COPY_CONDITION_CHANGED 0x01000000 +#define NDIS_GFT_EMFE_ALL_VPORT_FLOW_ENTRIES 0x02000000 + + +// +// flags used in CounterFlags field of of NDIS_GFT_EXACT_MATCH_FLOW_ENTRY. +// EMFE = Exact Match Flow Entry +// +#define NDIS_GFT_EMFE_COUNTER_ALLOCATE 0x00000001 +#define NDIS_GFT_EMFE_COUNTER_MEMORY_MAPPED 0x00000002 +#define NDIS_GFT_EMFE_COUNTER_CLIENT_SPECIFIED_ADDRESS 0x00000004 +#define NDIS_GFT_EMFE_COUNTER_TRACK_TCP_FLOW 0x00000008 + +#define NDIS_GFT_EXACT_MATCH_FLOW_ENTRY_REVISION_1 1 + +typedef struct _NDIS_GFT_EXACT_MATCH_FLOW_ENTRY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + + // + // the ID of either ingress or egress VPort + // + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + + _In_ NDIS_GFP_PROFILE_ID MatchProfileId; + + // + // + // allocation or activation status for this flow entry + // + _Out_ NDIS_STATUS MatchRequestStatus; + _Out_ NDIS_STATUS ActionRequestStatus; + + + _In_ ULONG CounterFlags; + _In_ NDIS_GFT_COUNTER_UPDATE_FREQUENCY CounterUpdateFrequency; + _In_ NDIS_GFT_COUNTER_TYPE CounterType; + _In_ ULONG UpdatePeriod; // in milliseconds + union + { + _Inout_ PNDIS_GFT_PACKET_COUNTER_VALUE PacketCounterAddress; + _Inout_ PNDIS_GFT_BYTE_COUNTER_VALUE ByteCounterAddress; + _Inout_ PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE PacketByteCounterAddress; + _Inout_ PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE_AND_STATE PacketByteCounterAndStateAddress; + } CounterValueBuffer; + + // + // optional + // + _In_ NDIS_GFP_PROFILE_ID HeaderTranspositionProfileId; + + + // + // valid only if NDIS_GFT_EMFE_REDIRECT_TO_xxx_VPORT is set + // + _In_ NDIS_NIC_SWITCH_VPORT_ID RedirectionVPortId; + + // + // valid only if NDIS_GFT_EMFE_REDIRECT_TO_xxx_IF_TTL_IS_ONE is set + // + _In_ NDIS_NIC_SWITCH_VPORT_ID TtlIsOneRedirectionVPortId; + + _In_ ULONG NumCounterObjects; + _In_ NDIS_GFT_COUNTER_ID CounterIdArray[NDIS_GFT_MAX_COUNTER_OBJECTS_PER_FLOW_ENTRY]; + + _In_ NDIS_GFT_FLOW_ENTRY_CACHE_HINT CacheHint; + + _Inout_ NDIS_GFT_FLOW_ENTRY_ID ClientFlowEntryId; + _Inout_ NDIS_GFT_FLOW_ENTRY_ID ProviderFlowEntryId; + _Inout_ NDIS_GFT_FLOW_ENTRY_STATE FlowEntryState; // _Out_ for Enum + + _Inout_ ULONG TcpSequenceNumber; + + // + // The following fields are used to describe an array of NDIS_GFP_HEADER_GROUP_EXACT_MATCH structures + // if a match profile ID is specified in MatchProfileId, then these fields must be consistent + // with the specified profile ID + // + _In_ ULONG HeaderGroupExactMatchArrayOffset; // from the beginning of this structure + _In_ ULONG HeaderGroupExactMatchArrayNumElements; + _In_ ULONG HeaderGroupExactMatchArrayElementSize; + + + // + // The following fields are used to describe an array of NDIS_GFT_HEADER_GROUP_TRANSPOSITION structures + // if a header transposition profile ID is specified in HeaderTranspositionProfileId, then these fields must be consistent + // with the specified profile ID + // + _In_ ULONG HeaderGroupTranspositionArrayOffset; // from the beginning of this structure + _In_ ULONG HeaderGroupTranspositionArrayNumElements; + _In_ ULONG HeaderGroupTranspositionArrayElementSize; + + // + // the offset to the beginning of custom action TLVs + // + _In_ ULONG CustomActionOffset; +} NDIS_GFT_EXACT_MATCH_FLOW_ENTRY, *PNDIS_GFT_EXACT_MATCH_FLOW_ENTRY; + +#define NDIS_SIZEOF_GFT_EXACT_MATCH_FLOW_ENTRY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_EXACT_MATCH_FLOW_ENTRY, CustomActionOffset) + +// +// wildcard GFT entries +// + + + +typedef enum _NDIS_GFT_WILDCARD_ACTION +{ + NdisGftWildcardActionUndefined, + NdisGftWildcardActionAllow, + NdisGftWildcardActionDrop, + NdisGftWildcardActionMax +} NDIS_GFT_WILDCARD_ACTION, *PNDIS_GFT_WILDCARD_ACTION; + + +// +// flags used in Flags field of NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY +// WCFE = Wildcard Flow Entry +// +#define NDIS_GFT_WCFE_ADD_IN_ACTIVATED_STATE 0x00000001 +#define NDIS_GFT_WCFE_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT 0x00000002 +#define NDIS_GFT_WCFE_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT 0x00000004 +#define NDIS_GFT_WCFE_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000008 +#define NDIS_GFT_WCFE_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000010 +#define NDIS_GFT_WCFE_COPY_ALL_PACKETS 0x00000020 +#define NDIS_GFT_WCFE_CUSTOM_ACTION_PRESENT 0x00000040 + + +// +// flags used in CounterFlags field of of NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY. +// WCFE = Wildcard Flow Entry +// +#define NDIS_GFT_WCFE_COUNTER_ALLOCATE 0x00000001 +#define NDIS_GFT_WCFE_COUNTER_MEMORY_MAPPED 0x00000002 +#define NDIS_GFT_WCFE_COUNTER_CLIENT_SPECIFIED_ADDRESS 0x00000004 + +// +// NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY is used with NDIS_GFT_FLOW_ENTRY_ARRAY +// that is used in OID_GFT_ADD_FLOW_ENTRT and OID_GFT_FLOW_ENTRY_PARAMETERS +// and with NDIS_GFT_FLOW_ENTRY_INFO_ARRAY that is used in +// OID_GFT_ENUM_FLOW_ENTRIES +// + +#define NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY_REVISION_1 1 + +typedef struct _NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + + // + // the ID of either ingress or egress VPort + // + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + + _In_ NDIS_GFP_PROFILE_ID MatchProfileId; + + // + // + // allocation or activation status for this flow entry + // + _Out_ NDIS_STATUS MatchRequestStatus; + _Out_ NDIS_STATUS ActionRequestStatus; + + + _In_ ULONG CounterFlags; + _In_ NDIS_GFT_COUNTER_UPDATE_FREQUENCY CounterUpdateFrequency; + _In_ NDIS_GFT_COUNTER_TYPE CounterType; + _In_ ULONG UpdatePeriod; // in milliseconds + union + { + _Inout_ PNDIS_GFT_PACKET_COUNTER_VALUE PacketCounterAddress; + _Inout_ PNDIS_GFT_BYTE_COUNTER_VALUE ByteCounterAddress; + _Inout_ PNDIS_GFT_PACKET_BYTE_COUNTER_VALUE PacketByteCounterAddress; + } CounterValueBuffer; + + _In_ ULONG Priority; + _In_ NDIS_GFT_WILDCARD_ACTION Action; + + // + // valid only if NDIS_GFT_WCFE_REDIRECT_TO_xxx_QUEUE_OF_VPORT is set + // + _In_ NDIS_NIC_SWITCH_VPORT_ID RedirectionVPortId; + + // + // valid only if NDIS_GFT_WCFE_REDIRECT_TO_xxx_IF_TTL_IS_ONE is set + // + _In_ NDIS_NIC_SWITCH_VPORT_ID TtlIsOneRedirectionVPortId; + + _In_ ULONG NumCounterObjects; + _In_ NDIS_GFT_COUNTER_ID CounterIdArray[NDIS_GFT_MAX_COUNTER_OBJECTS_PER_FLOW_ENTRY]; + + _In_ NDIS_GFT_FLOW_ENTRY_CACHE_HINT CacheHint; + + _Inout_ NDIS_GFT_FLOW_ENTRY_ID ClientFlowEntryId; + _Inout_ NDIS_GFT_FLOW_ENTRY_ID ProviderFlowEntryId; + + _Out_ NDIS_GFT_FLOW_ENTRY_STATE FlowEntryState; + + // + // The following fields are used to describe an array of NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH structures + // if a match profile ID is specified in MatchProfileId, then these fields must be consistent + // with the specified profile ID + // + _In_ ULONG HeaderGroupWildcardMatchArrayOffset; // from the beginning of this structure + _In_ ULONG HeaderGroupWildcardMatchArrayNumElements; + _In_ ULONG HeaderGroupWildcardMatchArrayElementSize; + + // + // the offset to the beginning of custom action TLVs + // + _In_ ULONG CustomActionOffset; +} NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY, *PNDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY; + +#define NDIS_SIZEOF_GFT_WILDCARD_MATCH_FLOW_ENTRY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY, CustomActionOffset) + +// +// NDIS_GFT_PROFILE_TYPE enum type is used as ProfileType field in +// NDIS_GFT_PROFILE_INFO +// + +typedef enum _NDIS_GFT_PROFILE_TYPE +{ + NdisGftProfileTypeUndefined, + NdisGftProfileTypeExactMatch, + NdisGftProfileTypeHeaderTransposition, + NdisGftProfileTypeWildcardMatch, + NdisGftProfileTypeMax +} NDIS_GFT_PROFILE_TYPE, *PNDIS_GFT_PROFILE_TYPE; + +// +// NDIS_GFT_PROFILE_INFO is used in NDIS_GFT_PROFILE_INFO_ARRAY +// + +#define NDIS_GFT_PROFILE_INFO_REVISION_1 1 + +typedef struct _NDIS_GFT_PROFILE_INFO +{ + _Out_ NDIS_OBJECT_HEADER Header; + _Out_ ULONG Flags; + + _Out_ NDIS_GFT_PROFILE_TYPE ProfileType; + _Out_ NDIS_GFP_TABLE_TYPE TableType; + _Out_ NDIS_GFP_PROFILE_ID ProfileId; + _Out_ ULONG NumSupportedFlowEntries; + _Out_ ULONG NumCurrentFlowEntries; + + // + // The following fields are used to describe an array of NDIS_GFP_HEADER_GROUP_EXACT_MATCH_PROFILE, + // NDIS_GFT_HEADER_GROUP_TRANSPOSITION_PROFILE, or NDIS_GFP_HEADER_GROUP_WILDCARD_MATCH_PROFILE structures + // + // The value of ProfileType field above determines the type of profile the structure + // describes + // + _Out_ ULONG HeaderGroupArrayOffset; // from the beginning of this structure + _Out_ ULONG HeaderGroupArrayNumElements; + _Out_ ULONG HeaderGroupArrayElementSize; + +} NDIS_GFT_PROFILE_INFO, *PNDIS_GFT_PROFILE_INFO; + +#define NDIS_SIZEOF_GFT_PROFILE_INFO_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_PROFILE_INFO, HeaderGroupArrayElementSize) + +// +// NDIS_GFT_PROFILE_INFO_ARRAY is used in OID_GFT_ENUM_PROFILES +// +#define NDIS_GFT_PROFILE_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_PROFILE_INFO_ARRAY +{ + _Out_ NDIS_OBJECT_HEADER Header; + _Out_ ULONG Flags; + + // + // The following fields are used to describe an array of NDIS_GFT_PROFILE_INFO + // + _Out_ ULONG ProfileInfoArrayOffset; // from the beginning of this structure + _Out_ ULONG ProfileInfoArrayNumElements; + _Out_ ULONG ProfileInfoArrayElementSize; +} NDIS_GFT_PROFILE_INFO_ARRAY, *PNDIS_GFT_PROFILE_INFO_ARRAY; + +#define NDIS_SIZEOF_GFT_PROFILE_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_PROFILE_INFO_ARRAY, ProfileArrayElementSize) + +// +// flags used in NDIS_GFT_DELETE_PROFILE_PARAMETERS structure +// +#define NDIS_GFT_DELETE_PROFILE_ALL_PROFILES 0x00000001 + +// +// NDIS_GFT_DELETE_PROFILE_PARAMETERS is used in +// OID_GFT_DELETE_PROFILE +// +#define NDIS_GFT_DELETE_PROFILE_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_DELETE_PROFILE_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_GFP_PROFILE_ID ProfileId; +} NDIS_GFT_DELETE_PROFILE_PARAMETERS, *PNDIS_GFT_DELETE_PROFILE_PARAMETERS; + +#define NDIS_SIZEOF_GFT_DELETE_PROFILE_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_DELETE_PROFILE_PARAMETERS, ProfileId) + +typedef enum _NDIS_GFT_FLOW_ENTRY_TYPE +{ + NdisGftFlowEntryTypeUndefined, + NdisGftFlowEntryTypeExactMatch, + NdisGftFlowEntryTypeWildcard, + NdisGftFlowEntryTypeMax +} NDIS_GFT_FLOW_ENTRY_TYPE, *PNDIS_GFT_FLOW_ENTRY_TYPE; + + +// +// NDIS_GFT_FLOW_ENTRY_ARRAY is used in OID_GFT_ADD_FLOW_ENTRIES +// OID_GFT_FLOW_ENTRY_PARAMETERS +// +#define NDIS_GFT_FLOW_ENTRY_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_FLOW_ENTRY_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + NDIS_GFT_FLOW_ENTRY_TYPE EntryType; + + // + // The following fields are used to describe an array of NDIS_GFT_EXACT_MATCH_FLOW_ENTRY + // or NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY structures. The table type of the table identified by + // TableId field above determines the type of the flow entries that are added. + // + ULONG FlowEntryArrayOffset; // from the beginning of this structure + ULONG FlowEntryArrayNumElements; + ULONG FlowEntryArrayElementSize; +} NDIS_GFT_FLOW_ENTRY_ARRAY, *PNDIS_GFT_FLOW_ENTRY_ARRAY; + +#define NDIS_SIZEOF_GFT_FLOW_ENTRY_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_FLOW_ENTRY_ARRAY, FlowEntryArrayElementSize) + +// +// flags used in NDIS_GFT_FLOW_ENTRY_INFO_ARRAY structure +// +#define NDIS_GFT_FLOW_ENTRY_INFO_ALL_FLOW_ENTRIES 0x00000001 + +// +// NDIS_GFT_FLOW_ENTRY_INFO_ARRAY is used in OID_GFT_ENUM_FLOW_ENTRIES +// +#define NDIS_GFT_FLOW_ENTRY_INFO_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_FLOW_ENTRY_INFO_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + + // + // optional fields for limiting the number of flows enumerated in + // a single call + // + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + _In_ NDIS_GFT_FLOW_ENTRY_ID ProviderFlowEntryIdStart; + _In_ ULONG FlowEntryIdCount; + + // + // The following fields are used to describe an array of NDIS_GFT_EXACT_MATCH_FLOW_ENTRY + // or NDIS_GFT_WILDCARD_MATCH_FLOW_ENTRY structures. The table type of the table identified by + // TableId field above determines the type of the flows that are enumerated. + // + _Out_ ULONG FlowEntryInfoArrayOffset; // from the beginning of this structure + _Out_ ULONG FlowEntryInfoArrayNumElements; + _Out_ ULONG FlowEntryInfoArrayElementSize; +} NDIS_GFT_FLOW_ENTRY_INFO_ARRAY, *PNDIS_GFT_FLOW_ENTRY_INFO_ARRAY; + +#define NDIS_SIZEOF_GFT_FLOW_ENTRY_INFO_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_FLOW_ENTRY_INFO_ARRAY, FlowEntryInfoArrayElementSize) + + +// +// flags used in NDIS_GFT_FLOW_ENTRY_ID_ARRAY structure +// +#define NDIS_GFT_FLOW_ENTRY_ID_ALL_NIC_SWITCH_FLOW_ENTRIES 0x00000001 +#define NDIS_GFT_FLOW_ENTRY_ID_ALL_TABLE_FLOW_ENTRIES 0x00000002 +#define NDIS_GFT_FLOW_ENTRY_ID_ALL_VPORT_FLOW_ENTRIES 0x00000004 +#define NDIS_GFT_FLOW_ENTRY_ID_RANGE_DEFINED 0x00000008 +#define NDIS_GFT_FLOW_ENTRY_ID_ARRAY_DEFINED 0x00000010 +#define NDIS_GFT_FLOW_ENTRY_ID_ARRAY_COUNTER_VALUES 0x00010000 + +// +// In NDIS 6.50, NDIS_GFT_FLOW_ENTRY_ID_AND_COUNTER structure is used in +// NDIS_GFT_FLOW_ENTRY_ID_ARRAY with OID_GFT_DELETE_FLOW_ENTRIES or OID_GFT_DEACTIVATE_FLOW_ENTRIES +// +typedef struct _NDIS_GFT_FLOW_ENTRY_ID_AND_COUNTER +{ + NDIS_GFT_FLOW_ENTRY_ID FlowEntryId; + NDIS_GFT_COUNTER_VALUE CounterValue; +} NDIS_GFT_FLOW_ENTRY_ID_AND_COUNTER, *PNDIS_GFT_FLOW_ENTRY_ID_AND_COUNTER; + +// +// NDIS_GFT_FLOW_ENTRY_ID_ARRAY is used in OID_GFT_DELETE_FLOW_ENTRIES, OID_GFT_ACTIVATE_FLOW_ENTRIES +// and OID_GFT_DEACTIVATE_FLOW_ENTRIES +// +#define NDIS_GFT_FLOW_ENTRY_ID_ARRAY_REVISION_1 1 + +typedef struct _NDIS_GFT_FLOW_ENTRY_ID_ARRAY +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + + _In_ NDIS_GFT_TABLE_ID TableId; + + // + // optional fields for limiting the number of flows affected in + // a single call + // + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + _In_ union + { + struct + { + // + // The following fields are used to describe an array of NDIS_GFT_FLOW_ENTRY_IDs + // + ULONG ProviderFlowEntryIdArrayOffset; // from the beginning of this structure + ULONG ProviderFlowEntryIdArrayNumElements; + ULONG ProviderFlowEntryIdArrayElementSize; + } FlowEntryIdArray; + + struct + { + // + // The following fields are used to describe an array of NDIS_GFT_FLOW_ENTRY_ID_AND_COUNTERs + // + ULONG ProviderFlowEntryIdAndCounterArrayOffset; // from the beginning of this structure + ULONG ProviderFlowEntryIdAndCounterArrayNumElements; + ULONG ProviderFlowEntryIdAndCounterArrayElementSize; + } FlowEntryIdAndCounterArray; + + } IdArray; + +} NDIS_GFT_FLOW_ENTRY_ID_ARRAY, *PNDIS_GFT_FLOW_ENTRY_ID_ARRAY; + +#define NDIS_SIZEOF_GFT_FLOW_ENTRY_ID_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_FLOW_ENTRY_ID_ARRAY, IdArray) + + + +// +// Flags used in NDIS_GFT_OFFLOAD_PARAMETERS +// +#define NDIS_GFT_OFFLOAD_PARAMETERS_ENABLE_OFFLOAD 0x00000001 +#define NDIS_GFT_OFFLOAD_PARAMETERS_CUSTOM_PROVIDER_RESERVED 0xFF000000 + +// +// NDIS_GFT_OFFLOAD_PARAMETERS is used in OID_GFT_GLOBAL_PARAMETERS +// and NDIS_STATUS_GFT_OFFLOAD_CURRENT_CONFIG status indication +// + +#define NDIS_GFT_OFFLOAD_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_OFFLOAD_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + + // + // Copy and sample VPorts are the same as the exception VPort + // + NDIS_NIC_SWITCH_VPORT_ID ExceptionVPortId; + + // + // The aggregated length of the headers that are copied + // + ULONG CopyLookaheadLength; + ULONG SampleLookaheadLength; + +} NDIS_GFT_OFFLOAD_PARAMETERS, *PNDIS_GFT_OFFLOAD_PARAMETERS; + +#define NDIS_SIZEOF_GFT_OFFLOAD_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_OFFLOAD_PARAMETERS, SampleLookaheadLength) + +// +// NDIS_GFT_OFFLOAD_CAPABILITIES is used in OID_GFT_HARDWARE_CAPABILITIES, +// OID_GFT_CURRENT_CAPABILITIES, NDIS_STATUS_GFT_OFFLOAD_CURRENT_CAPABILITIES +// and NDIS_STATUS_GFT_OFFLOAD_HARDWARE_CAPABILITIES +// + +// +// flags used in Flags field of NDIS_GFT_OFFLOAD_CAPABILITIES +// +#define NDIS_GFT_OFFLOAD_CAPS_ADD_FLOW_ENTRY_DEACTIVATED_PREFERRED 0x00000001 +#define NDIS_GFT_OFFLOAD_CAPS_RATE_LIMITING_QUEUE_SUPPORTED 0x00000002 + + +// +// flags used in CounterCapabilities field of NDIS_GFT_OFFLOAD_CAPABILITIES +// +#define NDIS_GFT_OFFLOAD_CAPS_MEMORY_MAPPED_COUNTERS 0x00000001 +#define NDIS_GFT_OFFLOAD_CAPS_MEMORY_MAPPED_PAKCET_AND_BYTE_COUNTERS 0x00000002 +#define NDIS_GFT_OFFLOAD_CAPS_PER_FLOW_ENTRY_COUNTERS 0x00000004 +#define NDIS_GFT_OFFLOAD_CAPS_PER_PACKET_COUNTER_UPDATE 0x00000008 +#define NDIS_GFT_OFFLOAD_CAPS_CLIENT_SPECIFIED_MEMORY_MAPPED_COUNTERS 0x00000010 +#define NDIS_GFT_OFFLOAD_CAPS_INGRESS_AGGREGATE_COUNTERS 0x00000020 +#define NDIS_GFT_OFFLOAD_CAPS_EGRESS_AGGREGATE_COUNTERS 0x00000040 +#define NDIS_GFT_OFFLOAD_CAPS_TRACK_TCP_FLOW_STATE 0x00000080 +#define NDIS_GFT_OFFLOAD_CAPS_COMBINED_COUNTER_AND_STATE 0x00000100 + + +// +// flags used in SupportedTableTypes field of NDIS_GFT_OFFLOAD_CAPABILITIES +// +#define NDIS_GFT_OFFLOAD_CAPS_INGRESS_WILDCARD_MATCH 0x00000001 +#define NDIS_GFT_OFFLOAD_CAPS_EGRESS_WILDCARD_MATCH 0x00000002 +#define NDIS_GFT_OFFLOAD_CAPS_INGRESS_EXACT_MATCH 0x00000004 +#define NDIS_GFT_OFFLOAD_CAPS_EGRESS_EXACT_MATCH 0x00000008 +#define NDIS_GFT_OFFLOAD_CAPS_EXT_VPORT_INGRESS_WILDCARD_MATCH 0x00000010 +#define NDIS_GFT_OFFLOAD_CAPS_EXT_VPORT_EGRESS_WILDCARD_MATCH 0x00000020 +#define NDIS_GFT_OFFLOAD_CAPS_EXT_VPORT_INGRESS_EXACT_MATCH 0x00000040 +#define NDIS_GFT_OFFLOAD_CAPS_EXT_VPORT_EGRESS_EXACT_MATCH 0x00000080 + +// +// supported actions +// +#define NDIS_GFT_OFFLOAD_CAPS_POP 0x00000001 +#define NDIS_GFT_OFFLOAD_CAPS_PUSH 0x00000002 +#define NDIS_GFT_OFFLOAD_CAPS_MODIFY 0x00000004 +#define NDIS_GFT_OFFLOAD_CAPS_IGNORE_ACTION_SUPPORTED 0x00000008 +#define NDIS_GFT_OFFLOAD_CAPS_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT 0x00000010 +#define NDIS_GFT_OFFLOAD_CAPS_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT 0x00000020 +#define NDIS_GFT_OFFLOAD_CAPS_REDIRECT_TO_INGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000040 +#define NDIS_GFT_OFFLOAD_CAPS_REDIRECT_TO_EGRESS_QUEUE_OF_VPORT_IF_TTL_IS_ONE 0x00000080 +#define NDIS_GFT_OFFLOAD_CAPS_COPY_ALL 0x00000100 +#define NDIS_GFT_OFFLOAD_CAPS_COPY_FIRST 0x00000200 +#define NDIS_GFT_OFFLOAD_CAPS_COPY_WHEN_TCP_FLAG_SET 0x00000400 +#define NDIS_GFT_OFFLOAD_CAPS_SAMPLE 0x00000800 +#define NDIS_GFT_OFFLOAD_CAPS_META_ACTION_BEFORE_HEADER_TRANSPOSITION 0x00001000 +#define NDIS_GFT_OFFLOAD_CAPS_META_ACTION_AFTER_HEADER_TRANSPOSITION 0x00002000 +#define NDIS_GFT_OFFLOAD_CAPS_PER_VPORT_EXCEPTION_VPORT 0x00004000 +#define NDIS_GFT_OFFLOAD_CAPS_DESIGNATED_EXCEPTION_VPORT 0x00008000 +#define NDIS_GFT_OFFLOAD_CAPS_DSCP_MASK 0x00010000 +#define NDIS_GFT_OFFLOAD_CAPS_8021P_PRIORITY_MASK 0x00020000 +#define NDIS_GFT_OFFLOAD_CAPS_ALLOW 0x00040000 +#define NDIS_GFT_OFFLOAD_CAPS_DROP 0x00080000 + +// +// NDIS_GFT_OFFLOAD_CAPABILITIES structure advertises the GFT offload capabilities of +// the miniport adapter. This structure is used in NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES +// + +#define NDIS_GFT_OFFLOAD_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_GFT_OFFLOAD_CAPABILITIES +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG CounterCapabilities; + ULONG SupportedTableTypes; + + // NDIS_GFP_ENCAPSULATION_TYPE_xxx + ULONG SupportedEncapsulationTypes; + + ULONG SupportedIngressExactMatchTableActions; + ULONG SupportedEgressExactMatchTableActions; + ULONG SoftwareSupportedIngressExactMatchTableActions; + ULONG SoftwareSupportedEgressExactMatchTableActions; + + ULONG SupportedIngressWildcardMatchTableActions; + ULONG SupportedEgressWildcardMatchTableActions; + ULONG SoftwareSupportedIngressWildcardMatchTableActions; + ULONG SoftwareSupportedEgressWildcardMatchTableActions; + + // + // Number of discrete counter objects. does not include per flow entry counters that the provider + // might support. + // + ULONG NumPacketCounterObjects; + ULONG NumByteCounterObjects; + ULONG NumPacketByteCounterObjects; + ULONG NumPacketByteCounterAndStateObjects; + ULONG NumCounterObjectsPerIngressExactMatchFlowEntry; + ULONG NumCounterObjectsPerEgressExactMatchFlowEntry; + ULONG NumCounterObjectsPerIngressWildcardMatchFlowEntry; + ULONG NumCounterObjectsPerEgressWildcardMatchFlowEntry; +} NDIS_GFT_OFFLOAD_CAPABILITIES, *PNDIS_GFT_OFFLOAD_CAPABILITIES; + +#define NDIS_SIZEOF_GFT_OFFLOAD_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_OFFLOAD_CAPABILITIES, NumCounterObjectsPerEgressWildcardMatchFlowEntry) + + +// +// flags used in Flags field of NDIS_GFT_VPORT_PARAMETERS +// +#define NDIS_GFT_VPORT_ENABLE 0x00000001 +#define NDIS_GFT_VPORT_PARSE_VXLAN 0x00000002 +#define NDIS_GFT_VPORT_PARSE_VXLAN_NOT_IN_SRC_PORT_RANGE 0x00000004 + +#define NDIS_GFT_VPORT_ENABLE_STATE_CHANGED 0x00100000 +#define NDIS_GFT_VPORT_EXCEPTION_VPORT_CHANGED 0x00200000 +#define NDIS_GFT_VPORT_SAMPLING_RATE_CHANGED 0x00400000 +#define NDIS_GFT_VPORT_DSCP_MASK_CHANGED 0x00800000 +#define NDIS_GFT_VPORT_PRIORITY_MASK_CHANGED 0x01000000 +#define NDIS_GFT_VPORT_VXLAN_SETTINGS_CHANGED 0x02000000 +#define NDIS_GFT_VPORT_DSCP_FLAGS_CHANGED 0x04000000 +#define NDIS_GFT_VPORT_PARAMS_CHANGE_MASK 0xFFF00000 +#define NDIS_GFT_VPORT_PARAMS_CUSTOM_PROVIDER_RESERVED 0x000FF000 + +#define NDIS_GFT_VPORT_MAX_DSCP_MASK_COUNTER_OBJECTS 64 +#define NDIS_GFT_VPORT_MAX_PRIORITY_MASK_COUNTER_OBJECTS 8 + + +// +// Dscp flags used in DscpFlags field of NDIS_GFT_VPORT_PARAMETERS +// +#define NDIS_GFT_VPORT_DSCP_GUARD_ENABLE_RX 0x00000001 +#define NDIS_GFT_VPORT_DSCP_GUARD_ENABLE_TX 0x00000002 +#define NDIS_GFT_VPORT_DSCP_MASK_ENABLE_RX 0x00000004 +#define NDIS_GFT_VPORT_DSCP_MASK_ENABLE_TX 0x00000008 + +// +// NDIS_GFT_VPORT_PARAMETERS is used in OID_GFT_VPORT_PARAMETERS +// + +#define NDIS_GFT_VPORT_PARAMETERS_REVISION_1 1 + +typedef struct _NDIS_GFT_VPORT_PARAMETERS +{ + _In_ NDIS_OBJECT_HEADER Header; + _In_ ULONG Flags; + _In_ NDIS_NIC_SWITCH_VPORT_ID VPortId; + + // + // Copy and sample VPorts are the same as the exception VPort + // + _In_ NDIS_NIC_SWITCH_VPORT_ID ExceptionVPortId; + + // + // on query, sampling rate is an out parameter and returns the current sampling rate + // on set, sampling rate is an "in" parameter + // 0 means no sampling. Any value "n" other than 0 means one sample for every "n" packet + // + _Inout_ ULONG SamplingRate; + + _In_ ULONG64 DscpMask; + _In_ ULONG NumDscpMaskCounterObjects; + _In_ NDIS_GFT_COUNTER_ID DscpMaskCounterIdArray[NDIS_GFT_VPORT_MAX_DSCP_MASK_COUNTER_OBJECTS]; + + _In_ ULONG64 PriorityMask; + _In_ ULONG NumPriorityMaskCounterObjects; + _In_ NDIS_GFT_COUNTER_ID PriorityMaskCounterIdArray[NDIS_GFT_VPORT_MAX_PRIORITY_MASK_COUNTER_OBJECTS]; + _In_ USHORT VxLanSrcPortBase; + _In_ USHORT VxLanSrcPortRange; + _In_ ULONG DscpFlags; + union { + _In_ PVOID CustomProviderReservedPointer; + _In_ ULONG64 CustomProviderReservedValue; + }; +} NDIS_GFT_VPORT_PARAMETERS, *PNDIS_GFT_VPORT_PARAMETERS; + +#define NDIS_SIZEOF_GFT_VPORT_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_GFT_VPORT_PARAMETERS, CustomProviderReservedValue) + +// +// QOS Offload Scheduler Queue data structures +// +typedef ULONG NDIS_QOS_SQ_ID, *PNDIS_QOS_SQ_ID; +#define NDIS_QOS_DEFAULT_SQ_ID 0 + +// +// NDIS_QOS_SQ_TYPE specifies the type of SQ. Used with NDIS_QOS_SQ_PARAMETERS +// in OID_QOS_OFFLOAD_ENUM_SQS. +// +typedef enum _NDIS_QOS_SQ_TYPE +{ + NdisQosSqTypeUndefined, + NdisQosSqTypeStandard, + NdisQosSqTypeGFT, + NdisQosSqTypeMax +} NDIS_QOS_SQ_TYPE, *PNDIS_QOS_SQ_TYPE; + +// +// NDIS_QOS_SQ_PARAMETERS is used in OID_QOS_OFFLOAD_ENUM_SQS. +// +#define NDIS_QOS_SQ_PARAMETERS_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_QOS_SQ_PARAMETERS_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS684) + +typedef struct _NDIS_QOS_SQ_PARAMETERS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_QOS_SQ_ID SqId; + NDIS_QOS_SQ_TYPE SqType; + BOOLEAN TcEnabledTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + ULONG TcTransmitBandwidthCapTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + ULONG TcTransmitBandwidthReservationTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + ULONG TcReceiveBandwidthCapTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; +#if (NDIS_SUPPORT_NDIS684) + ULONG CrossTcTransmitBandwidthCap; + ULONG MaxNumSqInputs; +#endif // (NDIS_SUPPORT_NDIS684) +} NDIS_QOS_SQ_PARAMETERS, *PNDIS_QOS_SQ_PARAMETERS; + +#define NDIS_SIZEOF_QOS_SQ_PARAMETERS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_SQ_PARAMETERS, TcReceiveBandwidthCapTable) +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_SIZEOF_QOS_SQ_PARAMETERS_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_SQ_PARAMETERS, MaxNumSqInputs) +#endif // (NDIS_SUPPORT_NDIS684) + +// +// Used in NDIS_QOS_SQ_PARAMETERS Flags Field +// +#define NDIS_QOS_SQ_TRANSMIT_CAP_ENABLED 0x00000001 +#define NDIS_QOS_SQ_TRANSMIT_RESERVATION_ENABLED 0x00000002 +#define NDIS_QOS_SQ_RECEIVE_CAP_ENABLED 0x00000004 + + +// +// NDIS_QOS_SQ_PARAMETERS_ARRAY name is deprecated in favor of +// the more generice NDIS_QOS_SQ_ARRAY name, since it's used +// for more than just OID_QOS_OFFLOAD_ENUM_SQS. +// +// Used in OID_QOS_OFFLOAD_ENUM_SQS and OID_QOS_OFFLOAD_SQ_STATS +// +#define NDIS_QOS_SQ_PARAMETERS_ARRAY_REVISION_1 1 + +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_QOS_SQ_ARRAY_REVISION_1 1 +#endif // (NDIS_SUPPORT_NDIS684) + +typedef struct _NDIS_QOS_SQ_PARAMETERS_ENUM_ARRAY +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_QOS_SQ_TYPE SqType; + NDIS_QOS_SQ_ID FirstSqId; + ULONG MaxSqsToReturn; +#if (NDIS_SUPPORT_NDIS684) + union + { + ULONG SqArrayOffset; + ULONG SqParamsArrayOffset; + }; + union + { + ULONG SqArrayNumElements; + ULONG SqParamsArrayNumElements; + }; + union + { + ULONG SqArrayElementSize; + ULONG SqParamsArrayElementSize; + }; +#else + ULONG SqParamsArrayOffset; + ULONG SqParamsArrayNumElements; + ULONG SqParamsArrayElementSize; +#endif // (NDIS_SUPPORT_NDIS684) +} NDIS_QOS_SQ_PARAMETERS_ENUM_ARRAY, *PNDIS_QOS_SQ_PARAMETERS_ENUM_ARRAY; + +#if (NDIS_SUPPORT_NDIS684) +typedef struct _NDIS_QOS_SQ_PARAMETERS_ENUM_ARRAY NDIS_QOS_SQ_ARRAY, *PNDIS_QOS_SQ_ARRAY; +#define NDIS_SIZEOF_QOS_SQ_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_SQ_ARRAY, SqArrayElementSize) +#endif // (NDIS_SUPPORT_NDIS684) + +#define NDIS_SIZEOF_QOS_SQ_PARAMETERS_ENUM_ARRAY_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_SQ_PARAMETERS_ENUM_ARRAY, SqParamsArrayElementSize) + + +// +// NDIS_QOS_OFFLOAD_CAPABILITIES is used in the +// NDIS_MINIPORT_ADAPTER_HARDWARE_ASSIST_ATTRIBUTES structure and +// OID_QOS_OFFLOAD_HARDWARE_CAPABILITIES and +// OID_QOS_OFFLOAD_CURRENT_CAPABILITIES. +// +#define NDIS_QOS_OFFLOAD_CAPABILITIES_REVISION_1 1 +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_QOS_OFFLOAD_CAPABILITIES_REVISION_2 2 +#endif // (NDIS_SUPPORT_NDIS684) + +typedef struct _NDIS_QOS_OFFLOAD_CAPABILITIES +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + ULONG SupportedSqTypes; + BOOLEAN TransmitCapSupported[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + BOOLEAN TransmitReservationSupported[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + BOOLEAN ReceiveCapSupported[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + BOOLEAN TransmitGftCapSupported[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + BOOLEAN ReceiveGftCapSupported[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + BOOLEAN TcSupportedTable[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + ULONG NumStandardSqsSupported; + ULONG NumGftSqsSupported; + ULONG ReservationGranularitySupported; + ULONG MaxNumSqInputs; +#if (NDIS_SUPPORT_NDIS684) + BOOLEAN CrossTcTransmitMaxCapSupported; +#endif // (NDIS_SUPPORT_NDIS684) +} NDIS_QOS_OFFLOAD_CAPABILITIES, *PNDIS_QOS_OFFLOAD_CAPABILITIES; + +#define NDIS_SIZEOF_QOS_OFFLOAD_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_OFFLOAD_CAPABILITIES, MaxNumSqInputs) +#if (NDIS_SUPPORT_NDIS684) +#define NDIS_SIZEOF_QOS_OFFLOAD_CAPABILITIES_REVISION_2 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_OFFLOAD_CAPABILITIES, CrossTcTransmitMaxCapSupported) +#endif // (NDIS_SUPPORT_NDIS684) + +// +// Used in NDIS_QOS_OFFLOAD_CAPABILITIES SupportedSqTypes Field +// +#define NDIS_QOS_OFFLOAD_CAPS_STANDARD_SQ 0x00000001 +#define NDIS_QOS_OFFLOAD_CAPS_GFT_SQ 0x00000002 + +#endif // (NDIS_SUPPORT_NDIS650) + +#if (NDIS_SUPPORT_NDIS685) + +#define NDIS_QOS_SQ_STATS_REVISION_1 1 + +typedef struct _NDIS_QOS_SQ_STATS +{ + NDIS_OBJECT_HEADER Header; + ULONG Flags; + NDIS_QOS_SQ_ID SqId; + NDIS_QOS_SQ_TYPE SqType; + UINT64 BytesTransmitted[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; + UINT64 PktsTransmitted[NDIS_QOS_MAXIMUM_TRAFFIC_CLASSES]; +} NDIS_QOS_SQ_STATS, *PNDIS_QOS_SQ_STATS; + +#define NDIS_SIZEOF_QOS_SQ_STATS_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_QOS_SQ_STATS, PktsTransmitted) + +#endif // (NDIS_SUPPORT_NDIS685) + +#if ((NTDDI_VERSION >= NTDDI_WIN10_RS5) || NDIS_SUPPORT_NDIS682) + + +#define NDIS_TIMESTAMP_CAPABILITIES_REVISION_1 1 + +typedef struct _NDIS_TIMESTAMP_CAPABILITY_FLAGS +{ + BOOLEAN PtpV2OverUdpIPv4EventMsgReceiveHw; + BOOLEAN PtpV2OverUdpIPv4AllMsgReceiveHw; + BOOLEAN PtpV2OverUdpIPv4EventMsgTransmitHw; + BOOLEAN PtpV2OverUdpIPv4AllMsgTransmitHw; + BOOLEAN PtpV2OverUdpIPv6EventMsgReceiveHw; + BOOLEAN PtpV2OverUdpIPv6AllMsgReceiveHw; + BOOLEAN PtpV2OverUdpIPv6EventMsgTransmitHw; + BOOLEAN PtpV2OverUdpIPv6AllMsgTransmitHw; + BOOLEAN AllReceiveHw; + BOOLEAN AllTransmitHw; + BOOLEAN TaggedTransmitHw; + BOOLEAN AllReceiveSw; + BOOLEAN AllTransmitSw; + BOOLEAN TaggedTransmitSw; +} NDIS_TIMESTAMP_CAPABILITY_FLAGS, *PNDIS_TIMESTAMP_CAPABILITY_FLAGS; + +typedef struct _NDIS_TIMESTAMP_CAPABILITIES +{ + NDIS_OBJECT_HEADER Header; + + ULONG64 HardwareClockFrequencyHz; + BOOLEAN CrossTimestamp; + ULONG64 Reserved1; + ULONG64 Reserved2; + NDIS_TIMESTAMP_CAPABILITY_FLAGS TimestampFlags; + +} NDIS_TIMESTAMP_CAPABILITIES, *PNDIS_TIMESTAMP_CAPABILITIES; + + +#define NDIS_SIZEOF_TIMESTAMP_CAPABILITIES_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_TIMESTAMP_CAPABILITIES, TimestampFlags) + + +#define OID_TIMESTAMP_CAPABILITY 0x00A00001 +#define OID_TIMESTAMP_CURRENT_CONFIG 0x00A00002 + +#define NDIS_HARDWARE_CROSSTIMESTAMP_REVISION_1 1 + +typedef struct _NDIS_HARDWARE_CROSSTIMESTAMP +{ + NDIS_OBJECT_HEADER Header; + + ULONG Flags; + ULONG64 SystemTimestamp1; + ULONG64 HardwareClockTimestamp; + ULONG64 SystemTimestamp2; + +} NDIS_HARDWARE_CROSSTIMESTAMP, *PNDIS_HARDWARE_CROSSTIMESTAMP; + +#define NDIS_SIZEOF_HARDWARE_CROSSTIMESTAMP_REVISION_1 \ + RTL_SIZEOF_THROUGH_FIELD(NDIS_HARDWARE_CROSSTIMESTAMP, SystemTimestamp2) + +#define OID_TIMESTAMP_GET_CROSSTIMESTAMP 0x00A00003 + + +#endif //((NTDDI_VERSION >= NTDDI_WIN10_RS5) || NDIS_SUPPORT_NDIS682) + + + +#if (NDIS_SUPPORT_NDIS685) + +// +// OID_QUIC_CONNECTION_ENCRYPTION is a direct OID used for QUIC connection +// encryption offload. +// +#define OID_QUIC_CONNECTION_ENCRYPTION 0xFC010215 + +#endif // (NDIS_SUPPORT_NDIS685) + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 + +#pragma warning(pop) + +#else + +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _NTDDNDIS_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddpar.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddpar.h new file mode 100644 index 0000000000000000000000000000000000000000..fbdff39f0fa4b7dfb23cfc119af15f14b2b15dc1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddpar.h @@ -0,0 +1,185 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddpar.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Parallel device. + + +--*/ + +// +// Interface GUID +// +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// +// #ifdef WANT_WDM +#ifndef FAR +#define FAR +#endif + +#ifdef DEFINE_GUID + +#if (NTDDI_VERSION >= NTDDI_WINXP) // Windows XP Version + +DEFINE_GUID(GUID_DEVINTERFACE_PARALLEL, 0x97F76EF0, 0xF883, 0x11D0, 0xAF, 0x1F, 0x00, 0x00, 0xF8, 0x00, 0x84, 0x5C); +DEFINE_GUID(GUID_DEVINTERFACE_PARCLASS, 0x811FC6A5, 0xF728, 0x11D0, 0xA5, 0x37, 0x00, 0x00, 0xF8, 0x75, 0x3E, 0xD1); + +// +// Obsolete device interface class GUID names. +// (use of above GUID_DEVINTERFACE_* names is recommended). +// + +#define GUID_PARALLEL_DEVICE GUID_DEVINTERFACE_PARALLEL +#define GUID_PARCLASS_DEVICE GUID_DEVINTERFACE_PARCLASS + +#else // if ( NTDDI_VERSION ... ) + +DEFINE_GUID(GUID_PARALLEL_DEVICE, 0x97F76EF0, 0xF883, 0x11D0, 0xAF, 0x1F, 0x00, 0x00, 0xF8, 0x00, 0x84, 0x5C); +DEFINE_GUID(GUID_PARCLASS_DEVICE, 0x811FC6A5, 0xF728, 0x11D0, 0xA5, 0x37, 0x00, 0x00, 0xF8, 0x75, 0x3E, 0xD1); + +#endif // if ( NTDDI_VERSION ... ) + +#endif +// #endif + +#ifndef _NTDDPAR_ +#define _NTDDPAR_ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_PAR_BASE FILE_DEVICE_PARALLEL_PORT +#define IOCTL_PAR_QUERY_INFORMATION CTL_CODE(FILE_DEVICE_PARALLEL_PORT,1,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_PAR_SET_INFORMATION CTL_CODE(FILE_DEVICE_PARALLEL_PORT,2,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// +// Returns NULL terminated device ID string +// +#define IOCTL_PAR_QUERY_DEVICE_ID CTL_CODE(FILE_DEVICE_PARALLEL_PORT,3,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// +// Returns buffer size required for a call to IOCTL_PAR_QUERY_DEVICE_ID +// to succeed. This includes device ID size plus space for terminating NULL. +// +#define IOCTL_PAR_QUERY_DEVICE_ID_SIZE CTL_CODE(FILE_DEVICE_PARALLEL_PORT,4,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_IEEE1284_GET_MODE CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_IEEE1284_NEGOTIATE CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_SET_WRITE_ADDRESS CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_SET_READ_ADDRESS CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_GET_DEVICE_CAPS CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 9, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_GET_DEFAULT_MODES CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 10, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_PING CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 11, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Similar to IOCTL_PAR_QUERY_DEVICE_ID above, but includes (i.e., does +// not discard) the two byte size prefix returned by the device. +// +#define IOCTL_PAR_QUERY_RAW_DEVICE_ID CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_ECP_HOST_RECOVERY CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 13, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_GET_READ_ADDRESS CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_GET_WRITE_ADDRESS CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 15, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PAR_TEST CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 20, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_PAR_IS_PORT_FREE CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 21, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#if (NTDDI_VERSION >= NTDDI_WINXP) // Windows XP Version + +// returns Location of the port - generally of the form: LPTx or LPTx.y or LPTx.y-z +#define IOCTL_PAR_QUERY_LOCATION CTL_CODE(FILE_DEVICE_PARALLEL_PORT, 22, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#endif // if (NTDDI_VERSION ... ) + +// +// NtDeviceIoControlFile InputBuffer/OutputBuffer record structures for +// this device. +// + +typedef struct _PAR_QUERY_INFORMATION{ + UCHAR Status; +} PAR_QUERY_INFORMATION, *PPAR_QUERY_INFORMATION; + +typedef struct _PAR_SET_INFORMATION{ + UCHAR Init; +} PAR_SET_INFORMATION, *PPAR_SET_INFORMATION; + +#define PARALLEL_INIT 0x1 +#define PARALLEL_AUTOFEED 0x2 +#define PARALLEL_PAPER_EMPTY 0x4 +#define PARALLEL_OFF_LINE 0x8 +#define PARALLEL_POWER_OFF 0x10 +#define PARALLEL_NOT_CONNECTED 0x20 +#define PARALLEL_BUSY 0x40 +#define PARALLEL_SELECTED 0x80 + +// +// This is the structure returned by IOCTL_PAR_QUERY_DEVICE_ID_SIZE. +// + +typedef struct _PAR_DEVICE_ID_SIZE_INFORMATION { + ULONG DeviceIdSize; +} PAR_DEVICE_ID_SIZE_INFORMATION, *PPAR_DEVICE_ID_SIZE_INFORMATION; + + +// +// These constants are used for usReadMask and usWriteMask components of the +// PARCLASS_NEGOTIATION_MASK structure that is used for: +// +// IOCTL_IEEE1284_NEGOTIATE, +// IOCTL_IEEE1284_GET_MODE, and +// IOCTL_PAR_GET_DEFAULT_MODES. +// + +typedef struct _PARCLASS_NEGOTIATION_MASK { + USHORT usReadMask; + USHORT usWriteMask; +} PARCLASS_NEGOTIATION_MASK, *PPARCLASS_NEGOTIATION_MASK; + +#define NONE 0x0000 +#define CENTRONICS 0x0001 /* Write Only */ +#define IEEE_COMPATIBILITY 0x0002 /* Write Only */ +#define NIBBLE 0x0004 /* Read Only */ +#define CHANNEL_NIBBLE 0x0008 /* Read Only */ +#define BYTE_BIDIR 0x0010 /* Read Only */ +#define EPP_HW 0x0020 +#define EPP_SW 0x0040 +#define EPP_ANY 0x0060 +#define BOUNDED_ECP 0x0080 +#define ECP_HW_NOIRQ 0x0100 /* HWECP PIO */ +#define ECP_HW_IRQ 0x0200 /* HWECP with IRQ */ +#define ECP_SW 0x0400 +#define ECP_ANY 0x0780 + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDDPAR_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscm.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscm.h new file mode 100644 index 0000000000000000000000000000000000000000..ccbe1646cd24bc11aa4a9e98685b2c3128920143 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscm.h @@ -0,0 +1,1759 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddscm.h + +Abstract: + + This is the include file that defines common constants, types and control codes + related to persistent memory, also known as storage-class memory (SCM). + + There are three types of persistent memory device objects. + + Physical persistent memory devices are the actual hardware that enable persistent memory + to work. In Windows, their corresponding device objects can be used for health monitoring, + firmware upgrade, secure erase etc., but they can't be used to read or write data. IOCTLs + sent to physical persistent memory devices, or types that represent information about them, + have the abbreviation "SCM_PD". + + Logical persistent memory devices are formed by combining one or more physical devices into + a logical object that can perform reads and writes. A logical persistent memory device corresponds + to a disk, and the usual disk interfaces should be used to query its health, do I/O and so on. + The abbreviation that identifies IOCTLs and structures directed to logical persistent memory devices + is "SCM_LD". + + Finally, the SCM bus driver is responsible for enumerating all physical and logical persistent memory + devices on the system. The IOCTLs and structures related to it have "SCM_BUS" in their names. + + +--*/ + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// +// Interface GUIDs +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// +#ifdef DEFINE_GUID + +// +// Supported device interfaces +// + +// begin_wioctlguids + +// +// This interface represents a physical persistent memory device, such as an NVDIMM. +// {4283609D-4DC2-43BE-BBB4-4F15DFCE2C61} +// +DEFINE_GUID(GUID_DEVINTERFACE_SCM_PHYSICAL_DEVICE, 0x4283609d, 0x4dc2, 0x43be, 0xbb, 0xb4, 0x4f, 0x15, 0xdf, 0xce, 0x2c, 0x61); + +// +// When a physical device driver detects a change in the health status of a physical device, +// it triggers a PNP custom event (through TARGET_DEVICE_CUSTOM_NOTIFICATION) to alert any +// registered components. The custom event's GUID is GUID_SCM_PD_HEALTH_NOTIFICATION +// and its payload is SCM_PD_HEALTH_NOTIFICATION_DATA +// {9DA2D386-72F5-4EE3-8155-ECA0678E3B06} +// +DEFINE_GUID(GUID_SCM_PD_HEALTH_NOTIFICATION, 0x9da2d386, 0x72f5, 0x4ee3, 0x81, 0x55, 0xec, 0xa0, 0x67, 0x8e, 0x3b, 0x6); + +// +// The passthrough protocol GUID for INVDIMM devices. The application and the driver use this value +// for the "ProtocolGuid" field of the SCM_PD_PASSTHROUGH_INPUT and SCM_PD_PASSTHROUGH_OUTPUT structures. +// {4309AC30-0D11-11E4-9191-0800200C9A66} +// +DEFINE_GUID(GUID_SCM_PD_PASSTHROUGH_INVDIMM, 0x4309AC30, 0x0D11, 0x11E4, 0x91, 0x91, 0x08, 0x00, 0x20, 0x0C, 0x9A, 0x66); + +// end_wioctlguids + +#endif // DEFINE_GUID + +// begin_winioctl + +#ifndef _NTDDSCM_H_ +#define _NTDDSCM_H_ + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4214) // bit field types other than int + + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) + +// +// Functions 0 to 0x2FF are reserved for the bus device. +// Functions 0x300 to 0x5FF are reserved for the logical persistent memory device. +// Functions 0x600 to 0x7FF are reserved for the physical persistent memory device. +// Functions 0x800 and above are reserved for non-Microsoft users. +// + +#define IOCTL_SCMBUS_BASE FILE_DEVICE_PERSISTENT_MEMORY + +#define IOCTL_SCMBUS_DEVICE_FUNCTION_BASE 0x0 +#define IOCTL_SCM_LOGICAL_DEVICE_FUNCTION_BASE 0x300 +#define IOCTL_SCM_PHYSICAL_DEVICE_FUNCTION_BASE 0x600 + +#define SCMBUS_FUNCTION(x) (IOCTL_SCMBUS_DEVICE_FUNCTION_BASE + x) +#define SCM_LOGICAL_DEVICE_FUNCTION(x) (IOCTL_SCM_LOGICAL_DEVICE_FUNCTION_BASE + x) +#define SCM_PHYSICAL_DEVICE_FUNCTION(x) (IOCTL_SCM_PHYSICAL_DEVICE_FUNCTION_BASE + x) + +// +// Persistent memory (SCM) bus device IOCTLs. +// + +#define IOCTL_SCM_BUS_GET_LOGICAL_DEVICES CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x00), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_BUS_GET_PHYSICAL_DEVICES CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x01), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_BUS_GET_REGIONS CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x02), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_BUS_QUERY_PROPERTY CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x03), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_BUS_SET_PROPERTY CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x05), METHOD_BUFFERED, FILE_WRITE_ACCESS) + +// +// This IOCTL does not require any input nor produce any output data. +// +#define IOCTL_SCM_BUS_RUNTIME_FW_ACTIVATE CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x04), METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_SCM_BUS_REFRESH_NAMESPACE CTL_CODE(IOCTL_SCMBUS_BASE, SCMBUS_FUNCTION(0x06), METHOD_BUFFERED, FILE_ANY_ACCESS) + + +// +// Logical persistent memory device IOCTLs. +// +#define IOCTL_SCM_LD_GET_INTERLEAVE_SET CTL_CODE(IOCTL_SCMBUS_BASE, SCM_LOGICAL_DEVICE_FUNCTION(0x00), METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTLs exposed by physical persistent memory device objects. +// + +#define IOCTL_SCM_PD_QUERY_PROPERTY CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x00), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_PD_FIRMWARE_DOWNLOAD CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x01), METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_SCM_PD_FIRMWARE_ACTIVATE CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x02), METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_SCM_PD_PASSTHROUGH CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x03), METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_SCM_PD_UPDATE_MANAGEMENT_STATUS CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x04), METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCM_PD_REINITIALIZE_MEDIA CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x05), METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_SCM_PD_SET_PROPERTY CTL_CODE(IOCTL_SCMBUS_BASE, SCM_PHYSICAL_DEVICE_FUNCTION(0x06), METHOD_BUFFERED, FILE_WRITE_ACCESS) + + +// +// The payload for a physical device health notification. +// +typedef struct _SCM_PD_HEALTH_NOTIFICATION_DATA { + + // + // The GUID of the device reporting the health change. + // This is the same GUID returned by IOCTL_SCM_PD_QUERY_PROPERTY with + // ScmPhysicalDeviceProperty_DeviceInfo. + // + GUID DeviceGuid; + +} SCM_PD_HEALTH_NOTIFICATION_DATA, *PSCM_PD_HEALTH_NOTIFICATION_DATA; + + +// +// IOCTL_SCM_BUS_GET_LOGICAL_DEVICES +// +// Send this IOCTL to the ScmBus adapter to get a list of all the logical persistent memory +// devices on the system. +// +// Input Buffer: +// None +// +// Output Buffer: +// SCM_LOGICAL_DEVICES +// + +#define SCM_MAX_SYMLINK_LEN_IN_CHARS 256 + +typedef struct _SCM_LOGICAL_DEVICE_INSTANCE { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure. + // + ULONG Size; + + // + // The logical device GUID. + // + GUID DeviceGuid; + + // + // Symbolic link that can be used to get a handle to the device. + // + WCHAR SymbolicLink[SCM_MAX_SYMLINK_LEN_IN_CHARS]; + +} SCM_LOGICAL_DEVICE_INSTANCE, *PSCM_LOGICAL_DEVICE_INSTANCE; + +typedef struct _SCM_LOGICAL_DEVICES { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure, including all the elements in the + // Devices array. + // + ULONG Size; + + // + // The number of valid elements in the Devices array. + // + ULONG DeviceCount; + + // + // Array of logical device instances. + // + SCM_LOGICAL_DEVICE_INSTANCE Devices[ANYSIZE_ARRAY]; + +} SCM_LOGICAL_DEVICES, *PSCM_LOGICAL_DEVICES; + +// +// IOCTL_SCM_BUS_GET_PHYSICAL_DEVICES +// +// Send this IOCTL to the ScmBus adapter to get a list of all the physical persistent memory +// devices on the system. +// +// Input Buffer: +// None +// +// Output Buffer: +// SCM_PHYSICAL_DEVICES +// +typedef struct _SCM_PHYSICAL_DEVICE_INSTANCE { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure. + // + ULONG Size; + + // + // The NFIT handle of the physical device. + // + ULONG NfitHandle; + + // + // Symbolic link that can be used to get a handle on the device. + // + WCHAR SymbolicLink[SCM_MAX_SYMLINK_LEN_IN_CHARS]; + +} SCM_PHYSICAL_DEVICE_INSTANCE, *PSCM_PHYSICAL_DEVICE_INSTANCE; + +typedef struct _SCM_PHYSICAL_DEVICES { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure, including all the elements in the + // Devices array. + // + ULONG Size; + + // + // The number of valid elements in the Devices array. + // + ULONG DeviceCount; + + // + // Array of physical device instances. + // + SCM_PHYSICAL_DEVICE_INSTANCE Devices[ANYSIZE_ARRAY]; + +} SCM_PHYSICAL_DEVICES, *PSCM_PHYSICAL_DEVICES; + +// +// IOCTL_SCM_BUS_GET_REGIONS +// +// Send to a logical persistent memory device stack to get a list of all regions that make up +// the logical device. +// +// Send to a physical persistent memory device stack to get a list of all the regions that +// reside on that physical device. +// +// Input Buffer: +// None +// +// Output Buffer: +// SCM_REGIONS +// + +typedef enum _SCM_REGION_FLAG { + ScmRegionFlagNone = 0x0, + + // + // Indicates this region is described by a label. + // + ScmRegionFlagLabel = 0x1 + +} SCM_REGION_FLAG, *PSCM_REGION_FLAG; + +#define SCM_REGION_SPA_UNKNOWN MAXULONG64 + +typedef struct _SCM_REGION { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure. + // + ULONG Size; + + // + // Bitmask of SCM_REGION_FLAG values. + // + ULONG Flags; + + // + // The NFIT handle of the physical device for this region. + // + ULONG NfitHandle; + + // + // The GUID of the logical device for this region, if any. + // + GUID LogicalDeviceGuid; + + // + // The address range type (e.g. byte-addressable persistent memory). + // + GUID AddressRangeType; + + // + // Regions that are associated with each other (e.g. part of an interleave + // set) will share an associated ID. + // + ULONG AssociatedId; + + // + // The total size of the region, in bytes. + // + ULONG64 Length; + + // + // The starting device physical address of the region + // within the physical device. + // + ULONG64 StartingDPA; + + // + // The base system physical address. + // + ULONG64 BaseSPA; + + // + // The region's offset from the base system physical address. + // This field may be SCM_REGION_SPA_UNKNOWN if there is not enough + // context to calculate the SPA offset for this particular region. + // + ULONG64 SPAOffset; + + // + // The value of the Region Offset field from the associated Region Mapping + // Structure. + // + ULONG64 RegionOffset; + +} SCM_REGION, *PSCM_REGION; + +typedef struct _SCM_REGIONS { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure, including all the elements in the + // Regions array. + // + ULONG Size; + + // + // The number of valid elements in the Regions array. + // + ULONG RegionCount; + + // + // Array of regions for the logical or physical device. + // + SCM_REGION Regions[ANYSIZE_ARRAY]; + +} SCM_REGIONS, *PSCM_REGIONS; + +// +// IOCTL_SCM_BUS_QUERY_PROPERTY +// +// Input Buffer: +// An SCM_BUS_PROPERTY_QUERY structure that describes the type of query +// being done, the property being queried, and any additional parameters +// the query requires. +// +// Output Buffer: +// Contains a buffer to place the results of the query into. Since all +// property descriptors can be cast into an SCM_BUS_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of queries +// + +typedef enum _SCM_BUS_QUERY_TYPE { + ScmBusQuery_Descriptor = 0, // Retrieves the descriptor + ScmBusQuery_IsSupported, // Used to test whether the descriptor is supported + + ScmBusQuery_Max +} SCM_BUS_QUERY_TYPE, *PSCM_BUS_QUERY_TYPE; + + +// +// IOCTL_SCM_BUS_SET_PROPERTY +// +// Input Buffer: +// An SCM_BUS_PROPERTY_SET structure that describes the type of set +// being done, the property being set, and any additional parameters +// the set requires. +// +// Output Buffer: +// Contains a buffer to place the results of the set into. Since all +// property descriptors can be cast into an SCM_BUS_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of sets +// + +typedef enum _SCM_BUS_SET_TYPE { + ScmBusSet_Descriptor = 0, // Retrieves the descriptor + ScmBusSet_IsSupported, // Used to test whether the descriptor is supported + + ScmBusSet_Max +} SCM_BUS_SET_TYPE, *PSCM_BUS_SET_TYPE; + + +typedef enum _SCM_BUS_PROPERTY_ID { + + // + // Runtime Firmware Activation Information. + // + ScmBusProperty_RuntimeFwActivationInfo = 0, + + // + // Dedicated Memory Information. + // + ScmBusProperty_DedicatedMemoryInfo = 1, + + // + // Activate/Deactivate the Dedicated Memory. + // + ScmBusProperty_DedicatedMemoryState = 2, + + ScmBusProperty_Max +} SCM_BUS_PROPERTY_ID, *PSCM_BUS_PROPERTY_ID; + +// +// Query structure - additional parameters for specific queries can follow +// the header +// + +typedef struct _SCM_BUS_PROPERTY_QUERY { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of this structure, including any additional + // parameters. + // + ULONG Size; + + // + // ID of the property being retrieved. + // + SCM_BUS_PROPERTY_ID PropertyId; + + // + // The type of query being performed. + // + SCM_BUS_QUERY_TYPE QueryType; + + // + // Space for additional parameters if necessary. + // + UCHAR AdditionalParameters[ANYSIZE_ARRAY]; + +} SCM_BUS_PROPERTY_QUERY, *PSCM_BUS_PROPERTY_QUERY; + +// +// Output buffer for ScmBusProperty_RuntimeFwActivationInfo +// + +// +// ScmBus Firmware Activation State +// +typedef enum _SCM_BUS_FIRMWARE_ACTIVATION_STATE { + ScmBusFirmwareActivationState_Idle = 0, // NVDIMM is Idle for firmware update + ScmBusFirmwareActivationState_Armed = 1, // NVDIMM is armed to activate the staging firmware + ScmBusFirmwareActivationState_Busy = 2 // NVDIMM firmware activation is underway + +} SCM_BUS_FIRMWARE_ACTIVATION_STATE, *PSCM_BUS_FIRMWARE_ACTIVATION_STATE; + +typedef struct _SCM_BUS_RUNTIME_FW_ACTIVATION_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Size of the data contained in this structure. If the output buffer is too small + // to contain the requested information, the Size field indicates the length of the + // output buffer the caller should provide in order to retrieve all the data. + // + ULONG Size; + + // + // Indicates if runtime firmware activation is supported or not. + // + BOOLEAN RuntimeFwActivationSupported; + + // + // Indicates the current Firmware activation state of the DIMMs. + // Note: If any one of the NVDIMMs is Armed, the state is Armed. + // + SCM_BUS_FIRMWARE_ACTIVATION_STATE FirmwareActivationState; + + // + // Firmware activation capabilities. + // + struct { + + // + // Live activation supported with platform firmware managed processor and I/O quiesce. + // + ULONG FwManagedIoQuiesceFwActivationSupported : 1; + + // + // Live activation supported with OS managed I/O quiesce (device idle) and platform managed processor quiesce. + // + ULONG OsManagedIoQuiesceFwActivationSupported : 1; + + // + // Warm reset-based activation supported. + // + ULONG WarmResetBasedFwActivationSupported : 1; + + ULONG Reserved : 29; + } FirmwareActivationCapability; + + // + // Estimated firmware activation time in micro seconds. + // + ULONGLONG EstimatedFirmwareActivationTimeInUSecs; + + // + // Estimated processor quiesce time during firmware activation in micro seconds. + // 0 - no processor quiesce required. + // + ULONGLONG EstimatedProcessorAccessQuiesceTimeInUSecs; + + // + // Estimated I/O access to host memory quiesce time during firmware activation in micro seconds. + // 0 - no I/O quiesce required. + // + ULONGLONG EstimatedIOAccessQuiesceTimeInUSecs; + + // + // Platform firmware supported Max I/O access to memory quiesce time during firmware activation in micro seconds. + // 0 - Informaiton not available. + // + ULONGLONG PlatformSupportedMaxIOAccessQuiesceTimeInUSecs; + +} SCM_BUS_RUNTIME_FW_ACTIVATION_INFO, *PSCM_BUS_RUNTIME_FW_ACTIVATION_INFO; + +// +// Output buffer for ScmBusProperty_DedicatedMemoryInfo +// +typedef struct _SCM_BUS_DEDICATED_MEMORY_DEVICE_INFO { + + // + // The dedicated memory device GUID. + // + GUID DeviceGuid; + + // + // The dedicated memory device number. + // + ULONG DeviceNumber; + + struct { + + // + // Indicates if the dedicated memory is created by registry settings. + // + ULONG ForcedByRegistry : 1; + + // + // Indicates if the dedicated memory is initialized. + // + ULONG Initialized : 1; + + ULONG Reserved : 30; + } Flags; + + // + // The dedicated memory device size in bytes. + // + ULONGLONG DeviceSize; + +} SCM_BUS_DEDICATED_MEMORY_DEVICE_INFO, *PSCM_BUS_DEDICATED_MEMORY_DEVICE_INFO; + +typedef struct _SCM_BUS_DEDICATED_MEMORY_DEVICES_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the data structure, including all the elements in the + // Devices array. + // + ULONG Size; + + // + // The number of valid elements in the Devices array. + // + ULONG DeviceCount; + + // + // Array of dedicated memory devices info. + // + SCM_BUS_DEDICATED_MEMORY_DEVICE_INFO Devices[ANYSIZE_ARRAY]; + +} SCM_BUS_DEDICATED_MEMORY_DEVICES_INFO, *PSCM_BUS_DEDICATED_MEMORY_DEVICES_INFO; + + +// +// Set structure - additional parameters for specific sets can follow +// the header +// + +typedef struct _SCM_BUS_PROPERTY_SET { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of this structure, including any additional + // parameters. + // + ULONG Size; + + // + // ID of the property being set. + // + SCM_BUS_PROPERTY_ID PropertyId; + + // + // The type of set being performed. + // + SCM_BUS_SET_TYPE SetType; + + // + // Space for additional parameters if necessary. + // + UCHAR AdditionalParameters[ANYSIZE_ARRAY]; + +} SCM_BUS_PROPERTY_SET, *PSCM_BUS_PROPERTY_SET; + +// +// Input AdditionalParameters for ScmBusProperty_DedicatedMemoryState +// + +typedef struct _SCM_BUS_DEDICATED_MEMORY_STATE { + + // + // Dedicated Memory state (Deactivate - FALSE, Activate - TRUE). + // + BOOLEAN ActivateState; +} SCM_BUS_DEDICATED_MEMORY_STATE, *PSCM_BUS_DEDICATED_MEMORY_STATE; + + +// +// Definitions for interfaces related to logical persistent memory devices (LDs). +// + +// +// IOCTL_SCM_LD_GET_INTERLEAVE_SET +// +// This IOCTL retrieves the interleave set of a logical persistent memory disk. The interleave set +// is comprised of one or more physical persistent memory devices. +// +// Input Buffer: +// None. +// +// Output Buffer: +// SCM_LD_INTERLEAVE_SET_INFO +// + +typedef struct _SCM_INTERLEAVED_PD_INFO { + + // + // An identifier for the physical device that comes from the NFIT table and + // is unique on the local system. + // + ULONG DeviceHandle; + + // + // A GUID that uniquely identifies the physical device on the system. + // + GUID DeviceGuid; + +} SCM_INTERLEAVED_PD_INFO, *PSCM_INTERLEAVED_PD_INFO; + +typedef struct _SCM_LD_INTERLEAVE_SET_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Total size of the structure, in bytes, including the InterleaveSet array. + // If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + // + // The number of elements in the InterleaveSet array. + // + ULONG InterleaveSetSize; + + // + // Information about the physical devices that make up this interleave + // set. + // + SCM_INTERLEAVED_PD_INFO InterleaveSet[ANYSIZE_ARRAY]; + +} SCM_LD_INTERLEAVE_SET_INFO, *PSCM_LD_INTERLEAVE_SET_INFO; + + +// +// Definitions for interfaces related to physical persistent memory devices (PDs). +// + +// +// IOCTL_SCM_PD_QUERY_PROPERTY +// +// Input Buffer: +// An SCM_PD_PROPERTY_QUERY structure that describes the type of query +// being done, the property being queried, and any additional parameters +// the query requires. +// +// Output Buffer: +// Contains a buffer to place the results of the query into. Since all +// property descriptors can be cast into an SCM_PD_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of queries +// + +typedef enum _SCM_PD_QUERY_TYPE { + ScmPhysicalDeviceQuery_Descriptor = 0, // Retrieves the descriptor + ScmPhysicalDeviceQuery_IsSupported, // Used to test whether the descriptor is supported + + ScmPhysicalDeviceQuery_Max +} SCM_PD_QUERY_TYPE, *PSCM_PD_QUERY_TYPE; + + +// +// IOCTL_SCM_PD_SET_PROPERTY +// +// Input Buffer: +// An SCM_PD_PROPERTY_SET structure that describes the type of set +// being done, the property being set, and any additional parameters +// the set requires. +// +// Output Buffer: +// Contains a buffer to place the results of the set into. Since all +// property descriptors can be cast into an SCM_PD_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of sets +// + +typedef enum _SCM_PD_SET_TYPE { + ScmPhysicalDeviceSet_Descriptor = 0, // Retrieves the descriptor + ScmPhysicalDeviceSet_IsSupported, // Used to test whether the descriptor is supported + + ScmPhysicalDeviceSet_Max +} SCM_PD_SET_TYPE, *PSCM_PD_SET_TYPE; + + +typedef enum _SCM_PD_PROPERTY_ID { + + // + // General information about the device. + // + ScmPhysicalDeviceProperty_DeviceInfo = 0, + + // + // Information about the device's health. + // + ScmPhysicalDeviceProperty_ManagementStatus, + + // + // Firmware-related information. + // + ScmPhysicalDeviceProperty_FirmwareInfo, + + // + // Returns a string that identifies where the device is located + // on the local system. + // + ScmPhysicalDeviceProperty_LocationString, + + // + // Returns a series of device-specific information, which give more detail + // on the device's status. + // + ScmPhysicalDeviceProperty_DeviceSpecificInfo, + + // + // Returns a identifying handle of the physical device, which comes from + // the NFIT table. + // + ScmPhysicalDeviceProperty_DeviceHandle, + + // + // Returns a string that identifies the replacement unit housing + // the device on the local system. + // + ScmPhysicalDeviceProperty_FruIdString, + + // + // Returns runtime firmware activation information. + // + ScmPhysicalDeviceProperty_RuntimeFwActivationInfo, + + // + // Runtime firmware activation arm state. + // + ScmPhysicalDeviceProperty_RuntimeFwActivationArmState, + + ScmPhysicalDeviceProperty_Max +} SCM_PD_PROPERTY_ID, *PSCM_PD_PROPERTY_ID; + + +// +// Query structure - additional parameters for specific queries can follow +// the header +// + +typedef struct _SCM_PD_PROPERTY_QUERY { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of this structure, including any additional + // parameters. + // + ULONG Size; + + // + // ID of the property being retrieved. + // + SCM_PD_PROPERTY_ID PropertyId; + + // + // The type of query being performed. + // + SCM_PD_QUERY_TYPE QueryType; + + // + // Space for additional parameters if necessary. + // + UCHAR AdditionalParameters[ANYSIZE_ARRAY]; + +} SCM_PD_PROPERTY_QUERY, *PSCM_PD_PROPERTY_QUERY; + +// +// Set structure - additional parameters for specific sets can follow +// the header +// + +typedef struct _SCM_PD_PROPERTY_SET { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of this structure, including any additional + // parameters. + // + ULONG Size; + + // + // ID of the property being retrieved. + // + SCM_PD_PROPERTY_ID PropertyId; + + // + // The type of set being performed. + // + SCM_PD_SET_TYPE SetType; + + // + // Space for additional parameters if necessary. + // + UCHAR AdditionalParameters[ANYSIZE_ARRAY]; + +} SCM_PD_PROPERTY_SET, *PSCM_PD_PROPERTY_SET; + +// +// Input AdditionalParameters for ScmPhysicalDeviceProperty_RuntimeFwActivationArmState +// + +typedef struct _SCM_PD_RUNTIME_FW_ACTIVATION_ARM_STATE { + + // + // Runtime firmware activation arm state (Disarm - FALSE, Arm - TRUE). + // + BOOLEAN ArmState; +} SCM_PD_RUNTIME_FW_ACTIVATION_ARM_STATE, *PSCM_PD_RUNTIME_FW_ACTIVATION_ARM_STATE; + +// +// Standard property descriptor header. All property pages should use this +// as their first element or should contain these two elements +// + +typedef struct _SCM_PD_DESCRIPTOR_HEADER { + + // + // The sizeof() of the entire descriptor (not just the header). + // + ULONG Version; + + // + // The size of the entire descriptor (not just the header). + // + ULONG Size; +} SCM_PD_DESCRIPTOR_HEADER, *PSCM_PD_DESCRIPTOR_HEADER; + +// +// Output buffer for ScmPhysicalDeviceProperty_DeviceHandle & ScmPhysicalDeviceQuery_Descriptor +// + +// +// The ScmPhysicalDeviceProperty_DeviceHandle property gets identifying information about +// a physical device. +// +typedef struct _SCM_PD_DEVICE_HANDLE { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure. + // + ULONG Size; + + // + // A GUID that uniquely identifies the physical device, based on hardware information. + // + GUID DeviceGuid; + + // + // A handle, exposed in the NFIT table, that uniquely identifies the physical device on a local + // system. + // + ULONG DeviceHandle; + +} SCM_PD_DEVICE_HANDLE, *PSCM_PD_DEVICE_HANDLE; + +// +// Output buffer for ScmPhysicalDeviceProperty_DeviceInfo & ScmPhysicalDeviceQuery_Descriptor +// + +#define MAX_INTERFACE_CODES 8 +#define SCM_PD_FIRMWARE_REVISION_LENGTH_BYTES 32 + +#define SCM_PD_MEMORY_SIZE_UNKNOWN MAXULONG64 + +typedef struct _SCM_PD_DEVICE_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure, including the serial number at the end. + // If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + // + // A GUID that uniquely identifies the physical device, based on hardware information. + // + GUID DeviceGuid; + + // + // The number of times this device went through an unsafe shutdown (i.e. a shutdown + // that might have led to data loss). + // + ULONG UnsafeShutdownCount; + + + // + // The combined size of all the persistent memory regions of the physical device. + // + ULONG64 PersistentMemorySizeInBytes; + + // + // The total size of the volatile memory this device contains, if any. + // May be SCM_PD_MEMORY_SIZE_UNKNOWN if it is not reported by the platform. + // + ULONG64 VolatileMemorySizeInBytes; + + // + // The total capacity of this memory device, including persistent and any + // volatile memory. + // May be SCM_PD_MEMORY_SIZE_UNKNOWN if it is not reported by the platform. + // + ULONG64 TotalMemorySizeInBytes; + + // + // The number of the slot in which the physical device is installed on the system. + // + ULONG SlotNumber; + + // + // A handle, exposed in the NFIT table, that uniquely identifies the physical device on a local + // system. + // + ULONG DeviceHandle; + + // + // The unique ID for this physical device as indicated in the SMBIOS. + // + USHORT PhysicalId; + + // + // An physical device can have regions that implement different format interface + // codes. This is a list of all format interface codes on this physical device. + // + UCHAR NumberOfFormatInterfaceCodes; + USHORT FormatInterfaceCodes[MAX_INTERFACE_CODES]; + + // + // Vendor and product IDs. + // + ULONG VendorId; + ULONG ProductId; + ULONG SubsystemDeviceId; + ULONG SubsystemVendorId; + UCHAR ManufacturingLocation; + UCHAR ManufacturingWeek; // *Not* in BCD format. + UCHAR ManufacturingYear; // *Not* in BCD format. + ULONG SerialNumber4Byte; // 4-byte serial number as defined in the JEDEC SPD spec and reported in the NFIT. + + // + // The physical device's serial number, as a string. + // + ULONG SerialNumberLengthInChars; + _Field_size_(SerialNumberLengthInChars) CHAR SerialNumber[ANYSIZE_ARRAY]; +} SCM_PD_DEVICE_INFO, *PSCM_PD_DEVICE_INFO; + +// +// Output buffer for ScmPhysicalDeviceProperty_DeviceSpecificInfo & ScmPhysicalDeviceQuery_Descriptor +// + +// +// A device specific property is a key-value pair where the key is a string +// and the value is a number. +// +#define SCM_PD_PROPERTY_NAME_LENGTH_IN_CHARS 128 + +typedef struct _SCM_PD_DEVICE_SPECIFIC_PROPERTY { + // NULL-terminated string. + WCHAR Name[SCM_PD_PROPERTY_NAME_LENGTH_IN_CHARS]; + LONGLONG Value; +} SCM_PD_DEVICE_SPECIFIC_PROPERTY, *PSCM_PD_DEVICE_SPECIFIC_PROPERTY; + +// +// The physical device driver fills in this structure with arbitrary numeric information. +// +typedef struct _SCM_PD_DEVICE_SPECIFIC_INFO { + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure, including the DeviceSpecificProperties array. + // If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + // + // The number of elements in the DeviceSpecificProperties array. + // + ULONG NumberOfProperties; + + // + // A series of device-specific properties filled in by the driver. + // + SCM_PD_DEVICE_SPECIFIC_PROPERTY DeviceSpecificProperties[ANYSIZE_ARRAY]; +} SCM_PD_DEVICE_SPECIFIC_INFO, *PSCM_PD_DEVICE_SPECIFIC_INFO; + +typedef struct _SCM_PD_FIRMWARE_SLOT_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Size of the data contained in this structure. + // + ULONG Size; + + UCHAR SlotNumber; + UCHAR ReadOnly : 1; + UCHAR Reserved0 : 7; + UCHAR Reserved1[6]; + + UCHAR Revision[SCM_PD_FIRMWARE_REVISION_LENGTH_BYTES]; + +} SCM_PD_FIRMWARE_SLOT_INFO, *PSCM_PD_FIRMWARE_SLOT_INFO; + + +// +// Output buffer for ScmPhysicalDeviceQuery_Descriptor & ScmPhysicalDeviceProperty_FirmwareInfo +// +typedef struct _SCM_PD_FIRMWARE_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Size of the data contained in this structure, including the Slots + // array. If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + + // + // The firmware slot that is currently active. + // + UCHAR ActiveSlot; + + // + // The slot that will become active once the device is reset. A value of 0xFF means + // there is no slot waiting to be activated. + // + UCHAR NextActiveSlot; + + UCHAR SlotCount; + + _Field_size_(SlotCount) SCM_PD_FIRMWARE_SLOT_INFO Slots[ANYSIZE_ARRAY]; + +} SCM_PD_FIRMWARE_INFO, *PSCM_PD_FIRMWARE_INFO; + + +// +// Constants for ScmPhysicalDeviceProperty_ManagementStatus, which can be queried via +// ScmPhysicalDeviceQuery_Descriptor. +// + +// +// Health states. +// +typedef enum _SCM_PD_HEALTH_STATUS { + ScmPhysicalDeviceHealth_Unknown = 0, + ScmPhysicalDeviceHealth_Unhealthy, + ScmPhysicalDeviceHealth_Warning, + ScmPhysicalDeviceHealth_Healthy, + + ScmPhysicalDeviceHealth_Max +} SCM_PD_HEALTH_STATUS, *PSCM_PD_HEALTH_STATUS; + +// +// Operational states. +// +typedef enum _SCM_PD_OPERATIONAL_STATUS { + ScmPhysicalDeviceOpStatus_Unknown = 0, + ScmPhysicalDeviceOpStatus_Ok, + ScmPhysicalDeviceOpStatus_PredictingFailure, + ScmPhysicalDeviceOpStatus_InService, + ScmPhysicalDeviceOpStatus_HardwareError, + ScmPhysicalDeviceOpStatus_NotUsable, + ScmPhysicalDeviceOpStatus_TransientError, + ScmPhysicalDeviceOpStatus_Missing, + + ScmPhysicalDeviceOpStatus_Max +} SCM_PD_OPERATIONAL_STATUS, *PSCM_PD_OPERATIONAL_STATUS; + +// +// Operational reasons. +// +typedef enum _SCM_PD_OPERATIONAL_STATUS_REASON { + ScmPhysicalDeviceOpReason_Unknown = 0, + ScmPhysicalDeviceOpReason_Media, + ScmPhysicalDeviceOpReason_ThresholdExceeded, + ScmPhysicalDeviceOpReason_LostData, + ScmPhysicalDeviceOpReason_EnergySource, + ScmPhysicalDeviceOpReason_Configuration, + ScmPhysicalDeviceOpReason_DeviceController, + ScmPhysicalDeviceOpReason_MediaController, + ScmPhysicalDeviceOpReason_Component, + ScmPhysicalDeviceOpReason_BackgroundOperation, + ScmPhysicalDeviceOpReason_InvalidFirmware, + ScmPhysicalDeviceOpReason_HealthCheck, + ScmPhysicalDeviceOpReason_LostDataPersistence, + ScmPhysicalDeviceOpReason_DisabledByPlatform, + ScmPhysicalDeviceOpReason_PermanentError, + ScmPhysicalDeviceOpReason_LostWritePersistence, + ScmPhysicalDeviceOpReason_FatalError, + ScmPhysicalDeviceOpReason_DataPersistenceLossImminent, + ScmPhysicalDeviceOpReason_WritePersistenceLossImminent, + ScmPhysicalDeviceOpReason_MediaRemainingSpareBlock, + ScmPhysicalDeviceOpReason_PerformanceDegradation, + ScmPhysicalDeviceOpReason_ExcessiveTemperature, + ScmPhysicalDeviceOpReason_InternalFailure, + + ScmPhysicalDeviceOpReason_Max +} SCM_PD_OPERATIONAL_STATUS_REASON, *PSCM_PD_OPERATIONAL_STATUS_REASON; + +// +// Output buffer for ScmPhysicalDeviceProperty_ManagementStatus & ScmPhysicalDeviceQuery_Descriptor +// + +#define SCM_PD_MAX_OPERATIONAL_STATUS 16 + +typedef struct _SCM_PD_MANAGEMENT_STATUS { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure, including operational status reasons + // that didn't fit in the caller's array. If the output buffer is too small to + // contain the requested information, the Size field indicates the length of the + // output buffer the caller should provide in order to retrieve all the data. + // + ULONG Size; + + // + // Health status. + // + SCM_PD_HEALTH_STATUS Health; + + // + // The number of operational statuses returned. + // + ULONG NumberOfOperationalStatus; + + // + // The number of additional reasons returned. + // + ULONG NumberOfAdditionalReasons; + + // + // Operational statuses. The primary operational status is the first element + // in the array. There are NumberOfOperationalStatus valid elements in the array. + // + SCM_PD_OPERATIONAL_STATUS OperationalStatus[SCM_PD_MAX_OPERATIONAL_STATUS]; + + // + // Additional reasons. There are NumberOfAdditionalReasons valid elements in the array. + // + _Field_size_(NumberOfAdditionalReasons) SCM_PD_OPERATIONAL_STATUS_REASON AdditionalReasons[ANYSIZE_ARRAY]; + +} SCM_PD_MANAGEMENT_STATUS, *PSCM_PD_MANAGEMENT_STATUS; + +// +// Output buffer for ScmPhysicalDeviceQuery_Descriptor & ScmPhysicalDeviceProperty_LocationString +// +typedef struct _SCM_PD_LOCATION_STRING { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure, including the buffer for the Unicode + // string. If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + // + // The Unicode string that represents the physical location of this physical device. + // + WCHAR Location[ANYSIZE_ARRAY]; + +} SCM_PD_LOCATION_STRING, *PSCM_PD_LOCATION_STRING; + +// +// Output buffer for ScmPhysicalDeviceQuery_Descriptor & ScmPhysicalDeviceProperty_FruIdString +// +typedef struct _SCM_PD_FRU_ID_STRING { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The total size of the structure, including the buffer for the fru id string. + // If the output buffer is too small to contain the requested information, + // the Size field indicates the length of the output buffer the caller should provide + // in order to retrieve all the data. + // + ULONG Size; + + // + // The string that represents the fru id of this physical device. + // + ULONG IdentifierSize; + UCHAR Identifier[ANYSIZE_ARRAY]; + +} SCM_PD_FRU_ID_STRING, *PSCM_PD_FRU_ID_STRING; + +// +// Firmware update IOCTLs. +// + +// +// Signals that the firmware image regions contained in the SCM_PD_FIRMWARE_DOWNLOAD +// structure are the last ones of the image. The physical device driver finishes the firmware update +// operation when this flag is set. +// +#define SCM_PD_FIRMWARE_LAST_DOWNLOAD 0x1 + +// +// Input buffer for IOCTL_SCM_PD_FIRMWARE_DOWNLOAD. +// +typedef struct _SCM_PD_FIRMWARE_DOWNLOAD { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The structure size, including the image. + // + ULONG Size; + + // + // Additional information about the region being download, such as whether it + // is the last region in the image. + // + ULONG Flags; + + // + // The firmware slot being upgraded. + // + UCHAR Slot; + + UCHAR Reserved[3]; + + // + // The offset of this region of the firmware image. + // + ULONG64 Offset; + + // + // The size of the FirmwareImage array. + // + ULONG FirmwareImageSizeInBytes; + + // + // The firmware region being downloaded to the device. + // + UCHAR FirmwareImage[ANYSIZE_ARRAY]; + +} SCM_PD_FIRMWARE_DOWNLOAD, *PSCM_PD_FIRMWARE_DOWNLOAD; + +// +// Input buffer for IOCTL_SCM_PD_FIRMWARE_ACTIVATE. +// +typedef struct _SCM_PD_FIRMWARE_ACTIVATE { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Total size of the structure + // + ULONG Size; + + // + // Reserved. Callers should set to 0. + // + ULONG Flags; + + // + // The slot that contains the firmware image being activated. + // + UCHAR Slot; + +} SCM_PD_FIRMWARE_ACTIVATE, *PSCM_PD_FIRMWARE_ACTIVATE; + +// +// Output buffer for ScmPhysicalDeviceProperty_RuntimeFwActivationInfo +// + +// +// ScmBus Physical Device Last Firmware Activation Status +// +typedef enum _SCM_PD_LAST_FW_ACTIVATION_STATUS { + ScmPdLastFwActivationStatus_None = 0, // No Firmware Activation performed. Reset to None on boot + ScmPdLastFwActivationStatus_Success = 1, // Success + ScmPdLastFwActivationStatus_FwNotFound = 2, // No new staged firmware to activate + ScmPdLastFwActivationStatus_ColdRebootRequired = 3, // NVDIMM Reset required to activate staged firmware + ScmPdLastFwActivaitonStatus_ActivationInProgress = 4, // Media disabled during firmware activation + ScmPdLastFwActivaitonStatus_Retry = 5, // Activation aborted due to throttling. Retry recommended + ScmPdLastFwActivaitonStatus_FwUnsupported = 6, // Staged firmware version does not meet activation requirements + ScmPdLastFwActivaitonStatus_UnknownError = 7 // Unclassified firmware activation error + +} SCM_PD_LAST_FW_ACTIVATION_STATUS, *PSCM_PD_LAST_FW_ACTIVATION_STATUS; + +// +// ScmBus Physical Device Firmware Activation State +// +typedef enum _SCM_PD_FIRMWARE_ACTIVATION_STATE { + ScmPdFirmwareActivationState_Idle = 0, // NVDIMM is Idle for firmware update + ScmPdFirmwareActivationState_Armed = 1, // NVDIMM is armed to activate the staging firmware + ScmPdFirmwareActivationState_Busy = 2 // NVDIMM firmware activation is underway + +} SCM_PD_FIRMWARE_ACTIVATION_STATE, *PSCM_PD_FIRMWARE_ACTIVATION_STATE; + +typedef struct _SCM_PD_RUNTIME_FW_ACTIVATION_INFO { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // Size of the data contained in this structure. If the output buffer is too small + // to contain the requested information, the Size field indicates the length of the + // output buffer the caller should provide in order to retrieve all the data. + // + ULONG Size; + + // + // This provides the previous Firmware Activation status. + // + SCM_PD_LAST_FW_ACTIVATION_STATUS LastFirmwareActivationStatus; + + // + // Indicates the current Firmware activation state of the DIMM. + // + SCM_PD_FIRMWARE_ACTIVATION_STATE FirmwareActivationState; + +} SCM_PD_RUNTIME_FW_ACTIVATION_INFO, *PSCM_PD_RUNTIME_FW_ACTIVATION_INFO; + +// +// IOCTL_SCM_PD_PASSTHROUGH +// +// This IOCTL sends a vendor-specific command to a physical device and returns its +// output. +// +// Input buffer: +// SCM_PD_PASSTHROUGH_INPUT +// The input structure contains another, physical device-type specific structure. +// +// Output buffer: +// SCM_PD_PASSTHROUGH_OUTPUT +// The output structure contains another, physical device-type specific structure. +// + +typedef struct _SCM_PD_PASSTHROUGH_INPUT { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of the structure, including the Data field, in bytes. + // + ULONG Size; + + // + // This GUID defines which command protocol is being used. The driver will + // check this field to make sure the application is sending commands for + // device types that the driver understands. + // + GUID ProtocolGuid; + + // + // The size, in bytes, of the data field. + // + ULONG DataSize; + + // + // The physical device-type specific structure which contains the passthrough command. + // + UCHAR Data[ANYSIZE_ARRAY]; +} SCM_PD_PASSTHROUGH_INPUT, *PSCM_PD_PASSTHROUGH_INPUT; + +typedef struct _SCM_PD_PASSTHROUGH_OUTPUT { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of the structure, including the Data field, in bytes. + // The caller is responsible for knowing how large the output buffer + // will be. The common approach of sending the IOCTL twice - once to learn + // the total required size, and again to retrieve the data - isn't recommended + // here because of the performance impact of executing a passthrough command. + // + ULONG Size; + + // + // This GUID defines which command protocol is being used. The application should + // check this field to make sure the driver is using a protocol that it understands. + // + GUID ProtocolGuid; + + // + // The size, in bytes, of the data field. + // + ULONG DataSize; + + // + // The physical device-type specific structure which contains the output of the passthrough command. + // + UCHAR Data[ANYSIZE_ARRAY]; +} SCM_PD_PASSTHROUGH_OUTPUT, *PSCM_PD_PASSTHROUGH_OUTPUT; + +// +// Passthrough structures and definitions for INVDIMM devices. +// + +// +// This structure defines the input of an INVDIMM command. The application sending a passthrough +// command uses this structure as the "Data" field of the SCM_PD_PASSTHROUGH_INPUT structure. +// +typedef struct _SCM_PD_PASSTHROUGH_INVDIMM_INPUT { + + // + // The command's opcode. + // + ULONG Opcode; + + // + // The length, in bytes, of the OpcodeParameters field. + // This can be zero, but the size of this structure must always be equal to + // or greater than sizeof(SCM_PD_PASSTHROUGH_INVDIMM_INPUT). + // + ULONG OpcodeParametersLength; + + // + // The opcode input payload, if any. + // + UCHAR OpcodeParameters[ANYSIZE_ARRAY]; +} SCM_PD_PASSTHROUGH_INVDIMM_INPUT, *PSCM_PD_PASSTHROUGH_INVDIMM_INPUT; + +// +// This structure defines the output of an INVDIMM command. The driver will respond to +// a passthrough request by bundling this structure in the "Data" field of the +// SCM_PD_PASSTHROUGH_OUTPUT structure. +// +typedef struct _SCM_PD_PASSTHROUGH_INVDIMM_OUTPUT { + + // + // The general status of the command (see the INVDIMM _DSM specification for details). + // + USHORT GeneralStatus; + + // + // The extended status of the command (see the INVDIMM _DSM specification for details). + // + USHORT ExtendedStatus; + + // + // The length, in bytes, of the OutputData field. Even when this is zero, the total + // size of this structure will be equal to or greater than sizeof(SCM_PD_PASSTHROUGH_INVDIMM_OUTPUT). + // + ULONG OutputDataLength; + + // + // The data returned by the device in response to the command. + // + UCHAR OutputData[ANYSIZE_ARRAY]; +} SCM_PD_PASSTHROUGH_INVDIMM_OUTPUT, *PSCM_PD_PASSTHROUGH_INVDIMM_OUTPUT; + +// +// IOCTL_SCM_PD_REINITIALIZE_MEDIA +// +// This IOCTL reinitializes the media of a physical persistent memory device, which erases +// all the data on it. +// +// Input buffer: +// SCM_PD_REINITIALIZE_MEDIA_INPUT +// +// Output buffer: +// SCM_PD_REINITIALIZE_MEDIA_OUTPUT +// +typedef struct _SCM_PD_REINITIALIZE_MEDIA_INPUT { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of the structure, in bytes. + // + ULONG Size; + + // + // If Overwrite is set to 1, the physical persistent memory device will + // overwrite the entire media, which might take several minutes. + // If it is set to 0, the physical persistent device may do a crypto-erase or some + // other quicker form of clearing the data on the media. + // + struct { + ULONG Overwrite : 1; + } Options; +} SCM_PD_REINITIALIZE_MEDIA_INPUT, *PSCM_PD_REINITIALIZE_MEDIA_INPUT; + +typedef enum _SCM_PD_MEDIA_REINITIALIZATION_STATUS { + + // + // The media reinitialization was successful and the device is ready for use. + // + ScmPhysicalDeviceReinit_Success = 0, + + // + // The media reinitialization was successful, but the device requires a reboot before being used. + // + ScmPhysicalDeviceReinit_RebootNeeded, + + // + // The media reinitialization was successful, but the device requires a cold boot before being used. + // + ScmPhysicalDeviceReinit_ColdBootNeeded, + + ScmPhysicalDeviceReinit_Max +} SCM_PD_MEDIA_REINITIALIZATION_STATUS, *PSCM_PD_MEDIA_REINITIALIZATION_STATUS; + +typedef struct _SCM_PD_REINITIALIZE_MEDIA_OUTPUT { + + // + // Sizeof() of this structure serves as the version. + // + ULONG Version; + + // + // The size of the structure, in bytes. + // + ULONG Size; + + // + // The detailed status of the reinitialization operation, in case it + // was successful. If it failed, the IOCTL itself will fail and callers + // should not look at the returned status code instead of this field. + // + SCM_PD_MEDIA_REINITIALIZATION_STATUS Status; +} SCM_PD_REINITIALIZE_MEDIA_OUTPUT, *PSCM_PD_REINITIALIZE_MEDIA_OUTPUT; + + +#endif // NTDDI_WIN10_RS5 + +#pragma warning(pop) + + +#endif // _NTDDSCM_H_ + +// end_winioctl + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) | WINAPI_PARTITION_SYSTEM) */ + +#pragma endregion + +#ifdef __cplusplus +} +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscsi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscsi.h new file mode 100644 index 0000000000000000000000000000000000000000..3299ed1a0da1c525633cddc5e81cc981cfdea7c5 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddscsi.h @@ -0,0 +1,1656 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddscsi.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the SCSI port adapters. + +--*/ + + +// +// Interface GUIDs +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// +#ifdef DEFINE_GUID +// +// Make sure FAR is defined... +// +#ifndef FAR +#ifdef _WIN32 +#define FAR +#else +#define FAR _far +#endif +#endif + +DEFINE_GUID(ScsiRawInterfaceGuid, 0x53f56309L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(WmiScsiAddressGuid, 0x53f5630fL, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +#endif + +#ifndef _NTDDSCSIH_ +#define _NTDDSCSIH_ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define IOCTL_SCSI_BASE FILE_DEVICE_CONTROLLER +#define FILE_DEVICE_SCSI 0x0000001b + +#define DD_SCSI_DEVICE_NAME "\\Device\\ScsiPort" + + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_SCSI_PASS_THROUGH CTL_CODE(IOCTL_SCSI_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_SCSI_MINIPORT CTL_CODE(IOCTL_SCSI_BASE, 0x0402, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_SCSI_GET_INQUIRY_DATA CTL_CODE(IOCTL_SCSI_BASE, 0x0403, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSI_GET_CAPABILITIES CTL_CODE(IOCTL_SCSI_BASE, 0x0404, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSI_PASS_THROUGH_DIRECT CTL_CODE(IOCTL_SCSI_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_SCSI_GET_ADDRESS CTL_CODE(IOCTL_SCSI_BASE, 0x0406, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSI_RESCAN_BUS CTL_CODE(IOCTL_SCSI_BASE, 0x0407, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSI_GET_DUMP_POINTERS CTL_CODE(IOCTL_SCSI_BASE, 0x0408, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSI_FREE_DUMP_POINTERS CTL_CODE(IOCTL_SCSI_BASE, 0x0409, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_IDE_PASS_THROUGH CTL_CODE(IOCTL_SCSI_BASE, 0x040a, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_ATA_PASS_THROUGH CTL_CODE(IOCTL_SCSI_BASE, 0x040b, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_ATA_PASS_THROUGH_DIRECT CTL_CODE(IOCTL_SCSI_BASE, 0x040c, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_ATA_MINIPORT CTL_CODE(IOCTL_SCSI_BASE, 0x040d, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_MINIPORT_PROCESS_SERVICE_IRP CTL_CODE(IOCTL_SCSI_BASE, 0x040e, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_MPIO_PASS_THROUGH_PATH CTL_CODE(IOCTL_SCSI_BASE, 0x040f, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT CTL_CODE(IOCTL_SCSI_BASE, 0x0410, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_SCSI_PASS_THROUGH_EX CTL_CODE(IOCTL_SCSI_BASE, 0x0411, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_SCSI_PASS_THROUGH_DIRECT_EX CTL_CODE(IOCTL_SCSI_BASE, 0x0412, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_MPIO_PASS_THROUGH_PATH_EX CTL_CODE(IOCTL_SCSI_BASE, 0x0413, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT_EX CTL_CODE(IOCTL_SCSI_BASE, 0x0414, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// Note: Function code values of less than 0x800 are reserved for Microsoft. Values of 0x800 and higher can be used by vendors. +// So do not use function code of 0x800 and higher to define new IOCTLs in this file. +// + +// +// Non Volatile Cache support +// + +#define IOCTL_SCSI_MINIPORT_NVCACHE ((FILE_DEVICE_SCSI << 16) + 0x0600) + +// +// Hybrid Device support +// +#define IOCTL_SCSI_MINIPORT_HYBRID ((FILE_DEVICE_SCSI << 16) + 0x0620) + +// +// Firmware upgrade support +// +#define IOCTL_SCSI_MINIPORT_FIRMWARE ((FILE_DEVICE_SCSI << 16) + 0x0780) + +// +// Diagnostic support +// +#define IOCTL_SCSI_MINIPORT_DIAGNOSTIC ((FILE_DEVICE_SCSI << 16) + 0x0900) + +// +// Define the SCSI pass through structure. +// + +typedef struct _SCSI_PASS_THROUGH { + USHORT Length; + UCHAR ScsiStatus; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR CdbLength; + UCHAR SenseInfoLength; + UCHAR DataIn; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG_PTR DataBufferOffset; + ULONG SenseInfoOffset; + UCHAR Cdb[16]; +}SCSI_PASS_THROUGH, *PSCSI_PASS_THROUGH; + +// +// Define the SCSI pass through direct structure. +// + +typedef struct _SCSI_PASS_THROUGH_DIRECT { + USHORT Length; + UCHAR ScsiStatus; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR CdbLength; + UCHAR SenseInfoLength; + UCHAR DataIn; + ULONG DataTransferLength; + ULONG TimeOutValue; + PVOID DataBuffer; + ULONG SenseInfoOffset; + UCHAR Cdb[16]; +}SCSI_PASS_THROUGH_DIRECT, *PSCSI_PASS_THROUGH_DIRECT; + + +// +// Define the SCSI pass through direct structure for Win64 (thunking). +// +#if defined(_WIN64) +typedef struct _SCSI_PASS_THROUGH32 { + USHORT Length; + UCHAR ScsiStatus; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR CdbLength; + UCHAR SenseInfoLength; + UCHAR DataIn; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG32 DataBufferOffset; + ULONG SenseInfoOffset; + UCHAR Cdb[16]; +}SCSI_PASS_THROUGH32, *PSCSI_PASS_THROUGH32; + +// +// Define the SCSI pass through direct structure. +// + +typedef struct _SCSI_PASS_THROUGH_DIRECT32 { + USHORT Length; + UCHAR ScsiStatus; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR CdbLength; + UCHAR SenseInfoLength; + UCHAR DataIn; + ULONG DataTransferLength; + ULONG TimeOutValue; + VOID * POINTER_32 DataBuffer; + ULONG SenseInfoOffset; + UCHAR Cdb[16]; +}SCSI_PASS_THROUGH_DIRECT32, *PSCSI_PASS_THROUGH_DIRECT32; + +#endif + + +// +// Data structure for IOCTL_SCSI_PASS_THROUGH_EX +// + +typedef struct _SCSI_PASS_THROUGH_EX { + ULONG Version; + ULONG Length; // size of the structure + ULONG CdbLength; // non-zero value should be set by caller + ULONG StorAddressLength; // non-zero value should be set by caller + UCHAR ScsiStatus; + UCHAR SenseInfoLength; // optional, can be zero + UCHAR DataDirection; // data transfer direction + UCHAR Reserved; // padding + ULONG TimeOutValue; + ULONG StorAddressOffset; // a value bigger than (structure size + CdbLength) should be set by caller + ULONG SenseInfoOffset; + ULONG DataOutTransferLength; // optional, can be zero + ULONG DataInTransferLength; // optional, can be zero + ULONG_PTR DataOutBufferOffset; + ULONG_PTR DataInBufferOffset; + _Field_size_bytes_full_(CdbLength) UCHAR Cdb[ANYSIZE_ARRAY]; +} SCSI_PASS_THROUGH_EX, *PSCSI_PASS_THROUGH_EX; + + +// +// Data structure for IOCTL_SCSI_PASS_THROUGH_DIRECT_EX +// + +typedef struct _SCSI_PASS_THROUGH_DIRECT_EX { + ULONG Version; + ULONG Length; // size of the structure + ULONG CdbLength; // non-zero value should be set by caller + ULONG StorAddressLength; // non-zero value should be set by caller + UCHAR ScsiStatus; + UCHAR SenseInfoLength; // optional, can be zero + UCHAR DataDirection; // data transfer direction + UCHAR Reserved; // padding + ULONG TimeOutValue; + ULONG StorAddressOffset; // a value bigger than (structure size + CdbLength) should be set by caller + ULONG SenseInfoOffset; + ULONG DataOutTransferLength; // optional, can be zero + ULONG DataInTransferLength; // optional, can be zero + _Field_size_bytes_full_(DataOutTransferLength) VOID * DataOutBuffer; + _Field_size_bytes_full_opt_(DataInTransferLength) VOID * DataInBuffer; + _Field_size_bytes_full_(CdbLength) UCHAR Cdb[ANYSIZE_ARRAY]; +} SCSI_PASS_THROUGH_DIRECT_EX, *PSCSI_PASS_THROUGH_DIRECT_EX; + + +// +// Structure needed for WOW64 support +// + +#if defined(_WIN64) + +// +// Data structure for IOCTL_SCSI_PASS_THROUGH_EX +// + +typedef struct _SCSI_PASS_THROUGH32_EX { + ULONG Version; + ULONG Length; // size of the structure + ULONG CdbLength; // non-zero value should be set by caller + ULONG StorAddressLength; // non-zero value should be set by caller + UCHAR ScsiStatus; + UCHAR SenseInfoLength; // optional, can be zero + UCHAR DataDirection; // data transfer direction + UCHAR Reserved; // padding + ULONG TimeOutValue; + ULONG StorAddressOffset; // a value bigger than (structure size + CdbLength) should be set by caller + ULONG SenseInfoOffset; + ULONG DataOutTransferLength; // optional, can be zero + ULONG DataInTransferLength; // optional, can be zero + ULONG32 DataOutBufferOffset; + ULONG32 DataInBufferOffset; + _Field_size_bytes_full_(CdbLength) UCHAR Cdb[ANYSIZE_ARRAY]; +} SCSI_PASS_THROUGH32_EX, *PSCSI_PASS_THROUGH32_EX; + + +// +// Data structure for IOCTL_SCSI_PASS_THROUGH_DIRECT_EX +// + +typedef struct _SCSI_PASS_THROUGH_DIRECT32_EX { + ULONG Version; + ULONG Length; // size of the structure + ULONG CdbLength; // non-zero value should be set by caller + ULONG StorAddressLength; // non-zero value should be set by caller + UCHAR ScsiStatus; + UCHAR SenseInfoLength; // optional, can be zero + UCHAR DataDirection; // data transfer direction + UCHAR Reserved; // padding + ULONG TimeOutValue; + ULONG StorAddressOffset; // a value bigger than (structure size + CdbLength) should be set by caller + ULONG SenseInfoOffset; + ULONG DataOutTransferLength; // optional, can be zero + ULONG DataInTransferLength; // optional, can be zero + _Field_size_bytes_full_(DataOutTransferLength) VOID * POINTER_32 DataOutBuffer; + _Field_size_bytes_full_opt_(DataInTransferLength) VOID * POINTER_32 DataInBuffer; + _Field_size_bytes_full_(CdbLength) UCHAR Cdb[ANYSIZE_ARRAY]; +} SCSI_PASS_THROUGH_DIRECT32_EX, *PSCSI_PASS_THROUGH_DIRECT32_EX; + +#endif + + +// +// ATA pass through structure +// + +typedef struct _ATA_PASS_THROUGH_EX { + USHORT Length; + USHORT AtaFlags; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR ReservedAsUchar; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG ReservedAsUlong; + ULONG_PTR DataBufferOffset; + UCHAR PreviousTaskFile[8]; + UCHAR CurrentTaskFile[8]; +} ATA_PASS_THROUGH_EX, *PATA_PASS_THROUGH_EX; + +// +// ATA pass through direct structure. +// + +typedef struct _ATA_PASS_THROUGH_DIRECT { + USHORT Length; + USHORT AtaFlags; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR ReservedAsUchar; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG ReservedAsUlong; + PVOID DataBuffer; + UCHAR PreviousTaskFile[8]; + UCHAR CurrentTaskFile[8]; +} ATA_PASS_THROUGH_DIRECT, *PATA_PASS_THROUGH_DIRECT; + +// +// Define the ATA pass through direct structure for Win64 (thunking). +// +#if defined(_WIN64) + +typedef struct _ATA_PASS_THROUGH_EX32 { + USHORT Length; + USHORT AtaFlags; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR ReservedAsUchar; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG ReservedAsUlong; + ULONG32 DataBufferOffset; + UCHAR PreviousTaskFile[8]; + UCHAR CurrentTaskFile[8]; +} ATA_PASS_THROUGH_EX32, *PATA_PASS_THROUGH_EX32; + +// +// ATA pass through direct structure. +// + +typedef struct _ATA_PASS_THROUGH_DIRECT32 { + USHORT Length; + USHORT AtaFlags; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR ReservedAsUchar; + ULONG DataTransferLength; + ULONG TimeOutValue; + ULONG ReservedAsUlong; + VOID * POINTER_32 DataBuffer; + UCHAR PreviousTaskFile[8]; + UCHAR CurrentTaskFile[8]; +} ATA_PASS_THROUGH_DIRECT32, *PATA_PASS_THROUGH_DIRECT32; +#endif + +// +// ATA Pass Through Flags +// +#define ATA_FLAGS_DRDY_REQUIRED (1 << 0) +#define ATA_FLAGS_DATA_IN (1 << 1) +#define ATA_FLAGS_DATA_OUT (1 << 2) +#define ATA_FLAGS_48BIT_COMMAND (1 << 3) +#define ATA_FLAGS_USE_DMA (1 << 4) +#define ATA_FLAGS_NO_MULTIPLE (1 << 5) + +// +// Define header for IOCTL_ATA_MINIPORT +// + +typedef struct _IDE_IO_CONTROL { + ULONG HeaderLength; + UCHAR Signature[8]; + ULONG Timeout; + ULONG ControlCode; + ULONG ReturnStatus; + ULONG DataLength; +} IDE_IO_CONTROL, *PIDE_IO_CONTROL; + +// +// Define the structure for IOCTL_MPIO_PASS_THROUGH_PATH. +// + +typedef struct _MPIO_PASS_THROUGH_PATH { + SCSI_PASS_THROUGH PassThrough; + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH, *PMPIO_PASS_THROUGH_PATH; + +// +// Define the structure for IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT. +// + +typedef struct _MPIO_PASS_THROUGH_PATH_DIRECT { + SCSI_PASS_THROUGH_DIRECT PassThrough; + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH_DIRECT, *PMPIO_PASS_THROUGH_PATH_DIRECT; + +// +// Define the structure for IOCTL_MPIO_PASS_THROUGH_PATH_EX. +// + +typedef struct _MPIO_PASS_THROUGH_PATH_EX { + ULONG PassThroughOffset; // Offset to a SCSI_PASS_THROUGH_EX structure. + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH_EX, *PMPIO_PASS_THROUGH_PATH_EX; + +// +// Define the structure for IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT_EX. +// + +typedef struct _MPIO_PASS_THROUGH_PATH_DIRECT_EX { + ULONG PassThroughOffset; // Offset to a PSCSI_PASS_THROUGH_DIRECT_EX structure. + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH_DIRECT_EX, *PMPIO_PASS_THROUGH_PATH_DIRECT_EX; + +// +// Define the IOCTL_MPIO_PASS_THROUGH_PATH structure for Win64 (thunking). +// + +#if defined(_WIN64) +typedef struct _MPIO_PASS_THROUGH_PATH32 { + SCSI_PASS_THROUGH32 PassThrough; + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH32, *PMPIO_PASS_THROUGH_PATH32; + +// +// Define the IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT structure for Win64 (thunking). +// + +typedef struct _MPIO_PASS_THROUGH_PATH_DIRECT32 { + SCSI_PASS_THROUGH_DIRECT32 PassThrough; + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH_DIRECT32, *PMPIO_PASS_THROUGH_PATH_DIRECT32; + +// +// Define the IOCTL_MPIO_PASS_THROUGH_PATH_EX structure for Win64 (thunking). +// + +typedef struct _MPIO_PASS_THROUGH_PATH32_EX { + ULONG PassThroughOffset; // Offset to a PSCSI_PASS_THROUGH32_EX structure. + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH32_EX, *PMPIO_PASS_THROUGH_PATH32_EX; + +// +// Define the IOCTL_MPIO_PASS_THROUGH_PATH_DIRECT_EX structure for Win64 (thunking). +// + +typedef struct _MPIO_PASS_THROUGH_PATH_DIRECT32_EX { + ULONG PassThroughOffset; // Offset to a PSCSI_PASS_THROUGH_DIRECT32_EX structure. + ULONG Version; + USHORT Length; + UCHAR Flags; + UCHAR PortNumber; + ULONGLONG MpioPathId; +} MPIO_PASS_THROUGH_PATH_DIRECT32_EX, *PMPIO_PASS_THROUGH_PATH_DIRECT32_EX; + +#endif + +// +// Define SCSI information. +// Used with the IOCTL_SCSI_GET_INQUIRY_DATA IOCTL. +// + +typedef struct _SCSI_BUS_DATA { + UCHAR NumberOfLogicalUnits; + UCHAR InitiatorBusId; + ULONG InquiryDataOffset; +}SCSI_BUS_DATA, *PSCSI_BUS_DATA; + +// +// Define SCSI adapter bus information structure.. +// Used with the IOCTL_SCSI_GET_INQUIRY_DATA IOCTL. +// + +typedef struct _SCSI_ADAPTER_BUS_INFO { + UCHAR NumberOfBuses; + SCSI_BUS_DATA BusData[1]; +} SCSI_ADAPTER_BUS_INFO, *PSCSI_ADAPTER_BUS_INFO; + +// +// Define SCSI adapter bus information. +// Used with the IOCTL_SCSI_GET_INQUIRY_DATA IOCTL. +// + +typedef struct _SCSI_INQUIRY_DATA { + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + BOOLEAN DeviceClaimed; + ULONG InquiryDataLength; + ULONG NextInquiryDataOffset; + UCHAR InquiryData[1]; +}SCSI_INQUIRY_DATA, *PSCSI_INQUIRY_DATA; + +// +// Define header for I/O control SRB. +// + +// +// Acceptable signatures for SCSI IOCTL MINIPORT calls. Must be equal in byte size to sizeof(SrbIoctl->Signature) +// +#define IOCTL_MINIPORT_SIGNATURE_SCSIDISK "SCSIDISK" +#define IOCTL_MINIPORT_SIGNATURE_HYBRDISK "HYBRDISK" +#define IOCTL_MINIPORT_SIGNATURE_DSM_NOTIFICATION "MPDSM " +#define IOCTL_MINIPORT_SIGNATURE_DSM_GENERAL "MPDSMGEN" + +#define IOCTL_MINIPORT_SIGNATURE_FIRMWARE "FIRMWARE" +#define IOCTL_MINIPORT_SIGNATURE_QUERY_PROTOCOL "PROTOCOL" +#define IOCTL_MINIPORT_SIGNATURE_SET_PROTOCOL "SETPROTO" +#define IOCTL_MINIPORT_SIGNATURE_QUERY_TEMPERATURE "TEMPERAT" +#define IOCTL_MINIPORT_SIGNATURE_SET_TEMPERATURE_THRESHOLD "SETTEMPT" +#define IOCTL_MINIPORT_SIGNATURE_QUERY_PHYSICAL_TOPOLOGY "TOPOLOGY" +#define IOCTL_MINIPORT_SIGNATURE_ENDURANCE_INFO "ENDURINF" + + +typedef struct _SRB_IO_CONTROL { + ULONG HeaderLength; + UCHAR Signature[8]; + ULONG Timeout; + ULONG ControlCode; + ULONG ReturnCode; + ULONG Length; +} SRB_IO_CONTROL, *PSRB_IO_CONTROL; + +typedef struct _NVCACHE_REQUEST_BLOCK { + ULONG NRBSize; + USHORT Function; + ULONG NRBFlags; + ULONG NRBStatus; + ULONG Count; + ULONGLONG LBA; + ULONG DataBufSize; + ULONG NVCacheStatus; + ULONG NVCacheSubStatus; +} NVCACHE_REQUEST_BLOCK, *PNVCACHE_REQUEST_BLOCK; + +#define NRB_FUNCTION_NVCACHE_INFO 0xEC +#define NRB_FUNCTION_SPINDLE_STATUS 0xE5 +#define NRB_FUNCTION_NVCACHE_POWER_MODE_SET 0x00 +#define NRB_FUNCTION_NVCACHE_POWER_MODE_RETURN 0x01 +#define NRB_FUNCTION_FLUSH_NVCACHE 0x14 +#define NRB_FUNCTION_QUERY_PINNED_SET 0x12 +#define NRB_FUNCTION_QUERY_CACHE_MISS 0x13 +#define NRB_FUNCTION_ADD_LBAS_PINNED_SET 0x10 +#define NRB_FUNCTION_REMOVE_LBAS_PINNED_SET 0x11 +#define NRB_FUNCTION_QUERY_ASCENDER_STATUS 0xD0 +#define NRB_FUNCTION_QUERY_HYBRID_DISK_STATUS 0xD1 + +// +// The NRB function - NRB_FUNCTION_PASS_HINT_PAYLOAD is deprecated. +// +#define NRB_FUNCTION_PASS_HINT_PAYLOAD 0xE0 + +// +// Function set to control write back caching policy separated non volatile cache in the miniport +// +#define NRB_FUNCTION_NVSEPARATED_INFO 0xc0 +#define NRB_FUNCTION_NVSEPARATED_FLUSH 0xc1 +#define NRB_FUNCTION_NVSEPARATED_WB_DISABLE 0xc2 +#define NRB_FUNCTION_NVSEPARATED_WB_REVERT_DEFAULT 0xc3 + + +#define NRB_SUCCESS 0 +#define NRB_ILLEGAL_REQUEST 1 +#define NRB_INVALID_PARAMETER 2 +#define NRB_INPUT_DATA_OVERRUN 3 +#define NRB_INPUT_DATA_UNDERRUN 4 +#define NRB_OUTPUT_DATA_OVERRUN 5 +#define NRB_OUTPUT_DATA_UNDERRUN 6 + +typedef struct _NV_FEATURE_PARAMETER{ + USHORT NVPowerModeEnabled; + USHORT NVParameterReserv1; + USHORT NVCmdEnabled; + USHORT NVParameterReserv2; + USHORT NVPowerModeVer; + USHORT NVCmdVer; + ULONG NVSize; // in number of LBA + USHORT NVReadSpeed; // in MB/s + USHORT NVWrtSpeed; + ULONG DeviceSpinUpTime; // in second +} NV_FEATURE_PARAMETER, *PNV_FEATURE_PARAMETER; + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int +#pragma warning(disable:4201) // nameless struct/unions + +// +// NOTE that data structure NVCACHE_HINT_PAYLOAD is deprecated along with NRB function - NRB_FUNCTION_PASS_HINT_PAYLOAD. +// +// Parameter structure for NRB_FUNCTION_PASS_HINT_PAYLOAD request +// This is the corresponding data structure for FIS 0x27 defined in SATA-IO spec. +// Caller that prepares this data structure shall set '0' to any non-used data field. +// +#pragma pack(push, nvcachehintpayload, 1) +typedef struct _NVCACHE_HINT_PAYLOAD { + UCHAR Command; // 0x63 or 0x64 + UCHAR Feature7_0; // when Commmand is 0x63, bit 0 - 3 reflects SubCommand + UCHAR Feature15_8; + UCHAR Count15_8; // when Commmand is 0x64, bit 0 - 4 reflects SubCommand + + UCHAR LBA7_0; + UCHAR LBA15_8; + UCHAR LBA23_16; + UCHAR LBA31_24; + + UCHAR LBA39_32; + UCHAR LBA47_40; + UCHAR Auxiliary7_0; + UCHAR Auxiliary23_16; + + UCHAR Reserved[4]; +} NVCACHE_HINT_PAYLOAD, *PNVCACHE_HINT_PAYLOAD; +#pragma pack(pop, nvcachehintpayload) + +// +// Parameter structure for NRB_FUNCTION_NVSEPARATED_INFO request +// +// Describes parameters of non volatile cache, supported by the miniport (aka separated nv cache). +// +// Caching is associated with the logical unit, it is up to the miniport to implement the exact scope (adapter or unit). MP caching is relative +// to what miniport considers as primary non volatile media for the unit. Miniport caching layer is separate from the caching layer integrated +// on the device and managed by the specific NRB functions. Miniport may have to support both separated cache and on device cache as well +// as volatile caches. Volatile cache policy is queried through the StorageProperty interface. +// +// Note that owner of the caching policy may be miniport or the HBA firmware, in either case miniport is the handler of the policy setting. +// + +typedef struct _NV_SEP_CACHE_PARAMETER{ + ULONG Version; // Version of the request structure + ULONG Size; // Size of this structure in bytes + + union { + + struct { + // + // Capability flags, describing separated non volatile cache + // + UCHAR WriteCacheEnabled : 1; // Is write caching enabled by the miniport as a persistent policy + UCHAR WriteCacheChangeable: 1; // Does the miniport respect change in write caching policy + UCHAR WriteThroughIOSupported :1;// Does the miniport support WriteThrough semantics for the NV cache on individual Writes . + UCHAR FlushCacheSupported :1; // Does the miniport support flushing of the NV cache + UCHAR ReservedBits: 4; + } CacheFlags; + + UCHAR CacheFlagsSet; + } Flags; + + // + // Persistent (cross boot) and effective caching types + // + UCHAR WriteCacheType; // Type of the NV cache (policy) supported by the miniport - persistent setting. + UCHAR WriteCacheTypeEffective;// Effective type of the NV cache (policy) used by the miniport at the time of query. + + UCHAR ParameterReserve1[3]; +} NV_SEP_CACHE_PARAMETER, *PNV_SEP_CACHE_PARAMETER; + +// +// Define version value for the structure +// +#define NV_SEP_CACHE_PARAMETER_VERSION_1 1 +#define NV_SEP_CACHE_PARAMETER_VERSION NV_SEP_CACHE_PARAMETER_VERSION_1 + +// +// Caching policy for separated NV cache. +// +// There are 2 distinct settings fields, one describing policy as used by the miniport +// after boot. The other field describes current effective policy setting, which may be impacted by NRB_FUNCTION_NVSEPARATED_WB_DISABLE +// +// Caller of NRB_FUNCTION_NVSEPARATED_INFO should expect only the effective policy setting to be modified if the query is made after +// call to NRB_FUNCTION_NVSEPARATED_WB_DISABLE (or other control codes in the future). +// +// Control of the persistent policy setting (WriteCacheType) is performed only through miniport proprietary interfaces +// + +typedef enum _NV_SEP_WRITE_CACHE_TYPE { + NVSEPWriteCacheTypeUnknown = 0, // Miniport can't report the type of the write cache + NVSEPWriteCacheTypeNone = 1, // Miniport doesn't support non volatile write cache + NVSEPWriteCacheTypeWriteBack = 2, // Miniport supports write back caching + NVSEPWriteCacheTypeWriteThrough = 3 // Miniport supports write through caching +} NV_SEP_WRITE_CACHE_TYPE, *PNV_SEP_WRITE_CACHE_TYPE; + +#pragma warning(pop) + +// +// STORAGE_DIAGNOSTIC_STATUS definitions +// +#define STORAGE_DIAGNOSTIC_STATUS_SUCCESS 0 +#define STORAGE_DIAGNOSTIC_STATUS_BUFFER_TOO_SMALL 0x1 +#define STORAGE_DIAGNOSTIC_STATUS_UNSUPPORTED_VERSION 0x2 +#define STORAGE_DIAGNOSTIC_STATUS_INVALID_PARAMETER 0x3 +#define STORAGE_DIAGNOSTIC_STATUS_INVALID_SIGNATURE 0x4 +#define STORAGE_DIAGNOSTIC_STATUS_INVALID_TARGET_TYPE 0x5 +#define STORAGE_DIAGNOSTIC_STATUS_MORE_DATA 0x6 + +// +// Diagnostic level allow caller to control what kinds of data the provider should return. +// +// Currently there is only default level defined, provider makes the call to return +// anything it assumes helpful for diagnostic purpose. +// +typedef enum _MP_STORAGE_DIAGNOSTIC_LEVEL { + MpStorageDiagnosticLevelDefault = 0, + MpStorageDiagnosticLevelMax +} MP_STORAGE_DIAGNOSTIC_LEVEL, *PMP_STORAGE_DIAGNOSTIC_LEVEL; + +typedef enum _MP_STORAGE_DIAGNOSTIC_TARGET_TYPE { + + MpStorageDiagnosticTargetTypeUndefined = 0, + MpStorageDiagnosticTargetTypeMiniport = 2, + MpStorageDiagnosticTargetTypeHbaFirmware, + MpStorageDiagnosticTargetTypeMax + +} MP_STORAGE_DIAGNOSTIC_TARGET_TYPE, *PMP_STORAGE_DIAGNOSTIC_TARGET_TYPE; + +// +// IOCTL_SCSI_MINIPORT_DIAGNOSTIC +// +// Diagnostic request to Miniport +// + +// +// Parameter for STORAGE_DIAGNOSTIC_MP_REQUEST +// Input buffer should contain SRB_IO_CONTROL, STORAGE_DIAGNOSTIC_MP_REQUEST structures. +// +// Fields in STORAGE_DIAGNOSTIC_MP_REQUEST +// - Input: Version +// - Input: TargetType +// - Input: Level +// - Output: ProviderId +// - Input/Output: BufferSize +// As input: +// "BufferSize" should be set to number of bytes allocated for the DataBuffer. +// As output: +// If the request is failed because of buffer too short, "BufferSize" should be set to the +// length required for DataBuffer by the diagnostic data provider; +// If the request is successful, it should be filled with returned data size of DataBuffer; +// For other cases, it should be cleared to 0. +// - Output: DataBuffer +// + +typedef struct _STORAGE_DIAGNOSTIC_MP_REQUEST { + + // Size of this structure. + ULONG Version; + + // Whole size of the structure and the associated data buffer. + ULONG Size; + + // Request target type. + MP_STORAGE_DIAGNOSTIC_TARGET_TYPE TargetType; + + // Diagnostic level. + MP_STORAGE_DIAGNOSTIC_LEVEL Level; + + // GUID of diagnostic data provider. + GUID ProviderId; + + // Data buffer size. + ULONG BufferSize; + + // Reserved for future use. + ULONG Reserved; + + // Diagnostic data buffer. + _Field_size_(BufferSize) UCHAR DataBuffer[ANYSIZE_ARRAY]; + +} STORAGE_DIAGNOSTIC_MP_REQUEST, *PSTORAGE_DIAGNOSTIC_MP_REQUEST; + +// +// MINIPORT_IOCTL block for data set management notifications +// +// Structure used to describe the list of ranges to process, should match the one in ntddstor.h +// + +typedef struct _MP_DEVICE_DATA_SET_RANGE { + LONGLONG StartingOffset; // Measured in bytes, must align to a sector boundary + ULONGLONG LengthInBytes; // Multiple of sector size. +} MP_DEVICE_DATA_SET_RANGE, *PMP_DEVICE_DATA_SET_RANGE; + + +typedef struct _DSM_NOTIFICATION_REQUEST_BLOCK { + ULONG Size; // Length of this structure + ULONG Version; // Version of the template + + ULONG NotifyFlags; // Same as in DSM definitions (eg Begin, End) + ULONG DataSetProfile; // Expected profile of IO access (based on OS file type : eg, hibernation, crashdump) + ULONG Reserved[3]; // Reserved for future use + ULONG DataSetRangesCount; + MP_DEVICE_DATA_SET_RANGE DataSetRanges[ANYSIZE_ARRAY]; +} DSM_NOTIFICATION_REQUEST_BLOCK,*PDSM_NOTIFICATION_REQUEST_BLOCK; + +// +// Define version value for the structure +// +#define MINIPORT_DSM_NOTIFICATION_VERSION_1 1 +#define MINIPORT_DSM_NOTIFICATION_VERSION MINIPORT_DSM_NOTIFICATION_VERSION_1 + +// +// Define access profiles, which are passed to the miniport, as describing expected access pattern to the dataset +// +#define MINIPORT_DSM_PROFILE_UNKNOWN 0 +#define MINIPORT_DSM_PROFILE_PAGE_FILE 1 +#define MINIPORT_DSM_PROFILE_HIBERNATION_FILE 2 +#define MINIPORT_DSM_PROFILE_CRASHDUMP_FILE 3 + +// +// Notification flag values - consistent with DSM flags, defined in ntddstor.h +// +#define MINIPORT_DSM_NOTIFY_FLAG_BEGIN 0x00000001 // The given LBA range is being used as defined by the profileID +#define MINIPORT_DSM_NOTIFY_FLAG_END 0x00000002 // The given LBA range is no longer being used as defined by the proileID + + +// +// Data structure and definitions related to IOCTL_SCSI_MINIPORT_HYBRID +// + +#define HYBRID_FUNCTION_GET_INFO 0x01 + +#define HYBRID_FUNCTION_DISABLE_CACHING_MEDIUM 0x10 +#define HYBRID_FUNCTION_ENABLE_CACHING_MEDIUM 0x11 +#define HYBRID_FUNCTION_SET_DIRTY_THRESHOLD 0x12 +#define HYBRID_FUNCTION_DEMOTE_BY_SIZE 0x13 + +// +// HYBRID IOCTL status +// +#define HYBRID_STATUS_SUCCESS 0x0 +#define HYBRID_STATUS_ILLEGAL_REQUEST 0x1 +#define HYBRID_STATUS_INVALID_PARAMETER 0x2 +#define HYBRID_STATUS_OUTPUT_BUFFER_TOO_SMALL 0x3 + +// +// A driver should keep a "RefCount" for HYBRID_FUNCTION_ENABLE_CACHING_MEDIUM. +// e.g. it increases this value every time when it receives a HYBRID_FUNCTION_ENABLE_CACHING_MEDIUM call. +// +// When driver receives HYBRID_FUNCTION_DISABLE_CACHING_MEDIUM call, it decreases "RefCount" when it's bigger than 0, +// and then only send command to disable caching medium when the new "RefCount" value is 0. +// +// In case of HYBRID_FUNCTION_DISABLE_CACHING_MEDIUM is received but no command is sent to device because of decreased "RefCount" is not 0, +// the driver returns following status to inform caller. +// +#define HYBRID_STATUS_ENABLE_REFCOUNT_HOLD 0x10 + +// +// General input data structure. +// Any data structures in input buffer after SRB_IO_CONTROL should contain HYBRID_REQUEST_BLOCK. +// +#define HYBRID_REQUEST_BLOCK_STRUCTURE_VERSION 0x1 + +typedef struct _HYBRID_REQUEST_BLOCK { + ULONG Version; // HYBRID_REQUEST_BLOCK_STRUCTURE_VERSION + ULONG Size; // Size of the data structure. + ULONG Function; // Function code + ULONG Flags; + + ULONG DataBufferOffset; // the offset is from the beginning of buffer. e.g. from beginning of SRB_IO_CONTROL. The value should be multiple of sizeof(PVOID); Value 0 means that there is no data buffer. + ULONG DataBufferLength; // length of the buffer +} HYBRID_REQUEST_BLOCK, *PHYBRID_REQUEST_BLOCK; + +// +// Parameter for HYBRID_FUNCTION_GET_INFO +// Input buffer should contain SRB_IO_CONTROL and HYBRID_REQUEST_BLOCK data structures. +// Field "DataBufferOffset" of HYBRID_REQUEST_BLOCK points to output data buffer and HYBRID_INFORMATION should be returned. +// + +// +// Output parameter for HYBRID_FUNCTION_GET_INFO +// +typedef enum _NVCACHE_TYPE { + NvCacheTypeUnknown = 0, // Driver can't report the type of the nvcache + NvCacheTypeNone = 1, // Device doesn't support non-volatile cache + NvCacheTypeWriteBack = 2, // Device supports write back caching + NvCacheTypeWriteThrough = 3 // Device supports write through caching +} NVCACHE_TYPE; + +typedef enum _NVCACHE_STATUS { + NvCacheStatusUnknown = 0, // Driver can't report non-volatile cache status + NvCacheStatusDisabling = 1, // non-volatile cache is in process of being disabled. + NvCacheStatusDisabled = 2, // non-volatile cache has been disabled. + NvCacheStatusEnabled = 3 // non-volatile cache has been enabled. +} NVCACHE_STATUS; + +typedef struct _NVCACHE_PRIORITY_LEVEL_DESCRIPTOR { + UCHAR PriorityLevel; + UCHAR Reserved0[3]; + ULONG ConsumedNVMSizeFraction; + ULONG ConsumedMappingResourcesFraction; + ULONG ConsumedNVMSizeForDirtyDataFraction; + ULONG ConsumedMappingResourcesForDirtyDataFraction; + ULONG Reserved1; +} NVCACHE_PRIORITY_LEVEL_DESCRIPTOR, *PNVCACHE_PRIORITY_LEVEL_DESCRIPTOR; + +#define HYBRID_REQUEST_INFO_STRUCTURE_VERSION 0x1 + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int +#pragma warning(disable:4200) // nonstandard extension used : zero-sized array in struct/union + +typedef struct _HYBRID_INFORMATION { + ULONG Version; // HYBRID_REQUEST_INFO_STRUCTURE_VERSION + ULONG Size; // sizeof(HYBRID_INFORMATION) + + BOOLEAN HybridSupported; + NVCACHE_STATUS Status; // for hybrid disk, expect values can be: NvCacheStatusDisabling, NvCacheStatusDisabled or NvCacheStatusEnabled + NVCACHE_TYPE CacheTypeEffective; // for hybrid disk, expect value will be: NvCacheTypeWriteBack + NVCACHE_TYPE CacheTypeDefault; // for hybrid disk, expect values can be: NvCacheTypeWriteBack + + ULONG FractionBase; // Base value of all fraction type of fields in the data structure. For hybrid disk, value of this field will be 255. + + ULONGLONG CacheSize; // total size of NVCache. unit: LBA count + + struct { + ULONG WriteCacheChangeable : 1; // Does the device respect change in write caching policy + ULONG WriteThroughIoSupported : 1; // Does the device support WriteThrough semantics for the NVCache on individual Writes. + ULONG FlushCacheSupported : 1; // Does the device support flushing of the NVCache + ULONG Removable : 1; // Does the nvcache can be removed. + ULONG ReservedBits : 28; + } Attributes; + + struct { + UCHAR PriorityLevelCount; // A non-zero value indicates the non-volatile cache supports priority levels. + BOOLEAN MaxPriorityBehavior; // If set to TRUE, the disk may fail IO sent with max priority level when it cannot find space for the IO in caching medium. + UCHAR OptimalWriteGranularity; // In LBAs. Value is the power value (of 2). Value 0xFF means that Optimal Write Granularity is not indicated. + // For example: value 0 indicates 2^0 = 1 logical sector, 1 indicates 2^1 = 2 logical sectors + UCHAR Reserved; + + ULONG DirtyThresholdLow; // fraction type of value, with base "FractionBase". + ULONG DirtyThresholdHigh; // fraction type of value, with base "FractionBase". + + struct { + ULONG CacheDisable : 1; // support of disabling the caching medium + ULONG SetDirtyThreshold : 1; // support of Setting dirty threshold for the entire caching medium + ULONG PriorityDemoteBySize : 1; // support of demote by size command + ULONG PriorityChangeByLbaRange : 1; // support of change by lba command + ULONG Evict : 1; // support of evict command + ULONG ReservedBits : 27; + + ULONG MaxEvictCommands; // Max outstanding Evict commands concurrently. Only value when "Evict" value is 1. + + ULONG MaxLbaRangeCountForEvict; // Count of LBA ranges can be associated with evict command. Only value when "Evict" value is 1. + ULONG MaxLbaRangeCountForChangeLba; // Count of LBA ranges associated with PriorityChangeByLbaRange command. Only value when "PriorityChangeByLbaRange" value is 1. + } SupportedCommands; + + NVCACHE_PRIORITY_LEVEL_DESCRIPTOR Priority[0]; + + } Priorities; + +} HYBRID_INFORMATION, *PHYBRID_INFORMATION; + +#pragma warning(pop) + +// +// Parameter for HYBRID_FUNCTION_DISABLE_CACHING_MEDIUM and HYBRID_FUNCTION_ENABLE_CACHING_MEDIUM +// Input buffer should contain SRB_IO_CONTROL and HYBRID_REQUEST_BLOCK data structures. +// Field "DataBufferOffset" of HYBRID_REQUEST_BLOCK should be set to "0" indicating there is no other parameter associated. +// NOTE that these functions don't have output parameter. +// + + +// +// Parameter for HYBRID_FUNCTION_SET_DIRTY_THRESHOLD +// Input buffer should contain SRB_IO_CONTROL, HYBRID_REQUEST_BLOCK and HYBRID_DIRTY_THRESHOLDS data structures. +// Field "DataBufferOffset" of HYBRID_REQUEST_BLOCK should be set to the starting offset of HYBRID_DIRTY_THRESHOLDS from beginning of buffer. +// NOTE that these functions don't have output parameter. +// +typedef struct _HYBRID_DIRTY_THRESHOLDS { + ULONG Version; + ULONG Size; // sizeof(HYBRID_DIRTY_THRESHOLDS) + + ULONG DirtyLowThreshold; // + ULONG DirtyHighThreshold; // >= DirtyLowThreshold +} HYBRID_DIRTY_THRESHOLDS, *PHYBRID_DIRTY_THRESHOLDS; + +// +// Parameter for HYBRID_FUNCTION_DEMOTE_BY_SIZE +// Input buffer should contain SRB_IO_CONTROL, HYBRID_REQUEST_BLOCK and HYBRID_DEMOTE_BY_SIZE data structures. +// Field "DataBufferOffset" of HYBRID_REQUEST_BLOCK should be set to the starting offset of HYBRID_DEMOTE_BY_SIZE from beginning of buffer. +// NOTE that these functions don't have output parameter. +// +typedef struct _HYBRID_DEMOTE_BY_SIZE { + ULONG Version; + ULONG Size; // sizeof(HYBRID_DEMOTE_BY_SIZE) + + UCHAR SourcePriority; // 1 ~ max priority + UCHAR TargetPriority; // < SourcePriority + USHORT Reserved0; + ULONG Reserved1; + ULONGLONG LbaCount; // How many LBAs should be demoted +} HYBRID_DEMOTE_BY_SIZE, *PHYBRID_DEMOTE_BY_SIZE; + + + +// +// Data structure and definitions related to IOCTL_SCSI_MINIPORT_FIRMWARE +// + +#define FIRMWARE_FUNCTION_GET_INFO 0x01 +#define FIRMWARE_FUNCTION_DOWNLOAD 0x02 +#define FIRMWARE_FUNCTION_ACTIVATE 0x03 + +// +// FIRMWARE IOCTL status +// +#define FIRMWARE_STATUS_SUCCESS 0x0 +#define FIRMWARE_STATUS_ERROR 0x1 +#define FIRMWARE_STATUS_ILLEGAL_REQUEST 0x2 +#define FIRMWARE_STATUS_INVALID_PARAMETER 0x3 +#define FIRMWARE_STATUS_INPUT_BUFFER_TOO_BIG 0x4 +#define FIRMWARE_STATUS_OUTPUT_BUFFER_TOO_SMALL 0x5 +#define FIRMWARE_STATUS_INVALID_SLOT 0x6 +#define FIRMWARE_STATUS_INVALID_IMAGE 0x7 +#define FIRMWARE_STATUS_CONTROLLER_ERROR 0x10 +#define FIRMWARE_STATUS_POWER_CYCLE_REQUIRED 0x20 +#define FIRMWARE_STATUS_DEVICE_ERROR 0x40 +#define FIRMWARE_STATUS_INTERFACE_CRC_ERROR 0x80 +#define FIRMWARE_STATUS_UNCORRECTABLE_DATA_ERROR 0x81 +#define FIRMWARE_STATUS_MEDIA_CHANGE 0x82 +#define FIRMWARE_STATUS_ID_NOT_FOUND 0x83 +#define FIRMWARE_STATUS_MEDIA_CHANGE_REQUEST 0x84 +#define FIRMWARE_STATUS_COMMAND_ABORT 0x85 +#define FIRMWARE_STATUS_END_OF_MEDIA 0x86 +#define FIRMWARE_STATUS_ILLEGAL_LENGTH 0x87 + +// +// For IOCTL_SCSI_MINIPORT_FIRMWARE, the data buffer should contain following structures/fields: +// 1. SRB_IO_CONTROL +// This is the header data structure indicating which IOCTL is sent. In this case, it's IOCTL_SCSI_MINIPORT_FIRMWARE. +// 2. FIRMWARE_REQUEST_BLOCK +// This data structure shall be right after SRB_IO_CONTROL. It indicates: +// a: the function code of firmware request. +// b: the data buffer location (in field - DataBufferOffset) and length (in field - DataBufferLength) for the firmware function. +// DataBufferOffset: should have value: ALIGN_UP(sizeof(SRB_IO_CONTROL) + sizeof(FIRMWARE_REQUEST_BLOCK), PVOID). This is to make sure the buffer is pointer aligned. +// 3. Padding. In case of (sizeof(SRB_IO_CONTROL) + sizeof(FIRMWARE_REQUEST_BLOCK)) is not multiple of pointer size, there will be padding space. +// 4. STORAGE_FIRMWARE_INFO or STORAGE_FIRMWARE_DOWNLOAD or STORAGE_FIRMWARE_ACTIVATE depending on the function code of firmware request. +// +#define FIRMWARE_REQUEST_BLOCK_STRUCTURE_VERSION 0x1 + +typedef struct _FIRMWARE_REQUEST_BLOCK { + ULONG Version; // FIRMWARE_REQUEST_BLOCK_STRUCTURE_VERSION + ULONG Size; // Size of the data structure. + ULONG Function; // Function code + ULONG Flags; + + ULONG DataBufferOffset; // the offset is from the beginning of buffer. e.g. from beginning of SRB_IO_CONTROL. The value should be multiple of sizeof(PVOID); Value 0 means that there is no data buffer. + ULONG DataBufferLength; // length of the buffer +} FIRMWARE_REQUEST_BLOCK, *PFIRMWARE_REQUEST_BLOCK; + +// +// The request is for Controller if this flag is set. Otherwise, it's for Device/Unit. +// +#define FIRMWARE_REQUEST_FLAG_CONTROLLER 0x00000001 + +// +// Indicate that current FW image segment is the last one. +// +#define FIRMWARE_REQUEST_FLAG_LAST_SEGMENT 0x00000002 + +// +// Indicate that current FW image segment is the first one. +// +#define FIRMWARE_REQUEST_FLAG_FIRST_SEGMENT 0x00000004 + +// +// Indicate that the existing firmware in slot should be activated immediately without +// controller reset. +// +#define FIRMWARE_REQUEST_FLAG_SWITCH_TO_FIRMWARE_WITHOUT_RESET 0x10000000 + +// +// Indicate that any existing firmware in slot should be replaced with the downloaded image, +// and activated with controller reset. +// +#define FIRMWARE_REQUEST_FLAG_REPLACE_AND_SWITCH_UPON_RESET 0x20000000 + +// +// Indicate that any existing firmware in slot should be replaced with the downloaded image. +// +#define FIRMWARE_REQUEST_FLAG_REPLACE_EXISTING_IMAGE 0x40000000 + +// +// Indicate that the existing firmware in slot should be activated. +// This flag is only valid for fimrware_activate request. It's ignored for other requests. +// +#define FIRMWARE_REQUEST_FLAG_SWITCH_TO_EXISTING_FIRMWARE 0x80000000 + +// +// Parameter for FIRMWARE_FUNCTION_GET_INFO +// Input buffer should contain SRB_IO_CONTROL and FIRMWARE_REQUEST_BLOCK data structures. +// Field "DataBufferOffset" of FIRMWARE_REQUEST_BLOCK points to output data buffer and STORAGE_FIRMWARE_INFO should be returned. +// + +// +// NOTE: In case of (NTDDI_VERSION >= NTDDI_WINTHRESHOLD), applications should use +// IOCTL_STORAGE_FIRMWARE_GET_INFO +// IOCTL_STORAGE_FIRMWARE_DOWNLOAD +// IOCTL_STORAGE_FIRMWARE_ACTIVATE +// to work on storage firmware query and update. +// +// Storage port driver uses FIRMWARE_FUNCTION_GET_INFO as corresponding interface to communicate to miniport. +// Version 1 data structures below are kept for backwards compatibility only. It's recommended that miniport drivers support Version 2 data structures. +// + +// +// Output parameter for FIRMWARE_FUNCTION_GET_INFO +// The total size of returned data is for Firmware Info is: +// sizeof(STORAGE_FIRMWARE_INFO) + sizeof(STORAGE_FIRMWARE_SLOT_INFO) * SlotCount. +// If the buffer is not big enough, callee should set "FIRMWARE_STATUS_OUTPUT_BUFFER_TOO_SMALL" into "ReturnCode" field of SRB_IO_CONTROL, +// and the required size in "DataBufferLength" field of FIRMWARE_REQUEST_BLOCK. +// + +#define STORAGE_FIRMWARE_INFO_STRUCTURE_VERSION 0x1 +#define STORAGE_FIRMWARE_INFO_STRUCTURE_VERSION_V2 0x2 + +#define STORAGE_FIRMWARE_INFO_INVALID_SLOT 0xFF + +typedef struct _STORAGE_FIRMWARE_SLOT_INFO { + + UCHAR SlotNumber; + BOOLEAN ReadOnly; + UCHAR Reserved[6]; + + union { + UCHAR Info[8]; + ULONGLONG AsUlonglong; + } Revision; + +} STORAGE_FIRMWARE_SLOT_INFO, *PSTORAGE_FIRMWARE_SLOT_INFO; + +#define STORAGE_FIRMWARE_SLOT_INFO_V2_REVISION_LENGTH 16 + +typedef struct _STORAGE_FIRMWARE_SLOT_INFO_V2 { + + UCHAR SlotNumber; + BOOLEAN ReadOnly; + UCHAR Reserved[6]; + + UCHAR Revision[STORAGE_FIRMWARE_SLOT_INFO_V2_REVISION_LENGTH]; + +} STORAGE_FIRMWARE_SLOT_INFO_V2, *PSTORAGE_FIRMWARE_SLOT_INFO_V2; + + +#pragma warning(push) +#pragma warning(disable:4200) // nonstandard extension used : zero-sized array in struct/union + +typedef struct _STORAGE_FIRMWARE_INFO { + + ULONG Version; // STORAGE_FIRMWARE_INFO_STRUCTURE_VERSION + ULONG Size; // sizeof(STORAGE_FIRMWARE_INFO) + + BOOLEAN UpgradeSupport; + UCHAR SlotCount; + UCHAR ActiveSlot; + UCHAR PendingActivateSlot; + + ULONG Reserved; + + STORAGE_FIRMWARE_SLOT_INFO Slot[0]; + +} STORAGE_FIRMWARE_INFO, *PSTORAGE_FIRMWARE_INFO; + +typedef struct _STORAGE_FIRMWARE_INFO_V2 { + + ULONG Version; // STORAGE_FIRMWARE_INFO_STRUCTURE_VERSION_V2 + ULONG Size; // sizeof(STORAGE_FIRMWARE_INFO_V2) + + BOOLEAN UpgradeSupport; + UCHAR SlotCount; + UCHAR ActiveSlot; + UCHAR PendingActivateSlot; + + BOOLEAN FirmwareShared; // The firmware applies to both device and adapter. For example: PCIe SSD. + UCHAR Reserved[3]; + + ULONG ImagePayloadAlignment; // Number of bytes. Max: PAGE_SIZE. The transfer size should be multiple of this unit size. Some protocol requires at least sector size. 0 means the value is not valid. + ULONG ImagePayloadMaxSize; // for a single command. + + STORAGE_FIRMWARE_SLOT_INFO_V2 Slot[0]; + +} STORAGE_FIRMWARE_INFO_V2, *PSTORAGE_FIRMWARE_INFO_V2; + + +// +// Parameter for FIRMWARE_FUNCTION_DOWNLOAD +// Input buffer should contain SRB_IO_CONTROL and FIRMWARE_REQUEST_BLOCK data structures. +// Field "DataBufferOffset" of FIRMWARE_REQUEST_BLOCK points to input data buffer that contains STORAGE_FIRMWARE_DOWNLOAD. +// +#define STORAGE_FIRMWARE_DOWNLOAD_STRUCTURE_VERSION 0x1 +#define STORAGE_FIRMWARE_DOWNLOAD_STRUCTURE_VERSION_V2 0x2 + +typedef struct _STORAGE_FIRMWARE_DOWNLOAD { + + ULONG Version; // STORAGE_FIRMWARE_DOWNLOAD_STRUCTURE_VERSION + ULONG Size; // sizeof(STORAGE_FIRMWARE_DOWNLOAD) + + ULONGLONG Offset; // image file offset, should be aligned to value of "ImagePayloadAlignment" from STORAGE_FIRMWARE_INFO. + ULONGLONG BufferSize; // should be multiple of value of "ImagePayloadAlignment" from STORAGE_FIRMWARE_INFO + + UCHAR ImageBuffer[0]; // firmware image file. + +} STORAGE_FIRMWARE_DOWNLOAD, *PSTORAGE_FIRMWARE_DOWNLOAD; + +typedef struct _STORAGE_FIRMWARE_DOWNLOAD_V2 { + + ULONG Version; // STORAGE_FIRMWARE_DOWNLOAD_STRUCTURE_VERSION_V2 + ULONG Size; // sizeof(STORAGE_FIRMWARE_DOWNLOAD_V2) + + ULONGLONG Offset; // image file offset, should be aligned to value of "ImagePayloadAlignment" from STORAGE_FIRMWARE_INFO. + ULONGLONG BufferSize; // should be multiple of value of "ImagePayloadAlignment" from STORAGE_FIRMWARE_INFO + + UCHAR Slot; + UCHAR Reserved[3]; + ULONG ImageSize; + + UCHAR ImageBuffer[0]; // firmware image file. + +} STORAGE_FIRMWARE_DOWNLOAD_V2, *PSTORAGE_FIRMWARE_DOWNLOAD_V2; + +#pragma warning(pop) + +// +// Parameter for FIRMWARE_FUNCTION_ACTIVATE +// Input buffer should contain SRB_IO_CONTROL and FIRMWARE_REQUEST_BLOCK data structures. +// Field "DataBufferOffset" of FIRMWARE_REQUEST_BLOCK points to input data buffer that contains STORAGE_FIRMWARE_ACTIVATE. +// +#define STORAGE_FIRMWARE_ACTIVATE_STRUCTURE_VERSION 0x1 + +typedef struct _STORAGE_FIRMWARE_ACTIVATE { + + ULONG Version; + ULONG Size; + + UCHAR SlotToActivate; + UCHAR Reserved0[3]; + +} STORAGE_FIRMWARE_ACTIVATE, *PSTORAGE_FIRMWARE_ACTIVATE; + + + +// +// SCSI port driver capabilities structure. +// + +typedef struct _IO_SCSI_CAPABILITIES { + + // + // Length of this structure + // + + ULONG Length; + + // + // Maximum transfer size in single SRB + // + + ULONG MaximumTransferLength; + + // + // Maximum number of physical pages per data buffer + // + + ULONG MaximumPhysicalPages; + + // + // Async calls from port to class + // + + ULONG SupportedAsynchronousEvents; + + // + // Alignment mask for data transfers. + // + + ULONG AlignmentMask; + + // + // Supports tagged queuing + // + + BOOLEAN TaggedQueuing; + + // + // Host adapter scans down for bios devices. + // + + BOOLEAN AdapterScansDown; + + // + // The host adapter uses programmed I/O. + // + + BOOLEAN AdapterUsesPio; + +} IO_SCSI_CAPABILITIES, *PIO_SCSI_CAPABILITIES; + +typedef struct _SCSI_ADDRESS { + ULONG Length; + UCHAR PortNumber; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; +} SCSI_ADDRESS, *PSCSI_ADDRESS; + +// +// Define structure for returning crash dump pointers. +// + +struct _ADAPTER_OBJECT; +#define DUMP_POINTERS_VERSION_1 1 +#define DUMP_POINTERS_VERSION_2 2 +#define DUMP_POINTERS_VERSION_3 3 +#define DUMP_POINTERS_VERSION_4 4 +#define DUMP_DRIVER_NAME_LENGTH 15 + +typedef +LONG +DUMP_DEVICE_POWERON_ROUTINE( + _In_ PVOID Context + ); +typedef DUMP_DEVICE_POWERON_ROUTINE *PDUMP_DEVICE_POWERON_ROUTINE; + +typedef struct _DUMP_POINTERS_VERSION { + // + // Dump pointers structure version + // + ULONG Version; + + // + // Dump pointers structure size + // + ULONG Size; + +} DUMP_POINTERS_VERSION, *PDUMP_POINTERS_VERSION; + +typedef struct _DUMP_POINTERS { + struct _ADAPTER_OBJECT *AdapterObject; + PVOID MappedRegisterBase; + PVOID DumpData; + PVOID CommonBufferVa; + LARGE_INTEGER CommonBufferPa; + ULONG CommonBufferSize; + BOOLEAN AllocateCommonBuffers; +#if (NTDDI_VERSION < NTDDI_WINXP) + UCHAR Spare1[3]; +#else + BOOLEAN UseDiskDump; + UCHAR Spare1[2]; +#endif + PVOID DeviceObject; +} DUMP_POINTERS, *PDUMP_POINTERS; + +typedef struct _DUMP_POINTERS_EX { + DUMP_POINTERS_VERSION Header; + PVOID DumpData; + PVOID CommonBufferVa; + ULONG CommonBufferSize; + BOOLEAN AllocateCommonBuffers; + PVOID DeviceObject; + PVOID DriverList; + +#if (NTDDI_VERSION >= NTDDI_WIN8) + + // + // Start of DUMP_POINTERS_EX_V3 specific fields + // + ULONG dwPortFlags; // Bit mask of various flags, returned by the port driver to crashdump driver + + // + // Configuration values for device telemetry collection - obtained from either live device or from the registry. + // + ULONG MaxDeviceDumpSectionSize;// Size of the buffer to hold complete telemetry section from the storage stack (header, public and private subsections) + ULONG MaxDeviceDumpLevel; // Max level of device dump to request from the device at the crash time + + // + // Maximum transfer size supported in dump stack + // + ULONG MaxTransferSize; + + // + // Field needed to support DMA operations in diskdump for storport miniports. + // + PVOID AdapterObject; + PVOID MappedRegisterBase; + + // + // Pointer to stack managed 'device ready for dump'. + // + + PBOOLEAN DeviceReady; + +#endif + + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + // + // Start of DUMP_POINTERS_EX_V4 specific fields + // + + // + // Dump device power up callback + // + PDUMP_DEVICE_POWERON_ROUTINE DumpDevicePowerOn; + PVOID DumpDevicePowerOnContext; + +#endif + +} DUMP_POINTERS_EX, *PDUMP_POINTERS_EX; + + +#if (NTDDI_VERSION == NTDDI_WIN8) + +// +// Size of the different DUMP_POINTERS_EX structures +// + +#define DUMP_POINTERS_EX_V2_SIZE ((ULONG)FIELD_OFFSET(DUMP_POINTERS_EX, dwPortFlags)) +#define DUMP_POINTERS_EX_V3_SIZE sizeof(DUMP_POINTERS_EX) + +#elif (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define DUMP_POINTERS_EX_V2_SIZE ((ULONG)FIELD_OFFSET(DUMP_POINTERS_EX, dwPortFlags)) +#define DUMP_POINTERS_EX_V3_SIZE ((ULONG)FIELD_OFFSET(DUMP_POINTERS_EX, DumpDevicePowerOn)) +#define DUMP_POINTERS_EX_V4_SIZE sizeof(DUMP_POINTERS_EX) + +#endif + +// +// Bit flag values, returned by the port driver in DUMP_POINTERS_EX structure +// + +// +// Driver stack & controller support 64-bit physical memory +// +#define DUMP_EX_FLAG_SUPPORT_64BITMEMORY 0x00000001 + +// +// Driver stack is capable of producing device and driver telemetry data (individual device may not be able to return data) +// +#define DUMP_EX_FLAG_SUPPORT_DD_TELEMETRY 0x00000002 + +// +// Driver stack is capable of working after a system resume +// +#define DUMP_EX_FLAG_RESUME_SUPPORT 0x00000004 + +// +// Driver stack is capable to provide driver full path(DUMP_DRIVER_EX is allocated/used by lower stack) +// +#define DUMP_EX_FLAG_DRIVER_FULL_PATH_SUPPORT 0x00000008 + +typedef struct _DUMP_DRIVER { + + // + // Dump driver list from port driver + // + PVOID DumpDriverList; + + // + // Name of the driver to be loaded + // + WCHAR DriverName[DUMP_DRIVER_NAME_LENGTH]; + + // + // Driver base name + // + WCHAR BaseName[DUMP_DRIVER_NAME_LENGTH]; + +} DUMP_DRIVER, *PDUMP_DRIVER; + +// +// Duplicate UNICODE_STRING definition here to eliminate dependancy +// with other header file. +// +// Unicode strings are counted 16-bit character strings. If they are +// NULL terminated, Length does not include trailing NULL. +// + +typedef struct _NTSCSI_UNICODE_STRING { + USHORT Length; + USHORT MaximumLength; +#ifdef MIDL_PASS + [size_is(MaximumLength / 2), length_is((Length) / 2) ] USHORT * Buffer; +#else // MIDL_PASS + _Field_size_bytes_part_opt_(MaximumLength, Length) PWCH Buffer; +#endif // MIDL_PASS +} NTSCSI_UNICODE_STRING; +typedef NTSCSI_UNICODE_STRING *PNTSCSI_UNICODE_STRING; + +typedef struct _DUMP_DRIVER_EX { + + // + // Dump driver list from port driver + // + PVOID DumpDriverList; + + // + // Name of the driver to be loaded + // + WCHAR DriverName[DUMP_DRIVER_NAME_LENGTH]; + + // + // Driver base name + // + WCHAR BaseName[DUMP_DRIVER_NAME_LENGTH]; + + // + // Driver full path string + // + NTSCSI_UNICODE_STRING DriverFullPath; + +} DUMP_DRIVER_EX, *PDUMP_DRIVER_EX; + + +// +// Define values for pass-through DataIn field. +// + +#define SCSI_IOCTL_DATA_OUT 0 +#define SCSI_IOCTL_DATA_IN 1 +#define SCSI_IOCTL_DATA_UNSPECIFIED 2 + +// +// This value specifies that there is both a data-in and data-out buffer. +// This value is only relevant when used for the DataDirection field of +// SCSI_PASS_THROUGH_EX and SCSI_PASS_THROUGH_DIRECT_EX. +// +#define SCSI_IOCTL_DATA_BIDIRECTIONAL 3 + +// +// Define values for MPIO-pass-through-path Flags field. +// + +#define MPIO_IOCTL_FLAG_USE_PATHID 1 +#define MPIO_IOCTL_FLAG_USE_SCSIADDRESS 2 +#define MPIO_IOCTL_FLAG_INVOLVE_DSM 4 + + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct +#pragma warning(disable:4201) // nameless struct/union + +// +// Parameters for IOCTL_SCSI_MINIPORT/IOCTL_MINIPORT_SIGNATURE_ENDURANCE_INFO +// The storage port driver uses these structures when communicating with the miniport. +// + +typedef struct _STORAGE_ENDURANCE_INFO { + ULONG ValidFields; // ValidFields represents bit mapping of valid fields of any type + // Eg: Bit 0 stands for GroupId, Bit 1 stands for Flags, Bit 3 for BytesReadCount + + ULONG GroupId; // Set Id Eg: Set Id for NVMe sets + + struct { + ULONG Shared:1; // TRUE if information is shared with multiple units/groups + + ULONG Reserved:31; + } Flags; + + ULONG LifePercentage; // Used life percentage + + UCHAR BytesReadCount[16]; // Total bytes read from device (Billion Unit) + + UCHAR ByteWriteCount[16]; // Total bytes written to device (Billion Unit) + +} STORAGE_ENDURANCE_INFO, *PSTORAGE_ENDURANCE_INFO; + +typedef struct _STORAGE_ENDURANCE_DATA_DESCRIPTOR { + ULONG Version; // Version of the endurance information structure + + ULONG Size; // Size of the endurance information + + STORAGE_ENDURANCE_INFO EnduranceInfo; // Endurance Information of the device + +} STORAGE_ENDURANCE_DATA_DESCRIPTOR, *PSTORAGE_ENDURANCE_DATA_DESCRIPTOR; + +#pragma warning(pop) + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddser.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddser.h new file mode 100644 index 0000000000000000000000000000000000000000..7241a419967b1500271b5bf031fa81a5778c4bdb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddser.h @@ -0,0 +1,754 @@ +/*++ BUILD Version: 0002 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddser.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Serial device. + +--*/ + +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +// +// Interface GUIDs +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// + +#ifdef DEFINE_GUID +// +// Make sure FAR is defined... +// +#ifndef FAR +#ifdef _WIN32 +#define FAR +#else +#define FAR _far +#endif +#endif + +// begin_wioctlguids +// {86E0D1E0-8089-11D0-9CE4-08003E301F73} +DEFINE_GUID(GUID_DEVINTERFACE_COMPORT, 0X86E0D1E0L, 0X8089, 0X11D0, 0X9C, 0XE4, 0X08, 0X00, 0X3E, 0X30, 0X1F, 0X73); +// {4D36E978-E325-11CE-BFC1-08002BE10318} +DEFINE_GUID(GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR, 0x4D36E978L, 0xE325, 0x11CE, 0xBF, 0xC1, 0x08, 0x00, 0x2B, 0xE1, 0x03, 0x18); +// end_wioctlguids + +// begin_wioctlobsoleteguids +#define GUID_CLASS_COMPORT GUID_DEVINTERFACE_COMPORT +#define GUID_SERENUM_BUS_ENUMERATOR GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR +// end_wioctlobsoleteguids + +#endif // DEFINE_GUID + +// +// Interface DEVPROPKEYs +// +// need these DEVPROPKEYs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the DEVPROPKEYs +// +#ifdef DEFINE_DEVPROPKEY + +// +// Device interface properties +// + +// Name: System.DeviceInterface.Serial.UsbVendorId +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {4C6BF15C-4C03-4AAC-91F5-64C0F852BCF4}, 2 +// +// UsbVendorId of Serial device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Serial_UsbVendorId, 0X4C6BF15C, 0X4C03, 0X4AAC, 0X91, 0XF5, 0X64, 0XC0, 0XF8, 0X52, 0XBC, 0XF4, 2); + + +// Name: System.DeviceInterface.Serial.UsbProductId +// Type: Two-Byte Integer - DEVPROP_TYPE_UINT16 +// FormatID: {4C6BF15C-4C03-4AAC-91F5-64C0F852BCF4}, 3 +// +// UsbProductId of Serial device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Serial_UsbProductId, 0X4C6BF15C, 0X4C03, 0X4AAC, 0X91, 0XF5, 0X64, 0XC0, 0XF8, 0X52, 0XBC, 0XF4, 3); + +// Name: System.DeviceInterface.Serial.PortName +// Type: String - DEVPROP_TYPE_STRING +// FormatID: {4C6BF15C-4C03-4AAC-91F5-64C0F852BCF4}, 4 +// +// PortName of Serial device +DEFINE_DEVPROPKEY(DEVPKEY_DeviceInterface_Serial_PortName, 0X4C6BF15C, 0X4C03, 0X4AAC, 0X91, 0XF5, 0X64, 0XC0, 0XF8, 0X52, 0XBC, 0XF4, 4); + +#endif // DEFINE_DEVPROPKEY + + +#ifndef _NTDDSER_ +#define _NTDDSER_ + +#ifdef __cplusplus +extern "C" { +#endif + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// + +#define IOCTL_SERIAL_SET_BAUD_RATE CTL_CODE(FILE_DEVICE_SERIAL_PORT, 1,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_QUEUE_SIZE CTL_CODE(FILE_DEVICE_SERIAL_PORT, 2,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_LINE_CONTROL CTL_CODE(FILE_DEVICE_SERIAL_PORT, 3,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_BREAK_ON CTL_CODE(FILE_DEVICE_SERIAL_PORT, 4,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_BREAK_OFF CTL_CODE(FILE_DEVICE_SERIAL_PORT, 5,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_IMMEDIATE_CHAR CTL_CODE(FILE_DEVICE_SERIAL_PORT, 6,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_TIMEOUTS CTL_CODE(FILE_DEVICE_SERIAL_PORT, 7,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_TIMEOUTS CTL_CODE(FILE_DEVICE_SERIAL_PORT, 8,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_DTR CTL_CODE(FILE_DEVICE_SERIAL_PORT, 9,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_CLR_DTR CTL_CODE(FILE_DEVICE_SERIAL_PORT,10,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_RESET_DEVICE CTL_CODE(FILE_DEVICE_SERIAL_PORT,11,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_RTS CTL_CODE(FILE_DEVICE_SERIAL_PORT,12,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_CLR_RTS CTL_CODE(FILE_DEVICE_SERIAL_PORT,13,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_XOFF CTL_CODE(FILE_DEVICE_SERIAL_PORT,14,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_XON CTL_CODE(FILE_DEVICE_SERIAL_PORT,15,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_WAIT_MASK CTL_CODE(FILE_DEVICE_SERIAL_PORT,16,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_WAIT_MASK CTL_CODE(FILE_DEVICE_SERIAL_PORT,17,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_WAIT_ON_MASK CTL_CODE(FILE_DEVICE_SERIAL_PORT,18,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_PURGE CTL_CODE(FILE_DEVICE_SERIAL_PORT,19,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_BAUD_RATE CTL_CODE(FILE_DEVICE_SERIAL_PORT,20,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_LINE_CONTROL CTL_CODE(FILE_DEVICE_SERIAL_PORT,21,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_CHARS CTL_CODE(FILE_DEVICE_SERIAL_PORT,22,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_CHARS CTL_CODE(FILE_DEVICE_SERIAL_PORT,23,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_HANDFLOW CTL_CODE(FILE_DEVICE_SERIAL_PORT,24,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_HANDFLOW CTL_CODE(FILE_DEVICE_SERIAL_PORT,25,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_MODEMSTATUS CTL_CODE(FILE_DEVICE_SERIAL_PORT,26,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_COMMSTATUS CTL_CODE(FILE_DEVICE_SERIAL_PORT,27,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_XOFF_COUNTER CTL_CODE(FILE_DEVICE_SERIAL_PORT,28,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_PROPERTIES CTL_CODE(FILE_DEVICE_SERIAL_PORT,29,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_DTRRTS CTL_CODE(FILE_DEVICE_SERIAL_PORT,30,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// +// Serenum reserves function codes between 128 and 255. Do not use. +// + +// begin_winioctl + +#define IOCTL_SERIAL_LSRMST_INSERT CTL_CODE(FILE_DEVICE_SERIAL_PORT,31,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_SERENUM_EXPOSE_HARDWARE CTL_CODE(FILE_DEVICE_SERENUM,128,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERENUM_REMOVE_HARDWARE CTL_CODE(FILE_DEVICE_SERENUM,129,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERENUM_PORT_DESC CTL_CODE(FILE_DEVICE_SERENUM,130,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERENUM_GET_PORT_NAME CTL_CODE(FILE_DEVICE_SERENUM,131,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// end_winioctl + +#define IOCTL_SERIAL_CONFIG_SIZE CTL_CODE(FILE_DEVICE_SERIAL_PORT,32,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_COMMCONFIG CTL_CODE(FILE_DEVICE_SERIAL_PORT,33,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_COMMCONFIG CTL_CODE(FILE_DEVICE_SERIAL_PORT,34,METHOD_BUFFERED,FILE_ANY_ACCESS) + +#define IOCTL_SERIAL_GET_STATS CTL_CODE(FILE_DEVICE_SERIAL_PORT,35,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_CLEAR_STATS CTL_CODE(FILE_DEVICE_SERIAL_PORT,36,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_GET_MODEM_CONTROL CTL_CODE(FILE_DEVICE_SERIAL_PORT,37,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_MODEM_CONTROL CTL_CODE(FILE_DEVICE_SERIAL_PORT,38,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_FIFO_CONTROL CTL_CODE(FILE_DEVICE_SERIAL_PORT,39,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// +// IoControlCodes reserved for use with the serial class extension (SerCx) +// + +#define IOCTL_SERIAL_APPLY_DEFAULT_CONFIGURATION CTL_CODE(FILE_DEVICE_SERIAL_PORT,40,METHOD_BUFFERED,FILE_ANY_ACCESS) +#define IOCTL_SERIAL_SET_INTERVAL_TIMER_RESOLUTION \ + CTL_CODE(FILE_DEVICE_SERIAL_PORT,41,METHOD_BUFFERED,FILE_ANY_ACCESS) + +// +// internal serial IOCTL's +// + +#define IOCTL_SERIAL_INTERNAL_DO_WAIT_WAKE CTL_CODE(FILE_DEVICE_SERIAL_PORT, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SERIAL_INTERNAL_CANCEL_WAIT_WAKE CTL_CODE(FILE_DEVICE_SERIAL_PORT, 2, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SERIAL_INTERNAL_BASIC_SETTINGS CTL_CODE(FILE_DEVICE_SERIAL_PORT, 3, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SERIAL_INTERNAL_RESTORE_SETTINGS CTL_CODE(FILE_DEVICE_SERIAL_PORT, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) + +typedef struct _SERIALPERF_STATS { + ULONG ReceivedCount; + ULONG TransmittedCount; + ULONG FrameErrorCount; + ULONG SerialOverrunErrorCount; + ULONG BufferOverrunErrorCount; + ULONG ParityErrorCount; +} SERIALPERF_STATS, *PSERIALPERF_STATS; + +typedef struct _SERIALCONFIG { + ULONG Size; + USHORT Version; + ULONG SubType; + ULONG ProvOffset; + ULONG ProviderSize; + WCHAR ProviderData[1]; +} SERIALCONFIG,*PSERIALCONFIG; + +// +// NtDeviceIoControlFile InputBuffer/OutputBuffer record structures for +// this device. +// + +// +// This structure used to set line parameters. +// + +typedef struct _SERIAL_LINE_CONTROL { + UCHAR StopBits; + UCHAR Parity; + UCHAR WordLength; + } SERIAL_LINE_CONTROL,*PSERIAL_LINE_CONTROL; + +typedef struct _SERIAL_TIMEOUTS { + ULONG ReadIntervalTimeout; + ULONG ReadTotalTimeoutMultiplier; + ULONG ReadTotalTimeoutConstant; + ULONG WriteTotalTimeoutMultiplier; + ULONG WriteTotalTimeoutConstant; + } SERIAL_TIMEOUTS,*PSERIAL_TIMEOUTS; + +// +// This structure used to resize the input/output buffers. +// An error code will be returned if the size exceeds the +// drivers capacity. The driver reserves the right to +// allocate a larger buffer. +// + +typedef struct _SERIAL_QUEUE_SIZE { + ULONG InSize; + ULONG OutSize; + } SERIAL_QUEUE_SIZE,*PSERIAL_QUEUE_SIZE; + + +// +// This structure used by set baud rate +// + +typedef struct _SERIAL_BAUD_RATE { + ULONG BaudRate; + } SERIAL_BAUD_RATE,*PSERIAL_BAUD_RATE; + + + +// +// Defines the bitmask that the driver can used to notify +// app of various changes in the state of the UART. +// + +#define SERIAL_EV_RXCHAR 0x0001 // Any Character received +#define SERIAL_EV_RXFLAG 0x0002 // Received certain character +#define SERIAL_EV_TXEMPTY 0x0004 // Transmitt Queue Empty +#define SERIAL_EV_CTS 0x0008 // CTS changed state +#define SERIAL_EV_DSR 0x0010 // DSR changed state +#define SERIAL_EV_RLSD 0x0020 // RLSD changed state +#define SERIAL_EV_BREAK 0x0040 // BREAK received +#define SERIAL_EV_ERR 0x0080 // Line status error occurred +#define SERIAL_EV_RING 0x0100 // Ring signal detected +#define SERIAL_EV_PERR 0x0200 // Printer error occured +#define SERIAL_EV_RX80FULL 0x0400 // Receive buffer is 80 percent full +#define SERIAL_EV_EVENT1 0x0800 // Provider specific event 1 +#define SERIAL_EV_EVENT2 0x1000 // Provider specific event 2 + +// +// A longword is used to send down a mask that +// instructs the driver what to purge. +// +// SERIAL_PURGE_TXABORT - Implies the current and all pending writes. +// SERIAL_PURGE_RXABORT - Implies the current and all pending reads. +// SERIAL_PURGE_TXCLEAR - Implies the transmit buffer if exists +// SERIAL_PURGE_RXCLEAR - Implies the receive buffer if exists. +// + +#define SERIAL_PURGE_TXABORT 0x00000001 +#define SERIAL_PURGE_RXABORT 0x00000002 +#define SERIAL_PURGE_TXCLEAR 0x00000004 +#define SERIAL_PURGE_RXCLEAR 0x00000008 + +// +// Communication defines +// + +#define STOP_BIT_1 0 +#define STOP_BITS_1_5 1 +#define STOP_BITS_2 2 + +#define NO_PARITY 0 +#define ODD_PARITY 1 +#define EVEN_PARITY 2 +#define MARK_PARITY 3 +#define SPACE_PARITY 4 + + +// +// This structure is used to set and retrieve the special characters +// used by the nt serial driver. +// +// Note that the driver will return an error if xonchar == xoffchar. +// + +typedef struct _SERIAL_CHARS { + UCHAR EofChar; + UCHAR ErrorChar; + UCHAR BreakChar; + UCHAR EventChar; + UCHAR XonChar; + UCHAR XoffChar; + } SERIAL_CHARS,*PSERIAL_CHARS; + +// +// This structure is used to contain the flow control +// and handshaking setup. +// +// A reasonably precise explaination of how they all +// work can be found in the OS/2 tech references. +// +// For Xon/Xofflimit: +// +// When there are more characters then +// +// (typeaheadbuffersize - xofflimit) +// +// in the typeahead buffer then the driver will perform all flow +// control that the app has enabled so that the sender will (hopefully) +// stop sending characters. +// +// When there are less than xonlimit number of characters in the +// typeahead buffer the driver will perform all flow control that +// the app has enabled so that the sender will hopefully start sending +// characters again. +// +// It should be noted that if Xoff character is sent then the +// driver will also stop transmitting any more characters. This is to +// provide support for those systems that take any character that +// follows an Xoff as an implied Xon. +// + +typedef struct _SERIAL_HANDFLOW { + ULONG ControlHandShake; + ULONG FlowReplace; + LONG XonLimit; + LONG XoffLimit; + } SERIAL_HANDFLOW,*PSERIAL_HANDFLOW; + +#define SERIAL_DTR_MASK ((ULONG)0x03) +#define SERIAL_DTR_CONTROL ((ULONG)0x01) +#define SERIAL_DTR_HANDSHAKE ((ULONG)0x02) +#define SERIAL_CTS_HANDSHAKE ((ULONG)0x08) +#define SERIAL_DSR_HANDSHAKE ((ULONG)0x10) +#define SERIAL_DCD_HANDSHAKE ((ULONG)0x20) +#define SERIAL_OUT_HANDSHAKEMASK ((ULONG)0x38) +#define SERIAL_DSR_SENSITIVITY ((ULONG)0x40) +#define SERIAL_ERROR_ABORT ((ULONG)0x80000000) +#define SERIAL_CONTROL_INVALID ((ULONG)0x7fffff84) +#define SERIAL_AUTO_TRANSMIT ((ULONG)0x01) +#define SERIAL_AUTO_RECEIVE ((ULONG)0x02) +#define SERIAL_ERROR_CHAR ((ULONG)0x04) +#define SERIAL_NULL_STRIPPING ((ULONG)0x08) +#define SERIAL_BREAK_CHAR ((ULONG)0x10) +#define SERIAL_RTS_MASK ((ULONG)0xc0) +#define SERIAL_RTS_CONTROL ((ULONG)0x40) +#define SERIAL_RTS_HANDSHAKE ((ULONG)0x80) +#define SERIAL_TRANSMIT_TOGGLE ((ULONG)0xc0) +#define SERIAL_XOFF_CONTINUE ((ULONG)0x80000000) +#define SERIAL_FLOW_INVALID ((ULONG)0x7fffff20) + +// +// These are the following reasons that the device could be holding. +// +#define SERIAL_TX_WAITING_FOR_CTS ((ULONG)0x00000001) +#define SERIAL_TX_WAITING_FOR_DSR ((ULONG)0x00000002) +#define SERIAL_TX_WAITING_FOR_DCD ((ULONG)0x00000004) +#define SERIAL_TX_WAITING_FOR_XON ((ULONG)0x00000008) +#define SERIAL_TX_WAITING_XOFF_SENT ((ULONG)0x00000010) +#define SERIAL_TX_WAITING_ON_BREAK ((ULONG)0x00000020) +#define SERIAL_RX_WAITING_FOR_DSR ((ULONG)0x00000040) + +// +// These are the error values that can be returned by the +// driver. +// +#define SERIAL_ERROR_BREAK ((ULONG)0x00000001) +#define SERIAL_ERROR_FRAMING ((ULONG)0x00000002) +#define SERIAL_ERROR_OVERRUN ((ULONG)0x00000004) +#define SERIAL_ERROR_QUEUEOVERRUN ((ULONG)0x00000008) +#define SERIAL_ERROR_PARITY ((ULONG)0x00000010) + + +// +// This structure is used by IOCTL_SERIAL_INTERNAL_BASIC_SETTINGS +// and IOCTL_SERIAL_INTERNAL_RESTORE_SETTINGS +// + +typedef struct _SERIAL_BASIC_SETTINGS { + SERIAL_TIMEOUTS Timeouts; + SERIAL_HANDFLOW HandFlow; + ULONG RxFifo; + ULONG TxFifo; +} SERIAL_BASIC_SETTINGS, *PSERIAL_BASIC_SETTINGS; + + +// +// This structure is used to get the current error and +// general status of the driver. +// + +typedef struct _SERIAL_STATUS { + ULONG Errors; + ULONG HoldReasons; + ULONG AmountInInQueue; + ULONG AmountInOutQueue; + BOOLEAN EofReceived; + BOOLEAN WaitForImmediate; + } SERIAL_STATUS,*PSERIAL_STATUS; + +// +// This structure is used for XOFF counter ioctl. The xoff ioctl +// is used to support those subsystems that feel the need to emulate +// the serial chip in software. +// +// It has the following semantics: +// +// This io request is placed into the normal device write +// queue. That is, it will be queued behind any writes +// already given to the driver. +// +// When this request becomes the current request, the character +// specified in the field XoffChar will be sent, subject to +// all other flow control already defined. +// +// Immediately upon sending the character the driver will +// perform the following actions. +// +// A timer will be initiated that will expire after the +// number of milliseconds in the Timeout field of the +// SERIAL_XOFF_COUNTER structure. +// +// The driver will initialize a counter to the value specified +// in the Counter field of the SERIAL_XOFF_RECORD. The driver +// will decrement this counter whenever a character is received. +// +// This request will then be held by the driver. It will +// actually complete under the following circumstances: +// +// 1) If there is another "write" request behind it in the queue. +// The "xoff" request will be completed with the informational status +// STATUS_SERIAL_MORE_WRITES. The Information field of the +// IOSTATUS block will be set to 0. +// +// Note: By write request we mean another SERIAL_XOFF_COUNTER +// request, or a simple write request. If the only subsequent +// request is a flush request, the driver WILL NOT automatically +// complete the SERIAL_XOFF_COUNTER request. NOTE: Transmit +// immediate requests DO NOT count as a normal write, and therefore +// would not cause a counter request to complete. +// +// 2) The timer expires. The driver will complete the request +// with the informational status STATUS_SERIAL_COUNTER_TIMEOUT. +// The Information field of the IOSTATUS of the request will be set to 0. +// +// 3) The driver maintained counter goes to zero. (By implication, +// at least "Counter" number of characters have been received.) +// The request will be completed with a successful status +// of STATUS_SUCCESS. The Information field of the +// IOSTATUS of the request will be set to 0. +// +// 4) This is really a degenerate case of "1" above. The request +// is started and no request follow it on the queue. However +// at some point, before "2" or "3" above occur, another "write" +// request is started. This will cause the completion actions +// stated in "1" to occur. +// +// NOTE: This request being issued WILL NOT cause the normal flow +// control code of the driver to be invoked. +// +// NOTE: This request has no interaction with the IOCTL_SERIAL_WAIT_ON_MASK +// request. An application CAN NOT wait via the above ^^^^^^ ioctl +// on the counter going to zero. The application must synchronize +// with the particular IOCTL_SERIAL_XOFF_COUNTER request. +// +// NOTE: The Timeout value equal to zero would cause the counter +// to NEVER timeout. The only way that such a request could +// be killed at that point would be issue another write, or +// to purge the WRITE queue. +// + +typedef struct _SERIAL_XOFF_COUNTER { + ULONG Timeout; // Zero based. In milliseconds + LONG Counter; // Must be greater than zero. + UCHAR XoffChar; + } SERIAL_XOFF_COUNTER,*PSERIAL_XOFF_COUNTER; + +// +// The following structure (and defines) are passed back by +// the serial driver in response to the get properties ioctl. +// + +#define SERIAL_SP_SERIALCOMM ((ULONG)0x00000001) + +// +// Provider subtypes +// +#define SERIAL_SP_UNSPECIFIED ((ULONG)0x00000000) +#define SERIAL_SP_RS232 ((ULONG)0x00000001) +#define SERIAL_SP_PARALLEL ((ULONG)0x00000002) +#define SERIAL_SP_RS422 ((ULONG)0x00000003) +#define SERIAL_SP_RS423 ((ULONG)0x00000004) +#define SERIAL_SP_RS449 ((ULONG)0x00000005) +#define SERIAL_SP_MODEM ((ULONG)0X00000006) +#define SERIAL_SP_FAX ((ULONG)0x00000021) +#define SERIAL_SP_SCANNER ((ULONG)0x00000022) +#define SERIAL_SP_BRIDGE ((ULONG)0x00000100) +#define SERIAL_SP_LAT ((ULONG)0x00000101) +#define SERIAL_SP_TELNET ((ULONG)0x00000102) +#define SERIAL_SP_X25 ((ULONG)0x00000103) + +// +// Provider capabilities flags. +// + +#define SERIAL_PCF_DTRDSR ((ULONG)0x0001) +#define SERIAL_PCF_RTSCTS ((ULONG)0x0002) +#define SERIAL_PCF_CD ((ULONG)0x0004) +#define SERIAL_PCF_PARITY_CHECK ((ULONG)0x0008) +#define SERIAL_PCF_XONXOFF ((ULONG)0x0010) +#define SERIAL_PCF_SETXCHAR ((ULONG)0x0020) +#define SERIAL_PCF_TOTALTIMEOUTS ((ULONG)0x0040) +#define SERIAL_PCF_INTTIMEOUTS ((ULONG)0x0080) +#define SERIAL_PCF_SPECIALCHARS ((ULONG)0x0100) +#define SERIAL_PCF_16BITMODE ((ULONG)0x0200) + +// +// Comm provider settable parameters. +// + +#define SERIAL_SP_PARITY ((ULONG)0x0001) +#define SERIAL_SP_BAUD ((ULONG)0x0002) +#define SERIAL_SP_DATABITS ((ULONG)0x0004) +#define SERIAL_SP_STOPBITS ((ULONG)0x0008) +#define SERIAL_SP_HANDSHAKING ((ULONG)0x0010) +#define SERIAL_SP_PARITY_CHECK ((ULONG)0x0020) +#define SERIAL_SP_CARRIER_DETECT ((ULONG)0x0040) + +// +// Settable baud rates in the provider. +// + +#define SERIAL_BAUD_075 ((ULONG)0x00000001) +#define SERIAL_BAUD_110 ((ULONG)0x00000002) +#define SERIAL_BAUD_134_5 ((ULONG)0x00000004) +#define SERIAL_BAUD_150 ((ULONG)0x00000008) +#define SERIAL_BAUD_300 ((ULONG)0x00000010) +#define SERIAL_BAUD_600 ((ULONG)0x00000020) +#define SERIAL_BAUD_1200 ((ULONG)0x00000040) +#define SERIAL_BAUD_1800 ((ULONG)0x00000080) +#define SERIAL_BAUD_2400 ((ULONG)0x00000100) +#define SERIAL_BAUD_4800 ((ULONG)0x00000200) +#define SERIAL_BAUD_7200 ((ULONG)0x00000400) +#define SERIAL_BAUD_9600 ((ULONG)0x00000800) +#define SERIAL_BAUD_14400 ((ULONG)0x00001000) +#define SERIAL_BAUD_19200 ((ULONG)0x00002000) +#define SERIAL_BAUD_38400 ((ULONG)0x00004000) +#define SERIAL_BAUD_56K ((ULONG)0x00008000) +#define SERIAL_BAUD_128K ((ULONG)0x00010000) +#define SERIAL_BAUD_115200 ((ULONG)0x00020000) +#define SERIAL_BAUD_57600 ((ULONG)0x00040000) +#define SERIAL_BAUD_USER ((ULONG)0x10000000) + +// +// Settable Data Bits +// + +#define SERIAL_DATABITS_5 ((USHORT)0x0001) +#define SERIAL_DATABITS_6 ((USHORT)0x0002) +#define SERIAL_DATABITS_7 ((USHORT)0x0004) +#define SERIAL_DATABITS_8 ((USHORT)0x0008) +#define SERIAL_DATABITS_16 ((USHORT)0x0010) +#define SERIAL_DATABITS_16X ((USHORT)0x0020) + +// +// Settable Stop and Parity bits. +// + +#define SERIAL_STOPBITS_10 ((USHORT)0x0001) +#define SERIAL_STOPBITS_15 ((USHORT)0x0002) +#define SERIAL_STOPBITS_20 ((USHORT)0x0004) +#define SERIAL_PARITY_NONE ((USHORT)0x0100) +#define SERIAL_PARITY_ODD ((USHORT)0x0200) +#define SERIAL_PARITY_EVEN ((USHORT)0x0400) +#define SERIAL_PARITY_MARK ((USHORT)0x0800) +#define SERIAL_PARITY_SPACE ((USHORT)0x1000) + +typedef struct _SERIAL_COMMPROP { + USHORT PacketLength; + USHORT PacketVersion; + ULONG ServiceMask; + ULONG Reserved1; + ULONG MaxTxQueue; + ULONG MaxRxQueue; + ULONG MaxBaud; + ULONG ProvSubType; + ULONG ProvCapabilities; + ULONG SettableParams; + ULONG SettableBaud; + USHORT SettableData; + USHORT SettableStopParity; + ULONG CurrentTxQueue; + ULONG CurrentRxQueue; + ULONG ProvSpec1; + ULONG ProvSpec2; + WCHAR ProvChar[1]; +} SERIAL_COMMPROP,*PSERIAL_COMMPROP; + +// +// Define masks for the rs-232 input and output. +// + +#define SERIAL_DTR_STATE ((ULONG)0x00000001) +#define SERIAL_RTS_STATE ((ULONG)0x00000002) +#define SERIAL_CTS_STATE ((ULONG)0x00000010) +#define SERIAL_DSR_STATE ((ULONG)0x00000020) +#define SERIAL_RI_STATE ((ULONG)0x00000040) +#define SERIAL_DCD_STATE ((ULONG)0x00000080) + + +// begin_winioctl + +// +// The following values follow the escape designator in the +// data stream if the LSRMST_INSERT mode has been turned on. +// +#define SERIAL_LSRMST_ESCAPE ((UCHAR)0x00) + +// +// Following this value is the contents of the line status +// register, and then the character in the RX hardware when +// the line status register was encountered. +// +#define SERIAL_LSRMST_LSR_DATA ((UCHAR)0x01) + +// +// Following this value is the contents of the line status +// register. No error character follows +// +#define SERIAL_LSRMST_LSR_NODATA ((UCHAR)0x02) + +// +// Following this value is the contents of the modem status +// register. +// +#define SERIAL_LSRMST_MST ((UCHAR)0x03) + +// +// Bit values for FIFO Control Register +// + +#define SERIAL_IOC_FCR_FIFO_ENABLE ((ULONG)0x00000001) +#define SERIAL_IOC_FCR_RCVR_RESET ((ULONG)0x00000002) +#define SERIAL_IOC_FCR_XMIT_RESET ((ULONG)0x00000004) +#define SERIAL_IOC_FCR_DMA_MODE ((ULONG)0x00000008) +#define SERIAL_IOC_FCR_RES1 ((ULONG)0x00000010) +#define SERIAL_IOC_FCR_RES2 ((ULONG)0x00000020) +#define SERIAL_IOC_FCR_RCVR_TRIGGER_LSB ((ULONG)0x00000040) +#define SERIAL_IOC_FCR_RCVR_TRIGGER_MSB ((ULONG)0x00000080) + +// +// Bit values for Modem Control Register +// + +#define SERIAL_IOC_MCR_DTR ((ULONG)0x00000001) +#define SERIAL_IOC_MCR_RTS ((ULONG)0x00000002) +#define SERIAL_IOC_MCR_OUT1 ((ULONG)0x00000004) +#define SERIAL_IOC_MCR_OUT2 ((ULONG)0x00000008) +#define SERIAL_IOC_MCR_LOOP ((ULONG)0x00000010) + +// end_winioctl + +// +// Serenum internal ioctl's +// + +#undef PHYSICAL_ADDRESS +#define PHYSICAL_ADDRESS LARGE_INTEGER + +typedef struct _SERENUM_PORT_DESC +{ + IN ULONG Size; // sizeof (struct _PORT_DESC) + OUT PVOID PortHandle; + OUT PHYSICAL_ADDRESS PortAddress; + USHORT Reserved[1]; +} SERENUM_PORT_DESC, * PSERENUM_PORT_DESC; + +// ************************************************************************** +// Internal IOCTL interface for (pdo) +// The HID to legacy serial port minidriver uses this interface to +// find the address of the device. +// ************************************************************************** + +#define IOCTL_INTERNAL_SERENUM_REMOVE_SELF \ + CTL_CODE(FILE_DEVICE_SERENUM, 129, METHOD_NEITHER, FILE_ANY_ACCESS) + + +// of which IO_STACK_LOCATION->Parameters.Others.Argument1 is set to +// a pointer to struct _SERENUM_SER_PARAMETERS + +typedef +UCHAR +(*PSERENUM_READPORT) ( + _In_ PVOID SerPortAddress + ); + +typedef +VOID +(*PSERENUM_WRITEPORT) ( + _In_ PVOID SerPortAddress, + _In_ UCHAR Value + ); + +typedef enum _SERENUM_PORTION { + SerenumFirstHalf, + SerenumSecondHalf, + SerenumWhole +} SERENUM_PORTION; + +typedef struct _SERENUM_PORT_PARAMETERS +{ + IN ULONG Size; // sizeof (SERENUM_GET_PORT_PARAMETERS) + + OUT PSERENUM_READPORT ReadAccessor; // read the serial port + OUT PSERENUM_WRITEPORT WriteAccessor; // write the serial port + OUT PVOID SerPortAddress; // token to read this serial port + + OUT PVOID HardwareHandle; // a handle to this particular PDO. + OUT SERENUM_PORTION Portion; + OUT USHORT NumberAxis; // legacy joysticks only + USHORT Reserved [3]; +} SERENUM_PORT_PARAMETERS, *PSERENUM_PORT_PARAMETERS; + +#ifdef __cplusplus +} +#endif + + +#endif // _NTDDSER_ + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddstor.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddstor.h new file mode 100644 index 0000000000000000000000000000000000000000..183ef49c0c78dc85d7eec4e3f1515c0f7b15c216 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddstor.h @@ -0,0 +1,7412 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddstor.h + +Abstract: + + This is the include file that defines all common constants and types + accessing the storage class drivers + +--*/ + +#include + + + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifndef RtlCopyMemory +#define RtlCopyMemory(Destination,Source,Length) memcpy((Destination),(Source),(Length)) +#endif + +#ifndef RtlZeroMemory +#define RtlZeroMemory(Destination,Length) memset((Destination),0,(Length)) +#endif + +// +// Interface GUIDs +// +// need these GUIDs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the GUIDs +// +#ifdef DEFINE_GUID +// +// Make sure FAR is defined... +// +#ifndef FAR +#ifdef _WIN32 +#define FAR +#else +#define FAR _far +#endif +#endif + +// begin_wioctlguids + +DEFINE_GUID(GUID_DEVINTERFACE_DISK, 0x53f56307L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_CDROM, 0x53f56308L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_PARTITION, 0x53f5630aL, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_TAPE, 0x53f5630bL, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_WRITEONCEDISK, 0x53f5630cL, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_VOLUME, 0x53f5630dL, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_MEDIUMCHANGER, 0x53f56310L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_FLOPPY, 0x53f56311L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_CDCHANGER, 0x53f56312L, 0xb6bf, 0x11d0, 0x94, 0xf2, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_STORAGEPORT, 0x2accfe60L, 0xc130, 0x11d2, 0xb0, 0x82, 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b); +DEFINE_GUID(GUID_DEVINTERFACE_VMLUN, 0x6f416619L, 0x9f29, 0x42a5, 0xb2, 0x0b, 0x37, 0xe2, 0x19, 0xca, 0x02, 0xb0); +DEFINE_GUID(GUID_DEVINTERFACE_SES, 0x1790c9ecL, 0x47d5, 0x4df3, 0xb5, 0xaf, 0x9a, 0xdf, 0x3c, 0xf2, 0x3e, 0x48); +DEFINE_GUID(GUID_DEVINTERFACE_ZNSDISK, 0xb87941c5L, 0xffdb, 0x43c7, 0xb6, 0xb1, 0x20, 0xb6, 0x32, 0xf0, 0xb1, 0x09); + +#define WDI_STORAGE_PREDICT_FAILURE_DPS_GUID {0xe9f2d03aL, 0x747c, 0x41c2, {0xbb, 0x9a, 0x02, 0xc6, 0x2b, 0x6d, 0x5f, 0xcb}}; + +// +// Interfaces to discover devices that are +// not reported through conventional APIs +// + +DEFINE_GUID(GUID_DEVINTERFACE_HIDDEN_DISK, 0x7fccc86cL, 0x228a, 0x40ad, 0x8a, 0x58, 0xf5, 0x90, 0xaf, 0x7b, 0xfd, 0xce); +DEFINE_GUID(GUID_DEVINTERFACE_SERVICE_VOLUME, 0x6ead3d82L, 0x25ec, 0x46bc, 0xb7, 0xfd, 0xc1, 0xf0, 0xdf, 0x8f, 0x50, 0x37); +DEFINE_GUID(GUID_DEVINTERFACE_HIDDEN_VOLUME, 0x7f108a28L, 0x9833, 0x4b3b, 0xb7, 0x80, 0x2c, 0x6b, 0x5f, 0xa5, 0xc0, 0x62); + +// +// Interface to register for RPMB commands +// + +DEFINE_GUID(GUID_DEVINTERFACE_UNIFIED_ACCESS_RPMB, 0x27447c21L, 0xbcc3, 0x4d07, 0xa0, 0x5b, 0xa3, 0x39, 0x5b, 0xb4, 0xee, 0xe7); + +// end_wioctlguids + +// begin_wioctlobsoleteguids + +#define DiskClassGuid GUID_DEVINTERFACE_DISK +#define CdRomClassGuid GUID_DEVINTERFACE_CDROM +#define PartitionClassGuid GUID_DEVINTERFACE_PARTITION +#define TapeClassGuid GUID_DEVINTERFACE_TAPE +#define WriteOnceDiskClassGuid GUID_DEVINTERFACE_WRITEONCEDISK +#define VolumeClassGuid GUID_DEVINTERFACE_VOLUME +#define MediumChangerClassGuid GUID_DEVINTERFACE_MEDIUMCHANGER +#define FloppyClassGuid GUID_DEVINTERFACE_FLOPPY +#define CdChangerClassGuid GUID_DEVINTERFACE_CDCHANGER +#define StoragePortClassGuid GUID_DEVINTERFACE_STORAGEPORT + +#define HiddenVolumeClassGuid GUID_DEVINTERFACE_HIDDEN_VOLUME + +// end_wioctlobsoleteguids + +// begin_tcioctlguids + +// +// GUID, identifying crash dump section, containing device information or driver information. These GUIDs are used both to identify secondary dump section in the crashdump +// and in IOCTL to identify why section is requested by the user mode application +// + +// /* d8e2592f-1aab-4d56-a746-1f7585df40f4 */ +DEFINE_GUID(GUID_DEVICEDUMP_STORAGE_DEVICE, 0xd8e2592f,0x1aab,0x4d56,0xa7, 0x46, 0x1f, 0x75, 0x85, 0xdf, 0x40, 0xf4); + +// /* da82441d-7142-4bc1-b844-0807c5a4b67f */ +DEFINE_GUID(GUID_DEVICEDUMP_DRIVER_STORAGE_PORT, 0xda82441d,0x7142,0x4bc1,0xb8, 0x44, 0x08, 0x07, 0xc5, 0xa4, 0xb6, 0x7f); + +// end_tcioctlguids + +#endif + + +// +// Interface DEVPROPKEY +// +// need these DEVPROPKEYs outside conditional includes so that user can +// #include in precompiled header +// #include in a single source file +// #include in that source file a second time to instantiate the DEVPROPKEYs +// +#ifdef DEFINE_DEVPROPKEY + +// begin_wioctldevpropkeys + +// +// Properties associated with the volume interface. +// + +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Portable, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 2); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Removable_Media, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 3); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Storage_System_Critical, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 4); // DEVPROP_TYPE_BOOLEAN +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Disk_Number, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 5); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Partition_Number, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 6); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Mbr_Type, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 7); // DEVPROP_TYPE_BYTE +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Gpt_Type, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 8); // DEVPROP_TYPE_GUID +DEFINE_DEVPROPKEY(DEVPKEY_Storage_Gpt_Name, 0x4d1ebee8, 0x803, 0x4774, 0x98, 0x42, 0xb7, 0x7d, 0xb5, 0x2, 0x65, 0xe9, 9); // DEVPROP_TYPE_STRING +// end_wioctldevpropkeys + +#endif + +// begin_winioctl + +#ifndef _NTDDSTOR_H_ +#define _NTDDSTOR_H_ + +#if defined __cplusplus && !defined __ALT_GENERATOR__ +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +// +// IoControlCode values for storage devices +// + +#define IOCTL_STORAGE_BASE FILE_DEVICE_MASS_STORAGE + +// +// The following device control codes are common for all class drivers. They +// should be used in place of the older IOCTL_DISK, IOCTL_CDROM and IOCTL_TAPE +// common codes +// + +#define IOCTL_STORAGE_CHECK_VERIFY CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_CHECK_VERIFY2 CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_MEDIA_REMOVAL CTL_CODE(IOCTL_STORAGE_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_EJECT_MEDIA CTL_CODE(IOCTL_STORAGE_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_LOAD_MEDIA CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_LOAD_MEDIA2 CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_RESERVE CTL_CODE(IOCTL_STORAGE_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_RELEASE CTL_CODE(IOCTL_STORAGE_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_FIND_NEW_DEVICES CTL_CODE(IOCTL_STORAGE_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) + +// end_winioctl +#define IOCTL_STORAGE_MANAGE_BYPASS_IO CTL_CODE(IOCTL_STORAGE_BASE, 0x0230, METHOD_BUFFERED, FILE_ANY_ACCESS) +// begin_winioctl + +#define IOCTL_STORAGE_EJECTION_CONTROL CTL_CODE(IOCTL_STORAGE_BASE, 0x0250, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_MCN_CONTROL CTL_CODE(IOCTL_STORAGE_BASE, 0x0251, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_STORAGE_GET_MEDIA_TYPES CTL_CODE(IOCTL_STORAGE_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_GET_MEDIA_TYPES_EX CTL_CODE(IOCTL_STORAGE_BASE, 0x0301, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_GET_MEDIA_SERIAL_NUMBER CTL_CODE(IOCTL_STORAGE_BASE, 0x0304, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_GET_HOTPLUG_INFO CTL_CODE(IOCTL_STORAGE_BASE, 0x0305, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_SET_HOTPLUG_INFO CTL_CODE(IOCTL_STORAGE_BASE, 0x0306, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_GET_SYSTEM_FEATURE_SUPPORT CTL_CODE(IOCTL_STORAGE_BASE, 0x0307, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_STORAGE_RESET_BUS CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_RESET_DEVICE CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_BREAK_RESERVATION CTL_CODE(IOCTL_STORAGE_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_PERSISTENT_RESERVE_IN CTL_CODE(IOCTL_STORAGE_BASE, 0x0406, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_PERSISTENT_RESERVE_OUT CTL_CODE(IOCTL_STORAGE_BASE, 0x0407, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +// +// This IOCTL allows a custom request to be sent directly to a StorMQ miniport. Input and output buffer formats are established by the miniport writer. +// +#define IOCTL_STORAGE_MINIPORT_PASSTHROUGH_REQUEST CTL_CODE(IOCTL_STORAGE_BASE, 0x0414, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_STORAGE_GET_DEVICE_NUMBER CTL_CODE(IOCTL_STORAGE_BASE, 0x0420, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// This IOCTL includes the same information as IOCTL_STORAGE_GET_DEVICE_NUMBER, plus the device GUID. +// +#define IOCTL_STORAGE_GET_DEVICE_NUMBER_EX CTL_CODE(IOCTL_STORAGE_BASE, 0x0421, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +#define IOCTL_STORAGE_PREDICT_FAILURE CTL_CODE(IOCTL_STORAGE_BASE, 0x0440, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_FAILURE_PREDICTION_CONFIG CTL_CODE(IOCTL_STORAGE_BASE, 0x0441, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// This IOCTL retrieves reliability counters for a device. +// +#define IOCTL_STORAGE_GET_COUNTERS CTL_CODE(IOCTL_STORAGE_BASE, 0x442, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_STORAGE_READ_CAPACITY CTL_CODE(IOCTL_STORAGE_BASE, 0x0450, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// IOCTLs 0x0463 to 0x0468 reserved for dependent disk support. +// + + +// +// IOCTLs 0x0470 to 0x047f reserved for device and stack telemetry interfaces +// + +#define IOCTL_STORAGE_GET_DEVICE_TELEMETRY CTL_CODE(IOCTL_STORAGE_BASE, 0x0470, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_DEVICE_TELEMETRY_NOTIFY CTL_CODE(IOCTL_STORAGE_BASE, 0x0471, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_DEVICE_TELEMETRY_QUERY_CAPS CTL_CODE(IOCTL_STORAGE_BASE, 0x0472, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_GET_DEVICE_TELEMETRY_RAW CTL_CODE(IOCTL_STORAGE_BASE, 0x0473, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +#define IOCTL_STORAGE_SET_TEMPERATURE_THRESHOLD CTL_CODE(IOCTL_STORAGE_BASE, 0x0480, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_STORAGE_PROTOCOL_COMMAND CTL_CODE(IOCTL_STORAGE_BASE, 0x04F0, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +#define IOCTL_STORAGE_SET_PROPERTY CTL_CODE(IOCTL_STORAGE_BASE, 0x04FF, METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_QUERY_PROPERTY CTL_CODE(IOCTL_STORAGE_BASE, 0x0500, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_MANAGE_DATA_SET_ATTRIBUTES CTL_CODE(IOCTL_STORAGE_BASE, 0x0501, METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_GET_LB_PROVISIONING_MAP_RESOURCES CTL_CODE(IOCTL_STORAGE_BASE, 0x0502, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// IOCTLs 0x0503 to 0x0580 reserved for Enhanced Storage devices. +// + +// +// This IOCTL offloads the erasure process to the storage device. There is no guarantee as to the successful +// deletion or recoverability of the data on the storage device after command completion. This IOCTL is limited +// to data disks in regular Windows. In WinPE, this IOCTL is supported for both boot and data disks. +// +// This IOCTL has an optional input and returns no output other than status. Callers should first call +// FSCTL_LOCK_VOLUME before calling this ioctl to flush out cached data in upper layers. No waiting of outstanding +// request completion is done before issuing the command to the device. +// +#define IOCTL_STORAGE_REINITIALIZE_MEDIA CTL_CODE(IOCTL_STORAGE_BASE, 0x0590, METHOD_BUFFERED, FILE_WRITE_ACCESS) + + +// +// IOCTLs for bandwidth contracts on storage devices +// (Move this to ntddsfio if we decide to use a new base) +// + +#define IOCTL_STORAGE_GET_BC_PROPERTIES CTL_CODE(IOCTL_STORAGE_BASE, 0x0600, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_STORAGE_ALLOCATE_BC_STREAM CTL_CODE(IOCTL_STORAGE_BASE, 0x0601, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_FREE_BC_STREAM CTL_CODE(IOCTL_STORAGE_BASE, 0x0602, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL to check for priority support +// +#define IOCTL_STORAGE_CHECK_PRIORITY_HINT_SUPPORT CTL_CODE(IOCTL_STORAGE_BASE, 0x0620, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL for data integrity check support +// + +#define IOCTL_STORAGE_START_DATA_INTEGRITY_CHECK CTL_CODE(IOCTL_STORAGE_BASE, 0x0621, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_STOP_DATA_INTEGRITY_CHECK CTL_CODE(IOCTL_STORAGE_BASE, 0x0622, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// These ioctl codes are obsolete. They are defined here to avoid resuing them +// and to allow class drivers to respond to them more easily. +// + +#define OBSOLETE_IOCTL_STORAGE_RESET_BUS CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define OBSOLETE_IOCTL_STORAGE_RESET_DEVICE CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTLs 0x0643 to 0x0655 reserved for VHD disk support. +// + + +// +// IOCTLs for firmware upgrade on storage devices +// + +#define IOCTL_STORAGE_FIRMWARE_GET_INFO CTL_CODE(IOCTL_STORAGE_BASE, 0x0700, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_FIRMWARE_DOWNLOAD CTL_CODE(IOCTL_STORAGE_BASE, 0x0701, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_STORAGE_FIRMWARE_ACTIVATE CTL_CODE(IOCTL_STORAGE_BASE, 0x0702, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + + +// +// IOCTL to support Idle Power Management, including Device Wake +// +#define IOCTL_STORAGE_ENABLE_IDLE_POWER CTL_CODE(IOCTL_STORAGE_BASE, 0x0720, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_GET_IDLE_POWERUP_REASON CTL_CODE(IOCTL_STORAGE_BASE, 0x0721, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTLs to allow class drivers to acquire and release active references on +// a unit. These should only be used if the class driver previously sent a +// successful IOCTL_STORAGE_ENABLE_IDLE_POWER request to the port driver. +// +#define IOCTL_STORAGE_POWER_ACTIVE CTL_CODE(IOCTL_STORAGE_BASE, 0x0722, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_STORAGE_POWER_IDLE CTL_CODE(IOCTL_STORAGE_BASE, 0x0723, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// This IOCTL indicates that the physical device has triggered some sort of event. +// +#define IOCTL_STORAGE_EVENT_NOTIFICATION CTL_CODE(IOCTL_STORAGE_BASE, 0x0724, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL to specify a power cap for a storage device. +// +#define IOCTL_STORAGE_DEVICE_POWER_CAP CTL_CODE(IOCTL_STORAGE_BASE, 0x0725, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL to send commands to the RPMB for a storage device. +// +#define IOCTL_STORAGE_RPMB_COMMAND CTL_CODE(IOCTL_STORAGE_BASE, 0x0726, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL to manage attributes for storage devices +// +#define IOCTL_STORAGE_ATTRIBUTE_MANAGEMENT CTL_CODE(IOCTL_STORAGE_BASE, 0x0727, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_STORAGE_DIAGNOSTIC IOCTL to query diagnostic data from the storage driver stack +// +#define IOCTL_STORAGE_DIAGNOSTIC CTL_CODE(IOCTL_STORAGE_BASE, 0x0728, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTLs for storage device depopulation support. +// + +// +// IOCTL_STORAGE_GET_PHYSICAL_ELEMENT_STATUS IOCTL to query physical element status from device. +// +#define IOCTL_STORAGE_GET_PHYSICAL_ELEMENT_STATUS CTL_CODE(IOCTL_STORAGE_BASE, 0x0729, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_STORAGE_REMOVE_ELEMENT_AND_TRUNCATE IOCTL to remove and truncate element from device. +// +#define IOCTL_STORAGE_REMOVE_ELEMENT_AND_TRUNCATE CTL_CODE(IOCTL_STORAGE_BASE, 0x0730, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_STORAGE_GET_DEVICE_INTERNAL_LOG IOCTL to get device internal status data. +// +#define IOCTL_STORAGE_GET_DEVICE_INTERNAL_LOG CTL_CODE(IOCTL_STORAGE_BASE, 0x0731, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +// +// Note: Function code values of less than 0x800 are reserved for Microsoft. Values of 0x800 and higher can be used by vendors. +// So do not use function code of 0x800 and higher to define new IOCTLs in this file. +// + + +// +// IOCTL_STORAGE_GET_HOTPLUG_INFO +// + +typedef struct _STORAGE_HOTPLUG_INFO { + ULONG Size; // version + BOOLEAN MediaRemovable; // ie. zip, jaz, cdrom, mo, etc. vs hdd + BOOLEAN MediaHotplug; // ie. does the device succeed a lock even though its not lockable media? + BOOLEAN DeviceHotplug; // ie. 1394, USB, etc. + BOOLEAN WriteCacheEnableOverride; // This field should not be relied upon because it is no longer used +} STORAGE_HOTPLUG_INFO, *PSTORAGE_HOTPLUG_INFO; + +// +// IOCTL_STORAGE_GET_SYSTEM_FEATURE_SUPPORT +// +// This IOCTL can be sent to any disk or adapter device but the query itself returns system-wide +// feature support as offered by the currently-installed version of the storage stack. +// + +#define STORAGE_FEATURE_SUPPORT_V1 0x1 + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct + +typedef struct _STORAGE_FEATURE_SUPPORT { + // + // Size of this structure + // + ULONG Size; + + // + // Version of this structure + // + ULONG Version; + + union { + + struct { + + // + // If set to '1', indicates that support for StorMQ miniports is present + // + ULONGLONG StorMQMiniportsSupported : 1; + + // + // Reserved for future use. Must be set to zero. + // + ULONGLONG Reserved : 63; + + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + + } Flags; + + ULONGLONG Reserved[6]; + +} STORAGE_FEATURE_SUPPORT, *PSTORAGE_FEATURE_SUPPORT; + +#pragma warning(pop) + +// +// IOCTL_STORAGE_GET_DEVICE_NUMBER +// +// input - none +// +// output - STORAGE_DEVICE_NUMBER structure +// The values in the STORAGE_DEVICE_NUMBER structure are guaranteed +// to remain unchanged until the system is rebooted. They are not +// guaranteed to be persistant across boots. +// + +typedef struct _STORAGE_DEVICE_NUMBER { + + // + // The FILE_DEVICE_XXX type for this device. + // + + DEVICE_TYPE DeviceType; + + // + // The number of this device + // + + ULONG DeviceNumber; + + // + // If the device is partitionable, the partition number of the device. + // Otherwise -1 + // + + ULONG PartitionNumber; +} STORAGE_DEVICE_NUMBER, *PSTORAGE_DEVICE_NUMBER; + +typedef struct _STORAGE_DEVICE_NUMBERS { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure + // + + ULONG Size; + + ULONG NumberOfDevices; + + STORAGE_DEVICE_NUMBER Devices[ANYSIZE_ARRAY]; + +} STORAGE_DEVICE_NUMBERS, *PSTORAGE_DEVICE_NUMBERS; + +// +// IOCTL_STORAGE_GET_DEVICE_NUMBER_EX +// +// input - none +// +// output - STORAGE_DEVICE_NUMBER_EX structure +// + +// +// Possible flags that can be set in Flags field of +// STORAGE_DEVICE_NUMBER_EX structure defined below +// + +// +// This flag indicates that deviceguid is randomly created because a deviceguid conflict was observed +// +#define STORAGE_DEVICE_FLAGS_RANDOM_DEVICEGUID_REASON_CONFLICT 0x1 + +// +// This flag indicates that deviceguid is randomly created because the HW ID was not available +// +#define STORAGE_DEVICE_FLAGS_RANDOM_DEVICEGUID_REASON_NOHWID 0x2 + +// +// This flag indicates that deviceguid is created from the scsi page83 data. +// If this flag is not set this implies it's created from serial number or is randomly generated. +// +#define STORAGE_DEVICE_FLAGS_PAGE_83_DEVICEGUID 0x4 + +typedef struct _STORAGE_DEVICE_NUMBER_EX { + + // + // Sizeof(STORAGE_DEVICE_NUMBER_EX). + // + + ULONG Version; + + // + // Total size of the structure, including any additional data. Currently + // this will always be the same as sizeof(STORAGE_DEVICE_NUMBER_EX). + // + + ULONG Size; + + // + // Flags - this shall be a combination of STORAGE_DEVICE_FLAGS_XXX flags + // that gives more information about the members of this structure. + // + + ULONG Flags; + + // + // The FILE_DEVICE_XXX type for this device. This IOCTL is only + // supported for disk devices. + // + + DEVICE_TYPE DeviceType; + + // + // The number of this device. + // + + ULONG DeviceNumber; + + // + // A globally-unique identification number for this device. + // A GUID of {0} indicates that a GUID could not be generated. The GUID + // is based on hardware information that doesn't change with firmware updates + // (for instance, serial number can be used to form the GUID, but not the firmware + // revision). The device GUID remains the same across reboots. + // + // In general, if a device exposes a globally unique identifier, the storage driver + // will use that identifier to form the GUID. Otherwise, the storage driver will combine + // the device's vendor ID, product ID and serial number to create the GUID. + // + // If a storage driver detects two devices with the same hardware information (which is + // an indication of a problem with the device), the driver will generate a random GUID for + // one of the two devices. When handling IOCTL_STORAGE_GET_DEVICE_NUMBER_EX for the device + // with the random GUID, the driver will add STORAGE_DEVICE_FLAGS_RANDOM_DEVICEGUID_REASON_CONFLICT + // to the Flags member of this structure. + // + // If a storage device does not provide any identifying information, the driver will generate a random + // GUID and add STORAGE_DEVICE_FLAGS_RANDOM_DEVICEGUID_REASON_NOHWID to the Flags member of this structure. + // + // A random GUID is not persisted and will not be the same after a reboot. + // + + GUID DeviceGuid; + + // + // If the device is partitionable, the partition number of the device. + // Otherwise -1. + // + + ULONG PartitionNumber; +} STORAGE_DEVICE_NUMBER_EX, *PSTORAGE_DEVICE_NUMBER_EX; + + +// +// Define the structures for scsi resets +// + +typedef struct _STORAGE_BUS_RESET_REQUEST { + UCHAR PathId; +} STORAGE_BUS_RESET_REQUEST, *PSTORAGE_BUS_RESET_REQUEST; + + +// +// Break reservation is sent to the Adapter/FDO with the given lun information. +// + +typedef struct STORAGE_BREAK_RESERVATION_REQUEST { + ULONG Length; + UCHAR _unused; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; +} STORAGE_BREAK_RESERVATION_REQUEST, *PSTORAGE_BREAK_RESERVATION_REQUEST; + + +// +// IOCTL_STORAGE_MEDIA_REMOVAL disables the mechanism +// on a storage device that ejects media. This function +// may or may not be supported on storage devices that +// support removable media. +// +// TRUE means prevent media from being removed. +// FALSE means allow media removal. +// + +typedef struct _PREVENT_MEDIA_REMOVAL { + BOOLEAN PreventMediaRemoval; +} PREVENT_MEDIA_REMOVAL, *PPREVENT_MEDIA_REMOVAL; + + + +// +// This is the format of TARGET_DEVICE_CUSTOM_NOTIFICATION.CustomDataBuffer +// passed to applications by the classpnp autorun code (via IoReportTargetDeviceChangeAsynchronous). +// +typedef struct _CLASS_MEDIA_CHANGE_CONTEXT { + ULONG MediaChangeCount; + ULONG NewState; // see MEDIA_CHANGE_DETECTION_STATE enum in classpnp.h in DDK +} CLASS_MEDIA_CHANGE_CONTEXT, *PCLASS_MEDIA_CHANGE_CONTEXT; + + +// begin_ntminitape + +typedef struct _TAPE_STATISTICS { + ULONG Version; + ULONG Flags; + LARGE_INTEGER RecoveredWrites; + LARGE_INTEGER UnrecoveredWrites; + LARGE_INTEGER RecoveredReads; + LARGE_INTEGER UnrecoveredReads; + UCHAR CompressionRatioReads; + UCHAR CompressionRatioWrites; +} TAPE_STATISTICS, *PTAPE_STATISTICS; + +#define RECOVERED_WRITES_VALID 0x00000001 +#define UNRECOVERED_WRITES_VALID 0x00000002 +#define RECOVERED_READS_VALID 0x00000004 +#define UNRECOVERED_READS_VALID 0x00000008 +#define WRITE_COMPRESSION_INFO_VALID 0x00000010 +#define READ_COMPRESSION_INFO_VALID 0x00000020 + +typedef struct _TAPE_GET_STATISTICS { + ULONG Operation; +} TAPE_GET_STATISTICS, *PTAPE_GET_STATISTICS; + +#define TAPE_RETURN_STATISTICS 0L +#define TAPE_RETURN_ENV_INFO 1L +#define TAPE_RESET_STATISTICS 2L + +// +// IOCTL_STORAGE_GET_MEDIA_TYPES_EX will return an array of DEVICE_MEDIA_INFO +// structures, one per supported type, embedded in the GET_MEDIA_TYPES struct. +// + +typedef enum _STORAGE_MEDIA_TYPE { + // + // Following are defined in ntdddisk.h in the MEDIA_TYPE enum + // + // Unknown, // Format is unknown + // F5_1Pt2_512, // 5.25", 1.2MB, 512 bytes/sector + // F3_1Pt44_512, // 3.5", 1.44MB, 512 bytes/sector + // F3_2Pt88_512, // 3.5", 2.88MB, 512 bytes/sector + // F3_20Pt8_512, // 3.5", 20.8MB, 512 bytes/sector + // F3_720_512, // 3.5", 720KB, 512 bytes/sector + // F5_360_512, // 5.25", 360KB, 512 bytes/sector + // F5_320_512, // 5.25", 320KB, 512 bytes/sector + // F5_320_1024, // 5.25", 320KB, 1024 bytes/sector + // F5_180_512, // 5.25", 180KB, 512 bytes/sector + // F5_160_512, // 5.25", 160KB, 512 bytes/sector + // RemovableMedia, // Removable media other than floppy + // FixedMedia, // Fixed hard disk media + // F3_120M_512, // 3.5", 120M Floppy + // F3_640_512, // 3.5" , 640KB, 512 bytes/sector + // F5_640_512, // 5.25", 640KB, 512 bytes/sector + // F5_720_512, // 5.25", 720KB, 512 bytes/sector + // F3_1Pt2_512, // 3.5" , 1.2Mb, 512 bytes/sector + // F3_1Pt23_1024, // 3.5" , 1.23Mb, 1024 bytes/sector + // F5_1Pt23_1024, // 5.25", 1.23MB, 1024 bytes/sector + // F3_128Mb_512, // 3.5" MO 128Mb 512 bytes/sector + // F3_230Mb_512, // 3.5" MO 230Mb 512 bytes/sector + // F8_256_128, // 8", 256KB, 128 bytes/sector + // F3_200Mb_512, // 3.5", 200M Floppy (HiFD) + // + + DDS_4mm = 0x20, // Tape - DAT DDS1,2,... (all vendors) + MiniQic, // Tape - miniQIC Tape + Travan, // Tape - Travan TR-1,2,3,... + QIC, // Tape - QIC + MP_8mm, // Tape - 8mm Exabyte Metal Particle + AME_8mm, // Tape - 8mm Exabyte Advanced Metal Evap + AIT1_8mm, // Tape - 8mm Sony AIT + DLT, // Tape - DLT Compact IIIxt, IV + NCTP, // Tape - Philips NCTP + IBM_3480, // Tape - IBM 3480 + IBM_3490E, // Tape - IBM 3490E + IBM_Magstar_3590, // Tape - IBM Magstar 3590 + IBM_Magstar_MP, // Tape - IBM Magstar MP + STK_DATA_D3, // Tape - STK Data D3 + SONY_DTF, // Tape - Sony DTF + DV_6mm, // Tape - 6mm Digital Video + DMI, // Tape - Exabyte DMI and compatibles + SONY_D2, // Tape - Sony D2S and D2L + CLEANER_CARTRIDGE, // Cleaner - All Drive types that support Drive Cleaners + CD_ROM, // Opt_Disk - CD + CD_R, // Opt_Disk - CD-Recordable (Write Once) + CD_RW, // Opt_Disk - CD-Rewriteable + DVD_ROM, // Opt_Disk - DVD-ROM + DVD_R, // Opt_Disk - DVD-Recordable (Write Once) + DVD_RW, // Opt_Disk - DVD-Rewriteable + MO_3_RW, // Opt_Disk - 3.5" Rewriteable MO Disk + MO_5_WO, // Opt_Disk - MO 5.25" Write Once + MO_5_RW, // Opt_Disk - MO 5.25" Rewriteable (not LIMDOW) + MO_5_LIMDOW, // Opt_Disk - MO 5.25" Rewriteable (LIMDOW) + PC_5_WO, // Opt_Disk - Phase Change 5.25" Write Once Optical + PC_5_RW, // Opt_Disk - Phase Change 5.25" Rewriteable + PD_5_RW, // Opt_Disk - PhaseChange Dual Rewriteable + ABL_5_WO, // Opt_Disk - Ablative 5.25" Write Once Optical + PINNACLE_APEX_5_RW, // Opt_Disk - Pinnacle Apex 4.6GB Rewriteable Optical + SONY_12_WO, // Opt_Disk - Sony 12" Write Once + PHILIPS_12_WO, // Opt_Disk - Philips/LMS 12" Write Once + HITACHI_12_WO, // Opt_Disk - Hitachi 12" Write Once + CYGNET_12_WO, // Opt_Disk - Cygnet/ATG 12" Write Once + KODAK_14_WO, // Opt_Disk - Kodak 14" Write Once + MO_NFR_525, // Opt_Disk - Near Field Recording (Terastor) + NIKON_12_RW, // Opt_Disk - Nikon 12" Rewriteable + IOMEGA_ZIP, // Mag_Disk - Iomega Zip + IOMEGA_JAZ, // Mag_Disk - Iomega Jaz + SYQUEST_EZ135, // Mag_Disk - Syquest EZ135 + SYQUEST_EZFLYER, // Mag_Disk - Syquest EzFlyer + SYQUEST_SYJET, // Mag_Disk - Syquest SyJet + AVATAR_F2, // Mag_Disk - 2.5" Floppy + MP2_8mm, // Tape - 8mm Hitachi + DST_S, // Ampex DST Small Tapes + DST_M, // Ampex DST Medium Tapes + DST_L, // Ampex DST Large Tapes + VXATape_1, // Ecrix 8mm Tape + VXATape_2, // Ecrix 8mm Tape +#if (NTDDI_VERSION < NTDDI_WINXP) + STK_EAGLE, // STK Eagle +#else + STK_9840, // STK 9840 +#endif + LTO_Ultrium, // IBM, HP, Seagate LTO Ultrium + LTO_Accelis, // IBM, HP, Seagate LTO Accelis + DVD_RAM, // Opt_Disk - DVD-RAM + AIT_8mm, // AIT2 or higher + ADR_1, // OnStream ADR Mediatypes + ADR_2, + STK_9940, // STK 9940 + SAIT, // SAIT Tapes + VXATape // VXA (Ecrix 8mm) Tape +}STORAGE_MEDIA_TYPE, *PSTORAGE_MEDIA_TYPE; + +#define MEDIA_ERASEABLE 0x00000001 +#define MEDIA_WRITE_ONCE 0x00000002 +#define MEDIA_READ_ONLY 0x00000004 +#define MEDIA_READ_WRITE 0x00000008 + +#define MEDIA_WRITE_PROTECTED 0x00000100 +#define MEDIA_CURRENTLY_MOUNTED 0x80000000 + +// +// Define the different storage bus types +// Bus types below 128 (0x80) are reserved for Microsoft use +// + +typedef enum _STORAGE_BUS_TYPE { + BusTypeUnknown = 0x00, + BusTypeScsi, + BusTypeAtapi, + BusTypeAta, + BusType1394, + BusTypeSsa, + BusTypeFibre, + BusTypeUsb, + BusTypeRAID, + BusTypeiScsi, + BusTypeSas, + BusTypeSata, + BusTypeSd, + BusTypeMmc, + BusTypeVirtual, + BusTypeFileBackedVirtual, + BusTypeSpaces, + BusTypeNvme, + BusTypeSCM, + BusTypeUfs, + BusTypeNvmeof, + BusTypeMax, + BusTypeMaxReserved = 0x7F +} STORAGE_BUS_TYPE, *PSTORAGE_BUS_TYPE; + +// +// Macro to identify which bus types +// support shared storage +// + +#define SupportsDeviceSharing( BusType ) ( \ + (BusType == BusTypeScsi) || \ + (BusType == BusTypeFibre) || \ + (BusType == BusTypeiScsi) || \ + (BusType == BusTypeSas) || \ + (BusType == BusTypeSpaces) ) + +typedef struct _DEVICE_MEDIA_INFO { + union { + struct { + LARGE_INTEGER Cylinders; + STORAGE_MEDIA_TYPE MediaType; + ULONG TracksPerCylinder; + ULONG SectorsPerTrack; + ULONG BytesPerSector; + ULONG NumberMediaSides; + ULONG MediaCharacteristics; // Bitmask of MEDIA_XXX values. + } DiskInfo; + + struct { + LARGE_INTEGER Cylinders; + STORAGE_MEDIA_TYPE MediaType; + ULONG TracksPerCylinder; + ULONG SectorsPerTrack; + ULONG BytesPerSector; + ULONG NumberMediaSides; + ULONG MediaCharacteristics; // Bitmask of MEDIA_XXX values. + } RemovableDiskInfo; + + struct { + STORAGE_MEDIA_TYPE MediaType; + ULONG MediaCharacteristics; // Bitmask of MEDIA_XXX values. + ULONG CurrentBlockSize; + STORAGE_BUS_TYPE BusType; + + // + // Bus specific information describing the medium supported. + // + + union { + struct { + UCHAR MediumType; + UCHAR DensityCode; + } ScsiInformation; + } BusSpecificData; + + } TapeInfo; + } DeviceSpecific; +} DEVICE_MEDIA_INFO, *PDEVICE_MEDIA_INFO; + +typedef struct _GET_MEDIA_TYPES { + ULONG DeviceType; // FILE_DEVICE_XXX values + ULONG MediaInfoCount; + DEVICE_MEDIA_INFO MediaInfo[1]; +} GET_MEDIA_TYPES, *PGET_MEDIA_TYPES; + + +// +// IOCTL_STORAGE_PREDICT_FAILURE +// +// input - none +// +// output - STORAGE_PREDICT_FAILURE structure +// PredictFailure returns zero if no failure predicted and non zero +// if a failure is predicted. +// +// VendorSpecific returns 512 bytes of vendor specific information +// if a failure is predicted +// +typedef struct _STORAGE_PREDICT_FAILURE +{ + ULONG PredictFailure; + UCHAR VendorSpecific[512]; +} STORAGE_PREDICT_FAILURE, *PSTORAGE_PREDICT_FAILURE; + + +// +// IOCTL_STORAGE_FAILURE_PREDICTION_CONFIG +// +// Input - STORAGE_FAILURE_PREDICTION_CONFIG structure. +// If the sender wants to enable or disable failure prediction then +// the sender should set the "Set" field to TRUE. +// Output - STORAGE_FAILURE_PREDICTION_CONFIG structure. +// If successful, the "Enabled" field will indicate if failure +// prediction is currently enabled or not. +// +typedef struct _STORAGE_FAILURE_PREDICTION_CONFIG { + ULONG Version; // Set to 1 for Blue. + ULONG Size; + BOOLEAN Set; // TRUE if the sender wants to enable/disable failure prediction. + BOOLEAN Enabled; + USHORT Reserved; +} STORAGE_FAILURE_PREDICTION_CONFIG, *PSTORAGE_FAILURE_PREDICTION_CONFIG; + +#define STORAGE_FAILURE_PREDICTION_CONFIG_V1 1 + +// end_ntminitape + + + +// +// Property Query Structures +// + +// +// IOCTL_STORAGE_QUERY_PROPERTY +// +// Input Buffer: +// a STORAGE_PROPERTY_QUERY structure which describes what type of query +// is being done, what property is being queried for, and any additional +// parameters which a particular property query requires. +// +// Output Buffer: +// Contains a buffer to place the results of the query into. Since all +// property descriptors can be cast into a STORAGE_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of queries +// + +typedef enum _STORAGE_QUERY_TYPE { + PropertyStandardQuery = 0, // Retrieves the descriptor + PropertyExistsQuery, // Used to test whether the descriptor is supported + PropertyMaskQuery, // Used to retrieve a mask of writeable fields in the descriptor + PropertyQueryMaxDefined // use to validate the value +} STORAGE_QUERY_TYPE, *PSTORAGE_QUERY_TYPE; + +// +// IOCTL_STORAGE_SET_PROPERTY +// +// Input Buffer: +// a STORAGE_PROPERTY_SET structure which describes what type of property set +// is being done, what property is being set, and any additional +// parameters which a particular property set requires. +// +// Output Buffer: +// Contains a buffer to place the results of the query into. Since all +// property descriptors can be cast into a STORAGE_DESCRIPTOR_HEADER, +// the IOCTL can be called once with a small buffer then again using +// a buffer as large as the header reports is necessary. +// + + +// +// Types of set operation +// + +typedef enum _STORAGE_SET_TYPE { + PropertyStandardSet = 0, // Sets the descriptor + PropertyExistsSet, // Used to test whether the descriptor is supported + PropertySetMaxDefined // use to validate the value +} STORAGE_SET_TYPE, *PSTORAGE_SET_TYPE; + +// +// define some initial property id's +// + +typedef enum _STORAGE_PROPERTY_ID { + StorageDeviceProperty = 0, + StorageAdapterProperty, + StorageDeviceIdProperty, + StorageDeviceUniqueIdProperty, // See storduid.h for details + StorageDeviceWriteCacheProperty, + StorageMiniportProperty, + StorageAccessAlignmentProperty, + StorageDeviceSeekPenaltyProperty, + StorageDeviceTrimProperty, + StorageDeviceWriteAggregationProperty, + StorageDeviceDeviceTelemetryProperty, + StorageDeviceLBProvisioningProperty, + StorageDevicePowerProperty, + StorageDeviceCopyOffloadProperty, + StorageDeviceResiliencyProperty, + StorageDeviceMediumProductType, + StorageAdapterRpmbProperty, + StorageAdapterCryptoProperty, // Deprecated for GE or greater OS. Use StorageHwCryptoProperty. +// end_winioctl + StorageDeviceTieringProperty, + StorageDeviceFaultDomainProperty, + StorageDeviceClusportProperty, + StorageDeviceDependantDevicesProperty, +// begin_winioctl + StorageDeviceIoCapabilityProperty = 48, + StorageAdapterProtocolSpecificProperty, + StorageDeviceProtocolSpecificProperty, + StorageAdapterTemperatureProperty, + StorageDeviceTemperatureProperty, + StorageAdapterPhysicalTopologyProperty, + StorageDevicePhysicalTopologyProperty, + StorageDeviceAttributesProperty, + StorageDeviceManagementStatus, + StorageAdapterSerialNumberProperty, + StorageDeviceLocationProperty, + StorageDeviceNumaProperty, + StorageDeviceZonedDeviceProperty, + StorageDeviceUnsafeShutdownCount, + StorageDeviceEnduranceProperty, + StorageDeviceLedStateProperty, + StorageDeviceSelfEncryptionProperty = 64, + StorageFruIdProperty, + StorageStackProperty, + StorageAdapterProtocolSpecificPropertyEx, + StorageDeviceProtocolSpecificPropertyEx, + StorageHwCryptoProperty +} STORAGE_PROPERTY_ID, *PSTORAGE_PROPERTY_ID; + + +// +// Query structure - additional parameters for specific queries can follow +// the header +// + +typedef struct _STORAGE_PROPERTY_QUERY { + + // + // ID of the property being retrieved + // + + STORAGE_PROPERTY_ID PropertyId; + + // + // Flags indicating the type of query being performed + // + + STORAGE_QUERY_TYPE QueryType; + + // + // Space for additional parameters if necessary + // + + UCHAR AdditionalParameters[1]; + +} STORAGE_PROPERTY_QUERY, *PSTORAGE_PROPERTY_QUERY; + +// +// Set structure - additional parameters for specific set property that can follow +// the header +// + +typedef struct _STORAGE_PROPERTY_SET { + + // + // ID of the property being retrieved + // + + STORAGE_PROPERTY_ID PropertyId; + + // + // Flags indicating the type of set property being performed + // + + STORAGE_SET_TYPE SetType; + + // + // Space for additional parameters if necessary + // + + UCHAR AdditionalParameters[1]; + +} STORAGE_PROPERTY_SET, *PSTORAGE_PROPERTY_SET; + +// +// Standard property descriptor header. All property pages should use this +// as their first element or should contain these two elements +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DESCRIPTOR_HEADER { + + ULONG Version; + + ULONG Size; + +} STORAGE_DESCRIPTOR_HEADER, *PSTORAGE_DESCRIPTOR_HEADER; + +// +// Device property descriptor - this is really just a rehash of the inquiry +// data retrieved from a scsi device +// +// This may only be retrieved from a target device. Sending this to the bus +// will result in an error +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_DESCRIPTOR { + + // + // Sizeof(STORAGE_DEVICE_DESCRIPTOR) + // + + ULONG Version; + + // + // Total size of the descriptor, including the space for additional + // data and id strings + // + + ULONG Size; + + // + // The SCSI-2 device type + // + + UCHAR DeviceType; + + // + // The SCSI-2 device type modifier (if any) - this may be zero + // + + UCHAR DeviceTypeModifier; + + // + // Flag indicating whether the device's media (if any) is removable. This + // field should be ignored for media-less devices + // + + BOOLEAN RemovableMedia; + + // + // Flag indicating whether the device can support mulitple outstanding + // commands. The actual synchronization in this case is the responsibility + // of the port driver. + // + + BOOLEAN CommandQueueing; + + // + // Byte offset to the zero-terminated ascii string containing the device's + // vendor id string. For devices with no such ID this will be zero + // + + ULONG VendorIdOffset; + + // + // Byte offset to the zero-terminated ascii string containing the device's + // product id string. For devices with no such ID this will be zero + // + + ULONG ProductIdOffset; + + // + // Byte offset to the zero-terminated ascii string containing the device's + // product revision string. For devices with no such string this will be + // zero + // + + ULONG ProductRevisionOffset; + + // + // Byte offset to the zero-terminated ascii string containing the device's + // serial number. For devices with no serial number this will be zero + // + + ULONG SerialNumberOffset; + + // + // Contains the bus type (as defined above) of the device. It should be + // used to interpret the raw device properties at the end of this structure + // (if any) + // + + STORAGE_BUS_TYPE BusType; + + // + // The number of bytes of bus-specific data which have been appended to + // this descriptor + // + + ULONG RawPropertiesLength; + + // + // Place holder for the first byte of the bus specific property data + // + + UCHAR RawDeviceProperties[1]; + +} STORAGE_DEVICE_DESCRIPTOR, *PSTORAGE_DEVICE_DESCRIPTOR; + + +// +// Adapter properties +// +// This descriptor can be retrieved from a target device object of from the +// device object for the bus. Retrieving from the target device object will +// forward the request to the underlying bus +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_ADAPTER_DESCRIPTOR { + + ULONG Version; + + ULONG Size; + + ULONG MaximumTransferLength; + + ULONG MaximumPhysicalPages; + + ULONG AlignmentMask; + + BOOLEAN AdapterUsesPio; + + BOOLEAN AdapterScansDown; + + BOOLEAN CommandQueueing; + + BOOLEAN AcceleratedTransfer; + +#if (NTDDI_VERSION < NTDDI_WINXP) + BOOLEAN BusType; +#else + UCHAR BusType; +#endif + + USHORT BusMajorVersion; + + USHORT BusMinorVersion; + +#if (NTDDI_VERSION >= NTDDI_WIN8) + + UCHAR SrbType; + + UCHAR AddressType; +#endif + +} STORAGE_ADAPTER_DESCRIPTOR, *PSTORAGE_ADAPTER_DESCRIPTOR; + + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define NO_SRBTYPE_ADAPTER_DESCRIPTOR_SIZE \ + UFIELD_OFFSET(STORAGE_ADAPTER_DESCRIPTOR, SrbType) + +#if !defined(SRB_TYPE_SCSI_REQUEST_BLOCK) +#define SRB_TYPE_SCSI_REQUEST_BLOCK 0 +#endif + +#if !defined(SRB_TYPE_STORAGE_REQUEST_BLOCK) +#define SRB_TYPE_STORAGE_REQUEST_BLOCK 1 +#endif + +#if !defined(STORAGE_ADDRESS_TYPE_BTL8) +#define STORAGE_ADDRESS_TYPE_BTL8 0 +#endif + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +typedef _Struct_size_bytes_(Size) struct _STORAGE_ACCESS_ALIGNMENT_DESCRIPTOR { + + // + // Sizeof(STORAGE_ACCESS_ALIGNMENT_DESCRIPTOR) + // + + ULONG Version; + + // + // Total size of the descriptor, including the space for additional + // data and id strings + // + + ULONG Size; + + // + // The number of bytes in a cache line of the device + // + + ULONG BytesPerCacheLine; + + // + // The address offset neccessary for proper cache access alignment in bytes + // + + ULONG BytesOffsetForCacheAlignment; + + // + // The number of bytes in a physical sector of the device + // + + ULONG BytesPerLogicalSector; + + // + // The number of bytes in an addressable logical sector (LBA)of the device + // + + ULONG BytesPerPhysicalSector; + + // + // The address offset neccessary for proper sector access alignment in bytes + // + + ULONG BytesOffsetForSectorAlignment; + +} STORAGE_ACCESS_ALIGNMENT_DESCRIPTOR, *PSTORAGE_ACCESS_ALIGNMENT_DESCRIPTOR; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_MEDIUM_PRODUCT_TYPE_DESCRIPTOR { + + // + // Sizeof(STORAGE_MEDIUM_PRODUCT_TYPE_DESCRIPTOR) + // + + ULONG Version; + + // + // Total size of the descriptor, including the space for additional data + // + + ULONG Size; + + // + // Product type of the supporting storage medium + // + + ULONG MediumProductType; + +} STORAGE_MEDIUM_PRODUCT_TYPE_DESCRIPTOR, *PSTORAGE_MEDIUM_PRODUCT_TYPE_DESCRIPTOR; + + +typedef enum _STORAGE_PORT_CODE_SET { + StoragePortCodeSetReserved = 0, + StoragePortCodeSetStorport = 1, + StoragePortCodeSetSCSIport = 2, + StoragePortCodeSetSpaceport = 3, + StoragePortCodeSetATAport = 4, + StoragePortCodeSetUSBport = 5, + StoragePortCodeSetSBP2port = 6, + StoragePortCodeSetSDport = 7 +} STORAGE_PORT_CODE_SET, *PSTORAGE_PORT_CODE_SET; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define STORAGE_MINIPORT_DESCRIPTOR_V1_SIZE RTL_SIZEOF_THROUGH_FIELD(STORAGE_MINIPORT_DESCRIPTOR, IoTimeoutValue) +#endif + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct + +typedef struct _STORAGE_MINIPORT_DESCRIPTOR { + + ULONG Version; + + ULONG Size; + + STORAGE_PORT_CODE_SET Portdriver; + + BOOLEAN LUNResetSupported; + + BOOLEAN TargetResetSupported; + +#if (NTDDI_VERSION >= NTDDI_WIN8) + USHORT IoTimeoutValue; +#endif + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + BOOLEAN ExtraIoInfoSupported; + +#if (NTDDI_VERSION >= NTDDI_WIN10_FE) + + union { + struct { + UCHAR LogicalPoFxForDisk : 1; + UCHAR ForwardIo : 1; + UCHAR Reserved : 6; + } DUMMYSTRUCTNAME; + UCHAR AsUCHAR; + } Flags; + + UCHAR Reserved0[2]; + +#else + UCHAR Reserved0[3]; +#endif + + ULONG Reserved1; +#endif + +} STORAGE_MINIPORT_DESCRIPTOR, *PSTORAGE_MINIPORT_DESCRIPTOR; + +#pragma warning(pop) + +// +// Storage identification descriptor. +// The definitions here are based on the SCSI/SBP vital product data +// device identifier page. +// + +typedef enum _STORAGE_IDENTIFIER_CODE_SET { + StorageIdCodeSetReserved = 0, + StorageIdCodeSetBinary = 1, + StorageIdCodeSetAscii = 2, + StorageIdCodeSetUtf8 = 3 +} STORAGE_IDENTIFIER_CODE_SET, *PSTORAGE_IDENTIFIER_CODE_SET; + +typedef enum _STORAGE_IDENTIFIER_TYPE { + StorageIdTypeVendorSpecific = 0, + StorageIdTypeVendorId = 1, + StorageIdTypeEUI64 = 2, + StorageIdTypeFCPHName = 3, + StorageIdTypePortRelative = 4, + StorageIdTypeTargetPortGroup = 5, + StorageIdTypeLogicalUnitGroup = 6, + StorageIdTypeMD5LogicalUnitIdentifier = 7, + StorageIdTypeScsiNameString = 8 +} STORAGE_IDENTIFIER_TYPE, *PSTORAGE_IDENTIFIER_TYPE; + +// Mislabeled above but need to keep it for backwards compatibility +#define StorageIdTypeNAA StorageIdTypeFCPHName + +// NAA formats (Used with StorageIdTypeNAA) +typedef enum _STORAGE_ID_NAA_FORMAT { + StorageIdNAAFormatIEEEExtended = 2, + StorageIdNAAFormatIEEERegistered = 3, + StorageIdNAAFormatIEEEERegisteredExtended = 5 +} STORAGE_ID_NAA_FORMAT, *PSTORAGE_ID_NAA_FORMAT; + +typedef enum _STORAGE_ASSOCIATION_TYPE { + StorageIdAssocDevice = 0, + StorageIdAssocPort = 1, + StorageIdAssocTarget = 2 +} STORAGE_ASSOCIATION_TYPE, *PSTORAGE_ASSOCIATION_TYPE; + +typedef struct _STORAGE_IDENTIFIER { + + STORAGE_IDENTIFIER_CODE_SET CodeSet; + + STORAGE_IDENTIFIER_TYPE Type; + + USHORT IdentifierSize; + + USHORT NextOffset; + + // + // Add new fields here since existing code depends on + // the above layout not changing. + // + + STORAGE_ASSOCIATION_TYPE Association; + + // + // The identifier is a variable length array of bytes. + // + + UCHAR Identifier[1]; + +} STORAGE_IDENTIFIER, *PSTORAGE_IDENTIFIER; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_ID_DESCRIPTOR { + + ULONG Version; + + ULONG Size; + + // + // The number of identifiers reported by the device. + // + + ULONG NumberOfIdentifiers; + + // + // The following field is actually a variable length array of identification + // descriptors. Unfortunately there's no C notation for an array of + // variable length structures so we're forced to just pretend. + // + + UCHAR Identifiers[1]; + +} STORAGE_DEVICE_ID_DESCRIPTOR, *PSTORAGE_DEVICE_ID_DESCRIPTOR; + +// output buffer for StorageDeviceSeekPenaltyProperty & PropertyStandardQuery +typedef struct _DEVICE_SEEK_PENALTY_DESCRIPTOR { + + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + BOOLEAN IncursSeekPenalty; + +} DEVICE_SEEK_PENALTY_DESCRIPTOR, *PDEVICE_SEEK_PENALTY_DESCRIPTOR; + +// output buffer for StorageDeviceWriteAggregationProperty & PropertyStandardQuery +typedef struct _DEVICE_WRITE_AGGREGATION_DESCRIPTOR { + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + BOOLEAN BenefitsFromWriteAggregation; +} DEVICE_WRITE_AGGREGATION_DESCRIPTOR, *PDEVICE_WRITE_AGGREGATION_DESCRIPTOR; + +// output buffer for StorageDeviceTrimProperty & PropertyStandardQuery +typedef struct _DEVICE_TRIM_DESCRIPTOR { + + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + BOOLEAN TrimEnabled; + +} DEVICE_TRIM_DESCRIPTOR, *PDEVICE_TRIM_DESCRIPTOR; + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int +// +// Output buffer for StorageDeviceLBProvisioningProperty & PropertyStandardQuery +// +typedef struct _DEVICE_LB_PROVISIONING_DESCRIPTOR { + + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + UCHAR ThinProvisioningEnabled : 1; + + UCHAR ThinProvisioningReadZeros : 1; + + UCHAR AnchorSupported : 3; + + UCHAR UnmapGranularityAlignmentValid : 1; + + UCHAR GetFreeSpaceSupported : 1; // Supports DeviceDsmAction_GetFreeSpace + + UCHAR MapSupported : 1; // Supports DeviceDsmAction_Map + + UCHAR Reserved1[7]; + + ULONGLONG OptimalUnmapGranularity; // Granularity in bytes. + + ULONGLONG UnmapGranularityAlignment; // Granularity alignment in bytes. + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + + ULONG MaxUnmapLbaCount; // Max LBAs that can be unmapped in a single UNMAP command, in logical blocks. + + ULONG MaxUnmapBlockDescriptorCount; // Max number of descriptors allowed in a single UNMAP command. + +#endif +} DEVICE_LB_PROVISIONING_DESCRIPTOR, *PDEVICE_LB_PROVISIONING_DESCRIPTOR; + +#define DEVICE_LB_PROVISIONING_DESCRIPTOR_V1_SIZE RTL_SIZEOF_THROUGH_FIELD(DEVICE_LB_PROVISIONING_DESCRIPTOR, UnmapGranularityAlignment) + +// +// IOCTL_STORAGE_GET_LB_PROVISIONING_MAP_RESOURCES +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type STORAGE_LB_PROVISIONING_MAP_RESOURCES +// + +typedef struct _STORAGE_LB_PROVISIONING_MAP_RESOURCES { + ULONG Size; + ULONG Version; + UCHAR AvailableMappingResourcesValid : 1; + UCHAR UsedMappingResourcesValid : 1; + UCHAR Reserved0 : 6; + UCHAR Reserved1[3]; + UCHAR AvailableMappingResourcesScope : 2; // See LOG_PAGE_LBP_RESOURCE_SCOPE_* definitions in scsi.h for scope values. + UCHAR UsedMappingResourcesScope : 2; + UCHAR Reserved2 : 4; + UCHAR Reserved3[3]; + ULONGLONG AvailableMappingResources; // Available LBA mapping resources, in bytes. + ULONGLONG UsedMappingResources; // Used LBA mapping resources, in bytes. +} STORAGE_LB_PROVISIONING_MAP_RESOURCES, *PSTORAGE_LB_PROVISIONING_MAP_RESOURCES; + +#pragma warning(pop) + +// output buffer for StorageDevicePowerProperty & PropertyStandardQuery +typedef struct _DEVICE_POWER_DESCRIPTOR { + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + BOOLEAN DeviceAttentionSupported; // The device supports "device attention". + BOOLEAN AsynchronousNotificationSupported; // The device supports asynchronous notifications, delivered via IOCTL_STORAGE_EVENT_NOTIFICATION. + BOOLEAN IdlePowerManagementEnabled; // The device has been registered for runtime idle power management. + BOOLEAN D3ColdEnabled; // The device will be powered off when put into D3. + BOOLEAN D3ColdSupported; // The platform supports D3Cold for this device. + BOOLEAN NoVerifyDuringIdlePower; // Device require no verification during idle power transitions. + UCHAR Reserved[2]; + ULONG IdleTimeoutInMS; // The idle timeout value in milliseconds. Only valid if IdlePowerManagementEnabled == TRUE. +} DEVICE_POWER_DESCRIPTOR, *PDEVICE_POWER_DESCRIPTOR; + +// +// Output buffer for StorageDeviceCopyOffloadProperty & PropertyStandardQuery +// +typedef struct _DEVICE_COPY_OFFLOAD_DESCRIPTOR { + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + ULONG MaximumTokenLifetime; + ULONG DefaultTokenLifetime; + ULONGLONG MaximumTransferSize; + ULONGLONG OptimalTransferCount; + ULONG MaximumDataDescriptors; + ULONG MaximumTransferLengthPerDescriptor; + ULONG OptimalTransferLengthPerDescriptor; + USHORT OptimalTransferLengthGranularity; + UCHAR Reserved[2]; +} DEVICE_COPY_OFFLOAD_DESCRIPTOR, *PDEVICE_COPY_OFFLOAD_DESCRIPTOR; + +// +// Output buffer for StorageDeviceResiliencyProperty & PropertyStandardQuery +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_RESILIENCY_DESCRIPTOR { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields + // + + ULONG Size; + + // + // Friendly name associated with + // this descriptor + // + + ULONG NameOffset; + + // + // Number of logical copies of + // data that are available + // + + ULONG NumberOfLogicalCopies; + + // + // Number of complete copies of + // data that are stored + // + + ULONG NumberOfPhysicalCopies; + + // + // Number of disks that can fail + // without leading to data loss + // + + ULONG PhysicalDiskRedundancy; + + // + // Number of columns associated + // with this descriptor + // + + ULONG NumberOfColumns; + + // + // Stripe width associated with + // this descriptor, in bytes + // + + ULONG Interleave; + +} STORAGE_DEVICE_RESILIENCY_DESCRIPTOR, *PSTORAGE_DEVICE_RESILIENCY_DESCRIPTOR; + +// +// Output buffer for StorageAdapterRpmbProperty & PropertyStandardQuery +// + +typedef enum _STORAGE_RPMB_FRAME_TYPE { + + StorageRpmbFrameTypeUnknown = 0, + StorageRpmbFrameTypeStandard, + StorageRpmbFrameTypeMax, + +} STORAGE_RPMB_FRAME_TYPE, *PSTORAGE_RPMB_FRAME_TYPE; + +#define STORAGE_RPMB_DESCRIPTOR_VERSION_1 1 + +#define STORAGE_RPMB_MINIMUM_RELIABLE_WRITE_SIZE 512 + +typedef struct _STORAGE_RPMB_DESCRIPTOR { + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to STORAGE_RPMB_DESCRIPTOR_VERSION_1 + // + + ULONG Version; + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to sizeof(STORAGE_RPMB_DESCRIPTOR) + // + + ULONG Size; + + // + // The size of the RPMB, in bytes. + // + // 0 if not supported, RPMB size in bytes otherwise + // + + ULONG SizeInBytes; + + // + // The maximum amount of data supported in one transaction + // in bytes. + // + // 0 if not supported, minimum 512 bytes + // + + ULONG MaxReliableWriteSizeInBytes; + + // + // To support different RPMB frame formats, specify which + // frame format the payload will be in so the port driver + // can take the appropriate action + // + + STORAGE_RPMB_FRAME_TYPE FrameFormat; + +} STORAGE_RPMB_DESCRIPTOR, *PSTORAGE_RPMB_DESCRIPTOR; + +// begin_storport begin_privstorport + +#ifndef STORAGE_CRYPTO_ALGORITHMS_DEFINED +#define STORAGE_CRYPTO_ALGORITHMS_DEFINED + +// +// Output buffer for StorageAdapterCryptoProperty & PropertyStandardQuery +// + +typedef enum _STORAGE_CRYPTO_ALGORITHM_ID { + + StorageCryptoAlgorithmUnknown = 0, + StorageCryptoAlgorithmXTSAES = 1, + StorageCryptoAlgorithmBitlockerAESCBC, + StorageCryptoAlgorithmAESECB, + StorageCryptoAlgorithmESSIVAESCBC, + StorageCryptoAlgorithmMax, + + // + // Legacy compatibility algorithm names. + // Use the names above. + // + + StorCryptoAlgorithmUnknown = StorageCryptoAlgorithmUnknown, + StorCryptoAlgorithmXTSAES = StorageCryptoAlgorithmXTSAES, + StorCryptoAlgorithmBitlockerAESCBC = StorageCryptoAlgorithmBitlockerAESCBC, + StorCryptoAlgorithmAESECB = StorageCryptoAlgorithmAESECB, + StorCryptoAlgorithmESSIVAESCBC = StorageCryptoAlgorithmESSIVAESCBC, +} STORAGE_CRYPTO_ALGORITHM_ID, *PSTORAGE_CRYPTO_ALGORITHM_ID; + +typedef enum _STORAGE_CRYPTO_KEY_SIZE { + + StorageCryptoKeySizeUnknown = 0, + StorageCryptoKeySize128Bits = 1, + StorageCryptoKeySize192Bits, + StorageCryptoKeySize256Bits, + StorageCryptoKeySize512Bits, + StorageCryptoKeySizeMax, + + // + // Legacy compatibility key size names. + // Use the names above. + // + StorCryptoKeySizeUnknown = StorageCryptoKeySizeUnknown, + StorCryptoKeySize128Bits = StorageCryptoKeySize128Bits, + StorCryptoKeySize192Bits = StorageCryptoKeySize192Bits, + StorCryptoKeySize256Bits = StorageCryptoKeySize256Bits, + StorCryptoKeySize512Bits = StorageCryptoKeySize512Bits, +} STORAGE_CRYPTO_KEY_SIZE, *PSTORAGE_CRYPTO_KEY_SIZE; + +#endif // STORAGE_CRYPTO_ALGORITHMS_DEFINED + +// end_storport end_privstorport + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions + +#define STORAGE_CRYPTO_CAPABILITY_VERSION_1 1 + +// +// Note: Starting in Win11 24H2 and WS2025 or GE, this struct is deprecated. +// Use STORAGE_HW_CRYPTO_CAPABILITY. +// +typedef struct _STORAGE_CRYPTO_CAPABILITY { + + // + // To enable versioning of this structure. This shall be set + // to STORAGE_CRYPTO_CAPABILITY_VERSION_1 + // + + ULONG Version; + + // + // Size of this structure. This shall be set to + // sizeof(STORAGE_CRYPTO_CAPABILITY) + // + + ULONG Size; + + // + // The index for this crypto capability + // + + ULONG CryptoCapabilityIndex; + + // + // Supported algorithm for this crypto capability + // + + STORAGE_CRYPTO_ALGORITHM_ID AlgorithmId; + + // + // The supported key size for this algorithm + // + + STORAGE_CRYPTO_KEY_SIZE KeySize; + + // + // Bitmask for the supported sizes of encryptable data blocks. When bit + // j is set (j=0...7), a data unit size of 512*2^j bytes is supported. + // Bit 0 represents 512 bytes, 1 represents 1 KB, bit 7 represents 64 KB + // + + ULONG DataUnitSizeBitmask; + +} STORAGE_CRYPTO_CAPABILITY, *PSTORAGE_CRYPTO_CAPABILITY; + +#define STORAGE_CRYPTO_CAPABILITY_VERSION_2 2 + +// begin_storport begin_privstorport + +#ifndef STORAGE_SECURITY_COMPLIANCE_BITMASK_DEFINED +#define STORAGE_SECURITY_COMPLIANCE_BITMASK_DEFINED + +typedef union _STORAGE_SECURITY_COMPLIANCE_BITMASK { + struct { + UCHAR FIPS : 1; + UCHAR Reserved : 7; + }; + UCHAR AsUchar; +} STORAGE_SECURITY_COMPLIANCE_BITMASK; + +#endif + +#ifndef STORAGE_CRYPTO_KEY_TYPE_DEFINED +#define STORAGE_CRYPTO_KEY_TYPE_DEFINED + +typedef union _STORAGE_CRYPTO_KEY_TYPE { + struct { + UCHAR DirectKey : 1; + UCHAR PlatformWrappedKey : 1; + UCHAR PlutonWrappedKey : 1; + UCHAR Reserved : 5; + }; + UCHAR AsUchar; +} STORAGE_CRYPTO_KEY_TYPE; + +#endif + +// end_storport end_privstorport + +typedef struct _STORAGE_CRYPTO_CAPABILITY_V2 { + + // + // To enable versioning of this structure. This shall be set + // to STORAGE_CRYPTO_CAPABILITY_VERSION_2 + // + + ULONG Version; + + // + // Size of this structure. This shall be set to + // sizeof(STORAGE_CRYPTO_CAPABILITY_V2) + // + + ULONG Size; + + // + // The index for this crypto capability + // + + ULONG CryptoCapabilityIndex; + + // + // Supported algorithm for this crypto capability + // + + STORAGE_CRYPTO_ALGORITHM_ID AlgorithmId; + + // + // The supported key size for this algorithm + // + + STORAGE_CRYPTO_KEY_SIZE KeySize; + + // + // Bitmask for the supported sizes of encryptable data blocks. When bit + // j is set (j=0...7), a data unit size of 512*2^j bytes is supported. + // Bit 0 represents 512 bytes, 1 represents 1 KB, bit 7 represents 64 KB + // + + ULONG DataUnitSizeBitmask; + + // + // Maximum supported initialization vector bit size. This can be 0 if + // this concept does not apply to the algorithm. + // + + USHORT MaxIVBitSize; + USHORT Reserved; + + // + // Bitmask of compliant security standards at the algorithm level. + // + + STORAGE_SECURITY_COMPLIANCE_BITMASK SecurityComplianceBitmask; + +} STORAGE_CRYPTO_CAPABILITY_V2, *PSTORAGE_CRYPTO_CAPABILITY_V2; + +#define STORAGE_CRYPTO_DESCRIPTOR_VERSION_1 1 + +// +// Note: Starting in Win11 24H2 and WS2025 or GE, this structure is deprecated. +// Use STORAGE_HW_CRYPTO_DESCRIPTOR. +// +typedef struct _STORAGE_CRYPTO_DESCRIPTOR { + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to STORAGE_CRYPTO_DESCRIPTOR_VERSION_1 + // + + ULONG Version; + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to sizeof(STORAGE_CRYPTO_DESCRIPTOR) + // + + ULONG Size; + + // + // The number of keys the crypto engine in the adapter supports + // + + ULONG NumKeysSupported; + + // + // The number of crypto capability entries. This outlines the + // crypto configurations the adapter supports + // + + ULONG NumCryptoCapabilities; + + // + // Array of Crypto Capabilities + // + + _Field_size_(NumCryptoCapabilities) STORAGE_CRYPTO_CAPABILITY CryptoCapabilities[ANYSIZE_ARRAY]; + +} STORAGE_CRYPTO_DESCRIPTOR, *PSTORAGE_CRYPTO_DESCRIPTOR; + +#define STORAGE_CRYPTO_DESCRIPTOR_VERSION_2 2 + +typedef enum _STORAGE_ICE_TYPE { + + StorageIceTypeUnknown = 0, + StorageIceTypeUfs, + StorageIceTypeNvme, + +} STORAGE_ICE_TYPE, *PSTORAGE_ICE_TYPE; + +// +// Note: Starting in Win11 24H2 and WS2025 or GE, this structure is deprecated. +// Use STORAGE_HW_CRYPTO_DESCRIPTOR. +// +typedef struct _STORAGE_CRYPTO_DESCRIPTOR_V2 { + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to STORAGE_CRYPTO_DESCRIPTOR_VERSION_2 + // + + ULONG Version; + + // + // Keep compatible with STORAGE_DESCRIPTOR_HEADER + // Shall be set to sizeof(STORAGE_CRYPTO_DESCRIPTOR_V2) + // + + ULONG Size; + + // + // The number of keys the crypto engine in the adapter supports + // + + ULONG NumKeysSupported; + + // + // The number of crypto capability entries. This outlines the + // crypto configurations the adapter supports + // + + ULONG NumCryptoCapabilities; + + // + // Which type of inline crypto engine this is + // + + STORAGE_ICE_TYPE IceType; + + // + // Bitmask of compliant security standards. + // + + STORAGE_SECURITY_COMPLIANCE_BITMASK SecurityComplianceBitmask; + +#if (NTDDI_VERSION >= NTDDI_WIN11_DT) + + // + // Bitmask of supported key types. + // + + STORAGE_CRYPTO_KEY_TYPE KeyTypeBitmask; +#endif + + // + // Array of Crypto Capabilities. + // NOTE: You cannot index into this array. + // Instead compute the next offset as + // curCryptoCapability = + // (STORAGE_CRYPTO_CAPABILITY_V2*)((PUCHAR)curCryptoCapability + curCryptoCapability->Size) + // + + _Field_size_(NumCryptoCapabilities) STORAGE_CRYPTO_CAPABILITY_V2 CryptoCapabilities[ANYSIZE_ARRAY]; + +} STORAGE_CRYPTO_DESCRIPTOR_V2, *PSTORAGE_CRYPTO_DESCRIPTOR_V2; + +// +// Output buffer for StorageHwCryptoProperty +// + +#define STORAGE_HW_CRYPTO_CAPABILITY_VERSION_1 1 + +typedef struct _STORAGE_HW_CRYPTO_CAPABILITY { + + // + // To enable versioning of this structure. This shall be set + // to STORAGE_HW_CRYPTO_CAPABILITY_VERSION_1 + // + + ULONG Version; + + // + // Size of this structure. This shall be set to + // sizeof(STORAGE_HW_CRYPTO_CAPABILITY) + // + + ULONG Size; + + // + // The index for this crypto capability + // + + ULONG CryptoCapabilityIndex; + + // + // Supported algorithm for this crypto capability + // + + STORAGE_CRYPTO_ALGORITHM_ID AlgorithmId; + + // + // The supported key size for this algorithm + // + + STORAGE_CRYPTO_KEY_SIZE KeySize; + + // + // Bitmask for the supported sizes of encryptable data blocks. When bit + // j is set (j=0...7), a data unit size of 512*2^j bytes is supported. + // Bit 0 represents 512 bytes, 1 represents 1 KB, bit 7 represents 64 KB + // + + ULONG DataUnitSizeBitmask; + + // + // Maximum supported initialization vector bit size. This can be 0 if + // this concept does not apply to the algorithm. + // + + USHORT MaxIVBitSize; + USHORT Reserved; + + // + // Bitmask of compliant security standards at the algorithm level. + // + + STORAGE_SECURITY_COMPLIANCE_BITMASK SecurityComplianceBitmask; + +} STORAGE_HW_CRYPTO_CAPABILITY, *PSTORAGE_HW_CRYPTO_CAPABILITY; + +#define STORAGE_HW_CRYPTO_DESCRIPTOR_VERSION_1 1 + +typedef struct _STORAGE_HW_CRYPTO_DESCRIPTOR { + + // + // Header.Version is set to STORAGE_HW_CRYPTO_DESCRIPTOR_VERSION_1 + // to enable future version updates. + // + // Header.Size is set to the size of the entire buffer, including + // the trailing array of crypto capabilities. + // + + STORAGE_DESCRIPTOR_HEADER Header; + + // + // The number of keys the crypto engine supports + // + + ULONG NumKeysSupported; + + // + // The number of crypto capability entries. This outlines the + // crypto configurations the crypto engine supports. + // + + ULONG NumCryptoCapabilities; + + // + // Offset to an array of STORAGE_HW_CRYPTO_CAPABILITY + // structures from the beginning of STORAGE_HW_CRYPTO_DESCRIPTOR. + // Use STORAGE_HW_CRYPTO_CAPABILITY::Size to iterate through the + // elements. + // + + _Field_range_(sizeof(struct _STORAGE_HW_CRYPTO_DESCRIPTOR), Header.Size) + ULONG OffsetToCryptoCapabilities; + + // + // Size of each crypto capability array element. + // + + ULONG SizeOfCryptoCapability; + + // + // Which type of inline crypto engine this is + // + + STORAGE_ICE_TYPE IceType; + + // + // Bitmask of compliant security standards. + // + + STORAGE_SECURITY_COMPLIANCE_BITMASK SecurityComplianceBitmask; + + // + // Bitmask of supported key types. + // + + STORAGE_CRYPTO_KEY_TYPE KeyTypeBitmask; + + // + // The following array exists at `OffsetToCryptoCapabilities`. + // Each element must be `SizeOfCryptoCapability` in size. + // + // STORAGE_HW_CRYPTO_CAPABILITY Capabilities[] + // + +} STORAGE_HW_CRYPTO_DESCRIPTOR, *PSTORAGE_HW_CRYPTO_DESCRIPTOR; + +FORCEINLINE +const STORAGE_HW_CRYPTO_CAPABILITY * +GetStorageHwCryptoCapability ( + const STORAGE_HW_CRYPTO_DESCRIPTOR *CryptoDescriptor, + ULONG Index + ) +{ + SIZE_T Offset = CryptoDescriptor->OffsetToCryptoCapabilities + + Index * CryptoDescriptor->SizeOfCryptoCapability; + +#if defined(NT_ASSERT) + NT_ASSERT(Offset <= CryptoDescriptor->Header.Size); +#endif + + return (STORAGE_HW_CRYPTO_CAPABILITY *)((const char *)CryptoDescriptor + Offset); +} + +// +// Same as GetStorageHwCryptoCapability except returns a non const (mutable) +// pointer. Useful when creating a storage crypto descriptor. +// +FORCEINLINE +STORAGE_HW_CRYPTO_CAPABILITY * +GetStorageHwCryptoCapabilityMut ( + _In_reads_bytes_(CryptoDescriptor->Header.Size) STORAGE_HW_CRYPTO_DESCRIPTOR *CryptoDescriptor, + ULONG Index + ) +{ + SIZE_T Offset = CryptoDescriptor->OffsetToCryptoCapabilities + + Index * CryptoDescriptor->SizeOfCryptoCapability; + +#if defined(NT_ASSERT) + NT_ASSERT(Offset <= CryptoDescriptor->Header.Size); +#endif + + return (STORAGE_HW_CRYPTO_CAPABILITY *)((char *)CryptoDescriptor + Offset); +} +#pragma warning(pop) + +// end_winioctl +// begin_winioctl + +// +// The STORAGE_TIER is an identifier for the storage tier relative to the volume/LUN. +// The storage tier ID for a particular volume has no relationship to the storage tier +// ID with the same value on a different volume. +// + +#define STORAGE_TIER_NAME_LENGTH (256) +#define STORAGE_TIER_DESCRIPTION_LENGTH (512) + +#define STORAGE_TIER_FLAG_NO_SEEK_PENALTY (0x00020000) +#define STORAGE_TIER_FLAG_WRITE_BACK_CACHE (0x00200000) +#define STORAGE_TIER_FLAG_READ_CACHE (0x00400000) +#define STORAGE_TIER_FLAG_PARITY (0x00800000) +#define STORAGE_TIER_FLAG_SMR (0x01000000) + +typedef enum _STORAGE_TIER_MEDIA_TYPE { + + StorageTierMediaTypeUnspecified = 0, + StorageTierMediaTypeDisk = 1, + StorageTierMediaTypeSsd = 2, + StorageTierMediaTypeScm = 4, + StorageTierMediaTypeMax + +} STORAGE_TIER_MEDIA_TYPE, *PSTORAGE_TIER_MEDIA_TYPE; + +typedef enum _STORAGE_TIER_CLASS { + + StorageTierClassUnspecified = 0, + StorageTierClassCapacity, + StorageTierClassPerformance, + StorageTierClassMax + +} STORAGE_TIER_CLASS, *PSTORAGE_TIER_CLASS; + +typedef struct _STORAGE_TIER { + + // + // Tier ID + // + + GUID Id; + + // + // Name for the tier + // + + WCHAR Name[STORAGE_TIER_NAME_LENGTH]; + + // + // Note for the tier + // + + WCHAR Description[STORAGE_TIER_NAME_LENGTH]; + + // + // Flags: STORAGE_TIER_FLAG_xxx + // + + ULONGLONG Flags; + + // + // Provisioned capacity of the tier + // + + ULONGLONG ProvisionedCapacity; + + // + // Media type of the tier + // + + STORAGE_TIER_MEDIA_TYPE MediaType; + + // + // Classification of the tier + // + + STORAGE_TIER_CLASS Class; + +} STORAGE_TIER, *PSTORAGE_TIER; + +// +// The response returns a single structure of STORAGE_DEVICE_TIERING_DESCRIPTOR that has +// all the tiers for this disk. +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_TIERING_DESCRIPTOR { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields + // + + ULONG Size; + + // + // Flags. The upper USHORT of these flags is reserved for file system use as + // this structure is returned slightly tweaked in FSCTL_QUERY_STORAGE_CLASSES_OUTPUT. + // + + ULONG Flags; + + // + // The total number of available tiers for this disk + // + + ULONG TotalNumberOfTiers; + + // + // The number of tiers that fit in the output + // + + ULONG NumberOfTiersReturned; + + // + // Detailed info on the storage tiers. + // + + _Field_size_(NumberOfTiersReturned) STORAGE_TIER Tiers[ANYSIZE_ARRAY]; + +} STORAGE_DEVICE_TIERING_DESCRIPTOR, *PSTORAGE_DEVICE_TIERING_DESCRIPTOR; + +// +// Output buffer for StorageDeviceFaultDomainProperty & PropertyStandardQuery +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_FAULT_DOMAIN_DESCRIPTOR { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields + // + + ULONG Size; + + // + // Number of fault domains + // + + ULONG NumberOfFaultDomains; + + // + // Fault domain ids + // + + _Field_size_(NumberOfFaultDomains) + GUID FaultDomainIds[ANYSIZE_ARRAY]; + +} STORAGE_DEVICE_FAULT_DOMAIN_DESCRIPTOR, *PSTORAGE_DEVICE_FAULT_DOMAIN_DESCRIPTOR; + +// +// Parameters for StorageAdapterProtocolSpecificProperty (or StorageDeviceProtocolSpecificProperty) & PropertyStandardQuery +// + +// +// Define the different storage command protocols that used between software and hardware. +// e.g. command protocol software uses to communicate with hardware. +// Protocol types below 128 (0x80) are reserved for Microsoft use. +// +typedef enum _STORAGE_PROTOCOL_TYPE { + ProtocolTypeUnknown = 0x00, + ProtocolTypeScsi, + ProtocolTypeAta, + ProtocolTypeNvme, + ProtocolTypeSd, + ProtocolTypeUfs, + ProtocolTypeProprietary = 0x7E, + ProtocolTypeMaxReserved = 0x7F +} STORAGE_PROTOCOL_TYPE, *PSTORAGE_PROTOCOL_TYPE; + + +typedef enum _STORAGE_PROTOCOL_NVME_DATA_TYPE { + NVMeDataTypeUnknown = 0, + + NVMeDataTypeIdentify, // Retrieved by command - IDENTIFY CONTROLLER or IDENTIFY NAMESPACE + // Corresponding values in STORAGE_PROTOCOL_SPECIFIC_DATA, + // ProtocolDataRequestValue - CNS as defined in NVME_IDENTIFY_CNS_CODES + // ProtocolDataRequestSubValue - Namespace Id + // ProtocolDataRequestSubValue2 - CNS Specific Id (CNSID) + // ProtocolDataRequestSubValue3 - Controller Id (CNTID) + // ProtocolDataRequestSubValue4 - Command Set Identifier (CSI) + + NVMeDataTypeLogPage, // Retrieved by command - GET LOG PAGE + // Corresponding values in STORAGE_PROTOCOL_SPECIFIC_DATA, + // ProtocolDataRequestValue - Log page id + // ProtocolDataRequestSubValue - Lower 32-bit offset value + // ProtocolDataRequestSubValue2 - Upper 32-bit offset value + // ProtocolDataRequestSubValue3 - Log specific identifier + // ProtocolDataRequestSubValue4 - STORAGE_PROTOCOL_DATA_SUBVALUE_GET_LOG_PAGE + + NVMeDataTypeFeature, // Retrieved by command - GET FEATURES or SET FEATURES + // Corresponding values in STORAGE_PROTOCOL_SPECIFIC_DATA (get) or STORAGE_PROTOCOL_SPECIFIC_DATA_EXT (set), + // ProtocolDataRequestValue - Defined in NVME_CDW10_GET_FEATURES / NVME_CDW10_SET_FEATURES + // ProtocolDataRequestSubValue - Defined in NVME_CDW11_FEATURES + // ProtocolDataRequestSubValue2 - Defined in NVME_CDW12_FEATURES + // ProtocolDataRequestSubValue3 - Defined in NVME_CDW13_FEATURES + // ProtocolDataRequestSubValue4 - Defined in NVME_CDW14_FEATURES + // ProtocolDataRequestSubValue5 - Defined in NVME_CDW15_FEATURES + + NVMeDataTypeLogPageEx, // Retrieved by command - GET LOG PAGE + // Corresponding values in STORAGE_PROTOCOL_SPECIFIC_DATA_EXT, + // ProtocolDataValue - Defined in NVME_CDW10_GET_LOG_PAGE + // ProtocolDataSubValue - Defined in NVME_CDW11_GET_LOG_PAGE + // ProtocolDataSubValue2 - Defined in NVME_CDW12_GET_LOG_PAGE + // ProtocolDataSubValue3 - Defined in NVME_CDW13_GET_LOG_PAGE + // ProtocolDataSubValue4 - Defined in NVME_CDW14_GET_LOG_PAGE + // ProtocolDataSubValue5 - Defined in NVME_CDW15_GET_LOG_PAGE (not used currently) + // ProtocolDataSubValue6 - Namespace ID + + NVMeDataTypeFeatureEx, // Retrieved by command - GET FEATURES or SET FEATURES + // Corresponding values in STORAGE_cd PROTOCOL_SPECIFIC_DATA_EXT, + // ProtocolDataValue - Defined in NVME_CDW10_GET_FEATURES / NVME_CDW10_SET_FEATURES + // ProtocolDataSubValue - Defined in NVME_CDW11_FEATURES + // ProtocolDataSubValue2 - Defined in NVME_CDW12_FEATURES + // ProtocolDataSubValue3 - Defined in NVME_CDW13_FEATURES + // ProtocolDataSubValue4 - Defined in NVME_CDW14_FEATURES + // ProtocolDataSubValue5 - Defined in NVME_CDW15_FEATURES + // ProtocolDataSubValue6 - Namespace ID + + // For NVMeDataTypeLogPageEx and NVMeDataTypeFeatureEx the namespace ID field is only used for requests sent to + // an adapter or controller. In these scenarios, the caller sets ProtocolDataSubValue6 to either 0 (NSID not used) or + // FFFFFFFFF (request applies to all namespaces). For requests being targeted at a disk, the storage stack driver + // will substitute in the corresponding NSID automatically. Callers must set ProtocolDataSubValue6 to 0 for these requests. + +} STORAGE_PROTOCOL_NVME_DATA_TYPE, *PSTORAGE_PROTOCOL_NVME_DATA_TYPE; + +typedef enum _STORAGE_PROTOCOL_ATA_DATA_TYPE { + AtaDataTypeUnknown = 0, + AtaDataTypeIdentify, // Retrieved by command - IDENTIFY DEVICE + AtaDataTypeLogPage, // Retrieved by command - READ LOG EXT +} STORAGE_PROTOCOL_ATA_DATA_TYPE, *PSTORAGE_PROTOCOL_ATA_DATA_TYPE; + +typedef enum _STORAGE_PROTOCOL_UFS_DATA_TYPE { + UfsDataTypeUnknown = 0, + UfsDataTypeQueryDescriptor, // Retrieved by command - QUERY UPIU + UfsDataTypeQueryAttribute, // Retrieved by command - QUERY UPIU + UfsDataTypeQueryFlag, // Retrieved by command - QUERY UPIU + UfsDataTypeQueryDmeAttribute, // Retrieved by command - QUERY UPIU + UfsDataTypeQueryDmePeerAttribute, // Retrieved by command - QUERY UPIU + UfsDataTypeMax, +} STORAGE_PROTOCOL_UFS_DATA_TYPE, *PSTORAGE_PROTOCOL_UFS_DATA_TYPE; + +// +// Below definition is used to specify particular command fields when querying +// NVMeDataTypeLogPage, and this definition maps to ProtocolDataRequestSubValue4 +// field in STORAGE_PROTOCOL_SPECIFIC_DATA. +// +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct + +typedef union _STORAGE_PROTOCOL_DATA_SUBVALUE_GET_LOG_PAGE { + + struct { + + ULONG RetainAsynEvent : 1; + ULONG LogSpecificField : 4; + ULONG Reserved0 : 3; + ULONG UUIDIndex : 7; + ULONG Reserved : 17; + + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} STORAGE_PROTOCOL_DATA_SUBVALUE_GET_LOG_PAGE, *PSTORAGE_PROTOCOL_DATA_SUBVALUE_GET_LOG_PAGE; + +#pragma warning(pop) + +// +// Protocol Data should follow this data structure in the same buffer. +// The offset of Protocol Data from the beginning of this data structure +// is reported in data field - "ProtocolDataOffset". +// +typedef struct _STORAGE_PROTOCOL_SPECIFIC_DATA { + + STORAGE_PROTOCOL_TYPE ProtocolType; + ULONG DataType; // The value will be protocol specific, as defined in STORAGE_PROTOCOL_NVME_DATA_TYPE or STORAGE_PROTOCOL_ATA_DATA_TYPE. + + ULONG ProtocolDataRequestValue; + ULONG ProtocolDataRequestSubValue; // Data sub request value + + ULONG ProtocolDataOffset; // The offset of data buffer is from beginning of this data structure. + ULONG ProtocolDataLength; + + ULONG FixedProtocolReturnData; + ULONG ProtocolDataRequestSubValue2; // First additional data sub request value + + ULONG ProtocolDataRequestSubValue3; // Second additional data sub request value + ULONG ProtocolDataRequestSubValue4; // Third additional data sub request value + +} STORAGE_PROTOCOL_SPECIFIC_DATA, *PSTORAGE_PROTOCOL_SPECIFIC_DATA; + +// +// Extended type incorporates both Get/Set protocol data +// Protocol Data should follow this data structure in the same buffer. +// The offset of Protocol Data from the beginning of this data structure +// is reported in data field - "ProtocolDataOffset". +// +typedef struct _STORAGE_PROTOCOL_SPECIFIC_DATA_EXT { + + STORAGE_PROTOCOL_TYPE ProtocolType; + ULONG DataType; // The value will be protocol specific, as defined in STORAGE_PROTOCOL_NVME_DATA_TYPE or STORAGE_PROTOCOL_ATA_DATA_TYPE. + + ULONG ProtocolDataValue; + ULONG ProtocolDataSubValue; // Data sub request value + + ULONG ProtocolDataOffset; // The offset of data buffer is from beginning of this data structure. + ULONG ProtocolDataLength; + + ULONG FixedProtocolReturnData; + ULONG ProtocolDataSubValue2; // First additional data sub request value + + ULONG ProtocolDataSubValue3; // Second additional data sub request value + ULONG ProtocolDataSubValue4; // Third additional data sub request value + + ULONG ProtocolDataSubValue5; // Fourth additional data sub request value + ULONG ProtocolDataSubValue6; // Fifth additional data sub request value + + ULONG Reserved[4]; + +} STORAGE_PROTOCOL_SPECIFIC_DATA_EXT, *PSTORAGE_PROTOCOL_SPECIFIC_DATA_EXT; + +// +// Input parameter for StorageAdapterProtocolSpecificProperty (or StorageDeviceProtocolSpecificProperty) & PropertyStandardQuery +// will be data structure STORAGE_PROPERTY_QUERY, where the data field "AdditionalParameters" is a buffer +// in format of STORAGE_PROTOCOL_SPECIFIC_DATA. +// + +// +// Out parameter for StorageAdapterProtocolSpecificProperty (or StorageDeviceProtocolSpecificProperty) & PropertyStandardQuery +// will be STORAGE_PROTOCOL_DATA_DESCRIPTOR. +// +typedef struct _STORAGE_PROTOCOL_DATA_DESCRIPTOR { + + ULONG Version; + ULONG Size; + + STORAGE_PROTOCOL_SPECIFIC_DATA ProtocolSpecificData; + +} STORAGE_PROTOCOL_DATA_DESCRIPTOR, *PSTORAGE_PROTOCOL_DATA_DESCRIPTOR; + +// +// Input parameter for StorageAdapterProtocolSpecificProperty (or StorageDeviceProtocolSpecificProperty) & PropertyStandardSet +// will be data structure STORAGE_PROPERTY_SET, where the data field "AdditionalParameters" is a buffer +// in format of STORAGE_PROTOCOL_SPECIFIC_DATA_EXT. +// + +// +// Input parameter for StorageAdapterProtocolSpecificPropertyEx (or StorageDeviceProtocolSpecificPropertyEx) & PropertyStandardQuery (or PropertyStandardSet) +// will be data structure STORAGE_PROPERTY_QUERY/STORAGE_PROPERTY_SET, where the data field "AdditionalParameters" is a buffer +// in format of STORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT. +// +// N.B. this differs from the non-Ex properties which use STORAGE_PROTOCOL_SPECIFIC_DATA_EXT in the AdditionalParameters field. +// + +// +// Out parameter for StorageAdapterProtocolSpecificProperty/StorageAdapterProtocolSpecificPropertyEx +// (or StorageDeviceProtocolSpecificProperty/StorageDeviceProtocolSpecificPropertyEx) & PropertyStandardSet +// will be STORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT. +// +typedef struct _STORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT { + + ULONG Version; + ULONG Size; + + STORAGE_PROTOCOL_SPECIFIC_DATA_EXT ProtocolSpecificData; + +} STORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT, *PSTORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT; + +// +// For StorageAdapterProtocolSpecificPropertyEx/StorageDeviceProtocolSpecificPropertyEx we require an actual +// version whereas the older properties used the sizeof as a version. +// +#define STORAGE_PROTOCOL_DATA_DESCRIPTOR_EXT_VERSION 1 + +// +// Parameters for StorageAdapterTemperatureProperty (or StorageDeviceTemperatureProperty) & PropertyStandardQuery +// + + +// +// Input parameters for StorageAdapterTemperatureProperty (or StorageDeviceTemperatureProperty) & PropertyStandardQuery +// uses data structure STORAGE_PROPERTY_QUERY. +// + +// +// Out parameters for StorageAdapterTemperatureProperty (or StorageDeviceTemperatureProperty) & PropertyStandardQuery +// For temperature/threshold data fields, the smallest value of SHORT type - 0x8000 indicates the value is not reported. +// +#define STORAGE_TEMPERATURE_VALUE_NOT_REPORTED 0x8000 + +typedef struct _STORAGE_TEMPERATURE_INFO { + + USHORT Index; // Starts from 0. Index 0 may indicate a composite value. + SHORT Temperature; // Signed value; in Celsius. + SHORT OverThreshold; // Signed value; in Celsius. + SHORT UnderThreshold; // Signed value; in Celsius. + + BOOLEAN OverThresholdChangable; // Can the threshold value being changed by using IOCTL_STORAGE_SET_TEMPERATURE_THRESHOLD. + BOOLEAN UnderThresholdChangable; // Can the threshold value being changed by using IOCTL_STORAGE_SET_TEMPERATURE_THRESHOLD. + BOOLEAN EventGenerated; // Indicates that notification will be generated when temperature cross threshold. + UCHAR Reserved0; + ULONG Reserved1; + +} STORAGE_TEMPERATURE_INFO, *PSTORAGE_TEMPERATURE_INFO; + +typedef struct _STORAGE_TEMPERATURE_DATA_DESCRIPTOR { + + ULONG Version; + ULONG Size; + + // + // Indicates the maximum temperature in degrees Celsius that may prevent continued normal operation, + // possibility of data loss, automatic device shutdown, extreme performance throttling, or permanent damage. + // + SHORT CriticalTemperature; // Signed value; in Celsius. + + // + // Indicates the maximum temperature in degrees Celsius at which the device is capable of + // operating continuously without degrading operation or reliability. + // + SHORT WarningTemperature; // Signed value; in Celsius. + + USHORT InfoCount; // Some devices may report more than one temperature information as there can be multiple sensors implemented. + + UCHAR Reserved0[2]; + + ULONG Reserved1[2]; + + STORAGE_TEMPERATURE_INFO TemperatureInfo[ANYSIZE_ARRAY]; + +} STORAGE_TEMPERATURE_DATA_DESCRIPTOR, *PSTORAGE_TEMPERATURE_DATA_DESCRIPTOR; + + +// +// Input parameters for IOCTL_STORAGE_SET_TEMPERATURE_THRESHOLD +// + +// +// Indicate the target of the request other than the device handle/object itself. +// This is used in "Flags" field of data structures. +// +#define STORAGE_TEMPERATURE_THRESHOLD_FLAG_ADAPTER_REQUEST 0x0001 + +typedef struct _STORAGE_TEMPERATURE_THRESHOLD { + + ULONG Version; + ULONG Size; + + USHORT Flags; + USHORT Index; + + SHORT Threshold; // Signed value; in Celsius. + BOOLEAN OverThreshold; // If TRUE, set the OverThreshold value; Otherwise, set the UnderThreshold value. + UCHAR Reserved; + +} STORAGE_TEMPERATURE_THRESHOLD, *PSTORAGE_TEMPERATURE_THRESHOLD; + +// +// Parameters for StorageAdapterPhysicalTopologyProperty (or StorageDevicePhysicalTopologyProperty) & PropertyStandardQuery +// + + +// +// Input parameters for StorageAdapterPhysicalTopologyProperty (or StorageDevicePhysicalTopologyProperty) & PropertyStandardQuery +// uses data structure STORAGE_PROPERTY_QUERY. +// + +// +// Out parameters for StorageAdapterPhysicalTopologyProperty (or StorageDevicePhysicalTopologyProperty) & PropertyStandardQuery +// uses data structure STORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR +// + +// +// Multiple roles are allowed for a single device. +// +#define STORAGE_COMPONENT_ROLE_CACHE 0x00000001 +#define STORAGE_COMPONENT_ROLE_TIERING 0x00000002 +#define STORAGE_COMPONENT_ROLE_DATA 0x00000004 + + +typedef enum _STORAGE_DEVICE_FORM_FACTOR { + FormFactorUnknown = 0, + + FormFactor3_5, // 3.5 inch nominal form factor + FormFactor2_5, // 2.5 inch nominal form factor + FormFactor1_8, // 1.8 inch nominal form factor + FormFactor1_8Less, // Less than 1.8 inch nominal form factor + + FormFactorEmbedded, // Embedded on board. + FormFactorMemoryCard, // Memory card such as SD, CF. + FormFactormSata, // mSATA + FormFactorM_2, // M.2 + FormFactorPCIeBoard, // PCIe card plug into slot. + FormFactorDimm, // DIMM Slot + +} STORAGE_DEVICE_FORM_FACTOR, *PSTORAGE_DEVICE_FORM_FACTOR; + + +typedef enum _STORAGE_COMPONENT_HEALTH_STATUS { + HealthStatusUnknown = 0, + HealthStatusNormal, + HealthStatusThrottled, + HealthStatusWarning, + HealthStatusDisabled, + HealthStatusFailed, +} STORAGE_COMPONENT_HEALTH_STATUS, *PSTORAGE_COMPONENT_HEALTH_STATUS; + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions + +typedef union _STORAGE_SPEC_VERSION { + + struct { + union { + struct { + UCHAR SubMinor; + UCHAR Minor; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + + } MinorVersion; + + USHORT MajorVersion; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} STORAGE_SPEC_VERSION, *PSTORAGE_SPEC_VERSION; + +#pragma warning(pop) + + +typedef struct _STORAGE_PHYSICAL_DEVICE_DATA { + + ULONG DeviceId; + ULONG Role; // Value(s) of bitmask from STORAGE_COMPONENT_ROLE_xxx + + STORAGE_COMPONENT_HEALTH_STATUS HealthStatus; + STORAGE_PROTOCOL_TYPE CommandProtocol; + STORAGE_SPEC_VERSION SpecVersion; // Supported storage spec version. For example: SBC 3, SATA 3.2, NVMe 1.2 + STORAGE_DEVICE_FORM_FACTOR FormFactor; + + UCHAR Vendor[8]; + UCHAR Model[40]; + UCHAR FirmwareRevision[16]; + + ULONGLONG Capacity; // in unit of Kilo-Bytes (1024 bytes). + + UCHAR PhysicalLocation[32]; // Reserved for future. + + ULONG Reserved[2]; + +} STORAGE_PHYSICAL_DEVICE_DATA, *PSTORAGE_PHYSICAL_DEVICE_DATA; + + +typedef struct _STORAGE_PHYSICAL_ADAPTER_DATA { + + ULONG AdapterId; + STORAGE_COMPONENT_HEALTH_STATUS HealthStatus; + STORAGE_PROTOCOL_TYPE CommandProtocol; + STORAGE_SPEC_VERSION SpecVersion; // Supported storage spec version. For example: AHCI 1.3.1 + + UCHAR Vendor[8]; + UCHAR Model[40]; + UCHAR FirmwareRevision[16]; + + UCHAR PhysicalLocation[32]; // Reserve for future. + + BOOLEAN ExpanderConnected; + UCHAR Reserved0[3]; + ULONG Reserved1[3]; + +} STORAGE_PHYSICAL_ADAPTER_DATA, *PSTORAGE_PHYSICAL_ADAPTER_DATA; + + +typedef struct _STORAGE_PHYSICAL_NODE_DATA { + + ULONG NodeId; + + ULONG AdapterCount; // 0 or 1 + ULONG AdapterDataLength; + ULONG AdapterDataOffset; // Offset from beginning of this data structure. The buffer contains an array of STORAGE_PHYSICAL_ADAPTER_DATA. + + ULONG DeviceCount; // >= 1 + ULONG DeviceDataLength; + ULONG DeviceDataOffset; // Offset from beginning of this data structure. The buffer contains an array of STORAGE_PHYSICAL_DEVICE_DATA. + + ULONG Reserved[3]; + +} STORAGE_PHYSICAL_NODE_DATA, *PSTORAGE_PHYSICAL_NODE_DATA; + + +typedef struct _STORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR { + + ULONG Version; // sizeof(STORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR) + ULONG Size; // Total size of the data. Should be >= sizeof(STORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR) + + ULONG NodeCount; + ULONG Reserved; + + STORAGE_PHYSICAL_NODE_DATA Node[ANYSIZE_ARRAY]; + +} STORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR, *PSTORAGE_PHYSICAL_TOPOLOGY_DESCRIPTOR; + + +// +// Output buffer for StorageDeviceIoCapabilityProperty & PropertyStandardQuery +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_IO_CAPABILITY_DESCRIPTOR { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure + // + + ULONG Size; + + // + // LUN max outstanding IO count + // + + ULONG LunMaxIoCount; + + // + // Adapter max outstanding IO count + // + + ULONG AdapterMaxIoCount; + +} STORAGE_DEVICE_IO_CAPABILITY_DESCRIPTOR, *PSTORAGE_DEVICE_IO_CAPABILITY_DESCRIPTOR; + +// +// Output buffer for StorageDeviceAttributesProperty & PropertyStandardQuery +// + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_ATTRIBUTES_DESCRIPTOR { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure + // + + ULONG Size; + + // + // Attributes (bit flags) + // + + ULONG64 Attributes; + +} STORAGE_DEVICE_ATTRIBUTES_DESCRIPTOR, *PSTORAGE_DEVICE_ATTRIBUTES_DESCRIPTOR; + +// +// Storage Device Attributes Flags +// + +#define STORAGE_ATTRIBUTE_BYTE_ADDRESSABLE_IO 0x01 +#define STORAGE_ATTRIBUTE_BLOCK_IO 0x02 +#define STORAGE_ATTRIBUTE_DYNAMIC_PERSISTENCE 0x04 +#define STORAGE_ATTRIBUTE_VOLATILE 0x08 +#define STORAGE_ATTRIBUTE_ASYNC_EVENT_NOTIFICATION 0x10 +#define STORAGE_ATTRIBUTE_PERF_SIZE_INDEPENDENT 0x20 + +// +// Constants for StorageDeviceManagementStatus +// + +typedef enum _STORAGE_DISK_HEALTH_STATUS { + DiskHealthUnknown = 0, + DiskHealthUnhealthy, + DiskHealthWarning, + DiskHealthHealthy, + DiskHealthMax +} STORAGE_DISK_HEALTH_STATUS, *PSTORAGE_DISK_HEALTH_STATUS; + +// +// Operational States +// +typedef enum _STORAGE_DISK_OPERATIONAL_STATUS { + DiskOpStatusNone = 0, + DiskOpStatusUnknown, + DiskOpStatusOk, + DiskOpStatusPredictingFailure, + DiskOpStatusInService, + DiskOpStatusHardwareError, + DiskOpStatusNotUsable, + DiskOpStatusTransientError, + DiskOpStatusMissing, +} STORAGE_DISK_OPERATIONAL_STATUS, *PSTORAGE_DISK_OPERATIONAL_STATUS; + +// +// Operational Reasons +// +typedef enum _STORAGE_OPERATIONAL_STATUS_REASON { + DiskOpReasonUnknown = 0, + DiskOpReasonScsiSenseCode, + DiskOpReasonMedia, + DiskOpReasonIo, + DiskOpReasonThresholdExceeded, + DiskOpReasonLostData, + DiskOpReasonEnergySource, + DiskOpReasonConfiguration, + DiskOpReasonDeviceController, + DiskOpReasonMediaController, + DiskOpReasonComponent, + DiskOpReasonNVDIMM_N, + DiskOpReasonBackgroundOperation, + DiskOpReasonInvalidFirmware, + DiskOpReasonHealthCheck, + DiskOpReasonLostDataPersistence, + DiskOpReasonDisabledByPlatform, + DiskOpReasonLostWritePersistence, + DiskOpReasonDataPersistenceLossImminent, + DiskOpReasonWritePersistenceLossImminent, + DiskOpReasonMax +} STORAGE_OPERATIONAL_STATUS_REASON, *PSTORAGE_OPERATIONAL_STATUS_REASON; + +typedef struct _STORAGE_OPERATIONAL_REASON { + ULONG Version; + ULONG Size; + STORAGE_OPERATIONAL_STATUS_REASON Reason; + + union { + + // + // This is the format if Reason == DiskOpReasonScsiSenseCode. + // + struct { + UCHAR SenseKey; + UCHAR ASC; + UCHAR ASCQ; + UCHAR Reserved; + } ScsiSenseKey; + + // + // This is the format if Reason == DiskOpReasonNVDIMM_N. + // + struct { + UCHAR CriticalHealth; + UCHAR ModuleHealth[2]; + UCHAR ErrorThresholdStatus; + } NVDIMM_N; + + ULONG AsUlong; + } RawBytes; +} STORAGE_OPERATIONAL_REASON, *PSTORAGE_OPERATIONAL_REASON; + +// +// Output buffer for StorageDeviceManagementStatus & PropertyStandardQuery +// + +#define STORAGE_DEVICE_MAX_OPERATIONAL_STATUS 16 + +typedef struct _STORAGE_DEVICE_MANAGEMENT_STATUS { + + // + // Sizeof() of this structure serves + // as the version. + // + + ULONG Version; + + // + // The total size of the structure, including operational status reasons + // that didn't fit in the caller's array. Callers should use this field to learn + // how big the input buffer should be to contain all the available information. + // + + ULONG Size; + + // + // Health status. + // + + STORAGE_DISK_HEALTH_STATUS Health; + + // + // The number of operational status returned. + // + + ULONG NumberOfOperationalStatus; + + // + // The number of additional reasons returned. + // + + ULONG NumberOfAdditionalReasons; + + // + // Operational statuses. The primary operational status is the first element + // in the array. There are NumberOfOperationalStatus valid elements in the array. + // + + STORAGE_DISK_OPERATIONAL_STATUS OperationalStatus[STORAGE_DEVICE_MAX_OPERATIONAL_STATUS]; + + // + // Additional reasons. There are NumberOfAdditionalReasons valid elements in the array. + // + + STORAGE_OPERATIONAL_REASON AdditionalReasons[ANYSIZE_ARRAY]; + +} STORAGE_DEVICE_MANAGEMENT_STATUS, *PSTORAGE_DEVICE_MANAGEMENT_STATUS; + +// +// Parameter for StorageAdapterSerialNumberProperty. +// +// Use this to get the serial number of the storage adapter. Note that not all +// controllers and host controller interfaces may provide a serial number for +// the adapter. If the serial number is malformed or cannot be obtained this +// query will fail. +// +// The serial number can have a maximum of 128 Unicode characters, including +// the trailing NULL character. +// + +#define STORAGE_ADAPTER_SERIAL_NUMBER_V1_MAX_LENGTH (128) + +typedef _Struct_size_bytes_(Size) struct _STORAGE_ADAPTER_SERIAL_NUMBER { + + ULONG Version; + + ULONG Size; + + // + // NULL-terminated Unicode string of the adapter's serial number. + // + + WCHAR SerialNumber[STORAGE_ADAPTER_SERIAL_NUMBER_V1_MAX_LENGTH]; + +} STORAGE_ADAPTER_SERIAL_NUMBER, *PSTORAGE_ADAPTER_SERIAL_NUMBER; + +#define STORAGE_ADAPTER_SERIAL_NUMBER_V1_VERSION (sizeof(STORAGE_ADAPTER_SERIAL_NUMBER)) +#define STORAGE_ADAPTER_SERIAL_NUMBER_V1_SIZE (sizeof(STORAGE_ADAPTER_SERIAL_NUMBER)) + +// +// Output buffer for StorageDeviceZonedDeviceProperty & PropertyStandardQuery +// + +typedef enum _STORAGE_ZONED_DEVICE_TYPES { + ZonedDeviceTypeUnknown = 0, + ZonedDeviceTypeHostManaged, + ZonedDeviceTypeHostAware, + ZonedDeviceTypeDeviceManaged, +} STORAGE_ZONED_DEVICE_TYPES, *PSTORAGE_ZONED_DEVICE_TYPES; + +typedef enum _STORAGE_ZONE_TYPES { + ZoneTypeUnknown = 0, + ZoneTypeConventional = 1, + ZoneTypeSequentialWriteRequired = 2, + ZoneTypeSequentialWritePreferred = 3, + ZoneTypeMax +} STORAGE_ZONE_TYPES, *PSTORAGE_ZONE_TYPES; + +typedef struct _STORAGE_ZONE_GROUP { + + ULONG ZoneCount; // Count of zones in this group. + + STORAGE_ZONE_TYPES ZoneType; + + ULONGLONG ZoneSize; // In Bytes + +} STORAGE_ZONE_GROUP, *PSTORAGE_ZONE_GROUP; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_ZONED_DEVICE_DESCRIPTOR { + + // + // Size of this structure serves as the version + // + + ULONG Version; + + // + // Size of buffer. The returned value indicates how big the buffer should be + // to store complete data. + // + + ULONG Size; + + // + // Zoned device type + // + + STORAGE_ZONED_DEVICE_TYPES DeviceType; + + // + // Total zone count + // + + ULONG ZoneCount; + + // + // Zone Attributes + // + + union { + struct { + + ULONG MaxOpenZoneCount; + + BOOLEAN UnrestrictedRead; + + UCHAR Reserved[3]; + + } SequentialRequiredZone; // Host managed device only + + struct { + + ULONG OptimalOpenZoneCount; + + ULONG Reserved; + + } SequentialPreferredZone; // Host aware device only + + } ZoneAttributes; + + // + // Zone Layout Information, to provide a picture about locations of different type of zones on disk. + // The zone layout starts from the first zone, and groups together zones with same type and size. + // + + ULONG ZoneGroupCount; + + STORAGE_ZONE_GROUP ZoneGroup[ANYSIZE_ARRAY]; + +} STORAGE_ZONED_DEVICE_DESCRIPTOR, *PSTORAGE_ZONED_DEVICE_DESCRIPTOR; + + +// +// Output buffer for StorageDeviceLocationProperty & PropertyStandardQuery +// + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions +typedef struct _DEVICE_LOCATION { + + ULONG Socket; + + ULONG Slot; + + ULONG Adapter; + + ULONG Port; + + union { + + struct { + + ULONG Channel; + + ULONG Device; + + } DUMMYSTRUCTNAME; + + struct { + + ULONG Target; + + ULONG Lun; + + } DUMMYSTRUCTNAME2; + + } DUMMYUNIONNAME; + +} DEVICE_LOCATION, *PDEVICE_LOCATION; +#pragma warning(pop) + +typedef _Struct_size_bytes_(Size) struct _STORAGE_DEVICE_LOCATION_DESCRIPTOR { + + ULONG Version; + + ULONG Size; + + DEVICE_LOCATION Location; + + ULONG StringOffset; + +} STORAGE_DEVICE_LOCATION_DESCRIPTOR, *PSTORAGE_DEVICE_LOCATION_DESCRIPTOR; + +// +// Output buffer for StorageDeviceNumaProperty. +// +// If the query for this property is successful, then the caller should +// validate the NumaNode field before using it to optimize any operations. +// That is, the caller should ensure the NumaNode value is less than or equal +// to the system's highest NUMA node value and the NumaNode value is not equal +// to STORAGE_DEVICE_NUMA_NODE_UNKNOWN. +// +typedef struct _STORAGE_DEVICE_NUMA_PROPERTY { + ULONG Version; + ULONG Size; + ULONG NumaNode; +} STORAGE_DEVICE_NUMA_PROPERTY, *PSTORAGE_DEVICE_NUMA_PROPERTY; + +#define STORAGE_DEVICE_NUMA_NODE_UNKNOWN MAXULONG + +// +// Output buffer for StorageDeviceUnsafeShutdownCount. +// +// On persistent memory devices, the unsafe shutdown count is the number of times +// the logical persistent memory disk was shut down in a way that might have caused +// data loss. +// +typedef struct _STORAGE_DEVICE_UNSAFE_SHUTDOWN_COUNT { + ULONG Version; + ULONG Size; + ULONG UnsafeShutdownCount; +} STORAGE_DEVICE_UNSAFE_SHUTDOWN_COUNT, *PSTORAGE_DEVICE_UNSAFE_SHUTDOWN_COUNT; + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct +#pragma warning(disable:4201) // nameless struct/union + +// +// Parameters for StorageDeviceEnduranceProperty & PropertyStandardQuery +// + +// +// Input parameters for StorageDeviceEnduranceProperty & PropertyStandardQuery +// uses data structure STORAGE_PROPERTY_QUERY. +// + +// +// Out parameters for StorageDeviceEnduranceProperty & PropertyStandardQuery +// For endurance info fields, ValidFields represents bit mapping of valid fields. +// + +typedef struct _STORAGE_HW_ENDURANCE_INFO { + ULONG ValidFields; // ValidFields represents bit mapping of valid fields of any type + // Eg: Bit 0 stands for GroupId, Bit 1 stands for Flags, Bit 3 for BytesReadCount + + ULONG GroupId; // Set Id Eg: Set Id for NVMe sets + + struct { + ULONG Shared:1; // TRUE if information is shared with multiple units/groups + + ULONG Reserved:31; + } Flags; + + ULONG LifePercentage; // Used life percentage + + UCHAR BytesReadCount[16]; // Total bytes read from device (Billion Unit) + + UCHAR ByteWriteCount[16]; // Total bytes written to device (Billion Unit) + +} STORAGE_HW_ENDURANCE_INFO, *PSTORAGE_HW_ENDURANCE_INFO; + +typedef struct _STORAGE_HW_ENDURANCE_DATA_DESCRIPTOR { + ULONG Version; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + ULONG Size; // keep compatible with STORAGE_DESCRIPTOR_HEADER + + STORAGE_HW_ENDURANCE_INFO EnduranceInfo; // Endurance Information of the device + +} STORAGE_HW_ENDURANCE_DATA_DESCRIPTOR, *PSTORAGE_HW_ENDURANCE_DATA_DESCRIPTOR; + +// +// Output buffer for StorageStackProperty. +// + +typedef enum _STORAGE_STACK_TYPE { + StorageStackTypeUnknown = 0, + StorageStackTypeScsi, + StorageStackTypeNVMe, +} STORAGE_STACK_TYPE, *PSTORAGE_STACK_TYPE; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_STACK_DESCRIPTOR { + + // + // Size of this structure serves as the version + // + + ULONG Version; + + // + // Size of buffer. The returned value indicates how big the buffer should be + // to store complete data. + // + + ULONG Size; + + // + // Type of storage stack for the device. + // + + STORAGE_STACK_TYPE StorageStackType; + +} STORAGE_STACK_DESCRIPTOR, *PSTORAGE_STACK_DESCRIPTOR; + +#pragma warning(pop) + +// +// Output buffer for StorageDeviceLedStateProperty. +// +typedef struct _STORAGE_DEVICE_LED_STATE_DESCRIPTOR { + + ULONG Version; + + ULONG Size; + + ULONGLONG State; + +} STORAGE_DEVICE_LED_STATE_DESCRIPTOR, *PSTORAGE_DEVICE_LED_STATE_DESCRIPTOR; + +// +// Output buffer for StorageDeviceSelfEncryptionProperty. +// + +// Version 1 of the structure +// Note: This version only checks if the storage device +// is eDrive capable to keep it backward compatible. +// To handle both eDrive and native TCG implementations +// use Version 2 of the structure. +typedef struct _STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY { + + ULONG Version; // Sizeof(STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY) + + ULONG Size; + + BOOLEAN SupportsSelfEncryption; + +} STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY, *PSTORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY; + + +typedef enum _STORAGE_ENCRYPTION_TYPE { + + StorageEncryptionTypeUnknown = 0x00, + StorageEncryptionTypeEDrive = 0x01, + StorageEncryptionTypeTcgOpal = 0x02, + +} STORAGE_ENCRYPTION_TYPE, *PSTORAGE_ENCRYPTION_TYPE; + +// Version 2 of the structure +// Note: This version handles both eDrive and native TCG implementations. +// To check if a storage device supports a native TCG implementation, +// a client must use this version of the structure. +typedef struct _STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY_V2 { + + ULONG Version; // Sizeof(STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY_V2) + + ULONG Size; + + BOOLEAN SupportsSelfEncryption; + + STORAGE_ENCRYPTION_TYPE EncryptionType; + +} STORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY_V2, *PSTORAGE_DEVICE_SELF_ENCRYPTION_PROPERTY_V2; + +// +// Output buffer for StorageFruIdProperty. +// +typedef struct _STORAGE_FRU_ID_DESCRIPTOR { + + // + // Sizeof(STORAGE_FRU_ID_DESCRIPTOR) + // + + ULONG Version; + + // + // Total size of the data. + // Should be >= sizeof(STORAGE_FRU_ID_DESCRIPTOR) + // + + ULONG Size; + + // + // The identifier is a variable length array of bytes. + // + + ULONG IdentifierSize; + UCHAR Identifier[ANYSIZE_ARRAY]; + +} STORAGE_FRU_ID_DESCRIPTOR, *PSTORAGE_FRU_ID_DESCRIPTOR; + + +//////////////////////////////////////////////////////////////////////////////// +// +// IOCTL_STORAGE_MANAGE_DATA_SET_ATTRIBUTES +// +// Input Buffer: +// Structure of type DEVICE_DSM_INPUT +// +// Output Buffer: +// Structure of type DEVICE_DSM_OUTPUT +// + +// +// DEVICE_DSM_INPUT.Action +// + +typedef ULONG DEVICE_DATA_MANAGEMENT_SET_ACTION, DEVICE_DSM_ACTION; + +// +// This indicates that the action is +// non-destructive and a driver that +// does not understand it may safely +// forward the IOCTL +// + +#define DeviceDsmActionFlag_NonDestructive (0x80000000) +#define IsDsmActionNonDestructive(_Action) ((BOOLEAN)((_Action & DeviceDsmActionFlag_NonDestructive) != 0)) + +#define DeviceDsmAction_None (0x00000000u) +#define DeviceDsmAction_Trim (0x00000001u) +#define DeviceDsmAction_Notification (0x00000002u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_OffloadRead (0x00000003u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_OffloadWrite (0x00000004u) +#define DeviceDsmAction_Allocation (0x00000005u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_Repair (0x00000006u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_Scrub (0x00000007u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_DrtQuery (0x00000008u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_DrtClear (0x00000009u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_DrtDisable (0x0000000Au | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_TieringQuery (0x0000000Bu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_Map (0x0000000Cu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_RegenerateParity (0x0000000Du | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_NvCache_Change_Priority (0x0000000Eu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_NvCache_Evict (0x0000000Fu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_TopologyIdQuery (0x00000010u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_GetPhysicalAddresses (0x00000011u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_ScopeRegen (0x00000012u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_ReportZones (0x00000013u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_OpenZone (0x00000014u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_FinishZone (0x00000015u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_CloseZone (0x00000016u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_ResetWritePointer (0x00000017u) +#define DeviceDsmAction_GetRangeErrorInfo (0x00000018u | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_WriteZeroes (0x00000019u) +#define DeviceDsmAction_LostQuery (0x0000001Au | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_GetFreeSpace (0x0000001Bu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_ConversionQuery (0x0000001Cu | DeviceDsmActionFlag_NonDestructive) +#define DeviceDsmAction_VdtSet (0x0000001Du) +#define DeviceDsmAction_QueryPreferLocalRepair (0x0000001Eu | DeviceDsmActionFlag_NonDestructive) + +// +// DEVICE_DSM_INPUT.Flags +// +// Flags that are not specific to an +// action are in the lower 16-bits +// +// Action-specific flags are in the +// higher 16-bits +// + +// +// When specified, the DataSetRanges +// fields should be 0 +// + +#define DEVICE_DSM_FLAG_ENTIRE_DATA_SET_RANGE 0x00000001 + +typedef struct _DEVICE_DATA_SET_RANGE { + + // + // Must be a multiple of sector + // size, in bytes + // + + LONGLONG StartingOffset; + ULONGLONG LengthInBytes; + +} DEVICE_DATA_SET_RANGE, *PDEVICE_DATA_SET_RANGE, + DEVICE_DSM_RANGE, *PDEVICE_DSM_RANGE; + +typedef struct _DEVICE_MANAGE_DATA_SET_ATTRIBUTES { + + // + // Size of this structure serves + // as the version + // + + ULONG Size; + + DEVICE_DSM_ACTION Action; + ULONG Flags; + + // + // Must be aligned to __alignof(action-specific struct) + // + + ULONG ParameterBlockOffset; + ULONG ParameterBlockLength; + + // + // Must be aligned to __alignof(DEVICE_DSM_RANGE) + // + + ULONG DataSetRangesOffset; + ULONG DataSetRangesLength; + +} DEVICE_MANAGE_DATA_SET_ATTRIBUTES, *PDEVICE_MANAGE_DATA_SET_ATTRIBUTES, + DEVICE_DSM_INPUT, *PDEVICE_DSM_INPUT; + +typedef struct _DEVICE_MANAGE_DATA_SET_ATTRIBUTES_OUTPUT { + + // + // Size of this structure serves + // as the version + // + + ULONG Size; + + DEVICE_DSM_ACTION Action; + ULONG Flags; + + ULONG OperationStatus; + ULONG ExtendedError; + ULONG TargetDetailedError; + ULONG ReservedStatus; + + // + // Must be aligned to __alignof(corresponding struct) + // + + ULONG OutputBlockOffset; + ULONG OutputBlockLength; + +} DEVICE_MANAGE_DATA_SET_ATTRIBUTES_OUTPUT, *PDEVICE_MANAGE_DATA_SET_ATTRIBUTES_OUTPUT, + DEVICE_DSM_OUTPUT, *PDEVICE_DSM_OUTPUT; + +typedef struct _DEVICE_DSM_DEFINITION { + + DEVICE_DSM_ACTION Action; + + BOOLEAN SingleRange; + + ULONG ParameterBlockAlignment; + ULONG ParameterBlockLength; + + BOOLEAN HasOutput; + + ULONG OutputBlockAlignment; + ULONG OutputBlockLength; + +} DEVICE_DSM_DEFINITION, *PDEVICE_DSM_DEFINITION; + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_None +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_None {DeviceDsmAction_None, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Trim +// + +// +// DEVICE_DSM_INPUT.Flags +// + +// +// Indicates that the ranges are not +// part of any file +// + +#define DEVICE_DSM_FLAG_TRIM_NOT_FS_ALLOCATED 0x80000000 + +// +// Indicates that RZAT is not needed +// RZAT only applies to ranges that +// are part of a file that need the +// additional protection +// + +#define DEVICE_DSM_FLAG_TRIM_BYPASS_RZAT 0x40000000 + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_Trim {DeviceDsmAction_Trim, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Notification +// + +// +// DEVICE_DSM_NOTIFICATION_PARAMETERS.Flags +// + +// +// The ranges are now in use by the +// file type identifier +// + +#define DEVICE_DSM_NOTIFY_FLAG_BEGIN 0x00000001 + +// +// The ranges are no longer in use +// by the file type identifier +// + +#define DEVICE_DSM_NOTIFY_FLAG_END 0x00000002 + +typedef struct _DEVICE_DSM_NOTIFICATION_PARAMETERS { + + ULONG Size; + + ULONG Flags; + + ULONG NumFileTypeIDs; + GUID FileTypeID[ANYSIZE_ARRAY]; + +} DEVICE_DSM_NOTIFICATION_PARAMETERS, *PDEVICE_DSM_NOTIFICATION_PARAMETERS; + +// +// SingleRange - No +// ParameterBlock - Yes +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_Notification {DeviceDsmAction_Notification, \ + FALSE, \ + __alignof(DEVICE_DSM_NOTIFICATION_PARAMETERS), \ + sizeof(DEVICE_DSM_NOTIFICATION_PARAMETERS), \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_OffloadRead +// + +#define STORAGE_OFFLOAD_MAX_TOKEN_LENGTH 512 // Keep as ULONG multiple +#define STORAGE_OFFLOAD_TOKEN_ID_LENGTH 0x1F8 +#define STORAGE_OFFLOAD_TOKEN_TYPE_ZERO_DATA 0xFFFF0001 + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions + +typedef struct _STORAGE_OFFLOAD_TOKEN { + + UCHAR TokenType[4]; + UCHAR Reserved[2]; + UCHAR TokenIdLength[2]; + union { + struct { + UCHAR Reserved2[STORAGE_OFFLOAD_TOKEN_ID_LENGTH]; + } StorageOffloadZeroDataToken; + UCHAR Token[STORAGE_OFFLOAD_TOKEN_ID_LENGTH]; + } DUMMYUNIONNAME; + +} STORAGE_OFFLOAD_TOKEN, *PSTORAGE_OFFLOAD_TOKEN; + +#pragma warning(pop) + +#define MAKE_ZERO_TOKEN(T) ( \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[0] = 0xFF, \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[1] = 0xFF, \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[2] = 0x00, \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[3] = 0x01, \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenIdLength[0] = 0x01, \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenIdLength[1] = 0xF8 \ +) + +#define IS_ZERO_TOKEN(T) ( \ + (((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[0] == 0xFF && \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[1] == 0xFF && \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[2] == 0x00 && \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenType[3] == 0x01 && \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenIdLength[0] == 0x01 && \ + ((PSTORAGE_OFFLOAD_TOKEN)T)->TokenIdLength[1] == 0xF8) \ +) + +typedef struct _DEVICE_DSM_OFFLOAD_READ_PARAMETERS { + + // + // Reserved for future use + // + + ULONG Flags; + + // + // Token TTL in milli-seconds as + // requested by the initiator + // + + ULONG TimeToLive; + + ULONG Reserved[2]; + +} DEVICE_DSM_OFFLOAD_READ_PARAMETERS, *PDEVICE_DSM_OFFLOAD_READ_PARAMETERS; + +// +// STORAGE_OFFLOAD_READ_OUTPUT.OffloadReadFlags +// + +#define STORAGE_OFFLOAD_READ_RANGE_TRUNCATED 0x00000001 + +// +// The token returned by the target +// uniquely identifies a "point in +// time" snapshot of ranges taken by +// the target. Its format is opaque +// +// We arbitrarily limit token length to 512. The SCSI interface will/may enable +// negotiable size. If we want to add support, we'll need to create a new action +// + +typedef struct _STORAGE_OFFLOAD_READ_OUTPUT { + + ULONG OffloadReadFlags; + ULONG Reserved; + + // + // Length of the "snapshot" that + // is bound to the token. Must + // be from the lowest range + // + + ULONGLONG LengthProtected; + + ULONG TokenLength; + STORAGE_OFFLOAD_TOKEN Token; + +} STORAGE_OFFLOAD_READ_OUTPUT, *PSTORAGE_OFFLOAD_READ_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - Yes +// Output - No +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_OffloadRead {DeviceDsmAction_OffloadRead, \ + FALSE, \ + __alignof(DEVICE_DSM_OFFLOAD_READ_PARAMETERS), \ + sizeof(DEVICE_DSM_OFFLOAD_READ_PARAMETERS), \ + FALSE, \ + __alignof(STORAGE_OFFLOAD_READ_OUTPUT), \ + sizeof(STORAGE_OFFLOAD_READ_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_OffloadWrite +// + +typedef struct _DEVICE_DSM_OFFLOAD_WRITE_PARAMETERS { + + // + // Reserved for future use + // + + ULONG Flags; + ULONG Reserved; + + // + // Starting offset to copy from + // "snapshot" bound to the token + // + + ULONGLONG TokenOffset; + + STORAGE_OFFLOAD_TOKEN Token; + +} DEVICE_DSM_OFFLOAD_WRITE_PARAMETERS, *PDEVICE_DSM_OFFLOAD_WRITE_PARAMETERS; + +// +// STORAGE_OFFLOAD_WRITE_OUTPUT.OffloadWriteFlags +// + +#define STORAGE_OFFLOAD_WRITE_RANGE_TRUNCATED 0x0001 +#define STORAGE_OFFLOAD_TOKEN_INVALID 0x0002 + +typedef struct _STORAGE_OFFLOAD_WRITE_OUTPUT { + + ULONG OffloadWriteFlags; + ULONG Reserved; + + // + // Length of content copied from + // the "snapshot" from the start + // + + ULONGLONG LengthCopied; + +} STORAGE_OFFLOAD_WRITE_OUTPUT, *PSTORAGE_OFFLOAD_WRITE_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - Yes +// Output - No +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_OffloadWrite {DeviceDsmAction_OffloadWrite, \ + FALSE, \ + __alignof(DEVICE_DSM_OFFLOAD_WRITE_PARAMETERS), \ + sizeof(DEVICE_DSM_OFFLOAD_WRITE_PARAMETERS), \ + FALSE, \ + __alignof(STORAGE_OFFLOAD_WRITE_OUTPUT), \ + sizeof(STORAGE_OFFLOAD_WRITE_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Allocation +// + +// +// DEVICE_DSM_INPUT.Flags +// + +#define DEVICE_DSM_FLAG_ALLOCATION_CONSOLIDATEABLE_ONLY 0x40000000 + +typedef struct _DEVICE_DATA_SET_LBP_STATE_PARAMETERS { + + ULONG Version; + ULONG Size; + + // + // Reserved for future use + // + + ULONG Flags; + + // + // DEVICE_DSM_ALLOCATION_OUTPUT_V1 or + // DEVICE_DSM_ALLOCATION_OUTPUT_V2 + // + + ULONG OutputVersion; + +} DEVICE_DATA_SET_LBP_STATE_PARAMETERS, *PDEVICE_DATA_SET_LBP_STATE_PARAMETERS, + DEVICE_DSM_ALLOCATION_PARAMETERS, *PDEVICE_DSM_ALLOCATION_PARAMETERS; + +#define DEVICE_DSM_PARAMETERS_V1 1 +#define DEVICE_DATA_SET_LBP_STATE_PARAMETERS_VERSION_V1 DEVICE_DSM_PARAMETERS_V1 + +typedef struct _DEVICE_DATA_SET_LB_PROVISIONING_STATE { + + ULONG Size; + ULONG Version; + + ULONGLONG SlabSizeInBytes; + + // + // Delta from the start offset + // if the requested range is not + // aligned to a slab boundary + // + + ULONG SlabOffsetDeltaInBytes; + + // + // Number of bits that are valid + // + + ULONG SlabAllocationBitMapBitCount; + + // + // Count of ULONGs in the bitmap + // + + ULONG SlabAllocationBitMapLength; + + // + // 1 = mapped, 0 = unmapped + // + + ULONG SlabAllocationBitMap[ANYSIZE_ARRAY]; + +} DEVICE_DATA_SET_LB_PROVISIONING_STATE, *PDEVICE_DATA_SET_LB_PROVISIONING_STATE, + DEVICE_DSM_ALLOCATION_OUTPUT, *PDEVICE_DSM_ALLOCATION_OUTPUT; + +#define DEVICE_DSM_ALLOCATION_OUTPUT_V1 (sizeof(DEVICE_DSM_ALLOCATION_OUTPUT)) +#define DEVICE_DATA_SET_LB_PROVISIONING_STATE_VERSION_V1 DEVICE_DSM_ALLOCATION_OUTPUT_V1 + +typedef struct _DEVICE_DATA_SET_LB_PROVISIONING_STATE_V2 { + + ULONG Size; + ULONG Version; + + ULONGLONG SlabSizeInBytes; + + // + // Delta from the start offset + // if the requested range is not + // aligned to a slab boundary + // + + ULONGLONG SlabOffsetDeltaInBytes; + + // + // Number of bits that are valid + // + + ULONG SlabAllocationBitMapBitCount; + + // + // Count of ULONGs in the bitmap + // + + ULONG SlabAllocationBitMapLength; + + // + // 1 = mapped, 0 = unmapped + // + + ULONG SlabAllocationBitMap[ANYSIZE_ARRAY]; + +} DEVICE_DATA_SET_LB_PROVISIONING_STATE_V2, *PDEVICE_DATA_SET_LB_PROVISIONING_STATE_V2, + DEVICE_DSM_ALLOCATION_OUTPUT2, *PDEVICE_DSM_ALLOCATION_OUTPUT2; + +#define DEVICE_DSM_ALLOCATION_OUTPUT_V2 (sizeof(DEVICE_DSM_ALLOCATION_OUTPUT2)) +#define DEVICE_DATA_SET_LB_PROVISIONING_STATE_VERSION_V2 DEVICE_DSM_ALLOCATION_OUTPUT_V2 + +// +// SingleRange - Yes +// ParameterBlock - Yes +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_Allocation {DeviceDsmAction_Allocation, \ + TRUE, \ + __alignof(DEVICE_DSM_ALLOCATION_PARAMETERS), \ + sizeof(DEVICE_DSM_ALLOCATION_PARAMETERS), \ + TRUE, \ + __alignof(DEVICE_DSM_ALLOCATION_OUTPUT2), \ + sizeof(DEVICE_DSM_ALLOCATION_OUTPUT2)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Repair +// + +// +// DEVICE_DSM_INPUT.Flags +// + +#define DEVICE_DSM_FLAG_REPAIR_INPUT_TOPOLOGY_ID_PRESENT 0x40000000 + +typedef struct _DEVICE_DATA_SET_REPAIR_PARAMETERS { + + ULONG NumberOfRepairCopies; + ULONG SourceCopy; + ULONG RepairCopies[ANYSIZE_ARRAY]; + + // + // Valid iff DEVICE_DSM_FLAG_REPAIR_INPUT_TOPOLOGY_ID_PRESENT is set + // + // To access this field, use the + // below macro + // + + // UCHAR TopologyId[16]; + +} DEVICE_DATA_SET_REPAIR_PARAMETERS, *PDEVICE_DATA_SET_REPAIR_PARAMETERS, + DEVICE_DSM_REPAIR_PARAMETERS, *PDEVICE_DSM_REPAIR_PARAMETERS; + +#define GET_REPAIR_TOPOLOGY_ID(R) \ + RtlOffsetToPointer(R, \ + ALIGN_UP_BY(FIELD_OFFSET(DEVICE_DATA_SET_REPAIR_PARAMETERS, RepairCopies) + \ + sizeof(ULONG) * R->NumberOfRepairCopies, \ + 8)) + +// +// DEVICE_DSM_OUTPUT.Flags +// + +#define DEVICE_DSM_FLAG_REPAIR_OUTPUT_PARITY_EXTENT 0x20000000 + +typedef struct _DEVICE_DATA_SET_REPAIR_OUTPUT { + + // + // Valid iff DEVICE_DSM_FLAG_REPAIR_OUTPUT_PARITY_EXTENT is set + // + + DEVICE_DSM_RANGE ParityExtent; + +} DEVICE_DATA_SET_REPAIR_OUTPUT, *PDEVICE_DATA_SET_REPAIR_OUTPUT, + DEVICE_DSM_REPAIR_OUTPUT, *PDEVICE_DSM_REPAIR_OUTPUT; + +// +// SingleRange - Yes +// ParameterBlock - Yes +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_Repair {DeviceDsmAction_Repair, \ + TRUE, \ + __alignof(DEVICE_DSM_REPAIR_PARAMETERS), \ + sizeof(DEVICE_DSM_REPAIR_PARAMETERS), \ + TRUE, \ + __alignof(DEVICE_DSM_REPAIR_OUTPUT), \ + sizeof(DEVICE_DSM_REPAIR_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_QueryPreferLocalRepair +// + +typedef struct _DEVICE_DSM_QUERY_PREFER_LOCAL_REPAIR_OUTPUT { + + ULONG Version; + BOOLEAN PreferLocalRepair; + +} DEVICE_DSM_QUERY_PREFER_LOCAL_REPAIR_OUTPUT, *PDEVICE_DSM_QUERY_PREFER_LOCAL_REPAIR_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_QueryPreferLocalRepair {DeviceDsmAction_QueryPreferLocalRepair, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_QUERY_PREFER_LOCAL_REPAIR_OUTPUT), \ + sizeof(DEVICE_DSM_QUERY_PREFER_LOCAL_REPAIR_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Scrub +// + +// +// DEVICE_DSM_INPUT.Flags +// + +#define DEVICE_DSM_FLAG_SCRUB_SKIP_IN_SYNC 0x10000000 + +typedef struct _DEVICE_DATA_SET_SCRUB_OUTPUT { + + ULONGLONG BytesProcessed; + ULONGLONG BytesRepaired; + ULONGLONG BytesFailed; + +} DEVICE_DATA_SET_SCRUB_OUTPUT, *PDEVICE_DATA_SET_SCRUB_OUTPUT, + DEVICE_DSM_SCRUB_OUTPUT, *PDEVICE_DSM_SCRUB_OUTPUT; + +// +// DEVICE_DSM_OUTPUT.Flags +// + +#define DEVICE_DSM_FLAG_SCRUB_OUTPUT_PARITY_EXTENT 0x20000000 + +typedef struct _DEVICE_DATA_SET_SCRUB_EX_OUTPUT { + + ULONGLONG BytesProcessed; + ULONGLONG BytesRepaired; + ULONGLONG BytesFailed; + + // + // Valid iff DEVICE_DSM_FLAG_SCRUB_OUTPUT_PARITY_EXTENT is set + // + + DEVICE_DSM_RANGE ParityExtent; + + ULONGLONG BytesScrubbed; + +} DEVICE_DATA_SET_SCRUB_EX_OUTPUT, *PDEVICE_DATA_SET_SCRUB_EX_OUTPUT, + DEVICE_DSM_SCRUB_OUTPUT2, *PDEVICE_DSM_SCRUB_OUTPUT2; + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_Scrub {DeviceDsmAction_Scrub, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_SCRUB_OUTPUT2), \ + sizeof(DEVICE_DSM_SCRUB_OUTPUT2)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_DrtQuery +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - No +// + +#define DeviceDsmDefinition_DrtQuery {DeviceDsmAction_DrtQuery, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_DrtClear +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_DrtClear {DeviceDsmAction_DrtClear, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_DrtDisable +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_DrtDisable {DeviceDsmAction_DrtDisable, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_TieringQuery +// + +typedef struct _DEVICE_DSM_TIERING_QUERY_INPUT { + + ULONG Version; + ULONG Size; + + // + // Reserved for future use + // + + ULONG Flags; + + ULONG NumberOfTierIds; + GUID TierIds[ANYSIZE_ARRAY]; + +} DEVICE_DSM_TIERING_QUERY_INPUT, *PDEVICE_DSM_TIERING_QUERY_INPUT, + DEVICE_DSM_TIERING_QUERY_PARAMETERS, *PDEVICE_DSM_TIERING_QUERY_PARAMETERS; + +typedef struct _STORAGE_TIER_REGION { + + GUID TierId; + + ULONGLONG Offset; + ULONGLONG Length; + +} STORAGE_TIER_REGION, *PSTORAGE_TIER_REGION; + +typedef struct _DEVICE_DSM_TIERING_QUERY_OUTPUT { + + ULONG Version; + ULONG Size; + + // + // Reserved for future use + // + + ULONG Flags; + ULONG Reserved; + + // + // Delta from the start offset + // if the requested range is not + // aligned to a region boundary + // + + ULONGLONG Alignment; + + // + // Total number of regions that + // are in the specified range + // + + ULONG TotalNumberOfRegions; + + ULONG NumberOfRegionsReturned; + _Field_size_(NumberOfRegionsReturned) STORAGE_TIER_REGION Regions[ANYSIZE_ARRAY]; + +} DEVICE_DSM_TIERING_QUERY_OUTPUT, *PDEVICE_DSM_TIERING_QUERY_OUTPUT; + +// +// SingleRange - Yes +// ParameterBlock - Yes +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_TieringQuery {DeviceDsmAction_TieringQuery, \ + TRUE, \ + __alignof(DEVICE_DSM_TIERING_QUERY_PARAMETERS), \ + sizeof(DEVICE_DSM_TIERING_QUERY_PARAMETERS), \ + TRUE, \ + __alignof(DEVICE_DSM_TIERING_QUERY_OUTPUT), \ + sizeof(DEVICE_DSM_TIERING_QUERY_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_Map +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_Map {DeviceDsmAction_Map, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_RegenerateParity +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_RegenerateParity {DeviceDsmAction_RegenerateParity, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_NvCache_Change_Priority +// + +typedef struct _DEVICE_DSM_NVCACHE_CHANGE_PRIORITY_PARAMETERS { + + ULONG Size; + + UCHAR TargetPriority; + UCHAR Reserved[3]; + +} DEVICE_DSM_NVCACHE_CHANGE_PRIORITY_PARAMETERS, *PDEVICE_DSM_NVCACHE_CHANGE_PRIORITY_PARAMETERS; + +// +// SingleRange - No +// ParameterBlock - Yes +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_NvCache_Change_Priority {DeviceDsmAction_NvCache_Change_Priority, \ + FALSE, \ + __alignof(DEVICE_DSM_NVCACHE_CHANGE_PRIORITY_PARAMETERS), \ + sizeof(DEVICE_DSM_NVCACHE_CHANGE_PRIORITY_PARAMETERS), \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_NvCache_Evict +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_NvCache_Evict {DeviceDsmAction_NvCache_Evict, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_TopologyIdQuery +// + +typedef struct _DEVICE_DATA_SET_TOPOLOGY_ID_QUERY_OUTPUT { + + // + // Number of bytes that topology + // id describes relative to the + // start of an input range + // + + ULONGLONG TopologyRangeBytes; + + // + // The corresponding topology id + // + + UCHAR TopologyId[16]; + +} DEVICE_DATA_SET_TOPOLOGY_ID_QUERY_OUTPUT, *PDEVICE_DATA_SET_TOPOLOGY_ID_QUERY_OUTPUT, + DEVICE_DSM_TOPOLOGY_ID_QUERY_OUTPUT, *PDEVICE_DSM_TOPOLOGY_ID_QUERY_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_TopologyIdQuery {DeviceDsmAction_TopologyIdQuery, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_TOPOLOGY_ID_QUERY_OUTPUT), \ + sizeof(DEVICE_DSM_TOPOLOGY_ID_QUERY_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_GetPhysicalAddresses +// + +// +// DEVICE_DSM_INPUT.Flags +// + +// +// If set, TotalNumberOfRanges field will be 0. +// A caller that doesn't need to know the total +// number of ranges should set this flag as a +// performance optimization, because the device +// might incur some cost calculating the total +// number of ranges. +// + +#define DEVICE_DSM_FLAG_PHYSICAL_ADDRESSES_OMIT_TOTAL_RANGES 0x10000000 + +// +// A driver can set the StartAddress field to this value +// to indicate that an address range has a memory error. +// Address ranges with memory errors must not be merged: +// if there are two physically contiguous address ranges +// with errors, they must be reported as two separate +// address ranges, both of which have StartAddress set +// to this value. +// + +#define DEVICE_DSM_PHYSICAL_ADDRESS_HAS_MEMORY_ERROR ((LONGLONG)-1) + +typedef struct _DEVICE_STORAGE_ADDRESS_RANGE { + + LONGLONG StartAddress; + ULONGLONG LengthInBytes; + +} DEVICE_STORAGE_ADDRESS_RANGE, *PDEVICE_STORAGE_ADDRESS_RANGE; + +typedef struct _DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT { + + ULONG Version; + + // + // Reserved for future use + // + + ULONG Flags; + + // + // Total number of ranges within + // the specified ranges. Callers + // may use it to determine the + // correct size of this output + // buffer + // + + ULONG TotalNumberOfRanges; + + // + // If the buffer provided by the + // caller is not large enough to + // hold all the requested ranges + // a STATUS_BUFFER_OVERFLOW will + // be returned + // + + ULONG NumberOfRangesReturned; + DEVICE_STORAGE_ADDRESS_RANGE Ranges[ANYSIZE_ARRAY]; + +} DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT, *PDEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT; + +#define DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT_V1 1 +#define DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT_VERSION_V1 DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT_V1 + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_GetPhysicalAddresses {DeviceDsmAction_GetPhysicalAddresses, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT), \ + sizeof(DEVICE_DSM_PHYSICAL_ADDRESSES_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_ScopeRegen +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_ScopeRegen {DeviceDsmAction_ScopeRegen, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_ReportZones +// + +typedef struct _DEVICE_DSM_REPORT_ZONES_PARAMETERS { + + ULONG Size; + + UCHAR ReportOption; + + // + // This bit affects calculation + // of the zone list length + // + + UCHAR Partial; + + UCHAR Reserved[2]; + +} DEVICE_DSM_REPORT_ZONES_PARAMETERS, *PDEVICE_DSM_REPORT_ZONES_PARAMETERS; + +typedef enum _STORAGE_ZONES_ATTRIBUTES { + + ZonesAttributeTypeAndLengthMayDifferent = 0, + ZonesAttributeTypeSameLengthSame = 1, + ZonesAttributeTypeSameLastZoneLengthDifferent = 2, + ZonesAttributeTypeMayDifferentLengthSame = 3, + +} STORAGE_ZONES_ATTRIBUTES, *PSTORAGE_ZONES_ATTRIBUTES; + +typedef enum _STORAGE_ZONE_CONDITION { + + ZoneConditionConventional = 0x00, + ZoneConditionEmpty = 0x01, + ZoneConditionImplicitlyOpened = 0x02, + ZoneConditionExplicitlyOpened = 0x03, + ZoneConditionClosed = 0x04, + + ZoneConditionReadOnly = 0x0D, + ZoneConditionFull = 0x0E, + ZoneConditionOffline = 0x0F, + +} STORAGE_ZONE_CONDITION, *PSTORAGE_ZONE_CONDITION; + +typedef struct _STORAGE_ZONE_DESCRIPTOR { + + ULONG Size; + + STORAGE_ZONE_TYPES ZoneType; + STORAGE_ZONE_CONDITION ZoneCondition; + + BOOLEAN ResetWritePointerRecommend; + UCHAR Reserved0[3]; + + // + // In bytes + // + + ULONGLONG ZoneSize; + ULONGLONG WritePointerOffset; + +} STORAGE_ZONE_DESCRIPTOR, *PSTORAGE_ZONE_DESCRIPTOR; + +typedef struct _DEVICE_DSM_REPORT_ZONES_DATA { + + ULONG Size; + + // + // Represents the number of ZoneDescriptors. + // + ULONG ZoneCount; + + STORAGE_ZONES_ATTRIBUTES Attributes; + + ULONG Reserved0; + + _Field_size_(ZoneCount) STORAGE_ZONE_DESCRIPTOR ZoneDescriptors[ANYSIZE_ARRAY]; + +} DEVICE_DSM_REPORT_ZONES_DATA, *PDEVICE_DSM_REPORT_ZONES_DATA, + DEVICE_DSM_REPORT_ZONES_OUTPUT, *PDEVICE_DSM_REPORT_ZONES_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - Yes +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_ReportZones {DeviceDsmAction_ReportZones, \ + FALSE, \ + __alignof(DEVICE_DSM_REPORT_ZONES_PARAMETERS), \ + sizeof(DEVICE_DSM_REPORT_ZONES_PARAMETERS), \ + TRUE, \ + __alignof(DEVICE_DSM_REPORT_ZONES_OUTPUT), \ + sizeof(DEVICE_DSM_REPORT_ZONES_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_OpenZone +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_OpenZone {DeviceDsmAction_OpenZone, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_FinishZone +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_FinishZone {DeviceDsmAction_FinishZone, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_CloseZone +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_CloseZone {DeviceDsmAction_CloseZone, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_ResetWritePointer +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_ResetWritePointer {DeviceDsmAction_ResetWritePointer, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_GetRangeErrorInfo +// + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int + +typedef struct _DEVICE_STORAGE_RANGE_ATTRIBUTES { + + // + // Must be a multiple of sector + // size, in bytes + // + + ULONGLONG LengthInBytes; + + union { + + ULONG AllFlags; + + struct { + + // + // 1 = bad, 0 = good + // + + ULONG IsRangeBad : 1; + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; + + ULONG Reserved; + +} DEVICE_STORAGE_RANGE_ATTRIBUTES, *PDEVICE_STORAGE_RANGE_ATTRIBUTES; + +#pragma warning(pop) + +// +// DEVICE_DSM_RANGE_ERROR_OUTPUT.Flags +// + +#define DEVICE_STORAGE_NO_ERRORS 0x1 + +typedef struct _DEVICE_DSM_RANGE_ERROR_INFO { + + ULONG Version; + + ULONG Flags; + + // + // Total number of ranges within + // the specified ranges. Callers + // may use it to determine the + // correct size of this output + // buffer + // + + ULONG TotalNumberOfRanges; + + // + // If the buffer provided by the + // caller is not large enough to + // hold all the requested ranges + // a STATUS_BUFFER_OVERFLOW will + // be returned + // + // The output ranges, which inform the caller about which regions of the requested + // ranges are good or bad. The elements of this array are sorted so that their order + // corresponds to the order of the input ranges. For example, if the first input + // range was broken into 3 output ranges, those will be the first 3 ranges in the array. + // The caller can learn which output ranges correspond to an input range by keeping track + // of the length of the output ranges. + // + + ULONG NumberOfRangesReturned; + DEVICE_STORAGE_RANGE_ATTRIBUTES Ranges[ANYSIZE_ARRAY]; + +} DEVICE_DSM_RANGE_ERROR_INFO, *PDEVICE_DSM_RANGE_ERROR_INFO, + DEVICE_DSM_RANGE_ERROR_OUTPUT, *PDEVICE_DSM_RANGE_ERROR_OUTPUT; + +#define DEVICE_DSM_RANGE_ERROR_OUTPUT_V1 1 +#define DEVICE_DSM_RANGE_ERROR_INFO_VERSION_V1 DEVICE_DSM_RANGE_ERROR_OUTPUT_V1 + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_GetRangeErrorInfo {DeviceDsmAction_GetRangeErrorInfo, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_RANGE_ERROR_OUTPUT), \ + sizeof(DEVICE_DSM_RANGE_ERROR_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_WriteZeroes +// +// ParameterBlock - No +// Output - No +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_WriteZeroes {DeviceDsmAction_WriteZeroes, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_LostQuery +// + +typedef struct _DEVICE_DSM_LOST_QUERY_PARAMETERS { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + ULONGLONG Granularity; + +} DEVICE_DSM_LOST_QUERY_PARAMETERS, *PDEVICE_DSM_LOST_QUERY_PARAMETERS; + +typedef struct _DEVICE_DSM_LOST_QUERY_OUTPUT { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields + // needed for the entire range + // + + ULONG Size; + + // + // Delta from the start offset + // if the requested range is not + // granularity aligned + // + + ULONGLONG Alignment; + + // + // 1 = lost, 0 = readable + // + + ULONG NumberOfBits; + ULONG BitMap[ANYSIZE_ARRAY]; + +} DEVICE_DSM_LOST_QUERY_OUTPUT, *PDEVICE_DSM_LOST_QUERY_OUTPUT; + +// +// SingleRange - Yes +// ParameterBlock - Yes +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_LostQuery {DeviceDsmAction_LostQuery, \ + TRUE, \ + __alignof(DEVICE_DSM_LOST_QUERY_PARAMETERS), \ + sizeof(DEVICE_DSM_LOST_QUERY_PARAMETERS), \ + TRUE, \ + __alignof(DEVICE_DSM_LOST_QUERY_OUTPUT), \ + sizeof(DEVICE_DSM_LOST_QUERY_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_GetFreeSpace +// + +typedef struct _DEVICE_DSM_FREE_SPACE_OUTPUT { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Shared free space available + // + + ULONGLONG FreeSpace; + +} DEVICE_DSM_FREE_SPACE_OUTPUT, *PDEVICE_DSM_FREE_SPACE_OUTPUT; + +// +// SingleRange - No +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_GetFreeSpace {DeviceDsmAction_GetFreeSpace, \ + FALSE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_FREE_SPACE_OUTPUT), \ + sizeof(DEVICE_DSM_FREE_SPACE_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_ConversionQuery +// + +typedef struct _DEVICE_DSM_CONVERSION_OUTPUT { + + // + // Size of this structure serves + // as the version + // + + ULONG Version; + + // + // Stable identifier associated + // with the source + // + + GUID Source; + +} DEVICE_DSM_CONVERSION_OUTPUT, *PDEVICE_DSM_CONVERSION_OUTPUT; + +// +// SingleRange - Yes +// ParameterBlock - No +// Output - Yes +// OutputBlock - Yes +// + +#define DeviceDsmDefinition_ConversionQuery {DeviceDsmAction_ConversionQuery, \ + TRUE, \ + 0, \ + 0, \ + TRUE, \ + __alignof(DEVICE_DSM_CONVERSION_OUTPUT), \ + sizeof(DEVICE_DSM_CONVERSION_OUTPUT)} + + +//////////////////////////////////////////////////////////////////////////////// +// +// DeviceDsmAction_VdtSet +// + +// +// SingleRange - No +// ParameterBlock - No +// Output - No +// OutputBlock - No +// + +#define DeviceDsmDefinition_VdtSet {DeviceDsmAction_VdtSet, \ + FALSE, \ + 0, \ + 0, \ + FALSE, \ + 0, \ + 0} + + +//////////////////////////////////////////////////////////////////////////////// +// +// Dsm helper routines +// + +#define DEVICE_DSM_ROUND_UP(_a, _b) (((_a) + ((_b) - 1)) / (_b) * (_b)) +#define DEVICE_DSM_ROUND_DN(_a, _b) (((_a) ) / (_b) * (_b)) + + +FORCEINLINE +PVOID +DeviceDsmParameterBlock ( + _In_ PDEVICE_DSM_INPUT Input + ) +{ + return (PVOID) + ((ULONG_PTR)Input + + Input->ParameterBlockOffset); +} + + +FORCEINLINE +PDEVICE_DSM_RANGE +DeviceDsmDataSetRanges ( + _In_ PDEVICE_DSM_INPUT Input + ) +{ + return (PDEVICE_DSM_RANGE) + ((ULONG_PTR)Input + + Input->DataSetRangesOffset); +} + + +FORCEINLINE +ULONG +DeviceDsmNumberOfDataSetRanges ( + _In_ PDEVICE_DSM_INPUT Input + ) +{ + return Input->DataSetRangesLength / + sizeof(DEVICE_DSM_RANGE); +} + + +FORCEINLINE +ULONG +DeviceDsmGetInputLength ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_ ULONG ParameterBlockLength, + _In_ ULONG NumberOfDataSetRanges + ) +{ + ULONG Bytes = sizeof(DEVICE_DSM_INPUT); + + if (Definition->ParameterBlockLength != 0 && + ParameterBlockLength != 0) { + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->ParameterBlockAlignment); + Bytes += ParameterBlockLength; + } + + if (NumberOfDataSetRanges != 0) { + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, __alignof(DEVICE_DSM_RANGE)); + Bytes += sizeof(DEVICE_DSM_RANGE) * NumberOfDataSetRanges; + } + + return Bytes; +} + + +FORCEINLINE +ULONG +DeviceDsmGetNumberOfDataSetRanges ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_ ULONG InputLength, + _In_ ULONG ParameterBlockLength + ) +{ + ULONG Bytes = sizeof(DEVICE_DSM_INPUT); + + if (Definition->ParameterBlockLength != 0 && + ParameterBlockLength != 0) { + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->ParameterBlockAlignment); + Bytes += ParameterBlockLength; + } + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, __alignof(DEVICE_DSM_RANGE)); + Bytes = InputLength - Bytes; + + return Bytes / sizeof(DEVICE_DSM_RANGE); +} + + +FORCEINLINE +VOID +DeviceDsmInitializeInput ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _Out_writes_bytes_(InputLength) PDEVICE_DSM_INPUT Input, + _In_ _In_range_(>=, sizeof(DEVICE_DSM_INPUT)) ULONG InputLength, + _In_ ULONG Flags, + _In_reads_bytes_opt_(ParameterBlockLength) PVOID Parameters, + _In_ ULONG ParameterBlockLength + ) +{ + ULONG Bytes = sizeof(DEVICE_DSM_INPUT); + + RtlZeroMemory(Input, InputLength); + + Input->Size = Bytes; + Input->Action = Definition->Action; + Input->Flags = Flags; + + if (Definition->ParameterBlockLength == 0 || + ParameterBlockLength == 0) { + + goto Cleanup; + } + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->ParameterBlockAlignment); + + Input->ParameterBlockOffset = Bytes; + Input->ParameterBlockLength = ParameterBlockLength; + + if (!Parameters) { + goto Cleanup; + } + + RtlCopyMemory(DeviceDsmParameterBlock(Input), + Parameters, + Input->ParameterBlockLength); + +Cleanup: + + return; +} + + +FORCEINLINE +BOOLEAN +DeviceDsmAddDataSetRange ( + _Inout_updates_bytes_(InputLength) PDEVICE_DSM_INPUT Input, + _In_ _In_range_(>=, sizeof(DEVICE_DSM_INPUT)) ULONG InputLength, + _In_ LONGLONG Offset, + _In_ ULONGLONG Length + ) +{ + ULONG Bytes = 0; + ULONG Index = 0; + PDEVICE_DSM_RANGE Ranges = NULL; + BOOLEAN Return = FALSE; + + if (Input->Flags & DEVICE_DSM_FLAG_ENTIRE_DATA_SET_RANGE) { + goto Cleanup; + } + + if (Input->DataSetRangesLength == 0) { + + if (Input->ParameterBlockLength == 0) { + + Bytes = sizeof(DEVICE_DSM_INPUT); + + } else { + + Bytes = Input->ParameterBlockOffset + + Input->ParameterBlockLength; + } + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, __alignof(DEVICE_DSM_RANGE)); + + } else { + + Bytes = Input->DataSetRangesOffset + + Input->DataSetRangesLength; + } + + if ((InputLength - Bytes) < sizeof(DEVICE_DSM_RANGE)) { + goto Cleanup; + } + + if (Input->DataSetRangesOffset == 0) { + Input->DataSetRangesOffset = Bytes; + } + + Ranges = DeviceDsmDataSetRanges(Input); + Index = DeviceDsmNumberOfDataSetRanges(Input); + + Ranges[Index].StartingOffset = Offset; + Ranges[Index].LengthInBytes = Length; + + Input->DataSetRangesLength += sizeof(DEVICE_DSM_RANGE); + + Return = TRUE; + +Cleanup: + + return Return; +} + + +FORCEINLINE +BOOLEAN +DeviceDsmValidateInput ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_reads_bytes_(InputLength) PDEVICE_DSM_INPUT Input, + _In_ _In_range_(>=, sizeof(DEVICE_DSM_INPUT)) ULONG InputLength + ) +{ + ULONG Max = 0; + ULONG Min = 0; + BOOLEAN Valid = FALSE; + + if (Input->Size != sizeof(*Input)) { + goto Cleanup; + } + + if (Definition->Action != Input->Action) { + goto Cleanup; + } + + if (Definition->ParameterBlockLength != 0) { + + Min = sizeof(*Input); + Max = InputLength; + + if (Input->ParameterBlockOffset < Min || + Input->ParameterBlockOffset > Max || + Input->ParameterBlockOffset % Definition->ParameterBlockAlignment) { + goto Cleanup; + } + + Min = Definition->ParameterBlockLength; + Max = InputLength - Input->ParameterBlockOffset; + + if (Input->ParameterBlockLength < Min || + Input->ParameterBlockLength > Max) { + goto Cleanup; + } + + } else { + + if (Input->ParameterBlockLength != 0 || + Input->ParameterBlockOffset != 0) { + goto Cleanup; + } + } + + if (!(Input->Flags & DEVICE_DSM_FLAG_ENTIRE_DATA_SET_RANGE)) { + + Min = sizeof(*Input); + Max = InputLength; + + if (Input->DataSetRangesOffset < Min || + Input->DataSetRangesOffset > Max || + Input->DataSetRangesOffset % __alignof(DEVICE_DSM_RANGE)) { + goto Cleanup; + } + + Min = sizeof(DEVICE_DSM_RANGE); + Max = InputLength - Input->DataSetRangesOffset; + + if (Input->DataSetRangesLength < Min || + Input->DataSetRangesLength > Max || + Input->DataSetRangesLength % Min) { + goto Cleanup; + } + + if (Definition->SingleRange && + Input->DataSetRangesLength != Min) { + goto Cleanup; + } + + } else { + + if (Input->DataSetRangesOffset != 0 || + Input->DataSetRangesLength != 0) { + goto Cleanup; + } + } + + if (Input->ParameterBlockOffset < Input->DataSetRangesOffset && + Input->ParameterBlockOffset + + Input->ParameterBlockLength > Input->DataSetRangesOffset) { + goto Cleanup; + } + + if (Input->DataSetRangesOffset < Input->ParameterBlockOffset && + Input->DataSetRangesOffset + + Input->DataSetRangesLength > Input->ParameterBlockOffset) { + goto Cleanup; + } + + Valid = TRUE; + +Cleanup: + + return Valid; +} + + +FORCEINLINE +PVOID +DeviceDsmOutputBlock ( + _In_ PDEVICE_DSM_OUTPUT Output + ) +{ + return (PVOID) + ((ULONG_PTR)Output + Output->OutputBlockOffset); +} + + +FORCEINLINE +ULONG +DeviceDsmGetOutputLength ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_ ULONG OutputBlockLength + ) +{ + ULONG Bytes = 0; + + if (!Definition->HasOutput) { + goto Cleanup; + } + + Bytes = sizeof(DEVICE_DSM_OUTPUT); + + if (Definition->OutputBlockLength == 0) { + goto Cleanup; + } + + if (Definition->OutputBlockLength > OutputBlockLength) { + OutputBlockLength = Definition->OutputBlockLength; + } + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->OutputBlockAlignment); + Bytes += OutputBlockLength; + +Cleanup: + + return Bytes; +} + + +FORCEINLINE +BOOLEAN +DeviceDsmValidateOutputLength ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_ ULONG OutputLength + ) +{ + ULONG Bytes = DeviceDsmGetOutputLength(Definition, + 0); + + return (OutputLength >= Bytes); +} + + +FORCEINLINE +ULONG +DeviceDsmGetOutputBlockLength ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_ ULONG OutputLength + ) +{ + ULONG Bytes = 0; + + if (Definition->OutputBlockLength == 0) { + goto Cleanup; + } + + Bytes = sizeof(DEVICE_DSM_OUTPUT); + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->OutputBlockAlignment); + Bytes = OutputLength - Bytes; + +Cleanup: + + return Bytes; +} + + +FORCEINLINE +VOID +DeviceDsmInitializeOutput ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _Out_writes_bytes_(OutputLength) PDEVICE_DSM_OUTPUT Output, + _In_ _In_range_(>=, sizeof(DEVICE_DSM_OUTPUT)) ULONG OutputLength, + _In_ ULONG Flags + ) +{ + ULONG Bytes = sizeof(DEVICE_DSM_OUTPUT); + + RtlZeroMemory(Output, OutputLength); + + Output->Size = Bytes; + Output->Action = Definition->Action; + Output->Flags = Flags; + + if (Definition->OutputBlockLength != 0) { + + Bytes = DEVICE_DSM_ROUND_UP(Bytes, Definition->OutputBlockAlignment); + + Output->OutputBlockOffset = Bytes; + Output->OutputBlockLength = OutputLength - Bytes; + } + + return; +} + + +FORCEINLINE +BOOLEAN +DeviceDsmValidateOutput ( + _In_ PDEVICE_DSM_DEFINITION Definition, + _In_reads_bytes_(OutputLength) PDEVICE_DSM_OUTPUT Output, + _In_ _In_range_(>=, sizeof(DEVICE_DSM_OUTPUT)) ULONG OutputLength + ) +{ + ULONG Max = 0; + ULONG Min = 0; + BOOLEAN Valid = FALSE; + + if (Definition->Action != Output->Action) { + goto Cleanup; + } + + if (!Definition->HasOutput) { + goto Cleanup; + } + + if (Definition->OutputBlockLength != 0) { + + Min = sizeof(*Output); + Max = OutputLength; + + if (Output->OutputBlockOffset < Min || + Output->OutputBlockOffset > Max || + Output->OutputBlockOffset % Definition->OutputBlockAlignment) { + goto Cleanup; + } + + Min = Definition->OutputBlockLength; + Max = OutputLength - Output->OutputBlockOffset; + + if (Output->OutputBlockLength < Min || + Output->OutputBlockLength > Max) { + goto Cleanup; + } + + } else { + + if (Output->OutputBlockOffset != 0 || + Output->OutputBlockLength != 0) { + goto Cleanup; + } + } + + Valid = TRUE; + +Cleanup: + + return Valid; +} + +// +// end IOCTL_STORAGE_MANAGE_DATA_SET_ATTRIBUTES +// +//////////////////////////////////////////////////////////////////////////////// + + +// +// There are some well known GUIDS for certain types of files. They are +// defined in NTIFS.H +// + +// +// IOCTL_STORAGE_GET_BC_PROPERTIES +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type STORAGE_GET_BC_PROPERTIES_OUTPUT +// + +typedef struct _STORAGE_GET_BC_PROPERTIES_OUTPUT { + + // + // Specifies the maximum number of requests + // that can be scheduled per period of time + // + ULONG MaximumRequestsPerPeriod; + + // + // Specifies the minimum period that the + // device uses when scheduling requests + // + ULONG MinimumPeriod; + + // + // Specifies the maximum transfer size supported + // for bandwidth contracts on this device. To + // achieve the highest level of performance, all + // requests should be of this size + // + ULONGLONG MaximumRequestSize; + + // + // Specifies the estimated time taken to + // perform an Io operstion. This field + // is for informational purposes only + // + ULONG EstimatedTimePerRequest; + + // + // Specifies the number of requests that should be + // kept outstanding. This helps keep the device + // device busy and thus obtain maximum throughput. + // This will only be filled in if the target file + // has an outstanding contract. + // + ULONG NumOutStandingRequests; + + // + // Specifies the required size of requests in this + // stream. This will only be filled in if the + // target file has an outstanding contract. + // + ULONGLONG RequestSize; + +} STORAGE_GET_BC_PROPERTIES_OUTPUT, *PSTORAGE_GET_BC_PROPERTIES_OUTPUT; + + +// +// IOCTL_STORAGE_ALLOCATE_BC_STREAM +// +// Input Buffer: +// Structure of type STORAGE_ALLOCATE_BC_STREAM_INPUT +// +// Output Buffer: +// Structure of type STORAGE_ALLOCATE_BC_STREAM_OUTPUT +// + + +// +// Current version +// +#define IOCTL_STORAGE_BC_VERSION 1 + +typedef struct _STORAGE_ALLOCATE_BC_STREAM_INPUT { + + // + // Specifies the corresponding structure version + // + ULONG Version; + + // + // Specifies the number of requests that + // need to complete per period of time + // + ULONG RequestsPerPeriod; + + // + // Specifies the period of time wherein the + // above number of requests must complete + // + ULONG Period; + + // + // Indicates whether failures + // should be retried or not + // + BOOLEAN RetryFailures; + + // + // Indicates whether reqests that will miss + // their deadline should be discarded or not + // + BOOLEAN Discardable; + + // + // Helps align the following field + // + BOOLEAN Reserved1[2]; + + // + // Indicates whether the Io will be + // comprised of reads, writes or both + // + ULONG AccessType; + + // + // Indicates whether the Io to the + // file will be sequential or random + // + ULONG AccessMode; + +} STORAGE_ALLOCATE_BC_STREAM_INPUT, *PSTORAGE_ALLOCATE_BC_STREAM_INPUT; + +typedef struct _STORAGE_ALLOCATE_BC_STREAM_OUTPUT { + + // + // Specifies the required size + // of requests in this stream + // + ULONGLONG RequestSize; + + // + // Specifies the number of requests that should be + // kept outstanding. This helps keep the device + // device busy and thus obtain maximum throughput + // + ULONG NumOutStandingRequests; + +} STORAGE_ALLOCATE_BC_STREAM_OUTPUT, *PSTORAGE_ALLOCATE_BC_STREAM_OUTPUT; + + +// +// IOCTL_STORAGE_FREE_BC_STREAM +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +// +// IOCTL_STORAGE_CHECK_PRIORITY_HINT_SUPPORT +// +// Input Buffer : +// None +// Output Buffer : +// Structure of type STORAGE_PRIORITY_HINT_SUPPORT +// + +#define STORAGE_PRIORITY_HINT_SUPPORTED 0x0001 + +typedef struct _STORAGE_PRIORITY_HINT_SUPPORT { + ULONG SupportFlags; +} STORAGE_PRIORITY_HINT_SUPPORT, *PSTORAGE_PRIORITY_HINT_SUPPORT; + +// +// IOCTL_STORAGE_DIAGNOSTIC +// +// Input Buffer : +// STORAGE_DIAGNOSTIC_REQUEST +// Output Buffer : +// STORAGE_DIAGNOSTIC_DATA +// + +typedef enum _STORAGE_DIAGNOSTIC_LEVEL { + StorageDiagnosticLevelDefault = 0, + StorageDiagnosticLevelMax +} STORAGE_DIAGNOSTIC_LEVEL, *PSTORAGE_DIAGNOSTIC_LEVEL; + +typedef enum _STORAGE_DIAGNOSTIC_TARGET_TYPE { + + StorageDiagnosticTargetTypeUndefined = 0, + StorageDiagnosticTargetTypePort, + StorageDiagnosticTargetTypeMiniport, + StorageDiagnosticTargetTypeHbaFirmware, + StorageDiagnosticTargetTypeMax + +} STORAGE_DIAGNOSTIC_TARGET_TYPE, *PSTORAGE_DIAGNOSTIC_TARGET_TYPE; + +// +// Indicate the target of the request other than the device handle/object itself. +// This is used in "Flags" field of data structures. +// +#define STORAGE_DIAGNOSTIC_FLAG_ADAPTER_REQUEST 0x00000001 + +// +// STORAGE_DIAGNOSTIC_REQUEST +// + +typedef struct _STORAGE_DIAGNOSTIC_REQUEST { + + // Size of this structure. + ULONG Version; + + // Whole size of the structure and the associated data buffer. + // (In case adding variable-sized buffer in future.) + ULONG Size; + + // Request flag. + ULONG Flags; + + // Request target type. See definitions for STORAGE_DIAGNOSTIC_TARGET_TYPE. + STORAGE_DIAGNOSTIC_TARGET_TYPE TargetType; + + // Diagnostic level. See definitions for STORAGE_DIAGNOSTIC_LEVEL. + STORAGE_DIAGNOSTIC_LEVEL Level; + +} STORAGE_DIAGNOSTIC_REQUEST, *PSTORAGE_DIAGNOSTIC_REQUEST; + +// +// STORAGE_DIAGNOSTIC_DATA +// + +typedef struct _STORAGE_DIAGNOSTIC_DATA { + + // Size of this structure. + ULONG Version; + + // Whole size of the structure and the associated data buffer. + ULONG Size; + + // GUID of diagnostic data provider. + GUID ProviderId; + + // If the request failed because of buffer too small, this field should be filled with the required buffer + // size for DiagnosticDataBuffer needed by provider; + // if the request is successful, it should be filled with returned buffer size of DiagnosticDataBuffer; + // it should be cleared to zero for other cases. + ULONG BufferSize; + + // Reserved for future use. + ULONG Reserved; + + // Diagnostic data buffer. + _Field_size_(BufferSize) UCHAR DiagnosticDataBuffer[ANYSIZE_ARRAY]; + +} STORAGE_DIAGNOSTIC_DATA, *PSTORAGE_DIAGNOSTIC_DATA; + +// +// IOCTL_STORAGE_GET_PHYSICAL_ELEMENT_STATUS +// +// Input: +// PHYSICAL_ELEMENT_STATUS_REQUEST +// Output: +// PHYSICAL_ELEMENT_STATUS +// + +typedef struct _PHYSICAL_ELEMENT_STATUS_REQUEST { + + ULONG Version; + ULONG Size; + + ULONG StartingElement; + UCHAR Filter; + UCHAR ReportType; + UCHAR Reserved[2]; + +} PHYSICAL_ELEMENT_STATUS_REQUEST, *PPHYSICAL_ELEMENT_STATUS_REQUEST; + +typedef struct _PHYSICAL_ELEMENT_STATUS_DESCRIPTOR { + + ULONG Version; + ULONG Size; + + ULONG ElementIdentifier; + UCHAR PhysicalElementType; + UCHAR PhysicalElementHealth; + UCHAR Reserved1[2]; + + // In unit of LBA. + ULONGLONG AssociatedCapacity; + + ULONG Reserved2[4]; + +} PHYSICAL_ELEMENT_STATUS_DESCRIPTOR, *PPHYSICAL_ELEMENT_STATUS_DESCRIPTOR; + +typedef struct _PHYSICAL_ELEMENT_STATUS { + + ULONG Version; + ULONG Size; + + ULONG DescriptorCount; + ULONG ReturnedDescriptorCount; + + ULONG ElementIdentifierBeingDepoped; + ULONG Reserved; + + PHYSICAL_ELEMENT_STATUS_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} PHYSICAL_ELEMENT_STATUS, *PPHYSICAL_ELEMENT_STATUS; + +// +// IOCTL_STORAGE_REMOVE_ELEMENT_AND_TRUNCATE +// +// Input: +// REMOVE_ELEMENT_AND_TRUNCATE_REQUEST +// + +typedef struct _REMOVE_ELEMENT_AND_TRUNCATE_REQUEST { + + ULONG Version; + ULONG Size; + + // In unit of LBA. + ULONGLONG RequestCapacity; + + ULONG ElementIdentifier; + ULONG Reserved; + +} REMOVE_ELEMENT_AND_TRUNCATE_REQUEST, *PREMOVE_ELEMENT_AND_TRUNCATE_REQUEST; + +// +// IOCTL_STORAGE_GET_DEVICE_INTERNAL_LOG +// +// Input: +// GET_DEVICE_INTERNAL_STATUS_DATA_REQUEST +// Output: +// DEVICE_INTERNAL_STATUS_DATA +// + +#define ERROR_HISTORY_DIRECTORY_ENTRY_DEFAULT_COUNT 8 + +typedef enum _DEVICE_INTERNAL_STATUS_DATA_REQUEST_TYPE { + DeviceInternalStatusDataRequestTypeUndefined = 0, + DeviceCurrentInternalStatusDataHeader, + DeviceCurrentInternalStatusData, + DeviceSavedInternalStatusDataHeader, + DeviceSavedInternalStatusData +} DEVICE_INTERNAL_STATUS_DATA_REQUEST_TYPE, *PDEVICE_INTERNAL_STATUS_DATA_REQUEST_TYPE; + +typedef enum _DEVICE_INTERNAL_STATUS_DATA_SET { + DeviceStatusDataSetUndefined = 0, + DeviceStatusDataSet1, + DeviceStatusDataSet2, + DeviceStatusDataSet3, + DeviceStatusDataSet4, + DeviceStatusDataSetMax +} DEVICE_INTERNAL_STATUS_DATA_SET, *PDEVICE_INTERNAL_STATUS_DATA_SET; + +typedef struct _GET_DEVICE_INTERNAL_STATUS_DATA_REQUEST { + + ULONG Version; + ULONG Size; + + DEVICE_INTERNAL_STATUS_DATA_REQUEST_TYPE RequestDataType; + DEVICE_INTERNAL_STATUS_DATA_SET RequestDataSet; + +} GET_DEVICE_INTERNAL_STATUS_DATA_REQUEST, *PGET_DEVICE_INTERNAL_STATUS_DATA_REQUEST; + +typedef struct _DEVICE_INTERNAL_STATUS_DATA { + + // Size of this structure. + ULONG Version; + + // Whole size of the structure and the associated data buffer. + ULONG Size; + + ULONGLONG T10VendorId; + + ULONG DataSet1Length; + ULONG DataSet2Length; + ULONG DataSet3Length; + ULONG DataSet4Length; + + UCHAR StatusDataVersion; + UCHAR Reserved[3]; + UCHAR ReasonIdentifier[128]; + ULONG StatusDataLength; + UCHAR StatusData[ANYSIZE_ARRAY]; + +} DEVICE_INTERNAL_STATUS_DATA, *PDEVICE_INTERNAL_STATUS_DATA; + +// +// IOCTL_STORAGE_REINITIALIZE_MEDIA +// +// Input Buffer : +// STORAGE_REINITIALIZE_MEDIA - Optional +// Output Buffer : +// None +// + +typedef enum _STORAGE_SANITIZE_METHOD { + StorageSanitizeMethodDefault = 0, + StorageSanitizeMethodBlockErase, + StorageSanitizeMethodCryptoErase +} STORAGE_SANITIZE_METHOD, *PSTORAGE_SANITIZE_METHOD; + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int to disable this around the struct + +typedef struct _STORAGE_REINITIALIZE_MEDIA { + + ULONG Version; + + ULONG Size; + + ULONG TimeoutInSeconds; + + // + // The SanitizeOption field is only applicable to NVMe devices. + // + struct { + + // + // This field specifies the sanitize method defined in STORAGE_SANITIZE_METHOD enum. + // + ULONG SanitizeMethod : 4; + + // + // This field specifies if unrestricted sanitize exit is allowed or not. + // By default unrestricted sanitize exit is allowed. + // + ULONG DisallowUnrestrictedSanitizeExit : 1; + + ULONG Reserved : 27; + } SanitizeOption; + +} STORAGE_REINITIALIZE_MEDIA, *PSTORAGE_REINITIALIZE_MEDIA; + +#pragma warning(pop) + + +#pragma warning(push) +#pragma warning(disable:4200) + +#if defined(_MSC_EXTENSIONS) + +typedef struct _STORAGE_MEDIA_SERIAL_NUMBER_DATA { + + USHORT Reserved; + + // + // the SerialNumberLength will be set to zero + // if the command is supported and the media + // does not have a valid serial number. + // + + USHORT SerialNumberLength; + + // + // the following data is binary, and is not guaranteed + // to be NULL terminated. this is an excercise for the + // caller. + // + +#if !defined(__midl) + UCHAR SerialNumber[0]; +#endif + +} STORAGE_MEDIA_SERIAL_NUMBER_DATA, *PSTORAGE_MEDIA_SERIAL_NUMBER_DATA; + +#endif /* _MSC_EXTENSIONS */ + +typedef _Struct_size_bytes_(Size) struct _STORAGE_READ_CAPACITY { + + // + // The version number, size of the STORAGE_READ_CAPACITY structure + // + ULONG Version; + + // + // The size of the date returned, size of the STORAGE_READ_CAPACITY structure + // + ULONG Size; + + // + // Number of bytes per block + // + + ULONG BlockLength; + + // + // Total number of blocks in the disk + // This will have the last LBA + 1 + // + + LARGE_INTEGER NumberOfBlocks; + + // + // Disk size in bytes + // + + LARGE_INTEGER DiskLength; + +} STORAGE_READ_CAPACITY, *PSTORAGE_READ_CAPACITY; + +#pragma warning(pop) + +// +// Device write cache property +// +// This property provides the write cache information +// about the target device. +// + +typedef enum _WRITE_CACHE_TYPE { + WriteCacheTypeUnknown, + WriteCacheTypeNone, + WriteCacheTypeWriteBack, + WriteCacheTypeWriteThrough +} WRITE_CACHE_TYPE; + +typedef enum _WRITE_CACHE_ENABLE { + WriteCacheEnableUnknown, + WriteCacheDisabled, + WriteCacheEnabled +} WRITE_CACHE_ENABLE; + +typedef enum _WRITE_CACHE_CHANGE { + WriteCacheChangeUnknown, + WriteCacheNotChangeable, + WriteCacheChangeable +} WRITE_CACHE_CHANGE; + +typedef enum _WRITE_THROUGH { + WriteThroughUnknown, + WriteThroughNotSupported, + WriteThroughSupported +} WRITE_THROUGH; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_WRITE_CACHE_PROPERTY { + + // + // The version number + // Size of STORAGE_WRITE_CACHE_PROPERTY structure + // + + ULONG Version; + + // + // The size of the date returned + // Size of STORAGE_WRITE_CACHE_PROPERTY structure + // + + ULONG Size; + + // + // Current write cache type + // + + WRITE_CACHE_TYPE WriteCacheType; + + // + // Current write cache value + // + + WRITE_CACHE_ENABLE WriteCacheEnabled; + + // + // Device write cache change capability + // + + WRITE_CACHE_CHANGE WriteCacheChangeable; + + // + // Device write through support capability + // + + WRITE_THROUGH WriteThroughSupported; + + // + // Device flush cache capability + // + + BOOLEAN FlushCacheSupported; + + // + // User selected power protection option through registry + // + + BOOLEAN UserDefinedPowerProtection; + + // + // Device has battery backup for write cache + // + + BOOLEAN NVCacheEnabled; + +} STORAGE_WRITE_CACHE_PROPERTY, *PSTORAGE_WRITE_CACHE_PROPERTY; + +#pragma warning(push) +#pragma warning(disable:4200) // array[0] +#pragma warning(disable:4201) // nameless struct/unions +#pragma warning(disable:4214) // bit fields other than int + + +#if defined(_MSC_EXTENSIONS) + +typedef struct _PERSISTENT_RESERVE_COMMAND { + + ULONG Version; + ULONG Size; + + union { + + struct { + + // + // Persistent Reserve service action. + // + + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + + // + // Number of bytes allocated for returned parameter list. + // + + USHORT AllocationLength; + + } PR_IN; + + struct { + + // + // Persistent Reserve service action. + // + + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + + // + // Persistent Reserve type and scope. + // + + UCHAR Type : 4; + UCHAR Scope : 4; + + // + // Space for additional PR Out parameters. + // + +#if !defined(__midl) + UCHAR ParameterList[0]; +#endif + + } PR_OUT; + } DUMMYUNIONNAME; + +} PERSISTENT_RESERVE_COMMAND, *PPERSISTENT_RESERVE_COMMAND; + +#endif /* _MSC_EXTENSIONS */ +#pragma warning(pop) + +// +// Device telemetry definitions +// +// Structures and interfaces dealing with acquistion of device and driver internal telemetry. +// + +// For variable size fields we use byte array, defined with zero length in structure template. Length of the field is stored as a separate field. +// No more than one variable size field is allowed in one structure and it is always placed last. + +#pragma warning(push) + + +// +// Persistent data structures are versioned and "sized" by adding structure version field and structure size field +// +#define DEVICEDUMP_STRUCTURE_VERSION_V1 1 + +// +// Max size of the identification string +// +#define DEVICEDUMP_MAX_IDSTRING 32 // Keep proportional to sizeof (ULONG) +#define MAX_FW_BUCKET_ID_LENGTH 132 // 128 (ACS specification + 1 for zero termination + 3 to align on ULONG) + + +// +// Global telemetry collection parameters in the registry +// +#define STORAGE_CRASH_TELEMETRY_REGKEY L"\\Registry\\Machine\\System\\CurrentControlSet\\Control\\CrashControl\\StorageTelemetry" +#define STORAGE_DEVICE_TELEMETRY_REGKEY L"\\Registry\\Machine\\System\\CurrentControlSet\\Control\\Storage\\StorageTelemetry" + +// +// Reasons for telemetry collection +// +typedef enum _DEVICEDUMP_COLLECTION_TYPE { + TCCollectionBugCheck = 1, // 1 + TCCollectionApplicationRequested, // 2 (Host Initiated - HITC) + TCCollectionDeviceRequested // 3 (Device initiated - DITC) +} DEVICEDUMP_COLLECTION_TYPEIDE_NOTIFICATION_TYPE, *PDEVICEDUMP_COLLECTION_TYPE; + +// +// Flags for the device dump section +// +#define DDUMP_FLAG_DATA_READ_FROM_DEVICE 0x0001 + +// +// Firmware issue IDs (similar to bug check reasons) +// +#define FW_ISSUEID_NO_ISSUE 0x00000000 +#define FW_ISSUEID_UNKNOWN 0xFFFFFFFF + +// +#include // Structures are packed on a byte boundary , because parsers may run on separate machines and different OS flavors + +// +// Device dump section contains common device dump header, followed by set of relative pointers to sub sections +// Each relative pointer contain size in bytes of the subsection and starting offset from the beginning of the section +// +// Layout of the device dump section is as +// +// HEADER - common descriptor +// PUBLIC DATA - publicly accessible data (eg SMART structures) +// RESRICTED DATA - restricted access data (eg encrypted with Microsoft and IHV public keys) +// PRIVATE DATA - private device data +// +// All fields in the section definition are used cross platform => types used are platform neutral +// + +// +// Relative descript or of a subsection, contains size of the subsection and relative offset (0 is the start of the section) +// +typedef struct _DEVICEDUMP_SUBSECTION_POINTER { + ULONG dwSize; // Size (in bytes) of the subsection + ULONG dwFlags; // Parameter flags for the subsection + ULONG dwOffset; // Offset (in bytes) of the subsection block from the start of the buffer +} DEVICEDUMP_SUBSECTION_POINTER,*PDEVICEDUMP_SUBSECTION_POINTER; + +// +// Data structure tagging fields (version and size) +// +typedef struct _DEVICEDUMP_STRUCTURE_VERSION { + // + // Header signature, useful for identifying the structure when reading the dump + // + ULONG dwSignature; + + // + // Version of the template + // + ULONG dwVersion; + + // + // Size of the parent structure in bytes + // + ULONG dwSize; + +} DEVICEDUMP_STRUCTURE_VERSION, *PDEVICEDUMP_STRUCTURE_VERSION; + +// +// Device data header for the secondary data (in crashdump) section , holding device dump information. +// +typedef struct _DEVICEDUMP_SECTION_HEADER { + // + // GUID, identifying device dump section. Same GUID as used in registering for SecondaryData callback, stored here for live telemetry interface consistency + // + GUID guidDeviceDataId; + + // + // Device identification fields. + // These fields together should uniquely identify the device firmware image. + + // + // ID value, common for storage device vendors. This ID will be used by !analyze to create a vendor ID for WinQual. + // + // + // Unique identifier assigned to the organization responsible for device quality (firmware quality). In most cases this is OUID (IEEE) or WorldWideName of the device vendor + // + UCHAR sOrganizationID[16]; + + // + // Firmware revision as indicated in IDENITFY or INQUIRY structures + // + ULONG dwFirmwareRevision; + + // + // Device model number (keep the length of the field proportional to sizeof (ULONG)) + // + UCHAR sModelNumber[DEVICEDUMP_MAX_IDSTRING]; + + // + // Vendor specific device cookie, identifying process and manufacturing parameters. Opaque to the OS and applications. + // + UCHAR szDeviceManufacturingID[DEVICEDUMP_MAX_IDSTRING]; // Keep the length of the field proportional to sizeof (ULONG) + + // + // Sourcing indicator flag - used to detect if data was emulated from other structures or obtained directly from the firmware using log command + // Set to 1 if public data was filled in using data from the device telemetry log + // Set to 0 if the device doesn't support the command and the driver filled in as best it could + // + ULONG dwFlags; + + // + // Version of private data as indicated by the firmware.Initially always 0 to specify Private only unspecified data + // + ULONG bRestrictedPrivateDataVersion; + + // + // Issue identifier (hash value) generated by the firmware. Reflects state of the device firmware and used for cross device type/vendor queries. + // We will rely on standardized namespace of issue IDs and good will of firmware developers to taxonomize + // + ULONG dwFirmwareIssueId; //currently unused + + // + // Firmware bucket ID - long string, opague to Windows , but useful to create unique bucket in concatenation with device identification data + // + UCHAR szIssueDescriptionString[MAX_FW_BUCKET_ID_LENGTH]; // zero terminated + +} DEVICEDUMP_SECTION_HEADER, *PDEVICEDUMP_SECTION_HEADER; + +// +// Public subsection header - subsection is holding data, describing device state and accessible to everybody. +// + +#define TC_PUBLIC_DEVICEDUMP_CONTENT_SMART 0x01 +#define TC_PUBLIC_DEVICEDUMP_CONTENT_GPLOG 0x02 + +// +// Maximum number of log pages collected into the public section +#define TC_PUBLIC_DEVICEDUMP_CONTENT_GPLOG_MAX 16 + +// Maximum length of the description of the collected pages (filled by the miniport) +#define TC_DEVICEDUMP_SUBSECTION_DESC_LENGTH 16 + +// +// Standard types of collected pages +// +#define TC_PUBLIC_DATA_TYPE_ATAGP "ATAGPLogPages" +#define TC_PUBLIC_DATA_TYPE_ATASMART "ATASMARTPages" + +// +// Public data is tagged with the table of "log descriptors". Each descriptor has LogAddress and number of pages. +// Specific meaning, assigned to the descriptor, is relative to the command set used. +// + +typedef struct _GP_LOG_PAGE_DESCRIPTOR { + USHORT LogAddress; + USHORT LogSectors; +} GP_LOG_PAGE_DESCRIPTOR,*PGP_LOG_PAGE_DESCRIPTOR; + +typedef struct _DEVICEDUMP_PUBLIC_SUBSECTION { + ULONG dwFlags; + GP_LOG_PAGE_DESCRIPTOR GPLogTable[TC_PUBLIC_DEVICEDUMP_CONTENT_GPLOG_MAX]; + CHAR szDescription[TC_DEVICEDUMP_SUBSECTION_DESC_LENGTH]; // Zero terminated + UCHAR bData[ANYSIZE_ARRAY]; // Data byte array ANYSIZE_ARRAY +} DEVICEDUMP_PUBLIC_SUBSECTION, *PDEVICEDUMP_PUBLIC_SUBSECTION; + +// +// Restricted subsection header - subsection is holding data, describing device state and accessible only to Microsoft and a device vendor +// +typedef struct _DEVICEDUMP_RESTRICTED_SUBSECTION { + + UCHAR bData[ANYSIZE_ARRAY]; // Data byte array (ANYSIZE_ARRAY) + +} DEVICEDUMP_RESTRICTED_SUBSECTION, *PDEVICEDUMP_RESTRICTED_SUBSECTION; + +// +// Private subsection header - subsection is holding data, describing device state and accessible only to a device vendor +// +typedef struct _DEVICEDUMP_PRIVATE_SUBSECTION { + + ULONG dwFlags; + GP_LOG_PAGE_DESCRIPTOR GPLogId; + + UCHAR bData[ANYSIZE_ARRAY]; // Data byte array (ANYSIZE_ARRAY) + +} DEVICEDUMP_PRIVATE_SUBSECTION, *PDEVICEDUMP_PRIVATE_SUBSECTION; + +// +// Descriptor of the storage device dump section +// +typedef _Struct_size_bytes_(Descriptor.dwSize) struct _DEVICEDUMP_STORAGEDEVICE_DATA { + + // + // Common descriptor (signature,version of the structure) + // + DEVICEDUMP_STRUCTURE_VERSION Descriptor; + + // + // Header - set of fields, describing dump section and device (not requiring protocol communication) + // + DEVICEDUMP_SECTION_HEADER SectionHeader; + + // + // Size of the whole section buffer, in bytes , including header and sum total of all the variable sized sub sections + // + ULONG dwBufferSize; + + // + // Reason for collecting telemetry + // + ULONG dwReasonForCollection; + + // + // "Pointers" to individual sub-sections. Sub sections are filled with the information, obtained from the device + // + DEVICEDUMP_SUBSECTION_POINTER PublicData; + DEVICEDUMP_SUBSECTION_POINTER RestrictedData; + DEVICEDUMP_SUBSECTION_POINTER PrivateData; + +} DEVICEDUMP_STORAGEDEVICE_DATA, *PDEVICEDUMP_STORAGEDEVICE_DATA; + + +// +// Driver dump section contains common device driver context information: +// - circular buffer of the IO requests as visible by the lower edge of the driver +// (in case of storage that would be an interface to the controller stack or controller itself) +// +// All fields in the section definition are used cross platform => types used are platform neutral +// + +// +// Format of the single record for publicly accessible driver state table +// + +#define CDB_SIZE 16 +#define TELEMETRY_COMMAND_SIZE 16 + +#define TCRecordStorportSrbFunction Command[0] + +typedef struct _DEVICEDUMP_STORAGESTACK_PUBLIC_STATE_RECORD { + // The CDB for this request. variable sized CDBs are truncated. + UCHAR Cdb[CDB_SIZE]; + + // The actual command for this request. + UCHAR Command[TELEMETRY_COMMAND_SIZE]; + + // the time when driver received the request + ULONGLONG StartTime; + + // the system time when the request was completed + ULONGLONG EndTime; + + // Status value () + ULONG OperationStatus; + + // Error value (eg error reg for ATAPort, SCSI error for storport) + ULONG OperationError; + + // Stack specific information + union { + struct { + ULONG dwReserved; + } ExternalStack; + + struct { + ULONG dwAtaPortSpecific; + } AtaPort; + + struct { + ULONG SrbTag ; + } StorPort; + + } StackSpecific; + +} DEVICEDUMP_STORAGESTACK_PUBLIC_STATE_RECORD,*PDEVICEDUMP_STORAGESTACK_PUBLIC_STATE_RECORD; + + +typedef _Struct_size_bytes_(Descriptor.dwSize) struct _DEVICEDUMP_STORAGESTACK_PUBLIC_DUMP { + + // + // Common descriptor (signature,version of the structure) + // + DEVICEDUMP_STRUCTURE_VERSION Descriptor; + + // + // Reason for collecting telemetry + // + ULONG dwReasonForCollection; + + // + // Driver stack and instance + // + UCHAR cDriverName[16]; + + // + // Standardized log of IO requests issued to the target, starting with number of records. + // Log is circular, order is not guaranteed + // + ULONG uiNumRecords; + + DEVICEDUMP_STORAGESTACK_PUBLIC_STATE_RECORD RecordArray[ANYSIZE_ARRAY]; //ANYSIZE_ARRAY + +} DEVICEDUMP_STORAGESTACK_PUBLIC_DUMP,*PDEVICEDUMP_STORAGESTACK_PUBLIC_DUMP; + +// End of the packed structure group +#include + + +// +// Telemetry information block descriptor - bit flags in DumpCapabilities field +// + +#define DEVICEDUMP_CAP_PRIVATE_SECTION 0x00000001 // Target supports private data +#define DEVICEDUMP_CAP_RESTRICTED_SECTION 0x00000002 // Target supports restricted data + + + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int + +// +// IOCTL_STORAGE_ENABLE_IDLE_POWER +// +// Input Buffer: +// A STORAGE_IDLE_POWER structure specifying the idle power management +// properties of the device. +// +// Output Buffer: +// None. +// +typedef struct _STORAGE_IDLE_POWER { + ULONG Version; // Structure version, should be set to 1 for Win8. + ULONG Size; // Size of this structure in bytes. + ULONG WakeCapableHint : 1; // Storage device supports wake from low power states. + ULONG D3ColdSupported : 1; // Storage device supports D3Cold + ULONG Reserved : 30; + ULONG D3IdleTimeout; // Idle time in msec before storage device is transitioned to D3 (max of ~49.7 days). +} STORAGE_IDLE_POWER, *PSTORAGE_IDLE_POWER; + +#pragma warning(pop) + +// +// IOCTL_STORAGE_GET_IDLE_POWERUP_REASON +// +// Input Buffer: +// None. +// +// Output Buffer: +// A STORAGE_IDLE_POWERUP_REASON structure specifying what caused the power up. +// +typedef enum _STORAGE_POWERUP_REASON_TYPE { + StoragePowerupUnknown = 0, + StoragePowerupIO, + StoragePowerupDeviceAttention +} STORAGE_POWERUP_REASON_TYPE, *PSTORAGE_POWERUP_REASON_TYPE; + +typedef struct _STORAGE_IDLE_POWERUP_REASON { + ULONG Version; // Structure version, should be set to 1 for Win8. + ULONG Size; // Size of this structure in bytes. + STORAGE_POWERUP_REASON_TYPE PowerupReason; // The reason for the power up (see above). +} STORAGE_IDLE_POWERUP_REASON, *PSTORAGE_IDLE_POWERUP_REASON; + +#define STORAGE_IDLE_POWERUP_REASON_VERSION_V1 1 + +// +// IOCTL_STORAGE_DEVICE_POWER_CAP +// +// This IOCTL specifies a maximum *operational* power consumption level for a +// storage device. +// The storage stack will do its best to transition the device to a power state +// that will not exceed the given maximum. However, this depends on what the +// device supports. The actual maximum may be less than or greater than the +// desired maximum. +// +// Input buffer: +// A STORAGE_DEVICE_POWER_CAP structure. +// * The Units field specifies the units of the MaxPower field. It can be +// either a percentage (0-100%) or an absolute value in milliwatts. +// * The MaxPower field is used to set the desired maximum power consumption +// value for the storage device. +// +// Output buffer: +// On success, the output buffer will contain a STORAGE_DEVICE_POWER_CAP +// structure. +// * The Units field will continue to specify the units of the MaxPower field +// and will match the value from the input buffer. +// * The MaxPower field will contain the value of the actual maximum +// power consumption level of the device. This may be equal to, less than, +// or greater than the desired cap, depending on what the device supports. +// +typedef enum _STORAGE_DEVICE_POWER_CAP_UNITS { + StorageDevicePowerCapUnitsPercent, + StorageDevicePowerCapUnitsMilliwatts +} STORAGE_DEVICE_POWER_CAP_UNITS, *PSTORAGE_DEVICE_POWER_CAP_UNITS; + +typedef struct _STORAGE_DEVICE_POWER_CAP { + ULONG Version; + ULONG Size; + STORAGE_DEVICE_POWER_CAP_UNITS Units; + ULONGLONG MaxPower; +} STORAGE_DEVICE_POWER_CAP, *PSTORAGE_DEVICE_POWER_CAP; + +#define STORAGE_DEVICE_POWER_CAP_VERSION_V1 1 + +// +// IOCTL_STORAGE_RPMB_COMMAND +// +// This IOCTL sends an RPMB command to the underlying storage device. +// +// Input buffer: +// An array of STORAGE_RPMB_DATA_FRAME structures +// * The number of frames included can be calculated by InputBufferLength / sizeof(STORAGE_RPMB_DATA_FRAME) +// +// Output buffer: +// An array of STORAGE_RPMB_DATA_FRAME structures +// * The number of frames included can be calculated by OutputBufferLength / sizeof(STORAGE_RPMB_DATA_FRAME) +// + +// Ensure we are byte aligned +#pragma pack(push) +#pragma pack(1) + +// +// This is the RPMB data frame used to compose all RPMB requests and responses. +// +// This corresponds to StorageRpmbFrameTypeStandard +// + +typedef struct _STORAGE_RPMB_DATA_FRAME { + + // + // Reserved + // + UCHAR Stuff[196]; + + // + // Either the key to be programmed or the MAC authenticating this frame or series of frames + // + UCHAR KeyOrMAC[32]; + + // + // The data input or output + // + UCHAR Data[256]; + + // + // Random 128-bit number generated by host + // + UCHAR Nonce[16]; + + // + // 32-bit counter + // + UCHAR WriteCounter[4]; + + // + // The half-sector address to operate on + // + UCHAR Address[2]; + + // + // The count of half-sector blocks to read/write + // + UCHAR BlockCount[2]; + + // + // The result of the operation + // + UCHAR OperationResult[2]; + + // + // The type of request or response + // + UCHAR RequestOrResponseType[2]; + +} STORAGE_RPMB_DATA_FRAME, *PSTORAGE_RPMB_DATA_FRAME; + +// +// RPMB RequestOrResponseType Values +// + +typedef enum _STORAGE_RPMB_COMMAND_TYPE { + StorRpmbProgramAuthKey = 0x00000001, + StorRpmbQueryWriteCounter = 0x00000002, + StorRpmbAuthenticatedWrite = 0x00000003, + StorRpmbAuthenticatedRead = 0x00000004, + StorRpmbReadResultRequest = 0x00000005, + StorRpmbAuthenticatedDeviceConfigWrite = 0x00000006, + StorRpmbAuthenticatedDeviceConfigRead = 0x00000007, +} STORAGE_RPMB_COMMAND_TYPE, *PSTORAGE_RPMB_COMMAND_TYPE; + +#pragma pack(pop) + +// +// IOCTL_STORAGE_EVENT_NOTIFICATION +// +// Input Buffer: +// A STORAGE_EVENT_NOTIFICATION structure specifying the event(s) that occurred. +// +// Output Buffer: +// None +// +typedef struct _STORAGE_EVENT_NOTIFICATION { + ULONG Version; // Structure version, should be set to 1 for Win8. + ULONG Size; // Size of this structure in bytes. + ULONGLONG Events; // Bitmask of event(s) that occurred. +} STORAGE_EVENT_NOTIFICATION, *PSTORAGE_EVENT_NOTIFICATION; + +#define STORAGE_EVENT_NOTIFICATION_VERSION_V1 1 + +#define STORAGE_EVENT_MEDIA_STATUS 0x0000000000000001 +#define STORAGE_EVENT_DEVICE_STATUS 0x0000000000000002 +#define STORAGE_EVENT_DEVICE_OPERATION 0x0000000000000004 + +#define STORAGE_EVENT_ALL (STORAGE_EVENT_MEDIA_STATUS | STORAGE_EVENT_DEVICE_STATUS | STORAGE_EVENT_DEVICE_OPERATION) + +#pragma warning(pop) + + +#define READ_COPY_NUMBER_KEY 0x52434e00 // 'RCN' +#define READ_COPY_NUMBER_BYPASS_CACHE_FLAG 0x00000100 + +#define IsKeyReadCopyNumber(_k) (((_k) & 0xFFFFFE00) == READ_COPY_NUMBER_KEY) + +#define IsKeyReadCopyNumberBypassCache(_k) ((_k) & READ_COPY_NUMBER_BYPASS_CACHE_FLAG) +#define SetReadCopyNumberBypassCacheToKey(_k) ((_k) |= READ_COPY_NUMBER_BYPASS_CACHE_FLAG) + +#define ReadCopyNumberToKey(_c) (READ_COPY_NUMBER_KEY | (UCHAR)(_c)) +#define ReadCopyNumberFromKey(_k) (UCHAR)((_k) & 0x000000FF) + + +// +// IOCTL_STORAGE_GET_COUNTERS +// +// This IOCTL retrieves reliability counters for a storage device. +// +// The caller can find out the required output buffer size by simply sending +// down a single STORAGE_COUNTERS structure. STATUS_BUFFER_OVERFLOW will be +// returned and the Size field in the STORAGE_COUNTERS structure will contain +// the total size of the required output buffer. +// +// When the output buffer is sufficiently large, STATUS_SUCCESS will be +// returned and the output buffer will contain a STORAGE_COUNTERS structure +// followed by an array of STORAGE_COUNTER structures. +// +// Input Buffer: +// STORAGE_COUNTERS with the Version field set appropriately. +// +// Output Buffer: +// When successful, a STORAGE_COUNTERS structure with the Counters array +// filled out. NumberOfCounters will indicate the number of elements in +// the Counters array. +// See above for more details. +// + +typedef enum _STORAGE_COUNTER_TYPE { + + StorageCounterTypeUnknown = 0, + + StorageCounterTypeTemperatureCelsius, + StorageCounterTypeTemperatureCelsiusMax, + StorageCounterTypeReadErrorsTotal, + StorageCounterTypeReadErrorsCorrected, + StorageCounterTypeReadErrorsUncorrected, + StorageCounterTypeWriteErrorsTotal, + StorageCounterTypeWriteErrorsCorrected, + StorageCounterTypeWriteErrorsUncorrected, + StorageCounterTypeManufactureDate, + StorageCounterTypeStartStopCycleCount, + StorageCounterTypeStartStopCycleCountMax, + StorageCounterTypeLoadUnloadCycleCount, + StorageCounterTypeLoadUnloadCycleCountMax, + StorageCounterTypeWearPercentage, + StorageCounterTypeWearPercentageWarning, + StorageCounterTypeWearPercentageMax, + StorageCounterTypePowerOnHours, + StorageCounterTypeReadLatency100NSMax, + StorageCounterTypeWriteLatency100NSMax, + StorageCounterTypeFlushLatency100NSMax, + + StorageCounterTypeMax + +} STORAGE_COUNTER_TYPE, *PSTORAGE_COUNTER_TYPE; + +typedef struct _STORAGE_COUNTER { + + STORAGE_COUNTER_TYPE Type; + + union { + + struct { + // + // Week is the number of the week in the year, 1-52. + // + ULONG Week; + + // + // Year is the last two digits of the year, e.g. 2016 is simply "16". + // + ULONG Year; + } ManufactureDate; + + ULONGLONG AsUlonglong; + } Value; + +} STORAGE_COUNTER, *PSTORAGE_COUNTER; + +typedef _Struct_size_bytes_(Size) struct _STORAGE_COUNTERS { + + // + // Size of this structure serves as the version. + // + ULONG Version; + + // + // Total size of this structure plus all the variable-sized fields. + // + ULONG Size; + + ULONG NumberOfCounters; + + _Field_size_(NumberOfCounters) STORAGE_COUNTER Counters[ANYSIZE_ARRAY]; + +} STORAGE_COUNTERS, *PSTORAGE_COUNTERS; + +#define STORAGE_COUNTERS_VERSION_V1 sizeof(STORAGE_COUNTERS) + +// +// Parameter and data structure for firmware upgrade IOCTLs +// IOCTL_STORAGE_FIRMWARE_GET_INFO, IOCTL_STORAGE_FIRMWARE_DOWNLOAD, IOCTL_STORAGE_FIRMWARE_ACTIVATE +// + +// +// Indicate the target of the request other than the device handle/object itself. +// This is used in "Flags" field of data structures for firmware upgrade request. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_CONTROLLER 0x00000001 + +// +// Indicate that current FW image segment is the last one. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_LAST_SEGMENT 0x00000002 + +// +// Indicate that current FW image segment is the first one. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_FIRST_SEGMENT 0x00000004 + +// +// Indicate that the existing firmware in slot should be activated immediately without +// controller reset. Only valid for IOCTL_STORAGE_FIRMWARE_ACTIVATE. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_SWITCH_TO_FIRMWARE_WITHOUT_RESET 0x10000000 + +// +// Indicate that any existing firmware in slot should be replaced with the downloaded image, +// and activated with controller reset. Only valid for IOCTL_STORAGE_FIRMWARE_ACTIVATE. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_REPLACE_AND_SWITCH_UPON_RESET 0x20000000 + +// +// Indicate that any existing firmware in slot should be replaced with the downloaded image. +// Only valid for IOCTL_STORAGE_FIRMWARE_ACTIVATE. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_REPLACE_EXISTING_IMAGE 0x40000000 + +// +// Indicate that the existing firmware in slot should be activated with a controller reset. +// Only valid for IOCTL_STORAGE_FIRMWARE_ACTIVATE. +// +#define STORAGE_HW_FIRMWARE_REQUEST_FLAG_SWITCH_TO_EXISTING_FIRMWARE 0x80000000 + +// +// Input parameter for IOCTL_STORAGE_FIRMWARE_GET_INFO +// +typedef struct _STORAGE_HW_FIRMWARE_INFO_QUERY { + ULONG Version; // sizeof(STORAGE_FIRMWARE_INFO_QUERY) + ULONG Size; // Whole size of the buffer (in case this data structure being extended to be variable length) + ULONG Flags; + ULONG Reserved; +} STORAGE_HW_FIRMWARE_INFO_QUERY, *PSTORAGE_HW_FIRMWARE_INFO_QUERY; + +// +// Output parameter for IOCTL_STORAGE_FIRMWARE_GET_INFO +// The total size of returned data is for Firmware Info is: +// sizeof(STORAGE_HW_FIRMWARE_INFO) + sizeof(STORAGE_HW_FIRMWARE_SLOT_INFO) * (SlotCount - 1). +// If the buffer is not big enough, callee should set the required length in "Size" field of STORAGE_HW_FIRMWARE_INFO, +// + +// +// Following value maybe used in "PendingActiveSlot" field indicating there is no firmware pending to activate. +// +#define STORAGE_HW_FIRMWARE_INVALID_SLOT 0xFF + +#pragma warning(push) +#pragma warning(disable:4214) // bit fields other than int + +#define STORAGE_HW_FIRMWARE_REVISION_LENGTH 16 + +typedef struct _STORAGE_HW_FIRMWARE_SLOT_INFO { + + ULONG Version; // sizeof(STORAGE_HW_FIRMWARE_SLOT_INFO) + + ULONG Size; // size the data contained in STORAGE_HW_FIRMWARE_SLOT_INFO. + + UCHAR SlotNumber; + + UCHAR ReadOnly : 1; + + UCHAR Reserved0 : 7; + + UCHAR Reserved1[6]; + + UCHAR Revision[STORAGE_HW_FIRMWARE_REVISION_LENGTH]; + +} STORAGE_HW_FIRMWARE_SLOT_INFO, *PSTORAGE_HW_FIRMWARE_SLOT_INFO; + +typedef struct _STORAGE_HW_FIRMWARE_INFO { + + ULONG Version; // sizeof(STORAGE_HW_FIRMWARE_INFO) + + ULONG Size; // size of the whole buffer including slot[] + + UCHAR SupportUpgrade : 1; + + UCHAR Reserved0 : 7; + + UCHAR SlotCount; + + UCHAR ActiveSlot; + + UCHAR PendingActivateSlot; + + BOOLEAN FirmwareShared; // The firmware applies to both device and adapter. For example: PCIe SSD. + + UCHAR Reserved[3]; + + ULONG ImagePayloadAlignment; // Number of bytes. Max: PAGE_SIZE. The transfer size should be multiple of this unit size. Some protocol requires at least sector size. 0 means the value is not valid. + + ULONG ImagePayloadMaxSize; // for a single command. + + STORAGE_HW_FIRMWARE_SLOT_INFO Slot[ANYSIZE_ARRAY]; + +} STORAGE_HW_FIRMWARE_INFO, *PSTORAGE_HW_FIRMWARE_INFO; +#pragma warning(pop) + + +// +// Input parameter for IOCTL_STORAGE_FIRMWARE_DOWNLOAD +// +#pragma warning(push) +#pragma warning(disable:4200) + +typedef struct _STORAGE_HW_FIRMWARE_DOWNLOAD { + + ULONG Version; // sizeof(STORAGE_HW_FIRMWARE_DOWNLOAD) + ULONG Size; // size of the whole buffer include "ImageBuffer" + + ULONG Flags; + UCHAR Slot; // Slot number that firmware image will be downloaded into. + UCHAR Reserved[3]; + + ULONGLONG Offset; // Image file offset, should be aligned to "ImagePayloadAlignment" value from STORAGE_FIRMWARE_INFO. + ULONGLONG BufferSize; // should be multiple of "ImagePayloadAlignment" value from STORAGE_FIRMWARE_INFO. + + UCHAR ImageBuffer[ANYSIZE_ARRAY]; // firmware image file. + +} STORAGE_HW_FIRMWARE_DOWNLOAD, *PSTORAGE_HW_FIRMWARE_DOWNLOAD; + +typedef struct _STORAGE_HW_FIRMWARE_DOWNLOAD_V2 { + + ULONG Version; // sizeof(STORAGE_HW_FIRMWARE_DOWNLOAD_V2) + ULONG Size; // size of the whole buffer include "ImageBuffer" + + ULONG Flags; + UCHAR Slot; // Slot number that firmware image will be downloaded into. + UCHAR Reserved[3]; + + ULONGLONG Offset; // Image file offset, should be aligned to "ImagePayloadAlignment" value from STORAGE_FIRMWARE_INFO. + ULONGLONG BufferSize; // should be multiple of "ImagePayloadAlignment" value from STORAGE_FIRMWARE_INFO. + + ULONG ImageSize; // Firmware Image size. + ULONG Reserved2; + + UCHAR ImageBuffer[ANYSIZE_ARRAY]; // firmware image file. + +} STORAGE_HW_FIRMWARE_DOWNLOAD_V2, *PSTORAGE_HW_FIRMWARE_DOWNLOAD_V2; + +#pragma warning(pop) + +// +// Input parameter for IOCTL_STORAGE_FIRMWARE_ACTIVATE +// +typedef struct _STORAGE_HW_FIRMWARE_ACTIVATE { + + ULONG Version; + ULONG Size; + + ULONG Flags; + UCHAR Slot; // Slot with firmware image to be activated. + UCHAR Reserved0[3]; + +} STORAGE_HW_FIRMWARE_ACTIVATE, *PSTORAGE_HW_FIRMWARE_ACTIVATE; + +// +// Parameter for IOCTL_STORAGE_PROTOCOL_COMMAND +// Buffer layout: [Error Info Buffer] [Data-to-Device Buffer] [Data-from-Device Buffer] +// +#define STORAGE_PROTOCOL_STRUCTURE_VERSION 0x1 + +typedef struct _STORAGE_PROTOCOL_COMMAND { + + ULONG Version; // STORAGE_PROTOCOL_STRUCTURE_VERSION + ULONG Length; // sizeof(STORAGE_PROTOCOL_COMMAND) + + STORAGE_PROTOCOL_TYPE ProtocolType; + ULONG Flags; // Flags for the request + + ULONG ReturnStatus; // return value + ULONG ErrorCode; // return value, optional + + ULONG CommandLength; // non-zero value should be set by caller + ULONG ErrorInfoLength; // optional, can be zero + ULONG DataToDeviceTransferLength; // optional, can be zero. Used by WRITE type of request. + ULONG DataFromDeviceTransferLength; // optional, can be zero. Used by READ type of request. + + ULONG TimeOutValue; // in unit of seconds + + ULONG ErrorInfoOffset; // offsets need to be pointer aligned + ULONG DataToDeviceBufferOffset; // offsets need to be pointer aligned + ULONG DataFromDeviceBufferOffset; // offsets need to be pointer aligned + + ULONG CommandSpecific; // optional information passed along with Command. + ULONG Reserved0; + + ULONG FixedProtocolReturnData; // return data, optional. Some protocol, such as NVMe, may return a small amount data (DWORD0 from completion queue entry) without the need of separate device data transfer. + ULONG FixedProtocolReturnData2; // return data2, optional. Some protocol, such as NVMe, may return a small amount data (DWORD1 from completion queue entry) without the need of separate device data transfer. + ULONG Reserved1[2]; + + _Field_size_bytes_full_(CommandLength) UCHAR Command[ANYSIZE_ARRAY]; + +} STORAGE_PROTOCOL_COMMAND, *PSTORAGE_PROTOCOL_COMMAND; + +// +// Bit-mask values for STORAGE_PROTOCOL_COMMAND - "Flags" field. +// +#define STORAGE_PROTOCOL_COMMAND_FLAG_ADAPTER_REQUEST 0x80000000 // Flag indicates the request targeting to adapter instead of device. + +// +// Status values for STORAGE_PROTOCOL_COMMAND - "ReturnStatus" field. +// +#define STORAGE_PROTOCOL_STATUS_PENDING 0x0 +#define STORAGE_PROTOCOL_STATUS_SUCCESS 0x1 +#define STORAGE_PROTOCOL_STATUS_ERROR 0x2 +#define STORAGE_PROTOCOL_STATUS_INVALID_REQUEST 0x3 +#define STORAGE_PROTOCOL_STATUS_NO_DEVICE 0x4 +#define STORAGE_PROTOCOL_STATUS_BUSY 0x5 +#define STORAGE_PROTOCOL_STATUS_DATA_OVERRUN 0x6 +#define STORAGE_PROTOCOL_STATUS_INSUFFICIENT_RESOURCES 0x7 +#define STORAGE_PROTOCOL_STATUS_THROTTLED_REQUEST 0x8 + +#define STORAGE_PROTOCOL_STATUS_NOT_SUPPORTED 0xFF + +// +// Command Length for Storage Protocols. +// +#define STORAGE_PROTOCOL_COMMAND_LENGTH_NVME 0x40 // NVMe commands are always 64 bytes. + +// +// Command Specific Information for Storage Protocols - "CommandSpecific" field. +// +#define STORAGE_PROTOCOL_SPECIFIC_NVME_ADMIN_COMMAND 0x01 +#define STORAGE_PROTOCOL_SPECIFIC_NVME_NVM_COMMAND 0x02 + +// +// Additional notes when STORAGE_PROTOCOL_TYPE is ProtocolTypeNvme: +// 1. When flag STORAGE_PROTOCOL_COMMAND_FLAG_ADAPTER_REQUEST is set, or the request is sent through adapter, namespace Id from "Command" field is used; +// otherwise, the underneath driver should determine namespace Id from the device that receives the command. +// 2. When a command fails, the "ErrorCode" field contains value from NVMe Completion Queue Entry - DW3 - Status Field. +// 3. "CommandLength" field must have value of 64. i.e. STORAGE_PROTOCOL_COMMAND_LENGTH_NVME. +// 4. "CommandSpecific" field must have value of either STORAGE_PROTOCOL_SPECIFIC_NVME_ADMIN_COMMAND, or STORAGE_PROTOCOL_SPECIFIC_NVME_NVM_COMMAND. +// 5. When a command succeeds, field "FixedProtocolReturnData" may contain value from NVMe Completion Queue Entry - DW0. +// + +// +// IOCTL_STORAGE_ATTRIBUTE_MANAGEMENT +// +// This IOCTL manages an attribute +// for a storage device. +// +// When a driver receives this IOCTL it should first +// let any lower drivers process the IOCTL. +// The driver can override the completion status +// from the lower driver layers, if needed. +// For example when driver can provide +// the required functionality after +// doing "Action" on "Attribute", without any support +// from lower drivers, it can choose to ignore failure +// from lower driver layers, complete the "Action" +// and return success. +// +// Input Buffer: +// STORAGE_ATTRIBUTE_MGMT +// +// Output Buffer: +// None. +// + +// +// Valid Management Actions allowed +// on the Attribute +// +typedef enum _STORAGE_ATTRIBUTE_MGMT_ACTION { + StorAttributeMgmt_ClearAttribute = 0, + StorAttributeMgmt_SetAttribute = 1, + StorAttributeMgmt_ResetAttribute = 2 +} STORAGE_ATTRIBUTE_MGMT_ACTION, *PSTORAGE_ATTRIBUTE_MGMT_ACTION; + +// +// Valid Storage Device Attributes +// + +// +// Reserved for future usage. +// +#define STORATTRIBUTE_NONE 0 + +// +// When this attribute is reset, a driver reverts to its +// default state. The definition of default state is specific +// to each individual driver. +// +// Supported actions: Reset. +// +#define STORATTRIBUTE_MANAGEMENT_STATE 1 + +typedef struct _STORAGE_ATTRIBUTE_MGMT { + + // + // Size of this structure serves + // as the version. + // + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields. + // + ULONG Size; + + // + // Indicates what action is requested. + // + STORAGE_ATTRIBUTE_MGMT_ACTION Action; + + // + // The attribute on which specified "Action" + // needs to be taken. + // + ULONG Attribute; + +} STORAGE_ATTRIBUTE_MGMT, *PSTORAGE_ATTRIBUTE_MGMT; + +// end_winioctl + +#if (NTDDI_VERSION >= NTDDI_WIN10_CO) + +// +// Defines the bit for each supported features in storage drivers +// The supported features is defined in "StorageSupportedFeatures" as a DWORD value under +// "Parameters" registry key of the driver +// + +// +// Bypass IO feature. If set, the driver understands bypass IO and supports bypass IO related IOCTL(s). +// +#define STORAGE_SUPPORTED_FEATURES_BYPASS_IO 0x00000001 + + +// +// Supported Features Mask. This is "OR" of all defined bits of supported features. +// +#define STORAGE_SUPPORTED_FEATURES_MASK (STORAGE_SUPPORTED_FEATURES_BYPASS_IO) + +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/unions + +// +// ======= IOCTL_STORAGE_MANAGE_BYPASS_IO ====== +// + +// +// This IOCTL is used to control BypassIO operations in all layers of the +// volume and storage stacks +// + +// +// Defines the various operations supported by the BypassIO IOCTL +// + +typedef enum _BPIO_OPERATIONS { + + // + // This is a request to enable BypassIO for the given volume/disk (device) + // which means a driver may not see all reads/writes for that stack. + // + // On the pre-operation, if a driver can support BypassIO for the given + // device it should forward the request down the stack. + // + // On the pre-operation if a driver CAN NOT support BypassIO for the given + // device they should complete the FSCTL with STATUS_SUCCESS and update the + // BPIO_OUTPUT structure with appropriate OpStatus, FailingDriverNames, + // and FailureReason reasons. + // + // During the post-operation they can see if all drivers below them are + // capable of supporting BypassIO. If yes, the driver should preserve any + // needed state for the file and continue completion processing. It is the + // drivers responsibility to maintain state to properly handle requests that + // may not be compatible with the BypassIO enabled state. + // + // During the post-operation processing if a driver determines they can no + // longer support BypassIO, they can call to inform the stack below them + // that BypassIO is now disabled. They should set appropriate state as to + // why it can not be supported. + // + + BPIO_OP_ENABLE = 1, + + // + // This is a request to disable BypassIO for the given volume/disk. It allows + // a driver to cleanup any associated BypassIO state. + // + // This can be received by a driver that currently does not have BypassIO + // enabled. It should be ignored. + // + // This operation should not be failed. + // + + BPIO_OP_DISABLE = 2, + + // + // This is an informational request to see if BypassIO can be enabled for + // the given volume/disk. This should be processed the same as an ENABLE operation + // with the appropriate fields in the BPIO_OUTPUT structure filled out. The + // only difference is that the driver does not enter the ENABLE state. + // + + BPIO_OP_QUERY = 3 + +} BPIO_OPERATIONS; + + +// +// Defines the BypassIO INPUT flags +// + +typedef enum _BPIO_INFLAGS { + + BPIO_INFL_NONE = 0 + +} BPIO_INFLAGS; +DEFINE_ENUM_FLAG_OPERATORS( BPIO_INFLAGS ) + +// +// Defines the INPUT structure for IOCTL_STORAGE_MANAGE_BYPASS_IO +// + +typedef struct _BPIO_INPUT { + + // + // Size of this structure serves + // as the version. + // + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields. + // + ULONG Size; + + // + // The BypassIO operation being requested. + // + + BPIO_OPERATIONS Operation; + + // + // Input flags for this operation. + // + + BPIO_INFLAGS InFlags; + + ULONGLONG Reserved2; + +} BPIO_INPUT, *PBPIO_INPUT; + + +// +// Defines the BypassIO OUTPUT flags +// + +typedef enum _BPIO_OUTFLAGS { + + BPIO_OUTFL_NONE = 0 + +} BPIO_OUTFLAGS; +DEFINE_ENUM_FLAG_OPERATORS( BPIO_OUTFLAGS ) + +// +// This structure defines operation specific outputs for both the ENABLE +// and QUERY operations +// + +typedef struct _BPIO_RESULTS { + + // + // A status code that will be available to users which identifies WHY + // the specified driver can't support BypassIO. This should only be + // set by the first driver to fail the request. + // + + LONG OpStatus; // This should be NTSTATUS but it is not always available + + // + // Receives the name of the driver that failed the request. For diagnostic + // reasons it is required that drivers store their name when failing an + // ENABLE/QUERY requests. The name should match the actual name of the driver + // used by the system with extension. Ex: "ntfs.sys". + // + // FailingDriversNameLen contains the length of the string in CHARACTERS. + // No one should assume the string is NULL terminated. + // + + USHORT FailingDriverNameLen; + WCHAR FailingDriverName[32]; + + // + // Receives a reasonable description of why the driver can not support the + // ENABLE/QUERY request. This string is used for diagnostic reasons and should + // identify the WHY. + // + // This string should be in English and does not need to be localized. + // + // FailureReasonLen contains the length of the string in CHARACTERS. + // No one should assume the strings is NULL terminated. + // + + USHORT FailureReasonLen; + WCHAR FailureReason[128]; + +} BPIO_RESULTS, *PBPIO_RESULTS; + +// +// Defines the variable sized OUTPUT structure for IOCTL_STORAGE_MANAGE_BYPASS_IO +// + +typedef struct _BPIO_OUTPUT { + + // + // Size of this structure serves + // as the version. + // + ULONG Version; + + // + // Size of this structure plus + // all the variable sized fields. + // + ULONG Size; + + // + // The BypassIO operation being requested. This should be set to the + // same value passed in the input structure + // + + BPIO_OPERATIONS Operation; + + // + // Output flags for this operation. + // + + BPIO_OUTFLAGS OutFlags; + + ULONGLONG Reserved2; //reserved for future expansion + + // + // This defines operation specific outputs + // + + union { + + BPIO_RESULTS Enable; + BPIO_RESULTS Query; + }; + +} BPIO_OUTPUT, *PBPIO_OUTPUT; + +#define BPIO_OUTPUT_ENABLE_SIZE (sizeof(BPIO_OUTPUT)) +#define BPIO_OUTPUT_QUERY_SIZE (sizeof(BPIO_OUTPUT)) +#define BPIO_OUTPUT_DISABLE_SIZE ((size_t)FIELD_OFFSET(BPIO_OUTPUT, Enable)) +#define BPIO_OUTPUT_VOLUME_DISABLE_SIZE ((size_t)FIELD_OFFSET(BPIO_OUTPUT, Enable)) + +#pragma warning(pop) + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_CO) + +// begin_winioctl + + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#if defined __cplusplus && !defined __ALT_GENERATOR__ +} +#endif + +#endif // _NTDDSTOR_H_ +// end_winioctl + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtape.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtape.h new file mode 100644 index 0000000000000000000000000000000000000000..fb92fdebd646f500e8e2fb1db4786366c2ae965d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtape.h @@ -0,0 +1,368 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddtape.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Tape device. + +--*/ + +#ifndef _NTDDTAPE_ +#define _NTDDTAPE_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_TAPE_DEVICE_NAME "\\Device\\Tape" + + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define IOCTL_TAPE_BASE FILE_DEVICE_TAPE + +#define IOCTL_TAPE_ERASE CTL_CODE(IOCTL_TAPE_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_TAPE_PREPARE CTL_CODE(IOCTL_TAPE_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_WRITE_MARKS CTL_CODE(IOCTL_TAPE_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_TAPE_GET_POSITION CTL_CODE(IOCTL_TAPE_BASE, 0x0003, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_SET_POSITION CTL_CODE(IOCTL_TAPE_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_GET_DRIVE_PARAMS CTL_CODE(IOCTL_TAPE_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_SET_DRIVE_PARAMS CTL_CODE(IOCTL_TAPE_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_TAPE_GET_MEDIA_PARAMS CTL_CODE(IOCTL_TAPE_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_SET_MEDIA_PARAMS CTL_CODE(IOCTL_TAPE_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_GET_STATUS CTL_CODE(IOCTL_TAPE_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS ) +#define IOCTL_TAPE_CREATE_PARTITION CTL_CODE(IOCTL_TAPE_BASE, 0x000a, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// The following device control codes are common for all class drivers. The +// functions codes defined here must match all of the other class drivers. +// +// Warning: these codes will be replaced in the future with the IOCTL_STORAGE +// codes included below +// + +#define IOCTL_TAPE_MEDIA_REMOVAL CTL_CODE(IOCTL_TAPE_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_EJECT_MEDIA CTL_CODE(IOCTL_TAPE_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_LOAD_MEDIA CTL_CODE(IOCTL_TAPE_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_RESERVE CTL_CODE(IOCTL_TAPE_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_RELEASE CTL_CODE(IOCTL_TAPE_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) + +#if (NTDDI_VERSION < NTDDI_WS03) +#define IOCTL_TAPE_CHECK_VERIFY CTL_CODE(IOCTL_TAPE_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_TAPE_FIND_NEW_DEVICES CTL_CODE(IOCTL_DISK_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) +#endif +// +// The following file contains the IOCTL_STORAGE class ioctls +// + +#include + +// begin_winnt begin_ntminitape + +#ifndef _NTDDTAPE_WINNT_ +#define _NTDDTAPE_WINNT_ + +// +// IOCTL_TAPE_ERASE definitions +// + +#define TAPE_ERASE_SHORT 0L +#define TAPE_ERASE_LONG 1L + +typedef struct _TAPE_ERASE { + ULONG Type; + BOOLEAN Immediate; +} TAPE_ERASE, *PTAPE_ERASE; + +// +// IOCTL_TAPE_PREPARE definitions +// + +#define TAPE_LOAD 0L +#define TAPE_UNLOAD 1L +#define TAPE_TENSION 2L +#define TAPE_LOCK 3L +#define TAPE_UNLOCK 4L +#define TAPE_FORMAT 5L + +typedef struct _TAPE_PREPARE { + ULONG Operation; + BOOLEAN Immediate; +} TAPE_PREPARE, *PTAPE_PREPARE; + +// +// IOCTL_TAPE_WRITE_MARKS definitions +// + +#define TAPE_SETMARKS 0L +#define TAPE_FILEMARKS 1L +#define TAPE_SHORT_FILEMARKS 2L +#define TAPE_LONG_FILEMARKS 3L + +typedef struct _TAPE_WRITE_MARKS { + ULONG Type; + ULONG Count; + BOOLEAN Immediate; +} TAPE_WRITE_MARKS, *PTAPE_WRITE_MARKS; + +// +// IOCTL_TAPE_GET_POSITION definitions +// + +#define TAPE_ABSOLUTE_POSITION 0L +#define TAPE_LOGICAL_POSITION 1L +#define TAPE_PSEUDO_LOGICAL_POSITION 2L + +typedef struct _TAPE_GET_POSITION { + ULONG Type; + ULONG Partition; + LARGE_INTEGER Offset; +} TAPE_GET_POSITION, *PTAPE_GET_POSITION; + +// +// IOCTL_TAPE_SET_POSITION definitions +// + +#define TAPE_REWIND 0L +#define TAPE_ABSOLUTE_BLOCK 1L +#define TAPE_LOGICAL_BLOCK 2L +#define TAPE_PSEUDO_LOGICAL_BLOCK 3L +#define TAPE_SPACE_END_OF_DATA 4L +#define TAPE_SPACE_RELATIVE_BLOCKS 5L +#define TAPE_SPACE_FILEMARKS 6L +#define TAPE_SPACE_SEQUENTIAL_FMKS 7L +#define TAPE_SPACE_SETMARKS 8L +#define TAPE_SPACE_SEQUENTIAL_SMKS 9L + +typedef struct _TAPE_SET_POSITION { + ULONG Method; + ULONG Partition; + LARGE_INTEGER Offset; + BOOLEAN Immediate; +} TAPE_SET_POSITION, *PTAPE_SET_POSITION; + +// +// IOCTL_TAPE_GET_DRIVE_PARAMS definitions +// + +// +// Definitions for FeaturesLow parameter +// + +#define TAPE_DRIVE_FIXED 0x00000001 +#define TAPE_DRIVE_SELECT 0x00000002 +#define TAPE_DRIVE_INITIATOR 0x00000004 + +#define TAPE_DRIVE_ERASE_SHORT 0x00000010 +#define TAPE_DRIVE_ERASE_LONG 0x00000020 +#define TAPE_DRIVE_ERASE_BOP_ONLY 0x00000040 +#define TAPE_DRIVE_ERASE_IMMEDIATE 0x00000080 + +#define TAPE_DRIVE_TAPE_CAPACITY 0x00000100 +#define TAPE_DRIVE_TAPE_REMAINING 0x00000200 +#define TAPE_DRIVE_FIXED_BLOCK 0x00000400 +#define TAPE_DRIVE_VARIABLE_BLOCK 0x00000800 + +#define TAPE_DRIVE_WRITE_PROTECT 0x00001000 +#define TAPE_DRIVE_EOT_WZ_SIZE 0x00002000 + +#define TAPE_DRIVE_ECC 0x00010000 +#define TAPE_DRIVE_COMPRESSION 0x00020000 +#define TAPE_DRIVE_PADDING 0x00040000 +#define TAPE_DRIVE_REPORT_SMKS 0x00080000 + +#define TAPE_DRIVE_GET_ABSOLUTE_BLK 0x00100000 +#define TAPE_DRIVE_GET_LOGICAL_BLK 0x00200000 +#define TAPE_DRIVE_SET_EOT_WZ_SIZE 0x00400000 + +#define TAPE_DRIVE_EJECT_MEDIA 0x01000000 +#define TAPE_DRIVE_CLEAN_REQUESTS 0x02000000 +#define TAPE_DRIVE_SET_CMP_BOP_ONLY 0x04000000 + +#define TAPE_DRIVE_RESERVED_BIT 0x80000000 //don't use this bit! +// //can't be a low features bit! +// //reserved; high features only + +// +// Definitions for FeaturesHigh parameter +// + +#define TAPE_DRIVE_LOAD_UNLOAD 0x80000001 +#define TAPE_DRIVE_TENSION 0x80000002 +#define TAPE_DRIVE_LOCK_UNLOCK 0x80000004 +#define TAPE_DRIVE_REWIND_IMMEDIATE 0x80000008 + +#define TAPE_DRIVE_SET_BLOCK_SIZE 0x80000010 +#define TAPE_DRIVE_LOAD_UNLD_IMMED 0x80000020 +#define TAPE_DRIVE_TENSION_IMMED 0x80000040 +#define TAPE_DRIVE_LOCK_UNLK_IMMED 0x80000080 + +#define TAPE_DRIVE_SET_ECC 0x80000100 +#define TAPE_DRIVE_SET_COMPRESSION 0x80000200 +#define TAPE_DRIVE_SET_PADDING 0x80000400 +#define TAPE_DRIVE_SET_REPORT_SMKS 0x80000800 + +#define TAPE_DRIVE_ABSOLUTE_BLK 0x80001000 +#define TAPE_DRIVE_ABS_BLK_IMMED 0x80002000 +#define TAPE_DRIVE_LOGICAL_BLK 0x80004000 +#define TAPE_DRIVE_LOG_BLK_IMMED 0x80008000 + +#define TAPE_DRIVE_END_OF_DATA 0x80010000 +#define TAPE_DRIVE_RELATIVE_BLKS 0x80020000 +#define TAPE_DRIVE_FILEMARKS 0x80040000 +#define TAPE_DRIVE_SEQUENTIAL_FMKS 0x80080000 + +#define TAPE_DRIVE_SETMARKS 0x80100000 +#define TAPE_DRIVE_SEQUENTIAL_SMKS 0x80200000 +#define TAPE_DRIVE_REVERSE_POSITION 0x80400000 +#define TAPE_DRIVE_SPACE_IMMEDIATE 0x80800000 + +#define TAPE_DRIVE_WRITE_SETMARKS 0x81000000 +#define TAPE_DRIVE_WRITE_FILEMARKS 0x82000000 +#define TAPE_DRIVE_WRITE_SHORT_FMKS 0x84000000 +#define TAPE_DRIVE_WRITE_LONG_FMKS 0x88000000 + +#define TAPE_DRIVE_WRITE_MARK_IMMED 0x90000000 +#define TAPE_DRIVE_FORMAT 0xA0000000 +#define TAPE_DRIVE_FORMAT_IMMEDIATE 0xC0000000 +#define TAPE_DRIVE_HIGH_FEATURES 0x80000000 //mask for high features flag + +typedef struct _TAPE_GET_DRIVE_PARAMETERS { + BOOLEAN ECC; + BOOLEAN Compression; + BOOLEAN DataPadding; + BOOLEAN ReportSetmarks; + ULONG DefaultBlockSize; + ULONG MaximumBlockSize; + ULONG MinimumBlockSize; + ULONG MaximumPartitionCount; + ULONG FeaturesLow; + ULONG FeaturesHigh; + ULONG EOTWarningZoneSize; +} TAPE_GET_DRIVE_PARAMETERS, *PTAPE_GET_DRIVE_PARAMETERS; + +// +// IOCTL_TAPE_SET_DRIVE_PARAMETERS definitions +// + +typedef struct _TAPE_SET_DRIVE_PARAMETERS { + BOOLEAN ECC; + BOOLEAN Compression; + BOOLEAN DataPadding; + BOOLEAN ReportSetmarks; + ULONG EOTWarningZoneSize; +} TAPE_SET_DRIVE_PARAMETERS, *PTAPE_SET_DRIVE_PARAMETERS; + +// +// IOCTL_TAPE_GET_MEDIA_PARAMETERS definitions +// + +typedef struct _TAPE_GET_MEDIA_PARAMETERS { + LARGE_INTEGER Capacity; + LARGE_INTEGER Remaining; + ULONG BlockSize; + ULONG PartitionCount; + BOOLEAN WriteProtected; +} TAPE_GET_MEDIA_PARAMETERS, *PTAPE_GET_MEDIA_PARAMETERS; + +// +// IOCTL_TAPE_SET_MEDIA_PARAMETERS definitions +// + +typedef struct _TAPE_SET_MEDIA_PARAMETERS { + ULONG BlockSize; +} TAPE_SET_MEDIA_PARAMETERS, *PTAPE_SET_MEDIA_PARAMETERS; + +// +// IOCTL_TAPE_CREATE_PARTITION definitions +// + +#define TAPE_FIXED_PARTITIONS 0L +#define TAPE_SELECT_PARTITIONS 1L +#define TAPE_INITIATOR_PARTITIONS 2L + +typedef struct _TAPE_CREATE_PARTITION { + ULONG Method; + ULONG Count; + ULONG Size; +} TAPE_CREATE_PARTITION, *PTAPE_CREATE_PARTITION; + + +// +// WMI Methods +// +#define TAPE_QUERY_DRIVE_PARAMETERS 0L +#define TAPE_QUERY_MEDIA_CAPACITY 1L +#define TAPE_CHECK_FOR_DRIVE_PROBLEM 2L +#define TAPE_QUERY_IO_ERROR_DATA 3L +#define TAPE_QUERY_DEVICE_ERROR_DATA 4L + +typedef struct _TAPE_WMI_OPERATIONS { + ULONG Method; + ULONG DataBufferSize; + PVOID DataBuffer; +} TAPE_WMI_OPERATIONS, *PTAPE_WMI_OPERATIONS; + +// +// Type of drive errors +// +typedef enum _TAPE_DRIVE_PROBLEM_TYPE { + TapeDriveProblemNone, TapeDriveReadWriteWarning, + TapeDriveReadWriteError, TapeDriveReadWarning, + TapeDriveWriteWarning, TapeDriveReadError, + TapeDriveWriteError, TapeDriveHardwareError, + TapeDriveUnsupportedMedia, TapeDriveScsiConnectionError, + TapeDriveTimetoClean, TapeDriveCleanDriveNow, + TapeDriveMediaLifeExpired, TapeDriveSnappedTape +} TAPE_DRIVE_PROBLEM_TYPE; + +#endif +// end_winnt end_ntminitape + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // _NTDDTAPE_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtdi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtdi.h new file mode 100644 index 0000000000000000000000000000000000000000..9c23f47a758a63401780ec33bfa6157d72a038c3 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddtdi.h @@ -0,0 +1,76 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) 1990-1999 Microsoft Corporation + +Module Name: + + ntddtdi.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Transport driver interface device. + +--*/ + +#ifndef _NTDDTDI_ +#define _NTDDTDI_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Device Name - this string is the name of the device. It is the name +// that should be passed to NtOpenFile when accessing the device. +// +// Note: For devices that support multiple units, it should be suffixed +// with the Ascii representation of the unit number. +// + +#define DD_TDI_DEVICE_NAME "\\Device\\UNKNOWN" + + +// +// NtDeviceIoControlFile IoControlCode values for this device. +// +// Warning: Remember that the low two bits of the code specify how the +// buffers are passed to the driver! +// + +#define _TDI_CONTROL_CODE(request,method) \ + CTL_CODE(FILE_DEVICE_TRANSPORT, request, method, FILE_ANY_ACCESS) + +#define IOCTL_TDI_ACCEPT _TDI_CONTROL_CODE( 0, METHOD_BUFFERED ) +#define IOCTL_TDI_CONNECT _TDI_CONTROL_CODE( 1, METHOD_BUFFERED ) +#define IOCTL_TDI_DISCONNECT _TDI_CONTROL_CODE( 2, METHOD_BUFFERED ) +#define IOCTL_TDI_LISTEN _TDI_CONTROL_CODE( 3, METHOD_BUFFERED ) +#define IOCTL_TDI_QUERY_INFORMATION _TDI_CONTROL_CODE( 4, METHOD_OUT_DIRECT ) +#define IOCTL_TDI_RECEIVE _TDI_CONTROL_CODE( 5, METHOD_OUT_DIRECT ) +#define IOCTL_TDI_RECEIVE_DATAGRAM _TDI_CONTROL_CODE( 6, METHOD_OUT_DIRECT ) +#define IOCTL_TDI_SEND _TDI_CONTROL_CODE( 7, METHOD_IN_DIRECT ) +#define IOCTL_TDI_SEND_DATAGRAM _TDI_CONTROL_CODE( 8, METHOD_IN_DIRECT ) +#define IOCTL_TDI_SET_EVENT_HANDLER _TDI_CONTROL_CODE( 9, METHOD_BUFFERED ) +#define IOCTL_TDI_SET_INFORMATION _TDI_CONTROL_CODE( 10, METHOD_IN_DIRECT ) +#define IOCTL_TDI_ASSOCIATE_ADDRESS _TDI_CONTROL_CODE( 11, METHOD_BUFFERED ) +#define IOCTL_TDI_DISASSOCIATE_ADDRESS _TDI_CONTROL_CODE( 12, METHOD_BUFFERED ) +#define IOCTL_TDI_ACTION _TDI_CONTROL_CODE( 13, METHOD_OUT_DIRECT ) + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // ndef _NTDDTDI_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvdeo.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvdeo.h new file mode 100644 index 0000000000000000000000000000000000000000..b977bce362a452a1e3b3ed16ea0a69e395ed79c0 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvdeo.h @@ -0,0 +1,2600 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ddvdeo.h + +Abstract: + + This is the include file that defines all constants and types for + accessing the Video device. + +--*/ + +#ifndef _NTDDVDEO_ +#define _NTDDVDEO_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#pragma warning(disable:4201) /* Disable warning C4201:nameless struct/union */ +#pragma warning(disable:4214) /* Disable warning C4201:bit field types other than int */ +#endif + +// +// Display output interfaces +// + +// DEFINE_GUID(GUID_DISPLAY_OUTPUT_INTERFACE_STANDARD, 0x96304D9F, 0x54b5, 0x11d1, 0x8b, 0x0f, 0x00, 0xa0, 0xc9, 0x06, 0x8f, 0xf3); + +// +// Display adapter device interface +// 5b45201d-f2f2-4f3b-85bb-30ff1f953599 +// + +DEFINE_GUID(GUID_DEVINTERFACE_DISPLAY_ADAPTER, 0x5b45201d, 0xf2f2, 0x4f3b, 0x85, 0xbb, 0x30, 0xff, 0x1f, 0x95, 0x35, 0x99); + +// +// Monitor device interface +// {E6F07B5F-EE97-4a90-B076-33F57BF4EAA7} +DEFINE_GUID(GUID_DEVINTERFACE_MONITOR, 0xe6f07b5f, 0xee97, 0x4a90, 0xb0, 0x76, 0x33, 0xf5, 0x7b, 0xf4, 0xea, 0xa7); + +// +// Obsolete device interface class GUID names. +// (use of above GUID_DEVINTERFACE_* names is recommended). +// + +#define GUID_DISPLAY_ADAPTER_INTERFACE GUID_DEVINTERFACE_DISPLAY_ADAPTER + +// +// Interface used by anyone listening for arrival of the graphics devices +// This includes Display only, Full graphics adapters, etc., but excludes MCDM (Compute only devices). +// {1CA05180-A699-450A-9A0C-DE4FBE3DDD89} +// + +DEFINE_GUID(GUID_DISPLAY_DEVICE_ARRIVAL, 0x1CA05180, 0xA699, 0x450A, 0x9A, 0x0C, 0xDE, 0x4F, 0xBE, 0x3D, 0xDD, 0x89); + +// +// Interface used by anyone listening for arrival of display children +// {1AD9E4F0-F88D-4360-BAB9-4C2D55E564CD} +// + +DEFINE_GUID(GUID_DEVINTERFACE_VIDEO_OUTPUT_ARRIVAL, 0x1AD9E4F0, 0xF88D, 0x4360, 0xBA, 0xB9, 0x4C, 0x2D, 0x55, 0xE5, 0x64, 0xCD); + +// +// Display Mux device interface +// Interface used by anyone listening for arrival of a display mux device +// {93c33929-3180-46d3-8aab-008c84ad1e6e} +// + +DEFINE_GUID(GUID_DEVINTERFACE_DISPLAYMUX, 0x93c33929, 0x3180, 0x46d3, 0x8a, 0xab, 0x00, 0x8c, 0x84, 0xad, 0x1e, 0x6e); + +#ifdef DEFINE_DEVPROPKEY + +// +// Property on a display class device's DevNode indicating that it is a indirect display +// + +DEFINE_DEVPROPKEY(DEVPKEY_IndirectDisplay, 0xc50a3f10, 0xaa5c, 0x4247, 0xb8, 0x30, 0xd6, 0xa6, 0xf8, 0xea, 0xa3, 0x10, 0x01); +DEFINE_DEVPROPKEY(DEVPKEY_Device_TerminalLuid, 0xc50a3f10, 0xaa5c, 0x4247, 0xb8, 0x30, 0xd6, 0xa6, 0xf8, 0xea, 0xa3, 0x10, 0x02); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_Device_AdapterLuid, 0xc50a3f10, 0xaa5c, 0x4247, 0xb8, 0x30, 0xd6, 0xa6, 0xf8, 0xea, 0xa3, 0x10, 0x03); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_Device_ActivityId, 0xc50a3f10, 0xaa5c, 0x4247, 0xb8, 0x30, 0xd6, 0xa6, 0xf8, 0xea, 0xa3, 0x10, 0x04); // DEVPROP_TYPE_BINARY +#define DEVPKEY_DeviceInterface_TerminalLuid DEVPKEY_Device_TerminalLuid + +struct INDIRECT_DISPLAY_INFO +{ + LUID DisplayAdapterLuid; + ULONG Flags; + ULONG NumMonitors; + ULONG DisplayAdapterTargetBase; + ULONG DriverVersionMajor; + ULONG DriverVersionMinor; +}; + +#define INDIRECT_DISPLAY_INFO_FLAGS_CREATED_IDDCX_ADAPTER 0x1 // This indirect display device created a IddCx adapter +#define INDIRECT_DISPLAY_INFO_FLAGS_SUPPORT_FP16 0x2 // This indirect display device supports FP16 + +// +// Display Mux property keys GUID base +// {fefa7434-e0fd-4b2a-905a-7d0127a9f01c} +// + +DEFINE_DEVPROPKEY(DEVPKEY_DisplayMux_InitStatus, 0xfefa7434, 0xe0fd, 0x4b2a, 0x90, 0x5a, 0x7d, 0x01, 0x27, 0xa9, 0xf0, 0x1c, 1); // +DEFINE_DEVPROPKEY(DEVPKEY_DisplayMux_SupportLevel , 0xfefa7434, 0xe0fd, 0x4b2a, 0x90, 0x5a, 0x7d, 0x01, 0x27, 0xa9, 0xf0, 0x1c, 2); // DEVPROP_TYPE_UINT32 +DEFINE_DEVPROPKEY(DEVPKEY_DisplayMux_MuxTarget1, 0xfefa7434, 0xe0fd, 0x4b2a, 0x90, 0x5a, 0x7d, 0x01, 0x27, 0xa9, 0xf0, 0x1c, 3); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_DisplayMux_MuxTarget2, 0xfefa7434, 0xe0fd, 0x4b2a, 0x90, 0x5a, 0x7d, 0x01, 0x27, 0xa9, 0xf0, 0x1c, 4); // DEVPROP_TYPE_BINARY +DEFINE_DEVPROPKEY(DEVPKEY_DisplayMux_CurrentTarget, 0xfefa7434, 0xe0fd, 0x4b2a, 0x90, 0x5a, 0x7d, 0x01, 0x27, 0xa9, 0xf0, 0x1c, 5); // DEVPROP_TYPE_BINARY + +#endif + +#ifndef GUID_DEFS_ONLY + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +// +// VideoIoControlFile InputBuffer/OutputBuffer record structures for +// this device. +// + +// +// Name used to create the miniport logical device names +// + +#define VIDEO_DEVICE_NAME "DISPLAY%d" +#define WVIDEO_DEVICE_NAME L"DISPLAY%d" + + +// +// Set of deprecated IOCTLs +// + +#define IOCTL_VIDEO_DISABLE_VDM \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x01, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_REGISTER_VDM \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x02, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_OUTPUT_DEVICE_POWER_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x03, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_GET_OUTPUT_DEVICE_POWER_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x04, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// This IOCTL was defined but never supported and should be removed +#define IOCTL_VIDEO_MONITOR_DEVICE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x05, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_ENUM_MONITOR_PDO \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x06, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_INIT_WIN32K_CALLBACKS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x07, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_IS_VGA_DEVICE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x09, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_USE_DEVICE_IN_SESSION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x0a, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_PREPARE_FOR_EARECOVERY \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x0b, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// All these IOCTL's must be both handled by the port and miniport since +// they require processing by both parties. +// + +#define IOCTL_VIDEO_ENABLE_VDM \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x00, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SAVE_HARDWARE_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x80, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_RESTORE_HARDWARE_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x81, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +// +// All these IOCTL's are public and must/can be handled by the miniport +// driver +// + +#define IOCTL_VIDEO_HANDLE_VIDEOPARAMETERS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x08, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_AVAIL_MODES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x100, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_NUM_AVAIL_MODES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x101, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_CURRENT_MODE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x102, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_CURRENT_MODE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x103, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_RESET_DEVICE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x104, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_LOAD_AND_SET_FONT \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x105, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_PALETTE_REGISTERS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x106, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_COLOR_REGISTERS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x107, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_ENABLE_CURSOR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x108, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_DISABLE_CURSOR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x109, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_CURSOR_ATTR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10a, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_CURSOR_ATTR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10b, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_CURSOR_POSITION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10c, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_CURSOR_POSITION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10d, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_ENABLE_POINTER \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10e, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_DISABLE_POINTER \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x10f, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_POINTER_ATTR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x110, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_POINTER_ATTR \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x111, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_SET_POINTER_POSITION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x112, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_POINTER_POSITION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x113, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_POINTER_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x114, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_GET_BANK_SELECT_CODE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x115, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_MAP_VIDEO_MEMORY \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x116, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_UNMAP_VIDEO_MEMORY \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x117, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_QUERY_PUBLIC_ACCESS_RANGES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x118, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_FREE_PUBLIC_ACCESS_RANGES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x119, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_QUERY_COLOR_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11a, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTLs defined for product 1.0A +// + +#define IOCTL_VIDEO_SET_POWER_MANAGEMENT \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11b, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_GET_POWER_MANAGEMENT \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11c, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SHARE_VIDEO_MEMORY \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11d, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VIDEO_UNSHARE_VIDEO_MEMORY \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11e, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_COLOR_LUT_DATA \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x11f, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_GET_CHILD_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x120, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_VALIDATE_CHILD_STATE_CONFIGURATION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x121, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_CHILD_STATE_CONFIGURATION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x122, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SWITCH_DUALVIEW \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x123, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_BANK_POSITION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x124, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +// +// Monitor control IOCTLs defined for XPSP1 +// + +// WARNING: New code should use the new WMI interface, old code should be updated to use WMI interfaces + +#define IOCTL_VIDEO_QUERY_SUPPORTED_BRIGHTNESS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x125, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_QUERY_DISPLAY_BRIGHTNESS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x126, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_VIDEO_SET_DISPLAY_BRIGHTNESS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x127, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// All these IOCTL's were handled by the East Asia Full Screen Video driver but are no longer supported +// + +#define IOCTL_FSVIDEO_COPY_FRAME_BUFFER \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x200, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_FSVIDEO_WRITE_TO_FRAME_BUFFER \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x201, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_FSVIDEO_REVERSE_MOUSE_POINTER \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x202, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_FSVIDEO_SET_CURRENT_MODE \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x203, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_FSVIDEO_SET_SCREEN_INFORMATION \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x204, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_FSVIDEO_SET_CURSOR_POSITION \ + CTL_CODE(FILE_DEVICE_FULLSCREEN_VIDEO, 0x205, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Panel control IOCLTs must/can be handled by the monitor, oem-panel, port/miniport +// driver +// + +#define IOCTL_PANEL_QUERY_BRIGHTNESS_CAPS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x300, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_QUERY_BRIGHTNESS_RANGES \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x301, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_GET_BRIGHTNESS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x302, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_SET_BRIGHTNESS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x303, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_SET_BRIGHTNESS_STATE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x304, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_SET_BACKLIGHT_OPTIMIZATION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x305, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_GET_BACKLIGHT_REDUCTION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x306, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_PANEL_GET_MANUFACTURING_MODE \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x307, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// Colorspace Transform control IOCLTs must/can be handled by the monitor, oem-panel, port/miniport +// driver +// + +#define IOCTL_COLORSPACE_TRANSFORM_QUERY_TARGET_CAPS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x400, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_COLORSPACE_TRANSFORM_SET \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x401, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_SET_ACTIVE_COLOR_PROFILE_NAME \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x402, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_GET_SCALAR_MULTIPLIER_CAPS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x403, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_SET_SCALAR_MULTIPLIER \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x404, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +// +// Mipi DCS IOCLTs must/can be handled by the monitor, oem-panel, port/miniport +// driver +// +#define IOCTL_MIPI_DSI_QUERY_CAPS \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x500, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_MIPI_DSI_TRANSMISSION \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x501, METHOD_BUFFERED, FILE_ANY_ACCESS) + +#define IOCTL_MIPI_DSI_RESET \ + CTL_CODE(FILE_DEVICE_VIDEO, 0x502, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// Many of the video IOCTLs are modal. When ever the palette is set, or the +// cursor is set or queried, it is done for the current mode. +// +// Modal specifies that the operation is only valid within a mode. Once a +// set mode operation is performed, the state associated to the modal IOCTL +// has been destroyed or reinitialized. +// Non-modal IOCTLs have their state preserved across set-mode operations. +// +// Optional IOCTLs are IOCTLs the miniport can optionally support. If the +// miniport does not support the IOCTL, it should return the appropriate +// error status. +// Required IOCTLs must be implemented in a miniport in order for the system +// to system properly. +// +// IOCTL_VIDEO_ENABLE_VDM Non-Modal Private(1) +// IOCTL_VIDEO_DISABLE_VDM Non-Modal Private(1) +// IOCTL_VIDEO_REGISTER_VDM Non-Modal Private(1) +// +// IOCTL_VIDEO_SAVE_HARDWARE_STATE Non-Modal Required(2) +// IOCTL_VIDEO_RESTORE_HARDWARE_STATE Non-Modal Required(2) +// +// IOCTL_VIDEO_QUERY_AVAIL_MODES Non-Modal Required +// IOCTL_VIDEO_QUERY_NUM_AVAIL_MODES Non-Modal Required +// IOCTL_VIDEO_QUERY_CURRENT_MODE Modal Required +// IOCTL_VIDEO_SET_CURRENT_MODE Non-Modal Required +// IOCTL_VIDEO_RESET_DEVICE Non-Modal Required +// +// IOCTL_VIDEO_LOAD_AND_SET_FONT Modal Required(2) +// +// IOCTL_VIDEO_SET_PALETTE_REGISTERS Modal Required(2) +// IOCTL_VIDEO_SET_COLOR_REGISTERS Modal Required(3) +// +// IOCTL_VIDEO_ENABLE_CURSOR Modal Required(2) +// IOCTL_VIDEO_DISABLE_CURSOR Modal Required(2) +// IOCTL_VIDEO_SET_CURSOR_ATTR Modal Required(2) +// IOCTL_VIDEO_QUERY_CURSOR_ATTR Modal Required(2) +// IOCTL_VIDEO_SET_CURSOR_POSITION Modal Required(2) +// IOCTL_VIDEO_QUERY_CURSOR_POSITION Modal Required(2) +// +// IOCTL_VIDEO_ENABLE_POINTER Modal Optional +// IOCTL_VIDEO_DISABLE_POINTER Modal Optional +// IOCTL_VIDEO_SET_POINTER_ATTR Modal Optional +// IOCTL_VIDEO_QUERY_POINTER_ATTR Modal Optional +// IOCTL_VIDEO_SET_POINTER_POSITION Modal Optional +// IOCTL_VIDEO_QUERY_POINTER_POSITION Modal Optional +// IOCTL_VIDEO_QUERY_POINTER_CAPABILITIES Non-Modal Optional +// +// IOCTL_VIDEO_GET_BANK_SELECT_CODE Modal Required(2) +// +// IOCTL_VIDEO_MAP_VIDEO_MEMORY Special(4) Required +// IOCTL_VIDEO_UNMAP_VIDEO_MEMORY Non-Modal Required +// IOCTL_VIDEO_QUERY_PUBLIC_ACCESS_RANGES Non-Modal Optional +// IOCTL_VIDEO_FREE_PUBLIC_ACCESS_RANGES Non-Modal Optional +// +// IOCTL_VIDEO_QUERY_COLOR_CAPABILITIES Non-Modal Optional +// +// IOCTL_VIDEO_SET_POWER_MANAGEMENT Non-Modal Optional +// IOCTL_VIDEO_GET_POWER_MANAGEMENT Non-Modal Optional +// +// IOCTL_VIDEO_SET_COLOR_LUT_DATA Modal Optional + +// +// (1) Private means the IOCTL is completely implemeted within the port driver +// and the miniport does not need to support it. +// +// (2) These Required functions are for "Vga Compatible" miniports. They are +// Optional for other, non vga-compatible (i.e frame buffers) drivers. +// VGA compatible means here that the miniport implements all the VGA +// functionality and that the VgaCompatible flag for the miniport in the +// registry parameters is turned on. +// +// (3) This IOCTL is required if the device has a color lookup table (also +// commonly called palette) the PALETTE IOCTL is used for VGA while the +// COLOR IOCTL is the more general IOCTL that is called by the display +// driver or application to set the colors in the devices internal +// lookup table +// +// (4) This IOCTL is both modal and non-modal. It should map all of video +// memory in the caller's address space. A set mode MUST NOT cause the +// video memory to change location - in this sense it is non-modal. +// However, this IOCTL returns the location size of the frame buffer within +// video memory, and the frame buffer size and location may vary from mode +// to mode - so that information is modal. +// + + +// +// Any IOCTL that returns information should return in the status block the +// size of the data returned. +// If the output buffer was too small, an error should be returned. +// +// +// +// + + + +// +// IOCTL_VIDEO_ENABLE_VDM +// IOCTL_VIDEO_DISABLE_VDM +// IOCTL_VIDEO_REGISTER_VDM +// +// These IOCTLs are used to enable or disable a VDM's access to the video +// hardware. This call will cause the real video frame buffer to be mapped +// into the VDM's address space and get the video validator connected to the +// V86 emulator for direct video register access. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_VDM { + HANDLE ProcessHandle; +} VIDEO_VDM, *PVIDEO_VDM; + +// +//ProcessHandle - Handle to the process for which this request must be +// performed. This is required because the console calls the miniport on +// the behalf of the VDM process; we are not performing this request in +// the context of the current caller. +// + + +typedef struct _VIDEO_REGISTER_VDM { + ULONG MinimumStateSize; +} VIDEO_REGISTER_VDM, *PVIDEO_REGISTER_VDM; + +// +//MinimumStateSize - Output value determining the minimum size required to +// store the video hardware state when performing SAVE_HARDWARE_SATE or +// RESTORE_HARDWARE_STATE Ioctls. +// + + +// +// IOCTL_VIDEO_GET_MONITOR_DESCRIPTOR +// +// Detailed descriptor of monitor devices +// + +typedef struct tagVIDEO_MONITOR_DESCRIPTOR { + ULONG DescriptorSize; // Size of the Descriptor + UCHAR Descriptor[1]; // Start of descriptor data (actual size is determined by DescriptorSize) +} VIDEO_MONITOR_DESCRIPTOR, *PVIDEO_MONITOR_DESCRIPTOR; + + +// + +// +// IOCTL_VIDEO_INIT_WIN32K_CALLBACKS +// +// List of function pointers used to make callbacks to win32k +// + +typedef enum _VIDEO_WIN32K_CALLBACKS_PARAMS_TYPE { + VideoPowerNotifyCallout = 1, + VideoEnumChildPdoNotifyCallout = 3, + VideoFindAdapterCallout = 4, + VideoPnpNotifyCallout = 7, + VideoDxgkDisplaySwitchCallout = 8, + VideoDxgkFindAdapterTdrCallout = 10, + VideoDxgkHardwareProtectionTeardown = 11, + VideoRepaintDesktop = 12, + VideoUpdateCursor = 13, + VideoDisableMultiPlaneOverlay = 14, + VideoDesktopDuplicationChange = 15, + VideoBlackScreenDiagnostics = 16, + VideoForceCompositionRender = 17, +} VIDEO_WIN32K_CALLBACKS_PARAMS_TYPE; + +enum BlackScreenDiagnosticsCalloutParam +{ + BlackScreenDiagnosticsData = 0x1, + BlackScreenDisplayRecovery = 0x2, +}; + +#define DXGK_WIN32K_PARAM_FLAG_UPDATEREGISTRY 1 // Saves the mode switch information into the registry. +#define DXGK_WIN32K_PARAM_FLAG_MODESWITCH 2 // Performs the mode switch. +#define DXGK_WIN32K_PARAM_FLAG_DISABLEVIEW 4 // Disables the view which we're interested in. + +// +// Extra information for DxgkVideoPortCallout +// implementation +// +typedef struct _DXGK_WIN32K_PARAM_DATA +{ + PVOID PathsArray; + PVOID ModesArray; + ULONG NumPathArrayElements; + ULONG NumModeArrayElements; + ULONG SDCFlags; +} DXGK_WIN32K_PARAM_DATA, *PDXGK_WIN32K_PARAM_DATA; + +typedef struct _VIDEO_WIN32K_CALLBACKS_PARAMS { + VIDEO_WIN32K_CALLBACKS_PARAMS_TYPE CalloutType; + PVOID PhysDisp; + ULONG_PTR Param; + LONG Status; + BOOLEAN LockUserSession; + BOOLEAN IsPostDevice; + BOOLEAN SurpriseRemoval; + BOOLEAN WaitForQueueReady; +} VIDEO_WIN32K_CALLBACKS_PARAMS, *PVIDEO_WIN32K_CALLBACKS_PARAMS; + +typedef +VOID +(*PVIDEO_WIN32K_CALLOUT) ( + IN PVOID Params + ); + + +typedef struct _VIDEO_WIN32K_CALLBACKS { + IN PVOID PhysDisp; + IN PVIDEO_WIN32K_CALLOUT Callout; + OUT ULONG bACPI; + OUT HANDLE pPhysDeviceObject; + OUT ULONG DualviewFlags; +} VIDEO_WIN32K_CALLBACKS, *PVIDEO_WIN32K_CALLBACKS; + +// +// defines for Dualview Flags +// + +#define VIDEO_DUALVIEW_REMOVABLE 0x00000001 +#define VIDEO_DUALVIEW_PRIMARY 0x80000000 +#define VIDEO_DUALVIEW_SECONDARY 0x40000000 + +// Used by WDDM infrastructure to determine whether a device is the VGA one or not. +#define VIDEO_DUALVIEW_WDDM_VGA 0x20000000 + +// +// IOCTL_VIDEO_USE_DEVICE_IN_SESSION +// +// Parameters to request new enabled/disabled state for a device +// + +typedef struct _VIDEO_DEVICE_SESSION_STATUS { + ULONG bEnable; // Is device being enabled or disabled + ULONG bSuccess; // Was request validated +} VIDEO_DEVICE_SESSION_STATUS, *PVIDEO_DEVICE_SESSION_STATUS; + + +// +// Second set of structures +// + +// +// These IOCTLs are used by the VDM and the console to communicate state +// changes between the VDM and the kernel video driver. +// +// IOCTL_VIDEO_SAVE_HARDWARE_STATE - +// IOCTL_VIDEO_RESTORE_HARDWARE_STATE - +// +// +// This structure is at the start of the block used when saving or restoring +// the state of the video hardware using ConsoleHardwareState(). +// the ULONG are offset to the location of the rest of the data. That data +// is stored within the same memory block pointed to by the +// VIDEO_HARDWARE_STATE structure, right after this header. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_HARDWARE_STATE_HEADER { + ULONG Length; + UCHAR PortValue[0x30]; + ULONG AttribIndexDataState; + ULONG BasicSequencerOffset; + ULONG BasicCrtContOffset; + ULONG BasicGraphContOffset; + ULONG BasicAttribContOffset; + ULONG BasicDacOffset; + ULONG BasicLatchesOffset; + ULONG ExtendedSequencerOffset; + ULONG ExtendedCrtContOffset; + ULONG ExtendedGraphContOffset; + ULONG ExtendedAttribContOffset; + ULONG ExtendedDacOffset; + ULONG ExtendedValidatorStateOffset; + ULONG ExtendedMiscDataOffset; + ULONG PlaneLength; + ULONG Plane1Offset; + ULONG Plane2Offset; + ULONG Plane3Offset; + ULONG Plane4Offset; + ULONG VGAStateFlags; + ULONG DIBOffset; + ULONG DIBBitsPerPixel; + ULONG DIBXResolution; + ULONG DIBYResolution; + ULONG DIBXlatOffset; + ULONG DIBXlatLength; + ULONG VesaInfoOffset; + PVOID FrameBufferData; + +} VIDEO_HARDWARE_STATE_HEADER, *PVIDEO_HARDWARE_STATE_HEADER; + +// +// defines for VGAStateFlags +// + +#define VIDEO_STATE_NON_STANDARD_VGA 0x00000001 +#define VIDEO_STATE_UNEMULATED_VGA_STATE 0x00000002 +#define VIDEO_STATE_PACKED_CHAIN4_MODE 0x00000004 + +typedef struct _VIDEO_HARDWARE_STATE { + PVIDEO_HARDWARE_STATE_HEADER StateHeader; + ULONG StateLength; +} VIDEO_HARDWARE_STATE, *PVIDEO_HARDWARE_STATE; + +// +//Length - Length of the basic structure. Used for versioning purposes. The +// length field should be initialized to be equal to +// sizeof(VIDEO_HARDWARE_STATE_HEADER). +// +//PortValue - Array of entries containing the data values for port 3B0 through +// 3DF. +// +//AttribIndexDataState - State of the attribute index register. +// +//BasicSequencerOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// sequencer register set of the VGA. +// +//BasicCrtContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// CRT register set of the VGA. +// +//BasicGraphContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// graphics controller register set of the VGA. +// +//BasicAttribContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// attribute controller register set of the VGA. +// +//BasicDacOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// DAC registers of the VGA. +// +//BasicLatchesOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the register values for the basic +// latches of the VGA. +// +//ExtendedSequencerOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the registers values for the extended +// sequencer register set of the VGA. +// +//ExtendedCrtContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the registers values for the extended +// CRT register set of the VGA. +// +//ExtendedGraphContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the registers values for the extended +// graphics controller register set of the VGA. +// +//ExtendedAttribContOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the registers values for the extended +// attribute controller register set of the VGA. +// +//ExtendedDacOffset - Offset, in bytes, from the beginning of the structure, +// to an array of fields containing the registers values for the extended +// DAC registers of the VGA. +// +//ExtendedValidatorStateOffset - Offset, in bytes, from the beginning of the +// structure, to an area reserved for the miniport to put the unemulated +// save state that the miniport uses to perform instruction validation for +// DOS apps. +// +//ExtendedMiscDataOffset - Offset, in bytes, from the beginning of the structure, +// to an area reserved for the use of the miniport. +// +//PlaneLength - Length of each of the following plane (if present) +// +//Plane1Offset - Offset, in bytes, from the beginning of the structure, to an +// array of fields containing the data of the first plane of video memory. +// +//Plane2Offset - Offset, in bytes, from the beginning of the structure, to an +// array of fields containing the data of the second plane of video memory. +// +//Plane3Offset - Offset, in bytes, from the beginning of the structure, to an +// array of fields containing the data of the third plane of video memory. +// +//Plane4Offset - Offset, in bytes, from the beginning of the structure, to an +// array of fields containing the data of the fourth plane of video memory. +// +//VGAStateFlags - Flags used for the interpretation of the VGA state. +// VIDEO_STATE_NON_STANDARD_VGA is set when the set of registers the VGA +// returns is not the basic set (all super vga's are not standard). +// The VDM should not emulate the saved state unless a specific VDD +// has been written for the device. +// VIDEO_STATE_UNEMULATED_VGA_STATE specified the miniport has stored +// informaiton in the ExtendedValidatorState field and the miniport +// should treat this as a frozen state, whatever the registers say. +// VIDEO_STATE_PACKED_CHAIN4_MODE indicates that in mode 13 (320x200x256). +// the data is stored in a packed pixel format in the plane, as +// opposed to the standard VGA format where the data is interleaved +// at every four bytes, and on every 16K boundary, offset by one +// extra byte. +// +//DIBOffset - Offset to the location of the DIB in the allocated data +// structure. If NULL, no translation is available. +// +//DIBBitsPerPixel - Format of the DIB. +// +//DIBXResolution - Width of the DIB in pixels. +// +//DIBYResolution - Height of the DIB in pixels. +// +//DIBXlatOffset - Offset to the location of the translation vector +// from DIB pixel values to 32-bit RGB (1 byte red, 1 byte green, 1 byte +// blue, 1 byte empty). Maximum length 256. If NULL, the standard +// VGA palette stored in this structure should be used. +// +//DIBXlatLength - Length of the RGB translation vector at DIBXlatOffset. +// +// For each of the offset fields, if an offset value is NULL, then there is +// no data for that offset. +// The length of a data area is: +// 1) the specific length given to it : plane length (planes) or XResolution * +// Yresolution * BitsPerPel (DIB) +// 2) otherwise, the length = next_non-null_offset_value - +// current_offset_value +// + +// +//StateHeader - Pointer to the VIDEO_HARDWARE_STATE_HEADER structure. +// +//StateLength - Size of the VIDEO_HARDWARE_STATE_HEADER structure. +// + +// +// IOCTL_VIDEO_QUERY_NUM_AVAIL_MODES - Returns number of different modes +// available on the controller. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_NUM_MODES { + ULONG NumModes; + ULONG ModeInformationLength; +} VIDEO_NUM_MODES, *PVIDEO_NUM_MODES; + +// +//NumModes - Returns the number of modes supported by the kernel driver. +// +//ModeInformationLength - Length of the VIDEO_MODE_INFORMATION structure +// for the IOCTL_VIDEO QUERY_AVAILABLE_MODES IOCTL. + + +// +// IOCTL_VIDEO_SET_CURRENT_MODE - Is used to set the mode of the controller. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_MODE { + ULONG RequestedMode; +} VIDEO_MODE, *PVIDEO_MODE; + +#define VIDEO_MODE_NO_ZERO_MEMORY 0x80000000 // High order bit of the mode + // determines if the set mode + // should (0) or should not (1) + // cause the video memory to be + // zeroed out simultaneously to + // the set mode operation. + +#define VIDEO_MODE_MAP_MEM_LINEAR 0x40000000 // Miniports which support this + // flag will set a linear mode + // if possible when this flag + // is set. Note: Some miniports + // may return a linear mode even + // if this flag is not set. + + +// +//RequestedMode - Indicates in which mode the adapter should be initialized. +// + + +// +// IOCTL_VIDEO_RESET_DEVICE - Is used to reset the mode of the adapter when GDI +// gives up control of the device to allow a VDM to +// access the hardware. x86 only. +// The default mode should be whatever is the +// default mode when the machine is booted +// +// No information is needed fo this function. +// + + + +// +// IOCTL_VIDEO_QUERY_AVAIL_MODES - Returns information about each available +// mode on the controller. +// +// IOCTL_VIDEO_QUERY_CURRENT_MODE - Returns the information for the current +// controller mode. +// +// Information used by this function is passed using the following structure: +// +// NOTE This structure is matched exactly with the DISP_MODE structure +// in winddi.h - every change to this structure MUST be made to the +// structure in winddi.h. +// + +typedef struct _VIDEO_MODE_INFORMATION { + ULONG Length; + ULONG ModeIndex; + ULONG VisScreenWidth; + ULONG VisScreenHeight; + ULONG ScreenStride; + ULONG NumberOfPlanes; + ULONG BitsPerPlane; + ULONG Frequency; + ULONG XMillimeter; + ULONG YMillimeter; + ULONG NumberRedBits; + ULONG NumberGreenBits; + ULONG NumberBlueBits; + ULONG RedMask; + ULONG GreenMask; + ULONG BlueMask; + ULONG AttributeFlags; + ULONG VideoMemoryBitmapWidth; + ULONG VideoMemoryBitmapHeight; + ULONG DriverSpecificAttributeFlags; +} VIDEO_MODE_INFORMATION, *PVIDEO_MODE_INFORMATION; + +// +// Bit definitions for Attribute Flags +// + +#define VIDEO_MODE_COLOR 0x0001 // 0 = Mono-compatible, 1 = Color +#define VIDEO_MODE_GRAPHICS 0x0002 // 0 = Text mode, 1 = Graphics +#define VIDEO_MODE_PALETTE_DRIVEN 0x0004 // 0 = Colors are direct + // 1 = Colors are index to a palette +#define VIDEO_MODE_MANAGED_PALETTE 0x0008 // 0 = Palette is fixed (must be + // queried from miniport + // 1 = Palette is settable. +#define VIDEO_MODE_INTERLACED 0x0010 // 1 = Mode is interlaced + // 0 = non-interlaced +#define VIDEO_MODE_NO_OFF_SCREEN 0x0020 // 1 = Offscreen memory CAN NOT be + // used to store information. + // 0 = Offscreen memory is available +#define VIDEO_MODE_NO_64_BIT_ACCESS 0x0040 // 1 = 64 bit memory writes to frame + // buffer are not handled properly. + // 0 = 64 bit memory writes to frame + // buffer are handled properly. +#define VIDEO_MODE_BANKED 0x0080 // 0 = undefined + // 1 = this is a banked mode +#define VIDEO_MODE_LINEAR 0x0100 // 0 = undefined + // 1 = this is a linear mode + +// +//Length - Length of the structure in bytes. Also used to do verisioning. +// +//ModeIndex - Number used to set this mode when calling the miniport driver. +// +//VisScreenWidth - Number of visible horizontal pixels on a scan line +// +//VisScreenHeight - Number of visible lines (or scan lines) +// +//ScreenStride - Delta, in *BYTES*, between the start of two scan lines. +// +// NOTE: the width and height are in pixels, but the stride is in bytes !!! +// +//NumberOfPlanes - Number of separate planes combined by the device. +// +//BitsPerPlane - Number of bits per pixel on a plane. +// +//Frequency - Screen Frequency, in Hertz. +// +//XMillimeter - Size of the horizontal active region on the output device, +// in millimeters. +// +//YMillimeter - Size of the vertical active region on the output device, +// in millimeters. +// +//NumberRedBits - Number of bits in the red DAC. +// +//NumberGreenBits - Number of bits in the green DAC. +// +//NumberBlueBits - Number of bits in the blue DAC. +// +//RedMask - Red color Mask for device with direct color modes. Bits turned +// on indicate the bit is of color Red. +// +//GreenMask - Green color Mask for device with direct color modes. Bits +// turned on indicate the bit is of color Green. +// +//BlueMask - Blue color Mask for device with direct color modes. Bits +// turned on indicate the bit is of color Blue. +// +//AttributeFlags. Flags indicating certain behavior for the device. +// +//VideoMemoryBitmapWidth - Width of the video memory bitmap. +// VisScreenWidth <= VideoMemoryBitmapWidth <= ScreenStride +// +//VideoMemoryBitmapHeight - Height of the video memory bitmap. +// VisScreenHeight <= VideoMemoryBitmapHeight = VideoRamLength / ScreenStride +// +//DriverSpecificAttributeFlags - Flags indicating certain behavior for the +// device that are private to the miniport\display driver. +// + + +// +// IOCTL_VIDEO_LOAD_AND_SET_FONT - Is used to load a user-defined font. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_LOAD_FONT_INFORMATION { + USHORT WidthInPixels; + USHORT HeightInPixels; + ULONG FontSize; + UCHAR Font[1]; +} VIDEO_LOAD_FONT_INFORMATION, *PVIDEO_LOAD_FONT_INFORMATION; + +// +//WidthInPixels - Width of the characters in the font, in pixels. +// +//HeigthInPixels - Heigth of the characters in the font, in pixels. +// +//FontSize - Size of the font buffer being passed in, in bytes. +// +//Font - Start of the font buffer. +// + + +// +// IOCTL_VIDEO_SET_PALETTE_REGISTERS - Takes buffer containing +// VIDEO_PALETTE_DATA where Colors[] +// specifies the array containing the +// color values for the palette registers. +// +// Information used by this function is passed using the following structure: +// +// NOTE: This should only be used by the VGA type drivers +// + +typedef struct _VIDEO_PALETTE_DATA { + USHORT NumEntries; + USHORT FirstEntry; + USHORT Colors[1]; +} VIDEO_PALETTE_DATA, *PVIDEO_PALETTE_DATA; + +// +//NumEntries - Number of entries in the array of color values. +// +//FirstEntry - Location in the device palette to which the first entry in the +// list of colors should be copied to. The other entries in the color list +// should be copied sequentially, from this starting point into the device's +// palette. +// +//Colors - Array of color entries to copy into the device's color palette. +// + +// +// IOCTL_VIDEO_SET_COLOR_REGISTERS - Takes buffer containing VIDEO_CLUT. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_CLUTDATA { + UCHAR Red; + UCHAR Green; + UCHAR Blue; + UCHAR Unused; +} VIDEO_CLUTDATA, *PVIDEO_CLUTDATA; + +// +//Red - Bits to be put in the Red portion of the color registers. +// +//Green - Bits to be put in the Green portion of the color registers. +// +//Blue - Bits to be put in the Blue portion of the color registers. +// + +typedef struct { + USHORT NumEntries; + USHORT FirstEntry; + union { + VIDEO_CLUTDATA RgbArray; + ULONG RgbLong; + } LookupTable[1]; +} VIDEO_CLUT, *PVIDEO_CLUT; + +// +//NumEntries - Number of entries in the LookupTable of color values. +// +//FirstEntry - Location in the device palette to which the first entry in the +// LookupTable of colors should be copied to. The other entries in the +// LookupTable should be copied sequentially, from this starting point into +// the device's palette. +// +//LookupTable - Array of color entries to copy into the device's color +// registers/palette. The color entries can be accessed as a genric 32 bit +// value or as Red/Green/Blue/Unused fields. +// + +// +// NOTE: Cursor vs. Pointer: +// A cursor is a rectangular set of pixels which are used to indicate the +// location of input coming from the keyboard. +// +// A pointer is the set of pixels that are used to paint the shape +// associated with the mouse. +// + +// +// IOCTL_VIDEO_QUERY_CURSOR_POSITION - Returns the location of the cursor on +// the screen. +// +// IOCTL_VIDEO_SET_CURSOR_POSITION - Is used to set the location of the +// cursor on the screen. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_CURSOR_POSITION { + SHORT Column; + SHORT Row; +} VIDEO_CURSOR_POSITION, *PVIDEO_CURSOR_POSITION; + +// +//Column - Column on which the cursor is located from the top left, in pixels. +// +//Row - Row on which the cusor is located from the top left, in pixels. +// + + +// +// IOCTL_VIDEO_QUERY_CURSOR_ATTR - Returns all attributes of the cursor. +// +// IOCTL_VIDEO_SET_CURSOR_ATTR - Is used to set the attributes of the cursor. +// +// Information used by this function is passed using the following structure: +// + +// +// For the VGA: +// TopScanLine will be stored in the height when an IOCTL is made +// BottomScanLine will be stored in the width when an IOCTL is made +// + +typedef struct _VIDEO_CURSOR_ATTRIBUTES { + USHORT Width; + USHORT Height; + SHORT Column; + SHORT Row; + UCHAR Rate; + UCHAR Enable; +} VIDEO_CURSOR_ATTRIBUTES, *PVIDEO_CURSOR_ATTRIBUTES; + +// +//Width - Width of the cursor, in pixels. +// +//Height - Height of the cursor, in scans. +// +//Column - Column on which the cursor is located from the top left, in pixels. +// +//Row - Row on which the cusor is located from the top left, in pixels. +// +//Rate - Rate at which the cursor whould flash. +// +//Enable - Non-zero to display cursor, 0 not to display. +// + +// +// IOCTL_VIDEO_QUERY_POINTER_POSITION - Returns the location of the pointer +// on the screen +// +// IOCTL_VIDEO_SET_POINTER_POSITION - Is used to set the location of the +// pointer on the screen. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_POINTER_POSITION { + SHORT Column; + SHORT Row; +} VIDEO_POINTER_POSITION, *PVIDEO_POINTER_POSITION; + +// +//Column - Column on which the cursor is located from the top left, in pixels. +// +//Row - Row on which the cusor is located from the top left, in pixels. +// + + +// +// IOCTL_VIDEO_QUERY_POINTER_ATTR - Returns all attributes of the pointer. +// +// IOCTL_VIDEO_SET_POINTER_ATTR - Is used to set the attributes of the +// pointer. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_POINTER_ATTRIBUTES { + ULONG Flags; + ULONG Width; + ULONG Height; + ULONG WidthInBytes; + ULONG Enable; + SHORT Column; + SHORT Row; + UCHAR Pixels[1]; +} VIDEO_POINTER_ATTRIBUTES, *PVIDEO_POINTER_ATTRIBUTES; + +// +//Flags - color or mono pointer, same as for query pointer capabilities. +// +//Width - Width of the pointer, in pixels. +// +//Height - Height of the pointer, in scans. +// +//WidthInBytes - Width of the pointer, in bytes. +// +//Enable - Non-zero to display pointer, 0 not to display. +// +//Column - Column on which the cursor is located from the top left, in pixels. +// +//Row - Row on which the cusor is located from the top left, in pixels. +// +//Pixels - Start of pointer data, in device-compatible DIB format. +// (Mask data is always in 1-bpp DIB format.) +// + + +// +// IOCTL_VIDEO_QUERY_POINTER_CAPABILITIES - Returns capabilities of miniport +// hardware cursor +// + +typedef struct _VIDEO_POINTER_CAPABILITIES { + ULONG Flags; + ULONG MaxWidth; + ULONG MaxHeight; + ULONG HWPtrBitmapStart; + ULONG HWPtrBitmapEnd; +} VIDEO_POINTER_CAPABILITIES, *PVIDEO_POINTER_CAPABILITIES; + +// +// Flag bit definitions +// + +#define VIDEO_MODE_ASYNC_POINTER 0x01 // 1 if the cursor can be updated + // asynchronously to drawing operations. +#define VIDEO_MODE_MONO_POINTER 0x02 // 1 if a monochrome hardware pointer + // is supported. +#define VIDEO_MODE_COLOR_POINTER 0x04 // 1 if a color hardware pointer is + // supported. +#define VIDEO_MODE_ANIMATE_START 0x08 // The pointer being passed down has +#define VIDEO_MODE_ANIMATE_UPDATE 0x10 // the same hotspot as the previous + // pointer +// +//MaxWidth - Widest pointer bitmap the miniport should be requested to load +// for either monochrome or color pointer. +// +//MaxHeight - widest pointer bitmap the miniport should be requested to load +// for either monochrome color pointer handled. +// +//HWPtrBitmapStart = first offset in bitmap of memory used to store hardware +// pointer bitmap, in CPU-addressable units (-1 if not applicable). For +// planar modes (like VGA mode 12h), this is a planar offset; for linear +// modes (like VGA mode 13h), this is a linear offset. The CPU-addressable +// translation in HC planar mode is assumed to be linearaddress/4, +// because there are four planes at each address. +// +//HWPtrBitmapEnd = last offset in bitmap of memory used to store hardware +// pointer bitmap (-1 if not applicable). +// +// Note: Miniport has options to reject any call to set a pointer. +// + + +// +// IOCTL_VIDEO_GET_BANK_SELECT_CODE - Called by the Windows display driver +// to get a block of executable code used +// to perform bank-switching in high +// resolution SVGA drivers. +// +// Gets information needed to implement banking control for a selected mode. +// +// Information used by this function is passed using the following structures: +// + +// +// The input from the caller in the input buffer is a VIDEO_MODE structure, as +// described under IOCTL_VIDEO_SET_CURRENT_MODE. +// +// RequestedMode - mode index for which banking information is desired. +// + +// +// Returned in output buffer. +// + +typedef struct _VIDEO_BANK_SELECT { + ULONG Length; + ULONG Size; + ULONG BankingFlags; + ULONG BankingType; + ULONG PlanarHCBankingType; + ULONG BitmapWidthInBytes; + ULONG BitmapSize; + ULONG Granularity; + ULONG PlanarHCGranularity; + ULONG CodeOffset; + ULONG PlanarHCBankCodeOffset; + ULONG PlanarHCEnableCodeOffset; + ULONG PlanarHCDisableCodeOffset; +} VIDEO_BANK_SELECT, *PVIDEO_BANK_SELECT; + +// +// Stored in the BankType and PlanarHCBankintType fields +// + +typedef enum _VIDEO_BANK_TYPE { + VideoNotBanked = 0, + VideoBanked1RW, + VideoBanked1R1W, + VideoBanked2RW, + NumVideoBankTypes +} VIDEO_BANK_TYPE, *PVIDEO_BANK_TYPE; + +// +// Defines for BankingFlags. +// + +#define PLANAR_HC 0x00000001 + +// +//Note: planar high-color ("planar HC") mode is a special 8-bpp-and-up +// CPU addressing mode in which four bytes can be accessed at +// once by using the VGA's planar hardware. This mode is enabled +// by turning off the Chain4 bit (bit 3 in Sequence Controller +// register 4), so it is also known as non-Chain4 mode. Planar HC +// mode can greatly accelerate operations such as solid fills, +// some pattern fills, and some blits. +// +//Note: the term "CPU-addressable bytes" means offsets measured +// in bytes as accessed by the CPU. In 16-color modes, this +// merely means "measured in bytes" rather than "measured in +// pixels," where each byte contains 8 pixels, as usual. +// In normal high-color modes, "CPU-addressable bytes" +// is exactly what you'd expect; it's the number of pixels in 256 +// color modes, pixels*2 in 16-bpp modes, and so on. However, in +// planar HC modes, there are four display memory bytes at every CPU- +// addressable byte, because four planes are at each address, so +// in 256 color modes the number of CPU-addressable bytes is +// pixels/4, in 16-bpp modes CPU-addressable bytes = pixels/2, and +// so on. Basically, "CPU-addressable bytes" just means the +// offsets the CPU needs to address banks properly in the +// specified mode. +// +//Note: the start address must be set to 0 (displayed pixels must +// start at offset 0 in display memory), and the banking windows +// must fit within the 64K area starting at A000:0; no 128K +// mappings, please, because there may be a monochrome adapter +// in the system. +// +//Length - Length of the basic structure. Used for versioning by checking the +// Length of the struct is at least as large as the value given by sizeof(). +// +//Size - number of bytes required to hold all banking information for +// this mode, including the VIDEO_BANK_SELECT structure and all +// bank-switch code. This is the size of the buffer that +// VgaGetBankSelectCode requires in order properly to return info. +// +//BankingFlags - indicate the type of banking supported in this mode. +// PLANAR_HC - if set, indicates that planar high-color (HC) mode +// (non-Chain4 8-, 15-, 16-, 24-, and 32-bpp) is supported. +// If this bit is set, the following fields must be filled in: +// PlanarHCGranularity, pPlanarHCBankCode, +// pPlanarHCEnableCode, pPlanarHCDisableCode. +// This bit is ignored by the 16-color driver, as are the +// associated fields. +// +//BankingType - These are the banking types supported by the adapter +// when it is ina standard mode. +// +// VideoNotBanked - this mode does not support or require banking. +// VideoBanked1RW - this mode supports a single RW (readable and +// writable) banking window. The window is assumed to be +// 64K in size. +// VideoBanked1R1W - this mode supports a single window, but the +// window can be mapped to different areas of display memory +// for reads and for writes. The window is assumed to be +// 64K in size. +// VideoBanked2RW - this mode supports two independently mappable +// banking windows, each RW. Each window is assumed to be +// 32K in size. The second window is assumed +// to start immediately after the end of the first, at +// A000:8000. +// +//PlanarHCBankingType - These are the banking types supported by the +// adapter when it is in a PLANAR HC mode. +// +// See BankingType for defintions of each banking type. +// +// +//BitmapWidthInBytes - distance from start of one scan line to start +// of next, counted in CPU-addressable bytes (not pixels). The +// CPU-addressable distance from one scan line to the next is +// assumed to be BitmapWidthInBytes/4 in planar HC modes, because +// there are four planes at each address. +// +//BitmapSize - size of display memory in CPU-addressable bytes (for +// example, 256K on a 1 Mb SVGA in 16-color mode, because there +// are four bytes at each address). The CPU-addressable bitmap +// size is assumed to be BitmapSize/4 in planar HC modes, because +// there are four planes at each address. +// +//Granularity - granularity with which display memory may be mapped +// into a banking window. (That is, resolution with which the +// display memory address mapped to the start of a window may be +// set; anywhere from 1K to 64K, depending on the adapter. If +// Granularity < window size (either 64K or 32K), then adjacent +// banks can overlap, and broken rasters can always be avoided. +// If Granularity == window size, then banks are disjoint, and +// display memory is basically segmented into banks.) Granularity +// is measured in CPU-addressable bytes. +// +//PlanarHCGranularity - granularity with which display memory may be +// mapped into a banking window in planar HC mode. +// PlanarHCGranularity is measured in CPU-addressable bytes, and +// is typically but not always Granularity/4. Ignored in +// 16-color modes. +// +//CodeOffset - base of the code section in the structure. +// +//PlanarHCBankCodeOffset - offset from Code of executable code +// that performs planar HC mode bank switching. Ignored in +// 16-color modes. +// +//PlanarHCEnableCodeOffset - offset from Code of executable code +// that enables planar HC mode. Ignored in 16-color modes. +// +//PlanarHCDisableCodeOffset - offset from Code of executable code +// that disables planar HC mode. Ignored in 16-color modes. +// +//Specification for bank switch code at Code: +// Executes requested bank mappings. +// +// Input: +// EAX = bank number to which to map window #0 +// EDX = bank number to which to map window #1 +// interpreted according to BankingType as follows: +// VideoBanked1RW - the single window is mapped to bank EAX, +// EBX is ignored. +// VideoBanked1RW - the read window is mapped to bank EAX, +// the write window is mapped to bank EBX +// VideoBanked1R1W - the window at A000:0 is mapped to bank EAX, +// the window at A800:0 is mapped to bank EBX +// +// Output: none +// +// Note: the definition of "bank n" is the bank that starts at +// display memory offset Granularity*n. In other words, +// banks are assumed to start every Granularity CPU-addressable +// bytes, and are numbered from 0 to number of banks-1. +// +//Specification for planar HC executable code: +// ***To be filled in when we get to planar HC modes*** +// + + +// +// IOCTL_VIDEO_MAP_VIDEO_MEMORY - Maps the frame buffer into the callers +// address space. +// IOCTL_VIDEO_UNMAP_VIDEO_MEMORY - Unmaps the frame buffer from the callers +// address space. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_MEMORY { + PVOID RequestedVirtualAddress; +} VIDEO_MEMORY, *PVIDEO_MEMORY; + +// +//RequestedVirtualAddress - For MAP: Requested virtual address for the video +// memory. This value is optional. If zero is specified, the operating +// system will choose an appropriate location. For UNMAP: Virtual Address +// of the base of video memory. The size is implicit since it can not +// change (you can not add video memory dynamically!). +// + +// IOCTL_VIDEO_SHARE_VIDEO_MEMORY - Maps the frame buffer to another process' +// address space. This IOCTL is initally +// defined to support DCI. +// IOCTL_VIDEO_UNSHARE_VIDEO_MEMORY - Unmaps a previously shared buffer. +// +// Note: for the MAP_VIDEO_MEMORY_IOCTL, the process handle is passed in +// the VirtualAddress filed, while for this IOCTL the handle is explicit. +// + +typedef struct _VIDEO_SHARE_MEMORY { + HANDLE ProcessHandle; + ULONG ViewOffset; + ULONG ViewSize; + PVOID RequestedVirtualAddress; +} VIDEO_SHARE_MEMORY, *PVIDEO_SHARE_MEMORY; + +typedef struct _VIDEO_SHARE_MEMORY_INFORMATION { + ULONG SharedViewOffset; + ULONG SharedViewSize; + PVOID VirtualAddress; +} VIDEO_SHARE_MEMORY_INFORMATION, *PVIDEO_SHARE_MEMORY_INFORMATION; + + +// +// IOCTL_VIDEO_MAP_VIDEO_MEMORY - Returns the virtual address and size of +// the frame buffer and video memory in the +// caller's address space. +// This IOCTL must be called after a call +// to the MAP IOCTL has been made. +// + +typedef struct _VIDEO_MEMORY_INFORMATION { + PVOID VideoRamBase; + ULONG VideoRamLength; + PVOID FrameBufferBase; + ULONG FrameBufferLength; +} VIDEO_MEMORY_INFORMATION, *PVIDEO_MEMORY_INFORMATION; + +// +//VideoRamBase - Virtual address of the Video RAM in the callers address space +// (only valid if the memory is mapped. +// +//VideoRamLength - Linear length of the Video RAM in the caller's virtual +// address space (memory accessible through a bank switch mechanism is not +// described by this value). +// This value must be equal to VideoMemoryBitmapHeight * ScreenStride +// +//FrameBufferBase - Virtual address of the Frame Buffer in the caller's +// address space. The Frame buffer is the actively displayed part of Video +// Ram. +// +//FrameBufferLength - Linear length of the Frame Buffer in the caller's +// virtual address space (memory accessible through a bank switch mechanism +// is not described by this value). +// This value must be equal to VisScreenWidth * ScreenStride +// + + +// +// IOCTL_VIDEO_QUERY_PUBLIC_ACCESS_RANGES - Returns the access range used to +// program the hardware directly. +// An array of these is returned if +// multiple ranges exist. +// +// IOCTL_VIDEO_FREE_PUBLIC_ACCESS_RANGES - Frees up the access ranges that were +// allocated by the QUERY_ACCESS_RANGES +// call. +// +// Information used by this function is passed using the following structure: +// + +typedef struct _VIDEO_PUBLIC_ACCESS_RANGES { + ULONG InIoSpace; + ULONG MappedInIoSpace; + PVOID VirtualAddress; +} VIDEO_PUBLIC_ACCESS_RANGES, *PVIDEO_PUBLIC_ACCESS_RANGES; + +// +//InIoSpace - Indicates if the hardware registers or ports are in IO space +// or in memory space. +// +//MappedInIoSpace - Indicates if under the current platform the registers or +// ports are mapped in IO Space or memory space. +// +//VirtualAddress - Location of the registers or IO ports as mapped under the +// current architecture. +// + + +// +// IOCTL_VIDEO_QUERY_COLOR_CAPABILITIES - Returns the color information +// found in the monitors VDDPs +// description file. +// +// NOTE: This structure must be filled out completely. A subset of the +// values can not be returned. +// + +typedef struct _VIDEO_COLOR_CAPABILITIES { + ULONG Length; + ULONG AttributeFlags; + LONG RedPhosphoreDecay; + LONG GreenPhosphoreDecay; + LONG BluePhosphoreDecay; + LONG WhiteChromaticity_x; + LONG WhiteChromaticity_y; + LONG WhiteChromaticity_Y; + LONG RedChromaticity_x; + LONG RedChromaticity_y; + LONG GreenChromaticity_x; + LONG GreenChromaticity_y; + LONG BlueChromaticity_x; + LONG BlueChromaticity_y; + LONG WhiteGamma; + LONG RedGamma; + LONG GreenGamma; + LONG BlueGamma; +} VIDEO_COLOR_CAPABILITIES, *PVIDEO_COLOR_CAPABILITIES; + +// +// Flag Bit definitions +// + +#define VIDEO_DEVICE_COLOR 0x1 // Is this device support color (1) + // or monochrome only +#define VIDEO_OPTIONAL_GAMMET_TABLE 0x2 // Indicates that a gammet table can + // be queried/set for the device + // use other IOCTLs for that purpose. +// +//Length - Length of the basic structure. Used for versioning by checking the +// Length of the struct is at least as large as the value given by sizeof(). +// +//AttributesFlag - List of falgs determining some of the properties of the +// device. +// +//See the VDDP documentation for the details on the various fields +// +//RedPhosphoreDecay +//GreenPhosphoreDecay +//BluePhosphoreDecay - +// +//WhiteChromaticity_x +//WhiteChromaticity_y +//WhiteChromaticity_Y - +// +//RedChromaticity_x +//RedChromaticity_y +//GreenChromaticity_x +//GreenChromaticity_y +//BlueChromaticity_x +//BlueChromaticity_y - +// +//WhiteGamma - +// +//RedGamma +//GreenGamma +//BlueGamma - +// +//All values returned in this structure are integers. +//The values returned must be floating point values * 10,000; i.e: +//a gamma of 2.34 would be returned as 23400. +// + + + +// +// IOCTL_VIDEO_SET_POWER_MANAGEMENT - Tells the device to change the power +// consumption level of the device to the +// new state. +// IOCTL_VIDEO_GET_POWER_MANAGEMENT - Return the current power consumption +// level of the device. +// +// Private IOCTLs intercepted by the video port: +// +// IOCTL_VIDEO_SET_OUTPUT_DEVICE_POWER_STATE - Sets the power state on the +// output device +// +// IOCTL_VIDEO_GET_OUTPUT_DEVICE_POWER_STATE - Returns if it is possible to set +// this partcular power state on the +// output device (monitor, TV). +// +// NOTE: +// This IOCTL is based on the VESA DPMS proposal. +// Changes to the DPMS standard will be refelcted in this IOCTL. +// + +typedef enum _VIDEO_POWER_STATE { + VideoPowerUnspecified = 0, + VideoPowerOn = 1, + VideoPowerStandBy, + VideoPowerSuspend, + VideoPowerOff, + VideoPowerHibernate, + VideoPowerShutdown, + VideoPowerMaximum +} VIDEO_POWER_STATE, *PVIDEO_POWER_STATE; + + +typedef struct _VIDEO_POWER_MANAGEMENT { + ULONG Length; + ULONG DPMSVersion; + ULONG PowerState; +} VIDEO_POWER_MANAGEMENT, *PVIDEO_POWER_MANAGEMENT; + +// +//Length - Length of the structure in bytes. Also used to do verisioning. +// +//DPMSVersion - Version of the DPMS standard supported by the device. +// Only used in the "GET" IOCTL. +// +//PowerState - One of the power states listed in VIDEO_POWER_STATE. +// + +// +// Note: +// Once the power has been turned off to the device, all other IOCTLs made +// to the miniport will be intercepted by the port driver and will return +// failiure, until the power on the device has been turned back on. +// + + +// +// IOCTL_VIDEO_SET_COLOR_LUT_DATA - Confugure color look up table on video adaptor. +// + +typedef struct _VIDEO_COLOR_LUT_DATA { + ULONG Length; + ULONG LutDataFormat; + UCHAR LutData[1]; +} VIDEO_COLOR_LUT_DATA, *PVIDEO_COLOR_LUT_DATA; + +// +// Length - Length of the structure in bytes. +// +// LutDataFormat values - indicate data format in ColorLutTable. +// +// LutDataTable - color lut table data. +// + +#define VIDEO_COLOR_LUT_DATA_FORMAT_RGB256WORDS 0x00000001 + +typedef struct _VIDEO_LUT_RGB256WORDS { + USHORT Red[256]; + USHORT Green[256]; + USHORT Blue[256]; +} VIDEO_LUT_RGB256WORDS, *PVIDEO_LUT_RGB256WORDS; + +#define VIDEO_COLOR_LUT_DATA_FORMAT_PRIVATEFORMAT 0x80000000 + +// +// VIDEO_COLOR_LUT_DATA_FORMAT_RGB256WORDS - +// Lut data has 3 array of 256 WORDs. 1st 256 WORDs array for Red, next +// for Blue, then Green. And its value have to be packed in the most +// significant bits of the WORDs (0 to 0xFF00 for 8 bit). This allows +// for 8, 12 and 16 bit RAMDAC independance. Thus Driver can shifts them +// right by 8, 4 or 0 places for 8, 12 and 16 bits RAMDAC. +// +// VIDEO_COLOR_LUT_DATA_FORMAT_PRIVATEFORMAT - +// Driver defined format. This value should be OR-ed with other driver +// internal identify index in 0 - 30 bits. Callee should know the detail +// format. +// + +// +// BANK_POSITION +// + +typedef struct _BANK_POSITION +{ + ULONG ReadBankPosition; + ULONG WriteBankPosition; +} BANK_POSITION, *PBANK_POSITION; + + +//----------------------------------------------------------------------------- +// +// Monitor control support (LCD brightness) +// +//----------------------------------------------------------------------------- + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// +// WARNING: Supported only for backwards compatibility with XPSP1 and should be retired - new code should use the new WMI interface +// +// IOCTL_VIDEO_QUERY_SUPPORTED_BRIGHTNESS - Queries via _BCL the available backlight +// levels. +// IOCTL_VIDEO_QUERY_DISPLAY_BRIGHTNESS - Queries the current AC/DC backlight levels +// and indicates the current power state per +// ucDisplayPolicy. +// IOCTL_VIDEO_SET_DISPLAY_BRIGHTNESS - Sets via _BCM the AC/DC brightness of the +// backlight for the power states indicated +// in ucDisplayPolicy. +// + +typedef struct _DISPLAY_BRIGHTNESS { + UCHAR ucDisplayPolicy; + UCHAR ucACBrightness; + UCHAR ucDCBrightness; +} DISPLAY_BRIGHTNESS, *PDISPLAY_BRIGHTNESS; + +#define DISPLAYPOLICY_AC 0x00000001 +#define DISPLAYPOLICY_DC 0x00000002 +#define DISPLAYPOLICY_BOTH (DISPLAYPOLICY_AC | DISPLAYPOLICY_DC) +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + + +// +// Used for setting brightness policy through the Device Power Policy Manager. +// +// DefaultToBiosPolicy implies that the brightness values should be adjusted +// to reflect the suggestions made by the BIOS. +// +// LevelCount is the number of structs that follow. +// +// BatteryLevel is the level below which the following Brightness applies. +// Brightness is a percentage that expresses how bright the screen should be +// at or below this BatteryLevel. +// + +typedef struct { + BOOLEAN DefaultToBiosPolicy; + UCHAR LevelCount; + struct { + UCHAR BatteryLevel; + UCHAR Brightness; + } Level[1]; +} VIDEO_BRIGHTNESS_POLICY, *PVIDEO_BRIGHTNESS_POLICY; + + +//----------------------------------------------------------------------------- +// +// East Asia fullscreen support +// +//----------------------------------------------------------------------------- + + +#ifndef _WINCON_ + +typedef struct _COORD { + SHORT X; + SHORT Y; +} COORD, *PCOORD; + +typedef struct _CHAR_INFO { + union { + WCHAR UnicodeChar; + CHAR AsciiChar; + } Char; + USHORT Attributes; +} CHAR_INFO, *PCHAR_INFO; + +// +// Attributes flags: +// + +#define FOREGROUND_BLUE 0x0001 // text color contains blue. +#define FOREGROUND_GREEN 0x0002 // text color contains green. +#define FOREGROUND_RED 0x0004 // text color contains red. +#define FOREGROUND_INTENSITY 0x0008 // text color is intensified. +#define BACKGROUND_BLUE 0x0010 // background color contains blue. +#define BACKGROUND_GREEN 0x0020 // background color contains green. +#define BACKGROUND_RED 0x0040 // background color contains red. +#define BACKGROUND_INTENSITY 0x0080 // background color is intensified. +#define COMMON_LVB_LEADING_BYTE 0x0100 // Leading Byte of DBCS +#define COMMON_LVB_TRAILING_BYTE 0x0200 // Trailing Byte of DBCS +#define COMMON_LVB_GRID_HORIZONTAL 0x0400 // DBCS: Grid attribute: top horizontal. +#define COMMON_LVB_GRID_LVERTICAL 0x0800 // DBCS: Grid attribute: left vertical. +#define COMMON_LVB_GRID_RVERTICAL 0x1000 // DBCS: Grid attribute: right vertical. +#define COMMON_LVB_REVERSE_VIDEO 0x4000 // DBCS: Reverse fore/back ground attribute. +#define COMMON_LVB_UNDERSCORE 0x8000 // DBCS: Underscore. + +#define COMMON_LVB_SBCSDBCS 0x0300 // SBCS or DBCS flag. + + + +// +// Share of conapi.h +// +#define CHAR_TYPE_SBCS 0 // Displayed SBCS character +#define CHAR_TYPE_LEADING 2 // Displayed leading byte of DBCS +#define CHAR_TYPE_TRAILING 3 // Displayed trailing byte of DBCS + + +// +// Share of foncache.h +// +#define BITMAP_BITS_BYTE_ALIGN 8 // BYTE align is 8 bit +#define BITMAP_BITS_WORD_ALIGN 16 // WORD align is 16 bit +#define BITMAP_ARRAY_BYTE 3 // BYTE array is 8 bit (shift count = 3) + +#define BITMAP_PLANES 1 +#define BITMAP_BITS_PIXEL 1 + + +#define BYTE_ALIGN sizeof(UCHAR) +#define WORD_ALIGN sizeof(USHORT) + + +#endif // _WINCON_ + + +typedef struct _FSCNTL_SCREEN_INFO { + COORD Position; + COORD ScreenSize; + ULONG nNumberOfChars; +} FSCNTL_SCREEN_INFO, *PFSCNTL_SCREEN_INFO; + + +typedef struct _FONT_IMAGE_INFO { + COORD FontSize; + PUCHAR ImageBits; // WORD aligned. +} FONT_IMAGE_INFO, *PFONT_IMAGE_INFO; + + +typedef struct _CHAR_IMAGE_INFO { + CHAR_INFO CharInfo; + FONT_IMAGE_INFO FontImageInfo; +} CHAR_IMAGE_INFO, *PCHAR_IMAGE_INFO; + +// +// Share of consrv.h +// +#define SCREEN_BUFFER_POINTER(X,Y,XSIZE,CELLSIZE) (((XSIZE * (Y)) + (X)) * (ULONG)CELLSIZE) + +typedef struct _VGA_CHAR { + CHAR Char; + CHAR Attributes; +} VGA_CHAR, *PVGA_CHAR; + + +// +// Define the Full Screen Video device name strings. +// + +#define DD_FULLSCREEN_VIDEO_DEVICE_NAME L"\\Device\\FSVideo" + + +// +// IOCTL_FSVIDEO_COPY_FRAME_BUFFER - Copy in the frame buffer. +// +typedef struct _FSVIDEO_COPY_FRAME_BUFFER { + FSCNTL_SCREEN_INFO SrcScreen; + FSCNTL_SCREEN_INFO DestScreen; +} FSVIDEO_COPY_FRAME_BUFFER, *PFSVIDEO_COPY_FRAME_BUFFER; + +// +// IOCTL_FSVIDEO_WRITE_TO_FRAME_BUFFER - Write to the frame buffer. +// +typedef struct _FSVIDEO_WRITE_TO_FRAME_BUFFER { + PCHAR_IMAGE_INFO SrcBuffer; + FSCNTL_SCREEN_INFO DestScreen; +} FSVIDEO_WRITE_TO_FRAME_BUFFER, *PFSVIDEO_WRITE_TO_FRAME_BUFFER; + +// +// IOCTL_FSVIDEO_REVERSE_MOUSE_POINTER - Reverse to the frame buffer for mouse pointer. +// +// dwType as follows: +// CHAR_TYPE_SBCS 0 // Displayed SBCS character +// CHAR_TYPE_LEADING 2 // Displayed leading byte of DBCS +// CHAR_TYPE_TRAILING 3 // Displayed trailing byte of DBCS +// +typedef struct _FSVIDEO_REVERSE_MOUSE_POINTER { + FSCNTL_SCREEN_INFO Screen; + ULONG dwType; +} FSVIDEO_REVERSE_MOUSE_POINTER, *PFSVIDEO_REVERSE_MOUSE_POINTER; + +// +// IOCTL_FSVIDEO_SET_CURRENT_MODE - Set the information for the current +// video mode. +// +// Information used by this function is passed using the following structure: +// +typedef struct _FSVIDEO_MODE_INFORMATION { + VIDEO_MODE_INFORMATION VideoMode; + VIDEO_MEMORY_INFORMATION VideoMemory; +} FSVIDEO_MODE_INFORMATION, *PFSVIDEO_MODE_INFORMATION; + +// +// IOCTL_FSVIDEO_SET_SCREEN_INFORMATION - Set the information for current console screen +// +typedef struct _FSVIDEO_SCREEN_INFORMATION { + COORD ScreenSize; + COORD FontSize; +} FSVIDEO_SCREEN_INFORMATION, *PFSVIDEO_SCREEN_INFORMATION; + + +// +// IOCTL_FSVIDEO_SET_CURSOR_POSITION - Set the information for cursor position +// +// dwType as follows: +// CHAR_TYPE_SBCS 0 // Displayed SBCS character +// CHAR_TYPE_LEADING 2 // Displayed leading byte of DBCS +// CHAR_TYPE_TRAILING 3 // Displayed trailing byte of DBCS +// +typedef struct _FSVIDEO_CURSOR_POSITION { + VIDEO_CURSOR_POSITION Coord; + ULONG dwType; +} FSVIDEO_CURSOR_POSITION, *PFSVIDEO_CURSOR_POSITION; + +// +// Opaque type for event objects. +// + +typedef struct _ENG_EVENT *PEVENT; + +typedef struct _ENG_EVENT { + PVOID pKEvent; + ULONG fFlags; + } ENG_EVENT, *PENG_EVENT; + +// +// Performance counter query information. +// + +#define VIDEO_REASON_NONE 0 +#define VIDEO_REASON_POLICY1 1 +#define VIDEO_REASON_POLICY2 2 +#define VIDEO_REASON_POLICY3 3 +#define VIDEO_REASON_POLICY4 4 +#define VIDEO_REASON_LOCK 5 +#define VIDEO_REASON_FAILED_ROTATION 5 +#define VIDEO_REASON_ALLOCATION 6 +#define VIDEO_REASON_SCRATCH 8 +#define VIDEO_REASON_CONFIGURATION 9 +#define VIDEO_MAX_REASON VIDEO_REASON_CONFIGURATION + +typedef struct _VIDEO_PERFORMANCE_COUNTER +{ + UINT64 NbOfAllocationEvicted[VIDEO_MAX_REASON+1]; + UINT64 NbOfAllocationMarked[VIDEO_MAX_REASON+1]; + UINT64 NbOfAllocationRestored[VIDEO_MAX_REASON+1]; + UINT64 KBytesEvicted[VIDEO_MAX_REASON+1]; + UINT64 KBytesMarked[VIDEO_MAX_REASON+1]; + UINT64 KBytesRestored[VIDEO_MAX_REASON+1]; + UINT64 NbProcessCommited; + UINT64 NbAllocationCommited; + UINT64 NbAllocationMarked; + UINT64 KBytesAllocated; + UINT64 KBytesAvailable; + UINT64 KBytesCurMarked; + UINT64 Reference; + UINT64 Unreference; + UINT64 TrueReference; + UINT64 NbOfPageIn; + UINT64 KBytesPageIn; + UINT64 NbOfPageOut; + UINT64 KBytesPageOut; + UINT64 NbOfRotateOut; + UINT64 KBytesRotateOut; +} VIDEO_PERFORMANCE_COUNTER, *PVIDEO_PERFORMANCE_COUNTER; + +typedef struct _VIDEO_QUERY_PERFORMANCE_COUNTER +{ + ULONG BufferSize; + PVIDEO_PERFORMANCE_COUNTER Buffer; +} VIDEO_QUERY_PERFORMANCE_COUNTER, *PVIDEO_QUERY_PERFORMANCE_COUNTER; + +// +// IOCTL_PANEL_QUERY_BRIGHTNESS_CAPS +// + +typedef enum _BRIGHTNESS_INTERFACE_VERSION +{ + BRIGHTNESS_INTERFACE_VERSION_1 = 1, + BRIGHTNESS_INTERFACE_VERSION_2 = 2, + BRIGHTNESS_INTERFACE_VERSION_3 = 3, +} BRIGHTNESS_INTERFACE_VERSION; + +typedef struct _PANEL_QUERY_BRIGHTNESS_CAPS{ + BRIGHTNESS_INTERFACE_VERSION Version; + union + { + struct + { + ULONG Smooth : 1; + ULONG Adaptive : 1; + ULONG NitsCalibrated: 1; + ULONG Reserved : 29; + }; + ULONG Value; + }; +} PANEL_QUERY_BRIGHTNESS_CAPS, *PPANEL_QUERY_BRIGHTNESS_CAPS; + +// +// IOCTL_PANEL_QUERY_BRIGHTNESS_RANGES +// + +#define BRIGHTNESS_MAX_LEVEL_COUNT 103 + +typedef struct _BRIGHTNESS_LEVEL +{ + UCHAR Count; + UCHAR Level[BRIGHTNESS_MAX_LEVEL_COUNT]; +} BRIGHTNESS_LEVEL, *PBRIGHTNESS_LEVEL; + +typedef struct _BRIGHTNESS_NIT_RANGE +{ + ULONG MinLevelInMillinit; + ULONG MaxLevelInMillinit; + ULONG StepSizeInMillinit; +} BRIGHTNESS_NIT_RANGE, *PBRIGHTNESS_NIT_RANGE; + +#define BRIGHTNESS_MAX_NIT_RANGE_COUNT 16 + +typedef struct BRIGHTNESS_NIT_RANGES +{ + ULONG NormalRangeCount; + ULONG RangeCount; + ULONG PreferredMaximumBrightness; + BRIGHTNESS_NIT_RANGE SupportedRanges[BRIGHTNESS_MAX_NIT_RANGE_COUNT]; +} BRIGHTNESS_NIT_RANGES, *PBRIGHTNESS_NIT_RANGES; + +typedef struct _PANEL_QUERY_BRIGHTNESS_RANGES{ + BRIGHTNESS_INTERFACE_VERSION Version; + union + { + BRIGHTNESS_LEVEL BrightnessLevel; + BRIGHTNESS_NIT_RANGES NitRanges; + }; +} PANEL_QUERY_BRIGHTNESS_RANGES, *PPANEL_QUERY_BRIGHTNESS_RANGES; + +// +// IOCTL_PANEL_GET_BRIGHTNESS +// + +typedef struct _PANEL_GET_BRIGHTNESS{ + BRIGHTNESS_INTERFACE_VERSION Version; + union + { + UCHAR Level; + struct + { + ULONG CurrentInMillinits; + ULONG TargetInMillinits; + }; + }; +} PANEL_GET_BRIGHTNESS, *PPANEL_GET_BRIGHTNESS; + +// +// IOCTL_PANEL_SET_BRIGHTNESS +// + +typedef struct _CHROMATICITY_COORDINATE +{ + float x; + float y; +} CHROMATICITY_COORDINATE; + +typedef struct _PANEL_BRIGHTNESS_SENSOR_DATA +{ + union + { + struct + { + ULONG AlsReadingValid : 1; + ULONG ChromaticityCoordinateValid : 1; + ULONG ColorTemperatureValid : 1; + ULONG Reserved : 29; + }; + ULONG Value; + }; + float AlsReading; + CHROMATICITY_COORDINATE ChromaticityCoordinate; + float ColorTemperature; +} PANEL_BRIGHTNESS_SENSOR_DATA; + +typedef struct _PANEL_SET_BRIGHTNESS{ + BRIGHTNESS_INTERFACE_VERSION Version; + union + { + UCHAR Level; + struct + { + ULONG Millinits; + ULONG TransitionTimeInMs; + PANEL_BRIGHTNESS_SENSOR_DATA SensorData; + }; + }; +} PANEL_SET_BRIGHTNESS, *PPANEL_SET_BRIGHTNESS; + +// +// IOCTL_PANEL_SET_BRIGHTNESS_STATE +// + +typedef struct _PANEL_SET_BRIGHTNESS_STATE{ + union + { + struct + { + ULONG Smooth : 1; // 0x00000001 + ULONG Reserved : 31; // 0xFFFFFFFE + }; + + ULONG Value; + }; +} PANEL_SET_BRIGHTNESS_STATE, *PPANEL_SET_BRIGHTNESS_STATE; + +// +// IOCTL_PANEL_SET_BACKLIGHT_OPTIMIZATION +// + +typedef enum _BACKLIGHT_OPTIMIZATION_LEVEL +{ + BacklightOptimizationDisable = 0, + BacklightOptimizationDesktop = 1, + BacklightOptimizationDynamic = 2, + BacklightOptimizationDimmed = 3, + BacklightOptimizationEDR = 4, +} BACKLIGHT_OPTIMIZATION_LEVEL; + +typedef struct _PANEL_SET_BACKLIGHT_OPTIMIZATION{ + BACKLIGHT_OPTIMIZATION_LEVEL Level; +} PANEL_SET_BACKLIGHT_OPTIMIZATION, *PPANEL_SET_BACKLIGHT_OPTIMIZATION; + +// +// IOCTL_PANEL_GET_BACKLIGHT_REDUCTION +// + +typedef struct _BACKLIGHT_REDUCTION_GAMMA_RAMP +{ + USHORT R[256]; + USHORT G[256]; + USHORT B[256]; +} BACKLIGHT_REDUCTION_GAMMA_RAMP; + +typedef struct _PANEL_GET_BACKLIGHT_REDUCTION{ + USHORT BacklightUsersetting; + USHORT BacklightEffective; + BACKLIGHT_REDUCTION_GAMMA_RAMP GammaRamp; +} PANEL_GET_BACKLIGHT_REDUCTION, *PPANEL_GET_BACKLIGHT_REDUCTION; + +// +// IOCTL_COLORSPACE_TRANSFORM_QUERY_TARGET_CAPS +// +typedef enum _COLORSPACE_TRANSFORM_DATA_TYPE +{ + COLORSPACE_TRANSFORM_DATA_TYPE_FIXED_POINT = 0, + COLORSPACE_TRANSFORM_DATA_TYPE_FLOAT, +}COLORSPACE_TRANSFORM_DATA_TYPE; + +typedef struct _COLORSPACE_TRANSFORM_DATA_CAP +{ + COLORSPACE_TRANSFORM_DATA_TYPE DataType; + union + { + struct + { + ULONG BitCountOfInteger : 6; // Bit count of integer if DataType is fixed-point(COLORSPACE_TRANSFORM_DATA_TYPE_FIXED_POINT) + ULONG BitCountOfFraction: 6; // Bit count of fraction if DataType is fixed-point(COLORSPACE_TRANSFORM_DATA_TYPE_FIXED_POINT) + }; + + struct + { + ULONG BitCountOfExponent: 6; // Bit count of exponent if the DataType is float(COLORSPACE_TRANSFORM_DATA_TYPE_FLOAT) + ULONG BitCountOfMantissa: 6; // Bit count of mantissa if the DataType is float(COLORSPACE_TRANSFORM_DATA_TYPE_FLOAT) + }; + + ULONG Value; + }; + + float NumericRangeMin; // Minimum number of gamma data + float NumericRangeMax; // Maximum number of gamma data + // Examples: [-4, 4]: NumericRangeMin = -4; NumericRangeMax = 4 + // [0, 1]: NumericRangeMin = 0; NumericRangeMax = 1 + // [-1.5, 2.5]:NumericRangeMin = -1.5; NumericRangeMax = 2.5 + // [0, 65504]: NumericRangeMin = 0; NumericRangeMax = 65504 + +}COLORSPACE_TRANSFORM_DATA_CAP; + +typedef struct _COLORSPACE_TRANSFORM_1DLUT_CAP +{ + ULONG NumberOfLUTEntries; // Number of lookup table entries. + COLORSPACE_TRANSFORM_DATA_CAP DataCap; +}COLORSPACE_TRANSFORM_1DLUT_CAP, *PCOLORSPACE_TRANSFORM_1DLUT_CAP; + +typedef struct _COLORSPACE_TRANSFORM_MATRIX_CAP +{ + union + { + struct + { + ULONG MatrixSizeX : 10; // X-dimension of Matrix + ULONG MatrixSizeY : 10; // Y-dimension of Matrix + // Examples 3x3 ColorMatrix : SizeX = 3; SizeY = 3; + // 3x11 ColorMatrix: SizeX = 3; SizeY = 11; + }; + ULONG Value; + }; + COLORSPACE_TRANSFORM_DATA_CAP DataCap; +}COLORSPACE_TRANSFORM_MATRIX_CAP, *PCOLORSPACE_TRANSFORM_MATRIX_CAP; + +typedef enum _COLORSPACE_TRANSFORM_TARGET_CAPS_VERSION +{ + COLORSPACE_TRANSFORM_VERSION_DEFAULT = 0, + COLORSPACE_TRANSFORM_VERSION_1 = 1, + COLORSPACE_TRANSFORM_VERSION_NOT_SUPPORTED = COLORSPACE_TRANSFORM_VERSION_DEFAULT, +}COLORSPACE_TRANSFORM_TARGET_CAPS_VERSION; + +typedef struct _COLORSPACE_SCALAR_MULTIPLIER_CAPS +{ + BOOLEAN Valid; + float NumericRangeMin; + float NumericRangeMax; +}COLORSPACE_SCALAR_MULTIPLIER_CAPS; + +typedef struct _COLORSPACE_TRANSFORM_TARGET_CAPS +{ + COLORSPACE_TRANSFORM_TARGET_CAPS_VERSION Version; + COLORSPACE_TRANSFORM_1DLUT_CAP LookupTable1DDegammaCap; + COLORSPACE_TRANSFORM_MATRIX_CAP ColorMatrix3x3Cap; + COLORSPACE_TRANSFORM_1DLUT_CAP LookupTable1DRegammaCap; +}COLORSPACE_TRANSFORM_TARGET_CAPS, *PCOLORSPACE_TRANSFORM_TARGET_CAPS; + +// +// IOCTL_COLORSPACE_TRANSFORM_SET +// +typedef enum _COLORSPACE_TRANSFORM_TYPE +{ + COLORSPACE_TRANSFORM_TYPE_UNINITIALIZED = 0, + COLORSPACE_TRANSFORM_TYPE_DEFAULT = 1, + COLORSPACE_TRANSFORM_TYPE_RGB256x3x16 = 2, + COLORSPACE_TRANSFORM_TYPE_DXGI_1 = 3, + COLORSPACE_TRANSFORM_TYPE_MATRIX_3x4 = 4, + COLORSPACE_TRANSFORM_TYPE_MATRIX_V2 = 5, +} COLORSPACE_TRANSFORM_TYPE; + +typedef struct _GAMMA_RAMP_RGB256x3x16 +{ + USHORT Red[256]; + USHORT Green[256]; + USHORT Blue[256]; +} GAMMA_RAMP_RGB256x3x16; + +typedef struct _GAMMA_RAMP_RGB +{ + float Red; + float Green; + float Blue; +} GAMMA_RAMP_RGB; + +typedef struct _GAMMA_RAMP_DXGI_1 +{ + GAMMA_RAMP_RGB Scale; + GAMMA_RAMP_RGB Offset; + GAMMA_RAMP_RGB GammaCurve[1025]; +} GAMMA_RAMP_DXGI_1; + +typedef struct _COLORSPACE_TRANSFORM_3x4 +{ + float ColorMatrix3x4[3][4]; + float ScalarMultiplier; + GAMMA_RAMP_RGB LookupTable1D[4096]; +} COLORSPACE_TRANSFORM_3x4, *PCOLORSPACE_TRANSFORM_3x4; + +typedef enum _OUTPUT_WIRE_COLOR_SPACE_TYPE +{ + OUTPUT_WIRE_COLOR_SPACE_G22_P709 = 0, + OUTPUT_WIRE_COLOR_SPACE_RESERVED = 4, + OUTPUT_WIRE_COLOR_SPACE_G2084_P2020 = 12, + OUTPUT_WIRE_COLOR_SPACE_G22_P709_WCG = 30, + OUTPUT_WIRE_COLOR_SPACE_G22_P2020 = 31, + OUTPUT_WIRE_COLOR_SPACE_G2084_P2020_HDR10PLUS = 32, + OUTPUT_WIRE_COLOR_SPACE_G2084_P2020_DVLL = 33, +} OUTPUT_WIRE_COLOR_SPACE_TYPE; + +typedef enum _OUTPUT_COLOR_ENCODING +{ + OUTPUT_COLOR_ENCODING_RGB = 0, + OUTPUT_COLOR_ENCODING_YCBCR444 = 1, + OUTPUT_COLOR_ENCODING_YCBCR422 = 2, + OUTPUT_COLOR_ENCODING_YCBCR420 = 3, + OUTPUT_COLOR_ENCODING_INTENSITY = 4, + OUTPUT_COLOR_ENCODING_FORCE_UINT32 = 0xFFFFFFFF +} OUTPUT_COLOR_ENCODING; + +typedef struct _OUTPUT_WIRE_FORMAT +{ + OUTPUT_COLOR_ENCODING ColorEncoding; + UINT32 BitsPerPixel; +} OUTPUT_WIRE_FORMAT; + +typedef enum _COLORSPACE_TRANSFORM_STAGE_CONTROL +{ + ColorSpaceTransformStageControl_No_Change = 0, + ColorSpaceTransformStageControl_Enable = 1, + ColorSpaceTransformStageControl_Bypass = 2, +}COLORSPACE_TRANSFORM_STAGE_CONTROL, *PCOLORSPACE_TRANSFORM_STAGE_CONTROL; + +typedef struct _COLORSPACE_TRANSFORM_MATRIX_V2 +{ + // stage of 1D Degamma. + COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlLookupTable1DDegamma; + GAMMA_RAMP_RGB LookupTable1DDegamma[4096]; + + // stage of 3x3 matrix + COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlColorMatrix3x3; + float ColorMatrix3x3[3][3]; + + // stage of 1D Regamma. + COLORSPACE_TRANSFORM_STAGE_CONTROL StageControlLookupTable1DRegamma; + GAMMA_RAMP_RGB LookupTable1DRegamma[4096]; +} COLORSPACE_TRANSFORM_MATRIX_V2, *PCOLORSPACE_TRANSFORM_MATRIX_V2; + +typedef struct _COLORSPACE_TRANSFORM +{ + COLORSPACE_TRANSFORM_TYPE Type; + union + { + GAMMA_RAMP_RGB256x3x16 Rgb256x3x16; // Type == COLORSPACE_TRANSFORM_TYPE_RGB256x3x16. + GAMMA_RAMP_DXGI_1 Dxgi1; // Type == COLORSPACE_TRANSFORM_TYPE_DXGI_1. + COLORSPACE_TRANSFORM_3x4 T3x4; // Type == COLORSPACE_TRANSFORM_TYPE_MATRIX_3x4. + COLORSPACE_TRANSFORM_MATRIX_V2 MatrixV2; // Type == COLORSPACE_TRANSFORM_TYPE_MATRIX_V2. + } Data; +} COLORSPACE_TRANSFORM, *PCOLORSPACE_TRANSFORM; + +typedef struct _COLORSPACE_TRANSFORM_SET_INPUT +{ + OUTPUT_WIRE_COLOR_SPACE_TYPE OutputWireColorSpaceExpected; + OUTPUT_WIRE_FORMAT OutputWireFormatExpected; + COLORSPACE_TRANSFORM ColorSpaceTransform; +}COLORSPACE_TRANSFORM_SET_INPUT, *PCOLORSPACE_TRANSFORM_SET_INPUT; + +// +// IOCTL_SET_ACTIVE_COLOR_PROFILE_NAME +// +typedef struct _SET_ACTIVE_COLOR_PROFILE_NAME +{ + WCHAR ColorProfileName[1]; +}SET_ACTIVE_COLOR_PROFILE_NAME, *PSET_ACTIVE_COLOR_PROFILE_NAME; + + +// +// IOCTL_MIPI_DSI_QUERY_CAPS +// +typedef struct _MIPI_DSI_CAPS +{ + UCHAR DSITypeMajor; + UCHAR DSITypeMinor; + + UCHAR SpecVersionMajor; + UCHAR SpecVersionMinor; + UCHAR SpecVersionPatch; + + USHORT TargetMaximumReturnPacketSize; + + UCHAR ResultCodeFlags; + UCHAR ResultCodeStatus; + UCHAR Revision; + UCHAR Level; + + UCHAR DeviceClassHi; + UCHAR DeviceClassLo; + UCHAR ManufacturerHi; + UCHAR ManufacturerLo; + + UCHAR ProductHi; + UCHAR ProductLo; + UCHAR LengthHi; + UCHAR LengthLo; +} MIPI_DSI_CAPS, *PMIPI_DSI_CAPS; + +// +// IOCTL_MIPI_DSI_TRANSMISSION +// +typedef enum _DSI_CONTROL_TRANSMISSION_MODE +{ + DCT_DEFAULT = 0, + DCT_FORCE_LOW_POWER, + DCT_FORCE_HIGH_PERFORMANCE, +} DSI_CONTROL_TRANSMISSION_MODE; + +#define DSI_PACKET_EMBEDDED_PAYLOAD_SIZE 8 + +typedef struct _MIPI_DSI_PACKET +{ + union + { + UCHAR DataId; + struct + { + UCHAR DataType :6; + UCHAR VirtualChannel :2; + }; + }; + + union + { + struct + { + UCHAR Data0; + UCHAR Data1; + }; + USHORT LongWriteWordCount; + }; + + UCHAR EccFiller; + + UCHAR Payload[DSI_PACKET_EMBEDDED_PAYLOAD_SIZE]; +} MIPI_DSI_PACKET; + +typedef struct _MIPI_DSI_TRANSMISSION +{ + ULONG TotalBufferSize; // in + UCHAR PacketCount; // in + UCHAR FailedPacket; // out + + struct + { + USHORT TransmissionMode : 2; // in + USHORT ReportMipiErrors : 1; // in + USHORT ClearMipiErrors : 1; // in + USHORT SecondaryPort : 1; // in + USHORT ManufacturingMode : 1; // in + USHORT Reserved :10; + }; + + USHORT ReadWordCount; // out + USHORT FinalCommandExtraPayload; // in + + USHORT MipiErrors; // out + USHORT HostErrors; // out + + _Field_size_(PacketCount) + MIPI_DSI_PACKET Packets[1]; // inout +} MIPI_DSI_TRANSMISSION; + +// +// Maximum PacketCount allowed. +// +#define MAX_PACKET_COUNT 0x80 + +// +//If not known or there is no detected packet error, DSI_INVALID_PACKET_INDEX +//is set to FailedPacket. +// +#define DSI_INVALID_PACKET_INDEX 0xFF + +// +// MipiErrors reported by communication with the peripheral +// +#define DSI_SOT_ERROR 0x0001 +#define DSI_SOT_SYNC_ERROR 0x0002 +#define DSI_EOT_SYNC_ERROR 0x0004 +#define DSI_ESCAPE_MODE_ENTRY_COMMAND_ERROR 0x0008 +#define DSI_LOW_POWER_TRANSMIT_SYNC_ERROR 0x0010 +#define DSI_PERIPHERAL_TIMEOUT_ERROR 0x0020 +#define DSI_FALSE_CONTROL_ERROR 0x0040 +#define DSI_CONTENTION_DETECTED 0x0080 +#define DSI_CHECKSUM_ERROR_CORRECTED 0x0100 +#define DSI_CHECKSUM_ERROR_NOT_CORRECTED 0x0200 +#define DSI_LONG_PACKET_PAYLOAD_CHECKSUM_ERROR 0x0400 +#define DSI_DSI_DATA_TYPE_NOT_RECOGNIZED 0x0800 +#define DSI_DSI_VC_ID_INVALID 0x1000 +#define DSI_INVALID_TRANSMISSION_LENGTH 0x2000 +// RESERVED 0x4000 +#define DSI_DSI_PROTOCOL_VIOLATION 0x8000 + +// +// HostErrors reported by the graphics driver or OS +// +#define HOST_DSI_DEVICE_NOT_READY 0x0001 +#define HOST_DSI_INTERFACE_RESET 0x0002 +#define HOST_DSI_DEVICE_RESET 0x0004 +#define HOST_DSI_TRANSMISSION_CANCELLED 0x0010 +#define HOST_DSI_TRANSMISSION_DROPPED 0x0020 +#define HOST_DSI_TRANSMISSION_TIMEOUT 0x0040 +#define HOST_DSI_INVALID_TRANSMISSION 0x0100 +#define HOST_DSI_OS_REJECTED_PACKET 0x0200 +#define HOST_DSI_DRIVER_REJECTED_PACKET 0x0400 +#define HOST_DSI_BAD_TRANSMISSION_MODE 0x1000 + +typedef MIPI_DSI_TRANSMISSION MIPI_DSI_TRANSMISSION_INPUT, *PMIPI_DSI_TRANSMISSION_INPUT; +typedef MIPI_DSI_TRANSMISSION MIPI_DSI_TRANSMISSION_OUTPUT, *PMIPI_DSI_TRANSMISSION_OUTPUT; + +// +// IOCTL_MIPI_DSI_RESET +// +typedef struct _MIPI_DSI_RESET +{ + ULONG Flags; // in + union + { + struct + { + ULONG MipiErrors :16; // out + ULONG ResetFailed : 1; // out + ULONG NeedModeSet : 1; // out + }; + ULONG Results; // out + }; +} MIPI_DSI_RESET, *PMIPI_DSI_RESET; + +typedef MIPI_DSI_RESET MIPI_DSI_RESET_INPUT, *PMIPI_DSI_RESET_INPUT; +typedef MIPI_DSI_RESET MIPI_DSI_RESET_OUTPUT, *PMIPI_DSI_RESET_OUTPUT; + +// +// Monitor override types +// + +// {F196C02F-F86F-4F9A-AA15-E9CEBDFE3B96} +DEFINE_GUID(GUID_MONITOR_OVERRIDE_PSEUDO_SPECIALIZED, 0xf196c02f, 0xf86f, 0x4f9a, 0xaa, 0x15, 0xe9, 0xce, 0xbd, 0xfe, 0x3b, 0x96); + +// {0457E531-3CB9-4A07-83C1-A79146C64DB3} +DEFINE_GUID(GUID_MONITOR_OVERRIDE_TEST_SPECIALIZED, 0x457e531, 0x3cb9, 0x4a07, 0x83, 0xc1, 0xa7, 0x91, 0x46, 0xc6, 0x4d, 0xb3); + +#ifdef __cplusplus +} +#endif + +#endif // !GUID_DEFS_ONLY + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _NTDDVDEO_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvol.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvol.h new file mode 100644 index 0000000000000000000000000000000000000000..16b67bcbe7be1aabbbef3ef20894d8bd163dc9ed --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntddvol.h @@ -0,0 +1,1105 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntddvol.h + +Abstract: + + This module contains type and function definitions for NT volumes. + + This module may contain definitions that are exposed in public + kit headers. + +--*/ + + +#ifndef _NTDDVOL_ +#define _NTDDVOL_ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#include + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) /* padding added after data member */ +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifndef IOCTL_VOLUME_BASE +// begin_winioctl + +#define IOCTL_VOLUME_BASE 0x00000056 // 'V' + +#if (NTDDI_VERSION >= NTDDI_WIN2K) + +// +// IOCTL to obtain the physical location of +// the specified volume on one or more disks. +// + +#define IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS CTL_CODE(IOCTL_VOLUME_BASE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type VOLUME_DISK_EXTENTS +// + +typedef struct _DISK_EXTENT { + + // + // Specifies the storage device number of + // the disk on which this extent resides. + // + ULONG DiskNumber; + + // + // Specifies the offset and length of this + // extent relative to the beginning of the + // disk. + // + LARGE_INTEGER StartingOffset; + LARGE_INTEGER ExtentLength; + +} DISK_EXTENT, *PDISK_EXTENT; + +typedef struct _VOLUME_DISK_EXTENTS { + + // + // Specifies one or more contiguous range + // of sectors that make up this volume. + // + ULONG NumberOfDiskExtents; + DISK_EXTENT Extents[ANYSIZE_ARRAY]; + +} VOLUME_DISK_EXTENTS, *PVOLUME_DISK_EXTENTS; + + +// +// IOCTLs to transition the specified volume +// between r/w and non r/w modes. +// + +#define IOCTL_VOLUME_ONLINE CTL_CODE(IOCTL_VOLUME_BASE, 2, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_VOLUME_OFFLINE CTL_CODE(IOCTL_VOLUME_BASE, 3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_VOLUME_ONLINE +// IOCTL_VOLUME_OFFLINE +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +#endif // NTDDI_VERSION >= NTDDI_WIN2K + + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// +// IOCTL to determine whether the specified +// volume resides on a disk that is an online +// cluster resource or not. +// + +#define IOCTL_VOLUME_IS_CLUSTERED CTL_CODE(IOCTL_VOLUME_BASE, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_IS_CLUSTERED +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +// +// IOCTL to query the attributes on volumes. +// + +#define IOCTL_VOLUME_GET_GPT_ATTRIBUTES CTL_CODE(IOCTL_VOLUME_BASE, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_GET_GPT_ATTRIBUTES +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type VOLUME_GET_GPT_ATTRIBUTES_INFORMATION +// + +typedef struct _VOLUME_GET_GPT_ATTRIBUTES_INFORMATION { + + // + // Specifies all the attributes + // associated with this volume. + // + ULONGLONG GptAttributes; + +} VOLUME_GET_GPT_ATTRIBUTES_INFORMATION, *PVOLUME_GET_GPT_ATTRIBUTES_INFORMATION; + +#endif // NTDDI_VERSION >= NTDDI_WINXP + +// end_winioctl +#endif // IOCTL_VOLUME_BASE + + +#if (NTDDI_VERSION >= NTDDI_WIN2K) + +// +// Legacy IOCTLs that were used to support +// clustering. +// + +#define IOCTL_VOLUME_SUPPORTS_ONLINE_OFFLINE CTL_CODE(IOCTL_VOLUME_BASE, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VOLUME_IS_OFFLINE CTL_CODE(IOCTL_VOLUME_BASE, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VOLUME_IS_IO_CAPABLE CTL_CODE(IOCTL_VOLUME_BASE, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VOLUME_QUERY_FAILOVER_SET CTL_CODE(IOCTL_VOLUME_BASE, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_SUPPORTS_ONLINE_OFFLINE +// IOCTL_VOLUME_IS_OFFLINE +// IOCTL_VOLUME_IS_IO_CAPABLE +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +// +// IOCTL_VOLUME_QUERY_FAILOVER_SET +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type VOLUME_FAILOVER_SET +// + +typedef struct _VOLUME_FAILOVER_SET { + + // + // Specifies all of the disks that are + // part of the pack that this volume is + // part of. + // + ULONG NumberOfDisks; + ULONG DiskNumbers[ANYSIZE_ARRAY]; + +} VOLUME_FAILOVER_SET, *PVOLUME_FAILOVER_SET; + + +// +// IOCTL to obtain general information about +// the specified volume. +// + +#define IOCTL_VOLUME_QUERY_VOLUME_NUMBER CTL_CODE(IOCTL_VOLUME_BASE, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VOLUME_LOGICAL_TO_PHYSICAL CTL_CODE(IOCTL_VOLUME_BASE, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_VOLUME_PHYSICAL_TO_LOGICAL CTL_CODE(IOCTL_VOLUME_BASE, 9, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_QUERY_VOLUME_NUMBER +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type VOLUME_NUMBER +// + +typedef struct _VOLUME_NUMBER { + + // + // Specifies the number associated + // with this volume for the current + // session. + // + ULONG VolumeNumber; + + // + // Specifies the name of the volume + // manager driver. If this is less + // than 8, it is padded with blanks. + // + WCHAR VolumeManagerName[8]; + +} VOLUME_NUMBER, *PVOLUME_NUMBER; + +// +// IOCTL_VOLUME_LOGICAL_TO_PHYSICAL +// +// Input Buffer: +// Structure of type VOLUME_LOGICAL_OFFSET +// +// Output Buffer: +// Structure of type VOLUME_PHYSICAL_OFFSETS +// + +typedef struct _VOLUME_LOGICAL_OFFSET { + + // + // Specifies the logical location + // that needs to be translated to + // a physical location. + // + LONGLONG LogicalOffset; + +} VOLUME_LOGICAL_OFFSET, *PVOLUME_LOGICAL_OFFSET; + +typedef struct _VOLUME_PHYSICAL_OFFSET { + + // + // Specifies the physical location + // that needs to be translated to + // a logical location. + // + ULONG DiskNumber; + LONGLONG Offset; + +} VOLUME_PHYSICAL_OFFSET, *PVOLUME_PHYSICAL_OFFSET; + +typedef struct _VOLUME_PHYSICAL_OFFSETS { + + // + // Specifies one or more physical + // locations on which the logical + // location resides. + // + ULONG NumberOfPhysicalOffsets; + VOLUME_PHYSICAL_OFFSET PhysicalOffset[ANYSIZE_ARRAY]; + +} VOLUME_PHYSICAL_OFFSETS, *PVOLUME_PHYSICAL_OFFSETS; + +// +// IOCTL_VOLUME_PHYSICAL_TO_LOGICAL +// +// Input Buffer: +// Structure of type VOLUME_PHYSICAL_OFFSET +// +// Output Buffer: +// Structure of type VOLUME_LOGICAL_OFFSET +// + +#endif // NTDDI_VERSION >= NTDDI_WIN2K + + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// +// IOCTL to determine whether the volume +// is suitable for OS installation or not. +// + +#define IOCTL_VOLUME_IS_PARTITION CTL_CODE(IOCTL_VOLUME_BASE, 10, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_IS_PARTITION +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + + +// +// IOCTL to perform a read operation from +// the specified plex of a mirrored volume. +// + +#define IOCTL_VOLUME_READ_PLEX CTL_CODE(IOCTL_VOLUME_BASE, 11, METHOD_OUT_DIRECT, FILE_READ_ACCESS) + +// +// IOCTL_VOLUME_READ_PLEX +// +// Input Buffer: +// Structure of type VOLUME_READ_PLEX_INPUT +// +// Output Buffer: +// None +// + +typedef struct _VOLUME_READ_PLEX_INPUT { + + // + // Specifies the offset within the + // volume from where to read data. + // + LARGE_INTEGER ByteOffset; + + // + // Specifies the amount of data in + // bytes to be read in. + // + ULONG Length; + + // + // Specifies the plex from which the + // data is to be read in. + // + ULONG PlexNumber; + +} VOLUME_READ_PLEX_INPUT, *PVOLUME_READ_PLEX_INPUT; + + +// +// IOCTL to modify the attributes on volumes. +// + +#define IOCTL_VOLUME_SET_GPT_ATTRIBUTES CTL_CODE(IOCTL_VOLUME_BASE, 13, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_SET_GPT_ATTRIBUTES +// +// Input Buffer: +// Structure of type VOLUME_SET_GPT_ATTRIBUTES_INFORMATION +// +// Output Buffer: +// None +// + +typedef struct _VOLUME_SET_GPT_ATTRIBUTES_INFORMATION { + + // + // Specifies the attributes that + // are to be applied to the volume + // + ULONGLONG GptAttributes; + + // + // Indicates whether this is to be + // undone when the handle is closed + // + BOOLEAN RevertOnClose; + + // + // Indicates whether the attributes + // apply to all the volumes on the + // disk that this volume resides on + // Required if the disk layout is MBR + // + BOOLEAN ApplyToAllConnectedVolumes; + + // + // For alignment purposes. + // + USHORT Reserved1; + ULONG Reserved2; + +} VOLUME_SET_GPT_ATTRIBUTES_INFORMATION, *PVOLUME_SET_GPT_ATTRIBUTES_INFORMATION; + +#endif // NTDDI_VERSION >= NTDDI_WINXP + + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +// +// IOCTLs for bandwidth contracts +// on volumes. +// + +#define IOCTL_VOLUME_GET_BC_PROPERTIES CTL_CODE(IOCTL_VOLUME_BASE, 15, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_VOLUME_ALLOCATE_BC_STREAM CTL_CODE(IOCTL_VOLUME_BASE, 16, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_VOLUME_FREE_BC_STREAM CTL_CODE(IOCTL_VOLUME_BASE, 17, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_VOLUME_BC_VERSION 1 + +// +// IOCTL_VOLUME_GET_BC_PROPERTIES +// +// Input Buffer: +// Structure of type VOLUME_GET_BC_PROPERTIES_INPUT +// +// Output Buffer: +// Structure of type VOLUME_GET_BC_PROPERTIES_OUTPUT +// + +typedef struct _VOLUME_GET_BC_PROPERTIES_INPUT { + + // + // Specifies the corresponding structure + // version. + // + ULONG Version; + + // + // For alignment purposes. + // + ULONG Reserved1; + + // + // Specifies the lowest byte offset of + // the file that is to be streamed. + // + ULONGLONG LowestByteOffset; + + // + // Specifies the highest byte offset of + // the file that is to be streamed. + // + ULONGLONG HighestByteOffset; + + // + // Indicates whether requests shall be + // comprised of reads, writes or both. + // + ULONG AccessType; + + // + // Indicates whether the Io requests to + // the file will be sequential or not. + // + ULONG AccessMode; + +} VOLUME_GET_BC_PROPERTIES_INPUT, *PVOLUME_GET_BC_PROPERTIES_INPUT; + +typedef struct _VOLUME_GET_BC_PROPERTIES_OUTPUT { + + // + // Specifies the maximum number of requests + // that can be scheduled per period of time. + // + ULONG MaximumRequestsPerPeriod; + + // + // Specifies the minimum period that the + // device uses when scheduling requests. + // + ULONG MinimumPeriod; + + // + // Specifies the maximum transfer size supported + // for bandwidth contracts on this device. To + // achieve the highest level of performance, all + // requests should be of this size. + // + ULONGLONG MaximumRequestSize; + + // + // Specifies the estimated time taken to + // perform an Io operation. This field + // is for informational purposes only. + // + ULONG EstimatedTimePerRequest; + + // + // Specifies the number of requests that should be + // kept outstanding. This helps keep the device + // device busy and thus obtain maximum throughput + // This will only be filled in if the target file + // has an outstanding contract. + // + ULONG NumOutStandingRequests; + + // + // Specifies the required size of requests in this + // stream. This will only be filled in if the + // target file has an outstanding contract. + // + ULONGLONG RequestSize; + +} VOLUME_GET_BC_PROPERTIES_OUTPUT, *PVOLUME_GET_BC_PROPERTIES_OUTPUT; + +// +// IOCTL_VOLUME_ALLOCATE_BC_STREAM +// +// Input Buffer: +// Structure of type VOLUME_ALLOCATE_BC_STREAM_INPUT +// +// Output Buffer: +// Structure of type VOLUME_ALLOCATE_BC_STREAM_OUTPUT +// + +typedef struct _VOLUME_ALLOCATE_BC_STREAM_INPUT { + + // + // Specifies the corresponding structure + // version. + // + ULONG Version; + + // + // Specifies the number of requests that + // need to complete per period of time. + // + ULONG RequestsPerPeriod; + + // + // Specifies the period of time wherein the + // above number of requests must complete. + // + ULONG Period; + + // + // Indicates whether failures should be + // be retried or not. + // + BOOLEAN RetryFailures; + + // + // Indicates whether reqests that miss + // their deadline should be discarded + // or not. + // + BOOLEAN Discardable; + + // + // For alignment purposes. + // + BOOLEAN Reserved1[2]; + + // + // Specifies the lowest byte offset of + // the file that is to be streamed. + // + ULONGLONG LowestByteOffset; + + // + // Specifies the highest byte offset of + // the file that is to be streamed. + // + ULONGLONG HighestByteOffset; + + // + // Indicates whether requests shall be + // comprised of reads, writes or both. + // + ULONG AccessType; + + // + // Indicates whether the Io requests to + // the file will be sequential or not. + // + ULONG AccessMode; + +} VOLUME_ALLOCATE_BC_STREAM_INPUT, *PVOLUME_ALLOCATE_BC_STREAM_INPUT; + +typedef struct _VOLUME_ALLOCATE_BC_STREAM_OUTPUT { + + // + // Specifies the required size + // of requests in this stream. + // + ULONGLONG RequestSize; + + // + // Specifies the number of requests that should be + // kept outstanding. This helps keep the device + // device busy and thus obtain maximum throughput. + // + ULONG NumOutStandingRequests; + +} VOLUME_ALLOCATE_BC_STREAM_OUTPUT, *PVOLUME_ALLOCATE_BC_STREAM_OUTPUT; + +// +// IOCTL_VOLUME_FREE_BC_STREAM +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + + +// +// IOCTL to differentiate between basic and +// dynamic volumes. +// + +#define IOCTL_VOLUME_IS_DYNAMIC CTL_CODE(IOCTL_VOLUME_BASE, 18, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_IS_DYNAMIC +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type BOOLEAN +// + + +// +// IOCTL to inform the storage stack of +// runs that contain a special file. +// + +#define IOCTL_VOLUME_PREPARE_FOR_CRITICAL_IO CTL_CODE(IOCTL_VOLUME_BASE, 19, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_VOLUME_PREPARE_FOR_CRITICAL_IO +// +// Input Buffer: +// Structure of type VOLUME_CRITICAL_IO +// +// Output Buffer: +// None +// + +typedef struct _FILE_EXTENT { + + ULONGLONG VolumeOffset; + ULONGLONG ExtentLength; + +} FILE_EXTENT, *PFILE_EXTENT; + +typedef struct _VOLUME_CRITICAL_IO { + + // + // Indicates whether requests shall be + // comprised of reads, writes or both. + // + ULONG AccessType; + + // + // Count of the number of extents that + // are contained within this structure. + // + ULONG ExtentsCount; + + // + // Specifies the extents along which + // the critical Io will be performed. + // + FILE_EXTENT Extents[ANYSIZE_ARRAY]; + +} VOLUME_CRITICAL_IO, *PVOLUME_CRITICAL_IO; + + +// +// IOCTL to provide hints to the file system +// as to where to place new file allocations. +// + +#define IOCTL_VOLUME_QUERY_ALLOCATION_HINT CTL_CODE(IOCTL_VOLUME_BASE, 20, METHOD_OUT_DIRECT, FILE_READ_ACCESS) + +// +// IOCTL_VOLUME_QUERY_ALLOCATION_HINT +// +// Input Buffer: +// Structure of type VOLUME_ALLOCATION_HINT_INPUT +// +// Output Buffer: +// Structure of type VOLUME_ALLOCATION_HINT_OUTPUT +// + +typedef struct _VOLUME_ALLOCATION_HINT_INPUT { + + // + // Specifies the granularity of + // the bitmap being requested. + // + ULONG ClusterSize; + + // + // Specifies the count of bits + // that are being requested. + // + ULONG NumberOfClusters; + + // + // Specifies the first cluster + // that is to be evaluated. + // + LONGLONG StartingClusterNumber; + +} VOLUME_ALLOCATION_HINT_INPUT, *PVOLUME_ALLOCATION_HINT_INPUT; + +typedef struct _VOLUME_ALLOCATION_HINT_OUTPUT { + + // + // Specifies the bits, 1 per cluster + // indicating all of the good places + // where file data may be allocated + // These bits are represented by a 0. + // + ULONG Bitmap[ANYSIZE_ARRAY]; + +} VOLUME_ALLOCATION_HINT_OUTPUT, *PVOLUME_ALLOCATION_HINT_OUTPUT; + + +// +// IOCTL to inform the storage stack to +// discard and re-query any information +// about the specified volume that might +// have been cached. +// + +#define IOCTL_VOLUME_UPDATE_PROPERTIES CTL_CODE(IOCTL_VOLUME_BASE, 21, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_UPDATE_PROPERTIES +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + + +// +// IOCTLs to coordinate a shrink operation +// with the drivers in the storage stack. +// + +#define IOCTL_VOLUME_QUERY_MINIMUM_SHRINK_SIZE CTL_CODE(IOCTL_VOLUME_BASE, 22, METHOD_BUFFERED, FILE_READ_ACCESS) +#define IOCTL_VOLUME_PREPARE_FOR_SHRINK CTL_CODE(IOCTL_VOLUME_BASE, 23, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_VOLUME_QUERY_MINIMUM_SHRINK_SIZE +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type VOLUME_SHRINK_INFO +// + +// +// IOCTL_VOLUME_PREPARE_FOR_SHRINK +// +// Input Buffer: +// Structure of type VOLUME_SHRINK_INFO +// +// Output Buffer: +// None +// + +typedef struct _VOLUME_SHRINK_INFO { + + // + // Specifies the size in bytes to + // which the volume can be or is + // going to be reduced down to. + // + ULONGLONG VolumeSize; + +} VOLUME_SHRINK_INFO, *PVOLUME_SHRINK_INFO; + +#endif // NTDDI_VERSION >= NTDDI_VISTA + + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +// +// IOCTL to differentiate between regular and +// csv volumes. +// + +#define IOCTL_VOLUME_IS_CSV CTL_CODE(IOCTL_VOLUME_BASE, 24, METHOD_BUFFERED, FILE_ANY_ACCESS) + +// +// IOCTL_VOLUME_IS_CSV +// +// Input Buffer: +// None +// +// Output Buffer: +// Structure of type BOOLEAN +// + +#define IOCTL_VOLUME_POST_ONLINE CTL_CODE(IOCTL_VOLUME_BASE, 25, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +// +// IOCTL_VOLUME_POST_ONLINE +// +// Input Buffer: +// None +// +// Output Buffer: +// None +// + +#define IOCTL_VOLUME_GET_CSVBLOCKCACHE_CALLBACK CTL_CODE(IOCTL_VOLUME_BASE, 26, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#ifdef _KERNEL_MODE + +typedef struct _CSV_FILECACHE_CONTEXT { + + union { + + struct { + // + // IO Status + // + IO_STATUS_BLOCK IoStatus; + + // + // Fields from IRP + // Flags + + ULONG IrpFlags; + + // + // Major/minor functions from IRP + // + UCHAR MajorFunction; + UCHAR MinorFunction; + + // + // The flags associated with operations. + // The IO_STACK_LOCATION.Flags field in the old model (SL_* flags) + // + UCHAR OperationFlags; + + // + // IO Parameters + // + ULONG Length; // Length of IO transfer + ULONG Key; + LARGE_INTEGER ByteOffset; // Offset to read/write from + PVOID MdlAddress; // Mdl address for the buffer + } ReadWrite; + + struct { + ULONGLONG Length; // Length of data to purge + LARGE_INTEGER ByteOffset; // Offset to purge from + } Purge; + + } Parameters; + + GUID StreamId; // Id unique per file-stream + + PVOID CsvIoContext; // Internal context used by Csv. + + PVOID DriverContext; // Drivers can save their context here. +} CSV_FILECACHE_CONTEXT, *PCSV_FILECACHE_CONTEXT; + + +// cache callbacks + +typedef +_Function_class_(CSV_BLOCKCACHE_PURGE_CACHE) +_IRQL_requires_max_(PASSIVE_LEVEL) +void (*CSV_BLOCKCACHE_PURGE_CACHE) (_Inout_ PVOID CallbackContext, + _In_ ULONGLONG Offset, + _In_ ULONGLONG Length); + +typedef +_Function_class_(CSV_BLOCKCACHE_DISABLE_CACHE) +_IRQL_requires_max_(PASSIVE_LEVEL) +void (*CSV_BLOCKCACHE_DISABLE_CACHE) (_Inout_ PVOID CallbackContext); + +typedef +_Function_class_(CSV_BLOCKCACHE_ENABLE_CACHE) +_IRQL_requires_max_(PASSIVE_LEVEL) +LONG (*CSV_BLOCKCACHE_ENABLE_CACHE) (_Inout_ PVOID CallbackContext); + + +// V2 Callbacks + +typedef +_Function_class_(CSV_FILECACHE_PURGE_RDCACHE) +_IRQL_requires_max_(PASSIVE_LEVEL) +void (*CSV_FILECACHE_PURGE_RDCACHE) (_Inout_ PVOID CallbackContext, + _In_ PCSV_FILECACHE_CONTEXT CSVContext); + +typedef +_Function_class_(CSV_FILECACHE_HANDLE_CACHE_IO) +_IRQL_requires_max_(PASSIVE_LEVEL) +LONG (*CSV_FILECACHE_HANDLE_CACHE_IO) (_Inout_ PVOID CallbackContext, + _Inout_ PCSV_FILECACHE_CONTEXT CSVContext); + +typedef +_Function_class_(CSV_FILECACHE_COMPLETE_CACHE_MISS) +_IRQL_requires_max_(DISPATCH_LEVEL) +void (*CSV_FILECACHE_COMPLETE_CACHE_MISS) (_Inout_ PVOID CallbackContext, + _Inout_ PCSV_FILECACHE_CONTEXT CSVContext); + +// Callback Provided by Csvfs + +typedef +_Function_class_(CSV_FILECACHE_HANDLE_CACHE_MISS) +_IRQL_requires_max_(PASSIVE_LEVEL) +LONG (*CSV_FILECACHE_HANDLE_CACHE_MISS) (_Inout_ PCSV_FILECACHE_CONTEXT CSVContext); + +typedef +_Function_class_(CSV_FILECACHE_COMPLETE_CACHE_IO) +_IRQL_requires_max_(DISPATCH_LEVEL) +void (*CSV_FILECACHE_COMPLETE_CACHE_IO) (_Inout_ PCSV_FILECACHE_CONTEXT CSVContext); + +// +// IOCTL_VOLUME_GET_CSVBLOCKCACHE_CALLBACK +// +// Input Buffer: +// Structure of type CSV_FILECACHE_CALLBACKS +// +// Output Buffer: +#define CSV_BLOCK_CACHE_CALLBACK_VERSION 01 +#define CSV_BLOCK_AND_FILE_CACHE_CALLBACK_VERSION 02 + +typedef struct _CSV_BLOCKCACHE_CALLBACK { + ULONG Version; + CSV_BLOCKCACHE_PURGE_CACHE PurgeCache; + CSV_BLOCKCACHE_ENABLE_CACHE CacheEnable; + CSV_BLOCKCACHE_DISABLE_CACHE CacheDisable; + PVOID CallbackContext; +} CSV_BLOCKCACHE_CALLBACK, *PCSV_BLOCKCACHE_CALLBACK; + +#pragma warning( push ) +#pragma warning( disable : 4201 ) // error C4201: nonstandard extension used : nameless struct/union + +#ifdef __cplusplus +typedef struct _CSV_CACHE_CALLBACK_V2_OUTPUT : public CSV_BLOCKCACHE_CALLBACK { +#else +typedef struct _CSV_CACHE_CALLBACK_V2_OUTPUT +{ + CSV_BLOCKCACHE_CALLBACK; +#endif + CSV_FILECACHE_HANDLE_CACHE_IO HandleCacheIo; + CSV_FILECACHE_COMPLETE_CACHE_MISS CompleteCacheMiss; + CSV_FILECACHE_PURGE_RDCACHE PurgeFileCache; +} CSV_CACHE_CALLBACK_V2_OUTPUT, *PCSV_CACHE_CALLBACK_V2_OUTPUT, +CSV_CACHE_CALLBACK, *PCSV_CACHE_CALLBACK; + +#pragma warning( pop ) + +typedef struct _CSV_CACHE_CALLBACK_V2_INPUT { + CSV_FILECACHE_HANDLE_CACHE_MISS HandleCacheMiss; + CSV_FILECACHE_COMPLETE_CACHE_IO CompleteCacheIo; +} CSV_CACHE_CALLBACK_V2_INPUT, *PCSV_CACHE_CALLBACK_V2_INPUT, +CSV_CACHE_CALLBACK_INPUT, *PCSV_CACHE_CALLBACK_INPUT; + +// Define V3 Contexts here for now. +typedef enum _CSV_FILECACHE_IO_TYPE +{ + CSV_FILECACHE_IO_TYPE_READWRITE = 0, + CSV_FILECACHE_IO_TYPE_PURGE = 1, +} CSV_FILECACHE_IO_TYPE; + +typedef struct _CSV_FILECACHE_IO_CONTEXT +{ + CSV_FILECACHE_IO_TYPE Type; + + union + { + struct + { + IRP *m_pIrp; + IO_STACK_LOCATION *m_pStackLocation; + } ReadWrite; + + struct + { + LARGE_INTEGER StartOffset; + LARGE_INTEGER EndOffset; + BOOLEAN fHard; + } Purge; + + } Parameters; + + VOID *m_pFileContext; + + ULONGLONG m_ExtraContext[1]; +} CSV_FILECACHE_IO_CONTEXT, *PCSV_FILECACHE_IO_CONTEXT; + + +typedef struct _CSV_FILECACHE_IO_RANGE +{ + ULONGLONG Offset; + ULONG Length; +} CSV_FILECACHE_IO_RANGE; + +// Callback Provided by Csvfs + +typedef +_Function_class_(CSV_FILECACHE_HANDLE_CACHE_MISS_V2) +_IRQL_requires_max_(PASSIVE_LEVEL) +void(*CSV_FILECACHE_HANDLE_CACHE_MISS_V2) (_Inout_ PCSV_FILECACHE_IO_CONTEXT pContext, ULONG cRanges, CSV_FILECACHE_IO_RANGE const * pNotRequiredRanges); + +typedef +_Function_class_(CSV_FILECACHE_COMPLETE_CACHE_IO_V2) +_IRQL_requires_max_(DISPATCH_LEVEL) +void(*CSV_FILECACHE_COMPLETE_CACHE_IO_V2) (_Inout_ PCSV_FILECACHE_IO_CONTEXT pContext); + +typedef struct _CSV_CACHE_CALLBACK_V3_INPUT { + CSV_FILECACHE_HANDLE_CACHE_MISS_V2 HandleCacheMiss; + CSV_FILECACHE_COMPLETE_CACHE_IO_V2 CompleteCacheIo; +} CSV_CACHE_CALLBACK_V3_INPUT, *PCSV_CACHE_CALLBACK_V3_INPUT; +//CSV_CACHE_CALLBACK_INPUT, *PCSV_CACHE_CALLBACK_INPUT; + +typedef struct _CSV_FILECACHE_FILE_CONTEXT_EXTENSION + CSV_FILECACHE_FILE_CONTEXT_EXTENSION, *PCSV_FILECACHE_FILE_CONTEXT_EXTENSION; + +typedef GUID FILE_SIG_T; +typedef GUID VOLUME_SIG_T; + +typedef NTSTATUS(*CSV_FILECACHE_FILE_CREATE) (PVOID pRegContext, VOLUME_SIG_T const * volSig, FILE_SIG_T const * fileSig, PVOID * ppContext); +typedef void(*CSV_FILECACHE_FILE_CLOSE) (PVOID pRegContext, PVOID pContext); +typedef void(*CSV_FILECACHE_HANDLE_CACHE_IO_V2) (PVOID pRegContext, PCSV_FILECACHE_IO_CONTEXT pContext); +typedef void(*CSV_FILECACHE_COMPLETE_CACHE_MISS_V2) (PVOID pRegContext, PCSV_FILECACHE_IO_CONTEXT pContext); + +typedef PCSV_FILECACHE_FILE_CONTEXT_EXTENSION (*CSV_FILECACHE_FILE_SET_EXTENSION) (PVOID pRegContext, PCSV_FILECACHE_IO_CONTEXT pContext, PCSV_FILECACHE_FILE_CONTEXT_EXTENSION pExtension); +typedef PCSV_FILECACHE_FILE_CONTEXT_EXTENSION (*CSV_FILECACHE_FILE_GET_EXTENSION) (PVOID pRegContext, PCSV_FILECACHE_IO_CONTEXT pContext); + +typedef +_Function_class_(CSV_FILECACHE_CLEANUP_CACHE) +_IRQL_requires_max_(PASSIVE_LEVEL) +void (*CSV_FILECACHE_CLEANUP_CACHE) (_Inout_ PVOID pRegContext); + +#pragma warning( push ) +#pragma warning( disable : 4201 ) // error C4201: nonstandard extension used : nameless struct/union + +#ifdef __cplusplus +typedef struct _CSV_CACHE_CALLBACK_V3_OUTPUT : public CSV_BLOCKCACHE_CALLBACK { +#else +typedef struct _CSV_CACHE_CALLBACK_V3_OUTPUT +{ + CSV_BLOCKCACHE_CALLBACK; +#endif + PVOID FileCacheCallbackContext; + ULONG IoContextBytesRequired; + CSV_FILECACHE_CLEANUP_CACHE CacheCleanup; + CSV_FILECACHE_FILE_CREATE FileCreate; + CSV_FILECACHE_FILE_CLOSE FileClose; + CSV_FILECACHE_HANDLE_CACHE_IO_V2 HandleCacheIo; + CSV_FILECACHE_COMPLETE_CACHE_MISS_V2 CompleteCacheMiss; + CSV_FILECACHE_FILE_SET_EXTENSION FileSetExtension; + CSV_FILECACHE_FILE_GET_EXTENSION FileGetExtension; +} CSV_CACHE_CALLBACK_V3_OUTPUT, *PCSV_CACHE_CALLBACK_V3_OUTPUT; +//CSV_CACHE_CALLBACK, *PCSV_CACHE_CALLBACK; + +#pragma warning( pop ) +#endif // KERNEL_MODE + +#endif // NTDDI_VERSION >= NTDDI_WIN8 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif // _NTDDVOL_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdef.h new file mode 100644 index 0000000000000000000000000000000000000000..6c179890d1e70cbba59fe4c5e3e96ced494ef5e4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdef.h @@ -0,0 +1,3456 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntdef.h + +Abstract: + + Type definitions for the basic types. + + +--*/ + +#ifndef _NTDEF_ +#define _NTDEF_ + +#if _MSC_VER > 1000 +#pragma once +#endif + + +#include // winnt ntndis +#include // winnt + +// begin_winnt begin_ntoshvp begin_ntddk + +// +// Anywhere that NOINITALL is defined, warning 4845 should be disabled. This warning +// fires whenever __declspec(no_init_all) is found but /d1initall isn't set. This isn't +// helpful since this will be done intentionally (not all components opt-in). +// + +#ifndef DECLSPEC_NOINITALL +#if (_MSC_VER >= 1915) && !defined(MIDL_PASS) && !defined(SORTPP_PASS) && !defined(RC_INVOKED) +#define DECLSPEC_NOINITALL __pragma(warning(push)) __pragma(warning(disable:4845)) __declspec(no_init_all) __pragma(warning(pop)) +#else +#define DECLSPEC_NOINITALL +#endif +#endif + +// end_winnt end_ntoshvp end_ntddk + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#pragma warning(disable:4820) // padding added after data member +#endif + +// begin_ntminiport begin_ntndis begin_ntminitape +// begin_ntoshvp + +#ifndef IN +#define IN +#endif + +#ifndef OUT +#define OUT +#endif + +#ifndef OPTIONAL +#define OPTIONAL +#endif + +#ifndef NOTHING +#define NOTHING +#endif + +#ifndef CRITICAL +#define CRITICAL +#endif + +#ifndef ANYSIZE_ARRAY +#define ANYSIZE_ARRAY 1 // winnt +#endif + +// begin_winnt + +// +// For compilers that don't support nameless unions/structs +// +#ifndef DUMMYUNIONNAME +#if defined(NONAMELESSUNION) || !defined(_MSC_EXTENSIONS) +#define DUMMYUNIONNAME u +#define DUMMYUNIONNAME2 u2 +#define DUMMYUNIONNAME3 u3 +#define DUMMYUNIONNAME4 u4 +#define DUMMYUNIONNAME5 u5 +#define DUMMYUNIONNAME6 u6 +#define DUMMYUNIONNAME7 u7 +#define DUMMYUNIONNAME8 u8 +#define DUMMYUNIONNAME9 u9 +#else +#define DUMMYUNIONNAME +#define DUMMYUNIONNAME2 +#define DUMMYUNIONNAME3 +#define DUMMYUNIONNAME4 +#define DUMMYUNIONNAME5 +#define DUMMYUNIONNAME6 +#define DUMMYUNIONNAME7 +#define DUMMYUNIONNAME8 +#define DUMMYUNIONNAME9 +#endif +#endif // DUMMYUNIONNAME + +#ifndef DUMMYSTRUCTNAME +#if defined(NONAMELESSUNION) || !defined(_MSC_EXTENSIONS) +#define DUMMYSTRUCTNAME s +#define DUMMYSTRUCTNAME2 s2 +#define DUMMYSTRUCTNAME3 s3 +#define DUMMYSTRUCTNAME4 s4 +#define DUMMYSTRUCTNAME5 s5 +#define DUMMYSTRUCTNAME6 s6 +#else +#define DUMMYSTRUCTNAME +#define DUMMYSTRUCTNAME2 +#define DUMMYSTRUCTNAME3 +#define DUMMYSTRUCTNAME4 +#define DUMMYSTRUCTNAME5 +#define DUMMYSTRUCTNAME6 +#endif +#endif // DUMMYSTRUCTNAME + +// end_ntoshvp + +#include +#include + +#if defined(STRICT_GS_ENABLED) +#pragma strict_gs_check(push, on) +#endif + +// begin_ntoshvp + +#if defined(_M_MRX000) && !(defined(MIDL_PASS) || defined(RC_INVOKED)) && defined(ENABLE_RESTRICTED) +#define RESTRICTED_POINTER __restrict +#else +#define RESTRICTED_POINTER +#endif + +#if defined(_M_MRX000) || defined(_M_ALPHA) || defined(_M_PPC) || defined(_M_IA64) || defined(_M_AMD64) || defined(_M_ARM) || defined(_M_ARM64) +#define ALIGNMENT_MACHINE +#define UNALIGNED __unaligned +#if defined(_WIN64) +#define UNALIGNED64 __unaligned +#else +#define UNALIGNED64 +#endif +#else +#undef ALIGNMENT_MACHINE +#define UNALIGNED +#define UNALIGNED64 +#endif + +// end_ntoshvp + + +#if defined(_WIN64) || defined(_M_ALPHA) +#define MAX_NATURAL_ALIGNMENT sizeof(ULONGLONG) +#define MEMORY_ALLOCATION_ALIGNMENT 16 +#else +#define MAX_NATURAL_ALIGNMENT sizeof(ULONG) +#define MEMORY_ALLOCATION_ALIGNMENT 8 +#endif + +// +// TYPE_ALIGNMENT will return the alignment requirements of a given type for +// the current platform. +// + +#ifdef __cplusplus +#if _MSC_VER >= 1300 +#define TYPE_ALIGNMENT( t ) __alignof(t) +#endif +#else +#define TYPE_ALIGNMENT( t ) \ + FIELD_OFFSET( struct { char x; t test; }, test ) +#endif + +// +// Note: RC_INVOKED is checked in PROBE_ALIGNMENT to maintain compatibility with previous +// versions of the SDK which did not block inclusion in an .RC file. +// + +#if defined(_AMD64_) || defined(_X86_) || defined(_ARM64EC_) +#define PROBE_ALIGNMENT( _s ) TYPE_ALIGNMENT( ULONG ) +#elif defined(_IA64_) || defined(_ARM_) || defined(_ARM64_) + +// +// TODO: WOWXX - Unblock ARM. Make all alignment checks ULONG for now. +// + +#define PROBE_ALIGNMENT( _s ) TYPE_ALIGNMENT( ULONG ) +#elif !defined(RC_INVOKED) +#error "No Target Architecture" +#endif + +// +// Define PROBE_ALIGNMENT32 to be the same as PROBE_ALIGNMENT on x86, so that +// code hosting x86 under WoW can handle x86's maximum guaranteed alignment. +// + +#define PROBE_ALIGNMENT32( _s ) TYPE_ALIGNMENT( ULONG ) + +// begin_ntoshvp + +// +// C_ASSERT() can be used to perform many compile-time assertions: +// type sizes, field offsets, etc. +// +// An assertion failure results in error C2118: negative subscript. +// + +#ifndef SORTPP_PASS +#define C_ASSERT(e) typedef char __C_ASSERT__[(e)?1:-1] +#else +#define C_ASSERT(e) /* nothing */ +#endif + +#include + +// end_winnt + +#ifndef CONST +#define CONST const +#endif + +// begin_winnt + +#ifndef DECLSPEC_IMPORT +#if (defined(_M_IX86) || defined(_M_IA64) || defined(_M_AMD64) || defined(_M_ARM) || defined(_M_ARM64)) && !defined(MIDL_PASS) +#define DECLSPEC_IMPORT __declspec(dllimport) +#else +#define DECLSPEC_IMPORT +#endif +#endif + +#ifndef DECLSPEC_NORETURN +#if (_MSC_VER >= 1200) && !defined(MIDL_PASS) +#define DECLSPEC_NORETURN __declspec(noreturn) +#else +#define DECLSPEC_NORETURN +#endif +#endif + +#ifndef DECLSPEC_NOTHROW +#if (_MSC_VER >= 1200) && !defined(MIDL_PASS) +#define DECLSPEC_NOTHROW __declspec(nothrow) +#else +#define DECLSPEC_NOTHROW +#endif +#endif + +#ifndef DECLSPEC_RESTRICT +#if (_MSC_VER >= 1915) && !defined(MIDL_PASS) +#define DECLSPEC_RESTRICT __declspec(restrict) +#else +#define DECLSPEC_RESTRICT +#endif +#endif + +#ifndef DECLSPEC_ALIGN +#if (_MSC_VER >= 1300) && !defined(MIDL_PASS) +#define DECLSPEC_ALIGN(x) __declspec(align(x)) +#else +#define DECLSPEC_ALIGN(x) +#endif +#endif + +// end_ntoshvp + +#ifndef X86_CACHE_ALIGNMENT_SIZE +#define X86_CACHE_ALIGNMENT_SIZE 64 +#endif + +#ifndef ARM_CACHE_ALIGNMENT_SIZE +#define ARM_CACHE_ALIGNMENT_SIZE 128 +#endif + +#ifndef SYSTEM_CACHE_ALIGNMENT_SIZE +#if defined(_AMD64_) || defined(_X86_) +#define SYSTEM_CACHE_ALIGNMENT_SIZE X86_CACHE_ALIGNMENT_SIZE +#elif defined(_ARM64_) || defined(_ARM_) +#define SYSTEM_CACHE_ALIGNMENT_SIZE ARM_CACHE_ALIGNMENT_SIZE +#elif !defined(RC_INVOKED) +#error Must define a target architecture. +#endif +#endif // SYSTEM_CACHE_ALIGNMENT_SIZE + +#ifndef DECLSPEC_CACHEALIGN +#define DECLSPEC_CACHEALIGN DECLSPEC_ALIGN(SYSTEM_CACHE_ALIGNMENT_SIZE) +#endif + +#ifndef DECLSPEC_UUID +#if (_MSC_VER >= 1100) && defined (__cplusplus) +#define DECLSPEC_UUID(x) __declspec(uuid(x)) +#else +#define DECLSPEC_UUID(x) +#endif +#endif + +#ifndef DECLSPEC_NOVTABLE +#if (_MSC_VER >= 1100) && defined(__cplusplus) +#define DECLSPEC_NOVTABLE __declspec(novtable) +#else +#define DECLSPEC_NOVTABLE +#endif +#endif + +#ifndef DECLSPEC_SELECTANY +#if (_MSC_VER >= 1100) +#define DECLSPEC_SELECTANY __declspec(selectany) +#else +#define DECLSPEC_SELECTANY +#endif +#endif + +#ifndef NOP_FUNCTION +#if (_MSC_VER >= 1210) +#define NOP_FUNCTION __noop +#else +#define NOP_FUNCTION (void)0 +#endif +#endif + +#ifndef DECLSPEC_ADDRSAFE +#if (_MSC_VER >= 1200) && (defined(_M_ALPHA) || defined(_M_AXP64)) +#define DECLSPEC_ADDRSAFE __declspec(address_safe) +#else +#define DECLSPEC_ADDRSAFE +#endif +#endif + +#ifndef DECLSPEC_SAFEBUFFERS +#if (_MSC_VER >= 1600) +#define DECLSPEC_SAFEBUFFERS __declspec(safebuffers) +#else +#define DECLSPEC_SAFEBUFFERS +#endif +#endif + +#ifndef DECLSPEC_NOINLINE +#if (_MSC_VER >= 1300) +#define DECLSPEC_NOINLINE __declspec(noinline) +#else +#define DECLSPEC_NOINLINE +#endif +#endif + +#ifndef DECLSPEC_SAFEBUFFERS +#if (_MSC_VER >= 1300) +#define DECLSPEC_SAFEBUFFERS __declspec(safebuffers) +#else +#define DECLSPEC_SAFEBUFFERS +#endif +#endif + +// end_winnt end_ntminiport end_ntndis end_ntminitape + +#ifndef DECLSPEC_GUARDIGNORE +#if (_MSC_FULL_VER >= 170065501) || defined(_D1VERSIONLKG171_) +#define DECLSPEC_GUARDIGNORE __declspec(guard(ignore)) +#else +#define DECLSPEC_GUARDIGNORE +#endif +#endif + +// begin_winnt begin_ntminiport begin_ntndis begin_ntminitape + +// begin_ntoshvp + +// +// When DECLSPEC_NOSANITIZEADDRESS is set, the compiler may not inline +// functions marked with __forceinline. This may result in warning 4714: +// +// function 'xxx' marked as __forceinline not inlined +// +// Provide a way to disable this warning. +// + +#ifndef DECLSPEC_NOSANITIZEADDRESS +#if defined(__SANITIZE_ADDRESS__) +#define DECLSPEC_NOSANITIZEADDRESS __declspec(no_sanitize_address) +#define ASAN_WARNING_DISABLE_4714_PUSH __pragma(warning(push)) __pragma(warning(disable:4714)) +#define ASAN_WARNING_DISABLE_4714_POP __pragma(warning(pop)) +#else +#define DECLSPEC_NOSANITIZEADDRESS +#define ASAN_WARNING_DISABLE_4714_PUSH +#define ASAN_WARNING_DISABLE_4714_POP +#endif +#endif + +#ifndef DECLSPEC_GUARDNOCF +#if (_MSC_FULL_VER >= 170065501) || defined(_D1VERSIONLKG171_) +#define DECLSPEC_GUARDNOCF __declspec(guard(nocf)) +#else +#define DECLSPEC_GUARDNOCF +#endif +#endif + +#ifndef DECLSPEC_GUARD_SUPPRESS +#if (_MSC_FULL_VER >= 181040116) || defined(_D1VERSIONLKG171_) +#define DECLSPEC_GUARD_SUPPRESS __declspec(guard(suppress)) +#else +#define DECLSPEC_GUARD_SUPPRESS +#endif +#endif + +#ifndef DECLSPEC_CHPE_GUEST +#if _M_HYBRID +#define DECLSPEC_CHPE_GUEST __declspec(hybrid_guest) +#else +#define DECLSPEC_CHPE_GUEST +#endif +#endif + +#ifndef DECLSPEC_CHPE_PATCHABLE +#if !defined(SORTPP_PASS) +#if defined (_M_HYBRID_X86_ARM64) || defined(_M_ARM64EC) +#define DECLSPEC_CHPE_PATCHABLE __declspec(hybrid_patchable) +#else +#define DECLSPEC_CHPE_PATCHABLE DECLSPEC_NOINLINE +#endif +#else +#define DECLSPEC_CHPE_PATCHABLE +#endif +#endif + +#ifndef FORCEINLINE +#if (_MSC_VER >= 1200) +#define FORCEINLINE __forceinline +#else +#define FORCEINLINE __inline +#endif +#endif + +// +// CFORCEINLINE: __forceinline required for correctness. Such definitions are +// typically required to be visible in the same translation unit +// (i.e., so that they may still be forceinlined, even in the +// event of non-LTCG code being encountered). +// + +#define CFORCEINLINE FORCEINLINE + +// +// STKFORCEINLINE: __forceinline required for correctness due to counting stack +// frames for a stack trace being captured. +// + +#define STKFORCEINLINE FORCEINLINE + +// +// PFORCEINLINE: __forceinline required for performance. +// + +#ifndef PFORCEINLINE +#define PFORCEINLINE FORCEINLINE +#endif + +// end_ntoshvp + +#ifndef DECLSPEC_DEPRECATED +#if (_MSC_VER >= 1300) && !defined(MIDL_PASS) +#define DECLSPEC_DEPRECATED __declspec(deprecated) +#define DEPRECATE_SUPPORTED +#else +#define DECLSPEC_DEPRECATED +#undef DEPRECATE_SUPPORTED +#endif +#endif + +#ifdef DEPRECATE_DDK_FUNCTIONS +#ifdef _NTDDK_ +#define DECLSPEC_DEPRECATED_DDK DECLSPEC_DEPRECATED +#ifdef DEPRECATE_SUPPORTED +#define PRAGMA_DEPRECATED_DDK 1 +#endif +#else +#define DECLSPEC_DEPRECATED_DDK +#define PRAGMA_DEPRECATED_DDK 1 +#endif +#else +#define DECLSPEC_DEPRECATED_DDK +#define PRAGMA_DEPRECATED_DDK 0 +#endif + +// begin_ntoshvp + +// +// Void +// + +typedef void *PVOID; +typedef void * POINTER_64 PVOID64; + +// end_winnt +// begin_wudfwdm + +#ifndef _MANAGED +#if defined(_M_IX86) +#define FASTCALL __fastcall +#else +#define FASTCALL +#endif +#else +#define FASTCALL NTAPI +#endif + +// end_wudfwdm +// begin_winnt + +#if (_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED) +#define NTAPI __stdcall +#else +#define _cdecl +#define __cdecl +#define NTAPI +#endif + +// end_ntminiport end_ntminitape + +#if !defined(_M_CEE_PURE) +#define NTAPI_INLINE NTAPI +#else +#define NTAPI_INLINE +#endif + +// begin_ntminiport begin_ntminitape + +// +// Define API decoration for direct importing system DLL references. +// + +#if !defined(_NTSYSTEM_) && !defined(_NTHALLIB_) +#define NTSYSAPI DECLSPEC_IMPORT +#define NTSYSCALLAPI DECLSPEC_IMPORT +#else +#define NTSYSAPI +#if defined(_NTDLLBUILD_) +#define NTSYSCALLAPI +#else +#define NTSYSCALLAPI DECLSPEC_ADDRSAFE +#endif +#endif + +// +// Basics +// + +#ifndef VOID +#define VOID void +typedef char CHAR; +typedef short SHORT; +typedef long LONG; +#if !defined(MIDL_PASS) +typedef int INT; +#endif +#endif + +// +// UNICODE (Wide Character) types +// + +#ifndef _MAC +typedef wchar_t WCHAR; // wc, 16-bit UNICODE character +#else +// some Macintosh compilers don't define wchar_t in a convenient location, or define it as a char +typedef unsigned short WCHAR; // wc, 16-bit UNICODE character +#endif + +typedef WCHAR *PWCHAR, *LPWCH, *PWCH; +typedef CONST WCHAR *LPCWCH, *PCWCH; + +typedef _Null_terminated_ WCHAR *NWPSTR, *LPWSTR, *PWSTR; +typedef _Null_terminated_ PWSTR *PZPWSTR; +typedef _Null_terminated_ CONST PWSTR *PCZPWSTR; +typedef _Null_terminated_ WCHAR UNALIGNED *LPUWSTR, *PUWSTR; +typedef _Null_terminated_ CONST WCHAR *LPCWSTR, *PCWSTR; +typedef _Null_terminated_ PCWSTR *PZPCWSTR; +typedef _Null_terminated_ CONST PCWSTR *PCZPCWSTR; +typedef _Null_terminated_ CONST WCHAR UNALIGNED *LPCUWSTR, *PCUWSTR; + +typedef _NullNull_terminated_ WCHAR *PZZWSTR; +typedef _NullNull_terminated_ CONST WCHAR *PCZZWSTR; +typedef _NullNull_terminated_ WCHAR UNALIGNED *PUZZWSTR; +typedef _NullNull_terminated_ CONST WCHAR UNALIGNED *PCUZZWSTR; + +typedef WCHAR *PNZWCH; +typedef CONST WCHAR *PCNZWCH; +typedef WCHAR UNALIGNED *PUNZWCH; +typedef CONST WCHAR UNALIGNED *PCUNZWCH; + +#if _WIN32_WINNT >= 0x0600 || (defined(__cplusplus) && defined(WINDOWS_ENABLE_CPLUSPLUS)) + +typedef CONST WCHAR *LPCWCHAR, *PCWCHAR; +typedef CONST WCHAR UNALIGNED *LPCUWCHAR, *PCUWCHAR; + +// +// UCS (Universal Character Set) types +// + +typedef unsigned long UCSCHAR; + +// +// Even pre-Unicode agreement, UCS values are always in the +// range U+00000000 to U+7FFFFFFF, so we'll pick an obvious +// value. + +#define UCSCHAR_INVALID_CHARACTER (0xffffffff) + +#define MIN_UCSCHAR (0) + +// +// We'll assume here that the ISO-10646 / Unicode agreement +// not to assign code points after U+0010FFFF holds so that +// we do not have to have separate "UCSCHAR" and "UNICODECHAR" +// types. +// + +#define MAX_UCSCHAR (0x0010FFFF) + +typedef UCSCHAR *PUCSCHAR; +typedef const UCSCHAR *PCUCSCHAR; + +typedef UCSCHAR *PUCSSTR; +typedef UCSCHAR UNALIGNED *PUUCSSTR; + +typedef const UCSCHAR *PCUCSSTR; +typedef const UCSCHAR UNALIGNED *PCUUCSSTR; + +typedef UCSCHAR UNALIGNED *PUUCSCHAR; +typedef const UCSCHAR UNALIGNED *PCUUCSCHAR; + +#endif // _WIN32_WINNT >= 0x0600 + + +// +// ANSI (Multi-byte Character) types +// +typedef CHAR *PCHAR, *LPCH, *PCH; +typedef CONST CHAR *LPCCH, *PCCH; + +typedef _Null_terminated_ CHAR *NPSTR, *LPSTR, *PSTR; +typedef _Null_terminated_ PSTR *PZPSTR; +typedef _Null_terminated_ CONST PSTR *PCZPSTR; +typedef _Null_terminated_ CONST CHAR *LPCSTR, *PCSTR; +typedef _Null_terminated_ PCSTR *PZPCSTR; +typedef _Null_terminated_ CONST PCSTR *PCZPCSTR; + +typedef _NullNull_terminated_ CHAR *PZZSTR; +typedef _NullNull_terminated_ CONST CHAR *PCZZSTR; + +typedef CHAR *PNZCH; +typedef CONST CHAR *PCNZCH; + +// +// Neutral ANSI/UNICODE types and macros +// +#ifdef UNICODE // r_winnt + +#ifndef _TCHAR_DEFINED +typedef WCHAR TCHAR, *PTCHAR; +typedef WCHAR TUCHAR, *PTUCHAR; +#define _TCHAR_DEFINED +#endif /* !_TCHAR_DEFINED */ + +typedef LPWCH LPTCH, PTCH; +typedef LPCWCH LPCTCH, PCTCH; +typedef LPWSTR PTSTR, LPTSTR; +typedef LPCWSTR PCTSTR, LPCTSTR; +typedef LPUWSTR PUTSTR, LPUTSTR; +typedef LPCUWSTR PCUTSTR, LPCUTSTR; +typedef LPWSTR LP; +typedef PZZWSTR PZZTSTR; +typedef PCZZWSTR PCZZTSTR; +typedef PUZZWSTR PUZZTSTR; +typedef PCUZZWSTR PCUZZTSTR; +typedef PZPWSTR PZPTSTR; +typedef PNZWCH PNZTCH; +typedef PCNZWCH PCNZTCH; +typedef PUNZWCH PUNZTCH; +typedef PCUNZWCH PCUNZTCH; +#define __TEXT(quote) L##quote // r_winnt + +#else /* UNICODE */ // r_winnt + +#ifndef _TCHAR_DEFINED +typedef char TCHAR, *PTCHAR; +typedef unsigned char TUCHAR, *PTUCHAR; +#define _TCHAR_DEFINED +#endif /* !_TCHAR_DEFINED */ + +typedef LPCH LPTCH, PTCH; +typedef LPCCH LPCTCH, PCTCH; +typedef LPSTR PTSTR, LPTSTR, PUTSTR, LPUTSTR; +typedef LPCSTR PCTSTR, LPCTSTR, PCUTSTR, LPCUTSTR; +typedef PZZSTR PZZTSTR, PUZZTSTR; +typedef PCZZSTR PCZZTSTR, PCUZZTSTR; +typedef PZPSTR PZPTSTR; +typedef PNZCH PNZTCH, PUNZTCH; +typedef PCNZCH PCNZTCH, PCUNZTCH; +#define __TEXT(quote) quote // r_winnt + +#endif /* UNICODE */ // r_winnt +#define TEXT(quote) __TEXT(quote) // r_winnt + + +// end_winnt + +// +// The type QUAD and UQUAD are intended to use when a 8 byte aligned structure +// is required, but it is not a floating point number. +// + +typedef double DOUBLE; + +typedef struct _QUAD { + union { + __int64 UseThisFieldToCopy; + double DoNotUseThisField; + } DUMMYUNIONNAME; + +} QUAD; + +// +// Pointer to Basics +// + +typedef SHORT *PSHORT; // winnt +typedef LONG *PLONG; // winnt +typedef QUAD *PQUAD; + +// +// Unsigned Basics +// + +// Tell windef.h that some types are already defined. +#define BASETYPES + +typedef unsigned char UCHAR; +typedef unsigned short USHORT; +typedef unsigned long ULONG; +typedef QUAD UQUAD; + +// +// Pointer to Unsigned Basics +// + +typedef UCHAR *PUCHAR; +typedef USHORT *PUSHORT; +typedef ULONG *PULONG; +typedef UQUAD *PUQUAD; + +// end_ntoshvp + +#if _WIN32_WINNT >= 0x0600 || (defined(__cplusplus) && defined(WINDOWS_ENABLE_CPLUSPLUS)) + +// +// Pointer to Const Unsigned Basics +// + +typedef CONST UCHAR *PCUCHAR; +typedef CONST USHORT *PCUSHORT; +typedef CONST ULONG *PCULONG; +typedef CONST UQUAD *PCUQUAD; + +#endif // _WIN32_WINNT >= 0x0600 + +// +// Signed characters +// + +typedef signed char SCHAR; +typedef SCHAR *PSCHAR; + +#if _WIN32_WINNT >= 0x0600 || (defined(__cplusplus) && defined(WINDOWS_ENABLE_CPLUSPLUS)) + +typedef CONST SCHAR *PCSCHAR; + +#endif // _WIN32_WINNT >= 0x0600 + +#ifndef NO_STRICT +#ifndef STRICT +#define STRICT 1 +#endif +#endif + +// begin_winnt + +#define ALL_PROCESSOR_GROUPS 0xffff + +// +// Structure to represent a system wide processor number. It contains a +// group number and relative processor number within the group. +// + +typedef struct _PROCESSOR_NUMBER { + USHORT Group; + UCHAR Number; + UCHAR Reserved; +} PROCESSOR_NUMBER, *PPROCESSOR_NUMBER; + +// begin_ntoshvp + +// +// Structure to represent a group-specific affinity, such as that of a +// thread. Specifies the group number and the affinity within that group. +// + +typedef struct _GROUP_AFFINITY { + KAFFINITY Mask; + USHORT Group; + USHORT Reserved[3]; +} GROUP_AFFINITY, *PGROUP_AFFINITY; + +typedef struct _GROUP_AFFINITY32 { + ULONG Mask; + USHORT Group; + USHORT Reserved[3]; +} GROUP_AFFINITY32, *PGROUP_AFFINITY32; + +typedef struct _GROUP_AFFINITY64 { + unsigned __int64 Mask; + USHORT Group; + USHORT Reserved[3]; +} GROUP_AFFINITY64, *PGROUP_AFFINITY64; + +// end_ntoshvp + +#if defined(_WIN64) + +#define MAXIMUM_PROC_PER_GROUP 64 + +#else + +#define MAXIMUM_PROC_PER_GROUP 32 + +#endif + +#define MAXIMUM_PROCESSORS MAXIMUM_PROC_PER_GROUP + +// begin_ntoshvp + +// +// Handle to an Object +// + +#ifdef STRICT +typedef void *HANDLE; +#if 0 && (_MSC_VER > 1000) +#define DECLARE_HANDLE(name) struct name##__; typedef struct name##__ *name +#else +#define DECLARE_HANDLE(name) struct name##__{int unused;}; typedef struct name##__ *name +#endif +#else +typedef PVOID HANDLE; +#define DECLARE_HANDLE(name) typedef HANDLE name +#endif +typedef HANDLE *PHANDLE; + +// end_ntoshvp + +// +// Flag (bit) fields +// + +typedef UCHAR FCHAR; +typedef USHORT FSHORT; +typedef ULONG FLONG; + +// begin_ntoshvp + +// Component Object Model defines, and macros + +#ifndef _HRESULT_DEFINED +#define _HRESULT_DEFINED +#ifdef __midl +typedef LONG HRESULT; +#else +typedef _Return_type_success_(return >= 0) long HRESULT; +#endif // __midl +#endif // !_HRESULT_DEFINED + +// end_ntoshvp + +#ifdef __cplusplus + #define EXTERN_C extern "C" + #define EXTERN_C_START extern "C" { + #define EXTERN_C_END } + + #if _MSC_VER >= 1900 + #define WIN_NOEXCEPT noexcept + #else + #define WIN_NOEXCEPT throw() + #endif + + // 'noexcept' on typedefs is invalid prior to C++17 + #if _MSVC_LANG >= 201703 + #define WIN_NOEXCEPT_PFN noexcept + #else + #define WIN_NOEXCEPT_PFN + #endif +#else + #define EXTERN_C extern + #define EXTERN_C_START + #define EXTERN_C_END + #define WIN_NOEXCEPT + #define WIN_NOEXCEPT_PFN +#endif + +#if defined(_WIN32) || defined(_MPPC_) + +// Win32 doesn't support __export + +#ifdef _68K_ +#define STDMETHODCALLTYPE __cdecl +#else +#define STDMETHODCALLTYPE __stdcall +#endif +#define STDMETHODVCALLTYPE __cdecl + +#define STDAPICALLTYPE __stdcall +#define STDAPIVCALLTYPE __cdecl + +#else + +#define STDMETHODCALLTYPE __export __stdcall +#define STDMETHODVCALLTYPE __export __cdecl + +#define STDAPICALLTYPE __export __stdcall +#define STDAPIVCALLTYPE __export __cdecl + +#endif + + +#define STDAPI EXTERN_C HRESULT STDAPICALLTYPE +#define STDAPI_CHPE_PATCHABLE EXTERN_C DECLSPEC_CHPE_PATCHABLE HRESULT STDAPICALLTYPE +#define STDAPI_(type) EXTERN_C type STDAPICALLTYPE +#define STDAPI_CHPE_PATCHABLE_(type) EXTERN_C DECLSPEC_CHPE_PATCHABLE type STDAPICALLTYPE +#define DEPRECATED_STDAPI(message) EXTERN_C __declspec(deprecated(message)) HRESULT STDAPICALLTYPE +#define DEPRECATED_NO_MESSAGE_STDAPI EXTERN_C __declspec(deprecated) HRESULT STDAPICALLTYPE +#define DEPRECATED_STDAPI_(type, message) EXTERN_C __declspec(deprecated(message)) type STDAPICALLTYPE +#define DEPRECATED_NO_MESSAGE_STDAPI_(type) EXTERN_C __declspec(deprecated) type STDAPICALLTYPE + +#define STDMETHODIMP HRESULT STDMETHODCALLTYPE +#define STDMETHODIMP_(type) type STDMETHODCALLTYPE + +#define STDOVERRIDEMETHODIMP __override STDMETHODIMP +#define STDOVERRIDEMETHODIMP_(type) __override STDMETHODIMP_(type) + +#define IFACEMETHODIMP __override STDMETHODIMP +#define IFACEMETHODIMP_(type) __override STDMETHODIMP_(type) + +// The 'V' versions allow Variable Argument lists. + +#define STDAPIV EXTERN_C HRESULT STDAPIVCALLTYPE +#define STDAPIV_(type) EXTERN_C type STDAPIVCALLTYPE + +#define DEPRECATED_STDAPIV(message) EXTERN_C __declspec(deprecated(message)) HRESULT STDAPIVCALLTYPE +#define DEPRECATED_NO_MESSAGE_STDAPIV EXTERN_C __declspec(deprecated) HRESULT STDAPIVCALLTYPE +#define DEPRECATED_STDAPIV_(type, message) EXTERN_C __declspec(deprecated(message)) type STDAPIVCALLTYPE +#define DEPRECATED_NO_MESSAGE_STDAPIV_(type) EXTERN_C __declspec(deprecated) type STDAPIVCALLTYPE + +#define STDMETHODIMPV HRESULT STDMETHODVCALLTYPE +#define STDMETHODIMPV_(type) type STDMETHODVCALLTYPE + +#define STDOVERRIDEMETHODIMPV __override STDMETHODIMPV +#define STDOVERRIDEMETHODIMPV_(type) __override STDMETHODIMPV_(type) + +#define IFACEMETHODIMPV __override STDMETHODIMPV +#define IFACEMETHODIMPV_(type) __override STDMETHODIMPV_(type) + +// end_winnt + + +// +// Low order two bits of a handle are ignored by the system and available +// for use by application code as tag bits. The remaining bits are opaque +// and used to store a serial number and table index. +// + +#define OBJ_HANDLE_TAGBITS 0x00000003L + +// begin_ntoshvp +// begin_wudfpwdm + +// +// Cardinal Data Types [0 - 2**N-2) +// + +typedef char CCHAR; // winnt +typedef short CSHORT; +typedef ULONG CLONG; + +typedef CCHAR *PCCHAR; +typedef CSHORT *PCSHORT; +typedef CLONG *PCLONG; + +// end_wudfpwdm +// end_ntoshvp +// end_ntminiport end_ntndis end_ntminitape + +// +// NLS basics (Locale and Language Ids) +// + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// The LCID and LANGID concepts are deprecated and no longer supported. +// Please use Locale Names instead. See the documentation for GetLocaleInfoEx. +// +// There are numerous challenges with the LCID concept which makes it impossible for +// them to support all of the languages and dialects that may be encountered by a +// modern application. Please use Locale Names. +// +typedef ULONG LCID; // DEPRECATED, use Locale Names. See documentation for GetLocaleInfoEx. // winnt +typedef PULONG PLCID; // DEPRECATED, use Locale Names. See documentation for GetLocaleInfoEx. // winnt +typedef USHORT LANGID; // DEPRECATED, use Locale Names. See documentation for GetLocaleInfoEx. // winnt + +// begin_winnt + +#ifndef __COMPARTMENT_ID_DEFINED__ +#define __COMPARTMENT_ID_DEFINED__ + +// +// Compartment identifier +// + +typedef enum { + UNSPECIFIED_COMPARTMENT_ID = 0, + DEFAULT_COMPARTMENT_ID +} COMPARTMENT_ID, *PCOMPARTMENT_ID; + +#endif // __COMPARTMENT_ID_DEFINED__ + +// end_winnt + +// begin_ntoshvp +// begin_wudfpwdm + +// +// Logical Data Type - These are 32-bit logical values. +// +typedef ULONG LOGICAL; +typedef ULONG *PLOGICAL; + +// end_wudfpwdm +// end_ntoshvp + +// begin_ntndis begin_windbgkd +// begin_ntoshvp +// begin_wudfwdm +// begin_sdfwdm +// +// NTSTATUS +// + +typedef _Return_type_success_(return >= 0) LONG NTSTATUS; +/*lint -save -e624 */ // Don't complain about different typedefs. +typedef NTSTATUS *PNTSTATUS; +/*lint -restore */ // Resume checking for different typedefs. + +#if _WIN32_WINNT >= 0x0600 +typedef CONST NTSTATUS *PCNTSTATUS; +#endif // _WIN32_WINNT >= 0x0600 + +// +// Status values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-------------------------+-------------------------------+ +// |Sev|C| Facility | Code | +// +---+-+-------------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// Facility - is the facility code +// +// Code - is the facility's status code +// + +// +// Generic test for success on any status value (non-negative numbers +// indicate success). +// + +#define NT_SUCCESS(Status) (((NTSTATUS)(Status)) >= 0) + +// +// Generic test for information on any status value. +// + +#define NT_INFORMATION(Status) ((((ULONG)(Status)) >> 30) == 1) + +// +// Generic test for warning on any status value. +// + +#define NT_WARNING(Status) ((((ULONG)(Status)) >> 30) == 2) + +// +// Generic test for error on any status value. +// + +#define NT_ERROR(Status) ((((ULONG)(Status)) >> 30) == 3) + +// end_sdfwdm +// end_wudfwdm +// end_ntoshvp +// end_windbgkd +// begin_winnt +#define APPLICATION_ERROR_MASK 0x20000000 +#define ERROR_SEVERITY_SUCCESS 0x00000000 +#define ERROR_SEVERITY_INFORMATIONAL 0x40000000 +#define ERROR_SEVERITY_WARNING 0x80000000 +#define ERROR_SEVERITY_ERROR 0xC0000000 +// end_winnt + +#ifndef __SECSTATUS_DEFINED__ +typedef long SECURITY_STATUS; +#define __SECSTATUS_DEFINED__ +#endif + + +// end_ntndis +// +// Large (64-bit) integer types and operations +// + +#define TIME LARGE_INTEGER +#define _TIME _LARGE_INTEGER +#define PTIME PLARGE_INTEGER +#define LowTime LowPart +#define HighTime HighPart + +// begin_winnt +// begin_ntoshvp + +// +// _M_IX86 included so that EM CONTEXT structure compiles with +// x86 programs. *** TBD should this be for all architectures? +// + +// +// 16 byte aligned type for 128 bit floats +// + +// +// For we define a 128 bit structure and use __declspec(align(16)) pragma to +// align to 128 bits. +// + +#if defined(_M_IA64) && !defined(MIDL_PASS) +__declspec(align(16)) +#endif +typedef struct _FLOAT128 { + __int64 LowPart; + __int64 HighPart; +} FLOAT128; + +typedef FLOAT128 *PFLOAT128; + +// end_winnt + + +// begin_winnt begin_ntminiport begin_ntndis begin_ntminitape + +// +// __int64 is only supported by 2.0 and later midl. +// __midl is set by the 2.0 midl and not by 1.0 midl. +// + +#define _ULONGLONG_ +#if (!defined (_MAC) && (!defined(MIDL_PASS) || defined(__midl)) && (!defined(_M_IX86) || (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 64))) +typedef __int64 LONGLONG; +typedef unsigned __int64 ULONGLONG; + +#define MAXLONGLONG (0x7fffffffffffffff) + + +#else + +#if defined(_MAC) && defined(_MAC_INT_64) +typedef __int64 LONGLONG; +typedef unsigned __int64 ULONGLONG; + +#define MAXLONGLONG (0x7fffffffffffffff) + + +#else +typedef double LONGLONG; +typedef double ULONGLONG; +#endif //_MAC and int64 + +#endif + +typedef LONGLONG *PLONGLONG; +typedef ULONGLONG *PULONGLONG; + +// Update Sequence Number + +typedef LONGLONG USN; + +#if defined(MIDL_PASS) +typedef struct _LARGE_INTEGER { + LONGLONG QuadPart; +} LARGE_INTEGER; +#else // MIDL_PASS +typedef union _LARGE_INTEGER { + struct { + ULONG LowPart; + LONG HighPart; + } DUMMYSTRUCTNAME; + struct { + ULONG LowPart; + LONG HighPart; + } u; + LONGLONG QuadPart; +} LARGE_INTEGER; +#endif //MIDL_PASS + +typedef LARGE_INTEGER *PLARGE_INTEGER; + +#if defined(MIDL_PASS) +typedef struct _ULARGE_INTEGER { + ULONGLONG QuadPart; +} ULARGE_INTEGER; +#else // MIDL_PASS +typedef union _ULARGE_INTEGER { + struct { + ULONG LowPart; + ULONG HighPart; + } DUMMYSTRUCTNAME; + struct { + ULONG LowPart; + ULONG HighPart; + } u; + ULONGLONG QuadPart; +} ULARGE_INTEGER; +#endif //MIDL_PASS + +typedef ULARGE_INTEGER *PULARGE_INTEGER; + +// +// Reference count. +// + +typedef LONG_PTR RTL_REFERENCE_COUNT, *PRTL_REFERENCE_COUNT; +typedef LONG RTL_REFERENCE_COUNT32, *PRTL_REFERENCE_COUNT32; + +// end_ntminiport end_ntndis end_ntminitape +// end_ntoshvp + + +// +// Locally Unique Identifier +// + +typedef struct _LUID { + ULONG LowPart; + LONG HighPart; +} LUID, *PLUID; + +#define _DWORDLONG_ +typedef ULONGLONG DWORDLONG; +typedef DWORDLONG *PDWORDLONG; + +// end_winnt + +// begin_sdfwdm +// begin_ntminiport begin_ntndis +// begin_wudfwdm +// begin_ntoshvp + +// +// Physical address. +// + +typedef LARGE_INTEGER PHYSICAL_ADDRESS, *PPHYSICAL_ADDRESS; + +// end_ntoshvp +// end_wudfwdm +// end_ntminiport end_ntndis +// end_sdfwdm + +// begin_winnt + +// +// Define operations to logically shift an int64 by 0..31 bits and to multiply +// 32-bits by 32-bits to form a 64-bit product. +// + +#if defined(MIDL_PASS) || defined(RC_INVOKED) || defined(_M_CEE_PURE) \ + || defined(_68K_) || defined(_MPPC_) \ + || defined(_M_IA64) || defined(_M_AMD64) || defined(_M_ARM) || defined(_M_ARM64) \ + || defined(_M_HYBRID_X86_ARM64) + +// +// Midl does not understand inline assembler. Therefore, the Rtl functions +// are used for shifts by 0..31 and multiplies of 32-bits times 32-bits to +// form a 64-bit product. +// +// +// IA64 and AMD64 have native 64-bit operations that are just as fast as their +// 32-bit counter parts. Therefore, the int64 data type is used directly to form +// shifts of 0..31 and multiplies of 32-bits times 32-bits to form a 64-bit +// product. +// + +#define Int32x32To64(a, b) (((__int64)((long)(a))) * ((__int64)((long)(b)))) +#define UInt32x32To64(a, b) (((unsigned __int64)((unsigned int)(a))) * ((unsigned __int64)((unsigned int)(b)))) + +#define Int64ShllMod32(a, b) (((unsigned __int64)(a)) << (b)) +#define Int64ShraMod32(a, b) (((__int64)(a)) >> (b)) +#define Int64ShrlMod32(a, b) (((unsigned __int64)(a)) >> (b)) + + +#elif defined(_M_IX86) + +// +// The x86 C compiler understands inline assembler. Therefore, inline functions +// that employ inline assembler are used for shifts of 0..31. The multiplies +// rely on the compiler recognizing the cast of the multiplicand to int64 to +// generate the optimal code inline. +// + +#define Int32x32To64(a, b) ((__int64)(((__int64)((long)(a))) * ((long)(b)))) +#define UInt32x32To64(a, b) ((unsigned __int64)(((unsigned __int64)((unsigned int)(a))) * ((unsigned int)(b)))) + + +ULONGLONG +NTAPI +Int64ShllMod32 ( + _In_ ULONGLONG Value, + _In_ ULONG ShiftCount + ); + +LONGLONG +NTAPI +Int64ShraMod32 ( + _In_ LONGLONG Value, + _In_ ULONG ShiftCount + ); + +ULONGLONG +NTAPI +Int64ShrlMod32 ( + _In_ ULONGLONG Value, + _In_ ULONG ShiftCount + ); + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4035 4793) // re-enable below + +__inline ULONGLONG +NTAPI +Int64ShllMod32 ( + _In_ ULONGLONG Value, + _In_ ULONG ShiftCount + ) +{ + __asm { + mov ecx, ShiftCount + mov eax, dword ptr [Value] + mov edx, dword ptr [Value+4] + shld edx, eax, cl + shl eax, cl + } +} + +__inline LONGLONG +NTAPI +Int64ShraMod32 ( + _In_ LONGLONG Value, + _In_ ULONG ShiftCount + ) +{ + __asm { + mov ecx, ShiftCount + mov eax, dword ptr [Value] + mov edx, dword ptr [Value+4] + shrd eax, edx, cl + sar edx, cl + } +} + +__inline ULONGLONG +NTAPI +Int64ShrlMod32 ( + _In_ ULONGLONG Value, + _In_ ULONG ShiftCount + ) +{ + __asm { + mov ecx, ShiftCount + mov eax, dword ptr [Value] + mov edx, dword ptr [Value+4] + shrd eax, edx, cl + shr edx, cl + } +} + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4035 4793) +#endif + +#else + +#error Must define a target architecture. + +#endif + +// +// Define rotate intrinsics. +// + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(_M_AMD64) + +#define RotateLeft8 _rotl8 +#define RotateLeft16 _rotl16 +#define RotateRight8 _rotr8 +#define RotateRight16 _rotr16 + +unsigned char +__cdecl +_rotl8 ( + _In_ unsigned char Value, + _In_ unsigned char Shift + ); + +unsigned short +__cdecl +_rotl16 ( + _In_ unsigned short Value, + _In_ unsigned char Shift + ); + +unsigned char +__cdecl +_rotr8 ( + _In_ unsigned char Value, + _In_ unsigned char Shift + ); + +unsigned short +__cdecl +_rotr16 ( + _In_ unsigned short Value, + _In_ unsigned char Shift + ); + +#pragma intrinsic(_rotl8) +#pragma intrinsic(_rotl16) +#pragma intrinsic(_rotr8) +#pragma intrinsic(_rotr16) + +#endif /* _M_AMD64 */ + +#if _MSC_VER >= 1300 + +#define RotateLeft32 _rotl +#define RotateLeft64 _rotl64 +#define RotateRight32 _rotr +#define RotateRight64 _rotr64 + +unsigned int +__cdecl +_rotl ( + _In_ unsigned int Value, + _In_ int Shift + ); + +unsigned __int64 +__cdecl +_rotl64 ( + _In_ unsigned __int64 Value, + _In_ int Shift + ); + +unsigned int +__cdecl +_rotr ( + _In_ unsigned int Value, + _In_ int Shift + ); + +unsigned __int64 +__cdecl +_rotr64 ( + _In_ unsigned __int64 Value, + _In_ int Shift + ); + +#pragma intrinsic(_rotl) +#pragma intrinsic(_rotl64) +#pragma intrinsic(_rotr) +#pragma intrinsic(_rotr64) + +#endif /* _MSC_VER >= 1300 */ + +#ifdef __cplusplus +} +#endif + +// end_winnt + +// begin_wudfwdm +// +// Event type +// + +typedef enum _EVENT_TYPE { + NotificationEvent, + SynchronizationEvent +} EVENT_TYPE; + +// end_wudfwdm +// +// Timer type +// + +typedef enum _TIMER_TYPE { + NotificationTimer, + SynchronizationTimer +} TIMER_TYPE; + +// +// Wait type +// + +typedef enum _WAIT_TYPE { + WaitAll, + WaitAny, + WaitNotification, + WaitDequeue, + WaitDpc +} WAIT_TYPE; + +// begin_ntoshvp +// begin_wudfwdm +// begin_sdfwdm +// +// Pointer to an Asciiz string +// + +typedef _Null_terminated_ CHAR *PSZ; +typedef _Null_terminated_ CONST char *PCSZ; + +// begin_ntndis +// +// Counted String +// + +typedef USHORT RTL_STRING_LENGTH_TYPE; + +typedef struct _STRING { + USHORT Length; + USHORT MaximumLength; +#ifdef MIDL_PASS + [size_is(MaximumLength), length_is(Length) ] +#endif // MIDL_PASS + _Field_size_bytes_part_opt_(MaximumLength, Length) PCHAR Buffer; +} STRING; +typedef STRING *PSTRING; +typedef STRING ANSI_STRING; +typedef PSTRING PANSI_STRING; + +// end_sdfwdm +// end_wudfwdm + +typedef STRING OEM_STRING; +typedef PSTRING POEM_STRING; +typedef CONST STRING* PCOEM_STRING; + +// +// CONSTCounted String +// + +typedef struct _CSTRING { + USHORT Length; + USHORT MaximumLength; + CONST char *Buffer; +} CSTRING; +typedef CSTRING *PCSTRING; +#define ANSI_NULL ((CHAR)0) // winnt + +// begin_wudfwdm +// begin_sdfwdm + +typedef STRING CANSI_STRING; +typedef PSTRING PCANSI_STRING; + +typedef STRING UTF8_STRING; +typedef PSTRING PUTF8_STRING; + +// +// Unicode strings are counted 16-bit character strings. If they are +// NULL terminated, Length does not include trailing NULL. +// + +typedef struct _UNICODE_STRING { + USHORT Length; + USHORT MaximumLength; +#ifdef MIDL_PASS + [size_is(MaximumLength / 2), length_is((Length) / 2) ] USHORT * Buffer; +#else // MIDL_PASS + _Field_size_bytes_part_opt_(MaximumLength, Length) PWCH Buffer; +#endif // MIDL_PASS +} UNICODE_STRING; +typedef UNICODE_STRING *PUNICODE_STRING; +typedef const UNICODE_STRING *PCUNICODE_STRING; +// end_sdfwdm +// end_wudfwdm + +#define UNICODE_NULL ((WCHAR)0) // winnt + +#if _WIN32_WINNT >= 0x0500 + +#define UNICODE_STRING_MAX_BYTES ((USHORT) 65534) // winnt +#define UNICODE_STRING_MAX_CHARS (32767) // winnt + +// begin_wudfwdm +// begin_sdfwdm + +#define DECLARE_CONST_UNICODE_STRING(_var, _string) \ +const WCHAR _var ## _buffer[] = _string; \ +__pragma(warning(push)) \ +__pragma(warning(disable:4221)) __pragma(warning(disable:4204)) \ +const UNICODE_STRING _var = { sizeof(_string) - sizeof(WCHAR), sizeof(_string), (PWCH) _var ## _buffer } \ +__pragma(warning(pop)) + +#define DECLARE_GLOBAL_CONST_UNICODE_STRING(_var, _str) \ +extern const __declspec(selectany) UNICODE_STRING _var = RTL_CONSTANT_STRING(_str) + +#define DECLARE_UNICODE_STRING_SIZE(_var, _size) \ +WCHAR _var ## _buffer[_size]; \ +__pragma(warning(push)) \ +__pragma(warning(disable:4221)) __pragma(warning(disable:4204)) \ +UNICODE_STRING _var = { 0, (_size) * sizeof(WCHAR) , _var ## _buffer } \ +__pragma(warning(pop)) + +// end_sdfwdm +// end_wudfwdm + +#endif // _WIN32_WINNT >= 0x0500 + + +// begin_ntminiport begin_ntminitape + +// +// Boolean +// + +typedef UCHAR BOOLEAN; // winnt +typedef BOOLEAN *PBOOLEAN; // winnt + +// end_ntminiport end_ntminitape + +// begin_winnt +// +// Doubly linked list structure. Can be used as either a list head, or +// as link words. +// + +typedef struct _LIST_ENTRY { + struct _LIST_ENTRY *Flink; + struct _LIST_ENTRY *Blink; +} LIST_ENTRY, *PLIST_ENTRY, *RESTRICTED_POINTER PRLIST_ENTRY; + +// +// Singly linked list structure. Can be used as either a list head, or +// as link words. +// + +typedef struct _SINGLE_LIST_ENTRY { + struct _SINGLE_LIST_ENTRY *Next; +} SINGLE_LIST_ENTRY, *PSINGLE_LIST_ENTRY; + +// end_ntoshvp +// end_winnt end_ntndis +// begin_wudfpwdm + +// +// Balanced tree node (AVL or RB) structure definition. +// + +#pragma warning(push) +#pragma warning(disable:4214) + +typedef struct _RTL_BALANCED_NODE { + union { + struct _RTL_BALANCED_NODE *Children[2]; + struct { + struct _RTL_BALANCED_NODE *Left; + struct _RTL_BALANCED_NODE *Right; + } DUMMYSTRUCTNAME; + } DUMMYUNIONNAME; + +#define RTL_BALANCED_NODE_RESERVED_PARENT_MASK 3 + + union { + UCHAR Red : 1; + UCHAR Balance : 2; + ULONG_PTR ParentValue; + } DUMMYUNIONNAME2; +} RTL_BALANCED_NODE, *PRTL_BALANCED_NODE; + +#pragma warning(pop) + +#define RTL_BALANCED_NODE_GET_PARENT_POINTER(Node) \ + ((PRTL_BALANCED_NODE)((Node)->ParentValue & \ + ~RTL_BALANCED_NODE_RESERVED_PARENT_MASK)) + +// end_wudfpwdm +// begin_winnt +// begin_ntoshvp + +// +// These are needed for portable debugger support. +// + +typedef struct LIST_ENTRY32 { + ULONG Flink; + ULONG Blink; +} LIST_ENTRY32; +typedef LIST_ENTRY32 *PLIST_ENTRY32; + +typedef struct LIST_ENTRY64 { + ULONGLONG Flink; + ULONGLONG Blink; +} LIST_ENTRY64; +typedef LIST_ENTRY64 *PLIST_ENTRY64; + +// end_winnt + +typedef struct _SINGLE_LIST_ENTRY32 { + ULONG Next; +} SINGLE_LIST_ENTRY32, *PSINGLE_LIST_ENTRY32; + +#if !defined(MIDL_PASS) +__inline +void +ListEntry32To64( + _In_ PLIST_ENTRY32 l32, + _Out_ PLIST_ENTRY64 l64 + ) +{ + l64->Flink = (ULONGLONG)(ULONG)l32->Flink; + l64->Blink = (ULONGLONG)(ULONG)l32->Blink; +} + +__inline +void +ListEntry64To32( + _In_ PLIST_ENTRY64 l64, + _Out_ PLIST_ENTRY32 l32 + ) +{ + l32->Flink = (ULONG)l64->Flink; + l32->Blink = (ULONG)l64->Blink; +} +#endif + +// +// The WNF state name is the fixed-length binary that uniquely identifies the +// state. Clients should treat it as opaque data of a fixed size and +// use provided API to manipulate state names. +// +// This is being moved from ntexapi_h.h -- so for now it is defined in both places. +// + +#ifndef _DEFINED__WNF_STATE_NAME +#define _DEFINED__WNF_STATE_NAME +typedef struct _WNF_STATE_NAME { + ULONG Data[2]; +} WNF_STATE_NAME; + +typedef struct _WNF_STATE_NAME* PWNF_STATE_NAME; +typedef const struct _WNF_STATE_NAME* PCWNF_STATE_NAME; +#endif + + +typedef struct _STRING32 { + USHORT Length; + USHORT MaximumLength; + ULONG Buffer; +} STRING32; +typedef STRING32 *PSTRING32; + +typedef STRING32 UNICODE_STRING32; +typedef UNICODE_STRING32 *PUNICODE_STRING32; + +typedef STRING32 ANSI_STRING32; +typedef ANSI_STRING32 *PANSI_STRING32; + + +typedef struct _STRING64 { + USHORT Length; + USHORT MaximumLength; + ULONGLONG Buffer; +} STRING64; +typedef STRING64 *PSTRING64; + +typedef STRING64 UNICODE_STRING64; +typedef UNICODE_STRING64 *PUNICODE_STRING64; + +typedef STRING64 ANSI_STRING64; +typedef ANSI_STRING64 *PANSI_STRING64; + +// begin_wudfwdm +// +// Valid values for the Attributes field +// + +#define OBJ_INHERIT 0x00000002L +#define OBJ_PERMANENT 0x00000010L +#define OBJ_EXCLUSIVE 0x00000020L +#define OBJ_CASE_INSENSITIVE 0x00000040L +#define OBJ_OPENIF 0x00000080L +#define OBJ_OPENLINK 0x00000100L +#define OBJ_KERNEL_HANDLE 0x00000200L +#define OBJ_FORCE_ACCESS_CHECK 0x00000400L +#define OBJ_IGNORE_IMPERSONATED_DEVICEMAP 0x00000800L +#define OBJ_DONT_REPARSE 0x00001000L +#define OBJ_VALID_ATTRIBUTES 0x00001FF2L + +// end_wudfwdm +// +// Object Attributes structure +// + +typedef struct _OBJECT_ATTRIBUTES64 { + ULONG Length; + ULONG64 RootDirectory; + ULONG64 ObjectName; + ULONG Attributes; + ULONG64 SecurityDescriptor; + ULONG64 SecurityQualityOfService; +} OBJECT_ATTRIBUTES64; +typedef OBJECT_ATTRIBUTES64 *POBJECT_ATTRIBUTES64; +typedef CONST OBJECT_ATTRIBUTES64 *PCOBJECT_ATTRIBUTES64; + +typedef struct _OBJECT_ATTRIBUTES32 { + ULONG Length; + ULONG RootDirectory; + ULONG ObjectName; + ULONG Attributes; + ULONG SecurityDescriptor; + ULONG SecurityQualityOfService; +} OBJECT_ATTRIBUTES32; +typedef OBJECT_ATTRIBUTES32 *POBJECT_ATTRIBUTES32; +typedef CONST OBJECT_ATTRIBUTES32 *PCOBJECT_ATTRIBUTES32; + +// begin_wudfwdm + +typedef struct _OBJECT_ATTRIBUTES { + ULONG Length; + HANDLE RootDirectory; + PUNICODE_STRING ObjectName; + ULONG Attributes; + PVOID SecurityDescriptor; // Points to type SECURITY_DESCRIPTOR + PVOID SecurityQualityOfService; // Points to type SECURITY_QUALITY_OF_SERVICE +} OBJECT_ATTRIBUTES; +typedef OBJECT_ATTRIBUTES *POBJECT_ATTRIBUTES; +typedef CONST OBJECT_ATTRIBUTES *PCOBJECT_ATTRIBUTES; + +//++ +// +// VOID +// InitializeObjectAttributes( +// _Out_ POBJECT_ATTRIBUTES p, +// _In_ PUNICODE_STRING n, +// _In_ ULONG a, +// _In_ HANDLE r, +// _In_ PSECURITY_DESCRIPTOR s +// ) +// +//-- + +#define InitializeObjectAttributes( p, n, a, r, s ) { \ + (p)->Length = sizeof( OBJECT_ATTRIBUTES ); \ + (p)->RootDirectory = r; \ + (p)->Attributes = a; \ + (p)->ObjectName = n; \ + (p)->SecurityDescriptor = s; \ + (p)->SecurityQualityOfService = NULL; \ + } + +// end_wudfwdm + +// RTL_ to avoid collisions in the global namespace. +// I don't believe there are possible/likely constant RootDirectory +// or SecurityDescriptor values other than NULL, so they are hardcoded. +// As well, the string will generally be const, so we cast that away. +#define RTL_CONSTANT_OBJECT_ATTRIBUTES(n, a) \ + { sizeof(OBJECT_ATTRIBUTES), NULL, RTL_CONST_CAST(PUNICODE_STRING)(n), a, NULL, NULL } + +// This synonym is more appropriate for initializing what isn't actually const. +#define RTL_INIT_OBJECT_ATTRIBUTES(n, a) RTL_CONSTANT_OBJECT_ATTRIBUTES(n, a) + +// begin_ntminiport begin_ntndis begin_ntminitape + +// +// Constants +// + +#define FALSE 0 +#define TRUE 1 + +#ifndef NULL +#ifdef __cplusplus +#define NULL 0 +#define NULL64 0 +#else +#define NULL ((void *)0) +#define NULL64 ((void * POINTER_64)0) +#endif +#endif // NULL + +// end_ntoshvp +// end_ntminiport end_ntndis end_ntminitape + +// begin_winnt begin_ntndis + +#include + +#ifndef __OBJECTID_DEFINED +#define __OBJECTID_DEFINED + +typedef struct _OBJECTID { // size is 20 + GUID Lineage; + ULONG Uniquifier; +} OBJECTID; +#endif // !_OBJECTID_DEFINED + +// end_winnt end_ntndis +// begin_wudfpwdm + +#define MINCHAR 0x80 // winnt +#define MAXCHAR 0x7f // winnt +#define MINSHORT 0x8000 // winnt +#define MAXSHORT 0x7fff // winnt +#define MINLONG 0x80000000 // winnt +#define MAXLONG 0x7fffffff // winnt +#define MAXUCHAR 0xff // winnt +#define MAXUSHORT 0xffff // winnt +#define MAXULONG 0xffffffff // winnt + +// end_wudfpwdm + +// +// Useful Helper Macros +// + +// begin_ntndis +// begin_wudfwdm +// +// Determine if an argument is present by testing the value of the pointer +// to the argument value. +// + +#define ARGUMENT_PRESENT(ArgumentPointer) (\ + (CHAR *)((ULONG_PTR)(ArgumentPointer)) != (CHAR *)(NULL) ) + +// end_wudfwdm +// begin_winnt begin_ntminiport +// begin_ntoshvp +// +// Calculate the byte offset of a field in a structure of type type. +// + +#ifdef __has_builtin +#if __has_builtin(__builtin_offsetof) +#define FIELD_OFFSET(type, field) ((LONG)__builtin_offsetof(type, field)) +#define UFIELD_OFFSET(type, field) ((ULONG)__builtin_offsetof(type, field)) +#endif +#endif + +#ifndef FIELD_OFFSET +#define FIELD_OFFSET(type, field) ((LONG)(LONG_PTR)&(((type *)0)->field)) +#define UFIELD_OFFSET(type, field) ((ULONG)(LONG_PTR)&(((type *)0)->field)) +#endif + +// +// Calculate the size of a field in a structure of type type, without +// knowing or stating the type of the field. +// +#define RTL_FIELD_SIZE(type, field) (sizeof(((type *)0)->field)) + +// +// Calculate the size of a structure of type type up through and +// including a field. +// +#define RTL_SIZEOF_THROUGH_FIELD(type, field) \ + (FIELD_OFFSET(type, field) + RTL_FIELD_SIZE(type, field)) + +// end_ntoshvp + +// +// RTL_CONTAINS_FIELD usage: +// +// if (RTL_CONTAINS_FIELD(pBlock, pBlock->cbSize, dwMumble)) +// // safe to use pBlock->dwMumble +// +#define RTL_CONTAINS_FIELD(Struct, Size, Field) \ + ( (((PCHAR)(&(Struct)->Field)) + sizeof((Struct)->Field)) <= (((PCHAR)(Struct))+(Size)) ) + +// +// Return the number of elements in a statically sized array. +// ULONG Buffer[100]; +// RTL_NUMBER_OF(Buffer) == 100 +// This is also popularly known as: NUMBER_OF, ARRSIZE, _countof, NELEM, etc. +// +#define RTL_NUMBER_OF_V1(A) (sizeof(A)/sizeof((A)[0])) + +#if defined(__cplusplus) && \ + !defined(MIDL_PASS) && \ + !defined(RC_INVOKED) && \ + !defined(_PREFAST_) && \ + (_MSC_FULL_VER >= 13009466) && \ + !defined(SORTPP_PASS) +// +// RtlpNumberOf is a function that takes a reference to an array of N Ts. +// +// typedef T array_of_T[N]; +// typedef array_of_T &reference_to_array_of_T; +// +// RtlpNumberOf returns a pointer to an array of N chars. +// We could return a reference instead of a pointer but older compilers do not accept that. +// +// typedef char array_of_char[N]; +// typedef array_of_char *pointer_to_array_of_char; +// +// sizeof(array_of_char) == N +// sizeof(*pointer_to_array_of_char) == N +// +// pointer_to_array_of_char RtlpNumberOf(reference_to_array_of_T); +// +// We never even call RtlpNumberOf, we just take the size of dereferencing its return type. +// We do not even implement RtlpNumberOf, we just declare it. +// +// Attempts to pass pointers instead of arrays to this macro result in compile time errors. +// That is the point. +// + +// end_ntndis end_ntminiport + +#pragma region Application Family or OneCore Family Or Game Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// begin_ntndis begin_ntminiport + +extern "C++" // templates cannot be declared to have 'C' linkage +template +char (*RtlpNumberOf( UNALIGNED T (&)[N] ))[N]; + +// end_ntndis end_ntminiport + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +// begin_ntndis begin_ntminiport + +#define RTL_NUMBER_OF_V2(A) (sizeof(*RtlpNumberOf(A))) + +// +// This does not work with: +// +// void Foo() +// { +// struct { int x; } y[2]; +// RTL_NUMBER_OF_V2(y); // illegal use of anonymous local type in template instantiation +// } +// +// You must instead do: +// +// struct Foo1 { int x; }; +// +// void Foo() +// { +// Foo1 y[2]; +// RTL_NUMBER_OF_V2(y); // ok +// } +// +// OR +// +// void Foo() +// { +// struct { int x; } y[2]; +// RTL_NUMBER_OF_V1(y); // ok +// } +// +// OR +// +// void Foo() +// { +// struct { int x; } y[2]; +// _ARRAYSIZE(y); // ok +// } +// + +#else +#define RTL_NUMBER_OF_V2(A) RTL_NUMBER_OF_V1(A) +#endif + +#ifdef ENABLE_RTL_NUMBER_OF_V2 +#define RTL_NUMBER_OF(A) RTL_NUMBER_OF_V2(A) +#else +#define RTL_NUMBER_OF(A) RTL_NUMBER_OF_V1(A) +#endif + +// +// ARRAYSIZE is more readable version of RTL_NUMBER_OF_V2, and uses +// it regardless of ENABLE_RTL_NUMBER_OF_V2 +// +// _ARRAYSIZE is a version useful for anonymous types +// +#define ARRAYSIZE(A) RTL_NUMBER_OF_V2(A) +#define _ARRAYSIZE(A) RTL_NUMBER_OF_V1(A) + +// +// An expression that yields the type of a field in a struct. +// +#define RTL_FIELD_TYPE(type, field) (((type*)0)->field) + +// RTL_ to avoid collisions in the global namespace. +// +// Given typedef struct _FOO { BYTE Bar[123]; } FOO; +// RTL_NUMBER_OF_FIELD(FOO, Bar) == 123 +// +#define RTL_NUMBER_OF_FIELD(type, field) (RTL_NUMBER_OF(RTL_FIELD_TYPE(type, field))) + +// +// eg: +// typedef struct FOO { +// ULONG Integer; +// PVOID Pointer; +// } FOO; +// +// RTL_PADDING_BETWEEN_FIELDS(FOO, Integer, Pointer) == 0 for Win32, 4 for Win64 +// +#define RTL_PADDING_BETWEEN_FIELDS(T, F1, F2) \ + ((FIELD_OFFSET(T, F2) > FIELD_OFFSET(T, F1)) \ + ? (FIELD_OFFSET(T, F2) - FIELD_OFFSET(T, F1) - RTL_FIELD_SIZE(T, F1)) \ + : (FIELD_OFFSET(T, F1) - FIELD_OFFSET(T, F2) - RTL_FIELD_SIZE(T, F2))) + +// RTL_ to avoid collisions in the global namespace. +#if defined(__cplusplus) +#define RTL_CONST_CAST(type) const_cast +#else +#define RTL_CONST_CAST(type) (type) +#endif + +// end_winnt +// +// This works "generically" for Unicode and Ansi/Oem strings. +// Usage: +// const static UNICODE_STRING FooU = RTL_CONSTANT_STRING(L"Foo"); +// const static STRING Foo = RTL_CONSTANT_STRING( "Foo"); +// instead of the slower: +// UNICODE_STRING FooU; +// STRING Foo; +// RtlInitUnicodeString(&FooU, L"Foo"); +// RtlInitString(&Foo , "Foo"); +// +// Or: +// const static char szFoo[] = "Foo"; +// const static STRING sFoo = RTL_CONSTANT_STRING(szFoo); +// +// This will compile without error or warning in C++. C will get a warning. +// +#ifdef __cplusplus +extern "C++" +{ +template char _RTL_CONSTANT_STRING_type_check(const char (&s)[N]); +template char _RTL_CONSTANT_STRING_type_check(const WCHAR (&s)[N]); +// __typeof would be desirable here instead of sizeof. +template class _RTL_CONSTANT_STRING_remove_const_template_class; +template <> class _RTL_CONSTANT_STRING_remove_const_template_class {public: typedef char T; }; +template <> class _RTL_CONSTANT_STRING_remove_const_template_class {public: typedef WCHAR T; }; +#define _RTL_CONSTANT_STRING_remove_const_macro(s) \ + (const_cast<_RTL_CONSTANT_STRING_remove_const_template_class::T*>(s)) +} +#else +char _RTL_CONSTANT_STRING_type_check(const void *s); +#define _RTL_CONSTANT_STRING_remove_const_macro(s) (s) +#endif +#define RTL_CONSTANT_STRING(s) \ +{ \ + sizeof( s ) - sizeof( (s)[0] ), \ + sizeof( s ) / sizeof(_RTL_CONSTANT_STRING_type_check(s)), \ + _RTL_CONSTANT_STRING_remove_const_macro(s) \ +} +// begin_winnt + +// like sizeof +// usually this would be * CHAR_BIT, but we don't necessarily have #include +#define RTL_BITS_OF(sizeOfArg) (sizeof(sizeOfArg) * 8) + +#define RTL_BITS_OF_FIELD(type, field) (RTL_BITS_OF(RTL_FIELD_TYPE(type, field))) + +// begin_ntoshvp + +// +// Calculate the address of the base of the structure given its type, and an +// address of a field within the structure. +// + +#define CONTAINING_RECORD(address, type, field) ((type *)( \ + (PCHAR)(address) - \ + (ULONG_PTR)(&((type *)0)->field))) + +// end_ntoshvp +// end_ntminiport end_ntndis + +// +// Exception handler routine definition. +// + +#include + +typedef +_IRQL_requires_same_ +_Function_class_(EXCEPTION_ROUTINE) +EXCEPTION_DISPOSITION +NTAPI +EXCEPTION_ROUTINE ( + _Inout_ struct _EXCEPTION_RECORD *ExceptionRecord, + _In_ PVOID EstablisherFrame, + _Inout_ struct _CONTEXT *ContextRecord, + _In_ PVOID DispatcherContext + ); + +typedef EXCEPTION_ROUTINE *PEXCEPTION_ROUTINE; + +// end_winnt +// begin_ntminiport begin_ntndis +// begin_wudfwdm +// begin_ntoshvp + +// +// Interrupt Request Level (IRQL) +// + +typedef UCHAR KIRQL; + +typedef KIRQL *PKIRQL; + +// end_ntoshvp +// end_wudfwdm +// end_ntminiport end_ntndis + +// begin_winnt + +// +// Enclave ID definitions +// + +#define ENCLAVE_SHORT_ID_LENGTH 16 +#define ENCLAVE_LONG_ID_LENGTH 32 + +// end_winnt + +// +// Product types +// + +typedef enum _NT_PRODUCT_TYPE { + NtProductWinNt = 1, + NtProductLanManNt, + NtProductServer +} NT_PRODUCT_TYPE, *PNT_PRODUCT_TYPE; + + +// +// the bit mask, SharedUserData->SuiteMask, is a ULONG +// so there can be a maximum of 32 entries +// in this enum. +// + +typedef _Enum_is_bitflag_ enum _SUITE_TYPE { + SmallBusiness, + Enterprise, + BackOffice, + CommunicationServer, + TerminalServer, + SmallBusinessRestricted, + EmbeddedNT, + DataCenter, + SingleUserTS, + Personal, + Blade, + EmbeddedRestricted, + SecurityAppliance, + StorageServer, + ComputeServer, + WHServer, + PhoneNT, + MultiUserTS, + MaxSuiteType +} SUITE_TYPE; + +// begin_winnt + +#define VER_SERVER_NT 0x80000000 +#define VER_WORKSTATION_NT 0x40000000 +#define VER_SUITE_SMALLBUSINESS 0x00000001 +#define VER_SUITE_ENTERPRISE 0x00000002 +#define VER_SUITE_BACKOFFICE 0x00000004 +#define VER_SUITE_COMMUNICATIONS 0x00000008 +#define VER_SUITE_TERMINAL 0x00000010 +#define VER_SUITE_SMALLBUSINESS_RESTRICTED 0x00000020 +#define VER_SUITE_EMBEDDEDNT 0x00000040 +#define VER_SUITE_DATACENTER 0x00000080 +#define VER_SUITE_SINGLEUSERTS 0x00000100 +#define VER_SUITE_PERSONAL 0x00000200 +#define VER_SUITE_BLADE 0x00000400 +#define VER_SUITE_EMBEDDED_RESTRICTED 0x00000800 +#define VER_SUITE_SECURITY_APPLIANCE 0x00001000 +#define VER_SUITE_STORAGE_SERVER 0x00002000 +#define VER_SUITE_COMPUTE_SERVER 0x00004000 +#define VER_SUITE_WH_SERVER 0x00008000 +#define VER_SUITE_MULTIUSERTS 0x00020000 + +// end_winnt + +// begin_winnt + +// +// Product types +// This list grows with each OS release. +// +// There is no ordering of values to ensure callers +// do an equality test i.e. greater-than and less-than +// comparisons are not useful. +// +// NOTE: Values in this list should never be deleted. +// When a product-type 'X' gets dropped from a +// OS release onwards, the value of 'X' continues +// to be used in the mapping table of GetProductInfo. +// + +#define PRODUCT_UNDEFINED 0x00000000 + +#define PRODUCT_ULTIMATE 0x00000001 +#define PRODUCT_HOME_BASIC 0x00000002 +#define PRODUCT_HOME_PREMIUM 0x00000003 +#define PRODUCT_ENTERPRISE 0x00000004 +#define PRODUCT_HOME_BASIC_N 0x00000005 +#define PRODUCT_BUSINESS 0x00000006 +#define PRODUCT_STANDARD_SERVER 0x00000007 +#define PRODUCT_DATACENTER_SERVER 0x00000008 +#define PRODUCT_SMALLBUSINESS_SERVER 0x00000009 +#define PRODUCT_ENTERPRISE_SERVER 0x0000000A +#define PRODUCT_STARTER 0x0000000B +#define PRODUCT_DATACENTER_SERVER_CORE 0x0000000C +#define PRODUCT_STANDARD_SERVER_CORE 0x0000000D +#define PRODUCT_ENTERPRISE_SERVER_CORE 0x0000000E +#define PRODUCT_ENTERPRISE_SERVER_IA64 0x0000000F +#define PRODUCT_BUSINESS_N 0x00000010 +#define PRODUCT_WEB_SERVER 0x00000011 +#define PRODUCT_CLUSTER_SERVER 0x00000012 +#define PRODUCT_HOME_SERVER 0x00000013 +#define PRODUCT_STORAGE_EXPRESS_SERVER 0x00000014 +#define PRODUCT_STORAGE_STANDARD_SERVER 0x00000015 +#define PRODUCT_STORAGE_WORKGROUP_SERVER 0x00000016 +#define PRODUCT_STORAGE_ENTERPRISE_SERVER 0x00000017 +#define PRODUCT_SERVER_FOR_SMALLBUSINESS 0x00000018 +#define PRODUCT_SMALLBUSINESS_SERVER_PREMIUM 0x00000019 +#define PRODUCT_HOME_PREMIUM_N 0x0000001A +#define PRODUCT_ENTERPRISE_N 0x0000001B +#define PRODUCT_ULTIMATE_N 0x0000001C +#define PRODUCT_WEB_SERVER_CORE 0x0000001D +#define PRODUCT_MEDIUMBUSINESS_SERVER_MANAGEMENT 0x0000001E +#define PRODUCT_MEDIUMBUSINESS_SERVER_SECURITY 0x0000001F +#define PRODUCT_MEDIUMBUSINESS_SERVER_MESSAGING 0x00000020 +#define PRODUCT_SERVER_FOUNDATION 0x00000021 +#define PRODUCT_HOME_PREMIUM_SERVER 0x00000022 +#define PRODUCT_SERVER_FOR_SMALLBUSINESS_V 0x00000023 +#define PRODUCT_STANDARD_SERVER_V 0x00000024 +#define PRODUCT_DATACENTER_SERVER_V 0x00000025 +#define PRODUCT_ENTERPRISE_SERVER_V 0x00000026 +#define PRODUCT_DATACENTER_SERVER_CORE_V 0x00000027 +#define PRODUCT_STANDARD_SERVER_CORE_V 0x00000028 +#define PRODUCT_ENTERPRISE_SERVER_CORE_V 0x00000029 +#define PRODUCT_HYPERV 0x0000002A +#define PRODUCT_STORAGE_EXPRESS_SERVER_CORE 0x0000002B +#define PRODUCT_STORAGE_STANDARD_SERVER_CORE 0x0000002C +#define PRODUCT_STORAGE_WORKGROUP_SERVER_CORE 0x0000002D +#define PRODUCT_STORAGE_ENTERPRISE_SERVER_CORE 0x0000002E +#define PRODUCT_STARTER_N 0x0000002F +#define PRODUCT_PROFESSIONAL 0x00000030 +#define PRODUCT_PROFESSIONAL_N 0x00000031 +#define PRODUCT_SB_SOLUTION_SERVER 0x00000032 +#define PRODUCT_SERVER_FOR_SB_SOLUTIONS 0x00000033 +#define PRODUCT_STANDARD_SERVER_SOLUTIONS 0x00000034 +#define PRODUCT_STANDARD_SERVER_SOLUTIONS_CORE 0x00000035 +#define PRODUCT_SB_SOLUTION_SERVER_EM 0x00000036 +#define PRODUCT_SERVER_FOR_SB_SOLUTIONS_EM 0x00000037 +#define PRODUCT_SOLUTION_EMBEDDEDSERVER 0x00000038 +#define PRODUCT_SOLUTION_EMBEDDEDSERVER_CORE 0x00000039 +#define PRODUCT_PROFESSIONAL_EMBEDDED 0x0000003A +#define PRODUCT_ESSENTIALBUSINESS_SERVER_MGMT 0x0000003B +#define PRODUCT_ESSENTIALBUSINESS_SERVER_ADDL 0x0000003C +#define PRODUCT_ESSENTIALBUSINESS_SERVER_MGMTSVC 0x0000003D +#define PRODUCT_ESSENTIALBUSINESS_SERVER_ADDLSVC 0x0000003E +#define PRODUCT_SMALLBUSINESS_SERVER_PREMIUM_CORE 0x0000003F +#define PRODUCT_CLUSTER_SERVER_V 0x00000040 +#define PRODUCT_EMBEDDED 0x00000041 +#define PRODUCT_STARTER_E 0x00000042 +#define PRODUCT_HOME_BASIC_E 0x00000043 +#define PRODUCT_HOME_PREMIUM_E 0x00000044 +#define PRODUCT_PROFESSIONAL_E 0x00000045 +#define PRODUCT_ENTERPRISE_E 0x00000046 +#define PRODUCT_ULTIMATE_E 0x00000047 +#define PRODUCT_ENTERPRISE_EVALUATION 0x00000048 +#define PRODUCT_MULTIPOINT_STANDARD_SERVER 0x0000004C +#define PRODUCT_MULTIPOINT_PREMIUM_SERVER 0x0000004D +#define PRODUCT_STANDARD_EVALUATION_SERVER 0x0000004F +#define PRODUCT_DATACENTER_EVALUATION_SERVER 0x00000050 +#define PRODUCT_ENTERPRISE_N_EVALUATION 0x00000054 +#define PRODUCT_EMBEDDED_AUTOMOTIVE 0x00000055 +#define PRODUCT_EMBEDDED_INDUSTRY_A 0x00000056 +#define PRODUCT_THINPC 0x00000057 +#define PRODUCT_EMBEDDED_A 0x00000058 +#define PRODUCT_EMBEDDED_INDUSTRY 0x00000059 +#define PRODUCT_EMBEDDED_E 0x0000005A +#define PRODUCT_EMBEDDED_INDUSTRY_E 0x0000005B +#define PRODUCT_EMBEDDED_INDUSTRY_A_E 0x0000005C +#define PRODUCT_STORAGE_WORKGROUP_EVALUATION_SERVER 0x0000005F +#define PRODUCT_STORAGE_STANDARD_EVALUATION_SERVER 0x00000060 +#define PRODUCT_CORE_ARM 0x00000061 +#define PRODUCT_CORE_N 0x00000062 +#define PRODUCT_CORE_COUNTRYSPECIFIC 0x00000063 +#define PRODUCT_CORE_SINGLELANGUAGE 0x00000064 +#define PRODUCT_CORE 0x00000065 +#define PRODUCT_PROFESSIONAL_WMC 0x00000067 +#define PRODUCT_EMBEDDED_INDUSTRY_EVAL 0x00000069 +#define PRODUCT_EMBEDDED_INDUSTRY_E_EVAL 0x0000006A +#define PRODUCT_EMBEDDED_EVAL 0x0000006B +#define PRODUCT_EMBEDDED_E_EVAL 0x0000006C +#define PRODUCT_NANO_SERVER 0x0000006D +#define PRODUCT_CLOUD_STORAGE_SERVER 0x0000006E +#define PRODUCT_CORE_CONNECTED 0x0000006F +#define PRODUCT_PROFESSIONAL_STUDENT 0x00000070 +#define PRODUCT_CORE_CONNECTED_N 0x00000071 +#define PRODUCT_PROFESSIONAL_STUDENT_N 0x00000072 +#define PRODUCT_CORE_CONNECTED_SINGLELANGUAGE 0x00000073 +#define PRODUCT_CORE_CONNECTED_COUNTRYSPECIFIC 0x00000074 +#define PRODUCT_CONNECTED_CAR 0x00000075 +#define PRODUCT_INDUSTRY_HANDHELD 0x00000076 +#define PRODUCT_PPI_PRO 0x00000077 +#define PRODUCT_ARM64_SERVER 0x00000078 +#define PRODUCT_EDUCATION 0x00000079 +#define PRODUCT_EDUCATION_N 0x0000007A +#define PRODUCT_IOTUAP 0x0000007B +#define PRODUCT_CLOUD_HOST_INFRASTRUCTURE_SERVER 0x0000007C +#define PRODUCT_ENTERPRISE_S 0x0000007D +#define PRODUCT_ENTERPRISE_S_N 0x0000007E +#define PRODUCT_PROFESSIONAL_S 0x0000007F +#define PRODUCT_PROFESSIONAL_S_N 0x00000080 +#define PRODUCT_ENTERPRISE_S_EVALUATION 0x00000081 +#define PRODUCT_ENTERPRISE_S_N_EVALUATION 0x00000082 +#define PRODUCT_HOLOGRAPHIC 0x00000087 +#define PRODUCT_HOLOGRAPHIC_BUSINESS 0x00000088 +#define PRODUCT_PRO_SINGLE_LANGUAGE 0x0000008A +#define PRODUCT_PRO_CHINA 0x0000008B +#define PRODUCT_ENTERPRISE_SUBSCRIPTION 0x0000008C +#define PRODUCT_ENTERPRISE_SUBSCRIPTION_N 0x0000008D +#define PRODUCT_DATACENTER_NANO_SERVER 0x0000008F +#define PRODUCT_STANDARD_NANO_SERVER 0x00000090 +#define PRODUCT_DATACENTER_A_SERVER_CORE 0x00000091 +#define PRODUCT_STANDARD_A_SERVER_CORE 0x00000092 +#define PRODUCT_DATACENTER_WS_SERVER_CORE 0x00000093 +#define PRODUCT_STANDARD_WS_SERVER_CORE 0x00000094 +#define PRODUCT_UTILITY_VM 0x00000095 +#define PRODUCT_DATACENTER_EVALUATION_SERVER_CORE 0x0000009F +#define PRODUCT_STANDARD_EVALUATION_SERVER_CORE 0x000000A0 +#define PRODUCT_PRO_WORKSTATION 0x000000A1 +#define PRODUCT_PRO_WORKSTATION_N 0x000000A2 +#define PRODUCT_PRO_FOR_EDUCATION 0x000000A4 +#define PRODUCT_PRO_FOR_EDUCATION_N 0x000000A5 +#define PRODUCT_AZURE_SERVER_CORE 0x000000A8 +#define PRODUCT_AZURE_NANO_SERVER 0x000000A9 +#define PRODUCT_ENTERPRISEG 0x000000AB +#define PRODUCT_ENTERPRISEGN 0x000000AC +#define PRODUCT_SERVERRDSH 0x000000AF +#define PRODUCT_CLOUD 0x000000B2 +#define PRODUCT_CLOUDN 0x000000B3 +#define PRODUCT_HUBOS 0x000000B4 +#define PRODUCT_ONECOREUPDATEOS 0x000000B6 +#define PRODUCT_CLOUDE 0x000000B7 +#define PRODUCT_IOTOS 0x000000B9 +#define PRODUCT_CLOUDEN 0x000000BA +#define PRODUCT_IOTEDGEOS 0x000000BB +#define PRODUCT_IOTENTERPRISE 0x000000BC +#define PRODUCT_LITE 0x000000BD +#define PRODUCT_IOTENTERPRISES 0x000000BF +#define PRODUCT_XBOX_SYSTEMOS 0x000000C0 +#define PRODUCT_XBOX_GAMEOS 0x000000C2 +#define PRODUCT_XBOX_ERAOS 0x000000C3 +#define PRODUCT_XBOX_DURANGOHOSTOS 0x000000C4 +#define PRODUCT_XBOX_SCARLETTHOSTOS 0x000000C5 +#define PRODUCT_XBOX_KEYSTONE 0x000000C6 +#define PRODUCT_AZURE_SERVER_CLOUDHOST 0x000000C7 +#define PRODUCT_AZURE_SERVER_CLOUDMOS 0x000000C8 +#define PRODUCT_CLOUDEDITIONN 0x000000CA +#define PRODUCT_CLOUDEDITION 0x000000CB +#define PRODUCT_VALIDATION 0x000000CC +#define PRODUCT_IOTENTERPRISESK 0x000000CD +#define PRODUCT_IOTENTERPRISEK 0x000000CE +#define PRODUCT_IOTENTERPRISESEVAL 0x000000CF +#define PRODUCT_AZURE_SERVER_AGENTBRIDGE 0x000000D0 +#define PRODUCT_AZURE_SERVER_NANOHOST 0x000000D1 +#define PRODUCT_WNC 0x000000D2 +#define PRODUCT_AZURESTACKHCI_SERVER_CORE 0x00000196 +#define PRODUCT_DATACENTER_SERVER_AZURE_EDITION 0x00000197 +#define PRODUCT_DATACENTER_SERVER_CORE_AZURE_EDITION 0x00000198 +#define PRODUCT_DATACENTER_WS_SERVER_CORE_AZURE_EDITION 0x00000199 + +#define PRODUCT_UNLICENSED 0xABCDABCD + +// end_winnt + +// begin_ntminiport begin_winnt begin_ntminitape +#include +// end_ntminiport end_winnt end_ntminitape + +// begin_winnt begin_r_winnt + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// DEPRECATED: The Language ID concept is deprecated, please use +// Locale Names instead, eg: "en" instead of a LANGID like 0x09. +// See the documentation for GetLocaleInfoEx. +// +// Note that the named locale APIs (eg GetLocaleInfoEx) are preferred. +// +// WARNING: Not all locales/languages have unique Language IDs +// +// The following two combinations of primary language ID and +// sublanguage ID have special semantics: +// +// Primary Language ID Sublanguage ID Result +// ------------------- --------------- ------------------------ +// LANG_NEUTRAL SUBLANG_NEUTRAL Language neutral +// LANG_NEUTRAL SUBLANG_DEFAULT User default language +// LANG_NEUTRAL SUBLANG_SYS_DEFAULT System default language +// LANG_INVARIANT SUBLANG_NEUTRAL Invariant locale +// +// This concept is deprecated. It is strongly recommended that +// applications test for locale names instead of Language IDs / LCIDs. +// +// Primary language IDs. +// +// WARNING: This pattern is broken and not followed for all languages. +// Serbian, Bosnian & Croatian are a few examples. +// +// WARNING: There are > 6000 human languages. The PRIMARYLANGID construct +// cannot support all languages your application may encounter. +// Please use Language Names, such as "en". +// +// WARNING: Some languages may have more than one PRIMARYLANGID. Please +// use Locale Names, such as "en-FJ". +// +// WARNING: Some languages do not have assigned LANGIDs. Please use +// Locale Names, such as "tlh-Piqd". +// +// It is recommended that applications test for locale names or actual LCIDs. +// +// Note that the LANG, SUBLANG construction is not always consistent. +// The named locale APIs (eg GetLocaleInfoEx) are recommended. +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +#define LANG_NEUTRAL 0x00 +#define LANG_INVARIANT 0x7f + +#define LANG_AFRIKAANS 0x36 +#define LANG_ALBANIAN 0x1c +#define LANG_ALSATIAN 0x84 +#define LANG_AMHARIC 0x5e +#define LANG_ARABIC 0x01 +#define LANG_ARMENIAN 0x2b +#define LANG_ASSAMESE 0x4d +#define LANG_AZERI 0x2c // for Azerbaijani, LANG_AZERBAIJANI is preferred +#define LANG_AZERBAIJANI 0x2c +#define LANG_BANGLA 0x45 +#define LANG_BASHKIR 0x6d +#define LANG_BASQUE 0x2d +#define LANG_BELARUSIAN 0x23 +#define LANG_BENGALI 0x45 // Some prefer to use LANG_BANGLA +#define LANG_BRETON 0x7e +#define LANG_BOSNIAN 0x1a // Use with SUBLANG_BOSNIAN_* Sublanguage IDs +#define LANG_BOSNIAN_NEUTRAL 0x781a // Use with the ConvertDefaultLocale function +#define LANG_BULGARIAN 0x02 +#define LANG_CATALAN 0x03 +#define LANG_CENTRAL_KURDISH 0x92 +#define LANG_CHEROKEE 0x5c +#define LANG_CHINESE 0x04 // Use with SUBLANG_CHINESE_* Sublanguage IDs +#define LANG_CHINESE_SIMPLIFIED 0x04 // Use with the ConvertDefaultLocale function +#define LANG_CHINESE_TRADITIONAL 0x7c04 // Use with the ConvertDefaultLocale function +#define LANG_CORSICAN 0x83 +#define LANG_CROATIAN 0x1a +#define LANG_CZECH 0x05 +#define LANG_DANISH 0x06 +#define LANG_DARI 0x8c +#define LANG_DIVEHI 0x65 +#define LANG_DUTCH 0x13 +#define LANG_ENGLISH 0x09 +#define LANG_ESTONIAN 0x25 +#define LANG_FAEROESE 0x38 +#define LANG_FARSI 0x29 // Deprecated: use LANG_PERSIAN instead +#define LANG_FILIPINO 0x64 +#define LANG_FINNISH 0x0b +#define LANG_FRENCH 0x0c +#define LANG_FRISIAN 0x62 +#define LANG_FULAH 0x67 +#define LANG_GALICIAN 0x56 +#define LANG_GEORGIAN 0x37 +#define LANG_GERMAN 0x07 +#define LANG_GREEK 0x08 +#define LANG_GREENLANDIC 0x6f +#define LANG_GUJARATI 0x47 +#define LANG_HAUSA 0x68 +#define LANG_HAWAIIAN 0x75 +#define LANG_HEBREW 0x0d +#define LANG_HINDI 0x39 +#define LANG_HUNGARIAN 0x0e +#define LANG_ICELANDIC 0x0f +#define LANG_IGBO 0x70 +#define LANG_INDONESIAN 0x21 +#define LANG_INUKTITUT 0x5d +#define LANG_IRISH 0x3c // Use with the SUBLANG_IRISH_IRELAND Sublanguage ID +#define LANG_ITALIAN 0x10 +#define LANG_JAPANESE 0x11 +#define LANG_KANNADA 0x4b +#define LANG_KASHMIRI 0x60 +#define LANG_KAZAK 0x3f +#define LANG_KHMER 0x53 +#define LANG_KICHE 0x86 +#define LANG_KINYARWANDA 0x87 +#define LANG_KONKANI 0x57 +#define LANG_KOREAN 0x12 +#define LANG_KYRGYZ 0x40 +#define LANG_LAO 0x54 +#define LANG_LATVIAN 0x26 +#define LANG_LITHUANIAN 0x27 +#define LANG_LOWER_SORBIAN 0x2e +#define LANG_LUXEMBOURGISH 0x6e +#define LANG_MACEDONIAN 0x2f // the Former Yugoslav Republic of Macedonia +#define LANG_MALAY 0x3e +#define LANG_MALAYALAM 0x4c +#define LANG_MALTESE 0x3a +#define LANG_MANIPURI 0x58 +#define LANG_MAORI 0x81 +#define LANG_MAPUDUNGUN 0x7a +#define LANG_MARATHI 0x4e +#define LANG_MOHAWK 0x7c +#define LANG_MONGOLIAN 0x50 +#define LANG_NEPALI 0x61 +#define LANG_NORWEGIAN 0x14 +#define LANG_OCCITAN 0x82 +#define LANG_ODIA 0x48 +#define LANG_ORIYA 0x48 // Deprecated: use LANG_ODIA, instead. +#define LANG_PASHTO 0x63 +#define LANG_PERSIAN 0x29 +#define LANG_POLISH 0x15 +#define LANG_PORTUGUESE 0x16 +#define LANG_PULAR 0x67 // Deprecated: use LANG_FULAH instead +#define LANG_PUNJABI 0x46 +#define LANG_QUECHUA 0x6b +#define LANG_ROMANIAN 0x18 +#define LANG_ROMANSH 0x17 +#define LANG_RUSSIAN 0x19 +#define LANG_SAKHA 0x85 +#define LANG_SAMI 0x3b +#define LANG_SANSKRIT 0x4f +#define LANG_SCOTTISH_GAELIC 0x91 +#define LANG_SERBIAN 0x1a // Use with the SUBLANG_SERBIAN_* Sublanguage IDs +#define LANG_SERBIAN_NEUTRAL 0x7c1a // Use with the ConvertDefaultLocale function +#define LANG_SINDHI 0x59 +#define LANG_SINHALESE 0x5b +#define LANG_SLOVAK 0x1b +#define LANG_SLOVENIAN 0x24 +#define LANG_SOTHO 0x6c +#define LANG_SPANISH 0x0a +#define LANG_SWAHILI 0x41 +#define LANG_SWEDISH 0x1d +#define LANG_SYRIAC 0x5a +#define LANG_TAJIK 0x28 +#define LANG_TAMAZIGHT 0x5f +#define LANG_TAMIL 0x49 +#define LANG_TATAR 0x44 +#define LANG_TELUGU 0x4a +#define LANG_THAI 0x1e +#define LANG_TIBETAN 0x51 +#define LANG_TIGRIGNA 0x73 +#define LANG_TIGRINYA 0x73 // Preferred spelling in locale +#define LANG_TSWANA 0x32 +#define LANG_TURKISH 0x1f +#define LANG_TURKMEN 0x42 +#define LANG_UIGHUR 0x80 +#define LANG_UKRAINIAN 0x22 +#define LANG_UPPER_SORBIAN 0x2e +#define LANG_URDU 0x20 +#define LANG_UZBEK 0x43 +#define LANG_VALENCIAN 0x03 +#define LANG_VIETNAMESE 0x2a +#define LANG_WELSH 0x52 +#define LANG_WOLOF 0x88 +#define LANG_XHOSA 0x34 +#define LANG_YAKUT 0x85 // Deprecated: use LANG_SAKHA,instead +#define LANG_YI 0x78 +#define LANG_YORUBA 0x6a +#define LANG_ZULU 0x35 + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// DEPRECATED: The Sublanguage ID concept is deprecated, please use +// Locale Names instead, eg: "en-US" instead of an LCID like 0x0409. +// See the documentation for GetLocaleInfoEx. +// +// The name immediately following SUBLANG_ dictates which primary +// language ID that sublanguage ID can be combined with to form a +// valid language ID. +// +// Note that the LANG, SUBLANG construction is not always consistent. +// The named locale APIs (eg GetLocaleInfoEx) are recommended. +// +// WARNING: The pattern is broken and not followed for all languages. +// Serbian, Bosnian & Croatian are a few examples. +// +// WARNING: The "SUBLANG" depends on the primary language and is inconsistent. +// SUBLANG_ENGLISH_US is 0x1 and SUBLANG_SPANISH_US is 0x15, so +// it is impossible to determine region merely by inspecting the +// SUBLANG. Please use Locale Names such as "en-US" instead. +// +// WARNING: Numerous SUBLANGS are assigned the same value, so 0x01 could be +// US, French, or many other variations. Please use Locale Names +// such as "en-US" instead. If that is not possible, consider +// testing the entire LCID, eg: 0x0409. +// +// WARNING: There are > 6000 human languages. The PRIMARYLANGID construct +// cannot support all languages your application may encounter. +// Please use Language Names, such as "en". +// +// WARNING: There are > 200 country-regions. The SUBLANGID construct cannot +// represent all valid dialects of languages such as English. +// Please use Locale Names, such as "en-US". +// +// WARNING: Some languages may have more than one PRIMARYLANGID. Please +// use Locale Names, such as "en-FJ". +// +// WARNING: Some languages do not have assigned LANGIDs. Please use +// Locale Names, such as "tlh-Piqd". +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +#define SUBLANG_NEUTRAL 0x00 // language neutral +#define SUBLANG_DEFAULT 0x01 // user default +#define SUBLANG_SYS_DEFAULT 0x02 // system default +#define SUBLANG_CUSTOM_DEFAULT 0x03 // default custom language/locale +#define SUBLANG_CUSTOM_UNSPECIFIED 0x04 // custom language/locale +#define SUBLANG_UI_CUSTOM_DEFAULT 0x05 // Default custom MUI language/locale + + +#define SUBLANG_AFRIKAANS_SOUTH_AFRICA 0x01 // Afrikaans (South Africa) 0x0436 af-ZA +#define SUBLANG_ALBANIAN_ALBANIA 0x01 // Albanian (Albania) 0x041c sq-AL +#define SUBLANG_ALSATIAN_FRANCE 0x01 // Alsatian (France) 0x0484 +#define SUBLANG_AMHARIC_ETHIOPIA 0x01 // Amharic (Ethiopia) 0x045e +#define SUBLANG_ARABIC_SAUDI_ARABIA 0x01 // Arabic (Saudi Arabia) +#define SUBLANG_ARABIC_IRAQ 0x02 // Arabic (Iraq) +#define SUBLANG_ARABIC_EGYPT 0x03 // Arabic (Egypt) +#define SUBLANG_ARABIC_LIBYA 0x04 // Arabic (Libya) +#define SUBLANG_ARABIC_ALGERIA 0x05 // Arabic (Algeria) +#define SUBLANG_ARABIC_MOROCCO 0x06 // Arabic (Morocco) +#define SUBLANG_ARABIC_TUNISIA 0x07 // Arabic (Tunisia) +#define SUBLANG_ARABIC_OMAN 0x08 // Arabic (Oman) +#define SUBLANG_ARABIC_YEMEN 0x09 // Arabic (Yemen) +#define SUBLANG_ARABIC_SYRIA 0x0a // Arabic (Syria) +#define SUBLANG_ARABIC_JORDAN 0x0b // Arabic (Jordan) +#define SUBLANG_ARABIC_LEBANON 0x0c // Arabic (Lebanon) +#define SUBLANG_ARABIC_KUWAIT 0x0d // Arabic (Kuwait) +#define SUBLANG_ARABIC_UAE 0x0e // Arabic (U.A.E) +#define SUBLANG_ARABIC_BAHRAIN 0x0f // Arabic (Bahrain) +#define SUBLANG_ARABIC_QATAR 0x10 // Arabic (Qatar) +#define SUBLANG_ARMENIAN_ARMENIA 0x01 // Armenian (Armenia) 0x042b hy-AM +#define SUBLANG_ASSAMESE_INDIA 0x01 // Assamese (India) 0x044d +#define SUBLANG_AZERI_LATIN 0x01 // Azeri (Latin) - for Azerbaijani, SUBLANG_AZERBAIJANI_AZERBAIJAN_LATIN preferred +#define SUBLANG_AZERI_CYRILLIC 0x02 // Azeri (Cyrillic) - for Azerbaijani, SUBLANG_AZERBAIJANI_AZERBAIJAN_CYRILLIC preferred +#define SUBLANG_AZERBAIJANI_AZERBAIJAN_LATIN 0x01 // Azerbaijani (Azerbaijan, Latin) +#define SUBLANG_AZERBAIJANI_AZERBAIJAN_CYRILLIC 0x02 // Azerbaijani (Azerbaijan, Cyrillic) +#define SUBLANG_BANGLA_INDIA 0x01 // Bangla (India) +#define SUBLANG_BANGLA_BANGLADESH 0x02 // Bangla (Bangladesh) +#define SUBLANG_BASHKIR_RUSSIA 0x01 // Bashkir (Russia) 0x046d ba-RU +#define SUBLANG_BASQUE_BASQUE 0x01 // Basque (Basque) 0x042d eu-ES +#define SUBLANG_BELARUSIAN_BELARUS 0x01 // Belarusian (Belarus) 0x0423 be-BY +#define SUBLANG_BENGALI_INDIA 0x01 // Bengali (India) - Note some prefer SUBLANG_BANGLA_INDIA +#define SUBLANG_BENGALI_BANGLADESH 0x02 // Bengali (Bangladesh) - Note some prefer SUBLANG_BANGLA_BANGLADESH +#define SUBLANG_BOSNIAN_BOSNIA_HERZEGOVINA_LATIN 0x05 // Bosnian (Bosnia and Herzegovina - Latin) 0x141a bs-BA-Latn +#define SUBLANG_BOSNIAN_BOSNIA_HERZEGOVINA_CYRILLIC 0x08 // Bosnian (Bosnia and Herzegovina - Cyrillic) 0x201a bs-BA-Cyrl +#define SUBLANG_BRETON_FRANCE 0x01 // Breton (France) 0x047e +#define SUBLANG_BULGARIAN_BULGARIA 0x01 // Bulgarian (Bulgaria) 0x0402 +#define SUBLANG_CATALAN_CATALAN 0x01 // Catalan (Catalan) 0x0403 +#define SUBLANG_CENTRAL_KURDISH_IRAQ 0x01 // Central Kurdish (Iraq) 0x0492 ku-Arab-IQ +#define SUBLANG_CHEROKEE_CHEROKEE 0x01 // Cherokee (Cherokee) 0x045c chr-Cher-US +#define SUBLANG_CHINESE_TRADITIONAL 0x01 // Chinese (Taiwan) 0x0404 zh-TW +#define SUBLANG_CHINESE_SIMPLIFIED 0x02 // Chinese (PR China) 0x0804 zh-CN +#define SUBLANG_CHINESE_HONGKONG 0x03 // Chinese (Hong Kong S.A.R., P.R.C.) 0x0c04 zh-HK +#define SUBLANG_CHINESE_SINGAPORE 0x04 // Chinese (Singapore) 0x1004 zh-SG +#define SUBLANG_CHINESE_MACAU 0x05 // Chinese (Macau S.A.R.) 0x1404 zh-MO +#define SUBLANG_CORSICAN_FRANCE 0x01 // Corsican (France) 0x0483 +#define SUBLANG_CZECH_CZECH_REPUBLIC 0x01 // Czech (Czech Republic) 0x0405 +#define SUBLANG_CROATIAN_CROATIA 0x01 // Croatian (Croatia) +#define SUBLANG_CROATIAN_BOSNIA_HERZEGOVINA_LATIN 0x04 // Croatian (Bosnia and Herzegovina - Latin) 0x101a hr-BA +#define SUBLANG_DANISH_DENMARK 0x01 // Danish (Denmark) 0x0406 +#define SUBLANG_DARI_AFGHANISTAN 0x01 // Dari (Afghanistan) +#define SUBLANG_DIVEHI_MALDIVES 0x01 // Divehi (Maldives) 0x0465 div-MV +#define SUBLANG_DUTCH 0x01 // Dutch +#define SUBLANG_DUTCH_BELGIAN 0x02 // Dutch (Belgian) +#define SUBLANG_ENGLISH_US 0x01 // English (USA) +#define SUBLANG_ENGLISH_UK 0x02 // English (UK) +#define SUBLANG_ENGLISH_AUS 0x03 // English (Australian) +#define SUBLANG_ENGLISH_CAN 0x04 // English (Canadian) +#define SUBLANG_ENGLISH_NZ 0x05 // English (New Zealand) +#define SUBLANG_ENGLISH_EIRE 0x06 // English (Irish) +#define SUBLANG_ENGLISH_SOUTH_AFRICA 0x07 // English (South Africa) +#define SUBLANG_ENGLISH_JAMAICA 0x08 // English (Jamaica) +#define SUBLANG_ENGLISH_CARIBBEAN 0x09 // English (Caribbean) +#define SUBLANG_ENGLISH_BELIZE 0x0a // English (Belize) +#define SUBLANG_ENGLISH_TRINIDAD 0x0b // English (Trinidad) +#define SUBLANG_ENGLISH_ZIMBABWE 0x0c // English (Zimbabwe) +#define SUBLANG_ENGLISH_PHILIPPINES 0x0d // English (Philippines) +#define SUBLANG_ENGLISH_INDIA 0x10 // English (India) +#define SUBLANG_ENGLISH_MALAYSIA 0x11 // English (Malaysia) +#define SUBLANG_ENGLISH_SINGAPORE 0x12 // English (Singapore) +#define SUBLANG_ESTONIAN_ESTONIA 0x01 // Estonian (Estonia) 0x0425 et-EE +#define SUBLANG_FAEROESE_FAROE_ISLANDS 0x01 // Faroese (Faroe Islands) 0x0438 fo-FO +#define SUBLANG_FILIPINO_PHILIPPINES 0x01 // Filipino (Philippines) 0x0464 fil-PH +#define SUBLANG_FINNISH_FINLAND 0x01 // Finnish (Finland) 0x040b +#define SUBLANG_FRENCH 0x01 // French +#define SUBLANG_FRENCH_BELGIAN 0x02 // French (Belgian) +#define SUBLANG_FRENCH_CANADIAN 0x03 // French (Canadian) +#define SUBLANG_FRENCH_SWISS 0x04 // French (Swiss) +#define SUBLANG_FRENCH_LUXEMBOURG 0x05 // French (Luxembourg) +#define SUBLANG_FRENCH_MONACO 0x06 // French (Monaco) +#define SUBLANG_FRISIAN_NETHERLANDS 0x01 // Frisian (Netherlands) 0x0462 fy-NL +#define SUBLANG_FULAH_SENEGAL 0x02 // Fulah (Senegal) 0x0867 ff-Latn-SN +#define SUBLANG_GALICIAN_GALICIAN 0x01 // Galician (Galician) 0x0456 gl-ES +#define SUBLANG_GEORGIAN_GEORGIA 0x01 // Georgian (Georgia) 0x0437 ka-GE +#define SUBLANG_GERMAN 0x01 // German +#define SUBLANG_GERMAN_SWISS 0x02 // German (Swiss) +#define SUBLANG_GERMAN_AUSTRIAN 0x03 // German (Austrian) +#define SUBLANG_GERMAN_LUXEMBOURG 0x04 // German (Luxembourg) +#define SUBLANG_GERMAN_LIECHTENSTEIN 0x05 // German (Liechtenstein) +#define SUBLANG_GREEK_GREECE 0x01 // Greek (Greece) +#define SUBLANG_GREENLANDIC_GREENLAND 0x01 // Greenlandic (Greenland) 0x046f kl-GL +#define SUBLANG_GUJARATI_INDIA 0x01 // Gujarati (India (Gujarati Script)) 0x0447 gu-IN +#define SUBLANG_HAUSA_NIGERIA_LATIN 0x01 // Hausa (Latin, Nigeria) 0x0468 ha-NG-Latn +#define SUBLANG_HAWAIIAN_US 0x01 // Hawiian (US) 0x0475 haw-US +#define SUBLANG_HEBREW_ISRAEL 0x01 // Hebrew (Israel) 0x040d +#define SUBLANG_HINDI_INDIA 0x01 // Hindi (India) 0x0439 hi-IN +#define SUBLANG_HUNGARIAN_HUNGARY 0x01 // Hungarian (Hungary) 0x040e +#define SUBLANG_ICELANDIC_ICELAND 0x01 // Icelandic (Iceland) 0x040f +#define SUBLANG_IGBO_NIGERIA 0x01 // Igbo (Nigeria) 0x0470 ig-NG +#define SUBLANG_INDONESIAN_INDONESIA 0x01 // Indonesian (Indonesia) 0x0421 id-ID +#define SUBLANG_INUKTITUT_CANADA 0x01 // Inuktitut (Syllabics) (Canada) 0x045d iu-CA-Cans +#define SUBLANG_INUKTITUT_CANADA_LATIN 0x02 // Inuktitut (Canada - Latin) +#define SUBLANG_IRISH_IRELAND 0x02 // Irish (Ireland) +#define SUBLANG_ITALIAN 0x01 // Italian +#define SUBLANG_ITALIAN_SWISS 0x02 // Italian (Swiss) +#define SUBLANG_JAPANESE_JAPAN 0x01 // Japanese (Japan) 0x0411 +#define SUBLANG_KANNADA_INDIA 0x01 // Kannada (India (Kannada Script)) 0x044b kn-IN +#define SUBLANG_KASHMIRI_SASIA 0x02 // Kashmiri (South Asia) +#define SUBLANG_KASHMIRI_INDIA 0x02 // For app compatibility only +#define SUBLANG_KAZAK_KAZAKHSTAN 0x01 // Kazakh (Kazakhstan) 0x043f kk-KZ +#define SUBLANG_KHMER_CAMBODIA 0x01 // Khmer (Cambodia) 0x0453 kh-KH +#define SUBLANG_KICHE_GUATEMALA 0x01 // K'iche (Guatemala) +#define SUBLANG_KINYARWANDA_RWANDA 0x01 // Kinyarwanda (Rwanda) 0x0487 rw-RW +#define SUBLANG_KONKANI_INDIA 0x01 // Konkani (India) 0x0457 kok-IN +#define SUBLANG_KOREAN 0x01 // Korean (Extended Wansung) +#define SUBLANG_KYRGYZ_KYRGYZSTAN 0x01 // Kyrgyz (Kyrgyzstan) 0x0440 ky-KG +#define SUBLANG_LAO_LAO 0x01 // Lao (Lao PDR) 0x0454 lo-LA +#define SUBLANG_LATVIAN_LATVIA 0x01 // Latvian (Latvia) 0x0426 lv-LV +#define SUBLANG_LITHUANIAN 0x01 // Lithuanian +#define SUBLANG_LOWER_SORBIAN_GERMANY 0x02 // Lower Sorbian (Germany) 0x082e wee-DE +#define SUBLANG_LUXEMBOURGISH_LUXEMBOURG 0x01 // Luxembourgish (Luxembourg) 0x046e lb-LU +#define SUBLANG_MACEDONIAN_MACEDONIA 0x01 // Macedonian (Macedonia (FYROM)) 0x042f mk-MK +#define SUBLANG_MALAY_MALAYSIA 0x01 // Malay (Malaysia) +#define SUBLANG_MALAY_BRUNEI_DARUSSALAM 0x02 // Malay (Brunei Darussalam) +#define SUBLANG_MALAYALAM_INDIA 0x01 // Malayalam (India (Malayalam Script) ) 0x044c ml-IN +#define SUBLANG_MALTESE_MALTA 0x01 // Maltese (Malta) 0x043a mt-MT +#define SUBLANG_MAORI_NEW_ZEALAND 0x01 // Maori (New Zealand) 0x0481 mi-NZ +#define SUBLANG_MAPUDUNGUN_CHILE 0x01 // Mapudungun (Chile) 0x047a arn-CL +#define SUBLANG_MARATHI_INDIA 0x01 // Marathi (India) 0x044e mr-IN +#define SUBLANG_MOHAWK_MOHAWK 0x01 // Mohawk (Mohawk) 0x047c moh-CA +#define SUBLANG_MONGOLIAN_CYRILLIC_MONGOLIA 0x01 // Mongolian (Cyrillic, Mongolia) +#define SUBLANG_MONGOLIAN_PRC 0x02 // Mongolian (PRC) +#define SUBLANG_NEPALI_INDIA 0x02 // Nepali (India) +#define SUBLANG_NEPALI_NEPAL 0x01 // Nepali (Nepal) 0x0461 ne-NP +#define SUBLANG_NORWEGIAN_BOKMAL 0x01 // Norwegian (Bokmal) +#define SUBLANG_NORWEGIAN_NYNORSK 0x02 // Norwegian (Nynorsk) +#define SUBLANG_OCCITAN_FRANCE 0x01 // Occitan (France) 0x0482 oc-FR +#define SUBLANG_ODIA_INDIA 0x01 // Odia (India (Odia Script)) 0x0448 or-IN +#define SUBLANG_ORIYA_INDIA 0x01 // Deprecated: use SUBLANG_ODIA_INDIA instead +#define SUBLANG_PASHTO_AFGHANISTAN 0x01 // Pashto (Afghanistan) +#define SUBLANG_PERSIAN_IRAN 0x01 // Persian (Iran) 0x0429 fa-IR +#define SUBLANG_POLISH_POLAND 0x01 // Polish (Poland) 0x0415 +#define SUBLANG_PORTUGUESE 0x02 // Portuguese +#define SUBLANG_PORTUGUESE_BRAZILIAN 0x01 // Portuguese (Brazil) +#define SUBLANG_PULAR_SENEGAL 0x02 // Deprecated: Use SUBLANG_FULAH_SENEGAL instead +#define SUBLANG_PUNJABI_INDIA 0x01 // Punjabi (India (Gurmukhi Script)) 0x0446 pa-IN +#define SUBLANG_PUNJABI_PAKISTAN 0x02 // Punjabi (Pakistan (Arabic Script)) 0x0846 pa-Arab-PK +#define SUBLANG_QUECHUA_BOLIVIA 0x01 // Quechua (Bolivia) +#define SUBLANG_QUECHUA_ECUADOR 0x02 // Quechua (Ecuador) +#define SUBLANG_QUECHUA_PERU 0x03 // Quechua (Peru) +#define SUBLANG_ROMANIAN_ROMANIA 0x01 // Romanian (Romania) 0x0418 +#define SUBLANG_ROMANSH_SWITZERLAND 0x01 // Romansh (Switzerland) 0x0417 rm-CH +#define SUBLANG_RUSSIAN_RUSSIA 0x01 // Russian (Russia) 0x0419 +#define SUBLANG_SAKHA_RUSSIA 0x01 // Sakha (Russia) 0x0485 sah-RU +#define SUBLANG_SAMI_NORTHERN_NORWAY 0x01 // Northern Sami (Norway) +#define SUBLANG_SAMI_NORTHERN_SWEDEN 0x02 // Northern Sami (Sweden) +#define SUBLANG_SAMI_NORTHERN_FINLAND 0x03 // Northern Sami (Finland) +#define SUBLANG_SAMI_LULE_NORWAY 0x04 // Lule Sami (Norway) +#define SUBLANG_SAMI_LULE_SWEDEN 0x05 // Lule Sami (Sweden) +#define SUBLANG_SAMI_SOUTHERN_NORWAY 0x06 // Southern Sami (Norway) +#define SUBLANG_SAMI_SOUTHERN_SWEDEN 0x07 // Southern Sami (Sweden) +#define SUBLANG_SAMI_SKOLT_FINLAND 0x08 // Skolt Sami (Finland) +#define SUBLANG_SAMI_INARI_FINLAND 0x09 // Inari Sami (Finland) +#define SUBLANG_SANSKRIT_INDIA 0x01 // Sanskrit (India) 0x044f sa-IN +#define SUBLANG_SCOTTISH_GAELIC 0x01 // Scottish Gaelic (United Kingdom) 0x0491 gd-GB +#define SUBLANG_SERBIAN_BOSNIA_HERZEGOVINA_LATIN 0x06 // Serbian (Bosnia and Herzegovina - Latin) +#define SUBLANG_SERBIAN_BOSNIA_HERZEGOVINA_CYRILLIC 0x07 // Serbian (Bosnia and Herzegovina - Cyrillic) +#define SUBLANG_SERBIAN_MONTENEGRO_LATIN 0x0b // Serbian (Montenegro - Latn) +#define SUBLANG_SERBIAN_MONTENEGRO_CYRILLIC 0x0c // Serbian (Montenegro - Cyrillic) +#define SUBLANG_SERBIAN_SERBIA_LATIN 0x09 // Serbian (Serbia - Latin) +#define SUBLANG_SERBIAN_SERBIA_CYRILLIC 0x0a // Serbian (Serbia - Cyrillic) +#define SUBLANG_SERBIAN_CROATIA 0x01 // Croatian (Croatia) 0x041a hr-HR +#define SUBLANG_SERBIAN_LATIN 0x02 // Serbian (Latin) +#define SUBLANG_SERBIAN_CYRILLIC 0x03 // Serbian (Cyrillic) +#define SUBLANG_SINDHI_INDIA 0x01 // Sindhi (India) reserved 0x0459 +#define SUBLANG_SINDHI_PAKISTAN 0x02 // Sindhi (Pakistan) 0x0859 sd-Arab-PK +#define SUBLANG_SINDHI_AFGHANISTAN 0x02 // For app compatibility only +#define SUBLANG_SINHALESE_SRI_LANKA 0x01 // Sinhalese (Sri Lanka) +#define SUBLANG_SOTHO_NORTHERN_SOUTH_AFRICA 0x01 // Northern Sotho (South Africa) +#define SUBLANG_SLOVAK_SLOVAKIA 0x01 // Slovak (Slovakia) 0x041b sk-SK +#define SUBLANG_SLOVENIAN_SLOVENIA 0x01 // Slovenian (Slovenia) 0x0424 sl-SI +#define SUBLANG_SPANISH 0x01 // Spanish (Castilian) +#define SUBLANG_SPANISH_MEXICAN 0x02 // Spanish (Mexico) +#define SUBLANG_SPANISH_MODERN 0x03 // Spanish (Modern) +#define SUBLANG_SPANISH_GUATEMALA 0x04 // Spanish (Guatemala) +#define SUBLANG_SPANISH_COSTA_RICA 0x05 // Spanish (Costa Rica) +#define SUBLANG_SPANISH_PANAMA 0x06 // Spanish (Panama) +#define SUBLANG_SPANISH_DOMINICAN_REPUBLIC 0x07 // Spanish (Dominican Republic) +#define SUBLANG_SPANISH_VENEZUELA 0x08 // Spanish (Venezuela) +#define SUBLANG_SPANISH_COLOMBIA 0x09 // Spanish (Colombia) +#define SUBLANG_SPANISH_PERU 0x0a // Spanish (Peru) +#define SUBLANG_SPANISH_ARGENTINA 0x0b // Spanish (Argentina) +#define SUBLANG_SPANISH_ECUADOR 0x0c // Spanish (Ecuador) +#define SUBLANG_SPANISH_CHILE 0x0d // Spanish (Chile) +#define SUBLANG_SPANISH_URUGUAY 0x0e // Spanish (Uruguay) +#define SUBLANG_SPANISH_PARAGUAY 0x0f // Spanish (Paraguay) +#define SUBLANG_SPANISH_BOLIVIA 0x10 // Spanish (Bolivia) +#define SUBLANG_SPANISH_EL_SALVADOR 0x11 // Spanish (El Salvador) +#define SUBLANG_SPANISH_HONDURAS 0x12 // Spanish (Honduras) +#define SUBLANG_SPANISH_NICARAGUA 0x13 // Spanish (Nicaragua) +#define SUBLANG_SPANISH_PUERTO_RICO 0x14 // Spanish (Puerto Rico) +#define SUBLANG_SPANISH_US 0x15 // Spanish (United States) +#define SUBLANG_SWAHILI_KENYA 0x01 // Swahili (Kenya) 0x0441 sw-KE +#define SUBLANG_SWEDISH 0x01 // Swedish +#define SUBLANG_SWEDISH_FINLAND 0x02 // Swedish (Finland) +#define SUBLANG_SYRIAC_SYRIA 0x01 // Syriac (Syria) 0x045a syr-SY +#define SUBLANG_TAJIK_TAJIKISTAN 0x01 // Tajik (Tajikistan) 0x0428 tg-TJ-Cyrl +#define SUBLANG_TAMAZIGHT_ALGERIA_LATIN 0x02 // Tamazight (Latin, Algeria) 0x085f tzm-Latn-DZ +#define SUBLANG_TAMAZIGHT_MOROCCO_TIFINAGH 0x04 // Tamazight (Tifinagh) 0x105f tzm-Tfng-MA +#define SUBLANG_TAMIL_INDIA 0x01 // Tamil (India) +#define SUBLANG_TAMIL_SRI_LANKA 0x02 // Tamil (Sri Lanka) 0x0849 ta-LK +#define SUBLANG_TATAR_RUSSIA 0x01 // Tatar (Russia) 0x0444 tt-RU +#define SUBLANG_TELUGU_INDIA 0x01 // Telugu (India (Telugu Script)) 0x044a te-IN +#define SUBLANG_THAI_THAILAND 0x01 // Thai (Thailand) 0x041e th-TH +#define SUBLANG_TIBETAN_PRC 0x01 // Tibetan (PRC) +#define SUBLANG_TIGRIGNA_ERITREA 0x02 // Tigrigna (Eritrea) +#define SUBLANG_TIGRINYA_ERITREA 0x02 // Tigrinya (Eritrea) 0x0873 ti-ER (preferred spelling) +#define SUBLANG_TIGRINYA_ETHIOPIA 0x01 // Tigrinya (Ethiopia) 0x0473 ti-ET +#define SUBLANG_TSWANA_BOTSWANA 0x02 // Setswana / Tswana (Botswana) 0x0832 tn-BW +#define SUBLANG_TSWANA_SOUTH_AFRICA 0x01 // Setswana / Tswana (South Africa) 0x0432 tn-ZA +#define SUBLANG_TURKISH_TURKEY 0x01 // Turkish (Turkey) 0x041f tr-TR +#define SUBLANG_TURKMEN_TURKMENISTAN 0x01 // Turkmen (Turkmenistan) 0x0442 tk-TM +#define SUBLANG_UIGHUR_PRC 0x01 // Uighur (PRC) 0x0480 ug-CN +#define SUBLANG_UKRAINIAN_UKRAINE 0x01 // Ukrainian (Ukraine) 0x0422 uk-UA +#define SUBLANG_UPPER_SORBIAN_GERMANY 0x01 // Upper Sorbian (Germany) 0x042e wen-DE +#define SUBLANG_URDU_PAKISTAN 0x01 // Urdu (Pakistan) +#define SUBLANG_URDU_INDIA 0x02 // Urdu (India) +#define SUBLANG_UZBEK_LATIN 0x01 // Uzbek (Latin) +#define SUBLANG_UZBEK_CYRILLIC 0x02 // Uzbek (Cyrillic) +#define SUBLANG_VALENCIAN_VALENCIA 0x02 // Valencian (Valencia) 0x0803 ca-ES-Valencia +#define SUBLANG_VIETNAMESE_VIETNAM 0x01 // Vietnamese (Vietnam) 0x042a vi-VN +#define SUBLANG_WELSH_UNITED_KINGDOM 0x01 // Welsh (United Kingdom) 0x0452 cy-GB +#define SUBLANG_WOLOF_SENEGAL 0x01 // Wolof (Senegal) +#define SUBLANG_XHOSA_SOUTH_AFRICA 0x01 // isiXhosa / Xhosa (South Africa) 0x0434 xh-ZA +#define SUBLANG_YAKUT_RUSSIA 0x01 // Deprecated: use SUBLANG_SAKHA_RUSSIA instead +#define SUBLANG_YI_PRC 0x01 // Yi (PRC)) 0x0478 +#define SUBLANG_YORUBA_NIGERIA 0x01 // Yoruba (Nigeria) 046a yo-NG +#define SUBLANG_ZULU_SOUTH_AFRICA 0x01 // isiZulu / Zulu (South Africa) 0x0435 zu-ZA + + + + +// +// Sorting IDs. +// +// Note that the named locale APIs (eg CompareStringExEx) are recommended. +// + +#define SORT_DEFAULT 0x0 // sorting default + +#define SORT_INVARIANT_MATH 0x1 // Invariant (Mathematical Symbols) + +#define SORT_JAPANESE_XJIS 0x0 // Japanese XJIS order +#define SORT_JAPANESE_UNICODE 0x1 // Japanese Unicode order (no longer supported) +#define SORT_JAPANESE_RADICALSTROKE 0x4 // Japanese radical/stroke order + +#define SORT_CHINESE_BIG5 0x0 // Chinese BIG5 order +#define SORT_CHINESE_PRCP 0x0 // PRC Chinese Phonetic order +#define SORT_CHINESE_UNICODE 0x1 // Chinese Unicode order (no longer supported) +#define SORT_CHINESE_PRC 0x2 // PRC Chinese Stroke Count order +#define SORT_CHINESE_BOPOMOFO 0x3 // Traditional Chinese Bopomofo order +#define SORT_CHINESE_RADICALSTROKE 0x4 // Traditional Chinese radical/stroke order. + +#define SORT_KOREAN_KSC 0x0 // Korean KSC order +#define SORT_KOREAN_UNICODE 0x1 // Korean Unicode order (no longer supported) + +#define SORT_GERMAN_PHONE_BOOK 0x1 // German Phone Book order + +#define SORT_HUNGARIAN_DEFAULT 0x0 // Hungarian Default order +#define SORT_HUNGARIAN_TECHNICAL 0x1 // Hungarian Technical order + +#define SORT_GEORGIAN_TRADITIONAL 0x0 // Georgian Traditional order +#define SORT_GEORGIAN_MODERN 0x1 // Georgian Modern order + +// end_r_winnt + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// DEPRECATED: The LCID/LANGID/SORTID concept is deprecated, please use +// Locale Names instead, eg: "en-US" instead of an LCID like 0x0409. +// See the documentation for GetLocaleInfoEx. +// +// A language ID is a 16 bit value which is the combination of a +// primary language ID and a secondary language ID. The bits are +// allocated as follows: +// +// +-----------------------+-------------------------+ +// | Sublanguage ID | Primary Language ID | +// +-----------------------+-------------------------+ +// 15 10 9 0 bit +// +// WARNING: This pattern is broken and not followed for all languages. +// Serbian, Bosnian & Croatian are a few examples. +// +// WARNING: There are > 6000 human languages. The PRIMARYLANGID construct +// cannot support all languages your application may encounter. +// Please use Language Names, such as "en". +// +// WARNING: There are > 200 country-regions. The SUBLANGID construct cannot +// represent all valid dialects of languages such as English. +// Please use Locale Names, such as "en-US". +// +// WARNING: Some languages may have more than one PRIMARYLANGID. Please +// use Locale Names, such as "en-FJ". +// +// WARNING: Some languages do not have assigned LANGIDs. Please use +// Locale Names, such as "tlh-Piqd". +// +// It is recommended that applications test for locale names rather than +// attempting to construct/deconstruct LANGID/PRIMARYLANGID/SUBLANGID +// +// Language ID creation/extraction macros: +// +// MAKELANGID - construct language id from a primary language id and +// a sublanguage id. +// PRIMARYLANGID - extract primary language id from a language id. +// SUBLANGID - extract sublanguage id from a language id. +// +// Note that the LANG, SUBLANG construction is not always consistent. +// The named locale APIs (eg GetLocaleInfoEx) are recommended. +// +// DEPRECATED: Language IDs do not exist for all locales +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +#define MAKELANGID(p, s) ((((USHORT)(s)) << 10) | (USHORT)(p)) +#define PRIMARYLANGID(lgid) ((USHORT)(lgid) & 0x3ff) +#define SUBLANGID(lgid) ((USHORT)(lgid) >> 10) + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// DEPRECATED: The LCID/LANGID/SORTID concept is deprecated, please use +// Locale Names instead, eg: en-US instead of an LCID like 0x0409. +// See the documentation for GetLocaleInfoEx. +// +// A locale ID is a 32 bit value which is the combination of a +// language ID, a sort ID, and a reserved area. The bits are +// allocated as follows: +// +// +-------------+---------+-------------------------+ +// | Reserved | Sort ID | Language ID | +// +-------------+---------+-------------------------+ +// 31 20 19 16 15 0 bit +// +// WARNING: This pattern isn't always followed (es-ES_tradnl vs es-ES for example) +// +// WARNING: Some locales do not have assigned LCIDs. Please use +// Locale Names, such as "tlh-Piqd". +// +// It is recommended that applications test for locale names rather than +// attempting to rely on LCID or LANGID behavior. +// +// DEPRECATED: Locale ID creation/extraction macros: +// +// MAKELCID - construct the locale id from a language id and a sort id. +// MAKESORTLCID - construct the locale id from a language id, sort id, and sort version. +// LANGIDFROMLCID - extract the language id from a locale id. +// SORTIDFROMLCID - extract the sort id from a locale id. +// SORTVERSIONFROMLCID - extract the sort version from a locale id. +// +// Note that the LANG, SUBLANG construction is not always consistent. +// The named locale APIs (eg GetLocaleInfoEx) are recommended. +// +// DEPRECATED: LCIDs do not exist for all locales. +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +#define NLS_VALID_LOCALE_MASK 0x000fffff + +#define MAKELCID(lgid, srtid) ((ULONG)((((ULONG)((USHORT)(srtid))) << 16) | \ + ((ULONG)((USHORT)(lgid))))) +#define MAKESORTLCID(lgid, srtid, ver) \ + ((ULONG)((MAKELCID(lgid, srtid)) | \ + (((ULONG)((USHORT)(ver))) << 20))) +#define LANGIDFROMLCID(lcid) ((USHORT)(lcid)) +#define SORTIDFROMLCID(lcid) ((USHORT)((((ULONG)(lcid)) >> 16) & 0xf)) +#define SORTVERSIONFROMLCID(lcid) ((USHORT)((((ULONG)(lcid)) >> 20) & 0xf)) + +// Maximum Locale Name Length in Windows +// Locale names are preferred to the deprecated LCID/LANGID concepts. +// +// Locale names should follow the BCP47 recommendations and typically +// include language, script, regional variant, and perhaps additional specifiers. +// BCP47 allows some variation, eg: en-US is preferred to en-Latn-US. +#define LOCALE_NAME_MAX_LENGTH 85 + +// +// ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** DEPRECATED ** +// +// Deprecated default System and User IDs for language and locale. +// +// Locale names such as LOCALE_NAME_SYSTEM_DEFAULT, LOCALE_NAME_USER_DEFAULT, +// and LOCALE_NAME_INVARIANT are preferred. See documentation for GetLocaleInfoEx. +// + +#define LANG_SYSTEM_DEFAULT (MAKELANGID(LANG_NEUTRAL, SUBLANG_SYS_DEFAULT)) +#define LANG_USER_DEFAULT (MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)) + +#define LOCALE_SYSTEM_DEFAULT (MAKELCID(LANG_SYSTEM_DEFAULT, SORT_DEFAULT)) +#define LOCALE_USER_DEFAULT (MAKELCID(LANG_USER_DEFAULT, SORT_DEFAULT)) + +// +// Other special IDs for language and locale. +// +// DEPRECATED: These identifiers are all underspecified and lose information. +// Please use Locale Names such as "en-FJ". +// See documentation for GetLocaleInfoEx. +// +#define LOCALE_CUSTOM_DEFAULT \ + (MAKELCID(MAKELANGID(LANG_NEUTRAL, SUBLANG_CUSTOM_DEFAULT), SORT_DEFAULT)) + +#define LOCALE_CUSTOM_UNSPECIFIED \ + (MAKELCID(MAKELANGID(LANG_NEUTRAL, SUBLANG_CUSTOM_UNSPECIFIED), SORT_DEFAULT)) + +#define LOCALE_CUSTOM_UI_DEFAULT \ + (MAKELCID(MAKELANGID(LANG_NEUTRAL, SUBLANG_UI_CUSTOM_DEFAULT), SORT_DEFAULT)) + +#define LOCALE_NEUTRAL \ + (MAKELCID(MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL), SORT_DEFAULT)) + +#define LOCALE_INVARIANT \ + (MAKELCID(MAKELANGID(LANG_INVARIANT, SUBLANG_NEUTRAL), SORT_DEFAULT)) + +// +// Transient keyboard Locale IDs (LCIDs) +// Should only be used for keyboard layout identification +// +// DEPRECATED: These identifiers are all transient and will change, even at +// different times on the same system. +// Please use Locale Names such as "en-FJ". +// See documentation for GetLocaleInfoEx. +// +#define LOCALE_TRANSIENT_KEYBOARD1 0x2000 +#define LOCALE_TRANSIENT_KEYBOARD2 0x2400 +#define LOCALE_TRANSIENT_KEYBOARD3 0x2800 +#define LOCALE_TRANSIENT_KEYBOARD4 0x2c00 + +// +// Locale with an unassigned LCID +// These locales cannot be queried by LCID +// Currently same as LOCALE_CUSTOM_UNSPECIFIED +// +// DEPRECATED: Please use Locale Names; see documentation for GetLocaleInfoEx. +// +#define LOCALE_UNASSIGNED_LCID LOCALE_CUSTOM_UNSPECIFIED + +// begin_ntminiport begin_ntndis begin_ntminitape + +// +// Macros used to eliminate compiler warning generated when formal +// parameters or local variables are not declared. +// +// Use DBG_UNREFERENCED_PARAMETER() when a parameter is not yet +// referenced but will be once the module is completely developed. +// +// Use DBG_UNREFERENCED_LOCAL_VARIABLE() when a local variable is not yet +// referenced but will be once the module is completely developed. +// +// Use UNREFERENCED_PARAMETER() if a parameter will never be referenced. +// +// DBG_UNREFERENCED_PARAMETER and DBG_UNREFERENCED_LOCAL_VARIABLE will +// eventually be made into a null macro to help determine whether there +// is unfinished work. +// + +// begin_ntoshvp + +#if ! defined(lint) + +#ifdef _PREFAST_ + +void _Prefast_unreferenced_parameter_impl_(const char*, ...); +#define UNREFERENCED_PARAMETER(P) _Prefast_unreferenced_parameter_impl_("PREfast", ((void) (P), 0)) +#define DBG_UNREFERENCED_PARAMETER(P) _Prefast_unreferenced_parameter_impl_("PREfast", ((void) (P), 0)) +#define DBG_UNREFERENCED_LOCAL_VARIABLE(V) _Prefast_unreferenced_parameter_impl_("PREfast", ((void) (V), 0)) + +#else // _PREFAST_ + +#define UNREFERENCED_PARAMETER(P) (P) +#define DBG_UNREFERENCED_PARAMETER(P) (P) +#define DBG_UNREFERENCED_LOCAL_VARIABLE(V) (V) + +#endif // _PREFAST_ + +#else // lint + +// Note: lint -e530 says don't complain about uninitialized variables for +// this variable. Error 527 has to do with unreachable code. +// -restore restores checking to the -save state + +#define UNREFERENCED_PARAMETER(P) \ + /*lint -save -e527 -e530 */ \ + { \ + (P) = (P); \ + } \ + /*lint -restore */ +#define DBG_UNREFERENCED_PARAMETER(P) \ + /*lint -save -e527 -e530 */ \ + { \ + (P) = (P); \ + } \ + /*lint -restore */ +#define DBG_UNREFERENCED_LOCAL_VARIABLE(V) \ + /*lint -save -e527 -e530 */ \ + { \ + (V) = (V); \ + } \ + /*lint -restore */ + +#endif // lint + +// end_ntoshvp + +// +// Macro used to eliminate compiler warning 4715 within a switch statement +// when all possible cases have already been accounted for. +// +// switch (a & 3) { +// case 0: return 1; +// case 1: return Foo(); +// case 2: return Bar(); +// case 3: return 1; +// DEFAULT_UNREACHABLE; +// + +#if (_MSC_VER > 1200) +#define DEFAULT_UNREACHABLE default: __assume(0) +#else + +// +// Older compilers do not support __assume(), and there is no other free +// method of eliminating the warning. +// + +#define DEFAULT_UNREACHABLE + +#endif + +#ifdef __cplusplus + +// Define operator overloads to enable bit operations on enum values that are +// used to define flags. Use DEFINE_ENUM_FLAG_OPERATORS(YOUR_TYPE) to enable these +// operators on YOUR_TYPE. + +// Moved here from objbase.w. + +// Templates are defined here in order to avoid a dependency on C++ header file, +// or on compiler-specific constructs. +extern "C++" { + + template + struct _ENUM_FLAG_INTEGER_FOR_SIZE; + + template <> + struct _ENUM_FLAG_INTEGER_FOR_SIZE<1> + { + typedef INT8 type; + }; + + template <> + struct _ENUM_FLAG_INTEGER_FOR_SIZE<2> + { + typedef INT16 type; + }; + + template <> + struct _ENUM_FLAG_INTEGER_FOR_SIZE<4> + { + typedef INT32 type; + }; + + template <> + struct _ENUM_FLAG_INTEGER_FOR_SIZE<8> + { + typedef INT64 type; + }; + + // used as an approximation of std::underlying_type + template + struct _ENUM_FLAG_SIZED_INTEGER + { + typedef typename _ENUM_FLAG_INTEGER_FOR_SIZE::type type; + }; + +} + +#if _MSC_VER >= 1900 +#define _ENUM_FLAG_CONSTEXPR constexpr +#else +#define _ENUM_FLAG_CONSTEXPR +#endif + +#define DEFINE_ENUM_FLAG_OPERATORS(ENUMTYPE) \ +extern "C++" { \ +inline _ENUM_FLAG_CONSTEXPR ENUMTYPE operator | (ENUMTYPE a, ENUMTYPE b) WIN_NOEXCEPT { return ENUMTYPE(((_ENUM_FLAG_SIZED_INTEGER::type)a) | ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +inline ENUMTYPE &operator |= (ENUMTYPE &a, ENUMTYPE b) WIN_NOEXCEPT { return (ENUMTYPE &)(((_ENUM_FLAG_SIZED_INTEGER::type &)a) |= ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +inline _ENUM_FLAG_CONSTEXPR ENUMTYPE operator & (ENUMTYPE a, ENUMTYPE b) WIN_NOEXCEPT { return ENUMTYPE(((_ENUM_FLAG_SIZED_INTEGER::type)a) & ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +inline ENUMTYPE &operator &= (ENUMTYPE &a, ENUMTYPE b) WIN_NOEXCEPT { return (ENUMTYPE &)(((_ENUM_FLAG_SIZED_INTEGER::type &)a) &= ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +inline _ENUM_FLAG_CONSTEXPR ENUMTYPE operator ~ (ENUMTYPE a) WIN_NOEXCEPT { return ENUMTYPE(~((_ENUM_FLAG_SIZED_INTEGER::type)a)); } \ +inline _ENUM_FLAG_CONSTEXPR ENUMTYPE operator ^ (ENUMTYPE a, ENUMTYPE b) WIN_NOEXCEPT { return ENUMTYPE(((_ENUM_FLAG_SIZED_INTEGER::type)a) ^ ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +inline ENUMTYPE &operator ^= (ENUMTYPE &a, ENUMTYPE b) WIN_NOEXCEPT { return (ENUMTYPE &)(((_ENUM_FLAG_SIZED_INTEGER::type &)a) ^= ((_ENUM_FLAG_SIZED_INTEGER::type)b)); } \ +} +#else +#define DEFINE_ENUM_FLAG_OPERATORS(ENUMTYPE) // NOP, C allows these operators. +#endif + +// Compile-time macros for initializing flag values in const data. +// +// When using DEFINE_ENUM_FLAG_OPERATORS for enum values you should use the macros below +// when you need to initialize global const data. Without these macros the inline operators +// from DEFINE_ENUM_FLAG_OPERATORS force a runtime initialization rather than a +// compile time initialization. This applies even if you have declared the data as const. +// +// This is no longer necessary for compilers that support constexpr. +#define COMPILETIME_OR_2FLAGS(a,b) ((UINT)(a)|(UINT)(b)) +#define COMPILETIME_OR_3FLAGS(a,b,c) ((UINT)(a)|(UINT)(b)|(UINT)(c)) +#define COMPILETIME_OR_4FLAGS(a,b,c,d) ((UINT)(a)|(UINT)(b)|(UINT)(c)|(UINT)(d)) +#define COMPILETIME_OR_5FLAGS(a,b,c,d,e) ((UINT)(a)|(UINT)(b)|(UINT)(c)|(UINT)(d)|(UINT)(e)) +#define COMPILETIME_OR_6FLAGS(a,b,c,d,e,f) ((UINT)(a)|(UINT)(b)|(UINT)(c)|(UINT)(d)|(UINT)(e)|(UINT)(f)) + +// end_winnt + +// +// Define standard min and max macros +// + +#ifndef NOMINMAX + +#ifndef min +#define min(a,b) (((a) < (b)) ? (a) : (b)) +#endif + +#ifndef max +#define max(a,b) (((a) > (b)) ? (a) : (b)) +#endif + +#endif // NOMINMAX + +// end_ntndis end_ntminitape +// begin_winnt + +// Much of the Windows SDK assumes the default packing of structs. +#if !defined(WINDOWS_IGNORE_PACKING_MISMATCH) && !defined(__midl) && !defined(MIDL_PASS) && !defined(SORTPP_PASS) && !defined(RC_INVOKED) +#if defined(__cplusplus) && (_MSC_VER >= 1600) +static_assert(__alignof(LARGE_INTEGER) == 8, "Windows headers require the default packing option. Changing this can lead to memory corruption." + " This diagnostic can be disabled by building with WINDOWS_IGNORE_PACKING_MISMATCH defined."); +#elif _MSC_VER >= 1300 +#pragma warning(push) +#pragma warning(disable: 4116) +C_ASSERT(TYPE_ALIGNMENT(LARGE_INTEGER) == 8); +#pragma warning(pop) +#endif +#endif + +// end_ntminiport end_winnt + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + + +#endif // _NTDEF_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdskreg.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdskreg.h new file mode 100644 index 0000000000000000000000000000000000000000..013e1abb86ddf3f7a76393fcaae16caa0ca10004 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntdskreg.h @@ -0,0 +1,276 @@ +/*++ + +Copyright (c) 1991-1999 Microsoft Corporation + +Module Name: + + ntdskreg.h + +Abstract: + + This file contains disk registry data structures. + + +--*/ + +#ifndef _NTDSKREG_ +#define _NTDSKREG_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Component types for FT members. If a disk partition +// is not a part of an FT component then it is stamped +// as "NotAnFtMember". +// + +typedef enum { + Mirror, + Stripe, + StripeWithParity, + VolumeSet, + NotAnFtMember, + WholeDisk +} FT_TYPE; + +// +// FT_PARTITION_STATE is an enumerated type that describes the state of an +// NTFT member. +// Up to one member can be 'orphaned', that is missing or out of sync with +// the other members. The orphaned member will remain orphaned until recovery +// action is commenced in DISKMAN.EXE. +// When READs are directed at an orphaned member, the data is returned from +// the redundant copy. WRITEs go to the secondary members only. +// +// Note that SyncRedundantCopy should NEVER be seen by anything other +// than ft itself. +// + +typedef enum _FT_PARTITION_STATE { + Healthy, + Orphaned, + Regenerating, + Initializing, + SyncRedundantCopy +} FT_PARTITION_STATE, *PFT_PARTITION_STATE; + +// +// The description of a partition on a disk. +// + +#include "pshpack4.h" +typedef struct _DISK_PARTITION { + + FT_TYPE FtType; + FT_PARTITION_STATE FtState; + LARGE_INTEGER StartingOffset; + LARGE_INTEGER Length; + LARGE_INTEGER FtLength; + ULONG ReservedTwoLongs[2]; + UCHAR DriveLetter; + BOOLEAN AssignDriveLetter; + USHORT LogicalNumber; + USHORT FtGroup; + USHORT FtMember; + BOOLEAN Modified; + UCHAR ReservedChars[3]; + +} DISK_PARTITION, *PDISK_PARTITION; + +// +// The description of a disk. +// + +typedef struct _DISK_DESCRIPTION { + + USHORT NumberOfPartitions; + USHORT ReservedShort; + ULONG Signature; + + // + // An array for NumberOfPartitions + // + + DISK_PARTITION Partitions[1]; + +} DISK_DESCRIPTION, *PDISK_DESCRIPTION; + +// +// Header for all disk descriptions. +// + +typedef struct _DISK_REGISTRY { + + USHORT NumberOfDisks; + USHORT ReservedShort; + + // + // An array for NumberOfDisks. + // + + DISK_DESCRIPTION Disks[1]; + +} DISK_REGISTRY, *PDISK_REGISTRY; +#include "poppack.h" + +// +// Function prototypes. +// + + +#if (NTDDI_VERSION < NTDDI_VISTA) + +// +// Set the current registry information. +// + +NTSTATUS +DiskRegistrySet( + _In_ PDISK_REGISTRY Buffer + ); + + +// +// Add a single disk to the registry. This disk is not a part of +// a Fault Tolerance volume. +// + +NTSTATUS +DiskRegistryAddNewDisk( + _In_ PDISK_DESCRIPTION Buffer + ); + +// +// Get the current registry information. +// A Buffer address == NULL indicates that the caller only wants. +// to know the size of the registry information. +// + +NTSTATUS +DiskRegistryGet( + _Out_ PDISK_REGISTRY Buffer, + _Out_ PULONG LengthReturned + ); + +// +// Determine if FT is installed and currently active in the system. +// + +BOOLEAN +FtInstalled( + ); + +// +// Cause an FT set to be initialized at the earliest possible moment. +// + +VOID +DiskRegistryInitializeSet( + _In_ USHORT FtType, + _In_ USHORT FtGroup + ); + +// +// Cause an FT set member to be regenerated at the earliest possible moment. +// + +VOID +DiskRegistryRegenerateSet( + _In_ USHORT FtType, + _In_ USHORT FtGroup, + _In_ USHORT FtMember + ); + +// +// Enable the FT driver. +// + +BOOLEAN +DiskRegistryEnableFt(); + +// +// Disable the FT driver. +// + +VOID +DiskRegistryDisableFt(); + +// +// Determine if the existing FT registry information requires the FT driver. +// + +BOOLEAN +DiskRegistryRequiresFt(); + +// +// Update drive letter assignment. +// + +BOOLEAN +DiskRegistryAssignDriveLetter( + _In_ ULONG Signature, + _In_ LARGE_INTEGER StartingOffset, + _In_ LARGE_INTEGER Length, + _In_ UCHAR DriveLetter + ); + +// +// Determine if DoubleSpace support is set to automount double space +// volumes on removable media. +// + +BOOLEAN +DiskRegistryAutomountCurrentState( + ); + +// +// Set the automount state for double space volumes on removable media. +// + +NTSTATUS +DiskRegistryDblSpaceRemovable( + _In_ BOOLEAN Automount + ); + +// +// Set the drive letter for space mount information in the registry. +// + +NTSTATUS +DiskRegistryAssignDblSpaceLetter( + _In_ PWSTR CvfName, + _In_ WCHAR DriveLetter + ); + +// +// Set up the registry information for CdRom drive letters. +// + +NTSTATUS +DiskRegistryAssignCdRomLetter( + _In_ PWSTR CdromName, + _In_ WCHAR DriveLetter + ); + +#endif // < NTDDI_VISTA + +#ifdef __cplusplus +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // _NTDSKREG_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntiologc.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntiologc.h new file mode 100644 index 0000000000000000000000000000000000000000..aa3b1585ef0a1418d16834a7677ae28401d11bd8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntiologc.h @@ -0,0 +1,1651 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) 1991 Microsoft Corporation + +Module Name: + + ntiologc.h + +Abstract: + + Constant definitions for the I/O error code log values. + +Author: + +Revision History: + +--*/ + +#ifndef _NTIOLOGC_ +#define _NTIOLOGC_ + +// +// Status values are 32 bit values layed out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-------------------------+-------------------------------+ +// |Sev|C| Facility | Code | +// +---+-+-------------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// Facility - is the facility code +// +// Code - is the facility's status code +// + +// +// Values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// +#define FACILITY_IO_ERROR_CODE 0x4 +#define FACILITY_MCA_ERROR_CODE 0x5 +#define FACILITY_VOLMGR 0x38 + + +// +// Define the severity codes +// +#define STATUS_SEVERITY_SUCCESS 0x0 +#define STATUS_SEVERITY_INFORMATIONAL 0x1 +#define STATUS_SEVERITY_WARNING 0x2 +#define STATUS_SEVERITY_ERROR 0x3 + + +// +// MessageId: IO_ERR_INSUFFICIENT_RESOURCES +// +// MessageText: +// +// The driver could not allocate something necessary for the request for %1. +// +#define IO_ERR_INSUFFICIENT_RESOURCES ((NTSTATUS)0xC0040002L) + +// +// MessageId: IO_ERR_DRIVER_ERROR +// +// MessageText: +// +// Driver detected an internal error in its data structures for %1. +// +#define IO_ERR_DRIVER_ERROR ((NTSTATUS)0xC0040004L) + +// +// MessageId: IO_ERR_SEEK_ERROR +// +// MessageText: +// +// The device, %1, had a seek error. +// +#define IO_ERR_SEEK_ERROR ((NTSTATUS)0xC0040006L) + +// +// MessageId: IO_ERR_BAD_BLOCK +// +// MessageText: +// +// The device, %1, has a bad block. +// +#define IO_ERR_BAD_BLOCK ((NTSTATUS)0xC0040007L) + +// +// MessageId: IO_ERR_TIMEOUT +// +// MessageText: +// +// The device, %1, did not respond within the timeout period. +// +#define IO_ERR_TIMEOUT ((NTSTATUS)0xC0040009L) + +// +// MessageId: IO_ERR_CONTROLLER_ERROR +// +// MessageText: +// +// The driver detected a controller error on %1. +// +#define IO_ERR_CONTROLLER_ERROR ((NTSTATUS)0xC004000BL) + +// +// MessageId: IO_ERR_NOT_READY +// +// MessageText: +// +// The device, %1, is not ready for access yet. +// +#define IO_ERR_NOT_READY ((NTSTATUS)0xC004000FL) + +// +// MessageId: IO_ERR_INVALID_REQUEST +// +// MessageText: +// +// The request is incorrectly formatted for %1. +// +#define IO_ERR_INVALID_REQUEST ((NTSTATUS)0xC0040010L) + +// +// MessageId: IO_ERR_RESET +// +// MessageText: +// +// The device, %1, has been reset. +// +#define IO_ERR_RESET ((NTSTATUS)0xC0040013L) + +// +// MessageId: IO_ERR_BAD_FIRMWARE +// +// MessageText: +// +// The driver has detected a device with old or out-of-date firmware. The +// device will not be used. +// +#define IO_ERR_BAD_FIRMWARE ((NTSTATUS)0xC0040019L) + +// +// MessageId: IO_WRN_BAD_FIRMWARE +// +// MessageText: +// +// The driver has detected that device %1 has old or out-of-date firmware. +// Reduced performance may result. +// +#define IO_WRN_BAD_FIRMWARE ((NTSTATUS)0x8004001AL) + +// +// MessageId: IO_WRITE_CACHE_ENABLED +// +// MessageText: +// +// The driver detected that the device %1 has its write cache enabled. Data corruption +// may occur. +// +#define IO_WRITE_CACHE_ENABLED ((NTSTATUS)0x80040020L) + +// +// MessageId: IO_RECOVERED_VIA_ECC +// +// MessageText: +// +// Data was recovered using error correction code on device %1. +// +#define IO_RECOVERED_VIA_ECC ((NTSTATUS)0x80040021L) + +// +// MessageId: IO_WRITE_CACHE_DISABLED +// +// MessageText: +// +// The driver disabled the write cache on device %1. +// +#define IO_WRITE_CACHE_DISABLED ((NTSTATUS)0x80040022L) + +// +// MessageId: IO_WARNING_PAGING_FAILURE +// +// MessageText: +// +// An error was detected on device %1 during a paging operation. +// +#define IO_WARNING_PAGING_FAILURE ((NTSTATUS)0x80040033L) + +// +// MessageId: IO_WRN_FAILURE_PREDICTED +// +// MessageText: +// +// The driver has detected that device %1 has predicted that it will fail. +// Immediately back up your data and replace your hard disk drive. A failure +// may be imminent. +// +#define IO_WRN_FAILURE_PREDICTED ((NTSTATUS)0x80040034L) + +// +// MessageId: IO_WARNING_ALLOCATION_FAILED +// +// MessageText: +// +// The driver failed to allocate memory. +// +#define IO_WARNING_ALLOCATION_FAILED ((NTSTATUS)0x80040038L) + +// +// MessageId: IO_WARNING_DUPLICATE_SIGNATURE +// +// MessageText: +// +// The disk signature of disk %2 is equal to the disk signature of disk %3. +// +#define IO_WARNING_DUPLICATE_SIGNATURE ((NTSTATUS)0x8004003AL) + +// +// MessageId: IO_WARNING_DUPLICATE_PATH +// +// MessageText: +// +// Disk %2 will not be used because it is a redundant path for disk %3. +// +#define IO_WARNING_DUPLICATE_PATH ((NTSTATUS)0x8004003BL) + +// +// MessageId: IO_WARNING_WRITE_FUA_PROBLEM +// +// MessageText: +// +// Device %1 is not correctly processing some write requests. In Device Manager, ensure that the Write Cache option is disabled for this device or data corruption may occur. +// +#define IO_WARNING_WRITE_FUA_PROBLEM ((NTSTATUS)0x80040084L) + +// +// MessageId: IO_WARNING_VOLUME_LOST_DISK_EXTENT +// +// MessageText: +// +// Extent %4 on disk %3 that is part of the fault-tolerant volume %2 is no longer accessible. +// +#define IO_WARNING_VOLUME_LOST_DISK_EXTENT ((NTSTATUS)0x8004008EL) + +// +// MessageId: IO_WARNING_DEVICE_HAS_INTERNAL_DUMP +// +// MessageText: +// +// The storage device produced an internal dump. +// +#define IO_WARNING_DEVICE_HAS_INTERNAL_DUMP ((NTSTATUS)0x8004008FL) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED ((NTSTATUS)0x80040090L) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED_EX +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold and used %3 bytes. When the threshold was crossed, there were %4 bytes of remaining capacity. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED_EX ((NTSTATUS)0x80040091L) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED_EX_LUN_LUN +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold and used %3 bytes. When the threshold was crossed, the disk had %4 bytes of remaining capacity. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED_EX_LUN_LUN ((NTSTATUS)0x80040092L) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED_EX_LUN_POOL +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold and used %3 bytes. When the threshold was crossed, the pool had %4 bytes of remaining capacity. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED_EX_LUN_POOL ((NTSTATUS)0x80040093L) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED_EX_POOL_LUN +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold. When the threshold was crossed, %3 bytes from the pool were used and the disk had %4 bytes of remaining capacity. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED_EX_POOL_LUN ((NTSTATUS)0x80040094L) + +// +// MessageId: IO_WARNING_SOFT_THRESHOLD_REACHED_EX_POOL_POOL +// +// MessageText: +// +// Disk %2 has crossed a capacity utilization threshold. When the threshold was crossed, %3 bytes from the pool were used and the pool had %4 bytes of remaining capacity. +// +#define IO_WARNING_SOFT_THRESHOLD_REACHED_EX_POOL_POOL ((NTSTATUS)0x80040095L) + +// +// MessageId: IO_ERROR_DISK_RESOURCES_EXHAUSTED +// +// MessageText: +// +// Disk %2 has reached a logical block provisioning permanent resource exhaustion condition. +// +#define IO_ERROR_DISK_RESOURCES_EXHAUSTED ((NTSTATUS)0xC0040096L) + +// +// MessageId: IO_WARNING_DISK_CAPACITY_CHANGED +// +// MessageText: +// +// The capacity of Disk %2 has changed. +// +#define IO_WARNING_DISK_CAPACITY_CHANGED ((NTSTATUS)0x80040097L) + +// +// MessageId: IO_WARNING_DISK_PROVISIONING_TYPE_CHANGED +// +// MessageText: +// +// The logical block provisioning type for Disk %2 has changed. +// +#define IO_WARNING_DISK_PROVISIONING_TYPE_CHANGED ((NTSTATUS)0x80040098L) + +// +// MessageId: IO_WARNING_IO_OPERATION_RETRIED +// +// MessageText: +// +// The IO operation at logical block address %2 for Disk %3 (PDO name: %4) was retried. +// +#define IO_WARNING_IO_OPERATION_RETRIED ((NTSTATUS)0x80040099L) + +// +// MessageId: IO_ERROR_IO_HARDWARE_ERROR +// +// MessageText: +// +// The IO operation at logical block address %2 for Disk %3 (PDO name: %4) failed due to a hardware error. +// +#define IO_ERROR_IO_HARDWARE_ERROR ((NTSTATUS)0xC004009AL) + +// +// MessageId: IO_WARNING_COMPLETION_TIME +// +// MessageText: +// +// The IO operation at logical block address %2 for Disk %3 took %4 milliseconds. This was longer than the maximum expected time of %5 milliseconds. +// +#define IO_WARNING_COMPLETION_TIME ((NTSTATUS)0x8004009BL) + +// +// MessageId: IO_WARNING_DISK_SURPRISE_REMOVED +// +// MessageText: +// +// Disk %2 has been surprise removed. +// +#define IO_WARNING_DISK_SURPRISE_REMOVED ((NTSTATUS)0x8004009DL) + +// +// MessageId: IO_WARNING_REPEATED_DISK_GUID +// +// MessageText: +// +// Disk %2 has the same disk identifiers as one or more disks connected to the system. Go to Microsoft's support website (http://support.microsoft.com) and search for KB2983588 to resolve the issue. +// +#define IO_WARNING_REPEATED_DISK_GUID ((NTSTATUS)0x8004009EL) + +// +// MessageId: IO_WARNING_DISK_FIRMWARE_UPDATED +// +// MessageText: +// +// Firmware update for Disk %2 is completed. +// +#define IO_WARNING_DISK_FIRMWARE_UPDATED ((NTSTATUS)0x4004009FL) + +//////////////////////////////////////////////////////// +// Facility IO +// +// +// SUCCESS codes +// +// +// MessageId: IO_ERR_RETRY_SUCCEEDED +// +// MessageText: +// +// A retry was successful on %1. +// +#define IO_ERR_RETRY_SUCCEEDED ((NTSTATUS)0x00040001L) + +// +// MessageId: IO_DUMP_CREATION_SUCCESS +// +// MessageText: +// +// Dump file generation succeded. +// +#define IO_DUMP_CREATION_SUCCESS ((NTSTATUS)0x000400A2L) + +// +// INFORMATIONAL codes +// +// +// MessageId: IO_FILE_QUOTA_THRESHOLD +// +// MessageText: +// +// A user hit their quota threshold on volume %2. +// +#define IO_FILE_QUOTA_THRESHOLD ((NTSTATUS)0x40040024L) + +// +// MessageId: IO_FILE_QUOTA_LIMIT +// +// MessageText: +// +// A user hit their quota limit on volume %2. +// +#define IO_FILE_QUOTA_LIMIT ((NTSTATUS)0x40040025L) + +// +// MessageId: IO_FILE_QUOTA_STARTED +// +// MessageText: +// +// The system has started rebuilding the user disk quota information on +// device %1 with label "%2". +// +#define IO_FILE_QUOTA_STARTED ((NTSTATUS)0x40040026L) + +// +// MessageId: IO_FILE_QUOTA_SUCCEEDED +// +// MessageText: +// +// The system has successfully rebuilt the user disk quota information on +// device %1 with label "%2". +// +#define IO_FILE_QUOTA_SUCCEEDED ((NTSTATUS)0x40040027L) + +// +// MessageId: IO_INFO_THROTTLE_COMPLETE +// +// MessageText: +// +// The driver for device %1 delayed non-paging Io requests for %2 ms to recover from a low memory condition. +// +#define IO_INFO_THROTTLE_COMPLETE ((NTSTATUS)0x40040077L) + +// +// MessageId: IO_CDROM_EXCLUSIVE_LOCK +// +// MessageText: +// +// Device %1 is locked for exclusive access. +// +#define IO_CDROM_EXCLUSIVE_LOCK ((NTSTATUS)0x40040085L) + + +// codes 0x9f defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_WARNING_ADAPTER_FIRMWARE_UPDATED +// +// MessageText: +// +// Firmware update for Adapter %1 is completed. +// +#define IO_WARNING_ADAPTER_FIRMWARE_UPDATED ((NTSTATUS)0x400400A0L) + +// +// WARNING codes +// + +// codes 0x1a, 0x20-0x22 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_FILE_QUOTA_FAILED +// +// MessageText: +// +// The system has encounted an error rebuilding the user disk quota +// information on device %1 with label "%2". +// +#define IO_FILE_QUOTA_FAILED ((NTSTATUS)0x80040028L) + +// +// MessageId: IO_LOST_DELAYED_WRITE +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %2. The data has been lost. +// This error may be caused by a failure of your computer hardware or network connection. Please try to save this file elsewhere. +// +#define IO_LOST_DELAYED_WRITE ((NTSTATUS)0x80040032L) + + +// codes 0x33, 0x34 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_WARNING_INTERRUPT_STILL_PENDING +// +// MessageText: +// +// A pending interrupt was detected on device %1 during a timeout operation. A +// large number of these warnings may indicate that the system is not correctly +// receiving or processing interrupts from the device. +// +#define IO_WARNING_INTERRUPT_STILL_PENDING ((NTSTATUS)0x80040035L) + +// +// MessageId: IO_DRIVER_CANCEL_TIMEOUT +// +// MessageText: +// +// An Io Request to the device %1 did not complete or canceled within the +// specific timeout. This can occur if the device driver does not set a +// cancel routine for a given IO request packet. +// +#define IO_DRIVER_CANCEL_TIMEOUT ((NTSTATUS)0x80040036L) + + +// codes 0x38 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_WARNING_LOG_FLUSH_FAILED +// +// MessageText: +// +// The system failed to flush data to the transaction log. Corruption may occur. +// +#define IO_WARNING_LOG_FLUSH_FAILED ((NTSTATUS)0x80040039L) + + +// codes 0x3a, 0x3b defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_WARNING_BUS_RESET +// +// MessageText: +// +// The driver for device %1 performed a bus reset upon request. +// +#define IO_WARNING_BUS_RESET ((NTSTATUS)0x80040076L) + +// +// MessageId: IO_WARNING_RESET +// +// MessageText: +// +// Reset to device, %1, was issued. +// +#define IO_WARNING_RESET ((NTSTATUS)0x80040081L) + + +// codes 0x84 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_LOST_DELAYED_WRITE_NETWORK_DISCONNECTED +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %2; the data has been lost. +// This error may be caused by network connectivity issues. Please try to save this file elsewhere. +// +#define IO_LOST_DELAYED_WRITE_NETWORK_DISCONNECTED ((NTSTATUS)0x8004008BL) + +// +// MessageId: IO_LOST_DELAYED_WRITE_NETWORK_SERVER_ERROR +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %2; the data has been lost. +// This error was returned by the server on which the file exists. Please try to save this file elsewhere. +// +#define IO_LOST_DELAYED_WRITE_NETWORK_SERVER_ERROR ((NTSTATUS)0x8004008CL) + +// +// MessageId: IO_LOST_DELAYED_WRITE_NETWORK_LOCAL_DISK_ERROR +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %2; the data has been lost. +// This error may be caused if the device has been removed or the media is write-protected. +// +#define IO_LOST_DELAYED_WRITE_NETWORK_LOCAL_DISK_ERROR ((NTSTATUS)0x8004008DL) + + +// codes 0x8e-0x95, 0x97-0x99, 0x9b defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_WARNING_DUMP_DISABLED_DEVICE_GONE +// +// MessageText: +// +// Crash dump is disabled. Crash dump device is not present in the system. +// +#define IO_WARNING_DUMP_DISABLED_DEVICE_GONE ((NTSTATUS)0x8004009CL) + + +// codes 0x9e defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// ERROR codes +// + +// codes 0x2 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_CONFIGURATION_ERROR +// +// MessageText: +// +// Driver or device is incorrectly configured for %1. +// +#define IO_ERR_CONFIGURATION_ERROR ((NTSTATUS)0xC0040003L) + + +// codes 0x4 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_PARITY +// +// MessageText: +// +// A parity error was detected on %1. +// +#define IO_ERR_PARITY ((NTSTATUS)0xC0040005L) + + +// codes 0x6,0x7 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_OVERRUN_ERROR +// +// MessageText: +// +// An overrun occurred on %1. +// +#define IO_ERR_OVERRUN_ERROR ((NTSTATUS)0xC0040008L) + + +// codes 0x9 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_SEQUENCE +// +// MessageText: +// +// The driver detected an unexpected sequence by the device, %1. +// +#define IO_ERR_SEQUENCE ((NTSTATUS)0xC004000AL) + + +// codes 0xb defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_INTERNAL_ERROR +// +// MessageText: +// +// The driver detected an internal driver error on %1. +// +#define IO_ERR_INTERNAL_ERROR ((NTSTATUS)0xC004000CL) + +// +// MessageId: IO_ERR_INCORRECT_IRQL +// +// MessageText: +// +// The driver was configured with an incorrect interrupt for %1. +// +#define IO_ERR_INCORRECT_IRQL ((NTSTATUS)0xC004000DL) + +// +// MessageId: IO_ERR_INVALID_IOBASE +// +// MessageText: +// +// The driver was configured with an invalid I/O base address for %1. +// +#define IO_ERR_INVALID_IOBASE ((NTSTATUS)0xC004000EL) + + +// codes 0xf, 0x10 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_VERSION +// +// MessageText: +// +// The wrong version of the driver has been loaded. +// +#define IO_ERR_VERSION ((NTSTATUS)0xC0040011L) + +// +// MessageId: IO_ERR_LAYERED_FAILURE +// +// MessageText: +// +// The driver beneath this one has failed in some way for %1. +// +#define IO_ERR_LAYERED_FAILURE ((NTSTATUS)0xC0040012L) + + +// codes 0x13 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_PROTOCOL +// +// MessageText: +// +// A transport driver received a frame which violated the protocol. +// +#define IO_ERR_PROTOCOL ((NTSTATUS)0xC0040014L) + +// +// MessageId: IO_ERR_MEMORY_CONFLICT_DETECTED +// +// MessageText: +// +// A conflict has been detected between two drivers which claimed two overlapping +// memory regions. +// Driver %2, with device <%3>, claimed a memory range with starting address +// in data address 0x28 and 0x2c, and length in data address 0x30. +// +#define IO_ERR_MEMORY_CONFLICT_DETECTED ((NTSTATUS)0xC0040015L) + +// +// MessageId: IO_ERR_PORT_CONFLICT_DETECTED +// +// MessageText: +// +// A conflict has been detected between two drivers which claimed two overlapping +// Io port regions. +// Driver %2, with device <%3>, claimed an IO port range with starting address +// in data address 0x28 and 0x2c, and length in data address 0x30. +// +#define IO_ERR_PORT_CONFLICT_DETECTED ((NTSTATUS)0xC0040016L) + +// +// MessageId: IO_ERR_DMA_CONFLICT_DETECTED +// +// MessageText: +// +// A conflict has been detected between two drivers which claimed equivalent DMA +// channels. +// Driver %2, with device <%3>, claimed the DMA Channel in data address 0x28, with +// optinal port in data address 0x2c. +// +#define IO_ERR_DMA_CONFLICT_DETECTED ((NTSTATUS)0xC0040017L) + +// +// MessageId: IO_ERR_IRQ_CONFLICT_DETECTED +// +// MessageText: +// +// A conflict has been detected between two drivers which claimed equivalent IRQs. +// Driver %2, with device <%3>, claimed an interrupt with Level in data address +// 0x28, vector in data address 0x2c and Affinity in data address 0x30. +// +#define IO_ERR_IRQ_CONFLICT_DETECTED ((NTSTATUS)0xC0040018L) + + +// codes 0x19 defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERR_DMA_RESOURCE_CONFLICT +// +// MessageText: +// +// The device could not allocate one or more required resources due to conflicts +// with other devices. The device DMA setting of '%2' could not be +// satisified due to a conflict with Driver '%3'. +// +#define IO_ERR_DMA_RESOURCE_CONFLICT ((NTSTATUS)0xC004001BL) + +// +// MessageId: IO_ERR_INTERRUPT_RESOURCE_CONFLICT +// +// MessageText: +// +// The device could not allocate one or more required resources due to conflicts +// with other devices. The device interrupt setting of '%2' could not be +// satisified due to a conflict with Driver '%3'. +// +#define IO_ERR_INTERRUPT_RESOURCE_CONFLICT ((NTSTATUS)0xC004001CL) + +// +// MessageId: IO_ERR_MEMORY_RESOURCE_CONFLICT +// +// MessageText: +// +// The device could not allocate one or more required resources due to conflicts +// with other devices. The device memory setting of '%2' could not be +// satisified due to a conflict with Driver '%3'. +// +#define IO_ERR_MEMORY_RESOURCE_CONFLICT ((NTSTATUS)0xC004001DL) + +// +// MessageId: IO_ERR_PORT_RESOURCE_CONFLICT +// +// MessageText: +// +// The device could not allocate one or more required resources due to conflicts +// with other devices. The device port setting of '%2' could not be +// satisified due to a conflict with Driver '%3'. +// +#define IO_ERR_PORT_RESOURCE_CONFLICT ((NTSTATUS)0xC004001EL) + +// +// MessageId: IO_BAD_BLOCK_WITH_NAME +// +// MessageText: +// +// The file %2 on device %1 contains a bad disk block. +// +#define IO_BAD_BLOCK_WITH_NAME ((NTSTATUS)0xC004001FL) + +// +// MessageId: IO_FILE_SYSTEM_CORRUPT +// +// MessageText: +// +// The file system structure on the disk is corrupt and unusable. +// Please run the chkdsk utility on the device %1 with label "%2". +// +#define IO_FILE_SYSTEM_CORRUPT ((NTSTATUS)0xC0040029L) + +// +// MessageId: IO_FILE_QUOTA_CORRUPT +// +// MessageText: +// +// The user disk quota information is unusable. +// To ensure accuracy, the file system quota information on the device %1 with label "%2" will +// be rebuilt. +// +#define IO_FILE_QUOTA_CORRUPT ((NTSTATUS)0xC004002AL) + +// +// MessageId: IO_SYSTEM_SLEEP_FAILED +// +// MessageText: +// +// The system sleep operation failed +// +#define IO_SYSTEM_SLEEP_FAILED ((NTSTATUS)0xC004002BL) + +// +// MessageId: IO_DUMP_POINTER_FAILURE +// +// MessageText: +// +// The system could not get file retrieval pointers for the dump file. +// +#define IO_DUMP_POINTER_FAILURE ((NTSTATUS)0xC004002CL) + +// +// MessageId: IO_DUMP_DRIVER_LOAD_FAILURE +// +// MessageText: +// +// The system could not sucessfully load the crash dump driver. +// +#define IO_DUMP_DRIVER_LOAD_FAILURE ((NTSTATUS)0xC004002DL) + +// +// MessageId: IO_DUMP_INITIALIZATION_FAILURE +// +// MessageText: +// +// Crash dump initialization failed! +// +#define IO_DUMP_INITIALIZATION_FAILURE ((NTSTATUS)0xC004002EL) + +// +// MessageId: IO_DUMP_DUMPFILE_CONFLICT +// +// MessageText: +// +// A valid crash dump was found in the paging file while trying to configure +// a direct dump. Direct dump is disabled! This occurs when the direct dump +// option is set in the registry but a stop error occured before configuration +// completed +// +#define IO_DUMP_DUMPFILE_CONFLICT ((NTSTATUS)0xC004002FL) + +// +// MessageId: IO_DUMP_DIRECT_CONFIG_FAILED +// +// MessageText: +// +// Direct dump configuration failed. Validate the filename and make sure the target device +// is not a Fault Tolerant set member, remote, or floppy device. The failure may +// be because there is not enough room on the dump device to create the dump file. +// +#define IO_DUMP_DIRECT_CONFIG_FAILED ((NTSTATUS)0xC0040030L) + +// +// MessageId: IO_DUMP_PAGE_CONFIG_FAILED +// +// MessageText: +// +// Configuring the Page file for crash dump failed. Make sure there is a page +// file on the boot partition and that is large enough to contain all physical +// memory. +// +#define IO_DUMP_PAGE_CONFIG_FAILED ((NTSTATUS)0xC0040031L) + +// +// MessageId: IO_FILE_SYSTEM_CORRUPT_WITH_NAME +// +// MessageText: +// +// The file system structure on the disk is corrupt and unusable. +// Please run the chkdsk utility on the volume %2. +// +#define IO_FILE_SYSTEM_CORRUPT_WITH_NAME ((NTSTATUS)0xC0040037L) + +// +// MessageId: IO_ERR_THREAD_STUCK_IN_DEVICE_DRIVER +// +// MessageText: +// +// The driver %3 for the %2 device %1 got stuck in an infinite loop. This +// usually indicates a problem with the device itself or with the device +// driver programming the hardware incorrectly. Please check with your +// hardware device vendor for any driver updates. +// +#define IO_ERR_THREAD_STUCK_IN_DEVICE_DRIVER ((NTSTATUS)0xC004006CL) + +// +// MessageId: IO_ERR_PORT_TIMEOUT +// +// MessageText: +// +// The driver for device %1 detected a port timeout due to prolonged inactivity. All associated busses were reset in an effort to clear the condition. +// +#define IO_ERR_PORT_TIMEOUT ((NTSTATUS)0xC0040075L) + + +// codes 0x96, 0x9a defined in minkernel\nlsmsg_base\ntiologc_base.mc + +// +// MessageId: IO_ERROR_DUMP_CREATION_ERROR +// +// MessageText: +// +// Dump file creation failed due to error during dump creation. BugCheckProgress was: %2 +// +#define IO_ERROR_DUMP_CREATION_ERROR ((NTSTATUS)0xC00400A1L) + +// +// MessageId: IO_DUMP_CALLBACK_EXCEPTION +// +// MessageText: +// +// A callback exception was logged during dump. See DumpStack.log for details. +// +#define IO_DUMP_CALLBACK_EXCEPTION ((NTSTATUS)0xC00400A3L) + +// +// MessageId: IO_DUMP_INIT_DEDICATED_DUMP_FAILURE +// +// MessageText: +// +// Configuring the dedicated dump for crash dump failed. Make sure the dedicated +// dump file path is set correctly, or the disk has enough space to create the dump file. +// +#define IO_DUMP_INIT_DEDICATED_DUMP_FAILURE ((NTSTATUS)0xC00400A4L) + +//////////////////////////////////////////////////////// +// Facility MCA +// +// +// INFORMATIONAL codes +// +// +// MessageId: MCA_INFO_CPU_THERMAL_THROTTLING_REMOVED +// +// MessageText: +// +// Machine Check Event reported is a CPU thermal throttling event reported from CPU %1. The CPU has dropped below the temperature limit and throttling has been removed. %2 additional error(s) are contained within the record. +// +#define MCA_INFO_CPU_THERMAL_THROTTLING_REMOVED ((NTSTATUS)0x40050070L) + +// +// MessageId: MCA_INFO_NO_MORE_CORRECTED_ERROR_LOGS +// +// MessageText: +// +// The maximum number of Machine Check Event corrected error events that can be saved to the Event Log has been reached. Logging of these events has been disabled. +// +#define MCA_INFO_NO_MORE_CORRECTED_ERROR_LOGS ((NTSTATUS)0x40050073L) + +// +// MessageId: MCA_INFO_MEMORY_PAGE_MARKED_BAD +// +// MessageText: +// +// The memory page at physical address %1 has encountered multiple corrected hardware error events. As a result it will no longer be used by Windows. +// +#define MCA_INFO_MEMORY_PAGE_MARKED_BAD ((NTSTATUS)0x40050074L) + +// +// WARNING codes +// +// +// MessageId: MCA_WARNING_CACHE +// +// MessageText: +// +// Machine Check Event reported is a corrected level %3 Cache error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_CACHE ((NTSTATUS)0x8005003CL) + +// +// MessageId: MCA_WARNING_TLB +// +// MessageText: +// +// Machine Check Event reported is a corrected level %3 translation Buffer error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_TLB ((NTSTATUS)0x8005003EL) + +// +// MessageId: MCA_WARNING_CPU_BUS +// +// MessageText: +// +// Machine Check Event reported is a corrected External/Internal bus error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_CPU_BUS ((NTSTATUS)0x80050040L) + +// +// MessageId: MCA_WARNING_REGISTER_FILE +// +// MessageText: +// +// Machine Check Event reported is a corrected internal CPU register access error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_REGISTER_FILE ((NTSTATUS)0x80050042L) + +// +// MessageId: MCA_WARNING_MAS +// +// MessageText: +// +// Machine Check Event reported is a corrected Micro Architecture Structure error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_MAS ((NTSTATUS)0x80050044L) + +// +// MessageId: MCA_WARNING_MEM_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is a corrected ECC memory error at an unknown physical address reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_MEM_UNKNOWN ((NTSTATUS)0x80050046L) + +// +// MessageId: MCA_WARNING_MEM_1_2 +// +// MessageText: +// +// Machine Check Event reported is a corrected ECC memory error at physical address %3 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_MEM_1_2 ((NTSTATUS)0x80050048L) + +// +// MessageId: MCA_WARNING_MEM_1_2_5 +// +// MessageText: +// +// Machine Check Event reported is a corrected ECC memory error at physical address %3 on memory module %4 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_MEM_1_2_5 ((NTSTATUS)0x8005004AL) + +// +// MessageId: MCA_WARNING_MEM_1_2_5_4 +// +// MessageText: +// +// Machine Check Event reported is a corrected ECC memory error at physical address %3 on memory module %4 on memory card %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_MEM_1_2_5_4 ((NTSTATUS)0x8005004CL) + +// +// MessageId: MCA_WARNING_SYSTEM_EVENT +// +// MessageText: +// +// Machine Check Event reported is a corrected System Event error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_SYSTEM_EVENT ((NTSTATUS)0x8005004EL) + +// +// MessageId: MCA_WARNING_PCI_BUS_PARITY +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Parity error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_PARITY ((NTSTATUS)0x80050050L) + +// +// MessageId: MCA_WARNING_PCI_BUS_PARITY_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Parity error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_PARITY_NO_INFO ((NTSTATUS)0x80050052L) + +// +// MessageId: MCA_WARNING_PCI_BUS_SERR +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus SERR error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_SERR ((NTSTATUS)0x80050054L) + +// +// MessageId: MCA_WARNING_PCI_BUS_SERR_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus SERR error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_SERR_NO_INFO ((NTSTATUS)0x80050056L) + +// +// MessageId: MCA_WARNING_PCI_BUS_MASTER_ABORT +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Master abort error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_MASTER_ABORT ((NTSTATUS)0x80050058L) + +// +// MessageId: MCA_WARNING_PCI_BUS_MASTER_ABORT_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Master abort error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_MASTER_ABORT_NO_INFO ((NTSTATUS)0x8005005AL) + +// +// MessageId: MCA_WARNING_PCI_BUS_TIMEOUT +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Timeout error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_TIMEOUT ((NTSTATUS)0x8005005CL) + +// +// MessageId: MCA_WARNING_PCI_BUS_TIMEOUT_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI bus Timeout error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_TIMEOUT_NO_INFO ((NTSTATUS)0x8005005EL) + +// +// MessageId: MCA_WARNING_PCI_BUS_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is an unknown corrected PCI bus error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_BUS_UNKNOWN ((NTSTATUS)0x80050060L) + +// +// MessageId: MCA_WARNING_PCI_DEVICE +// +// MessageText: +// +// Machine Check Event reported is a corrected PCI component error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PCI_DEVICE ((NTSTATUS)0x80050062L) + +// +// MessageId: MCA_WARNING_SMBIOS +// +// MessageText: +// +// Machine Check Event reported is a corrected SMBIOS Device Type %3 error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_SMBIOS ((NTSTATUS)0x80050064L) + +// +// MessageId: MCA_WARNING_PLATFORM_SPECIFIC +// +// MessageText: +// +// Machine Check Event reported is a corrected Platform Specific error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_PLATFORM_SPECIFIC ((NTSTATUS)0x80050066L) + +// +// MessageId: MCA_WARNING_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is a corrected error reported to CPU %1. +// +#define MCA_WARNING_UNKNOWN ((NTSTATUS)0x80050068L) + +// +// MessageId: MCA_WARNING_UNKNOWN_NO_CPU +// +// MessageText: +// +// Machine Check Event reported is a corrected error. +// +#define MCA_WARNING_UNKNOWN_NO_CPU ((NTSTATUS)0x8005006AL) + +// +// MessageId: MCA_WARNING_CMC_THRESHOLD_EXCEEDED +// +// MessageText: +// +// Corrected Machine Check Interrupt threshold exceeded. Interrupt has been disabled. Polling mode has been enabled. +// +#define MCA_WARNING_CMC_THRESHOLD_EXCEEDED ((NTSTATUS)0x8005006DL) + +// +// MessageId: MCA_WARNING_CPE_THRESHOLD_EXCEEDED +// +// MessageText: +// +// Corrected Platform Error Interrupt threshold exceeded. Interrupt has been disabled. Polling mode has been enabled. +// +#define MCA_WARNING_CPE_THRESHOLD_EXCEEDED ((NTSTATUS)0x8005006EL) + +// +// MessageId: MCA_WARNING_CPU_THERMAL_THROTTLED +// +// MessageText: +// +// Machine Check Event reported is a CPU thermal throttling event reported from CPU %1. The CPU has exceeded the temperature limit and has been throttled down. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_CPU_THERMAL_THROTTLED ((NTSTATUS)0x8005006FL) + +// +// MessageId: MCA_WARNING_CPU +// +// MessageText: +// +// Machine Check Event reported is a corrected CPU error reported from CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_WARNING_CPU ((NTSTATUS)0x80050071L) + +// +// ERROR codes +// +// +// MessageId: MCA_ERROR_CACHE +// +// MessageText: +// +// Machine Check Event reported is a fatal level %3 Cache error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_CACHE ((NTSTATUS)0xC005003DL) + +// +// MessageId: MCA_ERROR_TLB +// +// MessageText: +// +// Machine Check Event reported is a fatal level %3 translation Buffer error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_TLB ((NTSTATUS)0xC005003FL) + +// +// MessageId: MCA_ERROR_CPU_BUS +// +// MessageText: +// +// Machine Check Event reported is a fatal External/Internal bus error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_CPU_BUS ((NTSTATUS)0xC0050041L) + +// +// MessageId: MCA_ERROR_REGISTER_FILE +// +// MessageText: +// +// Machine Check Event reported is a fatal internal CPU register access error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_REGISTER_FILE ((NTSTATUS)0xC0050043L) + +// +// MessageId: MCA_ERROR_MAS +// +// MessageText: +// +// Machine Check Event reported is a fatal Micro Architecture Structure error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_MAS ((NTSTATUS)0xC0050045L) + +// +// MessageId: MCA_ERROR_MEM_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is a fatal ECC memory error at an unknown physical address reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_MEM_UNKNOWN ((NTSTATUS)0xC0050047L) + +// +// MessageId: MCA_ERROR_MEM_1_2 +// +// MessageText: +// +// Machine Check Event reported is a fatal ECC memory error at physical address %3 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_MEM_1_2 ((NTSTATUS)0xC0050049L) + +// +// MessageId: MCA_ERROR_MEM_1_2_5 +// +// MessageText: +// +// Machine Check Event reported is a fatal ECC memory error at physical address %3 on memory module %4 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_MEM_1_2_5 ((NTSTATUS)0xC005004BL) + +// +// MessageId: MCA_ERROR_MEM_1_2_5_4 +// +// MessageText: +// +// Machine Check Event reported is a fatal ECC memory error at physical address %3 on memory module %4 on memory card %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_MEM_1_2_5_4 ((NTSTATUS)0xC005004DL) + +// +// MessageId: MCA_ERROR_SYSTEM_EVENT +// +// MessageText: +// +// Machine Check Event reported is a fatal System Event error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_SYSTEM_EVENT ((NTSTATUS)0xC005004FL) + +// +// MessageId: MCA_ERROR_PCI_BUS_PARITY +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Parity error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_PARITY ((NTSTATUS)0xC0050051L) + +// +// MessageId: MCA_ERROR_PCI_BUS_PARITY_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Parity error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_PARITY_NO_INFO ((NTSTATUS)0xC0050053L) + +// +// MessageId: MCA_ERROR_PCI_BUS_SERR +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus SERR error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_SERR ((NTSTATUS)0xC0050055L) + +// +// MessageId: MCA_ERROR_PCI_BUS_SERR_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus SERR error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_SERR_NO_INFO ((NTSTATUS)0xC0050057L) + +// +// MessageId: MCA_ERROR_PCI_BUS_MASTER_ABORT +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Master abort error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_MASTER_ABORT ((NTSTATUS)0xC0050059L) + +// +// MessageId: MCA_ERROR_PCI_BUS_MASTER_ABORT_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Master abort error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_MASTER_ABORT_NO_INFO ((NTSTATUS)0xC005005BL) + +// +// MessageId: MCA_ERROR_PCI_BUS_TIMEOUT +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Timeout error during a transaction type %3 at address %4 on PCI bus %5 reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_TIMEOUT ((NTSTATUS)0xC005005DL) + +// +// MessageId: MCA_ERROR_PCI_BUS_TIMEOUT_NO_INFO +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI bus Timeout error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_TIMEOUT_NO_INFO ((NTSTATUS)0xC005005FL) + +// +// MessageId: MCA_ERROR_PCI_BUS_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is an unknown fatal PCI bus error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_BUS_UNKNOWN ((NTSTATUS)0xC0050061L) + +// +// MessageId: MCA_ERROR_PCI_DEVICE +// +// MessageText: +// +// Machine Check Event reported is a fatal PCI component error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PCI_DEVICE ((NTSTATUS)0xC0050063L) + +// +// MessageId: MCA_ERROR_SMBIOS +// +// MessageText: +// +// Machine Check Event reported is a fatal SMBIOS Device Type %3 error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_SMBIOS ((NTSTATUS)0xC0050065L) + +// +// MessageId: MCA_ERROR_PLATFORM_SPECIFIC +// +// MessageText: +// +// Machine Check Event reported is a fatal Platform Specific error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_PLATFORM_SPECIFIC ((NTSTATUS)0xC0050067L) + +// +// MessageId: MCA_ERROR_UNKNOWN +// +// MessageText: +// +// Machine Check Event reported is a fatal error reported to CPU %1. +// +#define MCA_ERROR_UNKNOWN ((NTSTATUS)0xC0050069L) + +// +// MessageId: MCA_ERROR_UNKNOWN_NO_CPU +// +// MessageText: +// +// Machine Check Event reported is a fatal error. +// +#define MCA_ERROR_UNKNOWN_NO_CPU ((NTSTATUS)0xC005006BL) + +// +// MessageId: MCA_ERROR_CPU +// +// MessageText: +// +// Machine Check Event reported is a fatal CPU error reported to CPU %1. %2 additional error(s) are contained within the record. +// +#define MCA_ERROR_CPU ((NTSTATUS)0xC0050072L) + +// +// MessageId: MCA_MEMORYHIERARCHY_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal memory hierarchy error.%r Trasaction Type: %1%r Memory Hierarchy Level: %2%r Request Type: %3%r Address: %4 +// +#define MCA_MEMORYHIERARCHY_ERROR ((NTSTATUS)0xC0050078L) + +// +// MessageId: MCA_TLB_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal TLB error.%r Transaction Type: %1%r Memory Hierarchy Level: %2%r Address: %3 +// +#define MCA_TLB_ERROR ((NTSTATUS)0xC0050079L) + +// +// MessageId: MCA_BUS_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal Bus or Interconnect error.%r Memory Hierarchy Level: %1%r Participation: %2%r Request Type: %3%r Memory/IO: %4%r Address: %5 +// +#define MCA_BUS_ERROR ((NTSTATUS)0xC005007AL) + +// +// MessageId: MCA_BUS_TIMEOUT_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal Bus or Interconnect timeout error.%r Memory Hierarchy Level: %1%r Participation: %2%r Request Type: %3%r Memory/IO: %4%r Address: %5 +// +#define MCA_BUS_TIMEOUT_ERROR ((NTSTATUS)0xC005007BL) + +// +// MessageId: MCA_INTERNALTIMER_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal internal watchdog timer error. +// +#define MCA_INTERNALTIMER_ERROR ((NTSTATUS)0xC005007CL) + +// +// MessageId: MCA_MICROCODE_ROM_PARITY_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal microsoft ROM parity error. +// +#define MCA_MICROCODE_ROM_PARITY_ERROR ((NTSTATUS)0xC005007EL) + +// +// MessageId: MCA_EXTERNAL_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal condition. A processor received an external signal that an unrecoverable error has occurred. +// +#define MCA_EXTERNAL_ERROR ((NTSTATUS)0xC005007FL) + +// +// MessageId: MCA_FRC_ERROR +// +// MessageText: +// +// Machine Check Event reported is a fatal functional redundancy check error. +// +#define MCA_FRC_ERROR ((NTSTATUS)0xC0050080L) + +//////////////////////////////////////////////////////// +// Facility VOLMGR +// +// +// WARNING codes +// +// +// MessageId: VOLMGR_KSR_ERROR +// +// MessageText: +// +// There was an error validating KSR data - operation %2 status %3. +// +#define VOLMGR_KSR_ERROR ((NTSTATUS)0x80380001L) + +// +// MessageId: VOLMGR_KSR_READ_ERROR +// +// MessageText: +// +// Failed to read KSR data - disk %2 sector %3 operation %4 status %5. +// +#define VOLMGR_KSR_READ_ERROR ((NTSTATUS)0x80380002L) + +// +// MessageId: VOLMGR_KSR_BYPASS +// +// MessageText: +// +// A %2 operation took place during KSR - disk %3 offset %4. +// +#define VOLMGR_KSR_BYPASS ((NTSTATUS)0x80380003L) + +#endif /* _NTIOLOGC_ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntstatus.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntstatus.h new file mode 100644 index 0000000000000000000000000000000000000000..c6c0b3a5b6974109adbbea7446d584f5491ec0de --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntstatus.h @@ -0,0 +1,27728 @@ +/*++ BUILD Version: 0005 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + ntstatus.h + +Abstract: + + Constant definitions for the NTSTATUS values. + +Author: + + Portable Systems Group 30-Mar-1989 + +Revision History: + +Notes: + + This file is generated by the MC tool from the ntstatus.mc file. + + Please add new error values to the end of the file. To do otherwise + will jumble the error values. + + Search for "**** New SYSTEM error codes can be inserted here ****" to + find where to insert new error codes +--*/ + +#ifndef _NTSTATUS_ +#define _NTSTATUS_ + +#if defined (_MSC_VER) && (_MSC_VER >= 1020) +#pragma once +#endif + +#ifndef WIN32_NO_STATUS // winnt +// begin_ntsecapi + +/*lint -save -e767 */ // Don't complain about different definitions // winnt + + +///////////////////////////////////////////////////////////////////////// +// +// Please update FACILITY_MAXIMUM_VALUE when adding new facility values. +// (This value should be greater than the highest value above) +// +// Facility 0x17 is reserved and used in isolation lib as +// PIE=0x17:FACILITY_MANIFEST_ERROR_CODE +// +// +///////////////////////////////////////////////////////////////////////// + +///////////////////////////////////////////////////////////////////////// +// +// Standard Success values +// +// +///////////////////////////////////////////////////////////////////////// + + +// +// The success status codes 0 - 63 are reserved for wait completion status. +// FacilityCodes 0x5 - 0xF have been allocated by various drivers. +// +#define STATUS_WAIT_0 ((NTSTATUS)0x00000000L) // winnt + +// +// Values are 32 bit values laid out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+-+-+-----------------------+-------------------------------+ +// |Sev|C|R| Facility | Code | +// +---+-+-+-----------------------+-------------------------------+ +// +// where +// +// Sev - is the severity code +// +// 00 - Success +// 01 - Informational +// 10 - Warning +// 11 - Error +// +// C - is the Customer code flag +// +// R - is a reserved bit +// +// Facility - is the facility code +// +// Code - is the facility's status code +// +// +// Define the facility codes +// +#define FACILITY_DEBUGGER 0x1 +#define FACILITY_RPC_RUNTIME 0x2 +#define FACILITY_RPC_STUBS 0x3 +#define FACILITY_IO_ERROR_CODE 0x4 +#define FACILITY_CODCLASS_ERROR_CODE 0x6 +#define FACILITY_NTWIN32 0x7 +#define FACILITY_NTCERT 0x8 +#define FACILITY_NTSSPI 0x9 +#define FACILITY_TERMINAL_SERVER 0xA +#define FACILTIY_MUI_ERROR_CODE 0xB +#define FACILITY_USB_ERROR_CODE 0x10 +#define FACILITY_HID_ERROR_CODE 0x11 +#define FACILITY_FIREWIRE_ERROR_CODE 0x12 +#define FACILITY_CLUSTER_ERROR_CODE 0x13 +#define FACILITY_ACPI_ERROR_CODE 0x14 +#define FACILITY_SXS_ERROR_CODE 0x15 +#define FACILITY_TRANSACTION 0x19 +#define FACILITY_COMMONLOG 0x1A +#define FACILITY_VIDEO 0x1B +#define FACILITY_FILTER_MANAGER 0x1C +#define FACILITY_MONITOR 0x1D +#define FACILITY_GRAPHICS_KERNEL 0x1E +#define FACILITY_CAMERA 0x1F +#define FACILITY_DRIVER_FRAMEWORK 0x20 +#define FACILITY_FVE_ERROR_CODE 0x21 +#define FACILITY_FWP_ERROR_CODE 0x22 +#define FACILITY_NDIS_ERROR_CODE 0x23 +#define FACILITY_QUIC_ERROR_CODE 0x24 +#define FACILITY_TPM 0x29 +#define FACILITY_RTPM 0x2A +#define FACILITY_HYPERVISOR 0x35 +#define FACILITY_IPSEC 0x36 +#define FACILITY_VIRTUALIZATION 0x37 +#define FACILITY_VOLMGR 0x38 +#define FACILITY_BCD_ERROR_CODE 0x39 +#define FACILITY_WIN32K_NTUSER 0x3E +#define FACILITY_WIN32K_NTGDI 0x3F +#define FACILITY_RESUME_KEY_FILTER 0x40 +#define FACILITY_RDBSS 0x41 +#define FACILITY_BTH_ATT 0x42 +#define FACILITY_SECUREBOOT 0x43 +#define FACILITY_AUDIO_KERNEL 0x44 +#define FACILITY_VSM 0x45 +#define FACILITY_NT_IORING 0x46 +#define FACILITY_VOLSNAP 0x50 +#define FACILITY_SDBUS 0x51 +#define FACILITY_SHARED_VHDX 0x5C +#define FACILITY_SMB 0x5D +#define FACILITY_XVS 0x5E +#define FACILITY_INTERIX 0x99 +#define FACILITY_SPACES 0xE7 +#define FACILITY_SECURITY_CORE 0xE8 +#define FACILITY_SYSTEM_INTEGRITY 0xE9 +#define FACILITY_LICENSING 0xEA +#define FACILITY_PLATFORM_MANIFEST 0xEB +#define FACILITY_APP_EXEC 0xEC +#define FACILITY_UNIONFS 0xED +#define FACILITY_PLATFORM_RUNTIME_MECHANISM 0xEE +#define FACILITY_WIN_ACCEL 0xEF +#define FACILITY_MAXIMUM_VALUE 0xF0 + + +// +// Define the severity codes +// +#define STATUS_SEVERITY_SUCCESS 0x0 +#define STATUS_SEVERITY_INFORMATIONAL 0x1 +#define STATUS_SEVERITY_WARNING 0x2 +#define STATUS_SEVERITY_ERROR 0x3 + + +// +// MessageId: STATUS_SUCCESS +// +// MessageText: +// +// STATUS_SUCCESS +// +#define STATUS_SUCCESS ((NTSTATUS)0x00000000L) // ntsubauth + +// +// MessageId: STATUS_WAIT_1 +// +// MessageText: +// +// STATUS_WAIT_1 +// +#define STATUS_WAIT_1 ((NTSTATUS)0x00000001L) + +// +// MessageId: STATUS_WAIT_2 +// +// MessageText: +// +// STATUS_WAIT_2 +// +#define STATUS_WAIT_2 ((NTSTATUS)0x00000002L) + +// +// MessageId: STATUS_WAIT_3 +// +// MessageText: +// +// STATUS_WAIT_3 +// +#define STATUS_WAIT_3 ((NTSTATUS)0x00000003L) + +// +// MessageId: STATUS_WAIT_63 +// +// MessageText: +// +// STATUS_WAIT_63 +// +#define STATUS_WAIT_63 ((NTSTATUS)0x0000003FL) + + +// +// The success status codes 128 - 191 are reserved for wait completion +// status with an abandoned mutant object. +// +#define STATUS_ABANDONED ((NTSTATUS)0x00000080L) + +// +// MessageId: STATUS_ABANDONED_WAIT_0 +// +// MessageText: +// +// STATUS_ABANDONED_WAIT_0 +// +#define STATUS_ABANDONED_WAIT_0 ((NTSTATUS)0x00000080L) // winnt + +// +// MessageId: STATUS_ABANDONED_WAIT_63 +// +// MessageText: +// +// STATUS_ABANDONED_WAIT_63 +// +#define STATUS_ABANDONED_WAIT_63 ((NTSTATUS)0x000000BFL) + + +// +// The success status codes 256, 257, 258, and 258 are reserved for +// User APC, Kernel APC, Alerted, and Timeout. +// +// +// MessageId: STATUS_USER_APC +// +// MessageText: +// +// STATUS_USER_APC +// +#define STATUS_USER_APC ((NTSTATUS)0x000000C0L) // winnt + +// +// MessageId: STATUS_ALREADY_COMPLETE +// +// MessageText: +// +// The requested action was completed by an earlier operation. +// +#define STATUS_ALREADY_COMPLETE ((NTSTATUS)0x000000FFL) + +// +// MessageId: STATUS_KERNEL_APC +// +// MessageText: +// +// STATUS_KERNEL_APC +// +#define STATUS_KERNEL_APC ((NTSTATUS)0x00000100L) + +// +// MessageId: STATUS_ALERTED +// +// MessageText: +// +// STATUS_ALERTED +// +#define STATUS_ALERTED ((NTSTATUS)0x00000101L) + +// +// MessageId: STATUS_TIMEOUT +// +// MessageText: +// +// STATUS_TIMEOUT +// +#define STATUS_TIMEOUT ((NTSTATUS)0x00000102L) // winnt + +// +// MessageId: STATUS_PENDING +// +// MessageText: +// +// The operation that was requested is pending completion. +// +#define STATUS_PENDING ((NTSTATUS)0x00000103L) // winnt + +// +// MessageId: STATUS_REPARSE +// +// MessageText: +// +// A reparse should be performed by the Object Manager since the name of the file resulted in a symbolic link. +// +#define STATUS_REPARSE ((NTSTATUS)0x00000104L) + +// +// MessageId: STATUS_MORE_ENTRIES +// +// MessageText: +// +// Returned by enumeration APIs to indicate more information is available to successive calls. +// +#define STATUS_MORE_ENTRIES ((NTSTATUS)0x00000105L) + +// +// MessageId: STATUS_NOT_ALL_ASSIGNED +// +// MessageText: +// +// Indicates not all privileges or groups referenced are assigned to the caller. +// This allows, for example, all privileges to be disabled without having to know exactly which privileges are assigned. +// +#define STATUS_NOT_ALL_ASSIGNED ((NTSTATUS)0x00000106L) + +// +// MessageId: STATUS_SOME_NOT_MAPPED +// +// MessageText: +// +// Some of the information to be translated has not been translated. +// +#define STATUS_SOME_NOT_MAPPED ((NTSTATUS)0x00000107L) + +// +// MessageId: STATUS_OPLOCK_BREAK_IN_PROGRESS +// +// MessageText: +// +// An open/create operation completed while an oplock break is underway. +// +#define STATUS_OPLOCK_BREAK_IN_PROGRESS ((NTSTATUS)0x00000108L) + +// +// MessageId: STATUS_VOLUME_MOUNTED +// +// MessageText: +// +// A new volume has been mounted by a file system. +// +#define STATUS_VOLUME_MOUNTED ((NTSTATUS)0x00000109L) + +// +// MessageId: STATUS_RXACT_COMMITTED +// +// MessageText: +// +// This success level status indicates that the transaction state already exists for the registry sub-tree, but that a transaction commit was previously aborted. The commit has now been completed. +// +#define STATUS_RXACT_COMMITTED ((NTSTATUS)0x0000010AL) + +// +// MessageId: STATUS_NOTIFY_CLEANUP +// +// MessageText: +// +// This indicates that a notify change request has been completed due to closing the handle which made the notify change request. +// +#define STATUS_NOTIFY_CLEANUP ((NTSTATUS)0x0000010BL) + +// +// MessageId: STATUS_NOTIFY_ENUM_DIR +// +// MessageText: +// +// This indicates that a notify change request is being completed and that the information is not being returned in the caller's buffer. +// The caller now needs to enumerate the files to find the changes. +// +#define STATUS_NOTIFY_ENUM_DIR ((NTSTATUS)0x0000010CL) + +// +// MessageId: STATUS_NO_QUOTAS_FOR_ACCOUNT +// +// MessageText: +// +// {No Quotas} +// No system quota limits are specifically set for this account. +// +#define STATUS_NO_QUOTAS_FOR_ACCOUNT ((NTSTATUS)0x0000010DL) + +// +// MessageId: STATUS_PRIMARY_TRANSPORT_CONNECT_FAILED +// +// MessageText: +// +// {Connect Failure on Primary Transport} +// An attempt was made to connect to the remote server %hs on the primary transport, but the connection failed. +// The computer WAS able to connect on a secondary transport. +// +#define STATUS_PRIMARY_TRANSPORT_CONNECT_FAILED ((NTSTATUS)0x0000010EL) + +// +// MessageId: STATUS_PAGE_FAULT_TRANSITION +// +// MessageText: +// +// Page fault was a transition fault. +// +#define STATUS_PAGE_FAULT_TRANSITION ((NTSTATUS)0x00000110L) + +// +// MessageId: STATUS_PAGE_FAULT_DEMAND_ZERO +// +// MessageText: +// +// Page fault was a demand zero fault. +// +#define STATUS_PAGE_FAULT_DEMAND_ZERO ((NTSTATUS)0x00000111L) + +// +// MessageId: STATUS_PAGE_FAULT_COPY_ON_WRITE +// +// MessageText: +// +// Page fault was a demand zero fault. +// +#define STATUS_PAGE_FAULT_COPY_ON_WRITE ((NTSTATUS)0x00000112L) + +// +// MessageId: STATUS_PAGE_FAULT_GUARD_PAGE +// +// MessageText: +// +// Page fault was a demand zero fault. +// +#define STATUS_PAGE_FAULT_GUARD_PAGE ((NTSTATUS)0x00000113L) + +// +// MessageId: STATUS_PAGE_FAULT_PAGING_FILE +// +// MessageText: +// +// Page fault was satisfied by reading from a secondary storage device. +// +#define STATUS_PAGE_FAULT_PAGING_FILE ((NTSTATUS)0x00000114L) + +// +// MessageId: STATUS_CACHE_PAGE_LOCKED +// +// MessageText: +// +// Cached page was locked during operation. +// +#define STATUS_CACHE_PAGE_LOCKED ((NTSTATUS)0x00000115L) + +// +// MessageId: STATUS_CRASH_DUMP +// +// MessageText: +// +// Crash dump exists in paging file. +// +#define STATUS_CRASH_DUMP ((NTSTATUS)0x00000116L) + +// +// MessageId: STATUS_BUFFER_ALL_ZEROS +// +// MessageText: +// +// Specified buffer contains all zeros. +// +#define STATUS_BUFFER_ALL_ZEROS ((NTSTATUS)0x00000117L) + +// +// MessageId: STATUS_REPARSE_OBJECT +// +// MessageText: +// +// A reparse should be performed by the Object Manager since the name of the file resulted in a symbolic link. +// +#define STATUS_REPARSE_OBJECT ((NTSTATUS)0x00000118L) + +// +// MessageId: STATUS_RESOURCE_REQUIREMENTS_CHANGED +// +// MessageText: +// +// The device has succeeded a query-stop and its resource requirements have changed. +// +#define STATUS_RESOURCE_REQUIREMENTS_CHANGED ((NTSTATUS)0x00000119L) + +// +// MessageId: STATUS_TRANSLATION_COMPLETE +// +// MessageText: +// +// The translator has translated these resources into the global space and no further translations should be performed. +// +#define STATUS_TRANSLATION_COMPLETE ((NTSTATUS)0x00000120L) + +// +// MessageId: STATUS_DS_MEMBERSHIP_EVALUATED_LOCALLY +// +// MessageText: +// +// The directory service evaluated group memberships locally, as it was unable to contact a global catalog server. +// +#define STATUS_DS_MEMBERSHIP_EVALUATED_LOCALLY ((NTSTATUS)0x00000121L) + +// +// MessageId: STATUS_NOTHING_TO_TERMINATE +// +// MessageText: +// +// A process being terminated has no threads to terminate. +// +#define STATUS_NOTHING_TO_TERMINATE ((NTSTATUS)0x00000122L) + +// +// MessageId: STATUS_PROCESS_NOT_IN_JOB +// +// MessageText: +// +// The specified process is not part of a job. +// +#define STATUS_PROCESS_NOT_IN_JOB ((NTSTATUS)0x00000123L) + +// +// MessageId: STATUS_PROCESS_IN_JOB +// +// MessageText: +// +// The specified process is part of a job. +// +#define STATUS_PROCESS_IN_JOB ((NTSTATUS)0x00000124L) + +// +// MessageId: STATUS_VOLSNAP_HIBERNATE_READY +// +// MessageText: +// +// {Volume Shadow Copy Service} +// The system is now ready for hibernation. +// +#define STATUS_VOLSNAP_HIBERNATE_READY ((NTSTATUS)0x00000125L) + +// +// MessageId: STATUS_FSFILTER_OP_COMPLETED_SUCCESSFULLY +// +// MessageText: +// +// A file system or file system filter driver has successfully completed an FsFilter operation. +// +#define STATUS_FSFILTER_OP_COMPLETED_SUCCESSFULLY ((NTSTATUS)0x00000126L) + +// +// MessageId: STATUS_INTERRUPT_VECTOR_ALREADY_CONNECTED +// +// MessageText: +// +// The specified interrupt vector was already connected. +// +#define STATUS_INTERRUPT_VECTOR_ALREADY_CONNECTED ((NTSTATUS)0x00000127L) + +// +// MessageId: STATUS_INTERRUPT_STILL_CONNECTED +// +// MessageText: +// +// The specified interrupt vector is still connected. +// +#define STATUS_INTERRUPT_STILL_CONNECTED ((NTSTATUS)0x00000128L) + +// +// MessageId: STATUS_PROCESS_CLONED +// +// MessageText: +// +// The current process is a cloned process. +// +#define STATUS_PROCESS_CLONED ((NTSTATUS)0x00000129L) + +// +// MessageId: STATUS_FILE_LOCKED_WITH_ONLY_READERS +// +// MessageText: +// +// The file was locked and all users of the file can only read. +// +#define STATUS_FILE_LOCKED_WITH_ONLY_READERS ((NTSTATUS)0x0000012AL) + +// +// MessageId: STATUS_FILE_LOCKED_WITH_WRITERS +// +// MessageText: +// +// The file was locked and at least one user of the file can write. +// +#define STATUS_FILE_LOCKED_WITH_WRITERS ((NTSTATUS)0x0000012BL) + +// +// MessageId: STATUS_VALID_IMAGE_HASH +// +// MessageText: +// +// The file image hash is valid. +// +#define STATUS_VALID_IMAGE_HASH ((NTSTATUS)0x0000012CL) + +// +// MessageId: STATUS_VALID_CATALOG_HASH +// +// MessageText: +// +// The file catalog hash is valid. +// +#define STATUS_VALID_CATALOG_HASH ((NTSTATUS)0x0000012DL) + +// +// MessageId: STATUS_VALID_STRONG_CODE_HASH +// +// MessageText: +// +// The file hash is valid and uses strong code integrity. +// +#define STATUS_VALID_STRONG_CODE_HASH ((NTSTATUS)0x0000012EL) + +// +// MessageId: STATUS_GHOSTED +// +// MessageText: +// +// At least a portion of IO range intersects with a ghosted file range. +// +#define STATUS_GHOSTED ((NTSTATUS)0x0000012FL) + +// +// MessageId: STATUS_DATA_OVERWRITTEN +// +// MessageText: +// +// A completed operation may have overwritten previous data. +// +#define STATUS_DATA_OVERWRITTEN ((NTSTATUS)0x00000130L) + +// +// MessageId: STATUS_RESOURCEMANAGER_READ_ONLY +// +// MessageText: +// +// The specified ResourceManager made no changes or updates to the resource under this transaction. +// +#define STATUS_RESOURCEMANAGER_READ_ONLY ((NTSTATUS)0x00000202L) + +// +// MessageId: STATUS_RING_PREVIOUSLY_EMPTY +// +// MessageText: +// +// The specified ring buffer was empty before the packet was successfully inserted. +// +#define STATUS_RING_PREVIOUSLY_EMPTY ((NTSTATUS)0x00000210L) + +// +// MessageId: STATUS_RING_PREVIOUSLY_FULL +// +// MessageText: +// +// The specified ring buffer was full before the packet was successfully removed. +// +#define STATUS_RING_PREVIOUSLY_FULL ((NTSTATUS)0x00000211L) + +// +// MessageId: STATUS_RING_PREVIOUSLY_ABOVE_QUOTA +// +// MessageText: +// +// The specified ring buffer has dropped below its quota of outstanding transactions. +// +#define STATUS_RING_PREVIOUSLY_ABOVE_QUOTA ((NTSTATUS)0x00000212L) + +// +// MessageId: STATUS_RING_NEWLY_EMPTY +// +// MessageText: +// +// The specified ring buffer has, with the removal of the current packet, now become empty. +// +#define STATUS_RING_NEWLY_EMPTY ((NTSTATUS)0x00000213L) + +// +// MessageId: STATUS_RING_SIGNAL_OPPOSITE_ENDPOINT +// +// MessageText: +// +// The specified ring buffer was either previously empty or previously full which implies that the caller should signal the opposite endpoint. +// +#define STATUS_RING_SIGNAL_OPPOSITE_ENDPOINT ((NTSTATUS)0x00000214L) + +// +// MessageId: STATUS_OPLOCK_SWITCHED_TO_NEW_HANDLE +// +// MessageText: +// +// The oplock that was associated with this handle is now associated with a different handle. +// +#define STATUS_OPLOCK_SWITCHED_TO_NEW_HANDLE ((NTSTATUS)0x00000215L) + +// +// MessageId: STATUS_OPLOCK_HANDLE_CLOSED +// +// MessageText: +// +// The handle with which this oplock was associated has been closed. The oplock is now broken. +// +#define STATUS_OPLOCK_HANDLE_CLOSED ((NTSTATUS)0x00000216L) + +// +// MessageId: STATUS_WAIT_FOR_OPLOCK +// +// MessageText: +// +// An operation is blocked waiting for an oplock. +// +#define STATUS_WAIT_FOR_OPLOCK ((NTSTATUS)0x00000367L) + +// +// MessageId: STATUS_REPARSE_GLOBAL +// +// MessageText: +// +// A reparse should be performed by the Object Manager from the global root to escape the container name space. +// +#define STATUS_REPARSE_GLOBAL ((NTSTATUS)0x00000368L) + +// +// MessageId: STATUS_PAGE_FAULT_RETRY +// +// MessageText: +// +// Page fault should be retried. +// +#define STATUS_PAGE_FAULT_RETRY ((NTSTATUS)0x00000369L) + +// +// MessageId: DBG_EXCEPTION_HANDLED +// +// MessageText: +// +// Debugger handled exception +// +#define DBG_EXCEPTION_HANDLED ((NTSTATUS)0x00010001L) // winnt + +// +// MessageId: DBG_CONTINUE +// +// MessageText: +// +// Debugger continued +// +#define DBG_CONTINUE ((NTSTATUS)0x00010002L) // winnt + +// +// MessageId: STATUS_FLT_IO_COMPLETE +// +// MessageText: +// +// The IO was completed by a filter. +// +#define STATUS_FLT_IO_COMPLETE ((NTSTATUS)0x001C0001L) + +///////////////////////////////////////////////////////////////////////// +// +// Standard Information values +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: STATUS_OBJECT_NAME_EXISTS +// +// MessageText: +// +// {Object Exists} +// An attempt was made to create an object and the object name already existed. +// +#define STATUS_OBJECT_NAME_EXISTS ((NTSTATUS)0x40000000L) + +// +// MessageId: STATUS_THREAD_WAS_SUSPENDED +// +// MessageText: +// +// {Thread Suspended} +// A thread termination occurred while the thread was suspended. The thread was resumed, and termination proceeded. +// +#define STATUS_THREAD_WAS_SUSPENDED ((NTSTATUS)0x40000001L) + +// +// MessageId: STATUS_WORKING_SET_LIMIT_RANGE +// +// MessageText: +// +// {Working Set Range Error} +// An attempt was made to set the working set minimum or maximum to values which are outside of the allowable range. +// +#define STATUS_WORKING_SET_LIMIT_RANGE ((NTSTATUS)0x40000002L) + +// +// MessageId: STATUS_IMAGE_NOT_AT_BASE +// +// MessageText: +// +// {Image Relocated} +// An image file could not be mapped at the address specified in the image file. Local fixups must be performed on this image. +// +#define STATUS_IMAGE_NOT_AT_BASE ((NTSTATUS)0x40000003L) + +// +// MessageId: STATUS_RXACT_STATE_CREATED +// +// MessageText: +// +// This informational level status indicates that a specified registry sub-tree transaction state did not yet exist and had to be created. +// +#define STATUS_RXACT_STATE_CREATED ((NTSTATUS)0x40000004L) + +// +// MessageId: STATUS_SEGMENT_NOTIFICATION +// +// MessageText: +// +// {Segment Load} +// A virtual DOS machine (VDM) is loading, unloading, or moving an MS-DOS or Win16 program segment image. +// An exception is raised so a debugger can load, unload or track symbols and breakpoints within these 16-bit segments. +// +#define STATUS_SEGMENT_NOTIFICATION ((NTSTATUS)0x40000005L) // winnt + +// +// MessageId: STATUS_LOCAL_USER_SESSION_KEY +// +// MessageText: +// +// {Local Session Key} +// A user session key was requested for a local RPC connection. The session key returned is a constant value and not unique to this connection. +// +#define STATUS_LOCAL_USER_SESSION_KEY ((NTSTATUS)0x40000006L) + +// +// MessageId: STATUS_BAD_CURRENT_DIRECTORY +// +// MessageText: +// +// {Invalid Current Directory} +// The process cannot switch to the startup current directory %hs. +// Select OK to set current directory to %hs, or select CANCEL to exit. +// +#define STATUS_BAD_CURRENT_DIRECTORY ((NTSTATUS)0x40000007L) + +// +// MessageId: STATUS_SERIAL_MORE_WRITES +// +// MessageText: +// +// {Serial IOCTL Complete} +// A serial I/O operation was completed by another write to a serial port. +// (The IOCTL_SERIAL_XOFF_COUNTER reached zero.) +// +#define STATUS_SERIAL_MORE_WRITES ((NTSTATUS)0x40000008L) + +// +// MessageId: STATUS_REGISTRY_RECOVERED +// +// MessageText: +// +// {Registry Recovery} +// One of the files containing the system's Registry data had to be recovered by use of a log or alternate copy. The recovery was successful. +// +#define STATUS_REGISTRY_RECOVERED ((NTSTATUS)0x40000009L) + +// +// MessageId: STATUS_FT_READ_RECOVERY_FROM_BACKUP +// +// MessageText: +// +// {Redundant Read} +// To satisfy a read request, the NT fault-tolerant file system successfully read the requested data from a redundant copy. +// This was done because the file system encountered a failure on a member of the fault-tolerant volume, but was unable to reassign the failing area of the device. +// +#define STATUS_FT_READ_RECOVERY_FROM_BACKUP ((NTSTATUS)0x4000000AL) + +// +// MessageId: STATUS_FT_WRITE_RECOVERY +// +// MessageText: +// +// {Redundant Write} +// To satisfy a write request, the NT fault-tolerant file system successfully wrote a redundant copy of the information. +// This was done because the file system encountered a failure on a member of the fault-tolerant volume, but was not able to reassign the failing area of the device. +// +#define STATUS_FT_WRITE_RECOVERY ((NTSTATUS)0x4000000BL) + +// +// MessageId: STATUS_SERIAL_COUNTER_TIMEOUT +// +// MessageText: +// +// {Serial IOCTL Timeout} +// A serial I/O operation completed because the time-out period expired. (The IOCTL_SERIAL_XOFF_COUNTER had not reached zero.) +// +#define STATUS_SERIAL_COUNTER_TIMEOUT ((NTSTATUS)0x4000000CL) + +// +// MessageId: STATUS_NULL_LM_PASSWORD +// +// MessageText: +// +// {Password Too Complex} +// The Windows password is too complex to be converted to a LAN Manager password. The LAN Manager password returned is a NULL string. +// +#define STATUS_NULL_LM_PASSWORD ((NTSTATUS)0x4000000DL) + +// +// MessageId: STATUS_IMAGE_MACHINE_TYPE_MISMATCH +// +// MessageText: +// +// {Machine Type Mismatch} +// The image file %hs is valid, but is for a machine type other than the current machine. Select OK to continue, or CANCEL to fail the DLL load. +// +#define STATUS_IMAGE_MACHINE_TYPE_MISMATCH ((NTSTATUS)0x4000000EL) + +// +// MessageId: STATUS_RECEIVE_PARTIAL +// +// MessageText: +// +// {Partial Data Received} +// The network transport returned partial data to its client. The remaining data will be sent later. +// +#define STATUS_RECEIVE_PARTIAL ((NTSTATUS)0x4000000FL) + +// +// MessageId: STATUS_RECEIVE_EXPEDITED +// +// MessageText: +// +// {Expedited Data Received} +// The network transport returned data to its client that was marked as expedited by the remote system. +// +#define STATUS_RECEIVE_EXPEDITED ((NTSTATUS)0x40000010L) + +// +// MessageId: STATUS_RECEIVE_PARTIAL_EXPEDITED +// +// MessageText: +// +// {Partial Expedited Data Received} +// The network transport returned partial data to its client and this data was marked as expedited by the remote system. The remaining data will be sent later. +// +#define STATUS_RECEIVE_PARTIAL_EXPEDITED ((NTSTATUS)0x40000011L) + +// +// MessageId: STATUS_EVENT_DONE +// +// MessageText: +// +// {TDI Event Done} +// The TDI indication has completed successfully. +// +#define STATUS_EVENT_DONE ((NTSTATUS)0x40000012L) + +// +// MessageId: STATUS_EVENT_PENDING +// +// MessageText: +// +// {TDI Event Pending} +// The TDI indication has entered the pending state. +// +#define STATUS_EVENT_PENDING ((NTSTATUS)0x40000013L) + +// +// MessageId: STATUS_CHECKING_FILE_SYSTEM +// +// MessageText: +// +// Checking file system on %wZ +// +#define STATUS_CHECKING_FILE_SYSTEM ((NTSTATUS)0x40000014L) + +// +// MessageId: STATUS_FATAL_APP_EXIT +// +// MessageText: +// +// {Fatal Application Exit} +// %hs +// +#define STATUS_FATAL_APP_EXIT ((NTSTATUS)0x40000015L) // winnt + +// +// MessageId: STATUS_PREDEFINED_HANDLE +// +// MessageText: +// +// The specified registry key is referenced by a predefined handle. +// +#define STATUS_PREDEFINED_HANDLE ((NTSTATUS)0x40000016L) + +// +// MessageId: STATUS_WAS_UNLOCKED +// +// MessageText: +// +// {Page Unlocked} +// The page protection of a locked page was changed to 'No Access' and the page was unlocked from memory and from the process. +// +#define STATUS_WAS_UNLOCKED ((NTSTATUS)0x40000017L) + +// +// MessageId: STATUS_SERVICE_NOTIFICATION +// +// MessageText: +// +// %hs +// +#define STATUS_SERVICE_NOTIFICATION ((NTSTATUS)0x40000018L) + +// +// MessageId: STATUS_WAS_LOCKED +// +// MessageText: +// +// {Page Locked} +// One of the pages to lock was already locked. +// +#define STATUS_WAS_LOCKED ((NTSTATUS)0x40000019L) + +// +// MessageId: STATUS_LOG_HARD_ERROR +// +// MessageText: +// +// Application popup: %1 : %2 +// +#define STATUS_LOG_HARD_ERROR ((NTSTATUS)0x4000001AL) + +// +// MessageId: STATUS_ALREADY_WIN32 +// +// MessageText: +// +// STATUS_ALREADY_WIN32 +// +#define STATUS_ALREADY_WIN32 ((NTSTATUS)0x4000001BL) + +// +// MessageId: STATUS_WX86_UNSIMULATE +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_UNSIMULATE ((NTSTATUS)0x4000001CL) + +// +// MessageId: STATUS_WX86_CONTINUE +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_CONTINUE ((NTSTATUS)0x4000001DL) + +// +// MessageId: STATUS_WX86_SINGLE_STEP +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_SINGLE_STEP ((NTSTATUS)0x4000001EL) + +// +// MessageId: STATUS_WX86_BREAKPOINT +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_BREAKPOINT ((NTSTATUS)0x4000001FL) + +// +// MessageId: STATUS_WX86_EXCEPTION_CONTINUE +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_EXCEPTION_CONTINUE ((NTSTATUS)0x40000020L) + +// +// MessageId: STATUS_WX86_EXCEPTION_LASTCHANCE +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_EXCEPTION_LASTCHANCE ((NTSTATUS)0x40000021L) + +// +// MessageId: STATUS_WX86_EXCEPTION_CHAIN +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_EXCEPTION_CHAIN ((NTSTATUS)0x40000022L) + +// +// MessageId: STATUS_IMAGE_MACHINE_TYPE_MISMATCH_EXE +// +// MessageText: +// +// {Machine Type Mismatch} +// The image file %hs is valid, but is for a machine type other than the current machine. +// +#define STATUS_IMAGE_MACHINE_TYPE_MISMATCH_EXE ((NTSTATUS)0x40000023L) + +// +// MessageId: STATUS_NO_YIELD_PERFORMED +// +// MessageText: +// +// A yield execution was performed and no thread was available to run. +// +#define STATUS_NO_YIELD_PERFORMED ((NTSTATUS)0x40000024L) + +// +// MessageId: STATUS_TIMER_RESUME_IGNORED +// +// MessageText: +// +// The resumable flag to a timer API was ignored. +// +#define STATUS_TIMER_RESUME_IGNORED ((NTSTATUS)0x40000025L) + +// +// MessageId: STATUS_ARBITRATION_UNHANDLED +// +// MessageText: +// +// The arbiter has deferred arbitration of these resources to its parent +// +#define STATUS_ARBITRATION_UNHANDLED ((NTSTATUS)0x40000026L) + +// +// MessageId: STATUS_CARDBUS_NOT_SUPPORTED +// +// MessageText: +// +// The device "%hs" has detected a CardBus card in its slot, but the firmware on this system is not configured to allow the CardBus controller to be run in CardBus mode. +// The operating system will currently accept only 16-bit (R2) pc-cards on this controller. +// +#define STATUS_CARDBUS_NOT_SUPPORTED ((NTSTATUS)0x40000027L) + +// +// MessageId: STATUS_WX86_CREATEWX86TIB +// +// MessageText: +// +// Exception status code used by Win32 x86 emulation subsystem. +// +#define STATUS_WX86_CREATEWX86TIB ((NTSTATUS)0x40000028L) + +// +// MessageId: STATUS_MP_PROCESSOR_MISMATCH +// +// MessageText: +// +// The CPUs in this multiprocessor system are not all the same revision level. To use all processors the operating system restricts itself to the features of the least capable processor in the system. Should problems occur with this system, contact the CPU manufacturer to see if this mix of processors is supported. +// +#define STATUS_MP_PROCESSOR_MISMATCH ((NTSTATUS)0x40000029L) + +// +// MessageId: STATUS_HIBERNATED +// +// MessageText: +// +// The system was put into hibernation. +// +#define STATUS_HIBERNATED ((NTSTATUS)0x4000002AL) + +// +// MessageId: STATUS_RESUME_HIBERNATION +// +// MessageText: +// +// The system was resumed from hibernation. +// +#define STATUS_RESUME_HIBERNATION ((NTSTATUS)0x4000002BL) + +// +// MessageId: STATUS_FIRMWARE_UPDATED +// +// MessageText: +// +// Windows has detected that the system firmware (BIOS) was updated [previous firmware date = %2, current firmware date %3]. +// +#define STATUS_FIRMWARE_UPDATED ((NTSTATUS)0x4000002CL) + +// +// MessageId: STATUS_DRIVERS_LEAKING_LOCKED_PAGES +// +// MessageText: +// +// A device driver is leaking locked I/O pages causing system degradation. The system has automatically enabled tracking code in order to try and catch the culprit. +// +#define STATUS_DRIVERS_LEAKING_LOCKED_PAGES ((NTSTATUS)0x4000002DL) + +// +// MessageId: STATUS_MESSAGE_RETRIEVED +// +// MessageText: +// +// The ALPC message being canceled has already been retrieved from the queue on the other side. +// +#define STATUS_MESSAGE_RETRIEVED ((NTSTATUS)0x4000002EL) + +// +// MessageId: STATUS_SYSTEM_POWERSTATE_TRANSITION +// +// MessageText: +// +// The system power state is transitioning from %2 to %3. +// +#define STATUS_SYSTEM_POWERSTATE_TRANSITION ((NTSTATUS)0x4000002FL) + +// +// MessageId: STATUS_ALPC_CHECK_COMPLETION_LIST +// +// MessageText: +// +// The receive operation was successful. Check the ALPC completion list for the received message. +// +#define STATUS_ALPC_CHECK_COMPLETION_LIST ((NTSTATUS)0x40000030L) + +// +// MessageId: STATUS_SYSTEM_POWERSTATE_COMPLEX_TRANSITION +// +// MessageText: +// +// The system power state is transitioning from %2 to %3 but could enter %4. +// +#define STATUS_SYSTEM_POWERSTATE_COMPLEX_TRANSITION ((NTSTATUS)0x40000031L) + +// +// MessageId: STATUS_ACCESS_AUDIT_BY_POLICY +// +// MessageText: +// +// Access to %1 is monitored by policy rule %2. +// +#define STATUS_ACCESS_AUDIT_BY_POLICY ((NTSTATUS)0x40000032L) + +// +// MessageId: STATUS_ABANDON_HIBERFILE +// +// MessageText: +// +// A valid hibernation file has been invalidated and should be abandoned. +// +#define STATUS_ABANDON_HIBERFILE ((NTSTATUS)0x40000033L) + +// +// MessageId: STATUS_BIZRULES_NOT_ENABLED +// +// MessageText: +// +// Business rule scripts are disabled for the calling application. +// +#define STATUS_BIZRULES_NOT_ENABLED ((NTSTATUS)0x40000034L) + +// +// MessageId: STATUS_FT_READ_FROM_COPY +// +// MessageText: +// +// The specified copy of the requested data was successfully read. +// +#define STATUS_FT_READ_FROM_COPY ((NTSTATUS)0x40000035L) + +// +// MessageId: STATUS_IMAGE_AT_DIFFERENT_BASE +// +// MessageText: +// +// {Image Relocated} +// An image file was mapped at a different address from the one specified in the image file but fixups will still be automatically performed on the image. +// +#define STATUS_IMAGE_AT_DIFFERENT_BASE ((NTSTATUS)0x40000036L) + +// +// MessageId: STATUS_PATCH_DEFERRED +// +// MessageText: +// +// A system patch was successfully loaded but is not applicable to any currently loaded images. +// +#define STATUS_PATCH_DEFERRED ((NTSTATUS)0x40000037L) + +// +// MessageId: STATUS_EMULATION_BREAKPOINT +// +// MessageText: +// +// Exception status code used by ARM64EC emulation subsystem. +// +#define STATUS_EMULATION_BREAKPOINT ((NTSTATUS)0x40000038L) + +// +// MessageId: STATUS_EMULATION_SYSCALL +// +// MessageText: +// +// Exception status code used by ARM64EC emulation subsystem. +// +#define STATUS_EMULATION_SYSCALL ((NTSTATUS)0x40000039L) + +// +// MessageId: STATUS_EMULATION_FLOAT_EXCEPTION +// +// MessageText: +// +// Exception status code used by ARM64EC emulation subsystem. +// +#define STATUS_EMULATION_FLOAT_EXCEPTION ((NTSTATUS)0x4000003AL) + +// +// MessageId: DBG_REPLY_LATER +// +// MessageText: +// +// Debugger will reply later. +// +#define DBG_REPLY_LATER ((NTSTATUS)0x40010001L) // winnt + +// +// MessageId: DBG_UNABLE_TO_PROVIDE_HANDLE +// +// MessageText: +// +// Debugger cannot provide handle. +// +#define DBG_UNABLE_TO_PROVIDE_HANDLE ((NTSTATUS)0x40010002L) + +// +// MessageId: DBG_TERMINATE_THREAD +// +// MessageText: +// +// Debugger terminated thread. +// +#define DBG_TERMINATE_THREAD ((NTSTATUS)0x40010003L) // winnt + +// +// MessageId: DBG_TERMINATE_PROCESS +// +// MessageText: +// +// Debugger terminated process. +// +#define DBG_TERMINATE_PROCESS ((NTSTATUS)0x40010004L) // winnt + +// +// MessageId: DBG_CONTROL_C +// +// MessageText: +// +// Debugger got control C. +// +#define DBG_CONTROL_C ((NTSTATUS)0x40010005L) // winnt + +// +// MessageId: DBG_PRINTEXCEPTION_C +// +// MessageText: +// +// Debugger printed exception on control C. +// +#define DBG_PRINTEXCEPTION_C ((NTSTATUS)0x40010006L) // winnt + +// +// MessageId: DBG_RIPEXCEPTION +// +// MessageText: +// +// Debugger received RIP exception. +// +#define DBG_RIPEXCEPTION ((NTSTATUS)0x40010007L) // winnt + +// +// MessageId: DBG_CONTROL_BREAK +// +// MessageText: +// +// Debugger received control break. +// +#define DBG_CONTROL_BREAK ((NTSTATUS)0x40010008L) // winnt + +// +// MessageId: DBG_COMMAND_EXCEPTION +// +// MessageText: +// +// Debugger command communication exception. +// +#define DBG_COMMAND_EXCEPTION ((NTSTATUS)0x40010009L) // winnt + +// +// MessageId: DBG_PRINTEXCEPTION_WIDE_C +// +// MessageText: +// +// Debugger printed exception on control C. +// +#define DBG_PRINTEXCEPTION_WIDE_C ((NTSTATUS)0x4001000AL) // winnt + +// +// MessageId: STATUS_HEURISTIC_DAMAGE_POSSIBLE +// +// MessageText: +// +// The attempt to commit the Transaction completed, but it is possible that some portion of the transaction tree did not commit successfully due to heuristics. Therefore it is possible that some data modified in the transaction may not have committed, resulting in transactional inconsistency. If possible, check the consistency of the associated data. +// +#define STATUS_HEURISTIC_DAMAGE_POSSIBLE ((NTSTATUS)0x40190001L) + + + +///////////////////////////////////////////////////////////////////////// +// +// Standard Warning values +// +// +// Note: Do NOT use the value 0x80000000L, as this is a non-portable value +// for the NT_SUCCESS macro. Warning values start with a code of 1. +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: STATUS_GUARD_PAGE_VIOLATION +// +// MessageText: +// +// {EXCEPTION} +// Guard Page Exception +// A page of memory that marks the end of a data structure, such as a stack or an array, has been accessed. +// +#define STATUS_GUARD_PAGE_VIOLATION ((NTSTATUS)0x80000001L) // winnt + +// +// MessageId: STATUS_DATATYPE_MISALIGNMENT +// +// MessageText: +// +// {EXCEPTION} +// Alignment Fault +// A datatype misalignment was detected in a load or store instruction. +// +#define STATUS_DATATYPE_MISALIGNMENT ((NTSTATUS)0x80000002L) // winnt + +// +// MessageId: STATUS_BREAKPOINT +// +// MessageText: +// +// {EXCEPTION} +// Breakpoint +// A breakpoint has been reached. +// +#define STATUS_BREAKPOINT ((NTSTATUS)0x80000003L) // winnt + +// +// MessageId: STATUS_SINGLE_STEP +// +// MessageText: +// +// {EXCEPTION} +// Single Step +// A single step or trace operation has just been completed. +// +#define STATUS_SINGLE_STEP ((NTSTATUS)0x80000004L) // winnt + +// +// MessageId: STATUS_BUFFER_OVERFLOW +// +// MessageText: +// +// {Buffer Overflow} +// The data was too large to fit into the specified buffer. +// +#define STATUS_BUFFER_OVERFLOW ((NTSTATUS)0x80000005L) + +// +// MessageId: STATUS_NO_MORE_FILES +// +// MessageText: +// +// {No More Files} +// No more files were found which match the file specification. +// +#define STATUS_NO_MORE_FILES ((NTSTATUS)0x80000006L) + +// +// MessageId: STATUS_WAKE_SYSTEM_DEBUGGER +// +// MessageText: +// +// {Kernel Debugger Awakened} +// the system debugger was awakened by an interrupt. +// +#define STATUS_WAKE_SYSTEM_DEBUGGER ((NTSTATUS)0x80000007L) + +// +// MessageId: STATUS_HANDLES_CLOSED +// +// MessageText: +// +// {Handles Closed} +// Handles to objects have been automatically closed as a result of the requested operation. +// +#define STATUS_HANDLES_CLOSED ((NTSTATUS)0x8000000AL) + +// +// MessageId: STATUS_NO_INHERITANCE +// +// MessageText: +// +// {Non-Inheritable ACL} +// An access control list (ACL) contains no components that can be inherited. +// +#define STATUS_NO_INHERITANCE ((NTSTATUS)0x8000000BL) + +// +// MessageId: STATUS_GUID_SUBSTITUTION_MADE +// +// MessageText: +// +// {GUID Substitution} +// During the translation of a global identifier (GUID) to a Windows security ID (SID), no administratively-defined GUID prefix was found. A substitute prefix was used, which will not compromise system security. However, this may provide a more restrictive access than intended. +// +#define STATUS_GUID_SUBSTITUTION_MADE ((NTSTATUS)0x8000000CL) + +// +// MessageId: STATUS_PARTIAL_COPY +// +// MessageText: +// +// {Partial Copy} +// Due to protection conflicts not all the requested bytes could be copied. +// +#define STATUS_PARTIAL_COPY ((NTSTATUS)0x8000000DL) + +// +// MessageId: STATUS_DEVICE_PAPER_EMPTY +// +// MessageText: +// +// {Out of Paper} +// The printer is out of paper. +// +#define STATUS_DEVICE_PAPER_EMPTY ((NTSTATUS)0x8000000EL) + +// +// MessageId: STATUS_DEVICE_POWERED_OFF +// +// MessageText: +// +// {Device Power Is Off} +// The printer power has been turned off. +// +#define STATUS_DEVICE_POWERED_OFF ((NTSTATUS)0x8000000FL) + +// +// MessageId: STATUS_DEVICE_OFF_LINE +// +// MessageText: +// +// {Device Offline} +// The printer has been taken offline. +// +#define STATUS_DEVICE_OFF_LINE ((NTSTATUS)0x80000010L) + +// +// MessageId: STATUS_DEVICE_BUSY +// +// MessageText: +// +// {Device Busy} +// The device is currently busy. +// +#define STATUS_DEVICE_BUSY ((NTSTATUS)0x80000011L) + +// +// MessageId: STATUS_NO_MORE_EAS +// +// MessageText: +// +// {No More EAs} +// No more extended attributes (EAs) were found for the file. +// +#define STATUS_NO_MORE_EAS ((NTSTATUS)0x80000012L) + +// +// MessageId: STATUS_INVALID_EA_NAME +// +// MessageText: +// +// {Illegal EA} +// The specified extended attribute (EA) name contains at least one illegal character. +// +#define STATUS_INVALID_EA_NAME ((NTSTATUS)0x80000013L) + +// +// MessageId: STATUS_EA_LIST_INCONSISTENT +// +// MessageText: +// +// {Inconsistent EA List} +// The extended attribute (EA) list is inconsistent. +// +#define STATUS_EA_LIST_INCONSISTENT ((NTSTATUS)0x80000014L) + +// +// MessageId: STATUS_INVALID_EA_FLAG +// +// MessageText: +// +// {Invalid EA Flag} +// An invalid extended attribute (EA) flag was set. +// +#define STATUS_INVALID_EA_FLAG ((NTSTATUS)0x80000015L) + +// +// MessageId: STATUS_VERIFY_REQUIRED +// +// MessageText: +// +// {Verifying Disk} +// The media has changed and a verify operation is in progress so no reads or writes may be performed to the device, except those used in the verify operation. +// +#define STATUS_VERIFY_REQUIRED ((NTSTATUS)0x80000016L) + +// +// MessageId: STATUS_EXTRANEOUS_INFORMATION +// +// MessageText: +// +// {Too Much Information} +// The specified access control list (ACL) contained more information than was expected. +// +#define STATUS_EXTRANEOUS_INFORMATION ((NTSTATUS)0x80000017L) + +// +// MessageId: STATUS_RXACT_COMMIT_NECESSARY +// +// MessageText: +// +// This warning level status indicates that the transaction state already exists for the registry sub-tree, but that a transaction commit was previously aborted. +// The commit has NOT been completed, but has not been rolled back either (so it may still be committed if desired). +// +#define STATUS_RXACT_COMMIT_NECESSARY ((NTSTATUS)0x80000018L) + +// +// MessageId: STATUS_NO_MORE_ENTRIES +// +// MessageText: +// +// {No More Entries} +// No more entries are available from an enumeration operation. +// +#define STATUS_NO_MORE_ENTRIES ((NTSTATUS)0x8000001AL) + +// +// MessageId: STATUS_FILEMARK_DETECTED +// +// MessageText: +// +// {Filemark Found} +// A filemark was detected. +// +#define STATUS_FILEMARK_DETECTED ((NTSTATUS)0x8000001BL) + +// +// MessageId: STATUS_MEDIA_CHANGED +// +// MessageText: +// +// {Media Changed} +// The media may have changed. +// +#define STATUS_MEDIA_CHANGED ((NTSTATUS)0x8000001CL) + +// +// MessageId: STATUS_BUS_RESET +// +// MessageText: +// +// {I/O Bus Reset} +// An I/O bus reset was detected. +// +#define STATUS_BUS_RESET ((NTSTATUS)0x8000001DL) + +// +// MessageId: STATUS_END_OF_MEDIA +// +// MessageText: +// +// {End of Media} +// The end of the media was encountered. +// +#define STATUS_END_OF_MEDIA ((NTSTATUS)0x8000001EL) + +// +// MessageId: STATUS_BEGINNING_OF_MEDIA +// +// MessageText: +// +// Beginning of tape or partition has been detected. +// +#define STATUS_BEGINNING_OF_MEDIA ((NTSTATUS)0x8000001FL) + +// +// MessageId: STATUS_MEDIA_CHECK +// +// MessageText: +// +// {Media Changed} +// The media may have changed. +// +#define STATUS_MEDIA_CHECK ((NTSTATUS)0x80000020L) + +// +// MessageId: STATUS_SETMARK_DETECTED +// +// MessageText: +// +// A tape access reached a setmark. +// +#define STATUS_SETMARK_DETECTED ((NTSTATUS)0x80000021L) + +// +// MessageId: STATUS_NO_DATA_DETECTED +// +// MessageText: +// +// During a tape access, the end of the data written is reached. +// +#define STATUS_NO_DATA_DETECTED ((NTSTATUS)0x80000022L) + +// +// MessageId: STATUS_REDIRECTOR_HAS_OPEN_HANDLES +// +// MessageText: +// +// The redirector is in use and cannot be unloaded. +// +#define STATUS_REDIRECTOR_HAS_OPEN_HANDLES ((NTSTATUS)0x80000023L) + +// +// MessageId: STATUS_SERVER_HAS_OPEN_HANDLES +// +// MessageText: +// +// The server is in use and cannot be unloaded. +// +#define STATUS_SERVER_HAS_OPEN_HANDLES ((NTSTATUS)0x80000024L) + +// +// MessageId: STATUS_ALREADY_DISCONNECTED +// +// MessageText: +// +// The specified connection has already been disconnected. +// +#define STATUS_ALREADY_DISCONNECTED ((NTSTATUS)0x80000025L) + +// +// MessageId: STATUS_LONGJUMP +// +// MessageText: +// +// A long jump has been executed. +// +#define STATUS_LONGJUMP ((NTSTATUS)0x80000026L) // winnt + +// +// MessageId: STATUS_CLEANER_CARTRIDGE_INSTALLED +// +// MessageText: +// +// A cleaner cartridge is present in the tape library. +// +#define STATUS_CLEANER_CARTRIDGE_INSTALLED ((NTSTATUS)0x80000027L) + +// +// MessageId: STATUS_PLUGPLAY_QUERY_VETOED +// +// MessageText: +// +// The Plug and Play query operation was not successful. +// +#define STATUS_PLUGPLAY_QUERY_VETOED ((NTSTATUS)0x80000028L) + +// +// MessageId: STATUS_UNWIND_CONSOLIDATE +// +// MessageText: +// +// A frame consolidation has been executed. +// +#define STATUS_UNWIND_CONSOLIDATE ((NTSTATUS)0x80000029L) // winnt + +// +// MessageId: STATUS_REGISTRY_HIVE_RECOVERED +// +// MessageText: +// +// {Registry Hive Recovered} +// Registry hive (file): +// %hs +// was corrupted and it has been recovered. Some data might have been lost. +// +#define STATUS_REGISTRY_HIVE_RECOVERED ((NTSTATUS)0x8000002AL) + +// +// MessageId: STATUS_DLL_MIGHT_BE_INSECURE +// +// MessageText: +// +// The application is attempting to run executable code from the module %hs. This may be insecure. An alternative, %hs, is available. Should the application use the secure module %hs? +// +#define STATUS_DLL_MIGHT_BE_INSECURE ((NTSTATUS)0x8000002BL) + +// +// MessageId: STATUS_DLL_MIGHT_BE_INCOMPATIBLE +// +// MessageText: +// +// The application is loading executable code from the module %hs. This is secure, but may be incompatible with previous releases of the operating system. An alternative, %hs, is available. Should the application use the secure module %hs? +// +#define STATUS_DLL_MIGHT_BE_INCOMPATIBLE ((NTSTATUS)0x8000002CL) + +// +// MessageId: STATUS_STOPPED_ON_SYMLINK +// +// MessageText: +// +// The create operation stopped after reaching a symbolic link. +// +#define STATUS_STOPPED_ON_SYMLINK ((NTSTATUS)0x8000002DL) + +// +// MessageId: STATUS_CANNOT_GRANT_REQUESTED_OPLOCK +// +// MessageText: +// +// An oplock of the requested level cannot be granted. An oplock of a lower level may be available. +// +#define STATUS_CANNOT_GRANT_REQUESTED_OPLOCK ((NTSTATUS)0x8000002EL) + +// +// MessageId: STATUS_NO_ACE_CONDITION +// +// MessageText: +// +// {No ACE Condition} +// The specified access control entry (ACE) does not contain a condition. +// +#define STATUS_NO_ACE_CONDITION ((NTSTATUS)0x8000002FL) + +// +// MessageId: STATUS_DEVICE_SUPPORT_IN_PROGRESS +// +// MessageText: +// +// {Support Being Determined} +// Device's command support detection is in progress. +// +#define STATUS_DEVICE_SUPPORT_IN_PROGRESS ((NTSTATUS)0x80000030L) + +// +// MessageId: STATUS_DEVICE_POWER_CYCLE_REQUIRED +// +// MessageText: +// +// The device needs to be power cycled. +// +#define STATUS_DEVICE_POWER_CYCLE_REQUIRED ((NTSTATUS)0x80000031L) + +// +// MessageId: STATUS_NO_WORK_DONE +// +// MessageText: +// +// The action requested resulted in no work being done. Error-style clean-up has been performed. +// +#define STATUS_NO_WORK_DONE ((NTSTATUS)0x80000032L) + +// +// MessageId: STATUS_RETURN_ADDRESS_HIJACK_ATTEMPT +// +// MessageText: +// +// A return address hijack is being attempted. This is supported by the operating system when user-mode shadow stacks are enabled. +// +#define STATUS_RETURN_ADDRESS_HIJACK_ATTEMPT ((NTSTATUS)0x80000033L) + +// +// MessageId: STATUS_RECOVERABLE_BUGCHECK +// +// MessageText: +// +// {EXCEPTION} +// Recoverable Bugcheck Exception +// A bugcheck was re-raised as an exception. +// +#define STATUS_RECOVERABLE_BUGCHECK ((NTSTATUS)0x80000034L) + +// +// MessageId: STATUS_PTE_CHANGE_NOT_COMPLETED +// +// MessageText: +// +// The secure page table update could not be completed due to a temporary address exclusion. +// +#define STATUS_PTE_CHANGE_NOT_COMPLETED ((NTSTATUS)0x80000035L) + +// +// MessageId: DBG_EXCEPTION_NOT_HANDLED +// +// MessageText: +// +// Debugger did not handle the exception. +// +#define DBG_EXCEPTION_NOT_HANDLED ((NTSTATUS)0x80010001L) // winnt + +// +// MessageId: STATUS_CLUSTER_NODE_ALREADY_UP +// +// MessageText: +// +// The cluster node is already up. +// +#define STATUS_CLUSTER_NODE_ALREADY_UP ((NTSTATUS)0x80130001L) + +// +// MessageId: STATUS_CLUSTER_NODE_ALREADY_DOWN +// +// MessageText: +// +// The cluster node is already down. +// +#define STATUS_CLUSTER_NODE_ALREADY_DOWN ((NTSTATUS)0x80130002L) + +// +// MessageId: STATUS_CLUSTER_NETWORK_ALREADY_ONLINE +// +// MessageText: +// +// The cluster network is already online. +// +#define STATUS_CLUSTER_NETWORK_ALREADY_ONLINE ((NTSTATUS)0x80130003L) + +// +// MessageId: STATUS_CLUSTER_NETWORK_ALREADY_OFFLINE +// +// MessageText: +// +// The cluster network is already offline. +// +#define STATUS_CLUSTER_NETWORK_ALREADY_OFFLINE ((NTSTATUS)0x80130004L) + +// +// MessageId: STATUS_CLUSTER_NODE_ALREADY_MEMBER +// +// MessageText: +// +// The cluster node is already a member of the cluster. +// +#define STATUS_CLUSTER_NODE_ALREADY_MEMBER ((NTSTATUS)0x80130005L) + +// +// MessageId: STATUS_FLT_BUFFER_TOO_SMALL +// +// MessageText: +// +// {Buffer too small} +// The buffer is too small to contain the entry. No information has been written to the buffer. +// +#define STATUS_FLT_BUFFER_TOO_SMALL ((NTSTATUS)0x801C0001L) + +/*++ + + Graphics Facility Warning messages (dxgkrnl.sys) + +--*/ +// +// MessageId: STATUS_GRAPHICS_LINK_CONFIGURATION_IN_PROGRESS +// +// MessageText: +// +// Link configuration for the display timing is still in progress. +// +// ;/*++ +// ; +// ; End of Graphics Facility Warning messages. +// ; +// ;--*/ +// +// +#define STATUS_GRAPHICS_LINK_CONFIGURATION_IN_PROGRESS ((NTSTATUS)0x801E0000L) + +// +// MessageId: STATUS_FVE_PARTIAL_METADATA +// +// MessageText: +// +// Volume Metadata read or write is incomplete. +// +#define STATUS_FVE_PARTIAL_METADATA ((NTSTATUS)0x80210001L) + +// +// MessageId: STATUS_FVE_TRANSIENT_STATE +// +// MessageText: +// +// BitLocker encryption keys were ignored because the volume was in a transient state. +// +#define STATUS_FVE_TRANSIENT_STATE ((NTSTATUS)0x80210002L) + +/*++ + + MessageId's 0xcf00 - 0xcfff (inclusive) are for Cloud Files specific warning messages. + +--*/ +// +// MessageId: STATUS_CLOUD_FILE_PROPERTY_BLOB_CHECKSUM_MISMATCH +// +// MessageText: +// +// The cloud file property is possibly corrupt. The on-disk checksum does not match the computed checksum. +// +#define STATUS_CLOUD_FILE_PROPERTY_BLOB_CHECKSUM_MISMATCH ((NTSTATUS)0x8000CF00L) + +/*++ + + End of Cloud Files specific warning messages. + +--*/ +///////////////////////////////////////////////////////////////////////// +// +// Standard Error values +// +///////////////////////////////////////////////////////////////////////// + +// +// MessageId: STATUS_UNSUCCESSFUL +// +// MessageText: +// +// {Operation Failed} +// The requested operation was unsuccessful. +// +#define STATUS_UNSUCCESSFUL ((NTSTATUS)0xC0000001L) + +// +// MessageId: STATUS_NOT_IMPLEMENTED +// +// MessageText: +// +// {Not Implemented} +// The requested operation is not implemented. +// +#define STATUS_NOT_IMPLEMENTED ((NTSTATUS)0xC0000002L) + +// +// MessageId: STATUS_INVALID_INFO_CLASS +// +// MessageText: +// +// {Invalid Parameter} +// The specified information class is not a valid information class for the specified object. +// +#define STATUS_INVALID_INFO_CLASS ((NTSTATUS)0xC0000003L) // ntsubauth + +// +// MessageId: STATUS_INFO_LENGTH_MISMATCH +// +// MessageText: +// +// The specified information record length does not match the length required for the specified information class. +// +#define STATUS_INFO_LENGTH_MISMATCH ((NTSTATUS)0xC0000004L) + +// +// MessageId: STATUS_ACCESS_VIOLATION +// +// MessageText: +// +// The instruction at 0x%p referenced memory at 0x%p. The memory could not be %s. +// +#define STATUS_ACCESS_VIOLATION ((NTSTATUS)0xC0000005L) // winnt + +// +// MessageId: STATUS_IN_PAGE_ERROR +// +// MessageText: +// +// The instruction at 0x%p referenced memory at 0x%p. The required data was not placed into memory because of an I/O error status of 0x%x. +// +#define STATUS_IN_PAGE_ERROR ((NTSTATUS)0xC0000006L) // winnt + +// +// MessageId: STATUS_PAGEFILE_QUOTA +// +// MessageText: +// +// The pagefile quota for the process has been exhausted. +// +#define STATUS_PAGEFILE_QUOTA ((NTSTATUS)0xC0000007L) + +// +// MessageId: STATUS_INVALID_HANDLE +// +// MessageText: +// +// An invalid HANDLE was specified. +// +#define STATUS_INVALID_HANDLE ((NTSTATUS)0xC0000008L) // winnt + +// +// MessageId: STATUS_BAD_INITIAL_STACK +// +// MessageText: +// +// An invalid initial stack was specified in a call to NtCreateThread. +// +#define STATUS_BAD_INITIAL_STACK ((NTSTATUS)0xC0000009L) + +// +// MessageId: STATUS_BAD_INITIAL_PC +// +// MessageText: +// +// An invalid initial start address was specified in a call to NtCreateThread. +// +#define STATUS_BAD_INITIAL_PC ((NTSTATUS)0xC000000AL) + +// +// MessageId: STATUS_INVALID_CID +// +// MessageText: +// +// An invalid Client ID was specified. +// +#define STATUS_INVALID_CID ((NTSTATUS)0xC000000BL) + +// +// MessageId: STATUS_TIMER_NOT_CANCELED +// +// MessageText: +// +// An attempt was made to cancel or set a timer that has an associated APC and the subject thread is not the thread that originally set the timer with an associated APC routine. +// +#define STATUS_TIMER_NOT_CANCELED ((NTSTATUS)0xC000000CL) + +// +// MessageId: STATUS_INVALID_PARAMETER +// +// MessageText: +// +// An invalid parameter was passed to a service or function. +// +#define STATUS_INVALID_PARAMETER ((NTSTATUS)0xC000000DL) // winnt + +// +// MessageId: STATUS_NO_SUCH_DEVICE +// +// MessageText: +// +// A device which does not exist was specified. +// +#define STATUS_NO_SUCH_DEVICE ((NTSTATUS)0xC000000EL) + +// +// MessageId: STATUS_NO_SUCH_FILE +// +// MessageText: +// +// {File Not Found} +// The file %hs does not exist. +// +#define STATUS_NO_SUCH_FILE ((NTSTATUS)0xC000000FL) + +// +// MessageId: STATUS_INVALID_DEVICE_REQUEST +// +// MessageText: +// +// The specified request is not a valid operation for the target device. +// +#define STATUS_INVALID_DEVICE_REQUEST ((NTSTATUS)0xC0000010L) + +// +// MessageId: STATUS_END_OF_FILE +// +// MessageText: +// +// The end-of-file marker has been reached. There is no valid data in the file beyond this marker. +// +#define STATUS_END_OF_FILE ((NTSTATUS)0xC0000011L) + +// +// MessageId: STATUS_WRONG_VOLUME +// +// MessageText: +// +// {Wrong Volume} +// The wrong volume is in the drive. +// Please insert volume %hs into drive %hs. +// +#define STATUS_WRONG_VOLUME ((NTSTATUS)0xC0000012L) + +// +// MessageId: STATUS_NO_MEDIA_IN_DEVICE +// +// MessageText: +// +// {No Disk} +// There is no disk in the drive. +// Please insert a disk into drive %hs. +// +#define STATUS_NO_MEDIA_IN_DEVICE ((NTSTATUS)0xC0000013L) + +// +// MessageId: STATUS_UNRECOGNIZED_MEDIA +// +// MessageText: +// +// {Unknown Disk Format} +// The disk in drive %hs is not formatted properly. +// Please check the disk, and reformat if necessary. +// +#define STATUS_UNRECOGNIZED_MEDIA ((NTSTATUS)0xC0000014L) + +// +// MessageId: STATUS_NONEXISTENT_SECTOR +// +// MessageText: +// +// {Sector Not Found} +// The specified sector does not exist. +// +#define STATUS_NONEXISTENT_SECTOR ((NTSTATUS)0xC0000015L) + +// +// MessageId: STATUS_MORE_PROCESSING_REQUIRED +// +// MessageText: +// +// {Still Busy} +// The specified I/O request packet (IRP) cannot be disposed of because the I/O operation is not complete. +// +#define STATUS_MORE_PROCESSING_REQUIRED ((NTSTATUS)0xC0000016L) + +// +// MessageId: STATUS_NO_MEMORY +// +// MessageText: +// +// {Not Enough Quota} +// Not enough virtual memory or paging file quota is available to complete the specified operation. +// +#define STATUS_NO_MEMORY ((NTSTATUS)0xC0000017L) // winnt + +// +// MessageId: STATUS_CONFLICTING_ADDRESSES +// +// MessageText: +// +// {Conflicting Address Range} +// The specified address range conflicts with the address space. +// +#define STATUS_CONFLICTING_ADDRESSES ((NTSTATUS)0xC0000018L) + +// +// MessageId: STATUS_NOT_MAPPED_VIEW +// +// MessageText: +// +// Address range to unmap is not a mapped view. +// +#define STATUS_NOT_MAPPED_VIEW ((NTSTATUS)0xC0000019L) + +// +// MessageId: STATUS_UNABLE_TO_FREE_VM +// +// MessageText: +// +// Virtual memory cannot be freed. +// +#define STATUS_UNABLE_TO_FREE_VM ((NTSTATUS)0xC000001AL) + +// +// MessageId: STATUS_UNABLE_TO_DELETE_SECTION +// +// MessageText: +// +// Specified section cannot be deleted. +// +#define STATUS_UNABLE_TO_DELETE_SECTION ((NTSTATUS)0xC000001BL) + +// +// MessageId: STATUS_INVALID_SYSTEM_SERVICE +// +// MessageText: +// +// An invalid system service was specified in a system service call. +// +#define STATUS_INVALID_SYSTEM_SERVICE ((NTSTATUS)0xC000001CL) + +// +// MessageId: STATUS_ILLEGAL_INSTRUCTION +// +// MessageText: +// +// {EXCEPTION} +// Illegal Instruction +// An attempt was made to execute an illegal instruction. +// +#define STATUS_ILLEGAL_INSTRUCTION ((NTSTATUS)0xC000001DL) // winnt + +// +// MessageId: STATUS_INVALID_LOCK_SEQUENCE +// +// MessageText: +// +// {Invalid Lock Sequence} +// An attempt was made to execute an invalid lock sequence. +// +#define STATUS_INVALID_LOCK_SEQUENCE ((NTSTATUS)0xC000001EL) + +// +// MessageId: STATUS_INVALID_VIEW_SIZE +// +// MessageText: +// +// {Invalid Mapping} +// An attempt was made to create a view for a section which is bigger than the section. +// +#define STATUS_INVALID_VIEW_SIZE ((NTSTATUS)0xC000001FL) + +// +// MessageId: STATUS_INVALID_FILE_FOR_SECTION +// +// MessageText: +// +// {Bad File} +// The attributes of the specified mapping file for a section of memory cannot be read. +// +#define STATUS_INVALID_FILE_FOR_SECTION ((NTSTATUS)0xC0000020L) + +// +// MessageId: STATUS_ALREADY_COMMITTED +// +// MessageText: +// +// {Already Committed} +// The specified address range is already committed. +// +#define STATUS_ALREADY_COMMITTED ((NTSTATUS)0xC0000021L) + +// +// MessageId: STATUS_ACCESS_DENIED +// +// MessageText: +// +// {Access Denied} +// A process has requested access to an object, but has not been granted those access rights. +// +#define STATUS_ACCESS_DENIED ((NTSTATUS)0xC0000022L) + +// +// MessageId: STATUS_BUFFER_TOO_SMALL +// +// MessageText: +// +// {Buffer Too Small} +// The buffer is too small to contain the entry. No information has been written to the buffer. +// +#define STATUS_BUFFER_TOO_SMALL ((NTSTATUS)0xC0000023L) + +// +// MessageId: STATUS_OBJECT_TYPE_MISMATCH +// +// MessageText: +// +// {Wrong Type} +// There is a mismatch between the type of object required by the requested operation and the type of object that is specified in the request. +// +#define STATUS_OBJECT_TYPE_MISMATCH ((NTSTATUS)0xC0000024L) + +// +// MessageId: STATUS_NONCONTINUABLE_EXCEPTION +// +// MessageText: +// +// {EXCEPTION} +// Cannot Continue +// Windows cannot continue from this exception. +// +#define STATUS_NONCONTINUABLE_EXCEPTION ((NTSTATUS)0xC0000025L) // winnt + +// +// MessageId: STATUS_INVALID_DISPOSITION +// +// MessageText: +// +// An invalid exception disposition was returned by an exception handler. +// +#define STATUS_INVALID_DISPOSITION ((NTSTATUS)0xC0000026L) // winnt + +// +// MessageId: STATUS_UNWIND +// +// MessageText: +// +// Unwind exception code. +// +#define STATUS_UNWIND ((NTSTATUS)0xC0000027L) + +// +// MessageId: STATUS_BAD_STACK +// +// MessageText: +// +// An invalid or unaligned stack was encountered during an unwind operation. +// +#define STATUS_BAD_STACK ((NTSTATUS)0xC0000028L) + +// +// MessageId: STATUS_INVALID_UNWIND_TARGET +// +// MessageText: +// +// An invalid unwind target was encountered during an unwind operation. +// +#define STATUS_INVALID_UNWIND_TARGET ((NTSTATUS)0xC0000029L) + +// +// MessageId: STATUS_NOT_LOCKED +// +// MessageText: +// +// An attempt was made to unlock a page of memory which was not locked. +// +#define STATUS_NOT_LOCKED ((NTSTATUS)0xC000002AL) + +// +// MessageId: STATUS_PARITY_ERROR +// +// MessageText: +// +// Device parity error on I/O operation. +// +#define STATUS_PARITY_ERROR ((NTSTATUS)0xC000002BL) + +// +// MessageId: STATUS_UNABLE_TO_DECOMMIT_VM +// +// MessageText: +// +// An attempt was made to decommit uncommitted virtual memory. +// +#define STATUS_UNABLE_TO_DECOMMIT_VM ((NTSTATUS)0xC000002CL) + +// +// MessageId: STATUS_NOT_COMMITTED +// +// MessageText: +// +// An attempt was made to change the attributes on memory that has not been committed. +// +#define STATUS_NOT_COMMITTED ((NTSTATUS)0xC000002DL) + +// +// MessageId: STATUS_INVALID_PORT_ATTRIBUTES +// +// MessageText: +// +// Invalid Object Attributes specified to NtCreatePort or invalid Port Attributes specified to NtConnectPort +// +#define STATUS_INVALID_PORT_ATTRIBUTES ((NTSTATUS)0xC000002EL) + +// +// MessageId: STATUS_PORT_MESSAGE_TOO_LONG +// +// MessageText: +// +// Length of message passed to NtRequestPort or NtRequestWaitReplyPort was longer than the maximum message allowed by the port. +// +#define STATUS_PORT_MESSAGE_TOO_LONG ((NTSTATUS)0xC000002FL) + +// +// MessageId: STATUS_INVALID_PARAMETER_MIX +// +// MessageText: +// +// An invalid combination of parameters was specified. +// +#define STATUS_INVALID_PARAMETER_MIX ((NTSTATUS)0xC0000030L) + +// +// MessageId: STATUS_INVALID_QUOTA_LOWER +// +// MessageText: +// +// An attempt was made to lower a quota limit below the current usage. +// +#define STATUS_INVALID_QUOTA_LOWER ((NTSTATUS)0xC0000031L) + +// +// MessageId: STATUS_DISK_CORRUPT_ERROR +// +// MessageText: +// +// {Corrupt Disk} +// The file system structure on the disk is corrupt and unusable. +// Please run the Chkdsk utility on the volume %hs. +// +#define STATUS_DISK_CORRUPT_ERROR ((NTSTATUS)0xC0000032L) + +// +// MessageId: STATUS_OBJECT_NAME_INVALID +// +// MessageText: +// +// Object Name invalid. +// +#define STATUS_OBJECT_NAME_INVALID ((NTSTATUS)0xC0000033L) + +// +// MessageId: STATUS_OBJECT_NAME_NOT_FOUND +// +// MessageText: +// +// Object Name not found. +// +#define STATUS_OBJECT_NAME_NOT_FOUND ((NTSTATUS)0xC0000034L) + +// +// MessageId: STATUS_OBJECT_NAME_COLLISION +// +// MessageText: +// +// Object Name already exists. +// +#define STATUS_OBJECT_NAME_COLLISION ((NTSTATUS)0xC0000035L) + +// +// MessageId: STATUS_PORT_DO_NOT_DISTURB +// +// MessageText: +// +// A port with the 'do not disturb' flag set attempted to send a message to a port in a suspended process. +// The process was not woken, and the message was not delivered. +// +#define STATUS_PORT_DO_NOT_DISTURB ((NTSTATUS)0xC0000036L) + +// +// MessageId: STATUS_PORT_DISCONNECTED +// +// MessageText: +// +// Attempt to send a message to a disconnected communication port. +// +#define STATUS_PORT_DISCONNECTED ((NTSTATUS)0xC0000037L) + +// +// MessageId: STATUS_DEVICE_ALREADY_ATTACHED +// +// MessageText: +// +// An attempt was made to attach to a device that was already attached to another device. +// +#define STATUS_DEVICE_ALREADY_ATTACHED ((NTSTATUS)0xC0000038L) + +// +// MessageId: STATUS_OBJECT_PATH_INVALID +// +// MessageText: +// +// Object Path Component was not a directory object. +// +#define STATUS_OBJECT_PATH_INVALID ((NTSTATUS)0xC0000039L) + +// +// MessageId: STATUS_OBJECT_PATH_NOT_FOUND +// +// MessageText: +// +// {Path Not Found} +// The path %hs does not exist. +// +#define STATUS_OBJECT_PATH_NOT_FOUND ((NTSTATUS)0xC000003AL) + +// +// MessageId: STATUS_OBJECT_PATH_SYNTAX_BAD +// +// MessageText: +// +// Object Path Component was not a directory object. +// +#define STATUS_OBJECT_PATH_SYNTAX_BAD ((NTSTATUS)0xC000003BL) + +// +// MessageId: STATUS_DATA_OVERRUN +// +// MessageText: +// +// {Data Overrun} +// A data overrun error occurred. +// +#define STATUS_DATA_OVERRUN ((NTSTATUS)0xC000003CL) + +// +// MessageId: STATUS_DATA_LATE_ERROR +// +// MessageText: +// +// {Data Late} +// A data late error occurred. +// +#define STATUS_DATA_LATE_ERROR ((NTSTATUS)0xC000003DL) + +// +// MessageId: STATUS_DATA_ERROR +// +// MessageText: +// +// {Data Error} +// An error in reading or writing data occurred. +// +#define STATUS_DATA_ERROR ((NTSTATUS)0xC000003EL) + +// +// MessageId: STATUS_CRC_ERROR +// +// MessageText: +// +// {Bad CRC} +// A cyclic redundancy check (CRC) checksum error occurred. +// +#define STATUS_CRC_ERROR ((NTSTATUS)0xC000003FL) + +// +// MessageId: STATUS_SECTION_TOO_BIG +// +// MessageText: +// +// {Section Too Large} +// The specified section is too big to map the file. +// +#define STATUS_SECTION_TOO_BIG ((NTSTATUS)0xC0000040L) + +// +// MessageId: STATUS_PORT_CONNECTION_REFUSED +// +// MessageText: +// +// The NtConnectPort request is refused. +// +#define STATUS_PORT_CONNECTION_REFUSED ((NTSTATUS)0xC0000041L) + +// +// MessageId: STATUS_INVALID_PORT_HANDLE +// +// MessageText: +// +// The type of port handle is invalid for the operation requested. +// +#define STATUS_INVALID_PORT_HANDLE ((NTSTATUS)0xC0000042L) + +// +// MessageId: STATUS_SHARING_VIOLATION +// +// MessageText: +// +// A file cannot be opened because the share access flags are incompatible. +// +#define STATUS_SHARING_VIOLATION ((NTSTATUS)0xC0000043L) + +// +// MessageId: STATUS_QUOTA_EXCEEDED +// +// MessageText: +// +// Insufficient quota exists to complete the operation +// +#define STATUS_QUOTA_EXCEEDED ((NTSTATUS)0xC0000044L) + +// +// MessageId: STATUS_INVALID_PAGE_PROTECTION +// +// MessageText: +// +// The specified page protection was not valid. +// +#define STATUS_INVALID_PAGE_PROTECTION ((NTSTATUS)0xC0000045L) + +// +// MessageId: STATUS_MUTANT_NOT_OWNED +// +// MessageText: +// +// An attempt to release a mutant object was made by a thread that was not the owner of the mutant object. +// +#define STATUS_MUTANT_NOT_OWNED ((NTSTATUS)0xC0000046L) + +// +// MessageId: STATUS_SEMAPHORE_LIMIT_EXCEEDED +// +// MessageText: +// +// An attempt was made to release a semaphore such that its maximum count would have been exceeded. +// +#define STATUS_SEMAPHORE_LIMIT_EXCEEDED ((NTSTATUS)0xC0000047L) + +// +// MessageId: STATUS_PORT_ALREADY_SET +// +// MessageText: +// +// An attempt to set a process's DebugPort or ExceptionPort was made, but a port already exists in the process or an attempt to set a file's CompletionPort made, but a port was already set in the file or an attempt to set an ALPC port's associated completion port was made, but it is already set. +// +#define STATUS_PORT_ALREADY_SET ((NTSTATUS)0xC0000048L) + +// +// MessageId: STATUS_SECTION_NOT_IMAGE +// +// MessageText: +// +// An attempt was made to query image information on a section which does not map an image. +// +#define STATUS_SECTION_NOT_IMAGE ((NTSTATUS)0xC0000049L) + +// +// MessageId: STATUS_SUSPEND_COUNT_EXCEEDED +// +// MessageText: +// +// An attempt was made to suspend a thread whose suspend count was at its maximum. +// +#define STATUS_SUSPEND_COUNT_EXCEEDED ((NTSTATUS)0xC000004AL) + +// +// MessageId: STATUS_THREAD_IS_TERMINATING +// +// MessageText: +// +// An attempt was made to access a thread that has begun termination. +// +#define STATUS_THREAD_IS_TERMINATING ((NTSTATUS)0xC000004BL) + +// +// MessageId: STATUS_BAD_WORKING_SET_LIMIT +// +// MessageText: +// +// An attempt was made to set the working set limit to an invalid value (minimum greater than maximum, etc). +// +#define STATUS_BAD_WORKING_SET_LIMIT ((NTSTATUS)0xC000004CL) + +// +// MessageId: STATUS_INCOMPATIBLE_FILE_MAP +// +// MessageText: +// +// A section was created to map a file which is not compatible to an already existing section which maps the same file. +// +#define STATUS_INCOMPATIBLE_FILE_MAP ((NTSTATUS)0xC000004DL) + +// +// MessageId: STATUS_SECTION_PROTECTION +// +// MessageText: +// +// A view to a section specifies a protection which is incompatible with the initial view's protection. +// +#define STATUS_SECTION_PROTECTION ((NTSTATUS)0xC000004EL) + +// +// MessageId: STATUS_EAS_NOT_SUPPORTED +// +// MessageText: +// +// An operation involving EAs failed because the file system does not support EAs. +// +#define STATUS_EAS_NOT_SUPPORTED ((NTSTATUS)0xC000004FL) + +// +// MessageId: STATUS_EA_TOO_LARGE +// +// MessageText: +// +// An EA operation failed because EA set is too large. +// +#define STATUS_EA_TOO_LARGE ((NTSTATUS)0xC0000050L) + +// +// MessageId: STATUS_NONEXISTENT_EA_ENTRY +// +// MessageText: +// +// An EA operation failed because the name or EA index is invalid. +// +#define STATUS_NONEXISTENT_EA_ENTRY ((NTSTATUS)0xC0000051L) + +// +// MessageId: STATUS_NO_EAS_ON_FILE +// +// MessageText: +// +// The file for which EAs were requested has no EAs. +// +#define STATUS_NO_EAS_ON_FILE ((NTSTATUS)0xC0000052L) + +// +// MessageId: STATUS_EA_CORRUPT_ERROR +// +// MessageText: +// +// The EA is corrupt and non-readable. +// +#define STATUS_EA_CORRUPT_ERROR ((NTSTATUS)0xC0000053L) + +// +// MessageId: STATUS_FILE_LOCK_CONFLICT +// +// MessageText: +// +// A requested read/write cannot be granted due to a conflicting file lock. +// +#define STATUS_FILE_LOCK_CONFLICT ((NTSTATUS)0xC0000054L) + +// +// MessageId: STATUS_LOCK_NOT_GRANTED +// +// MessageText: +// +// A requested file lock cannot be granted due to other existing locks. +// +#define STATUS_LOCK_NOT_GRANTED ((NTSTATUS)0xC0000055L) + +// +// MessageId: STATUS_DELETE_PENDING +// +// MessageText: +// +// A non close operation has been requested of a file object with a delete pending. +// +#define STATUS_DELETE_PENDING ((NTSTATUS)0xC0000056L) + +// +// MessageId: STATUS_CTL_FILE_NOT_SUPPORTED +// +// MessageText: +// +// An attempt was made to set the control attribute on a file. This attribute is not supported in the target file system. +// +#define STATUS_CTL_FILE_NOT_SUPPORTED ((NTSTATUS)0xC0000057L) + +// +// MessageId: STATUS_UNKNOWN_REVISION +// +// MessageText: +// +// Indicates a revision number encountered or specified is not one known by the service. It may be a more recent revision than the service is aware of. +// +#define STATUS_UNKNOWN_REVISION ((NTSTATUS)0xC0000058L) + +// +// MessageId: STATUS_REVISION_MISMATCH +// +// MessageText: +// +// Indicates two revision levels are incompatible. +// +#define STATUS_REVISION_MISMATCH ((NTSTATUS)0xC0000059L) + +// +// MessageId: STATUS_INVALID_OWNER +// +// MessageText: +// +// Indicates a particular Security ID may not be assigned as the owner of an object. +// +#define STATUS_INVALID_OWNER ((NTSTATUS)0xC000005AL) + +// +// MessageId: STATUS_INVALID_PRIMARY_GROUP +// +// MessageText: +// +// Indicates a particular Security ID may not be assigned as the primary group of an object. +// +#define STATUS_INVALID_PRIMARY_GROUP ((NTSTATUS)0xC000005BL) + +// +// MessageId: STATUS_NO_IMPERSONATION_TOKEN +// +// MessageText: +// +// An attempt has been made to operate on an impersonation token by a thread that is not currently impersonating a client. +// +#define STATUS_NO_IMPERSONATION_TOKEN ((NTSTATUS)0xC000005CL) + +// +// MessageId: STATUS_CANT_DISABLE_MANDATORY +// +// MessageText: +// +// A mandatory group may not be disabled. +// +#define STATUS_CANT_DISABLE_MANDATORY ((NTSTATUS)0xC000005DL) + +// +// MessageId: STATUS_NO_LOGON_SERVERS +// +// MessageText: +// +// We can't sign you in with this credential because your domain isn't available. Make sure your device is connected to your organization's network and try again. If you previously signed in on this device with another credential, you can sign in with that credential. +// +#define STATUS_NO_LOGON_SERVERS ((NTSTATUS)0xC000005EL) + +// +// MessageId: STATUS_NO_SUCH_LOGON_SESSION +// +// MessageText: +// +// A specified logon session does not exist. It may already have been terminated. +// +#define STATUS_NO_SUCH_LOGON_SESSION ((NTSTATUS)0xC000005FL) + +// +// MessageId: STATUS_NO_SUCH_PRIVILEGE +// +// MessageText: +// +// A specified privilege does not exist. +// +#define STATUS_NO_SUCH_PRIVILEGE ((NTSTATUS)0xC0000060L) + +// +// MessageId: STATUS_PRIVILEGE_NOT_HELD +// +// MessageText: +// +// A required privilege is not held by the client. +// +#define STATUS_PRIVILEGE_NOT_HELD ((NTSTATUS)0xC0000061L) + +// +// MessageId: STATUS_INVALID_ACCOUNT_NAME +// +// MessageText: +// +// The name provided is not a properly formed account name. +// +#define STATUS_INVALID_ACCOUNT_NAME ((NTSTATUS)0xC0000062L) + +// +// MessageId: STATUS_USER_EXISTS +// +// MessageText: +// +// The specified account already exists. +// +#define STATUS_USER_EXISTS ((NTSTATUS)0xC0000063L) + +// +// MessageId: STATUS_NO_SUCH_USER +// +// MessageText: +// +// The specified account does not exist. +// +#define STATUS_NO_SUCH_USER ((NTSTATUS)0xC0000064L) // ntsubauth + +// +// MessageId: STATUS_GROUP_EXISTS +// +// MessageText: +// +// The specified group already exists. +// +#define STATUS_GROUP_EXISTS ((NTSTATUS)0xC0000065L) + +// +// MessageId: STATUS_NO_SUCH_GROUP +// +// MessageText: +// +// The specified group does not exist. +// +#define STATUS_NO_SUCH_GROUP ((NTSTATUS)0xC0000066L) + +// +// MessageId: STATUS_MEMBER_IN_GROUP +// +// MessageText: +// +// The specified user account is already in the specified group account. Also used to indicate a group cannot be deleted because it contains a member. +// +#define STATUS_MEMBER_IN_GROUP ((NTSTATUS)0xC0000067L) + +// +// MessageId: STATUS_MEMBER_NOT_IN_GROUP +// +// MessageText: +// +// The specified user account is not a member of the specified group account. +// +#define STATUS_MEMBER_NOT_IN_GROUP ((NTSTATUS)0xC0000068L) + +// +// MessageId: STATUS_LAST_ADMIN +// +// MessageText: +// +// Indicates the requested operation would disable, delete or could prevent logon for an administration account. +// This is not allowed to prevent creating a situation in which the system cannot be administrated. +// +#define STATUS_LAST_ADMIN ((NTSTATUS)0xC0000069L) + +// +// MessageId: STATUS_WRONG_PASSWORD +// +// MessageText: +// +// When trying to update a password, this return status indicates that the value provided as the current password is not correct. +// +#define STATUS_WRONG_PASSWORD ((NTSTATUS)0xC000006AL) // ntsubauth + +// +// MessageId: STATUS_ILL_FORMED_PASSWORD +// +// MessageText: +// +// When trying to update a password, this return status indicates that the value provided for the new password contains values that are not allowed in passwords. +// +#define STATUS_ILL_FORMED_PASSWORD ((NTSTATUS)0xC000006BL) + +// +// MessageId: STATUS_PASSWORD_RESTRICTION +// +// MessageText: +// +// When trying to update a password, this status indicates that the password does not meet the length, complexity, or history requirements of the machine or domain. Try increasing the length of your password, along with including upper and lowercase characters, numbers, and symbols. +// +#define STATUS_PASSWORD_RESTRICTION ((NTSTATUS)0xC000006CL) // ntsubauth + +// +// MessageId: STATUS_LOGON_FAILURE +// +// MessageText: +// +// The attempted logon is invalid. This is either due to a bad username or authentication information. +// +#define STATUS_LOGON_FAILURE ((NTSTATUS)0xC000006DL) // ntsubauth + +// +// MessageId: STATUS_ACCOUNT_RESTRICTION +// +// MessageText: +// +// Indicates a referenced user name and authentication information are valid, but some user account restriction has prevented successful authentication (such as time-of-day restrictions). +// +#define STATUS_ACCOUNT_RESTRICTION ((NTSTATUS)0xC000006EL) // ntsubauth + +// +// MessageId: STATUS_INVALID_LOGON_HOURS +// +// MessageText: +// +// The user account has time restrictions and may not be logged onto at this time. +// +#define STATUS_INVALID_LOGON_HOURS ((NTSTATUS)0xC000006FL) // ntsubauth + +// +// MessageId: STATUS_INVALID_WORKSTATION +// +// MessageText: +// +// The user account is restricted such that it may not be used to log on from the source workstation. +// +#define STATUS_INVALID_WORKSTATION ((NTSTATUS)0xC0000070L) // ntsubauth + +// +// MessageId: STATUS_PASSWORD_EXPIRED +// +// MessageText: +// +// The user account's password has expired. +// +#define STATUS_PASSWORD_EXPIRED ((NTSTATUS)0xC0000071L) // ntsubauth + +// +// MessageId: STATUS_ACCOUNT_DISABLED +// +// MessageText: +// +// The referenced account is currently disabled and may not be logged on to. +// +#define STATUS_ACCOUNT_DISABLED ((NTSTATUS)0xC0000072L) // ntsubauth + +// +// MessageId: STATUS_NONE_MAPPED +// +// MessageText: +// +// None of the information to be translated has been translated. +// +#define STATUS_NONE_MAPPED ((NTSTATUS)0xC0000073L) + +// +// MessageId: STATUS_TOO_MANY_LUIDS_REQUESTED +// +// MessageText: +// +// The number of LUIDs requested may not be allocated with a single allocation. +// +#define STATUS_TOO_MANY_LUIDS_REQUESTED ((NTSTATUS)0xC0000074L) + +// +// MessageId: STATUS_LUIDS_EXHAUSTED +// +// MessageText: +// +// Indicates there are no more LUIDs to allocate. +// +#define STATUS_LUIDS_EXHAUSTED ((NTSTATUS)0xC0000075L) + +// +// MessageId: STATUS_INVALID_SUB_AUTHORITY +// +// MessageText: +// +// Indicates the sub-authority value is invalid for the particular use. +// +#define STATUS_INVALID_SUB_AUTHORITY ((NTSTATUS)0xC0000076L) + +// +// MessageId: STATUS_INVALID_ACL +// +// MessageText: +// +// Indicates the ACL structure is not valid. +// +#define STATUS_INVALID_ACL ((NTSTATUS)0xC0000077L) + +// +// MessageId: STATUS_INVALID_SID +// +// MessageText: +// +// Indicates the SID structure is not valid. +// +#define STATUS_INVALID_SID ((NTSTATUS)0xC0000078L) + +// +// MessageId: STATUS_INVALID_SECURITY_DESCR +// +// MessageText: +// +// Indicates the SECURITY_DESCRIPTOR structure is not valid. +// +#define STATUS_INVALID_SECURITY_DESCR ((NTSTATUS)0xC0000079L) + +// +// MessageId: STATUS_PROCEDURE_NOT_FOUND +// +// MessageText: +// +// Indicates the specified procedure address cannot be found in the DLL. +// +#define STATUS_PROCEDURE_NOT_FOUND ((NTSTATUS)0xC000007AL) + +// +// MessageId: STATUS_INVALID_IMAGE_FORMAT +// +// MessageText: +// +// {Bad Image} +// %hs is either not designed to run on Windows or it contains an error. Try installing the program again using the original installation media or contact your system administrator or the software vendor for support. Error status 0x%08lx. +// +#define STATUS_INVALID_IMAGE_FORMAT ((NTSTATUS)0xC000007BL) + +// +// MessageId: STATUS_NO_TOKEN +// +// MessageText: +// +// An attempt was made to reference a token that doesn't exist. +// This is typically done by referencing the token associated with a thread when the thread is not impersonating a client. +// +#define STATUS_NO_TOKEN ((NTSTATUS)0xC000007CL) + +// +// MessageId: STATUS_BAD_INHERITANCE_ACL +// +// MessageText: +// +// Indicates that an attempt to build either an inherited ACL or ACE was not successful. +// This can be caused by a number of things. One of the more probable causes is the replacement of a CreatorId with an SID that didn't fit into the ACE or ACL. +// +#define STATUS_BAD_INHERITANCE_ACL ((NTSTATUS)0xC000007DL) + +// +// MessageId: STATUS_RANGE_NOT_LOCKED +// +// MessageText: +// +// The range specified in NtUnlockFile was not locked. +// +#define STATUS_RANGE_NOT_LOCKED ((NTSTATUS)0xC000007EL) + +// +// MessageId: STATUS_DISK_FULL +// +// MessageText: +// +// An operation failed because the disk was full. +// If this is a thinly provisioned volume the physical storage backing this volume has been exhausted. +// +#define STATUS_DISK_FULL ((NTSTATUS)0xC000007FL) + +// +// MessageId: STATUS_SERVER_DISABLED +// +// MessageText: +// +// The GUID allocation server is [already] disabled at the moment. +// +#define STATUS_SERVER_DISABLED ((NTSTATUS)0xC0000080L) + +// +// MessageId: STATUS_SERVER_NOT_DISABLED +// +// MessageText: +// +// The GUID allocation server is [already] enabled at the moment. +// +#define STATUS_SERVER_NOT_DISABLED ((NTSTATUS)0xC0000081L) + +// +// MessageId: STATUS_TOO_MANY_GUIDS_REQUESTED +// +// MessageText: +// +// Too many GUIDs were requested from the allocation server at once. +// +#define STATUS_TOO_MANY_GUIDS_REQUESTED ((NTSTATUS)0xC0000082L) + +// +// MessageId: STATUS_GUIDS_EXHAUSTED +// +// MessageText: +// +// The GUIDs could not be allocated because the Authority Agent was exhausted. +// +#define STATUS_GUIDS_EXHAUSTED ((NTSTATUS)0xC0000083L) + +// +// MessageId: STATUS_INVALID_ID_AUTHORITY +// +// MessageText: +// +// The value provided was an invalid value for an identifier authority. +// +#define STATUS_INVALID_ID_AUTHORITY ((NTSTATUS)0xC0000084L) + +// +// MessageId: STATUS_AGENTS_EXHAUSTED +// +// MessageText: +// +// There are no more authority agent values available for the given identifier authority value. +// +#define STATUS_AGENTS_EXHAUSTED ((NTSTATUS)0xC0000085L) + +// +// MessageId: STATUS_INVALID_VOLUME_LABEL +// +// MessageText: +// +// An invalid volume label has been specified. +// +#define STATUS_INVALID_VOLUME_LABEL ((NTSTATUS)0xC0000086L) + +// +// MessageId: STATUS_SECTION_NOT_EXTENDED +// +// MessageText: +// +// A mapped section could not be extended. +// +#define STATUS_SECTION_NOT_EXTENDED ((NTSTATUS)0xC0000087L) + +// +// MessageId: STATUS_NOT_MAPPED_DATA +// +// MessageText: +// +// Specified section to flush does not map a data file. +// +#define STATUS_NOT_MAPPED_DATA ((NTSTATUS)0xC0000088L) + +// +// MessageId: STATUS_RESOURCE_DATA_NOT_FOUND +// +// MessageText: +// +// Indicates the specified image file did not contain a resource section. +// +#define STATUS_RESOURCE_DATA_NOT_FOUND ((NTSTATUS)0xC0000089L) + +// +// MessageId: STATUS_RESOURCE_TYPE_NOT_FOUND +// +// MessageText: +// +// Indicates the specified resource type cannot be found in the image file. +// +#define STATUS_RESOURCE_TYPE_NOT_FOUND ((NTSTATUS)0xC000008AL) + +// +// MessageId: STATUS_RESOURCE_NAME_NOT_FOUND +// +// MessageText: +// +// Indicates the specified resource name cannot be found in the image file. +// +#define STATUS_RESOURCE_NAME_NOT_FOUND ((NTSTATUS)0xC000008BL) + +// +// MessageId: STATUS_ARRAY_BOUNDS_EXCEEDED +// +// MessageText: +// +// {EXCEPTION} +// Array bounds exceeded. +// +#define STATUS_ARRAY_BOUNDS_EXCEEDED ((NTSTATUS)0xC000008CL) // winnt + +// +// MessageId: STATUS_FLOAT_DENORMAL_OPERAND +// +// MessageText: +// +// {EXCEPTION} +// Floating-point denormal operand. +// +#define STATUS_FLOAT_DENORMAL_OPERAND ((NTSTATUS)0xC000008DL) // winnt + +// +// MessageId: STATUS_FLOAT_DIVIDE_BY_ZERO +// +// MessageText: +// +// {EXCEPTION} +// Floating-point division by zero. +// +#define STATUS_FLOAT_DIVIDE_BY_ZERO ((NTSTATUS)0xC000008EL) // winnt + +// +// MessageId: STATUS_FLOAT_INEXACT_RESULT +// +// MessageText: +// +// {EXCEPTION} +// Floating-point inexact result. +// +#define STATUS_FLOAT_INEXACT_RESULT ((NTSTATUS)0xC000008FL) // winnt + +// +// MessageId: STATUS_FLOAT_INVALID_OPERATION +// +// MessageText: +// +// {EXCEPTION} +// Floating-point invalid operation. +// +#define STATUS_FLOAT_INVALID_OPERATION ((NTSTATUS)0xC0000090L) // winnt + +// +// MessageId: STATUS_FLOAT_OVERFLOW +// +// MessageText: +// +// {EXCEPTION} +// Floating-point overflow. +// +#define STATUS_FLOAT_OVERFLOW ((NTSTATUS)0xC0000091L) // winnt + +// +// MessageId: STATUS_FLOAT_STACK_CHECK +// +// MessageText: +// +// {EXCEPTION} +// Floating-point stack check. +// +#define STATUS_FLOAT_STACK_CHECK ((NTSTATUS)0xC0000092L) // winnt + +// +// MessageId: STATUS_FLOAT_UNDERFLOW +// +// MessageText: +// +// {EXCEPTION} +// Floating-point underflow. +// +#define STATUS_FLOAT_UNDERFLOW ((NTSTATUS)0xC0000093L) // winnt + +// +// MessageId: STATUS_INTEGER_DIVIDE_BY_ZERO +// +// MessageText: +// +// {EXCEPTION} +// Integer division by zero. +// +#define STATUS_INTEGER_DIVIDE_BY_ZERO ((NTSTATUS)0xC0000094L) // winnt + +// +// MessageId: STATUS_INTEGER_OVERFLOW +// +// MessageText: +// +// {EXCEPTION} +// Integer overflow. +// +#define STATUS_INTEGER_OVERFLOW ((NTSTATUS)0xC0000095L) // winnt + +// +// MessageId: STATUS_PRIVILEGED_INSTRUCTION +// +// MessageText: +// +// {EXCEPTION} +// Privileged instruction. +// +#define STATUS_PRIVILEGED_INSTRUCTION ((NTSTATUS)0xC0000096L) // winnt + +// +// MessageId: STATUS_TOO_MANY_PAGING_FILES +// +// MessageText: +// +// An attempt was made to install more paging files than the system supports. +// +#define STATUS_TOO_MANY_PAGING_FILES ((NTSTATUS)0xC0000097L) + +// +// MessageId: STATUS_FILE_INVALID +// +// MessageText: +// +// The volume for a file has been externally altered such that the opened file is no longer valid. +// +#define STATUS_FILE_INVALID ((NTSTATUS)0xC0000098L) + +// +// MessageId: STATUS_ALLOTTED_SPACE_EXCEEDED +// +// MessageText: +// +// When a block of memory is allotted for future updates, such as the memory allocated to hold discretionary access control and primary group information, successive updates may exceed the amount of memory originally allotted. +// Since quota may already have been charged to several processes which have handles to the object, it is not reasonable to alter the size of the allocated memory. +// Instead, a request that requires more memory than has been allotted must fail and the STATUS_ALLOTED_SPACE_EXCEEDED error returned. +// +#define STATUS_ALLOTTED_SPACE_EXCEEDED ((NTSTATUS)0xC0000099L) + +// +// MessageId: STATUS_INSUFFICIENT_RESOURCES +// +// MessageText: +// +// Insufficient system resources exist to complete the API. +// +#define STATUS_INSUFFICIENT_RESOURCES ((NTSTATUS)0xC000009AL) // ntsubauth + +// +// MessageId: STATUS_DFS_EXIT_PATH_FOUND +// +// MessageText: +// +// An attempt has been made to open a DFS exit path control file. +// +#define STATUS_DFS_EXIT_PATH_FOUND ((NTSTATUS)0xC000009BL) + +// +// MessageId: STATUS_DEVICE_DATA_ERROR +// +// MessageText: +// +// STATUS_DEVICE_DATA_ERROR +// +#define STATUS_DEVICE_DATA_ERROR ((NTSTATUS)0xC000009CL) + +// +// MessageId: STATUS_DEVICE_NOT_CONNECTED +// +// MessageText: +// +// STATUS_DEVICE_NOT_CONNECTED +// +#define STATUS_DEVICE_NOT_CONNECTED ((NTSTATUS)0xC000009DL) + +// +// MessageId: STATUS_DEVICE_POWER_FAILURE +// +// MessageText: +// +// STATUS_DEVICE_POWER_FAILURE +// +#define STATUS_DEVICE_POWER_FAILURE ((NTSTATUS)0xC000009EL) + +// +// MessageId: STATUS_FREE_VM_NOT_AT_BASE +// +// MessageText: +// +// Virtual memory cannot be freed as base address is not the base of the region and a region size of zero was specified. +// +#define STATUS_FREE_VM_NOT_AT_BASE ((NTSTATUS)0xC000009FL) + +// +// MessageId: STATUS_MEMORY_NOT_ALLOCATED +// +// MessageText: +// +// An attempt was made to free virtual memory which is not allocated. +// +#define STATUS_MEMORY_NOT_ALLOCATED ((NTSTATUS)0xC00000A0L) + +// +// MessageId: STATUS_WORKING_SET_QUOTA +// +// MessageText: +// +// The working set is not big enough to allow the requested pages to be locked. +// +#define STATUS_WORKING_SET_QUOTA ((NTSTATUS)0xC00000A1L) + +// +// MessageId: STATUS_MEDIA_WRITE_PROTECTED +// +// MessageText: +// +// {Write Protect Error} +// The disk cannot be written to because it is write protected. Please remove the write protection from the volume %hs in drive %hs. +// +#define STATUS_MEDIA_WRITE_PROTECTED ((NTSTATUS)0xC00000A2L) + +// +// MessageId: STATUS_DEVICE_NOT_READY +// +// MessageText: +// +// {Drive Not Ready} +// The drive is not ready for use; its door may be open. Please check drive %hs and make sure that a disk is inserted and that the drive door is closed. +// +#define STATUS_DEVICE_NOT_READY ((NTSTATUS)0xC00000A3L) + +// +// MessageId: STATUS_INVALID_GROUP_ATTRIBUTES +// +// MessageText: +// +// The specified attributes are invalid, or incompatible with the attributes for the group as a whole. +// +#define STATUS_INVALID_GROUP_ATTRIBUTES ((NTSTATUS)0xC00000A4L) + +// +// MessageId: STATUS_BAD_IMPERSONATION_LEVEL +// +// MessageText: +// +// A specified impersonation level is invalid. +// Also used to indicate a required impersonation level was not provided. +// +#define STATUS_BAD_IMPERSONATION_LEVEL ((NTSTATUS)0xC00000A5L) + +// +// MessageId: STATUS_CANT_OPEN_ANONYMOUS +// +// MessageText: +// +// An attempt was made to open an Anonymous level token. +// Anonymous tokens may not be opened. +// +#define STATUS_CANT_OPEN_ANONYMOUS ((NTSTATUS)0xC00000A6L) + +// +// MessageId: STATUS_BAD_VALIDATION_CLASS +// +// MessageText: +// +// The validation information class requested was invalid. +// +#define STATUS_BAD_VALIDATION_CLASS ((NTSTATUS)0xC00000A7L) + +// +// MessageId: STATUS_BAD_TOKEN_TYPE +// +// MessageText: +// +// The type of a token object is inappropriate for its attempted use. +// +#define STATUS_BAD_TOKEN_TYPE ((NTSTATUS)0xC00000A8L) + +// +// MessageId: STATUS_BAD_MASTER_BOOT_RECORD +// +// MessageText: +// +// The type of a token object is inappropriate for its attempted use. +// +#define STATUS_BAD_MASTER_BOOT_RECORD ((NTSTATUS)0xC00000A9L) + +// +// MessageId: STATUS_INSTRUCTION_MISALIGNMENT +// +// MessageText: +// +// An attempt was made to execute an instruction at an unaligned address and the host system does not support unaligned instruction references. +// +#define STATUS_INSTRUCTION_MISALIGNMENT ((NTSTATUS)0xC00000AAL) + +// +// MessageId: STATUS_INSTANCE_NOT_AVAILABLE +// +// MessageText: +// +// The maximum named pipe instance count has been reached. +// +#define STATUS_INSTANCE_NOT_AVAILABLE ((NTSTATUS)0xC00000ABL) + +// +// MessageId: STATUS_PIPE_NOT_AVAILABLE +// +// MessageText: +// +// An instance of a named pipe cannot be found in the listening state. +// +#define STATUS_PIPE_NOT_AVAILABLE ((NTSTATUS)0xC00000ACL) + +// +// MessageId: STATUS_INVALID_PIPE_STATE +// +// MessageText: +// +// The named pipe is not in the connected or closing state. +// +#define STATUS_INVALID_PIPE_STATE ((NTSTATUS)0xC00000ADL) + +// +// MessageId: STATUS_PIPE_BUSY +// +// MessageText: +// +// The specified pipe is set to complete operations and there are current I/O operations queued so it cannot be changed to queue operations. +// +#define STATUS_PIPE_BUSY ((NTSTATUS)0xC00000AEL) + +// +// MessageId: STATUS_ILLEGAL_FUNCTION +// +// MessageText: +// +// The specified handle is not open to the server end of the named pipe. +// +#define STATUS_ILLEGAL_FUNCTION ((NTSTATUS)0xC00000AFL) + +// +// MessageId: STATUS_PIPE_DISCONNECTED +// +// MessageText: +// +// The specified named pipe is in the disconnected state. +// +#define STATUS_PIPE_DISCONNECTED ((NTSTATUS)0xC00000B0L) + +// +// MessageId: STATUS_PIPE_CLOSING +// +// MessageText: +// +// The specified named pipe is in the closing state. +// +#define STATUS_PIPE_CLOSING ((NTSTATUS)0xC00000B1L) + +// +// MessageId: STATUS_PIPE_CONNECTED +// +// MessageText: +// +// The specified named pipe is in the connected state. +// +#define STATUS_PIPE_CONNECTED ((NTSTATUS)0xC00000B2L) + +// +// MessageId: STATUS_PIPE_LISTENING +// +// MessageText: +// +// The specified named pipe is in the listening state. +// +#define STATUS_PIPE_LISTENING ((NTSTATUS)0xC00000B3L) + +// +// MessageId: STATUS_INVALID_READ_MODE +// +// MessageText: +// +// The specified named pipe is not in message mode. +// +#define STATUS_INVALID_READ_MODE ((NTSTATUS)0xC00000B4L) + +// +// MessageId: STATUS_IO_TIMEOUT +// +// MessageText: +// +// {Device Timeout} +// The specified I/O operation on %hs was not completed before the time-out period expired. +// +#define STATUS_IO_TIMEOUT ((NTSTATUS)0xC00000B5L) + +// +// MessageId: STATUS_FILE_FORCED_CLOSED +// +// MessageText: +// +// The specified file has been closed by another process. +// +#define STATUS_FILE_FORCED_CLOSED ((NTSTATUS)0xC00000B6L) + +// +// MessageId: STATUS_PROFILING_NOT_STARTED +// +// MessageText: +// +// Profiling not started. +// +#define STATUS_PROFILING_NOT_STARTED ((NTSTATUS)0xC00000B7L) + +// +// MessageId: STATUS_PROFILING_NOT_STOPPED +// +// MessageText: +// +// Profiling not stopped. +// +#define STATUS_PROFILING_NOT_STOPPED ((NTSTATUS)0xC00000B8L) + +// +// MessageId: STATUS_COULD_NOT_INTERPRET +// +// MessageText: +// +// The passed ACL did not contain the minimum required information. +// +#define STATUS_COULD_NOT_INTERPRET ((NTSTATUS)0xC00000B9L) + +// +// MessageId: STATUS_FILE_IS_A_DIRECTORY +// +// MessageText: +// +// The file that was specified as a target is a directory and the caller specified that it could be anything but a directory. +// +#define STATUS_FILE_IS_A_DIRECTORY ((NTSTATUS)0xC00000BAL) + +// +// Network specific errors. +// +// +// +// MessageId: STATUS_NOT_SUPPORTED +// +// MessageText: +// +// The request is not supported. +// +#define STATUS_NOT_SUPPORTED ((NTSTATUS)0xC00000BBL) + +// +// MessageId: STATUS_REMOTE_NOT_LISTENING +// +// MessageText: +// +// This remote computer is not listening. +// +#define STATUS_REMOTE_NOT_LISTENING ((NTSTATUS)0xC00000BCL) + +// +// MessageId: STATUS_DUPLICATE_NAME +// +// MessageText: +// +// A duplicate name exists on the network. +// +#define STATUS_DUPLICATE_NAME ((NTSTATUS)0xC00000BDL) + +// +// MessageId: STATUS_BAD_NETWORK_PATH +// +// MessageText: +// +// The network path cannot be located. +// +#define STATUS_BAD_NETWORK_PATH ((NTSTATUS)0xC00000BEL) + +// +// MessageId: STATUS_NETWORK_BUSY +// +// MessageText: +// +// The network is busy. +// +#define STATUS_NETWORK_BUSY ((NTSTATUS)0xC00000BFL) + +// +// MessageId: STATUS_DEVICE_DOES_NOT_EXIST +// +// MessageText: +// +// This device does not exist. +// +#define STATUS_DEVICE_DOES_NOT_EXIST ((NTSTATUS)0xC00000C0L) + +// +// MessageId: STATUS_TOO_MANY_COMMANDS +// +// MessageText: +// +// The network BIOS command limit has been reached. +// +#define STATUS_TOO_MANY_COMMANDS ((NTSTATUS)0xC00000C1L) + +// +// MessageId: STATUS_ADAPTER_HARDWARE_ERROR +// +// MessageText: +// +// An I/O adapter hardware error has occurred. +// +#define STATUS_ADAPTER_HARDWARE_ERROR ((NTSTATUS)0xC00000C2L) + +// +// MessageId: STATUS_INVALID_NETWORK_RESPONSE +// +// MessageText: +// +// The network responded incorrectly. +// +#define STATUS_INVALID_NETWORK_RESPONSE ((NTSTATUS)0xC00000C3L) + +// +// MessageId: STATUS_UNEXPECTED_NETWORK_ERROR +// +// MessageText: +// +// An unexpected network error occurred. +// +#define STATUS_UNEXPECTED_NETWORK_ERROR ((NTSTATUS)0xC00000C4L) + +// +// MessageId: STATUS_BAD_REMOTE_ADAPTER +// +// MessageText: +// +// The remote adapter is not compatible. +// +#define STATUS_BAD_REMOTE_ADAPTER ((NTSTATUS)0xC00000C5L) + +// +// MessageId: STATUS_PRINT_QUEUE_FULL +// +// MessageText: +// +// The printer queue is full. +// +#define STATUS_PRINT_QUEUE_FULL ((NTSTATUS)0xC00000C6L) + +// +// MessageId: STATUS_NO_SPOOL_SPACE +// +// MessageText: +// +// Space to store the file waiting to be printed is not available on the server. +// +#define STATUS_NO_SPOOL_SPACE ((NTSTATUS)0xC00000C7L) + +// +// MessageId: STATUS_PRINT_CANCELLED +// +// MessageText: +// +// The requested print file has been canceled. +// +#define STATUS_PRINT_CANCELLED ((NTSTATUS)0xC00000C8L) + +// +// MessageId: STATUS_NETWORK_NAME_DELETED +// +// MessageText: +// +// The network name was deleted. +// +#define STATUS_NETWORK_NAME_DELETED ((NTSTATUS)0xC00000C9L) + +// +// MessageId: STATUS_NETWORK_ACCESS_DENIED +// +// MessageText: +// +// Network access is denied. +// +#define STATUS_NETWORK_ACCESS_DENIED ((NTSTATUS)0xC00000CAL) + +// +// MessageId: STATUS_BAD_DEVICE_TYPE +// +// MessageText: +// +// {Incorrect Network Resource Type} +// The specified device type (LPT, for example) conflicts with the actual device type on the remote resource. +// +#define STATUS_BAD_DEVICE_TYPE ((NTSTATUS)0xC00000CBL) + +// +// MessageId: STATUS_BAD_NETWORK_NAME +// +// MessageText: +// +// {Network Name Not Found} +// The specified share name cannot be found on the remote server. +// +#define STATUS_BAD_NETWORK_NAME ((NTSTATUS)0xC00000CCL) + +// +// MessageId: STATUS_TOO_MANY_NAMES +// +// MessageText: +// +// The name limit for the local computer network adapter card was exceeded. +// +#define STATUS_TOO_MANY_NAMES ((NTSTATUS)0xC00000CDL) + +// +// MessageId: STATUS_TOO_MANY_SESSIONS +// +// MessageText: +// +// The network BIOS session limit was exceeded. +// +#define STATUS_TOO_MANY_SESSIONS ((NTSTATUS)0xC00000CEL) + +// +// MessageId: STATUS_SHARING_PAUSED +// +// MessageText: +// +// File sharing has been temporarily paused. +// +#define STATUS_SHARING_PAUSED ((NTSTATUS)0xC00000CFL) + +// +// MessageId: STATUS_REQUEST_NOT_ACCEPTED +// +// MessageText: +// +// No more connections can be made to this remote computer at this time because there are already as many connections as the computer can accept. +// +#define STATUS_REQUEST_NOT_ACCEPTED ((NTSTATUS)0xC00000D0L) + +// +// MessageId: STATUS_REDIRECTOR_PAUSED +// +// MessageText: +// +// Print or disk redirection is temporarily paused. +// +#define STATUS_REDIRECTOR_PAUSED ((NTSTATUS)0xC00000D1L) + +// +// MessageId: STATUS_NET_WRITE_FAULT +// +// MessageText: +// +// A network data fault occurred. +// +#define STATUS_NET_WRITE_FAULT ((NTSTATUS)0xC00000D2L) + +// +// MessageId: STATUS_PROFILING_AT_LIMIT +// +// MessageText: +// +// The number of active profiling objects is at the maximum and no more may be started. +// +#define STATUS_PROFILING_AT_LIMIT ((NTSTATUS)0xC00000D3L) + +// +// MessageId: STATUS_NOT_SAME_DEVICE +// +// MessageText: +// +// {Incorrect Volume} +// The target file of a rename request is located on a different device than the source of the rename request. +// +#define STATUS_NOT_SAME_DEVICE ((NTSTATUS)0xC00000D4L) + +// +// MessageId: STATUS_FILE_RENAMED +// +// MessageText: +// +// The file specified has been renamed and thus cannot be modified. +// +#define STATUS_FILE_RENAMED ((NTSTATUS)0xC00000D5L) + +// +// MessageId: STATUS_VIRTUAL_CIRCUIT_CLOSED +// +// MessageText: +// +// {Network Request Timeout} +// The session with a remote server has been disconnected because the time-out interval for a request has expired. +// +#define STATUS_VIRTUAL_CIRCUIT_CLOSED ((NTSTATUS)0xC00000D6L) + +// +// MessageId: STATUS_NO_SECURITY_ON_OBJECT +// +// MessageText: +// +// Indicates an attempt was made to operate on the security of an object that does not have security associated with it. +// +#define STATUS_NO_SECURITY_ON_OBJECT ((NTSTATUS)0xC00000D7L) + +// +// MessageId: STATUS_CANT_WAIT +// +// MessageText: +// +// Used to indicate that an operation cannot continue without blocking for I/O. +// +#define STATUS_CANT_WAIT ((NTSTATUS)0xC00000D8L) + +// +// MessageId: STATUS_PIPE_EMPTY +// +// MessageText: +// +// Used to indicate that a read operation was done on an empty pipe. +// +#define STATUS_PIPE_EMPTY ((NTSTATUS)0xC00000D9L) + +// +// MessageId: STATUS_CANT_ACCESS_DOMAIN_INFO +// +// MessageText: +// +// Configuration information could not be read from the domain controller, either because the machine is unavailable, or access has been denied. +// +#define STATUS_CANT_ACCESS_DOMAIN_INFO ((NTSTATUS)0xC00000DAL) + +// +// MessageId: STATUS_CANT_TERMINATE_SELF +// +// MessageText: +// +// Indicates that a thread attempted to terminate itself by default (called NtTerminateThread with NULL) and it was the last thread in the current process. +// +#define STATUS_CANT_TERMINATE_SELF ((NTSTATUS)0xC00000DBL) + +// +// MessageId: STATUS_INVALID_SERVER_STATE +// +// MessageText: +// +// Indicates the Sam Server was in the wrong state to perform the desired operation. +// +#define STATUS_INVALID_SERVER_STATE ((NTSTATUS)0xC00000DCL) + +// +// MessageId: STATUS_INVALID_DOMAIN_STATE +// +// MessageText: +// +// Indicates the Domain was in the wrong state to perform the desired operation. +// +#define STATUS_INVALID_DOMAIN_STATE ((NTSTATUS)0xC00000DDL) + +// +// MessageId: STATUS_INVALID_DOMAIN_ROLE +// +// MessageText: +// +// This operation is only allowed for the Primary Domain Controller of the domain. +// +#define STATUS_INVALID_DOMAIN_ROLE ((NTSTATUS)0xC00000DEL) + +// +// MessageId: STATUS_NO_SUCH_DOMAIN +// +// MessageText: +// +// The specified Domain did not exist. +// +#define STATUS_NO_SUCH_DOMAIN ((NTSTATUS)0xC00000DFL) + +// +// MessageId: STATUS_DOMAIN_EXISTS +// +// MessageText: +// +// The specified Domain already exists. +// +#define STATUS_DOMAIN_EXISTS ((NTSTATUS)0xC00000E0L) + +// +// MessageId: STATUS_DOMAIN_LIMIT_EXCEEDED +// +// MessageText: +// +// An attempt was made to exceed the limit on the number of domains per server for this release. +// +#define STATUS_DOMAIN_LIMIT_EXCEEDED ((NTSTATUS)0xC00000E1L) + +// +// MessageId: STATUS_OPLOCK_NOT_GRANTED +// +// MessageText: +// +// Error status returned when oplock request is denied. +// +#define STATUS_OPLOCK_NOT_GRANTED ((NTSTATUS)0xC00000E2L) + +// +// MessageId: STATUS_INVALID_OPLOCK_PROTOCOL +// +// MessageText: +// +// Error status returned when an invalid oplock acknowledgment is received by a file system. +// +#define STATUS_INVALID_OPLOCK_PROTOCOL ((NTSTATUS)0xC00000E3L) + +// +// MessageId: STATUS_INTERNAL_DB_CORRUPTION +// +// MessageText: +// +// This error indicates that the requested operation cannot be completed due to a catastrophic media failure or on-disk data structure corruption. +// +#define STATUS_INTERNAL_DB_CORRUPTION ((NTSTATUS)0xC00000E4L) + +// +// MessageId: STATUS_INTERNAL_ERROR +// +// MessageText: +// +// An internal error occurred. +// +#define STATUS_INTERNAL_ERROR ((NTSTATUS)0xC00000E5L) + +// +// MessageId: STATUS_GENERIC_NOT_MAPPED +// +// MessageText: +// +// Indicates generic access types were contained in an access mask which should already be mapped to non-generic access types. +// +#define STATUS_GENERIC_NOT_MAPPED ((NTSTATUS)0xC00000E6L) + +// +// MessageId: STATUS_BAD_DESCRIPTOR_FORMAT +// +// MessageText: +// +// Indicates a security descriptor is not in the necessary format (absolute or self-relative). +// +#define STATUS_BAD_DESCRIPTOR_FORMAT ((NTSTATUS)0xC00000E7L) + +// +// Status codes raised by the Cache Manager which must be considered as +// "expected" by its callers. +// +// +// MessageId: STATUS_INVALID_USER_BUFFER +// +// MessageText: +// +// An access to a user buffer failed at an "expected" point in time. This code is defined since the caller does not want to accept STATUS_ACCESS_VIOLATION in its filter. +// +#define STATUS_INVALID_USER_BUFFER ((NTSTATUS)0xC00000E8L) + +// +// MessageId: STATUS_UNEXPECTED_IO_ERROR +// +// MessageText: +// +// If an I/O error is returned which is not defined in the standard FsRtl filter, it is converted to the following error which is guaranteed to be in the filter. In this case information is lost, however, the filter correctly handles the exception. +// +#define STATUS_UNEXPECTED_IO_ERROR ((NTSTATUS)0xC00000E9L) + +// +// MessageId: STATUS_UNEXPECTED_MM_CREATE_ERR +// +// MessageText: +// +// If an MM error is returned which is not defined in the standard FsRtl filter, it is converted to one of the following errors which is guaranteed to be in the filter. In this case information is lost, however, the filter correctly handles the exception. +// +#define STATUS_UNEXPECTED_MM_CREATE_ERR ((NTSTATUS)0xC00000EAL) + +// +// MessageId: STATUS_UNEXPECTED_MM_MAP_ERROR +// +// MessageText: +// +// If an MM error is returned which is not defined in the standard FsRtl filter, it is converted to one of the following errors which is guaranteed to be in the filter. In this case information is lost, however, the filter correctly handles the exception. +// +#define STATUS_UNEXPECTED_MM_MAP_ERROR ((NTSTATUS)0xC00000EBL) + +// +// MessageId: STATUS_UNEXPECTED_MM_EXTEND_ERR +// +// MessageText: +// +// If an MM error is returned which is not defined in the standard FsRtl filter, it is converted to one of the following errors which is guaranteed to be in the filter. In this case information is lost, however, the filter correctly handles the exception. +// +#define STATUS_UNEXPECTED_MM_EXTEND_ERR ((NTSTATUS)0xC00000ECL) + +// +// MessageId: STATUS_NOT_LOGON_PROCESS +// +// MessageText: +// +// The requested action is restricted for use by logon processes only. The calling process has not registered as a logon process. +// +#define STATUS_NOT_LOGON_PROCESS ((NTSTATUS)0xC00000EDL) + +// +// MessageId: STATUS_LOGON_SESSION_EXISTS +// +// MessageText: +// +// An attempt has been made to start a new session manager or LSA logon session with an ID that is already in use. +// +#define STATUS_LOGON_SESSION_EXISTS ((NTSTATUS)0xC00000EEL) + +// +// MessageId: STATUS_INVALID_PARAMETER_1 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the first argument. +// +#define STATUS_INVALID_PARAMETER_1 ((NTSTATUS)0xC00000EFL) + +// +// MessageId: STATUS_INVALID_PARAMETER_2 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the second argument. +// +#define STATUS_INVALID_PARAMETER_2 ((NTSTATUS)0xC00000F0L) + +// +// MessageId: STATUS_INVALID_PARAMETER_3 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the third argument. +// +#define STATUS_INVALID_PARAMETER_3 ((NTSTATUS)0xC00000F1L) + +// +// MessageId: STATUS_INVALID_PARAMETER_4 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the fourth argument. +// +#define STATUS_INVALID_PARAMETER_4 ((NTSTATUS)0xC00000F2L) + +// +// MessageId: STATUS_INVALID_PARAMETER_5 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the fifth argument. +// +#define STATUS_INVALID_PARAMETER_5 ((NTSTATUS)0xC00000F3L) + +// +// MessageId: STATUS_INVALID_PARAMETER_6 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the sixth argument. +// +#define STATUS_INVALID_PARAMETER_6 ((NTSTATUS)0xC00000F4L) + +// +// MessageId: STATUS_INVALID_PARAMETER_7 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the seventh argument. +// +#define STATUS_INVALID_PARAMETER_7 ((NTSTATUS)0xC00000F5L) + +// +// MessageId: STATUS_INVALID_PARAMETER_8 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the eighth argument. +// +#define STATUS_INVALID_PARAMETER_8 ((NTSTATUS)0xC00000F6L) + +// +// MessageId: STATUS_INVALID_PARAMETER_9 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the ninth argument. +// +#define STATUS_INVALID_PARAMETER_9 ((NTSTATUS)0xC00000F7L) + +// +// MessageId: STATUS_INVALID_PARAMETER_10 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the tenth argument. +// +#define STATUS_INVALID_PARAMETER_10 ((NTSTATUS)0xC00000F8L) + +// +// MessageId: STATUS_INVALID_PARAMETER_11 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the eleventh argument. +// +#define STATUS_INVALID_PARAMETER_11 ((NTSTATUS)0xC00000F9L) + +// +// MessageId: STATUS_INVALID_PARAMETER_12 +// +// MessageText: +// +// An invalid parameter was passed to a service or function as the twelfth argument. +// +#define STATUS_INVALID_PARAMETER_12 ((NTSTATUS)0xC00000FAL) + +// +// MessageId: STATUS_REDIRECTOR_NOT_STARTED +// +// MessageText: +// +// An attempt was made to access a network file, but the network software was not yet started. +// +#define STATUS_REDIRECTOR_NOT_STARTED ((NTSTATUS)0xC00000FBL) + +// +// MessageId: STATUS_REDIRECTOR_STARTED +// +// MessageText: +// +// An attempt was made to start the redirector, but the redirector has already been started. +// +#define STATUS_REDIRECTOR_STARTED ((NTSTATUS)0xC00000FCL) + +// +// MessageId: STATUS_STACK_OVERFLOW +// +// MessageText: +// +// A new guard page for the stack cannot be created. +// +#define STATUS_STACK_OVERFLOW ((NTSTATUS)0xC00000FDL) // winnt + +// +// MessageId: STATUS_NO_SUCH_PACKAGE +// +// MessageText: +// +// A specified authentication package is unknown. +// +#define STATUS_NO_SUCH_PACKAGE ((NTSTATUS)0xC00000FEL) + +// +// MessageId: STATUS_BAD_FUNCTION_TABLE +// +// MessageText: +// +// A malformed function table was encountered during an unwind operation. +// +#define STATUS_BAD_FUNCTION_TABLE ((NTSTATUS)0xC00000FFL) + +// +// MessageId: STATUS_VARIABLE_NOT_FOUND +// +// MessageText: +// +// Indicates the specified environment variable name was not found in the specified environment block. +// +#define STATUS_VARIABLE_NOT_FOUND ((NTSTATUS)0xC0000100L) + +// +// MessageId: STATUS_DIRECTORY_NOT_EMPTY +// +// MessageText: +// +// Indicates that the directory trying to be deleted is not empty. +// +#define STATUS_DIRECTORY_NOT_EMPTY ((NTSTATUS)0xC0000101L) + +// +// MessageId: STATUS_FILE_CORRUPT_ERROR +// +// MessageText: +// +// {Corrupt File} +// The file or directory %hs is corrupt and unreadable. +// Please run the Chkdsk utility. +// +#define STATUS_FILE_CORRUPT_ERROR ((NTSTATUS)0xC0000102L) + +// +// MessageId: STATUS_NOT_A_DIRECTORY +// +// MessageText: +// +// A requested opened file is not a directory. +// +#define STATUS_NOT_A_DIRECTORY ((NTSTATUS)0xC0000103L) + +// +// MessageId: STATUS_BAD_LOGON_SESSION_STATE +// +// MessageText: +// +// The logon session is not in a state that is consistent with the requested operation. +// +#define STATUS_BAD_LOGON_SESSION_STATE ((NTSTATUS)0xC0000104L) + +// +// MessageId: STATUS_LOGON_SESSION_COLLISION +// +// MessageText: +// +// An internal LSA error has occurred. An authentication package has requested the creation of a Logon Session but the ID of an already existing Logon Session has been specified. +// +#define STATUS_LOGON_SESSION_COLLISION ((NTSTATUS)0xC0000105L) + +// +// MessageId: STATUS_NAME_TOO_LONG +// +// MessageText: +// +// A specified name string is too long for its intended use. +// +#define STATUS_NAME_TOO_LONG ((NTSTATUS)0xC0000106L) + +// +// MessageId: STATUS_FILES_OPEN +// +// MessageText: +// +// The user attempted to force close the files on a redirected drive, but there were opened files on the drive, and the user did not specify a sufficient level of force. +// +#define STATUS_FILES_OPEN ((NTSTATUS)0xC0000107L) + +// +// MessageId: STATUS_CONNECTION_IN_USE +// +// MessageText: +// +// The user attempted to force close the files on a redirected drive, but there were opened directories on the drive, and the user did not specify a sufficient level of force. +// +#define STATUS_CONNECTION_IN_USE ((NTSTATUS)0xC0000108L) + +// +// MessageId: STATUS_MESSAGE_NOT_FOUND +// +// MessageText: +// +// RtlFindMessage could not locate the requested message ID in the message table resource. +// +#define STATUS_MESSAGE_NOT_FOUND ((NTSTATUS)0xC0000109L) + +// +// MessageId: STATUS_PROCESS_IS_TERMINATING +// +// MessageText: +// +// An attempt was made to access an exiting process. +// +#define STATUS_PROCESS_IS_TERMINATING ((NTSTATUS)0xC000010AL) + +// +// MessageId: STATUS_INVALID_LOGON_TYPE +// +// MessageText: +// +// Indicates an invalid value has been provided for the LogonType requested. +// +#define STATUS_INVALID_LOGON_TYPE ((NTSTATUS)0xC000010BL) + +// +// MessageId: STATUS_NO_GUID_TRANSLATION +// +// MessageText: +// +// Indicates that an attempt was made to assign protection to a file system file or directory and one of the SIDs in the security descriptor could not be translated into a GUID that could be stored by the file system. +// This causes the protection attempt to fail, which may cause a file creation attempt to fail. +// +#define STATUS_NO_GUID_TRANSLATION ((NTSTATUS)0xC000010CL) + +// +// MessageId: STATUS_CANNOT_IMPERSONATE +// +// MessageText: +// +// Indicates that an attempt has been made to impersonate via a named pipe that has not yet been read from. +// +#define STATUS_CANNOT_IMPERSONATE ((NTSTATUS)0xC000010DL) + +// +// MessageId: STATUS_IMAGE_ALREADY_LOADED +// +// MessageText: +// +// Indicates that the specified image is already loaded. +// +#define STATUS_IMAGE_ALREADY_LOADED ((NTSTATUS)0xC000010EL) + + +// +// ============================================================ +// NOTE: The following ABIOS error code should be reserved on +// non ABIOS kernel. Eventually, I will remove the ifdef +// ABIOS. +// ============================================================ +// +// +// MessageId: STATUS_ABIOS_NOT_PRESENT +// +// MessageText: +// +// STATUS_ABIOS_NOT_PRESENT +// +#define STATUS_ABIOS_NOT_PRESENT ((NTSTATUS)0xC000010FL) + +// +// MessageId: STATUS_ABIOS_LID_NOT_EXIST +// +// MessageText: +// +// STATUS_ABIOS_LID_NOT_EXIST +// +#define STATUS_ABIOS_LID_NOT_EXIST ((NTSTATUS)0xC0000110L) + +// +// MessageId: STATUS_ABIOS_LID_ALREADY_OWNED +// +// MessageText: +// +// STATUS_ABIOS_LID_ALREADY_OWNED +// +#define STATUS_ABIOS_LID_ALREADY_OWNED ((NTSTATUS)0xC0000111L) + +// +// MessageId: STATUS_ABIOS_NOT_LID_OWNER +// +// MessageText: +// +// STATUS_ABIOS_NOT_LID_OWNER +// +#define STATUS_ABIOS_NOT_LID_OWNER ((NTSTATUS)0xC0000112L) + +// +// MessageId: STATUS_ABIOS_INVALID_COMMAND +// +// MessageText: +// +// STATUS_ABIOS_INVALID_COMMAND +// +#define STATUS_ABIOS_INVALID_COMMAND ((NTSTATUS)0xC0000113L) + +// +// MessageId: STATUS_ABIOS_INVALID_LID +// +// MessageText: +// +// STATUS_ABIOS_INVALID_LID +// +#define STATUS_ABIOS_INVALID_LID ((NTSTATUS)0xC0000114L) + +// +// MessageId: STATUS_ABIOS_SELECTOR_NOT_AVAILABLE +// +// MessageText: +// +// STATUS_ABIOS_SELECTOR_NOT_AVAILABLE +// +#define STATUS_ABIOS_SELECTOR_NOT_AVAILABLE ((NTSTATUS)0xC0000115L) + +// +// MessageId: STATUS_ABIOS_INVALID_SELECTOR +// +// MessageText: +// +// STATUS_ABIOS_INVALID_SELECTOR +// +#define STATUS_ABIOS_INVALID_SELECTOR ((NTSTATUS)0xC0000116L) + +// +// MessageId: STATUS_NO_LDT +// +// MessageText: +// +// Indicates that an attempt was made to change the size of the LDT for a process that has no LDT. +// +#define STATUS_NO_LDT ((NTSTATUS)0xC0000117L) + +// +// MessageId: STATUS_INVALID_LDT_SIZE +// +// MessageText: +// +// Indicates that an attempt was made to grow an LDT by setting its size, or that the size was not an even number of selectors. +// +#define STATUS_INVALID_LDT_SIZE ((NTSTATUS)0xC0000118L) + +// +// MessageId: STATUS_INVALID_LDT_OFFSET +// +// MessageText: +// +// Indicates that the starting value for the LDT information was not an integral multiple of the selector size. +// +#define STATUS_INVALID_LDT_OFFSET ((NTSTATUS)0xC0000119L) + +// +// MessageId: STATUS_INVALID_LDT_DESCRIPTOR +// +// MessageText: +// +// Indicates that the user supplied an invalid descriptor when trying to set up Ldt descriptors. +// +#define STATUS_INVALID_LDT_DESCRIPTOR ((NTSTATUS)0xC000011AL) + +// +// MessageId: STATUS_INVALID_IMAGE_NE_FORMAT +// +// MessageText: +// +// The specified image file did not have the correct format. It appears to be NE format. +// +#define STATUS_INVALID_IMAGE_NE_FORMAT ((NTSTATUS)0xC000011BL) + +// +// MessageId: STATUS_RXACT_INVALID_STATE +// +// MessageText: +// +// Indicates that the transaction state of a registry sub-tree is incompatible with the requested operation. For example, a request has been made to start a new transaction with one already in progress, or a request has been made to apply a transaction when one is not currently in progress. +// +#define STATUS_RXACT_INVALID_STATE ((NTSTATUS)0xC000011CL) + +// +// MessageId: STATUS_RXACT_COMMIT_FAILURE +// +// MessageText: +// +// Indicates an error has occurred during a registry transaction commit. The database has been left in an unknown, but probably inconsistent, state. The state of the registry transaction is left as COMMITTING. +// +#define STATUS_RXACT_COMMIT_FAILURE ((NTSTATUS)0xC000011DL) + +// +// MessageId: STATUS_MAPPED_FILE_SIZE_ZERO +// +// MessageText: +// +// An attempt was made to map a file of size zero with the maximum size specified as zero. +// +#define STATUS_MAPPED_FILE_SIZE_ZERO ((NTSTATUS)0xC000011EL) + +// +// MessageId: STATUS_TOO_MANY_OPENED_FILES +// +// MessageText: +// +// Too many files are opened on a remote server. +// This error should only be returned by the Windows redirector on a remote drive. +// +#define STATUS_TOO_MANY_OPENED_FILES ((NTSTATUS)0xC000011FL) + +// +// MessageId: STATUS_CANCELLED +// +// MessageText: +// +// The I/O request was canceled. +// +#define STATUS_CANCELLED ((NTSTATUS)0xC0000120L) + +// +// MessageId: STATUS_CANNOT_DELETE +// +// MessageText: +// +// An attempt has been made to remove a file or directory that cannot be deleted. +// +#define STATUS_CANNOT_DELETE ((NTSTATUS)0xC0000121L) + +// +// MessageId: STATUS_INVALID_COMPUTER_NAME +// +// MessageText: +// +// Indicates a name specified as a remote computer name is syntactically invalid. +// +#define STATUS_INVALID_COMPUTER_NAME ((NTSTATUS)0xC0000122L) + +// +// MessageId: STATUS_FILE_DELETED +// +// MessageText: +// +// An I/O request other than close was performed on a file after it has been deleted, which can only happen to a request which did not complete before the last handle was closed via NtClose. +// +#define STATUS_FILE_DELETED ((NTSTATUS)0xC0000123L) + +// +// MessageId: STATUS_SPECIAL_ACCOUNT +// +// MessageText: +// +// Indicates an operation has been attempted on a built-in (special) SAM account which is incompatible with built-in accounts. For example, built-in accounts cannot be deleted. +// +#define STATUS_SPECIAL_ACCOUNT ((NTSTATUS)0xC0000124L) + +// +// MessageId: STATUS_SPECIAL_GROUP +// +// MessageText: +// +// The operation requested may not be performed on the specified group because it is a built-in special group. +// +#define STATUS_SPECIAL_GROUP ((NTSTATUS)0xC0000125L) + +// +// MessageId: STATUS_SPECIAL_USER +// +// MessageText: +// +// The operation requested may not be performed on the specified user because it is a built-in special user. +// +#define STATUS_SPECIAL_USER ((NTSTATUS)0xC0000126L) + +// +// MessageId: STATUS_MEMBERS_PRIMARY_GROUP +// +// MessageText: +// +// Indicates a member cannot be removed from a group because the group is currently the member's primary group. +// +#define STATUS_MEMBERS_PRIMARY_GROUP ((NTSTATUS)0xC0000127L) + +// +// MessageId: STATUS_FILE_CLOSED +// +// MessageText: +// +// An I/O request other than close and several other special case operations was attempted using a file object that had already been closed. +// +#define STATUS_FILE_CLOSED ((NTSTATUS)0xC0000128L) + +// +// MessageId: STATUS_TOO_MANY_THREADS +// +// MessageText: +// +// Indicates a process has too many threads to perform the requested action. For example, assignment of a primary token may only be performed when a process has zero or one threads. +// +#define STATUS_TOO_MANY_THREADS ((NTSTATUS)0xC0000129L) + +// +// MessageId: STATUS_THREAD_NOT_IN_PROCESS +// +// MessageText: +// +// An attempt was made to operate on a thread within a specific process, but the thread specified is not in the process specified. +// +#define STATUS_THREAD_NOT_IN_PROCESS ((NTSTATUS)0xC000012AL) + +// +// MessageId: STATUS_TOKEN_ALREADY_IN_USE +// +// MessageText: +// +// An attempt was made to establish a token for use as a primary token but the token is already in use. A token can only be the primary token of one process at a time. +// +#define STATUS_TOKEN_ALREADY_IN_USE ((NTSTATUS)0xC000012BL) + +// +// MessageId: STATUS_PAGEFILE_QUOTA_EXCEEDED +// +// MessageText: +// +// Pagefile quota was exceeded. +// +#define STATUS_PAGEFILE_QUOTA_EXCEEDED ((NTSTATUS)0xC000012CL) + +// +// MessageId: STATUS_COMMITMENT_LIMIT +// +// MessageText: +// +// {Out of Virtual Memory} +// Your system is low on virtual memory. To ensure that Windows runs properly, increase the size of your virtual memory paging file. For more information, see Help. +// +#define STATUS_COMMITMENT_LIMIT ((NTSTATUS)0xC000012DL) + +// +// MessageId: STATUS_INVALID_IMAGE_LE_FORMAT +// +// MessageText: +// +// The specified image file did not have the correct format, it appears to be LE format. +// +#define STATUS_INVALID_IMAGE_LE_FORMAT ((NTSTATUS)0xC000012EL) + +// +// MessageId: STATUS_INVALID_IMAGE_NOT_MZ +// +// MessageText: +// +// The specified image file did not have the correct format, it did not have an initial MZ. +// +#define STATUS_INVALID_IMAGE_NOT_MZ ((NTSTATUS)0xC000012FL) + +// +// MessageId: STATUS_INVALID_IMAGE_PROTECT +// +// MessageText: +// +// The specified image file did not have the correct format, it did not have a proper e_lfarlc in the MZ header. +// +#define STATUS_INVALID_IMAGE_PROTECT ((NTSTATUS)0xC0000130L) + +// +// MessageId: STATUS_INVALID_IMAGE_WIN_16 +// +// MessageText: +// +// The specified image file did not have the correct format, it appears to be a 16-bit Windows image. +// +#define STATUS_INVALID_IMAGE_WIN_16 ((NTSTATUS)0xC0000131L) + +// +// MessageId: STATUS_LOGON_SERVER_CONFLICT +// +// MessageText: +// +// The Netlogon service cannot start because another Netlogon service running in the domain conflicts with the specified role. +// +#define STATUS_LOGON_SERVER_CONFLICT ((NTSTATUS)0xC0000132L) + +// +// MessageId: STATUS_TIME_DIFFERENCE_AT_DC +// +// MessageText: +// +// The time at the Primary Domain Controller is different than the time at the Backup Domain Controller or member server by too large an amount. +// +#define STATUS_TIME_DIFFERENCE_AT_DC ((NTSTATUS)0xC0000133L) + +// +// MessageId: STATUS_SYNCHRONIZATION_REQUIRED +// +// MessageText: +// +// The SAM database on a Windows Server is significantly out of synchronization with the copy on the Domain Controller. A complete synchronization is required. +// +#define STATUS_SYNCHRONIZATION_REQUIRED ((NTSTATUS)0xC0000134L) + +// +// MessageId: STATUS_DLL_NOT_FOUND +// +// MessageText: +// +// The code execution cannot proceed because %hs was not found. Reinstalling the program may fix this problem. +// +#define STATUS_DLL_NOT_FOUND ((NTSTATUS)0xC0000135L) // winnt + +// +// MessageId: STATUS_OPEN_FAILED +// +// MessageText: +// +// The NtCreateFile API failed. This error should never be returned to an application, it is a place holder for the Windows Lan Manager Redirector to use in its internal error mapping routines. +// +#define STATUS_OPEN_FAILED ((NTSTATUS)0xC0000136L) + +// +// MessageId: STATUS_IO_PRIVILEGE_FAILED +// +// MessageText: +// +// {Privilege Failed} +// The I/O permissions for the process could not be changed. +// +#define STATUS_IO_PRIVILEGE_FAILED ((NTSTATUS)0xC0000137L) + +// +// MessageId: STATUS_ORDINAL_NOT_FOUND +// +// MessageText: +// +// {Ordinal Not Found} +// The ordinal %ld could not be located in the dynamic link library %hs. +// +#define STATUS_ORDINAL_NOT_FOUND ((NTSTATUS)0xC0000138L) // winnt + +// +// MessageId: STATUS_ENTRYPOINT_NOT_FOUND +// +// MessageText: +// +// {Entry Point Not Found} +// The procedure entry point %hs could not be located in the dynamic link library %hs. +// +#define STATUS_ENTRYPOINT_NOT_FOUND ((NTSTATUS)0xC0000139L) // winnt + +// +// MessageId: STATUS_CONTROL_C_EXIT +// +// MessageText: +// +// {Application Exit by CTRL+C} +// The application terminated as a result of a CTRL+C. +// +#define STATUS_CONTROL_C_EXIT ((NTSTATUS)0xC000013AL) // winnt + +// +// MessageId: STATUS_LOCAL_DISCONNECT +// +// MessageText: +// +// {Virtual Circuit Closed} +// The network transport on your computer has closed a network connection. There may or may not be I/O requests outstanding. +// +#define STATUS_LOCAL_DISCONNECT ((NTSTATUS)0xC000013BL) + +// +// MessageId: STATUS_REMOTE_DISCONNECT +// +// MessageText: +// +// {Virtual Circuit Closed} +// The network transport on a remote computer has closed a network connection. There may or may not be I/O requests outstanding. +// +#define STATUS_REMOTE_DISCONNECT ((NTSTATUS)0xC000013CL) + +// +// MessageId: STATUS_REMOTE_RESOURCES +// +// MessageText: +// +// {Insufficient Resources on Remote Computer} +// The remote computer has insufficient resources to complete the network request. For instance, there may not be enough memory available on the remote computer to carry out the request at this time. +// +#define STATUS_REMOTE_RESOURCES ((NTSTATUS)0xC000013DL) + +// +// MessageId: STATUS_LINK_FAILED +// +// MessageText: +// +// {Virtual Circuit Closed} +// An existing connection (virtual circuit) has been broken at the remote computer. There is probably something wrong with the network software protocol or the network hardware on the remote computer. +// +#define STATUS_LINK_FAILED ((NTSTATUS)0xC000013EL) + +// +// MessageId: STATUS_LINK_TIMEOUT +// +// MessageText: +// +// {Virtual Circuit Closed} +// The network transport on your computer has closed a network connection because it had to wait too long for a response from the remote computer. +// +#define STATUS_LINK_TIMEOUT ((NTSTATUS)0xC000013FL) + +// +// MessageId: STATUS_INVALID_CONNECTION +// +// MessageText: +// +// The connection handle given to the transport was invalid. +// +#define STATUS_INVALID_CONNECTION ((NTSTATUS)0xC0000140L) + +// +// MessageId: STATUS_INVALID_ADDRESS +// +// MessageText: +// +// The address handle given to the transport was invalid. +// +#define STATUS_INVALID_ADDRESS ((NTSTATUS)0xC0000141L) + +// +// MessageId: STATUS_DLL_INIT_FAILED +// +// MessageText: +// +// {DLL Initialization Failed} +// Initialization of the dynamic link library %hs failed. The process is terminating abnormally. +// +#define STATUS_DLL_INIT_FAILED ((NTSTATUS)0xC0000142L) // winnt + +// +// MessageId: STATUS_MISSING_SYSTEMFILE +// +// MessageText: +// +// {Missing System File} +// The required system file %hs is bad or missing. +// +#define STATUS_MISSING_SYSTEMFILE ((NTSTATUS)0xC0000143L) + +// +// MessageId: STATUS_UNHANDLED_EXCEPTION +// +// MessageText: +// +// {Application Error} +// The exception %s (0x%08lx) occurred in the application at location 0x%p. +// +#define STATUS_UNHANDLED_EXCEPTION ((NTSTATUS)0xC0000144L) + +// +// MessageId: STATUS_APP_INIT_FAILURE +// +// MessageText: +// +// {Application Error} +// The application was unable to start correctly (0x%lx). Click OK to close the application. +// +#define STATUS_APP_INIT_FAILURE ((NTSTATUS)0xC0000145L) + +// +// MessageId: STATUS_PAGEFILE_CREATE_FAILED +// +// MessageText: +// +// {Unable to Create Paging File} +// The creation of the paging file %hs failed (%lx). The requested size was %ld. +// +#define STATUS_PAGEFILE_CREATE_FAILED ((NTSTATUS)0xC0000146L) + +// +// MessageId: STATUS_NO_PAGEFILE +// +// MessageText: +// +// {No Paging File Specified} +// No paging file was specified in the system configuration. +// +#define STATUS_NO_PAGEFILE ((NTSTATUS)0xC0000147L) + +// +// MessageId: STATUS_INVALID_LEVEL +// +// MessageText: +// +// {Incorrect System Call Level} +// An invalid level was passed into the specified system call. +// +#define STATUS_INVALID_LEVEL ((NTSTATUS)0xC0000148L) + +// +// MessageId: STATUS_WRONG_PASSWORD_CORE +// +// MessageText: +// +// {Incorrect Password to LAN Manager Server} +// You specified an incorrect password to a LAN Manager 2.x or MS-NET server. +// +#define STATUS_WRONG_PASSWORD_CORE ((NTSTATUS)0xC0000149L) + +// +// MessageId: STATUS_ILLEGAL_FLOAT_CONTEXT +// +// MessageText: +// +// {EXCEPTION} +// A real-mode application issued a floating-point instruction and floating-point hardware is not present. +// +#define STATUS_ILLEGAL_FLOAT_CONTEXT ((NTSTATUS)0xC000014AL) + +// +// MessageId: STATUS_PIPE_BROKEN +// +// MessageText: +// +// The pipe operation has failed because the other end of the pipe has been closed. +// +#define STATUS_PIPE_BROKEN ((NTSTATUS)0xC000014BL) + +// +// MessageId: STATUS_REGISTRY_CORRUPT +// +// MessageText: +// +// {The Registry Is Corrupt} +// The structure of one of the files that contains Registry data is corrupt, or the image of the file in memory is corrupt, or the file could not be recovered because the alternate copy or log was absent or corrupt. +// +#define STATUS_REGISTRY_CORRUPT ((NTSTATUS)0xC000014CL) + +// +// MessageId: STATUS_REGISTRY_IO_FAILED +// +// MessageText: +// +// An I/O operation initiated by the Registry failed unrecoverably. The Registry could not read in, or write out, or flush, one of the files that contain the system's image of the Registry. +// +#define STATUS_REGISTRY_IO_FAILED ((NTSTATUS)0xC000014DL) + +// +// MessageId: STATUS_NO_EVENT_PAIR +// +// MessageText: +// +// An event pair synchronization operation was performed using the thread specific client/server event pair object, but no event pair object was associated with the thread. +// +#define STATUS_NO_EVENT_PAIR ((NTSTATUS)0xC000014EL) + +// +// MessageId: STATUS_UNRECOGNIZED_VOLUME +// +// MessageText: +// +// The volume does not contain a recognized file system. Please make sure that all required file system drivers are loaded and that the volume is not corrupt. +// +#define STATUS_UNRECOGNIZED_VOLUME ((NTSTATUS)0xC000014FL) + +// +// MessageId: STATUS_SERIAL_NO_DEVICE_INITED +// +// MessageText: +// +// No serial device was successfully initialized. The serial driver will unload. +// +#define STATUS_SERIAL_NO_DEVICE_INITED ((NTSTATUS)0xC0000150L) + +// +// MessageId: STATUS_NO_SUCH_ALIAS +// +// MessageText: +// +// The specified local group does not exist. +// +#define STATUS_NO_SUCH_ALIAS ((NTSTATUS)0xC0000151L) + +// +// MessageId: STATUS_MEMBER_NOT_IN_ALIAS +// +// MessageText: +// +// The specified account name is not a member of the group. +// +#define STATUS_MEMBER_NOT_IN_ALIAS ((NTSTATUS)0xC0000152L) + +// +// MessageId: STATUS_MEMBER_IN_ALIAS +// +// MessageText: +// +// The specified account name is already a member of the group. +// +#define STATUS_MEMBER_IN_ALIAS ((NTSTATUS)0xC0000153L) + +// +// MessageId: STATUS_ALIAS_EXISTS +// +// MessageText: +// +// The specified local group already exists. +// +#define STATUS_ALIAS_EXISTS ((NTSTATUS)0xC0000154L) + +// +// MessageId: STATUS_LOGON_NOT_GRANTED +// +// MessageText: +// +// A requested type of logon (e.g., Interactive, Network, Service) is not granted by the target system's local security policy. +// Please ask the system administrator to grant the necessary form of logon. +// +#define STATUS_LOGON_NOT_GRANTED ((NTSTATUS)0xC0000155L) + +// +// MessageId: STATUS_TOO_MANY_SECRETS +// +// MessageText: +// +// The maximum number of secrets that may be stored in a single system has been exceeded. The length and number of secrets is limited to satisfy United States State Department export restrictions. +// +#define STATUS_TOO_MANY_SECRETS ((NTSTATUS)0xC0000156L) + +// +// MessageId: STATUS_SECRET_TOO_LONG +// +// MessageText: +// +// The length of a secret exceeds the maximum length allowed. The length and number of secrets is limited to satisfy United States State Department export restrictions. +// +#define STATUS_SECRET_TOO_LONG ((NTSTATUS)0xC0000157L) + +// +// MessageId: STATUS_INTERNAL_DB_ERROR +// +// MessageText: +// +// The Local Security Authority (LSA) database contains an internal inconsistency. +// +#define STATUS_INTERNAL_DB_ERROR ((NTSTATUS)0xC0000158L) + +// +// MessageId: STATUS_FULLSCREEN_MODE +// +// MessageText: +// +// The requested operation cannot be performed in fullscreen mode. +// +#define STATUS_FULLSCREEN_MODE ((NTSTATUS)0xC0000159L) + +// +// MessageId: STATUS_TOO_MANY_CONTEXT_IDS +// +// MessageText: +// +// During a logon attempt, the user's security context accumulated too many security IDs. This is a very unusual situation. Remove the user from some global or local groups to reduce the number of security ids to incorporate into the security context. +// +#define STATUS_TOO_MANY_CONTEXT_IDS ((NTSTATUS)0xC000015AL) + +// +// MessageId: STATUS_LOGON_TYPE_NOT_GRANTED +// +// MessageText: +// +// A user has requested a type of logon (e.g., interactive or network) that has not been granted. An administrator has control over who may logon interactively and through the network. +// +#define STATUS_LOGON_TYPE_NOT_GRANTED ((NTSTATUS)0xC000015BL) + +// +// MessageId: STATUS_NOT_REGISTRY_FILE +// +// MessageText: +// +// The system has attempted to load or restore a file into the registry, and the specified file is not in the format of a registry file. +// +#define STATUS_NOT_REGISTRY_FILE ((NTSTATUS)0xC000015CL) + +// +// MessageId: STATUS_NT_CROSS_ENCRYPTION_REQUIRED +// +// MessageText: +// +// An attempt was made to change a user password in the security account manager without providing the necessary Windows cross-encrypted password. +// +#define STATUS_NT_CROSS_ENCRYPTION_REQUIRED ((NTSTATUS)0xC000015DL) + +// +// MessageId: STATUS_DOMAIN_CTRLR_CONFIG_ERROR +// +// MessageText: +// +// A Windows Server has an incorrect configuration. +// +#define STATUS_DOMAIN_CTRLR_CONFIG_ERROR ((NTSTATUS)0xC000015EL) + +// +// MessageId: STATUS_FT_MISSING_MEMBER +// +// MessageText: +// +// An attempt was made to explicitly access the secondary copy of information via a device control to the Fault Tolerance driver and the secondary copy is not present in the system. +// +#define STATUS_FT_MISSING_MEMBER ((NTSTATUS)0xC000015FL) + +// +// MessageId: STATUS_ILL_FORMED_SERVICE_ENTRY +// +// MessageText: +// +// A configuration registry node representing a driver service entry was ill-formed and did not contain required value entries. +// +#define STATUS_ILL_FORMED_SERVICE_ENTRY ((NTSTATUS)0xC0000160L) + +// +// MessageId: STATUS_ILLEGAL_CHARACTER +// +// MessageText: +// +// An illegal character was encountered. For a multi-byte character set this includes a lead byte without a succeeding trail byte. For the Unicode character set this includes the characters 0xFFFF and 0xFFFE. +// +#define STATUS_ILLEGAL_CHARACTER ((NTSTATUS)0xC0000161L) + +// +// MessageId: STATUS_UNMAPPABLE_CHARACTER +// +// MessageText: +// +// No mapping for the Unicode character exists in the target multi-byte code page. +// +#define STATUS_UNMAPPABLE_CHARACTER ((NTSTATUS)0xC0000162L) + +// +// MessageId: STATUS_UNDEFINED_CHARACTER +// +// MessageText: +// +// The Unicode character is not defined in the Unicode character set installed on the system. +// +#define STATUS_UNDEFINED_CHARACTER ((NTSTATUS)0xC0000163L) + +// +// MessageId: STATUS_FLOPPY_VOLUME +// +// MessageText: +// +// The paging file cannot be created on a floppy diskette. +// +#define STATUS_FLOPPY_VOLUME ((NTSTATUS)0xC0000164L) + +// +// MessageId: STATUS_FLOPPY_ID_MARK_NOT_FOUND +// +// MessageText: +// +// {Floppy Disk Error} +// While accessing a floppy disk, an ID address mark was not found. +// +#define STATUS_FLOPPY_ID_MARK_NOT_FOUND ((NTSTATUS)0xC0000165L) + +// +// MessageId: STATUS_FLOPPY_WRONG_CYLINDER +// +// MessageText: +// +// {Floppy Disk Error} +// While accessing a floppy disk, the track address from the sector ID field was found to be different than the track address maintained by the controller. +// +#define STATUS_FLOPPY_WRONG_CYLINDER ((NTSTATUS)0xC0000166L) + +// +// MessageId: STATUS_FLOPPY_UNKNOWN_ERROR +// +// MessageText: +// +// {Floppy Disk Error} +// The floppy disk controller reported an error that is not recognized by the floppy disk driver. +// +#define STATUS_FLOPPY_UNKNOWN_ERROR ((NTSTATUS)0xC0000167L) + +// +// MessageId: STATUS_FLOPPY_BAD_REGISTERS +// +// MessageText: +// +// {Floppy Disk Error} +// While accessing a floppy-disk, the controller returned inconsistent results via its registers. +// +#define STATUS_FLOPPY_BAD_REGISTERS ((NTSTATUS)0xC0000168L) + +// +// MessageId: STATUS_DISK_RECALIBRATE_FAILED +// +// MessageText: +// +// {Hard Disk Error} +// While accessing the hard disk, a recalibrate operation failed, even after retries. +// +#define STATUS_DISK_RECALIBRATE_FAILED ((NTSTATUS)0xC0000169L) + +// +// MessageId: STATUS_DISK_OPERATION_FAILED +// +// MessageText: +// +// {Hard Disk Error} +// While accessing the hard disk, a disk operation failed even after retries. +// +#define STATUS_DISK_OPERATION_FAILED ((NTSTATUS)0xC000016AL) + +// +// MessageId: STATUS_DISK_RESET_FAILED +// +// MessageText: +// +// {Hard Disk Error} +// While accessing the hard disk, a disk controller reset was needed, but even that failed. +// +#define STATUS_DISK_RESET_FAILED ((NTSTATUS)0xC000016BL) + +// +// MessageId: STATUS_SHARED_IRQ_BUSY +// +// MessageText: +// +// An attempt was made to open a device that was sharing an IRQ with other devices. +// At least one other device that uses that IRQ was already opened. +// Two concurrent opens of devices that share an IRQ and only work via interrupts is not supported for the particular bus type that the devices use. +// +#define STATUS_SHARED_IRQ_BUSY ((NTSTATUS)0xC000016CL) + +// +// MessageId: STATUS_FT_ORPHANING +// +// MessageText: +// +// {FT Orphaning} +// A disk that is part of a fault-tolerant volume can no longer be accessed. +// +#define STATUS_FT_ORPHANING ((NTSTATUS)0xC000016DL) + +// +// MessageId: STATUS_BIOS_FAILED_TO_CONNECT_INTERRUPT +// +// MessageText: +// +// The system bios failed to connect a system interrupt to the device or bus for which the device is connected. +// +#define STATUS_BIOS_FAILED_TO_CONNECT_INTERRUPT ((NTSTATUS)0xC000016EL) + +// +// MessageId: STATUS_PARTITION_FAILURE +// +// MessageText: +// +// Tape could not be partitioned. +// +#define STATUS_PARTITION_FAILURE ((NTSTATUS)0xC0000172L) + +// +// MessageId: STATUS_INVALID_BLOCK_LENGTH +// +// MessageText: +// +// When accessing a new tape of a multivolume partition, the current blocksize is incorrect. +// +#define STATUS_INVALID_BLOCK_LENGTH ((NTSTATUS)0xC0000173L) + +// +// MessageId: STATUS_DEVICE_NOT_PARTITIONED +// +// MessageText: +// +// Tape partition information could not be found when loading a tape. +// +#define STATUS_DEVICE_NOT_PARTITIONED ((NTSTATUS)0xC0000174L) + +// +// MessageId: STATUS_UNABLE_TO_LOCK_MEDIA +// +// MessageText: +// +// Attempt to lock the eject media mechanism fails. +// +#define STATUS_UNABLE_TO_LOCK_MEDIA ((NTSTATUS)0xC0000175L) + +// +// MessageId: STATUS_UNABLE_TO_UNLOAD_MEDIA +// +// MessageText: +// +// Unload media fails. +// +#define STATUS_UNABLE_TO_UNLOAD_MEDIA ((NTSTATUS)0xC0000176L) + +// +// MessageId: STATUS_EOM_OVERFLOW +// +// MessageText: +// +// Physical end of tape was detected. +// +#define STATUS_EOM_OVERFLOW ((NTSTATUS)0xC0000177L) + +// +// MessageId: STATUS_NO_MEDIA +// +// MessageText: +// +// {No Media} +// There is no media in the drive. Please insert media into drive %hs. +// +#define STATUS_NO_MEDIA ((NTSTATUS)0xC0000178L) + +// +// MessageId: STATUS_NO_SUCH_MEMBER +// +// MessageText: +// +// A member could not be added to or removed from the local group because the member does not exist. +// +#define STATUS_NO_SUCH_MEMBER ((NTSTATUS)0xC000017AL) + +// +// MessageId: STATUS_INVALID_MEMBER +// +// MessageText: +// +// A new member could not be added to a local group because the member has the wrong account type. +// +#define STATUS_INVALID_MEMBER ((NTSTATUS)0xC000017BL) + +// +// MessageId: STATUS_KEY_DELETED +// +// MessageText: +// +// Illegal operation attempted on a registry key which has been marked for deletion. +// +#define STATUS_KEY_DELETED ((NTSTATUS)0xC000017CL) + +// +// MessageId: STATUS_NO_LOG_SPACE +// +// MessageText: +// +// System could not allocate required space in a registry log. +// +#define STATUS_NO_LOG_SPACE ((NTSTATUS)0xC000017DL) + +// +// MessageId: STATUS_TOO_MANY_SIDS +// +// MessageText: +// +// Too many Sids have been specified. +// +#define STATUS_TOO_MANY_SIDS ((NTSTATUS)0xC000017EL) + +// +// MessageId: STATUS_LM_CROSS_ENCRYPTION_REQUIRED +// +// MessageText: +// +// An attempt was made to change a user password in the security account manager without providing the necessary LM cross-encrypted password. +// +#define STATUS_LM_CROSS_ENCRYPTION_REQUIRED ((NTSTATUS)0xC000017FL) + +// +// MessageId: STATUS_KEY_HAS_CHILDREN +// +// MessageText: +// +// An attempt was made to create a symbolic link in a registry key that already has subkeys or values. +// +#define STATUS_KEY_HAS_CHILDREN ((NTSTATUS)0xC0000180L) + +// +// MessageId: STATUS_CHILD_MUST_BE_VOLATILE +// +// MessageText: +// +// An attempt was made to create a Stable subkey under a Volatile parent key. +// +#define STATUS_CHILD_MUST_BE_VOLATILE ((NTSTATUS)0xC0000181L) + +// +// MessageId: STATUS_DEVICE_CONFIGURATION_ERROR +// +// MessageText: +// +// The I/O device is configured incorrectly or the configuration parameters to the driver are incorrect. +// +#define STATUS_DEVICE_CONFIGURATION_ERROR ((NTSTATUS)0xC0000182L) + +// +// MessageId: STATUS_DRIVER_INTERNAL_ERROR +// +// MessageText: +// +// An error was detected between two drivers or within an I/O driver. +// +#define STATUS_DRIVER_INTERNAL_ERROR ((NTSTATUS)0xC0000183L) + +// +// MessageId: STATUS_INVALID_DEVICE_STATE +// +// MessageText: +// +// The device is not in a valid state to perform this request. +// +#define STATUS_INVALID_DEVICE_STATE ((NTSTATUS)0xC0000184L) + +// +// MessageId: STATUS_IO_DEVICE_ERROR +// +// MessageText: +// +// The I/O device reported an I/O error. +// +#define STATUS_IO_DEVICE_ERROR ((NTSTATUS)0xC0000185L) + +// +// MessageId: STATUS_DEVICE_PROTOCOL_ERROR +// +// MessageText: +// +// A protocol error was detected between the driver and the device. +// +#define STATUS_DEVICE_PROTOCOL_ERROR ((NTSTATUS)0xC0000186L) + +// +// MessageId: STATUS_BACKUP_CONTROLLER +// +// MessageText: +// +// This operation is only allowed for the Primary Domain Controller of the domain. +// +#define STATUS_BACKUP_CONTROLLER ((NTSTATUS)0xC0000187L) + +// +// MessageId: STATUS_LOG_FILE_FULL +// +// MessageText: +// +// Log file space is insufficient to support this operation. +// +#define STATUS_LOG_FILE_FULL ((NTSTATUS)0xC0000188L) + +// +// MessageId: STATUS_TOO_LATE +// +// MessageText: +// +// A write operation was attempted to a volume after it was dismounted. +// +#define STATUS_TOO_LATE ((NTSTATUS)0xC0000189L) + +// +// MessageId: STATUS_NO_TRUST_LSA_SECRET +// +// MessageText: +// +// The workstation does not have a trust secret for the primary domain in the local LSA database. +// +#define STATUS_NO_TRUST_LSA_SECRET ((NTSTATUS)0xC000018AL) + +// +// MessageId: STATUS_NO_TRUST_SAM_ACCOUNT +// +// MessageText: +// +// The SAM database on the Windows Server does not have a computer account for this workstation trust relationship. +// +#define STATUS_NO_TRUST_SAM_ACCOUNT ((NTSTATUS)0xC000018BL) + +// +// MessageId: STATUS_TRUSTED_DOMAIN_FAILURE +// +// MessageText: +// +// The logon request failed because the trust relationship between the primary domain and the trusted domain failed. +// +#define STATUS_TRUSTED_DOMAIN_FAILURE ((NTSTATUS)0xC000018CL) + +// +// MessageId: STATUS_TRUSTED_RELATIONSHIP_FAILURE +// +// MessageText: +// +// The logon request failed because the trust relationship between this workstation and the primary domain failed. +// +#define STATUS_TRUSTED_RELATIONSHIP_FAILURE ((NTSTATUS)0xC000018DL) + +// +// MessageId: STATUS_EVENTLOG_FILE_CORRUPT +// +// MessageText: +// +// The Eventlog log file is corrupt. +// +#define STATUS_EVENTLOG_FILE_CORRUPT ((NTSTATUS)0xC000018EL) + +// +// MessageId: STATUS_EVENTLOG_CANT_START +// +// MessageText: +// +// No Eventlog log file could be opened. The Eventlog service did not start. +// +#define STATUS_EVENTLOG_CANT_START ((NTSTATUS)0xC000018FL) + +// +// MessageId: STATUS_TRUST_FAILURE +// +// MessageText: +// +// The network logon failed. This may be because the validation authority can't be reached. +// +#define STATUS_TRUST_FAILURE ((NTSTATUS)0xC0000190L) + +// +// MessageId: STATUS_MUTANT_LIMIT_EXCEEDED +// +// MessageText: +// +// An attempt was made to acquire a mutant such that its maximum count would have been exceeded. +// +#define STATUS_MUTANT_LIMIT_EXCEEDED ((NTSTATUS)0xC0000191L) + +// +// MessageId: STATUS_NETLOGON_NOT_STARTED +// +// MessageText: +// +// An attempt was made to logon, but the netlogon service was not started. +// +#define STATUS_NETLOGON_NOT_STARTED ((NTSTATUS)0xC0000192L) + +// +// MessageId: STATUS_ACCOUNT_EXPIRED +// +// MessageText: +// +// The user's account has expired. +// +#define STATUS_ACCOUNT_EXPIRED ((NTSTATUS)0xC0000193L) // ntsubauth + +// +// MessageId: STATUS_POSSIBLE_DEADLOCK +// +// MessageText: +// +// {EXCEPTION} +// Possible deadlock condition. +// +#define STATUS_POSSIBLE_DEADLOCK ((NTSTATUS)0xC0000194L) + +// +// MessageId: STATUS_NETWORK_CREDENTIAL_CONFLICT +// +// MessageText: +// +// Multiple connections to a server or shared resource by the same user, using more than one user name, are not allowed. Disconnect all previous connections to the server or shared resource and try again. +// +#define STATUS_NETWORK_CREDENTIAL_CONFLICT ((NTSTATUS)0xC0000195L) + +// +// MessageId: STATUS_REMOTE_SESSION_LIMIT +// +// MessageText: +// +// An attempt was made to establish a session to a network server, but there are already too many sessions established to that server. +// +#define STATUS_REMOTE_SESSION_LIMIT ((NTSTATUS)0xC0000196L) + +// +// MessageId: STATUS_EVENTLOG_FILE_CHANGED +// +// MessageText: +// +// The log file has changed between reads. +// +#define STATUS_EVENTLOG_FILE_CHANGED ((NTSTATUS)0xC0000197L) + +// +// MessageId: STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT +// +// MessageText: +// +// The account used is an Interdomain Trust account. Use your global user account or local user account to access this server. +// +#define STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT ((NTSTATUS)0xC0000198L) + +// +// MessageId: STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT +// +// MessageText: +// +// The account used is a Computer Account. Use your global user account or local user account to access this server. +// +#define STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT ((NTSTATUS)0xC0000199L) + +// +// MessageId: STATUS_NOLOGON_SERVER_TRUST_ACCOUNT +// +// MessageText: +// +// The account used is an Server Trust account. Use your global user account or local user account to access this server. +// +#define STATUS_NOLOGON_SERVER_TRUST_ACCOUNT ((NTSTATUS)0xC000019AL) + +// +// MessageId: STATUS_DOMAIN_TRUST_INCONSISTENT +// +// MessageText: +// +// The name or SID of the domain specified is inconsistent with the trust information for that domain. +// +#define STATUS_DOMAIN_TRUST_INCONSISTENT ((NTSTATUS)0xC000019BL) + +// +// MessageId: STATUS_FS_DRIVER_REQUIRED +// +// MessageText: +// +// A volume has been accessed for which a file system driver is required that has not yet been loaded. +// +#define STATUS_FS_DRIVER_REQUIRED ((NTSTATUS)0xC000019CL) + +// +// MessageId: STATUS_IMAGE_ALREADY_LOADED_AS_DLL +// +// MessageText: +// +// Indicates that the specified image is already loaded as a DLL. +// +#define STATUS_IMAGE_ALREADY_LOADED_AS_DLL ((NTSTATUS)0xC000019DL) + +// +// MessageId: STATUS_INCOMPATIBLE_WITH_GLOBAL_SHORT_NAME_REGISTRY_SETTING +// +// MessageText: +// +// Short name settings may not be changed on this volume due to the global registry setting. +// +#define STATUS_INCOMPATIBLE_WITH_GLOBAL_SHORT_NAME_REGISTRY_SETTING ((NTSTATUS)0xC000019EL) + +// +// MessageId: STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME +// +// MessageText: +// +// Short names are not enabled on this volume. +// +#define STATUS_SHORT_NAMES_NOT_ENABLED_ON_VOLUME ((NTSTATUS)0xC000019FL) + +// +// MessageId: STATUS_SECURITY_STREAM_IS_INCONSISTENT +// +// MessageText: +// +// The security stream for the given volume is in an inconsistent state. +// Please run CHKDSK on the volume. +// +#define STATUS_SECURITY_STREAM_IS_INCONSISTENT ((NTSTATUS)0xC00001A0L) + +// +// MessageId: STATUS_INVALID_LOCK_RANGE +// +// MessageText: +// +// A requested file lock operation cannot be processed due to an invalid byte range. +// +#define STATUS_INVALID_LOCK_RANGE ((NTSTATUS)0xC00001A1L) + +// +// MessageId: STATUS_INVALID_ACE_CONDITION +// +// MessageText: +// +// {Invalid ACE Condition} +// The specified access control entry (ACE) contains an invalid condition. +// +#define STATUS_INVALID_ACE_CONDITION ((NTSTATUS)0xC00001A2L) + +// +// MessageId: STATUS_IMAGE_SUBSYSTEM_NOT_PRESENT +// +// MessageText: +// +// The subsystem needed to support the image type is not present. +// +#define STATUS_IMAGE_SUBSYSTEM_NOT_PRESENT ((NTSTATUS)0xC00001A3L) + +// +// MessageId: STATUS_NOTIFICATION_GUID_ALREADY_DEFINED +// +// MessageText: +// +// {Invalid ACE Condition} +// The specified file already has a notification GUID associated with it. +// +#define STATUS_NOTIFICATION_GUID_ALREADY_DEFINED ((NTSTATUS)0xC00001A4L) + +// +// MessageId: STATUS_INVALID_EXCEPTION_HANDLER +// +// MessageText: +// +// An invalid exception handler routine has been detected. +// +#define STATUS_INVALID_EXCEPTION_HANDLER ((NTSTATUS)0xC00001A5L) + +// +// MessageId: STATUS_DUPLICATE_PRIVILEGES +// +// MessageText: +// +// Duplicate privileges were specified for the token. +// +#define STATUS_DUPLICATE_PRIVILEGES ((NTSTATUS)0xC00001A6L) + +// +// MessageId: STATUS_NOT_ALLOWED_ON_SYSTEM_FILE +// +// MessageText: +// +// Requested action not allowed on a file system internal file. +// +#define STATUS_NOT_ALLOWED_ON_SYSTEM_FILE ((NTSTATUS)0xC00001A7L) + +// +// MessageId: STATUS_REPAIR_NEEDED +// +// MessageText: +// +// A portion of the file system requires repair. +// +#define STATUS_REPAIR_NEEDED ((NTSTATUS)0xC00001A8L) + +// +// MessageId: STATUS_QUOTA_NOT_ENABLED +// +// MessageText: +// +// Quota support is not enabled on the system. +// +#define STATUS_QUOTA_NOT_ENABLED ((NTSTATUS)0xC00001A9L) + +// +// MessageId: STATUS_NO_APPLICATION_PACKAGE +// +// MessageText: +// +// The operation failed because the application is not part of an application package. +// +#define STATUS_NO_APPLICATION_PACKAGE ((NTSTATUS)0xC00001AAL) + +// +// MessageId: STATUS_FILE_METADATA_OPTIMIZATION_IN_PROGRESS +// +// MessageText: +// +// File metadata optimization is already in progress. +// +#define STATUS_FILE_METADATA_OPTIMIZATION_IN_PROGRESS ((NTSTATUS)0xC00001ABL) + +// +// MessageId: STATUS_NOT_SAME_OBJECT +// +// MessageText: +// +// The objects are not identical. +// +#define STATUS_NOT_SAME_OBJECT ((NTSTATUS)0xC00001ACL) + +// +// MessageId: STATUS_FATAL_MEMORY_EXHAUSTION +// +// MessageText: +// +// The process has terminated because it could not allocate additional memory. +// +#define STATUS_FATAL_MEMORY_EXHAUSTION ((NTSTATUS)0xC00001ADL) + +// +// MessageId: STATUS_ERROR_PROCESS_NOT_IN_JOB +// +// MessageText: +// +// The process is not part of a job. +// +#define STATUS_ERROR_PROCESS_NOT_IN_JOB ((NTSTATUS)0xC00001AEL) + +// +// MessageId: STATUS_CPU_SET_INVALID +// +// MessageText: +// +// The specified CPU Set IDs are invalid. +// +#define STATUS_CPU_SET_INVALID ((NTSTATUS)0xC00001AFL) + +// +// MessageId: STATUS_IO_DEVICE_INVALID_DATA +// +// MessageText: +// +// The device reported an invalid data error. +// +#define STATUS_IO_DEVICE_INVALID_DATA ((NTSTATUS)0xC00001B0L) + +// +// MessageId: STATUS_IO_UNALIGNED_WRITE +// +// MessageText: +// +// The device reported an unaligned write error. +// +#define STATUS_IO_UNALIGNED_WRITE ((NTSTATUS)0xC00001B1L) + +// +// MessageId: STATUS_CONTROL_STACK_VIOLATION +// +// MessageText: +// +// An invalid address was found on the control flow stack. +// +#define STATUS_CONTROL_STACK_VIOLATION ((NTSTATUS)0xC00001B2L) //winnt + +// +// MessageId: STATUS_WEAK_WHFBKEY_BLOCKED +// +// MessageText: +// +// The Security Account Manager blocked the use of a weak Windows Hello for Business key. +// +#define STATUS_WEAK_WHFBKEY_BLOCKED ((NTSTATUS)0xC00001B3L) + +// +// MessageId: STATUS_SERVER_TRANSPORT_CONFLICT +// +// MessageText: +// +// Multiple mappings to shared resource(s) on a server, using more than one transport, are not allowed. Use a single transport for all mappings to a server and try again. +// +#define STATUS_SERVER_TRANSPORT_CONFLICT ((NTSTATUS)0xC00001B4L) + +// +// MessageId: STATUS_CERTIFICATE_VALIDATION_PREFERENCE_CONFLICT +// +// MessageText: +// +// Multiple mappings to shared resource(s) on a server, using different certificate validation preferences, are not allowed. Use the same preference for all mappings to a server and try again. +// +#define STATUS_CERTIFICATE_VALIDATION_PREFERENCE_CONFLICT ((NTSTATUS)0xC00001B5L) + +// +// MessageId: STATUS_DEVICE_RESET_REQUIRED +// +// MessageText: +// +// The device needs to be reset. +// +#define STATUS_DEVICE_RESET_REQUIRED ((NTSTATUS)0x800001B6L) + +// +// Available range of NTSTATUS codes +// +// +// MessageId: STATUS_NETWORK_OPEN_RESTRICTION +// +// MessageText: +// +// A remote open failed because the network open restrictions were not satisfied. +// +#define STATUS_NETWORK_OPEN_RESTRICTION ((NTSTATUS)0xC0000201L) + +// +// MessageId: STATUS_NO_USER_SESSION_KEY +// +// MessageText: +// +// There is no user session key for the specified logon session. +// +#define STATUS_NO_USER_SESSION_KEY ((NTSTATUS)0xC0000202L) + +// +// MessageId: STATUS_USER_SESSION_DELETED +// +// MessageText: +// +// The remote user session has been deleted. +// +#define STATUS_USER_SESSION_DELETED ((NTSTATUS)0xC0000203L) + +// +// MessageId: STATUS_RESOURCE_LANG_NOT_FOUND +// +// MessageText: +// +// Indicates the specified resource language ID cannot be found in the +// image file. +// +#define STATUS_RESOURCE_LANG_NOT_FOUND ((NTSTATUS)0xC0000204L) + +// +// MessageId: STATUS_INSUFF_SERVER_RESOURCES +// +// MessageText: +// +// Insufficient server resources exist to complete the request. +// +#define STATUS_INSUFF_SERVER_RESOURCES ((NTSTATUS)0xC0000205L) + +// +// MessageId: STATUS_INVALID_BUFFER_SIZE +// +// MessageText: +// +// The size of the buffer is invalid for the specified operation. +// +#define STATUS_INVALID_BUFFER_SIZE ((NTSTATUS)0xC0000206L) + +// +// MessageId: STATUS_INVALID_ADDRESS_COMPONENT +// +// MessageText: +// +// The transport rejected the network address specified as invalid. +// +#define STATUS_INVALID_ADDRESS_COMPONENT ((NTSTATUS)0xC0000207L) + +// +// MessageId: STATUS_INVALID_ADDRESS_WILDCARD +// +// MessageText: +// +// The transport rejected the network address specified due to an invalid use of a wildcard. +// +#define STATUS_INVALID_ADDRESS_WILDCARD ((NTSTATUS)0xC0000208L) + +// +// MessageId: STATUS_TOO_MANY_ADDRESSES +// +// MessageText: +// +// The transport address could not be opened because all the available addresses are in use. +// +#define STATUS_TOO_MANY_ADDRESSES ((NTSTATUS)0xC0000209L) + +// +// MessageId: STATUS_ADDRESS_ALREADY_EXISTS +// +// MessageText: +// +// The transport address could not be opened because it already exists. +// +#define STATUS_ADDRESS_ALREADY_EXISTS ((NTSTATUS)0xC000020AL) + +// +// MessageId: STATUS_ADDRESS_CLOSED +// +// MessageText: +// +// The transport address is now closed. +// +#define STATUS_ADDRESS_CLOSED ((NTSTATUS)0xC000020BL) + +// +// MessageId: STATUS_CONNECTION_DISCONNECTED +// +// MessageText: +// +// The transport connection is now disconnected. +// +#define STATUS_CONNECTION_DISCONNECTED ((NTSTATUS)0xC000020CL) + +// +// MessageId: STATUS_CONNECTION_RESET +// +// MessageText: +// +// The transport connection has been reset. +// +#define STATUS_CONNECTION_RESET ((NTSTATUS)0xC000020DL) + +// +// MessageId: STATUS_TOO_MANY_NODES +// +// MessageText: +// +// The transport cannot dynamically acquire any more nodes. +// +#define STATUS_TOO_MANY_NODES ((NTSTATUS)0xC000020EL) + +// +// MessageId: STATUS_TRANSACTION_ABORTED +// +// MessageText: +// +// The transport aborted a pending transaction. +// +#define STATUS_TRANSACTION_ABORTED ((NTSTATUS)0xC000020FL) + +// +// MessageId: STATUS_TRANSACTION_TIMED_OUT +// +// MessageText: +// +// The transport timed out a request waiting for a response. +// +#define STATUS_TRANSACTION_TIMED_OUT ((NTSTATUS)0xC0000210L) + +// +// MessageId: STATUS_TRANSACTION_NO_RELEASE +// +// MessageText: +// +// The transport did not receive a release for a pending response. +// +#define STATUS_TRANSACTION_NO_RELEASE ((NTSTATUS)0xC0000211L) + +// +// MessageId: STATUS_TRANSACTION_NO_MATCH +// +// MessageText: +// +// The transport did not find a transaction matching the specific token. +// +#define STATUS_TRANSACTION_NO_MATCH ((NTSTATUS)0xC0000212L) + +// +// MessageId: STATUS_TRANSACTION_RESPONDED +// +// MessageText: +// +// The transport had previously responded to a transaction request. +// +#define STATUS_TRANSACTION_RESPONDED ((NTSTATUS)0xC0000213L) + +// +// MessageId: STATUS_TRANSACTION_INVALID_ID +// +// MessageText: +// +// The transport does not recognized the transaction request identifier specified. +// +#define STATUS_TRANSACTION_INVALID_ID ((NTSTATUS)0xC0000214L) + +// +// MessageId: STATUS_TRANSACTION_INVALID_TYPE +// +// MessageText: +// +// The transport does not recognize the transaction request type specified. +// +#define STATUS_TRANSACTION_INVALID_TYPE ((NTSTATUS)0xC0000215L) + +// +// MessageId: STATUS_NOT_SERVER_SESSION +// +// MessageText: +// +// The transport can only process the specified request on the server side of a session. +// +#define STATUS_NOT_SERVER_SESSION ((NTSTATUS)0xC0000216L) + +// +// MessageId: STATUS_NOT_CLIENT_SESSION +// +// MessageText: +// +// The transport can only process the specified request on the client side of a session. +// +#define STATUS_NOT_CLIENT_SESSION ((NTSTATUS)0xC0000217L) + +// +// MessageId: STATUS_CANNOT_LOAD_REGISTRY_FILE +// +// MessageText: +// +// {Registry File Failure} +// The registry cannot load the hive (file): +// %hs +// or its log or alternate. +// It is corrupt, absent, or not writable. +// +#define STATUS_CANNOT_LOAD_REGISTRY_FILE ((NTSTATUS)0xC0000218L) + +// +// MessageId: STATUS_DEBUG_ATTACH_FAILED +// +// MessageText: +// +// {Unexpected Failure in DebugActiveProcess} +// An unexpected failure occurred while processing a DebugActiveProcess API request. You may choose OK to terminate the process, or Cancel to ignore the error. +// +#define STATUS_DEBUG_ATTACH_FAILED ((NTSTATUS)0xC0000219L) + +// +// MessageId: STATUS_SYSTEM_PROCESS_TERMINATED +// +// MessageText: +// +// {Fatal System Error} +// The %hs system process terminated unexpectedly with a status of 0x%08x (0x%08x 0x%08x). +// The system has been shut down. +// +#define STATUS_SYSTEM_PROCESS_TERMINATED ((NTSTATUS)0xC000021AL) + +// +// MessageId: STATUS_DATA_NOT_ACCEPTED +// +// MessageText: +// +// {Data Not Accepted} +// The TDI client could not handle the data received during an indication. +// +#define STATUS_DATA_NOT_ACCEPTED ((NTSTATUS)0xC000021BL) + +// +// MessageId: STATUS_NO_BROWSER_SERVERS_FOUND +// +// MessageText: +// +// {Unable to Retrieve Browser Server List} +// The list of servers for this workgroup is not currently available. +// +#define STATUS_NO_BROWSER_SERVERS_FOUND ((NTSTATUS)0xC000021CL) + +// +// MessageId: STATUS_VDM_HARD_ERROR +// +// MessageText: +// +// NTVDM encountered a hard error. +// +#define STATUS_VDM_HARD_ERROR ((NTSTATUS)0xC000021DL) + +// +// MessageId: STATUS_DRIVER_CANCEL_TIMEOUT +// +// MessageText: +// +// {Cancel Timeout} +// The driver %hs failed to complete a cancelled I/O request in the allotted time. +// +#define STATUS_DRIVER_CANCEL_TIMEOUT ((NTSTATUS)0xC000021EL) + +// +// MessageId: STATUS_REPLY_MESSAGE_MISMATCH +// +// MessageText: +// +// {Reply Message Mismatch} +// An attempt was made to reply to an LPC message, but the thread specified by the client ID in the message was not waiting on that message. +// +#define STATUS_REPLY_MESSAGE_MISMATCH ((NTSTATUS)0xC000021FL) + +// +// MessageId: STATUS_MAPPED_ALIGNMENT +// +// MessageText: +// +// {Mapped View Alignment Incorrect} +// An attempt was made to map a view of a file, but either the specified base address or the offset into the file were not aligned on the proper allocation granularity. +// +#define STATUS_MAPPED_ALIGNMENT ((NTSTATUS)0xC0000220L) + +// +// MessageId: STATUS_IMAGE_CHECKSUM_MISMATCH +// +// MessageText: +// +// {Bad Image Checksum} +// The image %hs is possibly corrupt. The header checksum does not match the computed checksum. +// +#define STATUS_IMAGE_CHECKSUM_MISMATCH ((NTSTATUS)0xC0000221L) + +// +// MessageId: STATUS_LOST_WRITEBEHIND_DATA +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %hs. The data has been lost. This error may be caused by a failure of your computer hardware or network connection. Please try to save this file elsewhere. +// +#define STATUS_LOST_WRITEBEHIND_DATA ((NTSTATUS)0xC0000222L) + +// +// MessageId: STATUS_CLIENT_SERVER_PARAMETERS_INVALID +// +// MessageText: +// +// The parameter(s) passed to the server in the client/server shared memory window were invalid. Too much data may have been put in the shared memory window. +// +#define STATUS_CLIENT_SERVER_PARAMETERS_INVALID ((NTSTATUS)0xC0000223L) + +// +// MessageId: STATUS_PASSWORD_MUST_CHANGE +// +// MessageText: +// +// The user's password must be changed before signing in. +// +#define STATUS_PASSWORD_MUST_CHANGE ((NTSTATUS)0xC0000224L) // ntsubauth + +// +// MessageId: STATUS_NOT_FOUND +// +// MessageText: +// +// The object was not found. +// +#define STATUS_NOT_FOUND ((NTSTATUS)0xC0000225L) + +// +// MessageId: STATUS_NOT_TINY_STREAM +// +// MessageText: +// +// The stream is not a tiny stream. +// +#define STATUS_NOT_TINY_STREAM ((NTSTATUS)0xC0000226L) + +// +// MessageId: STATUS_RECOVERY_FAILURE +// +// MessageText: +// +// A transaction recover failed. +// +#define STATUS_RECOVERY_FAILURE ((NTSTATUS)0xC0000227L) + +// +// MessageId: STATUS_STACK_OVERFLOW_READ +// +// MessageText: +// +// The request must be handled by the stack overflow code. +// +#define STATUS_STACK_OVERFLOW_READ ((NTSTATUS)0xC0000228L) + +// +// MessageId: STATUS_FAIL_CHECK +// +// MessageText: +// +// A consistency check failed. +// +#define STATUS_FAIL_CHECK ((NTSTATUS)0xC0000229L) + +// +// MessageId: STATUS_DUPLICATE_OBJECTID +// +// MessageText: +// +// The attempt to insert the ID in the index failed because the ID is already in the index. +// +#define STATUS_DUPLICATE_OBJECTID ((NTSTATUS)0xC000022AL) + +// +// MessageId: STATUS_OBJECTID_EXISTS +// +// MessageText: +// +// The attempt to set the object's ID failed because the object already has an ID. +// +#define STATUS_OBJECTID_EXISTS ((NTSTATUS)0xC000022BL) + +// +// MessageId: STATUS_CONVERT_TO_LARGE +// +// MessageText: +// +// Internal OFS status codes indicating how an allocation operation is handled. Either it is retried after the containing onode is moved or the extent stream is converted to a large stream. +// +#define STATUS_CONVERT_TO_LARGE ((NTSTATUS)0xC000022CL) + +// +// MessageId: STATUS_RETRY +// +// MessageText: +// +// The request needs to be retried. +// +#define STATUS_RETRY ((NTSTATUS)0xC000022DL) + +// +// MessageId: STATUS_FOUND_OUT_OF_SCOPE +// +// MessageText: +// +// The attempt to find the object found an object matching by ID on the volume but it is out of the scope of the handle used for the operation. +// +#define STATUS_FOUND_OUT_OF_SCOPE ((NTSTATUS)0xC000022EL) + +// +// MessageId: STATUS_ALLOCATE_BUCKET +// +// MessageText: +// +// The bucket array must be grown. Retry transaction after doing so. +// +#define STATUS_ALLOCATE_BUCKET ((NTSTATUS)0xC000022FL) + +// +// MessageId: STATUS_PROPSET_NOT_FOUND +// +// MessageText: +// +// The property set specified does not exist on the object. +// +#define STATUS_PROPSET_NOT_FOUND ((NTSTATUS)0xC0000230L) + +// +// MessageId: STATUS_MARSHALL_OVERFLOW +// +// MessageText: +// +// The user/kernel marshalling buffer has overflowed. +// +#define STATUS_MARSHALL_OVERFLOW ((NTSTATUS)0xC0000231L) + +// +// MessageId: STATUS_INVALID_VARIANT +// +// MessageText: +// +// The supplied variant structure contains invalid data. +// +#define STATUS_INVALID_VARIANT ((NTSTATUS)0xC0000232L) + +// +// MessageId: STATUS_DOMAIN_CONTROLLER_NOT_FOUND +// +// MessageText: +// +// Could not find a domain controller for this domain. +// +#define STATUS_DOMAIN_CONTROLLER_NOT_FOUND ((NTSTATUS)0xC0000233L) + +// +// MessageId: STATUS_ACCOUNT_LOCKED_OUT +// +// MessageText: +// +// The user account has been automatically locked because too many invalid logon attempts or password change attempts have been requested. +// +#define STATUS_ACCOUNT_LOCKED_OUT ((NTSTATUS)0xC0000234L) // ntsubauth + +// +// MessageId: STATUS_HANDLE_NOT_CLOSABLE +// +// MessageText: +// +// NtClose was called on a handle that was protected from close via NtSetInformationObject. +// +#define STATUS_HANDLE_NOT_CLOSABLE ((NTSTATUS)0xC0000235L) + +// +// MessageId: STATUS_CONNECTION_REFUSED +// +// MessageText: +// +// The transport connection attempt was refused by the remote system. +// +#define STATUS_CONNECTION_REFUSED ((NTSTATUS)0xC0000236L) + +// +// MessageId: STATUS_GRACEFUL_DISCONNECT +// +// MessageText: +// +// The transport connection was gracefully closed. +// +#define STATUS_GRACEFUL_DISCONNECT ((NTSTATUS)0xC0000237L) + +// +// MessageId: STATUS_ADDRESS_ALREADY_ASSOCIATED +// +// MessageText: +// +// The transport endpoint already has an address associated with it. +// +#define STATUS_ADDRESS_ALREADY_ASSOCIATED ((NTSTATUS)0xC0000238L) + +// +// MessageId: STATUS_ADDRESS_NOT_ASSOCIATED +// +// MessageText: +// +// An address has not yet been associated with the transport endpoint. +// +#define STATUS_ADDRESS_NOT_ASSOCIATED ((NTSTATUS)0xC0000239L) + +// +// MessageId: STATUS_CONNECTION_INVALID +// +// MessageText: +// +// An operation was attempted on a nonexistent transport connection. +// +#define STATUS_CONNECTION_INVALID ((NTSTATUS)0xC000023AL) + +// +// MessageId: STATUS_CONNECTION_ACTIVE +// +// MessageText: +// +// An invalid operation was attempted on an active transport connection. +// +#define STATUS_CONNECTION_ACTIVE ((NTSTATUS)0xC000023BL) + +// +// MessageId: STATUS_NETWORK_UNREACHABLE +// +// MessageText: +// +// The remote network is not reachable by the transport. +// +#define STATUS_NETWORK_UNREACHABLE ((NTSTATUS)0xC000023CL) + +// +// MessageId: STATUS_HOST_UNREACHABLE +// +// MessageText: +// +// The remote system is not reachable by the transport. +// +#define STATUS_HOST_UNREACHABLE ((NTSTATUS)0xC000023DL) + +// +// MessageId: STATUS_PROTOCOL_UNREACHABLE +// +// MessageText: +// +// The remote system does not support the transport protocol. +// +#define STATUS_PROTOCOL_UNREACHABLE ((NTSTATUS)0xC000023EL) + +// +// MessageId: STATUS_PORT_UNREACHABLE +// +// MessageText: +// +// No service is operating at the destination port of the transport on the remote system. +// +#define STATUS_PORT_UNREACHABLE ((NTSTATUS)0xC000023FL) + +// +// MessageId: STATUS_REQUEST_ABORTED +// +// MessageText: +// +// The request was aborted. +// +#define STATUS_REQUEST_ABORTED ((NTSTATUS)0xC0000240L) + +// +// MessageId: STATUS_CONNECTION_ABORTED +// +// MessageText: +// +// The transport connection was aborted by the local system. +// +#define STATUS_CONNECTION_ABORTED ((NTSTATUS)0xC0000241L) + +// +// MessageId: STATUS_BAD_COMPRESSION_BUFFER +// +// MessageText: +// +// The specified buffer contains ill-formed data. +// +#define STATUS_BAD_COMPRESSION_BUFFER ((NTSTATUS)0xC0000242L) + +// +// MessageId: STATUS_USER_MAPPED_FILE +// +// MessageText: +// +// The requested operation cannot be performed on a file with a user mapped section open. +// +#define STATUS_USER_MAPPED_FILE ((NTSTATUS)0xC0000243L) + +// +// MessageId: STATUS_AUDIT_FAILED +// +// MessageText: +// +// {Audit Failed} +// An attempt to generate a security audit failed. +// +#define STATUS_AUDIT_FAILED ((NTSTATUS)0xC0000244L) + +// +// MessageId: STATUS_TIMER_RESOLUTION_NOT_SET +// +// MessageText: +// +// The timer resolution was not previously set by the current process. +// +#define STATUS_TIMER_RESOLUTION_NOT_SET ((NTSTATUS)0xC0000245L) + +// +// MessageId: STATUS_CONNECTION_COUNT_LIMIT +// +// MessageText: +// +// A connection to the server could not be made because the limit on the number of concurrent connections for this account has been reached. +// +#define STATUS_CONNECTION_COUNT_LIMIT ((NTSTATUS)0xC0000246L) + +// +// MessageId: STATUS_LOGIN_TIME_RESTRICTION +// +// MessageText: +// +// Attempting to login during an unauthorized time of day for this account. +// +#define STATUS_LOGIN_TIME_RESTRICTION ((NTSTATUS)0xC0000247L) + +// +// MessageId: STATUS_LOGIN_WKSTA_RESTRICTION +// +// MessageText: +// +// The account is not authorized to login from this station. +// +#define STATUS_LOGIN_WKSTA_RESTRICTION ((NTSTATUS)0xC0000248L) + +// +// MessageId: STATUS_IMAGE_MP_UP_MISMATCH +// +// MessageText: +// +// {UP/MP Image Mismatch} +// The image %hs has been modified for use on a uniprocessor system, but you are running it on a multiprocessor machine. +// Please reinstall the image file. +// +#define STATUS_IMAGE_MP_UP_MISMATCH ((NTSTATUS)0xC0000249L) + +// +// MessageId: STATUS_INSUFFICIENT_LOGON_INFO +// +// MessageText: +// +// There is insufficient account information to log you on. +// +#define STATUS_INSUFFICIENT_LOGON_INFO ((NTSTATUS)0xC0000250L) + +// +// MessageId: STATUS_BAD_DLL_ENTRYPOINT +// +// MessageText: +// +// {Invalid DLL Entrypoint} +// The dynamic link library %hs is not written correctly. The stack pointer has been left in an inconsistent state. The entrypoint should be declared as WINAPI or STDCALL. Select YES to fail the DLL load. Select NO to continue execution. Selecting NO may cause the application to operate incorrectly. +// +#define STATUS_BAD_DLL_ENTRYPOINT ((NTSTATUS)0xC0000251L) + +// +// MessageId: STATUS_BAD_SERVICE_ENTRYPOINT +// +// MessageText: +// +// {Invalid Service Callback Entrypoint} +// The %hs service is not written correctly. The stack pointer has been left in an inconsistent state. The callback entrypoint should be declared as WINAPI or STDCALL. Selecting OK will cause the service to continue operation. However, the service process may operate incorrectly. +// +#define STATUS_BAD_SERVICE_ENTRYPOINT ((NTSTATUS)0xC0000252L) + +// +// MessageId: STATUS_LPC_REPLY_LOST +// +// MessageText: +// +// The server received the messages but did not send a reply. +// +#define STATUS_LPC_REPLY_LOST ((NTSTATUS)0xC0000253L) + +// +// MessageId: STATUS_IP_ADDRESS_CONFLICT1 +// +// MessageText: +// +// There is an IP address conflict with another system on the network +// +#define STATUS_IP_ADDRESS_CONFLICT1 ((NTSTATUS)0xC0000254L) + +// +// MessageId: STATUS_IP_ADDRESS_CONFLICT2 +// +// MessageText: +// +// There is an IP address conflict with another system on the network +// +#define STATUS_IP_ADDRESS_CONFLICT2 ((NTSTATUS)0xC0000255L) + +// +// MessageId: STATUS_REGISTRY_QUOTA_LIMIT +// +// MessageText: +// +// {Low On Registry Space} +// The system has reached the maximum size allowed for the system part of the registry. Additional storage requests will be ignored. +// +#define STATUS_REGISTRY_QUOTA_LIMIT ((NTSTATUS)0xC0000256L) + +// +// MessageId: STATUS_PATH_NOT_COVERED +// +// MessageText: +// +// The contacted server does not support the indicated part of the DFS namespace. +// +#define STATUS_PATH_NOT_COVERED ((NTSTATUS)0xC0000257L) + +// +// MessageId: STATUS_NO_CALLBACK_ACTIVE +// +// MessageText: +// +// A callback return system service cannot be executed when no callback is active. +// +#define STATUS_NO_CALLBACK_ACTIVE ((NTSTATUS)0xC0000258L) + +// +// MessageId: STATUS_LICENSE_QUOTA_EXCEEDED +// +// MessageText: +// +// The service being accessed is licensed for a particular number of connections. No more connections can be made to the service at this time because there are already as many connections as the service can accept. +// +#define STATUS_LICENSE_QUOTA_EXCEEDED ((NTSTATUS)0xC0000259L) + +// +// MessageId: STATUS_PWD_TOO_SHORT +// +// MessageText: +// +// The password provided is too short to meet the policy of your user account. Please choose a longer password. +// +#define STATUS_PWD_TOO_SHORT ((NTSTATUS)0xC000025AL) + +// +// MessageId: STATUS_PWD_TOO_RECENT +// +// MessageText: +// +// The policy of your user account does not allow you to change passwords too frequently. This is done to prevent users from changing back to a familiar, but potentially discovered, password. If you feel your password has been compromised then please contact your administrator immediately to have a new one assigned. +// +#define STATUS_PWD_TOO_RECENT ((NTSTATUS)0xC000025BL) + +// +// MessageId: STATUS_PWD_HISTORY_CONFLICT +// +// MessageText: +// +// You have attempted to change your password to one that you have used in the past. The policy of your user account does not allow this. Please select a password that you have not previously used. +// +#define STATUS_PWD_HISTORY_CONFLICT ((NTSTATUS)0xC000025CL) + +// +// MessageId: STATUS_PLUGPLAY_NO_DEVICE +// +// MessageText: +// +// You have attempted to load a legacy device driver while its device instance had been disabled. +// +#define STATUS_PLUGPLAY_NO_DEVICE ((NTSTATUS)0xC000025EL) + +// +// MessageId: STATUS_UNSUPPORTED_COMPRESSION +// +// MessageText: +// +// The specified compression format is unsupported. +// +#define STATUS_UNSUPPORTED_COMPRESSION ((NTSTATUS)0xC000025FL) + +// +// MessageId: STATUS_INVALID_HW_PROFILE +// +// MessageText: +// +// The specified hardware profile configuration is invalid. +// +#define STATUS_INVALID_HW_PROFILE ((NTSTATUS)0xC0000260L) + +// +// MessageId: STATUS_INVALID_PLUGPLAY_DEVICE_PATH +// +// MessageText: +// +// The specified Plug and Play registry device path is invalid. +// +#define STATUS_INVALID_PLUGPLAY_DEVICE_PATH ((NTSTATUS)0xC0000261L) + +// +// MessageId: STATUS_DRIVER_ORDINAL_NOT_FOUND +// +// MessageText: +// +// {Driver Entry Point Not Found} +// The %hs device driver could not locate the ordinal %ld in driver %hs. +// +#define STATUS_DRIVER_ORDINAL_NOT_FOUND ((NTSTATUS)0xC0000262L) + +// +// MessageId: STATUS_DRIVER_ENTRYPOINT_NOT_FOUND +// +// MessageText: +// +// {Driver Entry Point Not Found} +// The %hs device driver could not locate the entry point %hs in driver %hs. +// +#define STATUS_DRIVER_ENTRYPOINT_NOT_FOUND ((NTSTATUS)0xC0000263L) + +// +// MessageId: STATUS_RESOURCE_NOT_OWNED +// +// MessageText: +// +// {Application Error} +// The application attempted to release a resource it did not own. Click OK to terminate the application. +// +#define STATUS_RESOURCE_NOT_OWNED ((NTSTATUS)0xC0000264L) + +// +// MessageId: STATUS_TOO_MANY_LINKS +// +// MessageText: +// +// An attempt was made to create more links on a file than the file system supports. +// +#define STATUS_TOO_MANY_LINKS ((NTSTATUS)0xC0000265L) + +// +// MessageId: STATUS_QUOTA_LIST_INCONSISTENT +// +// MessageText: +// +// The specified quota list is internally inconsistent with its descriptor. +// +#define STATUS_QUOTA_LIST_INCONSISTENT ((NTSTATUS)0xC0000266L) + +// +// MessageId: STATUS_FILE_IS_OFFLINE +// +// MessageText: +// +// The specified file has been relocated to offline storage. +// +#define STATUS_FILE_IS_OFFLINE ((NTSTATUS)0xC0000267L) + +// +// MessageId: STATUS_EVALUATION_EXPIRATION +// +// MessageText: +// +// {Windows Evaluation Notification} +// The evaluation period for this installation of Windows has expired. This system will shutdown in 1 hour. To restore access to this installation of Windows, please upgrade this installation using a licensed distribution of this product. +// +#define STATUS_EVALUATION_EXPIRATION ((NTSTATUS)0xC0000268L) + +// +// MessageId: STATUS_ILLEGAL_DLL_RELOCATION +// +// MessageText: +// +// {Illegal System DLL Relocation} +// The system DLL %hs was relocated in memory. The application will not run properly. The relocation occurred because the DLL %hs occupied an address range reserved for Windows system DLLs. The vendor supplying the DLL should be contacted for a new DLL. +// +#define STATUS_ILLEGAL_DLL_RELOCATION ((NTSTATUS)0xC0000269L) + +// +// MessageId: STATUS_LICENSE_VIOLATION +// +// MessageText: +// +// {License Violation} +// The system has detected tampering with your registered product type. This is a violation of your software license. Tampering with product type is not permitted. +// +#define STATUS_LICENSE_VIOLATION ((NTSTATUS)0xC000026AL) + +// +// MessageId: STATUS_DLL_INIT_FAILED_LOGOFF +// +// MessageText: +// +// {DLL Initialization Failed} +// The application failed to initialize because the window station is shutting down. +// +#define STATUS_DLL_INIT_FAILED_LOGOFF ((NTSTATUS)0xC000026BL) + +// +// MessageId: STATUS_DRIVER_UNABLE_TO_LOAD +// +// MessageText: +// +// {Unable to Load Device Driver} +// %hs device driver could not be loaded. +// Error Status was 0x%x +// +#define STATUS_DRIVER_UNABLE_TO_LOAD ((NTSTATUS)0xC000026CL) + +// +// MessageId: STATUS_DFS_UNAVAILABLE +// +// MessageText: +// +// DFS is unavailable on the contacted server. +// +#define STATUS_DFS_UNAVAILABLE ((NTSTATUS)0xC000026DL) + +// +// MessageId: STATUS_VOLUME_DISMOUNTED +// +// MessageText: +// +// An operation was attempted to a volume after it was dismounted. +// +#define STATUS_VOLUME_DISMOUNTED ((NTSTATUS)0xC000026EL) + +// +// MessageId: STATUS_WX86_INTERNAL_ERROR +// +// MessageText: +// +// An internal error occurred in the Win32 x86 emulation subsystem. +// +#define STATUS_WX86_INTERNAL_ERROR ((NTSTATUS)0xC000026FL) + +// +// MessageId: STATUS_WX86_FLOAT_STACK_CHECK +// +// MessageText: +// +// Win32 x86 emulation subsystem Floating-point stack check. +// +#define STATUS_WX86_FLOAT_STACK_CHECK ((NTSTATUS)0xC0000270L) + +// +// MessageId: STATUS_VALIDATE_CONTINUE +// +// MessageText: +// +// The validation process needs to continue on to the next step. +// +#define STATUS_VALIDATE_CONTINUE ((NTSTATUS)0xC0000271L) + +// +// MessageId: STATUS_NO_MATCH +// +// MessageText: +// +// There was no match for the specified key in the index. +// +#define STATUS_NO_MATCH ((NTSTATUS)0xC0000272L) + +// +// MessageId: STATUS_NO_MORE_MATCHES +// +// MessageText: +// +// There are no more matches for the current index enumeration. +// +#define STATUS_NO_MORE_MATCHES ((NTSTATUS)0xC0000273L) + +// +// MessageId: STATUS_NOT_A_REPARSE_POINT +// +// MessageText: +// +// The file or directory is not a reparse point. +// +#define STATUS_NOT_A_REPARSE_POINT ((NTSTATUS)0xC0000275L) + +// +// MessageId: STATUS_IO_REPARSE_TAG_INVALID +// +// MessageText: +// +// The Windows I/O reparse tag passed for the reparse point is invalid. +// +#define STATUS_IO_REPARSE_TAG_INVALID ((NTSTATUS)0xC0000276L) + +// +// MessageId: STATUS_IO_REPARSE_TAG_MISMATCH +// +// MessageText: +// +// The Windows I/O reparse tag does not match the one present in the reparse point. +// +#define STATUS_IO_REPARSE_TAG_MISMATCH ((NTSTATUS)0xC0000277L) + +// +// MessageId: STATUS_IO_REPARSE_DATA_INVALID +// +// MessageText: +// +// The user data passed for the reparse point is invalid. +// +#define STATUS_IO_REPARSE_DATA_INVALID ((NTSTATUS)0xC0000278L) + +// +// MessageId: STATUS_IO_REPARSE_TAG_NOT_HANDLED +// +// MessageText: +// +// The layered file system driver for this IO tag did not handle it when needed. +// +#define STATUS_IO_REPARSE_TAG_NOT_HANDLED ((NTSTATUS)0xC0000279L) + +// +// MessageId: STATUS_PWD_TOO_LONG +// +// MessageText: +// +// The password provided is too long to meet the policy of your user account. Please choose a shorter password. +// +#define STATUS_PWD_TOO_LONG ((NTSTATUS)0xC000027AL) + +// +// MessageId: STATUS_STOWED_EXCEPTION +// +// MessageText: +// +// An application-internal exception has occurred. +// +#define STATUS_STOWED_EXCEPTION ((NTSTATUS)0xC000027BL) + +// +// MessageId: STATUS_CONTEXT_STOWED_EXCEPTION +// +// MessageText: +// +// An application-internal exception has occurred. +// +#define STATUS_CONTEXT_STOWED_EXCEPTION ((NTSTATUS)0xC000027CL) + +// +// MessageId: STATUS_REPARSE_POINT_NOT_RESOLVED +// +// MessageText: +// +// The symbolic link could not be resolved even though the initial file name is valid. +// +#define STATUS_REPARSE_POINT_NOT_RESOLVED ((NTSTATUS)0xC0000280L) + +// +// MessageId: STATUS_DIRECTORY_IS_A_REPARSE_POINT +// +// MessageText: +// +// The directory is a reparse point. +// +#define STATUS_DIRECTORY_IS_A_REPARSE_POINT ((NTSTATUS)0xC0000281L) + +// +// MessageId: STATUS_RANGE_LIST_CONFLICT +// +// MessageText: +// +// The range could not be added to the range list because of a conflict. +// +#define STATUS_RANGE_LIST_CONFLICT ((NTSTATUS)0xC0000282L) + +// +// MessageId: STATUS_SOURCE_ELEMENT_EMPTY +// +// MessageText: +// +// The specified medium changer source element contains no media. +// +#define STATUS_SOURCE_ELEMENT_EMPTY ((NTSTATUS)0xC0000283L) + +// +// MessageId: STATUS_DESTINATION_ELEMENT_FULL +// +// MessageText: +// +// The specified medium changer destination element already contains media. +// +#define STATUS_DESTINATION_ELEMENT_FULL ((NTSTATUS)0xC0000284L) + +// +// MessageId: STATUS_ILLEGAL_ELEMENT_ADDRESS +// +// MessageText: +// +// The specified medium changer element does not exist. +// +#define STATUS_ILLEGAL_ELEMENT_ADDRESS ((NTSTATUS)0xC0000285L) + +// +// MessageId: STATUS_MAGAZINE_NOT_PRESENT +// +// MessageText: +// +// The specified element is contained within a magazine that is no longer present. +// +#define STATUS_MAGAZINE_NOT_PRESENT ((NTSTATUS)0xC0000286L) + +// +// MessageId: STATUS_REINITIALIZATION_NEEDED +// +// MessageText: +// +// The device requires reinitialization due to hardware errors. +// +#define STATUS_REINITIALIZATION_NEEDED ((NTSTATUS)0xC0000287L) + +// +// MessageId: STATUS_DEVICE_REQUIRES_CLEANING +// +// MessageText: +// +// The device has indicated that cleaning is necessary. +// +#define STATUS_DEVICE_REQUIRES_CLEANING ((NTSTATUS)0x80000288L) + +// +// MessageId: STATUS_DEVICE_DOOR_OPEN +// +// MessageText: +// +// The device has indicated that its door is open. Further operations require it closed and secured. +// +#define STATUS_DEVICE_DOOR_OPEN ((NTSTATUS)0x80000289L) + +// +// MessageId: STATUS_ENCRYPTION_FAILED +// +// MessageText: +// +// The file encryption attempt failed. +// +#define STATUS_ENCRYPTION_FAILED ((NTSTATUS)0xC000028AL) + +// +// MessageId: STATUS_DECRYPTION_FAILED +// +// MessageText: +// +// The file decryption attempt failed. +// +#define STATUS_DECRYPTION_FAILED ((NTSTATUS)0xC000028BL) + +// +// MessageId: STATUS_RANGE_NOT_FOUND +// +// MessageText: +// +// The specified range could not be found in the range list. +// +#define STATUS_RANGE_NOT_FOUND ((NTSTATUS)0xC000028CL) + +// +// MessageId: STATUS_NO_RECOVERY_POLICY +// +// MessageText: +// +// There is no encryption recovery policy configured for this system. +// +#define STATUS_NO_RECOVERY_POLICY ((NTSTATUS)0xC000028DL) + +// +// MessageId: STATUS_NO_EFS +// +// MessageText: +// +// The required encryption driver is not loaded for this system. +// +#define STATUS_NO_EFS ((NTSTATUS)0xC000028EL) + +// +// MessageId: STATUS_WRONG_EFS +// +// MessageText: +// +// The file was encrypted with a different encryption driver than is currently loaded. +// +#define STATUS_WRONG_EFS ((NTSTATUS)0xC000028FL) + +// +// MessageId: STATUS_NO_USER_KEYS +// +// MessageText: +// +// There are no EFS keys defined for the user. +// +#define STATUS_NO_USER_KEYS ((NTSTATUS)0xC0000290L) + +// +// MessageId: STATUS_FILE_NOT_ENCRYPTED +// +// MessageText: +// +// The specified file is not encrypted. +// +#define STATUS_FILE_NOT_ENCRYPTED ((NTSTATUS)0xC0000291L) + +// +// MessageId: STATUS_NOT_EXPORT_FORMAT +// +// MessageText: +// +// The specified file is not in the defined EFS export format. +// +#define STATUS_NOT_EXPORT_FORMAT ((NTSTATUS)0xC0000292L) + +// +// MessageId: STATUS_FILE_ENCRYPTED +// +// MessageText: +// +// The specified file is encrypted and the user does not have the ability to decrypt it. +// +#define STATUS_FILE_ENCRYPTED ((NTSTATUS)0xC0000293L) + +// +// MessageId: STATUS_WAKE_SYSTEM +// +// MessageText: +// +// The system has awoken +// +#define STATUS_WAKE_SYSTEM ((NTSTATUS)0x40000294L) + +// +// MessageId: STATUS_WMI_GUID_NOT_FOUND +// +// MessageText: +// +// The guid passed was not recognized as valid by a WMI data provider. +// +#define STATUS_WMI_GUID_NOT_FOUND ((NTSTATUS)0xC0000295L) + +// +// MessageId: STATUS_WMI_INSTANCE_NOT_FOUND +// +// MessageText: +// +// The instance name passed was not recognized as valid by a WMI data provider. +// +#define STATUS_WMI_INSTANCE_NOT_FOUND ((NTSTATUS)0xC0000296L) + +// +// MessageId: STATUS_WMI_ITEMID_NOT_FOUND +// +// MessageText: +// +// The data item id passed was not recognized as valid by a WMI data provider. +// +#define STATUS_WMI_ITEMID_NOT_FOUND ((NTSTATUS)0xC0000297L) + +// +// MessageId: STATUS_WMI_TRY_AGAIN +// +// MessageText: +// +// The WMI request could not be completed and should be retried. +// +#define STATUS_WMI_TRY_AGAIN ((NTSTATUS)0xC0000298L) + +// +// MessageId: STATUS_SHARED_POLICY +// +// MessageText: +// +// The policy object is shared and can only be modified at the root +// +#define STATUS_SHARED_POLICY ((NTSTATUS)0xC0000299L) + +// +// MessageId: STATUS_POLICY_OBJECT_NOT_FOUND +// +// MessageText: +// +// The policy object does not exist when it should +// +#define STATUS_POLICY_OBJECT_NOT_FOUND ((NTSTATUS)0xC000029AL) + +// +// MessageId: STATUS_POLICY_ONLY_IN_DS +// +// MessageText: +// +// The requested policy information only lives in the Ds +// +#define STATUS_POLICY_ONLY_IN_DS ((NTSTATUS)0xC000029BL) + +// +// MessageId: STATUS_VOLUME_NOT_UPGRADED +// +// MessageText: +// +// The volume must be upgraded to enable this feature +// +#define STATUS_VOLUME_NOT_UPGRADED ((NTSTATUS)0xC000029CL) + +// +// MessageId: STATUS_REMOTE_STORAGE_NOT_ACTIVE +// +// MessageText: +// +// The remote storage service is not operational at this time. +// +#define STATUS_REMOTE_STORAGE_NOT_ACTIVE ((NTSTATUS)0xC000029DL) + +// +// MessageId: STATUS_REMOTE_STORAGE_MEDIA_ERROR +// +// MessageText: +// +// The remote storage service encountered a media error. +// +#define STATUS_REMOTE_STORAGE_MEDIA_ERROR ((NTSTATUS)0xC000029EL) + +// +// MessageId: STATUS_NO_TRACKING_SERVICE +// +// MessageText: +// +// The tracking (workstation) service is not running. +// +#define STATUS_NO_TRACKING_SERVICE ((NTSTATUS)0xC000029FL) + +// +// MessageId: STATUS_SERVER_SID_MISMATCH +// +// MessageText: +// +// The server process is running under a SID different than that required by client. +// +#define STATUS_SERVER_SID_MISMATCH ((NTSTATUS)0xC00002A0L) + +// +// Directory Service specific Errors +// +// +// MessageId: STATUS_DS_NO_ATTRIBUTE_OR_VALUE +// +// MessageText: +// +// The specified directory service attribute or value does not exist. +// +#define STATUS_DS_NO_ATTRIBUTE_OR_VALUE ((NTSTATUS)0xC00002A1L) + +// +// MessageId: STATUS_DS_INVALID_ATTRIBUTE_SYNTAX +// +// MessageText: +// +// The attribute syntax specified to the directory service is invalid. +// +#define STATUS_DS_INVALID_ATTRIBUTE_SYNTAX ((NTSTATUS)0xC00002A2L) + +// +// MessageId: STATUS_DS_ATTRIBUTE_TYPE_UNDEFINED +// +// MessageText: +// +// The attribute type specified to the directory service is not defined. +// +#define STATUS_DS_ATTRIBUTE_TYPE_UNDEFINED ((NTSTATUS)0xC00002A3L) + +// +// MessageId: STATUS_DS_ATTRIBUTE_OR_VALUE_EXISTS +// +// MessageText: +// +// The specified directory service attribute or value already exists. +// +#define STATUS_DS_ATTRIBUTE_OR_VALUE_EXISTS ((NTSTATUS)0xC00002A4L) + +// +// MessageId: STATUS_DS_BUSY +// +// MessageText: +// +// The directory service is busy. +// +#define STATUS_DS_BUSY ((NTSTATUS)0xC00002A5L) + +// +// MessageId: STATUS_DS_UNAVAILABLE +// +// MessageText: +// +// The directory service is not available. +// +#define STATUS_DS_UNAVAILABLE ((NTSTATUS)0xC00002A6L) + +// +// MessageId: STATUS_DS_NO_RIDS_ALLOCATED +// +// MessageText: +// +// The directory service was unable to allocate a relative identifier. +// +#define STATUS_DS_NO_RIDS_ALLOCATED ((NTSTATUS)0xC00002A7L) + +// +// MessageId: STATUS_DS_NO_MORE_RIDS +// +// MessageText: +// +// The directory service has exhausted the pool of relative identifiers. +// +#define STATUS_DS_NO_MORE_RIDS ((NTSTATUS)0xC00002A8L) + +// +// MessageId: STATUS_DS_INCORRECT_ROLE_OWNER +// +// MessageText: +// +// The requested operation could not be performed because the directory service is not the master for that type of operation. +// +#define STATUS_DS_INCORRECT_ROLE_OWNER ((NTSTATUS)0xC00002A9L) + +// +// MessageId: STATUS_DS_RIDMGR_INIT_ERROR +// +// MessageText: +// +// The directory service was unable to initialize the subsystem that allocates relative identifiers. +// +#define STATUS_DS_RIDMGR_INIT_ERROR ((NTSTATUS)0xC00002AAL) + +// +// MessageId: STATUS_DS_OBJ_CLASS_VIOLATION +// +// MessageText: +// +// The requested operation did not satisfy one or more constraints associated with the class of the object. +// +#define STATUS_DS_OBJ_CLASS_VIOLATION ((NTSTATUS)0xC00002ABL) + +// +// MessageId: STATUS_DS_CANT_ON_NON_LEAF +// +// MessageText: +// +// The directory service can perform the requested operation only on a leaf object. +// +#define STATUS_DS_CANT_ON_NON_LEAF ((NTSTATUS)0xC00002ACL) + +// +// MessageId: STATUS_DS_CANT_ON_RDN +// +// MessageText: +// +// The directory service cannot perform the requested operation on the Relatively Defined Name (RDN) attribute of an object. +// +#define STATUS_DS_CANT_ON_RDN ((NTSTATUS)0xC00002ADL) + +// +// MessageId: STATUS_DS_CANT_MOD_OBJ_CLASS +// +// MessageText: +// +// The directory service detected an attempt to modify the object class of an object. +// +#define STATUS_DS_CANT_MOD_OBJ_CLASS ((NTSTATUS)0xC00002AEL) + +// +// MessageId: STATUS_DS_CROSS_DOM_MOVE_FAILED +// +// MessageText: +// +// An error occurred while performing a cross domain move operation. +// +#define STATUS_DS_CROSS_DOM_MOVE_FAILED ((NTSTATUS)0xC00002AFL) + +// +// MessageId: STATUS_DS_GC_NOT_AVAILABLE +// +// MessageText: +// +// Unable to Contact the Global Catalog Server. +// +#define STATUS_DS_GC_NOT_AVAILABLE ((NTSTATUS)0xC00002B0L) + +// +// MessageId: STATUS_DIRECTORY_SERVICE_REQUIRED +// +// MessageText: +// +// The requested operation requires a directory service, and none was available. +// +#define STATUS_DIRECTORY_SERVICE_REQUIRED ((NTSTATUS)0xC00002B1L) + +// +// MessageId: STATUS_REPARSE_ATTRIBUTE_CONFLICT +// +// MessageText: +// +// The reparse attribute cannot be set as it is incompatible with an existing attribute. +// +#define STATUS_REPARSE_ATTRIBUTE_CONFLICT ((NTSTATUS)0xC00002B2L) + +// +// MessageId: STATUS_CANT_ENABLE_DENY_ONLY +// +// MessageText: +// +// A group marked use for deny only cannot be enabled. +// +#define STATUS_CANT_ENABLE_DENY_ONLY ((NTSTATUS)0xC00002B3L) + +// +// MessageId: STATUS_FLOAT_MULTIPLE_FAULTS +// +// MessageText: +// +// {EXCEPTION} +// Multiple floating point faults. +// +#define STATUS_FLOAT_MULTIPLE_FAULTS ((NTSTATUS)0xC00002B4L) // winnt + +// +// MessageId: STATUS_FLOAT_MULTIPLE_TRAPS +// +// MessageText: +// +// {EXCEPTION} +// Multiple floating point traps. +// +#define STATUS_FLOAT_MULTIPLE_TRAPS ((NTSTATUS)0xC00002B5L) // winnt + +// +// MessageId: STATUS_DEVICE_REMOVED +// +// MessageText: +// +// The device has been removed. +// +#define STATUS_DEVICE_REMOVED ((NTSTATUS)0xC00002B6L) + +// +// MessageId: STATUS_JOURNAL_DELETE_IN_PROGRESS +// +// MessageText: +// +// The volume change journal is being deleted. +// +#define STATUS_JOURNAL_DELETE_IN_PROGRESS ((NTSTATUS)0xC00002B7L) + +// +// MessageId: STATUS_JOURNAL_NOT_ACTIVE +// +// MessageText: +// +// The volume change journal is not active. +// +#define STATUS_JOURNAL_NOT_ACTIVE ((NTSTATUS)0xC00002B8L) + +// +// MessageId: STATUS_NOINTERFACE +// +// MessageText: +// +// The requested interface is not supported. +// +#define STATUS_NOINTERFACE ((NTSTATUS)0xC00002B9L) + +// +// MessageId: STATUS_DS_RIDMGR_DISABLED +// +// MessageText: +// +// The directory service detected the subsystem that allocates relative identifiers is disabled. This can occur as a protective mechanism when the system determines a significant portion of relative identifiers (RIDs) have been exhausted. Please see http://go.microsoft.com/fwlink/?LinkId=228610 for recommended diagnostic steps and the procedure to re-enable account creation. +// +#define STATUS_DS_RIDMGR_DISABLED ((NTSTATUS)0xC00002BAL) + +// +// MessageId: STATUS_DS_ADMIN_LIMIT_EXCEEDED +// +// MessageText: +// +// A directory service resource limit has been exceeded. +// +#define STATUS_DS_ADMIN_LIMIT_EXCEEDED ((NTSTATUS)0xC00002C1L) + +// +// MessageId: STATUS_DRIVER_FAILED_SLEEP +// +// MessageText: +// +// {System Standby Failed} +// The driver %hs does not support standby mode. Updating this driver may allow the system to go to standby mode. +// +#define STATUS_DRIVER_FAILED_SLEEP ((NTSTATUS)0xC00002C2L) + +// +// MessageId: STATUS_MUTUAL_AUTHENTICATION_FAILED +// +// MessageText: +// +// Mutual Authentication failed. The server's password is out of date at the domain controller. +// +#define STATUS_MUTUAL_AUTHENTICATION_FAILED ((NTSTATUS)0xC00002C3L) + +// +// MessageId: STATUS_CORRUPT_SYSTEM_FILE +// +// MessageText: +// +// The system file %1 has become corrupt and has been replaced. +// +#define STATUS_CORRUPT_SYSTEM_FILE ((NTSTATUS)0xC00002C4L) + +// +// MessageId: STATUS_DATATYPE_MISALIGNMENT_ERROR +// +// MessageText: +// +// {EXCEPTION} +// Alignment Error +// A datatype misalignment error was detected in a load or store instruction. +// +#define STATUS_DATATYPE_MISALIGNMENT_ERROR ((NTSTATUS)0xC00002C5L) + +// +// MessageId: STATUS_WMI_READ_ONLY +// +// MessageText: +// +// The WMI data item or data block is read only. +// +#define STATUS_WMI_READ_ONLY ((NTSTATUS)0xC00002C6L) + +// +// MessageId: STATUS_WMI_SET_FAILURE +// +// MessageText: +// +// The WMI data item or data block could not be changed. +// +#define STATUS_WMI_SET_FAILURE ((NTSTATUS)0xC00002C7L) + +// +// MessageId: STATUS_COMMITMENT_MINIMUM +// +// MessageText: +// +// {Virtual Memory Minimum Too Low} +// Your system is low on virtual memory. Windows is increasing the size of your virtual memory paging file. During this process, memory requests for some applications may be denied. For more information, see Help. +// +#define STATUS_COMMITMENT_MINIMUM ((NTSTATUS)0xC00002C8L) + +// +// MessageId: STATUS_REG_NAT_CONSUMPTION +// +// MessageText: +// +// {EXCEPTION} +// Register NaT consumption faults. +// A NaT value is consumed on a non speculative instruction. +// +#define STATUS_REG_NAT_CONSUMPTION ((NTSTATUS)0xC00002C9L) // winnt + +// +// MessageId: STATUS_TRANSPORT_FULL +// +// MessageText: +// +// The medium changer's transport element contains media, which is causing the operation to fail. +// +#define STATUS_TRANSPORT_FULL ((NTSTATUS)0xC00002CAL) + +// +// MessageId: STATUS_DS_SAM_INIT_FAILURE +// +// MessageText: +// +// Security Accounts Manager initialization failed because of the following error: +// %hs +// Error Status: 0x%x. +// Please shutdown this system and reboot into Directory Services Restore Mode, check the event log for more detailed information. +// +#define STATUS_DS_SAM_INIT_FAILURE ((NTSTATUS)0xC00002CBL) + +// +// MessageId: STATUS_ONLY_IF_CONNECTED +// +// MessageText: +// +// This operation is supported only when you are connected to the server. +// +#define STATUS_ONLY_IF_CONNECTED ((NTSTATUS)0xC00002CCL) + +// +// MessageId: STATUS_DS_SENSITIVE_GROUP_VIOLATION +// +// MessageText: +// +// Only an administrator can modify the membership list of an administrative group. +// +#define STATUS_DS_SENSITIVE_GROUP_VIOLATION ((NTSTATUS)0xC00002CDL) + +// +// MessageId: STATUS_PNP_RESTART_ENUMERATION +// +// MessageText: +// +// A device was removed so enumeration must be restarted. +// +#define STATUS_PNP_RESTART_ENUMERATION ((NTSTATUS)0xC00002CEL) + +// +// MessageId: STATUS_JOURNAL_ENTRY_DELETED +// +// MessageText: +// +// The journal entry has been deleted from the journal. +// +#define STATUS_JOURNAL_ENTRY_DELETED ((NTSTATUS)0xC00002CFL) + +// +// MessageId: STATUS_DS_CANT_MOD_PRIMARYGROUPID +// +// MessageText: +// +// Cannot change the primary group ID of a domain controller account. +// +#define STATUS_DS_CANT_MOD_PRIMARYGROUPID ((NTSTATUS)0xC00002D0L) + +// +// MessageId: STATUS_SYSTEM_IMAGE_BAD_SIGNATURE +// +// MessageText: +// +// {Fatal System Error} +// The system image %s is not properly signed. The file has been replaced with the signed file. The system has been shut down. +// +#define STATUS_SYSTEM_IMAGE_BAD_SIGNATURE ((NTSTATUS)0xC00002D1L) + +// +// MessageId: STATUS_PNP_REBOOT_REQUIRED +// +// MessageText: +// +// Device will not start without a reboot. +// +#define STATUS_PNP_REBOOT_REQUIRED ((NTSTATUS)0xC00002D2L) + +// +// MessageId: STATUS_POWER_STATE_INVALID +// +// MessageText: +// +// Current device power state cannot support this request. +// +#define STATUS_POWER_STATE_INVALID ((NTSTATUS)0xC00002D3L) + +// +// MessageId: STATUS_DS_INVALID_GROUP_TYPE +// +// MessageText: +// +// The specified group type is invalid. +// +#define STATUS_DS_INVALID_GROUP_TYPE ((NTSTATUS)0xC00002D4L) + +// +// MessageId: STATUS_DS_NO_NEST_GLOBALGROUP_IN_MIXEDDOMAIN +// +// MessageText: +// +// In mixed domain no nesting of global group if group is security enabled. +// +#define STATUS_DS_NO_NEST_GLOBALGROUP_IN_MIXEDDOMAIN ((NTSTATUS)0xC00002D5L) + +// +// MessageId: STATUS_DS_NO_NEST_LOCALGROUP_IN_MIXEDDOMAIN +// +// MessageText: +// +// In mixed domain, cannot nest local groups with other local groups, if the group is security enabled. +// +#define STATUS_DS_NO_NEST_LOCALGROUP_IN_MIXEDDOMAIN ((NTSTATUS)0xC00002D6L) + +// +// MessageId: STATUS_DS_GLOBAL_CANT_HAVE_LOCAL_MEMBER +// +// MessageText: +// +// A global group cannot have a local group as a member. +// +#define STATUS_DS_GLOBAL_CANT_HAVE_LOCAL_MEMBER ((NTSTATUS)0xC00002D7L) + +// +// MessageId: STATUS_DS_GLOBAL_CANT_HAVE_UNIVERSAL_MEMBER +// +// MessageText: +// +// A global group cannot have a universal group as a member. +// +#define STATUS_DS_GLOBAL_CANT_HAVE_UNIVERSAL_MEMBER ((NTSTATUS)0xC00002D8L) + +// +// MessageId: STATUS_DS_UNIVERSAL_CANT_HAVE_LOCAL_MEMBER +// +// MessageText: +// +// A universal group cannot have a local group as a member. +// +#define STATUS_DS_UNIVERSAL_CANT_HAVE_LOCAL_MEMBER ((NTSTATUS)0xC00002D9L) + +// +// MessageId: STATUS_DS_GLOBAL_CANT_HAVE_CROSSDOMAIN_MEMBER +// +// MessageText: +// +// A global group cannot have a cross domain member. +// +#define STATUS_DS_GLOBAL_CANT_HAVE_CROSSDOMAIN_MEMBER ((NTSTATUS)0xC00002DAL) + +// +// MessageId: STATUS_DS_LOCAL_CANT_HAVE_CROSSDOMAIN_LOCAL_MEMBER +// +// MessageText: +// +// A local group cannot have another cross domain local group as a member. +// +#define STATUS_DS_LOCAL_CANT_HAVE_CROSSDOMAIN_LOCAL_MEMBER ((NTSTATUS)0xC00002DBL) + +// +// MessageId: STATUS_DS_HAVE_PRIMARY_MEMBERS +// +// MessageText: +// +// Cannot change to security disabled group because of having primary members in this group. +// +#define STATUS_DS_HAVE_PRIMARY_MEMBERS ((NTSTATUS)0xC00002DCL) + +// +// MessageId: STATUS_WMI_NOT_SUPPORTED +// +// MessageText: +// +// The WMI operation is not supported by the data block or method. +// +#define STATUS_WMI_NOT_SUPPORTED ((NTSTATUS)0xC00002DDL) + +// +// MessageId: STATUS_INSUFFICIENT_POWER +// +// MessageText: +// +// There is not enough power to complete the requested operation. +// +#define STATUS_INSUFFICIENT_POWER ((NTSTATUS)0xC00002DEL) + +// +// MessageId: STATUS_SAM_NEED_BOOTKEY_PASSWORD +// +// MessageText: +// +// Security Account Manager needs to get the boot password. +// +#define STATUS_SAM_NEED_BOOTKEY_PASSWORD ((NTSTATUS)0xC00002DFL) + +// +// MessageId: STATUS_SAM_NEED_BOOTKEY_FLOPPY +// +// MessageText: +// +// Security Account Manager needs to get the boot key from floppy disk. +// +#define STATUS_SAM_NEED_BOOTKEY_FLOPPY ((NTSTATUS)0xC00002E0L) + +// +// MessageId: STATUS_DS_CANT_START +// +// MessageText: +// +// Directory Service cannot start. +// +#define STATUS_DS_CANT_START ((NTSTATUS)0xC00002E1L) + +// +// MessageId: STATUS_DS_INIT_FAILURE +// +// MessageText: +// +// Directory Services could not start because of the following error: +// %hs +// Error Status: 0x%x. +// Please shutdown this system and reboot into Directory Services Restore Mode, check the event log for more detailed information. +// +#define STATUS_DS_INIT_FAILURE ((NTSTATUS)0xC00002E2L) + +// +// MessageId: STATUS_SAM_INIT_FAILURE +// +// MessageText: +// +// Security Accounts Manager initialization failed because of the following error: +// %hs +// Error Status: 0x%x. +// Please click OK to shutdown this system and reboot into Safe Mode, check the event log for more detailed information. +// +#define STATUS_SAM_INIT_FAILURE ((NTSTATUS)0xC00002E3L) + +// +// MessageId: STATUS_DS_GC_REQUIRED +// +// MessageText: +// +// The requested operation can be performed only on a global catalog server. +// +#define STATUS_DS_GC_REQUIRED ((NTSTATUS)0xC00002E4L) + +// +// MessageId: STATUS_DS_LOCAL_MEMBER_OF_LOCAL_ONLY +// +// MessageText: +// +// A local group can only be a member of other local groups in the same domain. +// +#define STATUS_DS_LOCAL_MEMBER_OF_LOCAL_ONLY ((NTSTATUS)0xC00002E5L) + +// +// MessageId: STATUS_DS_NO_FPO_IN_UNIVERSAL_GROUPS +// +// MessageText: +// +// Foreign security principals cannot be members of universal groups. +// +#define STATUS_DS_NO_FPO_IN_UNIVERSAL_GROUPS ((NTSTATUS)0xC00002E6L) + +// +// MessageId: STATUS_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED +// +// MessageText: +// +// Your computer could not be joined to the domain. You have exceeded the maximum number of computer accounts you are allowed to create in this domain. Contact your system administrator to have this limit reset or increased. +// +#define STATUS_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED ((NTSTATUS)0xC00002E7L) + +// +// MessageId: STATUS_MULTIPLE_FAULT_VIOLATION +// +// MessageText: +// +// STATUS_MULTIPLE_FAULT_VIOLATION +// +#define STATUS_MULTIPLE_FAULT_VIOLATION ((NTSTATUS)0xC00002E8L) + +// +// MessageId: STATUS_CURRENT_DOMAIN_NOT_ALLOWED +// +// MessageText: +// +// This operation cannot be performed on the current domain. +// +#define STATUS_CURRENT_DOMAIN_NOT_ALLOWED ((NTSTATUS)0xC00002E9L) + +// +// MessageId: STATUS_CANNOT_MAKE +// +// MessageText: +// +// The directory or file cannot be created. +// +#define STATUS_CANNOT_MAKE ((NTSTATUS)0xC00002EAL) + +// +// MessageId: STATUS_SYSTEM_SHUTDOWN +// +// MessageText: +// +// The system is in the process of shutting down. +// +#define STATUS_SYSTEM_SHUTDOWN ((NTSTATUS)0xC00002EBL) + +// +// MessageId: STATUS_DS_INIT_FAILURE_CONSOLE +// +// MessageText: +// +// Directory Services could not start because of the following error: +// %hs +// Error Status: 0x%x. +// Please click OK to shutdown the system. You can use the recovery console to diagnose the system further. +// +#define STATUS_DS_INIT_FAILURE_CONSOLE ((NTSTATUS)0xC00002ECL) + +// +// MessageId: STATUS_DS_SAM_INIT_FAILURE_CONSOLE +// +// MessageText: +// +// Security Accounts Manager initialization failed because of the following error: +// %hs +// Error Status: 0x%x. +// Please click OK to shutdown the system. You can use the recovery console to diagnose the system further. +// +#define STATUS_DS_SAM_INIT_FAILURE_CONSOLE ((NTSTATUS)0xC00002EDL) + +// +// MessageId: STATUS_UNFINISHED_CONTEXT_DELETED +// +// MessageText: +// +// A security context was deleted before the context was completed. This is considered a logon failure. +// +#define STATUS_UNFINISHED_CONTEXT_DELETED ((NTSTATUS)0xC00002EEL) + +// +// MessageId: STATUS_NO_TGT_REPLY +// +// MessageText: +// +// The client is trying to negotiate a context and the server requires user-to-user but didn't send a TGT reply. +// +#define STATUS_NO_TGT_REPLY ((NTSTATUS)0xC00002EFL) + +// +// MessageId: STATUS_OBJECTID_NOT_FOUND +// +// MessageText: +// +// An object ID was not found in the file. +// +#define STATUS_OBJECTID_NOT_FOUND ((NTSTATUS)0xC00002F0L) + +// +// MessageId: STATUS_NO_IP_ADDRESSES +// +// MessageText: +// +// Unable to accomplish the requested task because the local machine does not have any IP addresses. +// +#define STATUS_NO_IP_ADDRESSES ((NTSTATUS)0xC00002F1L) + +// +// MessageId: STATUS_WRONG_CREDENTIAL_HANDLE +// +// MessageText: +// +// The supplied credential handle does not match the credential associated with the security context. +// +#define STATUS_WRONG_CREDENTIAL_HANDLE ((NTSTATUS)0xC00002F2L) + +// +// MessageId: STATUS_CRYPTO_SYSTEM_INVALID +// +// MessageText: +// +// The crypto system or checksum function is invalid because a required function is unavailable. +// +#define STATUS_CRYPTO_SYSTEM_INVALID ((NTSTATUS)0xC00002F3L) + +// +// MessageId: STATUS_MAX_REFERRALS_EXCEEDED +// +// MessageText: +// +// The number of maximum ticket referrals has been exceeded. +// +#define STATUS_MAX_REFERRALS_EXCEEDED ((NTSTATUS)0xC00002F4L) + +// +// MessageId: STATUS_MUST_BE_KDC +// +// MessageText: +// +// The local machine must be a Kerberos KDC (domain controller) and it is not. +// +#define STATUS_MUST_BE_KDC ((NTSTATUS)0xC00002F5L) + +// +// MessageId: STATUS_STRONG_CRYPTO_NOT_SUPPORTED +// +// MessageText: +// +// The other end of the security negotiation is requires strong crypto but it is not supported on the local machine. +// +#define STATUS_STRONG_CRYPTO_NOT_SUPPORTED ((NTSTATUS)0xC00002F6L) + +// +// MessageId: STATUS_TOO_MANY_PRINCIPALS +// +// MessageText: +// +// The KDC reply contained more than one principal name. +// +#define STATUS_TOO_MANY_PRINCIPALS ((NTSTATUS)0xC00002F7L) + +// +// MessageId: STATUS_NO_PA_DATA +// +// MessageText: +// +// Expected to find PA data for a hint of what etype to use, but it was not found. +// +#define STATUS_NO_PA_DATA ((NTSTATUS)0xC00002F8L) + +// +// MessageId: STATUS_PKINIT_NAME_MISMATCH +// +// MessageText: +// +// The client certificate does not contain a valid UPN, or does not match the client name in the logon request. Please contact your administrator. +// +#define STATUS_PKINIT_NAME_MISMATCH ((NTSTATUS)0xC00002F9L) + +// +// MessageId: STATUS_SMARTCARD_LOGON_REQUIRED +// +// MessageText: +// +// Smartcard logon is required and was not used. +// +#define STATUS_SMARTCARD_LOGON_REQUIRED ((NTSTATUS)0xC00002FAL) + +// +// MessageId: STATUS_KDC_INVALID_REQUEST +// +// MessageText: +// +// An invalid request was sent to the KDC. +// +#define STATUS_KDC_INVALID_REQUEST ((NTSTATUS)0xC00002FBL) + +// +// MessageId: STATUS_KDC_UNABLE_TO_REFER +// +// MessageText: +// +// The KDC was unable to generate a referral for the service requested. +// +#define STATUS_KDC_UNABLE_TO_REFER ((NTSTATUS)0xC00002FCL) + +// +// MessageId: STATUS_KDC_UNKNOWN_ETYPE +// +// MessageText: +// +// The encryption type requested is not supported by the KDC. +// +#define STATUS_KDC_UNKNOWN_ETYPE ((NTSTATUS)0xC00002FDL) + +// +// MessageId: STATUS_SHUTDOWN_IN_PROGRESS +// +// MessageText: +// +// A system shutdown is in progress. +// +#define STATUS_SHUTDOWN_IN_PROGRESS ((NTSTATUS)0xC00002FEL) + +// +// MessageId: STATUS_SERVER_SHUTDOWN_IN_PROGRESS +// +// MessageText: +// +// The server machine is shutting down. +// +#define STATUS_SERVER_SHUTDOWN_IN_PROGRESS ((NTSTATUS)0xC00002FFL) + +// +// MessageId: STATUS_NOT_SUPPORTED_ON_SBS +// +// MessageText: +// +// This operation is not supported on a computer running Windows Server 2003 for Small Business Server +// +#define STATUS_NOT_SUPPORTED_ON_SBS ((NTSTATUS)0xC0000300L) + +// +// MessageId: STATUS_WMI_GUID_DISCONNECTED +// +// MessageText: +// +// The WMI GUID is no longer available +// +#define STATUS_WMI_GUID_DISCONNECTED ((NTSTATUS)0xC0000301L) + +// +// MessageId: STATUS_WMI_ALREADY_DISABLED +// +// MessageText: +// +// Collection or events for the WMI GUID is already disabled. +// +#define STATUS_WMI_ALREADY_DISABLED ((NTSTATUS)0xC0000302L) + +// +// MessageId: STATUS_WMI_ALREADY_ENABLED +// +// MessageText: +// +// Collection or events for the WMI GUID is already enabled. +// +#define STATUS_WMI_ALREADY_ENABLED ((NTSTATUS)0xC0000303L) + +// +// MessageId: STATUS_MFT_TOO_FRAGMENTED +// +// MessageText: +// +// The Master File Table on the volume is too fragmented to complete this operation. +// +#define STATUS_MFT_TOO_FRAGMENTED ((NTSTATUS)0xC0000304L) + +// +// MessageId: STATUS_COPY_PROTECTION_FAILURE +// +// MessageText: +// +// Copy protection failure. +// +#define STATUS_COPY_PROTECTION_FAILURE ((NTSTATUS)0xC0000305L) + +// +// MessageId: STATUS_CSS_AUTHENTICATION_FAILURE +// +// MessageText: +// +// Copy protection error - DVD CSS Authentication failed. +// +#define STATUS_CSS_AUTHENTICATION_FAILURE ((NTSTATUS)0xC0000306L) + +// +// MessageId: STATUS_CSS_KEY_NOT_PRESENT +// +// MessageText: +// +// Copy protection error - The given sector does not contain a valid key. +// +#define STATUS_CSS_KEY_NOT_PRESENT ((NTSTATUS)0xC0000307L) + +// +// MessageId: STATUS_CSS_KEY_NOT_ESTABLISHED +// +// MessageText: +// +// Copy protection error - DVD session key not established. +// +#define STATUS_CSS_KEY_NOT_ESTABLISHED ((NTSTATUS)0xC0000308L) + +// +// MessageId: STATUS_CSS_SCRAMBLED_SECTOR +// +// MessageText: +// +// Copy protection error - The read failed because the sector is encrypted. +// +#define STATUS_CSS_SCRAMBLED_SECTOR ((NTSTATUS)0xC0000309L) + +// +// MessageId: STATUS_CSS_REGION_MISMATCH +// +// MessageText: +// +// Copy protection error - The given DVD's region does not correspond to the +// region setting of the drive. +// +#define STATUS_CSS_REGION_MISMATCH ((NTSTATUS)0xC000030AL) + +// +// MessageId: STATUS_CSS_RESETS_EXHAUSTED +// +// MessageText: +// +// Copy protection error - The drive's region setting may be permanent. +// +#define STATUS_CSS_RESETS_EXHAUSTED ((NTSTATUS)0xC000030BL) + +// +// MessageId: STATUS_PASSWORD_CHANGE_REQUIRED +// +// MessageText: +// +// EAS policy requires that the user change their password before this operation can be performed. +// +#define STATUS_PASSWORD_CHANGE_REQUIRED ((NTSTATUS)0xC000030CL) + +// +// MessageId: STATUS_LOST_MODE_LOGON_RESTRICTION +// +// MessageText: +// +// An administrator has restricted sign in. To sign in, make sure your device is connected to the Internet, and have your administrator sign in first. +// +#define STATUS_LOST_MODE_LOGON_RESTRICTION ((NTSTATUS)0xC000030DL) + +/*++ + + MessageId's 0x030e - 0x031f (inclusive) are reserved for future **STORAGE** + copy protection errors. + +--*/ +// +// MessageId: STATUS_PKINIT_FAILURE +// +// MessageText: +// +// The Kerberos protocol encountered an error while validating the KDC certificate during logon. There is more information in the system event log. +// +#define STATUS_PKINIT_FAILURE ((NTSTATUS)0xC0000320L) + +// +// MessageId: STATUS_SMARTCARD_SUBSYSTEM_FAILURE +// +// MessageText: +// +// The Kerberos protocol encountered an error while attempting to utilize the smartcard subsystem. +// +#define STATUS_SMARTCARD_SUBSYSTEM_FAILURE ((NTSTATUS)0xC0000321L) + +// +// MessageId: STATUS_NO_KERB_KEY +// +// MessageText: +// +// The target server does not have acceptable Kerberos credentials. +// +#define STATUS_NO_KERB_KEY ((NTSTATUS)0xC0000322L) + +/*++ + + MessageId's 0x0323 - 0x034f (inclusive) are reserved for other future copy + protection errors. + +--*/ +// +// MessageId: STATUS_HOST_DOWN +// +// MessageText: +// +// The transport determined that the remote system is down. +// +#define STATUS_HOST_DOWN ((NTSTATUS)0xC0000350L) + +// +// MessageId: STATUS_UNSUPPORTED_PREAUTH +// +// MessageText: +// +// An unsupported preauthentication mechanism was presented to the Kerberos package. +// +#define STATUS_UNSUPPORTED_PREAUTH ((NTSTATUS)0xC0000351L) + +// +// MessageId: STATUS_EFS_ALG_BLOB_TOO_BIG +// +// MessageText: +// +// The encryption algorithm used on the source file needs a bigger key buffer than the one used on the destination file. +// +#define STATUS_EFS_ALG_BLOB_TOO_BIG ((NTSTATUS)0xC0000352L) + +// +// MessageId: STATUS_PORT_NOT_SET +// +// MessageText: +// +// An attempt to remove a process's DebugPort was made, but a port was not already associated with the process. +// +#define STATUS_PORT_NOT_SET ((NTSTATUS)0xC0000353L) + +// +// MessageId: STATUS_DEBUGGER_INACTIVE +// +// MessageText: +// +// Debugger Inactive: Windows may have been started without kernel debugging enabled. +// +#define STATUS_DEBUGGER_INACTIVE ((NTSTATUS)0xC0000354L) + +// +// MessageId: STATUS_DS_VERSION_CHECK_FAILURE +// +// MessageText: +// +// This version of Windows is not compatible with the behavior version of directory forest, domain or domain controller. +// +#define STATUS_DS_VERSION_CHECK_FAILURE ((NTSTATUS)0xC0000355L) + +// +// MessageId: STATUS_AUDITING_DISABLED +// +// MessageText: +// +// The specified event is currently not being audited. +// +#define STATUS_AUDITING_DISABLED ((NTSTATUS)0xC0000356L) + +// +// MessageId: STATUS_PRENT4_MACHINE_ACCOUNT +// +// MessageText: +// +// The machine account was created pre-NT4. The account needs to be recreated. +// +#define STATUS_PRENT4_MACHINE_ACCOUNT ((NTSTATUS)0xC0000357L) + +// +// MessageId: STATUS_DS_AG_CANT_HAVE_UNIVERSAL_MEMBER +// +// MessageText: +// +// A account group cannot have a universal group as a member. +// +#define STATUS_DS_AG_CANT_HAVE_UNIVERSAL_MEMBER ((NTSTATUS)0xC0000358L) + +// +// MessageId: STATUS_INVALID_IMAGE_WIN_32 +// +// MessageText: +// +// The specified image file did not have the correct format, it appears to be a 32-bit Windows image. +// +#define STATUS_INVALID_IMAGE_WIN_32 ((NTSTATUS)0xC0000359L) + +// +// MessageId: STATUS_INVALID_IMAGE_WIN_64 +// +// MessageText: +// +// The specified image file did not have the correct format, it appears to be a 64-bit Windows image. +// +#define STATUS_INVALID_IMAGE_WIN_64 ((NTSTATUS)0xC000035AL) + +// +// MessageId: STATUS_BAD_BINDINGS +// +// MessageText: +// +// Client's supplied SSPI channel bindings were incorrect. +// +#define STATUS_BAD_BINDINGS ((NTSTATUS)0xC000035BL) + +// +// MessageId: STATUS_NETWORK_SESSION_EXPIRED +// +// MessageText: +// +// The client's session has expired, so the client must reauthenticate to continue accessing the remote resources. +// +#define STATUS_NETWORK_SESSION_EXPIRED ((NTSTATUS)0xC000035CL) + +// +// MessageId: STATUS_APPHELP_BLOCK +// +// MessageText: +// +// AppHelp dialog canceled thus preventing the application from starting. +// +#define STATUS_APPHELP_BLOCK ((NTSTATUS)0xC000035DL) + +// +// MessageId: STATUS_ALL_SIDS_FILTERED +// +// MessageText: +// +// The SID filtering operation removed all SIDs. +// +#define STATUS_ALL_SIDS_FILTERED ((NTSTATUS)0xC000035EL) + +// +// MessageId: STATUS_NOT_SAFE_MODE_DRIVER +// +// MessageText: +// +// The driver was not loaded because the system is booting into safe mode. +// +#define STATUS_NOT_SAFE_MODE_DRIVER ((NTSTATUS)0xC000035FL) + +// +// MessageId: STATUS_ACCESS_DISABLED_BY_POLICY_DEFAULT +// +// MessageText: +// +// Access to %1 has been restricted by your Administrator by the default software restriction policy level. +// +#define STATUS_ACCESS_DISABLED_BY_POLICY_DEFAULT ((NTSTATUS)0xC0000361L) + +// +// MessageId: STATUS_ACCESS_DISABLED_BY_POLICY_PATH +// +// MessageText: +// +// Access to %1 has been restricted by your Administrator by location with policy rule %2 placed on path %3 +// +#define STATUS_ACCESS_DISABLED_BY_POLICY_PATH ((NTSTATUS)0xC0000362L) + +// +// MessageId: STATUS_ACCESS_DISABLED_BY_POLICY_PUBLISHER +// +// MessageText: +// +// Access to %1 has been restricted by your Administrator by software publisher policy. +// +#define STATUS_ACCESS_DISABLED_BY_POLICY_PUBLISHER ((NTSTATUS)0xC0000363L) + +// +// MessageId: STATUS_ACCESS_DISABLED_BY_POLICY_OTHER +// +// MessageText: +// +// Access to %1 has been restricted by your Administrator by policy rule %2. +// +#define STATUS_ACCESS_DISABLED_BY_POLICY_OTHER ((NTSTATUS)0xC0000364L) + +// +// MessageId: STATUS_FAILED_DRIVER_ENTRY +// +// MessageText: +// +// The driver was not loaded because it failed its initialization call. +// +#define STATUS_FAILED_DRIVER_ENTRY ((NTSTATUS)0xC0000365L) + +// +// MessageId: STATUS_DEVICE_ENUMERATION_ERROR +// +// MessageText: +// +// The "%hs" encountered an error while applying power or reading the device configuration. This may be caused by a failure of your hardware or by a poor connection. +// +#define STATUS_DEVICE_ENUMERATION_ERROR ((NTSTATUS)0xC0000366L) + +// +// MessageId: STATUS_MOUNT_POINT_NOT_RESOLVED +// +// MessageText: +// +// The create operation failed because the name contained at least one mount point which resolves to a volume to which the specified device object is not attached. +// +#define STATUS_MOUNT_POINT_NOT_RESOLVED ((NTSTATUS)0xC0000368L) + +// +// MessageId: STATUS_INVALID_DEVICE_OBJECT_PARAMETER +// +// MessageText: +// +// The device object parameter is either not a valid device object or is not attached to the volume specified by the file name. +// +#define STATUS_INVALID_DEVICE_OBJECT_PARAMETER ((NTSTATUS)0xC0000369L) + +// +// MessageId: STATUS_MCA_OCCURED +// +// MessageText: +// +// A Machine Check Error has occurred. Please check the system eventlog for additional information. +// +#define STATUS_MCA_OCCURED ((NTSTATUS)0xC000036AL) + +// +// MessageId: STATUS_DRIVER_BLOCKED_CRITICAL +// +// MessageText: +// +// Driver %2 has been blocked from loading. +// +#define STATUS_DRIVER_BLOCKED_CRITICAL ((NTSTATUS)0xC000036BL) + +// +// MessageId: STATUS_DRIVER_BLOCKED +// +// MessageText: +// +// Driver %2 has been blocked from loading. +// +#define STATUS_DRIVER_BLOCKED ((NTSTATUS)0xC000036CL) + +// +// MessageId: STATUS_DRIVER_DATABASE_ERROR +// +// MessageText: +// +// There was error [%2] processing the driver database. +// +#define STATUS_DRIVER_DATABASE_ERROR ((NTSTATUS)0xC000036DL) + +// +// MessageId: STATUS_SYSTEM_HIVE_TOO_LARGE +// +// MessageText: +// +// System hive size has exceeded its limit. +// +#define STATUS_SYSTEM_HIVE_TOO_LARGE ((NTSTATUS)0xC000036EL) + +// +// MessageId: STATUS_INVALID_IMPORT_OF_NON_DLL +// +// MessageText: +// +// A dynamic link library (DLL) referenced a module that was neither a DLL nor the process's executable image. +// +#define STATUS_INVALID_IMPORT_OF_NON_DLL ((NTSTATUS)0xC000036FL) + +// +// MessageId: STATUS_DS_SHUTTING_DOWN +// +// MessageText: +// +// The Directory Service is shutting down. +// +#define STATUS_DS_SHUTTING_DOWN ((NTSTATUS)0x40000370L) + +// +// MessageId: STATUS_NO_SECRETS +// +// MessageText: +// +// The local account store does not contain secret material for the specified account. +// +#define STATUS_NO_SECRETS ((NTSTATUS)0xC0000371L) + +// +// MessageId: STATUS_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY +// +// MessageText: +// +// Access to %1 has been restricted by your Administrator by policy rule %2. +// +#define STATUS_ACCESS_DISABLED_NO_SAFER_UI_BY_POLICY ((NTSTATUS)0xC0000372L) + +// +// MessageId: STATUS_FAILED_STACK_SWITCH +// +// MessageText: +// +// The system was not able to allocate enough memory to perform a stack switch. +// +#define STATUS_FAILED_STACK_SWITCH ((NTSTATUS)0xC0000373L) + +// +// MessageId: STATUS_HEAP_CORRUPTION +// +// MessageText: +// +// A heap has been corrupted. +// +#define STATUS_HEAP_CORRUPTION ((NTSTATUS)0xC0000374L) // winnt + +// +// MessageId: STATUS_SMARTCARD_WRONG_PIN +// +// MessageText: +// +// An incorrect PIN was presented to the smart card +// +#define STATUS_SMARTCARD_WRONG_PIN ((NTSTATUS)0xC0000380L) + +// +// MessageId: STATUS_SMARTCARD_CARD_BLOCKED +// +// MessageText: +// +// The smart card is blocked +// +#define STATUS_SMARTCARD_CARD_BLOCKED ((NTSTATUS)0xC0000381L) + +// +// MessageId: STATUS_SMARTCARD_CARD_NOT_AUTHENTICATED +// +// MessageText: +// +// No PIN was presented to the smart card +// +#define STATUS_SMARTCARD_CARD_NOT_AUTHENTICATED ((NTSTATUS)0xC0000382L) + +// +// MessageId: STATUS_SMARTCARD_NO_CARD +// +// MessageText: +// +// No smart card available +// +#define STATUS_SMARTCARD_NO_CARD ((NTSTATUS)0xC0000383L) + +// +// MessageId: STATUS_SMARTCARD_NO_KEY_CONTAINER +// +// MessageText: +// +// The requested key container does not exist on the smart card +// +#define STATUS_SMARTCARD_NO_KEY_CONTAINER ((NTSTATUS)0xC0000384L) + +// +// MessageId: STATUS_SMARTCARD_NO_CERTIFICATE +// +// MessageText: +// +// The requested certificate does not exist on the smart card +// +#define STATUS_SMARTCARD_NO_CERTIFICATE ((NTSTATUS)0xC0000385L) + +// +// MessageId: STATUS_SMARTCARD_NO_KEYSET +// +// MessageText: +// +// The requested keyset does not exist +// +#define STATUS_SMARTCARD_NO_KEYSET ((NTSTATUS)0xC0000386L) + +// +// MessageId: STATUS_SMARTCARD_IO_ERROR +// +// MessageText: +// +// A communication error with the smart card has been detected. +// +#define STATUS_SMARTCARD_IO_ERROR ((NTSTATUS)0xC0000387L) + +// +// MessageId: STATUS_DOWNGRADE_DETECTED +// +// MessageText: +// +// The system cannot contact a domain controller to service the authentication request. Please try again later. +// +#define STATUS_DOWNGRADE_DETECTED ((NTSTATUS)0xC0000388L) + +// +// MessageId: STATUS_SMARTCARD_CERT_REVOKED +// +// MessageText: +// +// The smartcard certificate used for authentication has been revoked. Please contact your system administrator. There may be additional information in the event log. +// +#define STATUS_SMARTCARD_CERT_REVOKED ((NTSTATUS)0xC0000389L) + +// +// MessageId: STATUS_ISSUING_CA_UNTRUSTED +// +// MessageText: +// +// An untrusted certificate authority was detected while processing the certificate used for authentication. +// +#define STATUS_ISSUING_CA_UNTRUSTED ((NTSTATUS)0xC000038AL) + +// +// MessageId: STATUS_REVOCATION_OFFLINE_C +// +// MessageText: +// +// The revocation status of the certificate used for authentication could not be determined. +// +#define STATUS_REVOCATION_OFFLINE_C ((NTSTATUS)0xC000038BL) + +// +// MessageId: STATUS_PKINIT_CLIENT_FAILURE +// +// MessageText: +// +// The client certificate used for authentication was not trusted. +// +#define STATUS_PKINIT_CLIENT_FAILURE ((NTSTATUS)0xC000038CL) + +// +// MessageId: STATUS_SMARTCARD_CERT_EXPIRED +// +// MessageText: +// +// The smartcard certificate used for authentication has expired. Please +// contact your system administrator. +// +#define STATUS_SMARTCARD_CERT_EXPIRED ((NTSTATUS)0xC000038DL) + +// +// MessageId: STATUS_DRIVER_FAILED_PRIOR_UNLOAD +// +// MessageText: +// +// The driver could not be loaded because a previous version of the driver is still in memory. +// +#define STATUS_DRIVER_FAILED_PRIOR_UNLOAD ((NTSTATUS)0xC000038EL) + +// +// MessageId: STATUS_SMARTCARD_SILENT_CONTEXT +// +// MessageText: +// +// The smartcard provider could not perform the action since the context was acquired as silent. +// +#define STATUS_SMARTCARD_SILENT_CONTEXT ((NTSTATUS)0xC000038FL) + + /* MessageId up to 0x400 is reserved for smart cards */ +// +// MessageId: STATUS_PER_USER_TRUST_QUOTA_EXCEEDED +// +// MessageText: +// +// The current user's delegated trust creation quota has been exceeded. +// +#define STATUS_PER_USER_TRUST_QUOTA_EXCEEDED ((NTSTATUS)0xC0000401L) + +// +// MessageId: STATUS_ALL_USER_TRUST_QUOTA_EXCEEDED +// +// MessageText: +// +// The total delegated trust creation quota has been exceeded. +// +#define STATUS_ALL_USER_TRUST_QUOTA_EXCEEDED ((NTSTATUS)0xC0000402L) + +// +// MessageId: STATUS_USER_DELETE_TRUST_QUOTA_EXCEEDED +// +// MessageText: +// +// The current user's delegated trust deletion quota has been exceeded. +// +#define STATUS_USER_DELETE_TRUST_QUOTA_EXCEEDED ((NTSTATUS)0xC0000403L) + +// +// MessageId: STATUS_DS_NAME_NOT_UNIQUE +// +// MessageText: +// +// The requested name already exists as a unique identifier. +// +#define STATUS_DS_NAME_NOT_UNIQUE ((NTSTATUS)0xC0000404L) + +// +// MessageId: STATUS_DS_DUPLICATE_ID_FOUND +// +// MessageText: +// +// The requested object has a non-unique identifier and cannot be retrieved. +// +#define STATUS_DS_DUPLICATE_ID_FOUND ((NTSTATUS)0xC0000405L) + +// +// MessageId: STATUS_DS_GROUP_CONVERSION_ERROR +// +// MessageText: +// +// The group cannot be converted due to attribute restrictions on the requested group type. +// +#define STATUS_DS_GROUP_CONVERSION_ERROR ((NTSTATUS)0xC0000406L) + +// +// MessageId: STATUS_VOLSNAP_PREPARE_HIBERNATE +// +// MessageText: +// +// {Volume Shadow Copy Service} +// Please wait while the Volume Shadow Copy Service prepares volume %hs for hibernation. +// +#define STATUS_VOLSNAP_PREPARE_HIBERNATE ((NTSTATUS)0xC0000407L) + +// +// MessageId: STATUS_USER2USER_REQUIRED +// +// MessageText: +// +// Kerberos sub-protocol User2User is required. +// +#define STATUS_USER2USER_REQUIRED ((NTSTATUS)0xC0000408L) + +// +// MessageId: STATUS_STACK_BUFFER_OVERRUN +// +// MessageText: +// +// The system detected an overrun of a stack-based buffer in this application. This overrun could potentially allow a malicious user to gain control of this application. +// +#define STATUS_STACK_BUFFER_OVERRUN ((NTSTATUS)0xC0000409L) // winnt + +// +// MessageId: STATUS_NO_S4U_PROT_SUPPORT +// +// MessageText: +// +// The Kerberos subsystem encountered an error. A service for user protocol request was made against a domain controller which does not support service for user. +// +#define STATUS_NO_S4U_PROT_SUPPORT ((NTSTATUS)0xC000040AL) + +// +// MessageId: STATUS_CROSSREALM_DELEGATION_FAILURE +// +// MessageText: +// +// An attempt was made by this server to make a Kerberos constrained delegation request for a target outside of the server's realm. This is not supported, and indicates a misconfiguration on this server's allowed to delegate to list. Please contact your administrator. +// +#define STATUS_CROSSREALM_DELEGATION_FAILURE ((NTSTATUS)0xC000040BL) + +// +// MessageId: STATUS_REVOCATION_OFFLINE_KDC +// +// MessageText: +// +// The revocation status of the domain controller certificate used for authentication could not be determined. There is additional information in the system event log. +// +#define STATUS_REVOCATION_OFFLINE_KDC ((NTSTATUS)0xC000040CL) + +// +// MessageId: STATUS_ISSUING_CA_UNTRUSTED_KDC +// +// MessageText: +// +// An untrusted certificate authority was detected while processing the domain controller certificate used for authentication. There is additional information in the system event log. Please contact your system administrator. +// +#define STATUS_ISSUING_CA_UNTRUSTED_KDC ((NTSTATUS)0xC000040DL) + +// +// MessageId: STATUS_KDC_CERT_EXPIRED +// +// MessageText: +// +// The domain controller certificate used for logon has expired. There is additional information in the system event log. +// +#define STATUS_KDC_CERT_EXPIRED ((NTSTATUS)0xC000040EL) + +// +// MessageId: STATUS_KDC_CERT_REVOKED +// +// MessageText: +// +// The domain controller certificate used for logon has been revoked. There is additional information in the system event log. +// +#define STATUS_KDC_CERT_REVOKED ((NTSTATUS)0xC000040FL) + +// +// MessageId: STATUS_PARAMETER_QUOTA_EXCEEDED +// +// MessageText: +// +// Data present in one of the parameters is more than the function can operate on. +// +#define STATUS_PARAMETER_QUOTA_EXCEEDED ((NTSTATUS)0xC0000410L) + +// +// MessageId: STATUS_HIBERNATION_FAILURE +// +// MessageText: +// +// The system has failed to hibernate (The error code is %hs). Hibernation will be disabled until the system is restarted. +// +#define STATUS_HIBERNATION_FAILURE ((NTSTATUS)0xC0000411L) + +// +// MessageId: STATUS_DELAY_LOAD_FAILED +// +// MessageText: +// +// An attempt to delay-load a .dll or get a function address in a delay-loaded .dll failed. +// +#define STATUS_DELAY_LOAD_FAILED ((NTSTATUS)0xC0000412L) + +// +// MessageId: STATUS_AUTHENTICATION_FIREWALL_FAILED +// +// MessageText: +// +// Logon Failure: The machine you are logging onto is protected by an authentication firewall. The specified account is not allowed to authenticate to the machine. +// +#define STATUS_AUTHENTICATION_FIREWALL_FAILED ((NTSTATUS)0xC0000413L) + +// +// MessageId: STATUS_VDM_DISALLOWED +// +// MessageText: +// +// %hs is a 16-bit application. You do not have permissions to execute 16-bit applications. Check your permissions with your system administrator. +// +#define STATUS_VDM_DISALLOWED ((NTSTATUS)0xC0000414L) + +// +// MessageId: STATUS_HUNG_DISPLAY_DRIVER_THREAD +// +// MessageText: +// +// {Display Driver Stopped Responding} +// The %hs display driver has stopped working normally. Save your work and reboot the system to restore full display functionality. The next time you reboot the machine a dialog will be displayed giving you a chance to report this failure to Microsoft. +// +#define STATUS_HUNG_DISPLAY_DRIVER_THREAD ((NTSTATUS)0xC0000415L) + +// +// MessageId: STATUS_INSUFFICIENT_RESOURCE_FOR_SPECIFIED_SHARED_SECTION_SIZE +// +// MessageText: +// +// The Desktop heap encountered an error while allocating session memory. There is more information in the system event log. +// +#define STATUS_INSUFFICIENT_RESOURCE_FOR_SPECIFIED_SHARED_SECTION_SIZE ((NTSTATUS)0xC0000416L) + +// +// MessageId: STATUS_INVALID_CRUNTIME_PARAMETER +// +// MessageText: +// +// An invalid parameter was passed to a C runtime function. +// +#define STATUS_INVALID_CRUNTIME_PARAMETER ((NTSTATUS)0xC0000417L) // winnt + +// +// MessageId: STATUS_NTLM_BLOCKED +// +// MessageText: +// +// The authentication failed since NTLM was blocked. +// +#define STATUS_NTLM_BLOCKED ((NTSTATUS)0xC0000418L) + +// +// MessageId: STATUS_DS_SRC_SID_EXISTS_IN_FOREST +// +// MessageText: +// +// The source object's SID already exists in destination forest. +// +#define STATUS_DS_SRC_SID_EXISTS_IN_FOREST ((NTSTATUS)0xC0000419L) + +// +// MessageId: STATUS_DS_DOMAIN_NAME_EXISTS_IN_FOREST +// +// MessageText: +// +// The domain name of the trusted domain already exists in the forest. +// +#define STATUS_DS_DOMAIN_NAME_EXISTS_IN_FOREST ((NTSTATUS)0xC000041AL) + +// +// MessageId: STATUS_DS_FLAT_NAME_EXISTS_IN_FOREST +// +// MessageText: +// +// The flat name of the trusted domain already exists in the forest. +// +#define STATUS_DS_FLAT_NAME_EXISTS_IN_FOREST ((NTSTATUS)0xC000041BL) + +// +// MessageId: STATUS_INVALID_USER_PRINCIPAL_NAME +// +// MessageText: +// +// The User Principal Name (UPN) is invalid. +// +#define STATUS_INVALID_USER_PRINCIPAL_NAME ((NTSTATUS)0xC000041CL) + +// +// MessageId: STATUS_FATAL_USER_CALLBACK_EXCEPTION +// +// MessageText: +// +// An unhandled exception was encountered during a user callback. +// +#define STATUS_FATAL_USER_CALLBACK_EXCEPTION ((NTSTATUS)0xC000041DL) + +// +// MessageId: STATUS_ASSERTION_FAILURE +// +// MessageText: +// +// An assertion failure has occurred. +// +#define STATUS_ASSERTION_FAILURE ((NTSTATUS)0xC0000420L) // winnt + +// +// MessageId: STATUS_VERIFIER_STOP +// +// MessageText: +// +// Application verifier has found an error in the current process. +// +#define STATUS_VERIFIER_STOP ((NTSTATUS)0xC0000421L) + +// +// MessageId: STATUS_CALLBACK_POP_STACK +// +// MessageText: +// +// An exception has occurred in a user mode callback and the kernel callback frame should be removed. +// +#define STATUS_CALLBACK_POP_STACK ((NTSTATUS)0xC0000423L) + +// +// MessageId: STATUS_INCOMPATIBLE_DRIVER_BLOCKED +// +// MessageText: +// +// %2 has been blocked from loading due to incompatibility with this system. Please contact your software vendor for a compatible version of the driver. +// +#define STATUS_INCOMPATIBLE_DRIVER_BLOCKED ((NTSTATUS)0xC0000424L) + +// +// MessageId: STATUS_HIVE_UNLOADED +// +// MessageText: +// +// Illegal operation attempted on a registry key which has already been unloaded. +// +#define STATUS_HIVE_UNLOADED ((NTSTATUS)0xC0000425L) + +// +// MessageId: STATUS_COMPRESSION_DISABLED +// +// MessageText: +// +// Compression is disabled for this volume. +// +#define STATUS_COMPRESSION_DISABLED ((NTSTATUS)0xC0000426L) + +// +// MessageId: STATUS_FILE_SYSTEM_LIMITATION +// +// MessageText: +// +// The requested operation could not be completed due to a file system limitation +// +#define STATUS_FILE_SYSTEM_LIMITATION ((NTSTATUS)0xC0000427L) + +// +// MessageId: STATUS_INVALID_IMAGE_HASH +// +// MessageText: +// +// Windows cannot verify the digital signature for this file. A recent hardware or software change might have installed a file that is signed incorrectly or damaged, or that might be malicious software from an unknown source. +// +#define STATUS_INVALID_IMAGE_HASH ((NTSTATUS)0xC0000428L) + +// +// MessageId: STATUS_NOT_CAPABLE +// +// MessageText: +// +// The implementation is not capable of performing the request. +// +#define STATUS_NOT_CAPABLE ((NTSTATUS)0xC0000429L) + +// +// MessageId: STATUS_REQUEST_OUT_OF_SEQUENCE +// +// MessageText: +// +// The requested operation is out of order with respect to other operations. +// +#define STATUS_REQUEST_OUT_OF_SEQUENCE ((NTSTATUS)0xC000042AL) + +// +// MessageId: STATUS_IMPLEMENTATION_LIMIT +// +// MessageText: +// +// An operation attempted to exceed an implementation-defined limit. +// +#define STATUS_IMPLEMENTATION_LIMIT ((NTSTATUS)0xC000042BL) + +// +// MessageId: STATUS_ELEVATION_REQUIRED +// +// MessageText: +// +// The requested operation requires elevation. +// +#define STATUS_ELEVATION_REQUIRED ((NTSTATUS)0xC000042CL) + +// +// MessageId: STATUS_NO_SECURITY_CONTEXT +// +// MessageText: +// +// The required security context does not exist. +// +#define STATUS_NO_SECURITY_CONTEXT ((NTSTATUS)0xC000042DL) + +// +// MessageId 0x042E is reserved and used in isolation lib as +// +// MessageId=0x042E Facility=System Severity=ERROR SymbolicName=STATUS_VERSION_PARSE_ERROR +// Language=English +// A version number could not be parsed. +// . +// +// MessageId: STATUS_PKU2U_CERT_FAILURE +// +// MessageText: +// +// The PKU2U protocol encountered an error while attempting to utilize the associated certificates. +// +#define STATUS_PKU2U_CERT_FAILURE ((NTSTATUS)0xC000042FL) + +// +// MessageId: STATUS_BEYOND_VDL +// +// MessageText: +// +// The operation was attempted beyond the valid data length of the file. +// +#define STATUS_BEYOND_VDL ((NTSTATUS)0xC0000432L) + +// +// MessageId: STATUS_ENCOUNTERED_WRITE_IN_PROGRESS +// +// MessageText: +// +// The attempted write operation encountered a write already in progress for some portion of the range. +// +#define STATUS_ENCOUNTERED_WRITE_IN_PROGRESS ((NTSTATUS)0xC0000433L) + +// +// MessageId: STATUS_PTE_CHANGED +// +// MessageText: +// +// The page fault mappings changed in the middle of processing a fault so the operation must be retried. +// +#define STATUS_PTE_CHANGED ((NTSTATUS)0xC0000434L) + +// +// MessageId: STATUS_PURGE_FAILED +// +// MessageText: +// +// The attempt to purge this file from memory failed to purge some or all the data from memory. +// +#define STATUS_PURGE_FAILED ((NTSTATUS)0xC0000435L) + +// +// MessageId: STATUS_CRED_REQUIRES_CONFIRMATION +// +// MessageText: +// +// The requested credential requires confirmation. +// +#define STATUS_CRED_REQUIRES_CONFIRMATION ((NTSTATUS)0xC0000440L) + +// +// MessageId: STATUS_CS_ENCRYPTION_INVALID_SERVER_RESPONSE +// +// MessageText: +// +// The remote server sent an invalid response for a file being opened with Client Side Encryption. +// +#define STATUS_CS_ENCRYPTION_INVALID_SERVER_RESPONSE ((NTSTATUS)0xC0000441L) + +// +// MessageId: STATUS_CS_ENCRYPTION_UNSUPPORTED_SERVER +// +// MessageText: +// +// Client Side Encryption is not supported by the remote server even though it claims to support it. +// +#define STATUS_CS_ENCRYPTION_UNSUPPORTED_SERVER ((NTSTATUS)0xC0000442L) + +// +// MessageId: STATUS_CS_ENCRYPTION_EXISTING_ENCRYPTED_FILE +// +// MessageText: +// +// File is encrypted and should be opened in Client Side Encryption mode. +// +#define STATUS_CS_ENCRYPTION_EXISTING_ENCRYPTED_FILE ((NTSTATUS)0xC0000443L) + +// +// MessageId: STATUS_CS_ENCRYPTION_NEW_ENCRYPTED_FILE +// +// MessageText: +// +// A new encrypted file is being created and a $EFS needs to be provided. +// +#define STATUS_CS_ENCRYPTION_NEW_ENCRYPTED_FILE ((NTSTATUS)0xC0000444L) + +// +// MessageId: STATUS_CS_ENCRYPTION_FILE_NOT_CSE +// +// MessageText: +// +// The SMB client requested a CSE FSCTL on a non-CSE file. +// +#define STATUS_CS_ENCRYPTION_FILE_NOT_CSE ((NTSTATUS)0xC0000445L) + +// +// MessageId: STATUS_INVALID_LABEL +// +// MessageText: +// +// Indicates a particular Security ID may not be assigned as the label of an object. +// +#define STATUS_INVALID_LABEL ((NTSTATUS)0xC0000446L) + +// +// MessageId: STATUS_DRIVER_PROCESS_TERMINATED +// +// MessageText: +// +// The process hosting the driver for this device has terminated. +// +#define STATUS_DRIVER_PROCESS_TERMINATED ((NTSTATUS)0xC0000450L) + +// +// MessageId: STATUS_AMBIGUOUS_SYSTEM_DEVICE +// +// MessageText: +// +// The requested system device cannot be identified due to multiple indistinguishable devices potentially matching the identification criteria. +// +#define STATUS_AMBIGUOUS_SYSTEM_DEVICE ((NTSTATUS)0xC0000451L) + +// +// MessageId: STATUS_SYSTEM_DEVICE_NOT_FOUND +// +// MessageText: +// +// The requested system device cannot be found. +// +#define STATUS_SYSTEM_DEVICE_NOT_FOUND ((NTSTATUS)0xC0000452L) + +// +// MessageId: STATUS_RESTART_BOOT_APPLICATION +// +// MessageText: +// +// This boot application must be restarted. +// +#define STATUS_RESTART_BOOT_APPLICATION ((NTSTATUS)0xC0000453L) + +// +// MessageId: STATUS_INSUFFICIENT_NVRAM_RESOURCES +// +// MessageText: +// +// Insufficient NVRAM resources exist to complete the API. A reboot might be required. +// +#define STATUS_INSUFFICIENT_NVRAM_RESOURCES ((NTSTATUS)0xC0000454L) + +// +// MessageId: STATUS_INVALID_SESSION +// +// MessageText: +// +// The specified session is invalid. +// +#define STATUS_INVALID_SESSION ((NTSTATUS)0xC0000455L) + +// +// MessageId: STATUS_THREAD_ALREADY_IN_SESSION +// +// MessageText: +// +// The specified thread is already in a session. +// +#define STATUS_THREAD_ALREADY_IN_SESSION ((NTSTATUS)0xC0000456L) + +// +// MessageId: STATUS_THREAD_NOT_IN_SESSION +// +// MessageText: +// +// The specified thread is not in a session. +// +#define STATUS_THREAD_NOT_IN_SESSION ((NTSTATUS)0xC0000457L) + +// +// MessageId: STATUS_INVALID_WEIGHT +// +// MessageText: +// +// The specified weight is invalid. +// +#define STATUS_INVALID_WEIGHT ((NTSTATUS)0xC0000458L) + +// +// MessageId: STATUS_REQUEST_PAUSED +// +// MessageText: +// +// The operation was paused. +// +#define STATUS_REQUEST_PAUSED ((NTSTATUS)0xC0000459L) + +// +// MessageId: STATUS_NO_RANGES_PROCESSED +// +// MessageText: +// +// No ranges for the specified operation were able to be processed. +// +#define STATUS_NO_RANGES_PROCESSED ((NTSTATUS)0xC0000460L) + +// +// MessageId: STATUS_DISK_RESOURCES_EXHAUSTED +// +// MessageText: +// +// The physical resources of this disk have been exhausted. +// +#define STATUS_DISK_RESOURCES_EXHAUSTED ((NTSTATUS)0xC0000461L) + +// +// MessageId: STATUS_NEEDS_REMEDIATION +// +// MessageText: +// +// The application cannot be started. Try reinstalling the application to fix the problem. +// +#define STATUS_NEEDS_REMEDIATION ((NTSTATUS)0xC0000462L) + +// +// MessageId: STATUS_DEVICE_FEATURE_NOT_SUPPORTED +// +// MessageText: +// +// {Device Feature Not Supported} +// The device does not support the command feature. +// +#define STATUS_DEVICE_FEATURE_NOT_SUPPORTED ((NTSTATUS)0xC0000463L) + +// +// MessageId: STATUS_DEVICE_UNREACHABLE +// +// MessageText: +// +// {Source/Destination device unreachable} +// The device is unreachable. +// +#define STATUS_DEVICE_UNREACHABLE ((NTSTATUS)0xC0000464L) + +// +// MessageId: STATUS_INVALID_TOKEN +// +// MessageText: +// +// {Invalid Proxy Data Token} +// The token representing the data is invalid. +// +#define STATUS_INVALID_TOKEN ((NTSTATUS)0xC0000465L) + +// +// MessageId: STATUS_SERVER_UNAVAILABLE +// +// MessageText: +// +// The file server is temporarily unavailable. +// +#define STATUS_SERVER_UNAVAILABLE ((NTSTATUS)0xC0000466L) + +// +// MessageId: STATUS_FILE_NOT_AVAILABLE +// +// MessageText: +// +// The file is temporarily unavailable. +// +#define STATUS_FILE_NOT_AVAILABLE ((NTSTATUS)0xC0000467L) + +// +// MessageId: STATUS_DEVICE_INSUFFICIENT_RESOURCES +// +// MessageText: +// +// {Device Insufficient Resources} +// The target device has insufficient resources to complete the operation. +// +#define STATUS_DEVICE_INSUFFICIENT_RESOURCES ((NTSTATUS)0xC0000468L) + +// +// MessageId: STATUS_PACKAGE_UPDATING +// +// MessageText: +// +// The application cannot be started because it is currently updating. +// +#define STATUS_PACKAGE_UPDATING ((NTSTATUS)0xC0000469L) + +// +// MessageId: STATUS_NOT_READ_FROM_COPY +// +// MessageText: +// +// The specified copy of the requested data could not be read. +// +#define STATUS_NOT_READ_FROM_COPY ((NTSTATUS)0xC000046AL) + +// +// MessageId: STATUS_FT_WRITE_FAILURE +// +// MessageText: +// +// The specified data could not be written to any of the copies. +// +#define STATUS_FT_WRITE_FAILURE ((NTSTATUS)0xC000046BL) + +// +// MessageId: STATUS_FT_DI_SCAN_REQUIRED +// +// MessageText: +// +// One or more copies of data on this device may be out of sync. No writes may be performed until a data integrity scan is completed. +// +#define STATUS_FT_DI_SCAN_REQUIRED ((NTSTATUS)0xC000046CL) + +// +// MessageId: STATUS_OBJECT_NOT_EXTERNALLY_BACKED +// +// MessageText: +// +// This object is not externally backed by any provider. +// +#define STATUS_OBJECT_NOT_EXTERNALLY_BACKED ((NTSTATUS)0xC000046DL) + +// +// MessageId: STATUS_EXTERNAL_BACKING_PROVIDER_UNKNOWN +// +// MessageText: +// +// The external backing provider is not recognized. +// +#define STATUS_EXTERNAL_BACKING_PROVIDER_UNKNOWN ((NTSTATUS)0xC000046EL) + +// +// MessageId: STATUS_COMPRESSION_NOT_BENEFICIAL +// +// MessageText: +// +// Compressing this object would not save space. +// +#define STATUS_COMPRESSION_NOT_BENEFICIAL ((NTSTATUS)0xC000046FL) + +// +// MessageId: STATUS_DATA_CHECKSUM_ERROR +// +// MessageText: +// +// A data integrity checksum error occurred. Data in the file stream is corrupt. +// +#define STATUS_DATA_CHECKSUM_ERROR ((NTSTATUS)0xC0000470L) + +// +// MessageId: STATUS_INTERMIXED_KERNEL_EA_OPERATION +// +// MessageText: +// +// An attempt was made to modify both a KERNEL and normal Extended Attribute (EA) in the same operation. +// +#define STATUS_INTERMIXED_KERNEL_EA_OPERATION ((NTSTATUS)0xC0000471L) + +// +// MessageId: STATUS_TRIM_READ_ZERO_NOT_SUPPORTED +// +// MessageText: +// +// {LogicalBlockProvisioningReadZero Not Supported} +// The target device does not support read returning zeros from trimmed/unmapped blocks. +// +#define STATUS_TRIM_READ_ZERO_NOT_SUPPORTED ((NTSTATUS)0xC0000472L) + +// +// MessageId: STATUS_TOO_MANY_SEGMENT_DESCRIPTORS +// +// MessageText: +// +// {Maximum Segment Descriptors Exceeded} +// The command specified a number of descriptors that exceeded the maximum supported by the device. +// +#define STATUS_TOO_MANY_SEGMENT_DESCRIPTORS ((NTSTATUS)0xC0000473L) + +// +// MessageId: STATUS_INVALID_OFFSET_ALIGNMENT +// +// MessageText: +// +// {Alignment Violation} +// The command specified a data offset that does not align to the device's granularity/alignment. +// +#define STATUS_INVALID_OFFSET_ALIGNMENT ((NTSTATUS)0xC0000474L) + +// +// MessageId: STATUS_INVALID_FIELD_IN_PARAMETER_LIST +// +// MessageText: +// +// {Invalid Field In Parameter List} +// The command specified an invalid field in its parameter list. +// +#define STATUS_INVALID_FIELD_IN_PARAMETER_LIST ((NTSTATUS)0xC0000475L) + +// +// MessageId: STATUS_OPERATION_IN_PROGRESS +// +// MessageText: +// +// {Operation In Progress} +// An operation is currently in progress with the device. +// +#define STATUS_OPERATION_IN_PROGRESS ((NTSTATUS)0xC0000476L) + +// +// MessageId: STATUS_INVALID_INITIATOR_TARGET_PATH +// +// MessageText: +// +// {Invalid I_T Nexus} +// An attempt was made to send down the command via an invalid path to the target device. +// +#define STATUS_INVALID_INITIATOR_TARGET_PATH ((NTSTATUS)0xC0000477L) + +// +// MessageId: STATUS_SCRUB_DATA_DISABLED +// +// MessageText: +// +// Scrub is disabled on the specified file. +// +#define STATUS_SCRUB_DATA_DISABLED ((NTSTATUS)0xC0000478L) + +// +// MessageId: STATUS_NOT_REDUNDANT_STORAGE +// +// MessageText: +// +// The storage device does not provide redundancy. +// +#define STATUS_NOT_REDUNDANT_STORAGE ((NTSTATUS)0xC0000479L) + +// +// MessageId: STATUS_RESIDENT_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a resident file. +// +#define STATUS_RESIDENT_FILE_NOT_SUPPORTED ((NTSTATUS)0xC000047AL) + +// +// MessageId: STATUS_COMPRESSED_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a compressed file. +// +#define STATUS_COMPRESSED_FILE_NOT_SUPPORTED ((NTSTATUS)0xC000047BL) + +// +// MessageId: STATUS_DIRECTORY_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a directory. +// +#define STATUS_DIRECTORY_NOT_SUPPORTED ((NTSTATUS)0xC000047CL) + +// +// MessageId: STATUS_IO_OPERATION_TIMEOUT +// +// MessageText: +// +// {IO Operation Timeout} +// The specified I/O operation failed to complete within the expected time period. +// +#define STATUS_IO_OPERATION_TIMEOUT ((NTSTATUS)0xC000047DL) + +// +// MessageId: STATUS_SYSTEM_NEEDS_REMEDIATION +// +// MessageText: +// +// An error in a system binary was detected. Try refreshing the PC to fix the problem. +// +#define STATUS_SYSTEM_NEEDS_REMEDIATION ((NTSTATUS)0xC000047EL) + +// +// MessageId: STATUS_APPX_INTEGRITY_FAILURE_CLR_NGEN +// +// MessageText: +// +// A corrupted CLR NGEN binary was detected on the system. +// +#define STATUS_APPX_INTEGRITY_FAILURE_CLR_NGEN ((NTSTATUS)0xC000047FL) + +// +// MessageId: STATUS_SHARE_UNAVAILABLE +// +// MessageText: +// +// The share is temporarily unavailable. +// +#define STATUS_SHARE_UNAVAILABLE ((NTSTATUS)0xC0000480L) + +// +// MessageId: STATUS_APISET_NOT_HOSTED +// +// MessageText: +// +// The target dll was not found because the apiset %hs is not hosted. +// +#define STATUS_APISET_NOT_HOSTED ((NTSTATUS)0xC0000481L) + +// +// MessageId: STATUS_APISET_NOT_PRESENT +// +// MessageText: +// +// The API set extension contains a host for a non-existent API set. +// +#define STATUS_APISET_NOT_PRESENT ((NTSTATUS)0xC0000482L) + +// +// MessageId: STATUS_DEVICE_HARDWARE_ERROR +// +// MessageText: +// +// The request failed due to a fatal device hardware error. +// +#define STATUS_DEVICE_HARDWARE_ERROR ((NTSTATUS)0xC0000483L) + +// +// MessageId: STATUS_FIRMWARE_SLOT_INVALID +// +// MessageText: +// +// The specified firmware slot is invalid. +// +#define STATUS_FIRMWARE_SLOT_INVALID ((NTSTATUS)0xC0000484L) + +// +// MessageId: STATUS_FIRMWARE_IMAGE_INVALID +// +// MessageText: +// +// The specified firmware image is invalid. +// +#define STATUS_FIRMWARE_IMAGE_INVALID ((NTSTATUS)0xC0000485L) + +// +// MessageId: STATUS_STORAGE_TOPOLOGY_ID_MISMATCH +// +// MessageText: +// +// The request failed due to a storage topology ID mismatch. +// +#define STATUS_STORAGE_TOPOLOGY_ID_MISMATCH ((NTSTATUS)0xC0000486L) + +// +// MessageId: STATUS_WIM_NOT_BOOTABLE +// +// MessageText: +// +// The specified Windows Image (WIM) is not marked as bootable. +// +#define STATUS_WIM_NOT_BOOTABLE ((NTSTATUS)0xC0000487L) + +// +// MessageId: STATUS_BLOCKED_BY_PARENTAL_CONTROLS +// +// MessageText: +// +// The operation was blocked by parental controls. +// +#define STATUS_BLOCKED_BY_PARENTAL_CONTROLS ((NTSTATUS)0xC0000488L) + +// +// MessageId: STATUS_NEEDS_REGISTRATION +// +// MessageText: +// +// The deployment operation failed because the specified application needs to be registered first. +// +#define STATUS_NEEDS_REGISTRATION ((NTSTATUS)0xC0000489L) + +// +// MessageId: STATUS_QUOTA_ACTIVITY +// +// MessageText: +// +// The requested operation failed due to quota operation is still in progress. +// +#define STATUS_QUOTA_ACTIVITY ((NTSTATUS)0xC000048AL) + +// +// MessageId: STATUS_CALLBACK_INVOKE_INLINE +// +// MessageText: +// +// The callback function must be invoked inline. +// +#define STATUS_CALLBACK_INVOKE_INLINE ((NTSTATUS)0xC000048BL) + +// +// MessageId: STATUS_BLOCK_TOO_MANY_REFERENCES +// +// MessageText: +// +// A file system block being referenced has already reached the maximum reference count and can't be referenced any further. +// +#define STATUS_BLOCK_TOO_MANY_REFERENCES ((NTSTATUS)0xC000048CL) + +// +// MessageId: STATUS_MARKED_TO_DISALLOW_WRITES +// +// MessageText: +// +// The requested operation failed because the file stream is marked to disallow writes. +// +#define STATUS_MARKED_TO_DISALLOW_WRITES ((NTSTATUS)0xC000048DL) + +// +// MessageId: STATUS_NETWORK_ACCESS_DENIED_EDP +// +// MessageText: +// +// Windows Information Protection policy does not allow access to this network resource. +// +#define STATUS_NETWORK_ACCESS_DENIED_EDP ((NTSTATUS)0xC000048EL) + +// +// MessageId: STATUS_ENCLAVE_FAILURE +// +// MessageText: +// +// The requested operation failed with an architecture-specific failure code. +// +#define STATUS_ENCLAVE_FAILURE ((NTSTATUS)0xC000048FL) + +// +// MessageId: STATUS_PNP_NO_COMPAT_DRIVERS +// +// MessageText: +// +// There are no compatible drivers available for this device. +// +#define STATUS_PNP_NO_COMPAT_DRIVERS ((NTSTATUS)0xC0000490L) + +// +// MessageId: STATUS_PNP_DRIVER_PACKAGE_NOT_FOUND +// +// MessageText: +// +// The specified driver package cannot be found on the system. +// +#define STATUS_PNP_DRIVER_PACKAGE_NOT_FOUND ((NTSTATUS)0xC0000491L) + +// +// MessageId: STATUS_PNP_DRIVER_CONFIGURATION_NOT_FOUND +// +// MessageText: +// +// The driver package cannot find a required driver configuration. +// +#define STATUS_PNP_DRIVER_CONFIGURATION_NOT_FOUND ((NTSTATUS)0xC0000492L) + +// +// MessageId: STATUS_PNP_DRIVER_CONFIGURATION_INCOMPLETE +// +// MessageText: +// +// The driver configuration is incomplete for use with this device. +// +#define STATUS_PNP_DRIVER_CONFIGURATION_INCOMPLETE ((NTSTATUS)0xC0000493L) + +// +// MessageId: STATUS_PNP_FUNCTION_DRIVER_REQUIRED +// +// MessageText: +// +// The device requires a driver configuration with a function driver. +// +#define STATUS_PNP_FUNCTION_DRIVER_REQUIRED ((NTSTATUS)0xC0000494L) + +// +// MessageId: STATUS_PNP_DEVICE_CONFIGURATION_PENDING +// +// MessageText: +// +// The device is pending further configuration. +// +#define STATUS_PNP_DEVICE_CONFIGURATION_PENDING ((NTSTATUS)0xC0000495L) + +// +// MessageId: STATUS_DEVICE_HINT_NAME_BUFFER_TOO_SMALL +// +// MessageText: +// +// The device hint name buffer is too small to receive the remaining name. +// +#define STATUS_DEVICE_HINT_NAME_BUFFER_TOO_SMALL ((NTSTATUS)0xC0000496L) + +// +// MessageId: STATUS_PACKAGE_NOT_AVAILABLE +// +// MessageText: +// +// The package is currently not available. +// +#define STATUS_PACKAGE_NOT_AVAILABLE ((NTSTATUS)0xC0000497L) + +// +// MessageId: STATUS_DEVICE_IN_MAINTENANCE +// +// MessageText: +// +// The device is in maintenance mode. +// +#define STATUS_DEVICE_IN_MAINTENANCE ((NTSTATUS)0xC0000499L) + +// +// MessageId: STATUS_NOT_SUPPORTED_ON_DAX +// +// MessageText: +// +// The specified operation is not supported on a DAX volume. +// +#define STATUS_NOT_SUPPORTED_ON_DAX ((NTSTATUS)0xC000049AL) + +// +// MessageId: STATUS_FREE_SPACE_TOO_FRAGMENTED +// +// MessageText: +// +// The free space on the volume is too fragmented to complete this operation. +// +#define STATUS_FREE_SPACE_TOO_FRAGMENTED ((NTSTATUS)0xC000049BL) + +// +// MessageId: STATUS_DAX_MAPPING_EXISTS +// +// MessageText: +// +// The volume has active DAX mappings. +// +#define STATUS_DAX_MAPPING_EXISTS ((NTSTATUS)0xC000049CL) + +// +// MessageId: STATUS_CHILD_PROCESS_BLOCKED +// +// MessageText: +// +// The process creation has been blocked. +// +#define STATUS_CHILD_PROCESS_BLOCKED ((NTSTATUS)0xC000049DL) + +// +// MessageId: STATUS_STORAGE_LOST_DATA_PERSISTENCE +// +// MessageText: +// +// The storage device has lost data or persistence. +// +#define STATUS_STORAGE_LOST_DATA_PERSISTENCE ((NTSTATUS)0xC000049EL) + +// +// MessageId: STATUS_PARTITION_TERMINATING +// +// MessageText: +// +// An attempt was made to access a partition that has begun termination. +// +#define STATUS_PARTITION_TERMINATING ((NTSTATUS)0xC00004A0L) + +// +// MessageId: STATUS_EXTERNAL_SYSKEY_NOT_SUPPORTED +// +// MessageText: +// +// An externally encrypted syskey has been configured, but the system no longer supports this feature. Please see https://go.microsoft.com/fwlink/?linkid=851152 for more information. +// +#define STATUS_EXTERNAL_SYSKEY_NOT_SUPPORTED ((NTSTATUS)0xC00004A1L) + +// +// MessageId: STATUS_ENCLAVE_VIOLATION +// +// MessageText: +// +// An attempt was made to access protected memory in violation of its secure access policy. +// +#define STATUS_ENCLAVE_VIOLATION ((NTSTATUS)0xC00004A2L) // winnt + +// +// MessageId: STATUS_FILE_PROTECTED_UNDER_DPL +// +// MessageText: +// +// The read or write operation to an encrypted file could not be completed because the file can only be accessed when the device is unlocked. +// +#define STATUS_FILE_PROTECTED_UNDER_DPL ((NTSTATUS)0xC00004A3L) + +// +// MessageId: STATUS_VOLUME_NOT_CLUSTER_ALIGNED +// +// MessageText: +// +// The volume is not cluster aligned on the disk. +// +#define STATUS_VOLUME_NOT_CLUSTER_ALIGNED ((NTSTATUS)0xC00004A4L) + +// +// MessageId: STATUS_NO_PHYSICALLY_ALIGNED_FREE_SPACE_FOUND +// +// MessageText: +// +// No physically aligned free space was found on the volume. +// +#define STATUS_NO_PHYSICALLY_ALIGNED_FREE_SPACE_FOUND ((NTSTATUS)0xC00004A5L) + +// +// MessageId: STATUS_APPX_FILE_NOT_ENCRYPTED +// +// MessageText: +// +// The APPX file can not be accessed because it is not encrypted as expected. +// +#define STATUS_APPX_FILE_NOT_ENCRYPTED ((NTSTATUS)0xC00004A6L) + +// +// MessageId: STATUS_RWRAW_ENCRYPTED_FILE_NOT_ENCRYPTED +// +// MessageText: +// +// A read or write of raw encrypted data cannot be performed because the file is not encrypted. +// +#define STATUS_RWRAW_ENCRYPTED_FILE_NOT_ENCRYPTED ((NTSTATUS)0xC00004A7L) + +// +// MessageId: STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_FILEOFFSET +// +// MessageText: +// +// An invalid file offset in the encrypted data info block was passed for read or write operation of file's raw encrypted data. +// +#define STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_FILEOFFSET ((NTSTATUS)0xC00004A8L) + +// +// MessageId: STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_FILERANGE +// +// MessageText: +// +// An invalid offset and length combination in the encrypted data info was passed for read or write operation of file's raw encrypted data. +// +#define STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_FILERANGE ((NTSTATUS)0xC00004A9L) + +// +// MessageId: STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_PARAMETER +// +// MessageText: +// +// An invalid parameter in the encrypted data info was passed for read or write operation of file's raw encrypted data. +// +#define STATUS_RWRAW_ENCRYPTED_INVALID_EDATAINFO_PARAMETER ((NTSTATUS)0xC00004AAL) + +// +// MessageId: STATUS_FT_READ_FAILURE +// +// MessageText: +// +// The specified data could not be read from any of the copies. +// +#define STATUS_FT_READ_FAILURE ((NTSTATUS)0xC00004ABL) + +// +// MessageId: STATUS_PATCH_CONFLICT +// +// MessageText: +// +// A system patch could not be applied due to conflicting accesses to the system image. +// +#define STATUS_PATCH_CONFLICT ((NTSTATUS)0xC00004ACL) + +// +// MessageId: STATUS_STORAGE_RESERVE_ID_INVALID +// +// MessageText: +// +// The specified storage reserve ID is invalid. +// +#define STATUS_STORAGE_RESERVE_ID_INVALID ((NTSTATUS)0xC00004ADL) + +// +// MessageId: STATUS_STORAGE_RESERVE_DOES_NOT_EXIST +// +// MessageText: +// +// The specified storage reserve does not exist. +// +#define STATUS_STORAGE_RESERVE_DOES_NOT_EXIST ((NTSTATUS)0xC00004AEL) + +// +// MessageId: STATUS_STORAGE_RESERVE_ALREADY_EXISTS +// +// MessageText: +// +// The specified storage reserve already exists. +// +#define STATUS_STORAGE_RESERVE_ALREADY_EXISTS ((NTSTATUS)0xC00004AFL) + +// +// MessageId: STATUS_STORAGE_RESERVE_NOT_EMPTY +// +// MessageText: +// +// The specified storage reserve is not empty. +// +#define STATUS_STORAGE_RESERVE_NOT_EMPTY ((NTSTATUS)0xC00004B0L) + +// +// MessageId: STATUS_NOT_A_DAX_VOLUME +// +// MessageText: +// +// This operation requires a DAX volume. +// +#define STATUS_NOT_A_DAX_VOLUME ((NTSTATUS)0xC00004B1L) + +// +// MessageId: STATUS_NOT_DAX_MAPPABLE +// +// MessageText: +// +// This stream is not DAX mappable. +// +#define STATUS_NOT_DAX_MAPPABLE ((NTSTATUS)0xC00004B2L) + +// +// MessageId: STATUS_CASE_DIFFERING_NAMES_IN_DIR +// +// MessageText: +// +// This directory contains entries whose names differ only in case. +// +#define STATUS_CASE_DIFFERING_NAMES_IN_DIR ((NTSTATUS)0xC00004B3L) + +// +// MessageId: STATUS_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The file cannot be safely opened because it is not supported by this version of Windows. +// +#define STATUS_FILE_NOT_SUPPORTED ((NTSTATUS)0xC00004B4L) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_BTT +// +// MessageText: +// +// This operation is not supported with BTT enabled. +// +#define STATUS_NOT_SUPPORTED_WITH_BTT ((NTSTATUS)0xC00004B5L) + +// +// MessageId: STATUS_ENCRYPTION_DISABLED +// +// MessageText: +// +// This operation cannot be performed because encryption is currently disabled. +// +#define STATUS_ENCRYPTION_DISABLED ((NTSTATUS)0xC00004B6L) + +// +// MessageId: STATUS_ENCRYPTING_METADATA_DISALLOWED +// +// MessageText: +// +// This encryption operation cannot be performed on filesystem metadata. +// +#define STATUS_ENCRYPTING_METADATA_DISALLOWED ((NTSTATUS)0xC00004B7L) + +// +// MessageId: STATUS_CANT_CLEAR_ENCRYPTION_FLAG +// +// MessageText: +// +// Encryption cannot be cleared on this file/directory because it still has an encrypted attribute. +// +#define STATUS_CANT_CLEAR_ENCRYPTION_FLAG ((NTSTATUS)0xC00004B8L) + +// +// MessageId: STATUS_UNSATISFIED_DEPENDENCIES +// +// MessageText: +// +// The operation could not be completed due to one or more unsatisfied dependencies. +// +#define STATUS_UNSATISFIED_DEPENDENCIES ((NTSTATUS)0xC00004B9L) + +// +// MessageId: STATUS_CASE_SENSITIVE_PATH +// +// MessageText: +// +// The file cannot be opened because the path has a case-sensitive directory. +// +#define STATUS_CASE_SENSITIVE_PATH ((NTSTATUS)0xC00004BAL) + +// +// MessageId: STATUS_UNSUPPORTED_PAGING_MODE +// +// MessageText: +// +// The currently selected address translation mode is not supported. +// +#define STATUS_UNSUPPORTED_PAGING_MODE ((NTSTATUS)0xC00004BBL) + +// +// MessageId: STATUS_UNTRUSTED_MOUNT_POINT +// +// MessageText: +// +// The path cannot be traversed because it contains an untrusted mount point. +// +#define STATUS_UNTRUSTED_MOUNT_POINT ((NTSTATUS)0xC00004BCL) + +// +// MessageId: STATUS_HAS_SYSTEM_CRITICAL_FILES +// +// MessageText: +// +// The volume contains paging, crash dump or other system critical files. +// +#define STATUS_HAS_SYSTEM_CRITICAL_FILES ((NTSTATUS)0xC00004BDL) + +// +// MessageId: STATUS_OBJECT_IS_IMMUTABLE +// +// MessageText: +// +// The request cannot be completed as it requires modifying an immutable object. +// +#define STATUS_OBJECT_IS_IMMUTABLE ((NTSTATUS)0xC00004BEL) + +// +// MessageId: STATUS_FT_READ_FROM_COPY_FAILURE +// +// MessageText: +// +// The specified copy of the requested data could not be read. +// +#define STATUS_FT_READ_FROM_COPY_FAILURE ((NTSTATUS)0xC00004BFL) + +// +// MessageId: STATUS_IMAGE_LOADED_AS_PATCH_IMAGE +// +// MessageText: +// +// This image cannot be loaded because it has already been loaded as a hot patch image. +// +#define STATUS_IMAGE_LOADED_AS_PATCH_IMAGE ((NTSTATUS)0xC00004C0L) + +// +// MessageId: STATUS_STORAGE_STACK_ACCESS_DENIED +// +// MessageText: +// +// The storage stack returned STATUS_ACCESS_DENEID for the current operation. +// +#define STATUS_STORAGE_STACK_ACCESS_DENIED ((NTSTATUS)0xC00004C1L) + +// +// MessageId: STATUS_INSUFFICIENT_VIRTUAL_ADDR_RESOURCES +// +// MessageText: +// +// Insufficient Virtual Address resources to complete the operation. +// +#define STATUS_INSUFFICIENT_VIRTUAL_ADDR_RESOURCES ((NTSTATUS)0xC00004C2L) + +// +// MessageId: STATUS_ENCRYPTED_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on an encrypted file. +// +#define STATUS_ENCRYPTED_FILE_NOT_SUPPORTED ((NTSTATUS)0xC00004C3L) + +// +// MessageId: STATUS_SPARSE_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a sparse file. +// +#define STATUS_SPARSE_FILE_NOT_SUPPORTED ((NTSTATUS)0xC00004C4L) + +// +// MessageId: STATUS_PAGEFILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a pagefile. +// +#define STATUS_PAGEFILE_NOT_SUPPORTED ((NTSTATUS)0xC00004C5L) + +// +// MessageId: STATUS_VOLUME_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a volume. +// +#define STATUS_VOLUME_NOT_SUPPORTED ((NTSTATUS)0xC00004C6L) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_BYPASSIO +// +// MessageText: +// +// The specified operation is not supported on a BypassIO enabled file. +// +#define STATUS_NOT_SUPPORTED_WITH_BYPASSIO ((NTSTATUS)0xC00004C7L) + +// +// MessageId: STATUS_NO_BYPASSIO_DRIVER_SUPPORT +// +// MessageText: +// +// The specified driver does not support BypassIO operations. +// +#define STATUS_NO_BYPASSIO_DRIVER_SUPPORT ((NTSTATUS)0xC00004C8L) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_ENCRYPTION +// +// MessageText: +// +// The specified operation is not supported while encryption is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_ENCRYPTION ((NTSTATUS)0xC00004C9L) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_COMPRESSION +// +// MessageText: +// +// The specified operation is not supported while compression is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_COMPRESSION ((NTSTATUS)0xC00004CAL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_REPLICATION +// +// MessageText: +// +// The specified operation is not supported while replication is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_REPLICATION ((NTSTATUS)0xC00004CBL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_DEDUPLICATION +// +// MessageText: +// +// The specified operation is not supported while deduplication is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_DEDUPLICATION ((NTSTATUS)0xC00004CCL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_AUDITING +// +// MessageText: +// +// The specified operation is not supported while auditing is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_AUDITING ((NTSTATUS)0xC00004CDL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_MONITORING +// +// MessageText: +// +// The specified operation is not supported while monitoring is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_MONITORING ((NTSTATUS)0xC00004CEL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_SNAPSHOT +// +// MessageText: +// +// The specified operation is not supported while snapshot is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_SNAPSHOT ((NTSTATUS)0xC00004CFL) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_VIRTUALIZATION +// +// MessageText: +// +// The specified operation is not supported while virtualization is enabled on the target object. +// +#define STATUS_NOT_SUPPORTED_WITH_VIRTUALIZATION ((NTSTATUS)0xC00004D0L) + +// +// MessageId: STATUS_INDEX_OUT_OF_BOUNDS +// +// MessageText: +// +// The specified index is beyond the bounds of valid range. +// +#define STATUS_INDEX_OUT_OF_BOUNDS ((NTSTATUS)0xC00004D1L) + +// +// MessageId: STATUS_BYPASSIO_FLT_NOT_SUPPORTED +// +// MessageText: +// +// At least one minifilter does not support bypass IO. +// +#define STATUS_BYPASSIO_FLT_NOT_SUPPORTED ((NTSTATUS)0xC00004D2L) + +// +// MessageId: STATUS_VOLUME_WRITE_ACCESS_DENIED +// +// MessageText: +// +// The volume is opened for exclusive write access, preventing files from being opened for write access. +// +#define STATUS_VOLUME_WRITE_ACCESS_DENIED ((NTSTATUS)0xC00004D3L) + +// +// MessageId: STATUS_PATCH_NOT_REGISTERED +// +// MessageText: +// +// The patch is not currently registered for the corresponding base image. +// +#define STATUS_PATCH_NOT_REGISTERED ((NTSTATUS)0xC00004D4L) + +// +// MessageId: STATUS_NOT_SUPPORTED_WITH_CACHED_HANDLE +// +// MessageText: +// +// The specified operation is not supported on a file opened for cached IO. +// +#define STATUS_NOT_SUPPORTED_WITH_CACHED_HANDLE ((NTSTATUS)0xC00004D5L) + +// +// MessageId: STATUS_PDE_ENCRYPTION_UNAVAILABLE_FAILURE +// +// MessageText: +// +// Personal Data Encryption keys to encrypt data are currently unavailable due to a failure. +// +#define STATUS_PDE_ENCRYPTION_UNAVAILABLE_FAILURE ((NTSTATUS)0xC00004D6L) + +// +// MessageId: STATUS_PDE_DECRYPTION_UNAVAILABLE_FAILURE +// +// MessageText: +// +// Personal Data Encryption keys to decrypt data are currently unavailable due to a failure. +// +#define STATUS_PDE_DECRYPTION_UNAVAILABLE_FAILURE ((NTSTATUS)0xC00004D7L) + +// +// MessageId: STATUS_PDE_DECRYPTION_UNAVAILABLE +// +// MessageText: +// +// Personal Data Encryption keys to decrypt data are currently unavailable. +// +#define STATUS_PDE_DECRYPTION_UNAVAILABLE ((NTSTATUS)0xC00004D8L) + +// +// MessageId: STATUS_VOLUME_UPGRADE_NOT_NEEDED +// +// MessageText: +// +// Volume format is up to date already. +// +#define STATUS_VOLUME_UPGRADE_NOT_NEEDED ((NTSTATUS)0x400004D9L) + +// +// MessageId: STATUS_VOLUME_UPGRADE_PENDING +// +// MessageText: +// +// Volume upgrade is pending. A reboot or re-mount of the volume is required. +// +#define STATUS_VOLUME_UPGRADE_PENDING ((NTSTATUS)0x400004DAL) + +// +// MessageId: STATUS_VOLUME_UPGRADE_DISABLED +// +// MessageText: +// +// Volume upgrade is disabled. +// +#define STATUS_VOLUME_UPGRADE_DISABLED ((NTSTATUS)0xC00004DBL) + +// +// MessageId: STATUS_VOLUME_UPGRADE_DISABLED_TILL_OS_DOWNGRADE_EXPIRED +// +// MessageText: +// +// Volume upgrade is disabled until Windows OS downgrade period has expired. +// +#define STATUS_VOLUME_UPGRADE_DISABLED_TILL_OS_DOWNGRADE_EXPIRED ((NTSTATUS)0xC00004DCL) + +// +// MessageId: STATUS_NOT_A_DEV_VOLUME +// +// MessageText: +// +// This operation requires a developer volume. +// +#define STATUS_NOT_A_DEV_VOLUME ((NTSTATUS)0xC00004DDL) + +// +// MessageId: STATUS_FS_GUID_MISMATCH +// +// MessageText: +// +// The file system GUID in the per machine state did not match the one on disk. +// +#define STATUS_FS_GUID_MISMATCH ((NTSTATUS)0xC00004DEL) + +// +// MessageId: STATUS_CANT_ATTACH_TO_DEV_VOLUME +// +// MessageText: +// +// The file system minifilter cannot attach to the developer volume. +// +#define STATUS_CANT_ATTACH_TO_DEV_VOLUME ((NTSTATUS)0xC00004DFL) + +// +// MessageId: STATUS_MEMORY_DECOMPRESSION_FAILURE +// +// MessageText: +// +// The data stored in compressed memory falied to be decompressed. +// +#define STATUS_MEMORY_DECOMPRESSION_FAILURE ((NTSTATUS)0xC00004E0L) + +// +// MessageId: STATUS_INVALID_CONFIG_VALUE +// +// MessageText: +// +// The configured value is not valid. +// +#define STATUS_INVALID_CONFIG_VALUE ((NTSTATUS)0xC00004E1L) + +// +// MessageId: STATUS_MEMORY_DECOMPRESSION_HW_ERROR +// +// MessageText: +// +// The data stored in compressed memory falied to be decompressed due to encountering an uncorrectable hardware memory error. +// +#define STATUS_MEMORY_DECOMPRESSION_HW_ERROR ((NTSTATUS)0xC00004E2L) + +// +// MessageId: STATUS_VOLUME_ROLLBACK_DETECTED +// +// MessageText: +// +// The operation was aborted because the observed volume identity or current state was not expected. +// +#define STATUS_VOLUME_ROLLBACK_DETECTED ((NTSTATUS)0xC00004E3L) + + +// **** New SYSTEM error codes can be inserted here **** + +// +// MessageId: STATUS_INVALID_TASK_NAME +// +// MessageText: +// +// The specified task name is invalid. +// +#define STATUS_INVALID_TASK_NAME ((NTSTATUS)0xC0000500L) + +// +// MessageId: STATUS_INVALID_TASK_INDEX +// +// MessageText: +// +// The specified task index is invalid. +// +#define STATUS_INVALID_TASK_INDEX ((NTSTATUS)0xC0000501L) + +// +// MessageId: STATUS_THREAD_ALREADY_IN_TASK +// +// MessageText: +// +// The specified thread is already joining a task. +// +#define STATUS_THREAD_ALREADY_IN_TASK ((NTSTATUS)0xC0000502L) + +// +// MessageId: STATUS_CALLBACK_BYPASS +// +// MessageText: +// +// A callback has requested to bypass native code. +// +#define STATUS_CALLBACK_BYPASS ((NTSTATUS)0xC0000503L) + +// +// MessageId: STATUS_UNDEFINED_SCOPE +// +// MessageText: +// +// The Central Access Policy specified is not defined on the target machine. +// +#define STATUS_UNDEFINED_SCOPE ((NTSTATUS)0xC0000504L) + +// +// MessageId: STATUS_INVALID_CAP +// +// MessageText: +// +// The Central Access Policy obtained from Active Directory is invalid. +// +#define STATUS_INVALID_CAP ((NTSTATUS)0xC0000505L) + +// +// MessageId: STATUS_NOT_GUI_PROCESS +// +// MessageText: +// +// Unable to finish the requested operation because the specified process is not a GUI process. +// +#define STATUS_NOT_GUI_PROCESS ((NTSTATUS)0xC0000506L) + +// +// MessageId: STATUS_DEVICE_HUNG +// +// MessageText: +// +// The device is not responding and cannot be safely removed. +// +#define STATUS_DEVICE_HUNG ((NTSTATUS)0xC0000507L) + +// +// MessageId: STATUS_CONTAINER_ASSIGNED +// +// MessageText: +// +// The specified Job already has a container assigned to it. +// +#define STATUS_CONTAINER_ASSIGNED ((NTSTATUS)0xC0000508L) + +// +// MessageId: STATUS_JOB_NO_CONTAINER +// +// MessageText: +// +// The specified Job does not have a container assigned to it. +// +#define STATUS_JOB_NO_CONTAINER ((NTSTATUS)0xC0000509L) + +// +// MessageId: STATUS_DEVICE_UNRESPONSIVE +// +// MessageText: +// +// The device is unresponsive. +// +#define STATUS_DEVICE_UNRESPONSIVE ((NTSTATUS)0xC000050AL) + +// +// MessageId: STATUS_REPARSE_POINT_ENCOUNTERED +// +// MessageText: +// +// The object manager encountered a reparse point while retrieving an object. +// +#define STATUS_REPARSE_POINT_ENCOUNTERED ((NTSTATUS)0xC000050BL) + +// +// MessageId: STATUS_ATTRIBUTE_NOT_PRESENT +// +// MessageText: +// +// The requested attribute is not present on the specified file or directory. +// +#define STATUS_ATTRIBUTE_NOT_PRESENT ((NTSTATUS)0xC000050CL) + +// +// MessageId: STATUS_NOT_A_TIERED_VOLUME +// +// MessageText: +// +// This volume is not a tiered volume. +// +#define STATUS_NOT_A_TIERED_VOLUME ((NTSTATUS)0xC000050DL) + +// +// MessageId: STATUS_ALREADY_HAS_STREAM_ID +// +// MessageText: +// +// This file is currently associated with a different stream id. +// +#define STATUS_ALREADY_HAS_STREAM_ID ((NTSTATUS)0xC000050EL) + +// +// MessageId: STATUS_JOB_NOT_EMPTY +// +// MessageText: +// +// The requested operation could not be completed because the specified job has children. +// +#define STATUS_JOB_NOT_EMPTY ((NTSTATUS)0xC000050FL) + +// +// MessageId: STATUS_ALREADY_INITIALIZED +// +// MessageText: +// +// The specified object has already been initialized. +// +#define STATUS_ALREADY_INITIALIZED ((NTSTATUS)0xC0000510L) + +// +// MessageId: STATUS_ENCLAVE_NOT_TERMINATED +// +// MessageText: +// +// The specified enclave has not yet been terminated. +// +#define STATUS_ENCLAVE_NOT_TERMINATED ((NTSTATUS)0xC0000511L) + +// +// MessageId: STATUS_ENCLAVE_IS_TERMINATING +// +// MessageText: +// +// An attempt was made to access an enclave that has begun termination. +// +#define STATUS_ENCLAVE_IS_TERMINATING ((NTSTATUS)0xC0000512L) + +// +// MessageId: STATUS_SMB1_NOT_AVAILABLE +// +// MessageText: +// +// You can't connect to the file share because it's not secure. This share requires the obsolete SMB1 protocol, which is unsafe and could expose your system to attack. +// Your system requires SMB2 or higher. For more info on resolving this issue, see: https://go.microsoft.com/fwlink/?linkid=852747 +// +#define STATUS_SMB1_NOT_AVAILABLE ((NTSTATUS)0xC0000513L) + +// +// MessageId: STATUS_SMR_GARBAGE_COLLECTION_REQUIRED +// +// MessageText: +// +// The volume must undergo garbage collection. +// +#define STATUS_SMR_GARBAGE_COLLECTION_REQUIRED ((NTSTATUS)0xC0000514L) + +// +// MessageId: STATUS_INTERRUPTED +// +// MessageText: +// +// Execution of the thread was interrupted. +// +#define STATUS_INTERRUPTED ((NTSTATUS)0xC0000515L) // winnt + +// +// MessageId: STATUS_THREAD_NOT_RUNNING +// +// MessageText: +// +// The target thread is not currently running. +// +#define STATUS_THREAD_NOT_RUNNING ((NTSTATUS)0xC0000516L) // winnt + +// +// MessageId: STATUS_SESSION_KEY_TOO_SHORT +// +// MessageText: +// +// The negotiated session key does not meet the minimum length requirement. +// +#define STATUS_SESSION_KEY_TOO_SHORT ((NTSTATUS)0xC0000517L) + +// +// MessageId: STATUS_FS_METADATA_INCONSISTENT +// +// MessageText: +// +// The file system encountered a metadata file with inconsistent data. +// +#define STATUS_FS_METADATA_INCONSISTENT ((NTSTATUS)0xC0000518L) + + +// **** New SYSTEM error codes can be inserted here **** + +// +// MessageId: STATUS_FAIL_FAST_EXCEPTION +// +// MessageText: +// +// {Fail Fast Exception} +// A fail fast exception occurred. Exception handlers will not be invoked and the process will be terminated immediately. +// +#define STATUS_FAIL_FAST_EXCEPTION ((NTSTATUS)0xC0000602L) + +// +// MessageId: STATUS_IMAGE_CERT_REVOKED +// +// MessageText: +// +// Windows cannot verify the digital signature for this file. The signing certificate for this file has been revoked. +// +#define STATUS_IMAGE_CERT_REVOKED ((NTSTATUS)0xC0000603L) + +// +// MessageId: STATUS_DYNAMIC_CODE_BLOCKED +// +// MessageText: +// +// The operation was blocked as the process prohibits dynamic code generation. +// +#define STATUS_DYNAMIC_CODE_BLOCKED ((NTSTATUS)0xC0000604L) + +// +// MessageId: STATUS_IMAGE_CERT_EXPIRED +// +// MessageText: +// +// Windows cannot verify the digital signature for this file. The signing certificate for this file has expired. +// +#define STATUS_IMAGE_CERT_EXPIRED ((NTSTATUS)0xC0000605L) + +// +// MessageId: STATUS_STRICT_CFG_VIOLATION +// +// MessageText: +// +// The specified image file was blocked from loading because it does not enable a feature required by the process: Control Flow Guard. +// +#define STATUS_STRICT_CFG_VIOLATION ((NTSTATUS)0xC0000606L) + +// +// MessageId: STATUS_SET_CONTEXT_DENIED +// +// MessageText: +// +// The thread context could not be updated because this has been restricted for the process. +// +#define STATUS_SET_CONTEXT_DENIED ((NTSTATUS)0xC000060AL) + +// +// MessageId: STATUS_CROSS_PARTITION_VIOLATION +// +// MessageText: +// +// An attempt to access another partition's private file/section was rejected. +// +#define STATUS_CROSS_PARTITION_VIOLATION ((NTSTATUS)0xC000060BL) + +// +// MessageId: STATUS_PORT_CLOSED +// +// MessageText: +// +// The ALPC port is closed. +// +#define STATUS_PORT_CLOSED ((NTSTATUS)0xC0000700L) + +// +// MessageId: STATUS_MESSAGE_LOST +// +// MessageText: +// +// The ALPC message requested is no longer available. +// +#define STATUS_MESSAGE_LOST ((NTSTATUS)0xC0000701L) + +// +// MessageId: STATUS_INVALID_MESSAGE +// +// MessageText: +// +// The ALPC message supplied is invalid. +// +#define STATUS_INVALID_MESSAGE ((NTSTATUS)0xC0000702L) + +// +// MessageId: STATUS_REQUEST_CANCELED +// +// MessageText: +// +// The ALPC message has been canceled. +// +#define STATUS_REQUEST_CANCELED ((NTSTATUS)0xC0000703L) + +// +// MessageId: STATUS_RECURSIVE_DISPATCH +// +// MessageText: +// +// Invalid recursive dispatch attempt. +// +#define STATUS_RECURSIVE_DISPATCH ((NTSTATUS)0xC0000704L) + +// +// MessageId: STATUS_LPC_RECEIVE_BUFFER_EXPECTED +// +// MessageText: +// +// No receive buffer has been supplied in a synchronous request. +// +#define STATUS_LPC_RECEIVE_BUFFER_EXPECTED ((NTSTATUS)0xC0000705L) + +// +// MessageId: STATUS_LPC_INVALID_CONNECTION_USAGE +// +// MessageText: +// +// The connection port is used in an invalid context. +// +#define STATUS_LPC_INVALID_CONNECTION_USAGE ((NTSTATUS)0xC0000706L) + +// +// MessageId: STATUS_LPC_REQUESTS_NOT_ALLOWED +// +// MessageText: +// +// The ALPC port does not accept new request messages. +// +#define STATUS_LPC_REQUESTS_NOT_ALLOWED ((NTSTATUS)0xC0000707L) + +// +// MessageId: STATUS_RESOURCE_IN_USE +// +// MessageText: +// +// The resource requested is already in use. +// +#define STATUS_RESOURCE_IN_USE ((NTSTATUS)0xC0000708L) + +// +// MessageId: STATUS_HARDWARE_MEMORY_ERROR +// +// MessageText: +// +// The hardware has reported an uncorrectable memory error. +// +#define STATUS_HARDWARE_MEMORY_ERROR ((NTSTATUS)0xC0000709L) + +// +// MessageId: STATUS_THREADPOOL_HANDLE_EXCEPTION +// +// MessageText: +// +// Status 0x%08x was returned, waiting on handle 0x%x for wait 0x%p, in waiter 0x%p. +// +#define STATUS_THREADPOOL_HANDLE_EXCEPTION ((NTSTATUS)0xC000070AL) + +// +// MessageId: STATUS_THREADPOOL_SET_EVENT_ON_COMPLETION_FAILED +// +// MessageText: +// +// After a callback to 0x%p(0x%p), a completion call to SetEvent(0x%p) failed with status 0x%08x. +// +#define STATUS_THREADPOOL_SET_EVENT_ON_COMPLETION_FAILED ((NTSTATUS)0xC000070BL) + +// +// MessageId: STATUS_THREADPOOL_RELEASE_SEMAPHORE_ON_COMPLETION_FAILED +// +// MessageText: +// +// After a callback to 0x%p(0x%p), a completion call to ReleaseSemaphore(0x%p, %d) failed with status 0x%08x. +// +#define STATUS_THREADPOOL_RELEASE_SEMAPHORE_ON_COMPLETION_FAILED ((NTSTATUS)0xC000070CL) + +// +// MessageId: STATUS_THREADPOOL_RELEASE_MUTEX_ON_COMPLETION_FAILED +// +// MessageText: +// +// After a callback to 0x%p(0x%p), a completion call to ReleaseMutex(%p) failed with status 0x%08x. +// +#define STATUS_THREADPOOL_RELEASE_MUTEX_ON_COMPLETION_FAILED ((NTSTATUS)0xC000070DL) + +// +// MessageId: STATUS_THREADPOOL_FREE_LIBRARY_ON_COMPLETION_FAILED +// +// MessageText: +// +// After a callback to 0x%p(0x%p), an completion call to FreeLibrary(%p) failed with status 0x%08x. +// +#define STATUS_THREADPOOL_FREE_LIBRARY_ON_COMPLETION_FAILED ((NTSTATUS)0xC000070EL) + +// +// MessageId: STATUS_THREADPOOL_RELEASED_DURING_OPERATION +// +// MessageText: +// +// The threadpool 0x%p was released while a thread was posting a callback to 0x%p(0x%p) to it. +// +#define STATUS_THREADPOOL_RELEASED_DURING_OPERATION ((NTSTATUS)0xC000070FL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_WHILE_IMPERSONATING +// +// MessageText: +// +// A threadpool worker thread is impersonating a client, after a callback to 0x%p(0x%p). +// This is unexpected, indicating that the callback is missing a call to revert the impersonation. +// +#define STATUS_CALLBACK_RETURNED_WHILE_IMPERSONATING ((NTSTATUS)0xC0000710L) + +// +// MessageId: STATUS_APC_RETURNED_WHILE_IMPERSONATING +// +// MessageText: +// +// A threadpool worker thread is impersonating a client, after executing an APC. +// This is unexpected, indicating that the APC is missing a call to revert the impersonation. +// +#define STATUS_APC_RETURNED_WHILE_IMPERSONATING ((NTSTATUS)0xC0000711L) + +// +// MessageId: STATUS_PROCESS_IS_PROTECTED +// +// MessageText: +// +// Either the target process, or the target thread's containing process, is a protected process. +// +#define STATUS_PROCESS_IS_PROTECTED ((NTSTATUS)0xC0000712L) + +// +// MessageId: STATUS_MCA_EXCEPTION +// +// MessageText: +// +// A Thread is getting dispatched with MCA EXCEPTION because of MCA. +// +#define STATUS_MCA_EXCEPTION ((NTSTATUS)0xC0000713L) + +// +// MessageId: STATUS_CERTIFICATE_MAPPING_NOT_UNIQUE +// +// MessageText: +// +// The client certificate account mapping is not unique. +// +#define STATUS_CERTIFICATE_MAPPING_NOT_UNIQUE ((NTSTATUS)0xC0000714L) + +// +// MessageId: STATUS_SYMLINK_CLASS_DISABLED +// +// MessageText: +// +// The symbolic link cannot be followed because its type is disabled. +// +#define STATUS_SYMLINK_CLASS_DISABLED ((NTSTATUS)0xC0000715L) + +// +// MessageId: STATUS_INVALID_IDN_NORMALIZATION +// +// MessageText: +// +// Indicates that the specified string is not valid for IDN normalization. +// +#define STATUS_INVALID_IDN_NORMALIZATION ((NTSTATUS)0xC0000716L) + +// +// MessageId: STATUS_NO_UNICODE_TRANSLATION +// +// MessageText: +// +// No mapping for the Unicode character exists in the target multi-byte code page. +// +#define STATUS_NO_UNICODE_TRANSLATION ((NTSTATUS)0xC0000717L) + +// +// MessageId: STATUS_ALREADY_REGISTERED +// +// MessageText: +// +// The provided callback is already registered. +// +#define STATUS_ALREADY_REGISTERED ((NTSTATUS)0xC0000718L) //winnt + +// +// MessageId: STATUS_CONTEXT_MISMATCH +// +// MessageText: +// +// The provided context did not match the target. +// +#define STATUS_CONTEXT_MISMATCH ((NTSTATUS)0xC0000719L) + +// +// MessageId: STATUS_PORT_ALREADY_HAS_COMPLETION_LIST +// +// MessageText: +// +// The specified port already has a completion list. +// +#define STATUS_PORT_ALREADY_HAS_COMPLETION_LIST ((NTSTATUS)0xC000071AL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_THREAD_PRIORITY +// +// MessageText: +// +// A threadpool worker thread enter a callback at thread base priority 0x%x and exited at priority 0x%x. +// This is unexpected, indicating that the callback missed restoring the priority. +// +#define STATUS_CALLBACK_RETURNED_THREAD_PRIORITY ((NTSTATUS)0xC000071BL) + +// +// MessageId: STATUS_INVALID_THREAD +// +// MessageText: +// +// An invalid thread, handle %p, is specified for this operation. Possibly, a threadpool worker thread was specified. +// +#define STATUS_INVALID_THREAD ((NTSTATUS)0xC000071CL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_TRANSACTION +// +// MessageText: +// +// A threadpool worker thread enter a callback, which left transaction state. +// This is unexpected, indicating that the callback missed clearing the transaction. +// +#define STATUS_CALLBACK_RETURNED_TRANSACTION ((NTSTATUS)0xC000071DL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_LDR_LOCK +// +// MessageText: +// +// A threadpool worker thread enter a callback, which left the loader lock held. +// This is unexpected, indicating that the callback missed releasing the lock. +// +#define STATUS_CALLBACK_RETURNED_LDR_LOCK ((NTSTATUS)0xC000071EL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_LANG +// +// MessageText: +// +// A threadpool worker thread enter a callback, which left with preferred languages set. +// This is unexpected, indicating that the callback missed clearing them. +// +#define STATUS_CALLBACK_RETURNED_LANG ((NTSTATUS)0xC000071FL) + +// +// MessageId: STATUS_CALLBACK_RETURNED_PRI_BACK +// +// MessageText: +// +// A threadpool worker thread enter a callback, which left with background priorities set. +// This is unexpected, indicating that the callback missed restoring the original priorities. +// +#define STATUS_CALLBACK_RETURNED_PRI_BACK ((NTSTATUS)0xC0000720L) + +// +// MessageId: STATUS_CALLBACK_RETURNED_THREAD_AFFINITY +// +// MessageText: +// +// A threadpool worker thread enter a callback at thread affinity %p and exited at affinity %p. +// This is unexpected, indicating that the callback missed restoring the priority. +// +#define STATUS_CALLBACK_RETURNED_THREAD_AFFINITY ((NTSTATUS)0xC0000721L) + +// +// MessageId: STATUS_LPC_HANDLE_COUNT_EXCEEDED +// +// MessageText: +// +// The caller has exceeded the maximum number of handles that may be transmitted in +// a single local procedure call. +// +#define STATUS_LPC_HANDLE_COUNT_EXCEEDED ((NTSTATUS)0xC0000722L) + +// +// MessageId: STATUS_EXECUTABLE_MEMORY_WRITE +// +// MessageText: +// +// A write to executable memory occurred for a process that is managing such operations. +// +#define STATUS_EXECUTABLE_MEMORY_WRITE ((NTSTATUS)0xC0000723L) + +// +// MessageId: STATUS_KERNEL_EXECUTABLE_MEMORY_WRITE +// +// MessageText: +// +// A write to executable memory occurred from kernel mode for a process that is managing such operations. +// +#define STATUS_KERNEL_EXECUTABLE_MEMORY_WRITE ((NTSTATUS)0xC0000724L) + +// +// MessageId: STATUS_ATTACHED_EXECUTABLE_MEMORY_WRITE +// +// MessageText: +// +// A write to executable memory occurred from kernel mode while attached to a process that is managing such operations. +// +#define STATUS_ATTACHED_EXECUTABLE_MEMORY_WRITE ((NTSTATUS)0xC0000725L) + +// +// MessageId: STATUS_TRIGGERED_EXECUTABLE_MEMORY_WRITE +// +// MessageText: +// +// A write to executable memory was triggered cross-process to a process that is managing such operations. +// +#define STATUS_TRIGGERED_EXECUTABLE_MEMORY_WRITE ((NTSTATUS)0xC0000726L) + +// +// MessageId: STATUS_DISK_REPAIR_DISABLED +// +// MessageText: +// +// The attempted operation required self healing to be enabled. +// +#define STATUS_DISK_REPAIR_DISABLED ((NTSTATUS)0xC0000800L) + +// +// MessageId: STATUS_DS_DOMAIN_RENAME_IN_PROGRESS +// +// MessageText: +// +// The Directory Service cannot perform the requested operation because a domain rename operation is in progress. +// +#define STATUS_DS_DOMAIN_RENAME_IN_PROGRESS ((NTSTATUS)0xC0000801L) + +// +// MessageId: STATUS_DISK_QUOTA_EXCEEDED +// +// MessageText: +// +// The requested file operation failed because the storage quota was exceeded. +// To free up disk space, move files to a different location or delete unnecessary files. For more information, contact your system administrator. +// +#define STATUS_DISK_QUOTA_EXCEEDED ((NTSTATUS)0xC0000802L) + +// +// MessageId: STATUS_DATA_LOST_REPAIR +// +// MessageText: +// +// Windows discovered a corruption in the file "%hs". +// This file has now been repaired. +// Please check if any data in the file was lost because of the corruption. +// +#define STATUS_DATA_LOST_REPAIR ((NTSTATUS)0x80000803L) + +// +// MessageId: STATUS_CONTENT_BLOCKED +// +// MessageText: +// +// The requested file operation failed because the storage policy blocks that type of file. For more information, contact your system administrator. +// +#define STATUS_CONTENT_BLOCKED ((NTSTATUS)0xC0000804L) + +// +// MessageId: STATUS_BAD_CLUSTERS +// +// MessageText: +// +// The operation could not be completed due to bad clusters on disk. +// +#define STATUS_BAD_CLUSTERS ((NTSTATUS)0xC0000805L) + +// +// MessageId: STATUS_VOLUME_DIRTY +// +// MessageText: +// +// The operation could not be completed because the volume is dirty. Please run chkdsk and try again. +// +#define STATUS_VOLUME_DIRTY ((NTSTATUS)0xC0000806L) + +// +// MessageId: STATUS_DISK_REPAIR_REDIRECTED +// +// MessageText: +// +// The volume repair could not be performed while it is online. +// Please schedule to take the volume offline so that it can be repaired. +// +#define STATUS_DISK_REPAIR_REDIRECTED ((NTSTATUS)0x40000807L) + +// +// MessageId: STATUS_DISK_REPAIR_UNSUCCESSFUL +// +// MessageText: +// +// The volume repair was not successful. +// +#define STATUS_DISK_REPAIR_UNSUCCESSFUL ((NTSTATUS)0xC0000808L) + +// +// MessageId: STATUS_CORRUPT_LOG_OVERFULL +// +// MessageText: +// +// One of the volume corruption logs is full. Further corruptions that may be detected won't be logged. +// +#define STATUS_CORRUPT_LOG_OVERFULL ((NTSTATUS)0xC0000809L) + +// +// MessageId: STATUS_CORRUPT_LOG_CORRUPTED +// +// MessageText: +// +// One of the volume corruption logs is internally corrupted and needs to be recreated. The volume may contain undetected corruptions and must be scanned. +// +#define STATUS_CORRUPT_LOG_CORRUPTED ((NTSTATUS)0xC000080AL) + +// +// MessageId: STATUS_CORRUPT_LOG_UNAVAILABLE +// +// MessageText: +// +// One of the volume corruption logs is unavailable for being operated on. +// +#define STATUS_CORRUPT_LOG_UNAVAILABLE ((NTSTATUS)0xC000080BL) + +// +// MessageId: STATUS_CORRUPT_LOG_DELETED_FULL +// +// MessageText: +// +// One of the volume corruption logs was deleted while still having corruption records in them. The volume contains detected corruptions and must be scanned. +// +#define STATUS_CORRUPT_LOG_DELETED_FULL ((NTSTATUS)0xC000080CL) + +// +// MessageId: STATUS_CORRUPT_LOG_CLEARED +// +// MessageText: +// +// One of the volume corruption logs was cleared by chkdsk and no longer contains real corruptions. +// +#define STATUS_CORRUPT_LOG_CLEARED ((NTSTATUS)0xC000080DL) + +// +// MessageId: STATUS_ORPHAN_NAME_EXHAUSTED +// +// MessageText: +// +// Orphaned files exist on the volume but could not be recovered because no more new names could be created in the recovery directory. Files must be moved from the recovery directory. +// +#define STATUS_ORPHAN_NAME_EXHAUSTED ((NTSTATUS)0xC000080EL) + +// +// MessageId: STATUS_PROACTIVE_SCAN_IN_PROGRESS +// +// MessageText: +// +// The operation could not be completed because an instance of Proactive Scanner is currently running. +// +#define STATUS_PROACTIVE_SCAN_IN_PROGRESS ((NTSTATUS)0xC000080FL) + +// +// MessageId: STATUS_ENCRYPTED_IO_NOT_POSSIBLE +// +// MessageText: +// +// The read or write operation to an encrypted file could not be completed because the file has not been opened for data access. +// +#define STATUS_ENCRYPTED_IO_NOT_POSSIBLE ((NTSTATUS)0xC0000810L) + +// +// MessageId: STATUS_CORRUPT_LOG_UPLEVEL_RECORDS +// +// MessageText: +// +// One of the volume corruption logs comes from a newer version of Windows and contains corruption records. The log will be emptied and reset to the current version, and the volume health state will be updated accordingly. +// +#define STATUS_CORRUPT_LOG_UPLEVEL_RECORDS ((NTSTATUS)0xC0000811L) + +// +// MessageId: STATUS_FILE_CHECKED_OUT +// +// MessageText: +// +// This file is checked out or locked for editing by another user. +// +#define STATUS_FILE_CHECKED_OUT ((NTSTATUS)0xC0000901L) + +// +// MessageId: STATUS_CHECKOUT_REQUIRED +// +// MessageText: +// +// The file must be checked out before saving changes. +// +#define STATUS_CHECKOUT_REQUIRED ((NTSTATUS)0xC0000902L) + +// +// MessageId: STATUS_BAD_FILE_TYPE +// +// MessageText: +// +// The file type being saved or retrieved has been blocked. +// +#define STATUS_BAD_FILE_TYPE ((NTSTATUS)0xC0000903L) + +// +// MessageId: STATUS_FILE_TOO_LARGE +// +// MessageText: +// +// The file size exceeds the limit allowed and cannot be saved. +// +#define STATUS_FILE_TOO_LARGE ((NTSTATUS)0xC0000904L) + +// +// MessageId: STATUS_FORMS_AUTH_REQUIRED +// +// MessageText: +// +// Access Denied. Before opening files in this location, you must first browse to the web site and select the option to login automatically. +// +#define STATUS_FORMS_AUTH_REQUIRED ((NTSTATUS)0xC0000905L) + +// +// MessageId: STATUS_VIRUS_INFECTED +// +// MessageText: +// +// Operation did not complete successfully because the file contains a virus or potentially unwanted software. +// +#define STATUS_VIRUS_INFECTED ((NTSTATUS)0xC0000906L) + +// +// MessageId: STATUS_VIRUS_DELETED +// +// MessageText: +// +// This file contains a virus or potentially unwanted software and cannot be opened. Due to the nature of this virus or potentially unwanted software, the file has been removed from this location. +// +#define STATUS_VIRUS_DELETED ((NTSTATUS)0xC0000907L) + +// +// MessageId: STATUS_BAD_MCFG_TABLE +// +// MessageText: +// +// The resources required for this device conflict with the MCFG table. +// +#define STATUS_BAD_MCFG_TABLE ((NTSTATUS)0xC0000908L) + +// +// MessageId: STATUS_CANNOT_BREAK_OPLOCK +// +// MessageText: +// +// The operation did not complete successfully because it would cause an oplock to be broken. The caller has requested that existing oplocks not be broken. +// +#define STATUS_CANNOT_BREAK_OPLOCK ((NTSTATUS)0xC0000909L) + +// +// MessageId: STATUS_BAD_KEY +// +// MessageText: +// +// Bad key. +// +#define STATUS_BAD_KEY ((NTSTATUS)0xC000090AL) + +// +// MessageId: STATUS_BAD_DATA +// +// MessageText: +// +// Bad data. +// +#define STATUS_BAD_DATA ((NTSTATUS)0xC000090BL) + +// +// MessageId: STATUS_NO_KEY +// +// MessageText: +// +// Key does not exist. +// +#define STATUS_NO_KEY ((NTSTATUS)0xC000090CL) + +// +// MessageId: STATUS_FILE_HANDLE_REVOKED +// +// MessageText: +// +// Access to the specified file handle has been revoked. +// +#define STATUS_FILE_HANDLE_REVOKED ((NTSTATUS)0xC0000910L) + +// +// MessageId: STATUS_SECTION_DIRECT_MAP_ONLY +// +// MessageText: +// +// The specified section is supported by direct map technology but the caller specifically does not want that. +// +#define STATUS_SECTION_DIRECT_MAP_ONLY ((NTSTATUS)0xC0000911L) + +// +// MessageId: STATUS_BLOCK_WEAK_REFERENCE_INVALID +// +// MessageText: +// +// A file system block has been modified after containing a weak reference. +// +#define STATUS_BLOCK_WEAK_REFERENCE_INVALID ((NTSTATUS)0xC0000912L) + +// +// MessageId: STATUS_BLOCK_SOURCE_WEAK_REFERENCE_INVALID +// +// MessageText: +// +// The source file system block has been modified after containing a weak reference. +// +#define STATUS_BLOCK_SOURCE_WEAK_REFERENCE_INVALID ((NTSTATUS)0xC0000913L) + +// +// MessageId: STATUS_BLOCK_TARGET_WEAK_REFERENCE_INVALID +// +// MessageText: +// +// The target file system block has been modified after containing a weak reference. +// +#define STATUS_BLOCK_TARGET_WEAK_REFERENCE_INVALID ((NTSTATUS)0xC0000914L) + +// +// MessageId: STATUS_BLOCK_SHARED +// +// MessageText: +// +// The target file system block is shared between multiple extents. +// +#define STATUS_BLOCK_SHARED ((NTSTATUS)0xC0000915L) + +// +// MessageId: STATUS_SYSTEM_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The specified operation is not supported on a system file. +// +#define STATUS_SYSTEM_FILE_NOT_SUPPORTED ((NTSTATUS)0xC0000916L) + +/*++ + + MessageId's 0xc08 - 0xc7f (inclusive) are reserved for Verifier errors. + +--*/ +// +// MessageId: STATUS_VRF_VOLATILE_CFG_AND_IO_ENABLED +// +// MessageText: +// +// Enabling driver verification from volatile command is currently not supported when both CFG and IO are enabled. +// +#define STATUS_VRF_VOLATILE_CFG_AND_IO_ENABLED ((NTSTATUS)0xC0000C08L) + +// +// MessageId: STATUS_VRF_VOLATILE_NOT_STOPPABLE +// +// MessageText: +// +// Removal of current driver verification is not supported from volatile command. +// +#define STATUS_VRF_VOLATILE_NOT_STOPPABLE ((NTSTATUS)0xC0000C09L) + +// +// MessageId: STATUS_VRF_VOLATILE_SAFE_MODE +// +// MessageText: +// +// Enabling driver verification is not supported in safe mode. +// +#define STATUS_VRF_VOLATILE_SAFE_MODE ((NTSTATUS)0xC0000C0AL) + +// +// MessageId: STATUS_VRF_VOLATILE_NOT_RUNNABLE_SYSTEM +// +// MessageText: +// +// Enabling driver verification is not supported from volatile mode in current system. +// +#define STATUS_VRF_VOLATILE_NOT_RUNNABLE_SYSTEM ((NTSTATUS)0xC0000C0BL) + +// +// MessageId: STATUS_VRF_VOLATILE_NOT_SUPPORTED_RULECLASS +// +// MessageText: +// +// The specified rule class (a.k.a. flag) is not supported from volatile mode. +// +#define STATUS_VRF_VOLATILE_NOT_SUPPORTED_RULECLASS ((NTSTATUS)0xC0000C0CL) + +// +// MessageId: STATUS_VRF_VOLATILE_PROTECTED_DRIVER +// +// MessageText: +// +// The specified driver is protected and volatile verification is currently not supported. +// +#define STATUS_VRF_VOLATILE_PROTECTED_DRIVER ((NTSTATUS)0xC0000C0DL) + +// +// MessageId: STATUS_VRF_VOLATILE_NMI_REGISTERED +// +// MessageText: +// +// Enabling driver verification is not supported for a driver with NMI callback(s) registered. +// +#define STATUS_VRF_VOLATILE_NMI_REGISTERED ((NTSTATUS)0xC0000C0EL) + +// +// MessageId: STATUS_VRF_VOLATILE_SETTINGS_CONFLICT +// +// MessageText: +// +// Volatile verification settings cannot be changed when verification is enabled from boot or DIF volatile verification is enabled. +// +#define STATUS_VRF_VOLATILE_SETTINGS_CONFLICT ((NTSTATUS)0xC0000C0FL) + +// +// MessageId: STATUS_CAR_LKD_IN_PROGRESS +// +// MessageText: +// +// Live memory dump generation is in progress. +// +#define STATUS_CAR_LKD_IN_PROGRESS ((NTSTATUS)0xC0000C10L) + +// +// MessageId: STATUS_DIF_ZERO_SIZE_INFORMATION +// +// MessageText: +// +// There is no captured information. +// +#define STATUS_DIF_ZERO_SIZE_INFORMATION ((NTSTATUS)0xC0000C73L) + +// +// MessageId: STATUS_DIF_DRIVER_PLUGIN_MISMATCH +// +// MessageText: +// +// The given rule class ID is not registered by the caller. +// +#define STATUS_DIF_DRIVER_PLUGIN_MISMATCH ((NTSTATUS)0xC0000C74L) + +// +// MessageId: STATUS_DIF_DRIVER_THUNKS_NOT_ALLOWED +// +// MessageText: +// +// Driver thunks are not added when kernel verification is in effect. +// +#define STATUS_DIF_DRIVER_THUNKS_NOT_ALLOWED ((NTSTATUS)0xC0000C75L) + +// +// MessageId: STATUS_DIF_IOCALLBACK_NOT_REPLACED +// +// MessageText: +// +// The specified driver is not associated with driver object or driver extension. +// +#define STATUS_DIF_IOCALLBACK_NOT_REPLACED ((NTSTATUS)0xC0000C76L) + +// +// MessageId: STATUS_DIF_LIVEDUMP_LIMIT_EXCEEDED +// +// MessageText: +// +// Verifier's internal data size exceeds the limit of live dump secondary data. +// +#define STATUS_DIF_LIVEDUMP_LIMIT_EXCEEDED ((NTSTATUS)0xC0000C77L) + +// +// MessageId: STATUS_DIF_VOLATILE_SECTION_NOT_LOCKED +// +// MessageText: +// +// Verification cannot start because an attempt to lock code or data section failed. +// +#define STATUS_DIF_VOLATILE_SECTION_NOT_LOCKED ((NTSTATUS)0xC0000C78L) + +// +// MessageId: STATUS_DIF_VOLATILE_DRIVER_HOTPATCHED +// +// MessageText: +// +// DIF volatile verification is not supported for hotpatched driver. +// +#define STATUS_DIF_VOLATILE_DRIVER_HOTPATCHED ((NTSTATUS)0xC0000C79L) + +// +// MessageId: STATUS_DIF_VOLATILE_INVALID_INFO +// +// MessageText: +// +// The passed system DIF information is invalid. +// +#define STATUS_DIF_VOLATILE_INVALID_INFO ((NTSTATUS)0xC0000C7AL) + +// +// MessageId: STATUS_DIF_VOLATILE_DRIVER_IS_NOT_RUNNING +// +// MessageText: +// +// DIF volatile only supports on loaded drivers. +// +#define STATUS_DIF_VOLATILE_DRIVER_IS_NOT_RUNNING ((NTSTATUS)0xC0000C7BL) + +// +// MessageId: STATUS_DIF_VOLATILE_PLUGIN_IS_NOT_RUNNING +// +// MessageText: +// +// Currently no plugin is running. +// +#define STATUS_DIF_VOLATILE_PLUGIN_IS_NOT_RUNNING ((NTSTATUS)0xC0000C7CL) + +// +// MessageId: STATUS_DIF_VOLATILE_PLUGIN_CHANGE_NOT_ALLOWED +// +// MessageText: +// +// Currently running plugin must be removed before applying a new plugin. +// +#define STATUS_DIF_VOLATILE_PLUGIN_CHANGE_NOT_ALLOWED ((NTSTATUS)0xC0000C7DL) + +// +// MessageId: STATUS_DIF_VOLATILE_NOT_ALLOWED +// +// MessageText: +// +// The plugin is not allowed to run in volatile mode. +// +#define STATUS_DIF_VOLATILE_NOT_ALLOWED ((NTSTATUS)0xC0000C7EL) + +// +// MessageId: STATUS_DIF_BINDING_API_NOT_FOUND +// +// MessageText: +// +// One or more DDI is not yet supported by DIF. +// +#define STATUS_DIF_BINDING_API_NOT_FOUND ((NTSTATUS)0xC0000C7FL) + +// End of Verifier Errors +// +// MessageId: STATUS_WOW_ASSERTION +// +// MessageText: +// +// WOW Assertion Error. +// +#define STATUS_WOW_ASSERTION ((NTSTATUS)0xC0009898L) + +// +// MessageId: STATUS_INVALID_SIGNATURE +// +// MessageText: +// +// The cryptographic signature is invalid. +// +#define STATUS_INVALID_SIGNATURE ((NTSTATUS)0xC000A000L) + +// +// MessageId: STATUS_HMAC_NOT_SUPPORTED +// +// MessageText: +// +// The cryptographic provider does not support HMAC. +// +#define STATUS_HMAC_NOT_SUPPORTED ((NTSTATUS)0xC000A001L) + +// +// MessageId: STATUS_AUTH_TAG_MISMATCH +// +// MessageText: +// +// The computed authentication tag did not match the input authentication tag. +// +#define STATUS_AUTH_TAG_MISMATCH ((NTSTATUS)0xC000A002L) + +// +// MessageId: STATUS_INVALID_STATE_TRANSITION +// +// MessageText: +// +// The requested state transition is invalid and cannot be performed. +// +#define STATUS_INVALID_STATE_TRANSITION ((NTSTATUS)0xC000A003L) + +// +// MessageId: STATUS_INVALID_KERNEL_INFO_VERSION +// +// MessageText: +// +// The supplied kernel information version is invalid. +// +#define STATUS_INVALID_KERNEL_INFO_VERSION ((NTSTATUS)0xC000A004L) + +// +// MessageId: STATUS_INVALID_PEP_INFO_VERSION +// +// MessageText: +// +// The supplied PEP information version is invalid. +// +#define STATUS_INVALID_PEP_INFO_VERSION ((NTSTATUS)0xC000A005L) + +// +// MessageId: STATUS_HANDLE_REVOKED +// +// MessageText: +// +// Access to the specified handle has been revoked. +// +#define STATUS_HANDLE_REVOKED ((NTSTATUS)0xC000A006L) + +// +// MessageId: STATUS_EOF_ON_GHOSTED_RANGE +// +// MessageText: +// +// The file operation will result in the end of file being on a ghosted range. +// +#define STATUS_EOF_ON_GHOSTED_RANGE ((NTSTATUS)0xC000A007L) + +// +// MessageId: STATUS_CC_NEEDS_CALLBACK_SECTION_DRAIN +// +// MessageText: +// +// Filesystem needs to release all the file resources and callback into Cc to drain pending section deletions, before retrying the operation. +// +#define STATUS_CC_NEEDS_CALLBACK_SECTION_DRAIN ((NTSTATUS)0xC000A008L) + +/*++ + + MessageId's 0xa010 - 0xa07f (inclusive) are reserved for TCPIP errors. + +--*/ +// +// MessageId: STATUS_IPSEC_QUEUE_OVERFLOW +// +// MessageText: +// +// The IPSEC queue overflowed. +// +#define STATUS_IPSEC_QUEUE_OVERFLOW ((NTSTATUS)0xC000A010L) + +// +// MessageId: STATUS_ND_QUEUE_OVERFLOW +// +// MessageText: +// +// The neighbor discovery queue overflowed. +// +#define STATUS_ND_QUEUE_OVERFLOW ((NTSTATUS)0xC000A011L) + +// +// MessageId: STATUS_HOPLIMIT_EXCEEDED +// +// MessageText: +// +// An ICMP hop limit exceeded error was received. +// +#define STATUS_HOPLIMIT_EXCEEDED ((NTSTATUS)0xC000A012L) + +// +// MessageId: STATUS_PROTOCOL_NOT_SUPPORTED +// +// MessageText: +// +// The protocol is not installed on the local machine. +// +#define STATUS_PROTOCOL_NOT_SUPPORTED ((NTSTATUS)0xC000A013L) + +// +// MessageId: STATUS_FASTPATH_REJECTED +// +// MessageText: +// +// An operation or data has been rejected while on the network fast path. +// +#define STATUS_FASTPATH_REJECTED ((NTSTATUS)0xC000A014L) + +/*++ + + MessageId's 0xa014 - 0xa07f (inclusive) are reserved for TCPIP errors. + +--*/ +// +// MessageId: STATUS_LOST_WRITEBEHIND_DATA_NETWORK_DISCONNECTED +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %hs; the data has been lost. +// This error may be caused by network connectivity issues. Please try to save this file elsewhere. +// +#define STATUS_LOST_WRITEBEHIND_DATA_NETWORK_DISCONNECTED ((NTSTATUS)0xC000A080L) + +// +// MessageId: STATUS_LOST_WRITEBEHIND_DATA_NETWORK_SERVER_ERROR +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %hs; the data has been lost. +// This error was returned by the server on which the file exists. Please try to save this file elsewhere. +// +#define STATUS_LOST_WRITEBEHIND_DATA_NETWORK_SERVER_ERROR ((NTSTATUS)0xC000A081L) + +// +// MessageId: STATUS_LOST_WRITEBEHIND_DATA_LOCAL_DISK_ERROR +// +// MessageText: +// +// {Delayed Write Failed} +// Windows was unable to save all the data for the file %hs; the data has been lost. +// This error may be caused if the device has been removed or the media is write-protected. +// +#define STATUS_LOST_WRITEBEHIND_DATA_LOCAL_DISK_ERROR ((NTSTATUS)0xC000A082L) + +// +// MessageId: STATUS_XML_PARSE_ERROR +// +// MessageText: +// +// Windows was unable to parse the requested XML data. +// +#define STATUS_XML_PARSE_ERROR ((NTSTATUS)0xC000A083L) + +// +// MessageId: STATUS_XMLDSIG_ERROR +// +// MessageText: +// +// An error was encountered while processing an XML digital signature. +// +#define STATUS_XMLDSIG_ERROR ((NTSTATUS)0xC000A084L) + +// +// MessageId: STATUS_WRONG_COMPARTMENT +// +// MessageText: +// +// Indicates that the caller made the connection request in the wrong routing compartment. +// +#define STATUS_WRONG_COMPARTMENT ((NTSTATUS)0xC000A085L) + +// +// MessageId: STATUS_AUTHIP_FAILURE +// +// MessageText: +// +// Indicates that there was an AuthIP failure when attempting to connect to the remote host. +// +#define STATUS_AUTHIP_FAILURE ((NTSTATUS)0xC000A086L) + +// +// MessageId: STATUS_DS_OID_MAPPED_GROUP_CANT_HAVE_MEMBERS +// +// MessageText: +// +// OID mapped groups cannot have members. +// +#define STATUS_DS_OID_MAPPED_GROUP_CANT_HAVE_MEMBERS ((NTSTATUS)0xC000A087L) + +// +// MessageId: STATUS_DS_OID_NOT_FOUND +// +// MessageText: +// +// The specified OID cannot be found. +// +#define STATUS_DS_OID_NOT_FOUND ((NTSTATUS)0xC000A088L) + +// +// MessageId: STATUS_INCORRECT_ACCOUNT_TYPE +// +// MessageText: +// +// The system is not authoritative for the specified account and therefore cannot complete the operation. Please retry the operation using the provider associated with this account. If this is an online provider please use the provider's online site. +// +#define STATUS_INCORRECT_ACCOUNT_TYPE ((NTSTATUS)0xC000A089L) + +// +// MessageId: STATUS_LOCAL_POLICY_MODIFICATION_NOT_SUPPORTED +// +// MessageText: +// +// The local account policy modification request was rejected because the policy is controlled by a regional authority. +// +#define STATUS_LOCAL_POLICY_MODIFICATION_NOT_SUPPORTED ((NTSTATUS)0xC000A08AL) + +// +// MessageId: STATUS_POLICY_CONTROLLED_ACCOUNT +// +// MessageText: +// +// The account is controlled by external policy and cannot be modified. +// +#define STATUS_POLICY_CONTROLLED_ACCOUNT ((NTSTATUS)0xC000A08BL) + +// +// MessageId: STATUS_LAPS_LEGACY_SCHEMA_MISSING +// +// MessageText: +// +// The Local Administrator Password Solution password update operation failed because the legacy LAPS schema needs to be added to Active Directory. +// +#define STATUS_LAPS_LEGACY_SCHEMA_MISSING ((NTSTATUS)0xC000A08CL) + +// +// MessageId: STATUS_LAPS_SCHEMA_MISSING +// +// MessageText: +// +// The Local Administrator Password Solution password update operation failed because the Windows LAPS schema needs to be added to Active Directory. +// +#define STATUS_LAPS_SCHEMA_MISSING ((NTSTATUS)0xC000A08DL) + +// +// MessageId: STATUS_LAPS_ENCRYPTION_REQUIRES_2016_DFL +// +// MessageText: +// +// The Local Administrator Password Solution encrypted password update operation failed because Active Directory is not yet running at the minimum required domain functional level (2016). +// +#define STATUS_LAPS_ENCRYPTION_REQUIRES_2016_DFL ((NTSTATUS)0xC000A08EL) + +// +// MessageId: STATUS_LAPS_PROCESS_TERMINATED +// +// MessageText: +// +// The process was terminated by Windows Local Administrator Password Solution per the configured post-authentication-action policy. +// +#define STATUS_LAPS_PROCESS_TERMINATED ((NTSTATUS)0x8000A08FL) + +// +// MessageId: STATUS_DS_JET_RECORD_TOO_BIG +// +// MessageText: +// +// The Active Directory JET database page size limit for this request was exceeded. +// +#define STATUS_DS_JET_RECORD_TOO_BIG ((NTSTATUS)0xC000A090L) + +// +// MessageId: STATUS_DS_REPLICA_PAGE_SIZE_MISMATCH +// +// MessageText: +// +// The Active Directory JET database page size does not match on all Domain Controllers in this forest. +// +#define STATUS_DS_REPLICA_PAGE_SIZE_MISMATCH ((NTSTATUS)0xC000A091L) + +/*++ + + MessageId's 0xa100 - 0xa120 (inclusive) are for the SMB Hash Generation Service. + +--*/ +// +// MessageId: STATUS_HASH_NOT_SUPPORTED +// +// MessageText: +// +// Hash generation for the specified version and hash type is not enabled on server. +// +#define STATUS_HASH_NOT_SUPPORTED ((NTSTATUS)0xC000A100L) + +// +// MessageId: STATUS_HASH_NOT_PRESENT +// +// MessageText: +// +// The hash requests is not present or not up to date with the current file contents. +// +#define STATUS_HASH_NOT_PRESENT ((NTSTATUS)0xC000A101L) + +/*++ + + MessageId's 0xa121 - 0xa140 (inclusive) are for GPIO (General Purpose I/O) controller related errors. + +--*/ +// +// MessageId: STATUS_SECONDARY_IC_PROVIDER_NOT_REGISTERED +// +// MessageText: +// +// The secondary interrupt controller instance that manages the specified interrupt is not registered. +// +#define STATUS_SECONDARY_IC_PROVIDER_NOT_REGISTERED ((NTSTATUS)0xC000A121L) + +// +// MessageId: STATUS_GPIO_CLIENT_INFORMATION_INVALID +// +// MessageText: +// +// The information supplied by the GPIO client driver is invalid. +// +#define STATUS_GPIO_CLIENT_INFORMATION_INVALID ((NTSTATUS)0xC000A122L) + +// +// MessageId: STATUS_GPIO_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The version specified by the GPIO client driver is not supported. +// +#define STATUS_GPIO_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC000A123L) + +// +// MessageId: STATUS_GPIO_INVALID_REGISTRATION_PACKET +// +// MessageText: +// +// The registration packet supplied by the GPIO client driver is not valid. +// +#define STATUS_GPIO_INVALID_REGISTRATION_PACKET ((NTSTATUS)0xC000A124L) + +// +// MessageId: STATUS_GPIO_OPERATION_DENIED +// +// MessageText: +// +// The requested operation is not supported for the specified handle. +// +#define STATUS_GPIO_OPERATION_DENIED ((NTSTATUS)0xC000A125L) + +// +// MessageId: STATUS_GPIO_INCOMPATIBLE_CONNECT_MODE +// +// MessageText: +// +// The requested connect mode conflicts with an existing mode on one or more of the specified pins. +// +#define STATUS_GPIO_INCOMPATIBLE_CONNECT_MODE ((NTSTATUS)0xC000A126L) + +// +// MessageId: STATUS_GPIO_INTERRUPT_ALREADY_UNMASKED +// +// MessageText: +// +// The interrupt requested to be unmasked is not masked. +// +#define STATUS_GPIO_INTERRUPT_ALREADY_UNMASKED ((NTSTATUS)0x8000A127L) + +/*++ + + MessageId's 0xa141 - 0xa160 (inclusive) are for run levels support. + +--*/ +// +// MessageId: STATUS_CANNOT_SWITCH_RUNLEVEL +// +// MessageText: +// +// The requested run level switch cannot be completed successfully since +// one or more services refused to stop or restart. +// +#define STATUS_CANNOT_SWITCH_RUNLEVEL ((NTSTATUS)0xC000A141L) + +// +// MessageId: STATUS_INVALID_RUNLEVEL_SETTING +// +// MessageText: +// +// The service has an invalid run level setting. The run level for a service +// must not be higher than the run level of its dependent services. +// +#define STATUS_INVALID_RUNLEVEL_SETTING ((NTSTATUS)0xC000A142L) + +// +// MessageId: STATUS_RUNLEVEL_SWITCH_TIMEOUT +// +// MessageText: +// +// The requested run level switch cannot be completed successfully since +// one or more services will not stop or restart within the specified timeout. +// +#define STATUS_RUNLEVEL_SWITCH_TIMEOUT ((NTSTATUS)0xC000A143L) + +// +// MessageId: STATUS_SERVICES_FAILED_AUTOSTART +// +// MessageText: +// +// One or more services failed to start during the service startup phase of a run level switch. +// +#define STATUS_SERVICES_FAILED_AUTOSTART ((NTSTATUS)0x4000A144L) + +// +// MessageId: STATUS_RUNLEVEL_SWITCH_AGENT_TIMEOUT +// +// MessageText: +// +// A run level switch agent did not respond within the specified timeout. +// +#define STATUS_RUNLEVEL_SWITCH_AGENT_TIMEOUT ((NTSTATUS)0xC000A145L) + +// +// MessageId: STATUS_RUNLEVEL_SWITCH_IN_PROGRESS +// +// MessageText: +// +// A run level switch is currently in progress. +// +#define STATUS_RUNLEVEL_SWITCH_IN_PROGRESS ((NTSTATUS)0xC000A146L) + +/*++ + + MessageId's 0xa161 - 0xa180 (inclusive) are for API Set support. + +--*/ +// +// MessageId: STATUS_APISET_COMPOSE_FAILURE +// +// MessageText: +// +// An API Set schema extension failed to compose. +// +#define STATUS_APISET_COMPOSE_FAILURE ((NTSTATUS)0xC000A161L) + +// +// MessageId: STATUS_APISET_SCHEMA_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The API Set schema version is not supported. +// +#define STATUS_APISET_SCHEMA_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC000A162L) + +/*++ + + MessageId's 0xa200 - 0xa280 (inclusive) are reserved for app container specific messages. + +--*/ +// +// MessageId: STATUS_NOT_APPCONTAINER +// +// MessageText: +// +// This operation is only valid in the context of an app container. +// +#define STATUS_NOT_APPCONTAINER ((NTSTATUS)0xC000A200L) + +// +// MessageId: STATUS_NOT_SUPPORTED_IN_APPCONTAINER +// +// MessageText: +// +// This functionality is not supported in the context of an app container. +// +#define STATUS_NOT_SUPPORTED_IN_APPCONTAINER ((NTSTATUS)0xC000A201L) + +// +// MessageId: STATUS_INVALID_PACKAGE_SID_LENGTH +// +// MessageText: +// +// The length of the SID supplied is not a valid length for app container SIDs. +// +#define STATUS_INVALID_PACKAGE_SID_LENGTH ((NTSTATUS)0xC000A202L) + +// +// MessageId: STATUS_LPAC_ACCESS_DENIED +// +// MessageText: +// +// Access to the specified resource has been denied for a less privileged app container. +// +#define STATUS_LPAC_ACCESS_DENIED ((NTSTATUS)0xC000A203L) + +// +// MessageId: STATUS_ADMINLESS_ACCESS_DENIED +// +// MessageText: +// +// Access to the specified resource has been denied for an adminless system. +// +#define STATUS_ADMINLESS_ACCESS_DENIED ((NTSTATUS)0xC000A204L) + +/*++ + + MessageId's 0xa281 - 0xa2a0 (inclusive) are reserved for Fast Cache specific messages. + +--*/ +// +// MessageId: STATUS_APP_DATA_NOT_FOUND +// +// MessageText: +// +// Fast Cache data not found. +// +#define STATUS_APP_DATA_NOT_FOUND ((NTSTATUS)0xC000A281L) + +// +// MessageId: STATUS_APP_DATA_EXPIRED +// +// MessageText: +// +// Fast Cache data expired. +// +#define STATUS_APP_DATA_EXPIRED ((NTSTATUS)0xC000A282L) + +// +// MessageId: STATUS_APP_DATA_CORRUPT +// +// MessageText: +// +// Fast Cache data corrupt. +// +#define STATUS_APP_DATA_CORRUPT ((NTSTATUS)0xC000A283L) + +// +// MessageId: STATUS_APP_DATA_LIMIT_EXCEEDED +// +// MessageText: +// +// Fast Cache data has exceeded its max size and cannot be updated. +// +#define STATUS_APP_DATA_LIMIT_EXCEEDED ((NTSTATUS)0xC000A284L) + +// +// MessageId: STATUS_APP_DATA_REBOOT_REQUIRED +// +// MessageText: +// +// Fast Cache has been ReArmed and requires a reboot until it can be updated. +// +#define STATUS_APP_DATA_REBOOT_REQUIRED ((NTSTATUS)0xC000A285L) + +/*++ + + MessageId's 0xa2a1 - 0xa2dc (inclusive) are for File System specific messages. + +--*/ +// +// MessageId: STATUS_OFFLOAD_READ_FLT_NOT_SUPPORTED +// +// MessageText: +// +// The copy offload read operation is not supported by a filter. +// +#define STATUS_OFFLOAD_READ_FLT_NOT_SUPPORTED ((NTSTATUS)0xC000A2A1L) + +// +// MessageId: STATUS_OFFLOAD_WRITE_FLT_NOT_SUPPORTED +// +// MessageText: +// +// The copy offload write operation is not supported by a filter. +// +#define STATUS_OFFLOAD_WRITE_FLT_NOT_SUPPORTED ((NTSTATUS)0xC000A2A2L) + +// +// MessageId: STATUS_OFFLOAD_READ_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The copy offload read operation is not supported for the file. +// +#define STATUS_OFFLOAD_READ_FILE_NOT_SUPPORTED ((NTSTATUS)0xC000A2A3L) + +// +// MessageId: STATUS_OFFLOAD_WRITE_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The copy offload write operation is not supported for the file. +// +#define STATUS_OFFLOAD_WRITE_FILE_NOT_SUPPORTED ((NTSTATUS)0xC000A2A4L) + +// +// MessageId: STATUS_WOF_WIM_HEADER_CORRUPT +// +// MessageText: +// +// The WOF driver encountered a corruption in WIM image's Header. +// +#define STATUS_WOF_WIM_HEADER_CORRUPT ((NTSTATUS)0xC000A2A5L) + +// +// MessageId: STATUS_WOF_WIM_RESOURCE_TABLE_CORRUPT +// +// MessageText: +// +// The WOF driver encountered a corruption in WIM image's Resource Table. +// +#define STATUS_WOF_WIM_RESOURCE_TABLE_CORRUPT ((NTSTATUS)0xC000A2A6L) + +// +// MessageId: STATUS_WOF_FILE_RESOURCE_TABLE_CORRUPT +// +// MessageText: +// +// The WOF driver encountered a corruption in the compressed file's Resource Table. +// +#define STATUS_WOF_FILE_RESOURCE_TABLE_CORRUPT ((NTSTATUS)0xC000A2A7L) + +/*++ + + MessageId's 0xc000 - 0xc0ff (inclusive) are for CimFS specific messages. + +--*/ +// +// MessageId: STATUS_CIMFS_IMAGE_CORRUPT +// +// MessageText: +// +// The CimFS image is corrupted. +// +#define STATUS_CIMFS_IMAGE_CORRUPT ((NTSTATUS)0xC000C001L) + +// +// MessageId: STATUS_CIMFS_IMAGE_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The system does not support this version of the CimFS image. +// +#define STATUS_CIMFS_IMAGE_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC000C002L) + +/*++ + + End of CimFS specific messages. + +--*/ +/*++ + + MessageId's 0xce00 - 0xceff (inclusive) are for File System virtualization specific messages. + +--*/ +// +// MessageId: STATUS_FILE_SYSTEM_VIRTUALIZATION_UNAVAILABLE +// +// MessageText: +// +// The provider that supports file system virtualization is temporarily unavailable. +// +#define STATUS_FILE_SYSTEM_VIRTUALIZATION_UNAVAILABLE ((NTSTATUS)0xC000CE01L) + +// +// MessageId: STATUS_FILE_SYSTEM_VIRTUALIZATION_METADATA_CORRUPT +// +// MessageText: +// +// The metadata for file system virtualization is corrupt and unreadable. +// +#define STATUS_FILE_SYSTEM_VIRTUALIZATION_METADATA_CORRUPT ((NTSTATUS)0xC000CE02L) + +// +// MessageId: STATUS_FILE_SYSTEM_VIRTUALIZATION_BUSY +// +// MessageText: +// +// The provider that supports file system virtualization is too busy to complete this operation. +// +#define STATUS_FILE_SYSTEM_VIRTUALIZATION_BUSY ((NTSTATUS)0xC000CE03L) + +// +// MessageId: STATUS_FILE_SYSTEM_VIRTUALIZATION_PROVIDER_UNKNOWN +// +// MessageText: +// +// The provider that supports file system virtualization is unknown. +// +#define STATUS_FILE_SYSTEM_VIRTUALIZATION_PROVIDER_UNKNOWN ((NTSTATUS)0xC000CE04L) + +// +// MessageId: STATUS_FILE_SYSTEM_VIRTUALIZATION_INVALID_OPERATION +// +// MessageText: +// +// The virtualization operation is not allowed on the file in its current state. +// +#define STATUS_FILE_SYSTEM_VIRTUALIZATION_INVALID_OPERATION ((NTSTATUS)0xC000CE05L) + +/*++ + + MessageId's 0xcf00 - 0xcfff (inclusive) are for Cloud Files specific messages. + +--*/ +// +// MessageId: STATUS_CLOUD_FILE_SYNC_ROOT_METADATA_CORRUPT +// +// MessageText: +// +// The cloud sync root metadata is corrupted. +// +#define STATUS_CLOUD_FILE_SYNC_ROOT_METADATA_CORRUPT ((NTSTATUS)0xC000CF00L) + +// +// MessageId: STATUS_CLOUD_FILE_PROVIDER_NOT_RUNNING +// +// MessageText: +// +// The cloud file provider is not running. +// +#define STATUS_CLOUD_FILE_PROVIDER_NOT_RUNNING ((NTSTATUS)0xC000CF01L) + +// +// MessageId: STATUS_CLOUD_FILE_METADATA_CORRUPT +// +// MessageText: +// +// The cloud file metadata is corrupt and unreadable. +// +#define STATUS_CLOUD_FILE_METADATA_CORRUPT ((NTSTATUS)0xC000CF02L) + +// +// MessageId: STATUS_CLOUD_FILE_METADATA_TOO_LARGE +// +// MessageText: +// +// The cloud file metadata is too large. +// +#define STATUS_CLOUD_FILE_METADATA_TOO_LARGE ((NTSTATUS)0xC000CF03L) + +// +// MessageId: STATUS_CLOUD_FILE_PROPERTY_BLOB_TOO_LARGE +// +// MessageText: +// +// The cloud file property is too large. +// +#define STATUS_CLOUD_FILE_PROPERTY_BLOB_TOO_LARGE ((NTSTATUS)0x8000CF04L) + +// +// MessageId: STATUS_CLOUD_FILE_TOO_MANY_PROPERTY_BLOBS +// +// MessageText: +// +// The maximum number of cloud file properties has been reached. +// +#define STATUS_CLOUD_FILE_TOO_MANY_PROPERTY_BLOBS ((NTSTATUS)0x8000CF05L) + +// +// MessageId: STATUS_CLOUD_FILE_PROPERTY_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The version of the cloud file property store is not supported. +// +#define STATUS_CLOUD_FILE_PROPERTY_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC000CF06L) + +// +// MessageId: STATUS_NOT_A_CLOUD_FILE +// +// MessageText: +// +// The file is not a cloud file. +// +#define STATUS_NOT_A_CLOUD_FILE ((NTSTATUS)0xC000CF07L) + +// +// MessageId: STATUS_CLOUD_FILE_NOT_IN_SYNC +// +// MessageText: +// +// The file is not in sync with the cloud. +// +#define STATUS_CLOUD_FILE_NOT_IN_SYNC ((NTSTATUS)0xC000CF08L) + +// +// MessageId: STATUS_CLOUD_FILE_ALREADY_CONNECTED +// +// MessageText: +// +// The cloud sync root is already connected with another cloud sync provider. +// +#define STATUS_CLOUD_FILE_ALREADY_CONNECTED ((NTSTATUS)0xC000CF09L) + +// +// MessageId: STATUS_CLOUD_FILE_NOT_SUPPORTED +// +// MessageText: +// +// The operation is not supported by the cloud sync provider. +// +#define STATUS_CLOUD_FILE_NOT_SUPPORTED ((NTSTATUS)0xC000CF0AL) + +// +// MessageId: STATUS_CLOUD_FILE_INVALID_REQUEST +// +// MessageText: +// +// The cloud operation is invalid. +// +#define STATUS_CLOUD_FILE_INVALID_REQUEST ((NTSTATUS)0xC000CF0BL) + +// +// MessageId: STATUS_CLOUD_FILE_READ_ONLY_VOLUME +// +// MessageText: +// +// The cloud operation is not supported on a read-only volume. +// +#define STATUS_CLOUD_FILE_READ_ONLY_VOLUME ((NTSTATUS)0xC000CF0CL) + +// +// MessageId: STATUS_CLOUD_FILE_CONNECTED_PROVIDER_ONLY +// +// MessageText: +// +// The operation is reserved for a connected cloud sync provider. +// +#define STATUS_CLOUD_FILE_CONNECTED_PROVIDER_ONLY ((NTSTATUS)0xC000CF0DL) + +// +// MessageId: STATUS_CLOUD_FILE_VALIDATION_FAILED +// +// MessageText: +// +// The cloud sync provider failed to validate the downloaded data. +// +#define STATUS_CLOUD_FILE_VALIDATION_FAILED ((NTSTATUS)0xC000CF0EL) + +// +// MessageId: STATUS_CLOUD_FILE_AUTHENTICATION_FAILED +// +// MessageText: +// +// The cloud sync provider failed user authentication. +// +#define STATUS_CLOUD_FILE_AUTHENTICATION_FAILED ((NTSTATUS)0xC000CF0FL) + +// +// MessageId: STATUS_CLOUD_FILE_INSUFFICIENT_RESOURCES +// +// MessageText: +// +// The cloud sync provider failed to perform the operation due to low system resources. +// +#define STATUS_CLOUD_FILE_INSUFFICIENT_RESOURCES ((NTSTATUS)0xC000CF10L) + +// +// MessageId: STATUS_CLOUD_FILE_NETWORK_UNAVAILABLE +// +// MessageText: +// +// The cloud sync provider failed to perform the operation due to network being unavailable. +// +#define STATUS_CLOUD_FILE_NETWORK_UNAVAILABLE ((NTSTATUS)0xC000CF11L) + +// +// MessageId: STATUS_CLOUD_FILE_UNSUCCESSFUL +// +// MessageText: +// +// The cloud operation was unsuccessful. +// +#define STATUS_CLOUD_FILE_UNSUCCESSFUL ((NTSTATUS)0xC000CF12L) + +// +// MessageId: STATUS_CLOUD_FILE_NOT_UNDER_SYNC_ROOT +// +// MessageText: +// +// The operation is only supported on files under a cloud sync root. +// +#define STATUS_CLOUD_FILE_NOT_UNDER_SYNC_ROOT ((NTSTATUS)0xC000CF13L) + +// +// MessageId: STATUS_CLOUD_FILE_IN_USE +// +// MessageText: +// +// The operation cannot be performed on cloud files in use. +// +#define STATUS_CLOUD_FILE_IN_USE ((NTSTATUS)0xC000CF14L) + +// +// MessageId: STATUS_CLOUD_FILE_PINNED +// +// MessageText: +// +// The operation cannot be performed on pinned cloud files. +// +#define STATUS_CLOUD_FILE_PINNED ((NTSTATUS)0xC000CF15L) + +// +// MessageId: STATUS_CLOUD_FILE_REQUEST_ABORTED +// +// MessageText: +// +// The cloud operation was aborted. +// +#define STATUS_CLOUD_FILE_REQUEST_ABORTED ((NTSTATUS)0xC000CF16L) + +// +// MessageId: STATUS_CLOUD_FILE_PROPERTY_CORRUPT +// +// MessageText: +// +// The cloud file's property store is corrupt. +// +#define STATUS_CLOUD_FILE_PROPERTY_CORRUPT ((NTSTATUS)0xC000CF17L) + +// +// MessageId: STATUS_CLOUD_FILE_ACCESS_DENIED +// +// MessageText: +// +// Access to the cloud file is denied. +// +#define STATUS_CLOUD_FILE_ACCESS_DENIED ((NTSTATUS)0xC000CF18L) + +// +// MessageId: STATUS_CLOUD_FILE_INCOMPATIBLE_HARDLINKS +// +// MessageText: +// +// The cloud operation cannot be performed on a file with incompatible hardlinks. +// +#define STATUS_CLOUD_FILE_INCOMPATIBLE_HARDLINKS ((NTSTATUS)0xC000CF19L) + +// +// MessageId: STATUS_CLOUD_FILE_PROPERTY_LOCK_CONFLICT +// +// MessageText: +// +// The operation failed due to a conflicting cloud file property lock. +// +#define STATUS_CLOUD_FILE_PROPERTY_LOCK_CONFLICT ((NTSTATUS)0xC000CF1AL) + +// +// MessageId: STATUS_CLOUD_FILE_REQUEST_CANCELED +// +// MessageText: +// +// The cloud operation was canceled by user. +// +#define STATUS_CLOUD_FILE_REQUEST_CANCELED ((NTSTATUS)0xC000CF1BL) + +// +// MessageId: STATUS_CLOUD_FILE_PROVIDER_TERMINATED +// +// MessageText: +// +// The cloud file provider exited unexpectedly. +// +#define STATUS_CLOUD_FILE_PROVIDER_TERMINATED ((NTSTATUS)0xC000CF1DL) + +// +// MessageId: STATUS_NOT_A_CLOUD_SYNC_ROOT +// +// MessageText: +// +// The file is not a cloud sync root. +// +#define STATUS_NOT_A_CLOUD_SYNC_ROOT ((NTSTATUS)0xC000CF1EL) + +// +// MessageId: STATUS_CLOUD_FILE_REQUEST_TIMEOUT +// +// MessageText: +// +// The cloud operation was not completed before the time-out period expired. +// +#define STATUS_CLOUD_FILE_REQUEST_TIMEOUT ((NTSTATUS)0xC000CF1FL) + +// +// MessageId: STATUS_CLOUD_FILE_DEHYDRATION_DISALLOWED +// +// MessageText: +// +// Dehydration of the cloud file is disallowed by the cloud sync provider. +// +#define STATUS_CLOUD_FILE_DEHYDRATION_DISALLOWED ((NTSTATUS)0xC000CF20L) + +// +// MessageId: STATUS_CLOUD_FILE_US_MESSAGE_TIMEOUT +// +// MessageText: +// +// The cloud provider failed to acknowledge a message before the time-out expired. +// +#define STATUS_CLOUD_FILE_US_MESSAGE_TIMEOUT ((NTSTATUS)0xC000CF21L) + +// +// MessageId: STATUS_CLOUD_FILE_HYDRATION_NOT_AVAILABLE +// +// MessageText: +// +// Cloud file cannot be retrieved from your cloud provider. Try again after responding to your cloud provider's request for action. +// +#define STATUS_CLOUD_FILE_HYDRATION_NOT_AVAILABLE ((NTSTATUS)0xC000CF22L) + +/*++ + + End of Cloud Files specific messages. + +--*/ +/*++ + + MessageId's 0xf500 - 0xf5ff (inclusive) are for File Snap specific messages. + +--*/ +// +// MessageId: STATUS_FILE_SNAP_IN_PROGRESS +// +// MessageText: +// +// A file snapshot operation was attempted when one is already in progress. +// +#define STATUS_FILE_SNAP_IN_PROGRESS ((NTSTATUS)0xC000F500L) + +// +// MessageId: STATUS_FILE_SNAP_USER_SECTION_NOT_SUPPORTED +// +// MessageText: +// +// A snapshot of the file cannot be taken because a user-mapped section is present. +// +#define STATUS_FILE_SNAP_USER_SECTION_NOT_SUPPORTED ((NTSTATUS)0xC000F501L) + +// +// MessageId: STATUS_FILE_SNAP_MODIFY_NOT_SUPPORTED +// +// MessageText: +// +// The file snapshot operation was terminated because one of the files was modified in a way incompatible with a snapshot operation. Please try again. +// +#define STATUS_FILE_SNAP_MODIFY_NOT_SUPPORTED ((NTSTATUS)0xC000F502L) + +// +// MessageId: STATUS_FILE_SNAP_IO_NOT_COORDINATED +// +// MessageText: +// +// An I/O request could not be coordinated with a file snapshot operation. +// +#define STATUS_FILE_SNAP_IO_NOT_COORDINATED ((NTSTATUS)0xC000F503L) + +// +// MessageId: STATUS_FILE_SNAP_UNEXPECTED_ERROR +// +// MessageText: +// +// An unexpected error occurred while processing a file snapshot operation. +// +#define STATUS_FILE_SNAP_UNEXPECTED_ERROR ((NTSTATUS)0xC000F504L) + +// +// MessageId: STATUS_FILE_SNAP_INVALID_PARAMETER +// +// MessageText: +// +// A file snapshot operation received an invalid parameter. +// +#define STATUS_FILE_SNAP_INVALID_PARAMETER ((NTSTATUS)0xC000F505L) + +/*++ + + End of File Snap specific messages. + +--*/ + +// +// UnionFS error values +// + +// +// MessageId: STATUS_UNIONFS_CANNOT_CROSS_UNION +// +// MessageText: +// +// This operation is not allowed across unions. +// +#define STATUS_UNIONFS_CANNOT_CROSS_UNION ((NTSTATUS)0xC0ED0001L) + +// +// MessageId: STATUS_UNIONFS_CANNOT_EXIT_UNION +// +// MessageText: +// +// This operation is not allowed to have a destination outside of a union. +// +#define STATUS_UNIONFS_CANNOT_EXIT_UNION ((NTSTATUS)0xC0ED0002L) + +// +// MessageId: STATUS_UNIONFS_CANNOT_PRESERVE_LINK +// +// MessageText: +// +// This file has one or more hard links in the scratch layer. +// +#define STATUS_UNIONFS_CANNOT_PRESERVE_LINK ((NTSTATUS)0xC0ED0003L) + +// +// MessageId: STATUS_UNIONFS_INVALID_TOMBSTONE_STATE +// +// MessageText: +// +// The tombstone cannot be created in or transitioned to the given state. +// +#define STATUS_UNIONFS_INVALID_TOMBSTONE_STATE ((NTSTATUS)0xC0ED0004L) + +// +// MessageId: STATUS_UNIONFS_LAYERS_PRESENT +// +// MessageText: +// +// This union has attached layers preventing this operation. +// +#define STATUS_UNIONFS_LAYERS_PRESENT ((NTSTATUS)0xC0ED0005L) + +// +// MessageId: STATUS_UNIONFS_NESTED_LAYER +// +// MessageText: +// +// A union layer root cannot be a descendant of another layer root. +// +#define STATUS_UNIONFS_NESTED_LAYER ((NTSTATUS)0xC0ED0006L) + +// +// MessageId: STATUS_UNIONFS_UNION_DUPLICATE_ID +// +// MessageText: +// +// A union with this union ID already exists. +// +#define STATUS_UNIONFS_UNION_DUPLICATE_ID ((NTSTATUS)0xC0ED0007L) + +// +// MessageId: STATUS_UNIONFS_INACTIVE_UNION +// +// MessageText: +// +// The union this operation is being performed on is inactive. +// +#define STATUS_UNIONFS_INACTIVE_UNION ((NTSTATUS)0xC0ED0008L) + +// +// MessageId: STATUS_UNIONFS_TOO_MANY_LAYERS +// +// MessageText: +// +// There are too many layers to construct this union. +// +#define STATUS_UNIONFS_TOO_MANY_LAYERS ((NTSTATUS)0xC0ED0009L) + +// +// MessageId: STATUS_UNIONFS_TOO_LATE +// +// MessageText: +// +// The UnionFS service is not available. +// +#define STATUS_UNIONFS_TOO_LATE ((NTSTATUS)0xC0ED000AL) + +// +// MessageId: STATUS_UNIONFS_NESTED_UNION +// +// MessageText: +// +// The operation cannot be supported because of a nested union. +// +#define STATUS_UNIONFS_NESTED_UNION ((NTSTATUS)0xC0ED000BL) + +// +// MessageId: STATUS_UNIONFS_NESTED_UNION_NOT_ALLOWED +// +// MessageText: +// +// An attempt was made to create a new union root as an ancestor or descendant of an existing union root, but the new union is not configured to allow nesting. +// +#define STATUS_UNIONFS_NESTED_UNION_NOT_ALLOWED ((NTSTATUS)0xC0ED000CL) + + +// **** New SYSTEM error codes can be inserted here **** + + +// +// Debugger error values +// + +// +// MessageId: DBG_NO_STATE_CHANGE +// +// MessageText: +// +// Debugger did not perform a state change. +// +#define DBG_NO_STATE_CHANGE ((NTSTATUS)0xC0010001L) + +// +// MessageId: DBG_APP_NOT_IDLE +// +// MessageText: +// +// Debugger has found the application is not idle. +// +#define DBG_APP_NOT_IDLE ((NTSTATUS)0xC0010002L) + + +// +// RPC error values +// + +// +// MessageId: RPC_NT_INVALID_STRING_BINDING +// +// MessageText: +// +// The string binding is invalid. +// +#define RPC_NT_INVALID_STRING_BINDING ((NTSTATUS)0xC0020001L) + +// +// MessageId: RPC_NT_WRONG_KIND_OF_BINDING +// +// MessageText: +// +// The binding handle is not the correct type. +// +#define RPC_NT_WRONG_KIND_OF_BINDING ((NTSTATUS)0xC0020002L) + +// +// MessageId: RPC_NT_INVALID_BINDING +// +// MessageText: +// +// The binding handle is invalid. +// +#define RPC_NT_INVALID_BINDING ((NTSTATUS)0xC0020003L) + +// +// MessageId: RPC_NT_PROTSEQ_NOT_SUPPORTED +// +// MessageText: +// +// The RPC protocol sequence is not supported. +// +#define RPC_NT_PROTSEQ_NOT_SUPPORTED ((NTSTATUS)0xC0020004L) + +// +// MessageId: RPC_NT_INVALID_RPC_PROTSEQ +// +// MessageText: +// +// The RPC protocol sequence is invalid. +// +#define RPC_NT_INVALID_RPC_PROTSEQ ((NTSTATUS)0xC0020005L) + +// +// MessageId: RPC_NT_INVALID_STRING_UUID +// +// MessageText: +// +// The string UUID is invalid. +// +#define RPC_NT_INVALID_STRING_UUID ((NTSTATUS)0xC0020006L) + +// +// MessageId: RPC_NT_INVALID_ENDPOINT_FORMAT +// +// MessageText: +// +// The endpoint format is invalid. +// +#define RPC_NT_INVALID_ENDPOINT_FORMAT ((NTSTATUS)0xC0020007L) + +// +// MessageId: RPC_NT_INVALID_NET_ADDR +// +// MessageText: +// +// The network address is invalid. +// +#define RPC_NT_INVALID_NET_ADDR ((NTSTATUS)0xC0020008L) + +// +// MessageId: RPC_NT_NO_ENDPOINT_FOUND +// +// MessageText: +// +// No endpoint was found. +// +#define RPC_NT_NO_ENDPOINT_FOUND ((NTSTATUS)0xC0020009L) + +// +// MessageId: RPC_NT_INVALID_TIMEOUT +// +// MessageText: +// +// The timeout value is invalid. +// +#define RPC_NT_INVALID_TIMEOUT ((NTSTATUS)0xC002000AL) + +// +// MessageId: RPC_NT_OBJECT_NOT_FOUND +// +// MessageText: +// +// The object UUID was not found. +// +#define RPC_NT_OBJECT_NOT_FOUND ((NTSTATUS)0xC002000BL) + +// +// MessageId: RPC_NT_ALREADY_REGISTERED +// +// MessageText: +// +// The object UUID has already been registered. +// +#define RPC_NT_ALREADY_REGISTERED ((NTSTATUS)0xC002000CL) + +// +// MessageId: RPC_NT_TYPE_ALREADY_REGISTERED +// +// MessageText: +// +// The type UUID has already been registered. +// +#define RPC_NT_TYPE_ALREADY_REGISTERED ((NTSTATUS)0xC002000DL) + +// +// MessageId: RPC_NT_ALREADY_LISTENING +// +// MessageText: +// +// The RPC server is already listening. +// +#define RPC_NT_ALREADY_LISTENING ((NTSTATUS)0xC002000EL) + +// +// MessageId: RPC_NT_NO_PROTSEQS_REGISTERED +// +// MessageText: +// +// No protocol sequences have been registered. +// +#define RPC_NT_NO_PROTSEQS_REGISTERED ((NTSTATUS)0xC002000FL) + +// +// MessageId: RPC_NT_NOT_LISTENING +// +// MessageText: +// +// The RPC server is not listening. +// +#define RPC_NT_NOT_LISTENING ((NTSTATUS)0xC0020010L) + +// +// MessageId: RPC_NT_UNKNOWN_MGR_TYPE +// +// MessageText: +// +// The manager type is unknown. +// +#define RPC_NT_UNKNOWN_MGR_TYPE ((NTSTATUS)0xC0020011L) + +// +// MessageId: RPC_NT_UNKNOWN_IF +// +// MessageText: +// +// The interface is unknown. +// +#define RPC_NT_UNKNOWN_IF ((NTSTATUS)0xC0020012L) + +// +// MessageId: RPC_NT_NO_BINDINGS +// +// MessageText: +// +// There are no bindings. +// +#define RPC_NT_NO_BINDINGS ((NTSTATUS)0xC0020013L) + +// +// MessageId: RPC_NT_NO_PROTSEQS +// +// MessageText: +// +// There are no protocol sequences. +// +#define RPC_NT_NO_PROTSEQS ((NTSTATUS)0xC0020014L) + +// +// MessageId: RPC_NT_CANT_CREATE_ENDPOINT +// +// MessageText: +// +// The endpoint cannot be created. +// +#define RPC_NT_CANT_CREATE_ENDPOINT ((NTSTATUS)0xC0020015L) + +// +// MessageId: RPC_NT_OUT_OF_RESOURCES +// +// MessageText: +// +// Not enough resources are available to complete this operation. +// +#define RPC_NT_OUT_OF_RESOURCES ((NTSTATUS)0xC0020016L) + +// +// MessageId: RPC_NT_SERVER_UNAVAILABLE +// +// MessageText: +// +// The RPC server is unavailable. +// +#define RPC_NT_SERVER_UNAVAILABLE ((NTSTATUS)0xC0020017L) + +// +// MessageId: RPC_NT_SERVER_TOO_BUSY +// +// MessageText: +// +// The RPC server is too busy to complete this operation. +// +#define RPC_NT_SERVER_TOO_BUSY ((NTSTATUS)0xC0020018L) + +// +// MessageId: RPC_NT_INVALID_NETWORK_OPTIONS +// +// MessageText: +// +// The network options are invalid. +// +#define RPC_NT_INVALID_NETWORK_OPTIONS ((NTSTATUS)0xC0020019L) + +// +// MessageId: RPC_NT_NO_CALL_ACTIVE +// +// MessageText: +// +// There are no remote procedure calls active on this thread. +// +#define RPC_NT_NO_CALL_ACTIVE ((NTSTATUS)0xC002001AL) + +// +// MessageId: RPC_NT_CALL_FAILED +// +// MessageText: +// +// The remote procedure call failed. +// +#define RPC_NT_CALL_FAILED ((NTSTATUS)0xC002001BL) + +// +// MessageId: RPC_NT_CALL_FAILED_DNE +// +// MessageText: +// +// The remote procedure call failed and did not execute. +// +#define RPC_NT_CALL_FAILED_DNE ((NTSTATUS)0xC002001CL) + +// +// MessageId: RPC_NT_PROTOCOL_ERROR +// +// MessageText: +// +// An RPC protocol error occurred. +// +#define RPC_NT_PROTOCOL_ERROR ((NTSTATUS)0xC002001DL) + +// +// MessageId: RPC_NT_UNSUPPORTED_TRANS_SYN +// +// MessageText: +// +// The transfer syntax is not supported by the RPC server. +// +#define RPC_NT_UNSUPPORTED_TRANS_SYN ((NTSTATUS)0xC002001FL) + +// +// MessageId: RPC_NT_UNSUPPORTED_TYPE +// +// MessageText: +// +// The type UUID is not supported. +// +#define RPC_NT_UNSUPPORTED_TYPE ((NTSTATUS)0xC0020021L) + +// +// MessageId: RPC_NT_INVALID_TAG +// +// MessageText: +// +// The tag is invalid. +// +#define RPC_NT_INVALID_TAG ((NTSTATUS)0xC0020022L) + +// +// MessageId: RPC_NT_INVALID_BOUND +// +// MessageText: +// +// The array bounds are invalid. +// +#define RPC_NT_INVALID_BOUND ((NTSTATUS)0xC0020023L) + +// +// MessageId: RPC_NT_NO_ENTRY_NAME +// +// MessageText: +// +// The binding does not contain an entry name. +// +#define RPC_NT_NO_ENTRY_NAME ((NTSTATUS)0xC0020024L) + +// +// MessageId: RPC_NT_INVALID_NAME_SYNTAX +// +// MessageText: +// +// The name syntax is invalid. +// +#define RPC_NT_INVALID_NAME_SYNTAX ((NTSTATUS)0xC0020025L) + +// +// MessageId: RPC_NT_UNSUPPORTED_NAME_SYNTAX +// +// MessageText: +// +// The name syntax is not supported. +// +#define RPC_NT_UNSUPPORTED_NAME_SYNTAX ((NTSTATUS)0xC0020026L) + +// +// MessageId: RPC_NT_UUID_NO_ADDRESS +// +// MessageText: +// +// No network address is available to use to construct a UUID. +// +#define RPC_NT_UUID_NO_ADDRESS ((NTSTATUS)0xC0020028L) + +// +// MessageId: RPC_NT_DUPLICATE_ENDPOINT +// +// MessageText: +// +// The endpoint is a duplicate. +// +#define RPC_NT_DUPLICATE_ENDPOINT ((NTSTATUS)0xC0020029L) + +// +// MessageId: RPC_NT_UNKNOWN_AUTHN_TYPE +// +// MessageText: +// +// The authentication type is unknown. +// +#define RPC_NT_UNKNOWN_AUTHN_TYPE ((NTSTATUS)0xC002002AL) + +// +// MessageId: RPC_NT_MAX_CALLS_TOO_SMALL +// +// MessageText: +// +// The maximum number of calls is too small. +// +#define RPC_NT_MAX_CALLS_TOO_SMALL ((NTSTATUS)0xC002002BL) + +// +// MessageId: RPC_NT_STRING_TOO_LONG +// +// MessageText: +// +// The string is too long. +// +#define RPC_NT_STRING_TOO_LONG ((NTSTATUS)0xC002002CL) + +// +// MessageId: RPC_NT_PROTSEQ_NOT_FOUND +// +// MessageText: +// +// The RPC protocol sequence was not found. +// +#define RPC_NT_PROTSEQ_NOT_FOUND ((NTSTATUS)0xC002002DL) + +// +// MessageId: RPC_NT_PROCNUM_OUT_OF_RANGE +// +// MessageText: +// +// The procedure number is out of range. +// +#define RPC_NT_PROCNUM_OUT_OF_RANGE ((NTSTATUS)0xC002002EL) + +// +// MessageId: RPC_NT_BINDING_HAS_NO_AUTH +// +// MessageText: +// +// The binding does not contain any authentication information. +// +#define RPC_NT_BINDING_HAS_NO_AUTH ((NTSTATUS)0xC002002FL) + +// +// MessageId: RPC_NT_UNKNOWN_AUTHN_SERVICE +// +// MessageText: +// +// The authentication service is unknown. +// +#define RPC_NT_UNKNOWN_AUTHN_SERVICE ((NTSTATUS)0xC0020030L) + +// +// MessageId: RPC_NT_UNKNOWN_AUTHN_LEVEL +// +// MessageText: +// +// The authentication level is unknown. +// +#define RPC_NT_UNKNOWN_AUTHN_LEVEL ((NTSTATUS)0xC0020031L) + +// +// MessageId: RPC_NT_INVALID_AUTH_IDENTITY +// +// MessageText: +// +// The security context is invalid. +// +#define RPC_NT_INVALID_AUTH_IDENTITY ((NTSTATUS)0xC0020032L) + +// +// MessageId: RPC_NT_UNKNOWN_AUTHZ_SERVICE +// +// MessageText: +// +// The authorization service is unknown. +// +#define RPC_NT_UNKNOWN_AUTHZ_SERVICE ((NTSTATUS)0xC0020033L) + +// +// MessageId: EPT_NT_INVALID_ENTRY +// +// MessageText: +// +// The entry is invalid. +// +#define EPT_NT_INVALID_ENTRY ((NTSTATUS)0xC0020034L) + +// +// MessageId: EPT_NT_CANT_PERFORM_OP +// +// MessageText: +// +// The operation cannot be performed. +// +#define EPT_NT_CANT_PERFORM_OP ((NTSTATUS)0xC0020035L) + +// +// MessageId: EPT_NT_NOT_REGISTERED +// +// MessageText: +// +// There are no more endpoints available from the endpoint mapper. +// +#define EPT_NT_NOT_REGISTERED ((NTSTATUS)0xC0020036L) + +// +// MessageId: RPC_NT_NOTHING_TO_EXPORT +// +// MessageText: +// +// No interfaces have been exported. +// +#define RPC_NT_NOTHING_TO_EXPORT ((NTSTATUS)0xC0020037L) + +// +// MessageId: RPC_NT_INCOMPLETE_NAME +// +// MessageText: +// +// The entry name is incomplete. +// +#define RPC_NT_INCOMPLETE_NAME ((NTSTATUS)0xC0020038L) + +// +// MessageId: RPC_NT_INVALID_VERS_OPTION +// +// MessageText: +// +// The version option is invalid. +// +#define RPC_NT_INVALID_VERS_OPTION ((NTSTATUS)0xC0020039L) + +// +// MessageId: RPC_NT_NO_MORE_MEMBERS +// +// MessageText: +// +// There are no more members. +// +#define RPC_NT_NO_MORE_MEMBERS ((NTSTATUS)0xC002003AL) + +// +// MessageId: RPC_NT_NOT_ALL_OBJS_UNEXPORTED +// +// MessageText: +// +// There is nothing to unexport. +// +#define RPC_NT_NOT_ALL_OBJS_UNEXPORTED ((NTSTATUS)0xC002003BL) + +// +// MessageId: RPC_NT_INTERFACE_NOT_FOUND +// +// MessageText: +// +// The interface was not found. +// +#define RPC_NT_INTERFACE_NOT_FOUND ((NTSTATUS)0xC002003CL) + +// +// MessageId: RPC_NT_ENTRY_ALREADY_EXISTS +// +// MessageText: +// +// The entry already exists. +// +#define RPC_NT_ENTRY_ALREADY_EXISTS ((NTSTATUS)0xC002003DL) + +// +// MessageId: RPC_NT_ENTRY_NOT_FOUND +// +// MessageText: +// +// The entry is not found. +// +#define RPC_NT_ENTRY_NOT_FOUND ((NTSTATUS)0xC002003EL) + +// +// MessageId: RPC_NT_NAME_SERVICE_UNAVAILABLE +// +// MessageText: +// +// The name service is unavailable. +// +#define RPC_NT_NAME_SERVICE_UNAVAILABLE ((NTSTATUS)0xC002003FL) + +// +// MessageId: RPC_NT_INVALID_NAF_ID +// +// MessageText: +// +// The network address family is invalid. +// +#define RPC_NT_INVALID_NAF_ID ((NTSTATUS)0xC0020040L) + +// +// MessageId: RPC_NT_CANNOT_SUPPORT +// +// MessageText: +// +// The requested operation is not supported. +// +#define RPC_NT_CANNOT_SUPPORT ((NTSTATUS)0xC0020041L) + +// +// MessageId: RPC_NT_NO_CONTEXT_AVAILABLE +// +// MessageText: +// +// No security context is available to allow impersonation. +// +#define RPC_NT_NO_CONTEXT_AVAILABLE ((NTSTATUS)0xC0020042L) + +// +// MessageId: RPC_NT_INTERNAL_ERROR +// +// MessageText: +// +// An internal error occurred in RPC. +// +#define RPC_NT_INTERNAL_ERROR ((NTSTATUS)0xC0020043L) + +// +// MessageId: RPC_NT_ZERO_DIVIDE +// +// MessageText: +// +// The RPC server attempted an integer divide by zero. +// +#define RPC_NT_ZERO_DIVIDE ((NTSTATUS)0xC0020044L) + +// +// MessageId: RPC_NT_ADDRESS_ERROR +// +// MessageText: +// +// An addressing error occurred in the RPC server. +// +#define RPC_NT_ADDRESS_ERROR ((NTSTATUS)0xC0020045L) + +// +// MessageId: RPC_NT_FP_DIV_ZERO +// +// MessageText: +// +// A floating point operation at the RPC server caused a divide by zero. +// +#define RPC_NT_FP_DIV_ZERO ((NTSTATUS)0xC0020046L) + +// +// MessageId: RPC_NT_FP_UNDERFLOW +// +// MessageText: +// +// A floating point underflow occurred at the RPC server. +// +#define RPC_NT_FP_UNDERFLOW ((NTSTATUS)0xC0020047L) + +// +// MessageId: RPC_NT_FP_OVERFLOW +// +// MessageText: +// +// A floating point overflow occurred at the RPC server. +// +#define RPC_NT_FP_OVERFLOW ((NTSTATUS)0xC0020048L) + +// +// MessageId: RPC_NT_NO_MORE_ENTRIES +// +// MessageText: +// +// The list of RPC servers available for auto-handle binding has been exhausted. +// +#define RPC_NT_NO_MORE_ENTRIES ((NTSTATUS)0xC0030001L) + +// +// MessageId: RPC_NT_SS_CHAR_TRANS_OPEN_FAIL +// +// MessageText: +// +// The file designated by DCERPCCHARTRANS cannot be opened. +// +#define RPC_NT_SS_CHAR_TRANS_OPEN_FAIL ((NTSTATUS)0xC0030002L) + +// +// MessageId: RPC_NT_SS_CHAR_TRANS_SHORT_FILE +// +// MessageText: +// +// The file containing the character translation table has fewer than 512 bytes. +// +#define RPC_NT_SS_CHAR_TRANS_SHORT_FILE ((NTSTATUS)0xC0030003L) + +// +// MessageId: RPC_NT_SS_IN_NULL_CONTEXT +// +// MessageText: +// +// A null context handle is passed as an [in] parameter. +// +#define RPC_NT_SS_IN_NULL_CONTEXT ((NTSTATUS)0xC0030004L) + +// +// MessageId: RPC_NT_SS_CONTEXT_MISMATCH +// +// MessageText: +// +// The context handle does not match any known context handles. +// +#define RPC_NT_SS_CONTEXT_MISMATCH ((NTSTATUS)0xC0030005L) + +// +// MessageId: RPC_NT_SS_CONTEXT_DAMAGED +// +// MessageText: +// +// The context handle changed during a call. +// +#define RPC_NT_SS_CONTEXT_DAMAGED ((NTSTATUS)0xC0030006L) + +// +// MessageId: RPC_NT_SS_HANDLES_MISMATCH +// +// MessageText: +// +// The binding handles passed to a remote procedure call do not match. +// +#define RPC_NT_SS_HANDLES_MISMATCH ((NTSTATUS)0xC0030007L) + +// +// MessageId: RPC_NT_SS_CANNOT_GET_CALL_HANDLE +// +// MessageText: +// +// The stub is unable to get the call handle. +// +#define RPC_NT_SS_CANNOT_GET_CALL_HANDLE ((NTSTATUS)0xC0030008L) + +// +// MessageId: RPC_NT_NULL_REF_POINTER +// +// MessageText: +// +// A null reference pointer was passed to the stub. +// +#define RPC_NT_NULL_REF_POINTER ((NTSTATUS)0xC0030009L) + +// +// MessageId: RPC_NT_ENUM_VALUE_OUT_OF_RANGE +// +// MessageText: +// +// The enumeration value is out of range. +// +#define RPC_NT_ENUM_VALUE_OUT_OF_RANGE ((NTSTATUS)0xC003000AL) + +// +// MessageId: RPC_NT_BYTE_COUNT_TOO_SMALL +// +// MessageText: +// +// The byte count is too small. +// +#define RPC_NT_BYTE_COUNT_TOO_SMALL ((NTSTATUS)0xC003000BL) + +// +// MessageId: RPC_NT_BAD_STUB_DATA +// +// MessageText: +// +// The stub received bad data. +// +#define RPC_NT_BAD_STUB_DATA ((NTSTATUS)0xC003000CL) + +// +// MessageId: RPC_NT_CALL_IN_PROGRESS +// +// MessageText: +// +// A remote procedure call is already in progress for this thread. +// +#define RPC_NT_CALL_IN_PROGRESS ((NTSTATUS)0xC0020049L) + +// +// MessageId: RPC_NT_NO_MORE_BINDINGS +// +// MessageText: +// +// There are no more bindings. +// +#define RPC_NT_NO_MORE_BINDINGS ((NTSTATUS)0xC002004AL) + +// +// MessageId: RPC_NT_GROUP_MEMBER_NOT_FOUND +// +// MessageText: +// +// The group member was not found. +// +#define RPC_NT_GROUP_MEMBER_NOT_FOUND ((NTSTATUS)0xC002004BL) + +// +// MessageId: EPT_NT_CANT_CREATE +// +// MessageText: +// +// The endpoint mapper database entry could not be created. +// +#define EPT_NT_CANT_CREATE ((NTSTATUS)0xC002004CL) + +// +// MessageId: RPC_NT_INVALID_OBJECT +// +// MessageText: +// +// The object UUID is the nil UUID. +// +#define RPC_NT_INVALID_OBJECT ((NTSTATUS)0xC002004DL) + +// +// MessageId: RPC_NT_NO_INTERFACES +// +// MessageText: +// +// No interfaces have been registered. +// +#define RPC_NT_NO_INTERFACES ((NTSTATUS)0xC002004FL) + +// +// MessageId: RPC_NT_CALL_CANCELLED +// +// MessageText: +// +// The remote procedure call was cancelled. +// +#define RPC_NT_CALL_CANCELLED ((NTSTATUS)0xC0020050L) + +// +// MessageId: RPC_NT_BINDING_INCOMPLETE +// +// MessageText: +// +// The binding handle does not contain all required information. +// +#define RPC_NT_BINDING_INCOMPLETE ((NTSTATUS)0xC0020051L) + +// +// MessageId: RPC_NT_COMM_FAILURE +// +// MessageText: +// +// A communications failure occurred during a remote procedure call. +// +#define RPC_NT_COMM_FAILURE ((NTSTATUS)0xC0020052L) + +// +// MessageId: RPC_NT_UNSUPPORTED_AUTHN_LEVEL +// +// MessageText: +// +// The requested authentication level is not supported. +// +#define RPC_NT_UNSUPPORTED_AUTHN_LEVEL ((NTSTATUS)0xC0020053L) + +// +// MessageId: RPC_NT_NO_PRINC_NAME +// +// MessageText: +// +// No principal name registered. +// +#define RPC_NT_NO_PRINC_NAME ((NTSTATUS)0xC0020054L) + +// +// MessageId: RPC_NT_NOT_RPC_ERROR +// +// MessageText: +// +// The error specified is not a valid Windows RPC error code. +// +#define RPC_NT_NOT_RPC_ERROR ((NTSTATUS)0xC0020055L) + +// +// MessageId: RPC_NT_UUID_LOCAL_ONLY +// +// MessageText: +// +// A UUID that is valid only on this computer has been allocated. +// +#define RPC_NT_UUID_LOCAL_ONLY ((NTSTATUS)0x40020056L) + +// +// MessageId: RPC_NT_SEC_PKG_ERROR +// +// MessageText: +// +// A security package specific error occurred. +// +#define RPC_NT_SEC_PKG_ERROR ((NTSTATUS)0xC0020057L) + +// +// MessageId: RPC_NT_NOT_CANCELLED +// +// MessageText: +// +// Thread is not cancelled. +// +#define RPC_NT_NOT_CANCELLED ((NTSTATUS)0xC0020058L) + +// +// MessageId: RPC_NT_INVALID_ES_ACTION +// +// MessageText: +// +// Invalid operation on the encoding/decoding handle. +// +#define RPC_NT_INVALID_ES_ACTION ((NTSTATUS)0xC0030059L) + +// +// MessageId: RPC_NT_WRONG_ES_VERSION +// +// MessageText: +// +// Incompatible version of the serializing package. +// +#define RPC_NT_WRONG_ES_VERSION ((NTSTATUS)0xC003005AL) + +// +// MessageId: RPC_NT_WRONG_STUB_VERSION +// +// MessageText: +// +// Incompatible version of the RPC stub. +// +#define RPC_NT_WRONG_STUB_VERSION ((NTSTATUS)0xC003005BL) + +// +// MessageId: RPC_NT_INVALID_PIPE_OBJECT +// +// MessageText: +// +// The RPC pipe object is invalid or corrupted. +// +#define RPC_NT_INVALID_PIPE_OBJECT ((NTSTATUS)0xC003005CL) + +// +// MessageId: RPC_NT_INVALID_PIPE_OPERATION +// +// MessageText: +// +// An invalid operation was attempted on an RPC pipe object. +// +#define RPC_NT_INVALID_PIPE_OPERATION ((NTSTATUS)0xC003005DL) + +// +// MessageId: RPC_NT_WRONG_PIPE_VERSION +// +// MessageText: +// +// Unsupported RPC pipe version. +// +#define RPC_NT_WRONG_PIPE_VERSION ((NTSTATUS)0xC003005EL) + +// +// MessageId: RPC_NT_PIPE_CLOSED +// +// MessageText: +// +// The RPC pipe object has already been closed. +// +#define RPC_NT_PIPE_CLOSED ((NTSTATUS)0xC003005FL) + +// +// MessageId: RPC_NT_PIPE_DISCIPLINE_ERROR +// +// MessageText: +// +// The RPC call completed before all pipes were processed. +// +#define RPC_NT_PIPE_DISCIPLINE_ERROR ((NTSTATUS)0xC0030060L) + +// +// MessageId: RPC_NT_PIPE_EMPTY +// +// MessageText: +// +// No more data is available from the RPC pipe. +// +#define RPC_NT_PIPE_EMPTY ((NTSTATUS)0xC0030061L) + +// +// MessageId: RPC_NT_INVALID_ASYNC_HANDLE +// +// MessageText: +// +// Invalid asynchronous remote procedure call handle. +// +#define RPC_NT_INVALID_ASYNC_HANDLE ((NTSTATUS)0xC0020062L) + +// +// MessageId: RPC_NT_INVALID_ASYNC_CALL +// +// MessageText: +// +// Invalid asynchronous RPC call handle for this operation. +// +#define RPC_NT_INVALID_ASYNC_CALL ((NTSTATUS)0xC0020063L) + +// +// MessageId: RPC_NT_PROXY_ACCESS_DENIED +// +// MessageText: +// +// Access to the HTTP proxy is denied. +// +#define RPC_NT_PROXY_ACCESS_DENIED ((NTSTATUS)0xC0020064L) + +// +// MessageId: RPC_NT_COOKIE_AUTH_FAILED +// +// MessageText: +// +// HTTP proxy server rejected the connection because the cookie authentication failed. +// +#define RPC_NT_COOKIE_AUTH_FAILED ((NTSTATUS)0xC0020065L) + +// +// MessageId: RPC_NT_SEND_INCOMPLETE +// +// MessageText: +// +// Some data remains to be sent in the request buffer. +// +#define RPC_NT_SEND_INCOMPLETE ((NTSTATUS)0x400200AFL) + + +// +// ACPI error values +// + +// +// MessageId: STATUS_ACPI_INVALID_OPCODE +// +// MessageText: +// +// An attempt was made to run an invalid AML opcode +// +#define STATUS_ACPI_INVALID_OPCODE ((NTSTATUS)0xC0140001L) + +// +// MessageId: STATUS_ACPI_STACK_OVERFLOW +// +// MessageText: +// +// The AML Interpreter Stack has overflowed +// +#define STATUS_ACPI_STACK_OVERFLOW ((NTSTATUS)0xC0140002L) + +// +// MessageId: STATUS_ACPI_ASSERT_FAILED +// +// MessageText: +// +// An inconsistent state has occurred +// +#define STATUS_ACPI_ASSERT_FAILED ((NTSTATUS)0xC0140003L) + +// +// MessageId: STATUS_ACPI_INVALID_INDEX +// +// MessageText: +// +// An attempt was made to access an array outside of its bounds +// +#define STATUS_ACPI_INVALID_INDEX ((NTSTATUS)0xC0140004L) + +// +// MessageId: STATUS_ACPI_INVALID_ARGUMENT +// +// MessageText: +// +// A required argument was not specified +// +#define STATUS_ACPI_INVALID_ARGUMENT ((NTSTATUS)0xC0140005L) + +// +// MessageId: STATUS_ACPI_FATAL +// +// MessageText: +// +// A fatal error has occurred +// +#define STATUS_ACPI_FATAL ((NTSTATUS)0xC0140006L) + +// +// MessageId: STATUS_ACPI_INVALID_SUPERNAME +// +// MessageText: +// +// An invalid SuperName was specified +// +#define STATUS_ACPI_INVALID_SUPERNAME ((NTSTATUS)0xC0140007L) + +// +// MessageId: STATUS_ACPI_INVALID_ARGTYPE +// +// MessageText: +// +// An argument with an incorrect type was specified +// +#define STATUS_ACPI_INVALID_ARGTYPE ((NTSTATUS)0xC0140008L) + +// +// MessageId: STATUS_ACPI_INVALID_OBJTYPE +// +// MessageText: +// +// An object with an incorrect type was specified +// +#define STATUS_ACPI_INVALID_OBJTYPE ((NTSTATUS)0xC0140009L) + +// +// MessageId: STATUS_ACPI_INVALID_TARGETTYPE +// +// MessageText: +// +// A target with an incorrect type was specified +// +#define STATUS_ACPI_INVALID_TARGETTYPE ((NTSTATUS)0xC014000AL) + +// +// MessageId: STATUS_ACPI_INCORRECT_ARGUMENT_COUNT +// +// MessageText: +// +// An incorrect number of arguments were specified +// +#define STATUS_ACPI_INCORRECT_ARGUMENT_COUNT ((NTSTATUS)0xC014000BL) + +// +// MessageId: STATUS_ACPI_ADDRESS_NOT_MAPPED +// +// MessageText: +// +// An address failed to translate +// +#define STATUS_ACPI_ADDRESS_NOT_MAPPED ((NTSTATUS)0xC014000CL) + +// +// MessageId: STATUS_ACPI_INVALID_EVENTTYPE +// +// MessageText: +// +// An incorrect event type was specified +// +#define STATUS_ACPI_INVALID_EVENTTYPE ((NTSTATUS)0xC014000DL) + +// +// MessageId: STATUS_ACPI_HANDLER_COLLISION +// +// MessageText: +// +// A handler for the target already exists +// +#define STATUS_ACPI_HANDLER_COLLISION ((NTSTATUS)0xC014000EL) + +// +// MessageId: STATUS_ACPI_INVALID_DATA +// +// MessageText: +// +// Invalid data for the target was specified +// +#define STATUS_ACPI_INVALID_DATA ((NTSTATUS)0xC014000FL) + +// +// MessageId: STATUS_ACPI_INVALID_REGION +// +// MessageText: +// +// An invalid region for the target was specified +// +#define STATUS_ACPI_INVALID_REGION ((NTSTATUS)0xC0140010L) + +// +// MessageId: STATUS_ACPI_INVALID_ACCESS_SIZE +// +// MessageText: +// +// An attempt was made to access a field outside of the defined range +// +#define STATUS_ACPI_INVALID_ACCESS_SIZE ((NTSTATUS)0xC0140011L) + +// +// MessageId: STATUS_ACPI_ACQUIRE_GLOBAL_LOCK +// +// MessageText: +// +// The Global system lock could not be acquired +// +#define STATUS_ACPI_ACQUIRE_GLOBAL_LOCK ((NTSTATUS)0xC0140012L) + +// +// MessageId: STATUS_ACPI_ALREADY_INITIALIZED +// +// MessageText: +// +// An attempt was made to reinitialize the ACPI subsystem +// +#define STATUS_ACPI_ALREADY_INITIALIZED ((NTSTATUS)0xC0140013L) + +// +// MessageId: STATUS_ACPI_NOT_INITIALIZED +// +// MessageText: +// +// The ACPI subsystem has not been initialized +// +#define STATUS_ACPI_NOT_INITIALIZED ((NTSTATUS)0xC0140014L) + +// +// MessageId: STATUS_ACPI_INVALID_MUTEX_LEVEL +// +// MessageText: +// +// An incorrect mutex was specified +// +#define STATUS_ACPI_INVALID_MUTEX_LEVEL ((NTSTATUS)0xC0140015L) + +// +// MessageId: STATUS_ACPI_MUTEX_NOT_OWNED +// +// MessageText: +// +// The mutex is not currently owned +// +#define STATUS_ACPI_MUTEX_NOT_OWNED ((NTSTATUS)0xC0140016L) + +// +// MessageId: STATUS_ACPI_MUTEX_NOT_OWNER +// +// MessageText: +// +// An attempt was made to access the mutex by a process that was not the owner +// +#define STATUS_ACPI_MUTEX_NOT_OWNER ((NTSTATUS)0xC0140017L) + +// +// MessageId: STATUS_ACPI_RS_ACCESS +// +// MessageText: +// +// An error occurred during an access to Region Space +// +#define STATUS_ACPI_RS_ACCESS ((NTSTATUS)0xC0140018L) + +// +// MessageId: STATUS_ACPI_INVALID_TABLE +// +// MessageText: +// +// An attempt was made to use an incorrect table +// +#define STATUS_ACPI_INVALID_TABLE ((NTSTATUS)0xC0140019L) + +// +// MessageId: STATUS_ACPI_REG_HANDLER_FAILED +// +// MessageText: +// +// The registration of an ACPI event failed +// +#define STATUS_ACPI_REG_HANDLER_FAILED ((NTSTATUS)0xC0140020L) + +// +// MessageId: STATUS_ACPI_POWER_REQUEST_FAILED +// +// MessageText: +// +// An ACPI Power Object failed to transition state +// +#define STATUS_ACPI_POWER_REQUEST_FAILED ((NTSTATUS)0xC0140021L) + +// +// Terminal Server specific Errors +// +// +// MessageId: STATUS_CTX_WINSTATION_NAME_INVALID +// +// MessageText: +// +// Session name %1 is invalid. +// +#define STATUS_CTX_WINSTATION_NAME_INVALID ((NTSTATUS)0xC00A0001L) + +// +// MessageId: STATUS_CTX_INVALID_PD +// +// MessageText: +// +// The protocol driver %1 is invalid. +// +#define STATUS_CTX_INVALID_PD ((NTSTATUS)0xC00A0002L) + +// +// MessageId: STATUS_CTX_PD_NOT_FOUND +// +// MessageText: +// +// The protocol driver %1 was not found in the system path. +// +#define STATUS_CTX_PD_NOT_FOUND ((NTSTATUS)0xC00A0003L) + +// +// MessageId: STATUS_CTX_CDM_CONNECT +// +// MessageText: +// +// The Client Drive Mapping Service Has Connected on Terminal Connection. +// +#define STATUS_CTX_CDM_CONNECT ((NTSTATUS)0x400A0004L) + +// +// MessageId: STATUS_CTX_CDM_DISCONNECT +// +// MessageText: +// +// The Client Drive Mapping Service Has Disconnected on Terminal Connection. +// +#define STATUS_CTX_CDM_DISCONNECT ((NTSTATUS)0x400A0005L) + +// +// MessageId: STATUS_CTX_CLOSE_PENDING +// +// MessageText: +// +// A close operation is pending on the Terminal Connection. +// +#define STATUS_CTX_CLOSE_PENDING ((NTSTATUS)0xC00A0006L) + +// +// MessageId: STATUS_CTX_NO_OUTBUF +// +// MessageText: +// +// There are no free output buffers available. +// +#define STATUS_CTX_NO_OUTBUF ((NTSTATUS)0xC00A0007L) + +// +// MessageId: STATUS_CTX_MODEM_INF_NOT_FOUND +// +// MessageText: +// +// The MODEM.INF file was not found. +// +#define STATUS_CTX_MODEM_INF_NOT_FOUND ((NTSTATUS)0xC00A0008L) + +// +// MessageId: STATUS_CTX_INVALID_MODEMNAME +// +// MessageText: +// +// The modem (%1) was not found in MODEM.INF. +// +#define STATUS_CTX_INVALID_MODEMNAME ((NTSTATUS)0xC00A0009L) + +// +// MessageId: STATUS_CTX_RESPONSE_ERROR +// +// MessageText: +// +// The modem did not accept the command sent to it. +// Verify the configured modem name matches the attached modem. +// +#define STATUS_CTX_RESPONSE_ERROR ((NTSTATUS)0xC00A000AL) + +// +// MessageId: STATUS_CTX_MODEM_RESPONSE_TIMEOUT +// +// MessageText: +// +// The modem did not respond to the command sent to it. +// Verify the modem is properly cabled and powered on. +// +#define STATUS_CTX_MODEM_RESPONSE_TIMEOUT ((NTSTATUS)0xC00A000BL) + +// +// MessageId: STATUS_CTX_MODEM_RESPONSE_NO_CARRIER +// +// MessageText: +// +// Carrier detect has failed or carrier has been dropped due to disconnect. +// +#define STATUS_CTX_MODEM_RESPONSE_NO_CARRIER ((NTSTATUS)0xC00A000CL) + +// +// MessageId: STATUS_CTX_MODEM_RESPONSE_NO_DIALTONE +// +// MessageText: +// +// Dial tone not detected within required time. +// Verify phone cable is properly attached and functional. +// +#define STATUS_CTX_MODEM_RESPONSE_NO_DIALTONE ((NTSTATUS)0xC00A000DL) + +// +// MessageId: STATUS_CTX_MODEM_RESPONSE_BUSY +// +// MessageText: +// +// Busy signal detected at remote site on callback. +// +#define STATUS_CTX_MODEM_RESPONSE_BUSY ((NTSTATUS)0xC00A000EL) + +// +// MessageId: STATUS_CTX_MODEM_RESPONSE_VOICE +// +// MessageText: +// +// Voice detected at remote site on callback. +// +#define STATUS_CTX_MODEM_RESPONSE_VOICE ((NTSTATUS)0xC00A000FL) + +// +// MessageId: STATUS_CTX_TD_ERROR +// +// MessageText: +// +// Transport driver error +// +#define STATUS_CTX_TD_ERROR ((NTSTATUS)0xC00A0010L) + +// +// MessageId: STATUS_CTX_LICENSE_CLIENT_INVALID +// +// MessageText: +// +// The client you are using is not licensed to use this system. Your logon request is denied. +// +#define STATUS_CTX_LICENSE_CLIENT_INVALID ((NTSTATUS)0xC00A0012L) + +// +// MessageId: STATUS_CTX_LICENSE_NOT_AVAILABLE +// +// MessageText: +// +// The system has reached its licensed logon limit. +// Please try again later. +// +#define STATUS_CTX_LICENSE_NOT_AVAILABLE ((NTSTATUS)0xC00A0013L) + +// +// MessageId: STATUS_CTX_LICENSE_EXPIRED +// +// MessageText: +// +// The system license has expired. Your logon request is denied. +// +#define STATUS_CTX_LICENSE_EXPIRED ((NTSTATUS)0xC00A0014L) + +// +// MessageId: STATUS_CTX_WINSTATION_NOT_FOUND +// +// MessageText: +// +// The specified session cannot be found. +// +#define STATUS_CTX_WINSTATION_NOT_FOUND ((NTSTATUS)0xC00A0015L) + +// +// MessageId: STATUS_CTX_WINSTATION_NAME_COLLISION +// +// MessageText: +// +// The specified session name is already in use. +// +#define STATUS_CTX_WINSTATION_NAME_COLLISION ((NTSTATUS)0xC00A0016L) + +// +// MessageId: STATUS_CTX_WINSTATION_BUSY +// +// MessageText: +// +// The task you are trying to do can't be completed because Remote Desktop Services is currently busy. Please try again in a few minutes. Other users should still be able to log on. +// +#define STATUS_CTX_WINSTATION_BUSY ((NTSTATUS)0xC00A0017L) + +// +// MessageId: STATUS_CTX_BAD_VIDEO_MODE +// +// MessageText: +// +// An attempt has been made to connect to a session whose video mode is not supported by the current client. +// +#define STATUS_CTX_BAD_VIDEO_MODE ((NTSTATUS)0xC00A0018L) + +// +// MessageId: STATUS_CTX_GRAPHICS_INVALID +// +// MessageText: +// +// The application attempted to enable DOS graphics mode. +// DOS graphics mode is not supported. +// +#define STATUS_CTX_GRAPHICS_INVALID ((NTSTATUS)0xC00A0022L) + +// +// MessageId: STATUS_CTX_NOT_CONSOLE +// +// MessageText: +// +// The requested operation can be performed only on the system console. +// This is most often the result of a driver or system DLL requiring direct console access. +// +#define STATUS_CTX_NOT_CONSOLE ((NTSTATUS)0xC00A0024L) + +// +// MessageId: STATUS_CTX_CLIENT_QUERY_TIMEOUT +// +// MessageText: +// +// The client failed to respond to the server connect message. +// +#define STATUS_CTX_CLIENT_QUERY_TIMEOUT ((NTSTATUS)0xC00A0026L) + +// +// MessageId: STATUS_CTX_CONSOLE_DISCONNECT +// +// MessageText: +// +// Disconnecting the console session is not supported. +// +#define STATUS_CTX_CONSOLE_DISCONNECT ((NTSTATUS)0xC00A0027L) + +// +// MessageId: STATUS_CTX_CONSOLE_CONNECT +// +// MessageText: +// +// Reconnecting a disconnected session to the console is not supported. +// +#define STATUS_CTX_CONSOLE_CONNECT ((NTSTATUS)0xC00A0028L) + +// +// MessageId: STATUS_CTX_SHADOW_DENIED +// +// MessageText: +// +// The request to control another session remotely was denied. +// +#define STATUS_CTX_SHADOW_DENIED ((NTSTATUS)0xC00A002AL) + +// +// MessageId: STATUS_CTX_WINSTATION_ACCESS_DENIED +// +// MessageText: +// +// A process has requested access to a session, but has not been granted those access rights. +// +#define STATUS_CTX_WINSTATION_ACCESS_DENIED ((NTSTATUS)0xC00A002BL) + +// +// MessageId: STATUS_CTX_INVALID_WD +// +// MessageText: +// +// The Terminal Connection driver %1 is invalid. +// +#define STATUS_CTX_INVALID_WD ((NTSTATUS)0xC00A002EL) + +// +// MessageId: STATUS_CTX_WD_NOT_FOUND +// +// MessageText: +// +// The Terminal Connection driver %1 was not found in the system path. +// +#define STATUS_CTX_WD_NOT_FOUND ((NTSTATUS)0xC00A002FL) + +// +// MessageId: STATUS_CTX_SHADOW_INVALID +// +// MessageText: +// +// The requested session cannot be controlled remotely. +// You cannot control your own session, a session that is trying to control your session, +// a session that has no user logged on, nor control other sessions from the console. +// +#define STATUS_CTX_SHADOW_INVALID ((NTSTATUS)0xC00A0030L) + +// +// MessageId: STATUS_CTX_SHADOW_DISABLED +// +// MessageText: +// +// The requested session is not configured to allow remote control. +// +#define STATUS_CTX_SHADOW_DISABLED ((NTSTATUS)0xC00A0031L) + +// +// MessageId: STATUS_RDP_PROTOCOL_ERROR +// +// MessageText: +// +// The RDP protocol component %2 detected an error in the protocol stream and has disconnected the client. +// +#define STATUS_RDP_PROTOCOL_ERROR ((NTSTATUS)0xC00A0032L) + +// +// MessageId: STATUS_CTX_CLIENT_LICENSE_NOT_SET +// +// MessageText: +// +// Your request to connect to this Terminal server has been rejected. +// Your Terminal Server Client license number has not been entered for this copy of the Terminal Client. +// Please call your system administrator for help in entering a valid, unique license number for this Terminal Server Client. +// Click OK to continue. +// +#define STATUS_CTX_CLIENT_LICENSE_NOT_SET ((NTSTATUS)0xC00A0033L) + +// +// MessageId: STATUS_CTX_CLIENT_LICENSE_IN_USE +// +// MessageText: +// +// Your request to connect to this Terminal server has been rejected. +// Your Terminal Server Client license number is currently being used by another user. +// Please call your system administrator to obtain a new copy of the Terminal Server Client with a valid, unique license number. +// Click OK to continue. +// +#define STATUS_CTX_CLIENT_LICENSE_IN_USE ((NTSTATUS)0xC00A0034L) + +// +// MessageId: STATUS_CTX_SHADOW_ENDED_BY_MODE_CHANGE +// +// MessageText: +// +// The remote control of the console was terminated because the display mode was changed. Changing the display mode in a remote control session is not supported. +// +#define STATUS_CTX_SHADOW_ENDED_BY_MODE_CHANGE ((NTSTATUS)0xC00A0035L) + +// +// MessageId: STATUS_CTX_SHADOW_NOT_RUNNING +// +// MessageText: +// +// Remote control could not be terminated because the specified session is not currently being remotely controlled. +// +#define STATUS_CTX_SHADOW_NOT_RUNNING ((NTSTATUS)0xC00A0036L) + +// +// MessageId: STATUS_CTX_LOGON_DISABLED +// +// MessageText: +// +// Your interactive logon privilege has been disabled. +// Please contact your system administrator. +// +#define STATUS_CTX_LOGON_DISABLED ((NTSTATUS)0xC00A0037L) + +// +// MessageId: STATUS_CTX_SECURITY_LAYER_ERROR +// +// MessageText: +// +// The Terminal Server security layer detected an error in the protocol stream and has disconnected the client. +// Client IP: %2. +// +#define STATUS_CTX_SECURITY_LAYER_ERROR ((NTSTATUS)0xC00A0038L) + +// +// MessageId: STATUS_TS_INCOMPATIBLE_SESSIONS +// +// MessageText: +// +// The target session is incompatible with the current session. +// +#define STATUS_TS_INCOMPATIBLE_SESSIONS ((NTSTATUS)0xC00A0039L) + +// +// MessageId: STATUS_TS_VIDEO_SUBSYSTEM_ERROR +// +// MessageText: +// +// Windows can't connect to your session because a problem occurred in the Windows video subsystem. Try connecting again later, or contact the server administrator for assistance. +// +#define STATUS_TS_VIDEO_SUBSYSTEM_ERROR ((NTSTATUS)0xC00A003AL) + + +// +// IO error values +// + +// +// MessageId: STATUS_PNP_BAD_MPS_TABLE +// +// MessageText: +// +// A device is missing in the system BIOS MPS table. This device will not be used. +// Please contact your system vendor for system BIOS update. +// +#define STATUS_PNP_BAD_MPS_TABLE ((NTSTATUS)0xC0040035L) + +// +// MessageId: STATUS_PNP_TRANSLATION_FAILED +// +// MessageText: +// +// A translator failed to translate resources. +// +#define STATUS_PNP_TRANSLATION_FAILED ((NTSTATUS)0xC0040036L) + +// +// MessageId: STATUS_PNP_IRQ_TRANSLATION_FAILED +// +// MessageText: +// +// A IRQ translator failed to translate resources. +// +#define STATUS_PNP_IRQ_TRANSLATION_FAILED ((NTSTATUS)0xC0040037L) + +// +// MessageId: STATUS_PNP_INVALID_ID +// +// MessageText: +// +// Driver %2 returned invalid ID for a child device (%3). +// +#define STATUS_PNP_INVALID_ID ((NTSTATUS)0xC0040038L) + +// +// MessageId: STATUS_IO_REISSUE_AS_CACHED +// +// MessageText: +// +// Reissue the given operation as a cached IO operation +// +#define STATUS_IO_REISSUE_AS_CACHED ((NTSTATUS)0xC0040039L) + + +// +// MUI error values +// + +// +// MessageId: STATUS_MUI_FILE_NOT_FOUND +// +// MessageText: +// +// The resource loader failed to find MUI file. +// +#define STATUS_MUI_FILE_NOT_FOUND ((NTSTATUS)0xC00B0001L) + +// +// MessageId: STATUS_MUI_INVALID_FILE +// +// MessageText: +// +// The resource loader failed to load MUI file because the file fail to pass validation. +// +#define STATUS_MUI_INVALID_FILE ((NTSTATUS)0xC00B0002L) + +// +// MessageId: STATUS_MUI_INVALID_RC_CONFIG +// +// MessageText: +// +// The RC Manifest is corrupted with garbage data or unsupported version or missing required item. +// +#define STATUS_MUI_INVALID_RC_CONFIG ((NTSTATUS)0xC00B0003L) + +// +// MessageId: STATUS_MUI_INVALID_LOCALE_NAME +// +// MessageText: +// +// The RC Manifest has invalid culture name. +// +#define STATUS_MUI_INVALID_LOCALE_NAME ((NTSTATUS)0xC00B0004L) + +// +// MessageId: STATUS_MUI_INVALID_ULTIMATEFALLBACK_NAME +// +// MessageText: +// +// The RC Manifest has invalid ultimatefallback name. +// +#define STATUS_MUI_INVALID_ULTIMATEFALLBACK_NAME ((NTSTATUS)0xC00B0005L) + +// +// MessageId: STATUS_MUI_FILE_NOT_LOADED +// +// MessageText: +// +// The resource loader cache doesn't have loaded MUI entry. +// +#define STATUS_MUI_FILE_NOT_LOADED ((NTSTATUS)0xC00B0006L) + +// +// MessageId: STATUS_RESOURCE_ENUM_USER_STOP +// +// MessageText: +// +// User stopped resource enumeration. +// +#define STATUS_RESOURCE_ENUM_USER_STOP ((NTSTATUS)0xC00B0007L) + + +// +// Filter Manager error values +// + +// +// Translation macro for converting: +// HRESULT --> NTSTATUS +// + +#define FILTER_FLT_NTSTATUS_FROM_HRESULT(x) ((NTSTATUS) (((x) & 0xC0007FFF) | (FACILITY_FILTER_MANAGER << 16) | 0x40000000)) + +// +// MessageId: STATUS_FLT_NO_HANDLER_DEFINED +// +// MessageText: +// +// A handler was not defined by the filter for this operation. +// +#define STATUS_FLT_NO_HANDLER_DEFINED ((NTSTATUS)0xC01C0001L) + +// +// MessageId: STATUS_FLT_CONTEXT_ALREADY_DEFINED +// +// MessageText: +// +// A context is already defined for this object. +// +#define STATUS_FLT_CONTEXT_ALREADY_DEFINED ((NTSTATUS)0xC01C0002L) + +// +// MessageId: STATUS_FLT_INVALID_ASYNCHRONOUS_REQUEST +// +// MessageText: +// +// Asynchronous requests are not valid for this operation. +// +#define STATUS_FLT_INVALID_ASYNCHRONOUS_REQUEST ((NTSTATUS)0xC01C0003L) + +// +// MessageId: STATUS_FLT_DISALLOW_FAST_IO +// +// MessageText: +// +// Internal error code used by the filter manager to determine if a fastio operation should be forced down the IRP path. Mini-filters should never return this value. +// +#define STATUS_FLT_DISALLOW_FAST_IO ((NTSTATUS)0xC01C0004L) + +// +// The same code used to disallow fast IO is also used to disallow the FS +// filter QueryOpen callback. +// + +#define STATUS_FLT_DISALLOW_FSFILTER_IO STATUS_FLT_DISALLOW_FAST_IO + +// +// MessageId: STATUS_FLT_INVALID_NAME_REQUEST +// +// MessageText: +// +// An invalid name request was made. The name requested cannot be retrieved at this time. +// +#define STATUS_FLT_INVALID_NAME_REQUEST ((NTSTATUS)0xC01C0005L) + +// +// MessageId: STATUS_FLT_NOT_SAFE_TO_POST_OPERATION +// +// MessageText: +// +// Posting this operation to a worker thread for further processing is not safe at this time because it could lead to a system deadlock. +// +#define STATUS_FLT_NOT_SAFE_TO_POST_OPERATION ((NTSTATUS)0xC01C0006L) + +// +// MessageId: STATUS_FLT_NOT_INITIALIZED +// +// MessageText: +// +// The Filter Manager was not initialized when a filter tried to register. Make sure that the Filter Manager is getting loaded as a driver. +// +#define STATUS_FLT_NOT_INITIALIZED ((NTSTATUS)0xC01C0007L) + +// +// MessageId: STATUS_FLT_FILTER_NOT_READY +// +// MessageText: +// +// The filter is not ready for attachment to volumes because it has not finished initializing (FltStartFiltering has not been called). +// +#define STATUS_FLT_FILTER_NOT_READY ((NTSTATUS)0xC01C0008L) + +// +// MessageId: STATUS_FLT_POST_OPERATION_CLEANUP +// +// MessageText: +// +// The filter must cleanup any operation specific context at this time because it is being removed from the system before the operation is completed by the lower drivers. +// +#define STATUS_FLT_POST_OPERATION_CLEANUP ((NTSTATUS)0xC01C0009L) + +// +// MessageId: STATUS_FLT_INTERNAL_ERROR +// +// MessageText: +// +// The Filter Manager had an internal error from which it cannot recover, therefore the operation has been failed. This is usually the result of a filter returning an invalid value from a pre-operation callback. +// +#define STATUS_FLT_INTERNAL_ERROR ((NTSTATUS)0xC01C000AL) + +// +// MessageId: STATUS_FLT_DELETING_OBJECT +// +// MessageText: +// +// The object specified for this action is in the process of being deleted, therefore the action requested cannot be completed at this time. +// +#define STATUS_FLT_DELETING_OBJECT ((NTSTATUS)0xC01C000BL) + +// +// MessageId: STATUS_FLT_MUST_BE_NONPAGED_POOL +// +// MessageText: +// +// Non-paged pool must be used for this type of context. +// +#define STATUS_FLT_MUST_BE_NONPAGED_POOL ((NTSTATUS)0xC01C000CL) + +// +// MessageId: STATUS_FLT_DUPLICATE_ENTRY +// +// MessageText: +// +// A duplicate handler definition has been provided for an operation. +// +#define STATUS_FLT_DUPLICATE_ENTRY ((NTSTATUS)0xC01C000DL) + +// +// MessageId: STATUS_FLT_CBDQ_DISABLED +// +// MessageText: +// +// The callback data queue has been disabled. +// +#define STATUS_FLT_CBDQ_DISABLED ((NTSTATUS)0xC01C000EL) + +// +// MessageId: STATUS_FLT_DO_NOT_ATTACH +// +// MessageText: +// +// Do not attach the filter to the volume at this time. +// +#define STATUS_FLT_DO_NOT_ATTACH ((NTSTATUS)0xC01C000FL) + +// +// MessageId: STATUS_FLT_DO_NOT_DETACH +// +// MessageText: +// +// Do not detach the filter from the volume at this time. +// +#define STATUS_FLT_DO_NOT_DETACH ((NTSTATUS)0xC01C0010L) + +// +// MessageId: STATUS_FLT_INSTANCE_ALTITUDE_COLLISION +// +// MessageText: +// +// An instance already exists at this altitude on the volume specified. +// +#define STATUS_FLT_INSTANCE_ALTITUDE_COLLISION ((NTSTATUS)0xC01C0011L) + +// +// MessageId: STATUS_FLT_INSTANCE_NAME_COLLISION +// +// MessageText: +// +// An instance already exists with this name on the volume specified. +// +#define STATUS_FLT_INSTANCE_NAME_COLLISION ((NTSTATUS)0xC01C0012L) + +// +// MessageId: STATUS_FLT_FILTER_NOT_FOUND +// +// MessageText: +// +// The system could not find the filter specified. +// +#define STATUS_FLT_FILTER_NOT_FOUND ((NTSTATUS)0xC01C0013L) + +// +// MessageId: STATUS_FLT_VOLUME_NOT_FOUND +// +// MessageText: +// +// The system could not find the volume specified. +// +#define STATUS_FLT_VOLUME_NOT_FOUND ((NTSTATUS)0xC01C0014L) + +// +// MessageId: STATUS_FLT_INSTANCE_NOT_FOUND +// +// MessageText: +// +// The system could not find the instance specified. +// +#define STATUS_FLT_INSTANCE_NOT_FOUND ((NTSTATUS)0xC01C0015L) + +// +// MessageId: STATUS_FLT_CONTEXT_ALLOCATION_NOT_FOUND +// +// MessageText: +// +// No registered context allocation definition was found for the given request. +// +#define STATUS_FLT_CONTEXT_ALLOCATION_NOT_FOUND ((NTSTATUS)0xC01C0016L) + +// +// MessageId: STATUS_FLT_INVALID_CONTEXT_REGISTRATION +// +// MessageText: +// +// An invalid parameter was specified during context registration. +// +#define STATUS_FLT_INVALID_CONTEXT_REGISTRATION ((NTSTATUS)0xC01C0017L) + +// +// MessageId: STATUS_FLT_NAME_CACHE_MISS +// +// MessageText: +// +// The name requested was not found in Filter Manager's name cache and could not be retrieved from the file system. +// +#define STATUS_FLT_NAME_CACHE_MISS ((NTSTATUS)0xC01C0018L) + +// +// MessageId: STATUS_FLT_NO_DEVICE_OBJECT +// +// MessageText: +// +// The requested device object does not exist for the given volume. +// +#define STATUS_FLT_NO_DEVICE_OBJECT ((NTSTATUS)0xC01C0019L) + +// +// MessageId: STATUS_FLT_VOLUME_ALREADY_MOUNTED +// +// MessageText: +// +// The specified volume is already mounted. +// +#define STATUS_FLT_VOLUME_ALREADY_MOUNTED ((NTSTATUS)0xC01C001AL) + +// +// MessageId: STATUS_FLT_ALREADY_ENLISTED +// +// MessageText: +// +// The specified Transaction Context is already enlisted in a transaction +// +#define STATUS_FLT_ALREADY_ENLISTED ((NTSTATUS)0xC01C001BL) + +// +// MessageId: STATUS_FLT_CONTEXT_ALREADY_LINKED +// +// MessageText: +// +// The specified context is already attached to another object +// +#define STATUS_FLT_CONTEXT_ALREADY_LINKED ((NTSTATUS)0xC01C001CL) + +// +// MessageId: STATUS_FLT_NO_WAITER_FOR_REPLY +// +// MessageText: +// +// No waiter is present for the filter's reply to this message. +// +#define STATUS_FLT_NO_WAITER_FOR_REPLY ((NTSTATUS)0xC01C0020L) + +// +// MessageId: STATUS_FLT_REGISTRATION_BUSY +// +// MessageText: +// +// The filesystem database resource is in use. Registration cannot complete at this time. +// +#define STATUS_FLT_REGISTRATION_BUSY ((NTSTATUS)0xC01C0023L) + +// +// MessageId: STATUS_FLT_WCOS_NOT_SUPPORTED +// +// MessageText: +// +// The filter is not allowed to attach because it has not declared compability with WCOS. +// +#define STATUS_FLT_WCOS_NOT_SUPPORTED ((NTSTATUS)0xC01C0024L) + + +// +// Side-by-side (SXS) error values +// + +// +// MessageId: STATUS_SXS_SECTION_NOT_FOUND +// +// MessageText: +// +// The requested section is not present in the activation context. +// +#define STATUS_SXS_SECTION_NOT_FOUND ((NTSTATUS)0xC0150001L) + +// +// MessageId: STATUS_SXS_CANT_GEN_ACTCTX +// +// MessageText: +// +// Windows was not able to process the application binding information. +// Please refer to your System Event Log for further information. +// +#define STATUS_SXS_CANT_GEN_ACTCTX ((NTSTATUS)0xC0150002L) + +// +// MessageId: STATUS_SXS_INVALID_ACTCTXDATA_FORMAT +// +// MessageText: +// +// The application binding data format is invalid. +// +#define STATUS_SXS_INVALID_ACTCTXDATA_FORMAT ((NTSTATUS)0xC0150003L) + +// +// MessageId: STATUS_SXS_ASSEMBLY_NOT_FOUND +// +// MessageText: +// +// The referenced assembly is not installed on your system. +// +#define STATUS_SXS_ASSEMBLY_NOT_FOUND ((NTSTATUS)0xC0150004L) + +// +// MessageId: STATUS_SXS_MANIFEST_FORMAT_ERROR +// +// MessageText: +// +// The manifest file does not begin with the required tag and format information. +// +#define STATUS_SXS_MANIFEST_FORMAT_ERROR ((NTSTATUS)0xC0150005L) + +// +// MessageId: STATUS_SXS_MANIFEST_PARSE_ERROR +// +// MessageText: +// +// The manifest file contains one or more syntax errors. +// +#define STATUS_SXS_MANIFEST_PARSE_ERROR ((NTSTATUS)0xC0150006L) + +// +// MessageId: STATUS_SXS_ACTIVATION_CONTEXT_DISABLED +// +// MessageText: +// +// The application attempted to activate a disabled activation context. +// +#define STATUS_SXS_ACTIVATION_CONTEXT_DISABLED ((NTSTATUS)0xC0150007L) + +// +// MessageId: STATUS_SXS_KEY_NOT_FOUND +// +// MessageText: +// +// The requested lookup key was not found in any active activation context. +// +#define STATUS_SXS_KEY_NOT_FOUND ((NTSTATUS)0xC0150008L) + +// +// MessageId: STATUS_SXS_VERSION_CONFLICT +// +// MessageText: +// +// A component version required by the application conflicts with another component version already active. +// +#define STATUS_SXS_VERSION_CONFLICT ((NTSTATUS)0xC0150009L) + +// +// MessageId: STATUS_SXS_WRONG_SECTION_TYPE +// +// MessageText: +// +// The type requested activation context section does not match the query API used. +// +#define STATUS_SXS_WRONG_SECTION_TYPE ((NTSTATUS)0xC015000AL) + +// +// MessageId: STATUS_SXS_THREAD_QUERIES_DISABLED +// +// MessageText: +// +// Lack of system resources has required isolated activation to be disabled for the current thread of execution. +// +#define STATUS_SXS_THREAD_QUERIES_DISABLED ((NTSTATUS)0xC015000BL) + +// +// MessageId: STATUS_SXS_ASSEMBLY_MISSING +// +// MessageText: +// +// The referenced assembly could not be found. +// +#define STATUS_SXS_ASSEMBLY_MISSING ((NTSTATUS)0xC015000CL) + +// +// MessageId: STATUS_SXS_RELEASE_ACTIVATION_CONTEXT +// +// MessageText: +// +// A kernel mode component is releasing a reference on an activation context. +// +#define STATUS_SXS_RELEASE_ACTIVATION_CONTEXT ((NTSTATUS)0x4015000DL) + +// +// MessageId: STATUS_SXS_PROCESS_DEFAULT_ALREADY_SET +// +// MessageText: +// +// An attempt to set the process default activation context failed because the process default activation context was already set. +// +#define STATUS_SXS_PROCESS_DEFAULT_ALREADY_SET ((NTSTATUS)0xC015000EL) + +#if defined(STATUS_SUCCESS) || (_WIN32_WINNT > 0x0500) || (_WIN32_FUSION >= 0x0100) // winnt +// +// MessageId: STATUS_SXS_EARLY_DEACTIVATION +// +// MessageText: +// +// The activation context being deactivated is not the most recently activated one. +// +#define STATUS_SXS_EARLY_DEACTIVATION ((NTSTATUS)0xC015000FL) // winnt + +// +// MessageId: STATUS_SXS_INVALID_DEACTIVATION +// +// MessageText: +// +// The activation context being deactivated is not active for the current thread of execution. +// +#define STATUS_SXS_INVALID_DEACTIVATION ((NTSTATUS)0xC0150010L) // winnt + +#endif // winnt +// +// MessageId: STATUS_SXS_MULTIPLE_DEACTIVATION +// +// MessageText: +// +// The activation context being deactivated has already been deactivated. +// +#define STATUS_SXS_MULTIPLE_DEACTIVATION ((NTSTATUS)0xC0150011L) + +// +// MessageId: STATUS_SXS_SYSTEM_DEFAULT_ACTIVATION_CONTEXT_EMPTY +// +// MessageText: +// +// The activation context of system default assembly could not be generated. +// +#define STATUS_SXS_SYSTEM_DEFAULT_ACTIVATION_CONTEXT_EMPTY ((NTSTATUS)0xC0150012L) + +// +// MessageId: STATUS_SXS_PROCESS_TERMINATION_REQUESTED +// +// MessageText: +// +// A component used by the isolation facility has requested to terminate the process. +// +#define STATUS_SXS_PROCESS_TERMINATION_REQUESTED ((NTSTATUS)0xC0150013L) + +// +// MessageId: STATUS_SXS_CORRUPT_ACTIVATION_STACK +// +// MessageText: +// +// The activation context activation stack for the running thread of execution is corrupt. +// +#define STATUS_SXS_CORRUPT_ACTIVATION_STACK ((NTSTATUS)0xC0150014L) + +// +// MessageId: STATUS_SXS_CORRUPTION +// +// MessageText: +// +// The application isolation metadata for this process or thread has become corrupt. +// +#define STATUS_SXS_CORRUPTION ((NTSTATUS)0xC0150015L) + +// +// MessageId: STATUS_SXS_INVALID_IDENTITY_ATTRIBUTE_VALUE +// +// MessageText: +// +// The value of an attribute in an identity is not within the legal range. +// +#define STATUS_SXS_INVALID_IDENTITY_ATTRIBUTE_VALUE ((NTSTATUS)0xC0150016L) + +// +// MessageId: STATUS_SXS_INVALID_IDENTITY_ATTRIBUTE_NAME +// +// MessageText: +// +// The name of an attribute in an identity is not within the legal range. +// +#define STATUS_SXS_INVALID_IDENTITY_ATTRIBUTE_NAME ((NTSTATUS)0xC0150017L) + +// +// MessageId: STATUS_SXS_IDENTITY_DUPLICATE_ATTRIBUTE +// +// MessageText: +// +// An identity contains two definitions for the same attribute. +// +#define STATUS_SXS_IDENTITY_DUPLICATE_ATTRIBUTE ((NTSTATUS)0xC0150018L) + +// +// MessageId: STATUS_SXS_IDENTITY_PARSE_ERROR +// +// MessageText: +// +// The identity string is malformed. This may be due to a trailing comma, more than two unnamed attributes, missing attribute name or missing attribute value. +// +#define STATUS_SXS_IDENTITY_PARSE_ERROR ((NTSTATUS)0xC0150019L) + +// +// MessageId: STATUS_SXS_COMPONENT_STORE_CORRUPT +// +// MessageText: +// +// The component store has been corrupted. +// +#define STATUS_SXS_COMPONENT_STORE_CORRUPT ((NTSTATUS)0xC015001AL) + +// +// MessageId: STATUS_SXS_FILE_HASH_MISMATCH +// +// MessageText: +// +// A component's file does not match the verification information present in the component manifest. +// +#define STATUS_SXS_FILE_HASH_MISMATCH ((NTSTATUS)0xC015001BL) + +// +// MessageId: STATUS_SXS_MANIFEST_IDENTITY_SAME_BUT_CONTENTS_DIFFERENT +// +// MessageText: +// +// The identities of the manifests are identical but their contents are different. +// +#define STATUS_SXS_MANIFEST_IDENTITY_SAME_BUT_CONTENTS_DIFFERENT ((NTSTATUS)0xC015001CL) + +// +// MessageId: STATUS_SXS_IDENTITIES_DIFFERENT +// +// MessageText: +// +// The component identities are different. +// +#define STATUS_SXS_IDENTITIES_DIFFERENT ((NTSTATUS)0xC015001DL) + +// +// MessageId: STATUS_SXS_ASSEMBLY_IS_NOT_A_DEPLOYMENT +// +// MessageText: +// +// The assembly is not a deployment. +// +#define STATUS_SXS_ASSEMBLY_IS_NOT_A_DEPLOYMENT ((NTSTATUS)0xC015001EL) + +// +// MessageId: STATUS_SXS_FILE_NOT_PART_OF_ASSEMBLY +// +// MessageText: +// +// The file is not a part of the assembly. +// +#define STATUS_SXS_FILE_NOT_PART_OF_ASSEMBLY ((NTSTATUS)0xC015001FL) + +// +// MessageId: STATUS_ADVANCED_INSTALLER_FAILED +// +// MessageText: +// +// An advanced installer failed during setup or servicing. +// +#define STATUS_ADVANCED_INSTALLER_FAILED ((NTSTATUS)0xC0150020L) + +// +// MessageId: STATUS_XML_ENCODING_MISMATCH +// +// MessageText: +// +// The character encoding in the XML declaration did not match the encoding used in the document. +// +#define STATUS_XML_ENCODING_MISMATCH ((NTSTATUS)0xC0150021L) + +// +// MessageId: STATUS_SXS_MANIFEST_TOO_BIG +// +// MessageText: +// +// The size of the manifest exceeds the maximum allowed. +// +#define STATUS_SXS_MANIFEST_TOO_BIG ((NTSTATUS)0xC0150022L) + +// +// MessageId: STATUS_SXS_SETTING_NOT_REGISTERED +// +// MessageText: +// +// The setting is not registered. +// +#define STATUS_SXS_SETTING_NOT_REGISTERED ((NTSTATUS)0xC0150023L) + +// +// MessageId: STATUS_SXS_TRANSACTION_CLOSURE_INCOMPLETE +// +// MessageText: +// +// One or more required members of the transaction are not present. +// +#define STATUS_SXS_TRANSACTION_CLOSURE_INCOMPLETE ((NTSTATUS)0xC0150024L) + +// +// MessageId: STATUS_SMI_PRIMITIVE_INSTALLER_FAILED +// +// MessageText: +// +// The SMI primitive installer failed during setup or servicing. +// +#define STATUS_SMI_PRIMITIVE_INSTALLER_FAILED ((NTSTATUS)0xC0150025L) + +// +// MessageId: STATUS_GENERIC_COMMAND_FAILED +// +// MessageText: +// +// A generic command executable returned a result that indicates failure. +// +#define STATUS_GENERIC_COMMAND_FAILED ((NTSTATUS)0xC0150026L) + +// +// MessageId: STATUS_SXS_FILE_HASH_MISSING +// +// MessageText: +// +// A component is missing file verification information in its manifest. +// +#define STATUS_SXS_FILE_HASH_MISSING ((NTSTATUS)0xC0150027L) + + +// +// Cluster error values +// + +// +// MessageId: STATUS_CLUSTER_INVALID_NODE +// +// MessageText: +// +// The cluster node is not valid. +// +#define STATUS_CLUSTER_INVALID_NODE ((NTSTATUS)0xC0130001L) + +// +// MessageId: STATUS_CLUSTER_NODE_EXISTS +// +// MessageText: +// +// The cluster node already exists. +// +#define STATUS_CLUSTER_NODE_EXISTS ((NTSTATUS)0xC0130002L) + +// +// MessageId: STATUS_CLUSTER_JOIN_IN_PROGRESS +// +// MessageText: +// +// A node is in the process of joining the cluster. +// +#define STATUS_CLUSTER_JOIN_IN_PROGRESS ((NTSTATUS)0xC0130003L) + +// +// MessageId: STATUS_CLUSTER_NODE_NOT_FOUND +// +// MessageText: +// +// The cluster node was not found. +// +#define STATUS_CLUSTER_NODE_NOT_FOUND ((NTSTATUS)0xC0130004L) + +// +// MessageId: STATUS_CLUSTER_LOCAL_NODE_NOT_FOUND +// +// MessageText: +// +// The cluster local node information was not found. +// +#define STATUS_CLUSTER_LOCAL_NODE_NOT_FOUND ((NTSTATUS)0xC0130005L) + +// +// MessageId: STATUS_CLUSTER_NETWORK_EXISTS +// +// MessageText: +// +// The cluster network already exists. +// +#define STATUS_CLUSTER_NETWORK_EXISTS ((NTSTATUS)0xC0130006L) + +// +// MessageId: STATUS_CLUSTER_NETWORK_NOT_FOUND +// +// MessageText: +// +// The cluster network was not found. +// +#define STATUS_CLUSTER_NETWORK_NOT_FOUND ((NTSTATUS)0xC0130007L) + +// +// MessageId: STATUS_CLUSTER_NETINTERFACE_EXISTS +// +// MessageText: +// +// The cluster network interface already exists. +// +#define STATUS_CLUSTER_NETINTERFACE_EXISTS ((NTSTATUS)0xC0130008L) + +// +// MessageId: STATUS_CLUSTER_NETINTERFACE_NOT_FOUND +// +// MessageText: +// +// The cluster network interface was not found. +// +#define STATUS_CLUSTER_NETINTERFACE_NOT_FOUND ((NTSTATUS)0xC0130009L) + +// +// MessageId: STATUS_CLUSTER_INVALID_REQUEST +// +// MessageText: +// +// The cluster request is not valid for this object. +// +#define STATUS_CLUSTER_INVALID_REQUEST ((NTSTATUS)0xC013000AL) + +// +// MessageId: STATUS_CLUSTER_INVALID_NETWORK_PROVIDER +// +// MessageText: +// +// The cluster network provider is not valid. +// +#define STATUS_CLUSTER_INVALID_NETWORK_PROVIDER ((NTSTATUS)0xC013000BL) + +// +// MessageId: STATUS_CLUSTER_NODE_DOWN +// +// MessageText: +// +// The cluster node is down. +// +#define STATUS_CLUSTER_NODE_DOWN ((NTSTATUS)0xC013000CL) + +// +// MessageId: STATUS_CLUSTER_NODE_UNREACHABLE +// +// MessageText: +// +// The cluster node is not reachable. +// +#define STATUS_CLUSTER_NODE_UNREACHABLE ((NTSTATUS)0xC013000DL) + +// +// MessageId: STATUS_CLUSTER_NODE_NOT_MEMBER +// +// MessageText: +// +// The cluster node is not a member of the cluster. +// +#define STATUS_CLUSTER_NODE_NOT_MEMBER ((NTSTATUS)0xC013000EL) + +// +// MessageId: STATUS_CLUSTER_JOIN_NOT_IN_PROGRESS +// +// MessageText: +// +// A cluster join operation is not in progress. +// +#define STATUS_CLUSTER_JOIN_NOT_IN_PROGRESS ((NTSTATUS)0xC013000FL) + +// +// MessageId: STATUS_CLUSTER_INVALID_NETWORK +// +// MessageText: +// +// The cluster network is not valid. +// +#define STATUS_CLUSTER_INVALID_NETWORK ((NTSTATUS)0xC0130010L) + +// +// MessageId: STATUS_CLUSTER_NO_NET_ADAPTERS +// +// MessageText: +// +// No network adapters are available. +// +#define STATUS_CLUSTER_NO_NET_ADAPTERS ((NTSTATUS)0xC0130011L) + +// +// MessageId: STATUS_CLUSTER_NODE_UP +// +// MessageText: +// +// The cluster node is up. +// +#define STATUS_CLUSTER_NODE_UP ((NTSTATUS)0xC0130012L) + +// +// MessageId: STATUS_CLUSTER_NODE_PAUSED +// +// MessageText: +// +// The cluster node is paused. +// +#define STATUS_CLUSTER_NODE_PAUSED ((NTSTATUS)0xC0130013L) + +// +// MessageId: STATUS_CLUSTER_NODE_NOT_PAUSED +// +// MessageText: +// +// The cluster node is not paused. +// +#define STATUS_CLUSTER_NODE_NOT_PAUSED ((NTSTATUS)0xC0130014L) + +// +// MessageId: STATUS_CLUSTER_NO_SECURITY_CONTEXT +// +// MessageText: +// +// No cluster security context is available. +// +#define STATUS_CLUSTER_NO_SECURITY_CONTEXT ((NTSTATUS)0xC0130015L) + +// +// MessageId: STATUS_CLUSTER_NETWORK_NOT_INTERNAL +// +// MessageText: +// +// The cluster network is not configured for internal cluster communication. +// +#define STATUS_CLUSTER_NETWORK_NOT_INTERNAL ((NTSTATUS)0xC0130016L) + +// +// MessageId: STATUS_CLUSTER_POISONED +// +// MessageText: +// +// The cluster node has been poisoned. +// +#define STATUS_CLUSTER_POISONED ((NTSTATUS)0xC0130017L) + +// +// MessageId: STATUS_CLUSTER_NON_CSV_PATH +// +// MessageText: +// +// The path does not belong to a cluster shared volume. +// +#define STATUS_CLUSTER_NON_CSV_PATH ((NTSTATUS)0xC0130018L) + +// +// MessageId: STATUS_CLUSTER_CSV_VOLUME_NOT_LOCAL +// +// MessageText: +// +// The cluster shared volume is not locally mounted. +// +#define STATUS_CLUSTER_CSV_VOLUME_NOT_LOCAL ((NTSTATUS)0xC0130019L) + +// +// MessageId: STATUS_CLUSTER_CSV_READ_OPLOCK_BREAK_IN_PROGRESS +// +// MessageText: +// +// The operation has failed because read oplock break is in progress. +// +#define STATUS_CLUSTER_CSV_READ_OPLOCK_BREAK_IN_PROGRESS ((NTSTATUS)0xC0130020L) + +// +// MessageId: STATUS_CLUSTER_CSV_AUTO_PAUSE_ERROR +// +// MessageText: +// +// The operation has failed. CSVFS has to pause and refresh information. +// +#define STATUS_CLUSTER_CSV_AUTO_PAUSE_ERROR ((NTSTATUS)0xC0130021L) + +// +// MessageId: STATUS_CLUSTER_CSV_REDIRECTED +// +// MessageText: +// +// The operation has failed. CSVFS does not allow block i/o in redirected mode. +// +#define STATUS_CLUSTER_CSV_REDIRECTED ((NTSTATUS)0xC0130022L) + +// +// MessageId: STATUS_CLUSTER_CSV_NOT_REDIRECTED +// +// MessageText: +// +// The operation has failed. CSVFS is not in redirected mode. +// +#define STATUS_CLUSTER_CSV_NOT_REDIRECTED ((NTSTATUS)0xC0130023L) + +// +// MessageId: STATUS_CLUSTER_CSV_VOLUME_DRAINING +// +// MessageText: +// +// CSVFS is failing operation because it is in draining state. +// +#define STATUS_CLUSTER_CSV_VOLUME_DRAINING ((NTSTATUS)0xC0130024L) + +// +// MessageId: STATUS_CLUSTER_CSV_SNAPSHOT_CREATION_IN_PROGRESS +// +// MessageText: +// +// The operation has failed because snapshot creation is in progress. +// +#define STATUS_CLUSTER_CSV_SNAPSHOT_CREATION_IN_PROGRESS ((NTSTATUS)0xC0130025L) + +// +// MessageId: STATUS_CLUSTER_CSV_VOLUME_DRAINING_SUCCEEDED_DOWNLEVEL +// +// MessageText: +// +// The operation has succeeded on the down level file system, but CSV is failing it because it is in draining state. +// +#define STATUS_CLUSTER_CSV_VOLUME_DRAINING_SUCCEEDED_DOWNLEVEL ((NTSTATUS)0xC0130026L) + +// +// MessageId: STATUS_CLUSTER_CSV_NO_SNAPSHOTS +// +// MessageText: +// +// Volsnap on the coordinating node returned an error indicating that there is no snapshots on this volume. +// +#define STATUS_CLUSTER_CSV_NO_SNAPSHOTS ((NTSTATUS)0xC0130027L) + +// +// MessageId: STATUS_CSV_IO_PAUSE_TIMEOUT +// +// MessageText: +// +// The operation has failed because CSV volume was not able to recover in time specified on this file object. +// +#define STATUS_CSV_IO_PAUSE_TIMEOUT ((NTSTATUS)0xC0130028L) + +// +// MessageId: STATUS_CLUSTER_CSV_INVALID_HANDLE +// +// MessageText: +// +// The operation has failed because CSV has invalidated this file object. +// +#define STATUS_CLUSTER_CSV_INVALID_HANDLE ((NTSTATUS)0xC0130029L) + +// +// MessageId: STATUS_CLUSTER_CSV_SUPPORTED_ONLY_ON_COORDINATOR +// +// MessageText: +// +// This operation is supported only on the CSV coordinator node. +// +#define STATUS_CLUSTER_CSV_SUPPORTED_ONLY_ON_COORDINATOR ((NTSTATUS)0xC0130030L) + +// +// MessageId: STATUS_CLUSTER_CAM_TICKET_REPLAY_DETECTED +// +// MessageText: +// +// Cluster CAM has detected that someone is trying to replay ticket. +// +#define STATUS_CLUSTER_CAM_TICKET_REPLAY_DETECTED ((NTSTATUS)0xC0130031L) + + +// +// Transaction Manager error values +// + +// +// MessageId: STATUS_TRANSACTIONAL_CONFLICT +// +// MessageText: +// +// The function attempted to use a name that is reserved for use by another transaction. +// +#define STATUS_TRANSACTIONAL_CONFLICT ((NTSTATUS)0xC0190001L) + +// +// MessageId: STATUS_INVALID_TRANSACTION +// +// MessageText: +// +// The transaction handle associated with this operation is not valid. +// +#define STATUS_INVALID_TRANSACTION ((NTSTATUS)0xC0190002L) + +// +// MessageId: STATUS_TRANSACTION_NOT_ACTIVE +// +// MessageText: +// +// The requested operation was made in the context of a transaction that is no longer active. +// +#define STATUS_TRANSACTION_NOT_ACTIVE ((NTSTATUS)0xC0190003L) + +// +// MessageId: STATUS_TM_INITIALIZATION_FAILED +// +// MessageText: +// +// The Transaction Manager was unable to be successfully initialized. Transacted operations are not supported. +// +#define STATUS_TM_INITIALIZATION_FAILED ((NTSTATUS)0xC0190004L) + +// +// MessageId: STATUS_RM_NOT_ACTIVE +// +// MessageText: +// +// Transaction support within the specified resource manager is not started or was shut down due to an error. +// +#define STATUS_RM_NOT_ACTIVE ((NTSTATUS)0xC0190005L) + +// +// MessageId: STATUS_RM_METADATA_CORRUPT +// +// MessageText: +// +// The metadata of the RM has been corrupted. The RM will not function. +// +#define STATUS_RM_METADATA_CORRUPT ((NTSTATUS)0xC0190006L) + +// +// MessageId: STATUS_TRANSACTION_NOT_JOINED +// +// MessageText: +// +// The resource manager has attempted to prepare a transaction that it has not successfully joined. +// +#define STATUS_TRANSACTION_NOT_JOINED ((NTSTATUS)0xC0190007L) + +// +// MessageId: STATUS_DIRECTORY_NOT_RM +// +// MessageText: +// +// The specified directory does not contain a file system resource manager. +// +#define STATUS_DIRECTORY_NOT_RM ((NTSTATUS)0xC0190008L) + +// +// MessageId: STATUS_COULD_NOT_RESIZE_LOG +// +// MessageText: +// +// The log could not be set to the requested size. +// +#define STATUS_COULD_NOT_RESIZE_LOG ((NTSTATUS)0x80190009L) + +// +// MessageId: STATUS_TRANSACTIONS_UNSUPPORTED_REMOTE +// +// MessageText: +// +// The remote server or share does not support transacted file operations. +// +#define STATUS_TRANSACTIONS_UNSUPPORTED_REMOTE ((NTSTATUS)0xC019000AL) + +// +// MessageId: STATUS_LOG_RESIZE_INVALID_SIZE +// +// MessageText: +// +// The requested log size for the file system resource manager is invalid. +// +#define STATUS_LOG_RESIZE_INVALID_SIZE ((NTSTATUS)0xC019000BL) + +// +// MessageId: STATUS_REMOTE_FILE_VERSION_MISMATCH +// +// MessageText: +// +// The remote server sent mismatching version number or Fid for a file opened with transactions. +// +#define STATUS_REMOTE_FILE_VERSION_MISMATCH ((NTSTATUS)0xC019000CL) + +// +// MessageId: STATUS_CRM_PROTOCOL_ALREADY_EXISTS +// +// MessageText: +// +// The RM tried to register a protocol that already exists. +// +#define STATUS_CRM_PROTOCOL_ALREADY_EXISTS ((NTSTATUS)0xC019000FL) + +// +// MessageId: STATUS_TRANSACTION_PROPAGATION_FAILED +// +// MessageText: +// +// The attempt to propagate the Transaction failed. +// +#define STATUS_TRANSACTION_PROPAGATION_FAILED ((NTSTATUS)0xC0190010L) + +// +// MessageId: STATUS_CRM_PROTOCOL_NOT_FOUND +// +// MessageText: +// +// The requested propagation protocol was not registered as a CRM. +// +#define STATUS_CRM_PROTOCOL_NOT_FOUND ((NTSTATUS)0xC0190011L) + +// +// MessageId: STATUS_TRANSACTION_SUPERIOR_EXISTS +// +// MessageText: +// +// The Transaction object already has a superior enlistment, and the caller attempted an operation that would have created a new superior. Only a single superior enlistment is allowed. +// +#define STATUS_TRANSACTION_SUPERIOR_EXISTS ((NTSTATUS)0xC0190012L) + +// +// MessageId: STATUS_TRANSACTION_REQUEST_NOT_VALID +// +// MessageText: +// +// The requested operation is not valid on the Transaction object in its current state. +// +#define STATUS_TRANSACTION_REQUEST_NOT_VALID ((NTSTATUS)0xC0190013L) + +// +// MessageId: STATUS_TRANSACTION_NOT_REQUESTED +// +// MessageText: +// +// The caller has called a response API, but the response is not expected because the TM did not issue the corresponding request to the caller. +// +#define STATUS_TRANSACTION_NOT_REQUESTED ((NTSTATUS)0xC0190014L) + +// +// MessageId: STATUS_TRANSACTION_ALREADY_ABORTED +// +// MessageText: +// +// It is too late to perform the requested operation, since the Transaction has already been aborted. +// +#define STATUS_TRANSACTION_ALREADY_ABORTED ((NTSTATUS)0xC0190015L) + +// +// MessageId: STATUS_TRANSACTION_ALREADY_COMMITTED +// +// MessageText: +// +// It is too late to perform the requested operation, since the Transaction has already been committed. +// +#define STATUS_TRANSACTION_ALREADY_COMMITTED ((NTSTATUS)0xC0190016L) + +// +// MessageId: STATUS_TRANSACTION_INVALID_MARSHALL_BUFFER +// +// MessageText: +// +// The buffer passed in to NtPushTransaction or NtPullTransaction is not in a valid format. +// +#define STATUS_TRANSACTION_INVALID_MARSHALL_BUFFER ((NTSTATUS)0xC0190017L) + +// +// MessageId: STATUS_CURRENT_TRANSACTION_NOT_VALID +// +// MessageText: +// +// The current transaction context associated with the thread is not a valid handle to a transaction object. +// +#define STATUS_CURRENT_TRANSACTION_NOT_VALID ((NTSTATUS)0xC0190018L) + +// +// MessageId: STATUS_LOG_GROWTH_FAILED +// +// MessageText: +// +// An attempt to create space in the transactional resource manager's log failed. The failure status has been recorded in the event log. +// +#define STATUS_LOG_GROWTH_FAILED ((NTSTATUS)0xC0190019L) + +// +// MessageId: STATUS_OBJECT_NO_LONGER_EXISTS +// +// MessageText: +// +// The object (file, stream, link) corresponding to the handle has been deleted by a transaction savepoint rollback. +// +#define STATUS_OBJECT_NO_LONGER_EXISTS ((NTSTATUS)0xC0190021L) + +// +// MessageId: STATUS_STREAM_MINIVERSION_NOT_FOUND +// +// MessageText: +// +// The specified file miniversion was not found for this transacted file open. +// +#define STATUS_STREAM_MINIVERSION_NOT_FOUND ((NTSTATUS)0xC0190022L) + +// +// MessageId: STATUS_STREAM_MINIVERSION_NOT_VALID +// +// MessageText: +// +// The specified file miniversion was found but has been invalidated. Most likely cause is a transaction savepoint rollback. +// +#define STATUS_STREAM_MINIVERSION_NOT_VALID ((NTSTATUS)0xC0190023L) + +// +// MessageId: STATUS_MINIVERSION_INACCESSIBLE_FROM_SPECIFIED_TRANSACTION +// +// MessageText: +// +// A miniversion may only be opened in the context of the transaction that created it. +// +#define STATUS_MINIVERSION_INACCESSIBLE_FROM_SPECIFIED_TRANSACTION ((NTSTATUS)0xC0190024L) + +// +// MessageId: STATUS_CANT_OPEN_MINIVERSION_WITH_MODIFY_INTENT +// +// MessageText: +// +// It is not possible to open a miniversion with modify access. +// +#define STATUS_CANT_OPEN_MINIVERSION_WITH_MODIFY_INTENT ((NTSTATUS)0xC0190025L) + +// +// MessageId: STATUS_CANT_CREATE_MORE_STREAM_MINIVERSIONS +// +// MessageText: +// +// It is not possible to create any more miniversions for this stream. +// +#define STATUS_CANT_CREATE_MORE_STREAM_MINIVERSIONS ((NTSTATUS)0xC0190026L) + +// +// MessageId: STATUS_HANDLE_NO_LONGER_VALID +// +// MessageText: +// +// The handle has been invalidated by a transaction. The most likely cause is the presence of memory mapping on a file or an open handle when the transaction ended or rolled back to savepoint. +// +#define STATUS_HANDLE_NO_LONGER_VALID ((NTSTATUS)0xC0190028L) + +// +// MessageId: STATUS_NO_TXF_METADATA +// +// MessageText: +// +// There is no transaction metadata on the file. +// +#define STATUS_NO_TXF_METADATA ((NTSTATUS)0x80190029L) + +// +// MessageId: STATUS_LOG_CORRUPTION_DETECTED +// +// MessageText: +// +// The log data is corrupt. +// +#define STATUS_LOG_CORRUPTION_DETECTED ((NTSTATUS)0xC0190030L) + +// +// MessageId: STATUS_CANT_RECOVER_WITH_HANDLE_OPEN +// +// MessageText: +// +// The file can't be recovered because there is a handle still open on it. +// +#define STATUS_CANT_RECOVER_WITH_HANDLE_OPEN ((NTSTATUS)0x80190031L) + +// +// MessageId: STATUS_RM_DISCONNECTED +// +// MessageText: +// +// The transaction outcome is unavailable because the resource manager responsible for it has disconnected. +// +#define STATUS_RM_DISCONNECTED ((NTSTATUS)0xC0190032L) + +// +// MessageId: STATUS_ENLISTMENT_NOT_SUPERIOR +// +// MessageText: +// +// The request was rejected because the enlistment in question is not a superior enlistment. +// +#define STATUS_ENLISTMENT_NOT_SUPERIOR ((NTSTATUS)0xC0190033L) + +// +// MessageId: STATUS_RECOVERY_NOT_NEEDED +// +// MessageText: +// +// The transactional resource manager is already consistent. Recovery is not needed. +// +#define STATUS_RECOVERY_NOT_NEEDED ((NTSTATUS)0x40190034L) + +// +// MessageId: STATUS_RM_ALREADY_STARTED +// +// MessageText: +// +// The transactional resource manager has already been started. +// +#define STATUS_RM_ALREADY_STARTED ((NTSTATUS)0x40190035L) + +// +// MessageId: STATUS_FILE_IDENTITY_NOT_PERSISTENT +// +// MessageText: +// +// The file cannot be opened transactionally, because its identity depends on the outcome of an unresolved transaction. +// +#define STATUS_FILE_IDENTITY_NOT_PERSISTENT ((NTSTATUS)0xC0190036L) + +// +// MessageId: STATUS_CANT_BREAK_TRANSACTIONAL_DEPENDENCY +// +// MessageText: +// +// The operation cannot be performed because another transaction is depending on the fact that this property will not change. +// +#define STATUS_CANT_BREAK_TRANSACTIONAL_DEPENDENCY ((NTSTATUS)0xC0190037L) + +// +// MessageId: STATUS_CANT_CROSS_RM_BOUNDARY +// +// MessageText: +// +// The operation would involve a single file with two transactional resource managers and is therefore not allowed. +// +#define STATUS_CANT_CROSS_RM_BOUNDARY ((NTSTATUS)0xC0190038L) + +// +// MessageId: STATUS_TXF_DIR_NOT_EMPTY +// +// MessageText: +// +// The $Txf directory must be empty for this operation to succeed. +// +#define STATUS_TXF_DIR_NOT_EMPTY ((NTSTATUS)0xC0190039L) + +// +// MessageId: STATUS_INDOUBT_TRANSACTIONS_EXIST +// +// MessageText: +// +// The operation would leave a transactional resource manager in an inconsistent state and is therefore not allowed. +// +#define STATUS_INDOUBT_TRANSACTIONS_EXIST ((NTSTATUS)0xC019003AL) + +// +// MessageId: STATUS_TM_VOLATILE +// +// MessageText: +// +// The operation could not be completed because the transaction manager does not have a log. +// +#define STATUS_TM_VOLATILE ((NTSTATUS)0xC019003BL) + +// +// MessageId: STATUS_ROLLBACK_TIMER_EXPIRED +// +// MessageText: +// +// A rollback could not be scheduled because a previously scheduled rollback has already executed or been queued for execution. +// +#define STATUS_ROLLBACK_TIMER_EXPIRED ((NTSTATUS)0xC019003CL) + +// +// MessageId: STATUS_TXF_ATTRIBUTE_CORRUPT +// +// MessageText: +// +// The transactional metadata attribute on the file or directory %hs is corrupt and unreadable. +// +#define STATUS_TXF_ATTRIBUTE_CORRUPT ((NTSTATUS)0xC019003DL) + +// +// MessageId: STATUS_EFS_NOT_ALLOWED_IN_TRANSACTION +// +// MessageText: +// +// The encryption operation could not be completed because a transaction is active. +// +#define STATUS_EFS_NOT_ALLOWED_IN_TRANSACTION ((NTSTATUS)0xC019003EL) + +// +// MessageId: STATUS_TRANSACTIONAL_OPEN_NOT_ALLOWED +// +// MessageText: +// +// This object is not allowed to be opened in a transaction. +// +#define STATUS_TRANSACTIONAL_OPEN_NOT_ALLOWED ((NTSTATUS)0xC019003FL) + +// +// MessageId: STATUS_TRANSACTED_MAPPING_UNSUPPORTED_REMOTE +// +// MessageText: +// +// Memory mapping (creating a mapped section) a remote file under a transaction is not supported. +// +#define STATUS_TRANSACTED_MAPPING_UNSUPPORTED_REMOTE ((NTSTATUS)0xC0190040L) + +// +// MessageId: STATUS_TXF_METADATA_ALREADY_PRESENT +// +// MessageText: +// +// Transaction metadata is already present on this file and cannot be superseded. +// +#define STATUS_TXF_METADATA_ALREADY_PRESENT ((NTSTATUS)0x80190041L) + +// +// MessageId: STATUS_TRANSACTION_SCOPE_CALLBACKS_NOT_SET +// +// MessageText: +// +// A transaction scope could not be entered because the scope handler has not been initialized. +// +#define STATUS_TRANSACTION_SCOPE_CALLBACKS_NOT_SET ((NTSTATUS)0x80190042L) + +// +// MessageId: STATUS_TRANSACTION_REQUIRED_PROMOTION +// +// MessageText: +// +// Promotion was required in order to allow the resource manager to enlist, but the transaction was set to disallow it. +// +#define STATUS_TRANSACTION_REQUIRED_PROMOTION ((NTSTATUS)0xC0190043L) + +// +// MessageId: STATUS_CANNOT_EXECUTE_FILE_IN_TRANSACTION +// +// MessageText: +// +// This file is open for modification in an unresolved transaction and may be opened for execute only by a transacted reader. +// +#define STATUS_CANNOT_EXECUTE_FILE_IN_TRANSACTION ((NTSTATUS)0xC0190044L) + +// +// MessageId: STATUS_TRANSACTIONS_NOT_FROZEN +// +// MessageText: +// +// The request to thaw frozen transactions was ignored because transactions had not previously been frozen. +// +#define STATUS_TRANSACTIONS_NOT_FROZEN ((NTSTATUS)0xC0190045L) + +// +// MessageId: STATUS_TRANSACTION_FREEZE_IN_PROGRESS +// +// MessageText: +// +// Transactions cannot be frozen because a freeze is already in progress. +// +#define STATUS_TRANSACTION_FREEZE_IN_PROGRESS ((NTSTATUS)0xC0190046L) + +// +// MessageId: STATUS_NOT_SNAPSHOT_VOLUME +// +// MessageText: +// +// The target volume is not a snapshot volume. This operation is only valid on a volume mounted as a snapshot. +// +#define STATUS_NOT_SNAPSHOT_VOLUME ((NTSTATUS)0xC0190047L) + +// +// MessageId: STATUS_NO_SAVEPOINT_WITH_OPEN_FILES +// +// MessageText: +// +// The savepoint operation failed because files are open on the transaction. This is not permitted. +// +#define STATUS_NO_SAVEPOINT_WITH_OPEN_FILES ((NTSTATUS)0xC0190048L) + +// +// MessageId: STATUS_SPARSE_NOT_ALLOWED_IN_TRANSACTION +// +// MessageText: +// +// The sparse operation could not be completed because a transaction is active on the file. +// +#define STATUS_SPARSE_NOT_ALLOWED_IN_TRANSACTION ((NTSTATUS)0xC0190049L) + +// +// MessageId: STATUS_TM_IDENTITY_MISMATCH +// +// MessageText: +// +// The call to create a TransactionManager object failed because the Tm Identity stored in the logfile does not match the Tm Identity that was passed in as an argument. +// +#define STATUS_TM_IDENTITY_MISMATCH ((NTSTATUS)0xC019004AL) + +// +// MessageId: STATUS_FLOATED_SECTION +// +// MessageText: +// +// I/O was attempted on a section object that has been floated as a result of a transaction ending. There is no valid data. +// +#define STATUS_FLOATED_SECTION ((NTSTATUS)0xC019004BL) + +// +// MessageId: STATUS_CANNOT_ACCEPT_TRANSACTED_WORK +// +// MessageText: +// +// The transactional resource manager cannot currently accept transacted work due to a transient condition such as low resources. +// +#define STATUS_CANNOT_ACCEPT_TRANSACTED_WORK ((NTSTATUS)0xC019004CL) + +// +// MessageId: STATUS_CANNOT_ABORT_TRANSACTIONS +// +// MessageText: +// +// The transactional resource manager had too many transactions outstanding that could not be aborted. The transactional resource manger has been shut down. +// +#define STATUS_CANNOT_ABORT_TRANSACTIONS ((NTSTATUS)0xC019004DL) + +// +// MessageId: STATUS_TRANSACTION_NOT_FOUND +// +// MessageText: +// +// The specified Transaction was unable to be opened, because it was not found. +// +#define STATUS_TRANSACTION_NOT_FOUND ((NTSTATUS)0xC019004EL) + +// +// MessageId: STATUS_RESOURCEMANAGER_NOT_FOUND +// +// MessageText: +// +// The specified ResourceManager was unable to be opened, because it was not found. +// +#define STATUS_RESOURCEMANAGER_NOT_FOUND ((NTSTATUS)0xC019004FL) + +// +// MessageId: STATUS_ENLISTMENT_NOT_FOUND +// +// MessageText: +// +// The specified Enlistment was unable to be opened, because it was not found. +// +#define STATUS_ENLISTMENT_NOT_FOUND ((NTSTATUS)0xC0190050L) + +// +// MessageId: STATUS_TRANSACTIONMANAGER_NOT_FOUND +// +// MessageText: +// +// The specified TransactionManager was unable to be opened, because it was not found. +// +#define STATUS_TRANSACTIONMANAGER_NOT_FOUND ((NTSTATUS)0xC0190051L) + +// +// MessageId: STATUS_TRANSACTIONMANAGER_NOT_ONLINE +// +// MessageText: +// +// The object specified could not be created or opened, because its associated TransactionManager is not online. The TransactionManager must be brought fully Online by calling RecoverTransactionManager to recover to the end of its LogFile before objects in its Transaction or ResourceManager namespaces can be opened. In addition, errors in writing records to its LogFile can cause a TransactionManager to go offline. +// +#define STATUS_TRANSACTIONMANAGER_NOT_ONLINE ((NTSTATUS)0xC0190052L) + +// +// MessageId: STATUS_TRANSACTIONMANAGER_RECOVERY_NAME_COLLISION +// +// MessageText: +// +// The specified TransactionManager was unable to create the objects contained in its logfile in the Ob namespace. Therefore, the TransactionManager was unable to recover. +// +#define STATUS_TRANSACTIONMANAGER_RECOVERY_NAME_COLLISION ((NTSTATUS)0xC0190053L) + +// +// MessageId: STATUS_TRANSACTION_NOT_ROOT +// +// MessageText: +// +// The call to create a superior Enlistment on this Transaction object could not be completed, because the Transaction object specified for the enlistment is a subordinate branch of the Transaction. Only the root of the Transaction can be enlisted on as a superior. +// +#define STATUS_TRANSACTION_NOT_ROOT ((NTSTATUS)0xC0190054L) + +// +// MessageId: STATUS_TRANSACTION_OBJECT_EXPIRED +// +// MessageText: +// +// Because the associated transaction manager or resource manager has been closed, the handle is no longer valid. +// +#define STATUS_TRANSACTION_OBJECT_EXPIRED ((NTSTATUS)0xC0190055L) + +// +// MessageId: STATUS_COMPRESSION_NOT_ALLOWED_IN_TRANSACTION +// +// MessageText: +// +// The compression operation could not be completed because a transaction is active on the file. +// +#define STATUS_COMPRESSION_NOT_ALLOWED_IN_TRANSACTION ((NTSTATUS)0xC0190056L) + +// +// MessageId: STATUS_TRANSACTION_RESPONSE_NOT_ENLISTED +// +// MessageText: +// +// The specified operation could not be performed on this Superior enlistment, because the enlistment was not created with the corresponding completion response in the NotificationMask. +// +#define STATUS_TRANSACTION_RESPONSE_NOT_ENLISTED ((NTSTATUS)0xC0190057L) + +// +// MessageId: STATUS_TRANSACTION_RECORD_TOO_LONG +// +// MessageText: +// +// The specified operation could not be performed, because the record that would be logged was too long. This can occur because of two conditions: either there are too many Enlistments on this Transaction, or the combined RecoveryInformation being logged on behalf of those Enlistments is too long. +// +#define STATUS_TRANSACTION_RECORD_TOO_LONG ((NTSTATUS)0xC0190058L) + +// +// MessageId: STATUS_NO_LINK_TRACKING_IN_TRANSACTION +// +// MessageText: +// +// The link tracking operation could not be completed because a transaction is active. +// +#define STATUS_NO_LINK_TRACKING_IN_TRANSACTION ((NTSTATUS)0xC0190059L) + +// +// MessageId: STATUS_OPERATION_NOT_SUPPORTED_IN_TRANSACTION +// +// MessageText: +// +// This operation cannot be performed in a transaction. +// +#define STATUS_OPERATION_NOT_SUPPORTED_IN_TRANSACTION ((NTSTATUS)0xC019005AL) + +// +// MessageId: STATUS_TRANSACTION_INTEGRITY_VIOLATED +// +// MessageText: +// +// The kernel transaction manager had to abort or forget the transaction because it blocked forward progress. +// +#define STATUS_TRANSACTION_INTEGRITY_VIOLATED ((NTSTATUS)0xC019005BL) + +// +// MessageId: STATUS_TRANSACTIONMANAGER_IDENTITY_MISMATCH +// +// MessageText: +// +// The TransactionManager identity that was supplied did not match the one recorded in the TransactionManager's log file. +// +#define STATUS_TRANSACTIONMANAGER_IDENTITY_MISMATCH ((NTSTATUS)0xC019005CL) + +// +// MessageId: STATUS_RM_CANNOT_BE_FROZEN_FOR_SNAPSHOT +// +// MessageText: +// +// This snapshot operation cannot continue because a transactional resource manager cannot be frozen in its current state. Please try again. +// +#define STATUS_RM_CANNOT_BE_FROZEN_FOR_SNAPSHOT ((NTSTATUS)0xC019005DL) + +// +// MessageId: STATUS_TRANSACTION_MUST_WRITETHROUGH +// +// MessageText: +// +// The transaction cannot be enlisted on with the specified EnlistmentMask, because the transaction has already completed the PrePrepare phase. In order to ensure correctness, the ResourceManager must switch to a write-through mode and cease caching data within this transaction. Enlisting for only subsequent transaction phases may still succeed. +// +#define STATUS_TRANSACTION_MUST_WRITETHROUGH ((NTSTATUS)0xC019005EL) + +// +// MessageId: STATUS_TRANSACTION_NO_SUPERIOR +// +// MessageText: +// +// The transaction does not have a superior enlistment. +// +#define STATUS_TRANSACTION_NO_SUPERIOR ((NTSTATUS)0xC019005FL) + +// +// MessageId: STATUS_EXPIRED_HANDLE +// +// MessageText: +// +// The handle is no longer properly associated with its transaction. It may have been opened in a transactional resource manager that was subsequently forced to restart. Please close the handle and open a new one. +// +#define STATUS_EXPIRED_HANDLE ((NTSTATUS)0xC0190060L) + +// +// MessageId: STATUS_TRANSACTION_NOT_ENLISTED +// +// MessageText: +// +// The specified operation could not be performed because the resource manager is not enlisted in the transaction. +// +#define STATUS_TRANSACTION_NOT_ENLISTED ((NTSTATUS)0xC0190061L) + +// +// MessageId: STATUS_ENLISTMENT_NOT_INITIALIZED +// +// MessageText: +// +// The transaction is linked to an enlistment that is not fully initialized yet. +// +#define STATUS_ENLISTMENT_NOT_INITIALIZED ((NTSTATUS)0xC0190062L) + + +// +// CLFS (common log file system) error values +// + +// +// MessageId: STATUS_LOG_SECTOR_INVALID +// +// MessageText: +// +// Log service found an invalid log sector. +// +#define STATUS_LOG_SECTOR_INVALID ((NTSTATUS)0xC01A0001L) + +// +// MessageId: STATUS_LOG_SECTOR_PARITY_INVALID +// +// MessageText: +// +// Log service encountered a log sector with invalid block parity. +// +#define STATUS_LOG_SECTOR_PARITY_INVALID ((NTSTATUS)0xC01A0002L) + +// +// MessageId: STATUS_LOG_SECTOR_REMAPPED +// +// MessageText: +// +// Log service encountered a remapped log sector. +// +#define STATUS_LOG_SECTOR_REMAPPED ((NTSTATUS)0xC01A0003L) + +// +// MessageId: STATUS_LOG_BLOCK_INCOMPLETE +// +// MessageText: +// +// Log service encountered a partial or incomplete log block. +// +#define STATUS_LOG_BLOCK_INCOMPLETE ((NTSTATUS)0xC01A0004L) + +// +// MessageId: STATUS_LOG_INVALID_RANGE +// +// MessageText: +// +// Log service encountered an attempt access data outside the active log range. +// +#define STATUS_LOG_INVALID_RANGE ((NTSTATUS)0xC01A0005L) + +// +// MessageId: STATUS_LOG_BLOCKS_EXHAUSTED +// +// MessageText: +// +// Log service user log marshalling buffers are exhausted. +// +#define STATUS_LOG_BLOCKS_EXHAUSTED ((NTSTATUS)0xC01A0006L) + +// +// MessageId: STATUS_LOG_READ_CONTEXT_INVALID +// +// MessageText: +// +// Log service encountered an attempt read from a marshalling area with an invalid read context. +// +#define STATUS_LOG_READ_CONTEXT_INVALID ((NTSTATUS)0xC01A0007L) + +// +// MessageId: STATUS_LOG_RESTART_INVALID +// +// MessageText: +// +// Log service encountered an invalid log restart area. +// +#define STATUS_LOG_RESTART_INVALID ((NTSTATUS)0xC01A0008L) + +// +// MessageId: STATUS_LOG_BLOCK_VERSION +// +// MessageText: +// +// Log service encountered an invalid log block version. +// +#define STATUS_LOG_BLOCK_VERSION ((NTSTATUS)0xC01A0009L) + +// +// MessageId: STATUS_LOG_BLOCK_INVALID +// +// MessageText: +// +// Log service encountered an invalid log block. +// +#define STATUS_LOG_BLOCK_INVALID ((NTSTATUS)0xC01A000AL) + +// +// MessageId: STATUS_LOG_READ_MODE_INVALID +// +// MessageText: +// +// Log service encountered an attempt to read the log with an invalid read mode. +// +#define STATUS_LOG_READ_MODE_INVALID ((NTSTATUS)0xC01A000BL) + +// +// MessageId: STATUS_LOG_NO_RESTART +// +// MessageText: +// +// Log service encountered a log stream with no restart area. +// +#define STATUS_LOG_NO_RESTART ((NTSTATUS)0x401A000CL) + +// +// MessageId: STATUS_LOG_METADATA_CORRUPT +// +// MessageText: +// +// Log service encountered a corrupted metadata file. +// +#define STATUS_LOG_METADATA_CORRUPT ((NTSTATUS)0xC01A000DL) + +// +// MessageId: STATUS_LOG_METADATA_INVALID +// +// MessageText: +// +// Log service encountered a metadata file that could not be created by the log file system. +// +#define STATUS_LOG_METADATA_INVALID ((NTSTATUS)0xC01A000EL) + +// +// MessageId: STATUS_LOG_METADATA_INCONSISTENT +// +// MessageText: +// +// Log service encountered a metadata file with inconsistent data. +// +#define STATUS_LOG_METADATA_INCONSISTENT ((NTSTATUS)0xC01A000FL) + +// +// MessageId: STATUS_LOG_RESERVATION_INVALID +// +// MessageText: +// +// Log service encountered an attempt to erroneously allocate or dispose reservation space. +// +#define STATUS_LOG_RESERVATION_INVALID ((NTSTATUS)0xC01A0010L) + +// +// MessageId: STATUS_LOG_CANT_DELETE +// +// MessageText: +// +// Log service cannot delete log file or file system container. +// +#define STATUS_LOG_CANT_DELETE ((NTSTATUS)0xC01A0011L) + +// +// MessageId: STATUS_LOG_CONTAINER_LIMIT_EXCEEDED +// +// MessageText: +// +// Log service has reached the maximum allowable containers allocated to a log file. +// +#define STATUS_LOG_CONTAINER_LIMIT_EXCEEDED ((NTSTATUS)0xC01A0012L) + +// +// MessageId: STATUS_LOG_START_OF_LOG +// +// MessageText: +// +// Log service has attempted to read or write backwards past the start of the log. +// +#define STATUS_LOG_START_OF_LOG ((NTSTATUS)0xC01A0013L) + +// +// MessageId: STATUS_LOG_POLICY_ALREADY_INSTALLED +// +// MessageText: +// +// Log policy could not be installed because a policy of the same type is already present. +// +#define STATUS_LOG_POLICY_ALREADY_INSTALLED ((NTSTATUS)0xC01A0014L) + +// +// MessageId: STATUS_LOG_POLICY_NOT_INSTALLED +// +// MessageText: +// +// Log policy in question was not installed at the time of the request. +// +#define STATUS_LOG_POLICY_NOT_INSTALLED ((NTSTATUS)0xC01A0015L) + +// +// MessageId: STATUS_LOG_POLICY_INVALID +// +// MessageText: +// +// The installed set of policies on the log is invalid. +// +#define STATUS_LOG_POLICY_INVALID ((NTSTATUS)0xC01A0016L) + +// +// MessageId: STATUS_LOG_POLICY_CONFLICT +// +// MessageText: +// +// A policy on the log in question prevented the operation from completing. +// +#define STATUS_LOG_POLICY_CONFLICT ((NTSTATUS)0xC01A0017L) + +// +// MessageId: STATUS_LOG_PINNED_ARCHIVE_TAIL +// +// MessageText: +// +// Log space cannot be reclaimed because the log is pinned by the archive tail. +// +#define STATUS_LOG_PINNED_ARCHIVE_TAIL ((NTSTATUS)0xC01A0018L) + +// +// MessageId: STATUS_LOG_RECORD_NONEXISTENT +// +// MessageText: +// +// Log record is not a record in the log file. +// +#define STATUS_LOG_RECORD_NONEXISTENT ((NTSTATUS)0xC01A0019L) + +// +// MessageId: STATUS_LOG_RECORDS_RESERVED_INVALID +// +// MessageText: +// +// Number of reserved log records or the adjustment of the number of reserved log records is invalid. +// +#define STATUS_LOG_RECORDS_RESERVED_INVALID ((NTSTATUS)0xC01A001AL) + +// +// MessageId: STATUS_LOG_SPACE_RESERVED_INVALID +// +// MessageText: +// +// Reserved log space or the adjustment of the log space is invalid. +// +#define STATUS_LOG_SPACE_RESERVED_INVALID ((NTSTATUS)0xC01A001BL) + +// +// MessageId: STATUS_LOG_TAIL_INVALID +// +// MessageText: +// +// A new or existing archive tail or base of the active log is invalid. +// +#define STATUS_LOG_TAIL_INVALID ((NTSTATUS)0xC01A001CL) + +// +// MessageId: STATUS_LOG_FULL +// +// MessageText: +// +// Log space is exhausted. +// +#define STATUS_LOG_FULL ((NTSTATUS)0xC01A001DL) + +// +// MessageId: STATUS_LOG_MULTIPLEXED +// +// MessageText: +// +// Log is multiplexed, no direct writes to the physical log is allowed. +// +#define STATUS_LOG_MULTIPLEXED ((NTSTATUS)0xC01A001EL) + +// +// MessageId: STATUS_LOG_DEDICATED +// +// MessageText: +// +// The operation failed because the log is a dedicated log. +// +#define STATUS_LOG_DEDICATED ((NTSTATUS)0xC01A001FL) + +// +// MessageId: STATUS_LOG_ARCHIVE_NOT_IN_PROGRESS +// +// MessageText: +// +// The operation requires an archive context. +// +#define STATUS_LOG_ARCHIVE_NOT_IN_PROGRESS ((NTSTATUS)0xC01A0020L) + +// +// MessageId: STATUS_LOG_ARCHIVE_IN_PROGRESS +// +// MessageText: +// +// Log archival is in progress. +// +#define STATUS_LOG_ARCHIVE_IN_PROGRESS ((NTSTATUS)0xC01A0021L) + +// +// MessageId: STATUS_LOG_EPHEMERAL +// +// MessageText: +// +// The operation requires a non-ephemeral log, but the log is ephemeral. +// +#define STATUS_LOG_EPHEMERAL ((NTSTATUS)0xC01A0022L) + +// +// MessageId: STATUS_LOG_NOT_ENOUGH_CONTAINERS +// +// MessageText: +// +// The log must have at least two containers before it can be read from or written to. +// +#define STATUS_LOG_NOT_ENOUGH_CONTAINERS ((NTSTATUS)0xC01A0023L) + +// +// MessageId: STATUS_LOG_CLIENT_ALREADY_REGISTERED +// +// MessageText: +// +// A log client has already registered on the stream. +// +#define STATUS_LOG_CLIENT_ALREADY_REGISTERED ((NTSTATUS)0xC01A0024L) + +// +// MessageId: STATUS_LOG_CLIENT_NOT_REGISTERED +// +// MessageText: +// +// A log client has not been registered on the stream. +// +#define STATUS_LOG_CLIENT_NOT_REGISTERED ((NTSTATUS)0xC01A0025L) + +// +// MessageId: STATUS_LOG_FULL_HANDLER_IN_PROGRESS +// +// MessageText: +// +// A request has already been made to handle the log full condition. +// +#define STATUS_LOG_FULL_HANDLER_IN_PROGRESS ((NTSTATUS)0xC01A0026L) + +// +// MessageId: STATUS_LOG_CONTAINER_READ_FAILED +// +// MessageText: +// +// Log service encountered an error when attempting to read from a log container. +// +#define STATUS_LOG_CONTAINER_READ_FAILED ((NTSTATUS)0xC01A0027L) + +// +// MessageId: STATUS_LOG_CONTAINER_WRITE_FAILED +// +// MessageText: +// +// Log service encountered an error when attempting to write to a log container. +// +#define STATUS_LOG_CONTAINER_WRITE_FAILED ((NTSTATUS)0xC01A0028L) + +// +// MessageId: STATUS_LOG_CONTAINER_OPEN_FAILED +// +// MessageText: +// +// Log service encountered an error when attempting open a log container. +// +#define STATUS_LOG_CONTAINER_OPEN_FAILED ((NTSTATUS)0xC01A0029L) + +// +// MessageId: STATUS_LOG_CONTAINER_STATE_INVALID +// +// MessageText: +// +// Log service encountered an invalid container state when attempting a requested action. +// +#define STATUS_LOG_CONTAINER_STATE_INVALID ((NTSTATUS)0xC01A002AL) + +// +// MessageId: STATUS_LOG_STATE_INVALID +// +// MessageText: +// +// Log service is not in the correct state to perform a requested action. +// +#define STATUS_LOG_STATE_INVALID ((NTSTATUS)0xC01A002BL) + +// +// MessageId: STATUS_LOG_PINNED +// +// MessageText: +// +// Log space cannot be reclaimed because the log is pinned. +// +#define STATUS_LOG_PINNED ((NTSTATUS)0xC01A002CL) + +// +// MessageId: STATUS_LOG_METADATA_FLUSH_FAILED +// +// MessageText: +// +// Log metadata flush failed. +// +#define STATUS_LOG_METADATA_FLUSH_FAILED ((NTSTATUS)0xC01A002DL) + +// +// MessageId: STATUS_LOG_INCONSISTENT_SECURITY +// +// MessageText: +// +// Security on the log and its containers is inconsistent. +// +#define STATUS_LOG_INCONSISTENT_SECURITY ((NTSTATUS)0xC01A002EL) + +// +// MessageId: STATUS_LOG_APPENDED_FLUSH_FAILED +// +// MessageText: +// +// Records were appended to the log or reservation changes were made, but the log could not be flushed. +// +#define STATUS_LOG_APPENDED_FLUSH_FAILED ((NTSTATUS)0xC01A002FL) + +// +// MessageId: STATUS_LOG_PINNED_RESERVATION +// +// MessageText: +// +// The log is pinned due to reservation consuming most of the log space. Free some reserved records to make space available. +// +#define STATUS_LOG_PINNED_RESERVATION ((NTSTATUS)0xC01A0030L) + + +// +// XDDM Video Facility Error codes (videoprt.sys) +// + +// +// MessageId: STATUS_VIDEO_HUNG_DISPLAY_DRIVER_THREAD +// +// MessageText: +// +// {Display Driver Stopped Responding} +// The %hs display driver has stopped working normally. Save your work and reboot the system to restore full display functionality. The next time you reboot the machine a dialog will be displayed giving you a chance to upload data about this failure to Microsoft. +// +#define STATUS_VIDEO_HUNG_DISPLAY_DRIVER_THREAD ((NTSTATUS)0xC01B00EAL) + +// +// MessageId: STATUS_VIDEO_HUNG_DISPLAY_DRIVER_THREAD_RECOVERED +// +// MessageText: +// +// {Display Driver Stopped Responding and recovered} +// The %hs display driver has stopped working normally. The recovery had been performed. +// +#define STATUS_VIDEO_HUNG_DISPLAY_DRIVER_THREAD_RECOVERED ((NTSTATUS)0x801B00EBL) + +// +// MessageId: STATUS_VIDEO_DRIVER_DEBUG_REPORT_REQUEST +// +// MessageText: +// +// {Display Driver Recovered From Failure} +// The %hs display driver has detected and recovered from a failure. Some graphical operations may have failed. The next time you reboot the machine a dialog will be displayed giving you a chance to upload data about this failure to Microsoft. +// +#define STATUS_VIDEO_DRIVER_DEBUG_REPORT_REQUEST ((NTSTATUS)0x401B00ECL) + + +// +// Monitor Facility Error codes (monitor.sys) +// + +// +// MessageId: STATUS_MONITOR_NO_DESCRIPTOR +// +// MessageText: +// +// Monitor descriptor could not be obtained. +// +#define STATUS_MONITOR_NO_DESCRIPTOR ((NTSTATUS)0xC01D0001L) + +// +// MessageId: STATUS_MONITOR_UNKNOWN_DESCRIPTOR_FORMAT +// +// MessageText: +// +// Format of the obtained monitor descriptor is not supported by this release. +// +#define STATUS_MONITOR_UNKNOWN_DESCRIPTOR_FORMAT ((NTSTATUS)0xC01D0002L) + +// +// MessageId: STATUS_MONITOR_INVALID_DESCRIPTOR_CHECKSUM +// +// MessageText: +// +// Checksum of the obtained monitor descriptor is invalid. +// +#define STATUS_MONITOR_INVALID_DESCRIPTOR_CHECKSUM ((NTSTATUS)0xC01D0003L) + +// +// MessageId: STATUS_MONITOR_INVALID_STANDARD_TIMING_BLOCK +// +// MessageText: +// +// Monitor descriptor contains an invalid standard timing block. +// +#define STATUS_MONITOR_INVALID_STANDARD_TIMING_BLOCK ((NTSTATUS)0xC01D0004L) + +// +// MessageId: STATUS_MONITOR_WMI_DATABLOCK_REGISTRATION_FAILED +// +// MessageText: +// +// WMI data block registration failed for one of the MSMonitorClass WMI subclasses. +// +#define STATUS_MONITOR_WMI_DATABLOCK_REGISTRATION_FAILED ((NTSTATUS)0xC01D0005L) + +// +// MessageId: STATUS_MONITOR_INVALID_SERIAL_NUMBER_MONDSC_BLOCK +// +// MessageText: +// +// Provided monitor descriptor block is either corrupted or does not contain monitor's detailed serial number. +// +#define STATUS_MONITOR_INVALID_SERIAL_NUMBER_MONDSC_BLOCK ((NTSTATUS)0xC01D0006L) + +// +// MessageId: STATUS_MONITOR_INVALID_USER_FRIENDLY_MONDSC_BLOCK +// +// MessageText: +// +// Provided monitor descriptor block is either corrupted or does not contain monitor's user friendly name. +// +#define STATUS_MONITOR_INVALID_USER_FRIENDLY_MONDSC_BLOCK ((NTSTATUS)0xC01D0007L) + +// +// MessageId: STATUS_MONITOR_NO_MORE_DESCRIPTOR_DATA +// +// MessageText: +// +// There is no monitor descriptor data at the specified (offset, size) region. +// +#define STATUS_MONITOR_NO_MORE_DESCRIPTOR_DATA ((NTSTATUS)0xC01D0008L) + +// +// MessageId: STATUS_MONITOR_INVALID_DETAILED_TIMING_BLOCK +// +// MessageText: +// +// Monitor descriptor contains an invalid detailed timing block. +// +#define STATUS_MONITOR_INVALID_DETAILED_TIMING_BLOCK ((NTSTATUS)0xC01D0009L) + +// +// MessageId: STATUS_MONITOR_INVALID_MANUFACTURE_DATE +// +// MessageText: +// +// Monitor descriptor contains invalid manufacture date. +// +#define STATUS_MONITOR_INVALID_MANUFACTURE_DATE ((NTSTATUS)0xC01D000AL) + + +// +// Graphics Facility Error codes (dxg.sys, dxgkrnl.sys) +// + +// +// Common Windows Graphics Kernel Subsystem status codes {0x0000..0x00ff} +// +// +// MessageId: STATUS_GRAPHICS_NOT_EXCLUSIVE_MODE_OWNER +// +// MessageText: +// +// Exclusive mode ownership is needed to create unmanaged primary allocation. +// +#define STATUS_GRAPHICS_NOT_EXCLUSIVE_MODE_OWNER ((NTSTATUS)0xC01E0000L) + +// +// MessageId: STATUS_GRAPHICS_INSUFFICIENT_DMA_BUFFER +// +// MessageText: +// +// The driver needs more DMA buffer space in order to complete the requested operation. +// +#define STATUS_GRAPHICS_INSUFFICIENT_DMA_BUFFER ((NTSTATUS)0xC01E0001L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_DISPLAY_ADAPTER +// +// MessageText: +// +// Specified display adapter handle is invalid. +// +#define STATUS_GRAPHICS_INVALID_DISPLAY_ADAPTER ((NTSTATUS)0xC01E0002L) + +// +// MessageId: STATUS_GRAPHICS_ADAPTER_WAS_RESET +// +// MessageText: +// +// Specified display adapter and all of its state has been reset. +// +#define STATUS_GRAPHICS_ADAPTER_WAS_RESET ((NTSTATUS)0xC01E0003L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_DRIVER_MODEL +// +// MessageText: +// +// The driver stack doesn't match the expected driver model. +// +#define STATUS_GRAPHICS_INVALID_DRIVER_MODEL ((NTSTATUS)0xC01E0004L) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_MODE_CHANGED +// +// MessageText: +// +// Present happened but ended up into the changed desktop mode +// +#define STATUS_GRAPHICS_PRESENT_MODE_CHANGED ((NTSTATUS)0xC01E0005L) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_OCCLUDED +// +// MessageText: +// +// Nothing to present due to desktop occlusion +// +#define STATUS_GRAPHICS_PRESENT_OCCLUDED ((NTSTATUS)0xC01E0006L) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_DENIED +// +// MessageText: +// +// Not able to present due to denial of desktop access +// +#define STATUS_GRAPHICS_PRESENT_DENIED ((NTSTATUS)0xC01E0007L) + +// +// MessageId: STATUS_GRAPHICS_CANNOTCOLORCONVERT +// +// MessageText: +// +// Not able to present with color conversion +// +#define STATUS_GRAPHICS_CANNOTCOLORCONVERT ((NTSTATUS)0xC01E0008L) + +// +// MessageId: STATUS_GRAPHICS_DRIVER_MISMATCH +// +// MessageText: +// +// The kernel driver detected a version mismatch between it and the user mode driver. +// +#define STATUS_GRAPHICS_DRIVER_MISMATCH ((NTSTATUS)0xC01E0009L) + +// +// MessageId: STATUS_GRAPHICS_PARTIAL_DATA_POPULATED +// +// MessageText: +// +// Specified buffer is not big enough to contain entire requested dataset. Partial data populated up to the size of the buffer. Caller needs to provide buffer of size as specified in the partially populated buffer's content (interface specific). +// +#define STATUS_GRAPHICS_PARTIAL_DATA_POPULATED ((NTSTATUS)0x401E000AL) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_REDIRECTION_DISABLED +// +// MessageText: +// +// Present redirection is disabled (desktop windowing management subsystem is off). +// +#define STATUS_GRAPHICS_PRESENT_REDIRECTION_DISABLED ((NTSTATUS)0xC01E000BL) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_UNOCCLUDED +// +// MessageText: +// +// Previous exclusive VidPn source owner has released its ownership +// +#define STATUS_GRAPHICS_PRESENT_UNOCCLUDED ((NTSTATUS)0xC01E000CL) + +// +// MessageId: STATUS_GRAPHICS_WINDOWDC_NOT_AVAILABLE +// +// MessageText: +// +// Window DC is not available for presentation +// +#define STATUS_GRAPHICS_WINDOWDC_NOT_AVAILABLE ((NTSTATUS)0xC01E000DL) + +// +// MessageId: STATUS_GRAPHICS_WINDOWLESS_PRESENT_DISABLED +// +// MessageText: +// +// Windowless present is disabled (desktop windowing management subsystem is off). +// +#define STATUS_GRAPHICS_WINDOWLESS_PRESENT_DISABLED ((NTSTATUS)0xC01E000EL) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_INVALID_WINDOW +// +// MessageText: +// +// Window handle is invalid +// +#define STATUS_GRAPHICS_PRESENT_INVALID_WINDOW ((NTSTATUS)0xC01E000FL) + +// +// MessageId: STATUS_GRAPHICS_PRESENT_BUFFER_NOT_BOUND +// +// MessageText: +// +// No buffer is bound to composition surface +// +#define STATUS_GRAPHICS_PRESENT_BUFFER_NOT_BOUND ((NTSTATUS)0xC01E0010L) + +// +// MessageId: STATUS_GRAPHICS_VAIL_STATE_CHANGED +// +// MessageText: +// +// Vail state has been changed +// +#define STATUS_GRAPHICS_VAIL_STATE_CHANGED ((NTSTATUS)0xC01E0011L) + +// +// MessageId: STATUS_GRAPHICS_INDIRECT_DISPLAY_ABANDON_SWAPCHAIN +// +// MessageText: +// +// Notifying indirect display UMDF class driver to abandon current swapchain. +// +#define STATUS_GRAPHICS_INDIRECT_DISPLAY_ABANDON_SWAPCHAIN ((NTSTATUS)0xC01E0012L) + +// +// MessageId: STATUS_GRAPHICS_INDIRECT_DISPLAY_DEVICE_STOPPED +// +// MessageText: +// +// Notifying indirect display UMDF class driver that indirect display device has been stopped. +// +#define STATUS_GRAPHICS_INDIRECT_DISPLAY_DEVICE_STOPPED ((NTSTATUS)0xC01E0013L) + +// +// MessageId: STATUS_GRAPHICS_MPO_ALLOCATION_UNPINNED +// +// MessageText: +// +// The allocation for the MPO has been unpinned. +// +#define STATUS_GRAPHICS_MPO_ALLOCATION_UNPINNED ((NTSTATUS)0xC01E0018L) + +// +// MessageId: STATUS_GRAPHICS_SETDISPLAYMODE_REQUIRED +// +// MessageText: +// +// SetDisplayMode is required before present can succeed. +// +#define STATUS_GRAPHICS_SETDISPLAYMODE_REQUIRED ((NTSTATUS)0xC01E0019L) + +// +// Video Memory Manager (VidMM) specific status codes {0x0100..0x01ff} +// +// +// MessageId: STATUS_GRAPHICS_NO_VIDEO_MEMORY +// +// MessageText: +// +// Not enough video memory available to complete the operation. +// +#define STATUS_GRAPHICS_NO_VIDEO_MEMORY ((NTSTATUS)0xC01E0100L) + +// +// MessageId: STATUS_GRAPHICS_CANT_LOCK_MEMORY +// +// MessageText: +// +// Couldn't probe and lock the underlying memory of an allocation. +// +#define STATUS_GRAPHICS_CANT_LOCK_MEMORY ((NTSTATUS)0xC01E0101L) + +// +// MessageId: STATUS_GRAPHICS_ALLOCATION_BUSY +// +// MessageText: +// +// The allocation is currently busy. +// +#define STATUS_GRAPHICS_ALLOCATION_BUSY ((NTSTATUS)0xC01E0102L) + +// +// MessageId: STATUS_GRAPHICS_TOO_MANY_REFERENCES +// +// MessageText: +// +// An object being referenced has already reached the maximum reference count and can't be referenced any further. +// +#define STATUS_GRAPHICS_TOO_MANY_REFERENCES ((NTSTATUS)0xC01E0103L) + +// +// MessageId: STATUS_GRAPHICS_TRY_AGAIN_LATER +// +// MessageText: +// +// A problem couldn't be solved due to some currently existing condition. The problem should be tried again later. +// +#define STATUS_GRAPHICS_TRY_AGAIN_LATER ((NTSTATUS)0xC01E0104L) + +// +// MessageId: STATUS_GRAPHICS_TRY_AGAIN_NOW +// +// MessageText: +// +// A problem couldn't be solved due to some currently existing condition. The problem should be tried again immediately. +// +#define STATUS_GRAPHICS_TRY_AGAIN_NOW ((NTSTATUS)0xC01E0105L) + +// +// MessageId: STATUS_GRAPHICS_ALLOCATION_INVALID +// +// MessageText: +// +// The allocation is invalid. +// +#define STATUS_GRAPHICS_ALLOCATION_INVALID ((NTSTATUS)0xC01E0106L) + +// +// MessageId: STATUS_GRAPHICS_UNSWIZZLING_APERTURE_UNAVAILABLE +// +// MessageText: +// +// No more unswizzling aperture are currently available. +// +#define STATUS_GRAPHICS_UNSWIZZLING_APERTURE_UNAVAILABLE ((NTSTATUS)0xC01E0107L) + +// +// MessageId: STATUS_GRAPHICS_UNSWIZZLING_APERTURE_UNSUPPORTED +// +// MessageText: +// +// The current allocation can't be unswizzled by an aperture. +// +#define STATUS_GRAPHICS_UNSWIZZLING_APERTURE_UNSUPPORTED ((NTSTATUS)0xC01E0108L) + +// +// MessageId: STATUS_GRAPHICS_CANT_EVICT_PINNED_ALLOCATION +// +// MessageText: +// +// The request failed because a pinned allocation can't be evicted. +// +#define STATUS_GRAPHICS_CANT_EVICT_PINNED_ALLOCATION ((NTSTATUS)0xC01E0109L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_ALLOCATION_USAGE +// +// MessageText: +// +// The allocation can't be used from its current segment location for the specified operation. +// +#define STATUS_GRAPHICS_INVALID_ALLOCATION_USAGE ((NTSTATUS)0xC01E0110L) + +// +// MessageId: STATUS_GRAPHICS_CANT_RENDER_LOCKED_ALLOCATION +// +// MessageText: +// +// A locked allocation can't be used in the current command buffer. +// +#define STATUS_GRAPHICS_CANT_RENDER_LOCKED_ALLOCATION ((NTSTATUS)0xC01E0111L) + +// +// MessageId: STATUS_GRAPHICS_ALLOCATION_CLOSED +// +// MessageText: +// +// The allocation being referenced has been closed permanently. +// +#define STATUS_GRAPHICS_ALLOCATION_CLOSED ((NTSTATUS)0xC01E0112L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_ALLOCATION_INSTANCE +// +// MessageText: +// +// An invalid allocation instance is being referenced. +// +#define STATUS_GRAPHICS_INVALID_ALLOCATION_INSTANCE ((NTSTATUS)0xC01E0113L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_ALLOCATION_HANDLE +// +// MessageText: +// +// An invalid allocation handle is being referenced. +// +#define STATUS_GRAPHICS_INVALID_ALLOCATION_HANDLE ((NTSTATUS)0xC01E0114L) + +// +// MessageId: STATUS_GRAPHICS_WRONG_ALLOCATION_DEVICE +// +// MessageText: +// +// The allocation being referenced doesn't belong to the current device. +// +#define STATUS_GRAPHICS_WRONG_ALLOCATION_DEVICE ((NTSTATUS)0xC01E0115L) + +// +// MessageId: STATUS_GRAPHICS_ALLOCATION_CONTENT_LOST +// +// MessageText: +// +// The specified allocation lost its content. +// +#define STATUS_GRAPHICS_ALLOCATION_CONTENT_LOST ((NTSTATUS)0xC01E0116L) + +// +// Video GPU Scheduler (VidSch) specific status codes {0x0200..0x02ff} +// +// +// MessageId: STATUS_GRAPHICS_GPU_EXCEPTION_ON_DEVICE +// +// MessageText: +// +// GPU exception is detected on the given device. The device is not able to be scheduled. +// +#define STATUS_GRAPHICS_GPU_EXCEPTION_ON_DEVICE ((NTSTATUS)0xC01E0200L) + +// +// MessageId: STATUS_GRAPHICS_SKIP_ALLOCATION_PREPARATION +// +// MessageText: +// +// Skip preparation of allocations referenced by the DMA buffer. +// +#define STATUS_GRAPHICS_SKIP_ALLOCATION_PREPARATION ((NTSTATUS)0x401E0201L) + +// +// Video Present Network Management (VidPNMgr) specific status codes {0x0300..0x03ff} +// +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY +// +// MessageText: +// +// Specified VidPN topology is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY ((NTSTATUS)0xC01E0300L) + +// +// MessageId: STATUS_GRAPHICS_VIDPN_TOPOLOGY_NOT_SUPPORTED +// +// MessageText: +// +// Specified VidPN topology is valid but is not supported by this model of the display adapter. +// +#define STATUS_GRAPHICS_VIDPN_TOPOLOGY_NOT_SUPPORTED ((NTSTATUS)0xC01E0301L) + +// +// MessageId: STATUS_GRAPHICS_VIDPN_TOPOLOGY_CURRENTLY_NOT_SUPPORTED +// +// MessageText: +// +// Specified VidPN topology is valid but is not supported by the display adapter at this time, due to current allocation of its resources. +// +#define STATUS_GRAPHICS_VIDPN_TOPOLOGY_CURRENTLY_NOT_SUPPORTED ((NTSTATUS)0xC01E0302L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN +// +// MessageText: +// +// Specified VidPN handle is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN ((NTSTATUS)0xC01E0303L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE +// +// MessageText: +// +// Specified video present source is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE ((NTSTATUS)0xC01E0304L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET +// +// MessageText: +// +// Specified video present target is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET ((NTSTATUS)0xC01E0305L) + +// +// MessageId: STATUS_GRAPHICS_VIDPN_MODALITY_NOT_SUPPORTED +// +// MessageText: +// +// Specified VidPN modality is not supported (e.g. at least two of the pinned modes are not cofunctional). +// +#define STATUS_GRAPHICS_VIDPN_MODALITY_NOT_SUPPORTED ((NTSTATUS)0xC01E0306L) + +// +// MessageId: STATUS_GRAPHICS_MODE_NOT_PINNED +// +// MessageText: +// +// No mode is pinned on the specified VidPN source/target. +// +#define STATUS_GRAPHICS_MODE_NOT_PINNED ((NTSTATUS)0x401E0307L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_SOURCEMODESET +// +// MessageText: +// +// Specified VidPN source mode set is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_SOURCEMODESET ((NTSTATUS)0xC01E0308L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_TARGETMODESET +// +// MessageText: +// +// Specified VidPN target mode set is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_TARGETMODESET ((NTSTATUS)0xC01E0309L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_FREQUENCY +// +// MessageText: +// +// Specified video signal frequency is invalid. +// +#define STATUS_GRAPHICS_INVALID_FREQUENCY ((NTSTATUS)0xC01E030AL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_ACTIVE_REGION +// +// MessageText: +// +// Specified video signal active region is invalid. +// +#define STATUS_GRAPHICS_INVALID_ACTIVE_REGION ((NTSTATUS)0xC01E030BL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_TOTAL_REGION +// +// MessageText: +// +// Specified video signal total region is invalid. +// +#define STATUS_GRAPHICS_INVALID_TOTAL_REGION ((NTSTATUS)0xC01E030CL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE_MODE +// +// MessageText: +// +// Specified video present source mode is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE_MODE ((NTSTATUS)0xC01E0310L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET_MODE +// +// MessageText: +// +// Specified video present target mode is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET_MODE ((NTSTATUS)0xC01E0311L) + +// +// MessageId: STATUS_GRAPHICS_PINNED_MODE_MUST_REMAIN_IN_SET +// +// MessageText: +// +// Pinned mode must remain in the set on VidPN's cofunctional modality enumeration. +// +#define STATUS_GRAPHICS_PINNED_MODE_MUST_REMAIN_IN_SET ((NTSTATUS)0xC01E0312L) + +// +// MessageId: STATUS_GRAPHICS_PATH_ALREADY_IN_TOPOLOGY +// +// MessageText: +// +// Specified video present path is already in VidPN's topology. +// +#define STATUS_GRAPHICS_PATH_ALREADY_IN_TOPOLOGY ((NTSTATUS)0xC01E0313L) + +// +// MessageId: STATUS_GRAPHICS_MODE_ALREADY_IN_MODESET +// +// MessageText: +// +// Specified mode is already in the mode set. +// +#define STATUS_GRAPHICS_MODE_ALREADY_IN_MODESET ((NTSTATUS)0xC01E0314L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEOPRESENTSOURCESET +// +// MessageText: +// +// Specified video present source set is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEOPRESENTSOURCESET ((NTSTATUS)0xC01E0315L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDEOPRESENTTARGETSET +// +// MessageText: +// +// Specified video present target set is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDEOPRESENTTARGETSET ((NTSTATUS)0xC01E0316L) + +// +// MessageId: STATUS_GRAPHICS_SOURCE_ALREADY_IN_SET +// +// MessageText: +// +// Specified video present source is already in the video present source set. +// +#define STATUS_GRAPHICS_SOURCE_ALREADY_IN_SET ((NTSTATUS)0xC01E0317L) + +// +// MessageId: STATUS_GRAPHICS_TARGET_ALREADY_IN_SET +// +// MessageText: +// +// Specified video present target is already in the video present target set. +// +#define STATUS_GRAPHICS_TARGET_ALREADY_IN_SET ((NTSTATUS)0xC01E0318L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_PRESENT_PATH +// +// MessageText: +// +// Specified VidPN present path is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_PRESENT_PATH ((NTSTATUS)0xC01E0319L) + +// +// MessageId: STATUS_GRAPHICS_NO_RECOMMENDED_VIDPN_TOPOLOGY +// +// MessageText: +// +// Miniport has no recommendation for augmentation of the specified VidPN's topology. +// +#define STATUS_GRAPHICS_NO_RECOMMENDED_VIDPN_TOPOLOGY ((NTSTATUS)0xC01E031AL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGESET +// +// MessageText: +// +// Specified monitor frequency range set is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGESET ((NTSTATUS)0xC01E031BL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE +// +// MessageText: +// +// Specified monitor frequency range is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE ((NTSTATUS)0xC01E031CL) + +// +// MessageId: STATUS_GRAPHICS_FREQUENCYRANGE_NOT_IN_SET +// +// MessageText: +// +// Specified frequency range is not in the specified monitor frequency range set. +// +#define STATUS_GRAPHICS_FREQUENCYRANGE_NOT_IN_SET ((NTSTATUS)0xC01E031DL) + +// +// MessageId: STATUS_GRAPHICS_NO_PREFERRED_MODE +// +// MessageText: +// +// Specified mode set does not specify preference for one of its modes. +// +#define STATUS_GRAPHICS_NO_PREFERRED_MODE ((NTSTATUS)0x401E031EL) + +// +// MessageId: STATUS_GRAPHICS_FREQUENCYRANGE_ALREADY_IN_SET +// +// MessageText: +// +// Specified frequency range is already in the specified monitor frequency range set. +// +#define STATUS_GRAPHICS_FREQUENCYRANGE_ALREADY_IN_SET ((NTSTATUS)0xC01E031FL) + +// +// MessageId: STATUS_GRAPHICS_STALE_MODESET +// +// MessageText: +// +// Specified mode set is stale. Please reacquire the new mode set. +// +#define STATUS_GRAPHICS_STALE_MODESET ((NTSTATUS)0xC01E0320L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_SOURCEMODESET +// +// MessageText: +// +// Specified monitor source mode set is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_SOURCEMODESET ((NTSTATUS)0xC01E0321L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_SOURCE_MODE +// +// MessageText: +// +// Specified monitor source mode is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_SOURCE_MODE ((NTSTATUS)0xC01E0322L) + +// +// MessageId: STATUS_GRAPHICS_NO_RECOMMENDED_FUNCTIONAL_VIDPN +// +// MessageText: +// +// Miniport does not have any recommendation regarding the request to provide a functional VidPN given the current display adapter configuration. +// +#define STATUS_GRAPHICS_NO_RECOMMENDED_FUNCTIONAL_VIDPN ((NTSTATUS)0xC01E0323L) + +// +// MessageId: STATUS_GRAPHICS_MODE_ID_MUST_BE_UNIQUE +// +// MessageText: +// +// ID of the specified mode is already used by another mode in the set. +// +#define STATUS_GRAPHICS_MODE_ID_MUST_BE_UNIQUE ((NTSTATUS)0xC01E0324L) + +// +// MessageId: STATUS_GRAPHICS_EMPTY_ADAPTER_MONITOR_MODE_SUPPORT_INTERSECTION +// +// MessageText: +// +// System failed to determine a mode that is supported by both the display adapter and the monitor connected to it. +// +#define STATUS_GRAPHICS_EMPTY_ADAPTER_MONITOR_MODE_SUPPORT_INTERSECTION ((NTSTATUS)0xC01E0325L) + +// +// MessageId: STATUS_GRAPHICS_VIDEO_PRESENT_TARGETS_LESS_THAN_SOURCES +// +// MessageText: +// +// Number of video present targets must be greater than or equal to the number of video present sources. +// +#define STATUS_GRAPHICS_VIDEO_PRESENT_TARGETS_LESS_THAN_SOURCES ((NTSTATUS)0xC01E0326L) + +// +// MessageId: STATUS_GRAPHICS_PATH_NOT_IN_TOPOLOGY +// +// MessageText: +// +// Specified present path is not in VidPN's topology. +// +#define STATUS_GRAPHICS_PATH_NOT_IN_TOPOLOGY ((NTSTATUS)0xC01E0327L) + +// +// MessageId: STATUS_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_SOURCE +// +// MessageText: +// +// Display adapter must have at least one video present source. +// +#define STATUS_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_SOURCE ((NTSTATUS)0xC01E0328L) + +// +// MessageId: STATUS_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_TARGET +// +// MessageText: +// +// Display adapter must have at least one video present target. +// +#define STATUS_GRAPHICS_ADAPTER_MUST_HAVE_AT_LEAST_ONE_TARGET ((NTSTATUS)0xC01E0329L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITORDESCRIPTORSET +// +// MessageText: +// +// Specified monitor descriptor set is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITORDESCRIPTORSET ((NTSTATUS)0xC01E032AL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITORDESCRIPTOR +// +// MessageText: +// +// Specified monitor descriptor is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITORDESCRIPTOR ((NTSTATUS)0xC01E032BL) + +// +// MessageId: STATUS_GRAPHICS_MONITORDESCRIPTOR_NOT_IN_SET +// +// MessageText: +// +// Specified descriptor is not in the specified monitor descriptor set. +// +#define STATUS_GRAPHICS_MONITORDESCRIPTOR_NOT_IN_SET ((NTSTATUS)0xC01E032CL) + +// +// MessageId: STATUS_GRAPHICS_MONITORDESCRIPTOR_ALREADY_IN_SET +// +// MessageText: +// +// Specified descriptor is already in the specified monitor descriptor set. +// +#define STATUS_GRAPHICS_MONITORDESCRIPTOR_ALREADY_IN_SET ((NTSTATUS)0xC01E032DL) + +// +// MessageId: STATUS_GRAPHICS_MONITORDESCRIPTOR_ID_MUST_BE_UNIQUE +// +// MessageText: +// +// ID of the specified monitor descriptor is already used by another descriptor in the set. +// +#define STATUS_GRAPHICS_MONITORDESCRIPTOR_ID_MUST_BE_UNIQUE ((NTSTATUS)0xC01E032EL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_TARGET_SUBSET_TYPE +// +// MessageText: +// +// Specified video present target subset type is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_TARGET_SUBSET_TYPE ((NTSTATUS)0xC01E032FL) + +// +// MessageId: STATUS_GRAPHICS_RESOURCES_NOT_RELATED +// +// MessageText: +// +// Two or more of the specified resources are not related to each other, as defined by the interface semantics. +// +#define STATUS_GRAPHICS_RESOURCES_NOT_RELATED ((NTSTATUS)0xC01E0330L) + +// +// MessageId: STATUS_GRAPHICS_SOURCE_ID_MUST_BE_UNIQUE +// +// MessageText: +// +// ID of the specified video present source is already used by another source in the set. +// +#define STATUS_GRAPHICS_SOURCE_ID_MUST_BE_UNIQUE ((NTSTATUS)0xC01E0331L) + +// +// MessageId: STATUS_GRAPHICS_TARGET_ID_MUST_BE_UNIQUE +// +// MessageText: +// +// ID of the specified video present target is already used by another target in the set. +// +#define STATUS_GRAPHICS_TARGET_ID_MUST_BE_UNIQUE ((NTSTATUS)0xC01E0332L) + +// +// MessageId: STATUS_GRAPHICS_NO_AVAILABLE_VIDPN_TARGET +// +// MessageText: +// +// Specified VidPN source cannot be used because there is no available VidPN target to connect it to. +// +#define STATUS_GRAPHICS_NO_AVAILABLE_VIDPN_TARGET ((NTSTATUS)0xC01E0333L) + +// +// MessageId: STATUS_GRAPHICS_MONITOR_COULD_NOT_BE_ASSOCIATED_WITH_ADAPTER +// +// MessageText: +// +// Newly arrived monitor could not be associated with a display adapter. +// +#define STATUS_GRAPHICS_MONITOR_COULD_NOT_BE_ASSOCIATED_WITH_ADAPTER ((NTSTATUS)0xC01E0334L) + +// +// MessageId: STATUS_GRAPHICS_NO_VIDPNMGR +// +// MessageText: +// +// Display adapter in question does not have an associated VidPN manager. +// +#define STATUS_GRAPHICS_NO_VIDPNMGR ((NTSTATUS)0xC01E0335L) + +// +// MessageId: STATUS_GRAPHICS_NO_ACTIVE_VIDPN +// +// MessageText: +// +// VidPN manager of the display adapter in question does not have an active VidPN. +// +#define STATUS_GRAPHICS_NO_ACTIVE_VIDPN ((NTSTATUS)0xC01E0336L) + +// +// MessageId: STATUS_GRAPHICS_STALE_VIDPN_TOPOLOGY +// +// MessageText: +// +// Specified VidPN topology is stale. Please reacquire the new topology. +// +#define STATUS_GRAPHICS_STALE_VIDPN_TOPOLOGY ((NTSTATUS)0xC01E0337L) + +// +// MessageId: STATUS_GRAPHICS_MONITOR_NOT_CONNECTED +// +// MessageText: +// +// There is no monitor connected on the specified video present target. +// +#define STATUS_GRAPHICS_MONITOR_NOT_CONNECTED ((NTSTATUS)0xC01E0338L) + +// +// MessageId: STATUS_GRAPHICS_SOURCE_NOT_IN_TOPOLOGY +// +// MessageText: +// +// Specified source is not part of the specified VidPN's topology. +// +#define STATUS_GRAPHICS_SOURCE_NOT_IN_TOPOLOGY ((NTSTATUS)0xC01E0339L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PRIMARYSURFACE_SIZE +// +// MessageText: +// +// Specified primary surface size is invalid. +// +#define STATUS_GRAPHICS_INVALID_PRIMARYSURFACE_SIZE ((NTSTATUS)0xC01E033AL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VISIBLEREGION_SIZE +// +// MessageText: +// +// Specified visible region size is invalid. +// +#define STATUS_GRAPHICS_INVALID_VISIBLEREGION_SIZE ((NTSTATUS)0xC01E033BL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_STRIDE +// +// MessageText: +// +// Specified stride is invalid. +// +#define STATUS_GRAPHICS_INVALID_STRIDE ((NTSTATUS)0xC01E033CL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PIXELFORMAT +// +// MessageText: +// +// Specified pixel format is invalid. +// +#define STATUS_GRAPHICS_INVALID_PIXELFORMAT ((NTSTATUS)0xC01E033DL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_COLORBASIS +// +// MessageText: +// +// Specified color basis is invalid. +// +#define STATUS_GRAPHICS_INVALID_COLORBASIS ((NTSTATUS)0xC01E033EL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PIXELVALUEACCESSMODE +// +// MessageText: +// +// Specified pixel value access mode is invalid. +// +#define STATUS_GRAPHICS_INVALID_PIXELVALUEACCESSMODE ((NTSTATUS)0xC01E033FL) + +// +// MessageId: STATUS_GRAPHICS_TARGET_NOT_IN_TOPOLOGY +// +// MessageText: +// +// Specified target is not part of the specified VidPN's topology. +// +#define STATUS_GRAPHICS_TARGET_NOT_IN_TOPOLOGY ((NTSTATUS)0xC01E0340L) + +// +// MessageId: STATUS_GRAPHICS_NO_DISPLAY_MODE_MANAGEMENT_SUPPORT +// +// MessageText: +// +// Failed to acquire display mode management interface. +// +#define STATUS_GRAPHICS_NO_DISPLAY_MODE_MANAGEMENT_SUPPORT ((NTSTATUS)0xC01E0341L) + +// +// MessageId: STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE +// +// MessageText: +// +// Specified VidPN source is already owned by a DMM client and cannot be used until that client releases it. +// +#define STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE ((NTSTATUS)0xC01E0342L) + +// +// MessageId: STATUS_GRAPHICS_CANT_ACCESS_ACTIVE_VIDPN +// +// MessageText: +// +// Specified VidPN is active and cannot be accessed. +// +#define STATUS_GRAPHICS_CANT_ACCESS_ACTIVE_VIDPN ((NTSTATUS)0xC01E0343L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PATH_IMPORTANCE_ORDINAL +// +// MessageText: +// +// Specified VidPN present path importance ordinal is invalid. +// +#define STATUS_GRAPHICS_INVALID_PATH_IMPORTANCE_ORDINAL ((NTSTATUS)0xC01E0344L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PATH_CONTENT_GEOMETRY_TRANSFORMATION +// +// MessageText: +// +// Specified VidPN present path content geometry transformation is invalid. +// +#define STATUS_GRAPHICS_INVALID_PATH_CONTENT_GEOMETRY_TRANSFORMATION ((NTSTATUS)0xC01E0345L) + +// +// MessageId: STATUS_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_SUPPORTED +// +// MessageText: +// +// Specified content geometry transformation is not supported on the respective VidPN present path. +// +#define STATUS_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_SUPPORTED ((NTSTATUS)0xC01E0346L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_GAMMA_RAMP +// +// MessageText: +// +// Specified gamma ramp is invalid. +// +#define STATUS_GRAPHICS_INVALID_GAMMA_RAMP ((NTSTATUS)0xC01E0347L) + +// +// MessageId: STATUS_GRAPHICS_GAMMA_RAMP_NOT_SUPPORTED +// +// MessageText: +// +// Specified gamma ramp is not supported on the respective VidPN present path. +// +#define STATUS_GRAPHICS_GAMMA_RAMP_NOT_SUPPORTED ((NTSTATUS)0xC01E0348L) + +// +// MessageId: STATUS_GRAPHICS_MULTISAMPLING_NOT_SUPPORTED +// +// MessageText: +// +// Multi-sampling is not supported on the respective VidPN present path. +// +#define STATUS_GRAPHICS_MULTISAMPLING_NOT_SUPPORTED ((NTSTATUS)0xC01E0349L) + +// +// MessageId: STATUS_GRAPHICS_MODE_NOT_IN_MODESET +// +// MessageText: +// +// Specified mode is not in the specified mode set. +// +#define STATUS_GRAPHICS_MODE_NOT_IN_MODESET ((NTSTATUS)0xC01E034AL) + +// +// MessageId: STATUS_GRAPHICS_DATASET_IS_EMPTY +// +// MessageText: +// +// Specified data set (e.g. mode set, frequency range set, descriptor set, topology, etc.) is empty. +// +#define STATUS_GRAPHICS_DATASET_IS_EMPTY ((NTSTATUS)0x401E034BL) + +// +// MessageId: STATUS_GRAPHICS_NO_MORE_ELEMENTS_IN_DATASET +// +// MessageText: +// +// Specified data set (e.g. mode set, frequency range set, descriptor set, topology, etc.) does not contain any more elements. +// +#define STATUS_GRAPHICS_NO_MORE_ELEMENTS_IN_DATASET ((NTSTATUS)0x401E034CL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY_RECOMMENDATION_REASON +// +// MessageText: +// +// Specified VidPN topology recommendation reason is invalid. +// +#define STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY_RECOMMENDATION_REASON ((NTSTATUS)0xC01E034DL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PATH_CONTENT_TYPE +// +// MessageText: +// +// Specified VidPN present path content type is invalid. +// +#define STATUS_GRAPHICS_INVALID_PATH_CONTENT_TYPE ((NTSTATUS)0xC01E034EL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_COPYPROTECTION_TYPE +// +// MessageText: +// +// Specified VidPN present path copy protection type is invalid. +// +#define STATUS_GRAPHICS_INVALID_COPYPROTECTION_TYPE ((NTSTATUS)0xC01E034FL) + +// +// MessageId: STATUS_GRAPHICS_UNASSIGNED_MODESET_ALREADY_EXISTS +// +// MessageText: +// +// No more than one unassigned mode set can exist at any given time for a given VidPN source/target. +// +#define STATUS_GRAPHICS_UNASSIGNED_MODESET_ALREADY_EXISTS ((NTSTATUS)0xC01E0350L) + +// +// MessageId: STATUS_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_PINNED +// +// MessageText: +// +// Specified content transformation is not pinned on the specified VidPN present path. +// +#define STATUS_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_PINNED ((NTSTATUS)0x401E0351L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_SCANLINE_ORDERING +// +// MessageText: +// +// Specified scanline ordering type is invalid. +// +#define STATUS_GRAPHICS_INVALID_SCANLINE_ORDERING ((NTSTATUS)0xC01E0352L) + +// +// MessageId: STATUS_GRAPHICS_TOPOLOGY_CHANGES_NOT_ALLOWED +// +// MessageText: +// +// Topology changes are not allowed for the specified VidPN. +// +#define STATUS_GRAPHICS_TOPOLOGY_CHANGES_NOT_ALLOWED ((NTSTATUS)0xC01E0353L) + +// +// MessageId: STATUS_GRAPHICS_NO_AVAILABLE_IMPORTANCE_ORDINALS +// +// MessageText: +// +// All available importance ordinals are already used in specified topology. +// +#define STATUS_GRAPHICS_NO_AVAILABLE_IMPORTANCE_ORDINALS ((NTSTATUS)0xC01E0354L) + +// +// MessageId: STATUS_GRAPHICS_INCOMPATIBLE_PRIVATE_FORMAT +// +// MessageText: +// +// Specified primary surface has a different private format attribute than the current primary surface +// +#define STATUS_GRAPHICS_INCOMPATIBLE_PRIVATE_FORMAT ((NTSTATUS)0xC01E0355L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MODE_PRUNING_ALGORITHM +// +// MessageText: +// +// Specified mode pruning algorithm is invalid +// +#define STATUS_GRAPHICS_INVALID_MODE_PRUNING_ALGORITHM ((NTSTATUS)0xC01E0356L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_CAPABILITY_ORIGIN +// +// MessageText: +// +// Specified monitor capability origin is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_CAPABILITY_ORIGIN ((NTSTATUS)0xC01E0357L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE_CONSTRAINT +// +// MessageText: +// +// Specified monitor frequency range constraint is invalid. +// +#define STATUS_GRAPHICS_INVALID_MONITOR_FREQUENCYRANGE_CONSTRAINT ((NTSTATUS)0xC01E0358L) + +// +// MessageId: STATUS_GRAPHICS_MAX_NUM_PATHS_REACHED +// +// MessageText: +// +// Maximum supported number of present paths has been reached. +// +#define STATUS_GRAPHICS_MAX_NUM_PATHS_REACHED ((NTSTATUS)0xC01E0359L) + +// +// MessageId: STATUS_GRAPHICS_CANCEL_VIDPN_TOPOLOGY_AUGMENTATION +// +// MessageText: +// +// Miniport requested that augmentation be cancelled for the specified source of the specified VidPN's topology. +// +#define STATUS_GRAPHICS_CANCEL_VIDPN_TOPOLOGY_AUGMENTATION ((NTSTATUS)0xC01E035AL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_CLIENT_TYPE +// +// MessageText: +// +// Specified client type was not recognized. +// +#define STATUS_GRAPHICS_INVALID_CLIENT_TYPE ((NTSTATUS)0xC01E035BL) + +// +// MessageId: STATUS_GRAPHICS_CLIENTVIDPN_NOT_SET +// +// MessageText: +// +// Client VidPN is not set on this adapter (e.g. no user mode initiated mode changes took place on this adapter yet). +// +#define STATUS_GRAPHICS_CLIENTVIDPN_NOT_SET ((NTSTATUS)0xC01E035CL) + +// +// Port specific status codes {0x0400..0x04ff} +// +// +// MessageId: STATUS_GRAPHICS_SPECIFIED_CHILD_ALREADY_CONNECTED +// +// MessageText: +// +// Specified display adapter child device already has an external device connected to it. +// +#define STATUS_GRAPHICS_SPECIFIED_CHILD_ALREADY_CONNECTED ((NTSTATUS)0xC01E0400L) + +// +// MessageId: STATUS_GRAPHICS_CHILD_DESCRIPTOR_NOT_SUPPORTED +// +// MessageText: +// +// Specified display adapter child device does not support descriptor exposure. +// +#define STATUS_GRAPHICS_CHILD_DESCRIPTOR_NOT_SUPPORTED ((NTSTATUS)0xC01E0401L) + +// +// MessageId: STATUS_GRAPHICS_UNKNOWN_CHILD_STATUS +// +// MessageText: +// +// Child device presence was not reliably detected. +// +#define STATUS_GRAPHICS_UNKNOWN_CHILD_STATUS ((NTSTATUS)0x401E042FL) + +// +// MessageId: STATUS_GRAPHICS_NOT_A_LINKED_ADAPTER +// +// MessageText: +// +// The display adapter is not linked to any other adapters. +// +#define STATUS_GRAPHICS_NOT_A_LINKED_ADAPTER ((NTSTATUS)0xC01E0430L) + +// +// MessageId: STATUS_GRAPHICS_LEADLINK_NOT_ENUMERATED +// +// MessageText: +// +// Lead adapter in a linked configuration was not enumerated yet. +// +#define STATUS_GRAPHICS_LEADLINK_NOT_ENUMERATED ((NTSTATUS)0xC01E0431L) + +// +// MessageId: STATUS_GRAPHICS_CHAINLINKS_NOT_ENUMERATED +// +// MessageText: +// +// Some chain adapters in a linked configuration were not enumerated yet. +// +#define STATUS_GRAPHICS_CHAINLINKS_NOT_ENUMERATED ((NTSTATUS)0xC01E0432L) + +// +// MessageId: STATUS_GRAPHICS_ADAPTER_CHAIN_NOT_READY +// +// MessageText: +// +// The chain of linked adapters is not ready to start because of an unknown failure. +// +#define STATUS_GRAPHICS_ADAPTER_CHAIN_NOT_READY ((NTSTATUS)0xC01E0433L) + +// +// MessageId: STATUS_GRAPHICS_CHAINLINKS_NOT_STARTED +// +// MessageText: +// +// An attempt was made to start a lead link display adapter when the chain links were not started yet. +// +#define STATUS_GRAPHICS_CHAINLINKS_NOT_STARTED ((NTSTATUS)0xC01E0434L) + +// +// MessageId: STATUS_GRAPHICS_CHAINLINKS_NOT_POWERED_ON +// +// MessageText: +// +// An attempt was made to power up a lead link display adapter when the chain links were powered down. +// +#define STATUS_GRAPHICS_CHAINLINKS_NOT_POWERED_ON ((NTSTATUS)0xC01E0435L) + +// +// MessageId: STATUS_GRAPHICS_INCONSISTENT_DEVICE_LINK_STATE +// +// MessageText: +// +// The adapter link was found to be in an inconsistent state. Not all adapters are in an expected PNP/Power state. +// +#define STATUS_GRAPHICS_INCONSISTENT_DEVICE_LINK_STATE ((NTSTATUS)0xC01E0436L) + +// +// MessageId: STATUS_GRAPHICS_LEADLINK_START_DEFERRED +// +// MessageText: +// +// Starting the leadlink adapter has been deferred temporarily. +// +#define STATUS_GRAPHICS_LEADLINK_START_DEFERRED ((NTSTATUS)0x401E0437L) + +// +// MessageId: STATUS_GRAPHICS_NOT_POST_DEVICE_DRIVER +// +// MessageText: +// +// The driver trying to start is not the same as the driver for the POSTed display adapter. +// +#define STATUS_GRAPHICS_NOT_POST_DEVICE_DRIVER ((NTSTATUS)0xC01E0438L) + +// +// MessageId: STATUS_GRAPHICS_POLLING_TOO_FREQUENTLY +// +// MessageText: +// +// The display adapter is being polled for children too frequently at the same polling level. +// +#define STATUS_GRAPHICS_POLLING_TOO_FREQUENTLY ((NTSTATUS)0x401E0439L) + +// +// MessageId: STATUS_GRAPHICS_START_DEFERRED +// +// MessageText: +// +// Starting the adapter has been deferred temporarily. +// +#define STATUS_GRAPHICS_START_DEFERRED ((NTSTATUS)0x401E043AL) + +// +// MessageId: STATUS_GRAPHICS_ADAPTER_ACCESS_NOT_EXCLUDED +// +// MessageText: +// +// An operation is being attempted that requires the display adapter to be in a quiescent state. +// +#define STATUS_GRAPHICS_ADAPTER_ACCESS_NOT_EXCLUDED ((NTSTATUS)0xC01E043BL) + +// +// MessageId: STATUS_GRAPHICS_DEPENDABLE_CHILD_STATUS +// +// MessageText: +// +// We can depend on the child device presence returned by the driver. +// +#define STATUS_GRAPHICS_DEPENDABLE_CHILD_STATUS ((NTSTATUS)0x401E043CL) + +// +// OPM, PVP and UAB status codes {0x0500..0x057F} +// +// +// MessageId: STATUS_GRAPHICS_OPM_NOT_SUPPORTED +// +// MessageText: +// +// The driver does not support OPM. +// +#define STATUS_GRAPHICS_OPM_NOT_SUPPORTED ((NTSTATUS)0xC01E0500L) + +// +// MessageId: STATUS_GRAPHICS_COPP_NOT_SUPPORTED +// +// MessageText: +// +// The driver does not support COPP. +// +#define STATUS_GRAPHICS_COPP_NOT_SUPPORTED ((NTSTATUS)0xC01E0501L) + +// +// MessageId: STATUS_GRAPHICS_UAB_NOT_SUPPORTED +// +// MessageText: +// +// The driver does not support UAB. +// +#define STATUS_GRAPHICS_UAB_NOT_SUPPORTED ((NTSTATUS)0xC01E0502L) + +// +// MessageId: STATUS_GRAPHICS_OPM_INVALID_ENCRYPTED_PARAMETERS +// +// MessageText: +// +// The specified encrypted parameters are invalid. +// +#define STATUS_GRAPHICS_OPM_INVALID_ENCRYPTED_PARAMETERS ((NTSTATUS)0xC01E0503L) + +// +// MessageId: STATUS_GRAPHICS_OPM_NO_PROTECTED_OUTPUTS_EXIST +// +// MessageText: +// +// The GDI display device passed to this function does not have any active protected outputs. +// +#define STATUS_GRAPHICS_OPM_NO_PROTECTED_OUTPUTS_EXIST ((NTSTATUS)0xC01E0505L) + +// +// MessageId: STATUS_GRAPHICS_OPM_INTERNAL_ERROR +// +// MessageText: +// +// An internal error caused an operation to fail. +// +#define STATUS_GRAPHICS_OPM_INTERNAL_ERROR ((NTSTATUS)0xC01E050BL) + +// +// MessageId: STATUS_GRAPHICS_OPM_INVALID_HANDLE +// +// MessageText: +// +// The function failed because the caller passed in an invalid OPM user mode handle. +// +#define STATUS_GRAPHICS_OPM_INVALID_HANDLE ((NTSTATUS)0xC01E050CL) + +// +// MessageId: STATUS_GRAPHICS_PVP_INVALID_CERTIFICATE_LENGTH +// +// MessageText: +// +// A certificate could not be returned because the certificate buffer passed to the function was too small. +// +#define STATUS_GRAPHICS_PVP_INVALID_CERTIFICATE_LENGTH ((NTSTATUS)0xC01E050EL) + +// +// MessageId: STATUS_GRAPHICS_OPM_SPANNING_MODE_ENABLED +// +// MessageText: +// +// The DxgkDdiOpmCreateProtectedOutput function could not create a protected output because the Video Present Target is in spanning mode. +// +#define STATUS_GRAPHICS_OPM_SPANNING_MODE_ENABLED ((NTSTATUS)0xC01E050FL) + +// +// MessageId: STATUS_GRAPHICS_OPM_THEATER_MODE_ENABLED +// +// MessageText: +// +// The DxgkDdiOpmCreateProtectedOutput function could not create a protected output because the Video Present Target is in theater mode. +// +#define STATUS_GRAPHICS_OPM_THEATER_MODE_ENABLED ((NTSTATUS)0xC01E0510L) + +// +// MessageId: STATUS_GRAPHICS_PVP_HFS_FAILED +// +// MessageText: +// +// The function failed because the display adapter's Hardware Functionality Scan failed to validate the graphics hardware. +// +#define STATUS_GRAPHICS_PVP_HFS_FAILED ((NTSTATUS)0xC01E0511L) + +// +// MessageId: STATUS_GRAPHICS_OPM_INVALID_SRM +// +// MessageText: +// +// The HDCP System Renewability Message passed to this function did not comply with section 5 of the HDCP 1.1 specification. +// +#define STATUS_GRAPHICS_OPM_INVALID_SRM ((NTSTATUS)0xC01E0512L) + +// +// MessageId: STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_HDCP +// +// MessageText: +// +// The protected output cannot enable the High-bandwidth Digital Content Protection (HDCP) System because it does not support HDCP. +// +#define STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_HDCP ((NTSTATUS)0xC01E0513L) + +// +// MessageId: STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_ACP +// +// MessageText: +// +// The protected output cannot enable Analogue Copy Protection (ACP) because it does not support ACP. +// +#define STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_ACP ((NTSTATUS)0xC01E0514L) + +// +// MessageId: STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_CGMSA +// +// MessageText: +// +// The protected output cannot enable the Content Generation Management System Analogue (CGMS-A) protection technology because it does not support CGMS-A. +// +#define STATUS_GRAPHICS_OPM_OUTPUT_DOES_NOT_SUPPORT_CGMSA ((NTSTATUS)0xC01E0515L) + +// +// MessageId: STATUS_GRAPHICS_OPM_HDCP_SRM_NEVER_SET +// +// MessageText: +// +// The DxgkDdiOPMGetInformation function cannot return the version of the SRM being used because the application never successfully passed an SRM to the protected output. +// +#define STATUS_GRAPHICS_OPM_HDCP_SRM_NEVER_SET ((NTSTATUS)0xC01E0516L) + +// +// MessageId: STATUS_GRAPHICS_OPM_RESOLUTION_TOO_HIGH +// +// MessageText: +// +// The DxgkDdiOPMConfigureProtectedOutput function cannot enable the specified output protection technology because the output's screen resolution is too high. +// +#define STATUS_GRAPHICS_OPM_RESOLUTION_TOO_HIGH ((NTSTATUS)0xC01E0517L) + +// +// MessageId: STATUS_GRAPHICS_OPM_ALL_HDCP_HARDWARE_ALREADY_IN_USE +// +// MessageText: +// +// The DxgkDdiOPMConfigureProtectedOutput function cannot enable HDCP because the display adapter's HDCP hardware is already being used by other physical outputs. +// +#define STATUS_GRAPHICS_OPM_ALL_HDCP_HARDWARE_ALREADY_IN_USE ((NTSTATUS)0xC01E0518L) + +// +// MessageId: STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_NO_LONGER_EXISTS +// +// MessageText: +// +// The operating system asynchronously destroyed this OPM protected output because the operating system's state changed. This error typically occurs because the monitor PDO associated with this protected output was removed, the monitor PDO associated with this protected output was stopped, or the protected output's session became a non-console session. +// +#define STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_NO_LONGER_EXISTS ((NTSTATUS)0xC01E051AL) + +// +// MessageId: STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_DOES_NOT_HAVE_COPP_SEMANTICS +// +// MessageText: +// +// Either the DxgkDdiOPMGetCOPPCompatibleInformation, DxgkDdiOPMGetInformation, or DxgkDdiOPMConfigureProtectedOutput function failed. This error is returned when the caller tries to use a COPP specific command while the protected output has OPM semantics only. +// +#define STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_DOES_NOT_HAVE_COPP_SEMANTICS ((NTSTATUS)0xC01E051CL) + +// +// MessageId: STATUS_GRAPHICS_OPM_INVALID_INFORMATION_REQUEST +// +// MessageText: +// +// The DxgkDdiOPMGetInformation and DxgkDdiOPMGetCOPPCompatibleInformation functions return this error code if the passed in sequence number is not the expected sequence number or the passed in OMAC value is invalid. +// +#define STATUS_GRAPHICS_OPM_INVALID_INFORMATION_REQUEST ((NTSTATUS)0xC01E051DL) + +// +// MessageId: STATUS_GRAPHICS_OPM_DRIVER_INTERNAL_ERROR +// +// MessageText: +// +// The function failed because an unexpected error occurred inside of a display driver. +// +#define STATUS_GRAPHICS_OPM_DRIVER_INTERNAL_ERROR ((NTSTATUS)0xC01E051EL) + +// +// MessageId: STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_DOES_NOT_HAVE_OPM_SEMANTICS +// +// MessageText: +// +// Either the DxgkDdiOPMGetCOPPCompatibleInformation, DxgkDdiOPMGetInformation, or DxgkDdiOPMConfigureProtectedOutput function failed. This error is returned when the caller tries to use an OPM specific command while the protected output has COPP semantics only. +// +#define STATUS_GRAPHICS_OPM_PROTECTED_OUTPUT_DOES_NOT_HAVE_OPM_SEMANTICS ((NTSTATUS)0xC01E051FL) + +// +// MessageId: STATUS_GRAPHICS_OPM_SIGNALING_NOT_SUPPORTED +// +// MessageText: +// +// The DxgkDdiOPMGetCOPPCompatibleInformation and DxgkDdiOPMConfigureProtectedOutput functions return this error if the display driver does not support the DXGKMDT_OPM_GET_ACP_AND_CGMSA_SIGNALING and DXGKMDT_OPM_SET_ACP_AND_CGMSA_SIGNALING GUIDs. +// +#define STATUS_GRAPHICS_OPM_SIGNALING_NOT_SUPPORTED ((NTSTATUS)0xC01E0520L) + +// +// MessageId: STATUS_GRAPHICS_OPM_INVALID_CONFIGURATION_REQUEST +// +// MessageText: +// +// The DxgkDdiOPMConfigureProtectedOutput function returns this error code if the passed in sequence number is not the expected sequence number or the passed in OMAC value is invalid. +// +#define STATUS_GRAPHICS_OPM_INVALID_CONFIGURATION_REQUEST ((NTSTATUS)0xC01E0521L) + +// +// Monitor Configuration API status codes {0x0580..0x05DF} +// +// +// MessageId: STATUS_GRAPHICS_I2C_NOT_SUPPORTED +// +// MessageText: +// +// The monitor connected to the specified video output does not have an I2C bus. +// +#define STATUS_GRAPHICS_I2C_NOT_SUPPORTED ((NTSTATUS)0xC01E0580L) + +// +// MessageId: STATUS_GRAPHICS_I2C_DEVICE_DOES_NOT_EXIST +// +// MessageText: +// +// No device on the I2C bus has the specified address. +// +#define STATUS_GRAPHICS_I2C_DEVICE_DOES_NOT_EXIST ((NTSTATUS)0xC01E0581L) + +// +// MessageId: STATUS_GRAPHICS_I2C_ERROR_TRANSMITTING_DATA +// +// MessageText: +// +// An error occurred while transmitting data to the device on the I2C bus. +// +#define STATUS_GRAPHICS_I2C_ERROR_TRANSMITTING_DATA ((NTSTATUS)0xC01E0582L) + +// +// MessageId: STATUS_GRAPHICS_I2C_ERROR_RECEIVING_DATA +// +// MessageText: +// +// An error occurred while receiving data from the device on the I2C bus. +// +#define STATUS_GRAPHICS_I2C_ERROR_RECEIVING_DATA ((NTSTATUS)0xC01E0583L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_VCP_NOT_SUPPORTED +// +// MessageText: +// +// The monitor does not support the specified VCP code. +// +#define STATUS_GRAPHICS_DDCCI_VCP_NOT_SUPPORTED ((NTSTATUS)0xC01E0584L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_INVALID_DATA +// +// MessageText: +// +// The data received from the monitor is invalid. +// +#define STATUS_GRAPHICS_DDCCI_INVALID_DATA ((NTSTATUS)0xC01E0585L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_MONITOR_RETURNED_INVALID_TIMING_STATUS_BYTE +// +// MessageText: +// +// The function failed because a monitor returned an invalid Timing Status byte when the operating system used the DDC/CI Get Timing Report & Timing Message command to get a timing report from a monitor. +// +#define STATUS_GRAPHICS_DDCCI_MONITOR_RETURNED_INVALID_TIMING_STATUS_BYTE ((NTSTATUS)0xC01E0586L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_INVALID_CAPABILITIES_STRING +// +// MessageText: +// +// A monitor returned a DDC/CI capabilities string which did not comply with the ACCESS.bus 3.0, DDC/CI 1.1, or MCCS 2 Revision 1 specification. +// +#define STATUS_GRAPHICS_DDCCI_INVALID_CAPABILITIES_STRING ((NTSTATUS)0xC01E0587L) + +// +// MessageId: STATUS_GRAPHICS_MCA_INTERNAL_ERROR +// +// MessageText: +// +// An internal error caused an operation to fail. +// +#define STATUS_GRAPHICS_MCA_INTERNAL_ERROR ((NTSTATUS)0xC01E0588L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_COMMAND +// +// MessageText: +// +// An operation failed because a DDC/CI message had an invalid value in its command field. +// +#define STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_COMMAND ((NTSTATUS)0xC01E0589L) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_LENGTH +// +// MessageText: +// +// An error occurred because the field length of a DDC/CI message contained an invalid value. +// +#define STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_LENGTH ((NTSTATUS)0xC01E058AL) + +// +// MessageId: STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_CHECKSUM +// +// MessageText: +// +// An error occurred because the checksum field in a DDC/CI message did not match the message's computed checksum value. This error implies that the data was corrupted while it was being transmitted from a monitor to a computer. +// +#define STATUS_GRAPHICS_DDCCI_INVALID_MESSAGE_CHECKSUM ((NTSTATUS)0xC01E058BL) + +// +// MessageId: STATUS_GRAPHICS_INVALID_PHYSICAL_MONITOR_HANDLE +// +// MessageText: +// +// This function failed because an invalid monitor handle was passed to it. +// +#define STATUS_GRAPHICS_INVALID_PHYSICAL_MONITOR_HANDLE ((NTSTATUS)0xC01E058CL) + +// +// MessageId: STATUS_GRAPHICS_MONITOR_NO_LONGER_EXISTS +// +// MessageText: +// +// The operating system asynchronously destroyed the monitor which corresponds to this handle because the operating system's state changed. This error typically occurs because the monitor PDO associated with this handle was removed, the monitor PDO associated with this handle was stopped, or a display mode change occurred. A display mode change occurs when windows sends a WM_DISPLAYCHANGE windows message to applications. +// +#define STATUS_GRAPHICS_MONITOR_NO_LONGER_EXISTS ((NTSTATUS)0xC01E058DL) + +// +// OPM, UAB, PVP and DDC/CI shared status codes {0x25E0..0x25FF} +// +// +// MessageId: STATUS_GRAPHICS_ONLY_CONSOLE_SESSION_SUPPORTED +// +// MessageText: +// +// This function can only be used if a program is running in the local console session. It cannot be used if a program is running on a remote desktop session or on a terminal server session. +// +#define STATUS_GRAPHICS_ONLY_CONSOLE_SESSION_SUPPORTED ((NTSTATUS)0xC01E05E0L) + +// +// MessageId: STATUS_GRAPHICS_NO_DISPLAY_DEVICE_CORRESPONDS_TO_NAME +// +// MessageText: +// +// This function cannot find an actual GDI display device which corresponds to the specified GDI display device name. +// +#define STATUS_GRAPHICS_NO_DISPLAY_DEVICE_CORRESPONDS_TO_NAME ((NTSTATUS)0xC01E05E1L) + +// +// MessageId: STATUS_GRAPHICS_DISPLAY_DEVICE_NOT_ATTACHED_TO_DESKTOP +// +// MessageText: +// +// The function failed because the specified GDI display device was not attached to the Windows desktop. +// +#define STATUS_GRAPHICS_DISPLAY_DEVICE_NOT_ATTACHED_TO_DESKTOP ((NTSTATUS)0xC01E05E2L) + +// +// MessageId: STATUS_GRAPHICS_MIRRORING_DEVICES_NOT_SUPPORTED +// +// MessageText: +// +// This function does not support GDI mirroring display devices because GDI mirroring display devices do not have any physical monitors associated with them. +// +#define STATUS_GRAPHICS_MIRRORING_DEVICES_NOT_SUPPORTED ((NTSTATUS)0xC01E05E3L) + +// +// MessageId: STATUS_GRAPHICS_INVALID_POINTER +// +// MessageText: +// +// The function failed because an invalid pointer parameter was passed to it. A pointer parameter is invalid if it is NULL, it points to an invalid address, it points to a kernel mode address or it is not correctly aligned. +// +#define STATUS_GRAPHICS_INVALID_POINTER ((NTSTATUS)0xC01E05E4L) + +// +// MessageId: STATUS_GRAPHICS_NO_MONITORS_CORRESPOND_TO_DISPLAY_DEVICE +// +// MessageText: +// +// This function failed because the GDI device passed to it did not have any monitors associated with it. +// +#define STATUS_GRAPHICS_NO_MONITORS_CORRESPOND_TO_DISPLAY_DEVICE ((NTSTATUS)0xC01E05E5L) + +// +// MessageId: STATUS_GRAPHICS_PARAMETER_ARRAY_TOO_SMALL +// +// MessageText: +// +// An array passed to the function cannot hold all of the data that the function must copy into the array. +// +#define STATUS_GRAPHICS_PARAMETER_ARRAY_TOO_SMALL ((NTSTATUS)0xC01E05E6L) + +// +// MessageId: STATUS_GRAPHICS_INTERNAL_ERROR +// +// MessageText: +// +// An internal error caused an operation to fail. +// +#define STATUS_GRAPHICS_INTERNAL_ERROR ((NTSTATUS)0xC01E05E7L) + +// +// MessageId: STATUS_GRAPHICS_SESSION_TYPE_CHANGE_IN_PROGRESS +// +// MessageText: +// +// The function failed because the current session is changing its type. This function cannot be called when the current session is changing its type. There are currently three types of sessions: console, disconnected and remote. +// +#define STATUS_GRAPHICS_SESSION_TYPE_CHANGE_IN_PROGRESS ((NTSTATUS)0xC01E05E8L) + +// +// Basic Display Driver shared status codes {0x0600..0x06DF} +// +// +// MessageId: STATUS_GRAPHICS_UNKNOWN_BIOS_FRAME_BUFFER_NOT_FOUND +// +// MessageText: +// +// The Basic Display Driver cannot start because there is no frame buffer found, and the system cannot determine if the system is BIOS-compatible. +// +#define STATUS_GRAPHICS_UNKNOWN_BIOS_FRAME_BUFFER_NOT_FOUND ((NTSTATUS)0xC01E0600L) + +// +// MessageId: STATUS_GRAPHICS_UEFI_FRAME_BUFFER_NOT_FOUND +// +// MessageText: +// +// The Basic Display Driver cannot start because there is no frame buffer found from UEFI or from a previously running graphics driver. +// +#define STATUS_GRAPHICS_UEFI_FRAME_BUFFER_NOT_FOUND ((NTSTATUS)0xC01E0601L) + + +// +// Camera Error messages (ks.sys, usbvideo.sys) +// The first 50 NTSTATUS are reserved for Camera drivers in Kernel mode, +// which has 1:1 mapping for Error code in WinError.mc file. +// +// The remaining NTSTATUS in camera category may not have mapping with System Error code. +// + +#define IS_CAMERA_NTSTATUS(x) ( ((x) & 0x0FFF0000) == (FACILITY_CAMERA << 16) ) + +// +// MessageId: STATUS_CAMERA_INVALID_CONFIGURATION +// +// MessageText: +// +// A camera's configuration contains some invalid settings. +// +#define STATUS_CAMERA_INVALID_CONFIGURATION ((NTSTATUS)0xC01F0000L) + +// +// MessageId: STATUS_CAMERA_INSUFFICIENT_BANDWIDTH +// +// MessageText: +// +// A camera interface doesn't have the desired bandwidth for data transfer. +// +#define STATUS_CAMERA_INSUFFICIENT_BANDWIDTH ((NTSTATUS)0xC01F0001L) + + +// +// Full Volume Encryption Error codes (fvevol.sys and fvevollib.lib) +// + +// +// MessageId: STATUS_FVE_LOCKED_VOLUME +// +// MessageText: +// +// This volume is locked by BitLocker Drive Encryption. +// +#define STATUS_FVE_LOCKED_VOLUME ((NTSTATUS)0xC0210000L) + +// +// MessageId: STATUS_FVE_NOT_ENCRYPTED +// +// MessageText: +// +// The volume is not encrypted, no key is available. +// +#define STATUS_FVE_NOT_ENCRYPTED ((NTSTATUS)0xC0210001L) + +// +// MessageId: STATUS_FVE_BAD_INFORMATION +// +// MessageText: +// +// The control block for the encrypted volume is not valid. +// +#define STATUS_FVE_BAD_INFORMATION ((NTSTATUS)0xC0210002L) + +// +// MessageId: STATUS_FVE_TOO_SMALL +// +// MessageText: +// +// The volume cannot be encrypted because it does not have enough free space. +// +#define STATUS_FVE_TOO_SMALL ((NTSTATUS)0xC0210003L) + +// +// MessageId: STATUS_FVE_FAILED_WRONG_FS +// +// MessageText: +// +// The volume cannot be encrypted because the file system is not supported. +// +#define STATUS_FVE_FAILED_WRONG_FS ((NTSTATUS)0xC0210004L) + +// +// MessageId: STATUS_FVE_BAD_PARTITION_SIZE +// +// MessageText: +// +// The file system size is larger than the partition size in the partition table. +// +#define STATUS_FVE_BAD_PARTITION_SIZE ((NTSTATUS)0xC0210005L) + +// +// MessageId: STATUS_FVE_FS_NOT_EXTENDED +// +// MessageText: +// +// The file system does not extend to the end of the volume. +// +#define STATUS_FVE_FS_NOT_EXTENDED ((NTSTATUS)0xC0210006L) + +// +// MessageId: STATUS_FVE_FS_MOUNTED +// +// MessageText: +// +// This operation cannot be performed while a file system is mounted on the volume. +// +#define STATUS_FVE_FS_MOUNTED ((NTSTATUS)0xC0210007L) + +// +// MessageId: STATUS_FVE_NO_LICENSE +// +// MessageText: +// +// BitLocker Drive Encryption is not included with this version of Windows. +// +#define STATUS_FVE_NO_LICENSE ((NTSTATUS)0xC0210008L) + +// +// MessageId: STATUS_FVE_ACTION_NOT_ALLOWED +// +// MessageText: +// +// Requested action not allowed in the current volume state. +// +#define STATUS_FVE_ACTION_NOT_ALLOWED ((NTSTATUS)0xC0210009L) + +// +// MessageId: STATUS_FVE_BAD_DATA +// +// MessageText: +// +// Data supplied is malformed. +// +#define STATUS_FVE_BAD_DATA ((NTSTATUS)0xC021000AL) + +// +// MessageId: STATUS_FVE_VOLUME_NOT_BOUND +// +// MessageText: +// +// The volume is not bound to the system. +// +#define STATUS_FVE_VOLUME_NOT_BOUND ((NTSTATUS)0xC021000BL) + +// +// MessageId: STATUS_FVE_NOT_DATA_VOLUME +// +// MessageText: +// +// That volume is not a data volume. +// +#define STATUS_FVE_NOT_DATA_VOLUME ((NTSTATUS)0xC021000CL) + +// +// MessageId: STATUS_FVE_CONV_READ_ERROR +// +// MessageText: +// +// A read operation failed while converting the volume. +// +#define STATUS_FVE_CONV_READ_ERROR ((NTSTATUS)0xC021000DL) + +// +// MessageId: STATUS_FVE_CONV_WRITE_ERROR +// +// MessageText: +// +// A write operation failed while converting the volume. +// +#define STATUS_FVE_CONV_WRITE_ERROR ((NTSTATUS)0xC021000EL) + +// +// MessageId: STATUS_FVE_OVERLAPPED_UPDATE +// +// MessageText: +// +// The control block for the encrypted volume was updated by another thread. Try again. +// +#define STATUS_FVE_OVERLAPPED_UPDATE ((NTSTATUS)0xC021000FL) + +// +// MessageId: STATUS_FVE_FAILED_SECTOR_SIZE +// +// MessageText: +// +// The encryption algorithm does not support the sector size of that volume. +// +#define STATUS_FVE_FAILED_SECTOR_SIZE ((NTSTATUS)0xC0210010L) + +// +// MessageId: STATUS_FVE_FAILED_AUTHENTICATION +// +// MessageText: +// +// BitLocker recovery authentication failed. +// +#define STATUS_FVE_FAILED_AUTHENTICATION ((NTSTATUS)0xC0210011L) + +// +// MessageId: STATUS_FVE_NOT_OS_VOLUME +// +// MessageText: +// +// That volume is not the OS volume. +// +#define STATUS_FVE_NOT_OS_VOLUME ((NTSTATUS)0xC0210012L) + +// +// MessageId: STATUS_FVE_KEYFILE_NOT_FOUND +// +// MessageText: +// +// The BitLocker startup key or recovery password could not be read from external media. +// +#define STATUS_FVE_KEYFILE_NOT_FOUND ((NTSTATUS)0xC0210013L) + +// +// MessageId: STATUS_FVE_KEYFILE_INVALID +// +// MessageText: +// +// The BitLocker startup key or recovery password file is corrupt or invalid. +// +#define STATUS_FVE_KEYFILE_INVALID ((NTSTATUS)0xC0210014L) + +// +// MessageId: STATUS_FVE_KEYFILE_NO_VMK +// +// MessageText: +// +// The BitLocker encryption key could not be obtained from the startup key or recovery password. +// +#define STATUS_FVE_KEYFILE_NO_VMK ((NTSTATUS)0xC0210015L) + +// +// MessageId: STATUS_FVE_TPM_DISABLED +// +// MessageText: +// +// The Trusted Platform Module (TPM) is disabled. +// +#define STATUS_FVE_TPM_DISABLED ((NTSTATUS)0xC0210016L) + +// +// MessageId: STATUS_FVE_TPM_SRK_AUTH_NOT_ZERO +// +// MessageText: +// +// The authorization data for the Storage Root Key (SRK) of the Trusted Platform Module (TPM) is not zero. +// +#define STATUS_FVE_TPM_SRK_AUTH_NOT_ZERO ((NTSTATUS)0xC0210017L) + +// +// MessageId: STATUS_FVE_TPM_INVALID_PCR +// +// MessageText: +// +// The system boot information changed or the Trusted Platform Module (TPM) locked out access to BitLocker encryption keys until the computer is restarted. +// +#define STATUS_FVE_TPM_INVALID_PCR ((NTSTATUS)0xC0210018L) + +// +// MessageId: STATUS_FVE_TPM_NO_VMK +// +// MessageText: +// +// The BitLocker encryption key could not be obtained from the Trusted Platform Module (TPM). +// +#define STATUS_FVE_TPM_NO_VMK ((NTSTATUS)0xC0210019L) + +// +// MessageId: STATUS_FVE_PIN_INVALID +// +// MessageText: +// +// The BitLocker encryption key could not be obtained from the Trusted Platform Module (TPM) and PIN. +// +#define STATUS_FVE_PIN_INVALID ((NTSTATUS)0xC021001AL) + +// +// MessageId: STATUS_FVE_AUTH_INVALID_APPLICATION +// +// MessageText: +// +// A boot application hash does not match the hash computed when BitLocker was turned on. +// +#define STATUS_FVE_AUTH_INVALID_APPLICATION ((NTSTATUS)0xC021001BL) + +// +// MessageId: STATUS_FVE_AUTH_INVALID_CONFIG +// +// MessageText: +// +// The Boot Configuration Data (BCD) settings are not supported or have changed since BitLocker was enabled. +// +#define STATUS_FVE_AUTH_INVALID_CONFIG ((NTSTATUS)0xC021001CL) + +// +// MessageId: STATUS_FVE_DEBUGGER_ENABLED +// +// MessageText: +// +// Boot debugging is enabled. Run bcdedit to turn it off. +// +#define STATUS_FVE_DEBUGGER_ENABLED ((NTSTATUS)0xC021001DL) + +// +// MessageId: STATUS_FVE_DRY_RUN_FAILED +// +// MessageText: +// +// The BitLocker encryption key could not be obtained. +// +#define STATUS_FVE_DRY_RUN_FAILED ((NTSTATUS)0xC021001EL) + +// +// MessageId: STATUS_FVE_BAD_METADATA_POINTER +// +// MessageText: +// +// The metadata disk region pointer is incorrect. +// +#define STATUS_FVE_BAD_METADATA_POINTER ((NTSTATUS)0xC021001FL) + +// +// MessageId: STATUS_FVE_OLD_METADATA_COPY +// +// MessageText: +// +// The backup copy of the metadata is out of date. +// +#define STATUS_FVE_OLD_METADATA_COPY ((NTSTATUS)0xC0210020L) + +// +// MessageId: STATUS_FVE_REBOOT_REQUIRED +// +// MessageText: +// +// No action was taken as a system reboot is required. +// +#define STATUS_FVE_REBOOT_REQUIRED ((NTSTATUS)0xC0210021L) + +// +// MessageId: STATUS_FVE_RAW_ACCESS +// +// MessageText: +// +// No action was taken as BitLocker Drive Encryption is in RAW access mode. +// +#define STATUS_FVE_RAW_ACCESS ((NTSTATUS)0xC0210022L) + +// +// MessageId: STATUS_FVE_RAW_BLOCKED +// +// MessageText: +// +// BitLocker Drive Encryption cannot enter raw access mode for this volume. +// +#define STATUS_FVE_RAW_BLOCKED ((NTSTATUS)0xC0210023L) + +// +// MessageId: STATUS_FVE_NO_AUTOUNLOCK_MASTER_KEY +// +// MessageText: +// +// The auto-unlock master key was not available from the operating system volume. Retry the operation using the BitLocker WMI interface. +// +#define STATUS_FVE_NO_AUTOUNLOCK_MASTER_KEY ((NTSTATUS)0xC0210024L) + +// +// MessageId: STATUS_FVE_MOR_FAILED +// +// MessageText: +// +// The system firmware failed to enable clearing of system memory on reboot. +// +#define STATUS_FVE_MOR_FAILED ((NTSTATUS)0xC0210025L) + +// +// MessageId: STATUS_FVE_NO_FEATURE_LICENSE +// +// MessageText: +// +// This feature of BitLocker Drive Encryption is not included with this version of Windows. +// +#define STATUS_FVE_NO_FEATURE_LICENSE ((NTSTATUS)0xC0210026L) + +// +// MessageId: STATUS_FVE_POLICY_USER_DISABLE_RDV_NOT_ALLOWED +// +// MessageText: +// +// Group policy does not permit turning off BitLocker Drive Encryption on roaming data volumes. +// +#define STATUS_FVE_POLICY_USER_DISABLE_RDV_NOT_ALLOWED ((NTSTATUS)0xC0210027L) + +// +// MessageId: STATUS_FVE_CONV_RECOVERY_FAILED +// +// MessageText: +// +// Bitlocker Drive Encryption failed to recover from aborted conversion. This could be due to either all conversion logs being corrupted or the media being write-protected. +// +#define STATUS_FVE_CONV_RECOVERY_FAILED ((NTSTATUS)0xC0210028L) + +// +// MessageId: STATUS_FVE_VIRTUALIZED_SPACE_TOO_BIG +// +// MessageText: +// +// The requested virtualization size is too big. +// +#define STATUS_FVE_VIRTUALIZED_SPACE_TOO_BIG ((NTSTATUS)0xC0210029L) + +// +// MessageId: STATUS_FVE_INVALID_DATUM_TYPE +// +// MessageText: +// +// The management information stored on the drive contained an unknown type. If you are using an old version of Windows, try accessing the drive from the latest version. +// +#define STATUS_FVE_INVALID_DATUM_TYPE ((NTSTATUS)0xC021002AL) + +// +// MessageId: STATUS_FVE_VOLUME_TOO_SMALL +// +// MessageText: +// +// The drive is too small to be protected using BitLocker Drive Encryption. +// +#define STATUS_FVE_VOLUME_TOO_SMALL ((NTSTATUS)0xC0210030L) + +// +// MessageId: STATUS_FVE_ENH_PIN_INVALID +// +// MessageText: +// +// The BitLocker encryption key could not be obtained from the Trusted Platform Module (TPM) and enhanced PIN. Try using a PIN containing only numerals. +// +#define STATUS_FVE_ENH_PIN_INVALID ((NTSTATUS)0xC0210031L) + +// +// MessageId: STATUS_FVE_FULL_ENCRYPTION_NOT_ALLOWED_ON_TP_STORAGE +// +// MessageText: +// +// BitLocker Drive Encryption only supports Used Space Only encryption on thin provisioned storage. +// +#define STATUS_FVE_FULL_ENCRYPTION_NOT_ALLOWED_ON_TP_STORAGE ((NTSTATUS)0xC0210032L) + +// +// MessageId: STATUS_FVE_WIPE_NOT_ALLOWED_ON_TP_STORAGE +// +// MessageText: +// +// BitLocker Drive Encryption does not support wiping free space on thin provisioned storage. +// +#define STATUS_FVE_WIPE_NOT_ALLOWED_ON_TP_STORAGE ((NTSTATUS)0xC0210033L) + +// +// MessageId: STATUS_FVE_NOT_ALLOWED_ON_CSV_STACK +// +// MessageText: +// +// This command can only be performed from the coordinator node for the specified CSV volume. +// +#define STATUS_FVE_NOT_ALLOWED_ON_CSV_STACK ((NTSTATUS)0xC0210034L) + +// +// MessageId: STATUS_FVE_NOT_ALLOWED_ON_CLUSTER +// +// MessageText: +// +// This command cannot be performed on a volume when it is part of a cluster. +// +#define STATUS_FVE_NOT_ALLOWED_ON_CLUSTER ((NTSTATUS)0xC0210035L) + +// +// MessageId: STATUS_FVE_NOT_ALLOWED_TO_UPGRADE_WHILE_CONVERTING +// +// MessageText: +// +// BitLocker cannot be upgraded during disk encryption or decryption. +// +#define STATUS_FVE_NOT_ALLOWED_TO_UPGRADE_WHILE_CONVERTING ((NTSTATUS)0xC0210036L) + +// +// MessageId: STATUS_FVE_WIPE_CANCEL_NOT_APPLICABLE +// +// MessageText: +// +// Wipe of free space is not currently taking place. +// +#define STATUS_FVE_WIPE_CANCEL_NOT_APPLICABLE ((NTSTATUS)0xC0210037L) + +// +// MessageId: STATUS_FVE_EDRIVE_DRY_RUN_FAILED +// +// MessageText: +// +// Your computer doesn't support BitLocker hardware-based encryption. Check with your computer manufacturer for firmware updates. +// +#define STATUS_FVE_EDRIVE_DRY_RUN_FAILED ((NTSTATUS)0xC0210038L) + +// +// MessageId: STATUS_FVE_SECUREBOOT_DISABLED +// +// MessageText: +// +// Secure Boot has been disabled. Either Secure Boot must be re-enabled, or BitLocker must be suspended for Windows to start normally. +// +#define STATUS_FVE_SECUREBOOT_DISABLED ((NTSTATUS)0xC0210039L) + +// +// MessageId: STATUS_FVE_SECUREBOOT_CONFIG_CHANGE +// +// MessageText: +// +// Secure Boot policy has unexpectedly changed. +// +#define STATUS_FVE_SECUREBOOT_CONFIG_CHANGE ((NTSTATUS)0xC021003AL) + +// +// MessageId: STATUS_FVE_DEVICE_LOCKEDOUT +// +// MessageText: +// +// Device Lock has been triggered due to too many incorrect password attempts. +// +#define STATUS_FVE_DEVICE_LOCKEDOUT ((NTSTATUS)0xC021003BL) + +// +// MessageId: STATUS_FVE_VOLUME_EXTEND_PREVENTS_EOW_DECRYPT +// +// MessageText: +// +// Device encryption removal is blocked due to volume being extended beyond its original size. +// +#define STATUS_FVE_VOLUME_EXTEND_PREVENTS_EOW_DECRYPT ((NTSTATUS)0xC021003CL) + +// +// MessageId: STATUS_FVE_NOT_DE_VOLUME +// +// MessageText: +// +// This action isn't supported because this drive isn't automatically managed with device encryption. +// +#define STATUS_FVE_NOT_DE_VOLUME ((NTSTATUS)0xC021003DL) + +// +// MessageId: STATUS_FVE_PROTECTION_DISABLED +// +// MessageText: +// +// BitLocker Drive Encryption has been suspended on this drive. All BitLocker key protectors configured for this drive are effectively disabled, and the drive will be automatically unlocked using an unencrypted (clear) key. +// +#define STATUS_FVE_PROTECTION_DISABLED ((NTSTATUS)0xC021003EL) + +// +// MessageId: STATUS_FVE_PROTECTION_CANNOT_BE_DISABLED +// +// MessageText: +// +// BitLocker can't be suspended on this drive until the next restart. +// +#define STATUS_FVE_PROTECTION_CANNOT_BE_DISABLED ((NTSTATUS)0xC021003FL) + +// +// MessageId: STATUS_FVE_OSV_KSR_NOT_ALLOWED +// +// MessageText: +// +// BitLocker Drive Encryption policy does not allow KSR operation with protected OS volume. +// +#define STATUS_FVE_OSV_KSR_NOT_ALLOWED ((NTSTATUS)0xC0210040L) + +// +// MessageId: STATUS_FVE_EDRIVE_BAND_ENUMERATION_FAILED +// +// MessageText: +// +// BitLocker can't enable encryption on this hardware encrypting drive volume because the drive bands couldn't be enumerated. +// +#define STATUS_FVE_EDRIVE_BAND_ENUMERATION_FAILED ((NTSTATUS)0xC0210041L) + +// +// MessageId: STATUS_FVE_POLICY_ON_RDV_EXCLUSION_LIST +// +// MessageText: +// +// This removable data drive has been excluded from device encryption by BitLocker Drive Encryption policy. +// +#define STATUS_FVE_POLICY_ON_RDV_EXCLUSION_LIST ((NTSTATUS)0xC0210042L) + +// +// MessageId: STATUS_FVE_DATASET_FULL +// +// MessageText: +// +// This operation cannot be completed because dataset is full. +// +#define STATUS_FVE_DATASET_FULL ((NTSTATUS)0xC0210043L) + +// +// MessageId: STATUS_FVE_METADATA_FULL +// +// MessageText: +// +// This operation cannot be completed because BitLocker Drive Encryption metadata area is full. Consider removing unnecessary key protectors for this drive. +// +#define STATUS_FVE_METADATA_FULL ((NTSTATUS)0xC0210044L) + +// +// MessageId: STATUS_FVE_SUSPEND_PROTECTION_NOT_ALLOWED +// +// MessageText: +// +// The operation failed because BitLocker Drive Encryption cannot suspend protection due to policy. +// +#define STATUS_FVE_SUSPEND_PROTECTION_NOT_ALLOWED ((NTSTATUS)0xC0210045L) + +// +// MessageId: STATUS_FVE_DATUM_PARTIALLY_INVALID +// +// MessageText: +// +// The datum is invalid in its current state, but may be fixed so that it is valid. +// +#define STATUS_FVE_DATUM_PARTIALLY_INVALID ((NTSTATUS)0xC0210046L) + +// +// MessageId: STATUS_FVE_DATASET_TPM_DATUMS_INCONSISTENT +// +// MessageText: +// +// The dataset contains TPM datums that are inconsistent. +// +#define STATUS_FVE_DATASET_TPM_DATUMS_INCONSISTENT ((NTSTATUS)0xC0210047L) + +// +// MessageId: STATUS_FVE_SECURE_BOOT_BINDINGS_OUT_OF_SYNC +// +// MessageText: +// +// The TPM protector contains conflicting information about whether the binding is a Secure Boot binding. +// +#define STATUS_FVE_SECURE_BOOT_BINDINGS_OUT_OF_SYNC ((NTSTATUS)0xC0210048L) + +// +// MessageId: STATUS_FVE_SECURE_BOOT_BINDING_DATA_OUT_OF_SYNC +// +// MessageText: +// +// The dataset contains conflicting information about whether the TPM protector binding is a Secure Boot binding. +// +#define STATUS_FVE_SECURE_BOOT_BINDING_DATA_OUT_OF_SYNC ((NTSTATUS)0xC0210049L) + +// +// MessageId: STATUS_FVE_ORPHANED_TPM_BINDING_DATUM +// +// MessageText: +// +// The dataset contains a TPM binding without associated binding information. Try removing and re-adding the TPM protector. +// +#define STATUS_FVE_ORPHANED_TPM_BINDING_DATUM ((NTSTATUS)0xC021004AL) + +// +// MessageId: STATUS_FVE_BAD_TPM_DATUM_ASSOCIATION +// +// MessageText: +// +// The dataset contains TPM binding information incorrectly associated to multiple TPM bindings. Try re-enabling BitLocker. +// +#define STATUS_FVE_BAD_TPM_DATUM_ASSOCIATION ((NTSTATUS)0xC021004BL) + +// +// MessageId: STATUS_FVE_FINAL_TPM_PCR_VALUES_MATCH +// +// MessageText: +// +// The compared final TPM PCR values match. +// +#define STATUS_FVE_FINAL_TPM_PCR_VALUES_MATCH ((NTSTATUS)0xC021004CL) + +// +// MessageId: STATUS_FVE_MATCHING_PCRS_TPM_FAILURE +// +// MessageText: +// +// BitLocker failed to obtain the key from the TPM due to an unforseen TPM failure. +// +#define STATUS_FVE_MATCHING_PCRS_TPM_FAILURE ((NTSTATUS)0xC021004DL) + +// +// MessageId: STATUS_FVE_GENERAL_TPM_FAILURE +// +// MessageText: +// +// BitLocker encountered a problem communicating with the TPM at boot. +// +#define STATUS_FVE_GENERAL_TPM_FAILURE ((NTSTATUS)0xC021004EL) + +// +// MessageId: STATUS_FVE_TPM_NONEXISTENT +// +// MessageText: +// +// A TPM was not available for BitLocker at boot. +// +#define STATUS_FVE_TPM_NONEXISTENT ((NTSTATUS)0xC021004FL) + +// +// MessageId: STATUS_FVE_NO_PCR_BOOT_LOCK_BOUNDARY +// +// MessageText: +// +// BitLocker could not enforce the PCR 11 cap event boundary. +// +#define STATUS_FVE_NO_PCR_BOOT_LOCK_BOUNDARY ((NTSTATUS)0xC0210050L) + +// +// MessageId: STATUS_FVE_PCR_BOOT_LOCK_BOUNDARY +// +// MessageText: +// +// BitLocker prevented an attempt to create a TPM binding for a PCR that contains events extended into the TPM after the BitLocker boot lock event. +// +#define STATUS_FVE_PCR_BOOT_LOCK_BOUNDARY ((NTSTATUS)0xC0210051L) + +// +// MessageId: STATUS_FVE_FW_UPDATE_TPM_BINDINGS_NOT_REFRESHED +// +// MessageText: +// +// The firmware update was not applied because BitLocker TPM bindings do not include the latest measurements. Restart your computer to retry. +// +#define STATUS_FVE_FW_UPDATE_TPM_BINDINGS_NOT_REFRESHED ((NTSTATUS)0xC0210052L) + +// +// MessageId: STATUS_FVE_INVALID_TPM_BINDING_CONFIGURATION +// +// MessageText: +// +// The BitLocker TPM binding configuration is invalid. +// +#define STATUS_FVE_INVALID_TPM_BINDING_CONFIGURATION ((NTSTATUS)0xC0210053L) + +// +// MessageId: STATUS_FVE_TOO_MANY_TPM_BINDINGS +// +// MessageText: +// +// The BitLocker TPM protector cannot fit all the necessary TPM bindings. +// +#define STATUS_FVE_TOO_MANY_TPM_BINDINGS ((NTSTATUS)0xC0210054L) + +// +// MessageId: STATUS_FVE_TPM_BINDING_ASSOCIATION_FAILURE +// +// MessageText: +// +// A BitLocker TPM protector binding is badly formatted. +// +#define STATUS_FVE_TPM_BINDING_ASSOCIATION_FAILURE ((NTSTATUS)0xC0210055L) + +// +// MessageId: STATUS_FVE_ORPHANED_PCR_DIGEST_DATUM +// +// MessageText: +// +// The dataset contains binding information without an associated TPM binding. Try re-enabling BitLocker. +// +#define STATUS_FVE_ORPHANED_PCR_DIGEST_DATUM ((NTSTATUS)0xC0210056L) + +// +// MessageId: STATUS_FVE_HW_ACCELERATED_ENCRYPTION_NOT_ALLOWED +// +// MessageText: +// +// BitLocker is prevented from using hardware accelerated encryption. +// +#define STATUS_FVE_HW_ACCELERATED_ENCRYPTION_NOT_ALLOWED ((NTSTATUS)0xC0210057L) + +// +// MessageId: STATUS_FVE_NO_MATCHING_TPM_BINDINGS +// +// MessageText: +// +// BitLocker failed to find a TPM binding that can be used to unlock the drive. +// +#define STATUS_FVE_NO_MATCHING_TPM_BINDINGS ((NTSTATUS)0xC0210058L) + +// +// MessageId: STATUS_FVE_TPMPV2_USED_FAILURE +// +// MessageText: +// +// BitLocker failed to unlock the drive using a V2 TPM protector. +// +#define STATUS_FVE_TPMPV2_USED_FAILURE ((NTSTATUS)0xC0210059L) + +// +// MessageId: STATUS_FVE_NO_TPM_BINDINGS +// +// MessageText: +// +// BitLocker failed to find any TPM bindings that can be used to unlock the drive. +// +#define STATUS_FVE_NO_TPM_BINDINGS ((NTSTATUS)0xC021005AL) + +// +// MessageId: STATUS_FVE_FW_UPDATE_PCRS_BLOCK +// +// MessageText: +// +// The firmware update was not applied. To finish installation of the firmware, please suspend BitLocker and restart your device. +// +#define STATUS_FVE_FW_UPDATE_PCRS_BLOCK ((NTSTATUS)0xC021005CL) + +// +// MessageId: STATUS_FVE_FW_UPDATE_PCRS_NOT_EXCLUDED +// +// MessageText: +// +// The firmware update was not applied because TPM PCRs affected by the firmware installation were not excluded by BitLocker's TPM protector. Restart your computer to retry. +// +#define STATUS_FVE_FW_UPDATE_PCRS_NOT_EXCLUDED ((NTSTATUS)0xC021005DL) + +// +// MessageId: STATUS_FVE_FAILED_TO_UNWRAP_HW_WRAPPED_KEY +// +// MessageText: +// +// The hardware crypto key manager failed to unwrap a hardware wrapped key. +// +#define STATUS_FVE_FAILED_TO_UNWRAP_HW_WRAPPED_KEY ((NTSTATUS)0xC021005EL) + +// +// MessageId: STATUS_FVE_HARDWARE_CRYPTO_ACCELERATOR_NOT_FIPS_COMPLIANT +// +// MessageText: +// +// FIPS compliance is required, but the hardware crypto accelerator does not report compliance with this standard. +// +#define STATUS_FVE_HARDWARE_CRYPTO_ACCELERATOR_NOT_FIPS_COMPLIANT ((NTSTATUS)0xC021005FL) + +// +// MessageId: STATUS_FVE_HARDWARE_CRYPTO_KEY_MANAGER_NOT_FIPS_COMPLIANT +// +// MessageText: +// +// FIPS compliance is required, but the hardware crypto key manager does not report compliance with this standard. +// +#define STATUS_FVE_HARDWARE_CRYPTO_KEY_MANAGER_NOT_FIPS_COMPLIANT ((NTSTATUS)0xC0210060L) + +// +// MessageId: STATUS_FVE_TPM_PCRS_DO_NOT_MATCH_LOG +// +// MessageText: +// +// The TPM PCR values did not match what was calculated from the TCG log. +// +#define STATUS_FVE_TPM_PCRS_DO_NOT_MATCH_LOG ((NTSTATUS)0xC0210061L) + + +// +// FWP error codes (fwpkclnt.sys) +// + +// +// MessageId: STATUS_FWP_CALLOUT_NOT_FOUND +// +// MessageText: +// +// The callout does not exist. +// +#define STATUS_FWP_CALLOUT_NOT_FOUND ((NTSTATUS)0xC0220001L) + +// +// MessageId: STATUS_FWP_CONDITION_NOT_FOUND +// +// MessageText: +// +// The filter condition does not exist. +// +#define STATUS_FWP_CONDITION_NOT_FOUND ((NTSTATUS)0xC0220002L) + +// +// MessageId: STATUS_FWP_FILTER_NOT_FOUND +// +// MessageText: +// +// The filter does not exist. +// +#define STATUS_FWP_FILTER_NOT_FOUND ((NTSTATUS)0xC0220003L) + +// +// MessageId: STATUS_FWP_LAYER_NOT_FOUND +// +// MessageText: +// +// The layer does not exist. +// +#define STATUS_FWP_LAYER_NOT_FOUND ((NTSTATUS)0xC0220004L) + +// +// MessageId: STATUS_FWP_PROVIDER_NOT_FOUND +// +// MessageText: +// +// The provider does not exist. +// +#define STATUS_FWP_PROVIDER_NOT_FOUND ((NTSTATUS)0xC0220005L) + +// +// MessageId: STATUS_FWP_PROVIDER_CONTEXT_NOT_FOUND +// +// MessageText: +// +// The provider context does not exist. +// +#define STATUS_FWP_PROVIDER_CONTEXT_NOT_FOUND ((NTSTATUS)0xC0220006L) + +// +// MessageId: STATUS_FWP_SUBLAYER_NOT_FOUND +// +// MessageText: +// +// The sublayer does not exist. +// +#define STATUS_FWP_SUBLAYER_NOT_FOUND ((NTSTATUS)0xC0220007L) + +// +// MessageId: STATUS_FWP_NOT_FOUND +// +// MessageText: +// +// The object does not exist. +// +#define STATUS_FWP_NOT_FOUND ((NTSTATUS)0xC0220008L) + +// +// MessageId: STATUS_FWP_ALREADY_EXISTS +// +// MessageText: +// +// An object with that GUID or LUID already exists. +// +#define STATUS_FWP_ALREADY_EXISTS ((NTSTATUS)0xC0220009L) + +// +// MessageId: STATUS_FWP_IN_USE +// +// MessageText: +// +// The object is referenced by other objects so cannot be deleted. +// +#define STATUS_FWP_IN_USE ((NTSTATUS)0xC022000AL) + +// +// MessageId: STATUS_FWP_DYNAMIC_SESSION_IN_PROGRESS +// +// MessageText: +// +// The call is not allowed from within a dynamic session. +// +#define STATUS_FWP_DYNAMIC_SESSION_IN_PROGRESS ((NTSTATUS)0xC022000BL) + +// +// MessageId: STATUS_FWP_WRONG_SESSION +// +// MessageText: +// +// The call was made from the wrong session so cannot be completed. +// +#define STATUS_FWP_WRONG_SESSION ((NTSTATUS)0xC022000CL) + +// +// MessageId: STATUS_FWP_NO_TXN_IN_PROGRESS +// +// MessageText: +// +// The call must be made from within an explicit transaction. +// +#define STATUS_FWP_NO_TXN_IN_PROGRESS ((NTSTATUS)0xC022000DL) + +// +// MessageId: STATUS_FWP_TXN_IN_PROGRESS +// +// MessageText: +// +// The call is not allowed from within an explicit transaction. +// +#define STATUS_FWP_TXN_IN_PROGRESS ((NTSTATUS)0xC022000EL) + +// +// MessageId: STATUS_FWP_TXN_ABORTED +// +// MessageText: +// +// The explicit transaction has been forcibly cancelled. +// +#define STATUS_FWP_TXN_ABORTED ((NTSTATUS)0xC022000FL) + +// +// MessageId: STATUS_FWP_SESSION_ABORTED +// +// MessageText: +// +// The session has been cancelled. +// +#define STATUS_FWP_SESSION_ABORTED ((NTSTATUS)0xC0220010L) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_TXN +// +// MessageText: +// +// The call is not allowed from within a read-only transaction. +// +#define STATUS_FWP_INCOMPATIBLE_TXN ((NTSTATUS)0xC0220011L) + +// +// MessageId: STATUS_FWP_TIMEOUT +// +// MessageText: +// +// The call timed out while waiting to acquire the transaction lock. +// +#define STATUS_FWP_TIMEOUT ((NTSTATUS)0xC0220012L) + +// +// MessageId: STATUS_FWP_NET_EVENTS_DISABLED +// +// MessageText: +// +// Collection of network diagnostic events is disabled. +// +#define STATUS_FWP_NET_EVENTS_DISABLED ((NTSTATUS)0xC0220013L) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_LAYER +// +// MessageText: +// +// The operation is not supported by the specified layer. +// +#define STATUS_FWP_INCOMPATIBLE_LAYER ((NTSTATUS)0xC0220014L) + +// +// MessageId: STATUS_FWP_KM_CLIENTS_ONLY +// +// MessageText: +// +// The call is allowed for kernel-mode callers only. +// +#define STATUS_FWP_KM_CLIENTS_ONLY ((NTSTATUS)0xC0220015L) + +// +// MessageId: STATUS_FWP_LIFETIME_MISMATCH +// +// MessageText: +// +// The call tried to associate two objects with incompatible lifetimes. +// +#define STATUS_FWP_LIFETIME_MISMATCH ((NTSTATUS)0xC0220016L) + +// +// MessageId: STATUS_FWP_BUILTIN_OBJECT +// +// MessageText: +// +// The object is built in so cannot be deleted. +// +#define STATUS_FWP_BUILTIN_OBJECT ((NTSTATUS)0xC0220017L) + +// +// MessageId: STATUS_FWP_TOO_MANY_CALLOUTS +// +// MessageText: +// +// The maximum number of callouts has been reached. +// +#define STATUS_FWP_TOO_MANY_CALLOUTS ((NTSTATUS)0xC0220018L) + +// +// MessageId: STATUS_FWP_NOTIFICATION_DROPPED +// +// MessageText: +// +// A notification could not be delivered because a message queue is at its maximum capacity. +// +#define STATUS_FWP_NOTIFICATION_DROPPED ((NTSTATUS)0xC0220019L) + +// +// MessageId: STATUS_FWP_TRAFFIC_MISMATCH +// +// MessageText: +// +// The traffic parameters do not match those for the security association context. +// +#define STATUS_FWP_TRAFFIC_MISMATCH ((NTSTATUS)0xC022001AL) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_SA_STATE +// +// MessageText: +// +// The call is not allowed for the current security association state. +// +#define STATUS_FWP_INCOMPATIBLE_SA_STATE ((NTSTATUS)0xC022001BL) + +// +// MessageId: STATUS_FWP_NULL_POINTER +// +// MessageText: +// +// A required pointer is null. +// +#define STATUS_FWP_NULL_POINTER ((NTSTATUS)0xC022001CL) + +// +// MessageId: STATUS_FWP_INVALID_ENUMERATOR +// +// MessageText: +// +// An enumerator is not valid. +// +#define STATUS_FWP_INVALID_ENUMERATOR ((NTSTATUS)0xC022001DL) + +// +// MessageId: STATUS_FWP_INVALID_FLAGS +// +// MessageText: +// +// The flags field contains an invalid value. +// +#define STATUS_FWP_INVALID_FLAGS ((NTSTATUS)0xC022001EL) + +// +// MessageId: STATUS_FWP_INVALID_NET_MASK +// +// MessageText: +// +// A network mask is not valid. +// +#define STATUS_FWP_INVALID_NET_MASK ((NTSTATUS)0xC022001FL) + +// +// MessageId: STATUS_FWP_INVALID_RANGE +// +// MessageText: +// +// An FWP_RANGE is not valid. +// +#define STATUS_FWP_INVALID_RANGE ((NTSTATUS)0xC0220020L) + +// +// MessageId: STATUS_FWP_INVALID_INTERVAL +// +// MessageText: +// +// The time interval is not valid. +// +#define STATUS_FWP_INVALID_INTERVAL ((NTSTATUS)0xC0220021L) + +// +// MessageId: STATUS_FWP_ZERO_LENGTH_ARRAY +// +// MessageText: +// +// An array that must contain at least one element is zero length. +// +#define STATUS_FWP_ZERO_LENGTH_ARRAY ((NTSTATUS)0xC0220022L) + +// +// MessageId: STATUS_FWP_NULL_DISPLAY_NAME +// +// MessageText: +// +// The displayData.name field cannot be null. +// +#define STATUS_FWP_NULL_DISPLAY_NAME ((NTSTATUS)0xC0220023L) + +// +// MessageId: STATUS_FWP_INVALID_ACTION_TYPE +// +// MessageText: +// +// The action type is not one of the allowed action types for a filter. +// +#define STATUS_FWP_INVALID_ACTION_TYPE ((NTSTATUS)0xC0220024L) + +// +// MessageId: STATUS_FWP_INVALID_WEIGHT +// +// MessageText: +// +// The filter weight is not valid. +// +#define STATUS_FWP_INVALID_WEIGHT ((NTSTATUS)0xC0220025L) + +// +// MessageId: STATUS_FWP_MATCH_TYPE_MISMATCH +// +// MessageText: +// +// A filter condition contains a match type that is not compatible with the operands. +// +#define STATUS_FWP_MATCH_TYPE_MISMATCH ((NTSTATUS)0xC0220026L) + +// +// MessageId: STATUS_FWP_TYPE_MISMATCH +// +// MessageText: +// +// An FWP_VALUE or FWPM_CONDITION_VALUE is of the wrong type. +// +#define STATUS_FWP_TYPE_MISMATCH ((NTSTATUS)0xC0220027L) + +// +// MessageId: STATUS_FWP_OUT_OF_BOUNDS +// +// MessageText: +// +// An integer value is outside the allowed range. +// +#define STATUS_FWP_OUT_OF_BOUNDS ((NTSTATUS)0xC0220028L) + +// +// MessageId: STATUS_FWP_RESERVED +// +// MessageText: +// +// A reserved field is non-zero. +// +#define STATUS_FWP_RESERVED ((NTSTATUS)0xC0220029L) + +// +// MessageId: STATUS_FWP_DUPLICATE_CONDITION +// +// MessageText: +// +// A filter cannot contain multiple conditions operating on a single field. +// +#define STATUS_FWP_DUPLICATE_CONDITION ((NTSTATUS)0xC022002AL) + +// +// MessageId: STATUS_FWP_DUPLICATE_KEYMOD +// +// MessageText: +// +// A policy cannot contain the same keying module more than once. +// +#define STATUS_FWP_DUPLICATE_KEYMOD ((NTSTATUS)0xC022002BL) + +// +// MessageId: STATUS_FWP_ACTION_INCOMPATIBLE_WITH_LAYER +// +// MessageText: +// +// The action type is not compatible with the layer. +// +#define STATUS_FWP_ACTION_INCOMPATIBLE_WITH_LAYER ((NTSTATUS)0xC022002CL) + +// +// MessageId: STATUS_FWP_ACTION_INCOMPATIBLE_WITH_SUBLAYER +// +// MessageText: +// +// The action type is not compatible with the sublayer. +// +#define STATUS_FWP_ACTION_INCOMPATIBLE_WITH_SUBLAYER ((NTSTATUS)0xC022002DL) + +// +// MessageId: STATUS_FWP_CONTEXT_INCOMPATIBLE_WITH_LAYER +// +// MessageText: +// +// The raw context or the provider context is not compatible with the layer. +// +#define STATUS_FWP_CONTEXT_INCOMPATIBLE_WITH_LAYER ((NTSTATUS)0xC022002EL) + +// +// MessageId: STATUS_FWP_CONTEXT_INCOMPATIBLE_WITH_CALLOUT +// +// MessageText: +// +// The raw context or the provider context is not compatible with the callout. +// +#define STATUS_FWP_CONTEXT_INCOMPATIBLE_WITH_CALLOUT ((NTSTATUS)0xC022002FL) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_AUTH_METHOD +// +// MessageText: +// +// The authentication method is not compatible with the policy type. +// +#define STATUS_FWP_INCOMPATIBLE_AUTH_METHOD ((NTSTATUS)0xC0220030L) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_DH_GROUP +// +// MessageText: +// +// The Diffie-Hellman group is not compatible with the policy type. +// +#define STATUS_FWP_INCOMPATIBLE_DH_GROUP ((NTSTATUS)0xC0220031L) + +// +// MessageId: STATUS_FWP_EM_NOT_SUPPORTED +// +// MessageText: +// +// An IKE policy cannot contain an Extended Mode policy. +// +#define STATUS_FWP_EM_NOT_SUPPORTED ((NTSTATUS)0xC0220032L) + +// +// MessageId: STATUS_FWP_NEVER_MATCH +// +// MessageText: +// +// The enumeration template or subscription will never match any objects. +// +#define STATUS_FWP_NEVER_MATCH ((NTSTATUS)0xC0220033L) + +// +// MessageId: STATUS_FWP_PROVIDER_CONTEXT_MISMATCH +// +// MessageText: +// +// The provider context is of the wrong type. +// +#define STATUS_FWP_PROVIDER_CONTEXT_MISMATCH ((NTSTATUS)0xC0220034L) + +// +// MessageId: STATUS_FWP_INVALID_PARAMETER +// +// MessageText: +// +// The parameter is incorrect. +// +#define STATUS_FWP_INVALID_PARAMETER ((NTSTATUS)0xC0220035L) + +// +// MessageId: STATUS_FWP_TOO_MANY_SUBLAYERS +// +// MessageText: +// +// The maximum number of sublayers has been reached. +// +#define STATUS_FWP_TOO_MANY_SUBLAYERS ((NTSTATUS)0xC0220036L) + +// +// MessageId: STATUS_FWP_CALLOUT_NOTIFICATION_FAILED +// +// MessageText: +// +// The notification function for a callout returned an error. +// +#define STATUS_FWP_CALLOUT_NOTIFICATION_FAILED ((NTSTATUS)0xC0220037L) + +// +// MessageId: STATUS_FWP_INVALID_AUTH_TRANSFORM +// +// MessageText: +// +// The IPsec authentication transform is not valid. +// +#define STATUS_FWP_INVALID_AUTH_TRANSFORM ((NTSTATUS)0xC0220038L) + +// +// MessageId: STATUS_FWP_INVALID_CIPHER_TRANSFORM +// +// MessageText: +// +// The IPsec cipher transform is not valid. +// +#define STATUS_FWP_INVALID_CIPHER_TRANSFORM ((NTSTATUS)0xC0220039L) + +// +// MessageId: STATUS_FWP_INCOMPATIBLE_CIPHER_TRANSFORM +// +// MessageText: +// +// The IPsec cipher transform is not compatible with the policy. +// +#define STATUS_FWP_INCOMPATIBLE_CIPHER_TRANSFORM ((NTSTATUS)0xC022003AL) + +// +// MessageId: STATUS_FWP_INVALID_TRANSFORM_COMBINATION +// +// MessageText: +// +// The combination of IPsec transform types is not valid. +// +#define STATUS_FWP_INVALID_TRANSFORM_COMBINATION ((NTSTATUS)0xC022003BL) + +// +// MessageId: STATUS_FWP_DUPLICATE_AUTH_METHOD +// +// MessageText: +// +// A policy cannot contain the same auth method more than once. +// +#define STATUS_FWP_DUPLICATE_AUTH_METHOD ((NTSTATUS)0xC022003CL) + +// +// MessageId: STATUS_FWP_INVALID_TUNNEL_ENDPOINT +// +// MessageText: +// +// A tunnel endpoint configuration is invalid. +// +#define STATUS_FWP_INVALID_TUNNEL_ENDPOINT ((NTSTATUS)0xC022003DL) + +// +// MessageId: STATUS_FWP_L2_DRIVER_NOT_READY +// +// MessageText: +// +// The WFP MAC Layers are not ready. +// +#define STATUS_FWP_L2_DRIVER_NOT_READY ((NTSTATUS)0xC022003EL) + +// +// MessageId: STATUS_FWP_KEY_DICTATOR_ALREADY_REGISTERED +// +// MessageText: +// +// A key manager capable of key dictation is already registered +// +#define STATUS_FWP_KEY_DICTATOR_ALREADY_REGISTERED ((NTSTATUS)0xC022003FL) + +// +// MessageId: STATUS_FWP_KEY_DICTATION_INVALID_KEYING_MATERIAL +// +// MessageText: +// +// A key manager dictated invalid keys +// +#define STATUS_FWP_KEY_DICTATION_INVALID_KEYING_MATERIAL ((NTSTATUS)0xC0220040L) + +// +// MessageId: STATUS_FWP_CONNECTIONS_DISABLED +// +// MessageText: +// +// The BFE IPsec Connection Tracking is disabled. +// +#define STATUS_FWP_CONNECTIONS_DISABLED ((NTSTATUS)0xC0220041L) + +// +// MessageId: STATUS_FWP_INVALID_DNS_NAME +// +// MessageText: +// +// The DNS name is invalid. +// +#define STATUS_FWP_INVALID_DNS_NAME ((NTSTATUS)0xC0220042L) + +// +// MessageId: STATUS_FWP_STILL_ON +// +// MessageText: +// +// The engine option is still enabled due to other configuration settings. +// +#define STATUS_FWP_STILL_ON ((NTSTATUS)0xC0220043L) + +// +// MessageId: STATUS_FWP_IKEEXT_NOT_RUNNING +// +// MessageText: +// +// The IKEEXT service is not running. This service only runs when there is IPsec policy applied to the machine. +// +#define STATUS_FWP_IKEEXT_NOT_RUNNING ((NTSTATUS)0xC0220044L) + +// +// MessageId: STATUS_FWP_TCPIP_NOT_READY +// +// MessageText: +// +// The TCP/IP stack is not ready. +// +#define STATUS_FWP_TCPIP_NOT_READY ((NTSTATUS)0xC0220100L) + +// +// MessageId: STATUS_FWP_INJECT_HANDLE_CLOSING +// +// MessageText: +// +// The injection handle is being closed by another thread. +// +#define STATUS_FWP_INJECT_HANDLE_CLOSING ((NTSTATUS)0xC0220101L) + +// +// MessageId: STATUS_FWP_INJECT_HANDLE_STALE +// +// MessageText: +// +// The injection handle is stale. +// +#define STATUS_FWP_INJECT_HANDLE_STALE ((NTSTATUS)0xC0220102L) + +// +// MessageId: STATUS_FWP_CANNOT_PEND +// +// MessageText: +// +// The classify cannot be pended. +// +#define STATUS_FWP_CANNOT_PEND ((NTSTATUS)0xC0220103L) + +// +// MessageId: STATUS_FWP_DROP_NOICMP +// +// MessageText: +// +// The packet should be dropped, no ICMP should be sent. +// +#define STATUS_FWP_DROP_NOICMP ((NTSTATUS)0xC0220104L) + + +// +// NDIS error codes (ndis.sys) +// + +// +// MessageId: STATUS_NDIS_CLOSING +// +// MessageText: +// +// The binding to the network interface is being closed. +// +#define STATUS_NDIS_CLOSING ((NTSTATUS)0xC0230002L) + +// +// MessageId: STATUS_NDIS_BAD_VERSION +// +// MessageText: +// +// An invalid version was specified. +// +#define STATUS_NDIS_BAD_VERSION ((NTSTATUS)0xC0230004L) + +// +// MessageId: STATUS_NDIS_BAD_CHARACTERISTICS +// +// MessageText: +// +// An invalid characteristics table was used. +// +#define STATUS_NDIS_BAD_CHARACTERISTICS ((NTSTATUS)0xC0230005L) + +// +// MessageId: STATUS_NDIS_ADAPTER_NOT_FOUND +// +// MessageText: +// +// Failed to find the network interface or network interface is not ready. +// +#define STATUS_NDIS_ADAPTER_NOT_FOUND ((NTSTATUS)0xC0230006L) + +// +// MessageId: STATUS_NDIS_OPEN_FAILED +// +// MessageText: +// +// Failed to open the network interface. +// +#define STATUS_NDIS_OPEN_FAILED ((NTSTATUS)0xC0230007L) + +// +// MessageId: STATUS_NDIS_DEVICE_FAILED +// +// MessageText: +// +// Network interface has encountered an internal unrecoverable failure. +// +#define STATUS_NDIS_DEVICE_FAILED ((NTSTATUS)0xC0230008L) + +// +// MessageId: STATUS_NDIS_MULTICAST_FULL +// +// MessageText: +// +// The multicast list on the network interface is full. +// +#define STATUS_NDIS_MULTICAST_FULL ((NTSTATUS)0xC0230009L) + +// +// MessageId: STATUS_NDIS_MULTICAST_EXISTS +// +// MessageText: +// +// An attempt was made to add a duplicate multicast address to the list. +// +#define STATUS_NDIS_MULTICAST_EXISTS ((NTSTATUS)0xC023000AL) + +// +// MessageId: STATUS_NDIS_MULTICAST_NOT_FOUND +// +// MessageText: +// +// At attempt was made to remove a multicast address that was never added. +// +#define STATUS_NDIS_MULTICAST_NOT_FOUND ((NTSTATUS)0xC023000BL) + +// +// MessageId: STATUS_NDIS_REQUEST_ABORTED +// +// MessageText: +// +// Network interface aborted the request. +// +#define STATUS_NDIS_REQUEST_ABORTED ((NTSTATUS)0xC023000CL) + +// +// MessageId: STATUS_NDIS_RESET_IN_PROGRESS +// +// MessageText: +// +// Network interface can not process the request because it is being reset. +// +#define STATUS_NDIS_RESET_IN_PROGRESS ((NTSTATUS)0xC023000DL) + +// +// MessageId: STATUS_NDIS_NOT_SUPPORTED +// +// MessageText: +// +// Network interface does not support this request. +// +#define STATUS_NDIS_NOT_SUPPORTED ((NTSTATUS)0xC02300BBL) + +// +// MessageId: STATUS_NDIS_INVALID_PACKET +// +// MessageText: +// +// An attempt was made to send an invalid packet on a network interface. +// +#define STATUS_NDIS_INVALID_PACKET ((NTSTATUS)0xC023000FL) + +// +// MessageId: STATUS_NDIS_ADAPTER_NOT_READY +// +// MessageText: +// +// Network interface is not ready to complete this operation. +// +#define STATUS_NDIS_ADAPTER_NOT_READY ((NTSTATUS)0xC0230011L) + +// +// MessageId: STATUS_NDIS_INVALID_LENGTH +// +// MessageText: +// +// The length of the buffer submitted for this operation is not valid. +// +#define STATUS_NDIS_INVALID_LENGTH ((NTSTATUS)0xC0230014L) + +// +// MessageId: STATUS_NDIS_INVALID_DATA +// +// MessageText: +// +// The data used for this operation is not valid. +// +#define STATUS_NDIS_INVALID_DATA ((NTSTATUS)0xC0230015L) + +// +// MessageId: STATUS_NDIS_BUFFER_TOO_SHORT +// +// MessageText: +// +// The length of buffer submitted for this operation is too small. +// +#define STATUS_NDIS_BUFFER_TOO_SHORT ((NTSTATUS)0xC0230016L) + +// +// MessageId: STATUS_NDIS_INVALID_OID +// +// MessageText: +// +// Network interface does not support this OID (Object Identifier) +// +#define STATUS_NDIS_INVALID_OID ((NTSTATUS)0xC0230017L) + +// +// MessageId: STATUS_NDIS_ADAPTER_REMOVED +// +// MessageText: +// +// The network interface has been removed. +// +#define STATUS_NDIS_ADAPTER_REMOVED ((NTSTATUS)0xC0230018L) + +// +// MessageId: STATUS_NDIS_UNSUPPORTED_MEDIA +// +// MessageText: +// +// Network interface does not support this media type. +// +#define STATUS_NDIS_UNSUPPORTED_MEDIA ((NTSTATUS)0xC0230019L) + +// +// MessageId: STATUS_NDIS_GROUP_ADDRESS_IN_USE +// +// MessageText: +// +// An attempt was made to remove a token ring group address that is in use by other components. +// +#define STATUS_NDIS_GROUP_ADDRESS_IN_USE ((NTSTATUS)0xC023001AL) + +// +// MessageId: STATUS_NDIS_FILE_NOT_FOUND +// +// MessageText: +// +// An attempt was made to map a file that can not be found. +// +#define STATUS_NDIS_FILE_NOT_FOUND ((NTSTATUS)0xC023001BL) + +// +// MessageId: STATUS_NDIS_ERROR_READING_FILE +// +// MessageText: +// +// An error occurred while NDIS tried to map the file. +// +#define STATUS_NDIS_ERROR_READING_FILE ((NTSTATUS)0xC023001CL) + +// +// MessageId: STATUS_NDIS_ALREADY_MAPPED +// +// MessageText: +// +// An attempt was made to map a file that is already mapped. +// +#define STATUS_NDIS_ALREADY_MAPPED ((NTSTATUS)0xC023001DL) + +// +// MessageId: STATUS_NDIS_RESOURCE_CONFLICT +// +// MessageText: +// +// An attempt to allocate a hardware resource failed because the resource is used by another component. +// +#define STATUS_NDIS_RESOURCE_CONFLICT ((NTSTATUS)0xC023001EL) + +// +// MessageId: STATUS_NDIS_MEDIA_DISCONNECTED +// +// MessageText: +// +// The I/O operation failed because network media is disconnected or wireless access point is out of range. +// +#define STATUS_NDIS_MEDIA_DISCONNECTED ((NTSTATUS)0xC023001FL) + +// +// MessageId: STATUS_NDIS_INVALID_ADDRESS +// +// MessageText: +// +// The network address used in the request is invalid. +// +#define STATUS_NDIS_INVALID_ADDRESS ((NTSTATUS)0xC0230022L) + +// +// MessageId: STATUS_NDIS_INVALID_DEVICE_REQUEST +// +// MessageText: +// +// The specified request is not a valid operation for the target device. +// +#define STATUS_NDIS_INVALID_DEVICE_REQUEST ((NTSTATUS)0xC0230010L) + +// +// MessageId: STATUS_NDIS_PAUSED +// +// MessageText: +// +// The offload operation on the network interface has been paused. +// +#define STATUS_NDIS_PAUSED ((NTSTATUS)0xC023002AL) + +// +// MessageId: STATUS_NDIS_INTERFACE_NOT_FOUND +// +// MessageText: +// +// Network interface was not found. +// +#define STATUS_NDIS_INTERFACE_NOT_FOUND ((NTSTATUS)0xC023002BL) + +// +// MessageId: STATUS_NDIS_UNSUPPORTED_REVISION +// +// MessageText: +// +// The revision number specified in the structure is not supported. +// +#define STATUS_NDIS_UNSUPPORTED_REVISION ((NTSTATUS)0xC023002CL) + +// +// MessageId: STATUS_NDIS_INVALID_PORT +// +// MessageText: +// +// The specified port does not exist on this network interface. +// +#define STATUS_NDIS_INVALID_PORT ((NTSTATUS)0xC023002DL) + +// +// MessageId: STATUS_NDIS_INVALID_PORT_STATE +// +// MessageText: +// +// The current state of the specified port on this network interface does not support the requested operation. +// +#define STATUS_NDIS_INVALID_PORT_STATE ((NTSTATUS)0xC023002EL) + +// +// MessageId: STATUS_NDIS_LOW_POWER_STATE +// +// MessageText: +// +// The miniport adapter is in lower power state. +// +#define STATUS_NDIS_LOW_POWER_STATE ((NTSTATUS)0xC023002FL) + +// +// MessageId: STATUS_NDIS_REINIT_REQUIRED +// +// MessageText: +// +// This operation requires the miniport adapter to be reinitialized. +// +#define STATUS_NDIS_REINIT_REQUIRED ((NTSTATUS)0xC0230030L) + +// +// MessageId: STATUS_NDIS_NO_QUEUES +// +// MessageText: +// +// There are not enough queues to complete the operation. +// +#define STATUS_NDIS_NO_QUEUES ((NTSTATUS)0xC0230031L) + + +// +// NDIS error codes (802.11 wireless LAN) +// + +// +// MessageId: STATUS_NDIS_DOT11_AUTO_CONFIG_ENABLED +// +// MessageText: +// +// The wireless local area network interface is in auto configuration mode and doesn't support the requested parameter change operation. +// +#define STATUS_NDIS_DOT11_AUTO_CONFIG_ENABLED ((NTSTATUS)0xC0232000L) + +// +// MessageId: STATUS_NDIS_DOT11_MEDIA_IN_USE +// +// MessageText: +// +// The wireless local area network interface is busy and can not perform the requested operation. +// +#define STATUS_NDIS_DOT11_MEDIA_IN_USE ((NTSTATUS)0xC0232001L) + +// +// MessageId: STATUS_NDIS_DOT11_POWER_STATE_INVALID +// +// MessageText: +// +// The wireless local area network interface is powered down and doesn't support the requested operation. +// +#define STATUS_NDIS_DOT11_POWER_STATE_INVALID ((NTSTATUS)0xC0232002L) + +// +// MessageId: STATUS_NDIS_PM_WOL_PATTERN_LIST_FULL +// +// MessageText: +// +// The list of wake on LAN patterns is full. +// +#define STATUS_NDIS_PM_WOL_PATTERN_LIST_FULL ((NTSTATUS)0xC0232003L) + +// +// MessageId: STATUS_NDIS_PM_PROTOCOL_OFFLOAD_LIST_FULL +// +// MessageText: +// +// The list of low power protocol offloads is full. +// +#define STATUS_NDIS_PM_PROTOCOL_OFFLOAD_LIST_FULL ((NTSTATUS)0xC0232004L) + +// +// MessageId: STATUS_NDIS_DOT11_AP_CHANNEL_CURRENTLY_NOT_AVAILABLE +// +// MessageText: +// +// The wireless local area network interface cannot start an AP on the specified channel right now. +// +#define STATUS_NDIS_DOT11_AP_CHANNEL_CURRENTLY_NOT_AVAILABLE ((NTSTATUS)0xC0232005L) + +// +// MessageId: STATUS_NDIS_DOT11_AP_BAND_CURRENTLY_NOT_AVAILABLE +// +// MessageText: +// +// The wireless local area network interface cannot start an AP on the specified band right now. +// +#define STATUS_NDIS_DOT11_AP_BAND_CURRENTLY_NOT_AVAILABLE ((NTSTATUS)0xC0232006L) + +// +// MessageId: STATUS_NDIS_DOT11_AP_CHANNEL_NOT_ALLOWED +// +// MessageText: +// +// The wireless local area network interface cannot start an AP on this channel due to regulatory reasons. +// +#define STATUS_NDIS_DOT11_AP_CHANNEL_NOT_ALLOWED ((NTSTATUS)0xC0232007L) + +// +// MessageId: STATUS_NDIS_DOT11_AP_BAND_NOT_ALLOWED +// +// MessageText: +// +// The wireless local area network interface cannot start an AP on this band due to regulatory reasons. +// +#define STATUS_NDIS_DOT11_AP_BAND_NOT_ALLOWED ((NTSTATUS)0xC0232008L) + +// +// MessageId: STATUS_NDIS_DOT11_AP_RADIO_RESTRICTION +// +// MessageText: +// +// The wireless local area network interface cannot start an AP because the minimum radio hardware required for this operation is not present. +// +#define STATUS_NDIS_DOT11_AP_RADIO_RESTRICTION ((NTSTATUS)0xC0232009L) + +// +// NDIS informational codes(ndis.sys) +// + +// +// MessageId: STATUS_NDIS_INDICATION_REQUIRED +// +// MessageText: +// +// The request will be completed later by NDIS status indication. +// +#define STATUS_NDIS_INDICATION_REQUIRED ((NTSTATUS)0x40230001L) + +// +// NDIS Chimney Offload codes (ndis.sys) +// + +// +// MessageId: STATUS_NDIS_OFFLOAD_POLICY +// +// MessageText: +// +// The TCP connection is not offloadable because of a local policy setting. +// +#define STATUS_NDIS_OFFLOAD_POLICY ((NTSTATUS)0xC023100FL) + +// +// MessageId: STATUS_NDIS_OFFLOAD_CONNECTION_REJECTED +// +// MessageText: +// +// The TCP connection is not offloadable by the Chimney offload target. +// +#define STATUS_NDIS_OFFLOAD_CONNECTION_REJECTED ((NTSTATUS)0xC0231012L) + +// +// MessageId: STATUS_NDIS_OFFLOAD_PATH_REJECTED +// +// MessageText: +// +// The IP Path object is not in an offloadable state. +// +#define STATUS_NDIS_OFFLOAD_PATH_REJECTED ((NTSTATUS)0xC0231013L) + +// +// TPM hardware errors {0x0000..0x003ff} +// +// +// MessageId: STATUS_TPM_ERROR_MASK +// +// MessageText: +// +// This is an error mask to convert TPM hardware errors to win errors. +// +#define STATUS_TPM_ERROR_MASK ((NTSTATUS)0xC0290000L) + +// +// MessageId: STATUS_TPM_AUTHFAIL +// +// MessageText: +// +// TPM 1.2: Authentication failed. +// +#define STATUS_TPM_AUTHFAIL ((NTSTATUS)0xC0290001L) + +// +// MessageId: STATUS_TPM_BADINDEX +// +// MessageText: +// +// TPM 1.2: The index to a PCR, DIR or other register is incorrect. +// +#define STATUS_TPM_BADINDEX ((NTSTATUS)0xC0290002L) + +// +// MessageId: STATUS_TPM_BAD_PARAMETER +// +// MessageText: +// +// TPM 1.2: One or more parameter is bad. +// +#define STATUS_TPM_BAD_PARAMETER ((NTSTATUS)0xC0290003L) + +// +// MessageId: STATUS_TPM_AUDITFAILURE +// +// MessageText: +// +// TPM 1.2: An operation completed successfully but the auditing of that operation failed. +// +#define STATUS_TPM_AUDITFAILURE ((NTSTATUS)0xC0290004L) + +// +// MessageId: STATUS_TPM_CLEAR_DISABLED +// +// MessageText: +// +// TPM 1.2: The clear disable flag is set and all clear operations now require physical access. +// +#define STATUS_TPM_CLEAR_DISABLED ((NTSTATUS)0xC0290005L) + +// +// MessageId: STATUS_TPM_DEACTIVATED +// +// MessageText: +// +// TPM 1.2: Activate the Trusted Platform Module (TPM). +// +#define STATUS_TPM_DEACTIVATED ((NTSTATUS)0xC0290006L) + +// +// MessageId: STATUS_TPM_DISABLED +// +// MessageText: +// +// TPM 1.2: Enable the Trusted Platform Module (TPM). +// +#define STATUS_TPM_DISABLED ((NTSTATUS)0xC0290007L) + +// +// MessageId: STATUS_TPM_DISABLED_CMD +// +// MessageText: +// +// TPM 1.2: The target command has been disabled. +// +#define STATUS_TPM_DISABLED_CMD ((NTSTATUS)0xC0290008L) + +// +// MessageId: STATUS_TPM_FAIL +// +// MessageText: +// +// TPM 1.2: The operation failed. +// +#define STATUS_TPM_FAIL ((NTSTATUS)0xC0290009L) + +// +// MessageId: STATUS_TPM_BAD_ORDINAL +// +// MessageText: +// +// TPM 1.2: The ordinal was unknown or inconsistent. +// +#define STATUS_TPM_BAD_ORDINAL ((NTSTATUS)0xC029000AL) + +// +// MessageId: STATUS_TPM_INSTALL_DISABLED +// +// MessageText: +// +// TPM 1.2: The ability to install an owner is disabled. +// +#define STATUS_TPM_INSTALL_DISABLED ((NTSTATUS)0xC029000BL) + +// +// MessageId: STATUS_TPM_INVALID_KEYHANDLE +// +// MessageText: +// +// TPM 1.2: The key handle cannot be interpreted. +// +#define STATUS_TPM_INVALID_KEYHANDLE ((NTSTATUS)0xC029000CL) + +// +// MessageId: STATUS_TPM_KEYNOTFOUND +// +// MessageText: +// +// TPM 1.2: The key handle points to an invalid key. +// +#define STATUS_TPM_KEYNOTFOUND ((NTSTATUS)0xC029000DL) + +// +// MessageId: STATUS_TPM_INAPPROPRIATE_ENC +// +// MessageText: +// +// TPM 1.2: Unacceptable encryption scheme. +// +#define STATUS_TPM_INAPPROPRIATE_ENC ((NTSTATUS)0xC029000EL) + +// +// MessageId: STATUS_TPM_MIGRATEFAIL +// +// MessageText: +// +// TPM 1.2: Migration authorization failed. +// +#define STATUS_TPM_MIGRATEFAIL ((NTSTATUS)0xC029000FL) + +// +// MessageId: STATUS_TPM_INVALID_PCR_INFO +// +// MessageText: +// +// TPM 1.2: PCR information could not be interpreted. +// +#define STATUS_TPM_INVALID_PCR_INFO ((NTSTATUS)0xC0290010L) + +// +// MessageId: STATUS_TPM_NOSPACE +// +// MessageText: +// +// TPM 1.2: No room to load key. +// +#define STATUS_TPM_NOSPACE ((NTSTATUS)0xC0290011L) + +// +// MessageId: STATUS_TPM_NOSRK +// +// MessageText: +// +// TPM 1.2: There is no Storage Root Key (SRK) set. +// +#define STATUS_TPM_NOSRK ((NTSTATUS)0xC0290012L) + +// +// MessageId: STATUS_TPM_NOTSEALED_BLOB +// +// MessageText: +// +// TPM 1.2: An encrypted blob is invalid or was not created by this TPM. +// +#define STATUS_TPM_NOTSEALED_BLOB ((NTSTATUS)0xC0290013L) + +// +// MessageId: STATUS_TPM_OWNER_SET +// +// MessageText: +// +// TPM 1.2: The Trusted Platform Module (TPM) already has an owner. +// +#define STATUS_TPM_OWNER_SET ((NTSTATUS)0xC0290014L) + +// +// MessageId: STATUS_TPM_RESOURCES +// +// MessageText: +// +// TPM 1.2: The TPM has insufficient internal resources to perform the requested action. +// +#define STATUS_TPM_RESOURCES ((NTSTATUS)0xC0290015L) + +// +// MessageId: STATUS_TPM_SHORTRANDOM +// +// MessageText: +// +// TPM 1.2: A random string was too short. +// +#define STATUS_TPM_SHORTRANDOM ((NTSTATUS)0xC0290016L) + +// +// MessageId: STATUS_TPM_SIZE +// +// MessageText: +// +// TPM 1.2: The TPM does not have the space to perform the operation. +// +#define STATUS_TPM_SIZE ((NTSTATUS)0xC0290017L) + +// +// MessageId: STATUS_TPM_WRONGPCRVAL +// +// MessageText: +// +// TPM 1.2: The named PCR value does not match the current PCR value. +// +#define STATUS_TPM_WRONGPCRVAL ((NTSTATUS)0xC0290018L) + +// +// MessageId: STATUS_TPM_BAD_PARAM_SIZE +// +// MessageText: +// +// TPM 1.2: The paramSize argument to the command has the incorrect value . +// +#define STATUS_TPM_BAD_PARAM_SIZE ((NTSTATUS)0xC0290019L) + +// +// MessageId: STATUS_TPM_SHA_THREAD +// +// MessageText: +// +// TPM 1.2: There is no existing SHA-1 thread. +// +#define STATUS_TPM_SHA_THREAD ((NTSTATUS)0xC029001AL) + +// +// MessageId: STATUS_TPM_SHA_ERROR +// +// MessageText: +// +// TPM 1.2: The calculation is unable to proceed because the existing SHA-1 thread has already encountered an error. +// +#define STATUS_TPM_SHA_ERROR ((NTSTATUS)0xC029001BL) + +// +// MessageId: STATUS_TPM_FAILEDSELFTEST +// +// MessageText: +// +// TPM 1.2: The TPM hardware device reported a failure during its internal self test. Try restarting the computer to resolve the problem. If the problem continues, you might need to replace your TPM hardware or motherboard. +// +#define STATUS_TPM_FAILEDSELFTEST ((NTSTATUS)0xC029001CL) + +// +// MessageId: STATUS_TPM_AUTH2FAIL +// +// MessageText: +// +// TPM 1.2: The authorization for the second key in a 2 key function failed authorization. +// +#define STATUS_TPM_AUTH2FAIL ((NTSTATUS)0xC029001DL) + +// +// MessageId: STATUS_TPM_BADTAG +// +// MessageText: +// +// TPM 1.2: The tag value sent to for a command is invalid. +// +#define STATUS_TPM_BADTAG ((NTSTATUS)0xC029001EL) + +// +// MessageId: STATUS_TPM_IOERROR +// +// MessageText: +// +// TPM 1.2: An IO error occurred transmitting information to the TPM. +// +#define STATUS_TPM_IOERROR ((NTSTATUS)0xC029001FL) + +// +// MessageId: STATUS_TPM_ENCRYPT_ERROR +// +// MessageText: +// +// TPM 1.2: The encryption process had a problem. +// +#define STATUS_TPM_ENCRYPT_ERROR ((NTSTATUS)0xC0290020L) + +// +// MessageId: STATUS_TPM_DECRYPT_ERROR +// +// MessageText: +// +// TPM 1.2: The decryption process did not complete. +// +#define STATUS_TPM_DECRYPT_ERROR ((NTSTATUS)0xC0290021L) + +// +// MessageId: STATUS_TPM_INVALID_AUTHHANDLE +// +// MessageText: +// +// TPM 1.2: An invalid handle was used. +// +#define STATUS_TPM_INVALID_AUTHHANDLE ((NTSTATUS)0xC0290022L) + +// +// MessageId: STATUS_TPM_NO_ENDORSEMENT +// +// MessageText: +// +// TPM 1.2: The TPM does not have an Endorsement Key (EK) installed. +// +#define STATUS_TPM_NO_ENDORSEMENT ((NTSTATUS)0xC0290023L) + +// +// MessageId: STATUS_TPM_INVALID_KEYUSAGE +// +// MessageText: +// +// TPM 1.2: The usage of a key is not allowed. +// +#define STATUS_TPM_INVALID_KEYUSAGE ((NTSTATUS)0xC0290024L) + +// +// MessageId: STATUS_TPM_WRONG_ENTITYTYPE +// +// MessageText: +// +// TPM 1.2: The submitted entity type is not allowed. +// +#define STATUS_TPM_WRONG_ENTITYTYPE ((NTSTATUS)0xC0290025L) + +// +// MessageId: STATUS_TPM_INVALID_POSTINIT +// +// MessageText: +// +// TPM 1.2: The command was received in the wrong sequence relative to TPM_Init and a subsequent TPM_Startup. +// +#define STATUS_TPM_INVALID_POSTINIT ((NTSTATUS)0xC0290026L) + +// +// MessageId: STATUS_TPM_INAPPROPRIATE_SIG +// +// MessageText: +// +// TPM 1.2: Signed data cannot include additional DER information. +// +#define STATUS_TPM_INAPPROPRIATE_SIG ((NTSTATUS)0xC0290027L) + +// +// MessageId: STATUS_TPM_BAD_KEY_PROPERTY +// +// MessageText: +// +// TPM 1.2: The key properties in TPM_KEY_PARMs are not supported by this TPM. +// +#define STATUS_TPM_BAD_KEY_PROPERTY ((NTSTATUS)0xC0290028L) + +// +// MessageId: STATUS_TPM_BAD_MIGRATION +// +// MessageText: +// +// TPM 1.2: The migration properties of this key are incorrect. +// +#define STATUS_TPM_BAD_MIGRATION ((NTSTATUS)0xC0290029L) + +// +// MessageId: STATUS_TPM_BAD_SCHEME +// +// MessageText: +// +// TPM 1.2: The signature or encryption scheme for this key is incorrect or not permitted in this situation. +// +#define STATUS_TPM_BAD_SCHEME ((NTSTATUS)0xC029002AL) + +// +// MessageId: STATUS_TPM_BAD_DATASIZE +// +// MessageText: +// +// TPM 1.2: The size of the data (or blob) parameter is bad or inconsistent with the referenced key. +// +#define STATUS_TPM_BAD_DATASIZE ((NTSTATUS)0xC029002BL) + +// +// MessageId: STATUS_TPM_BAD_MODE +// +// MessageText: +// +// TPM 1.2: A mode parameter is bad, such as capArea or subCapArea for TPM_GetCapability, phsicalPresence parameter for TPM_PhysicalPresence, or migrationType for TPM_CreateMigrationBlob. +// +#define STATUS_TPM_BAD_MODE ((NTSTATUS)0xC029002CL) + +// +// MessageId: STATUS_TPM_BAD_PRESENCE +// +// MessageText: +// +// TPM 1.2: Either the physicalPresence or physicalPresenceLock bits have the wrong value. +// +#define STATUS_TPM_BAD_PRESENCE ((NTSTATUS)0xC029002DL) + +// +// MessageId: STATUS_TPM_BAD_VERSION +// +// MessageText: +// +// TPM 1.2: The TPM cannot perform this version of the capability. +// +#define STATUS_TPM_BAD_VERSION ((NTSTATUS)0xC029002EL) + +// +// MessageId: STATUS_TPM_NO_WRAP_TRANSPORT +// +// MessageText: +// +// TPM 1.2: The TPM does not allow for wrapped transport sessions. +// +#define STATUS_TPM_NO_WRAP_TRANSPORT ((NTSTATUS)0xC029002FL) + +// +// MessageId: STATUS_TPM_AUDITFAIL_UNSUCCESSFUL +// +// MessageText: +// +// TPM 1.2: TPM audit construction failed and the underlying command was returning a failure code also. +// +#define STATUS_TPM_AUDITFAIL_UNSUCCESSFUL ((NTSTATUS)0xC0290030L) + +// +// MessageId: STATUS_TPM_AUDITFAIL_SUCCESSFUL +// +// MessageText: +// +// TPM 1.2: TPM audit construction failed and the underlying command was returning success. +// +#define STATUS_TPM_AUDITFAIL_SUCCESSFUL ((NTSTATUS)0xC0290031L) + +// +// MessageId: STATUS_TPM_NOTRESETABLE +// +// MessageText: +// +// TPM 1.2: Attempt to reset a PCR register that does not have the resettable attribute. +// +#define STATUS_TPM_NOTRESETABLE ((NTSTATUS)0xC0290032L) + +// +// MessageId: STATUS_TPM_NOTLOCAL +// +// MessageText: +// +// TPM 1.2: Attempt to reset a PCR register that requires locality and locality modifier not part of command transport. +// +#define STATUS_TPM_NOTLOCAL ((NTSTATUS)0xC0290033L) + +// +// MessageId: STATUS_TPM_BAD_TYPE +// +// MessageText: +// +// TPM 1.2: Make identity blob not properly typed. +// +#define STATUS_TPM_BAD_TYPE ((NTSTATUS)0xC0290034L) + +// +// MessageId: STATUS_TPM_INVALID_RESOURCE +// +// MessageText: +// +// TPM 1.2: When saving context identified resource type does not match actual resource. +// +#define STATUS_TPM_INVALID_RESOURCE ((NTSTATUS)0xC0290035L) + +// +// MessageId: STATUS_TPM_NOTFIPS +// +// MessageText: +// +// TPM 1.2: The TPM is attempting to execute a command that is not allowed when in FIPS mode. +// +#define STATUS_TPM_NOTFIPS ((NTSTATUS)0xC0290036L) + +// +// MessageId: STATUS_TPM_INVALID_FAMILY +// +// MessageText: +// +// TPM 1.2: The command is attempting to use an invalid family ID. +// +#define STATUS_TPM_INVALID_FAMILY ((NTSTATUS)0xC0290037L) + +// +// MessageId: STATUS_TPM_NO_NV_PERMISSION +// +// MessageText: +// +// TPM 1.2: The permission to manipulate the NV storage is not available. +// +#define STATUS_TPM_NO_NV_PERMISSION ((NTSTATUS)0xC0290038L) + +// +// MessageId: STATUS_TPM_REQUIRES_SIGN +// +// MessageText: +// +// TPM 1.2: The operation requires a signed command. +// +#define STATUS_TPM_REQUIRES_SIGN ((NTSTATUS)0xC0290039L) + +// +// MessageId: STATUS_TPM_KEY_NOTSUPPORTED +// +// MessageText: +// +// TPM 1.2: Wrong operation to load an NV key. +// +#define STATUS_TPM_KEY_NOTSUPPORTED ((NTSTATUS)0xC029003AL) + +// +// MessageId: STATUS_TPM_AUTH_CONFLICT +// +// MessageText: +// +// TPM 1.2: NV_LoadKey blob requires both owner and blob authorization. +// +#define STATUS_TPM_AUTH_CONFLICT ((NTSTATUS)0xC029003BL) + +// +// MessageId: STATUS_TPM_AREA_LOCKED +// +// MessageText: +// +// TPM 1.2: The NV area is locked and not writable. +// +#define STATUS_TPM_AREA_LOCKED ((NTSTATUS)0xC029003CL) + +// +// MessageId: STATUS_TPM_BAD_LOCALITY +// +// MessageText: +// +// TPM 1.2: The locality is incorrect for the attempted operation. +// +#define STATUS_TPM_BAD_LOCALITY ((NTSTATUS)0xC029003DL) + +// +// MessageId: STATUS_TPM_READ_ONLY +// +// MessageText: +// +// TPM 1.2: The NV area is read only and can't be written to. +// +#define STATUS_TPM_READ_ONLY ((NTSTATUS)0xC029003EL) + +// +// MessageId: STATUS_TPM_PER_NOWRITE +// +// MessageText: +// +// TPM 1.2: There is no protection on the write to the NV area. +// +#define STATUS_TPM_PER_NOWRITE ((NTSTATUS)0xC029003FL) + +// +// MessageId: STATUS_TPM_FAMILYCOUNT +// +// MessageText: +// +// TPM 1.2: The family count value does not match. +// +#define STATUS_TPM_FAMILYCOUNT ((NTSTATUS)0xC0290040L) + +// +// MessageId: STATUS_TPM_WRITE_LOCKED +// +// MessageText: +// +// TPM 1.2: The NV area has already been written to. +// +#define STATUS_TPM_WRITE_LOCKED ((NTSTATUS)0xC0290041L) + +// +// MessageId: STATUS_TPM_BAD_ATTRIBUTES +// +// MessageText: +// +// TPM 1.2: The NV area attributes conflict. +// +#define STATUS_TPM_BAD_ATTRIBUTES ((NTSTATUS)0xC0290042L) + +// +// MessageId: STATUS_TPM_INVALID_STRUCTURE +// +// MessageText: +// +// TPM 1.2: The structure tag and version are invalid or inconsistent. +// +#define STATUS_TPM_INVALID_STRUCTURE ((NTSTATUS)0xC0290043L) + +// +// MessageId: STATUS_TPM_KEY_OWNER_CONTROL +// +// MessageText: +// +// TPM 1.2: The key is under control of the TPM Owner and can only be evicted by the TPM Owner. +// +#define STATUS_TPM_KEY_OWNER_CONTROL ((NTSTATUS)0xC0290044L) + +// +// MessageId: STATUS_TPM_BAD_COUNTER +// +// MessageText: +// +// TPM 1.2: The counter handle is incorrect. +// +#define STATUS_TPM_BAD_COUNTER ((NTSTATUS)0xC0290045L) + +// +// MessageId: STATUS_TPM_NOT_FULLWRITE +// +// MessageText: +// +// TPM 1.2: The write is not a complete write of the area. +// +#define STATUS_TPM_NOT_FULLWRITE ((NTSTATUS)0xC0290046L) + +// +// MessageId: STATUS_TPM_CONTEXT_GAP +// +// MessageText: +// +// TPM 1.2: The gap between saved context counts is too large. +// +#define STATUS_TPM_CONTEXT_GAP ((NTSTATUS)0xC0290047L) + +// +// MessageId: STATUS_TPM_MAXNVWRITES +// +// MessageText: +// +// TPM 1.2: The maximum number of NV writes without an owner has been exceeded. +// +#define STATUS_TPM_MAXNVWRITES ((NTSTATUS)0xC0290048L) + +// +// MessageId: STATUS_TPM_NOOPERATOR +// +// MessageText: +// +// TPM 1.2: No operator AuthData value is set. +// +#define STATUS_TPM_NOOPERATOR ((NTSTATUS)0xC0290049L) + +// +// MessageId: STATUS_TPM_RESOURCEMISSING +// +// MessageText: +// +// TPM 1.2: The resource pointed to by context is not loaded. +// +#define STATUS_TPM_RESOURCEMISSING ((NTSTATUS)0xC029004AL) + +// +// MessageId: STATUS_TPM_DELEGATE_LOCK +// +// MessageText: +// +// TPM 1.2: The delegate administration is locked. +// +#define STATUS_TPM_DELEGATE_LOCK ((NTSTATUS)0xC029004BL) + +// +// MessageId: STATUS_TPM_DELEGATE_FAMILY +// +// MessageText: +// +// TPM 1.2: Attempt to manage a family other then the delegated family. +// +#define STATUS_TPM_DELEGATE_FAMILY ((NTSTATUS)0xC029004CL) + +// +// MessageId: STATUS_TPM_DELEGATE_ADMIN +// +// MessageText: +// +// TPM 1.2: Delegation table management not enabled. +// +#define STATUS_TPM_DELEGATE_ADMIN ((NTSTATUS)0xC029004DL) + +// +// MessageId: STATUS_TPM_TRANSPORT_NOTEXCLUSIVE +// +// MessageText: +// +// TPM 1.2: There was a command executed outside of an exclusive transport session. +// +#define STATUS_TPM_TRANSPORT_NOTEXCLUSIVE ((NTSTATUS)0xC029004EL) + +// +// MessageId: STATUS_TPM_OWNER_CONTROL +// +// MessageText: +// +// TPM 1.2: Attempt to context save a owner evict controlled key. +// +#define STATUS_TPM_OWNER_CONTROL ((NTSTATUS)0xC029004FL) + +// +// MessageId: STATUS_TPM_DAA_RESOURCES +// +// MessageText: +// +// TPM 1.2: The DAA command has no resources available to execute the command. +// +#define STATUS_TPM_DAA_RESOURCES ((NTSTATUS)0xC0290050L) + +// +// MessageId: STATUS_TPM_DAA_INPUT_DATA0 +// +// MessageText: +// +// TPM 1.2: The consistency check on DAA parameter inputData0 has failed. +// +#define STATUS_TPM_DAA_INPUT_DATA0 ((NTSTATUS)0xC0290051L) + +// +// MessageId: STATUS_TPM_DAA_INPUT_DATA1 +// +// MessageText: +// +// TPM 1.2: The consistency check on DAA parameter inputData1 has failed. +// +#define STATUS_TPM_DAA_INPUT_DATA1 ((NTSTATUS)0xC0290052L) + +// +// MessageId: STATUS_TPM_DAA_ISSUER_SETTINGS +// +// MessageText: +// +// TPM 1.2: The consistency check on DAA_issuerSettings has failed. +// +#define STATUS_TPM_DAA_ISSUER_SETTINGS ((NTSTATUS)0xC0290053L) + +// +// MessageId: STATUS_TPM_DAA_TPM_SETTINGS +// +// MessageText: +// +// TPM 1.2: The consistency check on DAA_tpmSpecific has failed. +// +#define STATUS_TPM_DAA_TPM_SETTINGS ((NTSTATUS)0xC0290054L) + +// +// MessageId: STATUS_TPM_DAA_STAGE +// +// MessageText: +// +// TPM 1.2: The atomic process indicated by the submitted DAA command is not the expected process. +// +#define STATUS_TPM_DAA_STAGE ((NTSTATUS)0xC0290055L) + +// +// MessageId: STATUS_TPM_DAA_ISSUER_VALIDITY +// +// MessageText: +// +// TPM 1.2: The issuer's validity check has detected an inconsistency. +// +#define STATUS_TPM_DAA_ISSUER_VALIDITY ((NTSTATUS)0xC0290056L) + +// +// MessageId: STATUS_TPM_DAA_WRONG_W +// +// MessageText: +// +// TPM 1.2: The consistency check on w has failed. +// +#define STATUS_TPM_DAA_WRONG_W ((NTSTATUS)0xC0290057L) + +// +// MessageId: STATUS_TPM_BAD_HANDLE +// +// MessageText: +// +// TPM 1.2: The handle is incorrect. +// +#define STATUS_TPM_BAD_HANDLE ((NTSTATUS)0xC0290058L) + +// +// MessageId: STATUS_TPM_BAD_DELEGATE +// +// MessageText: +// +// TPM 1.2: Delegation is not correct. +// +#define STATUS_TPM_BAD_DELEGATE ((NTSTATUS)0xC0290059L) + +// +// MessageId: STATUS_TPM_BADCONTEXT +// +// MessageText: +// +// TPM 1.2: The context blob is invalid. +// +#define STATUS_TPM_BADCONTEXT ((NTSTATUS)0xC029005AL) + +// +// MessageId: STATUS_TPM_TOOMANYCONTEXTS +// +// MessageText: +// +// TPM 1.2: Too many contexts held by the TPM. +// +#define STATUS_TPM_TOOMANYCONTEXTS ((NTSTATUS)0xC029005BL) + +// +// MessageId: STATUS_TPM_MA_TICKET_SIGNATURE +// +// MessageText: +// +// TPM 1.2: Migration authority signature validation failure. +// +#define STATUS_TPM_MA_TICKET_SIGNATURE ((NTSTATUS)0xC029005CL) + +// +// MessageId: STATUS_TPM_MA_DESTINATION +// +// MessageText: +// +// TPM 1.2: Migration destination not authenticated. +// +#define STATUS_TPM_MA_DESTINATION ((NTSTATUS)0xC029005DL) + +// +// MessageId: STATUS_TPM_MA_SOURCE +// +// MessageText: +// +// TPM 1.2: Migration source incorrect. +// +#define STATUS_TPM_MA_SOURCE ((NTSTATUS)0xC029005EL) + +// +// MessageId: STATUS_TPM_MA_AUTHORITY +// +// MessageText: +// +// TPM 1.2: Incorrect migration authority. +// +#define STATUS_TPM_MA_AUTHORITY ((NTSTATUS)0xC029005FL) + +// +// MessageId: STATUS_TPM_PERMANENTEK +// +// MessageText: +// +// TPM 1.2: Attempt to revoke the EK and the EK is not revocable. +// +#define STATUS_TPM_PERMANENTEK ((NTSTATUS)0xC0290061L) + +// +// MessageId: STATUS_TPM_BAD_SIGNATURE +// +// MessageText: +// +// TPM 1.2: Bad signature of CMK ticket. +// +#define STATUS_TPM_BAD_SIGNATURE ((NTSTATUS)0xC0290062L) + +// +// MessageId: STATUS_TPM_NOCONTEXTSPACE +// +// MessageText: +// +// TPM 1.2: There is no room in the context list for additional contexts. +// +#define STATUS_TPM_NOCONTEXTSPACE ((NTSTATUS)0xC0290063L) + +// +// MessageId: STATUS_TPM_20_E_ASYMMETRIC +// +// MessageText: +// +// TPM 2.0: Asymmetric algorithm not supported or not correct. +// +#define STATUS_TPM_20_E_ASYMMETRIC ((NTSTATUS)0xC0290081L) + +// +// MessageId: STATUS_TPM_20_E_ATTRIBUTES +// +// MessageText: +// +// TPM 2.0: Inconsistent attributes. +// +#define STATUS_TPM_20_E_ATTRIBUTES ((NTSTATUS)0xC0290082L) + +// +// MessageId: STATUS_TPM_20_E_HASH +// +// MessageText: +// +// TPM 2.0: Hash algorithm not supported or not appropriate. +// +#define STATUS_TPM_20_E_HASH ((NTSTATUS)0xC0290083L) + +// +// MessageId: STATUS_TPM_20_E_VALUE +// +// MessageText: +// +// TPM 2.0: Value is out of range or is not correct for the context. +// +#define STATUS_TPM_20_E_VALUE ((NTSTATUS)0xC0290084L) + +// +// MessageId: STATUS_TPM_20_E_HIERARCHY +// +// MessageText: +// +// TPM 2.0: Hierarchy is not enabled or is not correct for the use. +// +#define STATUS_TPM_20_E_HIERARCHY ((NTSTATUS)0xC0290085L) + +// +// MessageId: STATUS_TPM_20_E_KEY_SIZE +// +// MessageText: +// +// TPM 2.0: Key size is not supported. +// +#define STATUS_TPM_20_E_KEY_SIZE ((NTSTATUS)0xC0290087L) + +// +// MessageId: STATUS_TPM_20_E_MGF +// +// MessageText: +// +// TPM 2.0: Mask generation function not supported. +// +#define STATUS_TPM_20_E_MGF ((NTSTATUS)0xC0290088L) + +// +// MessageId: STATUS_TPM_20_E_MODE +// +// MessageText: +// +// TPM 2.0: Mode of operation not supported. +// +#define STATUS_TPM_20_E_MODE ((NTSTATUS)0xC0290089L) + +// +// MessageId: STATUS_TPM_20_E_TYPE +// +// MessageText: +// +// TPM 2.0: The type of the value is not appropriate for the use. +// +#define STATUS_TPM_20_E_TYPE ((NTSTATUS)0xC029008AL) + +// +// MessageId: STATUS_TPM_20_E_HANDLE +// +// MessageText: +// +// TPM 2.0: The Handle is not correct for the use. +// +#define STATUS_TPM_20_E_HANDLE ((NTSTATUS)0xC029008BL) + +// +// MessageId: STATUS_TPM_20_E_KDF +// +// MessageText: +// +// TPM 2.0: Unsupported key derivation function or function not appropriate for use. +// +#define STATUS_TPM_20_E_KDF ((NTSTATUS)0xC029008CL) + +// +// MessageId: STATUS_TPM_20_E_RANGE +// +// MessageText: +// +// TPM 2.0: Value was out of allowed range. +// +#define STATUS_TPM_20_E_RANGE ((NTSTATUS)0xC029008DL) + +// +// MessageId: STATUS_TPM_20_E_AUTH_FAIL +// +// MessageText: +// +// TPM 2.0: The authorization HMAC check failed and DA counter incremented. +// +#define STATUS_TPM_20_E_AUTH_FAIL ((NTSTATUS)0xC029008EL) + +// +// MessageId: STATUS_TPM_20_E_NONCE +// +// MessageText: +// +// TPM 2.0: Invalid nonce size. +// +#define STATUS_TPM_20_E_NONCE ((NTSTATUS)0xC029008FL) + +// +// MessageId: STATUS_TPM_20_E_PP +// +// MessageText: +// +// TPM 2.0: Authorization requires assertion of PP. +// +#define STATUS_TPM_20_E_PP ((NTSTATUS)0xC0290090L) + +// +// MessageId: STATUS_TPM_20_E_SCHEME +// +// MessageText: +// +// TPM 2.0: Unsupported or incompatible scheme. +// +#define STATUS_TPM_20_E_SCHEME ((NTSTATUS)0xC0290092L) + +// +// MessageId: STATUS_TPM_20_E_SIZE +// +// MessageText: +// +// TPM 2.0: Structure is wrong size. +// +#define STATUS_TPM_20_E_SIZE ((NTSTATUS)0xC0290095L) + +// +// MessageId: STATUS_TPM_20_E_SYMMETRIC +// +// MessageText: +// +// TPM 2.0: Unsupported symmetric algorithm or key size, or not appropriate for instance. +// +#define STATUS_TPM_20_E_SYMMETRIC ((NTSTATUS)0xC0290096L) + +// +// MessageId: STATUS_TPM_20_E_TAG +// +// MessageText: +// +// TPM 2.0: Incorrect structure tag. +// +#define STATUS_TPM_20_E_TAG ((NTSTATUS)0xC0290097L) + +// +// MessageId: STATUS_TPM_20_E_SELECTOR +// +// MessageText: +// +// TPM 2.0: Union selector is incorrect. +// +#define STATUS_TPM_20_E_SELECTOR ((NTSTATUS)0xC0290098L) + +// +// MessageId: STATUS_TPM_20_E_INSUFFICIENT +// +// MessageText: +// +// TPM 2.0: The TPM was unable to unmarshal a value because there were not enough octets in the input buffer. +// +#define STATUS_TPM_20_E_INSUFFICIENT ((NTSTATUS)0xC029009AL) + +// +// MessageId: STATUS_TPM_20_E_SIGNATURE +// +// MessageText: +// +// TPM 2.0: The signature is not valid. +// +#define STATUS_TPM_20_E_SIGNATURE ((NTSTATUS)0xC029009BL) + +// +// MessageId: STATUS_TPM_20_E_KEY +// +// MessageText: +// +// TPM 2.0: Key fields are not compatible with the selected use. +// +#define STATUS_TPM_20_E_KEY ((NTSTATUS)0xC029009CL) + +// +// MessageId: STATUS_TPM_20_E_POLICY_FAIL +// +// MessageText: +// +// TPM 2.0: A policy check failed. +// +#define STATUS_TPM_20_E_POLICY_FAIL ((NTSTATUS)0xC029009DL) + +// +// MessageId: STATUS_TPM_20_E_INTEGRITY +// +// MessageText: +// +// TPM 2.0: Integrity check failed. +// +#define STATUS_TPM_20_E_INTEGRITY ((NTSTATUS)0xC029009FL) + +// +// MessageId: STATUS_TPM_20_E_TICKET +// +// MessageText: +// +// TPM 2.0: Invalid ticket. +// +#define STATUS_TPM_20_E_TICKET ((NTSTATUS)0xC02900A0L) + +// +// MessageId: STATUS_TPM_20_E_RESERVED_BITS +// +// MessageText: +// +// TPM 2.0: Reserved bits not set to zero as required. +// +#define STATUS_TPM_20_E_RESERVED_BITS ((NTSTATUS)0xC02900A1L) + +// +// MessageId: STATUS_TPM_20_E_BAD_AUTH +// +// MessageText: +// +// TPM 2.0: Authorization failure without DA implications. +// +#define STATUS_TPM_20_E_BAD_AUTH ((NTSTATUS)0xC02900A2L) + +// +// MessageId: STATUS_TPM_20_E_EXPIRED +// +// MessageText: +// +// TPM 2.0: The policy has expired. +// +#define STATUS_TPM_20_E_EXPIRED ((NTSTATUS)0xC02900A3L) + +// +// MessageId: STATUS_TPM_20_E_POLICY_CC +// +// MessageText: +// +// TPM 2.0: The command code in the policy is not the command code of the command or the command code in a policy command references a command that is not implemented. +// +#define STATUS_TPM_20_E_POLICY_CC ((NTSTATUS)0xC02900A4L) + +// +// MessageId: STATUS_TPM_20_E_BINDING +// +// MessageText: +// +// TPM 2.0: Public and sensitive portions of an object are not cryptographically bound. +// +#define STATUS_TPM_20_E_BINDING ((NTSTATUS)0xC02900A5L) + +// +// MessageId: STATUS_TPM_20_E_CURVE +// +// MessageText: +// +// TPM 2.0: Curve not supported. +// +#define STATUS_TPM_20_E_CURVE ((NTSTATUS)0xC02900A6L) + +// +// MessageId: STATUS_TPM_20_E_ECC_POINT +// +// MessageText: +// +// TPM 2.0: Point is not on the required curve. +// +#define STATUS_TPM_20_E_ECC_POINT ((NTSTATUS)0xC02900A7L) + +// +// MessageId: STATUS_TPM_20_E_INITIALIZE +// +// MessageText: +// +// TPM 2.0: TPM not initialized. +// +#define STATUS_TPM_20_E_INITIALIZE ((NTSTATUS)0xC0290100L) + +// +// MessageId: STATUS_TPM_20_E_FAILURE +// +// MessageText: +// +// TPM 2.0: Commands not being accepted because of a TPM failure. +// +#define STATUS_TPM_20_E_FAILURE ((NTSTATUS)0xC0290101L) + +// +// MessageId: STATUS_TPM_20_E_SEQUENCE +// +// MessageText: +// +// TPM 2.0: Improper use of a sequence handle. +// +#define STATUS_TPM_20_E_SEQUENCE ((NTSTATUS)0xC0290103L) + +// +// MessageId: STATUS_TPM_20_E_PRIVATE +// +// MessageText: +// +// TPM 2.0: TPM_RC_PRIVATE error. +// +#define STATUS_TPM_20_E_PRIVATE ((NTSTATUS)0xC029010BL) + +// +// MessageId: STATUS_TPM_20_E_HMAC +// +// MessageText: +// +// TPM 2.0: TPM_RC_HMAC. +// +#define STATUS_TPM_20_E_HMAC ((NTSTATUS)0xC0290119L) + +// +// MessageId: STATUS_TPM_20_E_DISABLED +// +// MessageText: +// +// TPM 2.0: TPM_RC_DISABLED. +// +#define STATUS_TPM_20_E_DISABLED ((NTSTATUS)0xC0290120L) + +// +// MessageId: STATUS_TPM_20_E_EXCLUSIVE +// +// MessageText: +// +// TPM 2.0: Command failed because audit sequence required exclusivity. +// +#define STATUS_TPM_20_E_EXCLUSIVE ((NTSTATUS)0xC0290121L) + +// +// MessageId: STATUS_TPM_20_E_ECC_CURVE +// +// MessageText: +// +// TPM 2.0: Unsupported ECC curve. +// +#define STATUS_TPM_20_E_ECC_CURVE ((NTSTATUS)0xC0290123L) + +// +// MessageId: STATUS_TPM_20_E_AUTH_TYPE +// +// MessageText: +// +// TPM 2.0: Authorization handle is not correct for command. +// +#define STATUS_TPM_20_E_AUTH_TYPE ((NTSTATUS)0xC0290124L) + +// +// MessageId: STATUS_TPM_20_E_AUTH_MISSING +// +// MessageText: +// +// TPM 2.0: Command requires an authorization session for handle and is not present. +// +#define STATUS_TPM_20_E_AUTH_MISSING ((NTSTATUS)0xC0290125L) + +// +// MessageId: STATUS_TPM_20_E_POLICY +// +// MessageText: +// +// TPM 2.0: Policy failure in Math Operation or an invalid authPolicy value. +// +#define STATUS_TPM_20_E_POLICY ((NTSTATUS)0xC0290126L) + +// +// MessageId: STATUS_TPM_20_E_PCR +// +// MessageText: +// +// TPM 2.0: PCR check fail. +// +#define STATUS_TPM_20_E_PCR ((NTSTATUS)0xC0290127L) + +// +// MessageId: STATUS_TPM_20_E_PCR_CHANGED +// +// MessageText: +// +// TPM 2.0: PCR have changed since checked. +// +#define STATUS_TPM_20_E_PCR_CHANGED ((NTSTATUS)0xC0290128L) + +// +// MessageId: STATUS_TPM_20_E_UPGRADE +// +// MessageText: +// +// TPM 2.0: The TPM is not in the right mode for upgrade. +// +#define STATUS_TPM_20_E_UPGRADE ((NTSTATUS)0xC029012DL) + +// +// MessageId: STATUS_TPM_20_E_TOO_MANY_CONTEXTS +// +// MessageText: +// +// TPM 2.0: Context ID counter is at maximum. +// +#define STATUS_TPM_20_E_TOO_MANY_CONTEXTS ((NTSTATUS)0xC029012EL) + +// +// MessageId: STATUS_TPM_20_E_AUTH_UNAVAILABLE +// +// MessageText: +// +// TPM 2.0: authValue or authPolicy is not available for selected entity. +// +#define STATUS_TPM_20_E_AUTH_UNAVAILABLE ((NTSTATUS)0xC029012FL) + +// +// MessageId: STATUS_TPM_20_E_REBOOT +// +// MessageText: +// +// TPM 2.0: A _TPM_Init and Startup(CLEAR) is required before the TPM can resume operation. +// +#define STATUS_TPM_20_E_REBOOT ((NTSTATUS)0xC0290130L) + +// +// MessageId: STATUS_TPM_20_E_UNBALANCED +// +// MessageText: +// +// TPM 2.0: The protection algorithms (hash and symmetric) are not reasonably balanced. The digest size of the hash must be larger than the key size of the symmetric algorithm. +// +#define STATUS_TPM_20_E_UNBALANCED ((NTSTATUS)0xC0290131L) + +// +// MessageId: STATUS_TPM_20_E_COMMAND_SIZE +// +// MessageText: +// +// TPM 2.0: The TPM command's commandSize value is inconsistent with contents of the command buffer; either the size is not the same as the bytes loaded by the hardware interface layer or the value is not large enough to hold a command header. +// +#define STATUS_TPM_20_E_COMMAND_SIZE ((NTSTATUS)0xC0290142L) + +// +// MessageId: STATUS_TPM_20_E_COMMAND_CODE +// +// MessageText: +// +// TPM 2.0: Command code not supported. +// +#define STATUS_TPM_20_E_COMMAND_CODE ((NTSTATUS)0xC0290143L) + +// +// MessageId: STATUS_TPM_20_E_AUTHSIZE +// +// MessageText: +// +// TPM 2.0: The value of authorizationSize is out of range or the number of octets in the authorization Area is greater than required. +// +#define STATUS_TPM_20_E_AUTHSIZE ((NTSTATUS)0xC0290144L) + +// +// MessageId: STATUS_TPM_20_E_AUTH_CONTEXT +// +// MessageText: +// +// TPM 2.0: Use of an authorization session with a context command or another command that cannot have an authorization session. +// +#define STATUS_TPM_20_E_AUTH_CONTEXT ((NTSTATUS)0xC0290145L) + +// +// MessageId: STATUS_TPM_20_E_NV_RANGE +// +// MessageText: +// +// TPM 2.0: NV offset+size is out of range. +// +#define STATUS_TPM_20_E_NV_RANGE ((NTSTATUS)0xC0290146L) + +// +// MessageId: STATUS_TPM_20_E_NV_SIZE +// +// MessageText: +// +// TPM 2.0: Requested allocation size is larger than allowed. +// +#define STATUS_TPM_20_E_NV_SIZE ((NTSTATUS)0xC0290147L) + +// +// MessageId: STATUS_TPM_20_E_NV_LOCKED +// +// MessageText: +// +// TPM 2.0: NV access locked. +// +#define STATUS_TPM_20_E_NV_LOCKED ((NTSTATUS)0xC0290148L) + +// +// MessageId: STATUS_TPM_20_E_NV_AUTHORIZATION +// +// MessageText: +// +// TPM 2.0: NV access authorization fails in command actions +// +#define STATUS_TPM_20_E_NV_AUTHORIZATION ((NTSTATUS)0xC0290149L) + +// +// MessageId: STATUS_TPM_20_E_NV_UNINITIALIZED +// +// MessageText: +// +// TPM 2.0: An NV index is used before being initialized or the state saved by TPM2_Shutdown(STATE) could not be restored. +// +#define STATUS_TPM_20_E_NV_UNINITIALIZED ((NTSTATUS)0xC029014AL) + +// +// MessageId: STATUS_TPM_20_E_NV_SPACE +// +// MessageText: +// +// TPM 2.0: Insufficient space for NV allocation. +// +#define STATUS_TPM_20_E_NV_SPACE ((NTSTATUS)0xC029014BL) + +// +// MessageId: STATUS_TPM_20_E_NV_DEFINED +// +// MessageText: +// +// TPM 2.0: NV index or persistent object already defined. +// +#define STATUS_TPM_20_E_NV_DEFINED ((NTSTATUS)0xC029014CL) + +// +// MessageId: STATUS_TPM_20_E_BAD_CONTEXT +// +// MessageText: +// +// TPM 2.0: Context in TPM2_ContextLoad() is not valid. +// +#define STATUS_TPM_20_E_BAD_CONTEXT ((NTSTATUS)0xC0290150L) + +// +// MessageId: STATUS_TPM_20_E_CPHASH +// +// MessageText: +// +// TPM 2.0: chHash value already set or not correct for use. +// +#define STATUS_TPM_20_E_CPHASH ((NTSTATUS)0xC0290151L) + +// +// MessageId: STATUS_TPM_20_E_PARENT +// +// MessageText: +// +// TPM 2.0: Handle for parent is not a valid parent. +// +#define STATUS_TPM_20_E_PARENT ((NTSTATUS)0xC0290152L) + +// +// MessageId: STATUS_TPM_20_E_NEEDS_TEST +// +// MessageText: +// +// TPM 2.0: Some function needs testing. +// +#define STATUS_TPM_20_E_NEEDS_TEST ((NTSTATUS)0xC0290153L) + +// +// MessageId: STATUS_TPM_20_E_NO_RESULT +// +// MessageText: +// +// TPM 2.0: returned when an internal function cannot process a request due to an unspecified problem. This code is usually related to invalid parameters that are not properly filtered by the input unmarshaling code. +// +#define STATUS_TPM_20_E_NO_RESULT ((NTSTATUS)0xC0290154L) + +// +// MessageId: STATUS_TPM_20_E_SENSITIVE +// +// MessageText: +// +// TPM 2.0: The sensitive area did not unmarshal correctly after decryption - this code is used in lieu of the other unmarshaling errors so that an attacker cannot determine where the unmarshaling error occurred. +// +#define STATUS_TPM_20_E_SENSITIVE ((NTSTATUS)0xC0290155L) + +// +// TPM vendor specific hardware errors {0x0400..0x04ff} +// +// +// MessageId: STATUS_TPM_COMMAND_BLOCKED +// +// MessageText: +// +// The command was blocked. +// +#define STATUS_TPM_COMMAND_BLOCKED ((NTSTATUS)0xC0290400L) + +// +// MessageId: STATUS_TPM_INVALID_HANDLE +// +// MessageText: +// +// The specified handle was not found. +// +#define STATUS_TPM_INVALID_HANDLE ((NTSTATUS)0xC0290401L) + +// +// MessageId: STATUS_TPM_DUPLICATE_VHANDLE +// +// MessageText: +// +// The TPM returned a duplicate handle and the command needs to be resubmitted. +// +#define STATUS_TPM_DUPLICATE_VHANDLE ((NTSTATUS)0xC0290402L) + +// +// MessageId: STATUS_TPM_EMBEDDED_COMMAND_BLOCKED +// +// MessageText: +// +// The command within the transport was blocked. +// +#define STATUS_TPM_EMBEDDED_COMMAND_BLOCKED ((NTSTATUS)0xC0290403L) + +// +// MessageId: STATUS_TPM_EMBEDDED_COMMAND_UNSUPPORTED +// +// MessageText: +// +// The command within the transport is not supported. +// +#define STATUS_TPM_EMBEDDED_COMMAND_UNSUPPORTED ((NTSTATUS)0xC0290404L) + +// +// TPM non-fatal hardware errors {0x0800..0x08ff} +// +// +// MessageId: STATUS_TPM_RETRY +// +// MessageText: +// +// The TPM is too busy to respond to the command immediately, but the command could be resubmitted at a later time. +// +#define STATUS_TPM_RETRY ((NTSTATUS)0xC0290800L) + +// +// MessageId: STATUS_TPM_NEEDS_SELFTEST +// +// MessageText: +// +// SelfTestFull has not been run. +// +#define STATUS_TPM_NEEDS_SELFTEST ((NTSTATUS)0xC0290801L) + +// +// MessageId: STATUS_TPM_DOING_SELFTEST +// +// MessageText: +// +// The TPM is currently executing a full selftest. +// +#define STATUS_TPM_DOING_SELFTEST ((NTSTATUS)0xC0290802L) + +// +// MessageId: STATUS_TPM_DEFEND_LOCK_RUNNING +// +// MessageText: +// +// The TPM is defending against dictionary attacks and is in a time-out period. +// +#define STATUS_TPM_DEFEND_LOCK_RUNNING ((NTSTATUS)0xC0290803L) + + +// +// TPM software Error codes (tpm.sys) +// + +// +// MessageId: STATUS_TPM_COMMAND_CANCELED +// +// MessageText: +// +// The command was cancelled. +// +#define STATUS_TPM_COMMAND_CANCELED ((NTSTATUS)0xC0291001L) + +// +// MessageId: STATUS_TPM_TOO_MANY_CONTEXTS +// +// MessageText: +// +// A new TPM context could not be created because there are too many open contexts. +// +#define STATUS_TPM_TOO_MANY_CONTEXTS ((NTSTATUS)0xC0291002L) + +// +// MessageId: STATUS_TPM_NOT_FOUND +// +// MessageText: +// +// TPM driver is not compatible with the version of TPM found on the system. +// +#define STATUS_TPM_NOT_FOUND ((NTSTATUS)0xC0291003L) + +// +// MessageId: STATUS_TPM_ACCESS_DENIED +// +// MessageText: +// +// The caller does not have the appropriate rights to perform the requested operation. +// +#define STATUS_TPM_ACCESS_DENIED ((NTSTATUS)0xC0291004L) + +// +// MessageId: STATUS_TPM_INSUFFICIENT_BUFFER +// +// MessageText: +// +// The caller does not have the appropriate rights to perform the requested operation. +// +#define STATUS_TPM_INSUFFICIENT_BUFFER ((NTSTATUS)0xC0291005L) + +// +// MessageId: STATUS_TPM_PPI_FUNCTION_UNSUPPORTED +// +// MessageText: +// +// The Physical Presence Interface of this firmware does not support the requested method. +// +#define STATUS_TPM_PPI_FUNCTION_UNSUPPORTED ((NTSTATUS)0xC0291006L) + +// +// MessageId: STATUS_TPM_IN_EXCLUSIVE_MODE +// +// MessageText: +// +// The caller is trying to request an operation while the TPM driver has an exclusive context open. +// +#define STATUS_TPM_IN_EXCLUSIVE_MODE ((NTSTATUS)0xC0291007L) + +// +// MessageId: STATUS_TPM_REBOOT_REQUIRED +// +// MessageText: +// +// The TPM driver was previously in exclusive mode and now requires a reboot to resume normal functionality. +// +#define STATUS_TPM_REBOOT_REQUIRED ((NTSTATUS)0xC0291008L) + + +// +// Platform Crypto Provider Error Codes (PCPKSP.dll and future platform crypto providers) +// + +// +// MessageId: STATUS_PCP_ERROR_MASK +// +// MessageText: +// +// This is an error mask to convert Platform Crypto Provider errors to win errors. +// +#define STATUS_PCP_ERROR_MASK ((NTSTATUS)0xC0292000L) + +// +// MessageId: STATUS_PCP_DEVICE_NOT_READY +// +// MessageText: +// +// The Platform Crypto Device is currently not ready. It needs to be fully provisioned to be operational. +// +#define STATUS_PCP_DEVICE_NOT_READY ((NTSTATUS)0xC0292001L) + +// +// MessageId: STATUS_PCP_INVALID_HANDLE +// +// MessageText: +// +// The handle provided to the Platform Crypto Provider is invalid. +// +#define STATUS_PCP_INVALID_HANDLE ((NTSTATUS)0xC0292002L) + +// +// MessageId: STATUS_PCP_INVALID_PARAMETER +// +// MessageText: +// +// A parameter provided to the Platform Crypto Provider is invalid. +// +#define STATUS_PCP_INVALID_PARAMETER ((NTSTATUS)0xC0292003L) + +// +// MessageId: STATUS_PCP_FLAG_NOT_SUPPORTED +// +// MessageText: +// +// A provided flag to the Platform Crypto Provider is not supported. +// +#define STATUS_PCP_FLAG_NOT_SUPPORTED ((NTSTATUS)0xC0292004L) + +// +// MessageId: STATUS_PCP_NOT_SUPPORTED +// +// MessageText: +// +// The requested operation is not supported by this Platform Crypto Provider. +// +#define STATUS_PCP_NOT_SUPPORTED ((NTSTATUS)0xC0292005L) + +// +// MessageId: STATUS_PCP_BUFFER_TOO_SMALL +// +// MessageText: +// +// The buffer is too small to contain all data. No information has been written to the buffer. +// +#define STATUS_PCP_BUFFER_TOO_SMALL ((NTSTATUS)0xC0292006L) + +// +// MessageId: STATUS_PCP_INTERNAL_ERROR +// +// MessageText: +// +// An unexpected internal error has occurred in the Platform Crypto Provider. +// +#define STATUS_PCP_INTERNAL_ERROR ((NTSTATUS)0xC0292007L) + +// +// MessageId: STATUS_PCP_AUTHENTICATION_FAILED +// +// MessageText: +// +// The authorization to use a provider object has failed. +// +#define STATUS_PCP_AUTHENTICATION_FAILED ((NTSTATUS)0xC0292008L) + +// +// MessageId: STATUS_PCP_AUTHENTICATION_IGNORED +// +// MessageText: +// +// The Platform Crypto Device has ignored the authorization for the provider object, to mitigate against a dictionary attack. +// +#define STATUS_PCP_AUTHENTICATION_IGNORED ((NTSTATUS)0xC0292009L) + +// +// MessageId: STATUS_PCP_POLICY_NOT_FOUND +// +// MessageText: +// +// The referenced policy was not found. +// +#define STATUS_PCP_POLICY_NOT_FOUND ((NTSTATUS)0xC029200AL) + +// +// MessageId: STATUS_PCP_PROFILE_NOT_FOUND +// +// MessageText: +// +// The referenced profile was not found. +// +#define STATUS_PCP_PROFILE_NOT_FOUND ((NTSTATUS)0xC029200BL) + +// +// MessageId: STATUS_PCP_VALIDATION_FAILED +// +// MessageText: +// +// The validation was not successful. +// +#define STATUS_PCP_VALIDATION_FAILED ((NTSTATUS)0xC029200CL) + +// +// MessageId: STATUS_PCP_DEVICE_NOT_FOUND +// +// MessageText: +// +// A Platform Crypto Device was not found. Operations that require a Platform Crypto Device will not be submitted. +// +#define STATUS_PCP_DEVICE_NOT_FOUND ((NTSTATUS)0xC029200DL) + +// +// MessageId: STATUS_PCP_WRONG_PARENT +// +// MessageText: +// +// An attempt was made to import or load a key under an incorrect storage parent. +// +#define STATUS_PCP_WRONG_PARENT ((NTSTATUS)0xC029200EL) + +// +// MessageId: STATUS_PCP_KEY_NOT_LOADED +// +// MessageText: +// +// The TPM key is not loaded. +// +#define STATUS_PCP_KEY_NOT_LOADED ((NTSTATUS)0xC029200FL) + +// +// MessageId: STATUS_PCP_NO_KEY_CERTIFICATION +// +// MessageText: +// +// The TPM key certification has not been generated. +// +#define STATUS_PCP_NO_KEY_CERTIFICATION ((NTSTATUS)0xC0292010L) + +// +// MessageId: STATUS_PCP_KEY_NOT_FINALIZED +// +// MessageText: +// +// The TPM key is not yet finalized. +// +#define STATUS_PCP_KEY_NOT_FINALIZED ((NTSTATUS)0xC0292011L) + +// +// MessageId: STATUS_PCP_ATTESTATION_CHALLENGE_NOT_SET +// +// MessageText: +// +// The TPM attestation challenge is not set. +// +#define STATUS_PCP_ATTESTATION_CHALLENGE_NOT_SET ((NTSTATUS)0xC0292012L) + +// +// MessageId: STATUS_PCP_NOT_PCR_BOUND +// +// MessageText: +// +// The TPM key is not bound to PCR info. +// +#define STATUS_PCP_NOT_PCR_BOUND ((NTSTATUS)0xC0292013L) + +// +// MessageId: STATUS_PCP_KEY_ALREADY_FINALIZED +// +// MessageText: +// +// The TPM key is already finalized. +// +#define STATUS_PCP_KEY_ALREADY_FINALIZED ((NTSTATUS)0xC0292014L) + +// +// MessageId: STATUS_PCP_KEY_USAGE_POLICY_NOT_SUPPORTED +// +// MessageText: +// +// The TPM key usage policy is not supported. +// +#define STATUS_PCP_KEY_USAGE_POLICY_NOT_SUPPORTED ((NTSTATUS)0xC0292015L) + +// +// MessageId: STATUS_PCP_KEY_USAGE_POLICY_INVALID +// +// MessageText: +// +// The TPM key usage policy is invalid. +// +#define STATUS_PCP_KEY_USAGE_POLICY_INVALID ((NTSTATUS)0xC0292016L) + +// +// MessageId: STATUS_PCP_SOFT_KEY_ERROR +// +// MessageText: +// +// There was a problem with the software key being imported into the TPM. +// +#define STATUS_PCP_SOFT_KEY_ERROR ((NTSTATUS)0xC0292017L) + +// +// MessageId: STATUS_PCP_KEY_NOT_AUTHENTICATED +// +// MessageText: +// +// The TPM key is not authenticated. +// +#define STATUS_PCP_KEY_NOT_AUTHENTICATED ((NTSTATUS)0xC0292018L) + +// +// MessageId: STATUS_PCP_KEY_NOT_AIK +// +// MessageText: +// +// The TPM key is not an AIK. +// +#define STATUS_PCP_KEY_NOT_AIK ((NTSTATUS)0xC0292019L) + +// +// MessageId: STATUS_PCP_KEY_NOT_SIGNING_KEY +// +// MessageText: +// +// The TPM key is not a signing key. +// +#define STATUS_PCP_KEY_NOT_SIGNING_KEY ((NTSTATUS)0xC029201AL) + +// +// MessageId: STATUS_PCP_LOCKED_OUT +// +// MessageText: +// +// The TPM is locked out. +// +#define STATUS_PCP_LOCKED_OUT ((NTSTATUS)0xC029201BL) + +// +// MessageId: STATUS_PCP_CLAIM_TYPE_NOT_SUPPORTED +// +// MessageText: +// +// The claim type requested is not supported. +// +#define STATUS_PCP_CLAIM_TYPE_NOT_SUPPORTED ((NTSTATUS)0xC029201CL) + +// +// MessageId: STATUS_PCP_TPM_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The current TPM version is not supported. +// +#define STATUS_PCP_TPM_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC029201DL) + +// +// MessageId: STATUS_PCP_BUFFER_LENGTH_MISMATCH +// +// MessageText: +// +// The buffer lengths do not match. +// +#define STATUS_PCP_BUFFER_LENGTH_MISMATCH ((NTSTATUS)0xC029201EL) + +// +// MessageId: STATUS_PCP_IFX_RSA_KEY_CREATION_BLOCKED +// +// MessageText: +// +// The RSA key creation is blocked on this TPM due to known security vulnerabilities. +// +#define STATUS_PCP_IFX_RSA_KEY_CREATION_BLOCKED ((NTSTATUS)0xC029201FL) + +// +// MessageId: STATUS_PCP_TICKET_MISSING +// +// MessageText: +// +// A ticket required to use a key was not provided. +// +#define STATUS_PCP_TICKET_MISSING ((NTSTATUS)0xC0292020L) + +// +// MessageId: STATUS_PCP_RAW_POLICY_NOT_SUPPORTED +// +// MessageText: +// +// This key has a raw policy so the KSP can't authenticate against it. +// +#define STATUS_PCP_RAW_POLICY_NOT_SUPPORTED ((NTSTATUS)0xC0292021L) + +// +// MessageId: STATUS_PCP_KEY_HANDLE_INVALIDATED +// +// MessageText: +// +// The TPM key's handle was unexpectedly invalidated due to a hardware or firmware issue. +// +#define STATUS_PCP_KEY_HANDLE_INVALIDATED ((NTSTATUS)0xC0292022L) + +// +// MessageId: STATUS_PCP_UNSUPPORTED_PSS_SALT +// +// MessageText: +// +// The requested salt size for signing with RSAPSS does not match what the TPM uses. +// +#define STATUS_PCP_UNSUPPORTED_PSS_SALT ((NTSTATUS)0x40292023L) + + +// +// Remote TPM Error Codes +// + +// +// MessageId: STATUS_RTPM_CONTEXT_CONTINUE +// +// MessageText: +// +// The remote TPM context exchange is not complete. The context should be transported to the target and continued. +// +#define STATUS_RTPM_CONTEXT_CONTINUE ((NTSTATUS)0x00293000L) + +// +// MessageId: STATUS_RTPM_CONTEXT_COMPLETE +// +// MessageText: +// +// The remote TPM operation is complete. +// +#define STATUS_RTPM_CONTEXT_COMPLETE ((NTSTATUS)0x00293001L) + +// +// MessageId: STATUS_RTPM_NO_RESULT +// +// MessageText: +// +// No result associated with this instance exists. +// +#define STATUS_RTPM_NO_RESULT ((NTSTATUS)0xC0293002L) + +// +// MessageId: STATUS_RTPM_PCR_READ_INCOMPLETE +// +// MessageText: +// +// The TPM returned incomplete PCR results. This maybe due to an unsupported selection set. Attempt the read again with a different selection set. +// +#define STATUS_RTPM_PCR_READ_INCOMPLETE ((NTSTATUS)0xC0293003L) + +// +// MessageId: STATUS_RTPM_INVALID_CONTEXT +// +// MessageText: +// +// The rTPM context has been corrupted. The rTPM operation must be restarted. +// +#define STATUS_RTPM_INVALID_CONTEXT ((NTSTATUS)0xC0293004L) + +// +// MessageId: STATUS_RTPM_UNSUPPORTED_CMD +// +// MessageText: +// +// The rTPM target does not support remote processing of the specified TPM command. +// +#define STATUS_RTPM_UNSUPPORTED_CMD ((NTSTATUS)0xC0293005L) + + +// +// Misc TPM Error Codes +// + +// +// MessageId: STATUS_TPM_ZERO_EXHAUST_ENABLED +// +// MessageText: +// +// TPM related network operations are blocked as Zero Exhaust mode is enabled on client. +// +#define STATUS_TPM_ZERO_EXHAUST_ENABLED ((NTSTATUS)0xC0294000L) + + +// +// DRTM Error Codes +// + +// +// MessageId: STATUS_DRTM_ENVIRONMENT_UNSAFE +// +// MessageText: +// +// The current environment is unsafe for DRTM to run in. +// +#define STATUS_DRTM_ENVIRONMENT_UNSAFE ((NTSTATUS)0xC0295000L) + +// +// MessageId: STATUS_DRTM_NO_DIRECT_AUTH_FOR_CURRENT_MLE +// +// MessageText: +// +// There are no authorizations for the current running MLE. The current state is not authorized. +// +#define STATUS_DRTM_NO_DIRECT_AUTH_FOR_CURRENT_MLE ((NTSTATUS)0xC0295001L) + +// +// Hypervisor error codes - changes to these codes must be reflected in HvStatus.h +// + +// +// MessageId: STATUS_HV_INVALID_HYPERCALL_CODE +// +// MessageText: +// +// The hypervisor does not support the operation because the specified hypercall code is not supported. +// +#define STATUS_HV_INVALID_HYPERCALL_CODE ((NTSTATUS)0xC0350002L) + +// +// MessageId: STATUS_HV_INVALID_HYPERCALL_INPUT +// +// MessageText: +// +// The hypervisor does not support the operation because the encoding for the hypercall input register is not supported. +// +#define STATUS_HV_INVALID_HYPERCALL_INPUT ((NTSTATUS)0xC0350003L) + +// +// MessageId: STATUS_HV_INVALID_ALIGNMENT +// +// MessageText: +// +// The hypervisor could not perform the operation because a parameter has an invalid alignment. +// +#define STATUS_HV_INVALID_ALIGNMENT ((NTSTATUS)0xC0350004L) + +// +// MessageId: STATUS_HV_INVALID_PARAMETER +// +// MessageText: +// +// The hypervisor could not perform the operation because an invalid parameter was specified. +// +#define STATUS_HV_INVALID_PARAMETER ((NTSTATUS)0xC0350005L) + +// +// MessageId: STATUS_HV_ACCESS_DENIED +// +// MessageText: +// +// Access to the specified object was denied. +// +#define STATUS_HV_ACCESS_DENIED ((NTSTATUS)0xC0350006L) + +// +// MessageId: STATUS_HV_INVALID_PARTITION_STATE +// +// MessageText: +// +// The hypervisor could not perform the operation because the partition is entering or in an invalid state. +// +#define STATUS_HV_INVALID_PARTITION_STATE ((NTSTATUS)0xC0350007L) + +// +// MessageId: STATUS_HV_OPERATION_DENIED +// +// MessageText: +// +// The operation is not allowed in the current state. +// +#define STATUS_HV_OPERATION_DENIED ((NTSTATUS)0xC0350008L) + +// +// MessageId: STATUS_HV_UNKNOWN_PROPERTY +// +// MessageText: +// +// The hypervisor does not recognize the specified partition property. +// +#define STATUS_HV_UNKNOWN_PROPERTY ((NTSTATUS)0xC0350009L) + +// +// MessageId: STATUS_HV_PROPERTY_VALUE_OUT_OF_RANGE +// +// MessageText: +// +// The specified value of a partition property is out of range or violates an invariant. +// +#define STATUS_HV_PROPERTY_VALUE_OUT_OF_RANGE ((NTSTATUS)0xC035000AL) + +// +// MessageId: STATUS_HV_INSUFFICIENT_MEMORY +// +// MessageText: +// +// There is not enough memory in the hypervisor pool to complete the operation. +// +#define STATUS_HV_INSUFFICIENT_MEMORY ((NTSTATUS)0xC035000BL) + +// +// MessageId: STATUS_HV_PARTITION_TOO_DEEP +// +// MessageText: +// +// The maximum partition depth has been exceeded for the partition hierarchy. +// +#define STATUS_HV_PARTITION_TOO_DEEP ((NTSTATUS)0xC035000CL) + +// +// MessageId: STATUS_HV_INVALID_PARTITION_ID +// +// MessageText: +// +// A partition with the specified partition Id does not exist. +// +#define STATUS_HV_INVALID_PARTITION_ID ((NTSTATUS)0xC035000DL) + +// +// MessageId: STATUS_HV_INVALID_VP_INDEX +// +// MessageText: +// +// The hypervisor could not perform the operation because the specified VP index is invalid. +// +#define STATUS_HV_INVALID_VP_INDEX ((NTSTATUS)0xC035000EL) + +// +// MessageId: STATUS_HV_INVALID_PORT_ID +// +// MessageText: +// +// The hypervisor could not perform the operation because the specified port identifier is invalid. +// +#define STATUS_HV_INVALID_PORT_ID ((NTSTATUS)0xC0350011L) + +// +// MessageId: STATUS_HV_INVALID_CONNECTION_ID +// +// MessageText: +// +// The hypervisor could not perform the operation because the specified connection identifier is invalid. +// +#define STATUS_HV_INVALID_CONNECTION_ID ((NTSTATUS)0xC0350012L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_BUFFERS +// +// MessageText: +// +// Not enough buffers were supplied to send a message. +// +#define STATUS_HV_INSUFFICIENT_BUFFERS ((NTSTATUS)0xC0350013L) + +// +// MessageId: STATUS_HV_NOT_ACKNOWLEDGED +// +// MessageText: +// +// The previous virtual interrupt has not been acknowledged. +// +#define STATUS_HV_NOT_ACKNOWLEDGED ((NTSTATUS)0xC0350014L) + +// +// MessageId: STATUS_HV_INVALID_VP_STATE +// +// MessageText: +// +// A virtual processor is not in the correct state for the indicated operation. +// +#define STATUS_HV_INVALID_VP_STATE ((NTSTATUS)0xC0350015L) + +// +// MessageId: STATUS_HV_ACKNOWLEDGED +// +// MessageText: +// +// The previous virtual interrupt has already been acknowledged. +// +#define STATUS_HV_ACKNOWLEDGED ((NTSTATUS)0xC0350016L) + +// +// MessageId: STATUS_HV_INVALID_SAVE_RESTORE_STATE +// +// MessageText: +// +// The indicated partition is not in a valid state for saving or restoring. +// +#define STATUS_HV_INVALID_SAVE_RESTORE_STATE ((NTSTATUS)0xC0350017L) + +// +// MessageId: STATUS_HV_INVALID_SYNIC_STATE +// +// MessageText: +// +// The hypervisor could not complete the operation because a required feature of the synthetic interrupt controller (SynIC) was disabled. +// +#define STATUS_HV_INVALID_SYNIC_STATE ((NTSTATUS)0xC0350018L) + +// +// MessageId: STATUS_HV_OBJECT_IN_USE +// +// MessageText: +// +// The hypervisor could not perform the operation because the object or value was either already in use or being used for a purpose that would not permit completing the operation. +// +#define STATUS_HV_OBJECT_IN_USE ((NTSTATUS)0xC0350019L) + +// +// MessageId: STATUS_HV_INVALID_PROXIMITY_DOMAIN_INFO +// +// MessageText: +// +// The proximity domain information is invalid. +// +#define STATUS_HV_INVALID_PROXIMITY_DOMAIN_INFO ((NTSTATUS)0xC035001AL) + +// +// MessageId: STATUS_HV_NO_DATA +// +// MessageText: +// +// An attempt to retrieve debugging data failed because none was available. +// +#define STATUS_HV_NO_DATA ((NTSTATUS)0xC035001BL) + +// +// MessageId: STATUS_HV_INACTIVE +// +// MessageText: +// +// The physical connection being used for debugging has not recorded any receive activity since the last operation. +// +#define STATUS_HV_INACTIVE ((NTSTATUS)0xC035001CL) + +// +// MessageId: STATUS_HV_NO_RESOURCES +// +// MessageText: +// +// There are not enough resources to complete the operation. +// +#define STATUS_HV_NO_RESOURCES ((NTSTATUS)0xC035001DL) + +// +// MessageId: STATUS_HV_FEATURE_UNAVAILABLE +// +// MessageText: +// +// A hypervisor feature is not available to the user. +// +#define STATUS_HV_FEATURE_UNAVAILABLE ((NTSTATUS)0xC035001EL) + +// +// MessageId: STATUS_HV_INSUFFICIENT_BUFFER +// +// MessageText: +// +// The specified buffer was too small to contain all of the requested data. +// +#define STATUS_HV_INSUFFICIENT_BUFFER ((NTSTATUS)0xC0350033L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_DEVICE_DOMAINS +// +// MessageText: +// +// The maximum number of domains supported by the platform I/O remapping hardware is currently in use. No domains are available to assign this device to this partition. +// +#define STATUS_HV_INSUFFICIENT_DEVICE_DOMAINS ((NTSTATUS)0xC0350038L) + +// +// MessageId: STATUS_HV_CPUID_FEATURE_VALIDATION_ERROR +// +// MessageText: +// +// Validation of CPUID data of the processor failed. +// +#define STATUS_HV_CPUID_FEATURE_VALIDATION_ERROR ((NTSTATUS)0xC035003CL) + +// +// MessageId: STATUS_HV_CPUID_XSAVE_FEATURE_VALIDATION_ERROR +// +// MessageText: +// +// Validation of XSAVE CPUID data of the processor failed. +// +#define STATUS_HV_CPUID_XSAVE_FEATURE_VALIDATION_ERROR ((NTSTATUS)0xC035003DL) + +// +// MessageId: STATUS_HV_PROCESSOR_STARTUP_TIMEOUT +// +// MessageText: +// +// Processor did not respond within the timeout period. +// +#define STATUS_HV_PROCESSOR_STARTUP_TIMEOUT ((NTSTATUS)0xC035003EL) + +// +// MessageId: STATUS_HV_SMX_ENABLED +// +// MessageText: +// +// SMX has been enabled in the BIOS. +// +#define STATUS_HV_SMX_ENABLED ((NTSTATUS)0xC035003FL) + +// +// MessageId: STATUS_HV_INVALID_LP_INDEX +// +// MessageText: +// +// The hypervisor could not perform the operation because the specified LP index is invalid. +// +#define STATUS_HV_INVALID_LP_INDEX ((NTSTATUS)0xC0350041L) + +// +// MessageId: STATUS_HV_INVALID_REGISTER_VALUE +// +// MessageText: +// +// The supplied register value is invalid. +// +#define STATUS_HV_INVALID_REGISTER_VALUE ((NTSTATUS)0xC0350050L) + +// +// MessageId: STATUS_HV_INVALID_VTL_STATE +// +// MessageText: +// +// The supplied virtual trust level is not in the correct state to perform the requested operation. +// +#define STATUS_HV_INVALID_VTL_STATE ((NTSTATUS)0xC0350051L) + +// +// MessageId: STATUS_HV_NX_NOT_DETECTED +// +// MessageText: +// +// No execute feature (NX) is not present or not enabled in the BIOS. +// +#define STATUS_HV_NX_NOT_DETECTED ((NTSTATUS)0xC0350055L) + +// +// MessageId: STATUS_HV_INVALID_DEVICE_ID +// +// MessageText: +// +// The supplied device ID is invalid. +// +#define STATUS_HV_INVALID_DEVICE_ID ((NTSTATUS)0xC0350057L) + +// +// MessageId: STATUS_HV_INVALID_DEVICE_STATE +// +// MessageText: +// +// The operation is not allowed in the current device state. +// +#define STATUS_HV_INVALID_DEVICE_STATE ((NTSTATUS)0xC0350058L) + +// +// MessageId: STATUS_HV_PENDING_PAGE_REQUESTS +// +// MessageText: +// +// The device had pending page requests which were discarded. +// +#define STATUS_HV_PENDING_PAGE_REQUESTS ((NTSTATUS)0x00350059L) + +// +// MessageId: STATUS_HV_PAGE_REQUEST_INVALID +// +// MessageText: +// +// The supplied page request specifies a memory access that the guest does not have permissions to perform. +// +#define STATUS_HV_PAGE_REQUEST_INVALID ((NTSTATUS)0xC0350060L) + +// +// MessageId: STATUS_HV_INVALID_CPU_GROUP_ID +// +// MessageText: +// +// A CPU group with the specified CPU group Id does not exist. +// +#define STATUS_HV_INVALID_CPU_GROUP_ID ((NTSTATUS)0xC035006FL) + +// +// MessageId: STATUS_HV_INVALID_CPU_GROUP_STATE +// +// MessageText: +// +// The hypervisor could not perform the operation because the CPU group is entering or in an invalid state. +// +#define STATUS_HV_INVALID_CPU_GROUP_STATE ((NTSTATUS)0xC0350070L) + +// +// MessageId: STATUS_HV_OPERATION_FAILED +// +// MessageText: +// +// The requested operation failed. +// +#define STATUS_HV_OPERATION_FAILED ((NTSTATUS)0xC0350071L) + +// +// MessageId: STATUS_HV_NOT_ALLOWED_WITH_NESTED_VIRT_ACTIVE +// +// MessageText: +// +// The hypervisor could not perform the operation because it is not allowed with nested virtualization active. +// +#define STATUS_HV_NOT_ALLOWED_WITH_NESTED_VIRT_ACTIVE ((NTSTATUS)0xC0350072L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_ROOT_MEMORY +// +// MessageText: +// +// There is not enough memory in the root partition's pool to complete the operation. +// +#define STATUS_HV_INSUFFICIENT_ROOT_MEMORY ((NTSTATUS)0xC0350073L) + +// +// MessageId: STATUS_HV_EVENT_BUFFER_ALREADY_FREED +// +// MessageText: +// +// The provided event log buffer was already marked as freed. +// +#define STATUS_HV_EVENT_BUFFER_ALREADY_FREED ((NTSTATUS)0xC0350074L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_CONTIGUOUS_MEMORY +// +// MessageText: +// +// There is not enough contiguous memory in the partition's pool to complete the operation. +// +#define STATUS_HV_INSUFFICIENT_CONTIGUOUS_MEMORY ((NTSTATUS)0xC0350075L) + +// +// MessageId: STATUS_HV_DEVICE_NOT_IN_DOMAIN +// +// MessageText: +// +// The device is not in a device domain. +// +#define STATUS_HV_DEVICE_NOT_IN_DOMAIN ((NTSTATUS)0xC0350076L) + +// +// MessageId: STATUS_HV_NESTED_VM_EXIT +// +// MessageText: +// +// The requested operation would result in a nested vm-exit. +// +#define STATUS_HV_NESTED_VM_EXIT ((NTSTATUS)0xC0350077L) + +// +// MessageId: STATUS_HV_CALL_PENDING +// +// MessageText: +// +// The operation that was requested is pending completion. +// +#define STATUS_HV_CALL_PENDING ((NTSTATUS)0xC0350079L) + +// +// MessageId: STATUS_HV_MSR_ACCESS_FAILED +// +// MessageText: +// +// The requested access to the model specific register failed. +// +#define STATUS_HV_MSR_ACCESS_FAILED ((NTSTATUS)0xC0350080L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_MEMORY_MIRRORING +// +// MessageText: +// +// There is not enough memory in the partition's pool to complete the mirroring operation. +// +#define STATUS_HV_INSUFFICIENT_MEMORY_MIRRORING ((NTSTATUS)0xC0350081L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_CONTIGUOUS_MEMORY_MIRRORING +// +// MessageText: +// +// There is not enough contiguous memory in the partition's pool to complete the mirroring operation. +// +#define STATUS_HV_INSUFFICIENT_CONTIGUOUS_MEMORY_MIRRORING ((NTSTATUS)0xC0350082L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_CONTIGUOUS_ROOT_MEMORY +// +// MessageText: +// +// There is not enough contiguous memory in the root partition's pool to complete the operation. +// +#define STATUS_HV_INSUFFICIENT_CONTIGUOUS_ROOT_MEMORY ((NTSTATUS)0xC0350083L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_ROOT_MEMORY_MIRRORING +// +// MessageText: +// +// There is not enough memory in the root partition's pool to complete the mirroring operation. +// +#define STATUS_HV_INSUFFICIENT_ROOT_MEMORY_MIRRORING ((NTSTATUS)0xC0350084L) + +// +// MessageId: STATUS_HV_INSUFFICIENT_CONTIGUOUS_ROOT_MEMORY_MIRRORING +// +// MessageText: +// +// There is not enough contiguous memory in the root partition's pool to complete the mirroring operation. +// +#define STATUS_HV_INSUFFICIENT_CONTIGUOUS_ROOT_MEMORY_MIRRORING ((NTSTATUS)0xC0350085L) + +// +// MessageId: STATUS_HV_VTL_ALREADY_ENABLED +// +// MessageText: +// +// The VTL specified for the operation is already in an enabled state. +// +#define STATUS_HV_VTL_ALREADY_ENABLED ((NTSTATUS)0xC0350086L) + +// +// MessageId: STATUS_HV_SPDM_REQUEST +// +// MessageText: +// +// The device security operation was interrupted due to a required SPDM request. +// +#define STATUS_HV_SPDM_REQUEST ((NTSTATUS)0xC0350088L) + +// +// MessageId: STATUS_HV_NOT_PRESENT +// +// MessageText: +// +// No hypervisor is present on this system. +// +#define STATUS_HV_NOT_PRESENT ((NTSTATUS)0xC0351000L) + +// +// Virtualization status codes - these codes are used by the Virtualization Infrastructure Driver (VID) and other components +// of the virtualization stack. +// +// +// Errors: +// + +// +// MessageId: STATUS_VID_DUPLICATE_HANDLER +// +// MessageText: +// +// The handler for the virtualization infrastructure driver is already registered. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_DUPLICATE_HANDLER ((NTSTATUS)0xC0370001L) + +// +// MessageId: STATUS_VID_TOO_MANY_HANDLERS +// +// MessageText: +// +// The number of registered handlers for the virtualization infrastructure driver exceeded the maximum. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_TOO_MANY_HANDLERS ((NTSTATUS)0xC0370002L) + +// +// MessageId: STATUS_VID_QUEUE_FULL +// +// MessageText: +// +// The message queue for the virtualization infrastructure driver is full and cannot accept new messages. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_QUEUE_FULL ((NTSTATUS)0xC0370003L) + +// +// MessageId: STATUS_VID_HANDLER_NOT_PRESENT +// +// MessageText: +// +// No handler exists to handle the message for the virtualization infrastructure driver. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_HANDLER_NOT_PRESENT ((NTSTATUS)0xC0370004L) + +// +// MessageId: STATUS_VID_INVALID_OBJECT_NAME +// +// MessageText: +// +// The name of the partition or message queue for the virtualization infrastructure driver is invalid. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_INVALID_OBJECT_NAME ((NTSTATUS)0xC0370005L) + +// +// MessageId: STATUS_VID_PARTITION_NAME_TOO_LONG +// +// MessageText: +// +// The partition name of the virtualization infrastructure driver exceeds the maximum. +// +#define STATUS_VID_PARTITION_NAME_TOO_LONG ((NTSTATUS)0xC0370006L) + +// +// MessageId: STATUS_VID_MESSAGE_QUEUE_NAME_TOO_LONG +// +// MessageText: +// +// The message queue name of the virtualization infrastructure driver exceeds the maximum. +// +#define STATUS_VID_MESSAGE_QUEUE_NAME_TOO_LONG ((NTSTATUS)0xC0370007L) + +// +// MessageId: STATUS_VID_PARTITION_ALREADY_EXISTS +// +// MessageText: +// +// Cannot create the partition for the virtualization infrastructure driver because another partition with the same name already exists. +// +#define STATUS_VID_PARTITION_ALREADY_EXISTS ((NTSTATUS)0xC0370008L) + +// +// MessageId: STATUS_VID_PARTITION_DOES_NOT_EXIST +// +// MessageText: +// +// The virtualization infrastructure driver has encountered an error. The requested partition does not exist. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_PARTITION_DOES_NOT_EXIST ((NTSTATUS)0xC0370009L) + +// +// MessageId: STATUS_VID_PARTITION_NAME_NOT_FOUND +// +// MessageText: +// +// The virtualization infrastructure driver has encountered an error. Could not find the requested partition. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_PARTITION_NAME_NOT_FOUND ((NTSTATUS)0xC037000AL) + +// +// MessageId: STATUS_VID_MESSAGE_QUEUE_ALREADY_EXISTS +// +// MessageText: +// +// A message queue with the same name already exists for the virtualization infrastructure driver. +// +#define STATUS_VID_MESSAGE_QUEUE_ALREADY_EXISTS ((NTSTATUS)0xC037000BL) + +// +// MessageId: STATUS_VID_EXCEEDED_MBP_ENTRY_MAP_LIMIT +// +// MessageText: +// +// The memory block page for the virtualization infrastructure driver cannot be mapped because the page map limit has been reached. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_EXCEEDED_MBP_ENTRY_MAP_LIMIT ((NTSTATUS)0xC037000CL) + +// +// MessageId: STATUS_VID_MB_STILL_REFERENCED +// +// MessageText: +// +// The memory block for the virtualization infrastructure driver is still being used and cannot be destroyed. +// +#define STATUS_VID_MB_STILL_REFERENCED ((NTSTATUS)0xC037000DL) + +// +// MessageId: STATUS_VID_CHILD_GPA_PAGE_SET_CORRUPTED +// +// MessageText: +// +// Cannot unlock the page array for the guest operating system memory address because it does not match a previous lock request. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_CHILD_GPA_PAGE_SET_CORRUPTED ((NTSTATUS)0xC037000EL) + +// +// MessageId: STATUS_VID_INVALID_NUMA_SETTINGS +// +// MessageText: +// +// The non-uniform memory access (NUMA) node settings do not match the system NUMA topology. In order to start the virtual machine, you will need to modify the NUMA configuration. +// +#define STATUS_VID_INVALID_NUMA_SETTINGS ((NTSTATUS)0xC037000FL) + +// +// MessageId: STATUS_VID_INVALID_NUMA_NODE_INDEX +// +// MessageText: +// +// The non-uniform memory access (NUMA) node index does not match a valid index in the system NUMA topology. +// +#define STATUS_VID_INVALID_NUMA_NODE_INDEX ((NTSTATUS)0xC0370010L) + +// +// MessageId: STATUS_VID_NOTIFICATION_QUEUE_ALREADY_ASSOCIATED +// +// MessageText: +// +// The memory block for the virtualization infrastructure driver is already associated with a message queue. +// +#define STATUS_VID_NOTIFICATION_QUEUE_ALREADY_ASSOCIATED ((NTSTATUS)0xC0370011L) + +// +// MessageId: STATUS_VID_INVALID_MEMORY_BLOCK_HANDLE +// +// MessageText: +// +// The handle is not a valid memory block handle for the virtualization infrastructure driver. +// +#define STATUS_VID_INVALID_MEMORY_BLOCK_HANDLE ((NTSTATUS)0xC0370012L) + +// +// MessageId: STATUS_VID_PAGE_RANGE_OVERFLOW +// +// MessageText: +// +// The request exceeded the memory block page limit for the virtualization infrastructure driver. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_PAGE_RANGE_OVERFLOW ((NTSTATUS)0xC0370013L) + +// +// MessageId: STATUS_VID_INVALID_MESSAGE_QUEUE_HANDLE +// +// MessageText: +// +// The handle is not a valid message queue handle for the virtualization infrastructure driver. +// +#define STATUS_VID_INVALID_MESSAGE_QUEUE_HANDLE ((NTSTATUS)0xC0370014L) + +// +// MessageId: STATUS_VID_INVALID_GPA_RANGE_HANDLE +// +// MessageText: +// +// The handle is not a valid page range handle for the virtualization infrastructure driver. +// +#define STATUS_VID_INVALID_GPA_RANGE_HANDLE ((NTSTATUS)0xC0370015L) + +// +// MessageId: STATUS_VID_NO_MEMORY_BLOCK_NOTIFICATION_QUEUE +// +// MessageText: +// +// Cannot install client notifications because no message queue for the virtualization infrastructure driver is associated with the memory block. +// +#define STATUS_VID_NO_MEMORY_BLOCK_NOTIFICATION_QUEUE ((NTSTATUS)0xC0370016L) + +// +// MessageId: STATUS_VID_MEMORY_BLOCK_LOCK_COUNT_EXCEEDED +// +// MessageText: +// +// The request to lock or map a memory block page failed because the virtualization infrastructure driver memory block limit has been reached. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +// +// +#define STATUS_VID_MEMORY_BLOCK_LOCK_COUNT_EXCEEDED ((NTSTATUS)0xC0370017L) + +// +// MessageId: STATUS_VID_INVALID_PPM_HANDLE +// +// MessageText: +// +// The handle is not a valid parent partition mapping handle for the virtualization infrastructure driver. +// +#define STATUS_VID_INVALID_PPM_HANDLE ((NTSTATUS)0xC0370018L) + +// +// MessageId: STATUS_VID_MBPS_ARE_LOCKED +// +// MessageText: +// +// Notifications cannot be created on the memory block because it is use. +// +#define STATUS_VID_MBPS_ARE_LOCKED ((NTSTATUS)0xC0370019L) + +// +// MessageId: STATUS_VID_MESSAGE_QUEUE_CLOSED +// +// MessageText: +// +// The message queue for the virtualization infrastructure driver has been closed. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_MESSAGE_QUEUE_CLOSED ((NTSTATUS)0xC037001AL) + +// +// MessageId: STATUS_VID_VIRTUAL_PROCESSOR_LIMIT_EXCEEDED +// +// MessageText: +// +// Cannot add a virtual processor to the partition because the maximum has been reached. +// +#define STATUS_VID_VIRTUAL_PROCESSOR_LIMIT_EXCEEDED ((NTSTATUS)0xC037001BL) + +// +// MessageId: STATUS_VID_STOP_PENDING +// +// MessageText: +// +// Cannot stop the virtual processor immediately because of a pending intercept. +// +#define STATUS_VID_STOP_PENDING ((NTSTATUS)0xC037001CL) + +// +// MessageId: STATUS_VID_INVALID_PROCESSOR_STATE +// +// MessageText: +// +// Invalid state for the virtual processor. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_INVALID_PROCESSOR_STATE ((NTSTATUS)0xC037001DL) + +// +// MessageId: STATUS_VID_EXCEEDED_KM_CONTEXT_COUNT_LIMIT +// +// MessageText: +// +// The maximum number of kernel mode clients for the virtualization infrastructure driver has been reached. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_EXCEEDED_KM_CONTEXT_COUNT_LIMIT ((NTSTATUS)0xC037001EL) + +// +// MessageId: STATUS_VID_KM_INTERFACE_ALREADY_INITIALIZED +// +// MessageText: +// +// This kernel mode interface for the virtualization infrastructure driver has already been initialized. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_KM_INTERFACE_ALREADY_INITIALIZED ((NTSTATUS)0xC037001FL) + +// +// MessageId: STATUS_VID_MB_PROPERTY_ALREADY_SET_RESET +// +// MessageText: +// +// Cannot set or reset the memory block property more than once for the virtualization infrastructure driver. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_MB_PROPERTY_ALREADY_SET_RESET ((NTSTATUS)0xC0370020L) + +// +// MessageId: STATUS_VID_MMIO_RANGE_DESTROYED +// +// MessageText: +// +// The memory mapped I/O for this page range no longer exists. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_MMIO_RANGE_DESTROYED ((NTSTATUS)0xC0370021L) + +// +// MessageId: STATUS_VID_INVALID_CHILD_GPA_PAGE_SET +// +// MessageText: +// +// The lock or unlock request uses an invalid guest operating system memory address. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_INVALID_CHILD_GPA_PAGE_SET ((NTSTATUS)0xC0370022L) + +// +// MessageId: STATUS_VID_RESERVE_PAGE_SET_IS_BEING_USED +// +// MessageText: +// +// Cannot destroy or reuse the reserve page set for the virtualization infrastructure driver because it is in use. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_RESERVE_PAGE_SET_IS_BEING_USED ((NTSTATUS)0xC0370023L) + +// +// MessageId: STATUS_VID_RESERVE_PAGE_SET_TOO_SMALL +// +// MessageText: +// +// The reserve page set for the virtualization infrastructure driver is too small to use in the lock request. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_RESERVE_PAGE_SET_TOO_SMALL ((NTSTATUS)0xC0370024L) + +// +// MessageId: STATUS_VID_MBP_ALREADY_LOCKED_USING_RESERVED_PAGE +// +// MessageText: +// +// Cannot lock or map the memory block page for the virtualization infrastructure driver because it has already been locked using a reserve page set page. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_MBP_ALREADY_LOCKED_USING_RESERVED_PAGE ((NTSTATUS)0xC0370025L) + +// +// MessageId: STATUS_VID_MBP_COUNT_EXCEEDED_LIMIT +// +// MessageText: +// +// Cannot create the memory block for the virtualization infrastructure driver because the requested number of pages exceeded the limit. Restarting the virtual machine may fix the problem. If the problem persists, try restarting the physical computer. +// +#define STATUS_VID_MBP_COUNT_EXCEEDED_LIMIT ((NTSTATUS)0xC0370026L) + +// +// MessageId: STATUS_VID_SAVED_STATE_CORRUPT +// +// MessageText: +// +// Cannot restore this virtual machine because the saved state data cannot be read. Delete the saved state data and then try to start the virtual machine. +// +#define STATUS_VID_SAVED_STATE_CORRUPT ((NTSTATUS)0xC0370027L) + +// +// MessageId: STATUS_VID_SAVED_STATE_UNRECOGNIZED_ITEM +// +// MessageText: +// +// Cannot restore this virtual machine because an item read from the saved state data is not recognized. Delete the saved state data and then try to start the virtual machine. +// +#define STATUS_VID_SAVED_STATE_UNRECOGNIZED_ITEM ((NTSTATUS)0xC0370028L) + +// +// MessageId: STATUS_VID_SAVED_STATE_INCOMPATIBLE +// +// MessageText: +// +// Cannot restore this virtual machine to the saved state because of hypervisor incompatibility. Delete the saved state data and then try to start the virtual machine. +// +#define STATUS_VID_SAVED_STATE_INCOMPATIBLE ((NTSTATUS)0xC0370029L) + +// +// MessageId: STATUS_VID_VTL_ACCESS_DENIED +// +// MessageText: +// +// The specified VTL does not have the permission to access the resource. +// +#define STATUS_VID_VTL_ACCESS_DENIED ((NTSTATUS)0xC037002AL) + +// +// MessageId: STATUS_VID_INSUFFICIENT_RESOURCES_RESERVE +// +// MessageText: +// +// Failed to allocate backing memory due to insufficient memory resources. +// +#define STATUS_VID_INSUFFICIENT_RESOURCES_RESERVE ((NTSTATUS)0xC037002BL) + +// +// MessageId: STATUS_VID_INSUFFICIENT_RESOURCES_PHYSICAL_BUFFER +// +// MessageText: +// +// Failed to allocate memory for the physical buffer used to back certain internal structures. +// +#define STATUS_VID_INSUFFICIENT_RESOURCES_PHYSICAL_BUFFER ((NTSTATUS)0xC037002CL) + +// +// MessageId: STATUS_VID_INSUFFICIENT_RESOURCES_HV_DEPOSIT +// +// MessageText: +// +// Failed to allocate memory to be deposited in the hypervisor. +// +#define STATUS_VID_INSUFFICIENT_RESOURCES_HV_DEPOSIT ((NTSTATUS)0xC037002DL) + +// +// MessageId: STATUS_VID_MEMORY_TYPE_NOT_SUPPORTED +// +// MessageText: +// +// Memory type not supported for requested operation. +// +#define STATUS_VID_MEMORY_TYPE_NOT_SUPPORTED ((NTSTATUS)0xC037002EL) + +// +// MessageId: STATUS_VID_INSUFFICIENT_RESOURCES_WITHDRAW +// +// MessageText: +// +// Failed to withdraw memory. +// +#define STATUS_VID_INSUFFICIENT_RESOURCES_WITHDRAW ((NTSTATUS)0xC037002FL) + +// +// MessageId: STATUS_VID_PROCESS_ALREADY_SET +// +// MessageText: +// +// The process has already been set. +// +#define STATUS_VID_PROCESS_ALREADY_SET ((NTSTATUS)0xC0370030L) + + +// +// DM / Resize related error codes (0x0600-0x06ff) +// + +// +// MessageId: STATUS_DM_OPERATION_LIMIT_EXCEEDED +// +// MessageText: +// +// The attempted DM / resize operation exceeds the supported size. +// +#define STATUS_DM_OPERATION_LIMIT_EXCEEDED ((NTSTATUS)0xC0370600L) + +// +// Warnings: +// +// +// MessageId: STATUS_VID_REMOTE_NODE_PARENT_GPA_PAGES_USED +// +// MessageText: +// +// A virtual machine is running with its memory allocated across multiple NUMA nodes. This does not indicate a problem unless the performance of your virtual machine is unusually slow. If you are experiencing performance problems, you may need to modify the NUMA configuration. +// +#define STATUS_VID_REMOTE_NODE_PARENT_GPA_PAGES_USED ((NTSTATUS)0x80370001L) + + +// +// IPSEC error codes (tcpip.sys) +// + +// +// MessageId: STATUS_IPSEC_BAD_SPI +// +// MessageText: +// +// The SPI in the packet does not match a valid IPsec SA. +// +#define STATUS_IPSEC_BAD_SPI ((NTSTATUS)0xC0360001L) + +// +// MessageId: STATUS_IPSEC_SA_LIFETIME_EXPIRED +// +// MessageText: +// +// Packet was received on an IPsec SA whose lifetime has expired. +// +#define STATUS_IPSEC_SA_LIFETIME_EXPIRED ((NTSTATUS)0xC0360002L) + +// +// MessageId: STATUS_IPSEC_WRONG_SA +// +// MessageText: +// +// Packet was received on an IPsec SA that does not match the packet characteristics. +// +#define STATUS_IPSEC_WRONG_SA ((NTSTATUS)0xC0360003L) + +// +// MessageId: STATUS_IPSEC_REPLAY_CHECK_FAILED +// +// MessageText: +// +// Packet sequence number replay check failed. +// +#define STATUS_IPSEC_REPLAY_CHECK_FAILED ((NTSTATUS)0xC0360004L) + +// +// MessageId: STATUS_IPSEC_INVALID_PACKET +// +// MessageText: +// +// IPsec header and/or trailer in the packet is invalid. +// +#define STATUS_IPSEC_INVALID_PACKET ((NTSTATUS)0xC0360005L) + +// +// MessageId: STATUS_IPSEC_INTEGRITY_CHECK_FAILED +// +// MessageText: +// +// IPsec integrity check failed. +// +#define STATUS_IPSEC_INTEGRITY_CHECK_FAILED ((NTSTATUS)0xC0360006L) + +// +// MessageId: STATUS_IPSEC_CLEAR_TEXT_DROP +// +// MessageText: +// +// IPsec dropped a clear text packet. +// +#define STATUS_IPSEC_CLEAR_TEXT_DROP ((NTSTATUS)0xC0360007L) + +// +// MessageId: STATUS_IPSEC_AUTH_FIREWALL_DROP +// +// MessageText: +// +// IPsec dropped an incoming ESP packet in authenticated firewall mode. This drop is benign. +// +#define STATUS_IPSEC_AUTH_FIREWALL_DROP ((NTSTATUS)0xC0360008L) + +// +// MessageId: STATUS_IPSEC_THROTTLE_DROP +// +// MessageText: +// +// IPsec dropped a packet due to DoS throttling. +// +#define STATUS_IPSEC_THROTTLE_DROP ((NTSTATUS)0xC0360009L) + +// +// MessageId: STATUS_IPSEC_DOSP_BLOCK +// +// MessageText: +// +// IPsec DoS Protection matched an explicit block rule. +// +#define STATUS_IPSEC_DOSP_BLOCK ((NTSTATUS)0xC0368000L) + +// +// MessageId: STATUS_IPSEC_DOSP_RECEIVED_MULTICAST +// +// MessageText: +// +// IPsec DoS Protection received an IPsec specific multicast packet which is not allowed. +// +#define STATUS_IPSEC_DOSP_RECEIVED_MULTICAST ((NTSTATUS)0xC0368001L) + +// +// MessageId: STATUS_IPSEC_DOSP_INVALID_PACKET +// +// MessageText: +// +// IPsec DoS Protection received an incorrectly formatted packet. +// +#define STATUS_IPSEC_DOSP_INVALID_PACKET ((NTSTATUS)0xC0368002L) + +// +// MessageId: STATUS_IPSEC_DOSP_STATE_LOOKUP_FAILED +// +// MessageText: +// +// IPsec DoS Protection failed to look up state. +// +#define STATUS_IPSEC_DOSP_STATE_LOOKUP_FAILED ((NTSTATUS)0xC0368003L) + +// +// MessageId: STATUS_IPSEC_DOSP_MAX_ENTRIES +// +// MessageText: +// +// IPsec DoS Protection failed to create state because the maximum number of entries allowed by policy has been reached. +// +#define STATUS_IPSEC_DOSP_MAX_ENTRIES ((NTSTATUS)0xC0368004L) + +// +// MessageId: STATUS_IPSEC_DOSP_KEYMOD_NOT_ALLOWED +// +// MessageText: +// +// IPsec DoS Protection received an IPsec negotiation packet for a keying module which is not allowed by policy. +// +#define STATUS_IPSEC_DOSP_KEYMOD_NOT_ALLOWED ((NTSTATUS)0xC0368005L) + +// +// MessageId: STATUS_IPSEC_DOSP_MAX_PER_IP_RATELIMIT_QUEUES +// +// MessageText: +// +// IPsec DoS Protection failed to create a per internal IP rate limit queue because the maximum number of queues allowed by policy has been reached. +// +#define STATUS_IPSEC_DOSP_MAX_PER_IP_RATELIMIT_QUEUES ((NTSTATUS)0xC0368006L) + + +// +// Volume manager status codes (volmgr.sys and volmgrx.sys) +// + +// +// WARNINGS +// +// +// MessageId: STATUS_VOLMGR_INCOMPLETE_REGENERATION +// +// MessageText: +// +// The regeneration operation was not able to copy all data from the active plexes due to bad sectors. +// +#define STATUS_VOLMGR_INCOMPLETE_REGENERATION ((NTSTATUS)0x80380001L) + +// +// MessageId: STATUS_VOLMGR_INCOMPLETE_DISK_MIGRATION +// +// MessageText: +// +// One or more disks were not fully migrated to the target pack. They may or may not require reimport after fixing the hardware problems. +// +#define STATUS_VOLMGR_INCOMPLETE_DISK_MIGRATION ((NTSTATUS)0x80380002L) + +// +// ERRORS +// +// +// MessageId: STATUS_VOLMGR_DATABASE_FULL +// +// MessageText: +// +// The configuration database is full. +// +#define STATUS_VOLMGR_DATABASE_FULL ((NTSTATUS)0xC0380001L) + +// +// MessageId: STATUS_VOLMGR_DISK_CONFIGURATION_CORRUPTED +// +// MessageText: +// +// The configuration data on the disk is corrupted. +// +#define STATUS_VOLMGR_DISK_CONFIGURATION_CORRUPTED ((NTSTATUS)0xC0380002L) + +// +// MessageId: STATUS_VOLMGR_DISK_CONFIGURATION_NOT_IN_SYNC +// +// MessageText: +// +// The configuration on the disk is not insync with the in-memory configuration. +// +#define STATUS_VOLMGR_DISK_CONFIGURATION_NOT_IN_SYNC ((NTSTATUS)0xC0380003L) + +// +// MessageId: STATUS_VOLMGR_PACK_CONFIG_UPDATE_FAILED +// +// MessageText: +// +// A majority of disks failed to be updated with the new configuration. +// +#define STATUS_VOLMGR_PACK_CONFIG_UPDATE_FAILED ((NTSTATUS)0xC0380004L) + +// +// MessageId: STATUS_VOLMGR_DISK_CONTAINS_NON_SIMPLE_VOLUME +// +// MessageText: +// +// The disk contains non-simple volumes. +// +#define STATUS_VOLMGR_DISK_CONTAINS_NON_SIMPLE_VOLUME ((NTSTATUS)0xC0380005L) + +// +// MessageId: STATUS_VOLMGR_DISK_DUPLICATE +// +// MessageText: +// +// The same disk was specified more than once in the migration list. +// +#define STATUS_VOLMGR_DISK_DUPLICATE ((NTSTATUS)0xC0380006L) + +// +// MessageId: STATUS_VOLMGR_DISK_DYNAMIC +// +// MessageText: +// +// The disk is already dynamic. +// +#define STATUS_VOLMGR_DISK_DYNAMIC ((NTSTATUS)0xC0380007L) + +// +// MessageId: STATUS_VOLMGR_DISK_ID_INVALID +// +// MessageText: +// +// The specified disk id is invalid. There are no disks with the specified disk id. +// +#define STATUS_VOLMGR_DISK_ID_INVALID ((NTSTATUS)0xC0380008L) + +// +// MessageId: STATUS_VOLMGR_DISK_INVALID +// +// MessageText: +// +// The specified disk is an invalid disk. Operation cannot complete on an invalid disk. +// +#define STATUS_VOLMGR_DISK_INVALID ((NTSTATUS)0xC0380009L) + +// +// MessageId: STATUS_VOLMGR_DISK_LAST_VOTER +// +// MessageText: +// +// The specified disk(s) cannot be removed since it is the last remaining voter. +// +#define STATUS_VOLMGR_DISK_LAST_VOTER ((NTSTATUS)0xC038000AL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_INVALID +// +// MessageText: +// +// The specified disk has an invalid disk layout. +// +#define STATUS_VOLMGR_DISK_LAYOUT_INVALID ((NTSTATUS)0xC038000BL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_NON_BASIC_BETWEEN_BASIC_PARTITIONS +// +// MessageText: +// +// The disk layout contains non-basic partitions which appear after basic partitions. This is an invalid disk layout. +// +#define STATUS_VOLMGR_DISK_LAYOUT_NON_BASIC_BETWEEN_BASIC_PARTITIONS ((NTSTATUS)0xC038000CL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_NOT_CYLINDER_ALIGNED +// +// MessageText: +// +// The disk layout contains partitions which are not cylinder aligned. +// +#define STATUS_VOLMGR_DISK_LAYOUT_NOT_CYLINDER_ALIGNED ((NTSTATUS)0xC038000DL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_PARTITIONS_TOO_SMALL +// +// MessageText: +// +// The disk layout contains partitions which are smaller than the minimum size. +// +#define STATUS_VOLMGR_DISK_LAYOUT_PARTITIONS_TOO_SMALL ((NTSTATUS)0xC038000EL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_PRIMARY_BETWEEN_LOGICAL_PARTITIONS +// +// MessageText: +// +// The disk layout contains primary partitions in between logical drives. This is an invalid disk layout. +// +#define STATUS_VOLMGR_DISK_LAYOUT_PRIMARY_BETWEEN_LOGICAL_PARTITIONS ((NTSTATUS)0xC038000FL) + +// +// MessageId: STATUS_VOLMGR_DISK_LAYOUT_TOO_MANY_PARTITIONS +// +// MessageText: +// +// The disk layout contains more than the maximum number of supported partitions. +// +#define STATUS_VOLMGR_DISK_LAYOUT_TOO_MANY_PARTITIONS ((NTSTATUS)0xC0380010L) + +// +// MessageId: STATUS_VOLMGR_DISK_MISSING +// +// MessageText: +// +// The specified disk is missing. The operation cannot complete on a missing disk. +// +#define STATUS_VOLMGR_DISK_MISSING ((NTSTATUS)0xC0380011L) + +// +// MessageId: STATUS_VOLMGR_DISK_NOT_EMPTY +// +// MessageText: +// +// The specified disk is not empty. +// +#define STATUS_VOLMGR_DISK_NOT_EMPTY ((NTSTATUS)0xC0380012L) + +// +// MessageId: STATUS_VOLMGR_DISK_NOT_ENOUGH_SPACE +// +// MessageText: +// +// There is not enough usable space for this operation. +// +#define STATUS_VOLMGR_DISK_NOT_ENOUGH_SPACE ((NTSTATUS)0xC0380013L) + +// +// MessageId: STATUS_VOLMGR_DISK_REVECTORING_FAILED +// +// MessageText: +// +// The force revectoring of bad sectors failed. +// +#define STATUS_VOLMGR_DISK_REVECTORING_FAILED ((NTSTATUS)0xC0380014L) + +// +// MessageId: STATUS_VOLMGR_DISK_SECTOR_SIZE_INVALID +// +// MessageText: +// +// The specified disk has an invalid sector size. +// +#define STATUS_VOLMGR_DISK_SECTOR_SIZE_INVALID ((NTSTATUS)0xC0380015L) + +// +// MessageId: STATUS_VOLMGR_DISK_SET_NOT_CONTAINED +// +// MessageText: +// +// The specified disk set contains volumes which exist on disks outside of the set. +// +#define STATUS_VOLMGR_DISK_SET_NOT_CONTAINED ((NTSTATUS)0xC0380016L) + +// +// MessageId: STATUS_VOLMGR_DISK_USED_BY_MULTIPLE_MEMBERS +// +// MessageText: +// +// A disk in the volume layout provides extents to more than one member of a plex. +// +#define STATUS_VOLMGR_DISK_USED_BY_MULTIPLE_MEMBERS ((NTSTATUS)0xC0380017L) + +// +// MessageId: STATUS_VOLMGR_DISK_USED_BY_MULTIPLE_PLEXES +// +// MessageText: +// +// A disk in the volume layout provides extents to more than one plex. +// +#define STATUS_VOLMGR_DISK_USED_BY_MULTIPLE_PLEXES ((NTSTATUS)0xC0380018L) + +// +// MessageId: STATUS_VOLMGR_DYNAMIC_DISK_NOT_SUPPORTED +// +// MessageText: +// +// Dynamic disks are not supported on this system. +// +#define STATUS_VOLMGR_DYNAMIC_DISK_NOT_SUPPORTED ((NTSTATUS)0xC0380019L) + +// +// MessageId: STATUS_VOLMGR_EXTENT_ALREADY_USED +// +// MessageText: +// +// The specified extent is already used by other volumes. +// +#define STATUS_VOLMGR_EXTENT_ALREADY_USED ((NTSTATUS)0xC038001AL) + +// +// MessageId: STATUS_VOLMGR_EXTENT_NOT_CONTIGUOUS +// +// MessageText: +// +// The specified volume is retained and can only be extended into a contiguous extent. The specified extent to grow the volume is not contiguous with the specified volume. +// +#define STATUS_VOLMGR_EXTENT_NOT_CONTIGUOUS ((NTSTATUS)0xC038001BL) + +// +// MessageId: STATUS_VOLMGR_EXTENT_NOT_IN_PUBLIC_REGION +// +// MessageText: +// +// The specified volume extent is not within the public region of the disk. +// +#define STATUS_VOLMGR_EXTENT_NOT_IN_PUBLIC_REGION ((NTSTATUS)0xC038001CL) + +// +// MessageId: STATUS_VOLMGR_EXTENT_NOT_SECTOR_ALIGNED +// +// MessageText: +// +// The specified volume extent is not sector aligned. +// +#define STATUS_VOLMGR_EXTENT_NOT_SECTOR_ALIGNED ((NTSTATUS)0xC038001DL) + +// +// MessageId: STATUS_VOLMGR_EXTENT_OVERLAPS_EBR_PARTITION +// +// MessageText: +// +// The specified partition overlaps an EBR (the first track of an extended partition on a MBR disks). +// +#define STATUS_VOLMGR_EXTENT_OVERLAPS_EBR_PARTITION ((NTSTATUS)0xC038001EL) + +// +// MessageId: STATUS_VOLMGR_EXTENT_VOLUME_LENGTHS_DO_NOT_MATCH +// +// MessageText: +// +// The specified extent lengths cannot be used to construct a volume with specified length. +// +#define STATUS_VOLMGR_EXTENT_VOLUME_LENGTHS_DO_NOT_MATCH ((NTSTATUS)0xC038001FL) + +// +// MessageId: STATUS_VOLMGR_FAULT_TOLERANT_NOT_SUPPORTED +// +// MessageText: +// +// The system does not support fault tolerant volumes. +// +#define STATUS_VOLMGR_FAULT_TOLERANT_NOT_SUPPORTED ((NTSTATUS)0xC0380020L) + +// +// MessageId: STATUS_VOLMGR_INTERLEAVE_LENGTH_INVALID +// +// MessageText: +// +// The specified interleave length is invalid. +// +#define STATUS_VOLMGR_INTERLEAVE_LENGTH_INVALID ((NTSTATUS)0xC0380021L) + +// +// MessageId: STATUS_VOLMGR_MAXIMUM_REGISTERED_USERS +// +// MessageText: +// +// There is already a maximum number of registered users. +// +#define STATUS_VOLMGR_MAXIMUM_REGISTERED_USERS ((NTSTATUS)0xC0380022L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_IN_SYNC +// +// MessageText: +// +// The specified member is already in-sync with the other active members. It does not need to be regenerated. +// +#define STATUS_VOLMGR_MEMBER_IN_SYNC ((NTSTATUS)0xC0380023L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_INDEX_DUPLICATE +// +// MessageText: +// +// The same member index was specified more than once. +// +#define STATUS_VOLMGR_MEMBER_INDEX_DUPLICATE ((NTSTATUS)0xC0380024L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_INDEX_INVALID +// +// MessageText: +// +// The specified member index is greater or equal than the number of members in the volume plex. +// +#define STATUS_VOLMGR_MEMBER_INDEX_INVALID ((NTSTATUS)0xC0380025L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_MISSING +// +// MessageText: +// +// The specified member is missing. It cannot be regenerated. +// +#define STATUS_VOLMGR_MEMBER_MISSING ((NTSTATUS)0xC0380026L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_NOT_DETACHED +// +// MessageText: +// +// The specified member is not detached. Cannot replace a member which is not detached. +// +#define STATUS_VOLMGR_MEMBER_NOT_DETACHED ((NTSTATUS)0xC0380027L) + +// +// MessageId: STATUS_VOLMGR_MEMBER_REGENERATING +// +// MessageText: +// +// The specified member is already regenerating. +// +#define STATUS_VOLMGR_MEMBER_REGENERATING ((NTSTATUS)0xC0380028L) + +// +// MessageId: STATUS_VOLMGR_ALL_DISKS_FAILED +// +// MessageText: +// +// All disks belonging to the pack failed. +// +#define STATUS_VOLMGR_ALL_DISKS_FAILED ((NTSTATUS)0xC0380029L) + +// +// MessageId: STATUS_VOLMGR_NO_REGISTERED_USERS +// +// MessageText: +// +// There are currently no registered users for notifications. The task number is irrelevant unless there are registered users. +// +#define STATUS_VOLMGR_NO_REGISTERED_USERS ((NTSTATUS)0xC038002AL) + +// +// MessageId: STATUS_VOLMGR_NO_SUCH_USER +// +// MessageText: +// +// The specified notification user does not exist. Failed to unregister user for notifications. +// +#define STATUS_VOLMGR_NO_SUCH_USER ((NTSTATUS)0xC038002BL) + +// +// MessageId: STATUS_VOLMGR_NOTIFICATION_RESET +// +// MessageText: +// +// The notifications have been reset. Notifications for the current user are invalid. Unregister and re-register for notifications. +// +#define STATUS_VOLMGR_NOTIFICATION_RESET ((NTSTATUS)0xC038002CL) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_MEMBERS_INVALID +// +// MessageText: +// +// The specified number of members is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_MEMBERS_INVALID ((NTSTATUS)0xC038002DL) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_PLEXES_INVALID +// +// MessageText: +// +// The specified number of plexes is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_PLEXES_INVALID ((NTSTATUS)0xC038002EL) + +// +// MessageId: STATUS_VOLMGR_PACK_DUPLICATE +// +// MessageText: +// +// The specified source and target packs are identical. +// +#define STATUS_VOLMGR_PACK_DUPLICATE ((NTSTATUS)0xC038002FL) + +// +// MessageId: STATUS_VOLMGR_PACK_ID_INVALID +// +// MessageText: +// +// The specified pack id is invalid. There are no packs with the specified pack id. +// +#define STATUS_VOLMGR_PACK_ID_INVALID ((NTSTATUS)0xC0380030L) + +// +// MessageId: STATUS_VOLMGR_PACK_INVALID +// +// MessageText: +// +// The specified pack is the invalid pack. The operation cannot complete with the invalid pack. +// +#define STATUS_VOLMGR_PACK_INVALID ((NTSTATUS)0xC0380031L) + +// +// MessageId: STATUS_VOLMGR_PACK_NAME_INVALID +// +// MessageText: +// +// The specified pack name is invalid. +// +#define STATUS_VOLMGR_PACK_NAME_INVALID ((NTSTATUS)0xC0380032L) + +// +// MessageId: STATUS_VOLMGR_PACK_OFFLINE +// +// MessageText: +// +// The specified pack is offline. +// +#define STATUS_VOLMGR_PACK_OFFLINE ((NTSTATUS)0xC0380033L) + +// +// MessageId: STATUS_VOLMGR_PACK_HAS_QUORUM +// +// MessageText: +// +// The specified pack already has a quorum of healthy disks. +// +#define STATUS_VOLMGR_PACK_HAS_QUORUM ((NTSTATUS)0xC0380034L) + +// +// MessageId: STATUS_VOLMGR_PACK_WITHOUT_QUORUM +// +// MessageText: +// +// The pack does not have a quorum of healthy disks. +// +#define STATUS_VOLMGR_PACK_WITHOUT_QUORUM ((NTSTATUS)0xC0380035L) + +// +// MessageId: STATUS_VOLMGR_PARTITION_STYLE_INVALID +// +// MessageText: +// +// The specified disk has an unsupported partition style. Only MBR and GPT partition styles are supported. +// +#define STATUS_VOLMGR_PARTITION_STYLE_INVALID ((NTSTATUS)0xC0380036L) + +// +// MessageId: STATUS_VOLMGR_PARTITION_UPDATE_FAILED +// +// MessageText: +// +// Failed to update the disk's partition layout. +// +#define STATUS_VOLMGR_PARTITION_UPDATE_FAILED ((NTSTATUS)0xC0380037L) + +// +// MessageId: STATUS_VOLMGR_PLEX_IN_SYNC +// +// MessageText: +// +// The specified plex is already in-sync with the other active plexes. It does not need to be regenerated. +// +#define STATUS_VOLMGR_PLEX_IN_SYNC ((NTSTATUS)0xC0380038L) + +// +// MessageId: STATUS_VOLMGR_PLEX_INDEX_DUPLICATE +// +// MessageText: +// +// The same plex index was specified more than once. +// +#define STATUS_VOLMGR_PLEX_INDEX_DUPLICATE ((NTSTATUS)0xC0380039L) + +// +// MessageId: STATUS_VOLMGR_PLEX_INDEX_INVALID +// +// MessageText: +// +// The specified plex index is greater or equal than the number of plexes in the volume. +// +#define STATUS_VOLMGR_PLEX_INDEX_INVALID ((NTSTATUS)0xC038003AL) + +// +// MessageId: STATUS_VOLMGR_PLEX_LAST_ACTIVE +// +// MessageText: +// +// The specified plex is the last active plex in the volume. The plex cannot be removed or else the volume will go offline. +// +#define STATUS_VOLMGR_PLEX_LAST_ACTIVE ((NTSTATUS)0xC038003BL) + +// +// MessageId: STATUS_VOLMGR_PLEX_MISSING +// +// MessageText: +// +// The specified plex is missing. +// +#define STATUS_VOLMGR_PLEX_MISSING ((NTSTATUS)0xC038003CL) + +// +// MessageId: STATUS_VOLMGR_PLEX_REGENERATING +// +// MessageText: +// +// The specified plex is currently regenerating. +// +#define STATUS_VOLMGR_PLEX_REGENERATING ((NTSTATUS)0xC038003DL) + +// +// MessageId: STATUS_VOLMGR_PLEX_TYPE_INVALID +// +// MessageText: +// +// The specified plex type is invalid. +// +#define STATUS_VOLMGR_PLEX_TYPE_INVALID ((NTSTATUS)0xC038003EL) + +// +// MessageId: STATUS_VOLMGR_PLEX_NOT_RAID5 +// +// MessageText: +// +// The operation is only supported on RAID-5 plexes. +// +#define STATUS_VOLMGR_PLEX_NOT_RAID5 ((NTSTATUS)0xC038003FL) + +// +// MessageId: STATUS_VOLMGR_PLEX_NOT_SIMPLE +// +// MessageText: +// +// The operation is only supported on simple plexes. +// +#define STATUS_VOLMGR_PLEX_NOT_SIMPLE ((NTSTATUS)0xC0380040L) + +// +// MessageId: STATUS_VOLMGR_STRUCTURE_SIZE_INVALID +// +// MessageText: +// +// The Size fields in the VM_VOLUME_LAYOUT input structure are incorrectly set. +// +#define STATUS_VOLMGR_STRUCTURE_SIZE_INVALID ((NTSTATUS)0xC0380041L) + +// +// MessageId: STATUS_VOLMGR_TOO_MANY_NOTIFICATION_REQUESTS +// +// MessageText: +// +// There is already a pending request for notifications. Wait for the existing request to return before requesting for more notifications. +// +#define STATUS_VOLMGR_TOO_MANY_NOTIFICATION_REQUESTS ((NTSTATUS)0xC0380042L) + +// +// MessageId: STATUS_VOLMGR_TRANSACTION_IN_PROGRESS +// +// MessageText: +// +// There is currently a transaction in process. +// +#define STATUS_VOLMGR_TRANSACTION_IN_PROGRESS ((NTSTATUS)0xC0380043L) + +// +// MessageId: STATUS_VOLMGR_UNEXPECTED_DISK_LAYOUT_CHANGE +// +// MessageText: +// +// An unexpected layout change occurred outside of the volume manager. +// +#define STATUS_VOLMGR_UNEXPECTED_DISK_LAYOUT_CHANGE ((NTSTATUS)0xC0380044L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_CONTAINS_MISSING_DISK +// +// MessageText: +// +// The specified volume contains a missing disk. +// +#define STATUS_VOLMGR_VOLUME_CONTAINS_MISSING_DISK ((NTSTATUS)0xC0380045L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_ID_INVALID +// +// MessageText: +// +// The specified volume id is invalid. There are no volumes with the specified volume id. +// +#define STATUS_VOLMGR_VOLUME_ID_INVALID ((NTSTATUS)0xC0380046L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_LENGTH_INVALID +// +// MessageText: +// +// The specified volume length is invalid. +// +#define STATUS_VOLMGR_VOLUME_LENGTH_INVALID ((NTSTATUS)0xC0380047L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_LENGTH_NOT_SECTOR_SIZE_MULTIPLE +// +// MessageText: +// +// The specified size for the volume is not a multiple of the sector size. +// +#define STATUS_VOLMGR_VOLUME_LENGTH_NOT_SECTOR_SIZE_MULTIPLE ((NTSTATUS)0xC0380048L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_NOT_MIRRORED +// +// MessageText: +// +// The operation is only supported on mirrored volumes. +// +#define STATUS_VOLMGR_VOLUME_NOT_MIRRORED ((NTSTATUS)0xC0380049L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_NOT_RETAINED +// +// MessageText: +// +// The specified volume does not have a retain partition. +// +#define STATUS_VOLMGR_VOLUME_NOT_RETAINED ((NTSTATUS)0xC038004AL) + +// +// MessageId: STATUS_VOLMGR_VOLUME_OFFLINE +// +// MessageText: +// +// The specified volume is offline. +// +#define STATUS_VOLMGR_VOLUME_OFFLINE ((NTSTATUS)0xC038004BL) + +// +// MessageId: STATUS_VOLMGR_VOLUME_RETAINED +// +// MessageText: +// +// The specified volume already has a retain partition. +// +#define STATUS_VOLMGR_VOLUME_RETAINED ((NTSTATUS)0xC038004CL) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_EXTENTS_INVALID +// +// MessageText: +// +// The specified number of extents is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_EXTENTS_INVALID ((NTSTATUS)0xC038004DL) + +// +// MessageId: STATUS_VOLMGR_DIFFERENT_SECTOR_SIZE +// +// MessageText: +// +// All disks participating to the volume must have the same sector size. +// +#define STATUS_VOLMGR_DIFFERENT_SECTOR_SIZE ((NTSTATUS)0xC038004EL) + +// +// MessageId: STATUS_VOLMGR_BAD_BOOT_DISK +// +// MessageText: +// +// The boot disk experienced failures. +// +#define STATUS_VOLMGR_BAD_BOOT_DISK ((NTSTATUS)0xC038004FL) + +// +// MessageId: STATUS_VOLMGR_PACK_CONFIG_OFFLINE +// +// MessageText: +// +// The configuration of the pack is offline. +// +#define STATUS_VOLMGR_PACK_CONFIG_OFFLINE ((NTSTATUS)0xC0380050L) + +// +// MessageId: STATUS_VOLMGR_PACK_CONFIG_ONLINE +// +// MessageText: +// +// The configuration of the pack is online. +// +#define STATUS_VOLMGR_PACK_CONFIG_ONLINE ((NTSTATUS)0xC0380051L) + +// +// MessageId: STATUS_VOLMGR_NOT_PRIMARY_PACK +// +// MessageText: +// +// The specified pack is not the primary pack. +// +#define STATUS_VOLMGR_NOT_PRIMARY_PACK ((NTSTATUS)0xC0380052L) + +// +// MessageId: STATUS_VOLMGR_PACK_LOG_UPDATE_FAILED +// +// MessageText: +// +// All disks failed to be updated with the new content of the log. +// +#define STATUS_VOLMGR_PACK_LOG_UPDATE_FAILED ((NTSTATUS)0xC0380053L) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_DISKS_IN_PLEX_INVALID +// +// MessageText: +// +// The specified number of disks in a plex is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_DISKS_IN_PLEX_INVALID ((NTSTATUS)0xC0380054L) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_DISKS_IN_MEMBER_INVALID +// +// MessageText: +// +// The specified number of disks in a plex member is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_DISKS_IN_MEMBER_INVALID ((NTSTATUS)0xC0380055L) + +// +// MessageId: STATUS_VOLMGR_VOLUME_MIRRORED +// +// MessageText: +// +// The operation is not supported on mirrored volumes. +// +#define STATUS_VOLMGR_VOLUME_MIRRORED ((NTSTATUS)0xC0380056L) + +// +// MessageId: STATUS_VOLMGR_PLEX_NOT_SIMPLE_SPANNED +// +// MessageText: +// +// The operation is only supported on simple and spanned plexes. +// +#define STATUS_VOLMGR_PLEX_NOT_SIMPLE_SPANNED ((NTSTATUS)0xC0380057L) + +// +// MessageId: STATUS_VOLMGR_NO_VALID_LOG_COPIES +// +// MessageText: +// +// The pack has no valid log copies. +// +#define STATUS_VOLMGR_NO_VALID_LOG_COPIES ((NTSTATUS)0xC0380058L) + +// +// MessageId: STATUS_VOLMGR_PRIMARY_PACK_PRESENT +// +// MessageText: +// +// A primary pack is already present. +// +#define STATUS_VOLMGR_PRIMARY_PACK_PRESENT ((NTSTATUS)0xC0380059L) + +// +// MessageId: STATUS_VOLMGR_NUMBER_OF_DISKS_INVALID +// +// MessageText: +// +// The specified number of disks is invalid. +// +#define STATUS_VOLMGR_NUMBER_OF_DISKS_INVALID ((NTSTATUS)0xC038005AL) + +// +// MessageId: STATUS_VOLMGR_MIRROR_NOT_SUPPORTED +// +// MessageText: +// +// The system does not support mirrored volumes. +// +#define STATUS_VOLMGR_MIRROR_NOT_SUPPORTED ((NTSTATUS)0xC038005BL) + +// +// MessageId: STATUS_VOLMGR_RAID5_NOT_SUPPORTED +// +// MessageText: +// +// The system does not support RAID-5 volumes. +// +#define STATUS_VOLMGR_RAID5_NOT_SUPPORTED ((NTSTATUS)0xC038005CL) + +// +// Boot Code Data (BCD) status codes +// + +// +// MessageId: STATUS_BCD_NOT_ALL_ENTRIES_IMPORTED +// +// MessageText: +// +// Some BCD entries were not imported correctly from the BCD store. +// +#define STATUS_BCD_NOT_ALL_ENTRIES_IMPORTED ((NTSTATUS)0x80390001L) + +// +// MessageId: STATUS_BCD_TOO_MANY_ELEMENTS +// +// MessageText: +// +// Entries enumerated have exceeded the allowed threshold. +// +#define STATUS_BCD_TOO_MANY_ELEMENTS ((NTSTATUS)0xC0390002L) + +// +// MessageId: STATUS_BCD_NOT_ALL_ENTRIES_SYNCHRONIZED +// +// MessageText: +// +// Some BCD entries were not synchronized correctly with the firmware. +// +#define STATUS_BCD_NOT_ALL_ENTRIES_SYNCHRONIZED ((NTSTATUS)0x80390003L) + + +// +// vhdparser error codes (vhdmp.sys) +// + +// +// MessageId: STATUS_VHD_DRIVE_FOOTER_MISSING +// +// MessageText: +// +// The virtual hard disk is corrupted. The virtual hard disk drive footer is missing. +// +#define STATUS_VHD_DRIVE_FOOTER_MISSING ((NTSTATUS)0xC03A0001L) + +// +// MessageId: STATUS_VHD_DRIVE_FOOTER_CHECKSUM_MISMATCH +// +// MessageText: +// +// The virtual hard disk is corrupted. The virtual hard disk drive footer checksum does not match the on-disk checksum. +// +#define STATUS_VHD_DRIVE_FOOTER_CHECKSUM_MISMATCH ((NTSTATUS)0xC03A0002L) + +// +// MessageId: STATUS_VHD_DRIVE_FOOTER_CORRUPT +// +// MessageText: +// +// The virtual hard disk is corrupted. The virtual hard disk drive footer in the virtual hard disk is corrupted. +// +#define STATUS_VHD_DRIVE_FOOTER_CORRUPT ((NTSTATUS)0xC03A0003L) + +// +// MessageId: STATUS_VHD_FORMAT_UNKNOWN +// +// MessageText: +// +// The system does not recognize the file format of this virtual hard disk. +// +#define STATUS_VHD_FORMAT_UNKNOWN ((NTSTATUS)0xC03A0004L) + +// +// MessageId: STATUS_VHD_FORMAT_UNSUPPORTED_VERSION +// +// MessageText: +// +// The version does not support this version of the file format. +// +#define STATUS_VHD_FORMAT_UNSUPPORTED_VERSION ((NTSTATUS)0xC03A0005L) + +// +// MessageId: STATUS_VHD_SPARSE_HEADER_CHECKSUM_MISMATCH +// +// MessageText: +// +// The virtual hard disk is corrupted. The sparse header checksum does not match the on-disk checksum. +// +#define STATUS_VHD_SPARSE_HEADER_CHECKSUM_MISMATCH ((NTSTATUS)0xC03A0006L) + +// +// MessageId: STATUS_VHD_SPARSE_HEADER_UNSUPPORTED_VERSION +// +// MessageText: +// +// The system does not support this version of the virtual hard disk.This version of the sparse header is not supported. +// +#define STATUS_VHD_SPARSE_HEADER_UNSUPPORTED_VERSION ((NTSTATUS)0xC03A0007L) + +// +// MessageId: STATUS_VHD_SPARSE_HEADER_CORRUPT +// +// MessageText: +// +// The virtual hard disk is corrupted. The sparse header in the virtual hard disk is corrupt. +// +#define STATUS_VHD_SPARSE_HEADER_CORRUPT ((NTSTATUS)0xC03A0008L) + +// +// MessageId: STATUS_VHD_BLOCK_ALLOCATION_FAILURE +// +// MessageText: +// +// Failed to write to the virtual hard disk failed because the system failed to allocate a new block in the virtual hard disk. +// +#define STATUS_VHD_BLOCK_ALLOCATION_FAILURE ((NTSTATUS)0xC03A0009L) + +// +// MessageId: STATUS_VHD_BLOCK_ALLOCATION_TABLE_CORRUPT +// +// MessageText: +// +// The virtual hard disk is corrupted. The block allocation table in the virtual hard disk is corrupt. +// +#define STATUS_VHD_BLOCK_ALLOCATION_TABLE_CORRUPT ((NTSTATUS)0xC03A000AL) + +// +// MessageId: STATUS_VHD_INVALID_BLOCK_SIZE +// +// MessageText: +// +// The system does not support this version of the virtual hard disk. The block size is invalid. +// +#define STATUS_VHD_INVALID_BLOCK_SIZE ((NTSTATUS)0xC03A000BL) + +// +// MessageId: STATUS_VHD_BITMAP_MISMATCH +// +// MessageText: +// +// The virtual hard disk is corrupted. The block bitmap does not match with the block data present in the virtual hard disk. +// +#define STATUS_VHD_BITMAP_MISMATCH ((NTSTATUS)0xC03A000CL) + +// +// MessageId: STATUS_VHD_PARENT_VHD_NOT_FOUND +// +// MessageText: +// +// The chain of virtual hard disks is broken. The system cannot locate the parent virtual hard disk for the differencing disk. +// +#define STATUS_VHD_PARENT_VHD_NOT_FOUND ((NTSTATUS)0xC03A000DL) + +// +// MessageId: STATUS_VHD_CHILD_PARENT_ID_MISMATCH +// +// MessageText: +// +// The chain of virtual hard disks is corrupted. There is a mismatch in the identifiers of the parent virtual hard disk and differencing disk. +// +#define STATUS_VHD_CHILD_PARENT_ID_MISMATCH ((NTSTATUS)0xC03A000EL) + +// +// MessageId: STATUS_VHD_CHILD_PARENT_TIMESTAMP_MISMATCH +// +// MessageText: +// +// The chain of virtual hard disks is corrupted. The time stamp of the parent virtual hard disk does not match the time stamp of the differencing disk. +// +#define STATUS_VHD_CHILD_PARENT_TIMESTAMP_MISMATCH ((NTSTATUS)0xC03A000FL) + +// +// MessageId: STATUS_VHD_METADATA_READ_FAILURE +// +// MessageText: +// +// Failed to read the metadata of the virtual hard disk. +// +#define STATUS_VHD_METADATA_READ_FAILURE ((NTSTATUS)0xC03A0010L) + +// +// MessageId: STATUS_VHD_METADATA_WRITE_FAILURE +// +// MessageText: +// +// Failed to write to the metadata of the virtual hard disk. +// +#define STATUS_VHD_METADATA_WRITE_FAILURE ((NTSTATUS)0xC03A0011L) + +// +// MessageId: STATUS_VHD_INVALID_SIZE +// +// MessageText: +// +// The size of the virtual hard disk is not valid. +// +#define STATUS_VHD_INVALID_SIZE ((NTSTATUS)0xC03A0012L) + +// +// MessageId: STATUS_VHD_INVALID_FILE_SIZE +// +// MessageText: +// +// The file size of this virtual hard disk is not valid. +// +#define STATUS_VHD_INVALID_FILE_SIZE ((NTSTATUS)0xC03A0013L) + +// +// MessageId: STATUS_VIRTDISK_PROVIDER_NOT_FOUND +// +// MessageText: +// +// A virtual disk support provider for the specified file was not found. +// +#define STATUS_VIRTDISK_PROVIDER_NOT_FOUND ((NTSTATUS)0xC03A0014L) + +// +// MessageId: STATUS_VIRTDISK_NOT_VIRTUAL_DISK +// +// MessageText: +// +// The specified disk is not a virtual disk. +// +#define STATUS_VIRTDISK_NOT_VIRTUAL_DISK ((NTSTATUS)0xC03A0015L) + +// +// MessageId: STATUS_VHD_PARENT_VHD_ACCESS_DENIED +// +// MessageText: +// +// The chain of virtual hard disks is inaccessible. The process has not been granted access rights to the parent virtual hard disk for the differencing disk. +// +#define STATUS_VHD_PARENT_VHD_ACCESS_DENIED ((NTSTATUS)0xC03A0016L) + +// +// MessageId: STATUS_VHD_CHILD_PARENT_SIZE_MISMATCH +// +// MessageText: +// +// The chain of virtual hard disks is corrupted. There is a mismatch in the virtual sizes of the parent virtual hard disk and differencing disk. +// +#define STATUS_VHD_CHILD_PARENT_SIZE_MISMATCH ((NTSTATUS)0xC03A0017L) + +// +// MessageId: STATUS_VHD_DIFFERENCING_CHAIN_CYCLE_DETECTED +// +// MessageText: +// +// The chain of virtual hard disks is corrupted. A differencing disk is indicated in its own parent chain. +// +#define STATUS_VHD_DIFFERENCING_CHAIN_CYCLE_DETECTED ((NTSTATUS)0xC03A0018L) + +// +// MessageId: STATUS_VHD_DIFFERENCING_CHAIN_ERROR_IN_PARENT +// +// MessageText: +// +// The chain of virtual hard disks is inaccessible. There was an error opening a virtual hard disk further up the chain. +// +#define STATUS_VHD_DIFFERENCING_CHAIN_ERROR_IN_PARENT ((NTSTATUS)0xC03A0019L) + +// +// MessageId: STATUS_VIRTUAL_DISK_LIMITATION +// +// MessageText: +// +// The requested operation could not be completed due to a virtual disk system limitation. Virtual hard disk files must be uncompressed and unencrypted and must not be sparse. +// +#define STATUS_VIRTUAL_DISK_LIMITATION ((NTSTATUS)0xC03A001AL) + +// +// MessageId: STATUS_VHD_INVALID_TYPE +// +// MessageText: +// +// The requested operation cannot be performed on a virtual disk of this type. +// +#define STATUS_VHD_INVALID_TYPE ((NTSTATUS)0xC03A001BL) + +// +// MessageId: STATUS_VHD_INVALID_STATE +// +// MessageText: +// +// The requested operation cannot be performed on the virtual disk in its current state. +// +#define STATUS_VHD_INVALID_STATE ((NTSTATUS)0xC03A001CL) + +// +// MessageId: STATUS_VIRTDISK_UNSUPPORTED_DISK_SECTOR_SIZE +// +// MessageText: +// +// The sector size of the physical disk on which the virtual disk resides is not supported. +// +#define STATUS_VIRTDISK_UNSUPPORTED_DISK_SECTOR_SIZE ((NTSTATUS)0xC03A001DL) + +// +// MessageId: STATUS_VIRTDISK_DISK_ALREADY_OWNED +// +// MessageText: +// +// The disk is already owned by a different owner. +// +#define STATUS_VIRTDISK_DISK_ALREADY_OWNED ((NTSTATUS)0xC03A001EL) + +// +// MessageId: STATUS_VIRTDISK_DISK_ONLINE_AND_WRITABLE +// +// MessageText: +// +// The disk must be offline or read-only. +// +#define STATUS_VIRTDISK_DISK_ONLINE_AND_WRITABLE ((NTSTATUS)0xC03A001FL) + +// +// MessageId: STATUS_CTLOG_TRACKING_NOT_INITIALIZED +// +// MessageText: +// +// Change Tracking is not initialized for this virtual disk. +// +#define STATUS_CTLOG_TRACKING_NOT_INITIALIZED ((NTSTATUS)0xC03A0020L) + +// +// MessageId: STATUS_CTLOG_LOGFILE_SIZE_EXCEEDED_MAXSIZE +// +// MessageText: +// +// Size of change tracking file exceeded the maximum size limit. +// +#define STATUS_CTLOG_LOGFILE_SIZE_EXCEEDED_MAXSIZE ((NTSTATUS)0xC03A0021L) + +// +// MessageId: STATUS_CTLOG_VHD_CHANGED_OFFLINE +// +// MessageText: +// +// VHD file is changed due to compaction, expansion, or offline updates. +// +#define STATUS_CTLOG_VHD_CHANGED_OFFLINE ((NTSTATUS)0xC03A0022L) + +// +// MessageId: STATUS_CTLOG_INVALID_TRACKING_STATE +// +// MessageText: +// +// Change Tracking for the virtual disk is not in a valid state to perform this request. Change tracking could be discontinued or already in the requested state. +// +#define STATUS_CTLOG_INVALID_TRACKING_STATE ((NTSTATUS)0xC03A0023L) + +// +// MessageId: STATUS_CTLOG_INCONSISTENT_TRACKING_FILE +// +// MessageText: +// +// Change Tracking file for the virtual disk is not in a valid state. +// +#define STATUS_CTLOG_INCONSISTENT_TRACKING_FILE ((NTSTATUS)0xC03A0024L) + +// +// MessageId: STATUS_VHD_METADATA_FULL +// +// MessageText: +// +// There is not enough space in the virtual disk file for the provided metadata item. +// +#define STATUS_VHD_METADATA_FULL ((NTSTATUS)0xC03A0028L) + +// +// MessageId: STATUS_VHD_INVALID_CHANGE_TRACKING_ID +// +// MessageText: +// +// The specified change tracking identifier is not valid. +// +#define STATUS_VHD_INVALID_CHANGE_TRACKING_ID ((NTSTATUS)0xC03A0029L) + +// +// MessageId: STATUS_VHD_CHANGE_TRACKING_DISABLED +// +// MessageText: +// +// Change tracking is disabled for the specified virtual hard disk, so no change tracking information is available. +// +#define STATUS_VHD_CHANGE_TRACKING_DISABLED ((NTSTATUS)0xC03A002AL) + +// +// MessageId: STATUS_VHD_MISSING_CHANGE_TRACKING_INFORMATION +// +// MessageText: +// +// There is no change tracking data available associated with the specified change tracking identifier. +// +#define STATUS_VHD_MISSING_CHANGE_TRACKING_INFORMATION ((NTSTATUS)0xC03A0030L) + +// +// MessageId: STATUS_VHD_RESIZE_WOULD_TRUNCATE_DATA +// +// MessageText: +// +// The requested resize operation might truncate user data residing on the virtual disk. +// +#define STATUS_VHD_RESIZE_WOULD_TRUNCATE_DATA ((NTSTATUS)0xC03A0031L) + +// +// MessageId: STATUS_VHD_COULD_NOT_COMPUTE_MINIMUM_VIRTUAL_SIZE +// +// MessageText: +// +// The minimum safe size of the virtual disk could not be determined. This may be due to a missing or corrupt partition table. +// +#define STATUS_VHD_COULD_NOT_COMPUTE_MINIMUM_VIRTUAL_SIZE ((NTSTATUS)0xC03A0032L) + +// +// MessageId: STATUS_VHD_ALREADY_AT_OR_BELOW_MINIMUM_VIRTUAL_SIZE +// +// MessageText: +// +// The size of the virtual disk cannot be safely reduced further. +// +#define STATUS_VHD_ALREADY_AT_OR_BELOW_MINIMUM_VIRTUAL_SIZE ((NTSTATUS)0xC03A0033L) + +// +// MessageId: STATUS_VHD_UNEXPECTED_ID +// +// MessageText: +// +// The specified VHD has an unexpected virtual disk identifier. +// +#define STATUS_VHD_UNEXPECTED_ID ((NTSTATUS)0xC03A0034L) + + +// +// Vhd warnings. +// + +// +// MessageId: STATUS_QUERY_STORAGE_ERROR +// +// MessageText: +// +// The virtualization storage subsystem has generated an error. +// +#define STATUS_QUERY_STORAGE_ERROR ((NTSTATUS)0x803A0001L) + + +// +// NtGdi warnings. +// + +// +// MessageId: STATUS_GDI_HANDLE_LEAK +// +// MessageText: +// +// GDI handles were potentially leaked by the application. +// +#define STATUS_GDI_HANDLE_LEAK ((NTSTATUS)0x803F0001L) + + +// +// Resume Key Filter (RKF) error codes. +// +// +// MessageId: STATUS_RKF_KEY_NOT_FOUND +// +// MessageText: +// +// The Resume Key Filter could not find the resume key supplied for the operation. +// +#define STATUS_RKF_KEY_NOT_FOUND ((NTSTATUS)0xC0400001L) + +// +// MessageId: STATUS_RKF_DUPLICATE_KEY +// +// MessageText: +// +// The Resume Key Filter found an existing resume key that matches the one supplied for the handle. +// +#define STATUS_RKF_DUPLICATE_KEY ((NTSTATUS)0xC0400002L) + +// +// MessageId: STATUS_RKF_BLOB_FULL +// +// MessageText: +// +// The Resume Key Filter data blob attached to the handle is full. No more space is available. +// +#define STATUS_RKF_BLOB_FULL ((NTSTATUS)0xC0400003L) + +// +// MessageId: STATUS_RKF_STORE_FULL +// +// MessageText: +// +// The Resume Key Filter handle store is full. No more resume handles can be accepted. +// +#define STATUS_RKF_STORE_FULL ((NTSTATUS)0xC0400004L) + +// +// MessageId: STATUS_RKF_FILE_BLOCKED +// +// MessageText: +// +// The Resume Key Filter failed the operation because the file is temporarily blocked pending the resume of existing handles on the file. +// +#define STATUS_RKF_FILE_BLOCKED ((NTSTATUS)0xC0400005L) + +// +// MessageId: STATUS_RKF_ACTIVE_KEY +// +// MessageText: +// +// The Resume Key Filter found an existing resume key that matches the one supplied on a handle that's active/open. The operation requires an inactive/closed handle. +// +#define STATUS_RKF_ACTIVE_KEY ((NTSTATUS)0xC0400006L) + + +// +// RDBSS / MiniRdr internal error codes. +// +// +// MessageId: STATUS_RDBSS_RESTART_OPERATION +// +// MessageText: +// +// The operation must be restarted by RDBSS. +// +#define STATUS_RDBSS_RESTART_OPERATION ((NTSTATUS)0xC0410001L) + +// +// MessageId: STATUS_RDBSS_CONTINUE_OPERATION +// +// MessageText: +// +// The operation must continue processing. +// +#define STATUS_RDBSS_CONTINUE_OPERATION ((NTSTATUS)0xC0410002L) + +// +// MessageId: STATUS_RDBSS_POST_OPERATION +// +// MessageText: +// +// The operation must be posted to a thread to be retried at passive IRQL. +// +#define STATUS_RDBSS_POST_OPERATION ((NTSTATUS)0xC0410003L) + +// +// MessageId: STATUS_RDBSS_RETRY_LOOKUP +// +// MessageText: +// +// The caller must retry by looking up the object in the name table. +// +#define STATUS_RDBSS_RETRY_LOOKUP ((NTSTATUS)0xC0410004L) + +// +// Bluetooth Attribute Protocol Warnings +// + +// +// MessageId: STATUS_BTH_ATT_INVALID_HANDLE +// +// MessageText: +// +// The attribute handle given was not valid on this server. +// +#define STATUS_BTH_ATT_INVALID_HANDLE ((NTSTATUS)0xC0420001L) + +// +// MessageId: STATUS_BTH_ATT_READ_NOT_PERMITTED +// +// MessageText: +// +// The attribute cannot be read. +// +#define STATUS_BTH_ATT_READ_NOT_PERMITTED ((NTSTATUS)0xC0420002L) + +// +// MessageId: STATUS_BTH_ATT_WRITE_NOT_PERMITTED +// +// MessageText: +// +// The attribute cannot be written. +// +#define STATUS_BTH_ATT_WRITE_NOT_PERMITTED ((NTSTATUS)0xC0420003L) + +// +// MessageId: STATUS_BTH_ATT_INVALID_PDU +// +// MessageText: +// +// The attribute PDU was invalid. +// +#define STATUS_BTH_ATT_INVALID_PDU ((NTSTATUS)0xC0420004L) + +// +// MessageId: STATUS_BTH_ATT_INSUFFICIENT_AUTHENTICATION +// +// MessageText: +// +// The attribute requires authentication before it can be read or written. +// +#define STATUS_BTH_ATT_INSUFFICIENT_AUTHENTICATION ((NTSTATUS)0xC0420005L) + +// +// MessageId: STATUS_BTH_ATT_REQUEST_NOT_SUPPORTED +// +// MessageText: +// +// Attribute server does not support the request received from the client. +// +#define STATUS_BTH_ATT_REQUEST_NOT_SUPPORTED ((NTSTATUS)0xC0420006L) + +// +// MessageId: STATUS_BTH_ATT_INVALID_OFFSET +// +// MessageText: +// +// Offset specified was past the end of the attribute. +// +#define STATUS_BTH_ATT_INVALID_OFFSET ((NTSTATUS)0xC0420007L) + +// +// MessageId: STATUS_BTH_ATT_INSUFFICIENT_AUTHORIZATION +// +// MessageText: +// +// The attribute requires authorization before it can be read or written. +// +#define STATUS_BTH_ATT_INSUFFICIENT_AUTHORIZATION ((NTSTATUS)0xC0420008L) + +// +// MessageId: STATUS_BTH_ATT_PREPARE_QUEUE_FULL +// +// MessageText: +// +// Too many prepare writes have been queued. +// +#define STATUS_BTH_ATT_PREPARE_QUEUE_FULL ((NTSTATUS)0xC0420009L) + +// +// MessageId: STATUS_BTH_ATT_ATTRIBUTE_NOT_FOUND +// +// MessageText: +// +// No attribute found within the given attribute handle range. +// +#define STATUS_BTH_ATT_ATTRIBUTE_NOT_FOUND ((NTSTATUS)0xC042000AL) + +// +// MessageId: STATUS_BTH_ATT_ATTRIBUTE_NOT_LONG +// +// MessageText: +// +// The attribute cannot be read or written using the Read Blob Request. +// +#define STATUS_BTH_ATT_ATTRIBUTE_NOT_LONG ((NTSTATUS)0xC042000BL) + +// +// MessageId: STATUS_BTH_ATT_INSUFFICIENT_ENCRYPTION_KEY_SIZE +// +// MessageText: +// +// The Encryption Key Size used for encrypting this link is insufficient. +// +#define STATUS_BTH_ATT_INSUFFICIENT_ENCRYPTION_KEY_SIZE ((NTSTATUS)0xC042000CL) + +// +// MessageId: STATUS_BTH_ATT_INVALID_ATTRIBUTE_VALUE_LENGTH +// +// MessageText: +// +// The attribute value length is invalid for the operation. +// +#define STATUS_BTH_ATT_INVALID_ATTRIBUTE_VALUE_LENGTH ((NTSTATUS)0xC042000DL) + +// +// MessageId: STATUS_BTH_ATT_UNLIKELY +// +// MessageText: +// +// The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested. +// +#define STATUS_BTH_ATT_UNLIKELY ((NTSTATUS)0xC042000EL) + +// +// MessageId: STATUS_BTH_ATT_INSUFFICIENT_ENCRYPTION +// +// MessageText: +// +// The attribute requires encryption before it can be read or written. +// +#define STATUS_BTH_ATT_INSUFFICIENT_ENCRYPTION ((NTSTATUS)0xC042000FL) + +// +// MessageId: STATUS_BTH_ATT_UNSUPPORTED_GROUP_TYPE +// +// MessageText: +// +// The attribute type is not a supported grouping attribute as defined by a higher layer specification. +// +#define STATUS_BTH_ATT_UNSUPPORTED_GROUP_TYPE ((NTSTATUS)0xC0420010L) + +// +// MessageId: STATUS_BTH_ATT_INSUFFICIENT_RESOURCES +// +// MessageText: +// +// Insufficient Resources to complete the request. +// +#define STATUS_BTH_ATT_INSUFFICIENT_RESOURCES ((NTSTATUS)0xC0420011L) + +// +// MessageId: STATUS_BTH_ATT_UNKNOWN_ERROR +// +// MessageText: +// +// An error that lies in the reserved range has been received. +// +#define STATUS_BTH_ATT_UNKNOWN_ERROR ((NTSTATUS)0xC0421000L) + +// +// Secure Boot error messages. +// +// +// MessageId: STATUS_SECUREBOOT_ROLLBACK_DETECTED +// +// MessageText: +// +// Secure Boot detected that rollback of protected data has been attempted. +// +#define STATUS_SECUREBOOT_ROLLBACK_DETECTED ((NTSTATUS)0xC0430001L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_VIOLATION +// +// MessageText: +// +// The value is protected by Secure Boot policy and cannot be modified or deleted. +// +#define STATUS_SECUREBOOT_POLICY_VIOLATION ((NTSTATUS)0xC0430002L) + +// +// MessageId: STATUS_SECUREBOOT_INVALID_POLICY +// +// MessageText: +// +// The Secure Boot policy is invalid. +// +#define STATUS_SECUREBOOT_INVALID_POLICY ((NTSTATUS)0xC0430003L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_PUBLISHER_NOT_FOUND +// +// MessageText: +// +// A new Secure Boot policy did not contain the current publisher on its update list. +// +#define STATUS_SECUREBOOT_POLICY_PUBLISHER_NOT_FOUND ((NTSTATUS)0xC0430004L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_NOT_SIGNED +// +// MessageText: +// +// The Secure Boot policy is either not signed or is signed by a non-trusted signer. +// +#define STATUS_SECUREBOOT_POLICY_NOT_SIGNED ((NTSTATUS)0xC0430005L) + +// +// MessageId: STATUS_SECUREBOOT_NOT_ENABLED +// +// MessageText: +// +// Secure Boot is not enabled on this machine. +// +#define STATUS_SECUREBOOT_NOT_ENABLED ((NTSTATUS)0x80430006L) + +// +// MessageId: STATUS_SECUREBOOT_FILE_REPLACED +// +// MessageText: +// +// Secure Boot requires that certain files and drivers are not replaced by other files or drivers. +// +#define STATUS_SECUREBOOT_FILE_REPLACED ((NTSTATUS)0xC0430007L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_NOT_AUTHORIZED +// +// MessageText: +// +// The Secure Boot Supplemental Policy file was not authorized on this machine. +// +#define STATUS_SECUREBOOT_POLICY_NOT_AUTHORIZED ((NTSTATUS)0xC0430008L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_UNKNOWN +// +// MessageText: +// +// The Supplemental Policy is not recognized on this device. +// +#define STATUS_SECUREBOOT_POLICY_UNKNOWN ((NTSTATUS)0xC0430009L) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_MISSING_ANTIROLLBACKVERSION +// +// MessageText: +// +// The Antirollback version was not found in the Secure Boot Policy. +// +#define STATUS_SECUREBOOT_POLICY_MISSING_ANTIROLLBACKVERSION ((NTSTATUS)0xC043000AL) + +// +// MessageId: STATUS_SECUREBOOT_PLATFORM_ID_MISMATCH +// +// MessageText: +// +// The Platform ID specified in the Secure Boot policy does not match the Platform ID on this device. +// +#define STATUS_SECUREBOOT_PLATFORM_ID_MISMATCH ((NTSTATUS)0xC043000BL) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_ROLLBACK_DETECTED +// +// MessageText: +// +// The Secure Boot policy file has an older Antirollback Version than this device. +// +#define STATUS_SECUREBOOT_POLICY_ROLLBACK_DETECTED ((NTSTATUS)0xC043000CL) + +// +// MessageId: STATUS_SECUREBOOT_POLICY_UPGRADE_MISMATCH +// +// MessageText: +// +// The Secure Boot policy file does not match the upgraded legacy policy. +// +#define STATUS_SECUREBOOT_POLICY_UPGRADE_MISMATCH ((NTSTATUS)0xC043000DL) + +// +// MessageId: STATUS_SECUREBOOT_REQUIRED_POLICY_FILE_MISSING +// +// MessageText: +// +// The Secure Boot policy file is required but could not be found. +// +#define STATUS_SECUREBOOT_REQUIRED_POLICY_FILE_MISSING ((NTSTATUS)0xC043000EL) + +// +// MessageId: STATUS_SECUREBOOT_NOT_BASE_POLICY +// +// MessageText: +// +// Supplemental Secure Boot policy file can not be loaded as a base Secure Boot policy. +// +#define STATUS_SECUREBOOT_NOT_BASE_POLICY ((NTSTATUS)0xC043000FL) + +// +// MessageId: STATUS_SECUREBOOT_NOT_SUPPLEMENTAL_POLICY +// +// MessageText: +// +// Base Secure Boot policy file can not be loaded as a Supplemental Secure Boot policy. +// +#define STATUS_SECUREBOOT_NOT_SUPPLEMENTAL_POLICY ((NTSTATUS)0xC0430010L) + +// +// Platform Manifest Error Messages +// +// +// MessageId: STATUS_PLATFORM_MANIFEST_NOT_AUTHORIZED +// +// MessageText: +// +// The Platform Manifest file was not authorized on this machine. +// +#define STATUS_PLATFORM_MANIFEST_NOT_AUTHORIZED ((NTSTATUS)0xC0EB0001L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_INVALID +// +// MessageText: +// +// The Platform Manifest file was not valid. +// +#define STATUS_PLATFORM_MANIFEST_INVALID ((NTSTATUS)0xC0EB0002L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_FILE_NOT_AUTHORIZED +// +// MessageText: +// +// The file is not authorized on this platform because an entry was not found in the Platform Manifest. +// +#define STATUS_PLATFORM_MANIFEST_FILE_NOT_AUTHORIZED ((NTSTATUS)0xC0EB0003L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_CATALOG_NOT_AUTHORIZED +// +// MessageText: +// +// The catalog is not authorized on this platform because an entry was not found in the Platform Manifest. +// +#define STATUS_PLATFORM_MANIFEST_CATALOG_NOT_AUTHORIZED ((NTSTATUS)0xC0EB0004L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_BINARY_ID_NOT_FOUND +// +// MessageText: +// +// The file is not authorized on this platform because a Binary ID was not found in the embedded signature. +// +#define STATUS_PLATFORM_MANIFEST_BINARY_ID_NOT_FOUND ((NTSTATUS)0xC0EB0005L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_NOT_ACTIVE +// +// MessageText: +// +// No active Platform Manifest exists on this system. +// +#define STATUS_PLATFORM_MANIFEST_NOT_ACTIVE ((NTSTATUS)0xC0EB0006L) + +// +// MessageId: STATUS_PLATFORM_MANIFEST_NOT_SIGNED +// +// MessageText: +// +// The Platform Manifest file was not properly signed. +// +#define STATUS_PLATFORM_MANIFEST_NOT_SIGNED ((NTSTATUS)0xC0EB0007L) + +// +// System Integrity Policy error messages. +// +// +// MessageId: STATUS_SYSTEM_INTEGRITY_ROLLBACK_DETECTED +// +// MessageText: +// +// Application Control detected that policy rollback has been attempted. +// +#define STATUS_SYSTEM_INTEGRITY_ROLLBACK_DETECTED ((NTSTATUS)0xC0E90001L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_POLICY_VIOLATION +// +// MessageText: +// +// An Application Control policy has blocked this file. +// +#define STATUS_SYSTEM_INTEGRITY_POLICY_VIOLATION ((NTSTATUS)0xC0E90002L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_INVALID_POLICY +// +// MessageText: +// +// The Application Control policy is invalid. +// +#define STATUS_SYSTEM_INTEGRITY_INVALID_POLICY ((NTSTATUS)0xC0E90003L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_POLICY_NOT_SIGNED +// +// MessageText: +// +// The Application Control policy is either not signed or is signed by a non-trusted signer. +// +#define STATUS_SYSTEM_INTEGRITY_POLICY_NOT_SIGNED ((NTSTATUS)0xC0E90004L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_TOO_MANY_POLICIES +// +// MessageText: +// +// The number of Application Control policies is out of limit. +// +#define STATUS_SYSTEM_INTEGRITY_TOO_MANY_POLICIES ((NTSTATUS)0xC0E90005L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_SUPPLEMENTAL_POLICY_NOT_AUTHORIZED +// +// MessageText: +// +// The Application Control supplemental policy is not authorized by an Application Control base policy. +// +#define STATUS_SYSTEM_INTEGRITY_SUPPLEMENTAL_POLICY_NOT_AUTHORIZED ((NTSTATUS)0xC0E90006L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_MALICIOUS +// +// MessageText: +// +// An Application Control policy has blocked this file. Malicious binary reputation. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_MALICIOUS ((NTSTATUS)0xC0E90007L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_PUA +// +// MessageText: +// +// An Application Control policy has blocked this file. Potentially unwanted application. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_PUA ((NTSTATUS)0xC0E90008L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_DANGEROUS_EXT +// +// MessageText: +// +// An Application Control policy has blocked this file. Dangerous file extension from the web. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_DANGEROUS_EXT ((NTSTATUS)0xC0E90009L) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_OFFLINE +// +// MessageText: +// +// An Application Control policy has blocked this file. Unable to contact reputation service for unknown file. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_OFFLINE ((NTSTATUS)0xC0E9000AL) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_UNFRIENDLY_FILE +// +// MessageText: +// +// An Application Control policy has blocked this file. Unfriendly file. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_UNFRIENDLY_FILE ((NTSTATUS)0xC0E9000BL) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_UNATTAINABLE +// +// MessageText: +// +// An Application Control policy has blocked this file. Failed to obtain file reputation because an infrastructure issue occurred. Try again later. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_UNATTAINABLE ((NTSTATUS)0xC0E9000CL) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_REPUTATION_EXPLICIT_DENY_FILE +// +// MessageText: +// +// An Application Control policy has blocked this file. Explicitly denied file. +// +#define STATUS_SYSTEM_INTEGRITY_REPUTATION_EXPLICIT_DENY_FILE ((NTSTATUS)0xC0E9000DL) + +// +// MessageId: STATUS_SYSTEM_INTEGRITY_WHQL_NOT_SATISFIED +// +// MessageText: +// +// An Application Control policy has blocked this file. File did not pass WHQL-only requirements. +// +#define STATUS_SYSTEM_INTEGRITY_WHQL_NOT_SATISFIED ((NTSTATUS)0xC0E9000EL) + +// +// Clip modern app and windows licensing error messages. +// +// +// MessageId: STATUS_NO_APPLICABLE_APP_LICENSES_FOUND +// +// MessageText: +// +// No applicable app licenses found. +// +#define STATUS_NO_APPLICABLE_APP_LICENSES_FOUND ((NTSTATUS)0xC0EA0001L) + +// +// MessageId: STATUS_CLIP_LICENSE_NOT_FOUND +// +// MessageText: +// +// CLiP license not found. +// +#define STATUS_CLIP_LICENSE_NOT_FOUND ((NTSTATUS)0xC0EA0002L) + +// +// MessageId: STATUS_CLIP_DEVICE_LICENSE_MISSING +// +// MessageText: +// +// CLiP device license not found. +// +#define STATUS_CLIP_DEVICE_LICENSE_MISSING ((NTSTATUS)0xC0EA0003L) + +// +// MessageId: STATUS_CLIP_LICENSE_INVALID_SIGNATURE +// +// MessageText: +// +// CLiP license has an invalid signature. +// +#define STATUS_CLIP_LICENSE_INVALID_SIGNATURE ((NTSTATUS)0xC0EA0004L) + +// +// MessageId: STATUS_CLIP_KEYHOLDER_LICENSE_MISSING_OR_INVALID +// +// MessageText: +// +// CLiP keyholder license is invalid or missing. +// +#define STATUS_CLIP_KEYHOLDER_LICENSE_MISSING_OR_INVALID ((NTSTATUS)0xC0EA0005L) + +// +// MessageId: STATUS_CLIP_LICENSE_EXPIRED +// +// MessageText: +// +// CLiP license has expired. +// +#define STATUS_CLIP_LICENSE_EXPIRED ((NTSTATUS)0xC0EA0006L) + +// +// MessageId: STATUS_CLIP_LICENSE_SIGNED_BY_UNKNOWN_SOURCE +// +// MessageText: +// +// CLiP license is signed by an unknown source. +// +#define STATUS_CLIP_LICENSE_SIGNED_BY_UNKNOWN_SOURCE ((NTSTATUS)0xC0EA0007L) + +// +// MessageId: STATUS_CLIP_LICENSE_NOT_SIGNED +// +// MessageText: +// +// CLiP license is not signed. +// +#define STATUS_CLIP_LICENSE_NOT_SIGNED ((NTSTATUS)0xC0EA0008L) + +// +// MessageId: STATUS_CLIP_LICENSE_HARDWARE_ID_OUT_OF_TOLERANCE +// +// MessageText: +// +// CLiP license hardware ID is out of tolerance. +// +#define STATUS_CLIP_LICENSE_HARDWARE_ID_OUT_OF_TOLERANCE ((NTSTATUS)0xC0EA0009L) + +// +// MessageId: STATUS_CLIP_LICENSE_DEVICE_ID_MISMATCH +// +// MessageText: +// +// CLiP license device ID does not match the device ID in the bound device license. +// +#define STATUS_CLIP_LICENSE_DEVICE_ID_MISMATCH ((NTSTATUS)0xC0EA000AL) + +// +// Audio error messages. +// +// +// MessageId: STATUS_AUDIO_ENGINE_NODE_NOT_FOUND +// +// MessageText: +// +// PortCls could not find an audio engine node exposed by a miniport driver claiming support for IMiniportAudioEngineNode. +// +#define STATUS_AUDIO_ENGINE_NODE_NOT_FOUND ((NTSTATUS)0xC0440001L) + +// +// MessageId: STATUS_HDAUDIO_EMPTY_CONNECTION_LIST +// +// MessageText: +// +// HD Audio widget encountered an unexpected empty connection list. +// +#define STATUS_HDAUDIO_EMPTY_CONNECTION_LIST ((NTSTATUS)0xC0440002L) + +// +// MessageId: STATUS_HDAUDIO_CONNECTION_LIST_NOT_SUPPORTED +// +// MessageText: +// +// HD Audio widget does not support the connection list parameter. +// +#define STATUS_HDAUDIO_CONNECTION_LIST_NOT_SUPPORTED ((NTSTATUS)0xC0440003L) + +// +// MessageId: STATUS_HDAUDIO_NO_LOGICAL_DEVICES_CREATED +// +// MessageText: +// +// No HD Audio subdevices were successfully created. +// +#define STATUS_HDAUDIO_NO_LOGICAL_DEVICES_CREATED ((NTSTATUS)0xC0440004L) + +// +// MessageId: STATUS_HDAUDIO_NULL_LINKED_LIST_ENTRY +// +// MessageText: +// +// An unexpected NULL pointer was encountered in a linked list. +// +#define STATUS_HDAUDIO_NULL_LINKED_LIST_ENTRY ((NTSTATUS)0xC0440005L) + +// +// MessageId: STATUS_SOUNDWIRE_COMMAND_ABORTED +// +// MessageText: +// +// SoundWire command aborted. +// +#define STATUS_SOUNDWIRE_COMMAND_ABORTED ((NTSTATUS)0xC0440006L) + +// +// MessageId: STATUS_SOUNDWIRE_COMMAND_IGNORED +// +// MessageText: +// +// SoundWire command ignored. +// +#define STATUS_SOUNDWIRE_COMMAND_IGNORED ((NTSTATUS)0xC0440007L) + +// +// MessageId: STATUS_SOUNDWIRE_COMMAND_FAILED +// +// MessageText: +// +// SoundWire command failed. +// +#define STATUS_SOUNDWIRE_COMMAND_FAILED ((NTSTATUS)0xC0440008L) + +// +// Spaceport success codes (spaceport.sys) +// +// +// MessageId: STATUS_SPACES_REPAIRED +// +// MessageText: +// +// The repair was successful. +// +#define STATUS_SPACES_REPAIRED ((NTSTATUS)0x00E70000L) + +// +// MessageId: STATUS_SPACES_PAUSE +// +// MessageText: +// +// The operation has been paused. +// +#define STATUS_SPACES_PAUSE ((NTSTATUS)0x00E70001L) + +// +// MessageId: STATUS_SPACES_COMPLETE +// +// MessageText: +// +// The operation is complete. +// +#define STATUS_SPACES_COMPLETE ((NTSTATUS)0x00E70002L) + +// +// MessageId: STATUS_SPACES_REDIRECT +// +// MessageText: +// +// The operation should be redirected to another node. +// +#define STATUS_SPACES_REDIRECT ((NTSTATUS)0x00E70003L) + +// +// Spaceport error codes (spaceport.sys) +// +// +// MessageId: STATUS_SPACES_FAULT_DOMAIN_TYPE_INVALID +// +// MessageText: +// +// The specified fault domain type or combination of minimum / maximum fault domain type is not valid. +// +#define STATUS_SPACES_FAULT_DOMAIN_TYPE_INVALID ((NTSTATUS)0xC0E70001L) + +// +// MessageId: STATUS_SPACES_RESILIENCY_TYPE_INVALID +// +// MessageText: +// +// The specified resiliency type is not valid. +// +#define STATUS_SPACES_RESILIENCY_TYPE_INVALID ((NTSTATUS)0xC0E70003L) + +// +// MessageId: STATUS_SPACES_DRIVE_SECTOR_SIZE_INVALID +// +// MessageText: +// +// The sector size of the physical disk is not supported by the storage pool. +// +#define STATUS_SPACES_DRIVE_SECTOR_SIZE_INVALID ((NTSTATUS)0xC0E70004L) + +// +// MessageId: STATUS_SPACES_DRIVE_REDUNDANCY_INVALID +// +// MessageText: +// +// The value for fault tolerance is outside of the supported range of values. +// +#define STATUS_SPACES_DRIVE_REDUNDANCY_INVALID ((NTSTATUS)0xC0E70006L) + +// +// MessageId: STATUS_SPACES_NUMBER_OF_DATA_COPIES_INVALID +// +// MessageText: +// +// The number of data copies requested is outside of the supported range of values. +// +#define STATUS_SPACES_NUMBER_OF_DATA_COPIES_INVALID ((NTSTATUS)0xC0E70007L) + +// +// MessageId: STATUS_SPACES_INTERLEAVE_LENGTH_INVALID +// +// MessageText: +// +// The value for interleave length is outside of the supported range of values or is not a power of 2. +// +#define STATUS_SPACES_INTERLEAVE_LENGTH_INVALID ((NTSTATUS)0xC0E70009L) + +// +// MessageId: STATUS_SPACES_NUMBER_OF_COLUMNS_INVALID +// +// MessageText: +// +// The number of columns specified is outside of the supported range of values. +// +#define STATUS_SPACES_NUMBER_OF_COLUMNS_INVALID ((NTSTATUS)0xC0E7000AL) + +// +// MessageId: STATUS_SPACES_NOT_ENOUGH_DRIVES +// +// MessageText: +// +// There were not enough physical disks to complete the requested operation. +// +#define STATUS_SPACES_NOT_ENOUGH_DRIVES ((NTSTATUS)0xC0E7000BL) + +// +// MessageId: STATUS_SPACES_EXTENDED_ERROR +// +// MessageText: +// +// Extended error information is available. +// +#define STATUS_SPACES_EXTENDED_ERROR ((NTSTATUS)0xC0E7000CL) + +// +// MessageId: STATUS_SPACES_PROVISIONING_TYPE_INVALID +// +// MessageText: +// +// The specified provisioning type is not valid. +// +#define STATUS_SPACES_PROVISIONING_TYPE_INVALID ((NTSTATUS)0xC0E7000DL) + +// +// MessageId: STATUS_SPACES_ALLOCATION_SIZE_INVALID +// +// MessageText: +// +// The allocation size is outside of the supported range of values. +// +#define STATUS_SPACES_ALLOCATION_SIZE_INVALID ((NTSTATUS)0xC0E7000EL) + +// +// MessageId: STATUS_SPACES_ENCLOSURE_AWARE_INVALID +// +// MessageText: +// +// Enclosure awareness is not supported for this virtual disk. +// +#define STATUS_SPACES_ENCLOSURE_AWARE_INVALID ((NTSTATUS)0xC0E7000FL) + +// +// MessageId: STATUS_SPACES_WRITE_CACHE_SIZE_INVALID +// +// MessageText: +// +// The write cache size is outside of the supported range of values. +// +#define STATUS_SPACES_WRITE_CACHE_SIZE_INVALID ((NTSTATUS)0xC0E70010L) + +// +// MessageId: STATUS_SPACES_NUMBER_OF_GROUPS_INVALID +// +// MessageText: +// +// The value for number of groups is outside of the supported range of values. +// +#define STATUS_SPACES_NUMBER_OF_GROUPS_INVALID ((NTSTATUS)0xC0E70011L) + +// +// MessageId: STATUS_SPACES_DRIVE_OPERATIONAL_STATE_INVALID +// +// MessageText: +// +// The OperationalState of the physical disk is invalid for this operation. +// +#define STATUS_SPACES_DRIVE_OPERATIONAL_STATE_INVALID ((NTSTATUS)0xC0E70012L) + +// +// MessageId: STATUS_SPACES_UPDATE_COLUMN_STATE +// +// MessageText: +// +// A column's state needs to be updated. +// +#define STATUS_SPACES_UPDATE_COLUMN_STATE ((NTSTATUS)0xC0E70013L) + +// +// MessageId: STATUS_SPACES_MAP_REQUIRED +// +// MessageText: +// +// An extent needs to be allocated. +// +#define STATUS_SPACES_MAP_REQUIRED ((NTSTATUS)0xC0E70014L) + +// +// MessageId: STATUS_SPACES_UNSUPPORTED_VERSION +// +// MessageText: +// +// The metadata version is unsupported. +// +#define STATUS_SPACES_UNSUPPORTED_VERSION ((NTSTATUS)0xC0E70015L) + +// +// MessageId: STATUS_SPACES_CORRUPT_METADATA +// +// MessageText: +// +// The metadata read was corrupt. +// +#define STATUS_SPACES_CORRUPT_METADATA ((NTSTATUS)0xC0E70016L) + +// +// MessageId: STATUS_SPACES_DRT_FULL +// +// MessageText: +// +// The DRT is full. +// +#define STATUS_SPACES_DRT_FULL ((NTSTATUS)0xC0E70017L) + +// +// MessageId: STATUS_SPACES_INCONSISTENCY +// +// MessageText: +// +// An inconsistency was found. +// +#define STATUS_SPACES_INCONSISTENCY ((NTSTATUS)0xC0E70018L) + +// +// MessageId: STATUS_SPACES_LOG_NOT_READY +// +// MessageText: +// +// The log is not ready. +// +#define STATUS_SPACES_LOG_NOT_READY ((NTSTATUS)0xC0E70019L) + +// +// MessageId: STATUS_SPACES_NO_REDUNDANCY +// +// MessageText: +// +// No good copy of data was available. +// +#define STATUS_SPACES_NO_REDUNDANCY ((NTSTATUS)0xC0E7001AL) + +// +// MessageId: STATUS_SPACES_DRIVE_NOT_READY +// +// MessageText: +// +// The drive is not ready. +// +#define STATUS_SPACES_DRIVE_NOT_READY ((NTSTATUS)0xC0E7001BL) + +// +// MessageId: STATUS_SPACES_DRIVE_SPLIT +// +// MessageText: +// +// The data on this drive is stale. +// +#define STATUS_SPACES_DRIVE_SPLIT ((NTSTATUS)0xC0E7001CL) + +// +// MessageId: STATUS_SPACES_DRIVE_LOST_DATA +// +// MessageText: +// +// The data on this drive has been lost. +// +#define STATUS_SPACES_DRIVE_LOST_DATA ((NTSTATUS)0xC0E7001DL) + +// +// MessageId: STATUS_SPACES_ENTRY_INCOMPLETE +// +// MessageText: +// +// The specified log entry is not complete. +// +#define STATUS_SPACES_ENTRY_INCOMPLETE ((NTSTATUS)0xC0E7001EL) + +// +// MessageId: STATUS_SPACES_ENTRY_INVALID +// +// MessageText: +// +// The specified log entry is not valid. +// +#define STATUS_SPACES_ENTRY_INVALID ((NTSTATUS)0xC0E7001FL) + +// +// MessageId: STATUS_SPACES_MARK_DIRTY +// +// MessageText: +// +// A slab needs to be marked dirty. +// +#define STATUS_SPACES_MARK_DIRTY ((NTSTATUS)0xC0E70020L) + +// +// MessageId: STATUS_SPACES_PD_NOT_FOUND +// +// MessageText: +// +// A persisted memory buffer was not found. +// +#define STATUS_SPACES_PD_NOT_FOUND ((NTSTATUS)0xC0E70021L) + +// +// MessageId: STATUS_SPACES_PD_LENGTH_MISMATCH +// +// MessageText: +// +// A persisted memory buffer is too small. +// +#define STATUS_SPACES_PD_LENGTH_MISMATCH ((NTSTATUS)0xC0E70022L) + +// +// MessageId: STATUS_SPACES_PD_UNSUPPORTED_VERSION +// +// MessageText: +// +// A persisted memory buffer has an unsupported version. +// +#define STATUS_SPACES_PD_UNSUPPORTED_VERSION ((NTSTATUS)0xC0E70023L) + +// +// MessageId: STATUS_SPACES_PD_INVALID_DATA +// +// MessageText: +// +// A persisted memory buffer contains invalid data. +// +#define STATUS_SPACES_PD_INVALID_DATA ((NTSTATUS)0xC0E70024L) + +// +// MessageId: STATUS_SPACES_FLUSH_METADATA +// +// MessageText: +// +// The cache metadata needs to be written and flushed. +// +#define STATUS_SPACES_FLUSH_METADATA ((NTSTATUS)0xC0E70025L) + +// +// MessageId: STATUS_SPACES_CACHE_FULL +// +// MessageText: +// +// The cache is full. +// +#define STATUS_SPACES_CACHE_FULL ((NTSTATUS)0xC0E70026L) + +// +// MessageId: STATUS_SPACES_REPAIR_IN_PROGRESS +// +// MessageText: +// +// Repair is in progress. +// +#define STATUS_SPACES_REPAIR_IN_PROGRESS ((NTSTATUS)0xC0E70027L) + +// +// Volsnap status codes (volsnap.sys) +// +// +// MessageId: STATUS_VOLSNAP_BOOTFILE_NOT_VALID +// +// MessageText: +// +// The bootfile is too small to support persistent snapshots. +// +#define STATUS_VOLSNAP_BOOTFILE_NOT_VALID ((NTSTATUS)0xC0500003L) + +// +// MessageId: STATUS_VOLSNAP_ACTIVATION_TIMEOUT +// +// MessageText: +// +// Activation of persistent snapshots on this volume took longer than was allowed. +// +#define STATUS_VOLSNAP_ACTIVATION_TIMEOUT ((NTSTATUS)0xC0500004L) + +// +// MessageId: STATUS_VOLSNAP_NO_BYPASSIO_WITH_SNAPSHOT +// +// MessageText: +// +// BypassIO cannot be enabled while a volume snapshot exists. +// +#define STATUS_VOLSNAP_NO_BYPASSIO_WITH_SNAPSHOT ((NTSTATUS)0xC0500005L) + +// +// Sdbus status codes (sdbus.sys) +// +// +// MessageId: STATUS_IO_PREEMPTED +// +// MessageText: +// +// The operation was preempted by a higher priority operation. It must be resumed later. +// +#define STATUS_IO_PREEMPTED ((NTSTATUS)0xC0510001L) + +// +// Shared VHDX status codes (svhdxflt.sys) +// +// +// MessageId: STATUS_SVHDX_ERROR_STORED +// +// MessageText: +// +// The proper error code with sense data was stored on server side. +// +#define STATUS_SVHDX_ERROR_STORED ((NTSTATUS)0xC05C0000L) + +// +// MessageId: STATUS_SVHDX_ERROR_NOT_AVAILABLE +// +// MessageText: +// +// The requested error data is not available on the server. +// +#define STATUS_SVHDX_ERROR_NOT_AVAILABLE ((NTSTATUS)0xC05CFF00L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_AVAILABLE +// +// MessageText: +// +// Unit Attention data is available for the initiator to query. +// +#define STATUS_SVHDX_UNIT_ATTENTION_AVAILABLE ((NTSTATUS)0xC05CFF01L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_CAPACITY_DATA_CHANGED +// +// MessageText: +// +// The data capacity of the device has changed, resulting in a Unit Attention condition. +// +#define STATUS_SVHDX_UNIT_ATTENTION_CAPACITY_DATA_CHANGED ((NTSTATUS)0xC05CFF02L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_RESERVATIONS_PREEMPTED +// +// MessageText: +// +// A previous operation resulted in this initiator's reservations being preempted, resulting in a Unit Attention condition. +// +#define STATUS_SVHDX_UNIT_ATTENTION_RESERVATIONS_PREEMPTED ((NTSTATUS)0xC05CFF03L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_RESERVATIONS_RELEASED +// +// MessageText: +// +// A previous operation resulted in this initiator's reservations being released, resulting in a Unit Attention condition. +// +#define STATUS_SVHDX_UNIT_ATTENTION_RESERVATIONS_RELEASED ((NTSTATUS)0xC05CFF04L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_REGISTRATIONS_PREEMPTED +// +// MessageText: +// +// A previous operation resulted in this initiator's registrations being preempted, resulting in a Unit Attention condition. +// +#define STATUS_SVHDX_UNIT_ATTENTION_REGISTRATIONS_PREEMPTED ((NTSTATUS)0xC05CFF05L) + +// +// MessageId: STATUS_SVHDX_UNIT_ATTENTION_OPERATING_DEFINITION_CHANGED +// +// MessageText: +// +// The data storage format of the device has changed, resulting in a Unit Attention condition. +// +#define STATUS_SVHDX_UNIT_ATTENTION_OPERATING_DEFINITION_CHANGED ((NTSTATUS)0xC05CFF06L) + +// +// MessageId: STATUS_SVHDX_RESERVATION_CONFLICT +// +// MessageText: +// +// The current initiator is not allowed to perform the SCSI command because of a reservation conflict. +// +#define STATUS_SVHDX_RESERVATION_CONFLICT ((NTSTATUS)0xC05CFF07L) + +// +// MessageId: STATUS_SVHDX_WRONG_FILE_TYPE +// +// MessageText: +// +// Multiple virtual machines sharing a virtual hard disk is supported only on Fixed or Dynamic VHDX format virtual hard disks. +// +#define STATUS_SVHDX_WRONG_FILE_TYPE ((NTSTATUS)0xC05CFF08L) + +// +// MessageId: STATUS_SVHDX_VERSION_MISMATCH +// +// MessageText: +// +// The server version does not match the requested version. +// +#define STATUS_SVHDX_VERSION_MISMATCH ((NTSTATUS)0xC05CFF09L) + +// +// MessageId: STATUS_VHD_SHARED +// +// MessageText: +// +// The requested operation cannot be performed on the virtual disk as it is currently used in shared mode. +// +#define STATUS_VHD_SHARED ((NTSTATUS)0xC05CFF0AL) + +// +// MessageId: STATUS_SVHDX_NO_INITIATOR +// +// MessageText: +// +// Invalid Shared VHDX open due to lack of initiator ID. Check for related Continuous Availability failures. +// +#define STATUS_SVHDX_NO_INITIATOR ((NTSTATUS)0xC05CFF0BL) + +// +// MessageId: STATUS_VHDSET_BACKING_STORAGE_NOT_FOUND +// +// MessageText: +// +// The requested operation failed due to a missing backing storage file. +// +#define STATUS_VHDSET_BACKING_STORAGE_NOT_FOUND ((NTSTATUS)0xC05CFF0CL) + +// +// SMB status codes +// +// +// MessageId: STATUS_SMB_NO_PREAUTH_INTEGRITY_HASH_OVERLAP +// +// MessageText: +// +// Failed to negotiate a preauthentication integrity hash function. +// +#define STATUS_SMB_NO_PREAUTH_INTEGRITY_HASH_OVERLAP ((NTSTATUS)0xC05D0000L) + +// +// MessageId: STATUS_SMB_BAD_CLUSTER_DIALECT +// +// MessageText: +// +// The current cluster functional level does not support this SMB dialect. +// +#define STATUS_SMB_BAD_CLUSTER_DIALECT ((NTSTATUS)0xC05D0001L) + +// +// MessageId: STATUS_SMB_GUEST_LOGON_BLOCKED +// +// MessageText: +// +// You can't access this shared folder because your organization's security policies block unauthenticated guest access. These policies help protect your PC from unsafe or malicious devices on the network. +// +#define STATUS_SMB_GUEST_LOGON_BLOCKED ((NTSTATUS)0xC05D0002L) + +// +// MessageId: STATUS_SMB_NO_SIGNING_ALGORITHM_OVERLAP +// +// MessageText: +// +// Failed to negotiate a signing hash function. +// +#define STATUS_SMB_NO_SIGNING_ALGORITHM_OVERLAP ((NTSTATUS)0xC05D0003L) + +// +// MessageId: STATUS_NETWORK_AUTHENTICATION_PROMPT_CANCELED +// +// MessageText: +// +// The user canceled the authentication prompt to a remote server. +// +#define STATUS_NETWORK_AUTHENTICATION_PROMPT_CANCELED ((NTSTATUS)0xC05D0004L) + +// +// MessageId: STATUS_REMOTE_MAILSLOTS_DEPRECATED +// +// MessageText: +// +// The requested operation failed. The Remote Mailslot Protocol has been disabled. +// +#define STATUS_REMOTE_MAILSLOTS_DEPRECATED ((NTSTATUS)0xC05D0005L) + +// +// MessageId: STATUS_SMB_GUEST_LOGON_BLOCKED_SIGNING_REQUIRED +// +// MessageText: +// +// You can't access this shared folder because your computer is configured to require SMB signing. These policies help protect your PC from unsafe or malicious devices on the network. +// +#define STATUS_SMB_GUEST_LOGON_BLOCKED_SIGNING_REQUIRED ((NTSTATUS)0xC05D0006L) + +// +// MessageId: STATUS_SMB_GUEST_ENCRYPTION_NOT_SUPPORTED +// +// MessageText: +// +// The requested operation failed. Encryption is not supported for guest access. +// +#define STATUS_SMB_GUEST_ENCRYPTION_NOT_SUPPORTED ((NTSTATUS)0xC05D0007L) + +// +// MessageId: STATUS_SMB_ENCRYPTION_NOT_SUPPORTED_BY_PEER +// +// MessageText: +// +// The requested operation failed. Encryption is not supported on SMB server. +// +#define STATUS_SMB_ENCRYPTION_NOT_SUPPORTED_BY_PEER ((NTSTATUS)0xC05D0008L) + +// +// MessageId: STATUS_SMB_TLS_ACCESS_DENIED +// +// MessageText: +// +// The SMB client was denied access to the SMB server during mutual authentication. +// +#define STATUS_SMB_TLS_ACCESS_DENIED ((NTSTATUS)0xC05D0009L) + +// +// Embedded Security Core +// +// Reserved id values 0x0001 - 0x00FF +// 0x8xxx +// 0x4xxx +// +// MessageId: STATUS_SECCORE_INVALID_COMMAND +// +// MessageText: +// +// The command was not recognized by the security core +// +#define STATUS_SECCORE_INVALID_COMMAND ((NTSTATUS)0xC0E80000L) + +// +// Virtual Secure Mode (VSM) +// +// +// MessageId: STATUS_VSM_NOT_INITIALIZED +// +// MessageText: +// +// Virtual Secure Mode (VSM) is not initialized. The hypervisor or VSM may not be present or enabled. +// +#define STATUS_VSM_NOT_INITIALIZED ((NTSTATUS)0xC0450000L) + +// +// MessageId: STATUS_VSM_DMA_PROTECTION_NOT_IN_USE +// +// MessageText: +// +// The hypervisor is not protecting DMA because an IOMMU is not present or not enabled in the BIOS. +// +#define STATUS_VSM_DMA_PROTECTION_NOT_IN_USE ((NTSTATUS)0xC0450001L) + +// +// MessageId: STATUS_VSM_KEY_CI_POLICY_ROLLBACK_DETECTED +// +// MessageText: +// +// The VSM encryption key could not be released because the minimum Code Integrity policy version was not met. +// +#define STATUS_VSM_KEY_CI_POLICY_ROLLBACK_DETECTED ((NTSTATUS)0xC0450002L) + +// +// MessageId: STATUS_VSMIDK_KEYGEN_FAILURE +// +// MessageText: +// +// RSA identity key generation failed. +// +#define STATUS_VSMIDK_KEYGEN_FAILURE ((NTSTATUS)0xC0450003L) + +// +// MessageId: STATUS_VSMIDK_EXPORT_FAILURE +// +// MessageText: +// +// Exporting RSA key components failed. +// +#define STATUS_VSMIDK_EXPORT_FAILURE ((NTSTATUS)0xC0450004L) + +// +// MessageId: STATUS_VSMIDK_MODULUS_MISMATCH +// +// MessageText: +// +// Exported modulus size did not match expected key size. +// +#define STATUS_VSMIDK_MODULUS_MISMATCH ((NTSTATUS)0xC0450005L) + +// +// Application Execution (AppExec) +// +// +// MessageId: STATUS_APPEXEC_CONDITION_NOT_SATISFIED +// +// MessageText: +// +// The condition supplied for the app execution request was not satisfied, so the request was not performed. +// +#define STATUS_APPEXEC_CONDITION_NOT_SATISFIED ((NTSTATUS)0xC0EC0000L) + +// +// MessageId: STATUS_APPEXEC_HANDLE_INVALIDATED +// +// MessageText: +// +// The supplied handle has been invalidated and may not be used for the requested operation. +// +#define STATUS_APPEXEC_HANDLE_INVALIDATED ((NTSTATUS)0xC0EC0001L) + +// +// MessageId: STATUS_APPEXEC_INVALID_HOST_GENERATION +// +// MessageText: +// +// The supplied host generation has been invalidated and may not be used for the requested operation. +// +#define STATUS_APPEXEC_INVALID_HOST_GENERATION ((NTSTATUS)0xC0EC0002L) + +// +// MessageId: STATUS_APPEXEC_UNEXPECTED_PROCESS_REGISTRATION +// +// MessageText: +// +// An attempt to register a process failed because the target host was not in a valid state to receive process registrations. +// +#define STATUS_APPEXEC_UNEXPECTED_PROCESS_REGISTRATION ((NTSTATUS)0xC0EC0003L) + +// +// MessageId: STATUS_APPEXEC_INVALID_HOST_STATE +// +// MessageText: +// +// The host is not in a valid state to support the execution request. +// +#define STATUS_APPEXEC_INVALID_HOST_STATE ((NTSTATUS)0xC0EC0004L) + +// +// MessageId: STATUS_APPEXEC_NO_DONOR +// +// MessageText: +// +// The operation was not completed because a required resource donor was not found for the host. +// +#define STATUS_APPEXEC_NO_DONOR ((NTSTATUS)0xC0EC0005L) + +// +// MessageId: STATUS_APPEXEC_HOST_ID_MISMATCH +// +// MessageText: +// +// The operation was not completed because an unexpected host ID was encountered. +// +#define STATUS_APPEXEC_HOST_ID_MISMATCH ((NTSTATUS)0xC0EC0006L) + +// +// MessageId: STATUS_APPEXEC_UNKNOWN_USER +// +// MessageText: +// +// The operation was not completed because the specified user was not known to the service. +// +#define STATUS_APPEXEC_UNKNOWN_USER ((NTSTATUS)0xC0EC0007L) + +// +// MessageId: STATUS_APPEXEC_APP_COMPAT_BLOCK +// +// MessageText: +// +// The application is blocked by app compat policy. +// +#define STATUS_APPEXEC_APP_COMPAT_BLOCK ((NTSTATUS)0xC0EC0008L) + +// +// MessageId: STATUS_APPEXEC_CALLER_WAIT_TIMEOUT +// +// MessageText: +// +// The caller specified wait timed out before the operation completed. +// +#define STATUS_APPEXEC_CALLER_WAIT_TIMEOUT ((NTSTATUS)0xC0EC0009L) + +// +// MessageId: STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_TERMINATION +// +// MessageText: +// +// The caller specified wait timed out before the operation completed because a host termination is in queued. +// +#define STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_TERMINATION ((NTSTATUS)0xC0EC000AL) + +// +// MessageId: STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_LICENSING +// +// MessageText: +// +// The caller specified wait timed out before the operation completed because a licensing operation is being performed. +// +#define STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_LICENSING ((NTSTATUS)0xC0EC000BL) + +// +// MessageId: STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_RESOURCES +// +// MessageText: +// +// The caller specified wait timed out before the operation completed because resources are being acquired. +// +#define STATUS_APPEXEC_CALLER_WAIT_TIMEOUT_RESOURCES ((NTSTATUS)0xC0EC000CL) + + +// +// QUIC +// + +// +// MessageId: STATUS_QUIC_HANDSHAKE_FAILURE +// +// MessageText: +// +// The QUIC connection handshake failed. +// +#define STATUS_QUIC_HANDSHAKE_FAILURE ((NTSTATUS)0xC0240000L) + +// +// MessageId: STATUS_QUIC_VER_NEG_FAILURE +// +// MessageText: +// +// The QUIC connection failed to negotiate a compatible protocol version. +// +#define STATUS_QUIC_VER_NEG_FAILURE ((NTSTATUS)0xC0240001L) + +// +// MessageId: STATUS_QUIC_USER_CANCELED +// +// MessageText: +// +// The QUIC connection was canceled by the user. +// +#define STATUS_QUIC_USER_CANCELED ((NTSTATUS)0xC0240002L) + +// +// MessageId: STATUS_QUIC_INTERNAL_ERROR +// +// MessageText: +// +// The QUIC connection encountered an internal error. +// +#define STATUS_QUIC_INTERNAL_ERROR ((NTSTATUS)0xC0240003L) + +// +// MessageId: STATUS_QUIC_PROTOCOL_VIOLATION +// +// MessageText: +// +// The QUIC connection encountered a protocol violation. +// +#define STATUS_QUIC_PROTOCOL_VIOLATION ((NTSTATUS)0xC0240004L) + +// +// MessageId: STATUS_QUIC_CONNECTION_IDLE +// +// MessageText: +// +// The QUIC connection was idle. +// +#define STATUS_QUIC_CONNECTION_IDLE ((NTSTATUS)0xC0240005L) + +// +// MessageId: STATUS_QUIC_CONNECTION_TIMEOUT +// +// MessageText: +// +// The QUIC connection timed out while trying to contact the peer. +// +#define STATUS_QUIC_CONNECTION_TIMEOUT ((NTSTATUS)0xC0240006L) + +// +// MessageId: STATUS_QUIC_ALPN_NEG_FAILURE +// +// MessageText: +// +// The QUIC connection failed to negotiate a compatible ALPN. +// +#define STATUS_QUIC_ALPN_NEG_FAILURE ((NTSTATUS)0xC0240007L) + +// +// MessageId: STATUS_QUIC_STREAM_LIMIT_REACHED +// +// MessageText: +// +// The QUIC connection failed because there are not enough streams available. +// +#define STATUS_QUIC_STREAM_LIMIT_REACHED ((NTSTATUS)0xC0240008L) + +// +// MessageId: STATUS_QUIC_ALPN_IN_USE +// +// MessageText: +// +// The QUIC connection failed because the ALPN is in use. +// +#define STATUS_QUIC_ALPN_IN_USE ((NTSTATUS)0xC0240009L) + + +// +// QUIC TLS +// + +// +// MessageId: STATUS_QUIC_TLS_UNEXPECTED_MESSAGE +// +// MessageText: +// +// The QUIC connection encountered an unexpected message during TLS. +// +#define STATUS_QUIC_TLS_UNEXPECTED_MESSAGE ((NTSTATUS)0xC024010AL) + +// +// MessageId: STATUS_QUIC_TLS_BAD_CERTIFICATE +// +// MessageText: +// +// The QUIC connection encountered a bad certificate during TLS. +// +#define STATUS_QUIC_TLS_BAD_CERTIFICATE ((NTSTATUS)0xC024012AL) + +// +// MessageId: STATUS_QUIC_TLS_UNSUPPORTED_CERTIFICATE +// +// MessageText: +// +// The QUIC connection encountered an unsupported certificate during TLS. +// +#define STATUS_QUIC_TLS_UNSUPPORTED_CERTIFICATE ((NTSTATUS)0xC024012BL) + +// +// MessageId: STATUS_QUIC_TLS_CERTIFICATE_REVOKED +// +// MessageText: +// +// The QUIC connection encountered a revoked certificate during TLS. +// +#define STATUS_QUIC_TLS_CERTIFICATE_REVOKED ((NTSTATUS)0xC024012CL) + +// +// MessageId: STATUS_QUIC_TLS_CERTIFICATE_EXPIRED +// +// MessageText: +// +// The QUIC connection encountered an expired certificate during TLS. +// +#define STATUS_QUIC_TLS_CERTIFICATE_EXPIRED ((NTSTATUS)0xC024012DL) + +// +// MessageId: STATUS_QUIC_TLS_CERTIFICATE_UNKNOWN +// +// MessageText: +// +// The QUIC connection encountered an unknown certificate during TLS. +// +#define STATUS_QUIC_TLS_CERTIFICATE_UNKNOWN ((NTSTATUS)0xC024012EL) + +// +// MessageId: STATUS_QUIC_TLS_ILLEGAL_PARAMETER +// +// MessageText: +// +// The QUIC connection encountered an illegal parameter during TLS. +// +#define STATUS_QUIC_TLS_ILLEGAL_PARAMETER ((NTSTATUS)0xC024012FL) + +// +// MessageId: STATUS_QUIC_TLS_UNKNOWN_CA +// +// MessageText: +// +// The QUIC connection encountered a certificate with an unkown certificate authority during TLS. +// +#define STATUS_QUIC_TLS_UNKNOWN_CA ((NTSTATUS)0xC0240130L) + +// +// MessageId: STATUS_QUIC_TLS_ACCESS_DENIED +// +// MessageText: +// +// The QUIC connection attempt was denied by the peer during TLS. +// +#define STATUS_QUIC_TLS_ACCESS_DENIED ((NTSTATUS)0xC0240131L) + +// +// MessageId: STATUS_QUIC_TLS_INSUFFICIENT_SECURITY +// +// MessageText: +// +// The QUIC connection security was insufficient during TLS. +// +#define STATUS_QUIC_TLS_INSUFFICIENT_SECURITY ((NTSTATUS)0xC0240147L) + +// +// MessageId: STATUS_QUIC_TLS_INTERNAL_ERROR +// +// MessageText: +// +// The QUIC connection encountered an internal error during TLS. +// +#define STATUS_QUIC_TLS_INTERNAL_ERROR ((NTSTATUS)0xC0240150L) + +// +// MessageId: STATUS_QUIC_TLS_USER_CANCELED +// +// MessageText: +// +// The QUIC connection was canceled by the user during TLS. +// +#define STATUS_QUIC_TLS_USER_CANCELED ((NTSTATUS)0xC024015AL) + +// +// MessageId: STATUS_QUIC_TLS_CERTIFICATE_REQUIRED +// +// MessageText: +// +// The QUIC connection required a certificate during TLS. +// +#define STATUS_QUIC_TLS_CERTIFICATE_REQUIRED ((NTSTATUS)0xC0240174L) + + +// +// IORING NTSTATUS codes +// + +// +// MessageId: STATUS_IORING_REQUIRED_FLAG_NOT_SUPPORTED +// +// MessageText: +// +// One or more of the required flags provided is unknown by the implementation. +// +#define STATUS_IORING_REQUIRED_FLAG_NOT_SUPPORTED ((NTSTATUS)0xC0460001L) + +// +// MessageId: STATUS_IORING_SUBMISSION_QUEUE_FULL +// +// MessageText: +// +// The submission queue is full. +// +#define STATUS_IORING_SUBMISSION_QUEUE_FULL ((NTSTATUS)0xC0460002L) + +// +// MessageId: STATUS_IORING_VERSION_NOT_SUPPORTED +// +// MessageText: +// +// The version specified is not known or supported. +// +#define STATUS_IORING_VERSION_NOT_SUPPORTED ((NTSTATUS)0xC0460003L) + +// +// MessageId: STATUS_IORING_SUBMISSION_QUEUE_TOO_BIG +// +// MessageText: +// +// The submission queue size specified for the IoRing is too big. +// +#define STATUS_IORING_SUBMISSION_QUEUE_TOO_BIG ((NTSTATUS)0xC0460004L) + +// +// MessageId: STATUS_IORING_COMPLETION_QUEUE_TOO_BIG +// +// MessageText: +// +// The completion queue size specified for the IoRing is too big. +// +#define STATUS_IORING_COMPLETION_QUEUE_TOO_BIG ((NTSTATUS)0xC0460005L) + +// +// MessageId: STATUS_IORING_SUBMIT_IN_PROGRESS +// +// MessageText: +// +// A submit operation is already in progress for this IoRing on another thread. +// +#define STATUS_IORING_SUBMIT_IN_PROGRESS ((NTSTATUS)0xC0460006L) + +// +// MessageId: STATUS_IORING_CORRUPT +// +// MessageText: +// +// The shared ring buffers of the IoRing are corrupt. +// +#define STATUS_IORING_CORRUPT ((NTSTATUS)0xC0460007L) + +// +// MessageId: STATUS_IORING_COMPLETION_QUEUE_TOO_FULL +// +// MessageText: +// +// The completion queue does not have enough free space, to post completions, for all entries being submitted. +// +#define STATUS_IORING_COMPLETION_QUEUE_TOO_FULL ((NTSTATUS)0xC0460008L) + +/*++ + + PRM specific messages. + +--*/ +// +// MessageId: STATUS_PRM_HANDLER_NOT_FOUND +// +// MessageText: +// +// The specified PRM handler was not found. +// +#define STATUS_PRM_HANDLER_NOT_FOUND ((NTSTATUS)0xC0EE0200L) + +// +// MessageId: STATUS_PRM_CONCURRENT_OPERATION +// +// MessageText: +// +// The PRM call cannot be serviced due to a concurrent PRM operation. +// +#define STATUS_PRM_CONCURRENT_OPERATION ((NTSTATUS)0xC0EE0202L) + +// +// MessageId: STATUS_PRM_MODULE_UPDATE_PENDING +// +// MessageText: +// +// The PRM call failed due to a pending module update. +// +#define STATUS_PRM_MODULE_UPDATE_PENDING ((NTSTATUS)0xC0EE0203L) + +// +// MessageId: STATUS_PRM_MODULE_LOCKED +// +// MessageText: +// +// The PRM lock operation failed because the module is already locked. +// +#define STATUS_PRM_MODULE_LOCKED ((NTSTATUS)0xC0EE0204L) + +// +// MessageId: STATUS_PRM_UPDATE_INCOMPATIBLE_VERSION +// +// MessageText: +// +// The PRM update module version number is too small to be applied. +// +#define STATUS_PRM_UPDATE_INCOMPATIBLE_VERSION ((NTSTATUS)0xC0EE0205L) + +// +// MessageId: STATUS_PRM_UPDATE_MODULE_MISMATCH +// +// MessageText: +// +// The PRM update module does not match the current version. +// +#define STATUS_PRM_UPDATE_MODULE_MISMATCH ((NTSTATUS)0xC0EE0206L) + +// +// MessageId: STATUS_PRM_UPDATE_MODULE_NOT_FOUND +// +// MessageText: +// +// The PRM update is not applicable to the base PRM implementation. +// +#define STATUS_PRM_UPDATE_MODULE_NOT_FOUND ((NTSTATUS)0xC0EE0207L) + +// +// MessageId: STATUS_PRM_UPDATE_MISSING_EXPORT +// +// MessageText: +// +// A handler export from the PRM update module cannot be found. +// +#define STATUS_PRM_UPDATE_MISSING_EXPORT ((NTSTATUS)0xC0EE0208L) + +// +// MessageId: STATUS_PRM_UPDATE_MODULE_LOCKED +// +// MessageText: +// +// The PRM update cannot be applied due to an outstanding PRM transaction. +// +#define STATUS_PRM_UPDATE_MODULE_LOCKED ((NTSTATUS)0xC0EE0209L) + +// +// MessageId: STATUS_PRM_UPDATE_BAD_SIGNATURE +// +// MessageText: +// +// The PRM update cannot be applied due to a bad PRM module signature. +// +#define STATUS_PRM_UPDATE_BAD_SIGNATURE ((NTSTATUS)0xC0EE020AL) + +// +// MessageId: STATUS_PRM_UPDATE_VERSION_MISMATCH +// +// MessageText: +// +// The PRM update service provided module version does not match that present in the actual update module header. +// +#define STATUS_PRM_UPDATE_VERSION_MISMATCH ((NTSTATUS)0xC0EE020BL) + +// +// MessageId: STATUS_PRM_MODULE_UNLOCKED +// +// MessageText: +// +// The PRM unlock operation failed because the module is already unlocked. +// +#define STATUS_PRM_MODULE_UNLOCKED ((NTSTATUS)0xC0EE020CL) + +// +// MessageId: STATUS_PRM_INTERFACE_INACCESSIBLE +// +// MessageText: +// +// The PRM driver interface is currently not accessible. +// +#define STATUS_PRM_INTERFACE_INACCESSIBLE ((NTSTATUS)0xC0EE020DL) + +/*++ + + Accelerator specific messages. + +--*/ +// +// MessageId: STATUS_ACCELERATOR_SUBMISSION_QUEUE_FULL +// +// MessageText: +// +// The accelerator submission queue is full. +// +#define STATUS_ACCELERATOR_SUBMISSION_QUEUE_FULL ((NTSTATUS)0xC0EF0001L) + + +/////////////////////////////////////////////////// +// // +// CloudAP Remote Desktop Error codes // +// // +/////////////////////////////////////////////////// + +/*++ + + Cloud authentication Remote Desktop specific messages. + +--*/ +// +// MessageId: STATUS_AAD_CLOUDAP_E_APNONCE_INVALID +// +// MessageText: +// +// The server nonce has expired. +// +#define STATUS_AAD_CLOUDAP_E_APNONCE_INVALID ((NTSTATUS)0xC0048550L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_BAD_DEVICE_ACCESS_TOKEN_FORMAT +// +// MessageText: +// +// The format of the access token is invalid. +// +#define STATUS_AAD_CLOUDAP_E_BAD_DEVICE_ACCESS_TOKEN_FORMAT ((NTSTATUS)0xC0048551L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_ASSERTION_MALFORMED +// +// MessageText: +// +// The format of the assertion is invalid. +// +#define STATUS_AAD_CLOUDAP_E_ASSERTION_MALFORMED ((NTSTATUS)0xC0048552L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_INVALID_TENANT +// +// MessageText: +// +// The Entra ID tenant specified in the server nonce or the assertion is invalid. +// +#define STATUS_AAD_CLOUDAP_E_INVALID_TENANT ((NTSTATUS)0xC0048553L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_INVALID_DEVICE +// +// MessageText: +// +// The target device specified in the server nonce or the assertion is invalid. +// +#define STATUS_AAD_CLOUDAP_E_INVALID_DEVICE ((NTSTATUS)0xC0048554L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_INVALID_ACCESS_TOKEN +// +// MessageText: +// +// The access token is invalid. +// +#define STATUS_AAD_CLOUDAP_E_INVALID_ACCESS_TOKEN ((NTSTATUS)0xC0048556L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_INVALID_BINDING_KEY_ID +// +// MessageText: +// +// The binding key specified in the assertion does not match the binding key specified in the access token. +// +#define STATUS_AAD_CLOUDAP_E_INVALID_BINDING_KEY_ID ((NTSTATUS)0xC0048557L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_CANT_FIND_ROOT_CERT +// +// MessageText: +// +// The root certificate associated with the access token's signature cannot be found. +// +#define STATUS_AAD_CLOUDAP_E_CANT_FIND_ROOT_CERT ((NTSTATUS)0xC0048559L) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_ASSERTION_INVALID +// +// MessageText: +// +// The resource URL in the assertion does not match the audience specified in the access token. +// +#define STATUS_AAD_CLOUDAP_E_ASSERTION_INVALID ((NTSTATUS)0xC004855AL) + +// +// MessageId: STATUS_AAD_CLOUDAP_E_CALLER_MISMATCH +// +// MessageText: +// +// The specified resource ID does not match the audience specified in the access token. +// +#define STATUS_AAD_CLOUDAP_E_CALLER_MISMATCH ((NTSTATUS)0xC004855BL) + +// +// Map a WIN32 error value into an NTSTATUS +// Note: This assumes that WIN32 errors fall in the range -32k to 32k. +// + +#define __NTSTATUS_FROM_WIN32(x) ((NTSTATUS)(x) <= 0 ? ((NTSTATUS)(x)) : ((NTSTATUS) (((x) & 0x0000FFFF) | (FACILITY_NTWIN32 << 16) | ERROR_SEVERITY_ERROR))) + +#ifdef INLINE_NTSTATUS_FROM_WIN32 +#ifndef __midl +__inline NTSTATUS_FROM_WIN32(long x) { return x <= 0 ? (NTSTATUS)x : (NTSTATUS) (((x) & 0x0000FFFF) | (FACILITY_NTWIN32 << 16) | ERROR_SEVERITY_ERROR);} +#else +#define NTSTATUS_FROM_WIN32(x) __NTSTATUS_FROM_WIN32(x) +#endif +#else +#define NTSTATUS_FROM_WIN32(x) __NTSTATUS_FROM_WIN32(x) +#endif + + +/*lint -restore */ // Resume checking for different macro definitions // winnt +// end_ntsecapi + +#endif // WIN32_NO_STATUS // winnt +#endif // _NTSTATUS_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.h new file mode 100644 index 0000000000000000000000000000000000000000..34cf4f608e302861dee83e1c0f0eef00e1c760ad --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.h @@ -0,0 +1,157 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +/**************************************************************************** + * * + * ntverp.H -- Version information for internal builds * + * * + * This file is only modified by the official builder to update the * + * VERSION, VER_PRODUCTVERSION, VER_PRODUCTVERSION_STR and * + * VER_PRODUCTBETA_STR values. * + * * + **************************************************************************** +/*--------------------------------------------------------------*/ +/* the following values should be modified by the official */ +/* builder for each build */ +/* */ +/* the VER_PRODUCTBUILD lines must contain the product */ +/* comments and end with the build# */ +/* */ +/* the VER_PRODUCTBETA_STR lines must contain the product */ +/* comments and end with "some string" */ +/*--------------------------------------------------------------*/ + +#if _MSC_VER > 1000 +#pragma once +#endif + + +#define VER_PRODUCTBUILD /* NT */ 10011 +#define VER_STATICPRODUCTBUILD 10011 + +#define VER_PRODUCTBUILD_QFE 16384 +#define VER_STATICPRODUCTBUILD_QFE 16384 + +// +// Several components now use NT's VER_PRODUCTBUILD and VER_PRODUCTBUILD_QFE, +// but have their own major and minor version numbers. Those folks all define +// VER_USE_OTHER_MAJOR_MINOR_VER before including ntverp.h +// +#if !defined(VER_USE_OTHER_MAJOR_MINOR_VER) + +// Postbuild will pick up these values as strings. Don't change +// the syntax of these lines without updating postbuild! +#define VER_PRODUCTMAJORVERSION 10 +#define VER_PRODUCTMINORVERSION 0 + +#define VER_PRODUCTVERSION_W (0x0A00) +#define VER_PRODUCTVERSION_DW (0x0A000000 | VER_PRODUCTBUILD) + +#endif // !VER_USE_OTHER_MAJOR_MINOR_VER + +#define VER_PRODUCTBETA_STR /* NT */ "" + +#define VER_PRODUCTVERSION_MAJORMINOR2(x,y) #x "." #y +#define VER_PRODUCTVERSION_MAJORMINOR1(x,y) VER_PRODUCTVERSION_MAJORMINOR2(x, y) +#define VER_PRODUCTVERSION_STRING VER_PRODUCTVERSION_MAJORMINOR1(VER_PRODUCTMAJORVERSION, VER_PRODUCTMINORVERSION) + +#define LVER_PRODUCTVERSION_MAJORMINOR2(x,y) L## #x L"." L## #y +#define LVER_PRODUCTVERSION_MAJORMINOR1(x,y) LVER_PRODUCTVERSION_MAJORMINOR2(x, y) +#define LVER_PRODUCTVERSION_STRING LVER_PRODUCTVERSION_MAJORMINOR1(VER_PRODUCTMAJORVERSION, VER_PRODUCTMINORVERSION) + +#define VER_PRODUCTVERSION VER_PRODUCTMAJORVERSION,VER_PRODUCTMINORVERSION,VER_PRODUCTBUILD,VER_PRODUCTBUILD_QFE + + + +/*--------------------------------------------------------------*/ +/* this value is used by third party drivers build with the DDK */ +/* and internally, to avoid version number conflicts. */ +/*--------------------------------------------------------------*/ +#define VER_DDK_PRODUCTVERSION 10,0 +#define VER_DDK_PRODUCTVERSION_STR "10.0" + +#if (VER_PRODUCTBUILD < 10) +#define VER_BPAD "000" +#elif (VER_PRODUCTBUILD < 100) +#define VER_BPAD "00" +#elif (VER_PRODUCTBUILD < 1000) +#define VER_BPAD "0" +#else +#define VER_BPAD +#endif + +#if (VER_PRODUCTBUILD < 10) +#define LVER_BPAD L"000" +#elif (VER_PRODUCTBUILD < 100) +#define LVER_BPAD L"00" +#elif (VER_PRODUCTBUILD < 1000) +#define LVER_BPAD L"0" +#else +#define LVER_BPAD +#endif + +#define VER_PRODUCTVERSION_STR4(x) VER_PRODUCTVERSION_STRING "." VER_BPAD #x +#define VER_PRODUCTVERSION_STR3(x) VER_PRODUCTVERSION_STR4(x) +#define VER_PRODUCTVERSION_STR2(x,y) VER_PRODUCTVERSION_STRING "." VER_BPAD #x "." #y +#define VER_PRODUCTVERSION_STR1(x,y) VER_PRODUCTVERSION_STR2(x, y) +#define VER_PRODUCTVERSION_STR VER_PRODUCTVERSION_STR1(VER_PRODUCTBUILD, VER_PRODUCTBUILD_QFE) + +#define LVER_PRODUCTVERSION_STR4(x) LVER_PRODUCTVERSION_STRING L"." LVER_BPAD L## #x +#define LVER_PRODUCTVERSION_STR3(x) LVER_PRODUCTVERSION_STR4(x) +#define LVER_PRODUCTVERSION_STR2(x,y) LVER_PRODUCTVERSION_STRING L"." LVER_BPAD L## #x L"." L## #y +#define LVER_PRODUCTVERSION_STR1(x,y) LVER_PRODUCTVERSION_STR2(x, y) +#define LVER_PRODUCTVERSION_STR LVER_PRODUCTVERSION_STR1(VER_PRODUCTBUILD, VER_PRODUCTBUILD_QFE) + +#define VER_PRODUCTVERSION_STRING_TWO_PARTS VER_PRODUCTVERSION_STRING +#define VER_PRODUCTVERSION_STRING_THREE_PARTS VER_PRODUCTVERSION_STR3(VER_PRODUCTBUILD) +#define VER_PRODUCTVERSION_STRING_FOUR_PARTS VER_PRODUCTVERSION_STR + +#define LVER_PRODUCTVERSION_STRING_TWO_PARTS LVER_PRODUCTVERSION_STRING +#define LVER_PRODUCTVERSION_STRING_THREE_PARTS LVER_PRODUCTVERSION_STR3(VER_PRODUCTBUILD) +#define LVER_PRODUCTVERSION_STRING_FOUR_PARTS LVER_PRODUCTVERSION_STR + +/*--------------------------------------------------------------*/ +/* the following section defines values used in the version */ +/* data structure for all files, and which do not change. */ +/*--------------------------------------------------------------*/ + +/* default is nodebug */ +#if DBG +#define VER_DEBUG VS_FF_DEBUG +#else +#define VER_DEBUG 0 +#endif + +/* default is prerelease */ +#if BETA +#define VER_PRERELEASE VS_FF_PRERELEASE +#else +#define VER_PRERELEASE 0 +#endif + +#if OFFICIAL_BUILD +#define VER_PRIVATE 0 +#else +#define VER_PRIVATE VS_FF_PRIVATEBUILD +#endif + +#define VER_FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#define VER_FILEOS VOS_NT_WINDOWS32 +#define VER_FILEFLAGS (VER_PRERELEASE|VER_DEBUG|VER_PRIVATE) + +/*--------------------------------------------------------------*/ +/* the following section defines values used in the version */ +/* info for the kits */ +/*--------------------------------------------------------------*/ + +#define VER_KITSCURVER L"Winv10.0" + +/*--------------------------------------------------------------*/ +/* the following section defines values used to define legacy */ +/* version info */ +/*--------------------------------------------------------------*/ + +#define VER_PRODUCTMAJORVERSIONWIN81 6 +#define VER_PRODUCTMINORVERSIONWIN81 3 + +#include "ntverp.ver" diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.ver b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.ver new file mode 100644 index 0000000000000000000000000000000000000000..f03f5e03a9383fbb8adff37e66bb2ba000f071fb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/ntverp.ver @@ -0,0 +1,4 @@ +#define VER_COMPANYNAME_STR "Windows (R) Win 7 DDK provider" +#define VER_PRODUCTNAME_STR "Windows (R) Win 7 DDK driver" +#define VER_LEGALTRADEMARKS_STR \ +"Windows (R) is a registered trademark of Microsoft Corporation." diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nvme.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nvme.h new file mode 100644 index 0000000000000000000000000000000000000000..ad3e9af54a5c23567d36096df056496480820c94 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/nvme.h @@ -0,0 +1,7176 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + nvme.h + +Abstract: + + NVMe command protocol related definitions + +Revision: + + Aug. 2018 - Align to NVMe spec version 1.3. + +--*/ + +#ifndef NVME_INCLUDED +#define NVME_INCLUDED + +#include + +#pragma region Desktop Family or Storage Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_STORAGE) + +#if _MSC_VER >= 1200 +#pragma once +#pragma warning(push) +#endif + +#pragma warning(disable:4214) // bit field types other than int +#pragma warning(disable:4201) // nameless struct/union +#pragma warning(disable:4200) // zero-sized array in struct/union + +//////////////////////////////////////////////////////////////////////// +// +// NVMe definitions based on 2.0 spec +// + +#define NVME_ADMINQ_ID 0 + +#define NVME_NQN_MAX_LEN 256 +#define NVME_NQN_NAME_MAX_LEN 223 + +#define NVME_CONTROLLER_ID_MIN 0x0000 +#define NVME_CONTROLLER_ID_MAX 0xFFEF +#define NVME_CONTROLLER_ID_STAT_PERSIST 0xFFFE +#define NVME_CONTROLLER_ID_DYN 0xFFFF + +// +// NVMe Controller types reported in +// CNTRLTYPE field of Identify Controller +// +typedef enum _NVME_CONTROLLER_TYPE { + + NvmeCtrlNotReported = 0x00, // Reserved (controller type not reported) + NvmeCtrlIO = 0x01, // I/O controller + NvmeCtrlDiscovery = 0x02, // Discovery controller + NvmeCtrlAdmin = 0x03, // Administrative controller + NvmeCtrlReservedMin = 0x04, + NvmeCtrlReservedMax = 0xFF + +} NVME_CONTROLLER_TYPE; + +// +// NVMe Property Offset defined in +// the Controller Properties section +// +typedef enum _NVME_PROPERTY_OFFSET { + + NvmePropCAP = 0x0000, // Controller Capabilities + NvmePropVS = 0x0008, // Version + NvmePropINTMS = 0x000C, // Interrupt Mask Set + NvmePropINTMC = 0x0010, // Interrupt Mask Clear # Note: This is incorrect in the spec. + NvmePropCC = 0x0014, // Controller Configuration + NvmePropCSTS = 0x001C, // Controller Status + NvmePropNSSR = 0x0020, // NVM Subsystem Reset + NvmePropAQA = 0x0024, // Admin Queue Attributes + NvmePropASQ = 0x0028, // Admin Submission Queue Base Address + NvmePropACQ = 0x0030, // Admin Completion Queue Base Address + NvmePropCMBLOC = 0x0038, // Controller Memory Buffer Location + NvmePropCMBSZ = 0x003C, // Controller Memory Buffer Size + NvmePropBPINFO = 0x0040, // Boot Partition Information + NvmePropBPRSEL = 0x0044, // Boot Partition Read Select + NvmePropBPMBL = 0x0048, // Boot Partition Memory Buffer Location + NvmePropCMBMSC = 0x0050, // Controller Memory Buffer Memory Space Control + NvmePropCMBSTS = 0x0058, // Controller Memory Buffer Status + NvmePropCMBEBS = 0x005C, // Controller Memory Buffer Elasticity Buffer Size + NvmePropCMBSWTP = 0x0060, // Controller Memory Buffer Sustained Write Throughput + NvmePropNSSD = 0x0064, // NVM Subsystem Shutdown + NvmePropCRTO = 0x0068, // Controller Ready Timeouts + NvmePropPMRCAP = 0x0E00, // Persistent Memory Capabilities + NvmePropPMRCTL = 0x0E04, // Persistent Memory Region Control + NvmePropPMRSTS = 0x0E08, // Persistent Memory Region Status + NvmePropPMREBS = 0x0E0C, // Persistent Memory Region Elasticity Buffer Size + NvmePropPMRSWTP = 0x0E10, // Persistent Memory Region Sustained Write Throughput + NvmePropPMRMSCL = 0x0E14, // Persistent Memory Region Controller Memory Space Control Lower + NvmePropPMRMSCU = 0x0E18 // Persistent Memory Region Controller Memory Space Control Upper + +} NVME_PROPERTY_OFFSET; + +// +// Offset 0000h: NvmePropCAP (Controller Capabilities) +// +typedef enum { + + NVME_AMS_ROUND_ROBIN = 0, + NVME_AMS_WEIGHTED_ROUND_ROBIN_URGENT = 1, + +} NVME_AMS_OPTION; + +typedef enum { + + NVME_CPS_NOT_REPORTED = 0, + NVME_CPS_CONTROLLER_SCOPE = 1, + NVME_CPS_DOMAIN_SCOPE = 2, + NVME_CPS_SUBSYSTEM_SCOPE = 3 + +} NVME_CPS_VALUE; + +typedef union { + + struct { + //LSB + + ULONGLONG MQES : 16; // RO - Bit 00-15: Maximum Queue Entries Supported (MQES) + ULONGLONG CQR : 1; // RO - Bit 16: Contiguous Queues Required (CQR) + + // Bit 17, 18 - AMS; RO - Arbitration Mechanism Supported (AMS) + ULONGLONG AMS_WeightedRoundRobinWithUrgent : 1; // Bit 17: Weighted Round Robin with Urgent; + ULONGLONG AMS_VendorSpecific : 1; // Bit 18: Vendor Specific. + + ULONGLONG Reserved0 : 5; // RO - Bit 19-23 + ULONGLONG TO : 8; // RO - Bit 24-31: Timeout (TO) + ULONGLONG DSTRD : 4; // RO - Bit 32-35: Doorbell Stride (DSTRD) + ULONGLONG NSSRS : 1; // RO - Bit 36: NVM Subsystem Reset Supported (NSSRS) + + // Bit 37 ~ 44 - CSS; RO - Command Sets Supported (CSS) + ULONGLONG CSS_NVM : 1; // Bit 37: NVM command set + ULONGLONG CSS_Reserved0 : 1; // Bit 38: Reserved + ULONGLONG CSS_Reserved1 : 1; // Bit 39: Reserved + ULONGLONG CSS_Reserved2 : 1; // Bit 40: Reserved + ULONGLONG CSS_Reserved3 : 1; // Bit 41: Reserved + ULONGLONG CSS_Reserved4 : 1; // Bit 42: Reserved + ULONGLONG CSS_MultipleIo : 1; // Bit 43: One or more IO command sets + ULONGLONG CSS_AdminOnly : 1; // Bit 44: Only Admin command set (no IO command set) + + ULONGLONG BPS : 1; // RO - Bit 45: Boot Partition Support + ULONGLONG CPS : 2; // RO - Bit 46-47: Controller Power Scope + + ULONGLONG MPSMIN : 4; // RO - Bit 48-51: Memory Page Size Minimum (MPSMIN) + ULONGLONG MPSMAX : 4; // RO - Bit 52-55: Memory Page Size Maximum (MPSMAX) + ULONGLONG PMRS : 1; // RO - Bit 56: Persistent Memory Region Supported (PMRS) + ULONGLONG CMBS : 1; // RO - Bit 57: Controller Memory Buffer Supported (CMBS) + ULONGLONG NSSS : 1; // RO - Bit 58: NVM Subsystem Shutdown Supported (NSSS) + ULONGLONG CRWMS : 1; // RO - Bit 59: Controller Ready With Media Support (CRWMS) + ULONGLONG CRIMS : 1; // RO - Bit 60: Controller Ready Independent of Media Support (CRIMS) + + ULONGLONG Reserved2 : 3; // RO - Bit 61 ~ 63 + + //MSB + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + +} NVME_CONTROLLER_CAPABILITIES, *PNVME_CONTROLLER_CAPABILITIES; + +// +// Offset 0008h: NvmePropVS (Version) +// +typedef union { + + struct { + //LSB + ULONG TER : 8; // Tertiary Version Number (TER) + ULONG MNR : 8; // Minor Version Number (MNR) + ULONG MJR : 16; // Major Version Number (MJR) + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_VERSION, *PNVME_VERSION; + +// +// Offset 0014h: NvmePropCC (Controller Configuration) +// +typedef enum { + + NVME_CC_SHN_NO_NOTIFICATION = 0, + NVME_CC_SHN_NORMAL_SHUTDOWN = 1, + NVME_CC_SHN_ABRUPT_SHUTDOWN = 2, + +} NVME_CC_SHN_SHUTDOWN_NOTIFICATIONS; + +typedef enum { + + NVME_CSS_NVM_COMMAND_SET = 0, + NVME_CSS_ALL_SUPPORTED_IO_COMMAND_SET = 6, + NVME_CSS_ADMIN_COMMAND_SET_ONLY = 7, + +} NVME_CSS_COMMAND_SETS; + +typedef union { + + struct { + //LSB + ULONG EN : 1; // RW - Enable (EN) + ULONG Reserved0 : 3; // RO + ULONG CSS : 3; // RW - I/O Command Set Selected (CSS) + ULONG MPS : 4; // RW - Memory Page Size (MPS) + ULONG AMS : 3; // RW - Arbitration Mechanism Selected (AMS) + ULONG SHN : 2; // RW - Shutdown Notification (SHN) + ULONG IOSQES : 4; // RW - I/O Submission Queue Entry Size (IOSQES) + ULONG IOCQES : 4; // RW - I/O Completion Queue Entry Size (IOCQES) + ULONG CRIME : 1; // RO/RW - Controller Ready Independent of Media Enable (CRIME). + // RO/RW depends on CAP.CRMS + ULONG Reserved1 : 7; // RO + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTROLLER_CONFIGURATION, *PNVME_CONTROLLER_CONFIGURATION; + +// +// Offset 001Ch: NvmePropCSTS (Controller Status) +// +typedef enum { + + NVME_CSTS_SHST_NO_SHUTDOWN = 0, + NVME_CSTS_SHST_SHUTDOWN_IN_PROCESS = 1, + NVME_CSTS_SHST_SHUTDOWN_COMPLETED = 2, + +} NVME_CSTS_SHST_SHUTDOWN_STATUS; + +typedef union { + + struct { + ULONG RDY : 1; // RO - Ready (RDY) + ULONG CFS : 1; // RO - Controller Fatal Status (CFS) + ULONG SHST : 2; // RO - Shutdown Status (SHST) + ULONG NSSRO : 1; // RW1C - NVM Subsystem Reset Occurred (NSSRO) + ULONG PP : 1; // RO - Processing Paused (PP) + ULONG ST : 1; // RO - Shutdown Type (ST) + + ULONG Reserved0 : 25; // RO + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTROLLER_STATUS, *PNVME_CONTROLLER_STATUS; + +// +// Offset 0020h: NvmePropNSSR (NVM Subsystem Reset) +// +typedef struct _NVME_NVM_SUBSYSTEM_RESET { + + ULONG NSSRC; // RW - NVM Subsystem Reset Control (NSSRC) + +} NVME_NVM_SUBSYSTEM_RESET, *PNVME_NVM_SUBSYSTEM_RESET; + +// +// Offset 0024h: NvmePropAQA (Admin Queue Attributes) +// +typedef union { + + struct { + //LSB + ULONG ASQS : 12; // RW - Admin Submission Queue Size (ASQS) + ULONG Reserved0 : 4; // RO + ULONG ACQS : 12; // RW - Admin Completion Queue Size (ACQS) + ULONG Reserved1 : 4; // RO + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_ADMIN_QUEUE_ATTRIBUTES, *PNVME_ADMIN_QUEUE_ATTRIBUTES; + +// +// Offset 0028h: NvmePropASQ (Admin Submission Queue Base Address) +// +typedef union { + + struct { + //LSB + ULONGLONG Reserved0 : 12; // RO + ULONGLONG ASQB : 52; // RW - Admin Submission Queue Base (ASQB) + //MSB + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + +} NVME_ADMIN_SUBMISSION_QUEUE_BASE_ADDRESS, *PNVME_ADMIN_SUBMISSION_QUEUE_BASE_ADDRESS; + +// +// Offset 0030h: NvmePropACQ (Admin Completion Queue Base Address) +// +typedef union { + + struct { + //LSB + ULONGLONG Reserved0 : 12; // RO + ULONGLONG ACQB : 52; // RW - Admin Completion Queue Base (ACQB) + //MSB + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + +} NVME_ADMIN_COMPLETION_QUEUE_BASE_ADDRESS, *PNVME_ADMIN_COMPLETION_QUEUE_BASE_ADDRESS; + +// +// Offset 0038h: NvmePropCMBLOC (Controller Memory Buffer Location) +// +typedef union { + + struct { + //LSB + ULONG BIR : 3; // RO - Base Indicator Register (BIR) + ULONG Reserved : 9; // RO + ULONG OFST : 20; // RO - Offset (OFST) + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTROLLER_MEMORY_BUFFER_LOCATION, *PNVME_CONTROLLER_MEMORY_BUFFER_LOCATION; + +// +// Offset 003Ch: NvmePropCMBSZ (Controller Memory Buffer Size) +// +typedef enum { + + NVME_CMBSZ_SIZE_UNITS_4KB = 0, + NVME_CMBSZ_SIZE_UNITS_64KB = 1, + NVME_CMBSZ_SIZE_UNITS_1MB = 2, + NVME_CMBSZ_SIZE_UNITS_16MB = 3, + NVME_CMBSZ_SIZE_UNITS_256MB = 4, + NVME_CMBSZ_SIZE_UNITS_4GB = 5, + NVME_CMBSZ_SIZE_UNITS_64GB = 6, + +} NVME_CMBSZ_SIZE_UNITS; + +typedef union { + + struct { + //LSB + ULONG SQS : 1; // RO - Submission Queue Support (SQS) + ULONG CQS : 1; // RO - Completion Queue Support (CQS) + ULONG LISTS : 1; // RO - PRP SGL List Support (LISTS) + ULONG RDS : 1; // RO - Read Data Support (RDS) + ULONG WDS : 1; // RO - Write Data Support (WDS) + ULONG Reserved : 3; // RO + ULONG SZU : 4; // RO - Size Units (SZU) + ULONG SZ : 20; // RO - Size (SZ) + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTROLLER_MEMORY_BUFFER_SIZE, *PNVME_CONTROLLER_MEMORY_BUFFER_SIZE; + + +// +// Offset 0064h: NvmePropNSSD (NVM Subsystem Shutdown) +// + +#define NVM_SUBSYSTEM_SHUTDOWN_NORMAL 0x4E726D6C +#define NVM_SUBSYSTEM_SHUTDOWN_ABRUPT 0x41627074 + +typedef struct _NVME_NVM_SUBSYSTEM_SHUTDOWN { + + ULONG NSSC; // RW - NVM Subsystem Shutdown Control (NSSRC) + +} NVME_NVM_SUBSYSTEM_SHUTDOWN, *PNVME_NVM_SUBSYSTEM_SHUTDOWN; + +// +// Offset 0068h: NvmePropCRTO (Controller Ready Timeouts) +// + +typedef union _NVME_CONTROLLER_READY_TIMEOUTS { + + struct { + + USHORT CRWMT; // RO: Controller Ready With Media Timeout + USHORT CRIMT; // RO: Controller Ready Independent of Media Timeout + + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTROLLER_READY_TIMEOUTS, *PNVME_CONTROLLER_READY_TIMEOUTS; + + +// +// Offset (1000h + ((2y) * (4 << CAP.DSTRD))): SQyTDBL (Submission Queue y Tail Doorbell) +// +typedef union { + + struct { + //LSB + ULONG SQT : 16; // RW - Submission Queue Tail (SQT) + ULONG Reserved0 : 16; // RO + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_SUBMISSION_QUEUE_TAIL_DOORBELL, *PNVME_SUBMISSION_QUEUE_TAIL_DOORBELL; + +// +// Offset (1000h + ((2y + 1) * (4 << CAP.DSTRD))): CQyHDBL (Completion Queue y Head Doorbell) +// +typedef union { + + struct { + //LSB + ULONG CQH : 16; // RW - Completion Queue Head (CQH) + ULONG Reserved0 : 16; // RO + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_COMPLETION_QUEUE_HEAD_DOORBELL, *PNVME_COMPLETION_QUEUE_HEAD_DOORBELL; + +typedef struct { + + NVME_CONTROLLER_CAPABILITIES CAP; // Controller Capabilities; 8 bytes + NVME_VERSION VS; // Version + ULONG INTMS; // Interrupt Mask Set + ULONG INTMC; // Interrupt Mask Clear + NVME_CONTROLLER_CONFIGURATION CC; // Controller Configuration + ULONG Reserved0; + NVME_CONTROLLER_STATUS CSTS; // Controller Status + NVME_NVM_SUBSYSTEM_RESET NSSR; // NVM Subsystem Reset (Optional) + + NVME_ADMIN_QUEUE_ATTRIBUTES AQA; // Admin Queue Attributes + NVME_ADMIN_SUBMISSION_QUEUE_BASE_ADDRESS ASQ; // Admin Submission Queue Base Address; 8 bytes + NVME_ADMIN_COMPLETION_QUEUE_BASE_ADDRESS ACQ; // Admin Completion Queue Base Address; 8 bytes + + NVME_CONTROLLER_MEMORY_BUFFER_LOCATION CMBLOC; // Controller Memory Buffer Location (Optional) + NVME_CONTROLLER_MEMORY_BUFFER_SIZE CMBSZ; // Controller Memory Buffer Size (Optional) + + ULONG Reserved1[9]; // 40h ~ 64h + + NVME_NVM_SUBSYSTEM_SHUTDOWN NSSD; // NVM Subsystem Shutdown + NVME_CONTROLLER_READY_TIMEOUTS CRTO; // Controller Ready Timeouts + + ULONG Reserved2[933]; // 6Ch ~ EFFh + ULONG Reserved3[64]; // F00h ~ FFFh, Command Set Specific + + ULONG Doorbells[0]; // Start of the first Doorbell register. (Admin SQ Tail Doorbell) + +} NVME_CONTROLLER_REGISTERS, *PNVME_CONTROLLER_REGISTERS; + + +// +// Command completion status +// +typedef union _NVME_COMMAND_STATUS { + + struct { + USHORT P : 1; // Phase Tag (P) + USHORT SC : 8; // Status Code (SC) + USHORT SCT : 3; // Status Code Type (SCT) + USHORT CRD : 2; // Command Retry Delay (CRD) + USHORT M : 1; // More (M) + USHORT DNR : 1; // Do Not Retry (DNR) + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + +} NVME_COMMAND_STATUS, *PNVME_COMMAND_STATUS; + +// +// Command completion entry +// +typedef struct { + + ULONG DW0; + ULONG DW1; + + union { + struct { + USHORT SQHD; // SQ Head Pointer (SQHD) + USHORT SQID; // SQ Identifier (SQID) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + } DW2; + + union { + struct { + USHORT CID; // Command Identifier (CID) + NVME_COMMAND_STATUS Status; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + } DW3; + +} NVME_COMPLETION_ENTRY, *PNVME_COMPLETION_ENTRY; + +// +// Completion entry DW0 for NVME_ADMIN_COMMAND_ASYNC_EVENT_REQUEST +// + +typedef enum { + + NVME_ASYNC_EVENT_TYPE_ERROR_STATUS = 0, + NVME_ASYNC_EVENT_TYPE_HEALTH_STATUS = 1, + NVME_ASYNC_EVENT_TYPE_NOTICE = 2, + NVME_ASYNC_EVENT_TYPE_IMMEDIATE = 3, + NVME_ASYNC_EVENT_TYPE_IO_COMMAND_SET_STATUS = 6, + NVME_ASYNC_EVENT_TYPE_VENDOR_SPECIFIC = 7, + +} NVME_ASYNC_EVENT_TYPES; + +// +// Error Status: NVME_ASYNC_EVENT_TYPE_ERROR_STATUS +// +typedef enum { + + NVME_ASYNC_ERROR_WRITE_TO_INVALID_DOORBELL_REGISTER = 0, + NVME_ASYNC_ERROR_INVALID_DOORBELL_WRITE_VALUE = 1, + NVME_ASYNC_ERROR_DIAG_FAILURE = 2, + NVME_ASYNC_ERROR_PERSISTENT_INTERNAL_DEVICE_ERROR = 3, + NVME_ASYNC_ERROR_TRANSIENT_INTERNAL_DEVICE_ERROR = 4, + NVME_ASYNC_ERROR_FIRMWARE_IMAGE_LOAD_ERROR = 5, + +} NVME_ASYNC_EVENT_ERROR_STATUS_CODES; + +// +// SMART/Health Status: NVME_ASYNC_EVENT_TYPE_HEALTH_STATUS +// +typedef enum { + + NVME_ASYNC_HEALTH_NVM_SUBSYSTEM_RELIABILITY = 0, + NVME_ASYNC_HEALTH_TEMPERATURE_THRESHOLD = 1, + NVME_ASYNC_HEALTH_SPARE_BELOW_THRESHOLD = 2, + +} NVME_ASYNC_EVENT_HEALTH_STATUS_CODES; + +// +// Notice Status: NVME_ASYNC_EVENT_TYPE_NOTICE +// +typedef enum { + + NVME_ASYNC_NOTICE_NAMESPACE_ATTRIBUTE_CHANGED = 0, + NVME_ASYNC_NOTICE_FIRMWARE_ACTIVATION_STARTING = 1, + NVME_ASYNC_NOTICE_TELEMETRY_LOG_CHANGED = 2, + NVME_ASYNC_NOTICE_ASYMMETRIC_ACCESS_CHANGE = 3, + NVME_ASYNC_NOTICE_PREDICTABLE_LATENCY_EVENT_AGGREGATE_LOG_CHANGE = 4, + NVME_ASYNC_NOTICE_LBA_STATUS_INFORMATION_ALERT = 5, + NVME_ASYNC_NOTICE_ENDURANCE_GROUP_EVENT_AGGREGATE_LOG_CHANGE = 6, + + NVME_ASYNC_NOTICE_ZONE_DESCRIPTOR_CHANGED = 0xEF, + NVME_ASYNC_NOTICE_DISCOVERY_LOG_PAGE_CHANGED = 0xF0, + +} NVME_ASYNC_EVENT_NOTICE_CODES; + +// +// Immediate Status: NVME_ASYNC_EVENT_TYPE_IMMEDIATE +// +typedef enum { + + NVME_ASYNC_IMMEDIATE_NVM_SUBSYSTEM_NORMAL_SHUTDOWN = 0, + +} NVME_ASYNC_EVENT_IMMEDIATE_STATUS_CODES; + +// +// NVM Command Set Status: NVME_ASYNC_EVENT_TYPE_IO_COMMAND_SET_STATUS +// +typedef enum { + + NVME_ASYNC_IO_CMD_SET_RESERVATION_LOG_PAGE_AVAILABLE = 0, + NVME_ASYNC_IO_CMD_SANITIZE_OPERATION_COMPLETED = 1, + NVME_ASYNC_IO_CMD_SANITIZE_OPERATION_COMPLETED_WITH_UNEXPECTED_DEALLOCATION = 2, + +} NVME_ASYNC_EVENT_IO_COMMAND_SET_STATUS_CODES; + + +typedef struct { + + ULONG AsyncEventType : 3; + ULONG Reserved0 : 5; + ULONG AsyncEventInfo : 8; + ULONG LogPage : 8; + ULONG Reserved1 : 8; + +} NVME_COMPLETION_DW0_ASYNC_EVENT_REQUEST, *PNVME_COMPLETION_DW0_ASYNC_EVENT_REQUEST; + + + +// +// Status Code Type (SCT) +// +typedef enum { + + NVME_STATUS_TYPE_GENERIC_COMMAND = 0, + NVME_STATUS_TYPE_COMMAND_SPECIFIC = 1, + NVME_STATUS_TYPE_MEDIA_ERROR = 2, + NVME_STATUS_TYPE_PATH_RELATED = 3, + NVME_STATUS_TYPE_VENDOR_SPECIFIC = 7, + +} NVME_STATUS_TYPES; + +// +// Status Code (SC) of NVME_STATUS_TYPE_GENERIC_COMMAND +// +typedef enum { + + NVME_STATUS_SUCCESS_COMPLETION = 0x00, + NVME_STATUS_INVALID_COMMAND_OPCODE = 0x01, + NVME_STATUS_INVALID_FIELD_IN_COMMAND = 0x02, + NVME_STATUS_COMMAND_ID_CONFLICT = 0x03, + NVME_STATUS_DATA_TRANSFER_ERROR = 0x04, + NVME_STATUS_COMMAND_ABORTED_DUE_TO_POWER_LOSS_NOTIFICATION = 0x05, + NVME_STATUS_INTERNAL_DEVICE_ERROR = 0x06, + NVME_STATUS_COMMAND_ABORT_REQUESTED = 0x07, + NVME_STATUS_COMMAND_ABORTED_DUE_TO_SQ_DELETION = 0x08, + NVME_STATUS_COMMAND_ABORTED_DUE_TO_FAILED_FUSED_COMMAND = 0x09, + NVME_STATUS_COMMAND_ABORTED_DUE_TO_FAILED_MISSING_COMMAND = 0x0A, + NVME_STATUS_INVALID_NAMESPACE_OR_FORMAT = 0x0B, + NVME_STATUS_COMMAND_SEQUENCE_ERROR = 0x0C, + NVME_STATUS_INVALID_SGL_LAST_SEGMENT_DESCR = 0x0D, + NVME_STATUS_INVALID_NUMBER_OF_SGL_DESCR = 0x0E, + NVME_STATUS_DATA_SGL_LENGTH_INVALID = 0x0F, + NVME_STATUS_METADATA_SGL_LENGTH_INVALID = 0x10, + NVME_STATUS_SGL_DESCR_TYPE_INVALID = 0x11, + NVME_STATUS_INVALID_USE_OF_CONTROLLER_MEMORY_BUFFER = 0x12, + NVME_STATUS_PRP_OFFSET_INVALID = 0x13, + NVME_STATUS_ATOMIC_WRITE_UNIT_EXCEEDED = 0x14, + NVME_STATUS_OPERATION_DENIED = 0x15, + NVME_STATUS_SGL_OFFSET_INVALID = 0x16, + NVME_STATUS_RESERVED = 0x17, + NVME_STATUS_HOST_IDENTIFIER_INCONSISTENT_FORMAT = 0x18, + NVME_STATUS_KEEP_ALIVE_TIMEOUT_EXPIRED = 0x19, + NVME_STATUS_KEEP_ALIVE_TIMEOUT_INVALID = 0x1A, + NVME_STATUS_COMMAND_ABORTED_DUE_TO_PREEMPT_ABORT = 0x1B, + NVME_STATUS_SANITIZE_FAILED = 0x1C, + NVME_STATUS_SANITIZE_IN_PROGRESS = 0x1D, + NVME_STATUS_SGL_DATA_BLOCK_GRANULARITY_INVALID = 0x1E, + NVME_STATUS_COMMAND_NOT_SUPPORTED_FOR_QUEUE_IN_CMB = 0x1F, + NVME_STATUS_NAMESPACE_IS_WRITE_PROTECTED = 0x20, + NVME_STATUS_COMMAND_INTERRUPTED = 0x21, + NVME_STATUS_TRANSIENT_TRANSPORT_ERROR = 0x22, + NVME_STATUS_COMMAND_PROHIBITED_BY_LOCKDOWN = 0x23, + NVME_STATUS_ADMIN_COMMAND_MEDIA_NOT_READY = 0x24, + + NVME_STATUS_DIRECTIVE_TYPE_INVALID = 0x70, + NVME_STATUS_DIRECTIVE_ID_INVALID = 0x71, + + NVME_STATUS_NVM_LBA_OUT_OF_RANGE = 0x80, + NVME_STATUS_NVM_CAPACITY_EXCEEDED = 0x81, + NVME_STATUS_NVM_NAMESPACE_NOT_READY = 0x82, + NVME_STATUS_NVM_RESERVATION_CONFLICT = 0x83, + NVME_STATUS_FORMAT_IN_PROGRESS = 0x84, + +} NVME_STATUS_GENERIC_COMMAND_CODES; + +// +// Status Code (SC) of NVME_STATUS_TYPE_COMMAND_SPECIFIC +// +typedef enum { + + NVME_STATUS_COMPLETION_QUEUE_INVALID = 0x00, // Create I/O Submission Queue + NVME_STATUS_INVALID_QUEUE_IDENTIFIER = 0x01, // Create I/O Submission Queue, Create I/O Completion Queue, Delete I/O Completion Queue, Delete I/O Submission Queue + NVME_STATUS_MAX_QUEUE_SIZE_EXCEEDED = 0x02, // Create I/O Submission Queue, Create I/O Completion Queue + NVME_STATUS_ABORT_COMMAND_LIMIT_EXCEEDED = 0x03, // Abort + NVME_STATUS_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED = 0x05, // Asynchronous Event Request + NVME_STATUS_INVALID_FIRMWARE_SLOT = 0x06, // Firmware Commit + NVME_STATUS_INVALID_FIRMWARE_IMAGE = 0x07, // Firmware Commit + NVME_STATUS_INVALID_INTERRUPT_VECTOR = 0x08, // Create I/O Completion Queue + NVME_STATUS_INVALID_LOG_PAGE = 0x09, // Get Log Page + NVME_STATUS_INVALID_FORMAT = 0x0A, // Format NVM, Namespace Management + NVME_STATUS_FIRMWARE_ACTIVATION_REQUIRES_CONVENTIONAL_RESET = 0x0B, // Firmware Commit, Sanitize + NVME_STATUS_INVALID_QUEUE_DELETION = 0x0C, // Delete I/O Completion Queue + NVME_STATUS_FEATURE_ID_NOT_SAVEABLE = 0x0D, // Set Features + NVME_STATUS_FEATURE_NOT_CHANGEABLE = 0x0E, // Set Features + NVME_STATUS_FEATURE_NOT_NAMESPACE_SPECIFIC = 0x0F, // Set Features + NVME_STATUS_FIRMWARE_ACTIVATION_REQUIRES_NVM_SUBSYSTEM_RESET = 0x10, // Firmware Commit, Sanitize + NVME_STATUS_FIRMWARE_ACTIVATION_REQUIRES_RESET = 0x11, // Firmware Commit, Sanitize + NVME_STATUS_FIRMWARE_ACTIVATION_REQUIRES_MAX_TIME_VIOLATION = 0x12, // Firmware Commit + NVME_STATUS_FIRMWARE_ACTIVATION_PROHIBITED = 0x13, // Firmware Commit + NVME_STATUS_OVERLAPPING_RANGE = 0x14, // Firmware Commit, Firmware Image Download, Set Features + + NVME_STATUS_NAMESPACE_INSUFFICIENT_CAPACITY = 0x15, // Namespace Management + NVME_STATUS_NAMESPACE_IDENTIFIER_UNAVAILABLE = 0x16, // Namespace Management + NVME_STATUS_NAMESPACE_ALREADY_ATTACHED = 0x18, // Namespace Attachment + NVME_STATUS_NAMESPACE_IS_PRIVATE = 0x19, // Namespace Attachment + NVME_STATUS_NAMESPACE_NOT_ATTACHED = 0x1A, // Namespace Attachment + NVME_STATUS_NAMESPACE_THIN_PROVISIONING_NOT_SUPPORTED = 0x1B, // Namespace Management + NVME_STATUS_CONTROLLER_LIST_INVALID = 0x1C, // Namespace Attachment + + NVME_STATUS_DEVICE_SELF_TEST_IN_PROGRESS = 0x1D, // Device Self-test + + NVME_STATUS_BOOT_PARTITION_WRITE_PROHIBITED = 0x1E, // Firmware Commit + + NVME_STATUS_INVALID_CONTROLLER_IDENTIFIER = 0x1F, // Virtualization Management + NVME_STATUS_INVALID_SECONDARY_CONTROLLER_STATE = 0x20, // Virtualization Management + NVME_STATUS_INVALID_NUMBER_OF_CONTROLLER_RESOURCES = 0x21, // Virtualization Management + NVME_STATUS_INVALID_RESOURCE_IDENTIFIER = 0x22, // Virtualization Management + + NVME_STATUS_SANITIZE_PROHIBITED_ON_PERSISTENT_MEMORY = 0x23, // Sanitize + + NVME_STATUS_INVALID_ANA_GROUP_IDENTIFIER = 0x24, // Namespace Management + NVME_STATUS_ANA_ATTACH_FAILED = 0x25, // Namespace Attachment + NVME_STATUS_INSUFFICIENT_CAPACITY = 0x26, // Capacity Management + NVME_STATUS_NAMESPACE_ATTACHMENT_LIMIT_EXCEEDED = 0x27, // Namespace Attachment + NVME_STATUS_PROHIBITION_NOT_SUPPORTED = 0x28, // Lockdown + + NVME_IO_COMMAND_SET_NOT_SUPPORTED = 0x29, // Namespace Attachment/Management, Get Log Page + NVME_IO_COMMAND_SET_NOT_ENABLED = 0x2A, // Namespace Attachment + NVME_IO_COMMAND_SET_COMBINATION_REJECTED = 0x2B, // Set Features + NVME_IO_COMMAND_SET_INVALID = 0x2C, // Identify, Namespace Management + + NVME_STATUS_INVALID_DISCOVERY_INFORMATION = 0x2F, // Discovery Information Management + NVME_STATUS_INSUFFICIENT_DISCOVERY_RESOURCES = 0x32, // Discovery Information Management + + NVME_STATUS_STREAM_RESOURCE_ALLOCATION_FAILED = 0x7F, // Streams Directive + NVME_STATUS_ZONE_INVALID_FORMAT = 0x7F, // Namespace Management + + NVME_STATUS_NVM_CONFLICTING_ATTRIBUTES = 0x80, // Dataset Management, Read, Write + NVME_STATUS_NVM_INVALID_PROTECTION_INFORMATION = 0x81, // Compare, Read, Write, Write Zeroes, Verify + NVME_STATUS_NVM_ATTEMPTED_WRITE_TO_READ_ONLY_RANGE = 0x82, // Dataset Management, Write, Write Uncorrectable, Write Zeroes + NVME_STATUS_NVM_COMMAND_SIZE_LIMIT_EXCEEDED = 0x83, // Dataset Management + + NVME_STATUS_ZONE_BOUNDARY_ERROR = 0xB8, // Compare, Read, Verify, Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append + NVME_STATUS_ZONE_FULL = 0xB9, // Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append + NVME_STATUS_ZONE_READ_ONLY = 0xBA, // Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append + NVME_STATUS_ZONE_OFFLINE = 0xBB, // Compare, Read, Verify, Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append + NVME_STATUS_ZONE_INVALID_WRITE = 0xBC, // Write, Write Uncorrectable, Write Zeroes, Copy + NVME_STATUS_ZONE_TOO_MANY_ACTIVE = 0xBD, // Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append, Zone Management Send + NVME_STATUS_ZONE_TOO_MANY_OPEN = 0xBE, // Write, Write Uncorrectable, Write Zeroes, Copy, Zone Append, Zone Management Send + NVME_STATUS_ZONE_INVALID_STATE_TRANSITION = 0xBF, // Zone Management Send + +} NVME_STATUS_COMMAND_SPECIFIC_CODES; + +// +// Status Code (SC) of NVME_STATUS_TYPE_COMMAND_SPECIFIC, Fabrics Commands (NVME_ADMIN_COMMAND_FABRICS) +// +typedef enum { + + NVME_STATUS_INCOMPATIBLE_FORMAT = 0x80, // Connect, Disconnect + NVME_STATUS_CONTROLLER_BUSY = 0x81, // Connect, Disconnect + NVME_STATUS_CONNECT_INVALID_PARAMETERS = 0x82, // Connect + NVME_STATUS_CONNECT_RESTART_DISCOVERY = 0x83, // Connect + NVME_STATUS_CONNECT_INVALID_HOST = 0x84, // Connect + NVME_STATUS_INVALID_QUEUE_TYPE = 0x85, // Disconnect + + NVME_STATUS_DISCOVER_RESTART = 0x90, // Get Log Page + NVME_STATUS_AUTHENTICATION_REQUIRED = 0x91, // Queue has not yet been authenticated, in-band authentication is required + +} NVME_STATUS_FABRIC_COMMAND_CODES; + +// +// Status Code (SC) of NVME_STATUS_TYPE_PATH_RELATED +// +typedef enum { + + NVME_STATUS_INTERNAL_PATH_ERROR = 0x00, + NVME_STATUS_ASYMMETRIC_ACCESS_PERSISTENT_LOSS = 0x01, + NVME_STATUS_ASYMMETRIC_ACCESS_INACCESSIBLE = 0x02, + NVME_STATUS_ASYMMETRIC_ACCESS_TRANSITION = 0x03, + + NVME_STATUS_CONTROLLER_PATHING_ERROR = 0x60, + + NVME_STATUS_HOST_PATHING_ERROR = 0x70, + NVME_STATUS_COMMAND_ABORTED_BY_HOST = 0x71, + +} NVME_STATUS_PATH_ERROR_CODES; + +// +// Status Code (SC) of NVME_STATUS_TYPE_MEDIA_ERROR +// +typedef enum { + + NVME_STATUS_NVM_WRITE_FAULT = 0x80, + NVME_STATUS_NVM_UNRECOVERED_READ_ERROR = 0x81, + NVME_STATUS_NVM_END_TO_END_GUARD_CHECK_ERROR = 0x82, + NVME_STATUS_NVM_END_TO_END_APPLICATION_TAG_CHECK_ERROR = 0x83, + NVME_STATUS_NVM_END_TO_END_REFERENCE_TAG_CHECK_ERROR = 0x84, + NVME_STATUS_NVM_COMPARE_FAILURE = 0x85, + NVME_STATUS_NVM_ACCESS_DENIED = 0x86, + NVME_STATUS_NVM_DEALLOCATED_OR_UNWRITTEN_LOGICAL_BLOCK = 0x87, + +} NVME_STATUS_MEDIA_ERROR_CODES; + +// +// Admin Command Set +// +typedef enum { + + NVME_ADMIN_COMMAND_DELETE_IO_SQ = 0x00, + NVME_ADMIN_COMMAND_CREATE_IO_SQ = 0x01, + NVME_ADMIN_COMMAND_GET_LOG_PAGE = 0x02, + NVME_ADMIN_COMMAND_DELETE_IO_CQ = 0x04, + NVME_ADMIN_COMMAND_CREATE_IO_CQ = 0x05, + NVME_ADMIN_COMMAND_IDENTIFY = 0x06, + NVME_ADMIN_COMMAND_ABORT = 0x08, + NVME_ADMIN_COMMAND_SET_FEATURES = 0x09, + NVME_ADMIN_COMMAND_GET_FEATURES = 0x0A, + NVME_ADMIN_COMMAND_ASYNC_EVENT_REQUEST = 0x0C, + NVME_ADMIN_COMMAND_NAMESPACE_MANAGEMENT = 0x0D, + + NVME_ADMIN_COMMAND_FIRMWARE_ACTIVATE = 0x10, + NVME_ADMIN_COMMAND_FIRMWARE_COMMIT = 0x10, // "Firmware Activate" command has been renamed to "Firmware Commit" command in spec v1.2 + NVME_ADMIN_COMMAND_FIRMWARE_IMAGE_DOWNLOAD = 0x11, + NVME_ADMIN_COMMAND_DEVICE_SELF_TEST = 0x14, + NVME_ADMIN_COMMAND_NAMESPACE_ATTACHMENT = 0x15, + + NVME_ADMIN_COMMAND_KEEP_ALIVE = 0x18, + NVME_ADMIN_COMMAND_DIRECTIVE_SEND = 0x19, + NVME_ADMIN_COMMAND_DIRECTIVE_RECEIVE = 0x1A, + NVME_ADMIN_COMMAND_VIRTUALIZATION_MANAGEMENT= 0x1C, + NVME_ADMIN_COMMAND_NVME_MI_SEND = 0x1D, + NVME_ADMIN_COMMAND_NVME_MI_RECEIVE = 0x1E, + + NVME_ADMIN_COMMAND_DISCOVERY_INFO_MGMT = 0x21, + + NVME_ADMIN_COMMAND_DOORBELL_BUFFER_CONFIG = 0x7C, + + NVME_ADMIN_COMMAND_FABRICS = 0x7F, + + NVME_ADMIN_COMMAND_FORMAT_NVM = 0x80, + NVME_ADMIN_COMMAND_SECURITY_SEND = 0x81, + NVME_ADMIN_COMMAND_SECURITY_RECEIVE = 0x82, + NVME_ADMIN_COMMAND_SANITIZE = 0x84, + NVME_ADMIN_COMMAND_GET_LBA_STATUS = 0x86, + +} NVME_ADMIN_COMMANDS; + +// +// Features for Get/Set Features command +// +typedef enum { + + NVME_FEATURE_ARBITRATION = 0x01, + NVME_FEATURE_POWER_MANAGEMENT = 0x02, + NVME_FEATURE_LBA_RANGE_TYPE = 0x03, + NVME_FEATURE_TEMPERATURE_THRESHOLD = 0x04, + NVME_FEATURE_ERROR_RECOVERY = 0x05, + NVME_FEATURE_VOLATILE_WRITE_CACHE = 0x06, + NVME_FEATURE_NUMBER_OF_QUEUES = 0x07, + NVME_FEATURE_INTERRUPT_COALESCING = 0x08, + NVME_FEATURE_INTERRUPT_VECTOR_CONFIG = 0x09, + NVME_FEATURE_WRITE_ATOMICITY = 0x0A, + NVME_FEATURE_ASYNC_EVENT_CONFIG = 0x0B, + NVME_FEATURE_AUTONOMOUS_POWER_STATE_TRANSITION = 0x0C, + NVME_FEATURE_HOST_MEMORY_BUFFER = 0x0D, + NVME_FEATURE_TIMESTAMP = 0x0E, + NVME_FEATURE_KEEP_ALIVE = 0x0F, + NVME_FEATURE_HOST_CONTROLLED_THERMAL_MANAGEMENT = 0x10, + NVME_FEATURE_NONOPERATIONAL_POWER_STATE = 0x11, + NVME_FEATURE_READ_RECOVERY_LEVEL_CONFIG = 0x12, + NVME_FEATURE_PREDICTABLE_LATENCY_MODE_CONFIG = 0x13, + NVME_FEATURE_PREDICTABLE_LATENCY_MODE_WINDOW = 0x14, + NVME_FEATURE_LBA_STATUS_INFORMATION_REPORT_INTERVAL = 0x15, + NVME_FEATURE_HOST_BEHAVIOR_SUPPORT = 0x16, + NVME_FEATURE_SANITIZE_CONFIG = 0x17, + NVME_FEATURE_ENDURANCE_GROUP_EVENT_CONFIG = 0x18, + NVME_FEATURE_IO_COMMAND_SET_PROFILE = 0x19, + + NVME_FEATURE_ENHANCED_CONTROLLER_METADATA = 0x7D, + NVME_FEATURE_CONTROLLER_METADATA = 0x7E, + NVME_FEATURE_NAMESPACE_METADATA = 0x7F, + + NVME_FEATURE_NVM_SOFTWARE_PROGRESS_MARKER = 0x80, + NVME_FEATURE_NVM_HOST_IDENTIFIER = 0x81, + NVME_FEATURE_NVM_RESERVATION_NOTIFICATION_MASK = 0x82, + NVME_FEATURE_NVM_RESERVATION_PERSISTANCE = 0x83, + NVME_FEATURE_NVM_NAMESPACE_WRITE_PROTECTION_CONFIG = 0x84, + + NVME_FEATURE_ERROR_INJECTION = 0xC0, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_CLEAR_FW_UPDATE_HISTORY = 0xC1, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_READONLY_WRITETHROUGH_MODE = 0xC2, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_CLEAR_PCIE_CORRECTABLE_ERROR_COUNTERS = 0xC3, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_ENABLE_IEEE1667_SILO = 0xC4, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_LATENCY_MONITOR = 0xC5, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_PLP_HEALTH_CHECK_INTERVAL = 0xC6, // This is from OCP NVMe Cloud SSD spec. + NVME_FEATURE_DSSD_POWER_STATE = 0xC7, // This is from OCP NVMe Cloud SSD spec. + +} NVME_FEATURES; + + +// +// Abort command: parameter +// +typedef union { + + struct { + ULONG SQID : 8; // Submission Queue Identifier (SQID) + ULONG CID : 16; // Command Identifier (CID) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_ABORT, *PNVME_CDW10_ABORT; + +// +// Identify Command of Controller or Namespace Structure (CNS) +// +typedef enum { + + NVME_IDENTIFY_CNS_SPECIFIC_NAMESPACE = 0x0, + NVME_IDENTIFY_CNS_CONTROLLER = 0x1, + NVME_IDENTIFY_CNS_ACTIVE_NAMESPACES = 0x2, // A list of up to 1024 active namespace IDs is returned to the host containing active namespaces with a namespace identifier greater than the value specified in the Namespace Identifier (CDW1.NSID) field. + NVME_IDENTIFY_CNS_DESCRIPTOR_NAMESPACE = 0x3, + NVME_IDENTIFY_CNS_NVM_SET = 0x4, + + NVME_IDENTIFY_CNS_SPECIFIC_NAMESPACE_IO_COMMAND_SET = 0x5, + NVME_IDENTIFY_CNS_SPECIFIC_CONTROLLER_IO_COMMAND_SET = 0x6, + NVME_IDENTIFY_CNS_ACTIVE_NAMESPACE_LIST_IO_COMMAND_SET = 0x7, + + NVME_IDENTIFY_CNS_ALLOCATED_NAMESPACE_LIST = 0x10, + NVME_IDENTIFY_CNS_ALLOCATED_NAMESPACE = 0x11, + NVME_IDENTIFY_CNS_CONTROLLER_LIST_OF_NSID = 0x12, + NVME_IDENTIFY_CNS_CONTROLLER_LIST_OF_NVM_SUBSYSTEM = 0x13, + NVME_IDENTIFY_CNS_PRIMARY_CONTROLLER_CAPABILITIES = 0x14, + NVME_IDENTIFY_CNS_SECONDARY_CONTROLLER_LIST = 0x15, + NVME_IDENTIFY_CNS_NAMESPACE_GRANULARITY_LIST = 0x16, + NVME_IDENTIFY_CNS_UUID_LIST = 0x17, + NVME_IDENTIFY_CNS_DOMAIN_LIST = 0x18, + NVME_IDENTIFY_CNS_ENDURANCE_GROUP_LIST = 0x19, + + NVME_IDENTIFY_CNS_ALLOCATED_NAMSPACE_LIST_IO_COMMAND_SET= 0x1A, + NVME_IDENTIFY_CNS_ALLOCATED_NAMESPACE_IO_COMMAND_SET = 0x1B, + NVME_IDENTIFY_CNS_IO_COMMAND_SET = 0x1C, + +} NVME_IDENTIFY_CNS_CODES; + +// +// Identify Command Set Identifiers (CSI) +// +typedef enum { + NVME_COMMAND_SET_NVM = 0x0, + NVME_COMMAND_SET_KEY_VALUE = 0x1, + NVME_COMMAND_SET_ZONED_NAMESPACE = 0x2, +} NVME_COMMAND_SET_IDENTIFIERS; + +typedef union { + + struct { + ULONG CNS : 8; // Controller or Namespace Structure (CNS, Defined in NVME_IDENTIFY_CNS_CODES) + ULONG Reserved : 8; + ULONG CNTID : 16; // Controller Identifier (CNTID) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_IDENTIFY, *PNVME_CDW10_IDENTIFY; + +typedef union { + + struct { + USHORT NVMSETID; // NVM Set Identifier + USHORT Reserved; + } DUMMYSTRUCTNAME; + + struct { + ULONG CNSID : 16; // CNS Specific Identifier (NVM Set ID/Domain ID/Endurance Group ID) + ULONG Reserved2 : 8; + ULONG CSI : 8; // Command Set Identifier (CSI, Defined in NVME_COMMAND_SET_IDENTIFIERS) + } DUMMYSTRUCTNAME2; + + ULONG AsUlong; + +} NVME_CDW11_IDENTIFY, *PNVME_CDW11_IDENTIFY; + +typedef union { + + struct { + ULONG UUIDIndex : 7; // Bits 06:00 + ULONG Reserved : 25; // Bits 31:07 + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW14_IDENTIFY, *PNVME_CDW14_IDENTIFY; + +// +// Output of NVME_IDENTIFY_CNS_SPECIFIC_NAMESPACE (0x0) +// + +typedef enum { + NVME_READ_BEHAVIOR_NOT_REPORTED = 0x0, + NVME_READ_BEHAVIOR_RETURN_ZERO = 0x1, + NVME_READ_BEHAVIOR_RETURN_ONES = 0x2 +} NVME_DEALLOCATE_READ_BEHAVIOR; + +typedef union { + + struct { + USHORT MS; // bit 0:15 Metadata Size (MS) + UCHAR LBADS; // bit 16:23 LBA Data Size (LBADS) + + UCHAR RP : 2; // bit 24:25 Relative Performance (RP) + UCHAR Reserved0 : 6; // bit 26:31 + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_LBA_FORMAT, *PNVME_LBA_FORMAT; + +typedef union { + + struct { + UCHAR PersistThroughPowerLoss : 1; + UCHAR WriteExclusiveReservation : 1; + UCHAR ExclusiveAccessReservation : 1; + UCHAR WriteExclusiveRegistrantsOnlyReservation : 1; + UCHAR ExclusiveAccessRegistrantsOnlyReservation : 1; + UCHAR WriteExclusiveAllRegistrantsReservation : 1; + UCHAR ExclusiveAccessAllRegistrantsReservation : 1; + UCHAR Reserved : 1; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; +} NVM_RESERVATION_CAPABILITIES, *PNVME_RESERVATION_CAPABILITIES; + +typedef struct { + + ULONGLONG NSZE; // byte 0:7. M - Namespace Size (NSZE) + ULONGLONG NCAP; // byte 8:15 M - Namespace Capacity (NCAP) + ULONGLONG NUSE; // byte 16:23 M - Namespace Utilization (NUSE) + + struct { + UCHAR ThinProvisioning : 1; + UCHAR NameSpaceAtomicWriteUnit : 1; + UCHAR DeallocatedOrUnwrittenError : 1; + UCHAR SkipReuseUI : 1; + UCHAR NameSpaceIoOptimization : 1; + UCHAR Reserved : 3; + } NSFEAT; // byte 24 M - Namespace Features (NSFEAT) + + UCHAR NLBAF; // byte 25 M - Number of LBA Formats (NLBAF) + + struct { + UCHAR LbaFormatIndex : 4; + UCHAR MetadataInExtendedDataLBA : 1; + UCHAR LbaFormatIndexMS : 2; + UCHAR Reserved : 1; + } FLBAS; // byte 26 M - Formatted LBA Size (FLBAS) + + struct { + UCHAR MetadataInExtendedDataLBA : 1; + UCHAR MetadataInSeparateBuffer : 1; + UCHAR Reserved : 6; + } MC; // byte 27 M - Metadata Capabilities (MC) + + struct { + UCHAR ProtectionInfoType1 : 1; + UCHAR ProtectionInfoType2 : 1; + UCHAR ProtectionInfoType3 : 1; + UCHAR InfoAtBeginningOfMetadata : 1; + UCHAR InfoAtEndOfMetadata : 1; + UCHAR Reserved : 3; + } DPC; // byte 28 M - End-to-end Data Protection Capabilities (DPC) + + struct { + UCHAR ProtectionInfoTypeEnabled : 3; // 0 - not enabled; 1 ~ 3: enabled type; 4 ~ 7: reserved + UCHAR InfoAtBeginningOfMetadata : 1; + UCHAR Reserved : 4; + } DPS; // byte 29 M - End-to-end Data Protection Type Settings (DPS) + + struct { + UCHAR SharedNameSpace : 1; + UCHAR Reserved : 7; + } NMIC; // byte 30 O - Namespace Multi-path I/O and Namespace Sharing Capabilities (NMIC) + + NVM_RESERVATION_CAPABILITIES RESCAP; // byte 31 O - Reservation Capabilities (RESCAP) + + struct { + UCHAR PercentageRemained : 7;// Bits 6:0: indicate the percentage of the namespace that remains to be formatted + UCHAR Supported : 1;// Bit 7: if set to 1 indicates that the namespace supports the Format Progress Indicator. + } FPI; // byte 32 O - Format Progress Indicator (FPI) + + struct { + UCHAR ReadBehavior : 3;// Bits 2:0: indicate deallocated logical block read behavior (NVME_DEALLOCATE_READ_BEHAVIOR) + UCHAR WriteZeroes : 1;// Bit 3: indicate controller supports the deallocate bit in Write Zeroes + UCHAR GuardFieldWithCRC : 1;// Bit 4: indicate guard field for deallocated logical blocks is set to CRC + UCHAR Reserved : 3; + } DLFEAT; // byte 33 + + USHORT NAWUN; // byte 34:35 O - Namespace Atomic Write Unit Normal (NAWUN) + USHORT NAWUPF; // byte 36:37 O - Namespace Atomic Write Unit Power Fail (NAWUPF) + USHORT NACWU; // byte 38:39 O - Namespace Atomic Compare & Write Unit (NACWU) + USHORT NABSN; // byte 40:41 O - Namespace Atomic Boundary Size Normal (NABSN) + USHORT NABO; // byte 42:43 O - Namespace Atomic Boundary Offset (NABO) + USHORT NABSPF; // byte 44:45 O - Namespace Atomic Boundary Size Power Fail (NABSPF) + USHORT NOIOB; // byte 46:47 O - Namespace Optimal IO Boundary (NOIOB) + + UCHAR NVMCAP[16]; // byte 48:63 O - NVM Capacity (NVMCAP) + + USHORT NPWG; // byte 64:65 O - Namespace Preferred Write Granularity (NPWG) + USHORT NPWA; // byte 66:67 O - Namespace Preferred Write Alignment (NPWA) + USHORT NPDG; // byte 68:69 O - Namespace Preferred Deallocate Granularity (NPDG) + USHORT NPDA; // byte 70:71 O - Namespace Preferred Deallocate Alignment (NPDA) + USHORT NOWS; // byte 72:73 O - Namespace Optimal Write Size (NOWS) + + USHORT MSSRL; // byte 74:75 O - Maximum Single Source Range Length(MSSRL) + ULONG MCL; // byte 76:79 O - Maximum Copy Length(MCL) + UCHAR MSRC; // byte 80 O - Maximum Source Range Count(MSRC) + UCHAR Reserved2[11]; // byte 81:91 + + ULONG ANAGRPID; // byte 92:95 O - ANA Group Identifier (ANAGRPID) + + UCHAR Reserved3[3]; // byte 96:98 + + struct { + UCHAR WriteProtected : 1;// Write Protected + UCHAR Reserved : 7; + } NSATTR; // byte 99 O - Namespace Attributes + + USHORT NVMSETID; // byte 100:101 O - Associated NVM Set Identifier: 1-based value specifying NVM Set of this namespace. + + USHORT ENDGID; // byte 102:103 O - Associated Endurance Group Identier + + UCHAR NGUID[16]; // byte 104:119 O - Namespace Globally Unique Identifier (NGUID) + + UCHAR EUI64[8]; // byte 120:127 M - IEEE Extended Unique Identifier (EUI64) + + NVME_LBA_FORMAT LBAF[64]; // byte 128:131 M - LBA Format 0 Support (LBAF0) + // byte 132:135 O - LBA Format 1 Support (LBAF1) + // byte 136:139 O - LBA Format 2 Support (LBAF2) + // byte 140:143 O - LBA Format 3 Support (LBAF3) + // ... + // byte 380:383 O - LBA Format 63 Support (LBAF63) + + UCHAR VS[3712]; // byte 384:4095 O - Vendor Specific (VS): This range of bytes is allocated for vendor specific usage. + +} NVME_IDENTIFY_NAMESPACE_DATA, *PNVME_IDENTIFY_NAMESPACE_DATA; + +// +// Output of NVME_IDENTIFY_CNS_CONTROLLER (0x01) +// + +// +// Discovery Controller Type +// +typedef enum _NVME_DISC_CTRL_TYPE { + + NvmeDiscCtrlTypeUnspecified = 0, + NvmeDiscCtrlTypeDDC = 1, + NvmeDiscCtrlTypeCDC = 2, + NvmeDiscCtrlTypeReserved1 = 3, + NvmeDiscCtrlTypeReservedMax = 255, + +} NVME_DISC_CTRL_TYPE; + + +typedef struct { + USHORT MP; // bit 0:15. Maximum Power (MP) + + UCHAR Reserved0; // bit 16:23 + + UCHAR MPS : 1; // bit 24: Max Power Scale (MPS) + UCHAR NOPS : 1; // bit 25: Non-Operational State (NOPS) + UCHAR Reserved1 : 6; // bit 26:31 + + ULONG ENLAT; // bit 32:63. Entry Latency (ENLAT) + ULONG EXLAT; // bit 64:95. Exit Latency (EXLAT) + + UCHAR RRT : 5; // bit 96:100. Relative Read Throughput (RRT) + UCHAR Reserved2 : 3; // bit 101:103 + + UCHAR RRL : 5; // bit 104:108 Relative Read Latency (RRL) + UCHAR Reserved3 : 3; // bit 109:111 + + UCHAR RWT : 5; // bit 112:116 Relative Write Throughput (RWT) + UCHAR Reserved4 : 3; // bit 117:119 + + UCHAR RWL : 5; // bit 120:124 Relative Write Latency (RWL) + UCHAR Reserved5 : 3; // bit 125:127 + + USHORT IDLP; // bit 128:143 Idle Power (IDLP) + + UCHAR Reserved6 : 6; // bit 144:149 + UCHAR IPS : 2; // bit 150:151 Idle Power Scale (IPS) + + UCHAR Reserved7; // bit 152:159 + + USHORT ACTP; // bit 160:175 Active Power (ACTP) + + UCHAR APW : 3; // bit 176:178 Active Power Workload (APW) + UCHAR Reserved8 : 3; // bit 179:181 + UCHAR APS : 2; // bit 182:183 Active Power Scale (APS) + + + UCHAR Reserved9[9]; // bit 184:255. + +} NVME_POWER_STATE_DESC, *PNVME_POWER_STATE_DESC; + +typedef struct { + // + // byte 0 : 255, Controller Capabilities and Features + // + USHORT VID; // byte 0:1. M - PCI Vendor ID (VID) + USHORT SSVID; // byte 2:3. M - PCI Subsystem Vendor ID (SSVID) + UCHAR SN[20]; // byte 4: 23. M - Serial Number (SN) + UCHAR MN[40]; // byte 24:63. M - Model Number (MN) + UCHAR FR[8]; // byte 64:71. M - Firmware Revision (FR) + UCHAR RAB; // byte 72. M - Recommended Arbitration Burst (RAB) + UCHAR IEEE[3]; // byte 73:75. M - IEEE OUI Identifier (IEEE). Controller Vendor code. + + struct { + UCHAR MultiPorts : 1; + UCHAR MultiControllers : 1; + UCHAR SRIOV : 1; + UCHAR ANAR : 1; + UCHAR Reserved : 4; + } CMIC; // byte 76. O - Controller Multi-Path I/O and Namespace Sharing Capabilities (CMIC) + + UCHAR MDTS; // byte 77. M - Maximum Data Transfer Size (MDTS) + USHORT CNTLID; // byte 78:79. M - Controller ID (CNTLID) + ULONG VER; // byte 80:83. M - Version (VER) + ULONG RTD3R; // byte 84:87. M - RTD3 Resume Latency (RTD3R) + ULONG RTD3E; // byte 88:91. M - RTD3 Entry Latency (RTD3E) + + struct { + ULONG Reserved0 : 8; + ULONG NamespaceAttributeChanged : 1; + ULONG FirmwareActivation : 1; + ULONG Reserved1 : 1; + ULONG AsymmetricAccessChanged : 1; + ULONG PredictableLatencyAggregateLogChanged : 1; + ULONG LbaStatusChanged : 1; + ULONG EnduranceGroupAggregateLogChanged : 1; + ULONG NormalNvmSubsystemShutdown : 1; + ULONG Reserved2 : 11; + ULONG ZoneInformation : 1; + ULONG Reserved3 : 3; + ULONG DiscoveryLogChanged : 1; + } OAES; // byte 92:95. M - Optional Asynchronous Events Supported (OAES) + + struct { + ULONG HostIdentifier128Bit : 1; + ULONG NOPSPMode : 1; + ULONG NVMSets : 1; + ULONG ReadRecoveryLevels : 1; + ULONG EnduranceGroups : 1; + ULONG PredictableLatencyMode : 1; + ULONG TBKAS : 1; // Traffic Based Keep Alive Support + ULONG NamespaceGranularity : 1; + ULONG SQAssociations : 1; + ULONG UUIDList : 1; + ULONG MultiDomainSubsystem : 1; + ULONG FixedCapacityManagement : 1; + ULONG VariableCapacityManagement : 1; + ULONG DeleteEnduranceGroup : 1; + ULONG DeleteNVMSet : 1; + ULONG ELBAS : 1; // Extended LBA Formats Supported + ULONG Reserved0 : 16; + } CTRATT; // byte 96:99. M - Controller Attributes (CTRATT) + + struct { + USHORT ReadRecoveryLevel0 : 1; + USHORT ReadRecoveryLevel1 : 1; + USHORT ReadRecoveryLevel2 : 1; + USHORT ReadRecoveryLevel3 : 1; + USHORT ReadRecoveryLevel4 : 1; + USHORT ReadRecoveryLevel5 : 1; + USHORT ReadRecoveryLevel6 : 1; + USHORT ReadRecoveryLevel7 : 1; + USHORT ReadRecoveryLevel8 : 1; + USHORT ReadRecoveryLevel9 : 1; + USHORT ReadRecoveryLevel10 : 1; + USHORT ReadRecoveryLevel11 : 1; + USHORT ReadRecoveryLevel12 : 1; + USHORT ReadRecoveryLevel13 : 1; + USHORT ReadRecoveryLevel14 : 1; + USHORT ReadRecoveryLevel15 : 1; + } RRLS; // byte 100:101. O - Read Recovery Levels Supported (RRLS) + + UCHAR Reserved0[9]; // byte 102:110. + + UCHAR CNTRLTYPE; // byte 111. M - Controller Type + UCHAR FGUID[16]; // byte 112:127. O - FRU Globally Unique Identifier (FGUID) + + USHORT CRDT1; // byte 128:129. O - Command Retry Delay Time 1 + USHORT CRDT2; // byte 130:131. O - Command Retry Delay Time 1 + USHORT CRDT3; // byte 132:133. O - Command Retry Delay Time 1 + + UCHAR Reserved1[106]; // byte 134:239. + UCHAR ReservedForManagement[13]; // byte 240:252. Refer to the NVMe Management Interface Specification for definition. + UCHAR NVMSR; // byte 253. M - NVM Subsystem Report + UCHAR VWCI; // byte 254. M - VPD Write Cycle Information + UCHAR MEC; // byte 255. M - Management Endpoint Capabilities + + // + // byte 256 : 511, Admin Command Set Attributes + // + struct { + USHORT SecurityCommands : 1; + USHORT FormatNVM : 1; + USHORT FirmwareCommands : 1; + USHORT NamespaceCommands : 1; + USHORT DeviceSelfTest : 1; + USHORT Directives : 1; + USHORT NVMeMICommands : 1; + USHORT VirtualizationMgmt : 1; + USHORT DoorBellBufferConfig : 1; + USHORT GetLBAStatus : 1; + USHORT CommandFeatureLockdown : 1; + USHORT Reserved : 5; + } OACS; // byte 256:257. M - Optional Admin Command Support (OACS) + + UCHAR ACL; // byte 258. M - Abort Command Limit (ACL) + UCHAR AERL; // byte 259. M - Asynchronous Event Request Limit (AERL) + + struct { + UCHAR Slot1ReadOnly : 1; + UCHAR SlotCount : 3; + UCHAR ActivationWithoutReset : 1; + UCHAR Reserved : 3; + } FRMW; // byte 260. M - Firmware Updates (FRMW) + + struct { + UCHAR SmartPagePerNamespace : 1; + UCHAR CommandEffectsLog : 1; + UCHAR LogPageExtendedData : 1; + UCHAR TelemetrySupport : 1; + UCHAR PersistentEventLog : 1; + UCHAR SupportedLogPages : 1; + UCHAR TelemetryDataArea4 : 1; + UCHAR Reserved1 : 1; + } LPA; // byte 261. M - Log Page Attributes (LPA) + + UCHAR ELPE; // byte 262. M - Error Log Page Entries (ELPE) + UCHAR NPSS; // byte 263. M - Number of Power States Support (NPSS) + + struct { + UCHAR CommandFormatInSpec : 1; + UCHAR Reserved : 7; + } AVSCC; // byte 264. M - Admin Vendor Specific Command Configuration (AVSCC) + + struct { + UCHAR Supported : 1; + UCHAR Reserved : 7; + } APSTA; // byte 265. O - Autonomous Power State Transition Attributes (APSTA) + + USHORT WCTEMP; // byte 266:267. M - Warning Composite Temperature Threshold (WCTEMP) + USHORT CCTEMP; // byte 268:269. M - Critical Composite Temperature Threshold (CCTEMP) + USHORT MTFA; // byte 270:271. O - Maximum Time for Firmware Activation (MTFA) + ULONG HMPRE; // byte 272:275. O - Host Memory Buffer Preferred Size (HMPRE) + ULONG HMMIN; // byte 276:279. O - Host Memory Buffer Minimum Size (HMMIN) + UCHAR TNVMCAP[16]; // byte 280:295. O - Total NVM Capacity (TNVMCAP) + UCHAR UNVMCAP[16]; // byte 296:311. O - Unallocated NVM Capacity (UNVMCAP) + + struct { + ULONG RPMBUnitCount : 3; // Number of RPMB Units + ULONG AuthenticationMethod : 3; // Authentication Method + ULONG Reserved0 : 10; + ULONG TotalSize : 8; // Total Size: in 128KB units. + ULONG AccessSize : 8; // Access Size: in 512B units. + } RPMBS; // byte 312:315. O - Replay Protected Memory Block Support (RPMBS) + + USHORT EDSTT; // byte 316:317. O - Extended Device Self-test Time (EDSTT) + UCHAR DSTO; // byte 318. O - Device Self-test Options (DSTO) + UCHAR FWUG; // byte 319. M - Firmware Update Granularity (FWUG) + USHORT KAS; // byte 320:321 M - Keep Alive Support (KAS) + + struct { + USHORT Supported : 1; + USHORT Reserved : 15; + } HCTMA; // byte 322:323 O - Host Controlled Thermal Management Attributes (HCTMA) + + USHORT MNTMT; // byte 324:325 O - Minimum Thermal Management Temperature (MNTMT) + USHORT MXTMT; // byte 326:327 O - Maximum Thermal Management Temperature (MXTMT) + + struct { + ULONG CryptoErase : 1; // Controller supports Crypto Erase Sanitize + ULONG BlockErase : 1; // Controller supports Block Erase Sanitize + ULONG Overwrite : 1; // Controller supports Overwrite Santize + ULONG Reserved : 26; + ULONG NDI : 1; // No-Deallocate Inhibited (NDI) + ULONG NODMMAS : 2; // No-Deallocate Modifies Media After Sanitize (NODMMAS) + } SANICAP; // byte 328:331 O - Sanitize Capabilities (SANICAP) + + ULONG HMMINDS; // byte 332:335 O - Host Memory Buffer Minimum Descriptor Entry Size (HMMINDS) + USHORT HMMAXD; // byte 336:337 O - Host Memory Maxiumum Descriptors Entries (HMMAXD) + + USHORT NSETIDMAX; // byte 338:339 O - NVM Set Identifier Maximum: 1-based maximum value of a valid NVM Set Identifier. + USHORT ENDGIDMAX; // byte 340:341 O - Endurance Group Identifier Maximum (ENDGIDMAX) + + UCHAR ANATT; // byte 342 O - ANA Transition Time (ANATT) + + struct { + UCHAR OptimizedState : 1; // Report ANA Optimized State + UCHAR NonOptimizedState : 1; // Report ANA Non-Optimized State + UCHAR InaccessibleState : 1; // Report ANA Inaccessible State + UCHAR PersistentLossState : 1; // Report ANA Persistent Loss State + UCHAR ChangeState : 1; // Report ANA Change State + UCHAR Reserved : 1; + UCHAR StaticANAGRPID : 1; // If set, ANAGRPID in Identify Namespace doesn't change + UCHAR SupportNonZeroANAGRPID : 1; // If set, Controller supports a non-zero value in ANAGRPID field of Namespace Mgmt Command + } ANACAP; // byte 343 O - Asymmetric Namespace Access Capabilities (ANACAP) + + ULONG ANAGRPMAX; // byte 344:347 O - ANA Group Identifier Maximum (ANAGRPMAX) + ULONG NANAGRPID; // byte 348:351 O - Number of ANA Group Identifiers (NANAGRPID) + + ULONG PELS; // byte 352:355 O - Persistent Event Log Size (PELS) + + USHORT DomainId; // byte 356:357 O - Domain Identifier + + UCHAR Reserved2[10]; // byte 358:367 + + UCHAR MEGCAP[16]; // byte 368:383 O - Max Endurance Group Capacity + + UCHAR TMPTHHA; // byte 384 O - Temperature Threshold Hysteresis Attributes + + UCHAR Reserved3; // byte 385 + + USHORT CQT; // byte 386:387 M - Command Quiesce Time (milliseconds) + + UCHAR Reserved4[124]; // byte 388:511 + + // + // byte 512 : 703, NVM Command Set Attributes + // + struct { + UCHAR RequiredEntrySize : 4; // The value is in bytes and is reported as a power of two (2^n). + UCHAR MaxEntrySize : 4; // This value is larger than or equal to the required SQ entry size. The value is in bytes and is reported as a power of two (2^n). + } SQES; // byte 512. M - Submission Queue Entry Size (SQES) + + struct { + UCHAR RequiredEntrySize : 4; // The value is in bytes and is reported as a power of two (2^n). + UCHAR MaxEntrySize : 4; // This value is larger than or equal to the required CQ entry size. The value is in bytes and is reported as a power of two (2^n). + } CQES; // byte 513. M - Completion Queue Entry Size (CQES) + + USHORT MAXCMD; // byte 514:515. M - Maximum Outstanding Commands (MAXCMD) + + ULONG NN; // byte 516:519. M - Number of Namespaces (NN) + + struct { + USHORT Compare : 1; + USHORT WriteUncorrectable : 1; + USHORT DatasetManagement : 1; + USHORT WriteZeroes : 1; + USHORT FeatureField : 1; + USHORT Reservations : 1; + USHORT Timestamp : 1; + USHORT Verify : 1; + + USHORT Reserved : 8; + } ONCS; // byte 520:521. M - Optional NVM Command Support (ONCS) + + struct { + USHORT CompareAndWrite : 1; + USHORT Reserved : 15; + } FUSES; // byte 522:523. M - Fused Operation Support (FUSES) + + struct { + UCHAR FormatApplyToAll : 1; + UCHAR SecureEraseApplyToAll : 1; + UCHAR CryptographicEraseSupported : 1; + UCHAR FormatSupportNSIDAllF : 1; + UCHAR Reserved : 4; + } FNA; // byte 524. M - Format NVM Attributes (FNA) + + struct { + UCHAR Present : 1; + UCHAR FlushBehavior : 2; + UCHAR Reserved : 5; + } VWC; // byte 525. M - Volatile Write Cache (VWC) + + USHORT AWUN; // byte 526:527. M - Atomic Write Unit Normal (AWUN) + USHORT AWUPF; // byte 528:529. M - Atomic Write Unit Power Fail (AWUPF) + + struct { + UCHAR CommandFormatInSpec : 1; + UCHAR Reserved : 7; + } NVSCC; // byte 530. M - NVM Vendor Specific Command Configuration (NVSCC) + + struct { + UCHAR WriteProtect : 1; + UCHAR UntilPowerCycle : 1; + UCHAR Permanent : 1; + UCHAR Reserved : 5; + } NWPC; // byte 531. M - Namespace Write Protection Capabilities (NWPC) + + USHORT ACWU; // byte 532:533 O - Atomic Compare & Write Unit (ACWU) + + USHORT CopyDescFormats; // byte 534:535 M - Copy Descriptor Formats Supported + + struct { + ULONG SGLSupported : 2; + ULONG KeyedSGLData : 1; + ULONG Reserved0 : 13; + ULONG BitBucketDescrSupported : 1; + ULONG ByteAlignedContiguousPhysicalBuffer : 1; + ULONG SGLLengthLargerThanDataLength : 1; + ULONG MPTRSGLDescriptor : 1; + ULONG AddressFieldSGLDataBlock: 1; + ULONG TransportSGLData : 1; + ULONG Reserved1 : 10; + } SGLS; // byte 536:539. O - SGL Support (SGLS) + + ULONG MNAN; // byte 540:543. O - Maximum Number of Allowed Namespace (MNAN) + + UCHAR MAXDNA[16]; // byte 544:559. O - Maximum Domain Namespace Attachments (MAXDNA) + + ULONG MAXCNA; // byte 560:563. O - Maximum I/O Controller Namespace Attachments (MAXCNA) + + UCHAR Reserved6[204]; // byte 564:767. + + UCHAR SUBNQN[256]; // byte 768:1023. M - NVM Subsystem NVMe Qualified Name (SUBNQN) + + UCHAR Reserved7[768]; // byte 1024:1791 + + // + // byte 1792:2047. Fabric specific + // + ULONG IOCCSZ; // byte 1792:1795. M - I/O Queue Command Capsule Supported Size (IOCCSZ) + + ULONG IORCSZ; // byte 1796:1799. M - I/O Queue Response Capsule Supported Size (IORCSZ) + + USHORT ICDOFF; // byte 1800:1801. M - In Capsule Data Offset (ICDOFF) + + struct { + UCHAR StaticControllerModel : 1; + UCHAR Reserved : 7; + } FCATT; // byte 1802. M - Fabrics Controller Attributes (FCATT) + + UCHAR MSDBD; // byte 1803. M - Maximum SGL Data Block Descriptors (MSDBD) + + struct { + USHORT IOQueueDeletion : 1; + USHORT Reserved : 15; + } OFCS; // byte 1804:1805. M - Optional Fabric Commands Support (OFCS) + + UCHAR DCTYPE; // byte 1806. Discovery Controller Type (NVME_DISC_CTRL_TYPE) + + UCHAR Reserved8[241]; // byte 1807:2047 + + // + // byte 2048 : 3071, Power State Descriptors + // + NVME_POWER_STATE_DESC PDS[32]; // byte 2048:2079. M - Power State 0 Descriptor (PSD0): This field indicates the characteristics of power state 0 + // byte 2080:2111. O - Power State 1 Descriptor (PSD1): This field indicates the characteristics of power state 1 + // byte 2112:2143. O - Power State 2 Descriptor (PSD1): This field indicates the characteristics of power state 2 + // byte 2144:2175. O - Power State 3 Descriptor (PSD1): This field indicates the characteristics of power state 3 + // byte 2176:2207. O - Power State 4 Descriptor (PSD1): This field indicates the characteristics of power state 4 + // byte 2208:2239. O - Power State 5 Descriptor (PSD1): This field indicates the characteristics of power state 5 + // byte 2240:2271. O - Power State 6 Descriptor (PSD1): This field indicates the characteristics of power state 6 + // byte 2272:2303. O - Power State 7 Descriptor (PSD1): This field indicates the characteristics of power state 7 + // byte 2304:2335. O - Power State 8 Descriptor (PSD1): This field indicates the characteristics of power state 8 + // byte 2336:2367. O - Power State 9 Descriptor (PSD1): This field indicates the characteristics of power state 9 + // byte 2368:2399. O - Power State 10 Descriptor (PSD1): This field indicates the characteristics of power state 10 + // byte 2400:2431. O - Power State 11 Descriptor (PSD1): This field indicates the characteristics of power state 11 + // byte 2432:2463. O - Power State 12 Descriptor (PSD1): This field indicates the characteristics of power state 12 + // byte 2464:2495. O - Power State 13 Descriptor (PSD1): This field indicates the characteristics of power state 13 + // byte 2496:2527. O - Power State 14 Descriptor (PSD1): This field indicates the characteristics of power state 14 + // byte 2528:2559. O - Power State 15 Descriptor (PSD1): This field indicates the characteristics of power state 15 + // byte 2560:2591. O - Power State 16 Descriptor (PSD1): This field indicates the characteristics of power state 16 + // byte 2592:2623. O - Power State 17 Descriptor (PSD1): This field indicates the characteristics of power state 17 + // byte 2624:2655. O - Power State 18 Descriptor (PSD1): This field indicates the characteristics of power state 18 + // byte 2656:2687. O - Power State 19 Descriptor (PSD1): This field indicates the characteristics of power state 19 + // byte 2688:2719. O - Power State 20 Descriptor (PSD1): This field indicates the characteristics of power state 20 + // byte 2720:2751. O - Power State 21 Descriptor (PSD1): This field indicates the characteristics of power state 21 + // byte 2752:2783. O - Power State 22 Descriptor (PSD1): This field indicates the characteristics of power state 22 + // byte 2784:2815. O - Power State 23 Descriptor (PSD1): This field indicates the characteristics of power state 23 + // byte 2816:2847. O - Power State 24 Descriptor (PSD1): This field indicates the characteristics of power state 24 + // byte 2848:2879. O - Power State 25 Descriptor (PSD1): This field indicates the characteristics of power state 25 + // byte 2880:2911. O - Power State 26 Descriptor (PSD1): This field indicates the characteristics of power state 26 + // byte 2912:2943. O - Power State 27 Descriptor (PSD1): This field indicates the characteristics of power state 27 + // byte 2944:2975. O - Power State 28 Descriptor (PSD1): This field indicates the characteristics of power state 28 + // byte 2976:3007. O - Power State 29 Descriptor (PSD1): This field indicates the characteristics of power state 29 + // byte 3008:3039. O - Power State 30 Descriptor (PSD1): This field indicates the characteristics of power state 30 + // byte 3040:3071. O - Power State 31 Descriptor (PSD1): This field indicates the characteristics of power state 31 + + // + // byte 3072 : 4095, Vendor Specific + // + UCHAR VS[1024]; // byte 3072 : 4095. + +} NVME_IDENTIFY_CONTROLLER_DATA, *PNVME_IDENTIFY_CONTROLLER_DATA; + +// +// Namespace Identfier Type (NIDT) +// +typedef enum { + NVME_IDENTIFIER_TYPE_EUI64 = 0x1, + NVME_IDENTIFIER_TYPE_NGUID = 0x2, + NVME_IDENTIFIER_TYPE_UUID = 0x3, + NVME_IDENTIFIER_TYPE_CSI = 0x4, + +} NVME_IDENTIFIER_TYPE; + +// +// Namespace Identfier Length (NIDL) for a given type defined by NVME_IDENTIFIER_TYPE +// +typedef enum { + NVME_IDENTIFIER_TYPE_EUI64_LENGTH = 0x8, + NVME_IDENTIFIER_TYPE_NGUID_LENGTH = 0x10, + NVME_IDENTIFIER_TYPE_UUID_LENGTH = 0x10, + NVME_IDENTIFIER_TYPE_CSI_LENGTH = 0x1, + +} NVME_IDENTIFIER_TYPE_LENGTH; + +// +// Output of NVME_IDENTIFY_CNS_ACTIVE_NAMESPACES (0x02) +// + +typedef struct { + + ULONG NSID[1024]; // List of Namespace ID upto 1024 entries + +} NVME_ACTIVE_NAMESPACE_ID_LIST, *PNVME_ACTIVE_NAMESPACE_ID_LIST; + +// +// Output of NVME_IDENTIFY_CNS_DESCRIPTOR_NAMESPACE (0x03) +// + +#define NVME_IDENTIFY_CNS_DESCRIPTOR_NAMESPACE_SIZE 0x1000 + +typedef struct { + UCHAR NIDT; // Namespace Identifier Type as defined in NVME_IDENTIFIER_TYPE + UCHAR NIDL; // Namespace Identifier Length + UCHAR Reserved[2]; + UCHAR NID[ANYSIZE_ARRAY]; // Namespace Identifier (Based on NVME_IDENTIFIER_TYPE) +} NVME_IDENTIFY_NAMESPACE_DESCRIPTOR, *PNVME_IDENTIFY_NAMESPACE_DESCRIPTOR; + +// +// Output of NVME_IDENTIFY_CNS_NVM_SET (0x04) +// +typedef struct { + + USHORT Identifier; + USHORT ENDGID; + + ULONG Reserved1; + + ULONG Random4KBReadTypical; + ULONG OptimalWriteSize; + UCHAR TotalCapacity[16]; + UCHAR UnallocatedCapacity[16]; + + UCHAR Reserved2[80]; +} NVME_SET_ATTRIBUTES_ENTRY, *PNVME_SET_ATTRIBUTES_ENTRY; + +typedef struct { + + UCHAR IdentifierCount; + + UCHAR Reserved[127]; + + NVME_SET_ATTRIBUTES_ENTRY Entry[ANYSIZE_ARRAY]; + +} NVM_SET_LIST, *PNVM_SET_LIST; + +// +// Output of NVME_IDENTIFY_CNS_SPECIFIC_NAMESPACE_IO_COMMAND_SET (0x05) +// +typedef struct { + + ULONGLONG ZoneSize; // bit 0:63 Zone Size (MS) + UCHAR ZDES; // bit 64:71 Zone Descriptor Extension Size (ZDES) + UCHAR Reserved[7]; + +} NVME_LBA_ZONE_FORMAT, *PNVME_LBA_ZONE_FORMAT; + +typedef struct { + + struct { + USHORT VariableZoneCapacity : 1; + USHORT ZoneExcursions : 1; + USHORT Reserved : 14; + } ZOC; // Zone Operation Characteristics + + struct { + USHORT ReadAcrossZoneBoundaries : 1; + USHORT Reserved : 15; + } OZCS; // Optional Zoned Command Support + + ULONG MAR; // Maximum Active Resources (MAR) + ULONG MOR; // Maximum Open Resources (MOR) + ULONG RRL; // Reset Recommended Limit (RRL) + ULONG FRL; // Finish Recommended Limit (FRL) + + UCHAR Reserved0[2796]; + + NVME_LBA_ZONE_FORMAT LBAEF[16]; // byte 2816:2831 M - LBA Format 0 Extension (LBAFE0) + // byte 2832:2847 O - LBA Format 1 Extension (LBAFE1) + // byte 2848:2863 O - LBA Format 2 Extension (LBAFE2) + // byte 2864:2879 O - LBA Format 3 Extension (LBAFE3) + // byte 2880:2895 O - LBA Format 4 Extension (LBAFE4) + // byte 2896:2911 O - LBA Format 5 Extension (LBAFE5) + // byte 2912:2927 O - LBA Format 6 Extension (LBAFE6) + // byte 2928:2943 O - LBA Format 7 Extension (LBAFE7) + // byte 2944:2959 O - LBA Format 8 Extension (LBAFE8) + // byte 2960:2975 O - LBA Format 9 Extension (LBAFE9) + // byte 2976:2991 O - LBA Format 10 Extension (LBAFE10) + // byte 2992:3007 O - LBA Format 11 Extension (LBAFE11) + // byte 3008:3023 O - LBA Format 12 Extension (LBAFE12) + // byte 3024:3039 O - LBA Format 13 Extension (LBAFE13) + // byte 3040:3055 O - LBA Format 14 Extension (LBAFE14) + // byte 3056:3971 O - LBA Format 15 Extension (LBAFE15) + + UCHAR Reserved1[768]; // byte 3072:3839 + + UCHAR VS[256]; // byte 3840:4095 O - Vendor Specific (VS): This range of bytes is allocated for vendor specific usage. + +} NVME_IDENTIFY_SPECIFIC_NAMESPACE_IO_COMMAND_SET, *PNVME_IDENTIFY_SPECIFIC_NAMESPACE_IO_COMMAND_SET; + +// +// Output of NVME_IDENTIFY_CNS_SPECIFIC_CONTROLLER_IO_COMMAND_SET (0x06) with Command Set Identifier (0x00) +// +typedef struct { + UCHAR VSL; // byte 0 O - Verify Size Limit (VZL) + UCHAR WZSL; // byte 1 O - Write Zeroes Size Limit (WZSL) + UCHAR WUSL; // byte 2 O - Write Uncorrectable Size Limit (WUSL) + + UCHAR DMRL; // byte 3 O - Dataset Management Ranges Limit (DMRL) + ULONG DMRSL; // byte 4:7 O - Dataset Management Range Size Limit (DMRSL) + ULONGLONG DMSL; // byte 8:15 O - Dataset Management Size Limit (DMSL) + + UCHAR Reserved[4080]; // byte 16:4095 + +} NVME_IDENTIFY_NVM_SPECIFIC_CONTROLLER_IO_COMMAND_SET, *PNVME_IDENTIFY_NVM_SPECIFIC_CONTROLLER_IO_COMMAND_SET; + +// +// Output of NVME_IDENTIFY_CNS_SPECIFIC_CONTROLLER_IO_COMMAND_SET (0x06) with Command Set Identifier (0x02) +// +typedef struct { + UCHAR ZASL; // byte 0. O - Zone Append Size Limit (ZASL) + + UCHAR Reserved[4095]; // byte 1:4095 + +} NVME_IDENTIFY_ZNS_SPECIFIC_CONTROLLER_IO_COMMAND_SET, *PNVME_IDENTIFY_ZNS_SPECIFIC_CONTROLLER_IO_COMMAND_SET; + +// +// Output of NVME_IDENTIFY_CNS_CONTROLLER_LIST_OF_NSID (0x12)/NVME_IDENTIFY_CNS_CONTROLLER_LIST_OF_NVM_SUBSYSTEM (0x13) +// +typedef struct { + + USHORT NumberOfIdentifiers; + USHORT ControllerID[2047]; + +} NVME_CONTROLLER_LIST, *PNVME_CONTROLLER_LIST; + +// +// Output of NVME_IDENTIFY_CNS_UUID_LIST (CNS 0x17) +// The UUID List is 4096 bytes. +// + +#define NVME_UUID_ASSOCIATION_NONE 0 // No association of UUID reported +#define NVME_UUID_ASSOCIATION_PCI_VID 1 // UUID is associated with the vendor reported in the PCI Vendor ID field of Identify Controller data +#define NVME_UUID_ASSOCIATION_PCI_SUBSYSTEM_VID 2 // UUID is associated with vendor reported in the PCI subsystem vendor ID field of Identify Controller data +#define NVME_UUID_ASSOCIATION_RESERVED 3 + +typedef struct { + + UCHAR IdentifierAssociation : 2; // Byte 0, indicates whether the UUID is associated with a vendor. + UCHAR Reserved : 6; + UCHAR Reserved1[15]; // Bytes 1-15 + UCHAR UUID[16]; // Bytes 16-31, 128-bit UUID (per RFC 4122) + +} NVME_UUID_LIST_ENTRY, *PNVME_UUID_LIST_ENTRY; + +#define NVME_NUM_UUID_LIST_ENTRIES 128 +#define NVME_MAX_UUID_INDEX 127 // Index for last entry in a UUID List. Note, NVM Express + // requires UUID List Entry at index 127 shall be cleared to 0h. + +typedef struct { + + NVME_UUID_LIST_ENTRY UUID[NVME_NUM_UUID_LIST_ENTRIES]; // Note, UUID[0] is reserved. + +} NVME_UUID_LIST, *PNVME_UUID_LIST; + +// +// Output of NVME_IDENTIFY_CNS_IO_COMMAND_SET (0x1C) +// + +typedef struct { + + ULONGLONG NVMCommandSet : 1; // Bit 0, indicates whether this vector supports NVM command set. + ULONGLONG KVCommandSet : 1; // Bit 1, indicates whether this vector supports Key Value command set. + ULONGLONG ZNCommandSet : 1; // Bit 2, indicates whether this vector supports Zoned Namespace command set. + ULONGLONG Reserved : 61; // Bits 3-63, reserved + +} IO_COMMAND_SET_VECTOR, *PIO_COMMAND_SET_VECTOR; + +typedef struct { + + IO_COMMAND_SET_VECTOR IOCommandSetVector[512]; + +} NVME_IDENTIFY_IO_COMMAND_SET, *PNVME_IDENTIFY_IO_COMMAND_SET; + +// +// Data Structure of LBA Range Type entry +// +typedef enum { + + NVME_LBA_RANGE_TYPE_RESERVED = 0, + NVME_LBA_RANGE_TYPE_FILESYSTEM = 1, + NVME_LBA_RANGE_TYPE_RAID = 2, + NVME_LBA_RANGE_TYPE_CACHE = 3, + NVME_LBA_RANGE_TYPE_PAGE_SWAP_FILE = 4, + +} NVME_LBA_RANGE_TYPES; + +typedef struct { + UCHAR Type; // Type (Type): Specifies the Type of the LBA range. + struct { + UCHAR MayOverwritten : 1; + UCHAR Hidden : 1; + UCHAR Reserved : 6; + } Attributes; // Attributes: Specifies attributes of the LBA range. Each bit defines an attribute. + + UCHAR Reserved0[14]; + ULONGLONG SLBA; // Starting LBA (SLBA): This field specifies the 64-bit address of the first logical block that is part of this LBA range. + ULONGLONG NLB; // Number of Logical Blocks (NLB): This field specifies the number of logical blocks that are part of this LBA range. This is a 0s based value. + UCHAR GUID[16]; // Unique Identifier (GUID): This field is a global unique identifier that uniquely specifies the type of this LBA range. Well known Types may be defined and are published on the NVM Express website. + UCHAR Reserved1[16]; +} NVME_LBA_RANGET_TYPE_ENTRY, *PNVME_LBA_RANGET_TYPE_ENTRY; + +// +// Vendor defined log pages +// +typedef enum { + NVME_LOG_PAGE_OCP_DEVICE_SMART_INFORMATION = 0xC0, // OCP device SMART Information log page + NVME_LOG_PAGE_OCP_DEVICE_ERROR_RECOVERY = 0xC1, // OCP device Error Recovery log page + NVME_LOG_PAGE_OCP_FIRMWARE_ACTIVATION_HISTORY = 0xC2, // OCP device Firmware Activation History log page + NVME_LOG_PAGE_OCP_LATENCY_MONITOR = 0xC3, // OCP device Latency Monitor log page + NVME_LOG_PAGE_OCP_DEVICE_CAPABILITIES = 0xC4, // OCP device Device Capabilities log page + NVME_LOG_PAGE_OCP_UNSUPPORTED_REQUIREMENTS = 0xC5, // OCP device Unsupported Requirements log page + NVME_LOG_PAGE_OCP_TCG_CONFIGURATION = 0xC8, // OCP device TCG Configuration log page + NVME_LOG_PAGE_OCP_TCG_HISTORY = 0xC9 // OCP device TCG History log page +} NVME_VENDOR_LOG_PAGES; + +#define NVME_VENDOR_SPECIFIC_LOG_PAGE_MIN_IDENTIFIER 0xC0 +#define NVME_VENDOR_SPECIFIC_LOG_PAGE_MAX_IDENTIFIER 0xFF + +#define NVME_LOG_PAGE_WCS_DEVICE_SMART_ATTRIBUTES NVME_LOG_PAGE_OCP_DEVICE_SMART_INFORMATION // WCS device SMART Attributes log page +#define NVME_LOG_PAGE_WCS_DEVICE_ERROR_RECOVERY NVME_LOG_PAGE_OCP_DEVICE_ERROR_RECOVERY // WCS device Error Recovery log page + +// +// SMART Attributes Log Page GUID is defined in spec as byte stream: 0xAFD514C97C6F4F9CA4F2BFEA2810AFC5 +// which is converted to GUID format as: {2810AFC5-BFEA-A4F2-9C4F-6F7CC914D5AF} +// +#define GUID_OCP_DEVICE_SMART_INFORMATIONGuid { 0x2810AFC5, 0xBFEA, 0xA4F2, { 0x9C, 0x4F, 0x6F, 0x7C, 0xC9, 0x14, 0xD5, 0xAF} } +DEFINE_GUID(GUID_OCP_DEVICE_SMART_INFORMATION, 0x2810AFC5, 0xBFEA, 0xA4F2, 0x9C, 0x4F, 0x6F, 0x7C, 0xC9, 0x14, 0xD5, 0xAF); + +#define GUID_WCS_DEVICE_SMART_ATTRIBUTESGuid { 0x2810AFC5, 0xBFEA, 0xA4F2, { 0x9C, 0x4F, 0x6F, 0x7C, 0xC9, 0x14, 0xD5, 0xAF} } +DEFINE_GUID(GUID_WCS_DEVICE_SMART_ATTRIBUTES, 0x2810AFC5, 0xBFEA, 0xA4F2, 0x9C, 0x4F, 0x6F, 0x7C, 0xC9, 0x14, 0xD5, 0xAF); + +// +// Error Recovery Log Page GUID is defined in spec as byte stream: 0x5A1983BA3DFD4DABAE3430FE2131D944 +// which is converted to GUID format as: {2131D944-30FE-AE34-AB4D-FD3DBA83195A} +// +#define GUID_OCP_DEVICE_ERROR_RECOVERYGuid { 0x2131D944, 0x30FE, 0xAE34, {0xAB, 0x4D, 0xFD, 0x3D, 0xBA, 0x83, 0x19, 0x5A} } +DEFINE_GUID(GUID_OCP_DEVICE_ERROR_RECOVERY, 0x2131D944, 0x30FE, 0xAE34, 0xAB, 0x4D, 0xFD, 0x3D, 0xBA, 0x83, 0x19, 0x5A); + +#define GUID_WCS_DEVICE_ERROR_RECOVERYGuid { 0x2131D944, 0x30FE, 0xAE34, {0xAB, 0x4D, 0xFD, 0x3D, 0xBA, 0x83, 0x19, 0x5A} } +DEFINE_GUID(GUID_WCS_DEVICE_ERROR_RECOVERY, 0x2131D944, 0x30FE, 0xAE34, 0xAB, 0x4D, 0xFD, 0x3D, 0xBA, 0x83, 0x19, 0x5A); + +// +// Firmware Activation History Log Page GUID is defined in spec as byte stream: 0xD11CF3AC8AB24DE2A3F6DAB4769A796D +// which is converted to GUID format as: {769A796D-DAB4-A3F6-E24D-B28AACF31CD1} +// +#define GUID_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORYGuid { 0x769A796D, 0xDAB4, 0xA3F6, { 0xE2, 0x4D, 0xB2, 0x8A, 0xAC, 0xF3, 0x1C, 0xD1} } +DEFINE_GUID(GUID_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY, 0x769A796D, 0xDAB4, 0xA3F6, 0xE2, 0x4D, 0xB2, 0x8A, 0xAC, 0xF3, 0x1C, 0xD1); + +// +// Latency Monitor Log Page GUID is defined in spec as byte stream: 0x85D45E58D4E643709C6C84D08CC07A92 +// which is converted to GUID format as: {8CC07A92-84D0-9C6C-7043-E6D4585ED485} +// +#define GUID_OCP_DEVICE_LATENCY_MONITORGuid { 0x8CC07A92, 0x84D0, 0x9C6C, { 0x70, 0x43, 0xE6, 0xD4, 0x58, 0x5E, 0xD4, 0x85} } +DEFINE_GUID(GUID_OCP_DEVICE_LATENCY_MONITOR, 0x8CC07A92, 0x84D0, 0x9C6C, 0x70, 0x43, 0xE6, 0xD4, 0x58, 0x5E, 0xD4, 0x85); + +// +// Device Capabilities Log Page GUID is defined in spec as byte stream: 0xB7053C914B58495D98C9E1D10D054297 +// which is converted to GUID format as: {0D054297-E1D1-98C9-5D49-584B913C05B7} +// +#define GUID_OCP_DEVICE_DEVICE_CAPABILITIESGuid { 0x0D054297, 0xE1D1, 0x98C9, { 0x5D, 0x49, 0x58, 0x4B, 0x91, 0x3C, 0x05, 0xB7} } +DEFINE_GUID(GUID_OCP_DEVICE_DEVICE_CAPABILITIES, 0x0D054297, 0xE1D1, 0x98C9, 0x5D, 0x49, 0x58, 0x4B, 0x91, 0x3C, 0x05, 0xB7); + +// +// Unsupported Requirements Log Page GUID is defined in spec as byte stream: 0xC7BB98B7D0324863BB2C23990E9C722F +// which is converted to GUID format as: {0E9C722F-2399-BB2C-6348-32D0B798BBC7} +// +#define GUID_OCP_DEVICE_UNSUPPORTED_REQUIREMENTSGuid { 0x0E9C722F, 0x2399, 0xBB2C, { 0x63, 0x48, 0x32, 0xD0, 0xB7, 0x98, 0xBB, 0xC7} } +DEFINE_GUID(GUID_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS, 0x0E9C722F, 0x2399, 0xBB2C, 0x63, 0x48, 0x32, 0xD0, 0xB7, 0x98, 0xBB, 0xC7); + +// +// TCG Configuration Log Page GUID is defined in spec as byte stream: 0x54E02A9DFA5447C083E6E07EBD244006 +// which is converted to GUID format as: {BD244006-E07E-83E6-C047-54FA9D2AE054} +// +#define GUID_OCP_DEVICE_TCG_CONFIGURATIONGuid { 0xBD244006, 0xE07E, 0x83E6, { 0xC0, 0x47, 0x54, 0xFA, 0x9D, 0x2A, 0xE0, 0x54} } +DEFINE_GUID(GUID_OCP_DEVICE_TCG_CONFIGURATION, 0xBD244006, 0xE07E, 0x83E6, 0xC0, 0x47, 0x54, 0xFA, 0x9D, 0x2A, 0xE0, 0x54); + +// +// TCG History Log Page GUID is defined in spec as byte stream: 0x88D7909696D04E27949009C6704b513E +// which is converted to GUID format as: {704B513E-09C6-9490-274E-D0969690D788} +// +#define GUID_OCP_DEVICE_TCG_HISTORYGuid { 0x704B513E, 0x09C6, 0x9490, { 0x27, 0x4E, 0xD0, 0x96, 0x96, 0x90, 0xD7, 0x88} } +DEFINE_GUID(GUID_OCP_DEVICE_TCG_HISTORY, 0x704B513E, 0x09C6, 0x9490, 0x27, 0x4E, 0xD0, 0x96, 0x96, 0x90, 0xD7, 0x88); + +// +// MFND child controller event Log Page GUID is defined in spec as byte stream: 0x9C669D257FD944A5BF35A5F098BCCE18 +// which is converted to GUID format as: {98BCCE18-A5F0-BF35-A544-D97F259D669C} +// +#define GUID_MFND_CHILD_CONTROLLER_EVENT_LOG_PAGEGuid { 0x98BCCE18, 0xA5F0, 0xBF35, {0xA5, 0x44, 0xD9, 0x7F, 0x25, 0x9D, 0x66, 0x9C} } +DEFINE_GUID(GUID_MFND_CHILD_CONTROLLER_EVENT_LOG_PAGE, 0x98BCCE18, 0xA5F0, 0xBF35, 0xA5, 0x44, 0xD9, 0x7F, 0x25, 0x9D, 0x66, 0x9C); + +// +// MFND child controller QoS statistics Log Page GUID is defined in spec as byte stream: 0x0F5F578400403E87464406529CB5FA26 +// which is converted to GUID format as: {9CB5FA26-0652-4644-873E-400084575F0F} +// +#define GUID_MFND_CHILD_CONTROLLER_QOS_STAT_LOG_PAGEGuid { 0x9CB5FA26, 0x0652, 0x4644, {0x87, 0x3E, 0x40, 0x00, 0x84, 0x57, 0x5F, 0x0F} } +DEFINE_GUID(GUID_MFND_CHILD_CONTROLLER_QOS_STAT_LOG_PAGE, 0x9CB5FA26, 0x0652, 0x4644, 0x87, 0x3E, 0x40, 0x00, 0x84, 0x57, 0x5F, 0x0F); + +// +// Notice Status: NVME_ASYNC_EVENT_TYPE_VENDOR_SPECIFIC +// +typedef enum { + + NVME_ASYNC_EVENT_TYPE_VENDOR_SPECIFIC_RESERVED = 0, + NVME_ASYNC_EVENT_TYPE_VENDOR_SPECIFIC_DEVICE_PANIC = 1, + +} NVME_ASYNC_EVENT_TYPE_VENDOR_SPECIFIC_CODES; + +// +// Device recommended reset action on firmware assert for Windows Cloud Server Devices +// +typedef struct _NVME_WCS_DEVICE_RESET_ACTION { + union { + struct { + UCHAR ControllerReset : 1; + UCHAR NVMeSubsystemReset : 1; + UCHAR PCIeFLR : 1; + UCHAR PERST : 1; + UCHAR PowerCycle : 1; + UCHAR PCIeConventionalHotReset : 1; + UCHAR Reserved : 2; + }; + + UCHAR AsUCHAR; + }; + +} NVME_WCS_DEVICE_RESET_ACTION, * PNVME_WCS_DEVICE_RESET_ACTION; + +// +// Windows Cloud Server device capabilities +// +typedef struct _NVME_WCS_DEVICE_CAPABILITIES { + union { + struct { + ULONG PanicAEN : 1; + ULONG PanicCFS : 1; + ULONG Reserved : 30; + }; + + ULONG AsULONG; + }; + +} NVME_WCS_DEVICE_CAPABILITIES, * PNVME_WCS_DEVICE_CAPABILITIES; + +// +// Device recovery action on device panic +// +typedef enum _NVME_WCS_DEVICE_RECOVERY_ACTION1 +{ + NVMeDeviceRecoveryNoAction = 0, // Requires no action + NVMeDeviceRecoveryFormatNVM, // Requires Format NVM + NVMeDeviceRecoveryVendorSpecificCommand, // Requires Vendor Specific Command + NVMeDeviceRecoveryVendorAnalysis, // Requires Vendor Analysis + NVMeDeviceRecoveryDeviceReplacement, // Requires Device Replacement + NVMeDeviceRecoverySanitize, // Requires Sanitize + NVMeDeviceRecovery1Max = 15 // Not an actual action, denotes max action. +} NVME_WCS_DEVICE_RECOVERY_ACTION1, * PNVME_WCS_DEVICE_RECOVERY_ACTION1; + +typedef enum _NVME_WCS_DEVICE_RECOVERY_ACTION2 +{ + NVMeDeviceRecoveryControllerReset = 0, // Requires controller reset + NVMeDeviceRecoverySubsystemReset, // Requires NVM subsystem reset + NVMeDeviceRecoveryPcieFunctionReset, // Requires PCIe Function Level Reset + NVMeDeviceRecoveryPERST, // Requires PERST# + NVMeDeviceRecoveryPowerCycle, // Requires Main Power Cycle + NVMeDeviceRecoveryPcieHotReset, // Requires PCIe Conventional Hot Reset + NVMeDeviceRecovery2Max = 15 // Not an actual action, denotes max action. +} NVME_WCS_DEVICE_RECOVERY_ACTION2, * PNVME_WCS_DEVICE_RECOVERY_ACTION2; + +#pragma pack(push, 1) + +// +// Log page definition of NVME_LOG_PAGE_WCS_DEVICE_SMART_ATTRIBUTES/NVME_LOG_PAGE_OCP_DEVICE_SMART_INFORMATION. Size 512 bytes +// + +// Version independent structure to perform basic validation + +typedef struct _NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG { + + UCHAR VersionSpecificData[494]; + + USHORT LogPageVersionNumber; + + GUID LogPageGUID; // Shall be set to GUID_WCS_DEVICE_SMART_ATTRIBUTES / GUID_OCP_DEVICE_SMART_INFORMATION + +} NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG, *PNVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG; + +C_ASSERT(sizeof(NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG) == 512); + +// Version 2 + +#define NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_VERSION_2 0x0002 + +typedef struct _NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_V2 { + + UCHAR MediaUnitsWritten[16]; + UCHAR MediaUnitsRead[16]; + + struct { + UCHAR RawCount[6]; + UCHAR Normalized[2]; + } BadUserNANDBlockCount; + + struct { + UCHAR RawCount[6]; + UCHAR Normalized[2]; + } BadSystemNANDBlockCount; + + ULONGLONG XORRecoveryCount; + ULONGLONG UnrecoverableReadErrorCount; + ULONGLONG SoftECCErrorCount; + + struct { + ULONG DetectedCounts; + ULONG CorrectedCounts; + } EndToEndCorrectionCounts; + + UCHAR PercentageSystemDataUsed; + UCHAR RefreshCount[7]; + + struct { + ULONG MaximumCount; + ULONG MinimumCount; + } UserDataEraseCounts; + + struct { + UCHAR EventCount; + UCHAR Status; + } ThermalThrottling; + + UCHAR Reserved0[6]; + + ULONGLONG PCIeCorrectableErrorCount; + ULONG IncompleteShutdownCount; + + ULONG Reserved1; + + UCHAR PercentageFreeBlocks; + + UCHAR Reserved2[7]; + + USHORT CapacitorHealth; + + UCHAR Reserved3[6]; + + ULONGLONG UnalignedIOCount; + ULONGLONG SecurityVersionNumber; + ULONGLONG NUSE; + + UCHAR PLPStartCount[16]; + UCHAR EnduranceEstimate[16]; + + UCHAR Reserved4[302]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_VERSION_2 + + GUID LogPageGUID; // Shall be set to GUID_WCS_DEVICE_SMART_ATTRIBUTES + +} NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_V2, *PNVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_V2; + +C_ASSERT(sizeof(NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG_V2) == sizeof(NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG)); + +// Version 3 + +#define NVME_OCP_DEVICE_SMART_INFORMATION_LOG_VERSION_3 0x0003 + +#define NVME_OCP_DEVICE_DSSD_SPEC_MAJOR_VERSION_0 0x00 // For OCP 1.0 compliance +#define NVME_OCP_DEVICE_DSSD_SPEC_MAJOR_VERSION_2 0x02 // For OCP 2.0 compliance + +typedef struct _NVME_OCP_DEVICE_SMART_INFORMATION_LOG_V3 { + + UCHAR MediaUnitsWritten[16]; + UCHAR MediaUnitsRead[16]; + + struct { + UCHAR RawCount[6]; + UCHAR Normalized[2]; + } BadUserNANDBlockCount; + + struct { + UCHAR RawCount[6]; + UCHAR Normalized[2]; + } BadSystemNANDBlockCount; + + ULONGLONG XORRecoveryCount; + ULONGLONG UnrecoverableReadErrorCount; + ULONGLONG SoftECCErrorCount; + + struct { + ULONG DetectedCounts; + ULONG CorrectedCounts; + } EndToEndCorrectionCounts; + + UCHAR PercentageSystemDataUsed; + UCHAR RefreshCount[7]; + + struct { + ULONG MaximumCount; + ULONG MinimumCount; + } UserDataEraseCounts; + + struct { + UCHAR EventCount; + UCHAR Status; + } ThermalThrottling; + + struct { + UCHAR Errata; + USHORT PointVersion; + USHORT MinorVersion; + UCHAR MajorVersion; + } DSSDSpecVersion; + + ULONGLONG PCIeCorrectableErrorCount; + ULONG IncompleteShutdownCount; + + ULONG Reserved1; + + UCHAR PercentageFreeBlocks; + + UCHAR Reserved2[7]; + + USHORT CapacitorHealth; + + UCHAR NvmeErrata; + + UCHAR Reserved3[5]; + + ULONGLONG UnalignedIOCount; + ULONGLONG SecurityVersionNumber; + ULONGLONG NUSE; + + UCHAR PLPStartCount[16]; + UCHAR EnduranceEstimate[16]; + + ULONGLONG PCIeLinkRetrainingCount; + ULONGLONG PowerStateChangeCount; + + UCHAR Reserved4[286]; + + USHORT LogPageVersionNumber; + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_SMART_INFORMATION + +} NVME_OCP_DEVICE_SMART_INFORMATION_LOG_V3, *PNVME_OCP_DEVICE_SMART_INFORMATION_LOG_V3; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_SMART_INFORMATION_LOG_V3) == sizeof(NVME_WCS_DEVICE_SMART_ATTRIBUTES_LOG)); + +// +// Log page definition of NVME_LOG_PAGE_WCS_DEVICE_ERROR_RECOVERY. Size 512 bytes +// + +// Version independent structure to perform basic validation + +typedef struct _NVME_WCS_DEVICE_ERROR_RECOVERY_LOG { + + // Amount of time to wait for device panic workflow to complete in msec. Delay the reset accordingly + USHORT PanicResetWaitTime; + + // Reset actions on firmware assert, multiple options could be set + NVME_WCS_DEVICE_RESET_ACTION PanicResetAction; + + //Recovery action for device panic condition + UCHAR DriveRecoveryAction; + + // Id to identify the panic condition + ULONGLONG PanicId; + + // Device capabilities + NVME_WCS_DEVICE_CAPABILITIES DeviceCapabilities; + + // Vendor specific command opcode to recover device from panic condition + UCHAR VendorSpecificRecoveryCode; + + UCHAR Reserved0[3]; + + // CDW12 value for the Vendor Specific command to recover device from panic condition + ULONG VendorSpecificCommandCDW12; + + // CDW13 value for the Vendor Specific command to recover device from panic condition + ULONG VendorSpecificCommandCDW13; + + UCHAR Reserved1[466]; + + USHORT LogPageVersionNumber; + + GUID LogPageGUID; // Shall be set to GUID_WCS_DEVICE_ERROR_RECOVERY / GUID_OCP_DEVICE_ERROR_RECOVERY + +} NVME_WCS_DEVICE_ERROR_RECOVERY_LOG, *PNVME_WCS_DEVICE_ERROR_RECOVERY_LOG; + +C_ASSERT(sizeof(NVME_WCS_DEVICE_ERROR_RECOVERY_LOG) == 512); + +// Version 1 + +#define NVME_WCS_DEVICE_ERROR_RECOVERY_LOG_VERSION_1 0x0001 + +typedef struct _NVME_WCS_DEVICE_ERROR_RECOVERY_LOG NVME_WCS_DEVICE_ERROR_RECOVERY_LOG_V1, *PNVME_WCS_DEVICE_ERROR_RECOVERY_LOG_V1; + +C_ASSERT(sizeof(NVME_WCS_DEVICE_ERROR_RECOVERY_LOG_V1) == sizeof(NVME_WCS_DEVICE_ERROR_RECOVERY_LOG)); + +// Version 2 + +#define NVME_OCP_DEVICE_ERROR_RECOVERY_LOG_VERSION_2 0x0002 + +typedef struct _NVME_OCP_DEVICE_ERROR_RECOVERY_LOG_V2 { + + // Amount of time to wait for device panic workflow to complete in msec. Delay the reset accordingly + USHORT PanicResetWaitTime; + + // Reset actions on firmware assert, multiple options could be set + NVME_WCS_DEVICE_RESET_ACTION PanicResetAction; + + //Recovery action for device panic condition + UCHAR DeviceRecoveryAction1; + + // Id to identify the panic condition + ULONGLONG PanicId; + + // Device capabilities + NVME_WCS_DEVICE_CAPABILITIES DeviceCapabilities; + + // Vendor specific command opcode to recover device from panic condition + UCHAR VendorSpecificRecoveryCode; + + UCHAR Reserved0[3]; + + // CDW12 value for the Vendor Specific command to recover device from panic condition + ULONG VendorSpecificCommandCDW12; + + // CDW13 value for the Vendor Specific command to recover device from panic condition + ULONG VendorSpecificCommandCDW13; + + UCHAR VendorSpecificCommandTimeout; + + UCHAR DeviceRecoveryAction2; + + UCHAR DeviceRecoveryAction2Timeout; + + UCHAR Reserved1[463]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_ERROR_RECOVERY_LOG_VERSION_2 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_ERROR_RECOVERY + +} NVME_OCP_DEVICE_ERROR_RECOVERY_LOG_V2, *PNVME_OCP_DEVICE_ERROR_RECOVERY_LOG_V2; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_ERROR_RECOVERY_LOG_V2) == sizeof(NVME_WCS_DEVICE_ERROR_RECOVERY_LOG)); + +// +// Log page definition of NVME_LOG_PAGE_OCP_FIRMWARE_ACTIVATION_HISTORY. Size 4096 bytes +// + +#define FIRMWARE_ACTIVATION_HISTORY_ENTRY_VERSION_1 0x01 + +typedef struct _FIRMWARE_ACTIVATION_HISTORY_ENTRY { + + UCHAR VersionNumber; + UCHAR Length; + USHORT Reserved0; + USHORT ActivationCount; + ULONGLONG Timestamp; + ULONGLONG Reserved1; + ULONGLONG PowerCycleCount; + ULONGLONG PreviousFirmware; + ULONGLONG NewFirmware; + UCHAR SlotNumber; + UCHAR CommitActionType; + USHORT Result; + UCHAR Reserved2[14]; + +} FIRMWARE_ACTIVATION_HISTORY_ENTRY, *PFIRMWARE_ACTIVATION_HISTORY_ENTRY; + +C_ASSERT(sizeof(FIRMWARE_ACTIVATION_HISTORY_ENTRY) == 64); + +#define NVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG { + + UCHAR LID; // Shall be set to NVME_LOG_PAGE_OCP_FIRMWARE_ACTIVATION_HISTORY + + UCHAR Reserved0[3]; + + ULONG ValidNumberOfEntries; + + FIRMWARE_ACTIVATION_HISTORY_ENTRY Entries[20]; + + UCHAR Reserved1[2790]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY + +} NVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG, *PNVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_FIRMWARE_ACTIVATION_HISTORY_LOG) == 4096); + +// +// Log page definition of NVME_LOG_PAGE_OCP_LATENCY_MONITOR. Size 512 bytes +// + +typedef struct _LATENCY_MONITOR_FEATURE_STATUS { + union { + struct { + UCHAR FeatureEnabled : 1; + UCHAR ActiveLatencyMode : 1; + UCHAR ActiveMeasuredLatency : 1; + UCHAR Reserved : 5; + }; + + UCHAR AsUchar; + }; + +} LATENCY_MONITOR_FEATURE_STATUS, * PLATENCY_MONITOR_FEATURE_STATUS; + +typedef struct _ACTIVE_LATENCY_CONFIGURATION { + union { + struct { + USHORT Read0 : 1; + USHORT Write0 : 1; + USHORT Trim0 : 1; + USHORT Read1 : 1; + USHORT Write1 : 1; + USHORT Trim1 : 1; + USHORT Read2 : 1; + USHORT Write2 : 1; + USHORT Trim2 : 1; + USHORT Read3 : 1; + USHORT Write3 : 1; + USHORT Trim3 : 1; + USHORT Reserved : 4; + }; + + USHORT AsUshort; + }; + +} ACTIVE_LATENCY_CONFIGURATION, * PACTIVE_LATENCY_CONFIGURATION; + +typedef struct _BUCKET_COUNTER { + + ULONG Reserved; + ULONG Trim; + ULONG Write; + ULONG Read; + +} BUCKET_COUNTER, * PBUCKET_COUNTER; + +C_ASSERT(sizeof(BUCKET_COUNTER) == 16); + +typedef struct _LATENCY_STAMP { + + ULONGLONG Trim3; + ULONGLONG Write3; + ULONGLONG Read3; + + ULONGLONG Trim2; + ULONGLONG Write2; + ULONGLONG Read2; + + ULONGLONG Trim1; + ULONGLONG Write1; + ULONGLONG Read1; + + ULONGLONG Trim0; + ULONGLONG Write0; + ULONGLONG Read0; + +} LATENCY_STAMP, * PLATENCY_STAMP; + +C_ASSERT(sizeof(LATENCY_STAMP) == 96); + +typedef struct _MEASURED_LATENCY { + + USHORT Trim3; + USHORT Write3; + USHORT Read3; + + USHORT Trim2; + USHORT Write2; + USHORT Read2; + + USHORT Trim1; + USHORT Write1; + USHORT Read1; + + USHORT Trim0; + USHORT Write0; + USHORT Read0; + +} MEASURED_LATENCY, * PMEASURED_LATENCY; + +C_ASSERT(sizeof(MEASURED_LATENCY) == 24); + +typedef struct _LATENCY_STAMP_UNITS { + + USHORT Read0 : 1; + USHORT Write0 : 1; + USHORT Trim0 : 1; + + USHORT Read1 : 1; + USHORT Write1 : 1; + USHORT Trim1 : 1; + + USHORT Read2 : 1; + USHORT Write2 : 1; + USHORT Trim2 : 1; + + USHORT Read3 : 1; + USHORT Write3 : 1; + USHORT Trim3 : 1; + + USHORT Reserved : 4; + +} LATENCY_STAMP_UNITS, * PLATENCY_STAMP_UNITS; + +C_ASSERT(sizeof(LATENCY_STAMP_UNITS) == 2); + +typedef struct _DEBUG_BIT_FIELD { + + USHORT Read0 : 1; + USHORT Write0 : 1; + USHORT Trim0 : 1; + + USHORT Read1 : 1; + USHORT Write1 : 1; + USHORT Trim1 : 1; + + USHORT Read2 : 1; + USHORT Write2 : 1; + USHORT Trim2 : 1; + + USHORT Read3 : 1; + USHORT Write3 : 1; + USHORT Trim3 : 1; + + USHORT Reserved : 4; + +} DEBUG_BIT_FIELD, * PDEBUG_BIT_FIELD; + +C_ASSERT(sizeof(DEBUG_BIT_FIELD) == 2); + +#define NVME_OCP_DEVICE_LATENCY_MONITOR_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_LATENCY_MONITOR_LOG { + + LATENCY_MONITOR_FEATURE_STATUS FeatureStatus; + + UCHAR Reserved0; + + USHORT ActiveBucketTimer; + USHORT ActiveBucketTimerThreshold; + + UCHAR ActiveThresholdA; + UCHAR ActiveThresholdB; + UCHAR ActiveThresholdC; + UCHAR ActiveThresholdD; + + ACTIVE_LATENCY_CONFIGURATION ActiveLatencyConfig; + UCHAR ActiveLatencyMinimumWindow; + + UCHAR Reserved1[19]; + + BUCKET_COUNTER ActiveBucketCounter0; + BUCKET_COUNTER ActiveBucketCounter1; + BUCKET_COUNTER ActiveBucketCounter2; + BUCKET_COUNTER ActiveBucketCounter3; + + LATENCY_STAMP ActiveLatencyStamp; + MEASURED_LATENCY ActiveMeasuredLatency; + LATENCY_STAMP_UNITS ActiveLatencyStampUnits; + + UCHAR Reserved2[22]; + + BUCKET_COUNTER StaticBucketCounter0; + BUCKET_COUNTER StaticBucketCounter1; + BUCKET_COUNTER StaticBucketCounter2; + BUCKET_COUNTER StaticBucketCounter3; + + LATENCY_STAMP StaticLatencyStamp; + MEASURED_LATENCY StaticMeasuredLatency; + LATENCY_STAMP_UNITS StaticLatencyStampUnits; + + UCHAR Reserved3[22]; + + DEBUG_BIT_FIELD DebugLogTriggerEnable; + USHORT DebugLogMeasuredLatency; + ULONGLONG DebugLogLatencyStamp; + USHORT DebugLogPointer; + DEBUG_BIT_FIELD DebugCounterTriggerSource; + + union { + struct { + UCHAR BasedOnTimestamp : 1; + UCHAR Reserved : 7; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + } DebugLogStampUnits; + + UCHAR Reserved4[29]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_LATENCY_MONITOR_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_LATENCY_MONITOR + +} NVME_OCP_DEVICE_LATENCY_MONITOR_LOG, *PNVME_OCP_DEVICE_LATENCY_MONITOR_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_LATENCY_MONITOR_LOG) == 512); + +// +// Log page definition of NVME_LOG_PAGE_OCP_DEVICE_CAPABILITIES. Size 4096 bytes +// + +typedef struct _DSSD_POWER_STATE_DESCRIPTOR { + + UCHAR NvmePowerState : 5; + UCHAR Reserved : 2; + UCHAR ValidDSSDPowerState : 1; + +} DSSD_POWER_STATE_DESCRIPTOR, *PDSSD_POWER_STATE_DESCRIPTOR; + +C_ASSERT(sizeof(DSSD_POWER_STATE_DESCRIPTOR) == 1); + +#define NVME_OCP_DEVICE_CAPABILITIES_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_CAPABILITIES_LOG { + + USHORT PciePorts; + + union { + struct { + USHORT MctpOverSMBusSupported : 1; + USHORT MctpOverPcieVDMSupported : 1; + USHORT BasicMgmtCommandSupported : 1; + USHORT Reserved : 12; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } OobMgmtSupport; + + union { + struct { + USHORT Supported : 1; + USHORT DEACBitSupported : 1; + USHORT FUABitSupported : 1; + USHORT NvmeIo5Met : 1; + USHORT NvmeIo6Met : 1; + USHORT Reserved : 10; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } WriteZeroesCommand; + + union { + struct { + USHORT Supported : 1; + USHORT CryptoEraseSupported : 1; + USHORT BlockEraseSupported : 1; + USHORT OverwriteSupported : 1; + USHORT DeallocateLbaSupported : 1; + USHORT Reserved : 10; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } SanitizeCommand; + + union { + struct { + USHORT Supported : 1; + USHORT AttribDeallocateSupported : 1; + USHORT Reserved : 13; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } DatasetMgmtCommand; + + union { + struct { + USHORT Supported : 1; + USHORT SingleLBASupported : 1; + USHORT MaxLBASupported : 1; + USHORT NvmeIo14Met : 1; + USHORT Reserved : 11; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } WriteUncorrectableCommand; + + union { + struct { + USHORT CWFusedSupported : 1; + USHORT Reserved : 14; + USHORT CompliesWithSpec : 1; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + } FusedCommand; + + USHORT MinimumValidDSSDPowerState; + + UCHAR Reserved0; + + DSSD_POWER_STATE_DESCRIPTOR DssdDescriptors[127]; + + UCHAR Reserved1[3934]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_CAPABILITIES_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_DEVICE_CAPABILITIES + +} NVME_OCP_DEVICE_CAPABILITIES_LOG, *PNVME_OCP_DEVICE_CAPABILITIES_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_CAPABILITIES_LOG) == 4096); + +// +// Log page definition of NVME_LOG_PAGE_OCP_UNSUPPORTED_REQUIREMENTS. Size 4096 bytes +// + +typedef struct _UNSUPPORTED_REQUIREMENT { + + UCHAR ReqId[16]; // Zero padded ASCII string of the requirement id not supported + +} UNSUPPORTED_REQUIREMENT, *PUNSUPPORTED_REQUIREMENT; + +#define NVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG { + + USHORT UnsupportedCount; + + UCHAR Reserved0[14]; + + UNSUPPORTED_REQUIREMENT UnsupportedReqList[253]; + + UCHAR Reserved1[14]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS + +} NVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG, *PNVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_UNSUPPORTED_REQUIREMENTS_LOG) == 4096); + +// +// Log page definition of NVME_LOG_PAGE_OCP_TCG_CONFIGURATION. Size 512 bytes +// + +#define NVME_OCP_DEVICE_TCG_CONFIGURATION_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_TCG_CONFIGURATION_LOG { + + union { + + struct { + + UCHAR CPINSIDValue : 1; + UCHAR CPINSIDBlocked : 1; + UCHAR LockingEnabled : 1; + UCHAR SUMOwner : 1; + UCHAR Reserved : 4; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + } State; + + UCHAR Reserved0[3]; + + // Locking SP Activation count + UCHAR LSPActivationCount; + + // TPer Revert count + UCHAR TPRevertCount; + + // Locking SP Revert count + UCHAR LSPRevertCount; + + // Locking Object Count in Locking Table + UCHAR LOCount; + + // Single User Mode Locking Object count + UCHAR SUMLOCount; + + // Range Provisioned Locking Object count + UCHAR RPLOCount; + + // Namespace Provisioned Locking Object count + UCHAR NPLOCount; + + // Read Locked Locking Object count + UCHAR RLLOCount; + + // Write Locked Locking Object count + UCHAR WLLOCount; + + // Read Unlocked Locking Object count + UCHAR RULOCount; + + // Write Unlocked Locking Object count + UCHAR WULOCount; + + UCHAR Reserved1; + + // SID Authentication Try (failed) count + ULONG SIDAuthTryCount; + + // SID Authentication Try (failed) limit + ULONG SIDAuthTryLimit; + + // Programmatic TCG Reset count + ULONG ResetCount; + + // Count of Locking Objects transitioned to locked state + // due to Programmatic TCG Reset + ULONG ResetLockCount; + + UCHAR Reserved2[462]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_TCG_CONFIGURATION_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_TCG_CONFIGURATION + +} NVME_OCP_DEVICE_TCG_CONFIGURATION_LOG, *PNVME_OCP_DEVICE_TCG_CONFIGURATION_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_TCG_CONFIGURATION_LOG) == 512); + +// +// Log page definition of NVME_LOG_PAGE_OCP_TCG_HISTORY. Size 4096 bytes +// + +#define TCG_HISTORY_ENTRY_VERSION_1 0x01 + +typedef struct _TCG_HISTORY_ENTRY { + + UCHAR VersionNumber; + UCHAR EntryLength; + USHORT PowerCycleCount; + ULONG TcgCommandCount; + ULONGLONG TcgCommandCompletionTS; + ULONGLONG InvokingId; + ULONGLONG MethodId; + USHORT ComId; + UCHAR ProtocolId; + UCHAR TcgStatus; + USHORT ProcessTime; + UCHAR CommandSpecific[10]; + +} TCG_HISTORY_ENTRY, *PTCG_HISTORY_ENTRY; + +C_ASSERT(sizeof(TCG_HISTORY_ENTRY) == 48); + +typedef struct _TCG_AUTH_METHOD_SPECIFIC { + + ULONGLONG AuthorityId; + UCHAR TriesCount; + +} TCG_AUTH_METHOD_SPECIFIC, *PTCG_AUTH_METHOD_SPECIFIC; + +typedef struct _TCG_ACTIVATE_METHOD_SPECIFIC { + + UCHAR RangeStartLengthPolicy; + +} TCG_ACTIVATE_METHOD_SPECIFIC, *PTCG_ACTIVATE_METHOD_SPECIFIC; + +typedef struct _TCG_REACTIVATE_METHOD_SPECIFIC { + + UCHAR RangeStartLengthPolicy; + +} TCG_REACTIVATE_METHOD_SPECIFIC, *PTCG_REACTIVATE_METHOD_SPECIFIC; + +typedef struct _TCG_ASSIGN_METHOD_SPECIFIC { + + ULONG NamespaceId; + +} TCG_ASSIGN_METHOD_SPECIFIC, *PTCG_ASSIGN_METHOD_SPECIFIC; + +typedef struct _TCG_BLOCKSID_METHOD_SPECIFIC { + + UCHAR ClearEvents; + +} TCG_BLOCKSID_METHOD_SPECIFIC, *PTCG_BLOCKSID_METHOD_SPECIFIC; + +#define NVME_OCP_DEVICE_TCG_HISTORY_LOG_VERSION_1 0x0001 + +typedef struct _NVME_OCP_DEVICE_TCG_HISTORY_LOG { + + UCHAR LID; // Shall be set to NVME_LOG_PAGE_OCP_TCG_HISTORY + + UCHAR Reserved0[3]; + + ULONG HistoryEntryCount; + + TCG_HISTORY_ENTRY HistoryEntries[84]; + + UCHAR Reserved1[38]; + + USHORT LogPageVersionNumber; // Shall be set to NVME_OCP_DEVICE_TCG_HISTORY_LOG_VERSION_1 + + GUID LogPageGUID; // Shall be set to GUID_OCP_DEVICE_TCG_HISTORY + +} NVME_OCP_DEVICE_TCG_HISTORY_LOG, *PNVME_OCP_DEVICE_TCG_HISTORY_LOG; + +C_ASSERT(sizeof(NVME_OCP_DEVICE_TCG_HISTORY_LOG) == 4096); + +#pragma pack(pop) + +// +// Parameters for NVME_ADMIN_COMMAND_CREATE_IO_CQ +// +typedef union { + + struct { + ULONG QID : 16; // Queue Identifier (QID) + ULONG QSIZE : 16; // Queue Size (QSIZE) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_CREATE_IO_QUEUE, *PNVME_CDW10_CREATE_IO_QUEUE; + +typedef union { + + struct { + ULONG PC : 1; // Physically Contiguous (PC) + ULONG IEN : 1; // Interrupts Enabled (IEN) + ULONG Reserved0 : 14; + ULONG IV : 16; // Interrupt Vector (IV) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_CREATE_IO_CQ, *PNVME_CDW11_CREATE_IO_CQ; + +// +// Parameters for NVME_ADMIN_COMMAND_DELETE_IO_CQ and NVME_ADMIN_COMMAND_DELETE_IO_SQ +// +typedef union { + + struct { + ULONG QID : 16; // Queue Identifier (QID) + ULONG Reserved : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_DELETE_IO_QUEUE, *PNVME_CDW10_DELETE_IO_QUEUE; + +// +// Parameters for NVME_ADMIN_COMMAND_CREATE_IO_SQ +// +typedef enum { + + NVME_NVM_QUEUE_PRIORITY_URGENT = 0, + NVME_NVM_QUEUE_PRIORITY_HIGH = 1, + NVME_NVM_QUEUE_PRIORITY_MEDIUM = 2, + NVME_NVM_QUEUE_PRIORITY_LOW = 3, + +} NVME_NVM_QUEUE_PRIORITIES; + + +typedef union { + + struct { + ULONG PC : 1; // Physically Contiguous (PC) + ULONG QPRIO : 2; // Queue Priority (QPRIO) + ULONG Reserved0 : 13; + ULONG CQID : 16; // Completion Queue Identifier (CQID) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_CREATE_IO_SQ, *PNVME_CDW11_CREATE_IO_SQ; + +// +// Output and Parameters for NVME_ADMIN_COMMAND_GET_FEATURES or NVME_ADMIN_COMMAND_SET_FEATURES +// +typedef enum { + + NVME_FEATURE_VALUE_CURRENT = 0, + NVME_FEATURE_VALUE_DEFAULT = 1, + NVME_FEATURE_VALUE_SAVED = 2, + NVME_FEATURE_VALUE_SUPPORTED_CAPABILITIES = 3, + +} NVME_FEATURE_VALUE_CODES; + +typedef union { + + struct { + ULONG FID : 8; // Feature Identifier (FID) + ULONG SEL : 3; // Select (SEL): This field specifies which value of the attributes to return in the provided data. + ULONG Reserved0 : 21; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_GET_FEATURES, *PNVME_CDW10_GET_FEATURES; + +typedef union { + + struct { + ULONG FID : 8; // Feature Identifier (FID) + ULONG Reserved0 : 23; + ULONG SV : 1; // Save (SV) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_SET_FEATURES, *PNVME_CDW10_SET_FEATURES; + +typedef struct { + + struct { + ULONGLONG Timestamp : 48; // Timestamp in ms since Jan 1, 1970 UTC + ULONGLONG Synch : 1; // 0 = controller counted time continuously, 1 = controller may have stopped + ULONGLONG Origin : 3; // 000 = controller set timestamp to 0 at reset, 001 = timestamp set via Set Features + ULONGLONG Reserved : 12; + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + +} NVME_GET_FEATURE_TIMESTAMP, *PNVME_GET_FEATURE_TIMESTAMP; + +typedef union { + + struct { + ULONG NSQ : 16; // Number of IO Submission Queues. + ULONG NCQ : 16; // Number of IO Completion Queues. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_NUMBER_OF_QUEUES, *PNVME_CDW11_FEATURE_NUMBER_OF_QUEUES; + +typedef union { + + struct { + ULONG THR : 8; // Aggregation Threshold (THR) + ULONG TIME : 8; // Aggregation Time (TIME) + ULONG Reserved0 : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_INTERRUPT_COALESCING, *PNVME_CDW11_FEATURE_INTERRUPT_COALESCING; + +typedef union { + + struct { + ULONG IV : 16; // Interrupt Vector (IV) + ULONG CD : 1; // Coalescing Disabled (CD) + ULONG Reserved0 : 15; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_INTERRUPT_VECTOR_CONFIG, *PNVME_CDW11_FEATURE_INTERRUPT_VECTOR_CONFIG; + +typedef union { + + struct { + ULONG DN : 1; // Disable Normal (DN) + ULONG Reserved0 : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_WRITE_ATOMICITY_NORMAL, *PNVME_CDW11_FEATURE_WRITE_ATOMICITY_NORMAL; + +typedef union { + + struct { + ULONG NOPPME : 1; // Non-Operational Power State Permissive Mode Enable (NOPPME) + ULONG Reserved0 : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_NON_OPERATIONAL_POWER_STATE, *PNVME_CDW11_FEATURE_NON_OPERATIONAL_POWER_STATE; + +typedef union { + + struct { + ULONG NUM : 6; // Number of LBA Ranges (NUM) + ULONG Reserved0 : 26; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_LBA_RANGE_TYPE, *PNVME_CDW11_FEATURE_LBA_RANGE_TYPE; + +typedef union { + + struct { + ULONG AB : 3; // Arbitration Burst (AB) + ULONG Reserved0 : 5; + ULONG LPW : 8; // Low Priority Weight (LPW) + ULONG MPW : 8; // Medium Priority Weight (MPW) + ULONG HPW : 8; // High Priority Weight (HPW) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_ARBITRATION, *PNVME_CDW11_FEATURE_ARBITRATION; + +typedef union { + + struct { + ULONG WCE : 1; // Volatile Write Cache Enable (WCE) + ULONG Reserved0 : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_VOLATILE_WRITE_CACHE, *PNVME_CDW11_FEATURE_VOLATILE_WRITE_CACHE; + +typedef union { + + struct { + ULONG SAVE : 1; // Save supported + ULONG NSS : 1; // Namespace specific + ULONG MOD : 1; // Changeable + ULONG Reserved0 : 29; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_SUPPORTED_CAPABILITY, *PNVME_CDW11_FEATURE_SUPPORTED_CAPABILITY; + +typedef union { + + struct { + ULONG CriticalWarnings : 8; // SMART / Health Critical Warnings + ULONG NsAttributeNotices : 1; // Namespace Attributes Notices + ULONG FwActivationNotices : 1; // Firmware Activation Notices + ULONG TelemetryLogNotices : 1; // Telemetry Log Notices + ULONG ANAChangeNotices : 1; // Asymmetric Namespace Access Change Notices + ULONG PredictableLogChangeNotices : 1; // Predictable Latency Event Aggregate Log Change Notices + ULONG LBAStatusNotices : 1; // LBA Status Information Notices + ULONG EnduranceEventNotices : 1; // Endurance Group Event Aggregate Log Change Notices + ULONG NormalNVMSubsystemShutdown : 1; // Normal NVM Subsystem shutdown + ULONG Reserved0 : 11; + ULONG ZoneDescriptorNotices : 1; // Zone Descriptor Changed Notices + ULONG Reserved1 : 3; + ULONG DiscoveryLogPageChange : 1; // Discovery Log Page Change Notification + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_ASYNC_EVENT_CONFIG, *PNVME_CDW11_FEATURE_ASYNC_EVENT_CONFIG; + +// +// Parameter for NVME_FEATURE_POWER_MANAGEMENT +// +typedef union { + + struct { + ULONG PS : 5; // Power State (PS) + ULONG Reserved0 : 27; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_POWER_MANAGEMENT, *PNVME_CDW11_FEATURE_POWER_MANAGEMENT; + +// +// Parameter for NVME_FEATURE_AUTONOMOUS_POWER_STATE_TRANSITION +// +typedef union { + struct { + ULONG APSTE : 1; // Autonomous Power State Transition Enable (APSTE) + ULONG Reserved0 : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_AUTO_POWER_STATE_TRANSITION, *PNVME_CDW11_FEATURE_AUTO_POWER_STATE_TRANSITION; + +// +// Parameter for NVME_FEATURE_AUTONOMOUS_POWER_STATE_TRANSITION +// There is an array of 32 of these (one for each power state) in the data buffer. +// +typedef struct { + ULONG Reserved0 : 3; // Bits 0-2 are reserved. + ULONG IdleTransitionPowerState : 5; // Bits 3-7 - (ITPS) The non-operational power state for the controller to autonomously transition to after there is a continuous period of idle time in the current power state that exceeds time specified in the ITPT field. + ULONG IdleTimePriorToTransition : 24; // Bits 8-31 - (ITPT) The amount of idle time (in ms) that occurs in this power state prior to transitioning to the Idle Transition Power State. A value of 0 disables APST for this power state. + ULONG Reserved1; // Bits 32-63 are reserved. +} NVME_AUTO_POWER_STATE_TRANSITION_ENTRY, *PNVME_AUTO_POWER_STATE_TRANSITION_ENTRY; + +// +// Parameter for NVME_FEATURE_TEMPERATURE_THRESHOLD +// + +// +// Following definitions are used in "THSEL" field. +// +typedef enum { + + NVME_TEMPERATURE_OVER_THRESHOLD = 0, + NVME_TEMPERATURE_UNDER_THRESHOLD = 1, + +} NVME_TEMPERATURE_THRESHOLD_TYPES; + +typedef union { + + struct { + ULONG TMPTH : 16; // Temperature Threshold (TMPTH): Indicates the threshold for the temperature of the overall device (controller and NVM included) in units of Kelvin. + ULONG TMPSEL : 4; // Threshold Temperature Select (TMPSEL) + ULONG THSEL : 2; // Threshold Type Select (THSEL) + ULONG Reserved0 : 10; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_TEMPERATURE_THRESHOLD, *PNVME_CDW11_FEATURE_TEMPERATURE_THRESHOLD; + +// +// Parameter for NVME_FEATURE_ERROR_RECOVERY +// +typedef union { + struct { + ULONG TLER : 16; // Time limited error recovery (TLER) + ULONG DULBE : 1; // Deallocated or unwritten logical block error enable (DULBE) + ULONG Reserved0 : 15; + } DUMMYSTRUCTNAME; + ULONG AsUlong; +} NVME_CDW11_FEATURE_ERROR_RECOVERY, *PNVME_CDW11_FEATURE_ERROR_RECOVERY; + +// +// Parameters for NVME_FEATURE_HOST_MEMORY_BUFFER +// +typedef union { + struct { + ULONG EHM : 1; // Enable Host Memory (EHM) - Enables the host memory buffer. + ULONG MR : 1; // Memory Return (MR) - Indicates if the host is returning previously allocated memory to the controller. + ULONG Reserved : 30; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW11_FEATURE_HOST_MEMORY_BUFFER, *PNVME_CDW11_FEATURE_HOST_MEMORY_BUFFER; + +typedef union { + struct { + ULONG HSIZE; // Host Memory Buffer Size (HSIZE) - The size of the host memory buffer in memory page size (CC.MPS) units. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW12_FEATURE_HOST_MEMORY_BUFFER, *PNVME_CDW12_FEATURE_HOST_MEMORY_BUFFER; + +typedef union { + struct { + ULONG Reserved : 4; + ULONG HMDLLA : 28; // Host Memory Descriptor List Lower Address (HMDLLA) - 16-byte aligned, lower 32 bits of the physical location of the Host Memory Descriptor List. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW13_FEATURE_HOST_MEMORY_BUFFER, *PNVME_CDW13_FEATURE_HOST_MEMORY_BUFFER; + +typedef union { + struct { + ULONG HMDLUA; // Host Memory Descriptor List Upper Address (HMDLLA) - Upper 32 bits of the physical location of the Host Memory Descriptor List. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW14_FEATURE_HOST_MEMORY_BUFFER, *PNVME_CDW14_FEATURE_HOST_MEMORY_BUFFER; + +typedef union { + struct { + ULONG HMDLEC; // Host Memory Descriptor List Entry Count (HMDLEC) - Number of entries in the Host Memory Descriptor List. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW15_FEATURE_HOST_MEMORY_BUFFER, *PNVME_CDW15_FEATURE_HOST_MEMORY_BUFFER; + +// +// This structure is a single entry in the host memory descriptor list. +// +typedef struct { + ULONGLONG BADD; // Buffer Address (BADD) - Physical host memory address aligned to the memory page size (CC.MPS) + ULONG BSIZE; // Buffer Size (BSIZE) - The number of contiguous memory page size (CC.MPS) units for this entry. + ULONG Reserved; +} NVME_HOST_MEMORY_BUFFER_DESCRIPTOR_ENTRY, *PNVME_HOST_MEMORY_BUFFER_DESCRIPTOR_ENTRY; + +// +// Data structure for NVME_FEATURE_HOST_BEHAVIOR_SUPPORT +// +typedef struct { + + UCHAR ACRE; // byte 0 Advanced Command Retry Enable + UCHAR ETDAS; // byte 1 Extended Telemetry Data Area 4 Supported + UCHAR LBAFEE; // byte 2 LBA Format Extension Enable + UCHAR Reserved[509]; // byte 3:511 + +} NVME_HOST_BEHAVIOR_SUPPORT_DATA, *PNVME_HOST_BEHAVIOR_SUPPORT_DATA; + +// +// Parameters for NVME_FEATURE_IO_COMMAND_SET_PROFILE +// +typedef union { + + struct { + ULONG IOCSCI : 8; // I/O command Set Profile + ULONG Reserved : 24; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_IO_COMMAND_SET_PROFILE, *PNVME_CDW11_FEATURE_IO_COMMAND_SET_PROFILE; + +// +// Parameters for NVME_FEATURE_ENHANDED_CONTROLLER_METADATA, NVME_FEATURE_CONTROLLER_METADATA, NVME_FEATURE_NAMESPACE_METADATA +// +typedef union { + + struct { + ULONG GDHM : 1; // Generate Default Host Metadata (GDHM) + ULONG Reserved : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_GET_HOST_METADATA, *PNVME_CDW11_FEATURE_GET_HOST_METADATA; + +typedef enum { + + NVME_HOST_METADATA_ADD_REPLACE_ENTRY = 0, + NVME_HOST_METADATA_DELETE_ENTRY_MULTIPLE = 1, + NVME_HOST_METADATA_ADD_ENTRY_MULTIPLE = 2, + +} NVME_HOST_METADATA_ELEMENT_ACTIONS; + +typedef union { + + struct { + ULONG Reserved0 : 13; + + ULONG EA : 2; // Element Action (EA), value defined in enum NVME_HOST_METADATA_ELEMENT_ACTIONS + + ULONG Reserved1 : 17; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_SET_HOST_METADATA, *PNVME_CDW11_FEATURE_SET_HOST_METADATA; + +typedef enum { + + NVME_CONTROLLER_METADATA_OPERATING_SYSTEM_CONTROLLER_NAME = 0x1, + NVME_CONTROLLER_METADATA_OPERATING_SYSTEM_DRIVER_NAME = 0x2, + NVME_CONTROLLER_METADATA_OPERATING_SYSTEM_DRIVER_VERSION = 0x3, + NVME_CONTROLLER_METADATA_PREBOOT_CONTROLLER_NAME = 0x4, + NVME_CONTROLLER_METADATA_PREBOOT_DRIVER_NAME = 0x5, + NVME_CONTROLLER_METADATA_PREBOOT_DRIVER_VERSION = 0x6, + NVME_CONTROLLER_METADATA_SYSTEM_PROCESSOR_MODEL = 0x7, + NVME_CONTROLLER_METADATA_CHIPSET_DRIVER_NAME = 0x8, + NVME_CONTROLLER_METADATA_CHIPSET_DRIVER_VERSION = 0x9, + NVME_CONTROLLER_METADATA_OPERATING_SYSTEM_NAME_AND_BUILD = 0xA, + NVME_CONTROLLER_METADATA_SYSTEM_PRODUCT_NAME = 0xB, + NVME_CONTROLLER_METADATA_FIRMWARE_VERSION = 0xC, + NVME_CONTROLLER_METADATA_OPERATING_SYSTEM_DRIVER_FILENAME = 0xD, + NVME_CONTROLLER_METADATA_DISPLAY_DRIVER_NAME = 0xE, + NVME_CONTROLLER_METADATA_DISPLAY_DRIVER_VERSION = 0xF, + NVME_CONTROLLER_METADATA_HOST_DETERMINED_FAILURE_RECORD = 0x10, + +} NVME_CONTROLLER_METADATA_ELEMENT_TYPES; + +typedef enum { + + NVME_NAMESPACE_METADATA_OPERATING_SYSTEM_NAMESPACE_NAME = 0x1, + NVME_NAMESPACE_METADATA_PREBOOT_NAMESPACE_NAME = 0x2, + NVME_NAMESPACE_METADATA_OPERATING_SYSTEM_NAMESPACE_NAME_QUALIFIER_1 = 0x3, + NVME_NAMESPACE_METADATA_OPERATING_SYSTEM_NAMESPACE_NAME_QUALIFIER_2 = 0x4, + +} NVME_NAMESPACE_METADATA_ELEMENT_TYPES; + +typedef struct { + + ULONG ET : 6; // Element Type (ET), value defined in enum NVME_CONTROLLER_METADATA_ELEMENT_TYPES, NVME_NAMESPACE_METADATA_ELEMENT_TYPES + + ULONG Reserved0 : 2; + + ULONG ER : 4; // Element Revision (ER) + + ULONG Reserved1 : 4; + + ULONG ELEN : 16; // Element Length (ELEN), element value length in bytes + + UCHAR EVAL[ANYSIZE_ARRAY]; // Element Value (EVAL), UTF-8 string + +} NVME_HOST_METADATA_ELEMENT_DESCRIPTOR, *PNVME_HOST_METADATA_ELEMENT_DESCRIPTOR; + +typedef struct { + + UCHAR NumberOfMetadataElementDescriptors; + + UCHAR Reserved0; + + UCHAR MetadataElementDescriptors[4094]; // Use NVME_HOST_METADATA_ELEMENT_DESCRIPTOR to access this list. + +} NVME_FEATURE_HOST_METADATA_DATA, *PNVME_FEATURE_HOST_METADATA_DATA; + +// +// Parameter for NVME_FEATURE_ERROR_INJECTION +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG NUM : 7; // Number of Error Injections. + ULONG Reserved0 : 25; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_ERROR_INJECTION, *PNVME_CDW11_FEATURE_ERROR_INJECTION; + +// +// DWORD 0 for get feature command (Error Injection) shares the same format with DWORD 11 for set feature command (Error Injection). +// +typedef NVME_CDW11_FEATURE_ERROR_INJECTION NVME_CDW0_FEATURE_ERROR_INJECTION, *PNVME_CDW0_FEATURE_ERROR_INJECTION; + +typedef struct { + + union { + + struct { + + UCHAR Enable : 1; // A value of 0 indicates error injection is not enabled. A value of 1 indicates error injection is enabled. + + UCHAR SingleInstance : 1; // A value of 0 indicates error injection is enabled until disable. + // A value of 1 indicates a single instance error injection where a single error is injected. + // After a single instance error has been created, the value of the Enable field shall be 0 in the results from Get Features command. + UCHAR Reserved0 : 6; + + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } Flags; + + UCHAR Reserved1; + USHORT ErrorInjectionType; // Specifies the Type of Error Injection. + UCHAR ErrorInjectionTypeSpecific[28]; // Error Injection Type specific definition. + +} NVME_ERROR_INJECTION_ENTRY, *PNVME_ERROR_INJECTION_ENTRY; + +// +// Definitions are used in "Error Injection Type" field. +// +typedef enum { + + NVME_ERROR_INJECTION_TYPE_RESERVED0 = 0, + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_CPU_CONTROLLER_HANG, // 0x1 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_NAND_HANG, // 0x2 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_PLP_DEFECT, // 0x3 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_LOGICAL_FW_ERROR, // 0x4 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_DRAM_CORRUPTION_CRITICAL, // 0x5 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_DRAM_CORRUPTION_NONCRITICAL, // 0x6 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_NAND_CORRUPTION, // 0x7 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_SRAM_CORRUPTION, // 0x8 + NVME_ERROR_INJECTION_TYPE_DEVICE_PANIC_HW_MALFUNCTION, // 0x9 + + NVME_ERROR_INJECTION_TYPE_RESERVED1, // 0xA + + NVME_ERROR_INJECTION_TYPE_MAX = 0xFFFF + +} NVME_ERROR_INJECTION_TYPES; + +// +// Parameter for set feature NVME_FEATURE_CLEAR_FW_UPDATE_HISTORY +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG Reserved0 : 31; + ULONG Clear : 1; // Clear Firmware Update History Log. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_CLEAR_FW_UPDATE_HISTORY, *PNVME_CDW11_FEATURE_CLEAR_FW_UPDATE_HISTORY; + +// +// Parameter for set feature NVME_FEATURE_READONLY_WRITETHROUGH_MODE +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG Reserved0 : 30; + ULONG EOLBehavior : 2; // End of Life Behavior. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_READONLY_WRITETHROUGH_MODE, *PNVME_CDW11_FEATURE_READONLY_WRITETHROUGH_MODE; + +// +// Output for get feature NVME_FEATURE_READONLY_WRITETHROUGH_MODE +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG EOLBehavior : 3; // End of Life Behavior. + ULONG Reserved0 : 29; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW0_FEATURE_READONLY_WRITETHROUGH_MODE, *PNVME_CDW0_FEATURE_READONLY_WRITETHROUGH_MODE; + +// +// Parameter for set feature NVME_FEATURE_CLEAR_PCIE_CORRECTABLE_ERROR_COUNTERS +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG Reserved0 : 31; + ULONG Clear : 1; // Clear PCIe Error Counters. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_CLEAR_PCIE_CORRECTABLE_ERROR_COUNTERS, *PNVME_CDW11_FEATURE_CLEAR_PCIE_CORRECTABLE_ERROR_COUNTERS; + +// +// Parameter for set feature NVME_FEATURE_ENABLE_IEEE1667_SILO +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG Reserved0 : 31; + ULONG Enable : 1; // Enable IEEE1667 Silo. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_FEATURE_ENABLE_IEEE1667_SILO, *PNVME_CDW11_FEATURE_ENABLE_IEEE1667_SILO; + +// +// Output for get feature NVME_FEATURE_ENABLE_IEEE1667_SILO +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG Enabled : 3; // IEEE1667 Silo Enabled. + ULONG Reserved0 : 29; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW0_FEATURE_ENABLE_IEEE1667_SILO, *PNVME_CDW0_FEATURE_ENABLE_IEEE1667_SILO; + +// +// Parameter for set feature NVME_FEATURE_LATENCY_MONITOR. +// This is from OCP NVMe Cloud SSD spec. +// + +#pragma pack(push, 1) +typedef struct { + + USHORT ActiveBucketTimerThreshold; + + UCHAR ActiveThresholdA; + + UCHAR ActiveThresholdB; + + UCHAR ActiveThresholdC; + + UCHAR ActiveThresholdD; + + USHORT ActiveLatencyConfig; + + UCHAR ActiveLatencyMinimumWindow; + + USHORT DebugLogTriggerEnable; + + UCHAR DiscardDebugLog; + + UCHAR LatencyMonitorFeatureEnable; + + UCHAR Reserved0[4083]; + +} NVME_LATENCY_MONITORING_ENTRY, *PNVME_LATENCY_MONITORING_ENTRY; +#pragma pack(pop) + +C_ASSERT(sizeof(NVME_LATENCY_MONITORING_ENTRY) == 4096); + +// +// Output for get feature NVME_DSSD_POWER_STATE +// This is from OCP NVMe Cloud SSD spec. +// +typedef union { + + struct { + ULONG DSSDPowerState : 7; + ULONG Reserved0 : 25; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW0_FEATURE_DSSD_POWER_STATE, *PNVME_CDW0_FEATURE_DSSD_POWER_STATE; + +// +// Parameters for NVME_FEATURE_NVM_HOST_IDENTIFIER +// +#define NVME_MAX_HOST_IDENTIFIER_SIZE 16 // 16 Bytes, 128 Bits +#define NVME_HOST_IDENTIFIER_SIZE 8 // 8 Bytes, 64 Bits +#define NVME_EXTENDED_HOST_IDENTIFIER_SIZE 16 // 16 Bytes, 128 Bits + +typedef struct { + + ULONG EXHID : 1; // Enable Extended Host Identifier (EXHID) + ULONG Reserved : 31; + +} NVME_CDW11_FEATURE_HOST_IDENTIFIER, *PNVME_CDW11_FEATURE_HOST_IDENTIFIER; + +typedef struct { + + UCHAR HOSTID[NVME_MAX_HOST_IDENTIFIER_SIZE]; // Host Identifier (HOSTID) + +} NVME_FEATURE_HOST_IDENTIFIER_DATA, *PNVME_FEATURE_HOST_IDENTIFIER_DATA; + +typedef struct { + + ULONG PTPL : 1; // Persist Through Power Loss (PTPL) + ULONG Reserved : 31; + +} NVME_CDW11_FEATURE_RESERVATION_PERSISTENCE, *PNVME_CDW11_FEATURE_RESERVATION_PERSISTENCE; + +typedef struct { + + ULONG Reserved : 1; + + ULONG REGPRE : 1; // Mask Registration Preempted Notification (REGPRE) + ULONG RESREL : 1; // Mask Reservation Released Notification (RESREL) + ULONG RESPRE : 1; // Mast Reservation Preempted Notification (RESPRE) + + ULONG Reserved1 : 28; + +} NVME_CDW11_FEATURE_RESERVATION_NOTIFICATION_MASK, *PNVME_CDW11_FEATURE_RESERVATION_NOTIFICATION_MASK; + +typedef union { + NVME_CDW11_FEATURE_NUMBER_OF_QUEUES NumberOfQueues; + NVME_CDW11_FEATURE_INTERRUPT_COALESCING InterruptCoalescing; + NVME_CDW11_FEATURE_INTERRUPT_VECTOR_CONFIG InterruptVectorConfig; + NVME_CDW11_FEATURE_LBA_RANGE_TYPE LbaRangeType; + NVME_CDW11_FEATURE_ARBITRATION Arbitration; + NVME_CDW11_FEATURE_VOLATILE_WRITE_CACHE VolatileWriteCache; + NVME_CDW11_FEATURE_ASYNC_EVENT_CONFIG AsyncEventConfig; + NVME_CDW11_FEATURE_POWER_MANAGEMENT PowerManagement; + NVME_CDW11_FEATURE_AUTO_POWER_STATE_TRANSITION AutoPowerStateTransition; + NVME_CDW11_FEATURE_TEMPERATURE_THRESHOLD TemperatureThreshold; + NVME_CDW11_FEATURE_ERROR_RECOVERY ErrorRecovery; + NVME_CDW11_FEATURE_HOST_MEMORY_BUFFER HostMemoryBuffer; + NVME_CDW11_FEATURE_WRITE_ATOMICITY_NORMAL WriteAtomicityNormal; + NVME_CDW11_FEATURE_NON_OPERATIONAL_POWER_STATE NonOperationalPowerState; + NVME_CDW11_FEATURE_IO_COMMAND_SET_PROFILE IoCommandSetProfile; + NVME_CDW11_FEATURE_ERROR_INJECTION ErrorInjection; + NVME_CDW11_FEATURE_HOST_IDENTIFIER HostIdentifier; + NVME_CDW11_FEATURE_RESERVATION_PERSISTENCE ReservationPersistence; + NVME_CDW11_FEATURE_RESERVATION_NOTIFICATION_MASK ReservationNotificationMask; + NVME_CDW11_FEATURE_GET_HOST_METADATA GetHostMetadata; + NVME_CDW11_FEATURE_SET_HOST_METADATA SetHostMetadata; + + ULONG AsUlong; +} NVME_CDW11_FEATURES, *PNVME_CDW11_FEATURES; + +typedef union { + NVME_CDW12_FEATURE_HOST_MEMORY_BUFFER HostMemoryBuffer; + + ULONG AsUlong; +} NVME_CDW12_FEATURES, *PNVME_CDW12_FEATURES; + +typedef union { + NVME_CDW13_FEATURE_HOST_MEMORY_BUFFER HostMemoryBuffer; + + ULONG AsUlong; +} NVME_CDW13_FEATURES, *PNVME_CDW13_FEATURES; + +typedef union { + NVME_CDW14_FEATURE_HOST_MEMORY_BUFFER HostMemoryBuffer; + + ULONG AsUlong; +} NVME_CDW14_FEATURES, *PNVME_CDW14_FEATURES; + +typedef union { + NVME_CDW15_FEATURE_HOST_MEMORY_BUFFER HostMemoryBuffer; + + ULONG AsUlong; +} NVME_CDW15_FEATURES, *PNVME_CDW15_FEATURES; + +// +// NVMe Maximum log size +// +#define NVME_MAX_LOG_SIZE 0x1000 + +// +// NVM Express Log Page Identifier values for NVME_ADMIN_COMMAND_GET_LOG_PAGE Command +// +typedef enum { + + NVME_LOG_PAGE_SUPPORTED_LOG_PAGES = 0x00, + NVME_LOG_PAGE_ERROR_INFO = 0x01, + NVME_LOG_PAGE_HEALTH_INFO = 0x02, + NVME_LOG_PAGE_FIRMWARE_SLOT_INFO = 0x03, + NVME_LOG_PAGE_CHANGED_NAMESPACE_LIST = 0x04, + NVME_LOG_PAGE_COMMAND_EFFECTS = 0x05, + NVME_LOG_PAGE_DEVICE_SELF_TEST = 0x06, + NVME_LOG_PAGE_TELEMETRY_HOST_INITIATED = 0x07, + NVME_LOG_PAGE_TELEMETRY_CTLR_INITIATED = 0x08, + NVME_LOG_PAGE_ENDURANCE_GROUP_INFORMATION = 0x09, + NVME_LOG_PAGE_PREDICTABLE_LATENCY_NVM_SET = 0x0A, + NVME_LOG_PAGE_PREDICTABLE_LATENCY_EVENT_AGGREGATE = 0x0B, + NVME_LOG_PAGE_ASYMMETRIC_NAMESPACE_ACCESS = 0x0C, + NVME_LOG_PAGE_PERSISTENT_EVENT_LOG = 0x0D, + NVME_LOG_PAGE_LBA_STATUS_INFORMATION = 0x0E, // NVM Express NVM Command Set + NVME_LOG_PAGE_ENDURANCE_GROUP_EVENT_AGGREGATE = 0x0F, + NVME_LOG_PAGE_MEDIA_UNIT_STATUS = 0x10, + NVME_LOG_PAGE_SUPPORTED_CAPACITY_CONFIGURATION_LIST = 0X11, + NVME_LOG_PAGE_FEATURE_IDENTIFIERS_SUPPORTED_AND_EFFECTS = 0x12, + NVME_LOG_PAGE_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS = 0x13, + NVME_LOG_PAGE_COMMAND_AND_FEATURE_LOCKDOWN = 0x14, + NVME_LOG_PAGE_BOOT_PARTITON = 0x15, + NVME_LOG_PAGE_ROTATIONAL_MEDIA_INFORMATION = 0x16, + NVME_LOG_PAGE_DISCOVERY = 0x70, + NVME_LOG_PAGE_RESERVATION_NOTIFICATION = 0x80, + NVME_LOG_PAGE_SANITIZE_STATUS = 0x81, + NVME_LOG_PAGE_CHANGED_ZONE_LIST = 0xBF, // NVM Express Zoned Namespace Command Set + +} NVME_LOG_PAGES; + +// +// Get LOG PAGE format which conforms to < 1.2.1 NVMe Specification +// +typedef union { + + struct { + ULONG LID : 8; // Log Page Identifier (LID) + ULONG Reserved0 : 8; + ULONG NUMD : 12; // Number of Dwords (NUMD) + ULONG Reserved1 : 4; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_GET_LOG_PAGE, *PNVME_CDW10_GET_LOG_PAGE; + +// +// Get LOG PAGE format which conforms to 1.2.1 NVMe Specification +// +typedef union { + + struct { + ULONG LID : 8; // Log Page Identifier (LID) + ULONG Reserved0 : 8; + ULONG NUMDL : 16; // Number of Dwords Lower (NUMDL) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_GET_LOG_PAGE_V121, *PNVME_CDW10_GET_LOG_PAGE_V121; + +// +// Get Log Page CDW10 format for NVM Express specification revisions 1.3a thru 1.4, inclusive. +// +typedef union { + + struct { + ULONG LID : 8; // Log Page Identifier (LID) + ULONG LSP : 4; // Log Specific Field (LSP) + ULONG Reserved0 : 3; + ULONG RAE : 1; // Retain Asynchronous Event (RAE) + ULONG NUMDL : 16; // Number of Lower Dwords (NUMDL) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_GET_LOG_PAGE_V13, *PNVME_CDW10_GET_LOG_PAGE_V13; + +// +// Get Log Page CDW10 format for NVM Express Base Specification revision 2.0a and above. +// +typedef union { + + struct { + ULONG LID : 8; // Log Page Identifier (LID) + ULONG LSP : 7; // Log Specific Field (LSP) + ULONG RAE : 1; // Retain Asynchronous Event (RAE) + ULONG NUMDL : 16; // Number of Lower Dwords (NUMDL) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_GET_LOG_PAGE_V20, *PNVME_CDW10_GET_LOG_PAGE_V20; + +// +// Defined values for bits 09:08 of Log Specific Field (LSP) in CDW10 for Get Log Page, Persistent Event Log (Log Identifier 0Dh) +// NVM Express Base Specification, revision >= 2.0a. +// + +#define NVME_CDW10_LSP_ACTION_READ_LOG_DATA 0x0 +#define NVME_CDW10_LSP_ACTION_ESTABLISH_CONTEXT_AND_READ_LOG_DATA 0x1 +#define NVME_CDW10_LSP_ACTION_RELEASE_CONTEXT 0x2 +#define NVME_CDW10_LSP_ACTION_ESTABLISH_CONTEXT_AND_READ_512_BYTES_OF_HEADER 0x3 + +typedef union { + + struct { + ULONG NUMDU : 16; // Number of Upper Dwords (NUMDU) + ULONG LogSpecificIdentifier : 16; // Log Specific Identifier (Reserved prior to NVM Express 1.4 specification) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_GET_LOG_PAGE, *PNVME_CDW11_GET_LOG_PAGE; + +typedef union { + + ULONG LPOL; // Log Page Offset Lower (LPOL) + + ULONG AsUlong; + +} NVME_CDW12_GET_LOG_PAGE, *PNVME_CDW12_GET_LOG_PAGE; + +typedef union { + + ULONG LPOU; // Log Page Offset Upper (LPOU) + + ULONG AsUlong; + +} NVME_CDW13_GET_LOG_PAGE, *PNVME_CDW13_GET_LOG_PAGE; + +typedef union { + + struct { + ULONG UUIDIndex : 7; // UUID Index + ULONG Reserved : 16; + ULONG OT : 1; // Offset Type + ULONG CommandSetIdentifier : 8; // Command Set Identifier (CSI) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW14_GET_LOG_PAGE, *PNVME_CDW14_GET_LOG_PAGE; + +typedef union { + + struct { + ULONG UUIDIndex : 7; // UUID Index + ULONG Reserved : 16; + ULONG OffsetType : 1; // Offset Type (OT) + ULONG CommandSetIdentifier : 8; // Command Set Identifier (CSI) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW14_GET_LOG_PAGE_V20, *PNVME_CDW14_GET_LOG_PAGE_V20; + +// +// Information of log: NVME_LOG_PAGE_SUPPORTED_LOG_PAGES. Size: 1024 bytes +// + +// +// LID Supported and Effects Data Structure - LID Specific Field for Log Page Identifier 0Dh (NVME_LOG_PAGE_PERSISTENT_EVENT_LOG) +// + +typedef struct { + + USHORT EstablishContextAndRead512BytesOfHeaderSupported : 1; + USHORT Reserved : 15; + +} NVME_LID_SPECIFIC_PERSISTENT_EVENT_LOG, *PNVME_LID_SPECIFIC_PERSISTENT_EVENT_LOG; + +// +// Get Log Page - LID Supported and Effects Data Structure (Log Identifier 00h) +// + +typedef struct { + + ULONG LSUPP : 1; // LID Supported + ULONG IOS : 1; // Index Offset Supported + ULONG Reserved : 14; // Note, 2.0a spec typo shows as bits 31:2 + ULONG LIDSpecific : 16; // LID Specific Field (bits 31:16) + +} NVME_LID_SUPPORTED_AND_EFFECTS, *PNVME_LID_SUPPORTED_AND_EFFECTS; + +#define NVME_NUM_LOG_PAGE_IDENTIFIERS 256 +#define NVME_MAX_LOG_PAGE_IDENTIFIER 0xFF // Highest legal Log Page Identifier value. + +// +// Get Log Pages - Supported Log Pages - Log (Log Identifier 00h). Size: 1024 bytes. +// + +typedef struct { + + NVME_LID_SUPPORTED_AND_EFFECTS LogPageIdentifierSupported[NVME_NUM_LOG_PAGE_IDENTIFIERS]; + +} NVME_SUPPORTED_LOG_PAGES_LOG, *PNVME_SUPPORTED_LOG_PAGES_LOG; + +// +// Information of log: NVME_LOG_PAGE_ERROR_INFO. Size: 64 bytes +// +typedef struct { + + ULONGLONG ErrorCount; + USHORT SQID; // Submission Queue ID + USHORT CMDID; // Command ID + NVME_COMMAND_STATUS Status; // Status Field: This field indicates the Status Field for the command that completed. The Status + // Field is located in bits 15:01, bit 00 corresponds to the Phase Tag posted for the command. + + struct { + USHORT Byte : 8; // Byte in command that contained the error. + USHORT Bit : 3; // Bit in command that contained the error. + USHORT Reserved : 5; + } ParameterErrorLocation; + + ULONGLONG Lba; // LBA: This field indicates the first LBA that experienced the error condition, if applicable. + ULONG NameSpace; // Namespace: This field indicates the namespace that the error is associated with, if applicable. + + UCHAR VendorInfoAvailable; // Vendor Specific Information Available + + UCHAR TRTYPE; // NVMEOF_TRANSPORT_TYPE + + UCHAR Reserved0[2]; + + ULONGLONG CommandSpecificInfo; // This field contains command specific information. If used, the command definition specifies the information returned. + + USHORT TransportTypeSpecificInfo; // This field contains the transport type specific error information. + + UCHAR Reserved1[22]; + +} NVME_ERROR_INFO_LOG, *PNVME_ERROR_INFO_LOG; + +// +// Information of log: NVME_LOG_PAGE_HEALTH_INFO. Size: 512 bytes +// +typedef struct { + + union { + + struct { + UCHAR AvailableSpaceLow : 1; // If set to 1, then the available spare space has fallen below the threshold. + UCHAR TemperatureThreshold : 1; // If set to 1, then a temperature is above an over temperature threshold or below an under temperature threshold. + UCHAR ReliabilityDegraded : 1; // If set to 1, then the device reliability has been degraded due to significant media related errors or any internal error that degrades device reliability. + UCHAR ReadOnly : 1; // If set to 1, then the media has been placed in read only mode + UCHAR VolatileMemoryBackupDeviceFailed : 1; // If set to 1, then the volatile memory backup device has failed. This field is only valid if the controller has a volatile memory backup solution. + UCHAR Reserved : 3; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } CriticalWarning; // This field indicates critical warnings for the state of the controller. Each bit corresponds to a critical warning type; multiple bits may be set. + + UCHAR Temperature[2]; // Temperature: Contains the temperature of the overall device (controller and NVM included) in units of Kelvin. If the temperature exceeds the temperature threshold, refer to section 5.12.1.4, then an asynchronous event completion may occur + UCHAR AvailableSpare; // Available Spare: Contains a normalized percentage (0 to 100%) of the remaining spare capacity available + UCHAR AvailableSpareThreshold; // Available Spare Threshold: When the Available Spare falls below the threshold indicated in this field, an asynchronous event completion may occur. The value is indicated as a normalized percentage (0 to 100%). + UCHAR PercentageUsed; // Percentage Used + UCHAR Reserved0[26]; + + UCHAR DataUnitRead[16]; // Data Units Read: Contains the number of 512 byte data units the host has read from the controller; this value does not include metadata. This value is reported in thousands (i.e., a value of 1 corresponds to 1000 units of 512 bytes read) and is rounded up. When the LBA size is a value other than 512 bytes, the controller shall convert the amount of data read to 512 byte units. For the NVM command set, logical blocks read as part of Compare and Read operations shall be included in this value + UCHAR DataUnitWritten[16]; // Data Units Written: Contains the number of 512 byte data units the host has written to the controller; this value does not include metadata. This value is reported in thousands (i.e., a value of 1 corresponds to 1000 units of 512 bytes written) and is rounded up. When the LBA size is a value other than 512 bytes, the controller shall convert the amount of data written to 512 byte units. For the NVM command set, logical blocks written as part of Write operations shall be included in this value. Write Uncorrectable commands shall not impact this value. + UCHAR HostReadCommands[16]; // Host Read Commands: Contains the number of read commands completed by the controller. For the NVM command set, this is the number of Compare and Read commands. + UCHAR HostWrittenCommands[16]; // Host Write Commands: Contains the number of write commands completed by the controller. For the NVM command set, this is the number of Write commands. + UCHAR ControllerBusyTime[16]; // Controller Busy Time: Contains the amount of time the controller is busy with I/O commands. The controller is busy when there is a command outstanding to an I/O Queue (specifically, a command was issued via an I/O Submission Queue Tail doorbell write and the corresponding completion queue entry has not been posted yet to the associated I/O Completion Queue). This value is reported in minutes. + UCHAR PowerCycle[16]; // Power Cycles: Contains the number of power cycles. + UCHAR PowerOnHours[16]; // Power On Hours: Contains the number of power-on hours. This does not include time that the controller was powered and in a low power state condition. + UCHAR UnsafeShutdowns[16]; // Unsafe Shutdowns: Contains the number of unsafe shutdowns. This count is incremented when a shutdown notification (CC.SHN) is not received prior to loss of power. + UCHAR MediaErrors[16]; // Media Errors: Contains the number of occurrences where the controller detected an unrecovered data integrity error. Errors such as uncorrectable ECC, CRC checksum failure, or LBA tag mismatch are included in this field. + UCHAR ErrorInfoLogEntryCount[16]; // Number of Error Information Log Entries: Contains the number of Error Information log entries over the life of the controller + ULONG WarningCompositeTemperatureTime; // Warning Composite Temperature Time: Contains the amount of time in minutes that the controller is operational and the Composite Temperature is greater than or equal to the Warning Composite Temperature Threshold (WCTEMP) field and less than the Critical Composite Temperature Threshold (CCTEMP) field in the Identify Controller data structure + ULONG CriticalCompositeTemperatureTime; // Critical Composite Temperature Time: Contains the amount of time in minutes that the controller is operational and the Composite Temperature is greater the Critical Composite Temperature Threshold (CCTEMP) field in the Identify Controller data structure + USHORT TemperatureSensor1; // Contains the current temperature reported by temperature sensor 1. + USHORT TemperatureSensor2; // Contains the current temperature reported by temperature sensor 2. + USHORT TemperatureSensor3; // Contains the current temperature reported by temperature sensor 3. + USHORT TemperatureSensor4; // Contains the current temperature reported by temperature sensor 4. + USHORT TemperatureSensor5; // Contains the current temperature reported by temperature sensor 5. + USHORT TemperatureSensor6; // Contains the current temperature reported by temperature sensor 6. + USHORT TemperatureSensor7; // Contains the current temperature reported by temperature sensor 7. + USHORT TemperatureSensor8; // Contains the current temperature reported by temperature sensor 8. + UCHAR Reserved1[296]; + +} NVME_HEALTH_INFO_LOG, *PNVME_HEALTH_INFO_LOG; + +// +// "Telemetry Host-Initiated Log" structure definition. +// + +#define NVME_TELEMETRY_DATA_BLOCK_SIZE 0x200 // All NVMe Telemetry Data Blocks are 512 bytes in size. + +typedef struct _NVME_TELEMETRY_HOST_INITIATED_LOG { + + UCHAR LogIdentifier; // Byte 0 + UCHAR Reserved0[4]; // Bytes 1-4 + UCHAR OrganizationID[3]; // Bytes 5-7 - IEEE OUI Identifier + USHORT Area1LastBlock; // Bytes 8-9 + USHORT Area2LastBlock; // Bytes 10-11 + USHORT Area3LastBlock; // Bytes 12-13 + UCHAR Reserved1[2]; // Bytes 14-15 + ULONG Area4LastBlock; // Bytes 16-19 + UCHAR Reserved2[361]; // Bytes 20-380 + UCHAR HostInitiatedDataGenerationNumber; // Byte 381 + UCHAR ControllerInitiatedDataAvailable; // Byte 382 + UCHAR ControllerInitiatedDataGenerationNumber; // Byte 383 + UCHAR ReasonIdentifier[128]; // Bytes 384-511 + +} NVME_TELEMETRY_HOST_INITIATED_LOG, *PNVME_TELEMETRY_HOST_INITIATED_LOG; + +// +// "Telemetry Controller-Initiated Log" structure definition. +// +typedef struct _NVME_TELEMETRY_CONTROLLER_INITIATED_LOG { + + UCHAR LogIdentifier; // Byte 0 + UCHAR Reserved0[4]; // Bytes 1-4 + UCHAR OrganizationID[3]; // Bytes 5-7 - IEEE OUI Identifier + USHORT Area1LastBlock; // Bytes 8-9 + USHORT Area2LastBlock; // Bytes 10-11 + USHORT Area3LastBlock; // Bytes 12-13 + UCHAR Reserved1[2]; // Bytes 14-15 + ULONG Area4LastBlock; // Bytes 16-19 + UCHAR Reserved2[362]; // Bytes 20-381 + UCHAR ControllerInitiatedDataAvailable; // Byte 382 + UCHAR ControllerInitiatedDataGenerationNumber; // Byte 383 + UCHAR ReasonIdentifier[128]; // Bytes 384-511 + +} NVME_TELEMETRY_CONTROLLER_INITIATED_LOG, *PNVME_TELEMETRY_CONTROLLER_INITIATED_LOG; + +// +// Information of log: NVME_LOG_PAGE_FIRMWARE_SLOT_INFO. Size: 512 bytes +// +typedef struct { + + struct { + UCHAR ActiveSlot : 3; // Bits 2:0 indicates the firmware slot that contains the actively running firmware revision. + UCHAR Reserved0 : 1; + UCHAR PendingActivateSlot : 3; // Bits 6:4 indicates the firmware slot that is going to be activated at the next controller reset. + UCHAR Reserved1 : 1; + } AFI; // Active Firmware Info (AFI) + + UCHAR Reserved0[7]; + + ULONGLONG FRS[7]; // Firmware Revision for Slot 1 - 7(FRS1 - FRS7): Contains the revision of the firmware downloaded to firmware slot 1 - 7. + + UCHAR Reserved1[448]; + +} NVME_FIRMWARE_SLOT_INFO_LOG, *PNVME_FIRMWARE_SLOT_INFO_LOG; + +// +// Information of log: NVME_LOG_PAGE_CHANGED_NAMESPACE_LIST. Size: 4096 bytes +// +typedef struct { + + ULONG NSID[1024]; // List of Namespace ID upto 1024 entries + +} NVME_CHANGED_NAMESPACE_LIST_LOG, *PNVME_CHANGED_NAMESPACE_LIST_LOG; + +// +// Information of log: NVME_LOG_PAGE_CHANGED_ZONE_LIST. Size: 4096 bytes +// +typedef struct { + + USHORT ZoneIdentifiersCount; // Number of Zone Identifiers + UCHAR Reserved[6]; + + ULONGLONG ZoneIdentifier[511]; // List of Zone Identifiers upto 511 entries. Identifier contains Zone Start Logical Block Address(ZSLBA) + +} NVME_CHANGED_ZONE_LIST_LOG, *PNVME_CHANGED_ZONE_LIST_LOG; + + +// +// Information of log: NVME_LOG_PAGE_COMMAND_EFFECTS. Size: 4096 bytes +// +typedef enum { + + NVME_COMMAND_EFFECT_SBUMISSION_EXECUTION_LIMIT_NONE = 0, + NVME_COMMAND_EFFECT_SBUMISSION_EXECUTION_LIMIT_SINGLE_PER_NAMESPACE = 1, + NVME_COMMAND_EFFECT_SBUMISSION_EXECUTION_LIMIT_SINGLE_PER_CONTROLLER = 2, + +} NVME_COMMAND_EFFECT_SBUMISSION_EXECUTION_LIMITS; + +typedef union { + + struct { + //LSB + ULONG CSUPP : 1; // Command Supported (CSUPP) + ULONG LBCC : 1; // Logical Block Content Change (LBCC) + ULONG NCC : 1; // Namespace Capability Change (NCC) + ULONG NIC : 1; // Namespace Inventory Change (NIC) + ULONG CCC : 1; // Controller Capability Change (CCC) + ULONG Reserved : 11; + ULONG CSE : 3; // Command Submission and Execution (CSE) + ULONG UUIDSelectionSupported : 1; // UUID Selection Supported + ULONG CSPNamespace : 1; // Namespace Scope + ULONG CSPController : 1; // Controller Scope + ULONG CSPNVMSet : 1; // NVM Set Scope + ULONG CSPEnduranceGroup : 1; // Endurance Group Scope + ULONG CSPDomain : 1; // Domain Scope + ULONG CSPNVMSubsystem : 1; // NVM Subsystem Scope + ULONG CSPReserved : 6; + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_COMMAND_EFFECTS_DATA, *PNVME_COMMAND_EFFECTS_DATA; + + +typedef struct { + + NVME_COMMAND_EFFECTS_DATA ACS[256]; // Admin Command Supported + NVME_COMMAND_EFFECTS_DATA IOCS[256]; // I/O Command Supported + + UCHAR Reserved[2048]; + +} NVME_COMMAND_EFFECTS_LOG, *PNVME_COMMAND_EFFECTS_LOG; + +#define NVME_VENDOR_SPECIFIC_ADMIN_COMMAND_MIN_OPCODE 0xC0 +#define NVME_VENDOR_SPECIFIC_ADMIN_COMMAND_MAX_OPCODE 0xFF + +#define NVME_VENDOR_SPECIFIC_NVM_COMMAND_MIN_OPCODE 0x80 +#define NVME_VENDOR_SPECIFIC_NVM_COMMAND_MAX_OPCODE 0xFF + + +#pragma pack(push, 1) +typedef struct { + + struct { + UCHAR Result : 4; // Result of Device Self-Test operation of this particular result data + UCHAR CodeValue : 4; // Self-Test code value that was specified in command + } Status; + + UCHAR SegmentNumber; // Indicates the first segment that failure occured + + struct { + UCHAR NSIDValid : 1; // If set to 1, the contents of Namespace Identifier field is valid + UCHAR FLBAValid : 1; // If set to 1, the contents of Failing LBA field is valid + UCHAR SCTValid : 1; // If set to 1, the contents of Status Code Type field is valid + UCHAR SCValid : 1; // If set to 1, the contents of Status Code field is valid + UCHAR Reserved : 4; + } ValidDiagnostics; + + UCHAR Reserved; + + ULONGLONG POH; // Power On Hours, when test operation was completed/aborted + ULONG NSID; // Namespace Identifier. Only valid if NSIDValid is set + ULONGLONG FailingLBA; // Failed LBA which caused test to fail. Only valid if FLBAValid is set + + struct { + UCHAR AdditionalInfo : 3; // Additional information related to errors/conditions. Only valid if SCTValid is set + UCHAR Reserved : 5; + } StatusCodeType; + + UCHAR StatusCode; // Additional information related to errors/conditons. Only valid if SCValid is set + USHORT VendorSpecific; + +} NVME_DEVICE_SELF_TEST_RESULT_DATA, *PNVME_DEVICE_SELF_TEST_RESULT_DATA; + +// +// Information of log: NVME_LOG_PAGE_DEVICE_SELF_TEST. Size: 564 bytes +// +typedef struct { + + struct { + UCHAR Status : 4; // Status of current Device Self-Test operation + UCHAR Reserved : 4; + } CurrentOperation; + + struct { + UCHAR CompletePercent : 7; // Percentage of completion of Device Self-Test operation. Valid if Status field is non-zero. + UCHAR Reserved : 1; + } CurrentCompletion; + + UCHAR Reserved[2]; + + NVME_DEVICE_SELF_TEST_RESULT_DATA ResultData[20]; // Last 20 Self-Test Result Data, latest to oldest available in sorted order + +} NVME_DEVICE_SELF_TEST_LOG, *PNVME_DEVICE_SELF_TEST_LOG; + +// +// Information of log: NVME_LOG_PAGE_ENDURANCE_GROUP_INFORMATION. Size: 512 bytes +// +typedef struct { + + ULONG Reserved0; + UCHAR AvailableSpareThreshold; // Available spare indicated as normalized percentage (0-100) + UCHAR PercentageUsed; // Vendor specific estimate of percentage of life used for the NVM set(s) of Endurance Group (Billion Unit) + + UCHAR Reserved1[26]; + UCHAR EnduranceEstimate[16]; // Estimate of total number of data bytes written to NVM set(s) of Endurance Group (Billion Unit) + UCHAR DataUnitsRead[16]; // Total number of data bytes read from NVM set(s) of Endurance Group (Billion Unit) + UCHAR DataUnitsWritten[16]; // Total number of data bytes written to NVM sets(s) of Endurance Group (Billion Unit) + // Includes only host writes + + UCHAR MediaUnitsWritten[16]; // Total number of data bytes written to NVM sets(s) of Endurance Group (Billion Unit) + // Includes both host and controller writes. + + UCHAR Reserved2[416]; + +} NVME_ENDURANCE_GROUP_LOG, *PNVME_ENDURANCE_GROUP_LOG; + +// +// Information of log: NVME_LOG_PAGE_PERSISTENT_EVENT_LOG. Header Size: 512 bytes +// +typedef struct { + + UCHAR LogIdentifier; // Byte 0 - Shall be set to 0x0D + UCHAR Reserved0[3]; // Bytes 1-3 + ULONG TotalNumberOfEvents; // Bytes 4-7 - Contains the number of event entries in the log. + ULONGLONG TotalLogLength; // Bytes 8-15 - Contains the total number of bytes of persistent event log page data available, including the header. + UCHAR LogRevision; // Bytes 16 - Contains a number indicating the revision of the Get Log Page data structure that this log page data complies with. + UCHAR Reserved1; // Bytes 17 + USHORT LogHeaderLength; // Bytes 18-19 - Contains the length in bytes of the log header information that follows. The total length of the log header in bytes is the value in this field plus 20. + ULONGLONG Timestamp; // Bytes 20-27 + UCHAR PowerOnHours[16]; // Bytes 28-43 - Indicates the number of power-on hours at the time the Persistent Event log was retrieved. + ULONGLONG PowerCycleCount; // Bytes 44-51 - Contains the number of power cycles for the controller. + USHORT PciVendorId; // Bytes 52-53 - Same value as reported in the Identify Controller data PCI Vendor ID field. + USHORT PciSubsystemVendorId; // Bytes 54-55 - Same value as reported in the Identify Controller data PCI Subsystem Vendor ID field. + UCHAR SerialNumber[20]; // Bytes 56-75 - Same value as reported in the Identify Controller data Serial Number field. + UCHAR ModelNumber[40]; // Bytes 76-115 - Same value as reported in the Identify Controller data Model Number field. + UCHAR NVMSubsystemNVMeQualifiedName[256]; // Bytes 116-371 - Same value as reported in the Identify Controller data. + UCHAR Reserved[108]; // Bytes 372-479 + UCHAR SupportedEventsBitmap[32]; // Bytes 480-511 - Contains a bitmap indicating support for the persistent event log events. + +} NVME_PERSISTENT_EVENT_LOG_HEADER, *PNVME_PERSISTENT_EVENT_LOG_HEADER; + +typedef struct { + + UCHAR EventType; // Byte 0 - Indicates the event type for this entry. + UCHAR EventTypeRevision; // Byte 1 - Contains a number indicating the revision of the event data. + UCHAR EventHeaderLength; // Byte 2 - Contains the length in bytes of the event header information that follows. + UCHAR Reserved0; // Byte 3 + USHORT ControllerIdentifier; // Bytes 4-5 - Contains the NVM subsystem unique controller identifier for the controller that created this event. + ULONGLONG EventTimestamp; // Bytes 6-13 + UCHAR Reserved1[6]; // Bytes 14-19 + USHORT VendorSpecificInformationLength; // Bytes 20-21 - Indicates the length in bytes of the Vendor Specific Information. + USHORT EventLength; // Bytes 22-23 - Indicates the length in bytes of the Vendor Specific Information. + +} NVME_PERSISTENT_EVENT_LOG_EVENT_HEADER, *PNVME_PERSISTENT_EVENT_LOG_EVENT_HEADER; + +typedef enum { + + NVME_PERSISTENT_EVENT_TYPE_RESERVED0 = 0x00, + + NVME_PERSISTENT_EVENT_TYPE_SMART_HEALTH_LOG_SNAPSHOT = 0x01, + NVME_PERSISTENT_EVENT_TYPE_FIRMWARE_COMMIT = 0x02, + NVME_PERSISTENT_EVENT_TYPE_TIMESTAMP_CHANGE = 0x03, + NVME_PERSISTENT_EVENT_TYPE_POWER_ON_OR_RESET = 0x04, + NVME_PERSISTENT_EVENT_TYPE_NVM_SUBSYSTEM_HARDWARE_ERROR = 0x05, + NVME_PERSISTENT_EVENT_TYPE_CHANGE_NAMESPACE = 0x06, + NVME_PERSISTENT_EVENT_TYPE_FORMAT_NVM_START = 0x07, + NVME_PERSISTENT_EVENT_TYPE_FORMAT_NVM_COMPLETION = 0x08, + NVME_PERSISTENT_EVENT_TYPE_SANITIZE_START = 0x09, + NVME_PERSISTENT_EVENT_TYPE_SANITIZE_COMPLETION = 0x0A, + NVME_PERSISTENT_EVENT_TYPE_SET_FEATURE = 0x0B, + NVME_PERSISTENT_EVENT_TYPE_TELEMETRY_LOG_CREATED = 0x0C, + NVME_PERSISTENT_EVENT_TYPE_THERMAL_EXCURSION = 0x0D, + + NVME_PERSISTENT_EVENT_TYPE_RESERVED1_BEGIN = 0x0E, + NVME_PERSISTENT_EVENT_TYPE_RESERVED1_END = 0xDD, + + NVME_PERSISTENT_EVENT_TYPE_VENDOR_SPECIFIC_EVENT = 0xDE, + NVME_PERSISTENT_EVENT_TYPE_TCG_DEFINED = 0xDF, + + NVME_PERSISTENT_EVENT_TYPE_RESERVED2_BEGIN = 0xE0, + NVME_PERSISTENT_EVENT_TYPE_RESERVED2_END = 0xFF, + + NVME_PERSISTENT_EVENT_TYPE_MAX = 0xFF, + +} NVME_PERSISTENT_EVENT_LOG_EVENT_TYPES; + +#pragma pack(pop) + +// +// Information of log: NVME_LOG_PAGE_FEATURE_IDENTIFIERS_SUPPORTED_AND_EFFECTS (Log Identifier: 12h). Size: 1024 bytes +// Note: This log page describes the FIDs that are supported on the interface to which the Get Log Page command was +// submitted and the effects of those features on the state of the NVM subsystem. +// + +typedef struct { + + ULONG FSUPP : 1; // FID Supported + ULONG UDCC : 1; // User Data Content Change + ULONG NCC : 1; // Namespace Capability Change + ULONG NIC : 1; // Namespace Inventory Change + ULONG CCC : 1; // Controller Capability Change + ULONG Reserved : 14; // Reserved + ULONG UUIDSelectionSupported : 1; // UUID Selection Supported + ULONG FSPNamespace : 1; // Namespace Scope + ULONG FSPController : 1; // Controller Scope + ULONG FSPNVMSet : 1; // NVM Set Scope + ULONG FSPEnduranceGroup : 1; // Endurance Group Scope + ULONG FSPDomain : 1; // Domain Scope + ULONG FSPNVMSubsystem : 1; // NVM Subsystem Scope + ULONG FSPReserved : 6; + +} NVME_FID_SUPPORTED_AND_EFFECTS, *PNVME_FID_SUPPORTED_AND_EFFECTS; + +#define NVME_NUM_FID_SUPPORTED 256 + +typedef struct { + + NVME_FID_SUPPORTED_AND_EFFECTS FeatureIdentifierSupported[NVME_NUM_FID_SUPPORTED]; + +} NVME_FEATURE_IDENTIFIERS_EFFECTS_LOG, *PNVME_FEATURE_IDENTIFIERS_EFFECTS_LOG; + +#define NVME_VENDOR_SPECIFIC_FEATURE_MIN_IDENTIFIER 0xC0 +#define NVME_VENDOR_SPECIFIC_FEATURE_MAX_IDENTIFIER 0xFF + + +// +// Log Page: NVME_LOG_PAGE_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS (Log Identifier: 13h). Size: 4096 bytes +// + +typedef struct { + + ULONG CSUPP : 1; // Command Supported + ULONG UDCC : 1; // User Data Content Change + ULONG NCC : 1; // Namespace Capability Change + ULONG NIC : 1; // Namespace Inventory Change + ULONG CCC : 1; // Controller Capability Change + ULONG Reserved : 15; // Reserved + ULONG CSPNamespace : 1; // Namespace Scope + ULONG CSPController : 1; // Controller Scope + ULONG CSPNVMSet : 1; // NVM Set Scope + ULONG CSPEnduranceGroup : 1; // Endurance Group Scope + ULONG CSPDomain : 1; // Domain Scope + ULONG CSPNVMSubsystem : 1; // NVM Subsystem Scope + ULONG CSPReserved : 6; + +} NVME_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS, *PNVME_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS; + +#define NVME_NUM_NVME_MI_COMMANDS_SUPPORTED 256 + +typedef struct { + + NVME_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS ManagementInterfaceCommandSupported[NVME_NUM_NVME_MI_COMMANDS_SUPPORTED]; + UCHAR Reserved[3 * 1024]; + +} NVME_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS_LOG, *PNVME_NVME_MI_COMMANDS_SUPPORTED_AND_EFFECTS_LOG; + +// +// Information of log: NVME_LOG_PAGE_RESERVATION_NOTIFICATION. Size: 64 bytes +// +typedef enum { + + NVME_RESERVATION_NOTIFICATION_TYPE_EMPTY_LOG_PAGE = 0, + NVME_RESERVATION_NOTIFICATION_TYPE_REGISTRATION_PREEMPTED = 1, + NVME_RESERVATION_NOTIFICATION_TYPE_REGISTRATION_RELEASED = 2, + NVME_RESERVATION_NOTIFICATION_TYPE_RESERVATION_PREEPMPTED = 3, + +} NVME_RESERVATION_NOTIFICATION_TYPES; + +typedef struct { + + ULONGLONG LogPageCount; // Log Page Count + UCHAR LogPageType; // Reservation Notification Log Page Type. + UCHAR AvailableLogPageCount; // Number of Available Log Pages + UCHAR Reserved0[2]; + ULONG NameSpaceId; // Namespace ID + UCHAR Reserved1[48]; + +} NVME_RESERVATION_NOTIFICATION_LOG, *PNVME_RESERVATION_NOTIFICATION_LOG; + +// +// Information of log: NVME_SANITIZE_STATUS_LOG. Size: 512 bytes +// +typedef enum { + + // + // The NVM subsystem has never been sanitized. + // + NVME_SANITIZE_OPERATION_NONE = 0, + + // + // The most recent sanitize operation completed successfully including + // any additional media modification. + // + NVME_SANITIZE_OPERATION_SUCCEEDED = 1, + + // + // A sanitize operation is currently in progress. + // + NVME_SANITIZE_OPERATION_IN_PROGRESS = 2, + + // + // The most recent sanitize operation failed. + // + NVME_SANITIZE_OPERATION_FAILED = 3, + + // + // The most recent sanitize operation for which No-Deallocate After Sanitize was Requested + // has completed successfully with deallocation of all LBAs. + // + NVME_SANITIZE_OPERATION_SUCCEEDED_WITH_FORCED_DEALLOCATION = 4 + +} NVME_SANITIZE_OPERATION_STATUS, *PNVME_SANITIZE_OPERATION_STATUS; + +typedef struct { + + // + // This contains the status of the most recent sanitize operation. + // The value of this field is defined in enum NVME_SANITIZE_OPERATION_STATUS. + // + USHORT MostRecentSanitizeOperationStatus : 3; + + // + // This contains the number of completed passes if the most recent sanitize operation + // was an Overwrite. + // + USHORT NumberCompletedPassesOfOverwrite : 4; + + // + // If set to 1, then no namespace logical block in the NVM subsystem has been written to + // and no Persistent Memory Region in the NVM subsystem has been enabled since manufactured + // or most recent successfully sanitized operation. + // + // If set to 0, then a namespace logical block in the NVM subsystem has been written to + // or a Persistent Memory Region in the NVM subsystem has been enabled since manufactured + // or most recent successfully sanitized operation. + // + USHORT GlobalDataErased : 1; + + USHORT Reserved : 8; + +} NVME_SANITIZE_STATUS, *PNVME_SANITIZE_STATUS; + +typedef struct { + + // + // Sanitize Progress (SPROG) + // This field indicates the fraction complete of the sanitize operation. The value is a numerator + // of the fraction complete that has 65536 (10000h) as its denominator. This value shall be set to + // FFFFh if bits 2:0 of the SSTAT field are not set to 10b. + // + USHORT SPROG; + + // + // Sanitize Status (SSTAT) + // This field indicates the status associated with the most recent sanitize operation. + // + NVME_SANITIZE_STATUS SSTAT; + + // + // Sanitize Command Dword 10 Information (SCDW10) + // This field contains the value of the Command Dword 10 field of the Sanitize command that started + // the sanitize operation whose status is reported in the SSTAT field. + // + ULONG SCDW10; + + // + // These fields below indicates the number of seconds required to complete the sanitize operation + // of Overwrite/Block Erase/Crypto Erase methods when the No-Deallocate Modifies Media After Sanitize + // field is not set to 10b. A value of 0 indicates that the sanitize operation is expected to be + // completed in the background when the Sanitize command that started that operation is completed. + // A value of FFFFFFFFh indicates that no time period is reported. + // + ULONG EstimatedTimeForOverwrite; + ULONG EstimatedTimeForBlockErase; + ULONG EstimatedTimeForCryptoErase; + + // + // These fields below indicates the number of seconds required to complete the sanitize operation + // of Overwrite/Block Erase/CryptoErase methods and the associated additional media modification + // after the sanitize operation. A value of 0 indicates that the sanitize operation is expected + // to be completed in the background when the Sanitize command that started that operation is completed. + // A value of FFFFFFFFh indicates that no time period is reported. + // + ULONG EstimatedTimeForOverwriteWithNoDeallocateMediaModification; + ULONG EstimatedTimeForBlockEraseWithNoDeallocateMediaModification; + ULONG EstimatedTimeForCryptoEraseWithNoDeallocateMediaModification; + + UCHAR Reserved[480]; + +} NVME_SANITIZE_STATUS_LOG, *PNVME_SANITIZE_STATUS_LOG; + + +// +// Parameters for FIRMWARE IMAGE DOWNLOAD Command +// +typedef struct { + + ULONG NUMD; // Number of Dwords (NUMD) + +} NVME_CDW10_FIRMWARE_DOWNLOAD, *PNVME_CDW10_FIRMWARE_DOWNLOAD; + +typedef struct { + + ULONG OFST; // Offset (OFST) + +} NVME_CDW11_FIRMWARE_DOWNLOAD, *PNVME_CDW11_FIRMWARE_DOWNLOAD; + +// +// Parameters for FIRMWARE ACTIVATE/COMMIT Commands +// +typedef enum { + + + // + // Downloaded image replaces the existing image, if any, in the specified Firmware Slot. + // The newly placed image is not activated. + // + NVME_FIRMWARE_ACTIVATE_ACTION_DOWNLOAD_TO_SLOT = 0, + + // + // Downloaded image replaces the existing image, if any, in the specified Firmware Slot. + // The newly placed image is activated at the next Controller Level Reset. + // + NVME_FIRMWARE_ACTIVATE_ACTION_DOWNLOAD_TO_SLOT_AND_ACTIVATE = 1, + + // + // The existing image in the specified Firmware Slot is activated at the next Controller + // Level Reset + // + NVME_FIRMWARE_ACTIVATE_ACTION_ACTIVATE = 2, + + // + // Downloaded image replaces the existing image, if any, in the specified Firmware Slot + // and is then activated immediately. If there is not a newly downloaded image, then the + // existing image in the specified firmware slot is activated immediately. + // + NVME_FIRMWARE_ACTIVATE_ACTION_DOWNLOAD_TO_SLOT_AND_ACTIVATE_IMMEDIATE = 3, + +} NVME_FIRMWARE_ACTIVATE_ACTIONS; + +typedef union { + + struct { + ULONG FS : 3; // Firmware Slot (FS) + ULONG AA : 2; // Activate Action (AA) + ULONG Reserved : 27; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_FIRMWARE_ACTIVATE, *PNVME_CDW10_FIRMWARE_ACTIVATE; + +// +// Parameters for FORMAT NVM Commands +// +typedef enum { + + NVME_PROTECTION_INFORMATION_NOT_ENABLED = 0, + NVME_PROTECTION_INFORMATION_TYPE1 = 1, + NVME_PROTECTION_INFORMATION_TYPE2 = 2, + NVME_PROTECTION_INFORMATION_TYPE3 = 3, + +} NVME_PROTECTION_INFORMATION_TYPES; + +typedef enum { + + NVME_SECURE_ERASE_NONE = 0, + NVME_SECURE_ERASE_USER_DATA = 1, + NVME_SECURE_ERASE_CRYPTOGRAPHIC = 2, + +} NVME_SECURE_ERASE_SETTINGS; + +typedef union { + + struct { + ULONG LBAF : 4; // LBA Format (LBAF) + ULONG MS : 1; // Metadata Settings (MS) + ULONG PI : 3; // Protection Information (PI) + ULONG PIL : 1; // Protection Information Location (PIL) + ULONG SES : 3; // Secure Erase Settings (SES) + ULONG ZF : 2; // Zone Format (ZF) + + ULONG Reserved : 18; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_FORMAT_NVM, *PNVME_CDW10_FORMAT_NVM; + +typedef enum { + + // + // Additional media modification after sanitize is not defined. + // + NVME_MEDIA_ADDITIONALLY_MODIFIED_AFTER_SANITIZE_NOT_DEFINED = 0, + + // + // Media is not additionally modified after sanitize completes successfully. + // + NVME_MEDIA_NOT_ADDITIONALLY_MODIFIED_AFTER_SANITIZE = 1, + + // + // Media is additionally modified after sanitize completes sucessfully. The Sanitize Operation Completed event + // does not occur until the additional media modification associated with this field has completed. + // + NVME_MEDIA_ADDITIONALLY_MOFIDIED_AFTER_SANITIZE = 2 + +} NVME_NO_DEALLOCATE_MODIFIES_MEDIA_AFTER_SANITIZE, *PNVME_NO_DEALLOCATE_MODIFIES_MEDIA_AFTER_SANITIZE; + +// +// Parameters for Sanitize. +// + +typedef enum { + + NVME_SANITIZE_ACTION_RESERVED = 0, + NVME_SANITIZE_ACTION_EXIT_FAILURE_MODE = 1, + NVME_SANITIZE_ACTION_START_BLOCK_ERASE_SANITIZE = 2, + NVME_SANITIZE_ACTION_START_OVERWRITE_SANITIZE = 3, + NVME_SANITIZE_ACTION_START_CRYPTO_ERASE_SANITIZE = 4 + +} NVME_SANITIZE_ACTION, *PNVME_SANITIZE_ACTION; + +typedef union { + + struct { + + // + // Sanitize Action (SANACT) + // The value of this field is defined in enum NVME_SANTIZE_ACTION. + // + ULONG SANACT : 3; // Sanitize Action (SANACT) + + // + // Allow Unrestricted Sanitize Exit (AUSE) + // This bit is ignored if Sanitize Action is in Exit Failure Mode (001b). + // + ULONG AUSE : 1; // Allow Unrestricted Sanitize Exit (AUSE) + + // + // Overwrite Pass Count (OWPASS) + // This field specifies the number of overwrite passes using the data from Overwrite Pattern. + // A value of 0h specified 16 overwrite passes. This is ignored unless Sanitize Action is Overwrite (011b). + // + ULONG OWPASS : 4; // Overwrite Pass Count (OWPASS) + + // + // Overwrite Invert Pattern Between Passes (OIPBP) + // This field indicates if Overwrite Pattern shall be inverted between passes. + // This is ignored unless Sanitize Action is Overwrite (011b). + // + ULONG OIPBP : 1; // Overwrite Invert Pattern Between Passes (OIPBP) + + // + // No Deallocate After Sanitize + // If set to 1 and No-Deallocate Inhibited bit is 0, + // controller shall not deallocate any logical blocks after sanitize completed successfully. + // If set to 1 and No-Deallocate Inhibited bit is 1, or if set to 0, + // controller shall deallocate logical blocks after sanitize completed successfully. + // This bit is ignored if Sanitize Action is Exit Failure Mode (001b). + // + ULONG NDAS : 1; // No Deallocate After Sanitize + + ULONG Reserved : 22; + + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW10_SANITIZE, *PNVME_CDW10_SANITIZE; + +typedef union { + + struct { + + // + // Overwrite Pattern + // This field is ignored unless the Sanitize Action field in Command Dword 10 is set to 011b (Overwrite). + // This field specifies a 32-bit pattern that is used for the Overwrite sanitize operation. + // + ULONG OVRPAT; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW11_SANITIZE; + +// +// Parameters for RESERVATION Commands +// +typedef enum { + + NVME_RESERVATION_TYPE_RESERVED = 0, + NVME_RESERVATION_TYPE_WRITE_EXCLUSIVE = 1, + NVME_RESERVATION_TYPE_EXCLUSIVE_ACCESS = 2, + NVME_RESERVATION_TYPE_WRITE_EXCLUSIVE_REGISTRANTS_ONLY = 3, + NVME_RESERVATION_TYPE_EXCLUSIVE_ACCESS_REGISTRANTS_ONLY = 4, + NVME_RESERVATION_TYPE_WRITE_EXCLUSIVE_ALL_REGISTRANTS = 5, + NVME_RESERVATION_TYPE_EXCLUSIVE_ACCESS_ALL_REGISTRANTS = 6, + +} NVME_RESERVATION_TYPES; + +// +// Parameters for RESERVATION ACQUIRE Commands +// +typedef enum { + + NVME_RESERVATION_ACQUIRE_ACTION_ACQUIRE = 0, + NVME_RESERVATION_ACQUIRE_ACTION_PREEMPT = 1, + NVME_RESERVATION_ACQUIRE_ACTION_PREEMPT_AND_ABORT = 2, + +} NVME_RESERVATION_ACQUIRE_ACTIONS; + +typedef struct { + + ULONG PTPL : 1; // Persist Through Power Loss (PTPL) + ULONG Reserved : 31; + +} NVME_CDW0_RESERVATION_PERSISTENCE, *PNVME_CDW0_RESERVATION_PERSISTENCE; + +typedef union { + + struct { + ULONG RACQA : 3; // Reservation Acquire Action (RACQA) + ULONG IEKEY : 1; // Ignore Existing Key (IEKEY) + ULONG Reserved : 4; + ULONG RTYPE : 8; // Reservation Type (RTYPE) + + ULONG Reserved1 : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW10_RESERVATION_ACQUIRE, *PNVME_CDW10_RESERVATION_ACQUIRE; + + +// +// Reservation Acquire Data Structure +// +typedef struct { + + ULONGLONG CRKEY; // Current Reservation Key (CRKEY) + + // + // If the Reseravation Acquire Action is set to 001b (Preempt) or 010b (Preempt and Abort), + // then this field specifies the reservation key to be unregistered from the namespace. + // For all other Reservation Acquire Action values, this field is reserved. + // + ULONGLONG PRKEY; // Preempt Reservation Key (PRKEY) + +} NVME_RESERVATION_ACQUIRE_DATA_STRUCTURE, *PNVME_RESERVATION_ACQUIRE_DATA_STRUCTURE; + +// +// Parameters for RESERVATION REGISTER Commands +// +typedef enum { + + NVME_RESERVATION_REGISTER_ACTION_REGISTER = 0, + NVME_RESERVATION_REGISTER_ACTION_UNREGISTER = 1, + NVME_RESERVATION_REGISTER_ACTION_REPLACE = 2, + +} NVME_RESERVATION_REGISTER_ACTIONS; + +typedef enum { + + NVME_RESERVATION_REGISTER_PTPL_STATE_NO_CHANGE = 0, + NVME_RESERVATION_REGISTER_PTPL_STATE_RESERVED = 1, + NVME_RESERVATION_REGISTER_PTPL_STATE_SET_TO_0 = 2, // Reservations are released and registrants are cleared on a power on. + NVME_RESERVATION_REGISTER_PTPL_STATE_SET_TO_1 = 3, // Reservations and registrants persist across a power loss. + +} NVME_RESERVATION_REGISTER_PTPL_STATE_CHANGES; + +typedef union { + + struct { + ULONG RREGA : 3; // Reservation Register Action (RREGA) + ULONG IEKEY : 1; // Ignore Existing Key (IEKEY) + ULONG Reserved : 26; + ULONG CPTPL : 2; // Change Persist Through Power Loss State (CPTPL) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; +} NVME_CDW10_RESERVATION_REGISTER, *PNVME_CDW10_RESERVATION_REGISTER; + +// +// Reservation Register Data Structure +// +typedef struct { + + ULONGLONG CRKEY; // Current Reservation Key (CRKEY) + + // + // If the Reseravation Acquire Action is set to 001b (Preempt) or 010b (Preempt and Abort), + // then this field specifies the reservation key to be unregistered from the namespace. + // For all other Reservation Acquire Action values, this field is reserved. + // + ULONGLONG NRKEY; // New Reservation Key (NRKEY) + +} NVME_RESERVATION_REGISTER_DATA_STRUCTURE, *PNVME_RESERVATION_REGISTER_DATA_STRUCTURE; + +// +// Parameters for RESERVATION RELEASE Commands +// +typedef enum { + + NVME_RESERVATION_RELEASE_ACTION_RELEASE = 0, + NVME_RESERVATION_RELEASE_ACTION_CLEAR = 1, + +} NVME_RESERVATION_RELEASE_ACTIONS; + +typedef union { + + struct { + ULONG RRELA : 3; // Reservation Release Action (RRELA) + ULONG IEKEY : 1; // IgnoreExistingKey (IEKEY) + ULONG Reserved : 4; + ULONG RTYPE : 8; // Reservation Type (RTYPE) + + ULONG Reserved1 : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_RESERVATION_RELEASE, *PNVME_CDW10_RESERVATION_RELEASE; + +// +// Reservation Release Data Structure +// +typedef struct { + + ULONGLONG CRKEY; // Current Reservation Key (CRKEY) + +} NVME_RESERVATION_RELEASE_DATA_STRUCTURE, *PNVME_RESERVATION_RELEASE_DATA_STRUCTURE; + +// +// Parameters for RESERVATION REPORT Commands +// + +typedef union { + + struct { + ULONG NUMD; // Number of Dwords (NUMD), NOTE: 0's based value. + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_RESERVATION_REPORT, *PNVME_CDW10_RESERVATION_REPORT; + +typedef union { + + struct { + ULONG EDS : 1; // Extended Data Structure (EDS) + + ULONG Reserved : 31; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_RESERVATION_REPORT, *PNVME_CDW11_RESERVATION_REPORT; + +#pragma pack(push, 1) +typedef struct { + + // + // This field is a counter that increments any time the below occurs: + // a. a Reservation Register command completes successfully on any controller associated with the namespace; + // b. a Reservation Release command with Reservation Release Action set to 001b (Clear) completes successfully + // on any controller associated with the name space; + // c. a Reservation Acquire command with Reservation Acquire Action set to 001b (Preempt) or 010b (Preempt and Abort) + // completes successfully on any controller associated with the namespace. + // If the value of this field is FFFFFFFFh, then the field shall be cleared to 0b when incremented. + // + ULONG GEN; // Generation (Gen) + + UCHAR RTYPE; // Reservation Type (RTYPE) + + USHORT REGCTL; // Number of Registered Controllers (REGCTL) + + UCHAR Reserved[2]; + + UCHAR PTPLS; // Persist Through Power Loss State (PTPLS) + + UCHAR Reserved1[14]; + +} NVME_RESERVATION_REPORT_STATUS_HEADER, *PNVME_RESERVATION_REPORT_STATUS_HEADER; +#pragma pack(pop) + +C_ASSERT(sizeof(NVME_RESERVATION_REPORT_STATUS_HEADER) == 24); + +typedef struct { + + USHORT CNTLID; // Controller ID (CNTLID) + + struct { + UCHAR HoldReservation : 1; + + UCHAR Reserved : 7; + } RCSTS; // Reservation Status (RCSTS) + + UCHAR Reserved[5]; + + UCHAR HOSTID[8]; // Host Identifier (HOSTID) + ULONGLONG RKEY; // Reservation Key (RKEY) + +} NVME_REGISTERED_CONTROLLER_DATA, *PNVME_REGISTERED_CONTROLLER_DATA; + +C_ASSERT(sizeof(NVME_REGISTERED_CONTROLLER_DATA) == 24); + +typedef struct { + + NVME_RESERVATION_REPORT_STATUS_HEADER Header; + + NVME_REGISTERED_CONTROLLER_DATA RegisteredControllersData[ANYSIZE_ARRAY]; + +} NVME_RESERVATION_REPORT_STATUS_DATA_STRUCTURE, *PNVME_RESERVATION_REPORT_STATUS_DATA_STRUCTURE; + +typedef struct { + + USHORT CNTLID; // Controller ID (CNTLID) + + struct { + UCHAR HoldReservation : 1; + + UCHAR Reserved : 7; + } RCSTS; // Reservation Status (RCSTS) + + UCHAR Reserved[5]; + + ULONGLONG RKEY; // Reservation Key (RKEY) + UCHAR HOSTID[16]; // 128-bit Host Identifier (HOSTID) + + UCHAR Reserved1[32]; + +} NVME_REGISTERED_CONTROLLER_EXTENDED_DATA, *PNVME_REGISTERED_CONTROLLER_EXTENDED_DATA; + +C_ASSERT(sizeof(NVME_REGISTERED_CONTROLLER_EXTENDED_DATA) == 64); + +typedef struct { + + NVME_RESERVATION_REPORT_STATUS_HEADER Header; + + UCHAR Reserved1[40]; + + NVME_REGISTERED_CONTROLLER_EXTENDED_DATA RegisteredControllersExtendedData[ANYSIZE_ARRAY]; + +} NVME_RESERVATION_REPORT_STATUS_EXTENDED_DATA_STRUCTURE, *PNVME_RESERVATION_REPORT_STATUS_EXTENDED_DATA_STRUCTURE; + +// +// Parameters for Directives. +// + +typedef enum { + + NVME_DIRECTIVE_TYPE_IDENTIFY = 0x00, + NVME_DIRECTIVE_TYPE_STREAMS = 0x01 + +} NVME_DIRECTIVE_TYPES; + +#define NVME_STREAMS_ID_MIN 1 +#define NVME_STREAMS_ID_MAX 0xFFFF + +// +// General parameters for Directive Receive. +// + +typedef struct { + + ULONG NUMD; // Number of Dwords (NUMD) + +} NVME_CDW10_DIRECTIVE_RECEIVE, *PNVME_CDW10_DIRECTIVE_RECEIVE; + +typedef union { + + struct { + ULONG DOPER : 8; // Directive Operation + ULONG DTYPE : 8; // Directive Type + ULONG DSPEC : 16; // Directive Specific + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_DIRECTIVE_RECEIVE, *PNVME_CDW11_DIRECTIVE_RECEIVE; + + +// +// General parameters for Directive Send. +// + +typedef struct { + + ULONG NUMD; // Number of Dwords (NUMD) + +} NVME_CDW10_DIRECTIVE_SEND, *PNVME_CDW10_DIRECTIVE_SEND; + +typedef union { + + struct { + ULONG DOPER : 8; // Directive Operation + ULONG DTYPE : 8; // Directive Type + ULONG DSPEC : 16; // Directive Specific + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_DIRECTIVE_SEND, *PNVME_CDW11_DIRECTIVE_SEND; + + +// +// Parameters for the Identify Directive Type. +// + +typedef enum { + + NVME_DIRECTIVE_RECEIVE_IDENTIFY_OPERATION_RETURN_PARAMETERS = 1 + +} NVME_DIRECTIVE_RECEIVE_IDENTIFY_OPERATIONS; + +typedef enum { + + NVME_DIRECTIVE_SEND_IDENTIFY_OPERATION_ENABLE_DIRECTIVE = 1 + +} NVME_DIRECTIVE_SEND_IDENTIFY_OPERATIONS; + +typedef struct { + + UCHAR Identify : 1; + UCHAR Streams : 1; + UCHAR Reserved0 : 6; + + UCHAR Reserved1[31]; + +} NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR, *PNVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR; + +typedef struct { + + NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR DirectivesSupported; + NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS_DESCRIPTOR DirectivesEnabled; + + // + // This data structure is 4KB in size. The reserved space is commented out + // so that this data structure can be safely allocated on the stack. + // + //UCHAR Reserved[4032]; // 4096 - 32 - 32 = 4032 + +} NVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS, *PNVME_DIRECTIVE_IDENTIFY_RETURN_PARAMETERS; + +typedef union { + + struct { + ULONG ENDIR : 1; // Enable Directive + ULONG Reserved0 : 7; + ULONG DTYPE : 8; // Directive Type + ULONG Reserved1 : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW12_DIRECTIVE_SEND_IDENTIFY_ENABLE_DIRECTIVE, *PNVME_CDW12_DIRECTIVE_SEND_IDENTIFY_ENABLE_DIRECTIVE; + +// +// Parameters for the Streams Directive Type +// +typedef enum { + + NVME_DIRECTIVE_RECEIVE_STREAMS_OPERATION_RETURN_PARAMETERS = 1, + NVME_DIRECTIVE_RECEIVE_STREAMS_OPERATION_GET_STATUS = 2, + NVME_DIRECTIVE_RECEIVE_STREAMS_OPERATION_ALLOCATE_RESOURCES = 3 + +} NVME_DIRECTIVE_RECEIVE_STREAMS_OPERATIONS; + +typedef enum { + + NVME_DIRECTIVE_SEND_STREAMS_OPERATION_RELEASE_IDENTIFIER = 1, + NVME_DIRECTIVE_SEND_STREAMS_OPERATION_RELEASE_RESOURCES = 2 + +} NVME_DIRECTIVE_SEND_STREAMS_OPERATIONS; + +typedef struct { + + USHORT MSL; // Max Streams Limit + USHORT NSSA; // NVM Subsystem Streams Available + USHORT NSSO; // NVM Subsystem Streams Open + UCHAR Reserved0[10]; + + ULONG SWS; // Stream Write Size + USHORT SGS; // Stream Granularity Size + USHORT NSA; // Namespace Streams Allocated + USHORT NSO; // Namespace Streams Open + UCHAR Reserved1[6]; + +} NVME_DIRECTIVE_STREAMS_RETURN_PARAMETERS, *PNVME_DIRECTIVE_STREAMS_RETURN_PARAMETERS; + +#define NVME_STREAMS_GET_STATUS_MAX_IDS 65535 + +typedef struct { + + USHORT OpenStreamCount; // Number of currently open streams. + USHORT StreamIdentifiers[NVME_STREAMS_GET_STATUS_MAX_IDS]; // Array of stream IDs that are currently open. + +} NVME_DIRECTIVE_STREAMS_GET_STATUS_DATA, *PNVME_DIRECTIVE_STREAMS_GET_STATUS_DATA; + +typedef union { + + struct { + ULONG NSR : 16; // Namespace Streams Requested + ULONG Reserved : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW12_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES, *PNVME_CDW12_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES; + +typedef struct { + + struct { + ULONG NSA : 16; // Namespace Streams Allocated + ULONG Reserved : 16; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_COMPLETION_DW0_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES, *PNVME_COMPLETION_DW0_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES; + +typedef union { + NVME_CDW12_DIRECTIVE_SEND_IDENTIFY_ENABLE_DIRECTIVE EnableDirective; + + ULONG AsUlong; +} NVME_CDW12_DIRECTIVE_SEND; + +typedef union { + NVME_CDW12_DIRECTIVE_RECEIVE_STREAMS_ALLOCATE_RESOURCES AllocateResources; + + ULONG AsUlong; +} NVME_CDW12_DIRECTIVE_RECEIVE; + +// +// Parameters for SECURITY SEND / RECEIVE Commands +// +typedef union { + + struct { + ULONG Reserved0 : 8; + ULONG SPSP : 16; // SP Specific (SPSP) + ULONG SECP : 8; // Security Protocol (SECP) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_SECURITY_SEND_RECEIVE, *PNVME_CDW10_SECURITY_SEND_RECEIVE; + +typedef struct { + + ULONG TL; // Transfer Length (TL): + +} NVME_CDW11_SECURITY_SEND, *PNVME_CDW11_SECURITY_SEND; + +typedef struct { + + ULONG AL; // Transfer Length (AL) + +} NVME_CDW11_SECURITY_RECEIVE, *PNVME_CDW11_SECURITY_RECEIVE; + +// +// NVM Command Set +// +typedef enum { + + NVME_NVM_COMMAND_FLUSH = 0x00, + NVME_NVM_COMMAND_WRITE = 0x01, + NVME_NVM_COMMAND_READ = 0x02, + + NVME_NVM_COMMAND_WRITE_UNCORRECTABLE = 0x04, + NVME_NVM_COMMAND_COMPARE = 0x05, + NVME_NVM_COMMAND_WRITE_ZEROES = 0x08, + NVME_NVM_COMMAND_DATASET_MANAGEMENT = 0x09, + NVME_NVM_COMMAND_VERIFY = 0x0C, + NVME_NVM_COMMAND_RESERVATION_REGISTER = 0x0D, + NVME_NVM_COMMAND_RESERVATION_REPORT = 0x0E, + NVME_NVM_COMMAND_RESERVATION_ACQUIRE = 0x11, + NVME_NVM_COMMAND_RESERVATION_RELEASE = 0x15, + NVME_NVM_COMMAND_COPY = 0x19, + + NVME_NVM_COMMAND_ZONE_MANAGEMENT_SEND = 0x79, + NVME_NVM_COMMAND_ZONE_MANAGEMENT_RECEIVE = 0x7A, + NVME_NVM_COMMAND_ZONE_APPEND = 0x7D, + +} NVME_NVM_COMMANDS; + +// +// Data structure of CDW12 for Read/Write command +// +typedef union { + + struct { + ULONG NLB : 16; // Number of Logical Blocks (NLB) + ULONG Reserved0 : 4; + ULONG DTYPE : 4; // Directive Type (DTYPE) + ULONG Reserved1 : 2; + ULONG PRINFO : 4; // Protection Information Field (PRINFO) + ULONG FUA : 1; // Force Unit Access (FUA) + ULONG LR : 1; // Limited Retry (LR) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW12_READ_WRITE, *PNVME_CDW12_READ_WRITE; + +// +// Data structure of CDW13 for Read/Write command +// +typedef enum { + + NVME_ACCESS_FREQUENCY_NONE = 0, // No frequency information provided. + NVME_ACCESS_FREQUENCY_TYPICAL = 1, // Typical number of reads and writes expected for this LBA range. + NVME_ACCESS_FREQUENCY_INFR_WRITE_INFR_READ = 2, // Infrequent writes and infrequent reads to the LBA range indicated. + NVME_ACCESS_FREQUENCY_INFR_WRITE_FR_READ = 3, // Infrequent writes and frequent reads to the LBA range indicated. + NVME_ACCESS_FREQUENCY_FR_WRITE_INFR_READ = 4, // Frequent writes and infrequent reads to the LBA range indicated. + NVME_ACCESS_FREQUENCY_FR_WRITE_FR_READ = 5, // Frequent writes and frequent reads to the LBA range indicated. + NVME_ACCESS_FREQUENCY_ONE_TIME_READ = 6, // One time read. E.g. command is due to virus scan, backup, file copy, or archive. + NVME_ACCESS_FREQUENCY_SPECULATIVE_READ = 7, // Speculative read. The command is part of a prefetch operation. + NVME_ACCESS_FREQUENCY_WILL_BE_OVERWRITTEN = 8, // The LBA range is going to be overwritten in the near future. + +} NVME_ACCESS_FREQUENCIES; + + +typedef enum { + + NVME_ACCESS_LATENCY_NONE = 0, // None. No latency information provided. + NVME_ACCESS_LATENCY_IDLE = 1, // Idle. Longer latency acceptable + NVME_ACCESS_LATENCY_NORMAL = 2, // Normal. Typical latency. + NVME_ACCESS_LATENCY_LOW = 3, // Low. Smallest possible latency + +} NVME_ACCESS_LATENCIES; + +typedef union { + + struct { + struct { + UCHAR AccessFrequency : 4; + UCHAR AccessLatency : 2; + UCHAR SequentialRequest : 1; + UCHAR Incompressible : 1; + } DSM; // Dataset Management (DSM) + + UCHAR Reserved; + USHORT DSPEC; // Directive Specific Value + + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW13_READ_WRITE, *PNVME_CDW13_READ_WRITE; + +// +// Data structure of CDW15 for Read/Write command +// +typedef union { + + struct { + ULONG ELBAT : 16; // Expected Logical Block Application Tag (ELBAT) + ULONG ELBATM : 16; // Expected Logical Block Application Tag Mask (ELBATM) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW15_READ_WRITE, *PNVME_CDW15_READ_WRITE; + + +// +// Dataset Management - Range Definition +// +typedef union { + + struct { + ULONG AccessFrequency : 4; + ULONG AccessLatency : 2; + ULONG Reserved0 : 2; + ULONG SequentialReadRange : 1; + ULONG SequentialWriteRange : 1; + ULONG WritePrepare : 1; + ULONG Reserved1 : 13; + ULONG CommandAccessSize : 8; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CONTEXT_ATTRIBUTES, *PNVME_CONTEXT_ATTRIBUTES; + +typedef struct { + + NVME_CONTEXT_ATTRIBUTES Attributes; // The use of this information is optional and the controller is not required to perform any specific action. + ULONG LogicalBlockCount; + ULONGLONG StartingLBA; + +} NVME_LBA_RANGE, *PNVME_LBA_RANGE; + +typedef union { + + struct { + ULONG NR : 8; // Number of Ranges (NR) + ULONG Reserved : 24; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_DATASET_MANAGEMENT, *PNVME_CDW10_DATASET_MANAGEMENT; + +typedef union { + + struct { + ULONG IDR : 1; // Integral Dataset for Read (IDR) + ULONG IDW : 1; // Integral Dataset for Write (IDW) + ULONG AD : 1; // Deallocate (AD) + ULONG Reserved : 29; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW11_DATASET_MANAGEMENT, *PNVME_CDW11_DATASET_MANAGEMENT; + +// +// Data structure of CDW12 for Verify command +// +typedef union { + + struct { + ULONG NLB : 16; // Number of Logical Blocks (NLB). Zero based. + ULONG Reserved : 10; + ULONG PRINFO : 4; // Protection Information Field (PRINFO) + ULONG FUA : 1; // Force Unit Access (FUA) + ULONG LR : 1; // Limited Retry (LR) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW12_VERIFYCOMMAND, *PNVME_CDW12_VERIFYCOMMAND; + +// +// Data structure of CDW15 for Verify command +// +typedef union { + + struct { + ULONG ELBAT : 16; // Expected Logical Block Application Tag (ELBAT) + ULONG ELBATM : 16; // Expected Logical Block Application Tag Mask (ELBATM) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW15_VERIFY_COMMAND, *PNVME_CDW15_VERIFY_COMMAND; + +// +// Zone Descriptor +// +typedef struct { + + struct { + UCHAR ZT : 4; // Zone Type + UCHAR Reserved1 : 4; + } DUMMYSTRUCTNAME; + + struct { + UCHAR Reserved2 : 4; + UCHAR ZS : 4; // Zone State + } DUMMYSTRUCTNAME; + + struct { + UCHAR ZFC : 1; // Zone Finished by Controller (ZFC) + UCHAR FZR : 1; // Finish Zone Recommended (FZR) + UCHAR RZR : 1; // Reset Zone Recommended (RZR) + UCHAR Reserved : 4; + UCHAR ZDEV : 1; // Zone Descriptor Extension Valid (ZDEV) + } ZA; // Zone Attribute + + UCHAR Reserved3[5]; + + ULONGLONG ZCAP; // Zone Capacity + + ULONGLONG ZSLBA; // Zone Start Logical Block Address + + ULONGLONG WritePointer; // Current Write pointer of the Zone + + UCHAR Reserved4[32]; + +} NVME_ZONE_DESCRIPTOR, *PNVME_ZONE_DESCRIPTOR; + + +// +// Zone States +// +typedef enum { + NVME_STATE_ZSE = 0x1, // Zone State Empty + NVME_STATE_ZSIO = 0x2, // Zone State Implicitly Opened + NVME_STATE_ZSEO = 0x3, // Zone State Explicitly Opened + NVME_STATE_ZSC = 0x4, // Zone State Closed + + NVME_STATE_ZSRO = 0xD, // Zone State Read-Only + NVME_STATE_ZSF = 0xE, // Zone State Full + NVME_STATE_ZSO = 0xF, // Zone State Offline + +} ZONE_STATE; + +// +// Data structure of CDW13 for Zone Management Send command +// +typedef enum { + NVME_ZONE_SEND_CLOSE = 1, // Close one or more zones + NVME_ZONE_SEND_FINISH = 2, // Finish one or more zones + NVME_ZONE_SEND_OPEN = 3, // Open one or more zones + NVME_ZONE_SEND_RESET = 4, // Reset one or more zones + NVME_ZONE_SEND_OFFLINE = 5, // Offline one or more zones + + NVME_ZONE_SEND_SET_ZONE_DESCRIPTOR = 0x10, // Attach Zone Descriptor Extension data to a zone in the Empty state and + // transition the zone to the Closed state +} NVME_ZONE_SEND_ACTION; + +typedef struct { + + ULONGLONG SLBA; // Starting LBA (SLBA) + +} NVME_CDW10_ZONE_MANAGEMENT_SEND, *PNVME_CDW10_ZONE_MANAGEMENT_SEND; + +typedef union { + + struct { + ULONG ZSA : 8; // Zone Send Action, as defined in NVME_ZONE_SEND_ACTION + ULONG SelectAll : 1; // Select all the zones. SLBA is ignored if set + ULONG Reserved : 23; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW13_ZONE_MANAGEMENT_SEND, *PNVME_CDW13_ZONE_MANAGEMENT_SEND; + +// +// Report Zone Data Structure +// +typedef struct { + + ULONGLONG ZoneCount; //Number of Zones + ULONGLONG Reserved[7]; + + NVME_ZONE_DESCRIPTOR ZoneDescriptor[ANYSIZE_ARRAY]; +} NVME_REPORT_ZONE_INFO, *PNVME_REPORT_ZONE_INFO; + +// +// Extended Report Zone Data Structure and related defines +// +typedef struct{ + + UCHAR ZoneDescriptorExtensionInfo[64]; + +} NVME_ZONE_DESCRIPTOR_EXTENSION, *PNVME_ZONE_DESCRIPTOR_EXTENSION; + +#define ZDES_SIZE_MULTIPLIER_IN_BYTES 64 + +typedef struct { + + NVME_ZONE_DESCRIPTOR ZoneDescriptor; + NVME_ZONE_DESCRIPTOR_EXTENSION ZoneDescriptorExtension[ANYSIZE_ARRAY]; + +} NVME_ZONE_EXTENDED_REPORT_ZONE_DESC, *PNVME_ZONE_EXTENDED_REPORT_ZONE_DESC; + +typedef struct { + + ULONGLONG ZoneCount; //Number of Zones + ULONGLONG Reserved[7]; + + NVME_ZONE_EXTENDED_REPORT_ZONE_DESC Desc[ANYSIZE_ARRAY]; +} NVME_EXTENDED_REPORT_ZONE_INFO, *PNVME_EXTENDED_REPORT_ZONE_INFO; + +// +// Data structure of CDW13 for Zone Management Receive command and related defines +// +typedef enum { + NVME_ZONE_RECEIVE_REPORT_ZONES = 0, // Returns report zone Descriptors + NVME_ZONE_RECEIVE_EXTENDED_REPORT_ZONES = 1, // Returns report zone descriptors with extended report zone information + +} NVME_ZONE_RECEIVE_ACTION; + +typedef enum { + NVME_ZRA_ALL_ZONES = 0, // List all zones + NVME_ZRA_EMPTY_STATE_ZONES = 1, // List zones with state Zone State Empty + NVME_ZRA_IO_STATE_ZONES = 2, // List zones with state Zone State Implicitly Opened + NVME_ZRA_EO_STATE_ZONES = 3, // List zones with state Zone State Explicitly Opened + NVME_ZRA_CLOSED_STATE_ZONES = 4, // List zones with state Zone State Closed + NVME_ZRA_FULL_STATE_ZONES = 5, // List zones with state Zone State Full + NVME_ZRA_RO_STATE_ZONES = 6, // List zones with state Zone State Read-Only + NVME_ZRA_OFFLINE_STATE_ZONES = 7, // List zones with state Zone State Offline + +} NVME_ZONE_RECEIVE_ACTION_SPECIFIC; + +typedef struct { + + ULONGLONG SLBA; // Starting LBA (SLBA) + +} NVME_CDW10_ZONE_MANAGEMENT_RECEIVE, *PNVME_CDW10_ZONE_MANAGEMENT_RECEIVE; + +typedef union { + + struct { + ULONG ZRA : 8; // Zone Receive Action, as defined in NVME_ZONE_RECEIVE_ACTION + ULONG ZRASpecific : 8; // Zone Receive Action Specific field, as defined in NVME_ZONE_RECEIVE_ACTION_SPECIFIC + ULONG Partial : 1; // Report Zones and Extended Report Zones: Partial Report + ULONG Reserved : 15; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW13_ZONE_MANAGEMENT_RECEIVE, *PNVME_CDW13_ZONE_MANAGEMENT_RECEIVE; + +typedef struct { + + ULONGLONG SLBA; // Starting LBA (SLBA) + +} NVME_CDW10_ZONE_APPEND, *PNVME_CDW10_ZONE_APPEND; + +typedef union { + + struct { + ULONG NLB : 16; // Number of Logical Blocks (NLB) + ULONG Reserved : 9; + ULONG PIREMAP : 1; // Protection Information Remap (PIREMAP) + ULONG PRINFO : 4; // Protection Information Field (PRINFO) + ULONG FUA : 1; // Force Unit Access (FUA) + ULONG LR : 1; // Limited Retry(LR); + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW12_ZONE_APPEND, *PNVME_CDW12_ZONE_APPEND; + +typedef union { + + struct { + ULONG LBAT : 16; // Logical Block Application Tag + ULONG LBATM : 16; // Logical Block Application Tag Mask (LBATM) + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW15_ZONE_APPEND, *PNVME_CDW15_ZONE_APPEND; + +typedef union { + + struct { + ULONG STC : 4; // Self-test Code (STC) + ULONG Reserved : 28; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_DEVICE_SELF_TEST, *PNVME_CDW10_DEVICE_SELF_TEST; + +// +// Parameters for NVME_ADMIN_COMMAND_DISCOVERY_INFO_MGMT +// +typedef enum { + + NVME_DISCOVERY_INFO_MGMT_TASK_REGISTER = 0, + NVME_DISCOVERY_INFO_MGMT_TASK_DEREGISTER = 1, + NVME_DISCOVERY_INFO_MGMT_TASK_UPDATE = 2 + +} NVME_DISCOVERY_INFO_MGMT_TASK; + +typedef union { + + struct { + ULONG TAS : 4; // Task (TAS) - NVME_DISCOVERY_INFO_MGMT_TASK + ULONG Reserved : 28; + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_CDW10_DISCOVERY_INFO_MGMT, *PNVME_CDW10_DISCOVERY_INFO_MGMT; + +// +// Command Dword 0 +// + +#define NVME_PSDT_XFER_PRP 0 // PRPs are used for this transfer. +#define NVME_PSDT_XFER_SGL_BYTE 1 // SGLs are used for this transfer. If used, Metadata Pointer (MPTR) contains an address + // of a single contiguous physical buffer that is byte aligned. Required for all + // Admin and I/O commands for NVMe over Fabrics implementations. +#define NVME_PSDT_XFER_SGL_QWORD 2 // SGLs are used for this transfer. If used, Metadata Pointer (MPTR) contains an address + // of an SGL segment containing exactly one SGL Descriptor that is qword aligned. +#define NVME_PSDT_XFER_RESERVED 3 + +typedef union { + + struct { + //LSB + ULONG OPC : 8; // Opcode (OPC) + ULONG FUSE : 2; // Fused Operation (FUSE) + ULONG Reserved0 : 4; + ULONG PSDT : 2; // PRP or SGL for Data Transfer (PSDT) + ULONG CID : 16; // Command Identifier (CID) + //MSB + } DUMMYSTRUCTNAME; + + ULONG AsUlong; + +} NVME_COMMAND_DWORD0, *PNVME_COMMAND_DWORD0; + +// +// Fused Operation code +// +typedef enum { + + NVME_FUSED_OPERATION_NORMAL = 0, + NVME_FUSED_OPERATION_FIRST_CMD = 1, + NVME_FUSED_OPERATION_SECOND_CMD = 2, + +} NVME_FUSED_OPERATION_CODES; + + +typedef union { + + struct { + //LSB + ULONGLONG Reserved0 : 2; + ULONGLONG PBAO : 62; // Page Base Address and Offset (PBAO) + //MSB + } DUMMYSTRUCTNAME; + + ULONGLONG AsUlonglong; + +} NVME_PRP_ENTRY, *PNVME_PRP_ENTRY; + +// +// If the namespace is not used for the command, then 'NSID' field shall be cleared to 0h. +// If a command shall be applied to all namespaces on the device, then 'NSID' field shall be set to FFFFFFFFh. +// +#define NVME_NAMESPACE_ALL 0xFFFFFFFF + +// +// NVMe command data structure +// +typedef struct { + // + // Common fields for all commands + // + NVME_COMMAND_DWORD0 CDW0; + ULONG NSID; + ULONG Reserved0[2]; + ULONGLONG MPTR; + + union { + + struct { + ULONGLONG PRP1; + ULONGLONG PRP2; + }; + + ULONGLONG SGL1[2]; + }; + + // + // Command independent fields from CDW10 to CDW15 + // + union { + + // + // General Command data fields + // + struct { + ULONG CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } GENERAL; + + // + // Admin Command: Identify + // + struct { + NVME_CDW10_IDENTIFY CDW10; + NVME_CDW11_IDENTIFY CDW11; + ULONG CDW12; + ULONG CDW13; + union { + ULONG CDW14; + NVME_CDW14_IDENTIFY CDW14_V20; + }; + ULONG CDW15; + } IDENTIFY; + + // + // Admin Command: Abort + // + struct { + NVME_CDW10_ABORT CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } ABORT; + + // + // Admin Command: Get/Set Features + // + struct { + NVME_CDW10_GET_FEATURES CDW10; + NVME_CDW11_FEATURES CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } GETFEATURES; + + struct { + NVME_CDW10_SET_FEATURES CDW10; + NVME_CDW11_FEATURES CDW11; + NVME_CDW12_FEATURES CDW12; + NVME_CDW13_FEATURES CDW13; + NVME_CDW14_FEATURES CDW14; + NVME_CDW15_FEATURES CDW15; + } SETFEATURES; + + // + // Admin Command: Get Log Page + // + struct { + union { + NVME_CDW10_GET_LOG_PAGE CDW10; + NVME_CDW10_GET_LOG_PAGE_V121 CDW10_V121; + NVME_CDW10_GET_LOG_PAGE_V13 CDW10_V13; + NVME_CDW10_GET_LOG_PAGE_V20 CDW10_V20; + }; + + NVME_CDW11_GET_LOG_PAGE CDW11; + NVME_CDW12_GET_LOG_PAGE CDW12; + NVME_CDW13_GET_LOG_PAGE CDW13; + union { + NVME_CDW14_GET_LOG_PAGE CDW14; + NVME_CDW14_GET_LOG_PAGE_V20 CDW14_V20; + }; + ULONG CDW15; + } GETLOGPAGE; + + // + // Admin Command: Create IO Completion Queue + // + struct { + NVME_CDW10_CREATE_IO_QUEUE CDW10; + NVME_CDW11_CREATE_IO_CQ CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } CREATEIOCQ; + + // + // Admin Command: Create IO Submission Queue + // + struct { + NVME_CDW10_CREATE_IO_QUEUE CDW10; + NVME_CDW11_CREATE_IO_SQ CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } CREATEIOSQ; + + // + // Admin Command: Delete IO Queue (Submission or Completion) + // + struct { + NVME_CDW10_DELETE_IO_QUEUE CDW10; + } DELETEIOQUEUE; + + // + // NVM Command: Dataset Management + // + struct { + NVME_CDW10_DATASET_MANAGEMENT CDW10; + NVME_CDW11_DATASET_MANAGEMENT CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } DATASETMANAGEMENT; + + // + // Admin Command: SECURITY SEND + // + struct { + NVME_CDW10_SECURITY_SEND_RECEIVE CDW10; + NVME_CDW11_SECURITY_SEND CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } SECURITYSEND; + + // + // Admin Command: SECURITY RECEIVE + // + struct { + NVME_CDW10_SECURITY_SEND_RECEIVE CDW10; + NVME_CDW11_SECURITY_RECEIVE CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } SECURITYRECEIVE; + + // + // Admin Command: FIRMWARE IMAGE DOWNLOAD + // + struct { + NVME_CDW10_FIRMWARE_DOWNLOAD CDW10; + NVME_CDW11_FIRMWARE_DOWNLOAD CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } FIRMWAREDOWNLOAD; + + // + // Admin Command: FIRMWARE ACTIVATE + // + struct { + NVME_CDW10_FIRMWARE_ACTIVATE CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } FIRMWAREACTIVATE; + + // + // Admin Command: FORMAT NVM + // + struct { + NVME_CDW10_FORMAT_NVM CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } FORMATNVM; + + // + // Admin Command: DIRECTIVE RECEIVE + // + struct { + NVME_CDW10_DIRECTIVE_RECEIVE CDW10; + NVME_CDW11_DIRECTIVE_RECEIVE CDW11; + NVME_CDW12_DIRECTIVE_RECEIVE CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } DIRECTIVERECEIVE; + + // + // Admin Command: DIRECTIVE SEND + // + struct { + NVME_CDW10_DIRECTIVE_SEND CDW10; + NVME_CDW11_DIRECTIVE_SEND CDW11; + NVME_CDW12_DIRECTIVE_SEND CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } DIRECTIVESEND; + + // + // Admin Command: SANITIZE + // + struct { + NVME_CDW10_SANITIZE CDW10; + NVME_CDW11_SANITIZE CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } SANITIZE; + + // + // NVM Command: Read/Write + // + struct { + ULONG LBALOW; + ULONG LBAHIGH; + NVME_CDW12_READ_WRITE CDW12; + NVME_CDW13_READ_WRITE CDW13; + ULONG CDW14; + NVME_CDW15_READ_WRITE CDW15; + } READWRITE; + + // + // NVM Command: RESERVATION ACQUIRE + // + struct { + NVME_CDW10_RESERVATION_ACQUIRE CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } RESERVATIONACQUIRE; + + // + // NVM Command: RESERVATION REGISTER + // + struct { + NVME_CDW10_RESERVATION_REGISTER CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } RESERVATIONREGISTER; + + // + // NVM Command: RESERVATION RELEASE + // + struct { + NVME_CDW10_RESERVATION_RELEASE CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } RESERVATIONRELEASE; + + // + // NVM Command: RESERVATION REPORT + // + struct { + NVME_CDW10_RESERVATION_REPORT CDW10; + NVME_CDW11_RESERVATION_REPORT CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } RESERVATIONREPORT; + + // + // NVM Command: Zone Management Send + // + struct { + NVME_CDW10_ZONE_MANAGEMENT_SEND CDW1011; + ULONG CDW12; + NVME_CDW13_ZONE_MANAGEMENT_SEND CDW13; + ULONG CDW14; + ULONG CDW15; + } ZONEMANAGEMENTSEND; + + // + // NVM Command: Zone Management Receive + // + struct { + NVME_CDW10_ZONE_MANAGEMENT_RECEIVE CDW1011; + ULONG DWORDCOUNT; + NVME_CDW13_ZONE_MANAGEMENT_RECEIVE CDW13; + ULONG CDW14; + ULONG CDW15; + } ZONEMANAGEMENTRECEIVE; + + // + // NVM Command: Zone Append + // + struct { + NVME_CDW10_ZONE_APPEND CDW1011; + NVME_CDW12_ZONE_APPEND CDW12; + ULONG CDW13; + ULONG ILBRT; + NVME_CDW15_ZONE_APPEND CDW15; + } ZONEAPPEND; + + // + // NVM Command: Device Self Test + // + struct { + NVME_CDW10_DEVICE_SELF_TEST CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } DEVICESELFTEST; + + // + // + // + struct { + NVME_CDW10_DISCOVERY_INFO_MGMT CDW10; + ULONG CDW11; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } DISCOVERYINFOMGMT; + + // + // Admin or NVM Command: Vendor Specific Common Format + // + struct { + ULONG NDT; + ULONG NDM; + ULONG CDW12; + ULONG CDW13; + ULONG CDW14; + ULONG CDW15; + } VENDORSPECIFIC; + + // + // NVM Command: Verify command + // + struct { + ULONG LBALOW; + ULONG LBAHIGH; + NVME_CDW12_VERIFYCOMMAND CDW12; + ULONG CDW13; + ULONG EILBRT; + NVME_CDW15_VERIFY_COMMAND CDW15; + } VERIFYCOMMAND; + + } u; + +} NVME_COMMAND, *PNVME_COMMAND; + +C_ASSERT(sizeof(NVME_COMMAND) == 64); // NVMe commands are always 64 bytes + // (defined by constant STORAGE_PROTOCOL_COMMAND_LENGTH_NVME) + +// +// The SCSI name string identifier used for the page 83 descriptor in NVMe to SCSI translation +// For NVMe devices compliant with revision 1.0. +// +typedef struct { + + CHAR PCIVendorID[4]; + CHAR ModelNumber[40]; + CHAR NamespaceID[4]; + CHAR SerialNumber[20]; + +} NVME_SCSI_NAME_STRING, *PNVME_SCSI_NAME_STRING; + +//////////////////////////////////////////////////////////////////////// +// +// NVMe SGL definitions based on 2.0 spec +// + +// +// SGL Descriptor Type defined in +// the Scatter Gather List section +// +typedef enum _NVME_SGL_DESC_TYPE { + + NvmeSglDescTypeDataBlock = 0x0, + NvmeSglDescTypeBitBucket = 0x1, + NvmeSglDescTypeSegment = 0x2, + NvmeSglDescTypeLastSegment = 0x3, + NvmeSglDescTypeKeyedDataBlock = 0x4, + NvmeSglDescTypeTransportDataBlock = 0x5, + NvmeSglDescTypeMax = 0xF + +} NVME_SGL_DESC_TYPE; + +// +// SGL Descriptor Sub Type defined in +// the Scatter Gather List section +// +typedef enum _NVME_SGL_DESC_SUBTYPE { + + NvmeSglDescSubtypeAddress = 0x0, + NvmeSglDescSubtypeOffset = 0x1, + NvmeSglDescSubtypeTransportA = 0xA, + NvmeSglDescSubtypeTransportB = 0xB, + NvmeSglDescSubtypeTransportC = 0xC, + NvmeSglDescSubtypeTransportD = 0xD, + NvmeSglDescSubtypeTransportE = 0xE, + NvmeSglDescSubtypeTransportF = 0xF + +} NVME_SGL_DESC_SUBTYPE; + +// +// General NVMe SGL Descriptor +// +typedef struct _NVME_SGL_DESC { + + UCHAR Reserved0[15]; + + union { + struct { + + UCHAR SubType : 4; + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_DESC, *PNVME_SGL_DESC; + +C_ASSERT(sizeof(NVME_SGL_DESC) == 2 * sizeof(ULONGLONG)); + +// +// NVMe SGL Data Block descriptor +// +typedef struct _NVME_SGL_DATABLOCK_DESC { + + ULONGLONG Address; + ULONG Length; + UCHAR Reserved0[3]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeDataBlock, NvmeSglDescTypeDataBlock) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_DATABLOCK_DESC, *PNVME_SGL_DATABLOCK_DESC; + +C_ASSERT(sizeof(NVME_SGL_DATABLOCK_DESC) == 2 * sizeof(ULONGLONG)); + +// +// NVMe SGL Bit Bucket descriptor +// +typedef struct _NVME_SGL_BITBUCKET_DESC { + + ULONGLONG Reserved0; + ULONG Length; + UCHAR Reserved1[3]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeBitBucket, NvmeSglDescTypeBitBucket) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_BITBUCKET_DESC, *PNVME_SGL_BITBUCKET_DESC; + +C_ASSERT(sizeof(NVME_SGL_BITBUCKET_DESC) == 2 * sizeof(ULONGLONG)); + +// +// NVMe SGL Segment descriptor +// +typedef struct _NVME_SGL_SEGMENT_DESC { + + ULONGLONG Address; + ULONG Length; + UCHAR Reserved0[3]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeSegment, NvmeSglDescTypeSegment) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_SEGMENT_DESC, *PNVME_SGL_SEGMENT_DESC; + +C_ASSERT(sizeof(NVME_SGL_SEGMENT_DESC) == 2 * sizeof(ULONGLONG)); + +// +// NVMe SGL Last Segment descriptor +// +typedef struct _NVME_SGL_LASTSEG_DESC { + + ULONGLONG Address; + ULONG Length; + UCHAR Reserved0[3]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeLastSegment, NvmeSglDescTypeLastSegment) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_LASTSEG_DESC, *PNVME_SGL_LASTSEG_DESC; + +C_ASSERT(sizeof(NVME_SGL_LASTSEG_DESC) == 2 * sizeof(ULONGLONG)); + +// +// SGL Descriptor Sub Type defined in +// the Scatter Gather List section +// +typedef enum _NVME_RDMA_KEYED_SGL_DESC_SUBTYPE { + + NvmeRdmaKeyedSglDescSubtypeInvalidate = 0xF + +} NVME_RDMA_KEYED_SGL_DESC_SUBTYPE; + +// +// NVMe SGL Keyed Data Block descriptor +// +typedef struct _NVME_SGL_KEYDATABLOCK_DESC { + + ULONGLONG Address; + UCHAR Length[3]; + UCHAR Key[4]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeKeyedDataBlock, NvmeSglDescTypeKeyedDataBlock) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_KEYDATABLOCK_DESC, *PNVME_SGL_KEYDATABLOCK_DESC; + +C_ASSERT(sizeof(NVME_SGL_KEYDATABLOCK_DESC) == 2 * sizeof(ULONGLONG)); + +// +// NVMe SGL Transport Data Block descriptor +// +typedef struct _NVME_SGL_TRANSPORTDATA_DESC { + + ULONGLONG Reserved0; + ULONG Length; + UCHAR Reserved1[3]; + + union { + struct { + + UCHAR SubType : 4; + + _Field_range_(NvmeSglDescTypeTransportDataBlock, NvmeSglDescTypeTransportDataBlock) + UCHAR Type : 4; + }; + + UCHAR AsUchar; + + } Identifier; + +} NVME_SGL_TRANSPORTDATA_DESC, *PNVME_SGL_TRANSPORTDATA_DESC; + +C_ASSERT(sizeof(NVME_SGL_TRANSPORTDATA_DESC) == 2 * sizeof(ULONGLONG)); + +//////////////////////////////////////////////////////////////////////// +// +// NVMe over Fabrics definitions based on 2.0 spec +// + +#define NVMEOF_TRANSPORT_ADDR_MAX_LEN 256 +#define NVMEOF_TRANSPORT_SERVID_MAX_LEN 32 +#define NVMEOF_TRANSPORT_SAS_MAX_LEN 256 + +#define NVMEOF_DISCOVERY_NQN "nqn.2014-08.org.nvmexpress.discovery" +#define NVMEOF_DISCOVERY_LOG_VERSION_0 0 + +#define NVMEOF_ADMINQ_MIN_DEPTH 32 +#define NVMEOF_ADMINQ_MAX_DEPTH 4096 + +#define NVMEOF_IOQ_MIN_DEPTH 2 +#define NVMEOF_IOQ_MAX_DEPTH 65536 + +#define NVMEOF_PROPERTY_SIZE_4Bytes 0x00 +#define NVMEOF_PROPERTY_SIZE_8Bytes 0x01 + +// +// Fabrics Command Types +// +typedef enum { + + NVME_FABRICS_COMMAND_PROPERTY_SET = 0x00, + NVME_FABRICS_COMMAND_CONNECT = 0x01, + NVME_FABRICS_COMMAND_PROPERTY_GET = 0x04, + NVME_FABRICS_COMMAND_AUTH_SEND = 0x05, + NVME_FABRICS_COMMAND_AUTH_RECV = 0x06, + NVME_FABRICS_COMMAND_DISCONNECT = 0x08 + +} NVME_FABRICS_COMMAND_TYPE; + +// +// Transport type (TRTYPE) defined in the +// Get Log Page - Discovery Log Page Entry +// +typedef enum _NVMEOF_TRANSPORT_TYPE { + + NvmeofTransportUnknown = 0, + NvmeofTransportRdma = 1, + NvmeofTransportFC = 2, + NvmeofTransportTcp = 3, + NvmeofTransportLoopback = 254, + NvmeofTransportMax = 255 + +} NVMEOF_TRANSPORT_TYPE; + +// +// Address family (ADRFAM) defined in the +// Get Log Page - Discovery Log Page Entry +// +typedef enum _NVMEOF_ADDRESS_FAMILY { + + NvmeofAddressUnknown = 0, + NvmeofAddressIPv4 = 1, + NvmeofAddressIPv6 = 2, + NvmeofAddressIB = 3, + NvmeofAddressFC = 4, + NvmeofAddressLoopback = 254, + NvmeofAddressMax = 255 + +} NVMEOF_ADDRESS_FAMILY; + +// +// Subsystem type (SUBTYPE) defined in the +// Get Log Page - Discovery Log Page Entry +// +typedef enum _NVMEOF_SUBSYSTEM_TYPE { + + NvmeofSubsysTypeUnknown = 0, + NvmeofSubsysTypeDiscReferral = 1, + NvmeofSubsysTypeIo = 2, + NvmeofSubsysTypeDiscCurrent = 3, + NvmeofSubsysTypeMax = 255 + +} NVMEOF_SUBSYSTEM_TYPE; + +// +// Fabric secure channel requirement in the +// Transport requirements (TREQ) field in the +// Get Log Page - Discovery Log Page Entry +// +typedef enum _NVMEOF_SECURE_CHANNEL { + + NvmeofSCUnspecified = 0, + NvmeofSCRequired = 1, + NvmeofSCNotRequired = 2, + NvmeofSCReserved = 3 + +} NVMEOF_SECURE_CHANNEL; + +// +// Fabric authentication and secure channel +// requirement in the Transport requirements +// (TREQ) field in the Get Log Page - +// Discovery Log Page Entry +// +typedef enum _NVMEOF_AUTH_SECURE_CHANNEL { + + NvmeofAuthSCUnspecified = 0, + NvmeofAuthSCAuthRequired = 1, + NvmeofAuthSCAuthConcatSCRequired = 2, + NvmeofAuthSCReserved = 3 + +} NVMEOF_AUTH_SECURE_CHANNEL; + +// +// NVMe Fabrics Command Capsule +// +typedef struct _NVMEOF_FABRICS_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR PSDT; // PRP or SGL for data transfer (only Bits 7:6 are to be used, rest are reserved) + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type + UCHAR Reserved[35]; // Byte 5:39 + UCHAR Specific[24]; // Byte 40:63 - Command Type Specific + +} NVMEOF_FABRICS_COMMAND, *PNVMEOF_FABRICS_COMMAND; + +C_ASSERT(sizeof(NVMEOF_FABRICS_COMMAND) == 64); + +// +// NVMe Fabrics Response Capsule +// +typedef struct _NVMEOF_FABRICS_RESPONSE { + + UCHAR Specific[8]; // Byte 0:7 - Response Type Specific + USHORT SQHD; // SQ Head Pointer + USHORT Reserved; // Byte 10:11 + USHORT CID; // Command Identifier + USHORT STS; // Status - NVME_COMMAND_STATUS + +} NVMEOF_FABRICS_RESPONSE, *PNVMEOF_FABRICS_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_FABRICS_RESPONSE) == 16); + +// +// NVMeoF Connect Command +// +typedef struct _NVMEOF_CONNECT_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 01h + UCHAR Reserved1[19]; + NVME_SGL_DESC SGL1; // SGL descriptor that describes the entire data transfer + USHORT RECFMT; // Format of connect command capsule + USHORT QID; // Queue Identifier for the Admin Queue or I/O Queue to be created + USHORT SQSIZE; // Size of submission queue to be created + + union { + + struct { + + UCHAR PriorityClass : 2; + UCHAR SqFlowControlDisable : 1; + UCHAR IoQueueDeletion : 1; + UCHAR Reserved : 4; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } CATTR; // Connection attributes + + UCHAR Reserved2; + ULONG KATO; // Keep Alive Timeout, valid only for Admin Queue, reserved for IO Queue + UCHAR Reserved3[12]; + +} NVMEOF_CONNECT_COMMAND, *PNVMEOF_CONNECT_COMMAND; + +C_ASSERT(sizeof(NVMEOF_CONNECT_COMMAND) == 64); + +// +// NVMeoF Connect Command Data +// +typedef struct _NVMEOF_CONNECT_DATA { + + UCHAR HOSTID[NVME_EXTENDED_HOST_IDENTIFIER_SIZE]; + USHORT CNTLID; + UCHAR Reserved0[238]; + UCHAR SUBNQN[NVME_NQN_MAX_LEN]; + UCHAR HOSTNQN[NVME_NQN_MAX_LEN]; + UCHAR Reserved1[256]; + +} NVMEOF_CONNECT_DATA, *PNVMEOF_CONNECT_DATA; + +C_ASSERT(sizeof(NVMEOF_CONNECT_DATA) == 1024); + +// +// NVMeoF Connect Response +// +typedef struct _NVMEOF_CONNECT_RESPONSE { + + union { + + struct { + + USHORT CNTLID; + + union { + + struct { + + USHORT Obsolete : 1; + USHORT ATR : 1; + USHORT ASCR : 1; + USHORT Reserved : 13; + }; + + USHORT AsUshort; + + } AUTHREQ; + + } Success; + + ULONG AsUlong; + + } SCSpecific; // Status Code Specific + + ULONG Reserved0; + USHORT SQHD; // Current Submission Queue Head pointer if SQ flow control is enabled + USHORT Reserved1; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_CONNECT_RESPONSE, *PNVMEOF_CONNECT_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_CONNECT_RESPONSE) == 16); + +// +// NVMeoF Disconnect Command +// +typedef struct _NVMEOF_DISCONNECT_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 08h + UCHAR Reserved1[19]; // Byte 5:23 + NVME_SGL_DATABLOCK_DESC SGL1; + USHORT RECFMT; // Format of disconnect command capsule + UCHAR Reserved2[22]; + +} NVMEOF_DISCONNECT_COMMAND, *PNVMEOF_DISCONNECT_COMMAND; + +C_ASSERT(sizeof(NVMEOF_DISCONNECT_COMMAND) == 64); + +// +// NVMeoF Disconnect Response +// +typedef struct _NVMEOF_DISCONNECT_RESPONSE { + + ULONGLONG Reserved0; + USHORT SQHD; // Current Submission Queue Head pointer for the associated Submission Queue + USHORT Reserved1; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_DISCONNECT_RESPONSE, *PNVMEOF_DISCONNECT_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_DISCONNECT_RESPONSE) == 16); + +// +// NVMeoF Property Get Command +// + +typedef struct _NVMEOF_PROPERTY_GET_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 04h + UCHAR Reserved1[35]; // Byte 5:39 + + struct { + + UCHAR PropertySize : 3; + UCHAR Reserved : 5; + } ATTRIB; // Attributes for the Property Get command + + UCHAR Reserved2[3]; + ULONG OFST; // Offset to the property to get + UCHAR Reserved3[16]; + +} NVMEOF_PROPERTY_GET_COMMAND, *PNVMEOF_PROPERTY_GET_COMMAND; + +C_ASSERT(sizeof(NVMEOF_PROPERTY_GET_COMMAND) == 64); + +// +// NVMeoF Property Get Response +// +typedef struct _NVMEOF_PROPERTY_GET_RESPONSE { + + union { + + struct { + + ULONG Value; + ULONG Reserved; + } FourBytes; + + ULONGLONG EightBytes; + + } VALUE; // Value returned for the property + + USHORT SQHD; // Current Submission Queue Head pointer for the associated Submission Queue + USHORT Reserved0; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_PROPERTY_GET_RESPONSE, *PNVMEOF_PROPERTY_GET_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_PROPERTY_GET_RESPONSE) == 16); + +// +// NVMeoF Property Set Command +// +typedef struct _NVMEOF_PROPERTY_SET_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 00h + UCHAR Reserved1[35]; // Byte 5:39 + + struct { + + UCHAR PropertySize : 3; + UCHAR Reserved : 5; + } ATTRIB; // Attributes for the Property Set command + + UCHAR Reserved2[3]; + ULONG OFST; // Offset to the property to get + + union { + + struct { + + ULONG Value; + ULONG Reserved; + } FourBytes; + + ULONGLONG EightBytes; + + } VALUE; // Value to set for the property + + UCHAR Reserved3[8]; + +} NVMEOF_PROPERTY_SET_COMMAND, *PNVMEOF_PROPERTY_SET_COMMAND; + +C_ASSERT(sizeof(NVMEOF_PROPERTY_SET_COMMAND) == 64); + +// +// NVMeoF Property Set Response +// +typedef struct _NVMEOF_PROPERTY_SET_RESPONSE { + + ULONGLONG Reserved0; + USHORT SQHD; // Current Submission Queue Head pointer for the associated Submission Queue + USHORT Reserved1; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_PROPERTY_SET_RESPONSE, *PNVMEOF_PROPERTY_SET_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_PROPERTY_SET_RESPONSE) == 16); + +// +// NVMeoF Authenticate Receive Command +// +typedef struct _NVMEOF_AUTH_RECEIVE_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 06h + UCHAR Reserved1[19]; // Byte 5:23 + NVME_SGL_DESC SGL1; // SGL descriptor that describes the entire data transfer + UCHAR Reserved2; + UCHAR SPSP0; // Bits 07:00 of Security Protocol Specific field as defined in SPC-5 + UCHAR SPSP1; // Bits 15:08 of Security Protocol Specific field as defined in SPC-5 + UCHAR SECP; // Security protocol as defined in SPC-5 + ULONG AL; // Allocation Length, specific to the Security Protocol as defined in SPC-5 where INC_512 is cleared to '0' + + UCHAR Reserved3[16]; + +} NVMEOF_AUTH_RECEIVE_COMMAND, *PNVMEOF_AUTH_RECEIVE_COMMAND; + +C_ASSERT(sizeof(NVMEOF_AUTH_RECEIVE_COMMAND) == 64); + +// +// NVMeoF Authenticate Receive Response +// +typedef struct _NVMEOF_AUTH_RECEIVE_RESPONSE { + + ULONGLONG Reserved0; + USHORT SQHD; // Current Submission Queue Head pointer for the associated Submission Queue + USHORT Reserved1; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_AUTH_RECEIVE_RESPONSE, *PNVMEOF_AUTH_RECEIVE_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_AUTH_RECEIVE_RESPONSE) == 16); + +// +// NVMeoF Authenticate Send Command +// +typedef struct _NVMEOF_AUTH_SEND_COMMAND { + + UCHAR OPC; // Opcode (7Fh) + UCHAR Reserved0; // Maps to PSDT in NVMEOF_FABRICS_COMMAND + USHORT CID; // Command Identifier + UCHAR FCTYPE; // Fabrics Command Type, set to 05h + UCHAR Reserved1[19]; // Byte 5:23 + NVME_SGL_DESC SGL1; // SGL descriptor that describes the entire data transfer + UCHAR Reserved2; + UCHAR SPSP0; // Bits 07:00 of Security Protocol Specific field as defined in SPC-5 + UCHAR SPSP1; // Bits 15:08 of Security Protocol Specific field as defined in SPC-5 + UCHAR SECP; // Security protocol as defined in SPC-5 + ULONG TL; // Transfer Length, specific to the Security Protocol as defined in SPC-5 where INC_512 is cleared to '0' + + UCHAR Reserved3[16]; + +} NVMEOF_AUTH_SEND_COMMAND, *PNVMEOF_AUTH_SEND_COMMAND; + +C_ASSERT(sizeof(NVMEOF_AUTH_SEND_COMMAND) == 64); + +// +// NVMeoF Authenticate Send Response +// +typedef struct _NVMEOF_AUTH_SEND_RESPONSE { + + ULONGLONG Reserved0; + USHORT SQHD; // Current Submission Queue Head pointer for the associated Submission Queue + USHORT Reserved1; + USHORT CID; // Command Identifier + USHORT STS; // Status + +} NVMEOF_AUTH_SEND_RESPONSE, *PNVMEOF_AUTH_SEND_RESPONSE; + +C_ASSERT(sizeof(NVMEOF_AUTH_SEND_RESPONSE) == 16); + +// +// NVMe Discovery and Extended Discovery Entry +// for Subsystem and Host information. +// +typedef struct _NVME_DISCOVERY_ENTRY { + + UCHAR TRTYPE; // Transport Type - NVMEOF_TRANSPORT_TYPE + UCHAR ADRFAM; // Address Family - NVMEOF_ADDRESS_FAMILY + UCHAR SUBTYPE; // Subsystem Type - NVMEOF_SUBSYSTEM_TYPE + + union { + + struct { + + UCHAR SecureChannel : 2; // NVMEOF_SECURE_CHANNEL + UCHAR SqFlowControlDisable : 1; + UCHAR ZeroHostIdSupport : 1; + UCHAR AuthAndSecureChannel : 2; //NVMEOF_AUTH_SECURE_CHANNEL + UCHAR Reserved : 2; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } TREQ; // Transport Requirements + + USHORT PORTID; // Subsystem Port Id + USHORT CNTLID; // Controller Id + // If subsystem supports dynamic controller model the value will be FFFFh. + // If subsystem supports static controller model and value is FFFEh, the + // host should remember the controller Id returned by Connect command. + // If subsystem supports static controller model and value is between + // 0h and FFEFh, then a specific controller is specified. + USHORT ASQSZ; // Maximum size of an Admin Submission Queue, minimum value of 32 + + union { + + struct { + + USHORT DuplicateReturnedInfo : 1; + USHORT ExplicitPersistentConnectionSupport : 1; + USHORT NoCDCConnectivity : 1; + USHORT Reserved : 13; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + + } EFLAGS; // Entry Flags + + UCHAR Reserved0[20]; + UCHAR TRSVCID[NVMEOF_TRANSPORT_SERVID_MAX_LEN]; // NVMe Transport service identifier + UCHAR Reserved1[192]; + UCHAR NQN[NVME_NQN_MAX_LEN]; // NQN that uniquely identifies the NVM entity (Subsystem/Host) + + UCHAR TRADDR[NVMEOF_TRANSPORT_ADDR_MAX_LEN]; // Address of the fabric interface on the NVM entity (Subsystem/Host) + UCHAR TSAS[NVMEOF_TRANSPORT_SAS_MAX_LEN]; // Transport specific information of the address + +} NVME_DISCOVERY_ENTRY, *PNVME_DISCOVERY_ENTRY; + +C_ASSERT(sizeof(NVME_DISCOVERY_ENTRY) == 1024); + +typedef struct _NVME_EXTENDED_DISCOVERY_ENTRY { + + UCHAR TRTYPE; // Transport Type - NVMEOF_TRANSPORT_TYPE + UCHAR ADRFAM; // Address Family - NVMEOF_ADDRESS_FAMILY + UCHAR SUBTYPE; // Subsystem Type - NVMEOF_SUBSYSTEM_TYPE + + union { + + struct { + + UCHAR SecureChannel : 2; // NVMEOF_SECURE_CHANNEL + UCHAR SqFlowControlDisable : 1; + UCHAR ZeroHostIdSupport : 1; + UCHAR AuthAndSecureChannel : 2; //NVMEOF_AUTH_SECURE_CHANNEL + UCHAR Reserved : 2; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } TREQ; // Transport Requirements + + USHORT PORTID; // Subsystem Port Id + USHORT CNTLID; // Controller Id + // If subsystem supports dynamic controller model the value will be FFFFh. + // If subsystem supports static controller model and value is FFFEh, the + // host should remember the controller Id returned by Connect command. + // If subsystem supports static controller model and value is between + // 0h and FFEFh, then a specific controller is specified. + USHORT ASQSZ; // Maximum size of an Admin Submission Queue, minimum value of 32 + + union { + + struct { + + USHORT DuplicateReturnedInfo : 1; + USHORT ExplicitPersistentConnectionSupport : 1; + USHORT NoCDCConnectivity : 1; + USHORT Reserved : 13; + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + + } EFLAGS; // Entry Flags + + UCHAR Reserved0[20]; + UCHAR TRSVCID[NVMEOF_TRANSPORT_SERVID_MAX_LEN]; // NVMe Transport service identifier + UCHAR Reserved1[192]; + UCHAR NQN[NVME_NQN_MAX_LEN]; // NQN that uniquely identifies the NVM entity (Subsystem/Host) + + UCHAR TRADDR[NVMEOF_TRANSPORT_ADDR_MAX_LEN]; // Address of the fabric interface on the NVM entity (Subsystem/Host) + UCHAR TSAS[NVMEOF_TRANSPORT_SAS_MAX_LEN]; // Transport specific information of the address + + ULONG TEL; // Length in bytes of the entire extended discovery information entry + + USHORT NUMEXAT; // Number of Extended Attributes + + USHORT Reserved2; + +} NVME_EXTENDED_DISCOVERY_ENTRY, *PNVME_EXTENDED_DISCOVERY_ENTRY; + +C_ASSERT(sizeof(NVME_EXTENDED_DISCOVERY_ENTRY) == 1032); + +typedef enum _NVME_EXTENDED_ATTR_TYPE { + + NvmeExtAttrReserved0 = 0x0, + NvmeExtAttrHostId = 0x1, + NvmeExtAttrAdminLabelAscii = 0x2, + NvmeExtAttrAdminLabelUtf8 = 0x3, + NvmeExtAttrReservedStart = 0x4, + NvmeExtAttrReservedEnd = 0xFEFF, + NvmeExtAttrVendorStart = 0xFF00, + NvmeExtAttrVendorEnd = 0xFFFF + +} NVME_EXTENDED_ATTR_TYPE; + +typedef struct _NVME_EXTENDED_ATTR { + + USHORT EXATTYPE; // Extended Attribute Type - NVME_EXTENDED_ATTR_TYPE + + USHORT EXATLEN; // Extended Attribute Length + + _Field_size_(EXATLEN) + UCHAR EXATVAL[0]; // Extended Attribute Value + +} NVME_EXTENDED_ATTR, *PNVME_EXTENDED_ATTR; + +// +// NVMe Discovery Log Page Header +// +typedef struct _NVME_DISCOVERY_HEADER { + + ULONGLONG GENCTR; // Version of the discovery information starting at 0h and incrementing + ULONGLONG NUMREC; // Number of records contained in the log + USHORT RECFMT; // Format of the Discovery Log Page + + union { + + struct { + + UCHAR Extended : 1; + UCHAR PortLocal : 1; + UCHAR AllSubsystems : 1; + UCHAR Reserved : 5; + } DUMMYSTRUCTNAME; + + UCHAR AsUchar; + + } DLPF; // Entry Flags + + UCHAR Reserved0; + + ULONG TDLPL; + + UCHAR Reserved1[1000]; + +} NVME_DISCOVERY_HEADER, *PNVME_DISCOVERY_HEADER; + +C_ASSERT(sizeof(NVME_DISCOVERY_HEADER) == 1024); + +// +// Data for NVME_ADMIN_COMMAND_DISCOVERY_INFO_MGMT +// +typedef enum { + + NVME_DISCOVERY_INFO_ENTRY_FORMAT_RESERVED = 0, + NVME_DISCOVERY_INFO_ENTRY_FORMAT_BASIC = 1, + NVME_DISCOVERY_INFO_ENTRY_FORMAT_EXTENDED = 2 + +} NVME_DISCOVERY_INFO_ENTRY_FORMATS; + +typedef enum { + + NVME_DISCOVERY_INFO_ENTITY_TYPE_RESERVED = 0, + NVME_DISCOVERY_INFO_ENTITY_TYPE_HOST = 1, + NVME_DISCOVERY_INFO_ENTITY_TYPE_DDC = 2, + NVME_DISCOVERY_INFO_ENTITY_TYPE_CDC = 3 + +} NVME_DISCOVERY_INFO_ENTITY_TYPES; + +#define NVME_DISCOVERY_INFO_MGMT_EKTYPE_PORTID 0x003F // EKTYPE - Port ID Based (For Subsystem) +#define NVME_DISCOVERY_INFO_MGMT_EKTYPE_TRADDR 0x005F // EKTYPE - TRADDR Based (For Subsystem and Host) + +typedef struct _NVME_DISCOVERY_INFO_MGMT_HEADER { + + ULONG TDL; // Total Data Length (TDL) + ULONG Reserved0; + + ULONGLONG NUMENT; // Number of Entries (NUMENT) + + USHORT ENTFMT; // Entry Format (ENTFMT) + USHORT ETYPE; // Entity Type (ETYPE) + + UCHAR PORTLCL; // Port Local (PORTLCL) + UCHAR Reserved1; + + union { + + struct { + + USHORT NQN : 1; + USHORT TSAS : 1; + USHORT TRSVCID : 1; + USHORT ADRFAM : 1; + USHORT TRTYPE : 1; + USHORT PORTID : 1; + USHORT TRADDR : 1; + USHORT Reserved : 9; + + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + + } EKTYPE; // Entry Key Type (EKTYPE) + + UCHAR EID[256]; // Entity Identifier (EID) + UCHAR ENAME[256]; // Entity Name (ENAME) + UCHAR EVER[64]; // Entity Version (EVER) + + UCHAR Reserved2[424]; + +} NVME_DISCOVERY_INFO_MGMT_HEADER, *PNVME_DISCOVERY_INFO_MGMT_HEADER; + +C_ASSERT(sizeof(NVME_DISCOVERY_INFO_MGMT_HEADER) == 1024); + +// +// NVMeof Authentication and Secure Channel definitions +// + +// +// Authentication Security Protocols (SECP) +// +typedef enum _NVMEOF_AUTH_PROTOCOL { + + NvmeofAuthProtocolDHCHAP = 0xe9 + +} NVMEOF_AUTH_PROTOCOL; + +// +// Authentication Types (AUTH_TYPE) +// +typedef enum _NVMEOF_AUTH_TYPE { + + NvmeofAuthTypeCommonMessages = 0x00, + NvmeofAuthTypeDHCHAPMessages = 0x01 + +} NVMEOF_AUTH_TYPE; + +// +// Authentication IDs (AUTH_ID) +// +typedef enum _NVMEOF_AUTH_ID { + + NvmeofAuthIdNegotiate = 0x00, + NvmeofAuthIdChallenge = 0x01, + NvmeofAuthIdReply = 0x02, + NvmeofAuthIdSuccess1 = 0x03, + NvmeofAuthIdSuccess2 = 0x04, + NvmeofAuthIdFailure2 = 0xf0, + NvmeofAuthIdFailure1 = 0xf1 + +} NVMEOF_AUTH_ID; + +// +// Secure Channel Protocol Identifiers (SC_C) +// +typedef enum _NVMEOF_SECURE_CHANNEL_PROTOCOL { + + NvmeofSecureChannelConcatNone = 0x00, + NvmeofSecureChannelConcatWithTLS = 0x01, + NvmeofSecureChannelNewTLSPSK = 0x02, + NvmeofSecureChannelReplaceTLSPSK = 0x02, + +} NVMEOF_SECURE_CHANNEL_PROTOCOL; + +// +// Authentication Failure Reason Codes (RCODE) +// +typedef enum _NVMEOF_AUTH_FAIL_REASON_CODE { + + NvmeofAuthFailureReasonFailed = 0x01, + +} NVMEOF_AUTH_FAIL_REASON_CODE; + +// +// Authentication Failure Reason Explanations (RCODEEX) +// +typedef enum _NVMEOF_AUTH_FAIL_REASON_EXPLANATION { + + NvmeofAuthFailed = 0x01, + NvmeofAuthProtocolNotUsable = 0x02, + NvmeofAuthSecureChannelConcatMismatch = 0x03, + NvmeofAuthHashFunctionNotUsable = 0x04, + NvmeofAuthDHGroupNotUsable = 0x05, + NvmeofAuthIncorrectPayload = 0x06, + NvmeofAuthIncorrectProtocolMessage = 0x07 + +} NVMEOF_AUTH_FAIL_REASON_EXPLANATION; + +// +// Authentication Negotiate message +// +typedef struct _NVMEOF_AUTH_NEGOTIATE { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeCommonMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdNegotiate + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR SC_C; // NVMEOF_SECURE_CHANNEL_PROTOCOL + UCHAR NAPD; // Number of authentication protocol descriptors + + // + // Followed by one or more authentication + // protocol descriptors + // + +} NVMEOF_AUTH_NEGOTIATE, *PNVMEOF_AUTH_NEGOTIATE; + +// +// Authentication Failure message +// +typedef struct _NVMEOF_AUTH_FAILURE { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeCommonMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdFailure1, NvmeofAuthIdFailure2 + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR ReasonCode; // NVMEOF_AUTH_FAIL_REASON_CODE + UCHAR ReasonExplanation; // NVMEOF_AUTH_FAIL_REASON_EXPLANATION + +} NVMEOF_AUTH_FAILURE, *PNVMEOF_AUTH_FAILURE; + +C_ASSERT(sizeof(NVMEOF_AUTH_FAILURE) == 8); + +// +// DH-HMAC-CHAP Protocol definitions +// +#define NVMEOF_DHCHAP_PROTOCOL_ID 0x01 + +#define NVMEOF_DHCHAP_PREFIX_V1 "DHHC-1:" + +typedef enum _NVMEOF_AUTH_DHCHAP_HASH_ID { + + NvmeofAuthDHCHAPHashReserved = 0x00, + NvmeofAuthDHCHAPHashSha256 = 0x01, + NvmeofAuthDHCHAPHashSha384 = 0x02, + NvmeofAuthDHCHAPHashSha512 = 0x03, + NvmeofAuthDHCHAPHashMax = 0xFF + +} NVMEOF_AUTH_DHCHAP_HASH_ID; + +typedef enum _NVMEOF_AUTH_DHCHAP_GROUP_ID { + + NvmeofAuthDHCHAPGroupNull = 0x00, + NvmeofAuthDHCHAPGroup2048 = 0x01, + NvmeofAuthDHCHAPGroup3072 = 0x02, + NvmeofAuthDHCHAPGroup4096 = 0x03, + NvmeofAuthDHCHAPGroup6144 = 0x04, + NvmeofAuthDHCHAPGroup8192 = 0x05, + NvmeofAuthDHCHAPGroupMax = 0xFF + +} NVMEOF_AUTH_DHCHAP_GROUP_ID; + +UCHAR +FORCEINLINE +NVMEOF_AUTH_GET_HASH_LENGTH ( + _In_ UCHAR HashId + ) +{ + UCHAR Length = 0; + + switch(HashId) { + + case NvmeofAuthDHCHAPHashSha256: + Length = 32; + break; + + case NvmeofAuthDHCHAPHashSha384: + Length = 48; + break; + + case NvmeofAuthDHCHAPHashSha512: + Length = 64; + break; + } + + return Length; +} + +typedef struct _NVMEOF_AUTH_DHCHAP_DESCRIPTOR { + + UCHAR AuthId; // Authentication protocol identifier (NVMEOF_DHCHAP_PROTOCOL_ID) + UCHAR Reserved0; + + UCHAR HALEN; // HashIDList Length: Number of hash function identifiers (1 to 30) + UCHAR DHLEN; // DHgIDList Length: Number of Diffie-Hellman group identifiers (1 to 30) + + UCHAR IdList[60]; // List of HashIDList (NVMEOF_AUTH_DHCHAP_HASH_ID) + // and DHgIDList (NVMEOF_AUTH_DHCHAP_GROUP_ID) + +} NVMEOF_AUTH_DHCHAP_DESCRIPTOR, *PNVMEOF_AUTH_DHCHAP_DESCRIPTOR; + +C_ASSERT(sizeof(NVMEOF_AUTH_DHCHAP_DESCRIPTOR) == 64); + +typedef struct _NVMEOF_AUTH_DHCHAP_CHALLENGE { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeDHCHAPMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdChallenge + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR HL; // Hash Length, Length in bytes of the selected hash function + UCHAR Reserved1; + + UCHAR HashID; // Identifier of selected hash function + UCHAR DHgID; // Identifier of selected Diffie-Hellman group + + USHORT DHVLEN; // DH Value Length, Length in bytes of DH value. + // If no DH value is included in the message, + // then this field is cleared to 0h. + // This should be a multiple of 4. + + ULONG SEQNUM; // Sequence Number + + // + // Followed by Challenge Value (CVAL) bytes + // of HL length + // + + // + // Followed by DH Value (DHV) bytes + // of DHVLEN length + // + +} NVMEOF_AUTH_DHCHAP_CHALLENGE, *PNVMEOF_AUTH_DHCHAP_CHALLENGE; + +#define NVMEOF_DHCHAP_REPLY_CVAL_NOTVALID 0x00 +#define NVMEOF_DHCHAP_REPLY_CVAL_VALID 0x01 + +typedef struct _NVMEOF_AUTH_DHCHAP_REPLY { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeDHCHAPMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdReply + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR HL; // Hash Length, Length in bytes of the selected hash function + UCHAR Reserved1; + + UCHAR CVALID; // Challenge Valid + UCHAR Reserved2; + + USHORT DHVLEN; // DH Value Length, Length in bytes of DH value. + // If no DH value is included in the message, + // then this field is cleared to 0h. + // This should be a multiple of 4. + + ULONG SEQNUM; // Sequence Number + + // + // Followed by Response Value (RVAL) bytes + // of HL length + // + + // + // Followed by Challenge Value (CVAL) bytes + // of HL length + // + + // + // Followed by DH Value (DHV) bytes + // of DHVLEN length + // + +} NVMEOF_AUTH_DHCHAP_REPLY, *PNVMEOF_AUTH_DHCHAP_REPLY; + +#define NVMEOF_DHCHAP_SUCCESS1_RVAL_NOTVALID 0x00 +#define NVMEOF_DHCHAP_SUCCESS1_RVAL_VALID 0x01 + +typedef struct _NVMEOF_AUTH_DHCHAP_SUCCESS1 { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeDHCHAPMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdSuccess1 + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR HL; // Hash Length, Length in bytes of the selected hash function + UCHAR Reserved1; + + UCHAR RVALID; // Response Valid + UCHAR Reserved2[7]; + + // + // Followed by Response Value (RVAL) bytes + // of HL length + // + +} NVMEOF_AUTH_DHCHAP_SUCCESS1, *PNVMEOF_AUTH_DHCHAP_SUCCESS1; + +typedef struct _NVMEOF_AUTH_DHCHAP_SUCCESS2 { + + UCHAR AUTH_TYPE; // NVMEOF_AUTH_TYPE: NvmeofAuthTypeDHCHAPMessages + UCHAR AUTH_ID; // NVMEOF_AUTH_ID: NvmeofAuthIdSuccess2 + + USHORT Reserved0; + USHORT T_ID; // Transaction identifier + + UCHAR Reserved1[10]; + +} NVMEOF_AUTH_DHCHAP_SUCCESS2, *PNVMEOF_AUTH_DHCHAP_SUCCESS2; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4214) +#pragma warning(default:4201) +#pragma warning(default:4200) +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_STORAGE) */ +#pragma endregion + +#endif //NVME_INCLUDED + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packoff.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packoff.h new file mode 100644 index 0000000000000000000000000000000000000000..bfa909d53487405534fc58d4ba60eb81a3d8ea09 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packoff.h @@ -0,0 +1,30 @@ +/*++ + +Copyright (c) 1990,91 Microsoft Corporation + +Module Name: + + packoff.h + +Abstract: + + This file turns packing of structures off. (That is, it enables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. + + packoff.h is the complement to packon.h. An inclusion of packoff.h + MUST ALWAYS be preceded by an inclusion of packon.h, in one-to-one + correspondence. + +Revision History: + + 15-Apr-1991 + Created lint-able variant. +--*/ + +#if ! (defined(lint) || defined(_lint)) +#if ( _MSC_VER >= 800 ) +#pragma warning(disable:4103) +#endif +#pragma pack() +#endif // ! (defined(lint) || defined(_lint)) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packon.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packon.h new file mode 100644 index 0000000000000000000000000000000000000000..bb50a0aaafdbe22cbb0d0ad247c4db2fc6fdad20 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/packon.h @@ -0,0 +1,28 @@ +/*++ + +Copyright (c) 1990,91 Microsoft Corporation + +Module Name: + + packon.h + +Abstract: + + This file turns packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. + + The file packoff.h is the complement to this file. + +Revision History: + + 15-Apr-1991 + Created lint-able variant. +--*/ + +#if ! (defined(lint) || defined(_lint)) +#if ( _MSC_VER >= 800 ) +#pragma warning(disable:4103) +#endif +#pragma pack(1) // x86, MS compiler; MIPS, MIPS compiler +#endif // ! (defined(lint) || defined(_lint)) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pciprop.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pciprop.h new file mode 100644 index 0000000000000000000000000000000000000000..909fbc73aa34702d9d8468034b8104fa4ffd8ea5 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pciprop.h @@ -0,0 +1,618 @@ +/*++ + +Copyright (c) 2005 Microsoft Corporation + +Module Name: + + pciprop.h + +Abstract: + + This file contains custom property definitions for a PCI root bus and a PCI + device. + +--*/ + +#ifndef _PCIPROP_ +#define _PCIPROP_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +// +// The GUID {D817FC28-793E-4b9e-9970-469D8BE63073} is a seed for all properties +// defined for a root bus. +// + +#define DEFINE_PCI_ROOT_BUS_DEVPKEY(_DevPkeyName, _Pid) \ + DEFINE_DEVPROPKEY((_DevPkeyName), 0xd817fc28, 0x793e, 0x4b9e, 0x99, 0x70, 0x46, 0x9d, 0x8b, 0xe6, 0x30, 0x73, (_Pid)) + +// +// This property describes the secondary side characteristics of a root bus. +// The values for this property field are interpreted as below: +// + +#define DevProp_PciRootBus_SecondaryInterface_PciConventional 0 +#define DevProp_PciRootBus_SecondaryInterface_PciXMode1 1 +#define DevProp_PciRootBus_SecondaryInterface_PciXMode2 2 +#define DevProp_PciRootBus_SecondaryInterface_PciExpress 3 + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_SecondaryInterface, 1); //DEVPROP_TYPE_UINT32 + +// +// This field is valid for conventional PCI and PCI-X host bridges. +// The values for this property field are interpreted as below: +// + +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_Conventional_33Mhz 0 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_Conventional_66Mhz 1 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_66Mhz 2 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_100Mhz 3 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_133Mhz 4 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_ECC_66Mhz 5 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_ECC_100Mhz 6 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_Mode1_ECC_133Mhz 7 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_266_Mode2_66Mhz 8 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_266_Mode2_100Mhz 9 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_266_Mode2_133Mhz 10 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_533_Mode2_66Mhz 11 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_533_Mode2_100Mhz 12 +#define DevProp_PciRootBus_CurrentSpeedAndMode_Pci_X_533_Mode2_133Mhz 13 + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_CurrentSpeedAndMode, 2); //DEVPROP_TYPE_UINT32 + +// +// This field is valid for conventional PCI and PCI-X host bridges. +// The values for this property field are interpreted as below: +// + +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_Conventional_33Mhz 1 +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_Conventional_66Mhz 2 +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_X_66Mhz 4 +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_X_133Mhz 8 +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_X_266Mhz 16 +#define DevProp_PciRootBus_SupportedSpeedsAndModes_Pci_X_533Mhz 32 + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_SupportedSpeedsAndModes, 3); //DEVPROP_TYPE_UINT32 + +// +// This is boolean indicating if the host bridge is capable of forwarding +// Device ID Message transactions. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_DeviceIDMessagingCapable, 4); // DEVPROP_TYPE_BOOLEAN + +// +// Provides the width of a root bus interface. +// + +#define DevProp_PciRootBus_BusWidth_32Bits 0 +#define DevProp_PciRootBus_BusWidth_64Bits 1 + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_SecondaryBusWidth, 5); //DEVPROP_TYPE_UINT32 + +// +// This is a boolean indicating that an extended config space is available +// on the secondary side of the root bus. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_ExtendedConfigAvailable, 6); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating an operating system support for an extended +// PCI config op region. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_ExtendedPCIConfigOpRegionSupport, 7); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating an operating system support for ASPM. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_ASPMSupport, 8); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating an operating system support for clock power +// management. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_ClockPowerManagementSupport, 9); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating an operating system support for PCI Segments. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_PCISegmentGroupsSupport, 10); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating an operating system support for Message +// Signaled Interrupts. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_MSISupport, 11); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the firmware has granted control of native +// hot plug interrupts to the operating system. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_PCIExpressNativeHotPlugControl, 12); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the firmware has granted control of native +// SHPC to the operating system. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_SHPCNativeHotPlugControl, 13); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the firmware has granted control over +// native PME interrupts to the operating system. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_PCIExpressNativePMEControl, 14); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the firmware has granted control over +// AER to the operating system. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_PCIExpressAERControl, 15); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the firmware has granted control over the +// PCI Express capability to the operating system. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_PCIExpressCapabilityControl, 16); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the operating system is controlling PCI +// Express features natively. Generally this will be a reflection of the +// individual feature controls granted by the firmware and exposed by properties +// above, but the operating system might override the firmware. The final +// control disposition is reflected here. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_NativePciExpressControl, 17); // DEVPROP_TYPE_BOOLEAN + +// +// This is a boolean indicating that the system is configured to support MSI. +// If this is FALSE no message-signaled interrupts will be allocated to devices +// on this system, even if the operating system supports MSI. +// + +DEFINE_PCI_ROOT_BUS_DEVPKEY(DEVPKEY_PciRootBus_SystemMsiSupport, 18); // DEVPROP_TYPE_BOOLEAN + + +// +// The GUID {3AB22E31-8264-4b4e-9AF5-A8D2D8E33E62} is a seed for all properties +// defined for a PCI device. +// + +#define DEFINE_PCI_DEVICE_DEVPKEY(_DevPkeyName, _Pid) \ + DEFINE_DEVPROPKEY((_DevPkeyName), 0x3ab22e31, 0x8264, 0x4b4e, 0x9a, 0xf5, 0xa8, 0xd2, 0xd8, 0xe3, 0x3e, 0x62, (_Pid)) + +// +// This property is defined to display the type of PCI device. The possible +// values are shown below. +// + +#define DevProp_PciDevice_DeviceType_PciConventional 0 +#define DevProp_PciDevice_DeviceType_PciX 1 +#define DevProp_PciDevice_DeviceType_PciExpressEndpoint 2 +#define DevProp_PciDevice_DeviceType_PciExpressLegacyEndpoint 3 +#define DevProp_PciDevice_DeviceType_PciExpressRootComplexIntegratedEndpoint 4 +#define DevProp_PciDevice_DeviceType_PciExpressTreatedAsPci 5 +#define DevProp_PciDevice_BridgeType_PciConventional 6 +#define DevProp_PciDevice_BridgeType_PciX 7 +#define DevProp_PciDevice_BridgeType_PciExpressRootPort 8 +#define DevProp_PciDevice_BridgeType_PciExpressUpstreamSwitchPort 9 +#define DevProp_PciDevice_BridgeType_PciExpressDownstreamSwitchPort 10 +#define DevProp_PciDevice_BridgeType_PciExpressToPciXBridge 11 +#define DevProp_PciDevice_BridgeType_PciXToExpressBridge 12 +#define DevProp_PciDevice_BridgeType_PciExpressTreatedAsPci 13 +#define DevProp_PciDevice_BridgeType_PciExpressEventCollector 14 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_DeviceType, 1); + +// +// This property is valid for conventional PCI or PCI-X devices. +// For conventional PCI devices, the speed/mode is described by the following +// fields. +// + +#define DevProp_PciDevice_CurrentSpeedAndMode_Pci_Conventional_33MHz 0 +#define DevProp_PciDevice_CurrentSpeedAndMode_Pci_Conventional_66MHz 1 + +// +// For PCI-X devices, the speed/mode is encoded in the following fashion. +// + +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode_Conventional_Pci 0x0 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_66Mhz 0x1 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_100Mhz 0x2 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_133MHZ 0x3 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_ECC_66Mhz 0x5 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_ECC_100Mhz 0x6 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode1_ECC_133Mhz 0x7 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_266_66MHz 0x9 +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_266_100MHz 0xA +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_266_133MHz 0xB +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_533_66MHz 0xD +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_533_100MHz 0xE +#define DevProp_PciDevice_CurrentSpeedAndMode_PciX_Mode2_533_133MHz 0xF + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_CurrentSpeedAndMode, 2); + +// +// The BaseClass, SubClass and ProgIf fields are valid for all PCI devices. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_BaseClass, 3); + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_SubClass, 4); + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_ProgIf, 5); + +// +// This property describes the current payload size in the transaction layer +// for a PCI Express device. The encodings for this field are described below. +// + +#define DevProp_PciExpressDevice_PayloadOrRequestSize_128Bytes 0 +#define DevProp_PciExpressDevice_PayloadOrRequestSize_256Bytes 1 +#define DevProp_PciExpressDevice_PayloadOrRequestSize_512Bytes 2 +#define DevProp_PciExpressDevice_PayloadOrRequestSize_1024Bytes 3 +#define DevProp_PciExpressDevice_PayloadOrRequestSize_2048Bytes 4 +#define DevProp_PciExpressDevice_PayloadOrRequestSize_4096Bytes 5 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_CurrentPayloadSize, 6); + +// +// This property describes the maximum payload size supported by an express +// device/function. The encodings are described above. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_MaxPayloadSize, 7); + +// +// This property describes the maximum read request size for an express device. +// The encoding for this field are given above. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_MaxReadRequestSize, 8); + +// +// This property is applicable to an express device with an express link. It +// describes the current link speed for the device. The encodings are defined +// as follows. +// + +#define DevProp_PciExpressDevice_LinkSpeed_TwoAndHalf_Gbps 1 +#define DevProp_PciExpressDevice_LinkSpeed_Five_Gbps 2 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_CurrentLinkSpeed, 9); + +// +// This property is applicable to an express device with an express link. It +// describes the current link width whose encoding is as follows. +// + +#define DevProp_PciExpressDevice_LinkWidth_By_1 1 +#define DevProp_PciExpressDevice_LinkWidth_By_2 2 +#define DevProp_PciExpressDevice_LinkWidth_By_4 4 +#define DevProp_PciExpressDevice_LinkWidth_By_8 8 +#define DevProp_PciExpressDevice_LinkWidth_By_12 12 +#define DevProp_PciExpressDevice_LinkWidth_By_16 16 +#define DevProp_PciExpressDevice_LinkWidth_By_32 32 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_CurrentLinkWidth, 10); + +// +// This property describes the maximum link speed of an express link for an +// express device. The encodings for this field are: +// + +#define DevProp_PciExpressDevice_LinkSpeed_TwoAndHalf_Gbps 1 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_MaxLinkSpeed, 11); + +// +// This property describes the maximum link width implemented by an express +// link for an express devce. The encodings are same as described above. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_MaxLinkWidth, 12); + +// +// This property describes the specification version to which an express device +// was built. The encodings for this field are: +// + +#define DevProp_PciExpressDevice_Spec_Version_10 1 +#define DevProp_PciExpressDevice_Spec_Version_11 2 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_ExpressSpecVersion, 13); + +// +// This property describes the hardware support for interrupts on the device. +// It is a bitmask of supported interrupt types, with the following values: +// + +#define DevProp_PciDevice_InterruptType_LineBased 1 +#define DevProp_PciDevice_InterruptType_Msi 2 +#define DevProp_PciDevice_InterruptType_MsiX 4 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_InterruptSupport, 14); + +// +// This property describes the number of message interrupts a device supports +// in hardware. This property is only valid if the device supports message +// interrupts. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_InterruptMessageMaximum, 15); + +// +// This property describes the number of Base Address Registers of various types +// supported by the device hardware. The property data is a 32 bit value +// interpreted by the following macros: +// + +#define DevProp_PciDevice_IoBarCount(_PropertyData) ((_PropertyData) & 0xFF) +#define DevProp_PciDevice_NonPrefetchable_MemoryBarCount(_PropertyData) (((_PropertyData) >> 8) & 0xFF) +#define DevProp_PciDevice_32BitPrefetchable_MemoryBarCount(_PropertyData) (((_PropertyData) >> 16) & 0xFF) +#define DevProp_PciDevice_64BitPrefetchable_MemoryBarCount(_PropertyData) (((_PropertyData) >> 24) & 0xFF) + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_BarTypes, 16); + +// +// This property is a BOOLEAN indicating if AER capability is present on an +// endpoint. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AERCapabilityPresent, 17); + +// +// This property indicates if a device is configured for a firmware first +// error handling. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_FirmwareErrorHandling, 18); + +// +// This property provides the uncorrectable error mask for an endpoint. This +// field is interpreted in accordance to its definition in the PCI Express +// Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Uncorrectable_Error_Mask, 19); + +// +// This property provides the uncorrectable error severity for an endpoint. +// This field is interpreted in accordance to its definition in the PCI Express +// Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Uncorrectable_Error_Severity, 20); + +// +// This property provides the correctable error mask for an endpoint. This +// field is interpreted in accordance to its definition in the PCI Express +// Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Correctable_Error_Mask, 21); + +// +// This property indicates if a device is capable of ECRC generation and +// checking. This field is interpreted in according to the advanced error +// capabilities and control register value in the PCI Express Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_ECRC_Errors, 22); + +// +// This property indicates if an endpoint is enabled for reporting different +// types of error messages. This field is interpreted in accordance to the +// device control register value as described in the PCI Express Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Error_Reporting, 23); + +// +// This property indicates if a root port is enabled for reporting different +// types of error messages. This field is interpreted in accordance to the +// root control register value as described in the PCI Express Base spec. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_RootError_Reporting, 24); + +// +// This property indicates if a device can wake up via PME while the system is +// in S0. Some platforms do not support runtime wakeup on some device types. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_S0WakeupSupported, 25); + + +// +// This property indicates the status of SR-IOV support for the +// device. A status of 0 indicates that the device supports SR-IOV +// and that the system can enable this support. Non-zero value +// indicates an error that prevents SR-IOV support. +// + +#define DevProp_PciDevice_SriovSupport_Ok 0x0 +#define DevProp_PciDevice_SriovSupport_MissingAcs 0x1 +#define DevProp_PciDevice_SriovSupport_MissingPfDriver 0x2 +#define DevProp_PciDevice_SriovSupport_NoBusResource 0x3 +#define DevProp_PciDevice_SriovSupport_DidntGetVfBarSpace 0x4 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_SriovSupport, 26); + +// +// This property provides the unique ID associated with a PCI device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Label_Id, 27); + +// +// This property provides an indentifying string associated with a PCI device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_Label_String, 28); + +// +// This property indicates the status of ACS support for this bridge +// or device. A status of 0 indicates that ACS support is present. A +// status of 1 indicates that ACS support is not required. "Status 1" +// is valid for root ports only. Any other status indicates that ACS +// support is missing where it is required. +// + +#define DevProp_PciDevice_AcsSupport_Present 0x0 +#define DevProp_PciDevice_AcsSupport_NotNeeded 0x1 +#define DevProp_PciDevice_AcsSupport_Missing 0x2 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AcsSupport, 29); + +// +// This property indicates the capability for ARI support on this device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AriSupport, 30); + +// +// This property indicates the status of ACS support of not only the +// current device, but the whole heirarchy up to the express root port. +// Supported indicates that the device is a multifunction device that +// impelements a capability struct, and also each device up the the +// hierarchy implements ACS also. SingleFunctionSupported indicates +// that ACS is supported up the hierarchy, and since the device is +// single function, it is compatible by not implementing ACS. +// NoP2PSupported indicates that the device is multifunction, does not +// implement an ACS header, but does not support peer-to-peer (P2P), +// and ACS is supported up the hierarchy. NotSupported indicates +// that somewhere along the hierarchy ACS is not supported or the +// device is multifunction and does not implement ACS. +// + +#define DevProp_PciDevice_AcsCompatibleUpHierarchy_NotSupported 0x0 +#define DevProp_PciDevice_AcsCompatibleUpHierarchy_SingleFunctionSupported 0x1 +#define DevProp_PciDevice_AcsCompatibleUpHierarchy_NoP2PSupported 0x2 +#define DevProp_PciDevice_AcsCompatibleUpHierarchy_Supported 0x3 +#define DevProp_PciDevice_AcsCompatibleUpHierarchy_Enhanced 0x4 + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AcsCompatibleUpHierarchy, 31); + +// +// This property contains the actual value of the ACS capability register +// on the device. If the device does not implement an ACS capability +// struct, the value will be zero. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AcsCapabilityRegister, 32); + +// +// This property indicates the capability for ATS support on this device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AtsSupport, 33); + +// +// This property indicates if this device requires Iommu Reserved Memory Region. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_RequiresReservedMemoryRegion, 34); + +// +// This property indicates if this device supports atomics. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_AtomicsSupported, 35); + +// +// This property contains bitmask of the supported ASPM and PM link sub states. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_SupportedLinkSubState, 36); + +// +// This property indicates whether this device is on POST path. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_OnPostPath, 37); + +// +// This property contains bitmask of the D3.cold state and reason for that state. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_D3ColdSupport, 38); + +// +// This property contains the virtual channel resource control registers. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_VirtualChannelControlRegisters, 39); + +// +// This property contains the PCI serial number. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_SerialNumber, 40); + +// +// This property contains the port type that is read from the USB4 DVSEC Capability. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_UsbDvsecPortType, 41); + +// +// This property contains the port specific attributes read from the USB4 DVSEC Capability. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_UsbDvsecPortSpecificAttributes, 42); + +// +// This property contains a boolean to indicate whether or not a tunneled +// USB4 port uses component relation +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_UsbComponentRelation, 43); + +// +// This property contains the host router name that this device +// is mapped to. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_UsbHostRouterName, 44); + +// +// This property contains the serial number of the +// parent device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_ParentSerialNumber, 45); + +// +// This property contains a boolean to indicate whether the device +// supports DMWr along the entire device tree from the root to the device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_SupportsDmwrOnEntireDeviceTree, 46); + +// +// This property contains a boolean to indicate whether the device +// is a tunneled device. +// + +DEFINE_PCI_DEVICE_DEVPKEY(DEVPKEY_PciDevice_IsTunneledDevice, 47); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poclass.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poclass.h new file mode 100644 index 0000000000000000000000000000000000000000..a93eb437f10315a0a2eac8fe197023ca2c1e8848 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poclass.h @@ -0,0 +1,834 @@ +/*++ BUILD Version: 0001 // Increment this if a change has global effects + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + poclass.h + +Abstract: + + Defines power policy device driver interfaces. + + + +Revision History: + +--*/ + +// +// GUIDs are defined outside ifdef __POCLASS_ so that they can be instantiated +// easily using . +// + +// +// Custom device properties... +// + +#include +#include + +// +// This is of type DEVPROP_TYPE_UINT32 and represents the NT processor +// number. +// + +DEFINE_DEVPROPKEY(PROCESSOR_NUMBER_PKEY, + 0x5724c81d, + 0xd5af, + 0x4c1f, + 0xa1, 0x03, 0xa0, 0x6e, 0x28, 0xf2, 0x04, 0xc6, + 1); + +// +// Power management policy device GUIDs +// + +DEFINE_GUID( GUID_DEVICE_BATTERY, 0x72631e54L, 0x78A4, 0x11d0, 0xbc, 0xf7, 0x00, 0xaa, 0x00, 0xb7, 0xb3, 0x2a ); +DEFINE_GUID( GUID_DEVICE_APPLICATIONLAUNCH_BUTTON, 0x629758eel, 0x986e, 0x4d9e, 0x8e, 0x47, 0xde, 0x27, 0xf8, 0xab, 0x05, 0x4d ); +DEFINE_GUID( GUID_DEVICE_SYS_BUTTON, 0x4AFA3D53L, 0x74A7, 0x11d0, 0xbe, 0x5e, 0x00, 0xA0, 0xC9, 0x06, 0x28, 0x57 ); +DEFINE_GUID( GUID_DEVICE_LID, 0x4AFA3D52L, 0x74A7, 0x11d0, 0xbe, 0x5e, 0x00, 0xA0, 0xC9, 0x06, 0x28, 0x57 ); +DEFINE_GUID( GUID_DEVICE_THERMAL_ZONE, 0x4AFA3D51L, 0x74A7, 0x11d0, 0xbe, 0x5e, 0x00, 0xA0, 0xC9, 0x06, 0x28, 0x57 ); +DEFINE_GUID( GUID_DEVICE_FAN, 0x05ecd13dL, 0x81da, 0x4a2a, 0x8a, 0x4c, 0x52, 0x4f, 0x23, 0xdd, 0x4d, 0xc9 ); +DEFINE_GUID( GUID_DEVICE_PROCESSOR, 0x97fadb10L, 0x4e33, 0x40ae, 0x35, 0x9c, 0x8b, 0xef, 0x02, 0x9d, 0xbd, 0xd0 ); +DEFINE_GUID( GUID_DEVICE_MEMORY, 0x3fd0f03dL, 0x92e0, 0x45fb, 0xb7, 0x5c, 0x5e, 0xd8, 0xff, 0xb0, 0x10, 0x21 ); +DEFINE_GUID( GUID_DEVICE_ACPI_TIME, 0x97f99bf6L, 0x4497, 0x4f18, 0xbb, 0x22, 0x4b, 0x9f, 0xb2, 0xfb, 0xef, 0x9c ); +DEFINE_GUID( GUID_DEVICE_MESSAGE_INDICATOR, 0XCD48A365L, 0xfa94, 0x4ce2, 0xa2, 0x32, 0xa1, 0xb7, 0x64, 0xe5, 0xd8, 0xb4 ); +DEFINE_GUID( GUID_DEVICE_POWER_ADAPTER, 0xf76c6c62L, 0x7dea, 0x43cd, 0x86, 0x89, 0xd9, 0xa4, 0xaf, 0x3d, 0x85, 0x57 ); + +// copied from hidclass.h +DEFINE_GUID( GUID_CLASS_INPUT, 0x4D1E55B2L, 0xF16F, 0x11CF, 0x88, 0xCB, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30 ); + +// {DBE4373D-3C81-40cb-ACE4-E0E5D05F0C9F} +DEFINE_GUID(GUID_DEVINTERFACE_THERMAL_COOLING, +0xdbe4373d, 0x3c81, 0x40cb, 0xac, 0xe4, 0xe0, 0xe5, 0xd0, 0x5f, 0xc, 0x9f); + +// {927EC093-69A4-4bc0-BD02-711664714463} +DEFINE_GUID(GUID_DEVINTERFACE_THERMAL_MANAGER, +0x927ec093, 0x69a4, 0x4bc0, 0xbd, 0x2, 0x71, 0x16, 0x64, 0x71, 0x44, 0x63); + +// {8f366301-091e-4056-b92f-958b27625fce} +DEFINE_GUID(GUID_DEVINTERFACE_POWER_LIMIT, +0x8f366301, 0x091e, 0x4056, 0xb9, 0x2f, 0x95, 0x8b, 0x27, 0x62, 0x5f, 0xce); + +// {2a6c8538-7895-4d56-8567-795d3844858a} +DEFINE_GUID(GUID_DEVINTERFACE_TEMPERATURE_SENSOR, +0x2a6c8538, 0x7895, 0x4d56, 0x85, 0x67, 0x79, 0x5d, 0x38, 0x44, 0x85, 0x8a); + +// {2ed8544a-8eef-4033-b2a0-04aaa507cecb} +DEFINE_GUID(GUID_DEVINTERFACE_CUSTOMIZED_IO, +0x2ed8544a, 0x8eef, 0x4033, 0xb2, 0xa0, 0x04, 0xaa, 0xa5, 0x07, 0xce, 0xcb); + +#ifndef _POCLASS_ +#define _POCLASS_ + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// Battery driver interface (devices of registrying as GUID_DEVICE_BATTERY) +// + +typedef enum { + BatteryInformation, + BatteryGranularityInformation, + BatteryTemperature, + BatteryEstimatedTime, + BatteryDeviceName, + BatteryManufactureDate, + BatteryManufactureName, + BatteryUniqueID, + BatterySerialNumber +} BATTERY_QUERY_INFORMATION_LEVEL; + +typedef struct _BATTERY_QUERY_INFORMATION { + ULONG BatteryTag; + BATTERY_QUERY_INFORMATION_LEVEL InformationLevel; + ULONG AtRate; +} BATTERY_QUERY_INFORMATION, *PBATTERY_QUERY_INFORMATION; + +typedef struct _BATTERY_INFORMATION { + ULONG Capabilities; + UCHAR Technology; + UCHAR Reserved[3]; + UCHAR Chemistry[4]; + ULONG DesignedCapacity; + ULONG FullChargedCapacity; + ULONG DefaultAlert1; + ULONG DefaultAlert2; + ULONG CriticalBias; + ULONG CycleCount; +} BATTERY_INFORMATION, *PBATTERY_INFORMATION; + +// BATTERY_INFORMATION.*Capacity constants +#define BATTERY_UNKNOWN_CAPACITY 0xFFFFFFFF +#define UNKNOWN_CAPACITY BATTERY_UNKNOWN_CAPACITY + +// BATTERY_INFORMATION.Capabilities flags +#define BATTERY_SYSTEM_BATTERY 0x80000000 +#define BATTERY_CAPACITY_RELATIVE 0x40000000 +#define BATTERY_IS_SHORT_TERM 0x20000000 +#define BATTERY_SEALED 0x10000000 +#define BATTERY_SET_CHARGE_SUPPORTED 0x00000001 +#define BATTERY_SET_DISCHARGE_SUPPORTED 0x00000002 +#define BATTERY_SET_CHARGINGSOURCE_SUPPORTED 0x00000004 +#define BATTERY_SET_CHARGER_ID_SUPPORTED 0x00000008 + +// +// BatteryEstimatedTime constant +// +#define BATTERY_UNKNOWN_TIME 0xFFFFFFFF + +#define BATTERY_UNKNOWN_CURRENT 0xFFFFFFFF +#define UNKNOWN_CURRENT BATTERY_UNKNOWN_CURRENT + +// AC type explicitly set to maintain backwards compatibility +// (the previous enum member BatteryChargingSourceType_None was removed). +typedef enum _BATTERY_CHARGING_SOURCE_TYPE { + BatteryChargingSourceType_AC = 1, + BatteryChargingSourceType_USB, + BatteryChargingSourceType_Wireless, + BatteryChargingSourceType_Max +} BATTERY_CHARGING_SOURCE_TYPE, *PBATTERY_CHARGING_SOURCE_TYPE; + +typedef struct _BATTERY_CHARGING_SOURCE { + BATTERY_CHARGING_SOURCE_TYPE Type; + ULONG MaxCurrent; +} BATTERY_CHARGING_SOURCE, *PBATTERY_CHARGING_SOURCE; + +typedef GUID BATTERY_CHARGER_ID, *PBATTERY_CHARGER_ID; + +// New structure for Windows Phone specific feature: Source Change Notification. +typedef struct _BATTERY_CHARGING_SOURCE_INFORMATION { + BATTERY_CHARGING_SOURCE_TYPE Type; + BOOLEAN SourceOnline; +} BATTERY_CHARGING_SOURCE_INFORMATION, *PBATTERY_CHARGING_SOURCE_INFORMATION; + +// +// Physical USB port types. +// + +typedef enum _USB_CHARGER_PORT +{ + UsbChargerPort_Legacy, + UsbChargerPort_TypeC, + UsbChargerPort_Max +} USB_CHARGER_PORT, *PUSB_CHARGER_PORT; + +// +// IOCTL_BATTERY_SET_INFORMATION information levels +// + +typedef enum { + BatteryCriticalBias, + BatteryCharge, + BatteryDischarge, + BatteryChargingSource, + BatteryChargerId, + BatteryChargerStatus +} BATTERY_SET_INFORMATION_LEVEL; + +// +// Generic Payload for IOCTL_BATTERY_SET_INFORMATION. +// + +typedef struct _BATTERY_SET_INFORMATION { + ULONG BatteryTag; + BATTERY_SET_INFORMATION_LEVEL InformationLevel; + UCHAR Buffer[1]; +} BATTERY_SET_INFORMATION, *PBATTERY_SET_INFORMATION; + +// +// Payload for IOCTL_BATTERY_SET_INFORMATION information level +// BatteryChargerStatus. +// +// CAD uses this structure to identify charger source properties to the Battery. +// + +typedef struct _BATTERY_CHARGER_STATUS +{ + // + // Identifies the charger type. + // + + BATTERY_CHARGING_SOURCE_TYPE Type; + + // + // Start of variable data area. Data contained here will be specific to + // charging source type identified by Type. + // + + ULONG VaData[1]; + +} BATTERY_CHARGER_STATUS, *PBATTERY_CHARGER_STATUS; + +// +// Payload for IOCTL_BATTERY_SET_INFORMATION/BatteryChargerStatus (CAD->Battery) +// when Type is set to BatteryChargingSourceType_USB. +// +// CAD uses this structure to identify charger source properties to the Battery. +// + +typedef struct _BATTERY_USB_CHARGER_STATUS +{ + // + // Identifies the charger type. + // This value will be set to BatteryChargingSourceType_USB. + // + + BATTERY_CHARGING_SOURCE_TYPE Type; + + // + // Should not be interpreted by BM. + // + + ULONG Reserved; + + // + // Flags. + // + + ULONG Flags; + + // + // Indicates maximum current that can be drawn from this charging port in mA. + // Note that this value may be zero when OemCharger value is not GUID_EMPTY, + // in such case zero should be interpreted as unknown value. + // + + ULONG MaxCurrent; + + // + // Indicates constant voltage available on the charger terminal in mV. + // Note that this value may be zero when OemCharger value is not GUID_EMPTY, + // in such case zero should be interpreted as unknown value. + // + + ULONG Voltage; + + // + // USB Port Type. + // + + USB_CHARGER_PORT PortType; + + // + // Identifies a particular USB port on the system. + // When set to 0 indicates that port information is unavailable. + // + + ULONGLONG PortId; + + // + // Power source specific information: + // + // Type | PowerSourceInformation + // -------------------------------|----------------------- + // BatteryChargingSourceType_USB | USBFN_PORT_TYPE + // | + // + // N.B. On 64-bit systems, the high order 32-bits are always reset and must + // be unused. In other words, this value must not exceed 0xffffffff. + // This is to ensure semantic compatibility with 32-bit applications on + // 64-bit systems. + // + + PVOID PowerSourceInformation; + + // + // Represents OEM proprietary charger type when not GUID_EMPTY, this value is + // passed from charging port uninterpreted by CAD. + // + + BATTERY_CHARGER_ID OemCharger; + +} BATTERY_USB_CHARGER_STATUS, *PBATTERY_USB_CHARGER_STATUS; + +// +// BATTERY_USB_CHARGER_STATUS.Flags field. +// Indicates Type-C port running in the Default USB mode. +// +#define BATTERY_USB_CHARGER_STATUS_FN_DEFAULT_USB 0x00000001 + +// +// BATTERY_USB_CHARGER_STATUS.Flags field. +// Indicates Type-C port has established an explicit contract of Power Delivery with the port partner. +// +#define BATTERY_USB_CHARGER_STATUS_UCM_PD 0x00000002 + + +typedef struct _BATTERY_WAIT_STATUS { + ULONG BatteryTag; + ULONG Timeout; + ULONG PowerState; + ULONG LowCapacity; + ULONG HighCapacity; +} BATTERY_WAIT_STATUS, *PBATTERY_WAIT_STATUS; + +typedef struct _BATTERY_STATUS { + ULONG PowerState; + ULONG Capacity; + ULONG Voltage; + LONG Rate; +} BATTERY_STATUS, *PBATTERY_STATUS; + +typedef union _POWER_ADAPTER_POWER_STATES { + struct { + ULONG Online : 1; + ULONG RecState : 2; + ULONG Reserved : 29; + } States; + + ULONG AsUlong; +} POWER_ADAPTER_POWER_STATES, *PPOWER_ADAPTER_POWER_STATES; + +typedef struct _POWER_ADAPTER_STATUS { + UCHAR Version; + UCHAR Reserved[3]; + POWER_ADAPTER_POWER_STATES PowerState; + + // + // All power members are in mW. + // + + ULONG PeakPower; + ULONG MaxOutputPower; + ULONG MaxInputPower; + ULONG64 RecStartTime; + ULONG64 RecEndTime; +} POWER_ADAPTER_STATUS, *PPOWER_ADAPTER_STATUS; + +#define POWER_ADAPTER_REC_TIME_NOT_AVAILABLE 0xFFFFFFFFFFFFFFFFULL + +typedef struct _POWER_ADAPTER_SET_STATUS_BUFFER { + UCHAR Version; + BOOLEAN RecOverride; + UCHAR Reserved[2]; +} POWER_ADAPTER_SET_STATUS_BUFFER, *PPOWER_ADAPTER_SET_STATUS_BUFFER; + +// +// Power adapter charge requirements. +// - Type: 1 for USB-C, 0 for others. +// - If an adapter that delivers less than MinimumPower it will not charge the device. +// - If between MinimumPower and NominalPower will charge slowly. +// - MaximumPower should always charge the device. +// - MinimumPower, NominalPower and MinimumPower should be in mW. +// + +typedef struct _POWER_ADAPTER_CHARGE_REQUIREMENT { + ULONG AcAdapterType; + ULONG MinimumPower; + ULONG NominalPower; + ULONG MaximumPower; +} POWER_ADAPTER_CHARGE_REQUIREMENT, *PPOWER_ADAPTER_CHARGE_REQUIREMENT; + +// Battery Status Constants +#define BATTERY_UNKNOWN_VOLTAGE 0xFFFFFFFF +#define BATTERY_UNKNOWN_RATE 0x80000000 +#define UNKNOWN_RATE BATTERY_UNKNOWN_RATE +#define UNKNOWN_VOLTAGE BATTERY_UNKNOWN_VOLTAGE + +// PowerState flags +#define BATTERY_POWER_ON_LINE 0x00000001 +#define BATTERY_DISCHARGING 0x00000002 +#define BATTERY_CHARGING 0x00000004 +#define BATTERY_CRITICAL 0x00000008 + +// Max battery driver BATTERY_QUERY_INFORMATION_LEVEL string storage +// size in bytes. +#define MAX_BATTERY_STRING_SIZE 128 + +// Struct for accessing the packed date format in BatteryManufactureDate. +typedef struct _BATTERY_MANUFACTURE_DATE +{ + UCHAR Day; + UCHAR Month; + USHORT Year; +} BATTERY_MANUFACTURE_DATE, *PBATTERY_MANUFACTURE_DATE; + +// battery + +#define IOCTL_BATTERY_QUERY_TAG \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x10, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_BATTERY_QUERY_INFORMATION \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x11, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_BATTERY_SET_INFORMATION \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x12, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_BATTERY_QUERY_STATUS \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x13, METHOD_BUFFERED, FILE_READ_ACCESS) + +// New ioctl for Windows Phone specific feature: Source Change Notificaton. +#define IOCTL_BATTERY_CHARGING_SOURCE_CHANGE \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x14, METHOD_BUFFERED, FILE_READ_ACCESS) + + +#define BATTERY_TAG_INVALID 0 + +// +// Customized I/O +// + +#define IOCTL_QUERY_CUSTOMIZED_IO_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_BATTERY, 0xA0, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_QUERY_CUSTOMIZED_INPUT_FROM_PLATFORM \ + CTL_CODE(FILE_DEVICE_BATTERY, 0xA1, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_SEND_CUSTOMIZED_OUTPUT_TO_PLATFORM \ + CTL_CODE(FILE_DEVICE_BATTERY, 0xA2, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +typedef struct _CUSTOMIZED_IO_CAPABILITIES { + ULONG SupportedInputs; + ULONG SupportedOutputs; +} CUSTOMIZED_IO_CAPABILITIES, *PCUSTOMIZED_IO_CAPABILITIES; + +typedef struct _CUSTOMIZED_IO_QUERY_INPUT_RETURN { + ULONG FunctionId; + ULONG ErrorCode; + ULONG Value; +} CUSTOMIZED_IO_QUERY_INPUT_RETURN, *PCUSTOMIZED_IO_QUERY_INPUT_RETURN; + +typedef struct _CUSTOMIZED_IO_SEND_OUTPUT_BUFFER { + ULONG FunctionId; + ULONG Value; +} CUSTOMIZED_IO_SEND_OUTPUT_BUFFER, *PCUSTOMIZED_IO_SEND_OUTPUT_BUFFER; + +// +// Thermal Zone driver interface (devices of registrying as GUID_DEVICE_THERMAL_ZONE) +// + +#define MAX_ACTIVE_COOLING_LEVELS 10 + +// +// This structure has been depricated and the THERMAL_INFORMATION_EX +// structure should be used. THERMAL_INFORMATION has been left here for +// backward compatibility with the thermal WMI interface. +// +typedef struct _THERMAL_INFORMATION { + ULONG ThermalStamp; + ULONG ThermalConstant1; + ULONG ThermalConstant2; + KAFFINITY Processors; + ULONG SamplingPeriod; + ULONG CurrentTemperature; + ULONG PassiveTripPoint; + ULONG CriticalTripPoint; + UCHAR ActiveTripPointCount; + ULONG ActiveTripPoint[MAX_ACTIVE_COOLING_LEVELS]; +} THERMAL_INFORMATION, *PTHERMAL_INFORMATION; + +#define ACTIVE_COOLING 0x0 +#define PASSIVE_COOLING 0x1 + +typedef struct _THERMAL_WAIT_READ { + ULONG Timeout; + ULONG LowTemperature; + ULONG HighTemperature; +} THERMAL_WAIT_READ, *PTHERMAL_WAIT_READ; + +#define THERMAL_WAIT_READ_TIMEOUT_IMMEDIATE 0 +#define THERMAL_WAIT_READ_TIMEOUT_NONE 0xFFFFFFFFul + +#define TZ_ACTIVATION_REASON_THERMAL 0x00000001 +#define TZ_ACTIVATION_REASON_CURRENT 0x00000002 + +typedef struct _THERMAL_POLICY { + ULONG Version; + BOOLEAN WaitForUpdate; + BOOLEAN Hibernate; + BOOLEAN Critical; + BOOLEAN ThermalStandby; + ULONG ActivationReasons; + ULONG PassiveLimit; + ULONG ActiveLevel; + BOOLEAN OverThrottled; +} THERMAL_POLICY, *PTHERMAL_POLICY; + +#define THERMAL_POLICY_VERSION_1 1 +#define THERMAL_POLICY_VERSION_2 2 + +// thermal + +#define IOCTL_THERMAL_QUERY_INFORMATION \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x20, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_THERMAL_SET_COOLING_POLICY\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x21, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_RUN_ACTIVE_COOLING_METHOD\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x22, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_THERMAL_SET_PASSIVE_LIMIT\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x23, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_THERMAL_READ_TEMPERATURE\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x24, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_THERMAL_READ_POLICY\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x25, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// Lid class driver functions +// + +#define IOCTL_QUERY_LID\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x30, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// Switch class driver functions +// + +#define IOCTL_NOTIFY_SWITCH_EVENT\ + CTL_CODE(FILE_DEVICE_BATTERY, 0x40, METHOD_BUFFERED, FILE_READ_ACCESS) + +// +// System button class driver functions +// + +#define IOCTL_GET_SYS_BUTTON_CAPS \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x50, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define IOCTL_GET_SYS_BUTTON_EVENT \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x51, METHOD_BUFFERED, FILE_READ_ACCESS) + +#define SYS_BUTTON_POWER 0x00000001 +#define SYS_BUTTON_SLEEP 0x00000002 +#define SYS_BUTTON_LID 0x00000004 +#define SYS_BUTTON_WAKE 0x80000000 + +// +// Lid-specific state embedded in the button event irp. +// + +#define SYS_BUTTON_LID_STATE_MASK 0x00030000 +#define SYS_BUTTON_LID_OPEN 0x00010000 +#define SYS_BUTTON_LID_CLOSED 0x00020000 +#define SYS_BUTTON_LID_INITIAL 0x00040000 +#define SYS_BUTTON_LID_CHANGED 0x00080000 + +// +// Processor object class driver functions +// + +typedef struct { + ULONG PhysicalID; + ULONG PBlkAddress; + UCHAR PBlkLength; +} PROCESSOR_OBJECT_INFO, *PPROCESSOR_OBJECT_INFO; + +typedef struct { + ULONG PhysicalID; + ULONG PBlkAddress; + UCHAR PBlkLength; + ULONG InitialApicId; +} PROCESSOR_OBJECT_INFO_EX, *PPROCESSOR_OBJECT_INFO_EX; + + + +#define IOCTL_GET_PROCESSOR_OBJ_INFO \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x60, METHOD_BUFFERED, FILE_READ_ACCESS) + + +#ifndef _WINDOWS_ + +// +// Thermal client interface (devices implementing +// GUID_THERMAL_COOLING_INTERFACE) +// + +typedef +_Function_class_(DEVICE_ACTIVE_COOLING) +VOID +DEVICE_ACTIVE_COOLING ( + _Inout_opt_ PVOID Context, + _In_ BOOLEAN Engaged + ); + +typedef DEVICE_ACTIVE_COOLING *PDEVICE_ACTIVE_COOLING; + +typedef +_Function_class_(DEVICE_PASSIVE_COOLING) +VOID +DEVICE_PASSIVE_COOLING ( + _Inout_opt_ PVOID Context, + _In_ ULONG Percentage + ); + +typedef DEVICE_PASSIVE_COOLING *PDEVICE_PASSIVE_COOLING; + +typedef struct _THERMAL_COOLING_INTERFACE { + + // + // generic interface header + // + + USHORT Size; + USHORT Version; + PVOID Context; + PINTERFACE_REFERENCE InterfaceReference; + PINTERFACE_DEREFERENCE InterfaceDereference; + + // + // Thermal cooling interface + // + + ULONG Flags; + PDEVICE_ACTIVE_COOLING ActiveCooling; + PDEVICE_PASSIVE_COOLING PassiveCooling; + +} THERMAL_COOLING_INTERFACE, *PTHERMAL_COOLING_INTERFACE; + + +#define THERMAL_COOLING_INTERFACE_VERSION 1 + +// +// The following THERMAL_DEVICE_* definitions are deprecated and should not be +// used. Use THERMAL_COOLING_* instead. +// + +#define THERMAL_DEVICE_INTERFACE_VERSION 1 + +typedef THERMAL_COOLING_INTERFACE THERMAL_DEVICE_INTERFACE; +typedef THERMAL_COOLING_INTERFACE *PTHERMAL_DEVICE_INTERFACE; + +typedef enum _THERMAL_DEVICE_INTERFACE_FLAGS { + ThermalDeviceFlagActiveCooling = 1, + ThermalDeviceFlagPassiveCooling = 2 +} THERMAL_DEVICE_INTERFACE_FLAGS, *PTHERMAL_DEVICE_INTERFACE_FLAGS; + +// +// Power limit types. +// + +typedef +_Function_class_(QUERY_POWER_LIMIT_ATTRIBUTES) +NTSTATUS +QUERY_POWER_LIMIT_ATTRIBUTES ( + _Inout_opt_ PVOID Context, + _In_ ULONG BufferCount, + _Inout_opt_ PVOID Buffer, + _Out_ PULONG AttributeCount + ); + +typedef QUERY_POWER_LIMIT_ATTRIBUTES *PQUERY_POWER_LIMIT_ATTRIBUTES; + +typedef +_Function_class_(SET_POWER_LIMIT) +NTSTATUS +SET_POWER_LIMIT ( + _Inout_opt_ PVOID Context, + _In_ ULONG ValueCount, + _In_ PVOID Values + ); + +typedef SET_POWER_LIMIT *PSET_POWER_LIMIT; + +typedef +_Function_class_(QUERY_POWER_LIMIT) +NTSTATUS +QUERY_POWER_LIMIT ( + _Inout_opt_ PVOID Context, + _In_ ULONG ValueCount, + _Inout_ PVOID Values + ); + +typedef QUERY_POWER_LIMIT *PQUERY_POWER_LIMIT; + +// +// Power limit client interface (devices implementing GUID_POWER_LIMIT_INTERFACE) +// + +typedef struct _POWER_LIMIT_INTERFACE { + + // + // Generic interface header + // + + USHORT Size; + USHORT Version; + PVOID Context; + PINTERFACE_REFERENCE InterfaceReference; + PINTERFACE_DEREFERENCE InterfaceDereference; + + // + // Power limit interface + // + + ULONG DomainCount; + PQUERY_POWER_LIMIT_ATTRIBUTES QueryAttributes; + PSET_POWER_LIMIT SetPowerLimit; + PQUERY_POWER_LIMIT QueryPowerLimit; +} POWER_LIMIT_INTERFACE, *PPOWER_LIMIT_INTERFACE; + +#define POWER_LIMIT_INTERFACE_VERSION 1 + +#endif // _WINDOWS_ + +// +// Message indicator class driver functions +// +#define IOCTL_SET_SYS_MESSAGE_INDICATOR \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x70, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +// +// ACPI Time device functions +// +#define IOCTL_SET_WAKE_ALARM_VALUE \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x80, METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_SET_WAKE_ALARM_POLICY \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x81, METHOD_BUFFERED, FILE_WRITE_ACCESS) +#define IOCTL_GET_WAKE_ALARM_VALUE \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x82, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +#define IOCTL_GET_WAKE_ALARM_POLICY \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x83, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +typedef struct _WAKE_ALARM_INFORMATION { + + // + // Timer type, IN. + // 0x00000000 - AC Timer + // 0x00000001 - DC Timer + // + + ULONG TimerIdentifier; + + // + // Timeout value, IN for SET functions, OUT for GET functions + // Values 0x00000000 to 0xfffffffe represent the timeout in seconds. + // 0xffffffff disables a timer or indicates a timer countdown completion. + // + + ULONG Timeout; + +} WAKE_ALARM_INFORMATION, *PWAKE_ALARM_INFORMATION; + +// +// ACPI Real Time Clock functions +// + +#define ACPI_TIME_ADJUST_DAYLIGHT 0x01 +#define ACPI_TIME_IN_DAYLIGHT 0x02 +#define ACPI_TIME_ZONE_UNKNOWN 0x7FF + +#define IOCTL_ACPI_GET_REAL_TIME \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x84, METHOD_BUFFERED, FILE_READ_DATA) + +#define IOCTL_ACPI_SET_REAL_TIME \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x85, METHOD_BUFFERED, FILE_WRITE_ACCESS) + +#define IOCTL_GET_WAKE_ALARM_SYSTEM_POWERSTATE \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x86, METHOD_BUFFERED, FILE_READ_DATA) + +typedef struct _ACPI_REAL_TIME { + UINT16 Year; // Year : 2010 - 9999 + UINT8 Month; // Month : 1 - 12 + UINT8 Day; // Day : 1 - 31 + UINT8 Hour; // Hour : 0 - 23 + UINT8 Minute; // Minute : 0 - 59 + UINT8 Second; // Second : 0 - 59 + UINT8 Valid; // 0 - Time is not valid (request failed); 1 - Time is valid + UINT16 Milliseconds; // Milliseconds : 1-1000 + INT16 TimeZone; // TimeZone : -1440 to 1440 or 2047 + UINT8 DayLight; // DayLight : 0-1 + UINT8 Reserved1[3]; // Reserved: Must be 0 +} ACPI_REAL_TIME, *PACPI_REAL_TIME; + +// +// ACPI Time and Alarm Device Capabilities +// + +#define IOCTL_GET_ACPI_TIME_AND_ALARM_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_BATTERY, 0x87, METHOD_BUFFERED, FILE_READ_ACCESS) + +typedef enum _ACPI_TIME_RESOLUTION { + AcpiTimeResolutionMilliseconds = 0, + AcpiTimeResolutionSeconds, + AcpiTimeResolutionMax +} ACPI_TIME_RESOLUTION, *PACPI_TIME_RESOLUTION; + +typedef struct _ACPI_TIME_AND_ALARM_CAPABILITIES { + BOOLEAN AcWakeSupported; + BOOLEAN DcWakeSupported; + + BOOLEAN S4AcWakeSupported; + BOOLEAN S4DcWakeSupported; + + BOOLEAN S5AcWakeSupported; + BOOLEAN S5DcWakeSupported; + + BOOLEAN S4S5WakeStatusSupported; + + ULONG DeepestWakeSystemState; + + BOOLEAN RealTimeFeaturesSupported; + ACPI_TIME_RESOLUTION RealTimeResolution; +} ACPI_TIME_AND_ALARM_CAPABILITIES, *PACPI_TIME_AND_ALARM_CAPABILITIES; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // _POCLASS_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poppack.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poppack.h new file mode 100644 index 0000000000000000000000000000000000000000..5304463d0193c43b69e347bdb3daf4b9125ab451 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/poppack.h @@ -0,0 +1,36 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + poppack.h + +Abstract: + + This file turns packing of structures off. (That is, it enables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. + + poppack.h is the complement to pshpack?.h. An inclusion of poppack.h + MUST ALWAYS be preceded by an inclusion of one of pshpack?.h, in one-to-one + correspondence. + + For Microsoft compatible compilers, this file uses the pop option + to the pack pragma so that it can restore the previous saved by the + pshpack?.h include file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 && !defined(_M_I86)) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(pop) +#else +#pragma pack() +#endif +#else +#pragma pack() +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack1.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack1.h new file mode 100644 index 0000000000000000000000000000000000000000..0fb65dae145dd975baafe6fbadbdb38e71d98281 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack1.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pshpack1.h + +Abstract: + + This file turns 1 byte packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. For Microsoft + compatible compilers, this files uses the push option to the pack pragma + so that the poppack.h include file can restore the previous packing + reliably. + + The file poppack.h is the complement to this file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 && !defined(_M_I86)) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(push,1) +#else +#pragma pack(1) +#endif +#else +#pragma pack(1) +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack2.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack2.h new file mode 100644 index 0000000000000000000000000000000000000000..3c98fcdd79e8f9fffc08adabf128c74dd79981a2 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack2.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pshpack2.h + +Abstract: + + This file turns 2 byte packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. For Microsoft + compatible compilers, this files uses the push option to the pack pragma + so that the poppack.h include file can restore the previous packing + reliably. + + The file poppack.h is the complement to this file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 && !defined(_M_I86)) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(push,2) +#else +#pragma pack(2) +#endif +#else +#pragma pack(2) +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack4.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack4.h new file mode 100644 index 0000000000000000000000000000000000000000..34a8f41764850c1dd67e721d11931b32c59ad93d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack4.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pshpack4.h + +Abstract: + + This file turns 4 byte packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. For Microsoft + compatible compilers, this files uses the push option to the pack pragma + so that the poppack.h include file can restore the previous packing + reliably. + + The file poppack.h is the complement to this file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 && !defined(_M_I86)) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(push,4) +#else +#pragma pack(4) +#endif +#else +#pragma pack(4) +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack8.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack8.h new file mode 100644 index 0000000000000000000000000000000000000000..b3327b0e342fe50337a003433c2399706c9253ad --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpack8.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pshpack8.h + +Abstract: + + This file turns 8 byte packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. For Microsoft + compatible compilers, this files uses the push option to the pack pragma + so that the poppack.h include file can restore the previous packing + reliably. + + The file poppack.h is the complement to this file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 && !defined(_M_I86)) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(push,8) +#else +#pragma pack(8) +#endif +#else +#pragma pack(8) +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpck16.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpck16.h new file mode 100644 index 0000000000000000000000000000000000000000..1c910c85099d9a7fc59563a37071438b26ce66b2 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pshpck16.h @@ -0,0 +1,33 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pshpack8.h + +Abstract: + + This file turns 8 byte packing of structures on. (That is, it disables + automatic alignment of structure fields.) An include file is needed + because various compilers do this in different ways. For Microsoft + compatible compilers, this files uses the push option to the pack pragma + so that the poppack.h include file can restore the previous packing + reliably. + + The file poppack.h is the complement to this file. + +--*/ + +#if ! (defined(lint) || defined(RC_INVOKED)) +#if ( _MSC_VER >= 800 ) || defined(_PUSHPOP_SUPPORTED) +#pragma warning(disable:4103) +#if !(defined( MIDL_PASS )) || defined( __midl ) +#pragma pack(push,16) +#else +#pragma pack(16) +#endif +#else +#pragma pack(16) +#endif +#endif /* ! (defined(lint) || defined(RC_INVOKED)) */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pwm.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pwm.h new file mode 100644 index 0000000000000000000000000000000000000000..7aae697d92999cc09c72e1f87538642c98389fcc --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/pwm.h @@ -0,0 +1,253 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + pwm.h + +Abstract: + + This module contains the Pulse Width Modulator (PWM) IOCTL interface for + use by client applications and kernel-mode drivers. + +Environment: + + Kernel-mode and user-mode. + +--*/ + +#include + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN10) + +#ifdef _MSC_VER +#pragma once +#endif //_MSC_VER + +#ifdef __cplusplus +extern "C" { +#endif // __cplusplus + +// +// IOCTL codes enumeration +// +enum { + // Controller IOCTLs + PWM_IOCTL_ID_CONTROLLER_GET_INFO = 0, + PWM_IOCTL_ID_CONTROLLER_GET_ACTUAL_PERIOD, + PWM_IOCTL_ID_CONTROLLER_SET_DESIRED_PERIOD, + + // Pin IOCTLs + PWM_IOCTL_ID_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE= 100, + PWM_IOCTL_ID_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE, + PWM_IOCTL_ID_PIN_GET_POLARITY, + PWM_IOCTL_ID_PIN_SET_POLARITY, + PWM_IOCTL_ID_PIN_START, + PWM_IOCTL_ID_PIN_STOP, + PWM_IOCTL_ID_PIN_IS_STARTED +}; + +// +// PWM Device Interface GUID +// +DEFINE_GUID(GUID_DEVINTERFACE_PWM_CONTROLLER, + 0x60824b4c, 0xeed1, 0x4c9c, 0xb4, 0x9c, 0x1b, 0x96, 0x14, 0x61, 0xa8, 0x19); +#define GUID_DEVINTERFACE_PWM_CONTROLLER_WSZ L"{60824B4C-EED1-4C9C-B49C-1B961461A819}" + +// +// PWM wave period in picoseconds, where 1 picosecond is the period of a wave with +// frequency equals to 1 Terahertz(THz). +// +typedef ULONGLONG PWM_PERIOD; + +// +// PWM duty cycle percentage is represented as a 64-bit integer in the range +// 0 to PMW_PERCENTAGE_MAX inclusive where Percentage / PMW_PERCENTAGE_MAX is a +// floating-point number in the range 0.0 and 1.0 inclusive. +// Example: A percentage value of 25% (0.25) can be represented as +// (0.25 * ULONGLONG_MAX) which equals 9223372036854775807 and a percentage +// value of 40.25% (0.4025) can be represented as (0.4025 * ULONGLONG_MAX). +// +// To convert from PWM_PERCENTAGE to floating-point value divide by PWM_PERCENTAGE_MAX. +// To convert from floating-point to PWM_PERCENTAGE value multiply by PWM_PERCENTAGE_MAX. +// +typedef ULONGLONG PWM_PERCENTAGE; + +#define PWM_PERCENTAGE_MAX ULONGLONG_MAX + +// +// PWM_CONTROLLER_INFO struct is versioned by its byte size including the Size +// field. +// +typedef struct _PWM_CONTROLLER_INFO { + + // + // Info size - must be set to sizeof(PWM_CONTROLLER_INFO) + // + _Field_range_(==, sizeof(PWM_CONTROLLER_INFO)) + SIZE_T Size; + + ULONG PinCount; + PWM_PERIOD MinimumPeriod; + PWM_PERIOD MaximumPeriod; +} PWM_CONTROLLER_INFO; + +// +// IOCTL_PWM_CONTROLLER_GET_INFO +// + +#define IOCTL_PWM_CONTROLLER_GET_INFO \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_CONTROLLER_GET_INFO, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef PWM_CONTROLLER_INFO PWM_CONTROLLER_GET_INFO_OUTPUT; + +// +// IOCTL_PWM_CONTROLLER_GET_ACTUAL_PERIOD +// + +#define IOCTL_PWM_CONTROLLER_GET_ACTUAL_PERIOD \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_CONTROLLER_GET_ACTUAL_PERIOD, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef struct _PWM_CONTROLLER_GET_ACTUAL_PERIOD_OUTPUT { + PWM_PERIOD ActualPeriod; +} PWM_CONTROLLER_GET_ACTUAL_PERIOD_OUTPUT; + +// +// IOCTL_PWM_CONTROLLER_SET_DESIRED_PERIOD +// + +#define IOCTL_PWM_CONTROLLER_SET_DESIRED_PERIOD \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_CONTROLLER_SET_DESIRED_PERIOD, \ + METHOD_BUFFERED, \ + FILE_WRITE_DATA) + +typedef struct _PWM_CONTROLLER_SET_DESIRED_PERIOD_INPUT { + PWM_PERIOD DesiredPeriod; +} PWM_CONTROLLER_SET_DESIRED_PERIOD_INPUT; + +typedef struct _PWM_CONTROLLER_SET_DESIRED_PERIOD_OUTPUT { + PWM_PERIOD ActualPeriod; +} PWM_CONTROLLER_SET_DESIRED_PERIOD_OUTPUT; + +// +// PWM_IOCTL_ID_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE +// + +#define IOCTL_PWM_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef struct _PWM_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE_OUTPUT { + PWM_PERCENTAGE Percentage; +} PWM_PIN_GET_ACTIVE_DUTY_CYCLE_PERCENTAGE_OUTPUT; + +// +// PWM_IOCTL_ID_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE +// + +#define IOCTL_PWM_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE, \ + METHOD_BUFFERED, \ + FILE_WRITE_DATA) + +typedef struct _PWM_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE_INPUT { + PWM_PERCENTAGE Percentage; +} PWM_PIN_SET_ACTIVE_DUTY_CYCLE_PERCENTAGE_INPUT; + +// +// IOCTL_PWM_PIN_GET_POLARITY +// + +#define IOCTL_PWM_PIN_GET_POLARITY \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_GET_POLARITY, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef enum _PWM_POLARITY { + PWM_ACTIVE_HIGH, + PWM_ACTIVE_LOW, +} PWM_POLARITY; + +typedef struct _PWM_PIN_GET_POLARITY_OUTPUT { + PWM_POLARITY Polarity; +} PWM_PIN_GET_POLARITY_OUTPUT; + +// +// IOCTL_PWM_PIN_SET_POLARITY +// + +#define IOCTL_PWM_PIN_SET_POLARITY \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_SET_POLARITY, \ + METHOD_BUFFERED, \ + FILE_WRITE_DATA) + +typedef struct _PWM_PIN_SET_POLARITY_INPUT { + PWM_POLARITY Polarity; +} PWM_PIN_SET_POLARITY_INPUT; + +// +// IOCTL_PWM_PIN_START +// + +#define IOCTL_PWM_PIN_START \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_START, \ + METHOD_NEITHER, \ + FILE_WRITE_DATA) + +// +// IOCTL_PWM_PIN_STOP +// + +#define IOCTL_PWM_PIN_STOP \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_STOP, \ + METHOD_NEITHER, \ + FILE_WRITE_DATA) + +// +// IOCTL_PWM_PIN_IS_STARTED +// + +#define IOCTL_PWM_PIN_IS_STARTED \ + CTL_CODE( \ + FILE_DEVICE_CONTROLLER, \ + PWM_IOCTL_ID_PIN_IS_STARTED, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef struct _PWM_PIN_IS_STARTED_OUTPUT { + BOOLEAN IsStarted; +} PWM_PIN_IS_STARTED_OUTPUT; + +#ifdef __cplusplus +} // extern "C" +#endif // __cplusplus + +#endif // NTDDI_VERSION >= NTDDI_WIN10 + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qos.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qos.h new file mode 100644 index 0000000000000000000000000000000000000000..0005b8c9ce16f9a1664c947a8b02c928a3611959 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qos.h @@ -0,0 +1,218 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + qos.h - QoS definitions for NDIS components. + +Abstract: + + This module defines the Quality of Service structures and types used + by Winsock applications. + +WARNING: + + This api is deprecated and will be removed in a future release of Windows. + Please use the QOS2.h api. + +Revision History: + +--*/ + +#ifndef __QOS_H_ +#define __QOS_H_ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/* + * Definitions for valued-based Service Type for each direction of data flow. + */ + +typedef ULONG SERVICETYPE; + +#define SERVICETYPE_NOTRAFFIC 0x00000000 /* No data in this + * direction */ +#define SERVICETYPE_BESTEFFORT 0x00000001 /* Best Effort */ +#define SERVICETYPE_CONTROLLEDLOAD 0x00000002 /* Controlled Load */ +#define SERVICETYPE_GUARANTEED 0x00000003 /* Guaranteed */ + +#define SERVICETYPE_NETWORK_UNAVAILABLE 0x00000004 /* Used to notify + * change to user */ +#define SERVICETYPE_GENERAL_INFORMATION 0x00000005 /* corresponds to + * "General Parameters" + * defined by IntServ */ +#define SERVICETYPE_NOCHANGE 0x00000006 /* used to indicate + * that the flow spec + * contains no change + * from any previous + * one */ +#define SERVICETYPE_NONCONFORMING 0x00000009 /* Non-Conforming Traffic */ +#define SERVICETYPE_NETWORK_CONTROL 0x0000000A /* Network Control traffic */ +#define SERVICETYPE_QUALITATIVE 0x0000000D /* Qualitative applications */ + + + +/********* The usage of these is currently not supported. ***************/ +#define SERVICE_BESTEFFORT 0x80010000 +#define SERVICE_CONTROLLEDLOAD 0x80020000 +#define SERVICE_GUARANTEED 0x80040000 +#define SERVICE_QUALITATIVE 0x80200000 +/* **************************** ***** ************************************ */ + + + +/* + * Flags to control the usage of RSVP on this flow. + */ + +/* + * to turn off traffic control, 'OR' ( | ) this flag with the + * ServiceType field in the FLOWSPEC + */ +#define SERVICE_NO_TRAFFIC_CONTROL 0x81000000 + + +/* + * this flag can be used to prevent any rsvp signaling messages from being + * sent. Local traffic control will be invoked, but no RSVP Path messages + * will be sent.This flag can also be used in conjunction with a receiving + * flowspec to suppress the automatic generation of a Reserve message. + * The application would receive notification that a Path message had arrived + * and would then need to alter the QOS by issuing WSAIoctl( SIO_SET_QOS ), + * to unset this flag and thereby causing Reserve messages to go out. + */ + +#define SERVICE_NO_QOS_SIGNALING 0x40000000 + + + + +/* + * Flow Specifications for each direction of data flow. + */ +typedef struct _flowspec +{ + ULONG TokenRate; /* In Bytes/sec */ + ULONG TokenBucketSize; /* In Bytes */ + ULONG PeakBandwidth; /* In Bytes/sec */ + ULONG Latency; /* In microseconds */ + ULONG DelayVariation; /* In microseconds */ + SERVICETYPE ServiceType; + ULONG MaxSduSize; /* In Bytes */ + ULONG MinimumPolicedSize; /* In Bytes */ + +} FLOWSPEC, *PFLOWSPEC, * LPFLOWSPEC; + +/* + * this value can be used in the FLOWSPEC structure to instruct the Rsvp Service + * provider to derive the appropriate default value for the parameter. Note + * that not all values in the FLOWSPEC structure can be defaults. In the + * ReceivingFlowspec, all parameters can be defaulted except the ServiceType. + * In the SendingFlowspec, the MaxSduSize and MinimumPolicedSize can be + * defaulted. Other defaults may be possible. Refer to the appropriate + * documentation. + */ +#define QOS_NOT_SPECIFIED 0xFFFFFFFF + +/* + * define a value that can be used for the PeakBandwidth, which will map into + * positive infinity when the FLOWSPEC is converted into IntServ floating point + * format. We can't use (-1) because that value was previously defined to mean + * "select the default". + */ +#define POSITIVE_INFINITY_RATE 0xFFFFFFFE + + + +/* + * the provider specific structure can have a number of objects in it. + * Each next structure in the + * ProviderSpecific will be the QOS_OBJECT_HDR struct that prefaces the actual + * data with a type and length for that object. This QOS_OBJECT struct can + * repeat several times if there are several objects. This list of objects + * terminates either when the buffer length has been reached ( WSABUF ) or + * an object of type QOS_END_OF_LIST is encountered. + */ +typedef struct { + + ULONG ObjectType; + ULONG ObjectLength; /* the length of object buffer INCLUDING + * this header */ + +} QOS_OBJECT_HDR, *LPQOS_OBJECT_HDR; + + +/* + * general QOS objects start at this offset from the base and have a range + * of 1000 + */ +#define QOS_GENERAL_ID_BASE 2000 + +#define QOS_OBJECT_END_OF_LIST (0x00000001 + QOS_GENERAL_ID_BASE) + /* QOS_End_of_list structure passed */ +#define QOS_OBJECT_SD_MODE (0x00000002 + QOS_GENERAL_ID_BASE) + /* QOS_ShapeDiscard structure passed */ +#define QOS_OBJECT_SHAPING_RATE (0x00000003 + QOS_GENERAL_ID_BASE) + /* QOS_ShapingRate structure */ +#define QOS_OBJECT_DESTADDR (0x00000004 + QOS_GENERAL_ID_BASE) + /* QOS_DestAddr structure (defined in qossp.h) */ + + +/* + * This structure is used to define the behaviour that the traffic + * control packet shaper will apply to the flow. + * + * TC_NONCONF_BORROW - the flow will receive resources remaining + * after all higher priority flows have been serviced. If a + * TokenRate is specified, packets may be non-conforming and + * will be demoted to less than best-effort priority. + * + * TC_NONCONF_SHAPE - TokenRate must be specified. Non-conforming + * packets will be retianed in the packet shaper until they become + * conforming. + * + * TC_NONCONF_DISCARD - TokenRate must be specified. Non-conforming + * packets will be discarded. + * + */ + +typedef struct _QOS_SD_MODE { + + QOS_OBJECT_HDR ObjectHdr; + ULONG ShapeDiscardMode; + +} QOS_SD_MODE, *LPQOS_SD_MODE; + +#define TC_NONCONF_BORROW 0 +#define TC_NONCONF_SHAPE 1 +#define TC_NONCONF_DISCARD 2 +#define TC_NONCONF_BORROW_PLUS 3 // Not supported currently + + +/* + * This structure allows an app to specify a prorated "average token rate" using by + * the traffic shaper under SHAPE modehaper queue. It is expressed in bytes per sec. + * + * ShapingRate (bytes per sec.) + * + */ + +typedef struct _QOS_SHAPING_RATE { + + QOS_OBJECT_HDR ObjectHdr; + ULONG ShapingRate; + +} QOS_SHAPING_RATE, *LPQOS_SHAPING_RATE; + + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* __QOS_H_ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qosobjs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qosobjs.h new file mode 100644 index 0000000000000000000000000000000000000000..1564f3e75010d189965bff851d251b736860a8c8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qosobjs.h @@ -0,0 +1,132 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + qosobjs.h + +Abstract: + + This module contains QoS object definitions. + +--*/ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifdef __cplusplus +extern "C" { +#endif + + +#define QOS_MAX_OBJECT_STRING_LENGTH 256 + + +// +// QoS objects supported by traffic control +// +#define QOS_TRAFFIC_GENERAL_ID_BASE 4000 + +#define QOS_OBJECT_DS_CLASS (0x00000001 + QOS_TRAFFIC_GENERAL_ID_BASE) + /* QOS_DS_CLASS structure passed */ +#define QOS_OBJECT_TRAFFIC_CLASS (0x00000002 + QOS_TRAFFIC_GENERAL_ID_BASE) + /* QOS_Traffic class structure passed */ +#define QOS_OBJECT_DIFFSERV (0x00000003 + QOS_TRAFFIC_GENERAL_ID_BASE) + /* QOS_DIFFSERV Structure */ +#define QOS_OBJECT_TCP_TRAFFIC (0x00000004 + QOS_TRAFFIC_GENERAL_ID_BASE) + /* QOS_TCP_TRAFFIC structure */ +#define QOS_OBJECT_FRIENDLY_NAME (0x00000005 + QOS_TRAFFIC_GENERAL_ID_BASE) + /* QOS_FRIENDLY_NAME structure */ + + +// +// This structure is used to associate a friendly name with the flow +// + +typedef struct _QOS_FRIENDLY_NAME { + QOS_OBJECT_HDR ObjectHdr; + WCHAR FriendlyName[QOS_MAX_OBJECT_STRING_LENGTH]; +} QOS_FRIENDLY_NAME, *LPQOS_FRIENDLY_NAME; + +// +// This structure may carry an 802.1 TrafficClass parameter which +// has been provided to the host by a layer 2 network, for example, +// in an 802.1 extended RSVP RESV message. If this object is obtained +// from the network, hosts will stamp the MAC headers of corresponding +// transmitted packets, with the value in the object. Otherwise, hosts +// may select a value based on the standard Intserv mapping of +// ServiceType to 802.1 TrafficClass. +// +// + +typedef struct _QOS_TRAFFIC_CLASS { + + QOS_OBJECT_HDR ObjectHdr; + ULONG TrafficClass; + +} QOS_TRAFFIC_CLASS, *LPQOS_TRAFFIC_CLASS; + +// +// This structure may carry an DSField parameter which has been provided to +// the host by a layer 3 network, for example, in an extended RSVP RESV message. +// If this object is obtained from the network, hosts will stamp the DS Field on the +// IP header of transmitted packets, with the value in the object. Otherwise, hosts +// may select a value based on the standard Intserv mapping of ServiceType to DS Field +// + +typedef struct _QOS_DS_CLASS { + + QOS_OBJECT_HDR ObjectHdr; + ULONG DSField; + +} QOS_DS_CLASS, *LPQOS_DS_CLASS; + + +// +// This structure is used to create DiffServ Flows. This creates flows in the packet scheduler +// and allows it to classify to packets based on a particular DS field. This structure takes +// a variable length array of QOS_DIFFSERV_RULE, where each DS field is specified by a +// QOS_DIFFSERV_RULE +// +typedef struct _QOS_DIFFSERV { + + QOS_OBJECT_HDR ObjectHdr; + ULONG DSFieldCount; + UCHAR DiffservRule[1]; +} QOS_DIFFSERV, *LPQOS_DIFFSERV; + +// +// The rule for a Diffserv DS codepoint. +// +typedef struct _QOS_DIFFSERV_RULE { + UCHAR InboundDSField; + UCHAR ConformingOutboundDSField; + UCHAR NonConformingOutboundDSField; + UCHAR ConformingUserPriority; + UCHAR NonConformingUserPriority; +} QOS_DIFFSERV_RULE, *LPQOS_DIFFSERV_RULE; + +// +// This structure is passed to indicate that the IP Precedence and UserPriority mappings for the flow +// have to be set to the system defaults for TCP traffic. If this object is passed, +// the ServiceType ==> DSField mapping, ServiceType ==> UserPriorityMapping, QOS_OBJECT_DS_CLASS +// and QOS_OBJECT_TRAFFIC_CLASS will be ignored. +// + +typedef struct _QOS_TCP_TRAFFIC { + QOS_OBJECT_HDR ObjectHdr; +} QOS_TCP_TRAFFIC, *LPQOS_TCP_TRAFFIC; + + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qossp.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qossp.h new file mode 100644 index 0000000000000000000000000000000000000000..61856bdf30db2dccf95b74606270d134b1beb2d8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/qossp.h @@ -0,0 +1,685 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + qos.h - QoS definitions for NDIS components. + +Abstract: + + This module defines the type of objects that can go into the + ProviderSpecific buffer in the QOS structure. + +Revision History: + +--*/ + +#ifndef __QOSSP_H_ +#define __QOSSP_H_ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +/* + * Definition of object Types + * + * + * define the values for ObjectType above - RSVP Objects ids start at an + * offset from zero to allow for ATM objects that might be defined in the + * lower number range. + */ +#define RSVP_OBJECT_ID_BASE 1000 +#define RSVP_OBJECT_STATUS_INFO (0x00000000 + RSVP_OBJECT_ID_BASE) + /* RSVP_STATUS_INFO structure passed */ +#define RSVP_OBJECT_RESERVE_INFO (0x00000001 + RSVP_OBJECT_ID_BASE) + /* RSVP_RESERVE_INFO structure passed */ +#define RSVP_OBJECT_ADSPEC (0x00000002 + RSVP_OBJECT_ID_BASE) + /* RSVP_ADSPEC structure passed */ +#define RSVP_OBJECT_POLICY_INFO (0x00000003 + RSVP_OBJECT_ID_BASE) + /* RSVP POLICY ELEMENT(S) retrieved */ +#define RSVP_OBJECT_FILTERSPEC_LIST (0x00000004 + RSVP_OBJECT_ID_BASE) + /* RSVP SENDER LIST returned */ + + +/* + * IPV4 addressing for RSVP FILTERSPECS + */ +typedef union _IN_ADDR_IPV4 { + + ULONG Addr; + UCHAR AddrBytes[4]; + +} IN_ADDR_IPV4, *LPIN_ADDR_IPV4; + +/* + * IPV6 addressing for RSVP FILTERSPECS + */ +typedef struct _IN_ADDR_IPV6 { + + UCHAR Addr[16]; //IPV6 address + +} IN_ADDR_IPV6, *LPIN_ADDR_IPV6; + +typedef const IN_ADDR_IPV6 *LPCIN_ADDR_IPV6; + +/* + * IPV4 addressing for RSVP FILTERSPECS + */ +typedef struct _RSVP_FILTERSPEC_V4 { + + IN_ADDR_IPV4 Address; + USHORT Unused; + USHORT Port; + +} RSVP_FILTERSPEC_V4, *LPRSVP_FILTERSPEC_V4; + +typedef struct _RSVP_FILTERSPEC_V6 { + + IN_ADDR_IPV6 Address; + USHORT UnUsed; + USHORT Port; + +} RSVP_FILTERSPEC_V6, *LPRSVP_FILTERSPEC_V6; + + +typedef struct _RSVP_FILTERSPEC_V6_FLOW { + + IN_ADDR_IPV6 Address; + UCHAR UnUsed; + UCHAR FlowLabel[3]; + +} RSVP_FILTERSPEC_V6_FLOW, *LPRSVP_FILTERSPEC_V6_FLOW; + +typedef struct _RSVP_FILTERSPEC_V4_GPI { + + IN_ADDR_IPV4 Address; + ULONG GeneralPortId; + +} RSVP_FILTERSPEC_V4_GPI, *LPRSVP_FILTERSPEC_V4_GPI; + +typedef struct _RSVP_FILTERSPEC_V6_GPI { + + IN_ADDR_IPV6 Address; + ULONG GeneralPortId; + +} RSVP_FILTERSPEC_V6_GPI, *LPRSVP_FILTERSPEC_V6_GPI; + + +/* + * FILTERSPEC TYPES used in making reservations. + */ +typedef enum { + + FILTERSPECV4 = 1, + FILTERSPECV6, + FILTERSPECV6_FLOW, + FILTERSPECV4_GPI, + FILTERSPECV6_GPI, + FILTERSPEC_END + +} FilterType; + +typedef struct _RSVP_FILTERSPEC { + + FilterType Type; + + union { + RSVP_FILTERSPEC_V4 FilterSpecV4; + RSVP_FILTERSPEC_V6 FilterSpecV6; + RSVP_FILTERSPEC_V6_FLOW FilterSpecV6Flow; + RSVP_FILTERSPEC_V4_GPI FilterSpecV4Gpi; + RSVP_FILTERSPEC_V6_GPI FilterSpecV6Gpi; + }; + +} RSVP_FILTERSPEC, *LPRSVP_FILTERSPEC; + +/* + * FLOWDESCRIPTOR Structure used for specifying one or more + * Filters per Flowspec. + */ +typedef struct _FLOWDESCRIPTOR { + + FLOWSPEC FlowSpec; + ULONG NumFilters; + LPRSVP_FILTERSPEC FilterList; + +} FLOWDESCRIPTOR, *LPFLOWDESCRIPTOR; + +/* + * RSVP_POLICY contains undefined policy data. RSVP transports this + * data on behalf of the Policy Control component. + */ +typedef struct _RSVP_POLICY { + USHORT Len; /* total length of this element object */ + USHORT Type; + UCHAR Info[4]; +} RSVP_POLICY, *LPRSVP_POLICY; + +typedef const RSVP_POLICY *LPCRSVP_POLICY; +#define RSVP_POLICY_HDR_LEN ( sizeof(USHORT) + sizeof(USHORT) ) + +/* + * RSVP_POLICY_INFO contains undefined policy element(s) retrieved from RSVP. + */ +typedef struct _RSVP_POLICY_INFO { + + QOS_OBJECT_HDR ObjectHdr; + ULONG NumPolicyElement; /* count of the + * number of policy elements */ + RSVP_POLICY PolicyElement[1]; /* a list of the policy + * elements retrieved */ + +} RSVP_POLICY_INFO, *LPRSVP_POLICY_INFO; + +/* + * RSVP_RESERVE_INFO Structure used for storing RSVP specific + * information for fine tuning interaction via the Winsock2 + * Generic QoS API via the provider specific buffer. This structure + * includes the QOS_OBJECT_HDR structure directly + */ + +typedef struct _RSVP_RESERVE_INFO { + + QOS_OBJECT_HDR ObjectHdr; /* type and length of this object */ + ULONG Style; /* RSVP Style (FF,WF,SE) */ + ULONG ConfirmRequest; /* Non Zero for Confirm Request (receive only) */ + LPRSVP_POLICY_INFO PolicyElementList; /* Points to the set of policy elements */ + ULONG NumFlowDesc; /* Number of FlowDesc */ + LPFLOWDESCRIPTOR FlowDescList; /* Points to the FlowDesc list */ + +} RSVP_RESERVE_INFO, *LPRSVP_RESERVE_INFO; + +typedef const RSVP_RESERVE_INFO *LPCRSVP_RESERVE_INFO; + +/* + * definitions for the ulStyle in the previous structure + */ +#define RSVP_DEFAULT_STYLE 0x00000000 +#define RSVP_WILDCARD_STYLE 0x00000001 +#define RSVP_FIXED_FILTER_STYLE 0x00000002 +#define RSVP_SHARED_EXPLICIT_STYLE 0x00000003 + +/* + * RSVP_STATUS_INFO Structure used for storing RSVP specific + * error of status indications. This also serves as a header + * for additional objects in the provider specific buffer when + * interacting via Winsock2 Generic QoS API. This structure includes + * the QOS_OBJECT_COUNT and QOS_OBJECT_HDR structures directly It is + * expected to be the first structure in the provider specific structure + * since it includes the QOS_OBJECT_COUNT + */ + +typedef struct _RSVP_STATUS_INFO { + + QOS_OBJECT_HDR ObjectHdr; /* Object Hdr */ + ULONG StatusCode; /* Error or Status Information see + * Winsock2.h */ + ULONG ExtendedStatus1;/* Provider specific status extension */ + ULONG ExtendedStatus2;/* Provider specific status extension */ + +} RSVP_STATUS_INFO, *LPRSVP_STATUS_INFO; + +typedef const RSVP_STATUS_INFO *LPCRSVP_STATUS_INFO; + + +/* + * QOS_DestAddr structure -- used for WSAIoctl(SIO_SET_QOS) when we + * do not want to issue a connect for a sending socket. The destination + * address is required so we can generate the session information for + * RSVP signalling. +*/ + +typedef struct _QOS_DESTADDR { + QOS_OBJECT_HDR ObjectHdr; /* Object header */ + const struct sockaddr * SocketAddress; /* Destination socket address */ + ULONG SocketAddressLength; /* Length of the address structure */ +} QOS_DESTADDR, *LPQOS_DESTADDR; + +typedef const QOS_DESTADDR * LPCQOS_DESTADDR; + + + +/* + * this structure defines the "General Characterization Parameters" contained in + * the RSVP Adspec object + */ +typedef struct _AD_GENERAL_PARAMS{ + + ULONG IntServAwareHopCount; /* number of hops that conform to + * Integrated Services requirements */ + ULONG PathBandwidthEstimate; /* minimum bandwidth available from + * sender to receiver */ + ULONG MinimumLatency; /* sum of minimum latency of the packet + * forwarding process in routers + * (in usec)*/ + ULONG PathMTU; /* max transmission unit end to end that + * will not incur fragmentation */ + ULONG Flags; /* used to hold break bits.*/ + +} AD_GENERAL_PARAMS, *LPAD_GENERAL_PARAMS; + +/* + * Minimum Latency may be set to this "undefined" value + */ +#define INDETERMINATE_LATENCY 0xFFFFFFFF; + +/* + * This Flag is used to indicate the existence of a network element not + * supporting QoS control services somewhere in the data path. If this bit + * is set in the specific service override then it indicates that that + * service was not supported at at least one hop. + */ +#define AD_FLAG_BREAK_BIT 0x00000001 + +/* + * this structure describes the Guaranteed service parameters + */ +typedef struct _AD_GUARANTEED { + + ULONG CTotal; + ULONG DTotal; + ULONG CSum; + ULONG DSum; + +} AD_GUARANTEED, *LPAD_GUARANTEED; + +/* + * this structure describes the format of the parameter buffer that can be + * included in the Service_Type structure below. This structure allows an + * application to include any valid Int Serv service parameter in the Buffer + * value, after providing the Int Serv parameter id in the ParameterId field. + */ +typedef struct _PARAM_BUFFER { + + ULONG ParameterId; /* Int Server parameter ID */ + ULONG Length; /* total length of this structure + * ( 8 bytes + length of Buffer ) */ + UCHAR Buffer[1]; /* Paramter itself */ + +} PARAM_BUFFER, *LPPARAM_BUFFER; + +/* + * this structure contains the service types supported + */ +typedef struct _CONTROL_SERVICE { + + /* + * the length of this entire structure including the following buffer. + * This length value can be added to the ptr to the structure to get the ptr + * to the next SERVICE_TYPE structure in the list, until the + * NumberOfServices count has been exhausted. + */ + ULONG Length; + + SERVICETYPE Service; + AD_GENERAL_PARAMS Overrides; + + /* + * service specific information ( controlled load has no service specific + * info here ) + */ + union { + AD_GUARANTEED Guaranteed; + PARAM_BUFFER ParamBuffer[1]; /* allows for other services down + * the road */ + }; + +} CONTROL_SERVICE, *LPCONTROL_SERVICE; + +/* + * This structure defines the information which is carried in the Rsvp + * Adspec. This Rsvp object typically indicates which service types are + * available ( Controlled Load and/or Guaranteed Service ), if a non-Rsvp + * hop has been encountered by the Path message, and the minumum MTU along + * the path. The services array indicates which services are supported + */ +typedef struct _RSVP_ADSPEC { + + QOS_OBJECT_HDR ObjectHdr; + AD_GENERAL_PARAMS GeneralParams; /* contains the general + * characterization paramters */ + ULONG NumberOfServices; /* count of the number of services */ + CONTROL_SERVICE Services[1]; /* a list of the services + * supported/requested */ + +} RSVP_ADSPEC, *LPRSVP_ADSPEC; + + +// +// Opcode for the SIO_CHK_QOS ioctl +// (specific for the Microsoft QOS Service Provider +// +// Bascially: +// +// SIO_CHK_QOS = _WSAIORW(IOC_VENDOR,1) +// = mIOC_IN | mIOC_OUT | mIOC_VENDOR | mCOMPANY | ioctl_code +// where +// mIOC_IN = 0x80000000 +// mIOC_OUT = 0x40000000 +// mIOC_VENDOR = 0x04000000 +// mCOMPANY = 0x18000000 +// ioctl_code = 0x00000001 +// +// See WSAIoctl man page for details. +// + +#define mIOC_IN 0x80000000 +#define mIOC_OUT 0x40000000 +#define mIOC_VENDOR 0x04000000 +#define mCOMPANY 0x18000000 +#define ioctl_code 0x00000001 + +#define SIO_CHK_QOS (mIOC_IN | mIOC_OUT | mIOC_VENDOR | mCOMPANY | ioctl_code) + +// +// The following may be specified in the input buffer +// of the SIO_CHK_IOCTL ioctl call +// + +#define QOSSPBASE 50000 + +#define ALLOWED_TO_SEND_DATA (QOSSPBASE+1) // query the SBM/BEST_EFFORT limit + // -- result is based on a comparison between + // the user-specified token rate and the + // SBM/BEST_EFFORT bandwidth parameters in + // the system + // -- result is a YES(1) or NO(0) answer + // in the output buffer + +#define ABLE_TO_RECV_RSVP (QOSSPBASE+2) // query the SBM/BEST_EFFORT limit + // -- result is based on a comparison between + // the user-specified token rate and the + // SBM/BEST_EFFORT bandwidth parameters in + // the system + // -- result is a YES(1) or NO(0) answer + // in the output buffer + +#define LINE_RATE (QOSSPBASE+3) // query the interface capacity + // -- result returned in the output buffer + // in kilo-bits per second + +#define LOCAL_TRAFFIC_CONTROL (QOSSPBASE+4) // check if Kernel Traffic Control is available or not + // -- 0 if not available + // -- 1 if avaiable + // -- INFO_NOT_AVAILABLE if there is no way to check + +#define LOCAL_QOSABILITY (QOSSPBASE+5) // The followings are for + // the Discovery of Local QOSability + // -- 0 if no local QOS support + // -- 1 if local QOS support available + // -- INFO_NOT_AVAILABLE if there is no way to check + +#define END_TO_END_QOSABILITY (QOSSPBASE+6) // The followings are for + // the Discovery of End-to-End QOSability + // -- 0 if no end-to-end QOS support + // -- 1 if end-to-end QOS support available + // -- INFO_NOT_AVAILABLE if there is no way to check + +#define INFO_NOT_AVAILABLE 0xFFFFFFFF // used when LINE_RATE is not known + + +#define ANY_DEST_ADDR 0xFFFFFFFF // for QOS_OBJECT_DEST_ADDR + + +// The followings are for Guaranteed_Service+Latency -> ISSLOW_Traffic_Class Mapping + +#define MODERATELY_DELAY_SENSITIVE 0xFFFFFFFD + +#define HIGHLY_DELAY_SENSITIVE 0xFFFFFFFE + +// +// QOSSP Error Code/Value +// + +#define QOSSP_ERR_BASE (QOSSPBASE+6000) + +// No error +#define GQOS_NO_ERRORCODE (0) + +#define GQOS_NO_ERRORVALUE (0) + +// Unknown error +#define GQOS_ERRORCODE_UNKNOWN (0xFFFFFFFF) + +#define GQOS_ERRORVALUE_UNKNOWN (0xFFFFFFFF) + +// Admission (Resource) Error +#define GQOS_NET_ADMISSION (QOSSP_ERR_BASE+100) + +#define GQOS_OTHER (QOSSP_ERR_BASE+100+1) +#define GQOS_DELAYBND (QOSSP_ERR_BASE+100+2) +#define GQOS_BANDWIDTH (QOSSP_ERR_BASE+100+3) +#define GQOS_MTU (QOSSP_ERR_BASE+100+4) +#define GQOS_FLOW_RATE (QOSSP_ERR_BASE+100+5) +#define GQOS_PEAK_RATE (QOSSP_ERR_BASE+100+6) +#define GQOS_AGG_PEAK_RATE (QOSSP_ERR_BASE+100+7) + +// Policy Error +#define GQOS_NET_POLICY (QOSSP_ERR_BASE+200) + +#define GQOS_POLICY_ERROR_UNKNOWN (QOSSP_ERR_BASE+200+0) + +#define GQOS_POLICY_GLOBAL_DEF_FLOW_COUNT (QOSSP_ERR_BASE+200+1) +#define GQOS_POLICY_GLOBAL_GRP_FLOW_COUNT (QOSSP_ERR_BASE+200+2) +#define GQOS_POLICY_GLOBAL_USER_FLOW_COUNT (QOSSP_ERR_BASE+200+3) +#define GQOS_POLICY_GLOBAL_UNK_USER_FLOW_COUNT (QOSSP_ERR_BASE+200+4) +#define GQOS_POLICY_SUBNET_DEF_FLOW_COUNT (QOSSP_ERR_BASE+200+5) +#define GQOS_POLICY_SUBNET_GRP_FLOW_COUNT (QOSSP_ERR_BASE+200+6) +#define GQOS_POLICY_SUBNET_USER_FLOW_COUNT (QOSSP_ERR_BASE+200+7) +#define GQOS_POLICY_SUBNET_UNK_USER_FLOW_COUNT (QOSSP_ERR_BASE+200+8) + +#define GQOS_POLICY_GLOBAL_DEF_FLOW_DURATION (QOSSP_ERR_BASE+200+9) +#define GQOS_POLICY_GLOBAL_GRP_FLOW_DURATION (QOSSP_ERR_BASE+200+10) +#define GQOS_POLICY_GLOBAL_USER_FLOW_DURATION (QOSSP_ERR_BASE+200+11) +#define GQOS_POLICY_GLOBAL_UNK_USER_FLOW_DURATION (QOSSP_ERR_BASE+200+12) +#define GQOS_POLICY_SUBNET_DEF_FLOW_DURATION (QOSSP_ERR_BASE+200+13) +#define GQOS_POLICY_SUBNET_GRP_FLOW_DURATION (QOSSP_ERR_BASE+200+14) +#define GQOS_POLICY_SUBNET_USER_FLOW_DURATION (QOSSP_ERR_BASE+200+15) +#define GQOS_POLICY_SUBNET_UNK_USER_FLOW_DURATION (QOSSP_ERR_BASE+200+16) + +#define GQOS_POLICY_GLOBAL_DEF_FLOW_RATE (QOSSP_ERR_BASE+200+17) +#define GQOS_POLICY_GLOBAL_GRP_FLOW_RATE (QOSSP_ERR_BASE+200+18) +#define GQOS_POLICY_GLOBAL_USER_FLOW_RATE (QOSSP_ERR_BASE+200+19) +#define GQOS_POLICY_GLOBAL_UNK_USER_FLOW_RATE (QOSSP_ERR_BASE+200+20) +#define GQOS_POLICY_SUBNET_DEF_FLOW_RATE (QOSSP_ERR_BASE+200+21) +#define GQOS_POLICY_SUBNET_GRP_FLOW_RATE (QOSSP_ERR_BASE+200+22) +#define GQOS_POLICY_SUBNET_USER_FLOW_RATE (QOSSP_ERR_BASE+200+23) +#define GQOS_POLICY_SUBNET_UNK_USER_FLOW_RATE (QOSSP_ERR_BASE+200+24) + +#define GQOS_POLICY_GLOBAL_DEF_PEAK_RATE (QOSSP_ERR_BASE+200+25) +#define GQOS_POLICY_GLOBAL_GRP_PEAK_RATE (QOSSP_ERR_BASE+200+26) +#define GQOS_POLICY_GLOBAL_USER_PEAK_RATE (QOSSP_ERR_BASE+200+27) +#define GQOS_POLICY_GLOBAL_UNK_USER_PEAK_RATE (QOSSP_ERR_BASE+200+28) +#define GQOS_POLICY_SUBNET_DEF_PEAK_RATE (QOSSP_ERR_BASE+200+29) +#define GQOS_POLICY_SUBNET_GRP_PEAK_RATE (QOSSP_ERR_BASE+200+30) +#define GQOS_POLICY_SUBNET_USER_PEAK_RATE (QOSSP_ERR_BASE+200+31) +#define GQOS_POLICY_SUBNET_UNK_USER_PEAK_RATE (QOSSP_ERR_BASE+200+32) + +#define GQOS_POLICY_GLOBAL_DEF_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+33) +#define GQOS_POLICY_GLOBAL_GRP_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+34) +#define GQOS_POLICY_GLOBAL_USER_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+35) +#define GQOS_POLICY_GLOBAL_UNK_USER_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+36) +#define GQOS_POLICY_SUBNET_DEF_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+37) +#define GQOS_POLICY_SUBNET_GRP_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+38) +#define GQOS_POLICY_SUBNET_USER_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+39) +#define GQOS_POLICY_SUBNET_UNK_USER_SUM_FLOW_RATE (QOSSP_ERR_BASE+200+40) + +#define GQOS_POLICY_GLOBAL_DEF_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+41) +#define GQOS_POLICY_GLOBAL_GRP_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+42) +#define GQOS_POLICY_GLOBAL_USER_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+43) +#define GQOS_POLICY_GLOBAL_UNK_USER_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+44) +#define GQOS_POLICY_SUBNET_DEF_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+45) +#define GQOS_POLICY_SUBNET_GRP_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+46) +#define GQOS_POLICY_SUBNET_USER_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+47) +#define GQOS_POLICY_SUBNET_UNK_USER_SUM_PEAK_RATE (QOSSP_ERR_BASE+200+48) + +#define GQOS_POLICY_UNKNOWN_USER (QOSSP_ERR_BASE+200+49) +#define GQOS_POLICY_NO_PRIVILEGES (QOSSP_ERR_BASE+200+50) +#define GQOS_POLICY_EXPIRED_USER_TOKEN (QOSSP_ERR_BASE+200+51) +#define GQOS_POLICY_NO_RESOURCES (QOSSP_ERR_BASE+200+52) +#define GQOS_POLICY_PRE_EMPTED (QOSSP_ERR_BASE+200+53) +#define GQOS_POLICY_USER_CHANGED (QOSSP_ERR_BASE+200+54) +#define GQOS_POLICY_NO_ACCEPTS (QOSSP_ERR_BASE+200+55) +#define GQOS_POLICY_NO_MEMORY (QOSSP_ERR_BASE+200+56) +#define GQOS_POLICY_CRAZY_FLOWSPEC (QOSSP_ERR_BASE+200+57) + +#define GQOS_POLICY_NO_MORE_INFO (QOSSP_ERR_BASE+200+58) +#define GQOS_POLICY_UNSUPPORTED_CREDENTIAL_TYPE (QOSSP_ERR_BASE+200+59) +#define GQOS_POLICY_INSUFFICIENT_PRIVILEGES (QOSSP_ERR_BASE+200+60) +#define GQOS_POLICY_EXPIRED_CREDENTIAL (QOSSP_ERR_BASE+200+61) +#define GQOS_POLICY_IDENTITY_CHANGED (QOSSP_ERR_BASE+200+62) +#define GQOS_POLICY_NO_QOS_PROVIDED (QOSSP_ERR_BASE+200+63) +#define GQOS_POLICY_DO_NOT_SEND (QOSSP_ERR_BASE+200+64) + +#define GQOS_POLICY_ERROR_USERID (QOSSP_ERR_BASE+200+99) + +// RSVP Error +#define GQOS_RSVP (QOSSP_ERR_BASE+300) + +#define GQOS_NO_PATH (QOSSP_ERR_BASE+300+1) +#define GQOS_NO_SENDER (QOSSP_ERR_BASE+300+2) +#define GQOS_BAD_STYLE (QOSSP_ERR_BASE+300+3) +#define GQOS_UNKNOWN_STYLE (QOSSP_ERR_BASE+300+4) +#define GQOS_BAD_DSTPORT (QOSSP_ERR_BASE+300+5) +#define GQOS_BAD_SNDPORT (QOSSP_ERR_BASE+300+6) +#define GQOS_AMBIG_FILTER (QOSSP_ERR_BASE+300+7) +#define GQOS_PREEMPTED (QOSSP_ERR_BASE+300+8) +#define GQOS_UNKN_OBJ_CLASS (QOSSP_ERR_BASE+300+9) +#define GQOS_UNKNOWN_CTYPE (QOSSP_ERR_BASE+300+10) +#define GQOS_INVALID (QOSSP_ERR_BASE+300+11) + +// API Error +#define GQOS_API (QOSSP_ERR_BASE+400) + +#define GQOS_API_BADSEND (QOSSP_ERR_BASE+400+1) /* Sender addr not my interface */ +#define GQOS_API_BADRECV (QOSSP_ERR_BASE+400+2) /* Recv addr not my interface */ +#define GQOS_API_BADSPORT (QOSSP_ERR_BASE+400+3) /* Sport !=0 but Dport == 0 */ + +// TC System Error +#define GQOS_KERNEL_TC_SYS (QOSSP_ERR_BASE+500) + +#define GQOS_TC_GENERIC (QOSSP_ERR_BASE+500+1) +#define GQOS_TC_INVALID (QOSSP_ERR_BASE+500+2) +#define GQOS_NO_MEMORY (QOSSP_ERR_BASE+500+3) +#define GQOS_BAD_ADDRESSTYPE (QOSSP_ERR_BASE+500+4) +#define GQOS_BAD_DUPLICATE (QOSSP_ERR_BASE+500+5) +#define GQOS_CONFLICT (QOSSP_ERR_BASE+500+6) +#define GQOS_NOTREADY (QOSSP_ERR_BASE+500+7) +#define GQOS_WOULDBLOCK (QOSSP_ERR_BASE+500+8) +#define GQOS_INCOMPATIBLE (QOSSP_ERR_BASE+500+9) +#define GQOS_BAD_SDMODE (QOSSP_ERR_BASE+500+10) +#define GQOS_BAD_QOSPRIORITY (QOSSP_ERR_BASE+500+11) +#define GQOS_BAD_TRAFFICCLASS (QOSSP_ERR_BASE+500+12) +#define GQOS_NO_SYS_RESOURCES (QOSSP_ERR_BASE+500+13) + +// RSVP System Error +#define GQOS_RSVP_SYS (QOSSP_ERR_BASE+600) + +#define GQOS_OTHER_SYS (QOSSP_ERR_BASE+600+1) +#define GQOS_MEMORY_SYS (QOSSP_ERR_BASE+600+2) +#define GQOS_API_SYS (QOSSP_ERR_BASE+600+3) +#define GQOS_SETQOS_NO_LOCAL_APPS (QOSSP_ERR_BASE+600+4) + +// TC Error +#define GQOS_KERNEL_TC (QOSSP_ERR_BASE+700) + +#define GQOS_CONFLICT_SERV (QOSSP_ERR_BASE+700+1) +#define GQOS_NO_SERV (QOSSP_ERR_BASE+700+2) +#define GQOS_BAD_FLOWSPEC (QOSSP_ERR_BASE+700+3) +#define GQOS_BAD_TSPEC (QOSSP_ERR_BASE+700+4) +#define GQOS_BAD_ADSPEC (QOSSP_ERR_BASE+700+5) + +// GQOS API ERRORS + +// WSAIoctl Error + +#define GQOS_IOCTL_SYSTEMFAILURE (QOSSP_ERR_BASE+800+1) +#define GQOS_IOCTL_NOBYTESRETURNED (QOSSP_ERR_BASE+800+2) +#define GQOS_IOCTL_INVALIDSOCKET (QOSSP_ERR_BASE+800+3) +#define GQOS_IOCTL_INV_FUNCPTR (QOSSP_ERR_BASE+800+4) +#define GQOS_IOCTL_INV_OVERLAPPED (QOSSP_ERR_BASE+800+5) + +// SIO_SET_QOS error + +#define GQOS_SETQOS_BADINBUFFER (QOSSP_ERR_BASE+810+1) +#define GQOS_SETQOS_BADFLOWSPEC (QOSSP_ERR_BASE+810+2) +#define GQOS_SETQOS_COLLISION (QOSSP_ERR_BASE+810+3) +#define GQOS_SETQOS_BADPROVSPECBUF (QOSSP_ERR_BASE+810+4) +#define GQOS_SETQOS_ILLEGALOP (QOSSP_ERR_BASE+810+5) +#define GQOS_SETQOS_INVALIDADDRESS (QOSSP_ERR_BASE+810+6) +#define GQOS_SETQOS_OUTOFMEMORY (QOSSP_ERR_BASE+810+7) +#define GQOS_SETQOS_EXCEPTION (QOSSP_ERR_BASE+810+8) +#define GQOS_SETQOS_BADADDRLEN (QOSSP_ERR_BASE+810+9) +#define GQOS_SETQOS_NOSOCKNAME (QOSSP_ERR_BASE+810+10) +#define GQOS_SETQOS_IPTOSFAIL (QOSSP_ERR_BASE+810+11) +#define GQOS_SETQOS_OPENSESSIONFAIL (QOSSP_ERR_BASE+810+12) +#define GQOS_SETQOS_SENDFAIL (QOSSP_ERR_BASE+810+13) +#define GQOS_SETQOS_RECVFAIL (QOSSP_ERR_BASE+810+14) +#define GQOS_SETQOS_BADPOLICYOBJECT (QOSSP_ERR_BASE+810+15) +#define GQOS_SETQOS_UNKNOWNFILTEROBJ (QOSSP_ERR_BASE+810+16) +#define GQOS_SETQOS_BADFILTERTYPE (QOSSP_ERR_BASE+810+17) +#define GQOS_SETQOS_BADFILTERCOUNT (QOSSP_ERR_BASE+810+18) +#define GQOS_SETQOS_BADOBJLENGTH (QOSSP_ERR_BASE+810+19) +#define GQOS_SETQOS_BADFLOWCOUNT (QOSSP_ERR_BASE+810+20) +#define GQOS_SETQOS_UNKNOWNPSOBJ (QOSSP_ERR_BASE+810+21) +#define GQOS_SETQOS_BADPOLICYOBJ (QOSSP_ERR_BASE+810+22) +#define GQOS_SETQOS_BADFLOWDESC (QOSSP_ERR_BASE+810+23) +#define GQOS_SETQOS_BADPROVSPECOBJ (QOSSP_ERR_BASE+810+24) +#define GQOS_SETQOS_NOLOOPBACK (QOSSP_ERR_BASE+810+25) +#define GQOS_SETQOS_MODENOTSUPPORTED (QOSSP_ERR_BASE+810+26) +#define GQOS_SETQOS_MISSINGFLOWDESC (QOSSP_ERR_BASE+810+27) + +// SIO_GET_QOS error + +#define GQOS_GETQOS_BADOUTBUFFER (QOSSP_ERR_BASE+840+1) +#define GQOS_GETQOS_SYSTEMFAILURE (QOSSP_ERR_BASE+840+2) +#define GQOS_GETQOS_EXCEPTION (QOSSP_ERR_BASE+840+3) +#define GQOS_GETQOS_INTERNALFAILURE (QOSSP_ERR_BASE+840+4) + +// SIO_CHK_QOS error + +#define GQOS_CHKQOS_BADINBUFFER (QOSSP_ERR_BASE+850+1) +#define GQOS_CHKQOS_BADOUTBUFFER (QOSSP_ERR_BASE+850+2) +#define GQOS_CHKQOS_SYSTEMFAILURE (QOSSP_ERR_BASE+850+3) +#define GQOS_CHKQOS_INTERNALFAILURE (QOSSP_ERR_BASE+850+4) +#define GQOS_CHKQOS_BADPARAMETER (QOSSP_ERR_BASE+850+5) +#define GQOS_CHKQOS_EXCEPTION (QOSSP_ERR_BASE+850+6) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* __QOSSP_H_ */ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/reshub.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/reshub.h new file mode 100644 index 0000000000000000000000000000000000000000..9cb20a17d382f2715f45e86085db567d2d9f426b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/reshub.h @@ -0,0 +1,1033 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + + THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR + PURPOSE. + +Module Name: + + reshub.h + +Abstract: + + Defines the structures, prototypes and definitions required by consumers of + Resource Hub services. + +--*/ + +#ifndef __RES_HUB_H__ +#define __RES_HUB_H__ + + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#ifdef RESHUB_USE_HELPER_ROUTINES + +// +// Fix for value-less UMDF_DRIVER identifier in UMDF 1.x. +// +#if defined(__wudfddi_h__) && defined(UMDF_DRIVER) +#undef UMDF_DRIVER +#define UMDF_DRIVER 1 +#endif + +#ifdef UMDF_DRIVER +#if (UMDF_DRIVER == 1) +#include +#endif +#include +#else +#include +#endif + +#endif // RESHUB_USE_HELPER_ROUTINES + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Define the name for the Resource Hub device. +// + +#ifdef UMDF_DRIVER +#define RESOURCE_HUB_DEVICE_NAME L"\\\\.\\RESOURCE_HUB" +#else +#define RESOURCE_HUB_DEVICE_NAME L"\\Device\\RESOURCE_HUB" +#endif + +// +// Define the symbolic name target for the Resource Hub device for use by UMDF +// drivers. + +#define RESOURCE_HUB_SYMBOLIC_NAME L"\\DosDevices\\RESOURCE_HUB" + + +#define RESOURCE_HUB_DEVICE_NAME_PREFIX RESOURCE_HUB_DEVICE_NAME L"\\" + +// +// For connections, the file name to open a provider via the resource hub is a +// 16-digit hexadecimal representation of the ID. +// +// RESOURCE_HUB_CONNECTION_FILE_SIZE and RESOURCE_HUB_CONNECTION_PATH_SIZE both +// include space for NULL termination. +// + +#define RESOURCE_HUB_CONNECTION_FILE_SIZE \ + ((sizeof(LARGE_INTEGER) * 2 * sizeof(WCHAR)) + sizeof(UNICODE_NULL)) + +#define RESOURCE_HUB_CONNECTION_PATH_SIZE \ + (sizeof(RESOURCE_HUB_DEVICE_NAME_PREFIX) + \ + RESOURCE_HUB_CONNECTION_FILE_SIZE - \ + sizeof(UNICODE_NULL)) + +#define RESOURCE_HUB_CONNECTION_FILE_CHARS \ + ((RESOURCE_HUB_CONNECTION_FILE_SIZE + sizeof(WCHAR) - 1) / sizeof(WCHAR)) + +#define RESOURCE_HUB_CONNECTION_PATH_CHARS \ + ((RESOURCE_HUB_CONNECTION_PATH_SIZE + sizeof(WCHAR) - 1) / sizeof(WCHAR)) + +#define RESOURCE_HUB_FILE_SIZE RESOURCE_HUB_CONNECTION_FILE_SIZE +#define RESOURCE_HUB_PATH_SIZE RESOURCE_HUB_CONNECTION_PATH_SIZE +#define RESOURCE_HUB_FILE_CHARS RESOURCE_HUB_CONNECTION_FILE_CHARS +#define RESOURCE_HUB_PATH_CHARS RESOURCE_HUB_CONNECTION_PATH_CHARS + + + +#define FILE_DEVICE_RESOURCE_HUB (FILE_DEVICE_BUS_EXTENDER) + +// +// Definitions to interact with the resource hub. +// + +#define IOCTL_RH_QUERY_CONNECTION_PROPERTIES \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x0, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_RH_ALLOCATE_CONNECTION \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x1, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_RH_FREE_CONNECTION \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x2, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_RH_UPDATE_CONNECTION_PROPERTIES \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x3, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x4, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define IOCTL_RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY \ + CTL_CODE(FILE_DEVICE_RESOURCE_HUB, \ + 0x5, \ + METHOD_BUFFERED, \ + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +#define RH_QUERY_CONNECTION_PROPERTIES_INPUT_VERSION 1 +#define RH_QUERY_CONNECTION_PROPERTIES_OUTPUT_VERSION 1 + +#define RH_ALLOCATE_CONNECTION_INPUT_VERSION 1 +#define RH_ALLOCATE_CONNECTION_OUTPUT_VERSION 1 + +#define RH_FREE_CONNECTION_INPUT_VERSION 1 +#define RH_FREE_CONNECTION_OUTPUT_VERSION 1 + +#define RH_UPDATE_CONNECTION_PROPERTIES_INPUT_VERSION 1 +#define RH_UPDATE_CONNECTION_PROPERTIES_OUTPUT_VERSION 1 + +#define RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_VERSION 1 +#define RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_VERSION 1 + +#define RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_VERSION 1 +#define RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_VERSION 1 + +/*------------------------------------------------------------------------------ + * + * Update Connection Masks + * + *----------------------------------------------------------------------------*/ + + #define RH_UPDATE_CONNECTIONAL_MASK_ALL 0xFFFF + +/*------------------------------------------------------------------------------ + * + * Connection property definitions + * + *----------------------------------------------------------------------------*/ + +// +// Function Config +// + +#define FUNCTION_CONFIG_DESCRIPTOR 0x8d + +// +// Function config descriptor revision and type field values. +// + +#define PNP_FUNCTION_CONFIG_DESCRIPTOR_REVISION 0x1 +#define PNP_FUNCTION_CONFIG_DESCRIPTOR_REVISION_MINIMUM 0x1 + +// +// GPIO +// + +#define GPIO_INTERRUPT_IO_DESCRIPTOR 0x8c + +#ifndef INVALID_PIN_NUMBER + +#define INVALID_PIN_NUMBER 0xFFFF + +#endif + +// +// GPIO descriptor revision and type field values. +// + +#define PNP_GPIO_IRQ_DESCRIPTOR_REVISION 0x1 +#define PNP_GPIO_IRQ_DESCRIPTOR_TYPE_INTERRUPT 0x0 +#define PNP_GPIO_IRQ_DESCRIPTOR_TYPE_IO 0x1 +#define PNP_GPIO_IRQ_DESCRIPTOR_REVISION_MINIMUM (0x1) + +// +// IRQ Flags for GPIO interrupt descriptor. +// + +#define PNP_GPIO_IRQ_RESOURCE_CONSUMER_ONLY 0x01 +#define PNP_GPIO_IRQ_MODE 0x01 +#define PNP_GPIO_IRQ_POLARITY 0x06 +#define PNP_GPIO_IRQ_SHARED 0x08 +#define PNP_GPIO_IRQ_WAKE_HINT 0x10 + +#ifndef PNP_GPIO_IRQ_MODE_EDGE + +#define PNP_GPIO_IRQ_MODE_EDGE 0x01 +#define PNP_GPIO_IRQ_MODE_LEVEL 0x00 +#define PNP_GPIO_IRQ_POLARITY_LOW 0x02 +#define PNP_GPIO_IRQ_POLARITY_HIGH 0x00 +#define PNP_GPIO_IRQ_POLARITY_BOTH 0x04 + +#endif + +// +// Serial Peripheral Bus +// + +#define SERIAL_BUS_DESCRIPTOR 0x8e +#define SERIAL_BUS_DESCRIPTOR_REVISION 0x01 +#define SERIAL_BUS_DESCRIPTOR_REVISION_V2 0x02 +#define SERIAL_BUS_I2C_DESCRIPTOR_TYPE 1 +#define SERIAL_BUS_SPI_DESCRIPTOR_TYPE 2 +#define SERIAL_BUS_UART_DESCRIPTOR_TYPE 3 + +// +// General flags for SPB resources. +// + +#define SERIAL_BUS_FLAG_SHARED_DESCRIPTOR (0x4) + +/*------------------------------------------------------------------------------ + * + * IOCTL_RH_QUERY_CONNECTION_PROPERTIES parameters + * + *----------------------------------------------------------------------------*/ + +typedef enum _RH_QUERY_CONNECTION_PROPERTIES_INPUT_TYPE { + ConnectionIdType, + InterruptVectorType +} RH_QUERY_CONNECTION_PROPERTIES_INPUT_TYPE, + *PRH_QUERY_CONNECTION_PROPERTIES_INPUT_TYPE; + +typedef struct _RH_QUERY_CONNECTION_PROPERTIES_INPUT_BUFFER { + ULONG Version; + RH_QUERY_CONNECTION_PROPERTIES_INPUT_TYPE QueryType; + union { + LARGE_INTEGER ConnectionId; + ULONG InterruptVector; + } u; + +} RH_QUERY_CONNECTION_PROPERTIES_INPUT_BUFFER, + *PRH_QUERY_CONNECTION_PROPERTIES_INPUT_BUFFER; + +typedef struct _RH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER { + ULONG Version; + ULONG PropertiesLength; + UCHAR ConnectionProperties[ANYSIZE_ARRAY]; + +} RH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER, + *PRH_QUERY_CONNECTION_PROPERTIES_OUTPUT_BUFFER; + +/*------------------------------------------------------------------------------ +* +* IOCTL_RH_ALLOCATE_CONNECTION and IOCTL_RH_UPDATE_CONNECTION_PROPERTIES +* parameters +* +*----------------------------------------------------------------------------*/ + +typedef enum _RH_CONNECTION_PROPERTIES_INPUT_TYPE { + GpioIoType, + GpioInterruptType, + SpiConnectionType, + I2cConnectionType, + UartConnectionType +} RH_CONNECTION_PROPERTIES_INPUT_TYPE, + *PRH_CONNECTION_PROPERTIES_INPUT_TYPE; + +// +// _RH_GPIO_IO_CONNECTION_PARAMETERS only includes mutable parameters. +// Fields not present in this structure must not be changed. +// + +typedef struct _RH_GPIO_IO_CONNECTION_PARAMETERS { + LARGE_INTEGER ConnectionId; + + // + // The UpdateMask field is used to determine which parameters + // should be updated. Currently, all parameters are updated + // by default. + // + + USHORT UpdateMask; + + // + // Configurable parameters. + // + + UCHAR PinConfiguration; + USHORT DebounceTimeout; + USHORT DriveStrength; +} RH_GPIO_IO_CONNECTION_PARAMETERS, + *PRH_GPIO_IO_CONNECTION_PARAMETERS; + +// +// _RH_GPIO_INTERRUPT_CONNECTION_PARAMETERS only includes mutable parameters. +// Fields not present in this structure must not be changed. +// + +typedef struct _RH_GPIO_INTERRUPT_CONNECTION_PARAMETERS { + ULONG InterruptVector; + + // + // The UpdateMask field is used to determine which parameters + // should be updated. Currently, all parameters are updated + // by default. + // + + USHORT UpdateMask; + + // + // Configurable parameters. + // + + UCHAR InterruptMode; + UCHAR InterruptPolarity; + UCHAR PinConfiguration; + USHORT DebounceTimeout; +} RH_GPIO_INTERRUPT_CONNECTION_PARAMETERS, + *PRH_GPIO_INTERRUPT_CONNECTION_PARAMETERS; + +// +// _RH_SPI_CONNECTION_PARAMETERS only includes mutable parameters. +// Fields not present in this structure must not be changed. +// + +typedef struct _RH_SPI_CONNECTION_PARAMETERS { + LARGE_INTEGER ConnectionId; + + // + // The UpdateMask field is used to determine which parameters + // should be updated. Currently, all parameters are updated + // by default. + // + + USHORT UpdateMask; + + // + // Configurable parameters. + // + + USHORT DeviceSelection; + ULONG ConnectionSpeed; + UCHAR ClockPolarity; + UCHAR ClockPhase; + UCHAR DevicePolarity; + UCHAR DataBitLength; +} RH_SPI_CONNECTION_PARAMETERS, + *PRH_SPI_CONNECTION_PARAMETERS; + +// +// _RH_I2C_CONNECTION_PARAMETERS only includes mutable parameters. +// Fields not present in this structure must not be changed. +// + +typedef struct _RH_I2C_CONNECTION_PARAMETERS { + LARGE_INTEGER ConnectionId; + + // + // The UpdateMask field is used to determine which parameters + // should be updated. Currently, all parameters are updated + // by default. + // + + USHORT UpdateMask; + + // + // Configurable parameters. + // + + USHORT TypeSpecificFlags; + ULONG ConnectionSpeed; + USHORT SlaveAddress; +} RH_I2C_CONNECTION_PARAMETERS, + *PRH_I2C_CONNECTION_PARAMETERS; + +// +// _RH_UART_CONNECTION_PARAMETERS only includes mutable parameters. +// Fields not present in this structure must not be changed. +// + +typedef struct _RH_UART_CONNECTION_PARAMETERS { + LARGE_INTEGER ConnectionId; + + // + // The UpdateMask field is used to determine which parameters + // should be updated. Currently, all parameters are updated + // by default. + // + + USHORT UpdateMask; + + // + // Configurable parameters. + // + + ULONG BaudRate; + USHORT TypeSpecificFlags; + USHORT RxBufferSize; + USHORT TxBufferSize; + UCHAR Parity; +} RH_UART_CONNECTION_PARAMETERS, + *PRH_UART_CONNECTION_PARAMETERS; + +typedef struct _RH_ALLOCATE_UPDATE_CONNECTION_INPUT_BUFFER { + ULONG Version; + RH_CONNECTION_PROPERTIES_INPUT_TYPE ConnectionType; + union { + RH_GPIO_IO_CONNECTION_PARAMETERS IoConnection; + RH_GPIO_INTERRUPT_CONNECTION_PARAMETERS InterruptConnection; + RH_SPI_CONNECTION_PARAMETERS SpiConnection; + RH_I2C_CONNECTION_PARAMETERS I2cConnection; + RH_UART_CONNECTION_PARAMETERS UartConnection; + } u; +} RH_ALLOCATE_UPDATE_CONNECTION_INPUT_BUFFER, + *PRH_ALLOCATE_UPDATE_CONNECTION_INPUT_BUFFER; + +typedef struct _RH_ALLOCATE_CONNECTION_OUTPUT_BUFFER { + ULONG Version; + LARGE_INTEGER ConnectionId; +} RH_ALLOCATE_CONNECTION_OUTPUT_BUFFER, + *PRH_ALLOCATE_CONNECTION_OUTPUT_BUFFER; + +typedef struct _RH_UPDATE_CONNECTION_PROPERTIES_OUTPUT_BUFFER { + ULONG Version; +} RH_UPDATE_CONNECTION_PROPERTIES_OUTPUT_BUFFER, + *PRH_UPDATE_CONNECTION_PROPERTIES_OUTPUT_BUFFER; + +/*------------------------------------------------------------------------------ +* +* IOCTL_RH_FREE_CONNECTION parameters +* +*----------------------------------------------------------------------------*/ + +typedef struct _RH_FREE_CONNECTION_INPUT_BUFFER { + ULONG Version; + LARGE_INTEGER ConnectionId; +} RH_FREE_CONNECTION_INPUT_BUFFER, + *PRH_FREE_CONNECTION_INPUT_BUFFER; + +// +// Currently, the output buffer is empty and is left for future expansion. +// + +typedef struct _RH_FREE_CONNECTION_OUTPUT_BUFFER { + ULONG Version; +} RH_FREE_CONNECTION_OUTPUT_BUFFER, + *PRH_FREE_CONNECTION_OUTPUT_BUFFER; + +/*------------------------------------------------------------------------------ + * + * IOCTL_RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY parameters + * + *----------------------------------------------------------------------------*/ + +typedef struct _RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER { + ULONG Version; + ULONG InterruptVector; +} RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER, + *PRH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER; + +typedef struct _RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER { + ULONG Version; + UCHAR InitialPolarity; +} RH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER, + *PRH_QUERY_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER; + +/*------------------------------------------------------------------------------ + * + * IOCTL_RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY parameters + * + *----------------------------------------------------------------------------*/ + +typedef struct _RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER { + ULONG Version; + ULONG InterruptVector; + BOOLEAN InitialPolarity; +} RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER, + *PRH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_INPUT_BUFFER; + +// +// Currently this is basically empty but is left for future expansion. +// + +typedef struct _RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER { + ULONG Version; +} RH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER, + *PRH_UPDATE_ACTIVE_BOTH_INITIAL_POLARITY_OUTPUT_BUFFER; + +/*------------------------------------------------------------------------------ + * + * Connection property structures + * + *----------------------------------------------------------------------------*/ + +#include "pshpack1.h" + +// +// Length of GPIO common descriptor. +// + +#define PNP_GPIO_INTERRUPT_IO_DESCRIPTOR_LENGTH \ + sizeof(PNP_GPIO_INTERRUPT_IO_DESCRIPTOR) + +// +// GPIO IRQ and IO descriptor [fixed block] +// + +typedef struct _PNP_GPIO_INTERRUPT_IO_DESCRIPTOR { + UCHAR Tag; // 10001100B, Large item name = 0xC + USHORT Length; // Length of the descriptor = 12 (min) + UCHAR Revision; // Descriptor format revision + UCHAR DescriptorType; // Interrupt or IO descriptor + USHORT GeneralFlags; // Generic Flags + USHORT InterruptIoFlags; // Flags depending on descriptor type + UCHAR PinConfiguration; // Pull configuration for the pin + USHORT DriveStrength; // Drive strength + USHORT DebounceTimeout; // Debounce timeout + USHORT PinTableOffset; // Offset to start of pin table. + UCHAR ResourceSourceIndex; // Index of the resource producer + USHORT ResourceSourceOffset; // Offset to resource name string + USHORT VendorDataOffset; // Offset to start of vendor data + USHORT VendorDataLength; // Length of vendor data field + + // + // ...followed by Pin table (USHORT) + // ...followed RESOURCE_NAME string + // ...followed by optional vendor data. + // + // Note the offsets in the fixed block should be used to access this data. + // + +} PNP_GPIO_INTERRUPT_IO_DESCRIPTOR, *PPNP_GPIO_INTERRUPT_IO_DESCRIPTOR; + +// +// Length of function config descriptor. +// + +#define PNP_FUNCTION_CONFIG_DESCRIPTOR_LENGTH \ + sizeof(PNP_FUNCTION_CONFIG_DESCRIPTOR) + +// +// Large vendor descriptor. +// + +typedef struct _PNP_LARGE_VENDOR_DESCRIPTOR { + UCHAR Tag; // 10001100B, Large item name = 0x4 + USHORT Length; // Length of the descriptor + UCHAR SubType; // UUID specific subtype + GUID UUID; // UUID + UCHAR VendorDescriptor[ANYSIZE_ARRAY]; // Vendor descriptor data +} PNP_LARGE_VENDOR_DESCRIPTOR, *PPNP_LARGE_VENDOR_DESCRIPTOR; + +// +// Length of function config descriptor [fixed block] +// + +#define PNP_LARGE_VENDOR_DESCRIPTOR_LENGTH \ + sizeof(PNP_LARGE_VENDOR_DESCRIPTOR) + +// +// Function config descriptor [fixed block] +// + +typedef struct _PNP_FUNCTION_CONFIG_DESCRIPTOR { + UCHAR Tag; // 10001100B, Large item name = 0xD + USHORT Length; // Length of the descriptor = 12 (min) + UCHAR Revision; // Descriptor format revision + USHORT Flags; // Flags + UCHAR PinConfiguration; // Pull configuration for the pin + USHORT FunctionNumber; // Function config number for the pin + USHORT PinTableOffset; // Offset to start of pin table. + UCHAR ResourceSourceIndex; // Index of the resource producer + USHORT ResourceSourceOffset; // Offset to resource name string + USHORT VendorDataOffset; // Offset to start of vendor data + USHORT VendorDataLength; // Length of vendor data field + + // + // ...followed by Pin table (USHORT) + // ...followed RESOURCE_NAME string + // ...followed by optional vendor data. + // + // Note the offsets in the fixed block should be used to access this data. + // + +} PNP_FUNCTION_CONFIG_DESCRIPTOR, *PPNP_FUNCTION_CONFIG_DESCRIPTOR; + +// +// Length of SPB common descriptor. +// + +#define PNP_SERIAL_BUS_DESCRIPTOR_LENGTH sizeof(PNP_SERIAL_BUS_DESCRIPTOR) + +// +// Serial Peripheral Bus common descriptor +// + +typedef struct _PNP_SERIAL_BUS_DESCRIPTOR { + UCHAR Tag; + USHORT Length; + UCHAR RevisionId; + UCHAR ResourceSourceIndex; + UCHAR SerialBusType; + UCHAR GeneralFlags; + USHORT TypeSpecificFlags; + UCHAR TypeSpecificRevisionId; + USHORT TypeDataLength; +} PNP_SERIAL_BUS_DESCRIPTOR, *PPNP_SERIAL_BUS_DESCRIPTOR; + +#include "poppack.h" + +/*------------------------------------------------------------------------------ + * + * Resource Hub Helper Macros + * + *----------------------------------------------------------------------------*/ + +#ifdef RESHUB_USE_HELPER_ROUTINES + +/*------------------------------------------------------------------------------ + * + * For Connections + * + *----------------------------------------------------------------------------*/ + +#ifdef UMDF_DRIVER + +_When_(SUCCEEDED(hr), _Post_satisfies_(NT_SUCCESS(return))) +_When_(FAILED(hr), _Post_satisfies_(!NT_SUCCESS(return))) +NTSTATUS +FORCEINLINE +RESOURCE_HUB_HRESULT_TO_NTSTATUS ( + _In_ HRESULT hr + ) +{ + switch(hr) + { + + case STRSAFE_E_INVALID_PARAMETER: + return STATUS_INVALID_PARAMETER; + + case STRSAFE_E_INSUFFICIENT_BUFFER: + return STATUS_BUFFER_OVERFLOW; + + case STRSAFE_E_END_OF_FILE: + return STATUS_END_OF_FILE; + + default: + if(SUCCEEDED(hr)) { + return STATUS_SUCCESS; + + } else { + return STATUS_UNSUCCESSFUL; + } + } +} + +static +NTSTATUS +RESOURCE_HUB_STRING_PRINTF ( + _Inout_ STRSAFE_LPWSTR DestinationString, + _In_ size_t DestinationSizeInBytes, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ... + ) +{ + + HRESULT hr; + va_list argList; + + va_start(argList, pszFormat); + hr = StringCbVPrintfExW(DestinationString, + DestinationSizeInBytes, + NULL, + NULL, + 0, + pszFormat, + argList); + + return RESOURCE_HUB_HRESULT_TO_NTSTATUS(hr); +} + +static +NTSTATUS +RESOURCE_HUB_UNICODE_STRING_PRINTF ( + _Inout_ PUNICODE_STRING DestinationString, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ... + ) +{ + + HRESULT hr; + STRSAFE_LPWSTR pszDestEnd; + va_list argList; + + va_start(argList, pszFormat); + hr = StringCbVPrintfExW(DestinationString->Buffer, + DestinationString->MaximumLength, + &pszDestEnd, + NULL, + 0, + pszFormat, + argList); + + if (SUCCEEDED(hr)) { + DestinationString->Length = (USHORT)( + (pszDestEnd - DestinationString->Buffer) * sizeof(WCHAR)); + } + + return RESOURCE_HUB_HRESULT_TO_NTSTATUS(hr); +} + +#if (UMDF_DRIVER) + +NTSTATUS +FORCEINLINE +RESOURCE_HUB_UNICODE_STRING_INIT ( + _Out_ PUNICODE_STRING DestinationString, + _In_opt_ STRSAFE_LPCWSTR pszSrc + ) +{ + + HRESULT hr; + size_t cbLength; + + if (pszSrc) { + hr = StringCbLengthW(pszSrc, STRSAFE_MAX_CCH * sizeof(TCHAR), &cbLength); + if (SUCCEEDED(hr)) { + DestinationString->Length = (USHORT)cbLength; + DestinationString->MaximumLength = (USHORT)(cbLength + sizeof(wchar_t)); + DestinationString->Buffer = (LPWSTR)pszSrc; + } + } + else { + hr = STATUS_SUCCESS; + DestinationString->Length = 0; + DestinationString->MaximumLength = 0; + DestinationString->Buffer = NULL; + } + + return RESOURCE_HUB_HRESULT_TO_NTSTATUS(hr); +} + +#else + +#define RESOURCE_HUB_UNICODE_STRING_INIT RtlUnicodeStringInit + +#endif + +#ifdef DBG + +#define RESOURCE_HUB_ASSERT(_exp) \ + ((!(_exp)) ? \ + (__annotation(L"Debug", L"AssertFail", L#_exp), \ + DebugBreak(), FALSE) : \ + TRUE) + +#else + +#define RESOURCE_HUB_ASSERT(_exp) + +#endif // DBG + +#else + +static +NTSTATUS +RESOURCE_HUB_STRING_PRINTF ( + _Inout_ NTSTRSAFE_PWSTR DestinationString, + _In_ size_t DestinationSizeInBytes, + _In_ _Printf_format_string_ NTSTRSAFE_PWSTR pszFormat, + ... + ) +{ + + va_list argList; + + va_start(argList, pszFormat); + return RtlStringCbVPrintfExW(DestinationString, + DestinationSizeInBytes, + NULL, + NULL, + 0, + pszFormat, + argList); +} + +static +NTSTATUS +RESOURCE_HUB_UNICODE_STRING_PRINTF ( + _Inout_ PUNICODE_STRING DestinationString, + _In_ _Printf_format_string_ NTSTRSAFE_PWSTR pszFormat, + ... + ) +{ + + va_list argList; + NTSTRSAFE_PWSTR pszDestEnd; + NTSTATUS status; + + va_start(argList, pszFormat); + status = RtlStringCbVPrintfExW(DestinationString->Buffer, + DestinationString->MaximumLength, + &pszDestEnd, + NULL, + 0, + pszFormat, + argList); + + if (NT_SUCCESS(status)) { + DestinationString->Length = (USHORT)( + (pszDestEnd - DestinationString->Buffer) * sizeof(WCHAR)); + } + + return status; +} + +#define RESOURCE_HUB_UNICODE_STRING_INIT RtlUnicodeStringInit +#define RESOURCE_HUB_ASSERT(_exp) NT_ASSERT(_exp) + +#endif + +NTSTATUS +FORCEINLINE +RESOURCE_HUB_ID_TO_FILE_NAME( + _In_ ULONG IdLowPart, + _In_ ULONG IdHighPart, + _Out_writes_bytes_(RESOURCE_HUB_CONNECTION_FILE_SIZE) + PWCHAR FileName + ) +{ + + LARGE_INTEGER Id; + + Id.LowPart = IdLowPart; + Id.HighPart = IdHighPart; + return RESOURCE_HUB_STRING_PRINTF(FileName, + RESOURCE_HUB_FILE_SIZE, + L"%0*I64x", + (ULONG)(sizeof(LARGE_INTEGER) * 2), + Id.QuadPart); + +} + +NTSTATUS +FORCEINLINE +RESOURCE_HUB_CREATE_PATH_FROM_ID ( + _Inout_ PUNICODE_STRING FileName, + _In_ ULONG IdLowPart, + _In_ ULONG IdHighPart + ) +{ + + WCHAR FileNameSuffix[RESOURCE_HUB_CONNECTION_FILE_CHARS]; + NTSTATUS Status; + + RESOURCE_HUB_ASSERT(FileName->MaximumLength >= + RESOURCE_HUB_CONNECTION_PATH_SIZE); + + Status = RESOURCE_HUB_ID_TO_FILE_NAME(IdLowPart, + IdHighPart, + FileNameSuffix); + + if (NT_SUCCESS(Status)) { + Status = RESOURCE_HUB_UNICODE_STRING_PRINTF( + FileName, + L"%s%s", + RESOURCE_HUB_DEVICE_NAME_PREFIX, + FileNameSuffix); + } + + return Status; +} + +NTSTATUS +FORCEINLINE +RESOURCE_HUB_ID_FROM_FILE_NAME_WITH_SUBPATH ( + _In_z_ LPCWSTR FileName, + _Out_ PLARGE_INTEGER Id, + _Out_ LPWSTR *NextPathElement + ) +{ + + UNICODE_STRING HighPart; + USHORT Index; +#if !defined(UMDF_DRIVER) || (UMDF_DRIVER >= 2) + UNICODE_STRING LowPart; +#endif + NTSTATUS Status; + + Id->QuadPart = 0; + *NextPathElement = (LPWSTR)FileName; + + Status = RESOURCE_HUB_UNICODE_STRING_INIT(&HighPart, FileName); + if (!NT_SUCCESS(Status)) { + return Status; + + } else if ((RESOURCE_HUB_CONNECTION_FILE_SIZE - sizeof(UNICODE_NULL)) > + HighPart.Length) { + + Status = STATUS_INVALID_PARAMETER; + return Status; + + } else { + HighPart.Length = (RESOURCE_HUB_CONNECTION_FILE_SIZE - sizeof(UNICODE_NULL)); + } + + for (Index = 0; Index < (HighPart.Length / sizeof(WCHAR)); ++Index) { + if ((HighPart.Buffer[Index] >= L'0' && HighPart.Buffer[Index] <= L'9') || + (HighPart.Buffer[Index] >= L'a' && HighPart.Buffer[Index] <= L'f') || + (HighPart.Buffer[Index] >= L'A' && HighPart.Buffer[Index] <= L'F')) { + + continue; + + } else { + + + Status = STATUS_INVALID_PARAMETER; + break; + } + } + + if (!NT_SUCCESS(Status)) { + return Status; + } + + *NextPathElement = &HighPart.Buffer[Index]; + if ((*NextPathElement)[0] != L'\\' && (*NextPathElement)[0] != L'\0') { + return STATUS_INVALID_PARAMETER; + } + +#if defined(UMDF_DRIVER) && (UMDF_DRIVER == 1) + + Id->QuadPart = _wcstoi64(HighPart.Buffer, NextPathElement, 16); + + RESOURCE_HUB_ASSERT( + ((ULONG_PTR)*NextPathElement - (ULONG_PTR)HighPart.Buffer) == + HighPart.Length); + +#else + + // + // Split into two strings of eight characters each to translate into two + // 32-bit integers. + // + + HighPart.Length = 2 * sizeof(Id->HighPart) * sizeof(WCHAR); + LowPart.Buffer = (PWSTR)((ULONG_PTR)HighPart.Buffer + HighPart.Length); + LowPart.MaximumLength = HighPart.MaximumLength - HighPart.Length; + LowPart.Length = 2 * sizeof(Id->LowPart) * sizeof(WCHAR); + + Status = RtlUnicodeStringToInteger(&HighPart, 16, (PULONG)&Id->HighPart); + if (!NT_SUCCESS(Status)) { + return Status; + } + + Status = RtlUnicodeStringToInteger(&LowPart, 16, (PULONG)&Id->LowPart); + if (!NT_SUCCESS(Status)) { + return Status; + } + +#endif + + if ((*NextPathElement)[0] == L'\\') { + ++(*NextPathElement); + } + + return Status; +} + +NTSTATUS +FORCEINLINE +RESOURCE_HUB_ID_FROM_FILE_NAME ( + _In_z_ LPCWSTR FileName, + _Out_ PLARGE_INTEGER Id + ) +{ + + LPWSTR NextPathElement; + NTSTATUS Status; + + Status = RESOURCE_HUB_ID_FROM_FILE_NAME_WITH_SUBPATH(FileName, + Id, + &NextPathElement); + + return Status; +} + + +#endif // RESHUB_USE_HELPER_ROUTINES + +#ifdef __cplusplus +} +#endif + +#endif // NTDDI_VERSION + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + + +#endif // __RES_HUB_H__ + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpc.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpc.h new file mode 100644 index 0000000000000000000000000000000000000000..12a7be1518eb22e8f609bdc5edd052afbf1fd83d --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpc.h @@ -0,0 +1,231 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpc.h + +Abstract: + + Master include file for RPC applications. + +--*/ + +#if !defined( RPC_NO_WINDOWS_H ) && !defined( MAC ) && !defined( _MAC ) && !defined(_KRPCENV_) +/* + * Pull in WINDOWS.H if necessary + */ +#ifndef _INC_WINDOWS +#include +#endif /* _INC_WINDOWS */ +#endif // RPC_NO_WINDOWS_H + +#ifndef __RPC_H__ +#define __RPC_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +//------------------------------------------------------------- +// platform specific defines +//------------------------------------------------------------- + +//------------------- MAC --------------------------- +#if defined( MAC ) || defined( _MAC ) + +#define __RPC_MAC__ +// Set the packing level for RPC structures. + +#include + +//------------------- WIN32 --------------------------- +#else // win32 platforms + +#include + +#if defined(_M_ARM64) +#define __RPC_ARM64__ +#elif defined(_M_IA64) || defined(_M_AMD64) +#define __RPC_WIN64__ +#elif defined(_ARM_) +#define __RPC_ARM32__ +#else +#define __RPC_WIN32__ +#endif // defined(_M_ARM64) + +#endif // defined( MAC ) || defined( _MAC ) + +#if defined(__RPC_WIN64__) || defined(__RPC_ARM64__) +#include +#endif + +#ifndef __MIDL_USER_DEFINED +#define midl_user_allocate MIDL_user_allocate +#define midl_user_free MIDL_user_free +#define __MIDL_USER_DEFINED +#endif + +typedef void * I_RPC_HANDLE; + +// NTSTATUS is also long, so this definition is valid +// for both user mode and kernel mode +#if defined(__specstrings) +typedef _Return_type_success_(return == 0) long RPC_STATUS; +#else +typedef long RPC_STATUS; +#endif + +#if defined(__RPC_WIN32__) || defined(__RPC_WIN64__) || defined(__RPC_ARM32__) || defined(__RPC_ARM64__) +#define RPC_UNICODE_SUPPORTED +#endif + +#if !defined(__RPC_MAC__) && ( (_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED) ) +# define __RPC_API __stdcall +# define __RPC_USER __stdcall +# define __RPC_STUB __stdcall +# define RPC_ENTRY __stdcall +#else // Not Win32/Win64 +# define __RPC_API +# define __RPC_USER +# define __RPC_STUB +# define RPC_ENTRY +#endif + +#define __RPC_FAR + +// Some RPC platforms don't define DECLSPEC_IMPORT +#if !defined(DECLSPEC_IMPORT) +#if (defined(_M_MRX000) || defined(_M_IX86) || defined(_M_IA64) || defined(_M_AMD64) || defined(_M_ARM) || defined(_M_ARM64)) && !defined(MIDL_PASS) +#define DECLSPEC_IMPORT __declspec(dllimport) +#else +#define DECLSPEC_IMPORT +#endif +#endif + +#if !defined(_RPCRT4_) && !defined(_KRPCENV_) +#define RPCRTAPI DECLSPEC_IMPORT +#else +#define RPCRTAPI +#endif + +#if !defined(_RPCNS4_) +#define RPCNSAPI DECLSPEC_IMPORT +#else +#define RPCNSAPI +#endif + +#ifdef __RPC_MAC__ + +#include + +#define RPCXCWORD (sizeof(jmp_buf)/sizeof(int)) + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning( disable: 4005 ) +#include +#include +#include +#include +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning( default : 4005 ) +#endif + +typedef void (RPC_ENTRY *MACYIELDCALLBACK)(/*OSErr*/ short *) ; +RPC_STATUS RPC_ENTRY +RpcMacSetYieldInfo( + MACYIELDCALLBACK pfnCallback) ; + +#if !defined(UNALIGNED) +#define UNALIGNED +#endif + +#include + +#else // __RPC_MAC__ + +#include +#if !defined(_KRPCENV_) +#include +#endif // _KRPCENV_ +#include +#include +#if !defined(_KRPCENV_) +#include +#endif // _KRPCENV_ + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#define RpcTryExcept \ + __try \ + { + +// trystmts + +#define RpcExcept(expr) \ + } \ + __except (expr) \ + { + +// exceptstmts + +#define RpcEndExcept \ + } + +#define RpcTryFinally \ + __try \ + { + +// trystmts + +#define RpcFinally \ + } \ + __finally \ + { + +// finallystmts + +#define RpcEndFinally \ + } + +#define RpcExceptionCode() GetExceptionCode() +#define RpcAbnormalTermination() AbnormalTermination() + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // __RPC_MAC__ + +// rpcasync.h is now RPC_NO_WINDOWS_H aware, but we can't start including it always +// as it does still require windef.h which could clash with another header. +// +// Parsing of the below test: +// don't include rpcasync.h if either RPC_NO_WINDOWS_H or __RPC_MAC__ is set, except that setting +// RPC_NEED_RPCASYNC_H overrides RPC_NO_WINDOWS_H. +// In any case, if _KRPCENV_ is set, include rpcasync.h regardless of any of the above being set. +#if ((!defined( RPC_NO_WINDOWS_H ) || defined(RPC_NEED_RPCASYNC_H)) && !defined(__RPC_MAC__)) || defined(_KRPCENV_) + +#include + +#endif // RPC_NO_WINDOWS_H et al. + +#if defined(__RPC_WIN64__) || defined(__RPC_ARM64__) +#include +#endif + +#ifdef __cplusplus +} +#endif + +#endif // __RPC_H__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcasync.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcasync.h new file mode 100644 index 0000000000000000000000000000000000000000..8597e21530d88158bf6b1bb0a86142f879bbeb8a --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcasync.h @@ -0,0 +1,784 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpcasync.h + +Abstract: + + This module contains the RPC runtime APIs needed to use + [async] RPC features. + +--*/ + +#ifndef __RPCASYNC_H__ +#define __RPCASYNC_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#if defined(__RPC_WIN64__) +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + + +#if defined(_KRPCENV_) + +#include + +#endif // _KRPCENV_ + +#if defined(RPC_NO_WINDOWS_H) || defined(_KRPCENV_) + +// We've gotta have windef.h--can't live without it. + +#include + +#endif // RPC_NO_WINDOWS_H || _KRPCENV_ + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4820) // padding added after data member +#endif + +#define RPC_ASYNC_VERSION_1_0 sizeof(RPC_ASYNC_STATE) + +typedef +enum _RPC_NOTIFICATION_TYPES +{ + RpcNotificationTypeNone, + RpcNotificationTypeEvent, +#if !defined(_KRPCENV_) + RpcNotificationTypeApc, + RpcNotificationTypeIoc, + RpcNotificationTypeHwnd, +#endif + RpcNotificationTypeCallback +} RPC_NOTIFICATION_TYPES; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef +enum _RPC_ASYNC_EVENT { + RpcCallComplete, + RpcSendComplete, + RpcReceiveComplete, + RpcClientDisconnect, + RpcClientCancel + } RPC_ASYNC_EVENT; + +#else // (NTDDI_VERSION >= NTDDI_VISTA) + +typedef +enum _RPC_ASYNC_EVENT { + RpcCallComplete, + RpcSendComplete, + RpcReceiveComplete, + RpcClientDisconnect + } RPC_ASYNC_EVENT; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +struct _RPC_ASYNC_STATE; + +typedef void RPC_ENTRY +RPCNOTIFICATION_ROUTINE ( + struct _RPC_ASYNC_STATE *pAsync, + void *Context, + RPC_ASYNC_EVENT Event); +typedef RPCNOTIFICATION_ROUTINE *PFN_RPCNOTIFICATION_ROUTINE; + +typedef union _RPC_ASYNC_NOTIFICATION_INFO { +#if !defined(_KRPCENV_) + // + // Notification by APC + // + struct { + PFN_RPCNOTIFICATION_ROUTINE NotificationRoutine; + HANDLE hThread; + } APC; + + +#if !defined(RPC_NO_WINDOWS_H) || defined (_WINBASE_) + + // + // Notification by IO completion port + // + struct { + HANDLE hIOPort; + DWORD dwNumberOfBytesTransferred; + DWORD_PTR dwCompletionKey; + LPOVERLAPPED lpOverlapped; + } IOC; + +#endif // !RPC_NO_WINDOWS_H || _WINBASE_ +#if !defined(RPC_NO_WINDOWS_H) + // + // Notification by window message + // + struct { + HWND hWnd; + UINT Msg; + } HWND; + +#endif // RPC_NO_WINDOWS_H +#endif // _KRPCENV_ + + + #if !defined(_KRPCENV_) + // + // Notification by event + // + HANDLE hEvent; + #else // _KRPCENV_ + // + // Notification by event + // + PKEVENT Event; + #endif // _KRPCENV_ + + // + // Notification by callback function + // + // This option is available only to OLE + // + PFN_RPCNOTIFICATION_ROUTINE NotificationRoutine; +} RPC_ASYNC_NOTIFICATION_INFO, *PRPC_ASYNC_NOTIFICATION_INFO; + +typedef struct _RPC_ASYNC_STATE { + unsigned int Size; // size of this structure + unsigned long Signature; + long Lock; + unsigned long Flags; + void *StubInfo; + void *UserInfo; + void *RuntimeInfo; + RPC_ASYNC_EVENT Event; + + RPC_NOTIFICATION_TYPES NotificationType; + RPC_ASYNC_NOTIFICATION_INFO u; + + LONG_PTR Reserved[4]; + } RPC_ASYNC_STATE, *PRPC_ASYNC_STATE; + +// Possible values for Flags +#define RPC_C_NOTIFY_ON_SEND_COMPLETE 0x1 +#define RPC_C_INFINITE_TIMEOUT INFINITE + +#define RpcAsyncGetCallHandle(pAsync) (((PRPC_ASYNC_STATE) pAsync)->RuntimeInfo) + +#if !defined(_KRPCENV_) +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncRegisterInfo ( + _In_ PRPC_ASYNC_STATE pAsync + ) ; +#endif + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncInitializeHandle ( + _Out_writes_bytes_(Size) PRPC_ASYNC_STATE pAsync, + _In_ unsigned int Size + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncGetCallStatus ( + _In_ PRPC_ASYNC_STATE pAsync + ) ; + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncCompleteCall ( + _Inout_ PRPC_ASYNC_STATE pAsync, + _Out_opt_ void *Reply + ) ; + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncAbortCall ( + _Inout_ PRPC_ASYNC_STATE pAsync, + _In_ unsigned long ExceptionCode + ) ; + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcAsyncCancelCall ( + _Inout_ PRPC_ASYNC_STATE pAsync, + _In_ BOOL fAbort + ) ; + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +// EEINFO needs k-mode or needs winbase.h +#if !defined(RPC_NO_WINDOWS_H) || defined(_KRPCENV_) || defined(_WINBASE_) + +typedef enum tagExtendedErrorParamTypes +{ + eeptAnsiString = 1, + eeptUnicodeString, + eeptLongVal, + eeptShortVal, + eeptPointerVal, + eeptNone, + eeptBinary +} ExtendedErrorParamTypes; + +#define MaxNumberOfEEInfoParams 4 +#define RPC_EEINFO_VERSION 1 + +typedef struct tagBinaryParam +{ + void *Buffer; + short Size; +} BinaryParam; + +typedef struct tagRPC_EE_INFO_PARAM +{ + ExtendedErrorParamTypes ParameterType; + union + { + LPSTR AnsiString; + LPWSTR UnicodeString; + long LVal; + short SVal; + ULONGLONG PVal; + BinaryParam BVal; + } u; +} RPC_EE_INFO_PARAM; + +#define EEInfoPreviousRecordsMissing 1 +#define EEInfoNextRecordsMissing 2 +#define EEInfoUseFileTime 4 + +#define EEInfoGCCOM 11 +#if (NTDDI_VERSION >= NTDDI_WS03) +#define EEInfoGCFRS 12 +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +typedef struct tagRPC_EXTENDED_ERROR_INFO +{ + ULONG Version; + LPWSTR ComputerName; + ULONG ProcessID; + union + { +#if !defined(_KRPCENV_) + SYSTEMTIME SystemTime; + FILETIME FileTime; +#else // _KRPCENV_ + LARGE_INTEGER KernelTime; +#endif // _KRPCENV_ + } u; + ULONG GeneratingComponent; + ULONG Status; + USHORT DetectionLocation; + USHORT Flags; + int NumberOfParameters; + RPC_EE_INFO_PARAM Parameters[MaxNumberOfEEInfoParams]; +} RPC_EXTENDED_ERROR_INFO; + +typedef struct tagRPC_ERROR_ENUM_HANDLE +{ + ULONG Signature; + void *CurrentPos; + void *Head; +} RPC_ERROR_ENUM_HANDLE; + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorStartEnumeration ( + _Out_ RPC_ERROR_ENUM_HANDLE *EnumHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorGetNextRecord ( + _In_ RPC_ERROR_ENUM_HANDLE *EnumHandle, + _In_ BOOL CopyStrings, + _Out_ RPC_EXTENDED_ERROR_INFO *ErrorInfo + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorEndEnumeration ( + _Inout_ RPC_ERROR_ENUM_HANDLE *EnumHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorResetEnumeration ( + _Inout_ RPC_ERROR_ENUM_HANDLE *EnumHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorGetNumberOfRecords ( + _In_ RPC_ERROR_ENUM_HANDLE *EnumHandle, + _Out_ int *Records + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorSaveErrorInfo ( + _In_ RPC_ERROR_ENUM_HANDLE *EnumHandle, + _Outptr_result_bytebuffer_(*BlobSize) PVOID *ErrorBlob, + _Out_ size_t *BlobSize + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorLoadErrorInfo ( + _In_reads_bytes_(BlobSize) PVOID ErrorBlob, + _In_ size_t BlobSize, + _Out_ RPC_ERROR_ENUM_HANDLE *EnumHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcErrorAddRecord ( + _In_ RPC_EXTENDED_ERROR_INFO *ErrorInfo + ); + +RPCRTAPI +void +RPC_ENTRY +RpcErrorClearInformation ( + void + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#endif // !RPC_NO_WINDOWS_H || _KRPCENV_ || _WINBASE_ + +#if !defined(_KRPCENV_) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcAsyncCleanupThread ( + _In_ DWORD dwTimeout + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcGetAuthorizationContextForClient ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _In_ BOOL ImpersonateOnReturn, + _In_opt_ PVOID Reserved1, + _In_opt_ PLARGE_INTEGER pExpirationTime, + _In_ LUID Reserved2, + _In_ DWORD Reserved3, + _In_opt_ PVOID Reserved4, + _Out_ PVOID *pAuthzClientContext + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcFreeAuthorizationContext ( + _Inout_ PVOID *pAuthzClientContext + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSsContextLockExclusive ( + _In_opt_ RPC_BINDING_HANDLE ServerBindingHandle, + _In_ PVOID UserContext + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSsContextLockShared ( + _In_ RPC_BINDING_HANDLE ServerBindingHandle, + _In_ PVOID UserContext + ); + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef enum tagRpcLocalAddressFormat +{ + rlafInvalid = 0, + rlafIPv4, + rlafIPv6 +} RpcLocalAddressFormat; + +typedef struct _RPC_CALL_LOCAL_ADDRESS_V1 +{ + unsigned int Version; + void *Buffer; + unsigned long BufferSize; + RpcLocalAddressFormat AddressFormat; +} RPC_CALL_LOCAL_ADDRESS_V1, *PRPC_CALL_LOCAL_ADDRESS_V1; + +#if ( (NTDDI_VERSION >= NTDDI_VISTA) && (NTDDI_VERSION < NTDDI_WIN8) ) +#define RPC_CALL_ATTRIBUTES_VERSION (2) +#endif // ( (NTDDI_VERSION >= NTDDI_VISTA) && (NTDDI_VERSION < NTDDI_WIN8) ) + +#define RPC_QUERY_SERVER_PRINCIPAL_NAME (0x02) +#define RPC_QUERY_CLIENT_PRINCIPAL_NAME (0x04) +#define RPC_QUERY_CALL_LOCAL_ADDRESS (0x08) +#define RPC_QUERY_CLIENT_PID (0x10) +#define RPC_QUERY_IS_CLIENT_LOCAL (0x20) +#define RPC_QUERY_NO_AUTH_REQUIRED (0x40) +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define RPC_CALL_ATTRIBUTES_VERSION (3) +#define RPC_QUERY_CLIENT_ID (0x80) +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if ( (NTDDI_VERSION >= NTDDI_WINXP) && (NTDDI_VERSION < NTDDI_VISTA) ) +#define RPC_CALL_ATTRIBUTES_VERSION (1) +#define RPC_QUERY_SERVER_PRINCIPAL_NAME (2) +#define RPC_QUERY_CLIENT_PRINCIPAL_NAME (4) +#endif // ( (NTDDI_VERSION >= NTDDI_WINXP) && (NTDDI_VERSION < NTDDI_VISTA) ) + +typedef struct tagRPC_CALL_ATTRIBUTES_V1_W +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned short *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned short *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; +} RPC_CALL_ATTRIBUTES_V1_W; + +typedef struct tagRPC_CALL_ATTRIBUTES_V1_A +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned char *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned char *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; +} RPC_CALL_ATTRIBUTES_V1_A; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +// CallStatus bit fields +#define RPC_CALL_STATUS_CANCELLED 0x01 +#define RPC_CALL_STATUS_DISCONNECTED 0x02 + +typedef enum tagRpcCallType +{ + rctInvalid = 0, + rctNormal, + rctTraining, + rctGuaranteed +} RpcCallType; + +typedef enum tagRpcCallClientLocality +{ + rcclInvalid = 0, + rcclLocal, + rcclRemote, + rcclClientUnknownLocality +} RpcCallClientLocality; + + +typedef struct tagRPC_CALL_ATTRIBUTES_V2_W +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned short *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned short *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; + BOOL KernelModeCaller; + unsigned long ProtocolSequence; + RpcCallClientLocality IsClientLocal; + HANDLE ClientPID; + unsigned long CallStatus; + RpcCallType CallType; + RPC_CALL_LOCAL_ADDRESS_V1 *CallLocalAddress; // one of the CallLocalAddress flavors + unsigned short OpNum; + UUID InterfaceUuid; +} RPC_CALL_ATTRIBUTES_V2_W; + +typedef struct tagRPC_CALL_ATTRIBUTES_V2_A +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned char *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned char *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; + BOOL KernelModeCaller; + unsigned long ProtocolSequence; + unsigned long IsClientLocal; + HANDLE ClientPID; + unsigned long CallStatus; + RpcCallType CallType; + RPC_CALL_LOCAL_ADDRESS_V1 *CallLocalAddress; // one of the CallLocalAddress flavors + unsigned short OpNum; + UUID InterfaceUuid; +} RPC_CALL_ATTRIBUTES_V2_A; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef struct tagRPC_CALL_ATTRIBUTES_V3_W +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned short *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned short *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; + BOOL KernelModeCaller; + unsigned long ProtocolSequence; + RpcCallClientLocality IsClientLocal; + HANDLE ClientPID; + unsigned long CallStatus; + RpcCallType CallType; + RPC_CALL_LOCAL_ADDRESS_V1 *CallLocalAddress; // one of the CallLocalAddress flavors + unsigned short OpNum; + UUID InterfaceUuid; + unsigned long ClientIdentifierBufferLength; + unsigned char *ClientIdentifier; +} RPC_CALL_ATTRIBUTES_V3_W; + +typedef struct tagRPC_CALL_ATTRIBUTES_V3_A +{ + unsigned int Version; + unsigned long Flags; + unsigned long ServerPrincipalNameBufferLength; + unsigned char *ServerPrincipalName; + unsigned long ClientPrincipalNameBufferLength; + unsigned char *ClientPrincipalName; + unsigned long AuthenticationLevel; + unsigned long AuthenticationService; + BOOL NullSession; + BOOL KernelModeCaller; + unsigned long ProtocolSequence; + unsigned long IsClientLocal; + HANDLE ClientPID; + unsigned long CallStatus; + RpcCallType CallType; + RPC_CALL_LOCAL_ADDRESS_V1 *CallLocalAddress; // one of the CallLocalAddress flavors + unsigned short OpNum; + UUID InterfaceUuid; + unsigned long ClientIdentifierBufferLength; + unsigned char *ClientIdentifier; +} RPC_CALL_ATTRIBUTES_V3_A; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInqCallAttributesW ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Inout_ void *RpcCallAttributes + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInqCallAttributesA ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Inout_ void *RpcCallAttributes + ); + +#ifdef UNICODE +# define RPC_CALL_ATTRIBUTES_V1 RPC_CALL_ATTRIBUTES_V1_W +#if (NTDDI_VERSION >= NTDDI_VISTA) +# define RPC_CALL_ATTRIBUTES_V2 RPC_CALL_ATTRIBUTES_V2_W +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +#if (NTDDI_VERSION >= NTDDI_WIN8) +# define RPC_CALL_ATTRIBUTES_V3 RPC_CALL_ATTRIBUTES_V3_W +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +# define RpcServerInqCallAttributes RpcServerInqCallAttributesW +#else +# define RPC_CALL_ATTRIBUTES_V1 RPC_CALL_ATTRIBUTES_V1_A +#if (NTDDI_VERSION >= NTDDI_VISTA) +# define RPC_CALL_ATTRIBUTES_V2 RPC_CALL_ATTRIBUTES_V2_A +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +#if (NTDDI_VERSION >= NTDDI_WIN8) +# define RPC_CALL_ATTRIBUTES_V3 RPC_CALL_ATTRIBUTES_V3_A +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +# define RpcServerInqCallAttributes RpcServerInqCallAttributesA +#endif // !UNICODE + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef RPC_CALL_ATTRIBUTES_V3 RPC_CALL_ATTRIBUTES; +#elif (NTDDI_VERSION >= NTDDI_VISTA) +typedef RPC_CALL_ATTRIBUTES_V2 RPC_CALL_ATTRIBUTES; +#else +typedef RPC_CALL_ATTRIBUTES_V1 RPC_CALL_ATTRIBUTES; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +// can be used as flags in a bitmask too +typedef enum _RPC_NOTIFICATIONS +{ + RpcNotificationCallNone = 0, + RpcNotificationClientDisconnect = 1, + RpcNotificationCallCancel = 2 // internal for Windows +} RPC_NOTIFICATIONS; + +#define RpcNotificationCallStatusChange RpcNotificationClientDisconnect + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerSubscribeForNotification ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ RPC_NOTIFICATIONS Notification, + _In_ RPC_NOTIFICATION_TYPES NotificationType, + _In_ RPC_ASYNC_NOTIFICATION_INFO *NotificationInfo + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUnsubscribeForNotification ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ RPC_NOTIFICATIONS Notification, + _Out_ unsigned long *NotificationsQueued + ); + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +#endif // _KRPCENV_ + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingBind ( + _In_opt_ PRPC_ASYNC_STATE pAsync, + _In_ RPC_BINDING_HANDLE Binding, + _In_ RPC_IF_HANDLE IfSpec + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingUnbind ( + _In_ RPC_BINDING_HANDLE Binding + ); + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) +// +// Internal APIs +// +_Must_inspect_result_ +RPC_STATUS RPC_ENTRY +I_RpcAsyncSetHandle ( + _In_ PRPC_MESSAGE Message, + _In_ PRPC_ASYNC_STATE pAsync + ); + +_Must_inspect_result_ +RPC_STATUS RPC_ENTRY +I_RpcAsyncAbortCall ( + _In_ PRPC_ASYNC_STATE pAsync, + _In_ unsigned long ExceptionCode + ) ; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +int +RPC_ENTRY +I_RpcExceptionFilter ( + _In_ unsigned long ExceptionCode + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqClientTokenAttributes ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_opt_ LUID * TokenId, + _Out_opt_ LUID * AuthenticationId, + _Out_opt_ LUID * ModifiedId + ); + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#if defined(__RPC_WIN64__) +#include +#endif + +#endif /* __RPCASYNC_H__ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdce.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdce.h new file mode 100644 index 0000000000000000000000000000000000000000..e3f1c4421b93a4e49399ec2854146c3fa757208f --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdce.h @@ -0,0 +1,3364 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpcdce.h + +Abstract: + + This module contains the DCE RPC runtime APIs. + +--*/ + +#ifndef __RPCDCE_H__ +#define __RPCDCE_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#pragma warning(disable:4820) // padding added after data member +#endif + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef IN +#define IN +#endif + +#ifndef OUT +#define OUT +#endif + +#ifndef OPTIONAL +#define OPTIONAL +#endif + +#ifndef DECLSPEC_NORETURN +#if (_MSC_VER >= 1200) && !defined(MIDL_PASS) +#define DECLSPEC_NORETURN __declspec(noreturn) +#else +#define DECLSPEC_NORETURN +#endif +#endif + +/*typedef char small;*/ +/*typedef unsigned char byte;*/ +/*typedef unsigned char boolean;*/ + +#include + +typedef _Null_terminated_ unsigned char __RPC_FAR * RPC_CSTR; + +#if defined(RPC_USE_NATIVE_WCHAR) && defined(_NATIVE_WCHAR_T_DEFINED) +typedef _Null_terminated_ wchar_t __RPC_FAR * RPC_WSTR; +typedef _Null_terminated_ const wchar_t * RPC_CWSTR; +#else +typedef _Null_terminated_ unsigned short __RPC_FAR * RPC_WSTR; +typedef _Null_terminated_ const unsigned short * RPC_CWSTR; +#endif + +typedef I_RPC_HANDLE RPC_BINDING_HANDLE; +typedef RPC_BINDING_HANDLE handle_t; +#define rpc_binding_handle_t RPC_BINDING_HANDLE + +#ifndef GUID_DEFINED +#include +#endif /* GUID_DEFINED */ + +#ifndef UUID_DEFINED +#define UUID_DEFINED +typedef GUID UUID; +#ifndef uuid_t +#define uuid_t UUID +#endif +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +typedef struct _RPC_BINDING_VECTOR +{ + unsigned long Count; + _Field_size_(Count) RPC_BINDING_HANDLE BindingH[1]; +} RPC_BINDING_VECTOR; +#ifndef rpc_binding_vector_t +#define rpc_binding_vector_t RPC_BINDING_VECTOR +#endif + +typedef struct _UUID_VECTOR +{ + unsigned long Count; + _Field_size_(Count) UUID *Uuid[1]; +} UUID_VECTOR; +#ifndef uuid_vector_t +#define uuid_vector_t UUID_VECTOR +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +typedef void __RPC_FAR * RPC_IF_HANDLE; + +#ifndef IFID_DEFINED +#define IFID_DEFINED +typedef struct _RPC_IF_ID +{ + UUID Uuid; + unsigned short VersMajor; + unsigned short VersMinor; +} RPC_IF_ID; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#define RPC_C_BINDING_INFINITE_TIMEOUT 10 +#define RPC_C_BINDING_MIN_TIMEOUT 0 +#define RPC_C_BINDING_DEFAULT_TIMEOUT 5 +#define RPC_C_BINDING_MAX_TIMEOUT 9 + +#define RPC_C_CANCEL_INFINITE_TIMEOUT -1 + +#define RPC_C_LISTEN_MAX_CALLS_DEFAULT 1234 +#define RPC_C_PROTSEQ_MAX_REQS_DEFAULT 10 + +// RPC_POLICY EndpointFlags. +#define RPC_C_BIND_TO_ALL_NICS 1 +#define RPC_C_USE_INTERNET_PORT 0x1 +#define RPC_C_USE_INTRANET_PORT 0x2 +#define RPC_C_DONT_FAIL 0x4 +#define RPC_C_RPCHTTP_USE_LOAD_BALANCE 0x8 +#define RPC_C_TRY_ENFORCE_MAX_CALLS 0x10 + +#if (NTDDI_VERSION < NTDDI_VISTA) +// RPC_POLICY EndpointFlags specific to the Falcon/RPC transport (deprecated for Vista) +#define RPC_C_MQ_TEMPORARY 0x0000 +#define RPC_C_MQ_PERMANENT 0x0001 +#define RPC_C_MQ_CLEAR_ON_OPEN 0x0002 +#define RPC_C_MQ_USE_EXISTING_SECURITY 0x0004 +#define RPC_C_MQ_AUTHN_LEVEL_NONE 0x0000 +#define RPC_C_MQ_AUTHN_LEVEL_PKT_INTEGRITY 0x0008 +#define RPC_C_MQ_AUTHN_LEVEL_PKT_PRIVACY 0x0010 + +// Falcon/Rpc options are deprecated from Vista +#define RPC_C_MQ_EXPRESS 0 // Client: RPC_C_MQ_DELIVERY. +#define RPC_C_MQ_RECOVERABLE 1 + +#define RPC_C_MQ_JOURNAL_NONE 0 // Client: RPC_C_MQ_JOURNAL. +#define RPC_C_MQ_JOURNAL_DEADLETTER 1 +#define RPC_C_MQ_JOURNAL_ALWAYS 2 + +// Client: RpcBindingSetOption() values for the Falcon/RPC transport (some are deprecated from Vista) + +#define RPC_C_OPT_MQ_DELIVERY 1 +#define RPC_C_OPT_MQ_PRIORITY 2 +#define RPC_C_OPT_MQ_JOURNAL 3 +#define RPC_C_OPT_MQ_ACKNOWLEDGE 4 +#define RPC_C_OPT_MQ_AUTHN_SERVICE 5 +#define RPC_C_OPT_MQ_AUTHN_LEVEL 6 +#define RPC_C_OPT_MQ_TIME_TO_REACH_QUEUE 7 +#define RPC_C_OPT_MQ_TIME_TO_BE_RECEIVED 8 +#endif // (NTDDI_VERSION < NTDDI_VISTA) + +#define RPC_C_OPT_BINDING_NONCAUSAL 9 +#define RPC_C_OPT_SECURITY_CALLBACK 10 +#define RPC_C_OPT_UNIQUE_BINDING 11 + +#if (NTDDI_VERSION <= NTDDI_WIN2K) +#define RPC_C_OPT_MAX_OPTIONS 12 + +#elif (NTDDI_VERSION <= NTDDI_WS03) +#define RPC_C_OPT_CALL_TIMEOUT 12 +#define RPC_C_OPT_DONT_LINGER 13 +#define RPC_C_OPT_MAX_OPTIONS 14 + +#else +#define RPC_C_OPT_TRANS_SEND_BUFFER_SIZE 5 +#define RPC_C_OPT_CALL_TIMEOUT 12 +#define RPC_C_OPT_DONT_LINGER 13 +#define RPC_C_OPT_TRUST_PEER 14 +#define RPC_C_OPT_ASYNC_BLOCK 15 +#define RPC_C_OPT_OPTIMIZE_TIME 16 +#define RPC_C_OPT_MAX_OPTIONS 17 + +#endif // (NTDDI_VERSION <= NTDDI_WIN2K) + +// flags for RpcServerInqAuthClientEx +// +#define RPC_C_FULL_CERT_CHAIN 0x0001 + + + +#ifdef RPC_UNICODE_SUPPORTED +typedef struct _RPC_PROTSEQ_VECTORA +{ + unsigned int Count; + unsigned char __RPC_FAR * Protseq[1]; +} RPC_PROTSEQ_VECTORA; + +typedef struct _RPC_PROTSEQ_VECTORW +{ + unsigned int Count; + unsigned short __RPC_FAR * Protseq[1]; +} RPC_PROTSEQ_VECTORW; + +#ifdef UNICODE +#define RPC_PROTSEQ_VECTOR RPC_PROTSEQ_VECTORW +#else /* UNICODE */ +#define RPC_PROTSEQ_VECTOR RPC_PROTSEQ_VECTORA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +typedef struct _RPC_PROTSEQ_VECTOR +{ + unsigned int Count; + unsigned char __RPC_FAR * Protseq[1]; +} RPC_PROTSEQ_VECTOR; + +#endif /* RPC_UNICODE_SUPPORTED */ +typedef struct _RPC_POLICY { + unsigned int Length ; + unsigned long EndpointFlags ; + unsigned long NICFlags ; + } RPC_POLICY, __RPC_FAR *PRPC_POLICY ; + +typedef void __RPC_USER +RPC_OBJECT_INQ_FN ( + _In_ UUID __RPC_FAR * ObjectUuid, + _Out_ UUID __RPC_FAR * TypeUuid, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +_Success_(return == 0) /*RPC_S_OK*/ +typedef RPC_STATUS RPC_ENTRY +RPC_IF_CALLBACK_FN ( + _In_ RPC_IF_HANDLE InterfaceUuid, + _In_ void *Context + ) ; + +typedef void RPC_ENTRY +RPC_SECURITY_CALLBACK_FN ( + _In_ void *Context + ) ; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#define RPC_MGR_EPV void + +typedef struct +{ + unsigned int Count; + unsigned long Stats[1]; +} RPC_STATS_VECTOR; + +#define RPC_C_STATS_CALLS_IN 0 +#define RPC_C_STATS_CALLS_OUT 1 +#define RPC_C_STATS_PKTS_IN 2 +#define RPC_C_STATS_PKTS_OUT 3 + +typedef struct +{ + unsigned long Count; + RPC_IF_ID __RPC_FAR * IfId[1]; +} RPC_IF_ID_VECTOR; + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingCopy ( + _In_ RPC_BINDING_HANDLE SourceBinding, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * DestinationBinding + ); + +/* client */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingFree ( + _Inout_ RPC_BINDING_HANDLE __RPC_FAR * Binding + ); + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetOption ( + _In_ RPC_BINDING_HANDLE hBinding, + _In_ unsigned long option, + _In_ ULONG_PTR optionValue + ); + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqOption ( + _In_ RPC_BINDING_HANDLE hBinding, + _In_ unsigned long option, + _Out_ ULONG_PTR *pOptionValue + ); + +/* client */ + +#if !defined(_KRPCENV_) + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingFromStringBindingA ( + _In_ RPC_CSTR StringBinding, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * Binding + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingFromStringBindingW ( + _In_ RPC_WSTR StringBinding, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * Binding + ); + +#ifdef UNICODE +#define RpcBindingFromStringBinding RpcBindingFromStringBindingW +#else /* UNICODE */ +#define RpcBindingFromStringBinding RpcBindingFromStringBindingA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingFromStringBinding ( + _In_ RPC_CSTR StringBinding, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * Binding + ); + +#endif /* RPC_UNICODE_SUPPORTED */ +#endif /* _KRPCENV_ */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* client */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSsGetContextBinding ( + _In_ void *ContextHandle, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * Binding + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqMaxCalls ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned int * MaxCalls + ); + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqObject ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ UUID __RPC_FAR * ObjectUuid + ); + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingReset ( + _In_ RPC_BINDING_HANDLE Binding + ); + +/* RpcBindingServerFromClient : UNSUPPORTED */ +/* RpcBindingSetAuthInfo */ + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetObject ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ UUID __RPC_FAR * ObjectUuid + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqDefaultProtectLevel ( + _In_ unsigned long AuthnSvc, + _Out_ unsigned long __RPC_FAR *AuthnLevel + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + + +/* client/server */ + +#ifdef RPC_UNICODE_SUPPORTED + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingToStringBindingA ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_ RPC_CSTR __RPC_FAR * StringBinding + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingToStringBindingW ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_ RPC_WSTR __RPC_FAR * StringBinding + ); + +#ifdef UNICODE +#define RpcBindingToStringBinding RpcBindingToStringBindingW +#else /* UNICODE */ +#define RpcBindingToStringBinding RpcBindingToStringBindingA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingToStringBinding ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_ RPC_CSTR __RPC_FAR * StringBinding + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* client/server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingVectorFree ( + _Inout_ RPC_BINDING_VECTOR __RPC_FAR * __RPC_FAR * BindingVector + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +/* client/server */ + +#if !defined(_KRPCENV_) + +#ifdef RPC_UNICODE_SUPPORTED + + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcStringBindingComposeA ( + _In_opt_ RPC_CSTR ObjUuid, + _In_opt_ RPC_CSTR ProtSeq, + _In_opt_ RPC_CSTR NetworkAddr, + _In_opt_ RPC_CSTR Endpoint, + _In_opt_ RPC_CSTR Options, + _Outptr_opt_ RPC_CSTR __RPC_FAR * StringBinding + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcStringBindingComposeW ( + _In_opt_ RPC_WSTR ObjUuid, + _In_opt_ RPC_WSTR ProtSeq, + _In_opt_ RPC_WSTR NetworkAddr, + _In_opt_ RPC_WSTR Endpoint, + _In_opt_ RPC_WSTR Options, + _Outptr_opt_ RPC_WSTR __RPC_FAR * StringBinding + ); + +#ifdef UNICODE +#define RpcStringBindingCompose RpcStringBindingComposeW +#else /* UNICODE */ +#define RpcStringBindingCompose RpcStringBindingComposeA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcStringBindingCompose ( + _In_opt_ RPC_CSTR ObjUuid, + _In_opt_ RPC_CSTR ProtSeq, + _In_opt_ RPC_CSTR NetworkAddr, + _In_opt_ RPC_CSTR Endpoint, + _In_opt_ RPC_CSTR Options, + _Outptr_opt_ RPC_CSTR __RPC_FAR * StringBinding + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* client/server */ + +#ifdef RPC_UNICODE_SUPPORTED + + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcStringBindingParseA ( + _In_ RPC_CSTR StringBinding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ObjUuid, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Protseq, + _Outptr_opt_ RPC_CSTR __RPC_FAR * NetworkAddr, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Endpoint, + _Outptr_opt_ RPC_CSTR __RPC_FAR * NetworkOptions + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcStringBindingParseW ( + _In_ RPC_WSTR StringBinding, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ObjUuid, + _Outptr_opt_ RPC_WSTR __RPC_FAR * Protseq, + _Outptr_opt_ RPC_WSTR __RPC_FAR * NetworkAddr, + _Outptr_opt_ RPC_WSTR __RPC_FAR * Endpoint, + _Outptr_opt_ RPC_WSTR __RPC_FAR * NetworkOptions + ); + +#ifdef UNICODE +#define RpcStringBindingParse RpcStringBindingParseW +#else /* UNICODE */ +#define RpcStringBindingParse RpcStringBindingParseA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcStringBindingParse ( + _In_ RPC_CSTR StringBinding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ObjUuid, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Protseq, + _Outptr_opt_ RPC_CSTR __RPC_FAR * NetworkAddr, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Endpoint, + _Outptr_opt_ RPC_CSTR __RPC_FAR * NetworkOptions + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +#endif /* _KRPCENV_ */ + +/* client/server */ + +#ifdef RPC_UNICODE_SUPPORTED + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcStringFreeA ( + _Inout_ RPC_CSTR __RPC_FAR * String + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcStringFreeW ( + _Inout_ RPC_WSTR __RPC_FAR * String + ); + +#ifdef UNICODE +#define RpcStringFree RpcStringFreeW +#else /* UNICODE */ +#define RpcStringFree RpcStringFreeA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcStringFree ( + _At_(*_Curr_, _Frees_ptr_opt_) + _Inout_ RPC_CSTR __RPC_FAR * String + ); +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcIfInqId ( + _In_ RPC_IF_HANDLE RpcIfHandle, + _Out_ RPC_IF_ID __RPC_FAR * RpcIfId + ); + +/* client/server */ + +#ifdef RPC_UNICODE_SUPPORTED + + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNetworkIsProtseqValidA ( + _In_ RPC_CSTR Protseq + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNetworkIsProtseqValidW ( + _In_ RPC_WSTR Protseq + ); + +#ifdef UNICODE +#define RpcNetworkIsProtseqValid RpcNetworkIsProtseqValidW +#else /* UNICODE */ +#define RpcNetworkIsProtseqValid RpcNetworkIsProtseqValidA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcNetworkIsProtseqValid ( + _In_ RPC_CSTR Protseq + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqComTimeout ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned int __RPC_FAR * Timeout + ); + + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtSetComTimeout ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned int Timeout + ); + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtSetCancelTimeout( + _In_ long Timeout + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* server */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNetworkInqProtseqsA ( + _Outptr_ RPC_PROTSEQ_VECTORA __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNetworkInqProtseqsW ( + _Outptr_ RPC_PROTSEQ_VECTORW __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +#ifdef UNICODE +#define RpcNetworkInqProtseqs RpcNetworkInqProtseqsW +#else /* UNICODE */ +#define RpcNetworkInqProtseqs RpcNetworkInqProtseqsA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcNetworkInqProtseqs ( + _Outptr_ RPC_PROTSEQ_VECTOR __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcObjectInqType ( + _In_ UUID __RPC_FAR * ObjUuid, + _Out_opt_ OPTIONAL UUID __RPC_FAR * TypeUuid + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcObjectSetInqFn ( + _In_ RPC_OBJECT_INQ_FN __RPC_FAR * InquiryFn + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcObjectSetType ( + _In_ UUID __RPC_FAR * ObjUuid, + _In_opt_ OPTIONAL UUID __RPC_FAR * TypeUuid + ); + +/* server */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcProtseqVectorFreeA ( + _Inout_ RPC_PROTSEQ_VECTORA __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcProtseqVectorFreeW ( + _Inout_ RPC_PROTSEQ_VECTORW __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +#ifdef UNICODE +#define RpcProtseqVectorFree RpcProtseqVectorFreeW +#else /* UNICODE */ +#define RpcProtseqVectorFree RpcProtseqVectorFreeA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcProtseqVectorFree ( + _Inout_ RPC_PROTSEQ_VECTOR __RPC_FAR * __RPC_FAR * ProtseqVector + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerInqBindings ( + _Outptr_ RPC_BINDING_VECTOR __RPC_FAR * __RPC_FAR * BindingVector + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerInqBindingsEx ( + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _Outptr_ RPC_BINDING_VECTOR __RPC_FAR * __RPC_FAR * BindingVector + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerInqIf ( + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _Outptr_ RPC_MGR_EPV __RPC_FAR * __RPC_FAR * MgrEpv + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerListen ( + _In_ unsigned int MinimumCallThreads, + _In_ unsigned int MaxCalls, + _In_ unsigned int DontWait + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerRegisterIf ( + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _In_opt_ RPC_MGR_EPV __RPC_FAR * MgrEpv + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerRegisterIfEx ( + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _In_opt_ RPC_MGR_EPV __RPC_FAR * MgrEpv, + _In_ unsigned int Flags, + _In_ unsigned int MaxCalls, + _In_opt_ RPC_IF_CALLBACK_FN __RPC_FAR *IfCallback + ); + +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerRegisterIf2 ( + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID * MgrTypeUuid, + _In_opt_ RPC_MGR_EPV * MgrEpv, + _In_ unsigned int Flags, + _In_ unsigned int MaxCalls, + _In_ unsigned int MaxRpcSize, + _In_opt_ RPC_IF_CALLBACK_FN *IfCallbackFn + ); + +#if (NTDDI_VERSION >= NTDDI_WIN8) +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerRegisterIf3 ( + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _In_opt_ RPC_MGR_EPV __RPC_FAR * MgrEpv, + _In_ unsigned int Flags, + _In_ unsigned int MaxCalls, + _In_ unsigned int MaxRpcSize, + _In_opt_ RPC_IF_CALLBACK_FN __RPC_FAR *IfCallback, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUnregisterIf ( + _In_opt_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _In_ unsigned int WaitForCallsToComplete + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUnregisterIfEx ( + _In_opt_ RPC_IF_HANDLE IfSpec, + _In_opt_ UUID __RPC_FAR * MgrTypeUuid, + _In_ int RundownContextHandles + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseAllProtseqs ( + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseAllProtseqsEx ( + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseAllProtseqsIf ( + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseAllProtseqsIfEx ( + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + + +/* server */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqExA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqExW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#ifdef UNICODE +#define RpcServerUseProtseq RpcServerUseProtseqW +#define RpcServerUseProtseqEx RpcServerUseProtseqExW +#else /* UNICODE */ +#define RpcServerUseProtseq RpcServerUseProtseqA +#define RpcServerUseProtseqEx RpcServerUseProtseqExA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseq ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEx ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* server */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEpA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_CSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEpExA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_CSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEpW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_WSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEpExW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_WSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#ifdef UNICODE +#define RpcServerUseProtseqEp RpcServerUseProtseqEpW +#define RpcServerUseProtseqEpEx RpcServerUseProtseqEpExW +#else /* UNICODE */ +#define RpcServerUseProtseqEp RpcServerUseProtseqEpA +#define RpcServerUseProtseqEpEx RpcServerUseProtseqEpExA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEp ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_CSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqEpEx ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_WSTR Endpoint, + _In_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +/* server */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIfA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIfExA ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIfW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIfExW ( + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#ifdef UNICODE +#define RpcServerUseProtseqIf RpcServerUseProtseqIfW +#define RpcServerUseProtseqIfEx RpcServerUseProtseqIfExW +#else /* UNICODE */ +#define RpcServerUseProtseqIf RpcServerUseProtseqIfA +#define RpcServerUseProtseqIfEx RpcServerUseProtseqIfExA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIf ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_opt_ void __RPC_FAR * SecurityDescriptor + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerUseProtseqIfEx ( + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_IF_HANDLE IfSpec, + _In_ void __RPC_FAR * SecurityDescriptor, + _In_ PRPC_POLICY Policy + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +void +RPC_ENTRY +RpcServerYield ( + void + ); + +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcMgmtStatsVectorFree ( + _Inout_ RPC_STATS_VECTOR ** StatsVector + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqStats ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _Outptr_ RPC_STATS_VECTOR ** Statistics + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtIsServerListening ( + _In_opt_ RPC_BINDING_HANDLE Binding + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtStopServerListening ( + _In_opt_ RPC_BINDING_HANDLE Binding + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtWaitServerListen ( + void + ); + +/* server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtSetServerStackSize ( + _In_ unsigned long ThreadStackSize + ); + +/* server */ +RPCRTAPI +void +RPC_ENTRY +RpcSsDontSerializeContext ( + void + ); + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEnableIdleCleanup ( + void + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqIfIds ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _Outptr_ RPC_IF_ID_VECTOR __RPC_FAR * __RPC_FAR * IfIdVector + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcIfIdVectorFree ( + _Inout_ RPC_IF_ID_VECTOR __RPC_FAR * __RPC_FAR * IfIdVector + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef RPC_UNICODE_SUPPORTED + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqServerPrincNameA ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_CSTR __RPC_FAR * ServerPrincName + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtInqServerPrincNameW ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_WSTR __RPC_FAR * ServerPrincName + ); + +#ifdef UNICODE +#define RpcMgmtInqServerPrincName RpcMgmtInqServerPrincNameW +#else /* UNICODE */ +#define RpcMgmtInqServerPrincName RpcMgmtInqServerPrincNameA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcMgmtInqServerPrincName ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_WSTR __RPC_FAR * ServerPrincName + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerInqDefaultPrincNameA ( + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_CSTR __RPC_FAR * PrincName + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerInqDefaultPrincNameW ( + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_WSTR __RPC_FAR * PrincName + ); + +#ifdef UNICODE +#define RpcServerInqDefaultPrincName RpcServerInqDefaultPrincNameW +#else /* UNICODE */ +#define RpcServerInqDefaultPrincName RpcServerInqDefaultPrincNameA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInqDefaultPrincName ( + _In_ unsigned long AuthnSvc, + _Outptr_ RPC_WSTR __RPC_FAR * PrincName + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* client */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpResolveBinding ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ RPC_IF_HANDLE IfSpec + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* client */ + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNsBindingInqEntryNameA ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _Outptr_ RPC_CSTR __RPC_FAR * EntryName + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcNsBindingInqEntryNameW ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _Outptr_ RPC_WSTR __RPC_FAR * EntryName + ); + +#ifdef UNICODE +#define RpcNsBindingInqEntryName RpcNsBindingInqEntryNameW +#else /* UNICODE */ +#define RpcNsBindingInqEntryName RpcNsBindingInqEntryNameA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcNsBindingInqEntryName ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _Outptr_ RPC_CSTR __RPC_FAR * EntryName + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +typedef void __RPC_FAR * RPC_AUTH_IDENTITY_HANDLE; +typedef void __RPC_FAR * RPC_AUTHZ_HANDLE; + +#define RPC_C_AUTHN_LEVEL_DEFAULT 0 +#define RPC_C_AUTHN_LEVEL_NONE 1 +#define RPC_C_AUTHN_LEVEL_CONNECT 2 +#define RPC_C_AUTHN_LEVEL_CALL 3 +#define RPC_C_AUTHN_LEVEL_PKT 4 +#define RPC_C_AUTHN_LEVEL_PKT_INTEGRITY 5 +#define RPC_C_AUTHN_LEVEL_PKT_PRIVACY 6 + +#define RPC_C_IMP_LEVEL_DEFAULT 0 +#define RPC_C_IMP_LEVEL_ANONYMOUS 1 +#define RPC_C_IMP_LEVEL_IDENTIFY 2 +#define RPC_C_IMP_LEVEL_IMPERSONATE 3 +#define RPC_C_IMP_LEVEL_DELEGATE 4 + +#define RPC_C_QOS_IDENTITY_STATIC 0 +#define RPC_C_QOS_IDENTITY_DYNAMIC 1 + +#define RPC_C_QOS_CAPABILITIES_DEFAULT 0x0 +#define RPC_C_QOS_CAPABILITIES_MUTUAL_AUTH 0x1 +#define RPC_C_QOS_CAPABILITIES_MAKE_FULLSIC 0x2 +#define RPC_C_QOS_CAPABILITIES_ANY_AUTHORITY 0x4 + +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_C_QOS_CAPABILITIES_IGNORE_DELEGATE_FAILURE 0x8 +#define RPC_C_QOS_CAPABILITIES_LOCAL_MA_HINT 0x10 +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_C_QOS_CAPABILITIES_SCHANNEL_FULL_AUTH_IDENTITY 0x20 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPC_C_PROTECT_LEVEL_DEFAULT (RPC_C_AUTHN_LEVEL_DEFAULT) +#define RPC_C_PROTECT_LEVEL_NONE (RPC_C_AUTHN_LEVEL_NONE) +#define RPC_C_PROTECT_LEVEL_CONNECT (RPC_C_AUTHN_LEVEL_CONNECT) +#define RPC_C_PROTECT_LEVEL_CALL (RPC_C_AUTHN_LEVEL_CALL) +#define RPC_C_PROTECT_LEVEL_PKT (RPC_C_AUTHN_LEVEL_PKT) +#define RPC_C_PROTECT_LEVEL_PKT_INTEGRITY (RPC_C_AUTHN_LEVEL_PKT_INTEGRITY) +#define RPC_C_PROTECT_LEVEL_PKT_PRIVACY (RPC_C_AUTHN_LEVEL_PKT_PRIVACY) + +#define RPC_C_AUTHN_NONE 0 +#define RPC_C_AUTHN_DCE_PRIVATE 1 +#define RPC_C_AUTHN_DCE_PUBLIC 2 +#define RPC_C_AUTHN_DEC_PUBLIC 4 +#define RPC_C_AUTHN_GSS_NEGOTIATE 9 +#define RPC_C_AUTHN_WINNT 10 +#define RPC_C_AUTHN_GSS_SCHANNEL 14 +#define RPC_C_AUTHN_GSS_KERBEROS 16 +#define RPC_C_AUTHN_DPA 17 +#define RPC_C_AUTHN_MSN 18 +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define RPC_C_AUTHN_DIGEST 21 +#endif // (NTDDI_VERSION >= WINXP) +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define RPC_C_AUTHN_KERNEL 20 +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#define RPC_C_AUTHN_NEGO_EXTENDER 30 +#define RPC_C_AUTHN_PKU2U 31 + +#define RPC_C_AUTHN_LIVE_SSP 32 +#define RPC_C_AUTHN_LIVEXP_SSP 35 +#define RPC_C_AUTHN_CLOUD_AP 36 +#define RPC_C_AUTHN_MSONLINE 82 + +#define RPC_C_AUTHN_MQ 100 +#define RPC_C_AUTHN_DEFAULT 0xFFFFFFFFL + +#define RPC_C_NO_CREDENTIALS ((RPC_AUTH_IDENTITY_HANDLE) MAXUINT_PTR) + +#define RPC_C_SECURITY_QOS_VERSION 1L +#define RPC_C_SECURITY_QOS_VERSION_1 1L + +typedef struct _RPC_SECURITY_QOS { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; +} RPC_SECURITY_QOS, *PRPC_SECURITY_QOS; + +#ifndef _AUTH_IDENTITY_DEFINED +#define _AUTH_IDENTITY_DEFINED + +#define SEC_WINNT_AUTH_IDENTITY_ANSI 0x1 +#define SEC_WINNT_AUTH_IDENTITY_UNICODE 0x2 + +typedef struct _SEC_WINNT_AUTH_IDENTITY_W { + _Field_size_bytes_((UserLength+1)*sizeof(WCHAR)) unsigned short __RPC_FAR *User; + unsigned long UserLength; + _Field_size_bytes_((DomainLength+1)*sizeof(WCHAR)) unsigned short __RPC_FAR *Domain; + unsigned long DomainLength; + _Field_size_bytes_((PasswordLength+1)*sizeof(WCHAR)) unsigned short __RPC_FAR *Password; + unsigned long PasswordLength; + unsigned long Flags; +} SEC_WINNT_AUTH_IDENTITY_W, *PSEC_WINNT_AUTH_IDENTITY_W; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define _AUTH_IDENTITY_A_DEFINED +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +typedef struct _SEC_WINNT_AUTH_IDENTITY_A { + _Field_size_(UserLength+1) unsigned char __RPC_FAR *User; + unsigned long UserLength; + _Field_size_(DomainLength+1) unsigned char __RPC_FAR *Domain; + unsigned long DomainLength; + _Field_size_(PasswordLength+1) unsigned char __RPC_FAR *Password; + unsigned long PasswordLength; + unsigned long Flags; +} SEC_WINNT_AUTH_IDENTITY_A, *PSEC_WINNT_AUTH_IDENTITY_A; + +#ifdef UNICODE +#define SEC_WINNT_AUTH_IDENTITY SEC_WINNT_AUTH_IDENTITY_W +#define PSEC_WINNT_AUTH_IDENTITY PSEC_WINNT_AUTH_IDENTITY_W +#define _SEC_WINNT_AUTH_IDENTITY _SEC_WINNT_AUTH_IDENTITY_W +#else // UNICODE +#define SEC_WINNT_AUTH_IDENTITY SEC_WINNT_AUTH_IDENTITY_A +#define PSEC_WINNT_AUTH_IDENTITY PSEC_WINNT_AUTH_IDENTITY_A +#define _SEC_WINNT_AUTH_IDENTITY _SEC_WINNT_AUTH_IDENTITY_A +#endif // UNICODE + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#define RPC_C_SECURITY_QOS_VERSION_2 2L + +#define RPC_C_AUTHN_INFO_TYPE_HTTP 1 + +#define RPC_C_HTTP_AUTHN_TARGET_SERVER 1 +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_C_HTTP_AUTHN_TARGET_PROXY 2 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPC_C_HTTP_AUTHN_SCHEME_BASIC 0x00000001 +#define RPC_C_HTTP_AUTHN_SCHEME_NTLM 0x00000002 +#define RPC_C_HTTP_AUTHN_SCHEME_PASSPORT 0x00000004 +#define RPC_C_HTTP_AUTHN_SCHEME_DIGEST 0x00000008 +#define RPC_C_HTTP_AUTHN_SCHEME_NEGOTIATE 0x00000010 +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_C_HTTP_AUTHN_SCHEME_CERT 0x00010000 +// 0x00020000 & 0x00040000 are reserved +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#define RPC_C_HTTP_FLAG_USE_SSL 1 +#define RPC_C_HTTP_FLAG_USE_FIRST_AUTH_SCHEME 2 +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_C_HTTP_FLAG_IGNORE_CERT_CN_INVALID 8 +#endif // (NTDDI_VERSION >= NTDDI_WS03) +#if (NTDDI_VERSION >= NTDDI_VISTASP1) +#define RPC_C_HTTP_FLAG_ENABLE_CERT_REVOCATION_CHECK 16 +#endif // (NTDDI_VERSION >= NTDDI_VISTASP1) + + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_W +{ + SEC_WINNT_AUTH_IDENTITY_W *TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + unsigned long *AuthnSchemes; + unsigned short __RPC_FAR *ServerCertificateSubject; +} RPC_HTTP_TRANSPORT_CREDENTIALS_W, *PRPC_HTTP_TRANSPORT_CREDENTIALS_W; + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_A +{ + SEC_WINNT_AUTH_IDENTITY_A *TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + unsigned long *AuthnSchemes; + unsigned char __RPC_FAR *ServerCertificateSubject; +} RPC_HTTP_TRANSPORT_CREDENTIALS_A, *PRPC_HTTP_TRANSPORT_CREDENTIALS_A; + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_V2_W +{ + SEC_WINNT_AUTH_IDENTITY_W *TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + _Field_size_(NumberOfAuthnSchemes) unsigned long *AuthnSchemes; + unsigned short __RPC_FAR *ServerCertificateSubject; + SEC_WINNT_AUTH_IDENTITY_W *ProxyCredentials; + unsigned long NumberOfProxyAuthnSchemes; + _Field_size_(NumberOfProxyAuthnSchemes) unsigned long *ProxyAuthnSchemes; +} RPC_HTTP_TRANSPORT_CREDENTIALS_V2_W, *PRPC_HTTP_TRANSPORT_CREDENTIALS_V2_W; + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_V2_A +{ + SEC_WINNT_AUTH_IDENTITY_A *TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + unsigned long *AuthnSchemes; + unsigned char __RPC_FAR *ServerCertificateSubject; + SEC_WINNT_AUTH_IDENTITY_A *ProxyCredentials; + unsigned long NumberOfProxyAuthnSchemes; + unsigned long *ProxyAuthnSchemes; +} RPC_HTTP_TRANSPORT_CREDENTIALS_V2_A, *PRPC_HTTP_TRANSPORT_CREDENTIALS_V2_A; + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_V3_W +{ + RPC_AUTH_IDENTITY_HANDLE TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + _Field_size_(NumberOfAuthnSchemes) unsigned long *AuthnSchemes; + unsigned short __RPC_FAR *ServerCertificateSubject; + RPC_AUTH_IDENTITY_HANDLE ProxyCredentials; + unsigned long NumberOfProxyAuthnSchemes; + _Field_size_(NumberOfProxyAuthnSchemes) unsigned long *ProxyAuthnSchemes; +} RPC_HTTP_TRANSPORT_CREDENTIALS_V3_W, *PRPC_HTTP_TRANSPORT_CREDENTIALS_V3_W; + +typedef struct _RPC_HTTP_TRANSPORT_CREDENTIALS_V3_A +{ + RPC_AUTH_IDENTITY_HANDLE TransportCredentials; + unsigned long Flags; + unsigned long AuthenticationTarget; + unsigned long NumberOfAuthnSchemes; + _Field_size_(NumberOfAuthnSchemes) unsigned long *AuthnSchemes; + unsigned char __RPC_FAR *ServerCertificateSubject; + RPC_AUTH_IDENTITY_HANDLE ProxyCredentials; + unsigned long NumberOfProxyAuthnSchemes; + _Field_size_(NumberOfProxyAuthnSchemes) unsigned long *ProxyAuthnSchemes; +} RPC_HTTP_TRANSPORT_CREDENTIALS_V3_A, *PRPC_HTTP_TRANSPORT_CREDENTIALS_V3_A; + +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +typedef struct _RPC_SECURITY_QOS_V2_W { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_W *HttpCredentials; + } u; +} RPC_SECURITY_QOS_V2_W, *PRPC_SECURITY_QOS_V2_W; + +typedef struct _RPC_SECURITY_QOS_V2_A { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_A *HttpCredentials; + } u; +} RPC_SECURITY_QOS_V2_A, *PRPC_SECURITY_QOS_V2_A; + +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_C_SECURITY_QOS_VERSION_3 3L + +typedef struct _RPC_SECURITY_QOS_V3_W { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_W *HttpCredentials; + } u; + void *Sid; +} RPC_SECURITY_QOS_V3_W, *PRPC_SECURITY_QOS_V3_W; + +typedef struct _RPC_SECURITY_QOS_V3_A { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_A *HttpCredentials; + } u; + void *Sid; +} RPC_SECURITY_QOS_V3_A, *PRPC_SECURITY_QOS_V3_A; +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPC_C_SECURITY_QOS_VERSION_4 4L + +typedef struct _RPC_SECURITY_QOS_V4_W { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_W *HttpCredentials; + } u; + void *Sid; + unsigned int EffectiveOnly; +} RPC_SECURITY_QOS_V4_W, *PRPC_SECURITY_QOS_V4_W; + +typedef struct _RPC_SECURITY_QOS_V4_A { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_A *HttpCredentials; + } u; + void *Sid; + unsigned int EffectiveOnly; +} RPC_SECURITY_QOS_V4_A, *PRPC_SECURITY_QOS_V4_A; + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define RPC_C_SECURITY_QOS_VERSION_5 5L + +typedef struct _RPC_SECURITY_QOS_V5_W { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_W *HttpCredentials; + } u; + void *Sid; + unsigned int EffectiveOnly; + void *ServerSecurityDescriptor; +} RPC_SECURITY_QOS_V5_W, *PRPC_SECURITY_QOS_V5_W; + +typedef struct _RPC_SECURITY_QOS_V5_A { + unsigned long Version; + unsigned long Capabilities; + unsigned long IdentityTracking; + unsigned long ImpersonationType; + unsigned long AdditionalSecurityInfoType; + union + { + RPC_HTTP_TRANSPORT_CREDENTIALS_A *HttpCredentials; + } u; + void *Sid; + unsigned int EffectiveOnly; + void *ServerSecurityDescriptor; +} RPC_SECURITY_QOS_V5_A, *PRPC_SECURITY_QOS_V5_A; + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#endif // NTDDI_WINXP +#endif // _AUTH_IDENTITY_DEFINED + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if (NTDDI_VERSION >= NTDDI_WINXP) + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef UNICODE + +#define RPC_SECURITY_QOS_V2 RPC_SECURITY_QOS_V2_W +#define PRPC_SECURITY_QOS_V2 PRPC_SECURITY_QOS_V2_W +#define _RPC_SECURITY_QOS_V2 _RPC_SECURITY_QOS_V2_W + +#define RPC_HTTP_TRANSPORT_CREDENTIALS RPC_HTTP_TRANSPORT_CREDENTIALS_W +#define PRPC_HTTP_TRANSPORT_CREDENTIALS PRPC_HTTP_TRANSPORT_CREDENTIALS_W +#define _RPC_HTTP_TRANSPORT_CREDENTIALS _RPC_HTTP_TRANSPORT_CREDENTIALS_W + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_HTTP_TRANSPORT_CREDENTIALS_V2 RPC_HTTP_TRANSPORT_CREDENTIALS_V2_W +#define PRPC_HTTP_TRANSPORT_CREDENTIALS_V2 PRPC_HTTP_TRANSPORT_CREDENTIALS_V2_W +#define _RPC_HTTP_TRANSPORT_CREDENTIALS_V2 _RPC_HTTP_TRANSPORT_CREDENTIALS_V2_W +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define RPC_HTTP_TRANSPORT_CREDENTIALS_V3 RPC_HTTP_TRANSPORT_CREDENTIALS_V3_W +#define PRPC_HTTP_TRANSPORT_CREDENTIALS_V3 PRPC_HTTP_TRANSPORT_CREDENTIALS_V3_W +#define _RPC_HTTP_TRANSPORT_CREDENTIALS_V3 _RPC_HTTP_TRANSPORT_CREDENTIALS_V3_W +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_SECURITY_QOS_V3 RPC_SECURITY_QOS_V3_W +#define PRPC_SECURITY_QOS_V3 PRPC_SECURITY_QOS_V3_W +#define _RPC_SECURITY_QOS_V3 _RPC_SECURITY_QOS_V3_W +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_SECURITY_QOS_V4 RPC_SECURITY_QOS_V4_W +#define PRPC_SECURITY_QOS_V4 PRPC_SECURITY_QOS_V4_W +#define _RPC_SECURITY_QOS_V4 _RPC_SECURITY_QOS_V4_W +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define RPC_SECURITY_QOS_V5 RPC_SECURITY_QOS_V5_W +#define PRPC_SECURITY_QOS_V5 PRPC_SECURITY_QOS_V5_W +#define _RPC_SECURITY_QOS_V5 _RPC_SECURITY_QOS_V5_W +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#else // UNICODE + +#define RPC_SECURITY_QOS_V2 RPC_SECURITY_QOS_V2_A +#define PRPC_SECURITY_QOS_V2 PRPC_SECURITY_QOS_V2_A +#define _RPC_SECURITY_QOS_V2 _RPC_SECURITY_QOS_V2_A + +#define RPC_HTTP_TRANSPORT_CREDENTIALS RPC_HTTP_TRANSPORT_CREDENTIALS_A +#define PRPC_HTTP_TRANSPORT_CREDENTIALS PRPC_HTTP_TRANSPORT_CREDENTIALS_A +#define _RPC_HTTP_TRANSPORT_CREDENTIALS _RPC_HTTP_TRANSPORT_CREDENTIALS_A + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_HTTP_TRANSPORT_CREDENTIALS_V2 RPC_HTTP_TRANSPORT_CREDENTIALS_V2_A +#define PRPC_HTTP_TRANSPORT_CREDENTIALS_V2 PRPC_HTTP_TRANSPORT_CREDENTIALS_V2_A +#define _RPC_HTTP_TRANSPORT_CREDENTIALS_V2 _RPC_HTTP_TRANSPORT_CREDENTIALS_V2_A +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN7) +#define RPC_HTTP_TRANSPORT_CREDENTIALS_V3 RPC_HTTP_TRANSPORT_CREDENTIALS_V3_A +#define PRPC_HTTP_TRANSPORT_CREDENTIALS_V3 PRPC_HTTP_TRANSPORT_CREDENTIALS_V3_A +#define _RPC_HTTP_TRANSPORT_CREDENTIALS_V3 _RPC_HTTP_TRANSPORT_CREDENTIALS_V3_A +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WS03) +#define RPC_SECURITY_QOS_V3 RPC_SECURITY_QOS_V3_A +#define PRPC_SECURITY_QOS_V3 PRPC_SECURITY_QOS_V3_A +#define _RPC_SECURITY_QOS_V3 _RPC_SECURITY_QOS_V3_A +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_SECURITY_QOS_V4 RPC_SECURITY_QOS_V4_A +#define PRPC_SECURITY_QOS_V4 PRPC_SECURITY_QOS_V4_A +#define _RPC_SECURITY_QOS_V4 _RPC_SECURITY_QOS_V4_A +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +#define RPC_SECURITY_QOS_V5 RPC_SECURITY_QOS_V5_A +#define PRPC_SECURITY_QOS_V5 PRPC_SECURITY_QOS_V5_A +#define _RPC_SECURITY_QOS_V5 _RPC_SECURITY_QOS_V5_A +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + + +#endif // UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +#define RPC_PROTSEQ_TCP (0x1) +#define RPC_PROTSEQ_NMP (0x2) +#define RPC_PROTSEQ_LRPC (0x3) +#define RPC_PROTSEQ_HTTP (0x4) + +#define RPC_BHT_OBJECT_UUID_VALID (0x1) + +#define RPC_BHO_NONCAUSAL (0x1) +#define RPC_BHO_DONTLINGER (0x2) +#define RPC_BHO_EXCLUSIVE_AND_GUARANTEED (0x4) + +typedef struct _RPC_BINDING_HANDLE_TEMPLATE_V1_W { + unsigned long Version; + unsigned long Flags; + unsigned long ProtocolSequence; + unsigned short *NetworkAddress; + unsigned short *StringEndpoint; + union + { + unsigned short *Reserved; + } u1; + UUID ObjectUuid; +} RPC_BINDING_HANDLE_TEMPLATE_V1_W, *PRPC_BINDING_HANDLE_TEMPLATE_V1_W; + +typedef struct _RPC_BINDING_HANDLE_TEMPLATE_V1_A { + unsigned long Version; + unsigned long Flags; + unsigned long ProtocolSequence; + unsigned char *NetworkAddress; + unsigned char *StringEndpoint; + union + { + unsigned char *Reserved; + } u1; + UUID ObjectUuid; +} RPC_BINDING_HANDLE_TEMPLATE_V1_A, *PRPC_BINDING_HANDLE_TEMPLATE_V1_A; + +typedef struct _RPC_BINDING_HANDLE_SECURITY_V1_W { + unsigned long Version; + unsigned short *ServerPrincName; + unsigned long AuthnLevel; + unsigned long AuthnSvc; + SEC_WINNT_AUTH_IDENTITY_W *AuthIdentity; + RPC_SECURITY_QOS *SecurityQos; +} RPC_BINDING_HANDLE_SECURITY_V1_W, *PRPC_BINDING_HANDLE_SECURITY_V1_W; + +#ifdef _AUTH_IDENTITY_A_DEFINED + +typedef struct _RPC_BINDING_HANDLE_SECURITY_V1_A { + unsigned long Version; + unsigned char *ServerPrincName; + unsigned long AuthnLevel; + unsigned long AuthnSvc; + SEC_WINNT_AUTH_IDENTITY_A *AuthIdentity; + RPC_SECURITY_QOS *SecurityQos; +} RPC_BINDING_HANDLE_SECURITY_V1_A, *PRPC_BINDING_HANDLE_SECURITY_V1_A; + +#endif // _AUTH_IDENTITY_A_DEFINED + +typedef struct _RPC_BINDING_HANDLE_OPTIONS_V1 { + unsigned long Version; + unsigned long Flags; + unsigned long ComTimeout; + unsigned long CallTimeout; +} RPC_BINDING_HANDLE_OPTIONS_V1, *PRPC_BINDING_HANDLE_OPTIONS_V1; + +#ifdef UNICODE + +#define RPC_BINDING_HANDLE_TEMPLATE_V1 RPC_BINDING_HANDLE_TEMPLATE_V1_W +#define PRPC_BINDING_HANDLE_TEMPLATE_V1 PRPC_BINDING_HANDLE_TEMPLATE_V1_W +#define _RPC_BINDING_HANDLE_TEMPLATE_V1 _RPC_BINDING_HANDLE_TEMPLATE_V1_W + +#define RPC_BINDING_HANDLE_SECURITY_V1 RPC_BINDING_HANDLE_SECURITY_V1_W +#define PRPC_BINDING_HANDLE_SECURITY_V1 PRPC_BINDING_HANDLE_SECURITY_V1_W +#define _RPC_BINDING_HANDLE_SECURITY_V1 _RPC_BINDING_HANDLE_SECURITY_V1_W + +#else + +#define RPC_BINDING_HANDLE_TEMPLATE_V1 RPC_BINDING_HANDLE_TEMPLATE_V1_A +#define PRPC_BINDING_HANDLE_TEMPLATE_V1 PRPC_BINDING_HANDLE_TEMPLATE_V1_A +#define _RPC_BINDING_HANDLE_TEMPLATE_V1 _RPC_BINDING_HANDLE_TEMPLATE_V1_A + +#define RPC_BINDING_HANDLE_SECURITY_V1 RPC_BINDING_HANDLE_SECURITY_V1_A +#define PRPC_BINDING_HANDLE_SECURITY_V1 PRPC_BINDING_HANDLE_SECURITY_V1_A +#define _RPC_BINDING_HANDLE_SECURITY_V1 _RPC_BINDING_HANDLE_SECURITY_V1_A + +#endif // !UNICODE + +#ifdef _AUTH_IDENTITY_A_DEFINED + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingCreateA ( + _In_ RPC_BINDING_HANDLE_TEMPLATE_V1_A * Template, + _In_opt_ RPC_BINDING_HANDLE_SECURITY_V1_A * Security, + _In_opt_ RPC_BINDING_HANDLE_OPTIONS_V1 * Options, + _Out_ RPC_BINDING_HANDLE * Binding + ); + +#endif // _AUTH_IDENTITY_A_DEFINED + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingCreateW ( + _In_ RPC_BINDING_HANDLE_TEMPLATE_V1_W * Template, + _In_opt_ RPC_BINDING_HANDLE_SECURITY_V1_W * Security, + _In_opt_ RPC_BINDING_HANDLE_OPTIONS_V1 * Options, + _Out_ RPC_BINDING_HANDLE * Binding + ); + +#ifdef UNICODE +#define RpcBindingCreate RpcBindingCreateW +#else /* UNICODE */ +#define RpcBindingCreate RpcBindingCreateA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingGetTrainingContextHandle ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_ void ** ContextHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInqBindingHandle ( + _Out_ RPC_BINDING_HANDLE * Binding + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +#if (NTDDI_VERSION >= NTDDI_WS03) + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +typedef enum _RPC_HTTP_REDIRECTOR_STAGE +{ + RPCHTTP_RS_REDIRECT = 1, + RPCHTTP_RS_ACCESS_1, + RPCHTTP_RS_SESSION, + RPCHTTP_RS_ACCESS_2, + RPCHTTP_RS_INTERFACE +} RPC_HTTP_REDIRECTOR_STAGE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if (NTDDI_VERSION >= NTDDI_WS03) +typedef RPC_STATUS +(__RPC_USER * RPC_NEW_HTTP_PROXY_CHANNEL) ( + _In_ RPC_HTTP_REDIRECTOR_STAGE RedirectorStage, + _In_ RPC_WSTR ServerName, + _In_ RPC_WSTR ServerPort, + _In_opt_ RPC_WSTR RemoteUser, + _In_opt_ RPC_WSTR AuthType, + _Inout_ void __RPC_FAR * ResourceUuid, + _Inout_ void __RPC_FAR * SessionId, + _In_opt_ void __RPC_FAR * Interface, + _In_opt_ void __RPC_FAR * Reserved, + _In_ unsigned long Flags, + _Outptr_opt_ RPC_WSTR __RPC_FAR * NewServerName, + _Outptr_opt_ RPC_WSTR __RPC_FAR * NewServerPort + ); + +#else + +typedef RPC_STATUS +(__RPC_USER * RPC_NEW_HTTP_PROXY_CHANNEL) ( + _In_ unsigned short __RPC_FAR *ServerName, + _In_ unsigned short __RPC_FAR *ServerPort, + _In_ unsigned char __RPC_FAR *RemoteUser, + _Out_ unsigned short __RPC_FAR **NewServerName + ); +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +typedef void +(__RPC_USER * RPC_HTTP_PROXY_FREE_STRING) ( + _In_ RPC_WSTR String + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +#define RPC_C_AUTHZ_NONE 0 +#define RPC_C_AUTHZ_NAME 1 +#define RPC_C_AUTHZ_DCE 2 +#define RPC_C_AUTHZ_DEFAULT 0xffffffff + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcImpersonateClient ( + _In_opt_ RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcImpersonateClient2 ( + _In_opt_ RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcRevertToSelfEx ( + _In_opt_ RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcRevertToSelf ( + void + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcImpersonateClientContainer ( + _In_opt_ RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcRevertContainerImpersonation ( + void + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +// <<>> + +#ifdef RPC_UNICODE_SUPPORTED + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClientA ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClientW ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClientExA ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc, + _In_ unsigned long Flags + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClientExW ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc, + _In_ unsigned long Flags + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthInfoA ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ RPC_AUTH_IDENTITY_HANDLE __RPC_FAR * AuthIdentity, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthInfoW ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ RPC_AUTH_IDENTITY_HANDLE __RPC_FAR * AuthIdentity, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetAuthInfoA ( + _In_ RPC_BINDING_HANDLE Binding, + _In_opt_ RPC_CSTR ServerPrincName, + _In_ unsigned long AuthnLevel, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_IDENTITY_HANDLE AuthIdentity, + _In_ unsigned long AuthzSvc + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetAuthInfoExA ( + _In_ RPC_BINDING_HANDLE Binding, + _In_opt_ RPC_CSTR ServerPrincName, + _In_ unsigned long AuthnLevel, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_IDENTITY_HANDLE AuthIdentity, + _In_ unsigned long AuthzSvc, + _In_opt_ RPC_SECURITY_QOS * SecurityQos + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetAuthInfoW ( + _In_ RPC_BINDING_HANDLE Binding, + _In_opt_ RPC_WSTR ServerPrincName, + _In_ unsigned long AuthnLevel, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_IDENTITY_HANDLE AuthIdentity, + _In_ unsigned long AuthzSvc + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingSetAuthInfoExW ( + _In_ RPC_BINDING_HANDLE Binding, + _In_opt_ RPC_WSTR ServerPrincName, + _In_ unsigned long AuthnLevel, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_IDENTITY_HANDLE AuthIdentity, + _In_ unsigned long AuthzSvc, + _In_opt_ RPC_SECURITY_QOS * SecurityQOS + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthInfoExA ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ RPC_AUTH_IDENTITY_HANDLE __RPC_FAR * AuthIdentity, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc, + _In_ unsigned long RpcQosVersion, + _Out_opt_ RPC_SECURITY_QOS *SecurityQOS + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthInfoExW ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ RPC_AUTH_IDENTITY_HANDLE __RPC_FAR * AuthIdentity, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc, + _In_ unsigned long RpcQosVersion, + _Out_opt_ RPC_SECURITY_QOS * SecurityQOS + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +typedef void +(__RPC_USER * RPC_AUTH_KEY_RETRIEVAL_FN) ( + _In_ void __RPC_FAR * Arg, + _In_ RPC_WSTR ServerPrincName, + _In_ unsigned long KeyVer, + _Outptr_ void __RPC_FAR * __RPC_FAR * Key, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerCompleteSecurityCallback( + _In_ RPC_BINDING_HANDLE BindingHandle, + _In_ RPC_STATUS Status + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerRegisterAuthInfoA ( + _In_opt_ RPC_CSTR ServerPrincName, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_KEY_RETRIEVAL_FN GetKeyFn, + _In_opt_ void __RPC_FAR * Arg + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerRegisterAuthInfoW ( + _In_opt_ RPC_WSTR ServerPrincName, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_KEY_RETRIEVAL_FN GetKeyFn, + _In_opt_ void __RPC_FAR * Arg + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +#ifdef UNICODE +#define RpcBindingInqAuthClient RpcBindingInqAuthClientW +#define RpcBindingInqAuthClientEx RpcBindingInqAuthClientExW +#define RpcBindingInqAuthInfo RpcBindingInqAuthInfoW +#define RpcBindingSetAuthInfo RpcBindingSetAuthInfoW +#define RpcServerRegisterAuthInfo RpcServerRegisterAuthInfoW +#define RpcBindingInqAuthInfoEx RpcBindingInqAuthInfoExW +#define RpcBindingSetAuthInfoEx RpcBindingSetAuthInfoExW +#else /* UNICODE */ +#define RpcBindingInqAuthClient RpcBindingInqAuthClientA +#define RpcBindingInqAuthClientEx RpcBindingInqAuthClientExA +#define RpcBindingInqAuthInfo RpcBindingInqAuthInfoA +#define RpcBindingSetAuthInfo RpcBindingSetAuthInfoA +#define RpcServerRegisterAuthInfo RpcServerRegisterAuthInfoA +#define RpcBindingInqAuthInfoEx RpcBindingInqAuthInfoExA +#define RpcBindingSetAuthInfoEx RpcBindingSetAuthInfoExA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClient ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_WSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthClientEx ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_AUTHZ_HANDLE __RPC_FAR * Privs, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc, + _In_ unsigned long Flags + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingInqAuthInfo ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * ServerPrincName, + _Out_opt_ unsigned long __RPC_FAR * AuthnLevel, + _Out_opt_ unsigned long __RPC_FAR * AuthnSvc, + _Out_opt_ RPC_AUTH_IDENTITY_HANDLE __RPC_FAR * AuthIdentity, + _Out_opt_ unsigned long __RPC_FAR * AuthzSvc + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcBindingSetAuthInfo ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ RPC_CSTR ServerPrincName, + _In_ unsigned long AuthnLevel, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_IDENTITY_HANDLE AuthIdentity, + _In_ unsigned long AuthzSvc + ); + +typedef void +(__RPC_USER * RPC_AUTH_KEY_RETRIEVAL_FN) ( + _In_ void __RPC_FAR * Arg, + _In_ unsigned char __RPC_FAR * ServerPrincName, + _In_ unsigned long KeyVer, + _Out_ void __RPC_FAR * __RPC_FAR * Key, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerRegisterAuthInfo ( + _In_ RPC_CSTR ServerPrincName, + _In_ unsigned long AuthnSvc, + _In_opt_ RPC_AUTH_KEY_RETRIEVAL_FN GetKeyFn, + _In_opt_ OPTIONAL void __RPC_FAR * Arg + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if (NTDDI_VERSION >= NTDDI_WINXP) +#if !defined(_M_IA64) +typedef struct { + unsigned char __RPC_FAR * UserName; + unsigned char __RPC_FAR * ComputerName; + unsigned short Privilege; + unsigned long AuthFlags; +} RPC_CLIENT_INFORMATION1, __RPC_FAR * PRPC_CLIENT_INFORMATION1; +#endif +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcBindingServerFromClient ( + _In_opt_ RPC_BINDING_HANDLE ClientBinding, + _Out_ RPC_BINDING_HANDLE __RPC_FAR * ServerBinding + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +DECLSPEC_NORETURN +void +RPC_ENTRY +RpcRaiseException ( + _In_ RPC_STATUS exception + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcTestCancel( + void + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcServerTestCancel ( + _In_opt_ RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcCancelThread( + _In_ void * Thread + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcCancelThreadEx( + _In_ void * Thread, + _In_ long Timeout + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidCreate ( + _Out_ UUID __RPC_FAR * Uuid + ); + +/* client/server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +UuidCreateSequential ( + _Out_ UUID __RPC_FAR * Uuid + ); + +#ifdef RPC_UNICODE_SUPPORTED + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidToStringA ( + _In_ const UUID __RPC_FAR * Uuid, + _Outptr_ RPC_CSTR __RPC_FAR * StringUuid + ); + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidFromStringA ( + _In_opt_ RPC_CSTR StringUuid, + _Out_ UUID __RPC_FAR * Uuid + ); + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidToStringW ( + _In_ const UUID __RPC_FAR * Uuid, + _Outptr_ RPC_WSTR __RPC_FAR * StringUuid + ); + +/* client/server */ +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidFromStringW ( + _In_opt_ RPC_WSTR StringUuid, + _Out_ UUID __RPC_FAR * Uuid + ); + +#ifdef UNICODE +#define UuidFromString UuidFromStringW +#define UuidToString UuidToStringW +#else /* UNICODE */ +#define UuidFromString UuidFromStringA +#define UuidToString UuidToStringA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +/* client/server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +UuidToString ( + _In_ const UUID __RPC_FAR * Uuid, + _Outptr_ RPC_CSTR __RPC_FAR * StringUuid + ); + +/* client/server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +UuidFromString ( + _In_opt_ RPC_CSTR StringUuid, + _Out_ UUID __RPC_FAR * Uuid + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +signed int +RPC_ENTRY +UuidCompare ( + _In_ UUID __RPC_FAR * Uuid1, + _In_ UUID __RPC_FAR * Uuid2, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +UuidCreateNil ( + _Out_ UUID __RPC_FAR * NilUuid + ); + +RPCRTAPI +int +RPC_ENTRY +UuidEqual ( + _In_ UUID __RPC_FAR * Uuid1, + _In_ UUID __RPC_FAR * Uuid2, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +RPCRTAPI +unsigned short +RPC_ENTRY +UuidHash ( + _In_ UUID __RPC_FAR * Uuid, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +RPCRTAPI +int +RPC_ENTRY +UuidIsNil ( + _In_ UUID __RPC_FAR * Uuid, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpRegisterNoReplaceA ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_CSTR Annotation + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpRegisterNoReplaceW ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_WSTR Annotation + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpRegisterA ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_CSTR Annotation + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpRegisterW ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_WSTR Annotation + ); + +#ifdef UNICODE +#define RpcEpRegisterNoReplace RpcEpRegisterNoReplaceW +#define RpcEpRegister RpcEpRegisterW +#else /* UNICODE */ +#define RpcEpRegisterNoReplace RpcEpRegisterNoReplaceA +#define RpcEpRegister RpcEpRegisterA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcEpRegisterNoReplace ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_CSTR Annotation + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcEpRegister ( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector, + _In_opt_ RPC_CSTR Annotation + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcEpUnregister( + _In_ RPC_IF_HANDLE IfSpec, + _In_ RPC_BINDING_VECTOR * BindingVector, + _In_opt_ UUID_VECTOR * UuidVector + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#define DCE_C_ERROR_STRING_LEN 256 + +#ifdef RPC_UNICODE_SUPPORTED + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +DceErrorInqTextA ( + _In_ RPC_STATUS RpcStatus, + _Out_writes_(DCE_C_ERROR_STRING_LEN) RPC_CSTR ErrorText + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +DceErrorInqTextW ( + _In_ RPC_STATUS RpcStatus, + _Out_writes_(DCE_C_ERROR_STRING_LEN) RPC_WSTR ErrorText + ); + +#ifdef UNICODE +#define DceErrorInqText DceErrorInqTextW +#else /* UNICODE */ +#define DceErrorInqText DceErrorInqTextA +#endif /* UNICODE */ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#else /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +DceErrorInqText ( + _In_ RPC_STATUS RpcStatus, + _Out_writes_(DCE_C_ERROR_STRING_LEN) RPC_CSTR ErrorText + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* RPC_UNICODE_SUPPORTED */ + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +typedef I_RPC_HANDLE * RPC_EP_INQ_HANDLE; + +#define RPC_C_EP_ALL_ELTS 0 +#define RPC_C_EP_MATCH_BY_IF 1 +#define RPC_C_EP_MATCH_BY_OBJ 2 +#define RPC_C_EP_MATCH_BY_BOTH 3 + +#define RPC_C_VERS_ALL 1 +#define RPC_C_VERS_COMPATIBLE 2 +#define RPC_C_VERS_EXACT 3 +#define RPC_C_VERS_MAJOR_ONLY 4 +#define RPC_C_VERS_UPTO 5 + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEpEltInqBegin ( + _In_opt_ OPTIONAL RPC_BINDING_HANDLE EpBinding, + _In_ unsigned long InquiryType, + _In_opt_ RPC_IF_ID __RPC_FAR * IfId, + _In_opt_ unsigned long VersOption, + _In_opt_ UUID __RPC_FAR * ObjectUuid, + _Out_ RPC_EP_INQ_HANDLE __RPC_FAR * InquiryContext + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEpEltInqDone ( + _Inout_ RPC_EP_INQ_HANDLE __RPC_FAR * InquiryContext + ); + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEpEltInqNextA ( + _In_ RPC_EP_INQ_HANDLE InquiryContext, + _Out_ RPC_IF_ID __RPC_FAR * IfId, + _Out_opt_ RPC_BINDING_HANDLE __RPC_FAR * Binding, + _Out_opt_ UUID __RPC_FAR * ObjectUuid, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Annotation + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEpEltInqNextW ( + _In_ RPC_EP_INQ_HANDLE InquiryContext, + _Out_ RPC_IF_ID __RPC_FAR * IfId, + _Out_opt_ RPC_BINDING_HANDLE __RPC_FAR * Binding, + _Out_opt_ UUID __RPC_FAR * ObjectUuid, + _Outptr_opt_ RPC_WSTR __RPC_FAR * Annotation + ); + +#ifdef UNICODE +#define RpcMgmtEpEltInqNext RpcMgmtEpEltInqNextW +#else /* UNICODE */ +#define RpcMgmtEpEltInqNext RpcMgmtEpEltInqNextA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcMgmtEpEltInqNext ( + _In_ RPC_EP_INQ_HANDLE InquiryContext, + _Out_ RPC_IF_ID __RPC_FAR * IfId, + _Out_opt_ RPC_BINDING_HANDLE __RPC_FAR * Binding, + _Outptr_opt_ RPC_CSTR __RPC_FAR * Annotation + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtEpUnregister ( + _In_opt_ RPC_BINDING_HANDLE EpBinding, + _In_ RPC_IF_ID __RPC_FAR * IfId, + _In_ RPC_BINDING_HANDLE Binding, + _In_opt_ UUID __RPC_FAR * ObjectUuid + ); + +typedef int +(__RPC_API * RPC_MGMT_AUTHORIZATION_FN) ( + _In_ RPC_BINDING_HANDLE ClientBinding, + _In_ unsigned long RequestedMgmtOperation, + _Out_ RPC_STATUS __RPC_FAR * Status + ); + +#define RPC_C_MGMT_INQ_IF_IDS 0 +#define RPC_C_MGMT_INQ_PRINC_NAME 1 +#define RPC_C_MGMT_INQ_STATS 2 +#define RPC_C_MGMT_IS_SERVER_LISTEN 3 +#define RPC_C_MGMT_STOP_SERVER_LISTEN 4 + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +RpcMgmtSetAuthorizationFn ( + _In_ RPC_MGMT_AUTHORIZATION_FN AuthorizationFn + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +RPCRTAPI +int +RPC_ENTRY +RpcExceptionFilter ( + _In_ unsigned long ExceptionCode + ); +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#define RPC_C_PARM_MAX_PACKET_LENGTH 1 +#define RPC_C_PARM_BUFFER_LENGTH 2 + +#define RPC_IF_AUTOLISTEN 0x0001 +#define RPC_IF_OLE 0x0002 +#define RPC_IF_ALLOW_UNKNOWN_AUTHORITY 0x0004 +#define RPC_IF_ALLOW_SECURE_ONLY 0x0008 +#define RPC_IF_ALLOW_CALLBACKS_WITH_NO_AUTH 0x0010 +#define RPC_IF_ALLOW_LOCAL_ONLY 0x0020 +#define RPC_IF_SEC_NO_CACHE 0x0040 +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_IF_SEC_CACHE_PER_PROC 0x0080 +#define RPC_IF_ASYNC_CALLBACK 0x0100 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_FW_IF_FLAG_DCOM 0x0001 +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + + +#if (NTDDI_VERSION >= NTDDI_WIN8) +typedef void *RPC_INTERFACE_GROUP, **PRPC_INTERFACE_GROUP; + +#ifdef RPC_UNICODE_SUPPORTED +typedef struct +{ + unsigned long Version; + RPC_WSTR ProtSeq; + RPC_WSTR Endpoint; + void * SecurityDescriptor; + unsigned long Backlog; +} RPC_ENDPOINT_TEMPLATEW, *PRPC_ENDPOINT_TEMPLATEW; + +typedef struct +{ + unsigned long Version; + RPC_CSTR ProtSeq; + RPC_CSTR Endpoint; + void * SecurityDescriptor; + unsigned long Backlog; +} RPC_ENDPOINT_TEMPLATEA, *PRPC_ENDPOINT_TEMPLATEA; + +#ifdef UNICODE +#define RPC_ENDPOINT_TEMPLATE RPC_ENDPOINT_TEMPLATEW +#define PRPC_ENDPOINT_TEMPLATE PRPC_ENDPOINT_TEMPLATEW +#else /* UNICODE */ +#define RPC_ENDPOINT_TEMPLATE RPC_ENDPOINT_TEMPLATEA +#define PRPC_ENDPOINT_TEMPLATE PRPC_ENDPOINT_TEMPLATEA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ +typedef struct +{ + unsigned long Version; + RPC_CSTR ProtSeq; + RPC_CSTR Endpoint; + void * SecurityDescriptor; + unsigned long Backlog; +} RPC_ENDPOINT_TEMPLATE, *PRPC_ENDPOINT_TEMPLATE; +#endif /* RPC_UNICODE_SUPPORTED */ + +#ifdef RPC_UNICODE_SUPPORTED +typedef struct +{ + unsigned long Version; + RPC_IF_HANDLE IfSpec; + UUID * MgrTypeUuid; + RPC_MGR_EPV * MgrEpv; + unsigned int Flags; + unsigned int MaxCalls; + unsigned int MaxRpcSize; + RPC_IF_CALLBACK_FN *IfCallback; + UUID_VECTOR *UuidVector; + RPC_CSTR Annotation; + void * SecurityDescriptor; +} RPC_INTERFACE_TEMPLATEA, *PRPC_INTERFACE_TEMPLATEA; + +typedef struct +{ + unsigned long Version; + RPC_IF_HANDLE IfSpec; + UUID * MgrTypeUuid; + RPC_MGR_EPV * MgrEpv; + unsigned int Flags; + unsigned int MaxCalls; + unsigned int MaxRpcSize; + RPC_IF_CALLBACK_FN *IfCallback; + UUID_VECTOR *UuidVector; + RPC_WSTR Annotation; + void * SecurityDescriptor; +} RPC_INTERFACE_TEMPLATEW, *PRPC_INTERFACE_TEMPLATEW; + +#ifdef UNICODE +#define RPC_INTERFACE_TEMPLATE RPC_INTERFACE_TEMPLATEW +#define PRPC_INTERFACE_TEMPLATE PRPC_INTERFACE_TEMPLATEW +#else /* UNICODE */ +#define RPC_INTERFACE_TEMPLATE RPC_INTERFACE_TEMPLATEA +#define PRPC_INTERFACE_TEMPLATE PRPC_INTERFACE_TEMPLATEA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +typedef struct +{ + unsigned long Version; + RPC_IF_HANDLE IfSpec; + UUID * MgrTypeUuid; + RPC_MGR_EPV * MgrEpv; + unsigned int Flags; + unsigned int MaxCalls; + unsigned int MaxRpcSize; + RPC_IF_CALLBACK_FN *IfCallback; + UUID_VECTOR *UuidVector; + RPC_CSTR Annotation; + void * SecurityDescriptor; +} RPC_INTERFACE_TEMPLATE, *PRPC_INTERFACE_TEMPLATE; + +#endif /* RPC_UNICODE_SUPPORTED */ + + + +typedef void RPC_ENTRY +RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN ( + _In_ RPC_INTERFACE_GROUP IfGroup, + _In_ void* IdleCallbackContext, + _In_ unsigned long IsGroupIdle + ); + +#ifdef RPC_UNICODE_SUPPORTED + +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupCreateW ( + _In_reads_(NumIfs) RPC_INTERFACE_TEMPLATEW *Interfaces, + _In_ unsigned long NumIfs, + _In_reads_(NumEndpoints) RPC_ENDPOINT_TEMPLATEW *Endpoints, + _In_ unsigned long NumEndpoints, + _In_ unsigned long IdlePeriod, + _In_ RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN IdleCallbackFn, + _In_ void* IdleCallbackContext, + _Out_ PRPC_INTERFACE_GROUP IfGroup + ); + + +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupCreateA ( + _In_reads_(NumIfs) RPC_INTERFACE_TEMPLATEA *Interfaces, + _In_ unsigned long NumIfs, + _In_reads_(NumEndpoints) RPC_ENDPOINT_TEMPLATEA *Endpoints, + _In_ unsigned long NumEndpoints, + _In_ unsigned long IdlePeriod, + _In_ RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN IdleCallbackFn, + _In_ void* IdleCallbackContext, + _Out_ PRPC_INTERFACE_GROUP IfGroup + ); + +#ifdef UNICODE +#define RpcServerInterfaceGroupCreate RpcServerInterfaceGroupCreateW +#else /* UNICODE */ +#define RpcServerInterfaceGroupCreate RpcServerInterfaceGroupCreateA +#endif /* UNICODE */ + +#else /* RPC_UNICODE_SUPPORTED */ + +/* server */ +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupCreate ( + _In_reads_(NumIfs) RPC_INTERFACE_TEMPLATE *Interfaces, + _In_ unsigned long NumIfs, + _In_reads_(NumEndpoints) RPC_ENDPOINT_TEMPLATE *Endpoints, + _In_ unsigned long NumEndpoints, + _In_ unsigned long IdlePeriod, + _In_ RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN IdleCallbackFn, + _In_ void* IdleCallbackContext, + _Out_ PRPC_INTERFACE_GROUP IfGroup + ); + +#endif /* RPC_UNICODE_SUPPORTED */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupClose ( + _In_ RPC_INTERFACE_GROUP IfGroup + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupActivate ( + _In_ RPC_INTERFACE_GROUP IfGroup + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupDeactivate ( + _In_ RPC_INTERFACE_GROUP IfGroup, + _In_ unsigned long ForceDeactivation + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcServerInterfaceGroupInqBindings ( + _In_ RPC_INTERFACE_GROUP IfGroup, + _Outptr_ RPC_BINDING_VECTOR __RPC_FAR * __RPC_FAR * BindingVector + ); + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#include + +#ifdef __cplusplus +} +#endif + +#endif /* __RPCDCE_H__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdcep.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdcep.h new file mode 100644 index 0000000000000000000000000000000000000000..8b038177ceed370cabc619b27e208012b6f1663c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcdcep.h @@ -0,0 +1,1337 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpcdcep.h + +Abstract: + + This module contains the private RPC runtime APIs for use by the + stubs and by support libraries. Applications must not call these + routines. + +--*/ + +//@[contract("rpcdcep"), comment("MVI_tracked - https://osgwiki.com/wiki/Microsoft_Virus_Initiative")]; + +#ifndef __RPCDCEP_H__ +#define __RPCDCEP_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#pragma warning(disable:4820) // padding added after data member +#endif + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +typedef struct _RPC_VERSION { + unsigned short MajorVersion; + unsigned short MinorVersion; +} RPC_VERSION; + +typedef struct _RPC_SYNTAX_IDENTIFIER { + GUID SyntaxGUID; + RPC_VERSION SyntaxVersion; +} RPC_SYNTAX_IDENTIFIER, __RPC_FAR * PRPC_SYNTAX_IDENTIFIER; + +typedef struct _RPC_MESSAGE +{ + RPC_BINDING_HANDLE Handle; + unsigned long DataRepresentation; + void __RPC_FAR * Buffer; + unsigned int BufferLength; + unsigned int ProcNum; + PRPC_SYNTAX_IDENTIFIER TransferSyntax; + void __RPC_FAR * RpcInterfaceInformation; + void __RPC_FAR * ReservedForRuntime; + RPC_MGR_EPV __RPC_FAR * ManagerEpv; + void __RPC_FAR * ImportContext; + unsigned long RpcFlags; +} RPC_MESSAGE, __RPC_FAR * PRPC_MESSAGE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +typedef RPC_STATUS +RPC_ENTRY RPC_FORWARD_FUNCTION( + IN UUID __RPC_FAR * InterfaceId, + IN RPC_VERSION __RPC_FAR * InterfaceVersion, + IN UUID __RPC_FAR * ObjectId, + IN unsigned char __RPC_FAR * Rpcpro, + IN void __RPC_FAR * __RPC_FAR * ppDestEndpoint); + +enum RPC_ADDRESS_CHANGE_TYPE +{ + PROTOCOL_NOT_LOADED = 1, + PROTOCOL_LOADED, + PROTOCOL_ADDRESS_CHANGE +}; + +typedef void +RPC_ENTRY RPC_ADDRESS_CHANGE_FN( + IN void * arg + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +/* +* New context handle flavors. +*/ +#define RPC_CONTEXT_HANDLE_DEFAULT_GUARD ((void *)(ULONG_PTR)0xFFFFF00D) + +#define RPC_CONTEXT_HANDLE_DEFAULT_FLAGS 0x00000000UL +#define RPC_CONTEXT_HANDLE_FLAGS 0x30000000UL +#define RPC_CONTEXT_HANDLE_SERIALIZE 0x10000000UL +#define RPC_CONTEXT_HANDLE_DONT_SERIALIZE 0x20000000UL +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_TYPE_STRICT_CONTEXT_HANDLE 0x40000000UL +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +#define RPC_TYPE_DISCONNECT_EVENT_CONTEXT_HANDLE 0x80000000UL +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS5) + +/* + * Types of function calls for datagram rpc + */ + +#define RPC_NCA_FLAGS_DEFAULT 0x00000000 /* 0b000...000 */ +#define RPC_NCA_FLAGS_IDEMPOTENT 0x00000001 /* 0b000...001 */ +#define RPC_NCA_FLAGS_BROADCAST 0x00000002 /* 0b000...010 */ +#define RPC_NCA_FLAGS_MAYBE 0x00000004 /* 0b000...100 */ + +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPCFLG_HAS_GUARANTEE 0x00000010UL +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPCFLG_WINRT_REMOTE_ASYNC 0x00000020UL + +/* Flags used in RpcFlag field of RPC_MESSAGE structure */ + +#define RPC_BUFFER_COMPLETE 0x00001000 /* used by pipes */ +#define RPC_BUFFER_PARTIAL 0x00002000 /* used by pipes */ +#define RPC_BUFFER_EXTRA 0x00004000 /* used by pipes */ +#define RPC_BUFFER_ASYNC 0x00008000 /* used by async rpc */ +#define RPC_BUFFER_NONOTIFY 0x00010000 /* used by async pipes */ + +#define RPCFLG_MESSAGE 0x01000000UL +#define RPCFLG_AUTO_COMPLETE 0x08000000UL +#define RPCFLG_LOCAL_CALL 0x10000000UL +#define RPCFLG_INPUT_SYNCHRONOUS 0x20000000UL +#define RPCFLG_ASYNCHRONOUS 0x40000000UL +#define RPCFLG_NON_NDR 0x80000000UL + +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define RPCFLG_HAS_MULTI_SYNTAXES 0x02000000UL +#define RPCFLG_HAS_CALLBACK 0x04000000UL +#endif // (NTDDI_VERSION >= NTDDI_WXP) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +// These two bits will hold the combination of +// anonymous/admin/authenticate/mixed mode +#define RPCFLG_ACCESSIBILITY_BIT1 0x00100000UL +#define RPCFLG_ACCESSIBILITY_BIT2 0x00200000UL +#define RPCFLG_ACCESS_LOCAL 0x00400000UL + +// This goes to MIDL_STUB_DESC only +#define NDR_CUSTOM_OR_DEFAULT_ALLOCATOR 0x10000000UL +#define NDR_DEFAULT_ALLOCATOR 0x20000000UL +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +// NDR64 on ARM includes ARM parameter layout info +#define RPCFLG_NDR64_CONTAINS_ARM_LAYOUT 0x04000000UL +#endif + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +/* + * Used by COM to inform RPC that even though this is an + * async RPC call, there is a thread waiting for the call + * to complete. Essentially, from COM perspective, this is a + * sync call. This flag will be passed down to ALPC in order + * to count the wake charges properly. + */ + +#define RPCFLG_SENDER_WAITING_FOR_REPLY 0x00800000UL + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#define RPC_FLAGS_VALID_BIT 0x00008000 + +typedef +void +(__RPC_STUB __RPC_FAR * RPC_DISPATCH_FUNCTION) ( + IN OUT PRPC_MESSAGE Message + ); + +typedef struct { + unsigned int DispatchTableCount; + RPC_DISPATCH_FUNCTION __RPC_FAR * DispatchTable; + LONG_PTR Reserved; +} RPC_DISPATCH_TABLE, __RPC_FAR * PRPC_DISPATCH_TABLE; + +typedef struct _RPC_PROTSEQ_ENDPOINT +{ + unsigned char __RPC_FAR * RpcProtocolSequence; + unsigned char __RPC_FAR * Endpoint; +} RPC_PROTSEQ_ENDPOINT, __RPC_FAR * PRPC_PROTSEQ_ENDPOINT; + +/* +Both of these types MUST start with the InterfaceId and TransferSyntax. +Look at RpcIfInqId and I_RpcIfInqTransferSyntaxes to see why. +*/ +#define NT351_INTERFACE_SIZE 0x40 +#define RPC_INTERFACE_HAS_PIPES 0x0001 + +typedef struct _RPC_SERVER_INTERFACE +{ + unsigned int Length; + RPC_SYNTAX_IDENTIFIER InterfaceId; + RPC_SYNTAX_IDENTIFIER TransferSyntax; + PRPC_DISPATCH_TABLE DispatchTable; + unsigned int RpcProtseqEndpointCount; + PRPC_PROTSEQ_ENDPOINT RpcProtseqEndpoint; + RPC_MGR_EPV __RPC_FAR *DefaultManagerEpv; + void const __RPC_FAR *InterpreterInfo; + unsigned int Flags ; +} RPC_SERVER_INTERFACE, __RPC_FAR * PRPC_SERVER_INTERFACE; + +typedef struct _RPC_CLIENT_INTERFACE +{ + unsigned int Length; + RPC_SYNTAX_IDENTIFIER InterfaceId; + RPC_SYNTAX_IDENTIFIER TransferSyntax; + PRPC_DISPATCH_TABLE DispatchTable; + unsigned int RpcProtseqEndpointCount; + PRPC_PROTSEQ_ENDPOINT RpcProtseqEndpoint; + ULONG_PTR Reserved; + void const __RPC_FAR * InterpreterInfo; + unsigned int Flags ; +} RPC_CLIENT_INTERFACE, __RPC_FAR * PRPC_CLIENT_INTERFACE; + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if (NTDDI_VERSION >= NTDDI_WINXP) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcNegotiateTransferSyntax ( + IN OUT RPC_MESSAGE __RPC_FAR * Message + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcGetBuffer ( + IN OUT RPC_MESSAGE __RPC_FAR * Message + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcGetBufferWithObject ( + IN OUT RPC_MESSAGE __RPC_FAR * Message, + IN UUID * ObjectUuid + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcSendReceive ( + IN OUT RPC_MESSAGE __RPC_FAR * Message + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcFreeBuffer ( + IN OUT RPC_MESSAGE __RPC_FAR * Message + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcSend ( + IN OUT PRPC_MESSAGE Message + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcReceive ( + IN OUT PRPC_MESSAGE Message, + IN unsigned int Size + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcFreePipeBuffer ( + IN OUT RPC_MESSAGE __RPC_FAR * Message + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcReallocPipeBuffer ( + _In_ PRPC_MESSAGE Message, + unsigned int NewSize + ); + +typedef void * I_RPC_MUTEX; + +RPCRTAPI +void +RPC_ENTRY +I_RpcRequestMutex ( + IN OUT I_RPC_MUTEX * Mutex + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcClearMutex ( + IN I_RPC_MUTEX Mutex + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcDeleteMutex ( + IN I_RPC_MUTEX Mutex + ); + +RPCRTAPI +void __RPC_FAR * +RPC_ENTRY +I_RpcAllocate ( + IN unsigned int Size + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcFree ( + IN void __RPC_FAR * Object + ); + +#define RPC_SYSTEM_HANDLE_FREE_UNRETRIEVED 1 +#define RPC_SYSTEM_HANDLE_FREE_RETRIEVED 2 +#define RPC_SYSTEM_HANDLE_FREE_ALL 3 +#define RPC_SYSTEM_HANDLE_FREE_ERROR_ON_CLOSE 4 + +RPCRTAPI +unsigned long +RPC_ENTRY +I_RpcFreeSystemHandleCollection ( + _Inout_ void * CallObj, + _In_ unsigned long FreeFlags + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcSetSystemHandle ( + _In_ void * Handle, + _In_ unsigned char Type, + _In_ unsigned long AccessMask, + _Inout_ void * CallObj, + _Out_ unsigned long * HandleIndex + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcGetSystemHandle ( + _Out_writes_bytes_(sizeof(HANDLE)) unsigned char* pMemory, + _In_ unsigned char Type, + _In_ unsigned long AccessMask, + _In_ unsigned long HandleIndex, + _Inout_ void * CallObj + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcFreeSystemHandle ( + _In_ unsigned char Type, + _In_ void * Handle + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcPauseExecution ( + IN unsigned long Milliseconds + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcGetExtendedError ( + void + ); + + +typedef enum _LRPC_SYSTEM_HANDLE_MARSHAL_DIRECTION +{ + MarshalDirectionMarshal, + MarshalDirectionUnmarshal +}LRPC_SYSTEM_HANDLE_MARSHAL_DIRECTION; + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcSystemHandleTypeSpecificWork ( + _Inout_ void * Handle, + _In_ unsigned char ActualType, + _In_ unsigned char IdlType, + _In_ LRPC_SYSTEM_HANDLE_MARSHAL_DIRECTION MarshalDirection + ); + +typedef +void +(__RPC_USER __RPC_FAR * PRPC_RUNDOWN) ( + void __RPC_FAR * AssociationContext + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcMonitorAssociation ( + IN RPC_BINDING_HANDLE Handle, + IN PRPC_RUNDOWN RundownRoutine, + IN void * Context + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcStopMonitorAssociation ( + IN RPC_BINDING_HANDLE Handle + ); + +RPCRTAPI +RPC_BINDING_HANDLE +RPC_ENTRY +I_RpcGetCurrentCallHandle( + void + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcGetAssociationContext ( + IN RPC_BINDING_HANDLE BindingHandle, + OUT void __RPC_FAR * __RPC_FAR * AssociationContext + ); + +RPCRTAPI +void * +RPC_ENTRY +I_RpcGetServerContextList ( + IN RPC_BINDING_HANDLE BindingHandle + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcSetServerContextList ( + IN RPC_BINDING_HANDLE BindingHandle, + OUT void * ServerContextList + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcNsInterfaceExported ( + IN unsigned long EntryNameSyntax, + IN unsigned short *EntryName, + IN RPC_SERVER_INTERFACE * RpcInterfaceInformation + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcNsInterfaceUnexported ( + IN unsigned long EntryNameSyntax, + IN unsigned short *EntryName, + IN RPC_SERVER_INTERFACE * RpcInterfaceInformation + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingToStaticStringBindingW ( + IN RPC_BINDING_HANDLE Binding, + OUT unsigned short **StringBinding + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqSecurityContext ( + IN RPC_BINDING_HANDLE Binding, + OUT void **SecurityContextHandle + ); + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef struct _RPC_SEC_CONTEXT_KEY_INFO +{ + unsigned long EncryptAlgorithm; + unsigned long KeySize; + unsigned long SignatureAlgorithm; +} +RPC_SEC_CONTEXT_KEY_INFO, *PRPC_SEC_CONTEXT_KEY_INFO; + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqSecurityContextKeyInfo ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _Inout_ void *KeyInfo + ); + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqWireIdForSnego ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned char * WireId + ); + +#if (NTDDI_VERSION >= NTDDI_WS03) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqMarshalledTargetInfo ( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned long * MarshalledTargetInfoSize, + _Outptr_result_bytebuffer_(* MarshalledTargetInfoSize) RPC_CSTR * MarshalledTargetInfo + ); +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_WINXP) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqLocalClientPID ( + IN RPC_BINDING_HANDLE Binding, + OUT unsigned long *Pid + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingHandleToAsyncHandle ( + IN RPC_BINDING_HANDLE Binding, + OUT void **AsyncHandle + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcNsBindingSetEntryNameW ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _In_ RPC_WSTR EntryName + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcNsBindingSetEntryNameA ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _In_ RPC_CSTR EntryName + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseqEp2A ( + _In_opt_ RPC_CSTR NetworkAddress, + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_CSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ void * Policy + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseqEp2W ( + _In_opt_ RPC_WSTR NetworkAddress, + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_WSTR Endpoint, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ void * Policy + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseq2W ( + _In_opt_ RPC_WSTR NetworkAddress, + _In_ RPC_WSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ void * Policy + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseq2A ( + _In_opt_ RPC_CSTR NetworkAddress, + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_opt_ void __RPC_FAR * SecurityDescriptor, + _In_ void * Policy + ); + + +#ifdef UNICODE +#define I_RpcNsBindingSetEntryName I_RpcNsBindingSetEntryNameW +#define I_RpcServerUseProtseqEp2 I_RpcServerUseProtseqEp2W +#define I_RpcServerUseProtseq2 I_RpcServerUseProtseq2W +#else +#define I_RpcNsBindingSetEntryName I_RpcNsBindingSetEntryNameA +#define I_RpcServerUseProtseqEp2 I_RpcServerUseProtseqEp2A +#define I_RpcServerUseProtseq2 I_RpcServerUseProtseq2A +#endif + +#else + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcNsBindingSetEntryName ( + _In_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long EntryNameSyntax, + _In_ RPC_CSTR EntryName + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseq2 ( + _In_ RPC_CSTR NetworkAddress, + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ void __RPC_FAR * SecurityDescriptor, + _In_ void * Policy + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerUseProtseqEp2 ( + _In_ RPC_CSTR NetworkAddress, + _In_ RPC_CSTR Protseq, + _In_ unsigned int MaxCalls, + _In_ RPC_CSTR Endpoint, + _In_ void __RPC_FAR *SecurityDescriptor, + _In_ void *Policy + ); +#endif + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerStartService ( + _In_ RPC_WSTR Protseq, + _In_ RPC_WSTR Endpoint, + _In_ RPC_IF_HANDLE IfSpec + ); + +#ifdef RPC_UNICODE_SUPPORTED + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqDynamicEndpointW ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_result_maybenull_ RPC_WSTR __RPC_FAR *DynamicEndpoint + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqDynamicEndpointA ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_result_maybenull_ RPC_CSTR __RPC_FAR *DynamicEndpoint + ); + +#ifdef UNICODE +#define I_RpcBindingInqDynamicEndpoint I_RpcBindingInqDynamicEndpointW +#else +#define I_RpcBindingInqDynamicEndpoint I_RpcBindingInqDynamicEndpointA +#endif + +#else + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqDynamicEndpoint ( + _In_ RPC_BINDING_HANDLE Binding, + _Outptr_result_maybenull_ RPC_CSTR __RPC_FAR *DynamicEndpoint + ); + +#endif + +#if (NTDDI_VERSION >= NTDDI_WINXP) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerCheckClientRestriction ( + IN RPC_BINDING_HANDLE Context + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#define TRANSPORT_TYPE_CN 0x01 +#define TRANSPORT_TYPE_DG 0x02 +#define TRANSPORT_TYPE_LPC 0x04 +#define TRANSPORT_TYPE_WMSG 0x08 + +//@[comment("MVI_tracked")] +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqTransportType ( + IN RPC_BINDING_HANDLE Binding, + OUT unsigned int __RPC_FAR * Type + ); + +typedef struct _RPC_TRANSFER_SYNTAX +{ + UUID Uuid; + unsigned short VersMajor; + unsigned short VersMinor; +} RPC_TRANSFER_SYNTAX; + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcIfInqTransferSyntaxes ( + IN RPC_IF_HANDLE RpcIfHandle, + OUT RPC_TRANSFER_SYNTAX __RPC_FAR * TransferSyntaxes, + IN unsigned int TransferSyntaxSize, + OUT unsigned int __RPC_FAR * TransferSyntaxCount + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_UuidCreate ( + OUT UUID __RPC_FAR * Uuid + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcUninitializeNdrOle ( + void + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingCopy ( + IN RPC_BINDING_HANDLE SourceBinding, + OUT RPC_BINDING_HANDLE __RPC_FAR * DestinationBinding + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingIsClientLocal ( + IN OPTIONAL RPC_BINDING_HANDLE BindingHandle, + OUT unsigned int __RPC_FAR * ClientLocalFlag + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingInqConnId ( + IN RPC_BINDING_HANDLE Binding, + OUT void **ConnId, + OUT int *pfFirstCall + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingCreateNP ( + _In_ RPC_WSTR ServerName, + _In_ RPC_WSTR ServiceName, + _In_ RPC_WSTR NetworkOptions, + _Out_ RPC_BINDING_HANDLE *Binding + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcSsDontSerializeContext ( + void + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcLaunchDatagramReceiveThread( + void __RPC_FAR * pAddress + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcServerRegisterForwardFunction ( + IN RPC_FORWARD_FUNCTION * pForwardFunction + ); + +RPC_ADDRESS_CHANGE_FN * RPC_ENTRY +I_RpcServerInqAddressChangeFn( + void + ); + +RPC_STATUS RPC_ENTRY +I_RpcServerSetAddressChangeFn( + IN RPC_ADDRESS_CHANGE_FN * pAddressChangeFn + ); + +#if (NTDDI_VERSION >= NTDDI_WINXP) +/* The return buffer will contain SOCKADDR_IN for IPv4 */ +#define RPC_P_ADDR_FORMAT_TCP_IPV4 1 + +/* The return buffer will contain SOCKADDR_STORAGE for IPv6 */ +#define RPC_P_ADDR_FORMAT_TCP_IPV6 2 + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerInqLocalConnAddress ( + IN RPC_BINDING_HANDLE Binding, + IN OUT void *Buffer, + IN OUT unsigned long *BufferSize, + OUT unsigned long *AddressFormat + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerInqRemoteConnAddress ( + IN RPC_BINDING_HANDLE Binding, + IN OUT void *Buffer, + IN OUT unsigned long *BufferSize, + OUT unsigned long *AddressFormat + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcSessionStrictContextHandle ( + void + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcTurnOnEEInfoPropagation ( + void + ); +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcConnectionInqSockBuffSize( + OUT unsigned long __RPC_FAR * RecvBuffSize, + OUT unsigned long __RPC_FAR * SendBuffSize + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcConnectionSetSockBuffSize( + IN unsigned long RecvBuffSize, + IN unsigned long SendBuffSize + ); + +typedef +void +(*RPCLT_PDU_FILTER_FUNC) ( + IN void *Buffer, + IN unsigned int BufferLength, + IN int fDatagram + ); + +typedef +void +(__cdecl *RPC_SETFILTER_FUNC) ( + IN RPCLT_PDU_FILTER_FUNC pfnFilter + ); + +#ifndef WINNT +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcServerStartListening( + void * hWnd + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcServerStopListening( + void + ); + +typedef RPC_STATUS (*RPC_BLOCKING_FN) ( + IN void * hWnd, + IN void * Context, + IN OPTIONAL void * hSyncEvent + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcBindingSetAsync( + IN RPC_BINDING_HANDLE Binding, + IN RPC_BLOCKING_FN BlockingFn, + IN unsigned long ServerTid + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcSetThreadParams( + IN int fClientFree, + IN OPTIONAL void *Context, + IN OPTIONAL void * hWndClient + ); + +RPCRTAPI +unsigned int +RPC_ENTRY +I_RpcWindowProc( + IN void * hWnd, + IN unsigned int Message, + IN unsigned int wParam, + IN unsigned long lParam + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcServerUnregisterEndpointA ( + _In_ RPC_CSTR Protseq, + _In_ RPC_CSTR Endpoint + ); + +RPCRTAPI +_Must_inspect_result_ +RPC_STATUS +RPC_ENTRY +I_RpcServerUnregisterEndpointW ( + _In_ RPC_WSTR Protseq, + _In_ RPC_WSTR Endpoint + ); + +#ifdef UNICODE +#define I_RpcServerUnregisterEndpoint I_RpcServerUnregisterEndpointW +#else +#define I_RpcServerUnregisterEndpoint I_RpcServerUnregisterEndpointA +#endif +#endif // WINNT + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcServerInqTransportType( + OUT unsigned int __RPC_FAR * Type + ); + +RPCRTAPI +long +RPC_ENTRY +I_RpcMapWin32Status ( + IN RPC_STATUS Status + ); + +#if (NTDDI_VERSION >= NTDDI_WS03) + +#define RPC_C_OPT_SESSION_ID (6) +#define RPC_C_OPT_COOKIE_AUTH (7) +#define RPC_C_OPT_RESOURCE_TYPE_UUID (8) + +typedef struct _RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR +{ + unsigned long BufferSize; // Length of the buffer in bytes + _Field_size_bytes_(BufferSize) char *Buffer; // Zero-terminated string +} RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR; + +typedef struct _RDR_CALLOUT_STATE +{ + // LastError is used for debugging only - don't use it for processing + RPC_STATUS LastError; + void *LastEEInfo; + + RPC_HTTP_REDIRECTOR_STAGE LastCalledStage; + + // the information accumulated throughout the stages + unsigned short *ServerName; // Allocated with MemAllocate + unsigned short *ServerPort; // Allocated with MemAllocate + unsigned short *RemoteUser; // Allocated with MemAllocate + unsigned short *AuthType; // Allocated with MemAllocate + unsigned char ResourceTypePresent; + unsigned char SessionIdPresent; + unsigned char InterfacePresent; + UUID ResourceType; + UUID SessionId; + RPC_SYNTAX_IDENTIFIER Interface; + void *CertContext; // Contains PCCERT_CONTEXT if cert is used for authentication. + // NULL otherwise. If allocated, CertFreeCertificateContext + // needs to be called on it when done +} RDR_CALLOUT_STATE; +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef RPC_STATUS +(RPC_ENTRY *I_RpcProxyIsValidMachineFn) + ( + _In_ RPC_WSTR Machine, + _In_ RPC_WSTR DotMachine, + _In_ unsigned long PortNumber + ); + +typedef RPC_STATUS +(RPC_ENTRY *I_RpcProxyGetClientAddressFn) + ( + IN void *Context, + OUT char *Buffer, + OUT unsigned long *BufferLength + ); + +typedef RPC_STATUS +(RPC_ENTRY *I_RpcProxyGetConnectionTimeoutFn) + ( + OUT unsigned long *ConnectionTimeout + ); + +#if (NTDDI_VERSION >= NTDDI_WS03) +typedef RPC_STATUS +(RPC_ENTRY *I_RpcPerformCalloutFn) + ( + IN void *Context, + IN RDR_CALLOUT_STATE *CallOutState, + IN RPC_HTTP_REDIRECTOR_STAGE Stage + ); + +typedef void +(RPC_ENTRY *I_RpcFreeCalloutStateFn) + ( + IN RDR_CALLOUT_STATE *CallOutState + ); + +typedef RPC_STATUS +(RPC_ENTRY *I_RpcProxyGetClientSessionAndResourceUUID) + ( + _In_ void *Context, + _Out_opt_ int *SessionIdPresent, + _Out_opt_ UUID *SessionId, + _Out_ int *ResourceIdPresent, + _Out_ UUID *ResourceId + ); + +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef RPC_STATUS +(RPC_ENTRY *I_RpcProxyFilterIfFn) + ( + _In_ void *Context, + _In_ UUID *IfUuid, + _In_ unsigned short IfMajorVersion, + _Out_ int *fAllow + ); + +typedef enum RpcProxyPerfCounters +{ + RpcCurrentUniqueUser = 1, //Current Number of Unique Users + RpcBackEndConnectionAttempts, // Number of Back-End Connection Attempts per Second + RpcBackEndConnectionFailed, // Number of Failed Back-End Connection Attempts per Second + RpcRequestsPerSecond, //RPC/HTTP Requests per Second + RpcIncomingConnections, //Current Number of Incoming RPC over HTTP Connections + RpcIncomingBandwidth, // Total Incoming Bandwidth from Back-End Servers + RpcOutgoingBandwidth, // Total Outgoing Bandwidth to Back-End Servers + RpcAttemptedLbsDecisions, // Attempted RPC Load Balancing Decisions per Second + RpcFailedLbsDecisions, // Failed RPC Load Balancing Decisions per Second + RpcAttemptedLbsMessages, //Attempted RPC Load Balancing Broker Requests per Second + RpcFailedLbsMessages, // Failed RPC Load Balancing Broker Requests per Second + RpcLastCounter +} RpcPerfCounters; + +typedef void +(RPC_ENTRY *I_RpcProxyUpdatePerfCounterFn) + ( + _In_ RpcPerfCounters Counter, + _In_ int ModifyTrend, + _In_ unsigned long Size + ); + + typedef void +(RPC_ENTRY *I_RpcProxyUpdatePerfCounterBackendServerFn) + ( + _In_ unsigned short* MachineName, + _In_ int IsConnectEvent + ); + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPC_PROXY_CONNECTION_TYPE_IN_PROXY 0 +#define RPC_PROXY_CONNECTION_TYPE_OUT_PROXY 1 + +#if (NTDDI_VERSION >= NTDDI_WS03) +typedef struct tagI_RpcProxyCallbackInterface +{ + I_RpcProxyIsValidMachineFn IsValidMachineFn; + I_RpcProxyGetClientAddressFn GetClientAddressFn; + I_RpcProxyGetConnectionTimeoutFn GetConnectionTimeoutFn; + I_RpcPerformCalloutFn PerformCalloutFn; + I_RpcFreeCalloutStateFn FreeCalloutStateFn; + I_RpcProxyGetClientSessionAndResourceUUID GetClientSessionAndResourceUUIDFn; +#if (NTDDI_VERSION >= NTDDI_VISTA) + I_RpcProxyFilterIfFn ProxyFilterIfFn; + I_RpcProxyUpdatePerfCounterFn RpcProxyUpdatePerfCounterFn; + I_RpcProxyUpdatePerfCounterBackendServerFn RpcProxyUpdatePerfCounterBackendServerFn; +#endif // (NTDDI_VERSION >= NTDDI_VISTA) +} I_RpcProxyCallbackInterface; + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcProxyNewConnection ( + IN unsigned long ConnectionType, + IN unsigned short *ServerAddress, + IN unsigned short *ServerPort, + IN unsigned short *MinConnTimeout, + IN void *ConnectionParameter, + IN OPTIONAL RDR_CALLOUT_STATE *CallOutState, + IN I_RpcProxyCallbackInterface *ProxyCallbackInterface + ); + +#else + +typedef struct tagI_RpcProxyCallbackInterface +{ + I_RpcProxyIsValidMachineFn IsValidMachineFn; + I_RpcProxyGetClientAddressFn GetClientAddressFn; + I_RpcProxyGetConnectionTimeoutFn GetConnectionTimeoutFn; +} I_RpcProxyCallbackInterface; + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcProxyNewConnection ( + IN unsigned long ConnectionType, + IN unsigned short *ServerAddress, + IN unsigned short *ServerPort, + IN void *ConnectionParameter, + IN I_RpcProxyCallbackInterface *ProxyCallbackInterface + ); +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#endif // (NTDDI_VERSION >= NTDDI_WINXP) + +#if (NTDDI_VERSION >= NTDDI_WS03) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcReplyToClientWithStatus ( + IN void *ConnectionParameter, + IN RPC_STATUS RpcStatus + ); + +RPCRTAPI +void +RPC_ENTRY +I_RpcRecordCalloutFailure ( + IN RPC_STATUS RpcStatus, + IN RDR_CALLOUT_STATE *CallOutState, + IN unsigned short *DllName + ); +#endif // (NTDDI_VERSION >= NTDDI_WS03) + +#if (NTDDI_VERSION >= NTDDI_WIN7) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcMgmtEnableDedicatedThreadPool ( + void + ); +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_WIN7) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcGetDefaultSD( + _Out_ void __RPC_FAR ** ppSecurityDescriptor + ); +#endif // (NTDDI_VERSION >= NTDDI_WIN7) + +#if (NTDDI_VERSION >= NTDDI_VISTA) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcOpenClientProcess( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ unsigned long DesiredAccess, + _Outptr_ void** ClientProcess + ); +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_WIN8) +RPCRTAPI +RPC_STATUS +RPC_ENTRY +I_RpcBindingIsServerLocal( + _In_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned int * ServerLocalFlag + ); + +RPC_STATUS RPC_ENTRY +I_RpcBindingSetPrivateOption ( + _In_ RPC_BINDING_HANDLE hBinding, + _In_ unsigned long option, + _In_ ULONG_PTR optionValue + ); + +#define RPC_C_OPT_PRIVATE_SUPPRESS_WAKE 1 +#define RPC_C_OPT_PRIVATE_DO_NOT_DISTURB 2 +#define RPC_C_OPT_PRIVATE_BREAK_ON_SUSPEND 3 + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) +RPC_STATUS +RPC_ENTRY +I_RpcServerSubscribeForDisconnectNotification ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_opt_ void *hEvent + ); + +RPC_STATUS +RPC_ENTRY +I_RpcServerGetAssociationID ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _Out_ unsigned long *AssociationID + ); + +RPCRTAPI +long +RPC_ENTRY +I_RpcServerDisableExceptionFilter ( + void + ); + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS5) +RPC_STATUS +RPC_ENTRY +I_RpcServerSubscribeForDisconnectNotification2 ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ void *hEvent, + _Out_ UUID *SubscriptionId + ); + +RPC_STATUS +RPC_ENTRY +I_RpcServerUnsubscribeForDisconnectNotification ( + _In_opt_ RPC_BINDING_HANDLE Binding, + _In_ UUID SubscriptionId + ); + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS5) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#ifdef __cplusplus +} +#endif + +#if defined(__cplusplus) +#define I_RRPCUNINITIALIZENDROLE_EXPORT_NAME reinterpret_cast(static_cast(1000)) +#else +#define I_RRPCUNINITIALIZENDROLE_EXPORT_NAME ((LPCSTR)(ULONG_PTR)1000) +#endif + +#endif /* __RPCDCEP_H__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcndr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcndr.h new file mode 100644 index 0000000000000000000000000000000000000000..7fa7fd00c34cf577686e81036ce04843f3f92c61 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcndr.h @@ -0,0 +1,3353 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpcndr.h + +Abstract: + + Definitions for stub data structures and prototypes of helper functions. + +--*/ + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4001) /* nonstandard extension : single line comment */ +#pragma warning(disable:4255) // () treated as (void) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#pragma warning(disable:4820) // padding added after data member +#endif + +// This version of the rpcndr.h file corresponds to MIDL version 5.0.+ +// used with Windows 2000/XP build 1700+ + + +#ifndef __RPCNDR_H_VERSION__ +#define __RPCNDR_H_VERSION__ ( 501 ) +#endif // __RPCNDR_H_VERSION__ + + +#ifndef __RPCNDR_H__ +#define __RPCNDR_H__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __REQUIRED_RPCNDR_H_VERSION__ + #if ( __RPCNDR_H_VERSION__ < __REQUIRED_RPCNDR_H_VERSION__ ) + #error incorrect version. Use the header that matches with the MIDL compiler. + #endif +#endif + +#include + +#include +#include +#if !defined(_KRPCENV_) +#include +#endif + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +/**************************************************************************** + + Network Computing Architecture (NCA) definition: + + Network Data Representation: (NDR) Label format: + An unsigned long (32 bits) with the following layout: + + 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 + 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 + +---------------+---------------+---------------+-------+-------+ + | Reserved | Reserved |Floating point | Int | Char | + | | |Representation | Rep. | Rep. | + +---------------+---------------+---------------+-------+-------+ + + Where + + Reserved: + + Must be zero (0) for NCA 1.5 and NCA 2.0. + + Floating point Representation is: + + 0 - IEEE + 1 - VAX + 2 - Cray + 3 - IBM + + Int Rep. is Integer Representation: + + 0 - Big Endian + 1 - Little Endian + + Char Rep. is Character Representation: + + 0 - ASCII + 1 - EBCDIC + + The Microsoft Local Data Representation (for all platforms which are + of interest currently is edefined below: + + ****************************************************************************/ + +#define NDR_CHAR_REP_MASK (unsigned long)0X0000000FL +#define NDR_INT_REP_MASK (unsigned long)0X000000F0L +#define NDR_FLOAT_REP_MASK (unsigned long)0X0000FF00L + +#define NDR_LITTLE_ENDIAN (unsigned long)0X00000010L +#define NDR_BIG_ENDIAN (unsigned long)0X00000000L + +#define NDR_IEEE_FLOAT (unsigned long)0X00000000L +#define NDR_VAX_FLOAT (unsigned long)0X00000100L +#define NDR_IBM_FLOAT (unsigned long)0X00000300L + +#define NDR_ASCII_CHAR (unsigned long)0X00000000L +#define NDR_EBCDIC_CHAR (unsigned long)0X00000001L + +#if defined(__RPC_MAC__) +#define NDR_LOCAL_DATA_REPRESENTATION (unsigned long)0X00000000L +#define NDR_LOCAL_ENDIAN NDR_BIG_ENDIAN +#else +#define NDR_LOCAL_DATA_REPRESENTATION (unsigned long)0X00000010L +#define NDR_LOCAL_ENDIAN NDR_LITTLE_ENDIAN +#endif + + +/**************************************************************************** + * Macros for targeted platforms + ****************************************************************************/ + +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) +#define TARGET_IS_NT1012_OR_LATER 1 +#else +#define TARGET_IS_NT1012_OR_LATER 0 +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS1) +#define TARGET_IS_NT102_OR_LATER 1 +#else +#define TARGET_IS_NT102_OR_LATER 0 +#endif + +#if (0x0A00 <= _WIN32_WINNT) +#define TARGET_IS_NT100_OR_LATER 1 +#else +#define TARGET_IS_NT100_OR_LATER 0 +#endif + +#if (0x603 <= _WIN32_WINNT) +#define TARGET_IS_NT63_OR_LATER 1 +#else +#define TARGET_IS_NT63_OR_LATER 0 +#endif + +#if (0x602 <= _WIN32_WINNT) +#define TARGET_IS_NT62_OR_LATER 1 +#else +#define TARGET_IS_NT62_OR_LATER 0 +#endif + +#if (0x601 <= _WIN32_WINNT) +#define TARGET_IS_NT61_OR_LATER 1 +#else +#define TARGET_IS_NT61_OR_LATER 0 +#endif + +#if (0x600 <= _WIN32_WINNT) +#define TARGET_IS_NT60_OR_LATER 1 +#else +#define TARGET_IS_NT60_OR_LATER 0 +#endif + +#if (0x501 <= _WIN32_WINNT) +#define TARGET_IS_NT51_OR_LATER 1 +#else +#define TARGET_IS_NT51_OR_LATER 0 +#endif + +#if (0x500 <= _WIN32_WINNT) +#define TARGET_IS_NT50_OR_LATER 1 +#else +#define TARGET_IS_NT50_OR_LATER 0 +#endif + +#if (defined(_WIN32_DCOM) || 0x400 <= _WIN32_WINNT) +#define TARGET_IS_NT40_OR_LATER 1 +#else +#define TARGET_IS_NT40_OR_LATER 0 +#endif + +#if (0x400 <= WINVER) +#define TARGET_IS_NT351_OR_WIN95_OR_LATER 1 +#else +#define TARGET_IS_NT351_OR_WIN95_OR_LATER 0 +#endif + +/**************************************************************************** + * Other MIDL base types / predefined types: + ****************************************************************************/ + +#define small char +typedef unsigned char byte; +typedef byte cs_byte; +typedef unsigned char boolean; + +#ifndef _HYPER_DEFINED +#define _HYPER_DEFINED + +#if (!defined(_M_IX86) || (defined(_INTEGRAL_MAX_BITS) && _INTEGRAL_MAX_BITS >= 64)) +#define hyper __int64 +#define MIDL_uhyper unsigned __int64 +#else +typedef double hyper; +typedef double MIDL_uhyper; +#endif + +#endif // _HYPER_DEFINED + +#ifndef _WCHAR_T_DEFINED +typedef unsigned short wchar_t; +#define _WCHAR_T_DEFINED +#endif + +#ifndef _SIZE_T_DEFINED +#if defined(__RPC_WIN64__) || defined(__RPC_ARM64__) +typedef unsigned __int64 size_t; +#else +typedef unsigned int size_t; +#endif +#define _SIZE_T_DEFINED +#endif + +#ifdef __RPC_WIN32__ +#if (_MSC_VER >= 800) || defined(_STDCALL_SUPPORTED) +#define __RPC_CALLEE __stdcall +#else +#define __RPC_CALLEE +#endif +#endif + +#ifndef __MIDL_USER_DEFINED +#define midl_user_allocate MIDL_user_allocate +#define midl_user_free MIDL_user_free +#define __MIDL_USER_DEFINED +#endif + +_Must_inspect_result_ +_Ret_maybenull_ _Post_writable_byte_size_(size) +void * __RPC_USER MIDL_user_allocate( _In_ size_t size); +void __RPC_USER MIDL_user_free( _Pre_maybenull_ _Post_invalid_ void * ); + + +_Ret_maybenull_ _Post_writable_byte_size_(size) +void * __RPC_USER I_RpcDefaultAllocate( + handle_t bh, size_t size, void * (* RealAlloc)(size_t) ); + +void __RPC_USER I_RpcDefaultFree( + handle_t bh, void *, void (*RealFree)(void *) ); + + + +#define RPC_VAR_ENTRY __cdecl + + +/* winnt only */ +#if defined(_M_IX86) || defined(_M_AMD64) || defined(_M_IA64) +#define __MIDL_DECLSPEC_DLLIMPORT __declspec(dllimport) +#define __MIDL_DECLSPEC_DLLEXPORT __declspec(dllexport) +#else +#define __MIDL_DECLSPEC_DLLIMPORT +#define __MIDL_DECLSPEC_DLLEXPORT +#endif + + + + +/**************************************************************************** + * Context handle management related definitions: + * + * Client and Server Contexts. + * + ****************************************************************************/ + +typedef void * NDR_CCONTEXT; + +typedef struct _NDR_SCONTEXT + { + void * pad[2]; + void * userContext; + } * NDR_SCONTEXT; + +#define NDRSContextValue(hContext) (&(hContext)->userContext) + +#define cbNDRContext 20 /* size of context on WIRE */ + +typedef void (__RPC_USER * NDR_RUNDOWN)(void * context); + +typedef void (__RPC_USER * NDR_NOTIFY_ROUTINE)(void); + +typedef void (__RPC_USER * NDR_NOTIFY2_ROUTINE)(boolean flag); + +typedef struct _SCONTEXT_QUEUE { + unsigned long NumberOfObjects; + NDR_SCONTEXT * ArrayOfObjects; + } SCONTEXT_QUEUE, * PSCONTEXT_QUEUE; + +RPCRTAPI +RPC_BINDING_HANDLE +RPC_ENTRY +NDRCContextBinding ( + _In_ NDR_CCONTEXT CContext + ); + +RPCRTAPI +void +RPC_ENTRY +NDRCContextMarshall ( + _In_opt_ NDR_CCONTEXT CContext, + _Out_ void *pBuff + ); + +RPCRTAPI +void +RPC_ENTRY +NDRCContextUnmarshall ( + _Inout_opt_ NDR_CCONTEXT * pCContext, + _In_ RPC_BINDING_HANDLE hBinding, + _In_ void * pBuff, + _In_ unsigned long DataRepresentation + ); + +RPCRTAPI +void +RPC_ENTRY +NDRCContextUnmarshall2 ( + _Inout_opt_ NDR_CCONTEXT * pCContext, + _In_ RPC_BINDING_HANDLE hBinding, + _In_ void * pBuff, + _In_ unsigned long DataRepresentation + ); + +RPCRTAPI +void +RPC_ENTRY +NDRSContextMarshall ( + _In_ NDR_SCONTEXT CContext, + _Out_ void * pBuff, + _In_ NDR_RUNDOWN userRunDownIn + ); + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NDRSContextUnmarshall ( + _In_ void * pBuff, + _In_ unsigned long DataRepresentation + ); + +RPCRTAPI +void +RPC_ENTRY +NDRSContextMarshallEx ( + _In_ RPC_BINDING_HANDLE BindingHandle, + _In_ NDR_SCONTEXT CContext, + _Out_ void * pBuff, + _In_ NDR_RUNDOWN userRunDownIn + ); + +RPCRTAPI +void +RPC_ENTRY +NDRSContextMarshall2 ( + _In_ RPC_BINDING_HANDLE BindingHandle, + _In_ NDR_SCONTEXT CContext, + _Out_ void * pBuff, + _In_ NDR_RUNDOWN userRunDownIn, + _In_opt_ void * CtxGuard, + _In_ unsigned long Flags + ); + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NDRSContextUnmarshallEx ( + _In_ RPC_BINDING_HANDLE BindingHandle, + _In_ void * pBuff, + _In_ unsigned long DataRepresentation + ); + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NDRSContextUnmarshall2( + _In_ RPC_BINDING_HANDLE BindingHandle, + _In_opt_ void * pBuff, + _In_ unsigned long DataRepresentation, + _In_opt_ void * CtxGuard, + _In_ unsigned long Flags + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsDestroyClientContext ( + _In_ void * * ContextHandle + ); + + +/**************************************************************************** + NDR conversion related definitions. + ****************************************************************************/ + +#define byte_from_ndr(source, target) \ + { \ + *(target) = *(*(char * *)&(source)->Buffer)++; \ + } + +#define byte_array_from_ndr(Source, LowerIndex, UpperIndex, Target) \ + { \ + NDRcopy ( \ + (((char *)(Target))+(LowerIndex)), \ + (Source)->Buffer, \ + (unsigned int)((UpperIndex)-(LowerIndex))); \ + *(unsigned long *)&(Source)->Buffer += ((UpperIndex)-(LowerIndex)); \ + } + +#define boolean_from_ndr(source, target) \ + { \ + *(target) = *(*(char * *)&(source)->Buffer)++; \ + } + +#define boolean_array_from_ndr(Source, LowerIndex, UpperIndex, Target) \ + { \ + NDRcopy ( \ + (((char *)(Target))+(LowerIndex)), \ + (Source)->Buffer, \ + (unsigned int)((UpperIndex)-(LowerIndex))); \ + *(unsigned long *)&(Source)->Buffer += ((UpperIndex)-(LowerIndex)); \ + } + +#define small_from_ndr(source, target) \ + { \ + *(target) = *(*(char * *)&(source)->Buffer)++; \ + } + +#define small_from_ndr_temp(source, target, format) \ + { \ + *(target) = *(*(char * *)(source))++; \ + } + +#define small_array_from_ndr(Source, LowerIndex, UpperIndex, Target) \ + { \ + NDRcopy ( \ + (((char *)(Target))+(LowerIndex)), \ + (Source)->Buffer, \ + (unsigned int)((UpperIndex)-(LowerIndex))); \ + *(unsigned long *)&(Source)->Buffer += ((UpperIndex)-(LowerIndex)); \ + } + +/**************************************************************************** + Platform specific mapping of c-runtime functions. + ****************************************************************************/ + +#if defined(__RPC_WIN32__) || defined(__RPC_WIN64__) || defined(__RPC_ARM32__) || defined(__RPC_ARM64__) +#define MIDL_ascii_strlen(string) \ + strlen(string) +#define MIDL_ascii_strcpy(target,source) \ + strcpy(target,source) +#define MIDL_memset(s,c,n) \ + memset(s,c,n) +#endif + +/**************************************************************************** + MIDL 2.0 ndr definitions. + ****************************************************************************/ + +typedef unsigned long error_status_t; + +#define _midl_ma1( p, cast ) *(*( cast **)&p)++ +#define _midl_ma2( p, cast ) *(*( cast **)&p)++ +#define _midl_ma4( p, cast ) *(*( cast **)&p)++ +#define _midl_ma8( p, cast ) *(*( cast **)&p)++ + +#define _midl_unma1( p, cast ) *(( cast *)p)++ +#define _midl_unma2( p, cast ) *(( cast *)p)++ +#define _midl_unma3( p, cast ) *(( cast *)p)++ +#define _midl_unma4( p, cast ) *(( cast *)p)++ + +// Some alignment specific macros. + +// RKK64 +// these appear to be used in fossils inside MIDL +#define _midl_fa2( p ) (p = (RPC_BUFPTR )((ULONG_PTR)(p+1) & ~0x1)) +#define _midl_fa4( p ) (p = (RPC_BUFPTR )((ULONG_PTR)(p+3) & ~0x3)) +#define _midl_fa8( p ) (p = (RPC_BUFPTR )((ULONG_PTR)(p+7) & ~0x7)) + +#define _midl_addp( p, n ) (p += n) + +// Marshalling macros + +#define _midl_marsh_lhs( p, cast ) *(*( cast **)&p)++ +#define _midl_marsh_up( mp, p ) *(*(unsigned long **)&mp)++ = (unsigned long)p +#define _midl_advmp( mp ) *(*(unsigned long **)&mp)++ +#define _midl_unmarsh_up( p ) (*(*(unsigned long **)&p)++) + + +//////////////////////////////////////////////////////////////////////////// +// Ndr macros. +//////////////////////////////////////////////////////////////////////////// + +// RKK64 +// these appear to be used in fossils inside MIDL +#define NdrMarshConfStringHdr( p, s, l ) (_midl_ma4( p, unsigned long) = s, \ + _midl_ma4( p, unsigned long) = 0, \ + _midl_ma4( p, unsigned long) = l) + +#define NdrUnMarshConfStringHdr(p, s, l) ((s=_midl_unma4(p,unsigned long),\ + (_midl_addp(p,4)), \ + (l=_midl_unma4(p,unsigned long)) + +#define NdrMarshCCtxtHdl(pc,p) (NDRCContextMarshall( (NDR_CCONTEXT)pc, p ),p+20) + +#define NdrUnMarshCCtxtHdl(pc,p,h,drep) \ + (NDRCContextUnmarshall((NDR_CONTEXT)pc,h,p,drep), p+20) + +#define NdrUnMarshSCtxtHdl(pc, p,drep) (pc = NdrSContextUnMarshall(p,drep )) + + +#define NdrMarshSCtxtHdl(pc,p,rd) (NdrSContextMarshall((NDR_SCONTEXT)pc,p, (NDR_RUNDOWN)rd) + + +// end of unused + +#define NdrFieldOffset(s,f) (LONG_PTR)(& (((s *)0)->f)) +#define NdrFieldPad(s,f,p,t) ((unsigned long)(NdrFieldOffset(s,f) - NdrFieldOffset(s,p)) - sizeof(t)) + +#define NdrFcShort(s) (unsigned char)(s & 0xff), (unsigned char)(s >> 8) +#define NdrFcLong(s) (unsigned char)(s & 0xff), (unsigned char)((s & 0x0000ff00) >> 8), \ + (unsigned char)((s & 0x00ff0000) >> 16), (unsigned char)(s >> 24) + +// +// On the server side, the following exceptions are mapped to +// the bad stub data exception if -error stub_data is used. +// + +#define RPC_BAD_STUB_DATA_EXCEPTION_FILTER \ + ( (RpcExceptionCode() == STATUS_ACCESS_VIOLATION) || \ + (RpcExceptionCode() == STATUS_DATATYPE_MISALIGNMENT) || \ + (RpcExceptionCode() == RPC_X_BAD_STUB_DATA) || \ + (RpcExceptionCode() == RPC_S_INVALID_BOUND) ) + +///////////////////////////////////////////////////////////////////////////// +// Some stub helper functions. +///////////////////////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////////////////////// +// Stub helper structures. +//////////////////////////////////////////////////////////////////////////// + +struct _MIDL_STUB_MESSAGE; +struct _MIDL_STUB_DESC; +struct _FULL_PTR_XLAT_TABLES; + +typedef unsigned char * RPC_BUFPTR; +typedef unsigned long RPC_LENGTH; + +// Expression evaluation callback routine prototype. +typedef void (__RPC_USER * EXPR_EVAL)( struct _MIDL_STUB_MESSAGE * ); + +typedef const unsigned char * PFORMAT_STRING; + +/* + * Multidimensional conformant/varying array struct. + */ +typedef struct + { + long Dimension; + + /* These fields MUST be (unsigned long *) */ + unsigned long * BufferConformanceMark; + unsigned long * BufferVarianceMark; + + /* Count arrays, used for top level arrays in -Os stubs */ + unsigned long * MaxCountArray; + unsigned long * OffsetArray; + unsigned long * ActualCountArray; + } ARRAY_INFO, *PARRAY_INFO; + + +typedef struct _NDR_ASYNC_MESSAGE * PNDR_ASYNC_MESSAGE; +typedef struct _NDR_CORRELATION_INFO *PNDR_CORRELATION_INFO; + +/* + * MIDL Stub Message + */ + +typedef const unsigned char * PFORMAT_STRING; +typedef struct _MIDL_SYNTAX_INFO MIDL_SYNTAX_INFO, *PMIDL_SYNTAX_INFO; + +struct NDR_ALLOC_ALL_NODES_CONTEXT; +struct NDR_POINTER_QUEUE_STATE; +struct _NDR_PROC_CONTEXT; + +typedef struct _MIDL_STUB_MESSAGE + { + /* RPC message structure. */ + PRPC_MESSAGE RpcMsg; + + /* Pointer into RPC message buffer. */ + unsigned char * Buffer; + + /* + * These are used internally by the Ndr routines to mark the beginning + * and end of an incoming RPC buffer. + */ + unsigned char * BufferStart; + unsigned char * BufferEnd; + + /* + * Used internally by the Ndr routines as a place holder in the buffer. + * On the marshalling side it's used to mark the location where conformance + * size should be marshalled. + * On the unmarshalling side it's used to mark the location in the buffer + * used during pointer unmarshalling to base pointer offsets off of. + */ + unsigned char * BufferMark; + + /* Set by the buffer sizing routines. */ + unsigned long BufferLength; + + /* Set by the memory sizing routines. */ + unsigned long MemorySize; + + /* Pointer to user memory. */ + unsigned char * Memory; + + /* Is the Ndr routine begin called from a client side stub. */ + unsigned char IsClient; + unsigned char Pad; + unsigned short uFlags2; + + /* Can the buffer be re-used for memory on unmarshalling. */ + int ReuseBuffer; + + /* Hold the context for allocate all nodes */ + struct NDR_ALLOC_ALL_NODES_CONTEXT *pAllocAllNodesContext; + struct NDR_POINTER_QUEUE_STATE *pPointerQueueState; + + /* + * Stuff needed while handling complex structures + */ + + /* Ignore imbeded pointers while computing buffer or memory sizes. */ + int IgnoreEmbeddedPointers; + + /* + * This marks the location in the buffer where pointees of a complex + * struct reside. + */ + unsigned char * PointerBufferMark; + + /* + * Used to catch errors in SendReceive. + */ + unsigned char CorrDespIncrement; + + unsigned char uFlags; + unsigned short UniquePtrCount; + + /* + * Used internally by the Ndr routines. Holds the max counts for + * a conformant array. + */ + ULONG_PTR MaxCount; + + /* + * Used internally by the Ndr routines. Holds the offsets for a varying + * array. + */ + unsigned long Offset; + + /* + * Used internally by the Ndr routines. Holds the actual counts for + * a varying array. + */ + unsigned long ActualCount; + + /* Allocation and Free routine to be used by the Ndr routines. */ + void * ( __RPC_API * pfnAllocate)( size_t ); + void ( __RPC_API * pfnFree)(void *); + + /* + * Top of parameter stack. Used for "single call" stubs during marshalling + * to hold the beginning of the parameter list on the stack. Needed to + * extract parameters which hold attribute values for top level arrays and + * pointers. + */ + unsigned char * StackTop; + + /* + * Fields used for the transmit_as and represent_as objects. + * For represent_as the mapping is: presented=local, transmit=named. + */ + unsigned char * pPresentedType; + unsigned char * pTransmitType; + + /* + * When we first construct a binding on the client side, stick it + * in the rpcmessage and later call RpcGetBuffer, the handle field + * in the rpcmessage is changed. That's fine except that we need to + * have that original handle for use in unmarshalling context handles + * (the second argument in NDRCContextUnmarshall to be exact). So + * stash the contructed handle here and extract it when needed. + */ + handle_t SavedHandle; + + /* + * Pointer back to the stub descriptor. Use this to get all handle info. + */ + const struct _MIDL_STUB_DESC * StubDesc; + + /* + * Full pointer stuff. + */ + struct _FULL_PTR_XLAT_TABLES * FullPtrXlatTables; + unsigned long FullPtrRefId; + + unsigned long PointerLength; + + int fInDontFree :1; + int fDontCallFreeInst :1; + int fUnused1 :1; + int fHasReturn :1; + int fHasExtensions :1; + int fHasNewCorrDesc :1; + int fIsIn :1; + int fIsOut :1; + int fIsOicf :1; + int fBufferValid :1; + int fHasMemoryValidateCallback: 1; + int fInFree :1; + int fNeedMCCP :1; + int fUnused2 :3; + int fUnused3 :16; + + + unsigned long dwDestContext; + void * pvDestContext; + + NDR_SCONTEXT * SavedContextHandles; + + long ParamNumber; + + struct IRpcChannelBuffer * pRpcChannelBuffer; + + PARRAY_INFO pArrayInfo; + unsigned long * SizePtrCountArray; + unsigned long * SizePtrOffsetArray; + unsigned long * SizePtrLengthArray; + + /* + * Interpreter argument queue. Used on server side only. + */ + void * pArgQueue; + + unsigned long dwStubPhase; + + void * LowStackMark; + + /* + * Async message pointer, correlation data - NT 5.0 features. + */ + PNDR_ASYNC_MESSAGE pAsyncMsg; + PNDR_CORRELATION_INFO pCorrInfo; + unsigned char * pCorrMemory; + + void * pMemoryList; + + /* + * Reserved fields up to this point present since the 3.50 release. + * Reserved fields below were introduced for Windows 2000 release. + * (but not used). + */ + + /* + * International character support information - NT 5.1 feature. + */ + INT_PTR pCSInfo; + + unsigned char * ConformanceMark; + unsigned char * VarianceMark; + + INT_PTR Unused; + + struct _NDR_PROC_CONTEXT * pContext; + + /* + * Reserved fields up to this point present since Windows 2000 release. + * Fields added for NT5.1 + * + * pUserMarshalList is used to keep a linked list of nodes pointing to + * marshalled data to be freed. This list can contain (as the name + * implies) User Marshalled data, but also can contain Interface Pointer + * data. + */ + + void * ContextHandleHash; + void * pUserMarshalList; + unsigned char * pFullPtrFormat; + INT_PTR Reserved51_4; + INT_PTR Reserved51_5; + + + /* + * Reserved fields up to this point present since NT5.1 release. + */ + } MIDL_STUB_MESSAGE, *PMIDL_STUB_MESSAGE; + + +typedef struct _MIDL_STUB_MESSAGE MIDL_STUB_MESSAGE, *PMIDL_STUB_MESSAGE; + +/* + * Generic handle bind/unbind routine pair. + */ +typedef void * + ( __RPC_API * GENERIC_BINDING_ROUTINE) + (void *); +typedef void + ( __RPC_API * GENERIC_UNBIND_ROUTINE) + (void *, unsigned char *); + +typedef struct _GENERIC_BINDING_ROUTINE_PAIR + { + GENERIC_BINDING_ROUTINE pfnBind; + GENERIC_UNBIND_ROUTINE pfnUnbind; + } GENERIC_BINDING_ROUTINE_PAIR, *PGENERIC_BINDING_ROUTINE_PAIR; + +typedef struct __GENERIC_BINDING_INFO + { + void * pObj; + unsigned int Size; + GENERIC_BINDING_ROUTINE pfnBind; + GENERIC_UNBIND_ROUTINE pfnUnbind; + } GENERIC_BINDING_INFO, *PGENERIC_BINDING_INFO; + +// typedef EXPR_EVAL - see above +// typedefs for xmit_as + +#ifdef __cplusplus +#define NDR_SHAREABLE inline +#elif (defined(_MSC_VER)) && !defined(MIDL_PASS) +// a Microsoft C++ compiler +#define NDR_SHAREABLE __inline +#else +#define NDR_SHAREABLE static +#endif + +typedef void ( __RPC_USER * XMIT_HELPER_ROUTINE) + ( PMIDL_STUB_MESSAGE ); + +typedef struct _XMIT_ROUTINE_QUINTUPLE + { + XMIT_HELPER_ROUTINE pfnTranslateToXmit; + XMIT_HELPER_ROUTINE pfnTranslateFromXmit; + XMIT_HELPER_ROUTINE pfnFreeXmit; + XMIT_HELPER_ROUTINE pfnFreeInst; + } XMIT_ROUTINE_QUINTUPLE, *PXMIT_ROUTINE_QUINTUPLE; + +typedef unsigned long +( __RPC_USER * USER_MARSHAL_SIZING_ROUTINE) + (unsigned long *, + unsigned long, + void * ); + +typedef unsigned char * +( __RPC_USER * USER_MARSHAL_MARSHALLING_ROUTINE) + (unsigned long *, + unsigned char * , + void * ); + +typedef unsigned char * +( __RPC_USER * USER_MARSHAL_UNMARSHALLING_ROUTINE) + (unsigned long *, + unsigned char *, + void * ); + +typedef void ( __RPC_USER * USER_MARSHAL_FREEING_ROUTINE) + (unsigned long *, + void * ); + +typedef struct _USER_MARSHAL_ROUTINE_QUADRUPLE + { + USER_MARSHAL_SIZING_ROUTINE pfnBufferSize; + USER_MARSHAL_MARSHALLING_ROUTINE pfnMarshall; + USER_MARSHAL_UNMARSHALLING_ROUTINE pfnUnmarshall; + USER_MARSHAL_FREEING_ROUTINE pfnFree; + } USER_MARSHAL_ROUTINE_QUADRUPLE; + +#define USER_MARSHAL_CB_SIGNATURE 'USRC' + +typedef enum _USER_MARSHAL_CB_TYPE +{ + USER_MARSHAL_CB_BUFFER_SIZE, + USER_MARSHAL_CB_MARSHALL, + USER_MARSHAL_CB_UNMARSHALL, + USER_MARSHAL_CB_FREE +} USER_MARSHAL_CB_TYPE; + +typedef struct _USER_MARSHAL_CB +{ + unsigned long Flags; + PMIDL_STUB_MESSAGE pStubMsg; + PFORMAT_STRING pReserve; + unsigned long Signature; + USER_MARSHAL_CB_TYPE CBType; + PFORMAT_STRING pFormat; + PFORMAT_STRING pTypeFormat; +} USER_MARSHAL_CB; + + +#define USER_CALL_CTXT_MASK(f) ((f) & 0x00ff) +#define USER_CALL_AUX_MASK(f) ((f) & 0xff00) +#define GET_USER_DATA_REP(f) ((f) >> 16) + +#define USER_CALL_IS_ASYNC 0x0100 /* aux flag: in an [async] call */ +#define USER_CALL_NEW_CORRELATION_DESC 0x0200 + +typedef struct _MALLOC_FREE_STRUCT + { + void * ( __RPC_USER * pfnAllocate)(size_t); + void ( __RPC_USER * pfnFree)(void *); + } MALLOC_FREE_STRUCT; + +typedef struct _COMM_FAULT_OFFSETS + { + short CommOffset; + short FaultOffset; + } COMM_FAULT_OFFSETS; + +/* + * International character support definitions + */ + +typedef enum _IDL_CS_CONVERT + { + IDL_CS_NO_CONVERT, + IDL_CS_IN_PLACE_CONVERT, + IDL_CS_NEW_BUFFER_CONVERT + } IDL_CS_CONVERT; + +typedef void +( __RPC_USER * CS_TYPE_NET_SIZE_ROUTINE) + (RPC_BINDING_HANDLE hBinding, + unsigned long ulNetworkCodeSet, + unsigned long ulLocalBufferSize, + IDL_CS_CONVERT * conversionType, + unsigned long * pulNetworkBufferSize, + error_status_t * pStatus); + +typedef void +( __RPC_USER * CS_TYPE_LOCAL_SIZE_ROUTINE) + (RPC_BINDING_HANDLE hBinding, + unsigned long ulNetworkCodeSet, + unsigned long ulNetworkBufferSize, + IDL_CS_CONVERT * conversionType, + unsigned long * pulLocalBufferSize, + error_status_t * pStatus); + +typedef void +( __RPC_USER * CS_TYPE_TO_NETCS_ROUTINE) + (RPC_BINDING_HANDLE hBinding, + unsigned long ulNetworkCodeSet, + void * pLocalData, + unsigned long ulLocalDataLength, + byte * pNetworkData, + unsigned long * pulNetworkDataLength, + error_status_t * pStatus); + +typedef void +( __RPC_USER * CS_TYPE_FROM_NETCS_ROUTINE) + (RPC_BINDING_HANDLE hBinding, + unsigned long ulNetworkCodeSet, + byte * pNetworkData, + unsigned long ulNetworkDataLength, + unsigned long ulLocalBufferSize, + void * pLocalData, + unsigned long * pulLocalDataLength, + error_status_t * pStatus); + +typedef void +( __RPC_USER * CS_TAG_GETTING_ROUTINE) + (RPC_BINDING_HANDLE hBinding, + int fServerSide, + unsigned long * pulSendingTag, + unsigned long * pulDesiredReceivingTag, + unsigned long * pulReceivingTag, + error_status_t * pStatus); + +void __RPC_USER +RpcCsGetTags( + RPC_BINDING_HANDLE hBinding, + int fServerSide, + unsigned long * pulSendingTag, + unsigned long * pulDesiredReceivingTag, + unsigned long * pulReceivingTag, + error_status_t * pStatus); + +typedef struct _NDR_CS_SIZE_CONVERT_ROUTINES + { + CS_TYPE_NET_SIZE_ROUTINE pfnNetSize; + CS_TYPE_TO_NETCS_ROUTINE pfnToNetCs; + CS_TYPE_LOCAL_SIZE_ROUTINE pfnLocalSize; + CS_TYPE_FROM_NETCS_ROUTINE pfnFromNetCs; + } NDR_CS_SIZE_CONVERT_ROUTINES; + +typedef struct _NDR_CS_ROUTINES + { + NDR_CS_SIZE_CONVERT_ROUTINES *pSizeConvertRoutines; + CS_TAG_GETTING_ROUTINE *pTagGettingRoutines; + } NDR_CS_ROUTINES; + +typedef struct _NDR_EXPR_DESC +{ + const unsigned short * pOffset; + PFORMAT_STRING pFormatExpr; +} NDR_EXPR_DESC; +/* + * MIDL Stub Descriptor + */ + +typedef struct _MIDL_STUB_DESC + { + void * RpcInterfaceInformation; + + void * ( __RPC_API * pfnAllocate)(size_t); + void ( __RPC_API * pfnFree)(void *); + + union + { + handle_t * pAutoHandle; + handle_t * pPrimitiveHandle; + PGENERIC_BINDING_INFO pGenericBindingInfo; + } IMPLICIT_HANDLE_INFO; + + const NDR_RUNDOWN * apfnNdrRundownRoutines; + const GENERIC_BINDING_ROUTINE_PAIR * aGenericBindingRoutinePairs; + const EXPR_EVAL * apfnExprEval; + const XMIT_ROUTINE_QUINTUPLE * aXmitQuintuple; + + const unsigned char * pFormatTypes; + + int fCheckBounds; + + /* Ndr library version. */ + unsigned long Version; + + MALLOC_FREE_STRUCT * pMallocFreeStruct; + + long MIDLVersion; + + const COMM_FAULT_OFFSETS * CommFaultOffsets; + + // New fields for version 3.0+ + const USER_MARSHAL_ROUTINE_QUADRUPLE * aUserMarshalQuadruple; + + // Notify routines - added for NT5, MIDL 5.0 + const NDR_NOTIFY_ROUTINE * NotifyRoutineTable; + + /* + * Reserved for future use. + */ + + ULONG_PTR mFlags; + + // International support routines - added for 64bit post NT5 + const NDR_CS_ROUTINES * CsRoutineTables; + + void * ProxyServerInfo; + const NDR_EXPR_DESC * pExprInfo; + + // Fields up to now present in win2000 release. + + } MIDL_STUB_DESC; + + +typedef const MIDL_STUB_DESC * PMIDL_STUB_DESC; + +typedef void * PMIDL_XMIT_TYPE; + +/* + * MIDL Stub Format String. This is a const in the stub. + */ +#if defined(_MSC_EXTENSIONS) +#if !defined( RC_INVOKED ) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning( disable:4200 ) +#endif +typedef struct _MIDL_FORMAT_STRING + { + short Pad; + unsigned char Format[]; + } MIDL_FORMAT_STRING; +#if !defined( RC_INVOKED ) +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning( default:4200 ) +#endif +#endif +#endif /* _MSC_EXTENSIONS */ + +/* + * Stub thunk used for some interpreted server stubs. + */ +typedef void ( __RPC_API * STUB_THUNK)( PMIDL_STUB_MESSAGE ); + +#ifndef _MANAGED +typedef long ( __RPC_API * SERVER_ROUTINE)(); +#else +typedef long ( __RPC_API * SERVER_ROUTINE)(void); +#endif + +/* + * Method property structures + */ +typedef struct _MIDL_METHOD_PROPERTY +{ + unsigned long Id; + ULONG_PTR Value; +} MIDL_METHOD_PROPERTY, *PMIDL_METHOD_PROPERTY; + +typedef struct _MIDL_METHOD_PROPERTY_MAP +{ + unsigned long Count; + const MIDL_METHOD_PROPERTY *Properties; +} MIDL_METHOD_PROPERTY_MAP, *PMIDL_METHOD_PROPERTY_MAP; + +typedef struct _MIDL_INTERFACE_METHOD_PROPERTIES +{ + unsigned short MethodCount; + const MIDL_METHOD_PROPERTY_MAP* const *MethodProperties; +} MIDL_INTERFACE_METHOD_PROPERTIES; + +/* + * Server Interpreter's information strucuture. + */ +typedef struct _MIDL_SERVER_INFO_ + { + PMIDL_STUB_DESC pStubDesc; + const SERVER_ROUTINE * DispatchTable; + PFORMAT_STRING ProcString; + const unsigned short * FmtStringOffset; + const STUB_THUNK * ThunkTable; + PRPC_SYNTAX_IDENTIFIER pTransferSyntax; + ULONG_PTR nCount; + PMIDL_SYNTAX_INFO pSyntaxInfo; + } MIDL_SERVER_INFO, *PMIDL_SERVER_INFO; + +#undef _MIDL_STUBLESS_PROXY_INFO + +/* + * Stubless object proxy information structure. + */ +typedef struct _MIDL_STUBLESS_PROXY_INFO + { + PMIDL_STUB_DESC pStubDesc; + PFORMAT_STRING ProcFormatString; + const unsigned short * FormatStringOffset; + PRPC_SYNTAX_IDENTIFIER pTransferSyntax; + ULONG_PTR nCount; + PMIDL_SYNTAX_INFO pSyntaxInfo; + } MIDL_STUBLESS_PROXY_INFO; + +typedef MIDL_STUBLESS_PROXY_INFO * PMIDL_STUBLESS_PROXY_INFO; + +/* + * Multiple transfer syntax information. + */ +typedef struct _MIDL_SYNTAX_INFO +{ +RPC_SYNTAX_IDENTIFIER TransferSyntax; +RPC_DISPATCH_TABLE * DispatchTable; +PFORMAT_STRING ProcString; +const unsigned short * FmtStringOffset; +PFORMAT_STRING TypeString; +const void * aUserMarshalQuadruple; +const MIDL_INTERFACE_METHOD_PROPERTIES *pMethodProperties; +ULONG_PTR pReserved2; +} MIDL_SYNTAX_INFO, *PMIDL_SYNTAX_INFO; + +typedef unsigned short * PARAM_OFFSETTABLE, *PPARAM_OFFSETTABLE; + + +/* + * This is the return value from NdrClientCall. + */ +typedef union _CLIENT_CALL_RETURN + { + void * Pointer; + LONG_PTR Simple; + } CLIENT_CALL_RETURN; + +// BUGBUG: can we get rid of this defintion altogether, just leave void * here? +typedef enum + { + XLAT_SERVER = 1, + XLAT_CLIENT + } XLAT_SIDE; + +typedef struct _FULL_PTR_XLAT_TABLES +{ + void * RefIdToPointer; + void * PointerToRefId; + unsigned long NextRefId; + XLAT_SIDE XlatSide; +} FULL_PTR_XLAT_TABLES, *PFULL_PTR_XLAT_TABLES; + +/* + * Different types of System Handles + */ + +typedef enum _system_handle_t +{ + SYSTEM_HANDLE_FILE = 0, + SYSTEM_HANDLE_SEMAPHORE = 1, + SYSTEM_HANDLE_EVENT = 2, + SYSTEM_HANDLE_MUTEX = 3, + SYSTEM_HANDLE_PROCESS = 4, + SYSTEM_HANDLE_TOKEN = 5, + SYSTEM_HANDLE_SECTION = 6, + SYSTEM_HANDLE_REG_KEY = 7, + SYSTEM_HANDLE_THREAD = 8, + SYSTEM_HANDLE_COMPOSITION_OBJECT = 9, + SYSTEM_HANDLE_SOCKET = 10, + SYSTEM_HANDLE_JOB = 11, + SYSTEM_HANDLE_PIPE = 12, + SYSTEM_HANDLE_MAX = 12, + SYSTEM_HANDLE_INVALID = 0xFF, +} system_handle_t; + +/* + * Interception info. + */ + +enum { + MidlInterceptionInfoVersionOne = 1 +}; + +enum { + MidlWinrtTypeSerializationInfoVersionOne = 1 +}; + +#define MIDL_WINRT_TYPE_SERIALIZATION_INFO_CURRENT_VERSION MidlWinrtTypeSerializationInfoVersionOne + +typedef struct _MIDL_INTERCEPTION_INFO +{ + unsigned long Version; + PFORMAT_STRING ProcString; + const unsigned short *ProcFormatOffsetTable; + unsigned long ProcCount; + PFORMAT_STRING TypeString; +} MIDL_INTERCEPTION_INFO, *PMIDL_INTERCEPTION_INFO; + +typedef struct _MIDL_WINRT_TYPE_SERIALIZATION_INFO +{ + unsigned long Version; + PFORMAT_STRING TypeFormatString; + unsigned short FormatStringSize; + unsigned short TypeOffset; + PMIDL_STUB_DESC StubDesc; +} MIDL_WINRT_TYPE_SERIALIZATION_INFO, *PMIDL_WINRT_TYPE_SERIALIZATION_INFO; + +/*************************************************************************** + ** New MIDL 2.0 Ndr routine templates + ***************************************************************************/ + +RPC_STATUS RPC_ENTRY +NdrClientGetSupportedSyntaxes( + _In_ RPC_CLIENT_INTERFACE * pInf, + _Out_ unsigned long * pCount, + _Out_ MIDL_SYNTAX_INFO ** pArr ); + + +RPC_STATUS RPC_ENTRY +NdrServerGetSupportedSyntaxes( + _In_ RPC_SERVER_INTERFACE * pInf, + _Out_ unsigned long * pCount, + _Out_ MIDL_SYNTAX_INFO ** pArr, + _Out_ unsigned long * pPreferSyntaxIndex); + +/* + * Marshall routines + */ +#pragma warning(push) + // SAL can't adequately express buffer sizes from rpc format strings +#pragma warning(disable:28740) + +RPCRTAPI +void +RPC_ENTRY +NdrSimpleTypeMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + unsigned char FormatChar + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrPointerMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrCsArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrCsTagMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Structures */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrSimpleStructMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantStructMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantVaryingStructMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrComplexStructMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Arrays */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrFixedArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantVaryingArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrVaryingArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrComplexArrayMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Strings */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNonConformantStringMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantStringMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Unions */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrEncapsulatedUnionMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNonEncapsulatedUnionMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Byte count pointer */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrByteCountPointerMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Transmit as and represent as*/ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrXmitOrRepAsMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* User_marshal */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrUserMarshalMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Interface pointer */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrInterfacePointerMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Context handles */ + +RPCRTAPI +void +RPC_ENTRY +NdrClientContextMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + NDR_CCONTEXT ContextHandle, + int fCheck + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerContextMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + NDR_SCONTEXT ContextHandle, + NDR_RUNDOWN RundownRoutine + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerContextNewMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + NDR_SCONTEXT ContextHandle, + NDR_RUNDOWN RundownRoutine, + PFORMAT_STRING pFormat + ); + +/* + * Unmarshall routines + */ + +RPCRTAPI +void +RPC_ENTRY +NdrSimpleTypeUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + unsigned char FormatChar + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrCsArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char ** ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrCsTagUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char ** ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrRangeUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char ** ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCorrelationInitialize( + PMIDL_STUB_MESSAGE pStubMsg, + void * pMemory, + unsigned long CacheSize, + unsigned long flags + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCorrelationPass( + PMIDL_STUB_MESSAGE pStubMsg + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCorrelationFree( + PMIDL_STUB_MESSAGE pStubMsg + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrPointerUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Structures */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrSimpleStructUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantStructUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantVaryingStructUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrComplexStructUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Arrays */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrFixedArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantVaryingArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrVaryingArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrComplexArrayUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Strings */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNonConformantStringUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrConformantStringUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Unions */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrEncapsulatedUnionUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNonEncapsulatedUnionUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Byte count pointer */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrByteCountPointerUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Transmit as and represent as*/ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrXmitOrRepAsUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* User_marshal */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrUserMarshalUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Interface pointer */ + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrInterfacePointerUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * * ppMemory, + PFORMAT_STRING pFormat, + unsigned char fMustAlloc + ); + +/* Context handles */ + +RPCRTAPI +void +RPC_ENTRY +NdrClientContextUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + NDR_CCONTEXT * pContextHandle, + RPC_BINDING_HANDLE BindHandle + ); + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NdrServerContextUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg + ); + +/* New context handle flavors */ + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NdrContextHandleInitialize( + _In_ PMIDL_STUB_MESSAGE pStubMsg, + _In_reads_(_Inexpressible_(2)) PFORMAT_STRING pFormat + ); + +RPCRTAPI +NDR_SCONTEXT +RPC_ENTRY +NdrServerContextNewUnmarshall( + _In_ PMIDL_STUB_MESSAGE pStubMsg, + _In_reads_(_Inexpressible_(2)) PFORMAT_STRING pFormat + ); + +/* + * Buffer sizing routines + */ + +RPCRTAPI +void +RPC_ENTRY +NdrPointerBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCsArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCsTagBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Structures */ + +RPCRTAPI +void +RPC_ENTRY +NdrSimpleStructBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantStructBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantVaryingStructBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrComplexStructBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Arrays */ + +RPCRTAPI +void +RPC_ENTRY +NdrFixedArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantVaryingArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrVaryingArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrComplexArrayBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Strings */ + +RPCRTAPI +void +RPC_ENTRY +NdrConformantStringBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrNonConformantStringBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Unions */ + +RPCRTAPI +void +RPC_ENTRY +NdrEncapsulatedUnionBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrNonEncapsulatedUnionBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Byte count pointer */ + +RPCRTAPI +void +RPC_ENTRY +NdrByteCountPointerBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Transmit as and represent as*/ + +RPCRTAPI +void +RPC_ENTRY +NdrXmitOrRepAsBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* User_marshal */ + +RPCRTAPI +void +RPC_ENTRY +NdrUserMarshalBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Interface pointer */ + +RPCRTAPI +void +RPC_ENTRY +NdrInterfacePointerBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +// Context Handle size +// +RPCRTAPI +void +RPC_ENTRY +NdrContextHandleSize( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* + * Memory sizing routines + */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrPointerMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrContextHandleMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + + +/* cs_char things */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrCsArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrCsTagMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Structures */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrSimpleStructMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrConformantStructMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrConformantVaryingStructMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrComplexStructMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Arrays */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrFixedArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrConformantArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrConformantVaryingArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrVaryingArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrComplexArrayMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Strings */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrConformantStringMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrNonConformantStringMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Unions */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrEncapsulatedUnionMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrNonEncapsulatedUnionMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Transmit as and represent as*/ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrXmitOrRepAsMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* User_marshal */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrUserMarshalMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Interface pointer */ + +RPCRTAPI +unsigned long +RPC_ENTRY +NdrInterfacePointerMemorySize( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* + * Freeing routines + */ + +RPCRTAPI +void +RPC_ENTRY +NdrPointerFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrCsArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Structures */ + +RPCRTAPI +void +RPC_ENTRY +NdrSimpleStructFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantStructFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantVaryingStructFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrComplexStructFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Arrays */ + +RPCRTAPI +void +RPC_ENTRY +NdrFixedArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConformantVaryingArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrVaryingArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrComplexArrayFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Unions */ + +RPCRTAPI +void +RPC_ENTRY +NdrEncapsulatedUnionFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +RPCRTAPI +void +RPC_ENTRY +NdrNonEncapsulatedUnionFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Byte count */ + +RPCRTAPI +void +RPC_ENTRY +NdrByteCountPointerFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Transmit as and represent as*/ + +RPCRTAPI +void +RPC_ENTRY +NdrXmitOrRepAsFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* User_marshal */ + +RPCRTAPI +void +RPC_ENTRY +NdrUserMarshalFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* Interface pointer */ + +RPCRTAPI +void +RPC_ENTRY +NdrInterfacePointerFree( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pMemory, + PFORMAT_STRING pFormat + ); + +/* + * Endian conversion routine. + */ + +RPCRTAPI +void +RPC_ENTRY +NdrConvert2( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat, + long NumberParams + ); + +RPCRTAPI +void +RPC_ENTRY +NdrConvert( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +#define USER_MARSHAL_FC_BYTE 1 +#define USER_MARSHAL_FC_CHAR 2 +#define USER_MARSHAL_FC_SMALL 3 +#define USER_MARSHAL_FC_USMALL 4 +#define USER_MARSHAL_FC_WCHAR 5 +#define USER_MARSHAL_FC_SHORT 6 +#define USER_MARSHAL_FC_USHORT 7 +#define USER_MARSHAL_FC_LONG 8 +#define USER_MARSHAL_FC_ULONG 9 +#define USER_MARSHAL_FC_FLOAT 10 +#define USER_MARSHAL_FC_HYPER 11 +#define USER_MARSHAL_FC_DOUBLE 12 + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrUserMarshalSimpleTypeConvert( + unsigned long * pFlags, + unsigned char * pBuffer, + unsigned char FormatChar + ); + +/* + * Auxilary routines + */ + +RPCRTAPI +void +RPC_ENTRY +NdrClientInitializeNew( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor, + unsigned int ProcNum + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrServerInitializeNew( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerInitializePartial( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor, + unsigned long RequestedBufferSize + ); + +RPCRTAPI +void +RPC_ENTRY +NdrClientInitialize( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor, + unsigned int ProcNum + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrServerInitialize( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrServerInitializeUnmarshall ( + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor, + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerInitializeMarshall ( + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrGetBuffer( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned long BufferLength, + RPC_BINDING_HANDLE Handle + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNsGetBuffer( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned long BufferLength, + RPC_BINDING_HANDLE Handle + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrSendReceive( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pBufferEnd + ); + +RPCRTAPI +unsigned char * +RPC_ENTRY +NdrNsSendReceive( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned char * pBufferEnd, + RPC_BINDING_HANDLE * pAutoHandle + ); + +RPCRTAPI +void +RPC_ENTRY +NdrFreeBuffer( + PMIDL_STUB_MESSAGE pStubMsg + ); + +RPCRTAPI +HRESULT +RPC_ENTRY +NdrGetDcomProtocolVersion( + PMIDL_STUB_MESSAGE pStubMsg, + RPC_VERSION * pVersion ); + +#pragma warning(pop) + +/* + * Interpreter calls. + */ + +/* client */ + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrClientCall2( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrClientCall( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrAsyncClientCall( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +#if ( !defined(_WIN64) && !defined(_ARM_) ) + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrClientCall4( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrAsyncClientCall2( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrMesProcEncodeDecode4( + handle_t Handle, + const MIDL_STUB_DESC * pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrDcomAsyncClientCall( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +#if ( !defined(_WIN64) && !defined(_ARM_) ) + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrDcomAsyncClientCall2( + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + ... + ); + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +/* server */ +typedef enum { + STUB_UNMARSHAL, + STUB_CALL_SERVER, + STUB_MARSHAL, + STUB_CALL_SERVER_NO_HRESULT +}STUB_PHASE; + +typedef enum { + PROXY_CALCSIZE, + PROXY_GETBUFFER, + PROXY_MARSHAL, + PROXY_SENDRECEIVE, + PROXY_UNMARSHAL +}PROXY_PHASE; + +struct IRpcStubBuffer; // Forward declaration + + +// Raw RPC only +RPCRTAPI +void +RPC_ENTRY +NdrAsyncServerCall( + PRPC_MESSAGE pRpcMsg + ); + +// old dcom async scheme +RPCRTAPI +long +RPC_ENTRY +NdrAsyncStubCall( + struct IRpcStubBuffer * pThis, + struct IRpcChannelBuffer * pChannel, + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +// async uuid +RPCRTAPI +long +RPC_ENTRY +NdrDcomAsyncStubCall( + struct IRpcStubBuffer * pThis, + struct IRpcChannelBuffer * pChannel, + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +RPCRTAPI +long +RPC_ENTRY +NdrStubCall2( + void * pThis, // struct IRpcStubBuffer + void * pChannel, // struct IRpcChannelBuffer + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerCall2( + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +long +RPC_ENTRY +NdrStubCall ( + void * pThis, // struct IRpcStubBuffer + void * pChannel, // struct IRpcChannelBuffer + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerCall( + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +int +RPC_ENTRY +NdrServerUnmarshall( + void * pChannel, // Converted to struct IRpcChannelBuffer + PRPC_MESSAGE pRpcMsg, + PMIDL_STUB_MESSAGE pStubMsg, + PMIDL_STUB_DESC pStubDescriptor, + PFORMAT_STRING pFormat, + void * pParamList + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerMarshall( + void * pThis, //Converted to struct IRpcStubBuffer + void * pChannel, // Converted to struct IRpcChannelBuffer + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat + ); + +/* Comm and Fault status */ + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +NdrMapCommAndFaultStatus( + PMIDL_STUB_MESSAGE pStubMsg, + unsigned long * pCommStatus, + unsigned long * pFaultStatus, + RPC_STATUS Status + ); + + + +/**************************************************************************** + MIDL 2.0 memory package: rpc_ss_* rpc_sm_* + ****************************************************************************/ + +typedef void * RPC_SS_THREAD_HANDLE; + +typedef void * __RPC_API +RPC_CLIENT_ALLOC ( + _In_ size_t Size + ); + +typedef void __RPC_API +RPC_CLIENT_FREE ( + _In_ void * Ptr + ); + +/*++ + RpcSs* package +--*/ + +RPCRTAPI +void * +RPC_ENTRY +RpcSsAllocate ( + _In_ size_t Size + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsDisableAllocate ( + void + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsEnableAllocate ( + void + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsFree ( + _In_ void * NodeToFree + ); + +RPCRTAPI +RPC_SS_THREAD_HANDLE +RPC_ENTRY +RpcSsGetThreadHandle ( + void + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsSetClientAllocFree ( + _In_ RPC_CLIENT_ALLOC * ClientAlloc, + _In_ RPC_CLIENT_FREE * ClientFree + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsSetThreadHandle ( + _In_ RPC_SS_THREAD_HANDLE Id + ); + +RPCRTAPI +void +RPC_ENTRY +RpcSsSwapClientAllocFree ( + _In_ RPC_CLIENT_ALLOC * ClientAlloc, + _In_ RPC_CLIENT_FREE * ClientFree, + _Out_ RPC_CLIENT_ALLOC * * OldClientAlloc, + _Out_ RPC_CLIENT_FREE * * OldClientFree + ); + +/*++ + RpcSm* package +--*/ + +RPCRTAPI +void * +RPC_ENTRY +RpcSmAllocate ( + _In_ size_t Size, + _Out_ RPC_STATUS * pStatus + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmClientFree ( + _In_ void * pNodeToFree + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmDestroyClientContext ( + _In_ void * * ContextHandle + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmDisableAllocate ( + void + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmEnableAllocate ( + void + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmFree ( + _In_ void * NodeToFree + ); + +RPCRTAPI +RPC_SS_THREAD_HANDLE +RPC_ENTRY +RpcSmGetThreadHandle ( + _Out_ RPC_STATUS * pStatus + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmSetClientAllocFree ( + _In_ RPC_CLIENT_ALLOC * ClientAlloc, + _In_ RPC_CLIENT_FREE * ClientFree + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmSetThreadHandle ( + _In_ RPC_SS_THREAD_HANDLE Id + ); + +RPCRTAPI +RPC_STATUS +RPC_ENTRY +RpcSmSwapClientAllocFree ( + _In_ RPC_CLIENT_ALLOC * ClientAlloc, + _In_ RPC_CLIENT_FREE * ClientFree, + _Out_ RPC_CLIENT_ALLOC * * OldClientAlloc, + _Out_ RPC_CLIENT_FREE * * OldClientFree + ); + +/*++ + Ndr stub entry points +--*/ + +RPCRTAPI +void +RPC_ENTRY +NdrRpcSsEnableAllocate( + PMIDL_STUB_MESSAGE pMessage ); + +RPCRTAPI +void +RPC_ENTRY +NdrRpcSsDisableAllocate( + PMIDL_STUB_MESSAGE pMessage ); + +RPCRTAPI +void +RPC_ENTRY +NdrRpcSmSetClientToOsf( + PMIDL_STUB_MESSAGE pMessage ); + +RPCRTAPI +void * +RPC_ENTRY +NdrRpcSmClientAllocate ( + _In_ size_t Size + ); + +RPCRTAPI +void +RPC_ENTRY +NdrRpcSmClientFree ( + _In_ void * NodeToFree + ); + +RPCRTAPI +void * +RPC_ENTRY +NdrRpcSsDefaultAllocate ( + _In_ size_t Size + ); + +RPCRTAPI +void +RPC_ENTRY +NdrRpcSsDefaultFree ( + _In_ void * NodeToFree + ); + +/**************************************************************************** + end of memory package: rpc_ss_* rpc_sm_* + ****************************************************************************/ + +/**************************************************************************** + * Full Pointer APIs + ****************************************************************************/ + +RPCRTAPI +PFULL_PTR_XLAT_TABLES +RPC_ENTRY +NdrFullPointerXlatInit( + unsigned long NumberOfPointers, + XLAT_SIDE XlatSide + ); + +RPCRTAPI +void +RPC_ENTRY +NdrFullPointerXlatFree( + PFULL_PTR_XLAT_TABLES pXlatTables + ); + + +RPCRTAPI +void * +RPC_ENTRY +NdrAllocate( + PMIDL_STUB_MESSAGE pStubMsg, + size_t Len + ); + +RPCRTAPI +void +RPC_ENTRY +NdrClearOutParameters( + PMIDL_STUB_MESSAGE pStubMsg, + PFORMAT_STRING pFormat, + void * ArgAddr + ); + + +/**************************************************************************** + * Proxy APIs + ****************************************************************************/ + +RPCRTAPI +void * +RPC_ENTRY +NdrOleAllocate ( + _In_ size_t Size + ); + +RPCRTAPI +void +RPC_ENTRY +NdrOleFree ( + _In_ void * NodeToFree + ); + +#ifdef CONST_VTABLE +#define CONST_VTBL const +#else +#define CONST_VTBL +#endif + +/**************************************************************************** + * VC COM support + ****************************************************************************/ + +#ifndef DECLSPEC_SELECTANY +#if (_MSC_VER >= 1100) +#define DECLSPEC_SELECTANY __declspec(selectany) +#else +#define DECLSPEC_SELECTANY +#endif +#endif + +#ifndef DECLSPEC_NOVTABLE +#if (_MSC_VER >= 1100) && defined(__cplusplus) +#define DECLSPEC_NOVTABLE __declspec(novtable) +#else +#define DECLSPEC_NOVTABLE +#endif +#endif + +#ifndef DECLSPEC_UUID +#if (_MSC_VER >= 1100) && defined(__cplusplus) +#define DECLSPEC_UUID(x) __declspec(uuid(x)) +#else +#define DECLSPEC_UUID(x) +#endif +#endif + +#ifndef DECLSPEC_XFGVIRT +#if _CONTROL_FLOW_GUARD_XFG +#define DECLSPEC_XFGVIRT(base, func) __declspec(xfg_virtual(base, func)) +#else +#define DECLSPEC_XFGVIRT(base, func) +#endif +#endif + +#ifndef DECLSPEC_XFGREUSE +#if _CONTROL_FLOW_GUARD_XFG +#define DECLSPEC_XFGREUSE(vtbl, func) __declspec(xfg_reuse_typehash(vtbl, func)) +#else +#define DECLSPEC_XFGREUSE(vtbl, func) +#endif +#endif + +#define MIDL_INTERFACE(x) struct DECLSPEC_UUID(x) DECLSPEC_NOVTABLE + +#if _MSC_VER >= 1100 +#define EXTERN_GUID(itf,l1,s1,s2,c1,c2,c3,c4,c5,c6,c7,c8) \ + EXTERN_C const IID DECLSPEC_SELECTANY itf = {l1,s1,s2,{c1,c2,c3,c4,c5,c6,c7,c8}} +#else +#define EXTERN_GUID(itf,l1,s1,s2,c1,c2,c3,c4,c5,c6,c7,c8) EXTERN_C const IID itf +#endif + +#if defined(__cplusplus) && defined(__cpp_inline_variables) + +#if defined(__cpp_constinit) +#define MIDL_CONSTINIT_CONST_INLINE_VARIABLE EXTERN_C inline constinit const +#else +#define MIDL_CONSTINIT_CONST_INLINE_VARIABLE EXTERN_C inline const +#endif + +#else + +#if (_MSC_VER >= 1100) +#define MIDL_CONSTINIT_CONST_INLINE_VARIABLE EXTERN_C const __declspec(selectany) +#else +#define MIDL_CONSTINIT_CONST_INLINE_VARIABLE static const +#endif + +#endif + +/**************************************************************************** + * UserMarshal information + ****************************************************************************/ + +typedef struct _NDR_USER_MARSHAL_INFO_LEVEL1 +{ + _Field_size_bytes_(BufferSize) void* Buffer; + unsigned long BufferSize; + void *(__RPC_API * pfnAllocate)(size_t); + void (__RPC_API * pfnFree)(void *); + struct IRpcChannelBuffer * pRpcChannelBuffer; + ULONG_PTR Reserved[5]; +} NDR_USER_MARSHAL_INFO_LEVEL1; + +#if !defined( RC_INVOKED ) +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) +#endif + +typedef struct _NDR_USER_MARSHAL_INFO +{ + unsigned long InformationLevel; + union { + NDR_USER_MARSHAL_INFO_LEVEL1 Level1; + } DUMMYUNIONNAME; +} NDR_USER_MARSHAL_INFO; + +#if !defined( RC_INVOKED ) +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4201) +#endif +#endif + + +RPC_STATUS +RPC_ENTRY +NdrGetUserMarshalInfo ( + _In_ unsigned long * pFlags, + _In_ unsigned long InformationLevel, + _Out_ NDR_USER_MARSHAL_INFO * pMarshalInfo + ); + +/**************************************************************************** + * 64bit APIs + ****************************************************************************/ +RPC_STATUS RPC_ENTRY +NdrCreateServerInterfaceFromStub( + _In_ struct IRpcStubBuffer* pStub, + _Inout_ RPC_SERVER_INTERFACE *pServerIf ); + +/* + * Interpreter calls + */ +CLIENT_CALL_RETURN RPC_VAR_ENTRY +NdrClientCall3( + MIDL_STUBLESS_PROXY_INFO *pProxyInfo, + unsigned long nProcNum, + void * pReturnValue, + ... + ); + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +Ndr64AsyncClientCall( + MIDL_STUBLESS_PROXY_INFO *pProxyInfo, + unsigned long nProcNum, + void * pReturnValue, + ... + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +CLIENT_CALL_RETURN RPC_VAR_ENTRY +Ndr64DcomAsyncClientCall( + MIDL_STUBLESS_PROXY_INFO *pProxyInfo, + unsigned long nProcNum, + void * pReturnValue, + ... + ); + +RPCRTAPI +void +RPC_ENTRY +Ndr64AsyncServerCall( + PRPC_MESSAGE pRpcMsg + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +struct IRpcStubBuffer; // Forward declaration + +RPCRTAPI +void +RPC_ENTRY +Ndr64AsyncServerCall64( + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +void +RPC_ENTRY +Ndr64AsyncServerCallAll( + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +long +RPC_ENTRY +Ndr64AsyncStubCall( + struct IRpcStubBuffer * pThis, + struct IRpcChannelBuffer * pChannel, + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +/* async uuid */ +RPCRTAPI +long +RPC_ENTRY +Ndr64DcomAsyncStubCall( + struct IRpcStubBuffer * pThis, + struct IRpcChannelBuffer * pChannel, + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +RPCRTAPI +long +RPC_ENTRY +NdrStubCall3 ( + void * pThis, // struct IRpcStubBuffer + void * pChannel, // struct IRpcChannelBuffer + PRPC_MESSAGE pRpcMsg, + unsigned long * pdwStubPhase + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerCallAll( + PRPC_MESSAGE pRpcMsg + ); + +RPCRTAPI +void +RPC_ENTRY +NdrServerCallNdr64( + PRPC_MESSAGE pRpcMsg + ); + + +RPCRTAPI +void +RPC_ENTRY +NdrServerCall3( + PRPC_MESSAGE pRpcMsg + ); + + +/* [partial_ignore] functions*/ +RPCRTAPI +void +RPC_ENTRY +NdrPartialIgnoreClientMarshall( + PMIDL_STUB_MESSAGE pStubMsg, + void * pMemory + ); + +RPCRTAPI +void +RPC_ENTRY +NdrPartialIgnoreServerUnmarshall( + PMIDL_STUB_MESSAGE pStubMsg, + void ** ppMemory + ); + +RPCRTAPI +void +RPC_ENTRY +NdrPartialIgnoreClientBufferSize( + PMIDL_STUB_MESSAGE pStubMsg, + void * pMemory + ); + +RPCRTAPI +void +RPC_ENTRY +NdrPartialIgnoreServerInitialize( + PMIDL_STUB_MESSAGE pStubMsg, + void ** ppMemory, + PFORMAT_STRING pFormat + ); + + +void RPC_ENTRY +RpcUserFree( handle_t AsyncHandle, void * pBuffer ); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#include + +#endif /* __RPCNDR_H__ */ + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcnterr.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcnterr.h new file mode 100644 index 0000000000000000000000000000000000000000..cabc691d6d4554c27a398a3840dc30960f6bf071 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcnterr.h @@ -0,0 +1,562 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + rpcnterr.h + +Abstract: + + Rpc Error Codes from the compiler and runtime + +--*/ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifndef __RPCNTERR_H__ +#define __RPCNTERR_H__ + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#endif + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if !defined(_KRPCENV_) + +#define RPC_S_OK ERROR_SUCCESS +#define RPC_S_INVALID_ARG ERROR_INVALID_PARAMETER +#define RPC_S_OUT_OF_MEMORY ERROR_OUTOFMEMORY +#define RPC_S_OUT_OF_THREADS ERROR_MAX_THRDS_REACHED +#define RPC_S_INVALID_LEVEL ERROR_INVALID_PARAMETER +#define RPC_S_BUFFER_TOO_SMALL ERROR_INSUFFICIENT_BUFFER +#define RPC_S_INVALID_SECURITY_DESC ERROR_INVALID_SECURITY_DESCR +#define RPC_S_ACCESS_DENIED ERROR_ACCESS_DENIED +#define RPC_S_SERVER_OUT_OF_MEMORY ERROR_NOT_ENOUGH_SERVER_MEMORY +#define RPC_S_ASYNC_CALL_PENDING ERROR_IO_PENDING +#define RPC_S_UNKNOWN_PRINCIPAL ERROR_NONE_MAPPED +#define RPC_S_TIMEOUT ERROR_TIMEOUT +#define RPC_S_RUNTIME_UNINITIALIZED ERROR_INVALID_FUNCTION +#if (NTDDI_VERSION >= NTDDI_VISTA) +#define RPC_S_NOT_ENOUGH_QUOTA ERROR_NOT_ENOUGH_QUOTA +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#define RPC_X_NO_MEMORY RPC_S_OUT_OF_MEMORY +#define RPC_X_INVALID_BOUND RPC_S_INVALID_BOUND +#define RPC_X_INVALID_TAG RPC_S_INVALID_TAG +#define RPC_X_ENUM_VALUE_TOO_LARGE RPC_X_ENUM_VALUE_OUT_OF_RANGE +#define RPC_X_SS_CONTEXT_MISMATCH ERROR_INVALID_HANDLE +#define RPC_X_INVALID_BUFFER ERROR_INVALID_USER_BUFFER +#define RPC_X_PIPE_APP_MEMORY ERROR_OUTOFMEMORY +#define RPC_X_INVALID_PIPE_OPERATION RPC_X_WRONG_PIPE_ORDER + +#else // _KRPCENV_ + +#define RPC_S_OK STATUS_SUCCESS + +#if defined(RPC_S_INVALID_STRING_BINDING) +#undef RPC_S_INVALID_STRING_BINDING +#endif +#define RPC_S_INVALID_STRING_BINDING RPC_NT_INVALID_STRING_BINDING + +#if defined(RPC_S_WRONG_KIND_OF_BINDING) +#undef RPC_S_WRONG_KIND_OF_BINDING +#endif +#define RPC_S_WRONG_KIND_OF_BINDING RPC_NT_WRONG_KIND_OF_BINDING + +#if defined(RPC_S_INVALID_BINDING) +#undef RPC_S_INVALID_BINDING +#endif +#define RPC_S_INVALID_BINDING RPC_NT_INVALID_BINDING + +#if defined(RPC_S_PROTSEQ_NOT_SUPPORTED) +#undef RPC_S_PROTSEQ_NOT_SUPPORTED +#endif +#define RPC_S_PROTSEQ_NOT_SUPPORTED RPC_NT_PROTSEQ_NOT_SUPPORTED + +#if defined(RPC_S_INVALID_RPC_PROTSEQ) +#undef RPC_S_INVALID_RPC_PROTSEQ +#endif +#define RPC_S_INVALID_RPC_PROTSEQ RPC_NT_INVALID_RPC_PROTSEQ + +#if defined(RPC_S_INVALID_STRING_UUID) +#undef RPC_S_INVALID_STRING_UUID +#endif +#define RPC_S_INVALID_STRING_UUID RPC_NT_INVALID_STRING_UUID + +#if defined(RPC_S_INVALID_ENDPOINT_FORMAT) +#undef RPC_S_INVALID_ENDPOINT_FORMAT +#endif +#define RPC_S_INVALID_ENDPOINT_FORMAT RPC_NT_INVALID_ENDPOINT_FORMAT + +#if defined(RPC_S_INVALID_NET_ADDR) +#undef RPC_S_INVALID_NET_ADDR +#endif +#define RPC_S_INVALID_NET_ADDR RPC_NT_INVALID_NET_ADDR + +#if defined(RPC_S_NO_ENDPOINT_FOUND) +#undef RPC_S_NO_ENDPOINT_FOUND +#endif +#define RPC_S_NO_ENDPOINT_FOUND RPC_NT_NO_ENDPOINT_FOUND + +#if defined(RPC_S_INVALID_TIMEOUT) +#undef RPC_S_INVALID_TIMEOUT +#endif +#define RPC_S_INVALID_TIMEOUT RPC_NT_INVALID_TIMEOUT + +#if defined(RPC_S_OBJECT_NOT_FOUND) +#undef RPC_S_OBJECT_NOT_FOUND +#endif +#define RPC_S_OBJECT_NOT_FOUND RPC_NT_OBJECT_NOT_FOUND + +#if defined(RPC_S_ALREADY_REGISTERED) +#undef RPC_S_ALREADY_REGISTERED +#endif +#define RPC_S_ALREADY_REGISTERED RPC_NT_ALREADY_REGISTERED + +#if defined(RPC_S_TYPE_ALREADY_REGISTERED) +#undef RPC_S_TYPE_ALREADY_REGISTERED +#endif +#define RPC_S_TYPE_ALREADY_REGISTERED RPC_NT_TYPE_ALREADY_REGISTERED + +#if defined(RPC_S_ALREADY_LISTENING) +#undef RPC_S_ALREADY_LISTENING +#endif +#define RPC_S_ALREADY_LISTENING RPC_NT_ALREADY_LISTENING + +#if defined(RPC_S_NO_PROTSEQS_REGISTERED) +#undef RPC_S_NO_PROTSEQS_REGISTERED +#endif +#define RPC_S_NO_PROTSEQS_REGISTERED RPC_NT_NO_PROTSEQS_REGISTERED + +#if defined(RPC_S_NOT_LISTENING) +#undef RPC_S_NOT_LISTENING +#endif +#define RPC_S_NOT_LISTENING RPC_NT_NOT_LISTENING + +#if defined(RPC_S_UNKNOWN_MGR_TYPE) +#undef RPC_S_UNKNOWN_MGR_TYPE +#endif +#define RPC_S_UNKNOWN_MGR_TYPE RPC_NT_UNKNOWN_MGR_TYPE + +#if defined(RPC_S_UNKNOWN_IF) +#undef RPC_S_UNKNOWN_IF +#endif +#define RPC_S_UNKNOWN_IF RPC_NT_UNKNOWN_IF + +#if defined(RPC_S_NO_BINDINGS) +#undef RPC_S_NO_BINDINGS +#endif +#define RPC_S_NO_BINDINGS RPC_NT_NO_BINDINGS + +#if defined(RPC_S_NO_MORE_BINDINGS) +#undef RPC_S_NO_MORE_BINDINGS +#endif +#define RPC_S_NO_MORE_BINDINGS RPC_NT_NO_MORE_BINDINGS + +#if defined(RPC_S_NO_PROTSEQS) +#undef RPC_S_NO_PROTSEQS +#endif +#define RPC_S_NO_PROTSEQS RPC_NT_NO_PROTSEQS + +#if defined(RPC_S_CANT_CREATE_ENDPOINT) +#undef RPC_S_CANT_CREATE_ENDPOINT +#endif +#define RPC_S_CANT_CREATE_ENDPOINT RPC_NT_CANT_CREATE_ENDPOINT + +#if defined(RPC_S_OUT_OF_RESOURCES) +#undef RPC_S_OUT_OF_RESOURCES +#endif +#define RPC_S_OUT_OF_RESOURCES RPC_NT_OUT_OF_RESOURCES + +#if defined(RPC_S_SERVER_UNAVAILABLE) +#undef RPC_S_SERVER_UNAVAILABLE +#endif +#define RPC_S_SERVER_UNAVAILABLE RPC_NT_SERVER_UNAVAILABLE + +#if defined(RPC_S_SERVER_TOO_BUSY) +#undef RPC_S_SERVER_TOO_BUSY +#endif +#define RPC_S_SERVER_TOO_BUSY RPC_NT_SERVER_TOO_BUSY + +#if defined(RPC_S_INVALID_NETWORK_OPTIONS) +#undef RPC_S_INVALID_NETWORK_OPTIONS +#endif +#define RPC_S_INVALID_NETWORK_OPTIONS RPC_NT_INVALID_NETWORK_OPTIONS + +#if defined(RPC_S_NO_CALL_ACTIVE) +#undef RPC_S_NO_CALL_ACTIVE +#endif +#define RPC_S_NO_CALL_ACTIVE RPC_NT_NO_CALL_ACTIVE + +#if defined(RPC_S_CALL_FAILED) +#undef RPC_S_CALL_FAILED +#endif +#define RPC_S_CALL_FAILED RPC_NT_CALL_FAILED + +#if defined(RPC_S_CALL_CANCELLED) +#undef RPC_S_CALL_CANCELLED +#endif +#define RPC_S_CALL_CANCELLED RPC_NT_CALL_CANCELLED + +#if defined(RPC_S_CALL_FAILED_DNE) +#undef RPC_S_CALL_FAILED_DNE +#endif +#define RPC_S_CALL_FAILED_DNE RPC_NT_CALL_FAILED_DNE + +#if defined(RPC_S_PROTOCOL_ERROR) +#undef RPC_S_PROTOCOL_ERROR +#endif +#define RPC_S_PROTOCOL_ERROR RPC_NT_PROTOCOL_ERROR + +#if defined(RPC_S_UNSUPPORTED_TRANS_SYN) +#undef RPC_S_UNSUPPORTED_TRANS_SYN +#endif +#define RPC_S_UNSUPPORTED_TRANS_SYN RPC_NT_UNSUPPORTED_TRANS_SYN + +#if defined(RPC_S_SERVER_OUT_OF_MEMORY) +#undef RPC_S_SERVER_OUT_OF_MEMORY +#endif +#define RPC_S_SERVER_OUT_OF_MEMORY STATUS_INSUFF_SERVER_RESOURCES + +#if defined(RPC_S_UNSUPPORTED_TYPE) +#undef RPC_S_UNSUPPORTED_TYPE +#endif +#define RPC_S_UNSUPPORTED_TYPE RPC_NT_UNSUPPORTED_TYPE + +#if defined(RPC_S_INVALID_TAG) +#undef RPC_S_INVALID_TAG +#endif +#define RPC_S_INVALID_TAG RPC_NT_INVALID_TAG + +#if defined(RPC_S_INVALID_BOUND) +#undef RPC_S_INVALID_BOUND +#endif +#define RPC_S_INVALID_BOUND RPC_NT_INVALID_BOUND + +#if defined(RPC_S_NO_ENTRY_NAME) +#undef RPC_S_NO_ENTRY_NAME +#endif +#define RPC_S_NO_ENTRY_NAME RPC_NT_NO_ENTRY_NAME + +#if defined(RPC_S_INVALID_NAME_SYNTAX) +#undef RPC_S_INVALID_NAME_SYNTAX +#endif +#define RPC_S_INVALID_NAME_SYNTAX RPC_NT_INVALID_NAME_SYNTAX + +#if defined(RPC_S_UNSUPPORTED_NAME_SYNTAX) +#undef RPC_S_UNSUPPORTED_NAME_SYNTAX +#endif +#define RPC_S_UNSUPPORTED_NAME_SYNTAX RPC_NT_UNSUPPORTED_NAME_SYNTAX + +#if defined(RPC_S_UUID_NO_ADDRESS) +#undef RPC_S_UUID_NO_ADDRESS +#endif +#define RPC_S_UUID_NO_ADDRESS RPC_NT_UUID_NO_ADDRESS + +#if defined(RPC_S_DUPLICATE_ENDPOINT) +#undef RPC_S_DUPLICATE_ENDPOINT +#endif +#define RPC_S_DUPLICATE_ENDPOINT RPC_NT_DUPLICATE_ENDPOINT + +#if defined(RPC_S_UNKNOWN_AUTHN_TYPE) +#undef RPC_S_UNKNOWN_AUTHN_TYPE +#endif +#define RPC_S_UNKNOWN_AUTHN_TYPE RPC_NT_UNKNOWN_AUTHN_TYPE + +#if defined(RPC_S_MAX_CALLS_TOO_SMALL) +#undef RPC_S_MAX_CALLS_TOO_SMALL +#endif +#define RPC_S_MAX_CALLS_TOO_SMALL RPC_NT_MAX_CALLS_TOO_SMALL + +#if defined(RPC_S_STRING_TOO_LONG) +#undef RPC_S_STRING_TOO_LONG +#endif +#define RPC_S_STRING_TOO_LONG RPC_NT_STRING_TOO_LONG + +#if defined(RPC_S_PROTSEQ_NOT_FOUND) +#undef RPC_S_PROTSEQ_NOT_FOUND +#endif +#define RPC_S_PROTSEQ_NOT_FOUND RPC_NT_PROTSEQ_NOT_FOUND + +#if defined(RPC_S_PROCNUM_OUT_OF_RANGE) +#undef RPC_S_PROCNUM_OUT_OF_RANGE +#endif +#define RPC_S_PROCNUM_OUT_OF_RANGE RPC_NT_PROCNUM_OUT_OF_RANGE + +#if defined(RPC_S_BINDING_HAS_NO_AUTH) +#undef RPC_S_BINDING_HAS_NO_AUTH +#endif +#define RPC_S_BINDING_HAS_NO_AUTH RPC_NT_BINDING_HAS_NO_AUTH + +#if defined(RPC_S_UNKNOWN_AUTHN_SERVICE) +#undef RPC_S_UNKNOWN_AUTHN_SERVICE +#endif +#define RPC_S_UNKNOWN_AUTHN_SERVICE RPC_NT_UNKNOWN_AUTHN_SERVICE + +#if defined(RPC_S_UNKNOWN_AUTHN_LEVEL) +#undef RPC_S_UNKNOWN_AUTHN_LEVEL +#endif +#define RPC_S_UNKNOWN_AUTHN_LEVEL RPC_NT_UNKNOWN_AUTHN_LEVEL + +#if defined(RPC_S_INVALID_AUTH_IDENTITY) +#undef RPC_S_INVALID_AUTH_IDENTITY +#endif +#define RPC_S_INVALID_AUTH_IDENTITY RPC_NT_INVALID_AUTH_IDENTITY + +#if defined(RPC_S_UNKNOWN_AUTHZ_SERVICE) +#undef RPC_S_UNKNOWN_AUTHZ_SERVICE +#endif +#define RPC_S_UNKNOWN_AUTHZ_SERVICE RPC_NT_UNKNOWN_AUTHZ_SERVICE + +#if defined(EPT_S_INVALID_ENTRY) +#undef EPT_S_INVALID_ENTRY +#endif +#define EPT_S_INVALID_ENTRY EPT_NT_INVALID_ENTRY + +#if defined(EPT_S_CANT_PERFORM_OP) +#undef EPT_S_CANT_PERFORM_OP +#endif +#define EPT_S_CANT_PERFORM_OP EPT_NT_CANT_PERFORM_OP + +#if defined(EPT_S_NOT_REGISTERED) +#undef EPT_S_NOT_REGISTERED +#endif +#define EPT_S_NOT_REGISTERED EPT_NT_NOT_REGISTERED + +#if defined(RPC_S_NOTHING_TO_EXPORT) +#undef RPC_S_NOTHING_TO_EXPORT +#endif +#define RPC_S_NOTHING_TO_EXPORT RPC_NT_NOTHING_TO_EXPORT + +#if defined(RPC_S_INCOMPLETE_NAME) +#undef RPC_S_INCOMPLETE_NAME +#endif +#define RPC_S_INCOMPLETE_NAME RPC_NT_INCOMPLETE_NAME + +#if defined(RPC_S_INVALID_VERS_OPTION) +#undef RPC_S_INVALID_VERS_OPTION +#endif +#define RPC_S_INVALID_VERS_OPTION RPC_NT_INVALID_VERS_OPTION + +#if defined(RPC_S_NO_MORE_MEMBERS) +#undef RPC_S_NO_MORE_MEMBERS +#endif +#define RPC_S_NO_MORE_MEMBERS RPC_NT_NO_MORE_MEMBERS + +#if defined(RPC_S_NOT_ALL_OBJS_UNEXPORTED) +#undef RPC_S_NOT_ALL_OBJS_UNEXPORTED +#endif +#define RPC_S_NOT_ALL_OBJS_UNEXPORTED RPC_NT_NOT_ALL_OBJS_UNEXPORTED + +#if defined(RPC_S_INTERFACE_NOT_FOUND) +#undef RPC_S_INTERFACE_NOT_FOUND +#endif +#define RPC_S_INTERFACE_NOT_FOUND RPC_NT_INTERFACE_NOT_FOUND + +#if defined(RPC_S_ENTRY_ALREADY_EXISTS) +#undef RPC_S_ENTRY_ALREADY_EXISTS +#endif +#define RPC_S_ENTRY_ALREADY_EXISTS RPC_NT_ENTRY_ALREADY_EXISTS + +#if defined(RPC_S_ENTRY_NOT_FOUND) +#undef RPC_S_ENTRY_NOT_FOUND +#endif +#define RPC_S_ENTRY_NOT_FOUND RPC_NT_ENTRY_NOT_FOUND + +#if defined(RPC_S_NAME_SERVICE_UNAVAILABLE) +#undef RPC_S_NAME_SERVICE_UNAVAILABLE +#endif +#define RPC_S_NAME_SERVICE_UNAVAILABLE RPC_NT_NAME_SERVICE_UNAVAILABLE + +#if defined(RPC_S_INVALID_NAF_ID) +#undef RPC_S_INVALID_NAF_ID +#endif +#define RPC_S_INVALID_NAF_ID RPC_NT_INVALID_NAF_ID + +#if defined(RPC_S_CANNOT_SUPPORT) +#undef RPC_S_CANNOT_SUPPORT +#endif +#define RPC_S_CANNOT_SUPPORT RPC_NT_CANNOT_SUPPORT + +#if defined(RPC_S_NO_CONTEXT_AVAILABLE) +#undef RPC_S_NO_CONTEXT_AVAILABLE +#endif +#define RPC_S_NO_CONTEXT_AVAILABLE RPC_NT_NO_CONTEXT_AVAILABLE + +#if defined(RPC_S_INTERNAL_ERROR) +#undef RPC_S_INTERNAL_ERROR +#endif +#define RPC_S_INTERNAL_ERROR RPC_NT_INTERNAL_ERROR + +#if defined(RPC_S_ZERO_DIVIDE) +#undef RPC_S_ZERO_DIVIDE +#endif +#define RPC_S_ZERO_DIVIDE RPC_NT_ZERO_DIVIDE + +#if defined(RPC_S_ADDRESS_ERROR) +#undef RPC_S_ADDRESS_ERROR +#endif +#define RPC_S_ADDRESS_ERROR RPC_NT_ADDRESS_ERROR + +#if defined(RPC_S_FP_DIV_ZERO) +#undef RPC_S_FP_DIV_ZERO +#endif +#define RPC_S_FP_DIV_ZERO RPC_NT_FP_DIV_ZERO + +#if defined(RPC_S_FP_UNDERFLOW) +#undef RPC_S_FP_UNDERFLOW +#endif +#define RPC_S_FP_UNDERFLOW RPC_NT_FP_UNDERFLOW + +#if defined(RPC_S_FP_OVERFLOW) +#undef RPC_S_FP_OVERFLOW +#endif +#define RPC_S_FP_OVERFLOW RPC_NT_FP_OVERFLOW + +#if defined(RPC_S_PROXY_ACCESS_DENIED) +#undef RPC_S_PROXY_ACCESS_DENIED +#endif +#define RPC_S_PROXY_ACCESS_DENIED RPC_NT_PROXY_ACCESS_DENIED + +#if defined(RPC_X_NO_MORE_ENTRIES) +#undef RPC_X_NO_MORE_ENTRIES +#endif +#define RPC_X_NO_MORE_ENTRIES RPC_NT_NO_MORE_ENTRIES + +#if defined(RPC_X_SS_CHAR_TRANS_OPEN_FAIL) +#undef RPC_X_SS_CHAR_TRANS_OPEN_FAIL +#endif +#define RPC_X_SS_CHAR_TRANS_OPEN_FAIL RPC_NT_SS_CHAR_TRANS_OPEN_FAIL + +#if defined(RPC_X_SS_CHAR_TRANS_SHORT_FILE) +#undef RPC_X_SS_CHAR_TRANS_SHORT_FILE +#endif +#define RPC_X_SS_CHAR_TRANS_SHORT_FILE RPC_NT_SS_CHAR_TRANS_SHORT_FILE + +#if defined(RPC_X_SS_IN_NULL_CONTEXT) +#undef RPC_X_SS_IN_NULL_CONTEXT +#endif +#define RPC_X_SS_IN_NULL_CONTEXT RPC_NT_SS_IN_NULL_CONTEXT + +#if defined(RPC_X_SS_CONTEXT_MISMATCH) +#undef RPC_X_SS_CONTEXT_MISMATCH +#endif +#define RPC_X_SS_CONTEXT_MISMATCH RPC_NT_SS_CONTEXT_MISMATCH + +#if defined(RPC_X_SS_CONTEXT_DAMAGED) +#undef RPC_X_SS_CONTEXT_DAMAGED +#endif +#define RPC_X_SS_CONTEXT_DAMAGED RPC_NT_SS_CONTEXT_DAMAGED + +#if defined(RPC_X_SS_HANDLES_MISMATCH) +#undef RPC_X_SS_HANDLES_MISMATCH +#endif +#define RPC_X_SS_HANDLES_MISMATCH RPC_NT_SS_HANDLES_MISMATCH + +#if defined(RPC_X_SS_CANNOT_GET_CALL_HANDLE) +#undef RPC_X_SS_CANNOT_GET_CALL_HANDLE +#endif +#define RPC_X_SS_CANNOT_GET_CALL_HANDLE RPC_NT_SS_CANNOT_GET_CALL_HANDLE + +#if defined(RPC_X_NULL_REF_POINTER) +#undef RPC_X_NULL_REF_POINTER +#endif +#define RPC_X_NULL_REF_POINTER RPC_NT_NULL_REF_POINTER + +#if defined(RPC_X_ENUM_VALUE_OUT_OF_RANGE) +#undef RPC_X_ENUM_VALUE_OUT_OF_RANGE +#endif +#define RPC_X_ENUM_VALUE_OUT_OF_RANGE RPC_NT_ENUM_VALUE_OUT_OF_RANGE + +#if defined(RPC_X_BYTE_COUNT_TOO_SMALL) +#undef RPC_X_BYTE_COUNT_TOO_SMALL +#endif +#define RPC_X_BYTE_COUNT_TOO_SMALL RPC_NT_BYTE_COUNT_TOO_SMALL + +#if defined(RPC_X_BAD_STUB_DATA) +#undef RPC_X_BAD_STUB_DATA +#endif +#define RPC_X_BAD_STUB_DATA RPC_NT_BAD_STUB_DATA + +#if defined(RPC_S_CALL_IN_PROGRESS) +#undef RPC_S_CALL_IN_PROGRESS +#endif +#define RPC_S_CALL_IN_PROGRESS RPC_NT_CALL_IN_PROGRESS + +#if defined(RPC_S_GROUP_MEMBER_NOT_FOUND) +#undef RPC_S_GROUP_MEMBER_NOT_FOUND +#endif +#define RPC_S_GROUP_MEMBER_NOT_FOUND RPC_NT_GROUP_MEMBER_NOT_FOUND + +#if defined(EPT_S_CANT_CREATE) +#undef EPT_S_CANT_CREATE +#endif +#define EPT_S_CANT_CREATE EPT_NT_CANT_CREATE + +#if defined(RPC_S_INVALID_OBJECT) +#undef RPC_S_INVALID_OBJECT +#endif +#define RPC_S_INVALID_OBJECT RPC_NT_INVALID_OBJECT + +#if defined(RPC_S_INVALID_ASYNC_HANDLE) +#undef RPC_S_INVALID_ASYNC_HANDLE +#endif +#define RPC_S_INVALID_ASYNC_HANDLE RPC_NT_INVALID_ASYNC_HANDLE + +#if defined(RPC_S_INVALID_ASYNC_CALL) +#undef RPC_S_INVALID_ASYNC_CALL +#endif +#define RPC_S_INVALID_ASYNC_CALL RPC_NT_INVALID_ASYNC_CALL + +#if defined(RPC_X_PIPE_CLOSED) +#undef RPC_X_PIPE_CLOSED +#endif +#define RPC_X_PIPE_CLOSED RPC_NT_PIPE_CLOSED + +#if defined(RPC_X_PIPE_EMPTY) +#undef RPC_X_PIPE_EMPTY +#endif +#define RPC_X_PIPE_EMPTY RPC_NT_PIPE_EMPTY + +#if defined(RPC_X_PIPE_DISCIPLINE_ERROR) +#undef RPC_X_PIPE_DISCIPLINE_ERROR +#endif +#define RPC_X_PIPE_DISCIPLINE_ERROR RPC_NT_PIPE_DISCIPLINE_ERROR + +#define RPC_S_INVALID_ARG STATUS_INVALID_PARAMETER +#define RPC_S_OUT_OF_MEMORY STATUS_NO_MEMORY +#define RPC_S_OUT_OF_THREADS STATUS_NO_MEMORY +#define RPC_S_INVALID_LEVEL STATUS_INVALID_PARAMETER +#define RPC_S_BUFFER_TOO_SMALL STATUS_BUFFER_TOO_SMALL +#define RPC_S_INVALID_SECURITY_DESC STATUS_INVALID_SECURITY_DESCR +#define RPC_S_ACCESS_DENIED STATUS_ACCESS_DENIED +#define RPC_S_ASYNC_CALL_PENDING STATUS_PENDING +#define RPC_S_UNKNOWN_PRINCIPAL STATUS_NONE_MAPPED +#define RPC_S_NOT_ENOUGH_QUOTA STATUS_QUOTA_EXCEEDED +#define RPC_S_RUNTIME_UNINITIALIZED RPC_INVALID_FUNCTION +#define RPC_X_NO_MEMORY STATUS_NO_MEMORY +#define RPC_X_INVALID_BOUND RPC_NT_INVALID_BOUND +#define RPC_X_INVALID_TAG RPC_NT_INVALID_TAG +#define RPC_X_ENUM_VALUE_TOO_LARGE RPC_NT_ENUM_VALUE_OUT_OF_RANGE +#define RPC_X_SS_CONTEXT_MISMATCH RPC_NT_SS_CONTEXT_MISMATCH +#define RPC_X_INVALID_BUFFER STATUS_INVALID_BUFFER_SIZE +#define RPC_X_PIPE_APP_MEMORY STATUS_NO_MEMORY + +#endif // _KRPCENV_ + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + +#endif /* __RPCNTERR_H__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcsal.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcsal.h new file mode 100644 index 0000000000000000000000000000000000000000..2b9bbdb6e030e856bab8a22635b741d13f4217fa --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/rpcsal.h @@ -0,0 +1,330 @@ +/****************************************************************\ +* * +* rpcsal.h - markers for documenting the semantics of RPC APIs * +* * +* Version 1.0 * +* * +* Copyright (c) 2004 Microsoft Corporation. All rights reserved. * +* * +\****************************************************************/ + +// ------------------------------------------------------------------------------- +// Introduction +// +// rpcsal.h provides a set of annotations to describe how RPC functions use their +// parameters - the assumptions it makes about them, adn the guarantees it makes +// upon finishing. These annotations are similar to those found in specstrings.h, +// but are designed to be used by the MIDL compiler when it generates annotations +// enabled header files. +// +// IDL authors do not need to annotate their functions declarations. The MIDL compiler +// will interpret the IDL directives and use one of the annotations contained +// in this header. This documentation is intended to help those trying to understand +// the MIDL-generated header files or those who maintain their own copies of these files. +// +// ------------------------------------------------------------------------------- +// Differences between rpcsal.h and specstrings.h +// +// There are a few important differences between the annotations found in rpcsal.h and +// those in specstrings.h: +// +// 1. [in] parameters are not marked as read-only. They may be used for scratch space +// at the server and changes will not affect the client. +// 2. String versions of each macro alleviates the need for a special type definition +// +// ------------------------------------------------------------------------------- +// Interpreting RPC Annotations +// +// These annotations are interpreted precisely in the same way as those in specstrings.h. +// Please refer to that header for information related to general usage in annotations. +// +// To construct an RPC annotation, concatenate the appropriate value from each category +// along with a leading __RPC_. A typical annotation looks like "__RPC__in_string". +// +// |----------------------------------------------------------------------------------| +// | RPC Annotations | +// |------------|------------|---------|--------|----------|----------|---------------| +// | Level | Usage | Size | Output | Optional | String | Parameters | +// |------------|------------|---------|--------|----------|----------|---------------| +// | <> | <> | <> | <> | <> | <> | <> | +// | _deref | _in | _ecount | _full | _opt | _string | (size) | +// | _deref_opt | _out | _bcount | _part | | | (size,length) | +// | | _inout | | | | | | +// | | | | | | | | +// |------------|------------|---------|--------|----------|----------|---------------| +// +// Level: Describes the buffer pointer's level of indirection from the parameter or +// return value 'p'. +// +// <> : p is the buffer pointer. +// _deref : *p is the buffer pointer. p must not be NULL. +// _deref_opt : *p may be the buffer pointer. p may be NULL, in which case the rest of +// the annotation is ignored. +// +// Usage: Describes how the function uses the buffer. +// +// <> : The buffer is not accessed. If used on the return value or with _deref, the +// function will provide the buffer, and it will be uninitialized at exit. +// Otherwise, the caller must provide the buffer. This should only be used +// for alloc and free functions. +// _in : The function will only read from the buffer. The caller must provide the +// buffer and initialize it. Cannot be used with _deref. +// _out : The function will only write to the buffer. If used on the return value or +// with _deref, the function will provide the buffer and initialize it. +// Otherwise, the caller must provide the buffer, and the function will +// initialize it. +// _inout : The function may freely read from and write to the buffer. The caller must +// provide the buffer and initialize it. If used with _deref, the buffer may +// be reallocated by the function. +// +// Size: Describes the total size of the buffer. This may be less than the space actually +// allocated for the buffer, in which case it describes the accessible amount. +// +// <> : No buffer size is given. If the type specifies the buffer size (such as +// with LPSTR and LPWSTR), that amount is used. Otherwise, the buffer is one +// element long. Must be used with _in, _out, or _inout. +// _ecount : The buffer size is an explicit element count. +// _bcount : The buffer size is an explicit byte count. +// +// Output: Describes how much of the buffer will be initialized by the function. For +// _inout buffers, this also describes how much is initialized at entry. Omit this +// category for _in buffers; they must be fully initialized by the caller. +// +// <> : The type specifies how much is initialized. For instance, a function initializing +// an LPWSTR must NULL-terminate the string. +// _full : The function initializes the entire buffer. +// _part : The function initializes part of the buffer, and explicitly indicates how much. +// +// Optional: Describes if the buffer itself is optional. +// +// <> : The pointer to the buffer must not be NULL. +// _opt : The pointer to the buffer might be NULL. It will be checked before being dereferenced. +// +// String: Describes if the buffer is NULL terminated +// +// <> : The buffer is not assumed to be NULL terminated +// _string : The buffer is assumed to be NULL terminated once it has been initialized +// +// Parameters: Gives explicit counts for the size and length of the buffer. +// +// <> : There is no explicit count. Use when neither _ecount nor _bcount is used. +// (size) : Only the buffer's total size is given. Use with _ecount or _bcount but not _part. +// (size,length) : The buffer's total size and initialized length are given. Use with _ecount_part +// and _bcount_part. +// +// Notes: +// +// 1. Specifying two buffer annotations on a single parameter results in unspecified behavior +// (e.g. __RPC__in_bcount(5) __RPC__out_bcount(6) +// +// 2. The size of the buffer and the amount that has been initialized are separate concepts. +// Specify the size using _ecount or _bcount. Specify the amount that is initialized using +// _full, _part, or _string. As a special case, a single element buffer does not need +// _ecount, _bcount, _full, or _part +// +// 3. The count may be less than the total size of the buffer in which case it describes the +// accessible portion. +// +// 4. "__RPC__opt" and "__RPC_deref" are not valid annotations. +// +// 5. The placement of _opt when using _deref is important: +// __RPC__deref_opt_... : Input may be NULL +// __RPC__deref_..._opt : Output may be NULL +// __RPC__deref_opt_..._opt : Both input and output may be NULL +// + +#pragma once + +#include + +#ifndef __RPCSAL_H_VERSION__ +#define __RPCSAL_H_VERSION__ ( 100 ) +#endif // __RPCSAL_H_VERSION__ + +#ifdef __REQUIRED_RPCSAL_H_VERSION__ + #if ( __RPCSAL_H_VERSION__ < __REQUIRED_RPCSAL_H_VERSION__ ) + #error incorrect version. Use the header that matches with the MIDL compiler. + #endif +#endif + + +#ifdef __cplusplus +extern "C" { +#endif // #ifdef __cplusplus + + +#ifndef _SAL1_2_Source_ +#define _SAL1_2_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1.2") _Group_(annotes _SAL_nop_impl_) +#endif // _SAL1_2_Source_ + +// [in] +#define __RPC__in _SAL1_2_Source_(__RPC__in, (), _Pre_ _Notref_ _Notnull_ _Pre_ _Valid_) +#define __RPC__in_string _SAL1_2_Source_(__RPC__in_string, (), __RPC__in _Pre_ _Null_terminated_) +#define __RPC__in_ecount(size) _SAL1_2_Source_(__RPC__in_ecount, (size), __RPC__in _Pre_readable_size_(size)) +#define __RPC__in_ecount_full(size) _SAL1_2_Source_(__RPC__in_ecount_full, (size), __RPC__in_ecount(size)) +#define __RPC__in_ecount_full_string(size) _SAL1_2_Source_(__RPC__in_ecount_full_string, (size), __RPC__in_ecount_full(size) _Pre_ _Null_terminated_) +#define __RPC__in_ecount_part(size, length) _SAL1_2_Source_(__RPC__in_ecount_part, (size,length), __RPC__in_ecount(length) _Pre_writable_size_(size)) +#define __RPC__in_xcount(size) _SAL1_2_Source_(__RPC__in_xcount, (size), __RPC__in _Pre_readable_size_(size)) +#define __RPC__in_xcount_full(size) _SAL1_2_Source_(__RPC__in_xcount_full, (size), __RPC__in_ecount(size)) +#define __RPC__in_xcount_full_string(size) _SAL1_2_Source_(__RPC__in_xcount_full_string, (size), __RPC__in_ecount_full(size) _Pre_ _Null_terminated_) +#define __RPC__in_xcount_part(size, length) _SAL1_2_Source_(__RPC__in_xcount_part, (size,length), __RPC__in_ecount(length) _Pre_writable_size_(size)) + + +#define __RPC__deref_in _SAL1_2_Source_(__RPC__deref_in, (), __RPC__in _At_(*_Curr_, _Pre_ _Notnull_)) +#define __RPC__deref_in_string _SAL1_2_Source_(__RPC__deref_in_string, (), __RPC__deref_in _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_in_opt _SAL1_2_Source_(__RPC__deref_in_opt, (), __RPC__in _At_(*_Curr_, _Pre_ _Maybenull_)) +#define __RPC__deref_in_opt_string _SAL1_2_Source_(__RPC__deref_in_opt_string, (), __RPC__deref_in_opt _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_opt_in _SAL1_2_Source_(__RPC__deref_opt_in, (), __RPC__in_opt _At_(*_Curr_, _Pre_ _Notnull_)) +#define __RPC__deref_opt_in_string _SAL1_2_Source_(__RPC__deref_opt_in_string, (), __RPC__deref_opt_in _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_opt_in_opt _SAL1_2_Source_(__RPC__deref_opt_in_opt, (), __RPC__in_opt _At_(*_Curr_, _Pre_ _Maybenull_)) +#define __RPC__deref_opt_in_opt_string _SAL1_2_Source_(__RPC__deref_opt_in_opt_string, (), __RPC__deref_opt_in_opt _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_in_ecount(size) _SAL1_2_Source_(__RPC__deref_in_ecount, (size), __RPC__in _At_(*_Curr_, _Pre_ _Notnull_ _Pre_readable_size_(size))) +#define __RPC__deref_in_ecount_part(size, length) _SAL1_2_Source_(__RPC__deref_in_ecount_part, (size,length), __RPC__deref_in_ecount(size) _At_(*_Curr_, _Pre_readable_size_(length))) +#define __RPC__deref_in_ecount_full(size) _SAL1_2_Source_(__RPC__deref_in_ecount_full, (size), __RPC__deref_in_ecount_part(size, size)) +#define __RPC__deref_in_ecount_full_opt(size) _SAL1_2_Source_(__RPC__deref_in_ecount_full_opt, (size), __RPC__deref_in_ecount_part_opt(size, size)) +#define __RPC__deref_in_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_in_ecount_full_opt_string, (size), __RPC__deref_in_ecount_full_opt(size) _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_in_ecount_full_string(size) _SAL1_2_Source_(__RPC__deref_in_ecount_full_string, (size), __RPC__deref_in_ecount_full(size) _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_in_ecount_opt(size) _SAL1_2_Source_(__RPC__deref_in_ecount_opt, (size), __RPC__in _At_(*_Curr_, _Pre_ _Maybenull_ _Pre_readable_size_(size))) +#define __RPC__deref_in_ecount_opt_string(size) _SAL1_2_Source_(__RPC__deref_in_ecount_opt_string, (size), __RPC__deref_in_ecount_opt(size) _At_(*_Curr_, _Pre_ _Null_terminated_)) +#define __RPC__deref_in_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_in_ecount_part_opt, (size,length), __RPC__deref_in_ecount_opt(size) _At_(*_Curr_, _Pre_readable_size_(length))) +#define __RPC__deref_in_xcount(size) _SAL1_2_Source_(__RPC__deref_in_xcount, (size), __RPC__deref_in_ecount(size)) +#define __RPC__deref_in_xcount_part(size, length) _SAL1_2_Source_(__RPC__deref_in_xcount_part, (size,length), __RPC__deref_in_ecount_part(size, length)) +#define __RPC__deref_in_xcount_full(size) _SAL1_2_Source_(__RPC__deref_in_xcount_full, (size), __RPC__deref_in_ecount_part(size, size)) +#define __RPC__deref_in_xcount_full_opt(size) _SAL1_2_Source_(__RPC__deref_in_xcount_full_opt, (size), __RPC__deref_in_ecount_full_opt(size)) +#define __RPC__deref_in_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_in_xcount_full_opt_string, (size), __RPC__deref_in_ecount_full_opt_string(size)) +#define __RPC__deref_in_xcount_full_string(size) _SAL1_2_Source_(__RPC__deref_in_xcount_full_string, (size), __RPC__deref_in_ecount_full_string(size)) +#define __RPC__deref_in_xcount_opt(size) _SAL1_2_Source_(__RPC__deref_in_xcount_opt, (size), __RPC__deref_in_ecount_opt(size)) +#define __RPC__deref_in_xcount_opt_string(size) _SAL1_2_Source_(__RPC__deref_in_xcount_opt_string, (size), __RPC__deref_in_ecount_opt_string(size)) +#define __RPC__deref_in_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_in_xcount_part_opt, (size,length), __RPC__deref_in_ecount_part_opt(size)) + +// [out] +#define __RPC__out _SAL1_2_Source_(__RPC__out, (), _Out_) +#define __RPC__out_ecount(size) _SAL1_2_Source_(__RPC__out_ecount, (size), _Out_writes_(size) _Post_writable_size_(size)) +#define __RPC__out_ecount_string(size) _SAL1_2_Source_(__RPC__out_ecount_string, (size), __RPC__out_ecount(size) _Post_ _Null_terminated_) +#define __RPC__out_ecount_part(size, length) _SAL1_2_Source_(__RPC__out_ecount_part, (size,length), __RPC__out_ecount(size) _Post_readable_size_(length)) +#define __RPC__out_ecount_full(size) _SAL1_2_Source_(__RPC__out_ecount_full, (size), __RPC__out_ecount_part(size, size)) +#define __RPC__out_ecount_full_string(size) _SAL1_2_Source_(__RPC__out_ecount_full_string, (size), __RPC__out_ecount_full(size) _Post_ _Null_terminated_) +#define __RPC__out_xcount(size) _SAL1_2_Source_(__RPC__out_xcount, (size), _Out_) +#define __RPC__out_xcount_string(size) _SAL1_2_Source_(__RPC__out_xcount_string, (size), __RPC__out _Post_ _Null_terminated_) +#define __RPC__out_xcount_part(size, length) _SAL1_2_Source_(__RPC__out_xcount_part, (size,length), __RPC__out) +#define __RPC__out_xcount_full(size) _SAL1_2_Source_(__RPC__out_xcount_full, (size), __RPC__out) +#define __RPC__out_xcount_full_string(size) _SAL1_2_Source_(__RPC__out_xcount_full_string, (size), __RPC__out _Post_ _Null_terminated_) + +// [in,out] +#define __RPC__inout _SAL1_2_Source_(__RPC__inout, (), _Inout_) +#define __RPC__inout_string _SAL1_2_Source_(__RPC__inout_string, (), __RPC__inout _Pre_ _Null_terminated_ _Post_ _Null_terminated_) +#define __RPC__inout_ecount(size) _SAL1_2_Source_(__RPC__inout_ecount, (size), _Inout_updates_(size)) +#define __RPC__inout_ecount_part(size, length) _SAL1_2_Source_(__RPC__inout_ecount_part, (size,length), _Inout_updates_to_(size, length)) +#define __RPC__inout_ecount_full(size) _SAL1_2_Source_(__RPC__inout_ecount_full, (size), __RPC__inout_ecount_part(size, size)) +#define __RPC__inout_ecount_full_string(size) _SAL1_2_Source_(__RPC__inout_ecount_full_string, (size), __RPC__inout_ecount_full(size) _Pre_ _Null_terminated_ _Post_ _Null_terminated_) +#define __RPC__inout_xcount(size) _SAL1_2_Source_(__RPC__inout_xcount, (size), _Inout_) +#define __RPC__inout_xcount_part(size, length) _SAL1_2_Source_(__RPC__inout_xcount_part, (size,length), _Inout_) +#define __RPC__inout_xcount_full(size) _SAL1_2_Source_(__RPC__inout_xcount_full, (size), __RPC__inout) +#define __RPC__inout_xcount_full_string(size) _SAL1_2_Source_(__RPC__inout_xcount_full_string, (size), __RPC__inout _Pre_ _Null_terminated_ _Post_ _Null_terminated_) + +// [in,unique] +#define __RPC__in_opt _SAL1_2_Source_(__RPC__in_opt, (), _Pre_ _Notref_ _Maybenull_ _Pre_ _Valid_) +#define __RPC__in_opt_string _SAL1_2_Source_(__RPC__in_opt_string, (), __RPC__in_opt _Pre_ _Null_terminated_) +#define __RPC__in_ecount_opt(size) _SAL1_2_Source_(__RPC__in_ecount_opt, (size), __RPC__in_opt _Pre_readable_size_(size)) +#define __RPC__in_ecount_opt_string(size) _SAL1_2_Source_(__RPC__in_ecount_opt_string, (size), __RPC__in_ecount_opt(size) _Pre_ _Null_terminated_) +#define __RPC__in_ecount_full_opt(size) _SAL1_2_Source_(__RPC__in_ecount_full_opt, (size), __RPC__in_ecount_opt(size)) +#define __RPC__in_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__in_ecount_full_opt_string, (size), __RPC__in_ecount_full_opt(size) _Pre_ _Null_terminated_) +#define __RPC__in_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__in_ecount_part_opt, (size,length), __RPC__in_ecount_opt(length) _Pre_writable_size_(size)) +#define __RPC__in_xcount_full_opt(size) _SAL1_2_Source_(__RPC__in_xcount_full_opt, (size), __RPC__in_ecount_opt(size)) +#define __RPC__in_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__in_xcount_full_opt_string, (size), __RPC__in_ecount_full_opt(size) _Pre_ _Null_terminated_) +#define __RPC__in_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__in_xcount_part_opt, (size,length), __RPC__in_ecount_part_opt(size, length)) +#define __RPC__in_xcount_opt(size) _SAL1_2_Source_(__RPC__in_xcount_opt, (size), __RPC__in_ecount_opt(size)) +#define __RPC__in_xcount_opt_string(size) _SAL1_2_Source_(__RPC__in_xcount_opt_string, (size), __RPC__in_ecount_opt(size) _Pre_ _Null_terminated_) + +// [in,out,unique] +#define __RPC__inout_opt _SAL1_2_Source_(__RPC__inout_opt, (), _Inout_opt_) +#define __RPC__inout_opt_string _SAL1_2_Source_(__RPC__inout_opt_string, (), __RPC__inout_opt _Pre_ _Null_terminated_) +#define __RPC__inout_ecount_opt(size) _SAL1_2_Source_(__RPC__inout_ecount_opt, (size), _Inout_updates_opt_(size)) +#define __RPC__inout_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__inout_ecount_part_opt, (size,length), _Inout_updates_to_opt_(size, length)) +#define __RPC__inout_ecount_full_opt(size) _SAL1_2_Source_(__RPC__inout_ecount_full_opt, (size), __RPC__inout_ecount_part_opt(size, size)) +#define __RPC__inout_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__inout_ecount_full_opt_string, (size), __RPC__inout_ecount_full_opt(size) _Pre_ _Null_terminated_ _Post_ _Null_terminated_) +#define __RPC__inout_xcount_opt(size) _SAL1_2_Source_(__RPC__inout_xcount_opt, (size), _Inout_opt_) +#define __RPC__inout_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__inout_xcount_part_opt, (size,length), _Inout_opt_) +#define __RPC__inout_xcount_full_opt(size) _SAL1_2_Source_(__RPC__inout_xcount_full_opt, (size), __RPC__inout_opt) +#define __RPC__inout_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__inout_xcount_full_opt_string, (size), __RPC__inout_opt _Pre_ _Null_terminated_ _Post_ _Null_terminated_) + +// [out] ** +#define __RPC__deref_out _SAL1_2_Source_(__RPC__deref_out, (), _Outptr_) +#define __RPC__deref_out_string _SAL1_2_Source_(__RPC__deref_out_string, (), _Outptr_result_z_) +#define __RPC__deref_out_opt _SAL1_2_Source_(__RPC__deref_out_opt, (), __RPC__deref_out) +#define __RPC__deref_out_opt_string _SAL1_2_Source_(__RPC__deref_out_opt_string, (), _Outptr_result_maybenull_z_ _At_(*_Curr_, _Pre_opt_z_)) +#define __RPC__deref_out_ecount(size) _SAL1_2_Source_(__RPC__deref_out_ecount, (size), _Outptr_result_buffer_(size)) +#define __RPC__deref_out_ecount_part(size, length) _SAL1_2_Source_(__RPC__deref_out_ecount_part, (size,length), _Outptr_result_buffer_to_(size, length)) +#define __RPC__deref_out_ecount_full(size) _SAL1_2_Source_(__RPC__deref_out_ecount_full, (size), __RPC__deref_out_ecount_part(size,size)) +#define __RPC__deref_out_ecount_full_string(size) _SAL1_2_Source_(__RPC__deref_out_ecount_full_string, (size), __RPC__deref_out_ecount_full(size) _At_(*_Curr_, _Post_ _Null_terminated_)) +#define __RPC__deref_out_xcount(size) _SAL1_2_Source_(__RPC__deref_out_xcount, (size), _Outptr_) +#define __RPC__deref_out_xcount_part(size, length) _SAL1_2_Source_(__RPC__deref_out_xcount_part, (size,length), __RPC__deref_out) +#define __RPC__deref_out_xcount_full(size) _SAL1_2_Source_(__RPC__deref_out_xcount_full, (size), __RPC__deref_out) +#define __RPC__deref_out_xcount_full_string(size) _SAL1_2_Source_(__RPC__deref_out_xcount_full_string, (size), __RPC__deref_out _At_(*_Curr_, _Post_ _Null_terminated_)) + +// [in,out] **, second pointer decoration. +#define __RPC__deref_inout _SAL1_2_Source_(__RPC__deref_inout, (), _Inout_ _At_(*_Curr_, _Pre_ _Notnull_ _Post_ _Notnull_)) +#define __RPC__deref_inout_string _SAL1_2_Source_(__RPC__deref_inout_string, (), __RPC__deref_inout _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_inout_opt _SAL1_2_Source_(__RPC__deref_inout_opt, (), _Inout_ _At_(*_Curr_, _Pre_ _Maybenull_ _Post_ _Maybenull_)) +#define __RPC__deref_inout_opt_string _SAL1_2_Source_(__RPC__deref_inout_opt_string, (), __RPC__deref_inout_opt _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_inout_ecount_opt(size) _SAL1_2_Source_(__RPC__deref_inout_ecount_opt, (size), __RPC__deref_inout_opt _At_(*_Curr_, _Pre_writable_size_(size) _Post_writable_size_(size))) +#define __RPC__deref_inout_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_inout_ecount_part_opt, (size,length), __RPC__deref_inout_ecount_opt(size) _At_(*_Curr_, _Pre_readable_size_(length) _Post_readable_size_(length))) +#define __RPC__deref_inout_ecount_full_opt(size) _SAL1_2_Source_(__RPC__deref_inout_ecount_full_opt, (size), __RPC__deref_inout_ecount_part_opt(size, size)) +#define __RPC__deref_inout_ecount_full(size) _SAL1_2_Source_(__RPC__deref_inout_ecount_full, (size), __RPC__deref_inout _At_(*_Curr_, _Pre_readable_size_(size) _Post_readable_size_(size))) +#define __RPC__deref_inout_ecount_full_string(size) _SAL1_2_Source_(__RPC__deref_inout_ecount_full_string, (size), __RPC__deref_inout_ecount_full(size) _At_(*_Curr_, _Post_ _Null_terminated_)) +#define __RPC__deref_inout_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_inout_ecount_full_opt_string, (size), __RPC__deref_inout_ecount_full_opt(size) _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_inout_xcount_opt(size) _SAL1_2_Source_(__RPC__deref_inout_xcount_opt, (size), __RPC__deref_inout_opt) +#define __RPC__deref_inout_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_inout_xcount_part_opt, (size,length), __RPC__deref_inout_opt) +#define __RPC__deref_inout_xcount_full_opt(size) _SAL1_2_Source_(__RPC__deref_inout_xcount_full_opt, (size), __RPC__deref_inout_opt) +#define __RPC__deref_inout_xcount_full(size) _SAL1_2_Source_(__RPC__deref_inout_xcount_full, (size), __RPC__deref_inout) +#define __RPC__deref_inout_xcount_full_string(size) _SAL1_2_Source_(__RPC__deref_inout_xcount_full_string, (size), __RPC__deref_inout _At_(*_Curr_, _Post_ _Null_terminated_)) +#define __RPC__deref_inout_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_inout_xcount_full_opt_string, (size), __RPC__deref_inout_opt _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) + + +// #define __RPC_out_opt out_opt is not allowed in rpc + +// [in,out,unique] +#define __RPC__deref_opt_inout _SAL1_2_Source_(__RPC__deref_opt_inout, (), _Inout_opt_ _At_(*_Curr_, _Pre_ _Notnull_ _Post_ _Notnull_)) +#define __RPC__deref_opt_inout_ecount(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount, (size), __RPC__deref_opt_inout _At_(*_Curr_, _Pre_writable_size_(size) _Post_writable_size_(size))) +#define __RPC__deref_opt_inout_string _SAL1_2_Source_(__RPC__deref_opt_inout_string, (), __RPC__deref_opt_inout _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_opt_inout_ecount_part(size, length) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_part, (size,length), __RPC__deref_opt_inout_ecount(size) _At_(*_Curr_, _Pre_readable_size_(length) _Post_readable_size_(length))) +#define __RPC__deref_opt_inout_ecount_full(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_full, (size), __RPC__deref_opt_inout_ecount_part(size, size)) +#define __RPC__deref_opt_inout_ecount_full_string(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_full_string, (size), __RPC__deref_opt_inout_ecount_full(size) _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_opt_inout_xcount_part(size, length) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_part, (size,length), __RPC__deref_opt_inout) +#define __RPC__deref_opt_inout_xcount_full(size) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_full, (size), __RPC__deref_opt_inout) +#define __RPC__deref_opt_inout_xcount_full_string(size) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_full_string, (size), __RPC__deref_opt_inout_string) + + +#define __RPC__deref_out_ecount_opt(size) _SAL1_2_Source_(__RPC__deref_out_ecount_opt, (size), _Outptr_result_buffer_maybenull_(size) _At_(*_Curr_, _Pre_maybenull_)) +#define __RPC__deref_out_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_out_ecount_part_opt, (size,length), _Outptr_result_buffer_to_maybenull_(size, length) _At_(*_Curr_, _Pre_maybenull_)) +#define __RPC__deref_out_ecount_full_opt(size) _SAL1_2_Source_(__RPC__deref_out_ecount_full_opt, (size), __RPC__deref_out_ecount_part_opt(size, size)) +#define __RPC__deref_out_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_out_ecount_full_opt_string, (size), __RPC__deref_out_ecount_part_opt(size, size) _At_(*_Curr_, _Post_ _Null_terminated_)) +#define __RPC__deref_out_xcount_opt(size) _SAL1_2_Source_(__RPC__deref_out_xcount_opt, (size), __RPC__out _At_(*_Curr_, _Pre_maybenull_ _Pre_writable_size_(_Inexpressible_(size)) _Post_ _Maybenull_)) +#define __RPC__deref_out_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_out_xcount_part_opt, (size,length), __RPC__deref_out _At_(*_Curr_, _Pre_maybenull_ _Pre_writable_size_(_Inexpressible_(size)) _Post_ _Maybenull_)) +#define __RPC__deref_out_xcount_full_opt(size) _SAL1_2_Source_(__RPC__deref_out_xcount_full_opt, (size), __RPC__deref_out_opt _At_(*_Curr_, _Pre_maybenull_ _Pre_writable_size_(_Inexpressible_(size)))) +#define __RPC__deref_out_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_out_xcount_full_opt_string, (size), __RPC__deref_out_opt _At_(*_Curr_, _Pre_maybenull_ _Pre_writable_size_(_Inexpressible_(size)) _Post_ _Null_terminated_)) + +#define __RPC__deref_opt_inout_opt _SAL1_2_Source_(__RPC__deref_opt_inout_opt, (), _Inout_opt_ _At_(*_Curr_, _Pre_ _Maybenull_ _Post_ _Maybenull_)) +#define __RPC__deref_opt_inout_opt_string _SAL1_2_Source_(__RPC__deref_opt_inout_opt_string, (), __RPC__deref_opt_inout_opt _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_opt_inout_ecount_opt(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_opt, (size), _Inout_opt_ _At_(*_Curr_, _Pre_ _Maybenull_ _Pre_writable_size_(size) _Post_ _Maybenull_ _Post_writable_size_(size))) +#define __RPC__deref_opt_inout_ecount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_part_opt, (size,length), __RPC__deref_opt_inout_ecount_opt(size) _At_(*_Curr_, _Pre_readable_size_(length) _Post_readable_size_(length))) +#define __RPC__deref_opt_inout_ecount_full_opt(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_full_opt, (size), __RPC__deref_opt_inout_ecount_part_opt(size, size)) +#define __RPC__deref_opt_inout_ecount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_opt_inout_ecount_full_opt_string, (size), __RPC__deref_opt_inout_ecount_full_opt(size) _At_(*_Curr_, _Pre_ _Null_terminated_ _Post_ _Null_terminated_)) +#define __RPC__deref_opt_inout_xcount_opt(size) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_opt, (size), __RPC__deref_opt_inout_opt) +#define __RPC__deref_opt_inout_xcount_part_opt(size, length) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_part_opt, (size,length), __RPC__deref_opt_inout_opt) +#define __RPC__deref_opt_inout_xcount_full_opt(size) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_full_opt, (size), __RPC__deref_opt_inout_opt) +#define __RPC__deref_opt_inout_xcount_full_opt_string(size) _SAL1_2_Source_(__RPC__deref_opt_inout_xcount_full_opt_string, (size), __RPC__deref_opt_inout_opt_string) + +#define __RPC_full_pointer _SAL1_2_Source_(__RPC_full_pointer, (), _Maybenull_) +#define __RPC_unique_pointer _SAL1_2_Source_(__RPC_unique_pointer, (), _Maybenull_) +#define __RPC_ref_pointer _SAL1_2_Source_(__RPC_ref_pointer, (), _Notnull_) +#define __RPC_string _SAL1_2_Source_(__RPC_string, (), _Null_terminated_) + +#define __RPC__range(min,max) _SAL1_2_Source_(__RPC__range, (min,max), __range(min,max)) +#define __RPC__in_range(min,max) _SAL1_2_Source_(__RPC__in_range, (min,max), _In_range_(min,max)) + + +#ifdef __cplusplus +} +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sal.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sal.h new file mode 100644 index 0000000000000000000000000000000000000000..23ff7c797e3dc53b50445e76016de2fa804a2f88 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sal.h @@ -0,0 +1,2977 @@ +#ifndef SAL_INCLUDED +#define SAL_INCLUDED 1 +/*** +*sal.h - markers for documenting the semantics of APIs +* +* Copyright (c) Microsoft Corporation. All rights reserved. +* +*Purpose: +* sal.h provides a set of annotations to describe how a function uses its +* parameters - the assumptions it makes about them, and the guarantees it makes +* upon finishing. +* +* [Public] +* +****/ +#pragma once + +/*========================================================================== + + The comments in this file are intended to give basic understanding of + the usage of SAL, the Microsoft Source Code Annotation Language. + For more details, please see https://go.microsoft.com/fwlink/?LinkID=242134 + + The macros are defined in 3 layers, plus the structural set: + + _In_/_Out_/_Ret_ Layer: + ---------------------- + This layer provides the highest abstraction and its macros should be used + in most cases. These macros typically start with: + _In_ : input parameter to a function, unmodified by called function + _Out_ : output parameter, written to by called function, pointed-to + location not expected to be initialized prior to call + _Outptr_ : like _Out_ when returned variable is a pointer type + (so param is pointer-to-pointer type). Called function + provides/allocated space. + _Outref_ : like _Outptr_, except param is reference-to-pointer type. + _Inout_ : inout parameter, read from and potentially modified by + called function. + _Ret_ : for return values + _Field_ : class/struct field invariants + For common usage, this class of SAL provides the most concise annotations. + Note that _In_/_Out_/_Inout_/_Outptr_ annotations are designed to be used + with a parameter target. Using them with _At_ to specify non-parameter + targets may yield unexpected results. + + This layer also includes a number of other properties that can be specified + to extend the ability of code analysis, most notably: + -- Designating parameters as format strings for printf/scanf/scanf_s + -- Requesting stricter type checking for C enum parameters + + _Pre_/_Post_ Layer: + ------------------ + The macros of this layer only should be used when there is no suitable macro + in the _In_/_Out_ layer. Its macros start with _Pre_ or _Post_. + This layer provides the most flexibility for annotations. + + Implementation Abstraction Layer: + -------------------------------- + Macros from this layer should never be used directly. The layer only exists + to hide the implementation of the annotation macros. + + Structural Layer: + ---------------- + These annotations, like _At_ and _When_, are used with annotations from + any of the other layers as modifiers, indicating exactly when and where + the annotations apply. + + + Common syntactic conventions: + ---------------------------- + + Usage: + ----- + _In_, _Out_, _Inout_, _Pre_, _Post_, are for formal parameters. + _Ret_, _Deref_ret_ must be used for return values. + + Nullness: + -------- + If the parameter can be NULL as a precondition to the function, the + annotation contains _opt. If the macro does not contain '_opt' the + parameter cannot be NULL. + + If an out/inout parameter returns a null pointer as a postcondition, this is + indicated by _Ret_maybenull_ or _result_maybenull_. If the macro is not + of this form, then the result will not be NULL as a postcondition. + _Outptr_ - output value is not NULL + _Outptr_result_maybenull_ - output value might be NULL + + String Type: + ----------- + _z: NullTerminated string + for _In_ parameters the buffer must have the specified stringtype before the call + for _Out_ parameters the buffer must have the specified stringtype after the call + for _Inout_ parameters both conditions apply + + Extent Syntax: + ------------- + Buffer sizes are expressed as element counts, unless the macro explicitly + contains _byte_ or _bytes_. Some annotations specify two buffer sizes, in + which case the second is used to indicate how much of the buffer is valid + as a postcondition. This table outlines the precondition buffer allocation + size, precondition number of valid elements, postcondition allocation size, + and postcondition number of valid elements for representative buffer size + annotations: + Pre | Pre | Post | Post + alloc | valid | alloc | valid + Annotation elems | elems | elems | elems + ---------- ------------------------------------ + _In_reads_(s) s | s | s | s + _Inout_updates_(s) s | s | s | s + _Inout_updates_to_(s,c) s | s | s | c + _Out_writes_(s) s | 0 | s | s + _Out_writes_to_(s,c) s | 0 | s | c + _Outptr_result_buffer_(s) ? | ? | s | s + _Outptr_result_buffer_to_(s,c) ? | ? | s | c + + For the _Outptr_ annotations, the buffer in question is at one level of + dereference. The called function is responsible for supplying the buffer. + + Success and failure: + ------------------- + The SAL concept of success allows functions to define expressions that can + be tested by the caller, which if it evaluates to non-zero, indicates the + function succeeded, which means that its postconditions are guaranteed to + hold. Otherwise, if the expression evaluates to zero, the function is + considered to have failed, and the postconditions are not guaranteed. + + The success criteria can be specified with the _Success_(expr) annotation: + _Success_(return != FALSE) BOOL + PathCanonicalizeA(_Out_writes_(MAX_PATH) LPSTR pszBuf, LPCSTR pszPath) : + pszBuf is only guaranteed to be NULL-terminated when TRUE is returned, + and FALSE indicates failure. In common practice, callers check for zero + vs. non-zero returns, so it is preferable to express the success + criteria in terms of zero/non-zero, not checked for exactly TRUE. + + Functions can specify that some postconditions will still hold, even when + the function fails, using _On_failure_(anno-list), or postconditions that + hold regardless of success or failure using _Always_(anno-list). + + The annotation _Return_type_success_(expr) may be used with a typedef to + give a default _Success_ criteria to all functions returning that type. + This is the case for common Windows API status types, including + HRESULT and NTSTATUS. This may be overridden on a per-function basis by + specifying a _Success_ annotation locally. + +============================================================================*/ + +#define __ATTR_SAL + +#ifndef _SAL_VERSION +#define _SAL_VERSION 20 +#endif + +#ifndef __SAL_H_VERSION +#define __SAL_H_VERSION 180000000 +#endif + +#ifdef _PREFAST_ // [ + +// choose attribute or __declspec implementation +#ifndef _USE_DECLSPECS_FOR_SAL // [ +#define _USE_DECLSPECS_FOR_SAL 1 +#endif // ] + +#if _USE_DECLSPECS_FOR_SAL // [ +#undef _USE_ATTRIBUTES_FOR_SAL +#define _USE_ATTRIBUTES_FOR_SAL 0 +#elif !defined(_USE_ATTRIBUTES_FOR_SAL) // ][ +#define _USE_ATTRIBUTES_FOR_SAL 1 +#endif // ] + + +#if !_USE_DECLSPECS_FOR_SAL // [ +#if !_USE_ATTRIBUTES_FOR_SAL // [ +#undef _USE_ATTRIBUTES_FOR_SAL +#define _USE_ATTRIBUTES_FOR_SAL 1 +#endif // ] +#endif // ] + +#else + +// Disable expansion of SAL macros in non-Prefast mode to +// improve compiler throughput. +#ifndef _USE_DECLSPECS_FOR_SAL // [ +#define _USE_DECLSPECS_FOR_SAL 0 +#endif // ] +#ifndef _USE_ATTRIBUTES_FOR_SAL // [ +#define _USE_ATTRIBUTES_FOR_SAL 0 +#endif // ] + +#endif // ] + +// safeguard for MIDL and RC builds +#if _USE_DECLSPECS_FOR_SAL && ( defined( MIDL_PASS ) || defined(__midl) || defined(RC_INVOKED) || !defined(_PREFAST_) ) // [ +#undef _USE_DECLSPECS_FOR_SAL +#define _USE_DECLSPECS_FOR_SAL 0 +#endif // ] +#if _USE_ATTRIBUTES_FOR_SAL && ( !defined(_MSC_EXTENSIONS) || defined( MIDL_PASS ) || defined(__midl) || defined(RC_INVOKED) ) // [ +#undef _USE_ATTRIBUTES_FOR_SAL +#define _USE_ATTRIBUTES_FOR_SAL 0 +#endif // ] + +#if _USE_DECLSPECS_FOR_SAL || _USE_ATTRIBUTES_FOR_SAL + +// Special enum type for Y/N/M +enum __SAL_YesNo {_SAL_notpresent, _SAL_no, _SAL_maybe, _SAL_yes, _SAL_default}; + +#endif + +#if defined(UNDOCKED_WINDOWS_UCRT) && !_USE_ATTRIBUTES_FOR_SAL +#define _SAL1_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1") _GrouP_(annotes _SAL_nop_impl_) +#define _SAL1_1_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1.1") _GrouP_(annotes _SAL_nop_impl_) +#define _SAL1_2_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1.2") _GrouP_(annotes _SAL_nop_impl_) +#define _SAL2_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _GrouP_(annotes _SAL_nop_impl_) + +#ifndef _SAL_L_Source_ +// Some annotations aren't officially SAL2 yet. +#define _SAL_L_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _GrouP_(annotes _SAL_nop_impl_) +#endif +#else +#define _SAL1_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1") _Group_(annotes _SAL_nop_impl_) +#define _SAL1_1_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1.1") _Group_(annotes _SAL_nop_impl_) +#define _SAL1_2_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "1.2") _Group_(annotes _SAL_nop_impl_) +#define _SAL2_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _Group_(annotes _SAL_nop_impl_) + +#ifndef _SAL_L_Source_ +// Some annotations aren't officially SAL2 yet. +#define _SAL_L_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _Group_(annotes _SAL_nop_impl_) +#endif +#endif + + +//============================================================================ +// Structural SAL: +// These annotations modify the use of other annotations. They may +// express the annotation target (i.e. what parameter/field the annotation +// applies to) or the condition under which the annotation is applicable. +//============================================================================ + +// _At_(target, annos) specifies that the annotations listed in 'annos' is to +// be applied to 'target' rather than to the identifier which is the current +// lexical target. +#define _At_(target, annos) _At_impl_(target, annos _SAL_nop_impl_) + +// _At_buffer_(target, iter, bound, annos) is similar to _At_, except that +// target names a buffer, and each annotation in annos is applied to each +// element of target up to bound, with the variable named in iter usable +// by the annotations to refer to relevant offsets within target. +#define _At_buffer_(target, iter, bound, annos) _At_buffer_impl_(target, iter, bound, annos _SAL_nop_impl_) + +// _When_(expr, annos) specifies that the annotations listed in 'annos' only +// apply when 'expr' evaluates to non-zero. +#define _When_(expr, annos) _When_impl_(expr, annos _SAL_nop_impl_) +#define _Group_(annos) _Group_impl_(annos _SAL_nop_impl_) +#define _GrouP_(annos) _GrouP_impl_(annos _SAL_nop_impl_) + +// indicates whether normal post conditions apply to a function +#define _Success_(expr) _SAL2_Source_(_Success_, (expr), _Success_impl_(expr)) + +// indicates whether post conditions apply to a function returning +// the type that this annotation is applied to +#define _Return_type_success_(expr) _SAL2_Source_(_Return_type_success_, (expr), _Success_impl_(expr)) + +// Establish postconditions that apply only if the function does not succeed +#define _On_failure_(annos) _On_failure_impl_(annos _SAL_nop_impl_) + +// Establish postconditions that apply in both success and failure cases. +// Only applicable with functions that have _Success_ or _Return_type_succss_. +#define _Always_(annos) _Always_impl_(annos _SAL_nop_impl_) + +// Usable on a function defintion. Asserts that a function declaration is +// in scope, and its annotations are to be used. There are no other annotations +// allowed on the function definition. +#define _Use_decl_annotations_ _Use_decl_anno_impl_ + +// _Notref_ may precede a _Deref_ or "real" annotation, and removes one +// level of dereference if the parameter is a C++ reference (&). If the +// net deref on a "real" annotation is negative, it is simply discarded. +#define _Notref_ _Notref_impl_ + +// Annotations for defensive programming styles. +#define _Pre_defensive_ _SA_annotes0(SAL_pre_defensive) +#define _Post_defensive_ _SA_annotes0(SAL_post_defensive) + +#define _In_defensive_(annotes) _Pre_defensive_ _Group_(annotes) +#define _Out_defensive_(annotes) _Post_defensive_ _Group_(annotes) +#define _Inout_defensive_(annotes) _Pre_defensive_ _Post_defensive_ _Group_(annotes) + +//============================================================================ +// _In_/_Out_ Layer: +//============================================================================ + +// Reserved pointer parameters, must always be NULL. +#define _Reserved_ _SAL2_Source_(_Reserved_, (), _Pre1_impl_(__null_impl)) + +// _Const_ allows specification that any namable memory location is considered +// readonly for a given call. +#define _Const_ _SAL2_Source_(_Const_, (), _Pre1_impl_(__readaccess_impl_notref)) + + +// Input parameters -------------------------- + +// _In_ - Annotations for parameters where data is passed into the function, but not modified. +// _In_ by itself can be used with non-pointer types (although it is redundant). + +// e.g. void SetPoint( _In_ const POINT* pPT ); +#define _In_ _SAL2_Source_(_In_, (), _Pre1_impl_(__notnull_impl_notref) _Pre_valid_impl_ _Deref_pre1_impl_(__readaccess_impl_notref)) +#define _In_opt_ _SAL2_Source_(_In_opt_, (), _Pre1_impl_(__maybenull_impl_notref) _Pre_valid_impl_ _Deref_pre_readonly_) + +// nullterminated 'in' parameters. +// e.g. void CopyStr( _In_z_ const char* szFrom, _Out_z_cap_(cchTo) char* szTo, size_t cchTo ); +#define _In_z_ _SAL2_Source_(_In_z_, (), _In_ _Pre1_impl_(__zterm_impl)) +#define _In_opt_z_ _SAL2_Source_(_In_opt_z_, (), _In_opt_ _Pre1_impl_(__zterm_impl)) + + +// 'input' buffers with given size + +#define _In_reads_(size) _SAL2_Source_(_In_reads_, (size), _Pre_count_(size) _Deref_pre_readonly_) +#define _In_reads_opt_(size) _SAL2_Source_(_In_reads_opt_, (size), _Pre_opt_count_(size) _Deref_pre_readonly_) +#define _In_reads_bytes_(size) _SAL2_Source_(_In_reads_bytes_, (size), _Pre_bytecount_(size) _Deref_pre_readonly_) +#define _In_reads_bytes_opt_(size) _SAL2_Source_(_In_reads_bytes_opt_, (size), _Pre_opt_bytecount_(size) _Deref_pre_readonly_) +#define _In_reads_z_(size) _SAL2_Source_(_In_reads_z_, (size), _In_reads_(size) _Pre_z_) +#define _In_reads_opt_z_(size) _SAL2_Source_(_In_reads_opt_z_, (size), _Pre_opt_count_(size) _Deref_pre_readonly_ _Pre_opt_z_) +#define _In_reads_or_z_(size) _SAL2_Source_(_In_reads_or_z_, (size), _In_ _When_(_String_length_(_Curr_) < (size), _Pre_z_) _When_(_String_length_(_Curr_) >= (size), _Pre1_impl_(__count_impl(size)))) +#define _In_reads_or_z_opt_(size) _SAL2_Source_(_In_reads_or_z_opt_, (size), _In_opt_ _When_(_String_length_(_Curr_) < (size), _Pre_z_) _When_(_String_length_(_Curr_) >= (size), _Pre1_impl_(__count_impl(size)))) + + +// 'input' buffers valid to the given end pointer + +#define _In_reads_to_ptr_(ptr) _SAL2_Source_(_In_reads_to_ptr_, (ptr), _Pre_ptrdiff_count_(ptr) _Deref_pre_readonly_) +#define _In_reads_to_ptr_opt_(ptr) _SAL2_Source_(_In_reads_to_ptr_opt_, (ptr), _Pre_opt_ptrdiff_count_(ptr) _Deref_pre_readonly_) +#define _In_reads_to_ptr_z_(ptr) _SAL2_Source_(_In_reads_to_ptr_z_, (ptr), _In_reads_to_ptr_(ptr) _Pre_z_) +#define _In_reads_to_ptr_opt_z_(ptr) _SAL2_Source_(_In_reads_to_ptr_opt_z_, (ptr), _Pre_opt_ptrdiff_count_(ptr) _Deref_pre_readonly_ _Pre_opt_z_) + + + +// Output parameters -------------------------- + +// _Out_ - Annotations for pointer or reference parameters where data passed back to the caller. +// These are mostly used where the pointer/reference is to a non-pointer type. +// _Outptr_/_Outref) (see below) are typically used to return pointers via parameters. + +// e.g. void GetPoint( _Out_ POINT* pPT ); +#define _Out_ _SAL2_Source_(_Out_, (), _Out_impl_) +#define _Out_opt_ _SAL2_Source_(_Out_opt_, (), _Out_opt_impl_) + +#define _Out_writes_(size) _SAL2_Source_(_Out_writes_, (size), _Pre_cap_(size) _Post_valid_impl_) +#define _Out_writes_opt_(size) _SAL2_Source_(_Out_writes_opt_, (size), _Pre_opt_cap_(size) _Post_valid_impl_) +#define _Out_writes_bytes_(size) _SAL2_Source_(_Out_writes_bytes_, (size), _Pre_bytecap_(size) _Post_valid_impl_) +#define _Out_writes_bytes_opt_(size) _SAL2_Source_(_Out_writes_bytes_opt_, (size), _Pre_opt_bytecap_(size) _Post_valid_impl_) +#define _Out_writes_z_(size) _SAL2_Source_(_Out_writes_z_, (size), _Pre_cap_(size) _Post_valid_impl_ _Post_z_) +#define _Out_writes_opt_z_(size) _SAL2_Source_(_Out_writes_opt_z_, (size), _Pre_opt_cap_(size) _Post_valid_impl_ _Post_z_) + +#define _Out_writes_to_(size,count) _SAL2_Source_(_Out_writes_to_, (size,count), _Pre_cap_(size) _Post_valid_impl_ _Post_count_(count)) +#define _Out_writes_to_opt_(size,count) _SAL2_Source_(_Out_writes_to_opt_, (size,count), _Pre_opt_cap_(size) _Post_valid_impl_ _Post_count_(count)) +#define _Out_writes_all_(size) _SAL2_Source_(_Out_writes_all_, (size), _Out_writes_to_(_Old_(size), _Old_(size))) +#define _Out_writes_all_opt_(size) _SAL2_Source_(_Out_writes_all_opt_, (size), _Out_writes_to_opt_(_Old_(size), _Old_(size))) + +#define _Out_writes_bytes_to_(size,count) _SAL2_Source_(_Out_writes_bytes_to_, (size,count), _Pre_bytecap_(size) _Post_valid_impl_ _Post_bytecount_(count)) +#define _Out_writes_bytes_to_opt_(size,count) _SAL2_Source_(_Out_writes_bytes_to_opt_, (size,count), _Pre_opt_bytecap_(size) _Post_valid_impl_ _Post_bytecount_(count)) +#define _Out_writes_bytes_all_(size) _SAL2_Source_(_Out_writes_bytes_all_, (size), _Out_writes_bytes_to_(_Old_(size), _Old_(size))) +#define _Out_writes_bytes_all_opt_(size) _SAL2_Source_(_Out_writes_bytes_all_opt_, (size), _Out_writes_bytes_to_opt_(_Old_(size), _Old_(size))) + +#define _Out_writes_to_ptr_(ptr) _SAL2_Source_(_Out_writes_to_ptr_, (ptr), _Pre_ptrdiff_cap_(ptr) _Post_valid_impl_) +#define _Out_writes_to_ptr_opt_(ptr) _SAL2_Source_(_Out_writes_to_ptr_opt_, (ptr), _Pre_opt_ptrdiff_cap_(ptr) _Post_valid_impl_) +#define _Out_writes_to_ptr_z_(ptr) _SAL2_Source_(_Out_writes_to_ptr_z_, (ptr), _Pre_ptrdiff_cap_(ptr) _Post_valid_impl_ Post_z_) +#define _Out_writes_to_ptr_opt_z_(ptr) _SAL2_Source_(_Out_writes_to_ptr_opt_z_, (ptr), _Pre_opt_ptrdiff_cap_(ptr) _Post_valid_impl_ Post_z_) + + +// Inout parameters ---------------------------- + +// _Inout_ - Annotations for pointer or reference parameters where data is passed in and +// potentially modified. +// void ModifyPoint( _Inout_ POINT* pPT ); +// void ModifyPointByRef( _Inout_ POINT& pPT ); + +#define _Inout_ _SAL2_Source_(_Inout_, (), _Prepost_valid_) +#define _Inout_opt_ _SAL2_Source_(_Inout_opt_, (), _Prepost_opt_valid_) + +// For modifying string buffers +// void toupper( _Inout_z_ char* sz ); +#define _Inout_z_ _SAL2_Source_(_Inout_z_, (), _Prepost_z_) +#define _Inout_opt_z_ _SAL2_Source_(_Inout_opt_z_, (), _Prepost_opt_z_) + +// For modifying buffers with explicit element size +#define _Inout_updates_(size) _SAL2_Source_(_Inout_updates_, (size), _Pre_cap_(size) _Pre_valid_impl_ _Post_valid_impl_) +#define _Inout_updates_opt_(size) _SAL2_Source_(_Inout_updates_opt_, (size), _Pre_opt_cap_(size) _Pre_valid_impl_ _Post_valid_impl_) +#define _Inout_updates_z_(size) _SAL2_Source_(_Inout_updates_z_, (size), _Pre_cap_(size) _Pre_valid_impl_ _Post_valid_impl_ _Pre1_impl_(__zterm_impl) _Post1_impl_(__zterm_impl)) +#define _Inout_updates_opt_z_(size) _SAL2_Source_(_Inout_updates_opt_z_, (size), _Pre_opt_cap_(size) _Pre_valid_impl_ _Post_valid_impl_ _Pre1_impl_(__zterm_impl) _Post1_impl_(__zterm_impl)) + +#define _Inout_updates_to_(size,count) _SAL2_Source_(_Inout_updates_to_, (size,count), _Out_writes_to_(size,count) _Pre_valid_impl_ _Pre1_impl_(__count_impl(size))) +#define _Inout_updates_to_opt_(size,count) _SAL2_Source_(_Inout_updates_to_opt_, (size,count), _Out_writes_to_opt_(size,count) _Pre_valid_impl_ _Pre1_impl_(__count_impl(size))) + +#define _Inout_updates_all_(size) _SAL2_Source_(_Inout_updates_all_, (size), _Inout_updates_to_(_Old_(size), _Old_(size))) +#define _Inout_updates_all_opt_(size) _SAL2_Source_(_Inout_updates_all_opt_, (size), _Inout_updates_to_opt_(_Old_(size), _Old_(size))) + +// For modifying buffers with explicit byte size +#define _Inout_updates_bytes_(size) _SAL2_Source_(_Inout_updates_bytes_, (size), _Pre_bytecap_(size) _Pre_valid_impl_ _Post_valid_impl_) +#define _Inout_updates_bytes_opt_(size) _SAL2_Source_(_Inout_updates_bytes_opt_, (size), _Pre_opt_bytecap_(size) _Pre_valid_impl_ _Post_valid_impl_) + +#define _Inout_updates_bytes_to_(size,count) _SAL2_Source_(_Inout_updates_bytes_to_, (size,count), _Out_writes_bytes_to_(size,count) _Pre_valid_impl_ _Pre1_impl_(__bytecount_impl(size))) +#define _Inout_updates_bytes_to_opt_(size,count) _SAL2_Source_(_Inout_updates_bytes_to_opt_, (size,count), _Out_writes_bytes_to_opt_(size,count) _Pre_valid_impl_ _Pre1_impl_(__bytecount_impl(size))) + +#define _Inout_updates_bytes_all_(size) _SAL2_Source_(_Inout_updates_bytes_all_, (size), _Inout_updates_bytes_to_(_Old_(size), _Old_(size))) +#define _Inout_updates_bytes_all_opt_(size) _SAL2_Source_(_Inout_updates_bytes_all_opt_, (size), _Inout_updates_bytes_to_opt_(_Old_(size), _Old_(size))) + + +// Pointer to pointer parameters ------------------------- + +// _Outptr_ - Annotations for output params returning pointers +// These describe parameters where the called function provides the buffer: +// HRESULT SHStrDupW(_In_ LPCWSTR psz, _Outptr_ LPWSTR *ppwsz); +// The caller passes the address of an LPWSTR variable as ppwsz, and SHStrDupW allocates +// and initializes memory and returns the pointer to the new LPWSTR in *ppwsz. +// +// _Outptr_opt_ - describes parameters that are allowed to be NULL. +// _Outptr_*_result_maybenull_ - describes parameters where the called function might return NULL to the caller. +// +// Example: +// void MyFunc(_Outptr_opt_ int **ppData1, _Outptr_result_maybenull_ int **ppData2); +// Callers: +// MyFunc(NULL, NULL); // error: parameter 2, ppData2, should not be NULL +// MyFunc(&pData1, &pData2); // ok: both non-NULL +// if (*pData1 == *pData2) ... // error: pData2 might be NULL after call + +#define _Outptr_ _SAL2_Source_(_Outptr_, (), _Out_impl_ _Deref_post2_impl_(__notnull_impl_notref, __count_impl(1))) +#define _Outptr_result_maybenull_ _SAL2_Source_(_Outptr_result_maybenull_, (), _Out_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __count_impl(1))) +#define _Outptr_opt_ _SAL2_Source_(_Outptr_opt_, (), _Out_opt_impl_ _Deref_post2_impl_(__notnull_impl_notref, __count_impl(1))) +#define _Outptr_opt_result_maybenull_ _SAL2_Source_(_Outptr_opt_result_maybenull_, (), _Out_opt_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __count_impl(1))) + +// Annotations for _Outptr_ parameters returning pointers to null terminated strings. + +#define _Outptr_result_z_ _SAL2_Source_(_Outptr_result_z_, (), _Out_impl_ _Deref_post_z_) +#define _Outptr_opt_result_z_ _SAL2_Source_(_Outptr_opt_result_z_, (), _Out_opt_impl_ _Deref_post_z_) +#define _Outptr_result_maybenull_z_ _SAL2_Source_(_Outptr_result_maybenull_z_, (), _Out_impl_ _Deref_post_opt_z_) +#define _Outptr_opt_result_maybenull_z_ _SAL2_Source_(_Outptr_opt_result_maybenull_z_, (), _Out_opt_impl_ _Deref_post_opt_z_) + +// Annotations for _Outptr_ parameters where the output pointer is set to NULL if the function fails. + +#define _Outptr_result_nullonfailure_ _SAL2_Source_(_Outptr_result_nullonfailure_, (), _Outptr_ _On_failure_(_Deref_post_null_)) +#define _Outptr_opt_result_nullonfailure_ _SAL2_Source_(_Outptr_opt_result_nullonfailure_, (), _Outptr_opt_ _On_failure_(_Deref_post_null_)) + +// Annotations for _Outptr_ parameters which return a pointer to a ref-counted COM object, +// following the COM convention of setting the output to NULL on failure. +// The current implementation is identical to _Outptr_result_nullonfailure_. +// For pointers to types that are not COM objects, _Outptr_result_nullonfailure_ is preferred. + +#define _COM_Outptr_ _SAL2_Source_(_COM_Outptr_, (), _Outptr_ _On_failure_(_Deref_post_null_)) +#define _COM_Outptr_result_maybenull_ _SAL2_Source_(_COM_Outptr_result_maybenull_, (), _Outptr_result_maybenull_ _On_failure_(_Deref_post_null_)) +#define _COM_Outptr_opt_ _SAL2_Source_(_COM_Outptr_opt_, (), _Outptr_opt_ _On_failure_(_Deref_post_null_)) +#define _COM_Outptr_opt_result_maybenull_ _SAL2_Source_(_COM_Outptr_opt_result_maybenull_, (), _Outptr_opt_result_maybenull_ _On_failure_(_Deref_post_null_)) + +// Annotations for _Outptr_ parameters returning a pointer to buffer with a specified number of elements/bytes + +#define _Outptr_result_buffer_(size) _SAL2_Source_(_Outptr_result_buffer_, (size), _Out_impl_ _Deref_post2_impl_(__notnull_impl_notref, __cap_impl(size))) +#define _Outptr_opt_result_buffer_(size) _SAL2_Source_(_Outptr_opt_result_buffer_, (size), _Out_opt_impl_ _Deref_post2_impl_(__notnull_impl_notref, __cap_impl(size))) +#define _Outptr_result_buffer_to_(size, count) _SAL2_Source_(_Outptr_result_buffer_to_, (size, count), _Out_impl_ _Deref_post3_impl_(__notnull_impl_notref, __cap_impl(size), __count_impl(count))) +#define _Outptr_opt_result_buffer_to_(size, count) _SAL2_Source_(_Outptr_opt_result_buffer_to_, (size, count), _Out_opt_impl_ _Deref_post3_impl_(__notnull_impl_notref, __cap_impl(size), __count_impl(count))) + +#define _Outptr_result_buffer_all_(size) _SAL2_Source_(_Outptr_result_buffer_all_, (size), _Out_impl_ _Deref_post2_impl_(__notnull_impl_notref, __count_impl(size))) +#define _Outptr_opt_result_buffer_all_(size) _SAL2_Source_(_Outptr_opt_result_buffer_all_, (size), _Out_opt_impl_ _Deref_post2_impl_(__notnull_impl_notref, __count_impl(size))) + +#define _Outptr_result_buffer_maybenull_(size) _SAL2_Source_(_Outptr_result_buffer_maybenull_, (size), _Out_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __cap_impl(size))) +#define _Outptr_opt_result_buffer_maybenull_(size) _SAL2_Source_(_Outptr_opt_result_buffer_maybenull_, (size), _Out_opt_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __cap_impl(size))) +#define _Outptr_result_buffer_to_maybenull_(size, count) _SAL2_Source_(_Outptr_result_buffer_to_maybenull_, (size, count), _Out_impl_ _Deref_post3_impl_(__maybenull_impl_notref, __cap_impl(size), __count_impl(count))) +#define _Outptr_opt_result_buffer_to_maybenull_(size, count) _SAL2_Source_(_Outptr_opt_result_buffer_to_maybenull_, (size, count), _Out_opt_impl_ _Deref_post3_impl_(__maybenull_impl_notref, __cap_impl(size), __count_impl(count))) + +#define _Outptr_result_buffer_all_maybenull_(size) _SAL2_Source_(_Outptr_result_buffer_all_maybenull_, (size), _Out_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __count_impl(size))) +#define _Outptr_opt_result_buffer_all_maybenull_(size) _SAL2_Source_(_Outptr_opt_result_buffer_all_maybenull_, (size), _Out_opt_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __count_impl(size))) + +#define _Outptr_result_bytebuffer_(size) _SAL2_Source_(_Outptr_result_bytebuffer_, (size), _Out_impl_ _Deref_post2_impl_(__notnull_impl_notref, __bytecap_impl(size))) +#define _Outptr_opt_result_bytebuffer_(size) _SAL2_Source_(_Outptr_opt_result_bytebuffer_, (size), _Out_opt_impl_ _Deref_post2_impl_(__notnull_impl_notref, __bytecap_impl(size))) +#define _Outptr_result_bytebuffer_to_(size, count) _SAL2_Source_(_Outptr_result_bytebuffer_to_, (size, count), _Out_impl_ _Deref_post3_impl_(__notnull_impl_notref, __bytecap_impl(size), __bytecount_impl(count))) +#define _Outptr_opt_result_bytebuffer_to_(size, count) _SAL2_Source_(_Outptr_opt_result_bytebuffer_to_, (size, count), _Out_opt_impl_ _Deref_post3_impl_(__notnull_impl_notref, __bytecap_impl(size), __bytecount_impl(count))) + +#define _Outptr_result_bytebuffer_all_(size) _SAL2_Source_(_Outptr_result_bytebuffer_all_, (size), _Out_impl_ _Deref_post2_impl_(__notnull_impl_notref, __bytecount_impl(size))) +#define _Outptr_opt_result_bytebuffer_all_(size) _SAL2_Source_(_Outptr_opt_result_bytebuffer_all_, (size), _Out_opt_impl_ _Deref_post2_impl_(__notnull_impl_notref, __bytecount_impl(size))) + +#define _Outptr_result_bytebuffer_maybenull_(size) _SAL2_Source_(_Outptr_result_bytebuffer_maybenull_, (size), _Out_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __bytecap_impl(size))) +#define _Outptr_opt_result_bytebuffer_maybenull_(size) _SAL2_Source_(_Outptr_opt_result_bytebuffer_maybenull_, (size), _Out_opt_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __bytecap_impl(size))) +#define _Outptr_result_bytebuffer_to_maybenull_(size, count) _SAL2_Source_(_Outptr_result_bytebuffer_to_maybenull_, (size, count), _Out_impl_ _Deref_post3_impl_(__maybenull_impl_notref, __bytecap_impl(size), __bytecount_impl(count))) +#define _Outptr_opt_result_bytebuffer_to_maybenull_(size, count) _SAL2_Source_(_Outptr_opt_result_bytebuffer_to_maybenull_, (size, count), _Out_opt_impl_ _Deref_post3_impl_(__maybenull_impl_notref, __bytecap_impl(size), __bytecount_impl(count))) + +#define _Outptr_result_bytebuffer_all_maybenull_(size) _SAL2_Source_(_Outptr_result_bytebuffer_all_maybenull_, (size), _Out_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __bytecount_impl(size))) +#define _Outptr_opt_result_bytebuffer_all_maybenull_(size) _SAL2_Source_(_Outptr_opt_result_bytebuffer_all_maybenull_, (size), _Out_opt_impl_ _Deref_post2_impl_(__maybenull_impl_notref, __bytecount_impl(size))) + +// Annotations for output reference to pointer parameters. + +#define _Outref_ _SAL2_Source_(_Outref_, (), _Out_impl_ _Post_notnull_) +#define _Outref_result_maybenull_ _SAL2_Source_(_Outref_result_maybenull_, (), _Pre2_impl_(__notnull_impl_notref, __cap_c_one_notref_impl) _Post_maybenull_ _Post_valid_impl_) + +#define _Outref_result_buffer_(size) _SAL2_Source_(_Outref_result_buffer_, (size), _Outref_ _Post1_impl_(__cap_impl(size))) +#define _Outref_result_bytebuffer_(size) _SAL2_Source_(_Outref_result_bytebuffer_, (size), _Outref_ _Post1_impl_(__bytecap_impl(size))) +#define _Outref_result_buffer_to_(size, count) _SAL2_Source_(_Outref_result_buffer_to_, (size, count), _Outref_result_buffer_(size) _Post1_impl_(__count_impl(count))) +#define _Outref_result_bytebuffer_to_(size, count) _SAL2_Source_(_Outref_result_bytebuffer_to_, (size, count), _Outref_result_bytebuffer_(size) _Post1_impl_(__bytecount_impl(count))) +#define _Outref_result_buffer_all_(size) _SAL2_Source_(_Outref_result_buffer_all_, (size), _Outref_result_buffer_to_(size, _Old_(size))) +#define _Outref_result_bytebuffer_all_(size) _SAL2_Source_(_Outref_result_bytebuffer_all_, (size), _Outref_result_bytebuffer_to_(size, _Old_(size))) + +#define _Outref_result_buffer_maybenull_(size) _SAL2_Source_(_Outref_result_buffer_maybenull_, (size), _Outref_result_maybenull_ _Post1_impl_(__cap_impl(size))) +#define _Outref_result_bytebuffer_maybenull_(size) _SAL2_Source_(_Outref_result_bytebuffer_maybenull_, (size), _Outref_result_maybenull_ _Post1_impl_(__bytecap_impl(size))) +#define _Outref_result_buffer_to_maybenull_(size, count) _SAL2_Source_(_Outref_result_buffer_to_maybenull_, (size, count), _Outref_result_buffer_maybenull_(size) _Post1_impl_(__count_impl(count))) +#define _Outref_result_bytebuffer_to_maybenull_(size, count) _SAL2_Source_(_Outref_result_bytebuffer_to_maybenull_, (size, count), _Outref_result_bytebuffer_maybenull_(size) _Post1_impl_(__bytecount_impl(count))) +#define _Outref_result_buffer_all_maybenull_(size) _SAL2_Source_(_Outref_result_buffer_all_maybenull_, (size), _Outref_result_buffer_to_maybenull_(size, _Old_(size))) +#define _Outref_result_bytebuffer_all_maybenull_(size) _SAL2_Source_(_Outref_result_bytebuffer_all_maybenull_, (size), _Outref_result_bytebuffer_to_maybenull_(size, _Old_(size))) + +// Annotations for output reference to pointer parameters that guarantee +// that the pointer is set to NULL on failure. +#define _Outref_result_nullonfailure_ _SAL2_Source_(_Outref_result_nullonfailure_, (), _Outref_ _On_failure_(_Post_null_)) + +// Generic annotations to set output value of a by-pointer or by-reference parameter to null/zero on failure. +#define _Result_nullonfailure_ _SAL2_Source_(_Result_nullonfailure_, (), _On_failure_(_Notref_impl_ _Deref_impl_ _Post_null_)) +#define _Result_zeroonfailure_ _SAL2_Source_(_Result_zeroonfailure_, (), _On_failure_(_Notref_impl_ _Deref_impl_ _Out_range_(==, 0))) + + +// return values ------------------------------- + +// +// _Ret_ annotations +// +// describing conditions that hold for return values after the call + +// e.g. _Ret_z_ CString::operator const wchar_t*() const noexcept; +#define _Ret_z_ _SAL2_Source_(_Ret_z_, (), _Ret2_impl_(__notnull_impl, __zterm_impl) _Ret_valid_impl_) +#define _Ret_maybenull_z_ _SAL2_Source_(_Ret_maybenull_z_, (), _Ret2_impl_(__maybenull_impl,__zterm_impl) _Ret_valid_impl_) + +// used with allocated but not yet initialized objects +#define _Ret_notnull_ _SAL2_Source_(_Ret_notnull_, (), _Ret1_impl_(__notnull_impl)) +#define _Ret_maybenull_ _SAL2_Source_(_Ret_maybenull_, (), _Ret1_impl_(__maybenull_impl)) +#define _Ret_null_ _SAL2_Source_(_Ret_null_, (), _Ret1_impl_(__null_impl)) + +// used with allocated and initialized objects +// returns single valid object +#define _Ret_valid_ _SAL2_Source_(_Ret_valid_, (), _Ret1_impl_(__notnull_impl_notref) _Ret_valid_impl_) + +// returns pointer to initialized buffer of specified size +#define _Ret_writes_(size) _SAL2_Source_(_Ret_writes_, (size), _Ret2_impl_(__notnull_impl, __count_impl(size)) _Ret_valid_impl_) +#define _Ret_writes_z_(size) _SAL2_Source_(_Ret_writes_z_, (size), _Ret3_impl_(__notnull_impl, __count_impl(size), __zterm_impl) _Ret_valid_impl_) +#define _Ret_writes_bytes_(size) _SAL2_Source_(_Ret_writes_bytes_, (size), _Ret2_impl_(__notnull_impl, __bytecount_impl(size)) _Ret_valid_impl_) +#define _Ret_writes_maybenull_(size) _SAL2_Source_(_Ret_writes_maybenull_, (size), _Ret2_impl_(__maybenull_impl,__count_impl(size)) _Ret_valid_impl_) +#define _Ret_writes_maybenull_z_(size) _SAL2_Source_(_Ret_writes_maybenull_z_, (size), _Ret3_impl_(__maybenull_impl,__count_impl(size),__zterm_impl) _Ret_valid_impl_) +#define _Ret_writes_bytes_maybenull_(size) _SAL2_Source_(_Ret_writes_bytes_maybenull_, (size), _Ret2_impl_(__maybenull_impl,__bytecount_impl(size)) _Ret_valid_impl_) + +// returns pointer to partially initialized buffer, with total size 'size' and initialized size 'count' +#define _Ret_writes_to_(size,count) _SAL2_Source_(_Ret_writes_to_, (size,count), _Ret3_impl_(__notnull_impl, __cap_impl(size), __count_impl(count)) _Ret_valid_impl_) +#define _Ret_writes_bytes_to_(size,count) _SAL2_Source_(_Ret_writes_bytes_to_, (size,count), _Ret3_impl_(__notnull_impl, __bytecap_impl(size), __bytecount_impl(count)) _Ret_valid_impl_) +#define _Ret_writes_to_maybenull_(size,count) _SAL2_Source_(_Ret_writes_to_maybenull_, (size,count), _Ret3_impl_(__maybenull_impl, __cap_impl(size), __count_impl(count)) _Ret_valid_impl_) +#define _Ret_writes_bytes_to_maybenull_(size,count) _SAL2_Source_(_Ret_writes_bytes_to_maybenull_, (size,count), _Ret3_impl_(__maybenull_impl, __bytecap_impl(size), __bytecount_impl(count)) _Ret_valid_impl_) + + +// Annotations for strict type checking +#define _Points_to_data_ _SAL2_Source_(_Points_to_data_, (), _Pre_ _Points_to_data_impl_) +#define _Literal_ _SAL2_Source_(_Literal_, (), _Pre_ _Literal_impl_) +#define _Notliteral_ _SAL2_Source_(_Notliteral_, (), _Pre_ _Notliteral_impl_) + +// Check the return value of a function e.g. _Check_return_ ErrorCode Foo(); +#define _Check_return_ _SAL2_Source_(_Check_return_, (), _Check_return_impl_) +#define _Must_inspect_result_ _SAL2_Source_(_Must_inspect_result_, (), _Must_inspect_impl_ _Check_return_impl_) + +// e.g. MyPrintF( _Printf_format_string_ const wchar_t* wzFormat, ... ); +#define _Printf_format_string_ _SAL2_Source_(_Printf_format_string_, (), _Printf_format_string_impl_) +#define _Scanf_format_string_ _SAL2_Source_(_Scanf_format_string_, (), _Scanf_format_string_impl_) +#define _Scanf_s_format_string_ _SAL2_Source_(_Scanf_s_format_string_, (), _Scanf_s_format_string_impl_) + +#define _Format_string_impl_(kind,where) _SA_annotes2(SAL_IsFormatString2, kind, where) +#define _Printf_format_string_params_(x) _SAL2_Source_(_Printf_format_string_params_, (x), _Format_string_impl_("printf", x)) +#define _Scanf_format_string_params_(x) _SAL2_Source_(_Scanf_format_string_params_, (x), _Format_string_impl_("scanf", x)) +#define _Scanf_s_format_string_params_(x) _SAL2_Source_(_Scanf_s_format_string_params_, (x), _Format_string_impl_("scanf_s", x)) + +// annotations to express value of integral or pointer parameter +#define _In_range_(lb,ub) _SAL2_Source_(_In_range_, (lb,ub), _In_range_impl_(lb,ub)) +#define _Out_range_(lb,ub) _SAL2_Source_(_Out_range_, (lb,ub), _Out_range_impl_(lb,ub)) +#define _Ret_range_(lb,ub) _SAL2_Source_(_Ret_range_, (lb,ub), _Ret_range_impl_(lb,ub)) +#define _Deref_in_range_(lb,ub) _SAL2_Source_(_Deref_in_range_, (lb,ub), _Deref_in_range_impl_(lb,ub)) +#define _Deref_out_range_(lb,ub) _SAL2_Source_(_Deref_out_range_, (lb,ub), _Deref_out_range_impl_(lb,ub)) +#define _Deref_ret_range_(lb,ub) _SAL2_Source_(_Deref_ret_range_, (lb,ub), _Deref_ret_range_impl_(lb,ub)) +#define _Pre_equal_to_(expr) _SAL2_Source_(_Pre_equal_to_, (expr), _In_range_(==, expr)) +#define _Post_equal_to_(expr) _SAL2_Source_(_Post_equal_to_, (expr), _Out_range_(==, expr)) + +// annotation to express that a value (usually a field of a mutable class) +// is not changed by a function call +#define _Unchanged_(e) _SAL2_Source_(_Unchanged_, (e), _At_(e, _Post_equal_to_(_Old_(e)) _Const_)) + +// Annotations to allow expressing generalized pre and post conditions. +// 'cond' may be any valid SAL expression that is considered to be true as a precondition +// or postcondition (respectively). +#define _Pre_satisfies_(cond) _SAL2_Source_(_Pre_satisfies_, (cond), _Pre_satisfies_impl_(cond)) +#define _Post_satisfies_(cond) _SAL2_Source_(_Post_satisfies_, (cond), _Post_satisfies_impl_(cond)) + +// Annotations to express struct, class and field invariants +#define _Struct_size_bytes_(size) _SAL2_Source_(_Struct_size_bytes_, (size), _Writable_bytes_(size)) + +#define _Field_size_(size) _SAL2_Source_(_Field_size_, (size), _Notnull_ _Writable_elements_(size)) +#define _Field_size_opt_(size) _SAL2_Source_(_Field_size_opt_, (size), _Maybenull_ _Writable_elements_(size)) +#define _Field_size_part_(size, count) _SAL2_Source_(_Field_size_part_, (size, count), _Notnull_ _Writable_elements_(size) _Readable_elements_(count)) +#define _Field_size_part_opt_(size, count) _SAL2_Source_(_Field_size_part_opt_, (size, count), _Maybenull_ _Writable_elements_(size) _Readable_elements_(count)) +#define _Field_size_full_(size) _SAL2_Source_(_Field_size_full_, (size), _Field_size_part_(size, size)) +#define _Field_size_full_opt_(size) _SAL2_Source_(_Field_size_full_opt_, (size), _Field_size_part_opt_(size, size)) + +#define _Field_size_bytes_(size) _SAL2_Source_(_Field_size_bytes_, (size), _Notnull_ _Writable_bytes_(size)) +#define _Field_size_bytes_opt_(size) _SAL2_Source_(_Field_size_bytes_opt_, (size), _Maybenull_ _Writable_bytes_(size)) +#define _Field_size_bytes_part_(size, count) _SAL2_Source_(_Field_size_bytes_part_, (size, count), _Notnull_ _Writable_bytes_(size) _Readable_bytes_(count)) +#define _Field_size_bytes_part_opt_(size, count) _SAL2_Source_(_Field_size_bytes_part_opt_, (size, count), _Maybenull_ _Writable_bytes_(size) _Readable_bytes_(count)) +#define _Field_size_bytes_full_(size) _SAL2_Source_(_Field_size_bytes_full_, (size), _Field_size_bytes_part_(size, size)) +#define _Field_size_bytes_full_opt_(size) _SAL2_Source_(_Field_size_bytes_full_opt_, (size), _Field_size_bytes_part_opt_(size, size)) + +#define _Field_z_ _SAL2_Source_(_Field_z_, (), _Null_terminated_) + +#define _Field_range_(min,max) _SAL2_Source_(_Field_range_, (min,max), _Field_range_impl_(min,max)) + +//============================================================================ +// _Pre_/_Post_ Layer: +//============================================================================ + +// +// Raw Pre/Post for declaring custom pre/post conditions +// + +#define _Pre_ _Pre_impl_ +#define _Post_ _Post_impl_ + +// +// Validity property +// + +#define _Valid_ _Valid_impl_ +#define _Notvalid_ _Notvalid_impl_ +#define _Maybevalid_ _Maybevalid_impl_ + +// +// Buffer size properties +// + +// Expressing buffer sizes without specifying pre or post condition +#define _Readable_bytes_(size) _SAL2_Source_(_Readable_bytes_, (size), _Readable_bytes_impl_(size)) +#define _Readable_elements_(size) _SAL2_Source_(_Readable_elements_, (size), _Readable_elements_impl_(size)) +#define _Writable_bytes_(size) _SAL2_Source_(_Writable_bytes_, (size), _Writable_bytes_impl_(size)) +#define _Writable_elements_(size) _SAL2_Source_(_Writable_elements_, (size), _Writable_elements_impl_(size)) + +#define _Null_terminated_ _SAL2_Source_(_Null_terminated_, (), _Null_terminated_impl_) +#define _NullNull_terminated_ _SAL2_Source_(_NullNull_terminated_, (), _NullNull_terminated_impl_) + +// Expressing buffer size as pre or post condition +#define _Pre_readable_size_(size) _SAL2_Source_(_Pre_readable_size_, (size), _Pre1_impl_(__count_impl(size)) _Pre_valid_impl_) +#define _Pre_writable_size_(size) _SAL2_Source_(_Pre_writable_size_, (size), _Pre1_impl_(__cap_impl(size))) +#define _Pre_readable_byte_size_(size) _SAL2_Source_(_Pre_readable_byte_size_, (size), _Pre1_impl_(__bytecount_impl(size)) _Pre_valid_impl_) +#define _Pre_writable_byte_size_(size) _SAL2_Source_(_Pre_writable_byte_size_, (size), _Pre1_impl_(__bytecap_impl(size))) + +#define _Post_readable_size_(size) _SAL2_Source_(_Post_readable_size_, (size), _Post1_impl_(__count_impl(size)) _Post_valid_impl_) +#define _Post_writable_size_(size) _SAL2_Source_(_Post_writable_size_, (size), _Post1_impl_(__cap_impl(size))) +#define _Post_readable_byte_size_(size) _SAL2_Source_(_Post_readable_byte_size_, (size), _Post1_impl_(__bytecount_impl(size)) _Post_valid_impl_) +#define _Post_writable_byte_size_(size) _SAL2_Source_(_Post_writable_byte_size_, (size), _Post1_impl_(__bytecap_impl(size))) + +// +// Pointer null-ness properties +// +#define _Null_ _SAL2_Source_(_Null_, (), _Null_impl_) +#define _Notnull_ _SAL2_Source_(_Notnull_, (), _Notnull_impl_) +#define _Maybenull_ _SAL2_Source_(_Maybenull_, (), _Maybenull_impl_) + +// +// _Pre_ annotations --- +// +// describing conditions that must be met before the call of the function + +// e.g. int strlen( _Pre_z_ const char* sz ); +// buffer is a zero terminated string +#define _Pre_z_ _SAL2_Source_(_Pre_z_, (), _Pre1_impl_(__zterm_impl) _Pre_valid_impl_) + +// valid size unknown or indicated by type (e.g.:LPSTR) +#define _Pre_valid_ _SAL2_Source_(_Pre_valid_, (), _Pre1_impl_(__notnull_impl_notref) _Pre_valid_impl_) +#define _Pre_opt_valid_ _SAL2_Source_(_Pre_opt_valid_, (), _Pre1_impl_(__maybenull_impl_notref) _Pre_valid_impl_) + +#define _Pre_invalid_ _SAL2_Source_(_Pre_invalid_, (), _Deref_pre1_impl_(__notvalid_impl)) + +// Overrides recursive valid when some field is not yet initialized when using _Inout_ +#define _Pre_unknown_ _SAL2_Source_(_Pre_unknown_, (), _Pre1_impl_(__maybevalid_impl)) + +// used with allocated but not yet initialized objects +#define _Pre_notnull_ _SAL2_Source_(_Pre_notnull_, (), _Pre1_impl_(__notnull_impl_notref)) +#define _Pre_maybenull_ _SAL2_Source_(_Pre_maybenull_, (), _Pre1_impl_(__maybenull_impl_notref)) +#define _Pre_null_ _SAL2_Source_(_Pre_null_, (), _Pre1_impl_(__null_impl_notref)) + +// +// _Post_ annotations --- +// +// describing conditions that hold after the function call + +// void CopyStr( _In_z_ const char* szFrom, _Pre_cap_(cch) _Post_z_ char* szFrom, size_t cchFrom ); +// buffer will be a zero-terminated string after the call +#define _Post_z_ _SAL2_Source_(_Post_z_, (), _Post1_impl_(__zterm_impl) _Post_valid_impl_) + +// e.g. HRESULT InitStruct( _Post_valid_ Struct* pobj ); +#define _Post_valid_ _SAL2_Source_(_Post_valid_, (), _Post_valid_impl_) +#define _Post_invalid_ _SAL2_Source_(_Post_invalid_, (), _Deref_post1_impl_(__notvalid_impl)) + +// e.g. void free( _Post_ptr_invalid_ void* pv ); +#define _Post_ptr_invalid_ _SAL2_Source_(_Post_ptr_invalid_, (), _Post1_impl_(__notvalid_impl)) + +// e.g. void ThrowExceptionIfNull( _Post_notnull_ const void* pv ); +#define _Post_notnull_ _SAL2_Source_(_Post_notnull_, (), _Post1_impl_(__notnull_impl)) + +// e.g. HRESULT GetObject(_Outptr_ _On_failure_(_At_(*p, _Post_null_)) T **p); +#define _Post_null_ _SAL2_Source_(_Post_null_, (), _Post1_impl_(__null_impl)) + +#define _Post_maybenull_ _SAL2_Source_(_Post_maybenull_, (), _Post1_impl_(__maybenull_impl)) + +#define _Prepost_z_ _SAL2_Source_(_Prepost_z_, (), _Pre_z_ _Post_z_) + + +#pragma region Input Buffer SAL 1 compatibility macros + +/*========================================================================== + + This section contains definitions for macros defined for VS2010 and earlier. + Usage of these macros is still supported, but the SAL 2 macros defined above + are recommended instead. This comment block is retained to assist in + understanding SAL that still uses the older syntax. + + The macros are defined in 3 layers: + + _In_/_Out_ Layer: + ---------------- + This layer provides the highest abstraction and its macros should be used + in most cases. Its macros start with _In_, _Out_ or _Inout_. For the + typical case they provide the most concise annotations. + + _Pre_/_Post_ Layer: + ------------------ + The macros of this layer only should be used when there is no suitable macro + in the _In_/_Out_ layer. Its macros start with _Pre_, _Post_, _Ret_, + _Deref_pre_ _Deref_post_ and _Deref_ret_. This layer provides the most + flexibility for annotations. + + Implementation Abstraction Layer: + -------------------------------- + Macros from this layer should never be used directly. The layer only exists + to hide the implementation of the annotation macros. + + + Annotation Syntax: + |--------------|----------|----------------|-----------------------------| + | Usage | Nullness | ZeroTerminated | Extent | + |--------------|----------|----------------|-----------------------------| + | _In_ | <> | <> | <> | + | _Out_ | opt_ | z_ | [byte]cap_[c_|x_]( size ) | + | _Inout_ | | | [byte]count_[c_|x_]( size ) | + | _Deref_out_ | | | ptrdiff_cap_( ptr ) | + |--------------| | | ptrdiff_count_( ptr ) | + | _Ret_ | | | | + | _Deref_ret_ | | | | + |--------------| | | | + | _Pre_ | | | | + | _Post_ | | | | + | _Deref_pre_ | | | | + | _Deref_post_ | | | | + |--------------|----------|----------------|-----------------------------| + + Usage: + ----- + _In_, _Out_, _Inout_, _Pre_, _Post_, _Deref_pre_, _Deref_post_ are for + formal parameters. + _Ret_, _Deref_ret_ must be used for return values. + + Nullness: + -------- + If the pointer can be NULL the annotation contains _opt. If the macro + does not contain '_opt' the pointer may not be NULL. + + String Type: + ----------- + _z: NullTerminated string + for _In_ parameters the buffer must have the specified stringtype before the call + for _Out_ parameters the buffer must have the specified stringtype after the call + for _Inout_ parameters both conditions apply + + Extent Syntax: + |------|---------------|---------------| + | Unit | Writ/Readable | Argument Type | + |------|---------------|---------------| + | <> | cap_ | <> | + | byte | count_ | c_ | + | | | x_ | + |------|---------------|---------------| + + 'cap' (capacity) describes the writable size of the buffer and is typically used + with _Out_. The default unit is elements. Use 'bytecap' if the size is given in bytes + 'count' describes the readable size of the buffer and is typically used with _In_. + The default unit is elements. Use 'bytecount' if the size is given in bytes. + + Argument syntax for cap_, bytecap_, count_, bytecount_: + (|return)[+n] e.g. cch, return, cb+2 + + If the buffer size is a constant expression use the c_ postfix. + E.g. cap_c_(20), count_c_(MAX_PATH), bytecount_c_(16) + + If the buffer size is given by a limiting pointer use the ptrdiff_ versions + of the macros. + + If the buffer size is neither a parameter nor a constant expression use the x_ + postfix. e.g. bytecount_x_(num*size) x_ annotations accept any arbitrary string. + No analysis can be done for x_ annotations but they at least tell the tool that + the buffer has some sort of extent description. x_ annotations might be supported + by future compiler versions. + +============================================================================*/ + +// e.g. void SetCharRange( _In_count_(cch) const char* rgch, size_t cch ) +// valid buffer extent described by another parameter +#define _In_count_(size) _SAL1_1_Source_(_In_count_, (size), _Pre_count_(size) _Deref_pre_readonly_) +#define _In_opt_count_(size) _SAL1_1_Source_(_In_opt_count_, (size), _Pre_opt_count_(size) _Deref_pre_readonly_) +#define _In_bytecount_(size) _SAL1_1_Source_(_In_bytecount_, (size), _Pre_bytecount_(size) _Deref_pre_readonly_) +#define _In_opt_bytecount_(size) _SAL1_1_Source_(_In_opt_bytecount_, (size), _Pre_opt_bytecount_(size) _Deref_pre_readonly_) + +// valid buffer extent described by a constant extression +#define _In_count_c_(size) _SAL1_1_Source_(_In_count_c_, (size), _Pre_count_c_(size) _Deref_pre_readonly_) +#define _In_opt_count_c_(size) _SAL1_1_Source_(_In_opt_count_c_, (size), _Pre_opt_count_c_(size) _Deref_pre_readonly_) +#define _In_bytecount_c_(size) _SAL1_1_Source_(_In_bytecount_c_, (size), _Pre_bytecount_c_(size) _Deref_pre_readonly_) +#define _In_opt_bytecount_c_(size) _SAL1_1_Source_(_In_opt_bytecount_c_, (size), _Pre_opt_bytecount_c_(size) _Deref_pre_readonly_) + +// nullterminated 'input' buffers with given size + +// e.g. void SetCharRange( _In_count_(cch) const char* rgch, size_t cch ) +// nullterminated valid buffer extent described by another parameter +#define _In_z_count_(size) _SAL1_1_Source_(_In_z_count_, (size), _Pre_z_ _Pre_count_(size) _Deref_pre_readonly_) +#define _In_opt_z_count_(size) _SAL1_1_Source_(_In_opt_z_count_, (size), _Pre_opt_z_ _Pre_opt_count_(size) _Deref_pre_readonly_) +#define _In_z_bytecount_(size) _SAL1_1_Source_(_In_z_bytecount_, (size), _Pre_z_ _Pre_bytecount_(size) _Deref_pre_readonly_) +#define _In_opt_z_bytecount_(size) _SAL1_1_Source_(_In_opt_z_bytecount_, (size), _Pre_opt_z_ _Pre_opt_bytecount_(size) _Deref_pre_readonly_) + +// nullterminated valid buffer extent described by a constant extression +#define _In_z_count_c_(size) _SAL1_1_Source_(_In_z_count_c_, (size), _Pre_z_ _Pre_count_c_(size) _Deref_pre_readonly_) +#define _In_opt_z_count_c_(size) _SAL1_1_Source_(_In_opt_z_count_c_, (size), _Pre_opt_z_ _Pre_opt_count_c_(size) _Deref_pre_readonly_) +#define _In_z_bytecount_c_(size) _SAL1_1_Source_(_In_z_bytecount_c_, (size), _Pre_z_ _Pre_bytecount_c_(size) _Deref_pre_readonly_) +#define _In_opt_z_bytecount_c_(size) _SAL1_1_Source_(_In_opt_z_bytecount_c_, (size), _Pre_opt_z_ _Pre_opt_bytecount_c_(size) _Deref_pre_readonly_) + +// buffer capacity is described by another pointer +// e.g. void Foo( _In_ptrdiff_count_(pchMax) const char* pch, const char* pchMax ) { while pch < pchMax ) pch++; } +#define _In_ptrdiff_count_(size) _SAL1_1_Source_(_In_ptrdiff_count_, (size), _Pre_ptrdiff_count_(size) _Deref_pre_readonly_) +#define _In_opt_ptrdiff_count_(size) _SAL1_1_Source_(_In_opt_ptrdiff_count_, (size), _Pre_opt_ptrdiff_count_(size) _Deref_pre_readonly_) + +// 'x' version for complex expressions that are not supported by the current compiler version +// e.g. void Set3ColMatrix( _In_count_x_(3*cRows) const Elem* matrix, int cRows ); +#define _In_count_x_(size) _SAL1_1_Source_(_In_count_x_, (size), _Pre_count_x_(size) _Deref_pre_readonly_) +#define _In_opt_count_x_(size) _SAL1_1_Source_(_In_opt_count_x_, (size), _Pre_opt_count_x_(size) _Deref_pre_readonly_) +#define _In_bytecount_x_(size) _SAL1_1_Source_(_In_bytecount_x_, (size), _Pre_bytecount_x_(size) _Deref_pre_readonly_) +#define _In_opt_bytecount_x_(size) _SAL1_1_Source_(_In_opt_bytecount_x_, (size), _Pre_opt_bytecount_x_(size) _Deref_pre_readonly_) + + +// 'out' with buffer size +// e.g. void GetIndices( _Out_cap_(cIndices) int* rgIndices, size_t cIndices ); +// buffer capacity is described by another parameter +#define _Out_cap_(size) _SAL1_1_Source_(_Out_cap_, (size), _Pre_cap_(size) _Post_valid_impl_) +#define _Out_opt_cap_(size) _SAL1_1_Source_(_Out_opt_cap_, (size), _Pre_opt_cap_(size) _Post_valid_impl_) +#define _Out_bytecap_(size) _SAL1_1_Source_(_Out_bytecap_, (size), _Pre_bytecap_(size) _Post_valid_impl_) +#define _Out_opt_bytecap_(size) _SAL1_1_Source_(_Out_opt_bytecap_, (size), _Pre_opt_bytecap_(size) _Post_valid_impl_) + +// buffer capacity is described by a constant expression +#define _Out_cap_c_(size) _SAL1_1_Source_(_Out_cap_c_, (size), _Pre_cap_c_(size) _Post_valid_impl_) +#define _Out_opt_cap_c_(size) _SAL1_1_Source_(_Out_opt_cap_c_, (size), _Pre_opt_cap_c_(size) _Post_valid_impl_) +#define _Out_bytecap_c_(size) _SAL1_1_Source_(_Out_bytecap_c_, (size), _Pre_bytecap_c_(size) _Post_valid_impl_) +#define _Out_opt_bytecap_c_(size) _SAL1_1_Source_(_Out_opt_bytecap_c_, (size), _Pre_opt_bytecap_c_(size) _Post_valid_impl_) + +// buffer capacity is described by another parameter multiplied by a constant expression +#define _Out_cap_m_(mult,size) _SAL1_1_Source_(_Out_cap_m_, (mult,size), _Pre_cap_m_(mult,size) _Post_valid_impl_) +#define _Out_opt_cap_m_(mult,size) _SAL1_1_Source_(_Out_opt_cap_m_, (mult,size), _Pre_opt_cap_m_(mult,size) _Post_valid_impl_) +#define _Out_z_cap_m_(mult,size) _SAL1_1_Source_(_Out_z_cap_m_, (mult,size), _Pre_cap_m_(mult,size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_cap_m_(mult,size) _SAL1_1_Source_(_Out_opt_z_cap_m_, (mult,size), _Pre_opt_cap_m_(mult,size) _Post_valid_impl_ _Post_z_) + +// buffer capacity is described by another pointer +// e.g. void Foo( _Out_ptrdiff_cap_(pchMax) char* pch, const char* pchMax ) { while pch < pchMax ) pch++; } +#define _Out_ptrdiff_cap_(size) _SAL1_1_Source_(_Out_ptrdiff_cap_, (size), _Pre_ptrdiff_cap_(size) _Post_valid_impl_) +#define _Out_opt_ptrdiff_cap_(size) _SAL1_1_Source_(_Out_opt_ptrdiff_cap_, (size), _Pre_opt_ptrdiff_cap_(size) _Post_valid_impl_) + +// buffer capacity is described by a complex expression +#define _Out_cap_x_(size) _SAL1_1_Source_(_Out_cap_x_, (size), _Pre_cap_x_(size) _Post_valid_impl_) +#define _Out_opt_cap_x_(size) _SAL1_1_Source_(_Out_opt_cap_x_, (size), _Pre_opt_cap_x_(size) _Post_valid_impl_) +#define _Out_bytecap_x_(size) _SAL1_1_Source_(_Out_bytecap_x_, (size), _Pre_bytecap_x_(size) _Post_valid_impl_) +#define _Out_opt_bytecap_x_(size) _SAL1_1_Source_(_Out_opt_bytecap_x_, (size), _Pre_opt_bytecap_x_(size) _Post_valid_impl_) + +// a zero terminated string is filled into a buffer of given capacity +// e.g. void CopyStr( _In_z_ const char* szFrom, _Out_z_cap_(cchTo) char* szTo, size_t cchTo ); +// buffer capacity is described by another parameter +#define _Out_z_cap_(size) _SAL1_1_Source_(_Out_z_cap_, (size), _Pre_cap_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_cap_(size) _SAL1_1_Source_(_Out_opt_z_cap_, (size), _Pre_opt_cap_(size) _Post_valid_impl_ _Post_z_) +#define _Out_z_bytecap_(size) _SAL1_1_Source_(_Out_z_bytecap_, (size), _Pre_bytecap_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_bytecap_(size) _SAL1_1_Source_(_Out_opt_z_bytecap_, (size), _Pre_opt_bytecap_(size) _Post_valid_impl_ _Post_z_) + +// buffer capacity is described by a constant expression +#define _Out_z_cap_c_(size) _SAL1_1_Source_(_Out_z_cap_c_, (size), _Pre_cap_c_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_cap_c_(size) _SAL1_1_Source_(_Out_opt_z_cap_c_, (size), _Pre_opt_cap_c_(size) _Post_valid_impl_ _Post_z_) +#define _Out_z_bytecap_c_(size) _SAL1_1_Source_(_Out_z_bytecap_c_, (size), _Pre_bytecap_c_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_bytecap_c_(size) _SAL1_1_Source_(_Out_opt_z_bytecap_c_, (size), _Pre_opt_bytecap_c_(size) _Post_valid_impl_ _Post_z_) + +// buffer capacity is described by a complex expression +#define _Out_z_cap_x_(size) _SAL1_1_Source_(_Out_z_cap_x_, (size), _Pre_cap_x_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_cap_x_(size) _SAL1_1_Source_(_Out_opt_z_cap_x_, (size), _Pre_opt_cap_x_(size) _Post_valid_impl_ _Post_z_) +#define _Out_z_bytecap_x_(size) _SAL1_1_Source_(_Out_z_bytecap_x_, (size), _Pre_bytecap_x_(size) _Post_valid_impl_ _Post_z_) +#define _Out_opt_z_bytecap_x_(size) _SAL1_1_Source_(_Out_opt_z_bytecap_x_, (size), _Pre_opt_bytecap_x_(size) _Post_valid_impl_ _Post_z_) + +// a zero terminated string is filled into a buffer of given capacity +// e.g. size_t CopyCharRange( _In_count_(cchFrom) const char* rgchFrom, size_t cchFrom, _Out_cap_post_count_(cchTo,return)) char* rgchTo, size_t cchTo ); +#define _Out_cap_post_count_(cap,count) _SAL1_1_Source_(_Out_cap_post_count_, (cap,count), _Pre_cap_(cap) _Post_valid_impl_ _Post_count_(count)) +#define _Out_opt_cap_post_count_(cap,count) _SAL1_1_Source_(_Out_opt_cap_post_count_, (cap,count), _Pre_opt_cap_(cap) _Post_valid_impl_ _Post_count_(count)) +#define _Out_bytecap_post_bytecount_(cap,count) _SAL1_1_Source_(_Out_bytecap_post_bytecount_, (cap,count), _Pre_bytecap_(cap) _Post_valid_impl_ _Post_bytecount_(count)) +#define _Out_opt_bytecap_post_bytecount_(cap,count) _SAL1_1_Source_(_Out_opt_bytecap_post_bytecount_, (cap,count), _Pre_opt_bytecap_(cap) _Post_valid_impl_ _Post_bytecount_(count)) + +// a zero terminated string is filled into a buffer of given capacity +// e.g. size_t CopyStr( _In_z_ const char* szFrom, _Out_z_cap_post_count_(cchTo,return+1) char* szTo, size_t cchTo ); +#define _Out_z_cap_post_count_(cap,count) _SAL1_1_Source_(_Out_z_cap_post_count_, (cap,count), _Pre_cap_(cap) _Post_valid_impl_ _Post_z_count_(count)) +#define _Out_opt_z_cap_post_count_(cap,count) _SAL1_1_Source_(_Out_opt_z_cap_post_count_, (cap,count), _Pre_opt_cap_(cap) _Post_valid_impl_ _Post_z_count_(count)) +#define _Out_z_bytecap_post_bytecount_(cap,count) _SAL1_1_Source_(_Out_z_bytecap_post_bytecount_, (cap,count), _Pre_bytecap_(cap) _Post_valid_impl_ _Post_z_bytecount_(count)) +#define _Out_opt_z_bytecap_post_bytecount_(cap,count) _SAL1_1_Source_(_Out_opt_z_bytecap_post_bytecount_, (cap,count), _Pre_opt_bytecap_(cap) _Post_valid_impl_ _Post_z_bytecount_(count)) + +// only use with dereferenced arguments e.g. '*pcch' +#define _Out_capcount_(capcount) _SAL1_1_Source_(_Out_capcount_, (capcount), _Pre_cap_(capcount) _Post_valid_impl_ _Post_count_(capcount)) +#define _Out_opt_capcount_(capcount) _SAL1_1_Source_(_Out_opt_capcount_, (capcount), _Pre_opt_cap_(capcount) _Post_valid_impl_ _Post_count_(capcount)) +#define _Out_bytecapcount_(capcount) _SAL1_1_Source_(_Out_bytecapcount_, (capcount), _Pre_bytecap_(capcount) _Post_valid_impl_ _Post_bytecount_(capcount)) +#define _Out_opt_bytecapcount_(capcount) _SAL1_1_Source_(_Out_opt_bytecapcount_, (capcount), _Pre_opt_bytecap_(capcount) _Post_valid_impl_ _Post_bytecount_(capcount)) + +#define _Out_capcount_x_(capcount) _SAL1_1_Source_(_Out_capcount_x_, (capcount), _Pre_cap_x_(capcount) _Post_valid_impl_ _Post_count_x_(capcount)) +#define _Out_opt_capcount_x_(capcount) _SAL1_1_Source_(_Out_opt_capcount_x_, (capcount), _Pre_opt_cap_x_(capcount) _Post_valid_impl_ _Post_count_x_(capcount)) +#define _Out_bytecapcount_x_(capcount) _SAL1_1_Source_(_Out_bytecapcount_x_, (capcount), _Pre_bytecap_x_(capcount) _Post_valid_impl_ _Post_bytecount_x_(capcount)) +#define _Out_opt_bytecapcount_x_(capcount) _SAL1_1_Source_(_Out_opt_bytecapcount_x_, (capcount), _Pre_opt_bytecap_x_(capcount) _Post_valid_impl_ _Post_bytecount_x_(capcount)) + +// e.g. GetString( _Out_z_capcount_(*pLen+1) char* sz, size_t* pLen ); +#define _Out_z_capcount_(capcount) _SAL1_1_Source_(_Out_z_capcount_, (capcount), _Pre_cap_(capcount) _Post_valid_impl_ _Post_z_count_(capcount)) +#define _Out_opt_z_capcount_(capcount) _SAL1_1_Source_(_Out_opt_z_capcount_, (capcount), _Pre_opt_cap_(capcount) _Post_valid_impl_ _Post_z_count_(capcount)) +#define _Out_z_bytecapcount_(capcount) _SAL1_1_Source_(_Out_z_bytecapcount_, (capcount), _Pre_bytecap_(capcount) _Post_valid_impl_ _Post_z_bytecount_(capcount)) +#define _Out_opt_z_bytecapcount_(capcount) _SAL1_1_Source_(_Out_opt_z_bytecapcount_, (capcount), _Pre_opt_bytecap_(capcount) _Post_valid_impl_ _Post_z_bytecount_(capcount)) + + +// 'inout' buffers with initialized elements before and after the call +// e.g. void ModifyIndices( _Inout_count_(cIndices) int* rgIndices, size_t cIndices ); +#define _Inout_count_(size) _SAL1_1_Source_(_Inout_count_, (size), _Prepost_count_(size)) +#define _Inout_opt_count_(size) _SAL1_1_Source_(_Inout_opt_count_, (size), _Prepost_opt_count_(size)) +#define _Inout_bytecount_(size) _SAL1_1_Source_(_Inout_bytecount_, (size), _Prepost_bytecount_(size)) +#define _Inout_opt_bytecount_(size) _SAL1_1_Source_(_Inout_opt_bytecount_, (size), _Prepost_opt_bytecount_(size)) + +#define _Inout_count_c_(size) _SAL1_1_Source_(_Inout_count_c_, (size), _Prepost_count_c_(size)) +#define _Inout_opt_count_c_(size) _SAL1_1_Source_(_Inout_opt_count_c_, (size), _Prepost_opt_count_c_(size)) +#define _Inout_bytecount_c_(size) _SAL1_1_Source_(_Inout_bytecount_c_, (size), _Prepost_bytecount_c_(size)) +#define _Inout_opt_bytecount_c_(size) _SAL1_1_Source_(_Inout_opt_bytecount_c_, (size), _Prepost_opt_bytecount_c_(size)) + +// nullterminated 'inout' buffers with initialized elements before and after the call +// e.g. void ModifyIndices( _Inout_count_(cIndices) int* rgIndices, size_t cIndices ); +#define _Inout_z_count_(size) _SAL1_1_Source_(_Inout_z_count_, (size), _Prepost_z_ _Prepost_count_(size)) +#define _Inout_opt_z_count_(size) _SAL1_1_Source_(_Inout_opt_z_count_, (size), _Prepost_z_ _Prepost_opt_count_(size)) +#define _Inout_z_bytecount_(size) _SAL1_1_Source_(_Inout_z_bytecount_, (size), _Prepost_z_ _Prepost_bytecount_(size)) +#define _Inout_opt_z_bytecount_(size) _SAL1_1_Source_(_Inout_opt_z_bytecount_, (size), _Prepost_z_ _Prepost_opt_bytecount_(size)) + +#define _Inout_z_count_c_(size) _SAL1_1_Source_(_Inout_z_count_c_, (size), _Prepost_z_ _Prepost_count_c_(size)) +#define _Inout_opt_z_count_c_(size) _SAL1_1_Source_(_Inout_opt_z_count_c_, (size), _Prepost_z_ _Prepost_opt_count_c_(size)) +#define _Inout_z_bytecount_c_(size) _SAL1_1_Source_(_Inout_z_bytecount_c_, (size), _Prepost_z_ _Prepost_bytecount_c_(size)) +#define _Inout_opt_z_bytecount_c_(size) _SAL1_1_Source_(_Inout_opt_z_bytecount_c_, (size), _Prepost_z_ _Prepost_opt_bytecount_c_(size)) + +#define _Inout_ptrdiff_count_(size) _SAL1_1_Source_(_Inout_ptrdiff_count_, (size), _Pre_ptrdiff_count_(size)) +#define _Inout_opt_ptrdiff_count_(size) _SAL1_1_Source_(_Inout_opt_ptrdiff_count_, (size), _Pre_opt_ptrdiff_count_(size)) + +#define _Inout_count_x_(size) _SAL1_1_Source_(_Inout_count_x_, (size), _Prepost_count_x_(size)) +#define _Inout_opt_count_x_(size) _SAL1_1_Source_(_Inout_opt_count_x_, (size), _Prepost_opt_count_x_(size)) +#define _Inout_bytecount_x_(size) _SAL1_1_Source_(_Inout_bytecount_x_, (size), _Prepost_bytecount_x_(size)) +#define _Inout_opt_bytecount_x_(size) _SAL1_1_Source_(_Inout_opt_bytecount_x_, (size), _Prepost_opt_bytecount_x_(size)) + +// e.g. void AppendToLPSTR( _In_ LPCSTR szFrom, _Inout_cap_(cchTo) LPSTR* szTo, size_t cchTo ); +#define _Inout_cap_(size) _SAL1_1_Source_(_Inout_cap_, (size), _Pre_valid_cap_(size) _Post_valid_) +#define _Inout_opt_cap_(size) _SAL1_1_Source_(_Inout_opt_cap_, (size), _Pre_opt_valid_cap_(size) _Post_valid_) +#define _Inout_bytecap_(size) _SAL1_1_Source_(_Inout_bytecap_, (size), _Pre_valid_bytecap_(size) _Post_valid_) +#define _Inout_opt_bytecap_(size) _SAL1_1_Source_(_Inout_opt_bytecap_, (size), _Pre_opt_valid_bytecap_(size) _Post_valid_) + +#define _Inout_cap_c_(size) _SAL1_1_Source_(_Inout_cap_c_, (size), _Pre_valid_cap_c_(size) _Post_valid_) +#define _Inout_opt_cap_c_(size) _SAL1_1_Source_(_Inout_opt_cap_c_, (size), _Pre_opt_valid_cap_c_(size) _Post_valid_) +#define _Inout_bytecap_c_(size) _SAL1_1_Source_(_Inout_bytecap_c_, (size), _Pre_valid_bytecap_c_(size) _Post_valid_) +#define _Inout_opt_bytecap_c_(size) _SAL1_1_Source_(_Inout_opt_bytecap_c_, (size), _Pre_opt_valid_bytecap_c_(size) _Post_valid_) + +#define _Inout_cap_x_(size) _SAL1_1_Source_(_Inout_cap_x_, (size), _Pre_valid_cap_x_(size) _Post_valid_) +#define _Inout_opt_cap_x_(size) _SAL1_1_Source_(_Inout_opt_cap_x_, (size), _Pre_opt_valid_cap_x_(size) _Post_valid_) +#define _Inout_bytecap_x_(size) _SAL1_1_Source_(_Inout_bytecap_x_, (size), _Pre_valid_bytecap_x_(size) _Post_valid_) +#define _Inout_opt_bytecap_x_(size) _SAL1_1_Source_(_Inout_opt_bytecap_x_, (size), _Pre_opt_valid_bytecap_x_(size) _Post_valid_) + +// inout string buffers with writable size +// e.g. void AppendStr( _In_z_ const char* szFrom, _Inout_z_cap_(cchTo) char* szTo, size_t cchTo ); +#define _Inout_z_cap_(size) _SAL1_1_Source_(_Inout_z_cap_, (size), _Pre_z_cap_(size) _Post_z_) +#define _Inout_opt_z_cap_(size) _SAL1_1_Source_(_Inout_opt_z_cap_, (size), _Pre_opt_z_cap_(size) _Post_z_) +#define _Inout_z_bytecap_(size) _SAL1_1_Source_(_Inout_z_bytecap_, (size), _Pre_z_bytecap_(size) _Post_z_) +#define _Inout_opt_z_bytecap_(size) _SAL1_1_Source_(_Inout_opt_z_bytecap_, (size), _Pre_opt_z_bytecap_(size) _Post_z_) + +#define _Inout_z_cap_c_(size) _SAL1_1_Source_(_Inout_z_cap_c_, (size), _Pre_z_cap_c_(size) _Post_z_) +#define _Inout_opt_z_cap_c_(size) _SAL1_1_Source_(_Inout_opt_z_cap_c_, (size), _Pre_opt_z_cap_c_(size) _Post_z_) +#define _Inout_z_bytecap_c_(size) _SAL1_1_Source_(_Inout_z_bytecap_c_, (size), _Pre_z_bytecap_c_(size) _Post_z_) +#define _Inout_opt_z_bytecap_c_(size) _SAL1_1_Source_(_Inout_opt_z_bytecap_c_, (size), _Pre_opt_z_bytecap_c_(size) _Post_z_) + +#define _Inout_z_cap_x_(size) _SAL1_1_Source_(_Inout_z_cap_x_, (size), _Pre_z_cap_x_(size) _Post_z_) +#define _Inout_opt_z_cap_x_(size) _SAL1_1_Source_(_Inout_opt_z_cap_x_, (size), _Pre_opt_z_cap_x_(size) _Post_z_) +#define _Inout_z_bytecap_x_(size) _SAL1_1_Source_(_Inout_z_bytecap_x_, (size), _Pre_z_bytecap_x_(size) _Post_z_) +#define _Inout_opt_z_bytecap_x_(size) _SAL1_1_Source_(_Inout_opt_z_bytecap_x_, (size), _Pre_opt_z_bytecap_x_(size) _Post_z_) + + +// returning pointers to valid objects +#define _Ret_ _SAL1_1_Source_(_Ret_, (), _Ret_valid_) +#define _Ret_opt_ _SAL1_1_Source_(_Ret_opt_, (), _Ret_opt_valid_) + +// annotations to express 'boundedness' of integral value parameter +#define _In_bound_ _SAL1_1_Source_(_In_bound_, (), _In_bound_impl_) +#define _Out_bound_ _SAL1_1_Source_(_Out_bound_, (), _Out_bound_impl_) +#define _Ret_bound_ _SAL1_1_Source_(_Ret_bound_, (), _Ret_bound_impl_) +#define _Deref_in_bound_ _SAL1_1_Source_(_Deref_in_bound_, (), _Deref_in_bound_impl_) +#define _Deref_out_bound_ _SAL1_1_Source_(_Deref_out_bound_, (), _Deref_out_bound_impl_) +#define _Deref_inout_bound_ _SAL1_1_Source_(_Deref_inout_bound_, (), _Deref_in_bound_ _Deref_out_bound_) +#define _Deref_ret_bound_ _SAL1_1_Source_(_Deref_ret_bound_, (), _Deref_ret_bound_impl_) + +// e.g. HRESULT HrCreatePoint( _Deref_out_opt_ POINT** ppPT ); +#define _Deref_out_ _SAL1_1_Source_(_Deref_out_, (), _Out_ _Deref_post_valid_) +#define _Deref_out_opt_ _SAL1_1_Source_(_Deref_out_opt_, (), _Out_ _Deref_post_opt_valid_) +#define _Deref_opt_out_ _SAL1_1_Source_(_Deref_opt_out_, (), _Out_opt_ _Deref_post_valid_) +#define _Deref_opt_out_opt_ _SAL1_1_Source_(_Deref_opt_out_opt_, (), _Out_opt_ _Deref_post_opt_valid_) + +// e.g. void CloneString( _In_z_ const wchar_t* wzFrom, _Deref_out_z_ wchar_t** pWzTo ); +#define _Deref_out_z_ _SAL1_1_Source_(_Deref_out_z_, (), _Out_ _Deref_post_z_) +#define _Deref_out_opt_z_ _SAL1_1_Source_(_Deref_out_opt_z_, (), _Out_ _Deref_post_opt_z_) +#define _Deref_opt_out_z_ _SAL1_1_Source_(_Deref_opt_out_z_, (), _Out_opt_ _Deref_post_z_) +#define _Deref_opt_out_opt_z_ _SAL1_1_Source_(_Deref_opt_out_opt_z_, (), _Out_opt_ _Deref_post_opt_z_) + +// +// _Deref_pre_ --- +// +// describing conditions for array elements of dereferenced pointer parameters that must be met before the call + +// e.g. void SaveStringArray( _In_count_(cStrings) _Deref_pre_z_ const wchar_t* const rgpwch[] ); +#define _Deref_pre_z_ _SAL1_1_Source_(_Deref_pre_z_, (), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__zterm_impl) _Pre_valid_impl_) +#define _Deref_pre_opt_z_ _SAL1_1_Source_(_Deref_pre_opt_z_, (), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__zterm_impl) _Pre_valid_impl_) + +// e.g. void FillInArrayOfStr32( _In_count_(cStrings) _Deref_pre_cap_c_(32) _Deref_post_z_ wchar_t* const rgpwch[] ); +// buffer capacity is described by another parameter +#define _Deref_pre_cap_(size) _SAL1_1_Source_(_Deref_pre_cap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_impl(size))) +#define _Deref_pre_opt_cap_(size) _SAL1_1_Source_(_Deref_pre_opt_cap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_impl(size))) +#define _Deref_pre_bytecap_(size) _SAL1_1_Source_(_Deref_pre_bytecap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_impl(size))) +#define _Deref_pre_opt_bytecap_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_impl(size))) + +// buffer capacity is described by a constant expression +#define _Deref_pre_cap_c_(size) _SAL1_1_Source_(_Deref_pre_cap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_c_impl(size))) +#define _Deref_pre_opt_cap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_cap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_c_impl(size))) +#define _Deref_pre_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_bytecap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_c_impl(size))) +#define _Deref_pre_opt_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_c_impl(size))) + +// buffer capacity is described by a complex condition +#define _Deref_pre_cap_x_(size) _SAL1_1_Source_(_Deref_pre_cap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_x_impl(size))) +#define _Deref_pre_opt_cap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_cap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_x_impl(size))) +#define _Deref_pre_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_bytecap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_x_impl(size))) +#define _Deref_pre_opt_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_x_impl(size))) + +// convenience macros for nullterminated buffers with given capacity +#define _Deref_pre_z_cap_(size) _SAL1_1_Source_(_Deref_pre_z_cap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_cap_(size) _SAL1_1_Source_(_Deref_pre_opt_z_cap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_z_bytecap_(size) _SAL1_1_Source_(_Deref_pre_z_bytecap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_bytecap_(size) _SAL1_1_Source_(_Deref_pre_opt_z_bytecap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_impl(size)) _Pre_valid_impl_) + +#define _Deref_pre_z_cap_c_(size) _SAL1_1_Source_(_Deref_pre_z_cap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_cap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_z_cap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_z_bytecap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_z_bytecap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Pre_valid_impl_) + +#define _Deref_pre_z_cap_x_(size) _SAL1_1_Source_(_Deref_pre_z_cap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_cap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_z_cap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__cap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_z_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_z_bytecap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_z_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_z_bytecap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Pre_valid_impl_) + +// known capacity and valid but unknown readable extent +#define _Deref_pre_valid_cap_(size) _SAL1_1_Source_(_Deref_pre_valid_cap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_cap_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_cap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_valid_bytecap_(size) _SAL1_1_Source_(_Deref_pre_valid_bytecap_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_bytecap_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_bytecap_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_impl(size)) _Pre_valid_impl_) + +#define _Deref_pre_valid_cap_c_(size) _SAL1_1_Source_(_Deref_pre_valid_cap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_cap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_cap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_valid_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_valid_bytecap_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_bytecap_c_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_bytecap_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_c_impl(size)) _Pre_valid_impl_) + +#define _Deref_pre_valid_cap_x_(size) _SAL1_1_Source_(_Deref_pre_valid_cap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__cap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_cap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_cap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__cap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_valid_bytecap_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecap_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_pre_opt_valid_bytecap_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecap_x_impl(size)) _Pre_valid_impl_) + +// e.g. void SaveMatrix( _In_count_(n) _Deref_pre_count_(n) const Elem** matrix, size_t n ); +// valid buffer extent is described by another parameter +#define _Deref_pre_count_(size) _SAL1_1_Source_(_Deref_pre_count_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__count_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_count_(size) _SAL1_1_Source_(_Deref_pre_opt_count_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__count_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_bytecount_(size) _SAL1_1_Source_(_Deref_pre_bytecount_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecount_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_bytecount_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecount_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecount_impl(size)) _Pre_valid_impl_) + +// valid buffer extent is described by a constant expression +#define _Deref_pre_count_c_(size) _SAL1_1_Source_(_Deref_pre_count_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__count_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_count_c_(size) _SAL1_1_Source_(_Deref_pre_opt_count_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__count_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_bytecount_c_(size) _SAL1_1_Source_(_Deref_pre_bytecount_c_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecount_c_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_bytecount_c_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecount_c_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecount_c_impl(size)) _Pre_valid_impl_) + +// valid buffer extent is described by a complex expression +#define _Deref_pre_count_x_(size) _SAL1_1_Source_(_Deref_pre_count_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__count_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_count_x_(size) _SAL1_1_Source_(_Deref_pre_opt_count_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__count_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_bytecount_x_(size) _SAL1_1_Source_(_Deref_pre_bytecount_x_, (size), _Deref_pre1_impl_(__notnull_impl_notref) _Deref_pre1_impl_(__bytecount_x_impl(size)) _Pre_valid_impl_) +#define _Deref_pre_opt_bytecount_x_(size) _SAL1_1_Source_(_Deref_pre_opt_bytecount_x_, (size), _Deref_pre1_impl_(__maybenull_impl_notref) _Deref_pre1_impl_(__bytecount_x_impl(size)) _Pre_valid_impl_) + +// e.g. void PrintStringArray( _In_count_(cElems) _Deref_pre_valid_ LPCSTR rgStr[], size_t cElems ); +#define _Deref_pre_valid_ _SAL1_1_Source_(_Deref_pre_valid_, (), _Deref_pre1_impl_(__notnull_impl_notref) _Pre_valid_impl_) +#define _Deref_pre_opt_valid_ _SAL1_1_Source_(_Deref_pre_opt_valid_, (), _Deref_pre1_impl_(__maybenull_impl_notref) _Pre_valid_impl_) +#define _Deref_pre_invalid_ _SAL1_1_Source_(_Deref_pre_invalid_, (), _Deref_pre1_impl_(__notvalid_impl)) + +#define _Deref_pre_notnull_ _SAL1_1_Source_(_Deref_pre_notnull_, (), _Deref_pre1_impl_(__notnull_impl_notref)) +#define _Deref_pre_maybenull_ _SAL1_1_Source_(_Deref_pre_maybenull_, (), _Deref_pre1_impl_(__maybenull_impl_notref)) +#define _Deref_pre_null_ _SAL1_1_Source_(_Deref_pre_null_, (), _Deref_pre1_impl_(__null_impl_notref)) + +// restrict access rights +#define _Deref_pre_readonly_ _SAL1_1_Source_(_Deref_pre_readonly_, (), _Deref_pre1_impl_(__readaccess_impl_notref)) +#define _Deref_pre_writeonly_ _SAL1_1_Source_(_Deref_pre_writeonly_, (), _Deref_pre1_impl_(__writeaccess_impl_notref)) + +// +// _Deref_post_ --- +// +// describing conditions for array elements or dereferenced pointer parameters that hold after the call + +// e.g. void CloneString( _In_z_ const Wchar_t* wzIn _Out_ _Deref_post_z_ wchar_t** pWzOut ); +#define _Deref_post_z_ _SAL1_1_Source_(_Deref_post_z_, (), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__zterm_impl) _Post_valid_impl_) +#define _Deref_post_opt_z_ _SAL1_1_Source_(_Deref_post_opt_z_, (), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__zterm_impl) _Post_valid_impl_) + +// e.g. HRESULT HrAllocateMemory( size_t cb, _Out_ _Deref_post_bytecap_(cb) void** ppv ); +// buffer capacity is described by another parameter +#define _Deref_post_cap_(size) _SAL1_1_Source_(_Deref_post_cap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_impl(size))) +#define _Deref_post_opt_cap_(size) _SAL1_1_Source_(_Deref_post_opt_cap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_impl(size))) +#define _Deref_post_bytecap_(size) _SAL1_1_Source_(_Deref_post_bytecap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_impl(size))) +#define _Deref_post_opt_bytecap_(size) _SAL1_1_Source_(_Deref_post_opt_bytecap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_impl(size))) + +// buffer capacity is described by a constant expression +#define _Deref_post_cap_c_(size) _SAL1_1_Source_(_Deref_post_cap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_c_impl(size))) +#define _Deref_post_opt_cap_c_(size) _SAL1_1_Source_(_Deref_post_opt_cap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_c_impl(size))) +#define _Deref_post_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_bytecap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_c_impl(size))) +#define _Deref_post_opt_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_opt_bytecap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_c_impl(size))) + +// buffer capacity is described by a complex expression +#define _Deref_post_cap_x_(size) _SAL1_1_Source_(_Deref_post_cap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_x_impl(size))) +#define _Deref_post_opt_cap_x_(size) _SAL1_1_Source_(_Deref_post_opt_cap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_x_impl(size))) +#define _Deref_post_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_bytecap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_x_impl(size))) +#define _Deref_post_opt_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_opt_bytecap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_x_impl(size))) + +// convenience macros for nullterminated buffers with given capacity +#define _Deref_post_z_cap_(size) _SAL1_1_Source_(_Deref_post_z_cap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_cap_(size) _SAL1_1_Source_(_Deref_post_opt_z_cap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_impl(size)) _Post_valid_impl_) +#define _Deref_post_z_bytecap_(size) _SAL1_1_Source_(_Deref_post_z_bytecap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_bytecap_(size) _SAL1_1_Source_(_Deref_post_opt_z_bytecap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_impl(size)) _Post_valid_impl_) + +#define _Deref_post_z_cap_c_(size) _SAL1_1_Source_(_Deref_post_z_cap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_cap_c_(size) _SAL1_1_Source_(_Deref_post_opt_z_cap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_z_bytecap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_opt_z_bytecap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Post_valid_impl_) + +#define _Deref_post_z_cap_x_(size) _SAL1_1_Source_(_Deref_post_z_cap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_cap_x_(size) _SAL1_1_Source_(_Deref_post_opt_z_cap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__cap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_z_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_z_bytecap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_z_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_opt_z_bytecap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Post_valid_impl_) + +// known capacity and valid but unknown readable extent +#define _Deref_post_valid_cap_(size) _SAL1_1_Source_(_Deref_post_valid_cap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_cap_(size) _SAL1_1_Source_(_Deref_post_opt_valid_cap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_impl(size)) _Post_valid_impl_) +#define _Deref_post_valid_bytecap_(size) _SAL1_1_Source_(_Deref_post_valid_bytecap_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_bytecap_(size) _SAL1_1_Source_(_Deref_post_opt_valid_bytecap_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_impl(size)) _Post_valid_impl_) + +#define _Deref_post_valid_cap_c_(size) _SAL1_1_Source_(_Deref_post_valid_cap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_cap_c_(size) _SAL1_1_Source_(_Deref_post_opt_valid_cap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_valid_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_valid_bytecap_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_bytecap_c_(size) _SAL1_1_Source_(_Deref_post_opt_valid_bytecap_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_c_impl(size)) _Post_valid_impl_) + +#define _Deref_post_valid_cap_x_(size) _SAL1_1_Source_(_Deref_post_valid_cap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__cap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_cap_x_(size) _SAL1_1_Source_(_Deref_post_opt_valid_cap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__cap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_valid_bytecap_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecap_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_post_opt_valid_bytecap_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecap_x_impl(size)) _Post_valid_impl_) + +// e.g. HRESULT HrAllocateZeroInitializedMemory( size_t cb, _Out_ _Deref_post_bytecount_(cb) void** ppv ); +// valid buffer extent is described by another parameter +#define _Deref_post_count_(size) _SAL1_1_Source_(_Deref_post_count_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__count_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_count_(size) _SAL1_1_Source_(_Deref_post_opt_count_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__count_impl(size)) _Post_valid_impl_) +#define _Deref_post_bytecount_(size) _SAL1_1_Source_(_Deref_post_bytecount_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecount_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_bytecount_(size) _SAL1_1_Source_(_Deref_post_opt_bytecount_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecount_impl(size)) _Post_valid_impl_) + +// buffer capacity is described by a constant expression +#define _Deref_post_count_c_(size) _SAL1_1_Source_(_Deref_post_count_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__count_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_count_c_(size) _SAL1_1_Source_(_Deref_post_opt_count_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__count_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_bytecount_c_(size) _SAL1_1_Source_(_Deref_post_bytecount_c_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecount_c_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_bytecount_c_(size) _SAL1_1_Source_(_Deref_post_opt_bytecount_c_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecount_c_impl(size)) _Post_valid_impl_) + +// buffer capacity is described by a complex expression +#define _Deref_post_count_x_(size) _SAL1_1_Source_(_Deref_post_count_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__count_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_count_x_(size) _SAL1_1_Source_(_Deref_post_opt_count_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__count_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_bytecount_x_(size) _SAL1_1_Source_(_Deref_post_bytecount_x_, (size), _Deref_post1_impl_(__notnull_impl_notref) _Deref_post1_impl_(__bytecount_x_impl(size)) _Post_valid_impl_) +#define _Deref_post_opt_bytecount_x_(size) _SAL1_1_Source_(_Deref_post_opt_bytecount_x_, (size), _Deref_post1_impl_(__maybenull_impl_notref) _Deref_post1_impl_(__bytecount_x_impl(size)) _Post_valid_impl_) + +// e.g. void GetStrings( _Out_count_(cElems) _Deref_post_valid_ LPSTR const rgStr[], size_t cElems ); +#define _Deref_post_valid_ _SAL1_1_Source_(_Deref_post_valid_, (), _Deref_post1_impl_(__notnull_impl_notref) _Post_valid_impl_) +#define _Deref_post_opt_valid_ _SAL1_1_Source_(_Deref_post_opt_valid_, (), _Deref_post1_impl_(__maybenull_impl_notref) _Post_valid_impl_) + +#define _Deref_post_notnull_ _SAL1_1_Source_(_Deref_post_notnull_, (), _Deref_post1_impl_(__notnull_impl_notref)) +#define _Deref_post_maybenull_ _SAL1_1_Source_(_Deref_post_maybenull_, (), _Deref_post1_impl_(__maybenull_impl_notref)) +#define _Deref_post_null_ _SAL1_1_Source_(_Deref_post_null_, (), _Deref_post1_impl_(__null_impl_notref)) + +// +// _Deref_ret_ --- +// + +#define _Deref_ret_z_ _SAL1_1_Source_(_Deref_ret_z_, (), _Deref_ret1_impl_(__notnull_impl_notref) _Deref_ret1_impl_(__zterm_impl)) +#define _Deref_ret_opt_z_ _SAL1_1_Source_(_Deref_ret_opt_z_, (), _Deref_ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__zterm_impl)) + +// +// special _Deref_ --- +// +#define _Deref2_pre_readonly_ _SAL1_1_Source_(_Deref2_pre_readonly_, (), _Deref2_pre1_impl_(__readaccess_impl_notref)) + +// +// _Ret_ --- +// + +// e.g. _Ret_opt_valid_ LPSTR void* CloneSTR( _Pre_valid_ LPSTR src ); +#define _Ret_opt_valid_ _SAL1_1_Source_(_Ret_opt_valid_, (), _Ret1_impl_(__maybenull_impl_notref) _Ret_valid_impl_) +#define _Ret_opt_z_ _SAL1_1_Source_(_Ret_opt_z_, (), _Ret2_impl_(__maybenull_impl,__zterm_impl) _Ret_valid_impl_) + +// e.g. _Ret_opt_bytecap_(cb) void* AllocateMemory( size_t cb ); +// Buffer capacity is described by another parameter +#define _Ret_cap_(size) _SAL1_1_Source_(_Ret_cap_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__cap_impl(size))) +#define _Ret_opt_cap_(size) _SAL1_1_Source_(_Ret_opt_cap_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__cap_impl(size))) +#define _Ret_bytecap_(size) _SAL1_1_Source_(_Ret_bytecap_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecap_impl(size))) +#define _Ret_opt_bytecap_(size) _SAL1_1_Source_(_Ret_opt_bytecap_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecap_impl(size))) + +// Buffer capacity is described by a constant expression +#define _Ret_cap_c_(size) _SAL1_1_Source_(_Ret_cap_c_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__cap_c_impl(size))) +#define _Ret_opt_cap_c_(size) _SAL1_1_Source_(_Ret_opt_cap_c_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__cap_c_impl(size))) +#define _Ret_bytecap_c_(size) _SAL1_1_Source_(_Ret_bytecap_c_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecap_c_impl(size))) +#define _Ret_opt_bytecap_c_(size) _SAL1_1_Source_(_Ret_opt_bytecap_c_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecap_c_impl(size))) + +// Buffer capacity is described by a complex condition +#define _Ret_cap_x_(size) _SAL1_1_Source_(_Ret_cap_x_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__cap_x_impl(size))) +#define _Ret_opt_cap_x_(size) _SAL1_1_Source_(_Ret_opt_cap_x_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__cap_x_impl(size))) +#define _Ret_bytecap_x_(size) _SAL1_1_Source_(_Ret_bytecap_x_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecap_x_impl(size))) +#define _Ret_opt_bytecap_x_(size) _SAL1_1_Source_(_Ret_opt_bytecap_x_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecap_x_impl(size))) + +// return value is nullterminated and capacity is given by another parameter +#define _Ret_z_cap_(size) _SAL1_1_Source_(_Ret_z_cap_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret2_impl_(__zterm_impl,__cap_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_z_cap_(size) _SAL1_1_Source_(_Ret_opt_z_cap_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret2_impl_(__zterm_impl,__cap_impl(size)) _Ret_valid_impl_) +#define _Ret_z_bytecap_(size) _SAL1_1_Source_(_Ret_z_bytecap_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret2_impl_(__zterm_impl,__bytecap_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_z_bytecap_(size) _SAL1_1_Source_(_Ret_opt_z_bytecap_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret2_impl_(__zterm_impl,__bytecap_impl(size)) _Ret_valid_impl_) + +// e.g. _Ret_opt_bytecount_(cb) void* AllocateZeroInitializedMemory( size_t cb ); +// Valid Buffer extent is described by another parameter +#define _Ret_count_(size) _SAL1_1_Source_(_Ret_count_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__count_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_count_(size) _SAL1_1_Source_(_Ret_opt_count_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__count_impl(size)) _Ret_valid_impl_) +#define _Ret_bytecount_(size) _SAL1_1_Source_(_Ret_bytecount_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecount_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_bytecount_(size) _SAL1_1_Source_(_Ret_opt_bytecount_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecount_impl(size)) _Ret_valid_impl_) + +// Valid Buffer extent is described by a constant expression +#define _Ret_count_c_(size) _SAL1_1_Source_(_Ret_count_c_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__count_c_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_count_c_(size) _SAL1_1_Source_(_Ret_opt_count_c_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__count_c_impl(size)) _Ret_valid_impl_) +#define _Ret_bytecount_c_(size) _SAL1_1_Source_(_Ret_bytecount_c_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecount_c_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_bytecount_c_(size) _SAL1_1_Source_(_Ret_opt_bytecount_c_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecount_c_impl(size)) _Ret_valid_impl_) + +// Valid Buffer extent is described by a complex expression +#define _Ret_count_x_(size) _SAL1_1_Source_(_Ret_count_x_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__count_x_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_count_x_(size) _SAL1_1_Source_(_Ret_opt_count_x_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__count_x_impl(size)) _Ret_valid_impl_) +#define _Ret_bytecount_x_(size) _SAL1_1_Source_(_Ret_bytecount_x_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret1_impl_(__bytecount_x_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_bytecount_x_(size) _SAL1_1_Source_(_Ret_opt_bytecount_x_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret1_impl_(__bytecount_x_impl(size)) _Ret_valid_impl_) + +// return value is nullterminated and length is given by another parameter +#define _Ret_z_count_(size) _SAL1_1_Source_(_Ret_z_count_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret2_impl_(__zterm_impl,__count_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_z_count_(size) _SAL1_1_Source_(_Ret_opt_z_count_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret2_impl_(__zterm_impl,__count_impl(size)) _Ret_valid_impl_) +#define _Ret_z_bytecount_(size) _SAL1_1_Source_(_Ret_z_bytecount_, (size), _Ret1_impl_(__notnull_impl_notref) _Ret2_impl_(__zterm_impl,__bytecount_impl(size)) _Ret_valid_impl_) +#define _Ret_opt_z_bytecount_(size) _SAL1_1_Source_(_Ret_opt_z_bytecount_, (size), _Ret1_impl_(__maybenull_impl_notref) _Ret2_impl_(__zterm_impl,__bytecount_impl(size)) _Ret_valid_impl_) + + +// _Pre_ annotations --- +#define _Pre_opt_z_ _SAL1_1_Source_(_Pre_opt_z_, (), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__zterm_impl) _Pre_valid_impl_) + +// restrict access rights +#define _Pre_readonly_ _SAL1_1_Source_(_Pre_readonly_, (), _Pre1_impl_(__readaccess_impl_notref)) +#define _Pre_writeonly_ _SAL1_1_Source_(_Pre_writeonly_, (), _Pre1_impl_(__writeaccess_impl_notref)) + +// e.g. void FreeMemory( _Pre_bytecap_(cb) _Post_ptr_invalid_ void* pv, size_t cb ); +// buffer capacity described by another parameter +#define _Pre_cap_(size) _SAL1_1_Source_(_Pre_cap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_impl(size))) +#define _Pre_opt_cap_(size) _SAL1_1_Source_(_Pre_opt_cap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_impl(size))) +#define _Pre_bytecap_(size) _SAL1_1_Source_(_Pre_bytecap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_impl(size))) +#define _Pre_opt_bytecap_(size) _SAL1_1_Source_(_Pre_opt_bytecap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_impl(size))) + +// buffer capacity described by a constant expression +#define _Pre_cap_c_(size) _SAL1_1_Source_(_Pre_cap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_c_impl(size))) +#define _Pre_opt_cap_c_(size) _SAL1_1_Source_(_Pre_opt_cap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_c_impl(size))) +#define _Pre_bytecap_c_(size) _SAL1_1_Source_(_Pre_bytecap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_c_impl(size))) +#define _Pre_opt_bytecap_c_(size) _SAL1_1_Source_(_Pre_opt_bytecap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_c_impl(size))) +#define _Pre_cap_c_one_ _SAL1_1_Source_(_Pre_cap_c_one_, (), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_c_one_notref_impl)) +#define _Pre_opt_cap_c_one_ _SAL1_1_Source_(_Pre_opt_cap_c_one_, (), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_c_one_notref_impl)) + +// buffer capacity is described by another parameter multiplied by a constant expression +#define _Pre_cap_m_(mult,size) _SAL1_1_Source_(_Pre_cap_m_, (mult,size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__mult_impl(mult,size))) +#define _Pre_opt_cap_m_(mult,size) _SAL1_1_Source_(_Pre_opt_cap_m_, (mult,size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__mult_impl(mult,size))) + +// buffer capacity described by size of other buffer, only used by dangerous legacy APIs +// e.g. int strcpy(_Pre_cap_for_(src) char* dst, const char* src); +#define _Pre_cap_for_(param) _SAL1_1_Source_(_Pre_cap_for_, (param), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_for_impl(param))) +#define _Pre_opt_cap_for_(param) _SAL1_1_Source_(_Pre_opt_cap_for_, (param), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_for_impl(param))) + +// buffer capacity described by a complex condition +#define _Pre_cap_x_(size) _SAL1_1_Source_(_Pre_cap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_x_impl(size))) +#define _Pre_opt_cap_x_(size) _SAL1_1_Source_(_Pre_opt_cap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_x_impl(size))) +#define _Pre_bytecap_x_(size) _SAL1_1_Source_(_Pre_bytecap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_x_impl(size))) +#define _Pre_opt_bytecap_x_(size) _SAL1_1_Source_(_Pre_opt_bytecap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_x_impl(size))) + +// buffer capacity described by the difference to another pointer parameter +#define _Pre_ptrdiff_cap_(ptr) _SAL1_1_Source_(_Pre_ptrdiff_cap_, (ptr), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_x_impl(__ptrdiff(ptr)))) +#define _Pre_opt_ptrdiff_cap_(ptr) _SAL1_1_Source_(_Pre_opt_ptrdiff_cap_, (ptr), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_x_impl(__ptrdiff(ptr)))) + +// e.g. void AppendStr( _Pre_z_ const char* szFrom, _Pre_z_cap_(cchTo) _Post_z_ char* szTo, size_t cchTo ); +#define _Pre_z_cap_(size) _SAL1_1_Source_(_Pre_z_cap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_cap_(size) _SAL1_1_Source_(_Pre_opt_z_cap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_impl(size)) _Pre_valid_impl_) +#define _Pre_z_bytecap_(size) _SAL1_1_Source_(_Pre_z_bytecap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_bytecap_(size) _SAL1_1_Source_(_Pre_opt_z_bytecap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_impl(size)) _Pre_valid_impl_) + +#define _Pre_z_cap_c_(size) _SAL1_1_Source_(_Pre_z_cap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_cap_c_(size) _SAL1_1_Source_(_Pre_opt_z_cap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_z_bytecap_c_(size) _SAL1_1_Source_(_Pre_z_bytecap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_bytecap_c_(size) _SAL1_1_Source_(_Pre_opt_z_bytecap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_c_impl(size)) _Pre_valid_impl_) + +#define _Pre_z_cap_x_(size) _SAL1_1_Source_(_Pre_z_cap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_cap_x_(size) _SAL1_1_Source_(_Pre_opt_z_cap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__cap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_z_bytecap_x_(size) _SAL1_1_Source_(_Pre_z_bytecap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_z_bytecap_x_(size) _SAL1_1_Source_(_Pre_opt_z_bytecap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre2_impl_(__zterm_impl,__bytecap_x_impl(size)) _Pre_valid_impl_) + +// known capacity and valid but unknown readable extent +#define _Pre_valid_cap_(size) _SAL1_1_Source_(_Pre_valid_cap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_cap_(size) _SAL1_1_Source_(_Pre_opt_valid_cap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_impl(size)) _Pre_valid_impl_) +#define _Pre_valid_bytecap_(size) _SAL1_1_Source_(_Pre_valid_bytecap_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_bytecap_(size) _SAL1_1_Source_(_Pre_opt_valid_bytecap_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_impl(size)) _Pre_valid_impl_) + +#define _Pre_valid_cap_c_(size) _SAL1_1_Source_(_Pre_valid_cap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_cap_c_(size) _SAL1_1_Source_(_Pre_opt_valid_cap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_valid_bytecap_c_(size) _SAL1_1_Source_(_Pre_valid_bytecap_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_bytecap_c_(size) _SAL1_1_Source_(_Pre_opt_valid_bytecap_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_c_impl(size)) _Pre_valid_impl_) + +#define _Pre_valid_cap_x_(size) _SAL1_1_Source_(_Pre_valid_cap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_cap_x_(size) _SAL1_1_Source_(_Pre_opt_valid_cap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_valid_bytecap_x_(size) _SAL1_1_Source_(_Pre_valid_bytecap_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecap_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_valid_bytecap_x_(size) _SAL1_1_Source_(_Pre_opt_valid_bytecap_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecap_x_impl(size)) _Pre_valid_impl_) + +// e.g. void AppendCharRange( _Pre_count_(cchFrom) const char* rgFrom, size_t cchFrom, _Out_z_cap_(cchTo) char* szTo, size_t cchTo ); +// Valid buffer extent described by another parameter +#define _Pre_count_(size) _SAL1_1_Source_(_Pre_count_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__count_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_count_(size) _SAL1_1_Source_(_Pre_opt_count_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__count_impl(size)) _Pre_valid_impl_) +#define _Pre_bytecount_(size) _SAL1_1_Source_(_Pre_bytecount_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecount_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_bytecount_(size) _SAL1_1_Source_(_Pre_opt_bytecount_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecount_impl(size)) _Pre_valid_impl_) + +// Valid buffer extent described by a constant expression +#define _Pre_count_c_(size) _SAL1_1_Source_(_Pre_count_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__count_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_count_c_(size) _SAL1_1_Source_(_Pre_opt_count_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__count_c_impl(size)) _Pre_valid_impl_) +#define _Pre_bytecount_c_(size) _SAL1_1_Source_(_Pre_bytecount_c_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecount_c_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_bytecount_c_(size) _SAL1_1_Source_(_Pre_opt_bytecount_c_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecount_c_impl(size)) _Pre_valid_impl_) + +// Valid buffer extent described by a complex expression +#define _Pre_count_x_(size) _SAL1_1_Source_(_Pre_count_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__count_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_count_x_(size) _SAL1_1_Source_(_Pre_opt_count_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__count_x_impl(size)) _Pre_valid_impl_) +#define _Pre_bytecount_x_(size) _SAL1_1_Source_(_Pre_bytecount_x_, (size), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__bytecount_x_impl(size)) _Pre_valid_impl_) +#define _Pre_opt_bytecount_x_(size) _SAL1_1_Source_(_Pre_opt_bytecount_x_, (size), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__bytecount_x_impl(size)) _Pre_valid_impl_) + +// Valid buffer extent described by the difference to another pointer parameter +#define _Pre_ptrdiff_count_(ptr) _SAL1_1_Source_(_Pre_ptrdiff_count_, (ptr), _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__count_x_impl(__ptrdiff(ptr))) _Pre_valid_impl_) +#define _Pre_opt_ptrdiff_count_(ptr) _SAL1_1_Source_(_Pre_opt_ptrdiff_count_, (ptr), _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__count_x_impl(__ptrdiff(ptr))) _Pre_valid_impl_) + + +// char * strncpy(_Out_cap_(_Count) _Post_maybez_ char * _Dest, _In_z_ const char * _Source, _In_ size_t _Count) +// buffer maybe zero-terminated after the call +#define _Post_maybez_ _SAL_L_Source_(_Post_maybez_, (), _Post1_impl_(__maybezterm_impl)) + +// e.g. SIZE_T HeapSize( _In_ HANDLE hHeap, DWORD dwFlags, _Pre_notnull_ _Post_bytecap_(return) LPCVOID lpMem ); +#define _Post_cap_(size) _SAL1_1_Source_(_Post_cap_, (size), _Post1_impl_(__cap_impl(size))) +#define _Post_bytecap_(size) _SAL1_1_Source_(_Post_bytecap_, (size), _Post1_impl_(__bytecap_impl(size))) + +// e.g. int strlen( _In_z_ _Post_count_(return+1) const char* sz ); +#define _Post_count_(size) _SAL1_1_Source_(_Post_count_, (size), _Post1_impl_(__count_impl(size)) _Post_valid_impl_) +#define _Post_bytecount_(size) _SAL1_1_Source_(_Post_bytecount_, (size), _Post1_impl_(__bytecount_impl(size)) _Post_valid_impl_) +#define _Post_count_c_(size) _SAL1_1_Source_(_Post_count_c_, (size), _Post1_impl_(__count_c_impl(size)) _Post_valid_impl_) +#define _Post_bytecount_c_(size) _SAL1_1_Source_(_Post_bytecount_c_, (size), _Post1_impl_(__bytecount_c_impl(size)) _Post_valid_impl_) +#define _Post_count_x_(size) _SAL1_1_Source_(_Post_count_x_, (size), _Post1_impl_(__count_x_impl(size)) _Post_valid_impl_) +#define _Post_bytecount_x_(size) _SAL1_1_Source_(_Post_bytecount_x_, (size), _Post1_impl_(__bytecount_x_impl(size)) _Post_valid_impl_) + +// e.g. size_t CopyStr( _In_z_ const char* szFrom, _Pre_cap_(cch) _Post_z_count_(return+1) char* szFrom, size_t cchFrom ); +#define _Post_z_count_(size) _SAL1_1_Source_(_Post_z_count_, (size), _Post2_impl_(__zterm_impl,__count_impl(size)) _Post_valid_impl_) +#define _Post_z_bytecount_(size) _SAL1_1_Source_(_Post_z_bytecount_, (size), _Post2_impl_(__zterm_impl,__bytecount_impl(size)) _Post_valid_impl_) +#define _Post_z_count_c_(size) _SAL1_1_Source_(_Post_z_count_c_, (size), _Post2_impl_(__zterm_impl,__count_c_impl(size)) _Post_valid_impl_) +#define _Post_z_bytecount_c_(size) _SAL1_1_Source_(_Post_z_bytecount_c_, (size), _Post2_impl_(__zterm_impl,__bytecount_c_impl(size)) _Post_valid_impl_) +#define _Post_z_count_x_(size) _SAL1_1_Source_(_Post_z_count_x_, (size), _Post2_impl_(__zterm_impl,__count_x_impl(size)) _Post_valid_impl_) +#define _Post_z_bytecount_x_(size) _SAL1_1_Source_(_Post_z_bytecount_x_, (size), _Post2_impl_(__zterm_impl,__bytecount_x_impl(size)) _Post_valid_impl_) + +// +// _Prepost_ --- +// +// describing conditions that hold before and after the function call + +#define _Prepost_opt_z_ _SAL1_1_Source_(_Prepost_opt_z_, (), _Pre_opt_z_ _Post_z_) + +#define _Prepost_count_(size) _SAL1_1_Source_(_Prepost_count_, (size), _Pre_count_(size) _Post_count_(size)) +#define _Prepost_opt_count_(size) _SAL1_1_Source_(_Prepost_opt_count_, (size), _Pre_opt_count_(size) _Post_count_(size)) +#define _Prepost_bytecount_(size) _SAL1_1_Source_(_Prepost_bytecount_, (size), _Pre_bytecount_(size) _Post_bytecount_(size)) +#define _Prepost_opt_bytecount_(size) _SAL1_1_Source_(_Prepost_opt_bytecount_, (size), _Pre_opt_bytecount_(size) _Post_bytecount_(size)) +#define _Prepost_count_c_(size) _SAL1_1_Source_(_Prepost_count_c_, (size), _Pre_count_c_(size) _Post_count_c_(size)) +#define _Prepost_opt_count_c_(size) _SAL1_1_Source_(_Prepost_opt_count_c_, (size), _Pre_opt_count_c_(size) _Post_count_c_(size)) +#define _Prepost_bytecount_c_(size) _SAL1_1_Source_(_Prepost_bytecount_c_, (size), _Pre_bytecount_c_(size) _Post_bytecount_c_(size)) +#define _Prepost_opt_bytecount_c_(size) _SAL1_1_Source_(_Prepost_opt_bytecount_c_, (size), _Pre_opt_bytecount_c_(size) _Post_bytecount_c_(size)) +#define _Prepost_count_x_(size) _SAL1_1_Source_(_Prepost_count_x_, (size), _Pre_count_x_(size) _Post_count_x_(size)) +#define _Prepost_opt_count_x_(size) _SAL1_1_Source_(_Prepost_opt_count_x_, (size), _Pre_opt_count_x_(size) _Post_count_x_(size)) +#define _Prepost_bytecount_x_(size) _SAL1_1_Source_(_Prepost_bytecount_x_, (size), _Pre_bytecount_x_(size) _Post_bytecount_x_(size)) +#define _Prepost_opt_bytecount_x_(size) _SAL1_1_Source_(_Prepost_opt_bytecount_x_, (size), _Pre_opt_bytecount_x_(size) _Post_bytecount_x_(size)) + +#define _Prepost_valid_ _SAL1_1_Source_(_Prepost_valid_, (), _Pre_valid_ _Post_valid_) +#define _Prepost_opt_valid_ _SAL1_1_Source_(_Prepost_opt_valid_, (), _Pre_opt_valid_ _Post_valid_) + +// +// _Deref_ --- +// +// short version for _Deref_pre_ _Deref_post_ +// describing conditions for array elements or dereferenced pointer parameters that hold before and after the call + +#define _Deref_prepost_z_ _SAL1_1_Source_(_Deref_prepost_z_, (), _Deref_pre_z_ _Deref_post_z_) +#define _Deref_prepost_opt_z_ _SAL1_1_Source_(_Deref_prepost_opt_z_, (), _Deref_pre_opt_z_ _Deref_post_opt_z_) + +#define _Deref_prepost_cap_(size) _SAL1_1_Source_(_Deref_prepost_cap_, (size), _Deref_pre_cap_(size) _Deref_post_cap_(size)) +#define _Deref_prepost_opt_cap_(size) _SAL1_1_Source_(_Deref_prepost_opt_cap_, (size), _Deref_pre_opt_cap_(size) _Deref_post_opt_cap_(size)) +#define _Deref_prepost_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_bytecap_, (size), _Deref_pre_bytecap_(size) _Deref_post_bytecap_(size)) +#define _Deref_prepost_opt_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_opt_bytecap_, (size), _Deref_pre_opt_bytecap_(size) _Deref_post_opt_bytecap_(size)) + +#define _Deref_prepost_cap_x_(size) _SAL1_1_Source_(_Deref_prepost_cap_x_, (size), _Deref_pre_cap_x_(size) _Deref_post_cap_x_(size)) +#define _Deref_prepost_opt_cap_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_cap_x_, (size), _Deref_pre_opt_cap_x_(size) _Deref_post_opt_cap_x_(size)) +#define _Deref_prepost_bytecap_x_(size) _SAL1_1_Source_(_Deref_prepost_bytecap_x_, (size), _Deref_pre_bytecap_x_(size) _Deref_post_bytecap_x_(size)) +#define _Deref_prepost_opt_bytecap_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_bytecap_x_, (size), _Deref_pre_opt_bytecap_x_(size) _Deref_post_opt_bytecap_x_(size)) + +#define _Deref_prepost_z_cap_(size) _SAL1_1_Source_(_Deref_prepost_z_cap_, (size), _Deref_pre_z_cap_(size) _Deref_post_z_cap_(size)) +#define _Deref_prepost_opt_z_cap_(size) _SAL1_1_Source_(_Deref_prepost_opt_z_cap_, (size), _Deref_pre_opt_z_cap_(size) _Deref_post_opt_z_cap_(size)) +#define _Deref_prepost_z_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_z_bytecap_, (size), _Deref_pre_z_bytecap_(size) _Deref_post_z_bytecap_(size)) +#define _Deref_prepost_opt_z_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_opt_z_bytecap_, (size), _Deref_pre_opt_z_bytecap_(size) _Deref_post_opt_z_bytecap_(size)) + +#define _Deref_prepost_valid_cap_(size) _SAL1_1_Source_(_Deref_prepost_valid_cap_, (size), _Deref_pre_valid_cap_(size) _Deref_post_valid_cap_(size)) +#define _Deref_prepost_opt_valid_cap_(size) _SAL1_1_Source_(_Deref_prepost_opt_valid_cap_, (size), _Deref_pre_opt_valid_cap_(size) _Deref_post_opt_valid_cap_(size)) +#define _Deref_prepost_valid_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_valid_bytecap_, (size), _Deref_pre_valid_bytecap_(size) _Deref_post_valid_bytecap_(size)) +#define _Deref_prepost_opt_valid_bytecap_(size) _SAL1_1_Source_(_Deref_prepost_opt_valid_bytecap_, (size), _Deref_pre_opt_valid_bytecap_(size) _Deref_post_opt_valid_bytecap_(size)) + +#define _Deref_prepost_valid_cap_x_(size) _SAL1_1_Source_(_Deref_prepost_valid_cap_x_, (size), _Deref_pre_valid_cap_x_(size) _Deref_post_valid_cap_x_(size)) +#define _Deref_prepost_opt_valid_cap_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_valid_cap_x_, (size), _Deref_pre_opt_valid_cap_x_(size) _Deref_post_opt_valid_cap_x_(size)) +#define _Deref_prepost_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_prepost_valid_bytecap_x_, (size), _Deref_pre_valid_bytecap_x_(size) _Deref_post_valid_bytecap_x_(size)) +#define _Deref_prepost_opt_valid_bytecap_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_valid_bytecap_x_, (size), _Deref_pre_opt_valid_bytecap_x_(size) _Deref_post_opt_valid_bytecap_x_(size)) + +#define _Deref_prepost_count_(size) _SAL1_1_Source_(_Deref_prepost_count_, (size), _Deref_pre_count_(size) _Deref_post_count_(size)) +#define _Deref_prepost_opt_count_(size) _SAL1_1_Source_(_Deref_prepost_opt_count_, (size), _Deref_pre_opt_count_(size) _Deref_post_opt_count_(size)) +#define _Deref_prepost_bytecount_(size) _SAL1_1_Source_(_Deref_prepost_bytecount_, (size), _Deref_pre_bytecount_(size) _Deref_post_bytecount_(size)) +#define _Deref_prepost_opt_bytecount_(size) _SAL1_1_Source_(_Deref_prepost_opt_bytecount_, (size), _Deref_pre_opt_bytecount_(size) _Deref_post_opt_bytecount_(size)) + +#define _Deref_prepost_count_x_(size) _SAL1_1_Source_(_Deref_prepost_count_x_, (size), _Deref_pre_count_x_(size) _Deref_post_count_x_(size)) +#define _Deref_prepost_opt_count_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_count_x_, (size), _Deref_pre_opt_count_x_(size) _Deref_post_opt_count_x_(size)) +#define _Deref_prepost_bytecount_x_(size) _SAL1_1_Source_(_Deref_prepost_bytecount_x_, (size), _Deref_pre_bytecount_x_(size) _Deref_post_bytecount_x_(size)) +#define _Deref_prepost_opt_bytecount_x_(size) _SAL1_1_Source_(_Deref_prepost_opt_bytecount_x_, (size), _Deref_pre_opt_bytecount_x_(size) _Deref_post_opt_bytecount_x_(size)) + +#define _Deref_prepost_valid_ _SAL1_1_Source_(_Deref_prepost_valid_, (), _Deref_pre_valid_ _Deref_post_valid_) +#define _Deref_prepost_opt_valid_ _SAL1_1_Source_(_Deref_prepost_opt_valid_, (), _Deref_pre_opt_valid_ _Deref_post_opt_valid_) + +// +// _Deref_ +// +// used with references to arrays + +#define _Deref_out_z_cap_c_(size) _SAL1_1_Source_(_Deref_out_z_cap_c_, (size), _Deref_pre_cap_c_(size) _Deref_post_z_) +#define _Deref_inout_z_cap_c_(size) _SAL1_1_Source_(_Deref_inout_z_cap_c_, (size), _Deref_pre_z_cap_c_(size) _Deref_post_z_) +#define _Deref_out_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_out_z_bytecap_c_, (size), _Deref_pre_bytecap_c_(size) _Deref_post_z_) +#define _Deref_inout_z_bytecap_c_(size) _SAL1_1_Source_(_Deref_inout_z_bytecap_c_, (size), _Deref_pre_z_bytecap_c_(size) _Deref_post_z_) +#define _Deref_inout_z_ _SAL1_1_Source_(_Deref_inout_z_, (), _Deref_prepost_z_) + +#pragma endregion Input Buffer SAL 1 compatibility macros + + +//============================================================================ +// Implementation Layer: +//============================================================================ + + +// Naming conventions: +// A symbol the begins with _SA_ is for the machinery of creating any +// annotations; many of those come from sourceannotations.h in the case +// of attributes. + +// A symbol that ends with _impl is the very lowest level macro. It is +// not required to be a legal standalone annotation, and in the case +// of attribute annotations, usually is not. (In the case of some declspec +// annotations, it might be, but it should not be assumed so.) Those +// symbols will be used in the _PreN..., _PostN... and _RetN... annotations +// to build up more complete annotations. + +// A symbol ending in _impl_ is reserved to the implementation as well, +// but it does form a complete annotation; usually they are used to build +// up even higher level annotations. + + +#if _USE_ATTRIBUTES_FOR_SAL || _USE_DECLSPECS_FOR_SAL // [ +// Sharable "_impl" macros: these can be shared between the various annotation +// forms but are part of the implementation of the macros. These are collected +// here to assure that only necessary differences in the annotations +// exist. + +#define _Always_impl_(annos) _Group_(annos _SAL_nop_impl_) _On_failure_impl_(annos _SAL_nop_impl_) +#define _Bound_impl_ _SA_annotes0(SAL_bound) +#define _Field_range_impl_(min,max) _Range_impl_(min,max) +#define _Literal_impl_ _SA_annotes1(SAL_constant, __yes) +#define _Maybenull_impl_ _SA_annotes1(SAL_null, __maybe) +#define _Maybevalid_impl_ _SA_annotes1(SAL_valid, __maybe) +#define _Must_inspect_impl_ _Post_impl_ _SA_annotes0(SAL_mustInspect) +#define _Notliteral_impl_ _SA_annotes1(SAL_constant, __no) +#define _Notnull_impl_ _SA_annotes1(SAL_null, __no) +#define _Notvalid_impl_ _SA_annotes1(SAL_valid, __no) +#define _NullNull_terminated_impl_ _Group_(_SA_annotes1(SAL_nullTerminated, __yes) _SA_annotes1(SAL_readableTo,inexpressibleCount("NullNull terminated string"))) +#define _Null_impl_ _SA_annotes1(SAL_null, __yes) +#define _Null_terminated_impl_ _SA_annotes1(SAL_nullTerminated, __yes) +#define _Out_impl_ _Pre1_impl_(__notnull_impl_notref) _Pre1_impl_(__cap_c_one_notref_impl) _Post_valid_impl_ +#define _Out_opt_impl_ _Pre1_impl_(__maybenull_impl_notref) _Pre1_impl_(__cap_c_one_notref_impl) _Post_valid_impl_ +#define _Points_to_data_impl_ _At_(*_Curr_, _SA_annotes1(SAL_mayBePointer, __no)) +#define _Post_satisfies_impl_(cond) _Post_impl_ _Satisfies_impl_(cond) +#define _Post_valid_impl_ _Post1_impl_(__valid_impl) +#define _Pre_satisfies_impl_(cond) _Pre_impl_ _Satisfies_impl_(cond) +#define _Pre_valid_impl_ _Pre1_impl_(__valid_impl) +#define _Range_impl_(min,max) _SA_annotes2(SAL_range, min, max) +#define _Readable_bytes_impl_(size) _SA_annotes1(SAL_readableTo, byteCount(size)) +#define _Readable_elements_impl_(size) _SA_annotes1(SAL_readableTo, elementCount(size)) +#define _Ret_valid_impl_ _Ret1_impl_(__valid_impl) +#define _Satisfies_impl_(cond) _SA_annotes1(SAL_satisfies, cond) +#define _Valid_impl_ _SA_annotes1(SAL_valid, __yes) +#define _Writable_bytes_impl_(size) _SA_annotes1(SAL_writableTo, byteCount(size)) +#define _Writable_elements_impl_(size) _SA_annotes1(SAL_writableTo, elementCount(size)) + +#define _In_range_impl_(min,max) _Pre_impl_ _Range_impl_(min,max) +#define _Out_range_impl_(min,max) _Post_impl_ _Range_impl_(min,max) +#define _Ret_range_impl_(min,max) _Post_impl_ _Range_impl_(min,max) +#define _Deref_in_range_impl_(min,max) _Deref_pre_impl_ _Range_impl_(min,max) +#define _Deref_out_range_impl_(min,max) _Deref_post_impl_ _Range_impl_(min,max) +#define _Deref_ret_range_impl_(min,max) _Deref_post_impl_ _Range_impl_(min,max) + +#define _Deref_pre_impl_ _Pre_impl_ _Notref_impl_ _Deref_impl_ +#define _Deref_post_impl_ _Post_impl_ _Notref_impl_ _Deref_impl_ + +// The following are for the implementation machinery, and are not +// suitable for annotating general code. +// We're tying to phase this out, someday. The parser quotes the param. +#define __AuToQuOtE _SA_annotes0(SAL_AuToQuOtE) + +// Normally the parser does some simple type checking of annotation params, +// defer that check to the plugin. +#define __deferTypecheck _SA_annotes0(SAL_deferTypecheck) + +#define _SA_SPECSTRIZE( x ) #x +#define _SAL_nop_impl_ /* nothing */ +#define __nop_impl(x) x +#endif + + +#if _USE_ATTRIBUTES_FOR_SAL // [ + +// Using attributes for sal + +#include "CodeAnalysis/sourceannotations.h" + + +#define _SA_annotes0(n) [SAL_annotes(Name=#n)] +#define _SA_annotes1(n,pp1) [SAL_annotes(Name=#n, p1=_SA_SPECSTRIZE(pp1))] +#define _SA_annotes2(n,pp1,pp2) [SAL_annotes(Name=#n, p1=_SA_SPECSTRIZE(pp1), p2=_SA_SPECSTRIZE(pp2))] +#define _SA_annotes3(n,pp1,pp2,pp3) [SAL_annotes(Name=#n, p1=_SA_SPECSTRIZE(pp1), p2=_SA_SPECSTRIZE(pp2), p3=_SA_SPECSTRIZE(pp3))] + +#define _Pre_impl_ [SAL_pre] +#define _Post_impl_ [SAL_post] +#define _Deref_impl_ [SAL_deref] +#define _Notref_impl_ [SAL_notref] + + +// Declare a function to be an annotation or primop (respectively). +// Done this way so that they don't appear in the regular compiler's +// namespace. +#define __ANNOTATION(fun) _SA_annotes0(SAL_annotation) void __SA_##fun; +#define __PRIMOP(type, fun) _SA_annotes0(SAL_primop) type __SA_##fun; +#define __QUALIFIER(fun) _SA_annotes0(SAL_qualifier) void __SA_##fun; + +// Benign declspec needed here for WindowsPREfast +#define __In_impl_ [SA_Pre(Valid=SA_Yes)] [SA_Pre(Deref=1, Notref=1, Access=SA_Read)] __declspec("SAL_pre SAL_valid") + +#elif _USE_DECLSPECS_FOR_SAL // ][ + +// Using declspecs for sal + +#define _SA_annotes0(n) __declspec(#n) +#define _SA_annotes1(n,pp1) __declspec(#n "(" _SA_SPECSTRIZE(pp1) ")" ) +#define _SA_annotes2(n,pp1,pp2) __declspec(#n "(" _SA_SPECSTRIZE(pp1) "," _SA_SPECSTRIZE(pp2) ")") +#define _SA_annotes3(n,pp1,pp2,pp3) __declspec(#n "(" _SA_SPECSTRIZE(pp1) "," _SA_SPECSTRIZE(pp2) "," _SA_SPECSTRIZE(pp3) ")") + +#define _Pre_impl_ _SA_annotes0(SAL_pre) +#define _Post_impl_ _SA_annotes0(SAL_post) +#define _Deref_impl_ _SA_annotes0(SAL_deref) +#define _Notref_impl_ _SA_annotes0(SAL_notref) + +// Declare a function to be an annotation or primop (respectively). +// Done this way so that they don't appear in the regular compiler's +// namespace. +#define __ANNOTATION(fun) _SA_annotes0(SAL_annotation) void __SA_##fun + +#define __PRIMOP(type, fun) _SA_annotes0(SAL_primop) type __SA_##fun + +#define __QUALIFIER(fun) _SA_annotes0(SAL_qualifier) void __SA_##fun; + +#define __In_impl_ _Pre_impl_ _SA_annotes0(SAL_valid) _Pre_impl_ _Deref_impl_ _Notref_impl_ _SA_annotes0(SAL_readonly) + +#else // ][ + +// Using "nothing" for sal + +#define _SA_annotes0(n) +#define _SA_annotes1(n,pp1) +#define _SA_annotes2(n,pp1,pp2) +#define _SA_annotes3(n,pp1,pp2,pp3) + +#define __ANNOTATION(fun) +#define __PRIMOP(type, fun) +#define __QUALIFIER(type, fun) + +#endif // ] + +#if _USE_ATTRIBUTES_FOR_SAL || _USE_DECLSPECS_FOR_SAL // [ + +// Declare annotations that need to be declared. +__ANNOTATION(SAL_useHeader(void)); +__ANNOTATION(SAL_bound(void)); +__ANNOTATION(SAL_allocator(void)); //??? resolve with PFD +__ANNOTATION(SAL_file_parser(__AuToQuOtE __In_impl_ char *, __In_impl_ char *)); +__ANNOTATION(SAL_source_code_content(__In_impl_ char *)); +__ANNOTATION(SAL_analysisHint(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_untrusted_data_source(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_untrusted_data_source_this(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_validated(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_validated_this(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_encoded(void)); +__ANNOTATION(SAL_adt(__AuToQuOtE __In_impl_ char *, __AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_add_adt_property(__AuToQuOtE __In_impl_ char *, __AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_remove_adt_property(__AuToQuOtE __In_impl_ char *, __AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_transfer_adt_property_from(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_post_type(__AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_volatile(void)); +__ANNOTATION(SAL_nonvolatile(void)); +__ANNOTATION(SAL_entrypoint(__AuToQuOtE __In_impl_ char *, __AuToQuOtE __In_impl_ char *)); +__ANNOTATION(SAL_blocksOn(__In_impl_ void*)); +__ANNOTATION(SAL_mustInspect(void)); + +// Only appears in model files, but needs to be declared. +__ANNOTATION(SAL_TypeName(__AuToQuOtE __In_impl_ char *)); + +// To be declared well-known soon. +__ANNOTATION(SAL_interlocked(void);) + +__QUALIFIER(SAL_name(__In_impl_ char *, __In_impl_ char *, __In_impl_ char *);) + +__PRIMOP(char *, _Macro_value_(__In_impl_ char *)); +__PRIMOP(int, _Macro_defined_(__In_impl_ char *)); +__PRIMOP(char *, _Strstr_(__In_impl_ char *, __In_impl_ char *)); + +#endif // ] + +#if _USE_ATTRIBUTES_FOR_SAL // [ + +#define _Check_return_impl_ [SA_Post(MustCheck=SA_Yes)] + +#define _Success_impl_(expr) [SA_Success(Condition=#expr)] +#define _On_failure_impl_(annos) [SAL_context(p1="SAL_failed")] _Group_(_Post_impl_ _Group_(annos _SAL_nop_impl_)) + +#define _Printf_format_string_impl_ [SA_FormatString(Style="printf")] +#define _Scanf_format_string_impl_ [SA_FormatString(Style="scanf")] +#define _Scanf_s_format_string_impl_ [SA_FormatString(Style="scanf_s")] + +#define _In_bound_impl_ [SA_PreBound(Deref=0)] +#define _Out_bound_impl_ [SA_PostBound(Deref=0)] +#define _Ret_bound_impl_ [SA_PostBound(Deref=0)] +#define _Deref_in_bound_impl_ [SA_PreBound(Deref=1)] +#define _Deref_out_bound_impl_ [SA_PostBound(Deref=1)] +#define _Deref_ret_bound_impl_ [SA_PostBound(Deref=1)] + +#define __valid_impl Valid=SA_Yes +#define __maybevalid_impl Valid=SA_Maybe +#define __notvalid_impl Valid=SA_No + +#define __null_impl Null=SA_Yes +#define __maybenull_impl Null=SA_Maybe +#define __notnull_impl Null=SA_No + +#define __null_impl_notref Null=SA_Yes,Notref=1 +#define __maybenull_impl_notref Null=SA_Maybe,Notref=1 +#define __notnull_impl_notref Null=SA_No,Notref=1 + +#define __zterm_impl NullTerminated=SA_Yes +#define __maybezterm_impl NullTerminated=SA_Maybe +#define __maybzterm_impl NullTerminated=SA_Maybe +#define __notzterm_impl NullTerminated=SA_No + +#define __readaccess_impl Access=SA_Read +#define __writeaccess_impl Access=SA_Write +#define __allaccess_impl Access=SA_ReadWrite + +#define __readaccess_impl_notref Access=SA_Read,Notref=1 +#define __writeaccess_impl_notref Access=SA_Write,Notref=1 +#define __allaccess_impl_notref Access=SA_ReadWrite,Notref=1 + +// For SAL2, we need to expect general expressions. + +#define __cap_impl(size) WritableElements="\n"#size +#define __bytecap_impl(size) WritableBytes="\n"#size +#define __bytecount_impl(size) ValidBytes="\n"#size +#define __count_impl(size) ValidElements="\n"#size + +#define __cap_c_impl(size) WritableElementsConst=size +#define __cap_c_one_notref_impl WritableElementsConst=1,Notref=1 +#define __cap_for_impl(param) WritableElementsLength=#param +#define __cap_x_impl(size) WritableElements="\n@"#size + +#define __bytecap_c_impl(size) WritableBytesConst=size +#define __bytecap_x_impl(size) WritableBytes="\n@"#size + +#define __mult_impl(mult,size) __cap_impl((mult)*(size)) + +#define __count_c_impl(size) ValidElementsConst=size +#define __count_x_impl(size) ValidElements="\n@"#size + +#define __bytecount_c_impl(size) ValidBytesConst=size +#define __bytecount_x_impl(size) ValidBytes="\n@"#size + + +#define _At_impl_(target, annos) [SAL_at(p1=#target)] _Group_(annos) +#define _At_buffer_impl_(target, iter, bound, annos) [SAL_at_buffer(p1=#target, p2=#iter, p3=#bound)] _Group_(annos) +#define _When_impl_(expr, annos) [SAL_when(p1=#expr)] _Group_(annos) + +#define _Group_impl_(annos) [SAL_begin] annos [SAL_end] +#define _GrouP_impl_(annos) [SAL_BEGIN] annos [SAL_END] + +#define _Use_decl_anno_impl_ _SA_annotes0(SAL_useHeader) // this is a special case! + +#define _Pre1_impl_(p1) [SA_Pre(p1)] +#define _Pre2_impl_(p1,p2) [SA_Pre(p1,p2)] +#define _Pre3_impl_(p1,p2,p3) [SA_Pre(p1,p2,p3)] + +#define _Post1_impl_(p1) [SA_Post(p1)] +#define _Post2_impl_(p1,p2) [SA_Post(p1,p2)] +#define _Post3_impl_(p1,p2,p3) [SA_Post(p1,p2,p3)] + +#define _Ret1_impl_(p1) [SA_Post(p1)] +#define _Ret2_impl_(p1,p2) [SA_Post(p1,p2)] +#define _Ret3_impl_(p1,p2,p3) [SA_Post(p1,p2,p3)] + +#define _Deref_pre1_impl_(p1) [SA_Pre(Deref=1,p1)] +#define _Deref_pre2_impl_(p1,p2) [SA_Pre(Deref=1,p1,p2)] +#define _Deref_pre3_impl_(p1,p2,p3) [SA_Pre(Deref=1,p1,p2,p3)] + + +#define _Deref_post1_impl_(p1) [SA_Post(Deref=1,p1)] +#define _Deref_post2_impl_(p1,p2) [SA_Post(Deref=1,p1,p2)] +#define _Deref_post3_impl_(p1,p2,p3) [SA_Post(Deref=1,p1,p2,p3)] + +#define _Deref_ret1_impl_(p1) [SA_Post(Deref=1,p1)] +#define _Deref_ret2_impl_(p1,p2) [SA_Post(Deref=1,p1,p2)] +#define _Deref_ret3_impl_(p1,p2,p3) [SA_Post(Deref=1,p1,p2,p3)] + +#define _Deref2_pre1_impl_(p1) [SA_Pre(Deref=2,Notref=1,p1)] +#define _Deref2_post1_impl_(p1) [SA_Post(Deref=2,Notref=1,p1)] +#define _Deref2_ret1_impl_(p1) [SA_Post(Deref=2,Notref=1,p1)] + +// Obsolete -- may be needed for transition to attributes. +#define __inner_typefix(ctype) [SAL_typefix(p1=_SA_SPECSTRIZE(ctype))] +#define __inner_exceptthat [SAL_except] + + +#elif _USE_DECLSPECS_FOR_SAL // ][ + +#define _Check_return_impl_ __post _SA_annotes0(SAL_checkReturn) + +#define _Success_impl_(expr) _SA_annotes1(SAL_success, expr) +#define _On_failure_impl_(annos) _SA_annotes1(SAL_context, SAL_failed) _Group_(_Post_impl_ _Group_(_SAL_nop_impl_ annos)) + +#define _Printf_format_string_impl_ _SA_annotes1(SAL_IsFormatString, "printf") +#define _Scanf_format_string_impl_ _SA_annotes1(SAL_IsFormatString, "scanf") +#define _Scanf_s_format_string_impl_ _SA_annotes1(SAL_IsFormatString, "scanf_s") + +#define _In_bound_impl_ _Pre_impl_ _Bound_impl_ +#define _Out_bound_impl_ _Post_impl_ _Bound_impl_ +#define _Ret_bound_impl_ _Post_impl_ _Bound_impl_ +#define _Deref_in_bound_impl_ _Deref_pre_impl_ _Bound_impl_ +#define _Deref_out_bound_impl_ _Deref_post_impl_ _Bound_impl_ +#define _Deref_ret_bound_impl_ _Deref_post_impl_ _Bound_impl_ + + +#define __null_impl _SA_annotes0(SAL_null) // _SA_annotes1(SAL_null, __yes) +#define __notnull_impl _SA_annotes0(SAL_notnull) // _SA_annotes1(SAL_null, __no) +#define __maybenull_impl _SA_annotes0(SAL_maybenull) // _SA_annotes1(SAL_null, __maybe) + +#define __valid_impl _SA_annotes0(SAL_valid) // _SA_annotes1(SAL_valid, __yes) +#define __notvalid_impl _SA_annotes0(SAL_notvalid) // _SA_annotes1(SAL_valid, __no) +#define __maybevalid_impl _SA_annotes0(SAL_maybevalid) // _SA_annotes1(SAL_valid, __maybe) + +#define __null_impl_notref _Notref_ _Null_impl_ +#define __maybenull_impl_notref _Notref_ _Maybenull_impl_ +#define __notnull_impl_notref _Notref_ _Notnull_impl_ + +#define __zterm_impl _SA_annotes1(SAL_nullTerminated, __yes) +#define __maybezterm_impl _SA_annotes1(SAL_nullTerminated, __maybe) +#define __maybzterm_impl _SA_annotes1(SAL_nullTerminated, __maybe) +#define __notzterm_impl _SA_annotes1(SAL_nullTerminated, __no) + +#define __readaccess_impl _SA_annotes1(SAL_access, 0x1) +#define __writeaccess_impl _SA_annotes1(SAL_access, 0x2) +#define __allaccess_impl _SA_annotes1(SAL_access, 0x3) + +#define __readaccess_impl_notref _Notref_ _SA_annotes1(SAL_access, 0x1) +#define __writeaccess_impl_notref _Notref_ _SA_annotes1(SAL_access, 0x2) +#define __allaccess_impl_notref _Notref_ _SA_annotes1(SAL_access, 0x3) + +#define __cap_impl(size) _SA_annotes1(SAL_writableTo,elementCount(size)) +#define __cap_c_impl(size) _SA_annotes1(SAL_writableTo,elementCount(size)) +#define __cap_c_one_notref_impl _Notref_ _SA_annotes1(SAL_writableTo,elementCount(1)) +#define __cap_for_impl(param) _SA_annotes1(SAL_writableTo,inexpressibleCount(sizeof(param))) +#define __cap_x_impl(size) _SA_annotes1(SAL_writableTo,inexpressibleCount(#size)) + +#define __bytecap_impl(size) _SA_annotes1(SAL_writableTo,byteCount(size)) +#define __bytecap_c_impl(size) _SA_annotes1(SAL_writableTo,byteCount(size)) +#define __bytecap_x_impl(size) _SA_annotes1(SAL_writableTo,inexpressibleCount(#size)) + +#define __mult_impl(mult,size) _SA_annotes1(SAL_writableTo,(mult)*(size)) + +#define __count_impl(size) _SA_annotes1(SAL_readableTo,elementCount(size)) +#define __count_c_impl(size) _SA_annotes1(SAL_readableTo,elementCount(size)) +#define __count_x_impl(size) _SA_annotes1(SAL_readableTo,inexpressibleCount(#size)) + +#define __bytecount_impl(size) _SA_annotes1(SAL_readableTo,byteCount(size)) +#define __bytecount_c_impl(size) _SA_annotes1(SAL_readableTo,byteCount(size)) +#define __bytecount_x_impl(size) _SA_annotes1(SAL_readableTo,inexpressibleCount(#size)) + +#define _At_impl_(target, annos) _SA_annotes0(SAL_at(target)) _Group_(annos) +#define _At_buffer_impl_(target, iter, bound, annos) _SA_annotes3(SAL_at_buffer, target, iter, bound) _Group_(annos) +#define _Group_impl_(annos) _SA_annotes0(SAL_begin) annos _SA_annotes0(SAL_end) +#define _GrouP_impl_(annos) _SA_annotes0(SAL_BEGIN) annos _SA_annotes0(SAL_END) +#define _When_impl_(expr, annos) _SA_annotes0(SAL_when(expr)) _Group_(annos) + +#define _Use_decl_anno_impl_ __declspec("SAL_useHeader()") // this is a special case! + +#define _Pre1_impl_(p1) _Pre_impl_ p1 +#define _Pre2_impl_(p1,p2) _Pre_impl_ p1 _Pre_impl_ p2 +#define _Pre3_impl_(p1,p2,p3) _Pre_impl_ p1 _Pre_impl_ p2 _Pre_impl_ p3 + +#define _Post1_impl_(p1) _Post_impl_ p1 +#define _Post2_impl_(p1,p2) _Post_impl_ p1 _Post_impl_ p2 +#define _Post3_impl_(p1,p2,p3) _Post_impl_ p1 _Post_impl_ p2 _Post_impl_ p3 + +#define _Ret1_impl_(p1) _Post_impl_ p1 +#define _Ret2_impl_(p1,p2) _Post_impl_ p1 _Post_impl_ p2 +#define _Ret3_impl_(p1,p2,p3) _Post_impl_ p1 _Post_impl_ p2 _Post_impl_ p3 + +#define _Deref_pre1_impl_(p1) _Deref_pre_impl_ p1 +#define _Deref_pre2_impl_(p1,p2) _Deref_pre_impl_ p1 _Deref_pre_impl_ p2 +#define _Deref_pre3_impl_(p1,p2,p3) _Deref_pre_impl_ p1 _Deref_pre_impl_ p2 _Deref_pre_impl_ p3 + +#define _Deref_post1_impl_(p1) _Deref_post_impl_ p1 +#define _Deref_post2_impl_(p1,p2) _Deref_post_impl_ p1 _Deref_post_impl_ p2 +#define _Deref_post3_impl_(p1,p2,p3) _Deref_post_impl_ p1 _Deref_post_impl_ p2 _Deref_post_impl_ p3 + +#define _Deref_ret1_impl_(p1) _Deref_post_impl_ p1 +#define _Deref_ret2_impl_(p1,p2) _Deref_post_impl_ p1 _Deref_post_impl_ p2 +#define _Deref_ret3_impl_(p1,p2,p3) _Deref_post_impl_ p1 _Deref_post_impl_ p2 _Deref_post_impl_ p3 + +#define _Deref2_pre1_impl_(p1) _Deref_pre_impl_ _Notref_impl_ _Deref_impl_ p1 +#define _Deref2_post1_impl_(p1) _Deref_post_impl_ _Notref_impl_ _Deref_impl_ p1 +#define _Deref2_ret1_impl_(p1) _Deref_post_impl_ _Notref_impl_ _Deref_impl_ p1 + +#define __inner_typefix(ctype) _SA_annotes1(SAL_typefix, ctype) +#define __inner_exceptthat _SA_annotes0(SAL_except) + +#elif defined(_MSC_EXTENSIONS) && !defined( MIDL_PASS ) && !defined(__midl) && !defined(RC_INVOKED) && defined(_PFT_VER) // ][ + +// minimum attribute expansion for foreground build + +#pragma push_macro( "SA" ) +#pragma push_macro( "REPEATABLE" ) + +#ifdef __cplusplus // [ +#define SA( id ) id +#define REPEATABLE [repeatable] +#else // !__cplusplus // ][ +#define SA( id ) SA_##id +#define REPEATABLE +#endif // !__cplusplus // ] + +REPEATABLE +[source_annotation_attribute( SA( Parameter ) )] +struct __P_impl +{ +#ifdef __cplusplus // [ + __P_impl(); +#endif // ] + int __d_; +}; +typedef struct __P_impl __P_impl; + +REPEATABLE +[source_annotation_attribute( SA( ReturnValue ) )] +struct __R_impl +{ +#ifdef __cplusplus // [ + __R_impl(); +#endif // ] + int __d_; +}; +typedef struct __R_impl __R_impl; + +[source_annotation_attribute( SA( Method ) )] +struct __M_ +{ +#ifdef __cplusplus // [ + __M_(); +#endif // ] + int __d_; +}; +typedef struct __M_ __M_; + +[source_annotation_attribute( SA( All ) )] +struct __A_ +{ +#ifdef __cplusplus // [ + __A_(); +#endif // ] + int __d_; +}; +typedef struct __A_ __A_; + +[source_annotation_attribute( SA( Field ) )] +struct __F_ +{ +#ifdef __cplusplus // [ + __F_(); +#endif // ] + int __d_; +}; +typedef struct __F_ __F_; + +#pragma pop_macro( "REPEATABLE" ) +#pragma pop_macro( "SA" ) + + +#define _SAL_nop_impl_ + +#define _At_impl_(target, annos) [__A_(__d_=0)] +#define _At_buffer_impl_(target, iter, bound, annos) [__A_(__d_=0)] +#define _When_impl_(expr, annos) annos +#define _Group_impl_(annos) annos +#define _GrouP_impl_(annos) annos +#define _Use_decl_anno_impl_ [__M_(__d_=0)] + +#define _Points_to_data_impl_ [__P_impl(__d_=0)] +#define _Literal_impl_ [__P_impl(__d_=0)] +#define _Notliteral_impl_ [__P_impl(__d_=0)] + +#define _Pre_valid_impl_ [__P_impl(__d_=0)] +#define _Post_valid_impl_ [__P_impl(__d_=0)] +#define _Ret_valid_impl_ [__R_impl(__d_=0)] + +#define _Check_return_impl_ [__R_impl(__d_=0)] +#define _Must_inspect_impl_ [__R_impl(__d_=0)] + +#define _Success_impl_(expr) [__M_(__d_=0)] +#define _On_failure_impl_(expr) [__M_(__d_=0)] +#define _Always_impl_(expr) [__M_(__d_=0)] + +#define _Printf_format_string_impl_ [__P_impl(__d_=0)] +#define _Scanf_format_string_impl_ [__P_impl(__d_=0)] +#define _Scanf_s_format_string_impl_ [__P_impl(__d_=0)] + +#define _Raises_SEH_exception_impl_ [__M_(__d_=0)] +#define _Maybe_raises_SEH_exception_impl_ [__M_(__d_=0)] + +#define _In_bound_impl_ [__P_impl(__d_=0)] +#define _Out_bound_impl_ [__P_impl(__d_=0)] +#define _Ret_bound_impl_ [__R_impl(__d_=0)] +#define _Deref_in_bound_impl_ [__P_impl(__d_=0)] +#define _Deref_out_bound_impl_ [__P_impl(__d_=0)] +#define _Deref_ret_bound_impl_ [__R_impl(__d_=0)] + +#define _Range_impl_(min,max) [__P_impl(__d_=0)] +#define _In_range_impl_(min,max) [__P_impl(__d_=0)] +#define _Out_range_impl_(min,max) [__P_impl(__d_=0)] +#define _Ret_range_impl_(min,max) [__R_impl(__d_=0)] +#define _Deref_in_range_impl_(min,max) [__P_impl(__d_=0)] +#define _Deref_out_range_impl_(min,max) [__P_impl(__d_=0)] +#define _Deref_ret_range_impl_(min,max) [__R_impl(__d_=0)] + +#define _Field_range_impl_(min,max) [__F_(__d_=0)] + +#define _Pre_satisfies_impl_(cond) [__A_(__d_=0)] +#define _Post_satisfies_impl_(cond) [__A_(__d_=0)] +#define _Satisfies_impl_(cond) [__A_(__d_=0)] + +#define _Null_impl_ [__A_(__d_=0)] +#define _Notnull_impl_ [__A_(__d_=0)] +#define _Maybenull_impl_ [__A_(__d_=0)] + +#define _Valid_impl_ [__A_(__d_=0)] +#define _Notvalid_impl_ [__A_(__d_=0)] +#define _Maybevalid_impl_ [__A_(__d_=0)] + +#define _Readable_bytes_impl_(size) [__A_(__d_=0)] +#define _Readable_elements_impl_(size) [__A_(__d_=0)] +#define _Writable_bytes_impl_(size) [__A_(__d_=0)] +#define _Writable_elements_impl_(size) [__A_(__d_=0)] + +#define _Null_terminated_impl_ [__A_(__d_=0)] +#define _NullNull_terminated_impl_ [__A_(__d_=0)] + +#define _Pre_impl_ [__P_impl(__d_=0)] +#define _Pre1_impl_(p1) [__P_impl(__d_=0)] +#define _Pre2_impl_(p1,p2) [__P_impl(__d_=0)] +#define _Pre3_impl_(p1,p2,p3) [__P_impl(__d_=0)] + +#define _Post_impl_ [__P_impl(__d_=0)] +#define _Post1_impl_(p1) [__P_impl(__d_=0)] +#define _Post2_impl_(p1,p2) [__P_impl(__d_=0)] +#define _Post3_impl_(p1,p2,p3) [__P_impl(__d_=0)] + +#define _Ret1_impl_(p1) [__R_impl(__d_=0)] +#define _Ret2_impl_(p1,p2) [__R_impl(__d_=0)] +#define _Ret3_impl_(p1,p2,p3) [__R_impl(__d_=0)] + +#define _Deref_pre1_impl_(p1) [__P_impl(__d_=0)] +#define _Deref_pre2_impl_(p1,p2) [__P_impl(__d_=0)] +#define _Deref_pre3_impl_(p1,p2,p3) [__P_impl(__d_=0)] + +#define _Deref_post1_impl_(p1) [__P_impl(__d_=0)] +#define _Deref_post2_impl_(p1,p2) [__P_impl(__d_=0)] +#define _Deref_post3_impl_(p1,p2,p3) [__P_impl(__d_=0)] + +#define _Deref_ret1_impl_(p1) [__R_impl(__d_=0)] +#define _Deref_ret2_impl_(p1,p2) [__R_impl(__d_=0)] +#define _Deref_ret3_impl_(p1,p2,p3) [__R_impl(__d_=0)] + +#define _Deref2_pre1_impl_(p1) //[__P_impl(__d_=0)] +#define _Deref2_post1_impl_(p1) //[__P_impl(__d_=0)] +#define _Deref2_ret1_impl_(p1) //[__P_impl(__d_=0)] + +#else // ][ + + +#define _SAL_nop_impl_ X + +#define _At_impl_(target, annos) +#define _When_impl_(expr, annos) +#define _Group_impl_(annos) +#define _GrouP_impl_(annos) +#define _At_buffer_impl_(target, iter, bound, annos) +#define _Use_decl_anno_impl_ +#define _Points_to_data_impl_ +#define _Literal_impl_ +#define _Notliteral_impl_ +#define _Notref_impl_ + +#define _Pre_valid_impl_ +#define _Post_valid_impl_ +#define _Ret_valid_impl_ + +#define _Check_return_impl_ +#define _Must_inspect_impl_ + +#define _Success_impl_(expr) +#define _On_failure_impl_(annos) +#define _Always_impl_(annos) + +#define _Printf_format_string_impl_ +#define _Scanf_format_string_impl_ +#define _Scanf_s_format_string_impl_ + +#define _In_bound_impl_ +#define _Out_bound_impl_ +#define _Ret_bound_impl_ +#define _Deref_in_bound_impl_ +#define _Deref_out_bound_impl_ +#define _Deref_ret_bound_impl_ + +#define _Range_impl_(min,max) +#define _In_range_impl_(min,max) +#define _Out_range_impl_(min,max) +#define _Ret_range_impl_(min,max) +#define _Deref_in_range_impl_(min,max) +#define _Deref_out_range_impl_(min,max) +#define _Deref_ret_range_impl_(min,max) + +#define _Satisfies_impl_(expr) +#define _Pre_satisfies_impl_(expr) +#define _Post_satisfies_impl_(expr) + +#define _Null_impl_ +#define _Notnull_impl_ +#define _Maybenull_impl_ + +#define _Valid_impl_ +#define _Notvalid_impl_ +#define _Maybevalid_impl_ + +#define _Field_range_impl_(min,max) + +#define _Pre_impl_ +#define _Pre1_impl_(p1) +#define _Pre2_impl_(p1,p2) +#define _Pre3_impl_(p1,p2,p3) + +#define _Post_impl_ +#define _Post1_impl_(p1) +#define _Post2_impl_(p1,p2) +#define _Post3_impl_(p1,p2,p3) + +#define _Ret1_impl_(p1) +#define _Ret2_impl_(p1,p2) +#define _Ret3_impl_(p1,p2,p3) + +#define _Deref_pre1_impl_(p1) +#define _Deref_pre2_impl_(p1,p2) +#define _Deref_pre3_impl_(p1,p2,p3) + +#define _Deref_post1_impl_(p1) +#define _Deref_post2_impl_(p1,p2) +#define _Deref_post3_impl_(p1,p2,p3) + +#define _Deref_ret1_impl_(p1) +#define _Deref_ret2_impl_(p1,p2) +#define _Deref_ret3_impl_(p1,p2,p3) + +#define _Deref2_pre1_impl_(p1) +#define _Deref2_post1_impl_(p1) +#define _Deref2_ret1_impl_(p1) + +#define _Readable_bytes_impl_(size) +#define _Readable_elements_impl_(size) +#define _Writable_bytes_impl_(size) +#define _Writable_elements_impl_(size) + +#define _Null_terminated_impl_ +#define _NullNull_terminated_impl_ + +// Obsolete -- may be needed for transition to attributes. +#define __inner_typefix(ctype) +#define __inner_exceptthat + +#endif // ] + +// This section contains the deprecated annotations + +/* + ------------------------------------------------------------------------------- + Introduction + + sal.h provides a set of annotations to describe how a function uses its + parameters - the assumptions it makes about them, and the guarantees it makes + upon finishing. + + Annotations may be placed before either a function parameter's type or its return + type, and describe the function's behavior regarding the parameter or return value. + There are two classes of annotations: buffer annotations and advanced annotations. + Buffer annotations describe how functions use their pointer parameters, and + advanced annotations either describe complex/unusual buffer behavior, or provide + additional information about a parameter that is not otherwise expressible. + + ------------------------------------------------------------------------------- + Buffer Annotations + + The most important annotations in sal.h provide a consistent way to annotate + buffer parameters or return values for a function. Each of these annotations describes + a single buffer (which could be a string, a fixed-length or variable-length array, + or just a pointer) that the function interacts with: where it is, how large it is, + how much is initialized, and what the function does with it. + + The appropriate macro for a given buffer can be constructed using the table below. + Just pick the appropriate values from each category, and combine them together + with a leading underscore. Some combinations of values do not make sense as buffer + annotations. Only meaningful annotations can be added to your code; for a list of + these, see the buffer annotation definitions section. + + Only a single buffer annotation should be used for each parameter. + + |------------|------------|---------|--------|----------|----------|---------------| + | Level | Usage | Size | Output | NullTerm | Optional | Parameters | + |------------|------------|---------|--------|----------|----------|---------------| + | <> | <> | <> | <> | _z | <> | <> | + | _deref | _in | _ecount | _full | _nz | _opt | (size) | + | _deref_opt | _out | _bcount | _part | | | (size,length) | + | | _inout | | | | | | + | | | | | | | | + |------------|------------|---------|--------|----------|----------|---------------| + + Level: Describes the buffer pointer's level of indirection from the parameter or + return value 'p'. + + <> : p is the buffer pointer. + _deref : *p is the buffer pointer. p must not be NULL. + _deref_opt : *p may be the buffer pointer. p may be NULL, in which case the rest of + the annotation is ignored. + + Usage: Describes how the function uses the buffer. + + <> : The buffer is not accessed. If used on the return value or with _deref, the + function will provide the buffer, and it will be uninitialized at exit. + Otherwise, the caller must provide the buffer. This should only be used + for alloc and free functions. + _in : The function will only read from the buffer. The caller must provide the + buffer and initialize it. Cannot be used with _deref. + _out : The function will only write to the buffer. If used on the return value or + with _deref, the function will provide the buffer and initialize it. + Otherwise, the caller must provide the buffer, and the function will + initialize it. + _inout : The function may freely read from and write to the buffer. The caller must + provide the buffer and initialize it. If used with _deref, the buffer may + be reallocated by the function. + + Size: Describes the total size of the buffer. This may be less than the space actually + allocated for the buffer, in which case it describes the accessible amount. + + <> : No buffer size is given. If the type specifies the buffer size (such as + with LPSTR and LPWSTR), that amount is used. Otherwise, the buffer is one + element long. Must be used with _in, _out, or _inout. + _ecount : The buffer size is an explicit element count. + _bcount : The buffer size is an explicit byte count. + + Output: Describes how much of the buffer will be initialized by the function. For + _inout buffers, this also describes how much is initialized at entry. Omit this + category for _in buffers; they must be fully initialized by the caller. + + <> : The type specifies how much is initialized. For instance, a function initializing + an LPWSTR must NULL-terminate the string. + _full : The function initializes the entire buffer. + _part : The function initializes part of the buffer, and explicitly indicates how much. + + NullTerm: States if the present of a '\0' marks the end of valid elements in the buffer. + _z : A '\0' indicated the end of the buffer + _nz : The buffer may not be null terminated and a '\0' does not indicate the end of the + buffer. + Optional: Describes if the buffer itself is optional. + + <> : The pointer to the buffer must not be NULL. + _opt : The pointer to the buffer might be NULL. It will be checked before being dereferenced. + + Parameters: Gives explicit counts for the size and length of the buffer. + + <> : There is no explicit count. Use when neither _ecount nor _bcount is used. + (size) : Only the buffer's total size is given. Use with _ecount or _bcount but not _part. + (size,length) : The buffer's total size and initialized length are given. Use with _ecount_part + and _bcount_part. + + ------------------------------------------------------------------------------- + Buffer Annotation Examples + + LWSTDAPI_(BOOL) StrToIntExA( + __in LPCSTR pszString, + DWORD dwFlags, + __out int *piRet -- A pointer whose dereference will be filled in. + ); + + void MyPaintingFunction( + __in HWND hwndControl, -- An initialized read-only parameter. + __in_opt HDC hdcOptional, -- An initialized read-only parameter that might be NULL. + __inout IPropertyStore *ppsStore -- An initialized parameter that may be freely used + -- and modified. + ); + + LWSTDAPI_(BOOL) PathCompactPathExA( + __out_ecount(cchMax) LPSTR pszOut, -- A string buffer with cch elements that will + -- be NULL terminated on exit. + __in LPCSTR pszSrc, + UINT cchMax, + DWORD dwFlags + ); + + HRESULT SHLocalAllocBytes( + size_t cb, + __deref_bcount(cb) T **ppv -- A pointer whose dereference will be set to an + -- uninitialized buffer with cb bytes. + ); + + __inout_bcount_full(cb) : A buffer with cb elements that is fully initialized at + entry and exit, and may be written to by this function. + + __out_ecount_part(count, *countOut) : A buffer with count elements that will be + partially initialized by this function. The function indicates how much it + initialized by setting *countOut. + + ------------------------------------------------------------------------------- + Advanced Annotations + + Advanced annotations describe behavior that is not expressible with the regular + buffer macros. These may be used either to annotate buffer parameters that involve + complex or conditional behavior, or to enrich existing annotations with additional + information. + + __success(expr) f : + indicates whether function f succeeded or not. If is true at exit, + all the function's guarantees (as given by other annotations) must hold. If + is false at exit, the caller should not expect any of the function's guarantees + to hold. If not used, the function must always satisfy its guarantees. Added + automatically to functions that indicate success in standard ways, such as by + returning an HRESULT. + + __nullterminated p : + Pointer p is a buffer that may be read or written up to and including the first + NULL character or pointer. May be used on typedefs, which marks valid (properly + initialized) instances of that type as being NULL-terminated. + + __nullnullterminated p : + Pointer p is a buffer that may be read or written up to and including the first + sequence of two NULL characters or pointers. May be used on typedefs, which marks + valid instances of that type as being double-NULL terminated. + + __reserved v : + Value v must be 0/NULL, reserved for future use. + + __checkReturn v : + Return value v must not be ignored by callers of this function. + + __typefix(ctype) v : + Value v should be treated as an instance of ctype, rather than its declared type. + + __override f : + Specify C#-style 'override' behaviour for overriding virtual methods. + + __callback f : + Function f can be used as a function pointer. + + __format_string p : + Pointer p is a string that contains % markers in the style of printf. + + __blocksOn(resource) f : + Function f blocks on the resource 'resource'. + + __fallthrough : + Annotates switch statement labels where fall-through is desired, to distinguish + from forgotten break statements. + + ------------------------------------------------------------------------------- + Advanced Annotation Examples + + __success(return != FALSE) LWSTDAPI_(BOOL) + PathCanonicalizeA(__out_ecount(MAX_PATH) LPSTR pszBuf, LPCSTR pszPath) : + pszBuf is only guaranteed to be NULL-terminated when TRUE is returned. + + typedef __nullterminated WCHAR* LPWSTR : Initialized LPWSTRs are NULL-terminated strings. + + __out_ecount(cch) __typefix(LPWSTR) void *psz : psz is a buffer parameter which will be + a NULL-terminated WCHAR string at exit, and which initially contains cch WCHARs. + + ------------------------------------------------------------------------------- +*/ + +#define __specstrings + +#ifdef __cplusplus // [ +#ifndef __nothrow // [ +# define __nothrow __declspec(nothrow) +#endif // ] +extern "C" { +#else // ][ +#ifndef __nothrow // [ +# define __nothrow +#endif // ] +#endif /* __cplusplus */ // ] + + +/* + ------------------------------------------------------------------------------- + Helper Macro Definitions + + These express behavior common to many of the high-level annotations. + DO NOT USE THESE IN YOUR CODE. + ------------------------------------------------------------------------------- +*/ + +/* + The helper annotations are only understood by the compiler version used by + various defect detection tools. When the regular compiler is running, they + are defined into nothing, and do not affect the compiled code. +*/ + +#if !defined(__midl) && defined(_PREFAST_) // [ + + /* + In the primitive "SAL_*" annotations "SAL" stands for Standard + Annotation Language. These "SAL_*" annotations are the + primitives the compiler understands and high-level MACROs + will decompose into these primitives. + */ + + #define _SA_SPECSTRIZE( x ) #x + + /* + __null p + __notnull p + __maybenull p + + Annotates a pointer p. States that pointer p is null. Commonly used + in the negated form __notnull or the possibly null form __maybenull. + */ + + #define __null _Null_impl_ + #define __notnull _Notnull_impl_ + #define __maybenull _Maybenull_impl_ + + /* + __readonly l + __notreadonly l + __maybereadonly l + + Annotates a location l. States that location l is not modified after + this point. If the annotation is placed on the precondition state of + a function, the restriction only applies until the postcondition state + of the function. __maybereadonly states that the annotated location + may be modified, whereas __notreadonly states that a location must be + modified. + */ + + #define __readonly _Pre1_impl_(__readaccess_impl) + #define __notreadonly _Pre1_impl_(__allaccess_impl) + #define __maybereadonly _Pre1_impl_(__readaccess_impl) + + /* + __valid v + __notvalid v + __maybevalid v + + Annotates any value v. States that the value satisfies all properties of + valid values of its type. For example, for a string buffer, valid means + that the buffer pointer is either NULL or points to a NULL-terminated string. + */ + + #define __valid _Valid_impl_ + #define __notvalid _Notvalid_impl_ + #define __maybevalid _Maybevalid_impl_ + + /* + __readableTo(extent) p + + Annotates a buffer pointer p. If the buffer can be read, extent describes + how much of the buffer is readable. For a reader of the buffer, this is + an explicit permission to read up to that amount, rather than a restriction to + read only up to it. + */ + + #define __readableTo(extent) _SA_annotes1(SAL_readableTo, extent) + + /* + + __elem_readableTo(size) + + Annotates a buffer pointer p as being readable to size elements. + */ + + #define __elem_readableTo(size) _SA_annotes1(SAL_readableTo, elementCount( size )) + + /* + __byte_readableTo(size) + + Annotates a buffer pointer p as being readable to size bytes. + */ + #define __byte_readableTo(size) _SA_annotes1(SAL_readableTo, byteCount(size)) + + /* + __writableTo(extent) p + + Annotates a buffer pointer p. If the buffer can be modified, extent + describes how much of the buffer is writable (usually the allocation + size). For a writer of the buffer, this is an explicit permission to + write up to that amount, rather than a restriction to write only up to it. + */ + #define __writableTo(size) _SA_annotes1(SAL_writableTo, size) + + /* + __elem_writableTo(size) + + Annotates a buffer pointer p as being writable to size elements. + */ + #define __elem_writableTo(size) _SA_annotes1(SAL_writableTo, elementCount( size )) + + /* + __byte_writableTo(size) + + Annotates a buffer pointer p as being writable to size bytes. + */ + #define __byte_writableTo(size) _SA_annotes1(SAL_writableTo, byteCount( size)) + + /* + __deref p + + Annotates a pointer p. The next annotation applies one dereference down + in the type. If readableTo(p, size) then the next annotation applies to + all elements *(p+i) for which i satisfies the size. If p is a pointer + to a struct, the next annotation applies to all fields of the struct. + */ + #define __deref _Deref_impl_ + + /* + __pre __next_annotation + + The next annotation applies in the precondition state + */ + #define __pre _Pre_impl_ + + /* + __post __next_annotation + + The next annotation applies in the postcondition state + */ + #define __post _Post_impl_ + + /* + __precond() + + When is true, the next annotation applies in the precondition state + (currently not enabled) + */ + #define __precond(expr) __pre + + /* + __postcond() + + When is true, the next annotation applies in the postcondition state + (currently not enabled) + */ + #define __postcond(expr) __post + + /* + __exceptthat + + Given a set of annotations Q containing __exceptthat maybeP, the effect of + the except clause is to erase any P or notP annotations (explicit or + implied) within Q at the same level of dereferencing that the except + clause appears, and to replace it with maybeP. + + Example 1: __valid __pre_except_maybenull on a pointer p means that the + pointer may be null, and is otherwise valid, thus overriding + the implicit notnull annotation implied by __valid on + pointers. + + Example 2: __valid __deref __pre_except_maybenull on an int **p means + that p is not null (implied by valid), but the elements + pointed to by p could be null, and are otherwise valid. + */ + #define __exceptthat __inner_exceptthat + + /* + _refparam + + Added to all out parameter macros to indicate that they are all reference + parameters. + */ + #define __refparam _Notref_ __deref __notreadonly + + /* + __inner_* + + Helper macros that directly correspond to certain high-level annotations. + + */ + + /* + Macros to classify the entrypoints and indicate their category. + + Pre-defined control point categories include: RPC, LPC, DeviceDriver, UserToKernel, ISAPI, COM. + + */ + #define __inner_control_entrypoint(category) _SA_annotes2(SAL_entrypoint, controlEntry, category) + + + /* + Pre-defined data entry point categories include: Registry, File, Network. + */ + #define __inner_data_entrypoint(category) _SA_annotes2(SAL_entrypoint, dataEntry, category) + + #define __inner_override _SA_annotes0(__override) + #define __inner_callback _SA_annotes0(__callback) + #define __inner_blocksOn(resource) _SA_annotes1(SAL_blocksOn, resource) + #define __inner_fallthrough_dec __inline __nothrow void __FallThrough() {} + #define __inner_fallthrough __FallThrough(); + + #define __post_except_maybenull __post __inner_exceptthat _Maybenull_impl_ + #define __pre_except_maybenull __pre __inner_exceptthat _Maybenull_impl_ + + #define __post_deref_except_maybenull __post __deref __inner_exceptthat _Maybenull_impl_ + #define __pre_deref_except_maybenull __pre __deref __inner_exceptthat _Maybenull_impl_ + + #define __inexpressible_readableTo(size) _Readable_elements_impl_(_Inexpressible_(size)) + #define __inexpressible_writableTo(size) _Writable_elements_impl_(_Inexpressible_(size)) + + +#else // ][ + #define __null + #define __notnull + #define __maybenull + #define __readonly + #define __notreadonly + #define __maybereadonly + #define __valid + #define __notvalid + #define __maybevalid + #define __readableTo(extent) + #define __elem_readableTo(size) + #define __byte_readableTo(size) + #define __writableTo(size) + #define __elem_writableTo(size) + #define __byte_writableTo(size) + #define __deref + #define __pre + #define __post + #define __precond(expr) + #define __postcond(expr) + #define __exceptthat + #define __inner_override + #define __inner_callback + #define __inner_blocksOn(resource) + #define __inner_fallthrough_dec + #define __inner_fallthrough + #define __refparam + #define __inner_control_entrypoint(category) + #define __inner_data_entrypoint(category) + + #define __post_except_maybenull + #define __pre_except_maybenull + #define __post_deref_except_maybenull + #define __pre_deref_except_maybenull + + #define __inexpressible_readableTo(size) + #define __inexpressible_writableTo(size) + +#endif /* !defined(__midl) && defined(_PREFAST_) */ // ] + +/* +------------------------------------------------------------------------------- +Buffer Annotation Definitions + +Any of these may be used to directly annotate functions, but only one should +be used for each parameter. To determine which annotation to use for a given +buffer, use the table in the buffer annotations section. +------------------------------------------------------------------------------- +*/ + +#define __ecount(size) _SAL1_Source_(__ecount, (size), __notnull __elem_writableTo(size)) +#define __bcount(size) _SAL1_Source_(__bcount, (size), __notnull __byte_writableTo(size)) +#define __in _SAL1_Source_(__in, (), _In_) +#define __in_ecount(size) _SAL1_Source_(__in_ecount, (size), _In_reads_(size)) +#define __in_bcount(size) _SAL1_Source_(__in_bcount, (size), _In_reads_bytes_(size)) +#define __in_z _SAL1_Source_(__in_z, (), _In_z_) +#define __in_ecount_z(size) _SAL1_Source_(__in_ecount_z, (size), _In_reads_z_(size)) +#define __in_bcount_z(size) _SAL1_Source_(__in_bcount_z, (size), __in_bcount(size) __pre __nullterminated) +#define __in_nz _SAL1_Source_(__in_nz, (), __in) +#define __in_ecount_nz(size) _SAL1_Source_(__in_ecount_nz, (size), __in_ecount(size)) +#define __in_bcount_nz(size) _SAL1_Source_(__in_bcount_nz, (size), __in_bcount(size)) +#define __out _SAL1_Source_(__out, (), _Out_) +#define __out_ecount(size) _SAL1_Source_(__out_ecount, (size), _Out_writes_(size)) +#define __out_bcount(size) _SAL1_Source_(__out_bcount, (size), _Out_writes_bytes_(size)) +#define __out_ecount_part(size,length) _SAL1_Source_(__out_ecount_part, (size,length), _Out_writes_to_(size,length)) +#define __out_bcount_part(size,length) _SAL1_Source_(__out_bcount_part, (size,length), _Out_writes_bytes_to_(size,length)) +#define __out_ecount_full(size) _SAL1_Source_(__out_ecount_full, (size), _Out_writes_all_(size)) +#define __out_bcount_full(size) _SAL1_Source_(__out_bcount_full, (size), _Out_writes_bytes_all_(size)) +#define __out_z _SAL1_Source_(__out_z, (), __post __valid __refparam __post __nullterminated) +#define __out_z_opt _SAL1_Source_(__out_z_opt, (), __post __valid __refparam __post __nullterminated __pre_except_maybenull) +#define __out_ecount_z(size) _SAL1_Source_(__out_ecount_z, (size), __ecount(size) __post __valid __refparam __post __nullterminated) +#define __out_bcount_z(size) _SAL1_Source_(__out_bcount_z, (size), __bcount(size) __post __valid __refparam __post __nullterminated) +#define __out_ecount_part_z(size,length) _SAL1_Source_(__out_ecount_part_z, (size,length), __out_ecount_part(size,length) __post __nullterminated) +#define __out_bcount_part_z(size,length) _SAL1_Source_(__out_bcount_part_z, (size,length), __out_bcount_part(size,length) __post __nullterminated) +#define __out_ecount_full_z(size) _SAL1_Source_(__out_ecount_full_z, (size), __out_ecount_full(size) __post __nullterminated) +#define __out_bcount_full_z(size) _SAL1_Source_(__out_bcount_full_z, (size), __out_bcount_full(size) __post __nullterminated) +#define __out_nz _SAL1_Source_(__out_nz, (), __post __valid __refparam) +#define __out_nz_opt _SAL1_Source_(__out_nz_opt, (), __post __valid __refparam __post_except_maybenull_) +#define __out_ecount_nz(size) _SAL1_Source_(__out_ecount_nz, (size), __ecount(size) __post __valid __refparam) +#define __out_bcount_nz(size) _SAL1_Source_(__out_bcount_nz, (size), __bcount(size) __post __valid __refparam) +#define __inout _SAL1_Source_(__inout, (), _Inout_) +#define __inout_ecount(size) _SAL1_Source_(__inout_ecount, (size), _Inout_updates_(size)) +#define __inout_bcount(size) _SAL1_Source_(__inout_bcount, (size), _Inout_updates_bytes_(size)) +#define __inout_ecount_part(size,length) _SAL1_Source_(__inout_ecount_part, (size,length), _Inout_updates_to_(size,length)) +#define __inout_bcount_part(size,length) _SAL1_Source_(__inout_bcount_part, (size,length), _Inout_updates_bytes_to_(size,length)) +#define __inout_ecount_full(size) _SAL1_Source_(__inout_ecount_full, (size), _Inout_updates_all_(size)) +#define __inout_bcount_full(size) _SAL1_Source_(__inout_bcount_full, (size), _Inout_updates_bytes_all_(size)) +#define __inout_z _SAL1_Source_(__inout_z, (), _Inout_z_) +#define __inout_ecount_z(size) _SAL1_Source_(__inout_ecount_z, (size), _Inout_updates_z_(size)) +#define __inout_bcount_z(size) _SAL1_Source_(__inout_bcount_z, (size), __inout_bcount(size) __pre __nullterminated __post __nullterminated) +#define __inout_nz _SAL1_Source_(__inout_nz, (), __inout) +#define __inout_ecount_nz(size) _SAL1_Source_(__inout_ecount_nz, (size), __inout_ecount(size)) +#define __inout_bcount_nz(size) _SAL1_Source_(__inout_bcount_nz, (size), __inout_bcount(size)) +#define __ecount_opt(size) _SAL1_Source_(__ecount_opt, (size), __ecount(size) __pre_except_maybenull) +#define __bcount_opt(size) _SAL1_Source_(__bcount_opt, (size), __bcount(size) __pre_except_maybenull) +#define __in_opt _SAL1_Source_(__in_opt, (), _In_opt_) +#define __in_ecount_opt(size) _SAL1_Source_(__in_ecount_opt, (size), _In_reads_opt_(size)) +#define __in_bcount_opt(size) _SAL1_Source_(__in_bcount_opt, (size), _In_reads_bytes_opt_(size)) +#define __in_z_opt _SAL1_Source_(__in_z_opt, (), _In_opt_z_) +#define __in_ecount_z_opt(size) _SAL1_Source_(__in_ecount_z_opt, (size), __in_ecount_opt(size) __pre __nullterminated) +#define __in_bcount_z_opt(size) _SAL1_Source_(__in_bcount_z_opt, (size), __in_bcount_opt(size) __pre __nullterminated) +#define __in_nz_opt _SAL1_Source_(__in_nz_opt, (), __in_opt) +#define __in_ecount_nz_opt(size) _SAL1_Source_(__in_ecount_nz_opt, (size), __in_ecount_opt(size)) +#define __in_bcount_nz_opt(size) _SAL1_Source_(__in_bcount_nz_opt, (size), __in_bcount_opt(size)) +#define __out_opt _SAL1_Source_(__out_opt, (), _Out_opt_) +#define __out_ecount_opt(size) _SAL1_Source_(__out_ecount_opt, (size), _Out_writes_opt_(size)) +#define __out_bcount_opt(size) _SAL1_Source_(__out_bcount_opt, (size), _Out_writes_bytes_opt_(size)) +#define __out_ecount_part_opt(size,length) _SAL1_Source_(__out_ecount_part_opt, (size,length), __out_ecount_part(size,length) __pre_except_maybenull) +#define __out_bcount_part_opt(size,length) _SAL1_Source_(__out_bcount_part_opt, (size,length), __out_bcount_part(size,length) __pre_except_maybenull) +#define __out_ecount_full_opt(size) _SAL1_Source_(__out_ecount_full_opt, (size), __out_ecount_full(size) __pre_except_maybenull) +#define __out_bcount_full_opt(size) _SAL1_Source_(__out_bcount_full_opt, (size), __out_bcount_full(size) __pre_except_maybenull) +#define __out_ecount_z_opt(size) _SAL1_Source_(__out_ecount_z_opt, (size), __out_ecount_opt(size) __post __nullterminated) +#define __out_bcount_z_opt(size) _SAL1_Source_(__out_bcount_z_opt, (size), __out_bcount_opt(size) __post __nullterminated) +#define __out_ecount_part_z_opt(size,length) _SAL1_Source_(__out_ecount_part_z_opt, (size,length), __out_ecount_part_opt(size,length) __post __nullterminated) +#define __out_bcount_part_z_opt(size,length) _SAL1_Source_(__out_bcount_part_z_opt, (size,length), __out_bcount_part_opt(size,length) __post __nullterminated) +#define __out_ecount_full_z_opt(size) _SAL1_Source_(__out_ecount_full_z_opt, (size), __out_ecount_full_opt(size) __post __nullterminated) +#define __out_bcount_full_z_opt(size) _SAL1_Source_(__out_bcount_full_z_opt, (size), __out_bcount_full_opt(size) __post __nullterminated) +#define __out_ecount_nz_opt(size) _SAL1_Source_(__out_ecount_nz_opt, (size), __out_ecount_opt(size) __post __nullterminated) +#define __out_bcount_nz_opt(size) _SAL1_Source_(__out_bcount_nz_opt, (size), __out_bcount_opt(size) __post __nullterminated) +#define __inout_opt _SAL1_Source_(__inout_opt, (), _Inout_opt_) +#define __inout_ecount_opt(size) _SAL1_Source_(__inout_ecount_opt, (size), __inout_ecount(size) __pre_except_maybenull) +#define __inout_bcount_opt(size) _SAL1_Source_(__inout_bcount_opt, (size), __inout_bcount(size) __pre_except_maybenull) +#define __inout_ecount_part_opt(size,length) _SAL1_Source_(__inout_ecount_part_opt, (size,length), __inout_ecount_part(size,length) __pre_except_maybenull) +#define __inout_bcount_part_opt(size,length) _SAL1_Source_(__inout_bcount_part_opt, (size,length), __inout_bcount_part(size,length) __pre_except_maybenull) +#define __inout_ecount_full_opt(size) _SAL1_Source_(__inout_ecount_full_opt, (size), __inout_ecount_full(size) __pre_except_maybenull) +#define __inout_bcount_full_opt(size) _SAL1_Source_(__inout_bcount_full_opt, (size), __inout_bcount_full(size) __pre_except_maybenull) +#define __inout_z_opt _SAL1_Source_(__inout_z_opt, (), __inout_opt __pre __nullterminated __post __nullterminated) +#define __inout_ecount_z_opt(size) _SAL1_Source_(__inout_ecount_z_opt, (size), __inout_ecount_opt(size) __pre __nullterminated __post __nullterminated) +#define __inout_ecount_z_opt(size) _SAL1_Source_(__inout_ecount_z_opt, (size), __inout_ecount_opt(size) __pre __nullterminated __post __nullterminated) +#define __inout_bcount_z_opt(size) _SAL1_Source_(__inout_bcount_z_opt, (size), __inout_bcount_opt(size)) +#define __inout_nz_opt _SAL1_Source_(__inout_nz_opt, (), __inout_opt) +#define __inout_ecount_nz_opt(size) _SAL1_Source_(__inout_ecount_nz_opt, (size), __inout_ecount_opt(size)) +#define __inout_bcount_nz_opt(size) _SAL1_Source_(__inout_bcount_nz_opt, (size), __inout_bcount_opt(size)) +#define __deref_ecount(size) _SAL1_Source_(__deref_ecount, (size), _Notref_ __ecount(1) __post _Notref_ __elem_readableTo(1) __post _Notref_ __deref _Notref_ __notnull __post __deref __elem_writableTo(size)) +#define __deref_bcount(size) _SAL1_Source_(__deref_bcount, (size), _Notref_ __ecount(1) __post _Notref_ __elem_readableTo(1) __post _Notref_ __deref _Notref_ __notnull __post __deref __byte_writableTo(size)) +#define __deref_out _SAL1_Source_(__deref_out, (), _Outptr_) +#define __deref_out_ecount(size) _SAL1_Source_(__deref_out_ecount, (size), _Outptr_result_buffer_(size)) +#define __deref_out_bcount(size) _SAL1_Source_(__deref_out_bcount, (size), _Outptr_result_bytebuffer_(size)) +#define __deref_out_ecount_part(size,length) _SAL1_Source_(__deref_out_ecount_part, (size,length), _Outptr_result_buffer_to_(size,length)) +#define __deref_out_bcount_part(size,length) _SAL1_Source_(__deref_out_bcount_part, (size,length), _Outptr_result_bytebuffer_to_(size,length)) +#define __deref_out_ecount_full(size) _SAL1_Source_(__deref_out_ecount_full, (size), __deref_out_ecount_part(size,size)) +#define __deref_out_bcount_full(size) _SAL1_Source_(__deref_out_bcount_full, (size), __deref_out_bcount_part(size,size)) +#define __deref_out_z _SAL1_Source_(__deref_out_z, (), _Outptr_result_z_) +#define __deref_out_ecount_z(size) _SAL1_Source_(__deref_out_ecount_z, (size), __deref_out_ecount(size) __post __deref __nullterminated) +#define __deref_out_bcount_z(size) _SAL1_Source_(__deref_out_bcount_z, (size), __deref_out_bcount(size) __post __deref __nullterminated) +#define __deref_out_nz _SAL1_Source_(__deref_out_nz, (), __deref_out) +#define __deref_out_ecount_nz(size) _SAL1_Source_(__deref_out_ecount_nz, (size), __deref_out_ecount(size)) +#define __deref_out_bcount_nz(size) _SAL1_Source_(__deref_out_bcount_nz, (size), __deref_out_ecount(size)) +#define __deref_inout _SAL1_Source_(__deref_inout, (), _Notref_ __notnull _Notref_ __elem_readableTo(1) __pre __deref __valid __post _Notref_ __deref __valid __refparam) +#define __deref_inout_z _SAL1_Source_(__deref_inout_z, (), __deref_inout __pre __deref __nullterminated __post _Notref_ __deref __nullterminated) +#define __deref_inout_ecount(size) _SAL1_Source_(__deref_inout_ecount, (size), __deref_inout __pre __deref __elem_writableTo(size) __post _Notref_ __deref __elem_writableTo(size)) +#define __deref_inout_bcount(size) _SAL1_Source_(__deref_inout_bcount, (size), __deref_inout __pre __deref __byte_writableTo(size) __post _Notref_ __deref __byte_writableTo(size)) +#define __deref_inout_ecount_part(size,length) _SAL1_Source_(__deref_inout_ecount_part, (size,length), __deref_inout_ecount(size) __pre __deref __elem_readableTo(length) __post __deref __elem_readableTo(length)) +#define __deref_inout_bcount_part(size,length) _SAL1_Source_(__deref_inout_bcount_part, (size,length), __deref_inout_bcount(size) __pre __deref __byte_readableTo(length) __post __deref __byte_readableTo(length)) +#define __deref_inout_ecount_full(size) _SAL1_Source_(__deref_inout_ecount_full, (size), __deref_inout_ecount_part(size,size)) +#define __deref_inout_bcount_full(size) _SAL1_Source_(__deref_inout_bcount_full, (size), __deref_inout_bcount_part(size,size)) +#define __deref_inout_ecount_z(size) _SAL1_Source_(__deref_inout_ecount_z, (size), __deref_inout_ecount(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_inout_bcount_z(size) _SAL1_Source_(__deref_inout_bcount_z, (size), __deref_inout_bcount(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_inout_nz _SAL1_Source_(__deref_inout_nz, (), __deref_inout) +#define __deref_inout_ecount_nz(size) _SAL1_Source_(__deref_inout_ecount_nz, (size), __deref_inout_ecount(size)) +#define __deref_inout_bcount_nz(size) _SAL1_Source_(__deref_inout_bcount_nz, (size), __deref_inout_ecount(size)) +#define __deref_ecount_opt(size) _SAL1_Source_(__deref_ecount_opt, (size), __deref_ecount(size) __post_deref_except_maybenull) +#define __deref_bcount_opt(size) _SAL1_Source_(__deref_bcount_opt, (size), __deref_bcount(size) __post_deref_except_maybenull) +#define __deref_out_opt _SAL1_Source_(__deref_out_opt, (), __deref_out __post_deref_except_maybenull) +#define __deref_out_ecount_opt(size) _SAL1_Source_(__deref_out_ecount_opt, (size), __deref_out_ecount(size) __post_deref_except_maybenull) +#define __deref_out_bcount_opt(size) _SAL1_Source_(__deref_out_bcount_opt, (size), __deref_out_bcount(size) __post_deref_except_maybenull) +#define __deref_out_ecount_part_opt(size,length) _SAL1_Source_(__deref_out_ecount_part_opt, (size,length), __deref_out_ecount_part(size,length) __post_deref_except_maybenull) +#define __deref_out_bcount_part_opt(size,length) _SAL1_Source_(__deref_out_bcount_part_opt, (size,length), __deref_out_bcount_part(size,length) __post_deref_except_maybenull) +#define __deref_out_ecount_full_opt(size) _SAL1_Source_(__deref_out_ecount_full_opt, (size), __deref_out_ecount_full(size) __post_deref_except_maybenull) +#define __deref_out_bcount_full_opt(size) _SAL1_Source_(__deref_out_bcount_full_opt, (size), __deref_out_bcount_full(size) __post_deref_except_maybenull) +#define __deref_out_z_opt _SAL1_Source_(__deref_out_z_opt, (), _Outptr_result_maybenull_z_) +#define __deref_out_ecount_z_opt(size) _SAL1_Source_(__deref_out_ecount_z_opt, (size), __deref_out_ecount_opt(size) __post __deref __nullterminated) +#define __deref_out_bcount_z_opt(size) _SAL1_Source_(__deref_out_bcount_z_opt, (size), __deref_out_bcount_opt(size) __post __deref __nullterminated) +#define __deref_out_nz_opt _SAL1_Source_(__deref_out_nz_opt, (), __deref_out_opt) +#define __deref_out_ecount_nz_opt(size) _SAL1_Source_(__deref_out_ecount_nz_opt, (size), __deref_out_ecount_opt(size)) +#define __deref_out_bcount_nz_opt(size) _SAL1_Source_(__deref_out_bcount_nz_opt, (size), __deref_out_bcount_opt(size)) +#define __deref_inout_opt _SAL1_Source_(__deref_inout_opt, (), __deref_inout __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_ecount_opt(size) _SAL1_Source_(__deref_inout_ecount_opt, (size), __deref_inout_ecount(size) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_bcount_opt(size) _SAL1_Source_(__deref_inout_bcount_opt, (size), __deref_inout_bcount(size) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_ecount_part_opt(size,length) _SAL1_Source_(__deref_inout_ecount_part_opt, (size,length), __deref_inout_ecount_part(size,length) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_bcount_part_opt(size,length) _SAL1_Source_(__deref_inout_bcount_part_opt, (size,length), __deref_inout_bcount_part(size,length) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_ecount_full_opt(size) _SAL1_Source_(__deref_inout_ecount_full_opt, (size), __deref_inout_ecount_full(size) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_bcount_full_opt(size) _SAL1_Source_(__deref_inout_bcount_full_opt, (size), __deref_inout_bcount_full(size) __pre_deref_except_maybenull __post_deref_except_maybenull) +#define __deref_inout_z_opt _SAL1_Source_(__deref_inout_z_opt, (), __deref_inout_opt __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_inout_ecount_z_opt(size) _SAL1_Source_(__deref_inout_ecount_z_opt, (size), __deref_inout_ecount_opt(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_inout_bcount_z_opt(size) _SAL1_Source_(__deref_inout_bcount_z_opt, (size), __deref_inout_bcount_opt(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_inout_nz_opt _SAL1_Source_(__deref_inout_nz_opt, (), __deref_inout_opt) +#define __deref_inout_ecount_nz_opt(size) _SAL1_Source_(__deref_inout_ecount_nz_opt, (size), __deref_inout_ecount_opt(size)) +#define __deref_inout_bcount_nz_opt(size) _SAL1_Source_(__deref_inout_bcount_nz_opt, (size), __deref_inout_bcount_opt(size)) +#define __deref_opt_ecount(size) _SAL1_Source_(__deref_opt_ecount, (size), __deref_ecount(size) __pre_except_maybenull) +#define __deref_opt_bcount(size) _SAL1_Source_(__deref_opt_bcount, (size), __deref_bcount(size) __pre_except_maybenull) +#define __deref_opt_out _SAL1_Source_(__deref_opt_out, (), _Outptr_opt_) +#define __deref_opt_out_z _SAL1_Source_(__deref_opt_out_z, (), _Outptr_opt_result_z_) +#define __deref_opt_out_ecount(size) _SAL1_Source_(__deref_opt_out_ecount, (size), __deref_out_ecount(size) __pre_except_maybenull) +#define __deref_opt_out_bcount(size) _SAL1_Source_(__deref_opt_out_bcount, (size), __deref_out_bcount(size) __pre_except_maybenull) +#define __deref_opt_out_ecount_part(size,length) _SAL1_Source_(__deref_opt_out_ecount_part, (size,length), __deref_out_ecount_part(size,length) __pre_except_maybenull) +#define __deref_opt_out_bcount_part(size,length) _SAL1_Source_(__deref_opt_out_bcount_part, (size,length), __deref_out_bcount_part(size,length) __pre_except_maybenull) +#define __deref_opt_out_ecount_full(size) _SAL1_Source_(__deref_opt_out_ecount_full, (size), __deref_out_ecount_full(size) __pre_except_maybenull) +#define __deref_opt_out_bcount_full(size) _SAL1_Source_(__deref_opt_out_bcount_full, (size), __deref_out_bcount_full(size) __pre_except_maybenull) +#define __deref_opt_inout _SAL1_Source_(__deref_opt_inout, (), _Inout_opt_) +#define __deref_opt_inout_ecount(size) _SAL1_Source_(__deref_opt_inout_ecount, (size), __deref_inout_ecount(size) __pre_except_maybenull) +#define __deref_opt_inout_bcount(size) _SAL1_Source_(__deref_opt_inout_bcount, (size), __deref_inout_bcount(size) __pre_except_maybenull) +#define __deref_opt_inout_ecount_part(size,length) _SAL1_Source_(__deref_opt_inout_ecount_part, (size,length), __deref_inout_ecount_part(size,length) __pre_except_maybenull) +#define __deref_opt_inout_bcount_part(size,length) _SAL1_Source_(__deref_opt_inout_bcount_part, (size,length), __deref_inout_bcount_part(size,length) __pre_except_maybenull) +#define __deref_opt_inout_ecount_full(size) _SAL1_Source_(__deref_opt_inout_ecount_full, (size), __deref_inout_ecount_full(size) __pre_except_maybenull) +#define __deref_opt_inout_bcount_full(size) _SAL1_Source_(__deref_opt_inout_bcount_full, (size), __deref_inout_bcount_full(size) __pre_except_maybenull) +#define __deref_opt_inout_z _SAL1_Source_(__deref_opt_inout_z, (), __deref_opt_inout __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_ecount_z(size) _SAL1_Source_(__deref_opt_inout_ecount_z, (size), __deref_opt_inout_ecount(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_bcount_z(size) _SAL1_Source_(__deref_opt_inout_bcount_z, (size), __deref_opt_inout_bcount(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_nz _SAL1_Source_(__deref_opt_inout_nz, (), __deref_opt_inout) +#define __deref_opt_inout_ecount_nz(size) _SAL1_Source_(__deref_opt_inout_ecount_nz, (size), __deref_opt_inout_ecount(size)) +#define __deref_opt_inout_bcount_nz(size) _SAL1_Source_(__deref_opt_inout_bcount_nz, (size), __deref_opt_inout_bcount(size)) +#define __deref_opt_ecount_opt(size) _SAL1_Source_(__deref_opt_ecount_opt, (size), __deref_ecount_opt(size) __pre_except_maybenull) +#define __deref_opt_bcount_opt(size) _SAL1_Source_(__deref_opt_bcount_opt, (size), __deref_bcount_opt(size) __pre_except_maybenull) +#define __deref_opt_out_opt _SAL1_Source_(__deref_opt_out_opt, (), _Outptr_opt_result_maybenull_) +#define __deref_opt_out_ecount_opt(size) _SAL1_Source_(__deref_opt_out_ecount_opt, (size), __deref_out_ecount_opt(size) __pre_except_maybenull) +#define __deref_opt_out_bcount_opt(size) _SAL1_Source_(__deref_opt_out_bcount_opt, (size), __deref_out_bcount_opt(size) __pre_except_maybenull) +#define __deref_opt_out_ecount_part_opt(size,length) _SAL1_Source_(__deref_opt_out_ecount_part_opt, (size,length), __deref_out_ecount_part_opt(size,length) __pre_except_maybenull) +#define __deref_opt_out_bcount_part_opt(size,length) _SAL1_Source_(__deref_opt_out_bcount_part_opt, (size,length), __deref_out_bcount_part_opt(size,length) __pre_except_maybenull) +#define __deref_opt_out_ecount_full_opt(size) _SAL1_Source_(__deref_opt_out_ecount_full_opt, (size), __deref_out_ecount_full_opt(size) __pre_except_maybenull) +#define __deref_opt_out_bcount_full_opt(size) _SAL1_Source_(__deref_opt_out_bcount_full_opt, (size), __deref_out_bcount_full_opt(size) __pre_except_maybenull) +#define __deref_opt_out_z_opt _SAL1_Source_(__deref_opt_out_z_opt, (), __post __deref __valid __refparam __pre_except_maybenull __pre_deref_except_maybenull __post_deref_except_maybenull __post __deref __nullterminated) +#define __deref_opt_out_ecount_z_opt(size) _SAL1_Source_(__deref_opt_out_ecount_z_opt, (size), __deref_opt_out_ecount_opt(size) __post __deref __nullterminated) +#define __deref_opt_out_bcount_z_opt(size) _SAL1_Source_(__deref_opt_out_bcount_z_opt, (size), __deref_opt_out_bcount_opt(size) __post __deref __nullterminated) +#define __deref_opt_out_nz_opt _SAL1_Source_(__deref_opt_out_nz_opt, (), __deref_opt_out_opt) +#define __deref_opt_out_ecount_nz_opt(size) _SAL1_Source_(__deref_opt_out_ecount_nz_opt, (size), __deref_opt_out_ecount_opt(size)) +#define __deref_opt_out_bcount_nz_opt(size) _SAL1_Source_(__deref_opt_out_bcount_nz_opt, (size), __deref_opt_out_bcount_opt(size)) +#define __deref_opt_inout_opt _SAL1_Source_(__deref_opt_inout_opt, (), __deref_inout_opt __pre_except_maybenull) +#define __deref_opt_inout_ecount_opt(size) _SAL1_Source_(__deref_opt_inout_ecount_opt, (size), __deref_inout_ecount_opt(size) __pre_except_maybenull) +#define __deref_opt_inout_bcount_opt(size) _SAL1_Source_(__deref_opt_inout_bcount_opt, (size), __deref_inout_bcount_opt(size) __pre_except_maybenull) +#define __deref_opt_inout_ecount_part_opt(size,length) _SAL1_Source_(__deref_opt_inout_ecount_part_opt, (size,length), __deref_inout_ecount_part_opt(size,length) __pre_except_maybenull) +#define __deref_opt_inout_bcount_part_opt(size,length) _SAL1_Source_(__deref_opt_inout_bcount_part_opt, (size,length), __deref_inout_bcount_part_opt(size,length) __pre_except_maybenull) +#define __deref_opt_inout_ecount_full_opt(size) _SAL1_Source_(__deref_opt_inout_ecount_full_opt, (size), __deref_inout_ecount_full_opt(size) __pre_except_maybenull) +#define __deref_opt_inout_bcount_full_opt(size) _SAL1_Source_(__deref_opt_inout_bcount_full_opt, (size), __deref_inout_bcount_full_opt(size) __pre_except_maybenull) +#define __deref_opt_inout_z_opt _SAL1_Source_(__deref_opt_inout_z_opt, (), __deref_opt_inout_opt __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_ecount_z_opt(size) _SAL1_Source_(__deref_opt_inout_ecount_z_opt, (size), __deref_opt_inout_ecount_opt(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_bcount_z_opt(size) _SAL1_Source_(__deref_opt_inout_bcount_z_opt, (size), __deref_opt_inout_bcount_opt(size) __pre __deref __nullterminated __post __deref __nullterminated) +#define __deref_opt_inout_nz_opt _SAL1_Source_(__deref_opt_inout_nz_opt, (), __deref_opt_inout_opt) +#define __deref_opt_inout_ecount_nz_opt(size) _SAL1_Source_(__deref_opt_inout_ecount_nz_opt, (size), __deref_opt_inout_ecount_opt(size)) +#define __deref_opt_inout_bcount_nz_opt(size) _SAL1_Source_(__deref_opt_inout_bcount_nz_opt, (size), __deref_opt_inout_bcount_opt(size)) + +/* +------------------------------------------------------------------------------- +Advanced Annotation Definitions + +Any of these may be used to directly annotate functions, and may be used in +combination with each other or with regular buffer macros. For an explanation +of each annotation, see the advanced annotations section. +------------------------------------------------------------------------------- +*/ + +#define __success(expr) _SAL1_1_Source_(__success, (expr), _Success_(expr)) +#define __nullterminated _SAL1_Source_(__nullterminated, (), _Null_terminated_) +#define __nullnullterminated _SAL1_Source_(__nullnulltermiated, (), _SAL_nop_impl_) +#define __reserved _SAL1_Source_(__reserved, (), _Reserved_) +#define __checkReturn _SAL1_Source_(__checkReturn, (), _Check_return_) +#define __typefix(ctype) _SAL1_Source_(__typefix, (ctype), __inner_typefix(ctype)) +#define __override __inner_override +#define __callback __inner_callback +#define __format_string _SAL1_1_Source_(__format_string, (), _Printf_format_string_) +#define __blocksOn(resource) _SAL_L_Source_(__blocksOn, (resource), __inner_blocksOn(resource)) +#define __control_entrypoint(category) _SAL_L_Source_(__control_entrypoint, (category), __inner_control_entrypoint(category)) +#define __data_entrypoint(category) _SAL_L_Source_(__data_entrypoint, (category), __inner_data_entrypoint(category)) + +#ifdef _USING_V110_SDK71_ // [ +#ifndef _PREFAST_ // [ +#define __useHeader +#else // ][ +#error Code analysis is not supported when using Visual C++ 11.0/12.0 with the Windows 7.1 SDK. +#endif // ] +#else // ][ +#define __useHeader _Use_decl_anno_impl_ +#endif // ] + +#ifdef _USING_V110_SDK71_ // [ +#ifndef _PREFAST_ // [ +#define __on_failure(annotes) +#else // ][ +#error Code analysis is not supported when using Visual C++ 11.0/12.0 with the Windows 7.1 SDK. +#endif // ] +#else // ][ +#define __on_failure(annotes) _SAL1_1_Source_(__on_failure, (annotes), _On_failure_impl_(annotes _SAL_nop_impl_)) +#endif // ] + +#ifndef __fallthrough // [ +#if (!defined(_MSVC_LANG) || _MSVC_LANG < 201703l) // [ + __inner_fallthrough_dec + #define __fallthrough __inner_fallthrough +#else // ][ + #define __fallthrough [[fallthrough]] +#endif // ] +#endif // ] + +#ifndef __analysis_assume // [ +#ifdef _PREFAST_ // [ +#define __analysis_assume(expr) __assume(expr) +#else // ][ +#define __analysis_assume(expr) +#endif // ] +#endif // ] + +#ifndef _Analysis_assume_ // [ +#ifdef _PREFAST_ // [ +#define _Analysis_assume_(expr) __assume(expr) +#else // ][ +#define _Analysis_assume_(expr) +#endif // ] +#endif // ] + +#define _Analysis_noreturn_ _SAL2_Source_(_Analysis_noreturn_, (), _SA_annotes0(SAL_terminates)) + +#ifdef _PREFAST_ // [ +__inline __nothrow +void __AnalysisAssumeNullterminated(_Post_ _Null_terminated_ const void *p); + +#define _Analysis_assume_nullterminated_(x) __AnalysisAssumeNullterminated(x) + +#else // ][ +#define _Analysis_assume_nullterminated_(x) +#endif // ] + +// +// Set the analysis mode (global flags to analysis). +// They take effect at the point of declaration; use at global scope +// as a declaration. +// + +// Synthesize a unique symbol. +#define ___MKID(x, y) x ## y +#define __MKID(x, y) ___MKID(x, y) +#define __GENSYM(x) __MKID(x, __COUNTER__) + +__ANNOTATION(SAL_analysisMode(__AuToQuOtE __In_impl_ char *mode);) + +#define _Analysis_mode_impl_(mode) _SAL2_Source_(_Analysis_mode_impl_, (mode), _SA_annotes1(SAL_analysisMode, #mode)) + +// +// Floating point warnings are only meaningful in kernel-mode on x86 +// so avoid reporting them on other platforms. +// +#ifndef _M_IX86 // [ + +#define _Analysis_mode_(mode) \ + __pragma(warning(disable: 28110 28111 28161 28162)) \ + typedef _Analysis_mode_impl_(mode) int \ + __GENSYM(__prefast_analysis_mode_flag); + +#else // ][ + +#define _Analysis_mode_(mode) \ + typedef _Analysis_mode_impl_(mode) int \ + __GENSYM(__prefast_analysis_mode_flag); + +#endif // ] + +// The following are predefined: +// _Analysis_operator_new_throw_ (operator new throws) +// _Analysis_operator_new_null_ (operator new returns null) +// _Analysis_operator_new_never_fails_ (operator new never fails) +// + +// Function class annotations. +__ANNOTATION(SAL_functionClassNew(__In_impl_ char*);) +__PRIMOP(int, _In_function_class_(__In_impl_ char*);) +#define _In_function_class_(x) _In_function_class_(#x) +#define _Called_from_function_class_(x) _In_function_class_(x) + +#define _Function_class_(x) _SAL2_Source_(_Function_class_, (x), _SA_annotes1(SAL_functionClassNew, _SA_SPECSTRIZE(x))) + +#define _Enum_is_bitflag_ _SAL2_Source_(_Enum_is_bitflag_, (), _SA_annotes0(SAL_enumIsBitflag)) +#define _Strict_type_match_ _SAL2_Source_(_Strict_type_match, (), _SA_annotes0(SAL_strictType2)) + +#define _Maybe_raises_SEH_exception_ _SAL2_Source_(_Maybe_raises_SEH_exception_, (x), _Pre_ _SA_annotes1(SAL_inTry,__yes)) +#define _Raises_SEH_exception_ _SAL2_Source_(_Raises_SEH_exception_, (x), _Maybe_raises_SEH_exception_ _Analysis_noreturn_) + +#ifdef __cplusplus // [ +} +#endif // ] + +#include +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsi.h new file mode 100644 index 0000000000000000000000000000000000000000..b18a81c9edc40d6e6ab74ddf36132729afcba5c1 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsi.h @@ -0,0 +1,7356 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + scsi.h + +Abstract: + + These are the structures and defines that are used in the + SCSI port and class drivers. + +Authors: + +Revision History: + +--*/ + + +#ifndef _NTSCSI_ +#define _NTSCSI_ + +#include + +#pragma region Desktop Family or Storage Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_STORAGE) + +#ifndef _NTSCSI_USER_MODE_ +#ifndef _NTSRB_ + +#ifndef _MINIPORT_ +#ifndef _NTDDK_ + +// +// For user-mode application development, make sure to add the line "#define _NTSCSI_USER_MODE_" prior to "#include " +// +// For example, +// +// #define _NTSCSI_USER_MODE_ +// #include +// #undef _NTSCSI_USER_MODE_ +// +// Also see the SPTI sample (located in src\storage\tools\spti directory under the Windows Kits root directory) +// +#error "For user-mode application development, make sure to #define _NTSCSI_USER_MODE_ prior to #include " + +#endif // !defined _NTDDK_ +#endif // !defined _MINIPORT_ + +#include "srb.h" + +#endif // !defined _NTSRB_ +#endif // !defined _NTSCSI_USER_MODE_ + +#pragma warning(push) +#pragma warning(disable:4200) // array[0] is not a warning for this file +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union +#pragma warning(disable:4214) // nonstandard extension used : bit field types other than int + +#pragma pack(push, _scsi_) + +// begin_ntminitape + +// begin_storport begin_privstorport + +// +// Calculate the byte offset of a field in a structure of type type. +// + +#ifndef FIELD_OFFSET +#define FIELD_OFFSET(type, field) ((LONG)(LONG_PTR)&(((type *)0)->field)) +#endif + +// +// Calculate the size of a field in a structure of type type, without +// knowing or stating the type of the field. +// + +#ifndef RTL_FIELD_SIZE +#define RTL_FIELD_SIZE(type, field) (sizeof(((type *)0)->field)) +#endif + +// +// Calculate the size of a structure of type type up through and +// including a field. +// + +#ifndef RTL_SIZEOF_THROUGH_FIELD +#define RTL_SIZEOF_THROUGH_FIELD(type, field) \ + (FIELD_OFFSET(type, field) + RTL_FIELD_SIZE(type, field)) +#endif + +// +// RTL_CONTAINS_FIELD usage: +// +// if (RTL_CONTAINS_FIELD(pBlock, pBlock->cbSize, dwMumble)) { // safe to use pBlock->dwMumble +// + +#ifndef RTL_CONTAINS_FIELD +#define RTL_CONTAINS_FIELD(Struct, Size, Field) \ + ( (((PCHAR)(&(Struct)->Field)) + sizeof((Struct)->Field)) <= (((PCHAR)(Struct))+(Size)) ) +#endif + +#ifndef RtlZeroMemory +#define RtlZeroMemory(Destination,Length) memset((Destination),0,(Length)) +#endif + +// +// Command Descriptor Block. Passed by SCSI controller chip over the SCSI bus +// + +#pragma pack(push, cdb, 1) +typedef union _CDB { + + // + // Generic 6-Byte CDB + // + + struct _CDB6GENERIC { + UCHAR OperationCode; + UCHAR Immediate : 1; + UCHAR CommandUniqueBits : 4; + UCHAR LogicalUnitNumber : 3; + UCHAR CommandUniqueBytes[3]; + UCHAR Link : 1; + UCHAR Flag : 1; + UCHAR Reserved : 4; + UCHAR VendorUnique : 2; + } CDB6GENERIC; + + // + // Standard 6-byte CDB + // + + struct _CDB6READWRITE { + UCHAR OperationCode; // 0x08, 0x0A - SCSIOP_READ, SCSIOP_WRITE + UCHAR LogicalBlockMsb1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlockMsb0; + UCHAR LogicalBlockLsb; + UCHAR TransferBlocks; + UCHAR Control; + } CDB6READWRITE; + + // + // SCSI-1 Inquiry CDB + // + + struct _CDB6INQUIRY { + UCHAR OperationCode; // 0x12 - SCSIOP_INQUIRY + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR PageCode; + UCHAR IReserved; + UCHAR AllocationLength; + UCHAR Control; + } CDB6INQUIRY; + + // + // SCSI-3 Inquiry CDB + // + + struct _CDB6INQUIRY3 { + UCHAR OperationCode; // 0x12 - SCSIOP_INQUIRY + UCHAR EnableVitalProductData : 1; + UCHAR CommandSupportData : 1; + UCHAR Reserved1 : 6; + UCHAR PageCode; + UCHAR Reserved2; + UCHAR AllocationLength; + UCHAR Control; + } CDB6INQUIRY3; + + struct _CDB6VERIFY { + UCHAR OperationCode; // 0x13 - SCSIOP_VERIFY + UCHAR Fixed : 1; + UCHAR ByteCompare : 1; + UCHAR Immediate : 1; + UCHAR Reserved : 2; + UCHAR LogicalUnitNumber : 3; + UCHAR VerificationLength[3]; + UCHAR Control; + } CDB6VERIFY; + + struct _RECEIVE_DIAGNOSTIC { + UCHAR OperationCode; // 0x1C - SCSIOP_RECEIVE_DIAGNOSTIC + UCHAR PageCodeValid : 1; + UCHAR Reserved : 7; + UCHAR PageCode; + UCHAR AllocationLength[2]; + UCHAR Control; + } RECEIVE_DIAGNOSTIC; + + struct _SEND_DIAGNOSTIC { + UCHAR OperationCode; // 0x1D - SCSIOP_SEND_DIAGNOSTIC + UCHAR UnitOffline : 1; + UCHAR DeviceOffline : 1; + UCHAR SelfTest : 1; + UCHAR Reserved1 : 1; + UCHAR PageFormat : 1; + UCHAR SelfTestCode: 3; + UCHAR Reserved2; + UCHAR ParameterListLength[2]; + UCHAR Control; + } SEND_DIAGNOSTIC; + + // + // SCSI Format CDB + // + + struct _CDB6FORMAT { + UCHAR OperationCode; // 0x04 - SCSIOP_FORMAT_UNIT + UCHAR FormatControl : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR FReserved1; + UCHAR InterleaveMsb; + UCHAR InterleaveLsb; + UCHAR FReserved2; + } CDB6FORMAT; + + // + // Standard 10-byte CDB + + struct _CDB10 { + UCHAR OperationCode; + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 2; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlockByte0; + UCHAR LogicalBlockByte1; + UCHAR LogicalBlockByte2; + UCHAR LogicalBlockByte3; + UCHAR Reserved2; + UCHAR TransferBlocksMsb; + UCHAR TransferBlocksLsb; + UCHAR Control; + } CDB10; + + // + // Standard 12-byte CDB + // + + struct _CDB12 { + UCHAR OperationCode; + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 2; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlock[4]; + UCHAR TransferLength[4]; + UCHAR Reserved2; + UCHAR Control; + } CDB12; + + + + // + // Standard 16-byte CDB + // + + struct _CDB16 { + UCHAR OperationCode; + UCHAR Reserved1 : 3; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR Protection : 3; + UCHAR LogicalBlock[8]; + UCHAR TransferLength[4]; + UCHAR Reserved2; + UCHAR Control; + } CDB16; + + // + // Read Buffer(10) command from SPC-5 + // + + struct _READ_BUFFER_10 { + + UCHAR OperationCode; // 0x3c - SCSIOP_READ_DATA_BUFF + UCHAR Mode : 5; + UCHAR ModeSpecific : 3; + UCHAR BufferId; + UCHAR BufferOffset[3]; + UCHAR AllocationLength[3]; + UCHAR Control; + + } READ_BUFFER_10; + + // + // Read Buffer(16) command from SPC-5 + // + + struct _READ_BUFFER_16 { + + UCHAR OperationCode; // 0x9b - SCSIOP_READ_DATA_BUFF16 + UCHAR Mode : 5; + UCHAR ModeSpecific : 3; + UCHAR BufferOffset[8]; + UCHAR AllocationLength[4]; + UCHAR BufferId; + UCHAR Control; + + } READ_BUFFER_16; + + // + // Security-related commands from SPC-4 + // + + struct _SECURITY_PROTOCOL_IN { + + UCHAR OperationCode; + UCHAR SecurityProtocol; + UCHAR SecurityProtocolSpecific[2]; + UCHAR Reserved1 : 7; + UCHAR INC_512 : 1; + UCHAR Reserved2; + UCHAR AllocationLength[4]; + UCHAR Reserved3; + UCHAR Control; + + } SECURITY_PROTOCOL_IN; + + struct _SECURITY_PROTOCOL_OUT { + + UCHAR OperationCode; + UCHAR SecurityProtocol; + UCHAR SecurityProtocolSpecific[2]; + UCHAR Reserved1 : 7; + UCHAR INC_512 : 1; + UCHAR Reserved2; + UCHAR AllocationLength[4]; + UCHAR Reserved3; + UCHAR Control; + + } SECURITY_PROTOCOL_OUT; + + // + // Block Device UNMAP CDB + // + + struct _UNMAP { + UCHAR OperationCode; // 0x42 - SCSIOP_UNMAP + UCHAR Anchor : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[4]; + UCHAR GroupNumber : 5; + UCHAR Reserved3 : 3; + UCHAR AllocationLength[2]; + UCHAR Control; + } UNMAP; + + // + // Block Device SANITIZE CDB (SBC-4) + // + + struct _SANITIZE { + UCHAR OperationCode; // 0x48 - SCSIOP_SANITIZE + UCHAR ServiceAction : 5; + UCHAR AUSE : 1; + UCHAR Reserved1 : 1; + UCHAR Immediate : 1; + UCHAR Reserved2[5]; + UCHAR ParameterListLength[2]; + UCHAR Control; + } SANITIZE; + + // + // CD Rom Audio CDBs + // + + struct _PAUSE_RESUME { + UCHAR OperationCode; // 0x4B - SCSIOP_PAUSE_RESUME + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[6]; + UCHAR Action; + UCHAR Control; + } PAUSE_RESUME; + + // + // Read Table of Contents + // + + struct _READ_TOC { + UCHAR OperationCode; // 0x43 - SCSIOP_READ_TOC + UCHAR Reserved0 : 1; + UCHAR Msf : 1; + UCHAR Reserved1 : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR Format2 : 4; + UCHAR Reserved2 : 4; + UCHAR Reserved3[3]; + UCHAR StartingTrack; + UCHAR AllocationLength[2]; + UCHAR Control : 6; + UCHAR Format : 2; + } READ_TOC; + + struct _READ_DISK_INFORMATION { + UCHAR OperationCode; // 0x51 - SCSIOP_READ_DISC_INFORMATION + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR Reserved2[5]; + UCHAR AllocationLength[2]; + UCHAR Control; + } READ_DISK_INFORMATION, READ_DISC_INFORMATION; + + struct _READ_TRACK_INFORMATION { + UCHAR OperationCode; // 0x52 - SCSIOP_READ_TRACK_INFORMATION + UCHAR Track : 2; + UCHAR Reserved4 : 3; + UCHAR Lun : 3; + UCHAR BlockAddress[4]; // or Track Number + UCHAR Reserved3; + UCHAR AllocationLength[2]; + UCHAR Control; + } READ_TRACK_INFORMATION; + + struct _RESERVE_TRACK_RZONE { + UCHAR OperationCode; // 0x53 - SCSIOP_RESERVE_TRACK_RZONE + UCHAR Reserved1[4]; + UCHAR ReservationSize[4]; + UCHAR Control; + } RESERVE_TRACK_RZONE; + + struct _SEND_OPC_INFORMATION { + UCHAR OperationCode; // 0x54 - SCSIOP_SEND_OPC_INFORMATION + UCHAR DoOpc : 1; // perform OPC + UCHAR Reserved1 : 7; + UCHAR Exclude0 : 1; // exclude layer 0 + UCHAR Exclude1 : 1; // exclude layer 1 + UCHAR Reserved2 : 6; + UCHAR Reserved3[4]; + UCHAR ParameterListLength[2]; + UCHAR Reserved4; + } SEND_OPC_INFORMATION; + + struct _REPAIR_TRACK { + UCHAR OperationCode; // 0x58 - SCSIOP_REPAIR_TRACK + UCHAR Immediate : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[2]; + UCHAR TrackNumber[2]; + UCHAR Reserved3[3]; + UCHAR Control; + } REPAIR_TRACK; + + struct _CLOSE_TRACK { + UCHAR OperationCode; // 0x5B - SCSIOP_CLOSE_TRACK_SESSION + UCHAR Immediate : 1; + UCHAR Reserved1 : 7; + UCHAR Track : 1; + UCHAR Session : 1; + UCHAR Reserved2 : 6; + UCHAR Reserved3; + UCHAR TrackNumber[2]; + UCHAR Reserved4[3]; + UCHAR Control; + } CLOSE_TRACK; + + struct _READ_BUFFER_CAPACITY { + UCHAR OperationCode; // 0x5C - SCSIOP_READ_BUFFER_CAPACITY + UCHAR BlockInfo : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[5]; + UCHAR AllocationLength[2]; + UCHAR Control; + } READ_BUFFER_CAPACITY; + + struct _SEND_CUE_SHEET { + UCHAR OperationCode; // 0x5D - SCSIOP_SEND_CUE_SHEET + UCHAR Reserved[5]; + UCHAR CueSheetSize[3]; + UCHAR Control; + } SEND_CUE_SHEET; + + struct _READ_HEADER { + UCHAR OperationCode; // 0x44 - SCSIOP_READ_HEADER + UCHAR Reserved1 : 1; + UCHAR Msf : 1; + UCHAR Reserved2 : 3; + UCHAR Lun : 3; + UCHAR LogicalBlockAddress[4]; + UCHAR Reserved3; + UCHAR AllocationLength[2]; + UCHAR Control; + } READ_HEADER; + + struct _PLAY_AUDIO { + UCHAR OperationCode; // 0x45 - SCSIOP_PLAY_AUDIO + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR StartingBlockAddress[4]; + UCHAR Reserved2; + UCHAR PlayLength[2]; + UCHAR Control; + } PLAY_AUDIO; + + struct _PLAY_AUDIO_MSF { + UCHAR OperationCode; // 0x47 - SCSIOP_PLAY_AUDIO_MSF + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2; + UCHAR StartingM; + UCHAR StartingS; + UCHAR StartingF; + UCHAR EndingM; + UCHAR EndingS; + UCHAR EndingF; + UCHAR Control; + } PLAY_AUDIO_MSF; + + struct _BLANK_MEDIA { + UCHAR OperationCode; // 0xA1 - SCSIOP_BLANK + UCHAR BlankType : 3; + UCHAR Reserved1 : 1; + UCHAR Immediate : 1; + UCHAR Reserved2 : 3; + UCHAR AddressOrTrack[4]; + UCHAR Reserved3[5]; + UCHAR Control; + } BLANK_MEDIA; + + struct _PLAY_CD { + UCHAR OperationCode; // 0xBC - SCSIOP_PLAY_CD + UCHAR Reserved1 : 1; + UCHAR CMSF : 1; // LBA = 0, MSF = 1 + UCHAR ExpectedSectorType : 3; + UCHAR Lun : 3; + + union { + struct _LBA { + UCHAR StartingBlockAddress[4]; + UCHAR PlayLength[4]; + } LBA; + + struct _MSF { + UCHAR Reserved1; + UCHAR StartingM; + UCHAR StartingS; + UCHAR StartingF; + UCHAR EndingM; + UCHAR EndingS; + UCHAR EndingF; + UCHAR Reserved2; + } MSF; + }; + + UCHAR Audio : 1; + UCHAR Composite : 1; + UCHAR Port1 : 1; + UCHAR Port2 : 1; + UCHAR Reserved2 : 3; + UCHAR Speed : 1; + UCHAR Control; + } PLAY_CD; + + struct _SCAN_CD { + UCHAR OperationCode; // 0xBA - SCSIOP_SCAN_CD + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 3; + UCHAR Direct : 1; + UCHAR Lun : 3; + UCHAR StartingAddress[4]; + UCHAR Reserved2[3]; + UCHAR Reserved3 : 6; + UCHAR Type : 2; + UCHAR Reserved4; + UCHAR Control; + } SCAN_CD; + + struct _STOP_PLAY_SCAN { + UCHAR OperationCode; // 0x4E - SCSIOP_STOP_PLAY_SCAN + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR Reserved2[7]; + UCHAR Control; + } STOP_PLAY_SCAN; + + + // + // Read SubChannel Data + // + + struct _SUBCHANNEL { + UCHAR OperationCode; // 0x42 - SCSIOP_READ_SUB_CHANNEL + UCHAR Reserved0 : 1; + UCHAR Msf : 1; + UCHAR Reserved1 : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2 : 6; + UCHAR SubQ : 1; + UCHAR Reserved3 : 1; + UCHAR Format; + UCHAR Reserved4[2]; + UCHAR TrackNumber; + UCHAR AllocationLength[2]; + UCHAR Control; + } SUBCHANNEL; + + // + // Read CD. Used by Atapi for raw sector reads. + // + + struct _READ_CD { + UCHAR OperationCode; // 0xBE - SCSIOP_READ_CD + UCHAR RelativeAddress : 1; + UCHAR Reserved0 : 1; + UCHAR ExpectedSectorType : 3; + UCHAR Lun : 3; + UCHAR StartingLBA[4]; + UCHAR TransferBlocks[3]; + UCHAR Reserved2 : 1; + UCHAR ErrorFlags : 2; + UCHAR IncludeEDC : 1; + UCHAR IncludeUserData : 1; + UCHAR HeaderCode : 2; + UCHAR IncludeSyncData : 1; + UCHAR SubChannelSelection : 3; + UCHAR Reserved3 : 5; + UCHAR Control; + } READ_CD; + + struct _READ_CD_MSF { + UCHAR OperationCode; // 0xB9 - SCSIOP_READ_CD_MSF + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 1; + UCHAR ExpectedSectorType : 3; + UCHAR Lun : 3; + UCHAR Reserved2; + UCHAR StartingM; + UCHAR StartingS; + UCHAR StartingF; + UCHAR EndingM; + UCHAR EndingS; + UCHAR EndingF; + UCHAR Reserved4 : 1; + UCHAR ErrorFlags : 2; + UCHAR IncludeEDC : 1; + UCHAR IncludeUserData : 1; + UCHAR HeaderCode : 2; + UCHAR IncludeSyncData : 1; + UCHAR SubChannelSelection : 3; + UCHAR Reserved5 : 5; + UCHAR Control; + } READ_CD_MSF; + + // + // Plextor Read CD-DA + // + + struct _PLXTR_READ_CDDA { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR Reserved0 : 5; + UCHAR LogicalUnitNumber :3; + UCHAR LogicalBlockByte0; + UCHAR LogicalBlockByte1; + UCHAR LogicalBlockByte2; + UCHAR LogicalBlockByte3; + UCHAR TransferBlockByte0; + UCHAR TransferBlockByte1; + UCHAR TransferBlockByte2; + UCHAR TransferBlockByte3; + UCHAR SubCode; + UCHAR Control; + } PLXTR_READ_CDDA; + + // + // NEC Read CD-DA + // + + struct _NEC_READ_CDDA { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR Reserved0; + UCHAR LogicalBlockByte0; + UCHAR LogicalBlockByte1; + UCHAR LogicalBlockByte2; + UCHAR LogicalBlockByte3; + UCHAR Reserved1; + UCHAR TransferBlockByte0; + UCHAR TransferBlockByte1; + UCHAR Control; + } NEC_READ_CDDA; + + // + // Mode sense + // + +#if (NTDDI_VERSION >= NTDDI_WIN8) + struct _MODE_SENSE { + UCHAR OperationCode; // 0x1A - SCSIOP_MODE_SENSE + UCHAR Reserved1 : 3; + UCHAR Dbd : 1; + UCHAR Reserved2 : 4; + UCHAR PageCode : 6; + UCHAR Pc : 2; + UCHAR SubPageCode; + UCHAR AllocationLength; + UCHAR Control; + } MODE_SENSE; + + struct _MODE_SENSE10 { + UCHAR OperationCode; // 0x5A - SCSIOP_MODE_SENSE10 + UCHAR Reserved1 : 3; + UCHAR Dbd : 1; + UCHAR LongLBAAccepted : 1; + UCHAR Reserved2 : 3; + UCHAR PageCode : 6; + UCHAR Pc : 2; + UCHAR SubPageCode; + UCHAR Reserved3[3]; + UCHAR AllocationLength[2]; + UCHAR Control; + } MODE_SENSE10; +#else + struct _MODE_SENSE { + UCHAR OperationCode; // 0x1A - SCSIOP_MODE_SENSE + UCHAR Reserved1 : 3; + UCHAR Dbd : 1; + UCHAR Reserved2 : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR PageCode : 6; + UCHAR Pc : 2; + UCHAR Reserved3; + UCHAR AllocationLength; + UCHAR Control; + } MODE_SENSE; + + struct _MODE_SENSE10 { + UCHAR OperationCode; // 0x5A - SCSIOP_MODE_SENSE10 + UCHAR Reserved1 : 3; + UCHAR Dbd : 1; + UCHAR Reserved2 : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR PageCode : 6; + UCHAR Pc : 2; + UCHAR Reserved3[4]; + UCHAR AllocationLength[2]; + UCHAR Control; + } MODE_SENSE10; +#endif + + // + // Mode select + // + + struct _MODE_SELECT { + UCHAR OperationCode; // 0x15 - SCSIOP_MODE_SELECT + UCHAR SPBit : 1; + UCHAR Reserved1 : 3; + UCHAR PFBit : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[2]; + UCHAR ParameterListLength; + UCHAR Control; + } MODE_SELECT; + + struct _MODE_SELECT10 { + UCHAR OperationCode; // 0x55 - SCSIOP_MODE_SELECT10 + UCHAR SPBit : 1; + UCHAR Reserved1 : 3; + UCHAR PFBit : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[5]; + UCHAR ParameterListLength[2]; + UCHAR Control; + } MODE_SELECT10; + + struct _LOCATE { + UCHAR OperationCode; // 0x2B - SCSIOP_LOCATE + UCHAR Immediate : 1; + UCHAR CPBit : 1; + UCHAR BTBit : 1; + UCHAR Reserved1 : 2; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved3; + UCHAR LogicalBlockAddress[4]; + UCHAR Reserved4; + UCHAR Partition; + UCHAR Control; + } LOCATE; + + struct _LOGSENSE { + UCHAR OperationCode; // 0x4D - SCSIOP_LOG_SENSE + UCHAR SPBit : 1; + UCHAR PPCBit : 1; + UCHAR Reserved1 : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR PageCode : 6; + UCHAR PCBit : 2; + union { + UCHAR SubPageCode; + UCHAR Reserved2; + }; + UCHAR Reserved3; + UCHAR ParameterPointer[2]; + UCHAR AllocationLength[2]; + UCHAR Control; + } LOGSENSE; + + struct _LOGSELECT { + UCHAR OperationCode; // 0x4C - SCSIOP_LOG_SELECT + UCHAR SPBit : 1; + UCHAR PCRBit : 1; + UCHAR Reserved1 : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved : 6; + UCHAR PCBit : 2; + UCHAR Reserved2[4]; + UCHAR ParameterListLength[2]; + UCHAR Control; + } LOGSELECT; + + struct _PRINT { + UCHAR OperationCode; // 0x0A - SCSIOP_PRINT + UCHAR Reserved : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR TransferLength[3]; + UCHAR Control; + } PRINT; + + struct _SEEK { + UCHAR OperationCode; // 0x2B - SCSIOP_SEEK + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlockAddress[4]; + UCHAR Reserved2[3]; + UCHAR Control; + } SEEK; + + struct _ERASE { + UCHAR OperationCode; // 0x19 - SCSIOP_ERASE + UCHAR Long : 1; + UCHAR Immediate : 1; + UCHAR Reserved1 : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[3]; + UCHAR Control; + } ERASE; + + struct _START_STOP { + UCHAR OperationCode; // 0x1B - SCSIOP_START_STOP_UNIT + UCHAR Immediate: 1; + UCHAR Reserved1 : 4; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[2]; + UCHAR Start : 1; + UCHAR LoadEject : 1; + UCHAR Reserved3 : 6; + UCHAR Control; + } START_STOP; + + struct _MEDIA_REMOVAL { + UCHAR OperationCode; // 0x1E - SCSIOP_MEDIUM_REMOVAL + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR Reserved2[2]; + + UCHAR Prevent : 1; + UCHAR Persistant : 1; + UCHAR Reserved3 : 6; + + UCHAR Control; + } MEDIA_REMOVAL; + + // + // Tape CDBs + // + + struct _SEEK_BLOCK { + UCHAR OperationCode; // 0x0C - SCSIOP_SEEK_BLOCK + UCHAR Immediate : 1; + UCHAR Reserved1 : 7; + UCHAR BlockAddress[3]; + UCHAR Link : 1; + UCHAR Flag : 1; + UCHAR Reserved2 : 4; + UCHAR VendorUnique : 2; + } SEEK_BLOCK; + + struct _REQUEST_BLOCK_ADDRESS { + UCHAR OperationCode; // 0x02 - SCSIOP_REQUEST_BLOCK_ADDR + UCHAR Reserved1[3]; + UCHAR AllocationLength; + UCHAR Link : 1; + UCHAR Flag : 1; + UCHAR Reserved2 : 4; + UCHAR VendorUnique : 2; + } REQUEST_BLOCK_ADDRESS; + + struct _PARTITION { + UCHAR OperationCode; // 0x0D - SCSIOP_PARTITION + UCHAR Immediate : 1; + UCHAR Sel: 1; + UCHAR PartitionSelect : 6; + UCHAR Reserved1[3]; + UCHAR Control; + } PARTITION; + + struct _WRITE_TAPE_MARKS { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR Immediate : 1; + UCHAR WriteSetMarks: 1; + UCHAR Reserved : 3; + UCHAR LogicalUnitNumber : 3; + UCHAR TransferLength[3]; + UCHAR Control; + } WRITE_TAPE_MARKS; + + struct _SPACE_TAPE_MARKS { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR Code : 3; + UCHAR Reserved : 2; + UCHAR LogicalUnitNumber : 3; + UCHAR NumMarksMSB ; + UCHAR NumMarks; + UCHAR NumMarksLSB; + union { + UCHAR value; + struct { + UCHAR Link : 1; + UCHAR Flag : 1; + UCHAR Reserved : 4; + UCHAR VendorUnique : 2; + } Fields; + } Byte6; + } SPACE_TAPE_MARKS; + + // + // Read tape position + // + + struct _READ_POSITION { + UCHAR Operation; // 0x43 - SCSIOP_READ_POSITION + UCHAR BlockType:1; + UCHAR Reserved1:4; + UCHAR Lun:3; + UCHAR Reserved2[7]; + UCHAR Control; + } READ_POSITION; + + // + // ReadWrite for Tape + // + + struct _CDB6READWRITETAPE { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR VendorSpecific : 5; + UCHAR Reserved : 3; + UCHAR TransferLenMSB; + UCHAR TransferLen; + UCHAR TransferLenLSB; + UCHAR Link : 1; + UCHAR Flag : 1; + UCHAR Reserved1 : 4; + UCHAR VendorUnique : 2; + } CDB6READWRITETAPE; + + // + // Medium changer CDB's + // + + struct _INIT_ELEMENT_STATUS { + UCHAR OperationCode; // 0x07 - SCSIOP_INIT_ELEMENT_STATUS + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNubmer : 3; + UCHAR Reserved2[3]; + UCHAR Reserved3 : 7; + UCHAR NoBarCode : 1; + } INIT_ELEMENT_STATUS; + + struct _INITIALIZE_ELEMENT_RANGE { + UCHAR OperationCode; // 0xE7 - SCSIOP_INIT_ELEMENT_RANGE + UCHAR Range : 1; + UCHAR Reserved1 : 4; + UCHAR LogicalUnitNubmer : 3; + UCHAR FirstElementAddress[2]; + UCHAR Reserved2[2]; + UCHAR NumberOfElements[2]; + UCHAR Reserved3; + UCHAR Reserved4 : 7; + UCHAR NoBarCode : 1; + } INITIALIZE_ELEMENT_RANGE; + + struct _POSITION_TO_ELEMENT { + UCHAR OperationCode; // 0x2B - SCSIOP_POSITION_TO_ELEMENT + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR TransportElementAddress[2]; + UCHAR DestinationElementAddress[2]; + UCHAR Reserved2[2]; + UCHAR Flip : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } POSITION_TO_ELEMENT; + + struct _MOVE_MEDIUM { + UCHAR OperationCode; // 0xA5 - SCSIOP_MOVE_MEDIUM + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR TransportElementAddress[2]; + UCHAR SourceElementAddress[2]; + UCHAR DestinationElementAddress[2]; + UCHAR Reserved2[2]; + UCHAR Flip : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } MOVE_MEDIUM; + + struct _EXCHANGE_MEDIUM { + UCHAR OperationCode; // 0xA6 - SCSIOP_EXCHANGE_MEDIUM + UCHAR Reserved1 : 5; + UCHAR LogicalUnitNumber : 3; + UCHAR TransportElementAddress[2]; + UCHAR SourceElementAddress[2]; + UCHAR Destination1ElementAddress[2]; + UCHAR Destination2ElementAddress[2]; + UCHAR Flip1 : 1; + UCHAR Flip2 : 1; + UCHAR Reserved3 : 6; + UCHAR Control; + } EXCHANGE_MEDIUM; + + struct _READ_ELEMENT_STATUS { + UCHAR OperationCode; // 0xB8 - SCSIOP_READ_ELEMENT_STATUS + UCHAR ElementType : 4; + UCHAR VolTag : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR StartingElementAddress[2]; + UCHAR NumberOfElements[2]; + UCHAR Reserved1; + UCHAR AllocationLength[3]; + UCHAR Reserved2; + UCHAR Control; + } READ_ELEMENT_STATUS; + + struct _SEND_VOLUME_TAG { + UCHAR OperationCode; // 0xB6 - SCSIOP_SEND_VOLUME_TAG + UCHAR ElementType : 4; + UCHAR Reserved1 : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR StartingElementAddress[2]; + UCHAR Reserved2; + UCHAR ActionCode : 5; + UCHAR Reserved3 : 3; + UCHAR Reserved4[2]; + UCHAR ParameterListLength[2]; + UCHAR Reserved5; + UCHAR Control; + } SEND_VOLUME_TAG; + + struct _REQUEST_VOLUME_ELEMENT_ADDRESS { + UCHAR OperationCode; // Unknown -- vendor-unique? + UCHAR ElementType : 4; + UCHAR VolTag : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR StartingElementAddress[2]; + UCHAR NumberElements[2]; + UCHAR Reserved1; + UCHAR AllocationLength[3]; + UCHAR Reserved2; + UCHAR Control; + } REQUEST_VOLUME_ELEMENT_ADDRESS; + + // + // Atapi 2.5 Changer 12-byte CDBs + // + + struct _LOAD_UNLOAD { + UCHAR OperationCode; // 0xA6 - SCSIOP_LOAD_UNLOAD_SLOT + UCHAR Immediate : 1; + UCHAR Reserved1 : 4; + UCHAR Lun : 3; + UCHAR Reserved2[2]; + UCHAR Start : 1; + UCHAR LoadEject : 1; + UCHAR Reserved3: 6; + UCHAR Reserved4[3]; + UCHAR Slot; + UCHAR Reserved5[3]; + } LOAD_UNLOAD; + + struct _MECH_STATUS { + UCHAR OperationCode; // 0xBD - SCSIOP_MECHANISM_STATUS + UCHAR Reserved : 5; + UCHAR Lun : 3; + UCHAR Reserved1[6]; + UCHAR AllocationLength[2]; + UCHAR Reserved2[1]; + UCHAR Control; + } MECH_STATUS; + + // + // C/DVD 0.9 CDBs + // + + struct _SYNCHRONIZE_CACHE10 { + + UCHAR OperationCode; // 0x35 - SCSIOP_SYNCHRONIZE_CACHE + + UCHAR RelAddr : 1; + UCHAR Immediate : 1; + UCHAR Reserved : 3; + UCHAR Lun : 3; + + UCHAR LogicalBlockAddress[4]; // Unused - set to zero + UCHAR Reserved2; + UCHAR BlockCount[2]; // Unused - set to zero + UCHAR Control; + } SYNCHRONIZE_CACHE10; + + struct _GET_EVENT_STATUS_NOTIFICATION { + UCHAR OperationCode; // 0x4A - SCSIOP_GET_EVENT_STATUS_NOTIFICATION + + UCHAR Immediate : 1; + UCHAR Reserved : 4; + UCHAR Lun : 3; + + UCHAR Reserved2[2]; + UCHAR NotificationClassRequest; + UCHAR Reserved3[2]; + UCHAR EventListLength[2]; + + UCHAR Control; + } GET_EVENT_STATUS_NOTIFICATION; + + struct _GET_PERFORMANCE { + UCHAR OperationCode; // 0xAC - SCSIOP_GET_PERFORMANCE + UCHAR Except : 2; + UCHAR Write : 1; + UCHAR Tolerance : 2; + UCHAR Reserved0 : 3; + UCHAR StartingLBA[4]; + UCHAR Reserved1[2]; + UCHAR MaximumNumberOfDescriptors[2]; + UCHAR Type; + UCHAR Control; + } GET_PERFORMANCE; + + struct _READ_DVD_STRUCTURE { + UCHAR OperationCode; // 0xAD - SCSIOP_READ_DVD_STRUCTURE + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR RMDBlockNumber[4]; + UCHAR LayerNumber; + UCHAR Format; + UCHAR AllocationLength[2]; + UCHAR Reserved3 : 6; + UCHAR AGID : 2; + UCHAR Control; + } READ_DVD_STRUCTURE; + + struct _SET_STREAMING { + UCHAR OperationCode; // 0xB6 - SCSIOP_SET_STREAMING + UCHAR Reserved[8]; + UCHAR ParameterListLength[2]; + UCHAR Control; + } SET_STREAMING; + + struct _SEND_DVD_STRUCTURE { + UCHAR OperationCode; // 0xBF - SCSIOP_SEND_DVD_STRUCTURE + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR Reserved2[5]; + UCHAR Format; + UCHAR ParameterListLength[2]; + UCHAR Reserved3; + UCHAR Control; + } SEND_DVD_STRUCTURE; + + struct _SEND_KEY { + UCHAR OperationCode; // 0xA3 - SCSIOP_SEND_KEY + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR Reserved2[6]; + UCHAR ParameterListLength[2]; + UCHAR KeyFormat : 6; + UCHAR AGID : 2; + UCHAR Control; + } SEND_KEY; + + struct _REPORT_KEY { + UCHAR OperationCode; // 0xA4 - SCSIOP_REPORT_KEY + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR LogicalBlockAddress[4]; // for title key + UCHAR Reserved2[2]; + UCHAR AllocationLength[2]; + UCHAR KeyFormat : 6; + UCHAR AGID : 2; + UCHAR Control; + } REPORT_KEY; + + struct _SET_READ_AHEAD { + UCHAR OperationCode; // 0xA7 - SCSIOP_SET_READ_AHEAD + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR TriggerLBA[4]; + UCHAR ReadAheadLBA[4]; + UCHAR Reserved2; + UCHAR Control; + } SET_READ_AHEAD; + + struct _READ_FORMATTED_CAPACITIES { + UCHAR OperationCode; // 0x23 - SCSIOP_READ_FORMATTED_CAPACITY + UCHAR Reserved1 : 5; + UCHAR Lun : 3; + UCHAR Reserved2[5]; + UCHAR AllocationLength[2]; + UCHAR Control; + } READ_FORMATTED_CAPACITIES; + + // + // SCSI-3 + // + + struct _REPORT_LUNS { + UCHAR OperationCode; // 0xA0 - SCSIOP_REPORT_LUNS + UCHAR Reserved1[5]; + UCHAR AllocationLength[4]; + UCHAR Reserved2[1]; + UCHAR Control; + } REPORT_LUNS; + + struct _PERSISTENT_RESERVE_IN { + UCHAR OperationCode; // 0x5E - SCSIOP_PERSISTENT_RESERVE_IN + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR Reserved2[5]; + UCHAR AllocationLength[2]; + UCHAR Control; + } PERSISTENT_RESERVE_IN; + + struct _PERSISTENT_RESERVE_OUT { + UCHAR OperationCode; // 0x5F - SCSIOP_PERSISTENT_RESERVE_OUT + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR Type : 4; + UCHAR Scope : 4; + UCHAR Reserved2[4]; + UCHAR ParameterListLength[2]; // 0x18 + UCHAR Control; + } PERSISTENT_RESERVE_OUT; + + struct _REPORT_TIMESTAMP { + + UCHAR OperationCode; // Byte 0 : SCSIOP_MAINTENANCE_IN + UCHAR ServiceAction : 5; // Byte 1, bit 0-4 : SERVICE_ACTION_REPORT_TIMESTAMP + UCHAR Reserved1 : 3; // Byte 1, bit 5-7 + UCHAR Reserved2[4]; // Byte 2-5 + UCHAR AllocationLength[4]; // Byte 6-9 + UCHAR Reserved3; // Byte 10 + UCHAR Control; // Byte 11 + + } REPORT_TIMESTAMP; + + struct _SET_TIMESTAMP { + + UCHAR OperationCode; // Byte 0 : SCSIOP_MAINTENANCE_OUT + UCHAR ServiceAction : 5; // Byte 1, bit 0-4 : SERVICE_ACTION_SET_TIMESTAMP + UCHAR Reserved1 : 3; // Byte 1, bit 5-7 + UCHAR Reserved2[4]; // Byte 2-5 + UCHAR ParameterListLength[4]; // Byte 6-9 + UCHAR Reserved3; // Byte 10 + UCHAR Control; // Byte 11 + + } SET_TIMESTAMP; + + struct _REPORT_SUPPORTED_OPERATION_CODES { + UCHAR OperationCode; // 0xA3 SCSIOP_MAINTENANCE_IN + UCHAR ServiceAction : 5; // 0x0C SERVICE_ACTION_REPORT_SUPPORTED_OPERATION_CODES + UCHAR Reserved0 : 3; + UCHAR ReportOptions : 3; + UCHAR Reserved1 : 4; + UCHAR ReturnCommandTimeoutsDescriptor : 1; + UCHAR RequestedOperationCode; + UCHAR RequestedServiceAction[2]; + UCHAR AllocationLength[4]; + UCHAR Reserved2; + UCHAR Control; + } REPORT_SUPPORTED_OPERATION_CODES; + + // + // MMC / SFF-8090 commands + // + + struct _GET_CONFIGURATION { + UCHAR OperationCode; // 0x46 - SCSIOP_GET_CONFIGURATION + UCHAR RequestType : 2; // SCSI_GET_CONFIGURATION_REQUEST_TYPE_* + UCHAR Reserved1 : 6; // includes obsolete LUN field + UCHAR StartingFeature[2]; + UCHAR Reserved2[3]; + UCHAR AllocationLength[2]; + UCHAR Control; + } GET_CONFIGURATION; + + struct _SET_CD_SPEED { + UCHAR OperationCode; // 0xB8 - SCSIOP_SET_CD_SPEED + union { + UCHAR Reserved1; + struct { + UCHAR RotationControl : 2; + UCHAR Reserved3 : 6; + }; + }; + UCHAR ReadSpeed[2]; // 1x == (75 * 2352) + UCHAR WriteSpeed[2]; // 1x == (75 * 2352) + UCHAR Reserved2[5]; + UCHAR Control; + } SET_CD_SPEED; + + struct _READ12 { + UCHAR OperationCode; // 0xA8 - SCSIOP_READ12 + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 2; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlock[4]; + UCHAR TransferLength[4]; + UCHAR Reserved2 : 7; + UCHAR Streaming : 1; + UCHAR Control; + } READ12; + + struct _WRITE12 { + UCHAR OperationCode; // 0xAA - SCSIOP_WRITE12 + UCHAR RelativeAddress : 1; + UCHAR Reserved1 : 1; + UCHAR EBP : 1; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR LogicalUnitNumber : 3; + UCHAR LogicalBlock[4]; + UCHAR TransferLength[4]; + UCHAR Reserved2 : 7; + UCHAR Streaming : 1; + UCHAR Control; + } WRITE12; + + struct _ATA_PASSTHROUGH12 { + UCHAR OperationCode; // 0xA1 - SCSIOP_ATA_PASSTHROUGH12 + UCHAR Reserved1 : 1; + UCHAR Protocol : 4; + UCHAR MultipleCount : 3; + UCHAR TLength : 2; + UCHAR ByteBlock : 1; + UCHAR TDir : 1; + UCHAR Reserved2 : 1; + UCHAR CkCond : 1; + UCHAR Offline : 2; + UCHAR Features; + UCHAR SectorCount; + UCHAR LbaLow; + UCHAR LbaMid; + UCHAR LbaHigh; + UCHAR Device; + UCHAR Command; + UCHAR Reserved3; + UCHAR Control; + } ATA_PASSTHROUGH12; + + // + // 16-byte CDBs + // + + struct _READ16 { + UCHAR OperationCode; // 0x88 - SCSIOP_READ16 + UCHAR DurationLimitDescriptor2 : 1; + UCHAR Reserved1 : 1; + UCHAR RebuildAssistRecoveryControl : 1; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR ReadProtect : 3; + UCHAR LogicalBlock[8]; + UCHAR TransferLength[4]; + UCHAR Group : 6; + UCHAR DurationLimitDescriptor0 : 1; + UCHAR DurationLimitDescriptor1 : 1; + UCHAR Control; + } READ16; + + struct _WRITE16 { + UCHAR OperationCode; // 0x8A - SCSIOP_WRITE16 + UCHAR DurationLimitDescriptor2 : 1; + UCHAR Reserved1 : 2; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR WriteProtect : 3; + UCHAR LogicalBlock[8]; + UCHAR TransferLength[4]; + UCHAR Group : 6; + UCHAR DurationLimitDescriptor0 : 1; + UCHAR DurationLimitDescriptor1 : 1; + UCHAR Control; + } WRITE16; + + struct _VERIFY16 { + UCHAR OperationCode; // 0x8F - SCSIOP_VERIFY16 + UCHAR Reserved1 : 1; + UCHAR ByteCheck : 1; + UCHAR BlockVerify : 1; + UCHAR Reserved2 : 1; + UCHAR DisablePageOut : 1; + UCHAR VerifyProtect : 3; + UCHAR LogicalBlock[8]; + UCHAR VerificationLength[4]; + UCHAR Reserved3 : 7; + UCHAR Streaming : 1; + UCHAR Control; + } VERIFY16; + + struct _SYNCHRONIZE_CACHE16 { + UCHAR OperationCode; // 0x91 - SCSIOP_SYNCHRONIZE_CACHE16 + UCHAR Reserved1 : 1; + UCHAR Immediate : 1; + UCHAR Reserved2 : 6; + UCHAR LogicalBlock[8]; + UCHAR BlockCount[4]; + UCHAR Reserved3; + UCHAR Control; + } SYNCHRONIZE_CACHE16; + + struct _READ_CAPACITY16 { + UCHAR OperationCode; // 0x9E - SCSIOP_READ_CAPACITY16 + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR LogicalBlock[8]; + UCHAR AllocationLength[4]; + UCHAR PMI : 1; + UCHAR Reserved2 : 7; + UCHAR Control; + } READ_CAPACITY16; + + struct _ATA_PASSTHROUGH16 { + UCHAR OperationCode; // 0x85 - SCSIOP_ATA_PASSTHROUGH16 + UCHAR Extend : 1; + UCHAR Protocol : 4; + UCHAR MultipleCount : 3; + UCHAR TLength : 2; + UCHAR ByteBlock : 1; + UCHAR TDir : 1; + UCHAR Reserved1 : 1; + UCHAR CkCond : 1; + UCHAR Offline : 2; + UCHAR Features15_8; + UCHAR Features7_0; + UCHAR SectorCount15_8; + UCHAR SectorCount7_0; + UCHAR LbaLow15_8; + UCHAR LbaLow7_0; + UCHAR LbaMid15_8; + UCHAR LbaMid7_0; + UCHAR LbaHigh15_8; + UCHAR LbaHigh7_0; + UCHAR Device; + UCHAR Command; + UCHAR Control; + } ATA_PASSTHROUGH16; + + struct _GET_LBA_STATUS { + UCHAR OperationCode; // 0x9E SCSIOP_GET_LBA_STATUS + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR StartingLBA[8]; + UCHAR AllocationLength[4]; + UCHAR Reserved2; + UCHAR Control; + } GET_LBA_STATUS; + + struct _TOKEN_OPERATION { + UCHAR OperationCode; // 0x83 SCSIOP_POPULATE_TOKEN, SCSIOP_WRITE_USING_TOKEN + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR Reserved2[4]; + UCHAR ListIdentifier[4]; + UCHAR ParameterListLength[4]; + UCHAR GroupNumber : 5; + UCHAR Reserved3 : 3; + UCHAR Control; + } TOKEN_OPERATION; + + struct _RECEIVE_TOKEN_INFORMATION { + UCHAR OperationCode; // 0x84 SCSIOP_RECEIVE_ROD_TOKEN_INFORMATION + UCHAR ServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR ListIdentifier[4]; + UCHAR Reserved2[4]; + UCHAR AllocationLength[4]; + UCHAR Reserved3; + UCHAR Control; + } RECEIVE_TOKEN_INFORMATION; + + struct _WRITE_BUFFER { + UCHAR OperationCode; // 0x3B SCSIOP_WRITE_DATA_BUFF + UCHAR Mode : 5; + UCHAR ModeSpecific : 3; + UCHAR BufferID; + UCHAR BufferOffset[3]; + UCHAR ParameterListLength[3]; + UCHAR Control; + } WRITE_BUFFER; + + struct _CLOSE_ZONE { + UCHAR OperationCode; // 0x94 - SCSIOP_ZBC_OUT + UCHAR ServiceAction : 5; // 0x01 - SERVICE_ACTION_CLOSE_ZONE + UCHAR Reserved1 : 3; + UCHAR ZoneId[8]; + UCHAR Reserved2[4]; + UCHAR All : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } CLOSE_ZONE; + + struct _FINISH_ZONE { + UCHAR OperationCode; // 0x94 - SCSIOP_ZBC_OUT + UCHAR ServiceAction : 5; // 0x02 - SERVICE_ACTION_FINISH_ZONE + UCHAR Reserved1 : 3; + UCHAR ZoneId[8]; + UCHAR Reserved2[4]; + UCHAR All : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } FINISH_ZONE; + + struct _OPEN_ZONE { + UCHAR OperationCode; // 0x94 - SCSIOP_ZBC_OUT + UCHAR ServiceAction : 5; // 0x03 - SERVICE_ACTION_OPEN_ZONE + UCHAR Reserved1 : 3; + UCHAR ZoneId[8]; + UCHAR Reserved2[4]; + UCHAR All : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } OPEN_ZONE; + + struct _RESET_WRITE_POINTER { + UCHAR OperationCode; // 0x94 - SCSIOP_ZBC_OUT + UCHAR ServiceAction : 5; // 0x04 - SERVICE_ACTION_RESET_WRITE_POINTER + UCHAR Reserved1 : 3; + UCHAR ZoneId[8]; + UCHAR Reserved2[4]; + UCHAR All : 1; + UCHAR Reserved3 : 7; + UCHAR Control; + } RESET_WRITE_POINTER; + + struct _REPORT_ZONES { + UCHAR OperationCode; // 0x95 - SCSIOP_ZBC_IN + UCHAR ServiceAction : 5; // 0x00 - SERVICE_ACTION_REPORT_ZONES + UCHAR Reserved1 : 3; + UCHAR ZoneStartLBA[8]; + UCHAR AllocationLength[4]; + UCHAR ReportingOptions : 6; + UCHAR Reserved3 : 1; + UCHAR Partial : 1; + UCHAR Control; + } REPORT_ZONES; + + struct _GET_PHYSICAL_ELEMENT_STATUS { + UCHAR OperationCode; // 0x9E - SCSIOP_GET_PHYSICAL_ELEMENT_STATUS + UCHAR ServiceAction : 5; // 0x17 - SERVICE_ACTION_GET_PHYSICAL_ELEMENT_STATUS + UCHAR Reserved1 : 3; + UCHAR Reserved2[4]; + UCHAR StartingElement[4]; + UCHAR AllocationLength[4]; + UCHAR ReportType : 4; + UCHAR Reserved3 : 2; + UCHAR Filter : 2; + UCHAR Control; + } GET_PHYSICAL_ELEMENT_STATUS; + + struct _REMOVE_ELEMENT_AND_TRUNCATE { + UCHAR OperationCode; // 0x9E - SCSIOP_REMOVE_ELEMENT_AND_TRUNCATE + UCHAR ServiceAction : 5; // 0x18 - SERVICE_ACTION_REMOVE_ELEMENT_AND_TRUNCATE + UCHAR Reserved1 : 3; + UCHAR RequestedCapacity[8]; + UCHAR ElementIdentifier[4]; + UCHAR Reserved2; + UCHAR Control; + } REMOVE_ELEMENT_AND_TRUNCATE; + + ULONG AsUlong[4]; + UCHAR AsByte[16]; + +} CDB, *PCDB; + +typedef union _CDB32 { + + // + // Standard 32-byte CDB + // + + struct _CDB32GENERIC { + UCHAR OperationCode; + UCHAR Control; + UCHAR Reserved1[4]; + UCHAR Group : 5; + UCHAR Reserved2 : 3; + UCHAR AdditionalCDBLength; + UCHAR ServiceAction[2]; + UCHAR Reserved3; + UCHAR DurationLimitDescriptor0 : 1; + UCHAR DurationLimitDescriptor1 : 1; + UCHAR DurationLimitDescriptor2 : 1; + UCHAR Reserved4 : 5; + UCHAR LogicalBlock[8]; + UCHAR Reserved5[8]; + UCHAR TransferLength[4]; + } CDB32GENERIC; + + struct _XDWRITEREAD32 { + UCHAR OperationCode; // 0x7F - SCSIOP_OPERATION32 + UCHAR Control; + UCHAR Reserved1[4]; + UCHAR Group : 5; + UCHAR Reserved2 : 3; + UCHAR AdditionalCDBLength; // 0x18 + UCHAR ServiceAction[2]; // 0x0007 - SERVICE_ACTION_XDWRITEREAD + UCHAR XorProtectionInfo : 1; + UCHAR Reservede : 1; + UCHAR DisableWrite : 1; + UCHAR ForceUnitAccess : 1; + UCHAR DisablePageOut : 1; + UCHAR WriteProtect : 1; + UCHAR Reserved4; + UCHAR LogicalBlock[8]; + UCHAR Reserved5[8]; + UCHAR TransferLength[4]; + } XDWRITEREAD32; + + ULONG AsUlong[8]; + UCHAR AsByte[32]; + +} CDB32, *PCDB32; + +#pragma pack(pop, cdb) + + +//////////////////////////////////////////////////////////////////////////////// +// +// GET_EVENT_STATUS_NOTIFICATION +// + + +#define NOTIFICATION_OPERATIONAL_CHANGE_CLASS_MASK 0x02 +#define NOTIFICATION_POWER_MANAGEMENT_CLASS_MASK 0x04 +#define NOTIFICATION_EXTERNAL_REQUEST_CLASS_MASK 0x08 +#define NOTIFICATION_MEDIA_STATUS_CLASS_MASK 0x10 +#define NOTIFICATION_MULTI_HOST_CLASS_MASK 0x20 +#define NOTIFICATION_DEVICE_BUSY_CLASS_MASK 0x40 + + +#define NOTIFICATION_NO_CLASS_EVENTS 0x0 +#define NOTIFICATION_OPERATIONAL_CHANGE_CLASS_EVENTS 0x1 +#define NOTIFICATION_POWER_MANAGEMENT_CLASS_EVENTS 0x2 +#define NOTIFICATION_EXTERNAL_REQUEST_CLASS_EVENTS 0x3 +#define NOTIFICATION_MEDIA_STATUS_CLASS_EVENTS 0x4 +#define NOTIFICATION_MULTI_HOST_CLASS_EVENTS 0x5 +#define NOTIFICATION_DEVICE_BUSY_CLASS_EVENTS 0x6 + +#pragma pack(push, not_header, 1) +typedef struct _NOTIFICATION_EVENT_STATUS_HEADER { + UCHAR EventDataLength[2]; + + UCHAR NotificationClass : 3; + UCHAR Reserved : 4; + UCHAR NEA : 1; + + UCHAR SupportedEventClasses; +#if !defined(__midl) + UCHAR ClassEventData[0]; +#endif +} NOTIFICATION_EVENT_STATUS_HEADER, *PNOTIFICATION_EVENT_STATUS_HEADER; +#pragma pack(pop, not_header) + +#define NOTIFICATION_OPERATIONAL_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_OPERATIONAL_EVENT_CHANGE_REQUESTED 0x1 +#define NOTIFICATION_OPERATIONAL_EVENT_CHANGE_OCCURRED 0x2 + +#define NOTIFICATION_OPERATIONAL_STATUS_AVAILABLE 0x0 +#define NOTIFICATION_OPERATIONAL_STATUS_TEMPORARY_BUSY 0x1 +#define NOTIFICATION_OPERATIONAL_STATUS_EXTENDED_BUSY 0x2 + +#define NOTIFICATION_OPERATIONAL_OPCODE_NONE 0x0 +#define NOTIFICATION_OPERATIONAL_OPCODE_FEATURE_CHANGE 0x1 +#define NOTIFICATION_OPERATIONAL_OPCODE_FEATURE_ADDED 0x2 +#define NOTIFICATION_OPERATIONAL_OPCODE_UNIT_RESET 0x3 +#define NOTIFICATION_OPERATIONAL_OPCODE_FIRMWARE_CHANGED 0x4 +#define NOTIFICATION_OPERATIONAL_OPCODE_INQUIRY_CHANGED 0x5 + +// +// Class event data may be one (or none) of the following: +// + +#pragma pack(push, not_op, 1) +typedef struct _NOTIFICATION_OPERATIONAL_STATUS { // event class == 0x1 + UCHAR OperationalEvent : 4; + UCHAR Reserved1 : 4; + UCHAR OperationalStatus : 4; + UCHAR Reserved2 : 3; + UCHAR PersistentPrevented : 1; + UCHAR Operation[2]; +} NOTIFICATION_OPERATIONAL_STATUS, *PNOTIFICATION_OPERATIONAL_STATUS; +#pragma pack(pop, not_op) + + +#define NOTIFICATION_POWER_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_POWER_EVENT_CHANGE_SUCCEEDED 0x1 +#define NOTIFICATION_POWER_EVENT_CHANGE_FAILED 0x2 + +#define NOTIFICATION_POWER_STATUS_ACTIVE 0x1 +#define NOTIFICATION_POWER_STATUS_IDLE 0x2 +#define NOTIFICATION_POWER_STATUS_STANDBY 0x3 +#define NOTIFICATION_POWER_STATUS_SLEEP 0x4 + +#pragma pack(push, not_power, 1) +typedef struct _NOTIFICATION_POWER_STATUS { // event class == 0x2 + UCHAR PowerEvent : 4; + UCHAR Reserved : 4; + UCHAR PowerStatus; + UCHAR Reserved2[2]; +} NOTIFICATION_POWER_STATUS, *PNOTIFICATION_POWER_STATUS; +#pragma pack(pop, not_power) + +#define NOTIFICATION_MEDIA_EVENT_NO_EVENT 0x0 +#define NOTIFICATION_EXTERNAL_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_EXTERNAL_EVENT_BUTTON_DOWN 0x1 +#define NOTIFICATION_EXTERNAL_EVENT_BUTTON_UP 0x2 +#define NOTIFICATION_EXTERNAL_EVENT_EXTERNAL 0x3 // respond with GET_CONFIGURATION? + +#define NOTIFICATION_EXTERNAL_STATUS_READY 0x0 +#define NOTIFICATION_EXTERNAL_STATUS_PREVENT 0x1 + +#define NOTIFICATION_EXTERNAL_REQUEST_NONE 0x0000 +#define NOTIFICATION_EXTERNAL_REQUEST_QUEUE_OVERRUN 0x0001 +#define NOTIFICATION_EXTERNAL_REQUEST_PLAY 0x0101 +#define NOTIFICATION_EXTERNAL_REQUEST_REWIND_BACK 0x0102 +#define NOTIFICATION_EXTERNAL_REQUEST_FAST_FORWARD 0x0103 +#define NOTIFICATION_EXTERNAL_REQUEST_PAUSE 0x0104 +#define NOTIFICATION_EXTERNAL_REQUEST_STOP 0x0106 +#define NOTIFICATION_EXTERNAL_REQUEST_ASCII_LOW 0x0200 +#define NOTIFICATION_EXTERNAL_REQUEST_ASCII_HIGH 0x02ff + +#pragma pack(push, not_extern, 1) +typedef struct _NOTIFICATION_EXTERNAL_STATUS { // event class == 0x3 + UCHAR ExternalEvent : 4; + UCHAR Reserved1 : 4; + UCHAR ExternalStatus : 4; + UCHAR Reserved2 : 3; + UCHAR PersistentPrevented : 1; + UCHAR Request[2]; +} NOTIFICATION_EXTERNAL_STATUS, *PNOTIFICATION_EXTERNAL_STATUS; +#pragma pack(pop, not_extern) + +#define NOTIFICATION_MEDIA_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_MEDIA_EVENT_EJECT_REQUEST 0x1 +#define NOTIFICATION_MEDIA_EVENT_NEW_MEDIA 0x2 +#define NOTIFICATION_MEDIA_EVENT_MEDIA_REMOVAL 0x3 +#define NOTIFICATION_MEDIA_EVENT_MEDIA_CHANGE 0x4 + +#pragma pack(push, not_media, 1) +typedef struct _NOTIFICATION_MEDIA_STATUS { // event class == 0x4 + UCHAR MediaEvent : 4; + UCHAR Reserved : 4; + + union { + UCHAR PowerStatus; // OBSOLETE -- was improperly named in NT5 headers + UCHAR MediaStatus; // Use this for currently reserved fields + struct { + UCHAR DoorTrayOpen : 1; + UCHAR MediaPresent : 1; + UCHAR ReservedX : 6; // do not reference this directly! + }; + }; + UCHAR StartSlot; + UCHAR EndSlot; +} NOTIFICATION_MEDIA_STATUS, *PNOTIFICATION_MEDIA_STATUS; +#pragma pack(pop, not_media) + +#define NOTIFICATION_BUSY_EVENT_NO_EVENT 0x0 +#define NOTIFICATION_MULTI_HOST_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_REQUEST 0x1 +#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_GRANT 0x2 +#define NOTIFICATION_MULTI_HOST_EVENT_CONTROL_RELEASE 0x3 + +#define NOTIFICATION_MULTI_HOST_STATUS_READY 0x0 +#define NOTIFICATION_MULTI_HOST_STATUS_PREVENT 0x1 + +#define NOTIFICATION_MULTI_HOST_PRIORITY_NO_REQUESTS 0x0 +#define NOTIFICATION_MULTI_HOST_PRIORITY_LOW 0x1 +#define NOTIFICATION_MULTI_HOST_PRIORITY_MEDIUM 0x2 +#define NOTIFICATION_MULTI_HOST_PRIORITY_HIGH 0x3 + +#pragma pack(push, not_multi, 1) +typedef struct _NOTIFICATION_MULTI_HOST_STATUS { // event class == 0x5 + UCHAR MultiHostEvent : 4; + UCHAR Reserved1 : 4; + UCHAR MultiHostStatus : 4; + UCHAR Reserved2 : 3; + UCHAR PersistentPrevented : 1; + UCHAR Priority[2]; +} NOTIFICATION_MULTI_HOST_STATUS, *PNOTIFICATION_MULTI_HOST_STATUS; +#pragma pack(pop, not_multi) + +#define NOTIFICATION_BUSY_EVENT_NO_EVENT 0x0 +#define NOTIFICATION_BUSY_EVENT_NO_CHANGE 0x0 +#define NOTIFICATION_BUSY_EVENT_BUSY 0x1 +#define NOTIFICATION_BUSY_EVENT_LO_CHANGE 0x2 + +#define NOTIFICATION_BUSY_STATUS_NO_EVENT 0x0 +#define NOTIFICATION_BUSY_STATUS_POWER 0x1 +#define NOTIFICATION_BUSY_STATUS_IMMEDIATE 0x2 +#define NOTIFICATION_BUSY_STATUS_DEFERRED 0x3 + +#pragma pack(push, not_busy, 1) +typedef struct _NOTIFICATION_BUSY_STATUS { // event class == 0x6 + UCHAR DeviceBusyEvent : 4; + UCHAR Reserved : 4; + + UCHAR DeviceBusyStatus; + UCHAR Time[2]; +} NOTIFICATION_BUSY_STATUS, *PNOTIFICATION_BUSY_STATUS; +#pragma pack(pop, not_busy) + +//////////////////////////////////////////////////////////////////////////////// +// +// SECURITY PROTOCOL IN/OUT definitions (SPC-4, 6.29/6.30) +// + +#pragma pack(push, spin_prot_params, 1) +typedef struct _SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA { + + UCHAR Reserved1[6]; + UCHAR SupportedSecurityListLength[2]; + UCHAR SupportedSecurityProtocol[0]; + +} SUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA, *PSUPPORTED_SECURITY_PROTOCOLS_PARAMETER_DATA; +#pragma pack(pop, spin_prot_params) + +// Security protocols +#define SECURITY_PROTOCOL_IEEE1667 0xEE +#define TCG_SECURITY_PROTOCOL_ID_0 0x00 +#define TCG_SECURITY_PROTOCOL_ID_1 0x01 +#define TCG_SECURITY_PROTOCOL_ID_2 0x02 + +//////////////////////////////////////////////////////////////////////////////// +// +// Read DVD Structure Definitions and Constants +// + +#define DVD_FORMAT_LEAD_IN 0x00 +#define DVD_FORMAT_COPYRIGHT 0x01 +#define DVD_FORMAT_DISK_KEY 0x02 +#define DVD_FORMAT_BCA 0x03 +#define DVD_FORMAT_MANUFACTURING 0x04 + +#pragma pack(push, dvd_struct_header, 1) +typedef struct _READ_DVD_STRUCTURES_HEADER { + UCHAR Length[2]; + UCHAR Reserved[2]; + +#if !defined(__midl) + UCHAR Data[0]; +#endif +} READ_DVD_STRUCTURES_HEADER, *PREAD_DVD_STRUCTURES_HEADER; +#pragma pack(pop, dvd_struct_header) + +// +// DiskKey, BCA & Manufacturer information will provide byte arrays as their +// data. +// + +// +// CDVD 0.9 Send & Report Key Definitions and Structures +// + +#define DVD_REPORT_AGID 0x00 +#define DVD_CHALLENGE_KEY 0x01 +#define DVD_KEY_1 0x02 +#define DVD_KEY_2 0x03 +#define DVD_TITLE_KEY 0x04 +#define DVD_REPORT_ASF 0x05 +#define DVD_INVALIDATE_AGID 0x3F + +#pragma pack(push, dvdstuff, 1) +typedef struct _CDVD_KEY_HEADER { + UCHAR DataLength[2]; + UCHAR Reserved[2]; +#if !defined(__midl) + UCHAR Data[0]; +#endif +} CDVD_KEY_HEADER, *PCDVD_KEY_HEADER; + +typedef struct _CDVD_REPORT_AGID_DATA { + UCHAR Reserved1[3]; + UCHAR Reserved2 : 6; + UCHAR AGID : 2; +} CDVD_REPORT_AGID_DATA, *PCDVD_REPORT_AGID_DATA; + +typedef struct _CDVD_CHALLENGE_KEY_DATA { + UCHAR ChallengeKeyValue[10]; + UCHAR Reserved[2]; +} CDVD_CHALLENGE_KEY_DATA, *PCDVD_CHALLENGE_KEY_DATA; + +typedef struct _CDVD_KEY_DATA { + UCHAR Key[5]; + UCHAR Reserved[3]; +} CDVD_KEY_DATA, *PCDVD_KEY_DATA; + +typedef struct _CDVD_REPORT_ASF_DATA { + UCHAR Reserved1[3]; + UCHAR Success : 1; + UCHAR Reserved2 : 7; +} CDVD_REPORT_ASF_DATA, *PCDVD_REPORT_ASF_DATA; + +typedef struct _CDVD_TITLE_KEY_HEADER { + UCHAR DataLength[2]; + UCHAR Reserved1[1]; + UCHAR Reserved2 : 3; + UCHAR CGMS : 2; + UCHAR CP_SEC : 1; + UCHAR CPM : 1; + UCHAR Zero : 1; + CDVD_KEY_DATA TitleKey; +} CDVD_TITLE_KEY_HEADER, *PCDVD_TITLE_KEY_HEADER; +#pragma pack(pop, dvdstuff) + + +// +// Format Unit Data definitions and structures +// + +#pragma pack(push, format_unit, 1) +typedef struct _FORMAT_DESCRIPTOR { + UCHAR NumberOfBlocks[4]; + UCHAR FormatSubType : 2; + UCHAR FormatType : 6; + UCHAR BlockLength[3]; +} FORMAT_DESCRIPTOR, *PFORMAT_DESCRIPTOR; + +typedef struct _FORMAT_LIST_HEADER { + UCHAR Reserved; + UCHAR VendorSpecific : 1; + UCHAR Immediate : 1; + UCHAR TryOut : 1; + UCHAR IP : 1; + UCHAR STPF : 1; + UCHAR DCRT : 1; + UCHAR DPRY : 1; + UCHAR FOV : 1; + UCHAR FormatDescriptorLength[2]; +#if !defined(__midl) + FORMAT_DESCRIPTOR Descriptors[0]; +#endif +} FORMAT_LIST_HEADER, *PFORMAT_LIST_HEADER; +#pragma pack(pop, format_unit) + +// +// Read Formatted Capacity Data - returned in Big Endian Format +// + + +#pragma pack(push, formatted_capacity, 1) +typedef struct _FORMATTED_CAPACITY_DESCRIPTOR { + UCHAR NumberOfBlocks[4]; + UCHAR Maximum : 1; + UCHAR Valid : 1; + UCHAR FormatType : 6; + UCHAR BlockLength[3]; +} FORMATTED_CAPACITY_DESCRIPTOR, *PFORMATTED_CAPACITY_DESCRIPTOR; + +typedef struct _FORMATTED_CAPACITY_LIST { + UCHAR Reserved[3]; + UCHAR CapacityListLength; +#if !defined(__midl) + FORMATTED_CAPACITY_DESCRIPTOR Descriptors[0]; +#endif +} FORMATTED_CAPACITY_LIST, *PFORMATTED_CAPACITY_LIST; +#pragma pack(pop, formatted_capacity) + +// +// BLANK command blanking type codes +// + +#define BLANK_FULL 0x0 +#define BLANK_MINIMAL 0x1 +#define BLANK_TRACK 0x2 +#define BLANK_UNRESERVE_TRACK 0x3 +#define BLANK_TAIL 0x4 +#define BLANK_UNCLOSE_SESSION 0x5 +#define BLANK_SESSION 0x6 + +// +// PLAY_CD definitions and constants +// + +#define CD_EXPECTED_SECTOR_ANY 0x0 +#define CD_EXPECTED_SECTOR_CDDA 0x1 +#define CD_EXPECTED_SECTOR_MODE1 0x2 +#define CD_EXPECTED_SECTOR_MODE2 0x3 +#define CD_EXPECTED_SECTOR_MODE2_FORM1 0x4 +#define CD_EXPECTED_SECTOR_MODE2_FORM2 0x5 + +// +// Read Disk Information Definitions and Capabilities +// + +#define DISK_STATUS_EMPTY 0x00 +#define DISK_STATUS_INCOMPLETE 0x01 +#define DISK_STATUS_COMPLETE 0x02 +#define DISK_STATUS_OTHERS 0x03 + +#define LAST_SESSION_EMPTY 0x00 +#define LAST_SESSION_INCOMPLETE 0x01 +#define LAST_SESSION_RESERVED_DAMAGED 0x02 +#define LAST_SESSION_COMPLETE 0x03 + +#define DISK_TYPE_CDDA 0x00 +#define DISK_TYPE_CDI 0x10 +#define DISK_TYPE_XA 0x20 +#define DISK_TYPE_UNDEFINED 0xFF + +// +// Values for MrwStatus field. +// + +#define DISC_BGFORMAT_STATE_NONE 0x0 +#define DISC_BGFORMAT_STATE_INCOMPLETE 0x1 +#define DISC_BGFORMAT_STATE_RUNNING 0x2 +#define DISC_BGFORMAT_STATE_COMPLETE 0x3 + + +#pragma pack(push, discinfo, 1) +typedef struct _OPC_TABLE_ENTRY { + UCHAR Speed[2]; + UCHAR OPCValue[6]; +} OPC_TABLE_ENTRY, *POPC_TABLE_ENTRY; + +typedef struct _DISC_INFORMATION { + + UCHAR Length[2]; + UCHAR DiscStatus : 2; + UCHAR LastSessionStatus : 2; + UCHAR Erasable : 1; + UCHAR Reserved1 : 3; + UCHAR FirstTrackNumber; + + UCHAR NumberOfSessionsLsb; + UCHAR LastSessionFirstTrackLsb; + UCHAR LastSessionLastTrackLsb; + UCHAR MrwStatus : 2; + UCHAR MrwDirtyBit : 1; + UCHAR Reserved2 : 2; + UCHAR URU : 1; + UCHAR DBC_V : 1; + UCHAR DID_V : 1; + + UCHAR DiscType; + UCHAR NumberOfSessionsMsb; + UCHAR LastSessionFirstTrackMsb; + UCHAR LastSessionLastTrackMsb; + + UCHAR DiskIdentification[4]; + UCHAR LastSessionLeadIn[4]; // HMSF + UCHAR LastPossibleLeadOutStartTime[4]; // HMSF + UCHAR DiskBarCode[8]; + + UCHAR Reserved4; + UCHAR NumberOPCEntries; + OPC_TABLE_ENTRY OPCTable[ 1 ]; // can be many of these here.... + +} DISC_INFORMATION, *PDISC_INFORMATION; + +// TODO: Deprecate DISK_INFORMATION +//#if PRAGMA_DEPRECATED_DDK +//#pragma deprecated(_DISK_INFORMATION) // Use DISC_INFORMATION, note size change +//#pragma deprecated( DISK_INFORMATION) // Use DISC_INFORMATION, note size change +//#pragma deprecated(PDISK_INFORMATION) // Use DISC_INFORMATION, note size change +//#endif + +typedef struct _DISK_INFORMATION { + UCHAR Length[2]; + + UCHAR DiskStatus : 2; + UCHAR LastSessionStatus : 2; + UCHAR Erasable : 1; + UCHAR Reserved1 : 3; + + UCHAR FirstTrackNumber; + UCHAR NumberOfSessions; + UCHAR LastSessionFirstTrack; + UCHAR LastSessionLastTrack; + + UCHAR Reserved2 : 5; + UCHAR GEN : 1; + UCHAR DBC_V : 1; + UCHAR DID_V : 1; + + UCHAR DiskType; + UCHAR Reserved3[3]; + + UCHAR DiskIdentification[4]; + UCHAR LastSessionLeadIn[4]; // MSF + UCHAR LastPossibleStartTime[4]; // MSF + UCHAR DiskBarCode[8]; + + UCHAR Reserved4; + UCHAR NumberOPCEntries; +#if !defined(__midl) + OPC_TABLE_ENTRY OPCTable[0]; +#endif +} DISK_INFORMATION, *PDISK_INFORMATION; +#pragma pack(pop, discinfo) + + +// +// Read Header definitions and structures +// +#pragma pack(push, cdheader, 1) +typedef struct _DATA_BLOCK_HEADER { + UCHAR DataMode; + UCHAR Reserved[4]; + union { + UCHAR LogicalBlockAddress[4]; + struct { + UCHAR Reserved; + UCHAR M; + UCHAR S; + UCHAR F; + } MSF; + }; +} DATA_BLOCK_HEADER, *PDATA_BLOCK_HEADER; +#pragma pack(pop, cdheader) + + +#define DATA_BLOCK_MODE0 0x0 +#define DATA_BLOCK_MODE1 0x1 +#define DATA_BLOCK_MODE2 0x2 + +// +// Read TOC Format Codes +// + +#define READ_TOC_FORMAT_TOC 0x00 +#define READ_TOC_FORMAT_SESSION 0x01 +#define READ_TOC_FORMAT_FULL_TOC 0x02 +#define READ_TOC_FORMAT_PMA 0x03 +#define READ_TOC_FORMAT_ATIP 0x04 + +// TODO: Deprecate TRACK_INFORMATION structure, use TRACK_INFORMATION2 instead +#pragma pack(push, track_info, 1) +typedef struct _TRACK_INFORMATION { + UCHAR Length[2]; + UCHAR TrackNumber; + UCHAR SessionNumber; + UCHAR Reserved1; + UCHAR TrackMode : 4; + UCHAR Copy : 1; + UCHAR Damage : 1; + UCHAR Reserved2 : 2; + UCHAR DataMode : 4; + UCHAR FP : 1; + UCHAR Packet : 1; + UCHAR Blank : 1; + UCHAR RT : 1; + UCHAR NWA_V : 1; + UCHAR Reserved3 : 7; + UCHAR TrackStartAddress[4]; + UCHAR NextWritableAddress[4]; + UCHAR FreeBlocks[4]; + UCHAR FixedPacketSize[4]; +} TRACK_INFORMATION, *PTRACK_INFORMATION; + +// Second Revision Modifies: +// * Longer names for some fields +// * LSB to track/session number fields +// * LRA_V bit +// Second Revision Adds: +// * TrackSize +// * LastRecordedAddress +// * MSB to track/session +// * Two reserved bytes +// Total structure size increased by 12 (0x0C) bytes +typedef struct _TRACK_INFORMATION2 { + + UCHAR Length[2]; + UCHAR TrackNumberLsb; + UCHAR SessionNumberLsb; + + UCHAR Reserved4; + UCHAR TrackMode : 4; + UCHAR Copy : 1; + UCHAR Damage : 1; + UCHAR Reserved5 : 2; + UCHAR DataMode : 4; + UCHAR FixedPacket : 1; + UCHAR Packet : 1; + UCHAR Blank : 1; + UCHAR ReservedTrack : 1; + UCHAR NWA_V : 1; + UCHAR LRA_V : 1; + UCHAR Reserved6 : 6; + + UCHAR TrackStartAddress[4]; + UCHAR NextWritableAddress[4]; + UCHAR FreeBlocks[4]; + UCHAR FixedPacketSize[4]; // blocking factor + UCHAR TrackSize[4]; + UCHAR LastRecordedAddress[4]; + + UCHAR TrackNumberMsb; + UCHAR SessionNumberMsb; + UCHAR Reserved7[2]; + +} TRACK_INFORMATION2, *PTRACK_INFORMATION2; + +// Third Revision Adds +// * ReadCompatibilityLBA +// Total structure size increased by 4 bytes +typedef struct _TRACK_INFORMATION3 { + + UCHAR Length[2]; + UCHAR TrackNumberLsb; + UCHAR SessionNumberLsb; + + UCHAR Reserved4; + UCHAR TrackMode : 4; + UCHAR Copy : 1; + UCHAR Damage : 1; + UCHAR Reserved5 : 2; + UCHAR DataMode : 4; + UCHAR FixedPacket : 1; + UCHAR Packet : 1; + UCHAR Blank : 1; + UCHAR ReservedTrack : 1; + UCHAR NWA_V : 1; + UCHAR LRA_V : 1; + UCHAR Reserved6 : 6; + + UCHAR TrackStartAddress[4]; + UCHAR NextWritableAddress[4]; + UCHAR FreeBlocks[4]; + UCHAR FixedPacketSize[4]; // blocking factor + UCHAR TrackSize[4]; + UCHAR LastRecordedAddress[4]; + + UCHAR TrackNumberMsb; + UCHAR SessionNumberMsb; + UCHAR Reserved7[2]; + UCHAR ReadCompatibilityLba[4]; + +} TRACK_INFORMATION3, *PTRACK_INFORMATION3; + +#pragma pack(pop, track_info) + +#pragma pack(push, perf_descriptor, 1) +typedef struct _PERFORMANCE_DESCRIPTOR { + + UCHAR RandomAccess : 1; + UCHAR Exact : 1; + UCHAR RestoreDefaults : 1; + UCHAR WriteRotationControl : 2; + UCHAR Reserved1 : 3; + + UCHAR Reserved[3]; + UCHAR StartLba[4]; + UCHAR EndLba[4]; + UCHAR ReadSize[4]; + UCHAR ReadTime[4]; + UCHAR WriteSize[4]; + UCHAR WriteTime[4]; + +} PERFORMANCE_DESCRIPTOR, *PPERFORMANCE_DESCRIPTOR; +#pragma pack(pop, perf_descriptor) + +// +// Command Descriptor Block constants. +// + +#define CDB6GENERIC_LENGTH 6 +#define CDB10GENERIC_LENGTH 10 +#define CDB12GENERIC_LENGTH 12 + +#define SETBITON 1 +#define SETBITOFF 0 + +// +// Mode Sense/Select page constants. +// + +#define MODE_PAGE_VENDOR_SPECIFIC 0x00 +#define MODE_PAGE_ERROR_RECOVERY 0x01 +#define MODE_PAGE_DISCONNECT 0x02 +#define MODE_PAGE_FORMAT_DEVICE 0x03 // disk +#define MODE_PAGE_MRW 0x03 // cdrom +#define MODE_PAGE_RIGID_GEOMETRY 0x04 +#define MODE_PAGE_FLEXIBILE 0x05 // disk +#define MODE_PAGE_WRITE_PARAMETERS 0x05 // cdrom +#define MODE_PAGE_VERIFY_ERROR 0x07 +#define MODE_PAGE_CACHING 0x08 +#define MODE_PAGE_PERIPHERAL 0x09 +#define MODE_PAGE_CONTROL 0x0A +#define MODE_PAGE_MEDIUM_TYPES 0x0B +#define MODE_PAGE_NOTCH_PARTITION 0x0C +#define MODE_PAGE_CD_AUDIO_CONTROL 0x0E +#define MODE_PAGE_DATA_COMPRESS 0x0F +#define MODE_PAGE_DEVICE_CONFIG 0x10 +#define MODE_PAGE_XOR_CONTROL 0x10 // disk +#define MODE_PAGE_MEDIUM_PARTITION 0x11 +#define MODE_PAGE_ENCLOSURE_SERVICES_MANAGEMENT 0x14 +#define MODE_PAGE_EXTENDED 0x15 +#define MODE_PAGE_EXTENDED_DEVICE_SPECIFIC 0x16 +#define MODE_PAGE_CDVD_FEATURE_SET 0x18 +#define MODE_PAGE_PROTOCOL_SPECIFIC_LUN 0x18 +#define MODE_PAGE_PROTOCOL_SPECIFIC_PORT 0x19 +#define MODE_PAGE_POWER_CONDITION 0x1A +#define MODE_PAGE_LUN_MAPPING 0x1B +#define MODE_PAGE_FAULT_REPORTING 0x1C +#define MODE_PAGE_CDVD_INACTIVITY 0x1D // cdrom +#define MODE_PAGE_ELEMENT_ADDRESS 0x1D +#define MODE_PAGE_TRANSPORT_GEOMETRY 0x1E +#define MODE_PAGE_DEVICE_CAPABILITIES 0x1F +#define MODE_PAGE_CAPABILITIES 0x2A // cdrom + +#define MODE_SENSE_RETURN_ALL 0x3f + +#define MODE_SENSE_CURRENT_VALUES 0x00 +#define MODE_SENSE_CHANGEABLE_VALUES 0x40 +#define MODE_SENSE_DEFAULT_VAULES 0x80 +#define MODE_SENSE_SAVED_VALUES 0xc0 + +// +// Page Control for MODE_SENSE/MODE_SENSE10 +// +#define MODE_SENSE_CURRENT_VALUES_PAGE_CONTROL 0 +#define MODE_SENSE_CHANGEABLE_VALUES_PAGE_CONTROL 1 +#define MODE_SENSE_DEFAULT_VALUES_PAGE_CONTROL 2 +#define MODE_SENSE_SAVED_VALUES_PAGE_CONTROL 3 + +#define MODE_SUBPAGE_COMMAND_DURATION_LIMIT_A_MODE 0x03 +#define MODE_SUBPAGE_COMMAND_DURATION_LIMIT_B_MODE 0x04 +#define MODE_SUBPAGE_COMMAND_DURATION_LIMIT_T2A_MODE 0x07 +#define MODE_SUBPAGE_COMMAND_DURATION_LIMIT_T2B_MODE 0x08 + +// +// SCSI CDB operation codes +// + +// 6-byte commands: +#define SCSIOP_TEST_UNIT_READY 0x00 +#define SCSIOP_REZERO_UNIT 0x01 +#define SCSIOP_REWIND 0x01 +#define SCSIOP_REQUEST_BLOCK_ADDR 0x02 +#define SCSIOP_REQUEST_SENSE 0x03 +#define SCSIOP_FORMAT_UNIT 0x04 +#define SCSIOP_READ_BLOCK_LIMITS 0x05 +#define SCSIOP_REASSIGN_BLOCKS 0x07 +#define SCSIOP_INIT_ELEMENT_STATUS 0x07 +#define SCSIOP_READ6 0x08 +#define SCSIOP_RECEIVE 0x08 +#define SCSIOP_WRITE6 0x0A +#define SCSIOP_PRINT 0x0A +#define SCSIOP_SEND 0x0A +#define SCSIOP_SEEK6 0x0B +#define SCSIOP_TRACK_SELECT 0x0B +#define SCSIOP_SLEW_PRINT 0x0B +#define SCSIOP_SET_CAPACITY 0x0B // tape +#define SCSIOP_SEEK_BLOCK 0x0C +#define SCSIOP_PARTITION 0x0D +#define SCSIOP_READ_REVERSE 0x0F +#define SCSIOP_WRITE_FILEMARKS 0x10 +#define SCSIOP_FLUSH_BUFFER 0x10 +#define SCSIOP_SPACE 0x11 +#define SCSIOP_INQUIRY 0x12 +#define SCSIOP_VERIFY6 0x13 +#define SCSIOP_RECOVER_BUF_DATA 0x14 +#define SCSIOP_MODE_SELECT 0x15 +#define SCSIOP_RESERVE_UNIT 0x16 +#define SCSIOP_RELEASE_UNIT 0x17 +#define SCSIOP_COPY 0x18 +#define SCSIOP_ERASE 0x19 +#define SCSIOP_MODE_SENSE 0x1A +#define SCSIOP_START_STOP_UNIT 0x1B +#define SCSIOP_STOP_PRINT 0x1B +#define SCSIOP_LOAD_UNLOAD 0x1B +#define SCSIOP_RECEIVE_DIAGNOSTIC 0x1C +#define SCSIOP_SEND_DIAGNOSTIC 0x1D +#define SCSIOP_MEDIUM_REMOVAL 0x1E + +// 10-byte commands +#define SCSIOP_READ_FORMATTED_CAPACITY 0x23 +#define SCSIOP_READ_CAPACITY 0x25 +#define SCSIOP_READ 0x28 +#define SCSIOP_WRITE 0x2A +#define SCSIOP_SEEK 0x2B +#define SCSIOP_LOCATE 0x2B +#define SCSIOP_POSITION_TO_ELEMENT 0x2B +#define SCSIOP_WRITE_VERIFY 0x2E +#define SCSIOP_VERIFY 0x2F +#define SCSIOP_SEARCH_DATA_HIGH 0x30 +#define SCSIOP_SEARCH_DATA_EQUAL 0x31 +#define SCSIOP_SEARCH_DATA_LOW 0x32 +#define SCSIOP_SET_LIMITS 0x33 +#define SCSIOP_READ_POSITION 0x34 +#define SCSIOP_SYNCHRONIZE_CACHE 0x35 +#define SCSIOP_COMPARE 0x39 +#define SCSIOP_COPY_COMPARE 0x3A +#define SCSIOP_WRITE_DATA_BUFF 0x3B +#define SCSIOP_READ_DATA_BUFF 0x3C +#define SCSIOP_WRITE_LONG 0x3F +#define SCSIOP_CHANGE_DEFINITION 0x40 +#define SCSIOP_WRITE_SAME 0x41 +#define SCSIOP_READ_SUB_CHANNEL 0x42 +#define SCSIOP_UNMAP 0x42 // block device +#define SCSIOP_READ_TOC 0x43 +#define SCSIOP_READ_HEADER 0x44 +#define SCSIOP_REPORT_DENSITY_SUPPORT 0x44 // tape +#define SCSIOP_PLAY_AUDIO 0x45 +#define SCSIOP_GET_CONFIGURATION 0x46 +#define SCSIOP_PLAY_AUDIO_MSF 0x47 +#define SCSIOP_PLAY_TRACK_INDEX 0x48 +#define SCSIOP_SANITIZE 0x48 // block device +#define SCSIOP_PLAY_TRACK_RELATIVE 0x49 +#define SCSIOP_GET_EVENT_STATUS 0x4A +#define SCSIOP_PAUSE_RESUME 0x4B +#define SCSIOP_LOG_SELECT 0x4C +#define SCSIOP_LOG_SENSE 0x4D +#define SCSIOP_STOP_PLAY_SCAN 0x4E +#define SCSIOP_XDWRITE 0x50 +#define SCSIOP_XPWRITE 0x51 +#define SCSIOP_READ_DISK_INFORMATION 0x51 +#define SCSIOP_READ_DISC_INFORMATION 0x51 // proper use of disc over disk +#define SCSIOP_READ_TRACK_INFORMATION 0x52 +#define SCSIOP_XDWRITE_READ 0x53 +#define SCSIOP_RESERVE_TRACK_RZONE 0x53 +#define SCSIOP_SEND_OPC_INFORMATION 0x54 // optimum power calibration +#define SCSIOP_MODE_SELECT10 0x55 +#define SCSIOP_RESERVE_UNIT10 0x56 +#define SCSIOP_RESERVE_ELEMENT 0x56 +#define SCSIOP_RELEASE_UNIT10 0x57 +#define SCSIOP_RELEASE_ELEMENT 0x57 +#define SCSIOP_REPAIR_TRACK 0x58 +#define SCSIOP_MODE_SENSE10 0x5A +#define SCSIOP_CLOSE_TRACK_SESSION 0x5B +#define SCSIOP_READ_BUFFER_CAPACITY 0x5C +#define SCSIOP_SEND_CUE_SHEET 0x5D +#define SCSIOP_PERSISTENT_RESERVE_IN 0x5E +#define SCSIOP_PERSISTENT_RESERVE_OUT 0x5F + +// 12-byte commands +#define SCSIOP_REPORT_LUNS 0xA0 +#define SCSIOP_BLANK 0xA1 +#define SCSIOP_ATA_PASSTHROUGH12 0xA1 +#define SCSIOP_SEND_EVENT 0xA2 +#define SCSIOP_SECURITY_PROTOCOL_IN 0xA2 +#define SCSIOP_SEND_KEY 0xA3 +#define SCSIOP_MAINTENANCE_IN 0xA3 +#define SCSIOP_REPORT_KEY 0xA4 +#define SCSIOP_MAINTENANCE_OUT 0xA4 +#define SCSIOP_MOVE_MEDIUM 0xA5 +#define SCSIOP_LOAD_UNLOAD_SLOT 0xA6 +#define SCSIOP_EXCHANGE_MEDIUM 0xA6 +#define SCSIOP_SET_READ_AHEAD 0xA7 +#define SCSIOP_MOVE_MEDIUM_ATTACHED 0xA7 +#define SCSIOP_READ12 0xA8 +#define SCSIOP_GET_MESSAGE 0xA8 +#define SCSIOP_SERVICE_ACTION_OUT12 0xA9 +#define SCSIOP_WRITE12 0xAA +#define SCSIOP_SEND_MESSAGE 0xAB +#define SCSIOP_SERVICE_ACTION_IN12 0xAB +#define SCSIOP_GET_PERFORMANCE 0xAC +#define SCSIOP_READ_DVD_STRUCTURE 0xAD +#define SCSIOP_WRITE_VERIFY12 0xAE +#define SCSIOP_VERIFY12 0xAF +#define SCSIOP_SEARCH_DATA_HIGH12 0xB0 +#define SCSIOP_SEARCH_DATA_EQUAL12 0xB1 +#define SCSIOP_SEARCH_DATA_LOW12 0xB2 +#define SCSIOP_SET_LIMITS12 0xB3 +#define SCSIOP_READ_ELEMENT_STATUS_ATTACHED 0xB4 +#define SCSIOP_REQUEST_VOL_ELEMENT 0xB5 +#define SCSIOP_SECURITY_PROTOCOL_OUT 0xB5 +#define SCSIOP_SEND_VOLUME_TAG 0xB6 +#define SCSIOP_SET_STREAMING 0xB6 // C/DVD +#define SCSIOP_READ_DEFECT_DATA 0xB7 +#define SCSIOP_READ_ELEMENT_STATUS 0xB8 +#define SCSIOP_READ_CD_MSF 0xB9 +#define SCSIOP_SCAN_CD 0xBA +#define SCSIOP_REDUNDANCY_GROUP_IN 0xBA +#define SCSIOP_SET_CD_SPEED 0xBB +#define SCSIOP_REDUNDANCY_GROUP_OUT 0xBB +#define SCSIOP_PLAY_CD 0xBC +#define SCSIOP_SPARE_IN 0xBC +#define SCSIOP_MECHANISM_STATUS 0xBD +#define SCSIOP_SPARE_OUT 0xBD +#define SCSIOP_READ_CD 0xBE +#define SCSIOP_VOLUME_SET_IN 0xBE +#define SCSIOP_SEND_DVD_STRUCTURE 0xBF +#define SCSIOP_VOLUME_SET_OUT 0xBF +#define SCSIOP_INIT_ELEMENT_RANGE 0xE7 + +// 16-byte commands +#define SCSIOP_XDWRITE_EXTENDED16 0x80 // disk +#define SCSIOP_WRITE_FILEMARKS16 0x80 // tape +#define SCSIOP_REBUILD16 0x81 // disk +#define SCSIOP_READ_REVERSE16 0x81 // tape +#define SCSIOP_REGENERATE16 0x82 // disk +#define SCSIOP_EXTENDED_COPY 0x83 +#define SCSIOP_POPULATE_TOKEN 0x83 // disk +#define SCSIOP_WRITE_USING_TOKEN 0x83 // disk +#define SCSIOP_RECEIVE_COPY_RESULTS 0x84 +#define SCSIOP_RECEIVE_ROD_TOKEN_INFORMATION 0x84 //disk +#define SCSIOP_ATA_PASSTHROUGH16 0x85 +#define SCSIOP_ACCESS_CONTROL_IN 0x86 +#define SCSIOP_ACCESS_CONTROL_OUT 0x87 +#define SCSIOP_READ16 0x88 +#define SCSIOP_COMPARE_AND_WRITE 0x89 +#define SCSIOP_WRITE16 0x8A +#define SCSIOP_READ_ATTRIBUTES 0x8C +#define SCSIOP_WRITE_ATTRIBUTES 0x8D +#define SCSIOP_WRITE_VERIFY16 0x8E +#define SCSIOP_VERIFY16 0x8F +#define SCSIOP_PREFETCH16 0x90 +#define SCSIOP_SYNCHRONIZE_CACHE16 0x91 +#define SCSIOP_SPACE16 0x91 // tape +#define SCSIOP_LOCK_UNLOCK_CACHE16 0x92 +#define SCSIOP_LOCATE16 0x92 // tape +#define SCSIOP_WRITE_SAME16 0x93 +#define SCSIOP_ERASE16 0x93 // tape +#define SCSIOP_ZBC_OUT 0x94 // Close Zone, Finish Zone, Open Zone, Reset Write Pointer, etc. +#define SCSIOP_ZBC_IN 0x95 // Report Zones, etc. +#define SCSIOP_READ_DATA_BUFF16 0x9B +#define SCSIOP_READ_CAPACITY16 0x9E +#define SCSIOP_GET_LBA_STATUS 0x9E +#define SCSIOP_GET_PHYSICAL_ELEMENT_STATUS 0x9E +#define SCSIOP_REMOVE_ELEMENT_AND_TRUNCATE 0x9E +#define SCSIOP_SERVICE_ACTION_IN16 0x9E +#define SCSIOP_SERVICE_ACTION_OUT16 0x9F + + +// 32-byte commands +#define SCSIOP_OPERATION32 0x7F + + +// +// SCSIOP_SANITIZE - 0x48 +// + +#define SERVICE_ACTION_OVERWRITE 0x01 +#define SERVICE_ACTION_BLOCK_ERASE 0x02 +#define SERVICE_ACTION_CRYPTO_ERASE 0x03 +#define SERVICE_ACTION_EXIT_FAILURE 0x1f + + +// +// SCSIOP_OPERATION32 - 0x7F +// + +#define SERVICE_ACTION_XDWRITE 0x0004 +#define SERVICE_ACTION_XPWRITE 0x0006 +#define SERVICE_ACTION_XDWRITEREAD 0x0007 +#define SERVICE_ACTION_WRITE 0x000B +#define SERVICE_ACTION_WRITE_VERIFY 0x000C +#define SERVICE_ACTION_WRITE_SAME 0x000D +#define SERVICE_ACTION_ORWRITE 0x000E + +// +// SCSIOP_POPULATE_TOKEN, SCSIOP_WRITE_USING_TOKEN - 0x83 +// + +#define SERVICE_ACTION_POPULATE_TOKEN 0x10 +#define SERVICE_ACTION_WRITE_USING_TOKEN 0x11 + +// +// SCSIOP_RECEIVE_ROD_TOKEN_INFORMATION - 0x84 +// + +#define SERVICE_ACTION_RECEIVE_TOKEN_INFORMATION 0x07 + +// +// SCSIOP_ZBC_OUT - 0x94 +// + +#define SERVICE_ACTION_CLOSE_ZONE 0x01 +#define SERVICE_ACTION_FINISH_ZONE 0x02 +#define SERVICE_ACTION_OPEN_ZONE 0x03 +#define SERVICE_ACTION_RESET_WRITE_POINTER 0x04 + +// +// SCSIOP_ZBC_IN - 0x95 +// + +#define SERVICE_ACTION_REPORT_ZONES 0x00 + +#define REPORT_ZONES_OPTION_LIST_ALL_ZONES 0x00 +#define REPORT_ZONES_OPTION_LIST_EMPTY_ZONES 0x01 +#define REPORT_ZONES_OPTION_LIST_IMPLICITLY_OPENED_ZONES 0x02 +#define REPORT_ZONES_OPTION_LIST_EXPLICITLY_OPENED_ZONES 0x03 +#define REPORT_ZONES_OPTION_LIST_CLOSED_ZONES 0x04 +#define REPORT_ZONES_OPTION_LIST_FULL_ZONES 0x05 +#define REPORT_ZONES_OPTION_LIST_READ_ONLY_ZONES 0x06 +#define REPORT_ZONES_OPTION_LIST_OFFLINE_ZONES 0x07 + +#define REPORT_ZONES_OPTION_LIST_RWP_ZONES 0x10 +#define REPORT_ZONES_OPTION_LIST_NON_SEQUENTIAL_WRITE_RESOURCES_ACTIVE_ZONES 0x11 + +#define REPORT_ZONES_OPTION_LIST_NOT_WRITE_POINTER_ZONES 0x3F + +// +// SCSIOP_SERVICE_ACTION_IN16 - 0x9E +// + +#define SERVICE_ACTION_READ_CAPACITY16 0x10 +#define SERVICE_ACTION_GET_LBA_STATUS 0x12 +#define SERVICE_ACTION_GET_PHYSICAL_ELEMENT_STATUS 0x17 +#define SERVICE_ACTION_REMOVE_ELEMENT_AND_TRUNCATE 0x18 + +// +// SCSIOP_MAINTENANCE_IN - 0xA3 +// + +#define SERVICE_ACTION_REPORT_TIMESTAMP 0x0F +#define SERVICE_ACTION_REPORT_SUPPORTED_OPERATION_CODES 0x0C + +// +// SCSIOP_MAINTENANCE_OUT - 0xA4 +// + +#define SERVICE_ACTION_SET_TIMESTAMP 0x0F + +// +// If the IMMED bit is 1, status is returned as soon +// as the operation is initiated. If the IMMED bit +// is 0, status is not returned until the operation +// is completed. +// + +#define CDB_RETURN_ON_COMPLETION 0 +#define CDB_RETURN_IMMEDIATE 1 + +// end_ntminitape + +// +// CDB Force media access used in extended read and write commands. +// + +#define CDB_FORCE_MEDIA_ACCESS 0x08 + +// +// Denon CD ROM operation codes +// + +#define SCSIOP_DENON_EJECT_DISC 0xE6 +#define SCSIOP_DENON_STOP_AUDIO 0xE7 +#define SCSIOP_DENON_PLAY_AUDIO 0xE8 +#define SCSIOP_DENON_READ_TOC 0xE9 +#define SCSIOP_DENON_READ_SUBCODE 0xEB + +// +// SCSI Bus Messages +// + +#define SCSIMESS_ABORT 0x06 +#define SCSIMESS_ABORT_WITH_TAG 0x0D +#define SCSIMESS_BUS_DEVICE_RESET 0X0C +#define SCSIMESS_CLEAR_QUEUE 0X0E +#define SCSIMESS_COMMAND_COMPLETE 0X00 +#define SCSIMESS_DISCONNECT 0X04 +#define SCSIMESS_EXTENDED_MESSAGE 0X01 +#define SCSIMESS_IDENTIFY 0X80 +#define SCSIMESS_IDENTIFY_WITH_DISCON 0XC0 +#define SCSIMESS_IGNORE_WIDE_RESIDUE 0X23 +#define SCSIMESS_INITIATE_RECOVERY 0X0F +#define SCSIMESS_INIT_DETECTED_ERROR 0X05 +#define SCSIMESS_LINK_CMD_COMP 0X0A +#define SCSIMESS_LINK_CMD_COMP_W_FLAG 0X0B +#define SCSIMESS_MESS_PARITY_ERROR 0X09 +#define SCSIMESS_MESSAGE_REJECT 0X07 +#define SCSIMESS_NO_OPERATION 0X08 +#define SCSIMESS_HEAD_OF_QUEUE_TAG 0X21 +#define SCSIMESS_ORDERED_QUEUE_TAG 0X22 +#define SCSIMESS_SIMPLE_QUEUE_TAG 0X20 +#define SCSIMESS_RELEASE_RECOVERY 0X10 +#define SCSIMESS_RESTORE_POINTERS 0X03 +#define SCSIMESS_SAVE_DATA_POINTER 0X02 +#define SCSIMESS_TERMINATE_IO_PROCESS 0X11 + +// +// SCSI Extended Message operation codes +// + +#define SCSIMESS_MODIFY_DATA_POINTER 0X00 +#define SCSIMESS_SYNCHRONOUS_DATA_REQ 0X01 +#define SCSIMESS_WIDE_DATA_REQUEST 0X03 + +// +// SCSI Extended Message Lengths +// + +#define SCSIMESS_MODIFY_DATA_LENGTH 5 +#define SCSIMESS_SYNCH_DATA_LENGTH 3 +#define SCSIMESS_WIDE_DATA_LENGTH 2 + +// +// SCSI extended message structure +// + +#pragma pack(push, scsi_mess, 1) +typedef struct _SCSI_EXTENDED_MESSAGE { + UCHAR InitialMessageCode; + UCHAR MessageLength; + UCHAR MessageType; + union _EXTENDED_ARGUMENTS { + + struct { + UCHAR Modifier[4]; + } Modify; + + struct { + UCHAR TransferPeriod; + UCHAR ReqAckOffset; + } Synchronous; + + struct{ + UCHAR Width; + } Wide; + }ExtendedArguments; +}SCSI_EXTENDED_MESSAGE, *PSCSI_EXTENDED_MESSAGE; +#pragma pack(pop, scsi_mess) + +// +// SCSI bus status codes. +// + +#define SCSISTAT_GOOD 0x00 +#define SCSISTAT_CHECK_CONDITION 0x02 +#define SCSISTAT_CONDITION_MET 0x04 +#define SCSISTAT_BUSY 0x08 +#define SCSISTAT_INTERMEDIATE 0x10 +#define SCSISTAT_INTERMEDIATE_COND_MET 0x14 +#define SCSISTAT_RESERVATION_CONFLICT 0x18 +#define SCSISTAT_COMMAND_TERMINATED 0x22 +#define SCSISTAT_QUEUE_FULL 0x28 +#define SCSISTAT_TASK_ABORTED 0x40 + +// +// Enable Vital Product Data Flag (EVPD) +// used with INQUIRY command. +// + +#define CDB_INQUIRY_EVPD 0x01 + +// +// Defines for format CDB +// + +#define LUN0_FORMAT_SAVING_DEFECT_LIST 0 +#define USE_DEFAULTMSB 0 +#define USE_DEFAULTLSB 0 + +#define START_UNIT_CODE 0x01 +#define STOP_UNIT_CODE 0x00 + +// begin_ntminitape + +// +// Inquiry buffer structure. This is the data returned from the target +// after it receives an inquiry. +// +// This structure may be extended by the number of bytes specified +// in the field AdditionalLength. The defined size constant only +// includes fields through ProductRevisionLevel. +// +// The NT SCSI drivers are only interested in the first 36 bytes of data. +// + +#define INQUIRYDATABUFFERSIZE 36 + +typedef USHORT VERSION_DESCRIPTOR, *PVERSION_DESCRIPTOR; + +#define HOT_PLUGGABLE_NO_INFORMATION_PROVIDED 0x0 +#define HOT_PLUGGABLE_REMOVE_AS_SINGLE_OBJECT 0x1 +#define HOT_PLUGGABLE_NOT_REMOVE_FROM_SCSI_DOMAIN 0x2 +#define HOT_PLUGGABLE_RESERVED 0x3 + +#define HOT_PLUGGABLE_FIELD_SHIFT 0x4 + +#if (NTDDI_VERSION < NTDDI_WINXP) +typedef struct _INQUIRYDATA { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR DeviceTypeModifier : 7; + UCHAR RemovableMedia : 1; + UCHAR Versions; + UCHAR ResponseDataFormat : 4; + UCHAR HiSupport : 1; + UCHAR NormACA : 1; + UCHAR ReservedBit : 1; + UCHAR AERC : 1; + UCHAR AdditionalLength; + UCHAR Reserved[2]; + UCHAR SoftReset : 1; + UCHAR CommandQueue : 1; + UCHAR Reserved2 : 1; + UCHAR LinkedCommands : 1; + UCHAR Synchronous : 1; + UCHAR Wide16Bit : 1; + UCHAR Wide32Bit : 1; + UCHAR RelativeAddressing : 1; + UCHAR VendorId[8]; + UCHAR ProductId[16]; + UCHAR ProductRevisionLevel[4]; + UCHAR VendorSpecific[20]; + UCHAR Reserved3[2]; + VERSION_DESCRIPTOR VersionDescriptors[8]; + UCHAR Reserved4[30]; +} INQUIRYDATA, *PINQUIRYDATA; +#else +#pragma pack(push, inquiry, 1) +typedef struct _INQUIRYDATA { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + union { + struct { + UCHAR DeviceTypeModifier : 7; + UCHAR ReservedField1 : 1; + }; + struct { + UCHAR ReservedField2 : 4; + UCHAR HotPluggable : 2; + UCHAR LU_CONG: 1; + UCHAR RemovableMedia : 1; + }; + }; + union { + UCHAR Versions; + struct { + UCHAR ANSIVersion : 3; + UCHAR ECMAVersion : 3; + UCHAR ISOVersion : 2; + }; + }; + UCHAR ResponseDataFormat : 4; + UCHAR HiSupport : 1; + UCHAR NormACA : 1; + UCHAR TerminateTask : 1; + UCHAR AERC : 1; + UCHAR AdditionalLength; + union { + UCHAR Reserved; + struct { + UCHAR PROTECT : 1; + UCHAR Reserved_1 : 2; + UCHAR ThirdPartyCoppy : 1; + UCHAR TPGS : 2; + UCHAR ACC : 1; + UCHAR SCCS : 1; + }; + }; + UCHAR Addr16 : 1; // defined only for SIP devices. + UCHAR Addr32 : 1; // defined only for SIP devices. + UCHAR AckReqQ: 1; // defined only for SIP devices. + UCHAR MediumChanger : 1; + UCHAR MultiPort : 1; + UCHAR ReservedBit2 : 1; + UCHAR EnclosureServices : 1; + UCHAR ReservedBit3 : 1; + UCHAR SoftReset : 1; + UCHAR CommandQueue : 1; + UCHAR TransferDisable : 1; // defined only for SIP devices. + UCHAR LinkedCommands : 1; + UCHAR Synchronous : 1; // defined only for SIP devices. + UCHAR Wide16Bit : 1; // defined only for SIP devices. + UCHAR Wide32Bit : 1; // defined only for SIP devices. + UCHAR RelativeAddressing : 1; + UCHAR VendorId[8]; + UCHAR ProductId[16]; + UCHAR ProductRevisionLevel[4]; + UCHAR VendorSpecific[20]; + UCHAR Reserved3[2]; + VERSION_DESCRIPTOR VersionDescriptors[8]; + UCHAR Reserved4[30]; +} INQUIRYDATA, *PINQUIRYDATA; +#pragma pack(pop, inquiry) +#endif + +#define OFFSET_VER_DESCRIPTOR_ONE (FIELD_OFFSET(INQUIRYDATA, VersionDescriptors[0])) +#define OFFSET_VER_DESCRIPTOR_EIGHT (FIELD_OFFSET(INQUIRYDATA, VersionDescriptors[8])) + +// +// Inquiry defines. Used to interpret data returned from target as result +// of inquiry command. +// +// DeviceType field +// + +#define DIRECT_ACCESS_DEVICE 0x00 // disks +#define SEQUENTIAL_ACCESS_DEVICE 0x01 // tapes +#define PRINTER_DEVICE 0x02 // printers +#define PROCESSOR_DEVICE 0x03 // scanners, printers, etc +#define WRITE_ONCE_READ_MULTIPLE_DEVICE 0x04 // worms +#define READ_ONLY_DIRECT_ACCESS_DEVICE 0x05 // cdroms +#define SCANNER_DEVICE 0x06 // scanners +#define OPTICAL_DEVICE 0x07 // optical disks +#define MEDIUM_CHANGER 0x08 // jukebox +#define COMMUNICATION_DEVICE 0x09 // network +// 0xA and 0xB are obsolete +#define ARRAY_CONTROLLER_DEVICE 0x0C +#define SCSI_ENCLOSURE_DEVICE 0x0D +#define REDUCED_BLOCK_DEVICE 0x0E // e.g., 1394 disk +#define OPTICAL_CARD_READER_WRITER_DEVICE 0x0F +#define BRIDGE_CONTROLLER_DEVICE 0x10 +#define OBJECT_BASED_STORAGE_DEVICE 0x11 // OSD +#define HOST_MANAGED_ZONED_BLOCK_DEVICE 0x14 // Host managed zoned block device +#define UNKNOWN_OR_NO_DEVICE 0x1F // Unknown or no device type +#define LOGICAL_UNIT_NOT_PRESENT_DEVICE 0x7F +#define DEVICE_QUALIFIER_ACTIVE 0x00 +#define DEVICE_QUALIFIER_NOT_ACTIVE 0x01 +#define DEVICE_QUALIFIER_NOT_SUPPORTED 0x03 + +// +// DeviceTypeQualifier field +// + +#define DEVICE_CONNECTED 0x00 + +// +// Vital Product Data Pages +// + +// +// Unit Serial Number Page (page code 0x80) +// +// Provides a product serial number for the target or the logical unit. +// +#pragma pack(push, vpd_media_sn, 1) +typedef struct _VPD_MEDIA_SERIAL_NUMBER_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; + UCHAR Reserved; + UCHAR PageLength; +#if !defined(__midl) + UCHAR SerialNumber[0]; +#endif +} VPD_MEDIA_SERIAL_NUMBER_PAGE, *PVPD_MEDIA_SERIAL_NUMBER_PAGE; +#pragma pack(pop, vpd_media_sn) + +#pragma pack(push, vpd_sn, 1) +typedef struct _VPD_SERIAL_NUMBER_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; + UCHAR Reserved; + UCHAR PageLength; +#if !defined(__midl) + UCHAR SerialNumber[0]; +#endif +} VPD_SERIAL_NUMBER_PAGE, *PVPD_SERIAL_NUMBER_PAGE; +#pragma pack(pop, vpd_sn) + +// +// Device Identification Page (page code 0x83) +// Provides the means to retrieve zero or more identification descriptors +// applying to the logical unit. +// + +#pragma pack(push, vpd_stuff, 1) +typedef enum _VPD_CODE_SET { + VpdCodeSetReserved = 0, + VpdCodeSetBinary = 1, + VpdCodeSetAscii = 2, + VpdCodeSetUTF8 = 3 +} VPD_CODE_SET, *PVPD_CODE_SET; + +typedef enum _VPD_ASSOCIATION { + VpdAssocDevice = 0, + VpdAssocPort = 1, + VpdAssocTarget = 2, + VpdAssocReserved1 = 3, + VpdAssocReserved2 = 4 // bogus, only two bits +} VPD_ASSOCIATION, *PVPD_ASSOCIATION; + +typedef enum _VPD_IDENTIFIER_TYPE { + VpdIdentifierTypeVendorSpecific = 0, + VpdIdentifierTypeVendorId = 1, + VpdIdentifierTypeEUI64 = 2, + VpdIdentifierTypeFCPHName = 3, + VpdIdentifierTypePortRelative = 4, + VpdIdentifierTypeTargetPortGroup = 5, + VpdIdentifierTypeLogicalUnitGroup = 6, + VpdIdentifierTypeMD5LogicalUnitId = 7, + VpdIdentifierTypeSCSINameString = 8 +} VPD_IDENTIFIER_TYPE, *PVPD_IDENTIFIER_TYPE; + +typedef struct _VPD_IDENTIFICATION_DESCRIPTOR { + UCHAR CodeSet : 4; // VPD_CODE_SET + UCHAR Reserved : 4; + UCHAR IdentifierType : 4; // VPD_IDENTIFIER_TYPE + UCHAR Association : 2; + UCHAR Reserved2 : 2; + UCHAR Reserved3; + UCHAR IdentifierLength; +#if !defined(__midl) + UCHAR Identifier[0]; +#endif +} VPD_IDENTIFICATION_DESCRIPTOR, *PVPD_IDENTIFICATION_DESCRIPTOR; + +typedef struct _VPD_IDENTIFICATION_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; + UCHAR Reserved; + UCHAR PageLength; + + + // + // The following field is actually a variable length array of identification + // descriptors. Unfortunately there's no C notation for an array of + // variable length structures so we're forced to just pretend. + // + +#if !defined(__midl) + // VPD_IDENTIFICATION_DESCRIPTOR Descriptors[0]; + UCHAR Descriptors[0]; +#endif +} VPD_IDENTIFICATION_PAGE, *PVPD_IDENTIFICATION_PAGE; + +// +// VPD Page 0x86, Extended INQUIRY Data +// +typedef struct _VPD_EXTENDED_INQUIRY_DATA_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + + UCHAR PageCode; // 86h + UCHAR PageLength[2]; // [0] - 00h, [1] - 3Ch + + UCHAR RefChk : 1; // byte 4 bit 0 + UCHAR AppChk : 1; + UCHAR GrdChk : 1; + UCHAR Spt : 3; + UCHAR ActivateMicrocode : 2; + + UCHAR SimpSup : 1; // byte 5 bit 0 + UCHAR OrdSup : 1; + UCHAR HeadSup : 1; + UCHAR PriorSup : 1; + UCHAR GroupSup : 1; + UCHAR UaskSup : 1; + UCHAR Reserved0 : 2; + + UCHAR VSup : 1; // byte 6 bit 0 + UCHAR NvSup : 1; + UCHAR Obsolete0 : 1; + UCHAR WuSup : 1; + UCHAR Reserved1 : 4; + + UCHAR LuiClr : 1; // byte 7 bit 0 + UCHAR Reserved2 : 3; + UCHAR PiiSup : 1; + UCHAR NoPiChk : 1; + UCHAR Reserved3 : 2; + + UCHAR Obsolete1 : 1; // byte 8 bit 0 + UCHAR HssRelef : 1; + UCHAR Reserved4 : 1; + UCHAR RtdSup : 1; + UCHAR RSup : 1; + UCHAR LuCollectionType : 3; + + UCHAR Multi_i_t_Nexus_Microcode_Download : 4; // byte 9 bit 0 + UCHAR Reserved5 : 4; + + UCHAR ExtendedSelfTestCompletionMinutes[2]; + + UCHAR Reserved6 : 5; // byte 12 bit 0 + UCHAR VsaSup : 1; + UCHAR HraSup : 1; + UCHAR PoaSup : 1; + + UCHAR MaxSupportedSenseDataLength; + + UCHAR Nrd0 : 1; // byte 14 bit 0 + UCHAR Nrd1 : 1; + UCHAR Sac : 1; + UCHAR Reserved7 : 3; + UCHAR Ias : 1; + UCHAR Ibs : 1; + + UCHAR MaxInquiryChangeLogs[2]; + UCHAR MaxModePageChangeLogs[2]; + + UCHAR Reserved8[45]; +} VPD_EXTENDED_INQUIRY_DATA_PAGE, *PVPD_EXTENDED_INQUIRY_DATA_PAGE; + +// +// VPD Page 0x89, ATA Information +// +typedef struct _VPD_ATA_INFORMATION_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0x89 + UCHAR PageLength[2]; // 0x238 fixed size + UCHAR Reserved0[4]; + UCHAR VendorId[8]; + UCHAR ProductId[16]; + UCHAR ProductRevisionLevel[4]; + UCHAR DeviceSignature[20]; + UCHAR CommandCode; + UCHAR Reserved1[3]; + UCHAR IdentifyDeviceData[512]; +} VPD_ATA_INFORMATION_PAGE, *PVPD_ATA_INFORMATION_PAGE; + +#if (NTDDI_VERSION >= NTDDI_WIN8) +// +// VPD Page 0x8F, Third Party Copy +// +typedef struct _VPD_THIRD_PARTY_COPY_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0x8F + UCHAR PageLength[2]; // at least 0x24 if target supports Windows Offload Data Transfers +#if !defined(__midl) + UCHAR ThirdPartyCopyDescriptors[ANYSIZE_ARRAY]; +#endif +} VPD_THIRD_PARTY_COPY_PAGE, *PVPD_THIRD_PARTY_COPY_PAGE; + +typedef struct _WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR { + UCHAR DescriptorType[2]; // 0x00 + UCHAR DescriptorLength[2]; // 0x20 + UCHAR VendorSpecific[6]; + UCHAR MaximumRangeDescriptors[2]; + UCHAR MaximumInactivityTimer[4]; + UCHAR DefaultInactivityTimer[4]; + UCHAR MaximumTokenTransferSize[8]; + UCHAR OptimalTransferCount[8]; +} WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR, *PWINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR; + +#define BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR_TYPE_WINDOWS 0x00 + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) + +// +// VPD Page 0xB0, Block Limits +// +typedef struct _VPD_BLOCK_LIMITS_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0xB0 + UCHAR PageLength[2]; // 0x3C + + union { + struct { + UCHAR Reserved0; + + UCHAR MaximumCompareAndWriteLength; + UCHAR OptimalTransferLengthGranularity[2]; + UCHAR MaximumTransferLength[4]; + UCHAR OptimalTransferLength[4]; + UCHAR MaxPrefetchXDReadXDWriteTransferLength[4]; + UCHAR MaximumUnmapLBACount[4]; + UCHAR MaximumUnmapBlockDescriptorCount[4]; + UCHAR OptimalUnmapGranularity[4]; + union { + struct { + UCHAR UnmapGranularityAlignmentByte3 : 7; + UCHAR UGAValid : 1; + UCHAR UnmapGranularityAlignmentByte2; + UCHAR UnmapGranularityAlignmentByte1; + UCHAR UnmapGranularityAlignmentByte0; + }; + UCHAR UnmapGranularityAlignment[4]; + }; + UCHAR Reserved1[28]; + }; +#if !defined(__midl) + UCHAR Descriptors[0]; +#endif + }; +} VPD_BLOCK_LIMITS_PAGE, *PVPD_BLOCK_LIMITS_PAGE; + +// +// VPD Page 0xB1, Block Device Characteristics +// +#define ZONED_CAPABILITIES_NOT_REPORTED 0x0 +#define ZONED_CAPABILITIES_HOST_AWARE 0x1 +#define ZONED_CAPABILITIES_DEVICE_MANAGED 0x2 + +typedef struct _VPD_BLOCK_DEVICE_CHARACTERISTICS_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0xB1 + UCHAR Reserved0; + UCHAR PageLength; // 0x3C + + UCHAR MediumRotationRateMsb; + UCHAR MediumRotationRateLsb; + UCHAR MediumProductType; + + UCHAR NominalFormFactor : 4; + UCHAR WACEREQ : 2; + UCHAR WABEREQ : 2; + + UCHAR VBULS : 1; + UCHAR FUAB : 1; + UCHAR BOCS : 1; + UCHAR Reserved1 : 1; + UCHAR ZONED : 2; + UCHAR Reserved2 : 2; + + UCHAR Reserved3[3]; + UCHAR DepopulationTime[4]; + UCHAR Reserved4[48]; +} VPD_BLOCK_DEVICE_CHARACTERISTICS_PAGE, *PVPD_BLOCK_DEVICE_CHARACTERISTICS_PAGE; + +// +// VPD Page 0xB2, Logical Block Provisioning +// + +#define PROVISIONING_TYPE_UNKNOWN 0x0 +#define PROVISIONING_TYPE_RESOURCE 0x1 +#define PROVISIONING_TYPE_THIN 0x2 + +typedef struct _VPD_LOGICAL_BLOCK_PROVISIONING_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0xB2 + UCHAR PageLength[2]; + + UCHAR ThresholdExponent; + + UCHAR DP : 1; + UCHAR ANC_SUP : 1; + UCHAR LBPRZ : 1; + UCHAR Reserved0 : 2; + UCHAR LBPWS10 : 1; + UCHAR LBPWS : 1; + UCHAR LBPU : 1; + + UCHAR ProvisioningType : 3; + UCHAR Reserved1 : 5; + + UCHAR Reserved2; +#if !defined(__midl) + UCHAR ProvisioningGroupDescr[0]; +#endif +} VPD_LOGICAL_BLOCK_PROVISIONING_PAGE, *PVPD_LOGICAL_BLOCK_PROVISIONING_PAGE; + +// +// VPD Page 0xB6, Zoned Block Device Characteristics +// + +typedef struct _VPD_ZONED_BLOCK_DEVICE_CHARACTERISTICS_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; // 0xB6 + UCHAR PageLength[2]; // 0x3C + + UCHAR URSWRZ : 1; // Unrestricted Read in Sequential Write Required Zone + UCHAR Reserved1 : 7; + UCHAR Reserved2[3]; + + UCHAR OptimalNumberOfOpenSequentialWritePreferredZone[4]; + UCHAR OptimalNumberOfNonSequentiallyWrittenSequentialWritePreferredZone[4]; + UCHAR MaxNumberOfOpenSequentialWriteRequiredZone[4]; + + UCHAR Reserved3[44]; +} VPD_ZONED_BLOCK_DEVICE_CHARACTERISTICS_PAGE, *PVPD_ZONED_BLOCK_DEVICE_CHARACTERISTICS_PAGE; + + +// +// Supported Vital Product Data Pages Page (page code 0x00) +// Contains a list of the vital product data page cods supported by the target +// or logical unit. +// + +typedef struct _VPD_SUPPORTED_PAGES_PAGE { + UCHAR DeviceType : 5; + UCHAR DeviceTypeQualifier : 3; + UCHAR PageCode; + UCHAR Reserved; + UCHAR PageLength; +#if !defined(__midl) + UCHAR SupportedPageList[0]; +#endif +} VPD_SUPPORTED_PAGES_PAGE, *PVPD_SUPPORTED_PAGES_PAGE; +#pragma pack(pop, vpd_stuff) + + + +#define VPD_MAX_BUFFER_SIZE 0xff + +#define VPD_SUPPORTED_PAGES 0x00 +#define VPD_SERIAL_NUMBER 0x80 +#define VPD_DEVICE_IDENTIFIERS 0x83 +#define VPD_MEDIA_SERIAL_NUMBER 0x84 +#define VPD_SOFTWARE_INTERFACE_IDENTIFIERS 0x84 +#define VPD_NETWORK_MANAGEMENT_ADDRESSES 0x85 +#define VPD_EXTENDED_INQUIRY_DATA 0x86 +#define VPD_MODE_PAGE_POLICY 0x87 +#define VPD_SCSI_PORTS 0x88 +#define VPD_ATA_INFORMATION 0x89 + +#define VPD_THIRD_PARTY_COPY 0x8F +#define VPD_BLOCK_LIMITS 0xB0 +#define VPD_BLOCK_DEVICE_CHARACTERISTICS 0xB1 +#define VPD_LOGICAL_BLOCK_PROVISIONING 0xB2 +#define VPD_ZONED_BLOCK_DEVICE_CHARACTERISTICS 0xB6 + + +//////////////////////////////////////////////////////////////////////////////// +// +// Log page definitions +// + +#define LOG_PAGE_CODE_SUPPORTED_LOG_PAGES 0x00 +#define LOG_PAGE_CODE_WRITE_ERROR_COUNTERS 0x02 +#define LOG_PAGE_CODE_READ_ERROR_COUNTERS 0x03 +#define LOG_PAGE_CODE_LOGICAL_BLOCK_PROVISIONING 0x0C +#define LOG_PAGE_CODE_TEMPERATURE 0x0D +#define LOG_PAGE_CODE_ENVIRONMENTAL_REPORTING 0x0D +#define LOG_PAGE_CODE_STARTSTOP_CYCLE_COUNTERS 0x0E +#define LOG_PAGE_CODE_UTILIZATION 0x0E +#define LOG_PAGE_CODE_SELFTEST_RESULTS 0x10 +#define LOG_PAGE_CODE_SOLID_STATE_MEDIA 0x11 +#define LOG_PAGE_CODE_BACKGROUND_SCAN_RESULTS 0x15 +#define LOG_PAGE_CODE_PERFORMANCE_AND_STATISTICS 0x19 +#define LOG_PAGE_CODE_INFORMATIONAL_EXCEPTIONS 0x2F + +#define LOG_SUBPAGE_CODE_WRITE_ERROR_COUNTERS 0x00 +#define LOG_SUBPAGE_CODE_READ_ERROR_COUNTERS 0x00 +#define LOG_SUBPAGE_CODE_LOGICAL_BLOCK_PROVISIONING 0x00 +#define LOG_SUBPAGE_CODE_TEMPERATURE 0x00 +#define LOG_SUBPAGE_CODE_ENVIRONMENTAL_REPORTING 0x01 +#define LOG_SUBPAGE_CODE_STARTSTOP_CYCLE_COUNTERS 0x00 +#define LOG_SUBPAGE_CODE_UTILIZATION 0x01 +#define LOG_SUBPAGE_CODE_SELFTEST_RESULTS 0x00 +#define LOG_SUBPAGE_CODE_SOLID_STATE_MEDIA 0x00 +#define LOG_SUBPAGE_CODE_BACKGROUND_SCAN_RESULTS 0x00 +#define LOG_SUBPAGE_CODE_INFORMATIONAL_EXCEPTIONS 0x00 +#define LOG_SUBPAGE_CODE_COMMAND_DURATION_LIMIT_STATISTICS 0x21 +#define LOG_SUBPAGE_CODE_SUPPORTED_SUBPAGES 0xFF + +#pragma pack(push, log_page, 1) + +typedef struct _LOG_PARAMETER_HEADER { + + UCHAR ParameterCode[2]; // Bytes 0-1 + + union { + + UCHAR ControlByte; // Byte 2 + + struct { + + UCHAR FormatAndLinking : 2; // Byte 2, bit 0-1 + UCHAR TMC : 2; // Byte 2, bit 2-3 + UCHAR ETC : 1; // Byte 2, bit 4 + UCHAR TSD : 1; // Byte 2, bit 5 + UCHAR Obsolete : 1; // Byte 2, bit 6 + UCHAR DU : 1; // Byte 2, bit 7 + }; + + }; + + UCHAR ParameterLength; // Byte 3 + +} LOG_PARAMETER_HEADER, *PLOG_PARAMETER_HEADER; + +typedef struct _LOG_PARAMETER { + + LOG_PARAMETER_HEADER Header; // Bytes 0-3 + + union { + +#if !defined(__midl) + UCHAR AsByte[0]; // Bytes 4-N +#endif + + struct _THRESHOLD_RESOURCE_COUNT { + + UCHAR ResourceCount[4]; // Bytes 4-7 + UCHAR Scope : 2; // Byte 8, bit 0-1 + UCHAR Reserved1 : 6; // Byte 8, bit 2-7 + UCHAR Reserved2[3]; // Byte 9 + + } THRESHOLD_RESOURCE_COUNT; + + struct _TEMPERATURE { + + UCHAR Reserved; // Byte 4 + UCHAR Temperature; // Byte 5 + + } TEMPERATURE; + + struct _DATE_OF_MANUFACTURE { + + UCHAR Year[4]; // Bytes 4-7 + UCHAR Week[2]; // Bytes 8-9 + + } DATE_OF_MANUFACTURE; + + struct _WORKLOAD_UTILIZATION { + + UCHAR WorkloadUtilization[2]; // Bytes 4-5 + + } WORKLOAD_UTILIZATION; + + struct _SELF_TEST_RESULTS { + + UCHAR SelfTestResults : 4; // Byte 4, bit 0-3 + UCHAR Reserved1 : 1; // Byte 4, bit 4 + UCHAR SelfTestCode : 3; // Byte 4, bit 5-7 + UCHAR SelfTestNumber; // Byte 5 + UCHAR PowerOnHours[2]; // Bytes 6-7 + UCHAR AddressOfFirstFailure[8]; // Bytes 8-15 + UCHAR SenseKey : 4; // Byte 16, bit 0-3 + UCHAR Reserved2 : 4; // Byte 16, bit 4-7 + UCHAR AdditionalSenseCode; // Byte 17 + UCHAR AdditionalSenseCodeQualifier; // Byte 18 + UCHAR VendorSpecific; // Byte 19 + + } SELF_TEST_RESULTS; + + struct _SOLID_STATE_MEDIA { + + UCHAR Reserved[3]; // Bytes 4-6 + UCHAR PercentageUsed; // Byte 7 + + } SOLID_STATE_MEDIA; + + struct _BACKGROUND_SCAN_STATUS { + + UCHAR PowerOnMinutes[4]; // Bytes 4-7 + UCHAR Reserved; // Byte 8 + UCHAR ScanStatus; // Byte 9 + UCHAR ScansPerformed[2]; // Bytes 10-11 + UCHAR ScanProgress[2]; // Bytes 12-13 + UCHAR MediumScansPerformed[2]; // Bytes 14-15 + + } BACKGROUND_SCAN_STATUS; + + struct _INFORMATIONAL_EXCEPTIONS { + + UCHAR ASC; // Byte 4 + UCHAR ASCQ; // Byte 5 + UCHAR MostRecentTemperature; // Byte 6 + UCHAR VendorSpecific[ANYSIZE_ARRAY]; // Bytes 7-N + + } INFORMATIONAL_EXCEPTIONS; + + }; + +} LOG_PARAMETER, *PLOG_PARAMETER; + +typedef struct _LOG_PAGE { + + UCHAR PageCode : 6; // Byte 0, bit 0-5 + UCHAR SPF : 1; // Byte 0, bit 6 + UCHAR DS : 1; // Byte 0, bit 7 + UCHAR SubPageCode; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + +#if !defined(__midl) + LOG_PARAMETER Parameters[0]; +#endif + +} LOG_PAGE, *PLOG_PAGE; + +#pragma pack(pop, log_page) + + +// +// Logical Block Provisioning resource count parameter codes. +// +#define LOG_PAGE_LBP_PARAMETER_CODE_AVAILABLE 0x1 +#define LOG_PAGE_LBP_PARAMETER_CODE_USED 0x2 + +// +// Logical Block Provisioning resource count scope codes. +// +#define LOG_PAGE_LBP_RESOURCE_SCOPE_NOT_REPORTED 0x0 +#define LOG_PAGE_LBP_RESOURCE_SCOPE_DEDICATED_TO_LUN 0x1 +#define LOG_PAGE_LBP_RESOURCE_SCOPE_NOT_DEDICATED_TO_LUN 0x2 + +// +// Logical Block Provisioning threshold resource count log page parameter. +// +typedef struct _LOG_PARAMETER_THRESHOLD_RESOURCE_COUNT { + LOG_PARAMETER_HEADER Header; + UCHAR ResourceCount[4]; + UCHAR Scope :2; + UCHAR Reserved0 :6; + UCHAR Reserved1[3]; +} LOG_PARAMETER_THRESHOLD_RESOURCE_COUNT, *PLOG_PARAMETER_THRESHOLD_RESOURCE_COUNT; + +// +// Logical Block Provisioning log page. +// +typedef struct _LOG_PAGE_LOGICAL_BLOCK_PROVISIONING { + + UCHAR PageCode : 6; // 0x0C + UCHAR SPF : 1; // 0 + UCHAR DS : 1; // 1 + UCHAR SubPageCode; // 0x00 + UCHAR PageLength[2]; +#if !defined(__midl) + LOG_PARAMETER_HEADER Parameters[0]; +#endif + +} LOG_PAGE_LOGICAL_BLOCK_PROVISIONING, *PLOG_PAGE_LOGICAL_BLOCK_PROVISIONING; + + +// +// Optional VERSION DESCRIPTOR fields provide the opportunity for SCSI targets to +// claim conformance with a number of standards. The INQUIRY response can contain +// any number of version descriptors between one and eight. Below values are +// excerpted from table 136 of SPC-4 specification available at http://www.t10.org +// (backup copies maintained at http://www.incits.org and // http://www.ansi.org). +// + +#define VER_DESCRIPTOR_SPC4_NOVERSION 0x0460 +#define VER_DESCRIPTOR_SPC4_T10_1731D_R16 0x0461 +#define VER_DESCRIPTOR_SPC4_T10_1731D_R18 0x0462 +#define VER_DESCRIPTOR_SPC4_T10_1731D_R23 0x0463 +#define VER_DESCRIPTOR_SBC3 0x04C0 + +#define VER_DESCRIPTOR_1667_NOVERSION 0xFFC0 +#define VER_DESCRIPTOR_1667_2006 0xFFC1 +#define VER_DESCRIPTOR_1667_2009 0xFFC2 + +// +// Persistent Reservation Definitions. +// + +// +// PERSISTENT_RESERVE_* definitions +// + +#define RESERVATION_ACTION_READ_KEYS 0x00 +#define RESERVATION_ACTION_READ_RESERVATIONS 0x01 +#define RESERVATION_ACTION_REPORT_CAPABILITIES 0x02 +#define RESERVATION_ACTION_READ_FULL_STATUS 0x03 + +#define RESERVATION_ACTION_REGISTER 0x00 +#define RESERVATION_ACTION_RESERVE 0x01 +#define RESERVATION_ACTION_RELEASE 0x02 +#define RESERVATION_ACTION_CLEAR 0x03 +#define RESERVATION_ACTION_PREEMPT 0x04 +#define RESERVATION_ACTION_PREEMPT_ABORT 0x05 +#define RESERVATION_ACTION_REGISTER_IGNORE_EXISTING 0x06 +#define RESERVATION_ACTION_REGISTER_AND_MOVE 0x07 +#define RESERVATION_ACTION_REPLACE_LOST_RESERVATION 0x08 + +#define RESERVATION_SCOPE_LU 0x00 +#define RESERVATION_SCOPE_ELEMENT 0x02 + +#define RESERVATION_TYPE_WRITE_EXCLUSIVE 0x01 +#define RESERVATION_TYPE_EXCLUSIVE 0x03 +#define RESERVATION_TYPE_WRITE_EXCLUSIVE_REGISTRANTS 0x05 +#define RESERVATION_TYPE_EXCLUSIVE_REGISTRANTS 0x06 +#define RESERVATION_TYPE_WRITE_EXCLUSIVE_ALL_REGISTRANTS 0x07 +#define RESERVATION_TYPE_EXCLUSIVE_ALL_REGISTRANTS 0x08 + +// +// Structures for reserve in command. +// + +#pragma pack(push, reserve_in_stuff, 1) +typedef struct { + UCHAR Generation[4]; + UCHAR AdditionalLength[4]; +#if !defined(__midl) + UCHAR ReservationKeyList[0][8]; +#endif +} PRI_REGISTRATION_LIST, *PPRI_REGISTRATION_LIST; + +typedef struct { + UCHAR ReservationKey[8]; + UCHAR ScopeSpecificAddress[4]; + UCHAR Reserved; + UCHAR Type : 4; + UCHAR Scope : 4; + UCHAR Obsolete[2]; +} PRI_RESERVATION_DESCRIPTOR, *PPRI_RESERVATION_DESCRIPTOR; + +typedef struct { + UCHAR Generation[4]; + UCHAR AdditionalLength[4]; +#if !defined(__midl) + PRI_RESERVATION_DESCRIPTOR Reservations[0]; +#endif +} PRI_RESERVATION_LIST, *PPRI_RESERVATION_LIST; + +typedef struct { + UCHAR ReservationKey[8]; + UCHAR Reserved[4]; + UCHAR ReservationHolder : 1; + UCHAR AllTargetPorts : 1; + UCHAR Reserved1 : 6; + UCHAR Type : 4; + UCHAR Scope : 4; + UCHAR Reserved2[4]; + UCHAR RelativeTargetPortIdentifier[2]; + UCHAR AdditionalDescriptorLength[4]; +} PRI_FULL_STATUS_DESCRIPTOR_HEADER, *PPRI_FULL_STATUS_DESCRIPTOR_HEADER; + +typedef struct { + PRI_FULL_STATUS_DESCRIPTOR_HEADER Header; + UCHAR TransportID[ANYSIZE_ARRAY]; +} PRI_FULL_STATUS_DESCRIPTOR, *PPRI_FULL_STATUS_DESCRIPTOR; + +typedef struct { + UCHAR Generation[4]; + UCHAR AdditionalLength[4]; +} PRI_FULL_STATUS_LIST_HEADER, *PPRI_FULL_STATUS_LIST_HEADER; + +typedef struct { + UCHAR Generation[4]; + UCHAR AdditionalLength[4]; + + // + // Since TransportID could be different sizes, + // we use PRI_FULL_STATUS_DESCRIPTOR_HEADER rather than PRI_FULL_STATUS_DESCRIPTOR + // as a place holder here. + // + PRI_FULL_STATUS_DESCRIPTOR_HEADER FullStatusDescriptors[ANYSIZE_ARRAY]; +} PRI_FULL_STATUS_LIST, *PPRI_FULL_STATUS_LIST; + +typedef struct { + UCHAR Length[2]; + UCHAR PersistThroughPowerLossCapable : 1; + UCHAR Reserved : 1; + UCHAR AllTargetPortsCapable : 1; + UCHAR SpecifyInitiatorPortsCapable : 1; + UCHAR CompatibleReservationHandling : 1; + UCHAR Reserved1 : 2; + UCHAR ReplaceLostReservationCapable : 1; + UCHAR PersistThroughPowerLossActivated : 1; + UCHAR Reserved2 : 3; + UCHAR AllowCommands : 3; + UCHAR TypeMaskValid : 1; + UCHAR Reserved3 : 1; + UCHAR WriteExclusive : 1; + UCHAR Reserved4 : 1; + UCHAR ExclusiveAccess : 1; + UCHAR Reserved5 : 1; + UCHAR WriteExclusiveRegistrantsOnly : 1; + UCHAR ExclusiveAccessRegistrantsOnly : 1; + UCHAR WriteExclusiveAllRegistrants : 1; + UCHAR ExclusiveAccessAllRegistrants : 1; + UCHAR Reserved6 : 7; + UCHAR Reserved7[2]; +} PRI_REPORT_CAPABILITIES, *PPRI_REPORT_CAPABILITIES; +#pragma pack(pop, reserve_in_stuff) + +// +// Structures for reserve out command. +// + +#pragma pack(push, reserve_out_stuff, 1) +typedef struct { + UCHAR ReservationKey[8]; + UCHAR ServiceActionReservationKey[8]; + UCHAR ScopeSpecificAddress[4]; + UCHAR ActivatePersistThroughPowerLoss : 1; + UCHAR Reserved1 : 1; + UCHAR AllTargetPorts : 1; + UCHAR SpecifyInitiatorPorts : 1; + UCHAR Reserved2 : 4; + UCHAR Reserved3; + UCHAR Obsolete[2]; +} PRO_PARAMETER_LIST, *PPRO_PARAMETER_LIST; +#pragma pack(pop, reserve_out_stuff) + +// +// Structure for report timestamp command. +// + +#pragma pack(push, report_timestamp_stuff, 1) +typedef struct { + + UCHAR ParameterDataLength[2]; // Byte 0-1 + UCHAR Origin : 3; // Byte 2, bit 0-2 + UCHAR Reserved1 : 5; // Byte 2, bit 3-7 + UCHAR Reserved2; // Byte 3 + UCHAR Timestamp[6]; // Byte 4-9 + UCHAR Reserved3[2]; // Byte 10-11 + +} RT_PARAMETER_DATA, *PRT_PARAMETER_DATA; +#pragma pack(pop, report_timestamp_stuff) + +// +// Structure for set timestamp command. +// + +#pragma pack(push, set_timestamp_stuff, 1) +typedef struct { + + UCHAR Reserved1[4]; // Byte 0-3 + UCHAR Timestamp[6]; // Byte 4-9 + UCHAR Reserved2[2]; // Byte 10-11 + +} ST_PARAMETER_DATA, *PST_PARAMETER_DATA; +#pragma pack(pop, set_timestamp_stuff) + +// +// Report supported operation codes Definitions. +// + +#define REPORT_SUPPORTED_OPERATION_CODES_REPORTING_OPTIONS_ALL 0x0 +#define REPORT_SUPPORTED_OPERATION_CODES_REPORTING_OPTIONS_OP 0x1 +#define REPORT_SUPPORTED_OPERATION_CODES_REPORTING_OPTIONS_OP_SA 0x2 +#define REPORT_SUPPORTED_OPERATION_CODES_REPORTING_OPTIONS_OP_SA_OVERWRITE 0x3 + +#define REPORT_SUPPORTED_OPERATION_CODES_SUPPORT_NOT_AVAILABLE 0x0 +#define REPORT_SUPPORTED_OPERATION_CODES_SUPPORT_NONE 0x1 +#define REPORT_SUPPORTED_OPERATION_CODES_SUPPORT_SUPPORT_STANDARD 0x3 +#define REPORT_SUPPORTED_OPERATION_CODES_SUPPORT_SUPPORT_VENDOR 0x5 + +// +// Structure for report supported operation codes. +// + +#pragma pack(push, report_supported_operation_codes, 1) +typedef struct { + + UCHAR DescriptorLength[2]; // 0x0A + UCHAR Reserved; + UCHAR CommandSpecific; + UCHAR NominalCommandProcessingTimeoutInSec[4]; + UCHAR RecommendedCommandTimeoutInSec[4]; + +} RS_COMMAND_TIMEOUTS_DESCRIPTOR, *PRS_COMMAND_TIMEOUTS_DESCRIPTOR; + +typedef struct { + + UCHAR ReadWriteCommandDurationLimitsPage : 1; + UCHAR Reserved : 7; + UCHAR Support : 3; + UCHAR CommandDurationLimitPage : 2; + UCHAR MultipleLogicalUnits : 2; + UCHAR CommandTimeoutsDescriptorPresent : 1; + UCHAR CdbSize[2]; + UCHAR CdbUsageData[ANYSIZE_ARRAY]; +//#if !defined(__midl) +// RS_COMMAND_TIMEOUTS_DESCRIPTOR CommandTimeoutsDescriptor[0]; +//#endif + +} RS_ONE_COMMAND_PARAMETER_DATA, *PRS_ONE_COMMAND_PARAMETER_DATA; + +typedef struct { + + UCHAR OperationCode; + UCHAR Reserved; + UCHAR ServiceAction[2]; + UCHAR Reserved1; + UCHAR ServiceActionValid : 1; + UCHAR CommandTimeoutsDescriptorPresent : 1; + UCHAR CommandDurationLimitPage : 2; + UCHAR MultipleLogicalUnits : 2; + UCHAR ReadWriteCommandDurationLimitsPage : 1; + UCHAR Reserved2 : 1; + UCHAR CdbLength[2]; +//#if !defined(__midl) +// RS_COMMAND_TIMEOUTS_DESCRIPTOR CommandTimeoutsDescriptor[0]; +//#endif +} RS_COMMAND_DESCRIPTOR, *PRS_COMMAND_DESCRIPTOR; + +typedef struct { + + UCHAR CommandDataLength[4]; + RS_COMMAND_DESCRIPTOR CommandDescriptor[ANYSIZE_ARRAY]; + +} RS_ALL_COMMANDS_PARAMETER_DATA, *PRS_ALL_COMMANDS_PARAMETER_DATA; +#pragma pack(pop, report_supported_operation_codes) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define BLOCK_DEVICE_TOKEN_SIZE 512 + +// +// Stuctures for Token Operation and Receive Token Information commands +// + +#pragma pack(push, windows_token_operation, 1) +typedef struct { + UCHAR LogicalBlockAddress[8]; + UCHAR TransferLength[4]; + UCHAR Reserved[4]; +} BLOCK_DEVICE_RANGE_DESCRIPTOR, *PBLOCK_DEVICE_RANGE_DESCRIPTOR; + +typedef struct { + UCHAR PopulateTokenDataLength[2]; + UCHAR Immediate : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2; + UCHAR InactivityTimeout[4]; + UCHAR Reserved3[6]; + UCHAR BlockDeviceRangeDescriptorListLength[2]; +#if !defined(__midl) + UCHAR BlockDeviceRangeDescriptor[ANYSIZE_ARRAY]; +#endif +} POPULATE_TOKEN_HEADER, *PPOPULATE_TOKEN_HEADER; + +typedef struct { + UCHAR WriteUsingTokenDataLength[2]; + UCHAR Immediate : 1; + UCHAR Reserved1 : 7; + UCHAR Reserved2[5]; + UCHAR BlockOffsetIntoToken[8]; + UCHAR Token[BLOCK_DEVICE_TOKEN_SIZE]; + UCHAR Reserved3[6]; + UCHAR BlockDeviceRangeDescriptorListLength[2]; +#if !defined(__midl) + UCHAR BlockDeviceRangeDescriptor[ANYSIZE_ARRAY]; +#endif +} WRITE_USING_TOKEN_HEADER, *PWRITE_USING_TOKEN_HEADER; + +typedef struct { + UCHAR AvailableData[4]; + UCHAR ResponseToServiceAction : 5; + UCHAR Reserved1 : 3; + UCHAR OperationStatus : 7; + UCHAR Reserved2 : 1; + UCHAR OperationCounter[2]; + UCHAR EstimatedStatusUpdateDelay[4]; + UCHAR CompletionStatus; + UCHAR SenseDataFieldLength; + UCHAR SenseDataLength; + UCHAR TransferCountUnits; + UCHAR TransferCount[8]; + UCHAR SegmentsProcessed[2]; + UCHAR Reserved3[6]; +#if !defined(__midl) + UCHAR SenseData[ANYSIZE_ARRAY]; +#endif +} RECEIVE_TOKEN_INFORMATION_HEADER, *PRECEIVE_TOKEN_INFORMATION_HEADER; + +typedef struct { + UCHAR TokenDescriptorsLength[4]; +#if !defined(__midl) + UCHAR TokenDescriptor[ANYSIZE_ARRAY]; +#endif +} RECEIVE_TOKEN_INFORMATION_RESPONSE_HEADER, *PRECEIVE_TOKEN_INFORMATION_RESPONSE_HEADER; + +typedef struct { + UCHAR TokenIdentifier[2]; + UCHAR Token[BLOCK_DEVICE_TOKEN_SIZE]; +} BLOCK_DEVICE_TOKEN_DESCRIPTOR, *PBLOCK_DEVICE_TOKEN_DESCRIPTOR; + +typedef enum _OPERATION_STATUS { + OPERATION_COMPLETED_WITH_SUCCESS = 0x01, + OPERATION_COMPLETED_WITH_ERROR = 0x02, + OPERATION_COMPLETED_WITH_RESIDUAL_DATA = 0x03, + OPERATION_IN_PROGRESS_IN_FOREGROUND = 0x11, + OPERATION_IN_PROGRESS_IN_BACKGROUND = 0x12, + OPERATION_TERMINATED = 0x60 +} OPERATION_STATUS, *POPERATION_STATUS; + +typedef enum _TRANSFER_COUNT_UNITS { // Multiplier to convert a Transfer Count field to bytes + TRANSFER_COUNT_UNITS_BYTES = 0, // 1 + TRANSFER_COUNT_UNITS_KIBIBYTES = 1, // 2^10 or 1024 + TRANSFER_COUNT_UNITS_MEBIBYTES = 2, // 2^20 + TRANSFER_COUNT_UNITS_GIBIBYTES = 3, // 2^30 + TRANSFER_COUNT_UNITS_TEBIBYTES = 4, // 2^40 + TRANSFER_COUNT_UNITS_PEBIBYTES = 5, // 2^50 + TRANSFER_COUNT_UNITS_EXBIBYTES = 6, // 2^60 + TRANSFER_COUNT_UNITS_NUMBER_BLOCKS = 0xF1 // Logical Block Length In Bytes (from ReadCapacity) +} TRANSFER_COUNT_UNITS, *PTRANSFER_COUNT_UNITS; +#pragma pack(pop, windows_token_operation) + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) + +// +// SANITIZE related definition +// +#pragma pack(push, sanitize, 1) +typedef struct _OVERWRITE_PARAMETER_LIST { + UCHAR OverWriteCount : 5; + UCHAR Test : 2; + UCHAR Invert : 1; + UCHAR Reserved1; + UCHAR InitializationPatternLength[2]; +#if !defined(__midl) + UCHAR InitializationPattern[ANYSIZE_ARRAY]; +#endif +} OVERWRITE_PARAMETER_LIST, *POVERWRITE_PARAMETER_LIST; +#pragma pack(pop, sanitize) + +// +// SCSIOP_WRITE_DATA_BUFF related definition +// +#define SCSI_WRITE_BUFFER_MODE_DOWNLOAD_MICROCODE_WITH_OFFSETS_SAVE_DEFER_ACTIVATE 0x0E +#define SCSI_WRITE_BUFFER_MODE_ACTIVATE_DEFERRED_MICROCODE 0x0F + +#define SCSI_WRITE_BUFFER_MODE_0D_MODE_SPECIFIC_VSE_ACT 0x01 +#define SCSI_WRITE_BUFFER_MODE_0D_MODE_SPECIFIC_HR_ACT 0x02 +#define SCSI_WRITE_BUFFER_MODE_0D_MODE_SPECIFIC_PO_ACT 0x04 + +// +// Sense Data Format +// + +#pragma pack(push, sensedata, 1) +typedef struct _SENSE_DATA { + UCHAR ErrorCode:7; + UCHAR Valid:1; + UCHAR SegmentNumber; + UCHAR SenseKey:4; + UCHAR Reserved:1; + UCHAR IncorrectLength:1; + UCHAR EndOfMedia:1; + UCHAR FileMark:1; + UCHAR Information[4]; + UCHAR AdditionalSenseLength; + UCHAR CommandSpecificInformation[4]; + UCHAR AdditionalSenseCode; + UCHAR AdditionalSenseCodeQualifier; + UCHAR FieldReplaceableUnitCode; + UCHAR SenseKeySpecific[3]; +} SENSE_DATA, *PSENSE_DATA; +#pragma pack(pop, sensedata) + +#pragma pack(push, sensedata_ex, 1) + +// +// NOTE: Sense Data Descriptor Format is supported only in Windows 8 and later +// + +typedef struct _SCSI_SENSE_DESCRIPTOR_HEADER { + UCHAR DescriptorType; + UCHAR AdditionalLength; +} SCSI_SENSE_DESCRIPTOR_HEADER, *PSCSI_SENSE_DESCRIPTOR_HEADER; + +// +// Information Sense Data Descriptor Format +// +typedef struct _SCSI_SENSE_DESCRIPTOR_INFORMATION { + SCSI_SENSE_DESCRIPTOR_HEADER Header; + UCHAR Valid:1; + UCHAR Reserved1:7; + UCHAR Reserved2; + UCHAR Information[8]; +} SCSI_SENSE_DESCRIPTOR_INFORMATION, *PSCSI_SENSE_DESCRIPTOR_INFORMATION; + +// +// Block Command Sense Data Descriptor Format +// +typedef struct _SCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND { + SCSI_SENSE_DESCRIPTOR_HEADER Header; + UCHAR Reserved1; + UCHAR Reserved2:5; + UCHAR IncorrectLength:1; + UCHAR Reserved3:2; +} SCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND, *PSCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND; + +// +// ATA Status Return Descriptor Format +// +typedef struct _SCSI_SENSE_DESCRIPTOR_ATA_STATUS_RETURN { + SCSI_SENSE_DESCRIPTOR_HEADER Header; + UCHAR Extend:1; + UCHAR Reserved1:7; + UCHAR Error; + UCHAR SectorCount15_8; + UCHAR SectorCount7_0; + UCHAR LbaLow15_8; + UCHAR LbaLow7_0; + UCHAR LbaMid15_8; + UCHAR LbaMid7_0; + UCHAR LbaHigh15_8; + UCHAR LbaHigh7_0; + UCHAR Device; + UCHAR Status; +} SCSI_SENSE_DESCRIPTOR_ATA_STATUS_RETURN, *PSCSI_SENSE_DESCRIPTOR_ATA_STATUS_RETURN; + +// +// Fixed Sense Data Format +// +typedef struct _SENSE_DATA FIXED_SENSE_DATA, *PFIXED_SENSE_DATA; + +// +// Descriptor Sense Data Format +// +typedef struct _DESCRIPTOR_SENSE_DATA { + UCHAR ErrorCode:7; + UCHAR Reserved1:1; + UCHAR SenseKey:4; + UCHAR Reserved2:4; + UCHAR AdditionalSenseCode; + UCHAR AdditionalSenseCodeQualifier; + UCHAR Reserved3[3]; + UCHAR AdditionalSenseLength; + UCHAR DescriptorBuffer[ANYSIZE_ARRAY]; +} DESCRIPTOR_SENSE_DATA, *PDESCRIPTOR_SENSE_DATA; + +typedef union _SENSE_DATA_EX { + + // + // Sense data in fixed format + // + FIXED_SENSE_DATA FixedData; + + // + // Sense data in descriptor format + // + DESCRIPTOR_SENSE_DATA DescriptorData; + +} SENSE_DATA_EX, *PSENSE_DATA_EX; + +#pragma pack(pop, sensedata_ex) + +// +// Default request sense buffer size +// + +#define SENSE_BUFFER_SIZE sizeof(SENSE_DATA) + +#define SENSE_BUFFER_SIZE_EX sizeof(SENSE_DATA_EX) + +// +// Maximum request sense buffer size +// + +#define MAX_SENSE_BUFFER_SIZE 255 + +// +// Maximum number of additional sense bytes. +// + +#define MAX_ADDITIONAL_SENSE_BYTES (MAX_SENSE_BUFFER_SIZE - SENSE_BUFFER_SIZE) + +#define MAX_ADDITIONAL_SENSE_BYTES_EX (MAX_SENSE_BUFFER_SIZE - SENSE_BUFFER_SIZE_EX) + +// +// Sense Data Error Codes +// + +#define SCSI_SENSE_ERRORCODE_FIXED_CURRENT 0x70 +#define SCSI_SENSE_ERRORCODE_FIXED_DEFERRED 0x71 +#define SCSI_SENSE_ERRORCODE_DESCRIPTOR_CURRENT 0x72 +#define SCSI_SENSE_ERRORCODE_DESCRIPTOR_DEFERRED 0x73 + +// +// Sense Data Descriptor Types +// + +#define SCSI_SENSE_DESCRIPTOR_TYPE_INFORMATION 0x00 +#define SCSI_SENSE_DESCRIPTOR_TYPE_COMMAND_SPECIFIC 0x01 +#define SCSI_SENSE_DESCRIPTOR_TYPE_SENSE_KEY_SPECIFIC 0x02 +#define SCSI_SENSE_DESCRIPTOR_TYPE_FIELD_REPLACEABLE_UNIT 0x03 +#define SCSI_SENSE_DESCRIPTOR_TYPE_STREAM_COMMAND 0x04 +#define SCSI_SENSE_DESCRIPTOR_TYPE_BLOCK_COMMAND 0x05 +#define SCSI_SENSE_DESCRIPTOR_TYPE_OSD_OBJECT_IDENTIFICATION 0x06 +#define SCSI_SENSE_DESCRIPTOR_TYPE_OSD_RESPONSE_INTEGRITY_CHECK 0x07 +#define SCSI_SENSE_DESCRIPTOR_TYPE_OSD_ATTRIBUTE_IDENTIFICATION 0x08 +#define SCSI_SENSE_DESCRIPTOR_TYPE_ATA_STATUS_RETURN 0x09 +#define SCSI_SENSE_DESCRIPTOR_TYPE_PROGRESS_INDICATION 0x0A +#define SCSI_SENSE_DESCRIPTOR_TYPE_USER_DATA_SEGMENT_REFERRAL 0x0B +#define SCSI_SENSE_DESCRIPTOR_TYPE_FORWARDED_SENSE_DATA 0x0C + +// +// Sense Keys +// + +#define SCSI_SENSE_NO_SENSE 0x00 +#define SCSI_SENSE_RECOVERED_ERROR 0x01 +#define SCSI_SENSE_NOT_READY 0x02 +#define SCSI_SENSE_MEDIUM_ERROR 0x03 +#define SCSI_SENSE_HARDWARE_ERROR 0x04 +#define SCSI_SENSE_ILLEGAL_REQUEST 0x05 +#define SCSI_SENSE_UNIT_ATTENTION 0x06 +#define SCSI_SENSE_DATA_PROTECT 0x07 +#define SCSI_SENSE_BLANK_CHECK 0x08 +#define SCSI_SENSE_UNIQUE 0x09 +#define SCSI_SENSE_COPY_ABORTED 0x0A +#define SCSI_SENSE_ABORTED_COMMAND 0x0B +#define SCSI_SENSE_EQUAL 0x0C +#define SCSI_SENSE_VOL_OVERFLOW 0x0D +#define SCSI_SENSE_MISCOMPARE 0x0E +#define SCSI_SENSE_RESERVED 0x0F + +// +// Additional tape bit +// + +#define SCSI_ILLEGAL_LENGTH 0x20 +#define SCSI_EOM 0x40 +#define SCSI_FILE_MARK 0x80 + +// +// Additional Sense codes +// + +#define SCSI_ADSENSE_NO_SENSE 0x00 +#define SCSI_ADSENSE_NO_SEEK_COMPLETE 0x02 +#define SCSI_ADSENSE_WRITE 0x03 +#define SCSI_ADSENSE_LUN_NOT_READY 0x04 +#define SCSI_ADSENSE_LUN_COMMUNICATION 0x08 +#define SCSI_ADSENSE_SERVO_ERROR 0x09 +#define SCSI_ADSENSE_WARNING 0x0B +#define SCSI_ADSENSE_WRITE_ERROR 0x0C +#define SCSI_ADSENSE_COPY_TARGET_DEVICE_ERROR 0x0D +#define SCSI_ADSENSE_CRC_OR_ECC_ERROR 0x10 +#define SCSI_ADSENSE_UNRECOVERED_ERROR 0x11 +#define SCSI_ADSENSE_TRACK_ERROR 0x14 +#define SCSI_ADSENSE_SEEK_ERROR 0x15 +#define SCSI_ADSENSE_REC_DATA_NOECC 0x17 +#define SCSI_ADSENSE_REC_DATA_ECC 0x18 +#define SCSI_ADSENSE_DEFECT_LIST_ERROR 0x19 +#define SCSI_ADSENSE_PARAMETER_LIST_LENGTH 0x1A +#define SCSI_ADSENSE_MISCOMPARE_DURING_VERIFY_OPERATION 0x1D +#define SCSI_ADSENSE_ILLEGAL_COMMAND 0x20 +#define SCSI_ADSENSE_ACCESS_DENIED 0x20 +#define SCSI_ADSENSE_ILLEGAL_BLOCK 0x21 +#define SCSI_ADSENSE_INVALID_TOKEN 0x23 +#define SCSI_ADSENSE_INVALID_CDB 0x24 +#define SCSI_ADSENSE_INVALID_LUN 0x25 +#define SCSI_ADSENSE_INVALID_FIELD_PARAMETER_LIST 0x26 +#define SCSI_ADSENSE_WRITE_PROTECT 0x27 +#define SCSI_ADSENSE_MEDIUM_CHANGED 0x28 +#define SCSI_ADSENSE_BUS_RESET 0x29 +#define SCSI_ADSENSE_PARAMETERS_CHANGED 0x2A +#define SCSI_ADSENSE_COMMAND_SEQUENCE_ERROR 0x2C +#define SCSI_ADSENSE_INSUFFICIENT_TIME_FOR_OPERATION 0x2E +#define SCSI_ADSENSE_INVALID_MEDIA 0x30 +#define SCSI_ADSENSE_MEDIUM_FORMAT_CORRUPTED 0x31 +#define SCSI_ADSENSE_DEFECT_LIST 0x32 +#define SCSI_ADSENSE_LB_PROVISIONING 0x38 +#define SCSI_ADSENSE_NO_MEDIA_IN_DEVICE 0x3a +#define SCSI_ADSENSE_POSITION_ERROR 0x3b +#define SCSI_ADSENSE_LOGICAL_UNIT_ERROR 0x3e +#define SCSI_ADSENSE_OPERATING_CONDITIONS_CHANGED 0x3f +#define SCSI_ADSENSE_DATA_PATH_FAILURE 0x41 +#define SCSI_ADSENSE_POWER_ON_SELF_TEST_FAILURE 0x42 +#define SCSI_ADSENSE_INTERNAL_TARGET_FAILURE 0x44 +#define SCSI_ADSENSE_DATA_TRANSFER_ERROR 0x4b +#define SCSI_ADSENSE_LUN_FAILED_SELF_CONFIGURATION 0x4c +#define SCSI_ADSENSE_RESOURCE_FAILURE 0x55 +#define SCSI_ADSENSE_OPERATOR_REQUEST 0x5a // see below +#define SCSI_ADSENSE_FAILURE_PREDICTION_THRESHOLD_EXCEEDED 0x5d +#define SCSI_ADSENSE_ILLEGAL_MODE_FOR_THIS_TRACK 0x64 +#define SCSI_ADSENSE_COPY_PROTECTION_FAILURE 0x6f +#define SCSI_ADSENSE_POWER_CALIBRATION_ERROR 0x73 +#define SCSI_ADSENSE_VENDOR_UNIQUE 0x80 // and higher +#define SCSI_ADSENSE_MUSIC_AREA 0xA0 +#define SCSI_ADSENSE_DATA_AREA 0xA1 +#define SCSI_ADSENSE_VOLUME_OVERFLOW 0xA7 + +// for legacy apps: +#define SCSI_ADWRITE_PROTECT SCSI_ADSENSE_WRITE_PROTECT +#define SCSI_FAILURE_PREDICTION_THRESHOLD_EXCEEDED SCSI_ADSENSE_FAILURE_PREDICTION_THRESHOLD_EXCEEDED + + +// +// SCSI_ADSENSE_NO_SENSE (0x00) qualifiers +// + +#define SCSI_SENSEQ_OPERATION_IS_IN_PROGRESS 0x16 + +// +// SCSI_ADSENSE_WRITE (0x03) qualifiers +// +#define SCSI_SENSEQ_PERIPHERAL_DEVICE_WRITE_FAULT 0x00 +#define SCSI_SENSEQ_NO_WRITE_CURRENT 0x01 +#define SCSI_SENSEQ_EXCESSIVE_WRITE_ERRORS 0x02 + +// +// SCSI_ADSENSE_LUN_NOT_READY (0x04) qualifiers +// + +#define SCSI_SENSEQ_CAUSE_NOT_REPORTABLE 0x00 +#define SCSI_SENSEQ_BECOMING_READY 0x01 +#define SCSI_SENSEQ_INIT_COMMAND_REQUIRED 0x02 +#define SCSI_SENSEQ_MANUAL_INTERVENTION_REQUIRED 0x03 +#define SCSI_SENSEQ_FORMAT_IN_PROGRESS 0x04 +#define SCSI_SENSEQ_REBUILD_IN_PROGRESS 0x05 +#define SCSI_SENSEQ_RECALCULATION_IN_PROGRESS 0x06 +#define SCSI_SENSEQ_OPERATION_IN_PROGRESS 0x07 +#define SCSI_SENSEQ_LONG_WRITE_IN_PROGRESS 0x08 +#define SCSI_SENSEQ_SPACE_ALLOC_IN_PROGRESS 0x14 + +// +// SCSI_ADSENSE_LUN_COMMUNICATION (0x08) qualifiers +// + +#define SCSI_SENSEQ_COMM_FAILURE 0x00 +#define SCSI_SENSEQ_COMM_TIMEOUT 0x01 +#define SCSI_SENSEQ_COMM_PARITY_ERROR 0x02 +#define SCSI_SESNEQ_COMM_CRC_ERROR 0x03 +#define SCSI_SENSEQ_UNREACHABLE_TARGET 0x04 + +// +// SCSI_ADSENSE_SERVO_ERROR (0x09) qualifiers +// +#define SCSI_SENSEQ_TRACK_FOLLOWING_ERROR 0x00 +#define SCSI_SENSEQ_TRACKING_SERVO_FAILURE 0x01 +#define SCSI_SENSEQ_FOCUS_SERVO_FAILURE 0x02 +#define SCSI_SENSEQ_SPINDLE_SERVO_FAILURE 0x03 +#define SCSI_SENSEQ_HEAD_SELECT_FAULT 0x04 + +// +// SCSI_ADSENSE_WARNING (0x0B) qualifiers +// +#define SCSI_SENSEQ_POWER_LOSS_EXPECTED 0x08 + +// +// SCSI_ADSENSE_WRITE_ERROR (0x0C) qualifiers +// +#define SCSI_SENSEQ_LOSS_OF_STREAMING 0x09 +#define SCSI_SENSEQ_PADDING_BLOCKS_ADDED 0x0A + +// +// SCSI_ADSENSE_COPY_TARGET_DEVICE_ERROR (0x0D) qualifiers +// + +#define SCSI_SENSEQ_NOT_REACHABLE 0x02 +#define SCSI_SENSEQ_DATA_UNDERRUN 0x04 + +// +// SCSI_ADSENSE_CRC_OR_ECC_ERROR (0x10) qualifiers +// + +#define SCSI_SENSEQ_LOGICAL_BLOCK_GUARD_CHECK_FAILED 0x01 +#define SCSI_SENSEQ_LOGICAL_BLOCK_TAG_CHECK_FAILED 0x02 +#define SCSI_SENSEQ_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED 0x03 + +// +// SCSI_ADSENSE_UNRECOVERED_ERROR (0x11) qualifiers +// + +#define SCSI_SENSEQ_UNRECOVERED_READ_ERROR 0x00 +#define SCSI_SENSEQ_ERROR_TOO_LONG_TO_CORRECT 0x02 + +// +// SCSI_ADSENSE_SEEK_ERROR (0x15) qualifiers +// +#define SCSI_SENSEQ_RANDOM_POSITIONING_ERROR 0x00 +#define SCSI_SENSEQ_MECHANICAL_POSITIONING_ERROR 0x01 +#define SCSI_SENSEQ_POSITIONING_ERROR_DETECTED_BY_READ_OF_MEDIUM 0x02 + +// +// SCSI_ADSENSE_DEFECT_LIST_ERROR (0x19) qualifiers +// +#define SCSI_SENSEQ_DEFECT_LIST_ERROR 0x00 +#define SCSI_SENSEQ_DEFECT_LIST_NOT_AVAILABLE 0x01 +#define SCSI_SENSEQ_DEFECT_LIST_ERROR_IN_PRIMARY_LIST 0x02 +#define SCSI_SENSEQ_DEFECT_LIST_ERROR_IN_GROWN_LIST 0x03 + +// +// SCSI_ADSENSE_NO_SENSE (0x00) qualifiers +// + +#define SCSI_SENSEQ_FILEMARK_DETECTED 0x01 +#define SCSI_SENSEQ_END_OF_MEDIA_DETECTED 0x02 +#define SCSI_SENSEQ_SETMARK_DETECTED 0x03 +#define SCSI_SENSEQ_BEGINNING_OF_MEDIA_DETECTED 0x04 + +// +// SCSI_ADSENSE_ACCESS_DENIED (0x20) qualifiers +// + +#define SCSI_SENSEQ_NO_ACCESS_RIGHTS 0x02 +#define SCSI_SENSEQ_INVALID_LU_ID 0x09 + +// +// SCSI_ADSENSE_ILLEGAL_BLOCK (0x21) qualifiers +// + +#define SCSI_SENSEQ_LOGICAL_ADDRESS_OUT_OF_RANGE 0x00 +#define SCSI_SENSEQ_ILLEGAL_ELEMENT_ADDR 0x01 +#define SCSI_SENSEQ_INVALID_WRITE_ADDRESS 0x02 +#define SCSI_SENSEQ_INVALID_WRITE_CROSSING_LAYER_JUMP 0x03 +#define SCSI_SENSEQ_UNALIGNED_WRITE 0x04 +#define SCSI_SENSEQ_WRITE_BOUNDARY_VIOLATION 0x05 +#define SCSI_SENSEQ_READ_INVALID_DATA 0x06 +#define SCSI_SENSEQ_READ_BOUNDARY_VIOLATION 0x07 +#define SCSI_SENSEQ_MISALIGNED_WRITE 0x08 + +// +// SCSI_ADSENSE_INVALID_FIELD_PARAMETER_LIST (0x26) qualifiers +// + +#define SCSI_SENSEQ_INVALID_RELEASE_OF_PERSISTENT_RESERVATION 0x04 +#define SCSI_SENSEQ_TOO_MANY_SEGMENT_DESCRIPTORS 0x08 + +// +// SCSI_ADSENSE_WRITE_PROTECT (0x27) qualifiers +// + +#define SCSI_SENSEQ_SPACE_ALLOC_FAILED_WRITE_PROTECT 0x07 + +// +// SCSI_ADSENSE_PARAMETERS_CHANGED (0x2A) qualifiers +// + +#define SCSI_SENSEQ_CAPACITY_DATA_CHANGED 0x09 + +// +// SCSI_ADSENSE_COMMAND_SEQUENCE_ERROR (0x2C) qualifiers +// + +#define SCSI_SENSEQ_PREVIOUS_RESERVATION_CONFLICT 0x09 + +// +// SCSI_ADSENSE_POSITION_ERROR (0x3b) qualifiers +// + +#define SCSI_SENSEQ_DESTINATION_FULL 0x0d +#define SCSI_SENSEQ_SOURCE_EMPTY 0x0e + +// +// SCSI_ADSENSE_INVALID_MEDIA (0x30) qualifiers +// + +#define SCSI_SENSEQ_INCOMPATIBLE_MEDIA_INSTALLED 0x00 +#define SCSI_SENSEQ_UNKNOWN_FORMAT 0x01 +#define SCSI_SENSEQ_INCOMPATIBLE_FORMAT 0x02 +#define SCSI_SENSEQ_CLEANING_CARTRIDGE_INSTALLED 0x03 + +// +// SCSI_ADSENSE_MEDIUM_FORMAT_CORRUPTED (0x31) qualifiers +// + +#define SCSI_SENSEQ_FORMAT_COMMAND_FAILED 0x01 + +// +// SCSI_ADSENSE_DEFECT_LIST (0x32) qualifiers +// +#define SCSI_SENSEQ_NO_DEFECT_SPARE_LOCATION_AVAILABLE 0x00 +#define SCSI_SENSEQ_DEFECT_LIST_UPDATE_FAILURE 0x01 + +// +// SCSI_ADSENSE_LB_PROVISIONING (0x38) qualifiers +// +#define SCSI_SENSEQ_SOFT_THRESHOLD_REACHED 0x07 + +// +// SCSI_ADSENSE_LOGICAL_UNIT_ERROR (0x3e) qualifiers +// + +#define SCSI_SENSEQ_LOGICAL_UNIT_HAS_NOT_SELF_CONFIGURED_YET 0x00 +#define SCSI_SENSEQ_LOGICAL_UNIT_FAILURE 0x01 +#define SCSI_SENSEQ_TIMEOUT_ON_LOGICAL_UNIT 0x02 +#define SCSI_SENSEQ_LOGICAL_UNIT_FAILED_SELF_TEST 0x03 +#define SCSI_SENSEQ_LOGICAL_UNIT_FAILED_TO_UPDATE_SELF_TEST_LOG 0x04 + +// +// SCSI_ADSENSE_OPERATING_CONDITIONS_CHANGED (0x3f) qualifiers +// + +#define SCSI_SENSEQ_TARGET_OPERATING_CONDITIONS_CHANGED 0x00 +#define SCSI_SENSEQ_MICROCODE_CHANGED 0x01 +#define SCSI_SENSEQ_OPERATING_DEFINITION_CHANGED 0x02 +#define SCSI_SENSEQ_INQUIRY_DATA_CHANGED 0x03 +#define SCSI_SENSEQ_COMPONENT_DEVICE_ATTACHED 0x04 +#define SCSI_SENSEQ_DEVICE_IDENTIFIER_CHANGED 0x05 +#define SCSI_SENSEQ_REDUNDANCY_GROUP_MODIFIED 0x06 +#define SCSI_SENSEQ_REDUNDANCY_GROUP_DELETED 0x07 +#define SCSI_SENSEQ_SPARE_MODIFIED 0x08 +#define SCSI_SENSEQ_SPARE_DELETED 0x09 +#define SCSI_SENSEQ_VOLUME_SET_MODIFIED 0x0A +#define SCSI_SENSEQ_VOLUME_SET_DELETED 0x0B +#define SCSI_SENSEQ_VOLUME_SET_DEASSIGNED 0x0C +#define SCSI_SENSEQ_VOLUME_SET_REASSIGNED 0x0D +#define SCSI_SENSEQ_REPORTED_LUNS_DATA_CHANGED 0x0E +#define SCSI_SENSEQ_ECHO_BUFFER_OVERWRITTEN 0x0F +#define SCSI_SENSEQ_MEDIUM_LOADABLE 0x10 +#define SCSI_SENSEQ_MEDIUM_AUXILIARY_MEMORY_ACCESSIBLE 0x11 + +// +// SCSI_ADSENSE_INTERNAL_TARGET_FAILURE (0x44) qualifiers +// +#define SCSI_SENSEQ_INTERNAL_TARGET_FAILURE 0x00 +#define SCSI_SENSEQ_PRESISTENT_RESERVATION_INFORMATION_LOST 0x01 +#define SCSI_SENSEQ_ATA_DEVICE_FAILED_SET_FEATURES 0x71 + +// +// SCSI_ADSENSE_DATA_TRANSFER_ERROR (0x4b) qualifiers +// + +#define SCSI_SENSEQ_INITIATOR_RESPONSE_TIMEOUT 0x06 + +// +// SCSI_ADSENSE_RESOURCE_FAILURE (0x55) qualifiers +// +#define SCSI_SENSEQ_SYSTEM_RESOURCE_FAILURE 0x00 +#define SCSI_SENSEQ_SYSTEM_BUFFER_FULL 0x01 +#define SCSI_SENSEQ_INSUFFICIENT_RESERVATION_RESOURCES 0x02 +#define SCSI_SENSEQ_INSUFFICIENT_RESOURCES 0x03 + +// +// SCSI_ADSENSE_OPERATOR_REQUEST (0x5a) qualifiers +// + +#define SCSI_SENSEQ_STATE_CHANGE_INPUT 0x00 // generic request +#define SCSI_SENSEQ_MEDIUM_REMOVAL 0x01 +#define SCSI_SENSEQ_WRITE_PROTECT_ENABLE 0x02 +#define SCSI_SENSEQ_WRITE_PROTECT_DISABLE 0x03 + +// +// SCSI_ADSENSE_FAILURE_PREDICTION_THRESHOLD_EXCEEDED (0x5d) qualifiers +// +#define SCSI_SENSEQ_FAILURE_PREDICTION_THRESHOLD_EXCEEDED 0x00 +#define SCSI_SENSEQ_MEDIA_FAILURE_PREDICTION_THRESHOLD_EXCEEDED 0x01 +#define SCSI_SENSEQ_LUN_FAILURE_PREDICTION_THRESHOLD_EXCEEDED 0x02 +#define SCSI_SENSEQ_SPARE_AREA_EXHAUSTION_PREDICTION_THRESHOLD_EXCEEDED 0x03 +#define SCSI_SENSEQ_GENERAL_HARD_DRIVE_FAILURE 0x10 +#define SCSI_SENSEQ_DRIVE_ERROR_RATE_TOO_HIGH 0x11 +#define SCSI_SENSEQ_DATA_ERROR_RATE_TOO_HIGH 0x12 +#define SCSI_SENSEQ_SEEK_ERROR_RATE_TOO_HIGH 0x13 +#define SCSI_SENSEQ_TOO_MANY_BLOCK_REASSIGNS 0x14 +#define SCSI_SENSEQ_ACCESS_TIMES_TOO_HIGH 0x15 +#define SCSI_SENSEQ_START_UNIT_TIMES_TOO_HIGH 0x16 +#define SCSI_SENSEQ_CHANNEL_PARAMETRICS 0x17 +#define SCSI_SENSEQ_CONTROLLER_DETECTED 0x18 +#define SCSI_SENSEQ_THROUGHPUT_PERFORMANCE 0x19 +#define SCSI_SENSEQ_SEEK_TIME_PERFORMANCE 0x1A +#define SCSI_SENSEQ_SPIN_UP_RETRY_COUNT 0x1B +#define SCSI_SENSEQ_DRIVE_CALIBRATION_RETRY_COUNT 0x1C +#define SCSI_SENSEQ_DATA_CHANNEL_DATA_ERROR_RATE_TOO_HIGH 0x32 +#define SCSI_SENSEQ_SERVO_DATA_ERROR_RATE_TOO_HIGH 0x42 +#define SCSI_SENSEQ_SERVER_SEEK_ERROR_RATE_TOO_HIGH 0x43 +#define SCSI_SENSEQ_FAILURE_PREDICTION_THRESHOLD_EXCEEDED_FALSE 0xFF + +// +// SCSI_ADSENSE_COPY_PROTECTION_FAILURE (0x6f) qualifiers +// +#define SCSI_SENSEQ_AUTHENTICATION_FAILURE 0x00 +#define SCSI_SENSEQ_KEY_NOT_PRESENT 0x01 +#define SCSI_SENSEQ_KEY_NOT_ESTABLISHED 0x02 +#define SCSI_SENSEQ_READ_OF_SCRAMBLED_SECTOR_WITHOUT_AUTHENTICATION 0x03 +#define SCSI_SENSEQ_MEDIA_CODE_MISMATCHED_TO_LOGICAL_UNIT 0x04 +#define SCSI_SENSEQ_LOGICAL_UNIT_RESET_COUNT_ERROR 0x05 + +// +// SCSI_ADSENSE_POWER_CALIBRATION_ERROR (0x73) qualifiers +// + +#define SCSI_SENSEQ_POWER_CALIBRATION_AREA_ALMOST_FULL 0x01 +#define SCSI_SENSEQ_POWER_CALIBRATION_AREA_FULL 0x02 +#define SCSI_SENSEQ_POWER_CALIBRATION_AREA_ERROR 0x03 +#define SCSI_SENSEQ_PMA_RMA_UPDATE_FAILURE 0x04 +#define SCSI_SENSEQ_PMA_RMA_IS_FULL 0x05 +#define SCSI_SENSEQ_PMA_RMA_ALMOST_FULL 0x06 + + + +// end_ntminitape + +// +// SCSI IO Device Control Codes +// + +#define FILE_DEVICE_SCSI 0x0000001b + +#define IOCTL_SCSI_EXECUTE_IN ((FILE_DEVICE_SCSI << 16) + 0x0011) +#define IOCTL_SCSI_EXECUTE_OUT ((FILE_DEVICE_SCSI << 16) + 0x0012) +#define IOCTL_SCSI_EXECUTE_NONE ((FILE_DEVICE_SCSI << 16) + 0x0013) + +// +// SMART support in atapi +// + +#define IOCTL_SCSI_MINIPORT_SMART_VERSION ((FILE_DEVICE_SCSI << 16) + 0x0500) +#define IOCTL_SCSI_MINIPORT_IDENTIFY ((FILE_DEVICE_SCSI << 16) + 0x0501) +#define IOCTL_SCSI_MINIPORT_READ_SMART_ATTRIBS ((FILE_DEVICE_SCSI << 16) + 0x0502) +#define IOCTL_SCSI_MINIPORT_READ_SMART_THRESHOLDS ((FILE_DEVICE_SCSI << 16) + 0x0503) +#define IOCTL_SCSI_MINIPORT_ENABLE_SMART ((FILE_DEVICE_SCSI << 16) + 0x0504) +#define IOCTL_SCSI_MINIPORT_DISABLE_SMART ((FILE_DEVICE_SCSI << 16) + 0x0505) +#define IOCTL_SCSI_MINIPORT_RETURN_STATUS ((FILE_DEVICE_SCSI << 16) + 0x0506) +#define IOCTL_SCSI_MINIPORT_ENABLE_DISABLE_AUTOSAVE ((FILE_DEVICE_SCSI << 16) + 0x0507) +#define IOCTL_SCSI_MINIPORT_SAVE_ATTRIBUTE_VALUES ((FILE_DEVICE_SCSI << 16) + 0x0508) +#define IOCTL_SCSI_MINIPORT_EXECUTE_OFFLINE_DIAGS ((FILE_DEVICE_SCSI << 16) + 0x0509) +#define IOCTL_SCSI_MINIPORT_ENABLE_DISABLE_AUTO_OFFLINE ((FILE_DEVICE_SCSI << 16) + 0x050a) +#define IOCTL_SCSI_MINIPORT_READ_SMART_LOG ((FILE_DEVICE_SCSI << 16) + 0x050b) +#define IOCTL_SCSI_MINIPORT_WRITE_SMART_LOG ((FILE_DEVICE_SCSI << 16) + 0x050c) + + +// +// Data set management IOCTL to match DSM notifications. Lba Ranges carried by this IOCTL belong to the same file. +// This IOCTL carries SRB_IO_CONTROL and DSM_NOTIFICATION_REQUEST_BLOCK as part of input parameters. +// +#define IOCTL_SCSI_MINIPORT_DSM ((FILE_DEVICE_SCSI << 16) + 0x0720) + +// +// Data set management IOCTL sent to miniport driver. Lba Ranges carried by this IOCTL may cross different files or do not belong to file. +// This IOCTL carries SRB_IO_CONTROL and DEVICE_MANAGE_DATA_SET_ATTRIBUTES as part of input parameters. +// NOTE that when construct input buffer, padding place may be needed between SRB_IO_CONTROL and DEVICE_MANAGE_DATA_SET_ATTRIBUTES to make sure +// DEVICE_MANAGE_DATA_SET_ATTRIBUTES is pointer safe. +// e.g. input buffer layout should be: ALIGN_UP(sizeof(SRB_IO_CONTROL), PVOID) + DEVICE_MANAGE_DATA_SET_ATTRIBUTES. +// (Parameter Block and DataSet Ranges will be indicated by fields in DEVICE_MANAGE_DATA_SET_ATTRIBUTES) +// +#define IOCTL_SCSI_MINIPORT_DSM_GENERAL ((FILE_DEVICE_SCSI << 16) + 0x0721) + +// +// CLUSTER support +// deliberately skipped some values to allow for expansion above. +// +#define IOCTL_SCSI_MINIPORT_NOT_QUORUM_CAPABLE ((FILE_DEVICE_SCSI << 16) + 0x0520) +#define IOCTL_SCSI_MINIPORT_NOT_CLUSTER_CAPABLE ((FILE_DEVICE_SCSI << 16) + 0x0521) + + +// begin_ntminitape + +// +// Read Capacity Data - returned in Big Endian format +// + +#pragma pack(push, read_capacity, 1) +typedef struct _READ_CAPACITY_DATA { + ULONG LogicalBlockAddress; + ULONG BytesPerBlock; +} READ_CAPACITY_DATA, *PREAD_CAPACITY_DATA; +#pragma pack(pop, read_capacity) + + +#pragma pack(push, read_capacity_ex, 1) +typedef struct _READ_CAPACITY_DATA_EX { + LARGE_INTEGER LogicalBlockAddress; + ULONG BytesPerBlock; +} READ_CAPACITY_DATA_EX, *PREAD_CAPACITY_DATA_EX; +#pragma pack(pop, read_capacity_ex) + + +#define RC_BASIS_LAST_LBA_NOT_SEQUENTIAL_WRITE_REQUIRED_ZONES 0x0 +#define RC_BASIS_LAST_LBA_ON_LOGICAL_UNIT 0x1 + +#pragma pack(push, read_capacity16, 1) +typedef struct _READ_CAPACITY16_DATA { + LARGE_INTEGER LogicalBlockAddress; + ULONG BytesPerBlock; + UCHAR ProtectionEnable : 1; + UCHAR ProtectionType : 3; + UCHAR RcBasis : 2; + UCHAR Reserved : 2; + UCHAR LogicalPerPhysicalExponent : 4; + UCHAR ProtectionInfoExponent : 4; + UCHAR LowestAlignedBlock_MSB : 6; + UCHAR LBPRZ : 1; + UCHAR LBPME : 1; + UCHAR LowestAlignedBlock_LSB; + UCHAR Reserved3[16]; +} READ_CAPACITY16_DATA, *PREAD_CAPACITY16_DATA; +#pragma pack(pop, read_capacity16) + + +// +// Get LBA Status structures, returned in Big Endian format. +// +#pragma pack(push, get_lba_status, 1) +typedef struct _LBA_STATUS_DESCRIPTOR { + ULONGLONG StartingLBA; + ULONG LogicalBlockCount; + UCHAR ProvisioningStatus : 4; + UCHAR Reserved1 : 4; + UCHAR Reserved2[3]; +} LBA_STATUS_DESCRIPTOR, *PLBA_STATUS_DESCRIPTOR; + +typedef struct _LBA_STATUS_LIST_HEADER { + ULONG ParameterLength; + ULONG Reserved; +#if !defined(__midl) + LBA_STATUS_DESCRIPTOR Descriptors[0]; +#endif +} LBA_STATUS_LIST_HEADER, *PLBA_STATUS_LIST_HEADER; +#pragma pack(pop, get_lba_status) + +#define LBA_STATUS_MAPPED 0x0 +#define LBA_STATUS_DEALLOCATED 0x1 +#define LBA_STATUS_ANCHORED 0x2 + +// +// Read Block Limits Data - returned in Big Endian format +// This structure returns the maximum and minimum block +// size for a TAPE device. +// + +#pragma pack(push, read_block_limits, 1) +typedef struct _READ_BLOCK_LIMITS { + UCHAR Reserved; + UCHAR BlockMaximumSize[3]; + UCHAR BlockMinimumSize[2]; +} READ_BLOCK_LIMITS_DATA, *PREAD_BLOCK_LIMITS_DATA; +#pragma pack(pop, read_block_limits) + +#pragma pack(push, read_buffer_capacity, 1) +typedef struct _READ_BUFFER_CAPACITY_DATA { + UCHAR DataLength[2]; + UCHAR Reserved1; + UCHAR BlockDataReturned : 1; + UCHAR Reserved4 : 7; + UCHAR TotalBufferSize[4]; + UCHAR AvailableBufferSize[4]; +} READ_BUFFER_CAPACITY_DATA, *PREAD_BUFFER_CAPACITY_DATA; +#pragma pack(pop, read_buffer_capacity) + +// +// Report Zones data structures. +// Returned data contains REPORT_ZONES_DATA as header, +// and ZONE_DESCRIPTIOR(s) +// + +#define ZONE_TYPE_CONVENTIONAL 0x1 +#define ZONE_TYPE_SEQUENTIAL_WRITE_REQUIRED 0x2 +#define ZONE_TYPE_SEQUENTIAL_WRITE_PREFERRED 0x3 + +#define ZONE_CONDITION_NOT_WRITE_POINTER 0x0 +#define ZONE_CONDITION_EMPTY 0x1 +#define ZONE_CONDITION_IMPLICITLY_OPENED 0x2 +#define ZONE_CONDITION_EXPLICITLY_OPENED 0x3 +#define ZONE_CONDITION_CLOSED 0x4 +#define ZONE_CONDITION_READ_ONLY 0xD +#define ZONE_CONDITION_FULL 0xE +#define ZONE_CONDITION_OFFLINE 0xF + + +#pragma pack(push, zone_descriptors, 1) +typedef struct _ZONE_DESCRIPTIOR { + UCHAR ZoneType : 4; + UCHAR Reserved1 : 4; + UCHAR Reset : 1; + UCHAR Non_Seq : 1; + UCHAR Reserved2 : 2; + UCHAR ZoneCondition : 4; + UCHAR Reserved3[6]; + UCHAR ZoneLength[8]; + UCHAR ZoneStartLBA[8]; + UCHAR WritePointerLBA[8]; + UCHAR Reserved4[32]; +} ZONE_DESCRIPTIOR, *PZONE_DESCRIPTIOR; +#pragma pack(pop, zone_descriptors) + +#define ZONES_TYPE_AND_LENGTH_MAY_DIFFERENT 0x0 +#define ZONES_TYPE_SAME_LENGTH_SAME 0x1 +#define ZONES_TYPE_SAME_LAST_ZONE_LENGTH_DIFFERENT 0x2 +#define ZONES_TYPE_MAY_DIFFERENT_LENGTH_SAME 0x3 + +#pragma pack(push, report_zones, 1) +typedef struct _REPORT_ZONES_DATA { + UCHAR ZoneListLength[4]; + UCHAR Same : 4; + UCHAR Reserved1 : 4; + UCHAR Reserved2[3]; + UCHAR MaxLBA[8]; + UCHAR Reserved3[48]; +#if !defined(__midl) + ZONE_DESCRIPTIOR ZoneDescriptors[ANYSIZE_ARRAY]; +#endif +} REPORT_ZONES_DATA, *PREPORT_ZONES_DATA; +#pragma pack(pop, report_zones) + + + + +// +// Mode data structures. +// + +// +// Define Mode parameter header. +// + +#pragma pack(push, mode_params, 1) +typedef struct _MODE_PARAMETER_HEADER { + UCHAR ModeDataLength; + UCHAR MediumType; + UCHAR DeviceSpecificParameter; + UCHAR BlockDescriptorLength; +}MODE_PARAMETER_HEADER, *PMODE_PARAMETER_HEADER; + +typedef struct _MODE_PARAMETER_HEADER10 { + UCHAR ModeDataLength[2]; + UCHAR MediumType; + UCHAR DeviceSpecificParameter; + UCHAR Reserved[2]; + UCHAR BlockDescriptorLength[2]; +}MODE_PARAMETER_HEADER10, *PMODE_PARAMETER_HEADER10; +#pragma pack(pop, mode_params) + +#define MODE_FD_SINGLE_SIDE 0x01 +#define MODE_FD_DOUBLE_SIDE 0x02 +#define MODE_FD_MAXIMUM_TYPE 0x1E +#define MODE_DSP_FUA_SUPPORTED 0x10 +#define MODE_DSP_WRITE_PROTECT 0x80 + +// +// Define the mode parameter block. +// + +#pragma pack(push, mode_params_block, 1) +typedef struct _MODE_PARAMETER_BLOCK { + UCHAR DensityCode; + UCHAR NumberOfBlocks[3]; + UCHAR Reserved; + UCHAR BlockLength[3]; +}MODE_PARAMETER_BLOCK, *PMODE_PARAMETER_BLOCK; + +#pragma pack(pop, mode_params_block) + + +// +// Define Disconnect-Reconnect page. +// + +#pragma pack(push, mode_page_disconnect, 1) +typedef struct _MODE_DISCONNECT_PAGE { + UCHAR PageCode : 6; + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR BufferFullRatio; + UCHAR BufferEmptyRatio; + UCHAR BusInactivityLimit[2]; + UCHAR BusDisconnectTime[2]; + UCHAR BusConnectTime[2]; + UCHAR MaximumBurstSize[2]; + UCHAR DataTransferDisconnect : 2; + UCHAR Reserved2[3]; +}MODE_DISCONNECT_PAGE, *PMODE_DISCONNECT_PAGE; +#pragma pack(pop, mode_page_disconnect) + +// +// Define mode caching page. +// + +#pragma pack(push, mode_page_caching, 1) +typedef struct _MODE_CACHING_PAGE { + UCHAR PageCode : 6; + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR ReadDisableCache : 1; + UCHAR MultiplicationFactor : 1; + UCHAR WriteCacheEnable : 1; + UCHAR Reserved2 : 5; + UCHAR WriteRetensionPriority : 4; + UCHAR ReadRetensionPriority : 4; + UCHAR DisablePrefetchTransfer[2]; + UCHAR MinimumPrefetch[2]; + UCHAR MaximumPrefetch[2]; + UCHAR MaximumPrefetchCeiling[2]; +}MODE_CACHING_PAGE, *PMODE_CACHING_PAGE; +#pragma pack(pop, mode_page_caching) + +#pragma pack(push, mode_page_caching_ex, 1) +typedef struct _MODE_CACHING_PAGE_EX { + UCHAR PageCode : 6; // 0x08 + UCHAR SubPageFormat : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR ReadDisableCache : 1; + UCHAR MultiplicationFactor : 1; + UCHAR WriteCacheEnable : 1; + UCHAR SizeEnable : 1; + UCHAR Discontinuity : 1; + UCHAR CachingAnalysisPermitted : 1; + UCHAR AbortPreFetch : 1; + UCHAR InitiatorControl : 1; + UCHAR WriteRetensionPriority : 4; + UCHAR ReadRetensionPriority : 4; + UCHAR DisablePrefetchTransfer[2]; + UCHAR MinimumPrefetch[2]; + UCHAR MaximumPrefetch[2]; + UCHAR MaximumPrefetchCeiling[2]; + UCHAR NvCacheDisable : 1; + UCHAR SyncCacheProgress : 2; + UCHAR VendorSpecific : 2; + UCHAR DisableReadAhead : 1; + UCHAR LogicalBlockCacheSegmentSize : 1; + UCHAR ForceSequentialWrite : 1; + UCHAR NumberOfCacheSegments; + UCHAR CacheSegmentSize[2]; + UCHAR Reserved[4]; +}MODE_CACHING_PAGE_EX, *PMODE_CACHING_PAGE_EX; +#pragma pack(pop, mode_page_caching_ex) + +#pragma pack(push, mode_page_control, 1) +typedef struct _MODE_CONTROL_PAGE { + UCHAR PageCode : 6; // 0x0A + UCHAR Reserved1 : 1; + UCHAR PageSavable : 1; + + UCHAR PageLength; + + UCHAR RLEC : 1; + UCHAR GLTSD : 1; + UCHAR D_SENSE : 1; + UCHAR DPICZ : 1; + UCHAR TMF_ONLY : 1; + UCHAR TST : 3; + + UCHAR Obsolete1 : 1; + UCHAR QERR : 2; + UCHAR NUAR : 1; + UCHAR QueueAlgorithmModifier : 4; + + UCHAR Obsolete2 : 3; + UCHAR SWP : 1; + UCHAR UA_INTLCK_CTRL : 2; + UCHAR RAC : 1; + UCHAR VS : 1; + + UCHAR AutoloadMode : 3; + UCHAR Reserved2 : 1; + UCHAR RWWP : 1; + UCHAR ATMPE : 1; + UCHAR TAS : 1; + UCHAR ATO : 1; + + UCHAR Obsolete3[2]; + UCHAR BusyTimeoutPeriod[2]; + UCHAR ExtendeSelfTestCompletionTime[2]; + +}MODE_CONTROL_PAGE, *PMODE_CONTROL_PAGE; +#pragma pack(pop, mode_page_control) + + +// +// Define write parameters cdrom page +// +#pragma pack(push, mode_page_wp2, 1) +typedef struct _MODE_CDROM_WRITE_PARAMETERS_PAGE2 { + UCHAR PageCode : 6; // 0x05 + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; // 0x32 ?? + UCHAR WriteType : 4; + UCHAR TestWrite : 1; + UCHAR LinkSizeValid : 1; + UCHAR BufferUnderrunFreeEnabled : 1; + UCHAR Reserved2 : 1; + UCHAR TrackMode : 4; + UCHAR Copy : 1; + UCHAR FixedPacket : 1; + UCHAR MultiSession : 2; + UCHAR DataBlockType : 4; + UCHAR Reserved3 : 4; + UCHAR LinkSize; + UCHAR Reserved4; + UCHAR HostApplicationCode : 6; + UCHAR Reserved5 : 2; + UCHAR SessionFormat; + UCHAR Reserved6; + UCHAR PacketSize[4]; + UCHAR AudioPauseLength[2]; + UCHAR MediaCatalogNumber[16]; + UCHAR ISRC[16]; + UCHAR SubHeaderData[4]; +} MODE_CDROM_WRITE_PARAMETERS_PAGE2, *PMODE_CDROM_WRITE_PARAMETERS_PAGE2; +#pragma pack(pop, mode_page_wp2) + +#ifndef DEPRECATE_DDK_FUNCTIONS +// this structure is being retired due to missing fields and overly +// complex data definitions for the MCN and ISRC. +#pragma pack(push, mode_page_wp, 1) +typedef struct _MODE_CDROM_WRITE_PARAMETERS_PAGE { + UCHAR PageLength; // 0x32 ?? + UCHAR WriteType : 4; + UCHAR TestWrite : 1; + UCHAR LinkSizeValid : 1; + UCHAR BufferUnderrunFreeEnabled : 1; + UCHAR Reserved2 : 1; + UCHAR TrackMode : 4; + UCHAR Copy : 1; + UCHAR FixedPacket : 1; + UCHAR MultiSession : 2; + UCHAR DataBlockType : 4; + UCHAR Reserved3 : 4; + UCHAR LinkSize; + UCHAR Reserved4; + UCHAR HostApplicationCode : 6; + UCHAR Reserved5 : 2; + UCHAR SessionFormat; + UCHAR Reserved6; + UCHAR PacketSize[4]; + UCHAR AudioPauseLength[2]; + UCHAR Reserved7 : 7; + UCHAR MediaCatalogNumberValid : 1; + UCHAR MediaCatalogNumber[13]; + UCHAR MediaCatalogNumberZero; + UCHAR MediaCatalogNumberAFrame; + UCHAR Reserved8 : 7; + UCHAR ISRCValid : 1; + UCHAR ISRCCountry[2]; + UCHAR ISRCOwner[3]; + UCHAR ISRCRecordingYear[2]; + UCHAR ISRCSerialNumber[5]; + UCHAR ISRCZero; + UCHAR ISRCAFrame; + UCHAR ISRCReserved; + UCHAR SubHeaderData[4]; +} MODE_CDROM_WRITE_PARAMETERS_PAGE, *PMODE_CDROM_WRITE_PARAMETERS_PAGE; +#pragma pack(pop, mode_page_wp) +#endif //ifndef DEPRECATE_DDK_FUNCTIONS + +// +// Define the MRW mode page for CDROM device types +// +#pragma pack(push, mode_page_mrw, 1) +typedef struct _MODE_MRW_PAGE { + UCHAR PageCode : 6; // 0x03 + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; //0x06 + UCHAR Reserved1; + UCHAR LbaSpace : 1; + UCHAR Reserved2 : 7; + UCHAR Reserved3[4]; +} MODE_MRW_PAGE, *PMODE_MRW_PAGE; +#pragma pack(pop, mode_page_mrw) + +// +// Define mode flexible disk page. +// + +#pragma pack(push, mode_page_flex, 1) +typedef struct _MODE_FLEXIBLE_DISK_PAGE { + UCHAR PageCode : 6; + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR TransferRate[2]; + UCHAR NumberOfHeads; + UCHAR SectorsPerTrack; + UCHAR BytesPerSector[2]; + UCHAR NumberOfCylinders[2]; + UCHAR StartWritePrecom[2]; + UCHAR StartReducedCurrent[2]; + UCHAR StepRate[2]; + UCHAR StepPluseWidth; + UCHAR HeadSettleDelay[2]; + UCHAR MotorOnDelay; + UCHAR MotorOffDelay; + UCHAR Reserved2 : 5; + UCHAR MotorOnAsserted : 1; + UCHAR StartSectorNumber : 1; + UCHAR TrueReadySignal : 1; + UCHAR StepPlusePerCyclynder : 4; + UCHAR Reserved3 : 4; + UCHAR WriteCompenstation; + UCHAR HeadLoadDelay; + UCHAR HeadUnloadDelay; + UCHAR Pin2Usage : 4; + UCHAR Pin34Usage : 4; + UCHAR Pin1Usage : 4; + UCHAR Pin4Usage : 4; + UCHAR MediumRotationRate[2]; + UCHAR Reserved4[2]; +} MODE_FLEXIBLE_DISK_PAGE, *PMODE_FLEXIBLE_DISK_PAGE; +#pragma pack(pop, mode_page_flex) + +// +// Define mode format page. +// + +#pragma pack(push, mode_page_format, 1) +typedef struct _MODE_FORMAT_PAGE { + UCHAR PageCode : 6; + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR TracksPerZone[2]; + UCHAR AlternateSectorsPerZone[2]; + UCHAR AlternateTracksPerZone[2]; + UCHAR AlternateTracksPerLogicalUnit[2]; + UCHAR SectorsPerTrack[2]; + UCHAR BytesPerPhysicalSector[2]; + UCHAR Interleave[2]; + UCHAR TrackSkewFactor[2]; + UCHAR CylinderSkewFactor[2]; + UCHAR Reserved2 : 4; + UCHAR SurfaceFirst : 1; + UCHAR RemovableMedia : 1; + UCHAR HardSectorFormating : 1; + UCHAR SoftSectorFormating : 1; + UCHAR Reserved3[3]; +} MODE_FORMAT_PAGE, *PMODE_FORMAT_PAGE; +#pragma pack(pop, mode_page_format) + +// +// Define rigid disk driver geometry page. +// + +#pragma pack(push, mode_page_geometry, 1) +typedef struct _MODE_RIGID_GEOMETRY_PAGE { + UCHAR PageCode : 6; + UCHAR Reserved : 1; + UCHAR PageSavable : 1; + UCHAR PageLength; + UCHAR NumberOfCylinders[3]; + UCHAR NumberOfHeads; + UCHAR StartWritePrecom[3]; + UCHAR StartReducedCurrent[3]; + UCHAR DriveStepRate[2]; + UCHAR LandZoneCyclinder[3]; + UCHAR RotationalPositionLock : 2; + UCHAR Reserved2 : 6; + UCHAR RotationOffset; + UCHAR Reserved3; + UCHAR RoataionRate[2]; + UCHAR Reserved4[2]; +}MODE_RIGID_GEOMETRY_PAGE, *PMODE_RIGID_GEOMETRY_PAGE; +#pragma pack(pop, mode_page_geometry) + +// +// Define read write recovery page +// + +#pragma pack(push, mode_page_rw_recovery, 1) +typedef struct _MODE_READ_WRITE_RECOVERY_PAGE { + + UCHAR PageCode : 6; + UCHAR Reserved1 : 1; + UCHAR PSBit : 1; + UCHAR PageLength; + UCHAR DCRBit : 1; + UCHAR DTEBit : 1; + UCHAR PERBit : 1; + UCHAR EERBit : 1; + UCHAR RCBit : 1; + UCHAR TBBit : 1; + UCHAR ARRE : 1; + UCHAR AWRE : 1; + UCHAR ReadRetryCount; + UCHAR Reserved4[4]; + UCHAR WriteRetryCount; + UCHAR Reserved5[3]; + +} MODE_READ_WRITE_RECOVERY_PAGE, *PMODE_READ_WRITE_RECOVERY_PAGE; +#pragma pack(pop, mode_page_rw_recovery) + +// +// Define read recovery page - cdrom +// + +#pragma pack(push, mode_page_r_recovery, 1) +typedef struct _MODE_READ_RECOVERY_PAGE { + + UCHAR PageCode : 6; + UCHAR Reserved1 : 1; + UCHAR PSBit : 1; + UCHAR PageLength; + UCHAR DCRBit : 1; + UCHAR DTEBit : 1; + UCHAR PERBit : 1; + UCHAR Reserved2 : 1; + UCHAR RCBit : 1; + UCHAR TBBit : 1; + UCHAR Reserved3 : 2; + UCHAR ReadRetryCount; + UCHAR Reserved4[4]; + +} MODE_READ_RECOVERY_PAGE, *PMODE_READ_RECOVERY_PAGE; +#pragma pack(pop, mode_page_r_recovery) + + +// +// Define Informational Exception Control Page. Used for failure prediction +// + +#pragma pack(push, mode_page_xcpt, 1) +typedef struct _MODE_INFO_EXCEPTIONS +{ + UCHAR PageCode : 6; + UCHAR Reserved1 : 1; + UCHAR PSBit : 1; + + UCHAR PageLength; + + union + { + UCHAR Flags; + struct + { + UCHAR LogErr : 1; + UCHAR Reserved2 : 1; + UCHAR Test : 1; + UCHAR Dexcpt : 1; + UCHAR Reserved3 : 3; + UCHAR Perf : 1; + }; + }; + + UCHAR ReportMethod : 4; + UCHAR Reserved4 : 4; + + UCHAR IntervalTimer[4]; + UCHAR ReportCount[4]; + +} MODE_INFO_EXCEPTIONS, *PMODE_INFO_EXCEPTIONS; +#pragma pack(pop, mode_page_xcpt) + +// +// Begin C/DVD 0.9 definitions +// + +// +// Power Condition Mode Page Format +// + +#pragma pack(push, mode_page_power, 1) +typedef struct _POWER_CONDITION_PAGE { + UCHAR PageCode : 6; // 0x1A + UCHAR Reserved : 1; + UCHAR PSBit : 1; + UCHAR PageLength; // 0x0A + UCHAR Reserved2; + + UCHAR Standby : 1; + UCHAR Idle : 1; + UCHAR Reserved3 : 6; + + UCHAR IdleTimer[4]; + UCHAR StandbyTimer[4]; +} POWER_CONDITION_PAGE, *PPOWER_CONDITION_PAGE; +#pragma pack(pop, mode_page_power) + +// +// CD-Audio Control Mode Page Format +// + +#pragma pack(push, mode_page_cdaudio, 1) +typedef struct _CDDA_OUTPUT_PORT { + UCHAR ChannelSelection : 4; + UCHAR Reserved : 4; + UCHAR Volume; +} CDDA_OUTPUT_PORT, *PCDDA_OUTPUT_PORT; + +typedef struct _CDAUDIO_CONTROL_PAGE { + UCHAR PageCode : 6; // 0x0E + UCHAR Reserved : 1; + UCHAR PSBit : 1; + + UCHAR PageLength; // 0x0E + + UCHAR Reserved2 : 1; + UCHAR StopOnTrackCrossing : 1; // Default 0 + UCHAR Immediate : 1; // Always 1 + UCHAR Reserved3 : 5; + + UCHAR Reserved4[3]; + UCHAR Obsolete[2]; + + CDDA_OUTPUT_PORT CDDAOutputPorts[4]; + +} CDAUDIO_CONTROL_PAGE, *PCDAUDIO_CONTROL_PAGE; +#pragma pack(pop, mode_page_cdaudio) + +#define CDDA_CHANNEL_MUTED 0x0 +#define CDDA_CHANNEL_ZERO 0x1 +#define CDDA_CHANNEL_ONE 0x2 +#define CDDA_CHANNEL_TWO 0x4 +#define CDDA_CHANNEL_THREE 0x8 + +// +// C/DVD Feature Set Support & Version Page +// + +#pragma pack(push, mode_page_features, 1) +typedef struct _CDVD_FEATURE_SET_PAGE { + UCHAR PageCode : 6; // 0x18 + UCHAR Reserved : 1; + UCHAR PSBit : 1; + + UCHAR PageLength; // 0x16 + + UCHAR CDAudio[2]; + UCHAR EmbeddedChanger[2]; + UCHAR PacketSMART[2]; + UCHAR PersistantPrevent[2]; + UCHAR EventStatusNotification[2]; + UCHAR DigitalOutput[2]; + UCHAR CDSequentialRecordable[2]; + UCHAR DVDSequentialRecordable[2]; + UCHAR RandomRecordable[2]; + UCHAR KeyExchange[2]; + UCHAR Reserved2[2]; +} CDVD_FEATURE_SET_PAGE, *PCDVD_FEATURE_SET_PAGE; +#pragma pack(pop, mode_page_features) + +// +// CDVD Inactivity Time-out Page Format +// + +#pragma pack(push, mode_page_timeout, 1) +typedef struct _CDVD_INACTIVITY_TIMEOUT_PAGE { + UCHAR PageCode : 6; // 0x1D + UCHAR Reserved : 1; + UCHAR PSBit : 1; + + UCHAR PageLength; // 0x08 + UCHAR Reserved2[2]; + + UCHAR SWPP : 1; + UCHAR DISP : 1; + UCHAR Reserved3 : 6; + + UCHAR Reserved4; + UCHAR GroupOneMinimumTimeout[2]; + UCHAR GroupTwoMinimumTimeout[2]; +} CDVD_INACTIVITY_TIMEOUT_PAGE, *PCDVD_INACTIVITY_TIMEOUT_PAGE; +#pragma pack(pop, mode_page_timeout) + +// +// CDVD Capabilities & Mechanism Status Page +// + +#define CDVD_LMT_CADDY 0 +#define CDVD_LMT_TRAY 1 +#define CDVD_LMT_POPUP 2 +#define CDVD_LMT_RESERVED1 3 +#define CDVD_LMT_CHANGER_INDIVIDUAL 4 +#define CDVD_LMT_CHANGER_CARTRIDGE 5 +#define CDVD_LMT_RESERVED2 6 +#define CDVD_LMT_RESERVED3 7 + + +#pragma pack(push, mode_page_capabilities, 1) +typedef struct _CDVD_CAPABILITIES_PAGE { + UCHAR PageCode : 6; // 0x2A + UCHAR Reserved : 1; + UCHAR PSBit : 1; // offset 0 + + UCHAR PageLength; // >= 0x18 // offset 1 + + UCHAR CDRRead : 1; + UCHAR CDERead : 1; + UCHAR Method2 : 1; + UCHAR DVDROMRead : 1; + UCHAR DVDRRead : 1; + UCHAR DVDRAMRead : 1; + UCHAR Reserved2 : 2; // offset 2 + + UCHAR CDRWrite : 1; + UCHAR CDEWrite : 1; + UCHAR TestWrite : 1; + UCHAR Reserved3 : 1; + UCHAR DVDRWrite : 1; + UCHAR DVDRAMWrite : 1; + UCHAR Reserved4 : 2; // offset 3 + + UCHAR AudioPlay : 1; + UCHAR Composite : 1; + UCHAR DigitalPortOne : 1; + UCHAR DigitalPortTwo : 1; + UCHAR Mode2Form1 : 1; + UCHAR Mode2Form2 : 1; + UCHAR MultiSession : 1; + UCHAR BufferUnderrunFree : 1; // offset 4 + + UCHAR CDDA : 1; + UCHAR CDDAAccurate : 1; + UCHAR RWSupported : 1; + UCHAR RWDeinterleaved : 1; + UCHAR C2Pointers : 1; + UCHAR ISRC : 1; + UCHAR UPC : 1; + UCHAR ReadBarCodeCapable : 1; // offset 5 + + UCHAR Lock : 1; + UCHAR LockState : 1; + UCHAR PreventJumper : 1; + UCHAR Eject : 1; + UCHAR Reserved6 : 1; + UCHAR LoadingMechanismType : 3; // offset 6 + + UCHAR SeparateVolume : 1; + UCHAR SeperateChannelMute : 1; + UCHAR SupportsDiskPresent : 1; + UCHAR SWSlotSelection : 1; + UCHAR SideChangeCapable : 1; + UCHAR RWInLeadInReadable : 1; + UCHAR Reserved7 : 2; // offset 7 + + union { + UCHAR ReadSpeedMaximum[2]; + UCHAR ObsoleteReserved[2]; // offset 8 + }; + + UCHAR NumberVolumeLevels[2]; // offset 10 + UCHAR BufferSize[2]; // offset 12 + + union { + UCHAR ReadSpeedCurrent[2]; + UCHAR ObsoleteReserved2[2]; // offset 14 + }; + UCHAR ObsoleteReserved3; // offset 16 + + UCHAR Reserved8 : 1; + UCHAR BCK : 1; + UCHAR RCK : 1; + UCHAR LSBF : 1; + UCHAR Length : 2; + UCHAR Reserved9 : 2; // offset 17 + + union { + UCHAR WriteSpeedMaximum[2]; + UCHAR ObsoleteReserved4[2]; // offset 18 + }; + union { + UCHAR WriteSpeedCurrent[2]; + UCHAR ObsoleteReserved11[2]; // offset 20 + }; + + // + // NOTE: This mode page is two bytes too small in the release + // version of the Windows2000 DDK. it also incorrectly + // put the CopyManagementRevision at offset 20 instead + // of offset 22, so fix that with a nameless union (for + // backwards-compatibility with those who "fixed" it on + // their own by looking at Reserved10[]). + // + + union { + UCHAR CopyManagementRevision[2]; // offset 22 + UCHAR Reserved10[2]; + }; + //UCHAR Reserved12[2]; // offset 24 + +} CDVD_CAPABILITIES_PAGE, *PCDVD_CAPABILITIES_PAGE; +#pragma pack(pop, mode_page_capabilities) + +#pragma pack(push, lun_list, 1) +typedef struct _LUN_LIST { + UCHAR LunListLength[4]; // sizeof LunSize * 8 + UCHAR Reserved[4]; +#if !defined(__midl) + UCHAR Lun[0][8]; // 4 level of addressing. 2 bytes each. +#endif +} LUN_LIST, *PLUN_LIST; +#pragma pack(pop, lun_list) + + +#define LOADING_MECHANISM_CADDY 0x00 +#define LOADING_MECHANISM_TRAY 0x01 +#define LOADING_MECHANISM_POPUP 0x02 +#define LOADING_MECHANISM_INDIVIDUAL_CHANGER 0x04 +#define LOADING_MECHANISM_CARTRIDGE_CHANGER 0x05 + +// +// end C/DVD 0.9 mode page definitions + +// +// Define Mode Subpage header. +// +#pragma pack(push, mode_page_subpage_header, 1) +typedef struct _MODE_PAGE_SUBPAGE_HEADER { + UCHAR PageCode : 6; + UCHAR SubPageFormat : 1; + UCHAR PageSavable : 1; + UCHAR SubPageCode; + UCHAR PageLength[2]; +} MODE_PAGE_SUBPAGE_HEADER, *PMODE_PAGE_SUBPAGE_HEADER; +#pragma pack(pop, mode_page_subpage_header) + +// +// Define Command Duration Limit Mode Subpages. +// + +#define COMMAND_DURATION_LIMIT_T2_UNIT_NONE 0 +#define COMMAND_DURATION_LIMIT_T2_UNIT_500NS 0x06 +#define COMMAND_DURATION_LIMIT_T2_UNIT_1US 0x08 +#define COMMAND_DURATION_LIMIT_T2_UNIT_10MS 0x0A +#define COMMAND_DURATION_LIMIT_T2_UNIT_500MS 0x0E + +#define DURATION_LIMIT_T2_DESCRIPTOR_COUNT 7 + +#define COMMAND_DURATION_LIMIT_T2_POLICY_DO_NOTHING 0 +#define COMMAND_DURATION_LIMIT_T2_POLICY_CONTINUE_WITH_NEXT 0x01 +#define COMMAND_DURATION_LIMIT_T2_POLICY_CONTINUE 0x02 +#define COMMAND_DURATION_LIMIT_T2_POLICY_COMPLETE_DATA_UNAVAILABLE 0x0D +#define COMMAND_DURATION_LIMIT_T2_POLICY_ABORT_TIMEOUT_PARTIAL_TRANSFER 0x0E +#define COMMAND_DURATION_LIMIT_T2_POLICY_AOBRT_TIMEOUT 0x0F + +#pragma pack(push, mode_page_command_duration_limit_subpages, 1) +typedef struct _T2_COMMAND_DURATION_LIMIT_DESCRIPTOR { + UCHAR T2CDLUNITS : 4; + UCHAR Reserved : 4; + UCHAR Reserved1; + UCHAR MAX_INACTIVE_TIME[2]; + UCHAR MAX_ACTIVE_TIME[2]; + UCHAR MAX_ACTIVE_TIME_POLICY : 4; + UCHAR MAX_INACTIVE_TIME_POLICY : 4; + UCHAR Reserved2[3]; + UCHAR COMMAND_DURATION_GUIDELINE[2]; + UCHAR Reserved3[2]; + UCHAR COMMAND_DURATION_GUIDELINE_POLICY : 4; + UCHAR Reserved4 : 4; + UCHAR BypassSequestration : 1; + UCHAR Reserved5 : 7; + UCHAR Reserved6[16]; +} T2_COMMAND_DURATION_LIMIT_DESCRIPTOR, *PT2_COMMAND_DURATION_LIMIT_DESCRIPTOR; + +typedef struct _MODE_COMMAND_DURATION_LIMIT_PAGE_T2A_SUBPAGE { + UCHAR PageCode : 6; // 0x0A + UCHAR SubPageFormat : 1; + UCHAR PageSavable : 1; + UCHAR SubPageCode; // 0x07 + UCHAR PageLength[2]; // Page length is 0x00E4 for T2A subpage + UCHAR Reserved[3]; + UCHAR Reserved1 : 4; + UCHAR PerfvsCommandDurationGuidelines : 4; + T2_COMMAND_DURATION_LIMIT_DESCRIPTOR T2CommandDurationLimitDescriptors[DURATION_LIMIT_T2_DESCRIPTOR_COUNT]; +} MODE_COMMAND_DURATION_LIMIT_PAGE_T2A_SUBPAGE, *PMODE_COMMAND_DURATION_LIMIT_PAGE_T2A_SUBPAGE; + +C_ASSERT(sizeof(MODE_COMMAND_DURATION_LIMIT_PAGE_T2A_SUBPAGE) == (0xE4 + sizeof(MODE_PAGE_SUBPAGE_HEADER))); + +typedef struct _MODE_COMMAND_DURATION_LIMIT_PAGE_T2B_SUBPAGE { + UCHAR PageCode : 6; // 0x0A + UCHAR SubPageFormat : 1; + UCHAR PageSavable : 1; + UCHAR SubPageCode; // 0x08 + UCHAR PageLength[2]; // Page length is 0x00E4 for T2B subpage + UCHAR Reserved[3]; + UCHAR Reserved1 : 4; + UCHAR PerfvsLatencyControls : 4; + T2_COMMAND_DURATION_LIMIT_DESCRIPTOR T2CommandDurationLimitDescriptors[DURATION_LIMIT_T2_DESCRIPTOR_COUNT]; +} MODE_COMMAND_DURATION_LIMIT_PAGE_T2B_SUBPAGE, *PMODE_COMMAND_DURATION_LIMIT_PAGE_T2B_SUBPAGE; + +C_ASSERT(sizeof(MODE_COMMAND_DURATION_LIMIT_PAGE_T2B_SUBPAGE) == (0xE4 + sizeof(MODE_PAGE_SUBPAGE_HEADER))); + +#pragma pack(pop, mode_page_command_duration_limit_subpages) + +// +// Mode parameter list block descriptor - +// set the block length for reading/writing +// +// + +#define MODE_BLOCK_DESC_LENGTH 8 +#define MODE_HEADER_LENGTH 4 +#define MODE_HEADER_LENGTH10 8 + +#pragma pack(push, mode_parm_rw, 1) +typedef struct _MODE_PARM_READ_WRITE { + + MODE_PARAMETER_HEADER ParameterListHeader; // List Header Format + MODE_PARAMETER_BLOCK ParameterListBlock; // List Block Descriptor + +} MODE_PARM_READ_WRITE_DATA, *PMODE_PARM_READ_WRITE_DATA; +#pragma pack(pop, mode_parm_rw) + +// end_ntminitape + +// +// CDROM audio control (0x0E) +// + +#define CDB_AUDIO_PAUSE 0 +#define CDB_AUDIO_RESUME 1 + +#define CDB_DEVICE_START 0x11 +#define CDB_DEVICE_STOP 0x10 + +#define CDB_EJECT_MEDIA 0x10 +#define CDB_LOAD_MEDIA 0x01 + +#define CDB_SUBCHANNEL_HEADER 0x00 +#define CDB_SUBCHANNEL_BLOCK 0x01 + +#define CDROM_AUDIO_CONTROL_PAGE 0x0E +#define MODE_SELECT_IMMEDIATE 0x04 +#define MODE_SELECT_PFBIT 0x10 + +#define CDB_USE_MSF 0x01 + +#pragma pack(push, audio_output, 1) +typedef struct _PORT_OUTPUT { + UCHAR ChannelSelection; + UCHAR Volume; +} PORT_OUTPUT, *PPORT_OUTPUT; + +typedef struct _AUDIO_OUTPUT { + UCHAR CodePage; + UCHAR ParameterLength; + UCHAR Immediate; + UCHAR Reserved[2]; + UCHAR LbaFormat; + UCHAR LogicalBlocksPerSecond[2]; + PORT_OUTPUT PortOutput[4]; +} AUDIO_OUTPUT, *PAUDIO_OUTPUT; +#pragma pack(pop, audio_output) + +// +// Multisession CDROM +// + +#define GET_LAST_SESSION 0x01 +#define GET_SESSION_DATA 0x02; + +// +// Atapi 2.5 changer +// + +#pragma pack(push, chgr_stuff, 1) +typedef struct _MECHANICAL_STATUS_INFORMATION_HEADER { + UCHAR CurrentSlot : 5; + UCHAR ChangerState : 2; + UCHAR Fault : 1; + UCHAR Reserved : 5; + UCHAR MechanismState : 3; + UCHAR CurrentLogicalBlockAddress[3]; + UCHAR NumberAvailableSlots; + UCHAR SlotTableLength[2]; +} MECHANICAL_STATUS_INFORMATION_HEADER, *PMECHANICAL_STATUS_INFORMATION_HEADER; + +typedef struct _SLOT_TABLE_INFORMATION { + UCHAR DiscChanged : 1; + UCHAR Reserved : 6; + UCHAR DiscPresent : 1; + UCHAR Reserved2[3]; +} SLOT_TABLE_INFORMATION, *PSLOT_TABLE_INFORMATION; + +typedef struct _MECHANICAL_STATUS { + MECHANICAL_STATUS_INFORMATION_HEADER MechanicalStatusHeader; + SLOT_TABLE_INFORMATION SlotTableInfo[1]; +} MECHANICAL_STATUS, *PMECHANICAL_STATUS; +#pragma pack(pop, chgr_stuff) + +// +// Structure related to 0x42 - SCSIOP_UNMAP +// + +#pragma pack(push, unmap, 1) +typedef struct _UNMAP_BLOCK_DESCRIPTOR { + UCHAR StartingLba[8]; + UCHAR LbaCount[4]; + UCHAR Reserved[4]; +} UNMAP_BLOCK_DESCRIPTOR, *PUNMAP_BLOCK_DESCRIPTOR; + +typedef struct _UNMAP_LIST_HEADER { + UCHAR DataLength[2]; + UCHAR BlockDescrDataLength[2]; + UCHAR Reserved[4]; +#if !defined(__midl) + UNMAP_BLOCK_DESCRIPTOR Descriptors[0]; +#endif +} UNMAP_LIST_HEADER, *PUNMAP_LIST_HEADER; +#pragma pack(pop, unmap) + + +// begin_ntminitape + +// +// Tape definitions +// + +#pragma pack(push, tape_position, 1) +typedef struct _TAPE_POSITION_DATA { + UCHAR Reserved1:2; + UCHAR BlockPositionUnsupported:1; + UCHAR Reserved2:3; + UCHAR EndOfPartition:1; + UCHAR BeginningOfPartition:1; + UCHAR PartitionNumber; + USHORT Reserved3; + UCHAR FirstBlock[4]; + UCHAR LastBlock[4]; + UCHAR Reserved4; + UCHAR NumberOfBlocks[3]; + UCHAR NumberOfBytes[4]; +} TAPE_POSITION_DATA, *PTAPE_POSITION_DATA; +#pragma pack(pop, tape_position) + +// +// This structure is used to convert little endian +// ULONGs to SCSI CDB big endians values. +// + +#pragma pack(push, byte_stuff, 1) +typedef union _EIGHT_BYTE { + + struct { + UCHAR Byte0; + UCHAR Byte1; + UCHAR Byte2; + UCHAR Byte3; + UCHAR Byte4; + UCHAR Byte5; + UCHAR Byte6; + UCHAR Byte7; + }; + + ULONGLONG AsULongLong; +} EIGHT_BYTE, *PEIGHT_BYTE; + +typedef union _FOUR_BYTE { + + struct { + UCHAR Byte0; + UCHAR Byte1; + UCHAR Byte2; + UCHAR Byte3; + }; + + ULONG AsULong; +} FOUR_BYTE, *PFOUR_BYTE; + +typedef union _TWO_BYTE { + + struct { + UCHAR Byte0; + UCHAR Byte1; + }; + + USHORT AsUShort; +} TWO_BYTE, *PTWO_BYTE; +#pragma pack(pop, byte_stuff) + +// +// Byte reversing macro for converting +// between big- and little-endian formats +// + +#define REVERSE_BYTES_QUAD REVERSE_BYTES_8 +#define REVERSE_BYTES_8(Destination, Source) { \ + PEIGHT_BYTE d = (PEIGHT_BYTE)(Destination); \ + PEIGHT_BYTE s = (PEIGHT_BYTE)(Source); \ + d->Byte7 = s->Byte0; \ + d->Byte6 = s->Byte1; \ + d->Byte5 = s->Byte2; \ + d->Byte4 = s->Byte3; \ + d->Byte3 = s->Byte4; \ + d->Byte2 = s->Byte5; \ + d->Byte1 = s->Byte6; \ + d->Byte0 = s->Byte7; \ +} + +#define REVERSE_BYTES_6(Destination, Source) { \ + PEIGHT_BYTE d = (PEIGHT_BYTE)(Destination); \ + PEIGHT_BYTE s = (PEIGHT_BYTE)(Source); \ + d->Byte5 = s->Byte0; \ + d->Byte4 = s->Byte1; \ + d->Byte3 = s->Byte2; \ + d->Byte2 = s->Byte3; \ + d->Byte1 = s->Byte4; \ + d->Byte0 = s->Byte5; \ +} + +#define REVERSE_BYTES REVERSE_BYTES_4 +#define REVERSE_BYTES_4(Destination, Source) { \ + PFOUR_BYTE d = (PFOUR_BYTE)(Destination); \ + PFOUR_BYTE s = (PFOUR_BYTE)(Source); \ + d->Byte3 = s->Byte0; \ + d->Byte2 = s->Byte1; \ + d->Byte1 = s->Byte2; \ + d->Byte0 = s->Byte3; \ +} + +#define REVERSE_BYTES_SHORT REVERSE_BYTES_2 +#define REVERSE_BYTES_2(Destination, Source) { \ + PTWO_BYTE d = (PTWO_BYTE)(Destination); \ + PTWO_BYTE s = (PTWO_BYTE)(Source); \ + d->Byte1 = s->Byte0; \ + d->Byte0 = s->Byte1; \ +} + +// +// Byte reversing macro for converting +// USHORTS from big to little endian in place +// + +#define REVERSE_SHORT(Short) { \ + UCHAR tmp; \ + PTWO_BYTE w = (PTWO_BYTE)(Short); \ + tmp = w->Byte0; \ + w->Byte0 = w->Byte1; \ + w->Byte1 = tmp; \ + } + +// +// Byte reversing macro for converting +// ULONGS between big & little endian in place +// + +#define REVERSE_LONG(Long) { \ + UCHAR tmp; \ + PFOUR_BYTE l = (PFOUR_BYTE)(Long); \ + tmp = l->Byte3; \ + l->Byte3 = l->Byte0; \ + l->Byte0 = tmp; \ + tmp = l->Byte2; \ + l->Byte2 = l->Byte1; \ + l->Byte1 = tmp; \ + } + +// +// Byte reversing macro for converting +// ULONGLONGS between big & little endian in place +// + +#define REVERSE_LONGLONG(Longlong) { \ + UCHAR tmp; \ + PEIGHT_BYTE q = (PEIGHT_BYTE)(Longlong); \ + tmp = q->Byte7; \ + q->Byte7 = q->Byte0; \ + q->Byte0 = tmp; \ + tmp = q->Byte6; \ + q->Byte6 = q->Byte1; \ + q->Byte1 = tmp; \ + tmp = q->Byte5; \ + q->Byte5 = q->Byte2; \ + q->Byte2 = tmp; \ + tmp = q->Byte4; \ + q->Byte4 = q->Byte3; \ + q->Byte3 = tmp; \ + } + +// +// This macro has the effect of Bit = log2(Data) +// + +#define WHICH_BIT(Data, Bit) { \ + ULONG idx; \ + BitScanReverse(&idx, (Data)); \ + (Bit) = (UCHAR)idx; \ + } + +// +// Define alignment requirements for variable length components in extended SRB. +// For Win64, need to ensure all variable length components are 8 bytes align +// so the pointer fields within the variable length components are 8 bytes align. +// +#if defined(_WIN64) || defined(_M_ALPHA) +#define STOR_ADDRESS_ALIGN DECLSPEC_ALIGN(8) +#else +#define STOR_ADDRESS_ALIGN +#endif + +// +// Generic structure definition for accessing any STOR_ADDRESS. All +// STOR_ADDRESS must begin with a Type, Port and AddressLength field. +// +typedef struct STOR_ADDRESS_ALIGN _STOR_ADDRESS { + USHORT Type; + USHORT Port; + ULONG AddressLength; + _Field_size_bytes_(AddressLength) UCHAR AddressData[ANYSIZE_ARRAY]; +} STOR_ADDRESS, *PSTOR_ADDRESS; + +// Define different storage address types +#define STOR_ADDRESS_TYPE_UNKNOWN 0x0 +#define STOR_ADDRESS_TYPE_BTL8 0x1 + +// +// The following address types are defined in srb.h to avoid introducing new +// dependencies on the legacy SCSI infrastructure. If there are any future updates +// to scsi.h the following values should be treated as reserved. +// +// STOR_ADDRESS_TYPE_NVME 0x2 +// + +#define STOR_ADDRESS_TYPE_MAX 0xffff + +// Define 8 bit bus, target and LUN address scheme +#define STOR_ADDR_BTL8_ADDRESS_LENGTH 4 +typedef struct STOR_ADDRESS_ALIGN _STOR_ADDR_BTL8 { + _Field_range_(STOR_ADDRESS_TYPE_BTL8, STOR_ADDRESS_TYPE_BTL8) + USHORT Type; + USHORT Port; + _Field_range_(STOR_ADDR_BTL8_ADDRESS_LENGTH, STOR_ADDR_BTL8_ADDRESS_LENGTH) + ULONG AddressLength; + UCHAR Path; + UCHAR Target; + UCHAR Lun; + UCHAR Reserved; +} STOR_ADDR_BTL8, *PSTOR_ADDR_BTL8; + +#if (NTDDI_VERSION >= NTDDI_WIN8) + + +//////////////////////////////////////////////////////////////////////////////// +// +// Ses definitions +// + +#define SES_DIAGNOSTIC_PAGE_CONFIGURATION 0x01 +#define SES_DIAGNOSTIC_PAGE_CONTROL 0x02 +#define SES_DIAGNOSTIC_PAGE_STATUS 0x02 +#define SES_DIAGNOSTIC_PAGE_STRING_IN 0x04 +#define SES_DIAGNOSTIC_PAGE_ADDITIONAL_ELEMENT_STATUS 0x0A +#define SES_DIAGNOSTIC_PAGE_DOWNLOAD_MICROCODE 0x0E + +#define SES_SAS_PROTOCOL_IDENTIFIER 6 + +typedef enum _SES_ELEMENT_TYPE { + + SesElementTypeUnknown = 0, + SesElementTypeDeviceSlot, + SesElementTypePowerSupply, + SesElementTypeCooling, + SesElementTypeTemperatureSensor, + SesElementTypeDoor, + SesElementTypeAudibleAlarm, + SesElementTypeController, + SesElementTypeScsiController, + SesElementTypeNonVolatileCache, + SesElementTypeInvalidOperationReason, + SesElementTypeUps, + SesElementTypeDisplay, + SesElementTypeKeypad, + SesElementTypeEnclosure, + SesElementTypeScsiPort, + SesElementTypeLanguage, + SesElementTypeCommunicationPort, + SesElementTypeVoltageSensor, + SesElementTypeCurrentSensor, + SesElementTypeScsiTargetPort, + SesElementTypeScsiInitiatorPort, + SesElementTypeSubEnclosure, + SesElementTypeArrayDeviceSlot, + SesElementTypeSasExpander, + SesElementTypeSasConnector, + SesElementTypeMax + +} SES_ELEMENT_TYPE, *PSES_ELEMENT_TYPE; + +typedef enum _SES_ELEMENT_STATE { + + SesElementStateNotReported = 0, // Unknown + SesElementStateOkay, // Healthy + SesElementStateCritical, // Unhealthy + SesElementStateNonCritical, // Warning + SesElementStateUnrecoverable, // Unhealthy + SesElementStateNotInstalled, // Unknown + SesElementStateUnknown, // Unhealthy + SesElementStateNotAvailable, // Warning + SesElementStateNoAccessAllowed, // Warning + SesElementStateMax + +} SES_ELEMENT_STATE, *PSES_ELEMENT_STATE; + +typedef enum _SES_DOWNLOAD_MICROCODE_STATE { + + SesDownloadMcStateNoneInProgress = 0x00, + SesDownloadMcStateInProgress = 0x01, + SesDownloadMcStateCompletedPendingReset = 0x11, + SesDownloadMcStateCompletedPendingPowerOn = 0x12, + SesDownloadMcStateCompletedPendingActivation = 0x13 + +} SES_DOWNLOAD_MICROCODE_STATE, *PSES_DOWNLOAD_MICROCODE_STATE; + +#pragma pack(push, ses, 1) + +typedef struct _SES_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR Reserved; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR PageData[ANYSIZE_ARRAY]; + +} SES_DIAGNOSTIC_PAGE, *PSES_DIAGNOSTIC_PAGE; + + +typedef struct _SES_TYPE_DESCRIPTOR_HEADER { + + UCHAR ElementType; // Byte 0 + UCHAR NumberOfPossibleElements; // Byte 1 + UCHAR SubEnclosureId; // Byte 2 + UCHAR TypeDescriptorTextLength; // Byte 3 + +} SES_TYPE_DESCRIPTOR_HEADER, *PSES_TYPE_DESCRIPTOR_HEADER; + +typedef struct _SES_ENCLOSURE_DESCRIPTOR { + + UCHAR NumberOfEnclosureServices : 3; // Byte 0, bit 0-2 + UCHAR Reserved1 : 1; // Byte 0, bit 3 + UCHAR RelativeEnclosureServicesId : 3; // Byte 0, bit 4-6 + UCHAR Reserved2 : 1; // Byte 0, bit 7 + UCHAR SubEnclosureId; // Byte 1 + UCHAR NumberOfTypeDescriptorHeaders; // Byte 2 + UCHAR EnclosureDescriptorLength; // Byte 3 + UCHAR Identifier[8]; // Byte 4-11 + UCHAR VendorId[8]; // Byte 12-19 + UCHAR ProductId[16]; // Byte 20-35 + UCHAR ProductRevisionLevel[4]; // Byte 36-39 + UCHAR VendorSpecific[ANYSIZE_ARRAY]; + +} SES_ENCLOSURE_DESCRIPTOR, *PSES_ENCLOSURE_DESCRIPTOR; + +typedef struct _SES_CONFIGURATION_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR NumberOfSecondarySubEnclosures; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR GenerationCode[4]; // Bytes 4-7 + SES_ENCLOSURE_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} SES_CONFIGURATION_DIAGNOSTIC_PAGE, *PSES_CONFIGURATION_DIAGNOSTIC_PAGE; + + +typedef struct _SES_CONTROL_DESCRIPTOR { + + UCHAR Reserved : 4; // Byte 0, bit 0-3 + UCHAR ResetSwap : 1; // Byte 0, bit 4 + UCHAR Disable : 1; // Byte 0, bit 5 + UCHAR PredictFailure : 1; // Byte 0, bit 6 + UCHAR Select : 1; // Byte 0, bit 7 + + union { + + struct { + + UCHAR Reserved1; // Byte 1 + UCHAR Reserved2 : 1; // Byte 2, bit 0 + UCHAR RequestIdentify : 1; // Byte 2, bit 1 + UCHAR RequestRemove : 1; // Byte 2, bit 2 + UCHAR RequestInsert : 1; // Byte 2, bit 3 + UCHAR RequestMissing : 1; // Byte 2, bit 4 + UCHAR Reserved3 : 1; // Byte 2, bit 5 + UCHAR DoNotRemove : 1; // Byte 2, bit 6 + UCHAR RequestActive : 1; // Byte 2, bit 7 + UCHAR Reserved4 : 2; // Byte 3, bit 0-1 + UCHAR EnableBypassB : 1; // Byte 3, bit 2 + UCHAR EnableBypassA : 1; // Byte 3, bit 3 + UCHAR DeviceOff : 1; // Byte 3, bit 4 + UCHAR RequestFault : 1; // Byte 3, bit 5 + UCHAR Reserved5 : 2; // Byte 3, bit 6-7 + + } DeviceSlot; + + struct { + + UCHAR Reserved1 : 7; // Byte 1, bit 0-6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR Reserved2; // Byte 2 + UCHAR Reserved3 : 5; // Byte 3, bit 0-4 + UCHAR RequestOn : 1; // Byte 3, bit 5 + UCHAR RequestFail : 1; // Byte 3, bit 6 + UCHAR Reserved4 : 1; // Byte 3, bit 7 + + } PowerSupply; + + struct { + + UCHAR Reserved1 : 7; // Byte 1, bit 0-6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR Reserved2; // Byte 2 + UCHAR RequestSpeedCode : 3; // Byte 3, bit 0-2 + UCHAR Reserved3 : 2; // Byte 3, bit 3-4 + UCHAR RequestOn : 1; // Byte 3, bit 5 + UCHAR RequestFail : 1; // Byte 3, bit 6 + UCHAR Reserved4 : 1; // Byte 3, bit 7 + + } Cooling; + + struct { + + UCHAR Reserved1 : 6; // Byte 1, bit 0-5 + UCHAR RequestFail : 1; // Byte 1, bit 6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR Reserved2; // Byte 2 + UCHAR Reserved3; // Byte 3 + + } TemperatureSensor; + + struct { + + UCHAR Reserved1 : 6; // Byte 1, bit 0-5 + UCHAR RequestFail : 1; // Byte 1, bit 6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR Reserved2; // Byte 2 + UCHAR Reserved3; // Byte 3 + + } VoltageSensor; + + struct { + + UCHAR Reserved1 : 6; // Byte 1, bit 0-5 + UCHAR RequestFail : 1; // Byte 1, bit 6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR Reserved2; // Byte 2 + UCHAR Reserved3; // Byte 3 + + } CurrentSensor; + + struct { + + UCHAR Reserved1 : 7; // Byte 1, bit 0-6 + UCHAR RequestIdentify : 1; // Byte 1, bit 7 + UCHAR PowerCycleDelay : 6; // Byte 2, bit 0-5 + UCHAR PowerCycleRequest : 2; // Byte 2, bit 6-7 + UCHAR RequestWarning : 1; // Byte 3, bit 0 + UCHAR RequestFailure : 1; // Byte 3, bit 1 + UCHAR PowerOffDuration : 6; // Byte 3, bit 2-7 + + } Enclosure; + + struct { + + UCHAR RequestRebuildAbort : 1; // Byte 1, bit 0 + UCHAR RequestRebuild : 1; // Byte 1, bit 1 + UCHAR RequestInFailedArray : 1; // Byte 1, bit 2 + UCHAR RequestInCriticalArray : 1; // Byte 1, bit 3 + UCHAR RequestConsistencyArray : 1; // Byte 1, bit 4 + UCHAR RequestHotSpare : 1; // Byte 1, bit 5 + UCHAR RequestReservedDevice : 1; // Byte 1, bit 6 + UCHAR RequestOK : 1; // Byte 1, bit 7 + UCHAR Reserved1 : 1; // Byte 2, bit 0 + UCHAR RequestIdentify : 1; // Byte 2, bit 1 + UCHAR RequestRemove : 1; // Byte 2, bit 2 + UCHAR RequestInsert : 1; // Byte 2, bit 3 + UCHAR RequestMissing : 1; // Byte 2, bit 4 + UCHAR Reserved2 : 1; // Byte 2, bit 5 + UCHAR DoNotRemove : 1; // Byte 2, bit 6 + UCHAR RequestActive : 1; // Byte 2, bit 7 + UCHAR Reserved3 : 2; // Byte 3, bit 0-1 + UCHAR EnableBypassB : 1; // Byte 3, bit 2 + UCHAR EnableBypassA : 1; // Byte 3, bit 3 + UCHAR DeviceOff : 1; // Byte 3, bit 4 + UCHAR RequestFault : 1; // Byte 3, bit 5 + UCHAR Reserved4 : 2; // Byte 3, bit 6-7 + + } ArrayDeviceSlot; + + }; + +} SES_CONTROL_DESCRIPTOR, *PSES_CONTROL_DESCRIPTOR; + +typedef struct _SES_CONTROL_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR Unrecoverable : 1; // Byte 1, bit 0 + UCHAR Critical : 1; // Byte 1, bit 1 + UCHAR NonCritical : 1; // Byte 1, bit 2 + UCHAR Informational : 1; // Byte 1, bit 3 + UCHAR Reserved : 4; // Byte 1, bit 4-7 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR ExpectedGenerationCode[4]; // Bytes 4-7 + SES_CONTROL_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} SES_CONTROL_DIAGNOSTIC_PAGE, *PSES_CONTROL_DIAGNOSTIC_PAGE; + + +typedef struct _SES_STATUS_DESCRIPTOR { + + UCHAR ElementStatus : 4; // Byte 0, bit 0-3 + UCHAR Swap : 1; // Byte 0, bit 4 + UCHAR Disabled : 1; // Byte 0, bit 5 + UCHAR PredictedFailure : 1; // Byte 0, bit 6 + UCHAR Reserved1 : 1; // Byte 0, bit 7 + + union { + + struct { + + UCHAR SlotAddress; // Byte 1 + UCHAR Report : 1; // Byte 2, bit 0 + UCHAR Identify : 1; // Byte 2, bit 1 + UCHAR Remove : 1; // Byte 2, bit 2 + UCHAR ReadyToInsert : 1; // Byte 2, bit 3 + UCHAR EnclosureBypassedB : 1; // Byte 2, bit 4 + UCHAR EnclosureBypassedA : 1; // Byte 2, bit 5 + UCHAR DoNotRemove : 1; // Byte 2, bit 6 + UCHAR AppBypassedA : 1; // Byte 2, bit 7 + UCHAR DeviceBypassedB : 1; // Byte 3, bit 0 + UCHAR DeviceBypassedA : 1; // Byte 3, bit 1 + UCHAR BypassedB : 1; // Byte 3, bit 2 + UCHAR BypassedA : 1; // Byte 3, bit 3 + UCHAR DeviceOff : 1; // Byte 3, bit 4 + UCHAR FaultRequested : 1; // Byte 3, bit 5 + UCHAR FaultSensed : 1; // Byte 3, bit 6 + UCHAR AppBypassedB : 1; // Byte 3, bit 7 + + } DeviceSlot; + + struct { + + UCHAR Reserved1 : 7; // Byte 1, bit 0-6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR Reserved2 : 1; // Byte 2, bit 0 + UCHAR DCOverCurrent : 1; // Byte 2, bit 1 + UCHAR DCUnderVoltage : 1; // Byte 2, bit 2 + UCHAR DCOverVoltage : 1; // Byte 2, bit 3 + UCHAR Reserved3 : 4; // Byte 2, bit 4-7 + UCHAR DCFail : 1; // Byte 3, bit 0 + UCHAR ACFail : 1; // Byte 3, bit 1 + UCHAR TemperatureWarning : 1; // Byte 3, bit 2 + UCHAR OverTemperatureFail : 1; // Byte 3, bit 3 + UCHAR Off : 1; // Byte 3, bit 4 + UCHAR RequestedOn : 1; // Byte 3, bit 5 + UCHAR Fail : 1; // Byte 3, bit 6 + UCHAR HotSwap : 1; // Byte 3, bit 7 + + } PowerSupply; + + struct { + + UCHAR ActualFanSpeedMSB : 3; // Byte 1, bit 0-2 + UCHAR Reserved1 : 4; // Byte 1, bit 3-6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR ActualFanSpeedLSB; // Byte 2 + UCHAR ActualSpeedCode : 3; // Byte 3, bit 0-2 + UCHAR Reserved2 : 1; // Byte 3, bit 3 + UCHAR Off : 1; // Byte 3, bit 4 + UCHAR RequestedOn : 1; // Byte 3, bit 5 + UCHAR Fail : 1; // Byte 3, bit 6 + UCHAR HotSwap : 1; // Byte 3, bit 7 + + } Cooling; + + struct { + + UCHAR Reserved1 : 6; // Byte 1, bit 0-5 + UCHAR Fail : 1; // Byte 1, bit 6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR Temperature; // Byte 2 + UCHAR UnderTemperatureWarning : 1; // Byte 3, bit 0 + UCHAR UnderTemperatureFailure : 1; // Byte 3, bit 1 + UCHAR OverTemperatureWarning : 1; // Byte 3, bit 2 + UCHAR OverTemperatureFailure : 1; // Byte 3, bit 3 + UCHAR Reserved2 : 4; // Byte 3, bit 4-7 + + } TemperatureSensor; + + struct { + + UCHAR CritUnder : 1; // Byte 1, bit 0 + UCHAR CritOver : 1; // Byte 1, bit 1 + UCHAR WarnUnder : 1; // Byte 1, bit 2 + UCHAR WarnOver : 1; // Byte 1, bit 3 + UCHAR Reserved1 : 2; // Byte 1, bit 4-5 + UCHAR Fail : 1; // Byte 1, bit 6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR VoltageMSB; // Byte 2 + UCHAR VoltageLSB; // Byte 3 + + } VoltageSensor; + + struct { + + UCHAR Reserved1 : 1; // Byte 1, bit 0 + UCHAR CritOver : 1; // Byte 1, bit 1 + UCHAR Reserved2 : 1; // Byte 1, bit 2 + UCHAR WarnOver : 1; // Byte 1, bit 3 + UCHAR Reserved3 : 2; // Byte 1, bit 4-5 + UCHAR Fail : 1; // Byte 1, bit 6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR CurrentMSB; // Byte 2 + UCHAR CurrentLSB; // Byte 3 + + } CurrentSensor; + + struct { + + UCHAR Reserved1 : 7; // Byte 1, bit 0-6 + UCHAR Identify : 1; // Byte 1, bit 7 + UCHAR WarningIndication : 1; // Byte 2, bit 0 + UCHAR FailureIndication : 1; // Byte 2, bit 1 + UCHAR TimeUntilPowerCycle : 6; // Byte 2, bit 6 + UCHAR WarningRequested : 1; // Byte 3, bit 0 + UCHAR FailureRequested : 1; // Byte 3, bit 1 + UCHAR RequestedPowerOffTime : 6; // Byte 3, bit 6 + + } Enclosure; + + struct { + + UCHAR RebuildAbort : 1; // Byte 1, bit 0 + UCHAR Rebuild : 1; // Byte 1, bit 1 + UCHAR InFailedArray : 1; // Byte 1, bit 2 + UCHAR InCriticalArray : 1; // Byte 1, bit 3 + UCHAR ConsistencyCheck : 1; // Byte 1, bit 4 + UCHAR HotSpare : 1; // Byte 1, bit 5 + UCHAR ReservedDevice : 1; // Byte 1, bit 6 + UCHAR OK : 1; // Byte 1, bit 7 + UCHAR Report : 1; // Byte 2, bit 0 + UCHAR Identify : 1; // Byte 2, bit 1 + UCHAR Remove : 1; // Byte 2, bit 2 + UCHAR ReadyToInsert : 1; // Byte 2, bit 3 + UCHAR EnclosureBypassedB : 1; // Byte 2, bit 4 + UCHAR EnclosureBypassedA : 1; // Byte 2, bit 5 + UCHAR DoNotRemove : 1; // Byte 2, bit 6 + UCHAR AppBypassedA : 1; // Byte 2, bit 7 + UCHAR DeviceBypassedB : 1; // Byte 3, bit 0 + UCHAR DeviceBypassedA : 1; // Byte 3, bit 1 + UCHAR BypassedB : 1; // Byte 3, bit 2 + UCHAR BypassedA : 1; // Byte 3, bit 3 + UCHAR DeviceOff : 1; // Byte 3, bit 4 + UCHAR FaultRequested : 1; // Byte 3, bit 5 + UCHAR FaultSensed : 1; // Byte 3, bit 6 + UCHAR AppBypassedB : 1; // Byte 3, bit 7 + + } ArrayDeviceSlot; + + }; + +} SES_STATUS_DESCRIPTOR, *PSES_STATUS_DESCRIPTOR; + +typedef struct _SES_STATUS_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR Unrecoverable : 1; // Byte 1, bit 0 + UCHAR Critical : 1; // Byte 1, bit 1 + UCHAR NonCritical : 1; // Byte 1, bit 2 + UCHAR Informational : 1; // Byte 1, bit 3 + UCHAR InvalidOperation : 1; // Byte 1, bit 4 + UCHAR Reserved : 3; // Byte 1, bit 5-7 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR GenerationCode[4]; // Bytes 4-7 + SES_STATUS_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} SES_STATUS_DIAGNOSTIC_PAGE, *PSES_STATUS_DIAGNOSTIC_PAGE; + + +typedef struct _SES_PHY_DESCRIPTOR { + + UCHAR Reserved1 : 4; // Byte 0, bit 0-3 + UCHAR DeviceType : 3; // Byte 0, bit 4-6 + UCHAR Reserved3 : 1; // Byte 0, bit 7 + UCHAR Reserved4; // Byte 1 + UCHAR Reserved5 : 1; // Byte 2, bit 0 + UCHAR SmpInitiatorPort : 1; // Byte 2, bit 1 + UCHAR StpInitiatorPort : 1; // Byte 2, bit 2 + UCHAR SspInitiatorPort : 1; // Byte 2, bit 3 + UCHAR Reserved6 : 4; // Byte 2, bit 4-7 + UCHAR SataDevice : 1; // Byte 3, bit 0 + UCHAR SmpTargetPort : 1; // Byte 3, bit 1 + UCHAR StpTargetPort : 1; // Byte 3, bit 2 + UCHAR SspTargetPort : 1; // Byte 3, bit 3 + UCHAR Reserved7 : 3; // Byte 3, bit 4-6 + UCHAR SataPortSelector : 1; // Byte 3, bit 7 + UCHAR AttachedSASAddress[8]; // Bytes 4-11 + UCHAR SASAddress[8]; // Bytes 12-19 + UCHAR PhyIdentifier; // Byte 20 + UCHAR Reserved2[7]; // Bytes 21-27 + +} SES_PHY_DESCRIPTOR, *PSES_PHY_DESCRIPTOR; + +typedef struct _SES_SAS_SLOT_INFORMATION { + + UCHAR NumberOfPhyDescriptors; // Byte 0 + UCHAR NotAllPhys : 1; // Byte 1, bit 0 + UCHAR Reserved1 : 5; // Byte 1, bit 1-5 + UCHAR Type : 2; // Byte 1, bit 6-7 + UCHAR Reserved2; // Byte 2 + UCHAR DeviceSlotNumber; // Byte 3 + SES_PHY_DESCRIPTOR PhyDescriptors[ANYSIZE_ARRAY]; + +} SES_SAS_SLOT_INFORMATION, *PSES_SAS_SLOT_INFORMATION; + +typedef union _SES_PROTOCOL_INFORMATION { + + // + // Add additional protocol infos + // as needed + // + + SES_SAS_SLOT_INFORMATION SasSlot; + +} SES_PROTOCOL_INFORMATION, *PSES_PROTOCOL_INFORMATION; + +typedef struct _SES_ADDITIONAL_ELEMENT_STATUS_DESCRIPTOR { + + // + // We expect EIP to be set to 1 + // + + UCHAR ProtocolIdentifier : 4; // Byte 0, bit 0-3 + UCHAR EIP : 1; // Byte 0, bit 4 + UCHAR Reserved1 : 2; // Byte 0, bit 5-6 + UCHAR Invalid : 1; // Byte 0, bit 7 + UCHAR Length; // Byte 1 + UCHAR Reserved2; // Byte 2 + UCHAR ElementIndex; // Byte 3 + SES_PROTOCOL_INFORMATION ProtocolInfo; + +} SES_ADDITIONAL_ELEMENT_STATUS_DESCRIPTOR, *PSES_ADDITIONAL_ELEMENT_STATUS_DESCRIPTOR; + +typedef struct _SES_ADDITIONAL_ELEMENT_STATUS_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR Reserved; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR GenerationCode[4]; // Bytes 4-7 + SES_ADDITIONAL_ELEMENT_STATUS_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} SES_ADDITIONAL_ELEMENT_STATUS_DIAGNOSTIC_PAGE, *PSES_ADDITIONAL_ELEMENT_STATUS_DIAGNOSTIC_PAGE; + +typedef struct _SES_DOWNLOAD_MICROCODE_STATUS_DESCRIPTOR { + + UCHAR Reserved1; // Byte 0 + UCHAR SubEnclosureId; // Byte 1 + UCHAR Status; // Byte 2 + UCHAR AdditionalStatus; // Byte 3 + UCHAR MaximumImageSize[4]; // Bytes 4-7 + UCHAR Reserved2[3]; // Bytes 8-10 + UCHAR ExpectedBufferId; // Byte 11 + UCHAR ExpectedBufferOffset; // Bytes 12-15 + +} SES_DOWNLOAD_MICROCODE_STATUS_DESCRIPTOR, *PSES_DOWNLOAD_MICROCODE_STATUS_DESCRIPTOR; + +typedef struct _SES_DOWNLOAD_MICROCODE_STATUS_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR NumberOfSecondarySubEnclosures; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR GenerationCode[4]; // Bytes 4-7 + SES_DOWNLOAD_MICROCODE_STATUS_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} SES_DOWNLOAD_MICROCODE_STATUS_DIAGNOSTIC_PAGE, *PSES_DOWNLOAD_MICROCODE_STATUS_DIAGNOSTIC_PAGE; + +typedef struct _SES_DOWNLOAD_MICROCODE_CONTROL_DIAGNOSTIC_PAGE { + + UCHAR PageCode; // Byte 0 + UCHAR SubEnclosureId; // Byte 1 + UCHAR PageLength[2]; // Bytes 2-3 + UCHAR ExpectedGenerationCode[4]; // Bytes 4-7 + UCHAR Mode; // Byte 8 + UCHAR Reserved[2]; // Bytes 9-10 + UCHAR BufferID; // Byte 11 + UCHAR BufferOffset[4]; // Bytes 12-15 + UCHAR ImageLength[4]; // Bytes 16-19 + UCHAR DataLength[4]; // Bytes 20-23 + UCHAR Data[ANYSIZE_ARRAY]; + +} SES_DOWNLOAD_MICROCODE_CONTROL_DIAGNOSTIC_PAGE, *PSES_DOWNLOAD_MICROCODE_CONTROL_DIAGNOSTIC_PAGE; + +#pragma pack(pop, ses) + + +#endif + +// +// Definitions related to 0x9E - SCSIOP_GET_PHYSICAL_ELEMENT_STATUS +// + +// +// Input: Report type +// +#define GET_PHYSICAL_ELEMENT_STATUS_REPORT_TYPE_PHYSICAL_ELEMENT 0x0 +#define GET_PHYSICAL_ELEMENT_STATUS_REPORT_TYPE_STORAGE_ELEMENT 0x1 + +// +// Input: Filter +// +#define GET_PHYSICAL_ELEMENT_STATUS_ALL 0x0 +#define GET_PHYSICAL_ELEMENT_STATUS_FILTER_NEED_ATTENTION 0x1 + +// +// Output: Physical element type +// +#define PHYSICAL_ELEMENT_TYPE_STORAGE_ELEMENT 0x01 + +// +// Output: Physical element health +// +#define PHYSICAL_ELEMENT_HEALTH_NOT_REPORTED 0x00 +#define PHYSICAL_ELEMENT_HEALTH_MANUFACTURER_SPECIFICATION_LIMIT 0x64 +#define PHYSICAL_ELEMENT_HEALTH_RESERVED_LOWER_BOUNDARY 0xD0 +#define PHYSICAL_ELEMENT_HEALTH_RESERVED_UPPER_BOUNDARY 0xFC +#define PHYSICAL_ELEMENT_HEALTH_DEPOPULATION_COMPLETED_WITH_ERROR 0xFD +#define PHYSICAL_ELEMENT_HEALTH_DEPOPULATION_IN_PROGRESS 0xFE +#define PHYSICAL_ELEMENT_HEALTH_DEPOPULATION_COMPLETED_SUCCESS 0xFF + +#pragma pack(push, physical_element_status, 1) + +typedef struct _PHYSICAL_ELEMENT_STATUS_DATA_DESCRIPTOR { + + UCHAR Reserved1[4]; + UCHAR ElementIdentifier[4]; + + UCHAR Reserved2[6]; + UCHAR PhysicalElementType; + UCHAR PhysicalElementHealth; + + UCHAR AssociatedCapacity[8]; + + UCHAR Reserved3[8]; + +} PHYSICAL_ELEMENT_STATUS_DATA_DESCRIPTOR, *PPHYSICAL_ELEMENT_STATUS_DATA_DESCRIPTOR; + +typedef struct _PHYSICAL_ELEMENT_STATUS_PARAMETER_DATA { + + UCHAR DescriptorCount[4]; + UCHAR ReturnedDescriptorCount[4]; + + UCHAR ElementIdentifierBeingDepoped[4]; + UCHAR Reserved[20]; + + PHYSICAL_ELEMENT_STATUS_DATA_DESCRIPTOR Descriptors[ANYSIZE_ARRAY]; + +} PHYSICAL_ELEMENT_STATUS_PARAMETER_DATA, *PPHYSICAL_ELEMENT_STATUS_PARAMETER_DATA; + +#pragma pack(pop, physical_element_status) + +// +// Definitions related to 0x9B - SCSIOP_READ_DATA_BUFF16(Mode 0x1C: Error History) +// + +// +// Input: Mode field for Read buffer command +// + +#define READ_BUFFER_MODE_ERROR_HISTORY 0x1C + +// +// Input: Mode specific field for Read buffer command +// + +#define MODE_SPECIFIC_CREATE_VENDOR_SPECIFIC_DATA 0x0 +#define MODE_SPECIFIC_CREATE_CURRENT_INTERNAL_STATUS_DATA 0x1 + +// +// Input: Buffer ID field for Read buffer command +// + +// +// Return error history directory. +// +#define BUFFER_ID_RETURN_ERROR_HISTORY_DIRECTORY 0x0 + +// +// Return error history directory and create new error history snapshot. +// +#define BUFFER_ID_RETURN_ERROR_HISTORY_DIRECTORY_CREATE_NEW_ERROR_HISTORY_SNAPSHOT 0x1 + +// +// Return error history directory and establish new error history I_T nexus. +// +#define BUFFER_ID_RETURN_ERROR_HISTORY_DIRECTORY_ESTABLISH_NEW_NEXUS 0x2 + +// +// Return error history directory, establish new error history I_T nexus, +// and create new error history snapshot. +// +#define BUFFER_ID_RETURN_ERROR_HISTORY_DIRECTORY_ESTABLISH_NEW_NEXUS_AND_SNAPSHOT 0x3 + +// +// 0x04h - 0x0Fh Reserved. +// + +// +// 0x10h - 0xEFh Return error history. +// +#define BUFFER_ID_RETURN_ERROR_HISTORY_MINIMUM_THRESHOLD 0x10 + +#define BUFFER_ID_RETURN_ERROR_HISTORY_MAXIMUM_THRESHOLD 0xEF + +// +// 0xF0h - 0xFDh Reserved. +// + +// +// Clear error history I_T nexus. +// +#define BUFFER_ID_CLEAR_ERROR_HISTORY_NEXUS 0xFE + +// +// Clear error history I_T nexus and release any error history snapshots. +// +#define BUFFER_ID_CLEAR_ERROR_HISTORY_AND_RELEASE_ANY_SNAPSHOT 0xFF + +// +// Output: Error history source field +// + +#define ERROR_HISTORY_SOURCE_CREATED_BY_DEVICE_SERVER 0x0 +#define ERROR_HISTORY_SOURCE_CREATED_DUE_TO_CURRENT_READ_BUFFER_COMMAND 0x1 +#define ERROR_HISTORY_SOURCE_CREATED_DUE_TO_PREVIOUS_READ_BUFFER_COMMAND 0x2 +#define ERROR_HISTORY_SOURCE_INDICATED_IN_BUFFER_SOURCE_FIELD 0x3 + +// +// Output: Error history retrieved field +// + +#define ERROR_HISTORY_RETRIEVED_NO_INFORMATION 0x0 + +// +// The error history I_T nexus has requested buffer ID FEh (i.e., clear error history I_T nexus) or buffer ID FFh +// (i.e., clear error history I_T nexus and release snapshot) for the current error history snapshot. +// +#define ERROR_HISTORY_RETRIEVED_BUFFER_ID_FE_OR_FF 0x1 + +// +// An error history I_T nexus has not requested buffer ID FEh (i.e., clear error history I_T nexus) or buffer ID FFh +// (i.e., clear error history I_T nexus and release snapshot) for the current error history snapshot. +// +#define ERROR_HISTORY_RETRIEVED_NOT_BUFFER_ID_FE_OR_FF 0x2 +#define ERROR_HISTORY_RETRIEVED_RESERVED 0x3 + +// +// Output: Buffer format +// + +#define BUFFER_FORMAT_VENDOR_SPECIFIC 0x0 +#define BUFFER_FORMAT_CURRENT_INTERNAL_STATUS_DATA 0x1 +#define BUFFER_FORMAT_SAVED_INTERNAL_STATUS_DATA 0x2 + +// +// Output: Buffer source +// + +#define BUFFER_SOURCE_INDICATED_IN_EHS_SOURCE_FIELD 0x0 +#define BUFFER_SOURCE_UNKNOWN 0x1 +#define BUFFER_SOURCE_CREATED_BY_DEVICE_SERVER 0x2 +#define BUFFER_SOURCE_CREATED_DUE_TO_CURRENT_COMMAND 0x3 +#define BUFFER_SOURCE_CREATED_DUE_TO_PREVIOUS_COMMAND 0x4 + +#define STATUS_DATA_SET_SIZE_INCREMENT_IN_BYTES 0x200 + +#pragma pack(push, error_history, 1) + +typedef struct _ERROR_HISTORY_DIRECTORY_ENTRY { + + UCHAR SupportedBufferId; + UCHAR BufferFormat; + UCHAR BufferSource : 4; + UCHAR Reserved0 : 4; + UCHAR Reserved1; + UCHAR MaxAvailableLength[4]; + +} ERROR_HISTORY_DIRECTORY_ENTRY, *PERROR_HISTORY_DIRECTORY_ENTRY; + +typedef struct _ERROR_HISTORY_DIRECTORY { + + UCHAR T10VendorId[8]; + UCHAR ErrorHistoryVersion; + UCHAR ClearSupport : 1; + UCHAR ErrorHistorySource : 2; + UCHAR ErrorHistoryRetrieved : 2; + UCHAR Reserved0 : 3; + UCHAR Reserved1[20]; + UCHAR DirectoryLength[2]; + + ERROR_HISTORY_DIRECTORY_ENTRY ErrorHistoryDirectoryList[ANYSIZE_ARRAY]; + +} ERROR_HISTORY_DIRECTORY, *PERROR_HISTORY_DIRECTORY; + +typedef struct _CURRENT_INTERNAL_STATUS_PARAMETER_DATA { + + UCHAR Reserved0[4]; + UCHAR IEEECompanyId[4]; + UCHAR CurrentInternalStatusDataSetOneLength[2]; + UCHAR CurrentInternalStatusDataSetTwoLength[2]; + UCHAR CurrentInternalStatusDataSetThreeLength[2]; + UCHAR CurrentInternalStatusDataSetFourLength[4]; + UCHAR Reserved1[364]; + UCHAR NewSavedDataAvailable; + UCHAR SavedDataGenerationNumber; + UCHAR CurrentReasonIdentifier[128]; + + UCHAR CurrentInternalStatusData[ANYSIZE_ARRAY]; + +} CURRENT_INTERNAL_STATUS_PARAMETER_DATA, *PCURRENT_INTERNAL_STATUS_PARAMETER_DATA; + +typedef struct _SAVED_INTERNAL_STATUS_PARAMETER_DATA { + + UCHAR Reserved0[4]; + UCHAR IEEECompanyId[4]; + UCHAR SavedInternalStatusDataSetOneLength[2]; + UCHAR SavedInternalStatusDataSetTwoLength[2]; + UCHAR SavedInternalStatusDataSetThreeLength[2]; + UCHAR SavedInternalStatusDataSetFourLength[4]; + UCHAR Reserved1[364]; + UCHAR NewSavedDataAvailable; + UCHAR SavedDataGenerationNumber; + UCHAR SavedReasonIdentifier[128]; + + UCHAR SavedInternalStatusData[ANYSIZE_ARRAY]; + +} SAVED_INTERNAL_STATUS_PARAMETER_DATA, *PSAVED_INTERNAL_STATUS_PARAMETER_DATA; + +#pragma pack(pop, error_history) + +// +// Collections of SCSI utility functions +// + +// +// SCSI sense data related functions +// + +// +// NOTE: Sense Data Descriptor Format is supported only in Windows 8 and later +// + +// +// Obtain Error Code from the sense info buffer. +// Note: Error Code is same as "Response Code" defined in SPC Specification. +// +#define ScsiGetSenseErrorCode(SenseInfoBuffer) (((PUCHAR)(SenseInfoBuffer))[0] & 0x7f) + +// +// Determine the buffer length of a descriptor +// +#define ScsiGetSenseDescriptorLength(DescriptorBuffer) \ + (sizeof(SCSI_SENSE_DESCRIPTOR_HEADER) + ((PSCSI_SENSE_DESCRIPTOR_HEADER)(DescriptorBuffer))->AdditionalLength) + +// +// Determine if sense data is in Fixed format +// +#define IsFixedSenseDataFormat(SenseInfoBuffer) \ + ((ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_FIXED_CURRENT || \ + (ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_FIXED_DEFERRED) + +// +// Determine if sense data is in Descriptor format +// +#define IsDescriptorSenseDataFormat(SenseInfoBuffer) \ + ((ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_DESCRIPTOR_CURRENT || \ + (ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_DESCRIPTOR_DEFERRED) + +// +// Determine if sense data is Current error type +// +#define IsSenseDataCurrentError(SenseInfoBuffer) \ + ((ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_FIXED_CURRENT || \ + (ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_DESCRIPTOR_CURRENT) + +// +// Determine if sense data is Deferred error type +// +#define IsSenseDataDeferredError(SenseInfoBuffer) \ + ((ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_FIXED_DEFERRED || \ + (ScsiGetSenseErrorCode(SenseInfoBuffer)) == SCSI_SENSE_ERRORCODE_DESCRIPTOR_DEFERRED) + +// +// Determine if sense data format indicated in sense data payload is a valid value +// +#define IsSenseDataFormatValueValid(SenseInfoBuffer) \ + (IsFixedSenseDataFormat(SenseInfoBuffer) || IsDescriptorSenseDataFormat(SenseInfoBuffer)) + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetTotalSenseByteCountIndicated ( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _Out_ UCHAR *TotalByteCountIndicated + ) +/*++ + +Description: + + This function returns size of available sense data. This is based on + AdditionalSenseLength field in the sense data payload as indicated + by the device. + + This function handles both Fixed and Desciptor format. + +Arguments: + + SenseInfoBuffer + - A pointer to sense info buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + TotalByteCountIndicated + - On output, it contains total byte counts of available sense data + +Returns: + + TRUE if the function is able to determine size of available sense data + + Otherwise, FALSE + + Note: The routine returns FALSE when available sense data amount is + greater than MAX_SENSE_BUFFER_SIZE + +--*/ +{ + BOOLEAN succeed = FALSE; + UCHAR byteCount = 0; + PFIXED_SENSE_DATA senseInfoBuffer = NULL; + + if (SenseInfoBuffer == NULL || + SenseInfoBufferLength == 0 || + TotalByteCountIndicated == NULL) { + + return FALSE; + } + + + // + // Offset to AdditionalSenseLength field is same between + // Fixed and Descriptor format. + // + senseInfoBuffer = (PFIXED_SENSE_DATA)SenseInfoBuffer; + + if (RTL_CONTAINS_FIELD(senseInfoBuffer, + SenseInfoBufferLength, + AdditionalSenseLength)) { + + if (senseInfoBuffer->AdditionalSenseLength <= + (MAX_SENSE_BUFFER_SIZE - RTL_SIZEOF_THROUGH_FIELD(FIXED_SENSE_DATA, AdditionalSenseLength))) { + + byteCount = senseInfoBuffer->AdditionalSenseLength + + RTL_SIZEOF_THROUGH_FIELD(FIXED_SENSE_DATA, AdditionalSenseLength); + + *TotalByteCountIndicated = byteCount; + + succeed = TRUE; + } + } + + return succeed; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetFixedSenseKeyAndCodes ( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _Out_opt_ PUCHAR SenseKey, + _Out_opt_ PUCHAR AdditionalSenseCode, + _Out_opt_ PUCHAR AdditionalSenseCodeQualifier + ) +/*++ + +Description: + + This function retrieves the following information from sense data + in Fixed format: + + 1. Sense key + 2. Additional Sense Code + 3. Additional Sense Code Qualifier + + If Additional Sense Code or Additional Sense Code Qualifer is not available, + it is set to 0 when the function returns. + +Arguments: + + SenseInfoBuffer + - A pointer to sense info buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + SenseKey + - On output, buffer contains the sense key. + If null is specified, the function will not retrieve the sense key + + AdditionalSenseCode + - On output, buffer contains the additional sense code. + If null is specified, the function will not retrieve the additional sense code. + + AdditionalSenseCodeQualifier + - On output, buffer contains the additional sense code qualifier. + If null is specified, the function will not retrieve the additional sense code qualifier. + +Returns: + + TRUE if the function is able to retrieve the requested information. + + Otherwise, FALSE + +--*/ +{ + PFIXED_SENSE_DATA fixedSenseData = (PFIXED_SENSE_DATA)SenseInfoBuffer; + BOOLEAN succeed = FALSE; + ULONG dataLength = 0; + + if (SenseInfoBuffer == NULL || SenseInfoBufferLength == 0) { + return FALSE; + } + + if (RTL_CONTAINS_FIELD(fixedSenseData, SenseInfoBufferLength, AdditionalSenseLength)) { + + dataLength = fixedSenseData->AdditionalSenseLength + RTL_SIZEOF_THROUGH_FIELD(FIXED_SENSE_DATA, AdditionalSenseLength); + + if (dataLength > SenseInfoBufferLength) { + dataLength = SenseInfoBufferLength; + } + + if (SenseKey != NULL) { + *SenseKey = fixedSenseData->SenseKey; + } + + if (AdditionalSenseCode != NULL) { + *AdditionalSenseCode = RTL_CONTAINS_FIELD(fixedSenseData, dataLength, AdditionalSenseCode) ? + fixedSenseData->AdditionalSenseCode : 0; + } + + if (AdditionalSenseCodeQualifier != NULL) { + *AdditionalSenseCodeQualifier = RTL_CONTAINS_FIELD(fixedSenseData, dataLength, AdditionalSenseCodeQualifier) ? + fixedSenseData->AdditionalSenseCodeQualifier : 0; + } + + succeed = TRUE; + } + + return succeed; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetDescriptorSenseKeyAndCodes ( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _Out_opt_ PUCHAR SenseKey, + _Out_opt_ PUCHAR AdditionalSenseCode, + _Out_opt_ PUCHAR AdditionalSenseCodeQualifier + ) +/*++ + +Description: + + This function retrieves the following information from sense data + in Descriptor format: + + 1. Sense key + 2. Additional Sense Code + 3. Additional Sense Code Qualifier + +Arguments: + + SenseInfoBuffer + - A pointer to sense info buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + SenseKey + - On output, buffer contains the sense key. + Note: If null is specified, the function will not retrieve the sense key + + AdditionalSenseCode + - On output, buffer contains the additional sense code. + Note: If null is specified, the function will not retrieve the additional sense code. + + AdditionalSenseCodeQualifier + - On output, buffer contains the additional sense code qualifier. + Note: If null is specified, the function will not retrieve the additional sense code qualifier. + +Returns: + + TRUE if the function is able to retrieve the requested information. + + Otherwise, FALSE + +--*/ +{ + PDESCRIPTOR_SENSE_DATA descriptorSenseData = (PDESCRIPTOR_SENSE_DATA)SenseInfoBuffer; + BOOLEAN succeed = FALSE; + + if (SenseInfoBuffer == NULL || SenseInfoBufferLength == 0) { + return FALSE; + } + if (RTL_CONTAINS_FIELD(descriptorSenseData, SenseInfoBufferLength, AdditionalSenseLength)) { + + if (SenseKey) { + *SenseKey = descriptorSenseData->SenseKey; + } + + if (AdditionalSenseCode != NULL) { + *AdditionalSenseCode = descriptorSenseData->AdditionalSenseCode; + } + + if (AdditionalSenseCodeQualifier != NULL) { + *AdditionalSenseCodeQualifier = descriptorSenseData->AdditionalSenseCodeQualifier; + } + + succeed = TRUE; + } + + return succeed; +} + +// +// SCSI_SENSE_OPTIONS +// + +typedef ULONG SCSI_SENSE_OPTIONS; + +// +// No options is specified +// +#define SCSI_SENSE_OPTIONS_NONE ((SCSI_SENSE_OPTIONS)0x00000000) + +// +// If no known format is indicated in the sense buffer, interpret +// the sense buffer as Fixed format. +// +#define SCSI_SENSE_OPTIONS_FIXED_FORMAT_IF_UNKNOWN_FORMAT_INDICATED ((SCSI_SENSE_OPTIONS)0x00000001) + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetSenseKeyAndCodes ( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _In_ SCSI_SENSE_OPTIONS Options, + _Out_opt_ PUCHAR SenseKey, + _Out_opt_ PUCHAR AdditionalSenseCode, + _Out_opt_ PUCHAR AdditionalSenseCodeQualifier + ) +/*++ + +Description: + + This function retrieves the following information from sense data + + 1. Sense key + 2. Additional Sense Code + 3. Additional Sense Code Qualifier + + This function handles both Fixed and Descriptor format. + +Arguments: + + SenseInfoBuffer + - A pointer to sense info buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + Options + - Options used by this routine. It is a bit-field value. See defintions + of list of #define SCSI_SENSE_OPTIONS above in this file. + + SenseKey + - On output, buffer contains the sense key. + Note: If null is specified, the function will not retrieve the sense key + + AdditionalSenseCode + - On output, buffer contains the additional sense code. + Note: If null is specified, the function will not retrieve the additional sense code. + + AdditionalSenseCodeQualifier + - On output, buffer contains the additional sense code qualifier. + Note: If null is specified, the function will not retrieve the additional sense code qualifier. + +Returns: + + TRUE if the function is able to retrieve the requested information. + + Otherwise, FALSE + +--*/ +{ + BOOLEAN succeed = FALSE; + + if (SenseInfoBuffer == NULL || SenseInfoBufferLength == 0) { + return FALSE; + } + + if (IsDescriptorSenseDataFormat(SenseInfoBuffer)) { + + succeed = ScsiGetDescriptorSenseKeyAndCodes( SenseInfoBuffer, + SenseInfoBufferLength, + SenseKey, + AdditionalSenseCode, + AdditionalSenseCodeQualifier ); + } else { + + if ((Options & SCSI_SENSE_OPTIONS_FIXED_FORMAT_IF_UNKNOWN_FORMAT_INDICATED) || + IsFixedSenseDataFormat(SenseInfoBuffer)) { + + succeed = ScsiGetFixedSenseKeyAndCodes( SenseInfoBuffer, + SenseInfoBufferLength, + SenseKey, + AdditionalSenseCode, + AdditionalSenseCodeQualifier ); + } + } + + return succeed; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetSenseDescriptor( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _Outptr_result_bytebuffer_(*DescriptorBufferLength) PVOID *DescriptorBuffer, + _Out_ UCHAR *DescriptorBufferLength + ) +/*++ + +Description: + + This function calculates available amount of descriptors information + within sense data in Descriptor format. Then, it returns the starting + address of descriptors and amount of descriptor data available. + +Arguments: + + SenseInfoBuffer + - A pointer to sense info buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + DescriptorBuffer + - On output, it contains pointer to the starting address of descriptor + + DescriptorBufferLength + - On output, it contains number of bytes of available descriptor data + +Returns: + + TRUE if the function succeeds + + Otherwise, FALSE + + Note: FALSE if no descriptor data are available. + +--*/ +{ + PDESCRIPTOR_SENSE_DATA descriptorSenseData; + BOOLEAN succeed = FALSE; + UCHAR dataLength = 0; + + if (SenseInfoBuffer == NULL || + SenseInfoBufferLength == 0 || + DescriptorBuffer == NULL || + DescriptorBufferLength == NULL) { + return FALSE; + } + + *DescriptorBuffer = NULL; + *DescriptorBufferLength = 0; + + if (!IsDescriptorSenseDataFormat(SenseInfoBuffer)) { + return FALSE; + } + + descriptorSenseData = (PDESCRIPTOR_SENSE_DATA)SenseInfoBuffer; + + if (RTL_CONTAINS_FIELD(descriptorSenseData, SenseInfoBufferLength, AdditionalSenseLength)) { + + if (descriptorSenseData->AdditionalSenseLength <= (MAX_SENSE_BUFFER_SIZE - RTL_SIZEOF_THROUGH_FIELD(DESCRIPTOR_SENSE_DATA, AdditionalSenseLength))) { + + dataLength = descriptorSenseData->AdditionalSenseLength + RTL_SIZEOF_THROUGH_FIELD(DESCRIPTOR_SENSE_DATA, AdditionalSenseLength); + + if (dataLength > SenseInfoBufferLength) { + dataLength = SenseInfoBufferLength; + } + + *DescriptorBufferLength = dataLength - RTL_SIZEOF_THROUGH_FIELD(DESCRIPTOR_SENSE_DATA, AdditionalSenseLength); + + if (*DescriptorBufferLength > 0) { + *DescriptorBuffer = (PVOID)(descriptorSenseData->DescriptorBuffer); + succeed = TRUE; + } + } + } + + return succeed; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiValidateInformationSenseDescriptor( + _In_reads_bytes_(DescriptorBufferLength) PVOID DescriptorBuffer, + _In_ UCHAR DescriptorBufferLength + ) +/*++ + +Description: + + This function validates if buffer contains a valid payload for descriptor of Information type + +Arguments: + + DescriptorBuffer + - Pointer to the starting address of descriptor payload + + DescriptorBufferLength + - Size of the buffer that DescriptorBuffer points to. + +Returns: + + TRUE if DescriptorBuffer contains valid payload for Information type descriptor. + + Otherwise, FALSE + +--*/ +{ + PSCSI_SENSE_DESCRIPTOR_INFORMATION descriptor; + UCHAR additionalLength; + + if (DescriptorBuffer == NULL || DescriptorBufferLength < sizeof(SCSI_SENSE_DESCRIPTOR_INFORMATION)) { + return FALSE; + } + + descriptor = (PSCSI_SENSE_DESCRIPTOR_INFORMATION)DescriptorBuffer; + + if (descriptor->Header.DescriptorType != SCSI_SENSE_DESCRIPTOR_TYPE_INFORMATION) { + return FALSE; + } + + additionalLength = sizeof(SCSI_SENSE_DESCRIPTOR_INFORMATION) - RTL_SIZEOF_THROUGH_FIELD(SCSI_SENSE_DESCRIPTOR_INFORMATION, Header); + + if (descriptor->Header.AdditionalLength != additionalLength) { + return FALSE; + } + + if (descriptor->Valid == 0) { + return FALSE; + } + + return TRUE; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiValidateBlockCommandSenseDescriptor( + _In_reads_bytes_(DescriptorBufferLength) PVOID DescriptorBuffer, + _In_ UCHAR DescriptorBufferLength + ) +/*++ + +Description: + + This function validates if buffer contains a valid payload for Block Command type descriptor + +Arguments: + + DescriptorBuffer + - Pointer to the starting address of descriptor payload + + DescriptorBufferLength + - Size of the buffer that DescriptorBuffer points to + +Returns: + + TRUE if DescriptorBuffer contains a valid payload for descriptor of Block Command type + + Otherwise, FALSE + +--*/ +{ + PSCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND descriptor; + UCHAR additionalLength; + + if (DescriptorBuffer == NULL || DescriptorBufferLength < sizeof(SCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND)) { + return FALSE; + } + + descriptor = (PSCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND)DescriptorBuffer; + + if (descriptor->Header.DescriptorType != SCSI_SENSE_DESCRIPTOR_TYPE_BLOCK_COMMAND) { + return FALSE; + } + + additionalLength = sizeof(SCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND) - RTL_SIZEOF_THROUGH_FIELD(SCSI_SENSE_DESCRIPTOR_BLOCK_COMMAND, Header); + + if (descriptor->Header.AdditionalLength != additionalLength) { + return FALSE; + } + + return TRUE; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiConvertToFixedSenseFormat( + _In_reads_bytes_(SenseInfoBufferLength) PVOID SenseInfoBuffer, + _In_ UCHAR SenseInfoBufferLength, + _Out_writes_bytes_(OutBufferLength) PVOID OutBuffer, + _In_ UCHAR OutBufferLength + ) +/*++ + +Description: + + This routine converts descriptor format sense data to fixed format sense data. + + Due to differences between two formats, the conversion is only based on Sense Key, + Additional Sense Code, and Additional Sense Code Qualififer. + +Arguments: + + SenseInfoBuffer + - A pointer to sense data buffer + + SenseInfoBufferLength + - Size of the buffer SenseInfoBuffer points to. + + OutBuffer + - On output, OutBuffer contains the fixed sense data as result of conversion. + + OutBufferLength + - Size of the buffer that OutBuffer points to. + +Returns: + + TRUE if conversion to Fixed format is successful. + + Otherwise, FALSE. + +--*/ +{ + BOOLEAN succeed = FALSE; + BOOLEAN validSense = FALSE; + UCHAR senseKey = 0; + UCHAR additionalSenseCode = 0; + UCHAR additionalSenseCodeQualifier = 0; + PFIXED_SENSE_DATA outBuffer = (PFIXED_SENSE_DATA)OutBuffer; + + if (SenseInfoBuffer == NULL || + SenseInfoBufferLength == 0 || + OutBuffer == NULL || + OutBufferLength < sizeof(FIXED_SENSE_DATA)) { + return FALSE; + } + + if (IsDescriptorSenseDataFormat(SenseInfoBuffer)) { + + RtlZeroMemory(OutBuffer, OutBufferLength); + + validSense = ScsiGetSenseKeyAndCodes(SenseInfoBuffer, + SenseInfoBufferLength, + SCSI_SENSE_OPTIONS_NONE, + &senseKey, + &additionalSenseCode, + &additionalSenseCodeQualifier); + if (validSense) { + + if (IsSenseDataCurrentError(SenseInfoBuffer)) { + outBuffer->ErrorCode = SCSI_SENSE_ERRORCODE_FIXED_CURRENT; + } else { + outBuffer->ErrorCode = SCSI_SENSE_ERRORCODE_FIXED_DEFERRED; + } + outBuffer->AdditionalSenseLength = sizeof(FIXED_SENSE_DATA) - RTL_SIZEOF_THROUGH_FIELD(FIXED_SENSE_DATA, AdditionalSenseLength); + outBuffer->SenseKey = senseKey; + outBuffer->AdditionalSenseCode = additionalSenseCode; + outBuffer->AdditionalSenseCodeQualifier = additionalSenseCodeQualifier; + + succeed = TRUE; + } + } + + return succeed; +} + +_Success_(return != FALSE) +FORCEINLINE BOOLEAN +ScsiGetNextSenseDescriptorByType ( + _In_reads_bytes_(BufferLength) PVOID Buffer, + _In_ UCHAR BufferLength, + _In_reads_(TypeListCount) PUCHAR TypeList, + _In_ ULONG TypeListCount, + _Out_ PUCHAR OutType, + _Outptr_result_bytebuffer_(*OutBufferLength) PVOID *OutBuffer, + _Out_ UCHAR *OutBufferLength +) +/*++ + +Description: + + This routine locates the next descriptor with type equals to one of the + types specified by caller. + +Arguments: + + Buffer - pointer to buffer to be searched. + + BufferLength - Size of the buffer that Buffer points to. + + TypeList - Pointer to array of descriptor types to be searched + + TypeListCount - Number of element in TypeList array + + OutType - Upon return, if a descriptor is found, + it contains the type of the descriptor. + + OutBuffer - Upon return, if a descriptor is found, + it points to start address of the descriptor buffer + + OutBufferLength - Upon return, if a descriptor is found, + it contains the number of bytes available starting at + OutBuffer. i.e. This is the buffer available between + OutBuffer pointer and end of Buffer. + +Returns: + + TRUE if descriptor of specified type is found. + + Otherwise, FALSE. + +--*/ +{ + PUCHAR remainingBuffer; + UCHAR remainingBufferLength; + UCHAR type; + ULONG i; + UCHAR descriptorLength; + + if (Buffer == NULL || + BufferLength == 0 || + TypeList == NULL || + TypeListCount == 0 || + OutType == NULL || + OutBuffer == NULL || + OutBufferLength == NULL) { + + return FALSE; + } + + *OutBuffer = NULL; + *OutBufferLength = 0; + *OutType = 0; + + remainingBuffer = (PUCHAR)Buffer; + remainingBufferLength = BufferLength; + + while (remainingBufferLength >= sizeof(SCSI_SENSE_DESCRIPTOR_HEADER)) { + + for (i = 0; i < TypeListCount; i++) { + + type = TypeList[i]; + + if (((PSCSI_SENSE_DESCRIPTOR_HEADER)remainingBuffer)->DescriptorType == type) { + *OutBuffer = (PVOID)remainingBuffer; + *OutBufferLength = remainingBufferLength; + *OutType = type; + return TRUE; + } + } + + descriptorLength = ScsiGetSenseDescriptorLength(remainingBuffer); + + if (remainingBufferLength > descriptorLength) { + + // Advance to start address of next descriptor + remainingBuffer += descriptorLength; + remainingBufferLength -= descriptorLength; + + } else { + + // Search is completed. + break; + } + + } + + return FALSE; +} + +// +// [END] Collections of SCSI utiltiy functions +// + +// end_storport end_privstorport + +// end_ntminitape + +#pragma pack(pop, _scsi_) // restore original packing level + +#pragma warning(pop) // un-sets any local warning changes + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_STORAGE) */ +#pragma endregion + +#endif // !defined _NTSCSI_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsiscan.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsiscan.h new file mode 100644 index 0000000000000000000000000000000000000000..3688522ebb3a72e1040c9fea0ae2a71ef3ac700a --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/scsiscan.h @@ -0,0 +1,120 @@ +/**************************************************************************** +* +* (C) COPYRIGHT 1996-2000, MICROSOFT CORP. +* +* FILE: scsiscan.h +* +* VERSION: 1.0 +* +* DATE: 2/11/1997 +* +* DESCRIPTION: +* IOCTL definitions for the SCSI scanner device driver. +* +*****************************************************************************/ + +// +// Turns off [] +// +#pragma warning(disable : 4200) + +#ifndef _SCSISCAN_H_ +#define _SCSISCAN_H_ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +// SCSISCAN_CMD.SrbFlags + +#define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008 +#define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020 +#define SRB_FLAGS_DATA_IN 0x00000040 +#define SRB_FLAGS_DATA_OUT 0x00000080 +#define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000 + +// SCSISCAN_CMD.SrbStatus definitions + +#define SRB_STATUS_PENDING 0x00 +#define SRB_STATUS_SUCCESS 0x01 +#define SRB_STATUS_ABORTED 0x02 +#define SRB_STATUS_ABORT_FAILED 0x03 +#define SRB_STATUS_ERROR 0x04 +#define SRB_STATUS_BUSY 0x05 +#define SRB_STATUS_INVALID_REQUEST 0x06 +#define SRB_STATUS_INVALID_PATH_ID 0x07 +#define SRB_STATUS_NO_DEVICE 0x08 +#define SRB_STATUS_TIMEOUT 0x09 +#define SRB_STATUS_SELECTION_TIMEOUT 0x0A +#define SRB_STATUS_COMMAND_TIMEOUT 0x0B +#define SRB_STATUS_MESSAGE_REJECTED 0x0D +#define SRB_STATUS_BUS_RESET 0x0E +#define SRB_STATUS_PARITY_ERROR 0x0F +#define SRB_STATUS_REQUEST_SENSE_FAILED 0x10 +#define SRB_STATUS_NO_HBA 0x11 +#define SRB_STATUS_DATA_OVERRUN 0x12 +#define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13 +#define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14 +#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15 +#define SRB_STATUS_REQUEST_FLUSHED 0x16 +#define SRB_STATUS_INVALID_LUN 0x20 +#define SRB_STATUS_INVALID_TARGET_ID 0x21 +#define SRB_STATUS_BAD_FUNCTION 0x22 +#define SRB_STATUS_ERROR_RECOVERY 0x23 + +#define SRB_STATUS_QUEUE_FROZEN 0x40 +#define SRB_STATUS_AUTOSENSE_VALID 0x80 + +#define SRB_STATUS(Status) (Status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN)) + +typedef struct _SCSISCAN_CMD { + ULONG Reserved1; + ULONG Size; + ULONG SrbFlags; + UCHAR CdbLength; + UCHAR SenseLength; + UCHAR Reserved2; + UCHAR Reserved3; + ULONG TransferLength; + UCHAR Cdb[16]; + PUCHAR pSrbStatus; + PUCHAR pSenseBuffer; +} SCSISCAN_CMD, *PSCSISCAN_CMD; + +// Temporarily set to 128. Should be determined by other definition. +#define MAX_STRING 128 + +typedef struct _SCSISCAN_INFO{ + ULONG Size; + ULONG Flags; + UCHAR PortNumber; + UCHAR PathId; + UCHAR TargetId; + UCHAR Lun; + UCHAR AdapterName[MAX_STRING]; + ULONG Reserved; +} SCSISCAN_INFO, *PSCSISCAN_INFO; + +#define SCSISCAN_RESERVED 0x000 +#define SCSISCAN_CMD_CODE 0x004 +#define SCSISCAN_LOCKDEVICE 0x005 +#define SCSISCAN_UNLOCKDEVICE 0x006 +#define SCSISCAN_SET_TIMEOUT 0x007 +#define SCSISCAN_GET_INFO 0x008 + +//--------------------------------------------------------------------------- +// IOCTL definitions. +// Use these definitions when calling DeviceIoControl +//--------------------------------------------------------------------------- +#define IOCTL_SCSISCAN_CMD CTL_CODE(FILE_DEVICE_SCANNER, SCSISCAN_CMD_CODE, METHOD_OUT_DIRECT, FILE_ANY_ACCESS) +#define IOCTL_SCSISCAN_LOCKDEVICE CTL_CODE(FILE_DEVICE_SCANNER, SCSISCAN_LOCKDEVICE, METHOD_OUT_DIRECT, FILE_ANY_ACCESS) +#define IOCTL_SCSISCAN_UNLOCKDEVICE CTL_CODE(FILE_DEVICE_SCANNER, SCSISCAN_UNLOCKDEVICE, METHOD_OUT_DIRECT, FILE_ANY_ACCESS) +#define IOCTL_SCSISCAN_SET_TIMEOUT CTL_CODE(FILE_DEVICE_SCANNER, SCSISCAN_SET_TIMEOUT, METHOD_BUFFERED, FILE_ANY_ACCESS) +#define IOCTL_SCSISCAN_GET_INFO CTL_CODE(FILE_DEVICE_SCANNER, SCSISCAN_GET_INFO , METHOD_OUT_DIRECT, FILE_ANY_ACCESS) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sddl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sddl.h new file mode 100644 index 0000000000000000000000000000000000000000..ac2b84be566384493715d762b67ac6aba9c8efb9 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sddl.h @@ -0,0 +1,376 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + sddl.w + +Abstract: + + This module defines the support and conversions routines necessary for SDDL. + +Revision History: + +--*/ + +#ifdef _MSC_VER +#pragma once +#endif // _MSC_VER + +#ifndef __SDDL_H__ +#define __SDDL_H__ + +#include +#include + +#ifdef _CONTRACT_GEN +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Application Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) + +// +// SDDL Version information +// +#define SDDL_REVISION_1 1 +#define SDDL_REVISION SDDL_REVISION_1 + +// +// SDDL Component tags +// +#define SDDL_OWNER TEXT("O") // Owner tag +#define SDDL_GROUP TEXT("G") // Group tag +#define SDDL_DACL TEXT("D") // DACL tag +#define SDDL_SACL TEXT("S") // SACL tag + +// +// SDDL Security descriptor controls +// +#define SDDL_PROTECTED TEXT("P") // DACL or SACL Protected +#define SDDL_AUTO_INHERIT_REQ TEXT("AR") // Auto inherit request +#define SDDL_AUTO_INHERITED TEXT("AI") // DACL/SACL are auto inherited +#define SDDL_NULL_ACL TEXT("NO_ACCESS_CONTROL") // Null ACL + +// +// SDDL Ace types +// +#define SDDL_ACCESS_ALLOWED TEXT("A") // Access allowed +#define SDDL_ACCESS_DENIED TEXT("D") // Access denied +#define SDDL_OBJECT_ACCESS_ALLOWED TEXT("OA") // Object access allowed +#define SDDL_OBJECT_ACCESS_DENIED TEXT("OD") // Object access denied +#define SDDL_AUDIT TEXT("AU") // Audit +#define SDDL_ALARM TEXT("AL") // Alarm +#define SDDL_OBJECT_AUDIT TEXT("OU") // Object audit +#define SDDL_OBJECT_ALARM TEXT("OL") // Object alarm +#define SDDL_MANDATORY_LABEL TEXT("ML") // Integrity label +#define SDDL_PROCESS_TRUST_LABEL TEXT("TL") // Process trust label +#define SDDL_CALLBACK_ACCESS_ALLOWED TEXT("XA") // Callback access allowed +#define SDDL_CALLBACK_ACCESS_DENIED TEXT("XD") // Callback access denied +#define SDDL_RESOURCE_ATTRIBUTE TEXT("RA") // Resource attribute +#define SDDL_SCOPED_POLICY_ID TEXT("SP") // Scoped policy +#define SDDL_CALLBACK_AUDIT TEXT("XU") // Callback audit +#define SDDL_CALLBACK_OBJECT_ACCESS_ALLOWED TEXT("ZA") // Callback object access allowed +#define SDDL_ACCESS_FILTER TEXT("FL") // Access Filter + +// +// SDDL Resource attribute ace data types +// + +#define SDDL_INT TEXT("TI") // Signed integer +#define SDDL_UINT TEXT("TU") // Unsigned integer +#define SDDL_WSTRING TEXT("TS") // Wide string +#define SDDL_SID TEXT("TD") // SID +#define SDDL_BLOB TEXT("TX") // Octet String +#define SDDL_BOOLEAN TEXT("TB") // Boolean + +// +// SDDL Ace flags +// +#define SDDL_CONTAINER_INHERIT TEXT("CI") // Container inherit +#define SDDL_OBJECT_INHERIT TEXT("OI") // Object inherit +#define SDDL_NO_PROPAGATE TEXT("NP") // Inherit no propagate +#define SDDL_INHERIT_ONLY TEXT("IO") // Inherit only +#define SDDL_INHERITED TEXT("ID") // Inherited +#define SDDL_CRITICAL TEXT("CR") // Critical +#define SDDL_TRUST_PROTECTED_FILTER TEXT("TP") // Trust Protected Filter +#define SDDL_AUDIT_SUCCESS TEXT("SA") // Audit success +#define SDDL_AUDIT_FAILURE TEXT("FA") // Audit failure + +// +// SDDL Rights +// +#define SDDL_READ_PROPERTY TEXT("RP") +#define SDDL_WRITE_PROPERTY TEXT("WP") +#define SDDL_CREATE_CHILD TEXT("CC") +#define SDDL_DELETE_CHILD TEXT("DC") +#define SDDL_LIST_CHILDREN TEXT("LC") +#define SDDL_SELF_WRITE TEXT("SW") +#define SDDL_LIST_OBJECT TEXT("LO") +#define SDDL_DELETE_TREE TEXT("DT") +#define SDDL_CONTROL_ACCESS TEXT("CR") +#define SDDL_READ_CONTROL TEXT("RC") +#define SDDL_WRITE_DAC TEXT("WD") +#define SDDL_WRITE_OWNER TEXT("WO") +#define SDDL_STANDARD_DELETE TEXT("SD") +#define SDDL_GENERIC_ALL TEXT("GA") +#define SDDL_GENERIC_READ TEXT("GR") +#define SDDL_GENERIC_WRITE TEXT("GW") +#define SDDL_GENERIC_EXECUTE TEXT("GX") +#define SDDL_FILE_ALL TEXT("FA") +#define SDDL_FILE_READ TEXT("FR") +#define SDDL_FILE_WRITE TEXT("FW") +#define SDDL_FILE_EXECUTE TEXT("FX") +#define SDDL_KEY_ALL TEXT("KA") +#define SDDL_KEY_READ TEXT("KR") +#define SDDL_KEY_WRITE TEXT("KW") +#define SDDL_KEY_EXECUTE TEXT("KX") +#define SDDL_NO_WRITE_UP TEXT("NW") +#define SDDL_NO_READ_UP TEXT("NR") +#define SDDL_NO_EXECUTE_UP TEXT("NX") + +// +// SDDL User alias max size +// - currently, upto two supported eg. "DA" +// - modify this if more WCHARs need to be there in future e.g. "DAX" +// + +#define SDDL_ALIAS_SIZE 2 + +// +// SDDL User aliases +// +#define SDDL_DOMAIN_ADMINISTRATORS TEXT("DA") // Domain admins +#define SDDL_DOMAIN_GUESTS TEXT("DG") // Domain guests +#define SDDL_DOMAIN_USERS TEXT("DU") // Domain users +#define SDDL_ENTERPRISE_DOMAIN_CONTROLLERS TEXT("ED") // Enterprise domain controllers +#define SDDL_DOMAIN_DOMAIN_CONTROLLERS TEXT("DD") // Domain domain controllers +#define SDDL_DOMAIN_COMPUTERS TEXT("DC") // Domain computers +#define SDDL_BUILTIN_ADMINISTRATORS TEXT("BA") // Builtin (local ) administrators +#define SDDL_BUILTIN_GUESTS TEXT("BG") // Builtin (local ) guests +#define SDDL_BUILTIN_USERS TEXT("BU") // Builtin (local ) users +#define SDDL_LOCAL_ADMIN TEXT("LA") // Local administrator account +#define SDDL_LOCAL_GUEST TEXT("LG") // Local group account +#define SDDL_ACCOUNT_OPERATORS TEXT("AO") // Account operators +#define SDDL_BACKUP_OPERATORS TEXT("BO") // Backup operators +#define SDDL_PRINTER_OPERATORS TEXT("PO") // Printer operators +#define SDDL_SERVER_OPERATORS TEXT("SO") // Server operators +#define SDDL_AUTHENTICATED_USERS TEXT("AU") // Authenticated users +#define SDDL_PERSONAL_SELF TEXT("PS") // Personal self +#define SDDL_CREATOR_OWNER TEXT("CO") // Creator owner +#define SDDL_CREATOR_GROUP TEXT("CG") // Creator group +#define SDDL_LOCAL_SYSTEM TEXT("SY") // Local system +#define SDDL_POWER_USERS TEXT("PU") // Power users +#define SDDL_EVERYONE TEXT("WD") // Everyone ( World ) +#define SDDL_REPLICATOR TEXT("RE") // Replicator +#define SDDL_INTERACTIVE TEXT("IU") // Interactive logon user +#define SDDL_NETWORK TEXT("NU") // Nework logon user +#define SDDL_SERVICE TEXT("SU") // Service logon user +#define SDDL_RESTRICTED_CODE TEXT("RC") // Restricted code +#define SDDL_WRITE_RESTRICTED_CODE TEXT("WR") // Write Restricted code +#define SDDL_ANONYMOUS TEXT("AN") // Anonymous Logon +#define SDDL_SCHEMA_ADMINISTRATORS TEXT("SA") // Schema Administrators +#define SDDL_CERT_SERV_ADMINISTRATORS TEXT("CA") // Certificate Server Administrators +#define SDDL_RAS_SERVERS TEXT("RS") // RAS servers group +#define SDDL_ENTERPRISE_ADMINS TEXT("EA") // Enterprise administrators +#define SDDL_GROUP_POLICY_ADMINS TEXT("PA") // Group Policy administrators +#define SDDL_ALIAS_PREW2KCOMPACC TEXT("RU") // alias to allow previous windows 2000 +#define SDDL_LOCAL_SERVICE TEXT("LS") // Local service account (for services) +#define SDDL_NETWORK_SERVICE TEXT("NS") // Network service account (for services) +#define SDDL_REMOTE_DESKTOP TEXT("RD") // Remote desktop users (for terminal server) +#define SDDL_NETWORK_CONFIGURATION_OPS TEXT("NO") // Network configuration operators ( to manage configuration of networking features) +#define SDDL_PERFMON_USERS TEXT("MU") // Performance Monitor Users +#define SDDL_PERFLOG_USERS TEXT("LU") // Performance Log Users +#define SDDL_IIS_USERS TEXT("IS") // Anonymous Internet Users +#define SDDL_CRYPTO_OPERATORS TEXT("CY") // Crypto Operators +#define SDDL_OWNER_RIGHTS TEXT("OW") // Owner Rights SID +#define SDDL_EVENT_LOG_READERS TEXT("ER") // Event log readers +#define SDDL_ENTERPRISE_RO_DCs TEXT("RO") // Enterprise Read-only domain controllers +#define SDDL_CERTSVC_DCOM_ACCESS TEXT("CD") // Users who can connect to certification authorities using DCOM +#define SDDL_ALL_APP_PACKAGES TEXT("AC") // All applications running in an app package context +#define SDDL_RDS_REMOTE_ACCESS_SERVERS TEXT("RA") // Servers in this group enable users of RemoteApp programs and personal virtual desktops access to these resources. +#define SDDL_RDS_ENDPOINT_SERVERS TEXT("ES") // Servers in this group run virtual machines and host sessions where users RemoteApp programs and personal virtual desktops run. +#define SDDL_RDS_MANAGEMENT_SERVERS TEXT("MS") // Servers in this group can perform routine administrative actions on servers running Remote Desktop Services. +#define SDDL_USER_MODE_DRIVERS TEXT("UD") // UserMode driver +#define SDDL_HYPER_V_ADMINS TEXT("HA") // Members of this group have complete and unrestricted access to all features of Hyper-V. +#define SDDL_CLONEABLE_CONTROLLERS TEXT("CN") // Members of this group that are domain controllers may be cloned. +#define SDDL_ACCESS_CONTROL_ASSISTANCE_OPS TEXT("AA") // Members of this group can remotely query authorization attributes and permissions for resources on this computer. +#define SDDL_REMOTE_MANAGEMENT_USERS TEXT("RM") // Members of this group can access WMI resources over management protocols (such as WS-Management via the Windows Remote Management service). This applies only to WMI namespaces that grant access to the user. +#define SDDL_AUTHORITY_ASSERTED TEXT("AS") // Authentication Authority Asserted +#define SDDL_SERVICE_ASSERTED TEXT("SS") // Authentication Service Asserted +#define SDDL_PROTECTED_USERS TEXT("AP") // Members of this group are afforded additional protections against authentication security threats. +#define SDDL_KEY_ADMINS TEXT("KA") // Members of this group have full control over all key credential objects in the domain +#define SDDL_ENTERPRISE_KEY_ADMINS TEXT("EK") // Members of this group have full control over all key credential objects in the forest +#define SDDL_USER_MODE_HARDWARE_OPERATORS TEXT("HO") // Members of this group may operate hardware from user mode +#define SDDL_OPENSSH_USERS TEXT("SH") // Members of this group may connect to this computer using SSH + +// +// Note !! While making the above changes check if ScepReplaceNewAcronymsInSDDL +// needs to be updated to allow the new SIDs to be translated on downlevel OS. +// + +// +// Integrity Labels +// +#define SDDL_ML_LOW TEXT("LW") // Low mandatory level +#define SDDL_ML_MEDIUM TEXT("ME") // Medium mandatory level +#define SDDL_ML_MEDIUM_PLUS TEXT("MP") // Medium Plus mandatory level +#define SDDL_ML_HIGH TEXT("HI") // High mandatory level +#define SDDL_ML_SYSTEM TEXT("SI") // System mandatory level + +// +// SDDL Seperators - character version +// +#define SDDL_SEPERATORC TEXT(';') +#define SDDL_DELIMINATORC TEXT(':') +#define SDDL_ACE_BEGINC TEXT('(') +#define SDDL_ACE_ENDC TEXT(')') +#define SDDL_SPACEC TEXT(' ') +#define SDDL_ACE_COND_BEGINC TEXT('(') +#define SDDL_ACE_COND_ENDC TEXT(')') +#define SDDL_ACE_COND_STRING_BEGINC TEXT('"') +#define SDDL_ACE_COND_STRING_ENDC TEXT('"') +#define SDDL_ACE_COND_COMPOSITEVALUE_BEGINC TEXT('{') +#define SDDL_ACE_COND_COMPOSITEVALUE_ENDC TEXT('}') +#define SDDL_ACE_COND_COMPOSITEVALUE_SEPERATORC TEXT(',') +#define SDDL_ACE_COND_BLOB_PREFIXC TEXT('#') +#define SDDL_ACE_COND_SID_BEGINC TEXT('(') +#define SDDL_ACE_COND_SID_ENDC TEXT(')') + +// +// SDDL Seperators - string version +// +#define SDDL_SEPERATOR TEXT(";") +#define SDDL_DELIMINATOR TEXT(":") +#define SDDL_ACE_BEGIN TEXT("(") +#define SDDL_ACE_END TEXT(")") +#define SDDL_ACE_COND_BEGIN TEXT("(") +#define SDDL_ACE_COND_END TEXT(")") +#define SDDL_SPACE TEXT(" ") +#define SDDL_ACE_COND_BLOB_PREFIX TEXT("#") +#define SDDL_ACE_COND_SID_PREFIX TEXT("SID") +#define SDDL_ACE_COND_ATTRIBUTE_PREFIX TEXT("@") +#define SDDL_ACE_COND_USER_ATTRIBUTE_PREFIX TEXT("@USER.") +#define SDDL_ACE_COND_RESOURCE_ATTRIBUTE_PREFIX TEXT("@RESOURCE.") +#define SDDL_ACE_COND_DEVICE_ATTRIBUTE_PREFIX TEXT("@DEVICE.") +#define SDDL_ACE_COND_TOKEN_ATTRIBUTE_PREFIX TEXT("@TOKEN.") + +#if !defined(_NTDDK_) + +#if (_WIN32_WINNT >= 0x0500) +_Success_(return != FALSE) +BOOL +WINAPI +ConvertSidToStringSidA( + _In_ PSID Sid, + _Outptr_ LPSTR *StringSid + ); + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertSidToStringSidW( + _In_ PSID Sid, + _Outptr_ LPWSTR* StringSid + ); + +#ifdef UNICODE +#define ConvertSidToStringSid ConvertSidToStringSidW +#else +#define ConvertSidToStringSid ConvertSidToStringSidA +#endif // !UNICODE + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertStringSidToSidA( + _In_ LPCSTR StringSid, + _Outptr_ PSID *Sid + ); + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertStringSidToSidW( + _In_ LPCWSTR StringSid, + _Outptr_ PSID* Sid + ); + +#ifdef UNICODE +#define ConvertStringSidToSid ConvertStringSidToSidW +#else +#define ConvertStringSidToSid ConvertStringSidToSidA +#endif // !UNICODE + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertStringSecurityDescriptorToSecurityDescriptorA( + _In_ LPCSTR StringSecurityDescriptor, + _In_ DWORD StringSDRevision, + _Outptr_ PSECURITY_DESCRIPTOR *SecurityDescriptor, + _Out_opt_ PULONG SecurityDescriptorSize + ); + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertStringSecurityDescriptorToSecurityDescriptorW( + _In_ LPCWSTR StringSecurityDescriptor, + _In_ DWORD StringSDRevision, + _Outptr_ PSECURITY_DESCRIPTOR* SecurityDescriptor, + _Out_opt_ PULONG SecurityDescriptorSize + ); + +#ifdef UNICODE +#define ConvertStringSecurityDescriptorToSecurityDescriptor ConvertStringSecurityDescriptorToSecurityDescriptorW +#else +#define ConvertStringSecurityDescriptorToSecurityDescriptor ConvertStringSecurityDescriptorToSecurityDescriptorA +#endif // !UNICODE + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertSecurityDescriptorToStringSecurityDescriptorA( + _In_ PSECURITY_DESCRIPTOR SecurityDescriptor, + _In_ DWORD RequestedStringSDRevision, + _In_ SECURITY_INFORMATION SecurityInformation, + _Outptr_ LPSTR *StringSecurityDescriptor, + _Out_opt_ PULONG StringSecurityDescriptorLen + ); + +_Success_(return != FALSE) +BOOL +WINAPI +ConvertSecurityDescriptorToStringSecurityDescriptorW( + _In_ PSECURITY_DESCRIPTOR SecurityDescriptor, + _In_ DWORD RequestedStringSDRevision, + _In_ SECURITY_INFORMATION SecurityInformation, + _Outptr_ LPWSTR* StringSecurityDescriptor, + _Out_opt_ PULONG StringSecurityDescriptorLen + ); + +#ifdef UNICODE +#define ConvertSecurityDescriptorToStringSecurityDescriptor ConvertSecurityDescriptorToStringSecurityDescriptorW +#else +#define ConvertSecurityDescriptorToStringSecurityDescriptor ConvertSecurityDescriptorToStringSecurityDescriptorA +#endif // !UNICODE + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) +#pragma endregion + +#endif /* _WIN32_WINNT >= 0x0500 */ + +#endif /* !defined(_NTDDK_) */ + +#ifdef __cplusplus +} +#endif + +#endif // endif __SDDL_H__ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdkddkver.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdkddkver.h new file mode 100644 index 0000000000000000000000000000000000000000..20a29c3e51a9bac4ca19e505b15a3e2c7fd781b5 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdkddkver.h @@ -0,0 +1,320 @@ +/* + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + sdkddkver.h + +Abstract: + + Master include file for versioning windows SDK/DDK. + +*/ + +#ifndef _INC_SDKDDKVER +#define _INC_SDKDDKVER + +#if (_MSC_VER >= 800) +#if (_MSC_VER >= 1200) +#pragma warning(push) +#pragma warning(disable:4668) /* #if not_defined treated as #if 0 */ +#endif +#pragma warning(disable:4001) /* nonstandard extension : single line comment */ +#endif + +#pragma once + +// +// _WIN32_WINNT version constants +// +#define _WIN32_WINNT_NT4 0x0400 +#define _WIN32_WINNT_WIN2K 0x0500 +#define _WIN32_WINNT_WINXP 0x0501 +#define _WIN32_WINNT_WS03 0x0502 +#define _WIN32_WINNT_WIN6 0x0600 +#define _WIN32_WINNT_VISTA 0x0600 +#define _WIN32_WINNT_WS08 0x0600 +#define _WIN32_WINNT_LONGHORN 0x0600 +#define _WIN32_WINNT_WIN7 0x0601 +#define _WIN32_WINNT_WIN8 0x0602 +#define _WIN32_WINNT_WINBLUE 0x0603 +#define _WIN32_WINNT_WINTHRESHOLD 0x0A00 +#define _WIN32_WINNT_WIN10 0x0A00 + +// +// _WIN32_IE_ version constants +// +#define _WIN32_IE_IE20 0x0200 +#define _WIN32_IE_IE30 0x0300 +#define _WIN32_IE_IE302 0x0302 +#define _WIN32_IE_IE40 0x0400 +#define _WIN32_IE_IE401 0x0401 +#define _WIN32_IE_IE50 0x0500 +#define _WIN32_IE_IE501 0x0501 +#define _WIN32_IE_IE55 0x0550 +#define _WIN32_IE_IE60 0x0600 +#define _WIN32_IE_IE60SP1 0x0601 +#define _WIN32_IE_IE60SP2 0x0603 +#define _WIN32_IE_IE70 0x0700 +#define _WIN32_IE_IE80 0x0800 +#define _WIN32_IE_IE90 0x0900 +#define _WIN32_IE_IE100 0x0A00 +#define _WIN32_IE_IE110 0x0A00 + +// +// IE <-> OS version mapping +// +// NT4 supports IE versions 2.0 -> 6.0 SP1 +#define _WIN32_IE_NT4 _WIN32_IE_IE20 +#define _WIN32_IE_NT4SP1 _WIN32_IE_IE20 +#define _WIN32_IE_NT4SP2 _WIN32_IE_IE20 +#define _WIN32_IE_NT4SP3 _WIN32_IE_IE302 +#define _WIN32_IE_NT4SP4 _WIN32_IE_IE401 +#define _WIN32_IE_NT4SP5 _WIN32_IE_IE401 +#define _WIN32_IE_NT4SP6 _WIN32_IE_IE50 +// Win98 supports IE versions 4.01 -> 6.0 SP1 +#define _WIN32_IE_WIN98 _WIN32_IE_IE401 +// Win98SE supports IE versions 5.0 -> 6.0 SP1 +#define _WIN32_IE_WIN98SE _WIN32_IE_IE50 +// WinME supports IE versions 5.5 -> 6.0 SP1 +#define _WIN32_IE_WINME _WIN32_IE_IE55 +// Win2k supports IE versions 5.01 -> 6.0 SP1 +#define _WIN32_IE_WIN2K _WIN32_IE_IE501 +#define _WIN32_IE_WIN2KSP1 _WIN32_IE_IE501 +#define _WIN32_IE_WIN2KSP2 _WIN32_IE_IE501 +#define _WIN32_IE_WIN2KSP3 _WIN32_IE_IE501 +#define _WIN32_IE_WIN2KSP4 _WIN32_IE_IE501 +#define _WIN32_IE_XP _WIN32_IE_IE60 +#define _WIN32_IE_XPSP1 _WIN32_IE_IE60SP1 +#define _WIN32_IE_XPSP2 _WIN32_IE_IE60SP2 +#define _WIN32_IE_WS03 0x0602 +#define _WIN32_IE_WS03SP1 _WIN32_IE_IE60SP2 +#define _WIN32_IE_WIN6 _WIN32_IE_IE70 +#define _WIN32_IE_LONGHORN _WIN32_IE_IE70 +#define _WIN32_IE_WIN7 _WIN32_IE_IE80 +#define _WIN32_IE_WIN8 _WIN32_IE_IE100 +#define _WIN32_IE_WINBLUE _WIN32_IE_IE100 +#define _WIN32_IE_WINTHRESHOLD _WIN32_IE_IE110 +#define _WIN32_IE_WIN10 _WIN32_IE_IE110 + + +// +// NTDDI version constants +// +#define NTDDI_WIN4 0x04000000 + +#define NTDDI_WIN2K 0x05000000 +#define NTDDI_WIN2KSP1 0x05000100 +#define NTDDI_WIN2KSP2 0x05000200 +#define NTDDI_WIN2KSP3 0x05000300 +#define NTDDI_WIN2KSP4 0x05000400 + +#define NTDDI_WINXP 0x05010000 +#define NTDDI_WINXPSP1 0x05010100 +#define NTDDI_WINXPSP2 0x05010200 +#define NTDDI_WINXPSP3 0x05010300 +#define NTDDI_WINXPSP4 0x05010400 + +#define NTDDI_WS03 0x05020000 +#define NTDDI_WS03SP1 0x05020100 +#define NTDDI_WS03SP2 0x05020200 +#define NTDDI_WS03SP3 0x05020300 +#define NTDDI_WS03SP4 0x05020400 + +#define NTDDI_WIN6 0x06000000 +#define NTDDI_WIN6SP1 0x06000100 +#define NTDDI_WIN6SP2 0x06000200 +#define NTDDI_WIN6SP3 0x06000300 +#define NTDDI_WIN6SP4 0x06000400 + +#define NTDDI_VISTA NTDDI_WIN6 +#define NTDDI_VISTASP1 NTDDI_WIN6SP1 +#define NTDDI_VISTASP2 NTDDI_WIN6SP2 +#define NTDDI_VISTASP3 NTDDI_WIN6SP3 +#define NTDDI_VISTASP4 NTDDI_WIN6SP4 + +#define NTDDI_LONGHORN NTDDI_VISTA + +#define NTDDI_WS08 NTDDI_WIN6SP1 +#define NTDDI_WS08SP2 NTDDI_WIN6SP2 +#define NTDDI_WS08SP3 NTDDI_WIN6SP3 +#define NTDDI_WS08SP4 NTDDI_WIN6SP4 + +#define NTDDI_WIN7 0x06010000 +#define NTDDI_WIN8 0x06020000 +#define NTDDI_WINBLUE 0x06030000 +#define NTDDI_WINTHRESHOLD 0x0A000000 +#define NTDDI_WIN10 0x0A000000 +#define NTDDI_WIN10_TH2 0x0A000001 +#define NTDDI_WIN10_RS1 0x0A000002 +#define NTDDI_WIN10_RS2 0x0A000003 +#define NTDDI_WIN10_RS3 0x0A000004 +#define NTDDI_WIN10_RS4 0x0A000005 +#define NTDDI_WIN10_RS5 0x0A000006 +#define NTDDI_WIN10_19H1 0x0A000007 +#define NTDDI_WIN10_VB 0x0A000008 +#define NTDDI_WIN10_MN 0x0A000009 +#define NTDDI_WIN10_FE 0x0A00000A +#define NTDDI_WIN10_CO 0x0A00000B +#define NTDDI_WIN10_NI 0x0A00000C +#define NTDDI_WIN10_CU 0x0A00000D +#define NTDDI_WIN11_ZN 0x0A00000E +#define NTDDI_WIN11_GA 0x0A00000F +#define NTDDI_WIN11_GE 0x0A000010 + +#define WDK_NTDDI_VERSION NTDDI_WIN11_GE + + +// +// masks for version macros +// +#define OSVERSION_MASK 0xFFFF0000 +#define SPVERSION_MASK 0x0000FF00 +#define SUBVERSION_MASK 0x000000FF + + +// +// macros to extract various version fields from the NTDDI version +// +#define OSVER(Version) ((Version) & OSVERSION_MASK) +#define SPVER(Version) (((Version) & SPVERSION_MASK) >> 8) +#define SUBVER(Version) (((Version) & SUBVERSION_MASK) ) + + +#if defined(DECLSPEC_DEPRECATED_DDK) + +// deprecate in 2k or later +#if (NTDDI_VERSION >= NTDDI_WIN2K) +#define DECLSPEC_DEPRECATED_DDK_WIN2K DECLSPEC_DEPRECATED_DDK +#else +#define DECLSPEC_DEPRECATED_DDK_WIN2K +#endif + +// deprecate in XP or later +#if (NTDDI_VERSION >= NTDDI_WINXP) +#define DECLSPEC_DEPRECATED_DDK_WINXP DECLSPEC_DEPRECATED_DDK +#else +#define DECLSPEC_DEPRECATED_DDK_WINXP +#endif + +// deprecate in WS03 or later +#if (NTDDI_VERSION >= NTDDI_WS03) +#define DECLSPEC_DEPRECATED_DDK_WIN2003 DECLSPEC_DEPRECATED_DDK +#else +#define DECLSPEC_DEPRECATED_DDK_WIN2003 +#endif + +// deprecate in WIN6 or later +#if (NTDDI_VERSION >= NTDDI_WIN6) +#define DECLSPEC_DEPRECATED_DDK_WIN6 DECLSPEC_DEPRECATED_DDK +#else +#define DECLSPEC_DEPRECATED_DDK_WIN6 +#endif + +#define DECLSPEC_DEPRECATED_DDK_LONGHORN DECLSPEC_DEPRECATED_DDK_WIN6 + +#endif // defined(DECLSPEC_DEPRECATED_DDK) + + +// +// if versions aren't already defined, default to most current +// + +#define NTDDI_VERSION_FROM_WIN32_WINNT2(ver) ver##0000 +#define NTDDI_VERSION_FROM_WIN32_WINNT(ver) NTDDI_VERSION_FROM_WIN32_WINNT2(ver) + +#if !defined(_WIN32_WINNT) && !defined(_CHICAGO_) +#define _WIN32_WINNT 0x0A00 +#endif + +#ifndef NTDDI_VERSION +#ifdef _WIN32_WINNT +#if (_WIN32_WINNT <= _WIN32_WINNT_WINBLUE) +// set NTDDI_VERSION based on _WIN32_WINNT +#define NTDDI_VERSION NTDDI_VERSION_FROM_WIN32_WINNT(_WIN32_WINNT) +#elif (_WIN32_WINNT >= _WIN32_WINNT_WIN10) +// set NTDDI_VERSION to default to WDK_NTDDI_VERSION +#define NTDDI_VERSION WDK_NTDDI_VERSION +#endif // (_WIN32_WINNT <= _WIN32_WINNT_WINBLUE) +#else +// set NTDDI_VERSION to default to latest if _WIN32_WINNT isn't set +#define NTDDI_VERSION 0x0A000010 +#endif // _WIN32_WINNT +#endif // NTDDI_VERSION + +#ifndef WINVER +#ifdef _WIN32_WINNT +// set WINVER based on _WIN32_WINNT +#define WINVER _WIN32_WINNT +#else +#define WINVER 0x0A00 +#endif +#endif + +#ifndef _WIN32_IE +#ifdef _WIN32_WINNT +// set _WIN32_IE based on _WIN32_WINNT +#if (_WIN32_WINNT <= _WIN32_WINNT_NT4) +#define _WIN32_IE _WIN32_IE_IE50 +#elif (_WIN32_WINNT <= _WIN32_WINNT_WIN2K) +#define _WIN32_IE _WIN32_IE_IE501 +#elif (_WIN32_WINNT <= _WIN32_WINNT_WINXP) +#define _WIN32_IE _WIN32_IE_IE60 +#elif (_WIN32_WINNT <= _WIN32_WINNT_WS03) +#define _WIN32_IE _WIN32_IE_WS03 +#elif (_WIN32_WINNT <= _WIN32_WINNT_VISTA) +#define _WIN32_IE _WIN32_IE_LONGHORN +#elif (_WIN32_WINNT <= _WIN32_WINNT_WIN7) +#define _WIN32_IE _WIN32_IE_WIN7 +#elif (_WIN32_WINNT <= _WIN32_WINNT_WIN8) +#define _WIN32_IE _WIN32_IE_WIN8 +#else +#define _WIN32_IE 0x0A00 +#endif +#else +#define _WIN32_IE 0x0A00 +#endif +#endif + +// +// Sanity check for compatible versions +// +#if defined(_WIN32_WINNT) && !defined(MIDL_PASS) && !defined(RC_INVOKED) + +#if (defined(WINVER) && (WINVER < 0x0400) && (_WIN32_WINNT > 0x0400)) +#error WINVER setting conflicts with _WIN32_WINNT setting +#endif + +#if (((OSVERSION_MASK & NTDDI_VERSION) == NTDDI_WIN2K) && (_WIN32_WINNT != _WIN32_WINNT_WIN2K)) +#error NTDDI_VERSION setting conflicts with _WIN32_WINNT setting +#endif + +#if (((OSVERSION_MASK & NTDDI_VERSION) == NTDDI_WINXP) && (_WIN32_WINNT != _WIN32_WINNT_WINXP)) +#error NTDDI_VERSION setting conflicts with _WIN32_WINNT setting +#endif + +#if (((OSVERSION_MASK & NTDDI_VERSION) == NTDDI_WS03) && (_WIN32_WINNT != _WIN32_WINNT_WS03)) +#error NTDDI_VERSION setting conflicts with _WIN32_WINNT setting +#endif + +#if (((OSVERSION_MASK & NTDDI_VERSION) == NTDDI_VISTA) && (_WIN32_WINNT != _WIN32_WINNT_VISTA)) +#error NTDDI_VERSION setting conflicts with _WIN32_WINNT setting +#endif + +#if ((_WIN32_WINNT < _WIN32_WINNT_WIN2K) && (_WIN32_IE > _WIN32_IE_IE60SP1)) +#error _WIN32_WINNT settings conflicts with _WIN32_IE setting +#endif + +#endif // defined(_WIN32_WINNT) && !defined(MIDL_PASS) && !defined(_WINRESRC_) + +#if (_MSC_VER >= 800) +#if (_MSC_VER >= 1200) +#pragma warning(pop) +#else +#pragma warning(default:4001) /* nonstandard extension : single line comment */ +#endif +#endif + +#endif /* !_INC_SDKDDKVER */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdv_driverspecs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdv_driverspecs.h new file mode 100644 index 0000000000000000000000000000000000000000..694bd08f5f9d6938775f4195522013d63143b836 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sdv_driverspecs.h @@ -0,0 +1,22 @@ +#ifndef _SDV_ +// general purpose save +//----------------------- +#define __sdv_save_request(r) +// general purpose retrieve +//----------------------- +#define __sdv_retrieve_request(r) + +// NDIS AdapterContext save +//----------------------- +#define __sdv_save_adapter_context(c) + +#else +// general purpose save +//----------------------- +//#define __sdv_save sdv_save +//void sdv_save(void *r){;} +// general purpose retrieve macros +//----------------------- +//#define __sdv_retrieve sdv_retrieve +//void sdv_retrieve(void *r){;} +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/secext.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/secext.h new file mode 100644 index 0000000000000000000000000000000000000000..8353e4cdfc97b6125e9df1a16b7e1fc6ed5e8426 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/secext.h @@ -0,0 +1,201 @@ +//+----------------------------------------------------------------------- +// +// Microsoft Windows +// +// Copyright (c) Microsoft Corporation 1991-1999 +// +// File: secext.h +// +// Contents: Security function prototypes for functions not part of +// the SSPI interface. This file should not be directly +// included - include security.h instead. +// +// +// +//------------------------------------------------------------------------ + + + +#ifndef __SECEXT_H__ +#define __SECEXT_H__ +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#ifdef __cplusplus +extern "C" { +#endif + +// +// Extended Name APIs for ADS +// + + +typedef enum +{ + // Examples for the following formats assume a fictitous company + // which hooks into the global X.500 and DNS name spaces as follows. + // + // Enterprise root domain in DNS is + // + // widget.com + // + // Enterprise root domain in X.500 (RFC 1779 format) is + // + // O=Widget, C=US + // + // There exists the child domain + // + // engineering.widget.com + // + // equivalent to + // + // OU=Engineering, O=Widget, C=US + // + // There exists a container within the Engineering domain + // + // OU=Software, OU=Engineering, O=Widget, C=US + // + // There exists the user + // + // CN=John Doe, OU=Software, OU=Engineering, O=Widget, C=US + // + // And this user's downlevel (pre-ADS) user name is + // + // Engineering\JohnDoe + + // unknown name type + NameUnknown = 0, + + // CN=John Doe, OU=Software, OU=Engineering, O=Widget, C=US + NameFullyQualifiedDN = 1, + + // Engineering\JohnDoe + NameSamCompatible = 2, + + // Probably "John Doe" but could be something else. I.e. The + // display name is not necessarily the defining RDN. + NameDisplay = 3, + + + // String-ized GUID as returned by IIDFromString(). + // eg: {4fa050f0-f561-11cf-bdd9-00aa003a77b6} + NameUniqueId = 6, + + // engineering.widget.com/software/John Doe + NameCanonical = 7, + + // someone@example.com + NameUserPrincipal = 8, + + // Same as NameCanonical except that rightmost '/' is + // replaced with '\n' - even in domain-only case. + // eg: engineering.widget.com/software\nJohn Doe + NameCanonicalEx = 9, + + // www/srv.engineering.com/engineering.com + NameServicePrincipal = 10, + + // DNS domain name + SAM username + // eg: engineering.widget.com\JohnDoe + NameDnsDomain = 12, + + NameGivenName = 13, + NameSurname = 14 +} EXTENDED_NAME_FORMAT, * PEXTENDED_NAME_FORMAT ; + + +_Success_(return != 0) +BOOLEAN +SEC_ENTRY +GetUserNameExA( + _In_ EXTENDED_NAME_FORMAT NameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPSTR lpNameBuffer, + _Inout_ PULONG nSize + ); + +_Success_(return != 0) +BOOLEAN +SEC_ENTRY +GetUserNameExW( + _In_ EXTENDED_NAME_FORMAT NameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPWSTR lpNameBuffer, + _Inout_ PULONG nSize + ); + +#ifdef UNICODE +#define GetUserNameEx GetUserNameExW +#else +#define GetUserNameEx GetUserNameExA +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +BOOLEAN +SEC_ENTRY +GetComputerObjectNameA( + _In_ EXTENDED_NAME_FORMAT NameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPSTR lpNameBuffer, + _Inout_ PULONG nSize + ); +BOOLEAN +SEC_ENTRY +GetComputerObjectNameW( + _In_ EXTENDED_NAME_FORMAT NameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPWSTR lpNameBuffer, + _Inout_ PULONG nSize + ); + +#ifdef UNICODE +#define GetComputerObjectName GetComputerObjectNameW +#else +#define GetComputerObjectName GetComputerObjectNameA +#endif + +BOOLEAN +SEC_ENTRY +TranslateNameA( + _In_ LPCSTR lpAccountName, + _In_ EXTENDED_NAME_FORMAT AccountNameFormat, + _In_ EXTENDED_NAME_FORMAT DesiredNameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPSTR lpTranslatedName, + _Inout_ PULONG nSize + ); +BOOLEAN +SEC_ENTRY +TranslateNameW( + _In_ LPCWSTR lpAccountName, + _In_ EXTENDED_NAME_FORMAT AccountNameFormat, + _In_ EXTENDED_NAME_FORMAT DesiredNameFormat, + _Out_writes_to_opt_(*nSize,*nSize) LPWSTR lpTranslatedName, + _Inout_ PULONG nSize + ); +#ifdef UNICODE +#define TranslateName TranslateNameW +#else +#define TranslateName TranslateNameA +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifdef __cplusplus +} +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // __SECEXT_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/security.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/security.h new file mode 100644 index 0000000000000000000000000000000000000000..ddd8fca2f1a5aa126a857eb64cbd2198395ac6dc --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/security.h @@ -0,0 +1,91 @@ +//+----------------------------------------------------------------------- +// +// Microsoft Windows +// +// Copyright (c) Microsoft Corporation 1991-1999 +// +// File: Security.h +// +// Contents: Toplevel include file for security aware components +// +// +// +//------------------------------------------------------------------------ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_GAMES) + + +// This file will go out and pull in all the header files that you need, +// based on defines that you issue. The following macros are used. +// +// SECURITY_KERNEL Use the kernel interface, not the usermode +// + +// +// These are name that can be used to refer to the builtin packages +// + +#ifndef NTLMSP_NAME_A +#define NTLMSP_NAME_A "NTLM" +#define NTLMSP_NAME L"NTLM" // ntifs +#endif // NTLMSP_NAME + +#ifndef MICROSOFT_KERBEROS_NAME_A +#define MICROSOFT_KERBEROS_NAME_A "Kerberos" +#define MICROSOFT_KERBEROS_NAME_W L"Kerberos" +#ifdef WIN32_CHICAGO +#define MICROSOFT_KERBEROS_NAME MICROSOFT_KERBEROS_NAME_A +#else +#define MICROSOFT_KERBEROS_NAME MICROSOFT_KERBEROS_NAME_W +#endif +#endif // MICROSOFT_KERBEROS_NAME_A + + +#ifndef NEGOSSP_NAME +#define NEGOSSP_NAME_W L"Negotiate" +#define NEGOSSP_NAME_A "Negotiate" + +#ifdef UNICODE +#define NEGOSSP_NAME NEGOSSP_NAME_W +#else +#define NEGOSSP_NAME NEGOSSP_NAME_A +#endif +#endif // NEGOSSP_NAME + +#ifndef CLOUDAP_NAME +#define CLOUDAP_NAME_W L"CloudAP" +#define ClOUDAP_NAME_A "CloudAP" + +#ifdef UNICODE +#define CLOUDAP_NAME CLOUDAP_NAME_W +#else +#define CLOUDAP_NAME ClOUDAP_NAME_A +#endif +#endif // CLOUDAP_NAME + +// +// Include the master SSPI header file +// + +#include + +#if defined(SECURITY_WIN32) || defined(SECURITY_KERNEL) +#include +#endif + +// +// Include the error codes: +// + +#if ISSP_LEVEL == 16 +#include +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_GAMES) */ +#pragma endregion diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsdef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsdef.h new file mode 100644 index 0000000000000000000000000000000000000000..06fe2ed459542d5394f7a3148b21f2df3c3bdd2e --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsdef.h @@ -0,0 +1,725 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + SensorsDef.h + +Abstract: + + Sensors definitions header file + +--*/ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifndef __midl +#include +#include +#include +#include +#include +#include +#include +#endif + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef __midl + +///////////////////////////////////////////////////////////////////// +// Sensor Categories +// + +// {C317C286-C468-4288-9975-D4C4587C442C} +DEFINE_GUID(GUID_SensorCategory_All, 0XC317C286, 0XC468, 0X4288, 0X99, 0X75, 0XD4, 0XC4, 0X58, 0X7C, 0X44, 0X2C); +// {CA19690F-A2C7-477D-A99E-99EC6E2B5648} +DEFINE_GUID(GUID_SensorCategory_Biometric, 0XCA19690F, 0XA2C7, 0X477D, 0XA9, 0X9E, 0X99, 0XEC, 0X6E, 0X2B, 0X56, 0X48); +// {FB73FCD8-FC4A-483C-AC58-27B691C6BEFF} +DEFINE_GUID(GUID_SensorCategory_Electrical, 0XFB73FCD8, 0XFC4A, 0X483C, 0XAC, 0X58, 0X27, 0XB6, 0X91, 0XC6, 0XBE, 0XFF); +// {323439AA-7F66-492B-BA0C-73E9AA0A65D5} +DEFINE_GUID(GUID_SensorCategory_Environmental, 0X323439AA, 0X7F66, 0X492B, 0XBA, 0X0C, 0X73, 0XE9, 0XAA, 0X0A, 0X65, 0XD5); +// {17A665C0-9063-4216-B202-5C7A255E18CE} +DEFINE_GUID(GUID_SensorCategory_Light, 0X17A665C0, 0X9063, 0X4216, 0XB2, 0X02, 0X5C, 0X7A, 0X25, 0X5E, 0X18, 0XCE); +// {BFA794E4-F964-4FDB-90F6-51056BFE4B44} +DEFINE_GUID(GUID_SensorCategory_Location, 0XBFA794E4, 0XF964, 0X4FDB, 0X90, 0XF6, 0X51, 0X05, 0X6B, 0XFE, 0X4B, 0X44); +// {8D131D68-8EF7-4656-80B5-CCCBD93791C5} +DEFINE_GUID(GUID_SensorCategory_Mechanical, 0X8D131D68, 0X8EF7, 0X4656, 0X80, 0XB5, 0XCC, 0XCB, 0XD9, 0X37, 0X91, 0XC5); +// {CD09DAF1-3B2E-4C3D-B598-B5E5FF93FD46} +DEFINE_GUID(GUID_SensorCategory_Motion, 0XCD09DAF1, 0X3B2E, 0X4C3D, 0XB5, 0X98, 0XB5, 0XE5, 0XFF, 0X93, 0XFD, 0X46); +// {9E6C04B6-96FE-4954-B726-68682A473F69} +DEFINE_GUID(GUID_SensorCategory_Orientation, 0X9E6C04B6, 0X96FE, 0X4954, 0XB7, 0X26, 0X68, 0X68, 0X2A, 0X47, 0X3F, 0X69); +// {2C90E7A9-F4C9-4FA2-AF37-56D471FE5A3D} +DEFINE_GUID(GUID_SensorCategory_Other, 0x2C90E7A9, 0xF4C9, 0x4FA2, 0xAF, 0x37, 0x56, 0xD4, 0x71, 0xFE, 0x5A, 0x3D); +// {F1609081-1E12-412B-A14D-CBB0E95BD2E5} +DEFINE_GUID(GUID_SensorCategory_PersonalActivity, 0XF1609081, 0X1E12, 0X412B, 0XA1, 0X4D, 0XCB, 0XB0, 0XE9, 0X5B, 0XD2, 0XE5); +// {B000E77E-F5B5-420F-815D-0270A726F270} +DEFINE_GUID(GUID_SensorCategory_Scanner, 0XB000E77E, 0XF5B5, 0X420F, 0X81, 0X5D, 0X02, 0X70, 0XA7, 0X26, 0XF2, 0X70); +// {2BEAE7FA-19B0-48C5-A1F6-B5480DC206B0} +DEFINE_GUID(GUID_SensorCategory_Unsupported, 0x2BEAE7fA, 0x19B0, 0x48C5, 0xA1, 0xF6, 0xB5, 0x48, 0x0D, 0xC2, 0x06, 0xB0); + + +///////////////////////////////////////////////////////////////////// +// Sensor Types +// + +// {C2FB0F5F-E2D2-4C78-BCD0-352A9582819D} +DEFINE_GUID(GUID_SensorType_Accelerometer3D, 0XC2FB0F5F, 0XE2D2, 0X4C78, 0XBC, 0XD0, 0X35, 0X2A, 0X95, 0X82, 0X81, 0X9D); +// {9D9E0118-1807-4F2E-96E4-2CE57142E196} +DEFINE_GUID(GUID_SensorType_ActivityDetection, 0X9D9E0118, 0X1807, 0X4F2E, 0X96, 0XE4, 0X2C, 0XE5, 0X71, 0X42, 0XE1, 0X96); +// {97F115C8-599A-4153-8894-D2D12899918A} +DEFINE_GUID(GUID_SensorType_AmbientLight, 0X97F115C8, 0X599A, 0X4153, 0X88, 0X94, 0XD2, 0XD1, 0X28, 0X99, 0X91, 0X8A); +// {0E903829-FF8A-4A93-97DF-3DCBDE402288} +DEFINE_GUID(GUID_SensorType_Barometer, 0X0E903829, 0XFF8A, 0X4A93, 0X97, 0XDF, 0X3D, 0XCB, 0XDE, 0X40, 0X22, 0X88); +// {E83AF229-8640-4D18-A213-E22675EBB2C3} +DEFINE_GUID(GUID_SensorType_Custom, 0XE83AF229, 0X8640, 0X4D18, 0XA2, 0X13, 0XE2, 0X26, 0X75, 0XEB, 0XB2, 0XC3); +// {ADE4987F-7AC4-4DFA-9722-0A027181C747} +DEFINE_GUID(GUID_SensorType_FloorElevation, 0xADE4987F, 0x7AC4, 0x4DFA, 0x97, 0x22, 0x0A, 0x02, 0x71, 0x81, 0xC7, 0x47); +// {E77195F8-2D1F-4823-971B-1C4467556C9D} +DEFINE_GUID(GUID_SensorType_GeomagneticOrientation, 0XE77195F8, 0X2D1F, 0X4823, 0X97, 0X1B, 0X1C, 0X44, 0X67, 0X55, 0X6C, 0X9D); +// {03B52C73-BB76-463F-9524-38DE76EB700B} +DEFINE_GUID(GUID_SensorType_GravityVector, 0X03B52C73, 0XBB76, 0X463F, 0X95, 0X24, 0X38, 0XDE, 0X76, 0XEB, 0X70, 0X0B); +// {09485F5A-759E-42C2-BD4B-A349B75C8643} +DEFINE_GUID(GUID_SensorType_Gyrometer3D, 0X09485F5A, 0X759E, 0X42C2, 0XBD, 0X4B, 0XA3, 0X49, 0XB7, 0X5C, 0X86, 0X43); +// {5C72BF67-BD7E-4257-990B-98A3BA3B400A} +DEFINE_GUID(GUID_SensorType_Humidity, 0X5C72BF67, 0XBD7E, 0X4257, 0X99, 0X0B, 0X98, 0XA3, 0XBA, 0X3B, 0X40, 0X0A); +// {038B0283-97B4-41C8-BC24-5FF1AA48FEC7} +DEFINE_GUID(GUID_SensorType_LinearAccelerometer, 0X038B0283, 0X97B4, 0X41C8, 0XBC, 0X24, 0X5F, 0XF1, 0XAA, 0X48, 0XFE, 0XC7); +// {55E5EFFB-15C7-40df-8698-A84B7C863C53} +DEFINE_GUID(GUID_SensorType_Magnetometer3D, 0X55E5EFFB, 0X15C7, 0X40DF, 0X86, 0X98, 0XA8, 0X4B, 0X7C, 0X86, 0X3C, 0X53); +// {CDB5D8F7-3CFD-41C8-8542-CCE622CF5D6E} +DEFINE_GUID(GUID_SensorType_Orientation, 0XCDB5D8F7, 0X3CFD, 0X41C8, 0X85, 0X42, 0XCC, 0XE6, 0X22, 0XCF, 0X5D, 0X6E); +// {B19F89AF-E3EB-444B-8DEA-202575A71599} +DEFINE_GUID(GUID_SensorType_Pedometer, 0XB19F89AF, 0XE3EB, 0X444B, 0X8D, 0XEA, 0X20, 0X25, 0X75, 0XA7, 0X15, 0X99); +// {5220DAE9-3179-4430-9F90-06266D2A34DE} +DEFINE_GUID(GUID_SensorType_Proximity, 0X5220DAE9, 0X3179, 0X4430, 0X9F, 0X90, 0X06, 0X26, 0X6D, 0X2A, 0X34, 0XDE); +// {40993B51-4706-44DC-98D5-C920C037FFAB} +DEFINE_GUID(GUID_SensorType_RelativeOrientation, 0x40993b51, 0x4706, 0x44dc, 0x98, 0xd5, 0xc9, 0x20, 0xc0, 0x37, 0xff, 0xab); +// {86A19291-0482-402C-BF4C-ADDAC52B1C39} +DEFINE_GUID(GUID_SensorType_SimpleDeviceOrientation, 0X86A19291, 0X0482, 0X402C, 0XBF, 0X4C, 0XAD, 0XDA, 0XC5, 0X2B, 0X1C, 0X39); +// {04FD0EC4-D5DA-45FA-95A9-5DB38EE19306} +DEFINE_GUID(GUID_SensorType_Temperature, 0X04FD0EC4, 0XD5DA, 0X45FA, 0X95, 0XA9, 0X5D, 0XB3, 0X8E, 0XE1, 0X93, 0X06); +// {82358065-F4C4-4DA1-B272-13C23332A207} +DEFINE_GUID(GUID_SensorType_HingeAngle, 0x82358065, 0xf4c4, 0x4da1, 0xb2, 0x72, 0x13, 0xc2, 0x33, 0x32, 0xa2, 0x7); + + +//////////////////////////////////////////////////////////////////// +// Properties +// + +// {D4247382-969D-4F24-BB14-FB9671870BBF} + +// Sensor Enumeration Properties (2-19) +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_Type, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 2); //[VT_CLSID] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_Category, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 3); //[VT_CLSID] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_ConnectionType, // Possible values for this key are defined in the SENSOR_CONNECTION_TYPES enum below + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 4); //[VT_UI4] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_IsPrimary, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 5); //[VT_BOOL] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_Name, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 6); //[VT_LPWSTR] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_Manufacturer, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 7); //[VT_LPWSTR] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_Model, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 8); //[VT_LPWSTR] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_PersistentUniqueId, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 9); //[VT_CLSID] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_VendorDefinedSubType, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 10); //[VT_CLSID] + +// Common Sensor Properties (2, 20-29) +DEFINE_PROPERTYKEY(PKEY_Sensor_Type, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 2); //[VT_CLSID] +DEFINE_PROPERTYKEY(PKEY_Sensor_State, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 20); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_MinimumDataInterval_Ms, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 21); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_MaximumDataFieldSize_Bytes, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 22); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_Power_Milliwatts, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 23); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorHistory_MaxSize_Bytes, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 24); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorHistory_Interval_Ms, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 25); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorHistory_MaximumRecordSize_Bytes, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 26); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_FifoReservedSize_Samples, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 27); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_FifoMaxSize_Samples, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 28); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_WakeCapable, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 29); //[VT_BOOL] + +// Light Sensor Property (30-39) +DEFINE_PROPERTYKEY(PKEY_LightSensor_ResponseCurve, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 30); //[VT_VECTOR | VT_UI4] +DEFINE_PROPERTYKEY(DEVPKEY_LightSensor_AutoBrightnessPreferred, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 31); //[VT_BOOL] +DEFINE_PROPERTYKEY(DEVPKEY_LightSensor_ColorCapable, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 32); //[VT_BOOL] +DEFINE_PROPERTYKEY(DEVPKEY_LightSensor_AdaptiveColorPreferred, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 33); //[VT_BOOL] + +// Orientation Sensor Property (40-49) +DEFINE_PROPERTYKEY(PKEY_OrientationSensor_GyroscopeUsed, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 40); //[VT_BOOL] + +// Data-Field Property (50-59) +DEFINE_PROPERTYKEY(PKEY_SensorDataField_Resolution, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 50); +DEFINE_PROPERTYKEY(PKEY_SensorDataField_RangeMinimum, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 51); +DEFINE_PROPERTYKEY(PKEY_SensorDataField_RangeMaximum, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 52); + +// Activity Sensor Property (60-69) +DEFINE_PROPERTYKEY(PKEY_SensorData_SupportedActivityStates, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 60); //[VT_UI4] + +DEFINE_PROPERTYKEY(PKEY_SensorData_MinimumDetectionIntervals_Ms, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 61); //[VT_VECTOR|VT_UI4] + +// Pedometer Sensor Property (70-79) +DEFINE_PROPERTYKEY(PKEY_SensorData_SupportedStepTypes, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 70); //[VT_UI4] + +// Proximity Sensor Property (80-89) +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_ProximityType, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 80); //[VT_UI4] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_HumanPresenceDetectionType, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 81); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_Sensor_Proximity_SensorCapabilities, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 82); //[VT_UI4] +DEFINE_PROPERTYKEY(DEVPKEY_Sensor_HumanPresence_MaxDetectablePersonsCount, + 0xd4247382, 0x969d, 0x4f24, 0xbb, 0x14, 0xfb, 0x96, 0x71, 0x87, 0xb, 0xbf, 83); //[VT_UI4] + +////////////////////////////////////////////////////////////// +// Data-Fields +// + +// {C458F8A7-4AE8-4777-9607-2E9BDD65110A} + +// Common Data-Fields (2-9) +DEFINE_PROPERTYKEY(PKEY_SensorData_Timestamp, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 2); //[VT_FILETIME] +DEFINE_PROPERTYKEY(PKEY_SensorData_IsValid, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 3); //[VT_BOOL] +DEFINE_PROPERTYKEY(PKEY_SensorData_TimestampQPC, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 4); //[VT_UI8] + + +// Accelerometer Data-Fields (10-19) +DEFINE_PROPERTYKEY(PKEY_SensorData_AccelerationX_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 10); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_AccelerationY_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 11); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_AccelerationZ_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 12); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_Shake, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 33); //[VT_BOOL] + +// Magnetometer Data-Fields (20-29) +DEFINE_PROPERTYKEY(PKEY_SensorData_MagneticFieldStrengthX_Microteslas, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 20); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_MagneticFieldStrengthY_Microteslas, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 21); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_MagneticFieldStrengthZ_Microteslas, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 22); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_MagnetometerAccuracy, // Possible values for this key are defined in MAGNETOMETER_ACCURACY enum below + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 23); //[VT_UI4] + +// Gyrometer Data-Fields (40-49) +DEFINE_PROPERTYKEY(PKEY_SensorData_AngularVelocityX_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 40); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_AngularVelocityY_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 41); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_AngularVelocityZ_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 42); //[VT_R4] + +// Light Sensor Data-Fields (60-69) +DEFINE_PROPERTYKEY(PKEY_SensorData_LightLevel_Lux, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 60); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LightTemperature_Kelvins, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 61); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LightChromaticityX, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 62); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LightChromaticityY, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 63); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LightLevel_Lux_Threshold_AbsoluteDifference, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 64); //[VT_R4] + +// Device Orientation Sensor Data-Fields (70-89) +DEFINE_PROPERTYKEY(PKEY_SensorData_QuaternionW, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 70); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_QuaternionX, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 71); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_QuaternionY, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 72); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_QuaternionZ, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 73); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_DeclinationAngle_Degrees, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 74); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LinearAccelerationX_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 75); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LinearAccelerationY_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 76); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_LinearAccelerationZ_Gs, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 77); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CorrectedAngularVelocityX_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 78); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CorrectedAngularVelocityY_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 79); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CorrectedAngularVelocityZ_DegreesPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 80); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_RotationAngle_Degrees, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 81); //[VT_R4] + +// Proximity Sensor Data-Fields (90-99) +DEFINE_PROPERTYKEY(PKEY_SensorData_ProximityDetection, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 90); //[VT_BOOL] +DEFINE_PROPERTYKEY(PKEY_SensorData_ProximityDistanceMillimeters, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 91); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_DetectionDistance_Threshold, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 92); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_AttentionDetection, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 93); //[VT_BOOL] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadAzimuth, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 94); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadAltitude, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 95); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadRoll, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 96); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadPitch, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 97); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadYaw, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 98); //[VT_R4] + +// Environmental Sensor Data-Fields (100-109) +DEFINE_PROPERTYKEY(PKEY_SensorData_AtmosphericPressure_Bars, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 100); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_Temperature_Celsius, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 101); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_RelativeHumidity_Percent, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 102); //[VT_R4] + +// Simple Device Orientation Sensor Data-Fields (120-129) +DEFINE_PROPERTYKEY(PKEY_SensorData_SimpleDeviceOrientation, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 120); //[VT_UI4] + +// Activity Detection Sensor Data-Fields (130-139) +DEFINE_PROPERTYKEY(PKEY_SensorData_CurrentActivityState, // Possible values for this key are defined in ACTIVITY_STATES enum below + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 130); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CurrentActivityStateConfidence_Percentage, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 131); //[VT_UI2] +DEFINE_PROPERTYKEY(PKEY_SensorData_SubscribedActivityStates, // Possible values for this key are defined in ACTIVITY_STATES enum below + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 132); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_ActivityStream, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 133); //[VT_BOOL] +DEFINE_PROPERTYKEY(PKEY_SensorData_ConfidenceThreshold_Percentage, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 134); //[VT_UI2] + +// Pedometer Sensor Data-Fields (140-149) +DEFINE_PROPERTYKEY(PKEY_SensorData_PedometerStepType, // Possible values for this key are defined in PEDOMETER_STEP_TYPE enum below + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 140); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_PedometerStepCount, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 141); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_PedometerStepDuration_Ms, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 142); //[VT_I8] +DEFINE_PROPERTYKEY(PKEY_SensorData_PedometerReset, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 143); //[VT_BOOL] + +// Custom Sensor Data-Fields (160-199) +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue0, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 160); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue1, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 161); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue2, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 162); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue3, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 163); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue4, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 164); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue5, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 165); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue6, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 166); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue7, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 167); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue8, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 168); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue9, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 169); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue10, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 170); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue11, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 171); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue12, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 172); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue13, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 173); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue14, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 174); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue15, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 175); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue16, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 176); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue17, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 177); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue18, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 178); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue19, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 179); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue20, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 180); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue21, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 181); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue22, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 182); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue23, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 183); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue24, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 184); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue25, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 185); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue26, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 186); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue27, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 187); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CustomValue28, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 188); //[VT_UI4] + +// Floor Elevation Sensor Data-Fields (200-209) +DEFINE_PROPERTYKEY(PKEY_SensorData_ElevationChangeMode, // Possible values for this key are defined in ELEVATION_CHANGE_MODE enum below + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 200); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CumulativeElevation_Meters, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 201); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CumulativeElevationFloorCount, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 202); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_CumulativeElevationStepCount, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 203); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_ElevationChange_Meters, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 204); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_VerticalSpeed_MetersPerSecond, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 205); //[VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_ElevationChangeFloorCount, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 206); //[VT_UI4] + +// Human Presence Sensor Multi-Person Detection Data-Fields (210-230) +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_DetectedPersonsCount, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 210); //[VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_DistanceMillimetersVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 211); //[VT_VECTOR|VT_UI4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_AttentionVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 212); //[VT_VECTOR|VT_BOOL] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadAzimuthVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 213); //[VT_VECTOR|VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadAltitudeVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 214); //[VT_VECTOR|VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadRollVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 215); //[VT_VECTOR|VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadPitchVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 216); //[VT_VECTOR|VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_HeadYawVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 217); //[VT_VECTOR|VT_R4] +DEFINE_PROPERTYKEY(PKEY_SensorData_HumanPresence_PersonIdVector, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 218); //[VT_VECTOR|VT_UI4] + +// Hinge Angle Sensor Data Fields +DEFINE_PROPERTYKEY(PKEY_SensorData_HingeAngle, + 0xc458f8a7, 0x4ae8, 0x4777, 0x96, 0x7, 0x2e, 0x9b, 0xdd, 0x65, 0x11, 0xa, 300); //[VT_R4] + +#endif //__midl + +typedef enum ACTIVITY_STATE_COUNT +{ + ActivityStateCount = 8, +} ACTIVITY_STATE_COUNT; + +typedef enum ACTIVITY_STATE +{ + ActivityState_Unknown = 0x00000001, + ActivityState_Stationary = 0x00000002, + ActivityState_Fidgeting = 0x00000004, + ActivityState_Walking = 0x00000008, + ActivityState_Running = 0x00000010, + ActivityState_InVehicle = 0x00000020, + ActivityState_Biking = 0x00000040, + ActivityState_Idle = 0x00000080, + ActivityState_Max = 1 << ActivityStateCount, + + ActivityState_Force_Dword = 0xFFFFFFFF // Make sure the enum is 32bit +} ACTIVITY_STATE; + +typedef enum ELEVATION_CHANGE_MODE +{ + ElevationChangeMode_Unknown = 0, + ElevationChangeMode_Elevator, + ElevationChangeMode_Stepping, + ElevationChangeMode_Max, + + ElevationChangeMode_Force_Dword = 0xFFFFFFFF // Make sure the enum is 32bit +} ELEVATION_CHANGE_MODE; + +typedef enum MAGNETOMETER_ACCURACY +{ + MagnetometerAccuracy_Unknown = 0, + MagnetometerAccuracy_Unreliable, + MagnetometerAccuracy_Approximate, + MagnetometerAccuracy_High +} MAGNETOMETER_ACCURACY; + +// Represents the number of step types in the PEDOMETER_STEP_TYPE enum below +typedef enum PEDOMETER_STEP_TYPE_COUNT +{ + PedometerStepTypeCount = 3, +} PEDOMETER_STEP_TYPE_COUNT; + +typedef enum PEDOMETER_STEP_TYPE +{ + PedometerStepType_Unknown = 0x00000001, + PedometerStepType_Walking = 0x00000002, + PedometerStepType_Running = 0x00000004, + PedometerStepType_Max = 1 << PedometerStepTypeCount, + + PedometerStepType_Force_Dword = 0xFFFFFFFF // Make sure the enum is 32bit +} PEDOMETER_STEP_TYPE; + +typedef enum PROXIMITY_TYPE +{ + ProximityType_ObjectProximity = 0, + ProximityType_HumanProximity = 1, + ProximityType_Force_Dword = 0xFFFFFFFF +} PROXIMITY_TYPE; + +// Represents the number of human presence detection types in the HUMAN_PRESENCE_DETECTION_TYPE enum below +typedef enum HUMAN_PRESENCE_DETECTION_TYPE_COUNT +{ + HumanPresenceDetectionTypeCount = 4, +} HUMAN_PRESENCE_DETECTION_TYPE_COUNT; + +typedef enum HUMAN_PRESENCE_DETECTION_TYPE +{ + HumanPresenceDetectionType_Undefined = 0x00000000, + HumanPresenceDetectionType_VendorDefinedNonBiometric = 0x00000001, + HumanPresenceDetectionType_VendorDefinedBiometric = 0x00000002, + HumanPresenceDetectionType_FacialBiometric = 0x00000004, + HumanPresenceDetectionType_AudioBiometric = 0x00000008, + HumanPresenceDetectionType_Force_Dword = 0xFFFFFFFF // Make sure the enum is 32bit +} HUMAN_PRESENCE_DETECTION_TYPE; + +// This enum needs to be updated as new Sensor Capabilities are added +// and Proximity_Sensor_Supported_Capabilities must advertise this accordingly. +typedef enum PROXIMITY_SENSOR_CAPABILITIES +{ + Proximity_Sensor_Human_Presence_Capable = 0x0001, + Proximity_Sensor_Human_Engagement_Capable = 0x0002, + Proximity_Sensor_Human_Head_Azimuth_Capable = 0x0004, + Proximity_Sensor_Human_Head_Altitude_Capable = 0x0008, + Proximity_Sensor_Human_Head_Roll_Capable = 0x0010, + Proximity_Sensor_Human_Head_Pitch_Capable = 0x0020, + Proximity_Sensor_Human_Head_Yaw_Capable = 0x0040, + Proximity_Sensor_Human_Identification_Capable = 0x0080, + Proximity_Sensor_Multi_Person_Detection_Capable = 0x0100, + Proximity_Sensor_Supported_Capabilities = 0x01FF +} PROXIMITY_SENSOR_CAPABILITIES; + +typedef enum SIMPLE_DEVICE_ORIENTATION +{ + SimpleDeviceOrientation_NotRotated = 0, + SimpleDeviceOrientation_Rotated90DegreesCounterclockwise = 1, + SimpleDeviceOrientation_Rotated180DegreesCounterclockwise = 2, + SimpleDeviceOrientation_Rotated270DegreesCounterclockwise = 3, + SimpleDeviceOrientation_Faceup = 4, + SimpleDeviceOrientation_Facedown = 5, +} SIMPLE_DEVICE_ORIENTATION; + +typedef enum SENSOR_STATE +{ + SensorState_Initializing = 0, + SensorState_Idle, + SensorState_Active, + SensorState_Error, +} SENSOR_STATE; + +typedef enum SENSOR_CONNECTION_TYPES +{ + SensorConnectionType_Integrated = 0, + SensorConnectionType_Attached, + SensorConnectionType_External +} SENSOR_CONNECTION_TYPES; + +typedef struct SENSOR_VALUE_PAIR +{ + PROPERTYKEY Key; + PROPVARIANT Value; +} SENSOR_VALUE_PAIR, *PSENSOR_VALUE_PAIR; + +// This list contains the contains a sensors properties and their values +typedef struct SENSOR_COLLECTION_LIST +{ +#ifndef __midl + _Field_range_(>, SENSOR_COLLECTION_LIST_HEADER_SIZE) +#endif + ULONG AllocatedSizeInBytes; // Size of structure +#ifndef __midl + _Field_range_(<=, (AllocatedSizeInBytes - SENSOR_COLLECTION_LIST_HEADER_SIZE) / sizeof(SENSOR_VALUE_PAIR)) +#endif + ULONG Count; // Number of total elements populated +#ifndef __midl + _Field_size_bytes_(AllocatedSizeInBytes - SENSOR_COLLECTION_LIST_HEADER_SIZE) +#endif + SENSOR_VALUE_PAIR List[1]; // Variable sized buffer, first element is a placeholder and may not reflect actual size +} SENSOR_COLLECTION_LIST, *PSENSOR_COLLECTION_LIST; + +// This list contains ONLY the PROPERTYKEY's associated with a particular sensor, +// not the property values +typedef struct SENSOR_PROPERTY_LIST +{ +#ifndef __midl + _Field_range_(>, SENSOR_PROPERTY_LIST_HEADER_SIZE) +#endif + ULONG AllocatedSizeInBytes; // Size of structure +#ifndef __midl + _Field_range_(<=, (AllocatedSizeInBytes - SENSOR_PROPERTY_LIST_HEADER_SIZE) / sizeof(PROPERTYKEY)) +#endif + ULONG Count; // Number of total elements populated +#ifndef __midl + _Field_size_bytes_(AllocatedSizeInBytes - SENSOR_PROPERTY_LIST_HEADER_SIZE) +#endif + PROPERTYKEY List[1]; // Variable sized buffer, first element is a placeholder and may not reflect actual size +} SENSOR_PROPERTY_LIST, *PSENSOR_PROPERTY_LIST; + +#ifndef _CONTRACT_GEN // Exclude implementations from contract file generation. + +static const ULONG SENSOR_COLLECTION_LIST_HEADER_SIZE = + (sizeof(SENSOR_COLLECTION_LIST) - sizeof(SENSOR_VALUE_PAIR)); + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifndef __midl +VOID +FORCEINLINE +SENSOR_COLLECTION_LIST_INIT( + _Out_writes_bytes_(CollectionListSize) + _Post_satisfies_(pCollectionList->AllocatedSizeInBytes == CollectionListSize) + PSENSOR_COLLECTION_LIST pCollectionList, + _In_ _Pre_satisfies_(SENSOR_COLLECTION_LIST_HEADER_SIZE <= CollectionListSize) ULONG CollectionListSize + ) +{ + // Problematic if the pCollectionList buffer is too small + if (SENSOR_COLLECTION_LIST_HEADER_SIZE > CollectionListSize) + { + DbgRaiseAssertionFailure(); + } + + RtlZeroMemory(pCollectionList, CollectionListSize); + pCollectionList->AllocatedSizeInBytes = CollectionListSize; + pCollectionList->Count = 0; +} + +_Ret_range_(==, SENSOR_COLLECTION_LIST_HEADER_SIZE + sizeof(SENSOR_VALUE_PAIR) * Count) +ULONG +FORCEINLINE +SENSOR_COLLECTION_LIST_SIZE( + _In_ ULONG Count + ) +{ + return SENSOR_COLLECTION_LIST_HEADER_SIZE + sizeof(SENSOR_VALUE_PAIR) * Count; +} + +ULONG +FORCEINLINE +SENSOR_COLLECTION_LIST_CALCULATE_MAX_COUNT( + _In_ PSENSOR_COLLECTION_LIST pCollectionList + ) +{ + if (NULL == pCollectionList || + pCollectionList->AllocatedSizeInBytes < SENSOR_COLLECTION_LIST_HEADER_SIZE) + { + return 0; + } + else + { + return ((pCollectionList->AllocatedSizeInBytes - SENSOR_COLLECTION_LIST_HEADER_SIZE) / + sizeof(SENSOR_VALUE_PAIR)); + } +} +#endif // __midl +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#pragma deprecated(SENSOR_COLLECTION_LIST_CALCULATE_MAX_COUNT) // Use CollectionsListGetFillableCount instead. +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +static const ULONG SENSOR_PROPERTY_LIST_HEADER_SIZE = + (sizeof(SENSOR_PROPERTY_LIST) - sizeof(PROPERTYKEY)); + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) +#ifndef __midl +VOID +FORCEINLINE +SENSOR_PROPERTY_LIST_INIT( + _Out_writes_bytes_(PropertyListSize) PSENSOR_PROPERTY_LIST pPropertyList, + _In_ _Pre_satisfies_(SENSOR_PROPERTY_LIST_HEADER_SIZE <= PropertyListSize) ULONG PropertyListSize + ) +{ + // Problematic if the pPropertyList buffer is too small + if (SENSOR_PROPERTY_LIST_HEADER_SIZE > PropertyListSize) + { + DbgRaiseAssertionFailure(); + } + + RtlZeroMemory(pPropertyList, PropertyListSize); + pPropertyList->AllocatedSizeInBytes = PropertyListSize; + pPropertyList->Count = 0; +} + +_Ret_range_(== , SENSOR_PROPERTY_LIST_HEADER_SIZE + sizeof(PROPERTYKEY) * Count) +ULONG +FORCEINLINE +SENSOR_PROPERTY_LIST_SIZE( + _In_ ULONG Count + ) +{ + return SENSOR_PROPERTY_LIST_HEADER_SIZE + sizeof(PROPERTYKEY) * Count; +} + +ULONG +FORCEINLINE +SENSOR_PROPERTY_LIST_CALCULATE_MAX_COUNT( + _In_ PSENSOR_PROPERTY_LIST pPropertyList + ) +{ + if (NULL == pPropertyList || + pPropertyList->AllocatedSizeInBytes < SENSOR_PROPERTY_LIST_HEADER_SIZE) + { + return 0; + } + else + { + return ((pPropertyList->AllocatedSizeInBytes - SENSOR_PROPERTY_LIST_HEADER_SIZE) / + sizeof(PROPERTYKEY)); + } +} +#endif //__midl +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#endif // _CONTRACT_GEN + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) +#pragma deprecated(SENSOR_PROPERTY_LIST_CALCULATE_MAX_COUNT) // Use PropertiesListGetFillableCount instead. +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#ifdef __cplusplus +} +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsstructures.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsstructures.h new file mode 100644 index 0000000000000000000000000000000000000000..b4bc34bfc44a5bba22898508738b0f9c983b7adc --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsstructures.h @@ -0,0 +1,93 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + SensorsStructures.h + +Abstract: + + Sensor structures header file + +--*/ + +//#if _MSC_VER > 1000 +#pragma once +//#endif + +// The following flag is required to prevent structure redefinition with WpSensor.h +// we keep the #pragma above to benefit from the speed advantages this pragma brings. +#ifndef _SENSORS_STRUCTURES +#define _SENSORS_STRUCTURES + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct +{ + float X; + float Y; + float Z; +} VEC3D, *PVEC3D; + +#pragma warning(push) +#pragma warning(disable:4201) // warning C4201: nonstandard extension used : nameless struct/union + +typedef struct +{ + union + { + struct + { + float A11; + float A12; + float A13; + float A21; + float A22; + float A23; + float A31; + float A32; + float A33; + }; + struct + { + VEC3D V1; + VEC3D V2; + VEC3D V3; + }; + float M[3][3]; + }; +} MATRIX3X3, *PMATRIX3X3; + + +#pragma warning(pop) + +// Simple structure representing a 4 dimensional vector used for simple 3D rotation operation. +// The rotation is done around the axis formed by the vector v= [X, Y, Z] and is of angle ?, and we have: +// W=cos(theta/2) +// |v|=sin(theta/2) +typedef struct +{ + float X; // x component of rotation axis vector * sin(theta/2) also i (imaginary) coefficient + float Y; // y component of rotation axis vector * sin(theta/2) also j coefficient + float Z; // z component of rotation axis vector * sin(theta/2) also k coefficient + float W; // real coefficient = cos(theta/2) +} QUATERNION, *PQUATERNION; + + +typedef enum +{ + AXIS_X = 0, + AXIS_Y, + AXIS_Z, + AXIS_MAX +} AXIS, *PAXIS; + + +#ifdef __cplusplus +} +#endif + +#endif // _SENSORS_STRUCTURES \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsutils.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsutils.h new file mode 100644 index 0000000000000000000000000000000000000000..a27db077394444dfd489c3996a78d1fc952264b4 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sensorsutils.h @@ -0,0 +1,329 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + SensorsUtils.h + +Abstract: + + This file contains utility functions for V2 Sensors + +--*/ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +/////////////////////////////////////////////////////////////////////////////// +// // +// TimeStamp Helpers // +// // +/////////////////////////////////////////////////////////////////////////////// + +NTSTATUS +GetPerformanceTime( + _Out_ PULONG TimeMs + ); + +#define MILLISECONDS_TO_100NANOSECONDS(durationMs) ((durationMs) * 1000 * 10) +#define MILLISECONDS_FROM_100NANOSECONDS(durationNanoS) ((durationNanoS) / (1000 * 10)) + +/////////////////////////////////////////////////////////////////////////////// +// // +// PropVariant Helper // +// // +/////////////////////////////////////////////////////////////////////////////// + +HRESULT +InitPropVariantFromFloat( + _In_ FLOAT fltVal, + _Out_ PROPVARIANT *ppropvar + ); + +NTSTATUS +PropKeyFindKeyGetPropVariant( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _In_ BOOLEAN TypeCheck, + _Inout_ PROPVARIANT *pValue + ); + +_At_(pList->AllocatedSizeInBytes, _Const_) +_At_(pList->Count, _Const_) +NTSTATUS +PropKeyFindKeySetPropVariant( + _Inout_ SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _In_ BOOLEAN TypeCheck, + _In_ PROPVARIANT *pValue + ); + +NTSTATUS +PropKeyFindKeyGetFileTime( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ FILETIME *pRetValue); + +NTSTATUS +PropKeyFindKeyGetGuid( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ GUID *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetBool( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ BOOL *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetUlong( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ ULONG *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetUshort( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ USHORT *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetFloat( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ FLOAT *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetDouble( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ double *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetInt32( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ INT32 *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetInt64( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _Out_ INT64 *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetNthUlong( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _In_ const UINT32 Occurrence, + _Out_ ULONG *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetNthUshort( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _In_ const UINT32 Occurrence, + _Out_ USHORT *pRetValue + ); + +NTSTATUS +PropKeyFindKeyGetNthInt64( + _In_ const SENSOR_COLLECTION_LIST *pList, + _In_ const PROPERTYKEY *pKey, + _In_ const UINT32 Occurrence, + _Out_ INT64 *pRetValue + ); + +BOOLEAN +IsKeyPresentInPropertyList( + _In_ PSENSOR_PROPERTY_LIST pList, + _In_ const PROPERTYKEY *pKey + ); + +BOOLEAN +IsKeyPresentInCollectionList( + _In_ PSENSOR_COLLECTION_LIST pList, + _In_ const PROPERTYKEY *pKey + ); + +BOOLEAN +IsCollectionListSame( + _In_ const PSENSOR_COLLECTION_LIST ListA, + _In_ const PSENSOR_COLLECTION_LIST ListB + ); + +NTSTATUS +PropVariantGetInformation( + _In_ const PROPVARIANT *PropVariantValue, + _Out_opt_ ULONG *PropVariantOffset, + _Out_opt_ ULONG *PropVariantSize, + _Outptr_opt_result_bytebuffer_maybenull_(*PropVariantSize) PVOID *PropVariantPointer, + _Out_opt_ DEVPROPTYPE *RemappedType + ); + +NTSTATUS +PropertiesListCopy( + _Inout_ PSENSOR_PROPERTY_LIST Target, + _In_ const PSENSOR_PROPERTY_LIST Source + ); + +ULONG +PropertiesListGetFillableCount( + _In_ ULONG BufferSizeBytes + ); + +/////////////////////////////////////////////////////////////////////////////// +// // +// Collection List Marshaling Legacy Helpers // +// Architecture-specific - Avoid using for data across process boundaries // +// // +/////////////////////////////////////////////////////////////////////////////// + +ULONG +CollectionsListGetMarshalledSize( + _In_ const PSENSOR_COLLECTION_LIST Collection + ); + +NTSTATUS +CollectionsListCopyAndMarshall( + _Inout_ PSENSOR_COLLECTION_LIST Target, + _In_ const PSENSOR_COLLECTION_LIST Source + ); + +NTSTATUS +CollectionsListMarshall( + _Inout_ PSENSOR_COLLECTION_LIST Target + ); + +ULONG +CollectionsListGetMarshalledSizeWithoutSerialization( + _In_ const PSENSOR_COLLECTION_LIST Collection + ); + +NTSTATUS +CollectionsListUpdateMarshalledPointer( + _Inout_ PSENSOR_COLLECTION_LIST Collection + ); + +/////////////////////////////////////////////////////////////////////////////// +// // +// Collection List Serialization Helpers // +// Architecture-independent - Safe to use for data across process boundaries // +// (for example, during DeviceIoControl) // +// // +/////////////////////////////////////////////////////////////////////////////// + +NTSTATUS +SerializationBufferAllocate( + _In_ ULONG SizeInBytes, + _Outptr_result_bytebuffer_(SizeInBytes) BYTE** pBuffer + ); + +VOID +SerializationBufferFree( + _In_opt_ BYTE* Buffer + ); + +ULONG +CollectionsListGetSerializedSize( + _In_ const PSENSOR_COLLECTION_LIST Collection + ); + +NTSTATUS +CollectionsListSerializeToBuffer( + _In_ const PSENSOR_COLLECTION_LIST SourceCollection, + _In_ ULONG TargetBufferSizeInBytes, + _Out_writes_bytes_(TargetBufferSizeInBytes) BYTE* TargetBuffer + ); + +NTSTATUS +CollectionsListAllocateBufferAndSerialize( + _In_ const PSENSOR_COLLECTION_LIST SourceCollection, + _Out_ ULONG* pTargetBufferSizeInBytes, + _Outptr_result_bytebuffer_(*pTargetBufferSizeInBytes) BYTE** pTargetBuffer + ); + +NTSTATUS +CollectionsListDeserializeFromBuffer( + _In_ ULONG SourceBufferSizeInBytes, + _In_reads_bytes_(SourceBufferSizeInBytes) const BYTE* SourceBuffer, + _Inout_ PSENSOR_COLLECTION_LIST TargetCollection + ); + +/////////////////////////////////////////////////////////////////////////////// +// // +// Collection List Helper // +// // +/////////////////////////////////////////////////////////////////////////////// + +NTSTATUS +SensorCollectionGetAt( + _In_ UINT32 Index, + _In_ PSENSOR_COLLECTION_LIST pSensorsList, + _Out_opt_ PROPERTYKEY* pKey, + _Out_opt_ PROPVARIANT* pValue + ); + +ULONG +CollectionsListGetFillableCount( + _In_ ULONG BufferSizeBytes + ); + +BOOLEAN +EvaluateActivityThresholds( + _In_ PSENSOR_COLLECTION_LIST newSample, + _In_ PSENSOR_COLLECTION_LIST oldSample, + _In_ PSENSOR_COLLECTION_LIST thresholds + ); + +NTSTATUS +CollectionsListSortSubscribedActivitiesByConfidence( + _In_ PSENSOR_COLLECTION_LIST thresholds, + _Inout_updates_bytes_(pCollection->AllocatedSizeInBytes) PSENSOR_COLLECTION_LIST pCollection + ); + +HRESULT +InitPropVariantFromCLSIDArray( + _In_reads_(size) GUID *members, + _In_ ULONG size, + _Out_ PROPVARIANT *ppropvar +); + +BOOLEAN +IsSensorSubscribed( + _In_ PSENSOR_COLLECTION_LIST subscriptionList, + _In_ GUID currentType +); + +BOOLEAN +IsGUIDPresentInList( + _In_reads_(arrayLength) const GUID *guidArray, + _In_ const ULONG arrayLength, + _In_ const GUID *guidElem +); + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#ifdef __cplusplus + } +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/spb.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/spb.h new file mode 100644 index 0000000000000000000000000000000000000000..0edf62775e1f1cc4a77a091f68d283d633146e25 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/spb.h @@ -0,0 +1,477 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + spb.h + +Abstract: + + This module contains the Simple Peripheral Bus IOCTL interface for + use by client applications & drivers. + +Environment: + + User-mode and kernel-mode. + +--*/ + +#ifndef _SPB_H_ +#define _SPB_H_ + +#include + +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#ifdef _MSC_VER +#pragma once +#endif + +#pragma warning(push) +#pragma warning(disable:4480) // type specifier for enum + +// +// When opening an connection to a device attached to the SPB controller, +// this is the root of the file object name. +// + +#define SPB_TARGET_NAME_PREFIX L"\\SPB\\" + +typedef enum SpbIoctl +{ + IOCTL_SPB_LOCK_CONTROLLER = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x600, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_UNLOCK_CONTROLLER = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x601, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_EXECUTE_SEQUENCE = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x602, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_LOCK_CONNECTION = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x603, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_UNLOCK_CONNECTION = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x604, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_FULL_DUPLEX = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x605, + METHOD_BUFFERED, + FILE_ANY_ACCESS), + + IOCTL_SPB_MULTI_SPI_TRANSFER = CTL_CODE(FILE_DEVICE_CONTROLLER, + 0x606, + METHOD_BUFFERED, + FILE_ANY_ACCESS) +} +SpbIoctl, *PSpbIoctl; + +typedef enum SPB_TRANSFER_DIRECTION +{ + SpbTransferDirectionNone, + SpbTransferDirectionFromDevice, + SpbTransferDirectionToDevice, + SpbTransferDirectionMax +} +SPB_TRANSFER_DIRECTION, *PSPB_TRANSFER_DIRECTION; + +typedef enum SPB_TRANSFER_BUFFER_FORMAT +{ + SpbTransferBufferFormatInvalid, + SpbTransferBufferFormatSimple, + SpbTransferBufferFormatList, + SpbTransferBufferFormatSimpleNonPaged, + SpbTransferBufferFormatMdl, + SpbTransferBufferFormatMax +} +SPB_TRANSFER_BUFFER_FORMAT, *PSPB_TRANSFER_BUFFER_FORMAT; + +// +// A single entry in a transfer buffer list. +// + +typedef struct SPB_TRANSFER_BUFFER_LIST_ENTRY +{ + // + // The data buffer. + // + + PVOID Buffer; + + // + // The length of the buffer in bytes. + // + + ULONG BufferCb; +} +SPB_TRANSFER_BUFFER_LIST_ENTRY, *PSPB_TRANSFER_BUFFER_LIST_ENTRY; + +#ifndef _NTDDK_ +#ifndef PMDL +#define PMDL PVOID +#endif +#endif + +// +// A buffer - either a simple one-entry buffer or a buffer list +// + +typedef struct SPB_TRANSFER_BUFFER +{ + // + // the format of the transfer buffer. + // + + SPB_TRANSFER_BUFFER_FORMAT Format; + +#pragma warning(push) +#pragma warning(disable:4201) + union + { + // + // Simple buffer or simple non-paged buffer. + // + + SPB_TRANSFER_BUFFER_LIST_ENTRY Simple; + + // + // List of buffers. + // + + struct + { + PSPB_TRANSFER_BUFFER_LIST_ENTRY List; + ULONG ListCe; + } + BufferList; + + // + // MDL format + // + + PMDL Mdl; + }; +#pragma warning(pop) +} +SPB_TRANSFER_BUFFER, *PSPB_TRANSFER_BUFFER; + +// +// A single transfer and its buffer +// + +typedef struct SPB_TRANSFER_LIST_ENTRY +{ + // + // Direction. + // + + SPB_TRANSFER_DIRECTION Direction; + + // + // The delay (in us) before starting this transfer. + // + + ULONG DelayInUs; + + // + // The buffer to transfer to/from + // + + SPB_TRANSFER_BUFFER Buffer; +} +SPB_TRANSFER_LIST_ENTRY, *PSPB_TRANSFER_LIST_ENTRY; + +FORCEINLINE +SPB_TRANSFER_LIST_ENTRY +SPB_TRANSFER_LIST_ENTRY_INIT_SIMPLE( + _In_ SPB_TRANSFER_DIRECTION Direction, + _In_ ULONG DelayInUs, + _Pre_writable_byte_size_(BufferCb) PVOID Buffer, + _In_ ULONG BufferCb + ) +{ + SPB_TRANSFER_LIST_ENTRY entry; + + entry.Direction = Direction; + entry.DelayInUs = DelayInUs; + entry.Buffer.Format = SpbTransferBufferFormatSimple; + entry.Buffer.Simple.Buffer = Buffer; + entry.Buffer.Simple.BufferCb = BufferCb; + return entry; +} + +FORCEINLINE +SPB_TRANSFER_LIST_ENTRY +SPB_TRANSFER_LIST_ENTRY_INIT_NON_PAGED( + _In_ SPB_TRANSFER_DIRECTION Direction, + _In_ ULONG DelayInUs, + _Pre_writable_byte_size_(BufferCb) PVOID Buffer, + _In_ ULONG BufferCb + ) +{ + SPB_TRANSFER_LIST_ENTRY entry; + + entry.Direction = Direction; + entry.DelayInUs = DelayInUs; + entry.Buffer.Format = SpbTransferBufferFormatSimpleNonPaged; + entry.Buffer.Simple.Buffer = Buffer; + entry.Buffer.Simple.BufferCb = BufferCb; + return entry; +} + +FORCEINLINE +SPB_TRANSFER_LIST_ENTRY +SPB_TRANSFER_LIST_ENTRY_INIT_MDL( + _In_ SPB_TRANSFER_DIRECTION Direction, + _In_ ULONG DelayInUs, + _In_ PMDL Mdl + ) +{ + SPB_TRANSFER_LIST_ENTRY entry; + + entry.Direction = Direction; + entry.DelayInUs = DelayInUs; + entry.Buffer.Format = SpbTransferBufferFormatMdl; + entry.Buffer.Mdl = Mdl; + return entry; +} + +FORCEINLINE +SPB_TRANSFER_LIST_ENTRY +SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST( + _In_ SPB_TRANSFER_DIRECTION Direction, + _In_ ULONG DelayInUs, + _In_ SPB_TRANSFER_BUFFER_LIST_ENTRY BufferList[], + _In_ ULONG BufferListCe + ) +{ + SPB_TRANSFER_LIST_ENTRY entry; + + entry.Direction = Direction; + entry.DelayInUs = DelayInUs; + entry.Buffer.Format = SpbTransferBufferFormatList; + entry.Buffer.BufferList.List = BufferList; + entry.Buffer.BufferList.ListCe = BufferListCe; + return entry; +} + + +// +// a list of transfers to be executed in a sequence. +// + +typedef struct SPB_TRANSFER_LIST +{ + // + // List size - must be set to sizeof(SPB_TRANSFER_LIST) + // + + _Field_range_(==, sizeof(SPB_TRANSFER_LIST)) + ULONG Size; + + // + // Reserved flags for internal use - must be zero. + // + + ULONG Reserved; + + // + // The number of input or output transfers for this packet. + // The packet should be followed by this number of transfer descriptors. + // + // Transfers must consist of at least one packet. + // + + ULONG TransferCount; + + // + // The array of transfer descriptors in the list. + // + + _Field_size_(TransferCount) SPB_TRANSFER_LIST_ENTRY Transfers[1]; +} +SPB_TRANSFER_LIST, *PSPB_TRANSFER_LIST; + +// +// A macro to simplify defining a sequence with multiple +// transfers. +// + +#define SPB_TRANSFER_LIST_AND_ENTRIES(n) struct { \ + SPB_TRANSFER_LIST List; \ + SPB_TRANSFER_LIST_ENTRY ExtraTransfers[(n)-1]; \ +} + +VOID +FORCEINLINE +SPB_TRANSFER_LIST_INIT( + _Out_ SPB_TRANSFER_LIST *TransferList, + _In_ ULONG TransferCount + ) +{ + memset(TransferList, + 0, + (sizeof(SPB_TRANSFER_LIST) + + (sizeof(SPB_TRANSFER_LIST_ENTRY) * (TransferCount - 1)))); + TransferList->Size = sizeof(SPB_TRANSFER_LIST); + TransferList->TransferCount = TransferCount; +} + +typedef enum SPB_MULTI_SPI_TRANSFER_MODE +{ + SpbMultiSpiTransferModeInvalid, + SpbMultiSpiTransferModeDualSpi, + SpbMultiSpiTransferModeQuadSpi, + SpbMultiSpiTransferModeMax +} +SPB_MULTI_SPI_TRANSFER_MODE, *PSPB_MULTI_SPI_TRANSFER_MODE; + +// +// A multi-SPI transfer operation header +// This is the structure to be accessed by the SpbCx client (controller driver). +// + +typedef struct SPB_MULTI_SPI_TRANSFER_HEADER +{ + // + // Structure size - must be set to sizeof(SPB_MULTI_SPI_TRANSFER) + // + + _Field_range_(==, sizeof(struct SPB_MULTI_SPI_TRANSFER)) + ULONG Size; + + // + // Line mode + // + + SPB_MULTI_SPI_TRANSFER_MODE Mode; + + // + // The count of bytes at the beginning of the write phase to be + // transferred in single-SPI mode, before line mode switch to + // the mode specified in the Mode member of this struct. + // + + ULONG WritePhaseSingleSpiByteCount; + + // + // The number of wait cycles represented in bytes (representing multi-SPI + // transfer cycles - e.g. 1 byte => 2 wait cycles at quad-SPI), between the + // write phase and read phase of the transfer. + // These wait cycle bytes should be present, and of an undefined value + // at the end of the WritePhaseBuffer. This should be set to 0 if the + // transfer does not have a read phase. + // + + ULONG WaitCycleByteCount; +} +SPB_MULTI_SPI_TRANSFER_HEADER, *PSPB_MULTI_SPI_TRANSFER_HEADER; + +// +// Full representation of a multi-SPI transfer operation, including the +// transfer list. This structure should not be used directly by the SpbCx client +// (controller driver). +// + +typedef struct SPB_MULTI_SPI_TRANSFER { + + // + // Transfer header, containing parameters for the multi-SPI transfer + // + + SPB_MULTI_SPI_TRANSFER_HEADER Header; + + // + // Number of transfer phases, either 1 for write, or 2 for read. + // + + ULONG TransferPhaseCount; + + // + // The transfer entries for write, and optionally read phase of the transfer. + // + + _Field_size_(TransferPhaseCount) SPB_TRANSFER_LIST_ENTRY TransferPhases[1]; +} +SPB_MULTI_SPI_TRANSFER, *PSPB_MULTI_SPI_TRANSFER; + +// +// Structures & macros to simplify defining a multi-SPI transfer. +// + +typedef struct SPB_MULTI_SPI_WRITE_TRANSFER { + SPB_MULTI_SPI_TRANSFER SpiTransfer; +} SPB_MULTI_SPI_WRITE_TRANSFER, *PSPB_MULTI_SPI_WRITE_TRANSFER; + +typedef struct SPB_MULTI_SPI_READ_TRANSFER { + SPB_MULTI_SPI_TRANSFER SpiTransfer; + SPB_TRANSFER_LIST_ENTRY ExtraTransfer; +} SPB_MULTI_SPI_READ_TRANSFER, *PSPB_MULTI_SPI_READ_TRANSFER; + +C_ASSERT(sizeof(SPB_MULTI_SPI_READ_TRANSFER) == sizeof(SPB_MULTI_SPI_TRANSFER) + sizeof(SPB_TRANSFER_LIST_ENTRY)); + +VOID +FORCEINLINE +SPB_MULTI_SPI_TRANSFER_INIT( + _Out_ SPB_MULTI_SPI_TRANSFER *SpiTransfer, + _In_ SPB_MULTI_SPI_TRANSFER_MODE Mode, + _In_ ULONG TransferPhaseCount, + _In_ ULONG WritePhaseSingleSpiByteCount, + _In_ ULONG WaitCycleByteCount +) +{ + memset(SpiTransfer, 0, sizeof(SPB_MULTI_SPI_TRANSFER) + (sizeof(SPB_TRANSFER_LIST_ENTRY) * (TransferPhaseCount - 1))); + SpiTransfer->Header.Size = sizeof(SPB_MULTI_SPI_TRANSFER); + SpiTransfer->Header.Mode = Mode; + SpiTransfer->Header.WritePhaseSingleSpiByteCount = WritePhaseSingleSpiByteCount; + SpiTransfer->Header.WaitCycleByteCount = WaitCycleByteCount; + SpiTransfer->TransferPhaseCount = TransferPhaseCount; +} + +VOID +FORCEINLINE +SPB_MULTI_SPI_WRITE_TRANSFER_INIT( + _Out_ SPB_MULTI_SPI_WRITE_TRANSFER *SpiTransfer, + _In_ SPB_MULTI_SPI_TRANSFER_MODE Mode, + _In_ ULONG WritePhaseSingleSpiByteCount, + _In_ ULONG WaitCycleByteCount +) +{ + SPB_MULTI_SPI_TRANSFER_INIT(&SpiTransfer->SpiTransfer, Mode, 1, WritePhaseSingleSpiByteCount, WaitCycleByteCount); +} + +VOID +FORCEINLINE +SPB_MULTI_SPI_READ_TRANSFER_INIT( + _Out_ SPB_MULTI_SPI_READ_TRANSFER *SpiTransfer, + _In_ SPB_MULTI_SPI_TRANSFER_MODE Mode, + _In_ ULONG WritePhaseSingleSpiByteCount, + _In_ ULONG WaitCycleByteCount +) +{ + SPB_MULTI_SPI_TRANSFER_INIT(&SpiTransfer->SpiTransfer, Mode, 2, WritePhaseSingleSpiByteCount, WaitCycleByteCount); +} + +// begin_wpp config +// CUSTOM_TYPE(SPB_TRANSFER_DIRECTION, ItemEnum(_SPB_TRANSFER_DIRECTION)); +// CUSTOM_TYPE(SPB_TRANSFER_BUFFER_FORMAT, ItemEnum(_SPB_TRANSFER_BUFFER_FORMAT)); +// end_wpp + +#endif // NTDDI_VERSION >= NTDDI_WIN8 + +#endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#endif // _SPB_H_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings.h new file mode 100644 index 0000000000000000000000000000000000000000..5fc470f71b4c29cd106d6db5af21584a96ef2550 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings.h @@ -0,0 +1,716 @@ +#ifndef SPECSTRINGS_H // [ +#define SPECSTRINGS_H + +/*** +*specstrings.h - support for markers for documenting the semantics of APIs +* +* Copyright (c) Microsoft Corporation. All rights reserved. +* +* [Public] +****/ + +/************************************************************************* +* See specstrings_strict.h for documentation of all user visible macros. +*************************************************************************/ + +#if _MSC_VER +#pragma once +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#pragma warning(disable:4668) // #if not_defined treated as #if 0 +#endif + +#if !defined(_SAL_VERSION_SAL2) // [ + + #if defined(__BUILDMACHINE__) || defined(_USE_SAL2_ONLY) + #define _SAL_VERSION_SAL2(_A) SAL_2_Clean_Violation_using ## _A + #else + #define _SAL_VERSION_SAL2(_A) + #endif + + #ifdef _USE_SAL2_ONLY + #define _SAL2_STRICT + #define _SAL_VERSION_CHECK(_A) _SAL_VERSION_SAL2(_A) + #else + #define _SAL_VERSION_CHECK(_A) + #endif + + #ifndef SAL_VERSION_CHECK + #define SAL_VERSION_CHECK(_A) _SAL_VERSION_CHECK(_A) + #define SAL_VERSION_SAL2(_A) _SAL_VERSION_SAL2(_A) + #endif + +#endif // ] + +/* Begin compatibility fixes required for Win8/VS2012 RTM sal.h */ +#ifndef _SAL_L_Source_ + +// Some annotations aren't officially SAL2 yet. +#if _USE_ATTRIBUTES_FOR_SAL /*IFSTRIP=IGN*/ +#define _SAL_L_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _Group_(annotes _SAL_nop_impl_) +#else +#define _SAL_L_Source_(Name, args, annotes) _SA_annotes3(SAL_name, #Name, "", "2") _GrouP_(annotes _SAL_nop_impl_) +#endif + +#endif + +/* End compatibility fixes required for Win8/VS2012 RTM sal.h */ + +#include + +/* This version symbol is deprecated in favor of __SAL_H_VER */ +#ifndef __SAL_H_FULL_VER +#define __SAL_H_FULL_VER 140050727 +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/* version specific fixes to bring sal.h upto date */ +#if __SAL_H_FULL_VER <= 140050727 // [ + +#if !defined(__midl) && defined(_PREFAST_) && _MSC_VER >= 1000 // [ + +/* Missing from RTM sal.h */ +#define __inner_bound _SAL_L_Source_(__inner_bound, (), _SA_annotes0(SAL_bound)) +#define __inner_range(lb,ub) _SAL_L_Source_(__inner_range, (lb,ub), _SA_annotes2(SAL_range,lb,ub)) +#define __inner_assume_bound_dec __inline __nothrow void __AssumeBoundInt(_Post_ __inner_bound int i) {(void)i;} +#define __inner_assume_bound(i) __AssumeBoundInt(i); +#define __inner_allocator _SAL_L_Source_(__inner_allocater, (), _SA_annotes0(SAL_allocator)) + +#define __static_context(ctx, annotes) \ + _SAL_L_Source_(__static_context, (ctx, annotes), _SA_annotes1(SAL_context,ctx) _Group_(__nop_impl(annotes))) + +#define __failure(x) __static_context(SAL_return_convention, \ + _SAL_L_Source_(__failure, (x), _SA_annotes1(SAL_failure,x))) + +__ANNOTATION(SAL_valueUndefined(void)); +#define __valueUndefined _SAL_L_Source_(__valueUndefined, (), _SA_annotes0(SAL_valueUndefined)) + +enum __SAL_failureKind{__failureUnspecified = 0, __failureUndefined = 1}; + +__ANNOTATION(SAL_failureDefault(enum __SAL_failureKind)); +#define __failureDefault(kind) _SAL_L_Source_(__failureDefault, (kind), __static_context(SAL_return_convention, \ + _SA_annotes1(SAL_failureDefault,kind))) + +#else // ][ + +#define __inner_bound +#define __inner_range(lb,ub) +#define __inner_assume_bound_dec +#define __inner_assume_bound(i) +#define __inner_allocator + +#define __static_context(ctx, annotes) +#define __failure(x) +#define __valueUndefined +#define __failureDefault(x) + +#endif // ] + +#define __xcount(size) _SAL1_Source_(__xcount, (size), __notnull __inexpressible_writableTo(size)) +#define __in_xcount(size) _SAL1_Source_(__in_xcount, (size), __in _Pre_ __inexpressible_readableTo(size)) +#define __out_xcount(size) _SAL1_Source_(__out_xcount, (size), __xcount(size) _Post_ __valid __refparam) +#define __out_xcount_part(size,length) _SAL1_Source_(__out_xcount_part_, (size,length), __out_xcount(size) _Post_ __inexpressible_readableTo(length)) +#define __out_xcount_full(size) _SAL1_Source_(__out_xcount_full, (size), __out_xcount_part(size,size)) +#define __inout_xcount(size) _SAL1_Source_(__inout_xcount, (size), __out_xcount(size) _Pre_ __valid) +#define __inout_xcount_part(size,length) _SAL1_Source_(__inout_xcount_part, (size,length), __out_xcount_part(size,length) _Pre_ __valid _Pre_ __inexpressible_readableTo(length)) +#define __inout_xcount_full(size) _SAL1_Source_(__inout_xcount_full, (size), __inout_xcount_part(size,size)) +#define __xcount_opt(size) _SAL1_Source_(__xcount_opt, (size), __xcount(size) __exceptthat __maybenull) +#define __in_xcount_opt(size) _SAL1_Source_(__in_xcount_opt, (size), __in_xcount(size) __exceptthat __maybenull) +#define __out_xcount_opt(size) _SAL1_Source_(__out_xcount_opt, (size), __out_xcount(size) __exceptthat __maybenull) +#define __out_xcount_part_opt(size,length) _SAL1_Source_(__out_xcount_part_opt, (size,length), __out_xcount_part(size,length) __exceptthat __maybenull) +#define __out_xcount_full_opt(size) _SAL1_Source_(__out_xcount_full_opt, (size), __out_xcount_full(size) __exceptthat __maybenull) +#define __inout_xcount_opt(size) _SAL1_Source_(__inout_xcount_opt, (size), __inout_xcount(size) __exceptthat __maybenull) +#define __inout_xcount_part_opt(size,length) _SAL1_Source_(__inout_xcount_part_opt, (size, length), __inout_xcount_part(size,length) __exceptthat __maybenull) +#define __inout_xcount_full_opt(size) _SAL1_Source_(__inout_xcount_full_opt, (size), __inout_xcount_full(size) __exceptthat __maybenull) +#define __deref_xcount(size) _SAL1_Source_(__deref_xcount, (size), __ecount(1) _Post_ __elem_readableTo(1) _Post_ __deref __notnull _Post_ __deref __inexpressible_writableTo(size)) +#define __deref_in _SAL1_Source_(__deref_in, (), __in _Pre_ __deref __deref __readonly) +#define __deref_in_ecount(size) _SAL1_Source_(__deref_in_ecount, (size), __deref_in _Pre_ __deref __elem_readableTo(size)) +#define __deref_in_bcount(size) _SAL1_Source_(__deref_in_bcount, (size), __deref_in _Pre_ __deref __byte_readableTo(size)) +#define __deref_in_xcount(size) _SAL1_Source_(__deref_in_xcount, (size), __deref_in _Pre_ __deref __inexpressible_readableTo(size)) +#define __deref_out_xcount(size) _SAL1_Source_(__deref_out_xcount, (size), __deref_xcount(size) _Post_ __deref __valid __refparam) +#define __deref_out_xcount_part(size,length) _SAL1_Source_(__deref_out_xcount_part, (size,length), __deref_out_xcount(size) _Post_ __deref __inexpressible_readableTo(length)) +#define __deref_out_xcount_full(size) _SAL1_Source_(__deref_out_xcount_full, (size), __deref_out_xcount_part(size,size)) +#define __deref_out_xcount(size) _SAL1_Source_(__deref_out_xcount, (size), __deref_xcount(size) _Post_ __deref __valid __refparam) +#define __inout_xcount_opt(size) _SAL1_Source_(__inout_xcount_opt, (size), __inout_xcount(size) __exceptthat __maybenull) +#define __deref_xcount(size) _SAL1_Source_(__deref_xcount, (size), __ecount(1) _Post_ __elem_readableTo(1) _Post_ __deref __notnull _Post_ __deref __inexpressible_writableTo(size)) +#define __deref_in _SAL1_Source_(__deref_in, (), __in _Pre_ __deref __deref __readonly) +#define __deref_in_ecount(size) _SAL1_Source_(__deref_in_ecount, (size), __deref_in _Pre_ __deref __elem_readableTo(size)) +#define __deref_in_bcount(size) _SAL1_Source_(__deref_in_bcount, (size), __deref_in _Pre_ __deref __byte_readableTo(size)) +#define __deref_in_xcount(size) _SAL1_Source_(__deref_in_xcount, (size), __deref_in _Pre_ __deref __inexpressible_readableTo(size)) +#define __deref_out_xcount(size) _SAL1_Source_(__deref_out_xcount, (size), __deref_xcount(size) _Post_ __deref __valid __refparam) +#define __deref_out_xcount_part(size,length) _SAL1_Source_(__deref_out_xcount_part, (size,length), __deref_out_xcount(size) _Post_ __deref __inexpressible_readableTo(length)) +#define __deref_out_xcount_full(size) _SAL1_Source_(__deref_out_xcount_full, (size), __deref_out_xcount_part(size,size)) +#define __deref_out_xcount(size) _SAL1_Source_(__deref_out_xcount, (size), __deref_xcount(size) _Post_ __deref __valid __refparam) +#define __deref_inout_xcount(size) _SAL1_Source_(__deref_inout_xcount, (size), __deref_inout _Pre_ __deref __inexpressible_writableTo(size) _Post_ __deref __inexpressible_writableTo(size)) +#define __deref_inout_xcount_part(size,length) _SAL1_Source_(__deref_inout_xcount_part, (size,length), __deref_inout_xcount(size) _Pre_ __deref __inexpressible_readableTo(length) _Post_ __deref __inexpressible_readableTo(length)) +#define __deref_inout_xcount_full(size) _SAL1_Source_(__deref_inout_xcount_full, (size), __deref_inout_xcount_part(size,size)) +#define __deref_xcount_opt(size) _SAL1_Source_(__deref_xcount_opt, (size), __deref_xcount(size) _Post_ __deref __exceptthat __maybenull) +#define __deref_in_opt _SAL1_Source_(__deref_in_opt, (), __deref_in _Pre_ __deref __exceptthat __maybenull) +#define __deref_in_opt_out _SAL1_Source_(__deref_in_opt_out, (), __deref_inout _Pre_ __deref __exceptthat __maybenull _Post_ __deref __notnull) +#define __deref_in_ecount_opt(size) _SAL1_Source_(__deref_in_ecount_opt, (size), __deref_in_ecount(size) _Pre_ __deref __exceptthat __maybenull) +#define __deref_in_bcount_opt(size) _SAL1_Source_(__deref_in_bcount_opt_, (size), __deref_in_bcount(size) _Pre_ __deref __exceptthat __maybenull) +#define __deref_in_xcount_opt(size) _SAL1_Source_(__deref_in_xcount_opt, (size), __deref_in_xcount(size) _Pre_ __deref __exceptthat __maybenull) +#define __deref_out_xcount_opt(size) _SAL1_Source_(__deref_out_xcount_opt, (size), __deref_out_xcount(size) _Post_ __deref __exceptthat __maybenull) +#define __deref_out_xcount_part_opt(size,length) _SAL1_Source_(__deref_out_xcount_part_opt, (size,length), __deref_out_xcount_part(size,length) _Post_ __deref __exceptthat __maybenull) +#define __deref_out_xcount_full_opt(size) _SAL1_Source_(__deref_out_xcount_full_opt, (size), __deref_out_xcount_full(size) _Post_ __deref __exceptthat __maybenull) +#define __deref_inout_xcount_opt(size) _SAL1_Source_(__deref_inout_xcount_opt, (size), __deref_inout_xcount(size) _Pre_ __deref __exceptthat __maybenull _Post_ __deref __exceptthat __maybenull) +#define __deref_inout_xcount_part_opt(size,length) _SAL1_Source_(__deref_inout_xcount_part_opt, (size,length), __deref_inout_xcount_part(size,length) _Pre_ __deref __exceptthat __maybenull _Post_ __deref __exceptthat __maybenull) +#define __deref_inout_xcount_full_opt(size) _SAL1_Source_(__deref_inout_xcount_full_opt, (size), __deref_inout_xcount_full(size) _Pre_ __deref __exceptthat __maybenull _Post_ __deref __exceptthat __maybenull) +#define __deref_opt_xcount(size) _SAL1_Source_(__deref_opt_xcount, (size), __deref_xcount(size) __exceptthat __maybenull) +#define __deref_opt_in _SAL1_Source_(__deref_opt_in, (), __deref_in __exceptthat __maybenull) +#define __deref_opt_in_ecount(size) _SAL1_Source_(__deref_opt_in_ecount, (size), __deref_in_ecount(size) __exceptthat __maybenull) +#define __deref_opt_in_bcount(size) _SAL1_Source_(__deref_opt_in_bcount, (size), __deref_in_bcount(size) __exceptthat __maybenull) +#define __deref_opt_in_xcount(size) _SAL1_Source_(__deref_opt_in_xcount, (size), __deref_in_xcount(size) __exceptthat __maybenull) +#define __deref_opt_out_xcount(size) _SAL1_Source_(__deref_opt_out_xcount, (size), __deref_out_xcount(size) __exceptthat __maybenull) +#define __deref_opt_out_xcount_part(size,length) _SAL1_Source_(__deref_opt_out_xcount_part, (size,length), __deref_out_xcount_part(size,length) __exceptthat __maybenull) +#define __deref_opt_out_xcount_full(size) _SAL1_Source_(__deref_opt_out_xcount_full, (size), __deref_out_xcount_full(size) __exceptthat __maybenull) +#define __deref_opt_inout_xcount(size) _SAL1_Source_(__deref_opt_inout_xcount, (size), __deref_inout_xcount(size) __exceptthat __maybenull) +#define __deref_opt_inout_xcount_part(size,length) _SAL1_Source_(__deref_opt_inout_xcount_part, (size,length), __deref_inout_xcount_part(size,length) __exceptthat __maybenull) +#define __deref_opt_inout_xcount_full(size) _SAL1_Source_(__deref_opt_inout_xcount_full, (size), __deref_inout_xcount_full(size) __exceptthat __maybenull) +#define __deref_opt_xcount_opt(size) _SAL1_Source_(__deref_opt_xcount_opt, (size), __deref_xcount_opt(size) __exceptthat __maybenull) +#define __deref_opt_in_opt _SAL1_Source_(__deref_opt_in_opt, (), __deref_in_opt __exceptthat __maybenull) +#define __deref_opt_in_ecount_opt(size) _SAL1_Source_(__deref_opt_in_ecount_opt, (size), __deref_in_ecount_opt(size) __exceptthat __maybenull) +#define __deref_opt_in_bcount_opt(size) _SAL1_Source_(__deref_opt_in_bcount_opt, (size), __deref_in_bcount_opt(size) __exceptthat __maybenull) +#define __deref_opt_in_xcount_opt(size) _SAL1_Source_(__deref_opt_in_xcount_opt, (size), __deref_in_xcount_opt(size) __exceptthat __maybenull) +#define __deref_opt_out_xcount_opt(size) _SAL1_Source_(__deref_opt_out_xcount_opt, (size), __deref_out_xcount_opt(size) __exceptthat __maybenull) +#define __deref_opt_out_xcount_part_opt(size,length) _SAL1_Source_(__deref_opt_out_xcount_part_opt, (size,length), __deref_out_xcount_part_opt(size,length) __exceptthat __maybenull) +#define __deref_opt_out_xcount_full_opt(size) _SAL1_Source_(__deref_opt_out_scount_full_opt, (size), __deref_out_xcount_full_opt(size) __exceptthat __maybenull) +#define __deref_opt_inout_xcount_opt(size) _SAL1_Source_(__deref_opt_inout_xcount_opt, (size), __deref_inout_xcount_opt(size) __exceptthat __maybenull) +#define __deref_opt_inout_xcount_part_opt(size,length) _SAL1_Source_(__deref_inout_xcount_part_opt(size, (size,length), length) __exceptthat __maybenull) +#define __deref_opt_inout_xcount_full_opt(size) _SAL1_Source_(__deref_opt_inout_scount_full_opt, (size), __deref_inout_xcount_full_opt(size) __exceptthat __maybenull) + +#define __deref_in_ecount_iterator(size, incr) _SAL1_Source_(__deref_in_ecount_iterator, (size,incr), __inout _Pre_ __deref __elem_readableTo(size) __deref_out_range(==, _Old_(*_Curr_) + incr)) +#define __deref_out_ecount_iterator(size, incr) _SAL1_Source_(__deref_out_ecount_iterator, (size,incr), __inout _Pre_ __deref __elem_writableTo(size) __deref_out_range(==, _Old_(*_Curr_) + incr)) +#define __deref_inout_ecount_iterator(size, incr) _SAL1_Source_(__deref_inout_ecount_iterator, (size,incr), __inout _Pre_ __deref __elem_readableTo(size) _Pre_ __deref __elem_writableTo(size) __deref_out_range(==, _Old_(*_Curr_) + incr)) + +#define __post_bcount(size) _SAL1_Source_(__post_bcount, (size), _Post_ __byte_writableTo(size)) +#define __post_ecount(size) _SAL1_Source_(__post_ecount, (size), _Post_ __elem_writableTo(size)) + +#define __deref_realloc_bcount(insize, outsize) _SAL1_Source_(__deref_realloc_bcount, (insize,outsize), __inout _Pre_ __deref __byte_readableTo(insize) _Post_ __deref __byte_writableTo(outsize)) + +/* __in_ecount_or_z(c) specifies semantics like strncmp, where a string + * parameter is either null terminated, or valid up to c elements. + */ +#define __in_ecount_or_z(c) _SAL1_Source_(__in_ecount_or_z, (c), _When_(_String_length_(_Curr_) < (c), __in_z) \ + _When_(_String_length_(_Curr_) >= (c), __in_ecount(c))) + + +/* Provide default definition to be overridden when needed */ +#define __post_nullnullterminated + +/* Must protect redfinitions of macros to workaround rc.exe issues. */ +#ifndef RC_INVOKED // [ + +#undef __nullnullterminated +#define __nullnullterminated _SAL1_Source_(__nullnullterminated, (), __inexpressible_readableTo("string terminated by two nulls") __nullterminated) + +#undef __post_nullnullterminated +#define __post_nullnullterminated _SAL1_Source_(__post_nullnullterminated, (), _Post_ __inexpressible_readableTo("string terminated by two nulls") _Post_ __nullterminated) + +#endif // ] +#endif //__SAL_H_FULL_VER <= 140050727 // ] + +/************************************************************************ + New extensions to sal.h follow here. +*************************************************************************/ + +#if (_MSC_VER >= 1000) && !defined(__midl) && defined(_PREFAST_) // [ + +#define __file_parser(typ) _SAL_L_Source_(__file_parser, (typ), _SA_annotes2(SAL_file_parser,"function",typ)) +#define __file_parser_class(typ) _SAL_L_Source_(__file_parser_class, (typ), _SA_annotes2(SAL_file_parser,"class",typ)) +#define __file_parser_library(typ) extern int _SAL_L_Source_(__file_parser_library, (typ), _SA_annotes2(SAL_file_parser, "library", typ)) __iSALFileParserLibrary##typ; +#define __source_code_content(typ) extern int _SAL_L_Source_(__source_code_content, (typ), _SA_annotes1(SAL_source_code_content, typ)) __iSAL_Source_Code_Content##typ; +#define __class_code_content(typ) _SAL_L_Source_(__class_code_content, (typ), _SA_annotes1(SAL_class_code_content, typ)) +#define __analysis_assert(e) __assume(e) +#define __analysis_hint(hint) _SAL_L_Source_(__analysis_hint, (hint), _SA_annotes1(SAL_analysisHint, hint)) +// For "breakpoint": doesn't return as far as analysis is concerned. +#define __analysis_noreturn __declspec(noreturn) +/* Internal defintions */ +#define __inner_data_source(src_raw) _SAL_L_Source_(__inner_data_source, (src_raw), _SA_annotes1(SAL_untrusted_data_source,src_raw)) +#define __inner_this_data_source(src_raw) _SAL_L_Source_(__inner_this_data_source, (src_raw), _SA_annotes1(SAL_untrusted_data_source_this,src_raw)) +#define __inner_out_validated(typ_raw) _SAL_L_Source_(__inner_out_validated, (typ_raw), _Post_ _SA_annotes1(SAL_validated,typ_raw)) +#define __inner_this_out_validated(typ_raw) _SAL_L_Source_(__inner_this_out_validated, (typ_raw), _SA_annotes1(SAL_validated_this,typ_raw)) +#define __inner_assume_validated_dec __inline __nothrow void __AssumeValidated(__inner_out_validated("BY_DESIGN") const void *p) {(void)p;} +#define __inner_assume_validated(p) __AssumeValidated(p) +#define __inner_transfer(formal) _SAL_L_Source_(__inner_transfer, (formal), _SA_annotes1(SAL_transfer_adt_property_from,formal)) +#define __inner_encoded _SAL_L_Source_(__inner_encoded, (), _SA_annotes0(SAL_encoded)) + +#if defined(_MSC_EXTENSIONS) || defined(_PREFAST_) || defined(OACR) // [ +#define __inner_adt_prop(adt,prop) _SAL_L_Source_(__inner_adt_prop, (adt,prop), _SA_annotes2(SAL_adt, adt,prop)) +#define __inner_adt_add_prop(adt,prop) _SAL_L_Source_(__inner_adt_add_prop, (adt,prop), _SA_annotes2(SAL_add_adt_property,adt,prop)) +#define __inner_adt_remove_prop(adt,prop) _SAL_L_Source_(__inner_adt_remove_prop, (adt,prop), _SA_annotes2(SAL_remove_adt_property,adt,prop)) +#define __inner_adt_transfer_prop(arg) _SAL_L_Source_(__inner_adt_trasnfer_prop, (arg), _SA_annotes1(SAL_transfer_adt_property_from,arg)) +#define __inner_adt_type_props(typ) _SAL_L_Source_(__inner_adt_type_props, (typ), _SA_annotes1(SAL_post_type,typ)) +#define __inner_volatile _SAL_L_Source_(__inner_volatile, (), _SA_annotes0(SAL_volatile)) +#define __inner_nonvolatile _SAL_L_Source_(__inner_nonvolatile, (), _SA_annotes0(SAL_nonvolatile)) +#define __inner_possibly_notnullterminated _SAL_L_Source_(__inner_possibly_notnulltermiated, (), _SA_annotes1(SAL_nullTerminated,__maybe)) +#endif // ] + +/////////////////////////////////////////////////////////////////////////////// +// +// Low Level Memory Correctness annotations +// +// These are the implementation details for the Memory Correctness annotations +// that support checking of kernel/user memory handling within kernel mode code. +// +/////////////////////////////////////////////////////////////////////////////// + +// +// The enum that defines the types of memory context that exist in the system. +// +enum _SAL_ExecutionContext { SAL_KernelMode, SAL_UserMode }; + +// +// temporary hack: Globals that stand in for the globally available SAL-pseudo-variables +// _Current_execution_context_ and _Previous_execution_context_. NMM will need to be modified +// to offer these. +// +enum _SAL_ExecutionContext _Previous_execution_context_; +enum _SAL_ExecutionContext _Current_execution_context_; + +// +// Annotation elements that support the memory origin concept. +// The "When" variant is a hack for now until NMM can parse _Previous_execution_context_ +// and _Current_execution_context_ +// +__ANNOTATION(SAL_MemoryOrigin(__In_impl_ enum _SAL_ExecutionContext);) +__ANNOTATION(SAL_MemoryOriginWhen(__In_impl_ enum _SAL_ExecutionContext, __In_impl_ enum _SAL_ExecutionContext);) + +#define _Memory_origin_(context) _SAL2_Source_(_Memory_origin_, (context), _SA_annotes1(SAL_MemoryOrigin, context)) +#define _Memory_origin_when_(previousContext, context) _SAL2_Source_(_Memory_origin_when_, (previousContext, context), _SA_annotes2(SAL_MemoryOriginWhen, previousContext, context)) + + +// +// Annotation elements that support the memory accessibility concept. +// The "When" variant is a hack for new until NMM can parse _Previous_execution_context_ +// and _Current_execution_context_ +// +__ANNOTATION(SAL_AccessibleTo(__In_impl_ enum _SAL_ExecutionContext, __In_impl_ __int64 count);) +__ANNOTATION(SAL_AccessibleToWhen(__In_impl_ enum _SAL_ExecutionContext, __In_impl_ enum _SAL_ExecutionContext, __In_impl_ __int64 count);) + +#define _Accessible_bytes_(context, expr) _SAL2_Source_(_Accessible_bytes_, (context, expr), _SA_annotes2(SAL_AccessibleTo, context, expr)) +#define _Accessible_bytes_when_(previousContext, context, expr) _SAL2_Source_(_Accessible_bytes_when_, (context, previousContext, expr), _SA_annotes3(SAL_AccessibleToWhen, context, previousContext, expr)) +#define _Pre_accessible_bytes_(context, expr) _Pre_ _Accessible_bytes_(context, expr) +#define _Pre_accessible_bytes_when_(context, previousContext, expr) _Pre_ _Accessible_bytes_when_(context, previousContext, expr) + + +/////////////////////////////////////////////////////////////////////////////// +// +// High Level Memory Correctness annotations +// +// These annotations form the expected interface for users to the Memory Correctness +// annotations that support checking of kernel/user memory handling within +// kernel mode code. +// +/////////////////////////////////////////////////////////////////////////////// +#define _User_ _Memory_origin_when_(SAL_UserMode, SAL_UserMode) _Pre_accessible_bytes_when_(SAL_UserMode, SAL_KernelMode, 0) +#define _User_on_(expr) _When_((expr) != SAL_KernelMode, _User_always_) +#define _User_always_ _Memory_origin_(SAL_UserMode) _Pre_accessible_bytes_(SAL_KernelMode, 0) +#define _User_always_and_needs_probe_on_(mode) _User_always_ _Pre_accessible_bytes_when_(SAL_UserMode, SAL_KernelMode, 0) _Pre_satisfies_(mode == _Previous_execution_context_) +#define _Kernel_entry_ _SAL2_Source_(_Kernel_entry_, (), __inner_control_entrypoint(UserToKernel)) +#define _Kernel_entry_always_ _SAL2_Source_(_Kernel_entry_, (), __inner_control_entrypoint(UserToKernel)) _Pre_satisfies_(_Previous_execution_context_ == SAL_UserMode) + + +#else // ][ + +#define __file_parser(typ) +#define __file_parser_class(typ) +#define __file_parser_library(typ) +#define __source_code_content(typ) +#define __class_code_content(typ) +#define __analysis_assert(e) +#define __analysis_hint(hint) +#define __analysis_noreturn +/* Internal defintions */ +#define __inner_data_source(src_raw) +#define __inner_this_data_source(src_raw) +#define __inner_out_validated(typ_raw) +#define __inner_this_out_validated(typ_raw) +#define __inner_assume_validated_dec +#define __inner_assume_validated(p) +#define __inner_transfer(formal) +#define __inner_encoded +#define __inner_adt_prop(adt,prop) +#define __inner_adt_add_prop(adt,prop) +#define __inner_adt_remove_prop(adt,prop) +#define __inner_adt_transfer_prop(arg) +#define __inner_adt_type_props(typ) +#define __inner_volatile +#define __inner_nonvolatile +#define __inner_possibly_notnullterminated + +/////////////////////////////////////////////////////////////////////////////// +// +// Low Level Memory Correctness annotations +// +// These are the implementation details for the Memory Correctness annotations +// that support checking of kernel/user memory handling within kernel mode code. +// +/////////////////////////////////////////////////////////////////////////////// +#define _Memory_origin_(context) +#define _Memory_origin_when_(previousContext, context) +#define _Accessible_bytes_(context, expr) +#define _Accessible_bytes_when_(previousContext, context, expr) +#define _Pre_accessible_bytes_(context, expr) +#define _Pre_accessible_bytes_when_(context, previousContext, expr) + + +/////////////////////////////////////////////////////////////////////////////// +// +// High Level Memory Correctness annotations +// +// These annotations form the expected interface for users to the Memory Correctness +// annotations that support checking of kernel/user memory handling within +// kernel mode code. +// +/////////////////////////////////////////////////////////////////////////////// +#define _User_ +#define _User_on_(expr) +#define _User_always_ +#define _User_always_and_needs_probe_on_(mode) +#define _Kernel_entry_ +#define _Kernel_entry_always_ + +#endif // ] // #if (_MSC_VER >= 1000) && !defined(__midl) && defined(_PREFAST_) + +#define __field_ecount(size) _SAL1_Source_(__field_ecount, (size), __notnull __elem_writableTo(size)) +#define __field_bcount(size) _SAL1_Source_(__field_bcount, (size), __notnull __byte_writableTo(size)) +#define __field_xcount(size) _SAL1_Source_(__field_xcount, (size), __notnull __inexpressible_writableTo(size)) + +#define __field_ecount_opt(size) _SAL1_Source_(__field_ecount_opt, (size), __maybenull __elem_writableTo(size)) +#define __field_bcount_opt(size) _SAL1_Source_(__field_bcount_opt, (size), __maybenull __byte_writableTo(size)) +#define __field_xcount_opt(size) _SAL1_Source_(__field_xcount_opt, (size), __maybenull __inexpressible_writableTo(size)) + +#define __field_ecount_part(size,init) _SAL1_Source_(__field_ecount_part, (size,init), __notnull __elem_writableTo(size) __elem_readableTo(init)) +#define __field_bcount_part(size,init) _SAL1_Source_(__field_bcount_part, (size,init), __notnull __byte_writableTo(size) __byte_readableTo(init)) +#define __field_xcount_part(size,init) _SAL1_Source_(__field_xcount_part, (size,init), __notnull __inexpressible_writableTo(size) __inexpressible_readableTo(init)) + +#define __field_ecount_part_opt(size,init) _SAL1_Source_(__field_ecount_part_opt, (size,init), __maybenull __elem_writableTo(size) __elem_readableTo(init)) +#define __field_bcount_part_opt(size,init) _SAL1_Source_(__field_bcount_part_opt, (size,init), __maybenull __byte_writableTo(size) __byte_readableTo(init)) +#define __field_xcount_part_opt(size,init) _SAL1_Source_(__field_xcount_part_opt, (size,init), __maybenull __inexpressible_writableTo(size) __inexpressible_readableTo(init)) + +#define __field_ecount_full(size) _SAL1_Source_(__field_ecount_full, (size), __field_ecount_part(size,size)) +#define __field_bcount_full(size) _SAL1_Source_(__field_bcount_full, (size), __field_bcount_part(size,size)) +#define __field_xcount_full(size) _SAL1_Source_(__field_xcount_full, (size), __field_xcount_part(size,size)) + +#define __field_ecount_full_opt(size) _SAL1_Source_(__field_ecount_full_opt, (size), __field_ecount_part_opt(size,size)) +#define __field_bcount_full_opt(size) _SAL1_Source_(__field_bcount_full_opt, (size), __field_bcount_part_opt(size,size)) +#define __field_xcount_full_opt(size) _SAL1_Source_(__field_xcount_full_opt, (size), __field_xcount_part_opt(size,size)) + +#define __field_nullterminated _SAL1_Source_(__field_nullterminated, (), __nullterminated) + +#define __struct_bcount(size) _SAL1_Source_(__struct_bcount, (size), __byte_writableTo(size)) +#define __struct_xcount(size) _SAL1_Source_(__struct_xcount, (size), __inexpressible_writableTo(size)) + +#define __out_awcount(expr,size) _SAL1_Source_(__out_awcount, (expr,size), _Pre_ __notnull \ + __byte_writableTo((expr) ? (size) : (size) * 2) \ + _Post_ __valid __refparam) +#define __in_awcount(expr,size) _SAL1_Source_(__in_awcount, (expr,size), _Pre_ __valid \ + _Pre_ _Notref_ __deref __readonly \ + __byte_readableTo((expr) ? (size) : (size) * 2)) +#define __post_invalid _SAL1_Source_(__post_invalid, (), _Post_ __notvalid) +/* integer related macros */ +#define __allocator _SAL_L_Source_(__allocator, (), __inner_allocator) +#define __deallocate(kind) _SAL_L_Source_(__deallocate, (kind), _Pre_ __notnull __post_invalid) +#define __deallocate_opt(kind) _SAL_L_Source_(__deallocate_opt, (kind), _Pre_ __maybenull __post_invalid) +#define __bound _SAL_L_Source_(__bound, (), __inner_bound) +#define __range(lb,ub) _SAL_L_Source_(__range, (lb,ub), __inner_range(lb,ub)) +#define __in_bound _SAL_L_Source_(__in_bound, (), _Pre_ __inner_bound) +#define __out_bound _SAL_L_Source_(__out_bound, (), _Post_ __inner_bound) +#define __deref_out_bound _SAL_L_Source_(__deref_out_bound, (), _Post_ __deref __inner_bound) +#define __in_range(lb,ub) _SAL_L_Source_(__in_range, (lb,ub), _Pre_ __inner_range(lb,ub)) +#define __out_range(lb,ub) _SAL_L_Source_(__out_range, (lb,ub), _Post_ __inner_range(lb,ub)) +#define __deref_in_range(lb,ub) _SAL_L_Source_(__deref_in_range, (lb,ub), _Pre_ __deref __inner_range(lb,ub)) +#define __deref_out_range(lb,ub) _SAL_L_Source_(__deref_out_range, (lb,ub), _Post_ __deref __inner_range(lb,ub)) +#define __deref_inout_range(lb,ub) _SAL_L_Source_(__deref_inout_range, (lb,ub), __deref_in_range(lb,ub) __deref_out_range(lb,ub)) +#define __field_range(lb,ub) _SAL_L_Source_(__field_range, (lb,ub), __range(lb,ub)) +#define __field_data_source(src_sym) _SAL_L_Source_(__field_data_source, (lb,ub), __inner_data_source(#src_sym)) + +#define __range_max(a,b) _SAL_L_Source_(__range_max, (a,b), __range(==, a > b ? a : b)) +#define __range_min(a,b) _SAL_L_Source_(__range_min, (a,b), __range(==, a < b ? a : b)) + + +/* Penetration review macros */ +#define __in_data_source(src_sym) _SAL_L_Source_(__in_data_source, (src_sym), _Pre_ __inner_data_source(#src_sym)) +#define __out_data_source(src_sym) _SAL_L_Source_(__out_data_source, (src_sym), _Post_ __inner_data_source(#src_sym)) +#define __out_validated(typ_sym) _SAL_L_Source_(__out_validated, (src_sym), __inner_out_validated(#typ_sym)) +#define __this_out_data_source(src_sym) _SAL_L_Source_(__this_out_data_source, (src_sym), __inner_this_data_source(#src_sym)) +#define __this_out_validated(typ_sym) _SAL_L_Source_(__this_out_validated, (src_sym), __inner_this_out_validated(#typ_sym)) +#define __transfer(formal) _SAL_L_Source_(__transfer, (src_sym), _Post_ __inner_transfer(formal)) +#define __rpc_entry _SAL_L_Source_(__rpc_entry, (formal), __inner_control_entrypoint(RPC)) +#define __kernel_entry _SAL_L_Source_(__kernel_entry, (), __inner_control_entrypoint(UserToKernel)) +#define __gdi_entry _SAL_L_Source_(__gdi_entry, (), __inner_control_entrypoint(GDI)) +#define __encoded_pointer _SAL_L_Source_(__encoded_pointer, (), __inner_encoded) +#define __encoded_array _SAL_L_Source_(__encoded_array, (), __inner_encoded) +#define __field_encoded_pointer _SAL_L_Source_(__field_encoded_pointer, (), __inner_encoded) +#define __field_encoded_array _SAL_L_Source_(__field_encoded_array, (), __inner_encoded) +#if defined(_MSC_EXTENSIONS) || defined(_PREFAST_) || defined(OACR) // [ +#define __type_has_adt_prop(adt,prop) _SAL_L_Source_(__type_has_adt_prop, (adt,prop), __inner_adt_prop(adt,prop)) +#define __out_has_adt_prop(adt,prop) _SAL_L_Source_(__out_has_adt_prop, (adt,prop), _Post_ __inner_adt_add_prop(adt,prop)) +#define __out_not_has_adt_prop(adt,prop) _SAL_L_Source_(__out_not_has_adt_prop, (adt,prop), _Post_ __inner_adt_remove_prop(adt,prop)) +#define __out_transfer_adt_prop(arg) _SAL_L_Source_(__out_transfer_adt_prop, (arg), _Post_ __inner_adt_transfer_prop(arg)) +#define __out_has_type_adt_props(typ) _SAL_L_Source_(__out_has_type_adt_props, (typ), _Post_ __inner_adt_type_props(typ)) + +/* useful PFD related macros */ +#define __possibly_notnullterminated _SAL_L_Source_(__possibly_notnullterminated, (), __inner_possibly_notnullterminated) + +/* Windows Internal */ +#define __volatile _SAL_L_Source_(__volatile, (), __inner_volatile) +#define __nonvolatile _SAL_L_Source_(__nonvolatile, (), __inner_nonvolatile) +#else +#define __out_has_type_adt_props(typ) /* nothing */ +#endif +#define __deref_volatile _SAL_L_Source_(__deref_volatile, (), __deref __volatile) +#define __deref_nonvolatile _SAL_L_Source_(__deref_nonvolatile, (), __deref __nonvolatile) + +/* declare stub functions for macros */ +__inner_assume_validated_dec +__inner_assume_bound_dec +#define __analysis_assume_nullterminated(x) _Analysis_assume_nullterminated_(x) +#define __assume_validated(p) __inner_assume_validated(p) +#define __assume_bound(i) __inner_assume_bound(i) + + +/************************************************************************** +* SAL 2 extensions for Windows-specific APIs. +***************************************************************************/ + +// Annotation for parameters that are not used in any way by the function. +// Unlike _Reserved_, an _Unreferenced_parameter_ pointer need not be NULL. +#ifndef _Unreferenced_parameter_ +#define _Unreferenced_parameter_ _SAL2_Source_(_Unreferenced_parameter_, (), _Const_) +#endif + +// Pointer parameters that are freed by the function, and thus the pointed-to +// memory should not be used after return. +#ifndef _Frees_ptr_ +#define _Frees_ptr_ _SAL_L_Source_(_Frees_ptr_, (), _Pre_notnull_ _Post_ptr_invalid_ __drv_freesMem(Mem)) +#endif +#ifndef _Frees_ptr_opt_ +#define _Frees_ptr_opt_ _SAL_L_Source_(_Frees_ptr_opt_, (), _Pre_maybenull_ _Post_ptr_invalid_ __drv_freesMem(Mem)) +#endif + + +// Functions which behave like realloc in that they may succeed by +// freeing one block of memory and allocating another, or may fail, in +// which case the original block is still valid, or may be used to +// free memory directly by requesting that the new block is of size +// zero. We do not say here whether the before may be null, we leave +// that to the annotation on the argument +#define _Reallocation_function_(after, before, size) \ + _Success_((after) != NULL || (size) == 0) \ + _At_((after), _Post_maybenull_ _Post_writable_byte_size_(size) \ + _When_(((before) == NULL || (size) > 0), _Must_inspect_result_)) \ + _At_((before), _Post_ptr_invalid_ __drv_freesMem(Mem)) + +#define _Ret_reallocated_bytes_(before, size) \ + _Reallocation_function_(_Curr_, before, size) + + +// NLS APIs allow strings to be specified either by an element count or +// null termination. Unlike _In_reads_or_z_, this is not whichever comes +// first, but based on whether the size is negative or not. +#define _In_NLS_string_(size) _SAL_L_Source_(_In_NLS_string_, (size), _When_((size) < 0, _In_z_) \ + _When_((size) >= 0, _In_reads_(size))) + + +// Minifilter CompletionContext parameters on the pre-operation callback +// default to NULL. For return type FLT_PREOP_SUCCESS_WITH_CALLBACK or +// FLT_PREOP_SYNCHRONIZE, it may be set to NULL or a valid pointer. For all +// other returns, it must be NULL. +#define _Flt_CompletionContext_Outptr_ \ + _SAL_L_Source_(_Flt_CompletionContext_Outptr_, (), _Outptr_result_maybenull_ _Pre_valid_ \ + _At_(*_Curr_, _Pre_null_ \ + _When_(return != FLT_PREOP_SUCCESS_WITH_CALLBACK && return != FLT_PREOP_SYNCHRONIZE, _Post_null_))) + +// Minifilter ConnectionCookie parameters on the port connect notify callback +// default to NULL. On successful return, it may be set to NULL or non-NULL, +// but it must be NULL on failure. +#define _Flt_ConnectionCookie_Outptr_ \ + _SAL_L_Source_(_Flt_ConnectionCookie_Outptr_, (), _Outptr_result_maybenull_ _Pre_valid_ \ + _At_(*_Curr_, _Pre_null_ _On_failure_(_Post_null_))) + + +// +// A common pattern is to pass an "_Inout_ PCHAR* ppBuf" of size "_Inout_ DWORD* pSize" +// to a function that writes to **pBuf, incrementing *ppBuf to point to one +// past the last written byte. Thus the length of the write is +// (*ppBuf - Old(*ppBuf)). The size of the remaining unwritten capacity +// is written to *pSize. +// +// This pattern is frequently used when progressively filling a +// large buffer in chunks +// (e.g. when reading from a network interface in a driver). +// +// It is expected that these supplementary annotations would be used inside an +// _At_, like so: +// +// _At_(*ppBuf, _Writes_and_advances_ptr_(*pBufSize)) +// HRESULT WriteChunkOfData(_Inout_ PCHAR* ppBuf, _Inout_ DWORD* pBufSize); +// +#ifndef _Writes_and_advances_ptr_ // [ +#define _Writes_and_advances_ptr_(size) \ + _SAL2_Source_(_Writes_and_advances_ptr_, (size), _At_((void*)_Curr_, _Inout_) \ + _At_(_Curr_, \ + _Pre_writable_size_(size) \ + _Post_writable_size_(size) \ + _Post_satisfies_(_Curr_ - _Old_(_Curr_) == _Old_(size) - size)) \ + _At_(_Old_(_Curr_), \ + _Post_readable_size_(_Old_(size) - size))) +#endif // ] + +#ifndef _Writes_bytes_and_advances_ptr_ // [ +#define _Writes_bytes_and_advances_ptr_(size) \ + _SAL2_Source_(_Writes_bytes_and_advances_ptr, (size), _At_((void*)_Curr_, _Inout_) \ + _At_(_Curr_, \ + _Pre_writable_byte_size_(size) \ + _Post_writable_byte_size_(size) \ + _Post_satisfies_(((char*)_Curr_) - ((char*)_Old_(_Curr_)) == _Old_(size) - size)) \ + _At_(_Old_(_Curr_), \ + _Post_readable_byte_size_(_Old_(size) - size))) +#endif // ] + +// +// Gets the current error code (as returned by GetLastError()), and stores +// in _Curr_ as a postcondition. This is currently approximated by assuming +// that GetLastError() always returns a failed error code. This is not a +// completely accurate approximation, but reasonable. +// +#define _Post_equals_last_error_ _SAL2_Source_(_Post_equals_last_error_, (), _Post_satisfies_(_Curr_ != 0)) + +// +// Indicates the function simply translates the given Win32 error code into an HRESULT +// with broadly the same semantics as HRESULT_FROM_WIN32(). +// +// This convenience macro allows analyzers to understand the many bespoke error-translation +// functions as simple translators that can be treated as equivalent to HRESULT_FROM_WIN32(). +// This results in fewer false positives and unnecessary path explorations. This is because +// for analysis, the specific translations rarely matter, it is more important to know the +// that function cannot fail and the conditions under which it will return an error-range +// HRESULT and when a success-range HRESULT. +// +#ifndef _Translates_Win32_to_HRESULT_ // [ + +#define _Translates_Win32_to_HRESULT_(errorCode) \ + _SAL2_Source_(_Translates_Win32_to_HRESULT_, (errorCode), \ + _Always_( \ + _When_((HRESULT)errorCode <= 0, \ + _At_(_Curr_, _Post_equal_to_((HRESULT)errorCode))) \ + _When_((HRESULT)errorCode > 0, \ + _At_(_Curr_, _Post_equal_to_((HRESULT)((errorCode & 0x0000FFFF) | (FACILITY_WIN32 << 16) | 0x80000000)))))) + +#endif // ] + +// +// Indicates the function just directly translates the given NTSTATUS error code into an HRESULT. +// +// This convenience macro allows analyzers to understand the many bespoke error-translation +// functions as simple translators that can be treated as equivalent to HRESULT_FROM_NT(). +// This results in fewer false positives and unnecessary path explorations. This is because +// for analysis, the specific translations rarely matter. +// +#ifndef _Translates_NTSTATUS_to_HRESULT_ // [ + +#define _Translates_NTSTATUS_to_HRESULT_(status) \ + _SAL2_Source_(_Translates_NTSTATUS_to_HRESULT_, (status), \ + _Always_( \ + _Post_equal_to_((HRESULT)(status | FACILITY_NT_BIT)))) + +#endif // ] + +// +// Indicates the funtion just translates the result of GetLastError() into an HRESULT. +// +// This convenience macro allows analyzers to understand the many bespoke GetLastError-translation +// functions as simple translators that will always return a failure-value HRESULT (these functions +// are almost never meant to be called when GetLastError() could return 0). +// This results in fewer false positives and unnecessary path explorations. This is because +// for analysis, the specific translations rarely matter. +// +#ifndef _Translates_last_error_to_HRESULT_ // [ + +#define _Translates_last_error_to_HRESULT_ \ + _SAL2_Source_(_Translates_last_error_to_HRESULT_, (), \ + _Always_( \ + _Post_satisfies_(_Curr_ < 0))) + +#endif // ] + +#ifdef __cplusplus +} +#endif + +#ifdef _PREFIX_ // [ +/************************************************************************** +* Defintion of __pfx_assume and __pfx_assert. Thse should be the only +* defintions of these functions. +***************************************************************************/ +#if __cplusplus // [ +extern "C" void __pfx_assert(bool, const char *); +extern "C" void __pfx_assume(bool, const char *); +#else // ][ +void __pfx_assert(int, const char *); +void __pfx_assume(int, const char *); +#endif // ] +/************************************************************************** +* Redefintion of __analysis_assume and __analysis_assert for PREFIX build +**************************************************************************/ +#undef __analysis_assume +#undef __analysis_assert +#define __analysis_assume(e) (__pfx_assume(e,"pfx_assume"),__assume(e)); +#define __analysis_assert(e) (__pfx_assert(e,"pfx_assert"),__assume(e)); +#endif /* ifdef _PREFIX_ */ // ] + +/************************************************************************** +* This include should always be the last thing in this file. +* Must avoid redfinitions of macros to workaround rc.exe issues. +***************************************************************************/ +#if !(defined(RC_INVOKED) || defined(SORTPP_PASS)) +#include +#endif /* if !(defined(RC_INVOKED) || defined(SORTPP_PASS)) */ + +/* + If no SAL 2 appears to have been defined (_Outptr_ is a representative choice) + then we must be operating in a downlevel build environment (such as VS10). + We also test against the compiler version to identify a downlevel environment, + as VS11 is the minimum required for SAL 2 support. + + If we are operating in a downlevel build environment (such as VS10) + we need to undefine the following symbols before including driverspecs.h + or we will end up referencing SAL 2 implementation symbols and cause + build failures. +*/ +#if (!defined(_Outptr_) || _MSC_FULL_VER <= 160000000) && !( defined( MIDL_PASS ) || defined(__midl) || defined(RC_INVOKED) ) /*IFSTRIP=IGN*/ // [ +#undef __ANNOTATION +#define __ANNOTATION(fun) /* fun */ +#undef __PRIMOP +#define __PRIMOP(type, fun) +#endif /* !defined(_Outptr_) || _MSC_VER <= 1600 */ // ] + +#include + +/* + If no SAL 2 appears to have been defined (_Outptr_ is a representative choice) + then we must be operating in a downlevel build environment (such as VS10). + We also test against the compiler version to identify a downlevel environment, + as VS11 is the minimum required for SAL 2 support. + + If we are in a downlevel environment, we can go ahead and include no_sal2.h + to make all of SAL 2 no-ops to ensure no build failures. +*/ +#if (!defined(_Outptr_) || _MSC_FULL_VER <= 160000000) && !( defined( MIDL_PASS ) || defined(__midl) || defined(RC_INVOKED) ) && !( defined( _SDV_ ) ) /*IFSTRIP=IGN*/ // [ +#include +#endif /* !defined(_Outptr_) || _MSC_VER <= 1600 */ // ] + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + + +#endif /* #ifndef SPECSTRINGS_H */ // ] + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_strict.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_strict.h new file mode 100644 index 0000000000000000000000000000000000000000..f81ab7315dcf8c6645b4599b5193769cb3d2101c --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_strict.h @@ -0,0 +1,1186 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +/************************************************************************* +* This file documents all the macros approved for use in windows source +* code. It includes some experimental macros which should only be used by +* experts. +* +* DO NOT include this file directly. This file is include after +* specstrings.h. So we can undefine every possible old definition including +* private internal macros people should not be using, as well as macros from +* sal.h. Macros are redefined here in a way to cause syntax errors when used +* incorrectly during a normal build when specstrings.h is included and +* __SPECSTRINGS_STRICT_LEVEL is defined. +* +* There are several levels of strictness, each level includes the behavior of +* all previous levels. +* +* 0 - Disable strict checking +* 1 - Break on unapproved macros and misuse of statement +* macros such as __fallthrough (default) +* 2 - Deprecated some old macros that should not be used +* 3 - Use VS 2005 Source Annotation to make sure every macro +* is used in the right context. For example placing __in on a return +* parameter will result in an error. +************************************************************************/ +#ifndef __SPECSTRINGS_STRICT_LEVEL +#define __SPECSTRINGS_STRICT_LEVEL 1 +#endif +/************************************************************************ +* Introduction +* +* specstrings.h provides a set of annotations to describe how a function uses +* its parameters - the assumptions it makes about them, and the guarantees it +* makes upon finishing. +* +* Annotations must be placed before a function parameter's type or its return +* type. There are two basic classes of common annotations buffer annotations +* and advanced annotations. Buffer annotations describe how functions use +* their pointer parameters, and advanced annotations either describe +* complex/unusual buffer behavior, or provide additional information about a +* parameter that is not otherwise expressible. +* +* Buffer Annotations +* +* The most important annotations in SpecStrings.h provide a consistent way to +* annotate buffer parameters or return values for a function. Each of these +* annotations describes a single buffer (which could be a string, a +* fixed-length or variable-length array, or just a pointer) that the function +* interacts with: where it is, how large it is, how much is initialized, and +* what the function does with it. +* +* The appropriate macro for a given buffer can be constructed using the table +* below. Just pick the appropriate values from each category, and combine +* them together with a leading underscore. Some combinations of values do not +* make sense as buffer annotations. Only meaningful annotations can be added +* to your code; for a list of these, see the buffer annotation definitions +* section. +* +* Only a single buffer annotation should be used for each parameter. +* +* |------------|------------|---------|--------|----------|---------------| +* | Level | Usage | Size | Output | Optional | Parameters | +* |------------|------------|---------|--------|----------|---------------| +* | <> | <> | <> | <> | <> | <> | +* | _deref | _in | _ecount | _full | _opt | (size) | +* | _deref_opt | _out | _bcount | _part | | (size,length) | +* | | _inout | | | | | +* | | | | | | | +* |------------|------------|---------|--------|----------|---------------| +* +* Note: "<>" represents the empty string. +* +* Level: Describes the buffer pointer's level of indirection from the +* parameter or return value 'p'. +* +* <> : p is the buffer pointer. +* _deref : *p is the buffer pointer. p must not be NULL. +* _deref_opt : *p may be the buffer pointer. p may be NULL, in which case the +* rest of the annotation is ignored. +* +* Usage: Describes how the function uses the buffer. +* +* <> : The buffer is not accessed. If used on the return value or with +* _deref, the function will provide the buffer, and it will be uninitialized +* at exit. Otherwise, the caller must provide the buffer. This should only +* be used for alloc and free functions. +* +* _in : The function will only read from the buffer. The caller must provide +* the buffer and initialize it. +* +* _out : The function will only write to the buffer. If used on the return +* value or with _deref, the function will provide the buffer and initialize +* it. Otherwise, the caller must provide the buffer, and the function will +* initialize it. +* +* _inout : The function may freely read from and write to the buffer. The +* caller must provide the buffer and initialize it. If used with _deref, the +* buffer may be reallocated by the function. +* +* Size: Describes the total size of the buffer. This may be less than the +* space actually allocated for the buffer, in which case it describes the +* accessible amount. +* +* <> : No buffer size is given. If the type specifies the buffer size (such +* as with LPSTR and LPWSTR), that amount is used. Otherwise, the buffer is +* one element long. Must be used with _in, _out, or _inout. +* +* _ecount : The buffer size is an explicit element count. +* +* _bcount : The buffer size is an explicit byte count. +* +* Output: Describes how much of the buffer will be initialized by the +* function. For _inout buffers, this also describes how much is initialized +* at entry. Omit this category for _in buffers; they must be fully +* initialized by the caller. +* +* <> : The type specifies how much is initialized. For instance, a function +* initializing an LPWSTR must NULL-terminate the string. +* +* _full : The function initializes the entire buffer. +* +* _part : The function initializes part of the buffer, and explicitly +* indicates how much. +* +* Optional: Describes if the buffer itself is optional. +* +* <> : The pointer to the buffer must not be NULL. +* +* _opt : The pointer to the buffer might be NULL. It will be checked before +* being dereferenced. +* +* Parameters: Gives explicit counts for the size and length of the buffer. +* +* <> : There is no explicit count. Use when neither _ecount nor _bcount is +* used. +* +* (size) : Only the buffer's total size is given. Use with _ecount or _bcount +* but not _part. +* +* (size,length) : The buffer's total size and initialized length are +* given. Use with _ecount_part and _bcount_part. +* +* ---------------------------------------------------------------------------- +* Buffer Annotation Examples +* +* LWSTDAPI_(BOOL) StrToIntExA( +* LPCSTR pszString, // No annotation required, const implies __in. +* DWORD dwFlags, +* __out int *piRet // A pointer whose dereference will be filled in. +* ); +* +* void MyPaintingFunction( +* __in HWND hwndControl, // An initialized read-only parameter. +* __in_opt HDC hdcOptional, // An initialized read-only parameter that +* // might be NULL. +* __inout IPropertyStore *ppsStore // An initialized parameter that +* // may be freely used and modified. +* ); +* +* LWSTDAPI_(BOOL) PathCompactPathExA( +* __out_ecount(cchMax) LPSTR pszOut, // A string buffer with cch elements +* // that will be '\0' terminated +* // on exit. +* LPCSTR pszSrc, // No annotation required, +* // const implies __in. +* UINT cchMax, +* DWORD dwFlags +* ); +* +* HRESULT SHLocalAllocBytes( +* size_t cb, +* __deref_bcount(cb) T **ppv // A pointer whose dereference will be set +* // to an uninitialized buffer with cb bytes. +* ); +* +* __inout_bcount_full(cb) : A buffer with cb elements that is fully +* initialized at entry and exit, and may be written to by this function. +* +* __out_ecount_part(count, *countOut) : A buffer with count elements that +* will be partially initialized by this function. The function indicates how +* much it initialized by setting *countOut. +* +************************************************************************/ + +#if (_MSC_VER >= 1400) && !defined(__midl) && !defined(_PREFAST_) && (__SPECSTRINGS_STRICT_LEVEL > 0) +#pragma once +#include +#define __ecount(size) _SAL_VERSION_CHECK(__ecount) +#define __bcount(size) _SAL_VERSION_CHECK(__bcount) +#define __xcount(size) _SAL_VERSION_CHECK(__xcount) +#define __in _SAL_VERSION_CHECK(__in) +#define __in_ecount(size) _SAL_VERSION_CHECK(__in_ecount) +#define __in_bcount(size) _SAL_VERSION_CHECK(__in_bcount) +#define __in_xcount(size) _SAL_VERSION_CHECK(__in_xcount) +#define __in_z _SAL_VERSION_CHECK(__in_z) +#define __in_ecount_z(size) _SAL_VERSION_CHECK(__in_ecount_z) +#define __in_bcount_z(size) _SAL_VERSION_CHECK(__in_bcount_z) +#define __out _SAL_VERSION_CHECK(__out) +#define __out_ecount(size) _SAL_VERSION_CHECK(__out_ecount) +#define __out_bcount(size) _SAL_VERSION_CHECK(__out_bcount) +#define __out_xcount(size) _SAL_VERSION_CHECK(__out_xcount) +#define __out_ecount_part(size,len) _SAL_VERSION_CHECK(__out_ecount_part) +#define __out_bcount_part(size,len) _SAL_VERSION_CHECK(__out_bcount_part) +#define __out_xcount_part(size,len) _SAL_VERSION_CHECK(__out_xcount_part) +#define __out_ecount_full(size) _SAL_VERSION_CHECK(__out_ecount_full) +#define __out_bcount_full(size) _SAL_VERSION_CHECK(__out_bcount_full) +#define __out_xcount_full(size) _SAL_VERSION_CHECK(__out_xcount_full) +#define __out_z _SAL_VERSION_CHECK(__out_z) +#define __out_ecount_z(size) _SAL_VERSION_CHECK(__out_ecount_z) +#define __out_bcount_z(size) _SAL_VERSION_CHECK(__out_bcount_z) +#define __inout _SAL_VERSION_CHECK(__inout) +#define __inout_ecount(size) _SAL_VERSION_CHECK(__inout_ecount) +#define __inout_bcount(size) _SAL_VERSION_CHECK(__inout_bcount) +#define __inout_xcount(size) _SAL_VERSION_CHECK(__inout_xcount) +#define __inout_ecount_part(size,len) _SAL_VERSION_CHECK(__inout_ecount_part) +#define __inout_bcount_part(size,len) _SAL_VERSION_CHECK(__inout_bcount_part) +#define __inout_xcount_part(size,len) _SAL_VERSION_CHECK(__inout_xcount_part) +#define __inout_ecount_full(size) _SAL_VERSION_CHECK(__inout_ecount_full) +#define __inout_bcount_full(size) _SAL_VERSION_CHECK(__inout_bcount_full) +#define __inout_xcount_full(size) _SAL_VERSION_CHECK(__inout_xcount_full) +#define __inout_z __allowed(on_parameter) +#define __inout_ecount_z(size) __allowed(on_parameter) +#define __inout_bcount_z(size) __allowed(on_parameter) +#define __ecount_opt(size) __allowed(on_parameter) +#define __bcount_opt(size) __allowed(on_parameter) +#define __xcount_opt(size) __allowed(on_parameter) +#define __in_opt _SAL_VERSION_CHECK(__in_opt) +#define __in_ecount_opt(size) _SAL_VERSION_CHECK(__in_ecount_opt) +#define __in_bcount_opt(size) _SAL_VERSION_CHECK(__in_bcount_opt) +#define __in_z_opt __allowed(on_parameter) +#define __in_ecount_z_opt(size) __allowed(on_parameter) +#define __in_bcount_z_opt(size) __allowed(on_parameter) +#define __in_xcount_opt(size) __allowed(on_parameter) +#define __out_opt _SAL_VERSION_CHECK(__out_opt) +#define __out_ecount_opt(size) _SAL_VERSION_CHECK(__out_ecount_opt) +#define __out_bcount_opt(size) _SAL_VERSION_CHECK(__out_bcount_opt) +#define __out_xcount_opt(size) __allowed(on_parameter) +#define __out_ecount_part_opt(size,len) __allowed(on_parameter) +#define __out_bcount_part_opt(size,len) __allowed(on_parameter) +#define __out_xcount_part_opt(size,len) __allowed(on_parameter) +#define __out_ecount_full_opt(size) __allowed(on_parameter) +#define __out_bcount_full_opt(size) __allowed(on_parameter) +#define __out_xcount_full_opt(size) __allowed(on_parameter) +#define __out_ecount_z_opt(size) __allowed(on_parameter) +#define __out_bcount_z_opt(size) __allowed(on_parameter) +#define __inout_opt _SAL_VERSION_CHECK(__inout_opt) +#define __inout_ecount_opt(size) _SAL_VERSION_CHECK(__inout_ecount_opt) +#define __inout_bcount_opt(size) _SAL_VERSION_CHECK(__inout_bcount_opt) +#define __inout_xcount_opt(size) _SAL_VERSION_CHECK(__inout_xcount_opt) +#define __inout_ecount_part_opt(size,len) _SAL_VERSION_CHECK(__inout_ecount_part_opt) +#define __inout_bcount_part_opt(size,len) _SAL_VERSION_CHECK(__inout_bcount_part_opt) +#define __inout_xcount_part_opt(size,len) _SAL_VERSION_CHECK(__inout_xcount_part_opt) +#define __inout_ecount_full_opt(size) _SAL_VERSION_CHECK(__inout_ecount_full_opt) +#define __inout_bcount_full_opt(size) _SAL_VERSION_CHECK(__inout_bcount_full_opt) +#define __inout_xcount_full_opt(size) _SAL_VERSION_CHECK(__inout_xcount_full_opt) +#define __inout_z_opt __allowed(on_parameter) +#define __inout_ecount_z_opt(size) __allowed(on_parameter) +#define __inout_ecount_z_opt(size) __allowed(on_parameter) +#define __inout_bcount_z_opt(size) __allowed(on_parameter) +#define __deref_ecount(size) __allowed(on_parameter) +#define __deref_bcount(size) __allowed(on_parameter) +#define __deref_xcount(size) __allowed(on_parameter) +#define __deref_in _SAL_VERSION_CHECK(__deref_in) +#define __deref_in_ecount(size) _SAL_VERSION_CHECK(__deref_in_ecount) +#define __deref_in_bcount(size) _SAL_VERSION_CHECK(__deref_in_bcount) +#define __deref_in_xcount(size) _SAL_VERSION_CHECK(__deref_in_xcount) +#define __deref_out _SAL_VERSION_CHECK(__deref_out) +#define __deref_out_ecount(size) _SAL_VERSION_CHECK(__deref_out_ecount) +#define __deref_out_bcount(size) _SAL_VERSION_CHECK(__deref_out_bcount) +#define __deref_out_xcount(size) _SAL_VERSION_CHECK(__deref_out_xcount) +#define __deref_out_ecount_part(size,len) _SAL_VERSION_CHECK(__deref_out_ecount_part) +#define __deref_out_bcount_part(size,len) _SAL_VERSION_CHECK(__deref_out_bcount_part) +#define __deref_out_xcount_part(size,len) _SAL_VERSION_CHECK(__deref_out_xcount_part) +#define __deref_out_ecount_full(size) _SAL_VERSION_CHECK(__deref_out_ecount_full) +#define __deref_out_bcount_full(size) _SAL_VERSION_CHECK(__deref_out_bcount_full) +#define __deref_out_xcount_full(size) _SAL_VERSION_CHECK(__deref_out_xcount_full) +#define __deref_out_z __allowed(on_parameter) +#define __deref_out_ecount_z(size) __allowed(on_parameter) +#define __deref_out_bcount_z(size) __allowed(on_parameter) +#define __deref_inout _SAL_VERSION_CHECK(__deref_inout) +#define __deref_inout_ecount(size) _SAL_VERSION_CHECK(__deref_inout_ecount) +#define __deref_inout_bcount(size) _SAL_VERSION_CHECK(__deref_inout_bcount) +#define __deref_inout_xcount(size) _SAL_VERSION_CHECK(__deref_inout_xcount) +#define __deref_inout_ecount_part(size,len) __allowed(on_parameter) +#define __deref_inout_bcount_part(size,len) __allowed(on_parameter) +#define __deref_inout_xcount_part(size,len) __allowed(on_parameter) +#define __deref_inout_ecount_full(size) __allowed(on_parameter) +#define __deref_inout_bcount_full(size) __allowed(on_parameter) +#define __deref_inout_xcount_full(size) __allowed(on_parameter) +#define __deref_inout_z __allowed(on_parameter) +#define __deref_inout_ecount_z(size) __allowed(on_parameter) +#define __deref_inout_bcount_z(size) __allowed(on_parameter) +#define __deref_ecount_opt(size) __allowed(on_parameter) +#define __deref_bcount_opt(size) __allowed(on_parameter) +#define __deref_xcount_opt(size) __allowed(on_parameter) +#define __deref_in_opt __allowed(on_parameter) +#define __deref_in_opt_out __allowed(on_parameter) +#define __deref_in_ecount_opt(size) __allowed(on_parameter) +#define __deref_in_bcount_opt(size) __allowed(on_parameter) +#define __deref_in_xcount_opt(size) __allowed(on_parameter) +#define __deref_out_opt _SAL_VERSION_CHECK(__deref_out_opt) +#define __deref_out_ecount_opt(size) _SAL_VERSION_CHECK(__deref_out_ecount_opt) +#define __deref_out_bcount_opt(size) _SAL_VERSION_CHECK(__deref_out_bcount_opt) +#define __deref_out_xcount_opt(size) _SAL_VERSION_CHECK(__deref_out_xcount_opt) +#define __deref_out_ecount_part_opt(size,len) _SAL_VERSION_CHECK(__deref_out_ecount_part_opt) +#define __deref_out_bcount_part_opt(size,len) _SAL_VERSION_CHECK(__deref_out_bcount_part_opt) +#define __deref_out_xcount_part_opt(size,len) _SAL_VERSION_CHECK(__deref_out_xcount_part_opt) +#define __deref_out_ecount_full_opt(size) _SAL_VERSION_CHECK(__deref_out_ecount_full_opt) +#define __deref_out_bcount_full_opt(size) _SAL_VERSION_CHECK(__deref_out_bcount_full_opt) +#define __deref_out_xcount_full_opt(size) _SAL_VERSION_CHECK(__deref_out_xcount_full_opt) +#define __deref_out_z_opt __allowed(on_parameter) +#define __deref_out_ecount_z_opt(size) __allowed(on_parameter) +#define __deref_out_bcount_z_opt(size) __allowed(on_parameter) +#define __deref_inout_opt __allowed(on_parameter) +#define __deref_inout_ecount_opt(size) __allowed(on_parameter) +#define __deref_inout_bcount_opt(size) __allowed(on_parameter) +#define __deref_inout_xcount_opt(size) __allowed(on_parameter) +#define __deref_inout_ecount_part_opt(size,len) __allowed(on_parameter) +#define __deref_inout_bcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_inout_xcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_inout_ecount_full_opt(size) __allowed(on_parameter) +#define __deref_inout_bcount_full_opt(size) __allowed(on_parameter) +#define __deref_inout_xcount_full_opt(size) __allowed(on_parameter) +#define __deref_inout_z_opt __allowed(on_parameter) +#define __deref_inout_ecount_z_opt(size) __allowed(on_parameter) +#define __deref_inout_bcount_z_opt(size) __allowed(on_parameter) +#define __deref_opt_ecount(size) __allowed(on_parameter) +#define __deref_opt_bcount(size) __allowed(on_parameter) +#define __deref_opt_xcount(size) __allowed(on_parameter) +#define __deref_opt_in __allowed(on_parameter) +#define __deref_opt_in_ecount(size) __allowed(on_parameter) +#define __deref_opt_in_bcount(size) __allowed(on_parameter) +#define __deref_opt_in_xcount(size) __allowed(on_parameter) +#define __deref_opt_out _SAL_VERSION_CHECK(__deref_opt_out) +#define __deref_opt_out_ecount(size) _SAL_VERSION_CHECK(__deref_opt_out_ecount) +#define __deref_opt_out_bcount(size) _SAL_VERSION_CHECK(__deref_opt_out_bcount) +#define __deref_opt_out_xcount(size) _SAL_VERSION_CHECK(__deref_opt_out_xcount) +#define __deref_opt_out_ecount_part(size,len) __allowed(on_parameter) +#define __deref_opt_out_bcount_part(size,len) __allowed(on_parameter) +#define __deref_opt_out_xcount_part(size,len) __allowed(on_parameter) +#define __deref_opt_out_ecount_full(size) __allowed(on_parameter) +#define __deref_opt_out_bcount_full(size) __allowed(on_parameter) +#define __deref_opt_out_xcount_full(size) __allowed(on_parameter) +#define __deref_opt_inout __allowed(on_parameter) +#define __deref_opt_inout_ecount(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount(size) __allowed(on_parameter) +#define __deref_opt_inout_xcount(size) __allowed(on_parameter) +#define __deref_opt_inout_ecount_part(size,len) __allowed(on_parameter) +#define __deref_opt_inout_bcount_part(size,len) __allowed(on_parameter) +#define __deref_opt_inout_xcount_part(size,len) __allowed(on_parameter) +#define __deref_opt_inout_ecount_full(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount_full(size) __allowed(on_parameter) +#define __deref_opt_inout_xcount_full(size) __allowed(on_parameter) +#define __deref_opt_inout_z __allowed(on_parameter) +#define __deref_opt_inout_ecount_z(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount_z(size) __allowed(on_parameter) +#define __deref_opt_ecount_opt(size) __allowed(on_parameter) +#define __deref_opt_bcount_opt(size) __allowed(on_parameter) +#define __deref_opt_xcount_opt(size) __allowed(on_parameter) +#define __deref_opt_in_opt __allowed(on_parameter) +#define __deref_opt_in_ecount_opt(size) __allowed(on_parameter) +#define __deref_opt_in_bcount_opt(size) __allowed(on_parameter) +#define __deref_opt_in_xcount_opt(size) __allowed(on_parameter) +#define __deref_opt_out_opt __allowed(on_parameter) +#define __deref_opt_out_ecount_opt(size) __allowed(on_parameter) +#define __deref_opt_out_bcount_opt(size) __allowed(on_parameter) +#define __deref_opt_out_xcount_opt(size) __allowed(on_parameter) +#define __deref_opt_out_ecount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_out_bcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_out_xcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_out_ecount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_out_bcount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_out_xcount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_out_z_opt __allowed(on_parameter) +#define __deref_opt_out_ecount_z_opt(size) __allowed(on_parameter) +#define __deref_opt_out_bcount_z_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_opt __allowed(on_parameter) +#define __deref_opt_inout_ecount_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_xcount_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_ecount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_inout_bcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_inout_xcount_part_opt(size,len) __allowed(on_parameter) +#define __deref_opt_inout_ecount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_xcount_full_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_z_opt __allowed(on_parameter) +#define __deref_opt_inout_ecount_z_opt(size) __allowed(on_parameter) +#define __deref_opt_inout_bcount_z_opt(size) __allowed(on_parameter) +#define __deref_in_ecount_iterator(size,incr) __allowed(on_parameter) +#define __deref_out_ecount_iterator(size,incr) __allowed(on_parameter) +#define __deref_inout_ecount_iterator(size,incr) __allowed(on_parameter) +#define __deref_realloc_bcount(insize,outsize) __allowed(on_parameter) + +/************************************************************************ +* SAL 2 _Ouptr_ family of annotations +************************************************************************/ + +#define _Outptr_ __allowed(on_parameter) +#define _Outptr_result_maybenull_ __allowed(on_parameter) +#define _Outptr_opt_ __allowed(on_parameter) +#define _Outptr_opt_result_maybenull_ __allowed(on_parameter) +#define _Outptr_result_z_ __allowed(on_parameter) +#define _Outptr_opt_result_z_ __allowed(on_parameter) +#define _Outptr_result_maybenull_z_ __allowed(on_parameter) +#define _Outptr_opt_result_maybenull_z_ __allowed(on_parameter) +#define _Outptr_result_nullonfailure_ __allowed(on_parameter) +#define _Outptr_opt_result_nullonfailure_ __allowed(on_parameter) +#define _COM_Outptr_ __allowed(on_parameter) +#define _COM_Outptr_result_maybenull_ __allowed(on_parameter) +#define _COM_Outptr_opt_ __allowed(on_parameter) +#define _COM_Outptr_opt_result_maybenull_ __allowed(on_parameter) +#define _Outptr_result_buffer_(size) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_(size) __allowed(on_parameter) +#define _Outptr_result_buffer_to_(size, count) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_to_(size, count) __allowed(on_parameter) +#define _Outptr_result_buffer_all_(size) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_all_(size) __allowed(on_parameter) +#define _Outptr_result_buffer_maybenull_(size) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_maybenull_(size) __allowed(on_parameter) +#define _Outptr_result_buffer_to_maybenull_(size, count) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_to_maybenull_(size, count) __allowed(on_parameter) +#define _Outptr_result_buffer_all_maybenull_(size) __allowed(on_parameter) +#define _Outptr_opt_result_buffer_all_maybenull_(size) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_(size) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_(size) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_to_(size, count) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_to_(size, count) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_all_(size) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_all_(size) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_maybenull_(size) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_maybenull_(size) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_to_maybenull_(size, count) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_to_maybenull_(size, count) __allowed(on_parameter) +#define _Outptr_result_bytebuffer_all_maybenull_(size) __allowed(on_parameter) +#define _Outptr_opt_result_bytebuffer_all_maybenull_(size) __allowed(on_parameter) + +/************************************************************************ +* Orcas SAL +************************************************************************/ +#define _Deref_out_ _SAL_VERSION_CHECK(_Deref_out_) +#define _Deref_out_opt_ _SAL_VERSION_CHECK(_Deref_out_opt_) +#define _Deref_opt_out_ _SAL_VERSION_CHECK(_Deref_opt_out_) +#define _Deref_opt_out_opt_ _SAL_VERSION_CHECK(_Deref_opt_out_opt_) +#define _In_count_(size) _SAL_VERSION_CHECK(_In_count_) +#define _In_opt_count_(size) _SAL_VERSION_CHECK(_In_opt_count_) +#define _In_bytecount_(size) _SAL_VERSION_CHECK(_In_bytecount_) +#define _In_opt_bytecount_(size) _SAL_VERSION_CHECK(_In_opt_bytecount_) +#define _Out_cap_(size) _SAL_VERSION_CHECK(_Out_cap_) +#define _Out_opt_cap_(size) _SAL_VERSION_CHECK(_Out_opt_cap_) +#define _Out_bytecap_(size) _SAL_VERSION_CHECK(_Out_bytecap_) +#define _Out_opt_bytecap_(size) _SAL_VERSION_CHECK(_Out_opt_bytecap_) +#define _Deref_post_count_(size) _SAL_VERSION_CHECK(_Deref_post_count_) +#define _Deref_post_opt_count_(size) _SAL_VERSION_CHECK(_Deref_post_opt_count_) +#define _Deref_post_bytecount_(size) _SAL_VERSION_CHECK(_Deref_post_bytecount_) +#define _Deref_post_opt_bytecount_(size) _SAL_VERSION_CHECK(_Deref_post_opt_bytecount_) +#define _Deref_post_cap_(size) _SAL_VERSION_CHECK(_Deref_post_cap_) +#define _Deref_post_opt_cap_(size) _SAL_VERSION_CHECK(_Deref_post_opt_cap_) +#define _Deref_post_bytecap_(size) _SAL_VERSION_CHECK(_Deref_post_bytecap_) +#define _Deref_post_opt_bytecap_(size) _SAL_VERSION_CHECK(_Deref_post_opt_bytecap_) + +/************************************************************************ +* Advanced Annotations +* +* Advanced annotations describe behavior that is not expressible with the +* regular buffer macros. These may be used either to annotate buffer +* parameters that involve complex or conditional behavior, or to enrich +* existing annotations with additional information. +* +* _At_(expr, annotes) : annotation list annotes applies to target 'expr' +* +* _When_(expr, annotes) : annotation list annotes applies when 'expr' is true +* +* __success(expr) T f() : indicates whether function f succeeded or +* not. If is true at exit, all the function's guarantees (as given +* by other annotations) must hold. If is false at exit, the caller +* should not expect any of the function's guarantees to hold. If not used, +* the function must always satisfy its guarantees. Added automatically to +* functions that indicate success in standard ways, such as by returning an +* HRESULT. +* +* __out_awcount(expr, size) T *p : Pointer p is a buffer whose size may be +* given in either bytes or elements. If is true, this acts like +* __out_bcount. If is false, this acts like __out_ecount. This +* should only be used to annotate old APIs. +* +* __in_awcount(expr, size) T* p : Pointer p is a buffer whose size may be given +* in either bytes or elements. If is true, this acts like +* __in_bcount. If is false, this acts like __in_ecount. This should +* only be used to annotate old APIs. +* +* __nullterminated T* p : Pointer p is a buffer that may be read or written +* up to and including the first '\0' character or pointer. May be used on +* typedefs, which marks valid (properly initialized) instances of that type +* as being null-terminated. +* +* __nullnullterminated T* p : Pointer p is a buffer that may be read or +* written up to and including the first sequence of two '\0' characters or +* pointers. May be used on typedefs, which marks valid instances of that +* type as being double-null terminated. +* +* __reserved T v : Value v must be 0/NULL, reserved for future use. +* +* __checkReturn T f(); : Return value of f must not be ignored by callers +* of this function. +* +* __typefix(ctype) T v : Value v should be treated as an instance of ctype, +* rather than its declared type when considering validity. +* +* __override T f(); : Specify C#-style 'override' behaviour for overriding +* virtual methods. +* +* __callback T f(); : Function f can be used as a function pointer. +* +* __format_string T p : Pointer p is a string that contains % markers in +* the style of printf. +* +* __blocksOn(resource) f(); : Function f blocks on the resource 'resource'. +* +* __fallthrough : Annotates switch statement labels where fall-through is +* desired, to distinguish from forgotten break statements. +* +* __range(low_bnd, up_bnd) int f(): The return from the function "f" must +* be in the inclusive numeric range [low_bnd, up_bnd]. +* +* __in_range(low_bnd, up_bnd) int i : Precondition that integer i must be +* in the inclusive numeric range [low_bnd, up_bnd]. +* +* __out_range(low_bnd, up_bnd) int i : Postcondition that integer i must be +* in the inclusive numeric range [low_bnd, up_bnd]. +* +* __deref_in_range(low_bnd, up_bnd) int* pi : Precondition that integer *pi +* must be in the inclusive numeric range [low_bnd, up_bnd]. +* +* __deref_out_range(low_bnd, up_bnd) int* pi : Postcondition that integer +* *pi must be in the inclusive numeric range [low_bnd, up_bnd]. +* +* __deref_inout_range(low_bnd, up_bnd) int* pi : Invariant that the integer +* *pi must be in the inclusive numeric range [low_bnd, up_bnd]. +* +* The first argument of a range macro may also be a C relational operator +* (<,>,!=, ==, <=, >=). +* +* __range(rel_op, j) int f(): Postcondition that "f() rel_op j" must be +* true. Note that j may be a expression known only at runtime. +* +* __in_range(rel_op, j) int i : Precondition that "i rel_op j" must be +* true. Note that j may be a expression known only at runtime. +* +* __out_range(rel_op, j) int i : Postcondition that integer "i rel_op j" +* must be true. Note that j may be a expression known only at runtime. +* +* __deref_in_range(rel_op, j) int *pi : Precondition that "*pi rel_op j" +* must be true. Note that j may be a expression known only at runtime. +* +* __deref_out_range(rel_op, j) int *pi : Postcondition that "*pi rel_op j" +* must be true. Note that j may be a expression known only at runtime. +* +* __deref_inout_range(rel_op, j) int *pi : Invariant that "*pi rel_op j" +* must be true. Note that j may be a expression known only at runtime. +* +* __range_max(a, b) int f(): Postcondition f acts as 'max', returns larger +* of a and b. Note that a and b may be expressions known only at runtime. +* +* __range_min(a, b) int f(): Postcondition f acts as 'min', returns smaller +* of a and b. Note that a and b may be expressions known only at runtime. +* +* __in_bound int i : Precondition that integer i must be bound, but the +* exact range can't be specified at compile time. __in_range should be +* used if the range can be explicitly stated. +* +* __out_bound int i : Postcondition that integer i must be bound, but the +* exact range can't be specified at compile time. __out_range should be +* used if the range can be explicitly stated. +* +* __deref_out_bound int pi : Postcondition that integer *pi must be bound, +* but the exact range can't be specified at compile time. +* __deref_out_range should be used if the range can be explicitly stated. +* +* __assume_bound(expr); : Assume that the expression is bound to some known +* range. This can be used to suppress integer overflow warnings on integral +* expressions that are known to be bound due to reasons not explicit in the +* code. Use as a statement in the body of a function. +* +* __analysis_assume_nulltermianted(expr); : Assume that the expression is +* a null terminated buffer. Use this to suppress tool noise specific to +* nulltermination warnings, and capture deeper invariants tools can not +* discover. +* +* __allocator void f(): Function allocates memory using an integral size +* argument +* +* void myfree(__deallocate(Mem) void *p) : Memory is freed, no longer usable +* upon return, and p may not be null. +* +* void myfree(__deallocate_opt(Mem) void *p) : Memory is freed, no longer +* usable upon return, and p may be null. +* +* void free(__post_invalid void* x): Mark memory as untouchable when +* function returns. +* +* ---------------------------------------------------------------------------- +* Advanced Annotation Examples +* +* __success(return == TRUE) LWSTDAPI_(BOOL) +* PathCanonicalizeA(__out_ecount(MAX_PATH) LPSTR pszBuf, LPCSTR pszPath); +* // pszBuf is only guaranteed to be null-terminated when TRUE is returned. +* +* // Initialized LPWSTRs are null-terminated strings. +* typedef __nullterminated WCHAR* LPWSTR; +* +* __out_ecount(cch) __typefix(LPWSTR) void *psz; +* // psz is a buffer parameter which will be a null-terminated WCHAR string +* // at exit, and which initially contains cch WCHARs. +* +************************************************************************/ +#define _At_(expr, annotes) __allowed(on_parameter_or_return) +#define _When_(expr, annotes) __allowed(on_parameter_or_return) +#define __success(expr) _SAL_VERSION_CHECK(__success) +#define __out_awcount(expr,size) __allowed(on_parameter) +#define __in_awcount(expr,size) __allowed(on_parameter) +#define __nullterminated _SAL_VERSION_CHECK(__nullterminated) +#define __nullnullterminated _SAL_VERSION_CHECK(__nullnullterminated) +#define __reserved _SAL_VERSION_CHECK(__reserved) +#define __checkReturn _SAL_VERSION_CHECK(__checkReturn) +#define __typefix(ctype) __allowed(on_parameter_or_return) +#define __override __allowed(on_function) +#define __callback __allowed(on_function) +#define __format_string __allowed(on_parameter_or_return) +#define __blocksOn(resource) __allowed(on_function) +#define __fallthrough __allowed(as_statement) +#define __range(lb,ub) __allowed(on_return) +#define __in_range(lb,ub) _SAL_VERSION_CHECK(__in_range) +#define __out_range(lb,ub) _SAL_VERSION_CHECK(__out_range) +#define __deref_in_range(lb,ub) __allowed(on_parameter) +#define __deref_out_range(lb,ub) _SAL_VERSION_CHECK(__deref_out_range) +#define __deref_inout_range(lb,ub) __allowed(on_parameter) +#define __field_range(lb,ub) _SAL_VERSION_CHECK(__field_range) +#define __range_max(a,b) __allowed(on_return) +#define __range_min(a,b) __allowed(on_return) +#define __bound __allowed(on_return) +#define __in_bound __allowed(on_parameter) +#define __out_bound __allowed(on_parameter) +#define __deref_out_bound __allowed(on_parameter) +#define __assume_bound(i) __allowed(as_statement_with_arg(i)) +#define __analysis_assume_nullterminated(x) \ + __allowed(as_statement_with_arg(x)) +#define __allocator __allowed(on_function) +#define __deallocate(kind) __allowed(on_parameter) +#define __deallocate_opt(kind) __allowed(on_parameter) +#define __post_invalid __allowed(on_parameter_or_return) +#define __post_nullnullterminated \ + __allowed(on_parameter_or_return) +/*************************************************************************** +* Expert Macros +***************************************************************************/ +#define __null __allowed(on_typedecl) +#define __notnull __allowed(on_typedecl) +#define __maybenull __allowed(on_typedecl) +#define __exceptthat __allowed(on_typedecl) +/*************************************************************************** +* Macros to classify fields of structures. +* Structure Annotations +* +* The buffer annotations are a convenient way of describing +* relationships between buffers and their size on a function by +* function basis. Very often struct or class data members have similar +* invariants, which can be expressed directly on the type. +* +* Similar to our buffer annotations we can summarize all the various +* structure annotations by one choosing an element from each column of +* this table to build a composite annotation. +* +* +--------------------------------------------------+ +* | Selector | Units | Size/Init | Optional | +* |----------+---------+------------------+----------| +* | __field | _ecount | (size) | empty | +* |----------+---------+------------------+----------| +* | __struct | _bcount | _full(size) | _opt | +* |----------+---------+------------------+----------| +* | | _xcount | _part(size,init) | | +* +--------------------------------------------------+ +* +* Note that empty represents the empty string. Sometime arguments need +* to be "floated" to the left to give us a valid annotation name. For +* example the naive combination __field_ecount(size)_opt is actually +* written as __field_ecount_opt(size). Not all possible combinations +* are currently supported or sensible. See specstrings_strict.h for +* the currently supported set. Those that are supported are documented +* below. +* +*Summary of Elements +* +* Selector +* +* __field +* The annotation should only be placed in front +* of data members of structures and classes. The +* data members are pointers to a block of data. +* The annotations describe properties about the +* size of the block of data. This can be used for +* +* __struct +* The annotation should only be placed at the +* beginning of the definition of a structure or +* class. These annotations are used when a struct +* or class is used as a "header" that is +* allocated inline with a block of data and there +* is no apparent field that represents the tail +* end of the structure. +* +* Units +* +* _ecount +* All size and initialization values are in terms +* of elements of the appropriate type +* +* _bcount +* All size and initialization values are in terms +* of raw byte sizes. +* +* _xcount +* The size or initialization values cannot be +* properly expressed as a simple byte or element +* count, and instead a place holder is used to +* document the relationship. +* +* Size/Init +* All the size/init expressions can contain references to +* other fields in the struct or class. +* +* (size) +* The size of the buffer is determined by the +* expression size. Unless, the type of the buffer +* provides more information nothing is know about +* how much of this data is initialized. For +* example, if the data member happens to be a +* string type such as LPSTR. It is assumed that +* the data is initialized to the first '\0'. +* +* _full(size) +* The size of the buffer is determined by the +* expression size and all the data in the buffer +* is guaranteed to be initialized. +* +* _part(size,init) +* The size of the buffer is determined by the +* expression size and all the data in the buffer +* is guaranteed to be initialized up to init +* elements or bytes. +* +* Optional +* +* empty +* The pointer to the block of memory is never +* NULL +* +* _opt +* The pointer to the block of memory is may be +* NULL +* +* +* // Basic Usage of Struct Annotations +* #include +* #include +* struct buf_s { +* int sz; +* __field_bcount_full(sz) +* char *buf; +* }; +* void InitBuf(__out struct *buf_s b,int sz) { +* b->buf = calloc(sz,sizeof(char)); +* b->sz = sz; +* } +* void WriteBuf(__in FILE *fp,__in struct *buf_s b) { +* fwrite(b->buf,b->sz,sizeof(char),fp); +* } +* void ReadBuf(__in FILE *fp,__inout struct *buf_s b) { +* fread(b->buf,b->sz,sizeof(char),fp); +* } +* +* +* +* // Inline Allocated Buffer +* struct buf_s { +* int sz; +* __field_bcount(sz) +* char buf[1]; +* }; +* void WriteBuf(__in FILE *fp,__in struct *buf_s b) { +* fwrite(&(b->buf),b->sz,sizeof(char),fp); +* } +* void ReadBuf(__in FILE *fp,__inout struct *buf_s b) { +* fread(&(b->buf),b->sz,sizeof(char),fp); +* } +* +* +* +* // Embedded Header Structure +* __struct_bcount(sz) +* struct buf_s { +* int sz; +* }; +* void WriteBuf(__in FILE *fp,__in struct *buf_s b) { +* fwrite(&b,b->sz,sizeof(char),fp); +* } +* void ReadBuf(__in FILE *fp,__inout struct *buf_s b) { +* fread(&b,b->sz,sizeof(char),fp); +* } +* +* +****************************************************************************/ +#define __field_ecount(size) _SAL_VERSION_CHECK(__field_ecount) +#define __field_bcount(size) _SAL_VERSION_CHECK(__field_bcount) +#define __field_xcount(size) __allowed(on_field) +#define __field_ecount_opt(size) __allowed(on_field) +#define __field_bcount_opt(size) __allowed(on_field) +#define __field_xcount_opt(size) __allowed(on_field) +#define __field_ecount_part(size,init) __allowed(on_field) +#define __field_bcount_part(size,init) __allowed(on_field) +#define __field_xcount_part(size,init) __allowed(on_field) +#define __field_ecount_part_opt(size,init) __allowed(on_field) +#define __field_bcount_part_opt(size,init) __allowed(on_field) +#define __field_xcount_part_opt(size,init) __allowed(on_field) +#define __field_ecount_full(size) __allowed(on_field) +#define __field_bcount_full(size) __allowed(on_field) +#define __field_xcount_full(size) __allowed(on_field) +#define __field_ecount_full_opt(size) __allowed(on_field) +#define __field_bcount_full_opt(size) __allowed(on_field) +#define __field_xcount_full_opt(size) __allowed(on_field) +#define __field_nullterminated __allowed(on_field) +#define __struct_bcount(size) __allowed(on_struct) +#define __struct_xcount(size) __allowed(on_struct) + +/*************************************************************************** +* Macros to classify the entrypoints and indicate their category. +* +* Pre-defined control point categories include: RPC, KERNEL, GDI. +* +* Pre-defined control point macros include: +* __rpc_entry, __kernel_entry, __gdi_entry. +***************************************************************************/ +#define __control_entrypoint(category) __allowed(on_function) +#define __rpc_entry __allowed(on_function) +#define __kernel_entry __allowed(on_function) +#define __gdi_entry __allowed(on_function) + +/*************************************************************************** +* Macros to track untrusted data and their validation. The list of untrusted +* sources include: +* +* FILE - File reading stream or API +* NETWORK - Socket readers +* INTERNET - WinInet and WinHttp readers +* USER_REGISTRY - HKCU portions of the registry +* USER_MODE - Parameters to kernel entry points +* RPC - Parameters to RPC entry points +* DRIVER - Device driver +***************************************************************************/ +#define __in_data_source(src_sym) __allowed(on_parameter) +#define __out_data_source(src_sym) __allowed(on_parameter) +#define __field_data_source(src_sym) __allowed(on_field) +#define __this_out_data_source(src_syn) __allowed(on_function) + +/************************************************************************** +* Macros to tag file parsing code. Predefined formats include: +* PNG - Portable Network Graphics +* JPEG - Joint Photographic Experts Group +* BMP - Bitmap +* RC_BMP - Resource bitmap +* WMF - Windows Metafile +* EMF - Windows Enhanced Metafile +* GIF - Graphics Interchange Format +* MIME_TYPE - MIME type from header tokens +* MAIL_MONIKER - MAIL information refered by URL moniker +* HTML - HyperText Markup Language +* WMPHOTO - Windows media photo +* OE_VCARD - Outlook Express virtual card +* OE_CONTACT - Outlook Express contact +* MIDI - Musical Instrument Digital Interface +* LDIF - LDAP Data Interchange Format +* AVI - Audio Visual Interchange +* ACM - Audio Compression Manager +**************************************************************************/ +#define __out_validated(filetype_sym) __allowed(on_parameter) +#define __this_out_validated(filetype_sym) __allowed(on_function) +#define __file_parser(filetype_sym) __allowed(on_function) +#define __file_parser_class(filetype_sym) __allowed(on_struct) +#define __file_parser_library(filetype_sym) __allowed(as_global_decl) + +/*************************************************************************** +* Macros to track the code content in the file. The type of code +* contents currently tracked: +* +* NDIS_DRIVER - NDIS Device driver +***************************************************************************/ +#define __source_code_content(codetype_sym) __allowed(as_global_decl) + +/*************************************************************************** +* Macros to track the code content in the class. The type of code +* contents currently tracked: +* +* DCOM - Class implementing DCOM +***************************************************************************/ +#define __class_code_content(codetype_sym) __allowed(on_struct) + +/************************************************************************* +* Macros to tag encoded function pointers +**************************************************************************/ +#define __encoded_pointer +#define __encoded_array +#define __field_encoded_pointer __allowed(on_field) +#define __field_encoded_array __allowed(on_field) + +#define __transfer(formal) __allowed(on_parameter_or_return) +#define __assume_validated(exp) __allowed(as_statement_with_arg(exp)) + +/************************************************************************* +* __analysis_assume(expr) : Expert macro use only when directed. Use this to +* tell static analysis tools like PREfix and PREfast about a non-coded +* assumption that you wish the tools to assume. The assumption will be +* understood by those tools. By default there is no dynamic checking or +* static checking of the assumption in any build. +* +* To obtain dynamic checking wrap this macro in your local version of a debug +* assert. +* Please do not put function calls in the expression because this is not +* supported by all tools: +* __analysis_assume(GetObject () != NULL); // DO NOT DO THIS +* +*************************************************************************/ +#define __analysis_assume(expr) __allowed(as_statement_with_arg(expr)) +#define __analysis_assert(expr) __allowed(as_statement_with_arg(expr)) + +/************************************************************************* +* __analysis_hint(hint_sym) : Expert macro use only when +* directed. Use this to influence certain analysis heuristics +* used by the tools. These hints do not describe the semantics +* of functions but simply direct the tools to act in a certain +* way. +* +* Current hints that are supported are: +* +* INLINE - inline this function during analysis overrides any +* default heuristics +* NOINLINE - do not inline this function during analysis overrides +* and default heuristics +*************************************************************************/ +#define __analysis_hint(hint) __allowed(on_function) + +/************************************************************************* +* Macros to encode abstract properties of values. Used by SALadt.h +*************************************************************************/ +#define __type_has_adt_prop(adt,prop) __allowed(on_typdecl) +#define __out_has_adt_prop(adt,prop) __allowed(on_parameter) +#define __out_not_has_adt_prop(adt,prop) __allowed(on_parameter) +#define __out_transfer_adt_prop(arg) __allowed(on_parameter) +#define __out_has_type_adt_props(typ) __allowed(on_parameter) + +/************************************************************************* +* Macros used by Prefast for Drivers +* +* __possibly_notnullterminated : +* +* Used for return values of parameters or functions that do not +* guarantee nulltermination in all cases. +* +*************************************************************************/ +#define __possibly_notnullterminated __allowed(on_parameter_or_return) + +/************************************************************************* +* Advanced macros +* +* __volatile +* The __volatile annotation identifies a global variable or +* structure field that: +* 1) is not declared volatile; +* 2) is accessed concurrently by multiple threads. +* +* The __deref_volatile annotation identifies a global variable +* or structure field that stores a pointer to some data that: +* 1) is not declared volatile; +* 2) is accessed concurrently by multiple threads. +* +* Prefast uses these annotations to find patterns of code that +* may result in unexpected re-fetching of the global variable +* into a local variable. +* +* We also provide two complimentary annotations __nonvolatile +* and __deref_nonvolatile that could be used to suppress Prefast +* +* re-fetching warnings on variables that are known either: +* 1) not to be in danger of being re-fetched or, +* 2) not to lead to incorrect results if they are re-fetched +* +*************************************************************************/ +#define __volatile __allowed(on_global_or_field) +#define __deref_volatile __allowed(on_global_or_field) +#define __nonvolatile __allowed(on_global_or_field) +#define __deref_nonvolatile __allowed(on_global_or_field) + +/************************************************************************* +* Macros deprecated with strict level greater then 1. +**************************************************************************/ +#if (__SPECSTRINGS_STRICT_LEVEL > 1) +/* Must come before macro defintions */ +#pragma deprecated(__in_nz) +#pragma deprecated(__in_ecount_nz) +#pragma deprecated(__in_bcount_nz) +#pragma deprecated(__out_nz) +#pragma deprecated(__out_nz_opt) +#pragma deprecated(__out_ecount_nz) +#pragma deprecated(__out_bcount_nz) +#pragma deprecated(__inout_nz) +#pragma deprecated(__inout_ecount_nz) +#pragma deprecated(__inout_bcount_nz) +#pragma deprecated(__in_nz_opt) +#pragma deprecated(__in_ecount_nz_opt) +#pragma deprecated(__in_bcount_nz_opt) +#pragma deprecated(__out_ecount_nz_opt) +#pragma deprecated(__out_bcount_nz_opt) +#pragma deprecated(__inout_nz_opt) +#pragma deprecated(__inout_ecount_nz_opt) +#pragma deprecated(__inout_bcount_nz_opt) +#pragma deprecated(__deref_out_nz) +#pragma deprecated(__deref_out_ecount_nz) +#pragma deprecated(__deref_out_bcount_nz) +#pragma deprecated(__deref_inout_nz) +#pragma deprecated(__deref_inout_ecount_nz) +#pragma deprecated(__deref_inout_bcount_nz) +#pragma deprecated(__deref_out_nz_opt) +#pragma deprecated(__deref_out_ecount_nz_opt) +#pragma deprecated(__deref_out_bcount_nz_opt) +#pragma deprecated(__deref_inout_nz_opt) +#pragma deprecated(__deref_inout_ecount_nz_opt) +#pragma deprecated(__deref_inout_bcount_nz_opt) +#pragma deprecated(__deref_opt_inout_nz) +#pragma deprecated(__deref_opt_inout_ecount_nz) +#pragma deprecated(__deref_opt_inout_bcount_nz) +#pragma deprecated(__deref_opt_out_nz_opt) +#pragma deprecated(__deref_opt_out_ecount_nz_opt) +#pragma deprecated(__deref_opt_out_bcount_nz_opt) +#pragma deprecated(__deref_opt_inout_nz_opt) +#pragma deprecated(__deref_opt_inout_ecount_nz_opt) +#pragma deprecated(__deref_opt_inout_bcount_nz_opt) +#pragma deprecated(__deref) +#pragma deprecated(__pre) +#pragma deprecated(__post) +#pragma deprecated(__readableTo) +#pragma deprecated(__writableTo) +#pragma deprecated(__maybevalid) +#pragma deprecated(__data_entrypoint) +#pragma deprecated(__inexpressible_readableTo) +#pragma deprecated(__readonly) +#pragma deprecated(__byte_writableTo) +#pragma deprecated(__byte_readableTo) +#pragma deprecated(__elem_readableTo) +#pragma deprecated(__elem_writableTo) +#pragma deprecated(__valid) +#pragma deprecated(__notvalid) +#pragma deprecated(__refparam) +#pragma deprecated(__precond) +#endif +/* Define soon to be deprecated macros to nops. */ +#define __in_nz +#define __in_ecount_nz(size) +#define __in_bcount_nz(size) +#define __out_nz +#define __out_nz_opt +#define __out_ecount_nz(size) +#define __out_bcount_nz(size) +#define __inout_nz +#define __inout_ecount_nz(size) +#define __inout_bcount_nz(size) +#define __in_nz_opt +#define __in_ecount_nz_opt(size) +#define __in_bcount_nz_opt(size) +#define __out_ecount_nz_opt(size) +#define __out_bcount_nz_opt(size) +#define __inout_nz_opt +#define __inout_ecount_nz_opt(size) +#define __inout_bcount_nz_opt(size) +#define __deref_out_nz +#define __deref_out_ecount_nz(size) +#define __deref_out_bcount_nz(size) +#define __deref_inout_nz +#define __deref_inout_ecount_nz(size) +#define __deref_inout_bcount_nz(size) +#define __deref_out_nz_opt +#define __deref_out_ecount_nz_opt(size) +#define __deref_out_bcount_nz_opt(size) +#define __deref_inout_nz_opt +#define __deref_inout_ecount_nz_opt(size) +#define __deref_inout_bcount_nz_opt(size) +#define __deref_opt_inout_nz +#define __deref_opt_inout_ecount_nz(size) +#define __deref_opt_inout_bcount_nz(size) +#define __deref_opt_out_nz_opt +#define __deref_opt_out_ecount_nz_opt(size) +#define __deref_opt_out_bcount_nz_opt(size) +#define __deref_opt_inout_nz_opt +#define __deref_opt_inout_ecount_nz_opt(size) +#define __deref_opt_inout_bcount_nz_opt(size) +#define __deref +#define __pre +#define __post +#define __readableTo(count) +#define __writableTo(count) +#define __maybevalid +#define __inexpressible_readableTo(string) +#define __data_entrypoint(category) +#define __readonly +#define __byte_writableTo(count) +#define __byte_readableTo(count) +#define __elem_readableTo(count) +#define __elem_writableTo(count) +#define __valid +#define __notvalid +#define __refparam +#define __precond(condition) + +/************************************************************************* +* Definitions to force a compile error when macros are used improperly. +* Relies on VS 2005 source annotations. +*************************************************************************/ +#if !defined(_MSC_EXTENSIONS) && !defined(_PREFAST_) && !defined(OACR) +#define __allowed(p) /* nothing */ +#else +#define __allowed(p) __$allowed_##p +#define __$allowed_as_global_decl /* empty */ +#define __$allowed_as_statement_with_arg(x) \ + __pragma(warning(push)) __pragma(warning(disable : 4548)) \ + do {__noop(x);} while((0,0) __pragma(warning(pop)) ) +#define __$allowed_as_statement __$allowed_as_statement_with_arg(1) + +/************************************************************************** +* This should go away. It's only for __success which we should split into. +* __success and __typdecl_sucess +***************************************************************************/ +#define __$allowed_on_function_or_typedecl /* empty */ +#if (__SPECSTRINGS_STRICT_LEVEL == 1) || (__SPECSTRINGS_STRICT_LEVEL == 2) +#define __$allowed_on_typedecl /* empty */ +#define __$allowed_on_return /* empty */ +#define __$allowed_on_parameter /* empty */ +#define __$allowed_on_function /* empty */ +#define __$allowed_on_struct /* empty */ +#define __$allowed_on_field /* empty */ +#define __$allowed_on_parameter_or_return /* empty */ +#define __$allowed_on_global_or_field /* empty */ +#elif __SPECSTRINGS_STRICT_LEVEL == 3 +#define __$allowed_on_typedecl /* empty */ +/* Define dummy source attributes. Still needs more testing */ +#define __$allowed_on_return [returnvalue: OnReturnOnly] +#define __$allowed_on_parameter [OnParameterOnly] +#define __$allowed_on_function [method: OnFunctionOnly] +#define __$allowed_on_struct [OnStructOnly] +#define __$allowed_on_field [OnFieldOnly] +#define __$allowed_on_parameter_or_return [OnParameterOrReturnOnly] +#define __$allowed_on_global_or_field /* empty */ +#pragma push_macro( "DECL_SA" ) +#pragma push_macro( "SA" ) +#ifdef __cplusplus +#define SA(x) x +#define DECL_SA(name,loc) \ + [repeatable] \ + [source_annotation_attribute( loc )] \ + struct name##Attribute { name##Attribute(); const char* ignored; }; +#else +#define SA(x) SA_##x +#define DECL_SA(name,loc) \ + [source_annotation_attribute( loc )] \ + struct name { const char* ignored; };\ + typedef struct name name; +#endif /* #endif __cplusplus */ +DECL_SA(OnParameterOnly,SA(Parameter)); +DECL_SA(OnReturnOnly,SA(ReturnValue)); +DECL_SA(OnFunctionOnly,SA(Method)); +DECL_SA(OnStructOnly,SA(Struct)); +DECL_SA(OnFieldOnly,SA(Field)); +DECL_SA(OnParameterOrReturnOnly,SA(Parameter) | SA(ReturnValue)); +#pragma pop_macro( "SA" ) +#pragma pop_macro( "DECL_SA" ) +#endif +#endif +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_undef.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_undef.h new file mode 100644 index 0000000000000000000000000000000000000000..35b4d74c34de68fe88d7e98d02801d8f3dba5055 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/specstrings_undef.h @@ -0,0 +1,456 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +#undef _At_ +#undef _Deref_out_ +#undef _Deref_out_opt_ +#undef _Deref_opt_out_ +#undef _Deref_opt_out_opt_ +#undef _Deref_post_cap_ +#undef _Deref_post_opt_cap_ +#undef _Deref_post_bytecap_ +#undef _Deref_post_opt_bytecap_ +#undef _Deref_post_count_ +#undef _Deref_post_opt_count_ +#undef _Deref_post_bytecount_ +#undef _Deref_post_opt_bytecount_ +#undef _In_count_ +#undef _In_opt_count_ +#undef _In_bytecount_ +#undef _In_opt_bytecount_ +#undef _Out_cap_ +#undef _Out_opt_cap_ +#undef _Out_bytecap_ +#undef _Out_opt_bytecap_ +#undef _Outptr_ +#undef _Outptr_result_maybenull_ +#undef _Outptr_opt_ +#undef _Outptr_opt_result_maybenull_ +#undef _Outptr_result_z_ +#undef _Outptr_opt_result_z_ +#undef _Outptr_result_maybenull_z_ +#undef _Outptr_opt_result_maybenull_z_ +#undef _Outptr_result_nullonfailure_ +#undef _Outptr_opt_result_nullonfailure_ +#undef _COM_Outptr_ +#undef _COM_Outptr_result_maybenull_ +#undef _COM_Outptr_opt_ +#undef _COM_Outptr_opt_result_maybenull_ +#undef _Outptr_result_buffer_ +#undef _Outptr_opt_result_buffer_ +#undef _Outptr_result_buffer_to_ +#undef _Outptr_opt_result_buffer_to_ +#undef _Outptr_result_buffer_all_ +#undef _Outptr_opt_result_buffer_all_ +#undef _Outptr_result_buffer_maybenull_ +#undef _Outptr_opt_result_buffer_maybenull_ +#undef _Outptr_result_buffer_to_maybenull_ +#undef _Outptr_opt_result_buffer_to_maybenull_ +#undef _Outptr_result_buffer_all_maybenull_ +#undef _Outptr_opt_result_buffer_all_maybenull_ +#undef _Outptr_result_bytebuffer_ +#undef _Outptr_opt_result_bytebuffer_ +#undef _Outptr_result_bytebuffer_to_ +#undef _Outptr_opt_result_bytebuffer_to_ +#undef _Outptr_result_bytebuffer_all_ +#undef _Outptr_opt_result_bytebuffer_all_ +#undef _Outptr_result_bytebuffer_maybenull_ +#undef _Outptr_opt_result_bytebuffer_maybenull_ +#undef _Outptr_result_bytebuffer_to_maybenull_ +#undef _Outptr_opt_result_bytebuffer_to_maybenull_ +#undef _Outptr_result_bytebuffer_all_maybenull_ +#undef _Outptr_opt_result_bytebuffer_all_maybenull_ +#undef _When_ +#undef __allocator +#undef __analysis_assert +#undef __analysis_assume +#undef __analysis_assume_nullterminated +#undef __analysis_hint +#undef __assume_bound +#undef __assume_validated +#undef __bcount +#undef __bcount_opt +#undef __blocksOn +#undef __bound +#undef __byte_readableTo +#undef __byte_writableTo +#undef __callback +#undef __checkReturn +#undef __class_code_content +#undef __control_entrypoint +#undef __data_entrypoint +#undef __deallocate +#undef __deallocate_opt +#undef __deref +#undef __deref_bcount +#undef __deref_bcount_opt +#undef __deref_ecount +#undef __deref_ecount_opt +#undef __deref_in +#undef __deref_in_bcount +#undef __deref_in_bcount_opt +#undef __deref_in_ecount +#undef __deref_in_ecount_opt +#undef __deref_in_ecount_iterator +#undef __deref_in_opt +#undef __deref_in_opt_out +#undef __deref_in_range +#undef __deref_in_xcount +#undef __deref_in_xcount_opt +#undef __deref_inout +#undef __deref_inout_bcount +#undef __deref_inout_bcount_full +#undef __deref_inout_bcount_full_opt +#undef __deref_inout_bcount_nz +#undef __deref_inout_bcount_nz_opt +#undef __deref_inout_bcount_opt +#undef __deref_inout_bcount_part +#undef __deref_inout_bcount_part_opt +#undef __deref_inout_bcount_z +#undef __deref_inout_bcount_z_opt +#undef __deref_inout_ecount +#undef __deref_inout_ecount_full +#undef __deref_inout_ecount_full_opt +#undef __deref_inout_ecount_nz +#undef __deref_inout_ecount_nz_opt +#undef __deref_inout_ecount_opt +#undef __deref_inout_ecount_part +#undef __deref_inout_ecount_part_opt +#undef __deref_inout_ecount_z +#undef __deref_inout_ecount_z_opt +#undef __deref_inout_ecount_iterator +#undef __deref_inout_nz +#undef __deref_inout_nz_opt +#undef __deref_inout_opt +#undef __deref_inout_range +#undef __deref_inout_xcount +#undef __deref_inout_xcount_full +#undef __deref_inout_xcount_full_opt +#undef __deref_inout_xcount_opt +#undef __deref_inout_xcount_part +#undef __deref_inout_xcount_part_opt +#undef __deref_inout_z +#undef __deref_inout_z_opt +#undef __deref_nonvolatile +#undef __deref_opt_bcount +#undef __deref_opt_bcount_opt +#undef __deref_opt_ecount +#undef __deref_opt_ecount_opt +#undef __deref_opt_in +#undef __deref_opt_in_bcount +#undef __deref_opt_in_bcount_opt +#undef __deref_opt_in_ecount +#undef __deref_opt_in_ecount_opt +#undef __deref_opt_in_opt +#undef __deref_opt_in_xcount +#undef __deref_opt_in_xcount_opt +#undef __deref_opt_inout +#undef __deref_opt_inout_bcount +#undef __deref_opt_inout_bcount_full +#undef __deref_opt_inout_bcount_full_opt +#undef __deref_opt_inout_bcount_nz +#undef __deref_opt_inout_bcount_nz_opt +#undef __deref_opt_inout_bcount_opt +#undef __deref_opt_inout_bcount_part +#undef __deref_opt_inout_bcount_part_opt +#undef __deref_opt_inout_bcount_z +#undef __deref_opt_inout_bcount_z_opt +#undef __deref_opt_inout_ecount +#undef __deref_opt_inout_ecount_full +#undef __deref_opt_inout_ecount_full_opt +#undef __deref_opt_inout_ecount_nz +#undef __deref_opt_inout_ecount_nz_opt +#undef __deref_opt_inout_ecount_opt +#undef __deref_opt_inout_ecount_part +#undef __deref_opt_inout_ecount_part_opt +#undef __deref_opt_inout_ecount_z +#undef __deref_opt_inout_ecount_z_opt +#undef __deref_opt_inout_nz +#undef __deref_opt_inout_nz_opt +#undef __deref_opt_inout_opt +#undef __deref_opt_inout_xcount +#undef __deref_opt_inout_xcount_full +#undef __deref_opt_inout_xcount_full_opt +#undef __deref_opt_inout_xcount_opt +#undef __deref_opt_inout_xcount_part +#undef __deref_opt_inout_xcount_part_opt +#undef __deref_opt_inout_z +#undef __deref_opt_inout_z_opt +#undef __deref_opt_out +#undef __deref_opt_out_bcount +#undef __deref_opt_out_bcount_full +#undef __deref_opt_out_bcount_full_opt +#undef __deref_opt_out_bcount_nz_opt +#undef __deref_opt_out_bcount_opt +#undef __deref_opt_out_bcount_part +#undef __deref_opt_out_bcount_part_opt +#undef __deref_opt_out_bcount_z_opt +#undef __deref_opt_out_ecount +#undef __deref_opt_out_ecount_full +#undef __deref_opt_out_ecount_full_opt +#undef __deref_opt_out_ecount_nz_opt +#undef __deref_opt_out_ecount_opt +#undef __deref_opt_out_ecount_part +#undef __deref_opt_out_ecount_part_opt +#undef __deref_opt_out_ecount_z_opt +#undef __deref_opt_out_nz_opt +#undef __deref_opt_out_opt +#undef __deref_opt_out_xcount +#undef __deref_opt_out_xcount_full +#undef __deref_opt_out_xcount_full_opt +#undef __deref_opt_out_xcount_opt +#undef __deref_opt_out_xcount_part +#undef __deref_opt_out_xcount_part_opt +#undef __deref_opt_out_z_opt +#undef __deref_opt_xcount +#undef __deref_opt_xcount_opt +#undef __deref_out +#undef __deref_out_bcount +#undef __deref_out_bcount_full +#undef __deref_out_bcount_full_opt +#undef __deref_out_bcount_nz +#undef __deref_out_bcount_nz_opt +#undef __deref_out_bcount_opt +#undef __deref_out_bcount_part +#undef __deref_out_bcount_part_opt +#undef __deref_out_bcount_z +#undef __deref_out_bcount_z_opt +#undef __deref_out_bound +#undef __deref_out_ecount +#undef __deref_out_ecount_full +#undef __deref_out_ecount_full_opt +#undef __deref_out_ecount_iterator +#undef __deref_out_ecount_nz +#undef __deref_out_ecount_nz_opt +#undef __deref_out_ecount_opt +#undef __deref_out_ecount_part +#undef __deref_out_ecount_part_opt +#undef __deref_out_ecount_z +#undef __deref_out_ecount_z_opt +#undef __deref_out_nz +#undef __deref_out_nz_opt +#undef __deref_out_opt +#undef __deref_out_range +#undef __deref_out_range +#undef __deref_out_xcount +#undef __deref_out_xcount +#undef __deref_out_xcount_full +#undef __deref_out_xcount_full_opt +#undef __deref_out_xcount_opt +#undef __deref_out_xcount_part +#undef __deref_out_xcount_part_opt +#undef __deref_out_z +#undef __deref_out_z_opt +#undef __deref_realloc_bcount +#undef __deref_volatile +#undef __deref_xcount +#undef __deref_xcount_opt +#undef __ecount +#undef __ecount_opt +#undef __elem_readableTo +#undef __elem_writableTo +#undef __encoded_array +#undef __encoded_pointer +#undef __exceptthat +#undef __fallthrough +#undef __field_bcount +#undef __field_bcount_full +#undef __field_bcount_full_opt +#undef __field_bcount_opt +#undef __field_bcount_part +#undef __field_bcount_part_opt +#undef __field_data_source +#undef __field_ecount +#undef __field_ecount_full +#undef __field_ecount_full_opt +#undef __field_ecount_opt +#undef __field_ecount_part +#undef __field_ecount_part_opt +#undef __field_encoded_array +#undef __field_encoded_pointer +#undef __field_nullterminated +#undef __field_range +#undef __field_xcount +#undef __field_xcount_full +#undef __field_xcount_full_opt +#undef __field_xcount_opt +#undef __field_xcount_part +#undef __field_xcount_part_opt +#undef __file_parser +#undef __file_parser_class +#undef __file_parser_library +#undef __format_string +#undef __format_string +#undef __gdi_entry +#undef __in +#undef __in_awcount +#undef __in_bcount +#undef __in_bcount_nz +#undef __in_bcount_nz_opt +#undef __in_bcount_opt +#undef __in_bcount_z +#undef __in_bcount_z_opt +#undef __in_bound +#undef __in_data_source +#undef __in_ecount +#undef __in_ecount_nz +#undef __in_ecount_nz_opt +#undef __in_ecount_opt +#undef __in_ecount_z +#undef __in_ecount_z_opt +#undef __in_nz +#undef __in_nz_opt +#undef __in_opt +#undef __in_range +#undef __in_xcount +#undef __in_xcount_opt +#undef __in_z +#undef __in_z_opt +#undef __inexpressible_readableTo +#undef __inexpressible_writableTo +#undef __inner_adt_add_prop +#undef __inner_adt_prop +#undef __inner_adt_remove_prop +#undef __inner_adt_transfer_prop +#undef __inner_adt_type_props +#undef __inner_analysis_assume_nulltermianted_dec +#undef __inner_analysis_assume_nullterminated +#undef __inner_assume_bound +#undef __inner_assume_bound_dec +#undef __inner_assume_validated +#undef __inner_assume_validated_dec +#undef __inner_blocksOn +#undef __inner_bound +#undef __inner_callback +#undef __inner_checkReturn +#undef __inner_compname_props +#undef __inner_control_entrypoint +#undef __inner_data_entrypoint +#undef __inner_data_source +#undef __inner_encoded +#undef __inner_fallthrough +#undef __inner_fallthrough_dec +#undef __inner_nonvolatile +#undef __inner_out_validated +#undef __inner_override +#undef __inner_possibly_notnullterminated +#undef __inner_range +#undef __inner_success +#undef __inner_transfer +#undef __inner_typefix +#undef __inner_volatile +#undef __inout +#undef __inout_bcount +#undef __inout_bcount_full +#undef __inout_bcount_full_opt +#undef __inout_bcount_nz +#undef __inout_bcount_nz_opt +#undef __inout_bcount_opt +#undef __inout_bcount_part +#undef __inout_bcount_part_opt +#undef __inout_bcount_z +#undef __inout_bcount_z_opt +#undef __inout_ecount +#undef __inout_ecount_full +#undef __inout_ecount_full_opt +#undef __inout_ecount_nz +#undef __inout_ecount_nz_opt +#undef __inout_ecount_opt +#undef __inout_ecount_part +#undef __inout_ecount_part_opt +#undef __inout_ecount_z +#undef __inout_ecount_z_opt +#undef __inout_ecount_z_opt +#undef __inout_nz +#undef __inout_nz_opt +#undef __inout_opt +#undef __inout_xcount +#undef __inout_xcount_full +#undef __inout_xcount_full_opt +#undef __inout_xcount_opt +#undef __inout_xcount_part +#undef __inout_xcount_part_opt +#undef __inout_z +#undef __inout_z_opt +#undef __kernel_entry +#undef __maybenull +#undef __maybereadonly +#undef __maybevalid +#undef __range_max +#undef __range_min +#undef __nonvolatile +#undef __notnull +#undef __notreadonly +#undef __notvalid +#undef __null +#undef __nullnullterminated +#undef __nullterminated +#undef __out +#undef __out_awcount +#undef __out_bcount +#undef __out_bcount_full +#undef __out_bcount_full_opt +#undef __out_bcount_nz +#undef __out_bcount_nz_opt +#undef __out_bcount_opt +#undef __out_bcount_part +#undef __out_bcount_part_opt +#undef __out_bcount_z +#undef __out_bcount_z_opt +#undef __out_bound +#undef __out_data_source +#undef __out_ecount +#undef __out_ecount_full +#undef __out_ecount_full_opt +#undef __out_ecount_nz +#undef __out_ecount_nz_opt +#undef __out_ecount_opt +#undef __out_ecount_part +#undef __out_ecount_part_opt +#undef __out_ecount_z +#undef __out_ecount_z_opt +#undef __out_has_adt_prop +#undef __out_has_type_adt_props +#undef __out_not_has_adt_prop +#undef __out_nz +#undef __out_nz_opt +#undef __out_opt +#undef __out_range +#undef __out_transfer_adt_prop +#undef __out_validated +#undef __out_xcount +#undef __out_xcount_full +#undef __out_xcount_full_opt +#undef __out_xcount_opt +#undef __out_xcount_part +#undef __out_xcount_part_opt +#undef __out_z +#undef __override +#undef __possibly_notnullterminated +#undef __post +#undef __post_invalid +#undef __postcond +#undef __post_nullnullterminated +#undef __pre +#undef __precond +#undef __range +#undef __readableTo +#undef __readonly +#undef __refparam +#undef __reserved +#undef __rpc_entry +#undef __source_code_content +#undef __struct_bcount +#undef __struct_xcount +#undef __success +#undef __this_out_data_source +#undef __this_out_validated +#undef __transfer +#undef __type_has_adt_prop +#undef __typefix +#undef __valid +#undef __volatile +#undef __writableTo +#undef __xcount +#undef __xcount_opt + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/srb.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/srb.h new file mode 100644 index 0000000000000000000000000000000000000000..89c737e8645cb7ecdb98ec3b9b9ab418141b3838 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/srb.h @@ -0,0 +1,2209 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + srb.h + +Abstract: + + This file defines the interface between SCSI mini-port drivers and the + SCSI port driver. It is also used by SCSI class drivers to talk to the + SCSI port driver. + +Revision History: + +--*/ + +//@[contract("ntoskrnl-srb"), comment("MVI_tracked - https://osgwiki.com/wiki/Microsoft_Virus_Initiative")]; + +#ifndef _NTSRB_ +#define _NTSRB_ + +#include + +#pragma warning(push) +#pragma warning(disable:4214) // nonstandard extension used : bit field types other than int +#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if DBG +#define DebugPrint(x) ScsiDebugPrint x +#else +#define DebugPrint(x) +#endif + +// begin_storport begin_privstorport + +// +// Define SCSI maximum configuration parameters. +// +// NOTE - the current SCSI_MAXIMUM_TARGETS_PER_BUS is applicable only +// on scsiport miniports. For storport miniports, the max target +// supported is 255. +// + +#define SCSI_MAXIMUM_BUSES_PER_ADAPTER 255 +#define SCSI_MAXIMUM_TARGETS_PER_BUS 128 +#define SCSI_MAXIMUM_LUNS_PER_TARGET 255 +#define SCSI_MINIMUM_PHYSICAL_BREAKS 16 +#define SCSI_MAXIMUM_PHYSICAL_BREAKS 255 + +#define SCSI_COMBINE_BUS_TARGET( Bus, Target ) ( \ + ((((UCHAR) (Target)) & ~(0x20 - 1)) << 8) | \ + (((UCHAR) (Bus)) << 5) | \ + (((UCHAR) (Target)) & (0x20 - 1))) + +#define SCSI_DECODE_BUS_TARGET( Value, Bus, Target ) ( \ + Bus = (UCHAR) ((Value) >> 5), \ + Target = (UCHAR) ((((Value) >> 8) & ~(0x20 - 1)) | ((Value) & (0x20 - 1)))) + +// +// This constant is for backward compatibility. +// This use to be the maximum supported. +// + +#define SCSI_MAXIMUM_BUSES 8 +#define SCSI_MAXIMUM_TARGETS 8 +#define SCSI_MAXIMUM_LOGICAL_UNITS 8 + +//end_storport end_privstorport + +typedef PHYSICAL_ADDRESS SCSI_PHYSICAL_ADDRESS, *PSCSI_PHYSICAL_ADDRESS; + +typedef struct _ACCESS_RANGE { + SCSI_PHYSICAL_ADDRESS RangeStart; + ULONG RangeLength; + BOOLEAN RangeInMemory; +}ACCESS_RANGE, *PACCESS_RANGE; + +// +// Configuration information structure. Contains the information necessary +// to initialize the adapter. NOTE: This structure's must be a multiple of +// quadwords. +// + +typedef struct _PORT_CONFIGURATION_INFORMATION { + + // + // Length of port configuation information strucuture. + // + + ULONG Length; + + // + // IO bus number (0 for machines that have only 1 IO bus + // + + ULONG SystemIoBusNumber; + + // + // EISA, MCA or ISA + // + + INTERFACE_TYPE AdapterInterfaceType; + + // + // Interrupt request level for device + // + + ULONG BusInterruptLevel; + + // + // Bus interrupt vector used with hardware buses which use as vector as + // well as level, such as internal buses. + // + + ULONG BusInterruptVector; + + // + // Interrupt mode (level-sensitive or edge-triggered) + // + + KINTERRUPT_MODE InterruptMode; + + // + // Maximum number of bytes that can be transferred in a single SRB + // + + ULONG MaximumTransferLength; + + // + // Number of contiguous blocks of physical memory + // + + ULONG NumberOfPhysicalBreaks; + + // + // DMA channel for devices using system DMA + // + + ULONG DmaChannel; + ULONG DmaPort; + DMA_WIDTH DmaWidth; + DMA_SPEED DmaSpeed; + + // + // Alignment masked required by the adapter for data transfers. + // + + ULONG AlignmentMask; + + // + // Number of access range elements which have been allocated. + // + + ULONG NumberOfAccessRanges; + + // + // Pointer to array of access range elements. + // + + ACCESS_RANGE (*AccessRanges)[]; + + // + // Reserved field. + // + + PVOID Reserved; + + // + // Number of SCSI buses attached to the adapter. + // + + UCHAR NumberOfBuses; + + // + // SCSI bus ID for adapter + // + + UCHAR InitiatorBusId[8]; + + // + // Indicates that the adapter does scatter/gather + // + + BOOLEAN ScatterGather; + + // + // Indicates that the adapter is a bus master + // + + BOOLEAN Master; + + // + // Host caches data or state. + // + + BOOLEAN CachesData; + + // + // Host adapter scans down for bios devices. + // + + BOOLEAN AdapterScansDown; + + // + // Primary at disk address (0x1F0) claimed. + // + + BOOLEAN AtdiskPrimaryClaimed; + + // + // Secondary at disk address (0x170) claimed. + // + + BOOLEAN AtdiskSecondaryClaimed; + + // + // The master uses 32-bit DMA addresses. + // + + BOOLEAN Dma32BitAddresses; + + // + // Use Demand Mode DMA rather than Single Request. + // + + BOOLEAN DemandMode; + + // + // Data buffers must be mapped into virtual address space. + // + + BOOLEAN MapBuffers; + + // + // The driver will need to tranlate virtual to physical addresses. + // + + BOOLEAN NeedPhysicalAddresses; + + // + // Supports tagged queuing + // + + BOOLEAN TaggedQueuing; + + // + // Supports auto request sense. + // + + BOOLEAN AutoRequestSense; + + // + // Supports multiple requests per logical unit. + // + + BOOLEAN MultipleRequestPerLu; + + // + // Support receive event function. + // + + BOOLEAN ReceiveEvent; + + // + // Indicates the real-mode driver has initialized the card. + // + + BOOLEAN RealModeInitialized; + + // + // Indicate that the miniport will not touch the data buffers directly. + // + + BOOLEAN BufferAccessScsiPortControlled; + + // + // Indicator for wide scsi. + // + + UCHAR MaximumNumberOfTargets; + + // + // Ensure quadword alignment. + // + + UCHAR ReservedUchars[2]; + + // + // Adapter slot number + // + + ULONG SlotNumber; + + // + // Interrupt information for a second IRQ. + // + + ULONG BusInterruptLevel2; + ULONG BusInterruptVector2; + KINTERRUPT_MODE InterruptMode2; + + // + // DMA information for a second channel. + // + + ULONG DmaChannel2; + ULONG DmaPort2; + DMA_WIDTH DmaWidth2; + DMA_SPEED DmaSpeed2; + + // + // Fields added to allow for the miniport + // to update these sizes based on requirements + // for large transfers ( > 64K); + // + + ULONG DeviceExtensionSize; + ULONG SpecificLuExtensionSize; + ULONG SrbExtensionSize; + + // + // Used to determine whether the system and/or the miniport support + // 64-bit physical addresses. See SCSI_DMA64_* flags below. + // + + UCHAR Dma64BitAddresses; /* New */ + + // + // Indicates that the miniport can accept a SRB_FUNCTION_RESET_DEVICE + // to clear all requests to a particular LUN. + // + + BOOLEAN ResetTargetSupported; /* New */ + + // + // Indicates that the miniport can support more than 8 logical units per + // target (maximum LUN number is one less than this field). + // + + UCHAR MaximumNumberOfLogicalUnits; /* New */ + + // + // Supports WMI? + // + + BOOLEAN WmiDataProvider; + +} PORT_CONFIGURATION_INFORMATION, *PPORT_CONFIGURATION_INFORMATION; + +// +// Version control for ConfigInfo structure. +// + +#define CONFIG_INFO_VERSION_2 sizeof(PORT_CONFIGURATION_INFORMATION) + + +// +// Flags for controlling 64-bit DMA use (PORT_CONFIGURATION_INFORMATION field +// Dma64BitAddresses) +// + +// +// Set by scsiport on entering HwFindAdapter if the system can support 64-bit +// physical addresses. The miniport can use this information before calling +// ScsiPortGetUncachedExtension to modify the DeviceExtensionSize, +// SpecificLuExtensionSize & SrbExtensionSize fields to account for the extra +// size of the scatter gather list. +// + +#define SCSI_DMA64_SYSTEM_SUPPORTED 0x80 + +// +// Set by the miniport before calling ScsiPortGetUncachedExtension to indicate +// that scsiport should provide it with 64-bit physical addresses. If the +// system does not support 64-bit PA's then this bit will be ignored. +// + +#define SCSI_DMA64_MINIPORT_SUPPORTED 0x01 + +#if (NTDDI_VERSION > NTDDI_WS03SP1) +// +// Set by the miniport before calling ScsiPortGetUncachedExtension to indicate +// that scsiport should provide it with 64-bit physical addresses. +// In addition to I/O requests being handled with > 4GB physical addresses, +// the uncached extension, SenseInof and Srb Extension may all lie above 4GB. +// If the system does not support 64-bit PA's then this bit will be ignored. +// + +#define SCSI_DMA64_MINIPORT_FULL64BIT_SUPPORTED 0x02 +#endif + + +// +// Command type (and parameter) definition(s) for AdapterControl requests. +// + +typedef enum _SCSI_ADAPTER_CONTROL_TYPE { + ScsiQuerySupportedControlTypes = 0, + ScsiStopAdapter, + ScsiRestartAdapter, + ScsiSetBootConfig, + ScsiSetRunningConfig, + ScsiAdapterControlMax, + MakeAdapterControlTypeSizeOfUlong = 0xffffffff +} SCSI_ADAPTER_CONTROL_TYPE, *PSCSI_ADAPTER_CONTROL_TYPE; + +// +// Adapter control status values +// + +typedef enum _SCSI_ADAPTER_CONTROL_STATUS { + ScsiAdapterControlSuccess = 0, + ScsiAdapterControlUnsuccessful +} SCSI_ADAPTER_CONTROL_STATUS, *PSCSI_ADAPTER_CONTROL_STATUS; + +// +// Parameters for Adapter Control Functions: +// + +// +// ScsiQuerySupportedControlTypes: +// + +#pragma warning(disable:4200) +typedef struct _SCSI_SUPPORTED_CONTROL_TYPE_LIST { + + // + // Specifies the number of entries in the adapter control type list. + // + + IN ULONG MaxControlType; + + // + // The miniport will set TRUE for each control type it supports. + // The number of entries in this array is defined by MaxAdapterControlType + // - the miniport must not attempt to set any AC types beyond the maximum + // value specified. + // + + OUT BOOLEAN SupportedTypeList[0]; + +} SCSI_SUPPORTED_CONTROL_TYPE_LIST, *PSCSI_SUPPORTED_CONTROL_TYPE_LIST; +#pragma warning(default:4200) + +// begin_storport begin_privstorport + +// +// Uninitialized flag value. +// + +#define SP_UNINITIALIZED_VALUE ((ULONG) ~0) +#define SP_UNTAGGED ((UCHAR) ~0) + +// +// Set asynchronous events. +// + +#define SRBEV_BUS_RESET 0x0001 +#define SRBEV_SCSI_ASYNC_NOTIFICATION 0x0002 + +// begin_ntminitape + +#define MAXIMUM_CDB_SIZE 12 + +// +// SCSI I/O Request Block +// + +//@[comment("MVI_tracked")] +typedef struct _SCSI_REQUEST_BLOCK { + USHORT Length; // offset 0 + UCHAR Function; // offset 2 + UCHAR SrbStatus; // offset 3 + UCHAR ScsiStatus; // offset 4 + UCHAR PathId; // offset 5 + UCHAR TargetId; // offset 6 + UCHAR Lun; // offset 7 + UCHAR QueueTag; // offset 8 + UCHAR QueueAction; // offset 9 + UCHAR CdbLength; // offset a + UCHAR SenseInfoBufferLength; // offset b + ULONG SrbFlags; // offset c + ULONG DataTransferLength; // offset 10 + ULONG TimeOutValue; // offset 14 + _Field_size_bytes_(DataTransferLength) + PVOID DataBuffer; // offset 18 + PVOID SenseInfoBuffer; // offset 1c + struct _SCSI_REQUEST_BLOCK *NextSrb; // offset 20 + PVOID OriginalRequest; // offset 24 + PVOID SrbExtension; // offset 28 + union { + ULONG InternalStatus; // offset 2c + ULONG QueueSortKey; // offset 2c + ULONG LinkTimeoutValue; // offset 2c + }; + +#if defined(_WIN64) + + // + // Force PVOID alignment of Cdb + // + + ULONG Reserved; + +#endif + + UCHAR Cdb[16]; // offset 30 +} SCSI_REQUEST_BLOCK, *PSCSI_REQUEST_BLOCK; + +#define SCSI_REQUEST_BLOCK_SIZE sizeof(SCSI_REQUEST_BLOCK) + +// +// SCSI I/O Request Block for WMI Requests +// + +typedef struct _SCSI_WMI_REQUEST_BLOCK { + USHORT Length; + UCHAR Function; // SRB_FUNCTION_WMI + UCHAR SrbStatus; + UCHAR WMISubFunction; + UCHAR PathId; // If SRB_WMI_FLAGS_ADAPTER_REQUEST is set in + UCHAR TargetId; // WMIFlags then PathId, TargetId and Lun are + UCHAR Lun; // reserved fields. + UCHAR Reserved1; + UCHAR WMIFlags; + UCHAR Reserved2[2]; + ULONG SrbFlags; + ULONG DataTransferLength; + ULONG TimeOutValue; + PVOID DataBuffer; + PVOID DataPath; + PVOID Reserved3; + PVOID OriginalRequest; + PVOID SrbExtension; + ULONG Reserved4; + +#if (NTDDI_VERSION >= NTDDI_WS03SP1) +#if defined(_WIN64) + + // + // Force PVOID alignment of Cdb + // + + ULONG Reserved6; + +#endif +#endif + + UCHAR Reserved5[16]; +} SCSI_WMI_REQUEST_BLOCK, *PSCSI_WMI_REQUEST_BLOCK; + +typedef enum _STOR_DEVICE_POWER_STATE { + StorPowerDeviceUnspecified = 0, + StorPowerDeviceD0, + StorPowerDeviceD1, + StorPowerDeviceD2, + StorPowerDeviceD3, + StorPowerDeviceMaximum +} STOR_DEVICE_POWER_STATE, *PSTOR_DEVICE_POWER_STATE; + +typedef enum { + StorPowerActionNone = 0, + StorPowerActionReserved, + StorPowerActionSleep, + StorPowerActionHibernate, + StorPowerActionShutdown, + StorPowerActionShutdownReset, + StorPowerActionShutdownOff, + StorPowerActionWarmEject +} STOR_POWER_ACTION, *PSTOR_POWER_ACTION; + +typedef struct _SCSI_POWER_REQUEST_BLOCK { + USHORT Length; // offset 0 + UCHAR Function; // offset 2 + UCHAR SrbStatus; // offset 3 + UCHAR SrbPowerFlags; // offset 4 + UCHAR PathId; // offset 5 + UCHAR TargetId; // offset 6 + UCHAR Lun; // offset 7 + STOR_DEVICE_POWER_STATE DevicePowerState; // offset 8 + ULONG SrbFlags; // offset c + ULONG DataTransferLength; // offset 10 + ULONG TimeOutValue; // offset 14 + PVOID DataBuffer; // offset 18 + PVOID SenseInfoBuffer; // offset 1c + struct _SCSI_REQUEST_BLOCK *NextSrb; // offset 20 + PVOID OriginalRequest; // offset 24 + PVOID SrbExtension; // offset 28 + STOR_POWER_ACTION PowerAction; // offset 2c + +#if defined(_WIN64) + + // + // Force PVOID alignment of Cdb + // + + ULONG Reserved; + +#endif + + UCHAR Reserved5[16]; // offset 30 +} SCSI_POWER_REQUEST_BLOCK, *PSCSI_POWER_REQUEST_BLOCK; + +// +// PNP minor function codes. +// +typedef enum { + StorStartDevice = 0x0, + StorRemoveDevice = 0x2, + StorStopDevice = 0x4, + StorQueryCapabilities = 0x9, + StorQueryResourceRequirements = 0xB, + StorFilterResourceRequirements = 0xD, + StorSurpriseRemoval = 0x17 +} STOR_PNP_ACTION, *PSTOR_PNP_ACTION; + +typedef struct _STOR_DEVICE_CAPABILITIES { + USHORT Version; + ULONG DeviceD1:1; + ULONG DeviceD2:1; + ULONG LockSupported:1; + ULONG EjectSupported:1; + ULONG Removable:1; + ULONG DockDevice:1; + ULONG UniqueID:1; + ULONG SilentInstall:1; + ULONG SurpriseRemovalOK:1; + ULONG NoDisplayInUI:1; + +} STOR_DEVICE_CAPABILITIES, *PSTOR_DEVICE_CAPABILITIES; + + +#define STOR_DEVICE_CAPABILITIES_EX_VERSION_1 0x1 + +typedef struct _STOR_DEVICE_CAPABILITIES_EX { + USHORT Version; + USHORT Size; + ULONG DeviceD1:1; + ULONG DeviceD2:1; + ULONG LockSupported:1; + ULONG EjectSupported:1; + ULONG Removable:1; + ULONG DockDevice:1; + ULONG UniqueID:1; + ULONG SilentInstall:1; + ULONG RawDeviceOK:1; + ULONG SurpriseRemovalOK:1; + ULONG NoDisplayInUI:1; + ULONG DefaultWriteCacheEnabled:1; + ULONG Reserved0:20; + + ULONG Address; + ULONG UINumber; + + ULONG Reserved1[2]; +} STOR_DEVICE_CAPABILITIES_EX, *PSTOR_DEVICE_CAPABILITIES_EX; + +typedef struct _SCSI_PNP_REQUEST_BLOCK { + USHORT Length; // offset 0 + UCHAR Function; // offset 2 + UCHAR SrbStatus; // offset 3 + UCHAR PnPSubFunction; // offset 4 + UCHAR PathId; // offset 5 + UCHAR TargetId; // offset 6 + UCHAR Lun; // offset 7 + STOR_PNP_ACTION PnPAction; // offset 8 + ULONG SrbFlags; // offset c + ULONG DataTransferLength; // offset 10 + ULONG TimeOutValue; // offset 14 + PVOID DataBuffer; // offset 18 + PVOID SenseInfoBuffer; // offset 1c + struct _SCSI_REQUEST_BLOCK *NextSrb; // offset 20 + PVOID OriginalRequest; // offset 24 + PVOID SrbExtension; // offset 28 + ULONG SrbPnPFlags; // offset 2c + +#if defined(_WIN64) + + // + // Force PVOID alignment of Cdb + // + + ULONG Reserved; + +#endif + UCHAR Reserved4[16]; // offset 30 +} SCSI_PNP_REQUEST_BLOCK, *PSCSI_PNP_REQUEST_BLOCK; + +// +// SRB Functions +// + +#define SRB_FUNCTION_EXECUTE_SCSI 0x00 +#define SRB_FUNCTION_CLAIM_DEVICE 0x01 +#define SRB_FUNCTION_IO_CONTROL 0x02 +#define SRB_FUNCTION_RECEIVE_EVENT 0x03 +#define SRB_FUNCTION_RELEASE_QUEUE 0x04 +#define SRB_FUNCTION_ATTACH_DEVICE 0x05 +#define SRB_FUNCTION_RELEASE_DEVICE 0x06 +#define SRB_FUNCTION_SHUTDOWN 0x07 +#define SRB_FUNCTION_FLUSH 0x08 +#define SRB_FUNCTION_PROTOCOL_COMMAND 0x09 +#define SRB_FUNCTION_EXECUTE_NVME 0x0A +#define SRB_FUNCTION_ABORT_COMMAND 0x10 +#define SRB_FUNCTION_RELEASE_RECOVERY 0x11 +#define SRB_FUNCTION_RESET_BUS 0x12 +#define SRB_FUNCTION_RESET_DEVICE 0x13 +#define SRB_FUNCTION_TERMINATE_IO 0x14 +#define SRB_FUNCTION_FLUSH_QUEUE 0x15 +#define SRB_FUNCTION_REMOVE_DEVICE 0x16 +#define SRB_FUNCTION_WMI 0x17 +#define SRB_FUNCTION_LOCK_QUEUE 0x18 +#define SRB_FUNCTION_UNLOCK_QUEUE 0x19 +#define SRB_FUNCTION_QUIESCE_DEVICE 0x1a +#define SRB_FUNCTION_RESET_LOGICAL_UNIT 0x20 +#define SRB_FUNCTION_SET_LINK_TIMEOUT 0x21 +#define SRB_FUNCTION_LINK_TIMEOUT_OCCURRED 0x22 +#define SRB_FUNCTION_LINK_TIMEOUT_COMPLETE 0x23 +#define SRB_FUNCTION_POWER 0x24 +#define SRB_FUNCTION_PNP 0x25 +#define SRB_FUNCTION_DUMP_POINTERS 0x26 +#define SRB_FUNCTION_FREE_DUMP_POINTERS 0x27 + + +// +// Define extended SRB function that will be used to identify a new +// type of SRB that is not a SCSI_REQUEST_BLOCK. A +// SRB_FUNCTION_STORAGE_REQUEST_BLOCK will use a SRB that is of type +// STORAGE_REQUEST_BLOCK. +// +#define SRB_FUNCTION_STORAGE_REQUEST_BLOCK 0x28 + +#define SRB_FUNCTION_GET_DUMP_INFO 0x2a +#define SRB_FUNCTION_FREE_DUMP_INFO 0x2b + +#define SRB_FUNCTION_NVMEOF_OPERATION 0x2c + +#define SRB_FUNCTION_MINIPORT_PASSTHROUGH_REQUEST 0x2d + +// +// SRB Status +// + +#define SRB_STATUS_PENDING 0x00 +#define SRB_STATUS_SUCCESS 0x01 +#define SRB_STATUS_ABORTED 0x02 +#define SRB_STATUS_ABORT_FAILED 0x03 +#define SRB_STATUS_ERROR 0x04 +#define SRB_STATUS_BUSY 0x05 +#define SRB_STATUS_INVALID_REQUEST 0x06 +#define SRB_STATUS_INVALID_PATH_ID 0x07 +#define SRB_STATUS_NO_DEVICE 0x08 +#define SRB_STATUS_TIMEOUT 0x09 +#define SRB_STATUS_SELECTION_TIMEOUT 0x0A +#define SRB_STATUS_COMMAND_TIMEOUT 0x0B +#define SRB_STATUS_MESSAGE_REJECTED 0x0D +#define SRB_STATUS_BUS_RESET 0x0E +#define SRB_STATUS_PARITY_ERROR 0x0F +#define SRB_STATUS_REQUEST_SENSE_FAILED 0x10 +#define SRB_STATUS_NO_HBA 0x11 +#define SRB_STATUS_DATA_OVERRUN 0x12 +#define SRB_STATUS_UNEXPECTED_BUS_FREE 0x13 +#define SRB_STATUS_PHASE_SEQUENCE_FAILURE 0x14 +#define SRB_STATUS_BAD_SRB_BLOCK_LENGTH 0x15 +#define SRB_STATUS_REQUEST_FLUSHED 0x16 +#define SRB_STATUS_ACCESS_DENIED 0x17 +#define SRB_STATUS_OPERATION_IN_PROGRESS 0x18 +#define SRB_STATUS_INVALID_LUN 0x20 +#define SRB_STATUS_INVALID_TARGET_ID 0x21 +#define SRB_STATUS_BAD_FUNCTION 0x22 +#define SRB_STATUS_ERROR_RECOVERY 0x23 +#define SRB_STATUS_NOT_POWERED 0x24 +#define SRB_STATUS_LINK_DOWN 0x25 +#define SRB_STATUS_INSUFFICIENT_RESOURCES 0x26 +#define SRB_STATUS_THROTTLED_REQUEST 0x27 +#define SRB_STATUS_INVALID_PARAMETER 0x28 + + +// +// This value is used by the port driver to indicate that a non-scsi-related +// error occured. Miniports must never return this status. +// + +#define SRB_STATUS_INTERNAL_ERROR 0x30 + +// +// Srb status values 0x38 through 0x3f are reserved for internal port driver +// use. +// + +// +// SRB Status Masks +// + +#define SRB_STATUS_QUEUE_FROZEN 0x40 +#define SRB_STATUS_AUTOSENSE_VALID 0x80 + +#define SRB_STATUS(Status) (Status & ~(SRB_STATUS_AUTOSENSE_VALID | SRB_STATUS_QUEUE_FROZEN)) + +// +// SRB Flag Bits +// + +#define SRB_FLAGS_QUEUE_ACTION_ENABLE 0x00000002 +#define SRB_FLAGS_DISABLE_DISCONNECT 0x00000004 +#define SRB_FLAGS_DISABLE_SYNCH_TRANSFER 0x00000008 + +#define SRB_FLAGS_BYPASS_FROZEN_QUEUE 0x00000010 +#define SRB_FLAGS_DISABLE_AUTOSENSE 0x00000020 +#define SRB_FLAGS_DATA_IN 0x00000040 +#define SRB_FLAGS_DATA_OUT 0x00000080 +#define SRB_FLAGS_NO_DATA_TRANSFER 0x00000000 +#define SRB_FLAGS_UNSPECIFIED_DIRECTION (SRB_FLAGS_DATA_IN | SRB_FLAGS_DATA_OUT) + +#define SRB_FLAGS_NO_QUEUE_FREEZE 0x00000100 +#define SRB_FLAGS_ADAPTER_CACHE_ENABLE 0x00000200 +#define SRB_FLAGS_FREE_SENSE_BUFFER 0x00000400 + +// +// This flag indicates the request is part of the workflow for processing a D3. +// +#define SRB_FLAGS_D3_PROCESSING 0x00000800 + +// +// This flag indicates that LBA range falls into sequential write required zone +// +#define SRB_FLAGS_SEQUENTIAL_REQUIRED 0x00001000 + + +#define SRB_FLAGS_IS_ACTIVE 0x00010000 +#define SRB_FLAGS_ALLOCATED_FROM_ZONE 0x00020000 +#define SRB_FLAGS_SGLIST_FROM_POOL 0x00040000 +#define SRB_FLAGS_BYPASS_LOCKED_QUEUE 0x00080000 + +#define SRB_FLAGS_NO_KEEP_AWAKE 0x00100000 +#define SRB_FLAGS_PORT_DRIVER_ALLOCSENSE 0x00200000 + +#define SRB_FLAGS_PORT_DRIVER_SENSEHASPORT 0x00400000 +#define SRB_FLAGS_DONT_START_NEXT_PACKET 0x00800000 + +#define SRB_FLAGS_PORT_DRIVER_RESERVED 0x0F000000 +#define SRB_FLAGS_CLASS_DRIVER_RESERVED 0xF0000000 + +#if DBG==1 +// +// A signature used to validate the scsi port number +// at the end of a sense buffer. +// +#define SCSI_PORT_SIGNATURE 0x54524f50 +#endif + +// +// Queue Action +// + +#define SRB_SIMPLE_TAG_REQUEST 0x20 +#define SRB_HEAD_OF_QUEUE_TAG_REQUEST 0x21 +#define SRB_ORDERED_QUEUE_TAG_REQUEST 0x22 + +#define SRB_WMI_FLAGS_ADAPTER_REQUEST 0x01 +#define SRB_POWER_FLAGS_ADAPTER_REQUEST 0x01 +#define SRB_PNP_FLAGS_ADAPTER_REQUEST 0x01 +#define SRB_IOCTL_FLAGS_ADAPTER_REQUEST 0x01 +#define SRB_PROTOCOL_FLAGS_ADAPTER_REQUEST 0x01 + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +// +// Define alignment requirements for variable length components in extended +// SRB. For Win64, need to ensure all variable length components are 8 bytes +// align so the pointer fields within the variable length components are 8 +// bytes align. Also define pointer field alignment. +// +#if defined(_WIN64) || defined(_M_ALPHA) +#define SRB_ALIGN DECLSPEC_ALIGN(8) +#define STOR_ADDRESS_ALIGN DECLSPEC_ALIGN(8) +#define POINTER_ALIGN DECLSPEC_ALIGN(8) +#else +#define SRB_ALIGN +#define STOR_ADDRESS_ALIGN +#define POINTER_ALIGN +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) + +// +// This is the STOR_ADDRESS type used by StorMQ. +// The Controller field will contain the StorMQ controller extension known to the miniport. +// + +// +// N.B. The other legacy STOR_ADDRESS_TYPE_xxx values and structs are defined in scsi.h. +// Any updates to STOR_ADDRESS should be put here to not introduce new dependencies on legacy +// SCSI infrastructure. +// +#define STOR_ADDRESS_TYPE_NVME 0x2 + +#define STOR_ADDR_NVME_ADDRESS_LENGTH 16 +typedef struct STOR_ADDRESS_ALIGN _STOR_ADDR_NVME { + _Field_range_(STOR_ADDRESS_TYPE_NVME, STOR_ADDRESS_TYPE_NVME) + USHORT Type; + USHORT Port; + _Field_range_(STOR_ADDR_NVME_ADDRESS_LENGTH, STOR_ADDR_NVME_ADDRESS_LENGTH) + ULONG AddressLength; + PVOID Controller; + ULONG NamespaceId; + ULONG Reserved; +} STOR_ADDR_NVME, *PSTOR_ADDR_NVME; + +#endif + +// SRB extended data types. + + +typedef enum _SRBEXDATATYPE { + SrbExDataTypeUnknown = 0, + SrbExDataTypeBidirectional, + SrbExDataTypeScsiCdb16 = 0x40, + SrbExDataTypeScsiCdb32, + SrbExDataTypeScsiCdbVar, + SrbExDataTypeNvmeCommand, + SrbExDataTypeNvmeofOperation, + SrbExDataTypeMiniportPassthrough, + SrbExDataTypeWmi = 0x60, + SrbExDataTypePower, + SrbExDataTypePnP, + SrbExDataTypeIoInfo = 0x80, + SrbExDataTypePassthroughDirect = 0xa0, + SrbExDataTypeMSReservedStart = 0xf0000000, + SrbExDataTypeReserved = 0xffffffff +} SRBEXDATATYPE, *PSRBEXDATATYPE; + +// +// Generic structure definition for accessing any SRB extended data. All SRB +// extended data must begin with a Type and Length field. +// +typedef struct SRB_ALIGN _SRBEX_DATA { + SRBEXDATATYPE Type; + ULONG Length; + _Field_size_bytes_(Length) UCHAR Data[ANYSIZE_ARRAY]; +} SRBEX_DATA, *PSRBEX_DATA; + +// +// SRB extended data for bi-directional commands. For these SRBs, it will have both a +// SRB extended data (e.g. SRBEX_DATA_SCSI_CDB*) and a SRBEX_DATA_BIDIRECTIONAL. +// +#define SRBEX_DATA_BIDIRECTIONAL_LENGTH ((2 * sizeof(ULONG)) + sizeof(PVOID)) + +typedef struct SRB_ALIGN _SRBEX_DATA_BIDIRECTIONAL { + _Field_range_(SrbExDataTypeBidirectional, SrbExDataTypeBidirectional) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_BIDIRECTIONAL_LENGTH, SRBEX_DATA_BIDIRECTIONAL_LENGTH) + ULONG Length; + ULONG DataInTransferLength; + // Reserved for future to support 64-bit DataTransferInLength + ULONG Reserved1; + _Field_size_bytes_full_(DataInTransferLength) + PVOID POINTER_ALIGN DataInBuffer; +} SRBEX_DATA_BIDIRECTIONAL, *PSRBEX_DATA_BIDIRECTIONAL; + + +// SRB_FUNCTION_EXECUTE_SCSI for up to 16 byte CDBs +#define SRBEX_DATA_SCSI_CDB16_LENGTH ((20 * sizeof(UCHAR)) + sizeof(ULONG) + sizeof(PVOID)) + +typedef struct SRB_ALIGN _SRBEX_DATA_SCSI_CDB16 { + _Field_range_(SrbExDataTypeScsiCdb16, SrbExDataTypeScsiCdb16) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_SCSI_CDB16_LENGTH, SRBEX_DATA_SCSI_CDB16_LENGTH) + ULONG Length; + UCHAR ScsiStatus; + UCHAR SenseInfoBufferLength; + UCHAR CdbLength; + UCHAR Reserved; + ULONG Reserved1; + _Field_size_bytes_full_(SenseInfoBufferLength) + PVOID POINTER_ALIGN SenseInfoBuffer; + UCHAR POINTER_ALIGN Cdb[16]; +} SRBEX_DATA_SCSI_CDB16, *PSRBEX_DATA_SCSI_CDB16; + +// SRB_FUNCTION_EXECUTE_SCSI for up to 32 byte CDBs +#define SRBEX_DATA_SCSI_CDB32_LENGTH ((36 * sizeof(UCHAR)) + sizeof(ULONG) + sizeof(PVOID)) + +typedef struct SRB_ALIGN _SRBEX_DATA_SCSI_CDB32 { + _Field_range_(SrbExDataTypeScsiCdb32, SrbExDataTypeScsiCdb32) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_SCSI_CDB32_LENGTH, SRBEX_DATA_SCSI_CDB32_LENGTH) + ULONG Length; + UCHAR ScsiStatus; + UCHAR SenseInfoBufferLength; + UCHAR CdbLength; + UCHAR Reserved; + ULONG Reserved1; + _Field_size_bytes_full_(SenseInfoBufferLength) + PVOID POINTER_ALIGN SenseInfoBuffer; + UCHAR POINTER_ALIGN Cdb[32]; +} SRBEX_DATA_SCSI_CDB32, *PSRBEX_DATA_SCSI_CDB32; + +// SRB_FUNCTION_EXECUTE_SCSI for variable length CDBs +#define SRBEX_DATA_SCSI_CDB_VAR_LENGTH_MIN ((4 * sizeof(UCHAR)) + (3 * sizeof(ULONG)) + sizeof(PVOID)) + +// +// NOTE - may want to cap it instead of using ULONG_MAX. Max is 65KB +// currently (XCDB) +// +#define SRBEX_DATA_SCSI_CDB_VAR_LENGTH_MAX 0xffffffffUL + +typedef struct SRB_ALIGN _SRBEX_DATA_SCSI_CDB_VAR { + _Field_range_(SrbExDataTypeScsiCdbVar, SrbExDataTypeScsiCdbVar) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_SCSI_CDB_VAR_LENGTH_MIN, SRBEX_DATA_SCSI_CDB_VAR_LENGTH_MAX) + ULONG Length; + UCHAR ScsiStatus; + UCHAR SenseInfoBufferLength; + UCHAR Reserved[2]; + ULONG CdbLength; + ULONG Reserved1[2]; + _Field_size_bytes_full_(SenseInfoBufferLength) + PVOID POINTER_ALIGN SenseInfoBuffer; + _Field_size_bytes_full_(CdbLength) + UCHAR POINTER_ALIGN Cdb[ANYSIZE_ARRAY]; +} SRBEX_DATA_SCSI_CDB_VAR, *PSRBEX_DATA_SCSI_CDB_VAR; + +// Used by SRB_FUNCTION_WMI +#define SRBEX_DATA_WMI_LENGTH ((4 * sizeof(UCHAR)) + sizeof(ULONG) + sizeof(PVOID)) + +typedef struct SRB_ALIGN _SRBEX_DATA_WMI { + _Field_range_(SrbExDataTypeWmi, SrbExDataTypeWmi) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_WMI_LENGTH, SRBEX_DATA_WMI_LENGTH) + ULONG Length; + UCHAR WMISubFunction; + UCHAR WMIFlags; + UCHAR Reserved[2]; + ULONG Reserved1; + PVOID POINTER_ALIGN DataPath; +} SRBEX_DATA_WMI, *PSRBEX_DATA_WMI; + +// Used by SRB_FUNCTION_POWER +#define SRBEX_DATA_POWER_LENGTH ((4 * sizeof(UCHAR)) + sizeof(STOR_DEVICE_POWER_STATE) + sizeof(STOR_POWER_ACTION)) + +typedef struct SRB_ALIGN _SRBEX_DATA_POWER { + _Field_range_(SrbExDataTypePower, SrbExDataTypePower) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_POWER_LENGTH, SRBEX_DATA_POWER_LENGTH) + ULONG Length; + UCHAR SrbPowerFlags; + UCHAR Reserved[3]; + STOR_DEVICE_POWER_STATE DevicePowerState; + STOR_POWER_ACTION PowerAction; +} SRBEX_DATA_POWER, *PSRBEX_DATA_POWER; + +// Used by SRB_FUNCTION_PNP +#define SRBEX_DATA_PNP_LENGTH ((4 * sizeof(UCHAR)) + sizeof(STOR_PNP_ACTION) + (2 * sizeof(ULONG))) + +typedef struct SRB_ALIGN _SRBEX_DATA_PNP { + _Field_range_(SrbExDataTypePnP, SrbExDataTypePnP) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_PNP_LENGTH, SRBEX_DATA_PNP_LENGTH) + ULONG Length; + UCHAR PnPSubFunction; + UCHAR Reserved[3]; + STOR_PNP_ACTION PnPAction; + ULONG SrbPnPFlags; + ULONG Reserved1; +} SRBEX_DATA_PNP, *PSRBEX_DATA_PNP; + +// Used by SRB_FUNCTION_MINIPORT_PASSTHROUGH_REQUEST +#define SRBEX_DATA_MINIPORT_PASSTHROUGH_LENGTH ((4 * sizeof(ULONG))) + +typedef struct SRB_ALIGN _SRBEX_DATA_MINIPORT_PASSTHROUGH { + _Field_range_(SrbExDataTypeMiniportPassthrough, SrbExDataTypeMiniportPassthrough) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_MINIPORT_PASSTHROUGH_LENGTH, SRBEX_DATA_MINIPORT_PASSTHROUGH_LENGTH) + ULONG Length; + ULONG InputBufferLength; + ULONG OutputBufferLength; + ULONG OutputBufferWritten; + ULONG Reserved; +} SRBEX_DATA_MINIPORT_PASSTHROUGH, *PSRBEX_DATA_MINIPORT_PASSTHROUGH; + +// Use in read/write requests to provide additional info about the IO. +#define SRBEX_DATA_IO_INFO_LENGTH ((5 * sizeof(ULONG)) + (4 * sizeof(UCHAR))) + +// Define bit flags used in Flags field +#define REQUEST_INFO_NO_CACHE_FLAG 0x00000001 +#define REQUEST_INFO_PAGING_IO_FLAG 0x00000002 +#define REQUEST_INFO_SEQUENTIAL_IO_FLAG 0x00000004 +#define REQUEST_INFO_TEMPORARY_FLAG 0x00000008 +#define REQUEST_INFO_WRITE_THROUGH_FLAG 0x00000010 +#define REQUEST_INFO_HYBRID_WRITE_THROUGH_FLAG 0x00000020 + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define REQUEST_INFO_NO_FILE_OBJECT_FLAG 0x00000040 +#define REQUEST_INFO_VOLSNAP_IO_FLAG 0x00000080 +#define REQUEST_INFO_STREAM_FLAG 0x00000100 + +#endif //(NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#define REQUEST_INFO_CRYPTO_FLAG 0x00000200 +#define REQUEST_INFO_VALID_CACHEPRIORITY_FLAG 0x80000000 + +typedef struct SRB_ALIGN _SRBEX_DATA_IO_INFO { + _Field_range_(SrbExDataTypeIoInfo, SrbExDataTypeIoInfo) + SRBEXDATATYPE Type; + _Field_range_(SRBEX_DATA_IO_INFO_LENGTH, SRBEX_DATA_IO_INFO_LENGTH) + ULONG Length; + ULONG Flags; + ULONG Key; + ULONG RWLength; + BOOLEAN IsWriteRequest; + UCHAR CachePriority; +#if (NTDDI_VERSION >= NTDDI_WIN11_GE) + UCHAR IoPriorityLevel; + UCHAR Reserved; +#else + UCHAR Reserved[2]; +#endif //(NTDDI_VERSION >= NTDDI_WIN11_GE) + ULONG Reserved1[2]; +} SRBEX_DATA_IO_INFO, *PSRBEX_DATA_IO_INFO; + +// +// Used by SRB_FUNCTION_EXECUTE_NVME +// + +#define SRBEX_DATA_NVME_COMMAND_LENGTH ((4 * sizeof(ULONGLONG)) + (14 * sizeof(ULONG)) + (5 * sizeof(USHORT)) + (2 * sizeof(UCHAR))) + +typedef enum { + SRBEX_DATA_NVME_COMMAND_TYPE_NVM = 0, + SRBEX_DATA_NVME_COMMAND_TYPE_ADMIN, + SRBEX_DATA_NVME_COMMAND_TYPE_FABRICS +} SRBEX_DATA_NVME_COMMAND_TYPE, *PSRBEX_DATA_NVME_COMMAND_TYPE; + +typedef enum { + SRBEX_DATA_NVME_COMMAND_FLAG_REQUIRE_DATA_TRANSFER_IN = 0x1, // Data is being read in from the device. + SRBEX_DATA_NVME_COMMAND_FLAG_REQUIRE_DATA_TRANSFER_OUT = 0x2, // Data is being written out to the device. + SRBEX_DATA_NVME_COMMAND_FLAG_PRP_SET_ALREADY = 0x4, + SRBEX_DATA_NVME_COMMAND_FLAG_SIGNATURE_ENABLED = 0x8, + SRBEX_DATA_NVME_COMMAND_FLAG_NO_POLLING = 0x10 // Indicate to send the command with interrupt mode. +} SRBEX_DATA_NVME_COMMAND_FLAG, *PSRBEX_DATA_NVME_COMMAND_FLAG; + +typedef enum { + SRBEX_DATA_NVME_RESPONSE_FLAG_SQHD_VALID = 0x1 +} SRBEX_DATA_NVME_RESPONSE_FLAG, *PSRBEX_DATA_NVME_RESPONSE_FLAG; + +typedef struct SRB_ALIGN _SRBEX_DATA_NVME_COMMAND { + + _Field_range_(SrbExDataTypeNvmeCommand, SrbExDataTypeNvmeCommand) + SRBEXDATATYPE Type; + + _Field_range_(SRBEX_DATA_NVME_COMMAND_LENGTH, SRBEX_DATA_NVME_COMMAND_LENGTH) + ULONG Length; + + union { + + // + // Miniport's handle for the NVMe controller + // + PVOID ControllerHandle; + ULONGLONG Reserved0; + }; + + // + // NVMe command fields (Directly maps to Common Command Format in NVMe spec) + // + union { + + struct { + + ULONG CommandDWORD0; // NVME_COMMAND_DWORD0 in nvme.h + ULONG CommandNSID; + ULONG Reserved1[2]; + + ULONGLONG CommandMPTR; + + union { + + struct { + ULONGLONG CommandPRP1; + ULONGLONG CommandPRP2; + }; + + ULONGLONG CommandSGL1[2]; + }; + + ULONG CommandCDW10; + ULONG CommandCDW11; + ULONG CommandCDW12; + ULONG CommandCDW13; + ULONG CommandCDW14; + ULONG CommandCDW15; + }; // NVME_COMMAND in nvme.h + + struct { + + UCHAR OPC; + UCHAR PSDT; + USHORT CID; + UCHAR FCTYPE; + UCHAR Reserved[35]; + UCHAR Specific[24]; + + } FabricsCommand; // NVMEOF_FABRICS_COMMAND in nvme.h + + struct { + + ULONG OPC : 8; // Opcode (OPC) + ULONG FUSE : 2; // Fused Operation (FUSE) + ULONG Reserved : 4; + ULONG PSDT : 2; // PRP or SGL for Data Transfer (PSDT) + ULONG CID : 16; // Command Identifier (CID) + UCHAR TypeSpecific[60]; + + } Command; // To reference command DW0 + + }; + + // + // Additional command and response information + // + UCHAR CommandType; // Defined in SRBEX_DATA_NVME_COMMAND_TYPE + UCHAR Reserved2; + USHORT CommandFlags; // Defined in SRBEX_DATA_NVME_COMMAND_FLAG + USHORT ResponseFlags; // Defined in SRBEX_DATA_NVME_RESPONSE_FLAG + + // + // Command status + // + union { + struct { + USHORT P : 1; // Phase Tag (P) + USHORT SC : 8; // Status Code (SC) + USHORT SCT : 3; // Status Code Type (SCT) + USHORT CRD : 2; // Command Retry Delay (CRD) + USHORT M : 1; // More (M) + USHORT DNR : 1; // Do Not Retry (DNR) + } DUMMYSTRUCTNAME; + + USHORT AsUshort; + + } CommandStatus; // NVME_COMMAND_STATUS in nvme.h + + ULONG QID; // Choice of Queue ID, if unspecified it should be 0xFFFFFFFF + ULONG CommandTag; // Unique identifier for the command + + // + // NVMe response fields + // + union { + + struct { + + ULONG CQEntryDW0; // Completion queue entry DW0 + ULONG CQEntryDW1; // Completion queue entry DW1 + }; + + UCHAR Specific[8]; // Fabrics command specific response + }; + + USHORT SQHD; // SQ Head Pointer in completion queue entry + + // + // NVMe command and response fields + // + USHORT SQID; // SQ Identifier + +} SRBEX_DATA_NVME_COMMAND, *PSRBEX_DATA_NVME_COMMAND; + + +// +// Used by SRB_FUNCTION_NVMEOF_OPERATION +// + +#define STOR_NVMEOF_OPERATION_V1 0x0001 +#define SRBEX_DATA_NVMEOF_OPERATION_LENGTH ((2 * sizeof(USHORT)) + (2 * sizeof(ULONG))) + +typedef struct SRB_ALIGN _SRBEX_DATA_NVMEOF_OPERATION { + + _Field_range_(SrbExDataTypeNvmeofOperation, SrbExDataTypeNvmeofOperation) + SRBEXDATATYPE Type; + + _Field_range_(SRBEX_DATA_NVMEOF_OPERATION_LENGTH, SRBEX_DATA_NVMEOF_OPERATION_LENGTH) + ULONG Length; + + // + // Version of this structure + // + _Field_range_(STOR_NVMEOF_OPERATION_V1, STOR_NVMEOF_OPERATION_V1) + USHORT Version; + + USHORT Reserved1; + + // + // Operation specific flags + // + ULONG Flags; + + // + // STOR_NVMEOF_FUNCTION_TYPE (defined in storport.w) + // Payload if applicable is in data buffer + // + ULONG FunctionType; + +} SRBEX_DATA_NVMEOF_OPERATION, *PSRBEX_DATA_NVMEOF_OPERATION; + + +// SRB signature - "SRBX" in ASCII +#define SRB_SIGNATURE 0x53524258 + +// STORAGE_REQUEST_BLOCK structure version. +#define STORAGE_REQUEST_BLOCK_VERSION_1 0x1 + + +typedef struct SRB_ALIGN _STORAGE_REQUEST_BLOCK_HEADER { + USHORT Length; + + _Field_range_(SRB_FUNCTION_STORAGE_REQUEST_BLOCK, SRB_FUNCTION_STORAGE_REQUEST_BLOCK) + UCHAR Function; + + UCHAR SrbStatus; +} STORAGE_REQUEST_BLOCK_HEADER, *PSTORAGE_REQUEST_BLOCK_HEADER; + + + +// STORAGE_REQUEST_BLOCK is the SRB used for SRB_FUNCTION_STORAGE_REQUEST_BLOCK +typedef _Struct_size_bytes_(SrbLength) struct SRB_ALIGN _STORAGE_REQUEST_BLOCK { + // + // First 8 bytes of this structure is commom between all SRBs and should + // have the same meaning as SCSI_REQEUST_BLOCK. To avoid compatibility + // issues, bytes 4 to 7 will not be used and should be set to 0. These + // bytes corresponds to the ScsiStatus/WMiSubFunction/SrbPowerFlags/ + // PnPSubFunction, PathId, TargetId and Lun fields in the existing SRBs + // (e.g. SCSI_REQUEST_BLOCK, SCSI_WMI_REQUEST_BLOCK, etc). + // + USHORT Length; + + _Field_range_(SRB_FUNCTION_STORAGE_REQUEST_BLOCK, SRB_FUNCTION_STORAGE_REQUEST_BLOCK) + UCHAR Function; + + UCHAR SrbStatus; + + // Reserved for internal use + ULONG ReservedUlong1; + + // + // General SRB fields. The first 6 fields should not changed between + // versions of this structure. + // + + // Signature field + _Field_range_(SRB_SIGNATURE, SRB_SIGNATURE) + ULONG Signature; + + // Version field to denote version of STORAGE_REQUEST_BLOCK structure. + _Field_range_(STORAGE_REQUEST_BLOCK_VERSION_1, STORAGE_REQUEST_BLOCK_VERSION_1) + ULONG Version; + + // Size of this structure including address and SRB extended data. + ULONG SrbLength; + + ULONG SrbFunction; + + ULONG SrbFlags; + + // Reserved for future use to expand SrbStatus to 32-bit + ULONG ReservedUlong2; + + // Equivalent to QueueTag or Task Tag in SCSI + ULONG RequestTag; + + // Equivalent to Task Priority in SCSI + USHORT RequestPriority; + + // Equivalent to QueueAction or Task Attributes in SCSI. + USHORT RequestAttribute; + + // Request timeout value + ULONG TimeOutValue; + +#if (NTDDI_VERSION >= NTDDI_WIN10_CU) + + union { + // + // Used to store system failure status information in + // SrbStatus failure conditions (e.g. SRB_STATUS_INTERNAL_ERROR). + // + ULONG SystemStatus; + + // + // Used to store high 4 bytes of unique tag if unique tag feature is enabled. + // + ULONG RequestTagHigh4Bytes; + + } DUMMYUNIONNAME; + +#else + + // + // Used to store system failure status information in + // SrbStatus failure conditions (e.g. SRB_STATUS_INTERNAL_ERROR). + // + ULONG SystemStatus; + +#endif + + // + // Guard page that should always be zero. Use to guard against misbehaving + // storage filter drivers and to have defined behavior for drivers that misinterpret + // new SRB format for old on 32-bit platforms. + // + ULONG ZeroGuard1; + + // + // Offset to address from beginning of structure. Address should follow + // immediately after STORAGE_REQUEST_BLOCK structure and be a STOR_ADDRESS + // type address. + // + _Field_range_(sizeof(STORAGE_REQUEST_BLOCK), SrbLength - sizeof(STOR_ADDRESS)) + ULONG AddressOffset; + + // Number of SRB extended data + ULONG NumSrbExData; + + // Data transfer length + ULONG DataTransferLength; + + // Data buffer + _Field_size_bytes_full_(DataTransferLength) + PVOID POINTER_ALIGN DataBuffer; + + // + // Guard page that should always be zero. Use to guard against misbehaving + // storage filter drivers and to have defined behavior for drivers that misinterpret + // new SRB format for old on 64-bit platforms. + // + PVOID POINTER_ALIGN ZeroGuard2; + + // Original IRP containing the request + PVOID POINTER_ALIGN OriginalRequest; + + // Class driver's per-request context + PVOID POINTER_ALIGN ClassContext; + + // Port driver's per-request context + PVOID POINTER_ALIGN PortContext; + + // Miniport's per-request context + PVOID POINTER_ALIGN MiniportContext; + + struct _STORAGE_REQUEST_BLOCK POINTER_ALIGN *NextSrb; + + // + // Offsets to SRB extended data from beginning of structure. + // Should follow Address field content and be a SRBEX_DATA type extension. + // + _At_buffer_(SrbExDataOffset, _Iter_, NumSrbExData, _Field_range_(0, SrbLength - sizeof(SRBEX_DATA))) + _Field_size_(NumSrbExData) + ULONG SrbExDataOffset[ANYSIZE_ARRAY]; + +} STORAGE_REQUEST_BLOCK, *PSTORAGE_REQUEST_BLOCK; + +// Define SRB types supported +#define SRB_TYPE_SCSI_REQUEST_BLOCK 0 +#define SRB_TYPE_STORAGE_REQUEST_BLOCK 1 +#define SRB_TYPE_NVME_REQUEST_BLOCK 2 + +// Define address type supported +#define STORAGE_ADDRESS_TYPE_BTL8 0 +#define STORAGE_ADDRESS_TYPE_NVME 1 + + +#endif //(NTDDI_VERSION >= NTDDI_WIN8) + +// end_ntminitape + +// end_storport end_privstorport + +// +// SCSI Adapter Dependent Routines +// + +typedef +_Must_inspect_result_ +BOOLEAN +(*PHW_INITIALIZE) ( + _In_ PVOID DeviceExtension + ); + +typedef +_Must_inspect_result_ +BOOLEAN +(*PHW_STARTIO) ( + _In_ PVOID DeviceExtension, + _In_ PSCSI_REQUEST_BLOCK Srb + ); + +typedef +_Must_inspect_result_ +BOOLEAN +(*PHW_INTERRUPT) ( + _In_ PVOID DeviceExtension + ); + +typedef +VOID +(*PHW_TIMER) ( + _In_ PVOID DeviceExtension + ); + +typedef +VOID +(*PHW_DMA_STARTED) ( + _In_ PVOID DeviceExtension + ); + +typedef +_Must_inspect_result_ +ULONG +(*PHW_FIND_ADAPTER) ( + _In_ PVOID DeviceExtension, + _In_ PVOID HwContext, + _In_ PVOID BusInformation, + _In_ PCHAR ArgumentString, + _Inout_ PPORT_CONFIGURATION_INFORMATION ConfigInfo, + _Out_ PBOOLEAN Again + ); + +typedef +_Must_inspect_result_ +BOOLEAN +(*PHW_RESET_BUS) ( + _In_ PVOID DeviceExtension, + _In_ ULONG PathId + ); + +typedef +_Must_inspect_result_ +BOOLEAN +(*PHW_ADAPTER_STATE) ( + _In_ PVOID DeviceExtension, + _In_ PVOID Context, + _In_ BOOLEAN SaveState + ); + +typedef +_Must_inspect_result_ +SCSI_ADAPTER_CONTROL_STATUS +(*PHW_ADAPTER_CONTROL) ( + _In_ PVOID DeviceExtension, + _In_ SCSI_ADAPTER_CONTROL_TYPE ControlType, + _In_ PVOID Parameters + ); + +// +// Port driver error codes +// + +#define SP_BUS_PARITY_ERROR 0x0001 +#define SP_UNEXPECTED_DISCONNECT 0x0002 +#define SP_INVALID_RESELECTION 0x0003 +#define SP_BUS_TIME_OUT 0x0004 +#define SP_PROTOCOL_ERROR 0x0005 +#define SP_INTERNAL_ADAPTER_ERROR 0x0006 +#define SP_REQUEST_TIMEOUT 0x0007 +#define SP_IRQ_NOT_RESPONDING 0x0008 +#define SP_BAD_FW_WARNING 0x0009 +#define SP_BAD_FW_ERROR 0x000a +#define SP_LOST_WMI_MINIPORT_REQUEST 0x000b + +// +// Port driver version flags +// +#define SP_VER_TRACE_SUPPORT 0x0010 + +// +// Return values for SCSI_HW_FIND_ADAPTER. +// + +#define SP_RETURN_NOT_FOUND 0 +#define SP_RETURN_FOUND 1 +#define SP_RETURN_ERROR 2 +#define SP_RETURN_BAD_CONFIG 3 + +// +// Notification Event Types +// + +typedef enum _SCSI_NOTIFICATION_TYPE { + RequestComplete, + NextRequest, + NextLuRequest, + ResetDetected, + CallDisableInterrupts, + CallEnableInterrupts, + RequestTimerCall, + BusChangeDetected, /* New */ + WMIEvent, + WMIReregister, + LinkUp, + LinkDown, + QueryTickCount, + BufferOverrunDetected, + TraceNotification /* New */ +} SCSI_NOTIFICATION_TYPE, *PSCSI_NOTIFICATION_TYPE; + +// +// Structure passed between miniport initialization +// and SCSI port initialization +// + +typedef struct _HW_INITIALIZATION_DATA { + + ULONG HwInitializationDataSize; + + // + // Adapter interface type: + // + // Internal + // Isa + // Eisa + // MicroChannel + // TurboChannel + // PCIBus + // VMEBus + // NuBus + // PCMCIABus + // CBus + // MPIBus + // MPSABus + // + + INTERFACE_TYPE AdapterInterfaceType; + + // + // Miniport driver routines + // + + PHW_INITIALIZE HwInitialize; + + PHW_STARTIO HwStartIo; + + PHW_INTERRUPT HwInterrupt; + + PHW_FIND_ADAPTER HwFindAdapter; + + PHW_RESET_BUS HwResetBus; + + PHW_DMA_STARTED HwDmaStarted; + + PHW_ADAPTER_STATE HwAdapterState; + + // + // Miniport driver resources + // + + ULONG DeviceExtensionSize; + + ULONG SpecificLuExtensionSize; + + ULONG SrbExtensionSize; + + ULONG NumberOfAccessRanges; + + PVOID Reserved; + + // + // Data buffers must be mapped into virtual address space. + // + + BOOLEAN MapBuffers; + + // + // The driver will need to tranlate virtual to physical addresses. + // + + BOOLEAN NeedPhysicalAddresses; + + // + // Supports tagged queuing + // + + BOOLEAN TaggedQueuing; + + // + // Supports auto request sense. + // + + BOOLEAN AutoRequestSense; + + // + // Supports multiple requests per logical unit. + // + + BOOLEAN MultipleRequestPerLu; + + // + // Support receive event function. + // + + BOOLEAN ReceiveEvent; + + // + // Vendor identification length + // + + USHORT VendorIdLength; + + // + // Vendor identification + // + + PVOID VendorId; + + // + // Pad for alignment and future use. + // + + union { + + USHORT ReservedUshort; + + // + // Flags to indicate supported features + // + USHORT PortVersionFlags; + }; + + // + // Device identification length + // + + USHORT DeviceIdLength; + + // + // Device identification + // + + PVOID DeviceId; + + // + // Stop adapter routine. + // + + PHW_ADAPTER_CONTROL HwAdapterControl; + +} HW_INITIALIZATION_DATA, *PHW_INITIALIZATION_DATA; + +// begin_ntminitape + +#ifndef _NTDDK_ +#define SCSIPORT_API DECLSPEC_IMPORT +#else +#define SCSIPORT_API +#endif + +// end_ntminitape + +// +// Port driver routines called by miniport driver +// +//@[comment("MVI_tracked")] +_Must_inspect_result_ +_IRQL_requires_max_(PASSIVE_LEVEL) +SCSIPORT_API +ULONG +ScsiPortInitialize( + _In_ PVOID Argument1, + _In_ PVOID Argument2, + _In_ struct _HW_INITIALIZATION_DATA *HwInitializationData, + _In_ PVOID HwContext + ); + +SCSIPORT_API +VOID +ScsiPortFreeDeviceBase( + _In_ PVOID HwDeviceExtension, + _In_ PVOID MappedAddress + ); + +_Must_inspect_result_ +SCSIPORT_API +ULONG +ScsiPortGetBusData( + _In_ PVOID DeviceExtension, + _In_ ULONG BusDataType, + _In_ ULONG SystemIoBusNumber, + _In_ ULONG SlotNumber, + _In_reads_bytes_(Length) PVOID Buffer, + _In_ ULONG Length + ); + +_Must_inspect_result_ +SCSIPORT_API +ULONG +ScsiPortSetBusDataByOffset( + _In_ PVOID DeviceExtension, + _In_ ULONG BusDataType, + _In_ ULONG SystemIoBusNumber, + _In_ ULONG SlotNumber, + _In_reads_bytes_(Length) PVOID Buffer, + _In_ ULONG Offset, + _In_ ULONG Length + ); + +_Must_inspect_result_ +SCSIPORT_API +PVOID +ScsiPortGetDeviceBase( + _In_ PVOID HwDeviceExtension, + _In_ INTERFACE_TYPE BusType, + _In_ ULONG SystemIoBusNumber, + _In_ SCSI_PHYSICAL_ADDRESS IoAddress, + _In_ ULONG NumberOfBytes, + _In_ BOOLEAN InIoSpace + ); + +_Must_inspect_result_ +SCSIPORT_API +PVOID +ScsiPortGetLogicalUnit( + _In_ PVOID HwDeviceExtension, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun + ); + +_Must_inspect_result_ +SCSIPORT_API +PSCSI_REQUEST_BLOCK +ScsiPortGetSrb( + _In_ PVOID DeviceExtension, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun, + _In_ LONG QueueTag + ); + +_Must_inspect_result_ +SCSIPORT_API +SCSI_PHYSICAL_ADDRESS +ScsiPortGetPhysicalAddress( + _In_ PVOID HwDeviceExtension, + _In_ PSCSI_REQUEST_BLOCK Srb, + _In_ PVOID VirtualAddress, + _Out_ ULONG *Length + ); + +_Must_inspect_result_ +SCSIPORT_API +PVOID +ScsiPortGetVirtualAddress( + _In_ PVOID HwDeviceExtension, + _In_ SCSI_PHYSICAL_ADDRESS PhysicalAddress + ); + +_Must_inspect_result_ +SCSIPORT_API +PVOID +ScsiPortGetUncachedExtension( + _In_ PVOID HwDeviceExtension, + _In_ PPORT_CONFIGURATION_INFORMATION ConfigInfo, + _In_ ULONG NumberOfBytes + ); + +SCSIPORT_API +VOID +ScsiPortFlushDma( + _In_ PVOID DeviceExtension + ); + +SCSIPORT_API +VOID +ScsiPortIoMapTransfer( + _In_ PVOID HwDeviceExtension, + _In_ PSCSI_REQUEST_BLOCK Srb, + _In_ PVOID LogicalAddress, + _In_ ULONG Length + ); + +SCSIPORT_API +VOID +ScsiPortNotification( + _In_ SCSI_NOTIFICATION_TYPE NotificationType, + _In_ PVOID HwDeviceExtension, + ... + ); + +SCSIPORT_API +VOID +ScsiPortLogError( + _In_ PVOID HwDeviceExtension, + _In_ PSCSI_REQUEST_BLOCK Srb OPTIONAL, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun, + _In_ ULONG ErrorCode, + _In_ ULONG UniqueId + ); + +SCSIPORT_API +VOID +ScsiPortCompleteRequest( + _In_ PVOID HwDeviceExtension, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun, + _In_ UCHAR SrbStatus + ); + +SCSIPORT_API +VOID +ScsiPortStallExecution( + _In_ ULONG Delay + ); + +#if defined(_M_AMD64) + +#define ScsiPortReadPortUchar READ_PORT_UCHAR +#define ScsiPortReadPortUshort READ_PORT_USHORT +#define ScsiPortReadPortUlong READ_PORT_ULONG + +#define ScsiPortReadPortBufferUchar READ_PORT_BUFFER_UCHAR +#define ScsiPortReadPortBufferUshort READ_PORT_BUFFER_USHORT +#define ScsiPortReadPortBufferUlong READ_PORT_BUFFER_ULONG + +#define ScsiPortReadRegisterUchar READ_REGISTER_UCHAR +#define ScsiPortReadRegisterUshort READ_REGISTER_USHORT +#define ScsiPortReadRegisterUlong READ_REGISTER_ULONG + +#define ScsiPortReadRegisterBufferUchar READ_REGISTER_BUFFER_UCHAR +#define ScsiPortReadRegisterBufferUshort READ_REGISTER_BUFFER_USHORT +#define ScsiPortReadRegisterBufferUlong READ_REGISTER_BUFFER_ULONG + +#define ScsiPortWritePortUchar WRITE_PORT_UCHAR +#define ScsiPortWritePortUshort WRITE_PORT_USHORT +#define ScsiPortWritePortUlong WRITE_PORT_ULONG + +#define ScsiPortWritePortBufferUchar WRITE_PORT_BUFFER_UCHAR +#define ScsiPortWritePortBufferUshort WRITE_PORT_BUFFER_USHORT +#define ScsiPortWritePortBufferUlong WRITE_PORT_BUFFER_ULONG + +#define ScsiPortWriteRegisterUchar WRITE_REGISTER_UCHAR +#define ScsiPortWriteRegisterUshort WRITE_REGISTER_USHORT +#define ScsiPortWriteRegisterUlong WRITE_REGISTER_ULONG + +#define ScsiPortWriteRegisterBufferUchar WRITE_REGISTER_BUFFER_UCHAR +#define ScsiPortWriteRegisterBufferUshort WRITE_REGISTER_BUFFER_USHORT +#define ScsiPortWriteRegisterBufferUlong WRITE_REGISTER_BUFFER_ULONG + +#define ScsiPortMoveMemory memmove + +#else + +_Must_inspect_result_ +SCSIPORT_API +UCHAR +ScsiPortReadPortUchar( + _In_ PUCHAR Port + ); + +_Must_inspect_result_ +SCSIPORT_API +USHORT +ScsiPortReadPortUshort( + _In_ PUSHORT Port + ); + +_Must_inspect_result_ +SCSIPORT_API +ULONG +ScsiPortReadPortUlong( + _In_ PULONG Port + ); + +SCSIPORT_API +VOID +ScsiPortReadPortBufferUchar( + _In_ PUCHAR Port, + _In_ PUCHAR Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortReadPortBufferUshort( + _In_ PUSHORT Port, + _In_ PUSHORT Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortReadPortBufferUlong( + _In_ PULONG Port, + _In_ PULONG Buffer, + _In_ ULONG Count + ); + +_Must_inspect_result_ +SCSIPORT_API +UCHAR +ScsiPortReadRegisterUchar( + _In_ PUCHAR Register + ); + +_Must_inspect_result_ +SCSIPORT_API +USHORT +ScsiPortReadRegisterUshort( + _In_ PUSHORT Register + ); + +_Must_inspect_result_ +SCSIPORT_API +ULONG +ScsiPortReadRegisterUlong( + _In_ PULONG Register + ); + +SCSIPORT_API +VOID +ScsiPortReadRegisterBufferUchar( + _In_ PUCHAR Register, + _In_ PUCHAR Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortReadRegisterBufferUshort( + _In_ PUSHORT Register, + _In_ PUSHORT Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortReadRegisterBufferUlong( + _In_ PULONG Register, + _In_ PULONG Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWritePortUchar( + _In_ PUCHAR Port, + _In_ UCHAR Value + ); + +SCSIPORT_API +VOID +ScsiPortWritePortUshort( + _In_ PUSHORT Port, + _In_ USHORT Value + ); + +SCSIPORT_API +VOID +ScsiPortWritePortUlong( + _In_ PULONG Port, + _In_ ULONG Value + ); + +SCSIPORT_API +VOID +ScsiPortWritePortBufferUchar( + _In_ PUCHAR Port, + _In_ PUCHAR Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWritePortBufferUshort( + _In_ PUSHORT Port, + _In_ PUSHORT Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWritePortBufferUlong( + _In_ PULONG Port, + _In_ PULONG Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterUchar( + _In_ PUCHAR Register, + _In_ UCHAR Value + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterUshort( + _In_ PUSHORT Register, + _In_ USHORT Value + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterUlong( + _In_ PULONG Register, + _In_ ULONG Value + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterBufferUchar( + _In_ PUCHAR Register, + _In_ PUCHAR Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterBufferUshort( + _In_ PUSHORT Register, + _In_ PUSHORT Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortWriteRegisterBufferUlong( + _In_ PULONG Register, + _In_ PULONG Buffer, + _In_ ULONG Count + ); + +SCSIPORT_API +VOID +ScsiPortMoveMemory( + _In_ PVOID WriteBuffer, + _In_ PVOID ReadBuffer, + _In_ ULONG Length + ); + +#endif + +_Must_inspect_result_ +SCSIPORT_API +SCSI_PHYSICAL_ADDRESS +ScsiPortConvertUlongToPhysicalAddress( + _In_ ULONG_PTR UlongAddress + ); + +_Must_inspect_result_ +SCSIPORT_API +ULONG +ScsiPortConvertPhysicalAddressToUlong( + _In_ SCSI_PHYSICAL_ADDRESS Address + ); + +SCSIPORT_API +VOID +ScsiPortQuerySystemTime( + _Out_ PLARGE_INTEGER CurrentTime + ); + +#define ScsiPortConvertPhysicalAddressToUlong(Address) ((Address).LowPart) + +// +// Sundown Note: +// For now, ScsiPortConvertPhysicalAddressToULongPtr() exists only as a macro. +// + +#define ScsiPortConvertPhysicalAddressToULongPtr(Address) ((ULONG_PTR)((Address).QuadPart)) + +_Must_inspect_result_ +SCSIPORT_API +BOOLEAN +ScsiPortValidateRange( + _In_ PVOID HwDeviceExtension, + _In_ INTERFACE_TYPE BusType, + _In_ ULONG SystemIoBusNumber, + _In_ SCSI_PHYSICAL_ADDRESS IoAddress, + _In_ ULONG NumberOfBytes, + _In_ BOOLEAN InIoSpace + ); + +// begin_ntminitape + +SCSIPORT_API +VOID +ScsiDebugPrint( + ULONG DebugPrintLevel, + PCCHAR DebugMessage, + ... + ); + +// end_ntminitape + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + + +#pragma warning(pop) // un-sets any local warning changes + +#endif // + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sspi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sspi.h new file mode 100644 index 0000000000000000000000000000000000000000..06f5ed27e9a6563ffbfcd8c6c1782ad95a0164c9 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/sspi.h @@ -0,0 +1,3747 @@ +//+--------------------------------------------------------------------------- +// +// Microsoft Windows +// Copyright (C) Microsoft Corporation, 1992-1999. +// +// File: sspi.h +// +// Contents: Security Support Provider Interface +// Prototypes and structure definitions +// +// Functions: Security Support Provider API +// +// +//---------------------------------------------------------------------------- + +#include +#include + +// begin_ntifs +#ifndef __SSPI_H__ +#define __SSPI_H__ +// end_ntifs + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +// +// Determine environment: +// + +#ifdef SECURITY_WIN32 +#define ISSP_LEVEL 32 +#define ISSP_MODE 1 +#endif // SECURITY_WIN32 + +#ifdef SECURITY_KERNEL +#define ISSP_LEVEL 32 // ntifs + +// +// SECURITY_KERNEL trumps SECURITY_WIN32. Undefine ISSP_MODE so that +// we don't get redefine errors. +// +#ifdef ISSP_MODE +#undef ISSP_MODE +#endif +#define ISSP_MODE 0 // ntifs +#endif // SECURITY_KERNEL + +#ifdef SECURITY_MAC +#define ISSP_LEVEL 32 +#define ISSP_MODE 1 +#endif // SECURITY_MAC + + +#ifndef ISSP_LEVEL +#error You must define one of SECURITY_WIN32, SECURITY_KERNEL, or +#error SECURITY_MAC +#endif // !ISSP_LEVEL + + +// +// Now, define platform specific mappings: +// + + +// begin_ntifs + +#if defined(_NO_KSECDD_IMPORT_) + +#define KSECDDDECLSPEC + +#else + +#define KSECDDDECLSPEC __declspec(dllimport) + +#endif + +typedef WCHAR SEC_WCHAR; +typedef CHAR SEC_CHAR; + +#ifndef __SECSTATUS_DEFINED__ +typedef LONG SECURITY_STATUS; +#define __SECSTATUS_DEFINED__ +#endif + +#define SEC_TEXT TEXT +#define SEC_FAR +#define SEC_ENTRY __stdcall + +// end_ntifs + +// +// Decide what a string - 32 bits only since for 16 bits it is clear. +// + + +#ifdef UNICODE +typedef SEC_WCHAR * SECURITY_PSTR; +typedef CONST SEC_WCHAR * SECURITY_PCSTR; +#else // UNICODE +typedef SEC_CHAR * SECURITY_PSTR; +typedef CONST SEC_CHAR * SECURITY_PCSTR; +#endif // UNICODE + + + +// +// Equivalent string for rpcrt: +// + +#define __SEC_FAR SEC_FAR + + +// +// Okay, security specific types: +// + + +// begin_ntifs + +#ifndef __SECHANDLE_DEFINED__ +typedef struct _SecHandle +{ + ULONG_PTR dwLower ; + ULONG_PTR dwUpper ; +} SecHandle, * PSecHandle ; + +#define __SECHANDLE_DEFINED__ +#endif // __SECHANDLE_DEFINED__ + +#define SecInvalidateHandle( x ) \ + ((PSecHandle) (x))->dwLower = ((PSecHandle) (x))->dwUpper = ((ULONG_PTR) ((INT_PTR)-1)) ; + +#define SecIsValidHandle( x ) \ + ( ( ((PSecHandle) (x))->dwLower != ((ULONG_PTR) ((INT_PTR) -1 ))) && \ + ( ((PSecHandle) (x))->dwUpper != ((ULONG_PTR) ((INT_PTR) -1 ))) ) + +// +// pseudo handle value: the handle has already been deleted +// + +#define SEC_DELETED_HANDLE ((ULONG_PTR) (-2)) + +typedef SecHandle CredHandle; +typedef PSecHandle PCredHandle; + +typedef SecHandle CtxtHandle; +typedef PSecHandle PCtxtHandle; + +// end_ntifs + + +# ifdef WIN32_CHICAGO + +typedef unsigned __int64 QWORD; +typedef QWORD SECURITY_INTEGER, *PSECURITY_INTEGER; +#define SEC_SUCCESS(Status) ((Status) >= 0) + +# elif defined(_NTDEF_) || defined(_WINNT_) + +typedef LARGE_INTEGER _SECURITY_INTEGER, SECURITY_INTEGER, *PSECURITY_INTEGER; // ntifs + +# else // _NTDEF_ || _WINNT_ + +typedef struct _SECURITY_INTEGER +{ + unsigned long LowPart; + long HighPart; +} SECURITY_INTEGER, *PSECURITY_INTEGER; + +# endif // _NTDEF_ || _WINNT_ + +# ifndef SECURITY_MAC + +typedef SECURITY_INTEGER TimeStamp; // ntifs +typedef SECURITY_INTEGER * PTimeStamp; // ntifs + +# else // SECURITY_MAC +typedef unsigned long TimeStamp; +typedef unsigned long * PTimeStamp; +# endif // SECUIRT_MAC + + + +// +// If we are in 32 bit mode, define the SECURITY_STRING structure, +// as a clone of the base UNICODE_STRING structure. This is used +// internally in security components, an as the string interface +// for kernel components (e.g. FSPs) +// + +# ifndef _NTDEF_ +typedef struct _SECURITY_STRING { + unsigned short Length; + unsigned short MaximumLength; +# ifdef MIDL_PASS + [size_is(MaximumLength / 2), length_is(Length / 2)] +# endif // MIDL_PASS + unsigned short * Buffer; +} SECURITY_STRING, * PSECURITY_STRING; +# else // _NTDEF_ +typedef UNICODE_STRING SECURITY_STRING, *PSECURITY_STRING; // ntifs +# endif // _NTDEF_ + + +// begin_ntifs + +// +// SecPkgInfo structure +// +// Provides general information about a security provider +// + +typedef struct _SecPkgInfoW +{ + unsigned long fCapabilities; // Capability bitmask + unsigned short wVersion; // Version of driver + unsigned short wRPCID; // ID for RPC Runtime + unsigned long cbMaxToken; // Size of authentication token (max) +#ifdef MIDL_PASS + [string] +#endif + SEC_WCHAR * Name; // Text name + +#ifdef MIDL_PASS + [string] +#endif + SEC_WCHAR * Comment; // Comment +} SecPkgInfoW, * PSecPkgInfoW; + +// end_ntifs + +typedef struct _SecPkgInfoA +{ + unsigned long fCapabilities; // Capability bitmask + unsigned short wVersion; // Version of driver + unsigned short wRPCID; // ID for RPC Runtime + unsigned long cbMaxToken; // Size of authentication token (max) +#ifdef MIDL_PASS + [string] +#endif + SEC_CHAR * Name; // Text name + +#ifdef MIDL_PASS + [string] +#endif + SEC_CHAR * Comment; // Comment +} SecPkgInfoA, * PSecPkgInfoA; + +#ifdef UNICODE +# define SecPkgInfo SecPkgInfoW // ntifs +# define PSecPkgInfo PSecPkgInfoW // ntifs +#else +# define SecPkgInfo SecPkgInfoA +# define PSecPkgInfo PSecPkgInfoA +#endif // !UNICODE + +// begin_ntifs + +// +// Security Package Capabilities +// +#define SECPKG_FLAG_INTEGRITY 0x00000001 // Supports integrity on messages +#define SECPKG_FLAG_PRIVACY 0x00000002 // Supports privacy (confidentiality) +#define SECPKG_FLAG_TOKEN_ONLY 0x00000004 // Only security token needed +#define SECPKG_FLAG_DATAGRAM 0x00000008 // Datagram RPC support +#define SECPKG_FLAG_CONNECTION 0x00000010 // Connection oriented RPC support +#define SECPKG_FLAG_MULTI_REQUIRED 0x00000020 // Full 3-leg required for re-auth. +#define SECPKG_FLAG_CLIENT_ONLY 0x00000040 // Server side functionality not available +#define SECPKG_FLAG_EXTENDED_ERROR 0x00000080 // Supports extended error msgs +#define SECPKG_FLAG_IMPERSONATION 0x00000100 // Supports impersonation +#define SECPKG_FLAG_ACCEPT_WIN32_NAME 0x00000200 // Accepts Win32 names +#define SECPKG_FLAG_STREAM 0x00000400 // Supports stream semantics +#define SECPKG_FLAG_NEGOTIABLE 0x00000800 // Can be used by the negotiate package +#define SECPKG_FLAG_GSS_COMPATIBLE 0x00001000 // GSS Compatibility Available +#define SECPKG_FLAG_LOGON 0x00002000 // Supports common LsaLogonUser +#define SECPKG_FLAG_ASCII_BUFFERS 0x00004000 // Token Buffers are in ASCII +#define SECPKG_FLAG_FRAGMENT 0x00008000 // Package can fragment to fit +#define SECPKG_FLAG_MUTUAL_AUTH 0x00010000 // Package can perform mutual authentication +#define SECPKG_FLAG_DELEGATION 0x00020000 // Package can delegate +#define SECPKG_FLAG_READONLY_WITH_CHECKSUM 0x00040000 // Package can delegate +#define SECPKG_FLAG_RESTRICTED_TOKENS 0x00080000 // Package supports restricted callers +#define SECPKG_FLAG_NEGO_EXTENDER 0x00100000 // this package extends SPNEGO, there is at most one +#define SECPKG_FLAG_NEGOTIABLE2 0x00200000 // this package is negotiated under the NegoExtender +#define SECPKG_FLAG_APPCONTAINER_PASSTHROUGH 0x00400000 // this package receives all calls from appcontainer apps +#define SECPKG_FLAG_APPCONTAINER_CHECKS 0x00800000 // this package receives calls from appcontainer apps + // if the following checks succeed + // 1. Caller has domain auth capability or + // 2. Target is a proxy server or + // 3. The caller has supplied creds +#define SECPKG_FLAG_CREDENTIAL_ISOLATION_ENABLED 0x01000000 // this package is running with Credential Guard enabled +#define SECPKG_FLAG_APPLY_LOOPBACK 0x02000000 // this package supports reliable detection of loopback + // 1.) The client and server see the same sequence of tokens + // 2.) The server enforces a unique exchange for each + // non-anonymous authentication. (Replay detection) + +#define SECPKG_ID_NONE 0xFFFF + +// +// Extended Call Flags that currently contains +// Appcontainer related information about the caller. +// Packages can query for these +// via an LsaFunction GetExtendedCallFlags +// + +#define SECPKG_CALLFLAGS_APPCONTAINER 0x00000001 +#define SECPKG_CALLFLAGS_APPCONTAINER_AUTHCAPABLE 0x00000002 +#define SECPKG_CALLFLAGS_FORCE_SUPPLIED 0x00000004 +#define SECPKG_CALLFLAGS_APPCONTAINER_UPNCAPABLE 0x00000008 + +// +// SecBuffer +// +// Generic memory descriptors for buffers passed in to the security +// API +// + +typedef struct _SecBuffer { + unsigned long cbBuffer; // Size of the buffer, in bytes + unsigned long BufferType; // Type of the buffer (below) +#ifdef MIDL_PASS + [size_is(cbBuffer)] char * pvBuffer; // Pointer to the buffer +#else + _Field_size_bytes_(cbBuffer) void SEC_FAR * pvBuffer; // Pointer to the buffer +#endif +} SecBuffer, * PSecBuffer; + +typedef struct _SecBufferDesc { + unsigned long ulVersion; // Version number + unsigned long cBuffers; // Number of buffers +#ifdef MIDL_PASS + [size_is(cBuffers)] +#endif + _Field_size_(cBuffers) PSecBuffer pBuffers; // Pointer to array of buffers +} SecBufferDesc, SEC_FAR * PSecBufferDesc; + +#define SECBUFFER_VERSION 0 + +#define SECBUFFER_EMPTY 0 // Undefined, replaced by provider +#define SECBUFFER_DATA 1 // Packet data +#define SECBUFFER_TOKEN 2 // Security token +#define SECBUFFER_PKG_PARAMS 3 // Package specific parameters +#define SECBUFFER_MISSING 4 // Missing Data indicator +#define SECBUFFER_EXTRA 5 // Extra data +#define SECBUFFER_STREAM_TRAILER 6 // Security Trailer +#define SECBUFFER_STREAM_HEADER 7 // Security Header +#define SECBUFFER_NEGOTIATION_INFO 8 // Hints from the negotiation pkg +#define SECBUFFER_PADDING 9 // non-data padding +#define SECBUFFER_STREAM 10 // whole encrypted message +#define SECBUFFER_MECHLIST 11 +#define SECBUFFER_MECHLIST_SIGNATURE 12 +#define SECBUFFER_TARGET 13 // obsolete +#define SECBUFFER_CHANNEL_BINDINGS 14 +#define SECBUFFER_CHANGE_PASS_RESPONSE 15 +#define SECBUFFER_TARGET_HOST 16 +#define SECBUFFER_ALERT 17 +#define SECBUFFER_APPLICATION_PROTOCOLS 18 // Lists of application protocol IDs, one per negotiation extension +#define SECBUFFER_SRTP_PROTECTION_PROFILES 19 // List of SRTP protection profiles, in descending order of preference +#define SECBUFFER_SRTP_MASTER_KEY_IDENTIFIER 20 // SRTP master key identifier +#define SECBUFFER_TOKEN_BINDING 21 // Supported Token Binding protocol version and key parameters +#define SECBUFFER_PRESHARED_KEY 22 // Preshared key +#define SECBUFFER_PRESHARED_KEY_IDENTITY 23 // Preshared key identity +#define SECBUFFER_DTLS_MTU 24 // DTLS path MTU setting +#define SECBUFFER_SEND_GENERIC_TLS_EXTENSION 25 // Buffer for sending generic TLS extensions. +#define SECBUFFER_SUBSCRIBE_GENERIC_TLS_EXTENSION 26 // Buffer for subscribing to generic TLS extensions. +#define SECBUFFER_FLAGS 27 // ISC/ASC REQ Flags +#define SECBUFFER_TRAFFIC_SECRETS 28 // Message sequence lengths and corresponding traffic secrets. +#define SECBUFFER_CERTIFICATE_REQUEST_CONTEXT 29 // TLS 1.3 certificate request context. +#define SECBUFFER_CHANNEL_BINDINGS_RESULT 30 // Output buffer for Channel Bindings Audit +#define SECBUFFER_APP_SESSION_STATE 31 // Application state associated with the TLS 1.3+ session ticket. Server only. +#define SECBUFFER_SESSION_TICKET 32 // TLS 1.3+ session ticket. Client only. + +#define SECBUFFER_ATTRMASK 0xF0000000 +#define SECBUFFER_READONLY 0x80000000 // Buffer is read-only, no checksum +#define SECBUFFER_READONLY_WITH_CHECKSUM 0x10000000 // Buffer is read-only, and checksummed +#define SECBUFFER_RESERVED 0x60000000 // Flags reserved to security system + + +typedef struct _SEC_NEGOTIATION_INFO { + unsigned long Size; // Size of this structure + unsigned long NameLength; // Length of name hint + SEC_WCHAR * Name; // Name hint + void * Reserved; // Reserved +} SEC_NEGOTIATION_INFO, * PSEC_NEGOTIATION_INFO ; + +typedef struct _SEC_CHANNEL_BINDINGS { + unsigned long dwInitiatorAddrType; + unsigned long cbInitiatorLength; + unsigned long dwInitiatorOffset; + unsigned long dwAcceptorAddrType; + unsigned long cbAcceptorLength; + unsigned long dwAcceptorOffset; + unsigned long cbApplicationDataLength; + unsigned long dwApplicationDataOffset; +} SEC_CHANNEL_BINDINGS, * PSEC_CHANNEL_BINDINGS ; + +#define SEC_CHANNEL_BINDINGS_EX_MAGIC 'XEBC' + +typedef struct _SEC_CHANNEL_BINDINGS_EX { + unsigned long magicNumber; // contains SEC_CHANNEL_BINDINGS_VERSION_2. distinguish ex buffer from normal channel bindings buffer. Shouldn't collide with any of assigned dwInitiatorAddrType values + unsigned long flags; // audit flag is set to indicate if audit is needed + unsigned long cbHeaderLength; + unsigned long cbStructureLength; + unsigned long dwInitiatorAddrType; + unsigned long cbInitiatorLength; + unsigned long dwInitiatorOffset; + unsigned long dwAcceptorAddrType; + unsigned long cbAcceptorLength; + unsigned long dwAcceptorOffset; + unsigned long cbApplicationDataLength; + unsigned long dwApplicationDataOffset; +} SEC_CHANNEL_BINDINGS_EX, * PSEC_CHANNEL_BINDINGS_EX ; + +#define SEC_CHANNEL_BINDINGS_AUDIT_BINDINGS 0x1 + +#define SEC_CHANNEL_BINDINGS_VALID_FLAGS SEC_CHANNEL_BINDINGS_AUDIT_BINDINGS + +typedef struct _SEC_CHANNEL_BINDINGS_RESULT { + unsigned long flags; +}SEC_CHANNEL_BINDINGS_RESULT, *PSEC_CHANNEL_BINDINGS_RESULT; + +#define SEC_CHANNEL_BINDINGS_RESULT_CLIENT_SUPPORT 0x1 // Auth package indicates client versions should support bindings +#define SEC_CHANNEL_BINDINGS_RESULT_ABSENT 0x2 // The bindings are omitted or all zeroes +#define SEC_CHANNEL_BINDINGS_RESULT_NOTVALID_MISMATCH 0x4 // The channel binding hash was incorrect +#define SEC_CHANNEL_BINDINGS_RESULT_NOTVALID_MISSING 0x8 // Missing channel bindings are not allowed for this client +#define SEC_CHANNEL_BINDINGS_RESULT_VALID_MATCHED 0x10 // The client and server bindings match +#define SEC_CHANNEL_BINDINGS_RESULT_VALID_PROXY 0x20 // ASC_REQ_PROXY_BINDINGS required the client to provide a binding +#define SEC_CHANNEL_BINDINGS_RESULT_VALID_MISSING 0x40 // Client permitted by ASC_REQ_ALLOW_MISSING_BINDINGS + +#define SEC_CHANNEL_BINDINGS_RESULT_VALID (SEC_CHANNEL_BINDINGS_RESULT_VALID_MATCHED | SEC_CHANNEL_BINDINGS_RESULT_VALID_PROXY | \ + SEC_CHANNEL_BINDINGS_RESULT_VALID_MISSING) + +#define SEC_CHANNEL_BINDINGS_RESULT_NOTVALID (SEC_CHANNEL_BINDINGS_RESULT_NOTVALID_MISMATCH | SEC_CHANNEL_BINDINGS_RESULT_NOTVALID_MISSING) + +typedef enum _SEC_APPLICATION_PROTOCOL_NEGOTIATION_EXT +{ + SecApplicationProtocolNegotiationExt_None, + SecApplicationProtocolNegotiationExt_NPN, + SecApplicationProtocolNegotiationExt_ALPN +} SEC_APPLICATION_PROTOCOL_NEGOTIATION_EXT, *PSEC_APPLICATION_PROTOCOL_NEGOTIATION_EXT; + +typedef struct _SEC_APPLICATION_PROTOCOL_LIST { + SEC_APPLICATION_PROTOCOL_NEGOTIATION_EXT ProtoNegoExt; // Protocol negotiation extension type to use with this list of protocols + unsigned short ProtocolListSize; // Size in bytes of the protocol ID list + unsigned char ProtocolList[ANYSIZE_ARRAY]; // 8-bit length-prefixed application protocol IDs, most preferred first +} SEC_APPLICATION_PROTOCOL_LIST, *PSEC_APPLICATION_PROTOCOL_LIST; + +typedef struct _SEC_APPLICATION_PROTOCOLS { + unsigned long ProtocolListsSize; // Size in bytes of the protocol ID lists array + SEC_APPLICATION_PROTOCOL_LIST ProtocolLists[ANYSIZE_ARRAY]; // Array of protocol ID lists +} SEC_APPLICATION_PROTOCOLS, *PSEC_APPLICATION_PROTOCOLS; + + +typedef struct _SEC_SRTP_PROTECTION_PROFILES { + unsigned short ProfilesSize; // Size in bytes of the SRTP protection profiles array + unsigned short ProfilesList[ANYSIZE_ARRAY]; // Array of SRTP protection profiles +} SEC_SRTP_PROTECTION_PROFILES, *PSEC_SRTP_PROTECTION_PROFILES; + +typedef struct _SEC_SRTP_MASTER_KEY_IDENTIFIER { + unsigned char MasterKeyIdentifierSize; // Size in bytes of the SRTP master key identifier + unsigned char MasterKeyIdentifier[ANYSIZE_ARRAY]; // SRTP master key identifier +} SEC_SRTP_MASTER_KEY_IDENTIFIER, *PSEC_SRTP_MASTER_KEY_IDENTIFIER; + + +typedef struct _SEC_TOKEN_BINDING { + unsigned char MajorVersion; // Supported major version of the Token Binding protocol + unsigned char MinorVersion; // Supported minor version of the Token Binding protocol + unsigned short KeyParametersSize; // Size in bytes of the Token Binding key parameter IDs array + unsigned char KeyParameters[ANYSIZE_ARRAY]; // Token Binding key parameter IDs, most preferred first +} SEC_TOKEN_BINDING, *PSEC_TOKEN_BINDING; + +typedef struct _SEC_PRESHAREDKEY { + unsigned short KeySize; // Size in bytes of the PSK + unsigned char Key[ANYSIZE_ARRAY]; // PSK +} SEC_PRESHAREDKEY, *PSEC_PRESHAREDKEY; + +typedef struct _SEC_PRESHAREDKEY_IDENTITY { + unsigned short KeyIdentitySize; // Size in bytes of the PSK Identity + unsigned char KeyIdentity[ANYSIZE_ARRAY]; // PSK Identity +} SEC_PRESHAREDKEY_IDENTITY, *PSEC_PRESHAREDKEY_IDENTITY; + +typedef struct _SEC_DTLS_MTU { + unsigned short PathMTU; // Path MTU for the connection +} SEC_DTLS_MTU, *PSEC_DTLS_MTU; + +typedef struct _SEC_FLAGS { + unsigned long long Flags; // The caller sets ISC/ASC REQ flags; the lower 32 bits are reserved, must be set to 0. +} SEC_FLAGS, *PSEC_FLAGS; + +typedef struct _SEC_CERTIFICATE_REQUEST_CONTEXT { + unsigned char cbCertificateRequestContext; // Size in bytes of the rgCertificateRequestContext array. + unsigned char rgCertificateRequestContext[ANYSIZE_ARRAY]; // The TLS 1.3 certificate request context. +} SEC_CERTIFICATE_REQUEST_CONTEXT, *PSEC_CERTIFICATE_REQUEST_CONTEXT; + +typedef struct _SEC_APP_SESSION_STATE { + unsigned short AppSessionStateSize; // Size in bytes of the application state, up to 2048 bytes. + unsigned char AppSessionState[ANYSIZE_ARRAY]; // Application state to be associated with the session ticket. +} SEC_APP_SESSION_STATE, *PSEC_APP_SESSION_STATE; + +typedef struct _SEC_SESSION_TICKET { + unsigned short SessionTicketSize; // Size in bytes of the session ticket. + unsigned char SessionTicket[ANYSIZE_ARRAY]; // TLS 1.3+ session ticket. +} SEC_SESSION_TICKET, *PSEC_SESSION_TICKET; + + +// +// Traffic secret types: +// +typedef enum _SEC_TRAFFIC_SECRET_TYPE +{ + SecTrafficSecret_None, + SecTrafficSecret_Client, + SecTrafficSecret_Server +} SEC_TRAFFIC_SECRET_TYPE, *PSEC_TRAFFIC_SECRET_TYPE; + +#define SZ_ALG_MAX_SIZE 64 + +typedef struct _SEC_TRAFFIC_SECRETS { + wchar_t SymmetricAlgId[SZ_ALG_MAX_SIZE]; // Negotiated symmetric key algorithm. e.g. BCRYPT_AES_ALGORITHM. + wchar_t ChainingMode[SZ_ALG_MAX_SIZE]; // Negotiated symmetric key algorithm chaining mode. e.g. BCRYPT_CHAIN_MODE_GCM or BCRYPT_CHAIN_MODE_CCM. + wchar_t HashAlgId[SZ_ALG_MAX_SIZE]; // Negotiated hash algorithm. e.g. BCRYPT_SHA256_ALGORITHM or BCRYPT_SHA384_ALGORITHM. + unsigned short KeySize; // Size in bytes of the symmetric key to derive from this traffic secret. + unsigned short IvSize; // Size in bytes of the IV to derive from this traffic secret. + unsigned short MsgSequenceStart; // Offset of the first byte of the TLS message sequence to be protected with a key derived from TrafficSecret. Zero to indicate the first byte of the buffer. + unsigned short MsgSequenceEnd; // Offset of the last byte of the TLS message sequence to be protected with a key derived from TrafficSecret. Zero if the secret is for the encryption of application data or decryption of incoming records. + SEC_TRAFFIC_SECRET_TYPE TrafficSecretType; // Type of traffic secret from the TRAFFIC_SECRET_TYPE enumeration. + unsigned short TrafficSecretSize; // Size in bytes of the traffic secret. + unsigned char TrafficSecret[ANYSIZE_ARRAY]; // Traffic secret of type TrafficSecretType, TrafficSecretSize bytes long, used to derive write key and IV for message protection. +} SEC_TRAFFIC_SECRETS, *PSEC_TRAFFIC_SECRETS; + + +// +// Data Representation Constant: +// +#define SECURITY_NATIVE_DREP 0x00000010 +#define SECURITY_NETWORK_DREP 0x00000000 + +// +// Credential Use Flags +// +#define SECPKG_CRED_INBOUND 0x00000001 +#define SECPKG_CRED_OUTBOUND 0x00000002 +#define SECPKG_CRED_BOTH 0x00000003 +#define SECPKG_CRED_DEFAULT 0x00000004 +#define SECPKG_CRED_RESERVED 0xF0000000 + +// +// SSP SHOULD prompt the user for credentials/consent, independent +// of whether credentials to be used are the 'logged on' credentials +// or retrieved from credman. +// +// An SSP may choose not to prompt, however, in circumstances determined +// by the SSP. +// + +#define SECPKG_CRED_AUTOLOGON_RESTRICTED 0x00000010 + +// +// auth will always fail, ISC() is called to process policy data only +// + +#define SECPKG_CRED_PROCESS_POLICY_ONLY 0x00000020 + +// Enables configuring Kerberos to only request tickets from a specific DC version + +#define SECPKG_CRED_KERB_ANCHOR_DS_VERSION 0x00000040 + + +// +// InitializeSecurityContext Requirement and return flags: +// + +#define ISC_REQ_DELEGATE 0x00000001 +#define ISC_REQ_MUTUAL_AUTH 0x00000002 +#define ISC_REQ_REPLAY_DETECT 0x00000004 +#define ISC_REQ_SEQUENCE_DETECT 0x00000008 +#define ISC_REQ_CONFIDENTIALITY 0x00000010 +#define ISC_REQ_USE_SESSION_KEY 0x00000020 +#define ISC_REQ_PROMPT_FOR_CREDS 0x00000040 +#define ISC_REQ_USE_SUPPLIED_CREDS 0x00000080 +#define ISC_REQ_ALLOCATE_MEMORY 0x00000100 +#define ISC_REQ_USE_DCE_STYLE 0x00000200 +#define ISC_REQ_DATAGRAM 0x00000400 +#define ISC_REQ_CONNECTION 0x00000800 +#define ISC_REQ_CALL_LEVEL 0x00001000 +#define ISC_REQ_FRAGMENT_SUPPLIED 0x00002000 +#define ISC_REQ_EXTENDED_ERROR 0x00004000 +#define ISC_REQ_STREAM 0x00008000 +#define ISC_REQ_INTEGRITY 0x00010000 +#define ISC_REQ_IDENTIFY 0x00020000 +#define ISC_REQ_NULL_SESSION 0x00040000 +#define ISC_REQ_MANUAL_CRED_VALIDATION 0x00080000 +#define ISC_REQ_RESERVED1 0x00100000 +#define ISC_REQ_FRAGMENT_TO_FIT 0x00200000 +// This exists only in Windows Vista and greater +#define ISC_REQ_FORWARD_CREDENTIALS 0x00400000 +#define ISC_REQ_NO_INTEGRITY 0x00800000 // honored only by SPNEGO +#define ISC_REQ_USE_HTTP_STYLE 0x01000000 +#define ISC_REQ_UNVERIFIED_TARGET_NAME 0x20000000 +#define ISC_REQ_CONFIDENTIALITY_ONLY 0x40000000 // honored by SPNEGO/Kerberos +#define ISC_REQ_MESSAGES 0x0000000100000000 // Disables the TLS 1.3+ record layer and causes the security context to consume and produce cleartext TLS messages, rather than records. +// Request that schannel perform server cert chain validation without failing the handshake on errors (deferred), +// same as SCH_CRED_DEFERRED_CRED_VALIDATION except applies to context not credential handle. +#define ISC_REQ_DEFERRED_CRED_VALIDATION 0x0000000200000000 +// Prevents the client sending the post_handshake_auth extension in the TLS 1.3 Client Hello. +#define ISC_REQ_NO_POST_HANDSHAKE_AUTH 0x0000000400000000 +// Request TLS 1.3+ session ticket reuse. Passive observers may be able to track the TLS client across networks. +#define ISC_REQ_REUSE_SESSION_TICKETS 0x0000000800000000 +// Request explicit TLS 1.3+ session management. Received TLS 1.3+ session tickets will be returned to the SSPI caller. +// The SSPI caller will specify the session ticket to send in each resumption attempt. +#define ISC_REQ_EXPLICIT_SESSION 0x0000001000000000 + +#define ISC_RET_DELEGATE 0x00000001 +#define ISC_RET_MUTUAL_AUTH 0x00000002 +#define ISC_RET_REPLAY_DETECT 0x00000004 +#define ISC_RET_SEQUENCE_DETECT 0x00000008 +#define ISC_RET_CONFIDENTIALITY 0x00000010 +#define ISC_RET_USE_SESSION_KEY 0x00000020 +#define ISC_RET_USED_COLLECTED_CREDS 0x00000040 +#define ISC_RET_USED_SUPPLIED_CREDS 0x00000080 +#define ISC_RET_ALLOCATED_MEMORY 0x00000100 +#define ISC_RET_USED_DCE_STYLE 0x00000200 +#define ISC_RET_DATAGRAM 0x00000400 +#define ISC_RET_CONNECTION 0x00000800 +#define ISC_RET_INTERMEDIATE_RETURN 0x00001000 +#define ISC_RET_CALL_LEVEL 0x00002000 +#define ISC_RET_EXTENDED_ERROR 0x00004000 +#define ISC_RET_STREAM 0x00008000 +#define ISC_RET_INTEGRITY 0x00010000 +#define ISC_RET_IDENTIFY 0x00020000 +#define ISC_RET_NULL_SESSION 0x00040000 +#define ISC_RET_MANUAL_CRED_VALIDATION 0x00080000 +#define ISC_RET_RESERVED1 0x00100000 +#define ISC_RET_FRAGMENT_ONLY 0x00200000 +// This exists only in Windows Vista and greater +#define ISC_RET_FORWARD_CREDENTIALS 0x00400000 + +#define ISC_RET_USED_HTTP_STYLE 0x01000000 +#define ISC_RET_NO_ADDITIONAL_TOKEN 0x02000000 // *INTERNAL* +#define ISC_RET_REAUTHENTICATION 0x08000000 // *INTERNAL* +#define ISC_RET_CONFIDENTIALITY_ONLY 0x40000000 // honored by SPNEGO/Kerberos +#define ISC_RET_MESSAGES 0x0000000100000000 // Indicates that the TLS 1.3+ record layer is disabled, and the security context consumes and produces cleartext TLS messages, rather than records. +#define ISC_RET_DEFERRED_CRED_VALIDATION 0x0000000200000000 // Indicates that SCH_CRED_DEFERRED_CRED_VALIDATION/ISC_REQ_DEFERRED_CRED_VALIDATION request will be honored. +#define ISC_RET_NO_POST_HANDSHAKE_AUTH 0x0000000400000000 // Indicates that the TLS 1.3 Client Hello will not contain the post_handshake_auth extension. +#define ISC_RET_REUSE_SESSION_TICKETS 0x0000000800000000 // Indicates that the TLS 1.3+ client may reuse session tickets. +#define ISC_RET_EXPLICIT_SESSION 0x0000001000000000 // Indicates that explicit TLS 1.3+ session management is enabled. + +#define ASC_REQ_DELEGATE 0x00000001 +#define ASC_REQ_MUTUAL_AUTH 0x00000002 +#define ASC_REQ_REPLAY_DETECT 0x00000004 +#define ASC_REQ_SEQUENCE_DETECT 0x00000008 +#define ASC_REQ_CONFIDENTIALITY 0x00000010 +#define ASC_REQ_USE_SESSION_KEY 0x00000020 +#define ASC_REQ_SESSION_TICKET 0x00000040 +#define ASC_REQ_ALLOCATE_MEMORY 0x00000100 +#define ASC_REQ_USE_DCE_STYLE 0x00000200 +#define ASC_REQ_DATAGRAM 0x00000400 +#define ASC_REQ_CONNECTION 0x00000800 +#define ASC_REQ_CALL_LEVEL 0x00001000 +#define ASC_REQ_FRAGMENT_SUPPLIED 0x00002000 +#define ASC_REQ_EXTENDED_ERROR 0x00008000 +#define ASC_REQ_STREAM 0x00010000 +#define ASC_REQ_INTEGRITY 0x00020000 +#define ASC_REQ_LICENSING 0x00040000 +#define ASC_REQ_IDENTIFY 0x00080000 +#define ASC_REQ_ALLOW_NULL_SESSION 0x00100000 +#define ASC_REQ_ALLOW_NON_USER_LOGONS 0x00200000 +#define ASC_REQ_ALLOW_CONTEXT_REPLAY 0x00400000 +#define ASC_REQ_FRAGMENT_TO_FIT 0x00800000 + +#define ASC_REQ_NO_TOKEN 0x01000000 +#define ASC_REQ_PROXY_BINDINGS 0x04000000 +// SSP_RET_REAUTHENTICATION 0x08000000 // *INTERNAL* +#define ASC_REQ_ALLOW_MISSING_BINDINGS 0x10000000 +#define ASC_REQ_MESSAGES 0x0000000100000000 // Disables the TLS 1.3+ record layer and causes the security context to consume and produce cleartext TLS messages, rather than records. +// Request explicit TLS 1.3+ session management. TLS 1.3+ session ticket will only be generated when requested by the SSPI caller. +#define ASC_REQ_EXPLICIT_SESSION 0x0000001000000000 + +#define ASC_RET_DELEGATE 0x00000001 +#define ASC_RET_MUTUAL_AUTH 0x00000002 +#define ASC_RET_REPLAY_DETECT 0x00000004 +#define ASC_RET_SEQUENCE_DETECT 0x00000008 +#define ASC_RET_CONFIDENTIALITY 0x00000010 +#define ASC_RET_USE_SESSION_KEY 0x00000020 +#define ASC_RET_SESSION_TICKET 0x00000040 +#define ASC_RET_ALLOCATED_MEMORY 0x00000100 +#define ASC_RET_USED_DCE_STYLE 0x00000200 +#define ASC_RET_DATAGRAM 0x00000400 +#define ASC_RET_CONNECTION 0x00000800 +#define ASC_RET_CALL_LEVEL 0x00002000 // skipped 1000 to be like ISC_ +#define ASC_RET_THIRD_LEG_FAILED 0x00004000 +#define ASC_RET_EXTENDED_ERROR 0x00008000 +#define ASC_RET_STREAM 0x00010000 +#define ASC_RET_INTEGRITY 0x00020000 +#define ASC_RET_LICENSING 0x00040000 +#define ASC_RET_IDENTIFY 0x00080000 +#define ASC_RET_NULL_SESSION 0x00100000 +#define ASC_RET_ALLOW_NON_USER_LOGONS 0x00200000 +#define ASC_RET_ALLOW_CONTEXT_REPLAY 0x00400000 // deprecated - don't use this flag!!! +#define ASC_RET_FRAGMENT_ONLY 0x00800000 +#define ASC_RET_NO_TOKEN 0x01000000 +#define ASC_RET_NO_ADDITIONAL_TOKEN 0x02000000 // *INTERNAL* +// SSP_RET_REAUTHENTICATION 0x08000000 // *INTERNAL* +#define ASC_RET_MESSAGES 0x0000000100000000 // Indicates that the TLS 1.3+ record layer is disabled, and the security context consumes and produces cleartext TLS messages, rather than records. +#define ASC_RET_REUSE_SESSION_TICKETS 0x0000000800000000 // Indicates that the TLS 1.3+ server will allow session ticket reuse. +#define ASC_RET_EXPLICIT_SESSION 0x0000001000000000 // Indicates that explicit TLS 1.3+ session management is enabled. + +// +// Security Credentials Attributes: +// + +#define SECPKG_CRED_ATTR_NAMES 1 +#define SECPKG_CRED_ATTR_SSI_PROVIDER 2 +#define SECPKG_CRED_ATTR_KDC_PROXY_SETTINGS 3 // aliases SECPKG_CRED_ATTR_KDC_NETWORK_SETTINGS +#define SECPKG_CRED_ATTR_KDC_NETWORK_SETTINGS 3 // aliases SECPKG_CRED_ATTR_KDC_PROXY_SETTINGS +#define SECPKG_CRED_ATTR_CERT 4 +#define SECPKG_CRED_ATTR_PAC_BYPASS 5 + +typedef struct _SecPkgCredentials_NamesW +{ +#ifdef MIDL_PASS + [string] +#endif + SEC_WCHAR * sUserName; + +} SecPkgCredentials_NamesW, * PSecPkgCredentials_NamesW; + +// end_ntifs + +typedef struct _SecPkgCredentials_NamesA +{ +#ifdef MIDL_PASS + [string] +#endif + SEC_CHAR * sUserName; + +} SecPkgCredentials_NamesA, * PSecPkgCredentials_NamesA; + +#ifdef UNICODE +# define SecPkgCredentials_Names SecPkgCredentials_NamesW // ntifs +# define PSecPkgCredentials_Names PSecPkgCredentials_NamesW // ntifs +#else +# define SecPkgCredentials_Names SecPkgCredentials_NamesA +# define PSecPkgCredentials_Names PSecPkgCredentials_NamesA +#endif // !UNICODE + +// begin_ntifs + +#if NTDDI_VERSION > NTDDI_WS03 +typedef struct _SecPkgCredentials_SSIProviderW +{ + SEC_WCHAR * sProviderName; + unsigned long ProviderInfoLength; + char * ProviderInfo; +} SecPkgCredentials_SSIProviderW, * PSecPkgCredentials_SSIProviderW; +#endif // End W2k3SP1 and greater +// end_ntifs + +typedef struct _SecPkgCredentials_SSIProviderA +{ + SEC_CHAR * sProviderName; + unsigned long ProviderInfoLength; + char * ProviderInfo; +} SecPkgCredentials_SSIProviderA, * PSecPkgCredentials_SSIProviderA; + +#ifdef UNICODE +# define SecPkgCredentials_SSIProvider SecPkgCredentials_SSIProviderW // ntifs +# define PSecPkgCredentials_SSIProvider PSecPkgCredentials_SSIProviderW // ntifs +#else +# define SecPkgCredentials_SSIProvider SecPkgCredentials_SSIProviderA +# define PSecPkgCredentials_SSIProvider PSecPkgCredentials_SSIProviderA +#endif // !UNICODE + +// begin_ntifs + +#define KDC_PROXY_SETTINGS_V1 1 +#define KDC_NETWORK_SETTINGS_V2 2 + +#define KDC_PROXY_SETTINGS_FLAGS_FORCEPROXY 0x1 + +#define KDC_NETWORK_SETTINGS_FLAGS_FORCEPROXY 0x1 +#define KDC_NETWORK_SETTINGS_FLAGS_CONFIGURE_PROXY 0x80000000 +#define KDC_NETWORK_SETTINGS_FLAGS_CONFIGURE_DISCOVERY 0x40000000 + +#define KDC_NETWORK_DISCOVERY_FLAGS_DS13_REQUIRED 0x80000000 + +typedef struct _SecPkgCredentials_KdcProxySettingsW +{ + ULONG Version; // KDC_PROXY_SETTINGS_V1 + ULONG Flags; // KDC_PROXY_SETTINGS_FLAGS_* + USHORT ProxyServerOffset; // ProxyServer, optional + USHORT ProxyServerLength; + USHORT ClientTlsCredOffset; // ClientTlsCred, optional + USHORT ClientTlsCredLength; +} SecPkgCredentials_KdcProxySettingsW, *PSecPkgCredentials_KdcProxySettingsW; + +typedef struct _SecPkgCredentials_KdcNetworkSettingsW +{ + ULONG Version; // KDC_NETWORK_SETTINGS_V2 + ULONG Flags; // KDC_NETWORK_SETTINGS_FLAGS_* + USHORT ProxyServerOffset; // ProxyServer, optional + USHORT ProxyServerLength; + USHORT ClientTlsCredOffset; // ClientTlsCred, optional + USHORT ClientTlsCredLength; + ULONG DcDiscoveryFlags; // KDC_NETWORK_DISCOVERY_* +} SecPkgCredentials_KdcNetworkSettingsW, *PSecPkgCredentials_KdcNetworkSettingsW; + +// end_ntifs + +// begin_ntifs + +typedef struct _SecPkgCredentials_Cert +{ + unsigned long EncodedCertSize; + unsigned char* EncodedCert; +} SecPkgCredentials_Cert, * PSecPkgCredentials_Cert; + +// end_ntifs + +// begin_ntifs + +// +// Security Context Attributes: +// + +#define SECPKG_ATTR_SIZES 0 +#define SECPKG_ATTR_NAMES 1 +#define SECPKG_ATTR_LIFESPAN 2 +#define SECPKG_ATTR_DCE_INFO 3 +#define SECPKG_ATTR_STREAM_SIZES 4 +#define SECPKG_ATTR_KEY_INFO 5 +#define SECPKG_ATTR_AUTHORITY 6 +#define SECPKG_ATTR_PROTO_INFO 7 +#define SECPKG_ATTR_PASSWORD_EXPIRY 8 +#define SECPKG_ATTR_SESSION_KEY 9 +#define SECPKG_ATTR_PACKAGE_INFO 10 +#define SECPKG_ATTR_USER_FLAGS 11 +#define SECPKG_ATTR_NEGOTIATION_INFO 12 +#define SECPKG_ATTR_NATIVE_NAMES 13 +#define SECPKG_ATTR_FLAGS 14 +// These attributes exist only in Win XP and greater +#define SECPKG_ATTR_USE_VALIDATED 15 +#define SECPKG_ATTR_CREDENTIAL_NAME 16 +#define SECPKG_ATTR_TARGET_INFORMATION 17 +#define SECPKG_ATTR_ACCESS_TOKEN 18 +// These attributes exist only in Win2K3 and greater +#define SECPKG_ATTR_TARGET 19 +#define SECPKG_ATTR_AUTHENTICATION_ID 20 +// These attributes exist only in Win2K3SP1 and greater +#define SECPKG_ATTR_LOGOFF_TIME 21 +// +// win7 or greater +// +#define SECPKG_ATTR_NEGO_KEYS 22 +#define SECPKG_ATTR_PROMPTING_NEEDED 24 +#define SECPKG_ATTR_UNIQUE_BINDINGS 25 +#define SECPKG_ATTR_ENDPOINT_BINDINGS 26 +#define SECPKG_ATTR_CLIENT_SPECIFIED_TARGET 27 + +#define SECPKG_ATTR_LAST_CLIENT_TOKEN_STATUS 30 +#define SECPKG_ATTR_NEGO_PKG_INFO 31 // contains nego info of packages +#define SECPKG_ATTR_NEGO_STATUS 32 // contains the last error +#define SECPKG_ATTR_CONTEXT_DELETED 33 // a context has been deleted + +// +// win8 or greater +// +#define SECPKG_ATTR_DTLS_MTU 34 +#define SECPKG_ATTR_DATAGRAM_SIZES SECPKG_ATTR_STREAM_SIZES + +#define SECPKG_ATTR_SUBJECT_SECURITY_ATTRIBUTES 128 + +// +// win8.1 or greater +// +#define SECPKG_ATTR_APPLICATION_PROTOCOL 35 + +// +// win10 or greater +// +#define SECPKG_ATTR_NEGOTIATED_TLS_EXTENSIONS 36 +#define SECPKG_ATTR_IS_LOOPBACK 37 // indicates authentication to localhost + +typedef struct _SecPkgContext_SubjectAttributes { + void* AttributeInfo; // contains a PAUTHZ_SECURITY_ATTRIBUTES_INFORMATION structure +} SecPkgContext_SubjectAttributes, *PSecPkgContext_SubjectAttributes; + +#define SECPKG_ATTR_NEGO_INFO_FLAG_NO_KERBEROS 0x1 +#define SECPKG_ATTR_NEGO_INFO_FLAG_NO_NTLM 0x2 + +// +// types of credentials, used by SECPKG_ATTR_PROMPTING_NEEDED +// + +typedef enum _SECPKG_CRED_CLASS { + SecPkgCredClass_None = 0, // no creds + SecPkgCredClass_Ephemeral = 10, // logon creds + SecPkgCredClass_PersistedGeneric = 20, // saved creds, not target specific + SecPkgCredClass_PersistedSpecific = 30, // saved creds, target specific + SecPkgCredClass_Explicit = 40, // explicitly supplied creds +} SECPKG_CRED_CLASS, * PSECPKG_CRED_CLASS; + +typedef struct _SecPkgContext_CredInfo { + SECPKG_CRED_CLASS CredClass; + unsigned long IsPromptingNeeded; +} SecPkgContext_CredInfo, *PSecPkgContext_CredInfo; + +typedef struct _SecPkgContext_NegoPackageInfo +{ + unsigned long PackageMask; +} SecPkgContext_NegoPackageInfo, * PSecPkgContext_NegoPackageInfo; + +typedef struct _SecPkgContext_NegoStatus +{ + unsigned long LastStatus; +} SecPkgContext_NegoStatus, * PSecPkgContext_NegoStatus; + +typedef struct _SecPkgContext_Sizes +{ + unsigned long cbMaxToken; + unsigned long cbMaxSignature; + unsigned long cbBlockSize; + unsigned long cbSecurityTrailer; +} SecPkgContext_Sizes, * PSecPkgContext_Sizes; + +typedef struct _SecPkgContext_StreamSizes +{ + unsigned long cbHeader; + unsigned long cbTrailer; + unsigned long cbMaximumMessage; + unsigned long cBuffers; + unsigned long cbBlockSize; +} SecPkgContext_StreamSizes, * PSecPkgContext_StreamSizes; + +typedef SecPkgContext_StreamSizes SecPkgContext_DatagramSizes; +typedef PSecPkgContext_StreamSizes PSecPkgContext_DatagramSizes; + +typedef struct _SecPkgContext_NamesW +{ + SEC_WCHAR * sUserName; +} SecPkgContext_NamesW, * PSecPkgContext_NamesW; + +// end_ntifs + +typedef enum _SECPKG_ATTR_LCT_STATUS { + SecPkgAttrLastClientTokenYes, + SecPkgAttrLastClientTokenNo, + SecPkgAttrLastClientTokenMaybe +} SECPKG_ATTR_LCT_STATUS, * PSECPKG_ATTR_LCT_STATUS; + + +typedef struct _SecPkgContext_LastClientTokenStatus { + SECPKG_ATTR_LCT_STATUS LastClientTokenStatus; +} SecPkgContext_LastClientTokenStatus, * PSecPkgContext_LastClientTokenStatus; + +typedef struct _SecPkgContext_NamesA +{ + SEC_CHAR * sUserName; +} SecPkgContext_NamesA, * PSecPkgContext_NamesA; + +#ifdef UNICODE +# define SecPkgContext_Names SecPkgContext_NamesW // ntifs +# define PSecPkgContext_Names PSecPkgContext_NamesW // ntifs +#else +# define SecPkgContext_Names SecPkgContext_NamesA +# define PSecPkgContext_Names PSecPkgContext_NamesA +#endif // !UNICODE + +// begin_ntifs + +typedef struct _SecPkgContext_Lifespan +{ + TimeStamp tsStart; + TimeStamp tsExpiry; +} SecPkgContext_Lifespan, * PSecPkgContext_Lifespan; + +typedef struct _SecPkgContext_DceInfo +{ + unsigned long AuthzSvc; + void * pPac; +} SecPkgContext_DceInfo, * PSecPkgContext_DceInfo; + +// end_ntifs + +typedef struct _SecPkgContext_KeyInfoA +{ + SEC_CHAR * sSignatureAlgorithmName; + SEC_CHAR * sEncryptAlgorithmName; + unsigned long KeySize; + unsigned long SignatureAlgorithm; + unsigned long EncryptAlgorithm; +} SecPkgContext_KeyInfoA, * PSecPkgContext_KeyInfoA; + +// begin_ntifs + +typedef struct _SecPkgContext_KeyInfoW +{ + SEC_WCHAR * sSignatureAlgorithmName; + SEC_WCHAR * sEncryptAlgorithmName; + unsigned long KeySize; + unsigned long SignatureAlgorithm; + unsigned long EncryptAlgorithm; +} SecPkgContext_KeyInfoW, * PSecPkgContext_KeyInfoW; + +// end_ntifs + +#ifdef UNICODE +#define SecPkgContext_KeyInfo SecPkgContext_KeyInfoW // ntifs +#define PSecPkgContext_KeyInfo PSecPkgContext_KeyInfoW // ntifs +#else +#define SecPkgContext_KeyInfo SecPkgContext_KeyInfoA +#define PSecPkgContext_KeyInfo PSecPkgContext_KeyInfoA +#endif + +typedef struct _SecPkgContext_AuthorityA +{ + SEC_CHAR * sAuthorityName; +} SecPkgContext_AuthorityA, * PSecPkgContext_AuthorityA; + +// begin_ntifs + +typedef struct _SecPkgContext_AuthorityW +{ + SEC_WCHAR * sAuthorityName; +} SecPkgContext_AuthorityW, * PSecPkgContext_AuthorityW; + +// end_ntifs + +#ifdef UNICODE +#define SecPkgContext_Authority SecPkgContext_AuthorityW // ntifs +#define PSecPkgContext_Authority PSecPkgContext_AuthorityW // ntifs +#else +#define SecPkgContext_Authority SecPkgContext_AuthorityA +#define PSecPkgContext_Authority PSecPkgContext_AuthorityA +#endif + +typedef struct _SecPkgContext_ProtoInfoA +{ + SEC_CHAR * sProtocolName; + unsigned long majorVersion; + unsigned long minorVersion; +} SecPkgContext_ProtoInfoA, * PSecPkgContext_ProtoInfoA; + +// begin_ntifs + +typedef struct _SecPkgContext_ProtoInfoW +{ + SEC_WCHAR * sProtocolName; + unsigned long majorVersion; + unsigned long minorVersion; +} SecPkgContext_ProtoInfoW, * PSecPkgContext_ProtoInfoW; + +// end_ntifs + +#ifdef UNICODE +#define SecPkgContext_ProtoInfo SecPkgContext_ProtoInfoW // ntifs +#define PSecPkgContext_ProtoInfo PSecPkgContext_ProtoInfoW // ntifs +#else +#define SecPkgContext_ProtoInfo SecPkgContext_ProtoInfoA +#define PSecPkgContext_ProtoInfo PSecPkgContext_ProtoInfoA +#endif + +// begin_ntifs + +typedef struct _SecPkgContext_PasswordExpiry +{ + TimeStamp tsPasswordExpires; +} SecPkgContext_PasswordExpiry, * PSecPkgContext_PasswordExpiry; + +#if NTDDI_VERSION > NTDDI_WS03 +typedef struct _SecPkgContext_LogoffTime +{ + TimeStamp tsLogoffTime; +} SecPkgContext_LogoffTime, * PSecPkgContext_LogoffTime; +#endif // Greater than Windows Server 2003 RTM (SP1 and greater contains this) + +typedef struct _SecPkgContext_SessionKey +{ + unsigned long SessionKeyLength; + _Field_size_bytes_(SessionKeyLength) unsigned char * SessionKey; +} SecPkgContext_SessionKey, *PSecPkgContext_SessionKey; + +// used by nego2 +typedef struct _SecPkgContext_NegoKeys +{ + unsigned long KeyType; + unsigned short KeyLength; + _Field_size_bytes_(KeyLength) unsigned char* KeyValue; + unsigned long VerifyKeyType; + unsigned short VerifyKeyLength; + _Field_size_bytes_(VerifyKeyLength) unsigned char* VerifyKeyValue; +} SecPkgContext_NegoKeys, * PSecPkgContext_NegoKeys; + +typedef struct _SecPkgContext_PackageInfoW +{ + PSecPkgInfoW PackageInfo; +} SecPkgContext_PackageInfoW, * PSecPkgContext_PackageInfoW; + +// end_ntifs + +typedef struct _SecPkgContext_PackageInfoA +{ + PSecPkgInfoA PackageInfo; +} SecPkgContext_PackageInfoA, * PSecPkgContext_PackageInfoA; + +// begin_ntifs + +typedef struct _SecPkgContext_UserFlags +{ + unsigned long UserFlags; +} SecPkgContext_UserFlags, * PSecPkgContext_UserFlags; + +typedef struct _SecPkgContext_Flags +{ + unsigned long Flags; +} SecPkgContext_Flags, * PSecPkgContext_Flags; + +// end_ntifs + +#ifdef UNICODE +#define SecPkgContext_PackageInfo SecPkgContext_PackageInfoW // ntifs +#define PSecPkgContext_PackageInfo PSecPkgContext_PackageInfoW // ntifs +#else +#define SecPkgContext_PackageInfo SecPkgContext_PackageInfoA +#define PSecPkgContext_PackageInfo PSecPkgContext_PackageInfoA +#endif + + +typedef struct _SecPkgContext_NegotiationInfoA +{ + PSecPkgInfoA PackageInfo ; + unsigned long NegotiationState ; +} SecPkgContext_NegotiationInfoA, * PSecPkgContext_NegotiationInfoA ; + +// begin_ntifs +typedef struct _SecPkgContext_NegotiationInfoW +{ + PSecPkgInfoW PackageInfo ; + unsigned long NegotiationState ; +} SecPkgContext_NegotiationInfoW, * PSecPkgContext_NegotiationInfoW ; + +// end_ntifs + +#ifdef UNICODE +#define SecPkgContext_NegotiationInfo SecPkgContext_NegotiationInfoW +#define PSecPkgContext_NegotiationInfo PSecPkgContext_NegotiationInfoW +#else +#define SecPkgContext_NegotiationInfo SecPkgContext_NegotiationInfoA +#define PSecPkgContext_NegotiationInfo PSecPkgContext_NegotiationInfoA +#endif + +#define SECPKG_NEGOTIATION_COMPLETE 0 +#define SECPKG_NEGOTIATION_OPTIMISTIC 1 +#define SECPKG_NEGOTIATION_IN_PROGRESS 2 +#define SECPKG_NEGOTIATION_DIRECT 3 +#define SECPKG_NEGOTIATION_TRY_MULTICRED 4 + + +typedef struct _SecPkgContext_NativeNamesW +{ + SEC_WCHAR * sClientName; + SEC_WCHAR * sServerName; +} SecPkgContext_NativeNamesW, * PSecPkgContext_NativeNamesW; + +typedef struct _SecPkgContext_NativeNamesA +{ + SEC_CHAR * sClientName; + SEC_CHAR * sServerName; +} SecPkgContext_NativeNamesA, * PSecPkgContext_NativeNamesA; + + +#ifdef UNICODE +# define SecPkgContext_NativeNames SecPkgContext_NativeNamesW // ntifs +# define PSecPkgContext_NativeNames PSecPkgContext_NativeNamesW // ntifs +#else +# define SecPkgContext_NativeNames SecPkgContext_NativeNamesA +# define PSecPkgContext_NativeNames PSecPkgContext_NativeNamesA +#endif // !UNICODE + +// begin_ntifs + +#if OSVER(NTDDI_VERSION) > NTDDI_WIN2K + +typedef struct _SecPkgContext_CredentialNameW +{ + unsigned long CredentialType; + SEC_WCHAR *sCredentialName; +} SecPkgContext_CredentialNameW, * PSecPkgContext_CredentialNameW; + +#endif // Later than win2k +// end_ntifs + +typedef struct _SecPkgContext_CredentialNameA +{ + unsigned long CredentialType; + SEC_CHAR *sCredentialName; +} SecPkgContext_CredentialNameA, * PSecPkgContext_CredentialNameA; + +#ifdef UNICODE +# define SecPkgContext_CredentialName SecPkgContext_CredentialNameW // ntifs +# define PSecPkgContext_CredentialName PSecPkgContext_CredentialNameW // ntifs +#else +# define SecPkgContext_CredentialName SecPkgContext_CredentialNameA +# define PSecPkgContext_CredentialName PSecPkgContext_CredentialNameA +#endif // !UNICODE + +typedef struct _SecPkgContext_AccessToken +{ + void * AccessToken; +} SecPkgContext_AccessToken, * PSecPkgContext_AccessToken; + +typedef struct _SecPkgContext_TargetInformation +{ + unsigned long MarshalledTargetInfoLength; + unsigned char * MarshalledTargetInfo; + +} SecPkgContext_TargetInformation, * PSecPkgContext_TargetInformation; + +typedef struct _SecPkgContext_AuthzID +{ + unsigned long AuthzIDLength; + char * AuthzID; + +} SecPkgContext_AuthzID, * PSecPkgContext_AuthzID; + +typedef struct _SecPkgContext_Target +{ + unsigned long TargetLength; + char * Target; + +} SecPkgContext_Target, * PSecPkgContext_Target; + + +typedef struct _SecPkgContext_ClientSpecifiedTarget +{ + SEC_WCHAR * sTargetName; +} SecPkgContext_ClientSpecifiedTarget, * PSecPkgContext_ClientSpecifiedTarget; + +typedef struct _SecPkgContext_Bindings +{ + unsigned long BindingsLength; + _Field_size_bytes_(BindingsLength) SEC_CHANNEL_BINDINGS * Bindings; +} SecPkgContext_Bindings, * PSecPkgContext_Bindings; + +typedef enum _SEC_APPLICATION_PROTOCOL_NEGOTIATION_STATUS +{ + SecApplicationProtocolNegotiationStatus_None, + SecApplicationProtocolNegotiationStatus_Success, + SecApplicationProtocolNegotiationStatus_SelectedClientOnly +} SEC_APPLICATION_PROTOCOL_NEGOTIATION_STATUS, *PSEC_APPLICATION_PROTOCOL_NEGOTIATION_STATUS; + +#define MAX_PROTOCOL_ID_SIZE 0xff + +typedef struct _SecPkgContext_ApplicationProtocol +{ + SEC_APPLICATION_PROTOCOL_NEGOTIATION_STATUS ProtoNegoStatus; // Application protocol negotiation status + SEC_APPLICATION_PROTOCOL_NEGOTIATION_EXT ProtoNegoExt; // Protocol negotiation extension type corresponding to this protocol ID + unsigned char ProtocolIdSize; // Size in bytes of the application protocol ID + unsigned char ProtocolId[MAX_PROTOCOL_ID_SIZE]; // Byte string representing the negotiated application protocol ID +} SecPkgContext_ApplicationProtocol, *PSecPkgContext_ApplicationProtocol; + +typedef struct _SecPkgContext_NegotiatedTlsExtensions +{ + unsigned long ExtensionsCount; // Number of negotiated TLS extensions. + _Field_size_(ExtensionsCount) unsigned short * Extensions; // Pointer to array of 2-byte TLS extension IDs (allocated by IANA). +} SecPkgContext_NegotiatedTlsExtensions, * PSecPkgContext_NegotiatedTlsExtensions; + +typedef struct _SECPKG_APP_MODE_INFO { + ULONG UserFunction; + ULONG_PTR Argument1; + ULONG_PTR Argument2; + SecBuffer UserData; + BOOLEAN ReturnToLsa; +} SECPKG_APP_MODE_INFO, *PSECPKG_APP_MODE_INFO; + + +// begin_ntifs + +typedef void +(SEC_ENTRY * SEC_GET_KEY_FN) ( + void * Arg, // Argument passed in + void * Principal, // Principal ID + unsigned long KeyVer, // Key Version + void * * Key, // Returned ptr to key + SECURITY_STATUS * Status // returned status + ); + +// +// Flags for ExportSecurityContext +// + +#define SECPKG_CONTEXT_EXPORT_RESET_NEW 0x00000001 // New context is reset to initial state +#define SECPKG_CONTEXT_EXPORT_DELETE_OLD 0x00000002 // Old context is deleted during export +// This is only valid in W2K3SP1 and greater +#define SECPKG_CONTEXT_EXPORT_TO_KERNEL 0x00000004 // Context is to be transferred to the kernel + + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +AcquireCredentialsHandleW( +#if ISSP_MODE == 0 // For Kernel mode + _In_opt_ PSECURITY_STRING pPrincipal, + _In_ PSECURITY_STRING pPackage, +#else + _In_opt_ LPWSTR pszPrincipal, // Name of principal + _In_ LPWSTR pszPackage, // Name of package +#endif + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pvLogonId, // Pointer to logon ID + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _Out_ PCredHandle phCredential, // (out) Cred Handle + _Out_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ACQUIRE_CREDENTIALS_HANDLE_FN_W)( +#if ISSP_MODE == 0 + PSECURITY_STRING, + PSECURITY_STRING, +#else + SEC_WCHAR *, + SEC_WCHAR *, +#endif + unsigned long, + void *, + void *, + SEC_GET_KEY_FN, + void *, + PCredHandle, + PTimeStamp); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +AcquireCredentialsHandleA( + _In_opt_ LPSTR pszPrincipal, // Name of principal + _In_ LPSTR pszPackage, // Name of package + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pvLogonId, // Pointer to logon ID + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _Out_ PCredHandle phCredential, // (out) Cred Handle + _Out_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ACQUIRE_CREDENTIALS_HANDLE_FN_A)( + SEC_CHAR *, + SEC_CHAR *, + unsigned long, + void *, + void *, + SEC_GET_KEY_FN, + void *, + PCredHandle, + PTimeStamp); + +#ifdef UNICODE +# define AcquireCredentialsHandle AcquireCredentialsHandleW // ntifs +# define ACQUIRE_CREDENTIALS_HANDLE_FN ACQUIRE_CREDENTIALS_HANDLE_FN_W // ntifs +#else +# define AcquireCredentialsHandle AcquireCredentialsHandleA +# define ACQUIRE_CREDENTIALS_HANDLE_FN ACQUIRE_CREDENTIALS_HANDLE_FN_A +#endif // !UNICODE + +// begin_ntifs + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +FreeCredentialsHandle( + _In_ PCredHandle phCredential // Handle to free + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * FREE_CREDENTIALS_HANDLE_FN)( + PCredHandle ); + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +AddCredentialsW( + _In_ PCredHandle hCredentials, +#if ISSP_MODE == 0 // For Kernel mode + _In_opt_ PSECURITY_STRING pPrincipal, + _In_ PSECURITY_STRING pPackage, +#else + _In_opt_ LPWSTR pszPrincipal, // Name of principal + _In_ LPWSTR pszPackage, // Name of package +#endif + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _Out_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ADD_CREDENTIALS_FN_W)( + PCredHandle, +#if ISSP_MODE == 0 + PSECURITY_STRING, + PSECURITY_STRING, +#else + SEC_WCHAR *, + SEC_WCHAR *, +#endif + unsigned long, + void *, + SEC_GET_KEY_FN, + void *, + PTimeStamp); + +SECURITY_STATUS SEC_ENTRY +AddCredentialsA( + _In_ PCredHandle hCredentials, + _In_opt_ LPSTR pszPrincipal, // Name of principal + _In_ LPSTR pszPackage, // Name of package + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _Out_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ADD_CREDENTIALS_FN_A)( + PCredHandle, + SEC_CHAR *, + SEC_CHAR *, + unsigned long, + void *, + SEC_GET_KEY_FN, + void *, + PTimeStamp); + +#ifdef UNICODE +#define AddCredentials AddCredentialsW +#define ADD_CREDENTIALS_FN ADD_CREDENTIALS_FN_W +#else +#define AddCredentials AddCredentialsA +#define ADD_CREDENTIALS_FN ADD_CREDENTIALS_FN_A +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +//////////////////////////////////////////////////////////////////////// +/// +/// Asynchronous interface. Kernel-only (for now). +/// +//////////////////////////////////////////////////////////////////////// + +#if ISSP_MODE == 0 // For Kernel mode + +typedef struct _SspiAsyncContext SspiAsyncContext; + +// +// Callback used for notifying completion of an async SSPI call. +// +typedef void (*SspiAsyncNotifyCallback)( + _In_ SspiAsyncContext* Handle, + _In_opt_ PVOID CallbackData +); + +// +// Return a newly initialized context. +// +SspiAsyncContext* SspiCreateAsyncContext(); + +// +// Free up a context. +// +void SspiFreeAsyncContext( + _In_opt_ SspiAsyncContext* Handle +); + +// +// Mark an async context for reuse. Only the context state is altered. +// Client notification info, such as callback, is left alone +// +// If the context is invalid or currently in use, an error will be returned. +// +NTSTATUS SspiReinitAsyncContext( + _Inout_ SspiAsyncContext* Handle +); + +// +// Installs a callback which will be notified on async call completion. +// +SECURITY_STATUS SspiSetAsyncNotifyCallback( + _In_ SspiAsyncContext* Context, + _In_ SspiAsyncNotifyCallback Callback, + _In_opt_ void* CallbackData +); + +// +// Determines if the given async context requires notification on completion +// of the call. +// +BOOLEAN SspiAsyncContextRequiresNotify( + _In_ SspiAsyncContext* AsyncContext +); + +// +// Gets the current status of an async call. Until the call is completed, +// status will be SEC_I_ASYNC_CALL_PENDING. +// +SECURITY_STATUS SspiGetAsyncCallStatus( + _In_ SspiAsyncContext* Handle +); + +SECURITY_STATUS SspiAcquireCredentialsHandleAsyncW( + _Inout_ SspiAsyncContext* AsyncContext, +#if ISSP_MODE == 0 + _In_opt_ PSECURITY_STRING pszPrincipal, // Name of principal + _In_ PSECURITY_STRING pszPackage, // Name of package +#else + _In_opt_ LPWSTR pszPrincipal, // Name of principal + _In_ LPWSTR pszPackage, // Name of package +#endif + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pvLogonId, // Pointer to logon ID + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _In_ PCredHandle phCredential, // (out) Cred Handle + _In_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) +); + +SECURITY_STATUS SspiAcquireCredentialsHandleAsyncA( + _Inout_ SspiAsyncContext* AsyncContext, + _In_opt_ LPSTR pszPrincipal, // Name of principal + _In_ LPSTR pszPackage, // Name of package + _In_ unsigned long fCredentialUse, // Flags indicating use + _In_opt_ void * pvLogonId, // Pointer to logon ID + _In_opt_ void * pAuthData, // Package specific data + _In_opt_ SEC_GET_KEY_FN pGetKeyFn, // Pointer to GetKey() func + _In_opt_ void * pvGetKeyArgument, // Value to pass to GetKey() + _In_ PCredHandle phCredential, // (out) Cred Handle + _In_opt_ PTimeStamp ptsExpiry // (out) Lifetime (optional) +); + +SECURITY_STATUS SspiInitializeSecurityContextAsyncW( + _Inout_ SspiAsyncContext* AsyncContext, + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) +#if ISSP_MODE == 0 + _In_opt_ PSECURITY_STRING pszTargetName, // Name of target +#else + _In_opt_ LPWSTR pszTargetName, // Name of target +#endif + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _In_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _In_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _In_ unsigned long * pfContextAttr, // (out) Context attrs + _In_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) +); + +SECURITY_STATUS SspiInitializeSecurityContextAsyncA( + _Inout_ SspiAsyncContext* AsyncContext, + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ LPSTR pszTargetName, // Name of target + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _In_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _In_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _In_ unsigned long * pfContextAttr, // (out) Context attrs + _In_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) +); + +SECURITY_STATUS SspiAcceptSecurityContextAsync( + _Inout_ SspiAsyncContext* AsyncContext, + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ PSecBufferDesc pInput, // Input buffer + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long TargetDataRep, // Target Data Rep + _In_opt_ PCtxtHandle phNewContext, // (out) New context handle + _In_opt_ PSecBufferDesc pOutput, // (inout) Output buffers + _In_ unsigned long* pfContextAttr, // (out) Context attributes + _In_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) +); + +SECURITY_STATUS SspiFreeCredentialsHandleAsync( + _Inout_ SspiAsyncContext* AsyncContext, + _In_ PCredHandle phCredential // Handle to free +); + +SECURITY_STATUS SspiDeleteSecurityContextAsync( + _Inout_ SspiAsyncContext* AsyncContext, + _In_ PCtxtHandle phContext // Context to delete +); + +#ifdef UNICODE +# define SspiAcquireCredentialsHandleAsync SspiAcquireCredentialsHandleAsyncW +# define SspiInitializeSecurityContextAsync SspiInitializeSecurityContextAsyncW +#else +# define SspiAcquireCredentialsHandleAsync SspiAcquireCredentialsHandleAsyncA +# define SspiInitializeSecurityContextAsync SspiInitializeSecurityContextAsync +#endif + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +//////////////////////////////////////////////////////////////////////// +/// +/// Password Change Functions +/// +//////////////////////////////////////////////////////////////////////// + +#if ISSP_MODE != 0 + +SECURITY_STATUS SEC_ENTRY +ChangeAccountPasswordW( + _In_ SEC_WCHAR * pszPackageName, + _In_ SEC_WCHAR * pszDomainName, + _In_ SEC_WCHAR * pszAccountName, + _In_ SEC_WCHAR * pszOldPassword, + _In_ SEC_WCHAR * pszNewPassword, + _In_ BOOLEAN bImpersonating, + _In_ unsigned long dwReserved, + _Inout_ PSecBufferDesc pOutput + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * CHANGE_PASSWORD_FN_W)( + SEC_WCHAR *, + SEC_WCHAR *, + SEC_WCHAR *, + SEC_WCHAR *, + SEC_WCHAR *, + BOOLEAN, + unsigned long, + PSecBufferDesc + ); + + + +SECURITY_STATUS SEC_ENTRY +ChangeAccountPasswordA( + _In_ SEC_CHAR * pszPackageName, + _In_ SEC_CHAR * pszDomainName, + _In_ SEC_CHAR * pszAccountName, + _In_ SEC_CHAR * pszOldPassword, + _In_ SEC_CHAR * pszNewPassword, + _In_ BOOLEAN bImpersonating, + _In_ unsigned long dwReserved, + _Inout_ PSecBufferDesc pOutput + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * CHANGE_PASSWORD_FN_A)( + SEC_CHAR *, + SEC_CHAR *, + SEC_CHAR *, + SEC_CHAR *, + SEC_CHAR *, + BOOLEAN, + unsigned long, + PSecBufferDesc + ); + +#ifdef UNICODE +# define ChangeAccountPassword ChangeAccountPasswordW +# define CHANGE_PASSWORD_FN CHANGE_PASSWORD_FN_W +#else +# define ChangeAccountPassword ChangeAccountPasswordA +# define CHANGE_PASSWORD_FN CHANGE_PASSWORD_FN_A +#endif // !UNICODE + +#endif // ISSP_MODE + + +//////////////////////////////////////////////////////////////////////// +/// +/// Context Management Functions +/// +//////////////////////////////////////////////////////////////////////// + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +InitializeSecurityContextW( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) +#if ISSP_MODE == 0 + _In_opt_ PSECURITY_STRING pTargetName, +#else + _In_opt_ SEC_WCHAR * pszTargetName, // Name of target +#endif + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _Inout_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attrs + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * INITIALIZE_SECURITY_CONTEXT_FN_W)( + PCredHandle, + PCtxtHandle, +#if ISSP_MODE == 0 + PSECURITY_STRING, +#else + SEC_WCHAR *, +#endif + unsigned long, + unsigned long, + unsigned long, + PSecBufferDesc, + unsigned long, + PCtxtHandle, + PSecBufferDesc, + unsigned long *, + PTimeStamp); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +InitializeSecurityContextA( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ SEC_CHAR * pszTargetName, // Name of target + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _Inout_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attrs + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * INITIALIZE_SECURITY_CONTEXT_FN_A)( + PCredHandle, + PCtxtHandle, + SEC_CHAR *, + unsigned long, + unsigned long, + unsigned long, + PSecBufferDesc, + unsigned long, + PCtxtHandle, + PSecBufferDesc, + unsigned long *, + PTimeStamp); + +#ifdef UNICODE +# define InitializeSecurityContext InitializeSecurityContextW // ntifs +# define INITIALIZE_SECURITY_CONTEXT_FN INITIALIZE_SECURITY_CONTEXT_FN_W // ntifs +#else +# define InitializeSecurityContext InitializeSecurityContextA +# define INITIALIZE_SECURITY_CONTEXT_FN INITIALIZE_SECURITY_CONTEXT_FN_A +#endif // !UNICODE + +// begin_ntifs + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +AcceptSecurityContext( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ PSecBufferDesc pInput, // Input buffer + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long TargetDataRep, // Target Data Rep + _Inout_opt_ PCtxtHandle phNewContext, // (out) New context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attributes + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ACCEPT_SECURITY_CONTEXT_FN)( + PCredHandle, + PCtxtHandle, + PSecBufferDesc, + unsigned long, + unsigned long, + PCtxtHandle, + PSecBufferDesc, + unsigned long *, + PTimeStamp); + +SECURITY_STATUS SEC_ENTRY +CompleteAuthToken( + _In_ PCtxtHandle phContext, // Context to complete + _In_ PSecBufferDesc pToken // Token to complete + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * COMPLETE_AUTH_TOKEN_FN)( + PCtxtHandle, + PSecBufferDesc); + +KSECDDDECLSPEC +_Check_return_ +SECURITY_STATUS SEC_ENTRY +ImpersonateSecurityContext( + _In_ PCtxtHandle phContext // Context to impersonate + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * IMPERSONATE_SECURITY_CONTEXT_FN)( + PCtxtHandle); + + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +RevertSecurityContext( + _In_ PCtxtHandle phContext // Context from which to re + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * REVERT_SECURITY_CONTEXT_FN)( + PCtxtHandle); + + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +QuerySecurityContextToken( + _In_ PCtxtHandle phContext, + _Out_ void * * Token + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_SECURITY_CONTEXT_TOKEN_FN)( + PCtxtHandle, void * *); + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +DeleteSecurityContext( + _In_ PCtxtHandle phContext // Context to delete + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * DELETE_SECURITY_CONTEXT_FN)( + PCtxtHandle); + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +ApplyControlToken( + _In_ PCtxtHandle phContext, // Context to modify + _In_ PSecBufferDesc pInput // Input token to apply + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * APPLY_CONTROL_TOKEN_FN)( + PCtxtHandle, PSecBufferDesc); + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +QueryContextAttributesW( + _In_ PCtxtHandle phContext, // Context to query + _In_ unsigned long ulAttribute, // Attribute to query + _Out_ void * pBuffer // Buffer for attributes + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CONTEXT_ATTRIBUTES_FN_W)( + PCtxtHandle, + unsigned long, + void *); + +SECURITY_STATUS SEC_ENTRY +QueryContextAttributesExW( + _In_ PCtxtHandle phContext, // Context to query + _In_ unsigned long ulAttribute, // Attribute to query + _Out_writes_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Length of buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CONTEXT_ATTRIBUTES_EX_FN_W)( + PCtxtHandle, + unsigned long, + void *, + unsigned long); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +QueryContextAttributesA( + _In_ PCtxtHandle phContext, // Context to query + _In_ unsigned long ulAttribute, // Attribute to query + _Out_ void * pBuffer // Buffer for attributes + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CONTEXT_ATTRIBUTES_FN_A)( + PCtxtHandle, + unsigned long, + void *); + +SECURITY_STATUS SEC_ENTRY +QueryContextAttributesExA( + _In_ PCtxtHandle phContext, // Context to query + _In_ unsigned long ulAttribute, // Attribute to query + _Out_writes_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Length of buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CONTEXT_ATTRIBUTES_EX_FN_A)( + PCtxtHandle, + unsigned long, + void *, + unsigned long); + +#ifdef UNICODE +# define QueryContextAttributes QueryContextAttributesW // ntifs +# define QUERY_CONTEXT_ATTRIBUTES_FN QUERY_CONTEXT_ATTRIBUTES_FN_W // ntifs +# define QueryContextAttributesEx QueryContextAttributesExW // ntifs +# define QUERY_CONTEXT_ATTRIBUTES_EX_FN QUERY_CONTEXT_ATTRIBUTES_EX_FN_W // ntifs +#else +# define QueryContextAttributes QueryContextAttributesA +# define QUERY_CONTEXT_ATTRIBUTES_FN QUERY_CONTEXT_ATTRIBUTES_FN_A +# define QueryContextAttributesEx QueryContextAttributesExA +# define QUERY_CONTEXT_ATTRIBUTES_EX_FN QUERY_CONTEXT_ATTRIBUTES_EX_FN_A +#endif // !UNICODE + +// begin_ntifs + +#if (OSVER(NTDDI_VERSION) > NTDDI_WIN2K) + +SECURITY_STATUS SEC_ENTRY +SetContextAttributesW( + _In_ PCtxtHandle phContext, // Context to Set + _In_ unsigned long ulAttribute, // Attribute to Set + _In_reads_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Size (in bytes) of Buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * SET_CONTEXT_ATTRIBUTES_FN_W)( + PCtxtHandle, + unsigned long, + void *, + unsigned long ); + +#endif // Greater than w2k + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +SetContextAttributesA( + _In_ PCtxtHandle phContext, // Context to Set + _In_ unsigned long ulAttribute, // Attribute to Set + _In_reads_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Size (in bytes) of Buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * SET_CONTEXT_ATTRIBUTES_FN_A)( + PCtxtHandle, + unsigned long, + void *, + unsigned long ); + +#ifdef UNICODE +# define SetContextAttributes SetContextAttributesW // ntifs +# define SET_CONTEXT_ATTRIBUTES_FN SET_CONTEXT_ATTRIBUTES_FN_W // ntifs +#else +# define SetContextAttributes SetContextAttributesA +# define SET_CONTEXT_ATTRIBUTES_FN SET_CONTEXT_ATTRIBUTES_FN_A +#endif // !UNICODE + +// begin_ntifs + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +QueryCredentialsAttributesW( + _In_ PCredHandle phCredential, // Credential to query + _In_ unsigned long ulAttribute, // Attribute to query + _Inout_ void * pBuffer // Buffer for attributes + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CREDENTIALS_ATTRIBUTES_FN_W)( + PCredHandle, + unsigned long, + void *); + +SECURITY_STATUS SEC_ENTRY +QueryCredentialsAttributesExW( + _In_ PCredHandle phCredential, // Credential to query + _In_ unsigned long ulAttribute, // Attribute to query + _Inout_updates_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Length of buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_W)( + PCredHandle, + unsigned long, + void *, + unsigned long); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +QueryCredentialsAttributesA( + _In_ PCredHandle phCredential, // Credential to query + _In_ unsigned long ulAttribute, // Attribute to query + _Inout_ void * pBuffer // Buffer for attributes + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CREDENTIALS_ATTRIBUTES_FN_A)( + PCredHandle, + unsigned long, + void *); + +SECURITY_STATUS SEC_ENTRY +QueryCredentialsAttributesExA( + _In_ PCredHandle phCredential, // Credential to query + _In_ unsigned long ulAttribute, // Attribute to query + _Inout_updates_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Length of buffer + ); + + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_A)( + PCredHandle, + unsigned long, + void *, + unsigned long); + +#ifdef UNICODE +# define QueryCredentialsAttributes QueryCredentialsAttributesW // ntifs +# define QUERY_CREDENTIALS_ATTRIBUTES_FN QUERY_CREDENTIALS_ATTRIBUTES_FN_W // ntifs +# define QueryCredentialsAttributesEx QueryCredentialsAttributesExW // ntifs +# define QUERY_CREDENTIALS_ATTRIBUTES_EX_FN QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_W // ntifs +#else +# define QueryCredentialsAttributes QueryCredentialsAttributesA +# define QUERY_CREDENTIALS_ATTRIBUTES_FN QUERY_CREDENTIALS_ATTRIBUTES_FN_A +# define QueryCredentialsAttributesEx QueryCredentialsAttributesExA +# define QUERY_CREDENTIALS_ATTRIBUTES_EX_FN QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_A +#endif // !UNICODE + +// begin_ntifs + +#if NTDDI_VERSION > NTDDI_WS03 + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +SetCredentialsAttributesW( + _In_ PCredHandle phCredential, // Credential to Set + _In_ unsigned long ulAttribute, // Attribute to Set + _In_reads_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Size (in bytes) of Buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * SET_CREDENTIALS_ATTRIBUTES_FN_W)( + PCredHandle, + unsigned long, + void *, + unsigned long ); + +#endif // For W2k3SP1 and greater + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +SetCredentialsAttributesA( + _In_ PCredHandle phCredential, // Credential to Set + _In_ unsigned long ulAttribute, // Attribute to Set + _In_reads_bytes_(cbBuffer) void * pBuffer, // Buffer for attributes + _In_ unsigned long cbBuffer // Size (in bytes) of Buffer + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * SET_CREDENTIALS_ATTRIBUTES_FN_A)( + PCredHandle, + unsigned long, + void *, + unsigned long ); + +#ifdef UNICODE +# define SetCredentialsAttributes SetCredentialsAttributesW // ntifs +# define SET_CREDENTIALS_ATTRIBUTES_FN SET_CREDENTIALS_ATTRIBUTES_FN_W // ntifs +#else +# define SetCredentialsAttributes SetCredentialsAttributesA +# define SET_CREDENTIALS_ATTRIBUTES_FN SET_CREDENTIALS_ATTRIBUTES_FN_A +#endif // !UNICODE + +// begin_ntifs + +SECURITY_STATUS SEC_ENTRY +FreeContextBuffer( + _Inout_ PVOID pvContextBuffer // buffer to free + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * FREE_CONTEXT_BUFFER_FN)( + _Inout_ PVOID + ); + +SECURITY_STATUS +SEC_ENTRY +SecAllocateAndSetIPAddress( + _In_reads_bytes_(cchIpAddress) PUCHAR lpIpAddress, + _In_ ULONG cchIpAddress, + _Out_ int* FreeCallContext // Avoid creating a dependence on minwindef.h by replacing PBOOL with its definition int* + ); + +SECURITY_STATUS +SEC_ENTRY +SecAllocateAndSetCallTarget( + _In_reads_bytes_opt_(cchIpAddress) PUCHAR lpIpAddress, + _In_ ULONG cchIpAddress, + _In_opt_ LPWSTR TargetName, + _Out_ int* FreeCallContext // Avoid creating a dependence on minwindef.h by replacing PBOOL with its definition int* + ); + +VOID +SEC_ENTRY +SecFreeCallContext( + VOID + ); + +// end_ntifs + + +// begin_ntifs +/////////////////////////////////////////////////////////////////// +//// +//// Message Support API +//// +////////////////////////////////////////////////////////////////// + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +MakeSignature( + _In_ PCtxtHandle phContext, // Context to use + _In_ unsigned long fQOP, // Quality of Protection + _In_ PSecBufferDesc pMessage, // Message to sign + _In_ unsigned long MessageSeqNo // Message Sequence Num. + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * MAKE_SIGNATURE_FN)( + PCtxtHandle, + unsigned long, + PSecBufferDesc, + unsigned long); + + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +VerifySignature( + _In_ PCtxtHandle phContext, // Context to use + _In_ PSecBufferDesc pMessage, // Message to verify + _In_ unsigned long MessageSeqNo, // Sequence Num. + _Out_ unsigned long * pfQOP // QOP used + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * VERIFY_SIGNATURE_FN)( + PCtxtHandle, + PSecBufferDesc, + unsigned long, + unsigned long *); + +// This only exists win Win2k3 and Greater +#define SECQOP_WRAP_NO_ENCRYPT 0x80000001 +#define SECQOP_WRAP_OOB_DATA 0x40000000 + +SECURITY_STATUS SEC_ENTRY +EncryptMessage( _In_ PCtxtHandle phContext, + _In_ unsigned long fQOP, + _In_ PSecBufferDesc pMessage, + _In_ unsigned long MessageSeqNo); + +typedef SECURITY_STATUS +(SEC_ENTRY * ENCRYPT_MESSAGE_FN)( + PCtxtHandle, unsigned long, PSecBufferDesc, unsigned long); + + +SECURITY_STATUS SEC_ENTRY +DecryptMessage( _In_ PCtxtHandle phContext, + _In_ PSecBufferDesc pMessage, + _In_ unsigned long MessageSeqNo, + _Out_opt_ unsigned long * pfQOP); + + +typedef SECURITY_STATUS +(SEC_ENTRY * DECRYPT_MESSAGE_FN)( + PCtxtHandle, PSecBufferDesc, unsigned long, + unsigned long *); + + +// end_ntifs + +// begin_ntifs +/////////////////////////////////////////////////////////////////////////// +//// +//// Misc. +//// +/////////////////////////////////////////////////////////////////////////// + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +EnumerateSecurityPackagesW( + _Out_ unsigned long * pcPackages, // Receives num. packages + _Outptr_ PSecPkgInfoW * ppPackageInfo // Receives array of info + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ENUMERATE_SECURITY_PACKAGES_FN_W)( + unsigned long *, + PSecPkgInfoW *); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +EnumerateSecurityPackagesA( + _Out_ unsigned long * pcPackages, // Receives num. packages + _Outptr_ PSecPkgInfoA * ppPackageInfo // Receives array of info + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * ENUMERATE_SECURITY_PACKAGES_FN_A)( + unsigned long *, + PSecPkgInfoA *); + +#ifdef UNICODE +# define EnumerateSecurityPackages EnumerateSecurityPackagesW // ntifs +# define ENUMERATE_SECURITY_PACKAGES_FN ENUMERATE_SECURITY_PACKAGES_FN_W // ntifs +#else +# define EnumerateSecurityPackages EnumerateSecurityPackagesA +# define ENUMERATE_SECURITY_PACKAGES_FN ENUMERATE_SECURITY_PACKAGES_FN_A +#endif // !UNICODE + +// begin_ntifs + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +QuerySecurityPackageInfoW( +#if ISSP_MODE == 0 + _In_ PSECURITY_STRING pPackageName, +#else + _In_ LPWSTR pszPackageName, // Name of package +#endif + _Outptr_ PSecPkgInfoW *ppPackageInfo // Receives package info + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_SECURITY_PACKAGE_INFO_FN_W)( +#if ISSP_MODE == 0 + PSECURITY_STRING, +#else + SEC_WCHAR *, +#endif + PSecPkgInfoW *); + +// end_ntifs + +SECURITY_STATUS SEC_ENTRY +QuerySecurityPackageInfoA( + _In_ LPSTR pszPackageName, // Name of package + _Outptr_ PSecPkgInfoA *ppPackageInfo // Receives package info + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * QUERY_SECURITY_PACKAGE_INFO_FN_A)( + SEC_CHAR *, + PSecPkgInfoA *); + +#ifdef UNICODE +# define QuerySecurityPackageInfo QuerySecurityPackageInfoW // ntifs +# define QUERY_SECURITY_PACKAGE_INFO_FN QUERY_SECURITY_PACKAGE_INFO_FN_W // ntifs +#else +# define QuerySecurityPackageInfo QuerySecurityPackageInfoA +# define QUERY_SECURITY_PACKAGE_INFO_FN QUERY_SECURITY_PACKAGE_INFO_FN_A +#endif // !UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +typedef enum _SecDelegationType { + SecFull, + SecService, + SecTree, + SecDirectory, + SecObject +} SecDelegationType, * PSecDelegationType; + +SECURITY_STATUS SEC_ENTRY +DelegateSecurityContext( + PCtxtHandle phContext, // IN Active context to delegate +#if ISSP_MODE == 0 + PSECURITY_STRING pTarget, // IN Target path +#else + _In_ LPSTR pszTarget, +#endif + SecDelegationType DelegationType, // IN Type of delegation + PTimeStamp pExpiry, // IN OPTIONAL time limit + PSecBuffer pPackageParameters, // IN OPTIONAL package specific + PSecBufferDesc pOutput); // OUT Token for applycontroltoken. + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +/////////////////////////////////////////////////////////////////////////// +//// +//// Proxies +//// +/////////////////////////////////////////////////////////////////////////// + + +// +// Proxies are only available on NT platforms +// + +// begin_ntifs + +/////////////////////////////////////////////////////////////////////////// +//// +//// Context export/import +//// +/////////////////////////////////////////////////////////////////////////// + + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +ExportSecurityContext( + _In_ PCtxtHandle phContext, // (in) context to export + _In_ ULONG fFlags, // (in) option flags + _Out_ PSecBuffer pPackedContext, // (out) marshalled context + _Out_ void * * pToken // (out, optional) token handle for impersonation + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * EXPORT_SECURITY_CONTEXT_FN)( + PCtxtHandle, + ULONG, + PSecBuffer, + void * * + ); + +KSECDDDECLSPEC +SECURITY_STATUS SEC_ENTRY +ImportSecurityContextW( +#if ISSP_MODE == 0 + _In_ PSECURITY_STRING pszPackage, +#else + _In_ LPWSTR pszPackage, +#endif + _In_ PSecBuffer pPackedContext, // (in) marshalled context + _In_ void * Token, // (in, optional) handle to token for context + _Out_ PCtxtHandle phContext // (out) new context handle + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * IMPORT_SECURITY_CONTEXT_FN_W)( +#if ISSP_MODE == 0 + PSECURITY_STRING, +#else + SEC_WCHAR *, +#endif + PSecBuffer, + VOID *, + PCtxtHandle + ); + +// end_ntifs +SECURITY_STATUS SEC_ENTRY +ImportSecurityContextA( + _In_ LPSTR pszPackage, + _In_ PSecBuffer pPackedContext, // (in) marshalled context + _In_ VOID * Token, // (in, optional) handle to token for context + _Out_ PCtxtHandle phContext // (out) new context handle + ); + +typedef SECURITY_STATUS +(SEC_ENTRY * IMPORT_SECURITY_CONTEXT_FN_A)( + SEC_CHAR *, + PSecBuffer, + void *, + PCtxtHandle + ); + +#ifdef UNICODE +# define ImportSecurityContext ImportSecurityContextW // ntifs +# define IMPORT_SECURITY_CONTEXT_FN IMPORT_SECURITY_CONTEXT_FN_W // ntifs +#else +# define ImportSecurityContext ImportSecurityContextA +# define IMPORT_SECURITY_CONTEXT_FN IMPORT_SECURITY_CONTEXT_FN_A +#endif // !UNICODE + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// begin_ntifs + +#if ISSP_MODE == 0 +KSECDDDECLSPEC +NTSTATUS +NTAPI +SecMakeSPN( + IN PUNICODE_STRING ServiceClass, + IN PUNICODE_STRING ServiceName, + IN PUNICODE_STRING InstanceName OPTIONAL, + IN USHORT InstancePort OPTIONAL, + IN PUNICODE_STRING Referrer OPTIONAL, + IN OUT PUNICODE_STRING Spn, + OUT PULONG Length OPTIONAL, + IN BOOLEAN Allocate + ); + +#if OSVER(NTDDI_VERSION) > NTDD_WIN2K + +KSECDDDECLSPEC +NTSTATUS +NTAPI +SecMakeSPNEx( + IN PUNICODE_STRING ServiceClass, + IN PUNICODE_STRING ServiceName, + IN PUNICODE_STRING InstanceName OPTIONAL, + IN USHORT InstancePort OPTIONAL, + IN PUNICODE_STRING Referrer OPTIONAL, + IN PUNICODE_STRING TargetInfo OPTIONAL, + IN OUT PUNICODE_STRING Spn, + OUT PULONG Length OPTIONAL, + IN BOOLEAN Allocate + ); + +#if OSVER(NTDDI_VERSION) > NTDDI_WS03 + +KSECDDDECLSPEC +NTSTATUS +NTAPI +SecMakeSPNEx2( + IN PUNICODE_STRING ServiceClass, + IN PUNICODE_STRING ServiceName, + IN PUNICODE_STRING InstanceName OPTIONAL, + IN USHORT InstancePort OPTIONAL, + IN PUNICODE_STRING Referrer OPTIONAL, + IN PUNICODE_STRING InTargetInfo OPTIONAL, + IN OUT PUNICODE_STRING Spn, + OUT PULONG TotalSize OPTIONAL, + IN BOOLEAN Allocate, + IN BOOLEAN IsTargetInfoMarshaled + ); + +#endif // Windows Vista and greater + +KSECDDDECLSPEC +NTSTATUS +SEC_ENTRY +SecLookupAccountSid( + _In_ PSID Sid, + _Out_ PULONG NameSize, + _Inout_ PUNICODE_STRING NameBuffer, + _Out_ PULONG DomainSize OPTIONAL, + _Out_opt_ PUNICODE_STRING DomainBuffer OPTIONAL, + _Out_ PSID_NAME_USE NameUse + ); + +KSECDDDECLSPEC +NTSTATUS +SEC_ENTRY +SecLookupAccountName( + _In_ PUNICODE_STRING Name, + _Inout_ PULONG SidSize, + _Out_ PSID Sid, + _Out_ PSID_NAME_USE NameUse, + _Out_ PULONG DomainSize OPTIONAL, + _Inout_opt_ PUNICODE_STRING ReferencedDomain OPTIONAL + ); + +#endif // Greater than W2k + +#if OSVER(NTDDI_VERSION) > NTDDI_WINXP + +KSECDDDECLSPEC +NTSTATUS +SEC_ENTRY +SecLookupWellKnownSid( + _In_ WELL_KNOWN_SID_TYPE SidType, + _Out_ PSID Sid, + _In_ ULONG SidBufferSize, + _Inout_opt_ PULONG SidSize OPTIONAL + ); + +#endif // Greater than XP + + +#endif + +// end_ntifs + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +/////////////////////////////////////////////////////////////////////////////// +//// +//// Fast access for RPC: +//// +/////////////////////////////////////////////////////////////////////////////// + +#define SECURITY_ENTRYPOINT_ANSIW "InitSecurityInterfaceW" +#define SECURITY_ENTRYPOINT_ANSIA "InitSecurityInterfaceA" +#define SECURITY_ENTRYPOINTW SEC_TEXT("InitSecurityInterfaceW") // ntifs +#define SECURITY_ENTRYPOINTA SEC_TEXT("InitSecurityInterfaceA") +#define SECURITY_ENTRYPOINT16 "INITSECURITYINTERFACEA" + +#ifdef SECURITY_WIN32 +# ifdef UNICODE +# define SECURITY_ENTRYPOINT SECURITY_ENTRYPOINTW // ntifs +# define SECURITY_ENTRYPOINT_ANSI SECURITY_ENTRYPOINT_ANSIW +# else // UNICODE +# define SECURITY_ENTRYPOINT SECURITY_ENTRYPOINTA +# define SECURITY_ENTRYPOINT_ANSI SECURITY_ENTRYPOINT_ANSIA +# endif // UNICODE +#else // SECURITY_WIN32 +# define SECURITY_ENTRYPOINT SECURITY_ENTRYPOINT16 +# define SECURITY_ENTRYPOINT_ANSI SECURITY_ENTRYPOINT16 +#endif // SECURITY_WIN32 + +// begin_ntifs + +#define FreeCredentialHandle FreeCredentialsHandle + +typedef struct _SECURITY_FUNCTION_TABLE_W { + unsigned long dwVersion; + ENUMERATE_SECURITY_PACKAGES_FN_W EnumerateSecurityPackagesW; + QUERY_CREDENTIALS_ATTRIBUTES_FN_W QueryCredentialsAttributesW; + ACQUIRE_CREDENTIALS_HANDLE_FN_W AcquireCredentialsHandleW; + FREE_CREDENTIALS_HANDLE_FN FreeCredentialsHandle; + void * Reserved2; + INITIALIZE_SECURITY_CONTEXT_FN_W InitializeSecurityContextW; + ACCEPT_SECURITY_CONTEXT_FN AcceptSecurityContext; + COMPLETE_AUTH_TOKEN_FN CompleteAuthToken; + DELETE_SECURITY_CONTEXT_FN DeleteSecurityContext; + APPLY_CONTROL_TOKEN_FN ApplyControlToken; + QUERY_CONTEXT_ATTRIBUTES_FN_W QueryContextAttributesW; + IMPERSONATE_SECURITY_CONTEXT_FN ImpersonateSecurityContext; + REVERT_SECURITY_CONTEXT_FN RevertSecurityContext; + MAKE_SIGNATURE_FN MakeSignature; + VERIFY_SIGNATURE_FN VerifySignature; + FREE_CONTEXT_BUFFER_FN FreeContextBuffer; + QUERY_SECURITY_PACKAGE_INFO_FN_W QuerySecurityPackageInfoW; + void * Reserved3; + void * Reserved4; + EXPORT_SECURITY_CONTEXT_FN ExportSecurityContext; + IMPORT_SECURITY_CONTEXT_FN_W ImportSecurityContextW; + ADD_CREDENTIALS_FN_W AddCredentialsW ; + void * Reserved8; + QUERY_SECURITY_CONTEXT_TOKEN_FN QuerySecurityContextToken; + ENCRYPT_MESSAGE_FN EncryptMessage; + DECRYPT_MESSAGE_FN DecryptMessage; +#if OSVER(NTDDI_VERSION) > NTDDI_WIN2K + // Fields below this are available in OSes after w2k + SET_CONTEXT_ATTRIBUTES_FN_W SetContextAttributesW; +#endif // greater thean 2K + +#if NTDDI_VERSION > NTDDI_WS03SP1 + // Fields below this are available in OSes after W2k3SP1 + SET_CREDENTIALS_ATTRIBUTES_FN_W SetCredentialsAttributesW; +#endif +#if ISSP_MODE != 0 + CHANGE_PASSWORD_FN_W ChangeAccountPasswordW; +#else + void * Reserved9; +#endif +#if NTDDI_VERSION > NTDDI_WINBLUE + // Fields below this are available in OSes after Windows 8.1 + QUERY_CONTEXT_ATTRIBUTES_EX_FN_W QueryContextAttributesExW; + QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_W QueryCredentialsAttributesExW; +#endif +} SecurityFunctionTableW, * PSecurityFunctionTableW; + +// end_ntifs + +typedef struct _SECURITY_FUNCTION_TABLE_A { + unsigned long dwVersion; + ENUMERATE_SECURITY_PACKAGES_FN_A EnumerateSecurityPackagesA; + QUERY_CREDENTIALS_ATTRIBUTES_FN_A QueryCredentialsAttributesA; + ACQUIRE_CREDENTIALS_HANDLE_FN_A AcquireCredentialsHandleA; + FREE_CREDENTIALS_HANDLE_FN FreeCredentialHandle; + void * Reserved2; + INITIALIZE_SECURITY_CONTEXT_FN_A InitializeSecurityContextA; + ACCEPT_SECURITY_CONTEXT_FN AcceptSecurityContext; + COMPLETE_AUTH_TOKEN_FN CompleteAuthToken; + DELETE_SECURITY_CONTEXT_FN DeleteSecurityContext; + APPLY_CONTROL_TOKEN_FN ApplyControlToken; + QUERY_CONTEXT_ATTRIBUTES_FN_A QueryContextAttributesA; + IMPERSONATE_SECURITY_CONTEXT_FN ImpersonateSecurityContext; + REVERT_SECURITY_CONTEXT_FN RevertSecurityContext; + MAKE_SIGNATURE_FN MakeSignature; + VERIFY_SIGNATURE_FN VerifySignature; + FREE_CONTEXT_BUFFER_FN FreeContextBuffer; + QUERY_SECURITY_PACKAGE_INFO_FN_A QuerySecurityPackageInfoA; + void * Reserved3; + void * Reserved4; + EXPORT_SECURITY_CONTEXT_FN ExportSecurityContext; + IMPORT_SECURITY_CONTEXT_FN_A ImportSecurityContextA; + ADD_CREDENTIALS_FN_A AddCredentialsA ; + void * Reserved8; + QUERY_SECURITY_CONTEXT_TOKEN_FN QuerySecurityContextToken; + ENCRYPT_MESSAGE_FN EncryptMessage; + DECRYPT_MESSAGE_FN DecryptMessage; + SET_CONTEXT_ATTRIBUTES_FN_A SetContextAttributesA; + SET_CREDENTIALS_ATTRIBUTES_FN_A SetCredentialsAttributesA; +#if ISSP_MODE != 0 + CHANGE_PASSWORD_FN_A ChangeAccountPasswordA; +#else + void * Reserved9; +#endif +#if NTDDI_VERSION > NTDDI_WINBLUE + // Fields below this are available in OSes after Windows 8.1 + QUERY_CONTEXT_ATTRIBUTES_EX_FN_A QueryContextAttributesExA; + QUERY_CREDENTIALS_ATTRIBUTES_EX_FN_A QueryCredentialsAttributesExA; +#endif +} SecurityFunctionTableA, * PSecurityFunctionTableA; + +#ifdef UNICODE +# define SecurityFunctionTable SecurityFunctionTableW // ntifs +# define PSecurityFunctionTable PSecurityFunctionTableW // ntifs +#else +# define SecurityFunctionTable SecurityFunctionTableA +# define PSecurityFunctionTable PSecurityFunctionTableA +#endif // !UNICODE + +#define SECURITY_ + +// Function table has all routines through DecryptMessage +#define SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION 1 // ntifs + +// Function table has all routines through SetContextAttributes +#define SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_2 2 // ntifs + +// Function table has all routines through SetCredentialsAttributes +#define SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_3 3 // ntifs + +// Function table has all routines through ChangeAccountPassword +#define SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_4 4 // ntifs + +// Function table has all routines through QueryCredentialsAttributesEx +#define SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_5 5 // ntifs + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +PSecurityFunctionTableA SEC_ENTRY +InitSecurityInterfaceA( + void + ); + +typedef PSecurityFunctionTableA +(SEC_ENTRY * INIT_SECURITY_INTERFACE_A)(void); + +// begin_ntifs + +KSECDDDECLSPEC +PSecurityFunctionTableW SEC_ENTRY +InitSecurityInterfaceW( + void + ); + +typedef PSecurityFunctionTableW +(SEC_ENTRY * INIT_SECURITY_INTERFACE_W)(void); + +// end_ntifs + +#ifdef UNICODE +# define InitSecurityInterface InitSecurityInterfaceW // ntifs +# define INIT_SECURITY_INTERFACE INIT_SECURITY_INTERFACE_W // ntifs +#else +# define InitSecurityInterface InitSecurityInterfaceA +# define INIT_SECURITY_INTERFACE INIT_SECURITY_INTERFACE_A +#endif // !UNICODE + + +#ifdef SECURITY_WIN32 + +// +// SASL Profile Support +// + + +SECURITY_STATUS +SEC_ENTRY +SaslEnumerateProfilesA( + _Outptr_ LPSTR * ProfileList, + _Out_ ULONG * ProfileCount + ); + +SECURITY_STATUS +SEC_ENTRY +SaslEnumerateProfilesW( + _Outptr_ LPWSTR * ProfileList, + _Out_ ULONG * ProfileCount + ); + +#ifdef UNICODE +#define SaslEnumerateProfiles SaslEnumerateProfilesW +#else +#define SaslEnumerateProfiles SaslEnumerateProfilesA +#endif + + +SECURITY_STATUS +SEC_ENTRY +SaslGetProfilePackageA( + _In_ LPSTR ProfileName, + _Outptr_ PSecPkgInfoA * PackageInfo + ); + + +SECURITY_STATUS +SEC_ENTRY +SaslGetProfilePackageW( + _In_ LPWSTR ProfileName, + _Outptr_ PSecPkgInfoW * PackageInfo + ); + +#ifdef UNICODE +#define SaslGetProfilePackage SaslGetProfilePackageW +#else +#define SaslGetProfilePackage SaslGetProfilePackageA +#endif + +SECURITY_STATUS +SEC_ENTRY +SaslIdentifyPackageA( + _In_ PSecBufferDesc pInput, + _Outptr_ PSecPkgInfoA * PackageInfo + ); + +SECURITY_STATUS +SEC_ENTRY +SaslIdentifyPackageW( + _In_ PSecBufferDesc pInput, + _Outptr_ PSecPkgInfoW * PackageInfo + ); + +#ifdef UNICODE +#define SaslIdentifyPackage SaslIdentifyPackageW +#else +#define SaslIdentifyPackage SaslIdentifyPackageA +#endif + +SECURITY_STATUS +SEC_ENTRY +SaslInitializeSecurityContextW( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ LPWSTR pszTargetName, // Name of target + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _Inout_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attrs + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + +SECURITY_STATUS +SEC_ENTRY +SaslInitializeSecurityContextA( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ LPSTR pszTargetName, // Name of target + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long Reserved1, // Reserved, MBZ + _In_ unsigned long TargetDataRep, // Data rep of target + _In_opt_ PSecBufferDesc pInput, // Input Buffers + _In_ unsigned long Reserved2, // Reserved, MBZ + _Inout_opt_ PCtxtHandle phNewContext, // (out) New Context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output Buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attrs + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + +#ifdef UNICODE +#define SaslInitializeSecurityContext SaslInitializeSecurityContextW +#else +#define SaslInitializeSecurityContext SaslInitializeSecurityContextA +#endif + + +SECURITY_STATUS +SEC_ENTRY +SaslAcceptSecurityContext( + _In_opt_ PCredHandle phCredential, // Cred to base context + _In_opt_ PCtxtHandle phContext, // Existing context (OPT) + _In_opt_ PSecBufferDesc pInput, // Input buffer + _In_ unsigned long fContextReq, // Context Requirements + _In_ unsigned long TargetDataRep, // Target Data Rep + _Inout_opt_ PCtxtHandle phNewContext, // (out) New context handle + _Inout_opt_ PSecBufferDesc pOutput, // (inout) Output buffers + _Out_ unsigned long * pfContextAttr, // (out) Context attributes + _Out_opt_ PTimeStamp ptsExpiry // (out) Life span (OPT) + ); + + +#define SASL_OPTION_SEND_SIZE 1 // Maximum size to send to peer +#define SASL_OPTION_RECV_SIZE 2 // Maximum size willing to receive +#define SASL_OPTION_AUTHZ_STRING 3 // Authorization string +#define SASL_OPTION_AUTHZ_PROCESSING 4 // Authorization string processing + +typedef enum _SASL_AUTHZID_STATE { + Sasl_AuthZIDForbidden, // allow no AuthZID strings to be specified - error out (default) + Sasl_AuthZIDProcessed // AuthZID Strings processed by Application or SSP +} SASL_AUTHZID_STATE ; + +SECURITY_STATUS +SEC_ENTRY +SaslSetContextOption( + _In_ PCtxtHandle ContextHandle, + _In_ ULONG Option, + _In_ PVOID Value, + _In_ ULONG Size + ); + + +SECURITY_STATUS +SEC_ENTRY +SaslGetContextOption( + _In_ PCtxtHandle ContextHandle, + _In_ ULONG Option, + _Out_ PVOID Value, + _In_ ULONG Size, + _Out_opt_ PULONG Needed OPTIONAL + ); + +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifdef SECURITY_DOS +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#pragma warning(default:4147) +#endif +#endif + +// +// This is the legacy credentials structure. +// The EX version below is preferred. + +// begin_ntifs + +#ifndef _AUTH_IDENTITY_EX2_DEFINED +#define _AUTH_IDENTITY_EX2_DEFINED + +#define SEC_WINNT_AUTH_IDENTITY_VERSION_2 0x201 + +typedef struct _SEC_WINNT_AUTH_IDENTITY_EX2 { + unsigned long Version; // contains SEC_WINNT_AUTH_IDENTITY_VERSION_2 + unsigned short cbHeaderLength; + unsigned long cbStructureLength; + unsigned long UserOffset; // Non-NULL terminated string, unicode only + unsigned short UserLength; // # of bytes (NOT WCHARs), not including NULL. + unsigned long DomainOffset; // Non-NULL terminated string, unicode only + unsigned short DomainLength; // # of bytes (NOT WCHARs), not including NULL. + unsigned long PackedCredentialsOffset; // Non-NULL terminated string, unicode only + unsigned short PackedCredentialsLength; // # of bytes (NOT WCHARs), not including NULL. + unsigned long Flags; + unsigned long PackageListOffset; // Non-NULL terminated string, unicode only + unsigned short PackageListLength; +} SEC_WINNT_AUTH_IDENTITY_EX2, *PSEC_WINNT_AUTH_IDENTITY_EX2; + +#endif // _AUTH_IDENTITY_EX2_DEFINED + +#ifndef _AUTH_IDENTITY_DEFINED +#define _AUTH_IDENTITY_DEFINED + +// +// This was not defined in NTIFS.h for windows 2000 however +// this struct has always been there and are safe to use +// in windows 2000 and above. +// + +#define SEC_WINNT_AUTH_IDENTITY_ANSI 0x1 +#define SEC_WINNT_AUTH_IDENTITY_UNICODE 0x2 + +typedef struct _SEC_WINNT_AUTH_IDENTITY_W { + unsigned short *User; // Non-NULL terminated string. + unsigned long UserLength; // # of characters (NOT bytes), not including NULL. + unsigned short *Domain; // Non-NULL terminated string. + unsigned long DomainLength; // # of characters (NOT bytes), not including NULL. + unsigned short *Password; // Non-NULL terminated string. + unsigned long PasswordLength; // # of characters (NOT bytes), not including NULL. + unsigned long Flags; +} SEC_WINNT_AUTH_IDENTITY_W, *PSEC_WINNT_AUTH_IDENTITY_W; + +// end_ntifs + +#define _AUTH_IDENTITY_A_DEFINED + +typedef struct _SEC_WINNT_AUTH_IDENTITY_A { + unsigned char *User; // Non-NULL terminated string. + unsigned long UserLength; // # of characters (NOT bytes), not including NULL. + unsigned char *Domain; // Non-NULL terminated string. + unsigned long DomainLength; // # of characters (NOT bytes), not including NULL. + unsigned char *Password; // Non-NULL terminated string. + unsigned long PasswordLength; // # of characters (NOT bytes), not including NULL. + unsigned long Flags; +} SEC_WINNT_AUTH_IDENTITY_A, *PSEC_WINNT_AUTH_IDENTITY_A; + + +#ifdef UNICODE +#define SEC_WINNT_AUTH_IDENTITY SEC_WINNT_AUTH_IDENTITY_W // ntifs +#define PSEC_WINNT_AUTH_IDENTITY PSEC_WINNT_AUTH_IDENTITY_W // ntifs +#define _SEC_WINNT_AUTH_IDENTITY _SEC_WINNT_AUTH_IDENTITY_W // ntifs +#else // UNICODE +#define SEC_WINNT_AUTH_IDENTITY SEC_WINNT_AUTH_IDENTITY_A +#define PSEC_WINNT_AUTH_IDENTITY PSEC_WINNT_AUTH_IDENTITY_A +#define _SEC_WINNT_AUTH_IDENTITY _SEC_WINNT_AUTH_IDENTITY_A +#endif // UNICODE + +// begin_ntifs + +#endif //_AUTH_IDENTITY_DEFINED // ntifs + +// +// This is the combined authentication identity structure that may be +// used with the negotiate package, NTLM, Kerberos, or SCHANNEL +// + +#ifndef SEC_WINNT_AUTH_IDENTITY_VERSION +#define SEC_WINNT_AUTH_IDENTITY_VERSION 0x200 + +typedef struct _SEC_WINNT_AUTH_IDENTITY_EXW { + unsigned long Version; + unsigned long Length; + unsigned short *User; // Non-NULL terminated string. + unsigned long UserLength; // # of characters (NOT bytes), not including NULL. + unsigned short *Domain; // Non-NULL terminated string. + unsigned long DomainLength; // # of characters (NOT bytes), not including NULL. + unsigned short *Password; // Non-NULL terminated string. + unsigned long PasswordLength; // # of characters (NOT bytes), not including NULL. + unsigned long Flags; + unsigned short *PackageList; + unsigned long PackageListLength; +} SEC_WINNT_AUTH_IDENTITY_EXW, *PSEC_WINNT_AUTH_IDENTITY_EXW; + +// end_ntifs + +typedef struct _SEC_WINNT_AUTH_IDENTITY_EXA { + unsigned long Version; + unsigned long Length; + unsigned char *User; // Non-NULL terminated string. + unsigned long UserLength; // # of characters (NOT bytes), not including NULL. + unsigned char *Domain; // Non-NULL terminated string. + unsigned long DomainLength; // # of characters (NOT bytes), not including NULL. + unsigned char *Password; // Non-NULL terminated string. + unsigned long PasswordLength; // # of characters (NOT bytes), not including NULL. + unsigned long Flags; + unsigned char * PackageList; + unsigned long PackageListLength; +} SEC_WINNT_AUTH_IDENTITY_EXA, *PSEC_WINNT_AUTH_IDENTITY_EXA; + +#ifdef UNICODE +#define SEC_WINNT_AUTH_IDENTITY_EX SEC_WINNT_AUTH_IDENTITY_EXW // ntifs +#define PSEC_WINNT_AUTH_IDENTITY_EX PSEC_WINNT_AUTH_IDENTITY_EXW // ntifs +#else +#define SEC_WINNT_AUTH_IDENTITY_EX SEC_WINNT_AUTH_IDENTITY_EXA +#endif + +// begin_ntifs + +#endif // SEC_WINNT_AUTH_IDENTITY_VERSION + +// end_ntifs + +#ifndef _AUTH_IDENTITY_INFO_DEFINED +#define _AUTH_IDENTITY_INFO_DEFINED + +// +// the procedure for how to parse a SEC_WINNT_AUTH_IDENTITY_INFO structure: +// +// 1) First check the first DWORD of SEC_WINNT_AUTH_IDENTITY_INFO, if the first +// DWORD is 0x200, it is either an AuthIdExw or AuthIdExA, otherwise if the first +// DWORD is 0x201, the structure is an AuthIdEx2 structure. Otherwise the structure +// is either an AuthId_a or an AuthId_w. +// +// 2) Secondly check the flags for SEC_WINNT_AUTH_IDENTITY_ANSI or +// SEC_WINNT_AUTH_IDENTITY_UNICODE, the presence of the former means the structure +// is an ANSI structure. Otherwise, the structure is the wide version. Note that +// AuthIdEx2 does not have an ANSI version so this check does not apply to it. +// + +typedef union _SEC_WINNT_AUTH_IDENTITY_INFO { + SEC_WINNT_AUTH_IDENTITY_EXW AuthIdExw; + SEC_WINNT_AUTH_IDENTITY_EXA AuthIdExa; + SEC_WINNT_AUTH_IDENTITY_A AuthId_a; + SEC_WINNT_AUTH_IDENTITY_W AuthId_w; + SEC_WINNT_AUTH_IDENTITY_EX2 AuthIdEx2; +} SEC_WINNT_AUTH_IDENTITY_INFO, *PSEC_WINNT_AUTH_IDENTITY_INFO; + +// the credential structure is encrypted via +// RtlEncryptMemory(OptionFlags = 0) +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_PROCESS_ENCRYPTED 0x10 + +// the credential structure is protected by local system via +// RtlEncryptMemory(OptionFlags=RTL_ENCRYPT_OPTION_SAME_LOGON) +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SYSTEM_PROTECTED 0x20 + +// the credential structure is encrypted by a non-system context +// RtlEncryptMemory(OptionFlags=RTL_ENCRYPT_OPTION_SAME_LOGON) +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_USER_PROTECTED 0x40 + +// the credential structure is encrypted with +// RtlEncryptMemory(OptionFlags=RTL_ENCRYPT_OPTION_FOR_SYSTEM) +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SYSTEM_ENCRYPTED 0x80 + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_RESERVED 0x10000 +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_NULL_USER 0x20000 +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_NULL_DOMAIN 0x40000 +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_ID_PROVIDER 0x80000 + + +// +// These bits are for communication between SspiPromptForCredentials() +// and the credential providers. Do not use these bits for any other +// purpose. +// + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_USE_MASK 0xFF000000 + +// +// Instructs the credential provider to not save credentials itself +// when caller selects the "Remember my credential" checkbox. +// + + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_CREDPROV_DO_NOT_SAVE 0x80000000 + +// +// Support the old name for this flag for callers that were built for earlier +// versions of the SDK. +// + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_SAVE_CRED_BY_CALLER SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_CREDPROV_DO_NOT_SAVE + +// +// State of the "Remember my credentials" checkbox. +// When set, indicates checked; when cleared, indicates unchecked. +// + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_SAVE_CRED_CHECKED 0x40000000 + +// +// The "Save" checkbox is not displayed on the credential provider tiles +// + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_NO_CHECKBOX 0x20000000 + +// +// Credential providers will not attempt to prepopulate the CredUI dialog +// box with credentials retrieved from Cred Man. +// + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_CREDPROV_DO_NOT_LOAD 0x10000000 + + +#define SEC_WINNT_AUTH_IDENTITY_FLAGS_VALID_SSPIPFC_FLAGS \ + (SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_CREDPROV_DO_NOT_SAVE | \ + SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_SAVE_CRED_CHECKED | \ + SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_NO_CHECKBOX | \ + SEC_WINNT_AUTH_IDENTITY_FLAGS_SSPIPFC_CREDPROV_DO_NOT_LOAD) + + +#endif // _AUTH_IDENTITY_INFO_DEFINED + +#ifndef _SSPIPFC_NONE_ // the public view + +// begin_ntifs + +typedef PVOID PSEC_WINNT_AUTH_IDENTITY_OPAQUE; // the credential structure is opaque + +// end_ntifs + +#else // the internal view + +typedef PSEC_WINNT_AUTH_IDENTITY_INFO PSEC_WINNT_AUTH_IDENTITY_OPAQUE; + +#endif // _SSPIPFC_NONE_ + +// +// dwFlags parameter of SspiPromptForCredentials(): +// + +// +// Indicates that the credentials should not be saved if +// the user selects the 'save' (or 'remember my password') +// checkbox in the credential dialog box. The location pointed +// to by the pfSave parameter indicates whether or not the user +// selected the checkbox. +// +// Note that some credential providers won't honour this flag and +// may save the credentials in a persistent manner anyway if the +// user selects the 'save' checbox. +// + +#define SSPIPFC_CREDPROV_DO_NOT_SAVE 0x00000001 + +// +// Support the old name for this flag for callers that were built for earlier +// versions of the SDK. +// + + +#define SSPIPFC_SAVE_CRED_BY_CALLER SSPIPFC_CREDPROV_DO_NOT_SAVE + +// +// The password and smart card credential providers will not display the +// "Remember my credentials" check box in the provider tiles. +// + +#define SSPIPFC_NO_CHECKBOX 0x00000002 + +// +// Credential providers will not attempt to prepopulate the CredUI dialog +// box with credentials retrieved from Cred Man. +// + +#define SSPIPFC_CREDPROV_DO_NOT_LOAD 0x00000004 + +// +// Credential providers along with UI Dialog will be hosted in a separate +// broker process. +// +#define SSPIPFC_USE_CREDUIBROKER 0x00000008 + +#define SSPIPFC_VALID_FLAGS (SSPIPFC_CREDPROV_DO_NOT_SAVE | SSPIPFC_NO_CHECKBOX | SSPIPFC_CREDPROV_DO_NOT_LOAD | SSPIPFC_USE_CREDUIBROKER) + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#ifndef _SSPIPFC_NONE_ // the public view + +// Use SspiFreeAuthIdentity() to free the buffer returned +// in ppAuthIdentity. + +unsigned long +SEC_ENTRY +SspiPromptForCredentialsW( + _In_ PCWSTR pszTargetName, +#ifdef _CREDUI_INFO_DEFINED + _In_opt_ PCREDUI_INFOW pUiInfo, +#else + _In_opt_ PVOID pUiInfo, +#endif // _CREDUI_INFO_DEFINED + _In_ unsigned long dwAuthError, + _In_ PCWSTR pszPackage, + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE pInputAuthIdentity, + _Outptr_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE* ppAuthIdentity, + _Inout_opt_ int* pfSave, + _In_ unsigned long dwFlags + ); + +// Use SspiFreeAuthIdentity() to free the buffer returned +// in ppAuthIdentity. + +unsigned long +SEC_ENTRY +SspiPromptForCredentialsA( + _In_ PCSTR pszTargetName, +#ifdef _CREDUI_INFO_DEFINED + _In_opt_ PCREDUI_INFOA pUiInfo, +#else + _In_opt_ PVOID pUiInfo, +#endif // _CREDUI_INFO_DEFINED + _In_ unsigned long dwAuthError, + _In_ PCSTR pszPackage, + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE pInputAuthIdentity, + _Outptr_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE* ppAuthIdentity, + _Inout_opt_ int* pfSave, + _In_ unsigned long dwFlags + ); +#endif // _SSPIPFC_NONE_ + +#ifdef UNICODE +#define SspiPromptForCredentials SspiPromptForCredentialsW +#else +#define SspiPromptForCredentials SspiPromptForCredentialsA +#endif + +#ifdef _SEC_WINNT_AUTH_TYPES + +typedef struct _SEC_WINNT_AUTH_BYTE_VECTOR { + unsigned long ByteArrayOffset; // each element is a byte + unsigned short ByteArrayLength; // +} SEC_WINNT_AUTH_BYTE_VECTOR, *PSEC_WINNT_AUTH_BYTE_VECTOR; + +typedef struct _SEC_WINNT_AUTH_DATA { + GUID CredType; + SEC_WINNT_AUTH_BYTE_VECTOR CredData; +} SEC_WINNT_AUTH_DATA, *PSEC_WINNT_AUTH_DATA; + +typedef struct _SEC_WINNT_AUTH_PACKED_CREDENTIALS { + unsigned short cbHeaderLength; // the length of the header + unsigned short cbStructureLength; // pay load length including the header + SEC_WINNT_AUTH_DATA AuthData; +} SEC_WINNT_AUTH_PACKED_CREDENTIALS, *PSEC_WINNT_AUTH_PACKED_CREDENTIALS; + +// {28BFC32F-10F6-4738-98D1-1AC061DF716A} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_PASSWORD = + { 0x28bfc32f, 0x10f6, 0x4738, { 0x98, 0xd1, 0x1a, 0xc0, 0x61, 0xdf, 0x71, 0x6a } }; + +// {235F69AD-73FB-4dbc-8203-0629E739339B} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_CERT = + { 0x235f69ad, 0x73fb, 0x4dbc, { 0x82, 0x3, 0x6, 0x29, 0xe7, 0x39, 0x33, 0x9b } }; + +// {7CB72412-1016-491A-8C87-4D2AA1B7DD3A} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_CREDMAN_CERT = + { 0x7cb72412, 0x1016, 0x491a, { 0x8c, 0x87, 0x4d, 0x2a, 0xa1, 0xb7, 0xdd, 0x3a } }; + + +// {10A47879-5EBF-4B85-BD8D-C21BB4F49C8A} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_NGC = + { 0x10a47879, 0x5ebf, 0x4b85, { 0xbd, 0x8d, 0xc2, 0x1b, 0xb4, 0xf4, 0x9c, 0x8a } }; + +// {32E8F8D7-7871-4BCC-83C5-460F66C6135C} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_FIDO = +{ 0x32e8f8d7, 0x7871, 0x4bcc, { 0x83, 0xc5, 0x46, 0xf, 0x66, 0xc6, 0x13, 0x5c } }; + +// {D587AAE8-F78F-4455-A112-C934BEEE7CE1} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_KEYTAB = +{ 0xd587aae8, 0xf78f, 0x4455, { 0xa1, 0x12, 0xc9, 0x34, 0xbe, 0xee, 0x7c, 0xe1 } }; + +// {12E52E0F-6F9B-4F83-9020-9DE42B226267} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_DELEGATION_TOKEN = +{ 0x12e52e0f, 0x6f9b, 0x4f83, { 0x90, 0x20, 0x9d, 0xe4, 0x2b, 0x22, 0x62, 0x67 } }; + +typedef struct _SEC_WINNT_AUTH_DATA_PASSWORD { + SEC_WINNT_AUTH_BYTE_VECTOR UnicodePassword; +} SEC_WINNT_AUTH_DATA_PASSWORD, PSEC_WINNT_AUTH_DATA_PASSWORD; + +// +// smartcard cred data +// +// {68FD9879-079C-4dfe-8281-578AADC1C100} + +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_CSP_DATA = + { 0x68fd9879, 0x79c, 0x4dfe, { 0x82, 0x81, 0x57, 0x8a, 0xad, 0xc1, 0xc1, 0x0 } }; + +// {B86C4FF3-49D7-4DC4-B560-B1163685B236} +EXTERN_C __declspec(selectany) const GUID SEC_WINNT_AUTH_DATA_TYPE_SMARTCARD_CONTEXTS = + { 0xb86c4ff3, 0x49d7, 0x4dc4, { 0xb5, 0x60, 0xb1, 0x16, 0x36, 0x85, 0xb2, 0x36 } }; + +typedef struct _SEC_WINNT_AUTH_CERTIFICATE_DATA { + unsigned short cbHeaderLength; + unsigned short cbStructureLength; + SEC_WINNT_AUTH_BYTE_VECTOR Certificate; +} SEC_WINNT_AUTH_CERTIFICATE_DATA, *PSEC_WINNT_AUTH_CERTIFICATE_DATA; + +typedef struct _SEC_WINNT_AUTH_NGC_DATA { + LUID LogonId; + unsigned long Flags; + SEC_WINNT_AUTH_BYTE_VECTOR CspInfo; + SEC_WINNT_AUTH_BYTE_VECTOR UserIdKeyAuthTicket; + SEC_WINNT_AUTH_BYTE_VECTOR DecryptionKeyName; + SEC_WINNT_AUTH_BYTE_VECTOR DecryptionKeyAuthTicket; +} SEC_WINNT_AUTH_NGC_DATA, *PSEC_WINNT_AUTH_NGC_DATA; + +#define NGC_DATA_FLAG_KERB_CERTIFICATE_LOGON_FLAG_CHECK_DUPLICATES (0x1) //corresponds to KERB_CERTIFICATE_LOGON_FLAG_CHECK_DUPLICATES +#define NGC_DATA_FLAG_KERB_CERTIFICATE_LOGON_FLAG_USE_CERTIFICATE_INFO (0x2) //corresponds to KERB_CERTIFICATE_LOGON_FLAG_USE_CERTIFICATE_INFO +#define NGC_DATA_FLAG_IS_SMARTCARD_DATA (0x4) +#define NGC_DATA_FLAG_IS_CLOUD_TRUST_CRED (0x8) // credential should be treated as "cloud trust" - use Cloud TGTs instead of on-prem PKINIT + +typedef struct _SEC_WINNT_AUTH_DATA_TYPE_SMARTCARD_CONTEXTS_DATA +{ + PVOID pcc; + PVOID hProv; + LPWSTR pwszECDHKeyName; // only optionally set for ECDSA smartcards +} SEC_WINNT_AUTH_DATA_TYPE_SMARTCARD_CONTEXTS_DATA, *PSEC_WINNT_AUTH_DATA_TYPE_SMARTCARD_CONTEXTS_DATA; + +// FIDO cred data +typedef struct _SEC_WINNT_AUTH_FIDO_DATA { + unsigned short cbHeaderLength; + unsigned short cbStructureLength; + SEC_WINNT_AUTH_BYTE_VECTOR Secret; // offsets are from the beginning of this structure + SEC_WINNT_AUTH_BYTE_VECTOR NewSecret; + SEC_WINNT_AUTH_BYTE_VECTOR EncryptedNewSecret; // For storage by cloud AP + SEC_WINNT_AUTH_BYTE_VECTOR NetworkLogonBuffer; // Opaque data, understood by plugin, may contain signed Nonce and other data to perform a network logon + ULONG64 ulSignatureCount; // signature count to be stored in public cached info, required for CredProv +} SEC_WINNT_AUTH_FIDO_DATA, *PSEC_WINNT_AUTH_FIDO_DATA; + +typedef struct _SEC_WINNT_CREDUI_CONTEXT_VECTOR +{ + ULONG CredUIContextArrayOffset; // offset starts at the beginning of + // this structure, and each element is a SEC_WINNT_AUTH_BYTE_VECTOR that + // describes the flat CredUI context returned by SpGetCredUIContext() + USHORT CredUIContextCount; +} SEC_WINNT_CREDUI_CONTEXT_VECTOR, *PSEC_WINNT_CREDUI_CONTEXT_VECTOR; + +typedef struct _SEC_WINNT_AUTH_SHORT_VECTOR +{ + ULONG ShortArrayOffset; // each element is a short + USHORT ShortArrayCount; // number of characters +} SEC_WINNT_AUTH_SHORT_VECTOR, *PSEC_WINNT_AUTH_SHORT_VECTOR; + +// free the returned memory using SspiLocalFree + +SECURITY_STATUS +SEC_ENTRY +SspiGetCredUIContext( + _In_ HANDLE ContextHandle, + _In_ GUID* CredType, + _In_opt_ LUID* LogonId, // use this LogonId, the caller must be localsystem to supply a logon id + _Outptr_ PSEC_WINNT_CREDUI_CONTEXT_VECTOR* CredUIContexts, + _Out_opt_ HANDLE* TokenHandle + ); + +SECURITY_STATUS +SEC_ENTRY +SspiUpdateCredentials( + _In_ HANDLE ContextHandle, + _In_ GUID* CredType, + _In_ ULONG FlatCredUIContextLength, + _In_reads_bytes_(FlatCredUIContextLength) PUCHAR FlatCredUIContext + ); + +typedef struct _CREDUIWIN_MARSHALED_CONTEXT +{ + GUID StructureType; + USHORT cbHeaderLength; + LUID LogonId; // user's logon id + GUID MarshaledDataType; + ULONG MarshaledDataOffset; + USHORT MarshaledDataLength; +} CREDUIWIN_MARSHALED_CONTEXT, *PCREDUIWIN_MARSHALED_CONTEXT; + +typedef struct _SEC_WINNT_CREDUI_CONTEXT +{ + USHORT cbHeaderLength; + HANDLE CredUIContextHandle; // the handle to call SspiGetCredUIContext() +#ifdef _CREDUI_INFO_DEFINED + PCREDUI_INFOW UIInfo; // input from SspiPromptForCredentials() +#else + PVOID UIInfo; +#endif // _CREDUI_INFO_DEFINED + ULONG dwAuthError; // the authentication error + PSEC_WINNT_AUTH_IDENTITY_OPAQUE pInputAuthIdentity; + PUNICODE_STRING TargetName; +} SEC_WINNT_CREDUI_CONTEXT, *PSEC_WINNT_CREDUI_CONTEXT; + +// {3C3E93D9-D96B-49b5-94A7-458592088337} +EXTERN_C __declspec(selectany) const GUID CREDUIWIN_STRUCTURE_TYPE_SSPIPFC = +{ 0x3c3e93d9, 0xd96b, 0x49b5, { 0x94, 0xa7, 0x45, 0x85, 0x92, 0x8, 0x83, 0x37 } }; + +// {C2FFFE6F-503D-4c3d-A95E-BCE821213D44} +EXTERN_C __declspec(selectany) const GUID SSPIPFC_STRUCTURE_TYPE_CREDUI_CONTEXT = +{ 0xc2fffe6f, 0x503d, 0x4c3d, { 0xa9, 0x5e, 0xbc, 0xe8, 0x21, 0x21, 0x3d, 0x44 } }; + +typedef struct _SEC_WINNT_AUTH_PACKED_CREDENTIALS_EX { + unsigned short cbHeaderLength; + unsigned long Flags; // contains the Flags field in + // SEC_WINNT_AUTH_IDENTITY_EX + SEC_WINNT_AUTH_BYTE_VECTOR PackedCredentials; + SEC_WINNT_AUTH_SHORT_VECTOR PackageList; +} SEC_WINNT_AUTH_PACKED_CREDENTIALS_EX, *PSEC_WINNT_AUTH_PACKED_CREDENTIALS_EX; + +// +// free the returned memory using SspiLocalFree +// + +SECURITY_STATUS +SEC_ENTRY +SspiUnmarshalCredUIContext( + _In_reads_bytes_(MarshaledCredUIContextLength) PUCHAR MarshaledCredUIContext, + _In_ ULONG MarshaledCredUIContextLength, + _Outptr_ PSEC_WINNT_CREDUI_CONTEXT* CredUIContext + ); + +#endif // _SEC_WINNT_AUTH_TYPES + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +SECURITY_STATUS +SEC_ENTRY +SspiPrepareForCredRead( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity, + _In_ PCWSTR pszTargetName, + _Out_ PULONG pCredmanCredentialType, + _Outptr_ PCWSTR* ppszCredmanTargetName + ); + +SECURITY_STATUS +SEC_ENTRY +SspiPrepareForCredWrite( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity, + _In_opt_ PCWSTR pszTargetName, // supply NULL for username-target credentials + _Out_ PULONG pCredmanCredentialType, + _Outptr_ PCWSTR* ppszCredmanTargetName, + _Outptr_ PCWSTR* ppszCredmanUserName, + _Outptr_result_bytebuffer_(*pCredentialBlobSize) PUCHAR *ppCredentialBlob, + _Out_ PULONG pCredentialBlobSize + ); + + +// +// Input flags for SspiEncryptAuthIdentityEx and +// SspiDecryptAuthIdentityEx functions +// + +#define SEC_WINNT_AUTH_IDENTITY_ENCRYPT_SAME_LOGON 0x1 +#define SEC_WINNT_AUTH_IDENTITY_ENCRYPT_SAME_PROCESS 0x2 +#define SEC_WINNT_AUTH_IDENTITY_ENCRYPT_FOR_SYSTEM 0x4 + +SECURITY_STATUS +SEC_ENTRY +SspiEncryptAuthIdentity( + _Inout_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData + ); + +SECURITY_STATUS +SEC_ENTRY +SspiEncryptAuthIdentityEx( + _In_ ULONG Options, + _Inout_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData + ); + +SECURITY_STATUS +SEC_ENTRY +SspiDecryptAuthIdentity( + _Inout_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE EncryptedAuthData + ); + +SECURITY_STATUS +SEC_ENTRY +SspiDecryptAuthIdentityEx( + _In_ ULONG Options, + _Inout_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE EncryptedAuthData + ); + +BOOLEAN +SEC_ENTRY +SspiIsAuthIdentityEncrypted( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE EncryptedAuthData + ); + +// begin_ntifs + +#if (NTDDI_VERSION >= NTDDI_WIN7) +// +// Convert the _OPAQUE structure passed in to the +// 3 tuple . +// +// Note: The 'strings' returned need not necessarily be +// in user recognisable form. The purpose of this API +// is to 'flatten' the _OPAQUE structure into the 3 tuple. +// User recognisable can always be +// obtained by passing NULL to the pszPackedCredentialsString +// parameter. +// +// zero out the pszPackedCredentialsString then +// free the returned memory using SspiLocalFree() +// + +SECURITY_STATUS +SEC_ENTRY +SspiEncodeAuthIdentityAsStrings( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE pAuthIdentity, + _Outptr_result_maybenull_ PCWSTR* ppszUserName, + _Outptr_result_maybenull_ PCWSTR* ppszDomainName, + _Outptr_opt_result_maybenull_ PCWSTR* ppszPackedCredentialsString + ); + +SECURITY_STATUS +SEC_ENTRY +SspiValidateAuthIdentity( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData + ); + +// +// free the returned memory using SspiFreeAuthIdentity() +// + +SECURITY_STATUS +SEC_ENTRY +SspiCopyAuthIdentity( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData, + _Outptr_ _When_(return != 0, __drv_allocatesMem(Mem)) PSEC_WINNT_AUTH_IDENTITY_OPAQUE* AuthDataCopy + ); + +// +// use only for the memory returned by SspiCopyAuthIdentity(). +// Internally calls SspiZeroAuthIdentity(). +// + +VOID +SEC_ENTRY +SspiFreeAuthIdentity( + _In_opt_ __drv_freesMem(Mem) PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData + ); + +VOID +SEC_ENTRY +SspiZeroAuthIdentity( + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthData + ); + +VOID +SEC_ENTRY +SspiLocalFree( + _In_opt_ PVOID DataBuffer + ); + +// +// call SspiFreeAuthIdentity to free the returned AuthIdentity +// which zeroes out the credentials blob before freeing it +// + +SECURITY_STATUS +SEC_ENTRY +SspiEncodeStringsAsAuthIdentity( + _In_opt_ PCWSTR pszUserName, + _In_opt_ PCWSTR pszDomainName, + _In_opt_ PCWSTR pszPackedCredentialsString, + _Outptr_ _When_(return != 0, __drv_allocatesMem(Mem)) PSEC_WINNT_AUTH_IDENTITY_OPAQUE* ppAuthIdentity + ); + +SECURITY_STATUS +SEC_ENTRY +SspiCompareAuthIdentities( + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity1, + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity2, + _Out_opt_ PBOOLEAN SameSuppliedUser, + _Out_opt_ PBOOLEAN SameSuppliedIdentity + ); + +// +// zero out the returned AuthIdentityByteArray then +// free the returned memory using SspiLocalFree() +// + +SECURITY_STATUS +SEC_ENTRY +SspiMarshalAuthIdentity( + _In_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity, + _Out_ unsigned long* AuthIdentityLength, + _Outptr_result_bytebuffer_(*AuthIdentityLength) char** AuthIdentityByteArray + ); + +// +// free the returned auth identity using SspiFreeAuthIdentity() +// + +SECURITY_STATUS +SEC_ENTRY +SspiUnmarshalAuthIdentity( + _In_ unsigned long AuthIdentityLength, + _In_reads_bytes_(AuthIdentityLength) char* AuthIdentityByteArray, + _Outptr_ _When_(return != 0, __drv_allocatesMem(Mem)) PSEC_WINNT_AUTH_IDENTITY_OPAQUE* ppAuthIdentity + ); + +#endif // NTDDI_VERSION + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +BOOLEAN +SEC_ENTRY +SspiIsPromptingNeeded( + _In_ unsigned long ErrorOrNtStatus + ); + +#endif // NTDDI_VERSION + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#if (NTDDI_VERSION >= NTDDI_WIN7) + +SECURITY_STATUS +SEC_ENTRY +SspiGetTargetHostName( + _In_ PCWSTR pszTargetName, + _Outptr_ PWSTR* pszHostName + ); + +SECURITY_STATUS +SEC_ENTRY +SspiExcludePackage( + _In_opt_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE AuthIdentity, + _In_ PCWSTR pszPackageName, + _Outptr_ PSEC_WINNT_AUTH_IDENTITY_OPAQUE* ppNewAuthIdentity + ); + +#endif // NTDDI_VERSION + +// +// Common types used by negotiable security packages +// +// These are defined after W2K +// + +#define SEC_WINNT_AUTH_IDENTITY_MARSHALLED 0x4 // all data is in one buffer +#define SEC_WINNT_AUTH_IDENTITY_ONLY 0x8 // these credentials are for identity only - no PAC needed + +// end_ntifs + +// Set the requested flags in the channel bindings. pBindings->Bindings may change if the structure gets +// larger, but the caller's obligation to call FreeContextBuffer is unchanged. +SECURITY_STATUS +SEC_ENTRY +SspiSetChannelBindingFlags( + _Inout_ SecPkgContext_Bindings* pBindings, + unsigned long flags + ); + +// +// Routines for manipulating packages +// + +typedef struct _SECURITY_PACKAGE_OPTIONS { + unsigned long Size; + unsigned long Type; + unsigned long Flags; + unsigned long SignatureSize; + void * Signature; +} SECURITY_PACKAGE_OPTIONS, * PSECURITY_PACKAGE_OPTIONS; + +#define SECPKG_OPTIONS_TYPE_UNKNOWN 0 +#define SECPKG_OPTIONS_TYPE_LSA 1 +#define SECPKG_OPTIONS_TYPE_SSPI 2 + +#define SECPKG_OPTIONS_PERMANENT 0x00000001 + +SECURITY_STATUS +SEC_ENTRY +AddSecurityPackageA( + _In_ LPSTR pszPackageName, + _In_opt_ PSECURITY_PACKAGE_OPTIONS pOptions + ); + +SECURITY_STATUS +SEC_ENTRY +AddSecurityPackageW( + _In_ LPWSTR pszPackageName, + _In_opt_ PSECURITY_PACKAGE_OPTIONS pOptions + ); + +#ifdef UNICODE +#define AddSecurityPackage AddSecurityPackageW +#else +#define AddSecurityPackage AddSecurityPackageA +#endif + +SECURITY_STATUS +SEC_ENTRY +DeleteSecurityPackageA( + _In_ LPSTR pszPackageName + ); + +SECURITY_STATUS +SEC_ENTRY +DeleteSecurityPackageW( + _In_ LPWSTR pszPackageName + ); + +#ifdef UNICODE +#define DeleteSecurityPackage DeleteSecurityPackageW +#else +#define DeleteSecurityPackage DeleteSecurityPackageA +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#ifdef __cplusplus +} // extern "C" +#endif + +// begin_ntifs +#endif // __SSPI_H__ +// end_ntifs diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/stralign.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/stralign.h new file mode 100644 index 0000000000000000000000000000000000000000..60086d1cf298446e21c10e864974ad6addf98723 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/stralign.h @@ -0,0 +1,699 @@ +#include + +/*++ + +Copyright (c) 2000 Microsoft Corporation + +Module Name: + + stralign.h + +Abstract: + + This module contains macros and prototypes to expose the unaligned wide + character interfaces. + + Public interfaces created or declared here include: + + ua_CharUpper() + ua_CharUpperW() + ua_lstrcmp() + ua_lstrcmpW() + ua_lstrcmpi() + ua_lstrcmpiW() + ua_lstrlen() + ua_lstrlenW() + ua_tcscpy() + ua_tcscpy_s() + ua_wcschr() + ua_wcscpy() + ua_wcscpy_s() + ua_wcsicmp() + ua_wcslen() + ua_wcsrchr() + + STRUC_ALIGNED_STACK_COPY() + TSTR_ALIGNED() + TSTR_ALIGNED_STACK_COPY() + WSTR_ALIGNED() + WSTR_ALIGNED_STACK_COPY() + +Author: + +--*/ + +#if !defined(__STRALIGN_H_) && !defined(MIDL_PASS) +#define __STRALIGN_H_ + +#ifndef _STRALIGN_USE_SECURE_CRT +#if defined(__GOT_SECURE_LIB__) && __GOT_SECURE_LIB__ >= 200402L +#define _STRALIGN_USE_SECURE_CRT 1 +#else +#define _STRALIGN_USE_SECURE_CRT 0 +#endif +#endif + +#if !defined(_WINDOWS_INSECURE_DEPRECATE) +#if defined(_WINDOWS_SECURE_NO_DEPRECATE) || !_STRALIGN_USE_SECURE_CRT +#define _WINDOWS_INSECURE_DEPRECATE +#else +#define _WINDOWS_INSECURE_DEPRECATE __declspec(deprecated) +#endif +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +// +// N.B. On AMD64 platforms the key word __unaligned is enabled, but has no +// effect and strings can be unaligned exactly as they are on the x86. +// Therefore, all AMD64 alignment macros are forced to produce values +// that make the subject arguments appear as it they are aligned. +// +// On ARM platforms, the operation is similar. +// + +#if defined(_AMD64_) || defined(_ARM_) || defined(_ARM64_) +#pragma warning(push) +#pragma warning(disable:4127) +#endif + +#if defined(_X86_) + +// +// Alignment of unicode strings is not necessary on X86. +// + +#define WSTR_ALIGNED(s) TRUE + +#define ua_CharUpperW CharUpperW +#define ua_lstrcmpiW lstrcmpiW +#define ua_lstrcmpW lstrcmpW +#define ua_lstrlenW lstrlenW +#define ua_wcschr wcschr +#define ua_wcsicmp wcsicmp +#define ua_wcslen wcslen +#define ua_wcsrchr wcsrchr +#if _STRALIGN_USE_SECURE_CRT +#define ua_wcscpy_s wcscpy_s +#endif + +__inline +PUWSTR +static +_WINDOWS_INSECURE_DEPRECATE +ua_wcscpy( + _Out_writes_(_Inexpressible_("Sufficient length")) PUWSTR Destination, + _In_ PCUWSTR Source + ) +{ +#pragma warning(push) +#pragma warning(disable:4995) +#pragma warning(disable:4996) +#ifdef _PREFAST_ +#pragma warning(disable:25025) // call to dangerous string function 'wcscpy' +#pragma warning(disable:28719) // This function (ua_wcscpy) is also tagged as insecure and deprecated +#endif // _PREFAST_ + return wcscpy(Destination, Source); +#pragma warning(pop) +} + +#else + +// +// The C runtime libraries expect aligned string pointers. Following are the +// prototypes for our own, slower worker functions that accept unaligned +// UNICODE strings. +// +// Macro to determine whether a pointer to a unicode character is naturally +// aligned. +// + +#if defined(_AMD64_) || defined(_ARM_) || defined(_ARM64_) + +#define WSTR_ALIGNED(s) TRUE + +#else + +#define WSTR_ALIGNED(s) (((DWORD_PTR)(s) & (sizeof(WCHAR)-1)) == 0) + +#endif + +// +// Platform-specific prototypes for worker functions exported from kernel32. +// Do not call these directly, they do not exist on all platforms. Instead +// use the equivalent ua_xxx() routines. +// + +LPUWSTR +WINAPI +uaw_CharUpperW( + _Inout_ LPUWSTR String + ); + +int +APIENTRY +uaw_lstrcmpW( + _In_ PCUWSTR String1, + _In_ PCUWSTR String2 + ); + +int +APIENTRY +uaw_lstrcmpiW( + _In_ PCUWSTR String1, + _In_ PCUWSTR String2 + ); + +int +WINAPI +uaw_lstrlenW( + _In_ LPCUWSTR String + ); + +PUWSTR +__cdecl +uaw_wcschr( + _In_ PCUWSTR String, + _In_ WCHAR Character + ); + +PUWSTR +__cdecl +uaw_wcscpy( + _Out_writes_(_Inexpressible_("Sufficient length")) PUWSTR Destination, + _In_ PCUWSTR Source + ); + +int +__cdecl +uaw_wcsicmp( + _In_ PCUWSTR String1, + _In_ PCUWSTR String2 + ); + +size_t +__cdecl +uaw_wcslen( + _In_ PCUWSTR String + ); + +PUWSTR +__cdecl +uaw_wcsrchr( + _In_ PCUWSTR String, + _In_ WCHAR Character + ); + +// +// Following are the inline wrappers that determine the optimal worker function +// to call based on the alignment of the UNICODE string arguments. Their +// behavior is otherwise identical to the corresponding standard run-time +// routiunes. +// + +#if defined(CharUpper) +__inline +LPUWSTR +static +ua_CharUpperW( + _Inout_ LPUWSTR String + ) +{ + if (WSTR_ALIGNED(String)) { + return CharUpperW( (PWSTR)String ); + } else { + return uaw_CharUpperW( String ); + } +} +#endif + +#if defined(lstrcmp) +__inline +int +static +ua_lstrcmpW( + _In_ LPCUWSTR String1, + _In_ LPCUWSTR String2 + ) +{ + if (WSTR_ALIGNED(String1) && WSTR_ALIGNED(String2)) { + return lstrcmpW( (LPCWSTR)String1, (LPCWSTR)String2); + } else { + return uaw_lstrcmpW( String1, String2 ); + } +} +#endif + +#if defined(lstrcmpi) +__inline +int +static +ua_lstrcmpiW( + _In_ LPCUWSTR String1, + _In_ LPCUWSTR String2 + ) +{ + if (WSTR_ALIGNED(String1) && WSTR_ALIGNED(String2)) { + return lstrcmpiW( (LPCWSTR)String1, (LPCWSTR)String2 ); + } else { + return uaw_lstrcmpiW( String1, String2 ); + } +} +#endif + +#if defined(lstrlen) +__inline +int +static +ua_lstrlenW( + _In_ LPCUWSTR String + ) +{ + if (WSTR_ALIGNED(String)) { +#pragma warning(suppress: 28750) // use of deprecated API + return lstrlenW( (PCWSTR)String ); + } else { + return uaw_lstrlenW( String ); + } +} +#endif + +// _WSTRING_DEFINED is no longer defined in newer versions of STL. +// Check to see if string.h or wchar.h have been included instead. +#if defined(_INC_STRING) || defined(_INC_WCHAR) + +// +// Certain run-time string functions are overloaded in C++, to avoid +// inadvertent stripping of the const attribute. +// +// The functions of interest here include: wcschr and wcsrchr. +// +// There are three flavors of these functions: +// +// Flavor Returns Parameter +// +// 1 PWSTR PCWSTR +// 2 PCWSTR PCWSTR +// 3 PWSTR PWSTR +// +// string.h declares flavor 1 whether for C or C++. This is the non-ANSI, +// backward compatible mode. +// +// wchar.h declares flavor 1 if C, or flavors 2 and 3 if C++. This is the +// ANSI method. +// +// Our corresponding functions need to match what was declared. The way +// we can tell is by looking at _WConst_return... if it is defined then +// we want to match the prototypes in wchar.h, otherwise we'll match +// the prototypes in string.h. +// + +#if defined(_WConst_return) +typedef _WConst_return WCHAR UNALIGNED *PUWSTR_C; +#else +typedef WCHAR UNALIGNED *PUWSTR_C; +#endif + +// +// Here is flavor 1 or 2 +// + +__inline +PUWSTR_C +static +ua_wcschr( + _In_ PCUWSTR String, + _In_ WCHAR Character + ) +{ + if (WSTR_ALIGNED(String)) { + return wcschr((PCWSTR)String, Character); + } else { + return (PUWSTR_C)uaw_wcschr(String, Character); + } +} + +__inline +PUWSTR_C +static +ua_wcsrchr( + _In_ PCUWSTR String, + _In_ WCHAR Character + ) +{ + if (WSTR_ALIGNED(String)) { + return wcsrchr((PCWSTR)String, Character); + } else { + return (PUWSTR_C)uaw_wcsrchr(String, Character); + } +} + +#if defined(__cplusplus) && defined(_WConst_Return) + +// +// Here is flavor 3 +// + +__inline +PUWSTR +static +_WINDOWS_INSECURE_DEPRECATE +ua_wcschr( + _In_ PUWSTR String, + _In_ WCHAR Character + ) +{ + if (WSTR_ALIGNED(String)) { +#pragma warning(push) +#pragma warning(disable:4995) +#pragma warning(disable:4996) +#ifdef _PREFAST_ +#pragma warning(disable:25025) // call to dangerous string function 'wcscpy' +#endif + return wcscpy( (PWSTR)Destination, (PCWSTR)Source ); +#pragma warning(pop) + } else { + return uaw_wcscpy( Destination, Source ); + } +} + +__inline +PUWSTR +static +ua_wcscpy_s( + _Out_writes_(DestinationSize) PUWSTR Destination, + _In_ size_t DestinationSize, + _In_ PCUWSTR Source + ) +{ + if (WSTR_ALIGNED(Source) && WSTR_ALIGNED(Destination)) { + return (wcscpy_s( (PWSTR)Destination, DestinationSize, (PCWSTR)Source ) == 0 ? Destination : NULL); + } else { + /* TODO : Need to reference uaw_wcscpy_s */ + return uaw_wcscpy((PCUWSTR)String, Character); + } +} + +__inline +PUWSTR +static +ua_wcsrchr( + _In_ PUWSTR String, + _In_ WCHAR Character + ) +{ + if (WSTR_ALIGNED(String)) { + return wcsrchr(String, Character); + } else { + return uaw_wcsrchr((PCUWSTR)String, Character); + } +} + +#endif // __cplusplus && _WConst_Return + +__inline +PUWSTR +static +_WINDOWS_INSECURE_DEPRECATE +ua_wcscpy( + _Out_writes_(_Inexpressible_("Sufficient length")) PUWSTR Destination, + _In_ PCUWSTR Source + ) +{ + if (WSTR_ALIGNED(Source) && WSTR_ALIGNED(Destination)) { +#pragma warning(push) +#pragma warning(disable:4995) +#pragma warning(disable:4996) +#ifdef _PREFAST_ +#pragma warning(disable:25025) // call to dangerous string function 'wcscpy' +#pragma warning(disable:28719) // This function (ua_wcscpy) is also tagged as insecure and deprecated +#endif // _PREFAST_ + return wcscpy( (PWSTR)Destination, (PCWSTR)Source ); +#pragma warning(pop) + } else { + return uaw_wcscpy( Destination, Source ); + } +} + + +#if _STRALIGN_USE_SECURE_CRT +__inline +PUWSTR +static +ua_wcscpy_s( + _Out_writes_(DestinationSize) PUWSTR Destination, + _In_ size_t DestinationSize, + _In_ PCUWSTR Source + ) +{ + if (WSTR_ALIGNED(Source) && WSTR_ALIGNED(Destination)) { + return (wcscpy_s( (PWSTR)Destination, DestinationSize, (PCWSTR)Source ) == 0 ? Destination : NULL); + } else { + /* TODO: Need to reference uaw_wcscpy_s */ + return uaw_wcscpy( Destination, Source ); + } +} +#endif + +__inline +size_t +static +ua_wcslen( + _In_ PCUWSTR String + ) +{ + if (WSTR_ALIGNED(String)) { + return wcslen( (PCWSTR)String ); + } else { + return uaw_wcslen( String ); + } +} + +#endif // defined(_INC_STRING) || defined(_INC_WCHAR) + +__inline +int +static +ua_wcsicmp( + _In_ PCUWSTR String1, + _In_ PCUWSTR String2 + ) +{ + if (WSTR_ALIGNED(String1) && WSTR_ALIGNED(String2)) { + return _wcsicmp( (LPCWSTR)String1, (LPCWSTR)String2 ); + } else { + return uaw_wcsicmp( String1, String2 ); + } +} + +#endif // _X86_ + +//++ +// +// VOID +// WSTR_ALIGNED_STACK_COPY ( +// _Out_ PCWSTR *TargetString, +// _In_opt_ PCUWSTR SourceString +// ) +// +// VOID +// TSTR_ALIGNED_STACK_COPY ( +// _Out_ PCTSTR *TargetString, +// _In_opt_ PCUTSTR SourceString +// ) +// +// Routine Description: +// +// These macros set TargetString to an aligned pointer to the string +// represented by SourceString. If necessary, an aligned copy of +// SourceString is copied onto the stack. +// +// Arguments: +// +// TargetString - Supplies a pointer to a pointer to the resultant +// string. This may be the same as SourceString if +// that argument is aligned. +// +// SourceString - Supplies a pointer to the possibly unaligned UNICODE +// string. +// +// Return Value: +// +// None. +// +// Note: +// +// These macros may allocate memory on the stack via the CRT function +// _alloca(). This memory is "freed" when the calling function exits. +// As a result, do not use these macros inside of a loop that may execute +// a large number of times - instead, use a wrapper function, or use +// an explicit buffer like this: +// +// TCHAR AlignedStringBuffer[ MAX_FOOSTR_CHARS ]; +// PTSTR AlignedString; +// +// while (a < b) { +// ... +// if (TSTR_ALIGNED(s) { +// AlignedString = s; +// } else { +// AlignedString = (PTSTR)ua_tcscpy(AlignedStringBuffer,s); +// } +// SomeSystemFunction(AlignedString); +// ... +// } +// +// +//-- + +// +// __UA_WSTRSIZE returns the number of bytes required to store the +// supplied null-terminated UNICODE string. +// +// __UA_LOCALCOPY accepts a pointer to unaligned data and a size. It +// allocates an aligned buffer on the stack and copies the data into +// it, returning a pointer to the buffer. +// + +#if !defined(__UA_WCSLEN) +#define __UA_WCSLEN ua_wcslen +#endif + +#define __UA_WSTRSIZE(s) ((__UA_WCSLEN(s)+1)*sizeof(WCHAR)) +#define __UA_STACKCOPY(p,s) memcpy_s(_alloca(s),s,p,s) + +// +// Note that NULL is aligned. +// + +#if defined(_AMD64_) || defined(_ARM_) || defined(_ARM64_) || defined(_X86_) + +#define WSTR_ALIGNED_STACK_COPY(d,s) (*(d) = (PCWSTR)(s)) + +#else + +// +// Use of an inline function here is not possible, as the results of +// the _alloca() will not be preserved upon return from the function. +// + +#define WSTR_ALIGNED_STACK_COPY(d,s) \ + { \ + PCUWSTR __ua_src; \ + size_t __ua_size; \ + PWSTR __ua_dst; \ + \ + __ua_src = (s); \ + if (WSTR_ALIGNED(__ua_src)) { \ + __ua_dst = (PWSTR)__ua_src; \ + } else { \ + __ua_size = __UA_WSTRSIZE(__ua_src); \ + __ua_dst = (PWSTR)_alloca(__ua_size); \ + memcpy_s(__ua_dst,__ua_size,__ua_src,__ua_size); \ + } \ + *(d) = (PCWSTR)__ua_dst; \ + } + +#endif + +#define ASTR_ALIGNED_STACK_COPY(d,s) (*(d) = (PCSTR)(s)) + +//++ +// +// CONST * +// STRUC_ALIGNED_STACK_COPY ( +// _In_ , +// _In_opt_ PVOID Struc +// ) +// +// Routine Description: +// +// This macro returns an aligned pointer to Struc, creating a local +// copy on the stack if necessary. +// +// This should be used only for relatively small structures, and efforts +// should be made to align the structure properly in the first place. Use +// this macro only as a last resort. +// +// Arguments: +// +// - The type specifier of Struc +// +// Struc - Supplies a pointer to the structure in question. +// +// Return Value: +// +// Returns a const pointer to Struc if it is properly aligned, or a pointer +// to a stack-allocated copy of Struc if it is not. +// +//-- + +#if !defined(_AMD64_) && !defined(_ARM_) && !defined(_ARM64_) && !defined(_X86_) + +#define __UA_STRUC_ALIGNED(t,s) \ + (((DWORD_PTR)(s) & (TYPE_ALIGNMENT(t)-1)) == 0) + +#define STRUC_ALIGNED_STACK_COPY(t,s) \ + __UA_STRUC_ALIGNED(t,s) ? \ + ((t const *)(s)) : \ + ((t const *)__UA_STACKCOPY((s),sizeof(t))) + +#else + +#define STRUC_ALIGNED_STACK_COPY(t,s) ((CONST t *)(s)) + +#endif + +#if defined(UNICODE) + +#define TSTR_ALIGNED_STACK_COPY(d,s) WSTR_ALIGNED_STACK_COPY(d,s) +#define TSTR_ALIGNED(x) WSTR_ALIGNED(x) +#define ua_CharUpper ua_CharUpperW +#define ua_lstrcmp ua_lstrcmpW +#define ua_lstrcmpi ua_lstrcmpiW +#define ua_lstrlen ua_lstrlenW +#define ua_tcscpy ua_wcscpy +#if _STRALIGN_USE_SECURE_CRT +#define ua_tcscpy_s ua_wcscpy_s +#endif + +#else + +#define TSTR_ALIGNED_STACK_COPY(d,s) ASTR_ALIGNED_STACK_COPY(d,s) +#define TSTR_ALIGNED(x) TRUE +#define ua_CharUpper CharUpperA +#define ua_lstrcmp lstrcmpA +#define ua_lstrcmpi lstrcmpiA +#define ua_lstrlen lstrlenA +#define ua_tcscpy strcpy +#if _STRALIGN_USE_SECURE_CRT +#define ua_tcscpy_s strcpy_s +#endif + +#endif // UNICODE + +#if defined(_AMD64_) || defined(_ARM_) || defined(_ARM64_) +#pragma warning(pop) +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#ifdef __cplusplus +} +#endif + +#endif // __STRALIGN_H_ + + + + + + + + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/strsafe.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/strsafe.h new file mode 100644 index 0000000000000000000000000000000000000000..658a5d7efaeab1b2d1891c910100f84fd66d8234 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/strsafe.h @@ -0,0 +1,10608 @@ +/****************************************************************** +* * +* strsafe.h -- This module defines safer C library string * +* routine replacements. These are meant to make C * +* a bit more safe in reference to security and * +* robustness * +* * +* Copyright (c) Microsoft Corp. All rights reserved. * +* * +******************************************************************/ +#ifndef _STRSAFE_H_INCLUDED_ +#define _STRSAFE_H_INCLUDED_ +#if (_MSC_VER > 1000) +#pragma once +#endif + + +#include // for _vsnprintf, _vsnwprintf, getc, getwc +#include // for memset +#include // for va_start, etc. +#include // for _In_, etc. +#include // for WINAPI_FAMILY_PARTITION() + +#if !defined(_W64) +#if !defined(__midl) && (defined(_X86_) || defined(_M_IX86) || defined(_ARM_) || defined(_M_ARM)) && (_MSC_VER >= 1300) +#define _W64 __w64 +#else +#define _W64 +#endif +#endif + +#if defined(_M_MRX000) || defined(_M_ALPHA) || defined(_M_PPC) || defined(_M_IA64) || defined(_M_AMD64) || defined(_M_ARM) || defined(_M_ARM64) +#define ALIGNMENT_MACHINE +#define UNALIGNED __unaligned +#if defined(_WIN64) +#define UNALIGNED64 __unaligned +#else +#define UNALIGNED64 +#endif +#else +#undef ALIGNMENT_MACHINE +#define UNALIGNED +#define UNALIGNED64 +#endif + +// typedefs +#ifdef _WIN64 +typedef unsigned __int64 size_t; +#else +typedef _W64 unsigned int size_t; +#endif + +#ifndef _HRESULT_DEFINED +#define _HRESULT_DEFINED +typedef _Return_type_success_(return >= 0) long HRESULT; +#endif + +typedef unsigned long DWORD; + + +// macros +#define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0) +#define FAILED(hr) (((HRESULT)(hr)) < 0) + +#define S_OK ((HRESULT)0L) + +#ifndef SORTPP_PASS +// compiletime asserts (failure results in error C2118: negative subscript) +#define C_ASSERT(e) typedef char __C_ASSERT__[(e)?1:-1] +#else +#define C_ASSERT(e) +#endif + +#ifdef __cplusplus +#define EXTERN_C extern "C" +#else +#define EXTERN_C extern +#endif + +// use the new secure crt functions if available +#ifndef STRSAFE_USE_SECURE_CRT +#if defined(__GOT_SECURE_LIB__) && (__GOT_SECURE_LIB__ >= 200402L) +#define STRSAFE_USE_SECURE_CRT 0 +#else +#define STRSAFE_USE_SECURE_CRT 0 +#endif +#endif // !STRSAFE_USE_SECURE_CRT + +#ifdef _M_CEE_PURE +#define STRSAFEAPI __inline HRESULT __clrcall +#else +#define STRSAFEAPI __inline HRESULT __stdcall +#endif + +#if defined(STRSAFE_LIB_IMPL) || defined(STRSAFE_LIB) +#define STRSAFEWORKERAPI EXTERN_C HRESULT __stdcall +#else +#define STRSAFEWORKERAPI static STRSAFEAPI +#endif + +#ifdef STRSAFE_LOCALE_FUNCTIONS +#if defined(STRSAFE_LOCALE_LIB_IMPL) || defined(STRSAFE_LIB) +#define STRSAFELOCALEWORKERAPI EXTERN_C HRESULT __stdcall +#else +#define STRSAFELOCALEWORKERAPI static STRSAFEAPI +#endif +#endif // STRSAFE_LOCALE_FUNCTIONS + +#if defined(STRSAFE_LIB) +#pragma comment(lib, "strsafe.lib") +#endif + +#pragma warning(push) +#pragma warning(disable: 28210) // Because not all PREFast versions like _Always_ equally. + +// The user can request no "Cb" or no "Cch" fuctions, but not both +#if defined(STRSAFE_NO_CB_FUNCTIONS) && defined(STRSAFE_NO_CCH_FUNCTIONS) +#error cannot specify both STRSAFE_NO_CB_FUNCTIONS and STRSAFE_NO_CCH_FUNCTIONS !! +#endif + +// The user may override STRSAFE_MAX_CCH, but it must always be less than INT_MAX +#ifndef STRSAFE_MAX_CCH +#define STRSAFE_MAX_CCH 2147483647 // max buffer size, in characters, that we support (same as INT_MAX) +#endif +C_ASSERT(STRSAFE_MAX_CCH <= 2147483647); +C_ASSERT(STRSAFE_MAX_CCH > 1); + +#define STRSAFE_MAX_LENGTH (STRSAFE_MAX_CCH - 1) // max buffer length, in characters, that we support + + +// Flags for controling the Ex functions +// +// STRSAFE_FILL_BYTE(0xFF) 0x000000FF // bottom byte specifies fill pattern +#define STRSAFE_IGNORE_NULLS 0x00000100 // treat null string pointers as TEXT("") -- don't fault on NULL buffers +#define STRSAFE_FILL_BEHIND_NULL 0x00000200 // on success, fill in extra space behind the null terminator with fill pattern +#define STRSAFE_FILL_ON_FAILURE 0x00000400 // on failure, overwrite pszDest with fill pattern and null terminate it +#define STRSAFE_NULL_ON_FAILURE 0x00000800 // on failure, set *pszDest = TEXT('\0') +#define STRSAFE_NO_TRUNCATION 0x00001000 // instead of returning a truncated result, copy/append nothing to pszDest and null terminate it + +#define STRSAFE_VALID_FLAGS (0x000000FF | STRSAFE_IGNORE_NULLS | STRSAFE_FILL_BEHIND_NULL | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE | STRSAFE_NO_TRUNCATION) + +// helper macro to set the fill character and specify buffer filling +#define STRSAFE_FILL_BYTE(x) ((DWORD)((x & 0x000000FF) | STRSAFE_FILL_BEHIND_NULL)) +#define STRSAFE_FAILURE_BYTE(x) ((DWORD)((x & 0x000000FF) | STRSAFE_FILL_ON_FAILURE)) + +#define STRSAFE_GET_FILL_PATTERN(dwFlags) ((int)(dwFlags & 0x000000FF)) + + +// error return codes +#define STRSAFE_E_INSUFFICIENT_BUFFER ((HRESULT)0x8007007AL) // 0x7A = 122L = ERROR_INSUFFICIENT_BUFFER +#define STRSAFE_E_INVALID_PARAMETER ((HRESULT)0x80070057L) // 0x57 = 87L = ERROR_INVALID_PARAMETER +#define STRSAFE_E_END_OF_FILE ((HRESULT)0x80070026L) // 0x26 = 38L = ERROR_HANDLE_EOF + +// Deprecated, use the non STRSAFE_ prefixed types instead (e.g. LPSTR or PSTR) as they are the same as these. +typedef _Null_terminated_ char* STRSAFE_LPSTR; +typedef _Null_terminated_ const char* STRSAFE_LPCSTR; +typedef _Null_terminated_ wchar_t* STRSAFE_LPWSTR; +typedef _Null_terminated_ const wchar_t* STRSAFE_LPCWSTR; +typedef _Null_terminated_ const wchar_t UNALIGNED* STRSAFE_LPCUWSTR; + +// Deprecated, use the base types instead. +// Strings where the string is NOT guaranteed to be null terminated (does not have _Null_terminated_). +typedef const char* STRSAFE_PCNZCH; +typedef const wchar_t* STRSAFE_PCNZWCH; +typedef const wchar_t UNALIGNED* STRSAFE_PCUNZWCH; + + + +// prototypes for the worker functions + +STRSAFEWORKERAPI +StringLengthWorkerA( + _In_reads_or_z_(cchMax) STRSAFE_PCNZCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength); + + + +STRSAFEWORKERAPI +StringLengthWorkerW( + _In_reads_or_z_(cchMax) STRSAFE_PCNZWCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength); + +#ifdef ALIGNMENT_MACHINE +STRSAFEWORKERAPI +UnalignedStringLengthWorkerW( + _In_reads_or_z_(cchMax) STRSAFE_PCUNZWCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) size_t* pcchLength); +#endif // ALIGNMENT_MACHINE + + + +_When_(_Old_(*ppszSrc) != NULL, _Unchanged_(*ppszSrc)) +_When_(_Old_(*ppszSrc) == NULL, _At_(*ppszSrc, _Post_z_)) +STRSAFEWORKERAPI +StringExValidateSrcA( + _Inout_ _Deref_post_notnull_ STRSAFE_PCNZCH* ppszSrc, + _Inout_opt_ + _Deref_out_range_(<, cchMax) + _Deref_out_range_(<=, _Old_(*pcchToRead)) size_t* pcchToRead, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + + + +_When_(_Old_(*ppszSrc) != NULL, _Unchanged_(*ppszSrc)) +_When_(_Old_(*ppszSrc) == NULL, _At_(*ppszSrc, _Post_z_)) +STRSAFEWORKERAPI +StringExValidateSrcW( + _Inout_ _Deref_post_notnull_ STRSAFE_PCNZWCH* ppszSrc, + _Inout_opt_ + _Deref_out_range_(<, cchMax) + _Deref_out_range_(<=, _Old_(*pcchToRead)) size_t* pcchToRead, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + + + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) +STRSAFEWORKERAPI +StringValidateDestA( + _In_reads_opt_(cchDest) STRSAFE_PCNZCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax); + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) +STRSAFEWORKERAPI +StringValidateDestAndLengthA( + _In_reads_opt_(cchDest) STRSAFE_LPCSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, cchDest - 1) size_t* pcchDestLength, + _In_ const size_t cchMax); + + + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) +STRSAFEWORKERAPI +StringValidateDestW( + _In_reads_opt_(cchDest) STRSAFE_PCNZWCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax); + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) +STRSAFEWORKERAPI +StringValidateDestAndLengthW( + _In_reads_opt_(cchDest) STRSAFE_LPCWSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, cchDest - 1) size_t* pcchDestLength, + _In_ const size_t cchMax); + + + +STRSAFEWORKERAPI +StringExValidateDestA( + _In_reads_opt_(cchDest) STRSAFE_PCNZCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + +STRSAFEWORKERAPI +StringExValidateDestAndLengthA( + _In_reads_opt_(cchDest) STRSAFE_LPCSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, (cchDest>0?cchDest-1:0)) size_t* pcchDestLength, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + + + +STRSAFEWORKERAPI +StringExValidateDestW( + _In_reads_opt_(cchDest) STRSAFE_PCNZWCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + +STRSAFEWORKERAPI +StringExValidateDestAndLengthW( + _In_reads_opt_(cchDest) STRSAFE_LPCWSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, (cchDest>0?cchDest-1:0)) size_t* pcchDestLength, + _In_ const size_t cchMax, + _In_ DWORD dwFlags); + + + +STRSAFEWORKERAPI +StringCopyWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, (cchToCopy < cchDest) ? cchToCopy : (cchDest - 1))) size_t* pcchNewDestLength, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZCH pszSrc, + _In_ _In_range_(<, STRSAFE_MAX_CCH) size_t cchToCopy); + + + +STRSAFEWORKERAPI +StringCopyWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, (cchToCopy < cchDest) ? cchToCopy : (cchDest - 1))) size_t* pcchNewDestLength, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ _In_range_(<, STRSAFE_MAX_CCH) size_t cchToCopy); + + + +STRSAFEWORKERAPI +StringVPrintfWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList); + + + + +#ifdef STRSAFE_LOCALE_FUNCTIONS +STRSAFELOCALEWORKERAPI +StringVPrintf_lWorkerA( + _Out_writes_(cchDest) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Out_opt_ _Deref_out_range_(<=, cchDest - 1) size_t* pcchNewDestLength, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList); +#endif // STRSAFE_LOCALE_FUNCTIONS + + + + +STRSAFEWORKERAPI +StringVPrintfWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList); + + + + +#ifdef STRSAFE_LOCALE_FUNCTIONS +STRSAFELOCALEWORKERAPI +StringVPrintf_lWorkerW( + _Out_writes_(cchDest) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Out_opt_ _Deref_out_range_(<=, cchDest - 1) size_t* pcchNewDestLength, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList); +#endif // STRSAFE_LOCALE_FUNCTIONS + + +#ifndef STRSAFE_LIB_IMPL +// always run these functions inline always since they use stdin + + +STRSAFEAPI +StringGetsWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<, cchDest>0?cchDest:1)) size_t* pcchNewDestLength); + + + +STRSAFEAPI +StringGetsWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength); + + +#endif // !STRSAFE_LIB_IMPL + + + +STRSAFEWORKERAPI +StringExHandleFillBehindNullA( + _Inout_updates_bytes_(cbRemaining) STRSAFE_LPSTR pszDestEnd, + _In_ size_t cbRemaining, + _In_ DWORD dwFlags); + + + +STRSAFEWORKERAPI +StringExHandleFillBehindNullW( + _Inout_updates_bytes_(cbRemaining) STRSAFE_LPWSTR pszDestEnd, + _In_ size_t cbRemaining, + _In_ DWORD dwFlags); + + + +_Success_(1) // always succeeds, no exit tests needed + STRSAFEWORKERAPI + StringExHandleOtherFlagsA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(char)) size_t cbDest, + _In_ _In_range_(0, cbDest>sizeof(char)?(cbDest / sizeof(char)) - 1:0) size_t cchOriginalDestLength, + _Outptr_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_ _Deref_out_range_(0, cbDest / sizeof(char)) size_t* pcchRemaining, + _In_ DWORD dwFlags); + + + +_Success_(1) // always succeeds, no exit tests needed + STRSAFEWORKERAPI + StringExHandleOtherFlagsW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(wchar_t)) size_t cbDest, + _In_ _In_range_(0, cbDest>sizeof(wchar_t)?(cbDest / sizeof(wchar_t)) - 1:0) size_t cchOriginalDestLength, + _Outptr_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_ _Deref_out_range_(0, cbDest / sizeof(wchar_t)) size_t* pcchRemaining, + _In_ DWORD dwFlags); + + + +// To allow this to stand alone. +#define __WARNING_CYCLOMATIC_COMPLEXITY 28734 +#define __WARNING_USING_UNINIT_VAR 6001 +#define __WARNING_RETURN_UNINIT_VAR 6101 +#define __WARNING_DEREF_NULL_PTR 6011 +#define __WARNING_MISSING_ZERO_TERMINATION2 6054 +#define __WARNING_INVALID_PARAM_VALUE_1 6387 +#define __WARNING_UNSAFE_STRING_FUNCTION 25025 +#define __WARNING_INCORRECT_ANNOTATION 26007 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY 26015 +#define __WARNING_PRECONDITION_NULLTERMINATION_VIOLATION 26035 +#define __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION 26036 +#define __WARNING_HIGH_PRIORITY_OVERFLOW_POSTCONDITION 26045 +#define __WARNING_RANGE_POSTCONDITION_VIOLATION 26061 +#define __WARNING_POTENTIAL_RANGE_POSTCONDITION_VIOLATION 26071 +#define __WARNING_INVALID_PARAM_VALUE_3 28183 +#define __WARNING_RETURNING_BAD_RESULT 28196 +#define __WARNING_BANNED_API_USAGE 28719 +#define __WARNING_POST_EXPECTED 28210 + +#pragma warning(push) +#if _MSC_VER <= 1400 +#pragma warning(disable: 4616) // turn off warning out of range so prefast pragmas won't show +// show up in build.wrn/build.err +#endif +#pragma warning(disable : 4996) // 'function': was declared deprecated +#pragma warning(disable : 4995) // name was marked as #pragma deprecated +#pragma warning(disable : 4793) // vararg causes native code generation +#pragma warning(disable : __WARNING_CYCLOMATIC_COMPLEXITY) + + +#ifndef STRSAFE_LIB_IMPL + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCopy( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcpy'. + The size of the destination buffer (in characters) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This routine is not a replacement for strncpy. That function will pad the + destination string with extra null termination characters if the count is + greater than the length of the source string, and it will fail to null + terminate the destination string if the source string length is greater + than or equal to the count. You can not blindly use this instead of strncpy: + it is common for code to use it to "patch" strings and you would introduce + errors if the code started null terminating in the middle of the string. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was copied without truncation and null terminated, + otherwise it will return a failure code. In failure cases as much of + pszSrc will be copied to pszDest as possible, and pszDest will be null + terminated. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be = (_tcslen(src) + 1) to hold all of the +source including the null terminator + +pszSrc - source string which must be null terminated + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCchCopyEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ + +#ifdef UNICODE + + +#define StringCchCopy StringCchCopyW + + +#else + + +#define StringCchCopy StringCchCopyA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCopyA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCSTR pszSrc) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerA(pszDest, + cchDest, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchCopyW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCWSTR pszSrc) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerW(pszDest, + cchDest, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCopy( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcpy'. + The size of the destination buffer (in bytes) is a parameter and this + function will not write past the end of this buffer and it will ALWAYS + null terminate the destination buffer (unless it is zero length). + + This routine is not a replacement for strncpy. That function will pad the + destination string with extra null termination characters if the count is + greater than the length of the source string, and it will fail to null + terminate the destination string if the source string length is greater + than or equal to the count. You can not blindly use this instead of strncpy: + it is common for code to use it to "patch" strings and you would introduce + errors if the code started null terminating in the middle of the string. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was copied without truncation and null terminated, + otherwise it will return a failure code. In failure cases as much of pszSrc + will be copied to pszDest as possible, and pszDest will be null terminated. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be = ((_tcslen(src) + 1) * sizeof(TCHAR)) to +hold all of the source including the null terminator + +pszSrc - source string which must be null terminated + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCbCopyEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCbCopy StringCbCopyW + + +#else + + +#define StringCbCopy StringCbCopyA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCopyA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCSTR pszSrc) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerA(pszDest, + cchDest, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbCopyW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCWSTR pszSrc) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerW(pszDest, + cchDest, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCopyEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcpy' with + some additional parameters. In addition to functionality provided by + StringCchCopy, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be = (_tcslen(pszSrc) + 1) to hold all of +the source including the null terminator + +pszSrc - source string which must be null terminated + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return the +number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcpy + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCopyEx StringCchCopyExW + + +#else + + +#define StringCchCopyEx StringCchCopyExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCopyExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCSTR pszSrc, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if (*pszSrc != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDest, + cchDest, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchCopyExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCWSTR pszSrc, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if (*pszSrc != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDest, + cchDest, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCopyEx( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcpy' with + some additional parameters. In addition to functionality provided by + StringCbCopy, this routine also returns a pointer to the end of the + destination string and the number of bytes left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be ((_tcslen(pszSrc) + 1) * sizeof(TCHAR)) to +hold all of the source including the null terminator + +pszSrc - source string which must be null terminated + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcbRemaining - pcbRemaining is non-null,the function will return the +number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcpy + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCopyEx StringCbCopyExW + + +#else + + +#define StringCbCopyEx StringCbCopyExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCopyExA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCSTR pszSrc, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if (*pszSrc != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDest, + cchDest, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbCopyExW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCWSTR pszSrc, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if (*pszSrc != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDest, + cchDest, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCopyN( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToCopy) LPCTSTR pszSrc, + _In_ size_t cchToCopy + ); + + + Routine Description: + + This routine is a safer version of the C built-in function 'strncpy'. + The size of the destination buffer (in characters) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This routine is meant as a replacement for strncpy, but it does behave + differently. This function will not pad the destination buffer with extra + null termination characters if cchToCopy is greater than the length of pszSrc. + + This function returns a hresult, and not a pointer. It returns + S_OK if the entire string or the first cchToCopy characters were copied + without truncation and the resultant destination string was null terminated, + otherwise it will return a failure code. In failure cases as much of pszSrc + will be copied to pszDest as possible, and pszDest will be null terminated. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be = (_tcslen(src) + 1) to hold all of the +source including the null terminator + +pszSrc - source string + +cchToCopy - maximum number of characters to copy from source string, +not including the null terminator. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCchCopyNEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCchCopyN StringCchCopyNW + + +#else + + +#define StringCchCopyN StringCchCopyNA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCopyNA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZCH pszSrc, + _In_ size_t cchToCopy) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + if (cchToCopy > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + *pszDest = '\0'; + } + else + { + hr = StringCopyWorkerA(pszDest, + cchDest, + NULL, + pszSrc, + cchToCopy); + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchCopyNW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cchToCopy) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + if (cchToCopy > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + *pszDest = L'\0'; + } + else + { + hr = StringCopyWorkerW(pszDest, + cchDest, + NULL, + pszSrc, + cchToCopy); + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCopyN( + _Out_writes_bytes_(cbDest) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc, + _In_ size_t cbToCopy + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncpy'. + The size of the destination buffer (in bytes) is a parameter and this + function will not write past the end of this buffer and it will ALWAYS + null terminate the destination buffer (unless it is zero length). + + This routine is meant as a replacement for strncpy, but it does behave + differently. This function will not pad the destination buffer with extra + null termination characters if cbToCopy is greater than the size of pszSrc. + + This function returns a hresult, and not a pointer. It returns + S_OK if the entire string or the first cbToCopy characters were + copied without truncation and the resultant destination string was null + terminated, otherwise it will return a failure code. In failure cases as + much of pszSrc will be copied to pszDest as possible, and pszDest will be + null terminated. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be = ((_tcslen(src) + 1) * sizeof(TCHAR)) to +hold all of the source including the null terminator + +pszSrc - source string + +cbToCopy - maximum number of bytes to copy from source string, +not including the null terminator. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCbCopyEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCbCopyN StringCbCopyNW + + +#else + + +#define StringCbCopyN StringCbCopyNA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCopyNA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToCopy) STRSAFE_PCNZCH pszSrc, + _In_ size_t cbToCopy) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + size_t cchToCopy = cbToCopy / sizeof(char); + + if (cchToCopy > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + *pszDest = '\0'; + } + else + { + hr = StringCopyWorkerA(pszDest, + cchDest, + NULL, + pszSrc, + cchToCopy); + } + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY) + +STRSAFEAPI + StringCbCopyNW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cbToCopy) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + size_t cchToCopy = cbToCopy / sizeof(wchar_t); + + if (cchToCopy > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + *pszDest = L'\0'; + } + else + { + hr = StringCopyWorkerW(pszDest, + cchDest, + NULL, + pszSrc, + cchToCopy); + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCopyNEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _In_ size_t cchToCopy, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncpy' with + some additional parameters. In addition to functionality provided by + StringCchCopyN, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination + string including the null terminator. The flags parameter allows + additional controls. + + This routine is meant as a replacement for strncpy, but it does behave + differently. This function will not pad the destination buffer with extra + null termination characters if cchToCopy is greater than the length of pszSrc. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be = (_tcslen(pszSrc) + 1) to hold all of +the source including the null terminator + +pszSrc - source string + +cchToCopy - maximum number of characters to copy from the source +string + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return the +number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcpy + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCopyNEx StringCchCopyNExW + + +#else + + +#define StringCchCopyNEx StringCchCopyNExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCopyNExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZCH pszSrc, + _In_ size_t cchToCopy, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszSrc, &cchToCopy, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if ((cchToCopy != 0) && (*pszSrc != '\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDest, + cchDest, + &cchCopied, + pszSrc, + cchToCopy); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchCopyNExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cchToCopy, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszSrc, &cchToCopy, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if ((cchToCopy != 0) && (*pszSrc != L'\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDest, + cchDest, + &cchCopied, + pszSrc, + cchToCopy); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCopyNEx( + _Out_writes_bytes_(cbDest) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _In_ size_t cbToCopy, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncpy' with + some additional parameters. In addition to functionality provided by + StringCbCopyN, this routine also returns a pointer to the end of the + destination string and the number of bytes left in the destination string + including the null terminator. The flags parameter allows additional controls. + + This routine is meant as a replacement for strncpy, but it does behave + differently. This function will not pad the destination buffer with extra + null termination characters if cbToCopy is greater than the size of pszSrc. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be ((_tcslen(pszSrc) + 1) * sizeof(TCHAR)) to +hold all of the source including the null terminator + +pszSrc - source string + +cbToCopy - maximum number of bytes to copy from source string + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcbRemaining - pcbRemaining is non-null,the function will return the +number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcpy + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all copied and the +resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the copy +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCopyNEx StringCbCopyNExW + + +#else + + +#define StringCbCopyNEx StringCbCopyNExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCopyNExA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToCopy) STRSAFE_PCNZCH pszSrc, + _In_ size_t cbToCopy, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + size_t cchToCopy = cbToCopy / sizeof(char); + + hr = StringExValidateSrcA(&pszSrc, &cchToCopy, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if ((cchToCopy != 0) && (*pszSrc != '\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDest, + cchDest, + &cchCopied, + pszSrc, + cchToCopy); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY) + +STRSAFEAPI + StringCbCopyNExW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cbToCopy, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + size_t cchToCopy = cbToCopy / sizeof(wchar_t); + + hr = StringExValidateSrcW(&pszSrc, &cchToCopy, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually src data to copy + if ((cchToCopy != 0) && (*pszSrc != L'\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDest, + cchDest, + &cchCopied, + pszSrc, + cchToCopy); + + pszDestEnd = pszDest + cchCopied; + cchRemaining = cchDest - cchCopied; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCat( + _Inout_updates_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcat'. + The size of the destination buffer (in characters) is a parameter and this + function will not write past the end of this buffer and it will ALWAYS + null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was concatenated without truncation and null terminated, + otherwise it will return a failure code. In failure cases as much of pszSrc + will be appended to pszDest as possible, and pszDest will be null + terminated. + +Arguments: + +pszDest - destination string which must be null terminated + +cchDest - size of destination buffer in characters. +length must be = (_tcslen(pszDest) + _tcslen(pszSrc) + 1) +to hold all of the combine string plus the null +terminator + +pszSrc - source string which must be null terminated + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCchCatEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error occurs, +the destination buffer is modified to contain a truncated +version of the ideal result and is null terminated. This +is useful for situations where truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCat StringCchCatW + + +#else + + +#define StringCchCat StringCchCatA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCatA( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCSTR pszSrc) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerA(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + + return hr; +} + + + +STRSAFEAPI + StringCchCatW( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCWSTR pszSrc) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerW(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCat( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcat'. + The size of the destination buffer (in bytes) is a parameter and this + function will not write past the end of this buffer and it will ALWAYS + null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was concatenated without truncation and null terminated, + otherwise it will return a failure code. In failure cases as much of pszSrc + will be appended to pszDest as possible, and pszDest will be null + terminated. + +Arguments: + +pszDest - destination string which must be null terminated + +cbDest - size of destination buffer in bytes. +length must be = ((_tcslen(pszDest) + _tcslen(pszSrc) + 1) * sizeof(TCHAR) +to hold all of the combine string plus the null +terminator + +pszSrc - source string which must be null terminated + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCbCatEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error occurs, +the destination buffer is modified to contain a truncated +version of the ideal result and is null terminated. This +is useful for situations where truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCat StringCbCatW + + +#else + + +#define StringCbCat StringCbCatA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCatA( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCSTR pszSrc) +{ + HRESULT hr; + size_t cchDestLength; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerA(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + + return hr; +} + + + +STRSAFEAPI + StringCbCatW( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCWSTR pszSrc) +{ + HRESULT hr; + size_t cchDestLength; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringCopyWorkerW(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + STRSAFE_MAX_LENGTH); + } + + return hr; +} + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCatEx( + _Inout_updates_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcat' with + some additional parameters. In addition to functionality provided by + StringCchCat, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string which must be null terminated + +cchDest - size of destination buffer in characters +length must be (_tcslen(pszDest) + _tcslen(pszSrc) + 1) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string which must be null terminated + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function appended any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return the +number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcat + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any pre-existing +or truncated string + +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any pre-existing or +truncated string + +STRSAFE_NO_TRUNCATION +if the function returns STRSAFE_E_INSUFFICIENT_BUFFER, pszDest +will not contain a truncated string, it will remain unchanged. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCatEx StringCchCatExW + + +#else + + +#define StringCchCatEx StringCchCatExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCatExA( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCSTR pszSrc, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringExValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcA(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if (*pszSrc != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + + + +STRSAFEAPI + StringCchCatExW( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ STRSAFE_LPCWSTR pszSrc, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringExValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcW(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if (*pszSrc != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCatEx( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strcat' with + some additional parameters. In addition to functionality provided by + StringCbCat, this routine also returns a pointer to the end of the + destination string and the number of bytes left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string which must be null terminated + +cbDest - size of destination buffer in bytes. +length must be ((_tcslen(pszDest) + _tcslen(pszSrc) + 1) * sizeof(TCHAR) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string which must be null terminated + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function appended any data, the result will point to the +null termination character + +pcbRemaining - if pcbRemaining is non-null, the function will return +the number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). +this flag is useful for emulating functions like lstrcat + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any pre-existing +or truncated string + +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any pre-existing or +truncated string + +STRSAFE_NO_TRUNCATION +if the function returns STRSAFE_E_INSUFFICIENT_BUFFER, pszDest +will not contain a truncated string, it will remain unchanged. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all concatenated +and the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCatEx StringCbCatExW + + +#else + + +#define StringCbCatEx StringCbCatExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCatExA( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCSTR pszSrc, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + size_t cchDestLength; + + hr = StringExValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcA(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if (*pszSrc != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + + + +STRSAFEAPI + StringCbCatExW( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ STRSAFE_LPCWSTR pszSrc, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + size_t cchDestLength; + + hr = StringExValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcW(&pszSrc, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if (*pszSrc != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + STRSAFE_MAX_LENGTH); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCatN( + _Inout_updates_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc, + _In_ size_t cchToAppend + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncat'. + The size of the destination buffer (in characters) is a parameter as well as + the maximum number of characters to append, excluding the null terminator. + This function will not write past the end of the destination buffer and it will + ALWAYS null terminate pszDest (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if all of pszSrc or the first cchToAppend characters were appended + to the destination string and it was null terminated, otherwise it will + return a failure code. In failure cases as much of pszSrc will be appended + to pszDest as possible, and pszDest will be null terminated. + +Arguments: + +pszDest - destination string which must be null terminated + +cchDest - size of destination buffer in characters. +length must be (_tcslen(pszDest) + min(cchToAppend, _tcslen(pszSrc)) + 1) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string + +cchToAppend - maximum number of characters to append + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCchCatNEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if all of pszSrc or the first cchToAppend characters +were concatenated to pszDest and the resultant dest +string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCatN StringCchCatNW + + +#else + + +#define StringCchCatN StringCchCatNA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCatNA( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToAppend) STRSAFE_PCNZCH pszSrc, + _In_ size_t cchToAppend) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + if (cchToAppend > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringCopyWorkerA(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + cchToAppend); + } + } + + return hr; +} + + + +STRSAFEAPI + StringCchCatNW( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToAppend) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cchToAppend) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + if (cchToAppend > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringCopyWorkerW(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + cchToAppend); + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCatN( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc, + _In_ size_t cbToAppend + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncat'. + The size of the destination buffer (in bytes) is a parameter as well as + the maximum number of bytes to append, excluding the null terminator. + This function will not write past the end of the destination buffer and it will + ALWAYS null terminate pszDest (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if all of pszSrc or the first cbToAppend bytes were appended + to the destination string and it was null terminated, otherwise it will + return a failure code. In failure cases as much of pszSrc will be appended + to pszDest as possible, and pszDest will be null terminated. + +Arguments: + +pszDest - destination string which must be null terminated + +cbDest - size of destination buffer in bytes. +length must be ((_tcslen(pszDest) + min(cbToAppend / sizeof(TCHAR), _tcslen(pszSrc)) + 1) * sizeof(TCHAR) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string + +cbToAppend - maximum number of bytes to append + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL. See StringCbCatNEx if you require +the handling of NULL values. + +Return Value: + +S_OK - if all of pszSrc or the first cbToAppend bytes were +concatenated to pszDest and the resultant dest string +was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCatN StringCbCatNW + + +#else + + +#define StringCbCatN StringCbCatNA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCatNA( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToAppend) STRSAFE_PCNZCH pszSrc, + _In_ size_t cbToAppend) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + size_t cchDestLength; + + hr = StringValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + size_t cchToAppend = cbToAppend / sizeof(char); + + if (cchToAppend > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringCopyWorkerA(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + cchToAppend); + } + } + + return hr; +} + + + +STRSAFEAPI + StringCbCatNW( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToAppend) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cbToAppend) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + size_t cchDestLength; + + hr = StringValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + size_t cchToAppend = cbToAppend / sizeof(wchar_t); + + if (cchToAppend > STRSAFE_MAX_LENGTH) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringCopyWorkerW(pszDest + cchDestLength, + cchDest - cchDestLength, + NULL, + pszSrc, + cchToAppend); + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchCatNEx( + _Inout_updates_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _In_ size_t cchToAppend, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncat', with + some additional parameters. In addition to functionality provided by + StringCchCatN, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string which must be null terminated + +cchDest - size of destination buffer in characters. +length must be (_tcslen(pszDest) + min(cchToAppend, _tcslen(pszSrc)) + 1) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string + +cchToAppend - maximum number of characters to append + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function appended any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return the +number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any pre-existing +or truncated string + +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any pre-existing or +truncated string + +STRSAFE_NO_TRUNCATION +if the function returns STRSAFE_E_INSUFFICIENT_BUFFER, pszDest +will not contain a truncated string, it will remain unchanged. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if all of pszSrc or the first cchToAppend characters +were concatenated to pszDest and the resultant dest +string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchCatNEx StringCchCatNExW + + +#else + + +#define StringCchCatNEx StringCchCatNExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchCatNExA( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToAppend) STRSAFE_PCNZCH pszSrc, + _In_ size_t cchToAppend, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringExValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcA(&pszSrc, &cchToAppend, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if ((cchToAppend != 0) && (*pszSrc != '\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + cchToAppend); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + + + +STRSAFEAPI + StringCchCatNExW( + _Inout_updates_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_reads_or_z_(cchToAppend) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cchToAppend, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDestLength; + + hr = StringExValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + + hr = StringExValidateSrcW(&pszSrc, &cchToAppend, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if ((cchToAppend != 0) && (*pszSrc != L'\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + cchToAppend); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbCatNEx( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _In_ LPCTSTR pszSrc OPTIONAL, + _In_ size_t cbToAppend, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strncat', with + some additional parameters. In addition to functionality provided by + StringCbCatN, this routine also returns a pointer to the end of the + destination string and the number of bytes left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string which must be null terminated + +cbDest - size of destination buffer in bytes. +length must be ((_tcslen(pszDest) + min(cbToAppend / sizeof(TCHAR), _tcslen(pszSrc)) + 1) * sizeof(TCHAR) +to hold all of the combine string plus the null +terminator. + +pszSrc - source string + +cbToAppend - maximum number of bytes to append + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function appended any data, the result will point to the +null termination character + +pcbRemaining - if pcbRemaining is non-null, the function will return the +number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any pre-existing +or truncated string + +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any pre-existing or +truncated string + +STRSAFE_NO_TRUNCATION +if the function returns STRSAFE_E_INSUFFICIENT_BUFFER, pszDest +will not contain a truncated string, it will remain unchanged. + +Notes: +Behavior is undefined if source and destination strings overlap. + +pszDest and pszSrc should not be NULL unless the STRSAFE_IGNORE_NULLS flag +is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and pszSrc +may be NULL. An error may still be returned even though NULLS are ignored +due to insufficient space. + +Return Value: + +S_OK - if all of pszSrc or the first cbToAppend bytes were +concatenated to pszDest and the resultant dest string +was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the operation +failed due to insufficient space. When this error +occurs, the destination buffer is modified to contain +a truncated version of the ideal result and is null +terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbCatNEx StringCbCatNExW + + +#else + + +#define StringCbCatNEx StringCbCatNExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbCatNExA( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToAppend) STRSAFE_PCNZCH pszSrc, + _In_ size_t cbToAppend, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + size_t cchDestLength; + + hr = StringExValidateDestAndLengthA(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + size_t cchToAppend = cbToAppend / sizeof(char); + + hr = StringExValidateSrcA(&pszSrc, &cchToAppend, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if ((cchToAppend != 0) && (*pszSrc != '\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerA(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + cchToAppend); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY) + +STRSAFEAPI + StringCbCatNExW( + _Inout_updates_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_reads_bytes_(cbToAppend) STRSAFE_PCNZWCH pszSrc, + _In_ size_t cbToAppend, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + size_t cchDestLength; + + hr = StringExValidateDestAndLengthW(pszDest, + cchDest, + &cchDestLength, + STRSAFE_MAX_CCH, + dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest + cchDestLength; + size_t cchRemaining = cchDest - cchDestLength; + size_t cchToAppend = cbToAppend / sizeof(wchar_t); + + hr = StringExValidateSrcW(&pszSrc, &cchToAppend, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if (cchRemaining <= 1) + { + // only fail if there was actually src data to append + if ((cchToAppend != 0) && (*pszSrc != L'\0')) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchCopied = 0; + + hr = StringCopyWorkerW(pszDestEnd, + cchRemaining, + &cchCopied, + pszSrc, + cchToAppend); + + pszDestEnd = pszDestEnd + cchCopied; + cchRemaining = cchRemaining - cchCopied; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + cchDestLength, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchVPrintf( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ LPCTSTR pszFormat, + _In_ va_list argList + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'vsprintf'. + The size of the destination buffer (in characters) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was printed without truncation and null terminated, + otherwise it will return a failure code. In failure cases it will return + a truncated version of the ideal result. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters +length must be sufficient to hold the resulting formatted +string, including the null terminator. + +pszFormat - format string which must be null terminated + +argList - va_list from the variable arguments according to the +stdarg.h convention + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL. See StringCchVPrintfEx if you +require the handling of NULL values. + +Return Value: + +S_OK - if there was sufficient space in the dest buffer for +the resultant string and it was null terminated. + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchVPrintf StringCchVPrintfW + + +#else + + +#define StringCchVPrintf StringCchVPrintfA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintfA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintfWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintfW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintfWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + argList); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CCH_FUNCTIONS) +/*++ + + STDAPI + StringCchVPrintf_l( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat, + _In_ locale_t locale, + _In_ va_list argList + ); + + Routine Description: + + This routine is a version of StringCchVPrintf that also takes a locale. + Please see notes for StringCchVPrintf above. + + --*/ +#ifdef UNICODE + + +#define StringCchVPrintf_l StringCchVPrintf_lW + + +#else + + +#define StringCchVPrintf_l StringCchVPrintf_lA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintf_lA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintf_lW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbVPrintf( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ LPCTSTR pszFormat, + _In_ va_list argList + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'vsprintf'. + The size of the destination buffer (in bytes) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was printed without truncation and null terminated, + otherwise it will return a failure code. In failure cases it will return + a truncated version of the ideal result. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes +length must be sufficient to hold the resulting formatted +string, including the null terminator. + +pszFormat - format string which must be null terminated + +argList - va_list from the variable arguments according to the +stdarg.h convention + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL. See StringCbVPrintfEx if you +require the handling of NULL values. + + +Return Value: + +S_OK - if there was sufficient space in the dest buffer for +the resultant string and it was null terminated. + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbVPrintf StringCbVPrintfW + + +#else + + +#define StringCbVPrintf StringCbVPrintfA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbVPrintfA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintfWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbVPrintfW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintfWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CB_FUNCTIONS) +/*++ + + STDAPI + StringCbVPrintf_l( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat, + _In_ local_t locale, + _In_ va_list argList + ); + + Routine Description: + + This routine is a version of StringCbVPrintf that also takes a locale. + Please see notes for StringCbVPrintf above. + + --*/ +#ifdef UNICODE + + +#define StringCbVPrintf_l StringCbVPrintf_lW + + +#else + + +#define StringCbVPrintf_l StringCbVPrintf_lA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbVPrintf_lA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + } + + return hr; +} + +#pragma warning(pop) + + + +STRSAFEAPI + StringCbVPrintf_lW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + } + + return hr; +} + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef _M_CEE_PURE + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchPrintf( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ LPCTSTR pszFormat, + ... + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'sprintf'. + The size of the destination buffer (in characters) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was printed without truncation and null terminated, + otherwise it will return a failure code. In failure cases it will return + a truncated version of the ideal result. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters +length must be sufficient to hold the resulting formatted +string, including the null terminator. + +pszFormat - format string which must be null terminated + +... - additional parameters to be formatted according to +the format string + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL. See StringCchPrintfEx if you +require the handling of NULL values. + +Return Value: + +S_OK - if there was sufficient space in the dest buffer for +the resultant string and it was null terminated. + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchPrintf StringCchPrintfW + + +#else + + +#define StringCchPrintf StringCchPrintfA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchPrintfA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + ...) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + argList); + + va_end(argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchPrintfW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ...) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + argList); + + va_end(argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CCH_FUNCTIONS) +/*++ + + STDAPI + StringCchPrintf_l( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat, + _In_ locale_t locale, + ... + ); + + Routine Description: + + This routine is a version of a StringCchPrintf_l that also takes a locale. + Please see notes for StringCchPrintf above. + + --*/ +#ifdef UNICODE + + +#define StringCchPrintf_l StringCchPrintf_lW + + +#else + + +#define StringCchPrintf_l StringCchPrintf_lA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchPrintf_lA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + + va_end(argList); + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchPrintf_lW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + + va_end(argList); + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbPrintf( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ LPCTSTR pszFormat, + ... + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'sprintf'. + The size of the destination buffer (in bytes) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This function returns a hresult, and not a pointer. It returns + S_OK if the string was printed without truncation and null terminated, + otherwise it will return a failure code. In failure cases it will return + a truncated version of the ideal result. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes +length must be sufficient to hold the resulting formatted +string, including the null terminator. + +pszFormat - format string which must be null terminated + +... - additional parameters to be formatted according to +the format string + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL. See StringCbPrintfEx if you +require the handling of NULL values. + + +Return Value: + +S_OK - if there was sufficient space in the dest buffer for +the resultant string and it was null terminated. + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbPrintf StringCbPrintfW + + +#else + + +#define StringCbPrintf StringCbPrintfA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbPrintfA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + argList); + + va_end(argList); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbPrintfW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + argList); + + va_end(argList); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CB_FUNCTIONS) +/*++ + + STDAPI + StringCbPrintf_l( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat, + _In_ locale_t locale, + ... + ); + + Routine Description: + + This routine is a version of StringCbPrintf that also takes a locale. + Please see notes for StringCbPrintf above. + + --*/ +#ifdef UNICODE + + +#define StringCbPrintf_l StringCbPrintf_lW + + +#else + + +#define StringCbPrintf_l StringCbPrintf_lA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbPrintf_lA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + + va_end(argList); + } + + return hr; +} + +#pragma warning(pop) + + + +STRSAFEAPI + StringCbPrintf_lW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + NULL, + pszFormat, + locale, + argList); + + va_end(argList); + } + + return hr; +} + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchPrintfEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ LPCTSTR pszFormat OPTIONAL, + ... + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'sprintf' with + some additional parameters. In addition to functionality provided by + StringCchPrintf, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be sufficient to contain the resulting +formatted string plus the null terminator. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function printed any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return +the number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +pszFormat - format string which must be null terminated + +... - additional parameters to be formatted according to +the format string + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL unless the STRSAFE_IGNORE_NULLS +flag is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and +pszFormat may be NULL. An error may still be returned even though NULLS +are ignored due to insufficient space. + +Return Value: + +S_OK - if there was sufficient space in the dest buffer for +the resultant string and it was null terminated. + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchPrintfEx StringCchPrintfExW + + +#else + + +#define StringCchPrintfEx StringCchPrintfExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCchPrintfExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + ...) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCchPrintfExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ...) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CCH_FUNCTIONS) +/*++ + + STDAPI + StringCchPrintf_lEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat OPTIONAL, + _In_ locale_t locale, + ... + ); + + Routine Description: + + This routine is a version of StringCchPrintfEx that also takes a locale. + Please see notes for StringCchPrintfEx above. + + --*/ +#ifdef UNICODE + + +#define StringCchPrintf_lEx StringCchPrintf_lExW + + +#else + + +#define StringCchPrintf_lEx StringCchPrintf_lExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchPrintf_lExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchPrintf_lExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbPrintfEx( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ LPCTSTR pszFormat OPTIONAL, + ... + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'sprintf' with + some additional parameters. In addition to functionality provided by + StringCbPrintf, this routine also returns a pointer to the end of the + destination string and the number of bytes left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be sufficient to contain the resulting +formatted string plus the null terminator. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function printed any data, the result will point to the +null termination character + +pcbRemaining - if pcbRemaining is non-null, the function will return +the number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +pszFormat - format string which must be null terminated + +... - additional parameters to be formatted according to +the format string + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL unless the STRSAFE_IGNORE_NULLS +flag is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and +pszFormat may be NULL. An error may still be returned even though NULLS +are ignored due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbPrintfEx StringCbPrintfExW + + +#else + + +#define StringCbPrintfEx StringCbPrintfExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCbPrintfExA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbPrintfExW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, pszFormat); + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CB_FUNCTIONS) +/*++ + + STDAPI + StringCbPrintf_lEx( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat OPTIONAL, + _In_ locale_t locale, + ... + ); + + Routine Description: + + This routine is a version of StringCbPrintfEx that also takes a locale. + Please seee notes for StringCbPrintfEx above. + + --*/ +#ifdef UNICODE + + +#define StringCbPrintf_lEx StringCbPrintf_lExW + + +#else + + +#define StringCbPrintf_lEx StringCbPrintf_lExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbPrintf_lExA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbPrintf_lExW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + ...) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + va_list argList; + + va_start(argList, locale); + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + va_end(argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CB_FUNCTIONS + +#endif // !_M_CEE_PURE + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchVPrintfEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ LPCTSTR pszFormat OPTIONAL, + _In_ va_list argList + ); + + + Routine Description: + + This routine is a safer version of the C built-in function 'vsprintf' with + some additional parameters. In addition to functionality provided by + StringCchVPrintf, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. +length must be sufficient to contain the resulting +formatted string plus the null terminator. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function printed any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return +the number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +pszFormat - format string which must be null terminated + +argList - va_list from the variable arguments according to the +stdarg.h convention + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL unless the STRSAFE_IGNORE_NULLS +flag is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and +pszFormat may be NULL. An error may still be returned even though NULLS +are ignored due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCchVPrintfEx StringCchVPrintfExW + + +#else + + +#define StringCchVPrintfEx StringCchVPrintfExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCchVPrintfExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCchVPrintfExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CCH_FUNCTIONS) +/*++ + + STDAPI + StringCchVPrintf_lEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat OPTIONAL, + _In_ locale_t locale, + _In_ va_list argList + ); + + Routine Description: + + This routine is a version of StringCchVPrintfEx that also takes a locale. + Please see notes for StringCchVPrintfEx above. + + --*/ +#ifdef UNICODE + + +#define StringCchVPrintf_lEx StringCchVPrintf_lExW + + +#else + + +#define StringCchVPrintf_lEx StringCchVPrintf_lExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintf_lExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCchVPrintf_lExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbVPrintfEx( + _Out_writes_bytes_(cbDest) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ LPCTSTR pszFormat OPTIONAL, + _In_ va_list argList + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'vsprintf' with + some additional parameters. In addition to functionality provided by + StringCbVPrintf, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. +length must be sufficient to contain the resulting +formatted string plus the null terminator. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return +a pointer to the end of the destination string. If the +function printed any data, the result will point to the +null termination character + +pcbRemaining - if pcbRemaining is non-null, the function will return +the number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")) + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. This will overwrite any truncated +string returned when the failure is +STRSAFE_E_INSUFFICIENT_BUFFER + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. This will overwrite any truncated string +returned when the failure is STRSAFE_E_INSUFFICIENT_BUFFER. + +pszFormat - format string which must be null terminated + +argList - va_list from the variable arguments according to the +stdarg.h convention + +Notes: +Behavior is undefined if destination, format strings or any arguments +strings overlap. + +pszDest and pszFormat should not be NULL unless the STRSAFE_IGNORE_NULLS +flag is specified. If STRSAFE_IGNORE_NULLS is passed, both pszDest and +pszFormat may be NULL. An error may still be returned even though NULLS +are ignored due to insufficient space. + +Return Value: + +S_OK - if there was source data and it was all concatenated and +the resultant dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that the print +operation failed due to insufficient space. When this +error occurs, the destination buffer is modified to +contain a truncated version of the ideal result and is +null terminated. This is useful for situations where +truncation is ok. + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function + +--*/ +#ifdef UNICODE + + +#define StringCbVPrintfEx StringCbVPrintfExW + + +#else + + +#define StringCbVPrintfEx StringCbVPrintfExA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCbVPrintfExA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintfWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable : __WARNING_INCORRECT_ANNOTATION) + +STRSAFEAPI + StringCbVPrintfExW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + // for consistency with other use in this case... + __analysis_assume_nullterminated(pszDest); + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintfWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#if defined(STRSAFE_LOCALE_FUNCTIONS) && !defined(STRSAFE_NO_CB_FUNCTIONS) +/*++ + + STDAPI + StringCbVPrintf_lEx( + _Out_writes_bytes_(cbDest) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) LPCTSTR pszFormat OPTIONAL, + _In_ locale_t locale, + _In_ va_list argList + ); + + Routine Description: + + This routine is a version of StringCbVPrintfEx that also takes a locale. + Please see notes for StringCbVPrintfEx above. + + --*/ +#ifdef UNICODE + + +#define StringCbVPrintf_lEx StringCbVPrintf_lExW + + +#else + + +#define StringCbVPrintf_lEx StringCbVPrintf_lExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbVPrintf_lExA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcA(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != '\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintf_lWorkerA(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbVPrintf_lExW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + hr = StringExValidateSrcW(&pszFormat, NULL, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + // only fail if there was actually a non-empty format string + if (*pszFormat != L'\0') + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringVPrintf_lWorkerW(pszDest, + cchDest, + &cchNewDestLength, + pszFormat, + locale, + argList); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + } + else + { + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || (hr == STRSAFE_E_INSUFFICIENT_BUFFER)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + + return hr; +} + +#pragma warning(pop) + + +#endif // STRSAFE_LOCALE_FUNCTIONS && !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_LIB_IMPL + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchGets( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cchDest + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'gets'. + The size of the destination buffer (in characters) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This routine is not a replacement for fgets. That function does not replace + newline characters with a null terminator. + + This function returns a hresult, and not a pointer. It returns + S_OK if any characters were read from stdin and copied to pszDest and + pszDest was null terminated, otherwise it will return a failure code. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. + +Notes: +pszDest should not be NULL. See StringCchGetsEx if you require the handling +of NULL values. + +cchDest must be > 1 for this function to succeed. + +Return Value: + +S_OK - data was read from stdin and copied, and the resultant +dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_END_OF_FILE / +HRESULT_CODE(hr) == ERROR_HANDLE_EOF +- this return value indicates an error or end-of-file +condition, use feof or ferror to determine which one has +occured. + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that there was +insufficient space in the destination buffer to copy any +data + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCchGets StringCchGetsW + + +#else + + +#define StringCchGets StringCchGetsA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchGetsA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringGetsWorkerA(pszDest, cchDest, NULL); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchGetsW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringGetsWorkerW(pszDest, cchDest, NULL); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbGets( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest, + _In_ size_t cbDest + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'gets'. + The size of the destination buffer (in bytes) is a parameter and + this function will not write past the end of this buffer and it will + ALWAYS null terminate the destination buffer (unless it is zero length). + + This routine is not a replacement for fgets. That function does not replace + newline characters with a null terminator. + + This function returns a hresult, and not a pointer. It returns + S_OK if any characters were read from stdin and copied to pszDest + and pszDest was null terminated, otherwise it will return a failure code. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. + +Notes: +pszDest should not be NULL. See StringCbGetsEx if you require the handling +of NULL values. + +cbDest must be > sizeof(TCHAR) for this function to succeed. + +Return Value: + +S_OK - data was read from stdin and copied, and the resultant +dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_END_OF_FILE / +HRESULT_CODE(hr) == ERROR_HANDLE_EOF +- this return value indicates an error or end-of-file +condition, use feof or ferror to determine which one has +occured. + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that there was +insufficient space in the destination buffer to copy any +data + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCbGets StringCbGetsW + + +#else + + +#define StringCbGets StringCbGetsA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbGetsA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringGetsWorkerA(pszDest, cchDest, NULL); + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCbGetsW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH); + + if (SUCCEEDED(hr)) + { + hr = StringGetsWorkerW(pszDest, cchDest, NULL); + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchGetsEx( + _Out_writes_(cchDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcchRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'gets' with + some additional parameters. In addition to functionality provided by + StringCchGets, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cchDest - size of destination buffer in characters. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcchRemaining - if pcchRemaining is non-null, the function will return the +number of characters left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. + +Notes: +pszDest should not be NULL unless the STRSAFE_IGNORE_NULLS flag is specified. +If STRSAFE_IGNORE_NULLS is passed and pszDest is NULL, an error may still be +returned even though NULLS are ignored + +cchDest must be > 1 for this function to succeed. + +Return Value: + +S_OK - data was read from stdin and copied, and the resultant +dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_END_OF_FILE / +HRESULT_CODE(hr) == ERROR_HANDLE_EOF +- this return value indicates an error or end-of-file +condition, use feof or ferror to determine which one has +occured. + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that there was +insufficient space in the destination buffer to copy any +data + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCchGetsEx StringCchGetsExW + + +#else + + +#define StringCchGetsEx StringCchGetsExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCchGetsExA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringGetsWorkerA(pszDest, cchDest, &cchNewDestLength); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = cchRemaining * sizeof(char); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(char) since cchDest < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbDest = cchDest * sizeof(char); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || + (hr == STRSAFE_E_INSUFFICIENT_BUFFER) || + (hr == STRSAFE_E_END_OF_FILE)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +STRSAFEAPI + StringCchGetsExW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cchDest, + _Outptr_opt_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringGetsWorkerW(pszDest, cchDest, &cchNewDestLength); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = cchRemaining * sizeof(wchar_t); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cchDest != 0)) + { + size_t cbDest; + + // safe to multiply cchDest * sizeof(wchar_t) since cchDest < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbDest = cchDest * sizeof(wchar_t); + + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || + (hr == STRSAFE_E_INSUFFICIENT_BUFFER) || + (hr == STRSAFE_E_END_OF_FILE)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcchRemaining) + { + *pcchRemaining = cchRemaining; + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbGetsEx( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) LPTSTR pszDest OPTIONAL, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) LPTSTR* ppszDestEnd OPTIONAL, + _Out_opt_ size_t* pcbRemaining OPTIONAL, + _In_ DWORD dwFlags + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'gets' with + some additional parameters. In addition to functionality provided by + StringCbGets, this routine also returns a pointer to the end of the + destination string and the number of characters left in the destination string + including the null terminator. The flags parameter allows additional controls. + +Arguments: + +pszDest - destination string + +cbDest - size of destination buffer in bytes. + +ppszDestEnd - if ppszDestEnd is non-null, the function will return a +pointer to the end of the destination string. If the +function copied any data, the result will point to the +null termination character + +pcbRemaining - if pcbRemaining is non-null, the function will return the +number of bytes left in the destination string, +including the null terminator + +dwFlags - controls some details of the string copy: + +STRSAFE_FILL_BEHIND_NULL +if the function succeeds, the low byte of dwFlags will be +used to fill the uninitialize part of destination buffer +behind the null terminator + +STRSAFE_IGNORE_NULLS +treat NULL string pointers like empty strings (TEXT("")). + +STRSAFE_FILL_ON_FAILURE +if the function fails, the low byte of dwFlags will be +used to fill all of the destination buffer, and it will +be null terminated. + +STRSAFE_NO_TRUNCATION / +STRSAFE_NULL_ON_FAILURE +if the function fails, the destination buffer will be set +to the empty string. + +Notes: +pszDest should not be NULL unless the STRSAFE_IGNORE_NULLS flag is specified. +If STRSAFE_IGNORE_NULLS is passed and pszDest is NULL, an error may still be +returned even though NULLS are ignored + +cbDest must be > sizeof(TCHAR) for this function to succeed + +Return Value: + +S_OK - data was read from stdin and copied, and the resultant +dest string was null terminated + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +STRSAFE_E_END_OF_FILE / +HRESULT_CODE(hr) == ERROR_HANDLE_EOF +- this return value indicates an error or end-of-file +condition, use feof or ferror to determine which one has +occured. + +STRSAFE_E_INSUFFICIENT_BUFFER / +HRESULT_CODE(hr) == ERROR_INSUFFICIENT_BUFFER +- this return value is an indication that there was +insufficient space in the destination buffer to copy any +data + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCbGetsEx StringCbGetsExW + + +#else + + +#define StringCbGetsEx StringCbGetsExA + + +#endif // !UNICODE + + +STRSAFEAPI + StringCbGetsExA( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(char); + + hr = StringExValidateDestA(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = '\0'; + } + } + else if (cchDest == 0) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringGetsWorkerA(pszDest, cchDest, &cchNewDestLength); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && + (dwFlags & STRSAFE_FILL_BEHIND_NULL) && + (cchRemaining > 1)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + cbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullA(pszDestEnd, cbRemaining, dwFlags); + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsA(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || + (hr == STRSAFE_E_INSUFFICIENT_BUFFER) || + (hr == STRSAFE_E_END_OF_FILE)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(char) since cchRemaining < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbRemaining = (cchRemaining * sizeof(char)) + (cbDest % sizeof(char)); + } + } + } + else if (cchDest > 0) + { + *pszDest = '\0'; + } + + return hr; +} + + + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFEAPI + StringCbGetsExW( + _Out_writes_bytes_(cbDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ size_t cbDest, + _Outptr_opt_result_bytebuffer_(*pcbRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_opt_ size_t* pcbRemaining, + _In_ DWORD dwFlags) +{ + HRESULT hr; + size_t cchDest = cbDest / sizeof(wchar_t); + + hr = StringExValidateDestW(pszDest, cchDest, STRSAFE_MAX_CCH, dwFlags); + + if (SUCCEEDED(hr)) + { + STRSAFE_LPWSTR pszDestEnd = pszDest; + size_t cchRemaining = cchDest; + + if (dwFlags & (~STRSAFE_VALID_FLAGS)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + + if (cchDest != 0) + { + *pszDest = L'\0'; + } + } + else if (cchDest == 0) + { + if (pszDest == NULL) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + } + else + { + size_t cchNewDestLength = 0; + + hr = StringGetsWorkerW(pszDest, cchDest, &cchNewDestLength); + + pszDestEnd = pszDest + cchNewDestLength; + cchRemaining = cchDest - cchNewDestLength; + + if (SUCCEEDED(hr) && (dwFlags & STRSAFE_FILL_BEHIND_NULL)) + { + size_t cbRemaining; + + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + cbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + + // handle the STRSAFE_FILL_BEHIND_NULL flag + StringExHandleFillBehindNullW(pszDestEnd, cbRemaining, dwFlags); + } + } + + if (FAILED(hr) && + (dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)) && + (cbDest != 0)) + { + // handle the STRSAFE_FILL_ON_FAILURE, STRSAFE_NULL_ON_FAILURE, and STRSAFE_NO_TRUNCATION flags + StringExHandleOtherFlagsW(pszDest, + cbDest, + 0, + &pszDestEnd, + &cchRemaining, + dwFlags); + } + + if (SUCCEEDED(hr) || + (hr == STRSAFE_E_INSUFFICIENT_BUFFER) || + (hr == STRSAFE_E_END_OF_FILE)) + { + if (ppszDestEnd) + { + *ppszDestEnd = pszDestEnd; + } + + if (pcbRemaining) + { + // safe to multiply cchRemaining * sizeof(wchar_t) since cchRemaining < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbRemaining = (cchRemaining * sizeof(wchar_t)) + (cbDest % sizeof(wchar_t)); + } + } + } + else if (cchDest > 0) + { + *pszDest = L'\0'; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + +#endif // !STRSAFE_LIB_IMPL + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + StringCchLength( + _In_reads_or_z_(cchMax) LPCTSTR psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength OPTIONAL + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strlen'. + It is used to make sure a string is not larger than a given length, and + it optionally returns the current length in characters not including + the null terminator. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string is non-null and the length including the null + terminator is less than or equal to cchMax characters. + +Arguments: + +psz - string to check the length of + +cchMax - maximum number of characters including the null terminator +that psz is allowed to contain + +pcch - if the function succeeds and pcch is non-null, the current length +in characters of psz excluding the null terminator will be returned. +This out parameter is equivalent to the return value of strlen(psz) + +Notes: +psz can be null but the function will fail + +cchMax should be greater than zero or the function will fail + +Return Value: + +S_OK - psz is non-null and the length including the null +terminator is less than or equal to cchMax characters + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCchLength StringCchLengthW + + +#else + + +#define StringCchLength StringCchLengthA + + +#endif // !UNICODE + + +#pragma warning(push) +#pragma warning(disable:__WARNING_POTENTIAL_RANGE_POSTCONDITION_VIOLATION) + +_Must_inspect_result_ +STRSAFEAPI + StringCchLengthA( + _In_reads_or_z_(cchMax) STRSAFE_PCNZCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength) +{ + HRESULT hr; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringLengthWorkerA(psz, cchMax, pcchLength); + } + + if (FAILED(hr) && pcchLength) + { + *pcchLength = 0; + } + + return hr; +} + +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable:__WARNING_POTENTIAL_RANGE_POSTCONDITION_VIOLATION) + +_Must_inspect_result_ +STRSAFEAPI + StringCchLengthW( + _In_reads_or_z_(cchMax) STRSAFE_PCNZWCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength) +{ + HRESULT hr; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringLengthWorkerW(psz, cchMax, pcchLength); + } + + if (FAILED(hr) && pcchLength) + { + *pcchLength = 0; + } + + return hr; +} + +#pragma warning(pop) + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + StringCbLength( + _In_reads_or_z_(cbMax) LPCTSTR psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(TCHAR)) size_t cbMax, + _Out_opt_ _Deref_out_range_(<, cbMax) size_t* pcbLength OPTIONAL + ); + + Routine Description: + + This routine is a safer version of the C built-in function 'strlen'. + It is used to make sure a string is not larger than a given length, and + it optionally returns the current length in bytes not including + the null terminator. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string is non-null and the length including the null + terminator is less than or equal to cbMax bytes. + +Arguments: + +psz - string to check the length of + +cbMax - maximum number of bytes including the null terminator +that psz is allowed to contain + +pcb - if the function succeeds and pcb is non-null, the current length +in bytes of psz excluding the null terminator will be returned. +This out parameter is equivalent to the return value of strlen(psz) * sizeof(TCHAR) + +Notes: +psz can be null but the function will fail + +cbMax should be greater than or equal to sizeof(TCHAR) or the function will fail + +Return Value: + +S_OK - psz is non-null and the length including the null +terminator is less than or equal to cbMax bytes + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define StringCbLength StringCbLengthW + + +#else + + +#define StringCbLength StringCbLengthA + + +#endif // !UNICODE + + +_Must_inspect_result_ +STRSAFEAPI + StringCbLengthA( + _In_reads_or_z_(cbMax) STRSAFE_PCNZCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(char)) size_t cbMax, + _Out_opt_ _Deref_out_range_(<, cbMax) size_t* pcbLength) +{ + HRESULT hr; + size_t cchMax = cbMax / sizeof(char); + size_t cchLength = 0; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringLengthWorkerA(psz, cchMax, &cchLength); + } + + if (pcbLength) + { + if (SUCCEEDED(hr)) + { + // safe to multiply cchLength * sizeof(char) since cchLength < STRSAFE_MAX_CCH and sizeof(char) is 1 + *pcbLength = cchLength * sizeof(char); + } + else + { + *pcbLength = 0; + } + } + + return hr; +} + + + +_Must_inspect_result_ +STRSAFEAPI + StringCbLengthW( + _In_reads_or_z_(cbMax / sizeof(wchar_t)) STRSAFE_PCNZWCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(wchar_t)) size_t cbMax, + _Out_opt_ _Deref_out_range_(<, cbMax - 1) size_t* pcbLength) +{ + HRESULT hr; + size_t cchMax = cbMax / sizeof(wchar_t); + size_t cchLength = 0; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = StringLengthWorkerW(psz, cchMax, &cchLength); + } + + if (pcbLength) + { + if (SUCCEEDED(hr)) + { + // safe to multiply cchLength * sizeof(wchar_t) since cchLength < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbLength = cchLength * sizeof(wchar_t); + } + else + { + *pcbLength = 0; + } + } + + return hr; +} + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + +#ifndef STRSAFE_NO_CCH_FUNCTIONS +/*++ + + STDAPI + UnalignedStringCchLength( + _In_ LPCUTSTR psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) size_t* pcchLength OPTIONAL + ); + + Routine Description: + + This routine is a version of StringCchLength that accepts an unaligned string pointer. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string is non-null and the length including the null + terminator is less than or equal to cchMax characters. + +Arguments: + +psz - string to check the length of + +cchMax - maximum number of characters including the null terminator +that psz is allowed to contain + +pcch - if the function succeeds and pcch is non-null, the current length +in characters of psz excluding the null terminator will be returned. +This out parameter is equivalent to the return value of strlen(psz) + +Notes: +psz can be null but the function will fail + +cchMax should be greater than zero or the function will fail + +Return Value: + +S_OK - psz is non-null and the length including the null +terminator is less than or equal to cchMax characters + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define UnalignedStringCchLength UnalignedStringCchLengthW + + +#else + + +#define UnalignedStringCchLength StringCchLengthA + + +#endif // !UNICODE + + +#ifdef ALIGNMENT_MACHINE +_Must_inspect_result_ +STRSAFEAPI + UnalignedStringCchLengthW( + _In_reads_or_z_(cchMax) STRSAFE_PCUNZWCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) size_t* pcchLength) +{ + HRESULT hr; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = UnalignedStringLengthWorkerW(psz, cchMax, pcchLength); + } + + if (FAILED(hr) && pcchLength) + { + *pcchLength = 0; + } + + return hr; +} + +#else +#define UnalignedStringCchLengthW StringCchLengthW +#endif // !ALIGNMENT_MACHINE + + +#endif // !STRSAFE_NO_CCH_FUNCTIONS + +#ifndef STRSAFE_NO_CB_FUNCTIONS +/*++ + + STDAPI + UnalignedStringCbLength( + _In_reads_or_z_(cbMax) LPCUTSTR psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(TCHAR)) size_t cbMax, + _Out_opt_ _Deref_out_range_(<, cbMax) size_t* pcbLength OPTIONAL + ); + + Routine Description: + + This routine is a version of StringCbLength that accepts an unaligned string pointer. + + This function returns a hresult, and not a pointer. It returns + S_OK if the string is non-null and the length including the null + terminator is less than or equal to cbMax bytes. + +Arguments: + +psz - string to check the length of + +cbMax - maximum number of bytes including the null terminator +that psz is allowed to contain + +pcb - if the function succeeds and pcb is non-null, the current length +in bytes of psz excluding the null terminator will be returned. +This out parameter is equivalent to the return value of strlen(psz) * sizeof(TCHAR) + +Notes: +psz can be null but the function will fail + +cbMax should be greater than or equal to sizeof(TCHAR) or the function will fail + +Return Value: + +S_OK - psz is non-null and the length including the null +terminator is less than or equal to cbMax bytes + +failure - you can use the macro HRESULT_CODE() to get a win32 +error code for all hresult failure cases + +It is strongly recommended to use the SUCCEEDED() / FAILED() macros to test the +return value of this function. + +--*/ +#ifdef UNICODE + + +#define UnalignedStringCbLength UnalignedStringCbLengthW + + +#else + + +#define UnalignedStringCbLength StringCbLengthA + + +#endif // !UNICODE + + +#ifdef ALIGNMENT_MACHINE +_Must_inspect_result_ +STRSAFEAPI + UnalignedStringCbLengthW( + _In_reads_or_z_(cbMax / sizeof(wchar_t)) STRSAFE_PCUNZWCH psz, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(wchar_t)) size_t cbMax, + _Out_opt_ _Deref_out_range_(<, cbMax - 1) size_t* pcbLength) +{ + HRESULT hr; + size_t cchMax = cbMax / sizeof(wchar_t); + size_t cchLength = 0; + + if ((psz == NULL) || (cchMax > STRSAFE_MAX_CCH)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else + { + hr = UnalignedStringLengthWorkerW(psz, cchMax, &cchLength); + } + + if (pcbLength) + { + if (SUCCEEDED(hr)) + { + // safe to multiply cchLength * sizeof(wchar_t) since cchLength < STRSAFE_MAX_CCH and sizeof(wchar_t) is 2 + *pcbLength = cchLength * sizeof(wchar_t); + } + else + { + *pcbLength = 0; + } + } + + return hr; +} +#else +#define UnalignedStringCbLengthW StringCbLengthW + +#endif // !ALIGNMENT_MACHINE + + +#endif // !STRSAFE_NO_CB_FUNCTIONS + + +#endif // !STRSAFE_LIB_IMPL + +// Below here are the worker functions that actually do the work + +#if defined(STRSAFE_LIB_IMPL) || !defined(STRSAFE_LIB) + +#pragma warning(push) +#pragma warning(disable:__WARNING_RETURNING_BAD_RESULT) + + +STRSAFEWORKERAPI + StringLengthWorkerA( + _In_reads_or_z_(cchMax) STRSAFE_PCNZCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength) +{ + HRESULT hr = S_OK; + size_t cchOriginalMax = cchMax; + + while (cchMax && (*psz != '\0')) + { + psz++; + cchMax--; + } + + if (cchMax == 0) + { + // the string is longer than cchMax + hr = STRSAFE_E_INVALID_PARAMETER; + } + + if (pcchLength) + { + if (SUCCEEDED(hr)) + { + *pcchLength = cchOriginalMax - cchMax; + } + else + { + *pcchLength = 0; + } + } + + return hr; +} + + + +STRSAFEWORKERAPI + StringLengthWorkerW( + _In_reads_or_z_(cchMax) STRSAFE_PCNZWCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) _Deref_out_range_(<=, _String_length_(psz)) size_t* pcchLength) +{ + HRESULT hr = S_OK; + size_t cchOriginalMax = cchMax; + + while (cchMax && (*psz != L'\0')) + { + psz++; + cchMax--; + } + + if (cchMax == 0) + { + // the string is longer than cchMax + hr = STRSAFE_E_INVALID_PARAMETER; + } + + if (pcchLength) + { + if (SUCCEEDED(hr)) + { + *pcchLength = cchOriginalMax - cchMax; + } + else + { + *pcchLength = 0; + } + } + + return hr; +} + +#ifdef ALIGNMENT_MACHINE +STRSAFEWORKERAPI + UnalignedStringLengthWorkerW( + _In_reads_or_z_(cchMax) STRSAFE_PCUNZWCH psz, + _In_ _In_range_(<=, STRSAFE_MAX_CCH) size_t cchMax, + _Out_opt_ _Deref_out_range_(<, cchMax) size_t* pcchLength) +{ + HRESULT hr = S_OK; + size_t cchOriginalMax = cchMax; + + while (cchMax && (*psz != L'\0')) + { + psz++; + cchMax--; + } + + if (cchMax == 0) + { + // the string is longer than cchMax + hr = STRSAFE_E_INVALID_PARAMETER; + } + + if (pcchLength) + { + if (SUCCEEDED(hr)) + { + *pcchLength = cchOriginalMax - cchMax; + } + else + { + *pcchLength = 0; + } + } + + return hr; +} +#endif // ALIGNMENT_MACHINE + + +#pragma warning(pop) + +// Intentionally allow null deref when STRSAFE_IGNORE_NULLS is not present. +#pragma warning(push) +#pragma warning(disable : __WARNING_DEREF_NULL_PTR) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_1) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_3) +#pragma warning(disable : __WARNING_RETURNING_BAD_RESULT) +#pragma warning(disable : __WARNING_MISSING_ZERO_TERMINATION2) + + + _When_(_Old_(*ppszSrc) != NULL, _Unchanged_(*ppszSrc)) +_When_(_Old_(*ppszSrc) == NULL, _At_(*ppszSrc, _Post_z_)) + STRSAFEWORKERAPI + StringExValidateSrcA( + _Inout_ _Deref_post_notnull_ STRSAFE_PCNZCH* ppszSrc, + _Inout_opt_ + _Deref_out_range_(<, cchMax) + _Deref_out_range_(<=, _Old_(*pcchToRead)) size_t* pcchToRead, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr = S_OK; + + if (pcchToRead && (*pcchToRead >= cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if ((dwFlags & STRSAFE_IGNORE_NULLS) && (*ppszSrc == NULL)) + { + *ppszSrc = ""; + + if (pcchToRead) + { + *pcchToRead = 0; + } + } + + return hr; +} + + + + _When_(_Old_(*ppszSrc) != NULL, _Unchanged_(*ppszSrc)) +_When_(_Old_(*ppszSrc) == NULL, _At_(*ppszSrc, _Post_z_)) + STRSAFEWORKERAPI + StringExValidateSrcW( + _Inout_ _Deref_post_notnull_ STRSAFE_PCNZWCH* ppszSrc, + _Inout_opt_ + _Deref_out_range_(<, cchMax) + _Deref_out_range_(<=, _Old_(*pcchToRead)) size_t* pcchToRead, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr = S_OK; + + if (pcchToRead && (*pcchToRead >= cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + else if ((dwFlags & STRSAFE_IGNORE_NULLS) && (*ppszSrc == NULL)) + { + *ppszSrc = L""; + + if (pcchToRead) + { + *pcchToRead = 0; + } + } + + return hr; +} + + +#pragma warning(pop) // allow null deref + + +#pragma warning(push) +#pragma warning(disable : 4100) // Unused parameter (pszDest) +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) + STRSAFEWORKERAPI + StringValidateDestA( + _In_reads_opt_(cchDest) STRSAFE_PCNZCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax) +{ + HRESULT hr = S_OK; + + if ((cchDest == 0) || (cchDest > cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + + return hr; +} +#pragma warning(pop) + +// Intentionally allow null deref when STRSAFE_IGNORE_NULLS is not present. +#pragma warning(push) +#pragma warning(disable : __WARNING_DEREF_NULL_PTR) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_1) +#pragma warning(disable : __WARNING_RANGE_POSTCONDITION_VIOLATION) + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) + STRSAFEWORKERAPI + StringValidateDestAndLengthA( + _In_reads_opt_(cchDest) STRSAFE_LPCSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, cchDest - 1) size_t* pcchDestLength, + _In_ const size_t cchMax) +{ + HRESULT hr; + + hr = StringValidateDestA(pszDest, cchDest, cchMax); + + if (SUCCEEDED(hr)) + { + hr = StringLengthWorkerA(pszDest, cchDest, pcchDestLength); + } + else + { + *pcchDestLength = 0; + } + + return hr; +} +// End intentionally allow null deref. +#pragma warning(pop) + + + +#pragma warning(push) +#pragma warning(disable : 4100) // Unused parameter (pszDest) +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) + STRSAFEWORKERAPI + StringValidateDestW( + _In_reads_opt_(cchDest) STRSAFE_PCNZWCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax) +{ + HRESULT hr = S_OK; + + if ((cchDest == 0) || (cchDest > cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + + return hr; +} +#pragma warning(pop) + +// Intentionally allow null deref when STRSAFE_IGNORE_NULLS is not present. +#pragma warning(push) +#pragma warning(disable : __WARNING_DEREF_NULL_PTR) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_1) +#pragma warning(disable : __WARNING_RANGE_POSTCONDITION_VIOLATION) + +_Post_satisfies_(cchDest > 0 && cchDest <= cchMax) + STRSAFEWORKERAPI + StringValidateDestAndLengthW( + _In_reads_opt_(cchDest) STRSAFE_LPCWSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, cchDest - 1) size_t* pcchDestLength, + _In_ const size_t cchMax) +{ + HRESULT hr; + + hr = StringValidateDestW(pszDest, cchDest, cchMax); + + if (SUCCEEDED(hr)) + { + hr = StringLengthWorkerW(pszDest, cchDest, pcchDestLength); + } + else + { + *pcchDestLength = 0; + } + + return hr; +} +// End intentionally allow null deref. +#pragma warning(pop) + + + +STRSAFEWORKERAPI + StringExValidateDestA( + _In_reads_opt_(cchDest) STRSAFE_PCNZCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr = S_OK; + + if (dwFlags & STRSAFE_IGNORE_NULLS) + { + if (((pszDest == NULL) && (cchDest != 0)) || + (cchDest > cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + } + else + { + hr = StringValidateDestA(pszDest, cchDest, cchMax); + } + + return hr; +} + +// Intentionally allow null deref when STRSAFE_IGNORE_NULLS is not present. +#pragma warning(push) +#pragma warning(disable : __WARNING_DEREF_NULL_PTR) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_1) +STRSAFEWORKERAPI + StringExValidateDestAndLengthA( + _In_reads_opt_(cchDest) STRSAFE_LPCSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, (cchDest>0?cchDest-1:0)) size_t* pcchDestLength, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + if (dwFlags & STRSAFE_IGNORE_NULLS) + { + hr = StringExValidateDestA(pszDest, cchDest, cchMax, dwFlags); + + if (FAILED(hr) || (cchDest == 0)) + { + *pcchDestLength = 0; + } + else + { + hr = StringLengthWorkerA(pszDest, cchDest, pcchDestLength); + } + } + else + { + hr = StringValidateDestAndLengthA(pszDest, + cchDest, + pcchDestLength, + cchMax); + } + + return hr; +} +// End intentionally allow null deref. +#pragma warning(pop) + + + +STRSAFEWORKERAPI + StringExValidateDestW( + _In_reads_opt_(cchDest) STRSAFE_PCNZWCH pszDest, + _In_ size_t cchDest, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr = S_OK; + + if (dwFlags & STRSAFE_IGNORE_NULLS) + { + if (((pszDest == NULL) && (cchDest != 0)) || + (cchDest > cchMax)) + { + hr = STRSAFE_E_INVALID_PARAMETER; + } + } + else + { + hr = StringValidateDestW(pszDest, cchDest, cchMax); + } + + return hr; +} + +// Intentionally allow null deref when STRSAFE_IGNORE_NULLS is not present. +#pragma warning(push) +#pragma warning(disable : __WARNING_DEREF_NULL_PTR) +#pragma warning(disable : __WARNING_INVALID_PARAM_VALUE_1) +STRSAFEWORKERAPI + StringExValidateDestAndLengthW( + _In_reads_opt_(cchDest) STRSAFE_LPCWSTR pszDest, + _In_ size_t cchDest, + _Out_ _Deref_out_range_(0, (cchDest>0?cchDest-1:0)) size_t* pcchDestLength, + _In_ const size_t cchMax, + _In_ DWORD dwFlags) +{ + HRESULT hr; + + if (dwFlags & STRSAFE_IGNORE_NULLS) + { + hr = StringExValidateDestW(pszDest, cchDest, cchMax, dwFlags); + + if (FAILED(hr) || (cchDest == 0)) + { + *pcchDestLength = 0; + } + else + { + hr = StringLengthWorkerW(pszDest, cchDest, pcchDestLength); + } + } + else + { + hr = StringValidateDestAndLengthW(pszDest, + cchDest, + pcchDestLength, + cchMax); + } + + return hr; +} +// End intentionally allow null deref. +#pragma warning(pop) + + +#pragma warning(push) +#pragma warning(disable:__WARNING_RETURNING_BAD_RESULT) + + +STRSAFEWORKERAPI + StringCopyWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, (cchToCopy < cchDest) ? cchToCopy : (cchDest - 1))) size_t* pcchNewDestLength, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZCH pszSrc, + _In_ _In_range_(<, STRSAFE_MAX_CCH) size_t cchToCopy) +{ + HRESULT hr = S_OK; + size_t cchNewDestLength = 0; + + // ASSERT(cchDest != 0); + + while (cchDest && cchToCopy && (*pszSrc != '\0')) + { + *pszDest++ = *pszSrc++; + cchDest--; + cchToCopy--; + + cchNewDestLength++; + } + + if (cchDest == 0) + { + // we are going to truncate pszDest + pszDest--; + cchNewDestLength--; + + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + + *pszDest = '\0'; + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + + +STRSAFEWORKERAPI + StringCopyWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, (cchToCopy < cchDest) ? cchToCopy : (cchDest - 1))) size_t* pcchNewDestLength, + _In_reads_or_z_(cchToCopy) STRSAFE_PCNZWCH pszSrc, + _In_ _In_range_(<, STRSAFE_MAX_CCH) size_t cchToCopy) +{ + HRESULT hr = S_OK; + size_t cchNewDestLength = 0; + + // ASSERT(cchDest != 0); + + while (cchDest && cchToCopy && (*pszSrc != L'\0')) + { + *pszDest++ = *pszSrc++; + cchDest--; + cchToCopy--; + + cchNewDestLength++; + } + + if (cchDest == 0) + { + // we are going to truncate pszDest + pszDest--; + cchNewDestLength--; + + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + + *pszDest = L'\0'; + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + +#pragma warning(pop) + + +STRSAFEWORKERAPI + StringVPrintfWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength, + _In_ _Printf_format_string_ STRSAFE_LPCSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr = S_OK; + int iRet; + size_t cchMax; + size_t cchNewDestLength = 0; + + // leave the last space for the null terminator + cchMax = cchDest - 1; + +#if (STRSAFE_USE_SECURE_CRT == 1) && !defined(STRSAFE_LIB_IMPL) + iRet = _vsnprintf_s(pszDest, cchDest, cchMax, pszFormat, argList); +#else +#pragma warning(push) +#pragma warning(disable: __WARNING_BANNED_API_USAGE)// "STRSAFE not included" +#pragma warning(disable: __WARNING_UNSAFE_STRING_FUNCTION) // call to dangerous string function '_vsnprintf'. + iRet = _vsnprintf(pszDest, cchMax, pszFormat, argList); +#pragma warning(pop) +#endif + // ASSERT((iRet < 0) || (((size_t)iRet) <= cchMax)); + + if ((iRet < 0) || (((size_t)iRet) > cchMax)) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = '\0'; + + cchNewDestLength = cchMax; + + // we have truncated pszDest + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else if (((size_t)iRet) == cchMax) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = '\0'; + + cchNewDestLength = cchMax; + } + else + { + cchNewDestLength = (size_t)iRet; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + + + +#ifdef STRSAFE_LOCALE_FUNCTIONS + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFELOCALEWORKERAPI + StringVPrintf_lWorkerA( + _Out_writes_(cchDest) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Out_opt_ _Deref_out_range_(<=, cchDest - 1) size_t* pcchNewDestLength, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr = S_OK; + int iRet; + size_t cchMax; + size_t cchNewDestLength = 0; + + // leave the last space for the null terminator + cchMax = cchDest - 1; + +#if (STRSAFE_USE_SECURE_CRT == 1) && !defined(STRSAFE_LIB_IMPL) + iRet = _vsnprintf_s_l(pszDest, cchDest, cchMax, pszFormat, locale, argList); +#else + iRet = _vsnprintf_l(pszDest, cchMax, pszFormat, locale, argList); +#endif + // ASSERT((iRet < 0) || (((size_t)iRet) <= cchMax)); + + if ((iRet < 0) || (((size_t)iRet) > cchMax)) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = '\0'; + + cchNewDestLength = cchMax; + + // we have truncated pszDest + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else if (((size_t)iRet) == cchMax) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = '\0'; + + cchNewDestLength = cchMax; + } + else + { + cchNewDestLength = (size_t)iRet; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + +#pragma warning(pop) + +#endif // STRSAFE_LOCALE_FUNCTIONS + + + + +STRSAFEWORKERAPI + StringVPrintfWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength, + _In_ _Printf_format_string_ STRSAFE_LPCWSTR pszFormat, + _In_ va_list argList) +{ + HRESULT hr = S_OK; + int iRet; + size_t cchMax; + size_t cchNewDestLength = 0; + + // leave the last space for the null terminator + cchMax = cchDest - 1; + +#if (STRSAFE_USE_SECURE_CRT == 1) && !defined(STRSAFE_LIB_IMPL) + iRet = _vsnwprintf_s(pszDest, cchDest, cchMax, pszFormat, argList); +#else +#pragma warning(push) +#pragma warning(disable: __WARNING_BANNED_API_USAGE)// "STRSAFE not included" + iRet = _vsnwprintf(pszDest, cchMax, pszFormat, argList); +#pragma warning(pop) +#endif + // ASSERT((iRet < 0) || (((size_t)iRet) <= cchMax)); + + if ((iRet < 0) || (((size_t)iRet) > cchMax)) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = L'\0'; + + cchNewDestLength = cchMax; + + // we have truncated pszDest + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else if (((size_t)iRet) == cchMax) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = L'\0'; + + cchNewDestLength = cchMax; + } + else + { + cchNewDestLength = (size_t)iRet; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + + + +#ifdef STRSAFE_LOCALE_FUNCTIONS + +#pragma warning(push) +#pragma warning(disable: __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) + +STRSAFELOCALEWORKERAPI + StringVPrintf_lWorkerW( + _Out_writes_(cchDest) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Out_opt_ _Deref_out_range_(<=, cchDest - 1) size_t* pcchNewDestLength, + _In_ _Printf_format_string_params_(2) STRSAFE_LPCWSTR pszFormat, + _In_ _locale_t locale, + _In_ va_list argList) +{ + HRESULT hr = S_OK; + int iRet; + size_t cchMax; + size_t cchNewDestLength = 0; + + // leave the last space for the null terminator + cchMax = cchDest - 1; + +#if (STRSAFE_USE_SECURE_CRT == 1) && !defined(STRSAFE_LIB_IMPL) + iRet = _vsnwprintf_s_l(pszDest, cchDest, cchMax, pszFormat, locale, argList); +#else + iRet = _vsnwprintf_l(pszDest, cchMax, pszFormat, locale, argList); +#endif + // ASSERT((iRet < 0) || (((size_t)iRet) <= cchMax)); + + if ((iRet < 0) || (((size_t)iRet) > cchMax)) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = L'\0'; + + cchNewDestLength = cchMax; + + // we have truncated pszDest + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else if (((size_t)iRet) == cchMax) + { + // need to null terminate the string + pszDest += cchMax; + *pszDest = L'\0'; + + cchNewDestLength = cchMax; + } + else + { + cchNewDestLength = (size_t)iRet; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + +#pragma warning(pop) + +#endif // STRSAFE_LOCALE_FUNCTIONS + + +#endif // defined(STRSAFE_LIB_IMPL) || !defined(STRSAFE_LIB) + +#ifndef STRSAFE_LIB_IMPL +// the StringGetsWorkerA/W functions always run inline since we do not want to +// have a different strsafe lib versions each type of c runtime (eg msvcrt, +// libcmt, etc..) + + +STRSAFEAPI + StringGetsWorkerA( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<, cchDest>0?cchDest:1)) size_t* pcchNewDestLength) +{ + HRESULT hr = S_OK; + size_t cchNewDestLength = 0; + + if (cchDest == 1) + { + *pszDest = '\0'; + + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else + { + while (cchDest > 1) + { + char ch; + int i = getc(stdin); + + if (i == EOF) + { + if (cchNewDestLength == 0) + { + // we failed to read anything from stdin + hr = STRSAFE_E_END_OF_FILE; + } + + break; + } + + ch = (char)i; + + if (ch == '\n') + { + break; + } + + *pszDest++ = ch; + cchDest--; + + cchNewDestLength++; + } + + *pszDest = '\0'; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + + +STRSAFEAPI + StringGetsWorkerW( + _Out_writes_(cchDest) _Always_(_Post_z_) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH) size_t cchDest, + _Always_(_Out_opt_ _Deref_out_range_(<=, cchDest - 1)) size_t* pcchNewDestLength) +{ + HRESULT hr = S_OK; + size_t cchNewDestLength = 0; + + if (cchDest == 1) + { + *pszDest = '\0'; + + hr = STRSAFE_E_INSUFFICIENT_BUFFER; + } + else + { + while (cchDest > 1) + { + wchar_t ch = getwc(stdin); + // ASSERT(sizeof(wchar_t) == sizeof(wint_t)); + + if (ch == WEOF) + { + if (cchNewDestLength == 0) + { + // we failed to read anything from stdin + hr = STRSAFE_E_END_OF_FILE; + } + + break; + } + + if (ch == L'\n') + { + break; + } + + *pszDest++ = ch; + cchDest--; + + cchNewDestLength++; + } + + *pszDest = L'\0'; + } + + if (pcchNewDestLength) + { + *pcchNewDestLength = cchNewDestLength; + } + + return hr; +} + + +#endif // !STRSAFE_LIB_IMPL + +#if defined(STRSAFE_LIB_IMPL) || !defined(STRSAFE_LIB) + + +STRSAFEWORKERAPI + StringExHandleFillBehindNullA( + _Inout_updates_bytes_(cbRemaining) STRSAFE_LPSTR pszDestEnd, + _In_ size_t cbRemaining, + _In_ DWORD dwFlags) +{ + if (cbRemaining > sizeof(char)) + { + memset(pszDestEnd + 1, STRSAFE_GET_FILL_PATTERN(dwFlags), cbRemaining - sizeof(char)); + } + + return S_OK; +} + + + +STRSAFEWORKERAPI + StringExHandleFillBehindNullW( + _Inout_updates_bytes_(cbRemaining) STRSAFE_LPWSTR pszDestEnd, + _In_ size_t cbRemaining, + _In_ DWORD dwFlags) +{ + if (cbRemaining > sizeof(wchar_t)) + { + memset(pszDestEnd + 1, STRSAFE_GET_FILL_PATTERN(dwFlags), cbRemaining - sizeof(wchar_t)); + } + + return S_OK; +} + + +// ignore false positives due to complexity of bitflag usage +#pragma warning(push) +#pragma warning(disable : __WARNING_USING_UNINIT_VAR) +#pragma warning(disable : __WARNING_RETURN_UNINIT_VAR) +#pragma warning(disable : __WARNING_MISSING_ZERO_TERMINATION2) +#pragma warning(disable : __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) +#pragma warning(disable:__WARNING_POTENTIAL_RANGE_POSTCONDITION_VIOLATION) + + +_Success_(1) // always succeeds, no exit tests needed + STRSAFEWORKERAPI + StringExHandleOtherFlagsA( + _Out_writes_bytes_(cbDest) STRSAFE_LPSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(char)) size_t cbDest, + _In_ _In_range_(0, cbDest>sizeof(char)?(cbDest / sizeof(char)) - 1:0) size_t cchOriginalDestLength, + _Outptr_result_buffer_(*pcchRemaining) STRSAFE_LPSTR* ppszDestEnd, + _Out_ _Deref_out_range_(0, cbDest / sizeof(char)) size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + size_t cchDest = cbDest / sizeof(char); + + _Analysis_assume_(dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)); + + if ((cchDest > 0) && (dwFlags & STRSAFE_NO_TRUNCATION)) + { + char* pszOriginalDestEnd; + + pszOriginalDestEnd = pszDest + cchOriginalDestLength; + + *ppszDestEnd = pszOriginalDestEnd; + *pcchRemaining = cchDest - cchOriginalDestLength; + + // null terminate the end of the original string + *pszOriginalDestEnd = '\0'; + } + + if (dwFlags & STRSAFE_FILL_ON_FAILURE) + { + memset(pszDest, STRSAFE_GET_FILL_PATTERN(dwFlags), cbDest); + + if (STRSAFE_GET_FILL_PATTERN(dwFlags) == 0) + { + *ppszDestEnd = pszDest; + *pcchRemaining = cchDest; + _Analysis_assume_(*pszDest == '\0'); + } + else if (cchDest > 0) + { + char* pszDestEnd; + + pszDestEnd = pszDest + cchDest - 1; + + *ppszDestEnd = pszDestEnd; + *pcchRemaining = 1; + + // null terminate the end of the string + *pszDestEnd = L'\0'; + } + } + + if ((cchDest > 0) && (dwFlags & STRSAFE_NULL_ON_FAILURE)) + { + *ppszDestEnd = pszDest; + *pcchRemaining = cchDest; + + // null terminate the beginning of the string + *pszDest = '\0'; + } + + return S_OK; +} + + + +_Success_(1) // always succeeds, no exit tests needed + STRSAFEWORKERAPI + StringExHandleOtherFlagsW( + _Out_writes_bytes_(cbDest) STRSAFE_LPWSTR pszDest, + _In_ _In_range_(1, STRSAFE_MAX_CCH * sizeof(wchar_t)) size_t cbDest, + _In_ _In_range_(0, cbDest>sizeof(wchar_t)?(cbDest / sizeof(wchar_t)) - 1:0) size_t cchOriginalDestLength, + _Outptr_result_buffer_(*pcchRemaining) STRSAFE_LPWSTR* ppszDestEnd, + _Out_ _Deref_out_range_(0, cbDest / sizeof(wchar_t)) size_t* pcchRemaining, + _In_ DWORD dwFlags) +{ + size_t cchDest = cbDest / sizeof(wchar_t); + + _Analysis_assume_(dwFlags & (STRSAFE_NO_TRUNCATION | STRSAFE_FILL_ON_FAILURE | STRSAFE_NULL_ON_FAILURE)); + + if ((cchDest > 0) && (dwFlags & STRSAFE_NO_TRUNCATION)) + { + wchar_t* pszOriginalDestEnd; + + pszOriginalDestEnd = pszDest + cchOriginalDestLength; + + *ppszDestEnd = pszOriginalDestEnd; + *pcchRemaining = cchDest - cchOriginalDestLength; + + // null terminate the end of the original string + *pszOriginalDestEnd = L'\0'; + } + + if (dwFlags & STRSAFE_FILL_ON_FAILURE) + { + memset(pszDest, STRSAFE_GET_FILL_PATTERN(dwFlags), cbDest); + + if (STRSAFE_GET_FILL_PATTERN(dwFlags) == 0) + { + *ppszDestEnd = pszDest; + *pcchRemaining = cchDest; + _Analysis_assume_(cchDest == 0 || *pszDest == L'\0'); + } + else if (cchDest > 0) + { + wchar_t* pszDestEnd; + + pszDestEnd = pszDest + cchDest - 1; + + *ppszDestEnd = pszDestEnd; + *pcchRemaining = 1; + + // null terminate the end of the string + *pszDestEnd = L'\0'; + } + } + + if ((cchDest > 0) && (dwFlags & STRSAFE_NULL_ON_FAILURE)) + { + *ppszDestEnd = pszDest; + *pcchRemaining = cchDest; + + // null terminate the beginning of the string + *pszDest = L'\0'; + } + + return S_OK; +} + + +#pragma warning(pop) // ignore false positives due to complexity of bitflag usage + + + + +#endif // defined(STRSAFE_LIB_IMPL) || !defined(STRSAFE_LIB) + + +// Do not call these functions, they are worker functions for internal use within this file +#ifdef DEPRECATE_SUPPORTED +#pragma deprecated(StringLengthWorkerA) +#pragma deprecated(StringLengthWorkerW) +#pragma deprecated(UnalignedStringLengthWorkerW) +#pragma deprecated(StringExValidateSrcA) +#pragma deprecated(StringExValidateSrcW) +#pragma deprecated(StringValidateDestA) +#pragma deprecated(StringValidateDestAndLengthA) +#pragma deprecated(StringValidateDestW) +#pragma deprecated(StringValidateDestAndLengthW) +#pragma deprecated(StringExValidateDestA) +#pragma deprecated(StringExValidateDestAndLengthA) +#pragma deprecated(StringExValidateDestW) +#pragma deprecated(StringExValidateDestAndLengthW) +#pragma deprecated(StringCopyWorkerA) +#pragma deprecated(StringCopyWorkerW) +#pragma deprecated(StringVPrintfWorkerA) +#pragma deprecated(StringVPrintfWorkerW) +#pragma deprecated(StringGetsWorkerA) +#pragma deprecated(StringGetsWorkerW) +#pragma deprecated(StringExHandleFillBehindNullA) +#pragma deprecated(StringExHandleFillBehindNullW) +#pragma deprecated(StringExHandleOtherFlagsA) +#pragma deprecated(StringExHandleOtherFlagsW) +#else +#define StringLengthWorkerA StringLengthWorkerA_instead_use_StringCchLengthA_or_StringCbLengthA +#define StringLengthWorkerW StringLengthWorkerW_instead_use_StringCchLengthW_or_StringCbLengthW +#define UnalignedStringLengthWorkerW UnalignedStringLengthWorkerW_instead_use_UnalignedStringCchLengthW +#define StringExValidateSrcA StringExValidateSrcA_do_not_call_this_function +#define StringExValidateSrcW StringExValidateSrcW_do_not_call_this_function +#define StringValidateDestA StringValidateDestA_do_not_call_this_function +#define StringValidateDestAndLengthA StringValidateDestAndLengthA_do_not_call_this_function +#define StringValidateDestW StringValidateDestW_do_not_call_this_function +#define StringValidateDestAndLengthW StringValidateDestAndLengthW_do_not_call_this_function +#define StringExValidateDestA StringExValidateDestA_do_not_call_this_function +#define StringExValidateDestAndLengthA StringExValidateDestAndLengthA_do_not_call_this_function +#define StringExValidateDestW StringExValidateDestW_do_not_call_this_function +#define StringExValidateDestAndLengthW StringExValidateDestAndLengthW_do_not_call_this_function +#define StringCopyWorkerA StringCopyWorkerA_instead_use_StringCchCopyA_or_StringCbCopyA +#define StringCopyWorkerW StringCopyWorkerW_instead_use_StringCchCopyW_or_StringCbCopyW +#define StringVPrintfWorkerA StringVPrintfWorkerA_instead_use_StringCchVPrintfA_or_StringCbVPrintfA +#define StringVPrintfWorkerW StringVPrintfWorkerW_instead_use_StringCchVPrintfW_or_StringCbVPrintfW +#define StringGetsWorkerA StringGetsWorkerA_instead_use_StringCchGetsA_or_StringCbGetsA +#define StringGetsWorkerW StringGetsWorkerW_instead_use_StringCchGetsW_or_StringCbGetsW +#define StringExHandleFillBehindNullA StringExHandleFillBehindNullA_do_not_call_this_function +#define StringExHandleFillBehindNullW StringExHandleFillBehindNullW_do_not_call_this_function +#define StringExHandleOtherFlagsA StringExHandleOtherFlagsA_do_not_call_this_function +#define StringExHandleOtherFlagsW StringExHandleOtherFlagsW_do_not_call_this_function +#endif // !DEPRECATE_SUPPORTED + + +#pragma warning(pop) +#pragma warning(pop) + +#endif // _STRSAFE_H_INCLUDED_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/suppress.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/suppress.h new file mode 100644 index 0000000000000000000000000000000000000000..1c0f4bb783ea1c758d7cce057c2de0e37acc88a8 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/suppress.h @@ -0,0 +1,907 @@ +#pragma once +// +// DO NOT EDIT THIS FILE +// +#if _MSC_VER <= 1400 +#pragma warning(disable: 4068) // turn off unknown pragma warning so prefast pragmas won't show + // show up in build.wrn/build.err +#endif + + + + + + +#define __WARNING_USING_UNINIT_VAR 6001 +#define __WARNING_DEREF_NULL_PTR 6011 +#define __WARNING_MEMORY_LEAK 6014 +#define __WARNING_USING_TAINTED_DATA 6029 +#define __WARNING_RETVAL_IGNORED_FUNC_COULD_FAIL 6031 +#define __WARNING_MISSING_ZERO_TERMINATION1 6053 +#define __WARNING_MISSING_ZERO_TERMINATION2 6054 +#define __WARNING_CHAR_BYTE_SIZE_MISMATCH 6057 +#define __WARNING_BAD_CONCATENATION 6059 +#define __WARNING_MISSING_STRING_ARGUMENT_TO_FORMAT_FUNCTION 6063 +#define __WARNING_MISSING_INTEGER_ARGUMENT_TO_FORMAT_FUNCTION 6064 +#define __WARNING_NON_POINTER_ARGUMENT_TO_FORMAT_FUNCTION 6066 +#define __WARNING_NON_STRING_ARGUMENT_TO_FORMAT_FUNCTION 6067 +#define __WARNING_INDEX_EXCEEDS_MAX_NONSTACK 6200 +#define __WARNING_INDEX_EXCEEDS_MAX 6201 +#define __WARNING_BUFFER_OVERRUN 6202 +#define __WARNING_BUFFER_OVERRUN_NONSTACK 6203 +#define __WARNING_UNVALIDATED_PARAM 6204 +#define __WARNING_SIZEOF_CHAR_BYTE_SIZE_MISMATCH 6209 +#define __WARNING_MEMORY_LEAK_EXCEPTION 6211 +#define __WARNING_CAST_HRESULT_TO_BOOL 6214 +#define __WARNING_CAST_BOOL_TO_HRESULT 6215 +#define __WARNING_COMPILER_INSERTED_CAST_BOOL_TO_HRESULT 6216 +#define __WARNING_TESTING_HRESULT_WITH_NOT 6217 +#define __WARNING_COMPARING_HRESULT_TO_ONE 6219 +#define __WARNING_COMPARING_HRESULT_TO_MINUS_ONE 6220 +#define __WARNING_COMPARING_HRESULT_TO_INT 6221 +#define __WARNING_ASSIGNING_ONE_TO_HRESULT 6225 +#define __WARNING_ASSIGNING_MINUS_ONE_TO_HRESULT 6226 +#define __WARNING_USING_HRESULT_IN_BOOLEAN_CONTEXT 6230 +#define __WARNING_NONZEROLOGICALOR 6235 +#define __WARNING_LOGICALORNONZERO 6236 +#define __WARNING_ZEROLOGICALANDLOSINGSIDEEFFECTS 6237 +#define __WARNING_NONZEROLOGICALAND 6239 +#define __WARNING_LOGICALANDNONZERO 6240 +#define __WARNING_LOCALUNWINDFORCED 6242 +#define __WARNING_LOCALDECLHIDESGLOBAL 6244 +#define __WARNING_LOCALDECLHIDESLOCAL 6246 +#define __WARNING_CREATINGNULLDACL 6248 +#define __WARNING_WIN32UNRELEASEDVADS 6250 +#define __WARNING_UNPROTECTEDUSEOFALLOCA 6255 +#define __WARNING_USINGTERMINATETHREAD 6258 +#define __WARNING_DEADCODEINBITORLIMITEDSWITCH 6259 +#define __WARNING_USEOFBYTEAREA 6260 +#define __WARNING_EXCESSIVESTACKUSAGE 6262 +#define __WARNING_USINGALLOCAINLOOP 6263 +#define __WARNING_STRING_LITERAL_TO_NONCONST_CAST 6267 +#define __WARNING_MISPARENTHESIZED_CASTS 6268 +#define __WARNING_POINTER_DEREF_DISCARDED 6269 +#define __WARNING_MISSING_FLOAT_ARGUMENT_TO_FORMAT_FUNCTION 6270 +#define __WARNING_EXTRA_ARGUMENT_TO_FORMAT_FUNCTION 6271 +#define __WARNING_NON_FLOAT_ARGUMENT_TO_FORMAT_FUNCTION 6272 +#define __WARNING_NON_INTEGER_ARGUMENT_TO_FORMAT_FUNCTION 6273 +#define __WARNING_NON_CHAR_ARGUMENT_TO_FORMAT_FUNCTION 6274 +#define __WARNING_CHAR_TO_WCHAR_CAST 6276 +#define __WARNING_CREATEPROCESS_ESCAPE 6277 +#define __WARNING_ARRAY_NEW_DELETE_MISMATCH 6278 +#define __WARNING_NEW_ARRAY_DELETE_MISMATCH 6279 +#define __WARNING_MEMORY_ALLOCATION_MISMATCH 6280 +#define __WARNING_BITWISERELATIONPRECEDENCEERROR 6281 +#define __WARNING_ASSIGNMENTREPLACESTEST 6282 +#define __WARNING_PRIMITIVE_ARRAY_NEW_DELETE_MISMATCH 6283 +#define __WARNING_OBJECT_AS_STRING_ARGUMENT_TO_FORMAT_FUNCTION 6284 +#define __WARNING_LOGICALOROFCONSTANTS 6285 +#define __WARNING_NONZEROLOGICALORLOSINGSIDEEFFECTS 6286 +#define __WARNING_REDUNDANTTEST 6287 +#define __WARNING_MUTUALINCLUSIONOVERANDISFALSE 6288 +#define __WARNING_MUTUALEXCLUSIONOVERORISTRUE 6289 +#define __WARNING_LOGICALNOTBITWISEAND 6290 +#define __WARNING_LOGICALNOTBITWISEOR 6291 +#define __WARNING_LOOP_COUNTS_UP_FROM_MAX 6292 +#define __WARNING_LOOP_INDEX_GOES_NEGATIVE 6293 +#define __WARNING_LOOP_BODY_NEVER_EXECUTED 6294 +#define __WARNING_INFINITE_LOOP 6295 +#define __WARNING_LOOP_ONLY_EXECUTED_ONCE 6296 +#define __WARNING_RESULTOFSHIFTCASTTOLARGERSIZE 6297 +#define __WARNING_CONST_STRING_TO_WRITABLE_STRING 6298 +#define __WARNING_BITFIELD_TO_BOOL_COMPARISON 6299 +#define __WARNING_CHAR_WCHAR_ARGUMENT_TO_FORMAT_FUNCTION 6302 +#define __WARNING_WCHAR_CHAR_ARGUMENT_TO_FORMAT_FUNCTION 6303 +#define __WARNING_SIZEOF_COUNTOF_MISMATCH 6305 +#define __WARNING_INCORRECT_VARARG_FUNCTIONCALL 6306 +#define __WARNING_WCHAR_TO_BSTR 6307 +#define __WARNING_REALLOCLEAK 6308 +#define __WARNING_PASSING_FUNCTION_UNEXPECTED_NULL 6309 +#define __WARNING_ILLEGALEXCEPTEXPRCONST 6310 +#define __WARNING_EXCEPTIONCONTINUEEXECUTION 6312 +#define __WARNING_BITANDVSZEROVALUEDFLAG 6313 +#define __WARNING_BITORVSQUESTION 6314 +#define __WARNING_BITORVSBITAND 6315 +#define __WARNING_INAPPROPRIATEUSEOFBITOR 6316 +#define __WARNING_NOTNOTCOMPLEMENT 6317 +#define __WARNING_EXCEPTIONCONTINUESEARCH 6318 +#define __WARNING_IGNOREDBYCOMMA 6319 +#define __WARNING_EXCEPTIONEXECUTEHANDLER 6320 +#define __WARNING_EXCEPT_BLOCK_EMPTY 6322 +#define __WARNING_ARITH_OP_ON_BOOL 6323 +#define __WARNING_STRCPY_INSTEAD_OF_STRCMP 6324 +#define __WARNING_CONST_CONST_COMP 6326 +#define __WARNING_DEST_BUFFER_INSUFFICIENT 6327 +#define __WARNING_POTENTIAL_INCORRECT_RETVAL_CHECK 6329 +#define __WARNING_POTENTIAL_ARGUMENT_TYPE_MISMATCH 6330 +#define __WARNING_VIRTUALFREEINVALIDPARAM1 6331 +#define __WARNING_VIRTUALFREEINVALIDPARAM2 6332 +#define __WARNING_VIRTUALFREEINVALIDPARAM3 6333 +#define __WARNING_SIZEOFEXPR 6334 +#define __WARNING_LEAKING_PROCESS_HANDLE 6335 +#define __WARNING_QUESTIONPRECEDENCE 6336 +#define __WARNING_SHUTDOWN_API 6381 +#define __WARNING_ELEMENTS_TO_BYTES 6383 +#define __WARNING_DIVIDING_SIZEOF_POINTER 6384 +#define __WARNING_READ_OVERRUN 6385 +#define __WARNING_WRITE_OVERRUN 6386 +#define __WARNING_INVALID_PARAM_VALUE_1 6387 +#define __WARNING_INVALID_PARAM_VALUE_2 6388 +#define __WARNING_BOOL_VARIANT_BOOL_COMPARISON 6392 +#define __WARNING_COMPARE64BIT 6393 +#define __WARNING_MS03_026_LHS 6394 +#define __WARNING_LOCALE_DEPENDENT_CONSTANT_STRING_COMPARISON 6400 +#define __WARNING_DEFAULT_LOCALE_CONSTANT_STRING_COMPARISON 6401 +#define __WARNING_INVALID_ATTRIBUTE_PROPERTY 6500 +#define __WARNING_CONFLICTING_ATTRIBUTE_PROPERTY_VALUES 6501 +#define __WARNING_REFERENCES_CANT_BE_NULL 6503 +#define __WARNING_NULL_ON_NON_POINTER 6504 +#define __WARNING_MUSTCHECK_ON_VOID 6505 +#define __WARNING_BUFFER_SIZE_ON_NON_POINTER_OR_ARRAY 6506 +#define __WARNING_NULL_MISMATCH_AT_DEREF_0 6507 +#define __WARNING_WRITE_ACCESS_ON_CONST 6508 +#define __WARNING_RETURN_USED_ON_PRECONDITION 6509 +#define __WARNING_NULLTERMINATED_ON_NON_POINTER 6510 +#define __WARNING_MUSTCHECK_MAYBE 6511 +#define __WARNING_NULL_CONFLICTS_WITH_NOT_VALID 6512 +#define __WARNING_ELEMENT_SIZE_WITHOUT_BUFFER_SIZE 6513 +#define __WARNING_BUFFER_SIZE_EXCEEDS_ARRAY_SIZE 6514 +#define __WARNING_BUFFER_SIZE_ON_NON_POINTER 6515 +#define __WARNING_NO_PROPERTIES_ON_ATTRIBUTE 6516 +#define __WARNING_VALID_SIZE_ON_NON_READABLE_BUFFER 6517 +#define __WARNING_WRITABLE_SIZE_ON_NON_WRITABLE_BUFFER 6518 +#define __WARNING_NEEDSRELEASE_MAYBE 6519 +#define __WARNING_INVALID_SIZE_STRING_DEREF 6521 +#define __WARNING_INVALID_SIZE_STRING_TYPE 6522 +#define __WARNING_INVALID_SIZE_STRING_PARAM 6523 +#define __WARNING_INVALID_SIZE_STRING_UNREACHABLE_LOCATION 6525 +#define __WARNING_INVALID_SIZE_STRING_BUFFER_TYPE 6526 +#define __WARNING_NEEDSRELEASE_ON_VOID 6527 +#define __WARNING_UNRECOGNIZED_FORMAT_STRING_STYLE 6530 +#define __WARNING_BUFFERSIZE_INFEASIBLE 6535 +#define __WARNING_OVERRIDING_OLD_MODEL 6540 +#define __WARNING_LIB_BADYESNO 6701 +#define __WARNING_LIB_BADSTRING 6702 +#define __WARNING_LIB_BADNUMBER 6703 +#define __WARNING_LIB_EXP_MISC 6704 +#define __WARNING_LIB_ANNOTE_ARITY 6705 +#define __WARNING_LIB_ANNOTE_MISC 6706 +#define __WARNING_LIB_MODEL_MISC 6707 +#define __WARNING_MANAGEDCODENOTSUPPORTED 6990 +#define __WARNING_ATTRIBUTESNOTSUPPORTED 6991 +#define __WARNING_NATIVEEVENTSYNTAXNOTSUPPORTED 6992 +#define __WARNING_OMPNOTSUPPORTED 6993 +#define __WARNING_PCHNOTFOUND 6994 +#define __WARNING__SAVETOXMLFAILED 6995 + + + +#define __WARNING_DUMMY_IO_WARNING1 22010 +#define __WARNING_ALLOC_SIZE_OVERFLOW 22011 +#define __WARNING_ALLOC_SIZE_WRONG_OVERFLOW_CHECK 22012 +#define __WARNING_INDEX_WRONG_OVERFLOW_CHECK 22013 +#define __WARNING_ALLOC_SIZE_NEGATIVE 22014 +#define __WARNING_INDEX_NEGATIVE 22015 +#define __WARNING_LOOP_INDEX_WRONG_OVERFLOW_CHECK 22016 +#define __WARNING_ALLOC_SIZE_UNDERFLOW 22017 +#define __WARNING_INDEX_UNDERFLOW 22018 +#define __WARNING_LOOP_INDEX_UNDERFLOW 22019 +#define __WARNING_SIGNED_UNSIGNED_COMPARISON 22020 +#define __WARNING_DIFF_SIZE_SIGNED_UNSIGNED_COMPARISON 22021 +#define __WARNING_ALLOC_SIZE_OVERFLOW_WITH_ACCESS 22022 +#define __WARNING_ALLOC_SIZE_OVERFLOW_IN_ALLOC_WRAPPER 22023 +#define __WARNING_ALLOC_SIZE_UNDERFLOW_IN_ALLOC_WRAPPER 22024 +#define __WARNING_RETVAL_IS_USED_IN_ALLOC_SIZE_COMPUTATION 22025 +#define __WARNING_REFARG_IS_USED_IN_ALLOC_SIZE_COMPUTATION 22026 +#define __WARNING_OVERFLOW_OR_UNDERFLOW_IN_ALLOCATOR_SIZE_FUNC_RETVAL 22027 +#define __WARNING_OVERFLOW_OR_UNDERFLOW_IN_ALLOCATOR_SIZE_FUNC_REFARG 22028 +#define __WARNING_OVERFLOW_OR_UNDERFLOW_IN_ALLOC_SIZE 22029 +#define __WARNING_OVERFLOW_OR_UNDERFLOW_IN_ALLOC_WRAPPER 22030 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_OVERFLOW 22051 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_WRONG_OVERFLOW_CHECK 22052 +#define __WARNING_UNTRUSTED_INDEX_WRONG_OVERFLOW_CHECK 22053 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_NEGATIVE 22054 +#define __WARNING_UNTRUSTED_INDEX_NEGATIVE 22055 +#define __WARNING_UNTRUSTED_LOOP_INDEX_WRONG_OVERFLOW_CHECK 22056 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_UNDERFLOW 22057 +#define __WARNING_UNTRUSTED_INDEX_UNDERFLOW 22058 +#define __WARNING_UNTRUSTED_LOOP_INDEX_UNDERFLOW 22059 +#define __WARNING_UNTRUSTED_SIGNED_UNSIGNED_COMPARISON 22060 +#define __WARNING_UNTRUSTED_DIFF_SIZE_SIGNED_UNSIGNED_COMPARISON 22061 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_OVERFLOW_WITH_ACCESS 22062 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_OVERFLOW_IN_ALLOC_WRAPPER 22063 +#define __WARNING_UNTRUSTED_ALLOC_SIZE_UNDERFLOW_IN_ALLOC_WRAPPER 22064 +#define __WARNING_UNTRUSTED_OVERFLOW_OR_UNDERFLOW_IN_ALLOCATOR_SIZE_FUNC_RETVAL 22067 +#define __WARNING_UNTRUSTED_OVERFLOW_OR_UNDERFLOW_IN_ALLOCATOR_SIZE_FUNC_REFARG 22068 +#define __WARNING_UNTRUSTED_OVERFLOW_OR_UNDERFLOW_IN_ALLOC_SIZE 22069 +#define __WARNING_UNTRUSTED_OVERFLOW_OR_UNDERFLOW_IN_ALLOC_WRAPPER 22070 +#define __WARNING_UNTRUSTED_ALLOC_SIZE 22081 +#define __WARNING_UNTRUSTED_INDEX 22082 +#define __WARNING_UNTRUSTED_LOOP_INDEX 22083 +#define __WARNING_UNTRUSTED_OVERFLOWN_EXPR 22084 +#define __WARNING_UNTRUSTED_UNDERFLOWN_EXPR 22085 + + + +#define __WARNING_UNRELATED_SIZE_BUFFER_ACCESS 22101 +#define __WARNING_UNRELATED_LOOP_TERMINATION 22102 +#define __WARNING_UNRELATED_LOOP_TERMINATION_NO_SIZEEXPR 22103 +#define __WARNING_BUFFER_COPY_NO_KNOWN_SIZEEXPR 22104 +#define __WARNING_BUFFER_COPY_NO_PREDICATE 22105 +#define __WARNING_BUFFER_COPY_SOURCE_LEN 22106 +#define __WARNING_BUFFER_COPY_STRUCT_FIELD_ANNOTATION 22107 +#define __WARNING_SIZEEXPR_NOT_REINIT 22108 +#define __WARNING_MOVE_OBJECT_WITH_VTABLE_TO_HEAP 22109 +#define __WARNING_ENCODE_GLOBAL_FUNCTION_POINTER 22110 +#define __WARNING_ENCODE_GLOBAL_DISPATCH_TABLE 22111 +#define __WARNING_ENCODE_MEMBER_FUNCTION_POINTER 22112 +#define __WARNING_ENCODE_MEMBER_DISPATCH_TABLE 22113 +#define __WARNING_MISSING_ENCODE_ASSIGNMENT 22114 +#define __WARNING_MISSING_DECODE_CALL 22115 +#define __WARNING_BUFFER_COPY_FUNCTION_NO_PREDICATE 22116 +#define __WARNING_SENDMESSAGE_WITHOUT_CHECKING_BUFFER_SIZE 22117 + + + +#define __WARNING_MISMATCH_RETURN_TYPE 23601 +#define __WARNING_MISMATCH_INITEXPR_TYPE 23602 +#define __WARNING_MISMATCH_ASSIGNMENT_TYPE 23603 +#define __WARNING_MISMATCH_FORMAL_TYPE_AT_CALL 23604 +#define __WARNING_MISMATCH_ADD_PROPERTY 23605 +#define __WARNING_MISMATCH_REMOVE_PROPERTY 23606 +#define __WARNING_MISMATCH_POST_TYPE 23607 +#define __WARNING_MISMATCH_FORMAL_VALID_AT_CALL 23608 +#define __WARNING_MISMATCH_FORMAL_VALIDSRC_AT_CALL 23609 +#define __WARNING_MISMATCH_REFERENCE_VALID 23610 +#define __WARNING_MISMATCH_REFERENCE_VALIDSRC 23611 +#define __WARNING_MISMATCH_MEMBER_VALID 23612 +#define __WARNING_MISMATCH_MEMBER_VALIDSRC 23613 +#define __WARNING_MISMATCH_IN_UNTRUSTED_DATA_SPECS 23614 +#define __WARNING_POTENTIAL_FILE_READ 23615 +#define __WARNING_CONSUMES_UNTRUSTED_DATA 23616 +#define __WARNING_MISMATCH_PUBLIC_FORMAL_VALID_AT_CALL 23617 +#define __WARNING_FILE_PARSER_CLASS 23620 +#define __WARNING_FILE_PARSER_FUNCTION 23621 +#define __WARNING_MISMATCH_RETURN_TYPE_COMPNAME 23622 +#define __WARNING_MISMATCH_INITEXPR_TYPE_COMPNAME 23623 +#define __WARNING_MISMATCH_ASSIGNMENT_TYPE_COMPNAME 23624 +#define __WARNING_MISMATCH_FORMAL_TYPE_AT_CALL_COMPNAME 23625 +#define __WARNING_MISMATCH_ADD_PROPERTY_COMPNAME 23626 +#define __WARNING_MISMATCH_REMOVE_PROPERTY_COMPNAME 23627 +#define __WARNING_MISMATCH_POST_TYPE_COMPNAME 23628 +#define __WARNING_ALLOCATOR 23629 + + + +#define __WARNING_IPV6_NAME_RESOLUTION_IPV4_SPECIFIC 24001 +#define __WARNING_IPV6_ADDRESS_STRUCTURE_IPV4_SPECIFIC 24002 +#define __WARNING_IPV6_MULTICAST_IPV4_SPECIFIC 24003 +#define __WARNING_IPV6_CONSTANT_IPV4_SPECIFIC 24004 +#define __WARNING_IPV6_OBSOLETE_FUNCTION 24005 +#define __WARNING_IPV6_DEPRECATED_FUNCTION 24006 +#define __WARNING_IPV6_USE_EX_VERSION 24007 +#define __WARNING_IPV6_INVALID_DEVICE 24008 +#define __WARNING_IPV6_DEPRECATED_IOCTL 24009 + + + +#define __WARNING_BIG_FORMAL_PARAM 25000 +#define __WARNING_IMPLICIT_CTOR 25001 +#define __WARNING_UPCAST_CTOR 25002 +#define __WARNING_NONCONST_LOCAL 25003 +#define __WARNING_NONCONST_PARAM 25004 +#define __WARNING_NONCONST_FUNCTION 25005 +#define __WARNING_UNUSED_PARAM 25006 +#define __WARNING_STATIC_FUNCTION 25007 +#define __WARNING_FREE_CONSTRUCTOR_CALL 25008 +#define __WARNING_IDENTITY_ASSIGNMENT 25009 +#define __WARNING_VIRTUAL_CALL_IN_CTOR 25010 +#define __WARNING_CASE_FALLTHRU 25011 +#define __WARNING_SMARTPOINTER_DELETE 25012 +#define __WARNING_RETURN_FROM_GOTO_CONTEXT 25013 +#define __WARNING_MISSING_OVERRIDE 25014 +#define __WARNING_DOESNT_OVERRIDE 25015 +#define __WARNING_OVERRIDE_CONST_MISMATCH 25016 +#define __WARNING_OVERRIDING_NONVIRTUAL 25017 +#define __WARNING_DIFFERENT_CALLING_CONVENTION 25018 +#define __WARNING_VERYBIG_FORMAL_PARAM 25019 +#define __WARNING_SAMENAME_DATAMEMBER 25020 +#define __WARNING_POOR_DATAALIGNMENT 25021 +#define __WARNING_REMOVERETURNCONST_FUNCTIONCAST 25022 +#define __WARNING_BOGUS_BSTRCONST 25023 +#define __WARNING_DANGEROUS_POINTERCAST 25024 +#define __WARNING_UNSAFE_STRING_FUNCTION 25025 +#define __WARNING_OBSOLETE_INI_ACCESSOR 25026 +#define __WARNING_BANNED_FUNCTION 25027 +#define __WARNING_FUNCTION_NEEDS_REVIEW 25028 +#define __WARNING_OBSOLETE_ACL_FUNCTION 25029 +#define __WARNING_BOGUS_EXPRESSION_LIST 25030 +#define __WARNING_HRESULT_NOT_CHECKED 25031 +#define __WARNING_NONCONST_LOCAL_BUFFERPTR 25032 +#define __WARNING_NONCONST_BUFFER_PARAM 25033 +#define __WARNING_SIZEOF_POINTER_IN_DIVISION 25035 +#define __WARNING_STATIC_MASKING_VIRTUAL 25036 +#define __WARNING_TRUE_CONSTANT_EXPR_IN_AND 25037 +#define __WARNING_FALSE_CONSTANT_EXPR_IN_AND 25038 +#define __WARNING_TRUE_CONSTANT_EXPR_IN_OR 25039 +#define __WARNING_FALSE_CONSTANT_EXPR_IN_OR 25040 +#define __WARNING_IF_CONDITION_IS_ALWAYS_TRUE 25041 +#define __WARNING_IF_CONDITION_IS_ALWAYS_FALSE 25042 +#define __WARNING_LOCAL_BSTR_SHOULD_BE_CONST_WCHAR_PTR 25043 +#define __WARNING_BSTR_PARAM_SHOULD_BE_CONST_WCHAR_PTR 25044 +#define __WARNING_ISBADPTR_FUNCTION 25045 +#define __WARNING_SPECIFY_SELECTANY 25046 +#define __WARNING_INCORRECT_SELECTANY 25047 +#define __WARNING_STRINGCONST_ASSIGNED_TO_NONCONST 25048 +#define __WARNING_FREESTANDING_CONSTANT 25049 +#define __WARNING_LOCAL_FUNCDECL 25050 +#define __WARNING_DIFFERENT_RETURN_TYPE_SIZE 25051 +#define __WARNING_DIFFERENT_RETURN_TYPE_KIND 25052 +#define __WARNING_DIFFERENT_PARAM_COUNT 25053 +#define __WARNING_DIFFERENT_PARAM_TYPE_SIZE 25054 +#define __WARNING_DIFFERENT_PARAM_TYPE_KIND 25055 +#define __WARNING_REMOVEPARAMCONST_FUNCTIONCAST 25056 +#define __WARNING_COUNT_REQUIRED_FOR_WRITABLE_BUFFER 25057 +#define __WARNING_CAST_CAN_BE_CONST 25058 +#define __WARNING_SUPERFLUOUS_CAST 25059 +#define __WARNING_SUPERFLUOUS_NOTNOT 25060 +#define __WARNING_BACKWARD_JUMP 25061 +#define __WARNING_BACKWARD_JUMP_IN_MACRO 25062 +#define __WARNING_FILEMAPPING_WITH_GLOBAL_NAME 25063 +#define __WARNING_FUNCTION_CALLED_TWICE_IN_MACRO 25064 +#define __WARNING_UNSIGNED_SHORT_NEGATIVE_INT_COMPARISON 25065 +#define __WARNING_OUTOFRANGE_SHORT_LONG_COMPARISON 25066 +#define __WARNING_UNREACHABLE_CASE_LABEL 25067 +#define __WARNING_USE_WIDE_API 25068 +#define __WARNING_GOTO 25069 +#define __WARNING_UNINITIALIZED_DATAMEMBER 25070 +#define __WARNING_NO_MEMBERINIT 25071 +#define __WARNING_WRONG_MEMBERINIT_ORDER 25073 +#define __WARNING_NOHEAP_MEMBER 25075 +#define __WARNING_NOHEAP_BASECLASS 25076 +#define __WARNING_NEW_ON_NOHEAP 25077 +#define __WARNING_CONDITIONAL_WITH_FALSE_TRUE 25078 +#define __WARNING_CONDITIONAL_WITH_TRUE_FALSE 25079 +#define __WARNING_CONDITIONAL_WITH_SAME_ALTERNATIVES 25080 +#define __WARNING_DANGEROUS_ALL_ACCESS_ACL 25084 +#define __WARNING_URL_NEEDS_TO_BE_REVIEWED 25085 +#define __WARNING_SD_REQUIRED_FOR_NAMED_OBJECT 25086 +#define __WARNING_UNSPECIFIED_ACCESSRIGHTS 25087 +#define __WARNING_DEPRECATED_WIN16_FUNCTION 25089 +#define __WARNING_USE_CPLUSPLUS_BOOL_CONST 25090 +#define __WARNING_RETURNTYPE_CAN_BE_BOOL 25091 +#define __WARNING_LOCAL_CAN_BE_BOOL 25092 +#define __WARNING_FORMAL_CAN_BE_BOOL 25093 +#define __WARNING_BASECLASS_SHOULDHAVE_PROTECTED_OR_VIRTUAL_DTOR 25094 +#define __WARNING_ENUM_TYPEDEF 25096 +#define __WARNING_INTEGRAL_CAST_TO_OBJECT_WITH_VTABLE 25098 +#define __WARNING_USE_PREFIX_OPERATOR 25099 +#define __WARNING_LHS_TEMP_OBJECT 25100 +#define __WARNING_RHS_TEMP_OBJECT 25101 +#define __WARNING_EXC_NOT_CAUGHT_BY_REFERENCE 25102 +#define __WARNING_EXC_NOT_THROWN_BY_VALUE 25103 +#define __WARNING_INCONSISTENT_DECLSPECS 25104 +#define __WARNING_SEALED_BASE_CLASS 25105 +#define __WARNING_SEALED_BASE_METHOD 25106 +#define __WARNING_NOTRUNCCAST_PARAM 25107 +#define __WARNING_UNBOUND_RETURN 25108 +#define __WARNING_MISSING_BINDRETURN 25109 +#define __WARNING_CLARYFY_PRECEDENCE_FOR_QUESTIONOPERATOR 25110 +#define __WARNING_DEPRECATED_FUNCTION 25112 +#define __WARNING_DEPRECATED_LANGUAGE_TYPE_USED 25113 +#define __WARNING_UNMARKED_INTL_DEPRECATED_FUNCTION 25114 +#define __WARNING_DEPRECATED_INTL_FUNCTION_CALL 25115 +#define __WARNING_OLEO_DEPRECATED_FUNCTION 25119 +#define __WARNING_COUNT_REQUIRED_FOR_VOIDPTR_BUFFER 25120 +#define __WARNING_RETURNING_TEMP_OBJECT 25124 +#define __WARNING_STRCPY_LOOP 25125 +#define __WARNING_POSSIBLE_STRCPY_LOOP 25126 +#define __WARNING_BOOLEAN_BITWISE_OPERATOR_MIX 25127 +#define __WARNING_DIFFERENT_COMPARE_ON_64BIT 25128 +#define __WARNING_POSSIBLE_64BIT_TRUNCATION 25129 +#define __WARNING_NONCONST_CLSID 25130 +#define __WARNING_EMPTY_DTOR 25131 +#define __WARNING_BY_VALUE_FORMAL_WITH_DTOR 25132 +#define __WARNING_BY_VALUE_TEMPLATEFORMAL_WITH_DTOR 25133 +#define __WARNING_IMPLICIT_TEMPLATECTOR 25134 +#define __WARNING_LOCAL_ARRAY_SHOULD_BE_STATIC 25135 +#define __WARNING_NONCONST_LOCAL_ARRAY 25136 +#define __WARNING_LOCAL_ARRAY_SHOULD_BE_PTR 25137 +#define __WARNING_STATIC_ARRAY_SHOULD_BE_LOCAL_PTR 25138 +#define __WARNING_EMPTY_NONPUBLIC_DTOR 25139 +#define __WARNING_DANGEROUS_INTTOPTR_CAST 25140 + + + +#define __WARNING_HUNGARIAN_INFERRED 25351 +#define __WARNING_MISSING_ANNOTATION 25352 +#define __WARNING_OVERRIDE_AT_NON_VIRTUAL 25353 +#define __WARNING_OVERRIDE_AT_STATIC 25354 +#define __WARNING_OVERRIDE_AT_BASECLASS 25355 +#define __WARNING_UNSUPPORTED_DEREF_VALUE 25356 +#define __WARNING_PRE_ANNOTATION_AT_RETURNVALUE 25357 +#define __WARNING_MISSING_NOTHROW_AT_DECL 25358 +#define __WARNING_DEPRECATED_OVERRIDE 25359 +#define __WARNING_OBSOLETE_OVERRIDE 25360 +#define __WARNING_ILLEGAL_BOUND_AT_PARAM 25361 +#define __WARNING_ILLEGAL_BOUND_AT_RETURN 25362 +#define __WARNING_ILLEGAL_DEREF_BOUND_AT_PARAM 25363 +#define __WARNING_ILLEGAL_DEREF_BOUND_AT_RETURN 25364 +#define __WARNING_ILLEGAL_RANGE_AT_PARAM 25365 +#define __WARNING_ILLEGAL_RANGE_AT_RETURN 25366 +#define __WARNING_ILLEGAL_DEREF_RANGE_AT_PARAM 25367 +#define __WARNING_ILLEGAL_DEREF_RANGE_AT_RETURN 25368 +#define __WARNING_PARAM_UPPERBOUND_LT_LOWERBOUND 25369 +#define __WARNING_RETURN_UPPERBOUND_LT_LOWERBOUND 25370 +#define __WARNING_NO_ANNOTATIONS_AT_DECLARATION 25371 +#define __WARNING_DECLSPEC_SAL_ANNOTATION 25372 + + + +#define __WARNING_BUFFER_OVERFLOW 26000 +#define __WARNING_BUFFER_UNDERFLOW 26001 +#define __WARNING_READ_UNTRACKED_BUFFER 26002 +#define __WARNING_UNTRACKED_BUFFER 26003 +#define __WARNING_UNINITIALIZED_POINTER 26004 +#define __WARNING_ZEROLENGTHARRAY 26005 +#define __WARNING_INCORRECT_ANNOTATION_STRING 26006 +#define __WARNING_INCORRECT_ANNOTATION 26007 +#define __WARNING_BUFFERACCESS 26009 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW 26010 +#define __WARNING_POTENTIAL_BUFFER_UNDERFLOW 26011 +#define __WARNING_UNTRACKED_BUFFER_BUT_UNANNOTATABLE 26012 +#define __WARNING_COMPLEX_EXPR 26013 +#define __WARNING_INCORRECT_VALIDATION 26014 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY 26015 +#define __WARNING_BUFFER_OVERFLOW_NULL_TERMINATED 26016 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW_MISC 26017 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW_NULLTERMINATED 26018 +#define __WARNING_INCORRECT_VALIDATION2 26019 + + + +#define __WARNING_INSANE_ANNOTATION 26020 +#define __WARNING_ANNOTATION_MISMATCH_MISSING_FIRST 26021 +#define __WARNING_ANNOTATION_MISMATCH_MISSING_SECOND 26022 +#define __WARNING_ANNOTATION_MISMATCH 26023 +#define __WARNING_ANNOTATION_MISMATCH_INTERNAL 26029 + + + +#define __WARNING_POSTCONDITION_BUFFER_OVERFLOW 26030 +#define __WARNING_POSTCONDITION_BUFFER_UNDERFLOW 26031 +#define __WARNING_PRECONDITION_NULLTERMINATION_VIOLATION 26035 +#define __WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION 26036 +#define __WARNING_POTENTIAL_NULLTERMINATION_VIOLATION 26037 +#define __WARNING_POTENTIAL_POSTCONDITION_BUFFER_OVERFLOW 26040 +#define __WARNING_POTENTIAL_POSTCONDITION_BUFFER_UNDERFLOW 26041 +#define __WARNING_INCORRECT_VALIDATION_POSTCONDITION 26044 +#define __WARNING_HIGH_PRIORITY_OVERFLOW_POSTCONDITION 26045 +#define __WARNING_CHECKER_ASSERTION_FAILURE 26050 +#define __WARNING_IRREDUCIBLE_CFG 26051 +#define __WARNING_POTENTIALLY_UNCONSTRAINED_CALL 26052 +#define __WARNING_POTENTIAL_BUFFER_OVERFLOW_LOOP_DEPENDENT 26053 +#define __WARNING_RANGE_PRECONDITION_VIOLATION 26060 +#define __WARNING_RANGE_POSTCONDITION_VIOLATION 26061 +#define __WARNING_POTENTIAL_RANGE_PRECONDITION_VIOLATION 26070 +#define __WARNING_POTENTIAL_RANGE_POSTCONDITION_VIOLATION 26071 +#define __WARNING_VALIDATED_ACCESS 26080 +#define __WARNING_USING_STRUCT_ANNOTATION 26081 +#define __WARNING_SUSPICIOUS_FUNCTION_POINTER_CAST 26090 + + + +#define __WARNING_RACE_CONDITION 26100 +#define __WARNING_INTERLOCKED_VIOLATION 26101 +#define __WARNING_RACE_CONDITION_VIA_PARAMETER 26102 +#define __WARNING_LOCKORDER_ACQUIRE_VIOLATION 26105 +#define __WARNING_LOCKORDER_RELEASE_VIOLATION 26106 +#define __WARNING_CALLER_FAILING_TO_HOLD 26110 +#define __WARNING_CALLER_FAILING_TO_RELEASE 26111 +#define __WARNING_CALLER_CANNOT_HOLD_ANY_LOCK 26112 +#define __WARNING_FAILING_TO_RELEASE 26115 +#define __WARNING_FAILING_TO_ACQUIRE 26116 +#define __WARNING_RELEASING_UNHELD_LOCK 26117 +#define __WARNING_DOUBLE_LOCK 26118 +#define __WARNING_NEED_NO_COMPETING_THREAD 26130 +#define __WARNING_NEED_REQUIRES_LOCK_HELD 26131 +#define __WARNING_NEED_SIDE_EFFECT 26135 +#define __WARNING_NEED_GUARDED_BY 26136 +#define __WARNING_NEED_INTERLOCKED 26137 +#define __WARNING_NEED_LOCK_ORDER 26138 +#define __WARNING_NEED_LOCK_PROPERTY 26139 +#define __WARNING_CSAL_ANNOTATION_ERROR 26140 +#define __WARNING_IGNORE_LOCK_CHECKING 26149 +#define __WARNING_RACE_CONDITION_MEDIUM_CONFIDENCE 26150 +#define __WARNING_INTERLOCKED_VIOLATION_MEDIUM_CONFIDENCE 26151 +#define __WARNING_RACE_CONDITION_VIA_PARAMETER_MEDIUM_CONFIDENCE 26152 +#define __WARNING_LOCKORDER_ACQUIRE_VIOLATION_MEDIUM_CONFIDENCE 26155 +#define __WARNING_LOCKORDER_RELEASE_VIOLATION_MEDIUM_CONFIDENCE 26156 +#define __WARNING_CALLER_FAILING_TO_HOLD_MEDIUM_CONFIDENCE 26160 +#define __WARNING_CALLER_FAILING_TO_RELEASE_MEDIUM_CONFIDENCE 26161 +#define __WARNING_CALLER_CANNOT_HOLD_ANY_LOCK_MEDIUM_CONFIDENCE 26162 +#define __WARNING_FAILING_TO_RELEASE_MEDIUM_CONFIDENCE 26165 +#define __WARNING_FAILING_TO_ACQUIRE_MEDIUM_CONFIDENCE 26166 +#define __WARNING_RELEASING_UNHELD_LOCK_MEDIUM_CONFIDENCE 26167 +#define __WARNING_DOUBLE_LOCK_MEDIUM_CONFIDENCE 26168 +#define __WARNING_NEED_NO_COMPETING_THREAD_MEDIUM_CONFIDENCE 26180 +#define __WARNING_NEED_REQUIRES_LOCK_HELD_MEDIUM_CONFIDENCE 26181 +#define __WARNING_NEED_SIDE_EFFECT_MEDIUM_CONFIDENCE 26185 +#define __WARNING_NEED_GUARDED_BY_MEDIUM_CONFIDENCE 26186 +#define __WARNING_NEED_INTERLOCKED_MEDIUM_CONFIDENCE 26187 +#define __WARNING_NEED_LOCK_ORDER_MEDIUM_CONFIDENCE 26188 +#define __WARNING_NEED_LOCK_PROPERTY_MEDIUM_CONFIDENCE 26189 + + + +#define __WARNING_DRIVER_FUNCTION_TYPE 28101 + + + +#define __WARNING_RESOURCE_LEAK 28103 +#define __WARNING_RESOURCE_NOT_ACQUIRED 28104 +#define __WARNING_RESOURCE_LEAK_EXCEPTION 28105 +#define __WARNING_ALREADY_HELD 28106 +#define __WARNING_MUST_HOLD 28107 +#define __WARNING_WRONG_KIND 28108 +#define __WARNING_MUST_NOT_HOLD 28109 + + + +#define __WARNING_FLOAT_IN_DRIVER 28110 +#define __WARNING_FP_IRQ_UNMATCHED 28111 +#define __WARNING_INTERLOCKED_ACCESS 28112 +#define __WARNING_INTERLOCKED_SCLASS 28113 +#define __WARNING_IRP_COPY 28114 +#define __WARNING_IRQ_TOO_LOW 28120 +#define __WARNING_IRQ_TOO_HIGH 28121 +#define __WARNING_INFERRED_IRQ_TOO_LOW 28122 +#define __WARNING_INFERRED_IRQ_TOO_HIGH 28123 +#define __WARNING_IRQ_SET_TOO_LOW 28124 +#define __WARNING_PROBE_NO_TRY 28125 +#define __WARNING_OBJ_REFERENCE_MODE 28126 +#define __WARNING_PROTOTYPE_MISMATCH 28127 +#define __WARNING_FUNCTION_ASSIGNMENT 28128 +#define __WARNING_MUST_BE_BITOP 28129 +#define __WARNING_NOT_COPYING_NAME 28131 +#define __WARNING_SIZEOF_POINTER 28132 +#define __WARNING_INITIALIZE_TIMER 28133 +#define __WARNING_POOL_TAG 28134 +#define __WARNING_KE_WAIT_LOCAL 28135 +#define __WARNING_ALWAYS_CONSTANT 28137 +#define __WARNING_NEVER_CONSTANT 28138 +#define __WARNING_STRICT_TYPE_MATCH 28139 +#define __WARNING_CRITICAL_OR_IRQ 28140 +#define __WARNING_IRQ_LOWERED_IMPROPERLY 28141 +#define __WARNING_RELEASE_CONSTANT 28142 +#define __WARNING_PENDING_STATUS_ERROR 28143 +#define __WARNING_CANCEL_IRQL_FROM_IRP 28144 +#define __WARNING_MODIFYING_MDL 28145 +#define __WARNING_STRSAFE_H 28146 +#define __WARNING_UNHELPFUL_TAG 28147 +#define __WARNING_IRQ_SET_TOO_HIGH 28150 +#define __WARNING_BAD_IRQL_VALUE 28151 +#define __WARNING_INIT_NOT_CLEARED 28152 +#define __WARNING_MODEL_BAD_IRQL 28153 +#define __WARNING_CLASS_MISMATCH_NONE 28155 +#define __WARNING_IRQ_INCORRECT 28156 +#define __WARNING_IRQL_NOT_USED 28157 +#define __WARNING_IRQL_NOT_SET 28158 + + + +#define __WARNING_USE_OTHER_FUNCTION 28159 +#define __WARNING_ERROR 28160 + + + +#define __WARNING_FLOAT_UNSAFE_EXIT 28161 +#define __WARNING_FLOAT_SAFE_EXIT 28162 +#define __WARNING_MUST_NOT_TRY 28163 +#define __WARNING_PVOID 28164 +#define __WARNING_CLASS_MISMATCH 28165 +#define __WARNING_NOT_SAME_IRQL 28166 +#define __WARNING_UNEXPECTED_IRQL_CHANGE 28167 +#define __WARNING_DISPATCH_MISMATCH 28168 +#define __WARNING_DISPATCH_MISSING 28169 +#define __WARNING_NO_PAGED_CODE 28170 +#define __WARNING_MULTIPLE_PAGED_CODE 28171 +#define __WARNING_NO_PAGING_SEGMENT 28172 +#define __WARNING_GET_ADAPTER_NOT_RETRIED 28173 +#define __WARNING_INACCESSIBLE_MEMBER 28175 +#define __WARNING_READ_ONLY_MEMBER 28176 +#define __WARNING_MULTIPLE_FUNCTION_CLASS 28177 + + + +#define __WARNING_DEREF_INTERMEDIATE_NULL_PTR 28181 +#define __WARNING_DEREF_RENAMED_NULL_PTR 28182 +#define __WARNING_INVALID_PARAM_VALUE_3 28183 +#define __WARNING_DEREF_PARAMETER_NULL_PTR 28184 +#define __WARNING_INVALID_PARAM_VALUE_4 28185 +#define __WARNING_MUST_HOLD_CLASS 28191 +#define __WARNING_MUST_NOT_HOLD_CLASS 28192 +#define __WARNING_MUST_USE 28193 +#define __WARNING_MEMORY_NOT_ALIASED 28194 +#define __WARNING_MEMORY_NOT_ACQUIRED 28195 +#define __WARNING_RETURNING_BAD_RESULT 28196 +#define __WARNING_ALIASED_MEMORY_LEAK 28197 +#define __WARNING_ALIASED_MEMORY_LEAK_EXCEPTION 28198 +#define __WARNING_MAYBE_UNINIT_VAR 28199 + + + +#define __WARNING_INTERNAL_DEBUG 28200 +#define __WARNING_XML_ANNOTATION 28201 +#define __WARNING_INVALID_ANNOTATION_SYMBOL 28209 +#define __WARNING_POST_EXPECTED 28210 +#define __WARNING_CONTEXT_EXPECTED 28211 +#define __WARNING_POINTER_EXPECTED 28212 +#define __WARNING_BAD_USEHEADER 28213 +#define __WARNING_BAD_PARAM_NAME 28214 +#define __WARNING_DUPLICATE_TYPEFIX 28215 +#define __WARNING_MUSTCHECK_NOT_POST 28216 +#define __WARNING_UNMATCHED_ANNO_COUNT 28217 +#define __WARNING_UNMATCHED_ANNO_TREE 28218 +#define __WARNING_ENUM_EXPECTED 28219 +#define __WARNING_INTEGER_EXPECTED 28220 +#define __WARNING_STRING_EXPECTED 28221 +#define __WARNING_YNM_EXPECTED 28222 +#define __WARNING_AUTOQUOTE_EXPECTED 28223 +#define __WARNING_PARAMS_EXPECTED 28224 +#define __WARNING_BAD_NO_PARAMS 28225 +#define __WARNING_NOT_BOTH 28226 +#define __WARNING_NOT_BOTH_2 28227 +#define __WARNING_UNRECOGNIZED_TYPE 28228 +#define __WARNING_NO_PARAMS_EXPECTED 28229 +#define __WARNING_NO_SUCH_MEMBER 28230 +#define __WARNING_ILLEGAL_INDEX 28231 +#define __WARNING_DANGLING_QUALIFIER 28232 +#define __WARNING_BLOCK_QUALIFIER 28233 +#define __WARNING_AT_NOT_ROOT 28234 +#define __WARNING_PRIMOP_AS_ANNOTATION 28235 +#define __WARNING_ANNOTATION_AS_PRIMOP 28236 +#define __WARNING_OBSOLETE 28237 +#define __WARNING_TOOMANY_OLD 28238 +#define __WARNING_MIXED_OLD_NEW 28239 +#define __WARNING_NO_PARAM1 28240 +#define __WARNING_EXTERNAL_UNKNOWN_ANNO 28241 +#define __WARNING_BAD_MULTIPLIER 28242 +#define __WARNING_BAD_DEREF 28243 +#define __WARNING_BAD_EXTERNAL 28244 +#define __WARNING_THIS_NONMEMBER 28245 +#define __WARNING_ANNOTATION_TYPE_MISMATCH 28246 +#define __WARNING_XML_DUPLICATE 28247 +#define __WARNING_XML_MODEL_FILE_DUPLICATE 28248 +#define __WARNING_UNMATCHED_DECL 28250 +#define __WARNING_UNMATCHED_DEFN 28251 +#define __WARNING_UNMATCHED_DECL_ANNO 28252 +#define __WARNING_UNMATCHED_DEFN_ANNO 28253 +#define __WARNING_DYNAMIC_CAST 28254 + + + +#define __WARNING_MODEL_SYNTAX_ERROR 28260 + + + +#define __WARNING_MODEL_SYNTAX_ERROR1 28261 +#define __WARNING_MODEL_SYNTAX_ERROR2 28262 +#define __WARNING_MUST_BE_CONSTANT 28264 + + + +#define __WARNING_MODEL_PLACEMENT_ERROR 28266 + + + +#define __WARNING_MODEL_PLACEMENT_ERROR1 28267 + + + +#define __WARNING_CLASS_MODEL_MISMATCH 28268 + + + +#define __WARNING_MISMATCHED_LIST 28272 +#define __WARNING_MISMATCHED_PREDICATE 28273 +#define __WARNING_MISMATCHED_PREDICATE1 28274 +#define __WARNING_NULL_MACRO_VALUE 28275 +#define __WARNING_NO_MACROS 28276 +#define __WARNING_NO_PROTOTYPE 28278 + + + +#define __WARNING_UNMATCHED_BEGIN 28279 +#define __WARNING_UNMATCHED_END 28280 +#define __WARNING_BAD_INVALID 28281 +#define __WARNING_FORMAT_NOT_PRE 28282 +#define __WARNING_UNSUPPORTED_SIZESPEC 28283 +#define __WARNING_SPEC_INVALID_PREDICATE 28284 +#define __WARNING_SPEC_INVALID_SYNTAX2 28285 +#define __WARNING_SPEC_INVALID_SYNTAX 28286 +#define __WARNING_INVALID_AT2 28287 +#define __WARNING_INVALID_AT 28288 +#define __WARNING_LIMITSPEC_EXPECTED 28289 +#define __WARNING_SPEC_TOO_MANY 28290 +#define __WARNING_LOD_0_NULL 28291 +#define __WARNING_MIN_SIZE_MULTIPLE 28292 +#define __WARNING_MIN_SIZE_UNKNOWN 28293 +#define __WARNING_EXTERNAL_UNKNOWN_PARAM 28294 +#define __WARNING_EXTERNAL_UNKNOWN_TYPE 28295 +#define __WARNING_MODEL_PARSE_CRASH 28296 +#define __WARNING_MODEL_PARSE_1 28297 +#define __WARNING_MODEL_TOO_MANY 28299 + + + +#define __WARNING_AVOID_BLOCKING_HWNDBROADCAST 28601 +#define __WARNING_AVOID_TIMEOUT_HWNDBROADCAST 28602 +#define __WARNING_AVOID_SENDMESSAGE_TIMEOUT_MISUSE 28604 +#define __WARNING_ALLOCA_RESETSTKOFLW 28615 +#define __WARNING_INTERLOCKEDDECREMENT_MISUSE1 28616 +#define __WARNING_AVOID_BEGIN_THREAD_RETURN_VALUE 28617 +#define __WARNING_UNSIGNED_CAST_OF_GETMESSAGEPOS 28623 +#define __WARNING_UNRELEASED_REF 28624 +#define __WARNING_COMPILER_OPTIMIZATES_OUT_CLEARING_SENSITIVEDATA 28625 +#define __WARNING_LOCAL_FREE_NONALLOCATED 28636 +#define __WARNING_UNSAFE_CALL_IN_GLOBAL_INIT 28637 +#define __WARNING_DLOAD_FUNCDEFN 28638 +#define __WARNING_CLOSEHANDLE_STRING 28639 +#define __WARNING_DLOAD_FUNCSTATIC 28640 +#define __WARNING_BAD_POSTMESSAGE_FLAG 28642 +#define __WARNING_DPA_INSERTPTR_RETURN 28644 +#define __WARNING_OBSOLETE_MESSAGE_SYMBOL_QUESTION 28645 +#define __WARNING_DO_NOT_USE_PULSEEVENT 28648 +#define __WARNING_REDUNDANT_CHECK_FOR_ARRAY_IS_NOT_NULL 28649 +#define __WARNING_IMPROPER_NOT_OPERATOR_ON_ZERO 28650 +#define __WARNING_NONSTATIC_FUNCPTR_IN_STATIC_INIT 28651 +#define __WARNING_BITOP_CALL_IN_STATIC_INIT 28652 +#define __WARNING_CAST_NTSTATUS_TO_BOOL 28714 +#define __WARNING_CAST_BOOL_TO_NTSTATUS 28715 +#define __WARNING_COMPILER_INSERTED_CAST_BOOL_TO_NTSTATUS 28716 +#define __WARNING_INVALID_VARIANT_TYPE 28717 +#define __WARNING_UNANNOTATED_BUFFER 28718 +#define __WARNING_BANNED_API_USAGE 28719 +#define __WARNING_ISBADXXXPTR_API_USAGE 28720 +#define __WARNING_DEPRECATED_PERF_COUNT 28721 +#define __WARNING_UNANNOTATED_BUFFER_IN_DECL 28722 +#define __WARNING_UNANNOTATED_BUFFER_IN_DEFN_WO_DECL 28723 +#define __WARNING_SETUNHANDLEDEXCEPTIONFILTER_USE 28725 +#define __WARNING_BANNED_API_USAGEL2 28726 +#define __WARNING_BANNED_API_USAGEL3 28727 +#define __WARNING_BANNED_API_USAGEL4 28728 +#define __WARNING_INCORRECT_NULLTERM_ASSIGN 28730 +#define __WARNING_RETAIL_DEBUGBREAK 28731 +#define __WARNING_THROW_DECL_MISMATCH 28732 +#define __WARNING_THROW_DECL_MISSING 28733 +#define __WARNING_CYCLOMATIC_COMPLEXITY 28734 +#define __WARNING_BANNED_CRIMSON_API_USAGE 28735 +#define __WARNING_BANNED_API_ARGUMENT_USAGE 28736 +#define __WARNING_UNANNOTATED_BUFFER_UCHAR 28740 +#define __WARNING_UNANNOTATED_BUFFER_PROTOTYPE 28741 +#define __WARNING_UNANNOTATED_BUFFER_PROTOTYPE_UCHAR 28742 + + + +#define __WARNING_OUT_NOTNULL_ON_FAILURE 28901 +#define __WARNING_QI_SUCCESS_NO_ADDREF 28903 +#define __WARNING_BUFFER_SIZE_EQUALS_COUNT 28910 +#define __WARNING_REDUNDANT_TEST_IN_MACRO 28920 +#define __WARNING_REDUNDANT_POINTER_TEST_CLEANUP 28921 +#define __WARNING_REDUNDANT_POINTER_TEST 28922 +#define __WARNING_REDUNDANT_SCALAR_TEST 28923 +#define __WARNING_REDUNDANT_POINTER_TEST_FAR_EVIDENCE 28924 +#define __WARNING_POTENTIALLY_REDUNDANT_GLOBAL_POINTER_TEST 28925 +#define __WARNING_UNUSED_POINTER_ASSIGNMENT 28930 +#define __WARNING_UNUSED_SCALAR_ASSIGNMENT 28931 +#define __WARNING_UNUSED_FORMALPARAM_ASSIGNMENT 28933 +#define __WARNING_UNUSED_PTR2PTR_FORMALPARAM_ASSIGNMENT 28934 +#define __WARNING_UNUSED_OUT_FORMALPARAM_ASSIGNMENT 28935 +#define __WARNING_UNREACHABLE_CODE 28940 +#define __WARNING_UNANNONATED_EXP_IN_VOLATILE_CONTEXT 28952 +#define __WARNING_UNEXPECED_LEVEL_IN_VOLATILE_CONTEXT 28953 +#define __WARNING_MULTIPLE_VOLATILE_ACCESS 28954 +#define __WARNING_MULTIPLE_VOLATILE_ACCESS_FROM_ANNOT 28955 +#define __WARNING_COMPILER_GENERATED_VOLATILE_CAST 28956 +#define __WARNING_LOCAL_VARIABLE_IN_VOLATILE_CONTEXT 28957 +#define __WARNING_MULTIPLE_VOLATILE_ACCESS_WITH_CALLS 28958 +#define __WARNING_MULTIPLE_VOLATILE_ACCESS_FROM_ANNOT_WITH_CALLS 28959 + + + +#define __WARNING_DEPRECATED_MSXML4 30001 + + + +#define __WARNING_ACCESSIBILITY_COLORAPI 30022 +#define __WARNING_ACCESSIBILITY_CLIPCURSOR 30023 + + + +#define __WARNING_TEMP_FILE 33700 +#define __WARNING_ZERO_DIVISION 33701 +#define __WARNING_ZERO_DIVISION_WITH_FIELD 33702 +#define __WARNING_PARAMETER_BUFFER_TO_STRUCT_CAST 33703 +#define __WARNING_MEMBER_BUFFER_TO_STRUCT_CAST 33704 +#define __WARNING_SAFE_AFTER_UNSAFE_ARITHMETIC 33705 +#define __WARNING_UNSAFE_AFTER_SAFE_ARITHMETIC 33706 +#define __WARNING_PARAMETER_BUFFER_IN_MEMCPY 33707 +#define __WARNING_MEMBER_BUFFER_IN_MEMCPY 33708 +#define __WARNING_PARAMETER_BUFFER_IN_WRITE_CALL 33709 +#define __WARNING_PARAMETER_BUFFER_IN_READ_CALL 33710 +#define __WARNING_MEMBER_BUFFER_IN_WRITE_CALL 33711 +#define __WARNING_MEMBER_BUFFER_IN_READ_CALL 33712 +#define __WARNING_PARAMETER_BUFFER_UPDATED_INSIDE_LOOP 33713 +#define __WARNING_PARAMETER_BUFFER_UPDATED_OUTSIDE_LOOP 33714 +#define __WARNING_MEMBER_BUFFER_UPDATED_INSIDE_LOOP 33715 +#define __WARNING_MEMBER_BUFFER_UPDATED_OUTSIDE_LOOP 33716 + + + +#define __WARNING_NDIS_DRIVER_PARAMETER_BUFFER 33801 +#define __WARNING_USE_FILE_DEVICE_SECURE_OPEN 33802 +#define __WARNING_USE_SUFFIXED_CALL 33803 +#define __WARNING_USE_RPC_IF_ALLOW_SECURE_ONLY 33804 + + + +#define __WARNING_X_INVALID_ATTRIBUTE_PROPERTY 36500 +#define __WARNING_X_CONFLICTING_ATTRIBUTE_PROPERTY_VALUES 36501 +#define __WARNING_X_REFERENCES_CANT_BE_NULL 36503 +#define __WARNING_X_NULL_ON_NON_POINTER 36504 +#define __WARNING_X_MUSTCHECK_ON_VOID 36505 +#define __WARNING_X_BUFFER_SIZE_ON_NON_POINTER_OR_ARRAY 36506 +#define __WARNING_X_NULL_MISMATCH_AT_DEREF_0 36507 +#define __WARNING_X_WRITE_ACCESS_ON_CONST 36508 +#define __WARNING_X_RETURN_USED_ON_PRECONDITION 36509 +#define __WARNING_X_NULLTERMINATED_ON_NON_POINTER 36510 +#define __WARNING_X_MUSTCHECK_MAYBE 36511 +#define __WARNING_X_NULL_CONFLICTS_WITH_NOT_VALID 36512 +#define __WARNING_X_ELEMENT_SIZE_WITHOUT_BUFFER_SIZE 36513 +#define __WARNING_X_BUFFER_SIZE_EXCEEDS_ARRAY_SIZE 36514 +#define __WARNING_X_BUFFER_SIZE_ON_NON_POINTER 36515 +#define __WARNING_X_NO_PROPERTIES_ON_ATTRIBUTE 36516 +#define __WARNING_X_VALID_SIZE_ON_NON_READABLE_BUFFER 36517 +#define __WARNING_X_WRITABLE_SIZE_ON_NON_WRITABLE_BUFFER 36518 +#define __WARNING_X_NEEDSRELEASE_MAYBE 36519 +#define __WARNING_X_INVALID_SIZE_STRING_DEREF 36521 +#define __WARNING_X_INVALID_SIZE_STRING_TYPE 36522 +#define __WARNING_X_INVALID_SIZE_STRING_PARAM 36523 +#define __WARNING_X_INVALID_SIZE_STRING_UNREACHABLE_LOCATION 36525 +#define __WARNING_X_INVALID_SIZE_STRING_BUFFER_TYPE 36526 +#define __WARNING_X_NEEDSRELEASE_ON_VOID 36527 +#define __WARNING_X_UNRECOGNIZED_FORMAT_STRING_STYLE 36530 +#define __WARNING_X_BUFFERSIZE_INFEASIBLE 36535 +#define __WARNING_X_OVERRIDING_OLD_MODEL 36540 +#define __WARNING_X_INVALID_SIZE_STRING_EXPRESSION 36551 +#define __WARNING_X_INVALID_DEREF_EXPRESSION 36552 + + + +#define __WARNING_LOCALE_SENSITIVE_STRCMP 38001 +#define __WARNING_LOCALE_SENSITIVE_COMPARESTRING 38002 +#define __WARNING_SYSTEM_LOCALE_MISUSE 38003 +#define __WARNING_DEPRECATED_LIBRARY 38004 +#define __WARNING_CALLING_SETTHREADLOCALE 38010 +#define __WARNING_OVERRIDING_LOCALE_SETTINGS_WITH_SETLOCALEINFO 38011 +#define __WARNING_ANSI_APICALL 38020 +#define __WARNING_W2A_BEST_FIT 38021 +#define __WARNING_CLIPBOARD_ANSI 38022 +#define __WARNING_ANSI_DATAFILE 38023 +#define __WARNING_HARD_CODED_STRING_TO_UI_FN 38030 +#define __WARNING_HARDCODED_FONT_INFO 38031 +#define __WARNING_CONSOLE_OUTPUT_ISSUE 38032 +#define __WARNING_FORMAT_MESSAGE_LANG 38033 +#define __WARNING_CONCATENATED_RESOURCE_STRING 38034 +#define __WARNING_LOCALIZABLE_STRING_FORMAT_ISSUE 38035 +#define __WARNING_MESSAGEBOX_RTL 38036 +#define __WARNING_BITMAP_OR_ANSI_FONT 38037 +#define __WARNING_COMMANDLINK_SETNOTE 38038 +#define __WARNING_SCREEN_COORDINATES_CONVERSION 38039 +#define __WARNING_GETDATEFORMAT_WRAPPER 38041 +#define __WARNING_GETDATEFORMAT_AUTOLAYOUT 38042 +#define __WARNING_LAYOUT_BITMAPORIENTATIONPRESERVED 38043 +#define __WARNING_LOC_METADATA_GENERATED 38044 +#define __WARNING_NON_LOCFRIENDLY_STRING_FORMATTING 38045 + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbs.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbs.h new file mode 100644 index 0000000000000000000000000000000000000000..c6e1f5d9037297752c528c366626da79fa49116b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbs.h @@ -0,0 +1,310 @@ +/*+-------------------------------------------------------------------------- + +Microsoft Windows +Copyright (c) Microsoft Corporation. All rights reserved. + +File: tbs.h + +Contents: Definitions and prototypes for the TBS (TPM Base Services) for + user mode(tbs.dll) and kernel mode(tbs.sys) + + +---------------------------------------------------------------------------*/ + +#ifndef _TBS_H_ +#define _TBS_H_ + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or SecureStartup Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_SECURESTARTUP) + +#if defined(__cplusplus) +extern "C" { +#endif + +#if (NTDDI_VERSION >= NTDDI_VISTA) + +#ifndef WINAPI +#define WINAPI __stdcall +#endif + +#define CONST const + +typedef signed int INT32, *PINT32; +typedef const INT32 *PCINT32; +typedef unsigned int UINT32, *PUINT32; +typedef const UINT32 *PCUINT32; + + +#define VOID void +typedef VOID *PVOID; +typedef const VOID *PCVOID; + +typedef INT32 BOOL, *PBOOL; +typedef const BOOL *PCBOOL; + +typedef UINT8 BYTE, *PBYTE; +typedef const BYTE *PCBYTE; + +typedef BOOL TBS_BOOL; +typedef UINT32 TBS_RESULT; +typedef PVOID TBS_HCONTEXT, *PTBS_HCONTEXT; +typedef UINT32 TBS_COMMAND_PRIORITY; +typedef UINT32 TBS_COMMAND_LOCALITY; +typedef UINT32 TBS_OWNERAUTH_TYPE; +typedef UINT32 TBS_HANDLE; + +#define TBS_CONTEXT_VERSION_ONE 1 + +#define TBS_COMMAND_PRIORITY_LOW 100 +#define TBS_COMMAND_PRIORITY_NORMAL 200 +#define TBS_COMMAND_PRIORITY_HIGH 300 +#define TBS_COMMAND_PRIORITY_SYSTEM 400 +#define TBS_COMMAND_PRIORITY_MAX 0x80000000 + +#define TBS_COMMAND_LOCALITY_ZERO 0 +#define TBS_COMMAND_LOCALITY_ONE 1 +#define TBS_COMMAND_LOCALITY_TWO 2 +#define TBS_COMMAND_LOCALITY_THREE 3 +#define TBS_COMMAND_LOCALITY_FOUR 4 + +#define TBS_SUCCESS 0 + +#define TBS_IN_OUT_BUF_SIZE_MAX (256*1024) + +#define TBS_OWNERAUTH_TYPE_FULL 1 +#define TBS_OWNERAUTH_TYPE_ADMIN 2 +#define TBS_OWNERAUTH_TYPE_USER 3 +#define TBS_OWNERAUTH_TYPE_ENDORSEMENT 4 + +// +// TPM 2.0 OwnerAuth types +// + +#define TBS_OWNERAUTH_TYPE_ENDORSEMENT_20 12 +#define TBS_OWNERAUTH_TYPE_STORAGE_20 13 + +typedef struct tdTBS_CONTEXT_PARAMS +{ + UINT32 version; +} TBS_CONTEXT_PARAMS, *PTBS_CONTEXT_PARAMS; +typedef const TBS_CONTEXT_PARAMS *PCTBS_CONTEXT_PARAMS; + +TBS_RESULT WINAPI +Tbsi_Context_Create( + _In_ PCTBS_CONTEXT_PARAMS pContextParams, + _Out_ PTBS_HCONTEXT phContext); + +TBS_RESULT WINAPI +Tbsi_Tpm_Vendor_Maintenance_Mode( + _In_ PCTBS_CONTEXT_PARAMS pContextParams, + _Out_ PTBS_HCONTEXT phContext); + +TBS_RESULT WINAPI +Tbsip_Context_Close( + _In_ TBS_HCONTEXT hContext); + +TBS_RESULT WINAPI +Tbsip_Submit_Command( + _In_ TBS_HCONTEXT hContext, + _In_ TBS_COMMAND_LOCALITY Locality, + _In_ TBS_COMMAND_PRIORITY Priority, + _In_reads_bytes_(cbCommand) PCBYTE pabCommand, + _In_ UINT32 cbCommand, + _Out_writes_bytes_(*pcbResult) PBYTE pabResult, + _Inout_ PUINT32 pcbResult); + +TBS_RESULT WINAPI +Tbsip_Cancel_Commands( + _In_ TBS_HCONTEXT hContext); + +TBS_RESULT WINAPI +Tbsi_Physical_Presence_Command( + _In_ TBS_HCONTEXT hContext, + _In_reads_bytes_(cbInput) PCBYTE pabInput, + _In_ UINT32 cbInput, + _Out_writes_bytes_(*pcbOutput) PBYTE pabOutput, + _Out_ PUINT32 pcbOutput); + +#endif // (NTDDI_VERSION >= NTDDI_VISTA) + +#if (NTDDI_VERSION >= NTDDI_VISTASP1) + +_Success_(return == TBS_SUCCESS) +TBS_RESULT WINAPI +Tbsi_Get_TCG_Log( + _In_ TBS_HCONTEXT hContext, + _Out_writes_bytes_to_opt_(*pOutputBufLen, *pOutputBufLen) PBYTE pOutputBuf, + _Inout_ PUINT32 pOutputBufLen); + +#endif // _WIN32_WINNT_VISTASP1 + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define TBS_CONTEXT_VERSION_TWO 2 + +// +// Alternate TBS_CONTEXT_PARAMS if version == TBS_CONTEXT_VERSION_TWO +// + +#pragma warning(push) +#pragma warning(disable: 4201) // nonstandard extension used : nameless struct/union + +typedef struct tdTBS_CONTEXT_PARAMS2 +{ + UINT32 version; + + union + { + struct + { + UINT32 requestRaw : 1; // if set to 1, request raw context + UINT32 includeTpm12 : 1; // if 1.2 device present, can use this + UINT32 includeTpm20 : 1; // if 2.0 device present, can use this + }; + UINT32 asUINT32; + }; +} TBS_CONTEXT_PARAMS2, *PTBS_CONTEXT_PARAMS2; +typedef const TBS_CONTEXT_PARAMS2 *PCTBS_CONTEXT_PARAMS2; + +#pragma warning(pop) + +// +// 32 byte structure used for the TPM Provisioning WNF notification. +// +typedef struct tdTPM_WNF_PROVISIONING +{ + UINT32 status; // 4 bytes + BYTE message[28]; // + 28 bytes +} TPM_WNF_PROVISIONING; // = 32 bytes + +#define TPM_WNF_INFO_CLEAR_SUCCESSFUL 0x00000001 +#define TPM_WNF_INFO_OWNERSHIP_SUCCESSFUL 0x00000002 + +#define TPM_WNF_INFO_NO_REBOOT_REQUIRED 1 + +#ifndef TPM_VERSION_UNKNOWN +// +// TPM device info. +// +#define TPM_VERSION_UNKNOWN 0 +#define TPM_VERSION_12 1 +#define TPM_VERSION_20 2 + +#define TPM_IFTYPE_UNKNOWN 0 +#define TPM_IFTYPE_1 1 // for 1.2 - use I/O-port or MMIO +#define TPM_IFTYPE_TRUSTZONE 2 // 2.0: Trustzone +#define TPM_IFTYPE_HW 3 // 2.0: HW TPM +#define TPM_IFTYPE_EMULATOR 4 // 2.0: SW-emulator +#define TPM_IFTYPE_SPB 5 // 2.0: SPB attached + +typedef struct _TPM_DEVICE_INFO +{ + UINT32 structVersion; // = 1 for now + UINT32 tpmVersion; // 1.2 / 2.0 + UINT32 tpmInterfaceType; // HW, simulator, ... + UINT32 tpmImpRevision; // code-drop revision, + // implenmentation-specific +} TPM_DEVICE_INFO, *PTPM_DEVICE_INFO; +typedef const TPM_DEVICE_INFO *PCTPM_DEVICE_INFO; +#endif //TPM_VERSION_UNKNOWN + +TBS_RESULT WINAPI +Tbsi_GetDeviceInfo( + _In_ UINT32 Size, + _Out_writes_bytes_(Size) PVOID Info); + +_Success_(return == TBS_SUCCESS) +TBS_RESULT WINAPI +Tbsi_Get_OwnerAuth( + _In_ TBS_HCONTEXT hContext, + _In_ TBS_OWNERAUTH_TYPE ownerauthType, + _Out_writes_bytes_to_opt_(*pOutputBufLen, *pOutputBufLen) PBYTE pOutputBuf, + _Inout_ PUINT32 pOutputBufLen); + +TBS_RESULT WINAPI +Tbsi_Revoke_Attestation(); + +#endif // (NTDDI_VERSION >= NTDDI_WIN8) + +#if (NTDDI_VERSION >= NTDDI_WINBLUE) + +#ifndef _NTDDK_ + +// These functions are not available in kernel mode + +HRESULT +GetDeviceID( + _Out_writes_bytes_to_opt_(cbWindowsAIK, *pcbResult) PBYTE pbWindowsAIK, + _In_ UINT32 cbWindowsAIK, + _Out_ PUINT32 pcbResult, + _Out_opt_ BOOL *pfProtectedByTPM); + +HRESULT +GetDeviceIDString( + _Out_writes_to_opt_(cchWindowsAIK, *pcchResult) PWSTR pszWindowsAIK, + _In_ UINT32 cchWindowsAIK, + _Out_ PUINT32 pcchResult, + _Out_opt_ BOOL *pfProtectedByTPM); + +#endif // ifndef _NTDDK_ + +#endif // (NTDDI_VERSION >= NTDDI_WINBLUE) + +#if (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +TBS_RESULT WINAPI +Tbsi_Create_Windows_Key( + __in TBS_HANDLE keyHandle); + +#endif // (NTDDI_VERSION >= NTDDI_WINTHRESHOLD) + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS4) + +// +// Log types for Tbsi_Get_TCG_Log_Ex +// + +#define TBS_TCGLOG_SRTM_CURRENT 0 +// Returns the SRTM log associated with the current session (boot or resume) +#define TBS_TCGLOG_DRTM_CURRENT 1 +// Returns the DRTM log associated with the current session (boot or resume) +#define TBS_TCGLOG_SRTM_BOOT 2 +// (User mode only) Returns the SRTM log associated with the most recent clean boot +#define TBS_TCGLOG_SRTM_RESUME 3 +// (User mode only) Returns the SRTM log associated with the current resume from hibernation +#define TBS_TCGLOG_DRTM_BOOT 4 +// (User mode only) Returns the DRTM log associated with the most recent clean boot +#define TBS_TCGLOG_DRTM_RESUME 5 +// (User mode only) Returns the DRTM log associated with the current resume from hibernation + +_Success_(return == TBS_SUCCESS) +TBS_RESULT WINAPI +Tbsi_Get_TCG_Log_Ex( + _In_ UINT32 logType, + _Out_writes_bytes_opt_(*pcbOutput) PBYTE pbOutput, + _Inout_ PUINT32 pcbOutput); + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_RS4) + +#if (NTDDI_VERSION >= NTDDI_WIN10_NI) + +inline BOOL WINAPI +Tbsi_Is_Tpm_Present(); + +#endif // (NTDDI_VERSION >= NTDDI_WIN10_NI) + +#if defined(__cplusplus) +} +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_SECURESTARTUP) */ +#pragma endregion + +#endif // ifndef _TBS_H_ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbt3ioctls.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbt3ioctls.h new file mode 100644 index 0000000000000000000000000000000000000000..f3dc865fde549ccb8e64871a1c539dc3d125fd2b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tbt3ioctls.h @@ -0,0 +1,92 @@ +/* +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + TBT3IOCTLS.H + +Abstract: + + Common header file for all user-mode IOCTLs defined for Thunderbolt 3 routers + +Environment: + + Kernel & user-mode + +--*/ + +#define NVM_DATA_LENGTH (16 * sizeof(DWORD)) + +/* {9013316D-7092-4E8E-8F9D-24214977ADCE} */ + +DEFINE_GUID(GUID_TBT3_FW_UPDATE_INTERFACE, +0x9013316D, 0x7092, 0x4E8E, 0x8F, 0x9D, 0x24, 0x21, 0x49, 0x77, 0xAD, 0xCE); + +#include + +typedef struct _TBT3_NVM_GET_UUID_OUTPUT { + ULONG64 Uuid; + USHORT ProductId; +} TBT3_GET_UUID_OUTPUT, *PTBT3_GET_UUID_OUTPUT; + +typedef struct _TBT3_NVM_WRITE_INPUT { + ULONG NVMOffset; + UCHAR Data[NVM_DATA_LENGTH]; +} TBT3_NVM_WRITE_INPUT, *PTBT3_NVM_WRITE_INPUT; + +typedef struct _TBT3_NVM_WRITE_OUTPUT { + ULONG NVMStatus; +} TBT3_NVM_WRITE_OUTPUT, *PTBT3_NVM_WRITE_OUTPUT; + +typedef struct _TBT3_NVM_WRITE_AUTHENTICATE_OUTPUT { + ULONG NVMStatus; +} TBT3_NVM_WRITE_AUTHENTICATE_OUTPUT, *PTBT3_NVM_WRITE_AUTHENTICATE_OUTPUT; + +typedef struct _TBT3_NVM_READ_INPUT { + ULONG NVMOffset; + USHORT DataLength; +} TBT3_NVM_READ_INPUT, *PTBT3_NVM_READ_INPUT; + +typedef struct _TBT3_NVM_READ_OUTPUT { + ULONG NVMStatus; + UCHAR Data[NVM_DATA_LENGTH]; +} TBT3_NVM_READ_OUTPUT, *PTBT3_NVM_READ_OUTPUT; + +#include + +#define TBT3_GET_UUID 2000 +#define TBT3_NVM_WRITE 2001 +#define TBT3_NVM_WRITE_AUTHENTICATE 2002 +#define TBT3_NVM_READ 2003 +#define TBT3_NVM_POWER_CYCLE 2004 + + +#define IOCTL_TBT3_GET_UUID \ + CTL_CODE(FILE_DEVICE_USB4,\ + TBT3_GET_UUID, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_TBT3_NVM_WRITE \ + CTL_CODE(FILE_DEVICE_USB4,\ + TBT3_NVM_WRITE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_TBT3_NVM_WRITE_AUTHENTICATE \ + CTL_CODE(FILE_DEVICE_USB4,\ + TBT3_NVM_WRITE_AUTHENTICATE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_TBT3_NVM_READ \ + CTL_CODE(FILE_DEVICE_USB4,\ + TBT3_NVM_READ, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_TBT3_NVM_POWER_CYCLE \ + CTL_CODE(FILE_DEVICE_USB4,\ + TBT3_NVM_POWER_CYCLE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpestats.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpestats.h new file mode 100644 index 0000000000000000000000000000000000000000..b09086d80cd115fac7432e58804a530c5e425105 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpestats.h @@ -0,0 +1,372 @@ +/*++ + +Copyright (c) 2000-2001 Microsoft Corporation + +Module Name: + + tcpestats.w + +Abstract: + + This module contains the definitions and structures for TCP extended + statistics. + +Author: + + Xinyan Zan (xinyanz) 30-June-2006 + +Environment: + + User mode and kernel mode + +--*/ +#ifndef _TCPESTATS_ +#define _TCPESTATS_ +#pragma once +#include + +#pragma region Desktop Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +// +// Please don't change the order of this enum. The order defined in this +// enum needs to match the order in EstatsToTcpObjectMappingTable. +// +typedef enum { + TcpConnectionEstatsSynOpts, + TcpConnectionEstatsData, + TcpConnectionEstatsSndCong, + TcpConnectionEstatsPath, + TcpConnectionEstatsSendBuff, + TcpConnectionEstatsRec, + TcpConnectionEstatsObsRec, + TcpConnectionEstatsBandwidth, + TcpConnectionEstatsFineRtt, + TcpConnectionEstatsMaximum, +} TCP_ESTATS_TYPE, *PTCP_ESTATS_TYPE; + +// +// TCP_BOOLEAN_OPTIONAL +// +// Define the states that a caller can specify when updating a boolean field. +// + +typedef enum _TCP_BOOLEAN_OPTIONAL { + TcpBoolOptDisabled = 0, + TcpBoolOptEnabled, + TcpBoolOptUnchanged = -1 +} TCP_BOOLEAN_OPTIONAL, *PTCP_BOOLEAN_OPTIONAL; + +// +// TCP_ESTATS_SYN_OPTS_ROS +// +// Define extended SYN-exchange information maintained for TCP connections. +// + +typedef struct _TCP_ESTATS_SYN_OPTS_ROS_v0 { + BOOLEAN ActiveOpen; + ULONG MssRcvd; + ULONG MssSent; +} TCP_ESTATS_SYN_OPTS_ROS_v0, *PTCP_ESTATS_SYN_OPTS_ROS_v0; + + +// +// TCP_SOFT_ERROR +// +// Enumerate the non-fatal errors recorded on each connection. +// + +typedef enum { + TcpErrorNone = 0, + TcpErrorBelowDataWindow, + TcpErrorAboveDataWindow, + TcpErrorBelowAckWindow, + TcpErrorAboveAckWindow, + TcpErrorBelowTsWindow, + TcpErrorAboveTsWindow, + TcpErrorDataChecksumError, + TcpErrorDataLengthError, + TcpErrorMaxSoftError +} TCP_SOFT_ERROR, *PTCP_SOFT_ERROR; + +// +// TCP_ESTATS_DATA_ROD +// +// Define extended data-transfer information for TCP connections. +// + +typedef struct _TCP_ESTATS_DATA_ROD_v0 { + ULONG64 DataBytesOut; + ULONG64 DataSegsOut; + ULONG64 DataBytesIn; + ULONG64 DataSegsIn; + ULONG64 SegsOut; + ULONG64 SegsIn; + ULONG SoftErrors; + ULONG SoftErrorReason; + ULONG SndUna; + ULONG SndNxt; + ULONG SndMax; + ULONG64 ThruBytesAcked; + ULONG RcvNxt; + ULONG64 ThruBytesReceived; +} TCP_ESTATS_DATA_ROD_v0, *PTCP_ESTATS_DATA_ROD_v0; + +// +// TCP_ESTATS_DATA_RW +// +// Define structure for enabling extended data-transfer information. +// + +typedef struct _TCP_ESTATS_DATA_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_DATA_RW_v0, *PTCP_ESTATS_DATA_RW_v0; + + +// +// TCP_ESTATS_SND_CONG_ROD +// +// Define extended sender-congestion information for TCP connections. +// + +typedef struct _TCP_ESTATS_SND_CONG_ROD_v0 { + ULONG SndLimTransRwin; + ULONG SndLimTimeRwin; + SIZE_T SndLimBytesRwin; + ULONG SndLimTransCwnd; + ULONG SndLimTimeCwnd; + SIZE_T SndLimBytesCwnd; + ULONG SndLimTransSnd; + ULONG SndLimTimeSnd; + SIZE_T SndLimBytesSnd; + ULONG SlowStart; + ULONG CongAvoid; + ULONG OtherReductions; + ULONG CurCwnd; + ULONG MaxSsCwnd; + ULONG MaxCaCwnd; + ULONG CurSsthresh; + ULONG MaxSsthresh; + ULONG MinSsthresh; +} TCP_ESTATS_SND_CONG_ROD_v0, *PTCP_ESTATS_SND_CONG_ROD_v0; + +// +// TCP_ESTATS_SND_CONG_ROS +// +// Define static extended sender-congestion information for TCP connections. + +typedef struct _TCP_ESTATS_SND_CONG_ROS_v0 { + ULONG LimCwnd; +} TCP_ESTATS_SND_CONG_ROS_v0, *PTCP_ESTATS_SND_CONG_ROS_v0; + +// +// TCP_ESTATS_SND_CONG_RW +// +// Define structure for enabling extended sender-congestion information. +// + +typedef struct _TCP_ESTATS_SND_CONG_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_SND_CONG_RW_v0, *PTCP_ESTATS_SND_CONG_RW_v0; + +// +// TCP_ESTATS_PATH_ROD +// +// Define extended path-measurement information for TCP connections. +// + +typedef struct _TCP_ESTATS_PATH_ROD_v0 { + ULONG FastRetran; + ULONG Timeouts; + ULONG SubsequentTimeouts; + ULONG CurTimeoutCount; + ULONG AbruptTimeouts; + ULONG PktsRetrans; + ULONG BytesRetrans; + ULONG DupAcksIn; + ULONG SacksRcvd; + ULONG SackBlocksRcvd; + ULONG CongSignals; + ULONG PreCongSumCwnd; + ULONG PreCongSumRtt; + ULONG PostCongSumRtt; + ULONG PostCongCountRtt; + ULONG EcnSignals; + ULONG EceRcvd; + ULONG SendStall; + ULONG QuenchRcvd; + ULONG RetranThresh; + ULONG SndDupAckEpisodes; + ULONG SumBytesReordered; + ULONG NonRecovDa; + ULONG NonRecovDaEpisodes; + ULONG AckAfterFr; + ULONG DsackDups; + ULONG SampleRtt; + ULONG SmoothedRtt; + ULONG RttVar; + ULONG MaxRtt; + ULONG MinRtt; + ULONG SumRtt; + ULONG CountRtt; + ULONG CurRto; + ULONG MaxRto; + ULONG MinRto; + ULONG CurMss; + ULONG MaxMss; + ULONG MinMss; + ULONG SpuriousRtoDetections; +} TCP_ESTATS_PATH_ROD_v0, *PTCP_ESTATS_PATH_ROD_v0; + +// +// TCP_ESTATS_PATH_ROS +// +// Define structure for enabling path-measurement information. +// + +typedef struct _TCP_ESTATS_PATH_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_PATH_RW_v0, *PTCP_ESTATS_PATH_RW_v0; + +// +// TCP_ESTATS_SEND_BUFF_ROD +// +// Define extended output-queuing information for TCP connections. +// + +typedef struct _TCP_ESTATS_SEND_BUFF_ROD_v0 { + SIZE_T CurRetxQueue; + SIZE_T MaxRetxQueue; + SIZE_T CurAppWQueue; + SIZE_T MaxAppWQueue; +} TCP_ESTATS_SEND_BUFF_ROD_v0, *PTCP_ESTATS_SEND_BUFF_ROD_v0; + +// +// TCP_ESTATS_SEND_BUFF_RW +// +// Define structure for enabling output-queuing information. +// + +typedef struct _TCP_ESTATS_SEND_BUFF_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_SEND_BUFF_RW_v0, *PTCP_ESTATS_SEND_BUFF_RW_v0; + + +// +// TCP_ESTATS_REC_ROD +// +// Define extended local-receiver information for TCP connections. +// + +typedef struct _TCP_ESTATS_REC_ROD_v0 { + ULONG CurRwinSent; + ULONG MaxRwinSent; + ULONG MinRwinSent; + ULONG LimRwin; + ULONG DupAckEpisodes; + ULONG DupAcksOut; + ULONG CeRcvd; + ULONG EcnSent; + ULONG EcnNoncesRcvd; + ULONG CurReasmQueue; + ULONG MaxReasmQueue; + SIZE_T CurAppRQueue; + SIZE_T MaxAppRQueue; + UCHAR WinScaleSent; +} TCP_ESTATS_REC_ROD_v0, *PTCP_ESTATS_REC_ROD_v0; + +// +// TCP_ESTATS_REC_RW +// +// Define structure for enabling local-receiver information. +// + +typedef struct _TCP_ESTATS_REC_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_REC_RW_v0, *PTCP_ESTATS_REC_RW_v0; + + +// +// TCP_ESTATS_OBS_REC_ROD +// +// Define extended remote-receiver information for TCP connections. +// + +typedef struct _TCP_ESTATS_OBS_REC_ROD_v0 { + ULONG CurRwinRcvd; + ULONG MaxRwinRcvd; + ULONG MinRwinRcvd; + UCHAR WinScaleRcvd; +} TCP_ESTATS_OBS_REC_ROD_v0, *PTCP_ESTATS_OBS_REC_ROD_v0; + + +// +// TCP_ESTATS_OBS_REC_RW +// +// Define structure for enabling remote-receiver information. +// + +typedef struct _TCP_ESTATS_OBS_REC_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_OBS_REC_RW_v0, *PTCP_ESTATS_OBS_REC_RW_v0; + + +// +// TCP_ESTATS_BW_RW +// +// Define the structure for enabling bandwidth estimation for TCP connections. +// + +typedef struct _TCP_ESTATS_BANDWIDTH_RW_v0 { + TCP_BOOLEAN_OPTIONAL EnableCollectionOutbound; + TCP_BOOLEAN_OPTIONAL EnableCollectionInbound; +} TCP_ESTATS_BANDWIDTH_RW_v0, *PTCP_ESTATS_BANDWIDTH_RW_v0; + +// +// TCP_ESTATS_BW_ROD +// +// Define bandwidth estimation statistics for TCP connections. +// +// Bandwidth and Instability metrics are expressed as bits per second. +// + +typedef struct _TCP_ESTATS_BANDWIDTH_ROD_v0 { + ULONG64 OutboundBandwidth; + ULONG64 InboundBandwidth; + ULONG64 OutboundInstability; + ULONG64 InboundInstability; + BOOLEAN OutboundBandwidthPeaked; + BOOLEAN InboundBandwidthPeaked; +} TCP_ESTATS_BANDWIDTH_ROD_v0, *PTCP_ESTATS_BANDWIDTH_ROD_v0; + +// +// TCP_ESTATS_FINE_RTT_RW +// +// Define the structure for enabling fine-grained RTT estimation for TCP +// connections. +// + +typedef struct _TCP_ESTATS_FINE_RTT_RW_v0 { + BOOLEAN EnableCollection; +} TCP_ESTATS_FINE_RTT_RW_v0, *PTCP_ESTATS_FINE_RTT_RW_v0; + + +// +// TCP_ESTATS_FINE_RTT_ROD +// +// Define fine-grained RTT estimation statistics for TCP connections. +// + +typedef struct _TCP_ESTATS_FINE_RTT_ROD_v0 { + ULONG RttVar; + ULONG MaxRtt; + ULONG MinRtt; + ULONG SumRtt; +} TCP_ESTATS_FINE_RTT_ROD_v0, *PTCP_ESTATS_FINE_RTT_ROD_v0; + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _TCPESTATS_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpmib.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpmib.h new file mode 100644 index 0000000000000000000000000000000000000000..9dcc2e0c02add862e25c30d9a7c084a3a0d21e2b --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tcpmib.h @@ -0,0 +1,342 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + tcpmib.h + +Abstract: + + This module contains the public definitions and structures for the + TCP-specific parts of MIB-II. These definitions were previously + in iprtrmib.h, which now includes this file. + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef _TCPMIB_ +#define _TCPMIB_ +#pragma once +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + +#ifndef ANY_SIZE +#define ANY_SIZE 1 +#endif + +#define TCPIP_OWNING_MODULE_SIZE 16 + +// +// TCP states, as defined in the MIB. +// +typedef enum { + MIB_TCP_STATE_CLOSED = 1, + MIB_TCP_STATE_LISTEN = 2, + MIB_TCP_STATE_SYN_SENT = 3, + MIB_TCP_STATE_SYN_RCVD = 4, + MIB_TCP_STATE_ESTAB = 5, + MIB_TCP_STATE_FIN_WAIT1 = 6, + MIB_TCP_STATE_FIN_WAIT2 = 7, + MIB_TCP_STATE_CLOSE_WAIT = 8, + MIB_TCP_STATE_CLOSING = 9, + MIB_TCP_STATE_LAST_ACK = 10, + MIB_TCP_STATE_TIME_WAIT = 11, + MIB_TCP_STATE_DELETE_TCB = 12, + // + // Extra TCP states not defined in the MIB + // + MIB_TCP_STATE_RESERVED = 100 +} MIB_TCP_STATE; + +// +// Various Offload states a TCP connection can be in. +// +typedef enum { + TcpConnectionOffloadStateInHost, + TcpConnectionOffloadStateOffloading, + TcpConnectionOffloadStateOffloaded, + TcpConnectionOffloadStateUploading, + TcpConnectionOffloadStateMax +} TCP_CONNECTION_OFFLOAD_STATE, *PTCP_CONNECTION_OFFLOAD_STATE; + +typedef struct _MIB_TCPROW_LH { + union { + DWORD dwState; // Old field used DWORD type. + MIB_TCP_STATE State; // New field uses enum type. + }; + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwRemoteAddr; + DWORD dwRemotePort; +} MIB_TCPROW_LH, *PMIB_TCPROW_LH; + +typedef struct _MIB_TCPROW_W2K { + DWORD dwState; + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwRemoteAddr; + DWORD dwRemotePort; +} MIB_TCPROW_W2K, *PMIB_TCPROW_W2K; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef MIB_TCPROW_LH MIB_TCPROW; +typedef MIB_TCPROW_LH *PMIB_TCPROW; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_TCPROW_W2K MIB_TCPROW; +typedef MIB_TCPROW_W2K *PMIB_TCPROW; +#else +typedef MIB_TCPROW_LH MIB_TCPROW; +typedef MIB_TCPROW_LH *PMIB_TCPROW; +#endif + +typedef struct _MIB_TCPTABLE { + DWORD dwNumEntries; + MIB_TCPROW table[ANY_SIZE]; +} MIB_TCPTABLE, *PMIB_TCPTABLE; + +#define SIZEOF_TCPTABLE(X) (FIELD_OFFSET(MIB_TCPTABLE,table[0]) + \ + ((X) * sizeof(MIB_TCPROW)) + ALIGN_SIZE) + +typedef struct _MIB_TCPROW2 { + DWORD dwState; + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwRemoteAddr; + DWORD dwRemotePort; + DWORD dwOwningPid; + TCP_CONNECTION_OFFLOAD_STATE dwOffloadState; +} MIB_TCPROW2, *PMIB_TCPROW2; + +typedef struct _MIB_TCPTABLE2 { + DWORD dwNumEntries; + MIB_TCPROW2 table[ANY_SIZE]; +} MIB_TCPTABLE2, *PMIB_TCPTABLE2; + +#define SIZEOF_TCPTABLE2(X) (FIELD_OFFSET(MIB_TCPTABLE2,table[0]) + \ + ((X) * sizeof(MIB_TCPROW2)) + ALIGN_SIZE) + +typedef struct _MIB_TCPROW_OWNER_PID +{ + DWORD dwState; + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwRemoteAddr; + DWORD dwRemotePort; + DWORD dwOwningPid; +} MIB_TCPROW_OWNER_PID, *PMIB_TCPROW_OWNER_PID; + +typedef struct _MIB_TCPTABLE_OWNER_PID +{ + DWORD dwNumEntries; + MIB_TCPROW_OWNER_PID table[ANY_SIZE]; +} MIB_TCPTABLE_OWNER_PID, *PMIB_TCPTABLE_OWNER_PID; + +#define SIZEOF_TCPTABLE_OWNER_PID(X) (FIELD_OFFSET(MIB_TCPTABLE_OWNER_PID, table[0]) + \ + ((X) * sizeof(MIB_TCPROW_OWNER_PID)) + ALIGN_SIZE) + +typedef struct _MIB_TCPROW_OWNER_MODULE { + DWORD dwState; + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwRemoteAddr; + DWORD dwRemotePort; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + ULONGLONG OwningModuleInfo [TCPIP_OWNING_MODULE_SIZE]; +} MIB_TCPROW_OWNER_MODULE, *PMIB_TCPROW_OWNER_MODULE; + +typedef struct _MIB_TCPTABLE_OWNER_MODULE +{ + DWORD dwNumEntries; + MIB_TCPROW_OWNER_MODULE table[ANY_SIZE]; +} MIB_TCPTABLE_OWNER_MODULE, *PMIB_TCPTABLE_OWNER_MODULE; + +#define SIZEOF_TCPTABLE_OWNER_MODULE(X) (FIELD_OFFSET(MIB_TCPTABLE_OWNER_MODULE, table[0]) + \ + ((X) * sizeof(MIB_TCPROW_OWNER_MODULE)) + ALIGN_SIZE) + +#ifdef _WS2IPDEF_ +// +// The following definitions require Winsock2. +// + +typedef struct _MIB_TCP6ROW { + MIB_TCP_STATE State; + IN6_ADDR LocalAddr; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + IN6_ADDR RemoteAddr; + DWORD dwRemoteScopeId; + DWORD dwRemotePort; +} MIB_TCP6ROW, *PMIB_TCP6ROW; + +typedef struct _MIB_TCP6TABLE { + DWORD dwNumEntries; + MIB_TCP6ROW table[ANY_SIZE]; +} MIB_TCP6TABLE, *PMIB_TCP6TABLE; + +#define SIZEOF_TCP6TABLE(X) (FIELD_OFFSET(MIB_TCP6TABLE,table[0]) + \ + ((X) * sizeof(MIB_TCP6ROW)) + ALIGN_SIZE) + +typedef struct _MIB_TCP6ROW2 { + IN6_ADDR LocalAddr; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + IN6_ADDR RemoteAddr; + DWORD dwRemoteScopeId; + DWORD dwRemotePort; + MIB_TCP_STATE State; + DWORD dwOwningPid; + TCP_CONNECTION_OFFLOAD_STATE dwOffloadState; +} MIB_TCP6ROW2, *PMIB_TCP6ROW2; + +typedef struct _MIB_TCP6TABLE2 { + DWORD dwNumEntries; + MIB_TCP6ROW2 table[ANY_SIZE]; +} MIB_TCP6TABLE2, *PMIB_TCP6TABLE2; + +#define SIZEOF_TCP6TABLE2(X) (FIELD_OFFSET(MIB_TCP6TABLE2,table[0]) + \ + ((X) * sizeof(MIB_TCP6ROW2)) + ALIGN_SIZE) + +typedef struct _MIB_TCP6ROW_OWNER_PID +{ + UCHAR ucLocalAddr[16]; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + UCHAR ucRemoteAddr[16]; + DWORD dwRemoteScopeId; + DWORD dwRemotePort; + DWORD dwState; + DWORD dwOwningPid; +} MIB_TCP6ROW_OWNER_PID, *PMIB_TCP6ROW_OWNER_PID; + +typedef struct _MIB_TCP6TABLE_OWNER_PID +{ + DWORD dwNumEntries; + _Field_size_(dwNumEntries) + MIB_TCP6ROW_OWNER_PID table[ANY_SIZE]; +} MIB_TCP6TABLE_OWNER_PID, *PMIB_TCP6TABLE_OWNER_PID; + +#define SIZEOF_TCP6TABLE_OWNER_PID(X) (FIELD_OFFSET(MIB_TCP6TABLE_OWNER_PID, table[0]) + \ + ((X) * sizeof(MIB_TCP6ROW_OWNER_PID)) + ALIGN_SIZE) + +typedef struct _MIB_TCP6ROW_OWNER_MODULE +{ + UCHAR ucLocalAddr[16]; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + UCHAR ucRemoteAddr[16]; + DWORD dwRemoteScopeId; + DWORD dwRemotePort; + DWORD dwState; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + ULONGLONG OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE]; +} MIB_TCP6ROW_OWNER_MODULE, *PMIB_TCP6ROW_OWNER_MODULE; + +typedef struct _MIB_TCP6TABLE_OWNER_MODULE +{ + DWORD dwNumEntries; + _Field_size_(dwNumEntries) + MIB_TCP6ROW_OWNER_MODULE table[ANY_SIZE]; +} MIB_TCP6TABLE_OWNER_MODULE, *PMIB_TCP6TABLE_OWNER_MODULE; + +#define SIZEOF_TCP6TABLE_OWNER_MODULE(X) (FIELD_OFFSET(MIB_TCP6TABLE_OWNER_MODULE, table[0]) + \ + ((X) * sizeof(MIB_TCP6ROW_OWNER_MODULE)) + ALIGN_SIZE) + +#endif // _WS2IPDEF_ + +#define MIB_TCP_MAXCONN_DYNAMIC ((ULONG)-1) + +// +// The algorithm used to determine the timeout value used for retransmitting +// unacknowledged octets. +// +typedef enum { + TcpRtoAlgorithmOther = 1, + TcpRtoAlgorithmConstant, + TcpRtoAlgorithmRsre, + TcpRtoAlgorithmVanj, + + MIB_TCP_RTO_OTHER = 1, + MIB_TCP_RTO_CONSTANT = 2, + MIB_TCP_RTO_RSRE = 3, + MIB_TCP_RTO_VANJ = 4, +} TCP_RTO_ALGORITHM, *PTCP_RTO_ALGORITHM; + +typedef struct _MIB_TCPSTATS_LH { + union { + DWORD dwRtoAlgorithm; + TCP_RTO_ALGORITHM RtoAlgorithm; + }; + DWORD dwRtoMin; + DWORD dwRtoMax; + DWORD dwMaxConn; + DWORD dwActiveOpens; + DWORD dwPassiveOpens; + DWORD dwAttemptFails; + DWORD dwEstabResets; + DWORD dwCurrEstab; + DWORD dwInSegs; + DWORD dwOutSegs; + DWORD dwRetransSegs; + DWORD dwInErrs; + DWORD dwOutRsts; + DWORD dwNumConns; +} MIB_TCPSTATS_LH, *PMIB_TCPSTATS_LH; + +typedef struct _MIB_TCPSTATS_W2K { + DWORD dwRtoAlgorithm; + DWORD dwRtoMin; + DWORD dwRtoMax; + DWORD dwMaxConn; + DWORD dwActiveOpens; + DWORD dwPassiveOpens; + DWORD dwAttemptFails; + DWORD dwEstabResets; + DWORD dwCurrEstab; + DWORD dwInSegs; + DWORD dwOutSegs; + DWORD dwRetransSegs; + DWORD dwInErrs; + DWORD dwOutRsts; + DWORD dwNumConns; +} MIB_TCPSTATS_W2K, *PMIB_TCPSTATS_W2K; + +#if (NTDDI_VERSION >= NTDDI_VISTA) +typedef MIB_TCPSTATS_LH MIB_TCPSTATS; +typedef MIB_TCPSTATS_LH *PMIB_TCPSTATS; +#elif (NTDDI_VERSION >= NTDDI_WIN2K) +typedef MIB_TCPSTATS_W2K MIB_TCPSTATS; +typedef MIB_TCPSTATS_W2K *PMIB_TCPSTATS; +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct _MIB_TCPSTATS2 { + TCP_RTO_ALGORITHM RtoAlgorithm; + DWORD dwRtoMin; + DWORD dwRtoMax; + DWORD dwMaxConn; + DWORD dwActiveOpens; + DWORD dwPassiveOpens; + DWORD dwAttemptFails; + DWORD dwEstabResets; + DWORD dwCurrEstab; + DWORD64 dw64InSegs; + DWORD64 dw64OutSegs; + DWORD dwRetransSegs; + DWORD dwInErrs; + DWORD dwOutRsts; + DWORD dwNumConns; +} MIB_TCPSTATS2, *PMIB_TCPSTATS2; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _TCPMIB_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdi.h new file mode 100644 index 0000000000000000000000000000000000000000..1adf851e451458967e5ce331e8aad34d7de2de27 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdi.h @@ -0,0 +1,992 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + tdi.h + +Abstract: + + This header file contains interface definitions for NT transport + providers. This interface is documented in the NT Transport + Driver Interface (TDI) Specification, Version 2. + +Revision History: + +--*/ + +// +// Include the types which are common to TDI and other network users +// + +#ifndef _TDI_USER_ +#define _TDI_USER_ + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#include + +#include + +// +// Include Transport driver interface definitions +// All of the following have two definitions; ones that correspond exactly to +// the TDI spec, and those that correspond to the NT coding standards. They +// should be equivalent. +// + +typedef LONG TDI_STATUS; +typedef PVOID CONNECTION_CONTEXT; // connection context + +// +// Basic type used to represent an address at the transport level. There may +// be many addresses represented in a single address structure. If there are +// multiple addresses, a given provider must understand all of them or it can +// use none of them. Note that it is acceptible for the provider to not know +// how to use the address, as long as it knows the address type. Thus, a +// TCP/IP NetBIOS provider may know both NetBIOS and TCP/IP addresses, but +// use only the NetBIOS address; the TCP/IP address would (likely) be passed on +// to the TCP/IP provider. +// + +typedef UNALIGNED struct _TA_ADDRESS { + USHORT AddressLength; // length in bytes of Address[] in this + USHORT AddressType; // type of this address + UCHAR Address[1]; // actually AddressLength bytes long +} TA_ADDRESS, *PTA_ADDRESS; + +typedef struct _TRANSPORT_ADDRESS { + LONG TAAddressCount; // number of addresses following + TA_ADDRESS Address[1]; // actually TAAddressCount elements long +} TRANSPORT_ADDRESS, *PTRANSPORT_ADDRESS; + +// +// define some names for the EAs so people don't have to make them up. +// + +#define TdiTransportAddress "TransportAddress" +#define TdiConnectionContext "ConnectionContext" +#define TDI_TRANSPORT_ADDRESS_LENGTH (sizeof (TdiTransportAddress) - 1) +#define TDI_CONNECTION_CONTEXT_LENGTH (sizeof (TdiConnectionContext) - 1) + +// +// Known Address types +// + +#define TDI_ADDRESS_TYPE_UNSPEC ((USHORT)0) // unspecified +#define TDI_ADDRESS_TYPE_UNIX ((USHORT)1) // local to host (pipes, portals) +#define TDI_ADDRESS_TYPE_IP ((USHORT)2) // internetwork: UDP, TCP, etc. +#define TDI_ADDRESS_TYPE_IMPLINK ((USHORT)3) // arpanet imp addresses +#define TDI_ADDRESS_TYPE_PUP ((USHORT)4) // pup protocols: e.g. BSP +#define TDI_ADDRESS_TYPE_CHAOS ((USHORT)5) // mit CHAOS protocols +#define TDI_ADDRESS_TYPE_NS ((USHORT)6) // XEROX NS protocols +#define TDI_ADDRESS_TYPE_IPX ((USHORT)6) // Netware IPX +#define TDI_ADDRESS_TYPE_NBS ((USHORT)7) // nbs protocols +#define TDI_ADDRESS_TYPE_ECMA ((USHORT)8) // european computer manufacturers +#define TDI_ADDRESS_TYPE_DATAKIT ((USHORT)9) // datakit protocols +#define TDI_ADDRESS_TYPE_CCITT ((USHORT)10) // CCITT protocols, X.25 etc +#define TDI_ADDRESS_TYPE_SNA ((USHORT)11) // IBM SNA +#define TDI_ADDRESS_TYPE_DECnet ((USHORT)12) // DECnet +#define TDI_ADDRESS_TYPE_DLI ((USHORT)13) // Direct data link interface +#define TDI_ADDRESS_TYPE_LAT ((USHORT)14) // LAT +#define TDI_ADDRESS_TYPE_HYLINK ((USHORT)15) // NSC Hyperchannel +#define TDI_ADDRESS_TYPE_APPLETALK ((USHORT)16) // AppleTalk +#define TDI_ADDRESS_TYPE_NETBIOS ((USHORT)17) // Netbios Addresses +#define TDI_ADDRESS_TYPE_8022 ((USHORT)18) // +#define TDI_ADDRESS_TYPE_OSI_TSAP ((USHORT)19) // +#define TDI_ADDRESS_TYPE_NETONE ((USHORT)20) // for WzMail +#define TDI_ADDRESS_TYPE_VNS ((USHORT)21) // Banyan VINES IP +#define TDI_ADDRESS_TYPE_NETBIOS_EX ((USHORT)22) // NETBIOS address extensions +#define TDI_ADDRESS_TYPE_IP6 ((USHORT)23) // IP version 6 +#define TDI_ADDRESS_TYPE_NETBIOS_UNICODE_EX ((USHORT)24) // WCHAR Netbios address + +// +// Definition of address structures. These need to be packed +// and misaligned where necessary. +// + +#include + +// +// Unicode NetBIOS +// +enum eNameBufferType { + NBT_READONLY = 0, // default + NBT_WRITEONLY, + NBT_READWRITE, + NBT_WRITTEN +}; + +typedef UNALIGNED struct _TDI_ADDRESS_NETBIOS_UNICODE_EX_XP { + USHORT NetbiosNameType; + enum eNameBufferType NameBufferType; + UNICODE_STRING EndpointName; // Buffer should point to EndpointBuffer + UNICODE_STRING RemoteName; // Buffer should point to RemoteNameBuffer + + WCHAR EndpointBuffer[17]; // UNICODE + WCHAR RemoteNameBuffer[1]; // UNICODE +} TDI_ADDRESS_NETBIOS_UNICODE_EX_XP, *PTDI_ADDRESS_NETBIOS_UNICODE_EX_XP; + +typedef UNALIGNED struct _TA_ADDRESS_NETBIOS_UNICODE_EX_XP { + LONG TAAddressCount; + struct _AddrNetbiosWCharEx { + USHORT AddressLength; // length in bytes of this address == ?? + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_NETBIOS_WCHAR_EX + TDI_ADDRESS_NETBIOS_UNICODE_EX_XP Address[1]; + } Address [1]; +} TA_NETBIOS_UNICODE_EX_ADDRESS_XP, *PTA_NETBIOS_UNICODE_EX_ADDRESS_XP; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef TDI_ADDRESS_NETBIOS_UNICODE_EX_XP TDI_ADDRESS_NETBIOS_UNICODE_EX; +typedef TDI_ADDRESS_NETBIOS_UNICODE_EX* PTDI_ADDRESS_NETBIOS_UNICODE_EX; + +typedef TA_NETBIOS_UNICODE_EX_ADDRESS_XP TA_NETBIOS_UNICODE_EX_ADDRESS; +typedef TA_NETBIOS_UNICODE_EX_ADDRESS* PTA_NETBIOS_UNICODE_EX_ADDRESS; +#endif + +// +// NetBIOS +// + +typedef UNALIGNED struct _TDI_ADDRESS_NETBIOS { + USHORT NetbiosNameType; + UCHAR NetbiosName[16]; +} TDI_ADDRESS_NETBIOS, *PTDI_ADDRESS_NETBIOS; + +#define TDI_ADDRESS_NETBIOS_TYPE_UNIQUE ((USHORT)0x0000) +#define TDI_ADDRESS_NETBIOS_TYPE_GROUP ((USHORT)0x0001) +#define TDI_ADDRESS_NETBIOS_TYPE_QUICK_UNIQUE ((USHORT)0x0002) +#define TDI_ADDRESS_NETBIOS_TYPE_QUICK_GROUP ((USHORT)0x0003) + +#define TDI_ADDRESS_LENGTH_NETBIOS sizeof (TDI_ADDRESS_NETBIOS) + +// +// NETBIOS Extended address +// + +typedef struct _TDI_ADDRESS_NETBIOS_EX { + UCHAR EndpointName[16]; // the called name to be used in NETBT session setup + TDI_ADDRESS_NETBIOS NetbiosAddress; +} TDI_ADDRESS_NETBIOS_EX, *PTDI_ADDRESS_NETBIOS_EX; + +#define TDI_ADDRESS_LENGTH_NETBIOS_EX sizeof(TDI_ADDRESS_NETBIOS_EX) + +// +// Xns address for UB +// + +typedef struct _TDI_ADDRESS_NETONE { + USHORT NetoneNameType; + UCHAR NetoneName[20]; +} TDI_ADDRESS_NETONE, *PTDI_ADDRESS_NETONE; + +#define TDI_ADDRESS_NETONE_TYPE_UNIQUE ((USHORT)0x0000) +#define TDI_ADDRESS_NETONE_TYPE_ROTORED ((USHORT)0x0001) + +#define TDI_ADDRESS_LENGTH_NETONE sizeof (TDI_ADDRESS_NETONE) + + +// +// AppleTalk +// + +typedef struct _TDI_ADDRESS_APPLETALK { + USHORT Network; + UCHAR Node; + UCHAR Socket; +} TDI_ADDRESS_APPLETALK, *PTDI_ADDRESS_APPLETALK; + +#define TDI_ADDRESS_LENGTH_APPLETALK sizeof (TDI_ADDRESS_APPLETALK) + + +// +// 802.2 MAC addresses +// + +typedef struct _TDI_ADDRESS_8022 { + UCHAR MACAddress[6]; +} TDI_ADDRESS_8022, *PTDI_ADDRESS_8022; + +#define TDI_ADDRESS_LENGTH_8022 sizeof (TDI_ADDRESS_8022); + + +// +// IP address +// + +typedef struct _TDI_ADDRESS_IP { + USHORT sin_port; + ULONG in_addr; + UCHAR sin_zero[8]; +} TDI_ADDRESS_IP, *PTDI_ADDRESS_IP; + +#define TDI_ADDRESS_LENGTH_IP sizeof (TDI_ADDRESS_IP) + +// +// IPv6 address +// + +typedef struct _TDI_ADDRESS_IP6_WIN2K { + USHORT sin6_port; + ULONG sin6_flowinfo; + UCHAR sin6_addr[16]; +} TDI_ADDRESS_IP6_WIN2K, *PTDI_ADDRESS_IP6_WIN2K; + +typedef struct _TDI_ADDRESS_IP6_XP { + USHORT sin6_port; + ULONG sin6_flowinfo; + USHORT sin6_addr[8]; + ULONG sin6_scope_id; +} TDI_ADDRESS_IP6_XP, *PTDI_ADDRESS_IP6_XP; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef TDI_ADDRESS_IP6_XP TDI_ADDRESS_IP6; +#else +typedef TDI_ADDRESS_IP6_WIN2K TDI_ADDRESS_IP6; +#endif + +typedef TDI_ADDRESS_IP6* PTDI_ADDRESS_IP6; +#define TDI_ADDRESS_LENGTH_IP6 sizeof (TDI_ADDRESS_IP6) + +// +// IPX address +// + +typedef struct _TDI_ADDRESS_IPX { + ULONG NetworkAddress; + UCHAR NodeAddress[6]; + USHORT Socket; +} TDI_ADDRESS_IPX, *PTDI_ADDRESS_IPX; + + +#define TDI_ADDRESS_LENGTH_IPX sizeof (TDI_ADDRESS_IPX) + +// +// XNS address (same as IPX) +// + +typedef struct _TDI_ADDRESS_NS { + ULONG NetworkAddress; + UCHAR NodeAddress[6]; + USHORT Socket; +} TDI_ADDRESS_NS, *PTDI_ADDRESS_NS; + + +#define TDI_ADDRESS_LENGTH_NS sizeof (TDI_ADDRESS_NS) + +// +// Banyan VINES IP address +// + +typedef struct _TDI_ADDRESS_VNS { + UCHAR net_address[4]; // network address (static) + UCHAR subnet_addr[2]; // subnet address (dynamic) + UCHAR port[2]; + UCHAR hops; // # hops for broadcasts + UCHAR filler[5]; // filler, zeros +} TDI_ADDRESS_VNS, *PTDI_ADDRESS_VNS; + +#define TDI_ADDRESS_LENGTH_VNS sizeof (TDI_ADDRESS_VNS) + + +// OSI TSAP + +/* + * The maximum size of the tranport address (tp_addr field of a + * sockaddr_tp structure) is 64. + */ + +#define ISO_MAX_ADDR_LENGTH 64 + +/* + * There are two types of ISO addresses, hierarchical and + * non-hierarchical. For hierarchical addresses, the tp_addr + * field contains both the transport selector and the network + * address. For non-hierarchical addresses, tp_addr contains only + * the transport address, which must be translated by the ISO TP4 + * transport provider into the transport selector and network address. + */ + +#define ISO_HIERARCHICAL 0 +#define ISO_NON_HIERARCHICAL 1 + +typedef struct _TDI_ADDRESS_OSI_TSAP { + USHORT tp_addr_type; /* ISO_HIERARCHICAL or ISO_NON_HIERARCHICAL +*/ + USHORT tp_taddr_len; /* Length of transport address, <= 52 */ + USHORT tp_tsel_len; /* Length of transport selector, <= 32 */ + /* 0 if ISO_NON_HIERARCHICAL */ + UCHAR tp_addr[ISO_MAX_ADDR_LENGTH]; +} TDI_ADDRESS_OSI_TSAP, *PTDI_ADDRESS_OSI_TSAP; + +#define TDI_ADDRESS_LENGTH_OSI_TSAP sizeof (TDI_ADDRESS_OSI_TSAP) + +// +// Some pre-defined structures to make life easier for +// the 99.99% of us who use but one address. +// + +typedef struct _TA_ADDRESS_NETBIOS { + LONG TAAddressCount; + struct _Addr { + USHORT AddressLength; // length in bytes of this address == 18 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_NETBIOS + TDI_ADDRESS_NETBIOS Address[1]; + } Address [1]; +} TA_NETBIOS_ADDRESS, *PTA_NETBIOS_ADDRESS; + +typedef struct _TA_ADDRESS_NETBIOS_EX { + LONG TAAddressCount; + struct _AddrNetbiosEx { + USHORT AddressLength; // length in bytes of this address == 36 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_NETBIOS_EX + TDI_ADDRESS_NETBIOS_EX Address[1]; + } Address [1]; +} TA_NETBIOS_EX_ADDRESS, *PTA_NETBIOS_EX_ADDRESS; + +typedef struct _TA_APPLETALK_ADDR { + LONG TAAddressCount; + struct _AddrAtalk { + USHORT AddressLength; // length in bytes of this address == 4 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_APPLETALK + TDI_ADDRESS_APPLETALK Address[1]; + } Address[1]; +} TA_APPLETALK_ADDRESS, *PTA_APPLETALK_ADDRESS; + +typedef struct _TA_ADDRESS_IP { + LONG TAAddressCount; + struct _AddrIp { + USHORT AddressLength; // length in bytes of this address == 14 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_IP + TDI_ADDRESS_IP Address[1]; + } Address [1]; +} TA_IP_ADDRESS, *PTA_IP_ADDRESS; + +typedef struct _TA_ADDRESS_IP6 { + LONG TAAddressCount; + struct _AddrIp6 { + USHORT AddressLength; // length in bytes of this address == 24 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_IP6 + TDI_ADDRESS_IP6 Address[1]; + } Address [1]; +} TA_IP6_ADDRESS, *PTA_IP6_ADDRESS; + +typedef struct _TA_ADDRESS_IPX { + LONG TAAddressCount; + struct _AddrIpx { + USHORT AddressLength; // length in bytes of this address == 12 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_IPX + TDI_ADDRESS_IPX Address[1]; + } Address [1]; +} TA_IPX_ADDRESS, *PTA_IPX_ADDRESS; + +typedef struct _TA_ADDRESS_NS { + LONG TAAddressCount; + struct _AddrNs { + USHORT AddressLength; // length in bytes of this address == 12 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_NS + TDI_ADDRESS_NS Address[1]; + } Address [1]; +} TA_NS_ADDRESS, *PTA_NS_ADDRESS; + +typedef struct _TA_ADDRESS_VNS { + LONG TAAddressCount; + struct _AddrVns { + USHORT AddressLength; // length in bytes of this address == 14 + USHORT AddressType; // this will == TDI_ADDRESS_TYPE_VNS + TDI_ADDRESS_VNS Address[1]; + } Address [1]; +} TA_VNS_ADDRESS, *PTA_VNS_ADDRESS; + +#include + + +// +// This structure is passed with every request to TDI. It describes that +// request and the parameters to it. +// + +typedef struct _TDI_REQUEST { + union { + HANDLE AddressHandle; + CONNECTION_CONTEXT ConnectionContext; + HANDLE ControlChannel; + } Handle; + + PVOID RequestNotifyObject; + PVOID RequestContext; + TDI_STATUS TdiStatus; +} TDI_REQUEST, *PTDI_REQUEST; + +// +// Structure for information returned by the TDI provider. This structure is +// filled in upon request completion. +// + +typedef struct _TDI_REQUEST_STATUS { + TDI_STATUS Status; // status of request completion + PVOID RequestContext; // the request Context + ULONG BytesTransferred; // number of bytes transferred in the request + +} TDI_REQUEST_STATUS, *PTDI_REQUEST_STATUS; + +// +// connection primitives information structure. This is passed to the TDI calls +// (Accept, Connect, xxx) that do connecting sorts of things. +// + +typedef struct _TDI_CONNECTION_INFORMATION { + LONG UserDataLength; // length of user data buffer + _Field_size_bytes_(UserDataLength) PVOID UserData; // pointer to user data buffer + LONG OptionsLength; // length of follwoing buffer + _Field_size_bytes_(OptionsLength) PVOID Options; // pointer to buffer containing options + LONG RemoteAddressLength; // length of following buffer + _Field_size_bytes_(RemoteAddressLength) PVOID RemoteAddress; // buffer containing the remote address +} TDI_CONNECTION_INFORMATION, *PTDI_CONNECTION_INFORMATION; + +// +// structure defining a counted string is defined in +// \nt\public\sdk\inc\ntdefs.h as +// typedef struct _STRING { +// USHORT Length; +// USHORT MaximumLength; +// PCHAR Buffer; +// } STRING; +// typedef STRING *PSTRING; +// typedef STRING ANSI_STRING; +// typedef PSTRING PANSI_STRING; +// + +// +// Event types that are known +// + +#define TDI_EVENT_CONNECT ((USHORT)0) // TDI_IND_CONNECT event handler. +#define TDI_EVENT_DISCONNECT ((USHORT)1) // TDI_IND_DISCONNECT event handler. +#define TDI_EVENT_ERROR ((USHORT)2) // TDI_IND_ERROR event handler. +#define TDI_EVENT_RECEIVE ((USHORT)3) // TDI_IND_RECEIVE event handler. +#define TDI_EVENT_RECEIVE_DATAGRAM ((USHORT)4) // TDI_IND_RECEIVE_DATAGRAM event handler. +#define TDI_EVENT_RECEIVE_EXPEDITED ((USHORT)5) // TDI_IND_RECEIVE_EXPEDITED event handler. +#define TDI_EVENT_SEND_POSSIBLE ((USHORT)6) // TDI_IND_SEND_POSSIBLE event handler + +// +// Associate Address is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. +// + +typedef struct _TDI_REQUEST_ASSOCIATE { + TDI_REQUEST Request; + HANDLE AddressHandle; +} TDI_REQUEST_ASSOCIATE_ADDRESS, *PTDI_REQUEST_ASSOCIATE_ADDRESS; + + +// +// Disassociate Address passes no structure, uses the request code +// IOCTL_TDI_DISASSOCIATE_ADDRESS. This call will never pend. +// + +// +// Connect is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. +// + +typedef struct _TDI_CONNECT_REQUEST { + TDI_REQUEST Request; + PTDI_CONNECTION_INFORMATION RequestConnectionInformation; + PTDI_CONNECTION_INFORMATION ReturnConnectionInformation; + LARGE_INTEGER Timeout; +} TDI_REQUEST_CONNECT, *PTDI_REQUEST_CONNECT; + +// +// Accept is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. Accept is called by the user when a listen completes, +// before any activity can occur on a connection. AcceptConnectionId specifies +// the connection on which the connection is accepted; in most cases, this +// will be null, which that the connection is to be accepted on the +// connection on which the listen completed. If the transport provider supports +// "forwarding" of connections (the idea that a particular connection listens +// all the time, and creates new connections as needed for incoming connection +// requests and attaches them to the listen), this is the mechanism used to +// associate connections with the listen. +// + +typedef struct _TDI_REQUEST_ACCEPT { + TDI_REQUEST Request; + PTDI_CONNECTION_INFORMATION RequestConnectionInformation; + PTDI_CONNECTION_INFORMATION ReturnConnectionInformation; +} TDI_REQUEST_ACCEPT, *PTDI_REQUEST_ACCEPT; + +// +// Listen is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. RequestConnectionInformation contains information about +// the remote address to be listen for connections from; if NULL, any address +// is accepted. ReturnConnectionInformation returns information about the +// remote node that actually connected. +// + +typedef struct _TDI_REQUEST_LISTEN { + TDI_REQUEST Request; + PTDI_CONNECTION_INFORMATION RequestConnectionInformation; + PTDI_CONNECTION_INFORMATION ReturnConnectionInformation; + USHORT ListenFlags; +} TDI_REQUEST_LISTEN, *PTDI_REQUEST_LISTEN; + +// +// Disconnect is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. Disconnect differs from Close in offering more options. +// For example, Close terminates all activity on a connection (immediately), +// failing all outstanding requests, and tearing down the connection. With +// some providers, Disconnect allows a "graceful" disconnect, causing new activity +// to be rejected but allowing old activity to run down to completion. +// + +typedef struct _TDI_DISCONNECT_REQUEST { + TDI_REQUEST Request; + LARGE_INTEGER Timeout; +} TDI_REQUEST_DISCONNECT, *PTDI_REQUEST_DISCONNECT; + +// +// Send is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. Note that it is possible to Send using the file system's +// Write call. This will have the same effect as doing a Send with all flags +// set to null. +// + +typedef struct _TDI_REQUEST_SEND { + TDI_REQUEST Request; + USHORT SendFlags; +} TDI_REQUEST_SEND, *PTDI_REQUEST_SEND; + +// +// Receive is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the connection returned in the +// NtCreateFile call. Note that it is possible to Receive using the file +// system's Read call. Note further that receive returns a number of TDI_STATUS +// values, which indicate things such as partial receives. +// + +typedef struct _TDI_REQUEST_RECEIVE { + TDI_REQUEST Request; + USHORT ReceiveFlags; +} TDI_REQUEST_RECEIVE, *PTDI_REQUEST_RECEIVE; + +// +// SendDatagram is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the ADDRESS (note this is +// different than above!!) returned in the NtCreateFile call. Send Datagram +// specifies the address of the receiver through the SendDatagramInformation +// structure, using RemoteAddress to point to the transport address of the +// destination of the datagram. +// + +typedef struct _TDI_REQUEST_SEND_DATAGRAM { + TDI_REQUEST Request; + PTDI_CONNECTION_INFORMATION SendDatagramInformation; +} TDI_REQUEST_SEND_DATAGRAM, *PTDI_REQUEST_SEND_DATAGRAM; + +// +// ReceiveDatagram is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the ADDRESS (note this is +// different than above!!) returned in the NtCreateFile call. Receive Datagram +// specifies the address from which to receive a datagram through the +// ReceiveDatagramInformation structure, using RemoteAddress to point to the +// transport address of the origin of the datagram. (Broadcast datagrams are +// received by making the pointer NULL.) The actual address of the sender of +// the datagram is returned in ReturnInformation. +// +// for the receive datagram call +// + +typedef struct _TDI_REQUEST_RECEIVE_DATAGRAM { + TDI_REQUEST Request; + PTDI_CONNECTION_INFORMATION ReceiveDatagramInformation; + PTDI_CONNECTION_INFORMATION ReturnInformation; + USHORT ReceiveFlags; +} TDI_REQUEST_RECEIVE_DATAGRAM, *PTDI_REQUEST_RECEIVE_DATAGRAM; + +// +// SetEventHandler is done through NtDeviceIoControlFile, which passes this +// structure as its input buffer. The Handle specified in the +// NtDeviceIoControlFile is the handle of the ADDRESS (note this is +// different than above!!) returned in the NtCreateFile call. + +typedef struct _TDI_REQUEST_SET_EVENT { + TDI_REQUEST Request; + LONG EventType; + PVOID EventHandler; + PVOID EventContext; +} TDI_REQUEST_SET_EVENT_HANDLER, *PTDI_REQUEST_SET_EVENT_HANDLER; + +// +// ReceiveIndicator values (from TdiReceive and TdiReceiveDatagram requests, +// and also presented at TDI_IND_RECEIVE and TDI_IND_RECEIVE_DATAGRAM time). +// +// The TDI_RECEIVE_PARTIAL bit is no longer used at the kernel level +// interface. TDI_RECEIVE_ENTIRE_MESSAGE has replaced it. Providers +// may continue to set TDI_RECEIVE_PARTIAL when appropriate if they so +// desire, but the TDI_RECEIVE_ENTIRE_MESSAGE bit must be set or +// cleared as appropriate on all receive indications. +// + +#define TDI_RECEIVE_BROADCAST 0x00000004 // received TSDU was broadcast. +#define TDI_RECEIVE_MULTICAST 0x00000008 // received TSDU was multicast. +#define TDI_RECEIVE_PARTIAL 0x00000010 // received TSDU is not fully presented. +#define TDI_RECEIVE_NORMAL 0x00000020 // received TSDU is normal data +#define TDI_RECEIVE_EXPEDITED 0x00000040 // received TSDU is expedited data +#define TDI_RECEIVE_PEEK 0x00000080 // received TSDU is not released +#define TDI_RECEIVE_NO_RESPONSE_EXP 0x00000100 // HINT: no back-traffic expected +#define TDI_RECEIVE_COPY_LOOKAHEAD 0x00000200 // for kernel-mode indications +#define TDI_RECEIVE_ENTIRE_MESSAGE 0x00000400 // opposite of RECEIVE_PARTIAL + // (for kernel-mode indications) +#define TDI_RECEIVE_AT_DISPATCH_LEVEL 0x00000800 // receive indication called + // at dispatch level +#define TDI_RECEIVE_CONTROL_INFO 0x00001000 // Control info is being passed up. +#define TDI_RECEIVE_FORCE_INDICATION 0x00002000 // reindicate rejected data. +#define TDI_RECEIVE_NO_PUSH 0x00004000 // complete only when full. + + + +// +// Listen Flags +// + +#define TDI_QUERY_ACCEPT 0x00000001 // complete TdiListen + // without accepting + // connection + +// +// Options which are used for both SendOptions and ReceiveIndicators. +// + +#define TDI_SEND_EXPEDITED ((USHORT)0x0020) // TSDU is/was urgent/expedited. +#define TDI_SEND_PARTIAL ((USHORT)0x0040) // TSDU is/was terminated by an EOR. +#define TDI_SEND_NO_RESPONSE_EXPECTED ((USHORT)0x0080) // HINT: no back traffic expected. +#define TDI_SEND_NON_BLOCKING ((USHORT)0x0100) // don't block if no buffer space in protocol +#define TDI_SEND_AND_DISCONNECT ((USHORT)0x0200) // Piggy back disconnect to remote and do not + // indicate disconnect from remote + + +// +// Disconnect Flags +// + +#define TDI_DISCONNECT_WAIT ((USHORT)0x0001) // used for disconnect + // notification +#define TDI_DISCONNECT_ABORT ((USHORT)0x0002) // immediately terminate + // connection +#define TDI_DISCONNECT_RELEASE ((USHORT)0x0004) // initiate graceful + // disconnect + +// +// TdiRequest structure for TdiQueryInformation request. +// + +typedef struct _TDI_REQUEST_QUERY_INFORMATION { + TDI_REQUEST Request; + ULONG QueryType; // class of information to be queried. + PTDI_CONNECTION_INFORMATION RequestConnectionInformation; +} TDI_REQUEST_QUERY_INFORMATION, *PTDI_REQUEST_QUERY_INFORMATION; + +// +// TdiRequest structure for TdiSetInformation request. +// + +typedef struct _TDI_REQUEST_SET_INFORMATION { + TDI_REQUEST Request; + ULONG SetType; // class of information to be set. + PTDI_CONNECTION_INFORMATION RequestConnectionInformation; +} TDI_REQUEST_SET_INFORMATION, *PTDI_REQUEST_SET_INFORMATION; + +// +// This is the old name, do not use it. +// + +typedef TDI_REQUEST_SET_INFORMATION TDI_REQ_SET_INFORMATION, *PTDI_REQ_SET_INFORMATION; + +// +// Convenient universal request type. +// + +typedef union _TDI_REQUEST_TYPE { + TDI_REQUEST_ACCEPT TdiAccept; + TDI_REQUEST_CONNECT TdiConnect; + TDI_REQUEST_DISCONNECT TdiDisconnect; + TDI_REQUEST_LISTEN TdiListen; + TDI_REQUEST_QUERY_INFORMATION TdiQueryInformation; + TDI_REQUEST_RECEIVE TdiReceive; + TDI_REQUEST_RECEIVE_DATAGRAM TdiReceiveDatagram; + TDI_REQUEST_SEND TdiSend; + TDI_REQUEST_SEND_DATAGRAM TdiSendDatagram; + TDI_REQUEST_SET_EVENT_HANDLER TdiSetEventHandler; + TDI_REQUEST_SET_INFORMATION TdiSetInformation; +} TDI_REQUEST_TYPE, *PTDI_REQUEST_TYPE; + + +// +// Query information types +// + +// +// Generic query info types, must be supported by all transports. +// + +#define TDI_QUERY_BROADCAST_ADDRESS 0x00000001 +#define TDI_QUERY_PROVIDER_INFORMATION 0x00000002 // temp, renamed ... +#define TDI_QUERY_PROVIDER_INFO 0x00000002 // ... to this +#define TDI_QUERY_ADDRESS_INFO 0x00000003 +#define TDI_QUERY_CONNECTION_INFO 0x00000004 +#define TDI_QUERY_PROVIDER_STATISTICS 0x00000005 +#define TDI_QUERY_DATAGRAM_INFO 0x00000006 +#define TDI_QUERY_DATA_LINK_ADDRESS 0x00000007 +#define TDI_QUERY_NETWORK_ADDRESS 0x00000008 +#define TDI_QUERY_MAX_DATAGRAM_INFO 0x00000009 +#define TDI_QUERY_ROUTING_INFO 0x0000000a + + +// +// netbios specific query information types, must be supported by netbios +// providers. Query adapter status returns the ADAPTER_STATUS struture defined +// in the file NB30.H. Query session status returns the SESSION_HEADER/ +// SESSION_BUFFER structures defined in NB30.H. Query find name returns +// the FIND_NAME_HEADER/FIND_NAME_BUFFER structures defined in NB30.H. +// + +#define TDI_QUERY_ADAPTER_STATUS 0x00000100 +#define TDI_QUERY_SESSION_STATUS 0x00000200 +#define TDI_QUERY_FIND_NAME 0x00000300 + +// +// The following structures are returned by TdiQueryInformation and are read +// by TdiSetInformation. Note that a provider with netbios support will also +// return the adapter status +// + +typedef struct _TDI_ENDPOINT_INFO { + ULONG State; // current state of the endpoint. + ULONG Event; // last event at the endpoint. + ULONG TransmittedTsdus; // TSDUs sent from this endpoint. + ULONG ReceivedTsdus; // TSDUs received at this endpoint. + ULONG TransmissionErrors; // TSDUs transmitted in error. + ULONG ReceiveErrors; // TSDUs received in error. + ULONG MinimumLookaheadData; // guaranteed min size of lookahead data. + ULONG MaximumLookaheadData; // maximum size of lookahead data. + ULONG PriorityLevel; // priority class assigned to outgoing data. + ULONG SecurityLevel; // security level assigned to outgoing data. + ULONG SecurityCompartment; // security compartment assigned to outgoing data. +} TDI_ENDPOINT_INFO, *PTDI_ENDPOINT_INFO; + +typedef struct _TDI_CONNECTION_INFO { + ULONG State; // current state of the connection. + ULONG Event; // last event on the connection. + ULONG TransmittedTsdus; // TSDUs sent on this connection. + ULONG ReceivedTsdus; // TSDUs received on this connection. + ULONG TransmissionErrors; // TSDUs transmitted in error/this connection. + ULONG ReceiveErrors; // TSDUs received in error/this connection. + LARGE_INTEGER Throughput; // estimated throughput on this connection. + LARGE_INTEGER Delay; // estimated delay on this connection. + ULONG SendBufferSize; // size of buffer for sends - only + // meaningful for internal buffering + // protocols like tcp + ULONG ReceiveBufferSize; // size of buffer for receives - only + // meaningful for internal buffering + // protocols like tcp + BOOLEAN Unreliable; // is this connection "unreliable". +} TDI_CONNECTION_INFO, *PTDI_CONNECTION_INFO; + +typedef struct _TDI_ADDRESS_INFO { + ULONG ActivityCount; // outstanding open file objects/this address. + TRANSPORT_ADDRESS Address; // the actual address & its components. +} TDI_ADDRESS_INFO, *PTDI_ADDRESS_INFO; + +typedef struct _TDI_DATAGRAM_INFO { + ULONG MaximumDatagramBytes; + ULONG MaximumDatagramCount; +} TDI_DATAGRAM_INFO, *PTDI_DATAGRAM_INFO; + +typedef struct _TDI_MAX_DATAGRAM_INFO { + ULONG MaxDatagramSize; // max datagram length in bytes. +} TDI_MAX_DATAGRAM_INFO, *PTDI_MAX_DATAGRAM_INFO; + +typedef struct _TDI_PROVIDER_INFO { + ULONG Version; // TDI version: 0xaabb, aa=major, bb=minor + ULONG MaxSendSize; // max size of user send. + ULONG MaxConnectionUserData; // max size of user-specified connect data. + ULONG MaxDatagramSize; // max datagram length in bytes. + ULONG ServiceFlags; // service options, defined below. + ULONG MinimumLookaheadData; // guaranteed min size of lookahead data. + ULONG MaximumLookaheadData; // maximum size of lookahead data. + ULONG NumberOfResources; // how many TDI_RESOURCE_STATS for provider. + LARGE_INTEGER StartTime; // when the provider became active. +} TDI_PROVIDER_INFO, *PTDI_PROVIDER_INFO; + +typedef struct _TDI_ROUTING_INFO_WS03 { + ULONG Protocol; // protocol of the end point. + ULONG InterfaceId; // interface-id of the outgoing interface. + ULONG LinkId; // link-id of the outgoing link (if any). + TRANSPORT_ADDRESS Address; // address information of the end point. +} TDI_ROUTING_INFO_WS03, *PTDI_ROUTING_INFO_WS03; + +#if (NTDDI_VERSION >= NTDDI_WS03) +typedef TDI_ROUTING_INFO_WS03 TDI_ROUTING_INFO; +typedef TDI_ROUTING_INFO* PTDI_ROUTING_INFO; +#endif //NTDDI_WINS03 + +#define TDI_SERVICE_CONNECTION_MODE 0x00000001 // connection mode supported. +#define TDI_SERVICE_ORDERLY_RELEASE 0x00000002 // orderly release supported. +#define TDI_SERVICE_CONNECTIONLESS_MODE 0x00000004 // connectionless mode supported. +#define TDI_SERVICE_ERROR_FREE_DELIVERY 0x00000008 // error free delivery supported. +#define TDI_SERVICE_SECURITY_LEVEL 0x00000010 // security wrapper supported. +#define TDI_SERVICE_BROADCAST_SUPPORTED 0x00000020 // broadcast datagrams supported. +#define TDI_SERVICE_MULTICAST_SUPPORTED 0x00000040 // multicast datagrams supported. +#define TDI_SERVICE_DELAYED_ACCEPTANCE 0x00000080 // use of TDI_ACCEPT_OR_REJECT is supported. +#define TDI_SERVICE_EXPEDITED_DATA 0x00000100 // expedited data supported. +#define TDI_SERVICE_INTERNAL_BUFFERING 0x00000200 // protocol does internal buffering +#define TDI_SERVICE_ROUTE_DIRECTED 0x00000400 // directed packets may go further than MC. +#define TDI_SERVICE_NO_ZERO_LENGTH 0x00000800 // zero-length sends NOT supported +#define TDI_SERVICE_POINT_TO_POINT 0x00001000 // transport is functioning as a RAS gateway +#define TDI_SERVICE_MESSAGE_MODE 0x00002000 // message-mode send supported +#define TDI_SERVICE_HALF_DUPLEX 0x00004000 // data can be received after local disc +#define TDI_SERVICE_DGRAM_CONNECTION 0x00008000 // Pseudo connection for datagrams to handle + // GPC, QOS etc., +#define TDI_SERVICE_FORCE_ACCESS_CHECK 0x00010000 // kernel mode caller should force access + // check when opening trasnport objects + // if it passes the handle to user mode +#define TDI_SERVICE_SEND_AND_DISCONNECT 0x00020000 // combines send and disconnect processing +#define TDI_SERVICE_DIRECT_ACCEPT 0x00040000 // (deprecated) completes accept-requests directly +#define TDI_SERVICE_ACCEPT_LOCAL_ADDR 0x00080000 // supplies local address + // with accept-completion +#define TDI_SERVICE_ADDRESS_SECURITY 0x00100000 // supports security descriptor assignment to + // addresses, extracts default SD from subject + // security context for user mode callers +#define TDI_SERVICE_PREPOST_RECVS 0x00200000 // prefers pre-posting of receives. +#define TDI_SERVICE_NO_PUSH 0x00400000 // can complete receives after + // filling the buffers completely + +typedef struct _TDI_PROVIDER_RESOURCE_STATS { + ULONG ResourceId; // identifies resource in question. + ULONG MaximumResourceUsed; // maximum number in use at once. + ULONG AverageResourceUsed; // average number in use. + ULONG ResourceExhausted; // number of times resource not available. +} TDI_PROVIDER_RESOURCE_STATS, *PTDI_PROVIDER_RESOURCE_STATS; + +typedef struct _TDI_PROVIDER_STATISTICS { + ULONG Version; // TDI version: 0xaabb, aa=major, bb=minor + ULONG OpenConnections; // currently active connections. + ULONG ConnectionsAfterNoRetry; // successful connections, no retries. + ULONG ConnectionsAfterRetry; // successful connections after retry. + ULONG LocalDisconnects; // connection disconnected locally. + ULONG RemoteDisconnects; // connection disconnected by remote. + ULONG LinkFailures; // connections dropped, link failure. + ULONG AdapterFailures; // connections dropped, adapter failure. + ULONG SessionTimeouts; // connections dropped, session timeout. + ULONG CancelledConnections; // connect attempts cancelled. + ULONG RemoteResourceFailures; // connections failed, remote resource problems. + ULONG LocalResourceFailures; // connections failed, local resource problems. + ULONG NotFoundFailures; // connections failed, remote not found. + ULONG NoListenFailures; // connections rejected, we had no listens. + ULONG DatagramsSent; + LARGE_INTEGER DatagramBytesSent; + ULONG DatagramsReceived; + LARGE_INTEGER DatagramBytesReceived; + ULONG PacketsSent; // total packets given to NDIS. + ULONG PacketsReceived; // total packets received from NDIS. + ULONG DataFramesSent; + LARGE_INTEGER DataFrameBytesSent; + ULONG DataFramesReceived; + LARGE_INTEGER DataFrameBytesReceived; + ULONG DataFramesResent; + LARGE_INTEGER DataFrameBytesResent; + ULONG DataFramesRejected; + LARGE_INTEGER DataFrameBytesRejected; + ULONG ResponseTimerExpirations; // e.g. T1 for Netbios + ULONG AckTimerExpirations; // e.g. T2 for Netbios + ULONG MaximumSendWindow; // in bytes + ULONG AverageSendWindow; // in bytes + ULONG PiggybackAckQueued; // attempts to wait to piggyback ack. + ULONG PiggybackAckTimeouts; // times that wait timed out. + LARGE_INTEGER WastedPacketSpace; // total amount of "wasted" packet space. + ULONG WastedSpacePackets; // how many packets contributed to that. + ULONG NumberOfResources; // how many TDI_RESOURCE_STATS follow. + TDI_PROVIDER_RESOURCE_STATS ResourceStats[1]; // variable array of them. +} TDI_PROVIDER_STATISTICS, *PTDI_PROVIDER_STATISTICS; + + +_IRQL_requires_max_(PASSIVE_LEVEL) +_Success_(return==STATUS_SUCCESS) +_At_(Buffer, + _Out_writes_bytes_( + sizeof(FILE_FULL_EA_INFORMATION) + TDI_TRANSPORT_ADDRESS_LENGTH + + sizeof(TA_NETBIOS_ADDRESS))) +NTSTATUS +TdiOpenNetbiosAddress ( + _Out_ PHANDLE FileHandle, + PUCHAR Buffer, + _In_ PVOID DeviceName, + _In_opt_ PVOID Name + ); + + + +#define IOCTL_TDI_MAGIC_BULLET _TDI_CONTROL_CODE( 0x7f, METHOD_NEITHER ) + +// +// Define these to match the kernel ones for compatibility; eventually +// these will be removed. +// + +typedef TDI_REQUEST_ASSOCIATE_ADDRESS TDI_REQUEST_USER_ASSOCIATE, *PTDI_REQUEST_USER_ASSOCIATE; +typedef TDI_REQUEST_CONNECT TDI_REQUEST_USER_CONNECT, *PTDI_REQUEST_USER_CONNECT; +typedef TDI_REQUEST_QUERY_INFORMATION TDI_REQUEST_USER_QUERY_INFO, *PTDI_REQUEST_USER_QUERY_INFO; + +// +// The header in the OutputBuffer passed to TdiAction +// + +typedef struct _TDI_ACTION_HEADER { + ULONG TransportId; + USHORT ActionCode; + USHORT Reserved; +} TDI_ACTION_HEADER, *PTDI_ACTION_HEADER; + +typedef struct _STREAMS_TDI_ACTION { + TDI_ACTION_HEADER Header; + BOOLEAN DatagramOption; + ULONG BufferLength; + CHAR Buffer[1]; +} STREAMS_TDI_ACTION, *PSTREAMS_TDI_ACTION; + +// These are tags that transports pass to ndis as a first param of NdisAllocatePacketPoolEx +// api. Ndis uses this as pooltag for allocating packet pools for that transport. +#define NDIS_PACKET_POOL_TAG_FOR_NWLNKIPX 'iPDN' +#define NDIS_PACKET_POOL_TAG_FOR_NWLNKSPX 'sPDN' +#define NDIS_PACKET_POOL_TAG_FOR_NWLNKNB 'nPDN' +#define NDIS_PACKET_POOL_TAG_FOR_TCPIP 'tPDN' +#define NDIS_PACKET_POOL_TAG_FOR_NBF 'bPDN' +#define NDIS_PACKET_POOL_TAG_FOR_APPLETALK 'aPDN' + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // ndef _TDI_USER_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdiinfo.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdiinfo.h new file mode 100644 index 0000000000000000000000000000000000000000..74583d31e28f33de7585e91fd2c8a30582dded03 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tdiinfo.h @@ -0,0 +1,201 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + tdiinfo.h + +Abstract: + + This file contains definitions for the extended TDI query and set info. + calls. + +Revision History: + +--*/ + +#ifndef TDI_INFO_INCLUDED +#define TDI_INFO_INCLUDED + +#pragma once +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#ifndef CTE_TYPEDEFS_DEFINED +#define CTE_TYPEDEFS_DEFINED + +typedef unsigned long ulong; +typedef unsigned short ushort; +typedef unsigned char uchar; +typedef unsigned int uint; + +#endif // CTE_TYPEDEFS_DEFINED + + +//* Structure of an entity ID. +typedef struct TDIEntityID { + ulong tei_entity; + ulong tei_instance; +} TDIEntityID; + +//* Structure of an object ID. +typedef struct TDIObjectID { + TDIEntityID toi_entity; + ulong toi_class; + ulong toi_type; + ulong toi_id; +} TDIObjectID; + +#define MAX_TDI_ENTITIES 4096 + +#define INFO_CLASS_GENERIC 0x100 +#define INFO_CLASS_PROTOCOL 0x200 +#define INFO_CLASS_IMPLEMENTATION 0x300 + +#define INFO_TYPE_PROVIDER 0x100 +#define INFO_TYPE_ADDRESS_OBJECT 0x200 +#define INFO_TYPE_CONNECTION 0x300 + +#define ENTITY_LIST_ID 0 + +#define GENERIC_ENTITY 0 + +#define CO_TL_ENTITY 0x400 +#define CL_TL_ENTITY 0x401 + +#define ER_ENTITY 0x380 + +#define CO_NL_ENTITY 0x300 +#define CL_NL_ENTITY 0x301 + +#define AT_ENTITY 0x280 + +#define IF_ENTITY 0x200 + +#define INVALID_ENTITY_INSTANCE -1 + +#define CONTEXT_SIZE 16 + + +//* The following are IDs supported by all entities. They are of class +// GENERIC and type PROVIDER. + +#define ENTITY_TYPE_ID 1 // The ID to get the entity + // type. The return from this + // type is an unsigned integer + // (see below). + + +// Valid values to get back from entity type ID query. +#define CO_TL_NBF 0x400 // Entity implements NBF prot. +#define CO_TL_SPX 0x402 // Entity implements SPX prot. +#define CO_TL_TCP 0x404 // Entity implements TCP prot. +#define CO_TL_SPP 0x406 // Entity implements SPP prot. + +#define CL_TL_NBF 0x401 // CL NBF protocol. +#define CL_TL_UDP 0x403 // Entity implements UDP. + +#define ER_ICMP 0x380 // The ICMP protocol. + +#define CL_NL_IPX 0x301 // Entity implements IPX. +#define CL_NL_IP 0x303 // Entity implements IP. + +#define AT_ARP 0x280 // Entity implements ARP. +#define AT_NULL 0x282 // Entity does no address + // translation. + +#define IF_GENERIC 0x200 // Generic interface. +#define IF_MIB 0x202 // Supports MIB-2 interface. + + +/*NOINC*/ +// +// NT DeviceIoControl definitions for TdiExtendedInformationEx functions. +// + +// +// QueryInformationEx IOCTL. The return buffer is passed as the OutputBuffer +// in the DeviceIoControl request. This structure is passed as the +// InputBuffer. +// + +typedef struct tcp_request_query_information_ex_xp { + TDIObjectID ID; // object ID to query. + ULONG_PTR Context[CONTEXT_SIZE/sizeof(ULONG_PTR)]; // multi-request + // context. Zeroed for the first request. +} TCP_REQUEST_QUERY_INFORMATION_EX_XP, *PTCP_REQUEST_QUERY_INFORMATION_EX_XP; + +#if defined(_WIN64) +typedef struct tcp_request_query_information_ex32_xp { + TDIObjectID ID; + ULONG32 Context[CONTEXT_SIZE/sizeof(ULONG32)]; +} TCP_REQUEST_QUERY_INFORMATION_EX32_XP, *PTCP_REQUEST_QUERY_INFORMATION_EX32_XP; +#endif // _WIN64 + +typedef struct tcp_request_query_information_ex_w2k { + TDIObjectID ID; // object ID to query. + uchar Context[CONTEXT_SIZE]; // multi-request context. Zeroed + // for the first request. +} TCP_REQUEST_QUERY_INFORMATION_EX_W2K, *PTCP_REQUEST_QUERY_INFORMATION_EX_W2K; + +#if (NTDDI_VERSION >= NTDDI_WINXP) +typedef TCP_REQUEST_QUERY_INFORMATION_EX_XP TCP_REQUEST_QUERY_INFORMATION_EX; +typedef TCP_REQUEST_QUERY_INFORMATION_EX* PTCP_REQUEST_QUERY_INFORMATION_EX; + +#if defined(_WIN64) +typedef TCP_REQUEST_QUERY_INFORMATION_EX32_XP TCP_REQUEST_QUERY_INFORMATION_EX32; +typedef TCP_REQUEST_QUERY_INFORMATION_EX32* PTCP_REQUEST_QUERY_INFORMATION_EX32; +#endif +#else +typedef TCP_REQUEST_QUERY_INFORMATION_EX_W2K TCP_REQUEST_QUERY_INFORMATION_EX; +typedef TCP_REQUEST_QUERY_INFORMATION_EX* PTCP_REQUEST_QUERY_INFORMATION_EX; +#endif + +// +// SetInformationEx IOCTL request structure. This structure is passed as the +// InputBuffer. The space allocated for the structure must be large enough +// to contain the structure and the set data buffer, which begins at the +// Buffer field. The OutputBuffer parameter in the DeviceIoControl is not used. +// +typedef struct tcp_request_set_information_ex { + TDIObjectID ID; // object ID to set. + unsigned int BufferSize; // size of the set data buffer in bytes + unsigned char Buffer[1]; // beginning of the set data buffer +} TCP_REQUEST_SET_INFORMATION_EX, *PTCP_REQUEST_SET_INFORMATION_EX; + +typedef enum { + EndpointIoControlType, + SetSockOptIoControlType, + GetSockOptIoControlType, + SocketIoControlType, +} TDI_TL_IO_CONTROL_TYPE, *PTDI_TL_IO_CONTROL_TYPE; + +typedef struct _TDI_TL_IO_CONTROL_ENDPOINT { + TDI_TL_IO_CONTROL_TYPE Type; + ULONG Level; + union { + ULONG IoControlCode; + ULONG OptionName; + }; + _Field_size_bytes_(InputBufferLength) PVOID InputBuffer; + ULONG InputBufferLength; + _Field_size_bytes_(OutputBufferLength) PVOID OutputBuffer; + ULONG OutputBufferLength; +} TDI_TL_IO_CONTROL_ENDPOINT, *PTDI_TL_IO_CONTROL_ENDPOINT; + +// +// Defined in the same space as the IOCTL_TDI_XXX IOCTLs in ntddtdi.h +// +#define IOCTL_TDI_TL_IO_CONTROL_ENDPOINT \ + CTL_CODE(FILE_DEVICE_TRANSPORT, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif // TDI_INFO_INCLUDED + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/traffic.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/traffic.h new file mode 100644 index 0000000000000000000000000000000000000000..31f1eae70a5bcf8c30796e2d4a5ed512f72c8a71 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/traffic.h @@ -0,0 +1,468 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + traffic.h + +Abstract: + + This module contains API definitions for the traffic control interface. + +--*/ + +#ifndef __TRAFFIC_H +#define __TRAFFIC_H + +#if _MSC_VER > 1000 +#pragma once +#endif +#include + +#pragma region Desktop Family or Traffic Package +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_TRAFFIC) + + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +//--------------------------------------------------------------------------- +// +// Define's +// +#define CURRENT_TCI_VERSION 0x0002 + + +// +// Definitions of notification events. These may be passed +// to the client's notification handler, to identify the +// notification type +// + +// +// A TC interface has come up +// +#define TC_NOTIFY_IFC_UP 1 +// +// A TC interface has come down +// +#define TC_NOTIFY_IFC_CLOSE 2 +// +// A change on a TC interface, typically a change in the +// list of supported network addresses +// +#define TC_NOTIFY_IFC_CHANGE 3 +// +// A TC parameter has changed +// +#define TC_NOTIFY_PARAM_CHANGED 4 +// +// A flow has been closed by the TC interface +// for example: after a remote call close, or the whole interface +// is going down +// +#define TC_NOTIFY_FLOW_CLOSE 5 + +#define TC_INVALID_HANDLE ((HANDLE)0) + +#define MAX_STRING_LENGTH 256 + + +//--------------------------------------------------------------------------- +// +// Typedef's and structures +// + +#ifndef CALLBACK +#define CALLBACK __stdcall +#endif + +#ifndef APIENTRY +#define APIENTRY FAR __stdcall +#endif + +// +// Handlers registered by the TCI client +// + +typedef +VOID (CALLBACK * TCI_NOTIFY_HANDLER)( + _In_ HANDLE ClRegCtx, + _In_ HANDLE ClIfcCtx, + _In_ ULONG Event, // See list below + _In_ HANDLE SubCode, + _In_ ULONG BufSize, + _In_reads_bytes_(BufSize) PVOID Buffer + ); + +typedef +VOID (CALLBACK * TCI_ADD_FLOW_COMPLETE_HANDLER)( + _In_ HANDLE ClFlowCtx, + _In_ ULONG Status + ); + +typedef +VOID (CALLBACK * TCI_MOD_FLOW_COMPLETE_HANDLER)( + _In_ HANDLE ClFlowCtx, + _In_ ULONG Status + ); + +typedef +VOID (CALLBACK * TCI_DEL_FLOW_COMPLETE_HANDLER)( + _In_ HANDLE ClFlowCtx, + _In_ ULONG Status + ); + + +typedef struct _TCI_CLIENT_FUNC_LIST { + + TCI_NOTIFY_HANDLER ClNotifyHandler; + TCI_ADD_FLOW_COMPLETE_HANDLER ClAddFlowCompleteHandler; + TCI_MOD_FLOW_COMPLETE_HANDLER ClModifyFlowCompleteHandler; + TCI_DEL_FLOW_COMPLETE_HANDLER ClDeleteFlowCompleteHandler; + +} TCI_CLIENT_FUNC_LIST, *PTCI_CLIENT_FUNC_LIST; + + +// +// Network address descriptor +// +typedef struct _ADDRESS_LIST_DESCRIPTOR { + + ULONG MediaType; + NETWORK_ADDRESS_LIST AddressList; + +} ADDRESS_LIST_DESCRIPTOR, *PADDRESS_LIST_DESCRIPTOR; + + +// +// An interface ID that is returned by the enumerator +// +typedef struct _TC_IFC_DESCRIPTOR { + + ULONG Length; + LPWSTR pInterfaceName; + LPWSTR pInterfaceID; + ADDRESS_LIST_DESCRIPTOR AddressListDesc; + +} TC_IFC_DESCRIPTOR, *PTC_IFC_DESCRIPTOR; + + +// +// This structure is returned by a QoS data provider in reply to +// GUID_QOS_SUPPORTED query or with an interface UP notification +// +typedef struct _TC_SUPPORTED_INFO_BUFFER { + + USHORT InstanceIDLength; + + // device or interface ID + WCHAR InstanceID[MAX_STRING_LENGTH]; + + // the NET_LUID for the interface + ULONG64 InterfaceLuid; + + // address list + ADDRESS_LIST_DESCRIPTOR AddrListDesc; + +} TC_SUPPORTED_INFO_BUFFER, *PTC_SUPPORTED_INFO_BUFFER; + + +// +// Filters are used to match packets. The Pattern field +// indicates the values to which bits in corresponding +// positions in candidate packets should be compared. The +// Mask field indicates which bits are to be compared and +// which bits are don't cares. +// +// Different filters can be submitted on the TCI interface. +// The generic filter structure is defined to include an +// AddressType, which indicates the specific type of filter to +// follow. +// + +typedef struct _TC_GEN_FILTER { + + USHORT AddressType; // IP, IPX, etc. + ULONG PatternSize; // byte count of the pattern + _Field_size_bytes_(PatternSize) PVOID Pattern; // specific format, e.g. IP_PATTERN + _Field_size_bytes_(PatternSize) PVOID Mask; // same type as Pattern + +} TC_GEN_FILTER, *PTC_GEN_FILTER; + + +// +// A generic flow includes two flowspecs and a freeform +// buffer which contains flow specific TC objects. +// +typedef struct _TC_GEN_FLOW { + + FLOWSPEC SendingFlowspec; + FLOWSPEC ReceivingFlowspec; + ULONG TcObjectsLength; // number of optional bytes + QOS_OBJECT_HDR TcObjects[1]; + +} TC_GEN_FLOW, *PTC_GEN_FLOW; + + +// +// Format of specific pattern or mask used by GPC for the IP protocol +// +typedef struct _IP_PATTERN { + + ULONG Reserved1; + ULONG Reserved2; + + ULONG SrcAddr; + ULONG DstAddr; + + union { + struct { USHORT s_srcport,s_dstport; } S_un_ports; + struct { UCHAR s_type,s_code; USHORT filler; } S_un_icmp; + ULONG S_Spi; + } S_un; + + UCHAR ProtocolId; + UCHAR Reserved3[3]; + +#define tcSrcPort S_un.S_un_ports.s_srcport +#define tcDstPort S_un.S_un_ports.s_dstport +#define tcIcmpType S_un.S_un_icmp.s_type +#define tcIcmpCode S_un.S_un_icmp.s_code +#define tcSpi S_un.S_Spi + +} IP_PATTERN, *PIP_PATTERN; + + +// +// Format of specific pattern or mask used by GPC for the IPX protocol +// +typedef struct _IPX_PATTERN { + + struct { + ULONG NetworkAddress; + UCHAR NodeAddress[6]; + USHORT Socket; + } Src, Dest; + +} IPX_PATTERN, *PIPX_PATTERN; + + +// +// The enumeration buffer is the flow parameters + a list of filters +// +typedef struct _ENUMERATION_BUFFER { + + ULONG Length; + ULONG OwnerProcessId; + USHORT FlowNameLength; + WCHAR FlowName[MAX_STRING_LENGTH]; + PTC_GEN_FLOW pFlow; + ULONG NumberOfFilters; + TC_GEN_FILTER GenericFilter[1]; // one for each filter + +} ENUMERATION_BUFFER, *PENUMERATION_BUFFER; + + +//--------------------------------------------------------------------------- +// +// Interface Function Definitions +// + +ULONG +APIENTRY +TcRegisterClient( + _In_ ULONG TciVersion, + _In_ HANDLE ClRegCtx, + _In_ PTCI_CLIENT_FUNC_LIST ClientHandlerList, + _Out_ PHANDLE pClientHandle + ); + +ULONG +APIENTRY +TcEnumerateInterfaces( + _In_ HANDLE ClientHandle, + _Inout_ PULONG pBufferSize, + _Out_ PTC_IFC_DESCRIPTOR InterfaceBuffer + ); + +ULONG +APIENTRY +TcOpenInterfaceA( + _In_ LPSTR pInterfaceName, + _In_ HANDLE ClientHandle, + _In_ HANDLE ClIfcCtx, + _Out_ PHANDLE pIfcHandle + ); + +ULONG +APIENTRY +TcOpenInterfaceW( + _In_ LPWSTR pInterfaceName, + _In_ HANDLE ClientHandle, + _In_ HANDLE ClIfcCtx, + _Out_ PHANDLE pIfcHandle + ); + +ULONG +APIENTRY +TcCloseInterface( + _In_ HANDLE IfcHandle + ); + +ULONG +APIENTRY +TcQueryInterface( + _In_ HANDLE IfcHandle, + _In_ LPGUID pGuidParam, + _In_ BOOLEAN NotifyChange, + _Inout_ PULONG pBufferSize, + _Out_writes_bytes_(*pBufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcSetInterface( + _In_ HANDLE IfcHandle, + _In_ LPGUID pGuidParam, + _In_ ULONG BufferSize, + _In_reads_bytes_(BufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcQueryFlowA( + _In_ LPSTR pFlowName, + _In_ LPGUID pGuidParam, + _Inout_ PULONG pBufferSize, + _Out_writes_bytes_(*pBufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcQueryFlowW( + _In_ LPWSTR pFlowName, + _In_ LPGUID pGuidParam, + _Inout_ PULONG pBufferSize, + _Out_writes_bytes_(*pBufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcSetFlowA( + _In_ LPSTR pFlowName, + _In_ LPGUID pGuidParam, + _In_ ULONG BufferSize, + _In_reads_bytes_(BufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcSetFlowW( + _In_ LPWSTR pFlowName, + _In_ LPGUID pGuidParam, + _In_ ULONG BufferSize, + _In_reads_bytes_(BufferSize) PVOID Buffer + ); + +ULONG +APIENTRY +TcAddFlow( + _In_ HANDLE IfcHandle, + _In_ HANDLE ClFlowCtx, + _In_ ULONG Flags, + _In_ PTC_GEN_FLOW pGenericFlow, + _Out_ PHANDLE pFlowHandle + ); + +ULONG +APIENTRY +TcGetFlowNameA( + _In_ HANDLE FlowHandle, + _In_ ULONG StrSize, + _Out_writes_(StrSize) LPSTR pFlowName + ); + +ULONG +APIENTRY +TcGetFlowNameW( + _In_ HANDLE FlowHandle, + _In_ ULONG StrSize, + _Out_writes_(StrSize) LPWSTR pFlowName + ); + +ULONG +APIENTRY +TcModifyFlow( + _In_ HANDLE FlowHandle, + _In_ PTC_GEN_FLOW pGenericFlow + ); + +ULONG +APIENTRY +TcAddFilter( + _In_ HANDLE FlowHandle, + _In_ PTC_GEN_FILTER pGenericFilter, + _Out_ PHANDLE pFilterHandle + ); + +ULONG +APIENTRY +TcDeregisterClient( + _In_ HANDLE ClientHandle + ); + +ULONG +APIENTRY +TcDeleteFlow( + _In_ HANDLE FlowHandle + ); + +ULONG +APIENTRY +TcDeleteFilter( + _In_ HANDLE FilterHandle + ); + +ULONG +APIENTRY +TcEnumerateFlows( + _In_ HANDLE IfcHandle, + _Inout_ PHANDLE pEnumHandle, + _Inout_ PULONG pFlowCount, + _Inout_ PULONG pBufSize, + _Out_ PENUMERATION_BUFFER Buffer + ); + +#ifdef UNICODE + +#define TcOpenInterface TcOpenInterfaceW +#define TcQueryFlow TcQueryFlowW +#define TcSetFlow TcSetFlowW +#define TcGetFlowName TcGetFlowNameW + +#else // UNICODE + +#define TcOpenInterface TcOpenInterfaceA +#define TcQueryFlow TcQueryFlowA +#define TcSetFlow TcSetFlowA +#define TcGetFlowName TcGetFlowNameA + +#endif // UNICODE + + +#ifdef __cplusplus +} +#endif + + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_PKG_TRAFFIC) */ +#pragma endregion + +#endif + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/transportsettingcommon.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/transportsettingcommon.h new file mode 100644 index 0000000000000000000000000000000000000000..3a8ba6720f3639c25b0d607f60c9fc81fef6b341 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/transportsettingcommon.h @@ -0,0 +1,45 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + transportsettingcommon.h + +Environment: + + User mode or kernel mode + +--*/ + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#ifndef _TRANSPORT_SETTING_COMMON_ +#define _TRANSPORT_SETTING_COMMON_ + +#ifdef _MSC_VER + +#pragma once + +#endif // _MSC_VER + +#ifdef __cplusplus +extern "C" { +#endif // __cplusplus + +// +// This structure represents the key used in query and apply transport setting +// APIs. +// +typedef struct TRANSPORT_SETTING_ID +{ + GUID Guid; +} TRANSPORT_SETTING_ID, *PTRANSPORT_SETTING_ID; + + +#ifdef __cplusplus +} +#endif // __cplusplus + +#endif // _TRANSPORT_SETTING_COMMON_ +#endif // (NTDDI_VERSION >= NTDDI_WIN8) \ No newline at end of file diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tvout.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tvout.h new file mode 100644 index 0000000000000000000000000000000000000000..a3e82d11f0661cb97d7d0bb5fee82750a7d68a45 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/tvout.h @@ -0,0 +1,97 @@ +#include + +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. +*/ + +#ifndef __TVOUT__ +#define __TVOUT__ + +#if _MSC_VER > 1000 +#pragma once +#endif + +#ifndef GUID_DEFINED +#include +#endif + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +typedef struct _VIDEOPARAMETERS { + GUID Guid; // GUID for this structure + ULONG dwOffset; // leave it 0 for now. + ULONG dwCommand; // VP_COMMAND_* SET or GET + ULONG dwFlags; // bitfield, defined below SET or GET + ULONG dwMode; // bitfield, defined below SET or GET + ULONG dwTVStandard; // bitfield, defined below SET or GET + ULONG dwAvailableModes; // bitfield, defined below GET + ULONG dwAvailableTVStandard; // bitfield, defined below GET + ULONG dwFlickerFilter; // value SET or GET + ULONG dwOverScanX; // value SET or GET + ULONG dwOverScanY; // SET or GET + ULONG dwMaxUnscaledX; // value SET or GET + ULONG dwMaxUnscaledY; // SET or GET + ULONG dwPositionX; // value SET or GET + ULONG dwPositionY; // SET or GET + ULONG dwBrightness; // value SET or GET + ULONG dwContrast; // value SET or GET + ULONG dwCPType; // copy protection type SET or GET + ULONG dwCPCommand; // VP_CP_CMD_ + ULONG dwCPStandard; // what TV standards CP is available on. GET + ULONG dwCPKey; + ULONG bCP_APSTriggerBits; // (a dword for alignment) SET(bits 0 and 1 valid). + UCHAR bOEMCopyProtection[256]; // oem specific copy protection data SET or GET +} VIDEOPARAMETERS, *PVIDEOPARAMETERS, *LPVIDEOPARAMETERS; + +#define VP_COMMAND_GET 0x0001 // size set, return caps. + // returned Flags = 0 if not supported. +#define VP_COMMAND_SET 0x0002 // size and params set. + +#define VP_FLAGS_TV_MODE 0x0001 +#define VP_FLAGS_TV_STANDARD 0x0002 +#define VP_FLAGS_FLICKER 0x0004 +#define VP_FLAGS_OVERSCAN 0x0008 +#define VP_FLAGS_MAX_UNSCALED 0x0010 // do not use on SET +#define VP_FLAGS_POSITION 0x0020 +#define VP_FLAGS_BRIGHTNESS 0x0040 +#define VP_FLAGS_CONTRAST 0x0080 +#define VP_FLAGS_COPYPROTECT 0x0100 + +#define VP_MODE_WIN_GRAPHICS 0x0001 +#define VP_MODE_TV_PLAYBACK 0x0002 // optimize for TV video playback + +#define VP_TV_STANDARD_NTSC_M 0x0001 // 75 IRE Setup +#define VP_TV_STANDARD_NTSC_M_J 0x0002 // Japan, 0 IRE Setup +#define VP_TV_STANDARD_PAL_B 0x0004 +#define VP_TV_STANDARD_PAL_D 0x0008 +#define VP_TV_STANDARD_PAL_H 0x0010 +#define VP_TV_STANDARD_PAL_I 0x0020 +#define VP_TV_STANDARD_PAL_M 0x0040 +#define VP_TV_STANDARD_PAL_N 0x0080 +#define VP_TV_STANDARD_SECAM_B 0x0100 +#define VP_TV_STANDARD_SECAM_D 0x0200 +#define VP_TV_STANDARD_SECAM_G 0x0400 +#define VP_TV_STANDARD_SECAM_H 0x0800 +#define VP_TV_STANDARD_SECAM_K 0x1000 +#define VP_TV_STANDARD_SECAM_K1 0x2000 +#define VP_TV_STANDARD_SECAM_L 0x4000 +#define VP_TV_STANDARD_WIN_VGA 0x8000 +// and the rest +#define VP_TV_STANDARD_NTSC_433 0x00010000 +#define VP_TV_STANDARD_PAL_G 0x00020000 +#define VP_TV_STANDARD_PAL_60 0x00040000 +#define VP_TV_STANDARD_SECAM_L1 0x00080000 + +#define VP_CP_TYPE_APS_TRIGGER 0x0001 // DVD trigger bits only +#define VP_CP_TYPE_MACROVISION 0x0002 // full macrovision data available + +#define VP_CP_CMD_ACTIVATE 0x0001 // CP command type +#define VP_CP_CMD_DEACTIVATE 0x0002 +#define VP_CP_CMD_CHANGE 0x0004 + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/udpmib.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/udpmib.h new file mode 100644 index 0000000000000000000000000000000000000000..0b0df755547143e4a514e26adf27171700098929 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/udpmib.h @@ -0,0 +1,220 @@ +/*++ + +Copyright (c) Microsoft Corporation + +Module Name: + + udpmib.h + +Abstract: + + This module contains the public definitions and structures for the + UDP-specific parts of MIB-II. These definitions were previously + in iprtrmib.h, which now includes this file. + +Environment: + + user mode or kernel mode + +--*/ + +#ifndef _UDPMIB_ +#define _UDPMIB_ +#pragma once +#include + +#pragma region Application Family or OneCore Family or Games Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) + + +#ifndef ANY_SIZE +#define ANY_SIZE 1 +#endif + +#define TCPIP_OWNING_MODULE_SIZE 16 + +typedef struct _MIB_UDPROW { + DWORD dwLocalAddr; + DWORD dwLocalPort; +} MIB_UDPROW, *PMIB_UDPROW; + +typedef struct _MIB_UDPTABLE { + DWORD dwNumEntries; + MIB_UDPROW table[ANY_SIZE]; +} MIB_UDPTABLE, *PMIB_UDPTABLE; + +#define SIZEOF_UDPTABLE(X) (FIELD_OFFSET(MIB_UDPTABLE, table[0]) + \ + ((X) * sizeof(MIB_UDPROW)) + ALIGN_SIZE) + +typedef struct _MIB_UDPROW_OWNER_PID { + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwOwningPid; +} MIB_UDPROW_OWNER_PID, *PMIB_UDPROW_OWNER_PID; + +typedef struct _MIB_UDPTABLE_OWNER_PID +{ + DWORD dwNumEntries; + MIB_UDPROW_OWNER_PID table[ANY_SIZE]; +} MIB_UDPTABLE_OWNER_PID, *PMIB_UDPTABLE_OWNER_PID; + +#define SIZEOF_UDPTABLE_OWNER_PID(X) (FIELD_OFFSET(MIB_UDPTABLE_OWNER_PID, table[0]) + \ + ((X) * sizeof(MIB_UDPROW_OWNER_PID)) + ALIGN_SIZE) + +typedef struct _MIB_UDPROW_OWNER_MODULE { + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + union { + struct { + int SpecificPortBind : 1; + }; + int dwFlags; + }; + ULONGLONG OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE]; +} MIB_UDPROW_OWNER_MODULE, *PMIB_UDPROW_OWNER_MODULE; + +typedef struct _MIB_UDPTABLE_OWNER_MODULE +{ + DWORD dwNumEntries; + MIB_UDPROW_OWNER_MODULE table[ANY_SIZE]; +} MIB_UDPTABLE_OWNER_MODULE, *PMIB_UDPTABLE_OWNER_MODULE; + +#define SIZEOF_UDPTABLE_OWNER_MODULE(X) (FIELD_OFFSET(MIB_UDPTABLE_OWNER_MODULE, table[0]) + \ + ((X) * sizeof(MIB_UDPROW_OWNER_MODULE)) + ALIGN_SIZE) + +typedef struct _MIB_UDPROW2 { + DWORD dwLocalAddr; + DWORD dwLocalPort; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + union { + struct { + int SpecificPortBind : 1; + }; + int dwFlags; + }; + ULONGLONG OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE]; + DWORD dwRemoteAddr; + DWORD dwRemotePort; +} MIB_UDPROW2, *PMIB_UDPROW2; + +typedef struct _MIB_UDPTABLE2 { + DWORD dwNumEntries; + MIB_UDPROW2 table[ANY_SIZE]; +} MIB_UDPTABLE2, *PMIB_UDPTABLE2; + +#define SIZEOF_UDPTABLE2(X) (FIELD_OFFSET(MIB_UDPTABLE2, table[0]) + \ + ((X) * sizeof(MIB_UDPROW2)) + ALIGN_SIZE) + +#ifdef _WS2IPDEF_ +// +// The following definitions require Winsock2. +// + +typedef struct _MIB_UDP6ROW { + IN6_ADDR dwLocalAddr; + DWORD dwLocalScopeId; + DWORD dwLocalPort; +} MIB_UDP6ROW, *PMIB_UDP6ROW; + +typedef struct _MIB_UDP6TABLE { + DWORD dwNumEntries; + MIB_UDP6ROW table[ANY_SIZE]; +} MIB_UDP6TABLE, *PMIB_UDP6TABLE; + +#define SIZEOF_UDP6TABLE(X) (FIELD_OFFSET(MIB_UDP6TABLE, table[0]) + \ + ((X) * sizeof(MIB_UDP6ROW)) + ALIGN_SIZE) + +typedef struct _MIB_UDP6ROW_OWNER_PID { + UCHAR ucLocalAddr[16]; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + DWORD dwOwningPid; +} MIB_UDP6ROW_OWNER_PID, *PMIB_UDP6ROW_OWNER_PID; + +typedef struct _MIB_UDP6TABLE_OWNER_PID +{ + DWORD dwNumEntries; + _Field_size_(dwNumEntries) + MIB_UDP6ROW_OWNER_PID table[ANY_SIZE]; +} MIB_UDP6TABLE_OWNER_PID, *PMIB_UDP6TABLE_OWNER_PID; + +#define SIZEOF_UDP6TABLE_OWNER_PID(X) (FIELD_OFFSET(MIB_UDP6TABLE_OWNER_PID, table[0]) + \ + ((X) * sizeof(MIB_UDP6ROW_OWNER_PID)) + ALIGN_SIZE) + +typedef struct _MIB_UDP6ROW_OWNER_MODULE { + UCHAR ucLocalAddr[16]; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + union { + struct { + int SpecificPortBind : 1; + }; + int dwFlags; + }; + ULONGLONG OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE]; +} MIB_UDP6ROW_OWNER_MODULE, *PMIB_UDP6ROW_OWNER_MODULE; + +typedef struct _MIB_UDP6TABLE_OWNER_MODULE +{ + DWORD dwNumEntries; + MIB_UDP6ROW_OWNER_MODULE table[ANY_SIZE]; +} MIB_UDP6TABLE_OWNER_MODULE, *PMIB_UDP6TABLE_OWNER_MODULE; + +#define SIZEOF_UDP6TABLE_OWNER_MODULE(X) (FIELD_OFFSET(MIB_UDP6TABLE_OWNER_MODULE, table[0]) + \ + ((X) * sizeof(MIB_UDP6ROW_OWNER_MODULE)) + ALIGN_SIZE) + +typedef struct _MIB_UDP6ROW2 { + UCHAR ucLocalAddr[16]; + DWORD dwLocalScopeId; + DWORD dwLocalPort; + DWORD dwOwningPid; + LARGE_INTEGER liCreateTimestamp; + union { + struct { + int SpecificPortBind : 1; + }; + int dwFlags; + }; + ULONGLONG OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE]; + UCHAR ucRemoteAddr[16]; + DWORD dwRemoteScopeId; + DWORD dwRemotePort; +} MIB_UDP6ROW2, *PMIB_UDP6ROW2; + +typedef struct _MIB_UDP6TABLE2 { + DWORD dwNumEntries; + MIB_UDP6ROW2 table[ANY_SIZE]; +} MIB_UDP6TABLE2, *PMIB_UDP6TABLE2; + +#define SIZEOF_UDP6TABLE2(X) (FIELD_OFFSET(MIB_UDP6TABLE2, table[0]) + \ + ((X) * sizeof(MIB_UDP6ROW2)) + ALIGN_SIZE) + +#endif // _WS2IPDEF_ + +typedef struct _MIB_UDPSTATS { + DWORD dwInDatagrams; + DWORD dwNoPorts; + DWORD dwInErrors; + DWORD dwOutDatagrams; + DWORD dwNumAddrs; +} MIB_UDPSTATS,*PMIB_UDPSTATS; + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) +typedef struct _MIB_UDPSTATS2 { + DWORD64 dw64InDatagrams; + DWORD dwNoPorts; + DWORD dwInErrors; + DWORD64 dw64OutDatagrams; + DWORD dwNumAddrs; +} MIB_UDPSTATS2, *PMIB_UDPSTATS2; +#endif + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM | WINAPI_PARTITION_GAMES) */ +#pragma endregion + +#endif // _UDPMIB_ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/unexposeenums2managed.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/unexposeenums2managed.h new file mode 100644 index 0000000000000000000000000000000000000000..de200967a4c0a7ad32abd89fc2fa32a9e99b92bb --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/unexposeenums2managed.h @@ -0,0 +1,38 @@ +//------------------------------------------------------------------------------ +// File: expose.h +// +// Desc: macros to allow the same enum to be exposed to native and managed. +// +// USAGE: +// +// see comments at top of exposeenums2managed.h +// +// Copyright (c) 2003-2004, Microsoft Corporation. All rights reserved. +//------------------------------------------------------------------------------ + +// !!! do not pragma once or macro guard this file. +// it gets used multiple times by the same compilation units + +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + +#undef V1_ENUM +#undef V1_ENUMG +#undef ENUM +#undef ENUMG +#undef ENUM16 +#undef FLAGS +#undef FLAGS16 +#undef TAG +#undef EHRECVR_MGD_NAMESPACE +#undef ANALOG_VIDEO_STANDARD_NAMESPACE +#undef RATLEVEL +#undef RATATTR + +// end of file - expose.h + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb.h new file mode 100644 index 0000000000000000000000000000000000000000..93f2f0804e81e9bbe8239b83a7600ccb1f391c61 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb.h @@ -0,0 +1,1024 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + USB.H + +Abstract: + + structures and APIs for USB drivers. + +Environment: + + Kernel & user mode + +Revision History: + + 09-29-95 : created + 02-10-04 : Updated to include header versioning + +--*/ + +#ifndef __USB_H__ +#define __USB_H__ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + +#ifndef PHYSICAL_ADDRESS +typedef LARGE_INTEGER PHYSICAL_ADDRESS; +#endif + +#ifndef _NTDDK_ +#ifndef _WDMDDK_ +typedef PVOID PIRP; +typedef PVOID PMDL; +#endif +#endif + +#define USBDI_VERSION 0x00000600 + +#include "usbspec.h" +#ifdef _WDMDDK_ +#endif + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // named type definition in parentheses +#pragma warning(disable:4214) // named type definition in parentheses + +#define USB_PORTATTR_NO_CONNECTOR 0x00000001 +#define USB_PORTATTR_SHARED_USB2 0x00000002 +#define USB_PORTATTR_MINI_CONNECTOR 0x00000004 +#define USB_PORTATTR_OEM_CONNECTOR 0x00000008 + +#define USB_PORTATTR_OWNED_BY_CC 0x01000000 +#define USB_PORTATTR_NO_OVERCURRENT_UI 0x02000000 + +typedef enum _USB_CONTROLLER_FLAVOR { + + USB_HcGeneric = 0, + + OHCI_Generic = 100, + OHCI_Hydra, + OHCI_NEC, + + UHCI_Generic = 200, + UHCI_Piix4 = 201, + UHCI_Piix3 = 202, + UHCI_Ich2 = 203, + UHCI_Reserved204 = 204, + UHCI_Ich1 = 205, + UHCI_Ich3m = 206, + UHCI_Ich4 = 207, + UHCI_Ich5 = 208, + UHCI_Ich6 = 209, + + UHCI_Intel = 249, + + UHCI_VIA = 250, + UHCI_VIA_x01 = 251, + UHCI_VIA_x02 = 252, + UHCI_VIA_x03 = 253, + UHCI_VIA_x04 = 254, + + UHCI_VIA_x0E_FIFO = 264, + + EHCI_Generic = 1000, + EHCI_NEC = 2000, + EHCI_Lucent = 3000, + EHCI_NVIDIA_Tegra2 = 4000, + EHCI_NVIDIA_Tegra3 = 4001, + EHCI_Intel_Medfield = 5001 + +} USB_CONTROLLER_FLAVOR; + +// +// USB defined structures and constants +// (see chapter 9 of USB specification) +// + +#define USB_DEFAULT_DEVICE_ADDRESS 0 +#define USB_DEFAULT_ENDPOINT_ADDRESS 0 + +// +// max packet size (bytes) for default endpoint +// until SET_ADDRESS command is received. +// + +#define USB_DEFAULT_MAX_PACKET 64 + +// +// USBD interface structures and constants +// + +#define URB_FROM_IRP(Irp) ((IoGetCurrentIrpStackLocation(Irp))->Parameters.Others.Argument1) + +// +// URB request codes +// + +#define URB_FUNCTION_SELECT_CONFIGURATION 0x0000 +#define URB_FUNCTION_SELECT_INTERFACE 0x0001 +#define URB_FUNCTION_ABORT_PIPE 0x0002 +#define URB_FUNCTION_TAKE_FRAME_LENGTH_CONTROL 0x0003 +#define URB_FUNCTION_RELEASE_FRAME_LENGTH_CONTROL 0x0004 +#define URB_FUNCTION_GET_FRAME_LENGTH 0x0005 +#define URB_FUNCTION_SET_FRAME_LENGTH 0x0006 +#define URB_FUNCTION_GET_CURRENT_FRAME_NUMBER 0x0007 +#define URB_FUNCTION_CONTROL_TRANSFER 0x0008 +#define URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER 0x0009 +#define URB_FUNCTION_ISOCH_TRANSFER 0x000A +#define URB_FUNCTION_GET_DESCRIPTOR_FROM_DEVICE 0x000B +#define URB_FUNCTION_SET_DESCRIPTOR_TO_DEVICE 0x000C +#define URB_FUNCTION_SET_FEATURE_TO_DEVICE 0x000D +#define URB_FUNCTION_SET_FEATURE_TO_INTERFACE 0x000E +#define URB_FUNCTION_SET_FEATURE_TO_ENDPOINT 0x000F +#define URB_FUNCTION_CLEAR_FEATURE_TO_DEVICE 0x0010 +#define URB_FUNCTION_CLEAR_FEATURE_TO_INTERFACE 0x0011 +#define URB_FUNCTION_CLEAR_FEATURE_TO_ENDPOINT 0x0012 +#define URB_FUNCTION_GET_STATUS_FROM_DEVICE 0x0013 +#define URB_FUNCTION_GET_STATUS_FROM_INTERFACE 0x0014 +#define URB_FUNCTION_GET_STATUS_FROM_ENDPOINT 0x0015 +#define URB_FUNCTION_RESERVED_0X0016 0x0016 +#define URB_FUNCTION_VENDOR_DEVICE 0x0017 +#define URB_FUNCTION_VENDOR_INTERFACE 0x0018 +#define URB_FUNCTION_VENDOR_ENDPOINT 0x0019 +#define URB_FUNCTION_CLASS_DEVICE 0x001A +#define URB_FUNCTION_CLASS_INTERFACE 0x001B +#define URB_FUNCTION_CLASS_ENDPOINT 0x001C +#define URB_FUNCTION_RESERVE_0X001D 0x001D +// previously URB_FUNCTION_RESET_PIPE +#define URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL 0x001E +#define URB_FUNCTION_CLASS_OTHER 0x001F +#define URB_FUNCTION_VENDOR_OTHER 0x0020 +#define URB_FUNCTION_GET_STATUS_FROM_OTHER 0x0021 +#define URB_FUNCTION_CLEAR_FEATURE_TO_OTHER 0x0022 +#define URB_FUNCTION_SET_FEATURE_TO_OTHER 0x0023 +#define URB_FUNCTION_GET_DESCRIPTOR_FROM_ENDPOINT 0x0024 +#define URB_FUNCTION_SET_DESCRIPTOR_TO_ENDPOINT 0x0025 +#define URB_FUNCTION_GET_CONFIGURATION 0x0026 +#define URB_FUNCTION_GET_INTERFACE 0x0027 +#define URB_FUNCTION_GET_DESCRIPTOR_FROM_INTERFACE 0x0028 +#define URB_FUNCTION_SET_DESCRIPTOR_TO_INTERFACE 0x0029 + +// Reserve 0x002B-0x002F +#define URB_FUNCTION_RESERVE_0X002B 0x002B +#define URB_FUNCTION_RESERVE_0X002C 0x002C +#define URB_FUNCTION_RESERVE_0X002D 0x002D +#define URB_FUNCTION_RESERVE_0X002E 0x002E +#define URB_FUNCTION_RESERVE_0X002F 0x002F + +// USB 2.0 calls start at 0x0030 + +#if (_WIN32_WINNT >= 0x0501) + +#define URB_FUNCTION_GET_MS_FEATURE_DESCRIPTOR 0x002A +#define URB_FUNCTION_SYNC_RESET_PIPE 0x0030 +#define URB_FUNCTION_SYNC_CLEAR_STALL 0x0031 + +#endif + +#if (_WIN32_WINNT >= 0x0600) + +#define URB_FUNCTION_CONTROL_TRANSFER_EX 0x0032 +#define URB_FUNCTION_RESERVE_0X0033 0x0033 +#define URB_FUNCTION_RESERVE_0X0034 0x0034 + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define URB_FUNCTION_OPEN_STATIC_STREAMS 0x0035 +#define URB_FUNCTION_CLOSE_STATIC_STREAMS 0x0036 +#define URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER_USING_CHAINED_MDL 0x0037 +#define URB_FUNCTION_ISOCH_TRANSFER_USING_CHAINED_MDL 0x0038 +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + + +#define URB_FUNCTION_GET_ISOCH_PIPE_TRANSFER_PATH_DELAYS 0x003D + +#endif + + +// for backward drivers +#define URB_FUNCTION_RESET_PIPE \ + URB_FUNCTION_SYNC_RESET_PIPE_AND_CLEAR_STALL + +// +// Values for URB TransferFlags Field +// + +#define USBD_SHORT_TRANSFER_OK 0x00000002 +#define USBD_START_ISO_TRANSFER_ASAP 0x00000004 +#define USBD_DEFAULT_PIPE_TRANSFER 0x00000008 + +#define USBD_TRANSFER_DIRECTION_OUT 0 +#define USBD_TRANSFER_DIRECTION_IN 1 +#define USBD_TRANSFER_DIRECTION USBD_TRANSFER_DIRECTION_IN + +#define USBD_TRANSFER_DIRECTION_FLAG(flags) ((flags) & USBD_TRANSFER_DIRECTION) + +#define VALID_TRANSFER_FLAGS_MASK (USBD_SHORT_TRANSFER_OK | \ + USBD_TRANSFER_DIRECTION | \ + USBD_START_ISO_TRANSFER_ASAP | \ + USBD_DEFAULT_PIPE_TRANSFER) + +#define USBD_ISO_START_FRAME_RANGE 1024 + +typedef LONG USBD_STATUS; + +// +// USBD status codes +// +// Status values are 32 bit values layed out as follows: +// +// 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 +// 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 +// +---+---------------------------+-------------------------------+ +// | S | Status Code | +// +---+---------------------------+-------------------------------+ +// +// where +// +// S - is the state code +// +// 00 - completed with success +// 01 - request is pending +// 11, 10 - completed with error +// +// +// Code - is the status code +// + +// +// Generic test for success on any status value (non-negative numbers +// indicate success). +// + +#define USBD_SUCCESS(Status) ((USBD_STATUS)(Status) >= 0) + +// +// Generic test for pending status value. +// + +#define USBD_PENDING(Status) ((ULONG)(Status) >> 30 == 1) + +// +// Generic test for error on any status value. +// + +#define USBD_ERROR(Status) ((USBD_STATUS)(Status) < 0) + +#define USBD_STATUS_SUCCESS ((USBD_STATUS)0x00000000L) +#define USBD_STATUS_PORT_OPERATION_PENDING ((USBD_STATUS)0x00000001L) +#define USBD_STATUS_PENDING ((USBD_STATUS)0x40000000L) + +// +// HC (Hardware) status codes range 0x00000001 - 0x000000FF +// + +#define USBD_STATUS_CRC ((USBD_STATUS)0xC0000001L) +#define USBD_STATUS_BTSTUFF ((USBD_STATUS)0xC0000002L) +#define USBD_STATUS_DATA_TOGGLE_MISMATCH ((USBD_STATUS)0xC0000003L) +#define USBD_STATUS_STALL_PID ((USBD_STATUS)0xC0000004L) +#define USBD_STATUS_DEV_NOT_RESPONDING ((USBD_STATUS)0xC0000005L) +#define USBD_STATUS_PID_CHECK_FAILURE ((USBD_STATUS)0xC0000006L) +#define USBD_STATUS_UNEXPECTED_PID ((USBD_STATUS)0xC0000007L) +#define USBD_STATUS_DATA_OVERRUN ((USBD_STATUS)0xC0000008L) +#define USBD_STATUS_DATA_UNDERRUN ((USBD_STATUS)0xC0000009L) +#define USBD_STATUS_RESERVED1 ((USBD_STATUS)0xC000000AL) +#define USBD_STATUS_RESERVED2 ((USBD_STATUS)0xC000000BL) +#define USBD_STATUS_BUFFER_OVERRUN ((USBD_STATUS)0xC000000CL) +#define USBD_STATUS_BUFFER_UNDERRUN ((USBD_STATUS)0xC000000DL) +#define USBD_STATUS_NOT_ACCESSED ((USBD_STATUS)0xC000000FL) +#define USBD_STATUS_FIFO ((USBD_STATUS)0xC0000010L) +#define USBD_STATUS_XACT_ERROR ((USBD_STATUS)0xC0000011L) +#define USBD_STATUS_BABBLE_DETECTED ((USBD_STATUS)0xC0000012L) +#define USBD_STATUS_DATA_BUFFER_ERROR ((USBD_STATUS)0xC0000013L) +#define USBD_STATUS_NO_PING_RESPONSE ((USBD_STATUS)0xC0000014L) +#define USBD_STATUS_INVALID_STREAM_TYPE ((USBD_STATUS)0xC0000015L) +#define USBD_STATUS_INVALID_STREAM_ID ((USBD_STATUS)0xC0000016L) +#define USBD_STATUS_ENDPOINT_HALTED ((USBD_STATUS)0xC0000030L) + +// +// Software status codes +// +#define USBD_STATUS_INVALID_URB_FUNCTION ((USBD_STATUS)0x80000200L) +#define USBD_STATUS_INVALID_PARAMETER ((USBD_STATUS)0x80000300L) +#define USBD_STATUS_ERROR_BUSY ((USBD_STATUS)0x80000400L) +#define USBD_STATUS_INVALID_PIPE_HANDLE ((USBD_STATUS)0x80000600L) +#define USBD_STATUS_NO_BANDWIDTH ((USBD_STATUS)0x80000700L) +#define USBD_STATUS_INTERNAL_HC_ERROR ((USBD_STATUS)0x80000800L) +#define USBD_STATUS_ERROR_SHORT_TRANSFER ((USBD_STATUS)0x80000900L) +#define USBD_STATUS_BAD_START_FRAME ((USBD_STATUS)0xC0000A00L) +#define USBD_STATUS_ISOCH_REQUEST_FAILED ((USBD_STATUS)0xC0000B00L) +#define USBD_STATUS_FRAME_CONTROL_OWNED ((USBD_STATUS)0xC0000C00L) +#define USBD_STATUS_FRAME_CONTROL_NOT_OWNED ((USBD_STATUS)0xC0000D00L) +#define USBD_STATUS_NOT_SUPPORTED ((USBD_STATUS)0xC0000E00L) +#define USBD_STATUS_INAVLID_CONFIGURATION_DESCRIPTOR \ + ((USBD_STATUS)0xC0000F00L) +#define USBD_STATUS_INVALID_CONFIGURATION_DESCRIPTOR \ + ((USBD_STATUS)0xC0000F00L) +#define USBD_STATUS_INSUFFICIENT_RESOURCES ((USBD_STATUS)0xC0001000L) +#define USBD_STATUS_SET_CONFIG_FAILED ((USBD_STATUS)0xC0002000L) +#define USBD_STATUS_BUFFER_TOO_SMALL ((USBD_STATUS)0xC0003000L) +#define USBD_STATUS_INTERFACE_NOT_FOUND ((USBD_STATUS)0xC0004000L) +#define USBD_STATUS_INAVLID_PIPE_FLAGS ((USBD_STATUS)0xC0005000L) +#define USBD_STATUS_TIMEOUT ((USBD_STATUS)0xC0006000L) +#define USBD_STATUS_DEVICE_GONE ((USBD_STATUS)0xC0007000L) +#define USBD_STATUS_STATUS_NOT_MAPPED ((USBD_STATUS)0xC0008000L) +#define USBD_STATUS_HUB_INTERNAL_ERROR ((USBD_STATUS)0xC0009000L) +#define USBD_STATUS_CANCELED ((USBD_STATUS)0xC0010000L) +#define USBD_STATUS_ISO_NOT_ACCESSED_BY_HW ((USBD_STATUS)0xC0020000L) +#define USBD_STATUS_ISO_TD_ERROR ((USBD_STATUS)0xC0030000L) +#define USBD_STATUS_ISO_NA_LATE_USBPORT ((USBD_STATUS)0xC0040000L) +#define USBD_STATUS_ISO_NOT_ACCESSED_LATE ((USBD_STATUS)0xC0050000L) +#define USBD_STATUS_BAD_DESCRIPTOR ((USBD_STATUS)0xC0100000L) +#define USBD_STATUS_BAD_DESCRIPTOR_BLEN ((USBD_STATUS)0xC0100001L) +#define USBD_STATUS_BAD_DESCRIPTOR_TYPE ((USBD_STATUS)0xC0100002L) +#define USBD_STATUS_BAD_INTERFACE_DESCRIPTOR ((USBD_STATUS)0xC0100003L) +#define USBD_STATUS_BAD_ENDPOINT_DESCRIPTOR ((USBD_STATUS)0xC0100004L) +#define USBD_STATUS_BAD_INTERFACE_ASSOC_DESCRIPTOR \ + ((USBD_STATUS)0xC0100005L) +#define USBD_STATUS_BAD_CONFIG_DESC_LENGTH ((USBD_STATUS)0xC0100006L) +#define USBD_STATUS_BAD_NUMBER_OF_INTERFACES ((USBD_STATUS)0xC0100007L) +#define USBD_STATUS_BAD_NUMBER_OF_ENDPOINTS ((USBD_STATUS)0xC0100008L) +#define USBD_STATUS_BAD_ENDPOINT_ADDRESS ((USBD_STATUS)0xC0100009L) + +typedef PVOID USBD_PIPE_HANDLE; +typedef PVOID USBD_CONFIGURATION_HANDLE; +typedef PVOID USBD_INTERFACE_HANDLE; + +#if (_WIN32_WINNT >= 0x0501) + +#define USBD_DEFAULT_MAXIMUM_TRANSFER_SIZE 0xFFFFFFFF + +#else + +#define USBD_DEFAULT_MAXIMUM_TRANSFER_SIZE PAGE_SIZE + +#endif + +typedef struct _USBD_VERSION_INFORMATION { + ULONG USBDI_Version; + ULONG Supported_USB_Version; +} USBD_VERSION_INFORMATION, *PUSBD_VERSION_INFORMATION; + +typedef enum _USBD_PIPE_TYPE { + UsbdPipeTypeControl, + UsbdPipeTypeIsochronous, + UsbdPipeTypeBulk, + UsbdPipeTypeInterrupt +} USBD_PIPE_TYPE; + +#define USBD_PIPE_DIRECTION_IN(pipeInformation) ((pipeInformation)->EndpointAddress & \ + USB_ENDPOINT_DIRECTION_MASK) + +typedef struct _USBD_DEVICE_INFORMATION { + ULONG OffsetNext; + PVOID UsbdDeviceHandle; + USB_DEVICE_DESCRIPTOR DeviceDescriptor; +} USBD_DEVICE_INFORMATION, *PUSBD_DEVICE_INFORMATION; + +typedef struct _USBD_PIPE_INFORMATION { + USHORT MaximumPacketSize; + UCHAR EndpointAddress; + UCHAR Interval; + USBD_PIPE_TYPE PipeType; + USBD_PIPE_HANDLE PipeHandle; + ULONG MaximumTransferSize; + ULONG PipeFlags; +} USBD_PIPE_INFORMATION, *PUSBD_PIPE_INFORMATION; + +// +// values for PipeFlags field in USBD_PIPE_INFORMATION struct +// + +// +// override the enpoint max_packet size with the value in pipe_information +// field +// +#define USBD_PF_CHANGE_MAX_PACKET 0x00000001 + +// +// optimize for short packets 'bulk optimization #1' +// +#define USBD_PF_SHORT_PACKET_OPT 0x00000002 + +// +// optimize transfers for use with 'real time threads +// +#define USBD_PF_ENABLE_RT_THREAD_ACCESS 0x00000004 + +// +// causes the driver to allocate map more transfers in the queue. +// +#define USBD_PF_MAP_ADD_TRANSFERS 0x00000008 + +#define USBD_PF_VIDEO_PRIORITY 0x00000010 +#define USBD_PF_VOICE_PRIORITY 0x00000020 +#define USBD_PF_INTERACTIVE_PRIORITY 0x00000030 + +#define USBD_PF_PRIORITY_MASK 0x000000F0 + + +#if (NTDDI_VERSION >= NTDDI_WIN10_VB) + +// +// Inform the USB hub driver that the client is enlightened to handle +// SuperSpeedPlus high bandwidth Isochronous endpoints and expects the +// bytes per interval to be captured in the MaximumTransferSize field +// of the pipe information instead of the MaximumPacketSize field. +// The USB hub driver will set the USBD_PF_SSP_HIGH_BANDWIDTH_ISOCH +// flag for any such pipes if the client opts in by first setting this flag. +// +#define USBD_PF_HANDLES_SSP_HIGH_BANDWIDTH_ISOCH 0x00000100 + +// +// Inform the client that the pipe is a high bandwidth SuperSpeedPlus +// Isochronous endpoint and the bytes per interval are captured in +// the MaximumTransferSize field of the pipe information instead +// of the MaximumPacketSize field. Note: this flag communicates pipe +// properties from the host to the client, whereas other pipe flags +// have historically been used to communicate intent from the client +// to the host. As such, this flag is not included in the USBD_PF_VALID_MASK +// and is only meaningful if the client has set the +// USBD_PF_HANDLES_SSP_HIGH_BANDWIDTH_ISOCH flag. +// +#define USBD_PF_SSP_HIGH_BANDWIDTH_ISOCH 0x00010000 + +#define USBD_PF_VALID_MASK (USBD_PF_CHANGE_MAX_PACKET | \ + USBD_PF_SHORT_PACKET_OPT | \ + USBD_PF_ENABLE_RT_THREAD_ACCESS | \ + USBD_PF_MAP_ADD_TRANSFERS | \ + USBD_PF_VIDEO_PRIORITY | \ + USBD_PF_VOICE_PRIORITY | \ + USBD_PF_INTERACTIVE_PRIORITY | \ + USBD_PF_HANDLES_SSP_HIGH_BANDWIDTH_ISOCH) + +#else // (NTDDI_VERSION < NTDDI_WIN10_VB) + +#define USBD_PF_VALID_MASK (USBD_PF_CHANGE_MAX_PACKET | \ + USBD_PF_SHORT_PACKET_OPT | \ + USBD_PF_ENABLE_RT_THREAD_ACCESS | \ + USBD_PF_MAP_ADD_TRANSFERS | \ + USBD_PF_VIDEO_PRIORITY | \ + USBD_PF_VOICE_PRIORITY | \ + USBD_PF_INTERACTIVE_PRIORITY) + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +typedef enum _USBD_ENDPOINT_OFFLOAD_MODE { + + UsbdEndpointOffloadModeNotSupported = 0, + UsbdEndpointOffloadSoftwareAssisted, + UsbdEndpointOffloadHardwareAssisted + +} USBD_ENDPOINT_OFFLOAD_MODE; + +#pragma pack(push) +#pragma pack(1) + +typedef struct _USBD_ENDPOINT_OFFLOAD_INFORMATION_V1 { + + ULONG Size; + + // + // Input field to be filled in by USB client driver + // + + USHORT EndpointAddress; + + ULONG ResourceId; // Valid only in hardware assisted offload mode. + + // + // Output fields returned by the USB host controller driver if the specified + // endpoint (in EndpointAddress) was successfully setup for offload mode. + // + + USBD_ENDPOINT_OFFLOAD_MODE Mode; + + // + // Fields from SLOT_CONTEXT describing the device. + // Valid for both hardware and software assisted endpoint + // offload modes. + // + + ULONG RootHubPortNumber:8; + ULONG RouteString:20; + ULONG Speed:4; + + ULONG UsbDeviceAddress:8; + ULONG SlotId:8; + ULONG MultiTT:1; + + ULONG LSOrFSDeviceConnectedToTTHub:1; + ULONG Reserved0:14; + + // + // OUTPUT - Transfer ring information. + // Valid only in software assisted offload mode. + // + + PHYSICAL_ADDRESS TransferSegmentLA; + PVOID TransferSegmentVA; + size_t TransferRingSize; + ULONG TransferRingInitialCycleBit; + + // + // OUTPUT - Secondary event ring information + // Valid only in software assisted offload mode. + // + + ULONG MessageNumber; + PHYSICAL_ADDRESS EventRingSegmentLA; + PVOID EventRingSegmentVA; + size_t EventRingSize; + ULONG EventRingInitialCycleBit; + +} USBD_ENDPOINT_OFFLOAD_INFORMATION_V1, *PUSBD_ENDPOINT_OFFLOAD_INFORMATION_V1; + +typedef struct _USBD_ENDPOINT_OFFLOAD_INFORMATION { + + ULONG Size; + + // + // Input field to be filled in by USB client driver + // + + USHORT EndpointAddress; + + ULONG ResourceId; // Valid only in hardware assisted offload mode. + + // + // Output fields returned by the USB host controller driver if the specified + // endpoint (in EndpointAddress) was successfully setup for offload mode. + // + + USBD_ENDPOINT_OFFLOAD_MODE Mode; + + // + // Fields from SLOT_CONTEXT describing the device. + // Valid for both hardware and software assisted endpoint + // offload modes. + // + + ULONG RootHubPortNumber:8; + ULONG RouteString:20; + ULONG Speed:4; + + ULONG UsbDeviceAddress:8; + ULONG SlotId:8; + ULONG MultiTT:1; + + ULONG LSOrFSDeviceConnectedToTTHub:1; + ULONG Reserved0:14; + + // + // OUTPUT - Transfer ring information. + // Valid only in software assisted offload mode. + // + + PHYSICAL_ADDRESS TransferSegmentLA; + PVOID TransferSegmentVA; + size_t TransferRingSize; + ULONG TransferRingInitialCycleBit; + + // + // OUTPUT - Secondary event ring information + // Valid only in software assisted offload mode. + // + + ULONG MessageNumber; + PHYSICAL_ADDRESS EventRingSegmentLA; + PVOID EventRingSegmentVA; + size_t EventRingSize; + ULONG EventRingInitialCycleBit; + + // + // +++ + // New fields added in _V2 version follow here. + // --- + // + + // + // INPUT - Transfer ring segments provided by the sideband component. + // Output remains in the "Transfer Ring Information" above". + // Valid only in software assisted endpoint offload mode and + // must belong to the IO/device address space. It should be page + // aligned and size must be a multiple of PAGE_SIZE. + // + + PHYSICAL_ADDRESS ClientTransferRingSegmentPAIn; + size_t ClientTransferRingSizeIn; + + // + // INPUT - Data buffers provided by the sideband component. + // Valid only in software assisted endpoint offload mode and + // must belong to the IO/device address space. It should be page + // aligned and size must be a multiple of PAGE_SIZE. + // + + PHYSICAL_ADDRESS ClientDataBufferPAIn; + size_t ClientDataBufferSizeIn; + + // + // OUTPUT - fields describing mapped data buffer + // Valid only in software assisted offload mode. + // + + PHYSICAL_ADDRESS ClientDataBufferLAOut; + PVOID ClientDataBufferVAOut; + +} USBD_ENDPOINT_OFFLOAD_INFORMATION, *PUSBD_ENDPOINT_OFFLOAD_INFORMATION, + USBD_ENDPOINT_OFFLOAD_INFORMATION_V2, *PUSBD_ENDPOINT_OFFLOAD_INFORMATION_V2; + +C_ASSERT(sizeof(USBD_ENDPOINT_OFFLOAD_INFORMATION_V2) > sizeof(USBD_ENDPOINT_OFFLOAD_INFORMATION_V1)); +C_ASSERT(sizeof(USBD_ENDPOINT_OFFLOAD_INFORMATION) > sizeof(USBD_ENDPOINT_OFFLOAD_INFORMATION_V1)); + +#pragma pack(pop) + +#endif + +typedef struct _USBD_INTERFACE_INFORMATION { + USHORT Length; + UCHAR InterfaceNumber; + UCHAR AlternateSetting; + UCHAR Class; + UCHAR SubClass; + UCHAR Protocol; + UCHAR Reserved; + USBD_INTERFACE_HANDLE InterfaceHandle; + ULONG NumberOfPipes; + USBD_PIPE_INFORMATION Pipes[1]; +} USBD_INTERFACE_INFORMATION, *PUSBD_INTERFACE_INFORMATION; + +struct _URB_HCD_AREA { + PVOID Reserved8[8]; +}; + +struct _URB_HEADER { + USHORT Length; + USHORT Function; + USBD_STATUS Status; + PVOID UsbdDeviceHandle; // Reserved + ULONG UsbdFlags; // Reserved +}; + +struct _URB_SELECT_INTERFACE { + struct _URB_HEADER Hdr; + USBD_CONFIGURATION_HANDLE ConfigurationHandle; + USBD_INTERFACE_INFORMATION Interface; +}; + + +struct _URB_SELECT_CONFIGURATION { + struct _URB_HEADER Hdr; + PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor; + USBD_CONFIGURATION_HANDLE ConfigurationHandle; + USBD_INTERFACE_INFORMATION Interface; +}; + +struct _URB_PIPE_REQUEST { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG Reserved; +}; + +struct _URB_FRAME_LENGTH_CONTROL { + struct _URB_HEADER Hdr; +}; + +struct _URB_GET_FRAME_LENGTH { + struct _URB_HEADER Hdr; + ULONG FrameLength; + ULONG FrameNumber; +}; + +struct _URB_SET_FRAME_LENGTH { + struct _URB_HEADER Hdr; + LONG FrameLengthDelta; +}; + +struct _URB_GET_CURRENT_FRAME_NUMBER { + struct _URB_HEADER Hdr; + ULONG FrameNumber; +}; + +struct _URB_CONTROL_DESCRIPTOR_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved0; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + USHORT Reserved1; + UCHAR Index; + UCHAR DescriptorType; + USHORT LanguageId; + USHORT Reserved2; +}; + +struct _URB_CONTROL_GET_STATUS_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved0; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR Reserved1[4]; + USHORT Index; + USHORT Reserved2; +}; + +struct _URB_CONTROL_FEATURE_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved2; + ULONG Reserved3; + PVOID Reserved4; + PMDL Reserved5; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + USHORT Reserved0; + USHORT FeatureSelector; + USHORT Index; + USHORT Reserved1; +}; + +struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG TransferFlags; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR RequestTypeReservedBits; + UCHAR Request; + USHORT Value; + USHORT Index; + USHORT Reserved1; +}; + +struct _URB_CONTROL_GET_INTERFACE_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved0; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR Reserved1[4]; + USHORT Interface; + USHORT Reserved2; +}; + +struct _URB_CONTROL_GET_CONFIGURATION_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved0; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; //Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR Reserved1[8]; +}; + +#if (_WIN32_WINNT >= 0x0501) + +#define OS_STRING_DESCRIPTOR_INDEX 0xEE + +#define MS_GENRE_DESCRIPTOR_INDEX 0x0001 +#define MS_POWER_DESCRIPTOR_INDEX 0x0002 + +#define MS_OS_STRING_SIGNATURE L"MSFT100" + +#define MS_OS_FLAGS_CONTAINERID 0x02 + +typedef struct _OS_STRING { + UCHAR bLength; + UCHAR bDescriptorType; + WCHAR MicrosoftString[7]; + UCHAR bVendorCode; + union { + UCHAR bPad; + UCHAR bFlags; + }; +} OS_STRING, *POS_STRING; + +struct _URB_OS_FEATURE_DESCRIPTOR_REQUEST { + struct _URB_HEADER Hdr; + PVOID Reserved; + ULONG Reserved0; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR Recipient:5; + UCHAR Reserved1:3; + UCHAR Reserved2; + UCHAR InterfaceNumber; + UCHAR MS_PageIndex; + USHORT MS_FeatureDescriptorIndex; + USHORT Reserved3; +}; + +#endif + +struct _URB_CONTROL_TRANSFER { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG TransferFlags; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + UCHAR SetupPacket[8]; +}; + +#if (_WIN32_WINNT >= 0x0600) + +struct _URB_CONTROL_TRANSFER_EX { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG TransferFlags; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + ULONG Timeout; +#ifdef WIN64 + ULONG Pad; +#endif + struct _URB_HCD_AREA hca; // Reserved + UCHAR SetupPacket[8]; +}; + +#endif + +struct _URB_BULK_OR_INTERRUPT_TRANSFER { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG TransferFlags; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved +}; + +typedef struct _USBD_ISO_PACKET_DESCRIPTOR { + ULONG Offset; + ULONG Length; + USBD_STATUS Status; +} USBD_ISO_PACKET_DESCRIPTOR, *PUSBD_ISO_PACKET_DESCRIPTOR; + +struct _URB_ISOCH_TRANSFER { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG TransferFlags; + ULONG TransferBufferLength; + PVOID TransferBuffer; + PMDL TransferBufferMDL; + struct _URB *UrbLink; // Reserved + struct _URB_HCD_AREA hca; // Reserved + ULONG StartFrame; + ULONG NumberOfPackets; + ULONG ErrorCount; + USBD_ISO_PACKET_DESCRIPTOR IsoPacket[1]; +}; + +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define URB_OPEN_STATIC_STREAMS_VERSION_100 0x100 + +typedef struct _USBD_STREAM_INFORMATION { + USBD_PIPE_HANDLE PipeHandle; + ULONG StreamID; + ULONG MaximumTransferSize; + ULONG PipeFlags; +} USBD_STREAM_INFORMATION, *PUSBD_STREAM_INFORMATION; + +struct _URB_OPEN_STATIC_STREAMS { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG NumberOfStreams; + USHORT StreamInfoVersion; + USHORT StreamInfoSize; + PUSBD_STREAM_INFORMATION Streams; +}; + +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +struct _URB_GET_ISOCH_PIPE_TRANSFER_PATH_DELAYS { + struct _URB_HEADER Hdr; + USBD_PIPE_HANDLE PipeHandle; + ULONG MaximumSendPathDelayInMilliSeconds; + ULONG MaximumCompletionPathDelayInMilliSeconds; +}; + +#endif + +typedef _Struct_size_bytes_(UrbHeader.Length) struct _URB { + union { + struct _URB_HEADER + UrbHeader; + struct _URB_SELECT_INTERFACE + UrbSelectInterface; + struct _URB_SELECT_CONFIGURATION + UrbSelectConfiguration; + struct _URB_PIPE_REQUEST + UrbPipeRequest; + struct _URB_FRAME_LENGTH_CONTROL + UrbFrameLengthControl; + struct _URB_GET_FRAME_LENGTH + UrbGetFrameLength; + struct _URB_SET_FRAME_LENGTH + UrbSetFrameLength; + struct _URB_GET_CURRENT_FRAME_NUMBER + UrbGetCurrentFrameNumber; + struct _URB_CONTROL_TRANSFER + UrbControlTransfer; + + #if (_WIN32_WINNT >= 0x0600) + + struct _URB_CONTROL_TRANSFER_EX + UrbControlTransferEx; + + #endif + + struct _URB_BULK_OR_INTERRUPT_TRANSFER + UrbBulkOrInterruptTransfer; + struct _URB_ISOCH_TRANSFER + UrbIsochronousTransfer; + struct _URB_CONTROL_DESCRIPTOR_REQUEST + UrbControlDescriptorRequest; + struct _URB_CONTROL_GET_STATUS_REQUEST + UrbControlGetStatusRequest; + struct _URB_CONTROL_FEATURE_REQUEST + UrbControlFeatureRequest; + struct _URB_CONTROL_VENDOR_OR_CLASS_REQUEST + UrbControlVendorClassRequest; + struct _URB_CONTROL_GET_INTERFACE_REQUEST + UrbControlGetInterfaceRequest; + struct _URB_CONTROL_GET_CONFIGURATION_REQUEST + UrbControlGetConfigurationRequest; + + #if (_WIN32_WINNT >= 0x0501) + + struct _URB_OS_FEATURE_DESCRIPTOR_REQUEST + UrbOSFeatureDescriptorRequest; + #endif + + #if (NTDDI_VERSION >= NTDDI_WIN8) + + struct _URB_OPEN_STATIC_STREAMS + UrbOpenStaticStreams; + + #endif + + + #if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + + + struct _URB_GET_ISOCH_PIPE_TRANSFER_PATH_DELAYS + UrbGetIsochPipeTransferPathDelays; + + #endif + + }; + +} URB, *PURB; + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* __USB_H__ */ + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb100.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb100.h new file mode 100644 index 0000000000000000000000000000000000000000..5ccb840e7b710e8c8a6093ec1d29d8f553195462 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb100.h @@ -0,0 +1,18 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +#ifndef __USB100_H__ +#define __USB100_H__ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#include "usbspec.h" + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* __USB100_H__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb200.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb200.h new file mode 100644 index 0000000000000000000000000000000000000000..85e888cd7285f5dd5d1d794b8e1e537a83a1a894 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb200.h @@ -0,0 +1,18 @@ +// +// Copyright (C) Microsoft. All rights reserved. +// +#ifndef __USB200_H__ +#define __USB200_H__ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + +#include "usbspec.h" + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif // __USB200_H__ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb4dbgioctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb4dbgioctl.h new file mode 100644 index 0000000000000000000000000000000000000000..6736120490f797a5981a8ef89da44eba0370f797 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usb4dbgioctl.h @@ -0,0 +1,141 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + usb4dbgioctl.h + +Abstract: + + The USB4 debug interface definitions. + +--*/ + +#pragma once + +#include + + +// +// USB4 Specfication Chapter 6.1 +// + +#define USB4_MAX_DEPTH 6 + +// +// USB4 Specfication Chapter 6.4.2.3 Table 6-2 +// + +typedef enum { + + USB4PathConfigurationSpace = 0, + USB4AdapterConfigurationSpace = 1, + USB4RouterConfigurationSpace = 2, + USB4CounterConfigurationSpace = 3 + +} USB4_CONFIG_SPACE_TYPE; + +// +// USB4 Specfication Chapter 6.5 Table 6-11 +// + +typedef enum { + + ErrConn = 0, + ErrLink = 1, + ErrAddr = 2, + ErrAdp = 4, + HpAck = 7, + ErrEnum = 8, + ErrNua = 9, + ErrLen = 11, + ErrHec = 12, + ErrFc = 13, + ErrPlug = 14, + ErrLock = 15, + DpBw = 32, + + // + // V2 events + // + + RopCmplt = 33, + PopCmplt = 34, + PcieWake = 35, + DpConChange = 36, + DpTxDiscovery = 37, + LinkRecovery = 38, + AsymLink = 39, + + // + // The following are not spec defined but are useful for + // software to convey additional status information from + // the HRD to the DRD when completing requests. + // + + PollingSkipped = 252, + PollingTimeout = 253, + StatusSuccess = 254, // Nominal success + StatusUnknown = 255 // Nominal failure + +} USB4_STATUS; + +#define USB4_CONFIGURATION_REGISTERS_DW_LENGTH 60 + +// {981FCA05-60D3-4BB3-898E-497C580C4FB3} +DEFINE_GUID(USB4_HRD_DEBUG_INTERFACE, + 0x981fca05, 0x60d3, 0x4bb3, 0x89, 0x8e, 0x49, 0x7c, 0x58, 0xc, 0x4f, 0xb3); + +#define USB4_HRD_DEBUG_INTERFACE_REFERENCE_STRING L"\\DEBUGINTERFACE" + +// +// USB4 HRD Debug IOCTL Function Codes +// + +#define USB4_HRD_DEBUG_FUNCTION_READ_CONFIGURATION_SPACE 1131 + +#define IOCTL_USB4_HRD_DEBUG_READ_CONFIGURATION_SPACE \ + CTL_CODE(FILE_DEVICE_USB4,\ + USB4_HRD_DEBUG_FUNCTION_READ_CONFIGURATION_SPACE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +typedef struct _USB4_HRD_DEBUG_ROUTE_STRING +{ + + UINT8 Depth; + UINT8 Route[USB4_MAX_DEPTH + 1]; + +} USB4_HRD_DEBUG_ROUTE_STRING, *PUSB4_HRD_DEBUG_ROUTE_STRING; + +// +// Input buffer +// + +typedef struct _USB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_INPUT { + + USB4_HRD_DEBUG_ROUTE_STRING Route; + UINT8 AdapterNumber; + USB4_CONFIG_SPACE_TYPE ConfigurationSpaceType; + UINT32 DwOffset; + UINT32 DwLength; + +} USB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_INPUT, + *PUSB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_INPUT; + +// +// Output buffer +// + +typedef struct _USB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_OUTPUT { + + USB4_STATUS Usb4Status; + UINT32 Data[USB4_CONFIGURATION_REGISTERS_DW_LENGTH]; + +} USB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_OUTPUT, + *PUSB4_HRD_DEBUG_READ_CONFIGURATION_SPACE_OUTPUT; + + +#include + diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbdi.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbdi.h new file mode 100644 index 0000000000000000000000000000000000000000..54979b7023bd1e716f8b735a33f130ca81c55f79 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbdi.h @@ -0,0 +1,80 @@ +/*++ + +Copyright 2004(c) Microsoft Corporation. All rights reserved. + +Module Name: + + USBDI.H + +Abstract: + + Obsolete header. Use usb.h. + +Environment: + + Kernel & user mode + +Revision History: + + 09-29-95 : created + 02-01-04 : updated to use usb.h + +--*/ + +#ifndef __USBDI_H__ +#define __USBDI_H__ +#include + +#pragma region Desktop Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) + + +#include + +#include + +// +// The following are deprecated definitions. These should not be used +// + +#define USBD_STATUS_CANCELLING ((USBD_STATUS)0x00020000L) +#define USBD_STATUS_CANCELING ((USBD_STATUS)0x00020000L) +#define USBD_STATUS_NO_MEMORY ((USBD_STATUS)0x80000100L) +#define USBD_STATUS_ERROR ((USBD_STATUS)0x80000000L) +#define USBD_STATUS_REQUEST_FAILED ((USBD_STATUS)0x80000500L) +#define USBD_STATUS_HALTED ((USBD_STATUS)0xC0000000L) + + +#define USBD_HALTED(Status) ((ULONG)(Status) >> 30 == 3) +#define USBD_STATUS(Status) ((ULONG)(Status) & 0x0FFFFFFFL) + +#define URB_FUNCTION_RESERVED0 0x0016 +#define URB_FUNCTION_RESERVED 0x001D +#define URB_FUNCTION_LAST 0x0029 + +#define USBD_PF_DOUBLE_BUFFER 0x00000002 + +#ifdef USBD_PF_VALID_MASK +#undef USBD_PF_VALID_MASK +#endif + +#define USBD_PF_VALID_MASK (USBD_PF_CHANGE_MAX_PACKET | \ + USBD_PF_DOUBLE_BUFFER | \ + USBD_PF_ENABLE_RT_THREAD_ACCESS | \ + USBD_PF_MAP_ADD_TRANSFERS) + +#define USBD_TRANSFER_DIRECTION_BIT 0 +#define USBD_SHORT_TRANSFER_OK_BIT 1 +#define USBD_START_ISO_TRANSFER_ASAP_BIT 2 + +#ifdef USBD_TRANSFER_DIRECTION +#undef USBD_TRANSFER_DIRECTION +#endif + +#define USBD_TRANSFER_DIRECTION(x) ((x) & USBD_TRANSFER_DIRECTION_IN) + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) */ +#pragma endregion + +#endif /* __USBDI_H__ */ diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbfnbase.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbfnbase.h new file mode 100644 index 0000000000000000000000000000000000000000..f35a3f89829ce59a92f0c855e0e70ba6e43f8247 --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbfnbase.h @@ -0,0 +1,372 @@ +/*++ + +Copyright (C) Microsoft Corporation. All rights reserved. + +Module Name: + + usbfnbase.h + +Abstract: + + This header defines all interfaces and macros that USB Function class + drivers will require to implement class driver functionality. + +Environment: + + Kernel and user mode + +--*/ +#pragma once + +// +// Includes +// +#include + +// +// Registry path for the USBFn Enumeration keys +// +#define KREGUSBFNENUMPATH L"\\Registry\\Machine\\SYSTEM\\CurrentControlSet\\Control\\USBFN\\" +#define UREGUSBFNENUMPATH L"HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\USBFN\\" + +// +// Registry path for the USBFn Enumeration keys (manufacturing mode) +// +#define KREGMANUSBFNENUMPATH L"\\Registry\\Machine\\SYSTEM\\CurrentControlSet\\Control\\ManufacturingMode\\Current\\USBFN\\" +#define UREGMANUSBFNENUMPATH L"HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\ManufacturingMode\\Current\\USBFN\\" + + +// +// Structure definitions +// + +// +// A configuration can have upto 15 endpoints plus Endpoint 0 which belongs to the device. +// That translates into 16 pipes, including the pipe belonging to EP0. +// + +#define MAX_NUM_USBFN_ENDPOINTS 15 +#define MAX_NUM_USBFN_PIPES (MAX_NUM_USBFN_ENDPOINTS)+1 + +// +// Maximum length of a configuration length supported. +// + +#define MAX_CONFIGURATION_NAME_LENGTH 40 + +#define MAX_USB_STRING_LENGTH 255 + +// +// Maximum number of supported configurations +// + +#define MAX_SUPPORTED_CONFIGURATIONS 12 + +// +// if an interrupt endpoint's wMaxPacketSize should not be updated based on +// the current speed of the device and limit it to whatever was mentioned in +// the registry, wMaxPacketSize's MSB should be set to 1. Or the function stack +// will update it to an optimal value based on current connection speed. +// If this mask is set to wMaxPacketSize of the endpoint descriptor, then that +// endpoint's wMaxPacketSize will not be updated according to the current speed. +#define USBFN_INTERRUPT_ENDPOINT_SIZE_NOT_UPDATEABLE_MASK 0x80 + +// +// USB Electrical Test Mode selectors +// + +#define USB_TEST_MODE_TEST_J 0x01 +#define USB_TEST_MODE_TEST_K 0x02 +#define USB_TEST_MODE_TEST_SE0_NAK 0x03 +#define USB_TEST_MODE_TEST_PACKET 0x04 +#define USB_TEST_MODE_TEST_FORCE_ENABLE 0x05 + +// +// Maximum length of an interface name. +// + +#define MAX_INTERFACE_NAME_LENGTH 40 +#define MAX_ALTERNATE_NAME_LENGTH 40 +#define MAX_ASSOCIATION_NAME_LENGTH 40 + +// +// Maximum length of an interface GUID string. +// + +#define MAX_INTERFACE_GUID_SIZE (sizeof(L"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}")) +#define MAX_INTERFACE_GUID_LENGTH (MAX_INTERFACE_GUID_SIZE / sizeof(WCHAR)) + +// +// Notifications sent to class drivers. +// +typedef enum _USBFN_EVENT +{ + UsbfnEventMinimum = 0x0, + // + // VBUS is powered. + // No action is required. + // + UsbfnEventAttach, + + // + // USBFN has completed a USB Reset. + // If previously configured, class drivers should + // reset their state. Transfer requests will be cancelled. + // + UsbfnEventReset, + + // + // VBUS is no longer powered. + // If previously configured, class drivers should + // reset their state. Transfer requests will be cancelled. + // The BusSpeed field of the notification is set appropriately. + // + UsbfnEventDetach, + + // + // There have been no SOF packets on the bus for 3ms. + // If a class driver wishes to issue a remote wakeup, + // please use IOCTL_INTERNAL_USBFN_SIGNAL_REMOTE_WAKEUP. + // + UsbfnEventSuspend, + + // + // USBFN has resumed from suspend to the previous state. + // + UsbfnEventResume, + + // + // USBFN has received a setup packet with + // bmRequestType.Type == BMREQUEST_CLASS and + // bmRequestType.Recipient == BMREQUEST_TO_INTERFACE. + // USBFN has forwarded this setup packet to the class driver + // specified in wIndex.LowByte. + // + // The setup packet is available in the SetupPacket field of the + // event. If the control transfer does not require a data stage, + // class drivers should respond with + // IOCTL_INTERNAL_USBFN_CONTROL_STATUS_HANDSHAKE_OUT. + // If a data stage is required, class drivers should respond with + // one or more IOCTL_INTERNAL_USBFN_TRANSFER*, followed by + // IOCTL_INTERNAL_USBFN_CONTROL_STATUS_HANDSHAKE* in the opposite + // direction. + // + UsbfnEventSetupPacket, + + // + // USBFN has received a SET_CONFIGURATION setup packet. Transfer + // requests from class drivers are now permitted. + // The ConfigurationValue of the notification is set to wValue.W. + // + UsbfnEventConfigured, + + // + // USBFN has received a SET_CONFIGURATION setup packet with + // wValue.W == 0. If previously configured, class drivers should + // reset their state. Transfer requests will be cancelled. + // + UsbfnEventUnConfigured, + + // + // Deprecated. + // + UsbfnEventPortType, + + // + // Deprecated. + // + UsbfnEventBusTearDown, + + // + // USBFN has received a SET_INTERFACE setup packet. On receiving this + // notification the class driver should query for the new endpoint set + // for the interface. + // + UsbfnEventSetInterface, + + UsbfnEventMaximum +} USBFN_EVENT, *PUSBFN_EVENT; + + +// +// USBFN Port Types +// +typedef enum _USBFN_PORT_TYPE { + UsbfnUnknownPort = 0, + UsbfnStandardDownstreamPort, + UsbfnChargingDownstreamPort, + UsbfnDedicatedChargingPort, + UsbfnInvalidDedicatedChargingPort, + UsbfnProprietaryDedicatedChargingPort, + UsbfnPortTypeMaximum +} USBFN_PORT_TYPE, *PUSBFN_PORT_TYPE; + + +// +// Possible USB Bus speeds +// +typedef enum _USBFN_BUS_SPEED +{ + UsbfnBusSpeedLow, + UsbfnBusSpeedFull, + UsbfnBusSpeedHigh, + UsbfnBusSpeedSuper, + UsbfnBusSpeedMaximum +} USBFN_BUS_SPEED, *PUSBFN_BUS_SPEED; + +// +// Possible USB Bus transfer and endpoint directions +// + +typedef enum _USBFN_DIRECTION +{ + UsbfnDirectionMinimum = 0x0, + UsbfnDirectionIn, + UsbfnDirectionOut, + UsbfnDirectionTx = UsbfnDirectionIn, + UsbfnDirectionRx = UsbfnDirectionOut, + UsbfnDirectionMaximum +} USBFN_DIRECTION, *PUSBFN_DIRECTION; + +// +// These states indicated the current state of the USB driver. +// This should be used by class-extension clients only. +// +typedef enum _USBFN_DEVICE_STATE { + UsbfnDeviceStateMinimum = 0x0, + // + // VBUS is powered + // + UsbfnDeviceStateAttached, + + // + // USBFN has received a USB Reset. + // + UsbfnDeviceStateDefault, + + // + // VBUS is not powered. + // + UsbfnDeviceStateDetached, + + // + // USBFN has received a SET_ADDRESS setup packet. + // + UsbfnDeviceStateAddressed, + + // + // USBFN has received a SET_CONFIGURATION setup packet. + // + UsbfnDeviceStateConfigured, + + // + // There have been no SOF packets on the bus for 3ms. + // + UsbfnDeviceStateSuspended, + + UsbfnDeviceStateStateMaximum +} USBFN_DEVICE_STATE, *PUSBFN_DEVICE_STATE; + + +typedef struct _ALTERNATE_INTERFACE { + USHORT InterfaceNumber; + USHORT AlternateInterfaceNumber; +} ALTERNATE_INTERFACE, *PALTERNATE_INTERFACE; + + +// +// Notification structure used by class drivers to receive information +// about USBFN. Please see the definition of USBFN_EVENT to for details +// about each event. +// +typedef struct _USBFN_NOTIFICATION +{ + USBFN_EVENT Event; + + union + { + USBFN_BUS_SPEED BusSpeed; + USB_DEFAULT_PIPE_SETUP_PACKET SetupPacket; + USHORT ConfigurationValue; + USBFN_PORT_TYPE PortType; + ALTERNATE_INTERFACE AlternateInterface; + } u; + +} USBFN_NOTIFICATION, *PUSBFN_NOTIFICATION; + +// +// Defines an endpoint pipe index (not the address) +// +typedef ULONG USBFNPIPEID; +typedef USBFNPIPEID *PUSBFNPIPEID; + +typedef struct _USBFN_PIPE_INFORMATION { + USB_ENDPOINT_DESCRIPTOR EpDesc; + USBFNPIPEID PipeId; +} USBFN_PIPE_INFORMATION, *PUSBFN_PIPE_INFORMATION; + +typedef struct _USBFN_CLASS_INTERFACE { + UINT8 InterfaceNumber; + UINT8 PipeCount; + USBFN_PIPE_INFORMATION PipeArr[MAX_NUM_USBFN_PIPES]; +} USBFN_CLASS_INTERFACE, *PUSBFN_CLASS_INTERFACE; + +typedef struct _USBFN_CLASS_INFORMATION_PACKET { + USBFN_CLASS_INTERFACE FullSpeedClassInterface; + USBFN_CLASS_INTERFACE HighSpeedClassInterface; + WCHAR InterfaceName[MAX_INTERFACE_NAME_LENGTH]; + WCHAR InterfaceGuid[MAX_INTERFACE_GUID_LENGTH]; + BOOLEAN HasInterfaceGuid; + USBFN_CLASS_INTERFACE SuperSpeedClassInterface; +} USBFN_CLASS_INFORMATION_PACKET, *PUSBFN_CLASS_INFORMATION_PACKET; + +typedef struct _USBFN_CLASS_INTERFACE_EX { + UINT8 BaseInterfaceNumber; + UINT8 InterfaceCount; + UINT8 PipeCount; + USBFN_PIPE_INFORMATION PipeArr[MAX_NUM_USBFN_PIPES]; +} USBFN_CLASS_INTERFACE_EX, *PUSBFN_CLASS_INTERFACE_EX; + +typedef struct _USBFN_CLASS_INFORMATION_PACKET_EX { + USBFN_CLASS_INTERFACE_EX FullSpeedClassInterfaceEx; + USBFN_CLASS_INTERFACE_EX HighSpeedClassInterfaceEx; + USBFN_CLASS_INTERFACE_EX SuperSpeedClassInterfaceEx; + WCHAR InterfaceName[MAX_INTERFACE_NAME_LENGTH]; + WCHAR InterfaceGuid[MAX_INTERFACE_GUID_LENGTH]; + BOOLEAN HasInterfaceGuid; +} USBFN_CLASS_INFORMATION_PACKET_EX, *PUSBFN_CLASS_INFORMATION_PACKET_EX; + +typedef struct _USBFN_INTERFACE_INFO { + UINT8 InterfaceNumber; + USBFN_BUS_SPEED Speed; + USHORT Size; + UCHAR InterfaceDescriptorSet[1]; +} USBFN_INTERFACE_INFO, *PUSBFN_INTERFACE_INFO; + +typedef struct _USBFN_USB_STRING { + UINT8 StringIndex; + WCHAR UsbString[MAX_USB_STRING_LENGTH]; +} USBFN_USB_STRING, *PUSBFN_USB_STRING; + + +// +// Configuration packet that gives information about +// an available configuration. +// +typedef struct _USBFN_BUS_CONFIGURATION_INFO { + // + // NULL terminated wide char string indicating the name of a configuration + // + WCHAR ConfigurationName[MAX_CONFIGURATION_NAME_LENGTH]; + // + // BOOLEAN, indicating if this configuration is / should be the + // considered as current configuation. + // + BOOLEAN IsCurrent; + // + // The state of this configuration - is this configuration active? + // This is a read-only information returned by Class Extension and + // will be ignored in requests to Class extension. + // + BOOLEAN IsActive; +} USBFN_BUS_CONFIGURATION_INFO, *PUSBFN_BUS_CONFIGURATION_INFO; diff --git a/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbioctl.h b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbioctl.h new file mode 100644 index 0000000000000000000000000000000000000000..e06a5c4931edef89783e602747d0259779c43b4e --- /dev/null +++ b/msvc/Windows Kits/10/Include/10.0.26100.0/shared/usbioctl.h @@ -0,0 +1,1912 @@ +/*++ + +Copyright (c) Microsoft Corporation. All rights reserved. + +Module Name: + + USBIOCTL.H + +Abstract: + + This file defines both kernel and user mode IOCTL + codes supported by the USB core stack. + + These APIs are the APIS supported by th USB hub driver and the USB bus + driver AKA USBPORT. + + Typically only user mode applications (usbui) or the hub driver include this + file, USB drivers should use usbdrivr.h usb bus drivers should include + usbkern.h + +Environment: + + Kernel & user mode + +Revision History: + + 09-29-95 : created + 01-06-97 : added user mode hub ioctls + 10-31-99 : cleanup and document, jdunn + 1-25-03 : more cleanup and documentation + 2-10-04 : header versioning + +--*/ + +#ifndef __USBIOCTL_H__ +#define __USBIOCTL_H__ +#include + +#pragma region Desktop Family or OneCore Family +#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) + + + +#include "usb200.h" + +#if _MSC_VER >= 1200 +#pragma warning(push) +#endif +#pragma warning(disable:4201) // named type definition in parentheses +#pragma warning(disable:4214) // named type definition in parentheses +#pragma warning(disable:4200) // named type definition in parentheses + + +#ifndef FAR +#define FAR +#endif + +#include "usbiodef.h" + +/* + IOCTL definitions +*/ + +/* + USB kernel Mode IOCTLS +*/ + +/* +Routine Description: +Define the standard USB 'URB' IOCTL + +IOCTL_INTERNAL_USB_SUBMIT_URB + +This IOCTL is used by client drivers to submit URB (USB Request Blocks) + +Parameters.Others.Argument1 = pointer to URB + +*/ + +#define IOCTL_INTERNAL_USB_SUBMIT_URB \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_SUBMIT_URB, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_RESET_PORT + + This IOCTL is used by kernel mode drivers to reset their + upstream port. + + After a successful reset the device is re-configured to the + same configuration it was in before the reset. All pipe + handles, configuration handles and interface handles remain + valid. + +*/ + +#define IOCTL_INTERNAL_USB_RESET_PORT \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_RESET_PORT, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO + +Routine Description: +This function is used to by hubs to get the top of the physical USB stack. +All IRPs passed to a hub PDO are either serviced by the hub or forwarded +directly to the top of the bus driver stack i.e. the root hub PDO. A filter +driver interested only in bus traffic (AKA Urbs) can see such traffic by +attaching to the top of the root hub PDO, see section 9. + +Parameters: +ioStackLocation->Parameters.Others.Argument1 +>>RootHubPhysicalDeviceObject +This parameter contains a pointer that is filled in with the root hub PDO. +This is the actual PDO created by the USBPORT driver for the root hub. + +ioStackLocation->Parameters.Others.Argument2 +>> HcdTopOfStack +This parameter contains a pointer that is filled in with the top of the bus +driver stack is the device object returned when the hub driver attached to +top of the device stack associated with the root hub PDO. +*/ + +#define IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_ROOTHUB_PDO, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + + + +#define USBD_PORT_ENABLED 0x00000001 +#define USBD_PORT_CONNECTED 0x00000002 + +/* IOCTL_INTERNAL_USB_GET_PORT_STATUS + +Routine Description: +This function returns the current 'live' status of the port. It can be used +by client drivers to determine the current state of their device because +certain hardware errors on the bus can result in a device port being disabled +. The hub driver must communicate with the hub to get this information, if +it cannot for some reason a failure status is returned. + +This API will fail if called at raised IRQL. + +IRQL: Passive + +Parameters: +ioStackLocation->Parameters.Others.Argument1 +A pointer to a ULONG that is filled in with the port status bits defined below: + +*/ + +#define IOCTL_INTERNAL_USB_GET_PORT_STATUS \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_PORT_STATUS, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* + IOCTL_INTERNAL_USB_ENABLE_PORT is obsolete, drivers should use + IOCTL_INTERNAL_USB_RESET_PORT +*/ + +#define IOCTL_INTERNAL_USB_ENABLE_PORT \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_ENABLE_PORT, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + + +/* IOCTL_INTERNAL_USB_GET_HUB_COUNT + +Routine Description: +This function is used to count the number of hubs in the stack. It is used +to enforce the electrical limitation of no more that 5 hubs plus the root +being chained together. + +Parameters: +ioStackLocation->Parameters.Others.Argument1 +>>Count +This parameter contains a pointer that is filled in with the current count of +hubs in the stack. Each instance of the hub driver that receives the IRP +increments the counter and passes the irp on to its' PDO. When the Irp +reaches the hub that is the root the IRP is completed. This will result in +the count value being equal to the number of hubs (including the root). + + +*/ + +#define IOCTL_INTERNAL_USB_GET_HUB_COUNT \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_COUNT, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_CYCLE_PORT + + This IOCTL will simulate a plug/unplug on the drivers upstream + port. The device will be removed and re-added by PnP. +*/ + +#define IOCTL_INTERNAL_USB_CYCLE_PORT \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_CYCLE_PORT, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_GET_HUB_NAME + +Routine Description: +This API returns the UNICODE symbolic name for the PDO if the PDO is for a +usbhub, otherwise a NULL string is returned. The symbolic name can be used +to retrieve additional information about the hub through user mode ioctl apis +and WMI calls. + +Parameters: +ioStackLocation->Parameters.DeviceIoControl.OutputBufferLength +Length of buffer passed bytes. + +Irp->AssociatedIrp.SystemBuffer +A pointer to a structure (USB_HUB_NAME) to receive the symbolic name. + + USB_BUS_NOTIFICATION. +ActualLength - The structure size in bytes necessary to hold the NULL + terminated symbolic link name. This includes the entire structure, not + just the name. + + HubName - The UNICODE NULL terminated symbolic link name of the external +hub attached to the port. If there is no external hub attached to the port a +single NULL is returned. + +*/ + +#define IOCTL_INTERNAL_USB_GET_HUB_NAME \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* + IOCTL_INTERNAL_USB_GET_BUS_INFO is obsolete -- it has been replaced by the + USB_BUSIFFN_QUERY_BUS_INFORMATION service available thru the usb stack bus + interface. Drivers should use the bus interface function instead +*/ +#define IOCTL_INTERNAL_USB_GET_BUS_INFO CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_BUS_INFO, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_GET_CONTROLLER_NAME CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_CONTROLLER_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_GET_BUSGUID_INFO CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_BUSGUID_INFO, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_GET_PARENT_HUB_INFO CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_PARENT_HUB_INFO, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* + USB kernel Mode IOCTLS defined for windows XP and later +*/ + +#if (_WIN32_WINNT >= 0x0501) + +/* IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION + +This ioctl registers a device to receive notification when a specific +timeout has expired and it should now be suspended in order to conserve +power. If all devices on a hub are suspended, then the actual hub +can be suspended. + +Routine Description: +This function is part of the hub drivers selective suspend feature (see +section 2 usbhub.doc). This API is serviced only by hubs it is not supported +by a USB Port driver. The client USB drivers use this API to register an idle +callback request with the parent hub. The details on how this API is handled +can be found in section 2. + +Parameters: +ioStackLocation->Parameters.Others.Argument1 +>>IdeCallbackInfo +A pointer to a structure containing the callback routine and a context value. + +_IRQL_requires_max_(PASSIVE_LEVEL) +typedef +VOID +(*USB_IDLE_CALLBACK)( + _In_ PVOID Context + ); + +typedef struct _USB_IDLE_CALLBACK_INFO { + USB_IDLE_CALLBACK IdleCallback; + PVOID IdleContext; +} USB_IDLE_CALLBACK_INFO, *PUSB_IDLE_CALLBACK_INFO; + +*/ + +#define IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_IDLE_NOTIFICATION, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE + +Routine Description: +This function returns the device handle associated with the callers PDO. The +device handle is an opaque structure that is used as a parameter for other +APIs/ + +Parameters: +ioStackLocation->Parameters.Others.Argument1 +A pointer to a device handle (pointer to pointer). +*/ + +#define IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_DEVICE_HANDLE, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#endif + +/* + USB kernel Mode IOCTLS defined for windows Longhorn and later +*/ + +#if (_WIN32_WINNT >= 0x0600) + + +#define IOCTL_INTERNAL_USB_NOTIFY_IDLE_READY CTL_CODE(FILE_DEVICE_USB, \ + USB_IDLE_NOTIFICATION_EX, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_REQ_GLOBAL_SUSPEND CTL_CODE(FILE_DEVICE_USB, \ + USB_REQ_GLOBAL_SUSPEND, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_REQ_GLOBAL_RESUME CTL_CODE(FILE_DEVICE_USB, \ + USB_REQ_GLOBAL_RESUME, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_RECORD_FAILURE + +*/ + +#ifdef USB20_API +typedef struct _USB_START_FAILDATA { + ULONG LengthInBytes; + NTSTATUS NtStatus; + USBD_STATUS UsbdStatus; + ULONG ConnectStatus; + UCHAR DriverData[4]; +} USB_START_FAILDATA, *PUSB_START_FAILDATA; +#endif + +#define IOCTL_INTERNAL_USB_RECORD_FAILURE CTL_CODE(FILE_DEVICE_USB, \ + USB_RECORD_FAILURE, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + + +#define IOCTL_INTERNAL_USB_GET_DEVICE_HANDLE_EX CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_DEVICE_HANDLE_EX, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_GET_TT_DEVICE_HANDLE CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_TT_DEVICE_HANDLE, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +/* IOCTL_INTERNAL_USB_GET_TOPOLOGY_ADDRESS */ + +typedef struct _USB_TOPOLOGY_ADDRESS { + ULONG PciBusNumber; + ULONG PciDeviceNumber; + ULONG PciFunctionNumber; + ULONG Reserved; + USHORT RootHubPortNumber; + USHORT HubPortNumber[5]; + USHORT Reserved2; +} USB_TOPOLOGY_ADDRESS, *PUSB_TOPOLOGY_ADDRESS; + +#define IOCTL_INTERNAL_USB_GET_TOPOLOGY_ADDRESS CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_TOPOLOGY_ADDRESS, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_GET_DEVICE_CONFIG_INFO CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_CONFIG_INFO, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#endif + + +#if (NTDDI_VERSION >= NTDDI_WIN8) +/* + USB kernel Mode IOCTLS defined for Win8 and later. + Pivot on NTDDI_VERSION instead of _WIN32_WINNT + Note: These ioctls use FILE_DEVICE_USBEX. + All previously defined USB Ioctls use FILE_DEVICE_USB (aka FILE_DEVICE_UNKNOWN). +*/ + +#define IOCTL_INTERNAL_USB_REGISTER_COMPOSITE_DEVICE CTL_CODE(FILE_DEVICE_USBEX,\ + USB_REGISTER_COMPOSITE_DEVICE, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_UNREGISTER_COMPOSITE_DEVICE CTL_CODE(FILE_DEVICE_USBEX,\ + USB_UNREGISTER_COMPOSITE_DEVICE, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#define IOCTL_INTERNAL_USB_REQUEST_REMOTE_WAKE_NOTIFICATION CTL_CODE(FILE_DEVICE_USBEX,\ + USB_REQUEST_REMOTE_WAKE_NOTIFICATION, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#endif + +#if (NTDDI_VERSION >= NTDDI_WIN10) + +/* IOCTL_INTERNAL_USB_FAIL_GET_STATUS_FROM_DEVICE + + This IOCTL is used by kernel mode drivers to inform HUB driver + that device doesn't support IOCTL_INTERNAL_USB_GET_STATUS_FROM_DEVICE +*/ + +#define IOCTL_INTERNAL_USB_FAIL_GET_STATUS_FROM_DEVICE CTL_CODE(FILE_DEVICE_USB, \ + USB_FAIL_GET_STATUS, \ + METHOD_NEITHER, \ + FILE_ANY_ACCESS) + +#endif + +/* + USB user mode IOCTLS +*/ +#ifndef USB_KERNEL_IOCTL + +/************************************************************************** +The following IOCTLS are always sent to the HCD symbolic name +***************************************************************************/ + +/* IOCTL_USB_HCD_GET_STATS_1 (OPTIONAL) + + The following IOCTL is used to return internal statictics + for HCDs + +*/ + +#define IOCTL_USB_HCD_GET_STATS_1 CTL_CODE(FILE_DEVICE_USB, \ + HCD_GET_STATS_1, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* IOCTL_USB_HCD_GET_STATS_2 (OPTIONAL) + + The following IOCTL is used to return internal statictics + for HCDs + +*/ + +#define IOCTL_USB_HCD_GET_STATS_2 CTL_CODE(FILE_DEVICE_USB, \ + HCD_GET_STATS_2, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_HCD_DISABLE_PORT CTL_CODE(FILE_DEVICE_USB, \ + HCD_DISABLE_PORT, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_HCD_ENABLE_PORT CTL_CODE(FILE_DEVICE_USB, \ + HCD_ENABLE_PORT, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + + +/* + These ioctls are used for USB diagnostic and test applications +*/ +#ifndef IOCTL_USB_DIAGNOSTIC_MODE_ON +#define IOCTL_USB_DIAGNOSTIC_MODE_ON CTL_CODE(FILE_DEVICE_USB, \ + HCD_DIAGNOSTIC_MODE_ON, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +#ifndef IOCTL_USB_DIAGNOSTIC_MODE_OFF +#define IOCTL_USB_DIAGNOSTIC_MODE_OFF CTL_CODE(FILE_DEVICE_USB, \ + HCD_DIAGNOSTIC_MODE_OFF, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +#ifndef IOCTL_USB_GET_ROOT_HUB_NAME +#define IOCTL_USB_GET_ROOT_HUB_NAME CTL_CODE(FILE_DEVICE_USB, \ + HCD_GET_ROOT_HUB_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +#ifndef IOCTL_GET_HCD_DRIVERKEY_NAME +#define IOCTL_GET_HCD_DRIVERKEY_NAME CTL_CODE(FILE_DEVICE_USB, \ + HCD_GET_DRIVERKEY_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +/************************************************************************** +The following IOCTLS are always sent to symbolic names +created by usbhub +***************************************************************************/ + +/* + Utility IOCTLS supported by the hub device +*/ + +/* + These ioctls are supported by the hub driver for + use by user mode USB utilities. +*/ + +/* +IOCTL_USB_GET_NODE_INFORMATION + +Routine Description: +Returns information about the USB hub in the user buffer passed in. If the +IOCTL is sent to the hub NodeType is set to UsbHub and USB_HUB_INFORMATION is +returned this includes the hub descriptor and a flag indicating if the hub is +bus vs self powered . +This API returns FAILURE (STATUS_UNSUCCESSFUL) if the hub is not started or +otherwise not functional. + +Parameters: +Input: +Irp->AssociatedIrp.SystemBuffer - pointer to USB_NODE_INFORMATION structure + +Ouput: +USB_NODE_INFORMATION filled in as appropriate +*/ +#define IOCTL_USB_GET_NODE_INFORMATION \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_INFORMATION, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + + +/* +IOCTL_USB_GET_NODE_CONNECTION_INFORMATION + +Exactly the same as _EX but the speed field is a Boolean +LowSpeed +-TRUE if the device is low speed. +*/ +#define IOCTL_USB_GET_NODE_CONNECTION_INFORMATION \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_INFORMATION, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_NODE_CONNECTION_NAME \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_DIAG_IGNORE_HUBS_ON CTL_CODE(FILE_DEVICE_USB, \ + USB_DIAG_IGNORE_HUBS_ON, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_DIAG_IGNORE_HUBS_OFF \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_DIAG_IGNORE_HUBS_OFF, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_NODE_CONNECTION_DRIVERKEY_NAME \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_DRIVERKEY_NAME, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* +* IOCTLS defined for Windows XP and later +*/ + +#if (_WIN32_WINNT >= 0x0501) + +#define IOCTL_USB_GET_HUB_CAPABILITIES \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_CAPABILITIES, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_HUB_CYCLE_PORT \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_HUB_CYCLE_PORT, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* +IOCTL_USB_GET_NODE_CONNECTION_ATTRIBUTES + +Routine Description: +Returns the Microsoft extended port attributes for a specific port. The +caller inputs the port number as the 'ConnectionIndex'. Microsoft extended +port attributes are defined in the Extended Port Attribute specification. +This API also returns the current connection status of the port. + +This API returns FAILURE (STATUS_UNSUCCESSFUL) if the hub is not started or +otherwise not functional. + +Parameters: +Input: +Irp->AssociatedIrp.SystemBuffer - pointer to +Struct _USB_NODE_CONNECTION_INFORMATION { + ULONG ConnectionIndex; +} +ConnectionIndex +-is the one based port number. + +Ouput: (if a device is attached) +ConnectionStatus +-The current USB connection status. Indicates things like enumeration failure +or overcurrent. +PortAttributes +-Extended port attributes defined in usb.h. +*/ + +#define IOCTL_USB_GET_NODE_CONNECTION_ATTRIBUTES \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_ATTRIBUTES,\ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +/* +IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX + +Routine Description: +Returns information about a specific USB hub port (AKA connection). If there +is a device connected to the port information about the device is also +returned. The caller inputs the port number as the 'ConnectionIndex'. + +This API returns FAILURE (STATUS_UNSUCCESSFUL) if the hub is not started or +otherwise not functional. + +Parameters: +Input: +Irp->AssociatedIrp.SystemBuffer - pointer to +Struct _USB_NODE_CONNECTION_INFORMATION { + ULONG ConnectionIndex; + USB_DEVICE_DESCRIPTOR DeviceDescriptor; + UCHAR CurrentConfigurationValue; + BOOLEAN LowSpeed; + BOOLEAN DeviceIsHub; + USHORT DeviceAddress; + ULONG NumberOfOpenPipes; + USB_CONNECTION_STATUS ConnectionStatus; + USB_PIPE_INFO PipeList[0]; +} +ConnectionIndex +-is the one based port number. + +Ouput: (if a device is attached) +DeviceDescriptor +-USB device descriptor. +CurrentConfigurationValue +-Currently selected configuration value. +Speed +-indicates the 'current' operating speed, note that high speed devices can +operate at full speed when necessary. +DeviceIsHub +- TRUE if the attached device is a hub +DeviceAddress +- USB assigned device address. +NumberOfOpenPipes +- Number of open USB pipes in the current configuration +ConnectionStatus +- The current USB connection status. +USB_PIPE_INFO PipeList[0]; +- list of open pipes including schedule offset and endpoint descriptor. This +information can be used to calculate bandwidthusage. +*/ + +#define IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_INFORMATION_EX, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#endif + +/* +* The following IOCTLS are defined for Windows Longhorn and Later +*/ +#if (_WIN32_WINNT >= 0x0600) + +#define IOCTL_USB_RESET_HUB \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_RESET_HUB,\ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_HUB_CAPABILITIES_EX \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_CAPABILITIES_EX, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +/* +* The following IOCTLs are defined for Windows 8 and later +*/ +#if (NTDDI_VERSION >= NTDDI_WIN8) + +#define IOCTL_USB_GET_HUB_INFORMATION_EX \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_HUB_INFORMATION_EX,\ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_PORT_CONNECTOR_PROPERTIES \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_PORT_CONNECTOR_PROPERTIES, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX_V2 \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_INFORMATION_EX_V2, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) +#endif + +#endif //#ifndef USB_KERNEL_IOCTL + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +#define IOCTL_USB_GET_TRANSPORT_CHARACTERISTICS \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_TRANSPORT_CHARACTERISTICS, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_REGISTER_FOR_TRANSPORT_CHARACTERISTICS_CHANGE \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_REGISTER_FOR_TRANSPORT_CHARACTERISTICS_CHANGE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_NOTIFY_ON_TRANSPORT_CHARACTERISTICS_CHANGE \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_NOTIFY_ON_TRANSPORT_CHARACTERISTICS_CHANGE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_UNREGISTER_FOR_TRANSPORT_CHARACTERISTICS_CHANGE \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_UNREGISTER_FOR_TRANSPORT_CHARACTERISTICS_CHANGE, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_START_TRACKING_FOR_TIME_SYNC \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_START_TRACKING_FOR_TIME_SYNC, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_STOP_TRACKING_FOR_TIME_SYNC \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_STOP_TRACKING_FOR_TIME_SYNC, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_DEVICE_CHARACTERISTICS \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_DEVICE_CHARACTERISTICS, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#define IOCTL_USB_GET_NODE_CONNECTION_SUPERSPEEDPLUS_INFORMATION \ + CTL_CODE(FILE_DEVICE_USB, \ + USB_GET_NODE_CONNECTION_SUPERSPEEDPLUS_INFORMATION, \ + METHOD_BUFFERED, \ + FILE_ANY_ACCESS) + +#endif + +#ifndef USB_KERNEL_IOCTL + +/* + structures for user mode ioctls +*/ + +#include + +typedef enum _USB_HUB_NODE { + UsbHub, + UsbMIParent +} USB_HUB_NODE; + +typedef struct _USB_HUB_INFORMATION { + /* + copy of data from hub descriptor + */ + USB_HUB_DESCRIPTOR HubDescriptor; + + BOOLEAN HubIsBusPowered; + +} USB_HUB_INFORMATION, *PUSB_HUB_INFORMATION; + +typedef struct _USB_MI_PARENT_INFORMATION { + ULONG NumberOfInterfaces; +} USB_MI_PARENT_INFORMATION, *PUSB_MI_PARENT_INFORMATION; + +typedef struct _USB_NODE_INFORMATION { + USB_HUB_NODE NodeType; /* hub, mi parent */ + union { + USB_HUB_INFORMATION HubInformation; + USB_MI_PARENT_INFORMATION MiParentInformation; + } u; +} USB_NODE_INFORMATION, *PUSB_NODE_INFORMATION; + +typedef struct _USB_PIPE_INFO { + USB_ENDPOINT_DESCRIPTOR EndpointDescriptor; + ULONG ScheduleOffset; +} USB_PIPE_INFO, *PUSB_PIPE_INFO; + + +#if (_WIN32_WINNT >= 0x0600) +/* + For Windows Longhorn +*/ + +typedef enum _USB_CONNECTION_STATUS { + NoDeviceConnected, + DeviceConnected, + + /* failure codes, these map to fail reasons */ + DeviceFailedEnumeration, + DeviceGeneralFailure, + DeviceCausedOvercurrent, + DeviceNotEnoughPower, + DeviceNotEnoughBandwidth, + DeviceHubNestedTooDeeply, + DeviceInLegacyHub, + DeviceEnumerating, + DeviceReset +} USB_CONNECTION_STATUS, *PUSB_CONNECTION_STATUS; + +#elif (_WIN32_WINNT >= 0x0501) + +/* + For Windows XP +*/ + +typedef enum _USB_CONNECTION_STATUS { + NoDeviceConnected, + DeviceConnected, + + /* failure codes, these map to fail reasons */ + DeviceFailedEnumeration, + DeviceGeneralFailure, + DeviceCausedOvercurrent, + DeviceNotEnoughPower, + DeviceNotEnoughBandwidth, + DeviceHubNestedTooDeeply, + DeviceInLegacyHub +} USB_CONNECTION_STATUS, *PUSB_CONNECTION_STATUS; + +#else + +/* + For Windows 2000 +*/ + +typedef enum _USB_CONNECTION_STATUS { + NoDeviceConnected, + DeviceConnected, + + /* failure codes, these map to fail reasons */ + DeviceFailedEnumeration, + DeviceGeneralFailure, + DeviceCausedOvercurrent, + DeviceNotEnoughPower, + DeviceNotEnoughBandwidth +} USB_CONNECTION_STATUS, *PUSB_CONNECTION_STATUS; + +#endif + + +/** IOCTL_USB_GET_NODE_CONNECTION_INFORMATION **/ +#pragma warning( disable : 4200 ) +#pragma warning( disable : 4201 ) +typedef struct _USB_NODE_CONNECTION_INFORMATION { + ULONG ConnectionIndex; /* INPUT */ + /* usb device descriptor returned by this device + during enumeration */ + USB_DEVICE_DESCRIPTOR DeviceDescriptor; /* OUTPUT */ + UCHAR CurrentConfigurationValue;/* OUTPUT */ + BOOLEAN LowSpeed;/* OUTPUT */ + BOOLEAN DeviceIsHub;/* OUTPUT */ + USHORT DeviceAddress;/* OUTPUT */ + ULONG NumberOfOpenPipes;/* OUTPUT */ + USB_CONNECTION_STATUS ConnectionStatus;/* OUTPUT */ + USB_PIPE_INFO PipeList[0];/* OUTPUT */ +} USB_NODE_CONNECTION_INFORMATION, *PUSB_NODE_CONNECTION_INFORMATION; +#pragma warning( default : 4200 ) +#pragma warning( default : 4201 ) + +/** IOCTL_USB_GET_NODE_CONNECTION_DRIVERKEY_NAME **/ +typedef struct _USB_NODE_CONNECTION_DRIVERKEY_NAME { + ULONG ConnectionIndex; /* INPUT */ + ULONG ActualLength; /* OUTPUT */ + /* unicode name for the devnode */ + WCHAR DriverKeyName[1]; /* OUTPUT */ +} USB_NODE_CONNECTION_DRIVERKEY_NAME, *PUSB_NODE_CONNECTION_DRIVERKEY_NAME; + +/** IOCTL_USB_GET_NODE_CONNECTION_NAME **/ +typedef struct _USB_NODE_CONNECTION_NAME { + ULONG ConnectionIndex; /* INPUT */ + ULONG ActualLength; /* OUTPUT */ + /* unicode symbolic name for this node if it is a hub or parent driver + null if this node is a device. */ + WCHAR NodeName[1]; /* OUTPUT */ +} USB_NODE_CONNECTION_NAME, *PUSB_NODE_CONNECTION_NAME; + +typedef struct _USB_HUB_NAME { + ULONG ActualLength; /* OUTPUT */ + /* NULL terminated unicode symbolic name for the root hub */ + WCHAR HubName[1]; /* OUTPUT */ +} USB_HUB_NAME, *PUSB_HUB_NAME; + +typedef struct _USB_ROOT_HUB_NAME { + ULONG ActualLength; /* OUTPUT */ + /* NULL terminated unicode symbolic name for the root hub */ + WCHAR RootHubName[1]; /* OUTPUT */ +} USB_ROOT_HUB_NAME, *PUSB_ROOT_HUB_NAME; + +typedef struct _USB_HCD_DRIVERKEY_NAME { + ULONG ActualLength; /* OUTPUT */ + /* NULL terminated unicode driverkeyname for hcd */ + WCHAR DriverKeyName[1]; /* OUTPUT */ +} USB_HCD_DRIVERKEY_NAME, *PUSB_HCD_DRIVERKEY_NAME; + +#pragma warning( disable : 4200 ) +typedef struct _USB_DESCRIPTOR_REQUEST { + ULONG ConnectionIndex; + struct { + UCHAR bmRequest; + UCHAR bRequest; + USHORT wValue; + USHORT wIndex; + USHORT wLength; + } SetupPacket; + UCHAR Data[0]; +} USB_DESCRIPTOR_REQUEST, *PUSB_DESCRIPTOR_REQUEST; +#pragma warning( default : 4200 ) + +/* + Structures defined for Windows XP and later only +*/ + +#if (_WIN32_WINNT >= 0x0501) + +typedef struct _USB_HUB_CAPABILITIES { + /* + Unlike the USB_HUB_INFORMATION structure used by + IOCTL_USB_GET_NODE_INFORMATION, this structure can be extended in the + future to accomodate more data. The IOCTL will return only as much + data as indicated by the size of the request buffer, to maintain + backward compatibility with older callers that don't know about the + new data. + */ + + ULONG HubIs2xCapable:1; + +} USB_HUB_CAPABILITIES, *PUSB_HUB_CAPABILITIES; + + +/** IOCTL_USB_GET_NODE_CONNECTION_ATTRIBUTES **/ + +typedef struct _USB_NODE_CONNECTION_ATTRIBUTES { + /* one based port number */ + ULONG ConnectionIndex; /* INPUT */ + /* current USB connect status for the port*/ + USB_CONNECTION_STATUS ConnectionStatus; /* OUTPUT */ + /* extended port attributes defined in usb.h*/ + ULONG PortAttributes; /* OUTPUT */ +} USB_NODE_CONNECTION_ATTRIBUTES, *PUSB_NODE_CONNECTION_ATTRIBUTES; + +/** IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX **/ +#pragma warning( disable : 4200 ) +typedef struct _USB_NODE_CONNECTION_INFORMATION_EX { + ULONG ConnectionIndex; /* INPUT */ + /* usb device descriptor returned by this device + during enumeration */ + USB_DEVICE_DESCRIPTOR DeviceDescriptor;/* OUTPUT */ + UCHAR CurrentConfigurationValue;/* OUTPUT */ + /* values for the speed field are defined in USB200.h */ + UCHAR Speed;/* OUTPUT */ + BOOLEAN DeviceIsHub;/* OUTPUT */ + USHORT DeviceAddress;/* OUTPUT */ + ULONG NumberOfOpenPipes;/* OUTPUT */ + USB_CONNECTION_STATUS ConnectionStatus;/* OUTPUT */ + USB_PIPE_INFO PipeList[0];/* OUTPUT */ +} USB_NODE_CONNECTION_INFORMATION_EX, *PUSB_NODE_CONNECTION_INFORMATION_EX; + +C_ASSERT(sizeof(USB_NODE_CONNECTION_INFORMATION_EX) == \ + sizeof(USB_NODE_CONNECTION_INFORMATION)); +#pragma warning( default : 4200 ) +#endif + +/* + Structures defined for windows Longhorn and later only +*/ + +#if (_WIN32_WINNT >= 0x0600) +#pragma warning( disable : 4201 ) +typedef union _USB_HUB_CAP_FLAGS { + ULONG ul; + struct { + ULONG HubIsHighSpeedCapable:1; + ULONG HubIsHighSpeed:1; + ULONG HubIsMultiTtCapable:1; + ULONG HubIsMultiTt:1; + ULONG HubIsRoot:1; + ULONG HubIsArmedWakeOnConnect:1; + ULONG HubIsBusPowered:1; + ULONG ReservedMBZ:25; + }; + +} USB_HUB_CAP_FLAGS, *PUSB_HUB_CAP_FLAGS; + +#pragma warning( default : 4201 ) + +C_ASSERT(sizeof(USB_HUB_CAP_FLAGS) == sizeof(ULONG)); + +typedef struct _USB_HUB_CAPABILITIES_EX { + + USB_HUB_CAP_FLAGS CapabilityFlags; + +} USB_HUB_CAPABILITIES_EX, *PUSB_HUB_CAPABILITIES_EX; + +typedef struct _USB_CYCLE_PORT_PARAMS { + /* one based port number */ + ULONG ConnectionIndex; /* INPUT */ + + ULONG StatusReturned; /* OUTPUT */ +} USB_CYCLE_PORT_PARAMS, *PUSB_CYCLE_PORT_PARAMS; + + +/************************************************************************ +* Structures used for IOCTL_INTERNAL_USB_GET_DEVICE_CONFIG_INFO +**************************************************************************/ + +/* + structure for storing PnP ids + the length includes any trailing NULLs +*/ + +typedef struct _USB_ID_STRING { + + USHORT LanguageId; // laguage id where apllicable + USHORT Pad; + ULONG LengthInBytes; // length of in Bytes includes NULLs etc + PWCHAR Buffer; + +} USB_ID_STRING, *PUSB_ID_STRING; + +typedef struct _USB_HUB_DEVICE_UXD_SETTINGS { + ULONG Version; + GUID PnpGuid; + GUID OwnerGuid; + ULONG DeleteOnShutdown; + ULONG DeleteOnReload; + ULONG DeleteOnDisconnect; + ULONG Reserved[5]; +} USB_HUB_DEVICE_UXD_SETTINGS, *PUSB_HUB_DEVICE_UXD_SETTINGS; + +typedef struct _HUB_DEVICE_CONFIG_INFO_V1 { + ULONG Version; + ULONG Length; + USB_HUB_CAP_FLAGS HubFlags; + USB_ID_STRING HardwareIds; + USB_ID_STRING CompatibleIds; + USB_ID_STRING DeviceDescription; + ULONG Reserved[19]; + USB_HUB_DEVICE_UXD_SETTINGS UxdSettings; +} HUB_DEVICE_CONFIG_INFO, *PHUB_DEVICE_CONFIG_INFO; + +#endif + +/* + Structure for returning HCD debug and statistic information to + a user mode application. +*/ + +typedef struct _HCD_STAT_COUNTERS { + ULONG BytesTransferred; + + USHORT IsoMissedCount; + USHORT DataOverrunErrorCount; + + USHORT CrcErrorCount; + USHORT ScheduleOverrunCount; + + USHORT TimeoutErrorCount; + USHORT InternalHcErrorCount; + + USHORT BufferOverrunErrorCount; + USHORT SWErrorCount; + + USHORT StallPidCount; + USHORT PortDisableCount; + +} HCD_STAT_COUNTERS, *PHCD_STAT_COUNTERS; + + +typedef struct _HCD_ISO_STAT_COUNTERS { + + USHORT LateUrbs; + USHORT DoubleBufferedPackets; + + USHORT TransfersCF_5ms; + USHORT TransfersCF_2ms; + + USHORT TransfersCF_1ms; + USHORT MaxInterruptLatency; + + USHORT BadStartFrame; + USHORT StaleUrbs; + + /* total count of packets programmed but not accessed by + the controller either due to software scheduling + problems or HW problems */ + USHORT IsoPacketNotAccesed; + USHORT IsoPacketHWError; + + USHORT SmallestUrbPacketCount; + USHORT LargestUrbPacketCount; + + USHORT IsoCRC_Error; + USHORT IsoOVERRUN_Error; + USHORT IsoINTERNAL_Error; + USHORT IsoUNKNOWN_Error; + + ULONG IsoBytesTransferred; + + /* count of packets missed due to software scheduling + problems */ + USHORT LateMissedCount; + /* incremented when a packet is scheduled but not + accessed by the controller */ + USHORT HWIsoMissedCount; + + ULONG Reserved7[8]; + +} HCD_ISO_STAT_COUNTERS, *PHCD_ISO_STAT_COUNTERS; + + + +typedef struct _HCD_STAT_INFORMATION_1 { + ULONG Reserved1; + ULONG Reserved2; + ULONG ResetCounters; + LARGE_INTEGER TimeRead; + /* + stat registers + */ + HCD_STAT_COUNTERS Counters; + +} HCD_STAT_INFORMATION_1, *PHCD_STAT_INFORMATION_1; + +typedef struct _HCD_STAT_INFORMATION_2 { + ULONG Reserved1; + ULONG Reserved2; + ULONG ResetCounters; + LARGE_INTEGER TimeRead; + + LONG LockedMemoryUsed; + /* + stat registers + */ + HCD_STAT_COUNTERS Counters; + HCD_ISO_STAT_COUNTERS IsoCounters; + +} HCD_STAT_INFORMATION_2, *PHCD_STAT_INFORMATION_2; + +/* + WMI related structures +*/ + +/* these index in to our array of guids for the hub FDO */ +#define WMI_USB_DRIVER_INFORMATION 0 +#define WMI_USB_DRIVER_NOTIFICATION 1 +#define WMI_USB_POWER_DEVICE_ENABLE 2 +#define WMI_USB_HUB_NODE_INFORMATION 4 + +/* Index into array of guids for the HUB pdos */ + +#define WMI_USB_PERFORMANCE_INFORMATION 1 +#define WMI_USB_DEVICE_NODE_INFORMATION 2 + +#if (_WIN32_WINNT >= 0x0501) + /* + Windows XP and later + */ + +typedef enum _USB_NOTIFICATION_TYPE { + + /* the following return a + USB_CONNECTION_NOTIFICATION structure: */ + EnumerationFailure = 0, + InsufficentBandwidth, + InsufficentPower, + OverCurrent, + ResetOvercurrent, + + /* the following return a + USB_BUS_NOTIFICATION structure:*/ + AcquireBusInfo, + + /* the following return a + USB_ACQUIRE_INFO structure: */ + AcquireHubName, + AcquireControllerName, + + /* the following return a + USB_HUB_NOTIFICATION structure: */ + HubOvercurrent, + HubPowerChange, + HubNestedTooDeeply, + ModernDeviceInLegacyHub + +} USB_NOTIFICATION_TYPE; + +#else + +/* + For Windows 2000 +*/ + +typedef enum _USB_NOTIFICATION_TYPE { + + /* the following return a + USB_CONNECTION_NOTIFICATION structure: */ + EnumerationFailure = 0, + InsufficentBandwidth, + InsufficentPower, + OverCurrent, + ResetOvercurrent, + + /* the following return a + USB_BUS_NOTIFICATION structure:*/ + AcquireBusInfo, + + /* the following return a + USB_ACQUIRE_INFO structure: */ + AcquireHubName, + AcquireControllerName, + + /* the following return a + USB_HUB_NOTIFICATION structure: */ + HubOvercurrent, + HubPowerChange + +} USB_NOTIFICATION_TYPE; + +#endif + +typedef struct _USB_NOTIFICATION { + /* indicates type of notification */ + USB_NOTIFICATION_TYPE NotificationType; + +} USB_NOTIFICATION, *PUSB_NOTIFICATION; + +/* this structure is used for connection notification + codes */ + +typedef struct _USB_CONNECTION_NOTIFICATION { + /* indicates type of notification */ + USB_NOTIFICATION_TYPE NotificationType; + + /* valid for all connection notifictaion codes, + 0 indicates global condition for hub or parent + this value will be a port number for devices + attached to a hub, otherwise a one based + index if the device is a child of a composite + parent */ + ULONG ConnectionNumber; + + /* valid for InsufficentBandwidth, + the amount of bandwidth the device + tried to allocate and was denied. */ + ULONG RequestedBandwidth; + + /* valid for EnumerationFailure, + gives some indication why the device failed + to enumerate */ + ULONG EnumerationFailReason; + + /* valid for InsufficentPower, + the amount of power requested to configure + this device. */ + ULONG PowerRequested; + + /* length of the UNICODE symbolic name (in bytes) for the HUB + that this device is attached to. + not including NULL */ + ULONG HubNameLength; + +} USB_CONNECTION_NOTIFICATION, *PUSB_CONNECTION_NOTIFICATION; + +/* + This structure is used for the bus notification code 'AcquireBusInfo' +*/ + +typedef struct _USB_BUS_NOTIFICATION { + /* indicates type of notification */ + USB_NOTIFICATION_TYPE NotificationType; /* indicates type of */ + /* notification */ + ULONG TotalBandwidth; + ULONG ConsumedBandwidth; + + /* length of the UNICODE symbolic name (in bytes) for the controller + that this device is attached to. + not including NULL */ + ULONG ControllerNameLength; + +} USB_BUS_NOTIFICATION, *PUSB_BUS_NOTIFICATION; + +/* + used to acquire user mode filenames to open respective objects +*/ + +typedef struct _USB_ACQUIRE_INFO { + /* indicates type of notification */ + USB_NOTIFICATION_TYPE NotificationType; + /* TotalSize of this struct */ + ULONG TotalSize; + + WCHAR Buffer[1]; +} USB_ACQUIRE_INFO, *PUSB_ACQUIRE_INFO; + + +/* + Structures defined for windows Longhorn and later only +*/ + +#if (_WIN32_WINNT >= 0x0600) + +/* + structures used to acquire device specific info via + GUID_USB_WMI_NODE_INFO +*/ + +#define USB_NODE_INFO_SIG 'USBN' + +typedef enum _USB_WMI_DEVICE_NODE_TYPE { + UsbDevice, + HubDevice, + CompositeDevice, + UsbController +} USB_WMI_DEVICE_NODE_TYPE, *PUSB_WMI_DEVICE_NODE_TYPE; + +typedef struct _USB_DEVICE_STATE { + + ULONG DeviceConnected:1; + ULONG DeviceStarted:1; + +} USB_DEVICE_STATE, *PUSB_DEVICE_STATE; + +// +// Specific information about a hub device +// + +typedef struct _USB_HUB_PORT_INFORMATION{ + + USB_DEVICE_STATE DeviceState; + + USHORT PortNumber; + + USHORT DeviceAddress; + + // Legacy ConnectionIndex used with USB user IOCTLS + ULONG ConnectionIndex; + + // Legacy ConnectionStatus + USB_CONNECTION_STATUS ConnectionStatus; + +} USB_HUB_PORT_INFORMATION, *PUSB_HUB_PORT_INFORMATION; + +typedef struct _USB_HUB_DEVICE_INFO { + + // Hub Descriptor + USB_HUB_DESCRIPTOR HubDescriptor; + + // Unique Hub number + ULONG HubNumber; + + // Device Address + USHORT DeviceAddress; + + // Hub power bit + BOOLEAN HubIsSelfPowered; + + // Root hub + BOOLEAN HubIsRootHub; + + // Hub capabilities + USB_HUB_CAPABILITIES HubCapabilities; + + // Number of hub ports + ULONG NumberOfHubPorts; + + // Variable length array of info about hub ports + USB_HUB_PORT_INFORMATION PortInfo[1]; + +} USB_HUB_DEVICE_INFO, *PUSB_HUB_DEVICE_INFO; + +// +// Specific info about a composite device +// + +typedef struct _USB_COMPOSITE_FUNCTION_INFO{ + + UCHAR FunctionNumber; + + UCHAR BaseInterfaceNumber; + + UCHAR NumberOfInterfaces; + + BOOLEAN FunctionIsIdle; + +} USB_COMPOSITE_FUNCTION_INFO, *PUSB_COMPOSITE_FUNCTION_INFO; + + +typedef struct _USB_COMPOSITE_DEVICE_INFO { + + // USB Device Descriptor + USB_DEVICE_DESCRIPTOR DeviceDescriptor; + + // Usb Configuration Descriptor + USB_CONFIGURATION_DESCRIPTOR CurrentConfigDescriptor; + + // 0-based configuration number + UCHAR CurrentConfigurationValue; + + // Number of composite PDOs + UCHAR NumberOfFunctions; + + USB_COMPOSITE_FUNCTION_INFO FunctionInfo[1]; + +} USB_COMPOSITE_DEVICE_INFO, *PUSB_COMPOSITE_DEVICE_INFO; + +// +// Specific info about a USB controller +// + +typedef struct _USB_CONTROLLER_DEVICE_INFO { + + ULONG PciVendorId; + ULONG PciDeviceId; + ULONG PciRevision; + + ULONG NumberOfRootPorts; + + ULONG HcFeatureFlags; + +} USB_CONTROLLER_DEVICE_INFO, *PUSB_CONTROLLER_DEVICE_INFO; + +// +// Specific info about a connected USB device +// + +typedef struct _USB_DEVICE_INFO{ + + // Device State + USB_DEVICE_STATE DeviceState; + + // Hub Port Number + USHORT PortNumber; + + // USB Device Descriptor + USB_DEVICE_DESCRIPTOR DeviceDescriptor; + + // Current configuration value + UCHAR CurrentConfigurationValue; + + // Device speed + USB_DEVICE_SPEED Speed; + + // Device Address + USHORT DeviceAddress; + + // Legacy ConnectionIndex used with USB user IOCTLS + ULONG ConnectionIndex; + + // Legacy ConnectionStatus + USB_CONNECTION_STATUS ConnectionStatus; + + // PNP HardwareID in multi-string format + WCHAR PnpHardwareId[128]; + + // PNP Compatible ID in multi-string format + WCHAR PnpCompatibleId[128]; + + // USB Serial Number string if present + WCHAR SerialNumberId[128]; + + // PNP Device Description + WCHAR PnpDeviceDescription[128]; + + // Number of pipes contained in the PipeList + ULONG NumberOfOpenPipes; + + // Variable length list of open pipes + USB_PIPE_INFO PipeList[1]; + +} USB_DEVICE_INFO, *PUSB_DEVICE_INFO; + +#pragma warning( disable : 4201 ) +typedef struct _USB_DEVICE_NODE_INFO { + + // Structure signature + ULONG Sig; + + // Length of structure + ULONG LengthInBytes; + + // Device Description + WCHAR DeviceDescription[40]; + + // Device Type + USB_WMI_DEVICE_NODE_TYPE NodeType; + + // Bus Address + USB_TOPOLOGY_ADDRESS BusAddress; + + // device information + union{ + USB_DEVICE_INFO UsbDeviceInfo; + USB_HUB_DEVICE_INFO HubDeviceInfo; + USB_COMPOSITE_DEVICE_INFO CompositeDeviceInfo; + USB_CONTROLLER_DEVICE_INFO ControllerDeviceInfo; + UCHAR DeviceInformation[4]; + }; + +} USB_DEVICE_NODE_INFO, *PUSB_DEVICE_NODE_INFO; +#pragma warning( default : 4201 ) + +/* + structures used to acquire device specific performance info + GUID_USB_WMI_DEVICE_PERF_INFO +*/ + +typedef struct _USB_DEVICE_PERFORMANCE_INFO { + + //total bulk bytes transfered for this device + ULONG BulkBytes; + + //total control bytes transfered for this device + ULONG ControlDataBytes; + + // total iso bytes transfered for this device + ULONG IsoBytes; + + // total interrupt bytes transfered for this device + ULONG InterruptBytes; + + // Total number of transfer URBs processed for this device + ULONG BulkUrbCount; + ULONG ControlUrbCount; + ULONG IsoUrbCount; + ULONG InterruptUrbCount; + + // BW reported in bits/32ms(32 frames) + // Interrupt BW is reported by endpoint period in AllocedInterrupt[n] where period = 2^n + // The total interrupt BW allocated for this device is the sum of the BW + // for all periods + // + ULONG AllocedInterrupt[6]; + + // Iso BW allocated for all iso endpoints on the device. + // Reported in bits/32ms(32 frames) + // + ULONG AllocedIso; + + // Total USB controller BW available in bits/32ms. + ULONG Total32secBandwidth; + + // Total USB BW available on the device's TT in bits/32ms + ULONG TotalTtBandwidth; + + // Text description of the device + WCHAR DeviceDescription[60]; + + // operating speed of the device + USB_DEVICE_SPEED DeviceSpeed; + + // total number of ms iso transfers have waited after being scheduled + ULONG TotalIsoLatency; + + // Number of ISO packets that were not scheduled or processed by the controller + ULONG DroppedIsoPackets; + + // Number of transfers completing with an error + ULONG TransferErrors; + + // + // Following values are for CONTROLLER instances only. + // + + // Number of controller interrupts + ULONG PciInterruptCount; + + // HC Idle State -- non zero if the HC is not running + ULONG HcIdleState; + + // Async (EHCI) Idle State -- non zero if the async segment is off + ULONG HcAsyncIdleState; + + // Async (EHCI) Cache stats -- incremented each time we flush the async cache (doorbell). + ULONG HcAsyncCacheFlushCount; + + // Periodic (EHCI) Idle State -- non zero if the periodic segment is off + ULONG HcPeriodicIdleState; + + // Periodic (EHCI) Cache stats -- incremented each time we flush the periodic prefetch cache. + ULONG HcPeriodicCacheFlushCount; + +} USB_DEVICE_PERFORMANCE_INFO, *PUSB_DEVICE_PERFORMANCE_INFO; + +#endif + + +/* + Structures defined for Windows 8 and later only +*/ +#if (NTDDI_VERSION >= NTDDI_WIN8) + +typedef enum _USB_HUB_TYPE { + UsbRootHub = 1, + Usb20Hub = 2, + Usb30Hub = 3 +} USB_HUB_TYPE; + + +typedef struct _USB_HUB_INFORMATION_EX { + USB_HUB_TYPE HubType; + + // The higest valid port number on the hub + USHORT HighestPortNumber; + + union { + USB_HUB_DESCRIPTOR UsbHubDescriptor; + USB_30_HUB_DESCRIPTOR Usb30HubDescriptor; + } u; + +} USB_HUB_INFORMATION_EX, *PUSB_HUB_INFORMATION_EX; + + +#pragma warning( disable : 4201 ) + +typedef union _USB_PORT_PROPERTIES { + ULONG ul; + + struct { + ULONG PortIsUserConnectable :1; + ULONG PortIsDebugCapable :1; + ULONG PortHasMultipleCompanions :1; + ULONG PortConnectorIsTypeC :1; + ULONG ReservedMBZ :28; + }; + +} USB_PORT_PROPERTIES, *PUSB_PORT_PROPERTIES; + +#pragma warning( default : 4201 ) + +typedef struct _USB_PORT_CONNECTOR_PROPERTIES { + // one based port number + ULONG ConnectionIndex; + + // The number of bytes required to hold the entire USB_PORT_CONNECTOR_PROPERTIES + // structure, including the full CompanionHubSymbolicLinkName string + ULONG ActualLength; + + // bitmask of flags indicating properties and capabilities of the port + USB_PORT_PROPERTIES UsbPortProperties; + + // Zero based index number of the companion port being queried. + USHORT CompanionIndex; + + // Port number of the companion port + USHORT CompanionPortNumber; + + // Symbolic link name for the companion hub + WCHAR CompanionHubSymbolicLinkName[1]; +} USB_PORT_CONNECTOR_PROPERTIES, *PUSB_PORT_CONNECTOR_PROPERTIES; + +#pragma warning( disable : 4201 ) + +typedef union _USB_PROTOCOLS { + ULONG ul; + + struct { + ULONG Usb110 :1; + ULONG Usb200 :1; + ULONG Usb300 :1; + ULONG ReservedMBZ :29; + }; + +} USB_PROTOCOLS, *PUSB_PROTOCOLS; + + +typedef union _USB_NODE_CONNECTION_INFORMATION_EX_V2_FLAGS { + ULONG ul; + + struct { + ULONG DeviceIsOperatingAtSuperSpeedOrHigher :1; + ULONG DeviceIsSuperSpeedCapableOrHigher :1; + ULONG DeviceIsOperatingAtSuperSpeedPlusOrHigher :1; + ULONG DeviceIsSuperSpeedPlusCapableOrHigher :1; + ULONG ReservedMBZ :28; + }; + +} USB_NODE_CONNECTION_INFORMATION_EX_V2_FLAGS, *PUSB_NODE_CONNECTION_INFORMATION_EX_V2_FLAGS; + +#pragma warning( default : 4201 ) + + +typedef struct _USB_NODE_CONNECTION_INFORMATION_EX_V2 { + // one based port number + ULONG ConnectionIndex; + + // length of the structure + ULONG Length; + + // On input a bitmask that indicates which USB protocols are understood by the caller + // On output a bitmask that indicates which USB signaling protocols are supported by the port + USB_PROTOCOLS SupportedUsbProtocols; + + // A bitmask indicating properties of the connected device or port + USB_NODE_CONNECTION_INFORMATION_EX_V2_FLAGS Flags; +} USB_NODE_CONNECTION_INFORMATION_EX_V2, *PUSB_NODE_CONNECTION_INFORMATION_EX_V2; + +#endif + +#include + +#endif //#if USB_KERNEL_IOCTL + +#if (NTDDI_VERSION >= NTDDI_WIN10_RS3) + +#include + +#define USB_TRANSPORT_CHARACTERISTICS_VERSION_1 0x01 + +#define USB_TRANSPORT_CHARACTERISTICS_LATENCY_AVAILABLE 0x1 +#define USB_TRANSPORT_CHARACTERISTICS_BANDWIDTH_AVAILABLE 0x2 + +typedef struct _USB_TRANSPORT_CHARACTERISTICS { + ULONG Version; + ULONG TransportCharacteristicsFlags; + ULONG64 CurrentRoundtripLatencyInMilliSeconds; + ULONG64 MaxPotentialBandwidth; +} USB_TRANSPORT_CHARACTERISTICS, *PUSB_TRANSPORT_CHARACTERISTICS; + +#define USB_REGISTER_FOR_TRANSPORT_LATENCY_CHANGE 0x1 +#define USB_REGISTER_FOR_TRANSPORT_BANDWIDTH_CHANGE 0x2 + +DECLARE_HANDLE(USB_CHANGE_REGISTRATION_HANDLE); + +typedef struct _USB_TRANSPORT_CHARACTERISTICS_CHANGE_REGISTRATION { + ULONG ChangeNotificationInputFlags; + USB_CHANGE_REGISTRATION_HANDLE Handle; + USB_TRANSPORT_CHARACTERISTICS UsbTransportCharacteristics; +} USB_TRANSPORT_CHARACTERISTICS_CHANGE_REGISTRATION, *PUSB_TRANSPORT_CHARACTERISTICS_CHANGE_REGISTRATION; + +typedef struct _USB_TRANSPORT_CHARACTERISTICS_CHANGE_NOTIFICATION { + USB_CHANGE_REGISTRATION_HANDLE Handle; + USB_TRANSPORT_CHARACTERISTICS UsbTransportCharacteristics; +} USB_TRANSPORT_CHARACTERISTICS_CHANGE_NOTIFICATION, *PUSB_TRANSPORT_CHARACTERISTICS_CHANGE_NOTIFICATION; + +typedef struct _USB_TRANSPORT_CHARACTERISTICS_CHANGE_UNREGISTRATION { + USB_CHANGE_REGISTRATION_HANDLE Handle; +} USB_TRANSPORT_CHARACTERISTICS_CHANGE_UNREGISTRATION, *PUSB_TRANSPORT_CHARACTERISTICS_CHANGE_UNREGISTRATION; + +#define USB_DEVICE_CHARACTERISTICS_VERSION_1 0x01 + +#define USB_DEVICE_CHARACTERISTICS_MAXIMUM_PATH_DELAYS_AVAILABLE 0x1 + +typedef struct _USB_DEVICE_CHARACTERISTICS { + ULONG Version; + ULONG Reserved[2]; + ULONG UsbDeviceCharacteristicsFlags; + ULONG MaximumSendPathDelayInMilliSeconds; + ULONG MaximumCompletionPathDelayInMilliSeconds; +} USB_DEVICE_CHARACTERISTICS, *PUSB_DEVICE_CHARACTERISTICS; + + +#ifndef __USB_TIME_SYNC_DEFINED +#define __USB_TIME_SYNC_DEFINED + +typedef struct _USB_START_TRACKING_FOR_TIME_SYNC_INFORMATION { + + HANDLE TimeTrackingHandle; + BOOLEAN IsStartupDelayTolerable; + +} USB_START_TRACKING_FOR_TIME_SYNC_INFORMATION, *PUSB_START_TRACKING_FOR_TIME_SYNC_INFORMATION; + +typedef struct _USB_STOP_TRACKING_FOR_TIME_SYNC_INFORMATION { + + HANDLE TimeTrackingHandle; + +} USB_STOP_TRACKING_FOR_TIME_SYNC_INFORMATION, *PUSB_STOP_TRACKING_FOR_TIME_SYNC_INFORMATION; + +typedef struct _USB_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC_INFORMATION { + + // + // Input + // + + HANDLE TimeTrackingHandle; + ULONG InputFrameNumber; + ULONG InputMicroFrameNumber; + + // + // Output + // + + LARGE_INTEGER QueryPerformanceCounterAtInputFrameOrMicroFrame; + LARGE_INTEGER QueryPerformanceCounterFrequency; + ULONG PredictedAccuracyInMicroSeconds; + + ULONG CurrentGenerationID; + LARGE_INTEGER CurrentQueryPerformanceCounter; + ULONG CurrentHardwareFrameNumber; // 11 bits from hardware/MFINDEX + ULONG CurrentHardwareMicroFrameNumber; // 3 bits from hardware/MFINDEX + ULONG CurrentUSBFrameNumber; // 32 bit USB Frame Number + +} USB_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC_INFORMATION, *PUSB_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC_INFORMATION; + +#endif + +typedef struct _USB_NODE_CONNECTION_SUPERSPEEDPLUS_INFORMATION { + // one based port number + ULONG ConnectionIndex; + + // length of the structure + ULONG Length; + + // Current Operating Speed for RX Lane + USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED RxSuperSpeedPlus; + + // Note: For 'actual' LaneCount, add 1. + ULONG RxLaneCount; + + // Current Operating Speed for TX Lane + USB_DEVICE_CAPABILITY_SUPERSPEEDPLUS_SPEED TxSuperSpeedPlus; + + // Note: For 'actual' LaneCount, add 1. + ULONG TxLaneCount; +} USB_NODE_CONNECTION_SUPERSPEEDPLUS_INFORMATION, *PUSB_NODE_CONNECTION_SUPERSPEEDPLUS_INFORMATION; + + +#include + +#endif + + +#if _MSC_VER >= 1200 +#pragma warning(pop) +#else +#endif + + +#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */ +#pragma endregion + +#endif /* __USBIOCTL_H__ */ + + diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CertPolEng.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CertPolEng.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e5f276d6462bc6ca3cf4d26ae65d190fdbc220e3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CertPolEng.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Chakrart.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Chakrart.lib new file mode 100644 index 0000000000000000000000000000000000000000..885bda12c90dfc6d090647f23eef81b6ce273477 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Chakrart.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComCtl32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComCtl32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4fc02d383f98c3c465e34d99d4dbe8dbaffbc48d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComCtl32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComDlg32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComDlg32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..5319086732a4ba357841b2858b99930d465e2774 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComDlg32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComSvcs.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComSvcs.Lib new file mode 100644 index 0000000000000000000000000000000000000000..751707df156c8378e55fbbeb18071ac1bba27ba5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ComSvcs.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CompPkgSup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CompPkgSup.lib new file mode 100644 index 0000000000000000000000000000000000000000..29543a0d915b3e0922b73f82d084eebd13ff8dc3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CompPkgSup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CoreMessaging.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CoreMessaging.lib new file mode 100644 index 0000000000000000000000000000000000000000..c5cbf4fc0a6225ca5e38d8686094d5fe5f8f6179 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CoreMessaging.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Credui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Credui.lib new file mode 100644 index 0000000000000000000000000000000000000000..9505dd7d6e959f4aa9b26206d7bf62be8c17a798 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Credui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Crypt32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Crypt32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..dcc6c639070eab255ed378f953e703d0ef57cdbe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Crypt32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CryptNet.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CryptNet.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8fd4491e08edeff266eb9e33c7775a1f71e0d3d2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/CryptNet.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSProp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSProp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..874606d64202ab797010da93919b0bca04250534 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSProp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSUIExt.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSUIExt.Lib new file mode 100644 index 0000000000000000000000000000000000000000..5c9dfe1d9376cef4ff64a5bc1936b0fb45c91cbc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DSUIExt.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgEng.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgEng.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4f2c0c13af50f01a71db29499fedfbf7e7c63ff2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgEng.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgHelp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgHelp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..b495f6d2e172a468ece915c8644b0ac70fda880e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgHelp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgModel.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgModel.Lib new file mode 100644 index 0000000000000000000000000000000000000000..f9bc3938b799ef8a5e74511eace4f20334da31e4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DbgModel.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..b99a9564c6ba33bdf9345fb50cce7d8434c5004f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc6.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc6.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c538ad018e86a4ef26e44cf1c2944f0e3aef3d07 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DhcpCSvc6.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DiagnosticDataQuery.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DiagnosticDataQuery.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0e1140d8af2177ae7f96b5c55f9ae324787aaee7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DiagnosticDataQuery.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DnsAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DnsAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..76d79913fa91639df9a97f3b54917a78a38d8128 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/DnsAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ElsCore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ElsCore.lib new file mode 100644 index 0000000000000000000000000000000000000000..0044e7ff1c09baf36ceda7c0ac9a04ce064a4bde Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ElsCore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FaultRep.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FaultRep.Lib new file mode 100644 index 0000000000000000000000000000000000000000..115bbc627d3d1e8b7ad9be6b0f8bef3743a51957 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FaultRep.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FhSvcCtl.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FhSvcCtl.lib new file mode 100644 index 0000000000000000000000000000000000000000..d56af0652cffea5f01be6b04a004f9d5b594fca3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/FhSvcCtl.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GPEdit.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GPEdit.lib new file mode 100644 index 0000000000000000000000000000000000000000..97aaeaf3b132d11d6ff8b4904f228c1d4379168c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GPEdit.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GlU32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GlU32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..7a7b8ed25f8a3054c33661585acadeff52c579dc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/GlU32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HLink.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HLink.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a5adc9c1f130e0c8f2fb341ddcd84bcfeaf48601 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HLink.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HwReqChk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HwReqChk.lib new file mode 100644 index 0000000000000000000000000000000000000000..043a2b9922a5cbb6a2e1d66048116ce566342617 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/HwReqChk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..69bb0e9e9b8b4e1fd2fb0c8ca89ff67d33f137d0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icmui.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icmui.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d9e3090ac0119d450c80ec638fd972b548d09c5c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Icmui.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ImageHlp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ImageHlp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e3d237a2840b3e4c6dcd65142e02c54f5d7cfefb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ImageHlp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Imm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Imm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..78d50ddd6a0ac0735b0c0f8f6579ed7534c852a6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Imm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Iprop.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Iprop.Lib new file mode 100644 index 0000000000000000000000000000000000000000..82b8df41257eca2fe92f77af25f62b143cf7e202 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Iprop.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/IsolatedWindowsEnvironmentUtils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/IsolatedWindowsEnvironmentUtils.lib new file mode 100644 index 0000000000000000000000000000000000000000..1d6fe47531a89fe92bee3020854f67d63ef96b37 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/IsolatedWindowsEnvironmentUtils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/KSProxy.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/KSProxy.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8bebb6c28c77389ded50fc9d958d31d97099c566 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/KSProxy.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LicenseProtection.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LicenseProtection.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4e4360a737296c08b59c3b85e34eb0da9373f97e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LicenseProtection.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LoadPerf.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LoadPerf.Lib new file mode 100644 index 0000000000000000000000000000000000000000..89ef85f4ed62dd54abbe2ea15c4beec5cfcb121e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/LoadPerf.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Lz32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Lz32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..952806c65e940a81a35496ac8c9eaacf56b9d136 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Lz32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..efdbf16c2abf6012b3e4a5eed13ec1d0e65d99ac Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MDMRegistration.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MDMRegistration.lib new file mode 100644 index 0000000000000000000000000000000000000000..90f55228dc3434f5433efbc637956f37dc0d72b2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MDMRegistration.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSAcm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSAcm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..33a3b77e8997ee72ff06d56c0a79dd2f8a56a9d6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSAcm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSImg32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSImg32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..15f5400127e1d6a96d0d352a930116f3f007e2f0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSImg32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSRating.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSRating.Lib new file mode 100644 index 0000000000000000000000000000000000000000..db60a025af6ccfbf8daacf40c55b22c6da645acc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSRating.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSTask.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSTask.Lib new file mode 100644 index 0000000000000000000000000000000000000000..1177989f6aa3eab264d148a5ef87c5f899e19d98 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MSTask.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mf.lib new file mode 100644 index 0000000000000000000000000000000000000000..759499f6d34dd6e57d9dc730e74c7d62934f2722 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..0d38e15b5a96bd18d1ac757c681fe4392f746b6a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfplat.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfplat.lib new file mode 100644 index 0000000000000000000000000000000000000000..048db9fb6bcf1a29ab44510f25d9e461e82a7401 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfplat.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfsrcsnk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfsrcsnk.lib new file mode 100644 index 0000000000000000000000000000000000000000..1ffbb74f2d5256eed581c9816fc814f916ad3058 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mfsrcsnk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MgmtAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MgmtAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..368e2c5488c0ecd3c887e4d47d611845192e362c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MgmtAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mpr.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mpr.Lib new file mode 100644 index 0000000000000000000000000000000000000000..659c11a7ec12df0bbb7881321f6b167c9c6019da Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mpr.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mprapi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mprapi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..88839a1e8d1ce56bbfa2c19ecb6d919d2c431031 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mprapi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA.Lib new file mode 100644 index 0000000000000000000000000000000000000000..004b2ce3ba0d0f45b66d5384563c0faa20c33398 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA10.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA10.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..cd9fae156e1efd413b68784e851be1beabab2522 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA10.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA20.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA20.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..543ddbc9e10c582b4f23a5cfd4b3feb453ffe4a9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqOA20.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqRt.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqRt.Lib new file mode 100644 index 0000000000000000000000000000000000000000..9b61609886e15273a73c9084cbac13705ef9b808 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MqRt.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MrmSupport.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MrmSupport.lib new file mode 100644 index 0000000000000000000000000000000000000000..f1a33bda9755be48f000b1bbd19d1d86e9b7dbbc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MrmSupport.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsCtfMonitor.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsCtfMonitor.lib new file mode 100644 index 0000000000000000000000000000000000000000..d999b077fe3014475e6ea6da9c706c76b8edf669 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsCtfMonitor.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsWSock.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsWSock.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8c241b99eb80fa5cb84a1323743ef9088f2525e9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsWSock.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..e5e7147ac282a6967063d78812df1305e7920d78 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml2.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml2.Lib new file mode 100644 index 0000000000000000000000000000000000000000..76dea2d368c2d45235dbc34b3e861211e5189a4c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/MsXml2.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mscms.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mscms.Lib new file mode 100644 index 0000000000000000000000000000000000000000..58f9dd1b2455b35c5b8ae28539d69a4dac2473d2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mscms.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Msi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Msi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c7564fa296e82e41c3ae1da30ed9fe38496e1bf1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Msi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mtx.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mtx.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a9f85558ed4ecffbb2c947b5964b6936c2a37395 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Mtx.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a29ae6834d6fbff51ef1f37e7dfcbef2b43fe256 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetFW.TLB b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetFW.TLB new file mode 100644 index 0000000000000000000000000000000000000000..6628a0fad73078c88a3f0f5cb635ce844a7264cb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetFW.TLB differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetSh.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetSh.Lib new file mode 100644 index 0000000000000000000000000000000000000000..92a502a829bbdf79f44731492150e31709328909 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NetSh.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtDsAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtDsAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..28938fdd57aa51e816c753526d92bdf2a9bdf2c5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtDsAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtQuery.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtQuery.Lib new file mode 100644 index 0000000000000000000000000000000000000000..bebe3ed25f7d8db5fc50e70ff86dbe8286c7d15a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/NtQuery.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OemLicense.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OemLicense.lib new file mode 100644 index 0000000000000000000000000000000000000000..a6770a72d6f66b913f666174ca3333d27e9b7b5d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OemLicense.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAcc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAcc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..129aaa9f3d0a704b528f596e356793282f5f90f2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAcc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAut32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAut32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0dbcafc34d39fb70f2766f3ec5b533a5627e5bca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleAut32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ed3d775b90c7d447dc0f4727d43755633924cebb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OleDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OpenGL32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OpenGL32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..3d937b4716f69e6dd34fe4c7c74e6194e14e5a60 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/OpenGL32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Pdh.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Pdh.Lib new file mode 100644 index 0000000000000000000000000000000000000000..90b7af564a4eebb20d804d6520b6678480b84730 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Pdh.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/PeerDist.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/PeerDist.lib new file mode 100644 index 0000000000000000000000000000000000000000..a4aff648bcde43c66fd514736d9a0b952b6011ef Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/PeerDist.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ProjectedFSLib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ProjectedFSLib.lib new file mode 100644 index 0000000000000000000000000000000000000000..d8dd5d01d6d7b89a9f4d8e466144c703c4508c78 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ProjectedFSLib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..923fe784bfbc12e6105ccb0554c388fa46e622da Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6c69c78c43f4561f216ef72b0121572c3099914a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RASDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RTWorkQ.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RTWorkQ.lib new file mode 100644 index 0000000000000000000000000000000000000000..35e0fe4d077d481b55c3a162da852db070e6bebb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/RTWorkQ.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rdcentraldb.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rdcentraldb.tlb new file mode 100644 index 0000000000000000000000000000000000000000..eb7657871a0a74b30c2cc15e8dfc4e7a27f5fc1c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rdcentraldb.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rpcns4.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rpcns4.Lib new file mode 100644 index 0000000000000000000000000000000000000000..67753db005d22ee8d54cddbce9043a90b96b6db3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rpcns4.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rtm.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rtm.Lib new file mode 100644 index 0000000000000000000000000000000000000000..86ee75061ec90ef610318de1499d2db5f39bcfa1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Rtm.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SCardDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SCardDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6bb3c9c2b27601ccc7fecafb0c05e50aceb992b0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SCardDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchAPI.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchAPI.tlb new file mode 100644 index 0000000000000000000000000000000000000000..8ce4d8471e4c2b7e60c699cfe91b4e351f14820a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchAPI.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchSDK.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchSDK.lib new file mode 100644 index 0000000000000000000000000000000000000000..0f04c534d2c319b36feb204312a98f75655e6b2c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SearchSDK.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Secur32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Secur32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..617c4174f67a2149420cbbe711d728914c2a5975 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Secur32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..28625bc229eb8cd841ab3bad71bad481e91d4c81 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensEvts.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensEvts.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..5b45a562aaecb96c1a166570ef5273c42e5d30dd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensEvts.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensorsUtils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensorsUtils.lib new file mode 100644 index 0000000000000000000000000000000000000000..dd6f41be97ef761d16d47a142168a37b3b9c72c9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SensorsUtils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sfc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sfc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a0f16a7ad7f804f2ef95b73804aba971f8679e44 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sfc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShFolder.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShFolder.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ec869bbd350769e5c71f4913ae3641eb7fbad0d2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShFolder.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShLwApi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShLwApi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..2efdebcb75869d78841dcf40cc1ef078229d2bff Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ShLwApi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SnmpAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SnmpAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0559fabb92e20cfb4915a02e7974bda192cba1a9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SnmpAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SpOrder.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SpOrder.Lib new file mode 100644 index 0000000000000000000000000000000000000000..7a9fa44b50ed18c271a1997ba4c92b057f062be4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/SpOrder.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/StdOle2.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/StdOle2.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..3e6b5833870137f06dddbcb52d62c66126e2f2b4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/StdOle2.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sti.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sti.Lib new file mode 100644 index 0000000000000000000000000000000000000000..bd1d74640521331c8a32a50d93311d86a2a4bca0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Sti.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Tapi32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Tapi32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..f8f5b356c76f05f1bf7d47bacf2a7a503cf69031 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Tapi32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Traffic.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Traffic.Lib new file mode 100644 index 0000000000000000000000000000000000000000..581286453dbac14b8979691ae7e1d34de013e58f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Traffic.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/TranscodeImageUID.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/TranscodeImageUID.lib new file mode 100644 index 0000000000000000000000000000000000000000..c29201a46e8dd32d7aa9bdfe07dac86666542219 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/TranscodeImageUID.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UIAutomationCore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UIAutomationCore.lib new file mode 100644 index 0000000000000000000000000000000000000000..551a5d0e4f76fc1a8f964cf66dca7f72322d5d44 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UIAutomationCore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/USP10.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/USP10.Lib new file mode 100644 index 0000000000000000000000000000000000000000..661591409bcee13748b8d21d1193a676938a2e6f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/USP10.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Urlmon.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Urlmon.Lib new file mode 100644 index 0000000000000000000000000000000000000000..053a8758edf2190aed55d5763b44fa30b3556450 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Urlmon.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UserEnv.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UserEnv.Lib new file mode 100644 index 0000000000000000000000000000000000000000..887e2b3ddc8e1bdc3e071c5f9bfa3b71bab5d042 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/UserEnv.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Uxtheme.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Uxtheme.lib new file mode 100644 index 0000000000000000000000000000000000000000..d1001717fd35f1de31b7d32586cf6a1ce0e5b9f4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Uxtheme.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Version.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Version.Lib new file mode 100644 index 0000000000000000000000000000000000000000..43f788d8b1fa39ae1c02c9743d07f9429599bc66 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Version.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Vfw32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Vfw32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..914353cfd0880948d24b6c075ac5295a303be715 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Vfw32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Virtdisk.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Virtdisk.Lib new file mode 100644 index 0000000000000000000000000000000000000000..b36370862d40753df60992be53ee9e6f45b8b44d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Virtdisk.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSnmp32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSnmp32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..96ff18d1c9d6f0fdee6016a47827fddf73bceef6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSnmp32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSock32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSock32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ce0804c111a15110bf102b4fb44429ef2e3248ee Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WSock32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WdsTptMgmt.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WdsTptMgmt.tlb new file mode 100644 index 0000000000000000000000000000000000000000..2bcfcc0e7c7bfe5663b734adc81f7716acc5dc95 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WdsTptMgmt.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WebServices.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WebServices.lib new file mode 100644 index 0000000000000000000000000000000000000000..53300ebb8e0e9514774421367ef797ffa5ef41b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WebServices.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wer.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wer.lib new file mode 100644 index 0000000000000000000000000000000000000000..1117446da78d5f5fa21669acd941d2d5e8cb0aa2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wer.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinBio.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinBio.lib new file mode 100644 index 0000000000000000000000000000000000000000..804af8bf1f87dee9aabbe1f864e1cbcae9236f8c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinBio.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvEmulation.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvEmulation.lib new file mode 100644 index 0000000000000000000000000000000000000000..48ec48c3a9c35de0ee6cbb5912106917462c707d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvEmulation.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvPlatform.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvPlatform.lib new file mode 100644 index 0000000000000000000000000000000000000000..35323f88202320062d07eb1dd056ad737f0dedb9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinHvPlatform.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinMM.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinMM.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8e42407dfdd6ae3a6ebbd72a32e2f9f4e59d4704 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinMM.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinSpool.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinSpool.Lib new file mode 100644 index 0000000000000000000000000000000000000000..1190ba320df3ac1c847cb9551de5bbe79b0572df Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinSpool.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinTrust.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinTrust.Lib new file mode 100644 index 0000000000000000000000000000000000000000..dab18e5cbcd2122d2926da3195f153c116015a6e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WinTrust.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldap32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldap32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6fbec0d8ef98209c6b6fbb0e5e988b3bfdc32ad7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldap32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..69e158e884095a103f8e883bfad470712784da5f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Wldp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WtsApi32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WtsApi32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..043ebed89bbdd8ebe61d166cd2f23d1267dbbdce Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/WtsApi32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Xinput9_1_0.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Xinput9_1_0.lib new file mode 100644 index 0000000000000000000000000000000000000000..923a5d0a5cd34678fb7a1c861ca8c7fa333a0c3c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/Xinput9_1_0.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/certcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/certcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..baf8b4f59e73286c1413b41432eef2d4d1179443 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/certcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cfgmgr32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cfgmgr32.lib new file mode 100644 index 0000000000000000000000000000000000000000..6f72ba126148a93d5f1ee5646aa5a2df3f8596d5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cfgmgr32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cimfs.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cimfs.lib new file mode 100644 index 0000000000000000000000000000000000000000..298dbef47c2c1d3ebc8102a9f3bf2cfdf5f23160 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cimfs.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cldapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cldapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..1987f27cc36c8a6aa761a213154f2a240eb6bc35 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cldapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/clfsw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/clfsw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..3232b70a4f744d76709ec79b1f41f44da7a23a6d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/clfsw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/compstui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/compstui.lib new file mode 100644 index 0000000000000000000000000000000000000000..2349ab55930d5ca286f9109b579e095bae710289 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/compstui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computecore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computecore.lib new file mode 100644 index 0000000000000000000000000000000000000000..7be841ecbf1e3888ac7f102bdc57baaeff73bab6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computecore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computenetwork.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computenetwork.lib new file mode 100644 index 0000000000000000000000000000000000000000..3e7e3f06d167c96256a5f66f4ffd4b03dae971c6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computenetwork.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computestorage.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computestorage.lib new file mode 100644 index 0000000000000000000000000000000000000000..c58d31785ed4be4f8ffdc118026db511aa3db0df Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/computestorage.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/corrEngine.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/corrEngine.lib new file mode 100644 index 0000000000000000000000000000000000000000..0ba2a1bd6974f7439d8c560b846cf24367ab291f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/corrEngine.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptdll.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptdll.lib new file mode 100644 index 0000000000000000000000000000000000000000..a4a9951b7ee2023a8bab9e7d79d5f72cae7ce953 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptdll.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptui.lib new file mode 100644 index 0000000000000000000000000000000000000000..f1790c8c9e2f58df47417828c754f9624a27e2bb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptxml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptxml.lib new file mode 100644 index 0000000000000000000000000000000000000000..4850bb7b1ab3921d3d9bd94811ee26a3d5e8be08 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cryptxml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..4b6e31075e3a850ee6f970eeda73441cae011f47 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscdll.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscdll.lib new file mode 100644 index 0000000000000000000000000000000000000000..a29e679f99a84d222b8faef47b8f426eeaaa5ee1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/cscdll.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d2d1.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d2d1.lib new file mode 100644 index 0000000000000000000000000000000000000000..5c96ec2703901672fcfddcd79aedd63cdd5a818a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d2d1.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10.lib new file mode 100644 index 0000000000000000000000000000000000000000..f409a2958edc449066637ed96d2517c1ecb9b051 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10_1.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10_1.lib new file mode 100644 index 0000000000000000000000000000000000000000..bdd9cb5f62040f29069275143b3bf1afdef38cc6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d10_1.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d11.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d11.lib new file mode 100644 index 0000000000000000000000000000000000000000..987848a9d42af271cc4f67f585281d4987865eb2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d11.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d12.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d12.lib new file mode 100644 index 0000000000000000000000000000000000000000..594d1bb6b588e4c0c7e0a0e0fef4a163a81fbe63 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d12.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d9.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d9.lib new file mode 100644 index 0000000000000000000000000000000000000000..a710055d7ffd407fe8fecb37fc89f6fb2d673ac5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3d9.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcompiler.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcompiler.lib new file mode 100644 index 0000000000000000000000000000000000000000..1daf6317f27a420593c121e0e7b55cba8c4a6e41 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcompiler.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsx.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsx.lib new file mode 100644 index 0000000000000000000000000000000000000000..e5b87556a444ab89f3fad9680cd0f9346e91a968 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsx.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsxd.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsxd.lib new file mode 100644 index 0000000000000000000000000000000000000000..b08b2762299e8dea88c94ba62d222cc1847b13c7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/d3dcsxd.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/davclnt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/davclnt.lib new file mode 100644 index 0000000000000000000000000000000000000000..68b4a748de37c564d008e90042e6e11c9d201e79 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/davclnt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dciman32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dciman32.lib new file mode 100644 index 0000000000000000000000000000000000000000..fd1bbc6561fd2a9b47f9f27c9d08383c0da2409a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dciman32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dcomp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dcomp.lib new file mode 100644 index 0000000000000000000000000000000000000000..f7a455d31186ea86d1b240a9250e5d9b1c9756eb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dcomp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ddraw.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ddraw.lib new file mode 100644 index 0000000000000000000000000000000000000000..1d24047aeaf90c01fbcc249e74b307d2dc6618f0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ddraw.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devenum.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devenum.lib new file mode 100644 index 0000000000000000000000000000000000000000..8955265c9111a415680beb54aa33461bbdda3619 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devenum.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/deviceaccess.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/deviceaccess.lib new file mode 100644 index 0000000000000000000000000000000000000000..9eefe62318a639fd5b992a1f2532ffba13a6692c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/deviceaccess.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..7bf9c94fc982aaf594dedec3cac81dff1e00b487 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/devmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dflayout.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dflayout.lib new file mode 100644 index 0000000000000000000000000000000000000000..10836f8ad505a5a80a6ae959599e90cbb39131fe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dflayout.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dhcpsapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dhcpsapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..208622d9d8116489c2b89ca242c219cc5a190aa0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dhcpsapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/directml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/directml.lib new file mode 100644 index 0000000000000000000000000000000000000000..c54579ae9251e24af478952d199fc30c38d88322 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/directml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dloadhelper.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dloadhelper.lib new file mode 100644 index 0000000000000000000000000000000000000000..d5a3251ed494f87a35df2c164129a4873cb48451 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dloadhelper.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dmprocessxmlfiltered.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dmprocessxmlfiltered.lib new file mode 100644 index 0000000000000000000000000000000000000000..619eafe399906844ec78f89d6a40e42b856f3987 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dmprocessxmlfiltered.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnscrcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnscrcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..dbb6e87cbeb7169ea54853b364ebd3f85fc966a9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnscrcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnslib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnslib.lib new file mode 100644 index 0000000000000000000000000000000000000000..dbb6e87cbeb7169ea54853b364ebd3f85fc966a9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnslib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsperf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsperf.lib new file mode 100644 index 0000000000000000000000000000000000000000..0c8f691ef1615e0773175f5c9162d9024129e45a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsperf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrpc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrpc.lib new file mode 100644 index 0000000000000000000000000000000000000000..3f1c23df59818b58c421f7217aeecea46e098e6e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrpc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrslvr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrslvr.lib new file mode 100644 index 0000000000000000000000000000000000000000..b1bed0af006653dfbbd3be24ab22d53ee6f556a7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dnsrslvr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dpx.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dpx.lib new file mode 100644 index 0000000000000000000000000000000000000000..4f562aa24c64076dd32467f44b16b4be1c41b488 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dpx.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dsound.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dsound.lib new file mode 100644 index 0000000000000000000000000000000000000000..b46a8782ce0ab2e4f49e383d70d8a5a995b964ee Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dsound.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dssec.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dssec.lib new file mode 100644 index 0000000000000000000000000000000000000000..39a633a85db6fb7a43d2eccb74a7c22f590c06ea Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dssec.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dststlog.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dststlog.lib new file mode 100644 index 0000000000000000000000000000000000000000..0fa3eb1d13513723c4dd8165ff2a9a85bfd61890 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dststlog.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwmapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwmapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..d1044f3d85a6cf9cb384de3e7ab1f2be702b808a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwmapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwrite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwrite.lib new file mode 100644 index 0000000000000000000000000000000000000000..876a97dba00e67f5fa18a579c6b6a3122642b81d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dwrite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcompiler.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcompiler.lib new file mode 100644 index 0000000000000000000000000000000000000000..b28c5456cd08f537a88566b2478c2197cfe8032e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcompiler.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..6033fb395904f90760bc5c33058bf0d69532cba7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxgi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxgi.lib new file mode 100644 index 0000000000000000000000000000000000000000..9f0d9ce0d1d4471af676cb27b8abb571a247d3a5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxgi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtmsft.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtmsft.lib new file mode 100644 index 0000000000000000000000000000000000000000..5069765015e458fac46590e7c3d094d82113a7a7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtmsft.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtrans.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtrans.lib new file mode 100644 index 0000000000000000000000000000000000000000..b9bbb87049d356646a98362a018b7cb651fe19e9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxtrans.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxva2.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxva2.lib new file mode 100644 index 0000000000000000000000000000000000000000..4f464df4b2cdbe06f2039842d8be06f3ad5ebe36 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/dxva2.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappcfg.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappcfg.lib new file mode 100644 index 0000000000000000000000000000000000000000..dbaf98279ef85ebaf1248ff42c0ad57f3d781e6d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappcfg.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappprxy.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappprxy.lib new file mode 100644 index 0000000000000000000000000000000000000000..1f718c9977a8467143cc6c60bb2088b7cff828fc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/eappprxy.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/easregprov.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/easregprov.lib new file mode 100644 index 0000000000000000000000000000000000000000..0e41273c1f6c565704ff4260e38d675d5ce06217 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/easregprov.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/efswrt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/efswrt.lib new file mode 100644 index 0000000000000000000000000000000000000000..a6530968f298eeee5d6a86d8aa4f0aa21b480858 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/efswrt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/els.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/els.lib new file mode 100644 index 0000000000000000000000000000000000000000..bea644bf798fefdf86a2892c121da0302cc466bb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/els.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/esent.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/esent.lib new file mode 100644 index 0000000000000000000000000000000000000000..6d999461214c3cdab9d0fcb2448d826f8be8a137 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/esent.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/evr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/evr.lib new file mode 100644 index 0000000000000000000000000000000000000000..c912570f1ec55243c10a34a6b7fbfc2dd326741a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/evr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/exdisp.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/exdisp.tlb new file mode 100644 index 0000000000000000000000000000000000000000..f3e1dd4794d0640fda0b2793ccd3c01115c40425 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/exdisp.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/faxcomex.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/faxcomex.tlb new file mode 100644 index 0000000000000000000000000000000000000000..d6bb32ecb3b17e4c507b7b28eb817aaba757d9df Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/faxcomex.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/feclient.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/feclient.lib new file mode 100644 index 0000000000000000000000000000000000000000..d0c42fc2cc96d0d8ccb9a2ea3e326b4d2c39baa8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/feclient.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fltLib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fltLib.lib new file mode 100644 index 0000000000000000000000000000000000000000..8df5aff49fd58c6298f307cfb29b6801b96d0674 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fltLib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fontsub.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fontsub.lib new file mode 100644 index 0000000000000000000000000000000000000000..2e4a319d6adc68c1a9aa2950a54daecba302be89 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fontsub.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fwpuclnt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fwpuclnt.lib new file mode 100644 index 0000000000000000000000000000000000000000..c1b03a9bf03fb4b2f71abd35f591d4284c530b4f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fwpuclnt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fxsutility.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fxsutility.lib new file mode 100644 index 0000000000000000000000000000000000000000..f3a1ec96f18e1c8c7107b18071695623cbeacd2f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/fxsutility.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gameinput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gameinput.lib new file mode 100644 index 0000000000000000000000000000000000000000..3c16602583d82f75cad41a029ba6a311fcad7755 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gameinput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/glmf32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/glmf32.lib new file mode 100644 index 0000000000000000000000000000000000000000..97b1fdd91440159b574c47fcdeb80c3113648eb4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/glmf32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gpmuuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gpmuuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..18c267d240665b2f90b6c40c388ca5e0024106bc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/gpmuuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hbaapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hbaapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..5c0a1892d752c36c984893ad62ea2b4c4ffc40d0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hbaapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hhsetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hhsetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..34e3db157c2f4a567ba1a73eab8461552bfb1f47 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hhsetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hid.lib new file mode 100644 index 0000000000000000000000000000000000000000..6730030699342aeedab640e262aa4e0e2fae3473 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hrtfapo.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hrtfapo.lib new file mode 100644 index 0000000000000000000000000000000000000000..d86ae329721719f19f069d27fc56d3ffa45926b0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hrtfapo.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/httpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/httpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..ad8f40b45055c25c4be4458e6236225f5a07a395 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/httpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hxhelppaneproxy.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hxhelppaneproxy.tlb new file mode 100644 index 0000000000000000000000000000000000000000..be547530393f918ce0d43d461f37b0350ff51ff6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/hxhelppaneproxy.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iashlpr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iashlpr.lib new file mode 100644 index 0000000000000000000000000000000000000000..912dac16042aeaa4813322f800a1d1935ce2075e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iashlpr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/icuin.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/icuin.Lib new file mode 100644 index 0000000000000000000000000000000000000000..7a9a8059b584ae34f9a71e8ecd04a82c50b03b6d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/icuin.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iesetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iesetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..3b763888ea2d5670ce4bdd9555e183667a9665e4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iesetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iextag.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iextag.tlb new file mode 100644 index 0000000000000000000000000000000000000000..b284f8bd79cc547e894b44ce126b6e49f348bffb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iextag.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2.tlb new file mode 100644 index 0000000000000000000000000000000000000000..b45fcefeea82fe528bb76d992f3981455aaaae29 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2fs.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2fs.tlb new file mode 100644 index 0000000000000000000000000000000000000000..1d5648872dafc6d67a69e77979eb05d1882d29e5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imapi2fs.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imgutil.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imgutil.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6d00a7f934312cff0f08ddb54a5d44eb8c31e155 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/imgutil.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/infocardapi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/infocardapi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..697e2ab5d03ffc2b73871fe01b20950850a72835 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/infocardapi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inkobjcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inkobjcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..818119e18aac75c5e8906ef33af2155e298c4f4b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inkobjcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inseng.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inseng.lib new file mode 100644 index 0000000000000000000000000000000000000000..47db84391f31a450971ec2b82d320e5ef542e4b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/inseng.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iphlpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iphlpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..030d40075dcdfa5940e3265cae46fc9d943b3ca7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iphlpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iscsidsc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iscsidsc.lib new file mode 100644 index 0000000000000000000000000000000000000000..ab19b316cc33ece89fb4ab7cab4e2d5c7da0e230 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/iscsidsc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/jsrt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/jsrt.lib new file mode 100644 index 0000000000000000000000000000000000000000..54991d2a06b455324d1c2de2dbcf38dfcffb0331 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/jsrt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/kerbcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/kerbcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..13e235863391e5352607ad4eb29315510a460d1a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/kerbcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/keycredmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/keycredmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..1e4e029aff26870f63b3af3c3a03a6fa7c328073 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/keycredmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ktmw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ktmw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..cbf53a3431cede635245ebaf57d817aa936e003e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ktmw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/lamparray.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/lamparray.lib new file mode 100644 index 0000000000000000000000000000000000000000..162bb57efbc42cd2dbdff78f00e8cbfe2e2e30ac Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/lamparray.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/magnification.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/magnification.lib new file mode 100644 index 0000000000000000000000000000000000000000..69095a1c26aa6f99ec494694970822962f5e5815 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/magnification.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi.tlb new file mode 100644 index 0000000000000000000000000000000000000000..897c8eb01e202485d0ce1e73db6fffd820e3fee6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..6a72b5d81051a83b8d8e33c6c396f1673f41def1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mbnapi_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mciole32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mciole32.lib new file mode 100644 index 0000000000000000000000000000000000000000..bf2e0b5a8363ae8efe0bc0c7c28854f8237b7960 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mciole32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mdmlocalmanagement.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mdmlocalmanagement.lib new file mode 100644 index 0000000000000000000000000000000000000000..5719f8f9a397e213f03ef946ad2c33020908266b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mdmlocalmanagement.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfplay.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfplay.lib new file mode 100644 index 0000000000000000000000000000000000000000..6517d9e4f266c2a315731988a44e1b2885e5ab5c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfplay.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfreadwrite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfreadwrite.lib new file mode 100644 index 0000000000000000000000000000000000000000..37333597141aede031465ae616bf3b82a51e399b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfreadwrite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfsensorgroup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfsensorgroup.lib new file mode 100644 index 0000000000000000000000000000000000000000..2f0903839d846f74307b17b5d851e5253d9f7663 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mfsensorgroup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mi.lib new file mode 100644 index 0000000000000000000000000000000000000000..0db4ded997703dbee58e27174face4894ee74fac Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mmdevapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mmdevapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..86bbe7efdc652f686bce32bfbdf61c8b3f092eba Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mmdevapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mprsnap.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mprsnap.lib new file mode 100644 index 0000000000000000000000000000000000000000..7211f184f1b90882b5d694c02c00ffd30d59ae59 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mprsnap.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mqoa.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mqoa.tlb new file mode 100644 index 0000000000000000000000000000000000000000..523c7430b3c3a0e9041090b615d1ad70537c2ff5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mqoa.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msaatext.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msaatext.lib new file mode 100644 index 0000000000000000000000000000000000000000..abfcf8851d8d6daf5d19e35358cd3618a4b7509e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msaatext.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdasc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdasc.lib new file mode 100644 index 0000000000000000000000000000000000000000..20950f3b64092a019ccaa61d4702449908ec0e13 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdasc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdatsrc.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdatsrc.tlb new file mode 100644 index 0000000000000000000000000000000000000000..69dc8c481e4a8e019a3a1c4432cc0a4c74127af2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdatsrc.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdelta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdelta.lib new file mode 100644 index 0000000000000000000000000000000000000000..6480381b542700af94b7642ca6ce7066503d703f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdelta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdmo.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdmo.lib new file mode 100644 index 0000000000000000000000000000000000000000..5e41c582c7f20d567a6b664c4af147896a9ddf1f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdmo.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdrm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdrm.lib new file mode 100644 index 0000000000000000000000000000000000000000..afee9f8fdd68de5028f438136369c3ddba4b9c38 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msdrm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msfeeds.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msfeeds.tlb new file mode 100644 index 0000000000000000000000000000000000000000..0e020ee3a17ddc631a9382ae5e084b826f9eb017 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msfeeds.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatcha.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatcha.lib new file mode 100644 index 0000000000000000000000000000000000000000..b8def84b5391aac744495e2b6af5706bad221368 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatcha.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatchc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatchc.lib new file mode 100644 index 0000000000000000000000000000000000000000..ece9196c064d3c6b106e36f63d17a99bf8f0a945 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mspatchc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msports.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msports.lib new file mode 100644 index 0000000000000000000000000000000000000000..45b3d289da8cb38c025f6cb518e480ae34f4aa1d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msports.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msv1_0.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msv1_0.lib new file mode 100644 index 0000000000000000000000000000000000000000..4ffea84025bd138eb55bb413364271aa1aafcf60 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msv1_0.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msvfw32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msvfw32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d074ace7faf8d01d942600d5cc421a0ec8710dd2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msvfw32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msxml6.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msxml6.lib new file mode 100644 index 0000000000000000000000000000000000000000..1d3f1aed64548a103708086233fe85d98be6fa73 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/msxml6.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mtxdm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mtxdm.lib new file mode 100644 index 0000000000000000000000000000000000000000..2d6a60cd46d1fff355c573547010477c9d5331b6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/mtxdm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ncrypt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ncrypt.lib new file mode 100644 index 0000000000000000000000000000000000000000..304d54ea380712895c7395ecd5f16f1056674e06 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ncrypt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/nddeapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/nddeapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..e68cad04d23c86ce3174fca4328d4b9aaf83078d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/nddeapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndfapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndfapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..f94a9ac4dec738361fb94d45780ee8d1d09e1b08 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndfapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndproxystub.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndproxystub.lib new file mode 100644 index 0000000000000000000000000000000000000000..06fd3f4ca755ebef487b9acf75be2ddcf33b7e07 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ndproxystub.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/newdev.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/newdev.lib new file mode 100644 index 0000000000000000000000000000000000000000..426f25f6a43f749dc44ad20f8a34b64e342122e1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/newdev.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ninput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ninput.lib new file mode 100644 index 0000000000000000000000000000000000000000..cb05710dce8ca64e2dc1c47575ad307ab0ac1bf0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ninput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/normaliz.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/normaliz.lib new file mode 100644 index 0000000000000000000000000000000000000000..c34a1e5a6cd0a03c9d8482f80e2078804f1d964d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/normaliz.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsa.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsa.lib new file mode 100644 index 0000000000000000000000000000000000000000..6b7b999af0b8d9263cb53f20f88b205c32884427 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsa.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsatq.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsatq.lib new file mode 100644 index 0000000000000000000000000000000000000000..cee14075a0e307eba9c5167ff7de25fd0946f981 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsatq.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..27883e273887ff93ff2fd6f95874c2b2a01b8fe6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntdsetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntfrsapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntfrsapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7ac3068b3d9d2ca665cca395854fbc33b1f9f38e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntfrsapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntlanman.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntlanman.lib new file mode 100644 index 0000000000000000000000000000000000000000..32de64e13a12eeabeb5f72952ca7623d4912abf6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntlanman.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntmarta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntmarta.lib new file mode 100644 index 0000000000000000000000000000000000000000..bb284ba2a89e2ad2ec8edea4b6cac9bf0b41c5bd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ntmarta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/objsel.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/objsel.lib new file mode 100644 index 0000000000000000000000000000000000000000..2c626310033412dedf68c2490c5b0ce885fd22c6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/objsel.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbc32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbc32.lib new file mode 100644 index 0000000000000000000000000000000000000000..bc592c60ac5708f9c64322e50ed5aa70308c38da Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbc32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbcbcp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbcbcp.lib new file mode 100644 index 0000000000000000000000000000000000000000..83ec2052034cc4a771313c4d56e04c6ebb2c6a20 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/odbcbcp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olecli32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olecli32.lib new file mode 100644 index 0000000000000000000000000000000000000000..62fbee36f562c67fe6e5484a6f4d1beb7e5b80f8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olecli32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/oledb.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/oledb.lib new file mode 100644 index 0000000000000000000000000000000000000000..e27bc530096cbb828db366f6386caa648b897e1b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/oledb.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olesvr32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olesvr32.lib new file mode 100644 index 0000000000000000000000000000000000000000..69a7425772aca1f6ab624657ab430acd43191012 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/olesvr32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ondemandconnroutehelper.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ondemandconnroutehelper.lib new file mode 100644 index 0000000000000000000000000000000000000000..8d2718fcfdedb48c1a8c3ef045f44048ce2a2d63 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ondemandconnroutehelper.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/opmxbox.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/opmxbox.Lib new file mode 100644 index 0000000000000000000000000000000000000000..053d6e535e5d1052fc66dabe00bc1cc8e8a0be4c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/opmxbox.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/osptk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/osptk.lib new file mode 100644 index 0000000000000000000000000000000000000000..4dd2d70d470fe179941801f7d13ab6302cc25c56 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/osptk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/pathcch.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/pathcch.lib new file mode 100644 index 0000000000000000000000000000000000000000..844a28c6ae5ac399810fe179fcc25fab265064d4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/pathcch.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/powrprof.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/powrprof.lib new file mode 100644 index 0000000000000000000000000000000000000000..58794f66c403082110078fb00ff71a968e5d1e46 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/powrprof.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/prntvpt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/prntvpt.lib new file mode 100644 index 0000000000000000000000000000000000000000..673ca9a51b1e44103221b53b1389f2a9554f526f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/prntvpt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/propsys.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/propsys.lib new file mode 100644 index 0000000000000000000000000000000000000000..078145e4f024e255985614b6a8807e25bbde060c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/propsys.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/psapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/psapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..a21de7a33eff3eea56032c1d57531d3bcaf412d0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/psapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/quartz.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/quartz.lib new file mode 100644 index 0000000000000000000000000000000000000000..d7e9917701526d5c2a661a52645909224cc008fe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/quartz.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/query.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/query.lib new file mode 100644 index 0000000000000000000000000000000000000000..bebe3ed25f7d8db5fc50e70ff86dbe8286c7d15a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/query.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/qwave.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/qwave.lib new file mode 100644 index 0000000000000000000000000000000000000000..13072abd8460442595360f7f4465fedd963e7cd1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/qwave.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rasuser.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rasuser.lib new file mode 100644 index 0000000000000000000000000000000000000000..81e33f3eaf616546834b96304068cd6c5eeea3f8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rasuser.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rdpencomapi.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rdpencomapi.tlb new file mode 100644 index 0000000000000000000000000000000000000000..2451680f55a82f98051387d069f83e6a505c6aae Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rdpencomapi.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rendezvoussession.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rendezvoussession.tlb new file mode 100644 index 0000000000000000000000000000000000000000..57d983033527628c80410114195aef8bf7f5f96f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rendezvoussession.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/resutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/resutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..035a2ce9ca1979a890b0d23ccd70427852cad25a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/resutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rometadata.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rometadata.lib new file mode 100644 index 0000000000000000000000000000000000000000..a8b37bbcbaeb1a73aca173e5d482f98d0a476dc4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rometadata.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcexts.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcexts.lib new file mode 100644 index 0000000000000000000000000000000000000000..37c68cca8f6d73f029b99ad6e5434744d4b47d96 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcexts.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcproxy.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcproxy.lib new file mode 100644 index 0000000000000000000000000000000000000000..3356ba9735c7dcfc12c85f6d70c529a392bddfe6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rpcproxy.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rstrtmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rstrtmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..d346da398393be759e8cdb7ba5d8c2167763b6a1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rstrtmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rtutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rtutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..fe33c36ebe0436f225d9472d32cfbc61d833868f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/rtutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/runtimeobject.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/runtimeobject.lib new file mode 100644 index 0000000000000000000000000000000000000000..45623a36bde571c789464f9407abb84f6ad506df Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/runtimeobject.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samlib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samlib.lib new file mode 100644 index 0000000000000000000000000000000000000000..b34e8c3f07ec97b7625e768575cb4ebc724bbd71 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samlib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samsrv.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samsrv.lib new file mode 100644 index 0000000000000000000000000000000000000000..550e35992f5473a1fc405902eff19c5324cdaeb1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/samsrv.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sas.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sas.lib new file mode 100644 index 0000000000000000000000000000000000000000..82f3bdad60a38eda628c465910c1927b4fac4b1f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sas.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scecli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scecli.lib new file mode 100644 index 0000000000000000000000000000000000000000..cce34c8071e56a7ef129bebf7b6e204b4e888780 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scecli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scesrv.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scesrv.lib new file mode 100644 index 0000000000000000000000000000000000000000..620794d8f41fe78758e8a7c118e8f34d0f2cec9b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/scesrv.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/schannel.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/schannel.lib new file mode 100644 index 0000000000000000000000000000000000000000..12f033619726f367249de57b8452cca9752be22a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/schannel.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/security.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/security.lib new file mode 100644 index 0000000000000000000000000000000000000000..1a5a49c1a026be94de90d809ccb28a1277e06606 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/security.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sens.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sens.lib new file mode 100644 index 0000000000000000000000000000000000000000..09648892e4825681f6f3f743d1d46e13da73cf2f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/sens.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..3cac372f10530404c1b638050bc5c9545501b7fd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shdocvw.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shdocvw.lib new file mode 100644 index 0000000000000000000000000000000000000000..ed2dd3035029bc8301dc716d77e13c810fd405f8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/shdocvw.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/simpdata.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/simpdata.tlb new file mode 100644 index 0000000000000000000000000000000000000000..f545a83d4686e7586929d2a8d3b5cb07a107bffa Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/simpdata.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slc.lib new file mode 100644 index 0000000000000000000000000000000000000000..43a3f4e7f82b42457b3d5f43136c6bb7c37f8918 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slcext.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slcext.lib new file mode 100644 index 0000000000000000000000000000000000000000..f827ea0a68754601f0e3c9b7d1a28ddbb1f2b008 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slcext.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slwga.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slwga.lib new file mode 100644 index 0000000000000000000000000000000000000000..f08b40600db1c0ebbe7bd8737f0735026482c003 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/slwga.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/spoolss.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/spoolss.lib new file mode 100644 index 0000000000000000000000000000000000000000..05a1900d45a97a430311575f7fe3edae26fe790b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/spoolss.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/srpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/srpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..0675b933d6e24ede91438265e30bb4a808682118 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/srpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ssdpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ssdpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..b7110de44939f2978e24064a652ee4f1688b2eca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ssdpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/strsafe.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/strsafe.lib new file mode 100644 index 0000000000000000000000000000000000000000..8ae0a3136381716dd2ffccbbc5c04e512144bb41 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/strsafe.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/structuredquery.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/structuredquery.lib new file mode 100644 index 0000000000000000000000000000000000000000..37dfadf234fda399ab6070525e61094978f1a878 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/structuredquery.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/swdevice.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/swdevice.lib new file mode 100644 index 0000000000000000000000000000000000000000..325746bb1e4076cf74c034b8ddcd04ddd052eab7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/swdevice.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/synchronization.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/synchronization.lib new file mode 100644 index 0000000000000000000000000000000000000000..17f711bb93ab5f2073f88a2e06caa93c86c37096 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/synchronization.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/t2embed.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/t2embed.lib new file mode 100644 index 0000000000000000000000000000000000000000..8beb9962c97d0945b465daf85cde86e377b098fd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/t2embed.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/taskschd.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/taskschd.lib new file mode 100644 index 0000000000000000000000000000000000000000..54cad3c245314ac826cc317baf229cf1a114da5d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/taskschd.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tbs.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tbs.lib new file mode 100644 index 0000000000000000000000000000000000000000..3d386a8ecb87609974bec7a29dc7e30baa32b3be Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tbs.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tdh.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tdh.lib new file mode 100644 index 0000000000000000000000000000000000000000..076114ef3a80bac7276149f1993a3bb2b75c6cdd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tdh.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tokenbinding.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tokenbinding.lib new file mode 100644 index 0000000000000000000000000000000000000000..346f17d1f3d8a4722c5540b944b8ce426e243c1a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tokenbinding.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsec.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsec.lib new file mode 100644 index 0000000000000000000000000000000000000000..6c41a08e9b83ee075d6e57e786cc8955c9f58e65 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsec.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsuserex.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsuserex.tlb new file mode 100644 index 0000000000000000000000000000000000000000..7ff565619fcc19b6ae611f1aa7eb1b5e875a9124 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/tsuserex.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/twinapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/twinapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..453532d93966109476464dc0fa9c40310d6ee93a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/twinapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/txfw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/txfw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..a4c60f8de7404574b47f90e4c6beee3c2682134c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/txfw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ualapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ualapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..31b26668ddf158914d70c67d1ccb3414080b586c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/ualapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/umpdddi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/umpdddi.lib new file mode 100644 index 0000000000000000000000000000000000000000..6f806d911d3bd9fc527d715f352e02bbbea7dbdf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/umpdddi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vds_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vds_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..05bde9d09f41e6dd9de898dd917cdd30fcc10125 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vds_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/veinterop.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/veinterop.lib new file mode 100644 index 0000000000000000000000000000000000000000..7513ac4380b761cb44bb4caa1c4f58aa66974575 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/veinterop.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmdevicehost.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmdevicehost.lib new file mode 100644 index 0000000000000000000000000000000000000000..7c557f1bf7f1ce14b6b158ada8e497c5f6de3057 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmdevicehost.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmsavedstatedumpprovider.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmsavedstatedumpprovider.lib new file mode 100644 index 0000000000000000000000000000000000000000..1463e2859a0f8cbc990503775622837990f5234d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vmsavedstatedumpprovider.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/volatileaccessu.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/volatileaccessu.lib new file mode 100644 index 0000000000000000000000000000000000000000..1b52bc47ff63c92b1c62b44a33b5ff51a390d449 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/volatileaccessu.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vscmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vscmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..fc7256aed1618da34f4e240efd835e2ff533259a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vscmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vss_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vss_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..637a41cf60236f8d6b06dc66392babed7582afd8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vss_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vssapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vssapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..1e50d64752779ffc8c9120b0c9b639af73a6de4a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vssapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vstorinterface.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vstorinterface.lib new file mode 100644 index 0000000000000000000000000000000000000000..538c5119fc84630636174bc710019e275eeb370c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/vstorinterface.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wbemuuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wbemuuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..6706352bea9291e882862858e39a7a167c0cd60c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wbemuuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..096d31cf1d359883763336f306cef85787cf5770 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmguid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmguid.lib new file mode 100644 index 0000000000000000000000000000000000000000..51a84b0c8cf57ebe5c92c67f8109a8ec1eed0154 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wcmguid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsClientAPI.LIB b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsClientAPI.LIB new file mode 100644 index 0000000000000000000000000000000000000000..1ee2df62f95ccbc7673b38f7ade4aae0f8b0491d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsClientAPI.LIB differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsbp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsbp.lib new file mode 100644 index 0000000000000000000000000000000000000000..ff6fceff15456169c5b3dfab6571e9ccac5c2784 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsbp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsmc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsmc.lib new file mode 100644 index 0000000000000000000000000000000000000000..3831f744a8d688dab8e8a5465ce546da4a6c3c9f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdsmc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdspxe.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdspxe.lib new file mode 100644 index 0000000000000000000000000000000000000000..45313d9fa5feac6c5fd428140d16843b07768467 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdspxe.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdstptc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdstptc.lib new file mode 100644 index 0000000000000000000000000000000000000000..a0ec7dfc3b754a619f603f410142810c5a4b140d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wdstptc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/webauthn.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/webauthn.lib new file mode 100644 index 0000000000000000000000000000000000000000..a042a2ab9b5c9f443c843d56ba46021876979bc6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/webauthn.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/websocket.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/websocket.lib new file mode 100644 index 0000000000000000000000000000000000000000..554850d613ca6cc0ac7b62ab123a495195524899 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/websocket.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wecapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wecapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..af8ad5760973464524a985f5c3828e35cbcf1227 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wecapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wevtapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wevtapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..dad55a8cfdafe39a2f5acf2430aaafe9821a6ed9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wevtapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wiaservc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wiaservc.lib new file mode 100644 index 0000000000000000000000000000000000000000..6159fdb2268100ee2d5eaeec6f3776c32c17d281 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wiaservc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ai.machinelearning.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ai.machinelearning.lib new file mode 100644 index 0000000000000000000000000000000000000000..6259707a31f7285c7e1d739250f464f72c46335d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ai.machinelearning.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.data.pdf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.data.pdf.lib new file mode 100644 index 0000000000000000000000000000000000000000..f89fb425fb33be3e6a7e25b5a4d2f73b0a649295 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.data.pdf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.media.mediacontrol.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.media.mediacontrol.lib new file mode 100644 index 0000000000000000000000000000000000000000..1ea9f47d086d0fcfb34449704f298e758cad445c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.media.mediacontrol.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.networking.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.networking.lib new file mode 100644 index 0000000000000000000000000000000000000000..b41a450918905a098c99ad86495b866bd5ab19c3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.networking.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ui.lib new file mode 100644 index 0000000000000000000000000000000000000000..dee624259894c6ce4da3d710a3005c06190de434 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/windows.ui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winfax.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winfax.lib new file mode 100644 index 0000000000000000000000000000000000000000..ca873a3961a8ae9b7e7ad36a631591a85b65ff34 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winfax.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winhttp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winhttp.lib new file mode 100644 index 0000000000000000000000000000000000000000..a6417cf89011598740d51a0749115b411cce7451 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winhttp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wininet.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wininet.Lib new file mode 100644 index 0000000000000000000000000000000000000000..cf2bf6681b8dbd976a1136853295d84751ab5280 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wininet.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winml.lib new file mode 100644 index 0000000000000000000000000000000000000000..1eca0372c40f24ad1bcda1312116b45ef81277a5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsatapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsatapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..078b0270bb7ec99b04357918e9e1e1a948bd2512 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsatapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winscard.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winscard.lib new file mode 100644 index 0000000000000000000000000000000000000000..a4c76e982b8bd18a7c84e1e1d9007f8157449f8e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winscard.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsqlite3.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsqlite3.lib new file mode 100644 index 0000000000000000000000000000000000000000..9a0002c6112189e37127a2f7b1ead3bbea880a24 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsqlite3.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsta.lib new file mode 100644 index 0000000000000000000000000000000000000000..ca2c144edf7718e9478d2731abb677d5e566bba4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winsta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winusb.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winusb.lib new file mode 100644 index 0000000000000000000000000000000000000000..fef9df47fc9020fb1fbe035df301df91b6d9cd16 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/winusb.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wkspbkax.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wkspbkax.tlb new file mode 100644 index 0000000000000000000000000000000000000000..40e0877727cdddeb65a4357be1b130ce3b97a8d4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wkspbkax.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..47ca5171f6c6f54a8c7b38508d967241d511c11d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanui.lib new file mode 100644 index 0000000000000000000000000000000000000000..ad57171618b5ceb9c2229b8cd838936b78becba8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wlanui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmip.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmip.lib new file mode 100644 index 0000000000000000000000000000000000000000..ce71b93c0512fede8bdc77ed64e0afb444bc1495 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmip.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmiutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmiutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..1953bee2968c6482173c242160d95216059fa7a8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmiutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmvcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmvcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..88376859e4e92401eee7042f1b28b4948022df1e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wmvcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wnvapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wnvapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..d0ec1490b48be78226f9fe291ceda88f251cc1ed Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wnvapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wofutil.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wofutil.lib new file mode 100644 index 0000000000000000000000000000000000000000..e853e4fb0fedd0bb70f4e875e4ac2ce8baf26f54 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wofutil.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspace.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspace.tlb new file mode 100644 index 0000000000000000000000000000000000000000..2278d74c0407eaf2dd429448ac220902178410f6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspace.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspaceruntime.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspaceruntime.tlb new file mode 100644 index 0000000000000000000000000000000000000000..71aee77089558284d86db8d7637c4f1c514d45bf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/workspaceruntime.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbapp_uuid.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbapp_uuid.Lib new file mode 100644 index 0000000000000000000000000000000000000000..06765d7d8da9a488b1d2909bad4de921402c5af4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbapp_uuid.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbonline.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbonline.lib new file mode 100644 index 0000000000000000000000000000000000000000..c7b5d4a22fc4cbccbc7501b86df86f9b20d98196 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsbonline.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wscapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wscapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7cdc9f32a61d6816a18af2bf356bfbfdbd852d36 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wscapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsclient.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsclient.lib new file mode 100644 index 0000000000000000000000000000000000000000..f36b23ffcd98de34553c5e043e7f2c9349e45038 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsclient.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsdapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsdapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..15bcb06d0093b80f2e88c8e0f7a0d836ebf4893f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsdapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsmandisp.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsmandisp.tlb new file mode 100644 index 0000000000000000000000000000000000000000..0c2ec5afb20514240459d64c12046d311bc23dc6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/wsmandisp.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2.lib new file mode 100644 index 0000000000000000000000000000000000000000..4a125fd5c31ed1f3257903489a1cdb60bbd8375c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2_8.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2_8.lib new file mode 100644 index 0000000000000000000000000000000000000000..0b85545e65651518cb8875c4df49aa3abd0535b6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xaudio2_8.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinput.lib new file mode 100644 index 0000000000000000000000000000000000000000..5be0b279f1eb86597489eb0d66e37193d53fb3e0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinputuap.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinputuap.lib new file mode 100644 index 0000000000000000000000000000000000000000..8199edef2c42d349367f8e449307a10f2c5fcee4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xinputuap.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xmllite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xmllite.lib new file mode 100644 index 0000000000000000000000000000000000000000..3566a9dcb1b138f7908beb998bcf4f64a816abbf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xmllite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xolehlp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xolehlp.lib new file mode 100644 index 0000000000000000000000000000000000000000..22b45f9b74728c54835aa1af8d88d61e5e711ede Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xolehlp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsdocumenttargetprint.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsdocumenttargetprint.lib new file mode 100644 index 0000000000000000000000000000000000000000..ade2d00b5a310f3b7cf791efcaf1dae8c894499f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsdocumenttargetprint.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsprint.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsprint.lib new file mode 100644 index 0000000000000000000000000000000000000000..e21c63781afaabbff16486fb92bdf804a14a4abf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x64/xpsprint.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ASycFilt.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ASycFilt.Lib new file mode 100644 index 0000000000000000000000000000000000000000..433806316893e904b990fb25ab95cadcf9ea3152 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ASycFilt.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AclUI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AclUI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a7595e9e64767e9d7ef0063c1b8ae4bb6b317671 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AclUI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ActiveDS.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ActiveDS.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ee9e9a3c492d0c748c3d5ca49c1ac69ee00b7a93 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ActiveDS.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AuthZ.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AuthZ.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d63ff7b12814b77db30eca26f31a4fd03c9a24f8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/AuthZ.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/BluetoothApis.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/BluetoothApis.lib new file mode 100644 index 0000000000000000000000000000000000000000..5d9584a66d2dc4f4d3906010e3c54a6768622cd3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/BluetoothApis.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Cabinet.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Cabinet.Lib new file mode 100644 index 0000000000000000000000000000000000000000..bfd3eb81d79ee6fb6397c5c93df43bdc768c42f0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Cabinet.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CertPolEng.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CertPolEng.Lib new file mode 100644 index 0000000000000000000000000000000000000000..dba3b243f16c1338cb91591deb9c6897e7975ef3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CertPolEng.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Chakrart.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Chakrart.lib new file mode 100644 index 0000000000000000000000000000000000000000..462136fdd14c4c123f6eb68db592cf24863fb5ed Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Chakrart.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComCtl32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComCtl32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6afc1a99ad116f5e8166e06706e55c650b4c9dce Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComCtl32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComDlg32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComDlg32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..5e359a4669d6681ca6650ae6d3d08da0793b9591 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComDlg32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComSvcs.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComSvcs.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c0de490d0e47423d6de7169c169f7c96ed9f0444 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ComSvcs.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CompPkgSup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CompPkgSup.lib new file mode 100644 index 0000000000000000000000000000000000000000..96f8bf34a2f4e3c4e979e52edf7d7b1cd9c57159 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CompPkgSup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CoreMessaging.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CoreMessaging.lib new file mode 100644 index 0000000000000000000000000000000000000000..3a7ffa368520b3c79e1a0193dddd9de7f2602b99 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CoreMessaging.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Credui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Credui.lib new file mode 100644 index 0000000000000000000000000000000000000000..c6f930d73c0f4f2f823e08db5b6f059cdaf146ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Credui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Crypt32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Crypt32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6c38d9e8c8661182ac26f9207afcd313b5b41323 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Crypt32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CryptNet.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CryptNet.Lib new file mode 100644 index 0000000000000000000000000000000000000000..1cf1d34464948000f52d1626c855c2cfa9262d2a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/CryptNet.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSProp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSProp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a464c04bcc8b124be5170d0db4a04522b6672fdb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSProp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSUIExt.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSUIExt.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8d81358618f0d8a4bc6fe38cbce2bda4b3ff0a6e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DSUIExt.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgEng.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgEng.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8cad020fa6e645c47f806a5adb28758919cfc0e8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgEng.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgHelp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgHelp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4a4ef017aa4b6a9dabcc1d001f8c6ccaa8f97d95 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgHelp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgModel.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgModel.Lib new file mode 100644 index 0000000000000000000000000000000000000000..03db58cd93bcfbb82e1ad58fda3e37b17a1f1539 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DbgModel.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..82dbcd57d2af218277867bef746c7a1d55e533b8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc6.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc6.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d062b73f383fc0e283e264a69bd4892996bb54e0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DhcpCSvc6.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DiagnosticDataQuery.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DiagnosticDataQuery.Lib new file mode 100644 index 0000000000000000000000000000000000000000..437a9be786ac83ce6f82d29c7c631a734ca97d3e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DiagnosticDataQuery.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DnsAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DnsAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..22e1851633393781a24ca300569d2bafd6e5c68a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/DnsAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ElsCore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ElsCore.lib new file mode 100644 index 0000000000000000000000000000000000000000..4cc7751f25f2d6aa086bcba39ed7bb93b942bb60 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ElsCore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FaultRep.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FaultRep.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e0567b5673e670bff32346708f960d99980d8191 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FaultRep.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FhSvcCtl.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FhSvcCtl.lib new file mode 100644 index 0000000000000000000000000000000000000000..650513a884d4e0b6cdf90ffef7a9bdc9c3d843cf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/FhSvcCtl.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GPEdit.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GPEdit.lib new file mode 100644 index 0000000000000000000000000000000000000000..2b54e2eed754df5bfe1204776fb462b0eede0970 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GPEdit.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GlU32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GlU32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e5569af37a09861735dab1f5902bb2929a415776 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/GlU32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HLink.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HLink.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4fdbe872e8876562fcc961b5b1d53a9e8bdb4c2c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HLink.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HwReqChk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HwReqChk.lib new file mode 100644 index 0000000000000000000000000000000000000000..18e74b21dc541612fb9e5646548a769471a790ef Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/HwReqChk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..62c071b04315efc8685d0242704d1aa7c51d589c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icmui.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icmui.Lib new file mode 100644 index 0000000000000000000000000000000000000000..9455fd7fe83afdb355d9720f935d2c7390bef8b3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Icmui.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ImageHlp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ImageHlp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..f05e752a0a75c665c4274394f6478b7d665b46ae Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ImageHlp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Imm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Imm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..baf68544ad36a9fe28e2ec2de884a02e85ad9860 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Imm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Iprop.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Iprop.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c1b650a700ac38ceed67da3ab78fff387bda14ff Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Iprop.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/IsolatedWindowsEnvironmentUtils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/IsolatedWindowsEnvironmentUtils.lib new file mode 100644 index 0000000000000000000000000000000000000000..3c6e444f44363346b24d8953e223d482c66a53ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/IsolatedWindowsEnvironmentUtils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/KSProxy.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/KSProxy.Lib new file mode 100644 index 0000000000000000000000000000000000000000..2317e5cf3b24e9be03e8a5feb7ba9a36b35fd2a4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/KSProxy.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LicenseProtection.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LicenseProtection.Lib new file mode 100644 index 0000000000000000000000000000000000000000..2c1bca1df3467f42019e9d83876bd34a8b11eb9d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LicenseProtection.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LoadPerf.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LoadPerf.Lib new file mode 100644 index 0000000000000000000000000000000000000000..df6df1cff7056ea06cc9e9176b3dd4e3feeeb7a1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/LoadPerf.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Lz32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Lz32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..633e6f8d9eb0572802ac5ce340993200e8a5c4db Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Lz32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d8c9aab02f6be107e17db4951c58a736fc02e1e0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MDMRegistration.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MDMRegistration.lib new file mode 100644 index 0000000000000000000000000000000000000000..0d4f237e544f79bb5c1390776c47c522b2c696d4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MDMRegistration.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSAcm32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSAcm32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a429899b12bf92ceb51f8735ceca81bd401dd346 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSAcm32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSImg32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSImg32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..9ce34accf3b8d6f43937231e18ae75e384f9ba74 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSImg32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSRating.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSRating.Lib new file mode 100644 index 0000000000000000000000000000000000000000..508f4aa22aa4b0f42825fc86f87925be331b6c54 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSRating.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSTask.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSTask.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0893006e5a5612a8e50564a70b2b970ad41ff6f2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MSTask.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mf.lib new file mode 100644 index 0000000000000000000000000000000000000000..c356864d8364fa02bde187725cadc648396bea16 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..844e6a30e4ca8fa62573ace17f3ab295da6b6687 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfplat.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfplat.lib new file mode 100644 index 0000000000000000000000000000000000000000..19b621e2f8e2e0478abac44af22e17d17b25f65a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfplat.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfsrcsnk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfsrcsnk.lib new file mode 100644 index 0000000000000000000000000000000000000000..5464dba1d1b03364696dd32ac7c4bcb0e1bb6a83 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mfsrcsnk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MgmtAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MgmtAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..25ffb0f7247289ee03b0afa783250c4e683961a6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MgmtAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mpr.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mpr.Lib new file mode 100644 index 0000000000000000000000000000000000000000..29344725cbfc48981376b988060d428c7a6d97f1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mpr.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mprapi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mprapi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d1f553008062ffb3f9a16f3bbf3da65c8d084000 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mprapi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA.Lib new file mode 100644 index 0000000000000000000000000000000000000000..929ffc270efbe8771c703730f622030452aa6927 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA10.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA10.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..b6445a9c01f5e864547666dc6a65f8186bfd46b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA10.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA20.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA20.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..ff10dcaf87336d3672583f3c9b8a99d54b32e2f2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqOA20.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqRt.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqRt.Lib new file mode 100644 index 0000000000000000000000000000000000000000..886f7111c1d511249d7c6115eed49990b75d5783 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MqRt.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MrmSupport.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MrmSupport.lib new file mode 100644 index 0000000000000000000000000000000000000000..90298a594cdb1b96ef77d65d92eab9d86749c6aa Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MrmSupport.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsCtfMonitor.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsCtfMonitor.lib new file mode 100644 index 0000000000000000000000000000000000000000..e3fa43ccd962299c533e8d0fb9d8004ee0715d1b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsCtfMonitor.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsWSock.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsWSock.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0949f210c7cb892dedde3eb018dcf3e22f0637e2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsWSock.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..91145706afef7ee78e55b84c5f954e838c243439 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml2.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml2.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0a92d91eb6fcc69ee61479709932f99e333a6cf5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/MsXml2.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mscms.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mscms.Lib new file mode 100644 index 0000000000000000000000000000000000000000..415274ff41e83b95e5e3fb65d77ec2ee76b42c24 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mscms.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Msi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Msi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d35bc5a69e53f9ca03590bf9af3faca0aa83d859 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Msi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mtx.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mtx.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d972f1273939fb1f532f0e5d61ae31618841fffb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Mtx.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..d0415c2ee054471026cf6a2c090bfd200f5e370a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetFW.TLB b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetFW.TLB new file mode 100644 index 0000000000000000000000000000000000000000..b2ccf558a032aad5b9cdf0f92e5584dd5a0ce4d6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetFW.TLB differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetSh.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetSh.Lib new file mode 100644 index 0000000000000000000000000000000000000000..3fc11fc626b39a4b605b9346fb8f971eba46759b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NetSh.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtDsAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtDsAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..b6637e22e0978627295f54ea60d726dc1db2d3b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtDsAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtQuery.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtQuery.Lib new file mode 100644 index 0000000000000000000000000000000000000000..271f4fa1e06a55aa236833bb1d77ba8aefdbe8f3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/NtQuery.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OemLicense.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OemLicense.lib new file mode 100644 index 0000000000000000000000000000000000000000..d70bf309dcc2e6b0daf56cb1cb49de80090646cb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OemLicense.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAcc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAcc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c9a8fe693e6d7977bf57dd35f06cff94074698b3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAcc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAut32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAut32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..f5940b0689d6b52a607f8a4c88baf8d0d9c6bb9d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleAut32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e974a57bd8944876da62bdbd14feafa950712fe8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OleDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OlePro32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OlePro32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c6695453b87651a05da7d0d7247b44fbd7eb2382 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OlePro32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OpenGL32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OpenGL32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..680ddc0b1c63bc0e8d0df547b119cc673cddcc0e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/OpenGL32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Pdh.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Pdh.Lib new file mode 100644 index 0000000000000000000000000000000000000000..05bef3942ba3fe47b3ec5b9b058d5f0e843ea8ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Pdh.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/PeerDist.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/PeerDist.lib new file mode 100644 index 0000000000000000000000000000000000000000..c50d767011c21d0eecec5dabe374704b5235be05 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/PeerDist.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ProjectedFSLib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ProjectedFSLib.lib new file mode 100644 index 0000000000000000000000000000000000000000..b10c14d1eb03be7fe4f4c9a82ee796c7a3c492c1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ProjectedFSLib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASAPI32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASAPI32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a3c12148e981d6c332c956d4d1e240abe5c5b3b2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASAPI32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..984a663b197dae57a1b133a462323ccf506fe3fb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RASDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RTWorkQ.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RTWorkQ.lib new file mode 100644 index 0000000000000000000000000000000000000000..06024333d02874c7b071728b2059bca31918aead Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/RTWorkQ.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rdcentraldb.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rdcentraldb.tlb new file mode 100644 index 0000000000000000000000000000000000000000..33ba20182924c12ce3e24e80dd80de4158bd2c6c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rdcentraldb.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rpcns4.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rpcns4.Lib new file mode 100644 index 0000000000000000000000000000000000000000..63fe6dd270b985422786bd39c9542cd23349c495 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rpcns4.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rtm.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rtm.Lib new file mode 100644 index 0000000000000000000000000000000000000000..544f901b8fcb1cafc67af043fdbcf8199b3d9f67 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Rtm.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SCardDlg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SCardDlg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..32c0421a9fc7e49302f4354404b52cb620fb8251 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SCardDlg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchAPI.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchAPI.tlb new file mode 100644 index 0000000000000000000000000000000000000000..fbb35d991e71d84949b81a8473562ff06af64d4b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchAPI.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchSDK.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchSDK.lib new file mode 100644 index 0000000000000000000000000000000000000000..7e39bb867822ba4db98527fd508590f8e8628542 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SearchSDK.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Secur32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Secur32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..3926bfdbd368cb75e95ac1af8632e02e4a18aba8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Secur32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..de9e4330d074b484bf0f77842a0442c57c616793 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensEvts.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensEvts.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..97e91d1b91a73987fc9041706cb0558d5bc5908b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensEvts.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensorsUtils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensorsUtils.lib new file mode 100644 index 0000000000000000000000000000000000000000..5a0a4d27e69ebbf7c3fc83f8121340a0fca5ef84 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SensorsUtils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sfc.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sfc.Lib new file mode 100644 index 0000000000000000000000000000000000000000..3a71c79daf89674188c97bab16e7dac7f169d237 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sfc.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShFolder.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShFolder.Lib new file mode 100644 index 0000000000000000000000000000000000000000..0d234d2e0315624ae2ea1ed7ba530591918394c8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShFolder.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShLwApi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShLwApi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..84836256226c5db90e39028ff84ce31fedac3f9b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ShLwApi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SnmpAPI.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SnmpAPI.Lib new file mode 100644 index 0000000000000000000000000000000000000000..470d7edba785db47e8a5108e60d9a4034c87ebad Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SnmpAPI.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SpOrder.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SpOrder.Lib new file mode 100644 index 0000000000000000000000000000000000000000..492fe64f711ae515415ce88d5f1a688edbc35034 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/SpOrder.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/StdOle2.Tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/StdOle2.Tlb new file mode 100644 index 0000000000000000000000000000000000000000..3e6b5833870137f06dddbcb52d62c66126e2f2b4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/StdOle2.Tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sti.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sti.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ccfb5b77bcb4f40d4df9c4d17db7cc321cdc7d90 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Sti.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Tapi32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Tapi32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..af5738cc24670b3f4bf40890d5735f483ecff499 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Tapi32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Thunk32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Thunk32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..8b547e481122becc66bca7b9f87fcbba4c3a5d86 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Thunk32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Traffic.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Traffic.Lib new file mode 100644 index 0000000000000000000000000000000000000000..f4ad11e349d9b34bfcaee5d2529f70a025ddc02c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Traffic.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/TranscodeImageUID.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/TranscodeImageUID.lib new file mode 100644 index 0000000000000000000000000000000000000000..5469254e3aa68f3fa5d795fa724e9cef0bb7d56a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/TranscodeImageUID.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UIAutomationCore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UIAutomationCore.lib new file mode 100644 index 0000000000000000000000000000000000000000..6678558e531b42c7de51f9e7b8416880beb7120c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UIAutomationCore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/USP10.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/USP10.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4e14449d9f18556305d7b6b31e2670254aaf9c16 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/USP10.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Urlmon.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Urlmon.Lib new file mode 100644 index 0000000000000000000000000000000000000000..ae38e2f54a884de856040e30bdfa8b356f1c43c4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Urlmon.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UserEnv.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UserEnv.Lib new file mode 100644 index 0000000000000000000000000000000000000000..247116de060c5d4aed03be4143c29f3a3b0a9ec3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/UserEnv.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Uxtheme.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Uxtheme.lib new file mode 100644 index 0000000000000000000000000000000000000000..730126e5336066e7ee1a41b313188e103d8603e6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Uxtheme.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/VdmDbg.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/VdmDbg.Lib new file mode 100644 index 0000000000000000000000000000000000000000..4c167e673fe94c4af7879bc3a6074e36ad900d5f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/VdmDbg.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Version.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Version.Lib new file mode 100644 index 0000000000000000000000000000000000000000..662896a8a6052d6bda2b3683cf42379813514325 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Version.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Vfw32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Vfw32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6a6c0b15261349eb7e074be8e5659be4f9343129 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Vfw32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Virtdisk.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Virtdisk.Lib new file mode 100644 index 0000000000000000000000000000000000000000..1d75d49d8f59c5e3e8550258bfb3bb4ea36e1b6f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Virtdisk.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSnmp32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSnmp32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..cae90b91db6c8110ffeeced58991665fb0cded46 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSnmp32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSock32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSock32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..cfe9b974e52b0d80d0c21dd38d76a34493a2b11a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WSock32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WdsTptMgmt.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WdsTptMgmt.tlb new file mode 100644 index 0000000000000000000000000000000000000000..7852f75c9c0238e16913011433196de09653f025 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WdsTptMgmt.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WebServices.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WebServices.lib new file mode 100644 index 0000000000000000000000000000000000000000..9baa8dba63569eb1daf6404df596b49a13fef72f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WebServices.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wer.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wer.lib new file mode 100644 index 0000000000000000000000000000000000000000..fc62816c56311e0ac01112a23ebae70fa3f24e21 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wer.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinBio.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinBio.lib new file mode 100644 index 0000000000000000000000000000000000000000..f615342a70ae5e8aae57b19b4f7f541d7190b637 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinBio.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinMM.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinMM.Lib new file mode 100644 index 0000000000000000000000000000000000000000..2ceae9d3f4fe85c8f9dce2b771b8d893dcec8299 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinMM.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinSpool.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinSpool.Lib new file mode 100644 index 0000000000000000000000000000000000000000..a3eb6980397dec20d4f2fd23074763ef49c8b805 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinSpool.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinTrust.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinTrust.Lib new file mode 100644 index 0000000000000000000000000000000000000000..b62ebb4bdfe8ec34798d246c18adc5d112a6d2f5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WinTrust.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldap32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldap32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..6c5f9c4aa88dcd5e9102b6e3d77539e8f37f4aab Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldap32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldp.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldp.Lib new file mode 100644 index 0000000000000000000000000000000000000000..e06aa1d8ef50e2c8454c8afaa332de500c0ae53f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wldp.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wow32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wow32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..54245156265cf0ef90a3bf15647118ee0809f177 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Wow32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WtsApi32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WtsApi32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..767dba7c74562ca0ba223354199ee78c961ec3f3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/WtsApi32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Xinput9_1_0.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Xinput9_1_0.lib new file mode 100644 index 0000000000000000000000000000000000000000..faedf9943b04ec39817ccbef2d8c172ec3cd1ca8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/Xinput9_1_0.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/advpack.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/advpack.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c386f84472cd1e544eb976b5a4a7f21e7dfe19e2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/advpack.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ahadmin.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ahadmin.lib new file mode 100644 index 0000000000000000000000000000000000000000..fe3402db0d989a2aac1f46e074faf4d4fa9d587a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ahadmin.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/amsi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/amsi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7c1cdffa926e46d87dec3d0d853f5633a6b89bab Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/amsi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/apidll.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/apidll.lib new file mode 100644 index 0000000000000000000000000000000000000000..b89f97a2c5b4807019978ce3054386549ae50d1a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/apidll.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgmts.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgmts.lib new file mode 100644 index 0000000000000000000000000000000000000000..396d78fdfa27fdb77ccaf89b24f47c69c26ac7c5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgmts.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..8c1800060ea5eaf9b94e77a7cea94dece3a0b756 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appnotify.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appnotify.lib new file mode 100644 index 0000000000000000000000000000000000000000..04798178fcdc98fb37e9cab02ecbd767d0cd12ac Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/appnotify.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/audioeng.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/audioeng.lib new file mode 100644 index 0000000000000000000000000000000000000000..8efd56c3e792e5b9e455ea0002cd1196e69dec96 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/audioeng.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avifil32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avifil32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..23bfa694a003e68ac2d26e29951a8d197fba4031 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avifil32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avrt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avrt.lib new file mode 100644 index 0000000000000000000000000000000000000000..868c8019f2a5cd2c48ddab889bac09c5df32dd22 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/avrt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/basesrv.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/basesrv.lib new file mode 100644 index 0000000000000000000000000000000000000000..7c1a75ad3ef3e6175eb48dedcc8e0277c7e7b8fc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/basesrv.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcp47mrm.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcp47mrm.Lib new file mode 100644 index 0000000000000000000000000000000000000000..7d8d1d2b6148c1220964d8bba6bf3ff851b38285 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcp47mrm.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcrypt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcrypt.lib new file mode 100644 index 0000000000000000000000000000000000000000..6f2ff7a9afbb5ff67249486b4b023b65c4d07f81 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bcrypt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bindlink.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bindlink.lib new file mode 100644 index 0000000000000000000000000000000000000000..5439cbf91d65afec91c89e62bcb90292399df174 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bindlink.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bthprops.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bthprops.lib new file mode 100644 index 0000000000000000000000000000000000000000..8afb523af1ce34268ac2e2b23cf9d5ec911e3adc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/bthprops.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certadm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certadm.lib new file mode 100644 index 0000000000000000000000000000000000000000..21a926e621a3179cd2f68ff7b3716caec857bcbe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certadm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certca.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certca.lib new file mode 100644 index 0000000000000000000000000000000000000000..d6c1ac497d1c022ed523e8045cf49bc9f65e1233 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certca.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..cd24a460e2866424d78a4b472deeafb68c8489e1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/certcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cfgmgr32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cfgmgr32.lib new file mode 100644 index 0000000000000000000000000000000000000000..3b2338c6fbf93d47c17235e5ca0c20f1482bb38b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cfgmgr32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cimfs.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cimfs.lib new file mode 100644 index 0000000000000000000000000000000000000000..68b07d716579333ef4325ef75396e0288ecf740c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cimfs.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cldapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cldapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..5ac232441684ba0194d295fa2a24b8f7e9996526 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cldapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/clfsw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/clfsw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..560af5fd48c9a982530865b53a6d8b19984870a4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/clfsw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/compstui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/compstui.lib new file mode 100644 index 0000000000000000000000000000000000000000..d79376bf7f64d0c10133e1818fe08e7b89c1f522 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/compstui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/corrEngine.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/corrEngine.lib new file mode 100644 index 0000000000000000000000000000000000000000..5d3a0e05ea7c50b8c708faf057dbc0cb01af781b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/corrEngine.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptdll.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptdll.lib new file mode 100644 index 0000000000000000000000000000000000000000..054c42a9a8daf4e59336052ff302de1f9ce3d121 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptdll.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptui.lib new file mode 100644 index 0000000000000000000000000000000000000000..7ecc1a50e86260bccdc70d5154dc7b817683c062 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptxml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptxml.lib new file mode 100644 index 0000000000000000000000000000000000000000..6c7f4f41a0466e7b38b477a9f17fd7870b35ee20 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cryptxml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7ee3a4b5c5050017207ec86a4aee1e55159dfcc6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscdll.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscdll.lib new file mode 100644 index 0000000000000000000000000000000000000000..2cc4ad1d4e0d3ade1307c1d25c2f4b92e0df4b82 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/cscdll.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d2d1.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d2d1.lib new file mode 100644 index 0000000000000000000000000000000000000000..3f3e0375a7476357db0b8b1ff065dd6de94c52a2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d2d1.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10.lib new file mode 100644 index 0000000000000000000000000000000000000000..301ff2ace6786d354a32dc6e2c3951ea1740a80c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10_1.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10_1.lib new file mode 100644 index 0000000000000000000000000000000000000000..0c2d9f02426e062812e27b6e2e83c275d02519ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d10_1.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d11.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d11.lib new file mode 100644 index 0000000000000000000000000000000000000000..8a6275b00fc2efc1423b42c710a9152cb50e67ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d11.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d12.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d12.lib new file mode 100644 index 0000000000000000000000000000000000000000..bf2ce8027ae05839c9b53e5f0d0752648a8b9a0a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d12.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d9.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d9.lib new file mode 100644 index 0000000000000000000000000000000000000000..cafbf83a0908ea1f7a8ab67c56158cc3408e935a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3d9.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcompiler.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcompiler.lib new file mode 100644 index 0000000000000000000000000000000000000000..3ee789ff4dda377f7776fe942e667d0cfdf3b51b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcompiler.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsx.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsx.lib new file mode 100644 index 0000000000000000000000000000000000000000..8ea1337dc6baef933a9320bccd17532b441d00c5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsx.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsxd.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsxd.lib new file mode 100644 index 0000000000000000000000000000000000000000..84db7780cb39f0c67311c3703d225c0a10c1f844 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/d3dcsxd.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/davclnt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/davclnt.lib new file mode 100644 index 0000000000000000000000000000000000000000..fa8c1599d74eee77be5b44333b4737150e100bf4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/davclnt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dciman32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dciman32.lib new file mode 100644 index 0000000000000000000000000000000000000000..1e2ca65c23b12b846cf91666db02f675580d5115 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dciman32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dcomp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dcomp.lib new file mode 100644 index 0000000000000000000000000000000000000000..eca92dfffb306ffe381dcbfdd9602adea2d911f0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dcomp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ddraw.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ddraw.lib new file mode 100644 index 0000000000000000000000000000000000000000..5af2920607e11b714c90472e50976b03a5914a80 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ddraw.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devenum.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devenum.lib new file mode 100644 index 0000000000000000000000000000000000000000..eff4fe2aa8da87da0aeaaeed9dc06906ca2d028f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devenum.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/deviceaccess.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/deviceaccess.lib new file mode 100644 index 0000000000000000000000000000000000000000..bed574d0e6d62436b463583789742ebff4dd4d3b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/deviceaccess.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..e6834883ac65938bd8e11988f0864af0712b4858 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/devmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dflayout.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dflayout.lib new file mode 100644 index 0000000000000000000000000000000000000000..89e3217c5413a5a066958254cea178b876669e31 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dflayout.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dhcpsapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dhcpsapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..457dc1a13997d3edc6652601cf5c4737aa3b145a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dhcpsapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/directml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/directml.lib new file mode 100644 index 0000000000000000000000000000000000000000..412cc0d6a2d6c9de497ef4886ee73f98286bfbce Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/directml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dloadhelper.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dloadhelper.lib new file mode 100644 index 0000000000000000000000000000000000000000..a7915b7ff4d9c6ec0461905f41c6574520874a89 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dloadhelper.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dmprocessxmlfiltered.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dmprocessxmlfiltered.lib new file mode 100644 index 0000000000000000000000000000000000000000..08c123d0f961e564b30137d1960cf3cab7fe77ed Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dmprocessxmlfiltered.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnscrcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnscrcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..716dec220c8006f53408799777fa969f09332cc7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnscrcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnslib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnslib.lib new file mode 100644 index 0000000000000000000000000000000000000000..696fe6dde2e6680e9055df92cd5797cdf05e9da5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnslib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsperf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsperf.lib new file mode 100644 index 0000000000000000000000000000000000000000..c0482c242d033ef9fef62f821b84e301774d57f7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsperf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrpc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrpc.lib new file mode 100644 index 0000000000000000000000000000000000000000..9bc70fa10add38b905a5f25b8f9ef3c00feeb384 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrpc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrslvr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrslvr.lib new file mode 100644 index 0000000000000000000000000000000000000000..e0b6f2510f0ff62ae72eed7e940558fadac8f157 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dnsrslvr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dpx.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dpx.lib new file mode 100644 index 0000000000000000000000000000000000000000..056b30b5c347654798c7e45879de156ab89f3c10 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dpx.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dsound.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dsound.lib new file mode 100644 index 0000000000000000000000000000000000000000..eba4c5f87839fcfceb362a2673e61531695a6ed2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dsound.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dssec.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dssec.lib new file mode 100644 index 0000000000000000000000000000000000000000..70af245186f49356d191175f191a78384152d3af Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dssec.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dststlog.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dststlog.lib new file mode 100644 index 0000000000000000000000000000000000000000..9081fb096aa79c3d9561edda204d8d9eabf7cbc0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dststlog.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwmapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwmapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..42c95a993df86aa8ac45495fe001007bddb138be Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwmapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwrite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwrite.lib new file mode 100644 index 0000000000000000000000000000000000000000..cb66261190d4a2edfeb28e1e8dc6aa9d471c18ea Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dwrite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcompiler.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcompiler.lib new file mode 100644 index 0000000000000000000000000000000000000000..130b306bc3543be680f7010f8933d24b7aa78487 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcompiler.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..19e1be5271f1680e58b0d70cecf5f79760521c9b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxgi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxgi.lib new file mode 100644 index 0000000000000000000000000000000000000000..29d6ff5a3833db8b8079110414480cdb6951fb9a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxgi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtmsft.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtmsft.lib new file mode 100644 index 0000000000000000000000000000000000000000..31a43f888a7d0b507808dd3d3fba3ad8f568f54c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtmsft.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtrans.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtrans.lib new file mode 100644 index 0000000000000000000000000000000000000000..821388e86456c00b533a717ec4a634ec4221d06e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxtrans.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxva2.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxva2.lib new file mode 100644 index 0000000000000000000000000000000000000000..1eb7d91f66fca82487b773805965dcd406499bee Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/dxva2.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappcfg.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappcfg.lib new file mode 100644 index 0000000000000000000000000000000000000000..e51db465d4a50f456bd5d157f328f4c368df62e8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappcfg.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappprxy.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappprxy.lib new file mode 100644 index 0000000000000000000000000000000000000000..e38bed7aae0be01ebe044d528485ea00e94930f5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/eappprxy.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/easregprov.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/easregprov.lib new file mode 100644 index 0000000000000000000000000000000000000000..5aa717c921dd190ac75cc993de46d91ea411b7f4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/easregprov.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/efswrt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/efswrt.lib new file mode 100644 index 0000000000000000000000000000000000000000..4da19c35561287f7ff4c10afb7adb4b725bea666 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/efswrt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/els.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/els.lib new file mode 100644 index 0000000000000000000000000000000000000000..6b7aa31f673e7d1d65c1a92abd086498c13d57fe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/els.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/esent.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/esent.lib new file mode 100644 index 0000000000000000000000000000000000000000..73929dedfdf8a031a3382df3894e00cb87bcba0a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/esent.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/evr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/evr.lib new file mode 100644 index 0000000000000000000000000000000000000000..547ec269fc42c971bd899ade071e99901ebb29d7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/evr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/exdisp.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/exdisp.tlb new file mode 100644 index 0000000000000000000000000000000000000000..a04b39133fb3c4eaf3c036bc6bc34d5ae0e60b99 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/exdisp.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/faxcomex.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/faxcomex.tlb new file mode 100644 index 0000000000000000000000000000000000000000..3f8abe35f40dcee700ebda4033863e7b29bbd7f9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/faxcomex.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/feclient.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/feclient.lib new file mode 100644 index 0000000000000000000000000000000000000000..1fac87f008acf224e23d39029dffe06e772e58bb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/feclient.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fltLib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fltLib.lib new file mode 100644 index 0000000000000000000000000000000000000000..10f559b9c291517c8404e019c37b4445db35964f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fltLib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fontsub.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fontsub.lib new file mode 100644 index 0000000000000000000000000000000000000000..2a1e42732f174b2ce7ce42865eb1df79d83a3d59 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fontsub.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fwpuclnt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fwpuclnt.lib new file mode 100644 index 0000000000000000000000000000000000000000..b73f434d2df5a0182e9eecf404382052d6277bdb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fwpuclnt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fxsutility.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fxsutility.lib new file mode 100644 index 0000000000000000000000000000000000000000..25442718bb957efb4df36923780a18384187c5b7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/fxsutility.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gameinput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gameinput.lib new file mode 100644 index 0000000000000000000000000000000000000000..22f899ae11999cce07bc61a2a4f68124f0398122 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gameinput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/glmf32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/glmf32.lib new file mode 100644 index 0000000000000000000000000000000000000000..0e6edcf23f4d56e01c91b6522bc13f4f2af6eaf4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/glmf32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gpmuuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gpmuuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..e6b3643ceaf82b690fb0ed2dd27581335cc0a98c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/gpmuuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hbaapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hbaapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..9d1c1d7f6c642a323e61d6c11d07133067a2af8c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hbaapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hhsetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hhsetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..f3ce3b216ac3db9e6456c4b7fccc86bd813a8190 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hhsetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hid.lib new file mode 100644 index 0000000000000000000000000000000000000000..709fffdda2eef852863e298129d8f215f4e938ab Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hrtfapo.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hrtfapo.lib new file mode 100644 index 0000000000000000000000000000000000000000..ac1312122e2510f1c2eba9fda1b8011b6d60bb65 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hrtfapo.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/httpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/httpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..a338e741864cb46bd9f7306788dfe65f707c4f61 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/httpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hxhelppaneproxy.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hxhelppaneproxy.tlb new file mode 100644 index 0000000000000000000000000000000000000000..747b014cfe6bf8237938690c9bd880de129f5fb6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/hxhelppaneproxy.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iashlpr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iashlpr.lib new file mode 100644 index 0000000000000000000000000000000000000000..dbf66b513cae13f25cc1bb9d56f91fbc1036e5a4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iashlpr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/icuin.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/icuin.Lib new file mode 100644 index 0000000000000000000000000000000000000000..938e5958179eed15afc1dc6c6cc44b202062cd88 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/icuin.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iesetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iesetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..0e17d55e6f280e26dc05c4a10b5d8c55d7c96c3e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iesetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iextag.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iextag.tlb new file mode 100644 index 0000000000000000000000000000000000000000..9a98970774c335443ec6bbbde190c1699a1681b3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iextag.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2.tlb new file mode 100644 index 0000000000000000000000000000000000000000..dd5ae6f2f36cccdfe9f39aaaeedcd5e5a87b7a31 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2fs.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2fs.tlb new file mode 100644 index 0000000000000000000000000000000000000000..6248f07f6e3fc72a1d19adb3d07fb19ce1756fe2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imapi2fs.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imgutil.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imgutil.Lib new file mode 100644 index 0000000000000000000000000000000000000000..184b0f176c7fbd030c540559ac0de4d9a8328a03 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/imgutil.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/infocardapi.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/infocardapi.Lib new file mode 100644 index 0000000000000000000000000000000000000000..668d27839053b1db0447c60a224b33f01c8556f4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/infocardapi.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inkobjcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inkobjcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..5d534cc3d322316a9361c59eda1b56ed9d0a3b88 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inkobjcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inseng.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inseng.lib new file mode 100644 index 0000000000000000000000000000000000000000..6d27a3e03bf7117f631f9720f53624ed9a7f981f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/inseng.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/int64.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/int64.lib new file mode 100644 index 0000000000000000000000000000000000000000..0988ae60c7964eea8f17ebd590a069bc3611526f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/int64.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iphlpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iphlpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..194a0e3864d6d84b9e4f8aa2b83b8f8a9716cef7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iphlpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iscsidsc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iscsidsc.lib new file mode 100644 index 0000000000000000000000000000000000000000..609f831843c5c69f81a0ea894e48b7006c8cfc41 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/iscsidsc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jetoledb.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jetoledb.lib new file mode 100644 index 0000000000000000000000000000000000000000..b786d92b8d92e2fc7142235103a0b7012c710a67 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jetoledb.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jsrt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jsrt.lib new file mode 100644 index 0000000000000000000000000000000000000000..c938b78f3aeefe7f1c695ff4b27f124cc26d56b5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/jsrt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/kerbcli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/kerbcli.lib new file mode 100644 index 0000000000000000000000000000000000000000..d348c5f0b62e357dade21ca55e4f3151ffa3b22e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/kerbcli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/keycredmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/keycredmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..2315b10fbca522971d4b03c738d8d4ae77c5bf78 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/keycredmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ktmw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ktmw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..9bf940e561f26ddb50fc669b81972ff8638e62a5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ktmw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/lamparray.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/lamparray.lib new file mode 100644 index 0000000000000000000000000000000000000000..52ee05ce338d7dec3151fd3a63a7ae50448325e6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/lamparray.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/magnification.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/magnification.lib new file mode 100644 index 0000000000000000000000000000000000000000..36562985cf01d1c604aca7a83aa64a62e2f1f236 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/magnification.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi.tlb new file mode 100644 index 0000000000000000000000000000000000000000..12f539ee12809a50d25e1b0e910d0a07ddfd258c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..e28d231b032f4cf5fcf47ceac002ac5f973223d6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mbnapi_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mciole32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mciole32.lib new file mode 100644 index 0000000000000000000000000000000000000000..783ef48ec1ccc55cc8699ec257b795eea18e7951 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mciole32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mdmlocalmanagement.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mdmlocalmanagement.lib new file mode 100644 index 0000000000000000000000000000000000000000..99457cbc5e437f4ba4527ce11e9d8cfc5b4ff382 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mdmlocalmanagement.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfplay.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfplay.lib new file mode 100644 index 0000000000000000000000000000000000000000..3b2e068bcb1a53b3d1edf0cb875baf5074394549 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfplay.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfreadwrite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfreadwrite.lib new file mode 100644 index 0000000000000000000000000000000000000000..4be526b1d6f72d4734d126585b439f34eff852d7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfreadwrite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfsensorgroup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfsensorgroup.lib new file mode 100644 index 0000000000000000000000000000000000000000..0a161767ee6929dc08bc2354d10c5066767e82dd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mfsensorgroup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mi.lib new file mode 100644 index 0000000000000000000000000000000000000000..0c98b390bdd584c300a47671371bd5b134712db9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mmdevapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mmdevapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..2b8fd39792a2dc68da2de01d0e93d5b46ad892cd Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mmdevapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mprsnap.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mprsnap.lib new file mode 100644 index 0000000000000000000000000000000000000000..4d50e68ce7d111ed4363e0c965f9e1ab21d46da3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mprsnap.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mqoa.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mqoa.tlb new file mode 100644 index 0000000000000000000000000000000000000000..0e1a62ab6b7cde627f90ed582774ccdf1070f02e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mqoa.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msaatext.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msaatext.lib new file mode 100644 index 0000000000000000000000000000000000000000..a609bbaa762dd625f31ae3ed430f62ad3b4e0360 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msaatext.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdasc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdasc.lib new file mode 100644 index 0000000000000000000000000000000000000000..d42c443b2b5dcdf955aec3e3d6e044cbf800c1f8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdasc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdatsrc.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdatsrc.tlb new file mode 100644 index 0000000000000000000000000000000000000000..a366103f5e6f1dc19153efd5c9a96142111d9843 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdatsrc.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdelta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdelta.lib new file mode 100644 index 0000000000000000000000000000000000000000..b1245de4a27421f1ce91474ecc3a7da9a9e9e839 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdelta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdmo.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdmo.lib new file mode 100644 index 0000000000000000000000000000000000000000..537f6fee50608160c1f9971b82066d9869240eda Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdmo.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdrm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdrm.lib new file mode 100644 index 0000000000000000000000000000000000000000..734d51968edf8b63be7815227b15f747f411a055 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msdrm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msfeeds.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msfeeds.tlb new file mode 100644 index 0000000000000000000000000000000000000000..1ad138d404bb2dbb55857ad7f85fe52e16463e55 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msfeeds.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatcha.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatcha.lib new file mode 100644 index 0000000000000000000000000000000000000000..7b2b33eabe4b8b9fc403950ef339b7ad60b928a0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatcha.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatchc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatchc.lib new file mode 100644 index 0000000000000000000000000000000000000000..71d80f8189ebc53f2b9b54afacdf803a1b1a06a4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mspatchc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msports.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msports.lib new file mode 100644 index 0000000000000000000000000000000000000000..0630641c42be06c54855a282d507bc5db042fae7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msports.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msv1_0.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msv1_0.lib new file mode 100644 index 0000000000000000000000000000000000000000..ff484b393835b743773e5176d9bd337b7e7ef323 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msv1_0.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msvfw32.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msvfw32.Lib new file mode 100644 index 0000000000000000000000000000000000000000..c392324a92396a45467c1b9ea370e12dfd65b642 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msvfw32.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msxml6.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msxml6.lib new file mode 100644 index 0000000000000000000000000000000000000000..8cef995e214ece48e82e13e6c38f021348a86206 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/msxml6.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mtxdm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mtxdm.lib new file mode 100644 index 0000000000000000000000000000000000000000..da842be15571a5892241190fac3a850079f93bdc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/mtxdm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ncrypt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ncrypt.lib new file mode 100644 index 0000000000000000000000000000000000000000..71473749daba524af29b25047e48143b0e6b8f4f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ncrypt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/nddeapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/nddeapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7a9094a3bb628a63f773f69e888018dc96fd6af0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/nddeapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndfapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndfapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..2a3ca78e37fcfd8fb7dbf514d0de5de26a89ace6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndfapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndproxystub.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndproxystub.lib new file mode 100644 index 0000000000000000000000000000000000000000..42a9300415a06b02f6bdccf221cc4fc49d86f208 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ndproxystub.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/newdev.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/newdev.lib new file mode 100644 index 0000000000000000000000000000000000000000..772c652bd19a4dc0799d1a1a8fecbcb98664beb6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/newdev.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ninput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ninput.lib new file mode 100644 index 0000000000000000000000000000000000000000..30b562dc1418de162d37dc2a3567a85dcbea62db Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ninput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/normaliz.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/normaliz.lib new file mode 100644 index 0000000000000000000000000000000000000000..d1919e05e34491c36bcad84572e14698811abb3d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/normaliz.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsa.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsa.lib new file mode 100644 index 0000000000000000000000000000000000000000..55821bab23e61b16cad97ff9183640fec948cc2f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsa.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsatq.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsatq.lib new file mode 100644 index 0000000000000000000000000000000000000000..d125bf0eec9741f835f464bee33f3af66a11df90 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsatq.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsetup.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsetup.lib new file mode 100644 index 0000000000000000000000000000000000000000..bb704b734691ba75a16871f348168e158e1e2ffc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntdsetup.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntfrsapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntfrsapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..f2eb9fb5a424b4ff5727ecf26dd7ebe5f62c2fdc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntfrsapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntlanman.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntlanman.lib new file mode 100644 index 0000000000000000000000000000000000000000..8a3204f98359e8b3bd1f1d0ecfb86b3d65eb5fa1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntlanman.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntmarta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntmarta.lib new file mode 100644 index 0000000000000000000000000000000000000000..697cd483b2cb14f0a93b58956c20d8ae3211060d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntmarta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntvdm.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntvdm.lib new file mode 100644 index 0000000000000000000000000000000000000000..cdd509dae8252e0de76fe4367181bc780c56dc94 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ntvdm.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/objsel.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/objsel.lib new file mode 100644 index 0000000000000000000000000000000000000000..f196d2e949488e6c54cc4245e9067883f65e3890 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/objsel.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbc32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbc32.lib new file mode 100644 index 0000000000000000000000000000000000000000..59a60761f5e5f4f59a653d08109412e96f938148 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbc32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbcbcp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbcbcp.lib new file mode 100644 index 0000000000000000000000000000000000000000..6b96e549228c9a9fce2c8349ec526ad65a6b6515 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/odbcbcp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olecli32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olecli32.lib new file mode 100644 index 0000000000000000000000000000000000000000..e3f066eb585fd6c492522de0f84929fe961d50a9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olecli32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/oledb.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/oledb.lib new file mode 100644 index 0000000000000000000000000000000000000000..de5558dda962fc08103259b50811bc156c02ed7f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/oledb.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olesvr32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olesvr32.lib new file mode 100644 index 0000000000000000000000000000000000000000..ad6718c6280d02784d6988e08df6bfc5465cd90d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/olesvr32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ondemandconnroutehelper.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ondemandconnroutehelper.lib new file mode 100644 index 0000000000000000000000000000000000000000..128293e92bd7ebaa032841a85e193b24a66870d9 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ondemandconnroutehelper.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/osptk.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/osptk.lib new file mode 100644 index 0000000000000000000000000000000000000000..ae47cea87b4464c9f96e9553dcbb1b65a113a9b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/osptk.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/patchwiz.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/patchwiz.lib new file mode 100644 index 0000000000000000000000000000000000000000..e94541fbab3107b6ab18ad49ecd8a92670d04599 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/patchwiz.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/pathcch.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/pathcch.lib new file mode 100644 index 0000000000000000000000000000000000000000..20d56cb0d7f328c189c5eb980a7b99a37dfd0ad3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/pathcch.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/powrprof.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/powrprof.lib new file mode 100644 index 0000000000000000000000000000000000000000..836af130ac05afba6217aaec97262ff82f3e69ca Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/powrprof.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/prntvpt.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/prntvpt.lib new file mode 100644 index 0000000000000000000000000000000000000000..0c2b90484cf529fc14afd4f1d582aed051a1d879 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/prntvpt.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/propsys.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/propsys.lib new file mode 100644 index 0000000000000000000000000000000000000000..25d22ac0c6f9d9b608dd7613e54da777815a1ca1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/propsys.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/psapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/psapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..4d487a15a59b32c94e42d49965002ed70df0f1ae Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/psapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/quartz.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/quartz.lib new file mode 100644 index 0000000000000000000000000000000000000000..d97e44d1804c55aa13bc5fd59e5d7f8bd2ac8307 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/quartz.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/query.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/query.lib new file mode 100644 index 0000000000000000000000000000000000000000..271f4fa1e06a55aa236833bb1d77ba8aefdbe8f3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/query.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/qwave.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/qwave.lib new file mode 100644 index 0000000000000000000000000000000000000000..56e97ef810e49538a892338271ddb2a1fc0e7acc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/qwave.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rasuser.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rasuser.lib new file mode 100644 index 0000000000000000000000000000000000000000..b4c04114b52d90fbdb48e8814c90e6a934fbec5b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rasuser.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rdpencomapi.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rdpencomapi.tlb new file mode 100644 index 0000000000000000000000000000000000000000..b93d2f4f4aedfa0442337bdaca79467166e01184 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rdpencomapi.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rendezvoussession.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rendezvoussession.tlb new file mode 100644 index 0000000000000000000000000000000000000000..0360ac6c65d1169384ccefb7f929b4b6849a45f4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rendezvoussession.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/resutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/resutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..d36c1ce3a2c70509e4fc3668403821b3b643c725 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/resutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rometadata.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rometadata.lib new file mode 100644 index 0000000000000000000000000000000000000000..0b4e3d5def45a051cc98e8acaa6457d6a63fbdfc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rometadata.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcexts.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcexts.lib new file mode 100644 index 0000000000000000000000000000000000000000..9c4d6903e1fa25a4c4ac045b6d7bf6ba84b4653a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcexts.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcproxy.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcproxy.lib new file mode 100644 index 0000000000000000000000000000000000000000..8d25035a037e0185ec210c5eb2aaeb712ca06da4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rpcproxy.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rstrtmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rstrtmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..3168c0f3587fcfa9c1691450b555824f34a80df8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rstrtmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rtutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rtutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..956e9343df057748e9fe21a43100e11c12c6ee04 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/rtutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/runtimeobject.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/runtimeobject.lib new file mode 100644 index 0000000000000000000000000000000000000000..a057ed15b473cf8ba03cadf7fe102b4355f1dd44 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/runtimeobject.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samlib.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samlib.lib new file mode 100644 index 0000000000000000000000000000000000000000..b49ff419276116bc0ec7495daae955c12edbe3f5 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samlib.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samsrv.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samsrv.lib new file mode 100644 index 0000000000000000000000000000000000000000..bfd98f6704637f1d16bd42c989624d5c6527bdc7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/samsrv.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sas.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sas.lib new file mode 100644 index 0000000000000000000000000000000000000000..ac1e1531ed33c6477171dad1bc1998d4801acdfa Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sas.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scecli.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scecli.lib new file mode 100644 index 0000000000000000000000000000000000000000..943161397bfd28e18fdce5f17d35039afe016da1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scecli.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scesrv.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scesrv.lib new file mode 100644 index 0000000000000000000000000000000000000000..9d057d90485364211f61a0901487fc513b04f15a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/scesrv.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/schannel.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/schannel.lib new file mode 100644 index 0000000000000000000000000000000000000000..710e322e0b0584224b6709e3417669fc78d6f579 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/schannel.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/security.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/security.lib new file mode 100644 index 0000000000000000000000000000000000000000..8174304320627c4d6179f20f7b0c7c18112b00c8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/security.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sens.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sens.lib new file mode 100644 index 0000000000000000000000000000000000000000..a8c5af256e299d4d84eb27521642ac89499e5282 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/sens.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..b695d84b0aa5c33a965c400bd42bcd916522206b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shdocvw.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shdocvw.lib new file mode 100644 index 0000000000000000000000000000000000000000..d5c8d17affff1d975cc41f194e0046c42be99090 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/shdocvw.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/simpdata.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/simpdata.tlb new file mode 100644 index 0000000000000000000000000000000000000000..ee8ad27acadaad340c54bf6073854578df8f40d2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/simpdata.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slc.lib new file mode 100644 index 0000000000000000000000000000000000000000..3a1c15e739f1a53deddd896111826c6c506b6e82 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slcext.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slcext.lib new file mode 100644 index 0000000000000000000000000000000000000000..7ce960af764085489ba15d3e81761d855e07866d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slcext.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slwga.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slwga.lib new file mode 100644 index 0000000000000000000000000000000000000000..528b5cb520269c57b4e63079b3a252aa7211fbad Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/slwga.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/spoolss.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/spoolss.lib new file mode 100644 index 0000000000000000000000000000000000000000..87de72b670aac048ee8d605b4c76cc7a5993dffb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/spoolss.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/srpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/srpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..24ea222475331d81cbdcdcab9df9e394265c5264 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/srpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ssdpapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ssdpapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..a2ff3a2b205cdf9cb6bac05c78bef6cb2a6bd56c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ssdpapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/strsafe.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/strsafe.lib new file mode 100644 index 0000000000000000000000000000000000000000..940aa737a179678f9034d77b114b3edbf7aca2b7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/strsafe.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/structuredquery.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/structuredquery.lib new file mode 100644 index 0000000000000000000000000000000000000000..ac46b381978c57a99561b67eae60513b6e477ef6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/structuredquery.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/swdevice.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/swdevice.lib new file mode 100644 index 0000000000000000000000000000000000000000..9b3351ccc28e1867c84ceb35ec8f4c7095268d3a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/swdevice.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/synchronization.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/synchronization.lib new file mode 100644 index 0000000000000000000000000000000000000000..5c900bf3464821ee2ea4743bf8c68e52b4258d85 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/synchronization.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/t2embed.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/t2embed.lib new file mode 100644 index 0000000000000000000000000000000000000000..c2fde83dfa8fde120c90a85010429cf1da54c5ad Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/t2embed.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/taskschd.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/taskschd.lib new file mode 100644 index 0000000000000000000000000000000000000000..8a3a861209e957f5ace0ce78a178704074bbdd4b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/taskschd.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tbs.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tbs.lib new file mode 100644 index 0000000000000000000000000000000000000000..c5bd26c78fdb41436c958aba98e55fcce99e0e75 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tbs.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tdh.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tdh.lib new file mode 100644 index 0000000000000000000000000000000000000000..f4cd4816e535c2e9fbd8dc76a8c9127f4a8cc21b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tdh.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tokenbinding.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tokenbinding.lib new file mode 100644 index 0000000000000000000000000000000000000000..162aab1b7e5f6a94768501f5257a6237ba183385 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tokenbinding.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsec.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsec.lib new file mode 100644 index 0000000000000000000000000000000000000000..003d86d4cd635888eb34605b4afdfb21f50bf62a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsec.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsuserex.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsuserex.tlb new file mode 100644 index 0000000000000000000000000000000000000000..01f54face20bccdb4be5f888faf44584867b4c8c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/tsuserex.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twain_32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twain_32.lib new file mode 100644 index 0000000000000000000000000000000000000000..4ebc657044a4643b81223be558551443b19b8286 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twain_32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twinapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twinapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..71b95dcdaffa7b37787218d8705fa8f01de21ad2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/twinapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/txfw32.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/txfw32.lib new file mode 100644 index 0000000000000000000000000000000000000000..831497a454d8a030d23370e352216fc2d9a7511e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/txfw32.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ualapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ualapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..9beedb3a6557fc160b5114e2db0fa0583dc0cd00 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/ualapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/umpdddi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/umpdddi.lib new file mode 100644 index 0000000000000000000000000000000000000000..331b7bd4973df1aacc729bd0e95991e215cb3add Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/umpdddi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vds_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vds_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..1183129cf14d7298bfcc38e22d490c0c2ba22195 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vds_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/volatileaccessu.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/volatileaccessu.lib new file mode 100644 index 0000000000000000000000000000000000000000..18ef6d7f9c0ac18b491322a6efb32fb504144b11 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/volatileaccessu.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vscmgr.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vscmgr.lib new file mode 100644 index 0000000000000000000000000000000000000000..800430750001464a3cea8ba202751b24b19d7f1b Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vscmgr.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vss_uuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vss_uuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..49921059c39bcecf1b63469b860c444f325c5765 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vss_uuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vssapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vssapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..3111ff2e937fe8ea567021e8c42a853c1f719241 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vssapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vstorinterface.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vstorinterface.lib new file mode 100644 index 0000000000000000000000000000000000000000..b42b511a24de623cce1e8335304c2ccfd7fd33ac Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/vstorinterface.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wbemuuid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wbemuuid.lib new file mode 100644 index 0000000000000000000000000000000000000000..ad8c861868d610fa7c2ab43aab88b42d57823afc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wbemuuid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..2b184c7020743e6e4911d128edc129bd0de06aaf Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmguid.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmguid.lib new file mode 100644 index 0000000000000000000000000000000000000000..873047d5d02927b955bd20c5d183ebcb34b3c8bb Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wcmguid.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsClientAPI.LIB b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsClientAPI.LIB new file mode 100644 index 0000000000000000000000000000000000000000..33405abf41e39477d08623bc81ebe32b19ca46be Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsClientAPI.LIB differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsbp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsbp.lib new file mode 100644 index 0000000000000000000000000000000000000000..2ae37810b8e1add9c65948f90fc351dfd02eec4f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsbp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsmc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsmc.lib new file mode 100644 index 0000000000000000000000000000000000000000..01c5ec43be3aab7c1ea1ae24bbe8ffebfe66d2b1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdsmc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdspxe.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdspxe.lib new file mode 100644 index 0000000000000000000000000000000000000000..03ad511e838b9cf65ee00a153005a458ce75ef99 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdspxe.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdstptc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdstptc.lib new file mode 100644 index 0000000000000000000000000000000000000000..76e3ed65cc7895d5ad9845b39ec851e08dd33c80 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wdstptc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/webauthn.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/webauthn.lib new file mode 100644 index 0000000000000000000000000000000000000000..99ad4dcee34feeb778fc66d9ef32db264927861c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/webauthn.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/websocket.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/websocket.lib new file mode 100644 index 0000000000000000000000000000000000000000..1bd5686b54bd997d831d676252d060be73f7580e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/websocket.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wecapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wecapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..0f373fb6621d608b0d35fa1c4f1671d476990599 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wecapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wevtapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wevtapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..3b7dfa42c01c5cb9e4bfe87a5cb3b4b5866bdf30 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wevtapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wiaservc.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wiaservc.lib new file mode 100644 index 0000000000000000000000000000000000000000..e574d0e29defcad77a6e1b64846c5e5e4c4480e4 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wiaservc.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ai.machinelearning.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ai.machinelearning.lib new file mode 100644 index 0000000000000000000000000000000000000000..df86e1ffc420a8f2106bd36597e20183846d160a Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ai.machinelearning.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.data.pdf.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.data.pdf.lib new file mode 100644 index 0000000000000000000000000000000000000000..2362ebf6a09d8398d7f5b15d018f199c6df31b26 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.data.pdf.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.media.mediacontrol.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.media.mediacontrol.lib new file mode 100644 index 0000000000000000000000000000000000000000..21efdae67f415dc951fd157484d2c9a642dab2a3 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.media.mediacontrol.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.networking.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.networking.lib new file mode 100644 index 0000000000000000000000000000000000000000..b6bb2afd4847ebc6dfd41c41b4dfa5cf4b2c1b46 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.networking.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ui.lib new file mode 100644 index 0000000000000000000000000000000000000000..5f3cd61192bd207f542c6dc0ca9e04b78f7176e7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/windows.ui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winfax.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winfax.lib new file mode 100644 index 0000000000000000000000000000000000000000..757f8f9f6ac6cfa8045d3bf09b8af09281c188a7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winfax.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winhttp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winhttp.lib new file mode 100644 index 0000000000000000000000000000000000000000..8cb76ba152b09ca15a9848b59c509c99a55029a1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winhttp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wininet.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wininet.Lib new file mode 100644 index 0000000000000000000000000000000000000000..217d87b316a2d293031eef3b6250ac88c6c64066 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wininet.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winml.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winml.lib new file mode 100644 index 0000000000000000000000000000000000000000..1dbea957a7e528f04b17236b18ec00183b4ebcad Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winml.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsatapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsatapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..7005ab65a73472e3f5084f2c100e061e29690418 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsatapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winscard.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winscard.lib new file mode 100644 index 0000000000000000000000000000000000000000..ac4542c265cb12b4d2d01e27b2cbed1b48890042 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winscard.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsqlite3.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsqlite3.lib new file mode 100644 index 0000000000000000000000000000000000000000..e8be96a95ca79f2cfb3cdea97af975e4e0e86df8 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsqlite3.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsta.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsta.lib new file mode 100644 index 0000000000000000000000000000000000000000..a9fdb5465be7b3aae9f869b9241a518b7a78c5de Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winsta.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winusb.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winusb.lib new file mode 100644 index 0000000000000000000000000000000000000000..4fd2eb0413b6f78ab5764edda207ba1809f1f5e2 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/winusb.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wkspbkax.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wkspbkax.tlb new file mode 100644 index 0000000000000000000000000000000000000000..787fff242ea8aaa375880b7cbfb2349af8eac498 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wkspbkax.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..0d5e246a25c4749da854288b912a5f4560aa45e1 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanui.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanui.lib new file mode 100644 index 0000000000000000000000000000000000000000..d427f39334c9399532762cbe255c1b23438eb190 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wlanui.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmip.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmip.lib new file mode 100644 index 0000000000000000000000000000000000000000..87eebc1b8ef6dfe27ccf0cd485cf11e50ff6ceaa Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmip.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmiutils.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmiutils.lib new file mode 100644 index 0000000000000000000000000000000000000000..eca229a572eb515589a64bb9837b4ee50b2be5e6 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmiutils.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmvcore.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmvcore.lib new file mode 100644 index 0000000000000000000000000000000000000000..24b8e90a2c66c4e05528cb5a8e66772ca3ca67e7 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wmvcore.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wofutil.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wofutil.lib new file mode 100644 index 0000000000000000000000000000000000000000..e6d5935b73c0e487d6d2b474e73dfccd92af593e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wofutil.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspace.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspace.tlb new file mode 100644 index 0000000000000000000000000000000000000000..5b92a3fe6bffddc4c9b929953ca25b412cb89854 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspace.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspaceruntime.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspaceruntime.tlb new file mode 100644 index 0000000000000000000000000000000000000000..d9caa96cdef80d4a6a7b6957336c3edcdf3423d0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/workspaceruntime.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbapp_uuid.Lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbapp_uuid.Lib new file mode 100644 index 0000000000000000000000000000000000000000..67d5a0b0993399ec65ccb063d24a1a72da6137fe Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbapp_uuid.Lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbonline.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbonline.lib new file mode 100644 index 0000000000000000000000000000000000000000..2da0c2db8e1f7bb6e253c9f866cbdba9043568a0 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsbonline.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wscapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wscapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..4a94b53b06040efa26de2d318edab4a1cb98c10f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wscapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsclient.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsclient.lib new file mode 100644 index 0000000000000000000000000000000000000000..fc6164a2a5f847ec495a67452f533ee920af8b57 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsclient.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsdapi.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsdapi.lib new file mode 100644 index 0000000000000000000000000000000000000000..ca728e71cf2c70791a3c5496891590d031bd3d37 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsdapi.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsmandisp.tlb b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsmandisp.tlb new file mode 100644 index 0000000000000000000000000000000000000000..d3b8f1c05728923dc533981d23fc5eb2453d629d Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/wsmandisp.tlb differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2.lib new file mode 100644 index 0000000000000000000000000000000000000000..345a3485aa1c018d668e9670f124071ed06ea8fc Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2_8.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2_8.lib new file mode 100644 index 0000000000000000000000000000000000000000..56d20c879693ef3ced1d6890f8191600027e4263 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xaudio2_8.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinput.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinput.lib new file mode 100644 index 0000000000000000000000000000000000000000..d0bed9bc214e6d5b92a0987ea5c34edd8867ff2c Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinput.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinputuap.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinputuap.lib new file mode 100644 index 0000000000000000000000000000000000000000..f53637ad40b55b9ea5b0c69c3fed60bdee4ba36f Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xinputuap.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xmllite.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xmllite.lib new file mode 100644 index 0000000000000000000000000000000000000000..9e0c37c3e468b2d29d4c475c3a59f78608cc3731 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xmllite.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xolehlp.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xolehlp.lib new file mode 100644 index 0000000000000000000000000000000000000000..9d882d365ca09e70798a4aef69c8d4605412ef34 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xolehlp.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsdocumenttargetprint.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsdocumenttargetprint.lib new file mode 100644 index 0000000000000000000000000000000000000000..9712de3102aa4745664035fa1ecfd3385559b473 Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsdocumenttargetprint.lib differ diff --git a/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsprint.lib b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsprint.lib new file mode 100644 index 0000000000000000000000000000000000000000..a00467d6e097d142b63574be4a83ed4955b6a66e Binary files /dev/null and b/msvc/Windows Kits/10/Lib/10.0.26100.0/um/x86/xpsprint.lib differ