API Reference: Libraries

Top

# vxbMc146818Rtc

#### NAME

> vxbMc146818Rtc - driver for the MC146818 real time clock

#### ROUTINES

> vxbMc146818RtcDrvRegister( ) - registers the driver for MC146818 RTC

#### DESCRIPTION

> This is the vxBus compliant timer driver which interacts with the MC146818 Real time clock.

> A timer specific data structure (struct mc146818RtcData) is maintained within this driver.

> The driver implements all the vxBus driver specific initialization routines like mc146818RtcInstInit (), mc146818RtcInstInit2 () and mc146818RtcInstConnect ().

> A variable of type struct mc146818RtcData is allocated for the instance and stored in pInst->pDrvCtrl in mc146818RtcInstInit ()

> mc146818RtcInstInit2 () hooks an ISR to be used.

> A method for methodId vxbTimerFuncGet_desc is implemented in this driver and is used by the Timer Abstraction Layer/application to retrieve the characteristics of a timer device.

#### TARGET-SPECIFIC PARAMETERS

> The parameters are retrieved from hwconf.c in the target BSP.

> regBase

>   RTC base address. The parameter type is HCF_RES_INT.

> irq

>   Interrupt vector number for the timer interrupt source. The parameter type is HCF_RES_INT.

> irqLevel

>   Interrupt number for the timer interrupt source. The parameter type is HCF_RES_INT.

> clkFreq

>   clock frequency of RTC. The parameter type is HCF_RES_INT.

> clkRateMin

>   Specify the minimum clock rate(in ticks/sec) which can be supported by the RTC. The parameter type is HCF_RES_INT.

> clkRateMax

>   Specify the maximum clock rate(in ticks/sec) which can be supported by the RTC. The parameter type is HCF_RES_INT.

#### INCLUDE FILES

> none

API Reference: Routines

Top

# vxbMc146818RtcDrvRegister( )

#### NAME

> vxbMc146818RtcDrvRegister( ) - registers the driver for MC146818 RTC

#### SYNOPSIS

>     void vxbMc146818RtcDrvRegister(void)

#### DESCRIPTION

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

#### RETURNS

> N/A

#### ERRNO

#### SEE ALSO

> vxbMc146818Rtc