EVMDM642 UART Module

This module communicates through the on-chip 16C550 compatible UART. To use the module, you must use the EVMDM642_UART_open() call to get a handle of type EVMDM642_UART_Handle which is then passed as a parameter to the other functions.

Description
Open the UART at a specific baud rate and return a UART handle

Required Headers
evmdm642.h
evmdm642_uart.h

Required Libraries
evmdm642bsl.lib

Function Prototype
EVMDM642_UART_Handle EVMDM642_UART_open(Int16 devid, Int16 baudrate, EVMDM642_UART_Config *Config)

Parameters
devid – device ID, always 0 on the EVMDM642
baudrate - baud rate, use constants defined in evmdm642_uart.h. Possible values are:

    EVMDM642_UART_BAUD115200
    EVMDM642_UART_BAUD57600
    EVMDM642_UART_BAUD38400
    EVMDM642_UART_BAUD19200
    EVMDM642_UART_BAUD9600
    EVMDM642_UART_BAUD4800
    EVMDM642_UART_BAUD2400
    EVMDM642_UART_BAUD1200

Return Value
Active UART handle

Example

    /* Open UART at 19200 baud 
     * in normal (non-FIFO mode) */
    EVMDM642_UART_Handle hUart;
    EVMDM642_UART_Config uartcfg = {
        0x00, // IER
        0x00, // FCR
        0x03, // LCR
        0x00  // MCR
    }
    hUart = EVMDM642_UART_open(0,
            EVMDM642_UART_BAUD_19200, &uartcfg);

Description
Get the value of a UART register

Required Headers
evmdm642.h
evmdm642_uart.h

Required Libraries
evmdm642bsl.lib

Function Prototype
Int16 EVMDM642_UART_rget(EVMDM642_UART_Handle hUart, Int16 regnum)

Parameters
hUart - UART handle (see EVMDM642_UART_open() )
regnum - Index of register to get. Defined in evmdm642_uart.h as EVMDM642_UART_XXX where XXX is the name of the register

Return Value
Value of register, only lower 8-bits will contain data

Example

    /* Get the value of the LCR register */
    Int16 data;
    data = EVMDM642_UART_rget(hUart, EVMDM642_UART_LCR);

Description
Set the value of a UART register

Required Headers
evmdm642.h
evmdm642_uart.h

Required Libraries
evmdm642bsl.lib

Function Prototype
void EVMDM642_UART_rset(EVMDM642_UART_Handle hUart, Int16 regnum, Int16 regval)

Parameters
hUart - UART handle (see EVMDM642_UART_open() )
regnum - index of register to get. Defined in evmdm642_uart.h as EVMDM642_UART_XXX where XXX is the name of the register
regval - value to set the register to, only lower 8-bits are assigned

Return Value
None

Example

    /* Set the value of the LCR register to 0x03 */
    EVMDM642_UART_rset(hUart, EVMDM642_UART_LCR, 0x03);

Description
Get a character from the UART. Spins until a character is available

Required Headers
evmdm642.h
evmdm642_uart.h

Required Libraries
evmdm642bsl.lib

Function Prototype
Int16 EVMDM642_UART_getChar(EVMDM642_UART_Handle hUart)

Parameters
hUart - UART handle (see EVMDM642_UART_open() )

Return Value
Character value

Example

    /* Read a character from the UART */
    Int16 data;
    data = EVMDM642_UART_getChar(hUart);

Description
Send a character to the UART. Spins until the UART transmitter is ready to accept data.

Required Headers
evmdm642.h
evmdm642_uart.h

Required Libraries
evmdm642bsl.lib

Function Prototype
void EVMDM642_UART_rset(EVMDM642_UART_Handle hUart, Uint16 data)

Parameters
hUart - UART handle (see EVMDM642_UART_open() )
data - Character to be sent

Return Value
None

Example

    /* Send the character ‘A’ to the UART */
    EVMDM642_UART_putChar( hUart, ‘A’ );