/*++

Copyright (c) Microsoft Corporation. All rights reserved.

Module Name:

    UcmUcsiPpm.h

Abstract:

    UCM-UCSI PPM type declarations.

Environment:

    Kernel-mode.

--*/

//
// NOTE: This header is generated by stubwork.  Please make any 
//       modifications to the corresponding template files 
//       (.x or .y) and use stubwork to regenerate the header
//

#ifndef _UCMUCSIPPM_H_
#define _UCMUCSIPPM_H_

#ifndef WDF_EXTERN_C
  #ifdef __cplusplus
    #define WDF_EXTERN_C       extern "C"
    #define WDF_EXTERN_C_START extern "C" {
    #define WDF_EXTERN_C_END   }
  #else
    #define WDF_EXTERN_C
    #define WDF_EXTERN_C_START
    #define WDF_EXTERN_C_END
  #endif
#endif

WDF_EXTERN_C_START



DECLARE_HANDLE(UCMUCSIPPM);
DECLARE_HANDLE(UCMUCSI_CONNECTOR_COLLECTION);



typedef struct _UCMUCSI_CONNECTOR_INFO {
    ULONG Size;
    ULONGLONG ConnectorId;
} UCMUCSI_CONNECTOR_INFO, *PUCMUCSI_CONNECTOR_INFO;

VOID
FORCEINLINE
UCMUCSI_CONNECTOR_INFO_INIT (
    _Out_ PUCMUCSI_CONNECTOR_INFO ConnectorInfo
    )
{
    RtlZeroMemory(ConnectorInfo, sizeof(*ConnectorInfo));
    ConnectorInfo->Size = sizeof(*ConnectorInfo);
}

typedef struct _UCMUCSI_PPM_CONFIG
{
    ULONG Size;
    BOOLEAN UsbDeviceControllerEnabled;
    UCMUCSI_CONNECTOR_COLLECTION ConnectorCollectionHandle;
} UCMUCSI_PPM_CONFIG, *PUCMUCSI_PPM_CONFIG;

VOID
FORCEINLINE
UCMUCSI_PPM_CONFIG_INIT (
    _Out_ PUCMUCSI_PPM_CONFIG Config,
    _In_ UCMUCSI_CONNECTOR_COLLECTION CollectionObject
    )
{
    RtlZeroMemory(Config, sizeof(*Config));
    Config->Size = sizeof(*Config);
    Config->ConnectorCollectionHandle = CollectionObject;
}
//
// UCMUCSI Function: UcmUcsiConnectorCollectionCreate
//
typedef
_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
WDFAPI
NTSTATUS
(NTAPI *PFN_UCMUCSICONNECTORCOLLECTIONCREATE)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    WDFDEVICE WdfDevice,
    _In_opt_
    PWDF_OBJECT_ATTRIBUTES Attributes,
    _Out_
    UCMUCSI_CONNECTOR_COLLECTION* ConnectorCollection
    );

_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
FORCEINLINE
NTSTATUS
UcmUcsiConnectorCollectionCreate(
    _In_
    WDFDEVICE WdfDevice,
    _In_opt_
    PWDF_OBJECT_ATTRIBUTES Attributes,
    _Out_
    UCMUCSI_CONNECTOR_COLLECTION* ConnectorCollection
    )
{
    return ((PFN_UCMUCSICONNECTORCOLLECTIONCREATE) UcmucsiFunctions[UcmUcsiConnectorCollectionCreateTableIndex])(UcmucsiDriverGlobals, WdfDevice, Attributes, ConnectorCollection);
}

//
// UCMUCSI Function: UcmUcsiConnectorCollectionAddConnector
//
typedef
_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
WDFAPI
NTSTATUS
(NTAPI *PFN_UCMUCSICONNECTORCOLLECTIONADDCONNECTOR)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    UCMUCSI_CONNECTOR_COLLECTION ConnectorCollectionObject,
    _In_
    PUCMUCSI_CONNECTOR_INFO ConnectorInfo
    );

_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
FORCEINLINE
NTSTATUS
UcmUcsiConnectorCollectionAddConnector(
    _In_
    UCMUCSI_CONNECTOR_COLLECTION ConnectorCollectionObject,
    _In_
    PUCMUCSI_CONNECTOR_INFO ConnectorInfo
    )
{
    return ((PFN_UCMUCSICONNECTORCOLLECTIONADDCONNECTOR) UcmucsiFunctions[UcmUcsiConnectorCollectionAddConnectorTableIndex])(UcmucsiDriverGlobals, ConnectorCollectionObject, ConnectorInfo);
}

//
// UCMUCSI Function: UcmUcsiPpmCreate
//
typedef
_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
WDFAPI
NTSTATUS
(NTAPI *PFN_UCMUCSIPPMCREATE)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    WDFDEVICE WdfDevice,
    _In_
    PUCMUCSI_PPM_CONFIG Config,
    _In_opt_
    PWDF_OBJECT_ATTRIBUTES Attributes,
    _Out_
    UCMUCSIPPM* PPMObject
    );

_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
FORCEINLINE
NTSTATUS
UcmUcsiPpmCreate(
    _In_
    WDFDEVICE WdfDevice,
    _In_
    PUCMUCSI_PPM_CONFIG Config,
    _In_opt_
    PWDF_OBJECT_ATTRIBUTES Attributes,
    _Out_
    UCMUCSIPPM* PPMObject
    )
{
    return ((PFN_UCMUCSIPPMCREATE) UcmucsiFunctions[UcmUcsiPpmCreateTableIndex])(UcmucsiDriverGlobals, WdfDevice, Config, Attributes, PPMObject);
}

//
// UCMUCSI Function: UcmUcsiPpmSetUcsiCommandRequestQueue
//
typedef
_IRQL_requires_max_(DISPATCH_LEVEL)
WDFAPI
VOID
(NTAPI *PFN_UCMUCSIPPMSETUCSICOMMANDREQUESTQUEUE)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    UCMUCSIPPM PpmObject,
    _In_
    WDFQUEUE PpmRequestQueue
    );

_IRQL_requires_max_(DISPATCH_LEVEL)
FORCEINLINE
VOID
UcmUcsiPpmSetUcsiCommandRequestQueue(
    _In_
    UCMUCSIPPM PpmObject,
    _In_
    WDFQUEUE PpmRequestQueue
    )
{
    ((PFN_UCMUCSIPPMSETUCSICOMMANDREQUESTQUEUE) UcmucsiFunctions[UcmUcsiPpmSetUcsiCommandRequestQueueTableIndex])(UcmucsiDriverGlobals, PpmObject, PpmRequestQueue);
}

//
// UCMUCSI Function: UcmUcsiPpmStart
//
typedef
_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
WDFAPI
NTSTATUS
(NTAPI *PFN_UCMUCSIPPMSTART)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    UCMUCSIPPM PpmObject
    );

_Must_inspect_result_
_IRQL_requires_max_(PASSIVE_LEVEL)
FORCEINLINE
NTSTATUS
UcmUcsiPpmStart(
    _In_
    UCMUCSIPPM PpmObject
    )
{
    return ((PFN_UCMUCSIPPMSTART) UcmucsiFunctions[UcmUcsiPpmStartTableIndex])(UcmucsiDriverGlobals, PpmObject);
}

//
// UCMUCSI Function: UcmUcsiPpmStop
//
typedef
_IRQL_requires_max_(PASSIVE_LEVEL)
WDFAPI
VOID
(NTAPI *PFN_UCMUCSIPPMSTOP)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    UCMUCSIPPM PpmObject
    );

_IRQL_requires_max_(PASSIVE_LEVEL)
FORCEINLINE
VOID
UcmUcsiPpmStop(
    _In_
    UCMUCSIPPM PpmObject
    )
{
    ((PFN_UCMUCSIPPMSTOP) UcmucsiFunctions[UcmUcsiPpmStopTableIndex])(UcmucsiDriverGlobals, PpmObject);
}

//
// UCMUCSI Function: UcmUcsiPpmNotification
//
typedef
_IRQL_requires_max_(DISPATCH_LEVEL)
WDFAPI
VOID
(NTAPI *PFN_UCMUCSIPPMNOTIFICATION)(
    _In_
    PUCMUCSI_DRIVER_GLOBALS DriverGlobals,
    _In_
    UCMUCSIPPM PpmObject,
    _In_reads_(sizeof(UCSI_DATA_BLOCK))
    PUCSI_DATA_BLOCK DataBlock
    );

_IRQL_requires_max_(DISPATCH_LEVEL)
FORCEINLINE
VOID
UcmUcsiPpmNotification(
    _In_
    UCMUCSIPPM PpmObject,
    _In_reads_(sizeof(UCSI_DATA_BLOCK))
    PUCSI_DATA_BLOCK DataBlock
    )
{
    ((PFN_UCMUCSIPPMNOTIFICATION) UcmucsiFunctions[UcmUcsiPpmNotificationTableIndex])(UcmucsiDriverGlobals, PpmObject, DataBlock);
}



WDF_EXTERN_C_END

#endif // _UCMUCSIPPM_H_