midiuart.h File Reference

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

Go to the source code of this file.

Macros
#define	WRITE_MIDIUART_DATA(bp, x)   WRITE_PORT_UCHAR((PUCHAR) bp, x)
#define	READ_MIDIUART_DATA(bp)   READ_PORT_UCHAR((PUCHAR) bp)
#define	WRITE_MIDIUART_COMMAND(bp, x)   WRITE_PORT_UCHAR((PUCHAR) bp+1, x)
#define	READ_MIDIUART_STATUS(bp)   READ_PORT_UCHAR((PUCHAR) bp+1)
#define	MIDIUART_STATUS_DTR   0x40
#define	MIDIUART_STATUS_CTS   0x80
#define	WaitForMidiUartCTS(UartBasePort, Timeout)    WaitForMidiUartStatus(UartBasePort, MIDIUART_STATUS_CTS, Timeout)
#define	WaitForMidiUartDTR(UartBasePort, Timeout)    WaitForMidiUartStatus(UartBasePort, MIDIUART_STATUS_DTR, Timeout)

Functions
BOOLEAN	WaitForMidiUartStatus (IN PUCHAR UartBasePort, IN UCHAR StatusFlags, IN ULONG Timeout)
BOOLEAN	WriteMidiUartByte (IN PUCHAR UartBasePort, IN UCHAR Data, IN ULONG Timeout)
BOOLEAN	WriteMidiUartMulti (IN PUCHAR UartBasePort, IN PUCHAR Data, IN ULONG DataLength, IN ULONG Timeout)
BOOLEAN	ReadMidiUartByte (IN PUCHAR UartBasePort, OUT UCHAR *Data, IN ULONG Timeout)

Macro Definition Documentation

MIDIUART_STATUS_CTS

#define MIDIUART_STATUS_CTS   0x80

Definition at line 32 of file midiuart.h.

MIDIUART_STATUS_DTR

#define MIDIUART_STATUS_DTR   0x40

Definition at line 31 of file midiuart.h.

READ_MIDIUART_DATA

#define READ_MIDIUART_DATA

(

bp

)

READ_PORT_UCHAR((PUCHAR) bp)

Definition at line 26 of file midiuart.h.

READ_MIDIUART_STATUS

#define READ_MIDIUART_STATUS

(

bp

)

READ_PORT_UCHAR((PUCHAR) bp+1)

Definition at line 28 of file midiuart.h.

WaitForMidiUartCTS

#define WaitForMidiUartCTS	(		UartBasePort,
			Timeout
	)		WaitForMidiUartStatus(UartBasePort, MIDIUART_STATUS_CTS, Timeout)

Definition at line 53 of file midiuart.h.

WaitForMidiUartDTR

#define WaitForMidiUartDTR	(		UartBasePort,
			Timeout
	)		WaitForMidiUartStatus(UartBasePort, MIDIUART_STATUS_DTR, Timeout)

Definition at line 57 of file midiuart.h.

WRITE_MIDIUART_COMMAND

#define WRITE_MIDIUART_COMMAND	(		bp,
			x
	)		WRITE_PORT_UCHAR((PUCHAR) bp+1, x)

Definition at line 27 of file midiuart.h.

WRITE_MIDIUART_DATA

#define WRITE_MIDIUART_DATA	(		bp,
			x
	)		WRITE_PORT_UCHAR((PUCHAR) bp, x)

Definition at line 25 of file midiuart.h.

Function Documentation

ReadMidiUartByte()

BOOLEAN ReadMidiUartByte	(	IN PUCHAR	UartBasePort,
		OUT UCHAR *	Data,
		IN ULONG	Timeout
	)

Definition at line 75 of file midiuart.c.

{
    if ( ! Data )
    {
        return FALSE;
    }
 
    if ( ! WaitForMidiUartDTR(UartBasePort, Timeout) )
    {
        return FALSE;
    }
 
    *Data = READ_MIDIUART_DATA(UartBasePort);
 
    return TRUE;
}

WaitForMidiUartStatus()

BOOLEAN WaitForMidiUartStatus	(	IN PUCHAR	UartBasePort,
		IN UCHAR	StatusFlags,
		IN ULONG	Timeout
	)

Definition at line 19 of file midiuart.c.

{
    ULONG RemainingTime = Timeout;
 
    while ( RemainingTime -- )
    {
        if ( READ_MIDIUART_STATUS(UartBasePort) & StatusFlags )
        {
            return TRUE;
        }
    }
 
    return FALSE;
}

WriteMidiUartByte()

BOOLEAN WriteMidiUartByte	(	IN PUCHAR	UartBasePort,
		IN UCHAR	Data,
		IN ULONG	Timeout
	)

Definition at line 38 of file midiuart.c.

{
    if ( ! WaitForMidiUartCTS(UartBasePort, Timeout) )
    {
        return FALSE;
    }
 
    WRITE_MIDIUART_DATA(UartBasePort, Data);
 
    return TRUE;
}

Referenced by WriteMidiUartMulti().

WriteMidiUartMulti()

BOOLEAN WriteMidiUartMulti	(	IN PUCHAR	UartBasePort,
		IN PUCHAR	Data,
		IN ULONG	DataLength,
		IN ULONG	Timeout
	)

Definition at line 54 of file midiuart.c.

{
    ULONG DataIndex;
 
    for ( DataIndex = 0; DataIndex < DataLength; ++ DataIndex )
    {
        if ( ! WriteMidiUartByte(UartBasePort, Data[DataIndex], Timeout) )
        {
            /* We failed - don't try writing any more */
            return FALSE;
        }
    }
 
    return TRUE;
}