RIOT/drivers/include/rtc.h

/*
 * Copyright 2010, Freie Universitaet Berlin (FUB). All rights reserved.
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    rtc Realtime Clock
 * @ingroup     drivers
 * @brief       Generic real time clock driver interface
 * @{
 */

#ifndef RTC_H
#define RTC_H

#define RTC_SECOND 10001U

#include <time.h>
#include <sys/time.h>
#include "kernel_types.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Initializes the RTC for calendar mode
 */
void rtc_init(void);

/**
 * @brief Starts the RTC
 */
void rtc_enable(void);

/**
 * @brief Stops the RTC
 */
void rtc_disable(void);

/**
 * @brief   Sets the current time in broken down format directly from to RTC
 * @param[in]   localt      Pointer to structure with time to set
 */
void rtc_set_localtime(struct tm *localt);

/**
 * @brief   Returns the current time in broken down format directly from the RTC
 * @param[out]  localt      Pointer to structure to receive time
 */
void rtc_get_localtime(struct tm *localt);

/**
 * @brief   Get the current time as a struct timeval
 * @param[out]  time        Pointer to structure to receive time
 */
time_t rtc_time(struct timeval *time);

extern kernel_pid_t rtc_second_pid;

#ifdef __cplusplus
}
#endif

/** @} */
#endif