devctrl.c

Go to the documentation of this file.

/*
 * COPYRIGHT:       See COPYING in the top level directory
 * PROJECT:         Serial port driver
 * FILE:            drivers/dd/serial/devctrl.c
 * PURPOSE:         Serial IRP_MJ_DEVICE_CONTROL operations
 *
 * PROGRAMMERS:     Hervé Poussineau (hpoussin@reactos.org)
 */

#include "serial.h"

#include <debug.h>

#define IO_METHOD_FROM_CTL_CODE(ctlCode) (ctlCode&0x00000003)

static VOID
SerialGetUserBuffers(
    IN PIRP Irp,
    IN ULONG IoControlCode,
    OUT PVOID* BufferIn,
    OUT PVOID* BufferOut)
{
    ASSERT(Irp);
    ASSERT(BufferIn);
    ASSERT(BufferOut);

    switch (IO_METHOD_FROM_CTL_CODE(IoControlCode))
    {
        case METHOD_BUFFERED:
            *BufferIn = *BufferOut = Irp->AssociatedIrp.SystemBuffer;
            break;
        case METHOD_IN_DIRECT:
        case METHOD_OUT_DIRECT:
            *BufferIn = Irp->AssociatedIrp.SystemBuffer;
            *BufferOut = MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority);
            break;
        case METHOD_NEITHER:
            *BufferIn = IoGetCurrentIrpStackLocation(Irp)->Parameters.DeviceIoControl.Type3InputBuffer;
            *BufferOut = Irp->UserBuffer;
            break;
        default:
            /* Should never happen */
            *BufferIn = NULL;
            *BufferOut = NULL;
            break;
    }
}

NTSTATUS NTAPI
SerialSetBaudRate(
    IN PSERIAL_DEVICE_EXTENSION DeviceExtension,
    IN ULONG NewBaudRate)
{
    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;
}

NTSTATUS NTAPI
SerialSetLineControl(
    IN PSERIAL_DEVICE_EXTENSION DeviceExtension,
    IN PSERIAL_LINE_CONTROL NewSettings)
{
    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;
}

static
BOOLEAN
NTAPI
SerialClearPerfStats(IN PVOID SynchronizeContext)
{
    PSERIAL_DEVICE_EXTENSION DeviceExtension = SynchronizeContext;
    ASSERT(DeviceExtension);
    RtlZeroMemory(&DeviceExtension->SerialPerfStats, sizeof(SERIALPERF_STATS));
    DeviceExtension->BreakInterruptErrorCount = 0;
    return TRUE;
}

static
BOOLEAN
NTAPI
SerialGetPerfStats(IN PVOID SynchronizeContext)
{
    PIRP pIrp = SynchronizeContext;
    PSERIAL_DEVICE_EXTENSION pDeviceExtension;

    ASSERT(pIrp);
    pDeviceExtension = IoGetCurrentIrpStackLocation(pIrp)->DeviceObject->DeviceExtension;

    /*
    * we assume buffer is big enough to hold SerialPerfStats structure
    * caller must verify this
    */
    RtlCopyMemory(pIrp->AssociatedIrp.SystemBuffer,
                  &pDeviceExtension->SerialPerfStats,
                  sizeof(SERIALPERF_STATS));
    return TRUE;
}

static NTSTATUS
SerialGetCommProp(
    OUT PSERIAL_COMMPROP pCommProp,
    IN PSERIAL_DEVICE_EXTENSION DeviceExtension)
{
    ASSERT(pCommProp);

    RtlZeroMemory(pCommProp, sizeof(SERIAL_COMMPROP));

    if (!(pCommProp->ProvSpec1 & COMMPROP_INITIALIZED))
        pCommProp->PacketLength = sizeof(SERIAL_COMMPROP);
    pCommProp->PacketVersion = 2;
    pCommProp->ServiceMask = SERIAL_SP_SERIALCOMM;
    pCommProp->MaxTxQueue = pCommProp->CurrentTxQueue = DeviceExtension->OutputBuffer.Length - 1;
    pCommProp->MaxRxQueue = pCommProp->CurrentRxQueue = DeviceExtension->InputBuffer.Length - 1;
    pCommProp->ProvSubType = PST_RS232;
    pCommProp->ProvCapabilities = SERIAL_PCF_DTRDSR | SERIAL_PCF_INTTIMEOUTS | SERIAL_PCF_PARITY_CHECK
        | SERIAL_PCF_RTSCTS | SERIAL_PCF_SETXCHAR | SERIAL_PCF_SPECIALCHARS | SERIAL_PCF_TOTALTIMEOUTS
        | SERIAL_PCF_XONXOFF;
    pCommProp->SettableParams = SERIAL_SP_BAUD | SERIAL_SP_DATABITS | SERIAL_SP_HANDSHAKING
        | SERIAL_SP_PARITY | SERIAL_SP_PARITY_CHECK | SERIAL_SP_STOPBITS;

    /* SettableBaud is related to Uart type */
    pCommProp->SettableBaud = SERIAL_BAUD_075 | SERIAL_BAUD_110 | SERIAL_BAUD_134_5
        | SERIAL_BAUD_150 | SERIAL_BAUD_300 | SERIAL_BAUD_600 | SERIAL_BAUD_1200
        | SERIAL_BAUD_1800 | SERIAL_BAUD_2400 | SERIAL_BAUD_4800 | SERIAL_BAUD_7200
        | SERIAL_BAUD_9600 | SERIAL_BAUD_USER;
    pCommProp->MaxBaud = SERIAL_BAUD_USER;
    if (DeviceExtension->UartType >= Uart16450)
    {
        pCommProp->SettableBaud |= SERIAL_BAUD_14400 | SERIAL_BAUD_19200 | SERIAL_BAUD_38400;
    }
    if (DeviceExtension->UartType >= Uart16550)
    {
        pCommProp->SettableBaud |= SERIAL_BAUD_56K | SERIAL_BAUD_57600 | SERIAL_BAUD_115200 | SERIAL_BAUD_128K;
    }

    pCommProp->SettableData = SERIAL_DATABITS_5 | SERIAL_DATABITS_6 | SERIAL_DATABITS_7 | SERIAL_DATABITS_8;
    pCommProp->SettableStopParity = SERIAL_STOPBITS_10 | SERIAL_STOPBITS_15 | SERIAL_STOPBITS_20
        | SERIAL_PARITY_NONE | SERIAL_PARITY_ODD | SERIAL_PARITY_EVEN | SERIAL_PARITY_MARK | SERIAL_PARITY_SPACE;

    pCommProp->ProvSpec2 = 0; /* Size of provider-specific data */

    return STATUS_SUCCESS;
}

static NTSTATUS
SerialGetCommStatus(
    OUT PSERIAL_STATUS pSerialStatus,
    IN PSERIAL_DEVICE_EXTENSION DeviceExtension)
{
    KIRQL Irql;

    ASSERT(pSerialStatus);
    RtlZeroMemory(pSerialStatus, sizeof(SERIAL_STATUS));

    pSerialStatus->Errors = 0;
    if (DeviceExtension->BreakInterruptErrorCount)
        pSerialStatus->Errors |= SERIAL_ERROR_BREAK;
    if (DeviceExtension->SerialPerfStats.FrameErrorCount)
        pSerialStatus->Errors |= SERIAL_ERROR_FRAMING;
    if (DeviceExtension->SerialPerfStats.SerialOverrunErrorCount)
        pSerialStatus->Errors |= SERIAL_ERROR_OVERRUN;
    if (DeviceExtension->SerialPerfStats.BufferOverrunErrorCount)
        pSerialStatus->Errors |= SERIAL_ERROR_QUEUEOVERRUN;
    if (DeviceExtension->SerialPerfStats.ParityErrorCount)
        pSerialStatus->Errors |= SERIAL_ERROR_PARITY;

    pSerialStatus->HoldReasons = 0; /* FIXME */

    KeAcquireSpinLock(&DeviceExtension->InputBufferLock, &Irql);
    pSerialStatus->AmountInInQueue = (DeviceExtension->InputBuffer.WritePosition + DeviceExtension->InputBuffer.Length
        - DeviceExtension->InputBuffer.ReadPosition) % DeviceExtension->InputBuffer.Length;
    KeReleaseSpinLock(&DeviceExtension->InputBufferLock, Irql);

    KeAcquireSpinLock(&DeviceExtension->OutputBufferLock, &Irql);
    pSerialStatus->AmountInOutQueue = (DeviceExtension->OutputBuffer.WritePosition + DeviceExtension->OutputBuffer.Length
        - DeviceExtension->OutputBuffer.ReadPosition) % DeviceExtension->OutputBuffer.Length;
    KeReleaseSpinLock(&DeviceExtension->OutputBufferLock, Irql);

    pSerialStatus->EofReceived = FALSE; /* always FALSE */
    pSerialStatus->WaitForImmediate = FALSE; /* always FALSE */

    return STATUS_SUCCESS;
}

NTSTATUS NTAPI
SerialDeviceControl(
    IN PDEVICE_OBJECT DeviceObject,
    IN PIRP Irp)
{
    PIO_STACK_LOCATION Stack;
    ULONG IoControlCode;
    PSERIAL_DEVICE_EXTENSION DeviceExtension;
    ULONG LengthIn, LengthOut;
    ULONG_PTR Information = 0;
    PVOID BufferIn, BufferOut;
    PUCHAR ComPortBase;
    NTSTATUS Status;

    TRACE_(SERIAL, "IRP_MJ_DEVICE_CONTROL dispatch\n");

    Stack = IoGetCurrentIrpStackLocation(Irp);
    LengthIn = Stack->Parameters.DeviceIoControl.InputBufferLength;
    LengthOut = Stack->Parameters.DeviceIoControl.OutputBufferLength;
    DeviceExtension = (PSERIAL_DEVICE_EXTENSION)DeviceObject->DeviceExtension;
    ComPortBase = ULongToPtr(DeviceExtension->BaseAddress);
    IoControlCode = Stack->Parameters.DeviceIoControl.IoControlCode;
    SerialGetUserBuffers(Irp, IoControlCode, &BufferIn, &BufferOut);

    /* FIXME: need to probe buffers */
    /* FIXME: see http://www.osronline.com/ddkx/serial/serref_61bm.htm */
    switch (IoControlCode)
    {
        case IOCTL_SERIAL_CLEAR_STATS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_CLEAR_STATS\n");
            KeSynchronizeExecution(
                DeviceExtension->Interrupt,
                SerialClearPerfStats,
                DeviceExtension);
            Status = STATUS_SUCCESS;
            break;
        }
        case IOCTL_SERIAL_CLR_DTR:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_CLR_DTR\n");
            /* FIXME: If the handshake flow control of the device is configured to
             * automatically use DTR, return STATUS_INVALID_PARAMETER */
            Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
            if (NT_SUCCESS(Status))
            {
                DeviceExtension->MCR &= ~SR_MCR_DTR;
                WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
                IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
            }
            break;
        }
        case IOCTL_SERIAL_CLR_RTS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_CLR_RTS\n");
            /* FIXME: If the handshake flow control of the device is configured to
             * automatically use RTS, return STATUS_INVALID_PARAMETER */
            Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
            if (NT_SUCCESS(Status))
            {
                DeviceExtension->MCR &= ~SR_MCR_RTS;
                WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
                IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
            }
            break;
        }
        case IOCTL_SERIAL_CONFIG_SIZE:
        {
            /* Obsolete on Microsoft Windows 2000+ */
            PULONG pConfigSize;
            TRACE_(SERIAL, "IOCTL_SERIAL_CONFIG_SIZE\n");
            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pConfigSize = (PULONG)BufferOut;
                *pConfigSize = 0;
                Information = sizeof(ULONG);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_BAUD_RATE:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_BAUD_RATE\n");
            if (LengthOut < sizeof(SERIAL_BAUD_RATE))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                ((PSERIAL_BAUD_RATE)BufferOut)->BaudRate = DeviceExtension->BaudRate;
                Information = sizeof(SERIAL_BAUD_RATE);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_CHARS:
        {
            /* FIXME */
            PSERIAL_CHARS pSerialChars;
            ERR_(SERIAL, "IOCTL_SERIAL_GET_CHARS not implemented.\n");
            if (LengthOut < sizeof(SERIAL_CHARS))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pSerialChars = (PSERIAL_CHARS)BufferOut;
                pSerialChars->EofChar = 0;
                pSerialChars->ErrorChar = 0;
                pSerialChars->BreakChar = 0;
                pSerialChars->EventChar = 0;
                pSerialChars->XonChar = 0;
                pSerialChars->XoffChar = 0;
                Information = sizeof(SERIAL_CHARS);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_COMMSTATUS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_COMMSTATUS\n");
            if (LengthOut < sizeof(SERIAL_STATUS))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                Status = SerialGetCommStatus((PSERIAL_STATUS)BufferOut, DeviceExtension);
                Information = sizeof(SERIAL_STATUS);
            }
            break;
        }
        case IOCTL_SERIAL_GET_DTRRTS:
        {
            PULONG pDtrRts;
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_DTRRTS\n");
            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pDtrRts = (PULONG)BufferOut;
                *pDtrRts = 0;
                if (DeviceExtension->MCR & SR_MCR_DTR)
                    *pDtrRts |= SERIAL_DTR_STATE;
                if (DeviceExtension->MCR & SR_MCR_RTS)
                    *pDtrRts |= SERIAL_RTS_STATE;
                Information = sizeof(ULONG);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_HANDFLOW:
        {
            /* FIXME */
            PSERIAL_HANDFLOW pSerialHandflow;
            ERR_(SERIAL, "IOCTL_SERIAL_GET_HANDFLOW not implemented.\n");
            if (LengthOut < sizeof(SERIAL_HANDFLOW))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pSerialHandflow = (PSERIAL_HANDFLOW)BufferOut;
                pSerialHandflow->ControlHandShake = 0;
                pSerialHandflow->FlowReplace = 0;
                pSerialHandflow->XonLimit = 0;
                pSerialHandflow->XoffLimit = 0;
                Information = sizeof(SERIAL_HANDFLOW);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_LINE_CONTROL:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_LINE_CONTROL\n");
            if (LengthOut < sizeof(SERIAL_LINE_CONTROL))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                *((PSERIAL_LINE_CONTROL)BufferOut) = DeviceExtension->SerialLineControl;
                Information = sizeof(SERIAL_LINE_CONTROL);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_MODEM_CONTROL:
        {
            PULONG pMCR;
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_MODEM_CONTROL\n");
            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pMCR = (PULONG)BufferOut;
                *pMCR = DeviceExtension->MCR;
                Information = sizeof(ULONG);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_MODEMSTATUS:
        {
            PULONG pMSR;
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_MODEMSTATUS\n");
            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pMSR = (PULONG)BufferOut;
                *pMSR = DeviceExtension->MSR;
                Information = sizeof(ULONG);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_PROPERTIES:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_PROPERTIES\n");
            if (LengthOut < sizeof(SERIAL_COMMPROP))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                Status = SerialGetCommProp((PSERIAL_COMMPROP)BufferOut, DeviceExtension);
                Information = sizeof(SERIAL_COMMPROP);
            }
            break;
        }
        case IOCTL_SERIAL_GET_STATS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_STATS\n");
            if (LengthOut < sizeof(SERIALPERF_STATS))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                KeSynchronizeExecution(DeviceExtension->Interrupt,
                    SerialGetPerfStats, Irp);
                Information = sizeof(SERIALPERF_STATS);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_TIMEOUTS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_TIMEOUTS\n");
            if (LengthOut != sizeof(SERIAL_TIMEOUTS) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                *(PSERIAL_TIMEOUTS)BufferOut = DeviceExtension->SerialTimeOuts;
                Information = sizeof(SERIAL_TIMEOUTS);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_GET_WAIT_MASK:
        {
            PULONG pWaitMask;
            TRACE_(SERIAL, "IOCTL_SERIAL_GET_WAIT_MASK\n");
            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pWaitMask = (PULONG)BufferOut;
                *pWaitMask = DeviceExtension->WaitMask;
                Information = sizeof(ULONG);
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_IMMEDIATE_CHAR:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_IMMEDIATE_CHAR not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_LSRMST_INSERT:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_LSRMST_INSERT not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_PURGE:
        {
            KIRQL Irql;
            TRACE_(SERIAL, "IOCTL_SERIAL_PURGE\n");
            /* FIXME: SERIAL_PURGE_RXABORT and SERIAL_PURGE_TXABORT
             * should stop current request */
            if (LengthIn != sizeof(ULONG) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                ULONG PurgeMask = *(PULONG)BufferIn;

                Status = STATUS_SUCCESS;
                /* FIXME: use SERIAL_PURGE_RXABORT and SERIAL_PURGE_TXABORT flags */
                if (PurgeMask & SERIAL_PURGE_RXCLEAR)
                {
                    KeAcquireSpinLock(&DeviceExtension->InputBufferLock, &Irql);
                    DeviceExtension->InputBuffer.ReadPosition = DeviceExtension->InputBuffer.WritePosition = 0;
                    if (DeviceExtension->UartType >= Uart16550A)
                    {
                        /* Clear also Uart FIFO */
                        Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                        if (NT_SUCCESS(Status))
                        {
                            WRITE_PORT_UCHAR(SER_FCR(ComPortBase), SR_FCR_CLEAR_RCVR);
                            IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                        }
                    }
                    KeReleaseSpinLock(&DeviceExtension->InputBufferLock, Irql);
                }

                if (PurgeMask & SERIAL_PURGE_TXCLEAR)
                {
                    KeAcquireSpinLock(&DeviceExtension->OutputBufferLock, &Irql);
                    DeviceExtension->OutputBuffer.ReadPosition = DeviceExtension->OutputBuffer.WritePosition = 0;
                    if (DeviceExtension->UartType >= Uart16550A)
                    {
                        /* Clear also Uart FIFO */
                        Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                        if (NT_SUCCESS(Status))
                        {
                            WRITE_PORT_UCHAR(SER_FCR(ComPortBase), SR_FCR_CLEAR_XMIT);
                            IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                        }
                    }
                    KeReleaseSpinLock(&DeviceExtension->OutputBufferLock, Irql);
                }
            }
            break;
        }
        case IOCTL_SERIAL_RESET_DEVICE:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_RESET_DEVICE not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_SET_BAUD_RATE:
        {
            PULONG pNewBaudRate;
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_BAUD_RATE\n");
            if (LengthIn != sizeof(ULONG) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                pNewBaudRate = (PULONG)BufferIn;
                Status = SerialSetBaudRate(DeviceExtension, *pNewBaudRate);
            }
            break;
        }
        case IOCTL_SERIAL_SET_BREAK_OFF:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_BREAK_OFF not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_SET_BREAK_ON:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_BREAK_ON not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_SET_CHARS:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_CHARS not implemented.\n");
            Status = STATUS_SUCCESS;
            break;
        }
        case IOCTL_SERIAL_SET_DTR:
        {
            /* FIXME: If the handshake flow control of the device is configured to
             * automatically use DTR, return STATUS_INVALID_PARAMETER */
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_DTR\n");
            if (!(DeviceExtension->MCR & SR_MCR_DTR))
            {
                Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                if (NT_SUCCESS(Status))
                {
                    DeviceExtension->MCR |= SR_MCR_DTR;
                    WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
                    IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                }
            }
            else
                Status = STATUS_SUCCESS;
            break;
        }
        case IOCTL_SERIAL_SET_FIFO_CONTROL:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_FIFO_CONTROL\n");
            if (LengthIn != sizeof(ULONG) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                if (NT_SUCCESS(Status))
                {
                    WRITE_PORT_UCHAR(SER_FCR(ComPortBase), (UCHAR)((*(PULONG)BufferIn) & 0xff));
                    IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                }
            }
            break;
        }
        case IOCTL_SERIAL_SET_HANDFLOW:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_HANDFLOW not implemented.\n");
            Status = STATUS_SUCCESS;
            break;
        }
        case IOCTL_SERIAL_SET_LINE_CONTROL:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_LINE_CONTROL\n");
            if (LengthIn < sizeof(SERIAL_LINE_CONTROL))
                Status = STATUS_BUFFER_TOO_SMALL;
            else if (BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
                Status = SerialSetLineControl(DeviceExtension, (PSERIAL_LINE_CONTROL)BufferIn);
            break;
        }
        case IOCTL_SERIAL_SET_MODEM_CONTROL:
        {
            PULONG pMCR;
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_MODEM_CONTROL\n");
            if (LengthIn != sizeof(ULONG) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                if (NT_SUCCESS(Status))
                {
                    pMCR = (PULONG)BufferIn;
                    DeviceExtension->MCR = (UCHAR)(*pMCR & 0xff);
                    WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
                    IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                }
            }
            break;
        }
        case IOCTL_SERIAL_SET_QUEUE_SIZE:
        {
            if (LengthIn < sizeof(SERIAL_QUEUE_SIZE ))
                return STATUS_BUFFER_TOO_SMALL;
            else if (BufferIn == NULL)
                return STATUS_INVALID_PARAMETER;
            else
            {
                KIRQL Irql;
                PSERIAL_QUEUE_SIZE NewQueueSize = (PSERIAL_QUEUE_SIZE)BufferIn;
                Status = STATUS_SUCCESS;
                if (NewQueueSize->InSize > DeviceExtension->InputBuffer.Length)
                {
                    KeAcquireSpinLock(&DeviceExtension->InputBufferLock, &Irql);
                    Status = IncreaseCircularBufferSize(&DeviceExtension->InputBuffer, NewQueueSize->InSize);
                    KeReleaseSpinLock(&DeviceExtension->InputBufferLock, Irql);
                }
                if (NT_SUCCESS(Status) && NewQueueSize->OutSize > DeviceExtension->OutputBuffer.Length)
                {
                    KeAcquireSpinLock(&DeviceExtension->OutputBufferLock, &Irql);
                    Status = IncreaseCircularBufferSize(&DeviceExtension->OutputBuffer, NewQueueSize->OutSize);
                    KeReleaseSpinLock(&DeviceExtension->OutputBufferLock, Irql);
                }
            }
            break;
        }
        case IOCTL_SERIAL_SET_RTS:
        {
            /* FIXME: If the handshake flow control of the device is configured to
             * automatically use DTR, return STATUS_INVALID_PARAMETER */
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_RTS\n");
            if (!(DeviceExtension->MCR & SR_MCR_RTS))
            {
                Status = IoAcquireRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                if (NT_SUCCESS(Status))
                {
                    DeviceExtension->MCR |= SR_MCR_RTS;
                    WRITE_PORT_UCHAR(SER_MCR(ComPortBase), DeviceExtension->MCR);
                    IoReleaseRemoveLock(&DeviceExtension->RemoveLock, ULongToPtr(DeviceExtension->ComPort));
                }
            }
            else
                Status = STATUS_SUCCESS;
            break;
        }
        case IOCTL_SERIAL_SET_TIMEOUTS:
        {
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_TIMEOUTS\n");
            if (LengthIn != sizeof(SERIAL_TIMEOUTS) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                DeviceExtension->SerialTimeOuts = *(PSERIAL_TIMEOUTS)BufferIn;
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_SET_WAIT_MASK:
        {
            PULONG pWaitMask = (PULONG)BufferIn;
            TRACE_(SERIAL, "IOCTL_SERIAL_SET_WAIT_MASK\n");

            if (LengthIn != sizeof(ULONG) || BufferIn == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else if (DeviceExtension->WaitOnMaskIrp) /* FIXME: Race condition ; field may be currently in modification */
            {
                WARN_(SERIAL, "An IRP is already currently processed\n");
                Status = STATUS_INVALID_PARAMETER;
            }
            else
            {
                DeviceExtension->WaitMask = *pWaitMask;
                Status = STATUS_SUCCESS;
            }
            break;
        }
        case IOCTL_SERIAL_SET_XOFF:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_XOFF not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_SET_XON:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_SET_XON not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        case IOCTL_SERIAL_WAIT_ON_MASK:
        {
            PIRP WaitingIrp;
            TRACE_(SERIAL, "IOCTL_SERIAL_WAIT_ON_MASK\n");

            if (LengthOut != sizeof(ULONG) || BufferOut == NULL)
                Status = STATUS_INVALID_PARAMETER;
            else
            {
                IoMarkIrpPending(Irp);

                WaitingIrp = InterlockedCompareExchangePointer(
                    (PVOID*)&DeviceExtension->WaitOnMaskIrp,
                    Irp,
                    NULL);

                /* Check if an Irp is already pending */
                if (WaitingIrp != NULL)
                {
                    /* Unable to have a 2nd pending IRP for this IOCTL */
                    WARN_(SERIAL, "Unable to pend a second IRP for IOCTL_SERIAL_WAIT_ON_MASK\n");
                    Irp->IoStatus.Information = 0;
                    Irp->IoStatus.Status = STATUS_INVALID_PARAMETER;
                    IoCompleteRequest(Irp, IO_NO_INCREMENT);
                }
                return STATUS_PENDING;
            }
            break;
        }
        case IOCTL_SERIAL_XOFF_COUNTER:
        {
            /* FIXME */
            ERR_(SERIAL, "IOCTL_SERIAL_XOFF_COUNTER not implemented.\n");
            Status = STATUS_NOT_IMPLEMENTED;
            break;
        }
        default:
        {
            /* Pass Irp to lower driver */
            TRACE_(SERIAL, "Unknown IOCTL code 0x%x\n", Stack->Parameters.DeviceIoControl.IoControlCode);
            IoSkipCurrentIrpStackLocation(Irp);
            return IoCallDriver(DeviceExtension->LowerDevice, Irp);
        }
    }

    Irp->IoStatus.Status = Status;
    if (Status == STATUS_PENDING)
    {
        IoMarkIrpPending(Irp);
    }
    else
    {
        Irp->IoStatus.Information = Information;
        IoCompleteRequest(Irp, IO_NO_INCREMENT);
    }
    return Status;
}