API Reference: Libraries

Top

# vxbMC146818RtcK

#### NAME

> vxbMC146818RtcK - driver for the MC146818 real time clock

#### ROUTINES

> vxbMc146818RtcDrvRegister( ) - registers the driver for MC146818 RTC
> mc146818RtcInstInit( ) - first level initialization routine of the RTC
> mc146818RtcInstInit2( ) - second level initialization routine of the RTC
> mc146818RtcInstConnect( ) - third level initialization routine of the RTC
> mc146818RtcTimeGet( ) - retrieve the current date and time
> mc146818RtcTimeSet( ) - Set the current date and time

#### DESCRIPTION

> This is the vxBus compliant driver which implements the functionality
> specific to the the MC146818 real time clock Timer. It doesn't implement
> functionality of standard MC146818 timer driver but adds RTC time functions

> User application is able to use VxBus custom methods defined for this driver:
> METHOD_DECL(mc146818RtcTimeGet)
> METHOD_DECL(mc146818RtcTimeSet)

API Reference: Routines

Top

# vxbMc146818RtcDrvRegister( )

#### NAME

> vxbMc146818RtcDrvRegister( ) - registers the driver for MC146818 RTC

#### DESCRIPTION

> This routine registers the driver for MC146818 Real Time Clock with the vxBus subsystem.

#### RETURNS

> N/A

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK

API Reference: Routines

Top

# mc146818RtcInstInit( )

#### NAME

> mc146818RtcInstInit( ) - first level initialization routine of the RTC

#### DESCRIPTION

> This is the function called to perform the first level initialization of the Real time clock.

#### NOTE

> This routine is called early during system initialization, and *MUST NOT* make calls to OS facilities such as memory allocation and I/O.

#### RETURNS

> N/A

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK

API Reference: Routines

Top

# mc146818RtcInstInit2( )

#### NAME

> mc146818RtcInstInit2( ) - second level initialization routine of the RTC

#### DESCRIPTION

> This routine performs the second level initialization of the Real time clock

> This routine is called later during system initialization. OS features such as memory allocation are available at this time.

#### RETURNS

> N/A

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK

API Reference: Routines

Top

# mc146818RtcInstConnect( )

#### NAME

> mc146818RtcInstConnect( ) - third level initialization routine of the RTC

#### DESCRIPTION

> This is the function called to perform the third level initialization of the Real time clock.

#### RETURNS

> N/A

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK

API Reference: Routines

Top

# mc146818RtcTimeGet( )

#### NAME

> mc146818RtcTimeGet( ) - retrieve the current date and time

#### DESCRIPTION

> none

#### RETURNS

> OK or ERROR if the parameter is invalid.

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK

API Reference: Routines

Top

# mc146818RtcTimeSet( )

#### NAME

> mc146818RtcTimeSet( ) - Set the current date and time

#### DESCRIPTION

> none

#### RETURNS

> OK or ERROR if the parameter is invalid.

#### ERRNO

#### SEE ALSO

> vxbMC146818RtcK