Device.h

/*++

Module Name:

    device.h

Abstract:

    This file contains the device definitions.

Environment:

    Kernel-mode Driver Framework

--*/

#include "public.h"

EXTERN_C_START

//
// The device context performs the same job as
// a WDM device extension in the driver frameworks
//
typedef struct _DEVICE_CONTEXT
{
    WDFUSBDEVICE UsbDevice;
    ULONG PrivateDeviceData;  // just a placeholder

    UINT16 DeviceNumber; // ???
    STRING DebugLog;

    union {
        USHORT VersionAsUshort;
        struct {
            BYTE Minor;
            BYTE Major;
        } Version;
    } Firmware; // firmware version.

} DEVICE_CONTEXT, *PDEVICE_CONTEXT;

//
// This macro will generate an inline function called DeviceGetContext
// which will be used to get a pointer to the device context memory
// in a type safe manner.
//
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(DEVICE_CONTEXT, DeviceGetContext)

//
// Function to initialize the device's queues and callbacks
//
NTSTATUS
WacomPracticeCreateDevice(
    _Inout_ PWDFDEVICE_INIT DeviceInit
    );

//
// Function to select the device's USB configuration and get a WDFUSBDEVICE
// handle
//
EVT_WDF_DEVICE_PREPARE_HARDWARE WacomPracticeEvtDevicePrepareHardware;

// 
// Callback function called when a specific time period has elapsed.
//
EVT_WDF_TIMER BlinkLEDColorCallback;

//
// Higher-level, functional routines that can be invoked to trigger certain behaviours
//
VOID BlinkLEDColor(
    __in PDEVICE_CONTEXT DeviceContext,
    __in int duration,
    __in int r,
    __in int g,
    __in int b
);
VOID CycleLEDColor(
    __in PDEVICE_CONTEXT DeviceContext,
    __in int num_cycles,
    __in int h,
    __in int s
);
VOID SetLEDColor(
    __in PDEVICE_CONTEXT DeviceContext,
    __in int r,
    __in int g,
    __in int b
);
VOID GetFirmwareVersion(
    __in PDEVICE_CONTEXT DeviceContext
);

EXTERN_C_END