README: Driver for MC146818 Real-Time-Clock

This file contains specific information for the 
  "Driver for MC146818 RTC controller"
 
This file documents interface changes from previous software or hardware
versions, and notifies the user of serious caveats that must be noted before
using this package.  

--------------------------------------------------------------------------------

RELEASE 1.0

	Released from Kontron KGSC for Workbench 3.x, VxWorks 6.8/6.9

    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(vxbRtcGet)
    METHOD_DECL(vxbRtcSet)

    and the methods should be called as

    struct tm t;
        
    vxbDevMethodRun(DEVMETHOD_CALL(vxbRtcGet), &t);
    vxbDevMethodRun(DEVMETHOD_CALL(vxbRtcSet), &t);
	

    BSP installation:
    If this driver is NOT part of a BSP, you have to perform the following steps :
          Due to the fact that the drivers need to obtain configuration parameters through
          the hwconf.c, which is located in the appropriate BSP, you have to modify 
          the hwconf.c inserting the code:

	...
	
	#if defined (DRV_RTC_MC146818)
		struct hcfResource mc146818DevKResources[] = {
		    { "regBase", HCF_RES_INT, {(void *)RTC_INDEX} }
		};

		#define mc146818DevKNum NELEMENTS(mc146818DevKResources)
	#endif /* DRV_RTC_MC146818 */
					
        ...

	const struct hcfDevice hcfDeviceList[] = {
		....
		#if defined (DRV_RTC_MC146818)
		    { "mc146818RtcKontron", 0, VXB_BUSID_PLB, 0, mc146818DevKNum, mc146818DevKResources },
		#endif /* DRV_RTC_MC146818 */
		....
			

    Then rebuild the BSP.  
	  
	  
	  
	  
	  
	  
	  
