arch_cbm_driver.h

Go to the documentation of this file.

/*
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 *  Copyright 2005-2007 Spiro Trikaliotis
 *
 */

/* Include any configuration definitions */
#include "config.h"

#define DVRH_USE_PARPORT_ECP_ADDR 1

#include <parallel.h>

#define DBG_PROGNAME "OPENCBM.SYS"

#include "cbmioctl.h"
#include "memtags.h"
#include "util.h"
#include "queue.h"
#include "cbmlog.h"

#define CBMDEVICENAME L"\\DosDevices\\opencbm"

typedef
struct _ARCH_DEVICE_EXTENSION {

    /* Windows book keeping: */

    PDEVICE_OBJECT Fdo;

    BOOLEAN IsNT4;

    ULONG HandleEcpEppMyself;

    UNICODE_STRING DeviceName;

    QUEUE IrpQueue;

    PFILE_OBJECT ParallelPortFileObject;

    PDEVICE_OBJECT ParallelPortFdo;

    PPARALLEL_PORT_INFORMATION PortInfo;

    PARALLEL_INTERRUPT_SERVICE_ROUTINE Pisr;

    PARALLEL_INTERRUPT_INFORMATION Pii;

    KEVENT EventWaitForListener;

    BOOLEAN ParallelPortIsLocked;

    BOOLEAN ParallelPortLock;

    BOOLEAN ParallelPortAllocated;

    BOOLEAN ParallelPortModeSet;

    BOOLEAN ParallelPortAllocatedInterrupt;

    BOOLEAN DoNotReleaseBus;

    HANDLE ThreadHandle;

    PKTHREAD Thread;

    BOOLEAN QuitThread;

    KIRQL IecBlockIrqPreviousIrql;

#if DBG
    LONG IecBlockIrqUsageCount;
#endif

    LONG CableInitTimer;

} ARCH_DEVICE_EXTENSION;

extern VOID
DriverUnload(IN PDRIVER_OBJECT DriverObject);

extern NTSTATUS
DriverCommonInit(IN PDRIVER_OBJECT Driverobject, IN PUNICODE_STRING RegistryPath);

extern VOID
DriverCommonUninit(VOID);

extern NTSTATUS
AddDeviceCommonInit(IN PDEVICE_OBJECT Fdo, IN PUNICODE_STRING DeviceName, IN PCWSTR ParallelPortName);

extern NTSTATUS
cbm_install(IN PDEVICE_EXTENSION Pdx, OUT PCBMT_I_INSTALL_OUT ReturnBuffer, IN OUT PULONG ReturnLength);

extern NTSTATUS
cbm_lock(IN PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_unlock(IN PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_lock_parport(IN PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_unlock_parport(IN PDEVICE_EXTENSION Pdx);

#if DBG
extern NTSTATUS
cbm_dbg_readbuffer(IN PDEVICE_EXTENSION Pdx, OUT PCHAR ReturnBuffer, IN OUT PULONG ReturnLength);
#endif // #if DBG

extern VOID
cbm_init_registry(IN PUNICODE_STRING RegistryPath, IN PDEVICE_EXTENSION Pdx);

extern VOID
cbm_initialize_cable_deferred(IN PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_startio(IN PDEVICE_OBJECT Fdo, IN PIRP Irp);

extern NTSTATUS
cbm_createopenclose(IN PDEVICE_OBJECT Fdo, IN PIRP Irp);

extern NTSTATUS
cbm_readwrite(IN PDEVICE_OBJECT Fdo, IN PIRP Irp);

extern NTSTATUS
cbm_execute_readwrite(IN PDEVICE_EXTENSION Pdx, IN PIRP Irp);

extern NTSTATUS
cbm_execute_createopen(IN PDEVICE_EXTENSION Pdx, IN PIRP Irp);

extern NTSTATUS
cbm_cleanup(IN PDEVICE_OBJECT Fdo, IN PIRP Irp);

extern NTSTATUS
cbm_execute_close(IN PDEVICE_EXTENSION Pdx, IN PIRP Irp);

extern NTSTATUS
cbm_devicecontrol(IN PDEVICE_OBJECT Fdo, IN PIRP Irp);

extern NTSTATUS
cbm_execute_devicecontrol(IN PDEVICE_EXTENSION Pdx, IN PIRP Irp);

extern BOOLEAN
cbm_isr(IN PKINTERRUPT Interrupt, IN PVOID Pdx);

extern VOID
cbm_thread(IN PVOID Context);

extern NTSTATUS
cbm_start_thread(IN PDEVICE_EXTENSION Pdx);

extern VOID
cbm_stop_thread(IN PDEVICE_EXTENSION Pdx);

#ifndef PENUMERATE_DEFINED

   typedef PVOID PENUMERATE;
#endif

extern NTSTATUS
ParPortEnumerateOpen(PENUMERATE *EnumStruct);

extern NTSTATUS
ParPortEnumerate(PENUMERATE EnumStruct, PCWSTR *DriverName);

extern VOID
ParPortEnumerateClose(PENUMERATE EnumStruct);

extern NTSTATUS
ParPortInit(PUNICODE_STRING ParallelPortName, PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortDeinit(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortAllocate(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortFree(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortSetMode(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortUnsetMode(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortSetModeWdm(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortUnsetModeWdm(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortAllocInterrupt(PDEVICE_EXTENSION Pdx, PKSERVICE_ROUTINE Isr);

extern NTSTATUS
ParPortFreeInterrupt(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
ParPortAllowInterruptIoctl(PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_registry_open_for_read(OUT PHANDLE HandleKey, IN PUNICODE_STRING Path);

extern NTSTATUS
cbm_registry_open_hardwarekey(OUT PHANDLE HandleKey, OUT PDEVICE_OBJECT *Pdo,
                              IN PDEVICE_EXTENSION Pdx);

extern NTSTATUS
cbm_registry_close(IN HANDLE HandleKey);

extern NTSTATUS
cbm_registry_close_hardwarekey(IN HANDLE HandleKey, IN PDEVICE_OBJECT Pdo);

extern NTSTATUS
cbm_registry_read_ulong(IN HANDLE HandleKey, IN PCWSTR KeyName, OUT PULONG Value);

extern NTSTATUS
cbm_registry_write_ulong(IN HANDLE HandleKey, IN PCWSTR KeyName, IN ULONG Value);

extern NTSTATUS
CbmOpenDeviceRegistryKey(IN PDEVICE_OBJECT a, IN ULONG b, IN ACCESS_MASK c, OUT PHANDLE d);

extern ULONG
CbmGetCurrentProcessorNumber(VOID);

extern ULONG
CbmGetNumberProcessors(VOID);

extern VOID
CLI(VOID);

extern VOID
STI(VOID);