0c85453ace
Added the libraries to the repository Preliminary changes to fix slow startup when no network cable is connected
166 lines
6 KiB
C
166 lines
6 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief Real-Time Clock (RTC) driver for SAM.
|
|
*
|
|
* Copyright (c) 2011 - 2012 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an
|
|
* Atmel microcontroller product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
|
|
#ifndef RTC_H_INCLUDED
|
|
#define RTC_H_INCLUDED
|
|
|
|
#include "compiler.h"
|
|
|
|
/// @cond 0
|
|
/**INDENT-OFF**/
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/**INDENT-ON**/
|
|
/// @endcond
|
|
|
|
void rtc_set_hour_mode(Rtc *p_rtc, uint32_t ul_mode);
|
|
uint32_t rtc_get_hour_mode(Rtc *p_rtc);
|
|
void rtc_enable_interrupt(Rtc *p_rtc, uint32_t ul_sources);
|
|
void rtc_disable_interrupt(Rtc *p_rtc, uint32_t ul_sources);
|
|
uint32_t rtc_get_interrupt_mask(Rtc *p_rtc);
|
|
void rtc_get_time(Rtc *p_rtc, uint32_t *pul_hour, uint32_t *pul_minute,
|
|
uint32_t *pul_second);
|
|
uint32_t rtc_set_time(Rtc *p_rtc, uint32_t ul_hour, uint32_t ul_minute,
|
|
uint32_t ul_second);
|
|
uint32_t rtc_set_time_alarm(Rtc *p_rtc,
|
|
uint32_t ul_hour_flag, uint32_t ul_hour,
|
|
uint32_t ul_minute_flag, uint32_t ul_minute,
|
|
uint32_t ul_second_flag, uint32_t ul_second);
|
|
void rtc_get_date(Rtc *p_rtc, uint32_t *pul_year, uint32_t *pul_month,
|
|
uint32_t *pul_day, uint32_t *pul_week);
|
|
uint32_t rtc_set_date(Rtc *p_rtc, uint32_t ul_year, uint32_t ul_month,
|
|
uint32_t ul_day, uint32_t ul_week);
|
|
uint32_t rtc_set_date_alarm(Rtc *p_rtc,
|
|
uint32_t ul_month_flag, uint32_t ul_month,
|
|
uint32_t ul_day_flag, uint32_t ul_day);
|
|
void rtc_clear_time_alarm(Rtc *p_rtc);
|
|
void rtc_clear_data_alarm(Rtc *p_rtc);
|
|
uint32_t rtc_get_status(Rtc *p_rtc);
|
|
void rtc_clear_status(Rtc *p_rtc, uint32_t ul_clear);
|
|
|
|
#if ((SAM3S8) || (SAM3SD8) || (SAM4S))
|
|
void rtc_set_calendar_mode(Rtc *p_rtc, uint32_t ul_mode);
|
|
void rtc_set_calibration(Rtc *p_rtc, uint32_t ul_direction_ppm,
|
|
uint32_t ul_correction, uint32_t ul_range_ppm);
|
|
void rtc_set_waveform(Rtc *p_rtc, uint32_t ul_channel, uint32_t ul_value);
|
|
void rtc_set_pulse_parameter(Rtc *p_rtc, uint32_t ul_time_high,
|
|
uint32_t ul_period);
|
|
#endif /* ((SAM3S8) || (SAM3SD8) || (SAM4S)) */
|
|
|
|
#if ((SAM3N) || (SAM3U) || (SAM3XA_SERIES))
|
|
void rtc_set_writeprotect(Rtc *p_rtc, uint32_t ul_enable);
|
|
#endif /* ((SAM3N) || (SAM3U) || (SAM3XA_SERIES)) */
|
|
|
|
/**
|
|
* \page sam_rtc_quickstart Quickstart guide for SAM RTC driver
|
|
*
|
|
* This is the quickstart guide for the \ref rtc_group "SAM RTC driver",
|
|
* with step-by-step instructions on how to configure and use the driver in a
|
|
* selection of use cases.
|
|
*
|
|
* The use cases contain several code fragments. The code fragments in the
|
|
* steps for setup can be copied into a custom initialization function, while
|
|
* the steps for usage can be copied into, e.g., the main application function.
|
|
*
|
|
* \section rtc_basic_use_case Basic use case
|
|
* In this basic use case, the RTC module is using 32kHz external crystal and
|
|
* configured for 24-hour mode. It will read the current date and time.
|
|
*
|
|
* \subsection sam_rtc_quickstart_prereq Prerequisites
|
|
* -# \ref sysclk_group "System Clock Management (Sysclock)"
|
|
*
|
|
* \section rtc_basic_use_case_setup Setup steps
|
|
* \subsection rtc_basic_use_case_setup_code Example code
|
|
* Add to application C-file:
|
|
* \code
|
|
* void rtc_setup(void)
|
|
* {
|
|
* pmc_switch_sclk_to_32kxtal(PMC_OSC_XTAL);
|
|
*
|
|
* while (!pmc_osc_is_ready_32kxtal());
|
|
*
|
|
* rtc_set_hour_mode(RTC, 0);
|
|
* }
|
|
* \endcode
|
|
*
|
|
* \subsection rtc_basic_use_case_setup_flow Workflow
|
|
* - \note Please make sure the external 32kHz crystal is available.
|
|
* -# Enable the External 32K crystal :
|
|
* - \code pmc_switch_sclk_to_32kxtal(PMC_OSC_XTAL); \endcode
|
|
* -# Wait for 32K crystal ready:
|
|
* - \code while (!pmc_osc_is_ready_32kxtal()); \endcode
|
|
* -# Set default RTC configuration, 24-hour mode .
|
|
* - \code rtc_set_hour_mode(RTC, 0); \endcode
|
|
*
|
|
* \section rtc_basic_use_case_usage Usage steps
|
|
* \subsection rtc_basic_use_case_usage_code Example code
|
|
* Add to, e.g., main loop in application C-file:
|
|
* \code
|
|
* uint32_t hour, minute, second;
|
|
* uint32_t year, month, day, week;
|
|
*
|
|
* rtc_get_time(RTC, &hour, &minute, &second);
|
|
* rtc_get_date(RTC, &year, &month, &day, &week);
|
|
* \endcode
|
|
*
|
|
* \subsection rtc_basic_use_case_usage_flow Workflow
|
|
* -# Start Define the variables for the date and time:
|
|
* - \code uint32_t hour, minute, second; \endcode
|
|
* - \code uint32_t year, month, day, week; \endcode
|
|
* -# Read current time:
|
|
* - \code rtc_get_time(RTC, &hour, &minute, &second); \endcode
|
|
* -# Read current date:
|
|
* - \code rtc_get_date(RTC, &year, &month, &day, &week); \endcode
|
|
*
|
|
*/
|
|
|
|
/// @cond 0
|
|
/**INDENT-OFF**/
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
/**INDENT-ON**/
|
|
/// @endcond
|
|
|
|
#endif /* RTC_H_INCLUDED */
|