#include <ntddk.h>
#include <ntddser.h>

Include dependency graph for serial.h:

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

Classes
struct	_CIRCULAR_BUFFER

struct	_SERIAL_DEVICE_EXTENSION

struct	_WORKITEM_DATA

Macros
#define	PST_RS232 1

#define	COMMPROP_INITIALIZED 0xE73CF52E

#define	SERIAL_TAG 'lreS'

#define	INFINITE MAXULONG

#define	BAUD_CLOCK 1843200

#define	CLOCKS_PER_BIT 16

#define	SER_RBR(x) ((PUCHAR)(x)+0) /* Receive Register */

#define	SER_THR(x) ((PUCHAR)(x)+0) /* Transmit Register */

#define	SER_DLL(x) ((PUCHAR)(x)+0) /* Baud Rate Divisor LSB */

#define	SER_IER(x) ((PUCHAR)(x)+1) /* Interrupt Enable Register */

#define	SR_IER_DATA_RECEIVED 0x01

#define	SR_IER_THR_EMPTY 0x02

#define	SR_IER_LSR_CHANGE 0x04

#define	SR_IER_MSR_CHANGE 0x08

#define	SR_IER_SLEEP_MODE 0x10 /* Uart >= 16750 */

#define	SR_IER_LOW_POWER 0x20 /* Uart >= 16750 */

#define	SER_DLM(x) ((PUCHAR)(x)+1) /* Baud Rate Divisor MSB */

#define	SER_IIR(x) ((PUCHAR)(x)+2) /* Interrupt Identification Register */

#define	SR_IIR_SELF 0x00

#define	SR_IIR_ID_MASK 0x07

#define	SR_IIR_MSR_CHANGE SR_IIR_SELF

#define	SR_IIR_THR_EMPTY (SR_IIR_SELF \| 2)

#define	SR_IIR_DATA_RECEIVED (SR_IIR_SELF \| 4)

#define	SR_IIR_ERROR (SR_IIR_SELF \| 6)

#define	SER_FCR(x) ((PUCHAR)(x)+2) /* FIFO Control Register (Uart >= 16550A) */

#define	SR_FCR_ENABLE_FIFO 0x01

#define	SR_FCR_CLEAR_RCVR (0x02 \| SR_FCR_ENABLE_FIFO)

#define	SR_FCR_CLEAR_XMIT (0x04 \| SR_FCR_ENABLE_FIFO)

#define	SR_FCR_1_BYTE (0x00 \| SR_FCR_ENABLE_FIFO)

#define	SR_FCR_4_BYTES (0x40 \| SR_FCR_ENABLE_FIFO)

#define	SR_FCR_8_BYTES (0x80 \| SR_FCR_ENABLE_FIFO)

#define	SR_FCR_14_BYTES (0xC0 \| SR_FCR_ENABLE_FIFO)

#define	SER_LCR(x) ((PUCHAR)(x)+3) /* Line Control Register */

#define	SR_LCR_CS5 0x00

#define	SR_LCR_CS6 0x01

#define	SR_LCR_CS7 0x02

#define	SR_LCR_CS8 0x03

#define	SR_LCR_ST1 0x00

#define	SR_LCR_ST2 0x04

#define	SR_LCR_PNO 0x00

#define	SR_LCR_POD 0x08

#define	SR_LCR_PEV 0x18

#define	SR_LCR_PMK 0x28

#define	SR_LCR_PSP 0x38

#define	SR_LCR_BRK 0x40

#define	SR_LCR_DLAB 0x80

#define	SER_MCR(x) ((PUCHAR)(x)+4) /* Modem Control Register */

#define	SR_MCR_DTR SERIAL_DTR_STATE

#define	SR_MCR_RTS SERIAL_RTS_STATE

#define	SER_LSR(x) ((PUCHAR)(x)+5) /* Line Status Register */

#define	SR_LSR_DATA_RECEIVED 0x01

#define	SR_LSR_OVERRUN_ERROR 0x02

#define	SR_LSR_PARITY_ERROR 0x04

#define	SR_LSR_FRAMING_ERROR 0x08

#define	SR_LSR_BREAK_INT 0x10

#define	SR_LSR_THR_EMPTY 0x20

#define	SR_LSR_TSR_EMPTY 0x40

#define	SR_LSR_ERROR_IN_FIFO 0x80 /* Uart >= 16550A */

#define	SER_MSR(x) ((PUCHAR)(x)+6) /* Modem Status Register */

#define	SR_MSR_CTS_CHANGED 0x01

#define	SR_MSR_DSR_CHANGED 0x02

#define	SR_MSR_RI_CHANGED 0x04

#define	SR_MSR_DCD_CHANGED 0x08

#define	SR_MSR_CTS SERIAL_CTS_STATE /* Clear To Send */

#define	SR_MSR_DSR SERIAL_DSR_STATE /* Data Set Ready */

#define	SI_MSR_RI SERIAL_RI_STATE /* Ring Indicator */

#define	SR_MSR_DCD SERIAL_DCD_STATE /* Data Carrier Detect */

#define	SER_SCR(x) ((PUCHAR)(x)+7) /* Scratch Pad Register, Uart >= Uart16450 */

Typedefs
typedef struct _CIRCULAR_BUFFER	CIRCULAR_BUFFER

typedef struct _CIRCULAR_BUFFER *	PCIRCULAR_BUFFER

typedef struct _SERIAL_DEVICE_EXTENSION	SERIAL_DEVICE_EXTENSION

typedef struct _SERIAL_DEVICE_EXTENSION *	PSERIAL_DEVICE_EXTENSION

typedef struct _WORKITEM_DATA	WORKITEM_DATA

typedef struct _WORKITEM_DATA *	PWORKITEM_DATA

Enumerations
enum	SERIAL_DEVICE_STATE { dsStopped , dsStarted , dsPaused , dsRemoved , dsSurpriseRemoved }

enum	UART_TYPE { UartUnknown , Uart8250 , Uart16450 , Uart16550 , Uart16550A , Uart16650 , Uart16750 }

Functions
NTSTATUS	InitializeCircularBuffer (IN PCIRCULAR_BUFFER pBuffer, IN ULONG BufferSize)

NTSTATUS	FreeCircularBuffer (IN PCIRCULAR_BUFFER pBuffer)

BOOLEAN	IsCircularBufferEmpty (IN PCIRCULAR_BUFFER pBuffer)

ULONG	GetNumberOfElementsInCircularBuffer (IN PCIRCULAR_BUFFER pBuffer)

NTSTATUS	PushCircularBufferEntry (IN PCIRCULAR_BUFFER pBuffer, IN UCHAR Entry)

NTSTATUS	PopCircularBufferEntry (IN PCIRCULAR_BUFFER pBuffer, OUT PUCHAR Entry)

NTSTATUS	IncreaseCircularBufferSize (IN PCIRCULAR_BUFFER pBuffer, IN ULONG NewBufferSize)

NTSTATUS NTAPI	SerialSetBaudRate (IN PSERIAL_DEVICE_EXTENSION DeviceExtension, IN ULONG NewBaudRate)

NTSTATUS NTAPI	SerialSetLineControl (IN PSERIAL_DEVICE_EXTENSION DeviceExtension, IN PSERIAL_LINE_CONTROL NewSettings)

UART_TYPE	SerialDetectUartType (IN PUCHAR ComPortBase)

VOID NTAPI	SerialReceiveByte (IN PKDPC Dpc, IN PVOID pDeviceExtension, IN PVOID Unused1, IN PVOID Unused2)

VOID NTAPI	SerialSendByte (IN PKDPC Dpc, IN PVOID pDeviceExtension, IN PVOID Unused1, IN PVOID Unused2)

VOID NTAPI	SerialCompleteIrp (IN PKDPC Dpc, IN PVOID pDeviceExtension, IN PVOID pIrp, IN PVOID Unused)

NTSTATUS NTAPI	SerialAddDeviceInternal (IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT Pdo, IN UART_TYPE UartType, IN PULONG pComPortNumber OPTIONAL, OUT PDEVICE_OBJECT *pFdo OPTIONAL)

NTSTATUS NTAPI	SerialPnpStartDevice (IN PDEVICE_OBJECT DeviceObject, IN PCM_RESOURCE_LIST ResourceList, IN PCM_RESOURCE_LIST ResourceListTranslated)

Macro Definition Documentation

◆ BAUD_CLOCK

#define BAUD_CLOCK 1843200

Definition at line 105 of file serial.h.

◆ CLOCKS_PER_BIT

#define CLOCKS_PER_BIT 16

Definition at line 106 of file serial.h.

◆ COMMPROP_INITIALIZED

#define COMMPROP_INITIALIZED 0xE73CF52E

Definition at line 18 of file serial.h.

◆ INFINITE

#define INFINITE MAXULONG

Definition at line 102 of file serial.h.

◆ PST_RS232

#define PST_RS232 1

Definition at line 17 of file serial.h.

◆ SER_DLL

#define SER_DLL ( x ) ((PUCHAR)(x)+0) /* Baud Rate Divisor LSB */

Definition at line 111 of file serial.h.

◆ SER_DLM

#define SER_DLM ( x ) ((PUCHAR)(x)+1) /* Baud Rate Divisor MSB */

Definition at line 119 of file serial.h.

◆ SER_FCR

#define SER_FCR ( x ) ((PUCHAR)(x)+2) /* FIFO Control Register (Uart >= 16550A) */

Definition at line 127 of file serial.h.

◆ SER_IER

#define SER_IER ( x ) ((PUCHAR)(x)+1) /* Interrupt Enable Register */

Definition at line 112 of file serial.h.

◆ SER_IIR

#define SER_IIR ( x ) ((PUCHAR)(x)+2) /* Interrupt Identification Register */

Definition at line 120 of file serial.h.

◆ SER_LCR

#define SER_LCR ( x ) ((PUCHAR)(x)+3) /* Line Control Register */

Definition at line 135 of file serial.h.

◆ SER_LSR

#define SER_LSR ( x ) ((PUCHAR)(x)+5) /* Line Status Register */

Definition at line 152 of file serial.h.

◆ SER_MCR

#define SER_MCR ( x ) ((PUCHAR)(x)+4) /* Modem Control Register */

Definition at line 149 of file serial.h.

◆ SER_MSR

#define SER_MSR ( x ) ((PUCHAR)(x)+6) /* Modem Status Register */

Definition at line 161 of file serial.h.

◆ SER_RBR

#define SER_RBR ( x ) ((PUCHAR)(x)+0) /* Receive Register */

Definition at line 109 of file serial.h.

◆ SER_SCR

#define SER_SCR ( x ) ((PUCHAR)(x)+7) /* Scratch Pad Register, Uart >= Uart16450 */

Definition at line 170 of file serial.h.

◆ SER_THR

#define SER_THR ( x ) ((PUCHAR)(x)+0) /* Transmit Register */

Definition at line 110 of file serial.h.

◆ SERIAL_TAG

#define SERIAL_TAG 'lreS'

Definition at line 100 of file serial.h.

◆ SI_MSR_RI

#define SI_MSR_RI SERIAL_RI_STATE /* Ring Indicator */

Definition at line 168 of file serial.h.

◆ SR_FCR_14_BYTES

#define SR_FCR_14_BYTES (0xC0 | SR_FCR_ENABLE_FIFO)

Definition at line 134 of file serial.h.

◆ SR_FCR_1_BYTE

#define SR_FCR_1_BYTE (0x00 | SR_FCR_ENABLE_FIFO)

Definition at line 131 of file serial.h.

◆ SR_FCR_4_BYTES

#define SR_FCR_4_BYTES (0x40 | SR_FCR_ENABLE_FIFO)

Definition at line 132 of file serial.h.

◆ SR_FCR_8_BYTES

#define SR_FCR_8_BYTES (0x80 | SR_FCR_ENABLE_FIFO)

Definition at line 133 of file serial.h.

◆ SR_FCR_CLEAR_RCVR

#define SR_FCR_CLEAR_RCVR (0x02 | SR_FCR_ENABLE_FIFO)

Definition at line 129 of file serial.h.

◆ SR_FCR_CLEAR_XMIT

#define SR_FCR_CLEAR_XMIT (0x04 | SR_FCR_ENABLE_FIFO)

Definition at line 130 of file serial.h.

◆ SR_FCR_ENABLE_FIFO

#define SR_FCR_ENABLE_FIFO 0x01

Definition at line 128 of file serial.h.

◆ SR_IER_DATA_RECEIVED

#define SR_IER_DATA_RECEIVED 0x01

Definition at line 113 of file serial.h.

◆ SR_IER_LOW_POWER

#define SR_IER_LOW_POWER 0x20 /* Uart >= 16750 */

Definition at line 118 of file serial.h.

◆ SR_IER_LSR_CHANGE

#define SR_IER_LSR_CHANGE 0x04

Definition at line 115 of file serial.h.

◆ SR_IER_MSR_CHANGE

#define SR_IER_MSR_CHANGE 0x08

Definition at line 116 of file serial.h.

◆ SR_IER_SLEEP_MODE

#define SR_IER_SLEEP_MODE 0x10 /* Uart >= 16750 */

Definition at line 117 of file serial.h.

◆ SR_IER_THR_EMPTY

#define SR_IER_THR_EMPTY 0x02

Definition at line 114 of file serial.h.

◆ SR_IIR_DATA_RECEIVED

#define SR_IIR_DATA_RECEIVED (SR_IIR_SELF | 4)

Definition at line 125 of file serial.h.

◆ SR_IIR_ERROR

#define SR_IIR_ERROR (SR_IIR_SELF | 6)

Definition at line 126 of file serial.h.

◆ SR_IIR_ID_MASK

#define SR_IIR_ID_MASK 0x07

Definition at line 122 of file serial.h.

◆ SR_IIR_MSR_CHANGE

#define SR_IIR_MSR_CHANGE SR_IIR_SELF

Definition at line 123 of file serial.h.

◆ SR_IIR_SELF

#define SR_IIR_SELF 0x00

Definition at line 121 of file serial.h.

◆ SR_IIR_THR_EMPTY

#define SR_IIR_THR_EMPTY (SR_IIR_SELF | 2)

Definition at line 124 of file serial.h.

◆ SR_LCR_BRK

#define SR_LCR_BRK 0x40

Definition at line 147 of file serial.h.

◆ SR_LCR_CS5

#define SR_LCR_CS5 0x00

Definition at line 136 of file serial.h.

◆ SR_LCR_CS6

#define SR_LCR_CS6 0x01

Definition at line 137 of file serial.h.

◆ SR_LCR_CS7

#define SR_LCR_CS7 0x02

Definition at line 138 of file serial.h.

◆ SR_LCR_CS8

#define SR_LCR_CS8 0x03

Definition at line 139 of file serial.h.

◆ SR_LCR_DLAB

#define SR_LCR_DLAB 0x80

Definition at line 148 of file serial.h.

◆ SR_LCR_PEV

#define SR_LCR_PEV 0x18

Definition at line 144 of file serial.h.

◆ SR_LCR_PMK

#define SR_LCR_PMK 0x28

Definition at line 145 of file serial.h.

◆ SR_LCR_PNO

#define SR_LCR_PNO 0x00

Definition at line 142 of file serial.h.

◆ SR_LCR_POD

#define SR_LCR_POD 0x08

Definition at line 143 of file serial.h.

◆ SR_LCR_PSP

#define SR_LCR_PSP 0x38

Definition at line 146 of file serial.h.

◆ SR_LCR_ST1

#define SR_LCR_ST1 0x00

Definition at line 140 of file serial.h.

◆ SR_LCR_ST2

#define SR_LCR_ST2 0x04

Definition at line 141 of file serial.h.

◆ SR_LSR_BREAK_INT

#define SR_LSR_BREAK_INT 0x10

Definition at line 157 of file serial.h.

◆ SR_LSR_DATA_RECEIVED

#define SR_LSR_DATA_RECEIVED 0x01

Definition at line 153 of file serial.h.

◆ SR_LSR_ERROR_IN_FIFO

#define SR_LSR_ERROR_IN_FIFO 0x80 /* Uart >= 16550A */

Definition at line 160 of file serial.h.

◆ SR_LSR_FRAMING_ERROR

#define SR_LSR_FRAMING_ERROR 0x08

Definition at line 156 of file serial.h.

◆ SR_LSR_OVERRUN_ERROR

#define SR_LSR_OVERRUN_ERROR 0x02

Definition at line 154 of file serial.h.

◆ SR_LSR_PARITY_ERROR

#define SR_LSR_PARITY_ERROR 0x04

Definition at line 155 of file serial.h.

◆ SR_LSR_THR_EMPTY

#define SR_LSR_THR_EMPTY 0x20

Definition at line 158 of file serial.h.

◆ SR_LSR_TSR_EMPTY

#define SR_LSR_TSR_EMPTY 0x40

Definition at line 159 of file serial.h.

◆ SR_MCR_DTR

#define SR_MCR_DTR SERIAL_DTR_STATE

Definition at line 150 of file serial.h.

◆ SR_MCR_RTS

#define SR_MCR_RTS SERIAL_RTS_STATE

Definition at line 151 of file serial.h.

◆ SR_MSR_CTS

#define SR_MSR_CTS SERIAL_CTS_STATE /* Clear To Send */

Definition at line 166 of file serial.h.

◆ SR_MSR_CTS_CHANGED

#define SR_MSR_CTS_CHANGED 0x01

Definition at line 162 of file serial.h.

◆ SR_MSR_DCD

#define SR_MSR_DCD SERIAL_DCD_STATE /* Data Carrier Detect */

Definition at line 169 of file serial.h.

◆ SR_MSR_DCD_CHANGED

#define SR_MSR_DCD_CHANGED 0x08

Definition at line 165 of file serial.h.

◆ SR_MSR_DSR

#define SR_MSR_DSR SERIAL_DSR_STATE /* Data Set Ready */

Definition at line 167 of file serial.h.

◆ SR_MSR_DSR_CHANGED

#define SR_MSR_DSR_CHANGED 0x02

Definition at line 163 of file serial.h.

◆ SR_MSR_RI_CHANGED

#define SR_MSR_RI_CHANGED 0x04

Definition at line 164 of file serial.h.

Typedef Documentation

◆ CIRCULAR_BUFFER

typedef struct _CIRCULAR_BUFFER CIRCULAR_BUFFER

◆ PCIRCULAR_BUFFER

typedef struct _CIRCULAR_BUFFER * PCIRCULAR_BUFFER

◆ PSERIAL_DEVICE_EXTENSION

typedef struct _SERIAL_DEVICE_EXTENSION * PSERIAL_DEVICE_EXTENSION

◆ PWORKITEM_DATA

typedef struct _WORKITEM_DATA * PWORKITEM_DATA

◆ SERIAL_DEVICE_EXTENSION

typedef struct _SERIAL_DEVICE_EXTENSION SERIAL_DEVICE_EXTENSION

◆ WORKITEM_DATA

typedef struct _WORKITEM_DATA WORKITEM_DATA

Enumeration Type Documentation

◆ SERIAL_DEVICE_STATE

enum SERIAL_DEVICE_STATE

Enumerator
dsStopped
dsStarted
dsPaused
dsRemoved
dsSurpriseRemoved

Definition at line 20 of file serial.h.

{
  dsStopped,
  dsStarted,
  dsPaused,
  dsRemoved,
  dsSurpriseRemoved
} SERIAL_DEVICE_STATE;

◆ UART_TYPE

enum UART_TYPE

Enumerator
UartUnknown
Uart8250
Uart16450
Uart16550
Uart16550A
Uart16650
Uart16750

Definition at line 29 of file serial.h.

{
    UartUnknown,
    Uart8250,  /* initial version */
    Uart16450, /* + 38.4 Kbps */
    Uart16550, /* + 115 Kbps */
    Uart16550A,/* + FIFO 16 bytes */
    Uart16650, /* + FIFO 32 bytes, 230 Kbps, power management, auto-flow */
    Uart16750  /* + FIFO 64 bytes, 460 Kbps */
} UART_TYPE;

Function Documentation

◆ FreeCircularBuffer()

NTSTATUS FreeCircularBuffer ( IN PCIRCULAR_BUFFER pBuffer )

Definition at line 30 of file circularbuffer.c.

{
    TRACE_(SERIAL, "FreeCircularBuffer(pBuffer %p)\n", pBuffer);
    ASSERT(pBuffer);
    if (pBuffer->Buffer != NULL)
        ExFreePoolWithTag(pBuffer->Buffer, SERIAL_TAG);
    return STATUS_SUCCESS;
}

Referenced by SerialAddDeviceInternal().

◆ GetNumberOfElementsInCircularBuffer()

ULONG GetNumberOfElementsInCircularBuffer ( IN PCIRCULAR_BUFFER pBuffer )

Definition at line 50 of file circularbuffer.c.

{
    TRACE_(SERIAL, "GetNumberOfElementsInCircularBuffer(pBuffer %p)\n", pBuffer);
    ASSERT(pBuffer);
    return (pBuffer->WritePosition + pBuffer->Length - pBuffer->ReadPosition) % pBuffer->Length;
}

Referenced by SerialInterruptService().

◆ IncreaseCircularBufferSize()

NTSTATUS IncreaseCircularBufferSize	(	IN PCIRCULAR_BUFFER	pBuffer,
		IN ULONG	NewBufferSize
	)

Definition at line 91 of file circularbuffer.c.

{
    PUCHAR NewBuffer;
 
    TRACE_(SERIAL, "IncreaseCircularBufferSize(pBuffer %p, NewBufferSize %lu)\n", pBuffer, NewBufferSize);
    ASSERT(pBuffer);
    ASSERT(pBuffer->Length);
    if (pBuffer->Length > NewBufferSize)
        return STATUS_INVALID_PARAMETER;
    else if (pBuffer->Length == NewBufferSize)
        return STATUS_SUCCESS;
 
    NewBuffer = (PUCHAR)ExAllocatePoolWithTag(NonPagedPool, NewBufferSize * sizeof(UCHAR), SERIAL_TAG);
    if (!NewBuffer)
        return STATUS_INSUFFICIENT_RESOURCES;
    RtlCopyMemory(NewBuffer, pBuffer->Buffer, pBuffer->Length * sizeof(UCHAR));
    ExFreePoolWithTag(pBuffer->Buffer, SERIAL_TAG);
    pBuffer->Buffer = NewBuffer;
    pBuffer->Length = NewBufferSize;
    return STATUS_SUCCESS;
}

Referenced by SerialDeviceControl().

◆ InitializeCircularBuffer()

NTSTATUS InitializeCircularBuffer	(	IN PCIRCULAR_BUFFER	pBuffer,
		IN ULONG	BufferSize
	)

Definition at line 15 of file circularbuffer.c.

{
    TRACE_(SERIAL, "InitializeCircularBuffer(pBuffer %p, BufferSize %lu)\n", pBuffer, BufferSize);
    ASSERT(pBuffer);
    pBuffer->Buffer = (PUCHAR)ExAllocatePoolWithTag(NonPagedPool, BufferSize * sizeof(UCHAR), SERIAL_TAG);
    if (!pBuffer->Buffer)
        return STATUS_INSUFFICIENT_RESOURCES;
    pBuffer->Length = BufferSize;
    pBuffer->ReadPosition = pBuffer->WritePosition = 0;
    return STATUS_SUCCESS;
}

Referenced by SerialAddDeviceInternal().

◆ IsCircularBufferEmpty()

BOOLEAN IsCircularBufferEmpty ( IN PCIRCULAR_BUFFER pBuffer )

Definition at line 41 of file circularbuffer.c.

{
    TRACE_(SERIAL, "IsCircularBufferEmpty(pBuffer %p)\n", pBuffer);
    ASSERT(pBuffer);
    return (pBuffer->ReadPosition == pBuffer->WritePosition);
}

Referenced by PopCircularBufferEntry(), ReadBytes(), and SerialSendByte().

◆ PopCircularBufferEntry()

NTSTATUS PopCircularBufferEntry	(	IN PCIRCULAR_BUFFER	pBuffer,
		OUT PUCHAR	Entry
	)

Definition at line 76 of file circularbuffer.c.

{
    TRACE_(SERIAL, "PopCircularBufferEntry(pBuffer %p)\n", pBuffer);
    ASSERT(pBuffer);
    ASSERT(pBuffer->Length);
    if (IsCircularBufferEmpty(pBuffer))
        return STATUS_ARRAY_BOUNDS_EXCEEDED;
    *Entry = pBuffer->Buffer[pBuffer->ReadPosition];
    pBuffer->ReadPosition = (pBuffer->ReadPosition + 1) % pBuffer->Length;
    return STATUS_SUCCESS;
}

Referenced by ReadBytes(), and SerialSendByte().

◆ PushCircularBufferEntry()

NTSTATUS PushCircularBufferEntry	(	IN PCIRCULAR_BUFFER	pBuffer,
		IN UCHAR	Entry
	)

Definition at line 59 of file circularbuffer.c.

{
    ULONG NextPosition;
    TRACE_(SERIAL, "PushCircularBufferEntry(pBuffer %p, Entry 0x%x)\n", pBuffer, Entry);
    ASSERT(pBuffer);
    ASSERT(pBuffer->Length);
    NextPosition = (pBuffer->WritePosition + 1) % pBuffer->Length;
    if (NextPosition == pBuffer->ReadPosition)
        return STATUS_BUFFER_TOO_SMALL;
    pBuffer->Buffer[pBuffer->WritePosition] = Entry;
    pBuffer->WritePosition = NextPosition;
    return STATUS_SUCCESS;
}

Referenced by SerialReceiveByte(), and SerialWrite().

◆ SerialAddDeviceInternal()

NTSTATUS NTAPI SerialAddDeviceInternal	(	IN PDRIVER_OBJECT	DriverObject,
		IN PDEVICE_OBJECT	Pdo,
		IN UART_TYPE	UartType,
		IN PULONG pComPortNumber	OPTIONAL,
		OUT PDEVICE_OBJECT *pFdo	OPTIONAL
	)

Definition at line 18 of file pnp.c.

{
    PDEVICE_OBJECT Fdo = NULL;
    PSERIAL_DEVICE_EXTENSION DeviceExtension = NULL;
    NTSTATUS Status;
    WCHAR DeviceNameBuffer[32];
    UNICODE_STRING DeviceName;
 
    TRACE_(SERIAL, "SerialAddDeviceInternal()\n");
 
    ASSERT(DriverObject);
    ASSERT(Pdo);
 
    /* Create new device object */
    swprintf(DeviceNameBuffer, L"\\Device\\Serial%lu", IoGetConfigurationInformation()->SerialCount);
    RtlInitUnicodeString(&DeviceName, DeviceNameBuffer);
    Status = IoCreateDevice(DriverObject,
                            sizeof(SERIAL_DEVICE_EXTENSION),
                            &DeviceName,
                            FILE_DEVICE_SERIAL_PORT,
                            FILE_DEVICE_SECURE_OPEN,
                            FALSE,
                            &Fdo);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "IoCreateDevice() failed with status 0x%08x\n", Status);
        Fdo = NULL;
        goto ByeBye;
    }
    DeviceExtension = (PSERIAL_DEVICE_EXTENSION)Fdo->DeviceExtension;
    RtlZeroMemory(DeviceExtension, sizeof(SERIAL_DEVICE_EXTENSION));
 
    /* Register device interface */
    Status = IoRegisterDeviceInterface(Pdo, &GUID_DEVINTERFACE_COMPORT, NULL, &DeviceExtension->SerialInterfaceName);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "IoRegisterDeviceInterface() failed with status 0x%08x\n", Status);
        goto ByeBye;
    }
 
    DeviceExtension->SerialPortNumber = IoGetConfigurationInformation()->SerialCount++;
    if (pComPortNumber == NULL)
        DeviceExtension->ComPort = DeviceExtension->SerialPortNumber + 1;
    else
        DeviceExtension->ComPort = *pComPortNumber;
    DeviceExtension->Pdo = Pdo;
    DeviceExtension->PnpState = dsStopped;
    DeviceExtension->UartType = UartType;
    Status = InitializeCircularBuffer(&DeviceExtension->InputBuffer, 16);
    if (!NT_SUCCESS(Status)) goto ByeBye;
    Status = InitializeCircularBuffer(&DeviceExtension->OutputBuffer, 16);
    if (!NT_SUCCESS(Status)) goto ByeBye;
    IoInitializeRemoveLock(&DeviceExtension->RemoveLock, SERIAL_TAG, 0, 0);
    KeInitializeSpinLock(&DeviceExtension->InputBufferLock);
    KeInitializeSpinLock(&DeviceExtension->OutputBufferLock);
    KeInitializeEvent(&DeviceExtension->InputBufferNotEmpty, NotificationEvent, FALSE);
    KeInitializeDpc(&DeviceExtension->ReceivedByteDpc, SerialReceiveByte, DeviceExtension);
    KeInitializeDpc(&DeviceExtension->SendByteDpc, SerialSendByte, DeviceExtension);
    KeInitializeDpc(&DeviceExtension->CompleteIrpDpc, SerialCompleteIrp, DeviceExtension);
    Status = IoAttachDeviceToDeviceStackSafe(Fdo, Pdo, &DeviceExtension->LowerDevice);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "IoAttachDeviceToDeviceStackSafe() failed with status 0x%08x\n", Status);
        goto ByeBye;
    }
    if (DeviceExtension->LowerDevice->Flags & DO_POWER_PAGABLE)
        Fdo->Flags |= DO_POWER_PAGABLE;
    if (DeviceExtension->LowerDevice->Flags & DO_BUFFERED_IO)
        Fdo->Flags |= DO_BUFFERED_IO;
    if (DeviceExtension->LowerDevice->Flags & DO_DIRECT_IO)
        Fdo->Flags |= DO_DIRECT_IO;
 
    /* Choose default strategy */
    if ((Fdo->Flags & (DO_BUFFERED_IO | DO_DIRECT_IO)) == 0)
        Fdo->Flags |= DO_BUFFERED_IO;
 
    Fdo->Flags &= ~DO_DEVICE_INITIALIZING;
    if (pFdo)
    {
        *pFdo = Fdo;
    }
 
    return STATUS_SUCCESS;
 
ByeBye:
    if (Fdo)
    {
        FreeCircularBuffer(&DeviceExtension->InputBuffer);
        FreeCircularBuffer(&DeviceExtension->OutputBuffer);
        IoDeleteDevice(Fdo);
    }
    return Status;
}

Referenced by SerialAddDevice().

◆ SerialCompleteIrp()

VOID NTAPI SerialCompleteIrp	(	IN PKDPC	Dpc,
		IN PVOID	pDeviceExtension,
		IN PVOID	pIrp,
		IN PVOID	Unused
	)

Definition at line 105 of file misc.c.

{
    IoCompleteRequest((PIRP)pIrp, IO_NO_INCREMENT);
}

Referenced by SerialAddDeviceInternal().

◆ SerialDetectUartType()

UART_TYPE SerialDetectUartType ( IN PUCHAR ComPortBase )

Definition at line 16 of file legacy.c.

{
    UCHAR Lcr, TestLcr;
    UCHAR OldScr, Scr5A, ScrA5;
    BOOLEAN FifoEnabled;
    UCHAR NewFifoStatus;
 
    Lcr = READ_PORT_UCHAR(SER_LCR(BaseAddress));
    WRITE_PORT_UCHAR(SER_LCR(BaseAddress), Lcr ^ 0xFF);
    TestLcr = READ_PORT_UCHAR(SER_LCR(BaseAddress)) ^ 0xFF;
    WRITE_PORT_UCHAR(SER_LCR(BaseAddress), Lcr);
 
    /* Accessing the LCR must work for a usable serial port */
    if (TestLcr != Lcr)
        return UartUnknown;
 
    /* Ensure that all following accesses are done as required */
    READ_PORT_UCHAR(SER_RBR(BaseAddress));
    READ_PORT_UCHAR(SER_IER(BaseAddress));
    READ_PORT_UCHAR(SER_IIR(BaseAddress));
    READ_PORT_UCHAR(SER_LCR(BaseAddress));
    READ_PORT_UCHAR(SER_MCR(BaseAddress));
    READ_PORT_UCHAR(SER_LSR(BaseAddress));
    READ_PORT_UCHAR(SER_MSR(BaseAddress));
    READ_PORT_UCHAR(SER_SCR(BaseAddress));
 
    /* Test scratch pad */
    OldScr = READ_PORT_UCHAR(SER_SCR(BaseAddress));
    WRITE_PORT_UCHAR(SER_SCR(BaseAddress), 0x5A);
    Scr5A = READ_PORT_UCHAR(SER_SCR(BaseAddress));
    WRITE_PORT_UCHAR(SER_SCR(BaseAddress), 0xA5);
    ScrA5 = READ_PORT_UCHAR(SER_SCR(BaseAddress));
    WRITE_PORT_UCHAR(SER_SCR(BaseAddress), OldScr);
 
    /* When non-functional, we have a 8250 */
    if (Scr5A != 0x5A || ScrA5 != 0xA5)
        return Uart8250;
 
    /* Test FIFO type */
    FifoEnabled = (READ_PORT_UCHAR(SER_IIR(BaseAddress)) & 0x80) != 0;
    WRITE_PORT_UCHAR(SER_FCR(BaseAddress), SR_FCR_ENABLE_FIFO);
    NewFifoStatus = READ_PORT_UCHAR(SER_IIR(BaseAddress)) & 0xC0;
    if (!FifoEnabled)
        WRITE_PORT_UCHAR(SER_FCR(BaseAddress), 0);
    switch (NewFifoStatus)
    {
        case 0x00:
            return Uart16450;
        case 0x40:
        case 0x80:
            /* Not sure about this but the documentation says that 0x40
             * indicates an unusable FIFO but my tests only worked
             * with 0x80 */
            return Uart16550;
    }
 
    /* FIFO is only functional for 16550A+ */
    return Uart16550A;
}

Referenced by SerialPnpStartDevice().

◆ SerialPnpStartDevice()

NTSTATUS NTAPI SerialPnpStartDevice	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PCM_RESOURCE_LIST	ResourceList,
		IN PCM_RESOURCE_LIST	ResourceListTranslated
	)

Definition at line 136 of file pnp.c.

{
    PSERIAL_DEVICE_EXTENSION DeviceExtension;
    WCHAR DeviceNameBuffer[32];
    UNICODE_STRING DeviceName;
    WCHAR LinkNameBuffer[32];
    UNICODE_STRING LinkName;
    WCHAR ComPortBuffer[32];
    UNICODE_STRING ComPort;
    ULONG Vector = 0;
    ULONG i;
    UCHAR IER;
    KIRQL Dirql;
    KAFFINITY Affinity = 0;
    KINTERRUPT_MODE InterruptMode = Latched;
    BOOLEAN ShareInterrupt = TRUE;
    OBJECT_ATTRIBUTES objectAttributes;
    PUCHAR ComPortBase;
    UNICODE_STRING KeyName;
    HANDLE hKey;
    NTSTATUS Status;
 
    DeviceExtension = (PSERIAL_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
 
    ASSERT(DeviceExtension);
 
    if (!ResourceList)
    {
        WARN_(SERIAL, "No allocated resources sent to driver\n");
        return STATUS_INSUFFICIENT_RESOURCES;
    }
    if (ResourceList->Count != 1)
    {
        WARN_(SERIAL, "Wrong number of allocated resources sent to driver\n");
        return STATUS_INSUFFICIENT_RESOURCES;
    }
    if (ResourceList->List[0].PartialResourceList.Version != 1
     || ResourceList->List[0].PartialResourceList.Revision != 1
     || ResourceListTranslated->List[0].PartialResourceList.Version != 1
     || ResourceListTranslated->List[0].PartialResourceList.Revision != 1)
    {
        WARN_(SERIAL, "Revision mismatch: %u.%u != 1.1 or %u.%u != 1.1\n",
            ResourceList->List[0].PartialResourceList.Version,
            ResourceList->List[0].PartialResourceList.Revision,
            ResourceListTranslated->List[0].PartialResourceList.Version,
            ResourceListTranslated->List[0].PartialResourceList.Revision);
        return STATUS_REVISION_MISMATCH;
    }
 
    DeviceExtension->BaudRate = 19200;
    DeviceExtension->BaseAddress = 0;
    Dirql = 0;
    for (i = 0; i < ResourceList->List[0].PartialResourceList.Count; i++)
    {
        PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor = &ResourceList->List[0].PartialResourceList.PartialDescriptors[i];
        PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptorTranslated = &ResourceListTranslated->List[0].PartialResourceList.PartialDescriptors[i];
        switch (PartialDescriptor->Type)
        {
            case CmResourceTypePort:
                if (PartialDescriptor->u.Port.Length < 7)
                    return STATUS_INSUFFICIENT_RESOURCES;
                if (DeviceExtension->BaseAddress != 0)
                    return STATUS_UNSUCCESSFUL;
                DeviceExtension->BaseAddress = PartialDescriptor->u.Port.Start.u.LowPart;
                break;
            case CmResourceTypeInterrupt:
                Dirql = (KIRQL)PartialDescriptorTranslated->u.Interrupt.Level;
                Vector = PartialDescriptorTranslated->u.Interrupt.Vector;
                Affinity = PartialDescriptorTranslated->u.Interrupt.Affinity;
                if (PartialDescriptorTranslated->Flags & CM_RESOURCE_INTERRUPT_LATCHED)
                    InterruptMode = Latched;
                else
                    InterruptMode = LevelSensitive;
                ShareInterrupt = (PartialDescriptorTranslated->ShareDisposition == CmResourceShareShared);
                break;
        }
    }
    INFO_(SERIAL, "New COM port. Base = 0x%lx, Irql = %u\n",
        DeviceExtension->BaseAddress, Dirql);
    if (!DeviceExtension->BaseAddress)
        return STATUS_INSUFFICIENT_RESOURCES;
    if (!Dirql)
        return STATUS_INSUFFICIENT_RESOURCES;
    ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
 
    /* Test if we are trying to start the serial port used for debugging */
    INFO_(SERIAL, "Comparing addresses: KdComPortInUse: %p, ComPortBase: %p\n", KdComPortInUse, ComPortBase);
    if (KdComPortInUse == ComPortBase)
    {
        INFO_(SERIAL, "Failing IRP_MN_START_DEVICE as this serial port is used for debugging\n");
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    if (DeviceExtension->UartType == UartUnknown)
        DeviceExtension->UartType = SerialDetectUartType(ComPortBase);
 
    /* Get current settings */
    DeviceExtension->MCR = READ_PORT_UCHAR(SER_MCR(ComPortBase));
    DeviceExtension->MSR = READ_PORT_UCHAR(SER_MSR(ComPortBase));
    DeviceExtension->WaitMask = 0;
 
    /* Set baud rate */
    Status = SerialSetBaudRate(DeviceExtension, DeviceExtension->BaudRate);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "SerialSetBaudRate() failed with status 0x%08x\n", Status);
        return Status;
    }
 
    /* Set line control */
    DeviceExtension->SerialLineControl.StopBits = STOP_BIT_1;
    DeviceExtension->SerialLineControl.Parity = NO_PARITY;
    DeviceExtension->SerialLineControl.WordLength = 8;
    Status = SerialSetLineControl(DeviceExtension, &DeviceExtension->SerialLineControl);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "SerialSetLineControl() failed with status 0x%08x\n", Status);
        return Status;
    }
 
    /* Clear receive/transmit buffers */
    if (DeviceExtension->UartType >= Uart16550A)
    {
        /* 16550 UARTs also have FIFO queues, but they are unusable due to a bug */
        WRITE_PORT_UCHAR(SER_FCR(ComPortBase),
            SR_FCR_CLEAR_RCVR | SR_FCR_CLEAR_XMIT);
    }
 
    /* Create link \DosDevices\COMX -> \Device\SerialX */
    swprintf(DeviceNameBuffer, L"\\Device\\Serial%lu", DeviceExtension->SerialPortNumber);
    swprintf(LinkNameBuffer, L"\\DosDevices\\COM%lu", DeviceExtension->ComPort);
    swprintf(ComPortBuffer, L"COM%lu", DeviceExtension->ComPort);
    RtlInitUnicodeString(&DeviceName, DeviceNameBuffer);
    RtlInitUnicodeString(&LinkName, LinkNameBuffer);
    RtlInitUnicodeString(&ComPort, ComPortBuffer);
    Status = IoCreateSymbolicLink(&LinkName, &DeviceName);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "IoCreateSymbolicLink() failed with status 0x%08x\n", Status);
        return Status;
    }
 
    /* Connect interrupt and enable them */
    Status = IoConnectInterrupt(
        &DeviceExtension->Interrupt, SerialInterruptService,
        DeviceObject, NULL,
        Vector, Dirql, Dirql,
        InterruptMode, ShareInterrupt,
        Affinity, FALSE);
    if (!NT_SUCCESS(Status))
    {
        WARN_(SERIAL, "IoConnectInterrupt() failed with status 0x%08x\n", Status);
        IoSetDeviceInterfaceState(&DeviceExtension->SerialInterfaceName, FALSE);
        IoDeleteSymbolicLink(&LinkName);
        return Status;
    }
 
    /* Write an entry value under HKLM\HARDWARE\DeviceMap\SERIALCOMM */
    /* This step is not mandatory, so don't exit in case of error */
    RtlInitUnicodeString(&KeyName, L"\\Registry\\Machine\\HARDWARE\\DeviceMap\\SERIALCOMM");
    InitializeObjectAttributes(&objectAttributes, &KeyName, OBJ_CASE_INSENSITIVE | OBJ_KERNEL_HANDLE, NULL, NULL);
    Status = ZwCreateKey(&hKey, KEY_SET_VALUE, &objectAttributes, 0, NULL, REG_OPTION_VOLATILE, NULL);
    if (NT_SUCCESS(Status))
    {
        /* Key = \Device\Serialx, Value = COMx */
        ZwSetValueKey(hKey, &DeviceName, 0, REG_SZ, ComPortBuffer, ComPort.Length + sizeof(WCHAR));
        ZwClose(hKey);
    }
 
    DeviceExtension->PnpState = dsStarted;
 
    /* Activate interrupt modes */
    IER = READ_PORT_UCHAR(SER_IER(ComPortBase));
    IER |= SR_IER_DATA_RECEIVED | SR_IER_THR_EMPTY | SR_IER_LSR_CHANGE | SR_IER_MSR_CHANGE;
    WRITE_PORT_UCHAR(SER_IER(ComPortBase), IER);
 
    /* Activate DTR, RTS */
    DeviceExtension->MCR |= SR_MCR_DTR | SR_MCR_RTS;
    WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
 
    /* Activate serial interface */
    IoSetDeviceInterfaceState(&DeviceExtension->SerialInterfaceName, TRUE);
    /* We don't really care if the call succeeded or not... */
 
    return STATUS_SUCCESS;
}

Referenced by SerialPnp().

◆ SerialReceiveByte()

VOID NTAPI SerialReceiveByte	(	IN PKDPC	Dpc,
		IN PVOID	pDeviceExtension,
		IN PVOID	Unused1,
		IN PVOID	Unused2
	)

Definition at line 30 of file misc.c.

{
    PSERIAL_DEVICE_EXTENSION DeviceExtension;
    PUCHAR ComPortBase;
    UCHAR Byte;
    KIRQL Irql;
    UCHAR IER;
    NTSTATUS Status;
 
    DeviceExtension = (PSERIAL_DEVICE_EXTENSION)pDeviceExtension;
    ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
 
    KeAcquireSpinLock(&DeviceExtension->InputBufferLock, &Irql);
    while (READ_PORT_UCHAR(SER_LSR(ComPortBase)) & SR_LSR_DATA_RECEIVED)
    {
        Byte = READ_PORT_UCHAR(SER_RBR(ComPortBase));
        INFO_(SERIAL, "Byte received on COM%lu: 0x%02x\n",
            DeviceExtension->ComPort, Byte);
        Status = PushCircularBufferEntry(&DeviceExtension->InputBuffer, Byte);
        if (NT_SUCCESS(Status))
            DeviceExtension->SerialPerfStats.ReceivedCount++;
        else
            DeviceExtension->SerialPerfStats.BufferOverrunErrorCount++;
    }
    KeSetEvent(&DeviceExtension->InputBufferNotEmpty, 0, FALSE);
    KeReleaseSpinLock(&DeviceExtension->InputBufferLock, Irql);
 
    /* allow new interrupts */
    IER = READ_PORT_UCHAR(SER_IER(ComPortBase));
    WRITE_PORT_UCHAR(SER_IER(ComPortBase), IER | SR_IER_DATA_RECEIVED);
}

Referenced by SerialAddDeviceInternal().

◆ SerialSendByte()

VOID NTAPI SerialSendByte	(	IN PKDPC	Dpc,
		IN PVOID	pDeviceExtension,
		IN PVOID	Unused1,
		IN PVOID	Unused2
	)

Definition at line 67 of file misc.c.

{
    PSERIAL_DEVICE_EXTENSION DeviceExtension;
    PUCHAR ComPortBase;
    UCHAR Byte;
    KIRQL Irql;
    UCHAR IER;
    NTSTATUS Status;
 
    DeviceExtension = (PSERIAL_DEVICE_EXTENSION)pDeviceExtension;
    ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
 
    KeAcquireSpinLock(&DeviceExtension->OutputBufferLock, &Irql);
    while (!IsCircularBufferEmpty(&DeviceExtension->OutputBuffer)
        && READ_PORT_UCHAR(SER_LSR(ComPortBase)) & SR_LSR_THR_EMPTY)
    {
        Status = PopCircularBufferEntry(&DeviceExtension->OutputBuffer, &Byte);
        if (!NT_SUCCESS(Status))
            break;
        WRITE_PORT_UCHAR(SER_THR(ComPortBase), Byte);
        INFO_(SERIAL, "Byte sent to COM%lu: 0x%02x\n",
            DeviceExtension->ComPort, Byte);
        DeviceExtension->SerialPerfStats.TransmittedCount++;
    }
    if (!IsCircularBufferEmpty(&DeviceExtension->OutputBuffer))
    {
        /* allow new interrupts */
        IER = READ_PORT_UCHAR(SER_IER(ComPortBase));
        WRITE_PORT_UCHAR(SER_IER(ComPortBase), IER | SR_IER_THR_EMPTY);
    }
    KeReleaseSpinLock(&DeviceExtension->OutputBufferLock, Irql);
}

Referenced by SerialAddDeviceInternal(), and SerialWrite().

◆ SerialSetBaudRate()

NTSTATUS NTAPI SerialSetBaudRate	(	IN PSERIAL_DEVICE_EXTENSION	DeviceExtension,
		IN ULONG	NewBaudRate
	)

Definition at line 50 of file devctrl.c.

{
    ULONG BaudRate;
    USHORT divisor;
    PUCHAR ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
    NTSTATUS Status = STATUS_SUCCESS;
 
    if (NewBaudRate == 0)
        return STATUS_INVALID_PARAMETER;
 
    divisor = (USHORT)(BAUD_CLOCK / (CLOCKS_PER_BIT * NewBaudRate));
    BaudRate = BAUD_CLOCK / (CLOCKS_PER_BIT * divisor);
 
    Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
    if (NT_SUCCESS(Status))
    {
        UCHAR Lcr;
        TRACE_(SERIAL, "SerialSetBaudRate(COM%lu, %lu Bauds)\n", DeviceExtension->ComPort, BaudRate);
        /* Set Bit 7 of LCR to expose baud registers */
        Lcr = READ_PORT_UCHAR(SER_LCR(ComPortBase));
        WRITE_PORT_UCHAR(SER_LCR(ComPortBase), Lcr | SR_LCR_DLAB);
        /* Write the baud rate */
        WRITE_PORT_UCHAR(SER_DLL(ComPortBase), divisor & 0xff);
        WRITE_PORT_UCHAR(SER_DLM(ComPortBase), divisor >> 8);
        /* Switch back to normal registers */
        WRITE_PORT_UCHAR(SER_LCR(ComPortBase), Lcr);
 
        IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
    }
 
    if (NT_SUCCESS(Status))
        DeviceExtension->BaudRate = BaudRate;
    return Status;
}

Referenced by SerialDeviceControl(), and SerialPnpStartDevice().

◆ SerialSetLineControl()

NTSTATUS NTAPI SerialSetLineControl	(	IN PSERIAL_DEVICE_EXTENSION	DeviceExtension,
		IN PSERIAL_LINE_CONTROL	NewSettings
	)

Definition at line 88 of file devctrl.c.

{
    PUCHAR ComPortBase;
    UCHAR Lcr = 0;
    NTSTATUS Status;
 
    ASSERT(DeviceExtension);
    ASSERT(NewSettings);
 
    TRACE_(SERIAL, "SerialSetLineControl(COM%lu, Settings { %lu %lu %lu })\n",
        DeviceExtension->ComPort, NewSettings->StopBits, NewSettings->Parity, NewSettings->WordLength);
 
    /* Verify parameters */
    switch (NewSettings->WordLength)
    {
        case 5: Lcr |= SR_LCR_CS5; break;
        case 6: Lcr |= SR_LCR_CS6; break;
        case 7: Lcr |= SR_LCR_CS7; break;
        case 8: Lcr |= SR_LCR_CS8; break;
        default: return STATUS_INVALID_PARAMETER;
    }
 
    if (NewSettings->WordLength < 5 || NewSettings->WordLength > 8)
        return STATUS_INVALID_PARAMETER;
 
    switch (NewSettings->Parity)
    {
        case NO_PARITY:    Lcr |= SR_LCR_PNO; break;
        case ODD_PARITY:   Lcr |= SR_LCR_POD; break;
        case EVEN_PARITY:  Lcr |= SR_LCR_PEV; break;
        case MARK_PARITY:  Lcr |= SR_LCR_PMK; break;
        case SPACE_PARITY: Lcr |= SR_LCR_PSP; break;
        default: return STATUS_INVALID_PARAMETER;
    }
 
    switch (NewSettings->StopBits)
    {
        case STOP_BIT_1:
            Lcr |= SR_LCR_ST1;
            break;
        case STOP_BITS_1_5:
            if (NewSettings->WordLength != 5)
                return STATUS_INVALID_PARAMETER;
            Lcr |= SR_LCR_ST2;
            break;
        case STOP_BITS_2:
            if (NewSettings->WordLength < 6 || NewSettings->WordLength > 8)
                return STATUS_INVALID_PARAMETER;
            Lcr |= SR_LCR_ST2;
            break;
        default:
            return STATUS_INVALID_PARAMETER;
    }
 
    /* Update current parameters */
    ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
    Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
    if (!NT_SUCCESS(Status))
        return Status;
    WRITE_PORT_UCHAR(SER_LCR(ComPortBase), Lcr);
 
    /* Read junk out of RBR */
    READ_PORT_UCHAR(SER_RBR(ComPortBase));
    IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
 
    if (NT_SUCCESS(Status))
        DeviceExtension->SerialLineControl = *NewSettings;
 
    return Status;
}

Referenced by SerialDeviceControl(), and SerialPnpStartDevice().

Variable Documentation

◆ ForwardIrpAndForget

DRIVER_DISPATCH ForwardIrpAndForget

Definition at line 245 of file serial.h.

◆ SerialAddDevice

DRIVER_ADD_DEVICE SerialAddDevice

Definition at line 280 of file serial.h.

Referenced by DriverEntry().

◆ SerialCleanup

DRIVER_DISPATCH SerialCleanup

Definition at line 209 of file serial.h.

Referenced by DriverEntry().

◆ SerialClose

DRIVER_DISPATCH SerialClose

Definition at line 213 of file serial.h.

Referenced by DriverEntry().

◆ SerialCreate

DRIVER_DISPATCH SerialCreate

Definition at line 217 of file serial.h.

Referenced by DriverEntry().

◆ SerialDeviceControl

DRIVER_DISPATCH SerialDeviceControl

Definition at line 221 of file serial.h.

Referenced by DriverEntry().

◆ SerialInterruptService

KSERVICE_ROUTINE SerialInterruptService

Definition at line 268 of file serial.h.

Referenced by SerialPnpStartDevice().

◆ SerialPnp

DRIVER_DISPATCH SerialPnp

Definition at line 288 of file serial.h.

Referenced by DriverEntry().

◆ SerialPower

DRIVER_DISPATCH SerialPower

Definition at line 292 of file serial.h.

Referenced by DriverEntry().

◆ SerialQueryInformation

DRIVER_DISPATCH SerialQueryInformation

Definition at line 235 of file serial.h.

Referenced by DriverEntry().

◆ SerialRead

DRIVER_DISPATCH SerialRead

Definition at line 296 of file serial.h.

Referenced by DriverEntry().

◆ SerialWrite

DRIVER_DISPATCH SerialWrite

Definition at line 297 of file serial.h.

Referenced by DriverEntry().

Variables
DRIVER_DISPATCH	SerialCleanup

DRIVER_DISPATCH	SerialClose

DRIVER_DISPATCH	SerialCreate

DRIVER_DISPATCH	SerialDeviceControl

DRIVER_DISPATCH	SerialQueryInformation

DRIVER_DISPATCH	ForwardIrpAndForget

KSERVICE_ROUTINE	SerialInterruptService

DRIVER_ADD_DEVICE	SerialAddDevice

DRIVER_DISPATCH	SerialPnp

DRIVER_DISPATCH	SerialPower

DRIVER_DISPATCH	SerialRead

DRIVER_DISPATCH	SerialWrite

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ BAUD_CLOCK

◆ CLOCKS_PER_BIT

◆ COMMPROP_INITIALIZED

◆ INFINITE

◆ PST_RS232

◆ SER_DLL

◆ SER_DLM

◆ SER_FCR

◆ SER_IER

◆ SER_IIR

◆ SER_LCR

◆ SER_LSR

◆ SER_MCR

◆ SER_MSR

◆ SER_RBR

◆ SER_SCR

◆ SER_THR

◆ SERIAL_TAG

◆ SI_MSR_RI

◆ SR_FCR_14_BYTES

◆ SR_FCR_1_BYTE

◆ SR_FCR_4_BYTES

◆ SR_FCR_8_BYTES

◆ SR_FCR_CLEAR_RCVR

◆ SR_FCR_CLEAR_XMIT

◆ SR_FCR_ENABLE_FIFO

◆ SR_IER_DATA_RECEIVED

◆ SR_IER_LOW_POWER

◆ SR_IER_LSR_CHANGE

◆ SR_IER_MSR_CHANGE

◆ SR_IER_SLEEP_MODE

◆ SR_IER_THR_EMPTY

◆ SR_IIR_DATA_RECEIVED

◆ SR_IIR_ERROR

◆ SR_IIR_ID_MASK

◆ SR_IIR_MSR_CHANGE

◆ SR_IIR_SELF

◆ SR_IIR_THR_EMPTY

◆ SR_LCR_BRK

◆ SR_LCR_CS5

◆ SR_LCR_CS6

◆ SR_LCR_CS7

◆ SR_LCR_CS8

◆ SR_LCR_DLAB

◆ SR_LCR_PEV

◆ SR_LCR_PMK

◆ SR_LCR_PNO

◆ SR_LCR_POD

◆ SR_LCR_PSP

◆ SR_LCR_ST1

◆ SR_LCR_ST2

◆ SR_LSR_BREAK_INT

◆ SR_LSR_DATA_RECEIVED

◆ SR_LSR_ERROR_IN_FIFO

◆ SR_LSR_FRAMING_ERROR

◆ SR_LSR_OVERRUN_ERROR

◆ SR_LSR_PARITY_ERROR

◆ SR_LSR_THR_EMPTY

◆ SR_LSR_TSR_EMPTY

◆ SR_MCR_DTR

◆ SR_MCR_RTS

◆ SR_MSR_CTS

◆ SR_MSR_CTS_CHANGED

◆ SR_MSR_DCD

◆ SR_MSR_DCD_CHANGED

◆ SR_MSR_DSR

◆ SR_MSR_DSR_CHANGED

◆ SR_MSR_RI_CHANGED

Typedef Documentation

◆ CIRCULAR_BUFFER

◆ PCIRCULAR_BUFFER

◆ PSERIAL_DEVICE_EXTENSION

◆ PWORKITEM_DATA