cportlib.h File Reference

#include <ntdef.h>

Include dependency graph for cportlib.h:

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

Go to the source code of this file.

Classes
struct	_CPPORT

Macros
#define	CP_GET_SUCCESS   0
#define	CP_GET_NODATA   1
#define	CP_GET_ERROR   2
#define	CPPORT_FLAG_MODEM_CONTROL   0x02

Typedefs
typedef struct _CPPORT	CPPORT
typedef struct _CPPORT *	PCPPORT

Functions
VOID NTAPI	CpEnableFifo (IN PUCHAR Address, IN BOOLEAN Enable)
VOID NTAPI	CpSetBaud (IN PCPPORT Port, IN ULONG BaudRate)
NTSTATUS NTAPI	CpInitialize (IN PCPPORT Port, IN PUCHAR Address, IN ULONG BaudRate)
BOOLEAN NTAPI	CpDoesPortExist (IN PUCHAR Address)
UCHAR NTAPI	CpReadLsr (IN PCPPORT Port, IN UCHAR ExpectedValue)
USHORT NTAPI	CpGetByte (IN PCPPORT Port, OUT PUCHAR Byte, IN BOOLEAN Wait, IN BOOLEAN Poll)
VOID NTAPI	CpPutByte (IN PCPPORT Port, IN UCHAR Byte)

Macro Definition Documentation

CP_GET_ERROR

#define CP_GET_ERROR   2

Definition at line 20 of file cportlib.h.

CP_GET_NODATA

#define CP_GET_NODATA   1

Definition at line 19 of file cportlib.h.

CP_GET_SUCCESS

#define CP_GET_SUCCESS   0

Definition at line 18 of file cportlib.h.

CPPORT_FLAG_MODEM_CONTROL

#define CPPORT_FLAG_MODEM_CONTROL   0x02

Definition at line 25 of file cportlib.h.

Typedef Documentation

CPPORT

typedef struct _CPPORT CPPORT

PCPPORT

typedef struct _CPPORT * PCPPORT

Function Documentation

CpDoesPortExist()

BOOLEAN NTAPI CpDoesPortExist

(

IN PUCHAR

Address

)

Definition at line 224 of file cport.c.

{
    return ( ComPortTest1(Address) || ComPortTest2(Address) );
}

Referenced by CpInitialize(), DetectKeyboardController(), DetectSerialPorts(), InbvPortInitialize(), KdDebuggerInitialize0(), KdPortInitializeEx(), and WinLdrPortInitialize().

CpEnableFifo()

VOID NTAPI CpEnableFifo	(	IN PUCHAR	Address,
		IN BOOLEAN	Enable
	)

Definition at line 51 of file cport.c.

{
    /* Set FIFO and clear the receive/transmit buffers */
    WRITE_PORT_UCHAR(Address + FIFO_CONTROL_REGISTER,
                     Enable ? SERIAL_FCR_ENABLE | SERIAL_FCR_RCVR_RESET | SERIAL_FCR_TXMT_RESET
                            : SERIAL_FCR_DISABLE);
}

Referenced by CpGetByte(), CpInitialize(), InbvPortEnableFifo(), and WinLdrEnableFifo().

CpGetByte()

USHORT NTAPI CpGetByte	(	IN PCPPORT	Port,
		OUT PUCHAR	Byte,
		IN BOOLEAN	Wait,
		IN BOOLEAN	Poll
	)

Definition at line 253 of file cport.c.

{
    UCHAR Lsr;
    ULONG LimitCount = Wait ? TIMEOUT_COUNT : 1;
 
    /* Handle early read-before-init */
    if (!Port->Address) return CP_GET_NODATA;
 
    /* If "wait" mode enabled, spin many times, otherwise attempt just once */
    while (LimitCount--)
    {
        /* Read LSR for data ready */
        Lsr = CpReadLsr(Port, SERIAL_LSR_DR);
        if ((Lsr & SERIAL_LSR_DR) == SERIAL_LSR_DR)
        {
            /* If an error happened, clear the byte and fail */
            if (Lsr & (SERIAL_LSR_FE | SERIAL_LSR_PE | SERIAL_LSR_OE))
            {
                *Byte = 0;
                return CP_GET_ERROR;
            }
 
            /* If only polling was requested by caller, return now */
            if (Poll) return CP_GET_SUCCESS;
 
            /* Otherwise read the byte and return it */
            *Byte = READ_PORT_UCHAR(Port->Address + RECEIVE_BUFFER_REGISTER);
 
            /* Handle CD if port is in modem control mode */
            if (Port->Flags & CPPORT_FLAG_MODEM_CONTROL)
            {
                /* Not implemented yet */
                // DPRINT1("CP: CPPORT_FLAG_MODEM_CONTROL unexpected\n");
            }
 
            /* Byte was read */
            return CP_GET_SUCCESS;
        }
    }
 
    /* Reset LSR, no data was found */
    CpReadLsr(Port, 0);
    return CP_GET_NODATA;
}

Referenced by InbvPortGetByte(), InbvPortPollOnly(), KdPortGetByteEx(), KdpPollByte(), KdpReceiveByte(), WinLdrPortGetByte(), and WinLdrPortPollOnly().

CpInitialize()

NTSTATUS NTAPI CpInitialize	(	IN PCPPORT	Port,
		IN PUCHAR	Address,
		IN ULONG	BaudRate
	)

Definition at line 85 of file cport.c.

{
    /* Validity checks */
    if (Port == NULL || Address == NULL || BaudRate == 0)
        return STATUS_INVALID_PARAMETER;
 
    if (!CpDoesPortExist(Address))
        return STATUS_NOT_FOUND;
 
    /* Initialize port data */
    Port->Address  = Address;
    Port->BaudRate = 0;
    Port->Flags    = 0;
 
    /* Disable the interrupts */
    WRITE_PORT_UCHAR(Address + LINE_CONTROL_REGISTER, 0);
    WRITE_PORT_UCHAR(Address + INTERRUPT_ENABLE_REGISTER, 0);
 
    /* Turn on DTR, RTS and OUT2 */
    WRITE_PORT_UCHAR(Address + MODEM_CONTROL_REGISTER,
                     SERIAL_MCR_DTR | SERIAL_MCR_RTS | SERIAL_MCR_OUT2);
 
    /* Set the baud rate */
    CpSetBaud(Port, BaudRate);
 
    /* Set 8 data bits, 1 stop bit, no parity, no break */
    WRITE_PORT_UCHAR(Port->Address + LINE_CONTROL_REGISTER,
                     SERIAL_8_DATA | SERIAL_1_STOP | SERIAL_NONE_PARITY);
 
    /* Turn on FIFO */
    // TODO: Check whether FIFO exists and turn it on in that case.
    CpEnableFifo(Address, TRUE); // for 16550
 
    /* Read junk out of the RBR */
    (VOID)READ_PORT_UCHAR(Address + RECEIVE_BUFFER_REGISTER);
 
    return STATUS_SUCCESS;
}

Referenced by InbvPortInitialize(), KdDebuggerInitialize0(), KdPortInitializeEx(), KdpPortInitialize(), LlbHwOmap3UartInitialize(), and WinLdrPortInitialize().

CpPutByte()

VOID NTAPI CpPutByte	(	IN PCPPORT	Port,
		IN UCHAR	Byte
	)

Definition at line 303 of file cport.c.

{
    /* Check if port is in modem control to handle CD */
    // while (Port->Flags & CPPORT_FLAG_MODEM_CONTROL)  // Commented for the moment.
    if (Port->Flags & CPPORT_FLAG_MODEM_CONTROL)    // To be removed when this becomes implemented.
    {
        /* Not implemented yet */
        // DPRINT1("CP: CPPORT_FLAG_MODEM_CONTROL unexpected\n");
    }
 
    /* Wait for LSR to say we can go ahead */
    while ((CpReadLsr(Port, SERIAL_LSR_THRE) & SERIAL_LSR_THRE) == 0x00);
 
    /* Send the byte */
    WRITE_PORT_UCHAR(Port->Address + TRANSMIT_HOLDING_REGISTER, Byte);
}

Referenced by InbvPortPutByte(), KdPortPutByteEx(), KdpSendByte(), LlbHwUartSendChar(), and WinLdrPortPutByte().

CpReadLsr()

UCHAR NTAPI CpReadLsr	(	IN PCPPORT	Port,
		IN UCHAR	ExpectedValue
	)

Definition at line 231 of file cport.c.

{
    UCHAR Lsr, Msr;
 
    /* Read the LSR and check if the expected value is present */
    Lsr = READ_PORT_UCHAR(Port->Address + LINE_STATUS_REGISTER);
    if (!(Lsr & ExpectedValue))
    {
        /* Check the MSR for ring indicator toggle */
        Msr = READ_PORT_UCHAR(Port->Address + MODEM_STATUS_REGISTER);
 
        /* If the indicator reaches 3, we've seen this on/off twice */
        RingIndicator |= (Msr & SERIAL_MSR_RI) ? 1 : 2;
        if (RingIndicator == 3) Port->Flags |= CPPORT_FLAG_MODEM_CONTROL;
    }
 
    return Lsr;
}

Referenced by CpGetByte(), and CpPutByte().

CpSetBaud()

VOID NTAPI CpSetBaud	(	IN PCPPORT	Port,
		IN ULONG	BaudRate
	)

Definition at line 62 of file cport.c.

{
    UCHAR Lcr;
    ULONG Mode = CLOCK_RATE / BaudRate;
 
    /* Set the DLAB on */
    Lcr = READ_PORT_UCHAR(Port->Address + LINE_CONTROL_REGISTER);
    WRITE_PORT_UCHAR(Port->Address + LINE_CONTROL_REGISTER, Lcr | SERIAL_LCR_DLAB);
 
    /* Set the baud rate */
    WRITE_PORT_UCHAR(Port->Address + DIVISOR_LATCH_LSB, (UCHAR)(Mode & 0xFF));
    WRITE_PORT_UCHAR(Port->Address + DIVISOR_LATCH_MSB, (UCHAR)((Mode >> 8) & 0xFF));
 
    /* Reset DLAB */
    WRITE_PORT_UCHAR(Port->Address + LINE_CONTROL_REGISTER, Lcr);
 
    /* Save baud rate in port */
    Port->BaudRate = BaudRate;
}

Referenced by CpInitialize().