VxWorks Reference Manual : Libraries

ppc403Sio

NAME

ppc403Sio - ppc403GA serial driver

ROUTINES

ppc403DummyCallback( ) - dummy callback routine
ppc403DevInit( ) - initialize the serial port unit
ppc403IntWr( ) - handle a transmitter interrupt
ppc403IntRd( ) - handle a receiver interrupt
ppc403IntEx( ) - handle error interrupts

DESCRIPTION

This is the driver for PPC403GA serial port on the on-chip peripheral bus. The SPU (serial port unit) consists of three main elements: receiver, transmitter, and baud-rate generator. For details, refer to the PPC403GA Embedded Controller User's Manual.

USAGE

A PPC403_CHAN structure is used to describe the chip. This data structure contains the single serial channel. The BSP's sysHwInit( ) routine typically calls sysSerialHwInit( ) which initializes all the values in the PPC403_CHAN structure (except the SIO_DRV_FUNCS) before calling ppc403DevInit( ). The BSP's sysHwInit2( ) routine typically calls sysSerialHwInit2( ) which connects the chip interrupt routines ppc403IntWr( ) and ppc403IntRd( ) via intConnect( ).

IOCTL FUNCTIONS

This driver responds to the same ioctl( ) codes as other SIO drivers; for more information, see sioLib.h.

INCLUDE FILES

drv/sio/ppc403Sio.h

SEE ALSO

ppc403Sio


Libraries : Routines

ppc403DummyCallback( )

NAME

ppc403DummyCallback( ) - dummy callback routine

SYNOPSIS

 

STATUS ppc403DummyCallback (void)

DESCRIPTION

RETURNS

ERROR (always).

SEE ALSO

ppc403Sio


Libraries : Routines

ppc403DevInit( )

NAME

ppc403DevInit( ) - initialize the serial port unit

SYNOPSIS

void ppc403DevInit
    (
    PPC403_CHAN * pChan
    )

DESCRIPTION

The BSP must already have initialized all the device addresses in the PPC403_CHAN structure. This routine initializes some SIO_CHAN function pointers and then resets the chip in a quiescent state.

SEE ALSO

ppc403Sio


Libraries : Routines

ppc403IntWr( )

NAME

ppc403IntWr( ) - handle a transmitter interrupt

SYNOPSIS

void ppc403IntWr
    (
    PPC403_CHAN * pChan
    )

DESCRIPTION

This routine handles write interrupts from the serial communication controller.

RETURNS

N/A

SEE ALSO

ppc403Sio


Libraries : Routines

ppc403IntRd( )

NAME

ppc403IntRd( ) - handle a receiver interrupt

SYNOPSIS

void ppc403IntRd
    (
    PPC403_CHAN * pChan
    )

DESCRIPTION

This routine handles read interrupts from the serial commonication controller.

RETURNS

N/A

SEE ALSO

ppc403Sio


Libraries : Routines

ppc403IntEx( )

NAME

ppc403IntEx( ) - handle error interrupts

SYNOPSIS

void ppc403IntEx
    (
    PPC403_CHAN * pChan
    )

DESCRIPTION

This routine handles miscellaneous interrupts on the seial communication controller.

RETURNS

N/A

SEE ALSO

ppc403Sio