/*********************************************************************
 *
 *                  RTCC API implementation file
 *
 *********************************************************************
 * FileName:        _rtcc_set_time_and_date_lib.c
 * Dependencies:	Rtcc.h
 *
 * Processor:       PIC32
 *
 * Compiler:        MPLAB XC32
 *                  MPLAB IDE
 * Company:         Microchip Technology Inc.
 *
 * Software License Agreement
 *
 * The software supplied herewith by Microchip Technology Incorporated
 * (the “Company”) for its PIC32 Microcontroller is intended
 * and supplied to you, the Company’s customer, for use solely and
 * exclusively on Microchip PIC32 Microcontroller products.
 * The software is owned by the Company and/or its supplier, and is
 * protected under applicable copyright laws. All rights are reserved.
 * Any use in violation of the foregoing restrictions may subject the
 * user to criminal sanctions under applicable laws, as well as to
 * civil liability for the breach of the terms and conditions of this
 * license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES,
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
 * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *
 * $Id:$
 * $Name:  $
 *
 ********************************************************************/



#include <peripheral/rtcc.h>
#include <peripheral/int.h>

#include "_rtcc_include.h"

/* Notes regarding the disabling/enabling of the interrupts in the implememntation of this API:
 * all operations that perform the read/write update of a 32 bit peripheral register are considered to
 * be atomic and generally the disabling of the interrupts is not required.
 * The disabling of the interrupts is performed just for un-interruptible hardware access sequences
 * that span over multiple instructions.
 * */


/*********************************************************************
 * Function:        void _RtccSetTimeAndDate(const rtccTime* pTm, const rtccDate* pDt)
 *
 * PreCondition:    rtccTime and rtccDate structures fields have to have proper values:
 * 						- sec:	BCD codification, 00-59
 * 						- min:  BCD codification, 00-59
 * 						- hour: BCD codification, 00-24
 * 						- wday:	BCD codification, 00-06
 * 						- mday: BCD codification, 01-31
 * 						- mon: BCD codification, 01-12
 * 						- year: BCD codification, 00-99
 * Input:           pTm - pointer to a constant rtccTime union
 * 					pDt	- pointer to a constant rtccDate union
 *
 * Output:          None
 * Side Effects:    None
 * Overview:        The function sets the current time and date in the RTCC device.
 *
 * Note:            - The write is successful only if Wr Enable is set.
 * 					The function will enable the write itself, if needed.
 * 					- The device could be stopped in order
 * 					to safely perform the update of the RTC time register.
 * 					However, the device status will be restored but	the routine won't wait
 * 					for the CLK to be running before returning. User has to check RtccGetClkOn() (will take approx 30us).
 * 					- The routine disables the interrupts for a very short time to be able
 * 					to update the time and date registers.
 ********************************************************************/
void _RtccSetTimeAndDate(const rtccTime* pTm, const rtccDate* pDt)
{
	int		wasWrEn;
	int		intLevel;


	if(!(wasWrEn=RtccGetWrEnable()))
	{
		RtccWrEnable(1);			// have to allow the WRTEN in order to write the new value
	}


	if(RTCCONbits.ON)
	{	// device is ON
		intLevel=INTDisableInterrupts();

		// Poll RTCSYNC.
		if(RTCCONbits.RTCSYNC || (RTCALRMbits.ALRMEN && RTCALRMbits.AMASK==RTCC_RPT_HALF_SEC))
		{	// a rollover event taking place, we cannot perform the write now
			INTRestoreInterrupts(intLevel);				// restore the interrupts, we're going to wait for a while
			_RtccStop();	// turn module off before updating the time
						// make sure RTCC clock is stopped
			if(pTm)
			{
				RTCTIME=pTm->l;		// update the RTCTIME value
			}
			if(pDt)
			{
				RTCDATE=pDt->l;		// update the RTCDATE value
			}
			RTCCONSET=_RTCCON_ON_MASK;	// don't wait for the clock to be back on
		}
		else
		{	// there's no rollover now, safe to write
			if(pTm)
			{
				RTCTIME=pTm->l;		// update the RTCTIME value
			}
			if(pDt)
			{
				RTCDATE=pDt->l;		// update the RTCDATE value
			}
			INTRestoreInterrupts(intLevel);
		}
	}
	else
	{	// device is OFF, so we don't have to disable the interrupts
		_RtccWaitClockOff();	// make sure the clock is not running
		if(pTm)
		{
			RTCTIME=pTm->l;		// update the RTCTIME value
		}
		if(pDt)
		{
			RTCDATE=pDt->l;		// update the RTCDATE value
		}
	}

	// now restore the status
	if(!wasWrEn)
	{
		RtccWrEnable(0);	// disable
	}

}