#include "usbhub3.h"
#include "hubid.h"
#include <acpiioct.h>
#include <debug.h>

Include dependency graph for portacpi.cpp:

Macros
#define	NDEBUG

#define	HUB_ACPI_RESULT_BYTES (sizeof(ACPI_EVAL_OUTPUT_BUFFER) + 1024)

#define	HUB_ACPI_METHOD_SUFFIX 6U

#define	HUB_UPC_TYPE_C_NO_SWITCH 0x0A

#define	HUB_UPC_ELEMENTS 4

#define	HUB_PLD_BYTES 16

#define	HUB_DSM_REVISION 0

#define	HUB_DSM_INTERCONNECT_TYPE 2

#define	HUB_DSM_DISABLE_U2 5

#define	HUB_DSD_ENTRY_MIN_BYTES 16

#define	HUB_DSM_INPUT_BYTES

Functions
	C_ASSERT (sizeof(ACPI_EVAL_INPUT_BUFFER_COMPLEX_EX)==276)

	C_ASSERT (HUB_DSM_INPUT_BYTES==312)

	C_ASSERT (sizeof(ACPI_ENUM_CHILDREN_INPUT_BUFFER)==16)

	C_ASSERT (sizeof(ACPI_ENUM_CHILDREN_OUTPUT_BUFFER)==20)

static NTSTATUS NTAPI	HubAcpiAllocate (_In_ HubFdo Hub, _In_ size_t Bytes, _Out_ WDFMEMORY Memory, _Outptr_result_bytebuffer_(Bytes) PVOID *Buffer)

static VOID NTAPI	HubAcpiFree (_In_opt_ WDFMEMORY Memory)

	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI HubAcpiSend(_In_ HubFdo *Hub
	Sends a synchronous IOCTL to the specified device object.

return	WdfIoTargetSendInternalIoctlSynchronously (WdfDeviceGetIoTarget(Hub->m_Device), NULL, IoControlCode, &InputDescriptor, &OutputDescriptor, NULL, Information)

	if (!NT_SUCCESS(Status) &&!(CheckResultOnNoDevice &&Status==STATUS_NO_SUCH_DEVICE))

	if (Result->Signature !=ACPI_EVAL_OUTPUT_BUFFER_SIGNATURE\|\|Result->Count==0)

static NTSTATUS NTAPI	HubAcpiPrepareInput (_Out_ PACPI_EVAL_INPUT_BUFFER_COMPLEX_EX Input, _In_ PCANSI_STRING Device, _In_reads_(4) PCSTR Method, _In_ ULONG ArgumentCount)

_In_ PCANSI_STRING	_In_reads_ (4) PCSTR Method

	if (!NT_SUCCESS(Status)) return Status

	if (NT_SUCCESS(Status))

	HubAcpiFree (InputMemory)

	RtlCopyMemory (Argument->Data, &HubUsbDsmGuid, sizeof(HubUsbDsmGuid))

	RtlZeroMemory (WdfMemoryGetBuffer(Output, NULL), HUB_ACPI_RESULT_BYTES)

	if (Status==STATUS_NOT_SUPPORTED) return Status

	if (!NT_SUCCESS(Status) &&Status !=STATUS_BUFFER_OVERFLOW)

	if (OutputBytes==sizeof(ACPI_ENUM_CHILDREN_OUTPUT_BUFFER))

	if (Children->Signature !=ACPI_ENUM_CHILDREN_OUTPUT_BUFFER_SIGNATURE\|\|Children->NumberOfChildren==0\|\|Information !=OutputBytes)

static BOOLEAN NTAPI	HubAcpiResultInteger (_In_ WDFMEMORY Output, _Out_ PULONG Value)

	if (!NT_SUCCESS(HubAcpiEvaluateDsm(Hub, Device, HUB_DSM_INTERCONNECT_TYPE, Output))) return

	if (!HubAcpiResultInteger(Output, &Value))

Variables
static const GUID	HubUsbDsmGuid

static const GUID	HubDsdPropertiesGuid

static const CHAR	HubUsb4HostProperty [] = "usb4-host-interface"

_In_ ULONG	IoControlCode

_In_ ULONG _In_ WDFMEMORY	Input

_In_ ULONG _In_ WDFMEMORY _In_ WDFMEMORY	Output

_In_ ULONG _In_ WDFMEMORY _In_ WDFMEMORY _Out_ PULONG_PTR	Information

WDF_MEMORY_DESCRIPTOR	OutputDescriptor

WDF_MEMORY_DESCRIPTOR_INIT_HANDLE &	InputDescriptor

_In_ WDFMEMORY _In_ WDFMEMORY _In_ BOOLEAN	CheckResultOnNoDevice

PACPI_EVAL_INPUT_BUFFER_COMPLEX_EX	Method = (PACPI_EVAL_INPUT_BUFFER_COMPLEX_EX)WdfMemoryGetBuffer(Input, NULL)

NTSTATUS	Status = HubAcpiSend(Hub, IOCTL_ACPI_EVAL_METHOD_EX, Input, Output, &Information)

_In_ PCANSI_STRING	Device

WDFMEMORY	InputMemory

_In_ PCANSI_STRING _In_ ULONG	Function

PACPI_METHOD_ARGUMENT	Argument = Input->Argument

Argument	Type = ACPI_METHOD_ARGUMENT_BUFFER

Argument	DataLength = sizeof(HubUsbDsmGuid)

_In_ WDFMEMORY _In_ size_t	OutputBytes

Input	Signature = ACPI_ENUM_CHILDREN_INPUT_BUFFER_SIGNATURE

Input	Flags = ENUM_CHILDREN_IMMEDIATE_ONLY

Input	NameLength = 0

return	STATUS_SUCCESS

_In_ HubPort *	Port

Port	m_InterconnectType = (USHORT)Value

Macro Definition Documentation

◆ HUB_ACPI_METHOD_SUFFIX

#define HUB_ACPI_METHOD_SUFFIX 6U

Definition at line 20 of file portacpi.cpp.

◆ HUB_ACPI_RESULT_BYTES

#define HUB_ACPI_RESULT_BYTES (sizeof(ACPI_EVAL_OUTPUT_BUFFER) + 1024)

Definition at line 17 of file portacpi.cpp.

◆ HUB_DSD_ENTRY_MIN_BYTES

#define HUB_DSD_ENTRY_MIN_BYTES 16

Definition at line 49 of file portacpi.cpp.

◆ HUB_DSM_DISABLE_U2

#define HUB_DSM_DISABLE_U2 5

Definition at line 39 of file portacpi.cpp.

◆ HUB_DSM_INPUT_BYTES

#define HUB_DSM_INPUT_BYTES

Value:

                                     (FIELD_OFFSET(ACPI_EVAL_INPUT_BUFFER_COMPLEX_EX, Argument) + \
                                     ACPI_METHOD_ARGUMENT_LENGTH(sizeof(GUID)) +                \
                                     2 * ACPI_METHOD_ARGUMENT_LENGTH(sizeof(ULONG)) +           \
                                     ACPI_METHOD_ARGUMENT_LENGTH(0))

Definition at line 52 of file portacpi.cpp.

◆ HUB_DSM_INTERCONNECT_TYPE

#define HUB_DSM_INTERCONNECT_TYPE 2

Definition at line 36 of file portacpi.cpp.

◆ HUB_DSM_REVISION

#define HUB_DSM_REVISION 0

Definition at line 35 of file portacpi.cpp.

◆ HUB_PLD_BYTES

#define HUB_PLD_BYTES 16

Definition at line 29 of file portacpi.cpp.

◆ HUB_UPC_ELEMENTS

#define HUB_UPC_ELEMENTS 4

Definition at line 26 of file portacpi.cpp.

◆ HUB_UPC_TYPE_C_NO_SWITCH

#define HUB_UPC_TYPE_C_NO_SWITCH 0x0A

Definition at line 23 of file portacpi.cpp.

◆ NDEBUG

#define NDEBUG

Definition at line 13 of file portacpi.cpp.

Function Documentation

◆ _In_reads_()

_In_ PCANSI_STRING _In_reads_ ( 4 )

◆ _IRQL_requires_()

_IRQL_requires_ ( PASSIVE_LEVEL )

Sends a synchronous IOCTL to the specified device object.

Evaluates a method without arguments into Output.

Definition at line 2121 of file class.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Entering function.\n",
                DeviceObject));
 
    //
    // Send down Inquiry for VPD_THIRD_PARTY_COPY_PAGE and cache away the device parameters
    // from WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR.
    //
    status = ClasspGetBlockDeviceTokenLimitsInfo(DeviceObject);
 
    if (NT_SUCCESS(status)) {
 
        ULONG maxListIdentifier = MaxTokenOperationListIdentifier;
 
        //
        // Query the maximum list identifier to use for TokenOperation commands.
        //
        if (NT_SUCCESS(ClasspGetMaximumTokenListIdentifier(DeviceObject, REG_DISK_CLASS_CONTROL, &maxListIdentifier))) {
            if (maxListIdentifier >= MIN_TOKEN_LIST_IDENTIFIERS) {
 
                NT_ASSERT(maxListIdentifier <= MAX_TOKEN_LIST_IDENTIFIERS);
                MaxTokenOperationListIdentifier = maxListIdentifier;
            }
        }
 
    }
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Exiting function with status %x.\n",
                DeviceObject,
                status));
 
    return status;
}

◆ C_ASSERT() [1/4]

C_ASSERT ( HUB_DSM_INPUT_BYTES = =312 )

◆ C_ASSERT() [2/4]

C_ASSERT ( sizeof(ACPI_ENUM_CHILDREN_INPUT_BUFFER) = =16 )

◆ C_ASSERT() [3/4]

C_ASSERT ( sizeof(ACPI_ENUM_CHILDREN_OUTPUT_BUFFER) = =20 )

◆ C_ASSERT() [4/4]

C_ASSERT ( sizeof(ACPI_EVAL_INPUT_BUFFER_COMPLEX_EX) = =276 )

◆ HubAcpiAllocate()

static NTSTATUS NTAPI HubAcpiAllocate	(	_In_ HubFdo *	Hub,
		_In_ size_t	Bytes,
		_Out_ WDFMEMORY *	Memory,
		_Outptr_result_bytebuffer_(Bytes) PVOID *	Buffer
	)

static

Zeroed nonpaged WDF memory owned by the hub FDO.

Definition at line 66 of file portacpi.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = Hub->m_Device;
 
    Status = WdfMemoryCreate(&Attributes, NonPagedPool, HUB_TAG_HUB, Bytes, Memory, Buffer);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p ACPI buffer of %lu bytes failed 0x%lx\n", Hub, (ULONG)Bytes, Status);
        *Memory = NULL;
        *Buffer = NULL;
        return Status;
    }
 
    RtlZeroMemory(*Buffer, Bytes);
    return STATUS_SUCCESS;
}

◆ HubAcpiFree() [1/2]

static VOID NTAPI HubAcpiFree ( _In_opt_ WDFMEMORY Memory )

static

Definition at line 94 of file portacpi.cpp.

{
    if (Memory != NULL)
        WdfObjectDelete(Memory);
}

Referenced by if().

◆ HubAcpiFree() [2/2]

HubAcpiFree ( InputMemory )

◆ HubAcpiPrepareInput()

static NTSTATUS NTAPI HubAcpiPrepareInput	(	_Out_ PACPI_EVAL_INPUT_BUFFER_COMPLEX_EX	Input,
		_In_ PCANSI_STRING	Device,
		_In_reads_(4) PCSTR	Method,
		_In_ ULONG	ArgumentCount
	)

static

Fills the input header: "<Device>.<Method>" and the argument count.

Definition at line 168 of file portacpi.cpp.

{
    if (Device->Length + HUB_ACPI_METHOD_SUFFIX > sizeof(Input->MethodName))
    {
        DPRINT1("ACPI device path %Z is too long for a method name\n", Device);
        return STATUS_INVALID_PARAMETER;
    }
 
    Input->Signature = ACPI_EVAL_INPUT_BUFFER_COMPLEX_SIGNATURE_EX;
    Input->Size = sizeof(*Input);
    Input->ArgumentCount = ArgumentCount;
 
    RtlCopyMemory(Input->MethodName, Device->Buffer, Device->Length);
    Input->MethodName[Device->Length] = '.';
    RtlCopyMemory(&Input->MethodName[Device->Length + 1], Method, 4);
    Input->MethodName[Device->Length + 5] = ANSI_NULL;
    return STATUS_SUCCESS;
}

◆ HubAcpiResultInteger()

static BOOLEAN NTAPI HubAcpiResultInteger	(	_In_ WDFMEMORY	Output,
		_Out_ PULONG	Value
	)

static

First result argument when it is an integer.

Definition at line 348 of file portacpi.cpp.

{
    PACPI_EVAL_OUTPUT_BUFFER Result = (PACPI_EVAL_OUTPUT_BUFFER)WdfMemoryGetBuffer(Output, NULL);
 
    *Value = 0;
    if (Result->Count == 0 || Result->Argument[0].Type != ACPI_METHOD_ARGUMENT_INTEGER)
        return FALSE;
 
    *Value = Result->Argument[0].Argument;
    return TRUE;
}

◆ if() [1/10]

if ( ! HubAcpiResultIntegerOutput, &Value )

Definition at line 378 of file portacpi.cpp.

    {
        DPRINT1("Port %u: _DSM interconnect type is not an integer (platform compliance)\n", Port->Number());
        return;
    }

◆ if() [2/10]

if ( ! NT_SUCCESSHubAcpiEvaluateDsm(Hub, Device, HUB_DSM_INTERCONNECT_TYPE, Output) )

◆ if() [3/10]

if ( ! NT_SUCCESSStatus) &&!(CheckResultOnNoDevice &&Status==STATUS_NO_SUCH_DEVICE )

Definition at line 148 of file portacpi.cpp.

    {
        if (Status != STATUS_OBJECT_NAME_NOT_FOUND)
            DPRINT1("Hub %p ACPI %s failed 0x%lx\n", Hub, Method->MethodName, Status);
        return Status;
    }

◆ if() [4/10]

if ( !NT_SUCCESS(Status) &&Status ! = STATUS_BUFFER_OVERFLOW )

Definition at line 306 of file portacpi.cpp.

    {
        DPRINT1("Hub %p ACPI child enumeration failed 0x%lx\n", Hub, Status);
        return Status;
    }

◆ if() [5/10]

if ( ! NT_SUCCESSStatus )

Definition at line 242 of file portacpi.cpp.

    {
        HubAcpiFree(InputMemory);
        return Status;
    }

◆ if() [6/10]

if ( Children->Signature ! = ACPI_ENUM_CHILDREN_OUTPUT_BUFFER_SIGNATURE || Children->NumberOfChildren == 0 || Information != OutputBytes )

Definition at line 331 of file portacpi.cpp.

    {
        DPRINT1("Hub %p ACPI child enumeration returned no children\n", Hub);
        return STATUS_ACPI_INVALID_DATA;
    }

◆ if() [7/10]

if ( NT_SUCCESS(Status) )

Definition at line 211 of file portacpi.cpp.

    {
        RtlZeroMemory(WdfMemoryGetBuffer(Output, NULL), HUB_ACPI_RESULT_BYTES);
        Status = HubAcpiEvaluate(Hub, InputMemory, Output, FALSE);
    }

◆ if() [8/10]

if ( OutputBytes = = sizeof(ACPI_ENUM_CHILDREN_OUTPUT_BUFFER) )

Definition at line 312 of file portacpi.cpp.

    {
        if (Status != STATUS_BUFFER_OVERFLOW ||
            Children->Signature != ACPI_ENUM_CHILDREN_OUTPUT_BUFFER_SIGNATURE ||
            Children->NumberOfChildren < sizeof(ACPI_ENUM_CHILDREN_OUTPUT_BUFFER))
        {
            DPRINT1("Hub %p ACPI child enumeration size query is invalid 0x%lx\n", Hub, Status);
            return STATUS_ACPI_INVALID_DATA;
        }
 
        return STATUS_BUFFER_OVERFLOW;
    }

◆ if() [9/10]

if ( Result->Signature ! = ACPI_EVAL_OUTPUT_BUFFER_SIGNATURE || Result->Count == 0 )

Definition at line 155 of file portacpi.cpp.

    {
        DPRINT1("Hub %p ACPI %s returned no usable result\n", Hub, Method->MethodName);
        return STATUS_ACPI_INVALID_DATA;
    }

◆ if() [10/10]

if ( Status = =STATUS_NOT_SUPPORTED )

Definition at line 174 of file userreq.cpp.

    {
        User.SetStatus(UsbUserBufferTooSmall);
    }

◆ RtlCopyMemory()

RtlCopyMemory	(	Argument->	Data,
		&	HubUsbDsmGuid,
		sizeof(HubUsbDsmGuid)
	)

◆ RtlZeroMemory()

RtlZeroMemory	(	WdfMemoryGetBuffer(Output, NULL)	,
		HUB_ACPI_RESULT_BYTES
	)

◆ WdfIoTargetSendInternalIoctlSynchronously()

return WdfIoTargetSendInternalIoctlSynchronously	(	WdfDeviceGetIoTarget(Hub->m_Device)	,
		NULL	,
		IoControlCode	,
		&	InputDescriptor,
		&	OutputDescriptor,
		NULL	,
		Information
	)