VxWorks Reference Manual : Libraries

shScifSio

NAME

shScifSio - Hitachi SH SCIF (Serial Communications Interface) driver

ROUTINES

shScifDevInit( ) - initialize a on-chip serial communication interface
shScifIntRcv( ) - handle a channel's receive-character interrupt.
shScifIntTx( ) - handle a channels transmitter-ready interrupt.
shScifIntErr( ) - handle a channel's error interrupt.
dummyCallback( ) - dummy callback routine.

DESCRIPTION

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

USAGE

A SCIF_CHAN structure is used to describe the chip.

The BSP's sysHwInit( ) routine typically calls sysSerialHwInit( ) which initializes all the values in the SCIF_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 drv/sio/shScifSio.h sioLib.h

SEE ALSO

shScifSio


Libraries : Routines

shScifDevInit( )

NAME

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

SYNOPSIS

void shScifDevInit
    (
    SCIF_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 SCIF_CHAN structure before passing it to this routine.

RETURNS

N/A

SEE ALSO

shScifSio


Libraries : Routines

shScifIntRcv( )

NAME

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

SYNOPSIS

void shScifIntRcv
    (
    SCIF_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shScifSio


Libraries : Routines

shScifIntTx( )

NAME

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

SYNOPSIS

void shScifIntTx
    (
    SCIF_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shScifSio


Libraries : Routines

shScifIntErr( )

NAME

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

SYNOPSIS

void shScifIntErr
    (
    SCIF_CHAN * pChan /* channel generating the interrupt */
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

shScifSio


Libraries : Routines

dummyCallback( )

NAME

dummyCallback( ) - dummy callback routine.

SYNOPSIS


STATUS dummyCallback (void)

DESCRIPTION

RETURNS

ERROR.

SEE ALSO

shScifSio