mpu401.h File Reference

#include "../../../dll/win32/mmdrv/mmdef.h"

Include dependency graph for mpu401.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_DEVICE_EXTENSION
struct	_DEVICE_INSTANCE

Macros
#define	DEFAULT_PORT   0x330
#define	DEFAULT_IRQ   9
#define	DEVICE_SUBKEY   L"Devices"
#define	PARMS_SUBKEY   L"Parameters"
#define	REGISTRY_PORT   L"Port"
#define	MPU401_PORT   DEFAULT_PORT
#define	MPU401_IRQ   DEFAULT_IRQ
#define	MPU401_TIMEOUT   10000
#define	MPU401_WRITE_DATA(bp, x)   WRITE_PORT_UCHAR((PUCHAR) bp, x)
#define	MPU401_READ_DATA(bp)   READ_PORT_UCHAR((PUCHAR) bp)
#define	MPU401_WRITE_COMMAND(bp, x)   WRITE_PORT_UCHAR((PUCHAR) bp+1, x)
#define	MPU401_READ_STATUS(bp)   READ_PORT_UCHAR((PUCHAR) bp+1)
#define	MPU401_READY_TO_SEND(bp)    MPU401_READ_STATUS(bp) & 0x80
#define	MPU401_READY_TO_RECEIVE(bp)    MPU401_READ_STATUS(bp) & 0x40
#define	MPU401_WRITE_BYTE(bp, x)    if (WaitToSend(bp)) MPU401_WRITE_DATA(bp, x)
#define	MPU401_WRITE_MESSAGE(bp, status, da, db)

Typedefs
typedef struct _DEVICE_EXTENSION	DEVICE_EXTENSION
typedef struct _DEVICE_EXTENSION *	PDEVICE_EXTENSION
typedef struct _DEVICE_INSTANCE	DEVICE_INSTANCE
typedef struct _DEVICE_INSTANCE *	PDEVICE_INSTANCE
typedef NTSTATUS	REGISTRY_CALLBACK_ROUTINE(PWSTR RegistryPath, PVOID Context)
typedef REGISTRY_CALLBACK_ROUTINE *	PREGISTRY_CALLBACK_ROUTINE

Functions
BOOLEAN	WaitToSend (ULONG BasePort)
BOOLEAN	WaitToReceive (ULONG BasePort)
BOOLEAN	InitUARTMode (ULONG BasePort)
NTSTATUS NTAPI	EnumDeviceKeys (IN PUNICODE_STRING RegistryPath, IN PWSTR SubKey, IN PREGISTRY_CALLBACK_ROUTINE Callback, IN PVOID Context)
NTSTATUS NTAPI	LoadSettings (IN PWSTR ValueName, IN ULONG ValueType, IN PVOID ValueData, IN ULONG ValueLength, IN PVOID Context, IN PVOID EntryContext)
NTSTATUS NTAPI	DriverEntry (PDRIVER_OBJECT DriverObject, PUNICODE_STRING RegistryPath)

Macro Definition Documentation

DEFAULT_IRQ

#define DEFAULT_IRQ   9

Definition at line 20 of file mpu401.h.

DEFAULT_PORT

#define DEFAULT_PORT   0x330

Definition at line 19 of file mpu401.h.

DEVICE_SUBKEY

#define DEVICE_SUBKEY   L"Devices"

Definition at line 22 of file mpu401.h.

MPU401_IRQ

#define MPU401_IRQ   DEFAULT_IRQ

Definition at line 29 of file mpu401.h.

MPU401_PORT

#define MPU401_PORT   DEFAULT_PORT

Definition at line 28 of file mpu401.h.

MPU401_READ_DATA

#define MPU401_READ_DATA

(

bp

)

READ_PORT_UCHAR((PUCHAR) bp)

Definition at line 54 of file mpu401.h.

MPU401_READ_STATUS

#define MPU401_READ_STATUS

(

bp

)

READ_PORT_UCHAR((PUCHAR) bp+1)

Definition at line 56 of file mpu401.h.

MPU401_READY_TO_RECEIVE

#define MPU401_READY_TO_RECEIVE

(

bp

)

MPU401_READ_STATUS(bp) & 0x40

Definition at line 64 of file mpu401.h.

MPU401_READY_TO_SEND

#define MPU401_READY_TO_SEND

(

bp

)

MPU401_READ_STATUS(bp) & 0x80

Definition at line 61 of file mpu401.h.

MPU401_TIMEOUT

#define MPU401_TIMEOUT   10000

Definition at line 31 of file mpu401.h.

MPU401_WRITE_BYTE

#define MPU401_WRITE_BYTE	(		bp,
			x
	)		if (WaitToSend(bp)) MPU401_WRITE_DATA(bp, x)

Definition at line 68 of file mpu401.h.

MPU401_WRITE_COMMAND

#define MPU401_WRITE_COMMAND	(		bp,
			x
	)		WRITE_PORT_UCHAR((PUCHAR) bp+1, x)

Definition at line 55 of file mpu401.h.

MPU401_WRITE_DATA

#define MPU401_WRITE_DATA	(		bp,
			x
	)		WRITE_PORT_UCHAR((PUCHAR) bp, x)

Definition at line 53 of file mpu401.h.

MPU401_WRITE_MESSAGE

#define MPU401_WRITE_MESSAGE	(		bp,
			status,
			da,
			db
	)

Value:

    MPU401_WRITE(bp, status); \
    MPU401_WRITE(bp, da); \
    MPU401_WRITE(bp, db)

Definition at line 71 of file mpu401.h.

PARMS_SUBKEY

#define PARMS_SUBKEY   L"Parameters"

Definition at line 23 of file mpu401.h.

REGISTRY_PORT

#define REGISTRY_PORT   L"Port"

Definition at line 25 of file mpu401.h.

Typedef Documentation

DEVICE_EXTENSION

typedef struct _DEVICE_EXTENSION DEVICE_EXTENSION

DEVICE_INSTANCE

typedef struct _DEVICE_INSTANCE DEVICE_INSTANCE

PDEVICE_EXTENSION

typedef struct _DEVICE_EXTENSION * PDEVICE_EXTENSION

PDEVICE_INSTANCE

typedef struct _DEVICE_INSTANCE * PDEVICE_INSTANCE

PREGISTRY_CALLBACK_ROUTINE

typedef REGISTRY_CALLBACK_ROUTINE* PREGISTRY_CALLBACK_ROUTINE

Definition at line 121 of file mpu401.h.

REGISTRY_CALLBACK_ROUTINE

typedef NTSTATUS REGISTRY_CALLBACK_ROUTINE(PWSTR RegistryPath, PVOID Context)

Definition at line 120 of file mpu401.h.

Function Documentation

DriverEntry()

NTSTATUS NTAPI DriverEntry	(	PDRIVER_OBJECT	DriverObject,
		PUNICODE_STRING	RegistryPath
	)

Definition at line 16 of file battc.c.

{
    DPRINT("Battery class driver initialized\n");
 
    return STATUS_SUCCESS;
}

EnumDeviceKeys()

NTSTATUS NTAPI EnumDeviceKeys	(	IN PUNICODE_STRING	RegistryPath,
		IN PWSTR	SubKey,
		IN PREGISTRY_CALLBACK_ROUTINE	Callback,
		IN PVOID	Context
	)

Definition at line 73 of file settings.c.

{
    NTSTATUS s;
    OBJECT_ATTRIBUTES oa;
    HANDLE hKey, hSubKey;
    UNICODE_STRING SubkeyName;
    ULONG i;
 
    // Attempt to open the key
 
    InitializeObjectAttributes(&oa, RegistryPath, OBJ_CASE_INSENSITIVE,
                                NULL, (PSECURITY_DESCRIPTOR)NULL);
 
    s = ZwOpenKey(&hKey, KEY_READ, &oa);
 
        TEST_STATUS(s); // debugging
 
    if (! NT_SUCCESS(s))
        return s;   // Problem
 
    RtlInitUnicodeString(&SubkeyName, SubKey);
 
    DPRINT("Subkey: %wZ\n", &SubkeyName);
 
    InitializeObjectAttributes(&oa, &SubkeyName, OBJ_CASE_INSENSITIVE,
                                hKey, (PSECURITY_DESCRIPTOR)NULL);
 
    s = ZwOpenKey(&hSubKey, KEY_ENUMERATE_SUB_KEYS, &oa);
 
    ZwClose(hKey);
 
        TEST_STATUS(s); // debugging
 
    if (! NT_SUCCESS(s))
        return s;
 
 
    // And now, the enumeration
 
    for (i = 0;; i ++)
    {
        KEY_BASIC_INFORMATION Info;
        PKEY_BASIC_INFORMATION pInfo;
        ULONG ResultLength = 0;
        ULONG Size = 0;
        PWSTR Pos;
        PWSTR Name;
 
        // Find the length of the subkey data
 
//        Info.NameLength = 0;    // TEMPORARY!
 
        s = ZwEnumerateKey(hSubKey, i, KeyBasicInformation, &Info,
                            sizeof(Info), &ResultLength);
 
        if (s == STATUS_NO_MORE_ENTRIES)
            break;
 
        DPRINT("Found an entry, allocating memory...\n");
 
//        Size = Info.NameLength + FIELD_OFFSET(KEY_BASIC_INFORMATION, Name[0]);
        Size = ResultLength + FIELD_OFFSET(KEY_BASIC_INFORMATION, Name[0]);
 
        DPRINT("Size is %d\n", Size);
 
        pInfo = (PKEY_BASIC_INFORMATION) ExAllocatePool(PagedPool, Size);
 
        if (pInfo == NULL)
        {
            DPRINT("INSUFFICIENT RESOURCES!\n");
            s = STATUS_INSUFFICIENT_RESOURCES;
            break;
        }
 
        DPRINT("Re-enumerating...\n");
 
        s = ZwEnumerateKey(hSubKey, i, KeyBasicInformation, pInfo, Size,
                            &ResultLength);
 
//        TEST_STATUS(s); // debugging
 
        if (! NT_SUCCESS(s))
        {
            ExFreePool((PVOID) pInfo);
            s = STATUS_INTERNAL_ERROR;
            break;
        }
 
        DPRINT("Allocating memory for name...\n");
 
        Name = ExAllocatePool(PagedPool,
                          RegistryPath->Length + sizeof(WCHAR) +
                          SubkeyName.Length + sizeof(WCHAR) +
                          pInfo->NameLength + sizeof(UNICODE_NULL));
 
        if (Name == NULL)
        {
            DPRINT("INSUFFICIENT RESOURCES!");
            ExFreePool((PVOID) pInfo);
            return STATUS_INSUFFICIENT_RESOURCES;
        }
 
        // Copy the key name
        RtlCopyMemory((PVOID)Name, (PVOID)RegistryPath->Buffer, RegistryPath->Length);
        Pos = Name + (RegistryPath->Length / sizeof(WCHAR));
        Pos[0] = '\\';
        Pos++;
 
        // Copy the parameters sub key name
        RtlCopyMemory((PVOID)Pos, (PVOID)SubKey, SubkeyName.Length);    //SubkeyName?
        Pos += SubkeyName.Length / sizeof(WCHAR);
        Pos[0] = '\\';
        Pos ++;
 
        // Copy the device sub key name
        RtlCopyMemory((PVOID)Pos, (PVOID)pInfo->Name, pInfo->NameLength);
        Pos += pInfo->NameLength / sizeof(WCHAR);
        Pos[0] = UNICODE_NULL;
 
        ExFreePool((PVOID)pInfo);
 
        DPRINT("Calling callback...\n");
 
        s = (*Callback)(Name, Context);
 
        if (! NT_SUCCESS(s))
        {   DPRINT("Callback FAILED\n");
            break;}
    }
 
    ZwClose(hSubKey);
 
    DPRINT("%d device registry keys found\n", i);
 
    if ((i == 0) && (s == STATUS_NO_MORE_ENTRIES))
        return STATUS_DEVICE_CONFIGURATION_ERROR;
 
    return s == STATUS_NO_MORE_ENTRIES ? STATUS_SUCCESS : s;
}

InitUARTMode()

BOOLEAN InitUARTMode

(

ULONG

BasePort

)

Definition at line 64 of file portio.c.

{
    ULONG TimeOut;
    UCHAR Status = 0;
 
    DbgPrint("InitUARTMode() called\n");
 
    // Check if it's OK to send
    if (! WaitToSend(BasePort))
        return FALSE;
 
    DbgPrint("Resetting MPU401\n");
 
    // Send an MPU reset:
    MPU401_WRITE_COMMAND(BasePort, 0xff);
 
    // Check if it's OK to receive (some cards will ignore the above reset
    // command and so will not issue an ACK, so time out is NOT an error)
    DbgPrint("Waiting for an ACK\n");
    if (WaitToReceive(BasePort))
    {
        // Check to make sure the reset was acknowledged:
        for (TimeOut = MPU401_TIMEOUT;
             (Status = (MPU401_READ_DATA(BasePort) & 0xfe) && TimeOut > 0);
             TimeOut --);
    }
 
    DbgPrint("Entering UART mode\n");
    // Now we kick the MPU401 into UART ("dumb") mode
    MPU401_WRITE_COMMAND(BasePort, 0x3f);
 
    return TRUE;
}

Referenced by InitDevice().

LoadSettings()

NTSTATUS NTAPI LoadSettings	(	IN PWSTR	ValueName,
		IN ULONG	ValueType,
		IN PVOID	ValueData,
		IN ULONG	ValueLength,
		IN PVOID	Context,
		IN PVOID	EntryContext
	)

Definition at line 233 of file settings.c.

{
    PDEVICE_EXTENSION DeviceInfo = Context;
 
    if (ValueType == REG_DWORD)
    {
        if (! _wcsicmp(ValueName, REGISTRY_PORT))
        {
            DeviceInfo->Port = *(PULONG) ValueData;
            DPRINT("Registry port = 0x%x\n", DeviceInfo->Port);
        }
 
        // More to come... (config.c)
    }
 
    else
    {
        // ?
    }
 
    return STATUS_SUCCESS;
}

WaitToReceive()

BOOLEAN WaitToReceive

(

ULONG

BasePort

)

Definition at line 40 of file portio.c.

{
    int TimeOut;
 
    DbgPrint("WaitToSend ");
 
    // Check if it's OK to receive
    for (TimeOut = MPU401_TIMEOUT;
         ! MPU401_READY_TO_RECEIVE(BasePort) && TimeOut > 0;
         TimeOut --);
 
    // If a time-out occurs, we report failure
    if (! TimeOut)
    {
        DbgPrint("FAILED\n");
        return FALSE;
    }
 
    DbgPrint("SUCCEEDED\n");
 
    return TRUE;
}

Referenced by IsSpeakerEnabled().

WaitToSend()

BOOLEAN WaitToSend

(

ULONG

BasePort

)

Definition at line 16 of file portio.c.

{
    int TimeOut;
 
    DbgPrint("WaitToSend ");
 
    // Check if it's OK to send
    for (TimeOut = MPU401_TIMEOUT;
         ! MPU401_READY_TO_SEND(BasePort) && TimeOut > 0;
         TimeOut --);
 
    // If a time-out occurs, we report failure
    if (! TimeOut)
    {
        DbgPrint("FAILED\n");
        return FALSE;
    }
 
    DbgPrint("SUCCEEDED\n");
 
    return TRUE;
}

Referenced by MPU401Create().