VxWorks Reference Manual : Libraries

shSciSio

NAME

shSciSio - Hitachi SH SCI (Serial Communications Interface) driver

ROUTINES

shSciDevInit( ) - initialize a on-chip serial communication interface
shSciIntRcv( ) - handle a channel's receive-character interrupt.
shSciIntTx( ) - handle a channels transmitter-ready interrupt.
shSciIntErr( ) - handle a channel's error interrupt.
dummyCallback( ) - dummy callback routine.

DESCRIPTION

This is the driver for the Hitachi SH series on-chip SCI (Serial Communication Interface). It uses the SCI in asynchronous mode only.

USAGE

A SCI_CHAN structure is used to describe the chip.

The BSP's sysHwInit( ) routine typically calls sysSerialHwInit( ) which initializes all the values in the SCI_CHAN structure (except the SIO_DRV_FUNCS) before calling shSciDevInit( ). The BSP's sysHwInit2( ) routine typically calls sysSerialHwInit2( ), which connects the chips interrupts via intConnect( ).

INCLUDE FILES

drv/sio/shSciSio.h sioLib.h

SEE ALSO

shSciSio


Libraries : Routines

shSciDevInit( )

NAME

shSciDevInit( ) - initialize a on-chip serial communication interface

SYNOPSIS

void shSciDevInit
    (
    SCI_CHAN * pChan
    )

DESCRIPTION

This routine initializes the driver function pointers and then resets the chip in a quiescent state. The BSP must have already initialized all the device addresses and the baudFreq fields in the SCI_CHAN structure before passing it to this routine.

RETURNS

N/A

SEE ALSO

shSciSio


Libraries : Routines

shSciIntRcv( )

NAME

shSciIntRcv( ) - handle a channel's receive-character interrupt.

SYNOPSIS

void shSciIntRcv
    (
    SCI_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shSciSio


Libraries : Routines

shSciIntTx( )

NAME

shSciIntTx( ) - handle a channels transmitter-ready interrupt.

SYNOPSIS

void shSciIntTx
    (
    SCI_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shSciSio


Libraries : Routines

shSciIntErr( )

NAME

shSciIntErr( ) - handle a channel's error interrupt.

SYNOPSIS

void shSciIntErr
    (
    SCI_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shSciSio


Libraries : Routines

dummyCallback( )

NAME

dummyCallback( ) - dummy callback routine.

SYNOPSIS


STATUS dummyCallback (void)

DESCRIPTION

RETURNS

ERROR.

SEE ALSO

shSciSio