reactos/sdk/include/ddk/parallel.h

273 lines
8.4 KiB
C

/*
* parallel.h
*
* ParPort driver interface
*
* This file is part of the w32api package.
*
* Contributors:
* Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
*
* THIS SOFTWARE IS NOT COPYRIGHTED
*
* This source code is offered for use in the public domain. You may
* use, modify or distribute it freely.
*
* This code is distributed in the hope that it will be useful but
* WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
* DISCLAIMED. This includes but is not limited to warranties of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
*/
#ifndef __PARALLEL_H
#define __PARALLEL_H
#include "ntddpar.h"
#ifdef __cplusplus
extern "C" {
#endif
#define DD_PARALLEL_PORT_BASE_NAME "ParallelPort"
#define DD_PARALLEL_PORT_BASE_NAME_U L"ParallelPort"
#define IOCTL_INTERNAL_DESELECT_DEVICE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 24, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_GET_MORE_PARALLEL_PORT_INFO \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 17, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_GET_PARALLEL_PNP_INFO \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 21, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_GET_PARALLEL_PORT_INFO \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 12, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_INIT_1284_3_BUS \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 22, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_CLEAR_CHIP_MODE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 20, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_CONNECT_INTERRUPT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 13, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_DISCONNECT_INTERRUPT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 14, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_PORT_ALLOCATE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 11, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_PORT_FREE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 40, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARALLEL_SET_CHIP_MODE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 19, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_RELEASE_PARALLEL_PORT_INFO \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 15, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_SELECT_DEVICE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 23, METHOD_BUFFERED, FILE_ANY_ACCESS)
typedef struct _PARALLEL_1284_COMMAND {
UCHAR ID;
UCHAR Port;
ULONG CommandFlags;
} PARALLEL_1284_COMMAND, *PPARALLEL_1284_COMMAND;
/* PARALLEL_1284_COMMAND.CommandFlags */
#define PAR_END_OF_CHAIN_DEVICE 0x00000001
#define PAR_HAVE_PORT_KEEP_PORT 0x00000002
typedef struct _MORE_PARALLEL_PORT_INFORMATION {
INTERFACE_TYPE InterfaceType;
ULONG BusNumber;
ULONG InterruptLevel;
ULONG InterruptVector;
KAFFINITY InterruptAffinity;
KINTERRUPT_MODE InterruptMode;
} MORE_PARALLEL_PORT_INFORMATION, *PMORE_PARALLEL_PORT_INFORMATION;
typedef NTSTATUS
(NTAPI *PPARALLEL_SET_CHIP_MODE)(
_In_ PVOID SetChipContext,
_In_ UCHAR ChipMode);
typedef NTSTATUS
(NTAPI *PPARALLEL_CLEAR_CHIP_MODE)(
_In_ PVOID ClearChipContext,
_In_ UCHAR ChipMode);
typedef NTSTATUS
(NTAPI *PPARCHIP_CLEAR_CHIP_MODE)(
_In_ PVOID ClearChipContext,
_In_ UCHAR ChipMode);
typedef NTSTATUS
(NTAPI *PPARALLEL_TRY_SELECT_ROUTINE)(
_In_ PVOID TrySelectContext,
_In_ PVOID TrySelectCommand);
typedef NTSTATUS
(NTAPI *PPARALLEL_DESELECT_ROUTINE)(
_In_ PVOID DeselectContext,
_In_ PVOID DeselectCommand);
/* PARALLEL_PNP_INFORMATION.HardwareCapabilities */
#define PPT_NO_HARDWARE_PRESENT 0x00000000
#define PPT_ECP_PRESENT 0x00000001
#define PPT_EPP_PRESENT 0x00000002
#define PPT_EPP_32_PRESENT 0x00000004
#define PPT_BYTE_PRESENT 0x00000008
#define PPT_BIDI_PRESENT 0x00000008
#define PPT_1284_3_PRESENT 0x00000010
typedef struct _PARALLEL_PNP_INFORMATION {
PHYSICAL_ADDRESS OriginalEcpController;
PUCHAR EcpController;
ULONG SpanOfEcpController;
ULONG PortNumber;
ULONG HardwareCapabilities;
PPARALLEL_SET_CHIP_MODE TrySetChipMode;
PPARALLEL_CLEAR_CHIP_MODE ClearChipMode;
ULONG FifoDepth;
ULONG FifoWidth;
PHYSICAL_ADDRESS EppControllerPhysicalAddress;
ULONG SpanOfEppController;
ULONG Ieee1284_3DeviceCount;
PPARALLEL_TRY_SELECT_ROUTINE TrySelectDevice;
PPARALLEL_DESELECT_ROUTINE DeselectDevice;
PVOID Context;
ULONG CurrentMode;
PWSTR PortName;
} PARALLEL_PNP_INFORMATION, *PPARALLEL_PNP_INFORMATION;
typedef BOOLEAN
(NTAPI *PPARALLEL_TRY_ALLOCATE_ROUTINE)(
_In_ PVOID TryAllocateContext);
typedef VOID
(NTAPI *PPARALLEL_FREE_ROUTINE)(
_In_ PVOID FreeContext);
typedef ULONG
(NTAPI *PPARALLEL_QUERY_WAITERS_ROUTINE)(
_In_ PVOID QueryAllocsContext);
typedef struct _PARALLEL_PORT_INFORMATION {
PHYSICAL_ADDRESS OriginalController;
PUCHAR Controller;
ULONG SpanOfController;
PPARALLEL_TRY_ALLOCATE_ROUTINE TryAllocatePort;
PPARALLEL_FREE_ROUTINE FreePort;
PPARALLEL_QUERY_WAITERS_ROUTINE QueryNumWaiters;
PVOID Context;
} PARALLEL_PORT_INFORMATION, *PPARALLEL_PORT_INFORMATION;
/* PARALLEL_CHIP_MODE.ModeFlags */
#define INITIAL_MODE 0x00
#define PARCHIP_ECR_ARBITRATOR 0x01
typedef struct _PARALLEL_CHIP_MODE {
UCHAR ModeFlags;
BOOLEAN success;
} PARALLEL_CHIP_MODE, *PPARALLEL_CHIP_MODE;
typedef VOID
(NTAPI *PPARALLEL_DEFERRED_ROUTINE)(
_In_ PVOID DeferredContext);
typedef struct _PARALLEL_INTERRUPT_SERVICE_ROUTINE {
PKSERVICE_ROUTINE InterruptServiceRoutine;
PVOID InterruptServiceContext;
PPARALLEL_DEFERRED_ROUTINE DeferredPortCheckRoutine;
PVOID DeferredPortCheckContext;
} PARALLEL_INTERRUPT_SERVICE_ROUTINE, *PPARALLEL_INTERRUPT_SERVICE_ROUTINE;
#define IOCTL_INTERNAL_DISCONNECT_IDLE \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 32, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_LOCK_PORT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 37, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_LOCK_PORT_NO_SELECT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 52, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARCLASS_CONNECT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 30, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_PARCLASS_DISCONNECT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 31, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_UNLOCK_PORT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 38, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_INTERNAL_UNLOCK_PORT_NO_DESELECT \
CTL_CODE (FILE_DEVICE_PARALLEL_PORT, 53, METHOD_BUFFERED, FILE_ANY_ACCESS)
typedef USHORT
(NTAPI *PDETERMINE_IEEE_MODES)(
_In_ PVOID Context);
typedef enum _PARALLEL_SAFETY {
SAFE_MODE,
UNSAFE_MODE
} PARALLEL_SAFETY;
typedef NTSTATUS
(NTAPI *PNEGOTIATE_IEEE_MODE)(
_In_ PVOID Context,
_In_ USHORT ModeMaskFwd,
_In_ USHORT ModeMaskRev,
_In_ PARALLEL_SAFETY ModeSafety,
_In_ BOOLEAN IsForward);
typedef NTSTATUS
(NTAPI *PTERMINATE_IEEE_MODE)(
_In_ PVOID Context);
typedef NTSTATUS
(NTAPI *PPARALLEL_IEEE_FWD_TO_REV)(
_In_ PVOID Context);
typedef NTSTATUS
(NTAPI *PPARALLEL_IEEE_REV_TO_FWD)(
_In_ PVOID Context);
typedef NTSTATUS
(NTAPI *PPARALLEL_READ)(
_In_ PVOID Context,
_Out_writes_bytes_to_(NumBytesToRead, *NumBytesRead) PVOID Buffer,
_In_ ULONG NumBytesToRead,
_Out_ PULONG NumBytesRead,
_In_ UCHAR Channel);
typedef NTSTATUS
(NTAPI *PPARALLEL_WRITE)(
_In_ PVOID Context,
_In_reads_bytes_(NumBytesToWrite) PVOID Buffer,
_In_ ULONG NumBytesToWrite,
_Out_ PULONG NumBytesWritten,
_In_ UCHAR Channel);
typedef NTSTATUS
(NTAPI *PPARALLEL_TRYSELECT_DEVICE)(
_In_ PVOID Context,
_In_ PARALLEL_1284_COMMAND Command);
typedef NTSTATUS
(NTAPI *PPARALLEL_DESELECT_DEVICE)(
_In_ PVOID Context,
_In_ PARALLEL_1284_COMMAND Command);
typedef struct _PARCLASS_INFORMATION {
PUCHAR Controller;
PUCHAR EcrController;
ULONG SpanOfController;
PDETERMINE_IEEE_MODES DetermineIeeeModes;
PNEGOTIATE_IEEE_MODE NegotiateIeeeMode;
PTERMINATE_IEEE_MODE TerminateIeeeMode;
PPARALLEL_IEEE_FWD_TO_REV IeeeFwdToRevMode;
PPARALLEL_IEEE_REV_TO_FWD IeeeRevToFwdMode;
PPARALLEL_READ ParallelRead;
PPARALLEL_WRITE ParallelWrite;
PVOID ParclassContext;
ULONG HardwareCapabilities;
ULONG FifoDepth;
ULONG FifoWidth;
PPARALLEL_TRYSELECT_DEVICE ParallelTryselect;
PPARALLEL_DESELECT_DEVICE ParallelDeSelect;
} PARCLASS_INFORMATION, *PPARCLASS_INFORMATION;
#ifdef __cplusplus
}
#endif
#endif /* __PARALLEL_H */